micropython/ports/stm32
iabdalkader 23d7a915c1 stm32/mpremoteprocport: Use metal logging functions.
Signed-off-by: iabdalkader <i.abdalkader@gmail.com>
2024-03-29 17:59:18 +11:00
..
boards stm32/boards/ARDUINO_PORTENTA_H7: Add Arduino's external library. 2024-03-26 17:03:56 +11:00
lwip_inc stm32: Add optional lwip loopback support. 2023-11-17 13:37:04 +11:00
mbedtls all: Update bindings, ports and tests for mbedtls v3.5.1. 2024-01-30 11:08:46 +11:00
mboot stm32/mboot: Add support for a raw filesystem. 2024-03-19 11:38:36 +11:00
usbdev all: Prune trailing whitespace. 2024-03-07 16:25:17 +11:00
usbhost
Makefile stm32: Implement port backend for OpenAMP's remoteproc. 2024-03-15 18:11:28 +11:00
README.md stm32/README: Update list of supported STM32 series. 2024-03-28 12:34:46 +11:00
accel.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
accel.h
adc.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
adc.h stm32: Add initial support for H5 MCUs. 2023-06-15 11:09:20 +10:00
autoflash
boardctrl.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
boardctrl.h stm32/boardctrl: Allow boards to override fatal-error handler. 2022-07-08 23:47:29 +10:00
bufhelper.c ports: Convert legacy uppercase macro names to lowercase. 2019-02-12 14:54:51 +11:00
bufhelper.h
can.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
can.h stm32/pyb_can: Add support for bus with mixed Classic/FD nodes. 2022-04-02 22:37:52 +11:00
cyw43_configport.h extmod/modnetwork: Forward if.config(hostname) to network.hostname. 2023-10-04 12:39:51 +11:00
dac.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
dac.h stm32/dac: Deinit all DACs on soft reset. 2022-01-27 17:10:39 +11:00
dma.c stm32/dma: Add D-cache protection for DMA RX operations, including SPI. 2024-03-08 12:19:48 +11:00
dma.h stm32/dma: Add D-cache protection for DMA RX operations, including SPI. 2024-03-08 12:19:48 +11:00
eth.c stm32/network_lan: Add the phy_type=x keyword option to network.LAN(). 2024-03-07 17:54:56 +11:00
eth.h stm32/network_lan: Add the phy_type=x keyword option to network.LAN(). 2024-03-07 17:54:56 +11:00
eth_phy.c stm32/network_lan: Add the phy_type=x keyword option to network.LAN(). 2024-03-07 17:54:56 +11:00
eth_phy.h stm32/network_lan: Add the phy_type=x keyword option to network.LAN(). 2024-03-07 17:54:56 +11:00
extint.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
extint.h stm32: Rename pin_obj_t to machine_pin_obj_t. 2023-11-03 14:09:08 +11:00
factoryreset.c ports: Standardise docs link in help text. 2023-06-02 11:48:46 +10:00
factoryreset.h stm32: Generalise flash mounting code so it supports arbitrary FS. 2019-11-25 18:10:58 +11:00
fatfs_port.c
fdcan.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
flash.c stm32/flash: Fix sector and bank calculation for H5 and H7 MCUs. 2024-01-08 12:35:48 +11:00
flash.h stm32/flash: Change flash_erase to only erase a single sector at a time. 2024-01-08 12:33:34 +11:00
flashbdev.c stm32/flashbdev: Don't rely on flash sector id. 2024-01-08 12:34:18 +11:00
gccollect.c stm32: Remove commented-out printf's and debugging code. 2023-03-09 12:47:45 +11:00
gccollect.h stm32: In link script, define start of stack separately from heap end. 2019-06-14 15:29:24 +10:00
help.c stm32/help: Exclude legacy entries from help, and adjust constant names. 2023-06-02 12:43:58 +10:00
i2c.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
i2c.h stm32/i2c: Return error code and raise exception if I2C init fails. 2023-03-09 12:47:45 +11:00
i2cslave.c stm32/i2cslave: Pass I2C instance to callbacks to support multi I2Cs. 2020-06-26 23:56:45 +10:00
i2cslave.h stm32: Add initial support for H5 MCUs. 2023-06-15 11:09:20 +10:00
irq.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
irq.h stm32: Implement port backend for libmetal. 2024-03-15 18:11:28 +11:00
lcd.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
lcd.h
led.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
led.h
machine_adc.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
machine_bitstream.c extmod/modmachine: Consolidate simple machine headers into modmachine.h. 2023-10-26 16:49:27 +11:00
machine_i2c.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
machine_i2s.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
machine_spi.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
machine_uart.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
machine_wdt.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
main.c mimxrt,stm32: Set the security mode for the default WiFi AP. 2024-03-28 12:51:50 +11:00
make-stmconst.py all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
modmachine.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
modmachine.h extmod/modmachine: Provide common bindings for 6 bare-metal functions. 2023-11-30 16:11:11 +11:00
modos.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
modpyb.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
modstm.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
modtime.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
mpbthciport.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
mpbthciport.h stm32/mpbthciport: Allow a board to hook BT HCI poll functions. 2021-10-20 21:20:18 +11:00
mpbtstackport.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
mpbtstackport.h extmod/modbluetooth: Refactor stack/hci/driver/port bindings. 2020-09-08 11:41:31 +10:00
mpconfigboard_common.h stm32: Add support for dual-analog-pad "_C" pins on H7 MCUs. 2024-03-08 12:38:00 +11:00
mpconfigport.h extmod/modmachine: Add MICROPY_PY_MACHINE_RESET configuration option. 2024-03-15 12:04:37 +11:00
mpconfigport.mk stm32: Remove support for CC3000 WiFi driver. 2022-08-26 12:51:37 +10:00
mpconfigport_nanbox.h stm32: Add configuration to build in nanbox mode. 2019-12-27 22:54:53 +11:00
mphalport.c ports: Fix sys.stdout.buffer.write() return value. 2023-12-22 10:32:46 +11:00
mphalport.h ports: Move MICROPY_PY_LWIP_ENTER/REENTER/EXIT defns to mphalport.h. 2024-01-05 15:40:06 +11:00
mpmetalport.c stm32: Implement port backend for libmetal. 2024-03-15 18:11:28 +11:00
mpmetalport.h stm32: Implement port backend for libmetal. 2024-03-15 18:11:28 +11:00
mpnetworkport.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
mpnimbleport.c stm32/mpbthciport: Change from systick to soft-timer for BT scheduling. 2021-06-23 13:14:26 +10:00
mpnimbleport.h extmod/modbluetooth: Refactor stack/hci/driver/port bindings. 2020-09-08 11:41:31 +10:00
mpremoteprocport.c stm32/mpremoteprocport: Use metal logging functions. 2024-03-29 17:59:18 +11:00
mpthreadport.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
mpthreadport.h ports: Don't include mpthread.h in mpthreadport.h. 2024-02-29 13:35:36 +11:00
mpu.h stm32/mpu: Add MPU config for shared, uncached memory region. 2024-03-15 18:11:28 +11:00
network_lan.c stm32/network_lan: Add the phy_type=x keyword option to network.LAN(). 2024-03-07 17:54:56 +11:00
octospi.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
octospi.h stm32/octospi: Add preliminary support for OCTOSPI peripheral. 2023-06-15 11:09:37 +10:00
pendsv.c all: Fix spelling mistakes based on codespell check. 2023-04-27 18:03:06 +10:00
pendsv.h stm32: Add definitions required for lwIP version of Wiznet NIC. 2022-08-23 14:58:13 +10:00
pin.c stm32: Add support for dual-analog-pad "_C" pins on H7 MCUs. 2024-03-08 12:38:00 +11:00
pin.h stm32: Add support for dual-analog-pad "_C" pins on H7 MCUs. 2024-03-08 12:38:00 +11:00
pin_defs_stm32.c stm32: Rename pin_obj_t to machine_pin_obj_t. 2023-11-03 14:09:08 +11:00
pin_defs_stm32.h stm32: Rename pin_obj_t to machine_pin_obj_t. 2023-11-03 14:09:08 +11:00
pin_named_pins.c stm32: Rename pin_obj_t to machine_pin_obj_t. 2023-11-03 14:09:08 +11:00
pin_static_af.h stm32: Add missing header include for debug builds. 2023-11-28 23:32:52 +11:00
portmodules.h all: Rename mp_umodule*, mp_module_umodule* to remove the "u" prefix. 2023-06-08 17:54:04 +10:00
powerctrl.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
powerctrl.h extmod/modmachine: Provide common bindings for 6 bare-metal functions. 2023-11-30 16:11:11 +11:00
powerctrlboot.c stm32: Add STM32H5 support for sleep mode. 2023-11-03 17:14:05 +11:00
pyb_can.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
pyb_i2c.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
pyb_spi.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
pybcdc.inf_template
pybthread.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
pybthread.h stm32/pybthread: Make pyb_thread_dump take a printer as its argument. 2023-03-09 13:20:59 +11:00
qspi.c stm32/mpu: Rename MPU_CONFIG_DISABLE to MPU_CONFIG_NOACCESS. 2024-03-08 10:39:02 +11:00
qspi.h
qstrdefsport.h all: Rename mod_umodule*, ^umodule* to remove the "u" prefix. 2023-06-08 17:54:07 +10:00
resethandler.s stm32/powerctrlboot: Provide custom SystemInit for WB55. 2023-03-08 14:04:14 +11:00
resethandler_m0.s stm32/powerctrlboot: Provide custom SystemInit for WB55. 2023-03-08 14:04:14 +11:00
resethandler_m3.s stm32/powerctrlboot: Provide custom SystemInit for WB55. 2023-03-08 14:04:14 +11:00
rfcore.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
rfcore.h stm32/powerctrl: Disable WB55 BLE before entering deepsleep. 2023-03-08 14:03:36 +11:00
rng.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
rng.h
rtc.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
rtc.h stm32/rtc.h: Include py/obj.h to make header self contained. 2020-09-10 20:46:40 +10:00
sdcard.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
sdcard.h stm32/sdcard: Add sdcard_select_sd/mmc functions. 2022-03-22 12:38:45 +11:00
sdio.c stm32/sdio: Use runtime calculation for clock divider of sdio on H7. 2022-03-30 15:40:59 +11:00
sdio.h stm32/sdio: Add functions to re/enable SDIO/SDIOIT. 2021-04-30 01:12:08 +10:00
sdram.c stm32/sdram: Fix MPU config to use MPU_CONFIG_NOACCESS. 2024-03-09 10:50:43 +11:00
sdram.h stm32/sdram: Add function to enable SDRAM power-down mode. 2022-04-11 16:00:40 +10:00
servo.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
servo.h
spi.c stm32/dma: Add D-cache protection for DMA RX operations, including SPI. 2024-03-08 12:19:48 +11:00
spi.h extmod/modmachine: Clean up decls of machine types to use common ones. 2023-10-26 16:20:53 +11:00
spibdev.c drivers/bus: Detect QSPI transfer errors and pass up to spiflash driver. 2022-12-09 13:25:18 +11:00
stm32.mk stm32/stm32.mk: Enable _Float16 support on MCUs with hardware floats. 2024-03-20 14:13:49 +11:00
stm32_it.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
stm32_it.h
storage.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
storage.h stm32/storage: Make extended-block-device more configurable. 2021-08-31 00:16:39 +10:00
subghz.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
subghz.h stm32/subghz: Add STM32WL55 subghz radio interface to stm module. 2023-08-23 11:58:11 +10:00
system_stm32.c stm32: Add configuration options for analog switches. 2023-11-03 16:27:10 +11:00
systick.c all: Fix spelling mistakes based on codespell check. 2023-04-27 18:03:06 +10:00
systick.h stm32/mpbthciport: Change from systick to soft-timer for BT scheduling. 2021-06-23 13:14:26 +10:00
timer.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
timer.h
uart.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
uart.h extmod/machine_uart: Factor ports' UART Python bindings to common code. 2023-10-26 10:46:42 +11:00
ulpi.c all: Reformat remaining C code that doesn't have a space after a comma. 2022-05-05 13:30:40 +10:00
ulpi.h stm32/ulpi: Add USB3320 ULPI low-power functions. 2022-04-26 23:11:50 +10:00
usb.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
usb.h ports: Rename USBD_VID/PID config macros to MICROPY_HW_USB_VID/PID. 2021-08-07 23:13:55 +10:00
usbd_cdc_interface.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
usbd_cdc_interface.h stm32/usbd_cdc_interface: Add support for Arduino 1200bps touch. 2022-06-23 14:30:07 +10:00
usbd_conf.c stm32: Add USB support for STM32L1 MCUs. 2023-06-27 22:28:31 +09:00
usbd_conf.h stm32/usbdev: Optionally pass through vendor requests to Setup function. 2023-12-20 17:25:10 +11:00
usbd_desc.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
usbd_desc.h
usbd_hid_interface.c all: Reformat C and Python source code with tools/codeformat.py. 2020-02-28 10:33:03 +11:00
usbd_hid_interface.h stm32/usb: Expose USB HID device instance via usbd_hid_get(). 2022-06-24 18:33:26 +10:00
usbd_msc_interface.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
usbd_msc_interface.h stm32/usbdev: Fix calculation of SCSI LUN size with multiple LUNs. 2020-07-25 01:12:07 +10:00
usrsw.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
usrsw.h

README.md

MicroPython port to STM32 MCUs

This directory contains the port of MicroPython to ST's line of STM32 microcontrollers. Supported MCU series are: STM32F0, STM32F4, STM32F7, STM32G0, STM32G4, STM32H5, STM32H7, STM32L0, STM32L1, STM32L4, STM32WL and STM32WB. Parts of the code here utilise the STM32Cube HAL library.

The officially supported boards are the line of pyboards: PYBv1.0 and PYBv1.1 (both with STM32F405), PYBLITEv1.0 (with STM32F411) and PYBD-SFx (with STM32F7xx MCUs). See micropython.org/pyboard for further details.

Other boards that are supported include ST Discovery and Nucleo boards. See the boards/ subdirectory, which contains the configuration files used to build each individual board.

Build instructions

Before building the firmware for a given board the MicroPython cross-compiler must be built; it will be used to pre-compile some of the built-in scripts to bytecode. The cross-compiler is built and run on the host machine, using:

$ make -C mpy-cross

This command should be executed from the root directory of this repository. All other commands below should be executed from the ports/stm32/ directory.

An ARM compiler is required for the build, along with the associated binary utilities. The default compiler is arm-none-eabi-gcc, which is available for Arch Linux via the package arm-none-eabi-gcc, for Ubuntu via instructions here, or see here for the main GCC ARM Embedded page. The compiler can be changed using the CROSS_COMPILE variable when invoking make.

Next, the board to build must be selected. The default board is PYBV10 but any of the names of the subdirectories in the boards/ directory is a valid board. The board name must be passed as the argument to BOARD= when invoking make.

All boards require certain submodules to be obtained before they can be built. The correct set of submodules can be initialised using (with PYBV11 as an example of the selected board):

$ make BOARD=PYBV11 submodules

Then to build the board's firmware run:

$ make BOARD=PYBV11

The above command should produce binary images in the build-PYBV11/ subdirectory (or the equivalent directory for the board specified).

Note that some boards require the mboot bootloader to be built and deployed before flashing the main firmware. For such boards an information message about this will be printed at the end of the main firmware build. Mboot can be built via:

$ make -C mboot BOARD=STM32F769DISC

For more information about mboot see mboot/README.md.

Link Time Optimization (LTO) reduces the firmware binary size when enabled (typically 2-3% smaller). However it may make build time longer, particularly on older GCC versions.

Currently LTO is enabled by default for some smaller STM32 boards with less flash, but disabled on other boards.

To enable LTO, pass LTO=1 on the command line:

$ make BOARD=boardname LTO=1

To disable LTO, pass LTO=0 in the same way.

Note that make clean BOARD=boardname will be needed before changing the LTO setting of a firmware that is already built.

Flashing the Firmware using DFU mode

You must then get your board/microcontroller into DFU (Device Firmware Update) mode.

If you already have MicroPython installed on the board you can do that by calling machine.bootloader() on the board, either at the REPL or using pyboard.py. A nice property of this approach is that you can automate it so you can update the board without manually pressing any buttons.

If you do not have MicroPython running yet, temporarily jumper your board's DFU pin (typ. BOOT0) to 3.3v and reset or power-on the board.

On a pyboard the P1/DFU pin and a 3.3v pin are next to each other (on the bottom left of the board, second row from the bottom) and the reset button is labeled RST.

For the pyboard D-series you can enter the mboot DFU bootloader by holding down the USR button, pressing and releasing the RST button, and continuing to hold down USR until the LED is white (4th in the cycle), then let go of USR while the LED is white. The LED will then flash red once per second to indicate it is in USB DFU mode.

Once the board is in DFU mode, flash the firmware using the command:

$ make BOARD=PYBV11 deploy

This will use the included tools/pydfu.py script. You can use instead the dfu-util program (available here) by passing USE_PYDFU=0:

$ make BOARD=PYBV11 USE_PYDFU=0 deploy

If flashing the firmware does not work it may be because you don't have the correct permissions. Try then:

$ sudo make BOARD=PYBV11 deploy

Or using dfu-util directly:

$ sudo dfu-util -a 0 -d 0483:df11 -D build-PYBV11/firmware.dfu

ST Discovery or Nucleo boards have a builtin programmer called ST-LINK. With these boards and using Linux or OS X, you have the option to upload the stm32 firmware using the st-flash utility from the stlink project. To do so, connect the board with a mini USB cable to its ST-LINK USB port and then use the make target deploy-stlink. For example, if you have the STM32F4DISCOVERY board, you can run:

$ make BOARD=STM32F4DISC deploy-stlink

The st-flash program should detect the USB connection to the board automatically. If not, run lsusb to determine its USB bus and device number and set the STLINK_DEVICE environment variable accordingly, using the format <USB_BUS>:<USB_ADDR>. Example:

$ lsusb
[...]
Bus 002 Device 035: ID 0483:3748 STMicroelectronics ST-LINK/V2
$ export STLINK_DEVICE="002:0035"
$ make BOARD=STM32F4DISC deploy-stlink

Flashing the Firmware with OpenOCD

Another option to deploy the firmware on ST Discovery or Nucleo boards with a ST-LINK interface uses OpenOCD. Connect the board with a mini USB cable to its ST-LINK USB port and then use the make target deploy-openocd. For example, if you have the STM32F4DISCOVERY board:

$ make BOARD=STM32F4DISC deploy-openocd

The openocd program, which writes the firmware to the target board's flash, is configured via the file ports/stm32/boards/openocd_stm32f4.cfg. This configuration should work for all boards based on a STM32F4xx MCU with a ST-LINKv2 interface. You can override the path to this configuration by setting OPENOCD_CONFIG in your Makefile or on the command line.

Accessing the board

Once built and deployed, access the MicroPython REPL (the Python prompt) via USB serial or UART, depending on the board. There are many ways to do this, one of which is via mpremote (install it using pip install mpremote):

$ mpremote

Other options are picocom and screen, for example:

$ picocom /dev/ttyACM0