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>
44 #include <net/bluetooth/bluetooth.h>
45 #include <net/bluetooth/hci_core.h>
51 static struct hci_uart_proto *hup[HCI_UART_MAX_PROTO];
53 int hci_uart_register_proto(struct hci_uart_proto *p)
55 if (p->id >= HCI_UART_MAX_PROTO)
66 int hci_uart_unregister_proto(struct hci_uart_proto *p)
68 if (p->id >= HCI_UART_MAX_PROTO)
79 static struct hci_uart_proto *hci_uart_get_proto(unsigned int id)
81 if (id >= HCI_UART_MAX_PROTO)
87 static inline void hci_uart_tx_complete(struct hci_uart *hu, int pkt_type)
89 struct hci_dev *hdev = hu->hdev;
91 /* Update HCI stat counters */
101 case HCI_SCODATA_PKT:
107 static inline struct sk_buff *hci_uart_dequeue(struct hci_uart *hu)
109 struct sk_buff *skb = hu->tx_skb;
112 skb = hu->proto->dequeue(hu);
119 int hci_uart_tx_wakeup(struct hci_uart *hu)
121 struct tty_struct *tty = hu->tty;
122 struct hci_dev *hdev = hu->hdev;
125 if (test_and_set_bit(HCI_UART_SENDING, &hu->tx_state)) {
126 set_bit(HCI_UART_TX_WAKEUP, &hu->tx_state);
133 clear_bit(HCI_UART_TX_WAKEUP, &hu->tx_state);
135 while ((skb = hci_uart_dequeue(hu))) {
138 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
139 len = tty->ops->write(tty, skb->data, skb->len);
140 hdev->stat.byte_tx += len;
148 hci_uart_tx_complete(hu, bt_cb(skb)->pkt_type);
152 if (test_bit(HCI_UART_TX_WAKEUP, &hu->tx_state))
155 clear_bit(HCI_UART_SENDING, &hu->tx_state);
159 static void hci_uart_init_work(struct work_struct *work)
161 struct hci_uart *hu = container_of(work, struct hci_uart, init_ready);
164 if (!test_and_clear_bit(HCI_UART_INIT_PENDING, &hu->hdev_flags))
167 err = hci_register_dev(hu->hdev);
169 BT_ERR("Can't register HCI device");
170 hci_free_dev(hu->hdev);
172 hu->proto->close(hu);
175 set_bit(HCI_UART_REGISTERED, &hu->flags);
178 int hci_uart_init_ready(struct hci_uart *hu)
180 if (!test_bit(HCI_UART_INIT_PENDING, &hu->hdev_flags))
183 schedule_work(&hu->init_ready);
188 /* ------- Interface to HCI layer ------ */
189 /* Initialize device */
190 static int hci_uart_open(struct hci_dev *hdev)
192 BT_DBG("%s %p", hdev->name, hdev);
194 /* Nothing to do for UART driver */
196 set_bit(HCI_RUNNING, &hdev->flags);
202 static int hci_uart_flush(struct hci_dev *hdev)
204 struct hci_uart *hu = hci_get_drvdata(hdev);
205 struct tty_struct *tty = hu->tty;
207 BT_DBG("hdev %p tty %p", hdev, tty);
210 kfree_skb(hu->tx_skb); hu->tx_skb = NULL;
213 /* Flush any pending characters in the driver and discipline. */
214 tty_ldisc_flush(tty);
215 tty_driver_flush_buffer(tty);
217 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
218 hu->proto->flush(hu);
224 static int hci_uart_close(struct hci_dev *hdev)
226 BT_DBG("hdev %p", hdev);
228 if (!test_and_clear_bit(HCI_RUNNING, &hdev->flags))
231 hci_uart_flush(hdev);
236 /* Send frames from HCI layer */
237 static int hci_uart_send_frame(struct sk_buff *skb)
239 struct hci_dev* hdev = (struct hci_dev *) skb->dev;
243 BT_ERR("Frame for unknown device (hdev=NULL)");
247 if (!test_bit(HCI_RUNNING, &hdev->flags))
250 hu = hci_get_drvdata(hdev);
252 BT_DBG("%s: type %d len %d", hdev->name, bt_cb(skb)->pkt_type, skb->len);
254 hu->proto->enqueue(hu, skb);
256 hci_uart_tx_wakeup(hu);
261 /* ------ LDISC part ------ */
264 * Called when line discipline changed to HCI_UART.
267 * tty pointer to tty info structure
269 * 0 if success, otherwise error code
271 static int hci_uart_tty_open(struct tty_struct *tty)
275 BT_DBG("tty %p", tty);
277 /* Error if the tty has no write op instead of leaving an exploitable
279 if (tty->ops->write == NULL)
282 if (!(hu = kzalloc(sizeof(struct hci_uart), GFP_KERNEL))) {
283 BT_ERR("Can't allocate control structure");
289 tty->receive_room = 65536;
291 INIT_WORK(&hu->init_ready, hci_uart_init_work);
293 spin_lock_init(&hu->rx_lock);
295 /* Flush any pending characters in the driver and line discipline. */
297 /* FIXME: why is this needed. Note don't use ldisc_ref here as the
298 open path is before the ldisc is referencable */
300 if (tty->ldisc->ops->flush_buffer)
301 tty->ldisc->ops->flush_buffer(tty);
302 tty_driver_flush_buffer(tty);
307 /* hci_uart_tty_close()
309 * Called when the line discipline is changed to something
310 * else, the tty is closed, or the tty detects a hangup.
312 static void hci_uart_tty_close(struct tty_struct *tty)
314 struct hci_uart *hu = (void *)tty->disc_data;
315 struct hci_dev *hdev;
317 BT_DBG("tty %p", tty);
319 /* Detach from the tty */
320 tty->disc_data = NULL;
327 hci_uart_close(hdev);
329 if (test_and_clear_bit(HCI_UART_PROTO_SET, &hu->flags)) {
331 if (test_bit(HCI_UART_REGISTERED, &hu->flags))
332 hci_unregister_dev(hdev);
335 hu->proto->close(hu);
341 /* hci_uart_tty_wakeup()
343 * Callback for transmit wakeup. Called when low level
344 * device driver can accept more send data.
346 * Arguments: tty pointer to associated tty instance data
349 static void hci_uart_tty_wakeup(struct tty_struct *tty)
351 struct hci_uart *hu = (void *)tty->disc_data;
358 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
363 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
364 hci_uart_tx_wakeup(hu);
367 /* hci_uart_tty_receive()
369 * Called by tty low level driver when receive data is
372 * Arguments: tty pointer to tty isntance data
373 * data pointer to received data
374 * flags pointer to flags for data
375 * count count of received data in bytes
379 static void hci_uart_tty_receive(struct tty_struct *tty, const u8 *data, char *flags, int count)
381 struct hci_uart *hu = (void *)tty->disc_data;
383 if (!hu || tty != hu->tty)
386 if (!test_bit(HCI_UART_PROTO_SET, &hu->flags))
389 spin_lock(&hu->rx_lock);
390 hu->proto->recv(hu, (void *) data, count);
393 hu->hdev->stat.byte_rx += count;
395 spin_unlock(&hu->rx_lock);
400 static int hci_uart_register_dev(struct hci_uart *hu)
402 struct hci_dev *hdev;
406 /* Initialize and register HCI device */
407 hdev = hci_alloc_dev();
409 BT_ERR("Can't allocate HCI device");
415 hdev->bus = HCI_UART;
416 hci_set_drvdata(hdev, hu);
418 hdev->open = hci_uart_open;
419 hdev->close = hci_uart_close;
420 hdev->flush = hci_uart_flush;
421 hdev->send = hci_uart_send_frame;
422 SET_HCIDEV_DEV(hdev, hu->tty->dev);
424 if (test_bit(HCI_UART_RAW_DEVICE, &hu->hdev_flags))
425 set_bit(HCI_QUIRK_RAW_DEVICE, &hdev->quirks);
427 if (!test_bit(HCI_UART_RESET_ON_INIT, &hu->hdev_flags))
428 set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
430 if (test_bit(HCI_UART_CREATE_AMP, &hu->hdev_flags))
431 hdev->dev_type = HCI_AMP;
433 hdev->dev_type = HCI_BREDR;
435 if (test_bit(HCI_UART_INIT_PENDING, &hu->hdev_flags))
438 if (hci_register_dev(hdev) < 0) {
439 BT_ERR("Can't register HCI device");
444 set_bit(HCI_UART_REGISTERED, &hu->flags);
449 static int hci_uart_set_proto(struct hci_uart *hu, int id)
451 struct hci_uart_proto *p;
454 p = hci_uart_get_proto(id);
456 return -EPROTONOSUPPORT;
464 err = hci_uart_register_dev(hu);
473 /* hci_uart_tty_ioctl()
475 * Process IOCTL system call for the tty device.
479 * tty pointer to tty instance data
480 * file pointer to open file object for device
481 * cmd IOCTL command code
482 * arg argument for IOCTL call (cmd dependent)
484 * Return Value: Command dependent
486 static int hci_uart_tty_ioctl(struct tty_struct *tty, struct file * file,
487 unsigned int cmd, unsigned long arg)
489 struct hci_uart *hu = (void *)tty->disc_data;
494 /* Verify the status of the device */
499 case HCIUARTSETPROTO:
500 if (!test_and_set_bit(HCI_UART_PROTO_SET, &hu->flags)) {
501 err = hci_uart_set_proto(hu, arg);
503 clear_bit(HCI_UART_PROTO_SET, &hu->flags);
510 case HCIUARTGETPROTO:
511 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
512 return hu->proto->id;
515 case HCIUARTGETDEVICE:
516 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
520 case HCIUARTSETFLAGS:
521 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
523 hu->hdev_flags = arg;
526 case HCIUARTGETFLAGS:
527 return hu->hdev_flags;
530 err = n_tty_ioctl_helper(tty, file, cmd, arg);
538 * We don't provide read/write/poll interface for user space.
540 static ssize_t hci_uart_tty_read(struct tty_struct *tty, struct file *file,
541 unsigned char __user *buf, size_t nr)
546 static ssize_t hci_uart_tty_write(struct tty_struct *tty, struct file *file,
547 const unsigned char *data, size_t count)
552 static unsigned int hci_uart_tty_poll(struct tty_struct *tty,
553 struct file *filp, poll_table *wait)
558 static int __init hci_uart_init(void)
560 static struct tty_ldisc_ops hci_uart_ldisc;
563 BT_INFO("HCI UART driver ver %s", VERSION);
565 /* Register the tty discipline */
567 memset(&hci_uart_ldisc, 0, sizeof (hci_uart_ldisc));
568 hci_uart_ldisc.magic = TTY_LDISC_MAGIC;
569 hci_uart_ldisc.name = "n_hci";
570 hci_uart_ldisc.open = hci_uart_tty_open;
571 hci_uart_ldisc.close = hci_uart_tty_close;
572 hci_uart_ldisc.read = hci_uart_tty_read;
573 hci_uart_ldisc.write = hci_uart_tty_write;
574 hci_uart_ldisc.ioctl = hci_uart_tty_ioctl;
575 hci_uart_ldisc.poll = hci_uart_tty_poll;
576 hci_uart_ldisc.receive_buf = hci_uart_tty_receive;
577 hci_uart_ldisc.write_wakeup = hci_uart_tty_wakeup;
578 hci_uart_ldisc.owner = THIS_MODULE;
580 if ((err = tty_register_ldisc(N_HCI, &hci_uart_ldisc))) {
581 BT_ERR("HCI line discipline registration failed. (%d)", err);
585 #ifdef CONFIG_BT_HCIUART_H4
588 #ifdef CONFIG_BT_HCIUART_BCSP
591 #ifdef CONFIG_BT_HCIUART_LL
594 #ifdef CONFIG_BT_HCIUART_ATH3K
597 #ifdef CONFIG_BT_HCIUART_3WIRE
604 static void __exit hci_uart_exit(void)
608 #ifdef CONFIG_BT_HCIUART_H4
611 #ifdef CONFIG_BT_HCIUART_BCSP
614 #ifdef CONFIG_BT_HCIUART_LL
617 #ifdef CONFIG_BT_HCIUART_ATH3K
620 #ifdef CONFIG_BT_HCIUART_3WIRE
624 /* Release tty registration of line discipline */
625 if ((err = tty_unregister_ldisc(N_HCI)))
626 BT_ERR("Can't unregister HCI line discipline (%d)", err);
629 module_init(hci_uart_init);
630 module_exit(hci_uart_exit);
632 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
633 MODULE_DESCRIPTION("Bluetooth HCI UART driver ver " VERSION);
634 MODULE_VERSION(VERSION);
635 MODULE_LICENSE("GPL");
636 MODULE_ALIAS_LDISC(N_HCI);