IUsbInterface

概述

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

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

相关模块:

USB

汇总

Public 成员函数

成员函数说明

BindUsbdSubscriber()

IUsbInterface::BindUsbdSubscriber ([in] IUsbdSubscriber subscriber)

描述: 绑定订阅者。

参数:

返回:

0 表示操作成功。

非零值 表示操作失败。

BulkCancel()

IUsbInterface::BulkCancel ([in] struct UsbDev dev, [in] struct UsbPipe pipe )

描述: 批量传输异步取消接口，用于取消当前接口的异步批量读写操作。

参数:

返回:

0 表示操作成功。

非零值 表示操作失败。

BulkRead()

IUsbInterface::BulkRead ([in] struct UsbDev dev, [in] struct UsbPipe pipe, [in] Ashmem ashmem )

描述: 批量传输异步读数据。

参数:

返回:

0 表示操作成功。

非零值 表示操作失败。

BulkTransferRead()

IUsbInterface::BulkTransferRead ([in] struct UsbDev dev, [in] struct UsbPipe pipe, [in] int timeout, [out] unsigned char[] data )

描述: 在USB设备指定端点方向为读取时，执行批量数据读取。

参数:

返回:

0 表示操作成功。

非零值 表示操作失败。

BulkTransferWrite()

IUsbInterface::BulkTransferWrite ([in] struct UsbDev dev, [in] struct UsbPipe pipe, [in] int timeout, [in] unsigned char[] data )

描述: 在USB设备指定端点方向为写入时，执行批量数据写入。

参数:

返回:

0 表示操作成功。

非零值 表示操作失败。

BulkWrite()

IUsbInterface::BulkWrite ([in] struct UsbDev dev, [in] struct UsbPipe pipe, [in] Ashmem ashmem )

描述: 批量传输异步写数据。

参数:

返回:

0 表示操作成功。

非零值 表示操作失败。

ClaimInterface()

IUsbInterface::ClaimInterface ([in] struct UsbDev dev, [in] unsigned char interfaceid, [in] unsigned char force )

描述: 打开USB设备的接口并声明独占，必须在数据传输前执行。

参数:

返回:

0 表示操作成功。

非零值 表示操作失败。

CloseDevice()

IUsbInterface::CloseDevice ([in] struct UsbDev dev)

描述: 关闭设备，释放与设备相关的所有系统资源。

参数:

返回:

0 表示操作成功。

非零值 表示操作失败。

ControlTransferRead()

IUsbInterface::ControlTransferRead ([in] struct UsbDev dev, [in] struct UsbCtrlTransfer ctrl, [out] unsigned char[] data )

描述: 在传输状态为读取并且控制端点是端点零时，对USB设备执行控制传输。

参数:

返回:

0 表示成功。

非零值 表示失败。

ControlTransferWrite()

IUsbInterface::ControlTransferWrite ([in] struct UsbDev dev, [in] struct UsbCtrlTransfer ctrl, [in] unsigned char[] data )

描述: 在传输状态为写入并且控制端点是端点零时，对USB设备执行控制传输。

参数:

返回:

0 表示成功。

非零值 表示失败。

GetConfig()

IUsbInterface::GetConfig ([in] struct UsbDev dev, [out] unsigned char configIndex )

描述: 获取USB设备当前的配置信息。

参数:

返回:

0 表示操作成功。

非零值 表示操作失败。

GetConfigDescriptor()

IUsbInterface::GetConfigDescriptor ([in] struct UsbDev dev, [in] unsigned char descId, [out] unsigned char[] descriptor )

描述: 根据设备的配置ID获取配置描述符，配置描述符包含有关配置及其接口、备用设置及其终结点的信息。

参数:

返回:

0 表示操作成功。

非零值 表示操作失败。

GetCurrentFunctions()

IUsbInterface::GetCurrentFunctions ([out] int funcs)

描述: 获取USB设备当前的功能（按位域表示）。

参数:

返回:

0 表示操作成功。

非零值 表示操作失败。

GetDeviceDescriptor()

IUsbInterface::GetDeviceDescriptor ([in] struct UsbDev dev, [out] unsigned char[] descriptor )

描述: 获取设备描述符，设备描述符提供了关于设备、设备的配置以及任何设备所归属的类的信息。

参数:

返回:

0 表示操作成功。

非零值 表示操作失败。

GetFileDescriptor()

IUsbInterface::GetFileDescriptor ([in] struct UsbDev dev, [out] int fd )

描述: 获取USB设备的文件描述符。

参数:

返回:

0 表示操作成功。

非零值 表示操作失败。

GetRawDescriptor()

IUsbInterface::GetRawDescriptor ([in] struct UsbDev dev, [out] unsigned char[] descriptor )

描述: 获取USB设备的原始描述符。

参数:

返回:

0 表示操作成功。

非零值 表示操作失败。

GetStringDescriptor()

IUsbInterface::GetStringDescriptor ([in] struct UsbDev dev, [in] unsigned char descId, [out] unsigned char[] descriptor )

描述: 根据设备的字符串ID获取字符串描述符，字符串描述符是提供一些设备接口相关的描述性信息，比如厂商的名字、产品序列号等。

参数:

返回:

0 表示操作成功。

非零值 表示操作失败。

InterruptTransferRead()

IUsbInterface::InterruptTransferRead ([in] struct UsbDev dev, [in] struct UsbPipe pipe, [in] int timeout, [out] unsigned char[] data )

描述: 在USB设备指定端点方向为数据读取时执行中断数据读取。

参数:

返回:

0 表示操作成功。

非零值 表示操作失败。

InterruptTransferWrite()

IUsbInterface::InterruptTransferWrite ([in] struct UsbDev dev, [in] struct UsbPipe pipe, [in] int timeout, [in] unsigned char[] data )

描述: 在USB设备指定端点方向为写入时执行中断数据写入。

参数:

返回:

0 表示操作成功。

非零值 表示操作失败。

IsoTransferRead()

IUsbInterface::IsoTransferRead ([in] struct UsbDev dev, [in] struct UsbPipe pipe, [in] int timeout, [out] unsigned char[] data )

描述: 在USB设备指定端点方向为读取时执行等时数据读取。

参数:

返回:

0 表示操作成功。

非零值 表示操作失败。

IsoTransferWrite()

IUsbInterface::IsoTransferWrite ([in] struct UsbDev dev, [in] struct UsbPipe pipe, [in] int timeout, [in] unsigned char[] data )

描述: 在USB设备指定端点方向为写入时执行等时数据写入。

参数:

返回:

0 表示操作成功。

非零值 表示操作失败。

OpenDevice()

IUsbInterface::OpenDevice ([in] struct UsbDev dev)

描述: 打开设备，建立连接。

参数:

返回:

0 表示操作成功。

非零值 表示操作失败。

QueryPort()

IUsbInterface::QueryPort ([out] int portId, [out] int powerRole, [out] int dataRole, [out] int mode )

描述: 查询USB设备端口的当前设置信息。

参数:

返回:

0 表示操作成功。

非零值 表示操作失败。

RegBulkCallback()

IUsbInterface::RegBulkCallback ([in] struct UsbDev dev, [in] struct UsbPipe pipe, [in] IUsbdBulkCallback cb )

描述: 注册批量传输异步回调函数。

参数:

返回:

0 表示操作成功。

非零值 表示操作失败。

ReleaseInterface()

IUsbInterface::ReleaseInterface ([in] struct UsbDev dev, [in] unsigned char interfaceid )

描述: 在停止数据传输后关闭占用的USB设备接口，并释放相关资源。

参数:

返回:

0 表示操作成功。

非零值 表示操作失败。

RequestCancel()

IUsbInterface::RequestCancel ([in] struct UsbDev dev, [in] struct UsbPipe pipe )

描述: 取消待处理的数据请求。

参数:

返回:

0 表示操作成功。

非零值 表示操作失败。

RequestQueue()

IUsbInterface::RequestQueue ([in] struct UsbDev dev, [in] struct UsbPipe pipe, [in] unsigned char[] clientData, [in] unsigned char[] buffer )

描述: 在USB设备指定端点上进行异步数据发送或者接收请求，数据传输方向由端点方向决定。

参数:

返回:

0 表示操作成功。

非零值 表示操作失败。

RequestWait()

IUsbInterface::RequestWait ([in] struct UsbDev dev, [out] unsigned char[] clientData, [out] unsigned char[] buffer, [in] int timeout )

描述: 等待RequestQueue异步请求的操作结果。

参数:

返回:

0 表示操作成功。

非零值 表示操作失败。

SetConfig()

IUsbInterface::SetConfig ([in] struct UsbDev dev, [in] unsigned char configIndex )

描述: 设置USB设备当前的配置信息，USB设备被主机配置过后，主机可以使用设备提供的所有功能。

参数:

返回:

0 表示操作成功。

非零值 表示操作失败。

SetCurrentFunctions()

IUsbInterface::SetCurrentFunctions ([in] int funcs)

描述: 设置USB设备当前的功能（按位域表示）。

参数:

返回:

0 表示操作成功。

非零值 表示操作失败。

SetInterface()

IUsbInterface::SetInterface ([in] struct UsbDev dev, [in] unsigned char interfaceid, [in] unsigned char altIndex )

描述: 设置USB设备指定接口的备选设置，用于在具有相同ID但不同备用设置的两个接口之间进行选择。

参数:

返回:

0 表示操作成功。

非零值 表示操作失败。

SetPortRole()

IUsbInterface::SetPortRole ([in] int portId, [in] int powerRole, [in] int dataRole )

描述: 设置USB设备端口的角色。

参数:

返回:

0 表示操作成功。

非零值 表示操作失败。

UnbindUsbdSubscriber()

IUsbInterface::UnbindUsbdSubscriber ([in] IUsbdSubscriber subscriber)

描述: 解绑订阅者。

参数:

返回:

0 表示操作成功。

非零值 表示操作失败。

UnRegBulkCallback()

IUsbInterface::UnRegBulkCallback ([in] struct UsbDev dev, [in] struct UsbPipe pipe )

描述: 注销批量传输异步回调函数。

参数:

返回:

0 表示操作成功。

非零值 表示操作失败。