SAM-BA® ISP - Target Console Serial Communications

Introduction

The Target Console (also known as DEBUG, Device Console, Applet Console, or simply Console) is a serial communications port (generally a Universal Asynchronous Receiver Transmitter (UART)) on the target device that can communicate with a terminal emulation program on a host computer. It provides status information from operating systems, such as Linux®, and debug information from utility programs (for example, from "SAM-BA® ISP - Applets").

The SAM-BA Host to Monitor serial communications link is a dedicated serial port separate from the Target Console serial communications.

SAM-BA_Block_Diagram.png
Block Diagram of a SAMA5D2 Series MPU

As shown in the SAMA5D2 Series MPU block diagram, the UART is configured as the Target Console by the Boot Configuration Word. A serial-to-USB converter is generally needed for the USB port on a host computer to communicate with a two-wire UART of the target. On some evaluation kits, the serial-to-USB converter is on-board. This Target Console is also called the DEBUG port.

When the host computer is connected to the evaluation kit or separate serial-to-USB converter, the host computer will enumerate as a Communication Device Class (CDC). Take note of the USB port designation as it will be needed to configure the Terminal Emulation Program.

Terminal Emulation Program

Download, install, and configure a Terminal Emulation program onto your host computer.

For more detailed instructions on how to set up a terminal emulation program, see the "ATSAMA5D27-SOM1-EK1 – Console Serial Communications" article.

Serial Communications Port

Connect the host computer running the terminal emulation program to the target console serial communications port. The host computer will enumerate as a CDC. Take note of the USB port designation as it will be needed to configure the Terminal Emulation Program.

Evaluation Kit

If you are using an evaluation kit, the user manual will identify the port used for the console. The -b, --board option will configure the SAM-BA host to communicate with the default console of the evaluation kit

Custom Board

If you are developing with a custom board design, the Target Console can be configured by the Boot Configuration of the target device. In addition, the console can be set using the -d, --device <console_instance>:<console_ioset> option.

$ sam-ba -p serial -d sama5d2:help

Syntax: sama5d2:[<instance>]:[<ioset>]
Parameters:
    instance - Serial console peripheral number
    ioset - Serial console I/O set
Examples:
    sama5d2 - use default device/board settings
    sama5d2:1:2 - use fully custom settings (peripheral number 1, I/O set 2)
    sama5d2::2 - use default device/board settings but force use of I/O set 2
Note:
    Peripheral numbers and I/O sets are device specific. Please see device documentation in 'doc' directory.

Supported console {<instance>, <ioset>} pairs are device specific; refer to the "Serial Console Configuration" section of the device configuration in the SAM-BA documentation: ../doc/devices.html

Applet Trace Level

Applet trace level verbosity can be controlled with the -t, --tracelevel option. See the "SAM-BA ISP - Applets" article for more information.

© 2020 Microchip Technology, Inc.
Notice: ARM and Cortex are the registered trademarks of ARM Limited in the EU and other countries.
Information contained on this site regarding device applications and the like is provided only for your convenience and may be superseded by updates. It is your responsibility to ensure that your application meets with your specifications. MICROCHIP MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WHETHER EXPRESS OR IMPLIED, WRITTEN OR ORAL, STATUTORY OR OTHERWISE, RELATED TO THE INFORMATION, INCLUDING BUT NOT LIMITED TO ITS CONDITION, QUALITY, PERFORMANCE, MERCHANTABILITY OR FITNESS FOR PURPOSE. Microchip disclaims all liability arising from this information and its use. Use of Microchip devices in life support and/or safety applications is entirely at the buyer's risk, and the buyer agrees to defend, indemnify and hold harmless Microchip from any and all damages, claims, suits, or expenses resulting from such use. No licenses are conveyed, implicitly or otherwise, under any Microchip intellectual property rights.