1== INTRODUCTION ==
2
3The XMC Peripheral Library (XMC Lib) consists of low-level drivers for the XMC product family peripherals.
4It addition the Cortex Microcontroller Software Interface Standard (CMSIS) is included.
5CMSIS provides a hardware abstraction layer for the Cortex-M processor series.
6XMC Lib is built on top of CMSIS and MISRA-C 2004 compliant.
7
8The following tool chains are supported:
9- GNU GCC for ARM (gcc)
10- MDK-ARM Microcontroller Development Kit v5 (armcc)
11- Keil Arm Compiler Version 6
12- IAR Embedded Workbench for ARM (iccarm)
13- TASKING VX-toolset for ARM v5.(carm)
14
15The following 32-Bit Industrial Microcontrollers based on ARM Cortex are supported:
16- XMC4800 series
17- XMC4700 series
18- XMC4500 series
19- XMC4400 series
20- XMC4300 series
21- XMC4200 series
22- XMC4100 series
23- XMC1400 series
24- XMC1300 series
25- XMC1200 series
26- XMC1100 series
27
28== CONTENTS ==
29
30  Readme.txt
31  License.txt
32  XMClib/
33    doc/
34    examples/
35    /inc
36    /src
37  CMSIS/
38    Include/
39    Infineon/
40      SVD/
41      XMC1100_series/
42      XMC1200_series/
43      XMC1300_series/
44      XMC1400_series/
45      XMC4100_series/
46      XMC4200_series/
47      XMC4300_series/
48      XMC4400_series/
49      XMC4500_series/
50      XMC4700_series/
51      XMC4800_series/
52    Lib/
53
54Now let's explain the purpose of each directory:
55 - XMClib: The XMC Peripheral Library
56 - XMClib/doc: Holds complete documentation
57 - XMClib/examples: Contains examples using the XMClib for the supported devices and tool chains.
58 - XMClib/inc: Include files per peripheral
59 - XMClib/src: Implementation files per peripheral
60 - CMSIS: The Cortex Microcontroller Software Interface Standard abstraction layer
61 - CMSIS/Include: Hardware Abstraction Layer (HAL) for Cortex-M processor registers with standardized definitions for the SysTick,
62                  NVIC, System Control Block registers, MPU registers, FPU registers, and core access functions
63 - CMSIS/Infineon: Includes System View Description files (SVD) for use with debuggers, device header files with the register description,
64                   system files and startup files defined by CMSIS
65 - CMSIS/Lib: Precompiled CMSIS DSP libraries for XMC4 (ARM Cortex M4F) and XMC1 (ARM Cortex M0) families.
66
67== USAGE ==
68
69Several examples for the supported tool chains are provided that can serve as starting point.
70
71To start a project from scratch follow the steps:
721. Copy the CMSIS, XMClib and Newlib folders into your project.
733. Add the following folders into the include paths of your project:
74   - ${ProjName}/XMCLib/inc
75   - ${ProjName}/CMSIS/Include
76   - ${ProjName}/CMSIS/Infineon/XMC4400_series/Include
774. Select the device for which your compiling defining a preprocessor symbol, i.e. XMC4500_F144x1024
785. Include into your source the header files of the peripherals you want to use, i.e. #include <xmc_vadc.h>
796. Configure the peripheral and make use of the APIs described in the documentation.
80
81
82