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>
43 #include <linux/firmware.h>
45 #include <net/bluetooth/bluetooth.h>
46 #include <net/bluetooth/hci_core.h>
54 static const struct hci_uart_proto
*hup
[HCI_UART_MAX_PROTO
];
56 int hci_uart_register_proto(const struct hci_uart_proto
*p
)
58 if (p
->id
>= HCI_UART_MAX_PROTO
)
66 BT_INFO("HCI UART protocol %s registered", p
->name
);
71 int hci_uart_unregister_proto(const struct hci_uart_proto
*p
)
73 if (p
->id
>= HCI_UART_MAX_PROTO
)
84 static const struct hci_uart_proto
*hci_uart_get_proto(unsigned int id
)
86 if (id
>= HCI_UART_MAX_PROTO
)
92 static inline void hci_uart_tx_complete(struct hci_uart
*hu
, int pkt_type
)
94 struct hci_dev
*hdev
= hu
->hdev
;
96 /* Update HCI stat counters */
102 case HCI_ACLDATA_PKT
:
106 case HCI_SCODATA_PKT
:
112 static inline struct sk_buff
*hci_uart_dequeue(struct hci_uart
*hu
)
114 struct sk_buff
*skb
= hu
->tx_skb
;
117 skb
= hu
->proto
->dequeue(hu
);
124 int hci_uart_tx_wakeup(struct hci_uart
*hu
)
126 if (test_and_set_bit(HCI_UART_SENDING
, &hu
->tx_state
)) {
127 set_bit(HCI_UART_TX_WAKEUP
, &hu
->tx_state
);
133 schedule_work(&hu
->write_work
);
138 static void hci_uart_write_work(struct work_struct
*work
)
140 struct hci_uart
*hu
= container_of(work
, struct hci_uart
, write_work
);
141 struct tty_struct
*tty
= hu
->tty
;
142 struct hci_dev
*hdev
= hu
->hdev
;
145 /* REVISIT: should we cope with bad skbs or ->write() returning
150 clear_bit(HCI_UART_TX_WAKEUP
, &hu
->tx_state
);
152 while ((skb
= hci_uart_dequeue(hu
))) {
155 set_bit(TTY_DO_WRITE_WAKEUP
, &tty
->flags
);
156 len
= tty
->ops
->write(tty
, skb
->data
, skb
->len
);
157 hdev
->stat
.byte_tx
+= len
;
165 hci_uart_tx_complete(hu
, bt_cb(skb
)->pkt_type
);
169 if (test_bit(HCI_UART_TX_WAKEUP
, &hu
->tx_state
))
172 clear_bit(HCI_UART_SENDING
, &hu
->tx_state
);
175 static void hci_uart_init_work(struct work_struct
*work
)
177 struct hci_uart
*hu
= container_of(work
, struct hci_uart
, init_ready
);
180 if (!test_and_clear_bit(HCI_UART_INIT_PENDING
, &hu
->hdev_flags
))
183 err
= hci_register_dev(hu
->hdev
);
185 BT_ERR("Can't register HCI device");
186 hci_free_dev(hu
->hdev
);
188 hu
->proto
->close(hu
);
191 set_bit(HCI_UART_REGISTERED
, &hu
->flags
);
194 int hci_uart_init_ready(struct hci_uart
*hu
)
196 if (!test_bit(HCI_UART_INIT_PENDING
, &hu
->hdev_flags
))
199 schedule_work(&hu
->init_ready
);
204 /* ------- Interface to HCI layer ------ */
205 /* Initialize device */
206 static int hci_uart_open(struct hci_dev
*hdev
)
208 BT_DBG("%s %p", hdev
->name
, hdev
);
210 /* Nothing to do for UART driver */
215 static int hci_uart_flush(struct hci_dev
*hdev
)
217 struct hci_uart
*hu
= hci_get_drvdata(hdev
);
218 struct tty_struct
*tty
= hu
->tty
;
220 BT_DBG("hdev %p tty %p", hdev
, tty
);
223 kfree_skb(hu
->tx_skb
); hu
->tx_skb
= NULL
;
226 /* Flush any pending characters in the driver and discipline. */
227 tty_ldisc_flush(tty
);
228 tty_driver_flush_buffer(tty
);
230 if (test_bit(HCI_UART_PROTO_SET
, &hu
->flags
))
231 hu
->proto
->flush(hu
);
237 static int hci_uart_close(struct hci_dev
*hdev
)
239 BT_DBG("hdev %p", hdev
);
241 hci_uart_flush(hdev
);
246 /* Send frames from HCI layer */
247 static int hci_uart_send_frame(struct hci_dev
*hdev
, struct sk_buff
*skb
)
249 struct hci_uart
*hu
= hci_get_drvdata(hdev
);
251 BT_DBG("%s: type %d len %d", hdev
->name
, bt_cb(skb
)->pkt_type
, skb
->len
);
253 hu
->proto
->enqueue(hu
, skb
);
255 hci_uart_tx_wakeup(hu
);
260 /* Flow control or un-flow control the device */
261 void hci_uart_set_flow_control(struct hci_uart
*hu
, bool enable
)
263 struct tty_struct
*tty
= hu
->tty
;
264 struct ktermios ktermios
;
266 unsigned int set
= 0;
267 unsigned int clear
= 0;
270 /* Disable hardware flow control */
271 ktermios
= tty
->termios
;
272 ktermios
.c_cflag
&= ~CRTSCTS
;
273 status
= tty_set_termios(tty
, &ktermios
);
274 BT_DBG("Disabling hardware flow control: %s",
275 status
? "failed" : "success");
277 /* Clear RTS to prevent the device from sending */
278 /* Most UARTs need OUT2 to enable interrupts */
279 status
= tty
->driver
->ops
->tiocmget(tty
);
280 BT_DBG("Current tiocm 0x%x", status
);
282 set
&= ~(TIOCM_OUT2
| TIOCM_RTS
);
284 set
&= TIOCM_DTR
| TIOCM_RTS
| TIOCM_OUT1
|
285 TIOCM_OUT2
| TIOCM_LOOP
;
286 clear
&= TIOCM_DTR
| TIOCM_RTS
| TIOCM_OUT1
|
287 TIOCM_OUT2
| TIOCM_LOOP
;
288 status
= tty
->driver
->ops
->tiocmset(tty
, set
, clear
);
289 BT_DBG("Clearing RTS: %s", status
? "failed" : "success");
291 /* Set RTS to allow the device to send again */
292 status
= tty
->driver
->ops
->tiocmget(tty
);
293 BT_DBG("Current tiocm 0x%x", status
);
295 set
|= (TIOCM_OUT2
| TIOCM_RTS
);
297 set
&= TIOCM_DTR
| TIOCM_RTS
| TIOCM_OUT1
|
298 TIOCM_OUT2
| TIOCM_LOOP
;
299 clear
&= TIOCM_DTR
| TIOCM_RTS
| TIOCM_OUT1
|
300 TIOCM_OUT2
| TIOCM_LOOP
;
301 status
= tty
->driver
->ops
->tiocmset(tty
, set
, clear
);
302 BT_DBG("Setting RTS: %s", status
? "failed" : "success");
304 /* Re-enable hardware flow control */
305 ktermios
= tty
->termios
;
306 ktermios
.c_cflag
|= CRTSCTS
;
307 status
= tty_set_termios(tty
, &ktermios
);
308 BT_DBG("Enabling hardware flow control: %s",
309 status
? "failed" : "success");
313 void hci_uart_set_speeds(struct hci_uart
*hu
, unsigned int init_speed
,
314 unsigned int oper_speed
)
316 hu
->init_speed
= init_speed
;
317 hu
->oper_speed
= oper_speed
;
320 void hci_uart_init_tty(struct hci_uart
*hu
)
322 struct tty_struct
*tty
= hu
->tty
;
323 struct ktermios ktermios
;
325 /* Bring the UART into a known 8 bits no parity hw fc state */
326 ktermios
= tty
->termios
;
327 ktermios
.c_iflag
&= ~(IGNBRK
| BRKINT
| PARMRK
| ISTRIP
|
328 INLCR
| IGNCR
| ICRNL
| IXON
);
329 ktermios
.c_oflag
&= ~OPOST
;
330 ktermios
.c_lflag
&= ~(ECHO
| ECHONL
| ICANON
| ISIG
| IEXTEN
);
331 ktermios
.c_cflag
&= ~(CSIZE
| PARENB
);
332 ktermios
.c_cflag
|= CS8
;
333 ktermios
.c_cflag
|= CRTSCTS
;
335 /* tty_set_termios() return not checked as it is always 0 */
336 tty_set_termios(tty
, &ktermios
);
339 void hci_uart_set_baudrate(struct hci_uart
*hu
, unsigned int speed
)
341 struct tty_struct
*tty
= hu
->tty
;
342 struct ktermios ktermios
;
344 ktermios
= tty
->termios
;
345 ktermios
.c_cflag
&= ~CBAUD
;
346 tty_termios_encode_baud_rate(&ktermios
, speed
, speed
);
348 /* tty_set_termios() return not checked as it is always 0 */
349 tty_set_termios(tty
, &ktermios
);
351 BT_DBG("%s: New tty speeds: %d/%d", hu
->hdev
->name
,
352 tty
->termios
.c_ispeed
, tty
->termios
.c_ospeed
);
355 static int hci_uart_setup(struct hci_dev
*hdev
)
357 struct hci_uart
*hu
= hci_get_drvdata(hdev
);
358 struct hci_rp_read_local_version
*ver
;
363 /* Init speed if any */
365 speed
= hu
->init_speed
;
366 else if (hu
->proto
->init_speed
)
367 speed
= hu
->proto
->init_speed
;
372 hci_uart_set_baudrate(hu
, speed
);
374 /* Operational speed if any */
376 speed
= hu
->oper_speed
;
377 else if (hu
->proto
->oper_speed
)
378 speed
= hu
->proto
->oper_speed
;
382 if (hu
->proto
->set_baudrate
&& speed
) {
383 err
= hu
->proto
->set_baudrate(hu
, speed
);
385 hci_uart_set_baudrate(hu
, speed
);
388 if (hu
->proto
->setup
)
389 return hu
->proto
->setup(hu
);
391 if (!test_bit(HCI_UART_VND_DETECT
, &hu
->hdev_flags
))
394 skb
= __hci_cmd_sync(hdev
, HCI_OP_READ_LOCAL_VERSION
, 0, NULL
,
397 BT_ERR("%s: Reading local version information failed (%ld)",
398 hdev
->name
, PTR_ERR(skb
));
402 if (skb
->len
!= sizeof(*ver
)) {
403 BT_ERR("%s: Event length mismatch for version information",
408 ver
= (struct hci_rp_read_local_version
*)skb
->data
;
410 switch (le16_to_cpu(ver
->manufacturer
)) {
411 #ifdef CONFIG_BT_HCIUART_INTEL
413 hdev
->set_bdaddr
= btintel_set_bdaddr
;
414 btintel_check_bdaddr(hdev
);
417 #ifdef CONFIG_BT_HCIUART_BCM
419 hdev
->set_bdaddr
= btbcm_set_bdaddr
;
420 btbcm_check_bdaddr(hdev
);
430 /* ------ LDISC part ------ */
433 * Called when line discipline changed to HCI_UART.
436 * tty pointer to tty info structure
438 * 0 if success, otherwise error code
440 static int hci_uart_tty_open(struct tty_struct
*tty
)
444 BT_DBG("tty %p", tty
);
446 /* Error if the tty has no write op instead of leaving an exploitable
448 if (tty
->ops
->write
== NULL
)
451 hu
= kzalloc(sizeof(struct hci_uart
), GFP_KERNEL
);
453 BT_ERR("Can't allocate control structure");
459 tty
->receive_room
= 65536;
461 INIT_WORK(&hu
->init_ready
, hci_uart_init_work
);
462 INIT_WORK(&hu
->write_work
, hci_uart_write_work
);
464 /* Flush any pending characters in the driver and line discipline. */
466 /* FIXME: why is this needed. Note don't use ldisc_ref here as the
467 open path is before the ldisc is referencable */
469 if (tty
->ldisc
->ops
->flush_buffer
)
470 tty
->ldisc
->ops
->flush_buffer(tty
);
471 tty_driver_flush_buffer(tty
);
476 /* hci_uart_tty_close()
478 * Called when the line discipline is changed to something
479 * else, the tty is closed, or the tty detects a hangup.
481 static void hci_uart_tty_close(struct tty_struct
*tty
)
483 struct hci_uart
*hu
= tty
->disc_data
;
484 struct hci_dev
*hdev
;
486 BT_DBG("tty %p", tty
);
488 /* Detach from the tty */
489 tty
->disc_data
= NULL
;
496 hci_uart_close(hdev
);
498 cancel_work_sync(&hu
->write_work
);
500 if (test_and_clear_bit(HCI_UART_PROTO_SET
, &hu
->flags
)) {
502 if (test_bit(HCI_UART_REGISTERED
, &hu
->flags
))
503 hci_unregister_dev(hdev
);
506 hu
->proto
->close(hu
);
512 /* hci_uart_tty_wakeup()
514 * Callback for transmit wakeup. Called when low level
515 * device driver can accept more send data.
517 * Arguments: tty pointer to associated tty instance data
520 static void hci_uart_tty_wakeup(struct tty_struct
*tty
)
522 struct hci_uart
*hu
= tty
->disc_data
;
529 clear_bit(TTY_DO_WRITE_WAKEUP
, &tty
->flags
);
534 if (test_bit(HCI_UART_PROTO_SET
, &hu
->flags
))
535 hci_uart_tx_wakeup(hu
);
538 /* hci_uart_tty_receive()
540 * Called by tty low level driver when receive data is
543 * Arguments: tty pointer to tty isntance data
544 * data pointer to received data
545 * flags pointer to flags for data
546 * count count of received data in bytes
550 static void hci_uart_tty_receive(struct tty_struct
*tty
, const u8
*data
,
551 char *flags
, int count
)
553 struct hci_uart
*hu
= tty
->disc_data
;
555 if (!hu
|| tty
!= hu
->tty
)
558 if (!test_bit(HCI_UART_PROTO_SET
, &hu
->flags
))
561 /* It does not need a lock here as it is already protected by a mutex in
564 hu
->proto
->recv(hu
, data
, count
);
567 hu
->hdev
->stat
.byte_rx
+= count
;
572 static int hci_uart_register_dev(struct hci_uart
*hu
)
574 struct hci_dev
*hdev
;
578 /* Initialize and register HCI device */
579 hdev
= hci_alloc_dev();
581 BT_ERR("Can't allocate HCI device");
587 hdev
->bus
= HCI_UART
;
588 hci_set_drvdata(hdev
, hu
);
590 /* Only when vendor specific setup callback is provided, consider
591 * the manufacturer information valid. This avoids filling in the
592 * value for Ericsson when nothing is specified.
594 if (hu
->proto
->setup
)
595 hdev
->manufacturer
= hu
->proto
->manufacturer
;
597 hdev
->open
= hci_uart_open
;
598 hdev
->close
= hci_uart_close
;
599 hdev
->flush
= hci_uart_flush
;
600 hdev
->send
= hci_uart_send_frame
;
601 hdev
->setup
= hci_uart_setup
;
602 SET_HCIDEV_DEV(hdev
, hu
->tty
->dev
);
604 if (test_bit(HCI_UART_RAW_DEVICE
, &hu
->hdev_flags
))
605 set_bit(HCI_QUIRK_RAW_DEVICE
, &hdev
->quirks
);
607 if (test_bit(HCI_UART_EXT_CONFIG
, &hu
->hdev_flags
))
608 set_bit(HCI_QUIRK_EXTERNAL_CONFIG
, &hdev
->quirks
);
610 if (!test_bit(HCI_UART_RESET_ON_INIT
, &hu
->hdev_flags
))
611 set_bit(HCI_QUIRK_RESET_ON_CLOSE
, &hdev
->quirks
);
613 if (test_bit(HCI_UART_CREATE_AMP
, &hu
->hdev_flags
))
614 hdev
->dev_type
= HCI_AMP
;
616 hdev
->dev_type
= HCI_BREDR
;
618 if (test_bit(HCI_UART_INIT_PENDING
, &hu
->hdev_flags
))
621 if (hci_register_dev(hdev
) < 0) {
622 BT_ERR("Can't register HCI device");
627 set_bit(HCI_UART_REGISTERED
, &hu
->flags
);
632 static int hci_uart_set_proto(struct hci_uart
*hu
, int id
)
634 const struct hci_uart_proto
*p
;
637 p
= hci_uart_get_proto(id
);
639 return -EPROTONOSUPPORT
;
647 err
= hci_uart_register_dev(hu
);
656 static int hci_uart_set_flags(struct hci_uart
*hu
, unsigned long flags
)
658 unsigned long valid_flags
= BIT(HCI_UART_RAW_DEVICE
) |
659 BIT(HCI_UART_RESET_ON_INIT
) |
660 BIT(HCI_UART_CREATE_AMP
) |
661 BIT(HCI_UART_INIT_PENDING
) |
662 BIT(HCI_UART_EXT_CONFIG
) |
663 BIT(HCI_UART_VND_DETECT
);
665 if (flags
& ~valid_flags
)
668 hu
->hdev_flags
= flags
;
673 /* hci_uart_tty_ioctl()
675 * Process IOCTL system call for the tty device.
679 * tty pointer to tty instance data
680 * file pointer to open file object for device
681 * cmd IOCTL command code
682 * arg argument for IOCTL call (cmd dependent)
684 * Return Value: Command dependent
686 static int hci_uart_tty_ioctl(struct tty_struct
*tty
, struct file
*file
,
687 unsigned int cmd
, unsigned long arg
)
689 struct hci_uart
*hu
= tty
->disc_data
;
694 /* Verify the status of the device */
699 case HCIUARTSETPROTO
:
700 if (!test_and_set_bit(HCI_UART_PROTO_SET
, &hu
->flags
)) {
701 err
= hci_uart_set_proto(hu
, arg
);
703 clear_bit(HCI_UART_PROTO_SET
, &hu
->flags
);
710 case HCIUARTGETPROTO
:
711 if (test_bit(HCI_UART_PROTO_SET
, &hu
->flags
))
712 return hu
->proto
->id
;
715 case HCIUARTGETDEVICE
:
716 if (test_bit(HCI_UART_REGISTERED
, &hu
->flags
))
720 case HCIUARTSETFLAGS
:
721 if (test_bit(HCI_UART_PROTO_SET
, &hu
->flags
))
723 err
= hci_uart_set_flags(hu
, arg
);
728 case HCIUARTGETFLAGS
:
729 return hu
->hdev_flags
;
732 err
= n_tty_ioctl_helper(tty
, file
, cmd
, arg
);
740 * We don't provide read/write/poll interface for user space.
742 static ssize_t
hci_uart_tty_read(struct tty_struct
*tty
, struct file
*file
,
743 unsigned char __user
*buf
, size_t nr
)
748 static ssize_t
hci_uart_tty_write(struct tty_struct
*tty
, struct file
*file
,
749 const unsigned char *data
, size_t count
)
754 static unsigned int hci_uart_tty_poll(struct tty_struct
*tty
,
755 struct file
*filp
, poll_table
*wait
)
760 static int __init
hci_uart_init(void)
762 static struct tty_ldisc_ops hci_uart_ldisc
;
765 BT_INFO("HCI UART driver ver %s", VERSION
);
767 /* Register the tty discipline */
769 memset(&hci_uart_ldisc
, 0, sizeof(hci_uart_ldisc
));
770 hci_uart_ldisc
.magic
= TTY_LDISC_MAGIC
;
771 hci_uart_ldisc
.name
= "n_hci";
772 hci_uart_ldisc
.open
= hci_uart_tty_open
;
773 hci_uart_ldisc
.close
= hci_uart_tty_close
;
774 hci_uart_ldisc
.read
= hci_uart_tty_read
;
775 hci_uart_ldisc
.write
= hci_uart_tty_write
;
776 hci_uart_ldisc
.ioctl
= hci_uart_tty_ioctl
;
777 hci_uart_ldisc
.poll
= hci_uart_tty_poll
;
778 hci_uart_ldisc
.receive_buf
= hci_uart_tty_receive
;
779 hci_uart_ldisc
.write_wakeup
= hci_uart_tty_wakeup
;
780 hci_uart_ldisc
.owner
= THIS_MODULE
;
782 err
= tty_register_ldisc(N_HCI
, &hci_uart_ldisc
);
784 BT_ERR("HCI line discipline registration failed. (%d)", err
);
788 #ifdef CONFIG_BT_HCIUART_H4
791 #ifdef CONFIG_BT_HCIUART_BCSP
794 #ifdef CONFIG_BT_HCIUART_LL
797 #ifdef CONFIG_BT_HCIUART_ATH3K
800 #ifdef CONFIG_BT_HCIUART_3WIRE
803 #ifdef CONFIG_BT_HCIUART_INTEL
806 #ifdef CONFIG_BT_HCIUART_BCM
809 #ifdef CONFIG_BT_HCIUART_QCA
816 static void __exit
hci_uart_exit(void)
820 #ifdef CONFIG_BT_HCIUART_H4
823 #ifdef CONFIG_BT_HCIUART_BCSP
826 #ifdef CONFIG_BT_HCIUART_LL
829 #ifdef CONFIG_BT_HCIUART_ATH3K
832 #ifdef CONFIG_BT_HCIUART_3WIRE
835 #ifdef CONFIG_BT_HCIUART_INTEL
838 #ifdef CONFIG_BT_HCIUART_BCM
841 #ifdef CONFIG_BT_HCIUART_QCA
845 /* Release tty registration of line discipline */
846 err
= tty_unregister_ldisc(N_HCI
);
848 BT_ERR("Can't unregister HCI line discipline (%d)", err
);
851 module_init(hci_uart_init
);
852 module_exit(hci_uart_exit
);
854 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
855 MODULE_DESCRIPTION("Bluetooth HCI UART driver ver " VERSION
);
856 MODULE_VERSION(VERSION
);
857 MODULE_LICENSE("GPL");
858 MODULE_ALIAS_LDISC(N_HCI
);