11da177e4SLinus Torvalds /* 21da177e4SLinus Torvalds HIDP implementation for Linux Bluetooth stack (BlueZ). 31da177e4SLinus Torvalds Copyright (C) 2003-2004 Marcel Holtmann <marcel@holtmann.org> 41da177e4SLinus Torvalds 51da177e4SLinus Torvalds This program is free software; you can redistribute it and/or modify 61da177e4SLinus Torvalds it under the terms of the GNU General Public License version 2 as 71da177e4SLinus Torvalds published by the Free Software Foundation; 81da177e4SLinus Torvalds 91da177e4SLinus Torvalds THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 101da177e4SLinus Torvalds OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 111da177e4SLinus Torvalds FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS. 121da177e4SLinus Torvalds IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) AND AUTHOR(S) BE LIABLE FOR ANY 131da177e4SLinus Torvalds CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES 141da177e4SLinus Torvalds WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 151da177e4SLinus Torvalds ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 161da177e4SLinus Torvalds OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 171da177e4SLinus Torvalds 181da177e4SLinus Torvalds ALL LIABILITY, INCLUDING LIABILITY FOR INFRINGEMENT OF ANY PATENTS, 191da177e4SLinus Torvalds COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS, RELATING TO USE OF THIS 201da177e4SLinus Torvalds SOFTWARE IS DISCLAIMED. 211da177e4SLinus Torvalds */ 221da177e4SLinus Torvalds 231da177e4SLinus Torvalds #ifndef __HIDP_H 241da177e4SLinus Torvalds #define __HIDP_H 251da177e4SLinus Torvalds 261da177e4SLinus Torvalds #include <linux/types.h> 27b4f34d8dSDavid Herrmann #include <linux/kref.h> 281da177e4SLinus Torvalds #include <net/bluetooth/bluetooth.h> 29b4f34d8dSDavid Herrmann #include <net/bluetooth/l2cap.h> 301da177e4SLinus Torvalds 311da177e4SLinus Torvalds /* HIDP header masks */ 321da177e4SLinus Torvalds #define HIDP_HEADER_TRANS_MASK 0xf0 331da177e4SLinus Torvalds #define HIDP_HEADER_PARAM_MASK 0x0f 341da177e4SLinus Torvalds 351da177e4SLinus Torvalds /* HIDP transaction types */ 361da177e4SLinus Torvalds #define HIDP_TRANS_HANDSHAKE 0x00 371da177e4SLinus Torvalds #define HIDP_TRANS_HID_CONTROL 0x10 381da177e4SLinus Torvalds #define HIDP_TRANS_GET_REPORT 0x40 391da177e4SLinus Torvalds #define HIDP_TRANS_SET_REPORT 0x50 401da177e4SLinus Torvalds #define HIDP_TRANS_GET_PROTOCOL 0x60 411da177e4SLinus Torvalds #define HIDP_TRANS_SET_PROTOCOL 0x70 421da177e4SLinus Torvalds #define HIDP_TRANS_GET_IDLE 0x80 431da177e4SLinus Torvalds #define HIDP_TRANS_SET_IDLE 0x90 441da177e4SLinus Torvalds #define HIDP_TRANS_DATA 0xa0 451da177e4SLinus Torvalds #define HIDP_TRANS_DATC 0xb0 461da177e4SLinus Torvalds 471da177e4SLinus Torvalds /* HIDP handshake results */ 481da177e4SLinus Torvalds #define HIDP_HSHK_SUCCESSFUL 0x00 491da177e4SLinus Torvalds #define HIDP_HSHK_NOT_READY 0x01 501da177e4SLinus Torvalds #define HIDP_HSHK_ERR_INVALID_REPORT_ID 0x02 511da177e4SLinus Torvalds #define HIDP_HSHK_ERR_UNSUPPORTED_REQUEST 0x03 521da177e4SLinus Torvalds #define HIDP_HSHK_ERR_INVALID_PARAMETER 0x04 531da177e4SLinus Torvalds #define HIDP_HSHK_ERR_UNKNOWN 0x0e 541da177e4SLinus Torvalds #define HIDP_HSHK_ERR_FATAL 0x0f 551da177e4SLinus Torvalds 561da177e4SLinus Torvalds /* HIDP control operation parameters */ 571da177e4SLinus Torvalds #define HIDP_CTRL_NOP 0x00 581da177e4SLinus Torvalds #define HIDP_CTRL_HARD_RESET 0x01 591da177e4SLinus Torvalds #define HIDP_CTRL_SOFT_RESET 0x02 601da177e4SLinus Torvalds #define HIDP_CTRL_SUSPEND 0x03 611da177e4SLinus Torvalds #define HIDP_CTRL_EXIT_SUSPEND 0x04 621da177e4SLinus Torvalds #define HIDP_CTRL_VIRTUAL_CABLE_UNPLUG 0x05 631da177e4SLinus Torvalds 641da177e4SLinus Torvalds /* HIDP data transaction headers */ 651da177e4SLinus Torvalds #define HIDP_DATA_RTYPE_MASK 0x03 661da177e4SLinus Torvalds #define HIDP_DATA_RSRVD_MASK 0x0c 671da177e4SLinus Torvalds #define HIDP_DATA_RTYPE_OTHER 0x00 681da177e4SLinus Torvalds #define HIDP_DATA_RTYPE_INPUT 0x01 691da177e4SLinus Torvalds #define HIDP_DATA_RTYPE_OUPUT 0x02 701da177e4SLinus Torvalds #define HIDP_DATA_RTYPE_FEATURE 0x03 711da177e4SLinus Torvalds 721da177e4SLinus Torvalds /* HIDP protocol header parameters */ 731da177e4SLinus Torvalds #define HIDP_PROTO_BOOT 0x00 741da177e4SLinus Torvalds #define HIDP_PROTO_REPORT 0x01 751da177e4SLinus Torvalds 761da177e4SLinus Torvalds /* HIDP ioctl defines */ 771da177e4SLinus Torvalds #define HIDPCONNADD _IOW('H', 200, int) 781da177e4SLinus Torvalds #define HIDPCONNDEL _IOW('H', 201, int) 791da177e4SLinus Torvalds #define HIDPGETCONNLIST _IOR('H', 210, int) 801da177e4SLinus Torvalds #define HIDPGETCONNINFO _IOR('H', 211, int) 811da177e4SLinus Torvalds 821da177e4SLinus Torvalds #define HIDP_VIRTUAL_CABLE_UNPLUG 0 831da177e4SLinus Torvalds #define HIDP_BOOT_PROTOCOL_MODE 1 841da177e4SLinus Torvalds #define HIDP_BLUETOOTH_VENDOR_ID 9 850ff1731aSAlan Ott #define HIDP_WAITING_FOR_RETURN 10 860825411aSAlan Ott #define HIDP_WAITING_FOR_SEND_ACK 11 871da177e4SLinus Torvalds 881da177e4SLinus Torvalds struct hidp_connadd_req { 8917f09a7eSSzymon Janc int ctrl_sock; /* Connected control socket */ 9017f09a7eSSzymon Janc int intr_sock; /* Connected interrupt socket */ 911da177e4SLinus Torvalds __u16 parser; 921da177e4SLinus Torvalds __u16 rd_size; 9355e74744SAl Viro __u8 __user *rd_data; 941da177e4SLinus Torvalds __u8 country; 951da177e4SLinus Torvalds __u8 subclass; 961da177e4SLinus Torvalds __u16 vendor; 971da177e4SLinus Torvalds __u16 product; 981da177e4SLinus Torvalds __u16 version; 991da177e4SLinus Torvalds __u32 flags; 1001da177e4SLinus Torvalds __u32 idle_to; 1011da177e4SLinus Torvalds char name[128]; 1021da177e4SLinus Torvalds }; 1031da177e4SLinus Torvalds 1041da177e4SLinus Torvalds struct hidp_conndel_req { 1051da177e4SLinus Torvalds bdaddr_t bdaddr; 1061da177e4SLinus Torvalds __u32 flags; 1071da177e4SLinus Torvalds }; 1081da177e4SLinus Torvalds 1091da177e4SLinus Torvalds struct hidp_conninfo { 1101da177e4SLinus Torvalds bdaddr_t bdaddr; 1111da177e4SLinus Torvalds __u32 flags; 1121da177e4SLinus Torvalds __u16 state; 1131da177e4SLinus Torvalds __u16 vendor; 1141da177e4SLinus Torvalds __u16 product; 1151da177e4SLinus Torvalds __u16 version; 1161da177e4SLinus Torvalds char name[128]; 1171da177e4SLinus Torvalds }; 1181da177e4SLinus Torvalds 1191da177e4SLinus Torvalds struct hidp_connlist_req { 1201da177e4SLinus Torvalds __u32 cnum; 1211da177e4SLinus Torvalds struct hidp_conninfo __user *ci; 1221da177e4SLinus Torvalds }; 1231da177e4SLinus Torvalds 124b4f34d8dSDavid Herrmann int hidp_connection_add(struct hidp_connadd_req *req, struct socket *ctrl_sock, struct socket *intr_sock); 125b4f34d8dSDavid Herrmann int hidp_connection_del(struct hidp_conndel_req *req); 1261da177e4SLinus Torvalds int hidp_add_connection(struct hidp_connadd_req *req, struct socket *ctrl_sock, struct socket *intr_sock); 1271da177e4SLinus Torvalds int hidp_del_connection(struct hidp_conndel_req *req); 1281da177e4SLinus Torvalds int hidp_get_connlist(struct hidp_connlist_req *req); 1291da177e4SLinus Torvalds int hidp_get_conninfo(struct hidp_conninfo *ci); 1301da177e4SLinus Torvalds 131b4f34d8dSDavid Herrmann enum hidp_session_state { 132b4f34d8dSDavid Herrmann HIDP_SESSION_IDLING, 133b4f34d8dSDavid Herrmann HIDP_SESSION_RUNNING, 134b4f34d8dSDavid Herrmann }; 135b4f34d8dSDavid Herrmann 1361da177e4SLinus Torvalds /* HIDP session defines */ 1371da177e4SLinus Torvalds struct hidp_session { 1381da177e4SLinus Torvalds struct list_head list; 139b4f34d8dSDavid Herrmann struct kref ref; 1401da177e4SLinus Torvalds 141b4f34d8dSDavid Herrmann /* runtime management */ 142b4f34d8dSDavid Herrmann atomic_t state; 143b4f34d8dSDavid Herrmann wait_queue_head_t state_queue; 1447bb59df8SPeter Hurley atomic_t terminate; 145aabf6f89SSzymon Janc struct task_struct *task; 146b4f34d8dSDavid Herrmann unsigned long flags; 1471da177e4SLinus Torvalds 148b4f34d8dSDavid Herrmann /* connection management */ 149b4f34d8dSDavid Herrmann bdaddr_t bdaddr; 150b4f34d8dSDavid Herrmann struct hci_conn *hconn; 151b4f34d8dSDavid Herrmann struct l2cap_conn *conn; 152b4f34d8dSDavid Herrmann struct l2cap_user user; 153b4f34d8dSDavid Herrmann struct socket *ctrl_sock; 154b4f34d8dSDavid Herrmann struct socket *intr_sock; 1551da177e4SLinus Torvalds struct sk_buff_head ctrl_transmit; 1561da177e4SLinus Torvalds struct sk_buff_head intr_transmit; 157b4f34d8dSDavid Herrmann uint ctrl_mtu; 158b4f34d8dSDavid Herrmann uint intr_mtu; 159b4f34d8dSDavid Herrmann unsigned long idle_to; 160b4f34d8dSDavid Herrmann 161b4f34d8dSDavid Herrmann /* device management */ 162b4f34d8dSDavid Herrmann struct input_dev *input; 163b4f34d8dSDavid Herrmann struct hid_device *hid; 164b4f34d8dSDavid Herrmann struct timer_list timer; 165b4f34d8dSDavid Herrmann 166b4f34d8dSDavid Herrmann /* Report descriptor */ 167b4f34d8dSDavid Herrmann __u8 *rd_data; 168b4f34d8dSDavid Herrmann uint rd_size; 169b4f34d8dSDavid Herrmann 170b4f34d8dSDavid Herrmann /* session data */ 171b4f34d8dSDavid Herrmann unsigned char keys[8]; 172b4f34d8dSDavid Herrmann unsigned char leds; 173c500c971SJiri Slaby 1740ff1731aSAlan Ott /* Used in hidp_get_raw_report() */ 1750ff1731aSAlan Ott int waiting_report_type; /* HIDP_DATA_RTYPE_* */ 1760ff1731aSAlan Ott int waiting_report_number; /* -1 for not numbered */ 1770ff1731aSAlan Ott struct mutex report_mutex; 1780ff1731aSAlan Ott struct sk_buff *report_return; 1790ff1731aSAlan Ott wait_queue_head_t report_queue; 1800ff1731aSAlan Ott 1810825411aSAlan Ott /* Used in hidp_output_raw_report() */ 1820825411aSAlan Ott int output_report_success; /* boolean */ 1830825411aSAlan Ott 1840f69dca2SAlan Ott wait_queue_head_t startup_queue; 1850f69dca2SAlan Ott int waiting_for_startup; 1861da177e4SLinus Torvalds }; 1871da177e4SLinus Torvalds 1881da177e4SLinus Torvalds /* HIDP init defines */ 1891da177e4SLinus Torvalds extern int __init hidp_init_sockets(void); 1901da177e4SLinus Torvalds extern void __exit hidp_cleanup_sockets(void); 1911da177e4SLinus Torvalds 1921da177e4SLinus Torvalds #endif /* __HIDP_H */ 193