1.. zephyr:board:: xmc45_relax_kit
2
3Overview
4********
5
6The XMC4500 Relax Kit is designed to evaluate the capabilities of the XMC4500
7Microcontroller. It is based on High performance ARM Cortex-M4F which can run
8up to 120MHz.
9
10Features:
11=========
12
13* ARM Cortex-M4F XMC4500
14* 32 Mbit Quad-SPI Flash
15* 4 x SPI-Master, 3x I2C, 3 x I2S, 3 x UART, 2 x CAN, 17 x ADC
16* 2 pin header x1 and x2 with 80 pins
17* Two buttons and two LEDs for user interaction
18* Detachable on-board debugger (second XMC4500) with Segger J-Link
19
20Details on the Relax Kit development board can be found in the `Relax Kit User Manual`_.
21
22Supported Features
23==================
24
25* The on-board 12-MHz crystal allows the device to run at its maximum operating speed of 120MHz.
26
27The Relax Kit development board configuration supports the following hardware features:
28
29+-----------+------------+-----------------------+
30| Interface | Controller | Driver/Component      |
31+===========+============+=======================+
32| NVIC      | on-chip    | nested vectored       |
33|           |            | interrupt controller  |
34+-----------+------------+-----------------------+
35| SYSTICK   | on-chip    | system clock          |
36+-----------+------------+-----------------------+
37| UART      | on-chip    | serial port           |
38+-----------+------------+-----------------------+
39| SPI       | on-chip    | spi                   |
40+-----------+------------+-----------------------+
41| GPIO      | on-chip    | gpio                  |
42+-----------+------------+-----------------------+
43| FLASH     | on-chip    | flash                 |
44+-----------+------------+-----------------------+
45| ADC       | on-chip    | adc                   |
46+-----------+------------+-----------------------+
47| DMA       | on-chip    | dma                   |
48+-----------+------------+-----------------------+
49| PWM       | on-chip    | pwm                   |
50+-----------+------------+-----------------------+
51| WATCHDOG  | on-chip    | watchdog              |
52+-----------+------------+-----------------------+
53| MDIO      | on-chip    | mdio                  |
54+-----------+------------+-----------------------+
55| ETHERNET  | on-chip    | ethernet              |
56+-----------+------------+-----------------------+
57| PTP       | on-chip    | ethernet              |
58+-----------+------------+-----------------------+
59| RTC       | on-chip    | rtc                   |
60+-----------+------------+-----------------------+
61
62More details about the supported peripherals are available in `XMC4500 TRM`_
63
64The default configuration can be found in the Kconfig
65
66:zephyr_file:`boards/infineon/xmc45_relax_kit/xmc45_relax_kit_defconfig`
67
68Other hardware features are not currently supported by the Zephyr kernel.
69
70Build hello world sample
71************************
72Here is an example for building the :zephyr:code-sample:`hello_world` sample application.
73
74.. zephyr-app-commands::
75   :zephyr-app: samples/hello_world
76   :board: xmc45_relax_kit
77   :goals: build
78
79Programming and Debugging
80*************************
81West Commands
82=============
83Here is an example for the :zephyr:code-sample:`hello_world` application.
84
85   .. tabs::
86      .. group-tab:: Windows
87
88         .. code-block:: shell
89
90            # Do a pristine build
91            west build -b xmc45_relax_kit -p always samples/hello_world
92
93            west flash
94            west debug
95
96      .. group-tab:: Linux
97
98         .. code-block:: shell
99
100            # Do a pristine build
101            west build -b xmc45_relax_kit -p always samples/hello_world
102
103            west flash
104            west debug
105
106Once the gdb console starts after executing the west debug command, you may now set breakpoints and perform other standard GDB debugging.
107
108References
109**********
110
111.. target-notes::
112
113.. _Relax Kit User Manual:
114   https://www.infineon.com/dgdl/Board_Users_Manual_XMC4500_Relax_Kit-V1_R1.2_released.pdf?fileId=db3a30433acf32c9013adf6b97b112f9
115
116.. _XMC4500 TRM:
117   https://www.infineon.com/dgdl/Infineon-xmc4500_rm_v1.6_2016-UM-v01_06-EN.pdf?fileId=db3a30433580b3710135a5f8b7bc6d13
118