[mirror_ubuntu-artful-kernel.git] / net / bluetooth / hidp / hidp.h

/*
   HIDP implementation for Linux Bluetooth stack (BlueZ).
   Copyright (C) 2003-2004 Marcel Holtmann <marcel@holtmann.org>

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License version 2 as
   published by the Free Software Foundation;

   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
   OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS.
   IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) AND AUTHOR(S) BE LIABLE FOR ANY
   CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES
   WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
   ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
   OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

   ALL LIABILITY, INCLUDING LIABILITY FOR INFRINGEMENT OF ANY PATENTS,
   COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS, RELATING TO USE OF THIS
   SOFTWARE IS DISCLAIMED.
*/

#ifndef __HIDP_H
#define __HIDP_H

#include <linux/types.h>
#include <linux/hid.h>
#include <linux/kref.h>
#include <net/bluetooth/bluetooth.h>
#include <net/bluetooth/l2cap.h>

/* HIDP header masks */
#define HIDP_HEADER_TRANS_MASK			0xf0
#define HIDP_HEADER_PARAM_MASK			0x0f

/* HIDP transaction types */
#define HIDP_TRANS_HANDSHAKE			0x00
#define HIDP_TRANS_HID_CONTROL			0x10
#define HIDP_TRANS_GET_REPORT			0x40
#define HIDP_TRANS_SET_REPORT			0x50
#define HIDP_TRANS_GET_PROTOCOL			0x60
#define HIDP_TRANS_SET_PROTOCOL			0x70
#define HIDP_TRANS_GET_IDLE			0x80
#define HIDP_TRANS_SET_IDLE			0x90
#define HIDP_TRANS_DATA				0xa0
#define HIDP_TRANS_DATC				0xb0

/* HIDP handshake results */
#define HIDP_HSHK_SUCCESSFUL			0x00
#define HIDP_HSHK_NOT_READY			0x01
#define HIDP_HSHK_ERR_INVALID_REPORT_ID		0x02
#define HIDP_HSHK_ERR_UNSUPPORTED_REQUEST	0x03
#define HIDP_HSHK_ERR_INVALID_PARAMETER		0x04
#define HIDP_HSHK_ERR_UNKNOWN			0x0e
#define HIDP_HSHK_ERR_FATAL			0x0f

/* HIDP control operation parameters */
#define HIDP_CTRL_NOP				0x00
#define HIDP_CTRL_HARD_RESET			0x01
#define HIDP_CTRL_SOFT_RESET			0x02
#define HIDP_CTRL_SUSPEND			0x03
#define HIDP_CTRL_EXIT_SUSPEND			0x04
#define HIDP_CTRL_VIRTUAL_CABLE_UNPLUG		0x05

/* HIDP data transaction headers */
#define HIDP_DATA_RTYPE_MASK			0x03
#define HIDP_DATA_RSRVD_MASK			0x0c
#define HIDP_DATA_RTYPE_OTHER			0x00
#define HIDP_DATA_RTYPE_INPUT			0x01
#define HIDP_DATA_RTYPE_OUPUT			0x02
#define HIDP_DATA_RTYPE_FEATURE			0x03

/* HIDP protocol header parameters */
#define HIDP_PROTO_BOOT				0x00
#define HIDP_PROTO_REPORT			0x01

/* HIDP ioctl defines */
#define HIDPCONNADD	_IOW('H', 200, int)
#define HIDPCONNDEL	_IOW('H', 201, int)
#define HIDPGETCONNLIST	_IOR('H', 210, int)
#define HIDPGETCONNINFO	_IOR('H', 211, int)

#define HIDP_VIRTUAL_CABLE_UNPLUG	0
#define HIDP_BOOT_PROTOCOL_MODE		1
#define HIDP_BLUETOOTH_VENDOR_ID	9
#define HIDP_WAITING_FOR_RETURN		10
#define HIDP_WAITING_FOR_SEND_ACK	11

struct hidp_connadd_req {
	int   ctrl_sock;	/* Connected control socket */
	int   intr_sock;	/* Connected interrupt socket */
	__u16 parser;
	__u16 rd_size;
	__u8 __user *rd_data;
	__u8  country;
	__u8  subclass;
	__u16 vendor;
	__u16 product;
	__u16 version;
	__u32 flags;
	__u32 idle_to;
	char  name[128];
};

struct hidp_conndel_req {
	bdaddr_t bdaddr;
	__u32    flags;
};

struct hidp_conninfo {
	bdaddr_t bdaddr;
	__u32    flags;
	__u16    state;
	__u16    vendor;
	__u16    product;
	__u16    version;
	char     name[128];
};

struct hidp_connlist_req {
	__u32  cnum;
	struct hidp_conninfo __user *ci;
};

int hidp_connection_add(struct hidp_connadd_req *req, struct socket *ctrl_sock, struct socket *intr_sock);
int hidp_connection_del(struct hidp_conndel_req *req);
int hidp_get_connlist(struct hidp_connlist_req *req);
int hidp_get_conninfo(struct hidp_conninfo *ci);

enum hidp_session_state {
	HIDP_SESSION_IDLING,
	HIDP_SESSION_PREPARING,
	HIDP_SESSION_RUNNING,
};

/* HIDP session defines */
struct hidp_session {
	struct list_head list;
	struct kref ref;

	/* runtime management */
	atomic_t state;
	wait_queue_head_t state_queue;
	atomic_t terminate;
	struct task_struct *task;
	unsigned long flags;

	/* connection management */
	bdaddr_t bdaddr;
	struct l2cap_conn *conn;
	struct l2cap_user user;
	struct socket *ctrl_sock;
	struct socket *intr_sock;
	struct sk_buff_head ctrl_transmit;
	struct sk_buff_head intr_transmit;
	uint ctrl_mtu;
	uint intr_mtu;
	unsigned long idle_to;

	/* device management */
	struct work_struct dev_init;
	struct input_dev *input;
	struct hid_device *hid;
	struct timer_list timer;

	/* Report descriptor */
	__u8 *rd_data;
	uint rd_size;

	/* session data */
	unsigned char keys[8];
	unsigned char leds;

	/* Used in hidp_get_raw_report() */
	int waiting_report_type; /* HIDP_DATA_RTYPE_* */
	int waiting_report_number; /* -1 for not numbered */
	struct mutex report_mutex;
	struct sk_buff *report_return;
	wait_queue_head_t report_queue;

	/* Used in hidp_output_raw_report() */
	int output_report_success; /* boolean */

	/* temporary input buffer */
	u8 input_buf[HID_MAX_BUFFER_SIZE];
};

/* HIDP init defines */
int __init hidp_init_sockets(void);
void __exit hidp_cleanup_sockets(void);

#endif /* __HIDP_H */
Commit	Line	Data
8e87d142	1	/*
1da177e4 LT	2	HIDP implementation for Linux Bluetooth stack (BlueZ).
	3	Copyright (C) 2003-2004 Marcel Holtmann <marcel@holtmann.org>
	4
	5	This program is free software; you can redistribute it and/or modify
	6	it under the terms of the GNU General Public License version 2 as
	7	published by the Free Software Foundation;
	8
	9	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
	10	OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	11	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS.
	12	IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) AND AUTHOR(S) BE LIABLE FOR ANY
8e87d142 YH	13	CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES
	14	WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
	15	ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
1da177e4 LT	16	OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1da177e4 LT	17
8e87d142 YH	18	ALL LIABILITY, INCLUDING LIABILITY FOR INFRINGEMENT OF ANY PATENTS,
8e87d142 YH	19	COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS, RELATING TO USE OF THIS
1da177e4 LT	20	SOFTWARE IS DISCLAIMED.
	21	*/
	22
	23	#ifndef __HIDP_H
	24	#define __HIDP_H
	25
	26	#include <linux/types.h>
a4b1b587	27	#include <linux/hid.h>
b4f34d8d	28	#include <linux/kref.h>
1da177e4	29	#include <net/bluetooth/bluetooth.h>
b4f34d8d	30	#include <net/bluetooth/l2cap.h>
1da177e4 LT	31
	32	/* HIDP header masks */
	33	#define HIDP_HEADER_TRANS_MASK 0xf0
	34	#define HIDP_HEADER_PARAM_MASK 0x0f
	35
	36	/* HIDP transaction types */
	37	#define HIDP_TRANS_HANDSHAKE 0x00
	38	#define HIDP_TRANS_HID_CONTROL 0x10
	39	#define HIDP_TRANS_GET_REPORT 0x40
	40	#define HIDP_TRANS_SET_REPORT 0x50
	41	#define HIDP_TRANS_GET_PROTOCOL 0x60
	42	#define HIDP_TRANS_SET_PROTOCOL 0x70
	43	#define HIDP_TRANS_GET_IDLE 0x80
	44	#define HIDP_TRANS_SET_IDLE 0x90
	45	#define HIDP_TRANS_DATA 0xa0
	46	#define HIDP_TRANS_DATC 0xb0
	47
	48	/* HIDP handshake results */
	49	#define HIDP_HSHK_SUCCESSFUL 0x00
	50	#define HIDP_HSHK_NOT_READY 0x01
	51	#define HIDP_HSHK_ERR_INVALID_REPORT_ID 0x02
	52	#define HIDP_HSHK_ERR_UNSUPPORTED_REQUEST 0x03
	53	#define HIDP_HSHK_ERR_INVALID_PARAMETER 0x04
	54	#define HIDP_HSHK_ERR_UNKNOWN 0x0e
	55	#define HIDP_HSHK_ERR_FATAL 0x0f
	56
	57	/* HIDP control operation parameters */
	58	#define HIDP_CTRL_NOP 0x00
	59	#define HIDP_CTRL_HARD_RESET 0x01
	60	#define HIDP_CTRL_SOFT_RESET 0x02
	61	#define HIDP_CTRL_SUSPEND 0x03
	62	#define HIDP_CTRL_EXIT_SUSPEND 0x04
	63	#define HIDP_CTRL_VIRTUAL_CABLE_UNPLUG 0x05
	64
	65	/* HIDP data transaction headers */
	66	#define HIDP_DATA_RTYPE_MASK 0x03
	67	#define HIDP_DATA_RSRVD_MASK 0x0c
	68	#define HIDP_DATA_RTYPE_OTHER 0x00
	69	#define HIDP_DATA_RTYPE_INPUT 0x01
	70	#define HIDP_DATA_RTYPE_OUPUT 0x02
	71	#define HIDP_DATA_RTYPE_FEATURE 0x03
	72
	73	/* HIDP protocol header parameters */
	74	#define HIDP_PROTO_BOOT 0x00
	75	#define HIDP_PROTO_REPORT 0x01
	76
	77	/* HIDP ioctl defines */
	78	#define HIDPCONNADD _IOW('H', 200, int)
	79	#define HIDPCONNDEL _IOW('H', 201, int)
	80	#define HIDPGETCONNLIST _IOR('H', 210, int)
	81	#define HIDPGETCONNINFO _IOR('H', 211, int)
	82
	83	#define HIDP_VIRTUAL_CABLE_UNPLUG 0
	84	#define HIDP_BOOT_PROTOCOL_MODE 1
	85	#define HIDP_BLUETOOTH_VENDOR_ID 9
6d67c110	86	#define HIDP_WAITING_FOR_RETURN 10
0825411a	87	#define HIDP_WAITING_FOR_SEND_ACK 11
1da177e4 LT	88
1da177e4 LT	89	struct hidp_connadd_req {
17f09a7e SJ	90	int ctrl_sock; /* Connected control socket */
17f09a7e SJ	91	int intr_sock; /* Connected interrupt socket */
1da177e4 LT	92	__u16 parser;
1da177e4 LT	93	__u16 rd_size;
55e74744	94	__u8 __user *rd_data;
1da177e4 LT	95	__u8 country;
	96	__u8 subclass;
	97	__u16 vendor;
	98	__u16 product;
	99	__u16 version;
	100	__u32 flags;
	101	__u32 idle_to;
	102	char name[128];
	103	};
	104
	105	struct hidp_conndel_req {
	106	bdaddr_t bdaddr;
	107	__u32 flags;
	108	};
	109
	110	struct hidp_conninfo {
	111	bdaddr_t bdaddr;
	112	__u32 flags;
	113	__u16 state;
	114	__u16 vendor;
	115	__u16 product;
	116	__u16 version;
	117	char name[128];
	118	};
	119
	120	struct hidp_connlist_req {
	121	__u32 cnum;
	122	struct hidp_conninfo __user *ci;
	123	};
	124
b4f34d8d DH	125	int hidp_connection_add(struct hidp_connadd_req req, struct socket ctrl_sock, struct socket *intr_sock);
b4f34d8d DH	126	int hidp_connection_del(struct hidp_conndel_req *req);
1da177e4 LT	127	int hidp_get_connlist(struct hidp_connlist_req *req);
	128	int hidp_get_conninfo(struct hidp_conninfo *ci);
	129
b4f34d8d DH	130	enum hidp_session_state {
b4f34d8d DH	131	HIDP_SESSION_IDLING,
4e713cdf	132	HIDP_SESSION_PREPARING,
b4f34d8d DH	133	HIDP_SESSION_RUNNING,
	134	};
	135
1da177e4 LT	136	/* HIDP session defines */
	137	struct hidp_session {
	138	struct list_head list;
b4f34d8d	139	struct kref ref;
1da177e4	140
b4f34d8d DH	141	/* runtime management */
	142	atomic_t state;
	143	wait_queue_head_t state_queue;
	144	atomic_t terminate;
	145	struct task_struct *task;
	146	unsigned long flags;
edad6388	147
b4f34d8d DH	148	/* connection management */
b4f34d8d DH	149	bdaddr_t bdaddr;
b4f34d8d DH	150	struct l2cap_conn *conn;
b4f34d8d DH	151	struct l2cap_user user;
1da177e4 LT	152	struct socket *ctrl_sock;
1da177e4 LT	153	struct socket *intr_sock;
b4f34d8d DH	154	struct sk_buff_head ctrl_transmit;
b4f34d8d DH	155	struct sk_buff_head intr_transmit;
1da177e4 LT	156	uint ctrl_mtu;
1da177e4 LT	157	uint intr_mtu;
b4f34d8d	158	unsigned long idle_to;
1da177e4	159
b4f34d8d	160	/* device management */
4e713cdf	161	struct work_struct dev_init;
1da177e4	162	struct input_dev *input;
e1aaadd4	163	struct hid_device *hid;
1da177e4 LT	164	struct timer_list timer;
1da177e4 LT	165
b4f34d8d DH	166	/* Report descriptor */
	167	__u8 *rd_data;
	168	uint rd_size;
	169
	170	/* session data */
	171	unsigned char keys[8];
	172	unsigned char leds;
c500c971	173
0ff1731a AO	174	/* Used in hidp_get_raw_report() */
	175	int waiting_report_type; /* HIDP_DATA_RTYPE_* */
	176	int waiting_report_number; /* -1 for not numbered */
	177	struct mutex report_mutex;
	178	struct sk_buff *report_return;
	179	wait_queue_head_t report_queue;
	180
0825411a AO	181	/* Used in hidp_output_raw_report() */
0825411a AO	182	int output_report_success; /* boolean */
a4b1b587 DH	183
	184	/* temporary input buffer */
	185	u8 input_buf[HID_MAX_BUFFER_SIZE];
1da177e4 LT	186	};
1da177e4 LT	187
1da177e4	188	/* HIDP init defines */
348662a1 JP	189	int __init hidp_init_sockets(void);
348662a1 JP	190	void __exit hidp_cleanup_sockets(void);
1da177e4 LT	191
1da177e4 LT	192	#endif /* __HIDP_H */