usbd_desc.h File Reference

USB descriptors. More...

#include "os_port.h"

Go to the source code of this file.

Macros

#define USB_EP0   0
 
#define USB_EP1   1
 
#define USB_EP2   2
 
#define USB_EP3   3
 
#define USB_DIR_MASK   0x80
 
#define USB_DIR_OUT   0x00
 
#define USB_DIR_IN   0x80
 
#define USB_EP0_MAX_PACKET_SIZE   64
 
#define USB_EP1_MAX_PACKET_SIZE   64
 
#define USB_EP2_MAX_PACKET_SIZE   64
 
#define USB_EP3_MAX_PACKET_SIZE   64
 
#define USB_SELF_POWERED   0xC0
 
#define USB_BUS_POWERED   0x80
 
#define USB_REMOTE_WAKEUP   0xA0
 
#define USB_NO_REMOTE_WAKEUP   0x80
 
#define USB_ENDPOINT_TYPE_MASK   0x03
 
#define USB_ENDPOINT_TYPE_CONTROL   0x00
 
#define USB_ENDPOINT_TYPE_ISOCHRONOUS   0x01
 
#define USB_ENDPOINT_TYPE_BULK   0x02
 
#define USB_ENDPOINT_TYPE_INTERRUPT   0x03
 
#define USB_DEVICE_CLASS_CDC   0x02
 
#define USB_DEVICE_SUBCLASS_CDC   0x00
 
#define USB_DEVICE_PROTOCOL_CDC   0x00
 
#define CDC_INTERFACE_CLASS_COMMUNICATION   0x02
 
#define CDC_INTERFACE_CLASS_RNDIS   0xEF
 
#define CDC_INTERFACE_SUBCLASS_ACM   0x02
 
#define CDC_INTERFACE_SUBCLASS_RNDIS   0x04
 
#define CDC_INTERFACE_PROTOCOL_RNDIS   0x01
 
#define CDC_INTERFACE_PROTOCOL_VENDOR_SPECIFIC   0xFF
 
#define CDC_INTERFACE_CLASS_DATA   0x0A
 
#define CDC_INTERFACE_SUBCLASS_DATA   0x00
 
#define CDC_INTERFACE_PROTOCOL_DATA   0x00
 
#define CDC_CS_INTERFACE   0x24
 
#define CDC_CS_ENDPOINT   0x25
 
#define CDC_HEADER_DESC_SUBTYPE   0x00
 
#define CDC_CALL_MANAGEMENT_DESC_SUBTYPE   0x01
 
#define CDC_ACM_DESC_SUBTYPE   0x02
 
#define CDC_UNION_DESC_SUBTYPE   0x06
 

Typedefs

struct {
   char_t   type
 
   uint32_t   dataStart
 
   uint32_t   dataLength
 
   uint8_t   nameLength
 
   char_t   name []
 
   uint8_t   tokenLen: 4
 
   uint8_t   type: 2
 
   uint8_t   version: 2
 
   uint8_t   code
 
   uint16_t   mid
 
   uint8_t   token []
 
   union {
      uint8_t   b [6]
 
      uint16_t   w [3]
 
   } 
 
   uint16_t   srcPort
 
   uint16_t   destPort
 
   uint32_t   seqNum
 
   uint32_t   ackNum
 
   uint8_t   reserved1: 4
 
   uint8_t   dataOffset: 4
 
   uint8_t   flags: 6
 
   uint8_t   reserved2: 2
 
   uint16_t   window
 
   uint16_t   checksum
 
   uint16_t   urgentPointer
 
   uint8_t   options []
 
   uint16_t   length
 
   uint8_t   data []
 
   uint8_t   op
 
   uint8_t   htype
 
   uint8_t   hlen
 
   uint8_t   hops
 
   uint32_t   xid
 
   uint16_t   secs
 
   uint16_t   flags
 
   Ipv4Addr   ciaddr
 
   Ipv4Addr   yiaddr
 
   Ipv4Addr   siaddr
 
   Ipv4Addr   giaddr
 
   MacAddr   chaddr
 
   uint8_t   unused [10]
 
   uint8_t   sname [64]
 
   uint8_t   file [128]
 
   uint32_t   magicCookie
 
   uint16_t   type
 
   uint16_t   hardwareType
 
   uint32_t   time
 
   MacAddr   linkLayerAddr
 
   uint16_t   id
 
   uint8_t   rd: 1
 
   uint8_t   tc: 1
 
   uint8_t   aa: 1
 
   uint8_t   opcode: 4
 
   uint8_t   qr: 1
 
   uint8_t   rcode: 4
 
   uint8_t   z: 3
 
   uint8_t   ra: 1
 
   uint16_t   qdcount
 
   uint16_t   ancount
 
   uint16_t   nscount
 
   uint16_t   arcount
 
   uint8_t   questions []
 
   uint16_t   controlWord
 
   uint16_t   byteCount
 
   uint8_t   bLength
 
   uint8_t   bDescriptorType
 
   uint16_t   bcdUsb
 
   uint8_t   bDeviceClass
 
   uint8_t   bDeviceSubClass
 
   uint8_t   bDeviceProtocol
 
   uint8_t   bMaxPacketSize0
 
   uint16_t   idVendor
 
   uint16_t   idProduct
 
   uint16_t   bcdDevice
 
   uint8_t   iManufacturer
 
   uint8_t   iProduct
 
   uint8_t   iSerialNumber
 
   uint8_t   bNumConfigurations
 
   uint8_t   maxRespTime
 
   Ipv4Addr   groupAddr
 
   uint16_t   hrd
 
   uint16_t   pro
 
   uint8_t   hln
 
   uint8_t   pln
 
   uint16_t   op
 
   MacAddr   sha
 
   Ipv4Addr   spa
 
   MacAddr   tha
 
   Ipv4Addr   tpa
 
   uint8_t   length
 
   uint8_t   value []
 
   uint16_t   first
 
   uint16_t   last
 
   uint16_t   next
 
   union {
      uint8_t   b [16]
 
      uint16_t   w [8]
 
      uint32_t   dw [4]
 
   } 
 
   uint16_t   maxRespDelay
 
   uint16_t   reserved
 
   Ipv6Addr   multicastAddr
 
   uint32_t   reserved
 
   uint16_t   pvid
 
   uint8_t   autoNegSupportStatus
 
   uint16_t   pmdAutoNegAdvCap
 
   uint16_t   operationalMauType
 
   uint16_t   capabilities
 
   uint8_t   deviceType
 
   uint8_t   lengthH: 1
 
   uint8_t   lengthL
 
   uint8_t   t: 1
 
   uint8_t   c: 1
 
   union {
      int32_t   integer
 
      uint8_t   octetString [1]
 
      uint8_t   oid [1]
 
      uint8_t   ipAddr [4]
 
      uint32_t   counter32
 
      uint32_t   gauge32
 
      uint32_t   unsigned32
 
      uint32_t   timeTicks
 
      uint64_t   counter64
 
   } 
 
   uint16_t   transactionId
 
   uint16_t   protocolId
 
   uint8_t   unitId
 
   uint8_t   pdu []
 
   uint8_t   retain: 1
 
   uint8_t   qos: 2
 
   uint8_t   dup: 1
 
   union {
      uint8_t   all
 
      struct {
         uint8_t   topicIdType: 2
 
         uint8_t   cleanSession: 1
 
         uint8_t   will: 1
 
         uint8_t   retain: 1
 
         uint8_t   qos: 2
 
         uint8_t   dup: 1
 
      } 
 
   } 
 
   uint8_t   b: 1
 
   uint8_t   identifier
 
   uint8_t   valueSize
 
   Ipv4Addr   srcIpAddr
 
   Ipv4Addr   destIpAddr
 
   Eui64   interfaceId
 
   uint16_t   mru
 
   uint8_t   peerIdLength
 
   uint8_t   peerId []
 
   uint32_t   seconds
 
   uint32_t   fraction
 
   uint16_t   opcode
 
   char_t   filename []
 
   uint8_t   reserved: 3
 
   uint8_t   fin: 1
 
   uint8_t   payloadLen: 7
 
   uint8_t   mask: 1
 
   uint8_t   extPayloadLen []
 
   uint32_t   length
 
   uint8_t   payload []
 
   uint32_t   packetLen
 
   uint8_t   paddingLen
 
   uint8_t   protocolVersionId
 
   uint8_t   bpduType
 
   StpBridgeId   rootId
 
   uint32_t   rootPathCost
 
   StpBridgeId   bridgeId
 
   uint16_t   portId
 
   uint16_t   messageAge
 
   uint16_t   maxAge
 
   uint16_t   helloTime
 
   uint16_t   forwardDelay
 
   uint8_t   version1Length
 
   uint16_t   priority
 
   MacAddr   addr
 
UsbDeviceDescriptor
 Device descriptor. More...
 
struct {
   char_t   type
 
   uint32_t   dataStart
 
   uint32_t   dataLength
 
   uint8_t   nameLength
 
   uint8_t   length: 4
 
   uint8_t   delta: 4
 
   union {
      uint8_t   b [8]
 
      uint16_t   w [4]
 
      uint32_t   dw [2]
 
   } 
 
   uint8_t   kind
 
   uint8_t   value []
 
   uint8_t   code
 
   uint16_t   type
 
   uint32_t   enterpriseNumber
 
   uint8_t   identifier []
 
   uint16_t   qtype
 
   uint16_t   qclass
 
   uint16_t   statusWord
 
   uint16_t   byteCount
 
   uint8_t   bLength
 
   uint8_t   bDescriptorType
 
   uint16_t   wTotalLength
 
   uint8_t   bNumInterfaces
 
   uint8_t   bConfigurationValue
 
   uint8_t   iConfiguration
 
   uint8_t   bmAttributes
 
   uint8_t   bMaxPower
 
   uint8_t   type
 
   uint16_t   checksum
 
   uint8_t   parameter
 
   uint8_t   unused [3]
 
   uint8_t   data []
 
   uint32_t   parameter
 
   uint8_t   nextHeader
 
   uint8_t   hdrExtLen
 
   uint8_t   options []
 
   uint8_t   curHopLimit
 
   uint8_t   reserved: 2
 
   uint8_t   p: 1
 
   uint8_t   prf: 2
 
   uint8_t   h: 1
 
   uint8_t   o: 1
 
   uint8_t   m: 1
 
   uint16_t   routerLifetime
 
   uint32_t   reachableTime
 
   uint32_t   retransTimer
 
   uint8_t   flags
 
   uint16_t   ppvid
 
   uint8_t   mdiPowerSupport
 
   uint8_t   psePowerPair
 
   uint8_t   powerClass
 
   uint8_t   appType
 
   uint8_t   vlanIdH: 5
 
   uint8_t   x: 1
 
   uint8_t   t: 1
 
   uint8_t   u: 1
 
   uint8_t   l2PriorityH: 1
 
   uint8_t   vlanIdL: 7
 
   uint8_t   dscpValue: 6
 
   uint8_t   l2PriorityL: 2
 
   uint8_t   chassisIdSubtype
 
   uint8_t   chassisId []
 
   uint8_t   functionCode
 
   uint16_t   startingAddr
 
   uint16_t   quantityOfCoils
 
   uint16_t   length
 
   uint8_t   msgType
 
   uint16_t   flags
 
   Ipv4Addr   addr
 
   uint8_t   valueSize
 
   uint16_t   protocol
 
   uint32_t   accm
 
   uint8_t   msgLength
 
   uint8_t   message []
 
   uint8_t   mode: 3
 
   uint8_t   vn: 3
 
   uint8_t   li: 2
 
   uint8_t   stratum
 
   uint8_t   poll
 
   int8_t   precision
 
   uint32_t   rootDelay
 
   uint32_t   rootDispersion
 
   uint32_t   referenceId
 
   NtpTimestamp   referenceTimestamp
 
   NtpTimestamp   originateTimestamp
 
   NtpTimestamp   receiveTimestamp
 
   NtpTimestamp   transmitTimestamp
 
   uint16_t   opcode
 
   char_t   filename []
 
   uint16_t   value []
 
   uint16_t   group
 
   uint8_t   keyExchange []
 
   uint32_t   id
 
   uint32_t   dataLen
 
UsbConfigDescriptor
 Configuration descriptor. More...
 
struct {
   uint32_t   totalSize
 
   ResRootEntry   rootEntry
 
   MacAddr   destAddr
 
   MacAddr   srcAddr
 
   uint16_t   type
 
   uint8_t   data []
 
   uint16_t   hardwareType
 
   MacAddr   linkLayerAddr
 
   uint16_t   rtype
 
   uint16_t   rclass
 
   uint32_t   ttl
 
   uint16_t   rdlength
 
   uint8_t   rdata []
 
   uint8_t   bLength
 
   uint8_t   bDescriptorType
 
   uint8_t   bInterfaceNumber
 
   uint8_t   bAlternateSetting
 
   uint8_t   bNumEndpoints
 
   uint8_t   bInterfaceClass
 
   uint8_t   bInterfaceSubClass
 
   uint8_t   bInterfaceProtocol
 
   uint8_t   iInterface
 
   uint8_t   type
 
   uint8_t   code
 
   uint16_t   checksum
 
   uint32_t   unused
 
   uint8_t   nextHeader
 
   uint8_t   hdrExtLen
 
   uint8_t   options []
 
   uint32_t   reserved
 
   Ipv6Addr   targetAddr
 
   uint16_t   vlanId
 
   uint8_t   vlanNameLen
 
   char_t   vlanName []
 
   uint8_t   aggregationStatus
 
   uint32_t   aggregatedPortId
 
   uint8_t   locationDataFormat
 
   uint8_t   locationId []
 
   uint8_t   portIdSubtype
 
   uint8_t   portId []
 
   uint8_t   functionCode
 
   uint8_t   byteCount
 
   uint8_t   coilStatus []
 
   uint8_t   prefix
 
   uint16_t   length
 
   uint8_t   msgType
 
   uint8_t   identifier
 
   uint8_t   message []
 
   uint8_t   length
 
   Ipv4Addr   ipAddr
 
   uint16_t   protocol
 
   uint8_t   msgLength
 
   uint8_t   rejectedPacket []
 
   uint32_t   keyId
 
   uint8_t   messageDigest [16]
 
   uint16_t   opcode
 
   uint16_t   block
 
   uint16_t   value []
 
   uint8_t   value []
 
UsbInterfaceDescriptor
 Interface descriptor. More...
 
struct {
   uint8_t   dsap
 
   uint8_t   ssap
 
   uint8_t   control
 
   uint8_t   msgType
 
   uint8_t   transactionId [3]
 
   uint8_t   options []
 
   uint16_t   rtype
 
   uint16_t   rclass
 
   uint32_t   ttl
 
   uint16_t   rdlength
 
   uint8_t   rdata [4]
 
   uint8_t   bLength
 
   uint8_t   bDescriptorType
 
   uint8_t   bEndpointAddress
 
   uint8_t   bmAttributes
 
   uint16_t   wMaxPacketSize
 
   uint8_t   bInterval
 
   uint8_t   type
 
   uint8_t   code
 
   uint16_t   checksum
 
   uint32_t   unused
 
   uint8_t   data []
 
   uint32_t   mtu
 
   uint8_t   nextHeader
 
   uint8_t   hdrExtLen
 
   uint8_t   routingType
 
   uint8_t   segmentsLeft
 
   uint32_t   reserved
 
   Ipv6Addr   address []
 
   uint8_t   reserved1: 5
 
   uint8_t   o: 1
 
   uint8_t   s: 1
 
   uint8_t   r: 1
 
   uint8_t   reserved2 [3]
 
   Ipv6Addr   targetAddr
 
   uint8_t   protocolIdLen
 
   uint8_t   protocolId []
 
   uint16_t   maxFrameSize
 
   uint8_t   powerPriority: 4
 
   uint8_t   powerSource: 2
 
   uint8_t   powerType: 2
 
   uint16_t   powerValue
 
   uint16_t   ttl
 
   uint8_t   functionCode
 
   uint16_t   startingAddr
 
   uint16_t   quantityOfInputs
 
   uint8_t   gwId
 
   uint16_t   duration
 
   uint8_t   identifier
 
   uint16_t   length
 
   uint8_t   message []
 
   uint8_t   length
 
   Ipv4Addr   ipAddr
 
   uint16_t   protocol
 
   uint16_t   rejectedProtocol
 
   uint8_t   rejectedInfo []
 
   uint16_t   opcode
 
   uint16_t   block
 
   uint16_t   version
 
   uint16_t   epoch
 
   DtlsSequenceNumber   seqNum
 
   uint8_t   hash
 
   uint8_t   signature
 
   uint8_t   value []
 
UsbEndpointDescriptor
 Endpoint descriptor. More...
 
struct {
   uint16_t   tci
 
   uint16_t   type
 
   uint8_t   msgType
 
   uint8_t   hopCount
 
   Ipv6Addr   linkAddress
 
   Ipv6Addr   peerAddress
 
   uint8_t   options []
 
   uint16_t   rtype
 
   uint16_t   rclass
 
   uint32_t   ttl
 
   uint16_t   rdlength
 
   uint8_t   rdata [16]
 
   uint8_t   bLength
 
   uint8_t   bDescriptorType
 
   uint16_t   bString []
 
   uint8_t   type
 
   uint8_t   code
 
   uint16_t   checksum
 
   uint8_t   pointer
 
   uint8_t   unused [3]
 
   uint8_t   data []
 
   uint32_t   unused
 
   uint8_t   nextHeader
 
   uint8_t   payloadLen
 
   uint16_t   reserved
 
   uint32_t   securityParamIndex
 
   uint32_t   sequenceNumber
 
   uint8_t   authData []
 
   uint32_t   reserved
 
   Ipv6Addr   targetAddr
 
   Ipv6Addr   destAddr
 
   uint8_t   measurements [20]
 
   uint16_t   psePowerPriceIndex
 
   uint16_t   supportedCap
 
   uint16_t   enabledCap
 
   uint8_t   functionCode
 
   uint8_t   byteCount
 
   uint8_t   inputStatus []
 
   uint8_t   radius
 
   uint8_t   length
 
   Ipv4Addr   ipAddr
 
   uint32_t   magicNumber
 
   uint8_t   identifier
 
   uint16_t   length
 
   uint16_t   opcode
 
   uint16_t   errorCode
 
   char_t   errorMsg []
 
   uint16_t   msgSeq
 
   uint8_t   fragOffset [3]
 
   uint8_t   fragLength [3]
 
   TlsSignHashAlgo   value []
 
   uint8_t   value []
 
UsbStringDescriptor
 String descriptor. More...
 
struct {
   uint16_t   code
 
   uint16_t   length
 
   uint8_t   value []
 
   uint16_t   rtype
 
   uint16_t   rclass
 
   uint32_t   ttl
 
   uint16_t   rdlength
 
   uint16_t   priority
 
   uint16_t   weight
 
   uint16_t   port
 
   uint8_t   target []
 
   uint8_t   bFunctionLength
 
   uint8_t   bDescriptorType
 
   uint8_t   bDescriptorSubtype
 
   uint16_t   bcdCdc
 
   uint8_t   type
 
   uint8_t   code
 
   uint16_t   checksum
 
   uint16_t   identifier
 
   uint16_t   sequenceNumber
 
   uint8_t   data []
 
   uint32_t   pointer
 
   uint32_t   securityParamIndex
 
   uint32_t   sequenceNumber
 
   uint8_t   payloadData []
 
   uint8_t   length
 
   uint8_t   powerPriority: 2
 
   uint8_t   pd4pid: 1
 
   uint8_t   reserved: 1
 
   uint8_t   powerSource: 2
 
   uint8_t   powerType: 2
 
   uint16_t   pdRequestedPower
 
   uint16_t   pseAllocatedPower
 
   uint8_t   mgmtAddrLen
 
   uint8_t   mgmtAddrSubtype
 
   uint8_t   mgmtAddr []
 
   uint8_t   functionCode
 
   uint16_t   startingAddr
 
   uint16_t   quantityOfRegs
 
   uint8_t   gwId
 
   uint8_t   gwAdd []
 
   Ipv4Addr   ipAddr
 
   uint8_t   identifier
 
   uint32_t   magicNumber
 
   uint16_t   serverVersion
 
   uint8_t   cookieLength
 
   uint8_t   cookie []
 
CdcHeaderDescriptor
 CDC header functional descriptor. More...
 
struct {
   uint32_t   iaId
 
   uint32_t   t1
 
   uint32_t   t2
 
   uint8_t   options []
 
   uint8_t   bFunctionLength
 
   uint8_t   bDescriptorType
 
   uint8_t   bDescriptorSubtype
 
   uint8_t   bmCapabilities
 
   uint8_t   bDataInterface
 
   uint8_t   type
 
   uint8_t   code
 
   uint16_t   checksum
 
   uint16_t   identifier
 
   uint16_t   sequenceNumber
 
   uint8_t   data []
 
   uint8_t   length
 
   MacAddr   linkLayerAddr
 
   uint16_t   pdRequestedPowerA
 
   uint16_t   pdRequestedPowerB
 
   uint16_t   pseAllocatedPowerA
 
   uint16_t   pseAllocatedPowerB
 
   uint16_t   powerStatus
 
   uint8_t   systemSetup
 
   uint16_t   pseMaxAvailablePower
 
   uint8_t   autoclass
 
   uint8_t   powerDown [3]
 
   uint8_t   ifNumSubtype
 
   uint32_t   ifNum
 
   uint8_t   oidLen
 
   uint8_t   oid []
 
   uint8_t   functionCode
 
   uint8_t   byteCount
 
   uint16_t   regValue []
 
   MqttSnFlags   flags
 
   uint8_t   protocolId
 
   uint16_t   duration
 
   char_t   clientId []
 
   Ipv4Addr   ipAddr
 
   uint16_t   length
 
   uint8_t   value []
 
CdcCallManagementDescriptor
 CDC call management functional descriptor. More...
 
struct {
   uint32_t   iaId
 
   uint8_t   options []
 
   uint8_t   bFunctionLength
 
   uint8_t   bDescriptorType
 
   uint8_t   bDescriptorSubtype
 
   uint8_t   bmCapabilities
 
   uint8_t   type
 
   uint8_t   length
 
   uint8_t   prefixLength
 
   uint8_t   reserved1: 5
 
   uint8_t   r: 1
 
   uint8_t   a: 1
 
   uint8_t   l: 1
 
   uint32_t   validLifetime
 
   uint32_t   preferredLifetime
 
   uint32_t   reserved2
 
   Ipv6Addr   prefix
 
   uint8_t   oui [LLDP_OUI_SIZE]
 
   uint8_t   subtype
 
   uint8_t   value []
 
   uint8_t   functionCode
 
   uint16_t   startingAddr
 
   uint16_t   quantityOfRegs
 
   uint8_t   returnCode
 
   uint16_t   type
 
   uint16_t   length
 
CdcAcmDescriptor
 CDC abstract control management functional descriptor. More...
 
struct {
   Ipv6Addr   address
 
   uint32_t   preferredLifetime
 
   uint32_t   validLifetime
 
   uint8_t   options []
 
   uint8_t   bFunctionLength
 
   uint8_t   bDescriptorType
 
   uint8_t   bDescriptorSubtype
 
   uint8_t   bMasterInterface
 
   uint8_t   bSlaveInterface0
 
   uint8_t   type
 
   uint8_t   length
 
   uint16_t   reserved1
 
   uint32_t   reserved2
 
   uint8_t   ipPacket []
 
   uint8_t   functionCode
 
   uint8_t   byteCount
 
   uint16_t   regValue []
 
   MqttSnFlags   flags
 
   char_t   willTopic []
 
   uint16_t   length
 
   uint8_t   value []
 
CdcUnionDescriptor
 CDC union functional descriptor. More...
 
struct {
   uint16_t   requestedOption [1]
 
   UsbConfigDescriptor   configDescriptor
 
   UsbInterfaceDescriptor   communicationInterfaceDescriptor
 
   CdcHeaderDescriptor   cdcHeaderDescriptor
 
   CdcCallManagementDescriptor   cdcCallManagementDescriptor
 
   CdcAcmDescriptor   cdcAcmDescriptor
 
   CdcUnionDescriptor   cdcUnionDescriptor
 
   UsbEndpointDescriptor   notificationEndpointDescriptor
 
   UsbInterfaceDescriptor   dataInterfaceDescriptor
 
   UsbEndpointDescriptor   dataOutEndpointDescriptor
 
   UsbEndpointDescriptor   dataInEndpointDescriptor
 
   uint8_t   type
 
   uint8_t   length
 
   uint16_t   reserved
 
   uint32_t   mtu
 
   uint8_t   functionCode
 
   uint16_t   outputAddr
 
   uint16_t   outputValue
 
   uint16_t   topicId
 
   uint16_t   msgId
 
   char_t   topicName []
 
   uint16_t   value []
 
   uint16_t   algorithm
 
   uint16_t   length
 
   uint8_t   value []
 
UsbConfigDescriptors
 Configuration descriptors. More...
 

Functions

uint8_t * usbdGetDeviceDescriptor (USBD_SpeedTypeDef speed, uint16_t *length)
 Retrieve device descriptor. More...
 
uint8_t * usbdGetLangIdStrDescriptor (USBD_SpeedTypeDef speed, uint16_t *length)
 Retrieve the languages supported by the device. More...
 
uint8_t * usbdGetManufacturerStrDescriptor (USBD_SpeedTypeDef speed, uint16_t *length)
 Retrieve the manufacturer string descriptor. More...
 
uint8_t * usbdGetProductStrDescriptor (USBD_SpeedTypeDef speed, uint16_t *length)
 Retrieve the product string descriptor. More...
 
uint8_t * usbdGetSerialStrDescriptor (USBD_SpeedTypeDef speed, uint16_t *length)
 Retrieve the serial number string descriptor. More...
 
uint8_t * usbdGetConfigStrDescriptor (USBD_SpeedTypeDef speed, uint16_t *length)
 Retrieve the configuration string descriptor. More...
 
uint8_t * usbdGetInterfaceStrDescriptor (USBD_SpeedTypeDef speed, uint16_t *length)
 Retrieve the interface string descriptor. More...
 

Variables

USBD_DescriptorsTypeDef usbdRndisDescriptors
 USB descriptors. More...
 
const UsbDeviceDescriptor usbdDeviceDescriptor
 USB device descriptor. More...
 
const UsbConfigDescriptors usbdConfigDescriptors
 USB configuration descriptors. More...
 

Detailed Description

USB descriptors.

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2010-2022 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneTCP Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author
Oryx Embedded SARL (www.oryx-embedded.com)
Version
2.1.6

Definition in file usbd_desc.h.

Macro Definition Documentation

◆ CDC_ACM_DESC_SUBTYPE

#define CDC_ACM_DESC_SUBTYPE   0x02

Definition at line 98 of file usbd_desc.h.

◆ CDC_CALL_MANAGEMENT_DESC_SUBTYPE

#define CDC_CALL_MANAGEMENT_DESC_SUBTYPE   0x01

Definition at line 97 of file usbd_desc.h.

◆ CDC_CS_ENDPOINT

#define CDC_CS_ENDPOINT   0x25

Definition at line 93 of file usbd_desc.h.

◆ CDC_CS_INTERFACE

#define CDC_CS_INTERFACE   0x24

Definition at line 92 of file usbd_desc.h.

◆ CDC_HEADER_DESC_SUBTYPE

#define CDC_HEADER_DESC_SUBTYPE   0x00

Definition at line 96 of file usbd_desc.h.

◆ CDC_INTERFACE_CLASS_COMMUNICATION

#define CDC_INTERFACE_CLASS_COMMUNICATION   0x02

Definition at line 75 of file usbd_desc.h.

◆ CDC_INTERFACE_CLASS_DATA

#define CDC_INTERFACE_CLASS_DATA   0x0A

Definition at line 85 of file usbd_desc.h.

◆ CDC_INTERFACE_CLASS_RNDIS

#define CDC_INTERFACE_CLASS_RNDIS   0xEF

Definition at line 76 of file usbd_desc.h.

◆ CDC_INTERFACE_PROTOCOL_DATA

#define CDC_INTERFACE_PROTOCOL_DATA   0x00

Definition at line 89 of file usbd_desc.h.

◆ CDC_INTERFACE_PROTOCOL_RNDIS

#define CDC_INTERFACE_PROTOCOL_RNDIS   0x01

Definition at line 81 of file usbd_desc.h.

◆ CDC_INTERFACE_PROTOCOL_VENDOR_SPECIFIC

#define CDC_INTERFACE_PROTOCOL_VENDOR_SPECIFIC   0xFF

Definition at line 82 of file usbd_desc.h.

◆ CDC_INTERFACE_SUBCLASS_ACM

#define CDC_INTERFACE_SUBCLASS_ACM   0x02

Definition at line 78 of file usbd_desc.h.

◆ CDC_INTERFACE_SUBCLASS_DATA

#define CDC_INTERFACE_SUBCLASS_DATA   0x00

Definition at line 87 of file usbd_desc.h.

◆ CDC_INTERFACE_SUBCLASS_RNDIS

#define CDC_INTERFACE_SUBCLASS_RNDIS   0x04

Definition at line 79 of file usbd_desc.h.

◆ CDC_UNION_DESC_SUBTYPE

#define CDC_UNION_DESC_SUBTYPE   0x06

Definition at line 99 of file usbd_desc.h.

◆ USB_BUS_POWERED

#define USB_BUS_POWERED   0x80

Definition at line 56 of file usbd_desc.h.

◆ USB_DEVICE_CLASS_CDC

#define USB_DEVICE_CLASS_CDC   0x02

Definition at line 68 of file usbd_desc.h.

◆ USB_DEVICE_PROTOCOL_CDC

#define USB_DEVICE_PROTOCOL_CDC   0x00

Definition at line 72 of file usbd_desc.h.

◆ USB_DEVICE_SUBCLASS_CDC

#define USB_DEVICE_SUBCLASS_CDC   0x00

Definition at line 70 of file usbd_desc.h.

◆ USB_DIR_IN

#define USB_DIR_IN   0x80

Definition at line 46 of file usbd_desc.h.

◆ USB_DIR_MASK

#define USB_DIR_MASK   0x80

Definition at line 44 of file usbd_desc.h.

◆ USB_DIR_OUT

#define USB_DIR_OUT   0x00

Definition at line 45 of file usbd_desc.h.

◆ USB_ENDPOINT_TYPE_BULK

#define USB_ENDPOINT_TYPE_BULK   0x02

Definition at line 64 of file usbd_desc.h.

◆ USB_ENDPOINT_TYPE_CONTROL

#define USB_ENDPOINT_TYPE_CONTROL   0x00

Definition at line 62 of file usbd_desc.h.

◆ USB_ENDPOINT_TYPE_INTERRUPT

#define USB_ENDPOINT_TYPE_INTERRUPT   0x03

Definition at line 65 of file usbd_desc.h.

◆ USB_ENDPOINT_TYPE_ISOCHRONOUS

#define USB_ENDPOINT_TYPE_ISOCHRONOUS   0x01

Definition at line 63 of file usbd_desc.h.

◆ USB_ENDPOINT_TYPE_MASK

#define USB_ENDPOINT_TYPE_MASK   0x03

Definition at line 61 of file usbd_desc.h.

◆ USB_EP0

#define USB_EP0   0

Definition at line 38 of file usbd_desc.h.

◆ USB_EP0_MAX_PACKET_SIZE

#define USB_EP0_MAX_PACKET_SIZE   64

Definition at line 49 of file usbd_desc.h.

◆ USB_EP1

#define USB_EP1   1

Definition at line 39 of file usbd_desc.h.

◆ USB_EP1_MAX_PACKET_SIZE

#define USB_EP1_MAX_PACKET_SIZE   64

Definition at line 50 of file usbd_desc.h.

◆ USB_EP2

#define USB_EP2   2

Definition at line 40 of file usbd_desc.h.

◆ USB_EP2_MAX_PACKET_SIZE

#define USB_EP2_MAX_PACKET_SIZE   64

Definition at line 51 of file usbd_desc.h.

◆ USB_EP3

#define USB_EP3   3

Definition at line 41 of file usbd_desc.h.

◆ USB_EP3_MAX_PACKET_SIZE

#define USB_EP3_MAX_PACKET_SIZE   64

Definition at line 52 of file usbd_desc.h.

◆ USB_NO_REMOTE_WAKEUP

#define USB_NO_REMOTE_WAKEUP   0x80

Definition at line 58 of file usbd_desc.h.

◆ USB_REMOTE_WAKEUP

#define USB_REMOTE_WAKEUP   0xA0

Definition at line 57 of file usbd_desc.h.

◆ USB_SELF_POWERED

#define USB_SELF_POWERED   0xC0

Definition at line 55 of file usbd_desc.h.

Typedef Documentation

◆ CdcAcmDescriptor

typedef { ... } CdcAcmDescriptor

CDC abstract control management functional descriptor.

◆ CdcCallManagementDescriptor

typedef { ... } CdcCallManagementDescriptor

CDC call management functional descriptor.

◆ CdcHeaderDescriptor

typedef { ... } CdcHeaderDescriptor

CDC header functional descriptor.

◆ CdcUnionDescriptor

typedef { ... } CdcUnionDescriptor

CDC union functional descriptor.

◆ UsbConfigDescriptor

typedef { ... } UsbConfigDescriptor

Configuration descriptor.

◆ UsbConfigDescriptors

typedef { ... } UsbConfigDescriptors

Configuration descriptors.

◆ UsbDeviceDescriptor

typedef { ... } UsbDeviceDescriptor

Device descriptor.

◆ UsbEndpointDescriptor

typedef { ... } UsbEndpointDescriptor

Endpoint descriptor.

◆ UsbInterfaceDescriptor

typedef { ... } UsbInterfaceDescriptor

Interface descriptor.

◆ UsbStringDescriptor

typedef { ... } UsbStringDescriptor

String descriptor.

Function Documentation

◆ usbdGetConfigStrDescriptor()

uint8_t* usbdGetConfigStrDescriptor ( USBD_SpeedTypeDef  speed,
uint16_t *  length 
)

Retrieve the configuration string descriptor.

Parameters
[in]speedCurrent speed
[out]lengthLength of the string descriptor, in bytes
Returns
Pointer to the string descriptor

Definition at line 301 of file usbd_desc.c.

◆ usbdGetDeviceDescriptor()

uint8_t* usbdGetDeviceDescriptor ( USBD_SpeedTypeDef  speed,
uint16_t *  length 
)

Retrieve device descriptor.

Parameters
[in]speedCurrent speed
[out]lengthLength of the device descriptor, in bytes
Returns
Pointer to the device descriptor

Definition at line 211 of file usbd_desc.c.

◆ usbdGetInterfaceStrDescriptor()

uint8_t* usbdGetInterfaceStrDescriptor ( USBD_SpeedTypeDef  speed,
uint16_t *  length 
)

Retrieve the interface string descriptor.

Parameters
[in]speedCurrent speed
[out]lengthLength of the string descriptor, in bytes
Returns
Pointer to the string descriptor

Definition at line 317 of file usbd_desc.c.

◆ usbdGetLangIdStrDescriptor()

uint8_t* usbdGetLangIdStrDescriptor ( USBD_SpeedTypeDef  speed,
uint16_t *  length 
)

Retrieve the languages supported by the device.

Parameters
[in]speedCurrent speed
[out]lengthLength of the string descriptor, in bytes
Returns
Pointer to the string descriptor

Definition at line 227 of file usbd_desc.c.

◆ usbdGetManufacturerStrDescriptor()

uint8_t* usbdGetManufacturerStrDescriptor ( USBD_SpeedTypeDef  speed,
uint16_t *  length 
)

Retrieve the manufacturer string descriptor.

Parameters
[in]speedCurrent speed
[out]lengthLength of the string descriptor, in bytes
Returns
Pointer to the string descriptor

Definition at line 253 of file usbd_desc.c.

◆ usbdGetProductStrDescriptor()

uint8_t* usbdGetProductStrDescriptor ( USBD_SpeedTypeDef  speed,
uint16_t *  length 
)

Retrieve the product string descriptor.

Parameters
[in]speedCurrent speed
[out]lengthLength of the string descriptor, in bytes
Returns
Pointer to the string descriptor

Definition at line 269 of file usbd_desc.c.

◆ usbdGetSerialStrDescriptor()

uint8_t* usbdGetSerialStrDescriptor ( USBD_SpeedTypeDef  speed,
uint16_t *  length 
)

Retrieve the serial number string descriptor.

Parameters
[in]speedCurrent speed
[out]lengthLength of the string descriptor, in bytes
Returns
Pointer to the string descriptor

Definition at line 285 of file usbd_desc.c.

Variable Documentation

◆ bAlternateSetting

uint8_t bAlternateSetting

Definition at line 151 of file usbd_desc.h.

◆ bcdCdc

uint16_t bcdCdc

Definition at line 196 of file usbd_desc.h.

◆ bcdDevice

uint16_t bcdDevice

Definition at line 117 of file usbd_desc.h.

◆ bcdUsb

uint16_t bcdUsb

Definition at line 110 of file usbd_desc.h.

◆ bConfigurationValue

uint8_t bConfigurationValue

Definition at line 135 of file usbd_desc.h.

◆ bDataInterface

uint8_t bDataInterface

Definition at line 210 of file usbd_desc.h.

◆ bDescriptorSubtype

uint8_t bDescriptorSubtype

Definition at line 195 of file usbd_desc.h.

◆ bDescriptorType

uint8_t bDescriptorType

Definition at line 109 of file usbd_desc.h.

◆ bDeviceClass

uint8_t bDeviceClass

Definition at line 111 of file usbd_desc.h.

◆ bDeviceProtocol

uint8_t bDeviceProtocol

Definition at line 113 of file usbd_desc.h.

◆ bDeviceSubClass

uint8_t bDeviceSubClass

Definition at line 112 of file usbd_desc.h.

◆ bEndpointAddress

uint8_t bEndpointAddress

Definition at line 168 of file usbd_desc.h.

◆ bFunctionLength

uint8_t bFunctionLength

Definition at line 193 of file usbd_desc.h.

◆ bInterfaceClass

uint8_t bInterfaceClass

Definition at line 153 of file usbd_desc.h.

◆ bInterfaceNumber

uint8_t bInterfaceNumber

Definition at line 150 of file usbd_desc.h.

◆ bInterfaceProtocol

uint8_t bInterfaceProtocol

Definition at line 155 of file usbd_desc.h.

◆ bInterfaceSubClass

uint8_t bInterfaceSubClass

Definition at line 154 of file usbd_desc.h.

◆ bInterval

uint8_t bInterval

Definition at line 171 of file usbd_desc.h.

◆ bLength

uint8_t bLength

Definition at line 108 of file usbd_desc.h.

◆ bMasterInterface

uint8_t bMasterInterface

Definition at line 236 of file usbd_desc.h.

◆ bmAttributes

uint8_t bmAttributes

Definition at line 137 of file usbd_desc.h.

◆ bMaxPacketSize0

uint8_t bMaxPacketSize0

Definition at line 114 of file usbd_desc.h.

◆ bMaxPower

uint8_t bMaxPower

Definition at line 138 of file usbd_desc.h.

◆ bmCapabilities

uint8_t bmCapabilities

Definition at line 209 of file usbd_desc.h.

◆ bNumConfigurations

uint8_t bNumConfigurations

Definition at line 121 of file usbd_desc.h.

◆ bNumEndpoints

uint8_t bNumEndpoints

Definition at line 152 of file usbd_desc.h.

◆ bNumInterfaces

uint8_t bNumInterfaces

Definition at line 134 of file usbd_desc.h.

◆ bSlaveInterface0

uint8_t bSlaveInterface0

Definition at line 237 of file usbd_desc.h.

◆ bString

uint16_t bString[]

Definition at line 183 of file usbd_desc.h.

◆ cdcAcmDescriptor

CdcAcmDescriptor cdcAcmDescriptor

Definition at line 256 of file usbd_desc.h.

◆ cdcCallManagementDescriptor

CdcCallManagementDescriptor cdcCallManagementDescriptor

Definition at line 254 of file usbd_desc.h.

◆ cdcHeaderDescriptor

CdcHeaderDescriptor cdcHeaderDescriptor

Definition at line 252 of file usbd_desc.h.

◆ cdcUnionDescriptor

CdcUnionDescriptor cdcUnionDescriptor

Definition at line 258 of file usbd_desc.h.

◆ communicationInterfaceDescriptor

UsbInterfaceDescriptor communicationInterfaceDescriptor

Definition at line 250 of file usbd_desc.h.

◆ configDescriptor

UsbConfigDescriptor configDescriptor

Definition at line 248 of file usbd_desc.h.

◆ dataInEndpointDescriptor

UsbEndpointDescriptor dataInEndpointDescriptor

Definition at line 266 of file usbd_desc.h.

◆ dataInterfaceDescriptor

UsbInterfaceDescriptor dataInterfaceDescriptor

Definition at line 262 of file usbd_desc.h.

◆ dataOutEndpointDescriptor

UsbEndpointDescriptor dataOutEndpointDescriptor

Definition at line 264 of file usbd_desc.h.

◆ iConfiguration

uint8_t iConfiguration

Definition at line 136 of file usbd_desc.h.

◆ idProduct

uint16_t idProduct

Definition at line 116 of file usbd_desc.h.

◆ idVendor

uint16_t idVendor

Definition at line 115 of file usbd_desc.h.

◆ iInterface

uint8_t iInterface

Definition at line 156 of file usbd_desc.h.

◆ iManufacturer

uint8_t iManufacturer

Definition at line 118 of file usbd_desc.h.

◆ iProduct

uint8_t iProduct

Definition at line 119 of file usbd_desc.h.

◆ iSerialNumber

uint8_t iSerialNumber

Definition at line 120 of file usbd_desc.h.

◆ notificationEndpointDescriptor

UsbEndpointDescriptor notificationEndpointDescriptor

Definition at line 260 of file usbd_desc.h.

◆ usbdConfigDescriptors

const UsbConfigDescriptors usbdConfigDescriptors
extern

USB configuration descriptors.

Definition at line 99 of file usbd_desc.c.

◆ usbdDeviceDescriptor

const UsbDeviceDescriptor usbdDeviceDescriptor
extern

USB device descriptor.

Definition at line 76 of file usbd_desc.c.

◆ usbdRndisDescriptors

USBD_DescriptorsTypeDef usbdRndisDescriptors
extern

USB descriptors.

Definition at line 61 of file usbd_desc.c.

◆ wMaxPacketSize

uint16_t wMaxPacketSize

Definition at line 170 of file usbd_desc.h.

◆ wTotalLength

uint16_t wTotalLength

Definition at line 133 of file usbd_desc.h.