interface_i_usb_interface.md 25.6 KB
Newer Older
D
duangavin123 已提交
1 2 3
# IUsbInterface


Z
z00524957 已提交
4
## 概述
D
duangavin123 已提交
5 6 7 8 9 10 11

定义USB驱动基本的操作功能。

上层USB服务调用相关功能接口,可以打开/关闭设备,获取设备描述符,批量读取/写入数据等。

**相关模块:**

Z
z00524957 已提交
12
[USB](_u_s_b.md)
D
duangavin123 已提交
13 14


Z
z00524957 已提交
15
## 汇总
D
duangavin123 已提交
16 17 18 19 20 21


### Public 成员函数

  | 名称 | 描述 | 
| -------- | -------- |
Z
z00524957 已提交
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
| [OpenDevice](#opendevice) ([in] struct [UsbDev](_usb_dev.md) dev) | 打开设备,建立连接。  | 
| [CloseDevice](#closedevice) ([in] struct [UsbDev](_usb_dev.md) dev) | 关闭设备,释放与设备相关的所有系统资源。  | 
| [GetDeviceDescriptor](#getdevicedescriptor) ([in] struct [UsbDev](_usb_dev.md) dev, [out] unsigned char[] descriptor) | 获取设备描述符,设备描述符提供了关于设备、设备的配置以及任何设备所归属的类的信息。  | 
| [GetStringDescriptor](#getstringdescriptor) ([in] struct [UsbDev](_usb_dev.md) dev, [in] unsigned char descId, [out] unsigned char[] descriptor) | 根据设备的字符串ID获取字符串描述符,字符串描述符是提供一些设备接口相关的描述性信息,比如厂商的名字、产品序列号等。  | 
| [GetConfigDescriptor](#getconfigdescriptor) ([in] struct [UsbDev](_usb_dev.md) dev, [in] unsigned char descId, [out] unsigned char[] descriptor) | 根据设备的配置ID获取配置描述符,配置描述符包含有关配置及其接口、备用设置及其终结点的信息。  | 
| [GetRawDescriptor](#getrawdescriptor) ([in] struct [UsbDev](_usb_dev.md) dev, [out] unsigned char[] descriptor) | 获取USB设备的原始描述符。  | 
| [GetFileDescriptor](#getfiledescriptor) ([in] struct [UsbDev](_usb_dev.md) dev, [out] int fd) | 获取USB设备的文件描述符。  | 
| [SetConfig](#setconfig) ([in] struct [UsbDev](_usb_dev.md) dev, [in] unsigned char configIndex) | 设置USB设备当前的配置信息,USB设备被主机配置过后,主机可以使用设备提供的所有功能。  | 
| [GetConfig](#getconfig) ([in] struct [UsbDev](_usb_dev.md) dev, [out] unsigned char configIndex) | 获取USB设备当前的配置信息。  | 
| [ClaimInterface](#claiminterface) ([in] struct [UsbDev](_usb_dev.md) dev, [in] unsigned char interfaceid, [in] unsigned char force) | 打开USB设备的接口并声明独占,必须在数据传输前执行。  | 
| [ReleaseInterface](#releaseinterface) ([in] struct [UsbDev](_usb_dev.md) dev, [in] unsigned char interfaceid) | 在停止数据传输后关闭占用的USB设备接口,并释放相关资源。  | 
| [SetInterface](#setinterface) ([in] struct [UsbDev](_usb_dev.md) dev, [in] unsigned char interfaceid, [in] unsigned char altIndex) | 设置USB设备指定接口的备选设置,用于在具有相同ID但不同备用设置的两个接口之间进行选择。  | 
| [BulkTransferRead](#bulktransferread) ([in] struct [UsbDev](_usb_dev.md) dev, [in] struct [UsbPipe](_usb_pipe.md) pipe, [in] int timeout, [out] unsigned char[] data) | 在USB设备指定端点方向为读取时,执行批量数据读取。  | 
| [BulkTransferWrite](#bulktransferwrite) ([in] struct [UsbDev](_usb_dev.md) dev, [in] struct [UsbPipe](_usb_pipe.md) pipe, [in] int timeout, [in] unsigned char[] data) | 在USB设备指定端点方向为写入时,执行批量数据写入。  | 
| [ControlTransferRead](#controltransferread) ([in] struct [UsbDev](_usb_dev.md) dev, [in] struct [UsbCtrlTransfer](_usb_ctrl_transfer.md) ctrl, [out] unsigned char[] data) | 在传输状态为读取并且控制端点是端点零时,对USB设备执行控制传输。  | 
| [ControlTransferWrite](#controltransferwrite) ([in] struct [UsbDev](_usb_dev.md) dev, [in] struct [UsbCtrlTransfer](_usb_ctrl_transfer.md) ctrl, [in] unsigned char[] data) | 在传输状态为写入并且控制端点是端点零时,对USB设备执行控制传输。  | 
| [InterruptTransferRead](#interrupttransferread) ([in] struct [UsbDev](_usb_dev.md) dev, [in] struct [UsbPipe](_usb_pipe.md) pipe, [in] int timeout, [out] unsigned char[] data) | 在USB设备指定端点方向为数据读取时执行中断数据读取。  | 
| [InterruptTransferWrite](#interrupttransferwrite) ([in] struct [UsbDev](_usb_dev.md) dev, [in] struct [UsbPipe](_usb_pipe.md) pipe, [in] int timeout, [in] unsigned char[] data) | 在USB设备指定端点方向为写入时执行中断数据写入。  | 
| [IsoTransferRead](#isotransferread) ([in] struct [UsbDev](_usb_dev.md) dev, [in] struct [UsbPipe](_usb_pipe.md) pipe, [in] int timeout, [out] unsigned char[] data) | 在USB设备指定端点方向为读取时执行等时数据读取。  | 
| [IsoTransferWrite](#isotransferwrite) ([in] struct [UsbDev](_usb_dev.md) dev, [in] struct [UsbPipe](_usb_pipe.md) pipe, [in] int timeout, [in] unsigned char[] data) | 在USB设备指定端点方向为写入时执行等时数据写入。  | 
| [RequestQueue](#requestqueue) ([in] struct [UsbDev](_usb_dev.md) dev, [in] struct [UsbPipe](_usb_pipe.md) pipe, [in] unsigned char[] clientData, [in] unsigned char[] buffer) | 在USB设备指定端点上进行异步数据发送或者接收请求,数据传输方向由端点方向决定。  | 
| [RequestWait](#requestwait) ([in] struct [UsbDev](_usb_dev.md) dev, [out] unsigned char[] clientData, [out] unsigned char[] buffer, [in] int timeout) | 等待RequestQueue异步请求的操作结果。  | 
| [RequestCancel](#requestcancel) ([in] struct [UsbDev](_usb_dev.md) dev, [in] struct [UsbPipe](_usb_pipe.md) pipe) | 取消待处理的数据请求。  | 
| [GetCurrentFunctions](#getcurrentfunctions) ([out] int funcs) | 获取USB设备当前的功能(按位域表示)。  | 
| [SetCurrentFunctions](#setcurrentfunctions) ([in] int funcs) | 设置USB设备当前的功能(按位域表示)。  | 
| [SetPortRole](#setportrole) ([in] int portId, [in] int powerRole, [in] int dataRole) | 设置USB设备端口的角色。  | 
| [QueryPort](#queryport) ([out] int portId, [out] int powerRole, [out] int dataRole, [out] int mode) | 查询USB设备端口的当前设置信息。  | 
| [BindUsbdSubscriber](#bindusbdsubscriber) ([in] [IUsbdSubscriber](interface_i_usbd_subscriber.md) subscriber) | 绑定订阅者。  | 
| [UnbindUsbdSubscriber](#unbindusbdsubscriber) ([in] [IUsbdSubscriber](interface_i_usbd_subscriber.md) subscriber) | 解绑订阅者。  | 
| [RegBulkCallback](#regbulkcallback) ([in] struct [UsbDev](_usb_dev.md) dev, [in] struct [UsbPipe](_usb_pipe.md) pipe, [in] [IUsbdBulkCallback](interface_i_usbd_bulk_callback.md) cb) | 注册批量传输异步回调函数。  | 
| [UnRegBulkCallback](#unregbulkcallback) ([in] struct [UsbDev](_usb_dev.md) dev, [in] struct [UsbPipe](_usb_pipe.md) pipe) | 注销批量传输异步回调函数。  | 
| [BulkRead](#bulkread) ([in] struct [UsbDev](_usb_dev.md) dev, [in] struct [UsbPipe](_usb_pipe.md) pipe, [in] Ashmem ashmem) | 批量传输异步读数据。  | 
| [BulkWrite](#bulkwrite) ([in] struct [UsbDev](_usb_dev.md) dev, [in] struct [UsbPipe](_usb_pipe.md) pipe, [in] Ashmem ashmem) | 批量传输异步写数据。  | 
| [BulkCancel](#bulkcancel) ([in] struct [UsbDev](_usb_dev.md) dev, [in] struct [UsbPipe](_usb_pipe.md) pipe) | 批量传输异步取消接口,用于取消当前接口的异步批量读写操作。  | 


## 成员函数说明
D
duangavin123 已提交
59 60 61 62 63 64 65 66


### BindUsbdSubscriber()

  
```
IUsbInterface::BindUsbdSubscriber ([in] IUsbdSubscriber subscriber)
```
Z
z00524957 已提交
67
**描述:**
D
duangavin123 已提交
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
绑定订阅者。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
| subscriber | 订阅者信息,详见[IUsbdSubscriber](interface_i_usbd_subscriber.md)。 | 

**返回:**

0 表示操作成功。

非零值 表示操作失败。


### BulkCancel()

  
```
IUsbInterface::BulkCancel ([in] struct UsbDev dev, [in] struct UsbPipe pipe )
```
Z
z00524957 已提交
89
**描述:**
D
duangavin123 已提交
90 91 92 93 94 95
批量传输异步取消接口,用于取消当前接口的异步批量读写操作。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
z00524957 已提交
96
| dev | USB设备地址信息,详见[UsbDev](_usb_dev.md)  | 
D
duangavin123 已提交
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
| pipe | USB设备管道信息,详见[UsbPipe](_usb_pipe.md)。 | 

**返回:**

0 表示操作成功。

非零值 表示操作失败。


### BulkRead()

  
```
IUsbInterface::BulkRead ([in] struct UsbDev dev, [in] struct UsbPipe pipe, [in] Ashmem ashmem )
```
Z
z00524957 已提交
112
**描述:**
D
duangavin123 已提交
113 114 115 116 117 118
批量传输异步读数据。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
z00524957 已提交
119 120
| dev | USB设备地址信息,详见[UsbDev](_usb_dev.md)  | 
| pipe | USB设备管道信息,详见[UsbPipe](_usb_pipe.md)  | 
D
duangavin123 已提交
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
| ashmem | 共享内存,用于存放读取的数据。 | 

**返回:**

0 表示操作成功。

非零值 表示操作失败。


### BulkTransferRead()

  
```
IUsbInterface::BulkTransferRead ([in] struct UsbDev dev, [in] struct UsbPipe pipe, [in] int timeout, [out] unsigned char[] data )
```
Z
z00524957 已提交
136
**描述:**
D
duangavin123 已提交
137 138 139 140 141 142
在USB设备指定端点方向为读取时,执行批量数据读取。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
z00524957 已提交
143 144 145
| dev | USB设备地址信息,详见[UsbDev](_usb_dev.md)  | 
| pipe | USB设备管道信息,详见[UsbPipe](_usb_pipe.md)  | 
| timeout | 超时时间。  | 
D
duangavin123 已提交
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
| data | 读取的数据。 | 

**返回:**

0 表示操作成功。

非零值 表示操作失败。


### BulkTransferWrite()

  
```
IUsbInterface::BulkTransferWrite ([in] struct UsbDev dev, [in] struct UsbPipe pipe, [in] int timeout, [in] unsigned char[] data )
```
Z
z00524957 已提交
161
**描述:**
D
duangavin123 已提交
162 163 164 165 166 167
在USB设备指定端点方向为写入时,执行批量数据写入。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
z00524957 已提交
168 169 170
| dev | USB设备地址信息,详见[UsbDev](_usb_dev.md)  | 
| pipe | USB设备管道信息,详见[UsbPipe](_usb_pipe.md)  | 
| timeout | 超时时间。  | 
D
duangavin123 已提交
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
| data | 写入的数据。 | 

**返回:**

0 表示操作成功。

非零值 表示操作失败。


### BulkWrite()

  
```
IUsbInterface::BulkWrite ([in] struct UsbDev dev, [in] struct UsbPipe pipe, [in] Ashmem ashmem )
```
Z
z00524957 已提交
186
**描述:**
D
duangavin123 已提交
187 188 189 190 191 192
批量传输异步写数据。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
z00524957 已提交
193 194
| dev | USB设备地址信息,详见[UsbDev](_usb_dev.md)  | 
| pipe | USB设备管道信息,详见[UsbPipe](_usb_pipe.md)  | 
D
duangavin123 已提交
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
| ashmem | 为共享内存,用于存放需要写入的数据。 | 

**返回:**

0 表示操作成功。

非零值 表示操作失败。


### ClaimInterface()

  
```
IUsbInterface::ClaimInterface ([in] struct UsbDev dev, [in] unsigned char interfaceid, [in] unsigned char force )
```
Z
z00524957 已提交
210
**描述:**
D
duangavin123 已提交
211 212 213 214 215 216
打开USB设备的接口并声明独占,必须在数据传输前执行。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
z00524957 已提交
217 218
| dev | USB设备地址信息,详见[UsbDev](_usb_dev.md)  | 
| interfaceid | USB设备接口ID。  | 
D
duangavin123 已提交
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
| force | 是否强制,1表示强制,0表示不强制。 | 

**返回:**

0 表示操作成功。

非零值 表示操作失败。


### CloseDevice()

  
```
IUsbInterface::CloseDevice ([in] struct UsbDev dev)
```
Z
z00524957 已提交
234
**描述:**
D
duangavin123 已提交
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
关闭设备,释放与设备相关的所有系统资源。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
| dev | USB设备地址信息,详见[UsbDev](_usb_dev.md)。 | 

**返回:**

0 表示操作成功。

非零值 表示操作失败。


### ControlTransferRead()

  
```
IUsbInterface::ControlTransferRead ([in] struct UsbDev dev, [in] struct UsbCtrlTransfer ctrl, [out] unsigned char[] data )
```
Z
z00524957 已提交
256
**描述:**
D
duangavin123 已提交
257 258 259 260 261 262
在传输状态为读取并且控制端点是端点零时,对USB设备执行控制传输。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
z00524957 已提交
263 264
| dev | USB设备地址信息,详见[UsbDev](_usb_dev.md)  | 
| ctrl | USB设备控制数据,详见[UsbCtrlTransfer](_usb_ctrl_transfer.md)  | 
D
duangavin123 已提交
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
| data | 读取的数据。 | 

**返回:**

0 表示成功。

非零值 表示失败。


### ControlTransferWrite()

  
```
IUsbInterface::ControlTransferWrite ([in] struct UsbDev dev, [in] struct UsbCtrlTransfer ctrl, [in] unsigned char[] data )
```
Z
z00524957 已提交
280
**描述:**
D
duangavin123 已提交
281 282 283 284 285 286
在传输状态为写入并且控制端点是端点零时,对USB设备执行控制传输。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
z00524957 已提交
287 288
| dev | USB设备地址信息,详见[UsbDev](_usb_dev.md)  | 
| ctrl | USB设备控制数据,详见[UsbCtrlTransfer](_usb_ctrl_transfer.md)  | 
D
duangavin123 已提交
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
| data | 写入的数据。 | 

**返回:**

0 表示成功。

非零值 表示失败。


### GetConfig()

  
```
IUsbInterface::GetConfig ([in] struct UsbDev dev, [out] unsigned char configIndex )
```
Z
z00524957 已提交
304
**描述:**
D
duangavin123 已提交
305 306 307 308 309 310
获取USB设备当前的配置信息。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
z00524957 已提交
311
| dev | USB设备地址信息,详见[UsbDev](_usb_dev.md)  | 
D
duangavin123 已提交
312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
| configIndex | USB设备配置信息的字符串描述符索引值(数字字符串)。 | 

**返回:**

0 表示操作成功。

非零值 表示操作失败。


### GetConfigDescriptor()

  
```
IUsbInterface::GetConfigDescriptor ([in] struct UsbDev dev, [in] unsigned char descId, [out] unsigned char[] descriptor )
```
Z
z00524957 已提交
327
**描述:**
D
duangavin123 已提交
328 329 330 331 332 333
根据设备的配置ID获取配置描述符,配置描述符包含有关配置及其接口、备用设置及其终结点的信息。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
z00524957 已提交
334 335
| dev | USB设备地址信息,详见[UsbDev](_usb_dev.md)  | 
| descId | USB设备的配置ID。  | 
D
duangavin123 已提交
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
| descriptor | 获取USB设备配置信息。 | 

**返回:**

0 表示操作成功。

非零值 表示操作失败。


### GetCurrentFunctions()

  
```
IUsbInterface::GetCurrentFunctions ([out] int funcs)
```
Z
z00524957 已提交
351
**描述:**
D
duangavin123 已提交
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372
获取USB设备当前的功能(按位域表示)。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
| funcs | 设备当前的功能值。 | 

**返回:**

0 表示操作成功。

非零值 表示操作失败。


### GetDeviceDescriptor()

  
```
IUsbInterface::GetDeviceDescriptor ([in] struct UsbDev dev, [out] unsigned char[] descriptor )
```
Z
z00524957 已提交
373
**描述:**
D
duangavin123 已提交
374 375 376 377 378 379
获取设备描述符,设备描述符提供了关于设备、设备的配置以及任何设备所归属的类的信息。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
z00524957 已提交
380
| dev | USB设备地址信息,详见[UsbDev](_usb_dev.md)  | 
D
duangavin123 已提交
381 382 383 384 385 386 387 388 389 390 391 392 393 394 395
| descriptor | USB设备的描述符信息。 | 

**返回:**

0 表示操作成功。

非零值 表示操作失败。


### GetFileDescriptor()

  
```
IUsbInterface::GetFileDescriptor ([in] struct UsbDev dev, [out] int fd )
```
Z
z00524957 已提交
396
**描述:**
D
duangavin123 已提交
397 398 399 400 401 402
获取USB设备的文件描述符。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
z00524957 已提交
403
| dev | USB设备地址信息,详见[UsbDev](_usb_dev.md)  | 
D
duangavin123 已提交
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
| fd | USB设备的文件描述符。 | 

**返回:**

0 表示操作成功。

非零值 表示操作失败。


### GetRawDescriptor()

  
```
IUsbInterface::GetRawDescriptor ([in] struct UsbDev dev, [out] unsigned char[] descriptor )
```
Z
z00524957 已提交
419
**描述:**
D
duangavin123 已提交
420 421 422 423 424 425
获取USB设备的原始描述符。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
z00524957 已提交
426
| dev | USB设备地址信息,详见[UsbDev](_usb_dev.md)  | 
D
duangavin123 已提交
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
| descriptor | USB设备的原始描述符。 | 

**返回:**

0 表示操作成功。

非零值 表示操作失败。


### GetStringDescriptor()

  
```
IUsbInterface::GetStringDescriptor ([in] struct UsbDev dev, [in] unsigned char descId, [out] unsigned char[] descriptor )
```
Z
z00524957 已提交
442
**描述:**
D
duangavin123 已提交
443 444 445 446 447 448
根据设备的字符串ID获取字符串描述符,字符串描述符是提供一些设备接口相关的描述性信息,比如厂商的名字、产品序列号等。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
z00524957 已提交
449 450
| dev | USB设备地址信息,详见[UsbDev](_usb_dev.md)  | 
| descId | USB设备的描述符ID。  | 
D
duangavin123 已提交
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
| descriptor | 获取USB设备的字符串描述符。 | 

**返回:**

0 表示操作成功。

非零值 表示操作失败。


### InterruptTransferRead()

  
```
IUsbInterface::InterruptTransferRead ([in] struct UsbDev dev, [in] struct UsbPipe pipe, [in] int timeout, [out] unsigned char[] data )
```
Z
z00524957 已提交
466
**描述:**
D
duangavin123 已提交
467 468 469 470 471 472
在USB设备指定端点方向为数据读取时执行中断数据读取。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
z00524957 已提交
473 474 475
| dev | USB设备地址信息,详见[UsbDev](_usb_dev.md)  | 
| pipe | USB设备管道信息,详见[UsbPipe](_usb_pipe.md)  | 
| timeout | 超时时间。  | 
D
duangavin123 已提交
476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
| data | 读取的数据。 | 

**返回:**

0 表示操作成功。

非零值 表示操作失败。


### InterruptTransferWrite()

  
```
IUsbInterface::InterruptTransferWrite ([in] struct UsbDev dev, [in] struct UsbPipe pipe, [in] int timeout, [in] unsigned char[] data )
```
Z
z00524957 已提交
491
**描述:**
D
duangavin123 已提交
492 493 494 495 496 497
在USB设备指定端点方向为写入时执行中断数据写入。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
z00524957 已提交
498 499 500
| dev | USB设备地址信息,详见[UsbDev](_usb_dev.md)  | 
| pipe | USB设备管道信息,详见[UsbPipe](_usb_pipe.md)  | 
| timeout | 超时时间。  | 
D
duangavin123 已提交
501 502 503 504 505 506 507 508 509 510 511 512 513 514 515
| data | 写入的数据。 | 

**返回:**

0 表示操作成功。

非零值 表示操作失败。


### IsoTransferRead()

  
```
IUsbInterface::IsoTransferRead ([in] struct UsbDev dev, [in] struct UsbPipe pipe, [in] int timeout, [out] unsigned char[] data )
```
Z
z00524957 已提交
516
**描述:**
D
duangavin123 已提交
517 518 519 520 521 522
在USB设备指定端点方向为读取时执行等时数据读取。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
z00524957 已提交
523 524 525
| dev | USB设备地址信息,详见[UsbDev](_usb_dev.md)  | 
| pipe | USB设备管道信息,详见[UsbPipe](_usb_pipe.md)  | 
| timeout | 超时时间。  | 
D
duangavin123 已提交
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
| data | 读取的数据。 | 

**返回:**

0 表示操作成功。

非零值 表示操作失败。


### IsoTransferWrite()

  
```
IUsbInterface::IsoTransferWrite ([in] struct UsbDev dev, [in] struct UsbPipe pipe, [in] int timeout, [in] unsigned char[] data )
```
Z
z00524957 已提交
541
**描述:**
D
duangavin123 已提交
542 543 544 545 546 547
在USB设备指定端点方向为写入时执行等时数据写入。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
z00524957 已提交
548 549 550
| dev | USB设备地址信息,详见[UsbDev](_usb_dev.md)  | 
| pipe | USB设备管道信息,详见[UsbPipe](_usb_pipe.md)  | 
| timeout | 超时时间。  | 
D
duangavin123 已提交
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
| data | 写入的数据。 | 

**返回:**

0 表示操作成功。

非零值 表示操作失败。


### OpenDevice()

  
```
IUsbInterface::OpenDevice ([in] struct UsbDev dev)
```
Z
z00524957 已提交
566
**描述:**
D
duangavin123 已提交
567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587
打开设备,建立连接。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
| dev | USB设备地址信息,详见[UsbDev](_usb_dev.md)。 | 

**返回:**

0 表示操作成功。

非零值 表示操作失败。


### QueryPort()

  
```
IUsbInterface::QueryPort ([out] int portId, [out] int powerRole, [out] int dataRole, [out] int mode )
```
Z
z00524957 已提交
588
**描述:**
D
duangavin123 已提交
589 590 591 592 593 594
查询USB设备端口的当前设置信息。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
z00524957 已提交
595 596 597
| portId | USB设备端口ID。  | 
| powerRole | USB设备电源角色。  | 
| dataRole | USB设备数据角色。  | 
D
duangavin123 已提交
598 599 600 601 602 603 604 605 606 607 608 609 610 611 612
| mode | USB设备模式。 | 

**返回:**

0 表示操作成功。

非零值 表示操作失败。


### RegBulkCallback()

  
```
IUsbInterface::RegBulkCallback ([in] struct UsbDev dev, [in] struct UsbPipe pipe, [in] IUsbdBulkCallback cb )
```
Z
z00524957 已提交
613
**描述:**
D
duangavin123 已提交
614 615 616 617 618 619
注册批量传输异步回调函数。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
z00524957 已提交
620 621
| dev | USB设备地址信息,详见[UsbDev](_usb_dev.md)  | 
| pipe | USB设备管道信息,详见[UsbPipe](_usb_pipe.md)  | 
D
duangavin123 已提交
622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
| cb | 回调函数对象,详见[IUsbdBulkCallback](interface_i_usbd_bulk_callback.md)。 | 

**返回:**

0 表示操作成功。

非零值 表示操作失败。


### ReleaseInterface()

  
```
IUsbInterface::ReleaseInterface ([in] struct UsbDev dev, [in] unsigned char interfaceid )
```
Z
z00524957 已提交
637
**描述:**
D
duangavin123 已提交
638 639 640 641 642 643
在停止数据传输后关闭占用的USB设备接口,并释放相关资源。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
z00524957 已提交
644
| dev | USB设备地址信息,详见[UsbDev](_usb_dev.md)  | 
D
duangavin123 已提交
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659
| interfaceid | USB设备接口ID。 | 

**返回:**

0 表示操作成功。

非零值 表示操作失败。


### RequestCancel()

  
```
IUsbInterface::RequestCancel ([in] struct UsbDev dev, [in] struct UsbPipe pipe )
```
Z
z00524957 已提交
660
**描述:**
D
duangavin123 已提交
661 662 663 664 665 666
取消待处理的数据请求。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
z00524957 已提交
667
| dev | USB设备地址信息,详见[UsbDev](_usb_dev.md)  | 
D
duangavin123 已提交
668 669 670 671 672 673 674 675 676 677 678 679 680 681 682
| pipe | USB设备管道信息,详见[UsbPipe](_usb_pipe.md)。 | 

**返回:**

0 表示操作成功。

非零值 表示操作失败。


### RequestQueue()

  
```
IUsbInterface::RequestQueue ([in] struct UsbDev dev, [in] struct UsbPipe pipe, [in] unsigned char[] clientData, [in] unsigned char[] buffer )
```
Z
z00524957 已提交
683
**描述:**
D
duangavin123 已提交
684 685 686 687 688 689
在USB设备指定端点上进行异步数据发送或者接收请求,数据传输方向由端点方向决定。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
z00524957 已提交
690 691 692
| dev | USB设备地址信息,详见[UsbDev](_usb_dev.md)  | 
| pipe | USB设备管道信息,详见[UsbPipe](_usb_pipe.md)  | 
| clientData | 用户数据。  | 
D
duangavin123 已提交
693 694 695 696 697 698 699 700 701 702 703 704 705 706 707
| buffer | 传输的数据。 | 

**返回:**

0 表示操作成功。

非零值 表示操作失败。


### RequestWait()

  
```
IUsbInterface::RequestWait ([in] struct UsbDev dev, [out] unsigned char[] clientData, [out] unsigned char[] buffer, [in] int timeout )
```
Z
z00524957 已提交
708
**描述:**
D
duangavin123 已提交
709 710 711 712 713 714
等待RequestQueue异步请求的操作结果。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
z00524957 已提交
715 716 717
| dev | USB设备地址信息,详见[UsbDev](_usb_dev.md)  | 
| clientData | 用户数据。  | 
| buffer | 传输的数据。  | 
D
duangavin123 已提交
718 719 720 721 722 723 724 725 726 727 728 729 730 731 732
| timeout | 超时时间。 | 

**返回:**

0 表示操作成功。

非零值 表示操作失败。


### SetConfig()

  
```
IUsbInterface::SetConfig ([in] struct UsbDev dev, [in] unsigned char configIndex )
```
Z
z00524957 已提交
733
**描述:**
D
duangavin123 已提交
734 735 736 737 738 739
设置USB设备当前的配置信息,USB设备被主机配置过后,主机可以使用设备提供的所有功能。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
z00524957 已提交
740
| dev | USB设备地址信息,详见[UsbDev](_usb_dev.md)  | 
D
duangavin123 已提交
741 742 743 744 745 746 747 748 749 750 751 752 753 754 755
| configIndex | USB设备配置信息的字符串描述符索引值(数字字符串)。 | 

**返回:**

0 表示操作成功。

非零值 表示操作失败。


### SetCurrentFunctions()

  
```
IUsbInterface::SetCurrentFunctions ([in] int funcs)
```
Z
z00524957 已提交
756
**描述:**
D
duangavin123 已提交
757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
设置USB设备当前的功能(按位域表示)。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
| funcs | 待设置的设备功能值。 | 

**返回:**

0 表示操作成功。

非零值 表示操作失败。


### SetInterface()

  
```
IUsbInterface::SetInterface ([in] struct UsbDev dev, [in] unsigned char interfaceid, [in] unsigned char altIndex )
```
Z
z00524957 已提交
778
**描述:**
D
duangavin123 已提交
779 780 781 782 783 784
设置USB设备指定接口的备选设置,用于在具有相同ID但不同备用设置的两个接口之间进行选择。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
z00524957 已提交
785 786
| dev | USB设备地址信息,详见[UsbDev](_usb_dev.md)  | 
| interfaceid | USB设备接口ID。  | 
D
duangavin123 已提交
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801
| altIndex | USB设备接口的备用设置信息。 | 

**返回:**

0 表示操作成功。

非零值 表示操作失败。


### SetPortRole()

  
```
IUsbInterface::SetPortRole ([in] int portId, [in] int powerRole, [in] int dataRole )
```
Z
z00524957 已提交
802
**描述:**
D
duangavin123 已提交
803 804 805 806 807 808
设置USB设备端口的角色。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
z00524957 已提交
809 810
| portId | USB设备端口ID。  | 
| powerRole | 电源角色的值。  | 
D
duangavin123 已提交
811 812 813 814 815 816 817 818 819 820 821 822 823 824 825
| dataRole | 数据角色的值。 | 

**返回:**

0 表示操作成功。

非零值 表示操作失败。


### UnbindUsbdSubscriber()

  
```
IUsbInterface::UnbindUsbdSubscriber ([in] IUsbdSubscriber subscriber)
```
Z
z00524957 已提交
826
**描述:**
D
duangavin123 已提交
827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847
解绑订阅者。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
| subscriber | 订阅者信息,详见[IUsbdSubscriber](interface_i_usbd_subscriber.md)。 | 

**返回:**

0 表示操作成功。

非零值 表示操作失败。


### UnRegBulkCallback()

  
```
IUsbInterface::UnRegBulkCallback ([in] struct UsbDev dev, [in] struct UsbPipe pipe )
```
Z
z00524957 已提交
848
**描述:**
D
duangavin123 已提交
849 850 851 852 853 854
注销批量传输异步回调函数。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
Z
z00524957 已提交
855
| dev | USB设备地址信息,详见[UsbDev](_usb_dev.md)  | 
D
duangavin123 已提交
856 857 858 859 860 861 862
| pipe | USB设备管道信息,详见[UsbPipe](_usb_pipe.md)。 | 

**返回:**

0 表示操作成功。

非零值 表示操作失败。