circuitpython/ports/samd
robert-hh 79d182deb2 samd/machine_i2c_target: Support I2C target mode.
Supporting readfrom_mem*(). writeto_mem() and a set of IRQs.  Enabled by
default for SAMD51 devices and SAMD21 devices with external flash.

Tested with ItsyBitsy M4 and ItsyBitsy M0 with both on-board SoftI2C and a
RP2 Pico as controller.

Signed-off-by: Damien George <damien@micropython.org>
Signed-off-by: robert-hh <robert@hammelrath.com>
2025-08-01 23:03:17 +10:00
..
boards samd/machine_i2c_target: Support I2C target mode. 2025-08-01 23:03:17 +10:00
mboot samd/mboot/README.md: Add information about the bootloader source. 2024-11-18 18:31:16 +01:00
mcu samd/machine_i2c_target: Support I2C target mode. 2025-08-01 23:03:17 +10:00
modules ports: Use vfs module instead of os. 2024-02-07 13:25:09 +11:00
clock_config.h samd/mcu: Update clock config after changes to USB. 2024-03-28 15:49:41 +11:00
fatfs_port.c ports: Include py/mphal.h instead of mphalport.h. 2024-10-09 14:39:34 +11:00
help.c ports: Standardise docs link in help text. 2023-06-02 11:48:46 +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 samd/machine_bitstream: Add the machine.bitstream() function. 2022-10-06 23:00:00 +11:00
machine_dac.c samd/machine_dac: Fix SAMD51 DAC for two channels. 2025-01-23 15:29:11 +11:00
machine_i2c.c samd/machine_i2c_target: Support I2C target mode. 2025-08-01 23:03:17 +10:00
machine_i2c_target.c samd/machine_i2c_target: Support I2C target mode. 2025-08-01 23:03:17 +10: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 ports: Make PWM duty_u16 have an upper value of 65535 across all ports. 2024-11-18 16:05:56 +11:00
machine_rtc.c samd/modtime: Change time.time_ns() to follow the RTC time. 2025-05-07 16:17:07 +10:00
machine_spi.c samd/machine_spi: Support default instance and SCK/MOSI/MISO pin values. 2025-03-03 10:59:15 +11:00
machine_uart.c samd/machine_uart: Fix lock-up in loopback mode if read buffer is full. 2025-03-27 11:39:02 +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 samd/machine_i2c_target: Support I2C target mode. 2025-08-01 23:03:17 +10:00
Makefile shared/tinyusb: Use device event hook to schedule USB task. 2025-05-26 11:15:33 +10:00
modmachine.c all: Rename the "NORETURN" macro to "MP_NORETURN". 2025-05-13 10:36:47 +10:00
modmachine.h extmod/modmachine: Provide common Python bindings for bootloader(). 2023-11-30 16:11:11 +11:00
modos.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
modsamd.c all: Remove the "STATIC" macro and just use "static" instead. 2024-03-07 14:20:42 +11:00
modtime.c samd/modtime: Change time.time_ns() to follow the RTC time. 2025-05-07 16:17:07 +10:00
mpconfigport.h samd/machine_i2c_target: Support I2C target mode. 2025-08-01 23:03:17 +10:00
mphalport.c samd/mphalport: Simplify mp_hal_delay_ms(). 2024-09-06 17:43:49 +10:00
mphalport.h samd/modtime: Change time.time_ns() to follow the RTC time. 2025-05-07 16:17:07 +10: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/machine_i2c_target: Support I2C target mode. 2025-08-01 23:03:17 +10:00
pin_af.h samd/machine_i2c_target: Support I2C target mode. 2025-08-01 23:03:17 +10:00
qstrdefsport.h all: Add *FORMAT-OFF* in various places. 2020-02-28 10:31:07 +11:00
README.md samd/README: Fix incorrect port directory name. 2024-03-28 15:36:26 +11:00
samd_flash.c samd/samd_flash: Make flash read/write methods access self parameters. 2024-11-18 23:54:42 +11:00
samd_isr.c samd: Switch TinyUSB to run via a scheduled task. 2023-11-09 12:30:04 +11:00
samd_qspiflash.c samd/samd_qspiflash: Remove the attempt to handle a unknown device. 2025-05-07 16:20:19 +10:00
samd_soc.c samd/machine_i2c_target: Support I2C target mode. 2025-08-01 23:03:17 +10:00
samd_soc.h samd: Use unique id for USB serial number. 2023-11-16 15:03:09 +11:00
samd_spiflash.c samd/samd_spiflash: Improve the flash type detection. 2025-05-07 16:19:48 +10:00
sections.ld samd: Add support for building with user C modules. 2021-07-22 22:22:03 +10:00
usbd.c samd: Use unique id for USB serial number. 2023-11-16 15:03:09 +11: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/samd/ 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.