2 HIDP implementation for Linux Bluetooth stack (BlueZ).
3 Copyright (C) 2003-2004 Marcel Holtmann <marcel@holtmann.org>
4 Copyright (C) 2013 David Herrmann <dh.herrmann@gmail.com>
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License version 2 as
8 published by the Free Software Foundation;
10 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
11 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
12 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS.
13 IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) AND AUTHOR(S) BE LIABLE FOR ANY
14 CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES
15 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19 ALL LIABILITY, INCLUDING LIABILITY FOR INFRINGEMENT OF ANY PATENTS,
20 COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS, RELATING TO USE OF THIS
21 SOFTWARE IS DISCLAIMED.
24 #include <linux/kref.h>
25 #include <linux/module.h>
26 #include <linux/file.h>
27 #include <linux/kthread.h>
28 #include <linux/hidraw.h>
30 #include <net/bluetooth/bluetooth.h>
31 #include <net/bluetooth/hci_core.h>
32 #include <net/bluetooth/l2cap.h>
38 static DECLARE_RWSEM(hidp_session_sem
);
39 static LIST_HEAD(hidp_session_list
);
41 static unsigned char hidp_keycode
[256] = {
42 0, 0, 0, 0, 30, 48, 46, 32, 18, 33, 34, 35, 23, 36,
43 37, 38, 50, 49, 24, 25, 16, 19, 31, 20, 22, 47, 17, 45,
44 21, 44, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 28, 1,
45 14, 15, 57, 12, 13, 26, 27, 43, 43, 39, 40, 41, 51, 52,
46 53, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 87, 88,
47 99, 70, 119, 110, 102, 104, 111, 107, 109, 106, 105, 108, 103, 69,
48 98, 55, 74, 78, 96, 79, 80, 81, 75, 76, 77, 71, 72, 73,
49 82, 83, 86, 127, 116, 117, 183, 184, 185, 186, 187, 188, 189, 190,
50 191, 192, 193, 194, 134, 138, 130, 132, 128, 129, 131, 137, 133, 135,
51 136, 113, 115, 114, 0, 0, 0, 121, 0, 89, 93, 124, 92, 94,
52 95, 0, 0, 0, 122, 123, 90, 91, 85, 0, 0, 0, 0, 0,
53 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
54 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
55 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
56 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
57 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
58 29, 42, 56, 125, 97, 54, 100, 126, 164, 166, 165, 163, 161, 115,
59 114, 113, 150, 158, 159, 128, 136, 177, 178, 176, 142, 152, 173, 140
62 static unsigned char hidp_mkeyspat
[] = { 0x01, 0x01, 0x01, 0x01, 0x01, 0x01 };
64 static int hidp_session_probe(struct l2cap_conn
*conn
,
65 struct l2cap_user
*user
);
66 static void hidp_session_remove(struct l2cap_conn
*conn
,
67 struct l2cap_user
*user
);
68 static int hidp_session_thread(void *arg
);
69 static void hidp_session_terminate(struct hidp_session
*s
);
71 static void hidp_copy_session(struct hidp_session
*session
, struct hidp_conninfo
*ci
)
74 memset(ci
, 0, sizeof(*ci
));
75 bacpy(&ci
->bdaddr
, &session
->bdaddr
);
77 ci
->flags
= session
->flags
& valid_flags
;
78 ci
->state
= BT_CONNECTED
;
81 ci
->vendor
= session
->input
->id
.vendor
;
82 ci
->product
= session
->input
->id
.product
;
83 ci
->version
= session
->input
->id
.version
;
84 if (session
->input
->name
)
85 strlcpy(ci
->name
, session
->input
->name
, 128);
87 strlcpy(ci
->name
, "HID Boot Device", 128);
88 } else if (session
->hid
) {
89 ci
->vendor
= session
->hid
->vendor
;
90 ci
->product
= session
->hid
->product
;
91 ci
->version
= session
->hid
->version
;
92 strlcpy(ci
->name
, session
->hid
->name
, 128);
96 /* assemble skb, queue message on @transmit and wake up the session thread */
97 static int hidp_send_message(struct hidp_session
*session
, struct socket
*sock
,
98 struct sk_buff_head
*transmit
, unsigned char hdr
,
99 const unsigned char *data
, int size
)
102 struct sock
*sk
= sock
->sk
;
104 BT_DBG("session %p data %p size %d", session
, data
, size
);
106 if (atomic_read(&session
->terminate
))
109 skb
= alloc_skb(size
+ 1, GFP_ATOMIC
);
111 BT_ERR("Can't allocate memory for new frame");
115 *skb_put(skb
, 1) = hdr
;
116 if (data
&& size
> 0)
117 memcpy(skb_put(skb
, size
), data
, size
);
119 skb_queue_tail(transmit
, skb
);
120 wake_up_interruptible(sk_sleep(sk
));
125 static int hidp_send_ctrl_message(struct hidp_session
*session
,
126 unsigned char hdr
, const unsigned char *data
,
129 return hidp_send_message(session
, session
->ctrl_sock
,
130 &session
->ctrl_transmit
, hdr
, data
, size
);
133 static int hidp_send_intr_message(struct hidp_session
*session
,
134 unsigned char hdr
, const unsigned char *data
,
137 return hidp_send_message(session
, session
->intr_sock
,
138 &session
->intr_transmit
, hdr
, data
, size
);
141 static int hidp_input_event(struct input_dev
*dev
, unsigned int type
,
142 unsigned int code
, int value
)
144 struct hidp_session
*session
= input_get_drvdata(dev
);
145 unsigned char newleds
;
146 unsigned char hdr
, data
[2];
148 BT_DBG("session %p type %d code %d value %d",
149 session
, type
, code
, value
);
154 newleds
= (!!test_bit(LED_KANA
, dev
->led
) << 3) |
155 (!!test_bit(LED_COMPOSE
, dev
->led
) << 3) |
156 (!!test_bit(LED_SCROLLL
, dev
->led
) << 2) |
157 (!!test_bit(LED_CAPSL
, dev
->led
) << 1) |
158 (!!test_bit(LED_NUML
, dev
->led
) << 0);
160 if (session
->leds
== newleds
)
163 session
->leds
= newleds
;
165 hdr
= HIDP_TRANS_DATA
| HIDP_DATA_RTYPE_OUPUT
;
169 return hidp_send_intr_message(session
, hdr
, data
, 2);
172 static void hidp_input_report(struct hidp_session
*session
, struct sk_buff
*skb
)
174 struct input_dev
*dev
= session
->input
;
175 unsigned char *keys
= session
->keys
;
176 unsigned char *udata
= skb
->data
+ 1;
177 signed char *sdata
= skb
->data
+ 1;
178 int i
, size
= skb
->len
- 1;
180 switch (skb
->data
[0]) {
181 case 0x01: /* Keyboard report */
182 for (i
= 0; i
< 8; i
++)
183 input_report_key(dev
, hidp_keycode
[i
+ 224], (udata
[0] >> i
) & 1);
185 /* If all the key codes have been set to 0x01, it means
186 * too many keys were pressed at the same time. */
187 if (!memcmp(udata
+ 2, hidp_mkeyspat
, 6))
190 for (i
= 2; i
< 8; i
++) {
191 if (keys
[i
] > 3 && memscan(udata
+ 2, keys
[i
], 6) == udata
+ 8) {
192 if (hidp_keycode
[keys
[i
]])
193 input_report_key(dev
, hidp_keycode
[keys
[i
]], 0);
195 BT_ERR("Unknown key (scancode %#x) released.", keys
[i
]);
198 if (udata
[i
] > 3 && memscan(keys
+ 2, udata
[i
], 6) == keys
+ 8) {
199 if (hidp_keycode
[udata
[i
]])
200 input_report_key(dev
, hidp_keycode
[udata
[i
]], 1);
202 BT_ERR("Unknown key (scancode %#x) pressed.", udata
[i
]);
206 memcpy(keys
, udata
, 8);
209 case 0x02: /* Mouse report */
210 input_report_key(dev
, BTN_LEFT
, sdata
[0] & 0x01);
211 input_report_key(dev
, BTN_RIGHT
, sdata
[0] & 0x02);
212 input_report_key(dev
, BTN_MIDDLE
, sdata
[0] & 0x04);
213 input_report_key(dev
, BTN_SIDE
, sdata
[0] & 0x08);
214 input_report_key(dev
, BTN_EXTRA
, sdata
[0] & 0x10);
216 input_report_rel(dev
, REL_X
, sdata
[1]);
217 input_report_rel(dev
, REL_Y
, sdata
[2]);
220 input_report_rel(dev
, REL_WHEEL
, sdata
[3]);
227 static int hidp_get_raw_report(struct hid_device
*hid
,
228 unsigned char report_number
,
229 unsigned char *data
, size_t count
,
230 unsigned char report_type
)
232 struct hidp_session
*session
= hid
->driver_data
;
235 int numbered_reports
= hid
->report_enum
[report_type
].numbered
;
238 if (atomic_read(&session
->terminate
))
241 switch (report_type
) {
242 case HID_FEATURE_REPORT
:
243 report_type
= HIDP_TRANS_GET_REPORT
| HIDP_DATA_RTYPE_FEATURE
;
245 case HID_INPUT_REPORT
:
246 report_type
= HIDP_TRANS_GET_REPORT
| HIDP_DATA_RTYPE_INPUT
;
248 case HID_OUTPUT_REPORT
:
249 report_type
= HIDP_TRANS_GET_REPORT
| HIDP_DATA_RTYPE_OUPUT
;
255 if (mutex_lock_interruptible(&session
->report_mutex
))
258 /* Set up our wait, and send the report request to the device. */
259 session
->waiting_report_type
= report_type
& HIDP_DATA_RTYPE_MASK
;
260 session
->waiting_report_number
= numbered_reports
? report_number
: -1;
261 set_bit(HIDP_WAITING_FOR_RETURN
, &session
->flags
);
262 data
[0] = report_number
;
263 ret
= hidp_send_ctrl_message(session
, report_type
, data
, 1);
267 /* Wait for the return of the report. The returned report
268 gets put in session->report_return. */
269 while (test_bit(HIDP_WAITING_FOR_RETURN
, &session
->flags
) &&
270 !atomic_read(&session
->terminate
)) {
273 res
= wait_event_interruptible_timeout(session
->report_queue
,
274 !test_bit(HIDP_WAITING_FOR_RETURN
, &session
->flags
)
275 || atomic_read(&session
->terminate
),
289 skb
= session
->report_return
;
291 len
= skb
->len
< count
? skb
->len
: count
;
292 memcpy(data
, skb
->data
, len
);
295 session
->report_return
= NULL
;
297 /* Device returned a HANDSHAKE, indicating protocol error. */
301 clear_bit(HIDP_WAITING_FOR_RETURN
, &session
->flags
);
302 mutex_unlock(&session
->report_mutex
);
307 clear_bit(HIDP_WAITING_FOR_RETURN
, &session
->flags
);
308 mutex_unlock(&session
->report_mutex
);
312 static int hidp_set_raw_report(struct hid_device
*hid
, unsigned char reportnum
,
313 unsigned char *data
, size_t count
,
314 unsigned char report_type
)
316 struct hidp_session
*session
= hid
->driver_data
;
319 switch (report_type
) {
320 case HID_FEATURE_REPORT
:
321 report_type
= HIDP_TRANS_SET_REPORT
| HIDP_DATA_RTYPE_FEATURE
;
323 case HID_INPUT_REPORT
:
324 report_type
= HIDP_TRANS_SET_REPORT
| HIDP_DATA_RTYPE_INPUT
;
326 case HID_OUTPUT_REPORT
:
327 report_type
= HIDP_TRANS_SET_REPORT
| HIDP_DATA_RTYPE_OUPUT
;
333 if (mutex_lock_interruptible(&session
->report_mutex
))
336 /* Set up our wait, and send the report request to the device. */
338 set_bit(HIDP_WAITING_FOR_SEND_ACK
, &session
->flags
);
339 ret
= hidp_send_ctrl_message(session
, report_type
, data
, count
);
343 /* Wait for the ACK from the device. */
344 while (test_bit(HIDP_WAITING_FOR_SEND_ACK
, &session
->flags
) &&
345 !atomic_read(&session
->terminate
)) {
348 res
= wait_event_interruptible_timeout(session
->report_queue
,
349 !test_bit(HIDP_WAITING_FOR_SEND_ACK
, &session
->flags
)
350 || atomic_read(&session
->terminate
),
364 if (!session
->output_report_success
) {
372 clear_bit(HIDP_WAITING_FOR_SEND_ACK
, &session
->flags
);
373 mutex_unlock(&session
->report_mutex
);
377 static int hidp_output_report(struct hid_device
*hid
, __u8
*data
, size_t count
)
379 struct hidp_session
*session
= hid
->driver_data
;
381 return hidp_send_intr_message(session
,
382 HIDP_TRANS_DATA
| HIDP_DATA_RTYPE_OUPUT
,
386 static int hidp_raw_request(struct hid_device
*hid
, unsigned char reportnum
,
387 __u8
*buf
, size_t len
, unsigned char rtype
,
391 case HID_REQ_GET_REPORT
:
392 return hidp_get_raw_report(hid
, reportnum
, buf
, len
, rtype
);
393 case HID_REQ_SET_REPORT
:
394 return hidp_set_raw_report(hid
, reportnum
, buf
, len
, rtype
);
400 static void hidp_idle_timeout(unsigned long arg
)
402 struct hidp_session
*session
= (struct hidp_session
*) arg
;
404 /* The HIDP user-space API only contains calls to add and remove
405 * devices. There is no way to forward events of any kind. Therefore,
406 * we have to forcefully disconnect a device on idle-timeouts. This is
407 * unfortunate and weird API design, but it is spec-compliant and
408 * required for backwards-compatibility. Hence, on idle-timeout, we
409 * signal driver-detach events, so poll() will be woken up with an
410 * error-condition on both sockets.
413 session
->intr_sock
->sk
->sk_err
= EUNATCH
;
414 session
->ctrl_sock
->sk
->sk_err
= EUNATCH
;
415 wake_up_interruptible(sk_sleep(session
->intr_sock
->sk
));
416 wake_up_interruptible(sk_sleep(session
->ctrl_sock
->sk
));
418 hidp_session_terminate(session
);
421 static void hidp_set_timer(struct hidp_session
*session
)
423 if (session
->idle_to
> 0)
424 mod_timer(&session
->timer
, jiffies
+ HZ
* session
->idle_to
);
427 static void hidp_del_timer(struct hidp_session
*session
)
429 if (session
->idle_to
> 0)
430 del_timer(&session
->timer
);
433 static void hidp_process_report(struct hidp_session
*session
,
434 int type
, const u8
*data
, int len
, int intr
)
436 if (len
> HID_MAX_BUFFER_SIZE
)
437 len
= HID_MAX_BUFFER_SIZE
;
439 memcpy(session
->input_buf
, data
, len
);
440 hid_input_report(session
->hid
, type
, session
->input_buf
, len
, intr
);
443 static void hidp_process_handshake(struct hidp_session
*session
,
446 BT_DBG("session %p param 0x%02x", session
, param
);
447 session
->output_report_success
= 0; /* default condition */
450 case HIDP_HSHK_SUCCESSFUL
:
451 /* FIXME: Call into SET_ GET_ handlers here */
452 session
->output_report_success
= 1;
455 case HIDP_HSHK_NOT_READY
:
456 case HIDP_HSHK_ERR_INVALID_REPORT_ID
:
457 case HIDP_HSHK_ERR_UNSUPPORTED_REQUEST
:
458 case HIDP_HSHK_ERR_INVALID_PARAMETER
:
459 if (test_and_clear_bit(HIDP_WAITING_FOR_RETURN
, &session
->flags
))
460 wake_up_interruptible(&session
->report_queue
);
462 /* FIXME: Call into SET_ GET_ handlers here */
465 case HIDP_HSHK_ERR_UNKNOWN
:
468 case HIDP_HSHK_ERR_FATAL
:
469 /* Device requests a reboot, as this is the only way this error
470 * can be recovered. */
471 hidp_send_ctrl_message(session
,
472 HIDP_TRANS_HID_CONTROL
| HIDP_CTRL_SOFT_RESET
, NULL
, 0);
476 hidp_send_ctrl_message(session
,
477 HIDP_TRANS_HANDSHAKE
| HIDP_HSHK_ERR_INVALID_PARAMETER
, NULL
, 0);
481 /* Wake up the waiting thread. */
482 if (test_and_clear_bit(HIDP_WAITING_FOR_SEND_ACK
, &session
->flags
))
483 wake_up_interruptible(&session
->report_queue
);
486 static void hidp_process_hid_control(struct hidp_session
*session
,
489 BT_DBG("session %p param 0x%02x", session
, param
);
491 if (param
== HIDP_CTRL_VIRTUAL_CABLE_UNPLUG
) {
492 /* Flush the transmit queues */
493 skb_queue_purge(&session
->ctrl_transmit
);
494 skb_queue_purge(&session
->intr_transmit
);
496 hidp_session_terminate(session
);
500 /* Returns true if the passed-in skb should be freed by the caller. */
501 static int hidp_process_data(struct hidp_session
*session
, struct sk_buff
*skb
,
504 int done_with_skb
= 1;
505 BT_DBG("session %p skb %p len %d param 0x%02x", session
, skb
, skb
->len
, param
);
508 case HIDP_DATA_RTYPE_INPUT
:
509 hidp_set_timer(session
);
512 hidp_input_report(session
, skb
);
515 hidp_process_report(session
, HID_INPUT_REPORT
,
516 skb
->data
, skb
->len
, 0);
519 case HIDP_DATA_RTYPE_OTHER
:
520 case HIDP_DATA_RTYPE_OUPUT
:
521 case HIDP_DATA_RTYPE_FEATURE
:
525 hidp_send_ctrl_message(session
,
526 HIDP_TRANS_HANDSHAKE
| HIDP_HSHK_ERR_INVALID_PARAMETER
, NULL
, 0);
529 if (test_bit(HIDP_WAITING_FOR_RETURN
, &session
->flags
) &&
530 param
== session
->waiting_report_type
) {
531 if (session
->waiting_report_number
< 0 ||
532 session
->waiting_report_number
== skb
->data
[0]) {
533 /* hidp_get_raw_report() is waiting on this report. */
534 session
->report_return
= skb
;
536 clear_bit(HIDP_WAITING_FOR_RETURN
, &session
->flags
);
537 wake_up_interruptible(&session
->report_queue
);
541 return done_with_skb
;
544 static void hidp_recv_ctrl_frame(struct hidp_session
*session
,
547 unsigned char hdr
, type
, param
;
550 BT_DBG("session %p skb %p len %d", session
, skb
, skb
->len
);
555 type
= hdr
& HIDP_HEADER_TRANS_MASK
;
556 param
= hdr
& HIDP_HEADER_PARAM_MASK
;
559 case HIDP_TRANS_HANDSHAKE
:
560 hidp_process_handshake(session
, param
);
563 case HIDP_TRANS_HID_CONTROL
:
564 hidp_process_hid_control(session
, param
);
567 case HIDP_TRANS_DATA
:
568 free_skb
= hidp_process_data(session
, skb
, param
);
572 hidp_send_ctrl_message(session
,
573 HIDP_TRANS_HANDSHAKE
| HIDP_HSHK_ERR_UNSUPPORTED_REQUEST
, NULL
, 0);
581 static void hidp_recv_intr_frame(struct hidp_session
*session
,
586 BT_DBG("session %p skb %p len %d", session
, skb
, skb
->len
);
591 if (hdr
== (HIDP_TRANS_DATA
| HIDP_DATA_RTYPE_INPUT
)) {
592 hidp_set_timer(session
);
595 hidp_input_report(session
, skb
);
598 hidp_process_report(session
, HID_INPUT_REPORT
,
599 skb
->data
, skb
->len
, 1);
600 BT_DBG("report len %d", skb
->len
);
603 BT_DBG("Unsupported protocol header 0x%02x", hdr
);
609 static int hidp_send_frame(struct socket
*sock
, unsigned char *data
, int len
)
611 struct kvec iv
= { data
, len
};
614 BT_DBG("sock %p data %p len %d", sock
, data
, len
);
619 memset(&msg
, 0, sizeof(msg
));
621 return kernel_sendmsg(sock
, &msg
, &iv
, 1, len
);
624 /* dequeue message from @transmit and send via @sock */
625 static void hidp_process_transmit(struct hidp_session
*session
,
626 struct sk_buff_head
*transmit
,
632 BT_DBG("session %p", session
);
634 while ((skb
= skb_dequeue(transmit
))) {
635 ret
= hidp_send_frame(sock
, skb
->data
, skb
->len
);
636 if (ret
== -EAGAIN
) {
637 skb_queue_head(transmit
, skb
);
639 } else if (ret
< 0) {
640 hidp_session_terminate(session
);
645 hidp_set_timer(session
);
650 static int hidp_setup_input(struct hidp_session
*session
,
651 struct hidp_connadd_req
*req
)
653 struct input_dev
*input
;
656 input
= input_allocate_device();
660 session
->input
= input
;
662 input_set_drvdata(input
, session
);
664 input
->name
= "Bluetooth HID Boot Protocol Device";
666 input
->id
.bustype
= BUS_BLUETOOTH
;
667 input
->id
.vendor
= req
->vendor
;
668 input
->id
.product
= req
->product
;
669 input
->id
.version
= req
->version
;
671 if (req
->subclass
& 0x40) {
672 set_bit(EV_KEY
, input
->evbit
);
673 set_bit(EV_LED
, input
->evbit
);
674 set_bit(EV_REP
, input
->evbit
);
676 set_bit(LED_NUML
, input
->ledbit
);
677 set_bit(LED_CAPSL
, input
->ledbit
);
678 set_bit(LED_SCROLLL
, input
->ledbit
);
679 set_bit(LED_COMPOSE
, input
->ledbit
);
680 set_bit(LED_KANA
, input
->ledbit
);
682 for (i
= 0; i
< sizeof(hidp_keycode
); i
++)
683 set_bit(hidp_keycode
[i
], input
->keybit
);
684 clear_bit(0, input
->keybit
);
687 if (req
->subclass
& 0x80) {
688 input
->evbit
[0] = BIT_MASK(EV_KEY
) | BIT_MASK(EV_REL
);
689 input
->keybit
[BIT_WORD(BTN_MOUSE
)] = BIT_MASK(BTN_LEFT
) |
690 BIT_MASK(BTN_RIGHT
) | BIT_MASK(BTN_MIDDLE
);
691 input
->relbit
[0] = BIT_MASK(REL_X
) | BIT_MASK(REL_Y
);
692 input
->keybit
[BIT_WORD(BTN_MOUSE
)] |= BIT_MASK(BTN_SIDE
) |
694 input
->relbit
[0] |= BIT_MASK(REL_WHEEL
);
697 input
->dev
.parent
= &session
->conn
->hcon
->dev
;
699 input
->event
= hidp_input_event
;
704 static int hidp_open(struct hid_device
*hid
)
709 static void hidp_close(struct hid_device
*hid
)
713 static int hidp_parse(struct hid_device
*hid
)
715 struct hidp_session
*session
= hid
->driver_data
;
717 return hid_parse_report(session
->hid
, session
->rd_data
,
721 static int hidp_start(struct hid_device
*hid
)
726 static void hidp_stop(struct hid_device
*hid
)
728 struct hidp_session
*session
= hid
->driver_data
;
730 skb_queue_purge(&session
->ctrl_transmit
);
731 skb_queue_purge(&session
->intr_transmit
);
736 static struct hid_ll_driver hidp_hid_driver
= {
742 .raw_request
= hidp_raw_request
,
743 .output_report
= hidp_output_report
,
746 /* This function sets up the hid device. It does not add it
747 to the HID system. That is done in hidp_add_connection(). */
748 static int hidp_setup_hid(struct hidp_session
*session
,
749 struct hidp_connadd_req
*req
)
751 struct hid_device
*hid
;
754 session
->rd_data
= memdup_user(req
->rd_data
, req
->rd_size
);
755 if (IS_ERR(session
->rd_data
))
756 return PTR_ERR(session
->rd_data
);
758 session
->rd_size
= req
->rd_size
;
760 hid
= hid_allocate_device();
768 hid
->driver_data
= session
;
770 hid
->bus
= BUS_BLUETOOTH
;
771 hid
->vendor
= req
->vendor
;
772 hid
->product
= req
->product
;
773 hid
->version
= req
->version
;
774 hid
->country
= req
->country
;
776 strncpy(hid
->name
, req
->name
, sizeof(req
->name
) - 1);
778 snprintf(hid
->phys
, sizeof(hid
->phys
), "%pMR",
779 &l2cap_pi(session
->ctrl_sock
->sk
)->chan
->src
);
781 /* NOTE: Some device modules depend on the dst address being stored in
782 * uniq. Please be aware of this before making changes to this behavior.
784 snprintf(hid
->uniq
, sizeof(hid
->uniq
), "%pMR",
785 &l2cap_pi(session
->ctrl_sock
->sk
)->chan
->dst
);
787 hid
->dev
.parent
= &session
->conn
->hcon
->dev
;
788 hid
->ll_driver
= &hidp_hid_driver
;
790 /* True if device is blacklisted in drivers/hid/hid-core.c */
791 if (hid_ignore(hid
)) {
792 hid_destroy_device(session
->hid
);
800 kfree(session
->rd_data
);
801 session
->rd_data
= NULL
;
806 /* initialize session devices */
807 static int hidp_session_dev_init(struct hidp_session
*session
,
808 struct hidp_connadd_req
*req
)
812 if (req
->rd_size
> 0) {
813 ret
= hidp_setup_hid(session
, req
);
814 if (ret
&& ret
!= -ENODEV
)
819 ret
= hidp_setup_input(session
, req
);
827 /* destroy session devices */
828 static void hidp_session_dev_destroy(struct hidp_session
*session
)
831 put_device(&session
->hid
->dev
);
832 else if (session
->input
)
833 input_put_device(session
->input
);
835 kfree(session
->rd_data
);
836 session
->rd_data
= NULL
;
839 /* add HID/input devices to their underlying bus systems */
840 static int hidp_session_dev_add(struct hidp_session
*session
)
844 /* Both HID and input systems drop a ref-count when unregistering the
845 * device but they don't take a ref-count when registering them. Work
846 * around this by explicitly taking a refcount during registration
847 * which is dropped automatically by unregistering the devices. */
850 ret
= hid_add_device(session
->hid
);
853 get_device(&session
->hid
->dev
);
854 } else if (session
->input
) {
855 ret
= input_register_device(session
->input
);
858 input_get_device(session
->input
);
864 /* remove HID/input devices from their bus systems */
865 static void hidp_session_dev_del(struct hidp_session
*session
)
868 hid_destroy_device(session
->hid
);
869 else if (session
->input
)
870 input_unregister_device(session
->input
);
874 * Asynchronous device registration
875 * HID device drivers might want to perform I/O during initialization to
876 * detect device types. Therefore, call device registration in a separate
877 * worker so the HIDP thread can schedule I/O operations.
878 * Note that this must be called after the worker thread was initialized
879 * successfully. This will then add the devices and increase session state
880 * on success, otherwise it will terminate the session thread.
882 static void hidp_session_dev_work(struct work_struct
*work
)
884 struct hidp_session
*session
= container_of(work
,
889 ret
= hidp_session_dev_add(session
);
891 atomic_inc(&session
->state
);
893 hidp_session_terminate(session
);
897 * Create new session object
898 * Allocate session object, initialize static fields, copy input data into the
899 * object and take a reference to all sub-objects.
900 * This returns 0 on success and puts a pointer to the new session object in
901 * \out. Otherwise, an error code is returned.
902 * The new session object has an initial ref-count of 1.
904 static int hidp_session_new(struct hidp_session
**out
, const bdaddr_t
*bdaddr
,
905 struct socket
*ctrl_sock
,
906 struct socket
*intr_sock
,
907 struct hidp_connadd_req
*req
,
908 struct l2cap_conn
*conn
)
910 struct hidp_session
*session
;
912 struct bt_sock
*ctrl
, *intr
;
914 ctrl
= bt_sk(ctrl_sock
->sk
);
915 intr
= bt_sk(intr_sock
->sk
);
917 session
= kzalloc(sizeof(*session
), GFP_KERNEL
);
921 /* object and runtime management */
922 kref_init(&session
->ref
);
923 atomic_set(&session
->state
, HIDP_SESSION_IDLING
);
924 init_waitqueue_head(&session
->state_queue
);
925 session
->flags
= req
->flags
& BIT(HIDP_BLUETOOTH_VENDOR_ID
);
927 /* connection management */
928 bacpy(&session
->bdaddr
, bdaddr
);
929 session
->conn
= l2cap_conn_get(conn
);
930 session
->user
.probe
= hidp_session_probe
;
931 session
->user
.remove
= hidp_session_remove
;
932 INIT_LIST_HEAD(&session
->user
.list
);
933 session
->ctrl_sock
= ctrl_sock
;
934 session
->intr_sock
= intr_sock
;
935 skb_queue_head_init(&session
->ctrl_transmit
);
936 skb_queue_head_init(&session
->intr_transmit
);
937 session
->ctrl_mtu
= min_t(uint
, l2cap_pi(ctrl
)->chan
->omtu
,
938 l2cap_pi(ctrl
)->chan
->imtu
);
939 session
->intr_mtu
= min_t(uint
, l2cap_pi(intr
)->chan
->omtu
,
940 l2cap_pi(intr
)->chan
->imtu
);
941 session
->idle_to
= req
->idle_to
;
943 /* device management */
944 INIT_WORK(&session
->dev_init
, hidp_session_dev_work
);
945 setup_timer(&session
->timer
, hidp_idle_timeout
,
946 (unsigned long)session
);
949 mutex_init(&session
->report_mutex
);
950 init_waitqueue_head(&session
->report_queue
);
952 ret
= hidp_session_dev_init(session
, req
);
956 get_file(session
->intr_sock
->file
);
957 get_file(session
->ctrl_sock
->file
);
962 l2cap_conn_put(session
->conn
);
967 /* increase ref-count of the given session by one */
968 static void hidp_session_get(struct hidp_session
*session
)
970 kref_get(&session
->ref
);
973 /* release callback */
974 static void session_free(struct kref
*ref
)
976 struct hidp_session
*session
= container_of(ref
, struct hidp_session
,
979 hidp_session_dev_destroy(session
);
980 skb_queue_purge(&session
->ctrl_transmit
);
981 skb_queue_purge(&session
->intr_transmit
);
982 fput(session
->intr_sock
->file
);
983 fput(session
->ctrl_sock
->file
);
984 l2cap_conn_put(session
->conn
);
988 /* decrease ref-count of the given session by one */
989 static void hidp_session_put(struct hidp_session
*session
)
991 kref_put(&session
->ref
, session_free
);
995 * Search the list of active sessions for a session with target address
996 * \bdaddr. You must hold at least a read-lock on \hidp_session_sem. As long as
997 * you do not release this lock, the session objects cannot vanish and you can
998 * safely take a reference to the session yourself.
1000 static struct hidp_session
*__hidp_session_find(const bdaddr_t
*bdaddr
)
1002 struct hidp_session
*session
;
1004 list_for_each_entry(session
, &hidp_session_list
, list
) {
1005 if (!bacmp(bdaddr
, &session
->bdaddr
))
1013 * Same as __hidp_session_find() but no locks must be held. This also takes a
1014 * reference of the returned session (if non-NULL) so you must drop this
1015 * reference if you no longer use the object.
1017 static struct hidp_session
*hidp_session_find(const bdaddr_t
*bdaddr
)
1019 struct hidp_session
*session
;
1021 down_read(&hidp_session_sem
);
1023 session
= __hidp_session_find(bdaddr
);
1025 hidp_session_get(session
);
1027 up_read(&hidp_session_sem
);
1033 * Start session synchronously
1034 * This starts a session thread and waits until initialization
1035 * is done or returns an error if it couldn't be started.
1036 * If this returns 0 the session thread is up and running. You must call
1037 * hipd_session_stop_sync() before deleting any runtime resources.
1039 static int hidp_session_start_sync(struct hidp_session
*session
)
1041 unsigned int vendor
, product
;
1044 vendor
= session
->hid
->vendor
;
1045 product
= session
->hid
->product
;
1046 } else if (session
->input
) {
1047 vendor
= session
->input
->id
.vendor
;
1048 product
= session
->input
->id
.product
;
1054 session
->task
= kthread_run(hidp_session_thread
, session
,
1055 "khidpd_%04x%04x", vendor
, product
);
1056 if (IS_ERR(session
->task
))
1057 return PTR_ERR(session
->task
);
1059 while (atomic_read(&session
->state
) <= HIDP_SESSION_IDLING
)
1060 wait_event(session
->state_queue
,
1061 atomic_read(&session
->state
) > HIDP_SESSION_IDLING
);
1067 * Terminate session thread
1068 * Wake up session thread and notify it to stop. This is asynchronous and
1069 * returns immediately. Call this whenever a runtime error occurs and you want
1070 * the session to stop.
1071 * Note: wake_up_process() performs any necessary memory-barriers for us.
1073 static void hidp_session_terminate(struct hidp_session
*session
)
1075 atomic_inc(&session
->terminate
);
1076 wake_up_process(session
->task
);
1080 * Probe HIDP session
1081 * This is called from the l2cap_conn core when our l2cap_user object is bound
1082 * to the hci-connection. We get the session via the \user object and can now
1083 * start the session thread, link it into the global session list and
1084 * schedule HID/input device registration.
1085 * The global session-list owns its own reference to the session object so you
1086 * can drop your own reference after registering the l2cap_user object.
1088 static int hidp_session_probe(struct l2cap_conn
*conn
,
1089 struct l2cap_user
*user
)
1091 struct hidp_session
*session
= container_of(user
,
1092 struct hidp_session
,
1094 struct hidp_session
*s
;
1097 down_write(&hidp_session_sem
);
1099 /* check that no other session for this device exists */
1100 s
= __hidp_session_find(&session
->bdaddr
);
1106 if (session
->input
) {
1107 ret
= hidp_session_dev_add(session
);
1112 ret
= hidp_session_start_sync(session
);
1116 /* HID device registration is async to allow I/O during probe */
1118 atomic_inc(&session
->state
);
1120 schedule_work(&session
->dev_init
);
1122 hidp_session_get(session
);
1123 list_add(&session
->list
, &hidp_session_list
);
1129 hidp_session_dev_del(session
);
1131 up_write(&hidp_session_sem
);
1136 * Remove HIDP session
1137 * Called from the l2cap_conn core when either we explicitly unregistered
1138 * the l2cap_user object or if the underlying connection is shut down.
1139 * We signal the hidp-session thread to shut down, unregister the HID/input
1140 * devices and unlink the session from the global list.
1141 * This drops the reference to the session that is owned by the global
1143 * Note: We _must_ not synchronosly wait for the session-thread to shut down.
1144 * This is, because the session-thread might be waiting for an HCI lock that is
1145 * held while we are called. Therefore, we only unregister the devices and
1146 * notify the session-thread to terminate. The thread itself owns a reference
1147 * to the session object so it can safely shut down.
1149 static void hidp_session_remove(struct l2cap_conn
*conn
,
1150 struct l2cap_user
*user
)
1152 struct hidp_session
*session
= container_of(user
,
1153 struct hidp_session
,
1156 down_write(&hidp_session_sem
);
1158 hidp_session_terminate(session
);
1160 cancel_work_sync(&session
->dev_init
);
1161 if (session
->input
||
1162 atomic_read(&session
->state
) > HIDP_SESSION_PREPARING
)
1163 hidp_session_dev_del(session
);
1165 list_del(&session
->list
);
1167 up_write(&hidp_session_sem
);
1169 hidp_session_put(session
);
1174 * This performs the actual main-loop of the HIDP worker. We first check
1175 * whether the underlying connection is still alive, then parse all pending
1176 * messages and finally send all outstanding messages.
1178 static void hidp_session_run(struct hidp_session
*session
)
1180 struct sock
*ctrl_sk
= session
->ctrl_sock
->sk
;
1181 struct sock
*intr_sk
= session
->intr_sock
->sk
;
1182 struct sk_buff
*skb
;
1186 * This thread can be woken up two ways:
1187 * - You call hidp_session_terminate() which sets the
1188 * session->terminate flag and wakes this thread up.
1189 * - Via modifying the socket state of ctrl/intr_sock. This
1190 * thread is woken up by ->sk_state_changed().
1192 * Note: set_current_state() performs any necessary
1193 * memory-barriers for us.
1195 set_current_state(TASK_INTERRUPTIBLE
);
1197 if (atomic_read(&session
->terminate
))
1200 if (ctrl_sk
->sk_state
!= BT_CONNECTED
||
1201 intr_sk
->sk_state
!= BT_CONNECTED
)
1204 /* parse incoming intr-skbs */
1205 while ((skb
= skb_dequeue(&intr_sk
->sk_receive_queue
))) {
1207 if (!skb_linearize(skb
))
1208 hidp_recv_intr_frame(session
, skb
);
1213 /* send pending intr-skbs */
1214 hidp_process_transmit(session
, &session
->intr_transmit
,
1215 session
->intr_sock
);
1217 /* parse incoming ctrl-skbs */
1218 while ((skb
= skb_dequeue(&ctrl_sk
->sk_receive_queue
))) {
1220 if (!skb_linearize(skb
))
1221 hidp_recv_ctrl_frame(session
, skb
);
1226 /* send pending ctrl-skbs */
1227 hidp_process_transmit(session
, &session
->ctrl_transmit
,
1228 session
->ctrl_sock
);
1233 atomic_inc(&session
->terminate
);
1234 set_current_state(TASK_RUNNING
);
1238 * HIDP session thread
1239 * This thread runs the I/O for a single HIDP session. Startup is synchronous
1240 * which allows us to take references to ourself here instead of doing that in
1242 * When we are ready to run we notify the caller and call hidp_session_run().
1244 static int hidp_session_thread(void *arg
)
1246 struct hidp_session
*session
= arg
;
1247 wait_queue_t ctrl_wait
, intr_wait
;
1249 BT_DBG("session %p", session
);
1251 /* initialize runtime environment */
1252 hidp_session_get(session
);
1253 __module_get(THIS_MODULE
);
1254 set_user_nice(current
, -15);
1255 hidp_set_timer(session
);
1257 init_waitqueue_entry(&ctrl_wait
, current
);
1258 init_waitqueue_entry(&intr_wait
, current
);
1259 add_wait_queue(sk_sleep(session
->ctrl_sock
->sk
), &ctrl_wait
);
1260 add_wait_queue(sk_sleep(session
->intr_sock
->sk
), &intr_wait
);
1261 /* This memory barrier is paired with wq_has_sleeper(). See
1262 * sock_poll_wait() for more information why this is needed. */
1265 /* notify synchronous startup that we're ready */
1266 atomic_inc(&session
->state
);
1267 wake_up(&session
->state_queue
);
1270 hidp_session_run(session
);
1272 /* cleanup runtime environment */
1273 remove_wait_queue(sk_sleep(session
->intr_sock
->sk
), &intr_wait
);
1274 remove_wait_queue(sk_sleep(session
->intr_sock
->sk
), &ctrl_wait
);
1275 wake_up_interruptible(&session
->report_queue
);
1276 hidp_del_timer(session
);
1279 * If we stopped ourself due to any internal signal, we should try to
1280 * unregister our own session here to avoid having it linger until the
1281 * parent l2cap_conn dies or user-space cleans it up.
1282 * This does not deadlock as we don't do any synchronous shutdown.
1283 * Instead, this call has the same semantics as if user-space tried to
1284 * delete the session.
1286 l2cap_unregister_user(session
->conn
, &session
->user
);
1287 hidp_session_put(session
);
1289 module_put_and_exit(0);
1293 static int hidp_verify_sockets(struct socket
*ctrl_sock
,
1294 struct socket
*intr_sock
)
1296 struct l2cap_chan
*ctrl_chan
, *intr_chan
;
1297 struct bt_sock
*ctrl
, *intr
;
1298 struct hidp_session
*session
;
1300 if (!l2cap_is_socket(ctrl_sock
) || !l2cap_is_socket(intr_sock
))
1303 ctrl_chan
= l2cap_pi(ctrl_sock
->sk
)->chan
;
1304 intr_chan
= l2cap_pi(intr_sock
->sk
)->chan
;
1306 if (bacmp(&ctrl_chan
->src
, &intr_chan
->src
) ||
1307 bacmp(&ctrl_chan
->dst
, &intr_chan
->dst
))
1310 ctrl
= bt_sk(ctrl_sock
->sk
);
1311 intr
= bt_sk(intr_sock
->sk
);
1313 if (ctrl
->sk
.sk_state
!= BT_CONNECTED
||
1314 intr
->sk
.sk_state
!= BT_CONNECTED
)
1317 /* early session check, we check again during session registration */
1318 session
= hidp_session_find(&ctrl_chan
->dst
);
1320 hidp_session_put(session
);
1327 int hidp_connection_add(struct hidp_connadd_req
*req
,
1328 struct socket
*ctrl_sock
,
1329 struct socket
*intr_sock
)
1331 u32 valid_flags
= BIT(HIDP_VIRTUAL_CABLE_UNPLUG
) |
1332 BIT(HIDP_BOOT_PROTOCOL_MODE
);
1333 struct hidp_session
*session
;
1334 struct l2cap_conn
*conn
;
1335 struct l2cap_chan
*chan
;
1338 ret
= hidp_verify_sockets(ctrl_sock
, intr_sock
);
1342 if (req
->flags
& ~valid_flags
)
1345 chan
= l2cap_pi(ctrl_sock
->sk
)->chan
;
1347 l2cap_chan_lock(chan
);
1349 conn
= l2cap_conn_get(chan
->conn
);
1350 l2cap_chan_unlock(chan
);
1355 ret
= hidp_session_new(&session
, &chan
->dst
, ctrl_sock
,
1356 intr_sock
, req
, conn
);
1360 ret
= l2cap_register_user(conn
, &session
->user
);
1367 hidp_session_put(session
);
1369 l2cap_conn_put(conn
);
1373 int hidp_connection_del(struct hidp_conndel_req
*req
)
1375 u32 valid_flags
= BIT(HIDP_VIRTUAL_CABLE_UNPLUG
);
1376 struct hidp_session
*session
;
1378 if (req
->flags
& ~valid_flags
)
1381 session
= hidp_session_find(&req
->bdaddr
);
1385 if (req
->flags
& BIT(HIDP_VIRTUAL_CABLE_UNPLUG
))
1386 hidp_send_ctrl_message(session
,
1387 HIDP_TRANS_HID_CONTROL
|
1388 HIDP_CTRL_VIRTUAL_CABLE_UNPLUG
,
1391 l2cap_unregister_user(session
->conn
, &session
->user
);
1393 hidp_session_put(session
);
1398 int hidp_get_connlist(struct hidp_connlist_req
*req
)
1400 struct hidp_session
*session
;
1405 down_read(&hidp_session_sem
);
1407 list_for_each_entry(session
, &hidp_session_list
, list
) {
1408 struct hidp_conninfo ci
;
1410 hidp_copy_session(session
, &ci
);
1412 if (copy_to_user(req
->ci
, &ci
, sizeof(ci
))) {
1417 if (++n
>= req
->cnum
)
1424 up_read(&hidp_session_sem
);
1428 int hidp_get_conninfo(struct hidp_conninfo
*ci
)
1430 struct hidp_session
*session
;
1432 session
= hidp_session_find(&ci
->bdaddr
);
1434 hidp_copy_session(session
, ci
);
1435 hidp_session_put(session
);
1438 return session
? 0 : -ENOENT
;
1441 static int __init
hidp_init(void)
1443 BT_INFO("HIDP (Human Interface Emulation) ver %s", VERSION
);
1445 return hidp_init_sockets();
1448 static void __exit
hidp_exit(void)
1450 hidp_cleanup_sockets();
1453 module_init(hidp_init
);
1454 module_exit(hidp_exit
);
1456 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
1457 MODULE_AUTHOR("David Herrmann <dh.herrmann@gmail.com>");
1458 MODULE_DESCRIPTION("Bluetooth HIDP ver " VERSION
);
1459 MODULE_VERSION(VERSION
);
1460 MODULE_LICENSE("GPL");
1461 MODULE_ALIAS("bt-proto-6");