SAM-BA 3 subsections

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.1 release page.

In addition to the Qt5 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

Run script to flash the demo

download the demo package for the board. They are marked as \"Media type: \" 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_.bat file
for Linux users: Launch the demo_linux_.sh file
this script runs SAM-BA 3 and the associated QML sam-ba script (demo_linux__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

Connect the USB to the board before launching SAM-BA

Remove power from the board
JP9 must be opened (BMS=1) to boot from the on-chip Boot ROM

Cogent module	Embest module	Ronetix module
open `*NCS` jumper	open `SW1` switch (not `ON` position)	open `J1` and `J2` jumpers
which is (are) located on the CPU module to prevent access to serial flash and NAND flash

power up 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
  $\"AT91$
- For Linux users: check $percntGREEN$percnt/dev/ttyACMx$percntENDCOLOR$percnt by monitoring the last lines of dmesg command: