Serial Commands #

Use the serial commands to get information about and configure the serial configuration.

For more information about the supported serial communication protocols see VCOM and Auxiliary UART.


Commands	Description
serial vcom	Get information about the serial configuration.
serial vcom config	Configure the serial configuration.
serial vcom ctrl	Manually control serial handshake lines.
serial vcom stats	Get serial communication stats.
serial vcom enable	Enable serial communication.
serial vcom disable	Disable serial communication.

serial vcom#

Gets information about the currently selected serial configuration. Shows the active configuration as well as the configuration stored in persistent memory.

Command Line Syntax

$ serial vcom$ serial vcom

Command Line Examples

$ serial vcom
----- Virtual COM port -----
Stored port speed  : 115200
Active port speed  : 487603
Stored handshake   : auto
Actual handshake   : disabled

$ serial vcom
----- Aux uart -----
Stored port speed     : 115200
Active port speed     : 115200
Stored aux uart mode  : enabled
Actual aux uart mode  : enabled

$ serial vcom
----- Virtual COM port -----
Stored port speed     : 115200
Active port speed     : 115234
Stored handshake      : aux
Actual handshake      : rts
RTS Asserted - Ready to Receive.

----- Aux uart -----
Stored port speed     : 115200
Active port speed     : N/A
Stored aux uart mode  : enabled
Actual aux uart mode  : disabled

$ serial vcom
----- Virtual COM port -----
Stored port speed     : 115200
Active port speed     : N/A
Stored handshake      : cts
Actual handshake      : aux

----- Aux uart -----
Stored port speed     : 115200
Active port speed     : 115200
Stored aux uart mode  : disabled
Actual aux uart mode  : enabled$ serial vcom
----- Virtual COM port -----
Stored port speed  : 115200
Active port speed  : 487603
Stored handshake   : auto
Actual handshake   : disabled

$ serial vcom
----- Aux uart -----
Stored port speed     : 115200
Active port speed     : 115200
Stored aux uart mode  : enabled
Actual aux uart mode  : enabled

$ serial vcom
----- Virtual COM port -----
Stored port speed     : 115200
Active port speed     : 115234
Stored handshake      : aux
Actual handshake      : rts
RTS Asserted - Ready to Receive.

----- Aux uart -----
Stored port speed     : 115200
Active port speed     : N/A
Stored aux uart mode  : enabled
Actual aux uart mode  : disabled

$ serial vcom
----- Virtual COM port -----
Stored port speed     : 115200
Active port speed     : N/A
Stored handshake      : cts
Actual handshake      : aux

----- Aux uart -----
Stored port speed     : 115200
Active port speed     : 115200
Stored aux uart mode  : disabled
Actual aux uart mode  : enabled

serial vcom config#

Configures the serial configuration. You can change the handshake type, the baud rate, or both. By default, the configuration is stored in persistent memory. To skip this, use the --nostore option.

Supported handshake types and baud rates depend on the adapter type. Handshake signals are described from the board controller’s perspective; RTS is an input to the board controller, and CTS is an output from it.

Supported baud rates range from 9600 to 3,686,400. Baud rate configuration for the auxiliary UART is supported only on EKs and DKs.


Handshake type	Description	Supported on
rts	Enable RTS hardware flow control
cts	Enable CTS hardware flow control
rtscts	Enable RTS and CTS hardware flow control
disable	Disable hardware flow control
auto	Automatically set hardware flow control at boot
aux	Enables auxilary UART and disables VCOM

Command Line Syntax

$ serial vcom config [--nostore] [handshake <handshakeType>] [speed <bitrate>]$ serial vcom config [--nostore] [handshake <handshakeType>] [speed <bitrate>]

Command Line Examples

$ serial vcom config --nostore handshake rtscts speed 486000
Baudrate set to 486000 bps
Actual baud rate: 487603 Hz
RTS handshake enabled
CTS handshake enabled
Aux uart disabled

$ serial vcom config speed 115200
Baudrate set to 115200 bps
Actual baud rate: 115234 Hz
Serial configuration saved$ serial vcom config --nostore handshake rtscts speed 486000
Baudrate set to 486000 bps
Actual baud rate: 487603 Hz
RTS handshake enabled
CTS handshake enabled
Aux uart disabled

$ serial vcom config speed 115200
Baudrate set to 115200 bps
Actual baud rate: 115234 Hz
Serial configuration saved

serial vcom ctrl#

Manually controls serial handshake lines. The command supports asserting and deasserting either RTS or CTS or both at the same time.

Command Line Syntax

$ serial vcom ctrl [rts <assert/deassert>] [cts <assert/deassert>]$ serial vcom ctrl [rts <assert/deassert>] [cts <assert/deassert>]

Command Line Examples

$ serial vcom ctrl rts assert
RTS asserted

$ serial vcom ctrl cts assert rts deassert
RTS deasserted
CTS asserted$ serial vcom ctrl rts assert
RTS asserted

$ serial vcom ctrl cts assert rts deassert
RTS deasserted
CTS asserted

serial vcom stats#

Gets serial communication stats.

Command Line Syntax

$ serial vcom stats$ serial vcom stats

Command Line Example

$ serial vcom stats
### Target to Host ###
From target: 1818 bytes
Discarded:   106 bytes
Forwarded:   1712 bytes
By transport:
   CDC:      1712 bytes
   Conn:     0 bytes
   Appdata:  0 bytes
Last transport: CDC

### Host to Target ###
From host:   21 bytes
Discarded:   0 bytes
Forwarded:   21 bytes
By transport:
   CDC:      21 bytes
   Conn:     0 bytes
   Appdata:  0 bytes
Last transport: CDC$ serial vcom stats
### Target to Host ###
From target: 1818 bytes
Discarded:   106 bytes
Forwarded:   1712 bytes
By transport:
   CDC:      1712 bytes
   Conn:     0 bytes
   Appdata:  0 bytes
Last transport: CDC

### Host to Target ###
From host:   21 bytes
Discarded:   0 bytes
Forwarded:   21 bytes
By transport:
   CDC:      21 bytes
   Conn:     0 bytes
   Appdata:  0 bytes
Last transport: CDC

serial vcom enable#

Enable serial communication. It is not possible to enable serial communication while the currently selected debug mode is in.

Command Line Syntax

$ serial vcom enable$ serial vcom enable

Command Line Example

$ serial vcom enable
Enabling VCOM.$ serial vcom enable
Enabling VCOM.

serial vcom disable#

Disable serial communication.

Command Line Syntax

$ serial vcom disable$ serial vcom disable

Command Line Example

$ serial vcom disable
Disabling VCOM.$ serial vcom disable
Disabling VCOM.