Skip to content

Commit

Permalink
boards: st: nucleo_g431kb: add support for nucleo g431kb
Browse files Browse the repository at this point in the history
Add support for the nucleo g431kb Board.

Signed-off-by: Klaus Nagel <nagelkl01@gmail.com>
  • Loading branch information
nagelkl authored and carlescufi committed Oct 15, 2024
1 parent ec2dd19 commit 03959a2
Show file tree
Hide file tree
Showing 9 changed files with 368 additions and 0 deletions.
5 changes: 5 additions & 0 deletions boards/st/nucleo_g431kb/Kconfig.nucleo_g431kb
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Copyright (c) 2024 Klaus Nagel <nagelkl01@gmail.com>
# SPDX-License-Identifier: Apache-2.0

config BOARD_NUCLEO_G431KB
select SOC_STM32G431XX
10 changes: 10 additions & 0 deletions boards/st/nucleo_g431kb/board.cmake
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# SPDX-License-Identifier: Apache-2.0

# keep first
board_runner_args(stm32cubeprogrammer "--port=swd" "--reset-mode=hw")
board_runner_args(pyocd "--target=stm32g431kbtx")

# keep first
include(${ZEPHYR_BASE}/boards/common/stm32cubeprogrammer.board.cmake)
include(${ZEPHYR_BASE}/boards/common/pyocd.board.cmake)
include(${ZEPHYR_BASE}/boards/common/openocd.board.cmake)
6 changes: 6 additions & 0 deletions boards/st/nucleo_g431kb/board.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
board:
name: nucleo_g431kb
full_name: Nucleo G431KB
vendor: st
socs:
- name: stm32g431xx
Binary file not shown.
189 changes: 189 additions & 0 deletions boards/st/nucleo_g431kb/doc/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,189 @@
.. _nucleo_g431kb_board:

ST Nucleo G431KB
################

Overview
********

The Nucleo G431KB board features an ARM Cortex-M4 based STM32G431KB MCU
with a wide range of connectivity support and configurations.
Here are some highlights of the Nucleo G431KB board:

- STM32 microcontroller in LQFP32 package
- Arduino Nano V3 connectivity
- On-board ST-LINK/V3E debugger/programmer
- Flexible board power supply:

- USB VBUS or external source(3.3 V, 5 V, 7 - 12 V)
- Power management access point

- Three LEDs: USB communication (LD1), power LED (LD3), user LED (LD2)
- One push-button for RESET

.. image:: img/nucleo_g431kb.webp
:align: center
:alt: Nucleo G431kB

More information about the board can be found at the `Nucleo G431KB website`_.

- Development support: serial wire debug (SWD), JTAG, Embedded Trace Macrocell.

More information about STM32G431KB can be found here:

- `STM32G431KB on www.st.com`_
- `STM32G4 reference manual`_

Supported Features
==================

The Zephyr ``nucleo_g431kb`` board target supports the following hardware features:

+-----------+------------+-------------------------------------+
| Interface | Controller | Driver/Component |
+===========+============+=====================================+
| NVIC | on-chip | nested vector interrupt controller |
+-----------+------------+-------------------------------------+
| UART | on-chip | serial port-polling; |
| | | serial port-interrupt |
+-----------+------------+-------------------------------------+
| PINMUX | on-chip | pinmux |
+-----------+------------+-------------------------------------+
| GPIO | on-chip | gpio |
+-----------+------------+-------------------------------------+
| PWM | on-chip | pwm |
+-----------+------------+-------------------------------------+
| I2C | on-chip | i2c |
+-----------+------------+-------------------------------------+

Other hardware features are not yet supported on this Zephyr port.

The default configuration can be found in the defconfig file:
:zephyr_file:`boards/st/nucleo_g431kb/nucleo_g431kb_defconfig`


Connections and IOs
===================

Nucleo G431KB Board has 6 GPIO controllers. These controllers are responsible for pin muxing,
input/output, pull-up, etc.

For more details please refer to `STM32G4 Nucleo-32 board User Manual`_.

Default Zephyr Peripheral Mapping:
----------------------------------

.. rst-class:: rst-columns

- LPUART_1_TX : PA2
- LPUART_1_RX : PA3
- LD2 : PB8
- PWM_4_CH_3 : PB8
- I2C_2_SCL : PA9
- I2C_2_SDA : PA8

System Clock
------------

The Nucleo G431KB System Clock could be driven by internal or external oscillator,
as well as main PLL clock. By default the external oscillator is not connected to the board. Therefore only the internal
High Speed oscillator is supported. By default System clock is driven by PLL clock at 170 MHz,
the PLL is driven by the 16 MHz high speed internal oscillator.

Serial Port
-----------

Nucleo G431KB board has 1 U(S)ARTs and one LPUART. The Zephyr console output is assigned to LPUART1.
Default settings are 115200 8N1.

Please note that LPUART1 baudrate is limited to 9600 if the MCU is clocked by LSE (32.768 kHz) in
low power mode.

Programming and Debugging
*************************

Nucleo G431KB Board includes an ST-Link/V3 embedded debug tool interface.

Applications for the ``nucleo_g431kb`` board target can be built and
flashed in the usual way (see :ref:`build_an_application` and
:ref:`application_run` for more details).

Flashing
========

The board is configured to be flashed using west `STM32CubeProgrammer`_ runner,
so its :ref:`installation <stm32cubeprog-flash-host-tools>` is required.

Alternatively, OpenOCD, or pyOCD can also be used to flash the board using
the ``--runner`` (or ``-r``) option:

.. code-block:: console
$ west flash --runner openocd
$ west flash --runner pyocd
To enable support of the STM32G431KB SoC in pyOCD, its pack has to be installed first:

.. code-block:: console
$ pyocd pack --update
$ pyocd pack --install stm32g431kb
Flashing an application to Nucleo G431KB
----------------------------------------

Connect the Nucleo G431KB to your host computer using the USB port,
then run a serial host program to connect with your Nucleo board.

.. code-block:: console
$ minicom -D /dev/ttyACM0
Now build and flash an application. Here is an example for
:zephyr:code-sample:`hello_world`.

.. zephyr-app-commands::
:zephyr-app: samples/hello_world
:board: nucleo_g431kb
:goals: build flash

You should see the following message on the console:

.. code-block:: console
$ Hello World! nucleo_g431kb/stm32g431xx
Debugging
=========

You can debug an application in the usual way. Here is an example for the
:zephyr:code-sample:`hello_world` application.

.. zephyr-app-commands::
:zephyr-app: samples/hello_world
:board: nucleo_g431kb
:maybe-skip-config:
:goals: debug

References
**********

.. target-notes::

.. _Nucleo G431KB website:
https://www.st.com/en/evaluation-tools/nucleo-g431kb.html

.. _STM32G4 Nucleo-32 board User Manual:
https://www.st.com/resource/en/user_manual/um2397-stm32g4-nucleo32-board-mb1430-stmicroelectronics.pdf

.. _STM32g431kb Nucleo-32 board schematic:
https://www.st.com/resource/en/schematic_pack/mb1430-g431kbt6-a02_schematic_internal.pdf

.. _STM32G431KB on www.st.com:
https://www.st.com/en/microcontrollers-microprocessors/stm32g431kb.html

.. _STM32G4 reference manual:
https://www.st.com/resource/en/reference_manual/rm0440-stm32g4-series-advanced-armbased-32bit-mcus-stmicroelectronics.pdf

.. _STM32CubeProgrammer:
https://www.st.com/en/development-tools/stm32cubeprog.html
117 changes: 117 additions & 0 deletions boards/st/nucleo_g431kb/nucleo_g431kb.dts
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
/*
* Copyright (c) 2024 Klaus Nagel, <nagelkl01@gmail.com>
*
* SPDX-License-Identifier: Apache-2.0
*/

/dts-v1/;
#include <st/g4/stm32g431Xb.dtsi>
#include <st/g4/stm32g431k(6-8-b)tx-pinctrl.dtsi>

/ {
model = "STMicroelectronics STM32G431KB-NUCLEO board";
compatible = "st,stm32g431kb-nucleo";

chosen {
zephyr,console = &lpuart1;
zephyr,shell-uart = &lpuart1;
zephyr,sram = &sram0;
zephyr,flash = &flash0;
};

leds: leds {
compatible = "gpio-leds";
green_led: led_0 {
gpios = <&gpiob 8 GPIO_ACTIVE_HIGH>;
label = "User LD2";
};

};

pwmleds {
compatible = "pwm-leds";

green_pwm_led: green_pwm_led {
pwms = <&pwm4 3 PWM_MSEC(20) PWM_POLARITY_NORMAL>;
};
};


aliases {
led0 = &green_led;
pwm-led0 = &green_pwm_led;
watchdog0 = &iwdg;
};
};

&clk_hsi {
status = "okay";
};

&clk_lsi {
status = "okay";
};

stm32_lp_tick_source: &lptim1 {
clocks = <&rcc STM32_CLOCK_BUS_APB1 0x80000000>,
<&rcc STM32_SRC_LSI LPTIM1_SEL(3)>;
status = "okay";
};

/* Adjust the pll for a SYSTEM Clock of 170MHz */
&pll {
div-m = <4>;
mul-n = <85>;
div-p = <7>;
div-q = <2>;
div-r = <2>;
clocks = <&clk_hsi>;
status = "okay";
};

&rcc {
clocks = <&pll>;
clock-frequency = <DT_FREQ_M(170)>;
ahb-prescaler = <1>;
apb1-prescaler = <1>;
apb2-prescaler = <1>;
};

&lpuart1 {
pinctrl-0 = <&lpuart1_tx_pa2 &lpuart1_rx_pa3>;
pinctrl-names = "default";
current-speed = <115200>;
status = "okay";
};

&timers4 {
st,prescaler = <10000>;
status = "okay";

pwm4: pwm {
status = "okay";
pinctrl-0 = <&tim4_ch3_pb8>;
pinctrl-names = "default";
};
};

&i2c2 {
pinctrl-0 = <&i2c2_scl_pa9 &i2c2_sda_pa8>;
pinctrl-names = "default";
status = "okay";
};

&flash0 {

partitions {
compatible = "fixed-partitions";
#address-cells = <1>;
#size-cells = <1>;

/* Set 4Kb of storage at the end of the 128Kb of flash */
storage_partition: partition@1f000 {
label = "storage";
reg = <0x0001f000 DT_SIZE_K(4)>;
};
};
};
16 changes: 16 additions & 0 deletions boards/st/nucleo_g431kb/nucleo_g431kb.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
identifier: nucleo_g431kb
name: ST Nucleo G431KB
type: mcu
arch: arm
toolchain:
- zephyr
- gnuarmemb
- xtools
ram: 32
flash: 128
supported:
- gpio
- pwm
- counter
- i2c
vendor: st
18 changes: 18 additions & 0 deletions boards/st/nucleo_g431kb/nucleo_g431kb_defconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# SPDX-License-Identifier: Apache-2.0

# Serial drivers
CONFIG_SERIAL=y
CONFIG_UART_INTERRUPT_DRIVEN=y

# enable GPIO
CONFIG_GPIO=y

# Console
CONFIG_CONSOLE=y
CONFIG_UART_CONSOLE=y

# Enable MPU
CONFIG_ARM_MPU=y

# Enable HW stack protection
CONFIG_HW_STACK_PROTECTION=y
7 changes: 7 additions & 0 deletions boards/st/nucleo_g431kb/support/openocd.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
source [find interface/stlink.cfg]

transport select hla_swd

source [find target/stm32g4x.cfg]

reset_config srst_only

0 comments on commit 03959a2

Please sign in to comment.