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>
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 skb = hu->proto->dequeue(hu);
124 int hci_uart_tx_wakeup(struct hci_uart *hu)
126 if (test_and_set_bit(HCI_UART_SENDING, &hu->tx_state)) {
127 set_bit(HCI_UART_TX_WAKEUP, &hu->tx_state);
133 schedule_work(&hu->write_work);
138 static void hci_uart_write_work(struct work_struct *work)
140 struct hci_uart *hu = container_of(work, struct hci_uart, write_work);
141 struct tty_struct *tty = hu->tty;
142 struct hci_dev *hdev = hu->hdev;
145 /* REVISIT: should we cope with bad skbs or ->write() returning
150 clear_bit(HCI_UART_TX_WAKEUP, &hu->tx_state);
152 while ((skb = hci_uart_dequeue(hu))) {
155 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
156 len = tty->ops->write(tty, skb->data, skb->len);
157 hdev->stat.byte_tx += len;
165 hci_uart_tx_complete(hu, hci_skb_pkt_type(skb));
169 if (test_bit(HCI_UART_TX_WAKEUP, &hu->tx_state))
172 clear_bit(HCI_UART_SENDING, &hu->tx_state);
175 static void hci_uart_init_work(struct work_struct *work)
177 struct hci_uart *hu = container_of(work, struct hci_uart, init_ready);
180 if (!test_and_clear_bit(HCI_UART_INIT_PENDING, &hu->hdev_flags))
183 err = hci_register_dev(hu->hdev);
185 BT_ERR("Can't register HCI device");
186 hci_free_dev(hu->hdev);
188 hu->proto->close(hu);
191 set_bit(HCI_UART_REGISTERED, &hu->flags);
194 int hci_uart_init_ready(struct hci_uart *hu)
196 if (!test_bit(HCI_UART_INIT_PENDING, &hu->hdev_flags))
199 schedule_work(&hu->init_ready);
204 /* ------- Interface to HCI layer ------ */
205 /* Initialize device */
206 static int hci_uart_open(struct hci_dev *hdev)
208 BT_DBG("%s %p", hdev->name, hdev);
210 /* Nothing to do for UART driver */
215 static int hci_uart_flush(struct hci_dev *hdev)
217 struct hci_uart *hu = hci_get_drvdata(hdev);
218 struct tty_struct *tty = hu->tty;
220 BT_DBG("hdev %p tty %p", hdev, tty);
223 kfree_skb(hu->tx_skb); hu->tx_skb = NULL;
226 /* Flush any pending characters in the driver and discipline. */
227 tty_ldisc_flush(tty);
228 tty_driver_flush_buffer(tty);
230 if (test_bit(HCI_UART_PROTO_READY, &hu->flags))
231 hu->proto->flush(hu);
237 static int hci_uart_close(struct hci_dev *hdev)
239 BT_DBG("hdev %p", hdev);
241 hci_uart_flush(hdev);
246 /* Send frames from HCI layer */
247 static int hci_uart_send_frame(struct hci_dev *hdev, struct sk_buff *skb)
249 struct hci_uart *hu = hci_get_drvdata(hdev);
251 BT_DBG("%s: type %d len %d", hdev->name, hci_skb_pkt_type(skb),
254 hu->proto->enqueue(hu, skb);
256 hci_uart_tx_wakeup(hu);
261 /* Flow control or un-flow control the device */
262 void hci_uart_set_flow_control(struct hci_uart *hu, bool enable)
264 struct tty_struct *tty = hu->tty;
265 struct ktermios ktermios;
267 unsigned int set = 0;
268 unsigned int clear = 0;
271 /* Disable hardware flow control */
272 ktermios = tty->termios;
273 ktermios.c_cflag &= ~CRTSCTS;
274 status = tty_set_termios(tty, &ktermios);
275 BT_DBG("Disabling hardware flow control: %s",
276 status ? "failed" : "success");
278 /* Clear RTS to prevent the device from sending */
279 /* Most UARTs need OUT2 to enable interrupts */
280 status = tty->driver->ops->tiocmget(tty);
281 BT_DBG("Current tiocm 0x%x", status);
283 set &= ~(TIOCM_OUT2 | TIOCM_RTS);
285 set &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
286 TIOCM_OUT2 | TIOCM_LOOP;
287 clear &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
288 TIOCM_OUT2 | TIOCM_LOOP;
289 status = tty->driver->ops->tiocmset(tty, set, clear);
290 BT_DBG("Clearing RTS: %s", status ? "failed" : "success");
292 /* Set RTS to allow the device to send again */
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("Setting RTS: %s", status ? "failed" : "success");
305 /* Re-enable hardware flow control */
306 ktermios = tty->termios;
307 ktermios.c_cflag |= CRTSCTS;
308 status = tty_set_termios(tty, &ktermios);
309 BT_DBG("Enabling hardware flow control: %s",
310 status ? "failed" : "success");
314 void hci_uart_set_speeds(struct hci_uart *hu, unsigned int init_speed,
315 unsigned int oper_speed)
317 hu->init_speed = init_speed;
318 hu->oper_speed = oper_speed;
321 void hci_uart_init_tty(struct hci_uart *hu)
323 struct tty_struct *tty = hu->tty;
324 struct ktermios ktermios;
326 /* Bring the UART into a known 8 bits no parity hw fc state */
327 ktermios = tty->termios;
328 ktermios.c_iflag &= ~(IGNBRK | BRKINT | PARMRK | ISTRIP |
329 INLCR | IGNCR | ICRNL | IXON);
330 ktermios.c_oflag &= ~OPOST;
331 ktermios.c_lflag &= ~(ECHO | ECHONL | ICANON | ISIG | IEXTEN);
332 ktermios.c_cflag &= ~(CSIZE | PARENB);
333 ktermios.c_cflag |= CS8;
334 ktermios.c_cflag |= CRTSCTS;
336 /* tty_set_termios() return not checked as it is always 0 */
337 tty_set_termios(tty, &ktermios);
340 void hci_uart_set_baudrate(struct hci_uart *hu, unsigned int speed)
342 struct tty_struct *tty = hu->tty;
343 struct ktermios ktermios;
345 ktermios = tty->termios;
346 ktermios.c_cflag &= ~CBAUD;
347 tty_termios_encode_baud_rate(&ktermios, speed, speed);
349 /* tty_set_termios() return not checked as it is always 0 */
350 tty_set_termios(tty, &ktermios);
352 BT_DBG("%s: New tty speeds: %d/%d", hu->hdev->name,
353 tty->termios.c_ispeed, tty->termios.c_ospeed);
356 static int hci_uart_setup(struct hci_dev *hdev)
358 struct hci_uart *hu = hci_get_drvdata(hdev);
359 struct hci_rp_read_local_version *ver;
364 /* Init speed if any */
366 speed = hu->init_speed;
367 else if (hu->proto->init_speed)
368 speed = hu->proto->init_speed;
373 hci_uart_set_baudrate(hu, speed);
375 /* Operational speed if any */
377 speed = hu->oper_speed;
378 else if (hu->proto->oper_speed)
379 speed = hu->proto->oper_speed;
383 if (hu->proto->set_baudrate && speed) {
384 err = hu->proto->set_baudrate(hu, speed);
386 hci_uart_set_baudrate(hu, speed);
389 if (hu->proto->setup)
390 return hu->proto->setup(hu);
392 if (!test_bit(HCI_UART_VND_DETECT, &hu->hdev_flags))
395 skb = __hci_cmd_sync(hdev, HCI_OP_READ_LOCAL_VERSION, 0, NULL,
398 BT_ERR("%s: Reading local version information failed (%ld)",
399 hdev->name, PTR_ERR(skb));
403 if (skb->len != sizeof(*ver)) {
404 BT_ERR("%s: Event length mismatch for version information",
409 ver = (struct hci_rp_read_local_version *)skb->data;
411 switch (le16_to_cpu(ver->manufacturer)) {
412 #ifdef CONFIG_BT_HCIUART_INTEL
414 hdev->set_bdaddr = btintel_set_bdaddr;
415 btintel_check_bdaddr(hdev);
418 #ifdef CONFIG_BT_HCIUART_BCM
420 hdev->set_bdaddr = btbcm_set_bdaddr;
421 btbcm_check_bdaddr(hdev);
431 /* ------ LDISC part ------ */
434 * Called when line discipline changed to HCI_UART.
437 * tty pointer to tty info structure
439 * 0 if success, otherwise error code
441 static int hci_uart_tty_open(struct tty_struct *tty)
445 BT_DBG("tty %p", tty);
447 /* Error if the tty has no write op instead of leaving an exploitable
449 if (tty->ops->write == NULL)
452 hu = kzalloc(sizeof(struct hci_uart), GFP_KERNEL);
454 BT_ERR("Can't allocate control structure");
460 tty->receive_room = 65536;
462 INIT_WORK(&hu->init_ready, hci_uart_init_work);
463 INIT_WORK(&hu->write_work, hci_uart_write_work);
465 /* Flush any pending characters in the driver */
466 tty_driver_flush_buffer(tty);
471 /* hci_uart_tty_close()
473 * Called when the line discipline is changed to something
474 * else, the tty is closed, or the tty detects a hangup.
476 static void hci_uart_tty_close(struct tty_struct *tty)
478 struct hci_uart *hu = tty->disc_data;
479 struct hci_dev *hdev;
481 BT_DBG("tty %p", tty);
483 /* Detach from the tty */
484 tty->disc_data = NULL;
491 hci_uart_close(hdev);
493 cancel_work_sync(&hu->write_work);
495 if (test_and_clear_bit(HCI_UART_PROTO_READY, &hu->flags)) {
497 if (test_bit(HCI_UART_REGISTERED, &hu->flags))
498 hci_unregister_dev(hdev);
501 hu->proto->close(hu);
503 clear_bit(HCI_UART_PROTO_SET, &hu->flags);
508 /* hci_uart_tty_wakeup()
510 * Callback for transmit wakeup. Called when low level
511 * device driver can accept more send data.
513 * Arguments: tty pointer to associated tty instance data
516 static void hci_uart_tty_wakeup(struct tty_struct *tty)
518 struct hci_uart *hu = tty->disc_data;
525 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
530 if (test_bit(HCI_UART_PROTO_READY, &hu->flags))
531 hci_uart_tx_wakeup(hu);
534 /* hci_uart_tty_receive()
536 * Called by tty low level driver when receive data is
539 * Arguments: tty pointer to tty isntance data
540 * data pointer to received data
541 * flags pointer to flags for data
542 * count count of received data in bytes
546 static void hci_uart_tty_receive(struct tty_struct *tty, const u8 *data,
547 char *flags, int count)
549 struct hci_uart *hu = tty->disc_data;
551 if (!hu || tty != hu->tty)
554 if (!test_bit(HCI_UART_PROTO_READY, &hu->flags))
557 /* It does not need a lock here as it is already protected by a mutex in
560 hu->proto->recv(hu, data, count);
563 hu->hdev->stat.byte_rx += count;
568 static int hci_uart_register_dev(struct hci_uart *hu)
570 struct hci_dev *hdev;
574 /* Initialize and register HCI device */
575 hdev = hci_alloc_dev();
577 BT_ERR("Can't allocate HCI device");
583 hdev->bus = HCI_UART;
584 hci_set_drvdata(hdev, hu);
586 /* Only when vendor specific setup callback is provided, consider
587 * the manufacturer information valid. This avoids filling in the
588 * value for Ericsson when nothing is specified.
590 if (hu->proto->setup)
591 hdev->manufacturer = hu->proto->manufacturer;
593 hdev->open = hci_uart_open;
594 hdev->close = hci_uart_close;
595 hdev->flush = hci_uart_flush;
596 hdev->send = hci_uart_send_frame;
597 hdev->setup = hci_uart_setup;
598 SET_HCIDEV_DEV(hdev, hu->tty->dev);
600 if (test_bit(HCI_UART_RAW_DEVICE, &hu->hdev_flags))
601 set_bit(HCI_QUIRK_RAW_DEVICE, &hdev->quirks);
603 if (test_bit(HCI_UART_EXT_CONFIG, &hu->hdev_flags))
604 set_bit(HCI_QUIRK_EXTERNAL_CONFIG, &hdev->quirks);
606 if (!test_bit(HCI_UART_RESET_ON_INIT, &hu->hdev_flags))
607 set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
609 if (test_bit(HCI_UART_CREATE_AMP, &hu->hdev_flags))
610 hdev->dev_type = HCI_AMP;
612 hdev->dev_type = HCI_PRIMARY;
614 if (test_bit(HCI_UART_INIT_PENDING, &hu->hdev_flags))
617 if (hci_register_dev(hdev) < 0) {
618 BT_ERR("Can't register HCI device");
623 set_bit(HCI_UART_REGISTERED, &hu->flags);
628 static int hci_uart_set_proto(struct hci_uart *hu, int id)
630 const struct hci_uart_proto *p;
633 p = hci_uart_get_proto(id);
635 return -EPROTONOSUPPORT;
642 set_bit(HCI_UART_PROTO_READY, &hu->flags);
644 err = hci_uart_register_dev(hu);
646 clear_bit(HCI_UART_PROTO_READY, &hu->flags);
654 static int hci_uart_set_flags(struct hci_uart *hu, unsigned long flags)
656 unsigned long valid_flags = BIT(HCI_UART_RAW_DEVICE) |
657 BIT(HCI_UART_RESET_ON_INIT) |
658 BIT(HCI_UART_CREATE_AMP) |
659 BIT(HCI_UART_INIT_PENDING) |
660 BIT(HCI_UART_EXT_CONFIG) |
661 BIT(HCI_UART_VND_DETECT);
663 if (flags & ~valid_flags)
666 hu->hdev_flags = flags;
671 /* hci_uart_tty_ioctl()
673 * Process IOCTL system call for the tty device.
677 * tty pointer to tty instance data
678 * file pointer to open file object for device
679 * cmd IOCTL command code
680 * arg argument for IOCTL call (cmd dependent)
682 * Return Value: Command dependent
684 static int hci_uart_tty_ioctl(struct tty_struct *tty, struct file *file,
685 unsigned int cmd, unsigned long arg)
687 struct hci_uart *hu = tty->disc_data;
692 /* Verify the status of the device */
697 case HCIUARTSETPROTO:
698 if (!test_and_set_bit(HCI_UART_PROTO_SET, &hu->flags)) {
699 err = hci_uart_set_proto(hu, arg);
701 clear_bit(HCI_UART_PROTO_SET, &hu->flags);
706 case HCIUARTGETPROTO:
707 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
713 case HCIUARTGETDEVICE:
714 if (test_bit(HCI_UART_REGISTERED, &hu->flags))
720 case HCIUARTSETFLAGS:
721 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
724 err = hci_uart_set_flags(hu, arg);
727 case HCIUARTGETFLAGS:
728 err = hu->hdev_flags;
732 err = n_tty_ioctl_helper(tty, file, cmd, arg);
740 * We don't provide read/write/poll interface for user space.
742 static ssize_t hci_uart_tty_read(struct tty_struct *tty, struct file *file,
743 unsigned char __user *buf, size_t nr)
748 static ssize_t hci_uart_tty_write(struct tty_struct *tty, struct file *file,
749 const unsigned char *data, size_t count)
754 static unsigned int hci_uart_tty_poll(struct tty_struct *tty,
755 struct file *filp, poll_table *wait)
760 static int __init hci_uart_init(void)
762 static struct tty_ldisc_ops hci_uart_ldisc;
765 BT_INFO("HCI UART driver ver %s", VERSION);
767 /* Register the tty discipline */
769 memset(&hci_uart_ldisc, 0, sizeof(hci_uart_ldisc));
770 hci_uart_ldisc.magic = TTY_LDISC_MAGIC;
771 hci_uart_ldisc.name = "n_hci";
772 hci_uart_ldisc.open = hci_uart_tty_open;
773 hci_uart_ldisc.close = hci_uart_tty_close;
774 hci_uart_ldisc.read = hci_uart_tty_read;
775 hci_uart_ldisc.write = hci_uart_tty_write;
776 hci_uart_ldisc.ioctl = hci_uart_tty_ioctl;
777 hci_uart_ldisc.poll = hci_uart_tty_poll;
778 hci_uart_ldisc.receive_buf = hci_uart_tty_receive;
779 hci_uart_ldisc.write_wakeup = hci_uart_tty_wakeup;
780 hci_uart_ldisc.owner = THIS_MODULE;
782 err = tty_register_ldisc(N_HCI, &hci_uart_ldisc);
784 BT_ERR("HCI line discipline registration failed. (%d)", err);
788 #ifdef CONFIG_BT_HCIUART_H4
791 #ifdef CONFIG_BT_HCIUART_BCSP
794 #ifdef CONFIG_BT_HCIUART_LL
797 #ifdef CONFIG_BT_HCIUART_ATH3K
800 #ifdef CONFIG_BT_HCIUART_3WIRE
803 #ifdef CONFIG_BT_HCIUART_INTEL
806 #ifdef CONFIG_BT_HCIUART_BCM
809 #ifdef CONFIG_BT_HCIUART_QCA
812 #ifdef CONFIG_BT_HCIUART_AG6XX
815 #ifdef CONFIG_BT_HCIUART_MRVL
822 static void __exit hci_uart_exit(void)
826 #ifdef CONFIG_BT_HCIUART_H4
829 #ifdef CONFIG_BT_HCIUART_BCSP
832 #ifdef CONFIG_BT_HCIUART_LL
835 #ifdef CONFIG_BT_HCIUART_ATH3K
838 #ifdef CONFIG_BT_HCIUART_3WIRE
841 #ifdef CONFIG_BT_HCIUART_INTEL
844 #ifdef CONFIG_BT_HCIUART_BCM
847 #ifdef CONFIG_BT_HCIUART_QCA
850 #ifdef CONFIG_BT_HCIUART_AG6XX
853 #ifdef CONFIG_BT_HCIUART_MRVL
857 /* Release tty registration of line discipline */
858 err = tty_unregister_ldisc(N_HCI);
860 BT_ERR("Can't unregister HCI line discipline (%d)", err);
863 module_init(hci_uart_init);
864 module_exit(hci_uart_exit);
867 MODULE_DESCRIPTION("Bluetooth HCI UART driver ver " VERSION);
868 MODULE_VERSION(VERSION);
869 MODULE_LICENSE("GPL");
870 MODULE_ALIAS_LDISC(N_HCI);