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 hci_dev *hdev, struct sk_buff *skb)
239 struct hci_uart *hu = hci_get_drvdata(hdev);
241 if (!test_bit(HCI_RUNNING, &hdev->flags))
244 BT_DBG("%s: type %d len %d", hdev->name, bt_cb(skb)->pkt_type, skb->len);
246 hu->proto->enqueue(hu, skb);
248 hci_uart_tx_wakeup(hu);
253 /* ------ LDISC part ------ */
256 * Called when line discipline changed to HCI_UART.
259 * tty pointer to tty info structure
261 * 0 if success, otherwise error code
263 static int hci_uart_tty_open(struct tty_struct *tty)
267 BT_DBG("tty %p", tty);
269 /* Error if the tty has no write op instead of leaving an exploitable
271 if (tty->ops->write == NULL)
274 hu = kzalloc(sizeof(struct hci_uart), GFP_KERNEL);
276 BT_ERR("Can't allocate control structure");
282 tty->receive_room = 65536;
284 INIT_WORK(&hu->init_ready, hci_uart_init_work);
286 spin_lock_init(&hu->rx_lock);
288 /* Flush any pending characters in the driver and line discipline. */
290 /* FIXME: why is this needed. Note don't use ldisc_ref here as the
291 open path is before the ldisc is referencable */
293 if (tty->ldisc->ops->flush_buffer)
294 tty->ldisc->ops->flush_buffer(tty);
295 tty_driver_flush_buffer(tty);
300 /* hci_uart_tty_close()
302 * Called when the line discipline is changed to something
303 * else, the tty is closed, or the tty detects a hangup.
305 static void hci_uart_tty_close(struct tty_struct *tty)
307 struct hci_uart *hu = (void *)tty->disc_data;
308 struct hci_dev *hdev;
310 BT_DBG("tty %p", tty);
312 /* Detach from the tty */
313 tty->disc_data = NULL;
320 hci_uart_close(hdev);
322 if (test_and_clear_bit(HCI_UART_PROTO_SET, &hu->flags)) {
324 if (test_bit(HCI_UART_REGISTERED, &hu->flags))
325 hci_unregister_dev(hdev);
328 hu->proto->close(hu);
334 /* hci_uart_tty_wakeup()
336 * Callback for transmit wakeup. Called when low level
337 * device driver can accept more send data.
339 * Arguments: tty pointer to associated tty instance data
342 static void hci_uart_tty_wakeup(struct tty_struct *tty)
344 struct hci_uart *hu = (void *)tty->disc_data;
351 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
356 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
357 hci_uart_tx_wakeup(hu);
360 /* hci_uart_tty_receive()
362 * Called by tty low level driver when receive data is
365 * Arguments: tty pointer to tty isntance data
366 * data pointer to received data
367 * flags pointer to flags for data
368 * count count of received data in bytes
372 static void hci_uart_tty_receive(struct tty_struct *tty, const u8 *data, char *flags, int count)
374 struct hci_uart *hu = (void *)tty->disc_data;
376 if (!hu || tty != hu->tty)
379 if (!test_bit(HCI_UART_PROTO_SET, &hu->flags))
382 spin_lock(&hu->rx_lock);
383 hu->proto->recv(hu, (void *) data, count);
386 hu->hdev->stat.byte_rx += count;
388 spin_unlock(&hu->rx_lock);
393 static int hci_uart_register_dev(struct hci_uart *hu)
395 struct hci_dev *hdev;
399 /* Initialize and register HCI device */
400 hdev = hci_alloc_dev();
402 BT_ERR("Can't allocate HCI device");
408 hdev->bus = HCI_UART;
409 hci_set_drvdata(hdev, hu);
411 hdev->open = hci_uart_open;
412 hdev->close = hci_uart_close;
413 hdev->flush = hci_uart_flush;
414 hdev->send = hci_uart_send_frame;
415 SET_HCIDEV_DEV(hdev, hu->tty->dev);
417 if (test_bit(HCI_UART_RAW_DEVICE, &hu->hdev_flags))
418 set_bit(HCI_QUIRK_RAW_DEVICE, &hdev->quirks);
420 if (!test_bit(HCI_UART_RESET_ON_INIT, &hu->hdev_flags))
421 set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
423 if (test_bit(HCI_UART_CREATE_AMP, &hu->hdev_flags))
424 hdev->dev_type = HCI_AMP;
426 hdev->dev_type = HCI_BREDR;
428 if (test_bit(HCI_UART_INIT_PENDING, &hu->hdev_flags))
431 if (hci_register_dev(hdev) < 0) {
432 BT_ERR("Can't register HCI device");
437 set_bit(HCI_UART_REGISTERED, &hu->flags);
442 static int hci_uart_set_proto(struct hci_uart *hu, int id)
444 struct hci_uart_proto *p;
447 p = hci_uart_get_proto(id);
449 return -EPROTONOSUPPORT;
457 err = hci_uart_register_dev(hu);
466 /* hci_uart_tty_ioctl()
468 * Process IOCTL system call for the tty device.
472 * tty pointer to tty instance data
473 * file pointer to open file object for device
474 * cmd IOCTL command code
475 * arg argument for IOCTL call (cmd dependent)
477 * Return Value: Command dependent
479 static int hci_uart_tty_ioctl(struct tty_struct *tty, struct file * file,
480 unsigned int cmd, unsigned long arg)
482 struct hci_uart *hu = (void *)tty->disc_data;
487 /* Verify the status of the device */
492 case HCIUARTSETPROTO:
493 if (!test_and_set_bit(HCI_UART_PROTO_SET, &hu->flags)) {
494 err = hci_uart_set_proto(hu, arg);
496 clear_bit(HCI_UART_PROTO_SET, &hu->flags);
503 case HCIUARTGETPROTO:
504 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
505 return hu->proto->id;
508 case HCIUARTGETDEVICE:
509 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
513 case HCIUARTSETFLAGS:
514 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
516 hu->hdev_flags = arg;
519 case HCIUARTGETFLAGS:
520 return hu->hdev_flags;
523 err = n_tty_ioctl_helper(tty, file, cmd, arg);
531 * We don't provide read/write/poll interface for user space.
533 static ssize_t hci_uart_tty_read(struct tty_struct *tty, struct file *file,
534 unsigned char __user *buf, size_t nr)
539 static ssize_t hci_uart_tty_write(struct tty_struct *tty, struct file *file,
540 const unsigned char *data, size_t count)
545 static unsigned int hci_uart_tty_poll(struct tty_struct *tty,
546 struct file *filp, poll_table *wait)
551 static int __init hci_uart_init(void)
553 static struct tty_ldisc_ops hci_uart_ldisc;
556 BT_INFO("HCI UART driver ver %s", VERSION);
558 /* Register the tty discipline */
560 memset(&hci_uart_ldisc, 0, sizeof (hci_uart_ldisc));
561 hci_uart_ldisc.magic = TTY_LDISC_MAGIC;
562 hci_uart_ldisc.name = "n_hci";
563 hci_uart_ldisc.open = hci_uart_tty_open;
564 hci_uart_ldisc.close = hci_uart_tty_close;
565 hci_uart_ldisc.read = hci_uart_tty_read;
566 hci_uart_ldisc.write = hci_uart_tty_write;
567 hci_uart_ldisc.ioctl = hci_uart_tty_ioctl;
568 hci_uart_ldisc.poll = hci_uart_tty_poll;
569 hci_uart_ldisc.receive_buf = hci_uart_tty_receive;
570 hci_uart_ldisc.write_wakeup = hci_uart_tty_wakeup;
571 hci_uart_ldisc.owner = THIS_MODULE;
573 err = tty_register_ldisc(N_HCI, &hci_uart_ldisc);
575 BT_ERR("HCI line discipline registration failed. (%d)", err);
579 #ifdef CONFIG_BT_HCIUART_H4
582 #ifdef CONFIG_BT_HCIUART_BCSP
585 #ifdef CONFIG_BT_HCIUART_LL
588 #ifdef CONFIG_BT_HCIUART_ATH3K
591 #ifdef CONFIG_BT_HCIUART_3WIRE
598 static void __exit hci_uart_exit(void)
602 #ifdef CONFIG_BT_HCIUART_H4
605 #ifdef CONFIG_BT_HCIUART_BCSP
608 #ifdef CONFIG_BT_HCIUART_LL
611 #ifdef CONFIG_BT_HCIUART_ATH3K
614 #ifdef CONFIG_BT_HCIUART_3WIRE
618 /* Release tty registration of line discipline */
619 err = tty_unregister_ldisc(N_HCI);
621 BT_ERR("Can't unregister HCI line discipline (%d)", err);
624 module_init(hci_uart_init);
625 module_exit(hci_uart_exit);
627 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
628 MODULE_DESCRIPTION("Bluetooth HCI UART driver ver " VERSION);
629 MODULE_VERSION(VERSION);
630 MODULE_LICENSE("GPL");
631 MODULE_ALIAS_LDISC(N_HCI);