uartCfg - Configure UART

Configure a UART port. This command can be used to adjust the baud rate and bit settings of a UART port. Additionally, it can be used to configure additional UART ports via USB.

Usage:

- command: uartCfg <uartPort> <speed> [<triplet>]
  [id: <usbDeviceID>]
  [path: <usbDevicePath>]
  [interface: <usbDeviceInterface>]

Argument

Description

uartPort

UART port name: UART0, UART1, UART2, etc.

speed

Baud rate, in bits per second. Must be greater than 0 and no more than 3000000 (3 Mbps).

triplet

UART configuration triplet: 8N1 (8 data bits, no parity, 1 stop bit; default if omitted), 8E1 (8 data bits, even parity, 1 stop bit), or 7E1 (7 data bits, even parity, 1 stop bit).

usbDeviceID

Optional: USB device identifiers: VID:PID.

usbDevicePath

Optional: USB device path: port. ... .port.

usbDeviceInterface

Optional: USB device interface: interface_number.

External USB serial interfaces can be configured as UART ports by using the usbDeviceID, usbDevicePath, or usbDeviceInterface fields. FTDI UART adapters and USB-CDC peripherals are supported.

Note

The built-in UART ports cannot be redefined. That is, the usbDeviceID, usbDevicePath, and/or usbDeviceInterface parameters can’t be set on UART0 or UART1.

Note

Hardware flow control (RTS/CTS) and software flow control (XON/XOFF) are not currently supported; only no-flow-control configuration is available.

Probe multiplexing

- command: uartCfg UART0 tp

For UART0 on carrier boards with a probe multiplexer, uartCfg UART0 tp switches the UART0 multiplexer to use the debug test-point path instead of the standard UART0 connection. This form is not available for UART1 or higher-numbered ports. Configuring UART0’s baud rate/triplet (the normal uartCfg UART0 <speed> ... form) switches the multiplexer back to the standard UART0 path.

Examples

See also