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 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, bt_cb(skb)->pkt_type);
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 */
212 set_bit(HCI_RUNNING, &hdev->flags);
218 static int hci_uart_flush(struct hci_dev *hdev)
220 struct hci_uart *hu = hci_get_drvdata(hdev);
221 struct tty_struct *tty = hu->tty;
223 BT_DBG("hdev %p tty %p", hdev, tty);
226 kfree_skb(hu->tx_skb); hu->tx_skb = NULL;
229 /* Flush any pending characters in the driver and discipline. */
230 tty_ldisc_flush(tty);
231 tty_driver_flush_buffer(tty);
233 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
234 hu->proto->flush(hu);
240 static int hci_uart_close(struct hci_dev *hdev)
242 BT_DBG("hdev %p", hdev);
244 if (!test_and_clear_bit(HCI_RUNNING, &hdev->flags))
247 hci_uart_flush(hdev);
252 /* Send frames from HCI layer */
253 static int hci_uart_send_frame(struct hci_dev *hdev, struct sk_buff *skb)
255 struct hci_uart *hu = hci_get_drvdata(hdev);
257 if (!test_bit(HCI_RUNNING, &hdev->flags))
260 BT_DBG("%s: type %d len %d", hdev->name, bt_cb(skb)->pkt_type, skb->len);
262 hu->proto->enqueue(hu, skb);
264 hci_uart_tx_wakeup(hu);
269 /* Flow control or un-flow control the device */
270 void hci_uart_set_flow_control(struct hci_uart *hu, bool enable)
272 struct tty_struct *tty = hu->tty;
273 struct ktermios ktermios;
275 unsigned int set = 0;
276 unsigned int clear = 0;
279 /* Disable hardware flow control */
280 ktermios = tty->termios;
281 ktermios.c_cflag &= ~CRTSCTS;
282 status = tty_set_termios(tty, &ktermios);
283 BT_DBG("Disabling hardware flow control: %s",
284 status ? "failed" : "success");
286 /* Clear RTS to prevent the device from sending */
287 /* Most UARTs need OUT2 to enable interrupts */
288 status = tty->driver->ops->tiocmget(tty);
289 BT_DBG("Current tiocm 0x%x", status);
291 set &= ~(TIOCM_OUT2 | TIOCM_RTS);
293 set &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
294 TIOCM_OUT2 | TIOCM_LOOP;
295 clear &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
296 TIOCM_OUT2 | TIOCM_LOOP;
297 status = tty->driver->ops->tiocmset(tty, set, clear);
298 BT_DBG("Clearing RTS: %s", status ? "failed" : "success");
300 /* Set RTS to allow the device to send again */
301 status = tty->driver->ops->tiocmget(tty);
302 BT_DBG("Current tiocm 0x%x", status);
304 set |= (TIOCM_OUT2 | TIOCM_RTS);
306 set &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
307 TIOCM_OUT2 | TIOCM_LOOP;
308 clear &= TIOCM_DTR | TIOCM_RTS | TIOCM_OUT1 |
309 TIOCM_OUT2 | TIOCM_LOOP;
310 status = tty->driver->ops->tiocmset(tty, set, clear);
311 BT_DBG("Setting RTS: %s", status ? "failed" : "success");
313 /* Re-enable hardware flow control */
314 ktermios = tty->termios;
315 ktermios.c_cflag |= CRTSCTS;
316 status = tty_set_termios(tty, &ktermios);
317 BT_DBG("Enabling hardware flow control: %s",
318 status ? "failed" : "success");
322 void hci_uart_set_speeds(struct hci_uart *hu, unsigned int init_speed,
323 unsigned int oper_speed)
325 hu->init_speed = init_speed;
326 hu->oper_speed = oper_speed;
329 void hci_uart_init_tty(struct hci_uart *hu)
331 struct tty_struct *tty = hu->tty;
332 struct ktermios ktermios;
334 /* Bring the UART into a known 8 bits no parity hw fc state */
335 ktermios = tty->termios;
336 ktermios.c_iflag &= ~(IGNBRK | BRKINT | PARMRK | ISTRIP |
337 INLCR | IGNCR | ICRNL | IXON);
338 ktermios.c_oflag &= ~OPOST;
339 ktermios.c_lflag &= ~(ECHO | ECHONL | ICANON | ISIG | IEXTEN);
340 ktermios.c_cflag &= ~(CSIZE | PARENB);
341 ktermios.c_cflag |= CS8;
342 ktermios.c_cflag |= CRTSCTS;
344 /* tty_set_termios() return not checked as it is always 0 */
345 tty_set_termios(tty, &ktermios);
348 void hci_uart_set_baudrate(struct hci_uart *hu, unsigned int speed)
350 struct tty_struct *tty = hu->tty;
351 struct ktermios ktermios;
353 ktermios = tty->termios;
354 ktermios.c_cflag &= ~CBAUD;
355 tty_termios_encode_baud_rate(&ktermios, speed, speed);
357 /* tty_set_termios() return not checked as it is always 0 */
358 tty_set_termios(tty, &ktermios);
360 BT_DBG("%s: New tty speeds: %d/%d", hu->hdev->name,
361 tty->termios.c_ispeed, tty->termios.c_ospeed);
364 static int hci_uart_setup(struct hci_dev *hdev)
366 struct hci_uart *hu = hci_get_drvdata(hdev);
367 struct hci_rp_read_local_version *ver;
372 /* Init speed if any */
374 speed = hu->init_speed;
375 else if (hu->proto->init_speed)
376 speed = hu->proto->init_speed;
381 hci_uart_set_baudrate(hu, speed);
383 /* Operational speed if any */
385 speed = hu->oper_speed;
386 else if (hu->proto->oper_speed)
387 speed = hu->proto->oper_speed;
391 if (hu->proto->set_baudrate && speed) {
392 err = hu->proto->set_baudrate(hu, speed);
394 hci_uart_set_baudrate(hu, speed);
397 if (hu->proto->setup)
398 return hu->proto->setup(hu);
400 if (!test_bit(HCI_UART_VND_DETECT, &hu->hdev_flags))
403 skb = __hci_cmd_sync(hdev, HCI_OP_READ_LOCAL_VERSION, 0, NULL,
406 BT_ERR("%s: Reading local version information failed (%ld)",
407 hdev->name, PTR_ERR(skb));
411 if (skb->len != sizeof(*ver)) {
412 BT_ERR("%s: Event length mismatch for version information",
417 ver = (struct hci_rp_read_local_version *)skb->data;
419 switch (le16_to_cpu(ver->manufacturer)) {
420 #ifdef CONFIG_BT_HCIUART_INTEL
422 hdev->set_bdaddr = btintel_set_bdaddr;
423 btintel_check_bdaddr(hdev);
426 #ifdef CONFIG_BT_HCIUART_BCM
428 hdev->set_bdaddr = btbcm_set_bdaddr;
429 btbcm_check_bdaddr(hdev);
439 /* ------ LDISC part ------ */
442 * Called when line discipline changed to HCI_UART.
445 * tty pointer to tty info structure
447 * 0 if success, otherwise error code
449 static int hci_uart_tty_open(struct tty_struct *tty)
453 BT_DBG("tty %p", tty);
455 /* Error if the tty has no write op instead of leaving an exploitable
457 if (tty->ops->write == NULL)
460 hu = kzalloc(sizeof(struct hci_uart), GFP_KERNEL);
462 BT_ERR("Can't allocate control structure");
468 tty->receive_room = 65536;
470 INIT_WORK(&hu->init_ready, hci_uart_init_work);
471 INIT_WORK(&hu->write_work, hci_uart_write_work);
473 spin_lock_init(&hu->rx_lock);
475 /* Flush any pending characters in the driver and line discipline. */
477 /* FIXME: why is this needed. Note don't use ldisc_ref here as the
478 open path is before the ldisc is referencable */
480 if (tty->ldisc->ops->flush_buffer)
481 tty->ldisc->ops->flush_buffer(tty);
482 tty_driver_flush_buffer(tty);
487 /* hci_uart_tty_close()
489 * Called when the line discipline is changed to something
490 * else, the tty is closed, or the tty detects a hangup.
492 static void hci_uart_tty_close(struct tty_struct *tty)
494 struct hci_uart *hu = tty->disc_data;
495 struct hci_dev *hdev;
497 BT_DBG("tty %p", tty);
499 /* Detach from the tty */
500 tty->disc_data = NULL;
507 hci_uart_close(hdev);
509 cancel_work_sync(&hu->write_work);
511 if (test_and_clear_bit(HCI_UART_PROTO_SET, &hu->flags)) {
513 if (test_bit(HCI_UART_REGISTERED, &hu->flags))
514 hci_unregister_dev(hdev);
517 hu->proto->close(hu);
523 /* hci_uart_tty_wakeup()
525 * Callback for transmit wakeup. Called when low level
526 * device driver can accept more send data.
528 * Arguments: tty pointer to associated tty instance data
531 static void hci_uart_tty_wakeup(struct tty_struct *tty)
533 struct hci_uart *hu = tty->disc_data;
540 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
545 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
546 hci_uart_tx_wakeup(hu);
549 /* hci_uart_tty_receive()
551 * Called by tty low level driver when receive data is
554 * Arguments: tty pointer to tty isntance data
555 * data pointer to received data
556 * flags pointer to flags for data
557 * count count of received data in bytes
561 static void hci_uart_tty_receive(struct tty_struct *tty, const u8 *data,
562 char *flags, int count)
564 struct hci_uart *hu = tty->disc_data;
566 if (!hu || tty != hu->tty)
569 if (!test_bit(HCI_UART_PROTO_SET, &hu->flags))
572 spin_lock(&hu->rx_lock);
573 hu->proto->recv(hu, data, count);
576 hu->hdev->stat.byte_rx += count;
578 spin_unlock(&hu->rx_lock);
583 static int hci_uart_register_dev(struct hci_uart *hu)
585 struct hci_dev *hdev;
589 /* Initialize and register HCI device */
590 hdev = hci_alloc_dev();
592 BT_ERR("Can't allocate HCI device");
598 hdev->bus = HCI_UART;
599 hci_set_drvdata(hdev, hu);
601 hdev->open = hci_uart_open;
602 hdev->close = hci_uart_close;
603 hdev->flush = hci_uart_flush;
604 hdev->send = hci_uart_send_frame;
605 hdev->setup = hci_uart_setup;
606 SET_HCIDEV_DEV(hdev, hu->tty->dev);
608 if (test_bit(HCI_UART_RAW_DEVICE, &hu->hdev_flags))
609 set_bit(HCI_QUIRK_RAW_DEVICE, &hdev->quirks);
611 if (test_bit(HCI_UART_EXT_CONFIG, &hu->hdev_flags))
612 set_bit(HCI_QUIRK_EXTERNAL_CONFIG, &hdev->quirks);
614 if (!test_bit(HCI_UART_RESET_ON_INIT, &hu->hdev_flags))
615 set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
617 if (test_bit(HCI_UART_CREATE_AMP, &hu->hdev_flags))
618 hdev->dev_type = HCI_AMP;
620 hdev->dev_type = HCI_BREDR;
622 if (test_bit(HCI_UART_INIT_PENDING, &hu->hdev_flags))
625 if (hci_register_dev(hdev) < 0) {
626 BT_ERR("Can't register HCI device");
631 set_bit(HCI_UART_REGISTERED, &hu->flags);
636 static int hci_uart_set_proto(struct hci_uart *hu, int id)
638 const struct hci_uart_proto *p;
641 p = hci_uart_get_proto(id);
643 return -EPROTONOSUPPORT;
651 err = hci_uart_register_dev(hu);
660 static int hci_uart_set_flags(struct hci_uart *hu, unsigned long flags)
662 unsigned long valid_flags = BIT(HCI_UART_RAW_DEVICE) |
663 BIT(HCI_UART_RESET_ON_INIT) |
664 BIT(HCI_UART_CREATE_AMP) |
665 BIT(HCI_UART_INIT_PENDING) |
666 BIT(HCI_UART_EXT_CONFIG) |
667 BIT(HCI_UART_VND_DETECT);
669 if (flags & ~valid_flags)
672 hu->hdev_flags = flags;
677 /* hci_uart_tty_ioctl()
679 * Process IOCTL system call for the tty device.
683 * tty pointer to tty instance data
684 * file pointer to open file object for device
685 * cmd IOCTL command code
686 * arg argument for IOCTL call (cmd dependent)
688 * Return Value: Command dependent
690 static int hci_uart_tty_ioctl(struct tty_struct *tty, struct file *file,
691 unsigned int cmd, unsigned long arg)
693 struct hci_uart *hu = tty->disc_data;
698 /* Verify the status of the device */
703 case HCIUARTSETPROTO:
704 if (!test_and_set_bit(HCI_UART_PROTO_SET, &hu->flags)) {
705 err = hci_uart_set_proto(hu, arg);
707 clear_bit(HCI_UART_PROTO_SET, &hu->flags);
714 case HCIUARTGETPROTO:
715 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
716 return hu->proto->id;
719 case HCIUARTGETDEVICE:
720 if (test_bit(HCI_UART_REGISTERED, &hu->flags))
724 case HCIUARTSETFLAGS:
725 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
727 err = hci_uart_set_flags(hu, arg);
732 case HCIUARTGETFLAGS:
733 return hu->hdev_flags;
736 err = n_tty_ioctl_helper(tty, file, cmd, arg);
744 * We don't provide read/write/poll interface for user space.
746 static ssize_t hci_uart_tty_read(struct tty_struct *tty, struct file *file,
747 unsigned char __user *buf, size_t nr)
752 static ssize_t hci_uart_tty_write(struct tty_struct *tty, struct file *file,
753 const unsigned char *data, size_t count)
758 static unsigned int hci_uart_tty_poll(struct tty_struct *tty,
759 struct file *filp, poll_table *wait)
764 static int __init hci_uart_init(void)
766 static struct tty_ldisc_ops hci_uart_ldisc;
769 BT_INFO("HCI UART driver ver %s", VERSION);
771 /* Register the tty discipline */
773 memset(&hci_uart_ldisc, 0, sizeof (hci_uart_ldisc));
774 hci_uart_ldisc.magic = TTY_LDISC_MAGIC;
775 hci_uart_ldisc.name = "n_hci";
776 hci_uart_ldisc.open = hci_uart_tty_open;
777 hci_uart_ldisc.close = hci_uart_tty_close;
778 hci_uart_ldisc.read = hci_uart_tty_read;
779 hci_uart_ldisc.write = hci_uart_tty_write;
780 hci_uart_ldisc.ioctl = hci_uart_tty_ioctl;
781 hci_uart_ldisc.poll = hci_uart_tty_poll;
782 hci_uart_ldisc.receive_buf = hci_uart_tty_receive;
783 hci_uart_ldisc.write_wakeup = hci_uart_tty_wakeup;
784 hci_uart_ldisc.owner = THIS_MODULE;
786 err = tty_register_ldisc(N_HCI, &hci_uart_ldisc);
788 BT_ERR("HCI line discipline registration failed. (%d)", err);
792 #ifdef CONFIG_BT_HCIUART_H4
795 #ifdef CONFIG_BT_HCIUART_BCSP
798 #ifdef CONFIG_BT_HCIUART_LL
801 #ifdef CONFIG_BT_HCIUART_ATH3K
804 #ifdef CONFIG_BT_HCIUART_3WIRE
807 #ifdef CONFIG_BT_HCIUART_BCM
814 static void __exit hci_uart_exit(void)
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_BCM
837 /* Release tty registration of line discipline */
838 err = tty_unregister_ldisc(N_HCI);
840 BT_ERR("Can't unregister HCI line discipline (%d)", err);
843 module_init(hci_uart_init);
844 module_exit(hci_uart_exit);
846 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
847 MODULE_DESCRIPTION("Bluetooth HCI UART driver ver " VERSION);
848 MODULE_VERSION(VERSION);
849 MODULE_LICENSE("GPL");
850 MODULE_ALIAS_LDISC(N_HCI);