1.. zephyr:board:: gd32e507z_eval
2
3Overview
4********
5
6The GD32E507Z-EVAL board is a hardware platform that enables prototyping
7on GD32E507ZE Cortex-M33 High Performance MCU.
8
9The GD32E507ZE features a single-core ARM Cortex-M33 MCU which can run up
10to 180 MHz with flash accesses zero wait states, 512kiB of Flash, 128kiB of
11SRAM and 112 GPIOs.
12
13Hardware
14********
15
16- GD32E507ZET6 MCU
17- AT24C02C 2Kb EEPROM
18- GD25Q16 16Mbit SPI and QSPI NOR Flash
19- GD9FU1G8F2A 1Gbit NAND Flash
20- Micron MT48LC16M16A2P-6AIT 256Mbit SDRAM
21- 4 x User LEDs
22- 1 x Joystick (L/R/U/D/C)
23- 1 x USART (connected to USB VCOM at J1 connector)
24- 1 x POT connected to an ADC input
25- Headphone interface
26- USB FS connector
27- 1 x CAN (includes SN65HVD230 PHY)
28- Ethernet Interface
29- 3.2" RGB-LCD (320x240)
30- GD-Link on board programmer
31- J-Link/JTAG connector
32
33For more information about the GD32E507 SoC and GD32E507Z-EVAL board:
34
35- `GigaDevice Cortex-M33 High Performance SoC Website`_
36- `GD32E507X Datasheet`_
37- `GD32E50X User Manual`_
38- `GD32E507Z-EVAL User Manual`_
39
40Supported Features
41==================
42
43The board configuration supports the following hardware features:
44
45.. list-table::
46   :header-rows: 1
47
48   * - Peripheral
49     - Kconfig option
50     - Devicetree compatible
51   * - EXTI
52     - :kconfig:option:`CONFIG_GD32_EXTI`
53     - :dtcompatible:`gd,gd32-exti`
54   * - GPIO
55     - :kconfig:option:`CONFIG_GPIO`
56     - :dtcompatible:`gd,gd32-gpio`
57   * - NVIC
58     - N/A
59     - :dtcompatible:`arm,v8m-nvic`
60   * - PWM
61     - :kconfig:option:`CONFIG_PWM`
62     - :dtcompatible:`gd,gd32-pwm`
63   * - SYSTICK
64     - N/A
65     - N/A
66   * - USART
67     - :kconfig:option:`CONFIG_SERIAL`
68     - :dtcompatible:`gd,gd32-usart`
69
70Serial Port
71===========
72
73The GD32E507Z-EVAL board has one serial communication port. The default port
74is USART0 with TX connected at PA9 and RX at PA10. USART0 is exposed as a
75virtual COM port via the J1 USB connector.
76
77Programming and Debugging
78*************************
79
80Before programming your board make sure to configure boot jumpers as
81follows:
82
83- JP3/4: Select 2-3 for both (boot from user memory)
84
85Using GD-Link or J-Link
86=======================
87
88The board comes with an embedded GD-Link programmer. It can be used with pyOCD
89provided you install the necessary CMSIS-Pack:
90
91.. code-block:: console
92
93   pyocd pack install gd32e507ze
94
95J-Link can also be used to program the board using the JTAG interface exposed in
96the JP2 header.
97
98#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application:
99
100   .. zephyr-app-commands::
101      :zephyr-app: samples/hello_world
102      :board: gd32e507z_eval
103      :goals: build
104      :compact:
105
106#. Run your favorite terminal program to listen for output. On Linux the
107   terminal should be something like ``/dev/ttyUSB0``. For example:
108
109   .. code-block:: console
110
111      minicom -D /dev/ttyUSB0 -o
112
113   The -o option tells minicom not to send the modem initialization
114   string. Connection should be configured as follows:
115
116      - Speed: 115200
117      - Data: 8 bits
118      - Parity: None
119      - Stop bits: 1
120
121#. To flash an image:
122
123   .. zephyr-app-commands::
124      :zephyr-app: samples/hello_world
125      :board: gd32e507z_eval
126      :goals: flash
127      :compact:
128
129   You should see "Hello World! gd32e507z_eval" in your terminal.
130
131#. To debug an image:
132
133   .. zephyr-app-commands::
134      :zephyr-app: samples/hello_world
135      :board: gd32e507z_eval
136      :goals: debug
137      :compact:
138
139.. _GigaDevice Cortex-M33 High Performance SoC Website:
140   https://www.gigadevice.com/products/microcontrollers/gd32/arm-cortex-m33/high-performance-line/
141
142.. _GD32E507X Datasheet:
143   https://gd32mcu.com/download/down/document_id/252/path_type/1
144
145.. _GD32E50X User Manual:
146   https://www.gd32mcu.com/download/down/document_id/249/path_type/1
147
148.. _GD32E507Z-EVAL User Manual:
149   https://www.gd32mcu.com/data/documents/evaluationBoard/GD32E50x_Demo_Suites_V1.2.1.rar
150