micropython/ports/samd
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 samd/boards: Clean up comments and some pins in pins.csv files. 2023-02-21 23:13:01 +11:00
mcu samd/moduos: Add uos.urandom() using the phase-jitter rng. 2023-02-21 23:17:44 +11:00
modules samd/mcu: Use lf2s for SAMD51 and lfs1 for SAMD21. 2022-10-06 23:14:21 +11:00
Makefile ports: Make BOARD default from BOARD_DIR in Makefile's. 2023-02-23 09:47:08 +11:00
README.md samd/README: Update README to reflect recent changes to the port. 2022-11-08 23:25:39 +11: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 samd: Integrate latest asf4, add help, more time funcs and uPy features. 2021-11-19 11:05:05 +11:00
machine_adc.c samd: Add a vref=num option to the ADC and DAC constructor. 2022-12-14 12:48:24 +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: Add a vref=num option to the ADC and DAC constructor. 2022-12-14 12:48:24 +11:00
machine_i2c.c samd: Avoid under-/overflow in I2C and SPI baudrate calculations. 2022-12-14 12:41:42 +11: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/machine_pwm: Serialize fast update of PWM settings. 2022-10-25 23:42:14 +11:00
machine_rtc.c samd/machine_rtc: Add the machine.RTC class. 2022-10-25 23:20:09 +11:00
machine_spi.c samd/machine_uart: Fix IRQ flag setting and clearing. 2022-12-14 12:42:34 +11:00
machine_uart.c samd/machine_uart: Fix uart.deinit() and save some RAM. 2022-12-14 12:46:20 +11:00
machine_wdt.c samd/machine_wdt: Add the machine.WDT class. 2022-10-06 22:53:06 +11:00
main.c samd/machine_uart: Use a finaliser to tidy up UART on soft reset. 2022-10-25 23:44:49 +11:00
modmachine.c samd: Support entering bootloader via USB CDC 1200bps touch. 2022-12-14 12:50:04 +11:00
modmachine.h samd: Support entering bootloader via USB CDC 1200bps touch. 2022-12-14 12:50:04 +11:00
modsamd.c samd: Add Pin.board and Pin.cpu classes to Pin. 2023-02-17 17:27:21 +11:00
moduos.c samd/moduos: Add uos.urandom() using the phase-jitter rng. 2023-02-21 23:17:44 +11:00
modutime.c samd/machine_rtc: Add the machine.RTC class. 2022-10-25 23:20:09 +11:00
mpconfigport.h shared/runtime/softtimer: Use consistently the same clock source. 2023-02-16 12:59:48 +11:00
mphalport.c samd/mcu: Set the SAMD21 us-counter to 2 MHz for better resolution. 2023-02-21 23:17:12 +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/machine_timer: Add machine.Timer based on the shared soft-timer. 2022-10-06 22:52:39 +11:00
pin_af.c samd: Add Pin.board and Pin.cpu classes to Pin. 2023-02-17 17:27:21 +11:00
pin_af.h samd: Add Pin.board and Pin.cpu classes to Pin. 2023-02-17 17:27:21 +11:00
qstrdefsport.h all: Add *FORMAT-OFF* in various places. 2020-02-28 10:31:07 +11:00
samd_flash.c samd/boards: Move the flash filesystem definitions to the linker files. 2022-10-06 23:14:08 +11:00
samd_isr.c samd/moduos: Add uos.urandom() using the phase-jitter rng. 2023-02-21 23:17:44 +11: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
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

README.md

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.