Difference between revisions of "SHIP:Port:USBF CDC"

From Serious Documentation
Jump to: navigation, search
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
<onlyinclude>USBF (i.e. USB Device) Communications Class Device (CDC) port variables are used to configure the way a [[SIMs|SIM]] communicates with some other device and are referred to in the format "'''platform.USBF_CDC0'''", "'''platform.USBF_CDC1'''", etc.
 
<onlyinclude>USBF (i.e. USB Device) Communications Class Device (CDC) port variables are used to configure the way a [[SIMs|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 [[SHIP:Portvar|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:  
−
 
 
−
Multiple USB Device protocols (i.e. 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_CDC0''', implementing the Communications Device Class (aka "serial port over USB"), and,  
 
* '''USBF_VENDOR0''', the Vendor (or "Raw") class bound to a [[SHIPBridge | SHIPBridge Protocol]] link exchanging data with another board
 
* '''USBF_VENDOR0''', the Vendor (or "Raw") class bound to a [[SHIPBridge | SHIPBridge Protocol]] link exchanging data with another board
 
both operating simultaneously.
 
both operating simultaneously.
  
−
If you attempt to set an invalid value for any of these [[SHIP:Portvar|portvars]], the value of the portvar will not be changed. (see {{Const|UART_FLAGS}})
+
USBF_CDC devices act just like UARTs, and have a subset of the UART [[SHIP:Portvar|portvars]].  If you attempt to set an invalid value for any of these [[SHIP:Portvar|portvars]], the value of the portvar will not be changed. (see {{Const|UART_FLAGS}})
 
{{PortvarTableStart|}}
 
{{PortvarTableStart|}}
 
|{{:SHIP:Port:uart:rate}}
 
|{{:SHIP:Port:uart:rate}}

Latest revision as of 05:42, 14 November 2018

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.

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.

USBF_CDC devices act just like UARTs, and have a subset of the UART portvars. 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

Retrieved from "https://techref.myserious.com/index.php?title=SHIP:Port:USBF_CDC&oldid=7811"