3bca93b2d0
MicroPython code may rely on the return value of sys.stdout.buffer.write()
to reflect the number of bytes actually written. While in most scenarios a
write() operation is successful, there are cases where it fails, leading to
data loss. This problem arises because, currently, write() merely returns
the number of bytes it was supposed to write, without indication of
failure.
One scenario where write() might fail, is where USB is used and the
receiving end doesn't read quickly enough to empty the receive buffer. In
that case, write() on the MicroPython side can timeout, resulting in the
loss of data without any indication, a behavior observed notably in
communication between a Pi Pico as a client and a Linux host using the ACM
driver.
A complex issue arises with mp_hal_stdout_tx_strn() when it involves
multiple outputs, such as USB, dupterm and hardware UART. The challenge is
in handling cases where writing to one output is successful, but another
fails, either fully or partially. This patch implements the following
solution:
mp_hal_stdout_tx_strn() attempts to write len bytes to all of the possible
destinations for that data, and returns the minimum successful write
length.
The implementation of this is complicated by several factors:
- multiple outputs may be enabled or disabled at compiled time
- multiple outputs may be enabled or disabled at runtime
- mp_os_dupterm_tx_strn() is one such output, optionally containing
multiple additional outputs
- each of these outputs may or may not be able to report success
- each of these outputs may or may not be able to report partial writes
As a result, there's no single strategy that fits all ports, necessitating
unique logic for each instance of mp_hal_stdout_tx_strn().
Note that addressing sys.stdout.write() is more complex due to its data
modification process ("cooked" output), and it remains unchanged in this
patch. Developers who are concerned about accurate return values from
write operations should use sys.stdout.buffer.write().
This patch might disrupt some existing code, but it's also expected to
resolve issues, considering that the peculiar return value behavior of
sys.stdout.buffer.write() is not well-documented and likely not widely
known. Therefore, it's improbable that much existing code relies on the
previous behavior.
Signed-off-by: Maarten van der Schrieck <maarten@thingsconnected.nl>
|
||
|---|---|---|
| .. | ||
| boards | ||
| lwip_inc | ||
| mbedtls | ||
| mboot | ||
| usbdev | ||
| usbhost | ||
| Makefile | ||
| README.md | ||
| accel.c | ||
| accel.h | ||
| adc.c | ||
| adc.h | ||
| autoflash | ||
| boardctrl.c | ||
| boardctrl.h | ||
| bufhelper.c | ||
| bufhelper.h | ||
| can.c | ||
| can.h | ||
| cyw43_configport.h | ||
| dac.c | ||
| dac.h | ||
| dma.c | ||
| dma.h | ||
| eth.c | ||
| eth.h | ||
| extint.c | ||
| extint.h | ||
| factoryreset.c | ||
| factoryreset.h | ||
| fatfs_port.c | ||
| fdcan.c | ||
| flash.c | ||
| flash.h | ||
| flashbdev.c | ||
| gccollect.c | ||
| gccollect.h | ||
| help.c | ||
| i2c.c | ||
| i2c.h | ||
| i2cslave.c | ||
| i2cslave.h | ||
| irq.c | ||
| irq.h | ||
| lcd.c | ||
| lcd.h | ||
| led.c | ||
| led.h | ||
| machine_adc.c | ||
| machine_bitstream.c | ||
| machine_i2c.c | ||
| machine_i2s.c | ||
| machine_spi.c | ||
| machine_uart.c | ||
| machine_wdt.c | ||
| main.c | ||
| make-stmconst.py | ||
| modmachine.c | ||
| modmachine.h | ||
| modos.c | ||
| modpyb.c | ||
| modstm.c | ||
| modtime.c | ||
| mpbthciport.c | ||
| mpbthciport.h | ||
| mpbtstackport.c | ||
| mpbtstackport.h | ||
| mpconfigboard_common.h | ||
| mpconfigport.h | ||
| mpconfigport.mk | ||
| mpconfigport_nanbox.h | ||
| mphalport.c | ||
| mphalport.h | ||
| mpnetworkport.c | ||
| mpnimbleport.c | ||
| mpnimbleport.h | ||
| mpthreadport.c | ||
| mpthreadport.h | ||
| mpu.h | ||
| network_lan.c | ||
| octospi.c | ||
| octospi.h | ||
| pendsv.c | ||
| pendsv.h | ||
| pin.c | ||
| pin.h | ||
| pin_defs_stm32.c | ||
| pin_defs_stm32.h | ||
| pin_named_pins.c | ||
| pin_static_af.h | ||
| portmodules.h | ||
| powerctrl.c | ||
| powerctrl.h | ||
| powerctrlboot.c | ||
| pyb_can.c | ||
| pyb_i2c.c | ||
| pyb_spi.c | ||
| pybcdc.inf_template | ||
| pybthread.c | ||
| pybthread.h | ||
| qspi.c | ||
| qspi.h | ||
| qstrdefsport.h | ||
| resethandler.s | ||
| resethandler_m0.s | ||
| resethandler_m3.s | ||
| rfcore.c | ||
| rfcore.h | ||
| rng.c | ||
| rng.h | ||
| rtc.c | ||
| rtc.h | ||
| sdcard.c | ||
| sdcard.h | ||
| sdio.c | ||
| sdio.h | ||
| sdram.c | ||
| sdram.h | ||
| servo.c | ||
| servo.h | ||
| spi.c | ||
| spi.h | ||
| spibdev.c | ||
| stm32.mk | ||
| stm32_it.c | ||
| stm32_it.h | ||
| storage.c | ||
| storage.h | ||
| subghz.c | ||
| subghz.h | ||
| system_stm32.c | ||
| systick.c | ||
| systick.h | ||
| timer.c | ||
| timer.h | ||
| uart.c | ||
| uart.h | ||
| ulpi.c | ||
| ulpi.h | ||
| usb.c | ||
| usb.h | ||
| usbd_cdc_interface.c | ||
| usbd_cdc_interface.h | ||
| usbd_conf.c | ||
| usbd_conf.h | ||
| usbd_desc.c | ||
| usbd_desc.h | ||
| usbd_hid_interface.c | ||
| usbd_hid_interface.h | ||
| usbd_msc_interface.c | ||
| usbd_msc_interface.h | ||
| usrsw.c | ||
| 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, STM32H7, STM32L0, STM32L4 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.
The STM32H7 series has preliminary support: there is a working REPL via USB and UART, as well as very basic peripheral support, but some things do not work and none of the advanced features of the STM32H7 are yet supported, such as the clock tree. At this point the STM32H7 should be considered as a fast version of the STM32F7.
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
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
Flashing the Firmware with stlink
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