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>
51 static struct hci_uart_proto
*hup
[HCI_UART_MAX_PROTO
];
53 int hci_uart_register_proto(struct hci_uart_proto
*p
)
55 if (p
->id
>= HCI_UART_MAX_PROTO
)
66 int hci_uart_unregister_proto(struct hci_uart_proto
*p
)
68 if (p
->id
>= HCI_UART_MAX_PROTO
)
79 static struct hci_uart_proto
*hci_uart_get_proto(unsigned int id
)
81 if (id
>= HCI_UART_MAX_PROTO
)
87 static inline void hci_uart_tx_complete(struct hci_uart
*hu
, int pkt_type
)
89 struct hci_dev
*hdev
= hu
->hdev
;
91 /* Update HCI stat counters */
101 case HCI_SCODATA_PKT
:
107 static inline struct sk_buff
*hci_uart_dequeue(struct hci_uart
*hu
)
109 struct sk_buff
*skb
= hu
->tx_skb
;
112 skb
= hu
->proto
->dequeue(hu
);
119 int hci_uart_tx_wakeup(struct hci_uart
*hu
)
121 struct tty_struct
*tty
= hu
->tty
;
122 struct hci_dev
*hdev
= hu
->hdev
;
125 if (test_and_set_bit(HCI_UART_SENDING
, &hu
->tx_state
)) {
126 set_bit(HCI_UART_TX_WAKEUP
, &hu
->tx_state
);
133 clear_bit(HCI_UART_TX_WAKEUP
, &hu
->tx_state
);
135 while ((skb
= hci_uart_dequeue(hu
))) {
138 set_bit(TTY_DO_WRITE_WAKEUP
, &tty
->flags
);
139 len
= tty
->ops
->write(tty
, skb
->data
, skb
->len
);
140 hdev
->stat
.byte_tx
+= len
;
148 hci_uart_tx_complete(hu
, bt_cb(skb
)->pkt_type
);
152 if (test_bit(HCI_UART_TX_WAKEUP
, &hu
->tx_state
))
155 clear_bit(HCI_UART_SENDING
, &hu
->tx_state
);
159 static void hci_uart_init_work(struct work_struct
*work
)
161 struct hci_uart
*hu
= container_of(work
, struct hci_uart
, init_ready
);
164 if (!test_and_clear_bit(HCI_UART_INIT_PENDING
, &hu
->hdev_flags
))
167 err
= hci_register_dev(hu
->hdev
);
169 BT_ERR("Can't register HCI device");
170 hci_free_dev(hu
->hdev
);
172 hu
->proto
->close(hu
);
175 set_bit(HCI_UART_REGISTERED
, &hu
->flags
);
178 int hci_uart_init_ready(struct hci_uart
*hu
)
180 if (!test_bit(HCI_UART_INIT_PENDING
, &hu
->hdev_flags
))
183 schedule_work(&hu
->init_ready
);
188 /* ------- Interface to HCI layer ------ */
189 /* Initialize device */
190 static int hci_uart_open(struct hci_dev
*hdev
)
192 BT_DBG("%s %p", hdev
->name
, hdev
);
194 /* Nothing to do for UART driver */
196 set_bit(HCI_RUNNING
, &hdev
->flags
);
202 static int hci_uart_flush(struct hci_dev
*hdev
)
204 struct hci_uart
*hu
= hci_get_drvdata(hdev
);
205 struct tty_struct
*tty
= hu
->tty
;
207 BT_DBG("hdev %p tty %p", hdev
, tty
);
210 kfree_skb(hu
->tx_skb
); hu
->tx_skb
= NULL
;
213 /* Flush any pending characters in the driver and discipline. */
214 tty_ldisc_flush(tty
);
215 tty_driver_flush_buffer(tty
);
217 if (test_bit(HCI_UART_PROTO_SET
, &hu
->flags
))
218 hu
->proto
->flush(hu
);
224 static int hci_uart_close(struct hci_dev
*hdev
)
226 BT_DBG("hdev %p", hdev
);
228 if (!test_and_clear_bit(HCI_RUNNING
, &hdev
->flags
))
231 hci_uart_flush(hdev
);
236 /* Send frames from HCI layer */
237 static int hci_uart_send_frame(struct sk_buff
*skb
)
239 struct hci_dev
* hdev
= (struct hci_dev
*) skb
->dev
;
243 BT_ERR("Frame for unknown device (hdev=NULL)");
247 if (!test_bit(HCI_RUNNING
, &hdev
->flags
))
250 hu
= hci_get_drvdata(hdev
);
252 BT_DBG("%s: type %d len %d", hdev
->name
, bt_cb(skb
)->pkt_type
, skb
->len
);
254 hu
->proto
->enqueue(hu
, skb
);
256 hci_uart_tx_wakeup(hu
);
261 /* ------ LDISC part ------ */
264 * Called when line discipline changed to HCI_UART.
267 * tty pointer to tty info structure
269 * 0 if success, otherwise error code
271 static int hci_uart_tty_open(struct tty_struct
*tty
)
273 struct hci_uart
*hu
= (void *) tty
->disc_data
;
275 BT_DBG("tty %p", tty
);
277 /* FIXME: This btw is bogus, nothing requires the old ldisc to clear
282 /* Error if the tty has no write op instead of leaving an exploitable
284 if (tty
->ops
->write
== NULL
)
287 if (!(hu
= kzalloc(sizeof(struct hci_uart
), GFP_KERNEL
))) {
288 BT_ERR("Can't allocate control structure");
294 tty
->receive_room
= 65536;
296 INIT_WORK(&hu
->init_ready
, hci_uart_init_work
);
298 spin_lock_init(&hu
->rx_lock
);
300 /* Flush any pending characters in the driver and line discipline. */
302 /* FIXME: why is this needed. Note don't use ldisc_ref here as the
303 open path is before the ldisc is referencable */
305 if (tty
->ldisc
->ops
->flush_buffer
)
306 tty
->ldisc
->ops
->flush_buffer(tty
);
307 tty_driver_flush_buffer(tty
);
312 /* hci_uart_tty_close()
314 * Called when the line discipline is changed to something
315 * else, the tty is closed, or the tty detects a hangup.
317 static void hci_uart_tty_close(struct tty_struct
*tty
)
319 struct hci_uart
*hu
= (void *)tty
->disc_data
;
320 struct hci_dev
*hdev
;
322 BT_DBG("tty %p", tty
);
324 /* Detach from the tty */
325 tty
->disc_data
= NULL
;
332 hci_uart_close(hdev
);
334 if (test_and_clear_bit(HCI_UART_PROTO_SET
, &hu
->flags
)) {
336 if (test_bit(HCI_UART_REGISTERED
, &hu
->flags
))
337 hci_unregister_dev(hdev
);
340 hu
->proto
->close(hu
);
346 /* hci_uart_tty_wakeup()
348 * Callback for transmit wakeup. Called when low level
349 * device driver can accept more send data.
351 * Arguments: tty pointer to associated tty instance data
354 static void hci_uart_tty_wakeup(struct tty_struct
*tty
)
356 struct hci_uart
*hu
= (void *)tty
->disc_data
;
363 clear_bit(TTY_DO_WRITE_WAKEUP
, &tty
->flags
);
368 if (test_bit(HCI_UART_PROTO_SET
, &hu
->flags
))
369 hci_uart_tx_wakeup(hu
);
372 /* hci_uart_tty_receive()
374 * Called by tty low level driver when receive data is
377 * Arguments: tty pointer to tty isntance data
378 * data pointer to received data
379 * flags pointer to flags for data
380 * count count of received data in bytes
384 static void hci_uart_tty_receive(struct tty_struct
*tty
, const u8
*data
, char *flags
, int count
)
386 struct hci_uart
*hu
= (void *)tty
->disc_data
;
388 if (!hu
|| tty
!= hu
->tty
)
391 if (!test_bit(HCI_UART_PROTO_SET
, &hu
->flags
))
394 spin_lock(&hu
->rx_lock
);
395 hu
->proto
->recv(hu
, (void *) data
, count
);
396 hu
->hdev
->stat
.byte_rx
+= count
;
397 spin_unlock(&hu
->rx_lock
);
402 static int hci_uart_register_dev(struct hci_uart
*hu
)
404 struct hci_dev
*hdev
;
408 /* Initialize and register HCI device */
409 hdev
= hci_alloc_dev();
411 BT_ERR("Can't allocate HCI device");
417 hdev
->bus
= HCI_UART
;
418 hci_set_drvdata(hdev
, hu
);
420 hdev
->open
= hci_uart_open
;
421 hdev
->close
= hci_uart_close
;
422 hdev
->flush
= hci_uart_flush
;
423 hdev
->send
= hci_uart_send_frame
;
424 SET_HCIDEV_DEV(hdev
, hu
->tty
->dev
);
426 if (test_bit(HCI_UART_RAW_DEVICE
, &hu
->hdev_flags
))
427 set_bit(HCI_QUIRK_RAW_DEVICE
, &hdev
->quirks
);
429 if (!test_bit(HCI_UART_RESET_ON_INIT
, &hu
->hdev_flags
))
430 set_bit(HCI_QUIRK_RESET_ON_CLOSE
, &hdev
->quirks
);
432 if (test_bit(HCI_UART_CREATE_AMP
, &hu
->hdev_flags
))
433 hdev
->dev_type
= HCI_AMP
;
435 hdev
->dev_type
= HCI_BREDR
;
437 if (test_bit(HCI_UART_INIT_PENDING
, &hu
->hdev_flags
))
440 if (hci_register_dev(hdev
) < 0) {
441 BT_ERR("Can't register HCI device");
446 set_bit(HCI_UART_REGISTERED
, &hu
->flags
);
451 static int hci_uart_set_proto(struct hci_uart
*hu
, int id
)
453 struct hci_uart_proto
*p
;
456 p
= hci_uart_get_proto(id
);
458 return -EPROTONOSUPPORT
;
466 err
= hci_uart_register_dev(hu
);
475 /* hci_uart_tty_ioctl()
477 * Process IOCTL system call for the tty device.
481 * tty pointer to tty instance data
482 * file pointer to open file object for device
483 * cmd IOCTL command code
484 * arg argument for IOCTL call (cmd dependent)
486 * Return Value: Command dependent
488 static int hci_uart_tty_ioctl(struct tty_struct
*tty
, struct file
* file
,
489 unsigned int cmd
, unsigned long arg
)
491 struct hci_uart
*hu
= (void *)tty
->disc_data
;
496 /* Verify the status of the device */
501 case HCIUARTSETPROTO
:
502 if (!test_and_set_bit(HCI_UART_PROTO_SET
, &hu
->flags
)) {
503 err
= hci_uart_set_proto(hu
, arg
);
505 clear_bit(HCI_UART_PROTO_SET
, &hu
->flags
);
512 case HCIUARTGETPROTO
:
513 if (test_bit(HCI_UART_PROTO_SET
, &hu
->flags
))
514 return hu
->proto
->id
;
517 case HCIUARTGETDEVICE
:
518 if (test_bit(HCI_UART_PROTO_SET
, &hu
->flags
))
522 case HCIUARTSETFLAGS
:
523 if (test_bit(HCI_UART_PROTO_SET
, &hu
->flags
))
525 hu
->hdev_flags
= arg
;
528 case HCIUARTGETFLAGS
:
529 return hu
->hdev_flags
;
532 err
= n_tty_ioctl_helper(tty
, file
, cmd
, arg
);
540 * We don't provide read/write/poll interface for user space.
542 static ssize_t
hci_uart_tty_read(struct tty_struct
*tty
, struct file
*file
,
543 unsigned char __user
*buf
, size_t nr
)
548 static ssize_t
hci_uart_tty_write(struct tty_struct
*tty
, struct file
*file
,
549 const unsigned char *data
, size_t count
)
554 static unsigned int hci_uart_tty_poll(struct tty_struct
*tty
,
555 struct file
*filp
, poll_table
*wait
)
560 static int __init
hci_uart_init(void)
562 static struct tty_ldisc_ops hci_uart_ldisc
;
565 BT_INFO("HCI UART driver ver %s", VERSION
);
567 /* Register the tty discipline */
569 memset(&hci_uart_ldisc
, 0, sizeof (hci_uart_ldisc
));
570 hci_uart_ldisc
.magic
= TTY_LDISC_MAGIC
;
571 hci_uart_ldisc
.name
= "n_hci";
572 hci_uart_ldisc
.open
= hci_uart_tty_open
;
573 hci_uart_ldisc
.close
= hci_uart_tty_close
;
574 hci_uart_ldisc
.read
= hci_uart_tty_read
;
575 hci_uart_ldisc
.write
= hci_uart_tty_write
;
576 hci_uart_ldisc
.ioctl
= hci_uart_tty_ioctl
;
577 hci_uart_ldisc
.poll
= hci_uart_tty_poll
;
578 hci_uart_ldisc
.receive_buf
= hci_uart_tty_receive
;
579 hci_uart_ldisc
.write_wakeup
= hci_uart_tty_wakeup
;
580 hci_uart_ldisc
.owner
= THIS_MODULE
;
582 if ((err
= tty_register_ldisc(N_HCI
, &hci_uart_ldisc
))) {
583 BT_ERR("HCI line discipline registration failed. (%d)", err
);
587 #ifdef CONFIG_BT_HCIUART_H4
590 #ifdef CONFIG_BT_HCIUART_BCSP
593 #ifdef CONFIG_BT_HCIUART_LL
596 #ifdef CONFIG_BT_HCIUART_ATH3K
599 #ifdef CONFIG_BT_HCIUART_3WIRE
606 static void __exit
hci_uart_exit(void)
610 #ifdef CONFIG_BT_HCIUART_H4
613 #ifdef CONFIG_BT_HCIUART_BCSP
616 #ifdef CONFIG_BT_HCIUART_LL
619 #ifdef CONFIG_BT_HCIUART_ATH3K
622 #ifdef CONFIG_BT_HCIUART_3WIRE
626 /* Release tty registration of line discipline */
627 if ((err
= tty_unregister_ldisc(N_HCI
)))
628 BT_ERR("Can't unregister HCI line discipline (%d)", err
);
631 module_init(hci_uart_init
);
632 module_exit(hci_uart_exit
);
634 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
635 MODULE_DESCRIPTION("Bluetooth HCI UART driver ver " VERSION
);
636 MODULE_VERSION(VERSION
);
637 MODULE_LICENSE("GPL");
638 MODULE_ALIAS_LDISC(N_HCI
);