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/sched.h>
31 #include <linux/types.h>
32 #include <linux/fcntl.h>
33 #include <linux/interrupt.h>
34 #include <linux/ptrace.h>
35 #include <linux/poll.h>
37 #include <linux/slab.h>
38 #include <linux/tty.h>
39 #include <linux/errno.h>
40 #include <linux/string.h>
41 #include <linux/signal.h>
42 #include <linux/ioctl.h>
43 #include <linux/skbuff.h>
45 #include <net/bluetooth/bluetooth.h>
46 #include <net/bluetooth/hci_core.h>
50 #ifndef CONFIG_BT_HCIUART_DEBUG
52 #define BT_DBG( A... )
59 static struct hci_uart_proto *hup[HCI_UART_MAX_PROTO];
61 int hci_uart_register_proto(struct hci_uart_proto *p)
63 if (p->id >= HCI_UART_MAX_PROTO)
74 int hci_uart_unregister_proto(struct hci_uart_proto *p)
76 if (p->id >= HCI_UART_MAX_PROTO)
87 static struct hci_uart_proto *hci_uart_get_proto(unsigned int id)
89 if (id >= HCI_UART_MAX_PROTO)
95 static inline void hci_uart_tx_complete(struct hci_uart *hu, int pkt_type)
97 struct hci_dev *hdev = hu->hdev;
99 /* Update HCI stat counters */
101 case HCI_COMMAND_PKT:
105 case HCI_ACLDATA_PKT:
109 case HCI_SCODATA_PKT:
115 static inline struct sk_buff *hci_uart_dequeue(struct hci_uart *hu)
117 struct sk_buff *skb = hu->tx_skb;
120 skb = hu->proto->dequeue(hu);
127 int hci_uart_tx_wakeup(struct hci_uart *hu)
129 struct tty_struct *tty = hu->tty;
130 struct hci_dev *hdev = hu->hdev;
133 if (test_and_set_bit(HCI_UART_SENDING, &hu->tx_state)) {
134 set_bit(HCI_UART_TX_WAKEUP, &hu->tx_state);
141 clear_bit(HCI_UART_TX_WAKEUP, &hu->tx_state);
143 while ((skb = hci_uart_dequeue(hu))) {
146 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
147 len = tty->driver->write(tty, skb->data, skb->len);
148 hdev->stat.byte_tx += len;
156 hci_uart_tx_complete(hu, bt_cb(skb)->pkt_type);
160 if (test_bit(HCI_UART_TX_WAKEUP, &hu->tx_state))
163 clear_bit(HCI_UART_SENDING, &hu->tx_state);
167 /* ------- Interface to HCI layer ------ */
168 /* Initialize device */
169 static int hci_uart_open(struct hci_dev *hdev)
171 BT_DBG("%s %p", hdev->name, hdev);
173 /* Nothing to do for UART driver */
175 set_bit(HCI_RUNNING, &hdev->flags);
181 static int hci_uart_flush(struct hci_dev *hdev)
183 struct hci_uart *hu = (struct hci_uart *) hdev->driver_data;
184 struct tty_struct *tty = hu->tty;
186 BT_DBG("hdev %p tty %p", hdev, tty);
189 kfree_skb(hu->tx_skb); hu->tx_skb = NULL;
192 /* Flush any pending characters in the driver and discipline. */
193 tty_ldisc_flush(tty);
194 if (tty->driver && tty->driver->flush_buffer)
195 tty->driver->flush_buffer(tty);
197 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
198 hu->proto->flush(hu);
204 static int hci_uart_close(struct hci_dev *hdev)
206 BT_DBG("hdev %p", hdev);
208 if (!test_and_clear_bit(HCI_RUNNING, &hdev->flags))
211 hci_uart_flush(hdev);
215 /* Send frames from HCI layer */
216 static int hci_uart_send_frame(struct sk_buff *skb)
218 struct hci_dev* hdev = (struct hci_dev *) skb->dev;
219 struct tty_struct *tty;
223 BT_ERR("Frame for uknown device (hdev=NULL)");
227 if (!test_bit(HCI_RUNNING, &hdev->flags))
230 hu = (struct hci_uart *) hdev->driver_data;
233 BT_DBG("%s: type %d len %d", hdev->name, bt_cb(skb)->pkt_type, skb->len);
235 hu->proto->enqueue(hu, skb);
237 hci_uart_tx_wakeup(hu);
242 static void hci_uart_destruct(struct hci_dev *hdev)
247 BT_DBG("%s", hdev->name);
248 kfree(hdev->driver_data);
251 /* ------ LDISC part ------ */
254 * Called when line discipline changed to HCI_UART.
257 * tty pointer to tty info structure
259 * 0 if success, otherwise error code
261 static int hci_uart_tty_open(struct tty_struct *tty)
263 struct hci_uart *hu = (void *) tty->disc_data;
265 BT_DBG("tty %p", tty);
270 if (!(hu = kzalloc(sizeof(struct hci_uart), GFP_KERNEL))) {
271 BT_ERR("Can't allocate control structure");
277 tty->receive_room = 65536;
279 spin_lock_init(&hu->rx_lock);
281 /* Flush any pending characters in the driver and line discipline. */
283 /* FIXME: why is this needed. Note don't use ldisc_ref here as the
284 open path is before the ldisc is referencable */
286 if (tty->ldisc.flush_buffer)
287 tty->ldisc.flush_buffer(tty);
289 if (tty->driver && tty->driver->flush_buffer)
290 tty->driver->flush_buffer(tty);
295 /* hci_uart_tty_close()
297 * Called when the line discipline is changed to something
298 * else, the tty is closed, or the tty detects a hangup.
300 static void hci_uart_tty_close(struct tty_struct *tty)
302 struct hci_uart *hu = (void *)tty->disc_data;
304 BT_DBG("tty %p", tty);
306 /* Detach from the tty */
307 tty->disc_data = NULL;
310 struct hci_dev *hdev = hu->hdev;
311 hci_uart_close(hdev);
313 if (test_and_clear_bit(HCI_UART_PROTO_SET, &hu->flags)) {
314 hu->proto->close(hu);
315 hci_unregister_dev(hdev);
321 /* hci_uart_tty_wakeup()
323 * Callback for transmit wakeup. Called when low level
324 * device driver can accept more send data.
326 * Arguments: tty pointer to associated tty instance data
329 static void hci_uart_tty_wakeup(struct tty_struct *tty)
331 struct hci_uart *hu = (void *)tty->disc_data;
338 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
343 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
344 hci_uart_tx_wakeup(hu);
347 /* hci_uart_tty_receive()
349 * Called by tty low level driver when receive data is
352 * Arguments: tty pointer to tty isntance data
353 * data pointer to received data
354 * flags pointer to flags for data
355 * count count of received data in bytes
359 static void hci_uart_tty_receive(struct tty_struct *tty, const u8 *data, char *flags, int count)
361 struct hci_uart *hu = (void *)tty->disc_data;
363 if (!hu || tty != hu->tty)
366 if (!test_bit(HCI_UART_PROTO_SET, &hu->flags))
369 spin_lock(&hu->rx_lock);
370 hu->proto->recv(hu, (void *) data, count);
371 hu->hdev->stat.byte_rx += count;
372 spin_unlock(&hu->rx_lock);
374 if (test_and_clear_bit(TTY_THROTTLED, &tty->flags) &&
375 tty->driver->unthrottle)
376 tty->driver->unthrottle(tty);
379 static int hci_uart_register_dev(struct hci_uart *hu)
381 struct hci_dev *hdev;
385 /* Initialize and register HCI device */
386 hdev = hci_alloc_dev();
388 BT_ERR("Can't allocate HCI device");
394 hdev->type = HCI_UART;
395 hdev->driver_data = hu;
397 hdev->open = hci_uart_open;
398 hdev->close = hci_uart_close;
399 hdev->flush = hci_uart_flush;
400 hdev->send = hci_uart_send_frame;
401 hdev->destruct = hci_uart_destruct;
403 hdev->owner = THIS_MODULE;
406 set_bit(HCI_QUIRK_RESET_ON_INIT, &hdev->quirks);
408 if (hci_register_dev(hdev) < 0) {
409 BT_ERR("Can't register HCI device");
417 static int hci_uart_set_proto(struct hci_uart *hu, int id)
419 struct hci_uart_proto *p;
422 p = hci_uart_get_proto(id);
424 return -EPROTONOSUPPORT;
432 err = hci_uart_register_dev(hu);
441 /* hci_uart_tty_ioctl()
443 * Process IOCTL system call for the tty device.
447 * tty pointer to tty instance data
448 * file pointer to open file object for device
449 * cmd IOCTL command code
450 * arg argument for IOCTL call (cmd dependent)
452 * Return Value: Command dependent
454 static int hci_uart_tty_ioctl(struct tty_struct *tty, struct file * file,
455 unsigned int cmd, unsigned long arg)
457 struct hci_uart *hu = (void *)tty->disc_data;
462 /* Verify the status of the device */
467 case HCIUARTSETPROTO:
468 if (!test_and_set_bit(HCI_UART_PROTO_SET, &hu->flags)) {
469 err = hci_uart_set_proto(hu, arg);
471 clear_bit(HCI_UART_PROTO_SET, &hu->flags);
474 tty->low_latency = 1;
478 case HCIUARTGETPROTO:
479 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
480 return hu->proto->id;
484 err = n_tty_ioctl(tty, file, cmd, arg);
492 * We don't provide read/write/poll interface for user space.
494 static ssize_t hci_uart_tty_read(struct tty_struct *tty, struct file *file,
495 unsigned char __user *buf, size_t nr)
500 static ssize_t hci_uart_tty_write(struct tty_struct *tty, struct file *file,
501 const unsigned char *data, size_t count)
506 static unsigned int hci_uart_tty_poll(struct tty_struct *tty,
507 struct file *filp, poll_table *wait)
512 static int __init hci_uart_init(void)
514 static struct tty_ldisc hci_uart_ldisc;
517 BT_INFO("HCI UART driver ver %s", VERSION);
519 /* Register the tty discipline */
521 memset(&hci_uart_ldisc, 0, sizeof (hci_uart_ldisc));
522 hci_uart_ldisc.magic = TTY_LDISC_MAGIC;
523 hci_uart_ldisc.name = "n_hci";
524 hci_uart_ldisc.open = hci_uart_tty_open;
525 hci_uart_ldisc.close = hci_uart_tty_close;
526 hci_uart_ldisc.read = hci_uart_tty_read;
527 hci_uart_ldisc.write = hci_uart_tty_write;
528 hci_uart_ldisc.ioctl = hci_uart_tty_ioctl;
529 hci_uart_ldisc.poll = hci_uart_tty_poll;
530 hci_uart_ldisc.receive_buf = hci_uart_tty_receive;
531 hci_uart_ldisc.write_wakeup = hci_uart_tty_wakeup;
532 hci_uart_ldisc.owner = THIS_MODULE;
534 if ((err = tty_register_ldisc(N_HCI, &hci_uart_ldisc))) {
535 BT_ERR("HCI line discipline registration failed. (%d)", err);
539 #ifdef CONFIG_BT_HCIUART_H4
542 #ifdef CONFIG_BT_HCIUART_BCSP
549 static void __exit hci_uart_exit(void)
553 #ifdef CONFIG_BT_HCIUART_H4
556 #ifdef CONFIG_BT_HCIUART_BCSP
560 /* Release tty registration of line discipline */
561 if ((err = tty_unregister_ldisc(N_HCI)))
562 BT_ERR("Can't unregister HCI line discipline (%d)", err);
565 module_init(hci_uart_init);
566 module_exit(hci_uart_exit);
568 module_param(reset, bool, 0644);
569 MODULE_PARM_DESC(reset, "Send HCI reset command on initialization");
571 MODULE_AUTHOR("Maxim Krasnyansky <maxk@qualcomm.com>, Marcel Holtmann <marcel@holtmann.org>");
572 MODULE_DESCRIPTION("Bluetooth HCI UART driver ver " VERSION);
573 MODULE_VERSION(VERSION);
574 MODULE_LICENSE("GPL");
575 MODULE_ALIAS_LDISC(N_HCI);