SHIP:Port:USBF CDC

From Serious Documentation
Revision as of 05:40, 14 November 2018 by TerryWest (talk | contribs)
Jump to: navigation, search

USBF (i.e. USB Device) Communications Class Device (CDC) port variables are used to configure the way a SIM communicates with some other device and are referred to in the format "platform.USBF_CDC0", "platform.USBF_CDC1", etc.

USBF_CDC devices act just like UARTs, and have a subset of the UART portvars.

Multiple USB Device protocols (aka "classes") can be active on the same port simultaneously. For example, on USB device port 0 on a platform, you can have:

  • USBF_CDC0, implementing the Communications Device Class (aka "serial port over USB"), and,
  • USBF_VENDOR0, the Vendor (or "Raw") class bound to a SHIPBridge Protocol link exchanging data with another board

both operating simultaneously.

If you attempt to set an invalid value for any of these portvars, the value of the portvar will not be changed. (see UART_FLAGS)

Portvar Data Type Permissions Description
rate Integer Read/Write The baud rate.
bits UART_FLAG Read/Write The number of bits per character set.
stop UART_FLAG Read/Write The number of stop bits sent after each character set.
parity UART_FLAG Read/Write The parity bit sent after each character set.

see GRM