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_get_raw_report(struct hid_device *hid,
247 unsigned char report_number,
248 unsigned char *data, size_t count,
249 unsigned char report_type)
251 struct hidp_session *session = hid->driver_data;
254 int numbered_reports = hid->report_enum[report_type].numbered;
257 if (atomic_read(&session->terminate))
260 switch (report_type) {
261 case HID_FEATURE_REPORT:
262 report_type = HIDP_TRANS_GET_REPORT | HIDP_DATA_RTYPE_FEATURE;
264 case HID_INPUT_REPORT:
265 report_type = HIDP_TRANS_GET_REPORT | HIDP_DATA_RTYPE_INPUT;
267 case HID_OUTPUT_REPORT:
268 report_type = HIDP_TRANS_GET_REPORT | HIDP_DATA_RTYPE_OUPUT;
274 if (mutex_lock_interruptible(&session->report_mutex))
277 /* Set up our wait, and send the report request to the device. */
278 session->waiting_report_type = report_type & HIDP_DATA_RTYPE_MASK;
279 session->waiting_report_number = numbered_reports ? report_number : -1;
280 set_bit(HIDP_WAITING_FOR_RETURN, &session->flags);
281 data[0] = report_number;
282 ret = hidp_send_ctrl_message(session, report_type, data, 1);
286 /* Wait for the return of the report. The returned report
287 gets put in session->report_return. */
288 while (test_bit(HIDP_WAITING_FOR_RETURN, &session->flags) &&
289 !atomic_read(&session->terminate)) {
292 res = wait_event_interruptible_timeout(session->report_queue,
293 !test_bit(HIDP_WAITING_FOR_RETURN, &session->flags)
294 || atomic_read(&session->terminate),
308 skb = session->report_return;
310 len = skb->len < count ? skb->len : count;
311 memcpy(data, skb->data, len);
314 session->report_return = NULL;
316 /* Device returned a HANDSHAKE, indicating protocol error. */
320 clear_bit(HIDP_WAITING_FOR_RETURN, &session->flags);
321 mutex_unlock(&session->report_mutex);
326 clear_bit(HIDP_WAITING_FOR_RETURN, &session->flags);
327 mutex_unlock(&session->report_mutex);
331 static int hidp_output_raw_report(struct hid_device *hid, unsigned char *data, size_t count,
332 unsigned char report_type)
334 struct hidp_session *session = hid->driver_data;
337 if (report_type == HID_OUTPUT_REPORT) {
338 report_type = HIDP_TRANS_DATA | HIDP_DATA_RTYPE_OUPUT;
339 return hidp_send_intr_message(session, report_type,
341 } else if (report_type != HID_FEATURE_REPORT) {
345 if (mutex_lock_interruptible(&session->report_mutex))
348 /* Set up our wait, and send the report request to the device. */
349 set_bit(HIDP_WAITING_FOR_SEND_ACK, &session->flags);
350 report_type = HIDP_TRANS_SET_REPORT | HIDP_DATA_RTYPE_FEATURE;
351 ret = hidp_send_ctrl_message(session, report_type, data, count);
355 /* Wait for the ACK from the device. */
356 while (test_bit(HIDP_WAITING_FOR_SEND_ACK, &session->flags) &&
357 !atomic_read(&session->terminate)) {
360 res = wait_event_interruptible_timeout(session->report_queue,
361 !test_bit(HIDP_WAITING_FOR_SEND_ACK, &session->flags)
362 || atomic_read(&session->terminate),
376 if (!session->output_report_success) {
384 clear_bit(HIDP_WAITING_FOR_SEND_ACK, &session->flags);
385 mutex_unlock(&session->report_mutex);
389 static void hidp_idle_timeout(unsigned long arg)
391 struct hidp_session *session = (struct hidp_session *) arg;
393 hidp_session_terminate(session);
396 static void hidp_set_timer(struct hidp_session *session)
398 if (session->idle_to > 0)
399 mod_timer(&session->timer, jiffies + HZ * session->idle_to);
402 static void hidp_del_timer(struct hidp_session *session)
404 if (session->idle_to > 0)
405 del_timer(&session->timer);
408 static void hidp_process_handshake(struct hidp_session *session,
411 BT_DBG("session %p param 0x%02x", session, param);
412 session->output_report_success = 0; /* default condition */
415 case HIDP_HSHK_SUCCESSFUL:
416 /* FIXME: Call into SET_ GET_ handlers here */
417 session->output_report_success = 1;
420 case HIDP_HSHK_NOT_READY:
421 case HIDP_HSHK_ERR_INVALID_REPORT_ID:
422 case HIDP_HSHK_ERR_UNSUPPORTED_REQUEST:
423 case HIDP_HSHK_ERR_INVALID_PARAMETER:
424 if (test_and_clear_bit(HIDP_WAITING_FOR_RETURN, &session->flags))
425 wake_up_interruptible(&session->report_queue);
427 /* FIXME: Call into SET_ GET_ handlers here */
430 case HIDP_HSHK_ERR_UNKNOWN:
433 case HIDP_HSHK_ERR_FATAL:
434 /* Device requests a reboot, as this is the only way this error
435 * can be recovered. */
436 hidp_send_ctrl_message(session,
437 HIDP_TRANS_HID_CONTROL | HIDP_CTRL_SOFT_RESET, NULL, 0);
441 hidp_send_ctrl_message(session,
442 HIDP_TRANS_HANDSHAKE | HIDP_HSHK_ERR_INVALID_PARAMETER, NULL, 0);
446 /* Wake up the waiting thread. */
447 if (test_and_clear_bit(HIDP_WAITING_FOR_SEND_ACK, &session->flags))
448 wake_up_interruptible(&session->report_queue);
451 static void hidp_process_hid_control(struct hidp_session *session,
454 BT_DBG("session %p param 0x%02x", session, param);
456 if (param == HIDP_CTRL_VIRTUAL_CABLE_UNPLUG) {
457 /* Flush the transmit queues */
458 skb_queue_purge(&session->ctrl_transmit);
459 skb_queue_purge(&session->intr_transmit);
461 hidp_session_terminate(session);
465 /* Returns true if the passed-in skb should be freed by the caller. */
466 static int hidp_process_data(struct hidp_session *session, struct sk_buff *skb,
469 int done_with_skb = 1;
470 BT_DBG("session %p skb %p len %d param 0x%02x", session, skb, skb->len, param);
473 case HIDP_DATA_RTYPE_INPUT:
474 hidp_set_timer(session);
477 hidp_input_report(session, skb);
480 hid_input_report(session->hid, HID_INPUT_REPORT, skb->data, skb->len, 0);
483 case HIDP_DATA_RTYPE_OTHER:
484 case HIDP_DATA_RTYPE_OUPUT:
485 case HIDP_DATA_RTYPE_FEATURE:
489 hidp_send_ctrl_message(session,
490 HIDP_TRANS_HANDSHAKE | HIDP_HSHK_ERR_INVALID_PARAMETER, NULL, 0);
493 if (test_bit(HIDP_WAITING_FOR_RETURN, &session->flags) &&
494 param == session->waiting_report_type) {
495 if (session->waiting_report_number < 0 ||
496 session->waiting_report_number == skb->data[0]) {
497 /* hidp_get_raw_report() is waiting on this report. */
498 session->report_return = skb;
500 clear_bit(HIDP_WAITING_FOR_RETURN, &session->flags);
501 wake_up_interruptible(&session->report_queue);
505 return done_with_skb;
508 static void hidp_recv_ctrl_frame(struct hidp_session *session,
511 unsigned char hdr, type, param;
514 BT_DBG("session %p skb %p len %d", session, skb, skb->len);
519 type = hdr & HIDP_HEADER_TRANS_MASK;
520 param = hdr & HIDP_HEADER_PARAM_MASK;
523 case HIDP_TRANS_HANDSHAKE:
524 hidp_process_handshake(session, param);
527 case HIDP_TRANS_HID_CONTROL:
528 hidp_process_hid_control(session, param);
531 case HIDP_TRANS_DATA:
532 free_skb = hidp_process_data(session, skb, param);
536 hidp_send_ctrl_message(session,
537 HIDP_TRANS_HANDSHAKE | HIDP_HSHK_ERR_UNSUPPORTED_REQUEST, NULL, 0);
545 static void hidp_recv_intr_frame(struct hidp_session *session,
550 BT_DBG("session %p skb %p len %d", session, skb, skb->len);
555 if (hdr == (HIDP_TRANS_DATA | HIDP_DATA_RTYPE_INPUT)) {
556 hidp_set_timer(session);
559 hidp_input_report(session, skb);
562 hid_input_report(session->hid, HID_INPUT_REPORT, skb->data, skb->len, 1);
563 BT_DBG("report len %d", skb->len);
566 BT_DBG("Unsupported protocol header 0x%02x", hdr);
572 static int hidp_send_frame(struct socket *sock, unsigned char *data, int len)
574 struct kvec iv = { data, len };
577 BT_DBG("sock %p data %p len %d", sock, data, len);
582 memset(&msg, 0, sizeof(msg));
584 return kernel_sendmsg(sock, &msg, &iv, 1, len);
587 /* dequeue message from @transmit and send via @sock */
588 static void hidp_process_transmit(struct hidp_session *session,
589 struct sk_buff_head *transmit,
595 BT_DBG("session %p", session);
597 while ((skb = skb_dequeue(transmit))) {
598 ret = hidp_send_frame(sock, skb->data, skb->len);
599 if (ret == -EAGAIN) {
600 skb_queue_head(transmit, skb);
602 } else if (ret < 0) {
603 hidp_session_terminate(session);
608 hidp_set_timer(session);
613 static int hidp_setup_input(struct hidp_session *session,
614 struct hidp_connadd_req *req)
616 struct input_dev *input;
619 input = input_allocate_device();
623 session->input = input;
625 input_set_drvdata(input, session);
627 input->name = "Bluetooth HID Boot Protocol Device";
629 input->id.bustype = BUS_BLUETOOTH;
630 input->id.vendor = req->vendor;
631 input->id.product = req->product;
632 input->id.version = req->version;
634 if (req->subclass & 0x40) {
635 set_bit(EV_KEY, input->evbit);
636 set_bit(EV_LED, input->evbit);
637 set_bit(EV_REP, input->evbit);
639 set_bit(LED_NUML, input->ledbit);
640 set_bit(LED_CAPSL, input->ledbit);
641 set_bit(LED_SCROLLL, input->ledbit);
642 set_bit(LED_COMPOSE, input->ledbit);
643 set_bit(LED_KANA, input->ledbit);
645 for (i = 0; i < sizeof(hidp_keycode); i++)
646 set_bit(hidp_keycode[i], input->keybit);
647 clear_bit(0, input->keybit);
650 if (req->subclass & 0x80) {
651 input->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REL);
652 input->keybit[BIT_WORD(BTN_MOUSE)] = BIT_MASK(BTN_LEFT) |
653 BIT_MASK(BTN_RIGHT) | BIT_MASK(BTN_MIDDLE);
654 input->relbit[0] = BIT_MASK(REL_X) | BIT_MASK(REL_Y);
655 input->keybit[BIT_WORD(BTN_MOUSE)] |= BIT_MASK(BTN_SIDE) |
657 input->relbit[0] |= BIT_MASK(REL_WHEEL);
660 input->dev.parent = &session->conn->hcon->dev;
662 input->event = hidp_input_event;
667 static int hidp_open(struct hid_device *hid)
672 static void hidp_close(struct hid_device *hid)
676 static int hidp_parse(struct hid_device *hid)
678 struct hidp_session *session = hid->driver_data;
680 return hid_parse_report(session->hid, session->rd_data,
684 static int hidp_start(struct hid_device *hid)
686 struct hidp_session *session = hid->driver_data;
687 struct hid_report *report;
689 if (hid->quirks & HID_QUIRK_NO_INIT_REPORTS)
692 list_for_each_entry(report, &hid->report_enum[HID_INPUT_REPORT].
694 hidp_send_report(session, report);
696 list_for_each_entry(report, &hid->report_enum[HID_FEATURE_REPORT].
698 hidp_send_report(session, report);
703 static void hidp_stop(struct hid_device *hid)
705 struct hidp_session *session = hid->driver_data;
707 skb_queue_purge(&session->ctrl_transmit);
708 skb_queue_purge(&session->intr_transmit);
713 static struct hid_ll_driver hidp_hid_driver = {
721 /* This function sets up the hid device. It does not add it
722 to the HID system. That is done in hidp_add_connection(). */
723 static int hidp_setup_hid(struct hidp_session *session,
724 struct hidp_connadd_req *req)
726 struct hid_device *hid;
729 session->rd_data = kzalloc(req->rd_size, GFP_KERNEL);
730 if (!session->rd_data)
733 if (copy_from_user(session->rd_data, req->rd_data, req->rd_size)) {
737 session->rd_size = req->rd_size;
739 hid = hid_allocate_device();
747 hid->driver_data = session;
749 hid->bus = BUS_BLUETOOTH;
750 hid->vendor = req->vendor;
751 hid->product = req->product;
752 hid->version = req->version;
753 hid->country = req->country;
755 strncpy(hid->name, req->name, sizeof(req->name) - 1);
757 snprintf(hid->phys, sizeof(hid->phys), "%pMR",
758 &bt_sk(session->ctrl_sock->sk)->src);
760 snprintf(hid->uniq, sizeof(hid->uniq), "%pMR",
761 &bt_sk(session->ctrl_sock->sk)->dst);
763 hid->dev.parent = &session->conn->hcon->dev;
764 hid->ll_driver = &hidp_hid_driver;
766 hid->hid_get_raw_report = hidp_get_raw_report;
767 hid->hid_output_raw_report = hidp_output_raw_report;
769 /* True if device is blacklisted in drivers/hid/hid-core.c */
770 if (hid_ignore(hid)) {
771 hid_destroy_device(session->hid);
779 kfree(session->rd_data);
780 session->rd_data = NULL;
785 /* initialize session devices */
786 static int hidp_session_dev_init(struct hidp_session *session,
787 struct hidp_connadd_req *req)
791 if (req->rd_size > 0) {
792 ret = hidp_setup_hid(session, req);
793 if (ret && ret != -ENODEV)
798 ret = hidp_setup_input(session, req);
806 /* destroy session devices */
807 static void hidp_session_dev_destroy(struct hidp_session *session)
810 put_device(&session->hid->dev);
811 else if (session->input)
812 input_put_device(session->input);
814 kfree(session->rd_data);
815 session->rd_data = NULL;
818 /* add HID/input devices to their underlying bus systems */
819 static int hidp_session_dev_add(struct hidp_session *session)
823 /* Both HID and input systems drop a ref-count when unregistering the
824 * device but they don't take a ref-count when registering them. Work
825 * around this by explicitly taking a refcount during registration
826 * which is dropped automatically by unregistering the devices. */
829 ret = hid_add_device(session->hid);
832 get_device(&session->hid->dev);
833 } else if (session->input) {
834 ret = input_register_device(session->input);
837 input_get_device(session->input);
843 /* remove HID/input devices from their bus systems */
844 static void hidp_session_dev_del(struct hidp_session *session)
847 hid_destroy_device(session->hid);
848 else if (session->input)
849 input_unregister_device(session->input);
853 * Asynchronous device registration
854 * HID device drivers might want to perform I/O during initialization to
855 * detect device types. Therefore, call device registration in a separate
856 * worker so the HIDP thread can schedule I/O operations.
857 * Note that this must be called after the worker thread was initialized
858 * successfully. This will then add the devices and increase session state
859 * on success, otherwise it will terminate the session thread.
861 static void hidp_session_dev_work(struct work_struct *work)
863 struct hidp_session *session = container_of(work,
868 ret = hidp_session_dev_add(session);
870 atomic_inc(&session->state);
872 hidp_session_terminate(session);
876 * Create new session object
877 * Allocate session object, initialize static fields, copy input data into the
878 * object and take a reference to all sub-objects.
879 * This returns 0 on success and puts a pointer to the new session object in
880 * \out. Otherwise, an error code is returned.
881 * The new session object has an initial ref-count of 1.
883 static int hidp_session_new(struct hidp_session **out, const bdaddr_t *bdaddr,
884 struct socket *ctrl_sock,
885 struct socket *intr_sock,
886 struct hidp_connadd_req *req,
887 struct l2cap_conn *conn)
889 struct hidp_session *session;
891 struct bt_sock *ctrl, *intr;
893 ctrl = bt_sk(ctrl_sock->sk);
894 intr = bt_sk(intr_sock->sk);
896 session = kzalloc(sizeof(*session), GFP_KERNEL);
900 /* object and runtime management */
901 kref_init(&session->ref);
902 atomic_set(&session->state, HIDP_SESSION_IDLING);
903 init_waitqueue_head(&session->state_queue);
904 session->flags = req->flags & (1 << HIDP_BLUETOOTH_VENDOR_ID);
906 /* connection management */
907 bacpy(&session->bdaddr, bdaddr);
908 session->conn = conn;
909 session->user.probe = hidp_session_probe;
910 session->user.remove = hidp_session_remove;
911 session->ctrl_sock = ctrl_sock;
912 session->intr_sock = intr_sock;
913 skb_queue_head_init(&session->ctrl_transmit);
914 skb_queue_head_init(&session->intr_transmit);
915 session->ctrl_mtu = min_t(uint, l2cap_pi(ctrl)->chan->omtu,
916 l2cap_pi(ctrl)->chan->imtu);
917 session->intr_mtu = min_t(uint, l2cap_pi(intr)->chan->omtu,
918 l2cap_pi(intr)->chan->imtu);
919 session->idle_to = req->idle_to;
921 /* device management */
922 INIT_WORK(&session->dev_init, hidp_session_dev_work);
923 setup_timer(&session->timer, hidp_idle_timeout,
924 (unsigned long)session);
927 mutex_init(&session->report_mutex);
928 init_waitqueue_head(&session->report_queue);
930 ret = hidp_session_dev_init(session, req);
934 l2cap_conn_get(session->conn);
935 get_file(session->intr_sock->file);
936 get_file(session->ctrl_sock->file);
945 /* increase ref-count of the given session by one */
946 static void hidp_session_get(struct hidp_session *session)
948 kref_get(&session->ref);
951 /* release callback */
952 static void session_free(struct kref *ref)
954 struct hidp_session *session = container_of(ref, struct hidp_session,
957 hidp_session_dev_destroy(session);
958 skb_queue_purge(&session->ctrl_transmit);
959 skb_queue_purge(&session->intr_transmit);
960 fput(session->intr_sock->file);
961 fput(session->ctrl_sock->file);
962 l2cap_conn_put(session->conn);
966 /* decrease ref-count of the given session by one */
967 static void hidp_session_put(struct hidp_session *session)
969 kref_put(&session->ref, session_free);
973 * Search the list of active sessions for a session with target address
974 * \bdaddr. You must hold at least a read-lock on \hidp_session_sem. As long as
975 * you do not release this lock, the session objects cannot vanish and you can
976 * safely take a reference to the session yourself.
978 static struct hidp_session *__hidp_session_find(const bdaddr_t *bdaddr)
980 struct hidp_session *session;
982 list_for_each_entry(session, &hidp_session_list, list) {
983 if (!bacmp(bdaddr, &session->bdaddr))
991 * Same as __hidp_session_find() but no locks must be held. This also takes a
992 * reference of the returned session (if non-NULL) so you must drop this
993 * reference if you no longer use the object.
995 static struct hidp_session *hidp_session_find(const bdaddr_t *bdaddr)
997 struct hidp_session *session;
999 down_read(&hidp_session_sem);
1001 session = __hidp_session_find(bdaddr);
1003 hidp_session_get(session);
1005 up_read(&hidp_session_sem);
1011 * Start session synchronously
1012 * This starts a session thread and waits until initialization
1013 * is done or returns an error if it couldn't be started.
1014 * If this returns 0 the session thread is up and running. You must call
1015 * hipd_session_stop_sync() before deleting any runtime resources.
1017 static int hidp_session_start_sync(struct hidp_session *session)
1019 unsigned int vendor, product;
1022 vendor = session->hid->vendor;
1023 product = session->hid->product;
1024 } else if (session->input) {
1025 vendor = session->input->id.vendor;
1026 product = session->input->id.product;
1032 session->task = kthread_run(hidp_session_thread, session,
1033 "khidpd_%04x%04x", vendor, product);
1034 if (IS_ERR(session->task))
1035 return PTR_ERR(session->task);
1037 while (atomic_read(&session->state) <= HIDP_SESSION_IDLING)
1038 wait_event(session->state_queue,
1039 atomic_read(&session->state) > HIDP_SESSION_IDLING);
1045 * Terminate session thread
1046 * Wake up session thread and notify it to stop. This is asynchronous and
1047 * returns immediately. Call this whenever a runtime error occurs and you want
1048 * the session to stop.
1049 * Note: wake_up_process() performs any necessary memory-barriers for us.
1051 static void hidp_session_terminate(struct hidp_session *session)
1053 atomic_inc(&session->terminate);
1054 wake_up_process(session->task);
1058 * Probe HIDP session
1059 * This is called from the l2cap_conn core when our l2cap_user object is bound
1060 * to the hci-connection. We get the session via the \user object and can now
1061 * start the session thread, link it into the global session list and
1062 * schedule HID/input device registration.
1063 * The global session-list owns its own reference to the session object so you
1064 * can drop your own reference after registering the l2cap_user object.
1066 static int hidp_session_probe(struct l2cap_conn *conn,
1067 struct l2cap_user *user)
1069 struct hidp_session *session = container_of(user,
1070 struct hidp_session,
1072 struct hidp_session *s;
1075 down_write(&hidp_session_sem);
1077 /* check that no other session for this device exists */
1078 s = __hidp_session_find(&session->bdaddr);
1084 if (session->input) {
1085 ret = hidp_session_dev_add(session);
1090 ret = hidp_session_start_sync(session);
1094 /* HID device registration is async to allow I/O during probe */
1096 atomic_inc(&session->state);
1098 schedule_work(&session->dev_init);
1100 hidp_session_get(session);
1101 list_add(&session->list, &hidp_session_list);
1107 hidp_session_dev_del(session);
1109 up_write(&hidp_session_sem);
1114 * Remove HIDP session
1115 * Called from the l2cap_conn core when either we explicitly unregistered
1116 * the l2cap_user object or if the underlying connection is shut down.
1117 * We signal the hidp-session thread to shut down, unregister the HID/input
1118 * devices and unlink the session from the global list.
1119 * This drops the reference to the session that is owned by the global
1121 * Note: We _must_ not synchronosly wait for the session-thread to shut down.
1122 * This is, because the session-thread might be waiting for an HCI lock that is
1123 * held while we are called. Therefore, we only unregister the devices and
1124 * notify the session-thread to terminate. The thread itself owns a reference
1125 * to the session object so it can safely shut down.
1127 static void hidp_session_remove(struct l2cap_conn *conn,
1128 struct l2cap_user *user)
1130 struct hidp_session *session = container_of(user,
1131 struct hidp_session,
1134 down_write(&hidp_session_sem);
1136 hidp_session_terminate(session);
1138 cancel_work_sync(&session->dev_init);
1139 if (session->input ||
1140 atomic_read(&session->state) > HIDP_SESSION_PREPARING)
1141 hidp_session_dev_del(session);
1143 list_del(&session->list);
1145 up_write(&hidp_session_sem);
1147 hidp_session_put(session);
1152 * This performs the actual main-loop of the HIDP worker. We first check
1153 * whether the underlying connection is still alive, then parse all pending
1154 * messages and finally send all outstanding messages.
1156 static void hidp_session_run(struct hidp_session *session)
1158 struct sock *ctrl_sk = session->ctrl_sock->sk;
1159 struct sock *intr_sk = session->intr_sock->sk;
1160 struct sk_buff *skb;
1164 * This thread can be woken up two ways:
1165 * - You call hidp_session_terminate() which sets the
1166 * session->terminate flag and wakes this thread up.
1167 * - Via modifying the socket state of ctrl/intr_sock. This
1168 * thread is woken up by ->sk_state_changed().
1170 * Note: set_current_state() performs any necessary
1171 * memory-barriers for us.
1173 set_current_state(TASK_INTERRUPTIBLE);
1175 if (atomic_read(&session->terminate))
1178 if (ctrl_sk->sk_state != BT_CONNECTED ||
1179 intr_sk->sk_state != BT_CONNECTED)
1182 /* parse incoming intr-skbs */
1183 while ((skb = skb_dequeue(&intr_sk->sk_receive_queue))) {
1185 if (!skb_linearize(skb))
1186 hidp_recv_intr_frame(session, skb);
1191 /* send pending intr-skbs */
1192 hidp_process_transmit(session, &session->intr_transmit,
1193 session->intr_sock);
1195 /* parse incoming ctrl-skbs */
1196 while ((skb = skb_dequeue(&ctrl_sk->sk_receive_queue))) {
1198 if (!skb_linearize(skb))
1199 hidp_recv_ctrl_frame(session, skb);
1204 /* send pending ctrl-skbs */
1205 hidp_process_transmit(session, &session->ctrl_transmit,
1206 session->ctrl_sock);
1211 atomic_inc(&session->terminate);
1212 set_current_state(TASK_RUNNING);
1216 * HIDP session thread
1217 * This thread runs the I/O for a single HIDP session. Startup is synchronous
1218 * which allows us to take references to ourself here instead of doing that in
1220 * When we are ready to run we notify the caller and call hidp_session_run().
1222 static int hidp_session_thread(void *arg)
1224 struct hidp_session *session = arg;
1225 wait_queue_t ctrl_wait, intr_wait;
1227 BT_DBG("session %p", session);
1229 /* initialize runtime environment */
1230 hidp_session_get(session);
1231 __module_get(THIS_MODULE);
1232 set_user_nice(current, -15);
1233 hidp_set_timer(session);
1235 init_waitqueue_entry(&ctrl_wait, current);
1236 init_waitqueue_entry(&intr_wait, current);
1237 add_wait_queue(sk_sleep(session->ctrl_sock->sk), &ctrl_wait);
1238 add_wait_queue(sk_sleep(session->intr_sock->sk), &intr_wait);
1239 /* This memory barrier is paired with wq_has_sleeper(). See
1240 * sock_poll_wait() for more information why this is needed. */
1243 /* notify synchronous startup that we're ready */
1244 atomic_inc(&session->state);
1245 wake_up(&session->state_queue);
1248 hidp_session_run(session);
1250 /* cleanup runtime environment */
1251 remove_wait_queue(sk_sleep(session->intr_sock->sk), &intr_wait);
1252 remove_wait_queue(sk_sleep(session->intr_sock->sk), &ctrl_wait);
1253 wake_up_interruptible(&session->report_queue);
1254 hidp_del_timer(session);
1257 * If we stopped ourself due to any internal signal, we should try to
1258 * unregister our own session here to avoid having it linger until the
1259 * parent l2cap_conn dies or user-space cleans it up.
1260 * This does not deadlock as we don't do any synchronous shutdown.
1261 * Instead, this call has the same semantics as if user-space tried to
1262 * delete the session.
1264 l2cap_unregister_user(session->conn, &session->user);
1265 hidp_session_put(session);
1267 module_put_and_exit(0);
1271 static int hidp_verify_sockets(struct socket *ctrl_sock,
1272 struct socket *intr_sock)
1274 struct bt_sock *ctrl, *intr;
1275 struct hidp_session *session;
1277 if (!l2cap_is_socket(ctrl_sock) || !l2cap_is_socket(intr_sock))
1280 ctrl = bt_sk(ctrl_sock->sk);
1281 intr = bt_sk(intr_sock->sk);
1283 if (bacmp(&ctrl->src, &intr->src) || bacmp(&ctrl->dst, &intr->dst))
1285 if (ctrl->sk.sk_state != BT_CONNECTED ||
1286 intr->sk.sk_state != BT_CONNECTED)
1289 /* early session check, we check again during session registration */
1290 session = hidp_session_find(&ctrl->dst);
1292 hidp_session_put(session);
1299 int hidp_connection_add(struct hidp_connadd_req *req,
1300 struct socket *ctrl_sock,
1301 struct socket *intr_sock)
1303 struct hidp_session *session;
1304 struct l2cap_conn *conn;
1305 struct l2cap_chan *chan = l2cap_pi(ctrl_sock->sk)->chan;
1308 ret = hidp_verify_sockets(ctrl_sock, intr_sock);
1313 l2cap_chan_lock(chan);
1315 l2cap_conn_get(chan->conn);
1318 l2cap_chan_unlock(chan);
1323 ret = hidp_session_new(&session, &bt_sk(ctrl_sock->sk)->dst, ctrl_sock,
1324 intr_sock, req, conn);
1328 ret = l2cap_register_user(conn, &session->user);
1335 hidp_session_put(session);
1337 l2cap_conn_put(conn);
1341 int hidp_connection_del(struct hidp_conndel_req *req)
1343 struct hidp_session *session;
1345 session = hidp_session_find(&req->bdaddr);
1349 if (req->flags & (1 << HIDP_VIRTUAL_CABLE_UNPLUG))
1350 hidp_send_ctrl_message(session,
1351 HIDP_TRANS_HID_CONTROL |
1352 HIDP_CTRL_VIRTUAL_CABLE_UNPLUG,
1355 l2cap_unregister_user(session->conn, &session->user);
1357 hidp_session_put(session);
1362 int hidp_get_connlist(struct hidp_connlist_req *req)
1364 struct hidp_session *session;
1369 down_read(&hidp_session_sem);
1371 list_for_each_entry(session, &hidp_session_list, list) {
1372 struct hidp_conninfo ci;
1374 hidp_copy_session(session, &ci);
1376 if (copy_to_user(req->ci, &ci, sizeof(ci))) {
1381 if (++n >= req->cnum)
1388 up_read(&hidp_session_sem);
1392 int hidp_get_conninfo(struct hidp_conninfo *ci)
1394 struct hidp_session *session;
1396 session = hidp_session_find(&ci->bdaddr);
1398 hidp_copy_session(session, ci);
1399 hidp_session_put(session);
1402 return session ? 0 : -ENOENT;
1405 static int __init hidp_init(void)
1407 BT_INFO("HIDP (Human Interface Emulation) ver %s", VERSION);
1409 return hidp_init_sockets();
1412 static void __exit hidp_exit(void)
1414 hidp_cleanup_sockets();
1417 module_init(hidp_init);
1418 module_exit(hidp_exit);
1420 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
1421 MODULE_AUTHOR("David Herrmann <dh.herrmann@gmail.com>");
1422 MODULE_DESCRIPTION("Bluetooth HIDP ver " VERSION);
1423 MODULE_VERSION(VERSION);
1424 MODULE_LICENSE("GPL");
1425 MODULE_ALIAS("bt-proto-6");