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/config.h>
27 #include <linux/module.h>
29 #include <linux/kernel.h>
30 #include <linux/init.h>
31 #include <linux/sched.h>
32 #include <linux/types.h>
33 #include <linux/fcntl.h>
34 #include <linux/interrupt.h>
35 #include <linux/ptrace.h>
36 #include <linux/poll.h>
38 #include <linux/slab.h>
39 #include <linux/tty.h>
40 #include <linux/errno.h>
41 #include <linux/string.h>
42 #include <linux/signal.h>
43 #include <linux/ioctl.h>
44 #include <linux/skbuff.h>
46 #include <net/bluetooth/bluetooth.h>
47 #include <net/bluetooth/hci_core.h>
51 #ifndef CONFIG_BT_HCIUART_DEBUG
53 #define BT_DBG( A... )
60 static struct hci_uart_proto *hup[HCI_UART_MAX_PROTO];
62 int hci_uart_register_proto(struct hci_uart_proto *p)
64 if (p->id >= HCI_UART_MAX_PROTO)
75 int hci_uart_unregister_proto(struct hci_uart_proto *p)
77 if (p->id >= HCI_UART_MAX_PROTO)
88 static struct hci_uart_proto *hci_uart_get_proto(unsigned int id)
90 if (id >= HCI_UART_MAX_PROTO)
96 static inline void hci_uart_tx_complete(struct hci_uart *hu, int pkt_type)
98 struct hci_dev *hdev = hu->hdev;
100 /* Update HCI stat counters */
102 case HCI_COMMAND_PKT:
106 case HCI_ACLDATA_PKT:
110 case HCI_SCODATA_PKT:
116 static inline struct sk_buff *hci_uart_dequeue(struct hci_uart *hu)
118 struct sk_buff *skb = hu->tx_skb;
121 skb = hu->proto->dequeue(hu);
128 int hci_uart_tx_wakeup(struct hci_uart *hu)
130 struct tty_struct *tty = hu->tty;
131 struct hci_dev *hdev = hu->hdev;
134 if (test_and_set_bit(HCI_UART_SENDING, &hu->tx_state)) {
135 set_bit(HCI_UART_TX_WAKEUP, &hu->tx_state);
142 clear_bit(HCI_UART_TX_WAKEUP, &hu->tx_state);
144 while ((skb = hci_uart_dequeue(hu))) {
147 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
148 len = tty->driver->write(tty, skb->data, skb->len);
149 hdev->stat.byte_tx += len;
157 hci_uart_tx_complete(hu, bt_cb(skb)->pkt_type);
161 if (test_bit(HCI_UART_TX_WAKEUP, &hu->tx_state))
164 clear_bit(HCI_UART_SENDING, &hu->tx_state);
168 /* ------- Interface to HCI layer ------ */
169 /* Initialize device */
170 static int hci_uart_open(struct hci_dev *hdev)
172 BT_DBG("%s %p", hdev->name, hdev);
174 /* Nothing to do for UART driver */
176 set_bit(HCI_RUNNING, &hdev->flags);
182 static int hci_uart_flush(struct hci_dev *hdev)
184 struct hci_uart *hu = (struct hci_uart *) hdev->driver_data;
185 struct tty_struct *tty = hu->tty;
187 BT_DBG("hdev %p tty %p", hdev, tty);
190 kfree_skb(hu->tx_skb); hu->tx_skb = NULL;
193 /* Flush any pending characters in the driver and discipline. */
194 tty_ldisc_flush(tty);
195 if (tty->driver->flush_buffer)
196 tty->driver->flush_buffer(tty);
198 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
199 hu->proto->flush(hu);
205 static int hci_uart_close(struct hci_dev *hdev)
207 BT_DBG("hdev %p", hdev);
209 if (!test_and_clear_bit(HCI_RUNNING, &hdev->flags))
212 hci_uart_flush(hdev);
216 /* Send frames from HCI layer */
217 static int hci_uart_send_frame(struct sk_buff *skb)
219 struct hci_dev* hdev = (struct hci_dev *) skb->dev;
220 struct tty_struct *tty;
224 BT_ERR("Frame for uknown device (hdev=NULL)");
228 if (!test_bit(HCI_RUNNING, &hdev->flags))
231 hu = (struct hci_uart *) hdev->driver_data;
234 BT_DBG("%s: type %d len %d", hdev->name, bt_cb(skb)->pkt_type, skb->len);
236 hu->proto->enqueue(hu, skb);
238 hci_uart_tx_wakeup(hu);
243 static void hci_uart_destruct(struct hci_dev *hdev)
250 BT_DBG("%s", hdev->name);
252 hu = (struct hci_uart *) hdev->driver_data;
256 /* ------ LDISC part ------ */
259 * Called when line discipline changed to HCI_UART.
262 * tty pointer to tty info structure
264 * 0 if success, otherwise error code
266 static int hci_uart_tty_open(struct tty_struct *tty)
268 struct hci_uart *hu = (void *) tty->disc_data;
270 BT_DBG("tty %p", tty);
275 if (!(hu = kmalloc(sizeof(struct hci_uart), GFP_KERNEL))) {
276 BT_ERR("Can't allocate controll structure");
280 memset(hu, 0, sizeof(struct hci_uart));
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.flush_buffer)
293 tty->ldisc.flush_buffer(tty);
295 if (tty->driver->flush_buffer)
296 tty->driver->flush_buffer(tty);
301 /* hci_uart_tty_close()
303 * Called when the line discipline is changed to something
304 * else, the tty is closed, or the tty detects a hangup.
306 static void hci_uart_tty_close(struct tty_struct *tty)
308 struct hci_uart *hu = (void *)tty->disc_data;
310 BT_DBG("tty %p", tty);
312 /* Detach from the tty */
313 tty->disc_data = NULL;
316 struct hci_dev *hdev = hu->hdev;
317 hci_uart_close(hdev);
319 if (test_and_clear_bit(HCI_UART_PROTO_SET, &hu->flags)) {
320 hu->proto->close(hu);
321 hci_unregister_dev(hdev);
327 /* hci_uart_tty_wakeup()
329 * Callback for transmit wakeup. Called when low level
330 * device driver can accept more send data.
332 * Arguments: tty pointer to associated tty instance data
335 static void hci_uart_tty_wakeup(struct tty_struct *tty)
337 struct hci_uart *hu = (void *)tty->disc_data;
344 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
349 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
350 hci_uart_tx_wakeup(hu);
353 /* hci_uart_tty_room()
355 * Callback function from tty driver. Return the amount of
356 * space left in the receiver's buffer to decide if remote
357 * transmitter is to be throttled.
359 * Arguments: tty pointer to associated tty instance data
360 * Return Value: number of bytes left in receive buffer
362 static int hci_uart_tty_room (struct tty_struct *tty)
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);
391 hu->hdev->stat.byte_rx += count;
392 spin_unlock(&hu->rx_lock);
394 if (test_and_clear_bit(TTY_THROTTLED,&tty->flags) && tty->driver->unthrottle)
395 tty->driver->unthrottle(tty);
398 static int hci_uart_register_dev(struct hci_uart *hu)
400 struct hci_dev *hdev;
404 /* Initialize and register HCI device */
405 hdev = hci_alloc_dev();
407 BT_ERR("Can't allocate HCI device");
413 hdev->type = HCI_UART;
414 hdev->driver_data = hu;
416 hdev->open = hci_uart_open;
417 hdev->close = hci_uart_close;
418 hdev->flush = hci_uart_flush;
419 hdev->send = hci_uart_send_frame;
420 hdev->destruct = hci_uart_destruct;
422 hdev->owner = THIS_MODULE;
425 set_bit(HCI_QUIRK_RESET_ON_INIT, &hdev->quirks);
427 if (hci_register_dev(hdev) < 0) {
428 BT_ERR("Can't register HCI device");
436 static int hci_uart_set_proto(struct hci_uart *hu, int id)
438 struct hci_uart_proto *p;
441 p = hci_uart_get_proto(id);
443 return -EPROTONOSUPPORT;
451 err = hci_uart_register_dev(hu);
460 /* hci_uart_tty_ioctl()
462 * Process IOCTL system call for the tty device.
466 * tty pointer to tty instance data
467 * file pointer to open file object for device
468 * cmd IOCTL command code
469 * arg argument for IOCTL call (cmd dependent)
471 * Return Value: Command dependent
473 static int hci_uart_tty_ioctl(struct tty_struct *tty, struct file * file,
474 unsigned int cmd, unsigned long arg)
476 struct hci_uart *hu = (void *)tty->disc_data;
481 /* Verify the status of the device */
486 case HCIUARTSETPROTO:
487 if (!test_and_set_bit(HCI_UART_PROTO_SET, &hu->flags)) {
488 err = hci_uart_set_proto(hu, arg);
490 clear_bit(HCI_UART_PROTO_SET, &hu->flags);
493 tty->low_latency = 1;
497 case HCIUARTGETPROTO:
498 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
499 return hu->proto->id;
503 err = n_tty_ioctl(tty, file, cmd, arg);
511 * We don't provide read/write/poll interface for user space.
513 static ssize_t hci_uart_tty_read(struct tty_struct *tty, struct file *file,
514 unsigned char __user *buf, size_t nr)
519 static ssize_t hci_uart_tty_write(struct tty_struct *tty, struct file *file,
520 const unsigned char *data, size_t count)
525 static unsigned int hci_uart_tty_poll(struct tty_struct *tty,
526 struct file *filp, poll_table *wait)
531 static int __init hci_uart_init(void)
533 static struct tty_ldisc hci_uart_ldisc;
536 BT_INFO("HCI UART driver ver %s", VERSION);
538 /* Register the tty discipline */
540 memset(&hci_uart_ldisc, 0, sizeof (hci_uart_ldisc));
541 hci_uart_ldisc.magic = TTY_LDISC_MAGIC;
542 hci_uart_ldisc.name = "n_hci";
543 hci_uart_ldisc.open = hci_uart_tty_open;
544 hci_uart_ldisc.close = hci_uart_tty_close;
545 hci_uart_ldisc.read = hci_uart_tty_read;
546 hci_uart_ldisc.write = hci_uart_tty_write;
547 hci_uart_ldisc.ioctl = hci_uart_tty_ioctl;
548 hci_uart_ldisc.poll = hci_uart_tty_poll;
549 hci_uart_ldisc.receive_room = hci_uart_tty_room;
550 hci_uart_ldisc.receive_buf = hci_uart_tty_receive;
551 hci_uart_ldisc.write_wakeup = hci_uart_tty_wakeup;
552 hci_uart_ldisc.owner = THIS_MODULE;
554 if ((err = tty_register_ldisc(N_HCI, &hci_uart_ldisc))) {
555 BT_ERR("HCI line discipline registration failed. (%d)", err);
559 #ifdef CONFIG_BT_HCIUART_H4
562 #ifdef CONFIG_BT_HCIUART_BCSP
569 static void __exit hci_uart_exit(void)
573 #ifdef CONFIG_BT_HCIUART_H4
576 #ifdef CONFIG_BT_HCIUART_BCSP
580 /* Release tty registration of line discipline */
581 if ((err = tty_unregister_ldisc(N_HCI)))
582 BT_ERR("Can't unregister HCI line discipline (%d)", err);
585 module_init(hci_uart_init);
586 module_exit(hci_uart_exit);
588 module_param(reset, bool, 0644);
589 MODULE_PARM_DESC(reset, "Send HCI reset command on initialization");
591 MODULE_AUTHOR("Maxim Krasnyansky <maxk@qualcomm.com>, Marcel Holtmann <marcel@holtmann.org>");
592 MODULE_DESCRIPTION("Bluetooth HCI UART driver ver " VERSION);
593 MODULE_VERSION(VERSION);
594 MODULE_LICENSE("GPL");
595 MODULE_ALIAS_LDISC(N_HCI);