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 | ||
| fsp_cfg | ||
| lwip_inc | ||
| mbedtls | ||
| ra | ||
| Makefile | ||
| RA4M1_hal.h | ||
| RA4W1_hal.h | ||
| RA6M1_hal.h | ||
| RA6M2_hal.h | ||
| RA6M5_hal.h | ||
| README.md | ||
| boardctrl.c | ||
| boardctrl.h | ||
| build_all_boards.sh | ||
| extint.c | ||
| extint.h | ||
| factoryreset.c | ||
| factoryreset.h | ||
| fatfs_port.c | ||
| flash.c | ||
| flash.h | ||
| flashbdev.c | ||
| gccollect.c | ||
| gccollect.h | ||
| help.c | ||
| irq.c | ||
| irq.h | ||
| led.c | ||
| led.h | ||
| machine_adc.c | ||
| machine_dac.c | ||
| machine_i2c.c | ||
| machine_pin.c | ||
| machine_pwm.c | ||
| machine_rtc.c | ||
| machine_sdcard.c | ||
| machine_spi.c | ||
| machine_uart.c | ||
| main.c | ||
| modmachine.c | ||
| modmachine.h | ||
| modos.c | ||
| modtime.c | ||
| mpbthciport.c | ||
| mpbthciport.h | ||
| mpconfigboard_common.h | ||
| mpconfigport.h | ||
| mpconfigport.mk | ||
| mphalport.c | ||
| mphalport.h | ||
| mpnetworkport.c | ||
| mpnimbleport.c | ||
| mpnimbleport.h | ||
| mpthreadport.c | ||
| mpthreadport.h | ||
| pendsv.c | ||
| pendsv.h | ||
| pin.h | ||
| powerctrl.c | ||
| powerctrl.h | ||
| powerctrlboot.c | ||
| pybthread.c | ||
| pybthread.h | ||
| qstrdefsport.h | ||
| ra_hal.c | ||
| ra_it.c | ||
| ra_it.h | ||
| rng.c | ||
| rng.h | ||
| rtc.h | ||
| spi.h | ||
| storage.c | ||
| storage.h | ||
| systick.c | ||
| systick.h | ||
| timer.c | ||
| timer.h | ||
| uart.c | ||
| uart.h | ||
| usbd.c | ||
| usrsw.c | ||
| usrsw.h | ||
README.md
The Renesas RA port
This is a port of MicroPython to the Renesas RA family of microcontrollers. Currently supported features are:
- Filesystem on the internal flash using FatFs.
timemodule with sleep, time, and ticks functions.osmodule with VFS support.machinemodule with the following classes:Pin,ADC,PWM,DAC,I2C,SPI,SoftI2C,SoftSPI,UART,RTC,SDCard.sdcardmodule for MCUs without nativemachine.SDCardsupport.
Currently supported board product names are:
- EK-RA6M2
- RA4M1 CLICKER
- EK-RA6M1
- EK-RA4M1
- EK-RA4W1
Please refer to the quick reference of renesas-ra port for more
information about the boards.
Build instructions
-
MicroPython cross-compier The MicroPython cross-compiler must be built first, which will be used to pre-compile (freeze) built-in Python code. THis cross-compiler is built and run on the host machine, using:
$ make -C mpy-crossThis command should be executed from the root directory of this repository. All other commands below should be executed from the ports/renesas-ra/ directory.
-
Arm compiler An
Arm compileris required for the build, along with the associated binary utilities. The default compiler isarm-none-eabi-gcc, which is available for Linux, Mac and Windows hosts via https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads. The compiler can be changed using theCROSS_COMPILEvariable when invokingmake. -
Protocol buffer compiler Building for the
ARDUINO_PORTENTA_C33board will build theesp_hosteddriver, that depends on the Protocol Buffer Compiler being installed. On Debian/Ubuntu, this can be installed withsudo apt-get install protobuf-compiler. -
Obtain submodules First the submodules must be obtained using:
$ make submodules -
Build binary image
.hexThen to build for a given board subdirectory name, run:$ make BOARD=EK_RA6M2 clean $ make BOARD=EK_RA6M2The default board subdirectory name is EK_RA6M2 (which is for EK-RA6M2 board) but any of the names of the subdirectories in the
boards/directory can be passed as the argument toBOARD=; for exampleRA4M1_CLICKER,EK_RA4M1,EK_RA4W1andEK_RA6M1. The above command should produce binary imagesfirmware.hexin the build-EK_RA6M2/` subdirectory (or the equivalent directory for the board specified).
Supported/Unsupprted funtions
Please refer to the renesas-ra quick reference.
Known issues
all boards
-
machine.lightsleep(time_ms) and machine.deepsleep(time_ms) raise uncaught exceptions.
machine.deepsleep(1000) Uncaught exception in ExtInt interrupt handler line 16 TypeError:
RA4M1-CLICKER
- mpremote: mount command is not available due to limited memory resources.
EK-RA4M1
- mpremote: mount command is not available due to limited memory resources.
EK-RA4W1
- mpremote: "Execution: timeout waiting for remote" error happens when importing a file on /remote.