diff --git a/zh-cn/device_api/hdi/usb/usb_info.h b/zh-cn/device_api/hdi/usb/usb_info.h index 4920347cc10c6be8e3d7da25d386595926d77fc3..f380b7ef09315fa80ccdc650ab0ac8a9a8ec9a77 100644 --- a/zh-cn/device_api/hdi/usb/usb_info.h +++ b/zh-cn/device_api/hdi/usb/usb_info.h @@ -28,7 +28,7 @@ /** * @file usb_info.h * - * @brief usb驱动订阅模块使用的数据类型。 + * @brief USB驱动订阅模块使用的数据类型。 * * @since 3.0 * @version 1.0 @@ -43,28 +43,28 @@ namespace OHOS { namespace USB { /** - * @brief usb设备信息 + * @brief USB设备信息。 * */ struct USBDeviceInfo { - /** usb设备状态 */ + /** USB设备状态 */ int32_t status; - /** usb总线编号 */ + /** USB总线编号 */ int32_t busNum; - /** usb设备编号 */ + /** USB设备编号 */ int32_t devNum; }; /** - * @brief usb设备信息类 + * @brief USB设备信息类。 * */ class UsbInfo { public: /** - * @brief 设置usb设备状态 + * @brief 设置USB设备状态。 * - * @param status 输入参数,设备状态 + * @param status 输入参数,设备状态。 * * @since 3.0 * @version 1.0 @@ -75,9 +75,9 @@ public: } /** - * @brief 设置usb总线编号 + * @brief 设置USB总线编号。 * - * @param status 输入参数,usb总线编号 + * @param status 输入参数,USB总线编号。 * * @since 3.0 * @version 1.0 @@ -88,9 +88,9 @@ public: } /** - * @brief 设置usb设备编号 + * @brief 设置USB设备编号。 * - * @param status 输入参数,usb设备编号 + * @param status 输入参数,USB设备编号。 * * @since 3.0 * @version 1.0 @@ -101,9 +101,9 @@ public: } /** - * @brief 获取usb设备状态 + * @brief 获取USB设备状态。 * - * @param status 输出参数,设备状态 + * @param status 输出参数,设备状态。 * * @since 3.0 * @version 1.0 @@ -114,9 +114,9 @@ public: } /** - * @brief 获取usb总线编号 + * @brief 获取USB总线编号。 * - * @param status 输出参数,usb总线编号 + * @param status 输出参数,USB总线编号。 * * @since 3.0 * @version 1.0 @@ -127,9 +127,9 @@ public: } /** - * @brief 获取usb设备编号 + * @brief 获取USB设备编号。 * - * @param status 输出参数,usb设备编号 + * @param status 输出参数,USB设备编号。 * * @since 3.0 * @version 1.0 @@ -140,7 +140,7 @@ public: } private: - /** usb设备信息 */ + /** USB设备信息 */ USBDeviceInfo devInfo; }; } /** namespace USB */ diff --git a/zh-cn/device_api/hdi/usb/usbd_client.h b/zh-cn/device_api/hdi/usb/usbd_client.h index 0c389ba1190b79e635db7d77c68139a0ef253d71..b38c538bcfcccec0540cff4a4f310692a8eeed77 100644 --- a/zh-cn/device_api/hdi/usb/usbd_client.h +++ b/zh-cn/device_api/hdi/usb/usbd_client.h @@ -28,7 +28,7 @@ /** * @file usbd_client.h * - * @brief 声明标准usb驱动接口函数。 + * @brief 声明标准USB驱动接口函数。 * * @since 3.0 * @version 1.0 @@ -47,12 +47,12 @@ public: static UsbdClient &GetInstance(); /** - * @brief 打开设备,建立连接 + * @brief 打开设备,建立连接。 * - * @param dev 输入参数,usb设备地址信息,详见{@link UsbDev} + * @param dev 输入参数,USB设备地址信息,详见{@link UsbDev}。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -60,12 +60,12 @@ public: int32_t OpenDevice(const UsbDev &dev); /** - * @brief 关闭设备,释放与设备相关的所有系统资源 + * @brief 关闭设备,释放与设备相关的所有系统资源。 * - * @param dev 输入参数,usb设备地址信息,详见{@link UsbDev} + * @param dev 输入参数,USB设备地址信息,详见{@link UsbDev}。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -73,13 +73,13 @@ public: int32_t CloseDevice(const UsbDev &dev); /** - * @brief 获取设备描述符 + * @brief 获取设备描述符。 * - * @param dev 输入参数,usb设备地址信息,详见{@link UsbDev} - * @param descriptor 输出参数,usb设备描述符信息 + * @param dev 输入参数,USB设备地址信息,详见{@link UsbDev}。 + * @param descriptor 输出参数,USB设备描述符信息。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -87,14 +87,14 @@ public: int32_t GetDeviceDescriptor(const UsbDev &dev, std::vector &descriptor); /** - * @brief 根据String ID获取设备的字符串描述符 + * @brief 根据String ID获取设备的字符串描述符。 * - * @param dev 输入参数,usb设备地址信息,详见{@link UsbDev} - * @param descId 输入参数,usb的string ID - * @param descriptor 输出参数,获取usb设备config信息 + * @param dev 输入参数,USB设备地址信息,详见{@link UsbDev}。 + * @param descId 输入参数,USB的string ID。 + * @param descriptor 输出参数,获取USB设备config信息。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -102,14 +102,14 @@ public: int32_t GetStringDescriptor(const UsbDev &dev, uint8_t descId, std::vector &descriptor); /** - * @brief 根据config ID获取设备的配置描述符config + * @brief 根据config ID获取设备的配置描述符config。 * - * @param dev 输入参数,usb设备地址信息,详见{@link UsbDev} - * @param descId 输入参数,usb的config ID - * @param descriptor 输出参数,获取usb设备config信息 + * @param dev 输入参数,USB设备地址信息,详见{@link UsbDev}。 + * @param descId 输入参数,USB的config ID。 + * @param descriptor 输出参数,获取USB设备config信息。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -117,13 +117,13 @@ public: int32_t GetConfigDescriptor(const UsbDev &dev, uint8_t descId, std::vector &descriptor); /** - * @brief 获取原始描述符 + * @brief 获取原始描述符。 * - * @param dev 输入参数,usb设备地址信息,详见{@link UsbDev} - * @param descriptor 输出参数,usb设备原始描述符 + * @param dev 输入参数,USB设备地址信息,详见{@link UsbDev}。 + * @param descriptor 输出参数,USB设备原始描述符。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -131,13 +131,13 @@ public: int32_t GetRawDescriptor(const UsbDev &dev, std::vector &descriptor); /** - * @brief 获取文件描述符 + * @brief 获取文件描述符。 * - * @param dev 输入参数,usb设备地址信息,详见{@link UsbDev} - * @param fd 输出参数,usb设备文件描述符 + * @param dev 输入参数,USB设备地址信息,详见{@link UsbDev}。 + * @param fd 输出参数,USB设备文件描述符。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -145,13 +145,13 @@ public: int32_t GetFileDescriptor(const UsbDev &dev, int32_t &fd); /** - * @brief 设置当前的config信息 + * @brief 设置当前的config信息。 * - * @param dev 输入参数,usb设备地址信息,详见{@link UsbDev} - * @param configIndex 输入参数,usb设备config信息 + * @param dev 输入参数,USB设备地址信息,详见{@link UsbDev}。 + * @param configIndex 输入参数,USB设备config信息。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -159,13 +159,13 @@ public: int32_t SetConfig(const UsbDev &dev, uint8_t configIndex); /** - * @brief 获取当前的config信息 + * @brief 获取当前的config信息。 * - * @param dev 输入参数,usb设备地址信息,详见{@link UsbDev} - * @param configIndex 输出参数,usb设备config信息 + * @param dev 输入参数,USB设备地址信息,详见{@link UsbDev}。 + * @param configIndex 输出参数,USB设备config信息。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -173,14 +173,14 @@ public: int32_t GetConfig(const UsbDev &dev, uint8_t &configIndex); /** - * @brief 打开接口,并声明独占接口,必须在数据传输前执行 + * @brief 打开接口,并声明独占接口,必须在数据传输前执行。 * - * @param dev 输入参数,usb设备地址信息,详见{@link UsbDev} - * @param interfaceid 输入参数,usb设备interface ID - * @param force 输入参数,是否强制: 1强制 0不强制 + * @param dev 输入参数,USB设备地址信息,详见{@link UsbDev}。 + * @param interfaceid 输入参数,USB设备interface ID。 + * @param force 输入参数,是否强制: 1强制 0不强制。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -188,13 +188,13 @@ public: int32_t ClaimInterface(const UsbDev &dev, uint8_t interfaceid, uint8_t force); /** - * @brief 关闭接口,释放接口的占用,在停止数据传输后执行 + * @brief 关闭接口,释放接口的占用,在停止数据传输后执行。 * - * @param dev 输入参数,usb设备地址信息,详见{@link UsbDev} - * @param interfaceid 输入参数,usb设备interface ID + * @param dev 输入参数,USB设备地址信息,详见{@link UsbDev}。 + * @param interfaceid 输入参数,USB设备interface ID。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -202,29 +202,30 @@ public: int32_t ReleaseInterface(const UsbDev &dev, uint8_t interfaceid); /** - * @brief 设置指定接口的备选设置,用于在具有相同ID但不同备用设置的两个接口之间进行选择 + * @brief 设置指定接口的备选设置,用于在具有相同ID但不同备用设置的两个接口之间进行选择。 * - * @param dev 输入参数,usb设备地址信息,详见{@link UsbDev} - * @param interfaceid 输入参数,usb设备interface ID - * @param altIndex 输入参数,interface的AlternateSetting信息 + * @param dev 输入参数,USB设备地址信息,详见{@link UsbDev}。 + * @param interfaceid 输入参数,USB设备interface ID。 + * @param altIndex 输入参数,interface的AlternateSetting信息。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 + * * @since 3.0 * @version 1.0 */ int32_t SetInterface(const UsbDev &dev, uint8_t interfaceid, uint8_t altIndex); /** - * @brief 在给定端点上执行批量数据读取,返回读取的数据和长度,端点方向必须为数据读取,可以设置超时时间 + * @brief 在给定端点上执行批量数据读取,返回读取的数据和长度,端点方向必须为数据读取,可以设置超时时间。 * - * @param dev 输入参数,usb设备地址信息,详见{@link UsbDev} - * @param pipe 输入参数,usb设备pipe信息,详见{@link UsbPipe} - * @param timeout 输入参数,超时时间 - * @param data 输出参数,获取写入的数据 + * @param dev 输入参数,USB设备地址信息,详见{@link UsbDev}。 + * @param pipe 输入参数,USB设备pipe信息,详见{@link UsbPipe}。 + * @param timeout 输入参数,超时时间。 + * @param data 输出参数,获取写入的数据。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -232,15 +233,15 @@ public: int32_t BulkTransferRead(const UsbDev &dev, const UsbPipe &pipe, int32_t timeout, std::vector &data); /** - * @brief 在给定端点上执行批量数据写入, 返回读取的数据和长度,端点方向必须为数据写入 + * @brief 在给定端点上执行批量数据写入, 返回读取的数据和长度,端点方向必须为数据写入。 * - * @param dev 输入参数,usb设备地址信息,详见{@link UsbDev} - * @param pipe 输入参数,usb设备pipe信息,详见{@link UsbPipe} - * @param timeout 输入参数,超时时间 - * @param data 输入参数,写入的数据 + * @param dev 输入参数,USB设备地址信息,详见{@link UsbDev}。 + * @param pipe 输入参数,USB设备pipe信息,详见{@link UsbPipe}。 + * @param timeout 输入参数,超时时间。 + * @param data 输入参数,写入的数据。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -252,12 +253,12 @@ public: * @brief 对此设备执行端点零的控制事务,传输方向由请求类型决定。 如果requestType& * USB_ENDPOINT_DIR_MASK是USB_DIR_OUT ,则传输是写入,如果是USB_DIR_IN ,则传输是读取。 * - * @param dev 输入参数,usb设备地址信息,详见{@link UsbDev} - * @param ctrl 输入参数,usb设备控制数据包结构,详见{@link UsbCtrlTransfer} - * @param data 输入/输出参数,读取/写入的数据 + * @param dev 输入参数,USB设备地址信息,详见{@link UsbDev}。 + * @param ctrl 输入参数,USB设备控制数据包结构,详见{@link UsbCtrlTransfer}。 + * @param data 输入/输出参数,读取/写入的数据。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -265,15 +266,15 @@ public: int32_t ControlTransfer(const UsbDev &dev, const UsbCtrlTransfer &ctrl, std::vector &data); /** - * @brief 在给定端点上执行中断数据读取, 返回读取的数据和长度,端点方向必须为数据读取 + * @brief 在给定端点上执行中断数据读取, 返回读取的数据和长度,端点方向必须为数据读取。 * - * @param dev 输入参数,usb设备地址信息,详见{@link UsbDev} - * @param pipe 输入参数,usb设备pipe信息,详见{@link UsbPipe} - * @param timeout 输入参数,超时时间 - * @param data 输出参数,读取的数据 + * @param dev 输入参数,USB设备地址信息,详见{@link UsbDev}。 + * @param pipe 输入参数,USB设备pipe信息,详见{@link UsbPipe}。 + * @param timeout 输入参数,超时时间。 + * @param data 输出参数,读取的数据。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -281,15 +282,15 @@ public: int32_t InterruptTransferRead(const UsbDev &dev, const UsbPipe &pipe, int32_t timeout, std::vector &data); /** - * @brief 在给定端点上执行中断数据写入, 返回读取的数据和长度,端点方向必须为数据写入 + * @brief 在给定端点上执行中断数据写入, 返回读取的数据和长度,端点方向必须为数据写入。 * - * @param dev 输入参数,usb设备地址信息,详见{@link UsbDev} - * @param pipe 输入参数,usb设备pipe信息,详见{@link UsbPipe} - * @param timeout 输入参数,超时时间 - * @param data 输入参数,写入的数据 + * @param dev 输入参数,USB设备地址信息,详见{@link UsbDev}。 + * @param pipe 输入参数,USB设备pipe信息,详见{@link UsbPipe}。 + * @param timeout 输入参数,超时时间。 + * @param data 输入参数,写入的数据。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -297,15 +298,15 @@ public: int32_t InterruptTransferWrite(const UsbDev &dev, const UsbPipe &pipe, int32_t timeout, std::vector &data); /** - * @brief 在给定端点上执行等时数据读取, 返回读取的数据和长度,端点方向必须为数据读取 + * @brief 在给定端点上执行等时数据读取, 返回读取的数据和长度,端点方向必须为数据读取。 * - * @param dev 输入参数,usb设备地址信息,详见{@link UsbDev} - * @param pipe 输入参数,usb设备pipe信息,详见{@link UsbPipe} - * @param timeout 输入参数,超时时间 - * @param data 输出参数,读取的数据 + * @param dev 输入参数,USB设备地址信息,详见{@link UsbDev}。 + * @param pipe 输入参数,USB设备pipe信息,详见{@link UsbPipe}。 + * @param timeout 输入参数,超时时间。 + * @param data 输出参数,读取的数据。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -313,15 +314,15 @@ public: int32_t IsoTransferRead(const UsbDev &dev, const UsbPipe &pipe, int32_t timeout, std::vector &data); /** - * @brief 在给定端点上执行等时数据写入, 返回读取的数据和长度,端点方向必须为数据写入 + * @brief 在给定端点上执行等时数据写入, 返回读取的数据和长度,端点方向必须为数据写入。 * - * @param dev 输入参数,usb设备地址信息,详见{@link UsbDev} - * @param pipe 输入参数,usb设备pipe信息,详见{@link UsbPipe} - * @param timeout 输入参数,超时时间 - * @param data 输入参数,读取的数据 + * @param dev 输入参数,USB设备地址信息,详见{@link UsbDev}。 + * @param pipe 输入参数,USB设备pipe信息,详见{@link UsbPipe}。 + * @param timeout 输入参数,超时时间。 + * @param data 输入参数,读取的数据。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -329,15 +330,15 @@ public: int32_t IsoTransferWrite(const UsbDev &dev, const UsbPipe &pipe, int32_t timeout, std::vector &data); /** - * @brief 将指定的端点进行异步数据发送或者接收请求,数据传输方向由端点方向决定 + * @brief 将指定的端点进行异步数据发送或者接收请求,数据传输方向由端点方向决定。 * - * @param dev 输入参数,usb设备地址信息,详见{@link UsbDev} - * @param pipe 输入参数,usb设备pipe信息,详见{@link UsbPipe} - * @param clientData 输入参数,用户数据 - * @param buffer 输入参数,传输的数据 + * @param dev 输入参数,USB设备地址信息,详见{@link UsbDev}。 + * @param pipe 输入参数,USB设备pipe信息,详见{@link UsbPipe}。 + * @param clientData 输入参数,用户数据。 + * @param buffer 输入参数,传输的数据。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -346,15 +347,15 @@ public: const std::vector &buffer); /** - * @brief 等待RequestQueue异步请求的操作结果 + * @brief 等待RequestQueue异步请求的操作结果。 * - * @param dev 输入参数,usb设备地址信息,详见{@link UsbDev} - * @param clientData 输入参数,用户数据 - * @param buffer 输入参数,传输数据 - * @param timeout 输入参数,超时时间 + * @param dev 输入参数,USB设备地址信息,详见{@link UsbDev}。 + * @param clientData 输入参数,用户数据。 + * @param buffer 输入参数,传输数据。 + * @param timeout 输入参数,超时时间。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -363,13 +364,13 @@ public: int32_t timeout); /** - * @brief 取消待处理的数据请求 + * @brief 取消待处理的数据请求。 * - * @param dev 输入参数,usb设备地址信息,详见{@link UsbDev} - * @param pipe 输入参数,usb设备pipe信息,详见{@link UsbPipe} + * @param dev 输入参数,USB设备地址信息,详见{@link UsbDev}。 + * @param pipe 输入参数,USB设备pipe信息,详见{@link UsbPipe}。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -377,12 +378,12 @@ public: int32_t RequestCancel(const UsbDev &dev, const UsbPipe &pipe); /** - * @brief 获取从设备支持的功能列表(按位域表示)(从设备) + * @brief 获取从设备支持的功能列表(按位域表示)(从设备)。 * - * @param funcs 输出参数,获取当前设备的function的值 + * @param funcs 输出参数,获取当前设备的function的值。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -390,12 +391,12 @@ public: int32_t GetCurrentFunctions(int32_t &funcs); /** - * @brief 设置从设备支持的功能列表(按位域表示)(从设备) + * @brief 设置从设备支持的功能列表(按位域表示)(从设备)。 * - * @param funcs 输入参数,传入设备支持的function的值 + * @param funcs 输入参数,传入设备支持的function的值。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -403,14 +404,14 @@ public: int32_t SetCurrentFunctions(int32_t funcs); /** - * @brief 设置port端口的角色 + * @brief 设置port端口的角色。 * - * @param portId 输入参数,port接口 ID - * @param powerRole 输入参数,电源角色的值 - * @param dataRole 输入参数,数据角色的值 + * @param portId 输入参数,port接口ID。 + * @param powerRole 输入参数,电源角色的值。 + * @param dataRole 输入参数,数据角色的值。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -418,15 +419,15 @@ public: int32_t SetPortRole(int32_t portId, int32_t powerRole, int32_t dataRole); /** - * @brief 查询port端口的当前设置 + * @brief 查询port端口的当前设置。 * - * @param portId 输出参数,port接口 ID - * @param powerRole 输出参数,电源角色的值 - * @param dataRole 输出参数,数据角色的值 - * @param mode 输出参数,模式的值 + * @param portId 输出参数,port接口ID。 + * @param powerRole 输出参数,电源角色的值。 + * @param dataRole 输出参数,数据角色的值。 + * @param mode 输出参数,模式的值。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -434,12 +435,12 @@ public: int32_t QueryPort(int32_t &portId, int32_t &powerRole, int32_t &dataRole, int32_t &mode); /** - * @brief 绑定订阅者 + * @brief 绑定订阅者。 * - * @param subscriber 输入参数,订阅者信息,详见{@link UsbdSubscriber} + * @param subscriber 输入参数,订阅者信息,详见{@link UsbdSubscriber}。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -447,12 +448,12 @@ public: int32_t BindUsbdSubscriber(const sptr &subscriber); /** - * @brief 解绑订阅者 + * @brief 解绑订阅者。 * - * @param subscriber 输入参数,订阅者信息,详见{@link UsbdSubscriber} + * @param subscriber 输入参数,订阅者信息,详见{@link UsbdSubscriber}。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -460,14 +461,14 @@ public: int32_t UnbindUsbdSubscriber(const sptr &subscriber); /** - * @brief 注册批量传输异步回调函数 + * @brief 注册批量传输异步回调函数。 * - * @param dev 输入参数,usb设备地址信息,详见{@link UsbDev} - * @param pipe 输入参数,usb设备pipe信息,详见{@link UsbPipe} - * @param cb 输入参数,回调函数对象的引用 + * @param dev 输入参数,USB设备地址信息,详见{@link UsbDev}。 + * @param pipe 输入参数,USB设备pipe信息,详见{@link UsbPipe}。 + * @param cb 输入参数,回调函数对象的引用。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -475,13 +476,13 @@ public: int32_t RegBulkCallback(const UsbDev &dev, const UsbPipe &pipe, const sptr &cb); /** - * @brief 注销批量传输异步回调函数 + * @brief 注销批量传输异步回调函数。 * - * @param dev 输入参数,usb设备地址信息,详见{@link UsbDev} - * @param pipe 输入参数,usb设备pipe信息,详见{@link UsbPipe} + * @param dev 输入参数,USB设备地址信息,详见{@link UsbDev}。 + * @param pipe 输入参数,USB设备pipe信息,详见{@link UsbPipe}。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -489,14 +490,14 @@ public: int32_t UnRegBulkCallback(const UsbDev &dev, const UsbPipe &pipe); /** - * @brief 批量传输异步读数据 + * @brief 批量传输异步读数据。 * - * @param dev 输入参数,usb设备地址信息,详见{@link UsbDev} - * @param pipe 输入参数,usb设备pipe信息,详见{@link UsbPipe} - * @param ashmem 输出参数,为共享内存,用于存放读取的数据,详见{@link Ashmem} + * @param dev 输入参数,USB设备地址信息,详见{@link UsbDev}。 + * @param pipe 输入参数,USB设备pipe信息,详见{@link UsbPipe}。 + * @param ashmem 输出参数,为共享内存,用于存放读取的数据,详见{@link Ashmem}。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -504,14 +505,14 @@ public: int32_t BulkRead(const UsbDev &dev, const UsbPipe &pipe, sptr &ashmem); /** - * @brief 批量传输异步写数据 + * @brief 批量传输异步写数据。 * - * @param dev 输入参数,usb设备地址信息,详见{@link UsbDev} - * @param pipe 输入参数,usb设备pipe信息,详见{@link UsbPipe} - * @param ashmem 输入参数,为共享内存,用于存放需要写入的数据,详见{@link Ashmem} + * @param dev 输入参数,USB设备地址信息,详见{@link UsbDev}。 + * @param pipe 输入参数,USB设备pipe信息,详见{@link UsbPipe}。 + * @param ashmem 输入参数,为共享内存,用于存放需要写入的数据,详见{@link Ashmem}。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -519,13 +520,13 @@ public: int32_t BulkWrite(const UsbDev &dev, const UsbPipe &pipe, sptr &ashmem); /** - * @brief 批量传输异步取消接口,用于取消当前接口的异步批量读写操作 + * @brief 批量传输异步取消接口,用于取消当前接口的异步批量读写操作。 * - * @param dev 输入参数,usb设备地址信息,详见{@link UsbDev} - * @param pipe 输入参数,usb设备pipe信息,详见{@link UsbPipe} + * @param dev 输入参数,USB设备地址信息,详见{@link UsbDev}。 + * @param pipe 输入参数,USB设备pipe信息,详见{@link UsbPipe}。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 diff --git a/zh-cn/device_api/hdi/usb/usbd_subscriber.h b/zh-cn/device_api/hdi/usb/usbd_subscriber.h index 28baf9afb1fb259583d612e65a8f9b3d24a43bde..7e83601c284c8afeccd2a9fe846aec4c71753646 100644 --- a/zh-cn/device_api/hdi/usb/usbd_subscriber.h +++ b/zh-cn/device_api/hdi/usb/usbd_subscriber.h @@ -28,7 +28,7 @@ /** * @file usbd_subscriber.h * - * @brief usb驱动订阅模块。 + * @brief USB驱动订阅模块。 * * @since 3.0 * @version 1.0 @@ -49,12 +49,12 @@ public: virtual ~UsbdSubscriber() = default; /** - * @brief 设备事件 + * @brief 设备事件。 * - * @param UsbInfo 输入参数,usb设备信息 + * @param UsbInfo 输入参数,USB设备信息。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -62,15 +62,15 @@ public: virtual int32_t DeviceEvent(const UsbInfo &info) = 0; /** - * @brief 端口改变事件 + * @brief 端口改变事件。 * - * @param portId 输入参数,端口ID - * @param powerRole 输入参数,电源角色的值 - * @param dataRole 输入参数,数据角色的值 - * @param mode 输入参数,端口模式的值 + * @param portId 输入参数,端口ID。 + * @param powerRole 输入参数,电源角色的值。 + * @param dataRole 输入参数,数据角色的值。 + * @param mode 输入参数,端口模式的值。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -78,15 +78,15 @@ public: virtual int32_t PortChangedEvent(int32_t portId, int32_t powerRole, int32_t dataRole, int32_t mode) = 0; /** - * @brief 远程请求 + * @brief 远程请求。 * - * @param code 输入参数,命令字 - * @param data 输入参数,待解析的数据 - * @param reply 输出参数,返回的数据 - * @param option 输入参数,选项数据 + * @param code 输入参数,命令字。 + * @param data 输入参数,待解析的数据。 + * @param reply 输出参数,返回的数据。 + * @param option 输入参数,选项数据。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -95,15 +95,15 @@ public: private: /** - * @brief 解析usb设备信息 + * @brief 解析USB设备信息。 * - * @param code 输入参数,命令字 - * @param reply 输出参数,返回的数据 - * @param option 输入参数,选项数据 - * @param info 输出参数,usb设备信息 + * @param code 输入参数,命令字。 + * @param reply 输出参数,返回的数据。 + * @param option 输入参数,选项数据。 + * @param info 输出参数,USB设备信息。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 @@ -111,15 +111,15 @@ private: static int32_t ParserUsbInfo(MessageParcel &data, MessageParcel &reply, MessageOption &option, UsbInfo &info); /** - * @brief 解析usb设备端口信息 + * @brief 解析USB设备端口信息。 * - * @param code 输入参数,命令字 - * @param reply 输出参数,返回的数据 - * @param option 输入参数,选项数据 - * @param info 输出参数,usb设备端口信息 + * @param code 输入参数,命令字。 + * @param reply 输出参数,返回的数据。 + * @param option 输入参数,选项数据。 + * @param info 输出参数,USB设备端口信息。 * - * @return 0 表示操作成功 - * @return 非零值 表示操作失败 + * @return 0 表示操作成功。 + * @return 非零值 表示操作失败。 * * @since 3.0 * @version 1.0 diff --git a/zh-cn/device_api/hdi/usb/usbd_type.h b/zh-cn/device_api/hdi/usb/usbd_type.h index 94d57c26b08c61f479244ff9194417da9cdaa8c1..a630005c4877c319ac6b1384ddae65b745c57440 100644 --- a/zh-cn/device_api/hdi/usb/usbd_type.h +++ b/zh-cn/device_api/hdi/usb/usbd_type.h @@ -28,9 +28,9 @@ /** * @file usbd_type.h * - * @brief usb驱动模块接口定义中使用的自定义数据类型。 + * @brief USB驱动模块接口定义中使用的自定义数据类型。 * - * usb驱动模块接口定义中使用的自定义数据类型, 包括分发的命令字、数据方向等。 + * USB驱动模块接口定义中使用的自定义数据类型, 包括分发的命令字、数据方向等。 * * @since 3.0 * @version 1.0 @@ -44,7 +44,7 @@ #include #include -/** usb设备最大接口数量 */ +/** USB设备最大接口数量 */ #define USB_MAX_INTERFACES 32 /** 从地址中提取USB Endpoint方向的位掩码 */ @@ -60,7 +60,7 @@ static const int32_t USB_ENDPOINT_DIR_OUT = 0; typedef void (*UsbdRequestCallback)(uint8_t *requestArg); /** - * @brief 批量回调命令字 + * @brief 批量回调命令字。 * */ enum UsbdBulkCbCmd { @@ -71,7 +71,7 @@ enum UsbdBulkCbCmd { }; /** - * @brief 主机端和设备端插拔事件 + * @brief 主机端和设备端插拔事件。 * */ enum UsbdDeviceAction { @@ -88,29 +88,29 @@ enum UsbdDeviceAction { namespace OHOS { namespace USB { /** - * @brief usb设备 + * @brief USB设备。 * */ struct UsbDev { - /** usb总线编号 */ + /** USB总线编号 */ uint8_t busNum; - /** usb设备地址 */ + /** USB设备地址 */ uint8_t devAddr; }; /** - * @brief 管道信息 + * @brief 管道信息。 * */ struct UsbPipe { - /** usb设备接口ID */ + /** USB设备接口ID */ uint8_t interfaceId; - /** usb设备端点ID */ + /** USB设备端点ID */ uint8_t endpointId; }; /** - * @brief usb控制传输 + * @brief USB控制传输。 * */ struct UsbCtrlTransfer { @@ -127,15 +127,15 @@ struct UsbCtrlTransfer { }; /** - * @brief usb设备信息 + * @brief USB设备信息。 * */ struct USBDeviceInfo { - /** usb设备状态 */ + /** USB设备状态 */ int32_t status; - /** usb总线编号 */ + /** USB总线编号 */ int32_t busNum; - /** usb设备编号 */ + /** USB设备编号 */ int32_t devNum; }; } /** namespace USB */