Sama5d2 Xplained

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 are 115200 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: https://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 Port should appear in Device Manager. The COMxx number will be used to configure the terminal emulator.
    
     
  • For Linux users: Identify the serial USB connection by monitoring the last lines of dmesg command. The /dev/ttyUSBx number 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 ttyUSB0

A /dev/ttyUSB0 node has been created.

• 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 Port should appear in Device Manager. The COMxx number will be used to configure the terminal emulator.
    
     
  • For Linux users: identify the USB connection by monitoring the last lines of dmesg command. The /dev/ttyACMx number 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

• Now open your favorite terminal emulator with appropriate settings

Demo

Demo archives

You need a 1 GB (or larger) SD card 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), and
• 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 open-source software tool is useful for obtaining a compressed image as input. Additional information and support can be found on the balenaEtcher website. 

Flash the demo

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 Converter should 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 dmesg command:
    [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-ba application 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.bat file
• for Linux users: Launch the demo_linux_serialflash.sh file
• this script runs SAM-BA 3 and the associated QML sam-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

Back to Top

Back to Top

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:

Configure AT91Bootstrap

Assuming you are at the AT91Bootstrap root directory, you will find a configs folder which contains several default configuration files:

You can configure AT91Bootstrap to load U-Boot binary from SD Card by doing:

If 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:

Now, 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:

If 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/u-boot-2024.07-mchp
    origin/uboot_5series_1.x
  
     $ git checkout origin/u-boot-2024.07-mchp -b u-boot-2024.07-mchp
    Branch 'u-boot-2024.07-mchp' set up to track remote branch 'u-boot-2024.07-mchp' from 'origin'.
    Switched to a new branch 'u-boot-2024.07-mchp'

Cross-compiling U-Boot

Before compiling the U-Boot, you need setup cross compile toolchain in the Setup ARM Cross Compiler above.

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.

The U-Boot environment variables can be stored in different media, above config files can specify where to store the U-Boot environment.

Here are the building steps for the SAMA5D2-Xplained board:

The result of these operations is a fresh U-Boot binary called u-boot.bin corresponding to the binary ELF file u-boot.

• u-boot.bin is the file you should store on the board
• u-boot is 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:

The source code has been taken from the master branch which is pointing on the latest branch we use.

If you want to use another branch, you can list them and use one of them by doing this:

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-

  or

  tar -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/

  • Information

     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 in arch/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

   

Now we Configure and Build kernel for sama5d2xplained board:

You can modify default configuration using the menuconfig.

Build Yocto Project rootfs from sources

Support for the Microchip MPU SoC family is included in a particular Yocto Project layer, meta-mchp. The source for this layer is hosted on the Linux4Microchip GitHub account on the "Microchip Yocto Project BSP" page.

Building Environment

A step-by-step, comprehensive installation is explained on the "Yocto Project Quick Build" page. The following lines should be considered as an add-on that is MPU-specific or that can facilitate your setup.

Step-by-Step Build Procedure

OpenEmbedded/Yocto Project BSP Layer for Microchip's SoCs

• Description
  • The meta-mchp-common layer consolidates common Board Support Package (BSP) components and metadata for Microchip platforms, streamlining development across various Microchip devices for use with OpenEmbedded and/or Yocto Project.
• Supported Machines
  • The meta-mchp-common layer provides support for various Microchip platforms. For detailed information about supported machines, please refer to the documentation in the relevant sub-layers:
    • MPU layer README
• Prerequisites
  • Before starting, please refer to the Required Packages for Build Host section in the Yocto Project Documentation to install required dependencies for the build environment:

For instance, on Ubuntu or Debian, these packages need to be installed on your development host:

• Usage

  • To integrate this layer into your Yocto Project build environment:

  Clone the necessary repositories.

  Create an empty directory to hold the workspace:

  mkdir yocto-dev
  cd yocto-dev

  Use the repo tool to fetch all the required repositories.

  Information

  Note: Make sure to install the repo utility first.

  repo init -u https://github.com/linux4microchip/meta-mchp-manifest.git -b <branch> -m <target>/default.xml

  Replace and with the Yocto Project release branch and the manifest required. For example:

  repo init -u https://github.com/linux4microchip/meta-mchp-manifest.git -b scarthgap -m mpu/default.xml

  Fetch all the required repositories using the following repo command:

  repo sync

  Back to Top

  ---

  Initialize the build environment.

  The meta-mchp repository provides sample configuration templates that help set up BitBake layers and key configuration files in the Yocto Project build directory.

  Set the TEMPLATECONF environment variable to point to the appropriate configuration template before initializing the build environment:

  export TEMPLATECONF=${TEMPLATECONF:-../meta-mchp/<meta-layer>/conf/templates/default}

  Replace meta-layer above with the desired layer based on your target platform. For example:

  export TEMPLATECONF=${TEMPLATECONF:-../meta-mchp/meta-mchp-mpu/conf/templates/default}

  Information

  Note: Setting TEMPLATECONF is only needed the first time you will run the source command.

  Then initialize the Yocto Project build environment:

  source openembedded-core/oe-init-build-env

  Back to Top

  ---

  Set the target machine and build the image.

  MACHINE=<machine> bitbake core-image-minimal

  Each sub-layer provides several images that include demos and applications tailored for its respective platform.

  For more information on the supported images, please refer to the MPU layer README.

  • Layer Dependencies

    This layer depends on the following layers:

    - meta-openembedded
     - URI: git://git.openembedded.org/meta-openembedded
     - Layers: meta-oe, meta-networking, meta-python
    
    - openembedded-core
     - URI: git://git.openembedded.org/openembedded-core
     - Layers: meta

  For information on the specific revisions used, refer to the meta-mchp manifest repository.

  Back to Top

  ---

• Licensing
  • The contents of this layer are licensed under the MIT License. See COPYING.MIT for details
• Contributing 

• If you want to contribute changes, you can send GitHub pull requests. See CONTRIBUTING.md for additional information about contribution guidelines.

Using SAM-BA to flash components to board

Install SAM-BA Software In Your PC

We maintain information about SAM-BA in the "SoftwareTools" page.

Launch SAM-BA tools

• According to this section make sure that the chip can execute the SAM-BA Monitor.

In addition to the Qt^® 5 QML language for scripting used for flashing the demos, the most common SAM-BA software actions can be done using the SAM-BA software command line.

For browsing information on the SAM-BA software command line usage, please see the command line documentation available in the SAM-BA software installation directory, doc/index.html or doc/cmdline.html.

SAM-BA software includes a 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 --help command:

If you get the following error, it indicates a symbol mismatch or unresolved symbol when the sam-ba executable is being loaded:

Check for Qt libraries inside the extracted SAM-BA software directory.

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:

Commands that take an argument with options (port, monitor, applet) will display even more documentation when called with "help" as the option value.

For example, "sam-ba --port serial:help" will display:

Programming components into SPI flash

Program AT91Bootstrap binary

Run SAM-BA with USB connection (equivalent to serial) and erase the beginning of the SPI flash and then write AT91Bootstrap binary:

Program U-Boot binary

Run SAM-BA with USB connection (equivalent to serial) and erase the U-Boot section in the SPI flash memory map and then write U-Boot binary:

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.

Recent FAQ

• Boot Logo for SAM SOC's
• Compiling Linux Kernel fails looking at OpenSSL header files
• Connect Module From PDA
• Convert SAM-BA Scripts
• Crypto Hardware Acceleration
• Hash Error When Booting FIT Image
• Image Sensor Controller White balance features
• Media controller pipeline for image acquisition and SAM MPU products
• How to patch Device Tree Blob in U-boot using Overlays
• How to use Pulse Width Modulation driver
• Using the SAMA5D2-compatible ADC device
• SD card boot for AT91SAM SoC
• USB Gadget Configuration
• How to use the Atmel KMS/DRM LCD driver
• Using FIT Image and Device Tree Overlays
• Using I2SC (Inter-IC Sound Controller)
• External Component on External Bus Interface