3 * Bluetooth HCI UART driver
5 * Copyright (C) 2000-2001 Qualcomm Incorporated
6 * Copyright (C) 2002-2003 Maxim Krasnyansky <maxk@qualcomm.com>
7 * Copyright (C) 2004-2005 Marcel Holtmann <marcel@holtmann.org>
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>
43 #include <linux/firmware.h>
45 #include <net/bluetooth/bluetooth.h>
46 #include <net/bluetooth/hci_core.h>
54 static const struct hci_uart_proto *hup[HCI_UART_MAX_PROTO];
56 int hci_uart_register_proto(const struct hci_uart_proto *p)
58 if (p->id >= HCI_UART_MAX_PROTO)
66 BT_INFO("HCI UART protocol %s registered", p->name);
71 int hci_uart_unregister_proto(const struct hci_uart_proto *p)
73 if (p->id >= HCI_UART_MAX_PROTO)
84 static const struct hci_uart_proto *hci_uart_get_proto(unsigned int id)
86 if (id >= HCI_UART_MAX_PROTO)
92 static inline void hci_uart_tx_complete(struct hci_uart *hu, int pkt_type)
94 struct hci_dev *hdev = hu->hdev;
96 /* Update HCI stat counters */
102 case HCI_ACLDATA_PKT:
106 case HCI_SCODATA_PKT:
112 static inline struct sk_buff *hci_uart_dequeue(struct hci_uart *hu)
114 struct sk_buff *skb = hu->tx_skb;
117 if (test_bit(HCI_UART_PROTO_READY, &hu->flags))
118 skb = hu->proto->dequeue(hu);
126 int hci_uart_tx_wakeup(struct hci_uart *hu)
128 if (!test_bit(HCI_UART_PROTO_READY, &hu->flags))
131 if (test_and_set_bit(HCI_UART_SENDING, &hu->tx_state)) {
132 set_bit(HCI_UART_TX_WAKEUP, &hu->tx_state);
138 schedule_work(&hu->write_work);
142 EXPORT_SYMBOL_GPL(hci_uart_tx_wakeup);
144 static void hci_uart_write_work(struct work_struct *work)
146 struct hci_uart *hu = container_of(work, struct hci_uart, write_work);
147 struct tty_struct *tty = hu->tty;
148 struct hci_dev *hdev = hu->hdev;
151 /* REVISIT: should we cope with bad skbs or ->write() returning
156 clear_bit(HCI_UART_TX_WAKEUP, &hu->tx_state);
158 while ((skb = hci_uart_dequeue(hu))) {
161 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
162 len = tty->ops->write(tty, skb->data, skb->len);
163 hdev->stat.byte_tx += len;
171 hci_uart_tx_complete(hu, hci_skb_pkt_type(skb));
175 if (test_bit(HCI_UART_TX_WAKEUP, &hu->tx_state))
178 clear_bit(HCI_UART_SENDING, &hu->tx_state);
181 static void hci_uart_init_work(struct work_struct *work)
183 struct hci_uart *hu = container_of(work, struct hci_uart, init_ready);
185 struct hci_dev *hdev;
187 if (!test_and_clear_bit(HCI_UART_INIT_PENDING, &hu->hdev_flags))
190 err = hci_register_dev(hu->hdev);
192 BT_ERR("Can't register HCI device");
196 clear_bit(HCI_UART_PROTO_READY, &hu->flags);
197 hu->proto->close(hu);
201 set_bit(HCI_UART_REGISTERED, &hu->flags);
204 int hci_uart_init_ready(struct hci_uart *hu)
206 if (!test_bit(HCI_UART_INIT_PENDING, &hu->hdev_flags))
209 schedule_work(&hu->init_ready);
214 /* ------- Interface to HCI layer ------ */
215 /* Initialize device */
216 static int hci_uart_open(struct hci_dev *hdev)
218 BT_DBG("%s %p", hdev->name, hdev);
220 /* Nothing to do for UART driver */
225 static int hci_uart_flush(struct hci_dev *hdev)
227 struct hci_uart *hu = hci_get_drvdata(hdev);
228 struct tty_struct *tty = hu->tty;
230 BT_DBG("hdev %p tty %p", hdev, tty);
233 kfree_skb(hu->tx_skb); hu->tx_skb = NULL;
236 /* Flush any pending characters in the driver and discipline. */
237 tty_ldisc_flush(tty);
238 tty_driver_flush_buffer(tty);
240 if (test_bit(HCI_UART_PROTO_READY, &hu->flags))
241 hu->proto->flush(hu);
247 static int hci_uart_close(struct hci_dev *hdev)
249 BT_DBG("hdev %p", hdev);
251 hci_uart_flush(hdev);
256 /* Send frames from HCI layer */
257 static int hci_uart_send_frame(struct hci_dev *hdev, struct sk_buff *skb)
259 struct hci_uart *hu = hci_get_drvdata(hdev);
261 BT_DBG("%s: type %d len %d", hdev->name, hci_skb_pkt_type(skb),
264 if (!test_bit(HCI_UART_PROTO_READY, &hu->flags))
267 hu->proto->enqueue(hu, skb);
269 hci_uart_tx_wakeup(hu);
274 /* Flow control or un-flow control the device */
275 void hci_uart_set_flow_control(struct hci_uart *hu, bool enable)
277 struct tty_struct *tty = hu->tty;
278 struct ktermios ktermios;
280 unsigned int set = 0;
281 unsigned int clear = 0;
284 /* Disable hardware flow control */
285 ktermios = tty->termios;
286 ktermios.c_cflag &= ~CRTSCTS;
287 status = tty_set_termios(tty, &ktermios);
288 BT_DBG("Disabling hardware flow control: %s",
289 status ? "failed" : "success");
291 /* Clear RTS to prevent the device from sending */
292 /* Most UARTs need OUT2 to enable interrupts */
293 status = tty->driver->ops->tiocmget(tty);
294 BT_DBG("Current tiocm 0x%x", status);
296 set &= ~(TIOCM_OUT2 | TIOCM_RTS);
298 set &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
299 TIOCM_OUT2 | TIOCM_LOOP;
300 clear &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
301 TIOCM_OUT2 | TIOCM_LOOP;
302 status = tty->driver->ops->tiocmset(tty, set, clear);
303 BT_DBG("Clearing RTS: %s", status ? "failed" : "success");
305 /* Set RTS to allow the device to send again */
306 status = tty->driver->ops->tiocmget(tty);
307 BT_DBG("Current tiocm 0x%x", status);
309 set |= (TIOCM_OUT2 | TIOCM_RTS);
311 set &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
312 TIOCM_OUT2 | TIOCM_LOOP;
313 clear &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
314 TIOCM_OUT2 | TIOCM_LOOP;
315 status = tty->driver->ops->tiocmset(tty, set, clear);
316 BT_DBG("Setting RTS: %s", status ? "failed" : "success");
318 /* Re-enable hardware flow control */
319 ktermios = tty->termios;
320 ktermios.c_cflag |= CRTSCTS;
321 status = tty_set_termios(tty, &ktermios);
322 BT_DBG("Enabling hardware flow control: %s",
323 status ? "failed" : "success");
327 void hci_uart_set_speeds(struct hci_uart *hu, unsigned int init_speed,
328 unsigned int oper_speed)
330 hu->init_speed = init_speed;
331 hu->oper_speed = oper_speed;
334 void hci_uart_set_baudrate(struct hci_uart *hu, unsigned int speed)
336 struct tty_struct *tty = hu->tty;
337 struct ktermios ktermios;
339 ktermios = tty->termios;
340 ktermios.c_cflag &= ~CBAUD;
341 tty_termios_encode_baud_rate(&ktermios, speed, speed);
343 /* tty_set_termios() return not checked as it is always 0 */
344 tty_set_termios(tty, &ktermios);
346 BT_DBG("%s: New tty speeds: %d/%d", hu->hdev->name,
347 tty->termios.c_ispeed, tty->termios.c_ospeed);
350 static int hci_uart_setup(struct hci_dev *hdev)
352 struct hci_uart *hu = hci_get_drvdata(hdev);
353 struct hci_rp_read_local_version *ver;
358 /* Init speed if any */
360 speed = hu->init_speed;
361 else if (hu->proto->init_speed)
362 speed = hu->proto->init_speed;
367 hci_uart_set_baudrate(hu, speed);
369 /* Operational speed if any */
371 speed = hu->oper_speed;
372 else if (hu->proto->oper_speed)
373 speed = hu->proto->oper_speed;
377 if (hu->proto->set_baudrate && speed) {
378 err = hu->proto->set_baudrate(hu, speed);
380 hci_uart_set_baudrate(hu, speed);
383 if (hu->proto->setup)
384 return hu->proto->setup(hu);
386 if (!test_bit(HCI_UART_VND_DETECT, &hu->hdev_flags))
389 skb = __hci_cmd_sync(hdev, HCI_OP_READ_LOCAL_VERSION, 0, NULL,
392 BT_ERR("%s: Reading local version information failed (%ld)",
393 hdev->name, PTR_ERR(skb));
397 if (skb->len != sizeof(*ver)) {
398 BT_ERR("%s: Event length mismatch for version information",
403 ver = (struct hci_rp_read_local_version *)skb->data;
405 switch (le16_to_cpu(ver->manufacturer)) {
406 #ifdef CONFIG_BT_HCIUART_INTEL
408 hdev->set_bdaddr = btintel_set_bdaddr;
409 btintel_check_bdaddr(hdev);
412 #ifdef CONFIG_BT_HCIUART_BCM
414 hdev->set_bdaddr = btbcm_set_bdaddr;
415 btbcm_check_bdaddr(hdev);
425 /* ------ LDISC part ------ */
428 * Called when line discipline changed to HCI_UART.
431 * tty pointer to tty info structure
433 * 0 if success, otherwise error code
435 static int hci_uart_tty_open(struct tty_struct *tty)
439 BT_DBG("tty %p", tty);
441 /* Error if the tty has no write op instead of leaving an exploitable
443 if (tty->ops->write == NULL)
446 hu = kzalloc(sizeof(struct hci_uart), GFP_KERNEL);
448 BT_ERR("Can't allocate control structure");
454 tty->receive_room = 65536;
456 /* disable alignment support by default */
460 INIT_WORK(&hu->init_ready, hci_uart_init_work);
461 INIT_WORK(&hu->write_work, hci_uart_write_work);
463 /* Flush any pending characters in the driver */
464 tty_driver_flush_buffer(tty);
469 /* hci_uart_tty_close()
471 * Called when the line discipline is changed to something
472 * else, the tty is closed, or the tty detects a hangup.
474 static void hci_uart_tty_close(struct tty_struct *tty)
476 struct hci_uart *hu = tty->disc_data;
477 struct hci_dev *hdev;
479 BT_DBG("tty %p", tty);
481 /* Detach from the tty */
482 tty->disc_data = NULL;
489 hci_uart_close(hdev);
491 cancel_work_sync(&hu->write_work);
493 if (test_and_clear_bit(HCI_UART_PROTO_READY, &hu->flags)) {
495 if (test_bit(HCI_UART_REGISTERED, &hu->flags))
496 hci_unregister_dev(hdev);
499 hu->proto->close(hu);
501 clear_bit(HCI_UART_PROTO_SET, &hu->flags);
506 /* hci_uart_tty_wakeup()
508 * Callback for transmit wakeup. Called when low level
509 * device driver can accept more send data.
511 * Arguments: tty pointer to associated tty instance data
514 static void hci_uart_tty_wakeup(struct tty_struct *tty)
516 struct hci_uart *hu = tty->disc_data;
523 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
528 if (test_bit(HCI_UART_PROTO_READY, &hu->flags))
529 hci_uart_tx_wakeup(hu);
532 /* hci_uart_tty_receive()
534 * Called by tty low level driver when receive data is
537 * Arguments: tty pointer to tty isntance data
538 * data pointer to received data
539 * flags pointer to flags for data
540 * count count of received data in bytes
544 static void hci_uart_tty_receive(struct tty_struct *tty, const u8 *data,
545 char *flags, int count)
547 struct hci_uart *hu = tty->disc_data;
549 if (!hu || tty != hu->tty)
552 if (!test_bit(HCI_UART_PROTO_READY, &hu->flags))
555 /* It does not need a lock here as it is already protected by a mutex in
558 hu->proto->recv(hu, data, count);
561 hu->hdev->stat.byte_rx += count;
566 static int hci_uart_register_dev(struct hci_uart *hu)
568 struct hci_dev *hdev;
572 /* Initialize and register HCI device */
573 hdev = hci_alloc_dev();
575 BT_ERR("Can't allocate HCI device");
581 hdev->bus = HCI_UART;
582 hci_set_drvdata(hdev, hu);
584 /* Only when vendor specific setup callback is provided, consider
585 * the manufacturer information valid. This avoids filling in the
586 * value for Ericsson when nothing is specified.
588 if (hu->proto->setup)
589 hdev->manufacturer = hu->proto->manufacturer;
591 hdev->open = hci_uart_open;
592 hdev->close = hci_uart_close;
593 hdev->flush = hci_uart_flush;
594 hdev->send = hci_uart_send_frame;
595 hdev->setup = hci_uart_setup;
596 SET_HCIDEV_DEV(hdev, hu->tty->dev);
598 if (test_bit(HCI_UART_RAW_DEVICE, &hu->hdev_flags))
599 set_bit(HCI_QUIRK_RAW_DEVICE, &hdev->quirks);
601 if (test_bit(HCI_UART_EXT_CONFIG, &hu->hdev_flags))
602 set_bit(HCI_QUIRK_EXTERNAL_CONFIG, &hdev->quirks);
604 if (!test_bit(HCI_UART_RESET_ON_INIT, &hu->hdev_flags))
605 set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
607 if (test_bit(HCI_UART_CREATE_AMP, &hu->hdev_flags))
608 hdev->dev_type = HCI_AMP;
610 hdev->dev_type = HCI_PRIMARY;
612 if (test_bit(HCI_UART_INIT_PENDING, &hu->hdev_flags))
615 if (hci_register_dev(hdev) < 0) {
616 BT_ERR("Can't register HCI device");
622 set_bit(HCI_UART_REGISTERED, &hu->flags);
627 static int hci_uart_set_proto(struct hci_uart *hu, int id)
629 const struct hci_uart_proto *p;
632 p = hci_uart_get_proto(id);
634 return -EPROTONOSUPPORT;
641 set_bit(HCI_UART_PROTO_READY, &hu->flags);
643 err = hci_uart_register_dev(hu);
645 clear_bit(HCI_UART_PROTO_READY, &hu->flags);
653 static int hci_uart_set_flags(struct hci_uart *hu, unsigned long flags)
655 unsigned long valid_flags = BIT(HCI_UART_RAW_DEVICE) |
656 BIT(HCI_UART_RESET_ON_INIT) |
657 BIT(HCI_UART_CREATE_AMP) |
658 BIT(HCI_UART_INIT_PENDING) |
659 BIT(HCI_UART_EXT_CONFIG) |
660 BIT(HCI_UART_VND_DETECT);
662 if (flags & ~valid_flags)
665 hu->hdev_flags = flags;
670 /* hci_uart_tty_ioctl()
672 * Process IOCTL system call for the tty device.
676 * tty pointer to tty instance data
677 * file pointer to open file object for device
678 * cmd IOCTL command code
679 * arg argument for IOCTL call (cmd dependent)
681 * Return Value: Command dependent
683 static int hci_uart_tty_ioctl(struct tty_struct *tty, struct file *file,
684 unsigned int cmd, unsigned long arg)
686 struct hci_uart *hu = tty->disc_data;
691 /* Verify the status of the device */
696 case HCIUARTSETPROTO:
697 if (!test_and_set_bit(HCI_UART_PROTO_SET, &hu->flags)) {
698 err = hci_uart_set_proto(hu, arg);
700 clear_bit(HCI_UART_PROTO_SET, &hu->flags);
705 case HCIUARTGETPROTO:
706 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
712 case HCIUARTGETDEVICE:
713 if (test_bit(HCI_UART_REGISTERED, &hu->flags))
719 case HCIUARTSETFLAGS:
720 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
723 err = hci_uart_set_flags(hu, arg);
726 case HCIUARTGETFLAGS:
727 err = hu->hdev_flags;
731 err = n_tty_ioctl_helper(tty, file, cmd, arg);
739 * We don't provide read/write/poll interface for user space.
741 static ssize_t hci_uart_tty_read(struct tty_struct *tty, struct file *file,
742 unsigned char __user *buf, size_t nr)
747 static ssize_t hci_uart_tty_write(struct tty_struct *tty, struct file *file,
748 const unsigned char *data, size_t count)
753 static unsigned int hci_uart_tty_poll(struct tty_struct *tty,
754 struct file *filp, poll_table *wait)
759 static int __init hci_uart_init(void)
761 static struct tty_ldisc_ops hci_uart_ldisc;
764 BT_INFO("HCI UART driver ver %s", VERSION);
766 /* Register the tty discipline */
768 memset(&hci_uart_ldisc, 0, sizeof(hci_uart_ldisc));
769 hci_uart_ldisc.magic = TTY_LDISC_MAGIC;
770 hci_uart_ldisc.name = "n_hci";
771 hci_uart_ldisc.open = hci_uart_tty_open;
772 hci_uart_ldisc.close = hci_uart_tty_close;
773 hci_uart_ldisc.read = hci_uart_tty_read;
774 hci_uart_ldisc.write = hci_uart_tty_write;
775 hci_uart_ldisc.ioctl = hci_uart_tty_ioctl;
776 hci_uart_ldisc.poll = hci_uart_tty_poll;
777 hci_uart_ldisc.receive_buf = hci_uart_tty_receive;
778 hci_uart_ldisc.write_wakeup = hci_uart_tty_wakeup;
779 hci_uart_ldisc.owner = THIS_MODULE;
781 err = tty_register_ldisc(N_HCI, &hci_uart_ldisc);
783 BT_ERR("HCI line discipline registration failed. (%d)", err);
787 #ifdef CONFIG_BT_HCIUART_H4
790 #ifdef CONFIG_BT_HCIUART_BCSP
793 #ifdef CONFIG_BT_HCIUART_LL
796 #ifdef CONFIG_BT_HCIUART_ATH3K
799 #ifdef CONFIG_BT_HCIUART_3WIRE
802 #ifdef CONFIG_BT_HCIUART_INTEL
805 #ifdef CONFIG_BT_HCIUART_BCM
808 #ifdef CONFIG_BT_HCIUART_QCA
811 #ifdef CONFIG_BT_HCIUART_AG6XX
814 #ifdef CONFIG_BT_HCIUART_MRVL
821 static void __exit hci_uart_exit(void)
825 #ifdef CONFIG_BT_HCIUART_H4
828 #ifdef CONFIG_BT_HCIUART_BCSP
831 #ifdef CONFIG_BT_HCIUART_LL
834 #ifdef CONFIG_BT_HCIUART_ATH3K
837 #ifdef CONFIG_BT_HCIUART_3WIRE
840 #ifdef CONFIG_BT_HCIUART_INTEL
843 #ifdef CONFIG_BT_HCIUART_BCM
846 #ifdef CONFIG_BT_HCIUART_QCA
849 #ifdef CONFIG_BT_HCIUART_AG6XX
852 #ifdef CONFIG_BT_HCIUART_MRVL
856 /* Release tty registration of line discipline */
857 err = tty_unregister_ldisc(N_HCI);
859 BT_ERR("Can't unregister HCI line discipline (%d)", err);
862 module_init(hci_uart_init);
863 module_exit(hci_uart_exit);
865 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
866 MODULE_DESCRIPTION("Bluetooth HCI UART driver ver " VERSION);
867 MODULE_VERSION(VERSION);
868 MODULE_LICENSE("GPL");
869 MODULE_ALIAS_LDISC(N_HCI);