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 if (!(hu = kzalloc(sizeof(struct hci_uart), GFP_KERNEL))) {
275 BT_ERR("Can't allocate control structure");
281 tty->receive_room = 65536;
283 INIT_WORK(&hu->init_ready, hci_uart_init_work);
285 spin_lock_init(&hu->rx_lock);
287 /* Flush any pending characters in the driver and line discipline. */
289 /* FIXME: why is this needed. Note don't use ldisc_ref here as the
290 open path is before the ldisc is referencable */
292 if (tty->ldisc->ops->flush_buffer)
293 tty->ldisc->ops->flush_buffer(tty);
294 tty_driver_flush_buffer(tty);
299 /* hci_uart_tty_close()
301 * Called when the line discipline is changed to something
302 * else, the tty is closed, or the tty detects a hangup.
304 static void hci_uart_tty_close(struct tty_struct *tty)
306 struct hci_uart *hu = (void *)tty->disc_data;
307 struct hci_dev *hdev;
309 BT_DBG("tty %p", tty);
311 /* Detach from the tty */
312 tty->disc_data = NULL;
319 hci_uart_close(hdev);
321 if (test_and_clear_bit(HCI_UART_PROTO_SET, &hu->flags)) {
323 if (test_bit(HCI_UART_REGISTERED, &hu->flags))
324 hci_unregister_dev(hdev);
327 hu->proto->close(hu);
333 /* hci_uart_tty_wakeup()
335 * Callback for transmit wakeup. Called when low level
336 * device driver can accept more send data.
338 * Arguments: tty pointer to associated tty instance data
341 static void hci_uart_tty_wakeup(struct tty_struct *tty)
343 struct hci_uart *hu = (void *)tty->disc_data;
350 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
355 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
356 hci_uart_tx_wakeup(hu);
359 /* hci_uart_tty_receive()
361 * Called by tty low level driver when receive data is
364 * Arguments: tty pointer to tty isntance data
365 * data pointer to received data
366 * flags pointer to flags for data
367 * count count of received data in bytes
371 static void hci_uart_tty_receive(struct tty_struct *tty, const u8 *data, char *flags, int count)
373 struct hci_uart *hu = (void *)tty->disc_data;
375 if (!hu || tty != hu->tty)
378 if (!test_bit(HCI_UART_PROTO_SET, &hu->flags))
381 spin_lock(&hu->rx_lock);
382 hu->proto->recv(hu, (void *) data, count);
385 hu->hdev->stat.byte_rx += count;
387 spin_unlock(&hu->rx_lock);
392 static int hci_uart_register_dev(struct hci_uart *hu)
394 struct hci_dev *hdev;
398 /* Initialize and register HCI device */
399 hdev = hci_alloc_dev();
401 BT_ERR("Can't allocate HCI device");
407 hdev->bus = HCI_UART;
408 hci_set_drvdata(hdev, hu);
410 hdev->open = hci_uart_open;
411 hdev->close = hci_uart_close;
412 hdev->flush = hci_uart_flush;
413 hdev->send = hci_uart_send_frame;
414 SET_HCIDEV_DEV(hdev, hu->tty->dev);
416 if (test_bit(HCI_UART_RAW_DEVICE, &hu->hdev_flags))
417 set_bit(HCI_QUIRK_RAW_DEVICE, &hdev->quirks);
419 if (!test_bit(HCI_UART_RESET_ON_INIT, &hu->hdev_flags))
420 set_bit(HCI_QUIRK_RESET_ON_CLOSE, &hdev->quirks);
422 if (test_bit(HCI_UART_CREATE_AMP, &hu->hdev_flags))
423 hdev->dev_type = HCI_AMP;
425 hdev->dev_type = HCI_BREDR;
427 if (test_bit(HCI_UART_INIT_PENDING, &hu->hdev_flags))
430 if (hci_register_dev(hdev) < 0) {
431 BT_ERR("Can't register HCI device");
436 set_bit(HCI_UART_REGISTERED, &hu->flags);
441 static int hci_uart_set_proto(struct hci_uart *hu, int id)
443 struct hci_uart_proto *p;
446 p = hci_uart_get_proto(id);
448 return -EPROTONOSUPPORT;
456 err = hci_uart_register_dev(hu);
465 /* hci_uart_tty_ioctl()
467 * Process IOCTL system call for the tty device.
471 * tty pointer to tty instance data
472 * file pointer to open file object for device
473 * cmd IOCTL command code
474 * arg argument for IOCTL call (cmd dependent)
476 * Return Value: Command dependent
478 static int hci_uart_tty_ioctl(struct tty_struct *tty, struct file * file,
479 unsigned int cmd, unsigned long arg)
481 struct hci_uart *hu = (void *)tty->disc_data;
486 /* Verify the status of the device */
491 case HCIUARTSETPROTO:
492 if (!test_and_set_bit(HCI_UART_PROTO_SET, &hu->flags)) {
493 err = hci_uart_set_proto(hu, arg);
495 clear_bit(HCI_UART_PROTO_SET, &hu->flags);
502 case HCIUARTGETPROTO:
503 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
504 return hu->proto->id;
507 case HCIUARTGETDEVICE:
508 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
512 case HCIUARTSETFLAGS:
513 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
515 hu->hdev_flags = arg;
518 case HCIUARTGETFLAGS:
519 return hu->hdev_flags;
522 err = n_tty_ioctl_helper(tty, file, cmd, arg);
530 * We don't provide read/write/poll interface for user space.
532 static ssize_t hci_uart_tty_read(struct tty_struct *tty, struct file *file,
533 unsigned char __user *buf, size_t nr)
538 static ssize_t hci_uart_tty_write(struct tty_struct *tty, struct file *file,
539 const unsigned char *data, size_t count)
544 static unsigned int hci_uart_tty_poll(struct tty_struct *tty,
545 struct file *filp, poll_table *wait)
550 static int __init hci_uart_init(void)
552 static struct tty_ldisc_ops hci_uart_ldisc;
555 BT_INFO("HCI UART driver ver %s", VERSION);
557 /* Register the tty discipline */
559 memset(&hci_uart_ldisc, 0, sizeof (hci_uart_ldisc));
560 hci_uart_ldisc.magic = TTY_LDISC_MAGIC;
561 hci_uart_ldisc.name = "n_hci";
562 hci_uart_ldisc.open = hci_uart_tty_open;
563 hci_uart_ldisc.close = hci_uart_tty_close;
564 hci_uart_ldisc.read = hci_uart_tty_read;
565 hci_uart_ldisc.write = hci_uart_tty_write;
566 hci_uart_ldisc.ioctl = hci_uart_tty_ioctl;
567 hci_uart_ldisc.poll = hci_uart_tty_poll;
568 hci_uart_ldisc.receive_buf = hci_uart_tty_receive;
569 hci_uart_ldisc.write_wakeup = hci_uart_tty_wakeup;
570 hci_uart_ldisc.owner = THIS_MODULE;
572 if ((err = tty_register_ldisc(N_HCI, &hci_uart_ldisc))) {
573 BT_ERR("HCI line discipline registration failed. (%d)", err);
577 #ifdef CONFIG_BT_HCIUART_H4
580 #ifdef CONFIG_BT_HCIUART_BCSP
583 #ifdef CONFIG_BT_HCIUART_LL
586 #ifdef CONFIG_BT_HCIUART_ATH3K
589 #ifdef CONFIG_BT_HCIUART_3WIRE
596 static void __exit hci_uart_exit(void)
600 #ifdef CONFIG_BT_HCIUART_H4
603 #ifdef CONFIG_BT_HCIUART_BCSP
606 #ifdef CONFIG_BT_HCIUART_LL
609 #ifdef CONFIG_BT_HCIUART_ATH3K
612 #ifdef CONFIG_BT_HCIUART_3WIRE
616 /* Release tty registration of line discipline */
617 if ((err = tty_unregister_ldisc(N_HCI)))
618 BT_ERR("Can't unregister HCI line discipline (%d)", err);
621 module_init(hci_uart_init);
622 module_exit(hci_uart_exit);
624 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
625 MODULE_DESCRIPTION("Bluetooth HCI UART driver ver " VERSION);
626 MODULE_VERSION(VERSION);
627 MODULE_LICENSE("GPL");
628 MODULE_ALIAS_LDISC(N_HCI);