[linux.git] / include / uapi / linux / uhid.h

#ifndef __UHID_H_
#define __UHID_H_

/*
 * User-space I/O driver support for HID subsystem
 * Copyright (c) 2012 David Herrmann
 */

/*
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation; either version 2 of the License, or (at your option)
 * any later version.
 */

/*
 * Public header for user-space communication. We try to keep every structure
 * aligned but to be safe we also use __attribute__((__packed__)). Therefore,
 * the communication should be ABI compatible even between architectures.
 */

#include <linux/input.h>
#include <linux/types.h>
#include <linux/hid.h>

enum uhid_event_type {
	UHID_CREATE,
	UHID_DESTROY,
	UHID_START,
	UHID_STOP,
	UHID_OPEN,
	UHID_CLOSE,
	UHID_OUTPUT,
	UHID_OUTPUT_EV,			/* obsolete! */
	UHID_INPUT,
	UHID_FEATURE,
	UHID_FEATURE_ANSWER,
	UHID_CREATE2,
	UHID_INPUT2,
};

struct uhid_create_req {
	__u8 name[128];
	__u8 phys[64];
	__u8 uniq[64];
	__u8 __user *rd_data;
	__u16 rd_size;

	__u16 bus;
	__u32 vendor;
	__u32 product;
	__u32 version;
	__u32 country;
} __attribute__((__packed__));

struct uhid_create2_req {
	__u8 name[128];
	__u8 phys[64];
	__u8 uniq[64];
	__u16 rd_size;
	__u16 bus;
	__u32 vendor;
	__u32 product;
	__u32 version;
	__u32 country;
	__u8 rd_data[HID_MAX_DESCRIPTOR_SIZE];
} __attribute__((__packed__));

#define UHID_DATA_MAX 4096

enum uhid_report_type {
	UHID_FEATURE_REPORT,
	UHID_OUTPUT_REPORT,
	UHID_INPUT_REPORT,
};

struct uhid_input_req {
	__u8 data[UHID_DATA_MAX];
	__u16 size;
} __attribute__((__packed__));

struct uhid_input2_req {
	__u16 size;
	__u8 data[UHID_DATA_MAX];
} __attribute__((__packed__));

struct uhid_output_req {
	__u8 data[UHID_DATA_MAX];
	__u16 size;
	__u8 rtype;
} __attribute__((__packed__));

/* Obsolete! Newer kernels will no longer send these events but instead convert
 * it into raw output reports via UHID_OUTPUT. */
struct uhid_output_ev_req {
	__u16 type;
	__u16 code;
	__s32 value;
} __attribute__((__packed__));

struct uhid_feature_req {
	__u32 id;
	__u8 rnum;
	__u8 rtype;
} __attribute__((__packed__));

struct uhid_feature_answer_req {
	__u32 id;
	__u16 err;
	__u16 size;
	__u8 data[UHID_DATA_MAX];
} __attribute__((__packed__));

struct uhid_event {
	__u32 type;

	union {
		struct uhid_create_req create;
		struct uhid_input_req input;
		struct uhid_output_req output;
		struct uhid_output_ev_req output_ev;
		struct uhid_feature_req feature;
		struct uhid_feature_answer_req feature_answer;
		struct uhid_create2_req create2;
		struct uhid_input2_req input2;
	} u;
} __attribute__((__packed__));

#endif /* __UHID_H_ */
Commit	Line	Data
ace3d861 DR	1	#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>
4522643a	24	#include <linux/hid.h>
ace3d861 DR	25
ace3d861 DR	26	enum uhid_event_type {
d365c6cf DR	27	UHID_CREATE,
d365c6cf DR	28	UHID_DESTROY,
ec4b7dea DR	29	UHID_START,
ec4b7dea DR	30	UHID_STOP,
e7191474 DR	31	UHID_OPEN,
e7191474 DR	32	UHID_CLOSE,
3b3baa82	33	UHID_OUTPUT,
bdb829e1	34	UHID_OUTPUT_EV, /* obsolete! */
5e87a36a	35	UHID_INPUT,
fcfcf0de DR	36	UHID_FEATURE,
fcfcf0de DR	37	UHID_FEATURE_ANSWER,
4522643a PG	38	UHID_CREATE2,
4522643a PG	39	UHID_INPUT2,
ace3d861 DR	40	};
ace3d861 DR	41
d365c6cf DR	42	struct uhid_create_req {
	43	__u8 name[128];
	44	__u8 phys[64];
	45	__u8 uniq[64];
	46	__u8 __user *rd_data;
	47	__u16 rd_size;
	48
	49	__u16 bus;
	50	__u32 vendor;
	51	__u32 product;
	52	__u32 version;
	53	__u32 country;
	54	} __attribute__((__packed__));
	55
4522643a PG	56	struct uhid_create2_req {
	57	__u8 name[128];
	58	__u8 phys[64];
	59	__u8 uniq[64];
	60	__u16 rd_size;
	61	__u16 bus;
	62	__u32 vendor;
	63	__u32 product;
	64	__u32 version;
	65	__u32 country;
	66	__u8 rd_data[HID_MAX_DESCRIPTOR_SIZE];
	67	} __attribute__((__packed__));
	68
5e87a36a DR	69	#define UHID_DATA_MAX 4096
5e87a36a DR	70
3b3baa82 DR	71	enum uhid_report_type {
	72	UHID_FEATURE_REPORT,
	73	UHID_OUTPUT_REPORT,
	74	UHID_INPUT_REPORT,
	75	};
	76
5e87a36a DR	77	struct uhid_input_req {
	78	__u8 data[UHID_DATA_MAX];
	79	__u16 size;
	80	} __attribute__((__packed__));
	81
4522643a PG	82	struct uhid_input2_req {
	83	__u16 size;
	84	__u8 data[UHID_DATA_MAX];
	85	} __attribute__((__packed__));
	86
3b3baa82 DR	87	struct uhid_output_req {
	88	__u8 data[UHID_DATA_MAX];
	89	__u16 size;
	90	__u8 rtype;
	91	} __attribute__((__packed__));
	92
bdb829e1 DR	93	/* Obsolete! Newer kernels will no longer send these events but instead convert
bdb829e1 DR	94	* it into raw output reports via UHID_OUTPUT. */
f80e1360 DR	95	struct uhid_output_ev_req {
	96	__u16 type;
	97	__u16 code;
	98	__s32 value;
	99	} __attribute__((__packed__));
	100
fcfcf0de DR	101	struct uhid_feature_req {
	102	__u32 id;
	103	__u8 rnum;
	104	__u8 rtype;
	105	} __attribute__((__packed__));
	106
	107	struct uhid_feature_answer_req {
	108	__u32 id;
	109	__u16 err;
	110	__u16 size;
	111	__u8 data[UHID_DATA_MAX];
fee5dfec	112	} __attribute__((__packed__));
fcfcf0de	113
ace3d861 DR	114	struct uhid_event {
ace3d861 DR	115	__u32 type;
d365c6cf DR	116
	117	union {
	118	struct uhid_create_req create;
5e87a36a	119	struct uhid_input_req input;
3b3baa82	120	struct uhid_output_req output;
f80e1360	121	struct uhid_output_ev_req output_ev;
fcfcf0de DR	122	struct uhid_feature_req feature;
fcfcf0de DR	123	struct uhid_feature_answer_req feature_answer;
4522643a PG	124	struct uhid_create2_req create2;
4522643a PG	125	struct uhid_input2_req input2;
d365c6cf	126	} u;
ace3d861 DR	127	} __attribute__((__packed__));
	128
	129	#endif /* __UHID_H_ */