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 DECLARE_WAIT_QUEUE_HEAD(hidp_session_wq);
40 static LIST_HEAD(hidp_session_list);
42 static unsigned char hidp_keycode[256] = {
43 0, 0, 0, 0, 30, 48, 46, 32, 18, 33, 34, 35, 23, 36,
44 37, 38, 50, 49, 24, 25, 16, 19, 31, 20, 22, 47, 17, 45,
45 21, 44, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 28, 1,
46 14, 15, 57, 12, 13, 26, 27, 43, 43, 39, 40, 41, 51, 52,
47 53, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 87, 88,
48 99, 70, 119, 110, 102, 104, 111, 107, 109, 106, 105, 108, 103, 69,
49 98, 55, 74, 78, 96, 79, 80, 81, 75, 76, 77, 71, 72, 73,
50 82, 83, 86, 127, 116, 117, 183, 184, 185, 186, 187, 188, 189, 190,
51 191, 192, 193, 194, 134, 138, 130, 132, 128, 129, 131, 137, 133, 135,
52 136, 113, 115, 114, 0, 0, 0, 121, 0, 89, 93, 124, 92, 94,
53 95, 0, 0, 0, 122, 123, 90, 91, 85, 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 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
59 29, 42, 56, 125, 97, 54, 100, 126, 164, 166, 165, 163, 161, 115,
60 114, 113, 150, 158, 159, 128, 136, 177, 178, 176, 142, 152, 173, 140
63 static unsigned char hidp_mkeyspat[] = { 0x01, 0x01, 0x01, 0x01, 0x01, 0x01 };
65 static int hidp_session_probe(struct l2cap_conn *conn,
66 struct l2cap_user *user);
67 static void hidp_session_remove(struct l2cap_conn *conn,
68 struct l2cap_user *user);
69 static int hidp_session_thread(void *arg);
70 static void hidp_session_terminate(struct hidp_session *s);
72 static void hidp_copy_session(struct hidp_session *session, struct hidp_conninfo *ci)
75 memset(ci, 0, sizeof(*ci));
76 bacpy(&ci->bdaddr, &session->bdaddr);
78 ci->flags = session->flags & valid_flags;
79 ci->state = BT_CONNECTED;
82 ci->vendor = session->input->id.vendor;
83 ci->product = session->input->id.product;
84 ci->version = session->input->id.version;
85 if (session->input->name)
86 strlcpy(ci->name, session->input->name, 128);
88 strlcpy(ci->name, "HID Boot Device", 128);
89 } else if (session->hid) {
90 ci->vendor = session->hid->vendor;
91 ci->product = session->hid->product;
92 ci->version = session->hid->version;
93 strlcpy(ci->name, session->hid->name, 128);
97 /* assemble skb, queue message on @transmit and wake up the session thread */
98 static int hidp_send_message(struct hidp_session *session, struct socket *sock,
99 struct sk_buff_head *transmit, unsigned char hdr,
100 const unsigned char *data, int size)
103 struct sock *sk = sock->sk;
105 BT_DBG("session %p data %p size %d", session, data, size);
107 if (atomic_read(&session->terminate))
110 skb = alloc_skb(size + 1, GFP_ATOMIC);
112 BT_ERR("Can't allocate memory for new frame");
116 skb_put_u8(skb, hdr);
117 if (data && size > 0)
118 skb_put_data(skb, data, size);
120 skb_queue_tail(transmit, skb);
121 wake_up_interruptible(sk_sleep(sk));
126 static int hidp_send_ctrl_message(struct hidp_session *session,
127 unsigned char hdr, const unsigned char *data,
130 return hidp_send_message(session, session->ctrl_sock,
131 &session->ctrl_transmit, hdr, data, size);
134 static int hidp_send_intr_message(struct hidp_session *session,
135 unsigned char hdr, const unsigned char *data,
138 return hidp_send_message(session, session->intr_sock,
139 &session->intr_transmit, hdr, data, size);
142 static int hidp_input_event(struct input_dev *dev, unsigned int type,
143 unsigned int code, int value)
145 struct hidp_session *session = input_get_drvdata(dev);
146 unsigned char newleds;
147 unsigned char hdr, data[2];
149 BT_DBG("session %p type %d code %d value %d",
150 session, type, code, value);
155 newleds = (!!test_bit(LED_KANA, dev->led) << 3) |
156 (!!test_bit(LED_COMPOSE, dev->led) << 3) |
157 (!!test_bit(LED_SCROLLL, dev->led) << 2) |
158 (!!test_bit(LED_CAPSL, dev->led) << 1) |
159 (!!test_bit(LED_NUML, dev->led) << 0);
161 if (session->leds == newleds)
164 session->leds = newleds;
166 hdr = HIDP_TRANS_DATA | HIDP_DATA_RTYPE_OUPUT;
170 return hidp_send_intr_message(session, hdr, data, 2);
173 static void hidp_input_report(struct hidp_session *session, struct sk_buff *skb)
175 struct input_dev *dev = session->input;
176 unsigned char *keys = session->keys;
177 unsigned char *udata = skb->data + 1;
178 signed char *sdata = skb->data + 1;
179 int i, size = skb->len - 1;
181 switch (skb->data[0]) {
182 case 0x01: /* Keyboard report */
183 for (i = 0; i < 8; i++)
184 input_report_key(dev, hidp_keycode[i + 224], (udata[0] >> i) & 1);
186 /* If all the key codes have been set to 0x01, it means
187 * too many keys were pressed at the same time. */
188 if (!memcmp(udata + 2, hidp_mkeyspat, 6))
191 for (i = 2; i < 8; i++) {
192 if (keys[i] > 3 && memscan(udata + 2, keys[i], 6) == udata + 8) {
193 if (hidp_keycode[keys[i]])
194 input_report_key(dev, hidp_keycode[keys[i]], 0);
196 BT_ERR("Unknown key (scancode %#x) released.", keys[i]);
199 if (udata[i] > 3 && memscan(keys + 2, udata[i], 6) == keys + 8) {
200 if (hidp_keycode[udata[i]])
201 input_report_key(dev, hidp_keycode[udata[i]], 1);
203 BT_ERR("Unknown key (scancode %#x) pressed.", udata[i]);
207 memcpy(keys, udata, 8);
210 case 0x02: /* Mouse report */
211 input_report_key(dev, BTN_LEFT, sdata[0] & 0x01);
212 input_report_key(dev, BTN_RIGHT, sdata[0] & 0x02);
213 input_report_key(dev, BTN_MIDDLE, sdata[0] & 0x04);
214 input_report_key(dev, BTN_SIDE, sdata[0] & 0x08);
215 input_report_key(dev, BTN_EXTRA, sdata[0] & 0x10);
217 input_report_rel(dev, REL_X, sdata[1]);
218 input_report_rel(dev, REL_Y, sdata[2]);
221 input_report_rel(dev, REL_WHEEL, sdata[3]);
228 static int hidp_get_raw_report(struct hid_device *hid,
229 unsigned char report_number,
230 unsigned char *data, size_t count,
231 unsigned char report_type)
233 struct hidp_session *session = hid->driver_data;
236 int numbered_reports = hid->report_enum[report_type].numbered;
239 if (atomic_read(&session->terminate))
242 switch (report_type) {
243 case HID_FEATURE_REPORT:
244 report_type = HIDP_TRANS_GET_REPORT | HIDP_DATA_RTYPE_FEATURE;
246 case HID_INPUT_REPORT:
247 report_type = HIDP_TRANS_GET_REPORT | HIDP_DATA_RTYPE_INPUT;
249 case HID_OUTPUT_REPORT:
250 report_type = HIDP_TRANS_GET_REPORT | HIDP_DATA_RTYPE_OUPUT;
256 if (mutex_lock_interruptible(&session->report_mutex))
259 /* Set up our wait, and send the report request to the device. */
260 session->waiting_report_type = report_type & HIDP_DATA_RTYPE_MASK;
261 session->waiting_report_number = numbered_reports ? report_number : -1;
262 set_bit(HIDP_WAITING_FOR_RETURN, &session->flags);
263 data[0] = report_number;
264 ret = hidp_send_ctrl_message(session, report_type, data, 1);
268 /* Wait for the return of the report. The returned report
269 gets put in session->report_return. */
270 while (test_bit(HIDP_WAITING_FOR_RETURN, &session->flags) &&
271 !atomic_read(&session->terminate)) {
274 res = wait_event_interruptible_timeout(session->report_queue,
275 !test_bit(HIDP_WAITING_FOR_RETURN, &session->flags)
276 || atomic_read(&session->terminate),
290 skb = session->report_return;
292 len = skb->len < count ? skb->len : count;
293 memcpy(data, skb->data, len);
296 session->report_return = NULL;
298 /* Device returned a HANDSHAKE, indicating protocol error. */
302 clear_bit(HIDP_WAITING_FOR_RETURN, &session->flags);
303 mutex_unlock(&session->report_mutex);
308 clear_bit(HIDP_WAITING_FOR_RETURN, &session->flags);
309 mutex_unlock(&session->report_mutex);
313 static int hidp_set_raw_report(struct hid_device *hid, unsigned char reportnum,
314 unsigned char *data, size_t count,
315 unsigned char report_type)
317 struct hidp_session *session = hid->driver_data;
320 switch (report_type) {
321 case HID_FEATURE_REPORT:
322 report_type = HIDP_TRANS_SET_REPORT | HIDP_DATA_RTYPE_FEATURE;
324 case HID_INPUT_REPORT:
325 report_type = HIDP_TRANS_SET_REPORT | HIDP_DATA_RTYPE_INPUT;
327 case HID_OUTPUT_REPORT:
328 report_type = HIDP_TRANS_SET_REPORT | HIDP_DATA_RTYPE_OUPUT;
334 if (mutex_lock_interruptible(&session->report_mutex))
337 /* Set up our wait, and send the report request to the device. */
339 set_bit(HIDP_WAITING_FOR_SEND_ACK, &session->flags);
340 ret = hidp_send_ctrl_message(session, report_type, data, count);
344 /* Wait for the ACK from the device. */
345 while (test_bit(HIDP_WAITING_FOR_SEND_ACK, &session->flags) &&
346 !atomic_read(&session->terminate)) {
349 res = wait_event_interruptible_timeout(session->report_queue,
350 !test_bit(HIDP_WAITING_FOR_SEND_ACK, &session->flags)
351 || atomic_read(&session->terminate),
365 if (!session->output_report_success) {
373 clear_bit(HIDP_WAITING_FOR_SEND_ACK, &session->flags);
374 mutex_unlock(&session->report_mutex);
378 static int hidp_output_report(struct hid_device *hid, __u8 *data, size_t count)
380 struct hidp_session *session = hid->driver_data;
382 return hidp_send_intr_message(session,
383 HIDP_TRANS_DATA | HIDP_DATA_RTYPE_OUPUT,
387 static int hidp_raw_request(struct hid_device *hid, unsigned char reportnum,
388 __u8 *buf, size_t len, unsigned char rtype,
392 case HID_REQ_GET_REPORT:
393 return hidp_get_raw_report(hid, reportnum, buf, len, rtype);
394 case HID_REQ_SET_REPORT:
395 return hidp_set_raw_report(hid, reportnum, buf, len, rtype);
401 static void hidp_idle_timeout(struct timer_list *t)
403 struct hidp_session *session = from_timer(session, t, timer);
405 /* The HIDP user-space API only contains calls to add and remove
406 * devices. There is no way to forward events of any kind. Therefore,
407 * we have to forcefully disconnect a device on idle-timeouts. This is
408 * unfortunate and weird API design, but it is spec-compliant and
409 * required for backwards-compatibility. Hence, on idle-timeout, we
410 * signal driver-detach events, so poll() will be woken up with an
411 * error-condition on both sockets.
414 session->intr_sock->sk->sk_err = EUNATCH;
415 session->ctrl_sock->sk->sk_err = EUNATCH;
416 wake_up_interruptible(sk_sleep(session->intr_sock->sk));
417 wake_up_interruptible(sk_sleep(session->ctrl_sock->sk));
419 hidp_session_terminate(session);
422 static void hidp_set_timer(struct hidp_session *session)
424 if (session->idle_to > 0)
425 mod_timer(&session->timer, jiffies + HZ * session->idle_to);
428 static void hidp_del_timer(struct hidp_session *session)
430 if (session->idle_to > 0)
431 del_timer(&session->timer);
434 static void hidp_process_report(struct hidp_session *session, int type,
435 const u8 *data, unsigned int len, int intr)
437 if (len > HID_MAX_BUFFER_SIZE)
438 len = HID_MAX_BUFFER_SIZE;
440 memcpy(session->input_buf, data, len);
441 hid_input_report(session->hid, type, session->input_buf, len, intr);
444 static void hidp_process_handshake(struct hidp_session *session,
447 BT_DBG("session %p param 0x%02x", session, param);
448 session->output_report_success = 0; /* default condition */
451 case HIDP_HSHK_SUCCESSFUL:
452 /* FIXME: Call into SET_ GET_ handlers here */
453 session->output_report_success = 1;
456 case HIDP_HSHK_NOT_READY:
457 case HIDP_HSHK_ERR_INVALID_REPORT_ID:
458 case HIDP_HSHK_ERR_UNSUPPORTED_REQUEST:
459 case HIDP_HSHK_ERR_INVALID_PARAMETER:
460 if (test_and_clear_bit(HIDP_WAITING_FOR_RETURN, &session->flags))
461 wake_up_interruptible(&session->report_queue);
463 /* FIXME: Call into SET_ GET_ handlers here */
466 case HIDP_HSHK_ERR_UNKNOWN:
469 case HIDP_HSHK_ERR_FATAL:
470 /* Device requests a reboot, as this is the only way this error
471 * can be recovered. */
472 hidp_send_ctrl_message(session,
473 HIDP_TRANS_HID_CONTROL | HIDP_CTRL_SOFT_RESET, NULL, 0);
477 hidp_send_ctrl_message(session,
478 HIDP_TRANS_HANDSHAKE | HIDP_HSHK_ERR_INVALID_PARAMETER, NULL, 0);
482 /* Wake up the waiting thread. */
483 if (test_and_clear_bit(HIDP_WAITING_FOR_SEND_ACK, &session->flags))
484 wake_up_interruptible(&session->report_queue);
487 static void hidp_process_hid_control(struct hidp_session *session,
490 BT_DBG("session %p param 0x%02x", session, param);
492 if (param == HIDP_CTRL_VIRTUAL_CABLE_UNPLUG) {
493 /* Flush the transmit queues */
494 skb_queue_purge(&session->ctrl_transmit);
495 skb_queue_purge(&session->intr_transmit);
497 hidp_session_terminate(session);
501 /* Returns true if the passed-in skb should be freed by the caller. */
502 static int hidp_process_data(struct hidp_session *session, struct sk_buff *skb,
505 int done_with_skb = 1;
506 BT_DBG("session %p skb %p len %d param 0x%02x", session, skb, skb->len, param);
509 case HIDP_DATA_RTYPE_INPUT:
510 hidp_set_timer(session);
513 hidp_input_report(session, skb);
516 hidp_process_report(session, HID_INPUT_REPORT,
517 skb->data, skb->len, 0);
520 case HIDP_DATA_RTYPE_OTHER:
521 case HIDP_DATA_RTYPE_OUPUT:
522 case HIDP_DATA_RTYPE_FEATURE:
526 hidp_send_ctrl_message(session,
527 HIDP_TRANS_HANDSHAKE | HIDP_HSHK_ERR_INVALID_PARAMETER, NULL, 0);
530 if (test_bit(HIDP_WAITING_FOR_RETURN, &session->flags) &&
531 param == session->waiting_report_type) {
532 if (session->waiting_report_number < 0 ||
533 session->waiting_report_number == skb->data[0]) {
534 /* hidp_get_raw_report() is waiting on this report. */
535 session->report_return = skb;
537 clear_bit(HIDP_WAITING_FOR_RETURN, &session->flags);
538 wake_up_interruptible(&session->report_queue);
542 return done_with_skb;
545 static void hidp_recv_ctrl_frame(struct hidp_session *session,
548 unsigned char hdr, type, param;
551 BT_DBG("session %p skb %p len %d", session, skb, skb->len);
556 type = hdr & HIDP_HEADER_TRANS_MASK;
557 param = hdr & HIDP_HEADER_PARAM_MASK;
560 case HIDP_TRANS_HANDSHAKE:
561 hidp_process_handshake(session, param);
564 case HIDP_TRANS_HID_CONTROL:
565 hidp_process_hid_control(session, param);
568 case HIDP_TRANS_DATA:
569 free_skb = hidp_process_data(session, skb, param);
573 hidp_send_ctrl_message(session,
574 HIDP_TRANS_HANDSHAKE | HIDP_HSHK_ERR_UNSUPPORTED_REQUEST, NULL, 0);
582 static void hidp_recv_intr_frame(struct hidp_session *session,
587 BT_DBG("session %p skb %p len %d", session, skb, skb->len);
592 if (hdr == (HIDP_TRANS_DATA | HIDP_DATA_RTYPE_INPUT)) {
593 hidp_set_timer(session);
596 hidp_input_report(session, skb);
599 hidp_process_report(session, HID_INPUT_REPORT,
600 skb->data, skb->len, 1);
601 BT_DBG("report len %d", skb->len);
604 BT_DBG("Unsupported protocol header 0x%02x", hdr);
610 static int hidp_send_frame(struct socket *sock, unsigned char *data, int len)
612 struct kvec iv = { data, len };
615 BT_DBG("sock %p data %p len %d", sock, data, len);
620 memset(&msg, 0, sizeof(msg));
622 return kernel_sendmsg(sock, &msg, &iv, 1, len);
625 /* dequeue message from @transmit and send via @sock */
626 static void hidp_process_transmit(struct hidp_session *session,
627 struct sk_buff_head *transmit,
633 BT_DBG("session %p", session);
635 while ((skb = skb_dequeue(transmit))) {
636 ret = hidp_send_frame(sock, skb->data, skb->len);
637 if (ret == -EAGAIN) {
638 skb_queue_head(transmit, skb);
640 } else if (ret < 0) {
641 hidp_session_terminate(session);
646 hidp_set_timer(session);
651 static int hidp_setup_input(struct hidp_session *session,
652 const struct hidp_connadd_req *req)
654 struct input_dev *input;
657 input = input_allocate_device();
661 session->input = input;
663 input_set_drvdata(input, session);
665 input->name = "Bluetooth HID Boot Protocol Device";
667 input->id.bustype = BUS_BLUETOOTH;
668 input->id.vendor = req->vendor;
669 input->id.product = req->product;
670 input->id.version = req->version;
672 if (req->subclass & 0x40) {
673 set_bit(EV_KEY, input->evbit);
674 set_bit(EV_LED, input->evbit);
675 set_bit(EV_REP, input->evbit);
677 set_bit(LED_NUML, input->ledbit);
678 set_bit(LED_CAPSL, input->ledbit);
679 set_bit(LED_SCROLLL, input->ledbit);
680 set_bit(LED_COMPOSE, input->ledbit);
681 set_bit(LED_KANA, input->ledbit);
683 for (i = 0; i < sizeof(hidp_keycode); i++)
684 set_bit(hidp_keycode[i], input->keybit);
685 clear_bit(0, input->keybit);
688 if (req->subclass & 0x80) {
689 input->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REL);
690 input->keybit[BIT_WORD(BTN_MOUSE)] = BIT_MASK(BTN_LEFT) |
691 BIT_MASK(BTN_RIGHT) | BIT_MASK(BTN_MIDDLE);
692 input->relbit[0] = BIT_MASK(REL_X) | BIT_MASK(REL_Y);
693 input->keybit[BIT_WORD(BTN_MOUSE)] |= BIT_MASK(BTN_SIDE) |
695 input->relbit[0] |= BIT_MASK(REL_WHEEL);
698 input->dev.parent = &session->conn->hcon->dev;
700 input->event = hidp_input_event;
705 static int hidp_open(struct hid_device *hid)
710 static void hidp_close(struct hid_device *hid)
714 static int hidp_parse(struct hid_device *hid)
716 struct hidp_session *session = hid->driver_data;
718 return hid_parse_report(session->hid, session->rd_data,
722 static int hidp_start(struct hid_device *hid)
727 static void hidp_stop(struct hid_device *hid)
729 struct hidp_session *session = hid->driver_data;
731 skb_queue_purge(&session->ctrl_transmit);
732 skb_queue_purge(&session->intr_transmit);
737 struct hid_ll_driver hidp_hid_driver = {
743 .raw_request = hidp_raw_request,
744 .output_report = hidp_output_report,
746 EXPORT_SYMBOL_GPL(hidp_hid_driver);
748 /* This function sets up the hid device. It does not add it
749 to the HID system. That is done in hidp_add_connection(). */
750 static int hidp_setup_hid(struct hidp_session *session,
751 const struct hidp_connadd_req *req)
753 struct hid_device *hid;
756 session->rd_data = memdup_user(req->rd_data, req->rd_size);
757 if (IS_ERR(session->rd_data))
758 return PTR_ERR(session->rd_data);
760 session->rd_size = req->rd_size;
762 hid = hid_allocate_device();
770 hid->driver_data = session;
772 hid->bus = BUS_BLUETOOTH;
773 hid->vendor = req->vendor;
774 hid->product = req->product;
775 hid->version = req->version;
776 hid->country = req->country;
778 strncpy(hid->name, req->name, sizeof(hid->name));
780 snprintf(hid->phys, sizeof(hid->phys), "%pMR",
781 &l2cap_pi(session->ctrl_sock->sk)->chan->src);
783 /* NOTE: Some device modules depend on the dst address being stored in
784 * uniq. Please be aware of this before making changes to this behavior.
786 snprintf(hid->uniq, sizeof(hid->uniq), "%pMR",
787 &l2cap_pi(session->ctrl_sock->sk)->chan->dst);
789 hid->dev.parent = &session->conn->hcon->dev;
790 hid->ll_driver = &hidp_hid_driver;
792 /* True if device is blacklisted in drivers/hid/hid-quirks.c */
793 if (hid_ignore(hid)) {
794 hid_destroy_device(session->hid);
802 kfree(session->rd_data);
803 session->rd_data = NULL;
808 /* initialize session devices */
809 static int hidp_session_dev_init(struct hidp_session *session,
810 const struct hidp_connadd_req *req)
814 if (req->rd_size > 0) {
815 ret = hidp_setup_hid(session, req);
816 if (ret && ret != -ENODEV)
821 ret = hidp_setup_input(session, req);
829 /* destroy session devices */
830 static void hidp_session_dev_destroy(struct hidp_session *session)
833 put_device(&session->hid->dev);
834 else if (session->input)
835 input_put_device(session->input);
837 kfree(session->rd_data);
838 session->rd_data = NULL;
841 /* add HID/input devices to their underlying bus systems */
842 static int hidp_session_dev_add(struct hidp_session *session)
846 /* Both HID and input systems drop a ref-count when unregistering the
847 * device but they don't take a ref-count when registering them. Work
848 * around this by explicitly taking a refcount during registration
849 * which is dropped automatically by unregistering the devices. */
852 ret = hid_add_device(session->hid);
855 get_device(&session->hid->dev);
856 } else if (session->input) {
857 ret = input_register_device(session->input);
860 input_get_device(session->input);
866 /* remove HID/input devices from their bus systems */
867 static void hidp_session_dev_del(struct hidp_session *session)
870 hid_destroy_device(session->hid);
871 else if (session->input)
872 input_unregister_device(session->input);
876 * Asynchronous device registration
877 * HID device drivers might want to perform I/O during initialization to
878 * detect device types. Therefore, call device registration in a separate
879 * worker so the HIDP thread can schedule I/O operations.
880 * Note that this must be called after the worker thread was initialized
881 * successfully. This will then add the devices and increase session state
882 * on success, otherwise it will terminate the session thread.
884 static void hidp_session_dev_work(struct work_struct *work)
886 struct hidp_session *session = container_of(work,
891 ret = hidp_session_dev_add(session);
893 atomic_inc(&session->state);
895 hidp_session_terminate(session);
899 * Create new session object
900 * Allocate session object, initialize static fields, copy input data into the
901 * object and take a reference to all sub-objects.
902 * This returns 0 on success and puts a pointer to the new session object in
903 * \out. Otherwise, an error code is returned.
904 * The new session object has an initial ref-count of 1.
906 static int hidp_session_new(struct hidp_session **out, const bdaddr_t *bdaddr,
907 struct socket *ctrl_sock,
908 struct socket *intr_sock,
909 const struct hidp_connadd_req *req,
910 struct l2cap_conn *conn)
912 struct hidp_session *session;
914 struct bt_sock *ctrl, *intr;
916 ctrl = bt_sk(ctrl_sock->sk);
917 intr = bt_sk(intr_sock->sk);
919 session = kzalloc(sizeof(*session), GFP_KERNEL);
923 /* object and runtime management */
924 kref_init(&session->ref);
925 atomic_set(&session->state, HIDP_SESSION_IDLING);
926 init_waitqueue_head(&session->state_queue);
927 session->flags = req->flags & BIT(HIDP_BLUETOOTH_VENDOR_ID);
929 /* connection management */
930 bacpy(&session->bdaddr, bdaddr);
931 session->conn = l2cap_conn_get(conn);
932 session->user.probe = hidp_session_probe;
933 session->user.remove = hidp_session_remove;
934 INIT_LIST_HEAD(&session->user.list);
935 session->ctrl_sock = ctrl_sock;
936 session->intr_sock = intr_sock;
937 skb_queue_head_init(&session->ctrl_transmit);
938 skb_queue_head_init(&session->intr_transmit);
939 session->ctrl_mtu = min_t(uint, l2cap_pi(ctrl)->chan->omtu,
940 l2cap_pi(ctrl)->chan->imtu);
941 session->intr_mtu = min_t(uint, l2cap_pi(intr)->chan->omtu,
942 l2cap_pi(intr)->chan->imtu);
943 session->idle_to = req->idle_to;
945 /* device management */
946 INIT_WORK(&session->dev_init, hidp_session_dev_work);
947 timer_setup(&session->timer, hidp_idle_timeout, 0);
950 mutex_init(&session->report_mutex);
951 init_waitqueue_head(&session->report_queue);
953 ret = hidp_session_dev_init(session, req);
957 get_file(session->intr_sock->file);
958 get_file(session->ctrl_sock->file);
963 l2cap_conn_put(session->conn);
968 /* increase ref-count of the given session by one */
969 static void hidp_session_get(struct hidp_session *session)
971 kref_get(&session->ref);
974 /* release callback */
975 static void session_free(struct kref *ref)
977 struct hidp_session *session = container_of(ref, struct hidp_session,
980 hidp_session_dev_destroy(session);
981 skb_queue_purge(&session->ctrl_transmit);
982 skb_queue_purge(&session->intr_transmit);
983 fput(session->intr_sock->file);
984 fput(session->ctrl_sock->file);
985 l2cap_conn_put(session->conn);
989 /* decrease ref-count of the given session by one */
990 static void hidp_session_put(struct hidp_session *session)
992 kref_put(&session->ref, session_free);
996 * Search the list of active sessions for a session with target address
997 * \bdaddr. You must hold at least a read-lock on \hidp_session_sem. As long as
998 * you do not release this lock, the session objects cannot vanish and you can
999 * safely take a reference to the session yourself.
1001 static struct hidp_session *__hidp_session_find(const bdaddr_t *bdaddr)
1003 struct hidp_session *session;
1005 list_for_each_entry(session, &hidp_session_list, list) {
1006 if (!bacmp(bdaddr, &session->bdaddr))
1014 * Same as __hidp_session_find() but no locks must be held. This also takes a
1015 * reference of the returned session (if non-NULL) so you must drop this
1016 * reference if you no longer use the object.
1018 static struct hidp_session *hidp_session_find(const bdaddr_t *bdaddr)
1020 struct hidp_session *session;
1022 down_read(&hidp_session_sem);
1024 session = __hidp_session_find(bdaddr);
1026 hidp_session_get(session);
1028 up_read(&hidp_session_sem);
1034 * Start session synchronously
1035 * This starts a session thread and waits until initialization
1036 * is done or returns an error if it couldn't be started.
1037 * If this returns 0 the session thread is up and running. You must call
1038 * hipd_session_stop_sync() before deleting any runtime resources.
1040 static int hidp_session_start_sync(struct hidp_session *session)
1042 unsigned int vendor, product;
1045 vendor = session->hid->vendor;
1046 product = session->hid->product;
1047 } else if (session->input) {
1048 vendor = session->input->id.vendor;
1049 product = session->input->id.product;
1055 session->task = kthread_run(hidp_session_thread, session,
1056 "khidpd_%04x%04x", vendor, product);
1057 if (IS_ERR(session->task))
1058 return PTR_ERR(session->task);
1060 while (atomic_read(&session->state) <= HIDP_SESSION_IDLING)
1061 wait_event(session->state_queue,
1062 atomic_read(&session->state) > HIDP_SESSION_IDLING);
1068 * Terminate session thread
1069 * Wake up session thread and notify it to stop. This is asynchronous and
1070 * returns immediately. Call this whenever a runtime error occurs and you want
1071 * the session to stop.
1072 * Note: wake_up_interruptible() performs any necessary memory-barriers for us.
1074 static void hidp_session_terminate(struct hidp_session *session)
1076 atomic_inc(&session->terminate);
1078 * See the comment preceding the call to wait_woken()
1079 * in hidp_session_run().
1081 wake_up_interruptible(&hidp_session_wq);
1085 * Probe HIDP session
1086 * This is called from the l2cap_conn core when our l2cap_user object is bound
1087 * to the hci-connection. We get the session via the \user object and can now
1088 * start the session thread, link it into the global session list and
1089 * schedule HID/input device registration.
1090 * The global session-list owns its own reference to the session object so you
1091 * can drop your own reference after registering the l2cap_user object.
1093 static int hidp_session_probe(struct l2cap_conn *conn,
1094 struct l2cap_user *user)
1096 struct hidp_session *session = container_of(user,
1097 struct hidp_session,
1099 struct hidp_session *s;
1102 down_write(&hidp_session_sem);
1104 /* check that no other session for this device exists */
1105 s = __hidp_session_find(&session->bdaddr);
1111 if (session->input) {
1112 ret = hidp_session_dev_add(session);
1117 ret = hidp_session_start_sync(session);
1121 /* HID device registration is async to allow I/O during probe */
1123 atomic_inc(&session->state);
1125 schedule_work(&session->dev_init);
1127 hidp_session_get(session);
1128 list_add(&session->list, &hidp_session_list);
1134 hidp_session_dev_del(session);
1136 up_write(&hidp_session_sem);
1141 * Remove HIDP session
1142 * Called from the l2cap_conn core when either we explicitly unregistered
1143 * the l2cap_user object or if the underlying connection is shut down.
1144 * We signal the hidp-session thread to shut down, unregister the HID/input
1145 * devices and unlink the session from the global list.
1146 * This drops the reference to the session that is owned by the global
1148 * Note: We _must_ not synchronosly wait for the session-thread to shut down.
1149 * This is, because the session-thread might be waiting for an HCI lock that is
1150 * held while we are called. Therefore, we only unregister the devices and
1151 * notify the session-thread to terminate. The thread itself owns a reference
1152 * to the session object so it can safely shut down.
1154 static void hidp_session_remove(struct l2cap_conn *conn,
1155 struct l2cap_user *user)
1157 struct hidp_session *session = container_of(user,
1158 struct hidp_session,
1161 down_write(&hidp_session_sem);
1163 hidp_session_terminate(session);
1165 cancel_work_sync(&session->dev_init);
1166 if (session->input ||
1167 atomic_read(&session->state) > HIDP_SESSION_PREPARING)
1168 hidp_session_dev_del(session);
1170 list_del(&session->list);
1172 up_write(&hidp_session_sem);
1174 hidp_session_put(session);
1179 * This performs the actual main-loop of the HIDP worker. We first check
1180 * whether the underlying connection is still alive, then parse all pending
1181 * messages and finally send all outstanding messages.
1183 static void hidp_session_run(struct hidp_session *session)
1185 struct sock *ctrl_sk = session->ctrl_sock->sk;
1186 struct sock *intr_sk = session->intr_sock->sk;
1187 struct sk_buff *skb;
1188 DEFINE_WAIT_FUNC(wait, woken_wake_function);
1190 add_wait_queue(&hidp_session_wq, &wait);
1193 * This thread can be woken up two ways:
1194 * - You call hidp_session_terminate() which sets the
1195 * session->terminate flag and wakes this thread up.
1196 * - Via modifying the socket state of ctrl/intr_sock. This
1197 * thread is woken up by ->sk_state_changed().
1200 if (atomic_read(&session->terminate))
1203 if (ctrl_sk->sk_state != BT_CONNECTED ||
1204 intr_sk->sk_state != BT_CONNECTED)
1207 /* parse incoming intr-skbs */
1208 while ((skb = skb_dequeue(&intr_sk->sk_receive_queue))) {
1210 if (!skb_linearize(skb))
1211 hidp_recv_intr_frame(session, skb);
1216 /* send pending intr-skbs */
1217 hidp_process_transmit(session, &session->intr_transmit,
1218 session->intr_sock);
1220 /* parse incoming ctrl-skbs */
1221 while ((skb = skb_dequeue(&ctrl_sk->sk_receive_queue))) {
1223 if (!skb_linearize(skb))
1224 hidp_recv_ctrl_frame(session, skb);
1229 /* send pending ctrl-skbs */
1230 hidp_process_transmit(session, &session->ctrl_transmit,
1231 session->ctrl_sock);
1234 * wait_woken() performs the necessary memory barriers
1235 * for us; see the header comment for this primitive.
1237 wait_woken(&wait, TASK_INTERRUPTIBLE, MAX_SCHEDULE_TIMEOUT);
1239 remove_wait_queue(&hidp_session_wq, &wait);
1241 atomic_inc(&session->terminate);
1244 static int hidp_session_wake_function(wait_queue_entry_t *wait,
1246 int sync, void *key)
1248 wake_up_interruptible(&hidp_session_wq);
1253 * HIDP session thread
1254 * This thread runs the I/O for a single HIDP session. Startup is synchronous
1255 * which allows us to take references to ourself here instead of doing that in
1257 * When we are ready to run we notify the caller and call hidp_session_run().
1259 static int hidp_session_thread(void *arg)
1261 struct hidp_session *session = arg;
1262 DEFINE_WAIT_FUNC(ctrl_wait, hidp_session_wake_function);
1263 DEFINE_WAIT_FUNC(intr_wait, hidp_session_wake_function);
1265 BT_DBG("session %p", session);
1267 /* initialize runtime environment */
1268 hidp_session_get(session);
1269 __module_get(THIS_MODULE);
1270 set_user_nice(current, -15);
1271 hidp_set_timer(session);
1273 add_wait_queue(sk_sleep(session->ctrl_sock->sk), &ctrl_wait);
1274 add_wait_queue(sk_sleep(session->intr_sock->sk), &intr_wait);
1275 /* This memory barrier is paired with wq_has_sleeper(). See
1276 * sock_poll_wait() for more information why this is needed. */
1279 /* notify synchronous startup that we're ready */
1280 atomic_inc(&session->state);
1281 wake_up(&session->state_queue);
1284 hidp_session_run(session);
1286 /* cleanup runtime environment */
1287 remove_wait_queue(sk_sleep(session->intr_sock->sk), &intr_wait);
1288 remove_wait_queue(sk_sleep(session->intr_sock->sk), &ctrl_wait);
1289 wake_up_interruptible(&session->report_queue);
1290 hidp_del_timer(session);
1293 * If we stopped ourself due to any internal signal, we should try to
1294 * unregister our own session here to avoid having it linger until the
1295 * parent l2cap_conn dies or user-space cleans it up.
1296 * This does not deadlock as we don't do any synchronous shutdown.
1297 * Instead, this call has the same semantics as if user-space tried to
1298 * delete the session.
1300 l2cap_unregister_user(session->conn, &session->user);
1301 hidp_session_put(session);
1303 module_put_and_exit(0);
1307 static int hidp_verify_sockets(struct socket *ctrl_sock,
1308 struct socket *intr_sock)
1310 struct l2cap_chan *ctrl_chan, *intr_chan;
1311 struct bt_sock *ctrl, *intr;
1312 struct hidp_session *session;
1314 if (!l2cap_is_socket(ctrl_sock) || !l2cap_is_socket(intr_sock))
1317 ctrl_chan = l2cap_pi(ctrl_sock->sk)->chan;
1318 intr_chan = l2cap_pi(intr_sock->sk)->chan;
1320 if (bacmp(&ctrl_chan->src, &intr_chan->src) ||
1321 bacmp(&ctrl_chan->dst, &intr_chan->dst))
1324 ctrl = bt_sk(ctrl_sock->sk);
1325 intr = bt_sk(intr_sock->sk);
1327 if (ctrl->sk.sk_state != BT_CONNECTED ||
1328 intr->sk.sk_state != BT_CONNECTED)
1331 /* early session check, we check again during session registration */
1332 session = hidp_session_find(&ctrl_chan->dst);
1334 hidp_session_put(session);
1341 int hidp_connection_add(const struct hidp_connadd_req *req,
1342 struct socket *ctrl_sock,
1343 struct socket *intr_sock)
1345 u32 valid_flags = BIT(HIDP_VIRTUAL_CABLE_UNPLUG) |
1346 BIT(HIDP_BOOT_PROTOCOL_MODE);
1347 struct hidp_session *session;
1348 struct l2cap_conn *conn;
1349 struct l2cap_chan *chan;
1352 ret = hidp_verify_sockets(ctrl_sock, intr_sock);
1356 if (req->flags & ~valid_flags)
1359 chan = l2cap_pi(ctrl_sock->sk)->chan;
1361 l2cap_chan_lock(chan);
1363 conn = l2cap_conn_get(chan->conn);
1364 l2cap_chan_unlock(chan);
1369 ret = hidp_session_new(&session, &chan->dst, ctrl_sock,
1370 intr_sock, req, conn);
1374 ret = l2cap_register_user(conn, &session->user);
1381 hidp_session_put(session);
1383 l2cap_conn_put(conn);
1387 int hidp_connection_del(struct hidp_conndel_req *req)
1389 u32 valid_flags = BIT(HIDP_VIRTUAL_CABLE_UNPLUG);
1390 struct hidp_session *session;
1392 if (req->flags & ~valid_flags)
1395 session = hidp_session_find(&req->bdaddr);
1399 if (req->flags & BIT(HIDP_VIRTUAL_CABLE_UNPLUG))
1400 hidp_send_ctrl_message(session,
1401 HIDP_TRANS_HID_CONTROL |
1402 HIDP_CTRL_VIRTUAL_CABLE_UNPLUG,
1405 l2cap_unregister_user(session->conn, &session->user);
1407 hidp_session_put(session);
1412 int hidp_get_connlist(struct hidp_connlist_req *req)
1414 struct hidp_session *session;
1419 down_read(&hidp_session_sem);
1421 list_for_each_entry(session, &hidp_session_list, list) {
1422 struct hidp_conninfo ci;
1424 hidp_copy_session(session, &ci);
1426 if (copy_to_user(req->ci, &ci, sizeof(ci))) {
1431 if (++n >= req->cnum)
1438 up_read(&hidp_session_sem);
1442 int hidp_get_conninfo(struct hidp_conninfo *ci)
1444 struct hidp_session *session;
1446 session = hidp_session_find(&ci->bdaddr);
1448 hidp_copy_session(session, ci);
1449 hidp_session_put(session);
1452 return session ? 0 : -ENOENT;
1455 static int __init hidp_init(void)
1457 BT_INFO("HIDP (Human Interface Emulation) ver %s", VERSION);
1459 return hidp_init_sockets();
1462 static void __exit hidp_exit(void)
1464 hidp_cleanup_sockets();
1467 module_init(hidp_init);
1468 module_exit(hidp_exit);
1470 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
1471 MODULE_AUTHOR("David Herrmann <dh.herrmann@gmail.com>");
1472 MODULE_DESCRIPTION("Bluetooth HIDP ver " VERSION);
1473 MODULE_VERSION(VERSION);
1474 MODULE_LICENSE("GPL");
1475 MODULE_ALIAS("bt-proto-6");