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>
43 #include <linux/firmware.h>
44 #include <linux/serdev.h>
46 #include <net/bluetooth/bluetooth.h>
47 #include <net/bluetooth/hci_core.h>
55 static const struct hci_uart_proto *hup[HCI_UART_MAX_PROTO];
57 int hci_uart_register_proto(const struct hci_uart_proto *p)
59 if (p->id >= HCI_UART_MAX_PROTO)
67 BT_INFO("HCI UART protocol %s registered", p->name);
72 int hci_uart_unregister_proto(const struct hci_uart_proto *p)
74 if (p->id >= HCI_UART_MAX_PROTO)
85 static const struct hci_uart_proto *hci_uart_get_proto(unsigned int id)
87 if (id >= HCI_UART_MAX_PROTO)
93 static inline void hci_uart_tx_complete(struct hci_uart *hu, int pkt_type)
95 struct hci_dev *hdev = hu->hdev;
97 /* Update HCI stat counters */
103 case HCI_ACLDATA_PKT:
107 case HCI_SCODATA_PKT:
113 static inline struct sk_buff *hci_uart_dequeue(struct hci_uart *hu)
115 struct sk_buff *skb = hu->tx_skb;
118 percpu_down_read(&hu->proto_lock);
120 if (test_bit(HCI_UART_PROTO_READY, &hu->flags))
121 skb = hu->proto->dequeue(hu);
123 percpu_up_read(&hu->proto_lock);
131 int hci_uart_tx_wakeup(struct hci_uart *hu)
133 /* This may be called in an IRQ context, so we can't sleep. Therefore
134 * we try to acquire the lock only, and if that fails we assume the
135 * tty is being closed because that is the only time the write lock is
136 * acquired. If, however, at some point in the future the write lock
137 * is also acquired in other situations, then this must be revisited.
139 if (!percpu_down_read_trylock(&hu->proto_lock))
142 if (!test_bit(HCI_UART_PROTO_READY, &hu->flags))
145 if (test_and_set_bit(HCI_UART_SENDING, &hu->tx_state)) {
146 set_bit(HCI_UART_TX_WAKEUP, &hu->tx_state);
152 schedule_work(&hu->write_work);
155 percpu_up_read(&hu->proto_lock);
159 EXPORT_SYMBOL_GPL(hci_uart_tx_wakeup);
161 static void hci_uart_write_work(struct work_struct *work)
163 struct hci_uart *hu = container_of(work, struct hci_uart, write_work);
164 struct tty_struct *tty = hu->tty;
165 struct hci_dev *hdev = hu->hdev;
168 /* REVISIT: should we cope with bad skbs or ->write() returning
173 clear_bit(HCI_UART_TX_WAKEUP, &hu->tx_state);
175 while ((skb = hci_uart_dequeue(hu))) {
178 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
179 len = tty->ops->write(tty, skb->data, skb->len);
180 hdev->stat.byte_tx += len;
188 hci_uart_tx_complete(hu, hci_skb_pkt_type(skb));
192 if (test_bit(HCI_UART_TX_WAKEUP, &hu->tx_state))
195 clear_bit(HCI_UART_SENDING, &hu->tx_state);
198 static void hci_uart_init_work(struct work_struct *work)
200 struct hci_uart *hu = container_of(work, struct hci_uart, init_ready);
202 struct hci_dev *hdev;
204 if (!test_and_clear_bit(HCI_UART_INIT_PENDING, &hu->hdev_flags))
207 err = hci_register_dev(hu->hdev);
209 BT_ERR("Can't register HCI device");
213 clear_bit(HCI_UART_PROTO_READY, &hu->flags);
214 hu->proto->close(hu);
218 set_bit(HCI_UART_REGISTERED, &hu->flags);
221 int hci_uart_init_ready(struct hci_uart *hu)
223 if (!test_bit(HCI_UART_INIT_PENDING, &hu->hdev_flags))
226 schedule_work(&hu->init_ready);
231 /* ------- Interface to HCI layer ------ */
232 /* Initialize device */
233 static int hci_uart_open(struct hci_dev *hdev)
235 BT_DBG("%s %p", hdev->name, hdev);
237 /* Nothing to do for UART driver */
242 static int hci_uart_flush(struct hci_dev *hdev)
244 struct hci_uart *hu = hci_get_drvdata(hdev);
245 struct tty_struct *tty = hu->tty;
247 BT_DBG("hdev %p tty %p", hdev, tty);
250 kfree_skb(hu->tx_skb); hu->tx_skb = NULL;
253 /* Flush any pending characters in the driver and discipline. */
254 tty_ldisc_flush(tty);
255 tty_driver_flush_buffer(tty);
257 percpu_down_read(&hu->proto_lock);
259 if (test_bit(HCI_UART_PROTO_READY, &hu->flags))
260 hu->proto->flush(hu);
262 percpu_up_read(&hu->proto_lock);
268 static int hci_uart_close(struct hci_dev *hdev)
270 BT_DBG("hdev %p", hdev);
272 hci_uart_flush(hdev);
277 /* Send frames from HCI layer */
278 static int hci_uart_send_frame(struct hci_dev *hdev, struct sk_buff *skb)
280 struct hci_uart *hu = hci_get_drvdata(hdev);
282 BT_DBG("%s: type %d len %d", hdev->name, hci_skb_pkt_type(skb),
285 percpu_down_read(&hu->proto_lock);
287 if (!test_bit(HCI_UART_PROTO_READY, &hu->flags)) {
288 percpu_up_read(&hu->proto_lock);
292 hu->proto->enqueue(hu, skb);
293 percpu_up_read(&hu->proto_lock);
295 hci_uart_tx_wakeup(hu);
300 /* Flow control or un-flow control the device */
301 void hci_uart_set_flow_control(struct hci_uart *hu, bool enable)
303 struct tty_struct *tty = hu->tty;
304 struct ktermios ktermios;
306 unsigned int set = 0;
307 unsigned int clear = 0;
310 serdev_device_set_flow_control(hu->serdev, !enable);
311 serdev_device_set_rts(hu->serdev, !enable);
316 /* Disable hardware flow control */
317 ktermios = tty->termios;
318 ktermios.c_cflag &= ~CRTSCTS;
319 status = tty_set_termios(tty, &ktermios);
320 BT_DBG("Disabling hardware flow control: %s",
321 status ? "failed" : "success");
323 /* Clear RTS to prevent the device from sending */
324 /* Most UARTs need OUT2 to enable interrupts */
325 status = tty->driver->ops->tiocmget(tty);
326 BT_DBG("Current tiocm 0x%x", status);
328 set &= ~(TIOCM_OUT2 | TIOCM_RTS);
330 set &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
331 TIOCM_OUT2 | TIOCM_LOOP;
332 clear &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
333 TIOCM_OUT2 | TIOCM_LOOP;
334 status = tty->driver->ops->tiocmset(tty, set, clear);
335 BT_DBG("Clearing RTS: %s", status ? "failed" : "success");
337 /* Set RTS to allow the device to send again */
338 status = tty->driver->ops->tiocmget(tty);
339 BT_DBG("Current tiocm 0x%x", status);
341 set |= (TIOCM_OUT2 | TIOCM_RTS);
343 set &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
344 TIOCM_OUT2 | TIOCM_LOOP;
345 clear &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
346 TIOCM_OUT2 | TIOCM_LOOP;
347 status = tty->driver->ops->tiocmset(tty, set, clear);
348 BT_DBG("Setting RTS: %s", status ? "failed" : "success");
350 /* Re-enable hardware flow control */
351 ktermios = tty->termios;
352 ktermios.c_cflag |= CRTSCTS;
353 status = tty_set_termios(tty, &ktermios);
354 BT_DBG("Enabling hardware flow control: %s",
355 status ? "failed" : "success");
359 void hci_uart_set_speeds(struct hci_uart *hu, unsigned int init_speed,
360 unsigned int oper_speed)
362 hu->init_speed = init_speed;
363 hu->oper_speed = oper_speed;
366 void hci_uart_set_baudrate(struct hci_uart *hu, unsigned int speed)
368 struct tty_struct *tty = hu->tty;
369 struct ktermios ktermios;
371 ktermios = tty->termios;
372 ktermios.c_cflag &= ~CBAUD;
373 tty_termios_encode_baud_rate(&ktermios, speed, speed);
375 /* tty_set_termios() return not checked as it is always 0 */
376 tty_set_termios(tty, &ktermios);
378 BT_DBG("%s: New tty speeds: %d/%d", hu->hdev->name,
379 tty->termios.c_ispeed, tty->termios.c_ospeed);
382 static int hci_uart_setup(struct hci_dev *hdev)
384 struct hci_uart *hu = hci_get_drvdata(hdev);
385 struct hci_rp_read_local_version *ver;
390 /* Init speed if any */
392 speed = hu->init_speed;
393 else if (hu->proto->init_speed)
394 speed = hu->proto->init_speed;
399 hci_uart_set_baudrate(hu, speed);
401 /* Operational speed if any */
403 speed = hu->oper_speed;
404 else if (hu->proto->oper_speed)
405 speed = hu->proto->oper_speed;
409 if (hu->proto->set_baudrate && speed) {
410 err = hu->proto->set_baudrate(hu, speed);
412 hci_uart_set_baudrate(hu, speed);
415 if (hu->proto->setup)
416 return hu->proto->setup(hu);
418 if (!test_bit(HCI_UART_VND_DETECT, &hu->hdev_flags))
421 skb = __hci_cmd_sync(hdev, HCI_OP_READ_LOCAL_VERSION, 0, NULL,
424 BT_ERR("%s: Reading local version information failed (%ld)",
425 hdev->name, PTR_ERR(skb));
429 if (skb->len != sizeof(*ver)) {
430 BT_ERR("%s: Event length mismatch for version information",
435 ver = (struct hci_rp_read_local_version *)skb->data;
437 switch (le16_to_cpu(ver->manufacturer)) {
438 #ifdef CONFIG_BT_HCIUART_INTEL
440 hdev->set_bdaddr = btintel_set_bdaddr;
441 btintel_check_bdaddr(hdev);
444 #ifdef CONFIG_BT_HCIUART_BCM
446 hdev->set_bdaddr = btbcm_set_bdaddr;
447 btbcm_check_bdaddr(hdev);
457 /* ------ LDISC part ------ */
460 * Called when line discipline changed to HCI_UART.
463 * tty pointer to tty info structure
465 * 0 if success, otherwise error code
467 static int hci_uart_tty_open(struct tty_struct *tty)
471 BT_DBG("tty %p", tty);
473 /* Error if the tty has no write op instead of leaving an exploitable
476 if (tty->ops->write == NULL)
479 hu = kzalloc(sizeof(struct hci_uart), GFP_KERNEL);
481 BT_ERR("Can't allocate control structure");
487 tty->receive_room = 65536;
489 /* disable alignment support by default */
493 INIT_WORK(&hu->init_ready, hci_uart_init_work);
494 INIT_WORK(&hu->write_work, hci_uart_write_work);
496 percpu_init_rwsem(&hu->proto_lock);
498 /* Flush any pending characters in the driver */
499 tty_driver_flush_buffer(tty);
504 /* hci_uart_tty_close()
506 * Called when the line discipline is changed to something
507 * else, the tty is closed, or the tty detects a hangup.
509 static void hci_uart_tty_close(struct tty_struct *tty)
511 struct hci_uart *hu = tty->disc_data;
512 struct hci_dev *hdev;
514 BT_DBG("tty %p", tty);
516 /* Detach from the tty */
517 tty->disc_data = NULL;
524 hci_uart_close(hdev);
526 if (test_bit(HCI_UART_PROTO_READY, &hu->flags)) {
527 percpu_down_write(&hu->proto_lock);
528 clear_bit(HCI_UART_PROTO_READY, &hu->flags);
529 percpu_up_write(&hu->proto_lock);
531 cancel_work_sync(&hu->write_work);
534 if (test_bit(HCI_UART_REGISTERED, &hu->flags))
535 hci_unregister_dev(hdev);
538 hu->proto->close(hu);
540 clear_bit(HCI_UART_PROTO_SET, &hu->flags);
545 /* hci_uart_tty_wakeup()
547 * Callback for transmit wakeup. Called when low level
548 * device driver can accept more send data.
550 * Arguments: tty pointer to associated tty instance data
553 static void hci_uart_tty_wakeup(struct tty_struct *tty)
555 struct hci_uart *hu = tty->disc_data;
562 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
567 if (test_bit(HCI_UART_PROTO_READY, &hu->flags))
568 hci_uart_tx_wakeup(hu);
571 /* hci_uart_tty_receive()
573 * Called by tty low level driver when receive data is
576 * Arguments: tty pointer to tty isntance data
577 * data pointer to received data
578 * flags pointer to flags for data
579 * count count of received data in bytes
583 static void hci_uart_tty_receive(struct tty_struct *tty, const u8 *data,
584 char *flags, int count)
586 struct hci_uart *hu = tty->disc_data;
588 if (!hu || tty != hu->tty)
591 percpu_down_read(&hu->proto_lock);
593 if (!test_bit(HCI_UART_PROTO_READY, &hu->flags)) {
594 percpu_up_read(&hu->proto_lock);
598 /* It does not need a lock here as it is already protected by a mutex in
601 hu->proto->recv(hu, data, count);
602 percpu_up_read(&hu->proto_lock);
605 hu->hdev->stat.byte_rx += count;
610 static int hci_uart_register_dev(struct hci_uart *hu)
612 struct hci_dev *hdev;
616 /* Initialize and register HCI device */
617 hdev = hci_alloc_dev();
619 BT_ERR("Can't allocate HCI device");
625 hdev->bus = HCI_UART;
626 hci_set_drvdata(hdev, hu);
628 /* Only when vendor specific setup callback is provided, consider
629 * the manufacturer information valid. This avoids filling in the
630 * value for Ericsson when nothing is specified.
632 if (hu->proto->setup)
633 hdev->manufacturer = hu->proto->manufacturer;
635 hdev->open = hci_uart_open;
636 hdev->close = hci_uart_close;
637 hdev->flush = hci_uart_flush;
638 hdev->send = hci_uart_send_frame;
639 hdev->setup = hci_uart_setup;
640 SET_HCIDEV_DEV(hdev, hu->tty->dev);
642 if (test_bit(HCI_UART_RAW_DEVICE, &hu->hdev_flags))
643 set_bit(HCI_QUIRK_RAW_DEVICE, &hdev->quirks);
645 if (test_bit(HCI_UART_EXT_CONFIG, &hu->hdev_flags))
646 set_bit(HCI_QUIRK_EXTERNAL_CONFIG, &hdev->quirks);
648 if (!test_bit(HCI_UART_RESET_ON_INIT, &hu->hdev_flags))
649 set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
651 if (test_bit(HCI_UART_CREATE_AMP, &hu->hdev_flags))
652 hdev->dev_type = HCI_AMP;
654 hdev->dev_type = HCI_PRIMARY;
656 if (test_bit(HCI_UART_INIT_PENDING, &hu->hdev_flags))
659 if (hci_register_dev(hdev) < 0) {
660 BT_ERR("Can't register HCI device");
666 set_bit(HCI_UART_REGISTERED, &hu->flags);
671 static int hci_uart_set_proto(struct hci_uart *hu, int id)
673 const struct hci_uart_proto *p;
676 p = hci_uart_get_proto(id);
678 return -EPROTONOSUPPORT;
685 set_bit(HCI_UART_PROTO_READY, &hu->flags);
687 err = hci_uart_register_dev(hu);
689 clear_bit(HCI_UART_PROTO_READY, &hu->flags);
697 static int hci_uart_set_flags(struct hci_uart *hu, unsigned long flags)
699 unsigned long valid_flags = BIT(HCI_UART_RAW_DEVICE) |
700 BIT(HCI_UART_RESET_ON_INIT) |
701 BIT(HCI_UART_CREATE_AMP) |
702 BIT(HCI_UART_INIT_PENDING) |
703 BIT(HCI_UART_EXT_CONFIG) |
704 BIT(HCI_UART_VND_DETECT);
706 if (flags & ~valid_flags)
709 hu->hdev_flags = flags;
714 /* hci_uart_tty_ioctl()
716 * Process IOCTL system call for the tty device.
720 * tty pointer to tty instance data
721 * file pointer to open file object for device
722 * cmd IOCTL command code
723 * arg argument for IOCTL call (cmd dependent)
725 * Return Value: Command dependent
727 static int hci_uart_tty_ioctl(struct tty_struct *tty, struct file *file,
728 unsigned int cmd, unsigned long arg)
730 struct hci_uart *hu = tty->disc_data;
735 /* Verify the status of the device */
740 case HCIUARTSETPROTO:
741 if (!test_and_set_bit(HCI_UART_PROTO_SET, &hu->flags)) {
742 err = hci_uart_set_proto(hu, arg);
744 clear_bit(HCI_UART_PROTO_SET, &hu->flags);
749 case HCIUARTGETPROTO:
750 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
756 case HCIUARTGETDEVICE:
757 if (test_bit(HCI_UART_REGISTERED, &hu->flags))
763 case HCIUARTSETFLAGS:
764 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
767 err = hci_uart_set_flags(hu, arg);
770 case HCIUARTGETFLAGS:
771 err = hu->hdev_flags;
775 err = n_tty_ioctl_helper(tty, file, cmd, arg);
783 * We don't provide read/write/poll interface for user space.
785 static ssize_t hci_uart_tty_read(struct tty_struct *tty, struct file *file,
786 unsigned char __user *buf, size_t nr)
791 static ssize_t hci_uart_tty_write(struct tty_struct *tty, struct file *file,
792 const unsigned char *data, size_t count)
797 static __poll_t hci_uart_tty_poll(struct tty_struct *tty,
798 struct file *filp, poll_table *wait)
803 static int __init hci_uart_init(void)
805 static struct tty_ldisc_ops hci_uart_ldisc;
808 BT_INFO("HCI UART driver ver %s", VERSION);
810 /* Register the tty discipline */
812 memset(&hci_uart_ldisc, 0, sizeof(hci_uart_ldisc));
813 hci_uart_ldisc.magic = TTY_LDISC_MAGIC;
814 hci_uart_ldisc.name = "n_hci";
815 hci_uart_ldisc.open = hci_uart_tty_open;
816 hci_uart_ldisc.close = hci_uart_tty_close;
817 hci_uart_ldisc.read = hci_uart_tty_read;
818 hci_uart_ldisc.write = hci_uart_tty_write;
819 hci_uart_ldisc.ioctl = hci_uart_tty_ioctl;
820 hci_uart_ldisc.poll = hci_uart_tty_poll;
821 hci_uart_ldisc.receive_buf = hci_uart_tty_receive;
822 hci_uart_ldisc.write_wakeup = hci_uart_tty_wakeup;
823 hci_uart_ldisc.owner = THIS_MODULE;
825 err = tty_register_ldisc(N_HCI, &hci_uart_ldisc);
827 BT_ERR("HCI line discipline registration failed. (%d)", err);
831 #ifdef CONFIG_BT_HCIUART_H4
834 #ifdef CONFIG_BT_HCIUART_BCSP
837 #ifdef CONFIG_BT_HCIUART_LL
840 #ifdef CONFIG_BT_HCIUART_ATH3K
843 #ifdef CONFIG_BT_HCIUART_3WIRE
846 #ifdef CONFIG_BT_HCIUART_INTEL
849 #ifdef CONFIG_BT_HCIUART_BCM
852 #ifdef CONFIG_BT_HCIUART_QCA
855 #ifdef CONFIG_BT_HCIUART_AG6XX
858 #ifdef CONFIG_BT_HCIUART_MRVL
865 static void __exit hci_uart_exit(void)
869 #ifdef CONFIG_BT_HCIUART_H4
872 #ifdef CONFIG_BT_HCIUART_BCSP
875 #ifdef CONFIG_BT_HCIUART_LL
878 #ifdef CONFIG_BT_HCIUART_ATH3K
881 #ifdef CONFIG_BT_HCIUART_3WIRE
884 #ifdef CONFIG_BT_HCIUART_INTEL
887 #ifdef CONFIG_BT_HCIUART_BCM
890 #ifdef CONFIG_BT_HCIUART_QCA
893 #ifdef CONFIG_BT_HCIUART_AG6XX
896 #ifdef CONFIG_BT_HCIUART_MRVL
900 /* Release tty registration of line discipline */
901 err = tty_unregister_ldisc(N_HCI);
903 BT_ERR("Can't unregister HCI line discipline (%d)", err);
906 module_init(hci_uart_init);
907 module_exit(hci_uart_exit);
910 MODULE_DESCRIPTION("Bluetooth HCI UART driver ver " VERSION);
911 MODULE_VERSION(VERSION);
912 MODULE_LICENSE("GPL");
913 MODULE_ALIAS_LDISC(N_HCI);