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 | ||
| hal | ||
| lwip_inc | ||
| mbedtls | ||
| modules | ||
| Makefile | ||
| README.md | ||
| board_init.c | ||
| cyw43_configport.h | ||
| dma_manager.c | ||
| dma_manager.h | ||
| eth.c | ||
| eth.h | ||
| fatfs_port.c | ||
| flash.c | ||
| flash.h | ||
| help.c | ||
| irq.h | ||
| led.c | ||
| led.h | ||
| machine_adc.c | ||
| machine_bitstream.c | ||
| machine_i2c.c | ||
| machine_i2s.c | ||
| machine_led.c | ||
| machine_pin.c | ||
| machine_pwm.c | ||
| machine_rtc.c | ||
| machine_sdcard.c | ||
| machine_spi.c | ||
| machine_uart.c | ||
| machine_wdt.c | ||
| main.c | ||
| mimxrt_flash.c | ||
| mimxrt_sdram.c | ||
| modmachine.c | ||
| modmachine.h | ||
| modmimxrt.c | ||
| modmimxrt.h | ||
| modos.c | ||
| modtime.c | ||
| mpbthciport.c | ||
| mpbthciport.h | ||
| mpconfigport.h | ||
| mphalport.c | ||
| mphalport.h | ||
| mpnetworkport.c | ||
| mpnimbleport.c | ||
| mpnimbleport.h | ||
| network_lan.c | ||
| pendsv.c | ||
| pendsv.h | ||
| pin.c | ||
| pin.h | ||
| qstrdefsport.h | ||
| sdcard.c | ||
| sdcard.h | ||
| sdio.c | ||
| sdio.h | ||
| systick.c | ||
| systick.h | ||
| ticks.c | ||
| ticks.h | ||
| tusb_config.h | ||
| tusb_port.c | ||
README.md
Port of MicroPython to NXP iMX RT 10xx
Currently supports Teensy 4.0, Teensy 4.1, and the MIMXRT1010_EVK, MIMXRT1020_EVK, MIMXRT1050_EVK, MIMXRT1060_EVK and MIMXRT1064_EVK boards.
Features:
- REPL over USB VCP
- machine.ADC
- machine.I2C
- machine.LED
- machine.Pin
- machine.PWM
- machine.RTC
- machine.SDCard
- machine.SPI
- machine.Signal
- machine.SoftI2C
- machine.SoftSPI
- machine.Timer
- machine.UART
- LFS2 file system at the internal Flash
- SDCard support (not on MIMXRT1010_EVK)
- Ethernet (not on Teensy 4.0 and MIMXRT1010_EVK)
Known issues:
TODO:
- More peripherals (Counter, I2S, CAN, etc)
- More Python options
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/mimxrt/ 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.
In addition newlib is required which is available for Arch Linux via the
package arm-none-eabi-newlib, for Ubuntu/Debian install package libnewlib-arm-none-eabi
Next, the board to build must be selected. Any of the board 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 SEEED_ARCH_MIX
as an example of the selected board):
$ make BOARD=SEEED_ARCH_MIX submodules
Then to build the board's firmware run:
$ make BOARD=SEEED_ARCH_MIX
The above command should produce binary images in the build-SEEED_ARCH_MIX/
subdirectory (or the equivalent directory for the board specified).
Flashing
Deploy the firmware following the instructions here https://docs.micropython.org/en/latest/mimxrt/tutorial/intro.html#deploying-the-firmware