usb_ddk_types.h
概述
提供USB DDK中的枚举变量、结构体定义与宏定义。
起始版本：
10
相关模块:
汇总
结构体
| 名称 | 描述 |
|---|---|
| UsbControlRequestSetup | 控制传输setup包，对应USB协议中的Setup Data。 |
| UsbDeviceDescriptor | 标准设备描述符，对应USB协议中Standard Device Descriptor。 |
| UsbConfigDescriptor | 标准配置描述符，对应USB协议中Standard Configuration Descriptor。 |
| UsbInterfaceDescriptor | 标准接口描述符，对应USB协议中Standard Interface Descriptor。 |
| UsbEndpointDescriptor | 标准端点描述符，对应USB协议中Standard Endpoint Descriptor。 |
| UsbDdkEndpointDescriptor | 端点描述符。 |
| UsbDdkInterfaceDescriptor | 接口描述符。 |
| UsbDdkInterface | USB接口，是特定接口下备用设置的集合。 |
| UsbDdkConfigDescriptor | 配置描述符。 |
| UsbRequestPipe | 请求管道。 |
| UsbDeviceMemMap | 设备内存映射，通过OH_Usb_CreateDeviceMemMap()创建设备内存映射，使用内存映射后的缓冲区，获得更好的性能。 |
类型定义
| 名称 | 描述 |
|---|---|
| UsbDdkEndpointDescriptor | 端点描述符。 |
| UsbDdkInterfaceDescriptor | 接口描述符。 |
| UsbDdkInterface | USB接口。 |
| UsbDdkConfigDescriptor | 配置描述符。 |
| UsbDeviceMemMap | 设备内存映射，通过OH_Usb_CreateDeviceMemMap()创建设备内存映射，使用内存映射后的缓冲区，获得更好的性能。 |
枚举
| 名称 | 描述 |
|---|---|
| UsbDdkErrCode { USB_DDK_SUCCESS = 0, USB_DDK_FAILED = -1, USB_DDK_INVALID_PARAMETER = -2, USB_DDK_MEMORY_ERROR = -3, USB_DDK_INVALID_OPERATION = -4, USB_DDK_NULL_PTR = -5, USB_DDK_DEVICE_BUSY = -6, USB_DDK_TIMEOUT = -7 } |
USB DDK 错误码定义。 |
变量
| 名称 | 描述 |
|---|---|
| bmRequestType | 请求类型。 |
| bRequest | 具体的请求。 |
| wValue | 具体的请求不同，其代表的含义不一样。 |
| wIndex | 具体的请求不同，其代表的含义不一样，通常用来传递索引或者偏移量。 |
| wLength | 如果有数据阶段的传输，其代表传输的字节个数。 |
| bLength | 该描述符的大小，单位为字节。 |
| bDescriptorType | 描述符类型。 |
| bcdUSB | USB协议发布号。 |
| bDeviceClass | 由USB标准化组织（USB-IF）分配的设备类代码。 |
| bDeviceSubClass | 由USB标准化组织（USB-IF）分配的子类代码，其值由bDeviceClass的值限定。 |
| bDeviceProtocol | 由USB标准化组织（USB-IF）分配的协议代码，其值由bDeviceClass和bDeviceSubClass的值限定。 |
| bMaxPacketSize0 | 端点零的最大包大小，只有8、16、32、64是合法的。 |
| idVendor | 由USB标准化组织（USB-IF）分配的厂商编号。 |
| idProduct | 由厂商分配的产品编号。 |
| bcdDevice | 设备发布编号。 |
| iManufacturer | 描述厂商的字符串描述符的索引。 |
| iProduct | 描述产品的字符串描述符的索引。 |
| iSerialNumber | 描述设备序列号的字符串描述符的索引。 |
| bNumConfigurations | 配置数量。 |
| wTotalLength | 该配置描述符的总长度，包含配置、接口、端点和特定于类或供应商的描述符。 |
| bNumInterfaces | 该配置所支持的接口数量。 |
| bConfigurationValue | 设置配置所需要的参数，用来选择当前配置。 |
| iConfiguration | 描述该配置的字符串描述符的索引。 |
| bmAttributes | 配置属性，包含供电模式、远程唤醒等配置。 |
| bMaxPower | 总线供电的USB设备的最大功耗，以2mA为单位。 |
| bInterfaceNumber | 接口编号。 |
| bAlternateSetting | 用来选择该接口的备用配置的值。 |
| bNumEndpoints | 该接口所使用的端点数量（不包括端点零）。 |
| bInterfaceClass | 由USB标准化组织（USB-IF）分配的设备类代码。 |
| bInterfaceSubClass | 由USB标准化组织（USB-IF）分配的子类代码，其值由bInterfaceClass的值限定。 |
| bInterfaceProtocol | 由USB标准化组织（USB-IF）分配的协议代码，其值由bInterfaceClass和bInterfaceSubClass的值限定。 |
| iInterface | 描述该接口的字符串描述符的索引。 |
| bEndpointAddress | 端点地址，包含端点编号以及端点方向。 |
| bmAttributes | 端点属性，包括传输类型、同步类型、使用类型。 |
| wMaxPacketSize | 该端点所能承载的最大包的大小。 |
| bInterval | 数据传输轮询端点的时间间隔。 |
| bRefresh | 用于音频类设备，同步反馈的速率。 |
| bSynchAddress | 用于音频类设备，同步端点的地址。 |
| interfaceHandle | 接口操作句柄。 |
| endpoint | 要通信的端点的地址。 |
| timeout | 超时时间，单位是毫秒。 |
变量说明
bAlternateSetting
uint8_t bAlternateSetting
描述:
用来选择该接口的备用配置的值。
bcdDevice
uint16_t bcdDevice
描述:
设备发布编号。
bcdUSB
uint16_t bcdUSB
描述:
USB协议发布号。
bConfigurationValue
uint8_t bConfigurationValue
描述:
设置配置所需要的参数，用来选择当前配置。
bDescriptorType
uint8_t bDescriptorType
描述:
描述符类型。
bDeviceClass
uint8_t bDeviceClass
描述:
由USB标准化组织（USB-IF）分配的设备类代码。
bDeviceProtocol
uint8_t bDeviceProtocol
描述:
由USB标准化组织（USB-IF）分配的协议代码，其值由bDeviceClass和bDeviceSubClass的值限定。
bDeviceSubClass
uint8_t bDeviceSubClass
描述:
由USB标准化组织（USB-IF）分配的子类代码，其值由bDeviceClass的值限定。
bEndpointAddress
uint8_t bEndpointAddress
描述:
端点地址，包含端点编号以及端点方向。
bmAttributes
uint8_t bmAttributes
描述:
端点属性，包括传输类型、同步类型、使用类型。
bInterfaceClass
uint8_t bInterfaceClass
描述:
由USB标准化组织（USB-IF）分配的设备类代码。
bInterfaceNumber
uint8_t bInterfaceNumber
描述:
接口编号。
bInterfaceProtocol
uint8_t bInterfaceProtocol
描述:
由USB标准化组织（USB-IF）分配的协议代码，其值由bInterfaceClass和bInterfaceSubClass的值限定。
bInterfaceSubClass
uint8_t bInterfaceSubClass
描述:
由USB标准化组织（USB-IF）分配的子类代码，其值由bInterfaceClass的值限定。
bInterval
uint8_t bInterval
描述:
数据传输轮询端点的时间间隔。
bLength
uint8_t bLength
描述:
该描述符的大小，单位为字节。
bmAttributes
uint8_t bmAttributes
描述:
配置属性，包含供电模式、远程唤醒等配置。
bMaxPacketSize0
uint8_t bMaxPacketSize0
描述:
端点零的最大包大小，只有8、16、32、64是合法的。
bMaxPower
uint8_t bMaxPower
描述:
总线供电的USB设备的最大功耗，以2mA为单位。
bNumConfigurations
uint8_t bNumConfigurations
描述:
配置数量。
bNumEndpoints
uint8_t bNumEndpoints
描述:
该接口所使用的端点数量（不包括端点零）。
bNumInterfaces
uint8_t bNumInterfaces
描述:
该配置所支持的接口数量。
bRefresh
uint8_t bRefresh
描述:
用于音频类设备，同步反馈的速率。
bSynchAddress
uint8_t bSynchAddress
描述:
用于音频类设备，同步端点的地址。
endpoint
uint8_t endpoint
描述:
要通信的端点的地址。
iConfiguration
uint8_t iConfiguration
描述:
描述该配置的字符串描述符的索引。
idProduct
uint16_t idProduct
描述:
由厂商分配的产品编号。
idVendor
uint16_t idVendor
描述:
由USB标准化组织（USB-IF）分配的厂商编号。
iInterface
uint8_t iInterface
描述:
描述该接口的字符串描述符的索引。
iManufacturer
uint8_t iManufacturer
描述:
描述厂商的字符串描述符的索引。
wIndex
uint16_t wIndex
描述:
具体的请求不同，其代表的含义不一样，通常用来传递索引或者偏移量。
interfaceHandle
uint64_t interfaceHandle
描述:
接口操作句柄。
iProduct
uint8_t iProduct
描述:
描述产品的字符串描述符的索引。
iSerialNumber
uint8_t iSerialNumber
描述:
描述设备序列号的字符串描述符的索引。
wLength
uint16_t wLength
描述:
如果有数据阶段的传输，其代表传输的字节个数。
bRequest
uint8_t bRequest
描述:
具体的请求。
bmRequestType
uint8_t bmRequestType
描述:
请求类型。
timeout
uint32_t timeout
描述:
超时时间，单位是毫秒。
wValue
uint16_t wValue
描述:
具体的请求不同，其代表的含义不一样。
wMaxPacketSize
uint16_t wMaxPacketSize
描述:
该端点所能承载的最大包的大小。
wTotalLength
uint16_t wTotalLength
描述:
该配置描述符的总长度，包含配置、接口、端点和特定于类或供应商的描述符。