SAMA5D2 Xplained Board
SoC Features
The SAMA5D2 series is a high-performance, ultra-low-power ARM Cortex-A5 processor based MPU. The Cortex A5 processor runs up to 500MHz and features the ARM NEON SIMD engine a 128kB L2 cache and a floating point unit. It supports multiple memories, including latest-generation technologies such as DDR3, LPDDR3, and QSPI Flash. It integrates powerful peripherals for connectivity (EMAC, USB, dual CAN, up to 10 UARTs, etc.) and user interface applications (TFT LCD controller, embedded capacitive touch controller, class D amplifier, audio PLL, CMOS sensor interface, etc.). The devices offer advanced security functions to protect customer code and secure external data transfers. These include ARM TrustZone, tamper detection, secure data storage, hardware encryption engines including private keys, on-the-fly decryption of code stored in external DDR or QSPI memory and a secure boot loader.
Kit Information
Kit Overview
|
Access the console
The usual serial communication parameters are115200 8-N-1 :
|
|||||||||||
Access the console on DEBUG serial port
The serial console can be accessed from two connectors. One is from the DEBUG port with the help of a TTL-to-USB serial cable (marked as DEBUG J1), another is from micro-A USB connector that gives access to the on-board serial-to-USB converter (marked as J14 EDBG-USB).Using DEBUG on TTL-to-USB connector (DEBUG J1)
- For Microsoft Windows users: Install the driver of your USB TTL serial cable. FTDI-based ones are the most popular, have a look to this page to get the driver: http://www.ftdichip.com/Drivers/VCP.htm
- Open JP2 to enable this DEBUG interface
- Be sure to connect a 3.3V compatible cable and identify its GND pin. Place it properly according to the silkscreen and connect the cable to the board (J1)
- For Microsoft Windows users: Identify the USB connection that is established,
USB Serial Portshould appear in Device Manager. TheCOMxxnumber will be used to configure the terminal emulator.
- For Linux users: Identify the serial USB connection by monitoring the last lines of
dmesgcommand. The/dev/ttyUSBxnumber will be used to configure the terminal emulator.[605576.562740] usb 1-1.1.2: new full-speed USB device number 17 using ehci-pci [605576.660920] usb 1-1.1.2: New USB device found, idVendor=0403, idProduct=6001 [605576.660933] usb 1-1.1.2: New USB device strings: Mfr=1, Product=2, SerialNumber=3 [605576.660939] usb 1-1.1.2: Product: TTL232R-3V3 [605576.660944] usb 1-1.1.2: Manufacturer: FTDI [605576.660958] usb 1-1.1.2: SerialNumber: FTGNVZ04 [605576.663092] ftdi_sio 1-1.1.2:1.0: FTDI USB Serial Device converter detected [605576.663120] usb 1-1.1.2: Detected FT232RL [605576.663122] usb 1-1.1.2: Number of endpoints 2 [605576.663124] usb 1-1.1.2: Endpoint 1 MaxPacketSize 64 [605576.663126] usb 1-1.1.2: Endpoint 2 MaxPacketSize 64 [605576.663128] usb 1-1.1.2: Setting MaxPacketSize 64 [605576.663483] usb 1-1.1.2: FTDI USB Serial Device converter now attached to ttyUSB0A /dev/ttyUSB0 node has been created.
- For Microsoft Windows users: Identify the USB connection that is established,
- Now open your favorite terminal emulator with appropriate settings
Using the micro-A USB connector (J14 EDBG-USB)
You can also access the serial console through the on-board serial-to-USB converter. In fact, the Atmel EDBG (Embedded Debugger) chip on the Evaluation Kit acts as a serial-to-USB converter and is loaded with a firmware that is able to talk USB-CDC protocol.- For Microsoft Windows users: Install USB drivers for Atmel and Segger tools. No need to install a driver on any regular Linux distribution.
- Open JP1 to enable EDBG
- Close JP2 to disable de DEBUG port J1 (needed to avoid conflict on the UART TX line)
- Connect the USB cable to the board (J14 EDBG-USB)
- For Microsoft Windows users: identify the USB connection that is established
EDBG Virtual COM Portshould appear in Device Manager. TheCOMxxnumber will be used to configure the terminal emulator.
- For Linux users: identify the USB connection by monitoring the last lines of
dmesgcommand. The/dev/ttyACMxnumber will be used to configure the terminal emulator:usb 1-1.1.1: new high-speed USB device number 20 using ehci-pci usb 1-1.1.1: New USB device found, idVendor=03eb, idProduct=2111 usb 1-1.1.1: New USB device strings: Mfr=1, Product=2, SerialNumber=3 usb 1-1.1.1: Product: EDBG CMSIS-DAP usb 1-1.1.1: Manufacturer: Atmel Corp. usb 1-1.1.1: SerialNumber: ATML0000001989463039 hid-generic 0003:03EB:2111.0007: hiddev0,hidraw3: USB HID v1.11 Device [Atmel Corp. EDBG CMSIS-DAP] on usb-0000:00:1a.0-1.1.1/input0 cdc_acm 1-1.1.1:1.1: ttyACM0: USB ACM device
- For Microsoft Windows users: identify the USB connection that is established
- Now open your favorite terminal emulator with appropriate settings
Demo
Demo archives
|
|||||||||||||||||||||||||||||||||||||||||||||||
Create a SD card with the demo
You need a 1 GB SD card (or more) and to download the image of the demo. The image is compressed to reduce the amount of data to download. This image contains:- a FAT32 partition with the AT91Bootstrap, U-Boot and the Linux Kernel (zImage and dtb).
- an EXT4 partition for the rootfs.
Multi-platform procedure
To write the compressed image on the SD card, you will have to download and install balenaEtcher. This tool, which is an Open Source software, is useful since it allows to get a compressed image as input. More information and extra help available on the balenaEtcher website.
- Insert your SD card and launch
Etcher:
- Select the demo image. They are marked as "SD Card image" in the demo table above.
Note that you can select a compressed image (like the demos available here). The tool is able to decompress files on the fly - Select the device corresponding to your SD card (Etcher proposes you the devices that are removable to avoid erasing your system disk)
- Click on the
Flash!button - On Linux, Etcher finally asks you to enter your root password because it needs access to the hardware (your SD card reader or USB to SD card converter)
- then the flashing process begins followed by a verification phase (optional)
- Once writing done, Etcher asks you if you want to burn another demo image:
- Your SD card is ready!
Flash the demo
If you need to store the root filesystem on a SD Card, use information contained in StroreRootFSonSD. This is useful for Linux4SAM demos older than 5.6.
use SAM-BA 3.5.y onwards. You can download it here: SAM-BA 3.x release page.
Connect the USB to the board before launching SAM-BA
- Short the JP9 (BOOT_DIS) to prevents booting from eMMC or serial Flash by disabling Flash Chip Selects
- Connect a USB micro-A cable to the board (J23 A5-USB-A). It powers the board
- check whether the board is found in your PC as a USB device:
- For Microsoft Windows users: verify that the USB connection is well established
AT91 USB to Serial Convertershould appear in Device Manager. If it shows a unknown device you need to download and install the driver: AT91SAM USB CDC driver
- For Linux users: check /dev/ttyACMx by monitoring the last lines of
dmesgcommand:
- For Microsoft Windows users: verify that the USB connection is well established
[172677.700868] usb 2-1.4.4: new full-speed USB device number 31 using ehci-pci
[172677.792677] usb 2-1.4.4: not running at top speed; connect to a high speed hub
[172677.793418] usb 2-1.4.4: New USB device found, idVendor=03eb, idProduct=6124
[172677.793424] usb 2-1.4.4: New USB device strings: Mfr=0, Product=0, SerialNumber=0
[172677.793897] cdc_acm 2-1.4.4:1.0: This device cannot do calls on its own. It is not a modem.
[172677.793924] cdc_acm 2-1.4.4:1.0: ttyACM0: USB ACM device
idVendor=03eb, idProduct=6124: from this message you can see it's Microchip board USB connection.
- Open the JP9 (BOOT_DIS) to reactivate access to the on-board Flash devices
Run script to flash the demo
- download the demo package for the board. They are marked as "Media type: Boot on SPI Flash + rootfs on eMMC " in the table above
- extract the demo package
- run your usual terminal emulator and enter the demo directory
- make sure that the
sam-baapplication is in your Operating System path so that you can reach it from your demo package directory - for Microsoft Windows users: Launch the
demo_linux_serialflash.batfile - for Linux users: Launch the
demo_linux_serialflash.shfile - this script runs SAM-BA 3 and the associated
QMLsam-ba script (demo_linux_serialflash_usb.qml) with proper parameters - when you reach the end of the flashing process (this will take a few minutes), the following line is written:
-I- === Done. ===
- connect a serial link on DBGU and open the terminal emulator program as explained just above
- power cycle the board
- monitor the system while it's booting on the LCD screen or through the serial line
Build From source code
Setup ARM Cross Compiler
- First step is to dowload the ARM GNU Toolchain:
wget -c https://developer.arm.com/-/media/Files/downloads/gnu/13.2.rel1/binrel/arm-gnu-toolchain-13.2.rel1-x86_64-arm-none-linux-gnueabihf.tar.xz
- Next step is to add the ARM GNU Toolchain into your system:
tar -xf arm-gnu-toolchain-13.2.rel1-x86_64-arm-none-linux-gnueabihf.tar.xz export CROSS_COMPILE=`pwd`/arm-gnu-toolchain-13.2.rel1-x86_64-arm-none-linux-gnueabihf/bin/arm-none-linux-gnueabihf-ortar -xf arm-gnu-toolchain-13.2.rel1-x86_64-arm-none-linux-gnueabihf.tar.xz export CROSS_COMPILE=arm-none-linux-gnueabihf- export PATH=$PATH:/YOUR/PATH/TO/arm-gnu-toolchain-13.2.Rel1-x86_64-arm-none-linux-gnueabihf/bin/
- !Note: If you already have an old ARM GNU Toolchain need to clean up the PATH with:
export PATH=${PATH/':/YOUR/PATH/TO/arm-gnu-toolchain-VERSION-x86_64-arm-none-linux-gnueabihf/bin/'/}
Build AT91Bootstrap from sources
This section describes how to get source code from the git repository, how to configure with the default configuration, how to customize AT91Bootstrap based on the default configuration and finally to build AT91Bootstrap to produce the binary. take the default configuration to download U-Boot from NandFlash for example.Get AT91Bootstrap Source Code
You can easily download AT91Bootstrap source code on the at91bootstrap git repository.To get the source code, you should clone the repository by doing:
$ git clone https://github.com/linux4sam/at91bootstrap.git Cloning into 'at91bootstrap'... remote: Enumerating objects: 17621, done. remote: Counting objects: 100% (3324/3324), done. remote: Compressing objects: 100% (1029/1029), done. remote: Total 17621 (delta 2465), reused 3102 (delta 2285), pack-reused 14297 Receiving objects: 100% (17621/17621), 5.65 MiB | 4.65 MiB/s, done. Resolving deltas: 100% (13459/13459), done. $ cd at91bootstrap/
Configure AT91Bootstrap
Assuming you are at the AT91Bootstrap root directory, you will find aconfigs folder which contains several default configuration files: sama5d2_xplaineddf_uboot_defconfig sama5d2_xplainedsd_uboot_defconfig
Tips: nf means to read nandflash, df means to read serial flash, sd means to read mmc card. You can configure AT91Bootstrap to load U-Boot binary from SPI flash by doing:
$ make mrproper $ make sama5d2_xplaineddf_uboot_defconfigIf the configuring process is successful, the .config file can be found at AT91Bootstrap root directory.
Customize AT91Bootstrap
If the default configuration doesn't meet your need, after configuring with the default configuration, you can customize it by doing:$ make menuconfigNow, in the menuconfig dialog, you can easily add or remove some features to/from AT91Bootstrap as the same way as kernel configuration.
Move to
<Exit> with arrows and press this button hitting the Enter key to exit from this screen.
Build AT91Bootstrap
Then you can build the AT91Bootstrap binary by doing:$ makeIf the building process is successful, the final .bin image is build/binaries/at91bootstrap.bin.
Build U-Boot from sources
Getting U-Boot sources
Dedicated page on U-Boot wiki: http://www.denx.de/wiki/U-Boot/SourceCode
You can easily download U-Boot source code from Linux4Microchip GitHub U-Boot repository:
- clone the Linux4microchip GitHub U-Boot repository
$ git clone https://github.com/linux4microchip/u-boot-mchp.git Cloning into 'u-boot-mchp'... remote: Enumerating objects: 951876, done. remote: Counting objects: 100% (17718/17718), done. remote: Compressing objects: 100% (5735/5735), done. remote: Total 951876 (delta 12391), reused 15314 (delta 11846), pack-reused 934158 Receiving objects: 100% (951876/951876), 164.77 MiB | 401.00 KiB/s, done. Resolving deltas: 100% (790362/790362), done. $ cd u-boot-mchp/
- The source code has been taken from the master branch which is pointing to the latest branch we use. If you want to use the other branch, you can list them and use one of them by doing:
$ git branch -r origin/HEAD -> origin/master origin/dev/tony/sama7g5ek_optee origin/master origin/sam9x60_curiosity_early origin/sam9x60_early origin/sam9x60_iar origin/sam9x7_early origin/sama5d27wlsom1ek_ear origin/sama7g5_early origin/u-boot-2012.10-at91 origin/u-boot-2013.07-at91 origin/u-boot-2014.07-at91 origin/u-boot-2015.01-at91 origin/u-boot-2016.01-at91 origin/u-boot-2016.03-at91 origin/u-boot-2017.03-at91 origin/u-boot-2018.07-at91 origin/u-boot-2019.04-at91 origin/u-boot-2020.01-at91 origin/u-boot-2021.04-at91 origin/u-boot-2022.01-at91 origin/u-boot-2023.07-mchp origin/uboot_5series_1.x $ git checkout origin/u-boot-2023.07-mchp -b u-boot-2023.07-mchp Branch 'u-boot-2023.07-mchp' set up to track remote branch 'u-boot-2023.07-mchp' from 'origin'. Switched to a new branch 'u-boot-2023.07-mchp'
Cross-compiling U-Boot
Before compiling the U-Boot, you need setup cross compile toolchain in the section. Latest versions of U-boot (2018.07 and newer) have a minimum requirement of 6.0 version of the GCC toolchain. We always recommend to use the latest versions.
Once the AT91 U-Boot sources available, cross-compile U-Boot is made in two steps: configuration and compiling. Check the Configuration chapter in U-Boot reference manual.
Go to the configs/ to find the exact target when invoking make.
The U-Boot environment variables can be stored in different media, above config files can specify where to store the U-Boot environment.
# To put environment variables in serial flash: sama5d2_xplained_spiflash_defconfig # To put environment variables in SD/MMC card: sama5d2_xplained_mmc_defconfigHere are the building steps for the SAMA5D2-Xplained board:
# You can change the config according to your needs. make sama5d2_xplained_spiflash_defconfig makeThe result of these operations is a fresh U-Boot binary called
u-boot.bin corresponding to the binary ELF file u-boot. -
u-boot.binis the file you should store on the board -
u-bootis the ELF format binary file you may use to debug U-Boot through a JTag link for instance.
Build Kernel from sources
Required packages
You must install essential host packages on your build host. These requirements are listed in the Linux kernel documentation with the chapter Install build requirements. You must follow this process which includes, but not limited to, the following packages:
- build-essential
- flex
- bison
- git
- perl-base
- libssl-dev
- libncurses5-dev
- libncursesw5-dev
- ncurses-dev
Getting Kernel sources
To get the source code, you have to clone the repository:$ git clone https://github.com/linux4microchip/linux.git Cloning into 'linux'... remote: Enumerating objects: 8587836, done. remote: Total 8587836 (delta 0), reused 0 (delta 0), pack-reused 8587836 Receiving objects: 100% (8587836/8587836), 3.49 GiB | 13.44 MiB/s, done. Resolving deltas: 100% (7117887/7117887), done. Updating files: 100% (70687/70687), done. $ cd linuxThe source code has been taken from the master branch which is pointing on the latest branch we use.
Note that you can also add this Linux4SAM repository as a remote GIT repository to your usual Linux git tree. It will save you a lot of bandwidth and download time:
$ git remote add linux4microchip https://github.com/linux4microchip/linux.git $ git remote update linux4microchip Fetching linux4microchip From https://github.com/linux4microchip/linux * [new branch] linux-6.1-mchp -> linux4microchip/linux-6.1-mchp * [new branch] linux-6.6-mchp -> linux4microchip/linux-6.6-mchp * [new branch] master -> linux4microchip/masterIf you want to use another branch, you can list them and use one of them by doing this:
$ git branch -r linux4microchip/linux-5.10-mchp linux4microchip/linux-5.15-mchp linux4microchip/linux-5.15-mchp+fpga linux4microchip/linux-6.1-mchp linux4microchip/linux-6.1-mchp+fpga linux4microchip/linux-6.6-mchp linux4microchip/linux-6.6-mchp+fpga linux4microchip/master $ git checkout -b linux-6.6-mchp --track remotes/linux4microchip/linux-6.6-mchp Branch linux-6.6-mchp set up to track remote branch linux-6.6-mchp from linux4microchip. Switched to a new branch 'linux-6.6-mchp'
Setup ARM Cross Compiler
- First step is to dowload the ARM GNU Toolchain:
wget -c https://developer.arm.com/-/media/Files/downloads/gnu/13.2.rel1/binrel/arm-gnu-toolchain-13.2.rel1-x86_64-arm-none-linux-gnueabihf.tar.xz
- Next step is to add the ARM GNU Toolchain into your system:
tar -xf arm-gnu-toolchain-13.2.rel1-x86_64-arm-none-linux-gnueabihf.tar.xz export CROSS_COMPILE=`pwd`/arm-gnu-toolchain-13.2.rel1-x86_64-arm-none-linux-gnueabihf/bin/arm-none-linux-gnueabihf-ortar -xf arm-gnu-toolchain-13.2.rel1-x86_64-arm-none-linux-gnueabihf.tar.xz export CROSS_COMPILE=arm-none-linux-gnueabihf- export PATH=$PATH:/YOUR/PATH/TO/arm-gnu-toolchain-13.2.Rel1-x86_64-arm-none-linux-gnueabihf/bin/
- !Note: If you already have an old ARM GNU Toolchain need to clean up the PATH with:
export PATH=${PATH/':/YOUR/PATH/TO/arm-gnu-toolchain-VERSION-x86_64-arm-none-linux-gnueabihf/bin/'/}
Configure and Build the Linux kernel
Now you have to configure the Linux kernel according to your hardware. We have two default configuration at91 SoC inarch/arm/configs
arch/arm/configs/at91_dt_defconfig arch/arm/configs/sama5_defconfig arch/arm/configs/sama7_defconfig
-
at91_dt_defconfig: for SAM9 (ARM926) series chips -
sama5_defconfig: for SAMA5 series chips -
sama7_defconfig: for SAMA7 series chips
$ make ARCH=arm sama5_defconfig HOSTCC scripts/basic/fixdep HOSTCC scripts/kconfig/conf.o SHIPPED scripts/kconfig/zconf.tab.c SHIPPED scripts/kconfig/zconf.lex.c SHIPPED scripts/kconfig/zconf.hash.c HOSTCC scripts/kconfig/zconf.tab.o HOSTLD scripts/kconfig/conf # # configuration written to .config #At this step, you can modify default configuration using the
menuconfig
$ make ARCH=arm menuconfigNow, in the menuconfig dialog, you can easily add or remove some features. Once done, Move to
<Exit> with arrows and press this button hitting the Enter key to exit from this screen.
Build the Linux kernel image, before you build you need set up the cross compile toolchain, check this section.
$ make ARCH=arm [..] Kernel: arch/arm/boot/Image is ready Kernel: arch/arm/boot/zImage is readyNow you have an usable compressed kernel image
zImage.
If you need an uImage you can run this additional step:
make ARCH=arm uImage LOADADDR=0x20008000 [..] Kernel: arch/arm/boot/zImage is ready UIMAGE arch/arm/boot/uImage Image Name: Linux-6.6.23-linux4microchip-202 Created: Thu May 16 14:36:06 2024 Image Type: ARM Linux Kernel Image (uncompressed) Data Size: 5221704 Bytes = 5099.32 KiB = 4.98 MiB Load Address: 20008000 Entry Point: 20008000 Kernel: arch/arm/boot/uImage is ready
make ARCH=arm dtbs [..] DTC arch/arm/boot/dts/microchip/at91-sam9x60_curiosity.dtb DTC arch/arm/boot/dts/microchip/at91-sam9x60ek.dtb DTC arch/arm/boot/dts/microchip/at91-sam9x75_curiosity.dtb DTC arch/arm/boot/dts/microchip/at91-sam9x75eb.dtb DTC arch/arm/boot/dts/microchip/at91-sama5d27_som1_ek.dtb DTC arch/arm/boot/dts/microchip/at91-sama5d27_wlsom1_ek.dtb DTC arch/arm/boot/dts/microchip/at91-sama5d29_curiosity.dtb DTC arch/arm/boot/dts/microchip/at91-sama5d2_icp.dtb DTC arch/arm/boot/dts/microchip/at91-sama5d2_ptc_ek.dtb DTC arch/arm/boot/dts/microchip/at91-sama5d2_xplained.dtb DTC arch/arm/boot/dts/microchip/at91-sama7d65_curiosity.dtb DTC arch/arm/boot/dts/microchip/at91-sama7g5ek.dtb [..]If the building process is successful, the final images can be found under arch/arm/boot/ directory.
Build Yocto/Poky rootfs from sources
Note that building an entire distribution is a long process. It also requires a big amount of free disk space. The support for Microchip AT91 SoC family is included in a particular Yocto Project layer:meta-atmel. The source for this layer are hosted on Linux4SAM GitHub account: https://github.com/linux4sam/meta-atmel
Building environment
A step-by-step comprehensive installation is explained in the Yocto Project Quick Build. The following lines have to be considered as an add-on that is AT91 specific or that can facilitate your setup.
Prerequisite
Here are the reference pages for setting up a Yocto Project building environment: What You Need and How You Get It.
add git-lfs to the package requirement list from whichever Linux distribution you use.
For instance, on Ubuntu or debian, these packages need to be installed on your development host:
sudo apt-get install gawk wget git-core git-lfs diffstat unzip texinfo gcc-multilib \
build-essential chrpath socat cpio python3 python3-pip python3-pexpect \
xz-utils debianutils iputils-ping python3-git python3-jinja2 libegl1-mesa libsdl1.2-dev \
pylint3 xterm
Step by step build procedure
here is a copy of the README procedure available directly in the meta-atmel layer. This file in the meta-atmel layer repository must be considered as the reference and the following copy can be out-of-sync.
starting with Linux4SAM 2021.04 release, the meta-atmel layer supports Yocto Project templates, so make sure you create a new build environment using oe-init-build-env
This layer provides support for Microchip microprocessors (aka AT91)
====================================================================
For more information about the Microchip MPU product line see:
http://www.microchip.com/design-centers/32-bit-mpus
Linux & Open Source on Microchip microprocessors:
http://www.linux4sam.org
Supported SoCs / MACHINE names
==============================
Note that most of the machine names below, have a SD Card variant that can be
built by adding an "-sd" suffix to the machine name.
- SAMA5D2 product family / sama5d2-xplained, sama5d2-xplained-emmc, sama5d27-som1-ek-sd, sama5d27-som1-ek-optee-sd, sama5d2-ptc-ek, sama5d2-icp, sama5d27-wlsom1-ek-sd, sama5d29-curiosity-sd
- SAMA5D4 product family / sama5d4ek, sama5d4-xplained
- SAMA5D3 product family / sama5d3xek, sama5d3-xplained
- AT91SAM9x5 product family (AT91SAM9G15, AT91SAM9G25, AT91SAM9X25, AT91SAM9G35 and AT91SAM9X35) / at91sam9x5ek
- AT91SAM9RL / at91sam9rlek
- AT91SAM9G45 / at91sam9m10g45ek
- SAM9X60 / sam9x60ek, sam9x60-curiosity
- SAMA7G5 / sama7g5ek-sd, sama7g5ek-emmc, sama7g5ek-ospi
- SAM9X75 / sam9x75eb, sam9x75-curiosity
Sources
=======
- meta-atmel
URI: https://github.com/linux4sam/meta-atmel.git
Branch: kirkstone
Tag: linux4microchip-2024.04
Dependencies
============
This Layer depends on :
- poky
URI: https://git.yoctoproject.org/poky
Branch: kirkstone
Tag: yocto-4.0.17
- meta-openembedded
URI: https://git.openembedded.org/meta-openembedded
Branch: kirkstone
Tag/commit: 8bb16533532b6abc2eded7d9961ab2a108fd7a5b
- meta-arm (for optee components)
URI: https://git.yoctoproject.org/meta-arm
Branch: kirkstone
Tag: yocto-4.0.2
Build procedure
===============
0/ Create a directory
mkdir my_dir
cd my_dir
1/ Clone yocto/poky git repository with the proper branch ready
git clone https://git.yoctoproject.org/poky && cd poky && \
git checkout -b kirkstone yocto-4.0.17 && cd -
2/ Clone meta-openembedded git repository with the proper branch ready
git clone git://git.openembedded.org/meta-openembedded && \
cd meta-openembedded && git checkout -b kirkstone 8bb165 && cd -
3/ Clone meta-atmel layer with the proper branch ready
git clone https://github.com/linux4sam/meta-atmel.git
git checkout -b kirkstone linux4microchip-2024.04 && cd -
4/ Clone meta-arm layer with the proper branch ready
git clone https://git.yoctoproject.org/meta-arm && cd meta-arm && \
git checkout -b kirkstone yocto-4.0.2 && cd -
5/ Enter the poky directory to configure the build system and start the build process
cd poky
If not created yet, add a new "build-microchip" directory:
mkdir build-microchip
Else, if it's the first time you use Yocto Project templates, and if the
build-microchip directory remains from a previous use, we advise you to start
from a fresh directory. Keep your build-microchip/conf/local.conf file for
reference.
6/ Inside the .templateconf file, you will need to modify the TEMPLATECONF
variable to match the path to the meta-atmel layer "conf" directory:
export TEMPLATECONF=${TEMPLATECONF:-../meta-atmel/conf}
7/ Initialize build directory
source oe-init-build-env build-microchip
8/ To build a small image provided by Yocto Project:
[MACHINE=] bitbake core-image-minimal
Example for sama5d2-xplained-sd SD card image:
MACHINE=sama5d2-xplained-sd bitbake core-image-minimal
9/ To build the microchip image with no graphics support:
[MACHINE=] bitbake microchip-headless-image
Example for sama5d2-xplained-sd SD card image:
MACHINE=sama5d2-xplained-sd bitbake microchip-headless-image
10/ To build the microchip image with graphics support (EGT):
[MACHINE=] bitbake microchip-graphics-image
Example for sama5d2-xplained-sd SD card image:
MACHINE=sama5d2-xplained-sd bitbake microchip-graphics-image
Typical bitbake output
======================
Build Configuration:
BB_VERSION = "2.0.0"
BUILD_SYS = "x86_64-linux"
NATIVELSBSTRING = "universal"
TARGET_SYS = "arm-poky-linux-gnueabi"
MACHINE = "sam9x75-curiosity-sd"
DISTRO = "poky-atmel"
DISTRO_VERSION = "4.0.17"
TUNE_FEATURES = "arm armv5 thumb dsp"
TARGET_FPU = "soft"
meta
meta-poky
meta-yocto-bsp = "heads/kirkstone-4.0.17:6d1a878bbf24c66f7186b270f823fcdf82e35383"
meta-oe
meta-networking
meta-webserver
meta-python
meta-initramfs = "8bb16533532b6abc2eded7d9961ab2a108fd7a5b:8bb16533532b6abc2eded7d9961ab2a108fd7a5b"
meta-atmel = "heads/linux4microchip-2024.04-rc2:fd6500c866002b78e8ec752e11e34cff0acbc044"
meta-multimedia = "8bb16533532b6abc2eded7d9961ab2a108fd7a5b:8bb16533532b6abc2eded7d9961ab2a108fd7a5b"
meta-arm
meta-arm-toolchain = "heads/yocto-4.0.2:96aad3b29aa7a5ee4df5cf617a6336e5218fa9bd"
Contributing
============
To contribute to this layer you should submit the patches for review to:
the github pull-request facility directly or the forum. Anyway, don't forget to
Cc the maintainers.
Microchip Forum:
https://www.microchip.com/forums/f542.aspx
for some useful guidelines to be followed when submitting patches:
http://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded
Maintainers:
Hari Prasath G E
Nicolas Ferre
When creating patches insert the [meta-atmel] tag in the subject, for example
use something like:
git format-patch -s --subject-prefix='meta-atmel][PATCH'
Using SAM-BA to flash components to board
SPI + eMMC Flash demo - Memory map
Install SAM-BA software in your PC
In addition to the official SAM-BA pages on http://www.microchip.com, we maintain information about SAM-BA in the SoftwareTools page.
use SAM-BA 3.8.y onwards. You can download it here: SAM-BA 3.8 release page.
Launch SAM-BA tools
- According to this section make sure that the chip can execute the SAM-BA Monitor.
QML language for scripting used for flashing the demos, most common SAM-BA action can be done using SAM-BA command line.
For browsing information on the SAM-BA command line usage, please see the Command Line Documentation that is available in the SAM-BA installation directory: doc/index.html or doc/cmdline.html .
SAM-BA includes command line interface that provides support for the most common actions:
- reading / writing to arbitrary memory addresses and/or peripherals
- uploading applets and using them to erase/read/write external memories
The command line interface is designed to be self-documenting.
The main commands can be listed using the "sam-ba --help" command:
SAM-BA Command Line Tool v3.8 Copyright 2024 Microchip Technology Usage: ./sam-ba [options] SAM-BA Command Line Tool Options: -v, --version Displays version information. -h, --help Displays this help. -t, --tracelevel <trace_level> Set trace level to <trace_level>. -L, --applet-buffer-limit <SIZE> Set applet buffer limit to <SIZE>
bytes (default 131072). -x, --execute <script.qml> Execute script <script.qml>. -p, --port <port[:options:...]> Communicate with device using <port>. -d, --device <device[:options:...]> Connected device is <device>. -b, --board <board[:options:...]> Connected board is <board>. -m, --monitor <command[:options:...]> Run monitor command <command>. -a, --applet <applet[:options:...]> Load and initialize applet <applet>. -c, --command <command[:args:...]> Run command <command>. -w, --working-directory <DIR> Set working directory to <DIR>.
Additional help can be obtained for most commands by supplying a "help" parameter that will display their usage.
For example "sam-ba --port help" will display:
Known ports: j-link, serial, secure
Command that take an argument with options (port, monitor, applet) will display even more documentation when called with "help" as option value.
For example "sam-ba --port serial:help" will display:
Syntax:
serial:[<port>]:[<baudrate>]
Examples:
serial serial port (will use first AT91 USB if found otherwise first serial port)
serial:COM80 serial port on COM80
serial:ttyUSB0:57600 serial port on /dev/ttyUSB0, baudrate 57600
Programming components into SPI flash
Program AT91Bootstrap binary
Run SAM-BA with USB connection (equivalent toserial) and erase the beginning of the SPI flash and then write AT91Bootstrap binary:
# sam-ba -p serial -b sama5d2-xplained -a serialflash -c erase::0x3000 -c writeboot:at91bootstrap-sama5d2_xplained.bin Opening serial port 'ttyACM0' Connection opened. Detected memory size is 4194304 bytes. Page size is 256 bytes. Buffer is 93952 bytes (367 pages) at address 0x002290c0. Supported erase block sizes: 4KB, 32KB, 64KB Executing command 'erase::0x3000' Erased 4096 bytes at address 0x00000000 (33.33%) Erased 4096 bytes at address 0x00001000 (66.67%) Erased 4096 bytes at address 0x00002000 (100.00%) Executing command 'writeboot:at91bootstrap-sama5d2_xplained.bin' Appending 56 bytes of padding to fill the last written page Wrote 10752 bytes at address 0x00000000 (100.00%) Connection closed.
Note that you can run several commands on the same SAM-BA invocation.
Program U-Boot binary
Run SAM-BA with USB connection (equivalent toserial) and erase the U-Boot section in the SPI flash memory map and then write U-Boot binary:
# sam-ba -p serial -b sama5d2-xplained -a serialflash -c erase:0x8000:0x70000 -c write:u-boot-sama5d2-xplained.bin:0x8000 Opening serial port 'ttyACM0' Connection opened. Detected memory size is 4194304 bytes. Page size is 256 bytes. Buffer is 93952 bytes (367 pages) at address 0x002290c0. Supported erase block sizes: 4KB, 32KB, 64KB Executing command 'erase:0x8000:0x70000' Erased 32768 bytes at address 0x00008000 (7.14%) Erased 65536 bytes at address 0x00010000 (21.43%) Erased 65536 bytes at address 0x00020000 (35.71%) Erased 65536 bytes at address 0x00030000 (50.00%) Erased 65536 bytes at address 0x00040000 (64.29%) Erased 65536 bytes at address 0x00050000 (78.57%) Erased 65536 bytes at address 0x00060000 (92.86%) Erased 32768 bytes at address 0x00070000 (100.00%) Executing command 'write:u-boot-sama5d2-xplained.bin:0x8000' Appending 118 bytes of padding to fill the last written page Wrote 93952 bytes at address 0x00008000 (23.30%) Wrote 93952 bytes at address 0x0001ef00 (46.60%) Wrote 93952 bytes at address 0x00035e00 (69.90%) Wrote 93952 bytes at address 0x0004cd00 (93.21%) Wrote 27392 bytes at address 0x00063c00 (100.00%) Connection closed.
Programming components into eMMC flash
Program rootfs file
With SAM-BA you can directly program SD/MMC images to the on-board eMMC. These images are named*.img or *.wic for the ones generated by Yocto Project.
# sam-ba -p serial -b sama5d2-xplained -a sdmmc -c write:atmel-qt5-demo-image-sama5d2-xplained.wic Opening serial port 'ttyACM0' Connection opened. Detected memory size is 3925868544 bytes. Page size is 512 bytes. Buffer is 88576 bytes (173 pages) at address 0x0022a5a0. Executing command 'write:atmel-qt5-demo-image-sama5d2-xplained.wic' Wrote 88576 bytes at address 0x00000000 (0.02%) Wrote 88576 bytes at address 0x00015a00 (0.04%) Wrote 88576 bytes at address 0x0002b400 (0.05%) Wrote 88576 bytes at address 0x00040e00 (0.07%) Wrote 88576 bytes at address 0x00056800 (0.09%) [..] Wrote 88576 bytes at address 0x1d4e8600 (99.98%) Wrote 88576 bytes at address 0x1d4fe000 (100.00%) Wrote 4608 bytes at address 0x1d513a00 (100.00%) Connection closed.
Note that programming a rootfs of several hundreds of MiB will take a few minutes to complete.
Recent FAQ
- Sama5d2Xplained
-
• Media Controller: What is Media controller and how to use it with SAM products.. (linux-5.15-mchp, linux-6.1-mchp, linux-6.6-mchp)
• Using Atmel DRMDriver: Using Atmel KMS/DRM LCD driver. (Kernel, linux-3.18-at91, linux-4.1-at91, linux-4.4-at91, linux-4.9-at91, linux-4.14-at91, linux-4.19-at91, linux-5.4-at91, linux-5.10-at91, linux-5.15-mchp, linux-6.1-mchp, linux-6.6-mchp)
• U-Boot FAQ: Some U-Boot FAQ entries. (U-Boot)
• Using FITwith Overlays: How to use U-boot with FIT image to load overlays. (U-Boot, Kernel)
• Patching DTin Uboot: How to apply DTBOs in U-boot. (U-Boot, Kernel)
• Using SAMA 5 D 2 ADCDevice: Using the SAMA5D2-compatible ADC device. (Kernel, linux-5.15-mchp, linux-6.1-mchp, linux-6.6-mchp)
• Connect Module From PDA: How to connect LCD module from PDA to the Boards. (Kernel)
• Convert SAMBAScript: SAM-BA API revisions. (SAM-BA)
• Crypto Config: How to configure Crypto driver. (Kernel, linux-3.18-at91, linux-4.1-at91, linux-4.4-at91, linux-4.9-at91, linux-4.14-at91, linux-4.19-at91, linux-5.4-at91, linux-5.10-at91, linux-5.15-mchp, linux-6.1-mchp, linux-6.6-mchp)
• USBGadget Config: Configure AT91 USB Gadget on Linux and Endpoint order management (composite USB). (Kernel, linux-4.4-at91, linux-4.9-at91, linux-4.14-at91, linux-4.19-at91, linux-5.4-at91, linux-5.10-at91, linux-5.15-mchp, linux-6.1-mchp, linux-6.6-mchp)
• Pwm Faq: PWM Driver. (Kernel, linux-3.10-at91, linux-3.18-at91, linux-4.1-at91, linux-4.4-at91, linux-4.9-at91, linux-4.14-at91, linux-4.19-at91, linux-5.4-at91, linux-5.10-at91, linux-5.15-mchp, linux-6.1-mchp, linux-6.6-mchp)
• Using I 2 SC: How to use I2SC. (linux-5.10-at91, linux-5.15-mchp, linux-6.1-mchp, linux-6.6-mchp)
• ISCWhite Balance Features: White balance features of the Image sensor controller.. (Kernel, linux-4.19-at91, linux-5.4-at91, linux-5.10-at91, linux-5.15-mchp, linux-6.1-mchp, linux-6.6-mchp)
• External Component On EBI: Connecting an external component on the External Bus Interface. (Kernel, linux-4.14-at91, linux-4.19-at91, linux-5.4-at91, linux-5.10-at91, linux-5.15-mchp, linux-6.1-mchp, linux-6.6-mchp)
• SDCard Boot Notice: How to boot up the board from SD card. (AT91Bootstrap)
• Hasherrorwhenbooting FITimage: . (U-Boot)