[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 <net/bluetooth/bluetooth.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_add_connection(struct hidp_connadd_req *req, struct socket *ctrl_sock, struct socket *intr_sock);
int hidp_del_connection(struct hidp_conndel_req *req);
int hidp_get_connlist(struct hidp_connlist_req *req);
int hidp_get_conninfo(struct hidp_conninfo *ci);

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

	struct hci_conn *conn;

	struct socket *ctrl_sock;
	struct socket *intr_sock;

	bdaddr_t bdaddr;

	unsigned long state;
	unsigned long flags;
	unsigned long idle_to;

	uint ctrl_mtu;
	uint intr_mtu;

	struct task_struct *task;

	unsigned char keys[8];
	unsigned char leds;

	struct input_dev *input;

	struct hid_device *hid;

	struct timer_list timer;

	struct sk_buff_head ctrl_transmit;
	struct sk_buff_head intr_transmit;

	/* 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 */

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

	wait_queue_head_t startup_queue;
	int waiting_for_startup;
};

static inline void hidp_schedule(struct hidp_session *session)
{
	struct sock *ctrl_sk = session->ctrl_sock->sk;
	struct sock *intr_sk = session->intr_sock->sk;

	wake_up_interruptible(sk_sleep(ctrl_sk));
	wake_up_interruptible(sk_sleep(intr_sk));
}

/* HIDP init defines */
extern int __init hidp_init_sockets(void);
extern 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>
	27	#include <net/bluetooth/bluetooth.h>
	28
	29	/* HIDP header masks */
	30	#define HIDP_HEADER_TRANS_MASK 0xf0
	31	#define HIDP_HEADER_PARAM_MASK 0x0f
	32
	33	/* HIDP transaction types */
	34	#define HIDP_TRANS_HANDSHAKE 0x00
	35	#define HIDP_TRANS_HID_CONTROL 0x10
	36	#define HIDP_TRANS_GET_REPORT 0x40
	37	#define HIDP_TRANS_SET_REPORT 0x50
	38	#define HIDP_TRANS_GET_PROTOCOL 0x60
	39	#define HIDP_TRANS_SET_PROTOCOL 0x70
	40	#define HIDP_TRANS_GET_IDLE 0x80
	41	#define HIDP_TRANS_SET_IDLE 0x90
	42	#define HIDP_TRANS_DATA 0xa0
	43	#define HIDP_TRANS_DATC 0xb0
	44
	45	/* HIDP handshake results */
	46	#define HIDP_HSHK_SUCCESSFUL 0x00
	47	#define HIDP_HSHK_NOT_READY 0x01
	48	#define HIDP_HSHK_ERR_INVALID_REPORT_ID 0x02
	49	#define HIDP_HSHK_ERR_UNSUPPORTED_REQUEST 0x03
	50	#define HIDP_HSHK_ERR_INVALID_PARAMETER 0x04
	51	#define HIDP_HSHK_ERR_UNKNOWN 0x0e
	52	#define HIDP_HSHK_ERR_FATAL 0x0f
	53
	54	/* HIDP control operation parameters */
	55	#define HIDP_CTRL_NOP 0x00
	56	#define HIDP_CTRL_HARD_RESET 0x01
	57	#define HIDP_CTRL_SOFT_RESET 0x02
	58	#define HIDP_CTRL_SUSPEND 0x03
	59	#define HIDP_CTRL_EXIT_SUSPEND 0x04
	60	#define HIDP_CTRL_VIRTUAL_CABLE_UNPLUG 0x05
	61
	62	/* HIDP data transaction headers */
	63	#define HIDP_DATA_RTYPE_MASK 0x03
	64	#define HIDP_DATA_RSRVD_MASK 0x0c
	65	#define HIDP_DATA_RTYPE_OTHER 0x00
	66	#define HIDP_DATA_RTYPE_INPUT 0x01
	67	#define HIDP_DATA_RTYPE_OUPUT 0x02
	68	#define HIDP_DATA_RTYPE_FEATURE 0x03
	69
	70	/* HIDP protocol header parameters */
	71	#define HIDP_PROTO_BOOT 0x00
	72	#define HIDP_PROTO_REPORT 0x01
	73
	74	/* HIDP ioctl defines */
	75	#define HIDPCONNADD _IOW('H', 200, int)
	76	#define HIDPCONNDEL _IOW('H', 201, int)
	77	#define HIDPGETCONNLIST _IOR('H', 210, int)
	78	#define HIDPGETCONNINFO _IOR('H', 211, int)
	79
	80	#define HIDP_VIRTUAL_CABLE_UNPLUG 0
	81	#define HIDP_BOOT_PROTOCOL_MODE 1
	82	#define HIDP_BLUETOOTH_VENDOR_ID 9
6d67c110	83	#define HIDP_WAITING_FOR_RETURN 10
0825411a	84	#define HIDP_WAITING_FOR_SEND_ACK 11
1da177e4 LT	85
1da177e4 LT	86	struct hidp_connadd_req {
17f09a7e SJ	87	int ctrl_sock; /* Connected control socket */
17f09a7e SJ	88	int intr_sock; /* Connected interrupt socket */
1da177e4 LT	89	__u16 parser;
1da177e4 LT	90	__u16 rd_size;
55e74744	91	__u8 __user *rd_data;
1da177e4 LT	92	__u8 country;
	93	__u8 subclass;
	94	__u16 vendor;
	95	__u16 product;
	96	__u16 version;
	97	__u32 flags;
	98	__u32 idle_to;
	99	char name[128];
	100	};
	101
	102	struct hidp_conndel_req {
	103	bdaddr_t bdaddr;
	104	__u32 flags;
	105	};
	106
	107	struct hidp_conninfo {
	108	bdaddr_t bdaddr;
	109	__u32 flags;
	110	__u16 state;
	111	__u16 vendor;
	112	__u16 product;
	113	__u16 version;
	114	char name[128];
	115	};
	116
	117	struct hidp_connlist_req {
	118	__u32 cnum;
	119	struct hidp_conninfo __user *ci;
	120	};
	121
	122	int hidp_add_connection(struct hidp_connadd_req req, struct socket ctrl_sock, struct socket *intr_sock);
	123	int hidp_del_connection(struct hidp_conndel_req *req);
	124	int hidp_get_connlist(struct hidp_connlist_req *req);
	125	int hidp_get_conninfo(struct hidp_conninfo *ci);
	126
	127	/* HIDP session defines */
	128	struct hidp_session {
	129	struct list_head list;
	130
edad6388 MH	131	struct hci_conn *conn;
edad6388 MH	132
1da177e4 LT	133	struct socket *ctrl_sock;
	134	struct socket *intr_sock;
	135
	136	bdaddr_t bdaddr;
	137
	138	unsigned long state;
	139	unsigned long flags;
	140	unsigned long idle_to;
	141
	142	uint ctrl_mtu;
	143	uint intr_mtu;
	144
aabf6f89	145	struct task_struct *task;
1da177e4 LT	146
	147	unsigned char keys[8];
	148	unsigned char leds;
	149
	150	struct input_dev *input;
	151
e1aaadd4 MH	152	struct hid_device *hid;
e1aaadd4 MH	153
1da177e4 LT	154	struct timer_list timer;
	155
	156	struct sk_buff_head ctrl_transmit;
	157	struct sk_buff_head intr_transmit;
c500c971	158
0ff1731a AO	159	/* Used in hidp_get_raw_report() */
	160	int waiting_report_type; /* HIDP_DATA_RTYPE_* */
	161	int waiting_report_number; /* -1 for not numbered */
	162	struct mutex report_mutex;
	163	struct sk_buff *report_return;
	164	wait_queue_head_t report_queue;
	165
0825411a AO	166	/* Used in hidp_output_raw_report() */
	167	int output_report_success; /* boolean */
	168
15c697ce MP	169	/* Report descriptor */
	170	__u8 *rd_data;
	171	uint rd_size;
0f69dca2 AO	172
	173	wait_queue_head_t startup_queue;
	174	int waiting_for_startup;
1da177e4 LT	175	};
	176
	177	static inline void hidp_schedule(struct hidp_session *session)
	178	{
	179	struct sock *ctrl_sk = session->ctrl_sock->sk;
	180	struct sock *intr_sk = session->intr_sock->sk;
	181
aa395145 ED	182	wake_up_interruptible(sk_sleep(ctrl_sk));
aa395145 ED	183	wake_up_interruptible(sk_sleep(intr_sk));
1da177e4 LT	184	}
	185
	186	/* HIDP init defines */
	187	extern int __init hidp_init_sockets(void);
	188	extern void __exit hidp_cleanup_sockets(void);
	189
	190	#endif /* __HIDP_H */