1 // SPDX-License-Identifier: GPL-2.0-or-later
4 * Bluetooth HCI UART driver
6 * Copyright (C) 2000-2001 Qualcomm Incorporated
11 #include <linux/module.h>
13 #include <linux/kernel.h>
14 #include <linux/init.h>
15 #include <linux/types.h>
16 #include <linux/fcntl.h>
17 #include <linux/interrupt.h>
18 #include <linux/ptrace.h>
19 #include <linux/poll.h>
21 #include <linux/slab.h>
22 #include <linux/tty.h>
23 #include <linux/errno.h>
24 #include <linux/string.h>
25 #include <linux/signal.h>
26 #include <linux/ioctl.h>
27 #include <linux/skbuff.h>
28 #include <linux/firmware.h>
29 #include <linux/serdev.h>
31 #include <net/bluetooth/bluetooth.h>
32 #include <net/bluetooth/hci_core.h>
40 static const struct hci_uart_proto *hup[HCI_UART_MAX_PROTO];
42 int hci_uart_register_proto(const struct hci_uart_proto *p)
44 if (p->id >= HCI_UART_MAX_PROTO)
52 BT_INFO("HCI UART protocol %s registered", p->name);
57 int hci_uart_unregister_proto(const struct hci_uart_proto *p)
59 if (p->id >= HCI_UART_MAX_PROTO)
70 static const struct hci_uart_proto *hci_uart_get_proto(unsigned int id)
72 if (id >= HCI_UART_MAX_PROTO)
78 static inline void hci_uart_tx_complete(struct hci_uart *hu, int pkt_type)
80 struct hci_dev *hdev = hu->hdev;
82 /* Update HCI stat counters */
98 static inline struct sk_buff *hci_uart_dequeue(struct hci_uart *hu)
100 struct sk_buff *skb = hu->tx_skb;
103 percpu_down_read(&hu->proto_lock);
105 if (test_bit(HCI_UART_PROTO_READY, &hu->flags))
106 skb = hu->proto->dequeue(hu);
108 percpu_up_read(&hu->proto_lock);
116 int hci_uart_tx_wakeup(struct hci_uart *hu)
118 /* This may be called in an IRQ context, so we can't sleep. Therefore
119 * we try to acquire the lock only, and if that fails we assume the
120 * tty is being closed because that is the only time the write lock is
121 * acquired. If, however, at some point in the future the write lock
122 * is also acquired in other situations, then this must be revisited.
124 if (!percpu_down_read_trylock(&hu->proto_lock))
127 if (!test_bit(HCI_UART_PROTO_READY, &hu->flags))
130 if (test_and_set_bit(HCI_UART_SENDING, &hu->tx_state)) {
131 set_bit(HCI_UART_TX_WAKEUP, &hu->tx_state);
137 schedule_work(&hu->write_work);
140 percpu_up_read(&hu->proto_lock);
144 EXPORT_SYMBOL_GPL(hci_uart_tx_wakeup);
146 static void hci_uart_write_work(struct work_struct *work)
148 struct hci_uart *hu = container_of(work, struct hci_uart, write_work);
149 struct tty_struct *tty = hu->tty;
150 struct hci_dev *hdev = hu->hdev;
153 /* REVISIT: should we cope with bad skbs or ->write() returning
158 clear_bit(HCI_UART_TX_WAKEUP, &hu->tx_state);
160 while ((skb = hci_uart_dequeue(hu))) {
163 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
164 len = tty->ops->write(tty, skb->data, skb->len);
165 hdev->stat.byte_tx += len;
173 hci_uart_tx_complete(hu, hci_skb_pkt_type(skb));
177 if (test_bit(HCI_UART_TX_WAKEUP, &hu->tx_state))
180 clear_bit(HCI_UART_SENDING, &hu->tx_state);
181 wake_up_bit(&hu->tx_state, HCI_UART_SENDING);
184 void hci_uart_init_work(struct work_struct *work)
186 struct hci_uart *hu = container_of(work, struct hci_uart, init_ready);
188 struct hci_dev *hdev;
190 if (!test_and_clear_bit(HCI_UART_INIT_PENDING, &hu->hdev_flags))
193 err = hci_register_dev(hu->hdev);
195 BT_ERR("Can't register HCI device");
196 clear_bit(HCI_UART_PROTO_READY, &hu->flags);
197 hu->proto->close(hu);
204 set_bit(HCI_UART_REGISTERED, &hu->flags);
207 int hci_uart_init_ready(struct hci_uart *hu)
209 if (!test_bit(HCI_UART_INIT_PENDING, &hu->hdev_flags))
212 schedule_work(&hu->init_ready);
217 int hci_uart_wait_until_sent(struct hci_uart *hu)
219 return wait_on_bit_timeout(&hu->tx_state, HCI_UART_SENDING,
221 msecs_to_jiffies(2000));
224 /* ------- Interface to HCI layer ------ */
226 static int hci_uart_flush(struct hci_dev *hdev)
228 struct hci_uart *hu = hci_get_drvdata(hdev);
229 struct tty_struct *tty = hu->tty;
231 BT_DBG("hdev %p tty %p", hdev, tty);
234 kfree_skb(hu->tx_skb); hu->tx_skb = NULL;
237 /* Flush any pending characters in the driver and discipline. */
238 tty_ldisc_flush(tty);
239 tty_driver_flush_buffer(tty);
241 percpu_down_read(&hu->proto_lock);
243 if (test_bit(HCI_UART_PROTO_READY, &hu->flags))
244 hu->proto->flush(hu);
246 percpu_up_read(&hu->proto_lock);
251 /* Initialize device */
252 static int hci_uart_open(struct hci_dev *hdev)
254 BT_DBG("%s %p", hdev->name, hdev);
256 /* Undo clearing this from hci_uart_close() */
257 hdev->flush = hci_uart_flush;
263 static int hci_uart_close(struct hci_dev *hdev)
265 BT_DBG("hdev %p", hdev);
267 hci_uart_flush(hdev);
272 /* Send frames from HCI layer */
273 static int hci_uart_send_frame(struct hci_dev *hdev, struct sk_buff *skb)
275 struct hci_uart *hu = hci_get_drvdata(hdev);
277 BT_DBG("%s: type %d len %d", hdev->name, hci_skb_pkt_type(skb),
280 percpu_down_read(&hu->proto_lock);
282 if (!test_bit(HCI_UART_PROTO_READY, &hu->flags)) {
283 percpu_up_read(&hu->proto_lock);
287 hu->proto->enqueue(hu, skb);
288 percpu_up_read(&hu->proto_lock);
290 hci_uart_tx_wakeup(hu);
295 /* Check the underlying device or tty has flow control support */
296 bool hci_uart_has_flow_control(struct hci_uart *hu)
298 /* serdev nodes check if the needed operations are present */
302 if (hu->tty->driver->ops->tiocmget && hu->tty->driver->ops->tiocmset)
308 /* Flow control or un-flow control the device */
309 void hci_uart_set_flow_control(struct hci_uart *hu, bool enable)
311 struct tty_struct *tty = hu->tty;
312 struct ktermios ktermios;
314 unsigned int set = 0;
315 unsigned int clear = 0;
318 serdev_device_set_flow_control(hu->serdev, !enable);
319 serdev_device_set_rts(hu->serdev, !enable);
324 /* Disable hardware flow control */
325 ktermios = tty->termios;
326 ktermios.c_cflag &= ~CRTSCTS;
327 status = tty_set_termios(tty, &ktermios);
328 BT_DBG("Disabling hardware flow control: %s",
329 status ? "failed" : "success");
331 /* Clear RTS to prevent the device from sending */
332 /* Most UARTs need OUT2 to enable interrupts */
333 status = tty->driver->ops->tiocmget(tty);
334 BT_DBG("Current tiocm 0x%x", status);
336 set &= ~(TIOCM_OUT2 | TIOCM_RTS);
338 set &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
339 TIOCM_OUT2 | TIOCM_LOOP;
340 clear &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
341 TIOCM_OUT2 | TIOCM_LOOP;
342 status = tty->driver->ops->tiocmset(tty, set, clear);
343 BT_DBG("Clearing RTS: %s", status ? "failed" : "success");
345 /* Set RTS to allow the device to send again */
346 status = tty->driver->ops->tiocmget(tty);
347 BT_DBG("Current tiocm 0x%x", status);
349 set |= (TIOCM_OUT2 | TIOCM_RTS);
351 set &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
352 TIOCM_OUT2 | TIOCM_LOOP;
353 clear &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
354 TIOCM_OUT2 | TIOCM_LOOP;
355 status = tty->driver->ops->tiocmset(tty, set, clear);
356 BT_DBG("Setting RTS: %s", status ? "failed" : "success");
358 /* Re-enable hardware flow control */
359 ktermios = tty->termios;
360 ktermios.c_cflag |= CRTSCTS;
361 status = tty_set_termios(tty, &ktermios);
362 BT_DBG("Enabling hardware flow control: %s",
363 status ? "failed" : "success");
367 void hci_uart_set_speeds(struct hci_uart *hu, unsigned int init_speed,
368 unsigned int oper_speed)
370 hu->init_speed = init_speed;
371 hu->oper_speed = oper_speed;
374 void hci_uart_set_baudrate(struct hci_uart *hu, unsigned int speed)
376 struct tty_struct *tty = hu->tty;
377 struct ktermios ktermios;
379 ktermios = tty->termios;
380 ktermios.c_cflag &= ~CBAUD;
381 tty_termios_encode_baud_rate(&ktermios, speed, speed);
383 /* tty_set_termios() return not checked as it is always 0 */
384 tty_set_termios(tty, &ktermios);
386 BT_DBG("%s: New tty speeds: %d/%d", hu->hdev->name,
387 tty->termios.c_ispeed, tty->termios.c_ospeed);
390 static int hci_uart_setup(struct hci_dev *hdev)
392 struct hci_uart *hu = hci_get_drvdata(hdev);
393 struct hci_rp_read_local_version *ver;
398 /* Init speed if any */
400 speed = hu->init_speed;
401 else if (hu->proto->init_speed)
402 speed = hu->proto->init_speed;
407 hci_uart_set_baudrate(hu, speed);
409 /* Operational speed if any */
411 speed = hu->oper_speed;
412 else if (hu->proto->oper_speed)
413 speed = hu->proto->oper_speed;
417 if (hu->proto->set_baudrate && speed) {
418 err = hu->proto->set_baudrate(hu, speed);
420 hci_uart_set_baudrate(hu, speed);
423 if (hu->proto->setup)
424 return hu->proto->setup(hu);
426 if (!test_bit(HCI_UART_VND_DETECT, &hu->hdev_flags))
429 skb = __hci_cmd_sync(hdev, HCI_OP_READ_LOCAL_VERSION, 0, NULL,
432 BT_ERR("%s: Reading local version information failed (%ld)",
433 hdev->name, PTR_ERR(skb));
437 if (skb->len != sizeof(*ver)) {
438 BT_ERR("%s: Event length mismatch for version information",
443 ver = (struct hci_rp_read_local_version *)skb->data;
445 switch (le16_to_cpu(ver->manufacturer)) {
446 #ifdef CONFIG_BT_HCIUART_INTEL
448 hdev->set_bdaddr = btintel_set_bdaddr;
449 btintel_check_bdaddr(hdev);
452 #ifdef CONFIG_BT_HCIUART_BCM
454 hdev->set_bdaddr = btbcm_set_bdaddr;
455 btbcm_check_bdaddr(hdev);
467 /* ------ LDISC part ------ */
470 * Called when line discipline changed to HCI_UART.
473 * tty pointer to tty info structure
475 * 0 if success, otherwise error code
477 static int hci_uart_tty_open(struct tty_struct *tty)
481 BT_DBG("tty %p", tty);
483 /* Error if the tty has no write op instead of leaving an exploitable
486 if (tty->ops->write == NULL)
489 hu = kzalloc(sizeof(struct hci_uart), GFP_KERNEL);
491 BT_ERR("Can't allocate control structure");
497 tty->receive_room = 65536;
499 /* disable alignment support by default */
503 INIT_WORK(&hu->init_ready, hci_uart_init_work);
504 INIT_WORK(&hu->write_work, hci_uart_write_work);
506 percpu_init_rwsem(&hu->proto_lock);
508 /* Flush any pending characters in the driver */
509 tty_driver_flush_buffer(tty);
514 /* hci_uart_tty_close()
516 * Called when the line discipline is changed to something
517 * else, the tty is closed, or the tty detects a hangup.
519 static void hci_uart_tty_close(struct tty_struct *tty)
521 struct hci_uart *hu = tty->disc_data;
522 struct hci_dev *hdev;
524 BT_DBG("tty %p", tty);
526 /* Detach from the tty */
527 tty->disc_data = NULL;
534 hci_uart_close(hdev);
536 if (test_bit(HCI_UART_PROTO_READY, &hu->flags)) {
537 percpu_down_write(&hu->proto_lock);
538 clear_bit(HCI_UART_PROTO_READY, &hu->flags);
539 percpu_up_write(&hu->proto_lock);
541 cancel_work_sync(&hu->write_work);
544 if (test_bit(HCI_UART_REGISTERED, &hu->flags))
545 hci_unregister_dev(hdev);
548 hu->proto->close(hu);
550 clear_bit(HCI_UART_PROTO_SET, &hu->flags);
552 percpu_free_rwsem(&hu->proto_lock);
557 /* hci_uart_tty_wakeup()
559 * Callback for transmit wakeup. Called when low level
560 * device driver can accept more send data.
562 * Arguments: tty pointer to associated tty instance data
565 static void hci_uart_tty_wakeup(struct tty_struct *tty)
567 struct hci_uart *hu = tty->disc_data;
574 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
579 if (test_bit(HCI_UART_PROTO_READY, &hu->flags))
580 hci_uart_tx_wakeup(hu);
583 /* hci_uart_tty_receive()
585 * Called by tty low level driver when receive data is
588 * Arguments: tty pointer to tty isntance data
589 * data pointer to received data
590 * flags pointer to flags for data
591 * count count of received data in bytes
595 static void hci_uart_tty_receive(struct tty_struct *tty, const u8 *data,
596 char *flags, int count)
598 struct hci_uart *hu = tty->disc_data;
600 if (!hu || tty != hu->tty)
603 percpu_down_read(&hu->proto_lock);
605 if (!test_bit(HCI_UART_PROTO_READY, &hu->flags)) {
606 percpu_up_read(&hu->proto_lock);
610 /* It does not need a lock here as it is already protected by a mutex in
613 hu->proto->recv(hu, data, count);
614 percpu_up_read(&hu->proto_lock);
617 hu->hdev->stat.byte_rx += count;
622 static int hci_uart_register_dev(struct hci_uart *hu)
624 struct hci_dev *hdev;
629 /* Initialize and register HCI device */
630 hdev = hci_alloc_dev();
632 BT_ERR("Can't allocate HCI device");
638 hdev->bus = HCI_UART;
639 hci_set_drvdata(hdev, hu);
641 /* Only when vendor specific setup callback is provided, consider
642 * the manufacturer information valid. This avoids filling in the
643 * value for Ericsson when nothing is specified.
645 if (hu->proto->setup)
646 hdev->manufacturer = hu->proto->manufacturer;
648 hdev->open = hci_uart_open;
649 hdev->close = hci_uart_close;
650 hdev->flush = hci_uart_flush;
651 hdev->send = hci_uart_send_frame;
652 hdev->setup = hci_uart_setup;
653 SET_HCIDEV_DEV(hdev, hu->tty->dev);
655 if (test_bit(HCI_UART_RAW_DEVICE, &hu->hdev_flags))
656 set_bit(HCI_QUIRK_RAW_DEVICE, &hdev->quirks);
658 if (test_bit(HCI_UART_EXT_CONFIG, &hu->hdev_flags))
659 set_bit(HCI_QUIRK_EXTERNAL_CONFIG, &hdev->quirks);
661 if (!test_bit(HCI_UART_RESET_ON_INIT, &hu->hdev_flags))
662 set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
664 if (test_bit(HCI_UART_CREATE_AMP, &hu->hdev_flags))
665 hdev->dev_type = HCI_AMP;
667 hdev->dev_type = HCI_PRIMARY;
669 /* Only call open() for the protocol after hdev is fully initialized as
670 * open() (or a timer/workqueue it starts) may attempt to reference it.
672 err = hu->proto->open(hu);
679 if (test_bit(HCI_UART_INIT_PENDING, &hu->hdev_flags))
682 if (hci_register_dev(hdev) < 0) {
683 BT_ERR("Can't register HCI device");
684 hu->proto->close(hu);
690 set_bit(HCI_UART_REGISTERED, &hu->flags);
695 static int hci_uart_set_proto(struct hci_uart *hu, int id)
697 const struct hci_uart_proto *p;
700 p = hci_uart_get_proto(id);
702 return -EPROTONOSUPPORT;
706 err = hci_uart_register_dev(hu);
711 set_bit(HCI_UART_PROTO_READY, &hu->flags);
715 static int hci_uart_set_flags(struct hci_uart *hu, unsigned long flags)
717 unsigned long valid_flags = BIT(HCI_UART_RAW_DEVICE) |
718 BIT(HCI_UART_RESET_ON_INIT) |
719 BIT(HCI_UART_CREATE_AMP) |
720 BIT(HCI_UART_INIT_PENDING) |
721 BIT(HCI_UART_EXT_CONFIG) |
722 BIT(HCI_UART_VND_DETECT);
724 if (flags & ~valid_flags)
727 hu->hdev_flags = flags;
732 /* hci_uart_tty_ioctl()
734 * Process IOCTL system call for the tty device.
738 * tty pointer to tty instance data
739 * file pointer to open file object for device
740 * cmd IOCTL command code
741 * arg argument for IOCTL call (cmd dependent)
743 * Return Value: Command dependent
745 static int hci_uart_tty_ioctl(struct tty_struct *tty, struct file *file,
746 unsigned int cmd, unsigned long arg)
748 struct hci_uart *hu = tty->disc_data;
753 /* Verify the status of the device */
758 case HCIUARTSETPROTO:
759 if (!test_and_set_bit(HCI_UART_PROTO_SET, &hu->flags)) {
760 err = hci_uart_set_proto(hu, arg);
762 clear_bit(HCI_UART_PROTO_SET, &hu->flags);
767 case HCIUARTGETPROTO:
768 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
774 case HCIUARTGETDEVICE:
775 if (test_bit(HCI_UART_REGISTERED, &hu->flags))
781 case HCIUARTSETFLAGS:
782 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
785 err = hci_uart_set_flags(hu, arg);
788 case HCIUARTGETFLAGS:
789 err = hu->hdev_flags;
793 err = n_tty_ioctl_helper(tty, file, cmd, arg);
801 * We don't provide read/write/poll interface for user space.
803 static ssize_t hci_uart_tty_read(struct tty_struct *tty, struct file *file,
804 unsigned char __user *buf, size_t nr)
809 static ssize_t hci_uart_tty_write(struct tty_struct *tty, struct file *file,
810 const unsigned char *data, size_t count)
815 static __poll_t hci_uart_tty_poll(struct tty_struct *tty,
816 struct file *filp, poll_table *wait)
821 static int __init hci_uart_init(void)
823 static struct tty_ldisc_ops hci_uart_ldisc;
826 BT_INFO("HCI UART driver ver %s", VERSION);
828 /* Register the tty discipline */
830 memset(&hci_uart_ldisc, 0, sizeof(hci_uart_ldisc));
831 hci_uart_ldisc.magic = TTY_LDISC_MAGIC;
832 hci_uart_ldisc.name = "n_hci";
833 hci_uart_ldisc.open = hci_uart_tty_open;
834 hci_uart_ldisc.close = hci_uart_tty_close;
835 hci_uart_ldisc.read = hci_uart_tty_read;
836 hci_uart_ldisc.write = hci_uart_tty_write;
837 hci_uart_ldisc.ioctl = hci_uart_tty_ioctl;
838 hci_uart_ldisc.compat_ioctl = hci_uart_tty_ioctl;
839 hci_uart_ldisc.poll = hci_uart_tty_poll;
840 hci_uart_ldisc.receive_buf = hci_uart_tty_receive;
841 hci_uart_ldisc.write_wakeup = hci_uart_tty_wakeup;
842 hci_uart_ldisc.owner = THIS_MODULE;
844 err = tty_register_ldisc(N_HCI, &hci_uart_ldisc);
846 BT_ERR("HCI line discipline registration failed. (%d)", err);
850 #ifdef CONFIG_BT_HCIUART_H4
853 #ifdef CONFIG_BT_HCIUART_BCSP
856 #ifdef CONFIG_BT_HCIUART_LL
859 #ifdef CONFIG_BT_HCIUART_ATH3K
862 #ifdef CONFIG_BT_HCIUART_3WIRE
865 #ifdef CONFIG_BT_HCIUART_INTEL
868 #ifdef CONFIG_BT_HCIUART_BCM
871 #ifdef CONFIG_BT_HCIUART_QCA
874 #ifdef CONFIG_BT_HCIUART_AG6XX
877 #ifdef CONFIG_BT_HCIUART_MRVL
884 static void __exit hci_uart_exit(void)
888 #ifdef CONFIG_BT_HCIUART_H4
891 #ifdef CONFIG_BT_HCIUART_BCSP
894 #ifdef CONFIG_BT_HCIUART_LL
897 #ifdef CONFIG_BT_HCIUART_ATH3K
900 #ifdef CONFIG_BT_HCIUART_3WIRE
903 #ifdef CONFIG_BT_HCIUART_INTEL
906 #ifdef CONFIG_BT_HCIUART_BCM
909 #ifdef CONFIG_BT_HCIUART_QCA
912 #ifdef CONFIG_BT_HCIUART_AG6XX
915 #ifdef CONFIG_BT_HCIUART_MRVL
919 /* Release tty registration of line discipline */
920 err = tty_unregister_ldisc(N_HCI);
922 BT_ERR("Can't unregister HCI line discipline (%d)", err);
925 module_init(hci_uart_init);
926 module_exit(hci_uart_exit);
929 MODULE_DESCRIPTION("Bluetooth HCI UART driver ver " VERSION);
930 MODULE_VERSION(VERSION);
931 MODULE_LICENSE("GPL");
932 MODULE_ALIAS_LDISC(N_HCI);