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 /* ------- Interface to HCI layer ------ */
160 /* Initialize device */
161 static int hci_uart_open(struct hci_dev
*hdev
)
163 BT_DBG("%s %p", hdev
->name
, hdev
);
165 /* Nothing to do for UART driver */
167 set_bit(HCI_RUNNING
, &hdev
->flags
);
173 static int hci_uart_flush(struct hci_dev
*hdev
)
175 struct hci_uart
*hu
= hci_get_drvdata(hdev
);
176 struct tty_struct
*tty
= hu
->tty
;
178 BT_DBG("hdev %p tty %p", hdev
, tty
);
181 kfree_skb(hu
->tx_skb
); hu
->tx_skb
= NULL
;
184 /* Flush any pending characters in the driver and discipline. */
185 tty_ldisc_flush(tty
);
186 tty_driver_flush_buffer(tty
);
188 if (test_bit(HCI_UART_PROTO_SET
, &hu
->flags
))
189 hu
->proto
->flush(hu
);
195 static int hci_uart_close(struct hci_dev
*hdev
)
197 BT_DBG("hdev %p", hdev
);
199 if (!test_and_clear_bit(HCI_RUNNING
, &hdev
->flags
))
202 hci_uart_flush(hdev
);
207 /* Send frames from HCI layer */
208 static int hci_uart_send_frame(struct sk_buff
*skb
)
210 struct hci_dev
* hdev
= (struct hci_dev
*) skb
->dev
;
214 BT_ERR("Frame for unknown device (hdev=NULL)");
218 if (!test_bit(HCI_RUNNING
, &hdev
->flags
))
221 hu
= hci_get_drvdata(hdev
);
223 BT_DBG("%s: type %d len %d", hdev
->name
, bt_cb(skb
)->pkt_type
, skb
->len
);
225 hu
->proto
->enqueue(hu
, skb
);
227 hci_uart_tx_wakeup(hu
);
232 /* ------ LDISC part ------ */
235 * Called when line discipline changed to HCI_UART.
238 * tty pointer to tty info structure
240 * 0 if success, otherwise error code
242 static int hci_uart_tty_open(struct tty_struct
*tty
)
244 struct hci_uart
*hu
= (void *) tty
->disc_data
;
246 BT_DBG("tty %p", tty
);
248 /* FIXME: This btw is bogus, nothing requires the old ldisc to clear
253 /* Error if the tty has no write op instead of leaving an exploitable
255 if (tty
->ops
->write
== NULL
)
258 if (!(hu
= kzalloc(sizeof(struct hci_uart
), GFP_KERNEL
))) {
259 BT_ERR("Can't allocate control structure");
265 tty
->receive_room
= 65536;
267 spin_lock_init(&hu
->rx_lock
);
269 /* Flush any pending characters in the driver and line discipline. */
271 /* FIXME: why is this needed. Note don't use ldisc_ref here as the
272 open path is before the ldisc is referencable */
274 if (tty
->ldisc
->ops
->flush_buffer
)
275 tty
->ldisc
->ops
->flush_buffer(tty
);
276 tty_driver_flush_buffer(tty
);
281 /* hci_uart_tty_close()
283 * Called when the line discipline is changed to something
284 * else, the tty is closed, or the tty detects a hangup.
286 static void hci_uart_tty_close(struct tty_struct
*tty
)
288 struct hci_uart
*hu
= (void *)tty
->disc_data
;
289 struct hci_dev
*hdev
;
291 BT_DBG("tty %p", tty
);
293 /* Detach from the tty */
294 tty
->disc_data
= NULL
;
301 hci_uart_close(hdev
);
303 if (test_and_clear_bit(HCI_UART_PROTO_SET
, &hu
->flags
)) {
305 hci_unregister_dev(hdev
);
308 hu
->proto
->close(hu
);
314 /* hci_uart_tty_wakeup()
316 * Callback for transmit wakeup. Called when low level
317 * device driver can accept more send data.
319 * Arguments: tty pointer to associated tty instance data
322 static void hci_uart_tty_wakeup(struct tty_struct
*tty
)
324 struct hci_uart
*hu
= (void *)tty
->disc_data
;
331 clear_bit(TTY_DO_WRITE_WAKEUP
, &tty
->flags
);
336 if (test_bit(HCI_UART_PROTO_SET
, &hu
->flags
))
337 hci_uart_tx_wakeup(hu
);
340 /* hci_uart_tty_receive()
342 * Called by tty low level driver when receive data is
345 * Arguments: tty pointer to tty isntance data
346 * data pointer to received data
347 * flags pointer to flags for data
348 * count count of received data in bytes
352 static void hci_uart_tty_receive(struct tty_struct
*tty
, const u8
*data
, char *flags
, int count
)
354 struct hci_uart
*hu
= (void *)tty
->disc_data
;
356 if (!hu
|| tty
!= hu
->tty
)
359 if (!test_bit(HCI_UART_PROTO_SET
, &hu
->flags
))
362 spin_lock(&hu
->rx_lock
);
363 hu
->proto
->recv(hu
, (void *) data
, count
);
364 hu
->hdev
->stat
.byte_rx
+= count
;
365 spin_unlock(&hu
->rx_lock
);
370 static int hci_uart_register_dev(struct hci_uart
*hu
)
372 struct hci_dev
*hdev
;
376 /* Initialize and register HCI device */
377 hdev
= hci_alloc_dev();
379 BT_ERR("Can't allocate HCI device");
385 hdev
->bus
= HCI_UART
;
386 hci_set_drvdata(hdev
, hu
);
388 hdev
->open
= hci_uart_open
;
389 hdev
->close
= hci_uart_close
;
390 hdev
->flush
= hci_uart_flush
;
391 hdev
->send
= hci_uart_send_frame
;
392 SET_HCIDEV_DEV(hdev
, hu
->tty
->dev
);
394 if (test_bit(HCI_UART_RAW_DEVICE
, &hu
->hdev_flags
))
395 set_bit(HCI_QUIRK_RAW_DEVICE
, &hdev
->quirks
);
397 if (!test_bit(HCI_UART_RESET_ON_INIT
, &hu
->hdev_flags
))
398 set_bit(HCI_QUIRK_RESET_ON_CLOSE
, &hdev
->quirks
);
400 if (test_bit(HCI_UART_CREATE_AMP
, &hu
->hdev_flags
))
401 hdev
->dev_type
= HCI_AMP
;
403 hdev
->dev_type
= HCI_BREDR
;
405 if (hci_register_dev(hdev
) < 0) {
406 BT_ERR("Can't register HCI device");
414 static int hci_uart_set_proto(struct hci_uart
*hu
, int id
)
416 struct hci_uart_proto
*p
;
419 p
= hci_uart_get_proto(id
);
421 return -EPROTONOSUPPORT
;
429 err
= hci_uart_register_dev(hu
);
438 /* hci_uart_tty_ioctl()
440 * Process IOCTL system call for the tty device.
444 * tty pointer to tty instance data
445 * file pointer to open file object for device
446 * cmd IOCTL command code
447 * arg argument for IOCTL call (cmd dependent)
449 * Return Value: Command dependent
451 static int hci_uart_tty_ioctl(struct tty_struct
*tty
, struct file
* file
,
452 unsigned int cmd
, unsigned long arg
)
454 struct hci_uart
*hu
= (void *)tty
->disc_data
;
459 /* Verify the status of the device */
464 case HCIUARTSETPROTO
:
465 if (!test_and_set_bit(HCI_UART_PROTO_SET
, &hu
->flags
)) {
466 err
= hci_uart_set_proto(hu
, arg
);
468 clear_bit(HCI_UART_PROTO_SET
, &hu
->flags
);
475 case HCIUARTGETPROTO
:
476 if (test_bit(HCI_UART_PROTO_SET
, &hu
->flags
))
477 return hu
->proto
->id
;
480 case HCIUARTGETDEVICE
:
481 if (test_bit(HCI_UART_PROTO_SET
, &hu
->flags
))
485 case HCIUARTSETFLAGS
:
486 if (test_bit(HCI_UART_PROTO_SET
, &hu
->flags
))
488 hu
->hdev_flags
= arg
;
491 case HCIUARTGETFLAGS
:
492 return hu
->hdev_flags
;
495 err
= n_tty_ioctl_helper(tty
, file
, cmd
, arg
);
503 * We don't provide read/write/poll interface for user space.
505 static ssize_t
hci_uart_tty_read(struct tty_struct
*tty
, struct file
*file
,
506 unsigned char __user
*buf
, size_t nr
)
511 static ssize_t
hci_uart_tty_write(struct tty_struct
*tty
, struct file
*file
,
512 const unsigned char *data
, size_t count
)
517 static unsigned int hci_uart_tty_poll(struct tty_struct
*tty
,
518 struct file
*filp
, poll_table
*wait
)
523 static int __init
hci_uart_init(void)
525 static struct tty_ldisc_ops hci_uart_ldisc
;
528 BT_INFO("HCI UART driver ver %s", VERSION
);
530 /* Register the tty discipline */
532 memset(&hci_uart_ldisc
, 0, sizeof (hci_uart_ldisc
));
533 hci_uart_ldisc
.magic
= TTY_LDISC_MAGIC
;
534 hci_uart_ldisc
.name
= "n_hci";
535 hci_uart_ldisc
.open
= hci_uart_tty_open
;
536 hci_uart_ldisc
.close
= hci_uart_tty_close
;
537 hci_uart_ldisc
.read
= hci_uart_tty_read
;
538 hci_uart_ldisc
.write
= hci_uart_tty_write
;
539 hci_uart_ldisc
.ioctl
= hci_uart_tty_ioctl
;
540 hci_uart_ldisc
.poll
= hci_uart_tty_poll
;
541 hci_uart_ldisc
.receive_buf
= hci_uart_tty_receive
;
542 hci_uart_ldisc
.write_wakeup
= hci_uart_tty_wakeup
;
543 hci_uart_ldisc
.owner
= THIS_MODULE
;
545 if ((err
= tty_register_ldisc(N_HCI
, &hci_uart_ldisc
))) {
546 BT_ERR("HCI line discipline registration failed. (%d)", err
);
550 #ifdef CONFIG_BT_HCIUART_H4
553 #ifdef CONFIG_BT_HCIUART_BCSP
556 #ifdef CONFIG_BT_HCIUART_LL
559 #ifdef CONFIG_BT_HCIUART_ATH3K
562 #ifdef CONFIG_BT_HCIUART_3WIRE
569 static void __exit
hci_uart_exit(void)
573 #ifdef CONFIG_BT_HCIUART_H4
576 #ifdef CONFIG_BT_HCIUART_BCSP
579 #ifdef CONFIG_BT_HCIUART_LL
582 #ifdef CONFIG_BT_HCIUART_ATH3K
585 #ifdef CONFIG_BT_HCIUART_3WIRE
589 /* Release tty registration of line discipline */
590 if ((err
= tty_unregister_ldisc(N_HCI
)))
591 BT_ERR("Can't unregister HCI line discipline (%d)", err
);
594 module_init(hci_uart_init
);
595 module_exit(hci_uart_exit
);
597 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
598 MODULE_DESCRIPTION("Bluetooth HCI UART driver ver " VERSION
);
599 MODULE_VERSION(VERSION
);
600 MODULE_LICENSE("GPL");
601 MODULE_ALIAS_LDISC(N_HCI
);