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 if (test_and_set_bit(HCI_UART_SENDING
, &hu
->tx_state
)) {
122 set_bit(HCI_UART_TX_WAKEUP
, &hu
->tx_state
);
128 schedule_work(&hu
->write_work
);
133 static void hci_uart_write_work(struct work_struct
*work
)
135 struct hci_uart
*hu
= container_of(work
, struct hci_uart
, write_work
);
136 struct tty_struct
*tty
= hu
->tty
;
137 struct hci_dev
*hdev
= hu
->hdev
;
140 /* REVISIT: should we cope with bad skbs or ->write() returning
145 clear_bit(HCI_UART_TX_WAKEUP
, &hu
->tx_state
);
147 while ((skb
= hci_uart_dequeue(hu
))) {
150 set_bit(TTY_DO_WRITE_WAKEUP
, &tty
->flags
);
151 len
= tty
->ops
->write(tty
, skb
->data
, skb
->len
);
152 hdev
->stat
.byte_tx
+= len
;
160 hci_uart_tx_complete(hu
, bt_cb(skb
)->pkt_type
);
164 if (test_bit(HCI_UART_TX_WAKEUP
, &hu
->tx_state
))
167 clear_bit(HCI_UART_SENDING
, &hu
->tx_state
);
170 static void hci_uart_init_work(struct work_struct
*work
)
172 struct hci_uart
*hu
= container_of(work
, struct hci_uart
, init_ready
);
175 if (!test_and_clear_bit(HCI_UART_INIT_PENDING
, &hu
->hdev_flags
))
178 err
= hci_register_dev(hu
->hdev
);
180 BT_ERR("Can't register HCI device");
181 hci_free_dev(hu
->hdev
);
183 hu
->proto
->close(hu
);
186 set_bit(HCI_UART_REGISTERED
, &hu
->flags
);
189 int hci_uart_init_ready(struct hci_uart
*hu
)
191 if (!test_bit(HCI_UART_INIT_PENDING
, &hu
->hdev_flags
))
194 schedule_work(&hu
->init_ready
);
199 /* ------- Interface to HCI layer ------ */
200 /* Initialize device */
201 static int hci_uart_open(struct hci_dev
*hdev
)
203 BT_DBG("%s %p", hdev
->name
, hdev
);
205 /* Nothing to do for UART driver */
207 set_bit(HCI_RUNNING
, &hdev
->flags
);
213 static int hci_uart_flush(struct hci_dev
*hdev
)
215 struct hci_uart
*hu
= hci_get_drvdata(hdev
);
216 struct tty_struct
*tty
= hu
->tty
;
218 BT_DBG("hdev %p tty %p", hdev
, tty
);
221 kfree_skb(hu
->tx_skb
); hu
->tx_skb
= NULL
;
224 /* Flush any pending characters in the driver and discipline. */
225 tty_ldisc_flush(tty
);
226 tty_driver_flush_buffer(tty
);
228 if (test_bit(HCI_UART_PROTO_SET
, &hu
->flags
))
229 hu
->proto
->flush(hu
);
235 static int hci_uart_close(struct hci_dev
*hdev
)
237 BT_DBG("hdev %p", hdev
);
239 if (!test_and_clear_bit(HCI_RUNNING
, &hdev
->flags
))
242 hci_uart_flush(hdev
);
247 /* Send frames from HCI layer */
248 static int hci_uart_send_frame(struct hci_dev
*hdev
, struct sk_buff
*skb
)
250 struct hci_uart
*hu
= hci_get_drvdata(hdev
);
252 if (!test_bit(HCI_RUNNING
, &hdev
->flags
))
255 BT_DBG("%s: type %d len %d", hdev
->name
, bt_cb(skb
)->pkt_type
, skb
->len
);
257 hu
->proto
->enqueue(hu
, skb
);
259 hci_uart_tx_wakeup(hu
);
264 static int hci_uart_setup(struct hci_dev
*hdev
)
266 struct hci_uart
*hu
= hci_get_drvdata(hdev
);
268 if (hu
->proto
->setup
)
269 return hu
->proto
->setup(hu
);
274 /* ------ LDISC part ------ */
277 * Called when line discipline changed to HCI_UART.
280 * tty pointer to tty info structure
282 * 0 if success, otherwise error code
284 static int hci_uart_tty_open(struct tty_struct
*tty
)
288 BT_DBG("tty %p", tty
);
290 /* Error if the tty has no write op instead of leaving an exploitable
292 if (tty
->ops
->write
== NULL
)
295 hu
= kzalloc(sizeof(struct hci_uart
), GFP_KERNEL
);
297 BT_ERR("Can't allocate control structure");
303 tty
->receive_room
= 65536;
305 INIT_WORK(&hu
->init_ready
, hci_uart_init_work
);
306 INIT_WORK(&hu
->write_work
, hci_uart_write_work
);
308 spin_lock_init(&hu
->rx_lock
);
310 /* Flush any pending characters in the driver and line discipline. */
312 /* FIXME: why is this needed. Note don't use ldisc_ref here as the
313 open path is before the ldisc is referencable */
315 if (tty
->ldisc
->ops
->flush_buffer
)
316 tty
->ldisc
->ops
->flush_buffer(tty
);
317 tty_driver_flush_buffer(tty
);
322 /* hci_uart_tty_close()
324 * Called when the line discipline is changed to something
325 * else, the tty is closed, or the tty detects a hangup.
327 static void hci_uart_tty_close(struct tty_struct
*tty
)
329 struct hci_uart
*hu
= (void *)tty
->disc_data
;
330 struct hci_dev
*hdev
;
332 BT_DBG("tty %p", tty
);
334 /* Detach from the tty */
335 tty
->disc_data
= NULL
;
342 hci_uart_close(hdev
);
344 cancel_work_sync(&hu
->write_work
);
346 if (test_and_clear_bit(HCI_UART_PROTO_SET
, &hu
->flags
)) {
348 if (test_bit(HCI_UART_REGISTERED
, &hu
->flags
))
349 hci_unregister_dev(hdev
);
352 hu
->proto
->close(hu
);
358 /* hci_uart_tty_wakeup()
360 * Callback for transmit wakeup. Called when low level
361 * device driver can accept more send data.
363 * Arguments: tty pointer to associated tty instance data
366 static void hci_uart_tty_wakeup(struct tty_struct
*tty
)
368 struct hci_uart
*hu
= (void *)tty
->disc_data
;
375 clear_bit(TTY_DO_WRITE_WAKEUP
, &tty
->flags
);
380 if (test_bit(HCI_UART_PROTO_SET
, &hu
->flags
))
381 hci_uart_tx_wakeup(hu
);
384 /* hci_uart_tty_receive()
386 * Called by tty low level driver when receive data is
389 * Arguments: tty pointer to tty isntance data
390 * data pointer to received data
391 * flags pointer to flags for data
392 * count count of received data in bytes
396 static void hci_uart_tty_receive(struct tty_struct
*tty
, const u8
*data
, char *flags
, int count
)
398 struct hci_uart
*hu
= (void *)tty
->disc_data
;
400 if (!hu
|| tty
!= hu
->tty
)
403 if (!test_bit(HCI_UART_PROTO_SET
, &hu
->flags
))
406 spin_lock(&hu
->rx_lock
);
407 hu
->proto
->recv(hu
, (void *) data
, count
);
410 hu
->hdev
->stat
.byte_rx
+= count
;
412 spin_unlock(&hu
->rx_lock
);
417 static int hci_uart_register_dev(struct hci_uart
*hu
)
419 struct hci_dev
*hdev
;
423 /* Initialize and register HCI device */
424 hdev
= hci_alloc_dev();
426 BT_ERR("Can't allocate HCI device");
432 hdev
->bus
= HCI_UART
;
433 hci_set_drvdata(hdev
, hu
);
435 hdev
->open
= hci_uart_open
;
436 hdev
->close
= hci_uart_close
;
437 hdev
->flush
= hci_uart_flush
;
438 hdev
->send
= hci_uart_send_frame
;
439 hdev
->setup
= hci_uart_setup
;
440 SET_HCIDEV_DEV(hdev
, hu
->tty
->dev
);
442 if (test_bit(HCI_UART_RAW_DEVICE
, &hu
->hdev_flags
))
443 set_bit(HCI_QUIRK_RAW_DEVICE
, &hdev
->quirks
);
445 if (test_bit(HCI_UART_EXT_CONFIG
, &hu
->hdev_flags
))
446 set_bit(HCI_QUIRK_EXTERNAL_CONFIG
, &hdev
->quirks
);
448 if (!test_bit(HCI_UART_RESET_ON_INIT
, &hu
->hdev_flags
))
449 set_bit(HCI_QUIRK_RESET_ON_CLOSE
, &hdev
->quirks
);
451 if (test_bit(HCI_UART_CREATE_AMP
, &hu
->hdev_flags
))
452 hdev
->dev_type
= HCI_AMP
;
454 hdev
->dev_type
= HCI_BREDR
;
456 if (test_bit(HCI_UART_INIT_PENDING
, &hu
->hdev_flags
))
459 if (hci_register_dev(hdev
) < 0) {
460 BT_ERR("Can't register HCI device");
465 set_bit(HCI_UART_REGISTERED
, &hu
->flags
);
470 static int hci_uart_set_proto(struct hci_uart
*hu
, int id
)
472 struct hci_uart_proto
*p
;
475 p
= hci_uart_get_proto(id
);
477 return -EPROTONOSUPPORT
;
485 err
= hci_uart_register_dev(hu
);
494 static int hci_uart_set_flags(struct hci_uart
*hu
, unsigned long flags
)
496 unsigned long valid_flags
= BIT(HCI_UART_RAW_DEVICE
) |
497 BIT(HCI_UART_RESET_ON_INIT
) |
498 BIT(HCI_UART_CREATE_AMP
) |
499 BIT(HCI_UART_INIT_PENDING
) |
500 BIT(HCI_UART_EXT_CONFIG
);
502 if ((flags
& ~valid_flags
))
505 hu
->hdev_flags
= flags
;
510 /* hci_uart_tty_ioctl()
512 * Process IOCTL system call for the tty device.
516 * tty pointer to tty instance data
517 * file pointer to open file object for device
518 * cmd IOCTL command code
519 * arg argument for IOCTL call (cmd dependent)
521 * Return Value: Command dependent
523 static int hci_uart_tty_ioctl(struct tty_struct
*tty
, struct file
* file
,
524 unsigned int cmd
, unsigned long arg
)
526 struct hci_uart
*hu
= (void *)tty
->disc_data
;
531 /* Verify the status of the device */
536 case HCIUARTSETPROTO
:
537 if (!test_and_set_bit(HCI_UART_PROTO_SET
, &hu
->flags
)) {
538 err
= hci_uart_set_proto(hu
, arg
);
540 clear_bit(HCI_UART_PROTO_SET
, &hu
->flags
);
547 case HCIUARTGETPROTO
:
548 if (test_bit(HCI_UART_PROTO_SET
, &hu
->flags
))
549 return hu
->proto
->id
;
552 case HCIUARTGETDEVICE
:
553 if (test_bit(HCI_UART_REGISTERED
, &hu
->flags
))
557 case HCIUARTSETFLAGS
:
558 if (test_bit(HCI_UART_PROTO_SET
, &hu
->flags
))
560 err
= hci_uart_set_flags(hu
, arg
);
565 case HCIUARTGETFLAGS
:
566 return hu
->hdev_flags
;
569 err
= n_tty_ioctl_helper(tty
, file
, cmd
, arg
);
577 * We don't provide read/write/poll interface for user space.
579 static ssize_t
hci_uart_tty_read(struct tty_struct
*tty
, struct file
*file
,
580 unsigned char __user
*buf
, size_t nr
)
585 static ssize_t
hci_uart_tty_write(struct tty_struct
*tty
, struct file
*file
,
586 const unsigned char *data
, size_t count
)
591 static unsigned int hci_uart_tty_poll(struct tty_struct
*tty
,
592 struct file
*filp
, poll_table
*wait
)
597 static int __init
hci_uart_init(void)
599 static struct tty_ldisc_ops hci_uart_ldisc
;
602 BT_INFO("HCI UART driver ver %s", VERSION
);
604 /* Register the tty discipline */
606 memset(&hci_uart_ldisc
, 0, sizeof (hci_uart_ldisc
));
607 hci_uart_ldisc
.magic
= TTY_LDISC_MAGIC
;
608 hci_uart_ldisc
.name
= "n_hci";
609 hci_uart_ldisc
.open
= hci_uart_tty_open
;
610 hci_uart_ldisc
.close
= hci_uart_tty_close
;
611 hci_uart_ldisc
.read
= hci_uart_tty_read
;
612 hci_uart_ldisc
.write
= hci_uart_tty_write
;
613 hci_uart_ldisc
.ioctl
= hci_uart_tty_ioctl
;
614 hci_uart_ldisc
.poll
= hci_uart_tty_poll
;
615 hci_uart_ldisc
.receive_buf
= hci_uart_tty_receive
;
616 hci_uart_ldisc
.write_wakeup
= hci_uart_tty_wakeup
;
617 hci_uart_ldisc
.owner
= THIS_MODULE
;
619 err
= tty_register_ldisc(N_HCI
, &hci_uart_ldisc
);
621 BT_ERR("HCI line discipline registration failed. (%d)", err
);
625 #ifdef CONFIG_BT_HCIUART_H4
628 #ifdef CONFIG_BT_HCIUART_BCSP
631 #ifdef CONFIG_BT_HCIUART_LL
634 #ifdef CONFIG_BT_HCIUART_ATH3K
637 #ifdef CONFIG_BT_HCIUART_3WIRE
644 static void __exit
hci_uart_exit(void)
648 #ifdef CONFIG_BT_HCIUART_H4
651 #ifdef CONFIG_BT_HCIUART_BCSP
654 #ifdef CONFIG_BT_HCIUART_LL
657 #ifdef CONFIG_BT_HCIUART_ATH3K
660 #ifdef CONFIG_BT_HCIUART_3WIRE
664 /* Release tty registration of line discipline */
665 err
= tty_unregister_ldisc(N_HCI
);
667 BT_ERR("Can't unregister HCI line discipline (%d)", err
);
670 module_init(hci_uart_init
);
671 module_exit(hci_uart_exit
);
673 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
674 MODULE_DESCRIPTION("Bluetooth HCI UART driver ver " VERSION
);
675 MODULE_VERSION(VERSION
);
676 MODULE_LICENSE("GPL");
677 MODULE_ALIAS_LDISC(N_HCI
);