blob: aaa86d6bd1dd921ab0637f232ced8678c60e8849 [file] [log] [blame]
David Herrmannace3d862012-06-10 15:16:14 +02001#ifndef __UHID_H_
2#define __UHID_H_
3
4/*
5 * User-space I/O driver support for HID subsystem
6 * Copyright (c) 2012 David Herrmann
7 */
8
9/*
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by the Free
12 * Software Foundation; either version 2 of the License, or (at your option)
13 * any later version.
14 */
15
16/*
17 * Public header for user-space communication. We try to keep every structure
18 * aligned but to be safe we also use __attribute__((__packed__)). Therefore,
19 * the communication should be ABI compatible even between architectures.
20 */
21
22#include <linux/input.h>
23#include <linux/types.h>
Petri Gynther45226432014-03-24 13:50:01 -070024#include <linux/hid.h>
David Herrmannace3d862012-06-10 15:16:14 +020025
26enum uhid_event_type {
David Herrmann50598e72014-07-29 17:14:22 +020027 __UHID_LEGACY_CREATE,
David Herrmannd365c6c2012-06-10 15:16:18 +020028 UHID_DESTROY,
David Herrmannec4b7de2012-06-10 15:16:21 +020029 UHID_START,
30 UHID_STOP,
David Herrmanne7191472012-06-10 15:16:22 +020031 UHID_OPEN,
32 UHID_CLOSE,
David Herrmann3b3baa82012-06-10 15:16:24 +020033 UHID_OUTPUT,
David Herrmann50598e72014-07-29 17:14:22 +020034 __UHID_LEGACY_OUTPUT_EV,
35 __UHID_LEGACY_INPUT,
36 UHID_GET_REPORT,
37 UHID_GET_REPORT_REPLY,
Petri Gynther45226432014-03-24 13:50:01 -070038 UHID_CREATE2,
39 UHID_INPUT2,
David Herrmann11c22152014-07-29 17:14:24 +020040 UHID_SET_REPORT,
41 UHID_SET_REPORT_REPLY,
David Herrmannace3d862012-06-10 15:16:14 +020042};
43
Petri Gynther45226432014-03-24 13:50:01 -070044struct uhid_create2_req {
45 __u8 name[128];
46 __u8 phys[64];
47 __u8 uniq[64];
48 __u16 rd_size;
49 __u16 bus;
50 __u32 vendor;
51 __u32 product;
52 __u32 version;
53 __u32 country;
54 __u8 rd_data[HID_MAX_DESCRIPTOR_SIZE];
55} __attribute__((__packed__));
56
David Herrmannc2b2f162014-07-29 17:14:25 +020057enum uhid_dev_flag {
58 UHID_DEV_NUMBERED_FEATURE_REPORTS = (1ULL << 0),
59 UHID_DEV_NUMBERED_OUTPUT_REPORTS = (1ULL << 1),
60 UHID_DEV_NUMBERED_INPUT_REPORTS = (1ULL << 2),
61};
62
63struct uhid_start_req {
64 __u64 dev_flags;
65};
66
David Herrmann5e87a362012-06-10 15:16:19 +020067#define UHID_DATA_MAX 4096
68
David Herrmann3b3baa82012-06-10 15:16:24 +020069enum uhid_report_type {
70 UHID_FEATURE_REPORT,
71 UHID_OUTPUT_REPORT,
72 UHID_INPUT_REPORT,
73};
74
Petri Gynther45226432014-03-24 13:50:01 -070075struct uhid_input2_req {
76 __u16 size;
77 __u8 data[UHID_DATA_MAX];
78} __attribute__((__packed__));
79
David Herrmann3b3baa82012-06-10 15:16:24 +020080struct uhid_output_req {
81 __u8 data[UHID_DATA_MAX];
82 __u16 size;
83 __u8 rtype;
84} __attribute__((__packed__));
85
David Herrmann50598e72014-07-29 17:14:22 +020086struct uhid_get_report_req {
87 __u32 id;
88 __u8 rnum;
89 __u8 rtype;
90} __attribute__((__packed__));
91
92struct uhid_get_report_reply_req {
93 __u32 id;
94 __u16 err;
95 __u16 size;
96 __u8 data[UHID_DATA_MAX];
97} __attribute__((__packed__));
98
David Herrmann11c22152014-07-29 17:14:24 +020099struct uhid_set_report_req {
100 __u32 id;
101 __u8 rnum;
102 __u8 rtype;
103 __u16 size;
104 __u8 data[UHID_DATA_MAX];
105} __attribute__((__packed__));
106
107struct uhid_set_report_reply_req {
108 __u32 id;
109 __u16 err;
110} __attribute__((__packed__));
111
David Herrmann50598e72014-07-29 17:14:22 +0200112/*
113 * Compat Layer
114 * All these commands and requests are obsolete. You should avoid using them in
115 * new code. We support them for backwards-compatibility, but you might not get
116 * access to new feature in case you use them.
117 */
118
119enum uhid_legacy_event_type {
120 UHID_CREATE = __UHID_LEGACY_CREATE,
121 UHID_OUTPUT_EV = __UHID_LEGACY_OUTPUT_EV,
122 UHID_INPUT = __UHID_LEGACY_INPUT,
123 UHID_FEATURE = UHID_GET_REPORT,
124 UHID_FEATURE_ANSWER = UHID_GET_REPORT_REPLY,
125};
126
127/* Obsolete! Use UHID_CREATE2. */
128struct uhid_create_req {
129 __u8 name[128];
130 __u8 phys[64];
131 __u8 uniq[64];
132 __u8 __user *rd_data;
133 __u16 rd_size;
134
135 __u16 bus;
136 __u32 vendor;
137 __u32 product;
138 __u32 version;
139 __u32 country;
140} __attribute__((__packed__));
141
142/* Obsolete! Use UHID_INPUT2. */
143struct uhid_input_req {
144 __u8 data[UHID_DATA_MAX];
145 __u16 size;
146} __attribute__((__packed__));
147
148/* Obsolete! Kernel uses UHID_OUTPUT exclusively now. */
David Herrmannf80e1362012-06-10 15:16:23 +0200149struct uhid_output_ev_req {
150 __u16 type;
151 __u16 code;
152 __s32 value;
153} __attribute__((__packed__));
154
David Herrmannfa71f322014-07-29 17:14:21 +0200155/* Obsolete! Kernel uses ABI compatible UHID_GET_REPORT. */
David Herrmannfcfcf0d2012-06-10 15:16:25 +0200156struct uhid_feature_req {
157 __u32 id;
158 __u8 rnum;
159 __u8 rtype;
160} __attribute__((__packed__));
161
David Herrmannfa71f322014-07-29 17:14:21 +0200162/* Obsolete! Use ABI compatible UHID_GET_REPORT_REPLY. */
David Herrmannfcfcf0d2012-06-10 15:16:25 +0200163struct uhid_feature_answer_req {
164 __u32 id;
165 __u16 err;
166 __u16 size;
167 __u8 data[UHID_DATA_MAX];
David Herrmannfee5dfe2012-12-17 13:20:43 +0100168} __attribute__((__packed__));
David Herrmannfcfcf0d2012-06-10 15:16:25 +0200169
David Herrmann50598e72014-07-29 17:14:22 +0200170/*
171 * UHID Events
172 * All UHID events from and to the kernel are encoded as "struct uhid_event".
173 * The "type" field contains a UHID_* type identifier. All payload depends on
174 * that type and can be accessed via ev->u.XYZ accordingly.
175 * If user-space writes short events, they're extended with 0s by the kernel. If
176 * the kernel writes short events, user-space shall extend them with 0s.
177 */
David Herrmannfa71f322014-07-29 17:14:21 +0200178
David Herrmannace3d862012-06-10 15:16:14 +0200179struct uhid_event {
180 __u32 type;
David Herrmannd365c6c2012-06-10 15:16:18 +0200181
182 union {
183 struct uhid_create_req create;
David Herrmann5e87a362012-06-10 15:16:19 +0200184 struct uhid_input_req input;
David Herrmann3b3baa82012-06-10 15:16:24 +0200185 struct uhid_output_req output;
David Herrmannf80e1362012-06-10 15:16:23 +0200186 struct uhid_output_ev_req output_ev;
David Herrmannfcfcf0d2012-06-10 15:16:25 +0200187 struct uhid_feature_req feature;
David Herrmannfa71f322014-07-29 17:14:21 +0200188 struct uhid_get_report_req get_report;
David Herrmannfcfcf0d2012-06-10 15:16:25 +0200189 struct uhid_feature_answer_req feature_answer;
David Herrmannfa71f322014-07-29 17:14:21 +0200190 struct uhid_get_report_reply_req get_report_reply;
Petri Gynther45226432014-03-24 13:50:01 -0700191 struct uhid_create2_req create2;
192 struct uhid_input2_req input2;
David Herrmann11c22152014-07-29 17:14:24 +0200193 struct uhid_set_report_req set_report;
194 struct uhid_set_report_reply_req set_report_reply;
David Herrmannc2b2f162014-07-29 17:14:25 +0200195 struct uhid_start_req start;
David Herrmannd365c6c2012-06-10 15:16:18 +0200196 } u;
David Herrmannace3d862012-06-10 15:16:14 +0200197} __attribute__((__packed__));
198
199#endif /* __UHID_H_ */