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 if (test_bit(HCI_UART_PROTO_READY
, &hu
->flags
))
118 skb
= hu
->proto
->dequeue(hu
);
126 int hci_uart_tx_wakeup(struct hci_uart
*hu
)
128 if (!test_bit(HCI_UART_PROTO_READY
, &hu
->flags
))
131 if (test_and_set_bit(HCI_UART_SENDING
, &hu
->tx_state
)) {
132 set_bit(HCI_UART_TX_WAKEUP
, &hu
->tx_state
);
138 schedule_work(&hu
->write_work
);
143 static void hci_uart_write_work(struct work_struct
*work
)
145 struct hci_uart
*hu
= container_of(work
, struct hci_uart
, write_work
);
146 struct tty_struct
*tty
= hu
->tty
;
147 struct hci_dev
*hdev
= hu
->hdev
;
150 /* REVISIT: should we cope with bad skbs or ->write() returning
155 clear_bit(HCI_UART_TX_WAKEUP
, &hu
->tx_state
);
157 while ((skb
= hci_uart_dequeue(hu
))) {
160 set_bit(TTY_DO_WRITE_WAKEUP
, &tty
->flags
);
161 len
= tty
->ops
->write(tty
, skb
->data
, skb
->len
);
162 hdev
->stat
.byte_tx
+= len
;
170 hci_uart_tx_complete(hu
, hci_skb_pkt_type(skb
));
174 if (test_bit(HCI_UART_TX_WAKEUP
, &hu
->tx_state
))
177 clear_bit(HCI_UART_SENDING
, &hu
->tx_state
);
180 static void hci_uart_init_work(struct work_struct
*work
)
182 struct hci_uart
*hu
= container_of(work
, struct hci_uart
, init_ready
);
185 if (!test_and_clear_bit(HCI_UART_INIT_PENDING
, &hu
->hdev_flags
))
188 err
= hci_register_dev(hu
->hdev
);
190 BT_ERR("Can't register HCI device");
191 hci_free_dev(hu
->hdev
);
193 hu
->proto
->close(hu
);
196 set_bit(HCI_UART_REGISTERED
, &hu
->flags
);
199 int hci_uart_init_ready(struct hci_uart
*hu
)
201 if (!test_bit(HCI_UART_INIT_PENDING
, &hu
->hdev_flags
))
204 schedule_work(&hu
->init_ready
);
209 /* ------- Interface to HCI layer ------ */
210 /* Initialize device */
211 static int hci_uart_open(struct hci_dev
*hdev
)
213 BT_DBG("%s %p", hdev
->name
, hdev
);
215 /* Nothing to do for UART driver */
220 static int hci_uart_flush(struct hci_dev
*hdev
)
222 struct hci_uart
*hu
= hci_get_drvdata(hdev
);
223 struct tty_struct
*tty
= hu
->tty
;
225 BT_DBG("hdev %p tty %p", hdev
, tty
);
228 kfree_skb(hu
->tx_skb
); hu
->tx_skb
= NULL
;
231 /* Flush any pending characters in the driver and discipline. */
232 tty_ldisc_flush(tty
);
233 tty_driver_flush_buffer(tty
);
235 if (test_bit(HCI_UART_PROTO_READY
, &hu
->flags
))
236 hu
->proto
->flush(hu
);
242 static int hci_uart_close(struct hci_dev
*hdev
)
244 BT_DBG("hdev %p", hdev
);
246 hci_uart_flush(hdev
);
251 /* Send frames from HCI layer */
252 static int hci_uart_send_frame(struct hci_dev
*hdev
, struct sk_buff
*skb
)
254 struct hci_uart
*hu
= hci_get_drvdata(hdev
);
256 BT_DBG("%s: type %d len %d", hdev
->name
, hci_skb_pkt_type(skb
),
259 hu
->proto
->enqueue(hu
, skb
);
261 hci_uart_tx_wakeup(hu
);
266 /* Check the underlying device or tty has flow control support */
267 bool hci_uart_has_flow_control(struct hci_uart
*hu
)
269 if (hu
->tty
->driver
->ops
->tiocmget
&& hu
->tty
->driver
->ops
->tiocmset
)
275 /* Flow control or un-flow control the device */
276 void hci_uart_set_flow_control(struct hci_uart
*hu
, bool enable
)
278 struct tty_struct
*tty
= hu
->tty
;
279 struct ktermios ktermios
;
281 unsigned int set
= 0;
282 unsigned int clear
= 0;
285 /* Disable hardware flow control */
286 ktermios
= tty
->termios
;
287 ktermios
.c_cflag
&= ~CRTSCTS
;
288 status
= tty_set_termios(tty
, &ktermios
);
289 BT_DBG("Disabling hardware flow control: %s",
290 status
? "failed" : "success");
292 /* Clear RTS to prevent the device from sending */
293 /* Most UARTs need OUT2 to enable interrupts */
294 status
= tty
->driver
->ops
->tiocmget(tty
);
295 BT_DBG("Current tiocm 0x%x", status
);
297 set
&= ~(TIOCM_OUT2
| TIOCM_RTS
);
299 set
&= TIOCM_DTR
| TIOCM_RTS
| TIOCM_OUT1
|
300 TIOCM_OUT2
| TIOCM_LOOP
;
301 clear
&= TIOCM_DTR
| TIOCM_RTS
| TIOCM_OUT1
|
302 TIOCM_OUT2
| TIOCM_LOOP
;
303 status
= tty
->driver
->ops
->tiocmset(tty
, set
, clear
);
304 BT_DBG("Clearing RTS: %s", status
? "failed" : "success");
306 /* Set RTS to allow the device to send again */
307 status
= tty
->driver
->ops
->tiocmget(tty
);
308 BT_DBG("Current tiocm 0x%x", status
);
310 set
|= (TIOCM_OUT2
| TIOCM_RTS
);
312 set
&= TIOCM_DTR
| TIOCM_RTS
| TIOCM_OUT1
|
313 TIOCM_OUT2
| TIOCM_LOOP
;
314 clear
&= TIOCM_DTR
| TIOCM_RTS
| TIOCM_OUT1
|
315 TIOCM_OUT2
| TIOCM_LOOP
;
316 status
= tty
->driver
->ops
->tiocmset(tty
, set
, clear
);
317 BT_DBG("Setting RTS: %s", status
? "failed" : "success");
319 /* Re-enable hardware flow control */
320 ktermios
= tty
->termios
;
321 ktermios
.c_cflag
|= CRTSCTS
;
322 status
= tty_set_termios(tty
, &ktermios
);
323 BT_DBG("Enabling hardware flow control: %s",
324 status
? "failed" : "success");
328 void hci_uart_set_speeds(struct hci_uart
*hu
, unsigned int init_speed
,
329 unsigned int oper_speed
)
331 hu
->init_speed
= init_speed
;
332 hu
->oper_speed
= oper_speed
;
335 void hci_uart_init_tty(struct hci_uart
*hu
)
337 struct tty_struct
*tty
= hu
->tty
;
338 struct ktermios ktermios
;
340 /* Bring the UART into a known 8 bits no parity hw fc state */
341 ktermios
= tty
->termios
;
342 ktermios
.c_iflag
&= ~(IGNBRK
| BRKINT
| PARMRK
| ISTRIP
|
343 INLCR
| IGNCR
| ICRNL
| IXON
);
344 ktermios
.c_oflag
&= ~OPOST
;
345 ktermios
.c_lflag
&= ~(ECHO
| ECHONL
| ICANON
| ISIG
| IEXTEN
);
346 ktermios
.c_cflag
&= ~(CSIZE
| PARENB
);
347 ktermios
.c_cflag
|= CS8
;
348 ktermios
.c_cflag
|= CRTSCTS
;
350 /* tty_set_termios() return not checked as it is always 0 */
351 tty_set_termios(tty
, &ktermios
);
354 void hci_uart_set_baudrate(struct hci_uart
*hu
, unsigned int speed
)
356 struct tty_struct
*tty
= hu
->tty
;
357 struct ktermios ktermios
;
359 ktermios
= tty
->termios
;
360 ktermios
.c_cflag
&= ~CBAUD
;
361 tty_termios_encode_baud_rate(&ktermios
, speed
, speed
);
363 /* tty_set_termios() return not checked as it is always 0 */
364 tty_set_termios(tty
, &ktermios
);
366 BT_DBG("%s: New tty speeds: %d/%d", hu
->hdev
->name
,
367 tty
->termios
.c_ispeed
, tty
->termios
.c_ospeed
);
370 static int hci_uart_setup(struct hci_dev
*hdev
)
372 struct hci_uart
*hu
= hci_get_drvdata(hdev
);
373 struct hci_rp_read_local_version
*ver
;
378 /* Init speed if any */
380 speed
= hu
->init_speed
;
381 else if (hu
->proto
->init_speed
)
382 speed
= hu
->proto
->init_speed
;
387 hci_uart_set_baudrate(hu
, speed
);
389 /* Operational speed if any */
391 speed
= hu
->oper_speed
;
392 else if (hu
->proto
->oper_speed
)
393 speed
= hu
->proto
->oper_speed
;
397 if (hu
->proto
->set_baudrate
&& speed
) {
398 err
= hu
->proto
->set_baudrate(hu
, speed
);
400 hci_uart_set_baudrate(hu
, speed
);
403 if (hu
->proto
->setup
)
404 return hu
->proto
->setup(hu
);
406 if (!test_bit(HCI_UART_VND_DETECT
, &hu
->hdev_flags
))
409 skb
= __hci_cmd_sync(hdev
, HCI_OP_READ_LOCAL_VERSION
, 0, NULL
,
412 BT_ERR("%s: Reading local version information failed (%ld)",
413 hdev
->name
, PTR_ERR(skb
));
417 if (skb
->len
!= sizeof(*ver
)) {
418 BT_ERR("%s: Event length mismatch for version information",
423 ver
= (struct hci_rp_read_local_version
*)skb
->data
;
425 switch (le16_to_cpu(ver
->manufacturer
)) {
426 #ifdef CONFIG_BT_HCIUART_INTEL
428 hdev
->set_bdaddr
= btintel_set_bdaddr
;
429 btintel_check_bdaddr(hdev
);
432 #ifdef CONFIG_BT_HCIUART_BCM
434 hdev
->set_bdaddr
= btbcm_set_bdaddr
;
435 btbcm_check_bdaddr(hdev
);
445 /* ------ LDISC part ------ */
448 * Called when line discipline changed to HCI_UART.
451 * tty pointer to tty info structure
453 * 0 if success, otherwise error code
455 static int hci_uart_tty_open(struct tty_struct
*tty
)
459 BT_DBG("tty %p", tty
);
461 /* Error if the tty has no write op instead of leaving an exploitable
463 if (tty
->ops
->write
== NULL
)
466 hu
= kzalloc(sizeof(struct hci_uart
), GFP_KERNEL
);
468 BT_ERR("Can't allocate control structure");
474 tty
->receive_room
= 65536;
476 INIT_WORK(&hu
->init_ready
, hci_uart_init_work
);
477 INIT_WORK(&hu
->write_work
, hci_uart_write_work
);
479 /* Flush any pending characters in the driver */
480 tty_driver_flush_buffer(tty
);
485 /* hci_uart_tty_close()
487 * Called when the line discipline is changed to something
488 * else, the tty is closed, or the tty detects a hangup.
490 static void hci_uart_tty_close(struct tty_struct
*tty
)
492 struct hci_uart
*hu
= tty
->disc_data
;
493 struct hci_dev
*hdev
;
495 BT_DBG("tty %p", tty
);
497 /* Detach from the tty */
498 tty
->disc_data
= NULL
;
505 hci_uart_close(hdev
);
507 cancel_work_sync(&hu
->write_work
);
509 if (test_and_clear_bit(HCI_UART_PROTO_READY
, &hu
->flags
)) {
511 if (test_bit(HCI_UART_REGISTERED
, &hu
->flags
))
512 hci_unregister_dev(hdev
);
515 hu
->proto
->close(hu
);
517 clear_bit(HCI_UART_PROTO_SET
, &hu
->flags
);
522 /* hci_uart_tty_wakeup()
524 * Callback for transmit wakeup. Called when low level
525 * device driver can accept more send data.
527 * Arguments: tty pointer to associated tty instance data
530 static void hci_uart_tty_wakeup(struct tty_struct
*tty
)
532 struct hci_uart
*hu
= tty
->disc_data
;
539 clear_bit(TTY_DO_WRITE_WAKEUP
, &tty
->flags
);
544 if (test_bit(HCI_UART_PROTO_READY
, &hu
->flags
))
545 hci_uart_tx_wakeup(hu
);
548 /* hci_uart_tty_receive()
550 * Called by tty low level driver when receive data is
553 * Arguments: tty pointer to tty isntance data
554 * data pointer to received data
555 * flags pointer to flags for data
556 * count count of received data in bytes
560 static void hci_uart_tty_receive(struct tty_struct
*tty
, const u8
*data
,
561 char *flags
, int count
)
563 struct hci_uart
*hu
= tty
->disc_data
;
565 if (!hu
|| tty
!= hu
->tty
)
568 if (!test_bit(HCI_UART_PROTO_READY
, &hu
->flags
))
571 /* It does not need a lock here as it is already protected by a mutex in
574 hu
->proto
->recv(hu
, data
, count
);
577 hu
->hdev
->stat
.byte_rx
+= count
;
582 static int hci_uart_register_dev(struct hci_uart
*hu
)
584 struct hci_dev
*hdev
;
588 /* Initialize and register HCI device */
589 hdev
= hci_alloc_dev();
591 BT_ERR("Can't allocate HCI device");
597 hdev
->bus
= HCI_UART
;
598 hci_set_drvdata(hdev
, hu
);
600 /* Only when vendor specific setup callback is provided, consider
601 * the manufacturer information valid. This avoids filling in the
602 * value for Ericsson when nothing is specified.
604 if (hu
->proto
->setup
)
605 hdev
->manufacturer
= hu
->proto
->manufacturer
;
607 hdev
->open
= hci_uart_open
;
608 hdev
->close
= hci_uart_close
;
609 hdev
->flush
= hci_uart_flush
;
610 hdev
->send
= hci_uart_send_frame
;
611 hdev
->setup
= hci_uart_setup
;
612 SET_HCIDEV_DEV(hdev
, hu
->tty
->dev
);
614 if (test_bit(HCI_UART_RAW_DEVICE
, &hu
->hdev_flags
))
615 set_bit(HCI_QUIRK_RAW_DEVICE
, &hdev
->quirks
);
617 if (test_bit(HCI_UART_EXT_CONFIG
, &hu
->hdev_flags
))
618 set_bit(HCI_QUIRK_EXTERNAL_CONFIG
, &hdev
->quirks
);
620 if (!test_bit(HCI_UART_RESET_ON_INIT
, &hu
->hdev_flags
))
621 set_bit(HCI_QUIRK_RESET_ON_CLOSE
, &hdev
->quirks
);
623 if (test_bit(HCI_UART_CREATE_AMP
, &hu
->hdev_flags
))
624 hdev
->dev_type
= HCI_AMP
;
626 hdev
->dev_type
= HCI_PRIMARY
;
628 if (test_bit(HCI_UART_INIT_PENDING
, &hu
->hdev_flags
))
631 if (hci_register_dev(hdev
) < 0) {
632 BT_ERR("Can't register HCI device");
637 set_bit(HCI_UART_REGISTERED
, &hu
->flags
);
642 static int hci_uart_set_proto(struct hci_uart
*hu
, int id
)
644 const struct hci_uart_proto
*p
;
647 p
= hci_uart_get_proto(id
);
649 return -EPROTONOSUPPORT
;
656 set_bit(HCI_UART_PROTO_READY
, &hu
->flags
);
658 err
= hci_uart_register_dev(hu
);
660 clear_bit(HCI_UART_PROTO_READY
, &hu
->flags
);
668 static int hci_uart_set_flags(struct hci_uart
*hu
, unsigned long flags
)
670 unsigned long valid_flags
= BIT(HCI_UART_RAW_DEVICE
) |
671 BIT(HCI_UART_RESET_ON_INIT
) |
672 BIT(HCI_UART_CREATE_AMP
) |
673 BIT(HCI_UART_INIT_PENDING
) |
674 BIT(HCI_UART_EXT_CONFIG
) |
675 BIT(HCI_UART_VND_DETECT
);
677 if (flags
& ~valid_flags
)
680 hu
->hdev_flags
= flags
;
685 /* hci_uart_tty_ioctl()
687 * Process IOCTL system call for the tty device.
691 * tty pointer to tty instance data
692 * file pointer to open file object for device
693 * cmd IOCTL command code
694 * arg argument for IOCTL call (cmd dependent)
696 * Return Value: Command dependent
698 static int hci_uart_tty_ioctl(struct tty_struct
*tty
, struct file
*file
,
699 unsigned int cmd
, unsigned long arg
)
701 struct hci_uart
*hu
= tty
->disc_data
;
706 /* Verify the status of the device */
711 case HCIUARTSETPROTO
:
712 if (!test_and_set_bit(HCI_UART_PROTO_SET
, &hu
->flags
)) {
713 err
= hci_uart_set_proto(hu
, arg
);
715 clear_bit(HCI_UART_PROTO_SET
, &hu
->flags
);
720 case HCIUARTGETPROTO
:
721 if (test_bit(HCI_UART_PROTO_SET
, &hu
->flags
))
727 case HCIUARTGETDEVICE
:
728 if (test_bit(HCI_UART_REGISTERED
, &hu
->flags
))
734 case HCIUARTSETFLAGS
:
735 if (test_bit(HCI_UART_PROTO_SET
, &hu
->flags
))
738 err
= hci_uart_set_flags(hu
, arg
);
741 case HCIUARTGETFLAGS
:
742 err
= hu
->hdev_flags
;
746 err
= n_tty_ioctl_helper(tty
, file
, cmd
, arg
);
754 * We don't provide read/write/poll interface for user space.
756 static ssize_t
hci_uart_tty_read(struct tty_struct
*tty
, struct file
*file
,
757 unsigned char __user
*buf
, size_t nr
)
762 static ssize_t
hci_uart_tty_write(struct tty_struct
*tty
, struct file
*file
,
763 const unsigned char *data
, size_t count
)
768 static unsigned int hci_uart_tty_poll(struct tty_struct
*tty
,
769 struct file
*filp
, poll_table
*wait
)
774 static int __init
hci_uart_init(void)
776 static struct tty_ldisc_ops hci_uart_ldisc
;
779 BT_INFO("HCI UART driver ver %s", VERSION
);
781 /* Register the tty discipline */
783 memset(&hci_uart_ldisc
, 0, sizeof(hci_uart_ldisc
));
784 hci_uart_ldisc
.magic
= TTY_LDISC_MAGIC
;
785 hci_uart_ldisc
.name
= "n_hci";
786 hci_uart_ldisc
.open
= hci_uart_tty_open
;
787 hci_uart_ldisc
.close
= hci_uart_tty_close
;
788 hci_uart_ldisc
.read
= hci_uart_tty_read
;
789 hci_uart_ldisc
.write
= hci_uart_tty_write
;
790 hci_uart_ldisc
.ioctl
= hci_uart_tty_ioctl
;
791 hci_uart_ldisc
.poll
= hci_uart_tty_poll
;
792 hci_uart_ldisc
.receive_buf
= hci_uart_tty_receive
;
793 hci_uart_ldisc
.write_wakeup
= hci_uart_tty_wakeup
;
794 hci_uart_ldisc
.owner
= THIS_MODULE
;
796 err
= tty_register_ldisc(N_HCI
, &hci_uart_ldisc
);
798 BT_ERR("HCI line discipline registration failed. (%d)", err
);
802 #ifdef CONFIG_BT_HCIUART_H4
805 #ifdef CONFIG_BT_HCIUART_BCSP
808 #ifdef CONFIG_BT_HCIUART_LL
811 #ifdef CONFIG_BT_HCIUART_ATH3K
814 #ifdef CONFIG_BT_HCIUART_3WIRE
817 #ifdef CONFIG_BT_HCIUART_INTEL
820 #ifdef CONFIG_BT_HCIUART_BCM
823 #ifdef CONFIG_BT_HCIUART_QCA
826 #ifdef CONFIG_BT_HCIUART_AG6XX
829 #ifdef CONFIG_BT_HCIUART_MRVL
836 static void __exit
hci_uart_exit(void)
840 #ifdef CONFIG_BT_HCIUART_H4
843 #ifdef CONFIG_BT_HCIUART_BCSP
846 #ifdef CONFIG_BT_HCIUART_LL
849 #ifdef CONFIG_BT_HCIUART_ATH3K
852 #ifdef CONFIG_BT_HCIUART_3WIRE
855 #ifdef CONFIG_BT_HCIUART_INTEL
858 #ifdef CONFIG_BT_HCIUART_BCM
861 #ifdef CONFIG_BT_HCIUART_QCA
864 #ifdef CONFIG_BT_HCIUART_AG6XX
867 #ifdef CONFIG_BT_HCIUART_MRVL
871 /* Release tty registration of line discipline */
872 err
= tty_unregister_ldisc(N_HCI
);
874 BT_ERR("Can't unregister HCI line discipline (%d)", err
);
877 module_init(hci_uart_init
);
878 module_exit(hci_uart_exit
);
880 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
881 MODULE_DESCRIPTION("Bluetooth HCI UART driver ver " VERSION
);
882 MODULE_VERSION(VERSION
);
883 MODULE_LICENSE("GPL");
884 MODULE_ALIAS_LDISC(N_HCI
);