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>
53 static struct hci_uart_proto *hup[HCI_UART_MAX_PROTO];
55 int hci_uart_register_proto(struct hci_uart_proto *p)
57 if (p->id >= HCI_UART_MAX_PROTO)
68 int hci_uart_unregister_proto(struct hci_uart_proto *p)
70 if (p->id >= HCI_UART_MAX_PROTO)
81 static struct hci_uart_proto *hci_uart_get_proto(unsigned int id)
83 if (id >= HCI_UART_MAX_PROTO)
89 static inline void hci_uart_tx_complete(struct hci_uart *hu, int pkt_type)
91 struct hci_dev *hdev = hu->hdev;
93 /* Update HCI stat counters */
103 case HCI_SCODATA_PKT:
109 static inline struct sk_buff *hci_uart_dequeue(struct hci_uart *hu)
111 struct sk_buff *skb = hu->tx_skb;
114 skb = hu->proto->dequeue(hu);
121 int hci_uart_tx_wakeup(struct hci_uart *hu)
123 struct tty_struct *tty = hu->tty;
124 struct hci_dev *hdev = hu->hdev;
127 if (test_and_set_bit(HCI_UART_SENDING, &hu->tx_state)) {
128 set_bit(HCI_UART_TX_WAKEUP, &hu->tx_state);
135 clear_bit(HCI_UART_TX_WAKEUP, &hu->tx_state);
137 while ((skb = hci_uart_dequeue(hu))) {
140 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
141 len = tty->ops->write(tty, skb->data, skb->len);
142 hdev->stat.byte_tx += len;
150 hci_uart_tx_complete(hu, bt_cb(skb)->pkt_type);
154 if (test_bit(HCI_UART_TX_WAKEUP, &hu->tx_state))
157 clear_bit(HCI_UART_SENDING, &hu->tx_state);
161 /* ------- Interface to HCI layer ------ */
162 /* Initialize device */
163 static int hci_uart_open(struct hci_dev *hdev)
165 BT_DBG("%s %p", hdev->name, hdev);
167 /* Nothing to do for UART driver */
169 set_bit(HCI_RUNNING, &hdev->flags);
175 static int hci_uart_flush(struct hci_dev *hdev)
177 struct hci_uart *hu = (struct hci_uart *) hdev->driver_data;
178 struct tty_struct *tty = hu->tty;
180 BT_DBG("hdev %p tty %p", hdev, tty);
183 kfree_skb(hu->tx_skb); hu->tx_skb = NULL;
186 /* Flush any pending characters in the driver and discipline. */
187 tty_ldisc_flush(tty);
188 tty_driver_flush_buffer(tty);
190 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
191 hu->proto->flush(hu);
197 static int hci_uart_close(struct hci_dev *hdev)
199 BT_DBG("hdev %p", hdev);
201 if (!test_and_clear_bit(HCI_RUNNING, &hdev->flags))
204 hci_uart_flush(hdev);
209 /* Send frames from HCI layer */
210 static int hci_uart_send_frame(struct sk_buff *skb)
212 struct hci_dev* hdev = (struct hci_dev *) skb->dev;
213 struct tty_struct *tty;
217 BT_ERR("Frame for uknown device (hdev=NULL)");
221 if (!test_bit(HCI_RUNNING, &hdev->flags))
224 hu = (struct hci_uart *) hdev->driver_data;
227 BT_DBG("%s: type %d len %d", hdev->name, bt_cb(skb)->pkt_type, skb->len);
229 hu->proto->enqueue(hu, skb);
231 hci_uart_tx_wakeup(hu);
236 static void hci_uart_destruct(struct hci_dev *hdev)
241 BT_DBG("%s", hdev->name);
242 kfree(hdev->driver_data);
245 /* ------ LDISC part ------ */
248 * Called when line discipline changed to HCI_UART.
251 * tty pointer to tty info structure
253 * 0 if success, otherwise error code
255 static int hci_uart_tty_open(struct tty_struct *tty)
257 struct hci_uart *hu = (void *) tty->disc_data;
259 BT_DBG("tty %p", tty);
264 if (!(hu = kzalloc(sizeof(struct hci_uart), GFP_KERNEL))) {
265 BT_ERR("Can't allocate control structure");
271 tty->receive_room = 65536;
273 spin_lock_init(&hu->rx_lock);
275 /* Flush any pending characters in the driver and line discipline. */
277 /* FIXME: why is this needed. Note don't use ldisc_ref here as the
278 open path is before the ldisc is referencable */
280 if (tty->ldisc->ops->flush_buffer)
281 tty->ldisc->ops->flush_buffer(tty);
282 tty_driver_flush_buffer(tty);
287 /* hci_uart_tty_close()
289 * Called when the line discipline is changed to something
290 * else, the tty is closed, or the tty detects a hangup.
292 static void hci_uart_tty_close(struct tty_struct *tty)
294 struct hci_uart *hu = (void *)tty->disc_data;
296 BT_DBG("tty %p", tty);
298 /* Detach from the tty */
299 tty->disc_data = NULL;
302 struct hci_dev *hdev = hu->hdev;
305 hci_uart_close(hdev);
307 if (test_and_clear_bit(HCI_UART_PROTO_SET, &hu->flags)) {
308 hu->proto->close(hu);
309 hci_unregister_dev(hdev);
315 /* hci_uart_tty_wakeup()
317 * Callback for transmit wakeup. Called when low level
318 * device driver can accept more send data.
320 * Arguments: tty pointer to associated tty instance data
323 static void hci_uart_tty_wakeup(struct tty_struct *tty)
325 struct hci_uart *hu = (void *)tty->disc_data;
332 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
337 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
338 hci_uart_tx_wakeup(hu);
341 /* hci_uart_tty_receive()
343 * Called by tty low level driver when receive data is
346 * Arguments: tty pointer to tty isntance data
347 * data pointer to received data
348 * flags pointer to flags for data
349 * count count of received data in bytes
353 static void hci_uart_tty_receive(struct tty_struct *tty, const u8 *data, char *flags, int count)
355 struct hci_uart *hu = (void *)tty->disc_data;
357 if (!hu || tty != hu->tty)
360 if (!test_bit(HCI_UART_PROTO_SET, &hu->flags))
363 spin_lock(&hu->rx_lock);
364 hu->proto->recv(hu, (void *) data, count);
365 hu->hdev->stat.byte_rx += count;
366 spin_unlock(&hu->rx_lock);
371 static int hci_uart_register_dev(struct hci_uart *hu)
373 struct hci_dev *hdev;
377 /* Initialize and register HCI device */
378 hdev = hci_alloc_dev();
380 BT_ERR("Can't allocate HCI device");
386 hdev->type = HCI_UART;
387 hdev->driver_data = hu;
389 hdev->open = hci_uart_open;
390 hdev->close = hci_uart_close;
391 hdev->flush = hci_uart_flush;
392 hdev->send = hci_uart_send_frame;
393 hdev->destruct = hci_uart_destruct;
395 hdev->owner = THIS_MODULE;
398 set_bit(HCI_QUIRK_NO_RESET, &hdev->quirks);
400 if (hci_register_dev(hdev) < 0) {
401 BT_ERR("Can't register HCI device");
409 static int hci_uart_set_proto(struct hci_uart *hu, int id)
411 struct hci_uart_proto *p;
414 p = hci_uart_get_proto(id);
416 return -EPROTONOSUPPORT;
424 err = hci_uart_register_dev(hu);
433 /* hci_uart_tty_ioctl()
435 * Process IOCTL system call for the tty device.
439 * tty pointer to tty instance data
440 * file pointer to open file object for device
441 * cmd IOCTL command code
442 * arg argument for IOCTL call (cmd dependent)
444 * Return Value: Command dependent
446 static int hci_uart_tty_ioctl(struct tty_struct *tty, struct file * file,
447 unsigned int cmd, unsigned long arg)
449 struct hci_uart *hu = (void *)tty->disc_data;
454 /* Verify the status of the device */
459 case HCIUARTSETPROTO:
460 if (!test_and_set_bit(HCI_UART_PROTO_SET, &hu->flags)) {
461 err = hci_uart_set_proto(hu, arg);
463 clear_bit(HCI_UART_PROTO_SET, &hu->flags);
470 case HCIUARTGETPROTO:
471 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
472 return hu->proto->id;
475 case HCIUARTGETDEVICE:
476 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
481 err = n_tty_ioctl_helper(tty, file, cmd, arg);
489 * We don't provide read/write/poll interface for user space.
491 static ssize_t hci_uart_tty_read(struct tty_struct *tty, struct file *file,
492 unsigned char __user *buf, size_t nr)
497 static ssize_t hci_uart_tty_write(struct tty_struct *tty, struct file *file,
498 const unsigned char *data, size_t count)
503 static unsigned int hci_uart_tty_poll(struct tty_struct *tty,
504 struct file *filp, poll_table *wait)
509 static int __init hci_uart_init(void)
511 static struct tty_ldisc_ops hci_uart_ldisc;
514 BT_INFO("HCI UART driver ver %s", VERSION);
516 /* Register the tty discipline */
518 memset(&hci_uart_ldisc, 0, sizeof (hci_uart_ldisc));
519 hci_uart_ldisc.magic = TTY_LDISC_MAGIC;
520 hci_uart_ldisc.name = "n_hci";
521 hci_uart_ldisc.open = hci_uart_tty_open;
522 hci_uart_ldisc.close = hci_uart_tty_close;
523 hci_uart_ldisc.read = hci_uart_tty_read;
524 hci_uart_ldisc.write = hci_uart_tty_write;
525 hci_uart_ldisc.ioctl = hci_uart_tty_ioctl;
526 hci_uart_ldisc.poll = hci_uart_tty_poll;
527 hci_uart_ldisc.receive_buf = hci_uart_tty_receive;
528 hci_uart_ldisc.write_wakeup = hci_uart_tty_wakeup;
529 hci_uart_ldisc.owner = THIS_MODULE;
531 if ((err = tty_register_ldisc(N_HCI, &hci_uart_ldisc))) {
532 BT_ERR("HCI line discipline registration failed. (%d)", err);
536 #ifdef CONFIG_BT_HCIUART_H4
539 #ifdef CONFIG_BT_HCIUART_BCSP
542 #ifdef CONFIG_BT_HCIUART_LL
549 static void __exit hci_uart_exit(void)
553 #ifdef CONFIG_BT_HCIUART_H4
556 #ifdef CONFIG_BT_HCIUART_BCSP
559 #ifdef CONFIG_BT_HCIUART_LL
563 /* Release tty registration of line discipline */
564 if ((err = tty_unregister_ldisc(N_HCI)))
565 BT_ERR("Can't unregister HCI line discipline (%d)", err);
568 module_init(hci_uart_init);
569 module_exit(hci_uart_exit);
571 module_param(reset, bool, 0644);
572 MODULE_PARM_DESC(reset, "Send HCI reset command on initialization");
574 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
575 MODULE_DESCRIPTION("Bluetooth HCI UART driver ver " VERSION);
576 MODULE_VERSION(VERSION);
577 MODULE_LICENSE("GPL");
578 MODULE_ALIAS_LDISC(N_HCI);