Skip to content

D
Docs

OpenHarmony / Docs
12 个月 前同步成功

通知 159
Star 292
Fork 28
D
Docs

体验新版 GitCode，发现更多精彩内容 >>

提交 4ee3ceaf 编写于 作者: W wuchengwen
浏览文件
操作

feature:add usb ddk 

Signed-off-by: Nwuchengwen <wuchengwen4@huawei.com>
上级 4568ec45
隐藏空白更改
内联 并排
Showing with 2329 addition and 0 deletion
zh-cn/application-dev/napi/Readme-CN.md
浏览文件 @ 4ee3ceaf
......@@ -17,3 +17,5 @@
- [Neural Network Runtime对接AI推理框架开发指导](neural-network-runtime-guidelines.md)
- 内存管理
- [Purgeable memory开发指导](purgeable-memory-guidelines.md)
- 设备管理
- [USB DDK开发指导](usb-ddk-guidelines.md)
zh-cn/application-dev/napi/usb-ddk-guidelines.md 0 → 100644
浏览文件 @ 4ee3ceaf
# USB DDK开发指导
## 场景介绍
USB DDK（USB Driver Develop Kit）是OpenHarmony为开发者提供的USB驱动程序开发套件，支持开发者基于用户态，在应用层开发USB设备驱动。提供了一系列主机侧访问设备的接口，包括主机侧打开和关闭接口、管道同步异步读写通信、控制传输、中断传输等。
## 接口说明
| 名称 | 描述 |
| -------- | -------- |
| OH_Usb_Init(void) | 初始化DDK。 |
| OH_Usb_Release(void) | 释放DDK。 |
| OH_Usb_GetDeviceDescriptor(uint64_t deviceId, struct UsbDeviceDescriptor *desc) | 获取设备描述符。 |
| OH_Usb_GetConfigDescriptor(uint64_t deviceId, uint8_t configIndex, struct UsbDdkConfigDescriptor **const config) | 获取配置描述符。请在描述符使用完后使用OH_Usb_FreeConfigDescriptor()释放描述符，否则会造成内存泄露。 |
| OH_Usb_FreeConfigDescriptor(const struct UsbDdkConfigDescriptor *const config) | 释放配置描述符，请在描述符使用完后释放描述符，否则会造成内存泄露。 |
| OH_Usb_ClaimInterface(uint64_t deviceId, uint8_t interfaceIndex, uint64_t *interfaceHandle) | 声明接口。 |
| OH_Usb_ReleaseInterface(uint64_t interfaceHandle) | 释放接口。 |
| OH_Usb_SendPipeRequest(const struct UsbRequestPipe *pipe, UsbDeviceMemMap *devMmap) | 发送管道请求，该接口为同步接口。中断传输和批量传输都使用该接口发送请求。 |
| OH_Usb_CreateDeviceMemMap(uint64_t deviceId, size_t size, UsbDeviceMemMap **devMmap) | 创建缓冲区。请在缓冲区使用完后，调用OH_Usb_DestroyDeviceMemMap()销毁缓冲区，否则会造成资源泄露。 |
| OH_Usb_DestroyDeviceMemMap(UsbDeviceMemMap *devMmap) | 销毁缓冲区。请在缓冲区使用完后及时销毁缓冲区，否则会造成资源泄露。 |
详细的接口说明请参考[USB DDK](../reference/native-apis/_usb_ddk.md)。
## USB DDK开发步骤
以下步骤描述了在**OpenHarmony**如何使用 **USB DDK**开发USB驱动：
1. **获取设备描述符**。使用 **usb_ddk_api.h** 的 **OH_Usb_Init** 接口初始化DDK，并使用 **OH_Usb_GetDeviceDescriptor**获取到设备描述符。
```c++
// 初始化USB DDK
OH_Usb_Init();
struct UsbDeviceDescriptor devDesc;
uint64_t deviceId = 0;
// 获取设备描述符
OH_Usb_GetDeviceDescriptor(deviceId, &devDesc);
```
2. **获取配置描述符及声明接口**。使用 **usb_ddk_api.h** 的 **OH_Usb_GetConfigDescriptor** 接口获取配置描述符 **config**，并使用 **OH_Usb_ClaimInterface** 声明接口。
```c++
struct UsbDdkConfigDescriptor *config = nullptr;
// 获取配置描述符
OH_Usb_GetConfigDescriptor(deviceId, 1, &config);
// 根据配置描述符,找到所需要通信的interfaceIndex
uint8_t interfaceIndex = 0;
// 声明接口
uint64_t interfaceHandle = 0;
OH_Usb_ClaimInterface(deviceId, interfaceIndex, &interfaceHandle);
// 释放配置描述符
OH_Usb_FreeConfigDescriptor(config);
```
3. **创建内存映射缓冲区及发送请求**。使用 **usb_ddk_api.h** 的**OH_Usb_CreateDeviceMemMap**接口创建内存映射缓冲区**devMmap**，并使用**OH_Usb_SendPipeRequest**发送请求。
```c++
struct UsbDeviceMemMap *devMmap = nullptr;
// 创建用于存放数据的缓冲区
size_t bufferLen = 10;
OH_Usb_CreateDeviceMemMap(deviceId, bufferLen, &devMmap);
struct UsbRequestPipe pipe;
pipe.interfaceHandle = interfaceHandle;
// 根据配置描述符找到所要通信的端点
pipe.endpoint = 128;
pipe.timeout = UINT32_MAX;
// 发送请求
OH_Usb_SendPipeRequest(&pipe, devMmap);
```
4. **释放资源**。在所有请求处理完毕，程序退出前，使用 **usb_ddk_api.h** 的 **OH_Usb_DestroyDeviceMemMap** 接口销毁缓冲区。使用**OH_Usb_ReleaseInterface**释放接口。使用**OH_Usb_Release**释放USB DDK。
```c++
// 销毁缓冲区
OH_Usb_DestroyDeviceMemMap(devMmap);
// 释放接口
OH_Usb_ReleaseInterface(interfaceHandle);
// 释放USB DDK
OH_Usb_Release();
```
\ No newline at end of file
zh-cn/application-dev/reference/native-apis/Readme-CN.md
浏览文件 @ 4ee3ceaf
......@@ -29,6 +29,7 @@
- [HuksTypeApi](_huks_type_api.md)
- [Init](init.md)
- [Memory](memory.md)
- [UsbDdk](_usb_ddk.md)
- [Hitrace](_hitrace.md)
- [Vulkan](_vulkan.md)
- 头文件
......@@ -90,6 +91,8 @@
- [relational_store.h](relational__store_8h.md)
- [syscap_ndk.h](syscap__ndk_8h.md)
- [purgeable_memory.h](purgeable__memory_8h.md)
- [usb_ddk_api.h](usb__ddk__api_8h.md)
- [usb_ddk_types.h](usb__ddk__types_8h.md)
- [trace.h](trace_8h.md)
- [vulkan_ohos.h](vulkan__ohos_8h.md)
- 结构体
......@@ -137,6 +140,17 @@
- [OH_Rdb_Store](_o_h___rdb___store.md)
- [OH_VBucket](_o_h___v_bucket.md)
- [OH_VObject](_o_h___v_object.md)
- [UsbConfigDescriptor](_usb_config_descriptor.md)
- [UsbControlRequestSetup](_usb_control_request_setup.md)
- [UsbDdkConfigDescriptor](_usb_ddk_config_descriptor.md)
- [UsbDdkEndpointDescriptor](_usb_ddk_endpoint_descriptor.md)
- [UsbDdkInterface](_usb_ddk_interface.md)
- [UsbDdkInterfaceDescriptor](_usb_ddk_interface_descriptor.md)
- [UsbDeviceDescriptor](_usb_device_descriptor.md)
- [UsbDeviceMemMap](_usb_device_mem_map.md)
- [UsbEndpointDescriptor](_usb_endpoint_descriptor.md)
- [UsbInterfaceDescriptor](_usb_interface_descriptor.md)
- [UsbRequestPipe](_usb_request_pipe.md)
- [VkExternalFormatOHOS](_vk_external_format_o_h_o_s.md)
- [VkImportNativeBufferInfoOHOS](_vk_import_native_buffer_info_o_h_o_s.md)
- [VkMemoryGetNativeBufferInfoOHOS](_vk_memory_get_native_buffer_info_o_h_o_s.md)
......
zh-cn/application-dev/reference/native-apis/_usb_config_descriptor.md 0 → 100644
浏览文件 @ 4ee3ceaf
# UsbConfigDescriptor
## 概述
标准配置描述符，对应USB协议中Standard Configuration Descriptor。
**起始版本：**
10
**相关模块:**
[UsbDdk](_usb_ddk.md)
## 汇总
### 成员变量
| 名称 | 描述 |
| -------- | -------- |
| [bLength](#blength) | 该描述符的大小，单位为字节。 |
| [bDescriptorType](#bdescriptortype) | 描述符类型。 |
| [wTotalLength](#wtotallength) | 该配置描述符的总长度，包含配置、接口、端点和特定于类或供应商的描述符。 |
| [bNumInterfaces](#bnuminterfaces) | 该配置所支持的接口数量。 |
| [bConfigurationValue](#bconfigurationvalue) | 设置配置所需要的参数，用来选择当前配置。 |
| [iConfiguration](#iconfiguration) | 描述该配置的字符串描述符的索引。 |
| [bmAttributes](#bmattributes) | 配置属性，包含供电模式、远程唤醒等配置。 |
| [bMaxPower](#bmaxpower) | 总线供电的USB设备的最大功耗，以2mA为单位。 |
## 结构体成员变量说明
### bConfigurationValue
```
uint8_t UsbConfigDescriptor::bConfigurationValue
```
**描述:**
设置配置所需要的参数，用来选择当前配置。
### bDescriptorType
```
uint8_t UsbConfigDescriptor::bDescriptorType
```
**描述:**
描述符类型。
### bLength
```
uint8_t UsbConfigDescriptor::bLength
```
**描述:**
该描述符的大小，单位为字节。
### bmAttributes
```
uint8_t UsbConfigDescriptor::bmAttributes
```
**描述:**
配置属性，包含供电模式、远程唤醒等配置。
### bMaxPower
```
uint8_t UsbConfigDescriptor::bMaxPower
```
**描述:**
总线供电的USB设备的最大功耗，以2mA为单位。
### bNumInterfaces
```
uint8_t UsbConfigDescriptor::bNumInterfaces
```
**描述:**
该配置所支持的接口数量。
### iConfiguration
```
uint8_t UsbConfigDescriptor::iConfiguration
```
**描述:**
描述该配置的字符串描述符的索引。
### wTotalLength
```
uint16_t UsbConfigDescriptor::wTotalLength
```
**描述:**
该配置描述符的总长度，包含配置、接口、端点和特定于类或供应商的描述符。
zh-cn/application-dev/reference/native-apis/_usb_control_request_setup.md 0 → 100644
浏览文件 @ 4ee3ceaf
# UsbControlRequestSetup
## 概述
控制传输setup包，对应USB协议中的Setup Data。
**起始版本：**
10
**相关模块:**
[UsbDdk](_usb_ddk.md)
## 汇总
### 成员变量
| 名称 | 描述 |
| -------- | -------- |
| [bmRequestType](#bmrequesttype) | 请求类型。 |
| [bRequest](#brequest) | 具体的请求，其代表的含义不一样。 |
| [wValue](#wvalue) | 具体的请求不同。 |
| [wIndex](#windex) | 具体的请求不同，其代表的含义不一样，通常用来传递索引或者偏移量。 |
| [wLength](#wlength) | 如果有数据阶段的传输，其代表传输的字节个数。 |
## 结构体成员变量说明
### wIndex
```
uint16_t UsbControlRequestSetup::wIndex
```
**描述:**
具体的请求不同，其代表的含义不一样，通常用来传递索引或者偏移量。
### wLength
```
uint16_t UsbControlRequestSetup::wLength
```
**描述:**
如果有数据阶段的传输，其代表传输的字节个数。
### bRequest
```
uint8_t UsbControlRequestSetup::bRequest
```
**描述:**
具体的请求。
### bmRequestType
```
uint8_t UsbControlRequestSetup::bmRequestType
```
**描述:**
请求类型。
### wValue
```
uint16_t UsbControlRequestSetup::wValue
```
**描述:**
具体的请求不同，其代表的含义不一样。
zh-cn/application-dev/reference/native-apis/_usb_ddk.md 0 → 100644
浏览文件 @ 4ee3ceaf
# UsbDdk
## 概述
提供USB DDK接口，包括主机侧打开和关闭接口、管道同步异步读写通信、控制传输、中断传输等。
\@syscap SystemCapability.Driver.USB.Extension
**起始版本：**
10
## 汇总
### 文件
| 名称 | 描述 |
| -------- | -------- |
| [usb_ddk_api.h](usb__ddk__api_8h.md) | 声明用于主机侧访问设备的USB DDK接口。<br/>引用文件：&lt;usb/usb_ddk_api.h&gt; |
| [usb_ddk_types.h](usb__ddk__types_8h.md) | 提供USB DDK中的枚举变量、结构体定义与宏定义。<br/>引用文件：&lt;usb/usb_ddk_types.h&gt; |
### 结构体
| 名称 | 描述 |
| -------- | -------- |
| [UsbControlRequestSetup](_usb_control_request_setup.md) | 控制传输setup包，对应USB协议中的Setup Data。 |
| [UsbDeviceDescriptor](_usb_device_descriptor.md) | 标准设备描述符，对应USB协议中Standard Device Descriptor。 |
| [UsbConfigDescriptor](_usb_config_descriptor.md) | 标准配置描述符，对应USB协议中Standard Configuration Descriptor。 |
| [UsbInterfaceDescriptor](_usb_interface_descriptor.md) | 标准接口描述符，对应USB协议中Standard Interface Descriptor。 |
| [UsbEndpointDescriptor](_usb_endpoint_descriptor.md) | 标准端点描述符，对应USB协议中Standard Endpoint Descriptor。 |
| [UsbDdkEndpointDescriptor](_usb_ddk_endpoint_descriptor.md) | 端点描述符。 |
| [UsbDdkInterfaceDescriptor](_usb_ddk_interface_descriptor.md) | 接口描述符。 |
| [UsbDdkInterface](_usb_ddk_interface.md) | USB接口，是特定接口下备用设置的集合。 |
| [UsbDdkConfigDescriptor](_usb_ddk_config_descriptor.md) | 配置描述符。 |
| [UsbRequestPipe](_usb_request_pipe.md) | 请求管道。 |
| [UsbDeviceMemMap](_usb_device_mem_map.md) | 设备内存映射，通过[OH_Usb_CreateDeviceMemMap()](#oh_usb_createdevicememmap)创建设备内存映射，使用内存映射后的缓冲区，获得更好的性能。 |
### 类型定义
| 名称 | 描述 |
| -------- | -------- |
| [UsbDdkEndpointDescriptor](#usbddkendpointdescriptor) | 端点描述符。 |
| [UsbDdkInterfaceDescriptor](#usbddkinterfacedescriptor) | 接口描述符。 |
| [UsbDdkInterface](#usbddkinterface) | USB接口，是特定接口下备用设置的集合。 |
| [UsbDdkConfigDescriptor](#usbddkconfigdescriptor) | 配置描述符。 |
| [UsbDeviceMemMap](#usbdevicememmap) | 设备内存映射，通过[OH_Usb_CreateDeviceMemMap()](#oh_usb_createdevicememmap)创建设备内存映射，使用内存映射后的缓冲区，获得更好的性能。 |
### 枚举
| 名称 | 描述 |
| -------- | -------- |
| [UsbDdkErrCode](#usbddkerrcode) {<br/>USB_DDK_SUCCESS = 0, USB_DDK_FAILED = -1, USB_DDK_INVALID_PARAMETER = -2, USB_DDK_MEMORY_ERROR = -3,<br/>USB_DDK_INVALID_OPERATION = -4, USB_DDK_NULL_PTR = -5, USB_DDK_DEVICE_BUSY = -6, USB_DDK_TIMEOUT = -7<br/>} | USB DDK 错误码定义。 |
### 函数
| 名称 | 描述 |
| -------- | -------- |
| [OH_Usb_Init](#oh_usb_init) (void) | 初始化DDK。 |
| [OH_Usb_Release](#oh_usb_release) (void) | 释放DDK。 |
| [OH_Usb_GetDeviceDescriptor](#oh_usb_getdevicedescriptor) (uint64_t deviceId, struct [UsbDeviceDescriptor](_usb_device_descriptor.md) \*desc) | 获取设备描述符。 |
| [OH_Usb_GetConfigDescriptor](#oh_usb_getconfigdescriptor) (uint64_t deviceId, uint8_t configIndex, struct [UsbDdkConfigDescriptor](_usb_ddk_config_descriptor.md) \*\*const config) | 获取配置描述符。请在描述符使用完后使用[OH_Usb_FreeConfigDescriptor()](#oh_usb_freeconfigdescriptor)释放描述符，否则会造成内存泄露。 |
| [OH_Usb_FreeConfigDescriptor](#oh_usb_freeconfigdescriptor) (const struct [UsbDdkConfigDescriptor](_usb_ddk_config_descriptor.md) \*const config) | 释放配置描述符，请在描述符使用完后释放描述符，否则会造成内存泄露。 |
| [OH_Usb_ClaimInterface](#oh_usb_claiminterface) (uint64_t deviceId, uint8_t interfaceIndex, uint64_t \*[interfaceHandle](usb__ddk__types_8h.md#interfacehandle)) | 声明接口。 |
| [OH_Usb_ReleaseInterface](#oh_usb_releaseinterface) (uint64_t [interfaceHandle](usb__ddk__types_8h.md#interfacehandle)) | 释放接口。 |
| [OH_Usb_SelectInterfaceSetting](#oh_usb_selectinterfacesetting) (uint64_t [interfaceHandle](usb__ddk__types_8h.md#interfacehandle), uint8_t settingIndex) | 激活接口的备用设置。 |
| [OH_Usb_GetCurrentInterfaceSetting](#oh_usb_getcurrentinterfacesetting) (uint64_t [interfaceHandle](usb__ddk__types_8h.md#interfacehandle), uint8_t \*settingIndex) | 获取接口当前激活的备用设置。 |
| [OH_Usb_SendControlReadRequest](#oh_usb_sendcontrolreadrequest) (uint64_t [interfaceHandle](usb__ddk__types_8h.md#interfacehandle), const struct [UsbControlRequestSetup](_usb_control_request_setup.md) \*setup, uint32_t [timeout](usb__ddk__types_8h.md#timeout), uint8_t \*data, uint32_t \*dataLen) | 发送控制读请求，该接口为同步接口。 |
| [OH_Usb_SendControlWriteRequest](#oh_usb_sendcontrolwriterequest) (uint64_t [interfaceHandle](usb__ddk__types_8h.md#interfacehandle), const struct [UsbControlRequestSetup](_usb_control_request_setup.md) \*setup, uint32_t [timeout](usb__ddk__types_8h.md#timeout), const uint8_t \*data, uint32_t dataLen) | 发送控制写请求，该接口为同步接口。 |
| [OH_Usb_SendPipeRequest](#oh_usb_sendpiperequest) (const struct [UsbRequestPipe](_usb_request_pipe.md) \*pipe, [UsbDeviceMemMap](_usb_device_mem_map.md) \*devMmap) | 发送管道请求，该接口为同步接口。中断传输和批量传输都使用该接口发送请求。 |
| [OH_Usb_CreateDeviceMemMap](#oh_usb_createdevicememmap) (uint64_t deviceId, size_t size, [UsbDeviceMemMap](_usb_device_mem_map.md) \*\*devMmap) | 创建缓冲区。请在缓冲区使用完后，调用[OH_Usb_DestroyDeviceMemMap()](#oh_usb_destroydevicememmap)销毁缓冲区，否则会造成资源泄露。 |
| [OH_Usb_DestroyDeviceMemMap](#oh_usb_destroydevicememmap) ([UsbDeviceMemMap](_usb_device_mem_map.md) \*devMmap) | 销毁缓冲区。请在缓冲区使用完后及时销毁缓冲区，否则会造成资源泄露。 |
## 类型定义说明
### UsbDdkConfigDescriptor
```
typedef struct UsbDdkConfigDescriptor UsbDdkConfigDescriptor
```
**描述:**
配置描述符。
### UsbDdkEndpointDescriptor
```
typedef struct UsbDdkEndpointDescriptor UsbDdkEndpointDescriptor
```
**描述:**
端点描述符。
### UsbDdkInterface
```
typedef struct UsbDdkInterface UsbDdkInterface
```
**描述:**
USB接口，是特定接口下备用设置的集合。
### UsbDdkInterfaceDescriptor
```
typedef struct UsbDdkInterfaceDescriptor UsbDdkInterfaceDescriptor
```
**描述:**
接口描述符。
### UsbDeviceMemMap
```
typedef struct UsbDeviceMemMap UsbDeviceMemMap
```
**描述:**
设备内存映射，通过[OH_Usb_CreateDeviceMemMap()](#oh_usb_createdevicememmap)创建设备内存映射，使用内存映射后的缓冲区，获得更好的性能。
## 枚举类型说明
### UsbDdkErrCode
```
enum UsbDdkErrCode
```
**描述:**
USB DDK 错误码定义。
| 枚举值 | 描述 |
| -------- | -------- |
| USB_DDK_SUCCESS | 操作成功。 |
| USB_DDK_FAILED | 操作失败。 |
| USB_DDK_INVALID_PARAMETER | 非法参数。 |
| USB_DDK_MEMORY_ERROR | 内存相关的错误，包括：内存不足、内存数据拷贝失败、内存申请失败等。 |
| USB_DDK_INVALID_OPERATION | 非法操作。 |
| USB_DDK_NULL_PTR | 空指针异常。 |
| USB_DDK_DEVICE_BUSY | 设备忙。 |
| USB_DDK_TIMEOUT | 传输超时。 |
## 函数说明
### OH_Usb_ClaimInterface()
```
int32_t OH_Usb_ClaimInterface (uint64_t deviceId, uint8_t interfaceIndex, uint64_t * interfaceHandle )
```
**描述:**
声明接口。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| deviceId | 设备ID，代表要操作的设备。 |
| interfaceIndex | 接口索引，对应USB协议中的[bInterfaceNumber](_usb_interface_descriptor.md#binterfacenumber)。 |
| interfaceHandle | 接口操作句柄，接口声明成功后，该参数将会被赋值。 |
**返回:**
成功返回0，否则返回负数。
### OH_Usb_CreateDeviceMemMap()
```
int32_t OH_Usb_CreateDeviceMemMap (uint64_t deviceId, size_t size, UsbDeviceMemMap ** devMmap )
```
**描述:**
创建缓冲区。请在缓冲区使用完后，调用[OH_Usb_DestroyDeviceMemMap()](#oh_usb_destroydevicememmap)销毁缓冲区，否则会造成资源泄露。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| deviceId | 设备ID，代表要创建缓冲区的设备。 |
| size | 缓冲区的大小。 |
| devMmap | 创建的缓冲区通过该参数返回给调用者。 |
**返回:**
成功返回0，否则返回负数。
### OH_Usb_DestroyDeviceMemMap()
```
void OH_Usb_DestroyDeviceMemMap (UsbDeviceMemMap * devMmap)
```
**描述:**
销毁缓冲区。请在缓冲区使用完后及时销毁缓冲区，否则会造成资源泄露。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| devMmap | 销毁由[OH_Usb_CreateDeviceMemMap()](#oh_usb_createdevicememmap)创建的缓冲区。 |
### OH_Usb_FreeConfigDescriptor()
```
void OH_Usb_FreeConfigDescriptor (const struct UsbDdkConfigDescriptor *const config)
```
**描述:**
释放配置描述符，请在描述符使用完后释放描述符，否则会造成内存泄露。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| config | 配置描述符，通过[OH_Usb_GetConfigDescriptor()](#oh_usb_getconfigdescriptor)获得的配置描述符。 |
### OH_Usb_GetConfigDescriptor()
```
int32_t OH_Usb_GetConfigDescriptor (uint64_t deviceId, uint8_t configIndex, struct UsbDdkConfigDescriptor **const config )
```
**描述:**
获取配置描述符。请在描述符使用完后使用[OH_Usb_FreeConfigDescriptor()](#oh_usb_freeconfigdescriptor)释放描述符，否则会造成内存泄露。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| deviceId | 设备ID，代表要获取配置描述符的设备。 |
| configIndex | 配置id，对应USB协议中的[bConfigurationValue](_usb_config_descriptor.md#bconfigurationvalue)。 |
| config | 配置描述符，包含USB协议中定义的标准配置描述符，以及与其关联的接口描述符和端点描述符。 |
**返回:**
成功返回0，否则返回负数。
### OH_Usb_GetCurrentInterfaceSetting()
```
int32_t OH_Usb_GetCurrentInterfaceSetting (uint64_t interfaceHandle, uint8_t * settingIndex )
```
**描述:**
获取接口当前激活的备用设置。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| interfaceHandle | 接口操作句柄，代表要操作的接口。 |
| settingIndex | 备用设置索引，对应USB协议中的[bAlternateSetting](_usb_interface_descriptor.md#balternatesetting)。 |
**返回:**
成功返回0，否则返回负数。
### OH_Usb_GetDeviceDescriptor()
```
int32_t OH_Usb_GetDeviceDescriptor (uint64_t deviceId, struct UsbDeviceDescriptor * desc )
```
**描述:**
获取设备描述符。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| deviceId | 设备ID，代表要获取描述符的设备。 |
| desc | 设备描述符，详细定义请参考[UsbDeviceDescriptor](_usb_device_descriptor.md)。 |
**返回:**
成功返回0，否则返回负数。
### OH_Usb_Init()
```
int32_t OH_Usb_Init (void )
```
**描述:**
初始化DDK。
**返回:**
成功返回0，否则返回负数。
### OH_Usb_Release()
```
void OH_Usb_Release (void )
```
**描述:**
释放DDK。
### OH_Usb_ReleaseInterface()
```
int32_t OH_Usb_ReleaseInterface (uint64_t interfaceHandle)
```
**描述:**
释放接口。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| interfaceHandle | 接口操作句柄，代表要释放的接口。 |
**返回:**
成功返回0，否则返回负数。
### OH_Usb_SelectInterfaceSetting()
```
int32_t OH_Usb_SelectInterfaceSetting (uint64_t interfaceHandle, uint8_t settingIndex )
```
**描述:**
激活接口的备用设置。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| interfaceHandle | 接口操作句柄，代表要操作的接口。 |
| settingIndex | 备用设置索引，对应USB协议中的[bAlternateSetting](_usb_interface_descriptor.md#balternatesetting)。 |
**返回:**
成功返回0，否则返回负数。
### OH_Usb_SendControlReadRequest()
```
int32_t OH_Usb_SendControlReadRequest (uint64_t interfaceHandle, const struct UsbControlRequestSetup * setup, uint32_t timeout, uint8_t * data, uint32_t * dataLen )
```
**描述:**
发送控制读请求，该接口为同步接口。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| interfaceHandle | 接口操作句柄，代表要操作的接口。 |
| setup | 请求相关的参数，详细定义请参考 [UsbControlRequestSetup](_usb_control_request_setup.md)。 |
| timeout | 超时时间，单位为毫秒。 |
| data | 要传输的数据。 |
| dataLen | 表示data的数据长度，在函数返回后，表示实际读取到的数据的长度。 |
**返回:**
成功返回0，否则返回负数。
### OH_Usb_SendControlWriteRequest()
```
int32_t OH_Usb_SendControlWriteRequest (uint64_t interfaceHandle, const struct UsbControlRequestSetup * setup, uint32_t timeout, const uint8_t * data, uint32_t dataLen )
```
**描述:**
发送控制写请求，该接口为同步接口。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| interfaceHandle | 接口操作句柄，代表要操作的接口。 |
| setup | 请求相关的参数，详细定义请参考 [UsbControlRequestSetup](_usb_control_request_setup.md)。 |
| timeout | 超时时间，单位为毫秒。 |
| data | 要传输的数据。 |
| dataLen | 表示data的数据长度。 |
**返回:**
成功返回0，否则返回负数。
### OH_Usb_SendPipeRequest()
```
int32_t OH_Usb_SendPipeRequest (const struct UsbRequestPipe * pipe, UsbDeviceMemMap * devMmap )
```
**描述:**
发送管道请求，该接口为同步接口。中断传输和批量传输都使用该接口发送请求。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| pipe | 要传输数据的管道信息。 |
| devMmap | 数据缓冲区，可以通过[OH_Usb_CreateDeviceMemMap()](#oh_usb_createdevicememmap)获得。 |
**返回:**
成功返回0，否则返回负数。
zh-cn/application-dev/reference/native-apis/_usb_ddk_config_descriptor.md 0 → 100644
浏览文件 @ 4ee3ceaf
# UsbDdkConfigDescriptor
## 概述
配置描述符。
**起始版本：**
10
**相关模块:**
[UsbDdk](_usb_ddk.md)
## 汇总
### 成员变量
| 名称 | 描述 |
| -------- | -------- |
| [configDescriptor](#configdescriptor) | 标准配置描述符。 |
| [interface](#interface) | 该配置所包含的接口。 |
| [extra](#extra) | 未做解析的描述符，包含特定于类或供应商的描述符。 |
| [extraLength](#extralength) | 未做解析的描述符长度。 |
## 结构体成员变量说明
### configDescriptor
```
struct UsbConfigDescriptor UsbDdkConfigDescriptor::configDescriptor
```
**描述:**
标准配置描述符。
### extra
```
uint8_t* UsbDdkConfigDescriptor::extra
```
**描述:**
未做解析的描述符，包含特定于类或供应商的描述符。
### extraLength
```
uint32_t UsbDdkConfigDescriptor::extraLength
```
**描述:**
未做解析的描述符长度。
### interface
```
struct UsbDdkInterface* UsbDdkConfigDescriptor::interface
```
**描述:**
该配置所包含的接口。
zh-cn/application-dev/reference/native-apis/_usb_ddk_endpoint_descriptor.md 0 → 100644
浏览文件 @ 4ee3ceaf
# UsbDdkEndpointDescriptor
## 概述
端点描述符。
**起始版本：**
10
**相关模块:**
[UsbDdk](_usb_ddk.md)
## 汇总
### 成员变量
| 名称 | 描述 |
| -------- | -------- |
| [endpointDescriptor](#endpointdescriptor) | 标准端点描述符。 |
| [extra](#extra) | 未做解析的描述符，包含特定于类或供应商的描述符。 |
| [extraLength](#extralength) | 未做解析的描述符长度。 |
## 结构体成员变量说明
### endpointDescriptor
```
struct UsbEndpointDescriptor UsbDdkEndpointDescriptor::endpointDescriptor
```
**描述:**
标准端点描述符。
### extra
```
uint8_t* UsbDdkEndpointDescriptor::extra
```
**描述:**
未做解析的描述符，包含特定于类或供应商的描述符。
### extraLength
```
uint32_t UsbDdkEndpointDescriptor::extraLength
```
**描述:**
未做解析的描述符长度。
zh-cn/application-dev/reference/native-apis/_usb_ddk_interface.md 0 → 100644
浏览文件 @ 4ee3ceaf
# UsbDdkInterface
## 概述
USB接口，是特定接口下备用设置的集合。
**起始版本：**
10
**相关模块:**
[UsbDdk](_usb_ddk.md)
## 汇总
### 成员变量
| 名称 | 描述 |
| -------- | -------- |
| [numAltsetting](#numaltsetting) | 接口的备用设置数量。 |
| [altsetting](#altsetting) | 接口的备用设置。 |
## 结构体成员变量说明
### altsetting
```
struct UsbDdkInterfaceDescriptor* UsbDdkInterface::altsetting
```
**描述:**
接口的备用设置。
### numAltsetting
```
uint8_t UsbDdkInterface::numAltsetting
```
**描述:**
接口的备用设置数量。
zh-cn/application-dev/reference/native-apis/_usb_ddk_interface_descriptor.md 0 → 100644
浏览文件 @ 4ee3ceaf
# UsbDdkInterfaceDescriptor
## 概述
接口描述符。
**起始版本：**
10
**相关模块:**
[UsbDdk](_usb_ddk.md)
## 汇总
### 成员变量
| 名称 | 描述 |
| -------- | -------- |
| [interfaceDescriptor](#interfacedescriptor) | 标准接口描述符。 |
| [endPoint](#endpoint) | 该接口所包含的端点描述符。 |
| [extra](#extra) | 未做解析的描述符，包含特定于类或供应商的描述符。 |
| [extraLength](#extralength) | 未做解析的描述符长度。 |
## 结构体成员变量说明
### endPoint
```
struct UsbDdkEndpointDescriptor* UsbDdkInterfaceDescriptor::endPoint
```
**描述:**
该接口所包含的端点描述符。
### extra
```
uint8_t* UsbDdkInterfaceDescriptor::extra
```
**描述:**
未做解析的描述符，包含特定于类或供应商的描述符。
### extraLength
```
uint32_t UsbDdkInterfaceDescriptor::extraLength
```
**描述:**
未做解析的描述符长度。
### interfaceDescriptor
```
struct UsbInterfaceDescriptor UsbDdkInterfaceDescriptor::interfaceDescriptor
```
**描述:**
标准接口描述符。
zh-cn/application-dev/reference/native-apis/_usb_device_descriptor.md 0 → 100644
浏览文件 @ 4ee3ceaf
# UsbDeviceDescriptor
## 概述
标准设备描述符，对应USB协议中Standard Device Descriptor。
**起始版本：**
10
**相关模块:**
[UsbDdk](_usb_ddk.md)
## 汇总
### 成员变量
| 名称 | 描述 |
| -------- | -------- |
| [bLength](#blength) | 该描述符的大小，单位为字节。 |
| [bDescriptorType](#bdescriptortype) | 描述符类型。 |
| [bcdUSB](#bcdusb) | USB协议发布号。 |
| [bDeviceClass](#bdeviceclass) | 由USB标准化组织（USB-IF）分配的设备类代码。 |
| [bDeviceSubClass](#bdevicesubclass) | 由USB标准化组织（USB-IF）分配的子类代码，其值由[bDeviceClass](#bdeviceclass)的值限定。 |
| [bDeviceProtocol](#bdeviceprotocol) | 由USB标准化组织（USB-IF）分配的协议代码，其值由[bDeviceClass](#bdeviceclass)和[bDeviceSubClass](#bdevicesubclass)的值限定。 |
| [bMaxPacketSize0](#bmaxpacketsize0) | 端点零的最大包大小，只有8，16，32，64是合法的。 |
| [idVendor](#idvendor) | 由USB标准化组织（USB-IF）分配的厂商编号。 |
| [idProduct](#idproduct) | 由厂商分配的产品编号。 |
| [bcdDevice](#bcddevice) | 设备发布编号。 |
| [iManufacturer](#imanufacturer) | 描述厂商的字符串描述符的索引。 |
| [iProduct](#iproduct) | 描述产品的字符串描述符的索引。 |
| [iSerialNumber](#iserialnumber) | 描述设备序列号的字符串描述符的索引。 |
| [bNumConfigurations](#bnumconfigurations) | 配置数量。 |
## 结构体成员变量说明
### bcdDevice
```
uint16_t UsbDeviceDescriptor::bcdDevice
```
**描述:**
设备发布编号。
### bcdUSB
```
uint16_t UsbDeviceDescriptor::bcdUSB
```
**描述:**
USB协议发布号。
### bDescriptorType
```
uint8_t UsbDeviceDescriptor::bDescriptorType
```
**描述:**
描述符类型。
### bDeviceClass
```
uint8_t UsbDeviceDescriptor::bDeviceClass
```
**描述:**
由USB标准化组织（USB-IF）分配的设备类代码。
### bDeviceProtocol
```
uint8_t UsbDeviceDescriptor::bDeviceProtocol
```
**描述:**
由USB标准化组织（USB-IF）分配的协议代码，其值由[bDeviceClass](#bdeviceclass)和[bDeviceSubClass](#bdevicesubclass)的值限定。
### bDeviceSubClass
```
uint8_t UsbDeviceDescriptor::bDeviceSubClass
```
**描述:**
由USB标准化组织（USB-IF）分配的子类代码，其值由[bDeviceClass](#bdeviceclass)的值限定。
### bLength
```
uint8_t UsbDeviceDescriptor::bLength
```
**描述:**
该描述符的大小，单位为字节。
### bMaxPacketSize0
```
uint8_t UsbDeviceDescriptor::bMaxPacketSize0
```
**描述:**
端点零的最大包大小，只有8、16、32、64是合法的。
### bNumConfigurations
```
uint8_t UsbDeviceDescriptor::bNumConfigurations
```
**描述:**
配置数量。
### idProduct
```
uint16_t UsbDeviceDescriptor::idProduct
```
**描述:**
由厂商分配的产品编号。
### idVendor
```
uint16_t UsbDeviceDescriptor::idVendor
```
**描述:**
由USB标准化组织（USB-IF）分配的厂商编号。
### iManufacturer
```
uint8_t UsbDeviceDescriptor::iManufacturer
```
**描述:**
描述厂商的字符串描述符的索引。
### iProduct
```
uint8_t UsbDeviceDescriptor::iProduct
```
**描述:**
描述产品的字符串描述符的索引。
### iSerialNumber
```
uint8_t UsbDeviceDescriptor::iSerialNumber
```
**描述:**
描述设备序列号的字符串描述符的索引。
zh-cn/application-dev/reference/native-apis/_usb_device_mem_map.md 0 → 100644
浏览文件 @ 4ee3ceaf
# UsbDeviceMemMap
## 概述
设备内存映射，通过[OH_Usb_CreateDeviceMemMap()](_usb_ddk.md#oh_usb_createdevicememmap)创建设备内存映射，使用内存映射后的缓冲区，获得更好的性能。
**起始版本：**
10
**相关模块:**
[UsbDdk](_usb_ddk.md)
## 汇总
### 成员变量
| 名称 | 描述 |
| -------- | -------- |
| [address](#address) | 映射后的缓冲区地址。 |
| [size](#size) | 缓冲区大小。 |
| [offset](#offset) | 所使用的的缓冲区的偏移量，默认为0，表示没有偏移，从address开始。 |
| [bufferLength](#bufferlength) | 所使用的缓冲区的长度，默认等于size，表示使用全部的缓冲区。 |
| [transferedLength](#transferedlength) | 实际传输的数据的长度。 |
## 结构体成员变量说明
### address
```
uint8_t* const UsbDeviceMemMap::address
```
**描述:**
映射后的缓冲区地址。
### bufferLength
```
uint32_t UsbDeviceMemMap::bufferLength
```
**描述:**
所使用的缓冲区的长度，默认等于size，表示使用全部的缓冲区。
### offset
```
uint32_t UsbDeviceMemMap::offset
```
**描述:**
所使用的的缓冲区的偏移量，默认为0，表示没有偏移，从address开始。
### size
```
const size_t UsbDeviceMemMap::size
```
**描述:**
缓冲区大小。
### transferedLength
```
uint32_t UsbDeviceMemMap::transferedLength
```
**描述:**
实际传输的数据的长度。
zh-cn/application-dev/reference/native-apis/_usb_endpoint_descriptor.md 0 → 100644
浏览文件 @ 4ee3ceaf
# UsbEndpointDescriptor
## 概述
标准端点描述符，对应USB协议中Standard Endpoint Descriptor。
**起始版本：**
10
**相关模块:**
[UsbDdk](_usb_ddk.md)
## 汇总
### 成员变量
| 名称 | 描述 |
| -------- | -------- |
| [bLength](#blength) | 该描述符的大小，单位为字节。 |
| [bDescriptorType](#bdescriptortype) | 描述符类型。 |
| [bEndpointAddress](#bendpointaddress) | 端点地址，包含端点编号以及端点方向。 |
| [bmAttributes](#bmattributes) | 端点属性，包括传输类型、同步类型、使用类型。 |
| [wMaxPacketSize](#wmaxpacketsize) | 该端点所能承载的最大包的大小。 |
| [bInterval](#binterval) | 数据传输轮询端点的时间间隔。 |
| [bRefresh](#brefresh) | 用于音频类设备，同步反馈的速率。 |
| [bSynchAddress](#bsynchaddress) | 用于音频类设备，同步端点的地址。 |
## 结构体成员变量说明
### bDescriptorType
```
uint8_t UsbEndpointDescriptor::bDescriptorType
```
**描述:**
描述符类型。
### bEndpointAddress
```
uint8_t UsbEndpointDescriptor::bEndpointAddress
```
**描述:**
端点地址，包含端点编号以及端点方向。
### bInterval
```
uint8_t UsbEndpointDescriptor::bInterval
```
**描述:**
数据传输轮询端点的时间间隔。
### bLength
```
uint8_t UsbEndpointDescriptor::bLength
```
**描述:**
该描述符的大小，单位为字节。
### bmAttributes
```
uint8_t UsbEndpointDescriptor::bmAttributes
```
**描述:**
端点属性，包括传输类型、同步类型、使用类型。
### bRefresh
```
uint8_t UsbEndpointDescriptor::bRefresh
```
**描述:**
用于音频类设备，同步反馈的速率。
### bSynchAddress
```
uint8_t UsbEndpointDescriptor::bSynchAddress
```
**描述:**
用于音频类设备，同步端点的地址。
### wMaxPacketSize
```
uint16_t UsbEndpointDescriptor::wMaxPacketSize
```
**描述:**
该端点所能承载的最大包的大小。
zh-cn/application-dev/reference/native-apis/_usb_interface_descriptor.md 0 → 100644
浏览文件 @ 4ee3ceaf
# UsbInterfaceDescriptor
## 概述
标准接口描述符，对应USB协议中Standard Interface Descriptor。
**起始版本：**
10
**相关模块:**
[UsbDdk](_usb_ddk.md)
## 汇总
### 成员变量
| 名称 | 描述 |
| -------- | -------- |
| [bLength](#blength) | 该描述符的大小，单位为字节。 |
| [bDescriptorType](#bdescriptortype) | 描述符类型。 |
| [bInterfaceNumber](#binterfacenumber) | 接口编号。 |
| [bAlternateSetting](#balternatesetting) | 用来选择该接口的备用配置的值。 |
| [bNumEndpoints](#bnumendpoints) | 该接口所使用的端点数量（不包括端点零）。 |
| [bInterfaceClass](#binterfaceclass) | 由USB标准化组织（USB-IF）分配的设备类代码。 |
| [bInterfaceSubClass](#binterfacesubclass) | 由USB标准化组织（USB-IF）分配的子类代码，其值由[bInterfaceClass](#binterfaceclass)的值限定。 |
| [bInterfaceProtocol](#binterfaceprotocol) | 由USB标准化组织（USB-IF）分配的协议代码，其值由[bInterfaceClass](#binterfaceclass)和[bInterfaceSubClass](#binterfacesubclass)的值限定。 |
| [iInterface](#iinterface) | 描述该接口的字符串描述符的索引。 |
## 结构体成员变量说明
### bAlternateSetting
```
uint8_t UsbInterfaceDescriptor::bAlternateSetting
```
**描述:**
用来选择该接口的备用配置的值。
### bDescriptorType
```
uint8_t UsbInterfaceDescriptor::bDescriptorType
```
**描述:**
描述符类型。
### bInterfaceClass
```
uint8_t UsbInterfaceDescriptor::bInterfaceClass
```
**描述:**
由USB标准化组织（USB-IF）分配的设备类代码。
### bInterfaceNumber
```
uint8_t UsbInterfaceDescriptor::bInterfaceNumber
```
**描述:**
接口编号。
### bInterfaceProtocol
```
uint8_t UsbInterfaceDescriptor::bInterfaceProtocol
```
**描述:**
由USB标准化组织（USB-IF）分配的协议代码，其值由[bInterfaceClass](#binterfaceclass)和[bInterfaceSubClass](#binterfacesubclass)的值限定。
### bInterfaceSubClass
```
uint8_t UsbInterfaceDescriptor::bInterfaceSubClass
```
**描述:**
由USB标准化组织（USB-IF）分配的子类代码，其值由[bInterfaceClass](#binterfaceclass)的值限定。
### bLength
```
uint8_t UsbInterfaceDescriptor::bLength
```
**描述:**
该描述符的大小，单位为字节。
### bNumEndpoints
```
uint8_t UsbInterfaceDescriptor::bNumEndpoints
```
**描述:**
该接口所使用的端点数量（不包括端点零）。
### iInterface
```
uint8_t UsbInterfaceDescriptor::iInterface
```
**描述:**
描述该接口的字符串描述符的索引。
zh-cn/application-dev/reference/native-apis/_usb_request_pipe.md 0 → 100644
浏览文件 @ 4ee3ceaf
# UsbRequestPipe
## 概述
请求管道。
**起始版本：**
10
**相关模块:**
[UsbDdk](_usb_ddk.md)
## 汇总
### 成员变量
| 名称 | 描述 |
| -------- | -------- |
| [interfaceHandle](#interfacehandle) | 接口操作句柄。 |
| [endpoint](#endpoint) | 要通信的端点的地址。 |
| [timeout](#timeout) | 超时时间，单位是毫秒。 |
## 结构体成员变量说明
### endpoint
```
uint8_t UsbRequestPipe::endpoint
```
**描述:**
要通信的端点的地址。
### interfaceHandle
```
uint64_t UsbRequestPipe::interfaceHandle
```
**描述:**
接口操作句柄。
### timeout
```
uint32_t UsbRequestPipe::timeout
```
**描述:**
超时时间，单位是毫秒。
zh-cn/application-dev/reference/native-apis/usb__ddk__api_8h.md 0 → 100644
浏览文件 @ 4ee3ceaf
# usb_ddk_api.h
## 概述
声明用于主机侧访问设备的USB DDK接口。
**起始版本：**
10
**相关模块：**
[UsbDdk](_usb_ddk.md)
## 汇总
### 函数
| 名称 | 描述 |
| -------- | -------- |
| [OH_Usb_Init](_usb_ddk.md#oh_usb_init)&nbsp;(void) | 初始化DDK。 |
| [OH_Usb_Release](_usb_ddk.md#oh_usb_release)&nbsp;(void) | 释放DDK |
| [OH_Usb_GetDeviceDescriptor](_usb_ddk.md#oh_usb_getdevicedescriptor)&nbsp;(uint64_t&nbsp;deviceId,&nbsp;struct&nbsp;[UsbDeviceDescriptor](_usb_device_descriptor.md)&nbsp;\*desc) | 获取设备描述符。 |
| [OH_Usb_GetConfigDescriptor](_usb_ddk.md#oh_usb_getconfigdescriptor)&nbsp;(uint64_t&nbsp;deviceId,&nbsp;uint8_t&nbsp;configIndex,&nbsp;struct&nbsp;[UsbDdkConfigDescriptor](_usb_ddk_config_descriptor.md)&nbsp;\*\*const&nbsp;config) | 获取配置描述符。请在描述符使用完后使用[OH_Usb_FreeConfigDescriptor()](_usb_ddk.md#oh_usb_freeconfigdescriptor)释放描述符，否则会造成内存泄露。 |
| [OH_Usb_FreeConfigDescriptor](_usb_ddk.md#oh_usb_freeconfigdescriptor)&nbsp;(const&nbsp;struct&nbsp;[UsbDdkConfigDescriptor](_usb_ddk_config_descriptor.md)&nbsp;\*const&nbsp;config) | 释放配置描述符，请在描述符使用完后释放描述符，否则会造成内存泄露。 |
| [OH_Usb_ClaimInterface](_usb_ddk.md#oh_usb_claiminterface)&nbsp;(uint64_t&nbsp;deviceId,&nbsp;uint8_t&nbsp;interfaceIndex,&nbsp;uint64_t&nbsp;\*[interfaceHandle](usb__ddk__types_8h.md#interfacehandle)) | 声明接口。 |
| [OH_Usb_ReleaseInterface](_usb_ddk.md#oh_usb_releaseinterface)&nbsp;(uint64_t&nbsp;[interfaceHandle](usb__ddk__types_8h.md#interfacehandle)) | 释放接口。 |
| [OH_Usb_SelectInterfaceSetting](_usb_ddk.md#oh_usb_selectinterfacesetting)&nbsp;(uint64_t&nbsp;[interfaceHandle](usb__ddk__types_8h.md#interfacehandle),&nbsp;uint8_t&nbsp;settingIndex) | 激活接口的备用设置。 |
| [OH_Usb_GetCurrentInterfaceSetting](_usb_ddk.md#oh_usb_getcurrentinterfacesetting)&nbsp;(uint64_t&nbsp;[interfaceHandle](usb__ddk__types_8h.md#interfacehandle),&nbsp;uint8_t&nbsp;\*settingIndex) | 获取接口当前激活的备用设置。 |
| [OH_Usb_SendControlReadRequest](_usb_ddk.md#oh_usb_sendcontrolreadrequest)&nbsp;(uint64_t&nbsp;[interfaceHandle](usb__ddk__types_8h.md#interfacehandle),&nbsp;const&nbsp;struct&nbsp;[UsbControlRequestSetup](_usb_control_request_setup.md)&nbsp;\*setup,&nbsp;uint32_t&nbsp;[timeout](usb__ddk__types_8h.md#timeout),&nbsp;uint8_t&nbsp;\*data,&nbsp;uint32_t&nbsp;\*dataLen) | 发送控制读请求，该接口为同步接口。 |
| [OH_Usb_SendControlWriteRequest](_usb_ddk.md#oh_usb_sendcontrolwriterequest)&nbsp;(uint64_t&nbsp;[interfaceHandle](usb__ddk__types_8h.md#interfacehandle),&nbsp;const&nbsp;struct&nbsp;[UsbControlRequestSetup](_usb_control_request_setup.md)&nbsp;\*setup,&nbsp;uint32_t&nbsp;[timeout](usb__ddk__types_8h.md#timeout),&nbsp;const&nbsp;uint8_t&nbsp;\*data,&nbsp;uint32_t&nbsp;dataLen) | 发送控制写请求，该接口为同步接口。 |
| [OH_Usb_SendPipeRequest](_usb_ddk.md#oh_usb_sendpiperequest)&nbsp;(const&nbsp;struct&nbsp;[UsbRequestPipe](_usb_request_pipe.md)&nbsp;\*pipe,&nbsp;[UsbDeviceMemMap](_usb_device_mem_map.md)&nbsp;\*devMmap) | 发送管道请求，该接口为同步接口。中断传输和批量传输都使用该接口发送请求。 |
| [OH_Usb_CreateDeviceMemMap](_usb_ddk.md#oh_usb_createdevicememmap)&nbsp;(uint64_t&nbsp;deviceId,&nbsp;size_t&nbsp;size,&nbsp;[UsbDeviceMemMap](_usb_device_mem_map.md)&nbsp;\*\*devMmap) | 创建缓冲区。请在缓冲区使用完后，调用[OH_Usb_DestroyDeviceMemMap()](_usb_ddk.md#oh_usb_destroydevicememmap)销毁缓冲区，否则会造成资源泄露。 |
| [OH_Usb_DestroyDeviceMemMap](_usb_ddk.md#oh_usb_destroydevicememmap)&nbsp;([UsbDeviceMemMap](_usb_device_mem_map.md)&nbsp;\*devMmap) | 销毁缓冲区。请在缓冲区使用完后及时销毁缓冲区，否则会造成资源泄露。 |
zh-cn/application-dev/reference/native-apis/usb__ddk__types_8h.md 0 → 100644
浏览文件 @ 4ee3ceaf
# usb_ddk_types.h
## 概述
提供USB DDK中的枚举变量、结构体定义与宏定义。
**起始版本：**
10
**相关模块:**
[UsbDdk](_usb_ddk.md)
## 汇总
### 结构体
| 名称 | 描述 |
| -------- | -------- |
| [UsbControlRequestSetup](_usb_control_request_setup.md) | 控制传输setup包，对应USB协议中的Setup&nbsp;Data。 |
| [UsbDeviceDescriptor](_usb_device_descriptor.md) | 标准设备描述符，对应USB协议中Standard&nbsp;Device&nbsp;Descriptor。 |
| [UsbConfigDescriptor](_usb_config_descriptor.md) | 标准配置描述符，对应USB协议中Standard&nbsp;Configuration&nbsp;Descriptor。 |
| [UsbInterfaceDescriptor](_usb_interface_descriptor.md) | 标准接口描述符，对应USB协议中Standard&nbsp;Interface&nbsp;Descriptor。 |
| [UsbEndpointDescriptor](_usb_endpoint_descriptor.md) | 标准端点描述符，对应USB协议中Standard&nbsp;Endpoint&nbsp;Descriptor。 |
| [UsbDdkEndpointDescriptor](_usb_ddk_endpoint_descriptor.md) | 端点描述符。 |
| [UsbDdkInterfaceDescriptor](_usb_ddk_interface_descriptor.md) | 接口描述符。 |
| [UsbDdkInterface](_usb_ddk_interface.md) | USB接口，是特定接口下备用设置的集合。 |
| [UsbDdkConfigDescriptor](_usb_ddk_config_descriptor.md) | 配置描述符。 |
| [UsbRequestPipe](_usb_request_pipe.md) | 请求管道。 |
| [UsbDeviceMemMap](_usb_device_mem_map.md) | 设备内存映射，通过[OH_Usb_CreateDeviceMemMap()](_usb_ddk.md#oh_usb_createdevicememmap)创建设备内存映射，使用内存映射后的缓冲区，获得更好的性能。 |
### 类型定义
| 名称 | 描述 |
| -------- | -------- |
| [UsbDdkEndpointDescriptor](_usb_ddk.md#usbddkendpointdescriptor) | 端点描述符。 |
| [UsbDdkInterfaceDescriptor](_usb_ddk.md#usbddkinterfacedescriptor) | 接口描述符。 |
| [UsbDdkInterface](_usb_ddk.md#usbddkinterface) | USB接口。 |
| [UsbDdkConfigDescriptor](_usb_ddk.md#usbddkconfigdescriptor) | 配置描述符。 |
| [UsbDeviceMemMap](_usb_ddk.md#usbdevicememmap) | 设备内存映射，通过[OH_Usb_CreateDeviceMemMap()](_usb_ddk.md#oh_usb_createdevicememmap)创建设备内存映射，使用内存映射后的缓冲区，获得更好的性能。 |
### 枚举
| 名称 | 描述 |
| -------- | -------- |
| [UsbDdkErrCode](_usb_ddk.md#usbddkerrcode)&nbsp;{<br/>USB_DDK_SUCCESS&nbsp;=&nbsp;0,&nbsp;USB_DDK_FAILED&nbsp;=&nbsp;-1,&nbsp;USB_DDK_INVALID_PARAMETER&nbsp;=&nbsp;-2,&nbsp;USB_DDK_MEMORY_ERROR&nbsp;=&nbsp;-3,<br/>USB_DDK_INVALID_OPERATION&nbsp;=&nbsp;-4,&nbsp;USB_DDK_NULL_PTR&nbsp;=&nbsp;-5,&nbsp;USB_DDK_DEVICE_BUSY&nbsp;=&nbsp;-6,&nbsp;USB_DDK_TIMEOUT&nbsp;=&nbsp;-7<br/>} | USB&nbsp;DDK&nbsp;错误码定义。 |
### 变量
| 名称 | 描述 |
| -------- | -------- |
| [bmRequestType](#bmrequesttype) | 请求类型。 |
| [bRequest](#brequest) | 具体的请求。 |
| [wValue](#wvalue) | 具体的请求不同，其代表的含义不一样。 |
| [wIndex](#windex) | 具体的请求不同，其代表的含义不一样，通常用来传递索引或者偏移量。 |
| [wLength](#wlength) | 如果有数据阶段的传输，其代表传输的字节个数。 |
| [bLength](#blength) | 该描述符的大小，单位为字节。 |
| [bDescriptorType](#bdescriptortype) | 描述符类型。 |
| [bcdUSB](#bcdusb) | USB协议发布号。 |
| [bDeviceClass](#bdeviceclass) | 由USB标准化组织（USB-IF）分配的设备类代码。 |
| [bDeviceSubClass](#bdevicesubclass) | 由USB标准化组织（USB-IF）分配的子类代码，其值由[bDeviceClass](#bdeviceclass)的值限定。 |
| [bDeviceProtocol](#bdeviceprotocol) | 由USB标准化组织（USB-IF）分配的协议代码，其值由[bDeviceClass](#bdeviceclass)和[bDeviceSubClass](#bdevicesubclass)的值限定。 |
| [bMaxPacketSize0](#bmaxpacketsize0) | 端点零的最大包大小，只有8、16、32、64是合法的。 |
| [idVendor](#idvendor) | 由USB标准化组织（USB-IF）分配的厂商编号。 |
| [idProduct](#idproduct) | 由厂商分配的产品编号。 |
| [bcdDevice](#bcddevice) | 设备发布编号。 |
| [iManufacturer](#imanufacturer) | 描述厂商的字符串描述符的索引。 |
| [iProduct](#iproduct) | 描述产品的字符串描述符的索引。 |
| [iSerialNumber](#iserialnumber) | 描述设备序列号的字符串描述符的索引。 |
| [bNumConfigurations](#bnumconfigurations) | 配置数量。 |
| [wTotalLength](#wtotallength) | 该配置描述符的总长度，包含配置、接口、端点和特定于类或供应商的描述符。 |
| [bNumInterfaces](#bnuminterfaces) | 该配置所支持的接口数量。 |
| [bConfigurationValue](#bconfigurationvalue) | 设置配置所需要的参数，用来选择当前配置。 |
| [iConfiguration](#iconfiguration) | 描述该配置的字符串描述符的索引。 |
| [bmAttributes](#bmattributes) | 配置属性，包含供电模式、远程唤醒等配置。 |
| [bMaxPower](#bmaxpower) | 总线供电的USB设备的最大功耗，以2mA为单位。 |
| [bInterfaceNumber](#binterfacenumber) | 接口编号。 |
| [bAlternateSetting](#balternatesetting) | 用来选择该接口的备用配置的值。 |
| [bNumEndpoints](#bnumendpoints) | 该接口所使用的端点数量（不包括端点零）。 |
| [bInterfaceClass](#binterfaceclass) | 由USB标准化组织（USB-IF）分配的设备类代码。 |
| [bInterfaceSubClass](#binterfacesubclass) | 由USB标准化组织（USB-IF）分配的子类代码，其值由[bInterfaceClass](#binterfaceclass)的值限定。 |
| [bInterfaceProtocol](#binterfaceprotocol) | 由USB标准化组织（USB-IF）分配的协议代码，其值由[bInterfaceClass](#binterfaceclass)和[bInterfaceSubClass](#binterfacesubclass)的值限定。 |
| [iInterface](#iinterface) | 描述该接口的字符串描述符的索引。 |
| [bEndpointAddress](#bendpointaddress) | 端点地址，包含端点编号以及端点方向。 |
| [bmAttributes](#bmattributes) | 端点属性，包括传输类型、同步类型、使用类型。 |
| [wMaxPacketSize](#wmaxpacketsize) | 该端点所能承载的最大包的大小。 |
| [bInterval](#binterval) | 数据传输轮询端点的时间间隔。 |
| [bRefresh](#brefresh) | 用于音频类设备，同步反馈的速率。 |
| [bSynchAddress](#bsynchaddress) | 用于音频类设备，同步端点的地址。 |
| [interfaceHandle](#interfacehandle) | 接口操作句柄。 |
| [endpoint](#endpoint) | 要通信的端点的地址。 |
| [timeout](#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](#bdeviceclass)和[bDeviceSubClass](#bdevicesubclass)的值限定。
### bDeviceSubClass
```
uint8_t bDeviceSubClass
```
**描述:**
由USB标准化组织（USB-IF）分配的子类代码，其值由[bDeviceClass](#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](#binterfaceclass)和[bInterfaceSubClass](#binterfacesubclass)的值限定。
### bInterfaceSubClass
```
uint8_t bInterfaceSubClass
```
**描述:**
由USB标准化组织（USB-IF）分配的子类代码，其值由[bInterfaceClass](#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
```
**描述:**
该配置描述符的总长度，包含配置、接口、端点和特定于类或供应商的描述符。
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或