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 #ifdef CONFIG_BT_HCIBCM4325
50 extern int bcm4325_sleep(int bSleep);
57 static struct hci_uart_proto *hup[HCI_UART_MAX_PROTO];
59 int hci_uart_register_proto(struct hci_uart_proto *p)
61 if (p->id >= HCI_UART_MAX_PROTO)
72 int hci_uart_unregister_proto(struct hci_uart_proto *p)
74 if (p->id >= HCI_UART_MAX_PROTO)
85 static struct hci_uart_proto *hci_uart_get_proto(unsigned int id)
87 if (id >= HCI_UART_MAX_PROTO)
93 static inline void hci_uart_tx_complete(struct hci_uart *hu, int pkt_type)
95 struct hci_dev *hdev = hu->hdev;
97 /* Update HCI stat counters */
103 case HCI_ACLDATA_PKT:
107 case HCI_SCODATA_PKT:
113 static inline struct sk_buff *hci_uart_dequeue(struct hci_uart *hu)
115 struct sk_buff *skb = hu->tx_skb;
118 skb = hu->proto->dequeue(hu);
125 int hci_uart_tx_wakeup(struct hci_uart *hu)
127 struct tty_struct *tty = hu->tty;
128 struct hci_dev *hdev = hu->hdev;
131 if (test_and_set_bit(HCI_UART_SENDING, &hu->tx_state)) {
132 set_bit(HCI_UART_TX_WAKEUP, &hu->tx_state);
139 clear_bit(HCI_UART_TX_WAKEUP, &hu->tx_state);
140 /*added by Barry,for broadcom 4325*/
141 #ifdef CONFIG_BT_HCIBCM4325
144 while ((skb = hci_uart_dequeue(hu))) {
147 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
148 len = tty->ops->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 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);
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;
223 BT_ERR("Frame for unknown device (hdev=NULL)");
227 if (!test_bit(HCI_RUNNING, &hdev->flags))
230 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);
266 /* FIXME: This btw is bogus, nothing requires the old ldisc to clear
271 /* Error if the tty has no write op instead of leaving an exploitable
273 if (tty->ops->write == NULL)
276 if (!(hu = kzalloc(sizeof(struct hci_uart), GFP_KERNEL))) {
277 BT_ERR("Can't allocate control structure");
283 tty->receive_room = 65536;
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;
308 BT_DBG("tty %p", tty);
310 /* Detach from the tty */
311 tty->disc_data = NULL;
314 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_receive()
355 * Called by tty low level driver when receive data is
358 * Arguments: tty pointer to tty isntance data
359 * data pointer to received data
360 * flags pointer to flags for data
361 * count count of received data in bytes
365 static void hci_uart_tty_receive(struct tty_struct *tty, const u8 *data, char *flags, int count)
367 struct hci_uart *hu = (void *)tty->disc_data;
369 if (!hu || tty != hu->tty)
372 if (!test_bit(HCI_UART_PROTO_SET, &hu->flags))
375 spin_lock(&hu->rx_lock);
376 hu->proto->recv(hu, (void *) data, count);
377 hu->hdev->stat.byte_rx += count;
378 spin_unlock(&hu->rx_lock);
383 static int hci_uart_register_dev(struct hci_uart *hu)
385 struct hci_dev *hdev;
389 /* Initialize and register HCI device */
390 hdev = hci_alloc_dev();
392 BT_ERR("Can't allocate HCI device");
398 hdev->bus = HCI_UART;
399 hdev->driver_data = hu;
401 hdev->open = hci_uart_open;
402 hdev->close = hci_uart_close;
403 hdev->flush = hci_uart_flush;
404 hdev->send = hci_uart_send_frame;
405 hdev->destruct = hci_uart_destruct;
407 hdev->owner = THIS_MODULE;
410 set_bit(HCI_QUIRK_NO_RESET, &hdev->quirks);
412 if (test_bit(HCI_UART_RAW_DEVICE, &hu->hdev_flags))
413 set_bit(HCI_QUIRK_RAW_DEVICE, &hdev->quirks);
415 if (hci_register_dev(hdev) < 0) {
416 BT_ERR("Can't register HCI device");
424 static int hci_uart_set_proto(struct hci_uart *hu, int id)
426 struct hci_uart_proto *p;
429 p = hci_uart_get_proto(id);
431 return -EPROTONOSUPPORT;
439 err = hci_uart_register_dev(hu);
448 /* hci_uart_tty_ioctl()
450 * Process IOCTL system call for the tty device.
454 * tty pointer to tty instance data
455 * file pointer to open file object for device
456 * cmd IOCTL command code
457 * arg argument for IOCTL call (cmd dependent)
459 * Return Value: Command dependent
461 static int hci_uart_tty_ioctl(struct tty_struct *tty, struct file * file,
462 unsigned int cmd, unsigned long arg)
464 struct hci_uart *hu = (void *)tty->disc_data;
469 /* Verify the status of the device */
474 case HCIUARTSETPROTO:
475 if (!test_and_set_bit(HCI_UART_PROTO_SET, &hu->flags)) {
476 err = hci_uart_set_proto(hu, arg);
478 clear_bit(HCI_UART_PROTO_SET, &hu->flags);
485 case HCIUARTGETPROTO:
486 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
487 return hu->proto->id;
490 case HCIUARTGETDEVICE:
491 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
495 case HCIUARTSETFLAGS:
496 if (test_bit(HCI_UART_PROTO_SET, &hu->flags))
498 hu->hdev_flags = arg;
501 case HCIUARTGETFLAGS:
502 return hu->hdev_flags;
505 err = n_tty_ioctl_helper(tty, file, cmd, arg);
513 * We don't provide read/write/poll interface for user space.
515 static ssize_t hci_uart_tty_read(struct tty_struct *tty, struct file *file,
516 unsigned char __user *buf, size_t nr)
521 static ssize_t hci_uart_tty_write(struct tty_struct *tty, struct file *file,
522 const unsigned char *data, size_t count)
527 static unsigned int hci_uart_tty_poll(struct tty_struct *tty,
528 struct file *filp, poll_table *wait)
533 static int __init hci_uart_init(void)
535 static struct tty_ldisc_ops hci_uart_ldisc;
538 BT_INFO("HCI UART driver ver %s", VERSION);
540 /* Register the tty discipline */
542 memset(&hci_uart_ldisc, 0, sizeof (hci_uart_ldisc));
543 hci_uart_ldisc.magic = TTY_LDISC_MAGIC;
544 hci_uart_ldisc.name = "n_hci";
545 hci_uart_ldisc.open = hci_uart_tty_open;
546 hci_uart_ldisc.close = hci_uart_tty_close;
547 hci_uart_ldisc.read = hci_uart_tty_read;
548 hci_uart_ldisc.write = hci_uart_tty_write;
549 hci_uart_ldisc.ioctl = hci_uart_tty_ioctl;
550 hci_uart_ldisc.poll = hci_uart_tty_poll;
551 hci_uart_ldisc.receive_buf = hci_uart_tty_receive;
552 hci_uart_ldisc.write_wakeup = hci_uart_tty_wakeup;
553 hci_uart_ldisc.owner = THIS_MODULE;
555 if ((err = tty_register_ldisc(N_HCI, &hci_uart_ldisc))) {
556 BT_ERR("HCI line discipline registration failed. (%d)", err);
560 #ifdef CONFIG_BT_HCIUART_H4
563 #ifdef CONFIG_BT_HCIUART_BCSP
566 #ifdef CONFIG_BT_HCIUART_LL
569 #ifdef CONFIG_BT_HCIUART_ATH3K
576 static void __exit hci_uart_exit(void)
580 #ifdef CONFIG_BT_HCIUART_H4
583 #ifdef CONFIG_BT_HCIUART_BCSP
586 #ifdef CONFIG_BT_HCIUART_LL
589 #ifdef CONFIG_BT_HCIUART_ATH3K
593 /* Release tty registration of line discipline */
594 if ((err = tty_unregister_ldisc(N_HCI)))
595 BT_ERR("Can't unregister HCI line discipline (%d)", err);
598 module_init(hci_uart_init);
599 module_exit(hci_uart_exit);
601 module_param(reset, bool, 0644);
602 MODULE_PARM_DESC(reset, "Send HCI reset command on initialization");
604 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
605 MODULE_DESCRIPTION("Bluetooth HCI UART driver ver " VERSION);
606 MODULE_VERSION(VERSION);
607 MODULE_LICENSE("GPL");
608 MODULE_ALIAS_LDISC(N_HCI);