circuitpython/ports/samd
Jim Mussared 30628d1bb7 all: Rename MP_QSTR_umodule to MP_QSTR_module everywhere.
This renames the builtin-modules, such that help('modules') and printing
the module object will show "module" rather than "umodule".

This work was funded through GitHub Sponsors.

Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
2023-06-08 17:53:57 +10:00
..
boards samd/boards: Extend the code size limit for boards with external flash. 2023-06-06 00:49:36 +10:00
mcu ports: Enable os.sync() for esp32, esp8266, rp2, mimxrt, samd51. 2023-06-01 11:39:01 +10:00
modules samd: Adapt existing samd.Flash and integrate with (Q)SPI flash in boot. 2023-06-06 00:49:36 +10:00
clock_config.h samd: Change the symbol names for the peripheral clocks. 2022-10-06 23:10:08 +11:00
fatfs_port.c samd/machine_rtc: Add the machine.RTC class. 2022-10-25 23:20:09 +11:00
help.c ports: Standardise docs link in help text. 2023-06-02 11:48:46 +10:00
machine_adc.c samd/modmachine: Make some machine classes configurable by #defines. 2023-05-22 18:39:07 +10:00
machine_bitstream.c samd/machine_bitstream: Add the machine.bitstream() function. 2022-10-06 23:00:00 +11:00
machine_dac.c samd/modmachine: Make some machine classes configurable by #defines. 2023-05-22 18:39:07 +10:00
machine_i2c.c samd/modmachine: Make some machine classes configurable by #defines. 2023-05-22 18:39:07 +10:00
machine_pin.c samd: Add Pin.board and Pin.cpu classes to Pin. 2023-02-17 17:27:21 +11:00
machine_pwm.c samd/modmachine: Make some machine classes configurable by #defines. 2023-05-22 18:39:07 +10:00
machine_rtc.c samd/machine_rtc: Add the machine.RTC class. 2022-10-25 23:20:09 +11:00
machine_spi.c samd/modmachine: Make some machine classes configurable by #defines. 2023-05-22 18:39:07 +10:00
machine_uart.c samd/machine_uart: Add support for UART hardware flow control. 2023-05-23 09:53:24 +10:00
machine_wdt.c samd/modmachine: Make some machine classes configurable by #defines. 2023-05-22 18:39:07 +10:00
main.c samd/modmachine: Make some machine classes configurable by #defines. 2023-05-22 18:39:07 +10:00
Makefile samd: Adapt existing samd.Flash and integrate with (Q)SPI flash in boot. 2023-06-06 00:49:36 +10:00
modmachine.c all: Rename MP_QSTR_umodule to MP_QSTR_module everywhere. 2023-06-08 17:53:57 +10:00
modmachine.h samd/modmachine: Make some machine classes configurable by #defines. 2023-05-22 18:39:07 +10:00
modsamd.c samd: Adapt existing samd.Flash and integrate with (Q)SPI flash in boot. 2023-06-06 00:49:36 +10:00
moduos.c samd/moduos: Add uos.urandom() using the phase-jitter rng. 2023-02-21 23:17:44 +11:00
modutime.c samd/modutime: Use extmod version of time module. 2023-04-27 15:11:51 +10:00
mpconfigport.h samd: Adapt existing samd.Flash and integrate with (Q)SPI flash in boot. 2023-06-06 00:49:36 +10:00
mphalport.c ports: Implement simple write polling for stdout. 2023-03-23 13:51:17 +11:00
mphalport.h samd/mcu: Set the SAMD21 us-counter to 2 MHz for better resolution. 2023-02-21 23:17:12 +11:00
pendsv.c samd/machine_timer: Add machine.Timer based on the shared soft-timer. 2022-10-06 22:52:39 +11:00
pendsv.h samd/pendsv: Add MICROPY_BOARD_PENDSV_ENTRIES for board customisation. 2023-03-07 15:59:58 +11:00
pin_af.c samd/modmachine: Make some machine classes configurable by #defines. 2023-05-22 18:39:07 +10:00
pin_af.h samd/samd_qspiflash: Add QSPI flash driver and configure it accordingly. 2023-06-06 00:49:36 +10:00
qstrdefsport.h all: Add *FORMAT-OFF* in various places. 2020-02-28 10:31:07 +11:00
README.md samd/README: Update README to reflect recent changes to the port. 2022-11-08 23:25:39 +11:00
samd_flash.c samd: Adapt existing samd.Flash and integrate with (Q)SPI flash in boot. 2023-06-06 00:49:36 +10:00
samd_isr.c samd/moduos: Add uos.urandom() using the phase-jitter rng. 2023-02-21 23:17:44 +11:00
samd_qspiflash.c samd/samd_qspiflash: Add QSPI flash driver and configure it accordingly. 2023-06-06 00:49:36 +10:00
samd_soc.c samd/clock_config: Extend the SAMD51 us-counter to 60 bit. 2022-10-25 23:26:14 +11:00
samd_soc.h samd/samd_isr: Change the way a Sercom ISR is registered and called. 2022-10-06 22:52:10 +11:00
samd_spiflash.c samd/samd_spiflash: Add SPI flash driver and configure it accordingly. 2023-06-06 00:49:36 +10:00
sections.ld samd: Add support for building with user C modules. 2021-07-22 22:22:03 +10:00
tusb_config.h samd: Add new port to Microchip SAMDxx microcontrollers. 2019-07-01 17:19:18 +10:00
tusb_port.c ports: Rename USBD_VID/PID config macros to MICROPY_HW_USB_VID/PID. 2021-08-07 23:13:55 +10:00

Port of MicroPython to Microchip SAMD MCUs

Supports SAMD21 and SAMD51. For each supported device there is a subdirectory in the boards/ directory.

The entry point for the specific port documentation is at https://docs.micropython.org/en/latest/samd/quickref.html, which also shows the assignment of IO-Functions to pins. The generic MicroPython documentation applies for anything not specific for the SAM port.

Due to the different flash sizes of SAMD21 and SAMD51 devices, the coverage of MicroPython modules differ. Use help("modules") to tell, which MicroPython modules are provided.

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. There is no default board. 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 ADAFRUIT_ITSYBITSY_M4_EXPRESS as an example of the selected board):

$ make BOARD=ADAFRUIT_ITSYBITSY_M4_EXPRESS submodules

Then to build the board's firmware run:

$ make BOARD=ADAFRUIT_ITSYBITSY_M4_EXPRESS clean
$ make BOARD=ADAFRUIT_ITSYBITSY_M4_EXPRESS

The above command produces binary images in the build-ADAFRUIT_ITSYBITSY_M4_EXPRESS/ subdirectory (or the equivalent directory for the board specified).

Flashing the Firmware

Most SAMD21 and SAMD51 boards have a built in firmware loader. To start it, push the reset button of the boards twice. The speed varies a little bit. If the firmware loader starts, a drive will appear in the file manager of your PC. Copy the created firmware.uf2 file to that drive. If the upload is finished, the drive will disappear and the board will reboot.