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
)
73 memset(ci
, 0, sizeof(*ci
));
74 bacpy(&ci
->bdaddr
, &session
->bdaddr
);
76 ci
->flags
= session
->flags
;
77 ci
->state
= BT_CONNECTED
;
80 ci
->vendor
= session
->input
->id
.vendor
;
81 ci
->product
= session
->input
->id
.product
;
82 ci
->version
= session
->input
->id
.version
;
83 if (session
->input
->name
)
84 strlcpy(ci
->name
, session
->input
->name
, 128);
86 strlcpy(ci
->name
, "HID Boot Device", 128);
87 } else if (session
->hid
) {
88 ci
->vendor
= session
->hid
->vendor
;
89 ci
->product
= session
->hid
->product
;
90 ci
->version
= session
->hid
->version
;
91 strlcpy(ci
->name
, session
->hid
->name
, 128);
95 /* assemble skb, queue message on @transmit and wake up the session thread */
96 static int hidp_send_message(struct hidp_session
*session
, struct socket
*sock
,
97 struct sk_buff_head
*transmit
, unsigned char hdr
,
98 const unsigned char *data
, int size
)
101 struct sock
*sk
= sock
->sk
;
103 BT_DBG("session %p data %p size %d", session
, data
, size
);
105 if (atomic_read(&session
->terminate
))
108 skb
= alloc_skb(size
+ 1, GFP_ATOMIC
);
110 BT_ERR("Can't allocate memory for new frame");
114 *skb_put(skb
, 1) = hdr
;
115 if (data
&& size
> 0)
116 memcpy(skb_put(skb
, size
), data
, size
);
118 skb_queue_tail(transmit
, skb
);
119 wake_up_interruptible(sk_sleep(sk
));
124 static int hidp_send_ctrl_message(struct hidp_session
*session
,
125 unsigned char hdr
, const unsigned char *data
,
128 return hidp_send_message(session
, session
->ctrl_sock
,
129 &session
->ctrl_transmit
, hdr
, data
, size
);
132 static int hidp_send_intr_message(struct hidp_session
*session
,
133 unsigned char hdr
, const unsigned char *data
,
136 return hidp_send_message(session
, session
->intr_sock
,
137 &session
->intr_transmit
, hdr
, data
, size
);
140 static int hidp_input_event(struct input_dev
*dev
, unsigned int type
,
141 unsigned int code
, int value
)
143 struct hidp_session
*session
= input_get_drvdata(dev
);
144 unsigned char newleds
;
145 unsigned char hdr
, data
[2];
147 BT_DBG("session %p type %d code %d value %d",
148 session
, type
, code
, value
);
153 newleds
= (!!test_bit(LED_KANA
, dev
->led
) << 3) |
154 (!!test_bit(LED_COMPOSE
, dev
->led
) << 3) |
155 (!!test_bit(LED_SCROLLL
, dev
->led
) << 2) |
156 (!!test_bit(LED_CAPSL
, dev
->led
) << 1) |
157 (!!test_bit(LED_NUML
, dev
->led
));
159 if (session
->leds
== newleds
)
162 session
->leds
= newleds
;
164 hdr
= HIDP_TRANS_DATA
| HIDP_DATA_RTYPE_OUPUT
;
168 return hidp_send_intr_message(session
, hdr
, data
, 2);
171 static void hidp_input_report(struct hidp_session
*session
, struct sk_buff
*skb
)
173 struct input_dev
*dev
= session
->input
;
174 unsigned char *keys
= session
->keys
;
175 unsigned char *udata
= skb
->data
+ 1;
176 signed char *sdata
= skb
->data
+ 1;
177 int i
, size
= skb
->len
- 1;
179 switch (skb
->data
[0]) {
180 case 0x01: /* Keyboard report */
181 for (i
= 0; i
< 8; i
++)
182 input_report_key(dev
, hidp_keycode
[i
+ 224], (udata
[0] >> i
) & 1);
184 /* If all the key codes have been set to 0x01, it means
185 * too many keys were pressed at the same time. */
186 if (!memcmp(udata
+ 2, hidp_mkeyspat
, 6))
189 for (i
= 2; i
< 8; i
++) {
190 if (keys
[i
] > 3 && memscan(udata
+ 2, keys
[i
], 6) == udata
+ 8) {
191 if (hidp_keycode
[keys
[i
]])
192 input_report_key(dev
, hidp_keycode
[keys
[i
]], 0);
194 BT_ERR("Unknown key (scancode %#x) released.", keys
[i
]);
197 if (udata
[i
] > 3 && memscan(keys
+ 2, udata
[i
], 6) == keys
+ 8) {
198 if (hidp_keycode
[udata
[i
]])
199 input_report_key(dev
, hidp_keycode
[udata
[i
]], 1);
201 BT_ERR("Unknown key (scancode %#x) pressed.", udata
[i
]);
205 memcpy(keys
, udata
, 8);
208 case 0x02: /* Mouse report */
209 input_report_key(dev
, BTN_LEFT
, sdata
[0] & 0x01);
210 input_report_key(dev
, BTN_RIGHT
, sdata
[0] & 0x02);
211 input_report_key(dev
, BTN_MIDDLE
, sdata
[0] & 0x04);
212 input_report_key(dev
, BTN_SIDE
, sdata
[0] & 0x08);
213 input_report_key(dev
, BTN_EXTRA
, sdata
[0] & 0x10);
215 input_report_rel(dev
, REL_X
, sdata
[1]);
216 input_report_rel(dev
, REL_Y
, sdata
[2]);
219 input_report_rel(dev
, REL_WHEEL
, sdata
[3]);
226 static int hidp_send_report(struct hidp_session
*session
, struct hid_report
*report
)
232 buf
= hid_alloc_report_buf(report
, GFP_ATOMIC
);
236 hid_output_report(report
, buf
);
237 hdr
= HIDP_TRANS_DATA
| HIDP_DATA_RTYPE_OUPUT
;
239 rsize
= ((report
->size
- 1) >> 3) + 1 + (report
->id
> 0);
240 ret
= hidp_send_intr_message(session
, hdr
, buf
, rsize
);
246 static int hidp_hidinput_event(struct input_dev
*dev
, unsigned int type
,
247 unsigned int code
, int value
)
249 struct hid_device
*hid
= input_get_drvdata(dev
);
250 struct hidp_session
*session
= hid
->driver_data
;
251 struct hid_field
*field
;
254 BT_DBG("session %p type %d code %d value %d",
255 session
, type
, code
, value
);
260 offset
= hidinput_find_field(hid
, type
, code
, &field
);
262 hid_warn(dev
, "event field not found\n");
266 hid_set_field(field
, offset
, value
);
268 return hidp_send_report(session
, field
->report
);
271 static int hidp_get_raw_report(struct hid_device
*hid
,
272 unsigned char report_number
,
273 unsigned char *data
, size_t count
,
274 unsigned char report_type
)
276 struct hidp_session
*session
= hid
->driver_data
;
279 int numbered_reports
= hid
->report_enum
[report_type
].numbered
;
282 if (atomic_read(&session
->terminate
))
285 switch (report_type
) {
286 case HID_FEATURE_REPORT
:
287 report_type
= HIDP_TRANS_GET_REPORT
| HIDP_DATA_RTYPE_FEATURE
;
289 case HID_INPUT_REPORT
:
290 report_type
= HIDP_TRANS_GET_REPORT
| HIDP_DATA_RTYPE_INPUT
;
292 case HID_OUTPUT_REPORT
:
293 report_type
= HIDP_TRANS_GET_REPORT
| HIDP_DATA_RTYPE_OUPUT
;
299 if (mutex_lock_interruptible(&session
->report_mutex
))
302 /* Set up our wait, and send the report request to the device. */
303 session
->waiting_report_type
= report_type
& HIDP_DATA_RTYPE_MASK
;
304 session
->waiting_report_number
= numbered_reports
? report_number
: -1;
305 set_bit(HIDP_WAITING_FOR_RETURN
, &session
->flags
);
306 data
[0] = report_number
;
307 ret
= hidp_send_ctrl_message(session
, report_type
, data
, 1);
311 /* Wait for the return of the report. The returned report
312 gets put in session->report_return. */
313 while (test_bit(HIDP_WAITING_FOR_RETURN
, &session
->flags
) &&
314 !atomic_read(&session
->terminate
)) {
317 res
= wait_event_interruptible_timeout(session
->report_queue
,
318 !test_bit(HIDP_WAITING_FOR_RETURN
, &session
->flags
)
319 || atomic_read(&session
->terminate
),
333 skb
= session
->report_return
;
335 len
= skb
->len
< count
? skb
->len
: count
;
336 memcpy(data
, skb
->data
, len
);
339 session
->report_return
= NULL
;
341 /* Device returned a HANDSHAKE, indicating protocol error. */
345 clear_bit(HIDP_WAITING_FOR_RETURN
, &session
->flags
);
346 mutex_unlock(&session
->report_mutex
);
351 clear_bit(HIDP_WAITING_FOR_RETURN
, &session
->flags
);
352 mutex_unlock(&session
->report_mutex
);
356 static int hidp_output_raw_report(struct hid_device
*hid
, unsigned char *data
, size_t count
,
357 unsigned char report_type
)
359 struct hidp_session
*session
= hid
->driver_data
;
362 if (report_type
== HID_OUTPUT_REPORT
) {
363 report_type
= HIDP_TRANS_DATA
| HIDP_DATA_RTYPE_OUPUT
;
364 return hidp_send_intr_message(session
, report_type
,
366 } else if (report_type
!= HID_FEATURE_REPORT
) {
370 if (mutex_lock_interruptible(&session
->report_mutex
))
373 /* Set up our wait, and send the report request to the device. */
374 set_bit(HIDP_WAITING_FOR_SEND_ACK
, &session
->flags
);
375 report_type
= HIDP_TRANS_SET_REPORT
| HIDP_DATA_RTYPE_FEATURE
;
376 ret
= hidp_send_ctrl_message(session
, report_type
, data
, count
);
380 /* Wait for the ACK from the device. */
381 while (test_bit(HIDP_WAITING_FOR_SEND_ACK
, &session
->flags
) &&
382 !atomic_read(&session
->terminate
)) {
385 res
= wait_event_interruptible_timeout(session
->report_queue
,
386 !test_bit(HIDP_WAITING_FOR_SEND_ACK
, &session
->flags
)
387 || atomic_read(&session
->terminate
),
401 if (!session
->output_report_success
) {
409 clear_bit(HIDP_WAITING_FOR_SEND_ACK
, &session
->flags
);
410 mutex_unlock(&session
->report_mutex
);
414 static void hidp_idle_timeout(unsigned long arg
)
416 struct hidp_session
*session
= (struct hidp_session
*) arg
;
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_handshake(struct hidp_session
*session
,
436 BT_DBG("session %p param 0x%02x", session
, param
);
437 session
->output_report_success
= 0; /* default condition */
440 case HIDP_HSHK_SUCCESSFUL
:
441 /* FIXME: Call into SET_ GET_ handlers here */
442 session
->output_report_success
= 1;
445 case HIDP_HSHK_NOT_READY
:
446 case HIDP_HSHK_ERR_INVALID_REPORT_ID
:
447 case HIDP_HSHK_ERR_UNSUPPORTED_REQUEST
:
448 case HIDP_HSHK_ERR_INVALID_PARAMETER
:
449 if (test_and_clear_bit(HIDP_WAITING_FOR_RETURN
, &session
->flags
))
450 wake_up_interruptible(&session
->report_queue
);
452 /* FIXME: Call into SET_ GET_ handlers here */
455 case HIDP_HSHK_ERR_UNKNOWN
:
458 case HIDP_HSHK_ERR_FATAL
:
459 /* Device requests a reboot, as this is the only way this error
460 * can be recovered. */
461 hidp_send_ctrl_message(session
,
462 HIDP_TRANS_HID_CONTROL
| HIDP_CTRL_SOFT_RESET
, NULL
, 0);
466 hidp_send_ctrl_message(session
,
467 HIDP_TRANS_HANDSHAKE
| HIDP_HSHK_ERR_INVALID_PARAMETER
, NULL
, 0);
471 /* Wake up the waiting thread. */
472 if (test_and_clear_bit(HIDP_WAITING_FOR_SEND_ACK
, &session
->flags
))
473 wake_up_interruptible(&session
->report_queue
);
476 static void hidp_process_hid_control(struct hidp_session
*session
,
479 BT_DBG("session %p param 0x%02x", session
, param
);
481 if (param
== HIDP_CTRL_VIRTUAL_CABLE_UNPLUG
) {
482 /* Flush the transmit queues */
483 skb_queue_purge(&session
->ctrl_transmit
);
484 skb_queue_purge(&session
->intr_transmit
);
486 hidp_session_terminate(session
);
490 /* Returns true if the passed-in skb should be freed by the caller. */
491 static int hidp_process_data(struct hidp_session
*session
, struct sk_buff
*skb
,
494 int done_with_skb
= 1;
495 BT_DBG("session %p skb %p len %d param 0x%02x", session
, skb
, skb
->len
, param
);
498 case HIDP_DATA_RTYPE_INPUT
:
499 hidp_set_timer(session
);
502 hidp_input_report(session
, skb
);
505 hid_input_report(session
->hid
, HID_INPUT_REPORT
, skb
->data
, skb
->len
, 0);
508 case HIDP_DATA_RTYPE_OTHER
:
509 case HIDP_DATA_RTYPE_OUPUT
:
510 case HIDP_DATA_RTYPE_FEATURE
:
514 hidp_send_ctrl_message(session
,
515 HIDP_TRANS_HANDSHAKE
| HIDP_HSHK_ERR_INVALID_PARAMETER
, NULL
, 0);
518 if (test_bit(HIDP_WAITING_FOR_RETURN
, &session
->flags
) &&
519 param
== session
->waiting_report_type
) {
520 if (session
->waiting_report_number
< 0 ||
521 session
->waiting_report_number
== skb
->data
[0]) {
522 /* hidp_get_raw_report() is waiting on this report. */
523 session
->report_return
= skb
;
525 clear_bit(HIDP_WAITING_FOR_RETURN
, &session
->flags
);
526 wake_up_interruptible(&session
->report_queue
);
530 return done_with_skb
;
533 static void hidp_recv_ctrl_frame(struct hidp_session
*session
,
536 unsigned char hdr
, type
, param
;
539 BT_DBG("session %p skb %p len %d", session
, skb
, skb
->len
);
544 type
= hdr
& HIDP_HEADER_TRANS_MASK
;
545 param
= hdr
& HIDP_HEADER_PARAM_MASK
;
548 case HIDP_TRANS_HANDSHAKE
:
549 hidp_process_handshake(session
, param
);
552 case HIDP_TRANS_HID_CONTROL
:
553 hidp_process_hid_control(session
, param
);
556 case HIDP_TRANS_DATA
:
557 free_skb
= hidp_process_data(session
, skb
, param
);
561 hidp_send_ctrl_message(session
,
562 HIDP_TRANS_HANDSHAKE
| HIDP_HSHK_ERR_UNSUPPORTED_REQUEST
, NULL
, 0);
570 static void hidp_recv_intr_frame(struct hidp_session
*session
,
575 BT_DBG("session %p skb %p len %d", session
, skb
, skb
->len
);
580 if (hdr
== (HIDP_TRANS_DATA
| HIDP_DATA_RTYPE_INPUT
)) {
581 hidp_set_timer(session
);
584 hidp_input_report(session
, skb
);
587 hid_input_report(session
->hid
, HID_INPUT_REPORT
, skb
->data
, skb
->len
, 1);
588 BT_DBG("report len %d", skb
->len
);
591 BT_DBG("Unsupported protocol header 0x%02x", hdr
);
597 static int hidp_send_frame(struct socket
*sock
, unsigned char *data
, int len
)
599 struct kvec iv
= { data
, len
};
602 BT_DBG("sock %p data %p len %d", sock
, data
, len
);
607 memset(&msg
, 0, sizeof(msg
));
609 return kernel_sendmsg(sock
, &msg
, &iv
, 1, len
);
612 /* dequeue message from @transmit and send via @sock */
613 static void hidp_process_transmit(struct hidp_session
*session
,
614 struct sk_buff_head
*transmit
,
620 BT_DBG("session %p", session
);
622 while ((skb
= skb_dequeue(transmit
))) {
623 ret
= hidp_send_frame(sock
, skb
->data
, skb
->len
);
624 if (ret
== -EAGAIN
) {
625 skb_queue_head(transmit
, skb
);
627 } else if (ret
< 0) {
628 hidp_session_terminate(session
);
633 hidp_set_timer(session
);
638 static int hidp_setup_input(struct hidp_session
*session
,
639 struct hidp_connadd_req
*req
)
641 struct input_dev
*input
;
644 input
= input_allocate_device();
648 session
->input
= input
;
650 input_set_drvdata(input
, session
);
652 input
->name
= "Bluetooth HID Boot Protocol Device";
654 input
->id
.bustype
= BUS_BLUETOOTH
;
655 input
->id
.vendor
= req
->vendor
;
656 input
->id
.product
= req
->product
;
657 input
->id
.version
= req
->version
;
659 if (req
->subclass
& 0x40) {
660 set_bit(EV_KEY
, input
->evbit
);
661 set_bit(EV_LED
, input
->evbit
);
662 set_bit(EV_REP
, input
->evbit
);
664 set_bit(LED_NUML
, input
->ledbit
);
665 set_bit(LED_CAPSL
, input
->ledbit
);
666 set_bit(LED_SCROLLL
, input
->ledbit
);
667 set_bit(LED_COMPOSE
, input
->ledbit
);
668 set_bit(LED_KANA
, input
->ledbit
);
670 for (i
= 0; i
< sizeof(hidp_keycode
); i
++)
671 set_bit(hidp_keycode
[i
], input
->keybit
);
672 clear_bit(0, input
->keybit
);
675 if (req
->subclass
& 0x80) {
676 input
->evbit
[0] = BIT_MASK(EV_KEY
) | BIT_MASK(EV_REL
);
677 input
->keybit
[BIT_WORD(BTN_MOUSE
)] = BIT_MASK(BTN_LEFT
) |
678 BIT_MASK(BTN_RIGHT
) | BIT_MASK(BTN_MIDDLE
);
679 input
->relbit
[0] = BIT_MASK(REL_X
) | BIT_MASK(REL_Y
);
680 input
->keybit
[BIT_WORD(BTN_MOUSE
)] |= BIT_MASK(BTN_SIDE
) |
682 input
->relbit
[0] |= BIT_MASK(REL_WHEEL
);
685 input
->dev
.parent
= &session
->conn
->hcon
->dev
;
687 input
->event
= hidp_input_event
;
692 static int hidp_open(struct hid_device
*hid
)
697 static void hidp_close(struct hid_device
*hid
)
701 static int hidp_parse(struct hid_device
*hid
)
703 struct hidp_session
*session
= hid
->driver_data
;
705 return hid_parse_report(session
->hid
, session
->rd_data
,
709 static int hidp_start(struct hid_device
*hid
)
714 static void hidp_stop(struct hid_device
*hid
)
716 struct hidp_session
*session
= hid
->driver_data
;
718 skb_queue_purge(&session
->ctrl_transmit
);
719 skb_queue_purge(&session
->intr_transmit
);
724 static struct hid_ll_driver hidp_hid_driver
= {
730 .hidinput_input_event
= hidp_hidinput_event
,
733 /* This function sets up the hid device. It does not add it
734 to the HID system. That is done in hidp_add_connection(). */
735 static int hidp_setup_hid(struct hidp_session
*session
,
736 struct hidp_connadd_req
*req
)
738 struct hid_device
*hid
;
741 session
->rd_data
= kzalloc(req
->rd_size
, GFP_KERNEL
);
742 if (!session
->rd_data
)
745 if (copy_from_user(session
->rd_data
, req
->rd_data
, req
->rd_size
)) {
749 session
->rd_size
= req
->rd_size
;
751 hid
= hid_allocate_device();
759 hid
->driver_data
= session
;
761 hid
->bus
= BUS_BLUETOOTH
;
762 hid
->vendor
= req
->vendor
;
763 hid
->product
= req
->product
;
764 hid
->version
= req
->version
;
765 hid
->country
= req
->country
;
767 strncpy(hid
->name
, req
->name
, sizeof(req
->name
) - 1);
769 snprintf(hid
->phys
, sizeof(hid
->phys
), "%pMR",
770 &l2cap_pi(session
->ctrl_sock
->sk
)->chan
->src
);
772 snprintf(hid
->uniq
, sizeof(hid
->uniq
), "%pMR",
773 &l2cap_pi(session
->ctrl_sock
->sk
)->chan
->dst
);
775 hid
->dev
.parent
= &session
->conn
->hcon
->dev
;
776 hid
->ll_driver
= &hidp_hid_driver
;
778 hid
->hid_get_raw_report
= hidp_get_raw_report
;
779 hid
->hid_output_raw_report
= hidp_output_raw_report
;
781 /* True if device is blacklisted in drivers/hid/hid-core.c */
782 if (hid_ignore(hid
)) {
783 hid_destroy_device(session
->hid
);
791 kfree(session
->rd_data
);
792 session
->rd_data
= NULL
;
797 /* initialize session devices */
798 static int hidp_session_dev_init(struct hidp_session
*session
,
799 struct hidp_connadd_req
*req
)
803 if (req
->rd_size
> 0) {
804 ret
= hidp_setup_hid(session
, req
);
805 if (ret
&& ret
!= -ENODEV
)
810 ret
= hidp_setup_input(session
, req
);
818 /* destroy session devices */
819 static void hidp_session_dev_destroy(struct hidp_session
*session
)
822 put_device(&session
->hid
->dev
);
823 else if (session
->input
)
824 input_put_device(session
->input
);
826 kfree(session
->rd_data
);
827 session
->rd_data
= NULL
;
830 /* add HID/input devices to their underlying bus systems */
831 static int hidp_session_dev_add(struct hidp_session
*session
)
835 /* Both HID and input systems drop a ref-count when unregistering the
836 * device but they don't take a ref-count when registering them. Work
837 * around this by explicitly taking a refcount during registration
838 * which is dropped automatically by unregistering the devices. */
841 ret
= hid_add_device(session
->hid
);
844 get_device(&session
->hid
->dev
);
845 } else if (session
->input
) {
846 ret
= input_register_device(session
->input
);
849 input_get_device(session
->input
);
855 /* remove HID/input devices from their bus systems */
856 static void hidp_session_dev_del(struct hidp_session
*session
)
859 hid_destroy_device(session
->hid
);
860 else if (session
->input
)
861 input_unregister_device(session
->input
);
865 * Asynchronous device registration
866 * HID device drivers might want to perform I/O during initialization to
867 * detect device types. Therefore, call device registration in a separate
868 * worker so the HIDP thread can schedule I/O operations.
869 * Note that this must be called after the worker thread was initialized
870 * successfully. This will then add the devices and increase session state
871 * on success, otherwise it will terminate the session thread.
873 static void hidp_session_dev_work(struct work_struct
*work
)
875 struct hidp_session
*session
= container_of(work
,
880 ret
= hidp_session_dev_add(session
);
882 atomic_inc(&session
->state
);
884 hidp_session_terminate(session
);
888 * Create new session object
889 * Allocate session object, initialize static fields, copy input data into the
890 * object and take a reference to all sub-objects.
891 * This returns 0 on success and puts a pointer to the new session object in
892 * \out. Otherwise, an error code is returned.
893 * The new session object has an initial ref-count of 1.
895 static int hidp_session_new(struct hidp_session
**out
, const bdaddr_t
*bdaddr
,
896 struct socket
*ctrl_sock
,
897 struct socket
*intr_sock
,
898 struct hidp_connadd_req
*req
,
899 struct l2cap_conn
*conn
)
901 struct hidp_session
*session
;
903 struct bt_sock
*ctrl
, *intr
;
905 ctrl
= bt_sk(ctrl_sock
->sk
);
906 intr
= bt_sk(intr_sock
->sk
);
908 session
= kzalloc(sizeof(*session
), GFP_KERNEL
);
912 /* object and runtime management */
913 kref_init(&session
->ref
);
914 atomic_set(&session
->state
, HIDP_SESSION_IDLING
);
915 init_waitqueue_head(&session
->state_queue
);
916 session
->flags
= req
->flags
& (1 << HIDP_BLUETOOTH_VENDOR_ID
);
918 /* connection management */
919 bacpy(&session
->bdaddr
, bdaddr
);
920 session
->conn
= conn
;
921 session
->user
.probe
= hidp_session_probe
;
922 session
->user
.remove
= hidp_session_remove
;
923 session
->ctrl_sock
= ctrl_sock
;
924 session
->intr_sock
= intr_sock
;
925 skb_queue_head_init(&session
->ctrl_transmit
);
926 skb_queue_head_init(&session
->intr_transmit
);
927 session
->ctrl_mtu
= min_t(uint
, l2cap_pi(ctrl
)->chan
->omtu
,
928 l2cap_pi(ctrl
)->chan
->imtu
);
929 session
->intr_mtu
= min_t(uint
, l2cap_pi(intr
)->chan
->omtu
,
930 l2cap_pi(intr
)->chan
->imtu
);
931 session
->idle_to
= req
->idle_to
;
933 /* device management */
934 INIT_WORK(&session
->dev_init
, hidp_session_dev_work
);
935 setup_timer(&session
->timer
, hidp_idle_timeout
,
936 (unsigned long)session
);
939 mutex_init(&session
->report_mutex
);
940 init_waitqueue_head(&session
->report_queue
);
942 ret
= hidp_session_dev_init(session
, req
);
946 l2cap_conn_get(session
->conn
);
947 get_file(session
->intr_sock
->file
);
948 get_file(session
->ctrl_sock
->file
);
957 /* increase ref-count of the given session by one */
958 static void hidp_session_get(struct hidp_session
*session
)
960 kref_get(&session
->ref
);
963 /* release callback */
964 static void session_free(struct kref
*ref
)
966 struct hidp_session
*session
= container_of(ref
, struct hidp_session
,
969 hidp_session_dev_destroy(session
);
970 skb_queue_purge(&session
->ctrl_transmit
);
971 skb_queue_purge(&session
->intr_transmit
);
972 fput(session
->intr_sock
->file
);
973 fput(session
->ctrl_sock
->file
);
974 l2cap_conn_put(session
->conn
);
978 /* decrease ref-count of the given session by one */
979 static void hidp_session_put(struct hidp_session
*session
)
981 kref_put(&session
->ref
, session_free
);
985 * Search the list of active sessions for a session with target address
986 * \bdaddr. You must hold at least a read-lock on \hidp_session_sem. As long as
987 * you do not release this lock, the session objects cannot vanish and you can
988 * safely take a reference to the session yourself.
990 static struct hidp_session
*__hidp_session_find(const bdaddr_t
*bdaddr
)
992 struct hidp_session
*session
;
994 list_for_each_entry(session
, &hidp_session_list
, list
) {
995 if (!bacmp(bdaddr
, &session
->bdaddr
))
1003 * Same as __hidp_session_find() but no locks must be held. This also takes a
1004 * reference of the returned session (if non-NULL) so you must drop this
1005 * reference if you no longer use the object.
1007 static struct hidp_session
*hidp_session_find(const bdaddr_t
*bdaddr
)
1009 struct hidp_session
*session
;
1011 down_read(&hidp_session_sem
);
1013 session
= __hidp_session_find(bdaddr
);
1015 hidp_session_get(session
);
1017 up_read(&hidp_session_sem
);
1023 * Start session synchronously
1024 * This starts a session thread and waits until initialization
1025 * is done or returns an error if it couldn't be started.
1026 * If this returns 0 the session thread is up and running. You must call
1027 * hipd_session_stop_sync() before deleting any runtime resources.
1029 static int hidp_session_start_sync(struct hidp_session
*session
)
1031 unsigned int vendor
, product
;
1034 vendor
= session
->hid
->vendor
;
1035 product
= session
->hid
->product
;
1036 } else if (session
->input
) {
1037 vendor
= session
->input
->id
.vendor
;
1038 product
= session
->input
->id
.product
;
1044 session
->task
= kthread_run(hidp_session_thread
, session
,
1045 "khidpd_%04x%04x", vendor
, product
);
1046 if (IS_ERR(session
->task
))
1047 return PTR_ERR(session
->task
);
1049 while (atomic_read(&session
->state
) <= HIDP_SESSION_IDLING
)
1050 wait_event(session
->state_queue
,
1051 atomic_read(&session
->state
) > HIDP_SESSION_IDLING
);
1057 * Terminate session thread
1058 * Wake up session thread and notify it to stop. This is asynchronous and
1059 * returns immediately. Call this whenever a runtime error occurs and you want
1060 * the session to stop.
1061 * Note: wake_up_process() performs any necessary memory-barriers for us.
1063 static void hidp_session_terminate(struct hidp_session
*session
)
1065 atomic_inc(&session
->terminate
);
1066 wake_up_process(session
->task
);
1070 * Probe HIDP session
1071 * This is called from the l2cap_conn core when our l2cap_user object is bound
1072 * to the hci-connection. We get the session via the \user object and can now
1073 * start the session thread, link it into the global session list and
1074 * schedule HID/input device registration.
1075 * The global session-list owns its own reference to the session object so you
1076 * can drop your own reference after registering the l2cap_user object.
1078 static int hidp_session_probe(struct l2cap_conn
*conn
,
1079 struct l2cap_user
*user
)
1081 struct hidp_session
*session
= container_of(user
,
1082 struct hidp_session
,
1084 struct hidp_session
*s
;
1087 down_write(&hidp_session_sem
);
1089 /* check that no other session for this device exists */
1090 s
= __hidp_session_find(&session
->bdaddr
);
1096 if (session
->input
) {
1097 ret
= hidp_session_dev_add(session
);
1102 ret
= hidp_session_start_sync(session
);
1106 /* HID device registration is async to allow I/O during probe */
1108 atomic_inc(&session
->state
);
1110 schedule_work(&session
->dev_init
);
1112 hidp_session_get(session
);
1113 list_add(&session
->list
, &hidp_session_list
);
1119 hidp_session_dev_del(session
);
1121 up_write(&hidp_session_sem
);
1126 * Remove HIDP session
1127 * Called from the l2cap_conn core when either we explicitly unregistered
1128 * the l2cap_user object or if the underlying connection is shut down.
1129 * We signal the hidp-session thread to shut down, unregister the HID/input
1130 * devices and unlink the session from the global list.
1131 * This drops the reference to the session that is owned by the global
1133 * Note: We _must_ not synchronosly wait for the session-thread to shut down.
1134 * This is, because the session-thread might be waiting for an HCI lock that is
1135 * held while we are called. Therefore, we only unregister the devices and
1136 * notify the session-thread to terminate. The thread itself owns a reference
1137 * to the session object so it can safely shut down.
1139 static void hidp_session_remove(struct l2cap_conn
*conn
,
1140 struct l2cap_user
*user
)
1142 struct hidp_session
*session
= container_of(user
,
1143 struct hidp_session
,
1146 down_write(&hidp_session_sem
);
1148 hidp_session_terminate(session
);
1150 cancel_work_sync(&session
->dev_init
);
1151 if (session
->input
||
1152 atomic_read(&session
->state
) > HIDP_SESSION_PREPARING
)
1153 hidp_session_dev_del(session
);
1155 list_del(&session
->list
);
1157 up_write(&hidp_session_sem
);
1159 hidp_session_put(session
);
1164 * This performs the actual main-loop of the HIDP worker. We first check
1165 * whether the underlying connection is still alive, then parse all pending
1166 * messages and finally send all outstanding messages.
1168 static void hidp_session_run(struct hidp_session
*session
)
1170 struct sock
*ctrl_sk
= session
->ctrl_sock
->sk
;
1171 struct sock
*intr_sk
= session
->intr_sock
->sk
;
1172 struct sk_buff
*skb
;
1176 * This thread can be woken up two ways:
1177 * - You call hidp_session_terminate() which sets the
1178 * session->terminate flag and wakes this thread up.
1179 * - Via modifying the socket state of ctrl/intr_sock. This
1180 * thread is woken up by ->sk_state_changed().
1182 * Note: set_current_state() performs any necessary
1183 * memory-barriers for us.
1185 set_current_state(TASK_INTERRUPTIBLE
);
1187 if (atomic_read(&session
->terminate
))
1190 if (ctrl_sk
->sk_state
!= BT_CONNECTED
||
1191 intr_sk
->sk_state
!= BT_CONNECTED
)
1194 /* parse incoming intr-skbs */
1195 while ((skb
= skb_dequeue(&intr_sk
->sk_receive_queue
))) {
1197 if (!skb_linearize(skb
))
1198 hidp_recv_intr_frame(session
, skb
);
1203 /* send pending intr-skbs */
1204 hidp_process_transmit(session
, &session
->intr_transmit
,
1205 session
->intr_sock
);
1207 /* parse incoming ctrl-skbs */
1208 while ((skb
= skb_dequeue(&ctrl_sk
->sk_receive_queue
))) {
1210 if (!skb_linearize(skb
))
1211 hidp_recv_ctrl_frame(session
, skb
);
1216 /* send pending ctrl-skbs */
1217 hidp_process_transmit(session
, &session
->ctrl_transmit
,
1218 session
->ctrl_sock
);
1223 atomic_inc(&session
->terminate
);
1224 set_current_state(TASK_RUNNING
);
1228 * HIDP session thread
1229 * This thread runs the I/O for a single HIDP session. Startup is synchronous
1230 * which allows us to take references to ourself here instead of doing that in
1232 * When we are ready to run we notify the caller and call hidp_session_run().
1234 static int hidp_session_thread(void *arg
)
1236 struct hidp_session
*session
= arg
;
1237 wait_queue_t ctrl_wait
, intr_wait
;
1239 BT_DBG("session %p", session
);
1241 /* initialize runtime environment */
1242 hidp_session_get(session
);
1243 __module_get(THIS_MODULE
);
1244 set_user_nice(current
, -15);
1245 hidp_set_timer(session
);
1247 init_waitqueue_entry(&ctrl_wait
, current
);
1248 init_waitqueue_entry(&intr_wait
, current
);
1249 add_wait_queue(sk_sleep(session
->ctrl_sock
->sk
), &ctrl_wait
);
1250 add_wait_queue(sk_sleep(session
->intr_sock
->sk
), &intr_wait
);
1251 /* This memory barrier is paired with wq_has_sleeper(). See
1252 * sock_poll_wait() for more information why this is needed. */
1255 /* notify synchronous startup that we're ready */
1256 atomic_inc(&session
->state
);
1257 wake_up(&session
->state_queue
);
1260 hidp_session_run(session
);
1262 /* cleanup runtime environment */
1263 remove_wait_queue(sk_sleep(session
->intr_sock
->sk
), &intr_wait
);
1264 remove_wait_queue(sk_sleep(session
->intr_sock
->sk
), &ctrl_wait
);
1265 wake_up_interruptible(&session
->report_queue
);
1266 hidp_del_timer(session
);
1269 * If we stopped ourself due to any internal signal, we should try to
1270 * unregister our own session here to avoid having it linger until the
1271 * parent l2cap_conn dies or user-space cleans it up.
1272 * This does not deadlock as we don't do any synchronous shutdown.
1273 * Instead, this call has the same semantics as if user-space tried to
1274 * delete the session.
1276 l2cap_unregister_user(session
->conn
, &session
->user
);
1277 hidp_session_put(session
);
1279 module_put_and_exit(0);
1283 static int hidp_verify_sockets(struct socket
*ctrl_sock
,
1284 struct socket
*intr_sock
)
1286 struct l2cap_chan
*ctrl_chan
, *intr_chan
;
1287 struct bt_sock
*ctrl
, *intr
;
1288 struct hidp_session
*session
;
1290 if (!l2cap_is_socket(ctrl_sock
) || !l2cap_is_socket(intr_sock
))
1293 ctrl_chan
= l2cap_pi(ctrl_sock
->sk
)->chan
;
1294 intr_chan
= l2cap_pi(intr_sock
->sk
)->chan
;
1296 if (bacmp(&ctrl_chan
->src
, &intr_chan
->src
) ||
1297 bacmp(&ctrl_chan
->dst
, &intr_chan
->dst
))
1300 ctrl
= bt_sk(ctrl_sock
->sk
);
1301 intr
= bt_sk(intr_sock
->sk
);
1303 if (ctrl
->sk
.sk_state
!= BT_CONNECTED
||
1304 intr
->sk
.sk_state
!= BT_CONNECTED
)
1307 /* early session check, we check again during session registration */
1308 session
= hidp_session_find(&ctrl_chan
->dst
);
1310 hidp_session_put(session
);
1317 int hidp_connection_add(struct hidp_connadd_req
*req
,
1318 struct socket
*ctrl_sock
,
1319 struct socket
*intr_sock
)
1321 struct hidp_session
*session
;
1322 struct l2cap_conn
*conn
;
1323 struct l2cap_chan
*chan
= l2cap_pi(ctrl_sock
->sk
)->chan
;
1326 ret
= hidp_verify_sockets(ctrl_sock
, intr_sock
);
1331 l2cap_chan_lock(chan
);
1333 l2cap_conn_get(chan
->conn
);
1336 l2cap_chan_unlock(chan
);
1341 ret
= hidp_session_new(&session
, &chan
->dst
, ctrl_sock
,
1342 intr_sock
, req
, conn
);
1346 ret
= l2cap_register_user(conn
, &session
->user
);
1353 hidp_session_put(session
);
1355 l2cap_conn_put(conn
);
1359 int hidp_connection_del(struct hidp_conndel_req
*req
)
1361 struct hidp_session
*session
;
1363 session
= hidp_session_find(&req
->bdaddr
);
1367 if (req
->flags
& (1 << HIDP_VIRTUAL_CABLE_UNPLUG
))
1368 hidp_send_ctrl_message(session
,
1369 HIDP_TRANS_HID_CONTROL
|
1370 HIDP_CTRL_VIRTUAL_CABLE_UNPLUG
,
1373 l2cap_unregister_user(session
->conn
, &session
->user
);
1375 hidp_session_put(session
);
1380 int hidp_get_connlist(struct hidp_connlist_req
*req
)
1382 struct hidp_session
*session
;
1387 down_read(&hidp_session_sem
);
1389 list_for_each_entry(session
, &hidp_session_list
, list
) {
1390 struct hidp_conninfo ci
;
1392 hidp_copy_session(session
, &ci
);
1394 if (copy_to_user(req
->ci
, &ci
, sizeof(ci
))) {
1399 if (++n
>= req
->cnum
)
1406 up_read(&hidp_session_sem
);
1410 int hidp_get_conninfo(struct hidp_conninfo
*ci
)
1412 struct hidp_session
*session
;
1414 session
= hidp_session_find(&ci
->bdaddr
);
1416 hidp_copy_session(session
, ci
);
1417 hidp_session_put(session
);
1420 return session
? 0 : -ENOENT
;
1423 static int __init
hidp_init(void)
1425 BT_INFO("HIDP (Human Interface Emulation) ver %s", VERSION
);
1427 return hidp_init_sockets();
1430 static void __exit
hidp_exit(void)
1432 hidp_cleanup_sockets();
1435 module_init(hidp_init
);
1436 module_exit(hidp_exit
);
1438 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
1439 MODULE_AUTHOR("David Herrmann <dh.herrmann@gmail.com>");
1440 MODULE_DESCRIPTION("Bluetooth HIDP ver " VERSION
);
1441 MODULE_VERSION(VERSION
);
1442 MODULE_LICENSE("GPL");
1443 MODULE_ALIAS("bt-proto-6");