1.. zephyr:board:: gd32f450z_eval
2
3Overview
4********
5
6The GD32F450Z-EVAL board is a hardware platform that enables prototyping
7on GD32F450ZK Cortex-M4F Stretch Performance MCU.
8
9The GD32F450ZK features a single-core ARM Cortex-M4F MCU which can run up
10to 200 MHz with flash accesses zero wait states, 3072kiB of Flash, 256kiB of
11SRAM and 114 GPIOs.
12
13Hardware
14********
15
16- GD32F450ZKT6 MCU
17- AT24C02C 2Kb EEPROM
18- GD25Q16B 16Mbit SPI and QSPI NOR Flash
19- Micron MT48LC16M16A2P-6AIT 256Mbit SDRAM
20- 3 x User LEDs
21- 3 x User Push buttons
22- 1 x USART (RS-232 at J1 connector)
23- 1 x POT connected to an ADC input
24- Headphone interface
25- Micro SD Card Interface
26- USB FS connector
27- USB HS connector
28- 1 x CAN
29- Ethernet Interface
30- 3.5" RGB-LCD (320x480)
31- GD-Link on board programmer
32- J-Link/JTAG connector
33
34For more information about the GD32F450 SoC and GD32F450Z-EVAL board:
35
36- `GigaDevice Cortex-M4F Stretch Performance SoC Website`_
37- `GD32F450xx Datasheet`_
38- `GD32F4xx User Manual`_
39- `GD32F450Z-EVAL User Manual`_
40
41Supported Features
42==================
43
44The board configuration supports the following hardware features:
45
46.. list-table::
47   :header-rows: 1
48
49   * - Peripheral
50     - Kconfig option
51     - Devicetree compatible
52   * - EXTI
53     - :kconfig:option:`CONFIG_GD32_EXTI`
54     - :dtcompatible:`gd,gd32-exti`
55   * - GPIO
56     - :kconfig:option:`CONFIG_GPIO`
57     - :dtcompatible:`gd,gd32-gpio`
58   * - NVIC
59     - N/A
60     - :dtcompatible:`arm,v7m-nvic`
61   * - PWM
62     - :kconfig:option:`CONFIG_PWM`
63     - :dtcompatible:`gd,gd32-pwm`
64   * - SYSTICK
65     - N/A
66     - N/A
67   * - USART
68     - :kconfig:option:`CONFIG_SERIAL`
69     - :dtcompatible:`gd,gd32-usart`
70   * - DAC
71     - :kconfig:option:`CONFIG_DAC`
72     - :dtcompatible:`gd,gd32-dac`
73   * - I2C
74     - :kconfig:option:`CONFIG_I2C`
75     - :dtcompatible:`gd,gd32-i2c`
76   * - EEPROM
77     - :kconfig:option:`CONFIG_EEPROM`
78     - :dtcompatible:`atmel,at24`
79
80Serial Port
81===========
82
83The GD32F450Z-EVAL board has one serial communication port. The default port
84is USART0 with TX connected at PA9 and RX at PA10.
85
86Programming and Debugging
87*************************
88
89Before programming your board make sure to configure boot and serial jumpers
90as follows:
91
92- JP3/JP4: Select 2-3 for both (boot from user memory)
93- JP13: Select 1-2 position (labeled as ``USART0``)
94
95Using GD-Link
96=============
97
98The GD32F450Z-EVAL includes an onboard programmer/debugger (GD-Link) which
99allows flash programming and debugging over USB. There is also a JTAG header
100(J1) which can be used with tools like Segger J-Link.
101
102#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application:
103
104   .. zephyr-app-commands::
105      :zephyr-app: samples/hello_world
106      :board: gd32f450z_eval
107      :goals: build
108      :compact:
109
110#. Run your favorite terminal program to listen for output. On Linux the
111   terminal should be something like ``/dev/ttyUSB0``. For example:
112
113   .. code-block:: console
114
115      minicom -D /dev/ttyUSB0 -o
116
117   The -o option tells minicom not to send the modem initialization
118   string. Connection should be configured as follows:
119
120      - Speed: 115200
121      - Data: 8 bits
122      - Parity: None
123      - Stop bits: 1
124
125#. To flash an image:
126
127   .. zephyr-app-commands::
128      :zephyr-app: samples/hello_world
129      :board: gd32f450z_eval
130      :goals: flash
131      :compact:
132
133   You should see "Hello World! gd32f450z_eval" in your terminal.
134
135#. To debug an image:
136
137   .. zephyr-app-commands::
138      :zephyr-app: samples/hello_world
139      :board: gd32f450z_eval
140      :goals: debug
141      :compact:
142
143
144.. _GigaDevice Cortex-M4F Stretch Performance SoC Website:
145   https://www.gigadevice.com/products/microcontrollers/gd32/arm-cortex-m4/stretch-performance-line/
146
147.. _GD32F450xx Datasheet:
148	https://gd32mcu.21ic.com/data/documents/shujushouce/GD32F450xx_Datasheet_Rev1.1.pdf
149
150.. _GD32F4xx User Manual:
151	https://www.gigadevice.com/manual/gd32f450xxxx-user-manual/
152
153.. _GD32F450Z-EVAL User Manual:
154  http://www.gd32mcu.com/download/down/document_id/118/path_type/1
155