Difference between revisions of "Unit USBCDC"

From Ultibo.org
Jump to: navigation, search
 
(One intermediate revision by the same user not shown)
Line 383: Line 383:
 
----
 
----
  
−
''To be documented''
+
 
 +
'''CDC descriptor'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PUSBCDCDescriptor = ^TUSBCDCDescriptor;</code>
 +
 
 +
<code>TUSBCDCDescriptor = packed record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>bFunctionLength:Byte;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>bDescriptorType:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>bDescriptorSubType:Byte;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''CDC header descriptor'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PUSBCDCHeaderDescriptor = ^TUSBCDCHeaderDescriptor;</code>
 +
 
 +
<code>TUSBCDCHeaderDescriptor = packed record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|See: Section 5.2.3.1 of USB Class Definitions for Communications Devices 1.2
 +
|-
 +
| <code>bFunctionLength:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>bDescriptorType:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>bDescriptorSubType:Byte;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>bcdCDC:Word;</code>
 +
| LE16
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''CDC call management descriptor'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PUSBCDCCallManagementDescriptor = ^TUSBCDCCallManagementDescriptor;</code>
 +
 
 +
<code>TUSBCDCCallManagementDescriptor = packed record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|See: Section 5.2.3.2 of USB Class Definitions for Communications Devices 1.2
 +
|-
 +
| <code>bFunctionLength:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>bDescriptorType:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>bDescriptorSubType:Byte;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>bmCapabilities:Byte;</code>
 +
| See USB_CDC_CALL_MGMT_CAP_*
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''CDC abstract control management descriptor'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PUSBCDCACMDescriptor = ^TUSBCDCACMDescriptor;</code>
 +
 
 +
<code>TUSBCDCACMDescriptor = packed record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|See: Section 5.2.3.3 of USB Class Definitions for Communications Devices 1.2
 +
|-
 +
| <code>bFunctionLength:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>bDescriptorType:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>bDescriptorSubType:Byte;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>bmCapabilities:Byte;</code>
 +
| See USB_CDC_ACM_*
 +
|-
 +
|}
 +
</div></div>
 +
 +
'''CDC union descriptor'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PUSBCDCUnionDescriptor = ^TUSBCDCUnionDescriptor;</code>
 +
 
 +
<code>TUSBCDCUnionDescriptor = packed record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|See: Section 5.2.3.8 of USB Class Definitions for Communications Devices 1.2
 +
|-
 +
| <code>bFunctionLength:Byte;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>bDescriptorType:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>bDescriptorSubType:Byte;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>bMasterInterface0:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>bSlaveInterface0:Byte;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|''Additional Slave interfaces dependent on bFunctionLength''
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''CDC country descriptor'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PUSBCDCCountryDescriptor = ^TUSBCDCCountryDescriptor;</code>
 +
 
 +
<code>TUSBCDCCountryDescriptor = packed record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|See: Section 5.2.3.9 of USB Class Definitions for Communications Devices 1.2
 +
|-
 +
| <code>bFunctionLength:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>bDescriptorType:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>bDescriptorSubType:Byte;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>iCountryCodeRelDate:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>wCountyCode0:Word;</code>
 +
| LE16
 +
|-
 +
|colspan="2"|''Additional Country codes dependent on bFunctionLength''
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''CDC network terminal descriptor'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PUSBCDCNetworkTerminalDescriptor = ^TUSBCDCNetworkTerminalDescriptor;</code>
 +
 
 +
<code>TUSBCDCNetworkTerminalDescriptor = packed record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|See: Section 5.2.3.11 of USB Class Definitions for Communications Devices 1.2
 +
|-
 +
| <code>bFunctionLength:Byte;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>bDescriptorType:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>bDescriptorSubType:Byte;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>bEntityId:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>iName:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>bChannelIndex:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>bPhysicalInterface:Byte;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''CDC ethernet descriptor'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PUSBCDCEthernetDescriptor = ^TUSBCDCEthernetDescriptor;</code>
 +
 
 +
<code>TUSBCDCEthernetDescriptor = packed record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|See: Section 5.4 of USB Communications Class Subclass Specification for Ethernet Control Model Devices 1.2
 +
|-
 +
| <code>bFunctionLength:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>bDescriptorType:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>bDescriptorSubType:Byte;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>iMACAddress:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>bmEthernetStatistics:LongWord;</code>
 +
| LE32
 +
|-
 +
| <code>wMaxSegmentSize:Word;</code>
 +
| LE16
 +
|-
 +
| <code>wNumberMCFilters:Word;</code>
 +
| LE16
 +
|-
 +
| <code>bNumberPowerFilters:Byte;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''CDC telephone control model descriptor'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PUSBCDCTCMDescriptor = ^TUSBCDCTCMDescriptor;</code>
 +
 
 +
<code>TUSBCDCTCMDescriptor = packed record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|See: Section 6.3.2.3 of USB CDC Subclass Specification for Wireless Mobile Communications Devices 1.1
 +
|-
 +
| <code>bFunctionLength:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>bDescriptorType:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>bDescriptorSubType:Byte;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>bcdVersion:Word;</code>
 +
| &nbsp;
 +
|-
 +
| <code>wMaxCommand:Word;</code>
 +
| LE16
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''CDC MDLM descriptor'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PUSBCDCMDLMDescriptor = ^TUSBCDCMDLMDescriptor;</code>
 +
 
 +
<code>TUSBCDCMDLMDescriptor = packed record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|See: Section 6.7.2.3 of USB CDC Subclass Specification for Wireless Mobile Communications Devices 1.1
 +
|-
 +
| <code>bFunctionLength:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>bDescriptorType:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>bDescriptorSubType:Byte;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>bcdVersion:Word;</code>
 +
| LE16
 +
|-
 +
| <code>bGUID:array[0..15] of Byte;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''CDC MDLM detail descriptor'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PUSBCDCMDLMDetailDescriptor = ^TUSBCDCMDLMDetailDescriptor;</code>
 +
 
 +
<code>TUSBCDCMDLMDetailDescriptor = packed record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|See: Section 6.7.2.4 of USB CDC Subclass Specification for Wireless Mobile Communications Devices 1.1
 +
|-
 +
| <code>bFunctionLength:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>bDescriptorType:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>bDescriptorSubType:Byte;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>bGuidDescriptorType:Byte;</code>
 +
| Associated with TUSBCDCMDLMDescriptor.bGUID
 +
|-
 +
| <code>bDetailData:array[0..0] of Byte;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''CDC OBEX descriptor'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PUSBCDCOBEXDescriptor = ^TUSBCDCOBEXDescriptor;</code>
 +
 
 +
<code>TUSBCDCOBEXDescriptor = packed record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|See: Section 6.5.2.3 of USB CDC Subclass Specification for Wireless Mobile Communications Devices 1.1
 +
|-
 +
| <code>bFunctionLength:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>bDescriptorType:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>bDescriptorSubType:Byte;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>bcdVersion:Word;</code>
 +
| LE16
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''CDC NCM descriptor'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PUSBCDCNCMDescriptor = ^TUSBCDCNCMDescriptor;</code>
 +
 
 +
<code>TUSBCDCNCMDescriptor = packed record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>bFunctionLength:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>bDescriptorType:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>bDescriptorSubType:Byte;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>bcdNcmVersion:Word;</code>
 +
| LE16
 +
|-
 +
| <code>bmNetworkCapabilities:Byte;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''CDC MBIM descriptor'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PUSBCDCMBIMDescriptor = ^TUSBCDCMBIMDescriptor;</code>
 +
 
 +
<code>TUSBCDCMBIMDescriptor = packed record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>bFunctionLength:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>bDescriptorType:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>bDescriptorSubType:Byte;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>bcdMBIMVersion:Word;</code>
 +
| LE16
 +
|-
 +
| <code>wMaxControlMessage:Word;</code>
 +
| LE16
 +
|-
 +
| <code>bNumberFilters:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>bMaxFilterSize:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>wMaxSegmentSize:Word;</code>
 +
| LE16
 +
|-
 +
| <code>bmNetworkCapabilities:Byte;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''CDC MBIM extended descriptor'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PUSBCDCMBIMExtendedDescriptor = ^TUSBCDCMBIMExtendedDescriptor;</code>
 +
 
 +
<code>TUSBCDCMBIMExtendedDescriptor = packed record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|''Device Properties''
 +
|-
 +
| <code>bFunctionLength:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>bDescriptorType:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>bDescriptorSubType:Byte;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>bcdMBIMExtendedVersion:Word;</code>
 +
| LE16
 +
|-
 +
| <code>bMaxOutstandingCommandMessages:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>wMTU:Word;</code>
 +
| LE16
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''CDC line coding'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PUSBCDCLineCoding = ^TUSBCDCLineCoding;</code>
 +
 
 +
<code>TUSBCDCLineCoding = packed record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|See: Section 6.3.11 of USB Communications Class Subclass Specification for PSTN Devices 1.2
 +
|-
 +
| <code>dwDTERate:LongWord;</code>
 +
| LE32
 +
|-
 +
| <code>bCharFormat:Byte;</code>
 +
| See USB_CDC_1_STOP_BITS etc
 +
|-
 +
| <code>bParityType:Byte;</code>
 +
| See USB_CDC_NO_PARITY etc
 +
|-
 +
| <code>bDataBits:Byte;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''CDC notification'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PUSBCDCNotification = ^TUSBCDCNotification;</code>
 +
 
 +
<code>TUSBCDCNotification = packed record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|See: Section 6.3 of USB Class Definitions for Communications Devices 1.2
 +
|-
 +
| <code>bmRequestType:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>bNotificationType:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>wValue:Word;</code>
 +
| LE16
 +
|-
 +
| <code>wIndex:Word;</code>
 +
| LE16
 +
|-
 +
| <code>wLength:Word;</code>
 +
| LE16
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''CDC connection speed change'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PUSBCDCSpeedChange = ^TUSBCDCSpeedChange;</code>
 +
 
 +
<code>TUSBCDCSpeedChange = packed record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|See: Section 6.3.3 of USB Class Definitions for Communications Devices 1.2
 +
|-
 +
| <code>DLBitRRate:LongWord;</code>
 +
| LE32 Contains the downlink bit rate, in bits per second, as sent on the IN pipe.
 +
|-
 +
| <code>ULBitRate:LongWord;</code>
 +
| LE32 Contains the uplink bit rate, in bits per second, as sent on the OUT pipe.
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''CDC headers'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PUSBCDCHeaders = ^TUSBCDCHeaders;</code>
 +
 
 +
<code>TUSBCDCHeaders = record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>UnionDescriptor:PUSBCDCUnionDescriptor;</code>
 +
| Union Functional Descriptor
 +
|-
 +
| <code>HeaderDescriptor:PUSBCDCHeaderDescriptor;</code>
 +
| Header Functional Descriptor
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>CallManagementDescriptor:PUSBCDCCallManagementDescriptor;</code>
 +
| Call Management Descriptor
 +
|-
 +
| <code>ACMDescriptor:PUSBCDCACMDescriptor;</code>
 +
| Abstract Control Management Descriptor
 +
|-
 +
| <code>CountryDescriptor:PUSBCDCCountryDescriptor;</code>
 +
| Country Selection Functional Descriptor
 +
|-
 +
| <code>NetworkTerminalDescriptor:PUSBCDCNetworkTerminalDescriptor;</code>
 +
| Network Channel Terminal Functional Descriptor
 +
|-
 +
| <code>EthernetDescriptor:PUSBCDCEthernetDescriptor;</code>
 +
| Ethernet Networking Functional Descriptor
 +
|-
 +
| <code>TCMDescriptor:PUSBCDCTCMDescriptor;</code>
 +
| Telephone Control Model Functional Descriptor
 +
|-
 +
| <code>MDLMDescriptor:PUSBCDCMDLMDescriptor;</code>
 +
| MDLM Functional Descriptor
 +
|-
 +
| <code>MDLMDetailDescriptor:PUSBCDCMDLMDetailDescriptor;</code>
 +
| MDLM Detail Functional Descriptor
 +
|-
 +
| <code>OBEXDescriptor:PUSBCDCOBEXDescriptor;</code>
 +
| OBEX Control Model Functional Descriptor
 +
|-
 +
| <code>NCMDescriptor:PUSBCDCNCMDescriptor;</code>
 +
| NCM Control Model Functional Descriptor
 +
|-
 +
| <code>MBIMDescriptor:PUSBCDCMBIMDescriptor;</code>
 +
| MBIM Control Model Functional Descriptor
 +
|-
 +
| <code>MBIMExtendedDescriptor:PUSBCDCMBIMExtendedDescriptor;</code>
 +
| MBIM Extended Functional Descriptor
 +
|-
 +
|}
 +
</div></div>
 +
<br />
  
 
=== Public variables ===
 
=== Public variables ===
Line 393: Line 997:
 
----
 
----
  
−
''To be documented''
 
  
 +
'''CDC helper functions'''
 +
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">function USBCDCParseHeaders(Device:PUSBDevice; Headers:PUSBCDCHeaders; Data:Pointer; Size:LongWord):LongWord;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Parse the extra data contained in a CDC interface and return pointers to the available headers</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! Device
 +
| The USB device the headers belong to
 +
|-
 +
! Headers
 +
| A pointer to the headers structure to be returned
 +
|-
 +
! Data
 +
| A pointer to the extra data from a CDC interface
 +
|-
 +
! Size
 +
| The size of the buffer pointed to by Data
 +
|-
 +
! Return
 +
| USB_STATUS_SUCCESS if completed or another error code on failure
 +
|-
 +
|}
 +
</div></div>
 +
<br />
  
 
Return to [[Unit_Reference|Unit Reference]]
 
Return to [[Unit_Reference|Unit Reference]]

Latest revision as of 06:19, 9 September 2021

Return to Unit Reference


Description

Ultibo USB CDC Interface unit

The USB Communications Device Class (CDC) standard defines the protocol for communicating with a range of network adapters, modems and ISDN devices. This unit provides common definitions and structures used in conjunction with CDC devices.

Constants


[Expand]
CDC specific constants USB_CDC_*_TYPE


[Expand]
CDC call management capabilities USB_CDC_CALL_MGMT_CAP_*


[Expand]
CDC abstract control model capabilities USB_CDC_ACM_*


[Expand]
CDC class specific control requests USB_CDC_*


[Expand]
CDC get/set line coding bCharFormat USB_CDC_*_STOP_BITS


[Expand]
CDC get/set line coding bParityType USB_CDC_*_PARITY


[Expand]
CDC set control line state wValue USB_CDC_ACM_CTRL_*


[Expand]
CDC set ethernet packet filter wValue USB_CDC_PACKET_TYPE_*


[Expand]
CDC class specific notifications USB_CDC_NOTIFY_*


[Expand]
CDC serial state notification data USB_CDC_ACM_CTRL_*


Type definitions


CDC descriptor

[Expand]

PUSBCDCDescriptor = ^TUSBCDCDescriptor;

TUSBCDCDescriptor = packed record

CDC header descriptor

[Expand]

PUSBCDCHeaderDescriptor = ^TUSBCDCHeaderDescriptor;

TUSBCDCHeaderDescriptor = packed record

CDC call management descriptor

[Expand]

PUSBCDCCallManagementDescriptor = ^TUSBCDCCallManagementDescriptor;

TUSBCDCCallManagementDescriptor = packed record

CDC abstract control management descriptor

[Expand]

PUSBCDCACMDescriptor = ^TUSBCDCACMDescriptor;

TUSBCDCACMDescriptor = packed record

CDC union descriptor

[Expand]

PUSBCDCUnionDescriptor = ^TUSBCDCUnionDescriptor;

TUSBCDCUnionDescriptor = packed record

CDC country descriptor

[Expand]

PUSBCDCCountryDescriptor = ^TUSBCDCCountryDescriptor;

TUSBCDCCountryDescriptor = packed record

CDC network terminal descriptor

[Expand]

PUSBCDCNetworkTerminalDescriptor = ^TUSBCDCNetworkTerminalDescriptor;

TUSBCDCNetworkTerminalDescriptor = packed record

CDC ethernet descriptor

[Expand]

PUSBCDCEthernetDescriptor = ^TUSBCDCEthernetDescriptor;

TUSBCDCEthernetDescriptor = packed record

CDC telephone control model descriptor

[Expand]

PUSBCDCTCMDescriptor = ^TUSBCDCTCMDescriptor;

TUSBCDCTCMDescriptor = packed record

CDC MDLM descriptor

[Expand]

PUSBCDCMDLMDescriptor = ^TUSBCDCMDLMDescriptor;

TUSBCDCMDLMDescriptor = packed record

CDC MDLM detail descriptor

[Expand]

PUSBCDCMDLMDetailDescriptor = ^TUSBCDCMDLMDetailDescriptor;

TUSBCDCMDLMDetailDescriptor = packed record

CDC OBEX descriptor

[Expand]

PUSBCDCOBEXDescriptor = ^TUSBCDCOBEXDescriptor;

TUSBCDCOBEXDescriptor = packed record

CDC NCM descriptor

[Expand]

PUSBCDCNCMDescriptor = ^TUSBCDCNCMDescriptor;

TUSBCDCNCMDescriptor = packed record

CDC MBIM descriptor

[Expand]

PUSBCDCMBIMDescriptor = ^TUSBCDCMBIMDescriptor;

TUSBCDCMBIMDescriptor = packed record

CDC MBIM extended descriptor

[Expand]

PUSBCDCMBIMExtendedDescriptor = ^TUSBCDCMBIMExtendedDescriptor;

TUSBCDCMBIMExtendedDescriptor = packed record

CDC line coding

[Expand]

PUSBCDCLineCoding = ^TUSBCDCLineCoding;

TUSBCDCLineCoding = packed record

CDC notification

[Expand]

PUSBCDCNotification = ^TUSBCDCNotification;

TUSBCDCNotification = packed record

CDC connection speed change

[Expand]

PUSBCDCSpeedChange = ^TUSBCDCSpeedChange;

TUSBCDCSpeedChange = packed record

CDC headers

[Expand]

PUSBCDCHeaders = ^TUSBCDCHeaders;

TUSBCDCHeaders = record


Public variables

None defined

Function declarations


CDC helper functions

[Expand] 
function USBCDCParseHeaders(Device:PUSBDevice; Headers:PUSBCDCHeaders; Data:Pointer; Size:LongWord):LongWord;
Description: Parse the extra data contained in a CDC interface and return pointers to the available headers


Return to Unit Reference

Retrieved from "https://ultibo.org/mediawiki_ultibo_org/index.php?title=Unit_USBCDC&oldid=5209"