micropython/ports/mimxrt
Angus Gratton decf8e6a8b all: Remove the "STATIC" macro and just use "static" instead.
The STATIC macro was introduced a very long time ago in commit
d5df6cd44a.  The original reason for this was
to have the option to define it to nothing so that all static functions
become global functions and therefore visible to certain debug tools, so
one could do function size comparison and other things.

This STATIC feature is rarely (if ever) used.  And with the use of LTO and
heavy inline optimisation, analysing the size of individual functions when
they are not static is not a good representation of the size of code when
fully optimised.

So the macro does not have much use and it's simpler to just remove it.
Then you know exactly what it's doing.  For example, newcomers don't have
to learn what the STATIC macro is and why it exists.  Reading the code is
also less "loud" with a lowercase static.

One other minor point in favour of removing it, is that it stops bugs with
`STATIC inline`, which should always be `static inline`.

Methodology for this commit was:

1) git ls-files | egrep '\.[ch]$' | \
   xargs sed -Ei "s/(^| )STATIC($| )/\1static\2/"

2) Do some manual cleanup in the diff by searching for the word STATIC in
   comments and changing those back.

3) "git-grep STATIC docs/", manually fixed those cases.

4) "rg -t python STATIC", manually fixed codegen lines that used STATIC.

This work was funded through GitHub Sponsors.

Signed-off-by: Angus Gratton <angus@redyak.com.au>
2024-03-07 14:20:42 +11:00
..
boards ports: Use vfs module instead of os. 2024-02-07 13:25:09 +11:00
hal mimxrt/hal: Make flash clock frequency configurable. 2023-08-15 23:45:22 +10:00
lwip_inc mimxrt: Re-Enable eth checksum creation by HW. 2021-12-14 08:07:52 +01:00
mbedtls all: Update bindings, ports and tests for mbedtls v3.5.1. 2024-01-30 11:08:46 +11:00
modules ports: Use vfs module instead of os. 2024-02-07 13:25:09 +11:00
Makefile ports: Fix handling of paths containing spaces in Makefiles. 2024-01-24 10:43:18 +11:00
README.md mimxrt/README: Add build and flashing instructions. 2022-11-17 14:21:59 +11:00
board_init.c mimxrt/irq: Move all IRQ related definitions to dedicated header. 2023-09-01 00:02:19 +10:00
cyw43_configport.h mimxrt: Fix header include guard names. 2024-02-15 09:45:14 +11:00
dma_manager.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
dma_manager.h mixmrt/machine_i2s: Add I2S protocol support. 2022-03-30 14:12:40 +11:00
eth.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
eth.h mimxrt: Add support for MIMXRT1176 MCUs, and MIMXRT1170_EVK board. 2022-11-17 14:11:50 +11:00
fatfs_port.c mimxrt/sdcard: Implement SDCard driver. 2021-09-07 20:45:33 +02:00
flash.c mimxrt/flash: Separate low level driver code from flash object. 2023-05-09 15:18:36 +10:00
flash.h mimxrt/flash: Separate low level driver code from flash object. 2023-05-09 15:18:36 +10:00
help.c ports: Standardise docs link in help text. 2023-06-02 11:48:46 +10:00
irq.h mimxrt/irq: Move all IRQ related definitions to dedicated header. 2023-09-01 00:02:19 +10:00
led.c mimxrt/boards/make-pins.py: Update to use tools/boardgen.py. 2023-11-03 14:18:54 +11:00
led.h mimxrt/led: Add support for up to four LEDs. 2023-05-23 10:54:23 +10:00
machine_adc.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
machine_bitstream.c mimxrt: Fix cycle counter for time.ticks_cpu() and machine.bitstream(). 2021-10-25 15:50:44 +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_led.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
machine_pin.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
machine_pwm.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
machine_rtc.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
machine_sdcard.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 ports: On cold boot, enable USB after boot.py completes. 2024-02-15 12:31:26 +11:00
mimxrt_flash.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
mimxrt_sdram.c mimxrt/mimxrt_sdram: Allow boards to override the default SDRAM config. 2023-09-29 23:08:48 +10: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: Clean up decls of machine types to use common ones. 2023-10-26 16:20:53 +11:00
modmimxrt.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
modmimxrt.h mimxrt: Add flash storage support with VFS and littlefs filesystem. 2021-06-01 23:42:57 +10:00
modos.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 mimxrt: Integrate Bluetooth support with NimBLE bindings. 2023-08-31 23:42:10 +10:00
mpconfigport.h ports: Move MICROPY_PY_LWIP_ENTER/REENTER/EXIT defns to mphalport.h. 2024-01-05 15:40:06 +11:00
mphalport.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
mphalport.h ports: Move MICROPY_PY_LWIP_ENTER/REENTER/EXIT defns to mphalport.h. 2024-01-05 15:40:06 +11:00
mpnetworkport.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
mpnimbleport.c mimxrt: Integrate Bluetooth support with NimBLE bindings. 2023-08-31 23:42:10 +10:00
mpnimbleport.h mimxrt: Integrate Bluetooth support with NimBLE bindings. 2023-08-31 23:42:10 +10:00
network_lan.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
pendsv.c mimxrt/irq: Move all IRQ related definitions to dedicated header. 2023-09-01 00:02:19 +10:00
pendsv.h mimxrt: Fix header include guard names. 2024-02-15 09:45:14 +11:00
pin.c mimxrt/boards/make-pins.py: Update to use tools/boardgen.py. 2023-11-03 14:18:54 +11:00
pin.h mimxrt/boards/make-pins.py: Update to use tools/boardgen.py. 2023-11-03 14:18:54 +11:00
qstrdefsport.h mimxrt: Add new, minimal port to NXP i.MX RT series CPUs. 2020-03-11 15:34:13 +11:00
sdcard.c mimxrt: Remove SDCARD Makefile config option. 2023-09-29 23:09:14 +10:00
sdcard.h mimxrt/sdcard: Implement SDCard driver. 2021-09-07 20:45:33 +02:00
sdio.c mimxrt/sdio: Add support for the 117x series. 2023-09-29 23:08:41 +10:00
sdio.h mimxrt/sdio: Add SDIO driver. 2023-08-31 23:39:34 +10:00
systick.c mimxrt/machine_timer: Use soft-timer implementation for machine.Timer. 2022-10-27 14:09:29 +11:00
systick.h mimxrt/eth: Add LAN support and integrate the network module. 2021-10-25 15:14:26 +11:00
ticks.c mimxrt: Add support for MIMXRT1176 MCUs, and MIMXRT1170_EVK board. 2022-11-17 14:11:50 +11:00
ticks.h mimxrt: Improve ticks and sleep functions using GPT. 2021-05-18 22:36:32 +10:00
tusb_config.h ports: Update to build with new tinyusb. 2021-02-12 12:50:36 +11:00
tusb_port.c mimxrt/usb: Change macro name MICROPY_HW_USB_STR_MANUF. 2022-11-17 08:27:33 +01:00

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