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