micropython/ports/mimxrt
Jim Mussared 69b93527d5 ports: Make BOARD default from BOARD_DIR in Makefile's.
This allows:

    $ make BOARD_DIR=path/to/board

to infer BOARD=board, rather than the previous behavior that required
additionally setting BOARD explicitly.

Also makes the same change for VARIANT_DIR -> VARIANT on Unix.

This work was funded through GitHub Sponsors.

Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
Signed-off-by: Damien George <damien@micropython.org>
2023-02-23 09:47:08 +11:00
..
boards top: Update Python formatting to black "2023 stable style". 2023-02-02 12:51:03 +11:00
hal mimxrt: Add support for MIMXRT1176 MCUs, and MIMXRT1170_EVK board. 2022-11-17 14:11:50 +11:00
lwip_inc mimxrt: Re-Enable eth checksum creation by HW. 2021-12-14 08:07:52 +01:00
mbedtls mimxrt: Add support for MIMXRT1176 MCUs, and MIMXRT1170_EVK board. 2022-11-17 14:11:50 +11:00
modules mimxrt/modules: Append /flash/lib to the default sys.path. 2022-04-11 12:25:15 +10:00
Makefile ports: Make BOARD default from BOARD_DIR in Makefile's. 2023-02-23 09:47:08 +11:00
README.md mimxrt/README: Add build and flashing instructions. 2022-11-17 14:21:59 +11:00
board_init.c mimxrt: Add support for MIMXRT1176 MCUs, and MIMXRT1170_EVK board. 2022-11-17 14:11:50 +11:00
dma_manager.c mixmrt/machine_i2s: Add I2S protocol support. 2022-03-30 14:12:40 +11:00
dma_manager.h mixmrt/machine_i2s: Add I2S protocol support. 2022-03-30 14:12:40 +11:00
eth.c mimxrt: Add support for MIMXRT1176 MCUs, and MIMXRT1170_EVK board. 2022-11-17 14:11:50 +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
led.c mimxrt: Implement machine.Pin class. 2021-05-26 00:12:42 +10:00
led.h mimxrt: Implement machine.Pin class. 2021-05-26 00:12:42 +10:00
machine_adc.c mimxrt: Add support for MIMXRT1176 MCUs, and MIMXRT1170_EVK board. 2022-11-17 14:11:50 +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 mimxrt: Add support for MIMXRT1176 MCUs, and MIMXRT1170_EVK board. 2022-11-17 14:11:50 +11:00
machine_i2s.c mimxrt: Add support for MIMXRT1176 MCUs, and MIMXRT1170_EVK board. 2022-11-17 14:11:50 +11:00
machine_led.c py/obj: Convert make_new into a mp_obj_type_t slot. 2022-09-19 19:06:15 +10:00
machine_pin.c mimxrt: Add support for MIMXRT1176 MCUs, and MIMXRT1170_EVK board. 2022-11-17 14:11:50 +11:00
machine_pwm.c mimxrt: Add support for MIMXRT1176 MCUs, and MIMXRT1170_EVK board. 2022-11-17 14:11:50 +11:00
machine_rtc.c mimxrt/machine_rtc: Set the microsecond value to 0. 2022-12-14 13:04:09 +11:00
machine_sdcard.c mimxrt: Add support for MIMXRT1176 MCUs, and MIMXRT1170_EVK board. 2022-11-17 14:11:50 +11:00
machine_spi.c mimxrt: Add support for MIMXRT1176 MCUs, and MIMXRT1170_EVK board. 2022-11-17 14:11:50 +11:00
machine_uart.c mimxrt: Add support for MIMXRT1176 MCUs, and MIMXRT1170_EVK board. 2022-11-17 14:11:50 +11:00
machine_wdt.c py/obj: Convert make_new into a mp_obj_type_t slot. 2022-09-19 19:06:15 +10:00
main.c mimxrt: Add support for MIMXRT1176 MCUs, and MIMXRT1170_EVK board. 2022-11-17 14:11:50 +11:00
mimxrt_flash.c mimxrt: Add support for MIMXRT1176 MCUs, and MIMXRT1170_EVK board. 2022-11-17 14:11:50 +11:00
mimxrt_sdram.c mimxrt: Add support for MIMXRT1176 MCUs, and MIMXRT1170_EVK board. 2022-11-17 14:11:50 +11:00
modmachine.c mimxrt: Add support for MIMXRT1176 MCUs, and MIMXRT1170_EVK board. 2022-11-17 14:11:50 +11:00
modmachine.h mimxrt/machine_rtc: Start RTC at boot and set datetime if not set. 2022-04-11 12:25:23 +10:00
modmimxrt.c mimxrt/modmachine: Move dht_readinto() to the machine module. 2022-11-09 15:56:43 +11:00
modmimxrt.h mimxrt: Add flash storage support with VFS and littlefs filesystem. 2021-06-01 23:42:57 +10:00
moduos.c mimxrt: Add support for MIMXRT1176 MCUs, and MIMXRT1170_EVK board. 2022-11-17 14:11:50 +11:00
modutime.c all: Remove third argument to MP_REGISTER_MODULE. 2022-06-02 16:31:37 +10:00
mpconfigport.h shared/runtime/softtimer: Use consistently the same clock source. 2023-02-16 12:59:48 +11:00
mphalport.c mimxrt: Add support for MIMXRT1176 MCUs, and MIMXRT1170_EVK board. 2022-11-17 14:11:50 +11:00
mphalport.h mimxrt/mphalport: Add a timeout to mp_hal_stdout_tx_strn(). 2022-11-09 11:16:25 +11:00
mpnetworkport.c mimxrt/eth: Add LAN support and integrate the network module. 2021-10-25 15:14:26 +11:00
network_lan.c mimxrt/network: Rename the argument clock_mode to ref_clk_mode. 2022-11-17 08:55:16 +01:00
pendsv.c mimxrt/eth: Add LAN support and integrate the network module. 2021-10-25 15:14:26 +11:00
pendsv.h mimxrt/eth: Add LAN support and integrate the network module. 2021-10-25 15:14:26 +11:00
pin.c mimxrt/machine_pin: Change pin drive constants to DRIVE_x naming. 2022-03-08 22:30:33 +11:00
pin.h mimxrt: Add support for MIMXRT1176 MCUs, and MIMXRT1170_EVK board. 2022-11-17 14:11:50 +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/sdcard: Remove obsolete code already excluded by preprocessor. 2022-12-14 13:05:27 +11:00
sdcard.h mimxrt/sdcard: Implement SDCard driver. 2021-09-07 20:45:33 +02: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