• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# usb_serial_types.h
2<!--Kit: Driver Development Kit-->
3<!--Subsystem: Driver-->
4<!--Owner: @lixinsheng2-->
5<!--Designer: @w00373942-->
6<!--Tester: @dong-dongzhen-->
7<!--Adviser: @w_Machine_cc-->
8
9## 概述
10
11提供USB SERIAL DDK中的枚举变量、结构体定义与宏定义。
12
13**引用文件:** <usb_serial/usb_serial_types.h>
14
15**库:** libusb_serial.z.so
16
17**系统能力:** SystemCapability.Driver.UsbSerial.Extension
18
19**起始版本:** 18
20
21**相关模块:** [SerialDdk](capi-serialddk.md)
22
23## 汇总
24
25### 结构体
26
27| 名称 | typedef关键字 | 描述 |
28| -- | -- | -- |
29| [UsbSerial_Params](capi-serialddk-usbserial-params.md) | __attribute__((aligned(8))) UsbSerial_Params | 定义USB SERIAL DDK使用的USB串口参数. |
30| [UsbSerial_DeviceHandle](capi-serialddk-usbserial-devicehandle.md) | UsbSerial_DeviceHandle | USB串口设备数据结构(不透明)。 |
31
32### 枚举
33
34| 名称 | typedef关键字 | 描述 |
35| -- | -- | -- |
36| [UsbSerial_DdkRetCode](#usbserial_ddkretcode) | UsbSerial_DdkRetCode | 定义USB SERIAL DDK使用的返回码。 |
37| [UsbSerial_FlowControl](#usbserial_flowcontrol) | UsbSerial_FlowControl | 定义USB SERIAL DDK中的流量控制。 |
38| [UsbSerial_Parity](#usbserial_parity) | UsbSerial_Parity | 定义USB SERIAL DDK使用的校验参数枚举。 |
39
40## 枚举类型说明
41
42### UsbSerial_DdkRetCode
43
44```
45enum UsbSerial_DdkRetCode
46```
47
48**描述**
49
50定义USB SERIAL DDK使用的返回码。
51
52**起始版本:** 18
53
54| 枚举项 | 描述 |
55| -- | -- |
56| USB_SERIAL_DDK_NO_PERM = 201 | 权限被拒绝。 |
57| USB_SERIAL_DDK_INVALID_PARAMETER = 401 | 无效参数。 |
58| USB_SERIAL_DDK_SUCCESS = 31600000 | 操作成功。 |
59| USB_SERIAL_DDK_INVALID_OPERATION = 31600001 | 无效操作。 |
60| USB_SERIAL_DDK_INIT_ERROR = 31600002 | 初始化失败。 |
61| USB_SERIAL_DDK_SERVICE_ERROR = 31600003 | 服务错误。 |
62| USB_SERIAL_DDK_MEMORY_ERROR = 31600004 | 内存相关错误,例如内存不足、内存数据复制失败或内存应用程序故障。 |
63| USB_SERIAL_DDK_IO_ERROR = 31600005 | I/O 错误。 |
64| USB_SERIAL_DDK_DEVICE_NOT_FOUND = 31600006 | 未找到设备。 |
65
66### UsbSerial_FlowControl
67
68```
69enum UsbSerial_FlowControl
70```
71
72**描述**
73
74定义USB SERIAL DDK中的流量控制。
75
76**起始版本:** 18
77
78| 枚举项 | 描述 |
79| -- | -- |
80| USB_SERIAL_NO_FLOW_CONTROL = 0 | 无流量控制。 |
81| USB_SERIAL_SOFTWARE_FLOW_CONTROL = 1 | 软件流控。 |
82| USB_SERIAL_HARDWARE_FLOW_CONTROL = 2 | 硬件流控。 |
83
84### UsbSerial_Parity
85
86```
87enum UsbSerial_Parity
88```
89
90**描述**
91
92定义USB SERIAL DDK使用的校验参数枚举。
93
94**起始版本:** 18
95
96| 枚举项 | 描述 |
97| -- | -- |
98| USB_SERIAL_PARITY_NONE = 0 | 无校验。 |
99| USB_SERIAL_PARITY_ODD = 1 | 奇校验。 |
100| USB_SERIAL_PARITY_EVEN = 2 | 偶校验。 |
101
102
103