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 read_lock(&hu->proto_lock);
119 if (test_bit(HCI_UART_PROTO_READY, &hu->flags))
120 skb = hu->proto->dequeue(hu);
122 read_unlock(&hu->proto_lock);
130 int hci_uart_tx_wakeup(struct hci_uart *hu)
132 read_lock(&hu->proto_lock);
134 if (!test_bit(HCI_UART_PROTO_READY, &hu->flags))
137 if (test_and_set_bit(HCI_UART_SENDING, &hu->tx_state)) {
138 set_bit(HCI_UART_TX_WAKEUP, &hu->tx_state);
144 schedule_work(&hu->write_work);
147 read_unlock(&hu->proto_lock);
151 EXPORT_SYMBOL_GPL(hci_uart_tx_wakeup);
153 static void hci_uart_write_work(struct work_struct *work)
155 struct hci_uart *hu = container_of(work, struct hci_uart, write_work);
156 struct tty_struct *tty = hu->tty;
157 struct hci_dev *hdev = hu->hdev;
160 /* REVISIT: should we cope with bad skbs or ->write() returning
165 clear_bit(HCI_UART_TX_WAKEUP, &hu->tx_state);
167 while ((skb = hci_uart_dequeue(hu))) {
170 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
171 len = tty->ops->write(tty, skb->data, skb->len);
172 hdev->stat.byte_tx += len;
180 hci_uart_tx_complete(hu, hci_skb_pkt_type(skb));
184 if (test_bit(HCI_UART_TX_WAKEUP, &hu->tx_state))
187 clear_bit(HCI_UART_SENDING, &hu->tx_state);
190 static void hci_uart_init_work(struct work_struct *work)
192 struct hci_uart *hu = container_of(work, struct hci_uart, init_ready);
194 struct hci_dev *hdev;
196 if (!test_and_clear_bit(HCI_UART_INIT_PENDING, &hu->hdev_flags))
199 err = hci_register_dev(hu->hdev);
201 BT_ERR("Can't register HCI device");
205 clear_bit(HCI_UART_PROTO_READY, &hu->flags);
206 hu->proto->close(hu);
210 set_bit(HCI_UART_REGISTERED, &hu->flags);
213 int hci_uart_init_ready(struct hci_uart *hu)
215 if (!test_bit(HCI_UART_INIT_PENDING, &hu->hdev_flags))
218 schedule_work(&hu->init_ready);
223 /* ------- Interface to HCI layer ------ */
224 /* Initialize device */
225 static int hci_uart_open(struct hci_dev *hdev)
227 BT_DBG("%s %p", hdev->name, hdev);
229 /* Nothing to do for UART driver */
234 static int hci_uart_flush(struct hci_dev *hdev)
236 struct hci_uart *hu = hci_get_drvdata(hdev);
237 struct tty_struct *tty = hu->tty;
239 BT_DBG("hdev %p tty %p", hdev, tty);
242 kfree_skb(hu->tx_skb); hu->tx_skb = NULL;
245 /* Flush any pending characters in the driver and discipline. */
246 tty_ldisc_flush(tty);
247 tty_driver_flush_buffer(tty);
249 read_lock(&hu->proto_lock);
251 if (test_bit(HCI_UART_PROTO_READY, &hu->flags))
252 hu->proto->flush(hu);
254 read_unlock(&hu->proto_lock);
260 static int hci_uart_close(struct hci_dev *hdev)
262 BT_DBG("hdev %p", hdev);
264 hci_uart_flush(hdev);
269 /* Send frames from HCI layer */
270 static int hci_uart_send_frame(struct hci_dev *hdev, struct sk_buff *skb)
272 struct hci_uart *hu = hci_get_drvdata(hdev);
274 BT_DBG("%s: type %d len %d", hdev->name, hci_skb_pkt_type(skb),
277 read_lock(&hu->proto_lock);
279 if (!test_bit(HCI_UART_PROTO_READY, &hu->flags)) {
280 read_unlock(&hu->proto_lock);
284 hu->proto->enqueue(hu, skb);
285 read_unlock(&hu->proto_lock);
287 hci_uart_tx_wakeup(hu);
292 /* Flow control or un-flow control the device */
293 void hci_uart_set_flow_control(struct hci_uart *hu, bool enable)
295 struct tty_struct *tty = hu->tty;
296 struct ktermios ktermios;
298 unsigned int set = 0;
299 unsigned int clear = 0;
302 /* Disable hardware flow control */
303 ktermios = tty->termios;
304 ktermios.c_cflag &= ~CRTSCTS;
305 status = tty_set_termios(tty, &ktermios);
306 BT_DBG("Disabling hardware flow control: %s",
307 status ? "failed" : "success");
309 /* Clear RTS to prevent the device from sending */
310 /* Most UARTs need OUT2 to enable interrupts */
311 status = tty->driver->ops->tiocmget(tty);
312 BT_DBG("Current tiocm 0x%x", status);
314 set &= ~(TIOCM_OUT2 | TIOCM_RTS);
316 set &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
317 TIOCM_OUT2 | TIOCM_LOOP;
318 clear &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
319 TIOCM_OUT2 | TIOCM_LOOP;
320 status = tty->driver->ops->tiocmset(tty, set, clear);
321 BT_DBG("Clearing RTS: %s", status ? "failed" : "success");
323 /* Set RTS to allow the device to send again */
324 status = tty->driver->ops->tiocmget(tty);
325 BT_DBG("Current tiocm 0x%x", status);
327 set |= (TIOCM_OUT2 | TIOCM_RTS);
329 set &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
330 TIOCM_OUT2 | TIOCM_LOOP;
331 clear &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
332 TIOCM_OUT2 | TIOCM_LOOP;
333 status = tty->driver->ops->tiocmset(tty, set, clear);
334 BT_DBG("Setting RTS: %s", status ? "failed" : "success");
336 /* Re-enable hardware flow control */
337 ktermios = tty->termios;
338 ktermios.c_cflag |= CRTSCTS;
339 status = tty_set_termios(tty, &ktermios);
340 BT_DBG("Enabling hardware flow control: %s",
341 status ? "failed" : "success");
345 void hci_uart_set_speeds(struct hci_uart *hu, unsigned int init_speed,
346 unsigned int oper_speed)
348 hu->init_speed = init_speed;
349 hu->oper_speed = oper_speed;
352 void hci_uart_set_baudrate(struct hci_uart *hu, unsigned int speed)
354 struct tty_struct *tty = hu->tty;
355 struct ktermios ktermios;
357 ktermios = tty->termios;
358 ktermios.c_cflag &= ~CBAUD;
359 tty_termios_encode_baud_rate(&ktermios, speed, speed);
361 /* tty_set_termios() return not checked as it is always 0 */
362 tty_set_termios(tty, &ktermios);
364 BT_DBG("%s: New tty speeds: %d/%d", hu->hdev->name,
365 tty->termios.c_ispeed, tty->termios.c_ospeed);
368 static int hci_uart_setup(struct hci_dev *hdev)
370 struct hci_uart *hu = hci_get_drvdata(hdev);
371 struct hci_rp_read_local_version *ver;
376 /* Init speed if any */
378 speed = hu->init_speed;
379 else if (hu->proto->init_speed)
380 speed = hu->proto->init_speed;
385 hci_uart_set_baudrate(hu, speed);
387 /* Operational speed if any */
389 speed = hu->oper_speed;
390 else if (hu->proto->oper_speed)
391 speed = hu->proto->oper_speed;
395 if (hu->proto->set_baudrate && speed) {
396 err = hu->proto->set_baudrate(hu, speed);
398 hci_uart_set_baudrate(hu, speed);
401 if (hu->proto->setup)
402 return hu->proto->setup(hu);
404 if (!test_bit(HCI_UART_VND_DETECT, &hu->hdev_flags))
407 skb = __hci_cmd_sync(hdev, HCI_OP_READ_LOCAL_VERSION, 0, NULL,
410 BT_ERR("%s: Reading local version information failed (%ld)",
411 hdev->name, PTR_ERR(skb));
415 if (skb->len != sizeof(*ver)) {
416 BT_ERR("%s: Event length mismatch for version information",
421 ver = (struct hci_rp_read_local_version *)skb->data;
423 switch (le16_to_cpu(ver->manufacturer)) {
424 #ifdef CONFIG_BT_HCIUART_INTEL
426 hdev->set_bdaddr = btintel_set_bdaddr;
427 btintel_check_bdaddr(hdev);
430 #ifdef CONFIG_BT_HCIUART_BCM
432 hdev->set_bdaddr = btbcm_set_bdaddr;
433 btbcm_check_bdaddr(hdev);
443 /* ------ LDISC part ------ */
446 * Called when line discipline changed to HCI_UART.
449 * tty pointer to tty info structure
451 * 0 if success, otherwise error code
453 static int hci_uart_tty_open(struct tty_struct *tty)
457 BT_DBG("tty %p", tty);
459 /* Error if the tty has no write op instead of leaving an exploitable
462 if (tty->ops->write == NULL)
465 hu = kzalloc(sizeof(struct hci_uart), GFP_KERNEL);
467 BT_ERR("Can't allocate control structure");
473 tty->receive_room = 65536;
475 /* disable alignment support by default */
479 INIT_WORK(&hu->init_ready, hci_uart_init_work);
480 INIT_WORK(&hu->write_work, hci_uart_write_work);
482 rwlock_init(&hu->proto_lock);
484 /* Flush any pending characters in the driver */
485 tty_driver_flush_buffer(tty);
490 /* hci_uart_tty_close()
492 * Called when the line discipline is changed to something
493 * else, the tty is closed, or the tty detects a hangup.
495 static void hci_uart_tty_close(struct tty_struct *tty)
497 struct hci_uart *hu = tty->disc_data;
498 struct hci_dev *hdev;
501 BT_DBG("tty %p", tty);
503 /* Detach from the tty */
504 tty->disc_data = NULL;
511 hci_uart_close(hdev);
513 cancel_work_sync(&hu->write_work);
515 if (test_bit(HCI_UART_PROTO_READY, &hu->flags)) {
516 write_lock_irqsave(&hu->proto_lock, flags);
517 clear_bit(HCI_UART_PROTO_READY, &hu->flags);
518 write_unlock_irqrestore(&hu->proto_lock, flags);
521 if (test_bit(HCI_UART_REGISTERED, &hu->flags))
522 hci_unregister_dev(hdev);
525 hu->proto->close(hu);
527 clear_bit(HCI_UART_PROTO_SET, &hu->flags);
532 /* hci_uart_tty_wakeup()
534 * Callback for transmit wakeup. Called when low level
535 * device driver can accept more send data.
537 * Arguments: tty pointer to associated tty instance data
540 static void hci_uart_tty_wakeup(struct tty_struct *tty)
542 struct hci_uart *hu = tty->disc_data;
549 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
554 if (test_bit(HCI_UART_PROTO_READY, &hu->flags))
555 hci_uart_tx_wakeup(hu);
558 /* hci_uart_tty_receive()
560 * Called by tty low level driver when receive data is
563 * Arguments: tty pointer to tty isntance data
564 * data pointer to received data
565 * flags pointer to flags for data
566 * count count of received data in bytes
570 static void hci_uart_tty_receive(struct tty_struct *tty, const u8 *data,
571 char *flags, int count)
573 struct hci_uart *hu = tty->disc_data;
575 if (!hu || tty != hu->tty)
578 read_lock(&hu->proto_lock);
580 if (!test_bit(HCI_UART_PROTO_READY, &hu->flags)) {
581 read_unlock(&hu->proto_lock);
585 /* It does not need a lock here as it is already protected by a mutex in
588 hu->proto->recv(hu, data, count);
589 read_unlock(&hu->proto_lock);
592 hu->hdev->stat.byte_rx += count;
597 static int hci_uart_register_dev(struct hci_uart *hu)
599 struct hci_dev *hdev;
603 /* Initialize and register HCI device */
604 hdev = hci_alloc_dev();
606 BT_ERR("Can't allocate HCI device");
612 hdev->bus = HCI_UART;
613 hci_set_drvdata(hdev, hu);
615 /* Only when vendor specific setup callback is provided, consider
616 * the manufacturer information valid. This avoids filling in the
617 * value for Ericsson when nothing is specified.
619 if (hu->proto->setup)
620 hdev->manufacturer = hu->proto->manufacturer;
622 hdev->open = hci_uart_open;
623 hdev->close = hci_uart_close;
624 hdev->flush = hci_uart_flush;
625 hdev->send = hci_uart_send_frame;
626 hdev->setup = hci_uart_setup;
627 SET_HCIDEV_DEV(hdev, hu->tty->dev);
629 if (test_bit(HCI_UART_RAW_DEVICE, &hu->hdev_flags))
630 set_bit(HCI_QUIRK_RAW_DEVICE, &hdev->quirks);
632 if (test_bit(HCI_UART_EXT_CONFIG, &hu->hdev_flags))
633 set_bit(HCI_QUIRK_EXTERNAL_CONFIG, &hdev->quirks);
635 if (!test_bit(HCI_UART_RESET_ON_INIT, &hu->hdev_flags))
636 set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
638 if (test_bit(HCI_UART_CREATE_AMP, &hu->hdev_flags))
639 hdev->dev_type = HCI_AMP;
641 hdev->dev_type = HCI_PRIMARY;
643 if (test_bit(HCI_UART_INIT_PENDING, &hu->hdev_flags))
646 if (hci_register_dev(hdev) < 0) {
647 BT_ERR("Can't register HCI device");
653 set_bit(HCI_UART_REGISTERED, &hu->flags);
658 static int hci_uart_set_proto(struct hci_uart *hu, int id)
660 const struct hci_uart_proto *p;
663 p = hci_uart_get_proto(id);
665 return -EPROTONOSUPPORT;
672 set_bit(HCI_UART_PROTO_READY, &hu->flags);
674 err = hci_uart_register_dev(hu);
676 clear_bit(HCI_UART_PROTO_READY, &hu->flags);
684 static int hci_uart_set_flags(struct hci_uart *hu, unsigned long flags)
686 unsigned long valid_flags = BIT(HCI_UART_RAW_DEVICE) |
687 BIT(HCI_UART_RESET_ON_INIT) |
688 BIT(HCI_UART_CREATE_AMP) |
689 BIT(HCI_UART_INIT_PENDING) |
690 BIT(HCI_UART_EXT_CONFIG) |
691 BIT(HCI_UART_VND_DETECT);
693 if (flags & ~valid_flags)
696 hu->hdev_flags = flags;
701 /* hci_uart_tty_ioctl()
703 * Process IOCTL system call for the tty device.
707 * tty pointer to tty instance data
708 * file pointer to open file object for device
709 * cmd IOCTL command code
710 * arg argument for IOCTL call (cmd dependent)
712 * Return Value: Command dependent
714 static int hci_uart_tty_ioctl(struct tty_struct *tty, struct file *file,
715 unsigned int cmd, unsigned long arg)
717 struct hci_uart *hu = tty->disc_data;
722 /* Verify the status of the device */
727 case HCIUARTSETPROTO:
728 if (!test_and_set_bit(HCI_UART_PROTO_SET, &hu->flags)) {
729 err = hci_uart_set_proto(hu, arg);
731 clear_bit(HCI_UART_PROTO_SET, &hu->flags);
736 case HCIUARTGETPROTO:
737 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
743 case HCIUARTGETDEVICE:
744 if (test_bit(HCI_UART_REGISTERED, &hu->flags))
750 case HCIUARTSETFLAGS:
751 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
754 err = hci_uart_set_flags(hu, arg);
757 case HCIUARTGETFLAGS:
758 err = hu->hdev_flags;
762 err = n_tty_ioctl_helper(tty, file, cmd, arg);
770 * We don't provide read/write/poll interface for user space.
772 static ssize_t hci_uart_tty_read(struct tty_struct *tty, struct file *file,
773 unsigned char __user *buf, size_t nr)
778 static ssize_t hci_uart_tty_write(struct tty_struct *tty, struct file *file,
779 const unsigned char *data, size_t count)
784 static unsigned int hci_uart_tty_poll(struct tty_struct *tty,
785 struct file *filp, poll_table *wait)
790 static int __init hci_uart_init(void)
792 static struct tty_ldisc_ops hci_uart_ldisc;
795 BT_INFO("HCI UART driver ver %s", VERSION);
797 /* Register the tty discipline */
799 memset(&hci_uart_ldisc, 0, sizeof(hci_uart_ldisc));
800 hci_uart_ldisc.magic = TTY_LDISC_MAGIC;
801 hci_uart_ldisc.name = "n_hci";
802 hci_uart_ldisc.open = hci_uart_tty_open;
803 hci_uart_ldisc.close = hci_uart_tty_close;
804 hci_uart_ldisc.read = hci_uart_tty_read;
805 hci_uart_ldisc.write = hci_uart_tty_write;
806 hci_uart_ldisc.ioctl = hci_uart_tty_ioctl;
807 hci_uart_ldisc.poll = hci_uart_tty_poll;
808 hci_uart_ldisc.receive_buf = hci_uart_tty_receive;
809 hci_uart_ldisc.write_wakeup = hci_uart_tty_wakeup;
810 hci_uart_ldisc.owner = THIS_MODULE;
812 err = tty_register_ldisc(N_HCI, &hci_uart_ldisc);
814 BT_ERR("HCI line discipline registration failed. (%d)", err);
818 #ifdef CONFIG_BT_HCIUART_H4
821 #ifdef CONFIG_BT_HCIUART_BCSP
824 #ifdef CONFIG_BT_HCIUART_LL
827 #ifdef CONFIG_BT_HCIUART_ATH3K
830 #ifdef CONFIG_BT_HCIUART_3WIRE
833 #ifdef CONFIG_BT_HCIUART_INTEL
836 #ifdef CONFIG_BT_HCIUART_BCM
839 #ifdef CONFIG_BT_HCIUART_QCA
842 #ifdef CONFIG_BT_HCIUART_AG6XX
845 #ifdef CONFIG_BT_HCIUART_MRVL
852 static void __exit hci_uart_exit(void)
856 #ifdef CONFIG_BT_HCIUART_H4
859 #ifdef CONFIG_BT_HCIUART_BCSP
862 #ifdef CONFIG_BT_HCIUART_LL
865 #ifdef CONFIG_BT_HCIUART_ATH3K
868 #ifdef CONFIG_BT_HCIUART_3WIRE
871 #ifdef CONFIG_BT_HCIUART_INTEL
874 #ifdef CONFIG_BT_HCIUART_BCM
877 #ifdef CONFIG_BT_HCIUART_QCA
880 #ifdef CONFIG_BT_HCIUART_AG6XX
883 #ifdef CONFIG_BT_HCIUART_MRVL
887 /* Release tty registration of line discipline */
888 err = tty_unregister_ldisc(N_HCI);
890 BT_ERR("Can't unregister HCI line discipline (%d)", err);
893 module_init(hci_uart_init);
894 module_exit(hci_uart_exit);
896 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
897 MODULE_DESCRIPTION("Bluetooth HCI UART driver ver " VERSION);
898 MODULE_VERSION(VERSION);
899 MODULE_LICENSE("GPL");
900 MODULE_ALIAS_LDISC(N_HCI);