3 * Bluetooth HCI UART driver
5 * Copyright (C) 2000-2001 Qualcomm Incorporated
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
26 #include <linux/module.h>
28 #include <linux/kernel.h>
29 #include <linux/init.h>
30 #include <linux/types.h>
31 #include <linux/fcntl.h>
32 #include <linux/interrupt.h>
33 #include <linux/ptrace.h>
34 #include <linux/poll.h>
36 #include <linux/slab.h>
37 #include <linux/tty.h>
38 #include <linux/errno.h>
39 #include <linux/string.h>
40 #include <linux/signal.h>
41 #include <linux/ioctl.h>
42 #include <linux/skbuff.h>
44 #include <net/bluetooth/bluetooth.h>
45 #include <net/bluetooth/hci_core.h>
53 static const struct hci_uart_proto *hup[HCI_UART_MAX_PROTO];
55 int hci_uart_register_proto(const struct hci_uart_proto *p)
57 if (p->id >= HCI_UART_MAX_PROTO)
65 BT_INFO("HCI UART protocol %s registered", p->name);
70 int hci_uart_unregister_proto(const struct hci_uart_proto *p)
72 if (p->id >= HCI_UART_MAX_PROTO)
83 static const struct hci_uart_proto *hci_uart_get_proto(unsigned int id)
85 if (id >= HCI_UART_MAX_PROTO)
91 static inline void hci_uart_tx_complete(struct hci_uart *hu, int pkt_type)
93 struct hci_dev *hdev = hu->hdev;
95 /* Update HCI stat counters */
101 case HCI_ACLDATA_PKT:
105 case HCI_SCODATA_PKT:
111 static inline struct sk_buff *hci_uart_dequeue(struct hci_uart *hu)
113 struct sk_buff *skb = hu->tx_skb;
116 skb = hu->proto->dequeue(hu);
123 int hci_uart_tx_wakeup(struct hci_uart *hu)
125 if (test_and_set_bit(HCI_UART_SENDING, &hu->tx_state)) {
126 set_bit(HCI_UART_TX_WAKEUP, &hu->tx_state);
132 schedule_work(&hu->write_work);
137 static void hci_uart_write_work(struct work_struct *work)
139 struct hci_uart *hu = container_of(work, struct hci_uart, write_work);
140 struct tty_struct *tty = hu->tty;
141 struct hci_dev *hdev = hu->hdev;
144 /* REVISIT: should we cope with bad skbs or ->write() returning
149 clear_bit(HCI_UART_TX_WAKEUP, &hu->tx_state);
151 while ((skb = hci_uart_dequeue(hu))) {
154 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
155 len = tty->ops->write(tty, skb->data, skb->len);
156 hdev->stat.byte_tx += len;
164 hci_uart_tx_complete(hu, bt_cb(skb)->pkt_type);
168 if (test_bit(HCI_UART_TX_WAKEUP, &hu->tx_state))
171 clear_bit(HCI_UART_SENDING, &hu->tx_state);
174 static void hci_uart_init_work(struct work_struct *work)
176 struct hci_uart *hu = container_of(work, struct hci_uart, init_ready);
179 if (!test_and_clear_bit(HCI_UART_INIT_PENDING, &hu->hdev_flags))
182 err = hci_register_dev(hu->hdev);
184 BT_ERR("Can't register HCI device");
185 hci_free_dev(hu->hdev);
187 hu->proto->close(hu);
190 set_bit(HCI_UART_REGISTERED, &hu->flags);
193 int hci_uart_init_ready(struct hci_uart *hu)
195 if (!test_bit(HCI_UART_INIT_PENDING, &hu->hdev_flags))
198 schedule_work(&hu->init_ready);
203 /* ------- Interface to HCI layer ------ */
204 /* Initialize device */
205 static int hci_uart_open(struct hci_dev *hdev)
207 BT_DBG("%s %p", hdev->name, hdev);
209 /* Nothing to do for UART driver */
211 set_bit(HCI_RUNNING, &hdev->flags);
217 static int hci_uart_flush(struct hci_dev *hdev)
219 struct hci_uart *hu = hci_get_drvdata(hdev);
220 struct tty_struct *tty = hu->tty;
222 BT_DBG("hdev %p tty %p", hdev, tty);
225 kfree_skb(hu->tx_skb); hu->tx_skb = NULL;
228 /* Flush any pending characters in the driver and discipline. */
229 tty_ldisc_flush(tty);
230 tty_driver_flush_buffer(tty);
232 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
233 hu->proto->flush(hu);
239 static int hci_uart_close(struct hci_dev *hdev)
241 BT_DBG("hdev %p", hdev);
243 if (!test_and_clear_bit(HCI_RUNNING, &hdev->flags))
246 hci_uart_flush(hdev);
251 /* Send frames from HCI layer */
252 static int hci_uart_send_frame(struct hci_dev *hdev, struct sk_buff *skb)
254 struct hci_uart *hu = hci_get_drvdata(hdev);
256 if (!test_bit(HCI_RUNNING, &hdev->flags))
259 BT_DBG("%s: type %d len %d", hdev->name, bt_cb(skb)->pkt_type, skb->len);
261 hu->proto->enqueue(hu, skb);
263 hci_uart_tx_wakeup(hu);
268 static int hci_uart_setup(struct hci_dev *hdev)
270 struct hci_uart *hu = hci_get_drvdata(hdev);
271 struct hci_rp_read_local_version *ver;
274 if (hu->proto->setup)
275 return hu->proto->setup(hu);
277 if (!test_bit(HCI_UART_VND_DETECT, &hu->hdev_flags))
280 skb = __hci_cmd_sync(hdev, HCI_OP_READ_LOCAL_VERSION, 0, NULL,
283 BT_ERR("%s: Reading local version information failed (%ld)",
284 hdev->name, PTR_ERR(skb));
288 if (skb->len != sizeof(*ver)) {
289 BT_ERR("%s: Event length mismatch for version information",
294 ver = (struct hci_rp_read_local_version *)skb->data;
296 switch (le16_to_cpu(ver->manufacturer)) {
297 #ifdef CONFIG_BT_HCIUART_INTEL
299 hdev->set_bdaddr = btintel_set_bdaddr;
300 btintel_check_bdaddr(hdev);
303 #ifdef CONFIG_BT_HCIUART_BCM
305 hdev->set_bdaddr = btbcm_set_bdaddr;
306 btbcm_check_bdaddr(hdev);
316 /* ------ LDISC part ------ */
319 * Called when line discipline changed to HCI_UART.
322 * tty pointer to tty info structure
324 * 0 if success, otherwise error code
326 static int hci_uart_tty_open(struct tty_struct *tty)
330 BT_DBG("tty %p", tty);
332 /* Error if the tty has no write op instead of leaving an exploitable
334 if (tty->ops->write == NULL)
337 hu = kzalloc(sizeof(struct hci_uart), GFP_KERNEL);
339 BT_ERR("Can't allocate control structure");
345 tty->receive_room = 65536;
347 INIT_WORK(&hu->init_ready, hci_uart_init_work);
348 INIT_WORK(&hu->write_work, hci_uart_write_work);
350 spin_lock_init(&hu->rx_lock);
352 /* Flush any pending characters in the driver and line discipline. */
354 /* FIXME: why is this needed. Note don't use ldisc_ref here as the
355 open path is before the ldisc is referencable */
357 if (tty->ldisc->ops->flush_buffer)
358 tty->ldisc->ops->flush_buffer(tty);
359 tty_driver_flush_buffer(tty);
364 /* hci_uart_tty_close()
366 * Called when the line discipline is changed to something
367 * else, the tty is closed, or the tty detects a hangup.
369 static void hci_uart_tty_close(struct tty_struct *tty)
371 struct hci_uart *hu = tty->disc_data;
372 struct hci_dev *hdev;
374 BT_DBG("tty %p", tty);
376 /* Detach from the tty */
377 tty->disc_data = NULL;
384 hci_uart_close(hdev);
386 cancel_work_sync(&hu->write_work);
388 if (test_and_clear_bit(HCI_UART_PROTO_SET, &hu->flags)) {
390 if (test_bit(HCI_UART_REGISTERED, &hu->flags))
391 hci_unregister_dev(hdev);
394 hu->proto->close(hu);
400 /* hci_uart_tty_wakeup()
402 * Callback for transmit wakeup. Called when low level
403 * device driver can accept more send data.
405 * Arguments: tty pointer to associated tty instance data
408 static void hci_uart_tty_wakeup(struct tty_struct *tty)
410 struct hci_uart *hu = tty->disc_data;
417 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
422 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
423 hci_uart_tx_wakeup(hu);
426 /* hci_uart_tty_receive()
428 * Called by tty low level driver when receive data is
431 * Arguments: tty pointer to tty isntance data
432 * data pointer to received data
433 * flags pointer to flags for data
434 * count count of received data in bytes
438 static void hci_uart_tty_receive(struct tty_struct *tty, const u8 *data,
439 char *flags, int count)
441 struct hci_uart *hu = tty->disc_data;
443 if (!hu || tty != hu->tty)
446 if (!test_bit(HCI_UART_PROTO_SET, &hu->flags))
449 spin_lock(&hu->rx_lock);
450 hu->proto->recv(hu, data, count);
453 hu->hdev->stat.byte_rx += count;
455 spin_unlock(&hu->rx_lock);
460 static int hci_uart_register_dev(struct hci_uart *hu)
462 struct hci_dev *hdev;
466 /* Initialize and register HCI device */
467 hdev = hci_alloc_dev();
469 BT_ERR("Can't allocate HCI device");
475 hdev->bus = HCI_UART;
476 hci_set_drvdata(hdev, hu);
478 hdev->open = hci_uart_open;
479 hdev->close = hci_uart_close;
480 hdev->flush = hci_uart_flush;
481 hdev->send = hci_uart_send_frame;
482 hdev->setup = hci_uart_setup;
483 SET_HCIDEV_DEV(hdev, hu->tty->dev);
485 if (test_bit(HCI_UART_RAW_DEVICE, &hu->hdev_flags))
486 set_bit(HCI_QUIRK_RAW_DEVICE, &hdev->quirks);
488 if (test_bit(HCI_UART_EXT_CONFIG, &hu->hdev_flags))
489 set_bit(HCI_QUIRK_EXTERNAL_CONFIG, &hdev->quirks);
491 if (!test_bit(HCI_UART_RESET_ON_INIT, &hu->hdev_flags))
492 set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
494 if (test_bit(HCI_UART_CREATE_AMP, &hu->hdev_flags))
495 hdev->dev_type = HCI_AMP;
497 hdev->dev_type = HCI_BREDR;
499 if (test_bit(HCI_UART_INIT_PENDING, &hu->hdev_flags))
502 if (hci_register_dev(hdev) < 0) {
503 BT_ERR("Can't register HCI device");
508 set_bit(HCI_UART_REGISTERED, &hu->flags);
513 static int hci_uart_set_proto(struct hci_uart *hu, int id)
515 const struct hci_uart_proto *p;
518 p = hci_uart_get_proto(id);
520 return -EPROTONOSUPPORT;
528 err = hci_uart_register_dev(hu);
537 static int hci_uart_set_flags(struct hci_uart *hu, unsigned long flags)
539 unsigned long valid_flags = BIT(HCI_UART_RAW_DEVICE) |
540 BIT(HCI_UART_RESET_ON_INIT) |
541 BIT(HCI_UART_CREATE_AMP) |
542 BIT(HCI_UART_INIT_PENDING) |
543 BIT(HCI_UART_EXT_CONFIG) |
544 BIT(HCI_UART_VND_DETECT);
546 if (flags & ~valid_flags)
549 hu->hdev_flags = flags;
554 /* hci_uart_tty_ioctl()
556 * Process IOCTL system call for the tty device.
560 * tty pointer to tty instance data
561 * file pointer to open file object for device
562 * cmd IOCTL command code
563 * arg argument for IOCTL call (cmd dependent)
565 * Return Value: Command dependent
567 static int hci_uart_tty_ioctl(struct tty_struct *tty, struct file *file,
568 unsigned int cmd, unsigned long arg)
570 struct hci_uart *hu = tty->disc_data;
575 /* Verify the status of the device */
580 case HCIUARTSETPROTO:
581 if (!test_and_set_bit(HCI_UART_PROTO_SET, &hu->flags)) {
582 err = hci_uart_set_proto(hu, arg);
584 clear_bit(HCI_UART_PROTO_SET, &hu->flags);
591 case HCIUARTGETPROTO:
592 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
593 return hu->proto->id;
596 case HCIUARTGETDEVICE:
597 if (test_bit(HCI_UART_REGISTERED, &hu->flags))
601 case HCIUARTSETFLAGS:
602 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
604 err = hci_uart_set_flags(hu, arg);
609 case HCIUARTGETFLAGS:
610 return hu->hdev_flags;
613 err = n_tty_ioctl_helper(tty, file, cmd, arg);
621 * We don't provide read/write/poll interface for user space.
623 static ssize_t hci_uart_tty_read(struct tty_struct *tty, struct file *file,
624 unsigned char __user *buf, size_t nr)
629 static ssize_t hci_uart_tty_write(struct tty_struct *tty, struct file *file,
630 const unsigned char *data, size_t count)
635 static unsigned int hci_uart_tty_poll(struct tty_struct *tty,
636 struct file *filp, poll_table *wait)
641 static int __init hci_uart_init(void)
643 static struct tty_ldisc_ops hci_uart_ldisc;
646 BT_INFO("HCI UART driver ver %s", VERSION);
648 /* Register the tty discipline */
650 memset(&hci_uart_ldisc, 0, sizeof (hci_uart_ldisc));
651 hci_uart_ldisc.magic = TTY_LDISC_MAGIC;
652 hci_uart_ldisc.name = "n_hci";
653 hci_uart_ldisc.open = hci_uart_tty_open;
654 hci_uart_ldisc.close = hci_uart_tty_close;
655 hci_uart_ldisc.read = hci_uart_tty_read;
656 hci_uart_ldisc.write = hci_uart_tty_write;
657 hci_uart_ldisc.ioctl = hci_uart_tty_ioctl;
658 hci_uart_ldisc.poll = hci_uart_tty_poll;
659 hci_uart_ldisc.receive_buf = hci_uart_tty_receive;
660 hci_uart_ldisc.write_wakeup = hci_uart_tty_wakeup;
661 hci_uart_ldisc.owner = THIS_MODULE;
663 err = tty_register_ldisc(N_HCI, &hci_uart_ldisc);
665 BT_ERR("HCI line discipline registration failed. (%d)", err);
669 #ifdef CONFIG_BT_HCIUART_H4
672 #ifdef CONFIG_BT_HCIUART_BCSP
675 #ifdef CONFIG_BT_HCIUART_LL
678 #ifdef CONFIG_BT_HCIUART_ATH3K
681 #ifdef CONFIG_BT_HCIUART_3WIRE
684 #ifdef CONFIG_BT_HCIUART_BCM
691 static void __exit hci_uart_exit(void)
695 #ifdef CONFIG_BT_HCIUART_H4
698 #ifdef CONFIG_BT_HCIUART_BCSP
701 #ifdef CONFIG_BT_HCIUART_LL
704 #ifdef CONFIG_BT_HCIUART_ATH3K
707 #ifdef CONFIG_BT_HCIUART_3WIRE
710 #ifdef CONFIG_BT_HCIUART_BCM
714 /* Release tty registration of line discipline */
715 err = tty_unregister_ldisc(N_HCI);
717 BT_ERR("Can't unregister HCI line discipline (%d)", err);
720 module_init(hci_uart_init);
721 module_exit(hci_uart_exit);
724 MODULE_DESCRIPTION("Bluetooth HCI UART driver ver " VERSION);
725 MODULE_VERSION(VERSION);
726 MODULE_LICENSE("GPL");
727 MODULE_ALIAS_LDISC(N_HCI);