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>
49 #ifndef CONFIG_BT_HCIUART_DEBUG
51 #define BT_DBG( A... )
58 static struct hci_uart_proto *hup[HCI_UART_MAX_PROTO];
60 int hci_uart_register_proto(struct hci_uart_proto *p)
62 if (p->id >= HCI_UART_MAX_PROTO)
73 int hci_uart_unregister_proto(struct hci_uart_proto *p)
75 if (p->id >= HCI_UART_MAX_PROTO)
86 static struct hci_uart_proto *hci_uart_get_proto(unsigned int id)
88 if (id >= HCI_UART_MAX_PROTO)
94 static inline void hci_uart_tx_complete(struct hci_uart *hu, int pkt_type)
96 struct hci_dev *hdev = hu->hdev;
98 /* Update HCI stat counters */
100 case HCI_COMMAND_PKT:
104 case HCI_ACLDATA_PKT:
108 case HCI_SCODATA_PKT:
114 static inline struct sk_buff *hci_uart_dequeue(struct hci_uart *hu)
116 struct sk_buff *skb = hu->tx_skb;
119 skb = hu->proto->dequeue(hu);
126 int hci_uart_tx_wakeup(struct hci_uart *hu)
128 struct tty_struct *tty = hu->tty;
129 struct hci_dev *hdev = hu->hdev;
132 if (test_and_set_bit(HCI_UART_SENDING, &hu->tx_state)) {
133 set_bit(HCI_UART_TX_WAKEUP, &hu->tx_state);
140 clear_bit(HCI_UART_TX_WAKEUP, &hu->tx_state);
142 while ((skb = hci_uart_dequeue(hu))) {
145 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
146 len = tty->ops->write(tty, skb->data, skb->len);
147 hdev->stat.byte_tx += len;
155 hci_uart_tx_complete(hu, bt_cb(skb)->pkt_type);
159 if (test_bit(HCI_UART_TX_WAKEUP, &hu->tx_state))
162 clear_bit(HCI_UART_SENDING, &hu->tx_state);
166 /* ------- Interface to HCI layer ------ */
167 /* Initialize device */
168 static int hci_uart_open(struct hci_dev *hdev)
170 BT_DBG("%s %p", hdev->name, hdev);
172 /* Nothing to do for UART driver */
174 set_bit(HCI_RUNNING, &hdev->flags);
180 static int hci_uart_flush(struct hci_dev *hdev)
182 struct hci_uart *hu = (struct hci_uart *) hdev->driver_data;
183 struct tty_struct *tty = hu->tty;
185 BT_DBG("hdev %p tty %p", hdev, tty);
188 kfree_skb(hu->tx_skb); hu->tx_skb = NULL;
191 /* Flush any pending characters in the driver and discipline. */
192 tty_ldisc_flush(tty);
193 tty_driver_flush_buffer(tty);
195 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
196 hu->proto->flush(hu);
202 static int hci_uart_close(struct hci_dev *hdev)
204 BT_DBG("hdev %p", hdev);
206 if (!test_and_clear_bit(HCI_RUNNING, &hdev->flags))
209 hci_uart_flush(hdev);
214 /* Send frames from HCI layer */
215 static int hci_uart_send_frame(struct sk_buff *skb)
217 struct hci_dev* hdev = (struct hci_dev *) skb->dev;
218 struct tty_struct *tty;
222 BT_ERR("Frame for uknown device (hdev=NULL)");
226 if (!test_bit(HCI_RUNNING, &hdev->flags))
229 hu = (struct hci_uart *) hdev->driver_data;
232 BT_DBG("%s: type %d len %d", hdev->name, bt_cb(skb)->pkt_type, skb->len);
234 hu->proto->enqueue(hu, skb);
236 hci_uart_tx_wakeup(hu);
241 static void hci_uart_destruct(struct hci_dev *hdev)
246 BT_DBG("%s", hdev->name);
247 kfree(hdev->driver_data);
250 /* ------ LDISC part ------ */
253 * Called when line discipline changed to HCI_UART.
256 * tty pointer to tty info structure
258 * 0 if success, otherwise error code
260 static int hci_uart_tty_open(struct tty_struct *tty)
262 struct hci_uart *hu = (void *) tty->disc_data;
264 BT_DBG("tty %p", tty);
269 if (!(hu = kzalloc(sizeof(struct hci_uart), GFP_KERNEL))) {
270 BT_ERR("Can't allocate control structure");
276 tty->receive_room = 65536;
278 spin_lock_init(&hu->rx_lock);
280 /* Flush any pending characters in the driver and line discipline. */
282 /* FIXME: why is this needed. Note don't use ldisc_ref here as the
283 open path is before the ldisc is referencable */
285 if (tty->ldisc.ops->flush_buffer)
286 tty->ldisc.ops->flush_buffer(tty);
287 tty_driver_flush_buffer(tty);
292 /* hci_uart_tty_close()
294 * Called when the line discipline is changed to something
295 * else, the tty is closed, or the tty detects a hangup.
297 static void hci_uart_tty_close(struct tty_struct *tty)
299 struct hci_uart *hu = (void *)tty->disc_data;
301 BT_DBG("tty %p", tty);
303 /* Detach from the tty */
304 tty->disc_data = NULL;
307 struct hci_dev *hdev = hu->hdev;
310 hci_uart_close(hdev);
312 if (test_and_clear_bit(HCI_UART_PROTO_SET, &hu->flags)) {
313 hu->proto->close(hu);
314 hci_unregister_dev(hdev);
320 /* hci_uart_tty_wakeup()
322 * Callback for transmit wakeup. Called when low level
323 * device driver can accept more send data.
325 * Arguments: tty pointer to associated tty instance data
328 static void hci_uart_tty_wakeup(struct tty_struct *tty)
330 struct hci_uart *hu = (void *)tty->disc_data;
337 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
342 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
343 hci_uart_tx_wakeup(hu);
346 /* hci_uart_tty_receive()
348 * Called by tty low level driver when receive data is
351 * Arguments: tty pointer to tty isntance data
352 * data pointer to received data
353 * flags pointer to flags for data
354 * count count of received data in bytes
358 static void hci_uart_tty_receive(struct tty_struct *tty, const u8 *data, char *flags, int count)
360 struct hci_uart *hu = (void *)tty->disc_data;
362 if (!hu || tty != hu->tty)
365 if (!test_bit(HCI_UART_PROTO_SET, &hu->flags))
368 spin_lock(&hu->rx_lock);
369 hu->proto->recv(hu, (void *) data, count);
370 hu->hdev->stat.byte_rx += count;
371 spin_unlock(&hu->rx_lock);
376 static int hci_uart_register_dev(struct hci_uart *hu)
378 struct hci_dev *hdev;
382 /* Initialize and register HCI device */
383 hdev = hci_alloc_dev();
385 BT_ERR("Can't allocate HCI device");
391 hdev->type = HCI_UART;
392 hdev->driver_data = hu;
394 hdev->open = hci_uart_open;
395 hdev->close = hci_uart_close;
396 hdev->flush = hci_uart_flush;
397 hdev->send = hci_uart_send_frame;
398 hdev->destruct = hci_uart_destruct;
400 hdev->owner = THIS_MODULE;
403 set_bit(HCI_QUIRK_RESET_ON_INIT, &hdev->quirks);
405 if (hci_register_dev(hdev) < 0) {
406 BT_ERR("Can't register HCI device");
414 static int hci_uart_set_proto(struct hci_uart *hu, int id)
416 struct hci_uart_proto *p;
419 p = hci_uart_get_proto(id);
421 return -EPROTONOSUPPORT;
429 err = hci_uart_register_dev(hu);
438 /* hci_uart_tty_ioctl()
440 * Process IOCTL system call for the tty device.
444 * tty pointer to tty instance data
445 * file pointer to open file object for device
446 * cmd IOCTL command code
447 * arg argument for IOCTL call (cmd dependent)
449 * Return Value: Command dependent
451 static int hci_uart_tty_ioctl(struct tty_struct *tty, struct file * file,
452 unsigned int cmd, unsigned long arg)
454 struct hci_uart *hu = (void *)tty->disc_data;
459 /* Verify the status of the device */
464 case HCIUARTSETPROTO:
465 if (!test_and_set_bit(HCI_UART_PROTO_SET, &hu->flags)) {
466 err = hci_uart_set_proto(hu, arg);
468 clear_bit(HCI_UART_PROTO_SET, &hu->flags);
471 tty->low_latency = 1;
476 case HCIUARTGETPROTO:
477 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
478 return hu->proto->id;
481 case HCIUARTGETDEVICE:
482 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
487 err = n_tty_ioctl_helper(tty, file, cmd, arg);
495 * We don't provide read/write/poll interface for user space.
497 static ssize_t hci_uart_tty_read(struct tty_struct *tty, struct file *file,
498 unsigned char __user *buf, size_t nr)
503 static ssize_t hci_uart_tty_write(struct tty_struct *tty, struct file *file,
504 const unsigned char *data, size_t count)
509 static unsigned int hci_uart_tty_poll(struct tty_struct *tty,
510 struct file *filp, poll_table *wait)
515 static int __init hci_uart_init(void)
517 static struct tty_ldisc_ops hci_uart_ldisc;
520 BT_INFO("HCI UART driver ver %s", VERSION);
522 /* Register the tty discipline */
524 memset(&hci_uart_ldisc, 0, sizeof (hci_uart_ldisc));
525 hci_uart_ldisc.magic = TTY_LDISC_MAGIC;
526 hci_uart_ldisc.name = "n_hci";
527 hci_uart_ldisc.open = hci_uart_tty_open;
528 hci_uart_ldisc.close = hci_uart_tty_close;
529 hci_uart_ldisc.read = hci_uart_tty_read;
530 hci_uart_ldisc.write = hci_uart_tty_write;
531 hci_uart_ldisc.ioctl = hci_uart_tty_ioctl;
532 hci_uart_ldisc.poll = hci_uart_tty_poll;
533 hci_uart_ldisc.receive_buf = hci_uart_tty_receive;
534 hci_uart_ldisc.write_wakeup = hci_uart_tty_wakeup;
535 hci_uart_ldisc.owner = THIS_MODULE;
537 if ((err = tty_register_ldisc(N_HCI, &hci_uart_ldisc))) {
538 BT_ERR("HCI line discipline registration failed. (%d)", err);
542 #ifdef CONFIG_BT_HCIUART_H4
545 #ifdef CONFIG_BT_HCIUART_BCSP
548 #ifdef CONFIG_BT_HCIUART_LL
555 static void __exit hci_uart_exit(void)
559 #ifdef CONFIG_BT_HCIUART_H4
562 #ifdef CONFIG_BT_HCIUART_BCSP
565 #ifdef CONFIG_BT_HCIUART_LL
569 /* Release tty registration of line discipline */
570 if ((err = tty_unregister_ldisc(N_HCI)))
571 BT_ERR("Can't unregister HCI line discipline (%d)", err);
574 module_init(hci_uart_init);
575 module_exit(hci_uart_exit);
577 module_param(reset, bool, 0644);
578 MODULE_PARM_DESC(reset, "Send HCI reset command on initialization");
580 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
581 MODULE_DESCRIPTION("Bluetooth HCI UART driver ver " VERSION);
582 MODULE_VERSION(VERSION);
583 MODULE_LICENSE("GPL");
584 MODULE_ALIAS_LDISC(N_HCI);