Release 4.12 include/uapi/linux/uhid.h

Directory: include/uapi/linux
#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_LEGACY_CREATE,
	
UHID_DESTROY,
	
UHID_START,
	
UHID_STOP,
	
UHID_OPEN,
	
UHID_CLOSE,
	
UHID_OUTPUT,
	
__UHID_LEGACY_OUTPUT_EV,
	
__UHID_LEGACY_INPUT,
	
UHID_GET_REPORT,
	
UHID_GET_REPORT_REPLY,
	
UHID_CREATE2,
	
UHID_INPUT2,
	
UHID_SET_REPORT,
	
UHID_SET_REPORT_REPLY,
};


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__));


enum uhid_dev_flag {
	
UHID_DEV_NUMBERED_FEATURE_REPORTS			= (1ULL << 0),
	
UHID_DEV_NUMBERED_OUTPUT_REPORTS			= (1ULL << 1),
	
UHID_DEV_NUMBERED_INPUT_REPORTS				= (1ULL << 2),
};


struct uhid_start_req {
	
__u64 dev_flags;
};


#define UHID_DATA_MAX 4096


enum uhid_report_type {
	
UHID_FEATURE_REPORT,
	
UHID_OUTPUT_REPORT,
	
UHID_INPUT_REPORT,
};


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__));


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


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


struct uhid_set_report_req {
	
__u32 id;
	
__u8 rnum;
	
__u8 rtype;
	
__u16 size;
	
__u8 data[UHID_DATA_MAX];
} __attribute__((__packed__));


struct uhid_set_report_reply_req {
	
__u32 id;
	
__u16 err;
} __attribute__((__packed__));

/*
 * Compat Layer
 * All these commands and requests are obsolete. You should avoid using them in
 * new code. We support them for backwards-compatibility, but you might not get
 * access to new feature in case you use them.
 */


enum uhid_legacy_event_type {
	
UHID_CREATE			= __UHID_LEGACY_CREATE,
	
UHID_OUTPUT_EV			= __UHID_LEGACY_OUTPUT_EV,
	
UHID_INPUT			= __UHID_LEGACY_INPUT,
	
UHID_FEATURE			= UHID_GET_REPORT,
	
UHID_FEATURE_ANSWER		= UHID_GET_REPORT_REPLY,
};

/* Obsolete! Use UHID_CREATE2. */

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__));

/* Obsolete! Use UHID_INPUT2. */

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

/* Obsolete! Kernel uses UHID_OUTPUT exclusively now. */

struct uhid_output_ev_req {
	
__u16 type;
	
__u16 code;
	
__s32 value;
} __attribute__((__packed__));

/* Obsolete! Kernel uses ABI compatible UHID_GET_REPORT. */

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

/* Obsolete! Use ABI compatible UHID_GET_REPORT_REPLY. */

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

/*
 * UHID Events
 * All UHID events from and to the kernel are encoded as "struct uhid_event".
 * The "type" field contains a UHID_* type identifier. All payload depends on
 * that type and can be accessed via ev->u.XYZ accordingly.
 * If user-space writes short events, they're extended with 0s by the kernel. If
 * the kernel writes short events, user-space shall extend them with 0s.
 */


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_get_report_req get_report;
		
struct uhid_feature_answer_req feature_answer;
		
struct uhid_get_report_reply_req get_report_reply;
		
struct uhid_create2_req create2;
		
struct uhid_input2_req input2;
		
struct uhid_set_report_req set_report;
		
struct uhid_set_report_reply_req set_report_reply;
		
struct uhid_start_req start;
	
} u;
} __attribute__((__packed__));

#endif /* __UHID_H_ */
Overall Contributors
Person Tokens Prop Commits CommitProp
David Herrmann 450 84.43% 13 92.86%
Petri Gynther 83 15.57% 1 7.14%
Total 533 100.00% 14 100.00%
Directory: include/uapi/linux

Information contained on this website is for historical information purposes only and does not indicate or represent copyright ownership.
Created with cregit.
Person	Tokens	Prop	Commits	CommitProp
David Herrmann	450	84.43%	13	92.86%
Petri Gynther	83	15.57%	1	7.14%
Total	533	100.00%	14	100.00%
cregit-Linux how code gets into the kernel

Release 4.12 include/uapi/linux/uhid.h

Overall Contributors
