harmony 鸿蒙HID DDK

2025-06-12 浏览 (1)

HID DDK

概述

提供HID DDK接口，包括创建设备、发送事件、销毁设备。

系统能力： SystemCapability.Driver.HID.Extension

起始版本： 11

汇总

文件

名称描述
hid_ddk_api.h声明主机侧访问输入设备的HID DDK接口。
引用文件：<hid/hid_ddk_api.h>
库： libhid.z.so
hid_ddk_types.h提供HID DDK中的枚举变量与结构体定义。
引用文件：<hid/hid_ddk_types.h>
库： libhid.z.so

结构体

名称描述
struct  Hid_EmitItem事件信息。
struct  Hid_Device设备基本信息。
struct  Hid_EventTypeArray事件类型编码数组。
struct  Hid_KeyCodeArray键值属性数组。
struct  Hid_AbsAxesArray绝对坐标属性数组。
struct  Hid_RelAxesArray相对坐标属性数组。
struct  Hid_MscEventArray其它特殊事件属性数组。
struct  Hid_EventProperties设备关注事件属性。
struct  Hid_RawDevInfo原始设备信息定义。

宏定义

名称描述
HID_MAX_REPORT_BUFFER_SIZE   (16 * 1024 - 1)最大报告缓冲区大小。

类型定义

名称描述
typedef struct Hid_EmitItem Hid_EmitItem事件信息。
typedef struct Hid_Device Hid_Device设备基本信息。
typedef struct Hid_EventTypeArray Hid_EventTypeArray事件类型编码数组。
typedef struct Hid_KeyCodeArray Hid_KeyCodeArray键值属性数组。
typedef struct Hid_AbsAxesArray Hid_AbsAxesArray绝对坐标属性数组。
typedef struct Hid_RelAxesArray Hid_RelAxesArray相对坐标属性数组。
typedef struct Hid_MscEventArray Hid_MscEventArray其它特殊事件属性数组。
typedef struct Hid_EventProperties Hid_EventProperties设备关注事件属性。
typedef struct Hid_DeviceHandle Hid_DeviceHandle不透明的USB HID设备结构。
typedef struct Hid_RawDevInfo Hid_RawDevInfo原始设备信息定义。

枚举

名称描述
Hid_DeviceProp {
HID_PROP_POINTER = 0x00, HID_PROP_DIRECT = 0x01, HID_PROP_BUTTON_PAD = 0x02, HID_PROP_SEMI_MT = 0x03, HID_PROP_TOP_BUTTON_PAD = 0x04, HID_PROP_POINTING_STICK = 0x05, HID_PROP_ACCELEROMETER = 0x06
}		输入设备特性定义。
Hid_EventType {
HID_EV_SYN = 0x00, HID_EV_KEY = 0x01, HID_EV_REL = 0x02, HID_EV_ABS = 0x03, HID_EV_MSC = 0x04
}		事件类型。
Hid_SynEvent { HID_SYN_REPORT = 0, HID_SYN_CONFIG = 1, HID_SYN_MT_REPORT = 2, HID_SYN_DROPPED = 3 }同步事件编码。
Hid_KeyCode {
HID_KEY_A = 30, HID_KEY_B = 48, HID_KEY_C = 46, HID_KEY_D = 32, HID_KEY_E = 18, HID_KEY_F = 33, HID_KEY_G = 34, HID_KEY_H = 35, HID_KEY_I = 23, HID_KEY_J = 36, HID_KEY_K = 37, HID_KEY_L = 38, HID_KEY_M = 50, HID_KEY_N = 49, HID_KEY_O = 24, HID_KEY_P = 25, HID_KEY_Q = 16, HID_KEY_R = 19, HID_KEY_S = 31, HID_KEY_T = 20, HID_KEY_U = 22, HID_KEY_V = 47, HID_KEY_W = 17, HID_KEY_X = 45, HID_KEY_Y = 21, HID_KEY_Z = 44, HID_KEY_ESC = 1, HID_KEY_0 = 11, HID_KEY_1 = 2, HID_KEY_2 = 3, HID_KEY_3 = 4, HID_KEY_4 = 5, HID_KEY_5 = 6, HID_KEY_6 = 7, HID_KEY_7 = 8, HID_KEY_8 = 9, HID_KEY_9 = 10, HID_KEY_GRAVE = 41, HID_KEY_MINUS = 12, HID_KEY_EQUALS = 13, HID_KEY_BACKSPACE = 14, HID_KEY_LEFT_BRACKET = 26, HID_KEY_RIGHT_BRACKET = 27, HID_KEY_ENTER = 28, HID_KEY_LEFT_SHIFT = 42, HID_KEY_BACKSLASH = 43, HID_KEY_SEMICOLON = 39, HID_KEY_APOSTROPHE = 40, HID_KEY_SPACE = 57, HID_KEY_SLASH = 53, HID_KEY_COMMA = 51, HID_KEY_PERIOD = 52, HID_KEY_RIGHT_SHIFT = 54, HID_KEY_NUMPAD_0 = 82, HID_KEY_NUMPAD_1 = 79, HID_KEY_NUMPAD_2 = 80, HID_KEY_NUMPAD_3 = 81, HID_KEY_NUMPAD_4 = 75, HID_KEY_NUMPAD_5 = 76, HID_KEY_NUMPAD_6 = 77, HID_KEY_NUMPAD_7 = 71, HID_KEY_NUMPAD_8 = 72, HID_KEY_NUMPAD_9 = 73, HID_KEY_NUMPAD_DIVIDE = 70, HID_KEY_NUMPAD_MULTIPLY = 55, HID_KEY_NUMPAD_SUBTRACT = 74, HID_KEY_NUMPAD_ADD = 78, HID_KEY_NUMPAD_DOT = 83, HID_KEY_SYSRQ = 99, HID_KEY_DELETE = 111, HID_KEY_MUTE = 113, HID_KEY_VOLUME_DOWN = 114, HID_KEY_VOLUME_UP = 115, HID_KEY_BRIGHTNESS_DOWN = 224, HID_KEY_BRIGHTNESS_UP = 225, HID_BTN_0 = 0x100, HID_BTN_1 = 0x101, HID_BTN_2 = 0x102, HID_BTN_3 = 0x103, HID_BTN_4 = 0x104, HID_BTN_5 = 0x105, HID_BTN_6 = 0x106, HID_BTN_7 = 0x107, HID_BTN_8 = 0x108, HID_BTN_9 = 0x109, HID_BTN_LEFT = 0x110, HID_BTN_RIGHT = 0x111, HID_BTN_MIDDLE = 0x112, HID_BTN_SIDE = 0x113, HID_BTN_EXTRA = 0x114, HID_BTN_FORWARD = 0x115, HID_BTN_BACKWARD = 0x116, HID_BTN_TASK = 0x117, HID_BTN_TOOL_PEN = 0x140, HID_BTN_TOOL_RUBBER = 0x141, HID_BTN_TOOL_BRUSH = 0x142, HID_BTN_TOOL_PENCIL = 0x143, HID_BTN_TOOL_AIRBRUSH = 0x144, HID_BTN_TOOL_FINGER = 0x145, HID_BTN_TOOL_MOUSE = 0x146, HID_BTN_TOOL_LENS = 0x147, HID_BTN_TOOL_QUINT_TAP = 0x148, HID_BTN_STYLUS3 = 0x149, HID_BTN_TOUCH = 0x14a, HID_BTN_STYLUS = 0x14b, HID_BTN_STYLUS2 = 0x14c, HID_BTN_TOOL_DOUBLE_TAP = 0x14d, HID_BTN_TOOL_TRIPLE_TAP = 0x14e, HID_BTN_TOOL_QUAD_TAP = 0x14f, HID_BTN_WHEEL = 0x150
}		键值编码。
Hid_AbsAxes {
HID_ABS_X = 0x00, HID_ABS_Y = 0x01, HID_ABS_Z = 0x02, HID_ABS_RX = 0x03, HID_ABS_RY = 0x04, HID_ABS_RZ = 0x05, HID_ABS_THROTTLE = 0x06, HID_ABS_RUDDER = 0x07, HID_ABS_WHEEL = 0x08, HID_ABS_GAS = 0x09, HID_ABS_BRAKE = 0x0a, HID_ABS_HAT0X = 0x10, HID_ABS_HAT0Y = 0x11, HID_ABS_HAT1X = 0x12, HID_ABS_HAT1Y = 0x13, HID_ABS_HAT2X = 0x14, HID_ABS_HAT2Y = 0x15, HID_ABS_HAT3X = 0x16, HID_ABS_HAT3Y = 0x17, HID_ABS_PRESSURE = 0x18, HID_ABS_DISTANCE = 0x19, HID_ABS_TILT_X = 0x1a, HID_ABS_TILT_Y = 0x1b, HID_ABS_TOOL_WIDTH = 0x1c, HID_ABS_VOLUME = 0x20, HID_ABS_MISC = 0x28
}		绝对坐标编码。
Hid_RelAxes {
HID_REL_X = 0x00, HID_REL_Y = 0x01, HID_REL_Z = 0x02, HID_REL_RX = 0x03, HID_REL_RY = 0x04, HID_REL_RZ = 0x05, HID_REL_HWHEEL = 0x06, HID_REL_DIAL = 0x07, HID_REL_WHEEL = 0x08, HID_REL_MISC = 0x09, HID_REL_RESERVED = 0x0a, HID_REL_WHEEL_HI_RES = 0x0b, HID_REL_HWHEEL_HI_RES = 0x0c
}		相对坐标编码。
Hid_MscEvent {
HID_MSC_SERIAL = 0x00, HID_MSC_PULSE_LED = 0x01, HID_MSC_GESTURE = 0x02, HID_MSC_RAW = 0x03, HID_MSC_SCAN = 0x04, HID_MSC_TIMESTAMP = 0x05
}		不适合其它类型的输入事件编码。
Hid_DdkErrCode {
HID_DDK_SUCCESS = 0, HID_DDK_NO_PERM = 201, HID_DDK_INVALID_PARAMETER = 401, HID_DDK_FAILURE = 27300001, HID_DDK_NULL_PTR = 27300002, HID_DDK_INVALID_OPERATION = 27300003, HID_DDK_TIMEOUT = 27300004, HID_DDK_INIT_ERROR = 27300005, HID_DDK_SERVICE_ERROR = 27300006, HID_DDK_MEMORY_ERROR = 27300007, HID_DDK_IO_ERROR = 27300008, HID_DDK_DEVICE_NOT_FOUND = 27300009
}		HID DDK错误码定义。
Hid_ReportType { HID_INPUT_REPORT = 0, HID_OUTPUT_REPORT = 1, HID_FEATURE_REPORT = 2 }报告（HID设备与主机之间交换的数据包）类型定义。

函数

名称描述
int32_t OH_Hid_CreateDevice (Hid_Device *hidDevice, Hid_EventProperties *hidEventProperties)创建设备。
int32_t OH_Hid_EmitEvent (int32_t deviceId, const Hid_EmitItem items[], uint16_t length)向指定设备发送事件列表。
int32_t OH_Hid_DestroyDevice (int32_t deviceId)销毁设备。
int32_t OH_Hid_Init (void)初始化HID DDK。
int32_t OH_Hid_Release (void)释放HID DDK。
int32_t OH_Hid_Open (uint64_t deviceId, uint8_t interfaceIndex, Hid_DeviceHandle **dev)打开deviceId和interfaceIndex指定的设备。
int32_t OH_Hid_Close (Hid_DeviceHandle **dev)关闭设备。
int32_t OH_Hid_Write (Hid_DeviceHandle *dev, uint8_t *data, uint32_t length, uint32_t *bytesWritten)向设备写入报告。
int32_t OH_Hid_ReadTimeout (Hid_DeviceHandle *dev, uint8_t *data, uint32_t bufSize, int timeout, uint32_t *bytesRead)在指定的超时时间内从设备读取报告。
int32_t OH_Hid_Read (Hid_DeviceHandle *dev, uint8_t *data, uint32_t bufSize, uint32_t *bytesRead)从设备读取报告，默认为阻塞模式（阻塞等待直到有数据可读取），可以调用OH_Hid_SetNonBlocking改变模式。
int32_t OH_Hid_SetNonBlocking (Hid_DeviceHandle *dev, int nonBlock)设置设备读取模式为非阻塞。
int32_t OH_Hid_GetRawInfo (Hid_DeviceHandle *dev, Hid_RawDevInfo *rawDevInfo)获取设备原始信息。
int32_t OH_Hid_GetRawName (Hid_DeviceHandle *dev, char *data, uint32_t bufSize)获取设备原始名称。
int32_t OH_Hid_GetPhysicalAddress (Hid_DeviceHandle *dev, char *data, uint32_t bufSize)获取设备物理地址。
int32_t OH_Hid_GetRawUniqueId (Hid_DeviceHandle *dev, uint8_t *data, uint32_t bufSize)获取设备原始唯一标识符。
int32_t OH_Hid_SendReport (Hid_DeviceHandle *dev, Hid_ReportType reportType, const uint8_t *data, uint32_t length)向设备发送报告。
int32_t OH_Hid_GetReport (Hid_DeviceHandle *dev, Hid_ReportType reportType, uint8_t *data, uint32_t bufSize)获取设备报告。
int32_t OH_Hid_GetReportDescriptor (Hid_DeviceHandle *dev, uint8_t *buf, uint32_t bufSize, uint32_t *bytesRead)获取设备报告描述符。

变量

名称描述
uint16_t Hid_EmitItem::type事件类型。
uint16_t Hid_EmitItem::code事件编码。
uint32_t Hid_EmitItem::value事件值。
const char * Hid_Device::deviceName设备名称。
uint16_t Hid_Device::vendorId厂商ID。
uint16_t Hid_Device::productId产品ID。
uint16_t Hid_Device::version版本号。
uint16_t Hid_Device::bustype总线类型。
Hid_DeviceProp * Hid_Device::properties设备特性。
uint16_t Hid_Device::propLength设备特性数量。
Hid_EventType * Hid_EventTypeArray::hidEventType事件类型编码。
uint16_t Hid_EventTypeArray::length数组长度。
Hid_KeyCode * Hid_KeyCodeArray::hidKeyCode键值编码。
uint16_t Hid_KeyCodeArray::length数组长度。
Hid_AbsAxes * Hid_AbsAxesArray::hidAbsAxes绝对坐标属性编码。
uint16_t Hid_AbsAxesArray::length数组长度。
Hid_RelAxes * Hid_RelAxesArray::hidRelAxes相对坐标属性编码。
uint16_t Hid_RelAxesArray::length数组长度。
Hid_MscEvent * Hid_MscEventArray::hidMscEvent其它特殊事件属性编码。
uint16_t Hid_MscEventArray::length数组长度。
struct Hid_EventTypeArrayHid_EventProperties::hidEventTypes事件类型属性编码数组。
struct Hid_KeyCodeArrayHid_EventProperties::hidKeys键值属性编码数组。
struct Hid_AbsAxesArrayHid_EventProperties::hidAbs绝对坐标属性编码数组。
struct Hid_RelAxesArrayHid_EventProperties::hidRelBits相对坐标属性编码数组。
struct Hid_MscEventArrayHid_EventProperties::hidMiscellaneous其它特殊事件属性编码数组。
int32_t Hid_EventProperties::hidAbsMax [64]绝对坐标属性最大值。
int32_t Hid_EventProperties::hidAbsMin [64]绝对坐标属性最小值。
int32_t Hid_EventProperties::hidAbsFuzz [64]绝对坐标属性模糊值。
int32_t Hid_EventProperties::hidAbsFlat [64]绝对坐标属性固定值。
uint32_t Hid_RawDevInfo::busType总线类型。
uint16_t Hid_RawDevInfo::vendor供应商ID。
uint16_t Hid_RawDevInfo::product产品ID。

宏定义说明

HID_MAX_REPORT_BUFFER_SIZE

#define HID_MAX_REPORT_BUFFER_SIZE   (16 * 1024 - 1)

描述

最大报告缓冲区大小。

起始版本： 18

类型定义说明

Hid_AbsAxesArray

typedef struct Hid_AbsAxesArray Hid_AbsAxesArray

描述

绝对坐标属性数组。

起始版本： 11

Hid_Device

typedef struct Hid_Device Hid_Device

描述

设备基本信息。

起始版本： 11

Hid_DeviceHandle

typedef struct Hid_DeviceHandle Hid_DeviceHandle

描述

不透明的USB HID设备结构。

起始版本： 18

Hid_EmitItem

typedef struct Hid_EmitItem Hid_EmitItem

描述

事件信息。

起始版本： 11

Hid_EventProperties

typedef struct Hid_EventProperties Hid_EventProperties

描述

设备关注事件属性。

起始版本： 11

Hid_EventTypeArray

typedef struct Hid_EventTypeArray Hid_EventTypeArray

描述

事件类型编码数组。

起始版本： 11

Hid_KeyCodeArray

typedef struct Hid_KeyCodeArray Hid_KeyCodeArray

描述

键值属性数组。

起始版本： 11

Hid_MscEventArray

typedef struct Hid_MscEventArray Hid_MscEventArray

描述

其它特殊事件属性数组。

起始版本： 11

Hid_RawDevInfo

typedef struct Hid_RawDevInfo Hid_RawDevInfo

描述

原始设备信息定义。

起始版本： 18

Hid_RelAxesArray

typedef struct Hid_RelAxesArray Hid_RelAxesArray

描述

相对坐标属性数组。

起始版本： 11

枚举类型说明

Hid_AbsAxes

enum Hid_AbsAxes

描述

绝对坐标编码。

起始版本： 11

枚举值描述
HID_ABS_XX轴。
HID_ABS_YY轴。
HID_ABS_ZZ轴。
HID_ABS_RX右模拟摇杆的 X 轴。
HID_ABS_RY右模拟摇杆的 Y 轴。
HID_ABS_RZ右模拟摇杆的 Z 轴。
HID_ABS_THROTTLE油门。
HID_ABS_RUDDER舵。
HID_ABS_WHEEL滚轮。
HID_ABS_GAS气。
HID_ABS_BRAKE制动。
HID_ABS_HAT0XHAT0X。
HID_ABS_HAT0YHAT0Y。
HID_ABS_HAT1XHAT1X。
HID_ABS_HAT1YHAT1Y。
HID_ABS_HAT2XHAT2X。
HID_ABS_HAT2YHAT2Y。
HID_ABS_HAT3XHAT3X。
HID_ABS_HAT3YHAT3Y。
HID_ABS_PRESSURE压力。
HID_ABS_DISTANCE距离。
HID_ABS_TILT_XX轴倾斜度。
HID_ABS_TILT_YY轴倾斜度。
HID_ABS_TOOL_WIDTH触摸工具的宽度。
HID_ABS_VOLUME音量。
HID_ABS_MISC其它。

Hid_DdkErrCode

enum Hid_DdkErrCode

描述

HID DDK错误码定义。

起始版本： 11

枚举值描述
HID_DDK_SUCCESS操作成功。
HID_DDK_NO_PERM没有权限，从API 16起，取值由-6变更为201。
HID_DDK_INVALID_PARAMETER非法参数，从API 16起，取值由-2变更为401。
HID_DDK_FAILURE操作失败，从API 16起，取值由-1变更为27300001。
HID_DDK_NULL_PTR空指针异常，从API 16起，取值由-4变更为27300002。
HID_DDK_INVALID_OPERATION非法操作，从API 16起，取值由-3变更为27300003。
HID_DDK_TIMEOUT超时，从API 16起，取值由-5变更为27300004。
HID_DDK_INIT_ERROR初始化DDK失败或DDK未初始化。从API 16开始支持此枚举。
HID_DDK_SERVICE_ERROR服务通信过程中错误，从API 16开始支持此枚举。
HID_DDK_MEMORY_ERROR内存相关的错误，包括：内存数据拷贝失败、内存申请失败等，从API 16开始支持此枚举。
HID_DDK_IO_ERRORI/O操作失败，从API 16开始支持此枚举。
HID_DDK_DEVICE_NOT_FOUND设备未找到，从API 16开始支持此枚举。

Hid_DeviceProp

enum Hid_DeviceProp

描述

输入设备特性定义。

起始版本： 11

枚举值描述
HID_PROP_POINTER指针设备。
HID_PROP_DIRECT直接输入设备。
HID_PROP_BUTTON_PAD底部按键触摸设备。
HID_PROP_SEMI_MT全多点触控设备。
HID_PROP_TOP_BUTTON_PAD顶部软按键触摸设备。
HID_PROP_POINTING_STICK指点杆设备。
HID_PROP_ACCELEROMETER加速度传感器设备。

Hid_EventType

enum Hid_EventType

描述

事件类型。

起始版本： 11

枚举值描述
HID_EV_SYN同步事件。
HID_EV_KEY按键事件。
HID_EV_REL相对坐标事件。
HID_EV_ABS绝对坐标事件。
HID_EV_MSC特殊事件。

Hid_KeyCode

enum Hid_KeyCode

描述

键值编码。

起始版本： 11

枚举值描述
HID_KEY_A键A。
HID_KEY_B键B。
HID_KEY_C键C。
HID_KEY_D键D。
HID_KEY_E键E。
HID_KEY_F键F。
HID_KEY_G键G。
HID_KEY_H键H。
HID_KEY_I键I。
HID_KEY_J键J。
HID_KEY_K键K。
HID_KEY_L键L。
HID_KEY_M键M。
HID_KEY_N键N。
HID_KEY_O键O。
HID_KEY_P键P。
HID_KEY_Q键Q。
HID_KEY_R键R。
HID_KEY_S键S。
HID_KEY_T键T。
HID_KEY_U键U。
HID_KEY_V键V。
HID_KEY_W键W。
HID_KEY_X键X。
HID_KEY_Y键Y。
HID_KEY_Z键Z。
HID_KEY_ESC键ESC。
HID_KEY_0键0。
HID_KEY_1键1。
HID_KEY_2键2。
HID_KEY_3键3。
HID_KEY_4键4。
HID_KEY_5键5。
HID_KEY_6键6。
HID_KEY_7键7。
HID_KEY_8键8。
HID_KEY_9键9。
HID_KEY_GRAVE键`。
HID_KEY_MINUS键-。
HID_KEY_EQUALS键=。
HID_KEY_BACKSPACE键退格。
HID_KEY_LEFT_BRACKET键[。
HID_KEY_RIGHT_BRACKET键]。
HID_KEY_ENTER键回车。
HID_KEY_LEFT_SHIFT键左shift。
HID_KEY_BACKSLASH键\。
HID_KEY_SEMICOLON键;。
HID_KEY_APOSTROPHE键'。
HID_KEY_SPACE键空格。
HID_KEY_SLASH键/。
HID_KEY_COMMA键,。
HID_KEY_PERIOD键.。
HID_KEY_RIGHT_SHIFT键右shift。
HID_KEY_NUMPAD_0数字键0。
HID_KEY_NUMPAD_1数字键1。
HID_KEY_NUMPAD_2数字键2。
HID_KEY_NUMPAD_3数字键3。
HID_KEY_NUMPAD_4数字键4。
HID_KEY_NUMPAD_5数字键5。
HID_KEY_NUMPAD_6数字键6。
HID_KEY_NUMPAD_7数字键7。
HID_KEY_NUMPAD_8数字键8。
HID_KEY_NUMPAD_9数字键9。
HID_KEY_NUMPAD_DIVIDE数字键/。
HID_KEY_NUMPAD_MULTIPLY数字键*。
HID_KEY_NUMPAD_SUBTRACT数字键-。
HID_KEY_NUMPAD_ADD数字键+。
HID_KEY_NUMPAD_DOT数字键.。
HID_KEY_SYSRQ键打印屏幕。
HID_KEY_DELETE键删除。
HID_KEY_MUTE键静音。
HID_KEY_VOLUME_DOWN键音量-。
HID_KEY_VOLUME_UP键音量+。
HID_KEY_BRIGHTNESS_DOWN键亮度-。
HID_KEY_BRIGHTNESS_UP键亮度+。
HID_BTN_0按钮0。
HID_BTN_1按钮1。
HID_BTN_2按钮2。
HID_BTN_3按钮3。
HID_BTN_4按钮4。
HID_BTN_5按钮5。
HID_BTN_6按钮6。
HID_BTN_7按钮7。
HID_BTN_8按钮8。
HID_BTN_9按钮9。
HID_BTN_LEFT鼠标按键左键。
HID_BTN_RIGHT鼠标按键右键。
HID_BTN_MIDDLE鼠标按键中键。
HID_BTN_SIDE鼠标侧面按键。
HID_BTN_EXTRA鼠标附加按键。
HID_BTN_FORWARD鼠标向前按键。
HID_BTN_BACKWARD鼠标向后按键。
HID_BTN_TASK鼠标任务按键。
HID_BTN_TOOL_PEN画笔。
HID_BTN_TOOL_RUBBER橡皮擦。
HID_BTN_TOOL_BRUSH笔刷。
HID_BTN_TOOL_PENCIL钢笔。
HID_BTN_TOOL_AIRBRUSH喷枪。
HID_BTN_TOOL_FINGER手指。
HID_BTN_TOOL_MOUSE鼠标。
HID_BTN_TOOL_LENS镜头。
HID_BTN_TOOL_QUINT_TAP五指触控。
HID_BTN_STYLUS3手写笔3。
HID_BTN_TOUCH触摸。
HID_BTN_STYLUS手写笔。
HID_BTN_STYLUS2手写笔2。
HID_BTN_TOOL_DOUBLE_TAP二指触控。
HID_BTN_TOOL_TRIPLE_TAP三指触控。
HID_BTN_TOOL_QUAD_TAP四指触控。
HID_BTN_WHEEL滚轮。

Hid_MscEvent

enum Hid_MscEvent

描述

不适合其它类型的输入事件编码。

起始版本： 11

枚举值描述
HID_MSC_SERIAL序列号。
HID_MSC_PULSE_LED脉冲。
HID_MSC_GESTURE手势。
HID_MSC_RAW开始事件。
HID_MSC_SCAN扫描。
HID_MSC_TIMESTAMP时间戳。

Hid_RelAxes

enum Hid_RelAxes

描述

相对坐标编码。

起始版本： 11

枚举值描述
HID_REL_XX轴。
HID_REL_YY轴。
HID_REL_ZZ轴。
HID_REL_RX右模拟摇杆的 X 轴。
HID_REL_RY右模拟摇杆的 Y 轴。
HID_REL_RZ右模拟摇杆的 Z 轴。
HID_REL_HWHEEL水平滚轮。
HID_REL_DIAL刻度。
HID_REL_WHEEL滚轮。
HID_REL_MISC其它。
HID_REL_RESERVED预留。
HID_REL_WHEEL_HI_RES高分辨率滚轮。
HID_REL_HWHEEL_HI_RES高分辨率水平滚轮。

Hid_ReportType

enum Hid_ReportType

描述

报告（HID设备与主机之间交换的数据包）类型定义。

起始版本： 18

枚举值描述
HID_INPUT_REPORT输入报告。
HID_OUTPUT_REPORT输出报告。
HID_FEATURE_REPORT特性报告。

Hid_SynEvent

enum Hid_SynEvent

描述

同步事件编码。

起始版本： 11

枚举值描述
HID_SYN_REPORT表示一个事件的结束。
HID_SYN_CONFIG表示配置同步。
HID_SYN_MT_REPORT表示多点触摸的ABS数据包结束。
HID_SYN_DROPPED表示该事件被丢弃。

函数说明

OH_Hid_Close()

int32_t OH_Hid_Close (Hid_DeviceHandle ** dev)

描述

关闭设备。

起始版本： 18

参数:

名称描述
dev设备操作句柄。

Permission：

ohos.permission.ACCESS_DDK_HID

返回：

  • HID_DDK_SUCCESS 操作成功。

  • HID_DDK_NO_PERM 权限校验失败。

  • HID_DDK_INIT_ERROR DDK未初始化。

  • HID_DDK_SERVICE_ERROR 与DDK服务通信失败。

  • HID_DDK_IO_ERROR I/O操作失败。

  • HID_DDK_INVALID_PARAMETER dev为空。

OH_Hid_CreateDevice()

int32_t OH_Hid_CreateDevice (Hid_Device * hidDevice, Hid_EventProperties * hidEventProperties)

描述

创建设备。

起始版本： 11

参数:

名称描述
hidDevice创建设备需要的基本信息，包括设备名、厂商ID、产品ID等。
hidEventProperties创建的设备关注的事件，包括事件类型、按键事件属性、绝对坐标事件属性、相对坐标事件属性等。

Permission：

ohos.permission.ACCESS_DDK_HID

返回：

  • deviceID (一个非负的数字) 调用接口成功。

  • HID_DDK_NO_PERM 权限校验失败。

  • HID_DDK_INVALID_OPERATION 连接hid_ddk服务失败。

  • HID_DDK_INVALID_PARAMETER 参数校验失败。可能的原因：1. 入参hidDevice为空指针；2. 入参hidEventProperties为空指针；3. properties的长度超过7；4. hidEventTypes的长度超过5；5. hidKeys的长度超过100；6. hidAbs的长度超过26；7. hidRelBits的长度超过13；8. hidMiscellaneous的长度超过6。

  • HID_DDK_FAILURE 设备数量达到最大值200。

OH_Hid_DestroyDevice()

int32_t OH_Hid_DestroyDevice (int32_t deviceId)

描述

销毁设备。

起始版本： 11

参数:

名称描述
deviceId设备ID。

Permission：

ohos.permission.ACCESS_DDK_HID

返回：

  • HID_DDK_SUCCESS 调用接口成功。

  • HID_DDK_NO_PERM 权限校验失败。

  • HID_DDK_INVALID_OPERATION 连接hid_ddk服务失败或者调用方不是设备的创建者。

  • HID_DDK_NULL_PTR 对应设备不存在。

OH_Hid_EmitEvent()

int32_t OH_Hid_EmitEvent (int32_t deviceId, const Hid_EmitItem items[], uint16_t length)

描述

向指定设备发送事件列表。

起始版本： 11

参数:

名称描述
deviceId设备ID。
items发送的事件列表，事件包括类型（取值来源事件类型Hid_EventType）、编码（取值来源同步事件编码Hid_SynEvent、键值编码Hid_KeyCode、按钮编码HidBtnCode、 绝对坐标编码Hid_AbsAxes、相对坐标编码Hid_RelAxes、其它类型的输入事件编码Hid_MscEvent）、值（根据实际设备输入决定）。
length发送事件列表长度（一次发送事件个数）。

Permission：

ohos.permission.ACCESS_DDK_HID

返回：

  • HID_DDK_SUCCESS 调用接口成功。

  • HID_DDK_NO_PERM 权限校验失败。

  • HID_DDK_INVALID_OPERATION 连接hid_ddk服务失败或者调用方不是设备的创建者。

  • HID_DDK_INVALID_PARAMETER 参数校验失败。可能的原因: 1. 设备ID小于0；2. 入参length长度超过7；3. 入参items为空指针。

  • HID_DDK_NULL_PTR 对应设备的注入为空。

  • HID_DDK_FAILURE 对应设备不存在。

OH_Hid_GetPhysicalAddress()

int32_t OH_Hid_GetPhysicalAddress (Hid_DeviceHandle * dev, char * data, uint32_t bufSize)

描述

获取设备物理地址。

起始版本： 18

参数:

名称描述
dev设备操作句柄。
data存放读取数据的缓冲区。
bufSize存放读取数据的缓冲区大小，最大不超过HID_MAX_REPORT_BUFFER_SIZE。

Permission：

ohos.permission.ACCESS_DDK_HID

返回：

  • HID_DDK_SUCCESS 操作成功。

  • HID_DDK_NO_PERM 权限校验失败。

  • HID_DDK_INVALID_PARAMETER 参数校验失败。可能原因：1. dev为空；2. data为空；3. bufSize为0；4. bufSize超过HID_MAX_REPORT_BUFFER_SIZE。 HID_DDK_INIT_ERROR DDK未初始化。

  • HID_DDK_SERVICE_ERROR 与DDK服务通信失败。

  • HID_DDK_MEMORY_ERROR 内存数据拷贝失败。

  • HID_DDK_IO_ERROR I/O操作失败。

  • HID_DDK_INVALID_OPERATION 不支持此操作。

OH_Hid_GetRawInfo()

int32_t OH_Hid_GetRawInfo (Hid_DeviceHandle * dev, Hid_RawDevInfo * rawDevInfo)

描述

获取设备原始信息。

起始版本： 18

参数:

名称描述
dev设备操作句柄。
rawDevInfo设备原始信息，包含供应商ID、产品ID和总线类型。

Permission：

ohos.permission.ACCESS_DDK_HID

返回：

  • HID_DDK_SUCCESS 操作成功。

  • HID_DDK_NO_PERM 权限校验失败。

  • HID_DDK_INVALID_PARAMETER 参数校验失败。可能原因：1. dev为空；2. rawDevInfo为空。

  • HID_DDK_INIT_ERROR DDK未初始化。

  • HID_DDK_SERVICE_ERROR 与DDK服务通信失败。

  • HID_DDK_IO_ERROR I/O操作失败。

  • HID_DDK_INVALID_OPERATION 不支持此操作。

OH_Hid_GetRawName()

int32_t OH_Hid_GetRawName (Hid_DeviceHandle * dev, char * data, uint32_t bufSize)

描述

获取设备原始名称。

起始版本： 18

参数:

名称描述
dev设备操作句柄。
data存放读取数据的缓冲区。
bufSize存放读取数据的缓冲区大小，最大不超过HID_MAX_REPORT_BUFFER_SIZE。

Permission：

ohos.permission.ACCESS_DDK_HID

返回：

  • HID_DDK_SUCCESS 操作成功。

  • HID_DDK_NO_PERM 权限校验失败。

  • HID_DDK_INVALID_PARAMETER 参数校验失败。可能原因：1. dev为空；2. data为空；3. bufSize为0；4. bufSize超过HID_MAX_REPORT_BUFFER_SIZE。 HID_DDK_INIT_ERROR DDK未初始化。

  • HID_DDK_SERVICE_ERROR 与DDK服务通信失败。

  • HID_DDK_MEMORY_ERROR 内存数据拷贝失败。

  • HID_DDK_IO_ERROR I/O操作失败。

  • HID_DDK_INVALID_OPERATION 不支持此操作。

OH_Hid_GetRawUniqueId()

int32_t OH_Hid_GetRawUniqueId (Hid_DeviceHandle * dev, uint8_t * data, uint32_t bufSize)

描述

获取设备原始唯一标识符。

起始版本： 18

参数:

名称描述
dev设备操作句柄。
data存放读取数据的缓冲区。
bufSize存放读取数据的缓冲区大小，最大不超过HID_MAX_REPORT_BUFFER_SIZE。

Permission：

ohos.permission.ACCESS_DDK_HID

返回：

  • HID_DDK_SUCCESS 操作成功。

  • HID_DDK_NO_PERM 权限校验失败。

  • HID_DDK_INVALID_PARAMETER 参数校验失败。可能原因：1. dev为空；2. data为空；3. bufSize为0；4. bufSize超过HID_MAX_REPORT_BUFFER_SIZE。 HID_DDK_INIT_ERROR DDK未初始化。

  • HID_DDK_SERVICE_ERROR 与DDK服务通信失败。

  • HID_DDK_MEMORY_ERROR 内存数据拷贝失败。

  • HID_DDK_IO_ERROR I/O操作失败。

  • HID_DDK_INVALID_OPERATION 不支持此操作。

OH_Hid_GetReport()

int32_t OH_Hid_GetReport (Hid_DeviceHandle * dev, Hid_ReportType reportType, uint8_t * data, uint32_t bufSize)

描述

获取设备报告。

起始版本： 18

参数:

名称描述
dev设备操作句柄。
reportType报告类型。
data存放读取数据的缓冲区。
bufSize存放读取数据的缓冲区大小，最大不超过HID_MAX_REPORT_BUFFER_SIZE。

Permission：

ohos.permission.ACCESS_DDK_HID

返回：

  • HID_DDK_SUCCESS 操作成功。

  • HID_DDK_NO_PERM 权限校验失败。

  • HID_DDK_INVALID_PARAMETER 参数校验失败。可能原因：1. dev为空；2. data为空；3. bufSize为0；4. bufSize超过HID_MAX_REPORT_BUFFER_SIZE。

  • HID_DDK_INIT_ERROR DDK未初始化。

  • HID_DDK_SERVICE_ERROR 与DDK服务通信失败。

  • HID_DDK_MEMORY_ERROR 内存数据拷贝失败。

  • HID_DDK_IO_ERROR I/O操作失败。

  • HID_DDK_INVALID_OPERATION 不支持此操作。

OH_Hid_GetReportDescriptor()

int32_t OH_Hid_GetReportDescriptor (Hid_DeviceHandle * dev, uint8_t * buf, uint32_t bufSize, uint32_t * bytesRead)

描述

获取设备报告描述符。

起始版本： 18

参数:

名称描述
dev设备操作句柄。
buf存放描述符的缓冲区。
bufSize缓冲区的字节大小，最大不超过HID_MAX_REPORT_BUFFER_SIZE。
bytesRead读取的字节数。

Permission：

ohos.permission.ACCESS_DDK_HID

返回：

  • HID_DDK_SUCCESS 操作成功。

  • HID_DDK_NO_PERM 权限校验失败。

  • HID_DDK_INVALID_PARAMETER 参数校验失败。可能原因：1. dev为空；2. buf为空；3. bufSize为0；4. bufSize超过HID_MAX_REPORT_BUFFER_SIZE；5. bytesRead为空。

  • HID_DDK_INIT_ERROR DDK未初始化。

  • HID_DDK_SERVICE_ERROR 与DDK服务通信失败。

  • HID_DDK_MEMORY_ERROR 内存数据拷贝失败。

  • HID_DDK_IO_ERROR I/O操作失败。

  • HID_DDK_INVALID_OPERATION 不支持此操作。

OH_Hid_Init()

int32_t OH_Hid_Init (void)

描述

初始化HID DDK。

起始版本： 18

Permission：

ohos.permission.ACCESS_DDK_HID

返回：

  • HID_DDK_SUCCESS 操作成功。

  • HID_DDK_NO_PERM 权限校验失败。

  • HID_DDK_INIT_ERROR 初始化DDK失败。

  • HID_DDK_SERVICE_ERROR 与DDK服务通信失败。

OH_Hid_Open()

int32_t OH_Hid_Open (uint64_t deviceId, uint8_t interfaceIndex, Hid_DeviceHandle ** dev)

描述

打开deviceId和interfaceIndex指定的设备。

起始版本： 18

参数:

名称描述
deviceId操作设备的ID。
interfaceIndex接口索引，对应HID设备的接口。
dev设备操作句柄。

Permission：

ohos.permission.ACCESS_DDK_HID

返回：

  • HID_DDK_SUCCESS 操作成功。

  • HID_DDK_NO_PERM 权限校验失败。

  • HID_DDK_INIT_ERROR DDK未初始化。

  • HID_DDK_SERVICE_ERROR 与DDK服务通信失败。

  • HID_DDK_MEMORY_ERROR dev内存申请失败。

  • HID_DDK_IO_ERROR I/O操作失败。

  • HID_DDK_INVALID_PARAMETER dev为空。

  • HID_DDK_DEVICE_NOT_FOUND 根据deviceId和interfaceIndex找不到设备。

OH_Hid_Read()

int32_t OH_Hid_Read (Hid_DeviceHandle * dev, uint8_t * data, uint32_t bufSize, uint32_t * bytesRead)

描述

从设备读取报告，默认为阻塞模式（阻塞等待直到有数据可读取），可以调用OH_Hid_SetNonBlocking改变模式。

起始版本： 18

参数:

名称描述
dev设备操作句柄。
data存放读取数据的缓冲区。
bufSize存放读取数据的缓冲区大小，最大不超过HID_MAX_REPORT_BUFFER_SIZE。
bytesRead读取的字节数。

Permission：

ohos.permission.ACCESS_DDK_HID

返回：

  • HID_DDK_SUCCESS 操作成功。

  • HID_DDK_NO_PERM 权限校验失败。

  • HID_DDK_INVALID_PARAMETER 参数校验失败。可能原因：1. dev为空；2. data为空；3. bufSize为0；4. bufSize超过HID_MAX_REPORT_BUFFER_SIZE；5. bytesRead为空。

  • HID_DDK_INIT_ERROR DDK未初始化。

  • HID_DDK_SERVICE_ERROR 与DDK服务通信失败。

  • HID_DDK_MEMORY_ERROR 内存数据拷贝失败。

  • HID_DDK_IO_ERROR I/O操作失败。

  • HID_DDK_TIMEOUT 读取超时。

OH_Hid_ReadTimeout()

int32_t OH_Hid_ReadTimeout (Hid_DeviceHandle * dev, uint8_t * data, uint32_t bufSize, int timeout, uint32_t * bytesRead)

描述

在指定的超时时间内从设备读取报告。

起始版本： 18

参数:

名称描述
dev设备操作句柄。
data存放读取数据的缓冲区。
bufSize存放读取数据的缓冲区大小，最大不超过HID_MAX_REPORT_BUFFER_SIZE。
timeout超时时间（毫秒）或-1表示阻塞等待。
bytesRead读取的字节数。

Permission：

ohos.permission.ACCESS_DDK_HID

返回：

  • HID_DDK_SUCCESS 操作成功。

  • HID_DDK_NO_PERM 权限校验失败。

  • HID_DDK_INVALID_PARAMETER 参数校验失败。可能原因：1. dev为空；2. data为空；3. bufSize为0；4. bufSize超过HID_MAX_REPORT_BUFFER_SIZE；5. bytesRead为空。

  • HID_DDK_INIT_ERROR DDK未初始化。

  • HID_DDK_SERVICE_ERROR 与DDK服务通信失败。

  • HID_DDK_MEMORY_ERROR 内存数据拷贝失败。

  • HID_DDK_IO_ERROR I/O操作失败。

  • HID_DDK_TIMEOUT 读取超时。

OH_Hid_Release()

int32_t OH_Hid_Release (void)

描述

释放HID DDK。

起始版本： 18

Permission：

ohos.permission.ACCESS_DDK_HID

返回：

  • HID_DDK_SUCCESS 操作成功。

  • HID_DDK_NO_PERM 权限校验失败。

  • HID_DDK_INIT_ERROR DDK未初始化。

  • HID_DDK_SERVICE_ERROR 与DDK服务通信失败。

OH_Hid_SendReport()

int32_t OH_Hid_SendReport (Hid_DeviceHandle * dev, Hid_ReportType reportType, const uint8_t * data, uint32_t length)

描述

向设备发送报告。

起始版本： 18

参数:

名称描述
dev设备操作句柄。
reportType报告类型。
data待发送的数据。
length发送数据的字节长度，最大不超过HID_MAX_REPORT_BUFFER_SIZE。

Permission：

ohos.permission.ACCESS_DDK_HID

返回：

  • HID_DDK_SUCCESS 操作成功。

  • HID_DDK_NO_PERM 权限校验失败。

  • HID_DDK_INVALID_PARAMETER 参数校验失败。可能原因：1. dev为空；2. data为空；3. length为0；4. length超过HID_MAX_REPORT_BUFFER_SIZE。

  • HID_DDK_INIT_ERROR DDK未初始化。

  • HID_DDK_SERVICE_ERROR 与DDK服务通信失败。

  • HID_DDK_IO_ERROR I/O操作失败。

  • HID_DDK_INVALID_OPERATION 不支持此操作。

OH_Hid_SetNonBlocking()

int32_t OH_Hid_SetNonBlocking (Hid_DeviceHandle * dev, int nonBlock)

描述

设置设备读取模式为非阻塞。

起始版本： 18

参数:

名称描述
dev设备操作句柄。
nonBlock是否启用非阻塞模式读取数据。
- 1：启用非阻塞模式，调用OH_Hid_Read接口时，如果设备有可读的数据，读取并返回HID_DDK_SUCCESS，如果设备没有数据可读，则返回HID_DDK_TIMEOUT。
- 0：禁用非阻塞模式。

Permission：

ohos.permission.ACCESS_DDK_HID

返回：

  • HID_DDK_SUCCESS 操作成功。

  • HID_DDK_NO_PERM 权限校验失败。

  • HID_DDK_INIT_ERROR DDK未初始化。

  • HID_DDK_INVALID_PARAMETER 参数校验失败。可能原因：1. dev为空；2. nonBlock不是1或0。

  • HID_DDK_SERVICE_ERROR 与DDK服务通信失败。

OH_Hid_Write()

int32_t OH_Hid_Write (Hid_DeviceHandle * dev, uint8_t * data, uint32_t length, uint32_t * bytesWritten)

描述

向设备写入报告。

起始版本： 18

参数:

名称描述
dev设备操作句柄。
data待写入的数据。
length写入数据的字节长度，最大不超过HID_MAX_REPORT_BUFFER_SIZE。
bytesWritten实际写入的数据字节数。

Permission：

ohos.permission.ACCESS_DDK_HID

返回：

  • HID_DDK_SUCCESS 操作成功。

  • HID_DDK_NO_PERM 权限校验失败。

  • HID_DDK_INVALID_PARAMETER 参数校验失败。可能原因：1. dev为空；2. data为空；3. length为0；4. length超过HID_MAX_REPORT_BUFFER_SIZE；5. bytesWritten为空。

  • HID_DDK_INIT_ERROR DDK未初始化。

  • HID_DDK_SERVICE_ERROR 与DDK服务通信失败。

  • HID_DDK_IO_ERROR I/O操作失败。

变量说明

bustype

uint16_t Hid_Device::bustype

描述

总线类型。

busType

uint32_t Hid_RawDevInfo::busType

描述

总线类型。

code

uint16_t Hid_EmitItem::code

描述

事件编码。

deviceName

const char* Hid_Device::deviceName

描述

设备名称。

hidAbs

struct Hid_AbsAxesArray Hid_EventProperties::hidAbs

描述

绝对坐标属性编码数组。

hidAbsAxes

Hid_AbsAxes* Hid_AbsAxesArray::hidAbsAxes

描述

绝对坐标属性编码。

hidAbsFlat

int32_t Hid_EventProperties::hidAbsFlat[64]

描述

绝对坐标属性固定值。

hidAbsFuzz

int32_t Hid_EventProperties::hidAbsFuzz[64]

描述

绝对坐标属性模糊值。

hidAbsMax

int32_t Hid_EventProperties::hidAbsMax[64]

描述

绝对坐标属性最大值。

hidAbsMin

int32_t Hid_EventProperties::hidAbsMin[64]

描述

绝对坐标属性最小值。

hidEventType

Hid_EventType* Hid_EventTypeArray::hidEventType

描述

事件类型编码。

hidEventTypes

struct Hid_EventTypeArray Hid_EventProperties::hidEventTypes

描述

事件类型属性编码数组。

hidKeyCode

Hid_KeyCode* Hid_KeyCodeArray::hidKeyCode

描述

键值编码。

hidKeys

struct Hid_KeyCodeArray Hid_EventProperties::hidKeys

描述

键值属性编码数组。

hidMiscellaneous

struct Hid_MscEventArray Hid_EventProperties::hidMiscellaneous

描述

其它特殊事件属性编码数组。

hidMscEvent

Hid_MscEvent* Hid_MscEventArray::hidMscEvent

描述

其它特殊事件属性编码。

hidRelAxes

Hid_RelAxes* Hid_RelAxesArray::hidRelAxes

描述

相对坐标属性编码。

hidRelBits

struct Hid_RelAxesArray Hid_EventProperties::hidRelBits

描述

相对坐标属性编码数组。

length [1/5]

uint16_t Hid_EventTypeArray::length

描述

数组长度。

length [2/5]

uint16_t Hid_KeyCodeArray::length

描述

数组长度。

length [3/5]

uint16_t Hid_AbsAxesArray::length

描述

数组长度。

length [4/5]

uint16_t Hid_RelAxesArray::length

描述

数组长度。

length [5/5]

uint16_t Hid_MscEventArray::length

描述

数组长度。

product

uint16_t Hid_RawDevInfo::product

描述

产品ID。

productId

uint16_t Hid_Device::productId

描述

产品ID。

properties

Hid_DeviceProp* Hid_Device::properties

描述

设备特性。

propLength

uint16_t Hid_Device::propLength

描述

设备特性数量。

type

uint16_t Hid_EmitItem::type

描述

事件类型。

value

uint32_t Hid_EmitItem::value

描述

事件值。

vendor

uint16_t Hid_RawDevInfo::vendor

描述

供应商ID。

vendorId

uint16_t Hid_Device::vendorId

描述

厂商ID。

version

uint16_t Hid_Device::version

描述

版本号。

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Driver Development Kit（驱动开发服务）

harmony 鸿蒙Base DDK

harmony 鸿蒙DDK_Ashmem

harmony 鸿蒙Hid_AbsAxesArray

harmony 鸿蒙Hid_Device

harmony 鸿蒙Hid_EmitItem

harmony 鸿蒙Hid_EventProperties

harmony 鸿蒙Hid_EventTypeArray

harmony 鸿蒙Hid_KeyCodeArray

harmony 鸿蒙Hid_MscEventArray

  • 所属分类： 后端技术
  • 本文标签： 鸿蒙 软件
  • 版权声明： 本文链接 https://seaxiang.com/blog/2LkdQM