1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */ 2*4882a593Smuzhiyun #ifndef __UHID_H_ 3*4882a593Smuzhiyun #define __UHID_H_ 4*4882a593Smuzhiyun 5*4882a593Smuzhiyun /* 6*4882a593Smuzhiyun * User-space I/O driver support for HID subsystem 7*4882a593Smuzhiyun * Copyright (c) 2012 David Herrmann 8*4882a593Smuzhiyun */ 9*4882a593Smuzhiyun 10*4882a593Smuzhiyun /* 11*4882a593Smuzhiyun * This program is free software; you can redistribute it and/or modify it 12*4882a593Smuzhiyun * under the terms of the GNU General Public License as published by the Free 13*4882a593Smuzhiyun * Software Foundation; either version 2 of the License, or (at your option) 14*4882a593Smuzhiyun * any later version. 15*4882a593Smuzhiyun */ 16*4882a593Smuzhiyun 17*4882a593Smuzhiyun /* 18*4882a593Smuzhiyun * Public header for user-space communication. We try to keep every structure 19*4882a593Smuzhiyun * aligned but to be safe we also use __attribute__((__packed__)). Therefore, 20*4882a593Smuzhiyun * the communication should be ABI compatible even between architectures. 21*4882a593Smuzhiyun */ 22*4882a593Smuzhiyun 23*4882a593Smuzhiyun #include <linux/input.h> 24*4882a593Smuzhiyun #include <linux/types.h> 25*4882a593Smuzhiyun #include <linux/hid.h> 26*4882a593Smuzhiyun 27*4882a593Smuzhiyun enum uhid_event_type { 28*4882a593Smuzhiyun __UHID_LEGACY_CREATE, 29*4882a593Smuzhiyun UHID_DESTROY, 30*4882a593Smuzhiyun UHID_START, 31*4882a593Smuzhiyun UHID_STOP, 32*4882a593Smuzhiyun UHID_OPEN, 33*4882a593Smuzhiyun UHID_CLOSE, 34*4882a593Smuzhiyun UHID_OUTPUT, 35*4882a593Smuzhiyun __UHID_LEGACY_OUTPUT_EV, 36*4882a593Smuzhiyun __UHID_LEGACY_INPUT, 37*4882a593Smuzhiyun UHID_GET_REPORT, 38*4882a593Smuzhiyun UHID_GET_REPORT_REPLY, 39*4882a593Smuzhiyun UHID_CREATE2, 40*4882a593Smuzhiyun UHID_INPUT2, 41*4882a593Smuzhiyun UHID_SET_REPORT, 42*4882a593Smuzhiyun UHID_SET_REPORT_REPLY, 43*4882a593Smuzhiyun }; 44*4882a593Smuzhiyun 45*4882a593Smuzhiyun struct uhid_create2_req { 46*4882a593Smuzhiyun __u8 name[128]; 47*4882a593Smuzhiyun __u8 phys[64]; 48*4882a593Smuzhiyun __u8 uniq[64]; 49*4882a593Smuzhiyun __u16 rd_size; 50*4882a593Smuzhiyun __u16 bus; 51*4882a593Smuzhiyun __u32 vendor; 52*4882a593Smuzhiyun __u32 product; 53*4882a593Smuzhiyun __u32 version; 54*4882a593Smuzhiyun __u32 country; 55*4882a593Smuzhiyun __u8 rd_data[HID_MAX_DESCRIPTOR_SIZE]; 56*4882a593Smuzhiyun } __attribute__((__packed__)); 57*4882a593Smuzhiyun 58*4882a593Smuzhiyun enum uhid_dev_flag { 59*4882a593Smuzhiyun UHID_DEV_NUMBERED_FEATURE_REPORTS = (1ULL << 0), 60*4882a593Smuzhiyun UHID_DEV_NUMBERED_OUTPUT_REPORTS = (1ULL << 1), 61*4882a593Smuzhiyun UHID_DEV_NUMBERED_INPUT_REPORTS = (1ULL << 2), 62*4882a593Smuzhiyun }; 63*4882a593Smuzhiyun 64*4882a593Smuzhiyun struct uhid_start_req { 65*4882a593Smuzhiyun __u64 dev_flags; 66*4882a593Smuzhiyun }; 67*4882a593Smuzhiyun 68*4882a593Smuzhiyun #define UHID_DATA_MAX 4096 69*4882a593Smuzhiyun 70*4882a593Smuzhiyun enum uhid_report_type { 71*4882a593Smuzhiyun UHID_FEATURE_REPORT, 72*4882a593Smuzhiyun UHID_OUTPUT_REPORT, 73*4882a593Smuzhiyun UHID_INPUT_REPORT, 74*4882a593Smuzhiyun }; 75*4882a593Smuzhiyun 76*4882a593Smuzhiyun struct uhid_input2_req { 77*4882a593Smuzhiyun __u16 size; 78*4882a593Smuzhiyun __u8 data[UHID_DATA_MAX]; 79*4882a593Smuzhiyun } __attribute__((__packed__)); 80*4882a593Smuzhiyun 81*4882a593Smuzhiyun struct uhid_output_req { 82*4882a593Smuzhiyun __u8 data[UHID_DATA_MAX]; 83*4882a593Smuzhiyun __u16 size; 84*4882a593Smuzhiyun __u8 rtype; 85*4882a593Smuzhiyun } __attribute__((__packed__)); 86*4882a593Smuzhiyun 87*4882a593Smuzhiyun struct uhid_get_report_req { 88*4882a593Smuzhiyun __u32 id; 89*4882a593Smuzhiyun __u8 rnum; 90*4882a593Smuzhiyun __u8 rtype; 91*4882a593Smuzhiyun } __attribute__((__packed__)); 92*4882a593Smuzhiyun 93*4882a593Smuzhiyun struct uhid_get_report_reply_req { 94*4882a593Smuzhiyun __u32 id; 95*4882a593Smuzhiyun __u16 err; 96*4882a593Smuzhiyun __u16 size; 97*4882a593Smuzhiyun __u8 data[UHID_DATA_MAX]; 98*4882a593Smuzhiyun } __attribute__((__packed__)); 99*4882a593Smuzhiyun 100*4882a593Smuzhiyun struct uhid_set_report_req { 101*4882a593Smuzhiyun __u32 id; 102*4882a593Smuzhiyun __u8 rnum; 103*4882a593Smuzhiyun __u8 rtype; 104*4882a593Smuzhiyun __u16 size; 105*4882a593Smuzhiyun __u8 data[UHID_DATA_MAX]; 106*4882a593Smuzhiyun } __attribute__((__packed__)); 107*4882a593Smuzhiyun 108*4882a593Smuzhiyun struct uhid_set_report_reply_req { 109*4882a593Smuzhiyun __u32 id; 110*4882a593Smuzhiyun __u16 err; 111*4882a593Smuzhiyun } __attribute__((__packed__)); 112*4882a593Smuzhiyun 113*4882a593Smuzhiyun /* 114*4882a593Smuzhiyun * Compat Layer 115*4882a593Smuzhiyun * All these commands and requests are obsolete. You should avoid using them in 116*4882a593Smuzhiyun * new code. We support them for backwards-compatibility, but you might not get 117*4882a593Smuzhiyun * access to new feature in case you use them. 118*4882a593Smuzhiyun */ 119*4882a593Smuzhiyun 120*4882a593Smuzhiyun enum uhid_legacy_event_type { 121*4882a593Smuzhiyun UHID_CREATE = __UHID_LEGACY_CREATE, 122*4882a593Smuzhiyun UHID_OUTPUT_EV = __UHID_LEGACY_OUTPUT_EV, 123*4882a593Smuzhiyun UHID_INPUT = __UHID_LEGACY_INPUT, 124*4882a593Smuzhiyun UHID_FEATURE = UHID_GET_REPORT, 125*4882a593Smuzhiyun UHID_FEATURE_ANSWER = UHID_GET_REPORT_REPLY, 126*4882a593Smuzhiyun }; 127*4882a593Smuzhiyun 128*4882a593Smuzhiyun /* Obsolete! Use UHID_CREATE2. */ 129*4882a593Smuzhiyun struct uhid_create_req { 130*4882a593Smuzhiyun __u8 name[128]; 131*4882a593Smuzhiyun __u8 phys[64]; 132*4882a593Smuzhiyun __u8 uniq[64]; 133*4882a593Smuzhiyun __u8 __user *rd_data; 134*4882a593Smuzhiyun __u16 rd_size; 135*4882a593Smuzhiyun 136*4882a593Smuzhiyun __u16 bus; 137*4882a593Smuzhiyun __u32 vendor; 138*4882a593Smuzhiyun __u32 product; 139*4882a593Smuzhiyun __u32 version; 140*4882a593Smuzhiyun __u32 country; 141*4882a593Smuzhiyun } __attribute__((__packed__)); 142*4882a593Smuzhiyun 143*4882a593Smuzhiyun /* Obsolete! Use UHID_INPUT2. */ 144*4882a593Smuzhiyun struct uhid_input_req { 145*4882a593Smuzhiyun __u8 data[UHID_DATA_MAX]; 146*4882a593Smuzhiyun __u16 size; 147*4882a593Smuzhiyun } __attribute__((__packed__)); 148*4882a593Smuzhiyun 149*4882a593Smuzhiyun /* Obsolete! Kernel uses UHID_OUTPUT exclusively now. */ 150*4882a593Smuzhiyun struct uhid_output_ev_req { 151*4882a593Smuzhiyun __u16 type; 152*4882a593Smuzhiyun __u16 code; 153*4882a593Smuzhiyun __s32 value; 154*4882a593Smuzhiyun } __attribute__((__packed__)); 155*4882a593Smuzhiyun 156*4882a593Smuzhiyun /* Obsolete! Kernel uses ABI compatible UHID_GET_REPORT. */ 157*4882a593Smuzhiyun struct uhid_feature_req { 158*4882a593Smuzhiyun __u32 id; 159*4882a593Smuzhiyun __u8 rnum; 160*4882a593Smuzhiyun __u8 rtype; 161*4882a593Smuzhiyun } __attribute__((__packed__)); 162*4882a593Smuzhiyun 163*4882a593Smuzhiyun /* Obsolete! Use ABI compatible UHID_GET_REPORT_REPLY. */ 164*4882a593Smuzhiyun struct uhid_feature_answer_req { 165*4882a593Smuzhiyun __u32 id; 166*4882a593Smuzhiyun __u16 err; 167*4882a593Smuzhiyun __u16 size; 168*4882a593Smuzhiyun __u8 data[UHID_DATA_MAX]; 169*4882a593Smuzhiyun } __attribute__((__packed__)); 170*4882a593Smuzhiyun 171*4882a593Smuzhiyun /* 172*4882a593Smuzhiyun * UHID Events 173*4882a593Smuzhiyun * All UHID events from and to the kernel are encoded as "struct uhid_event". 174*4882a593Smuzhiyun * The "type" field contains a UHID_* type identifier. All payload depends on 175*4882a593Smuzhiyun * that type and can be accessed via ev->u.XYZ accordingly. 176*4882a593Smuzhiyun * If user-space writes short events, they're extended with 0s by the kernel. If 177*4882a593Smuzhiyun * the kernel writes short events, user-space shall extend them with 0s. 178*4882a593Smuzhiyun */ 179*4882a593Smuzhiyun 180*4882a593Smuzhiyun struct uhid_event { 181*4882a593Smuzhiyun __u32 type; 182*4882a593Smuzhiyun 183*4882a593Smuzhiyun union { 184*4882a593Smuzhiyun struct uhid_create_req create; 185*4882a593Smuzhiyun struct uhid_input_req input; 186*4882a593Smuzhiyun struct uhid_output_req output; 187*4882a593Smuzhiyun struct uhid_output_ev_req output_ev; 188*4882a593Smuzhiyun struct uhid_feature_req feature; 189*4882a593Smuzhiyun struct uhid_get_report_req get_report; 190*4882a593Smuzhiyun struct uhid_feature_answer_req feature_answer; 191*4882a593Smuzhiyun struct uhid_get_report_reply_req get_report_reply; 192*4882a593Smuzhiyun struct uhid_create2_req create2; 193*4882a593Smuzhiyun struct uhid_input2_req input2; 194*4882a593Smuzhiyun struct uhid_set_report_req set_report; 195*4882a593Smuzhiyun struct uhid_set_report_reply_req set_report_reply; 196*4882a593Smuzhiyun struct uhid_start_req start; 197*4882a593Smuzhiyun } u; 198*4882a593Smuzhiyun } __attribute__((__packed__)); 199*4882a593Smuzhiyun 200*4882a593Smuzhiyun #endif /* __UHID_H_ */ 201