2 * Texas Instruments' Bluetooth HCILL UART protocol
4 * HCILL (HCI Low Level) is a Texas Instruments' power management
5 * protocol extension to H4.
7 * Copyright (C) 2007 Texas Instruments, Inc.
9 * Written by Ohad Ben-Cohen <ohad@bencohen.org>
12 * This file is based on hci_h4.c, which was written
13 * by Maxim Krasnyansky and Marcel Holtmann.
15 * This program is free software; you can redistribute it and/or modify
16 * it under the terms of the GNU General Public License version 2
17 * as published by the Free Software Foundation
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program; if not, write to the Free Software
26 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30 #include <linux/module.h>
31 #include <linux/kernel.h>
33 #include <linux/init.h>
34 #include <linux/sched.h>
35 #include <linux/types.h>
36 #include <linux/fcntl.h>
37 #include <linux/firmware.h>
38 #include <linux/interrupt.h>
39 #include <linux/ptrace.h>
40 #include <linux/poll.h>
42 #include <linux/slab.h>
43 #include <linux/errno.h>
44 #include <linux/string.h>
45 #include <linux/signal.h>
46 #include <linux/ioctl.h>
48 #include <linux/serdev.h>
49 #include <linux/skbuff.h>
50 #include <linux/ti_wilink_st.h>
51 #include <linux/clk.h>
53 #include <net/bluetooth/bluetooth.h>
54 #include <net/bluetooth/hci_core.h>
55 #include <linux/gpio/consumer.h>
56 #include <linux/nvmem-consumer.h>
60 /* Vendor-specific HCI commands */
61 #define HCI_VS_WRITE_BD_ADDR 0xfc06
62 #define HCI_VS_UPDATE_UART_HCI_BAUDRATE 0xff36
65 #define HCILL_GO_TO_SLEEP_IND 0x30
66 #define HCILL_GO_TO_SLEEP_ACK 0x31
67 #define HCILL_WAKE_UP_IND 0x32
68 #define HCILL_WAKE_UP_ACK 0x33
73 HCILL_ASLEEP_TO_AWAKE
,
80 struct serdev_device
*serdev
;
81 struct gpio_desc
*enable_gpio
;
87 struct sk_buff
*rx_skb
;
88 struct sk_buff_head txq
;
89 spinlock_t hcill_lock
; /* HCILL state lock */
90 unsigned long hcill_state
; /* HCILL power state */
91 struct sk_buff_head tx_wait_q
; /* HCILL wait queue */
95 * Builds and sends an HCILL command packet.
96 * These are very simple packets with only 1 cmd byte
98 static int send_hcill_cmd(u8 cmd
, struct hci_uart
*hu
)
101 struct sk_buff
*skb
= NULL
;
102 struct ll_struct
*ll
= hu
->priv
;
104 BT_DBG("hu %p cmd 0x%x", hu
, cmd
);
106 /* allocate packet */
107 skb
= bt_skb_alloc(1, GFP_ATOMIC
);
109 BT_ERR("cannot allocate memory for HCILL packet");
115 skb_put_u8(skb
, cmd
);
118 skb_queue_tail(&ll
->txq
, skb
);
123 /* Initialize protocol */
124 static int ll_open(struct hci_uart
*hu
)
126 struct ll_struct
*ll
;
130 ll
= kzalloc(sizeof(*ll
), GFP_KERNEL
);
134 skb_queue_head_init(&ll
->txq
);
135 skb_queue_head_init(&ll
->tx_wait_q
);
136 spin_lock_init(&ll
->hcill_lock
);
138 ll
->hcill_state
= HCILL_AWAKE
;
143 struct ll_device
*lldev
= serdev_device_get_drvdata(hu
->serdev
);
144 if (!IS_ERR(lldev
->ext_clk
))
145 clk_prepare_enable(lldev
->ext_clk
);
151 /* Flush protocol data */
152 static int ll_flush(struct hci_uart
*hu
)
154 struct ll_struct
*ll
= hu
->priv
;
158 skb_queue_purge(&ll
->tx_wait_q
);
159 skb_queue_purge(&ll
->txq
);
165 static int ll_close(struct hci_uart
*hu
)
167 struct ll_struct
*ll
= hu
->priv
;
171 skb_queue_purge(&ll
->tx_wait_q
);
172 skb_queue_purge(&ll
->txq
);
174 kfree_skb(ll
->rx_skb
);
177 struct ll_device
*lldev
= serdev_device_get_drvdata(hu
->serdev
);
178 gpiod_set_value_cansleep(lldev
->enable_gpio
, 0);
180 clk_disable_unprepare(lldev
->ext_clk
);
191 * internal function, which does common work of the device wake up process:
192 * 1. places all pending packets (waiting in tx_wait_q list) in txq list.
193 * 2. changes internal state to HCILL_AWAKE.
194 * Note: assumes that hcill_lock spinlock is taken,
195 * shouldn't be called otherwise!
197 static void __ll_do_awake(struct ll_struct
*ll
)
199 struct sk_buff
*skb
= NULL
;
201 while ((skb
= skb_dequeue(&ll
->tx_wait_q
)))
202 skb_queue_tail(&ll
->txq
, skb
);
204 ll
->hcill_state
= HCILL_AWAKE
;
208 * Called upon a wake-up-indication from the device
210 static void ll_device_want_to_wakeup(struct hci_uart
*hu
)
213 struct ll_struct
*ll
= hu
->priv
;
217 /* lock hcill state */
218 spin_lock_irqsave(&ll
->hcill_lock
, flags
);
220 switch (ll
->hcill_state
) {
221 case HCILL_ASLEEP_TO_AWAKE
:
223 * This state means that both the host and the BRF chip
224 * have simultaneously sent a wake-up-indication packet.
225 * Traditionally, in this case, receiving a wake-up-indication
226 * was enough and an additional wake-up-ack wasn't needed.
227 * This has changed with the BRF6350, which does require an
228 * explicit wake-up-ack. Other BRF versions, which do not
229 * require an explicit ack here, do accept it, thus it is
230 * perfectly safe to always send one.
232 BT_DBG("dual wake-up-indication");
235 /* acknowledge device wake up */
236 if (send_hcill_cmd(HCILL_WAKE_UP_ACK
, hu
) < 0) {
237 BT_ERR("cannot acknowledge device wake up");
242 /* any other state is illegal */
243 BT_ERR("received HCILL_WAKE_UP_IND in state %ld", ll
->hcill_state
);
247 /* send pending packets and change state to HCILL_AWAKE */
251 spin_unlock_irqrestore(&ll
->hcill_lock
, flags
);
253 /* actually send the packets */
254 hci_uart_tx_wakeup(hu
);
258 * Called upon a sleep-indication from the device
260 static void ll_device_want_to_sleep(struct hci_uart
*hu
)
263 struct ll_struct
*ll
= hu
->priv
;
267 /* lock hcill state */
268 spin_lock_irqsave(&ll
->hcill_lock
, flags
);
271 if (ll
->hcill_state
!= HCILL_AWAKE
)
272 BT_ERR("ERR: HCILL_GO_TO_SLEEP_IND in state %ld", ll
->hcill_state
);
274 /* acknowledge device sleep */
275 if (send_hcill_cmd(HCILL_GO_TO_SLEEP_ACK
, hu
) < 0) {
276 BT_ERR("cannot acknowledge device sleep");
281 ll
->hcill_state
= HCILL_ASLEEP
;
284 spin_unlock_irqrestore(&ll
->hcill_lock
, flags
);
286 /* actually send the sleep ack packet */
287 hci_uart_tx_wakeup(hu
);
291 * Called upon wake-up-acknowledgement from the device
293 static void ll_device_woke_up(struct hci_uart
*hu
)
296 struct ll_struct
*ll
= hu
->priv
;
300 /* lock hcill state */
301 spin_lock_irqsave(&ll
->hcill_lock
, flags
);
304 if (ll
->hcill_state
!= HCILL_ASLEEP_TO_AWAKE
)
305 BT_ERR("received HCILL_WAKE_UP_ACK in state %ld", ll
->hcill_state
);
307 /* send pending packets and change state to HCILL_AWAKE */
310 spin_unlock_irqrestore(&ll
->hcill_lock
, flags
);
312 /* actually send the packets */
313 hci_uart_tx_wakeup(hu
);
316 /* Enqueue frame for transmittion (padding, crc, etc) */
317 /* may be called from two simultaneous tasklets */
318 static int ll_enqueue(struct hci_uart
*hu
, struct sk_buff
*skb
)
320 unsigned long flags
= 0;
321 struct ll_struct
*ll
= hu
->priv
;
323 BT_DBG("hu %p skb %p", hu
, skb
);
325 /* Prepend skb with frame type */
326 memcpy(skb_push(skb
, 1), &hci_skb_pkt_type(skb
), 1);
328 /* lock hcill state */
329 spin_lock_irqsave(&ll
->hcill_lock
, flags
);
331 /* act according to current state */
332 switch (ll
->hcill_state
) {
334 BT_DBG("device awake, sending normally");
335 skb_queue_tail(&ll
->txq
, skb
);
338 BT_DBG("device asleep, waking up and queueing packet");
339 /* save packet for later */
340 skb_queue_tail(&ll
->tx_wait_q
, skb
);
342 if (send_hcill_cmd(HCILL_WAKE_UP_IND
, hu
) < 0) {
343 BT_ERR("cannot wake up device");
346 ll
->hcill_state
= HCILL_ASLEEP_TO_AWAKE
;
348 case HCILL_ASLEEP_TO_AWAKE
:
349 BT_DBG("device waking up, queueing packet");
350 /* transient state; just keep packet for later */
351 skb_queue_tail(&ll
->tx_wait_q
, skb
);
354 BT_ERR("illegal hcill state: %ld (losing packet)", ll
->hcill_state
);
359 spin_unlock_irqrestore(&ll
->hcill_lock
, flags
);
364 static int ll_recv_frame(struct hci_dev
*hdev
, struct sk_buff
*skb
)
366 struct hci_uart
*hu
= hci_get_drvdata(hdev
);
367 struct ll_struct
*ll
= hu
->priv
;
369 switch (hci_skb_pkt_type(skb
)) {
370 case HCILL_GO_TO_SLEEP_IND
:
371 BT_DBG("HCILL_GO_TO_SLEEP_IND packet");
372 ll_device_want_to_sleep(hu
);
374 case HCILL_GO_TO_SLEEP_ACK
:
375 /* shouldn't happen */
376 bt_dev_err(hdev
, "received HCILL_GO_TO_SLEEP_ACK in state %ld",
379 case HCILL_WAKE_UP_IND
:
380 BT_DBG("HCILL_WAKE_UP_IND packet");
381 ll_device_want_to_wakeup(hu
);
383 case HCILL_WAKE_UP_ACK
:
384 BT_DBG("HCILL_WAKE_UP_ACK packet");
385 ll_device_woke_up(hu
);
393 #define LL_RECV_SLEEP_IND \
394 .type = HCILL_GO_TO_SLEEP_IND, \
400 #define LL_RECV_SLEEP_ACK \
401 .type = HCILL_GO_TO_SLEEP_ACK, \
407 #define LL_RECV_WAKE_IND \
408 .type = HCILL_WAKE_UP_IND, \
414 #define LL_RECV_WAKE_ACK \
415 .type = HCILL_WAKE_UP_ACK, \
421 static const struct h4_recv_pkt ll_recv_pkts
[] = {
422 { H4_RECV_ACL
, .recv
= hci_recv_frame
},
423 { H4_RECV_SCO
, .recv
= hci_recv_frame
},
424 { H4_RECV_EVENT
, .recv
= hci_recv_frame
},
425 { LL_RECV_SLEEP_IND
, .recv
= ll_recv_frame
},
426 { LL_RECV_SLEEP_ACK
, .recv
= ll_recv_frame
},
427 { LL_RECV_WAKE_IND
, .recv
= ll_recv_frame
},
428 { LL_RECV_WAKE_ACK
, .recv
= ll_recv_frame
},
432 static int ll_recv(struct hci_uart
*hu
, const void *data
, int count
)
434 struct ll_struct
*ll
= hu
->priv
;
436 if (!test_bit(HCI_UART_REGISTERED
, &hu
->flags
))
439 ll
->rx_skb
= h4_recv_buf(hu
->hdev
, ll
->rx_skb
, data
, count
,
440 ll_recv_pkts
, ARRAY_SIZE(ll_recv_pkts
));
441 if (IS_ERR(ll
->rx_skb
)) {
442 int err
= PTR_ERR(ll
->rx_skb
);
443 bt_dev_err(hu
->hdev
, "Frame reassembly failed (%d)", err
);
451 static struct sk_buff
*ll_dequeue(struct hci_uart
*hu
)
453 struct ll_struct
*ll
= hu
->priv
;
454 return skb_dequeue(&ll
->txq
);
457 #if IS_ENABLED(CONFIG_SERIAL_DEV_BUS)
458 static int read_local_version(struct hci_dev
*hdev
)
461 unsigned short version
= 0;
463 struct hci_rp_read_local_version
*ver
;
465 skb
= __hci_cmd_sync(hdev
, HCI_OP_READ_LOCAL_VERSION
, 0, NULL
, HCI_INIT_TIMEOUT
);
467 bt_dev_err(hdev
, "Reading TI version information failed (%ld)",
471 if (skb
->len
!= sizeof(*ver
)) {
476 ver
= (struct hci_rp_read_local_version
*)skb
->data
;
477 if (le16_to_cpu(ver
->manufacturer
) != 13) {
482 version
= le16_to_cpu(ver
->lmp_subver
);
485 if (err
) bt_dev_err(hdev
, "Failed to read TI version info: %d", err
);
487 return err
? err
: version
;
491 * download_firmware -
492 * internal function which parses through the .bts firmware
493 * script file intreprets SEND, DELAY actions only as of now
495 static int download_firmware(struct ll_device
*lldev
)
497 unsigned short chip
, min_ver
, maj_ver
;
498 int version
, err
, len
;
499 unsigned char *ptr
, *action_ptr
;
500 unsigned char bts_scr_name
[40]; /* 40 char long bts scr name? */
501 const struct firmware
*fw
;
503 struct hci_command
*cmd
;
505 version
= read_local_version(lldev
->hu
.hdev
);
509 chip
= (version
& 0x7C00) >> 10;
510 min_ver
= (version
& 0x007F);
511 maj_ver
= (version
& 0x0380) >> 7;
512 if (version
& 0x8000)
515 snprintf(bts_scr_name
, sizeof(bts_scr_name
),
516 "ti-connectivity/TIInit_%d.%d.%d.bts",
517 chip
, maj_ver
, min_ver
);
519 err
= request_firmware(&fw
, bts_scr_name
, &lldev
->serdev
->dev
);
520 if (err
|| !fw
->data
|| !fw
->size
) {
521 bt_dev_err(lldev
->hu
.hdev
, "request_firmware failed(errno %d) for %s",
525 ptr
= (void *)fw
->data
;
527 /* bts_header to remove out magic number and
530 ptr
+= sizeof(struct bts_header
);
531 len
-= sizeof(struct bts_header
);
533 while (len
> 0 && ptr
) {
534 bt_dev_dbg(lldev
->hu
.hdev
, " action size %d, type %d ",
535 ((struct bts_action
*)ptr
)->size
,
536 ((struct bts_action
*)ptr
)->type
);
538 action_ptr
= &(((struct bts_action
*)ptr
)->data
[0]);
540 switch (((struct bts_action
*)ptr
)->type
) {
541 case ACTION_SEND_COMMAND
: /* action send */
542 bt_dev_dbg(lldev
->hu
.hdev
, "S");
543 cmd
= (struct hci_command
*)action_ptr
;
544 if (cmd
->opcode
== HCI_VS_UPDATE_UART_HCI_BAUDRATE
) {
545 /* ignore remote change
546 * baud rate HCI VS command
548 bt_dev_warn(lldev
->hu
.hdev
, "change remote baud rate command in firmware");
551 if (cmd
->prefix
!= 1)
552 bt_dev_dbg(lldev
->hu
.hdev
, "command type %d", cmd
->prefix
);
554 skb
= __hci_cmd_sync(lldev
->hu
.hdev
, cmd
->opcode
, cmd
->plen
, &cmd
->speed
, HCI_INIT_TIMEOUT
);
556 bt_dev_err(lldev
->hu
.hdev
, "send command failed");
562 case ACTION_WAIT_EVENT
: /* wait */
563 /* no need to wait as command was synchronous */
564 bt_dev_dbg(lldev
->hu
.hdev
, "W");
566 case ACTION_DELAY
: /* sleep */
567 bt_dev_info(lldev
->hu
.hdev
, "sleep command in scr");
568 msleep(((struct bts_action_delay
*)action_ptr
)->msec
);
571 len
-= (sizeof(struct bts_action
) +
572 ((struct bts_action
*)ptr
)->size
);
573 ptr
+= sizeof(struct bts_action
) +
574 ((struct bts_action
*)ptr
)->size
;
578 /* fw download complete */
579 release_firmware(fw
);
583 static int ll_set_bdaddr(struct hci_dev
*hdev
, const bdaddr_t
*bdaddr
)
585 bdaddr_t bdaddr_swapped
;
588 /* HCI_VS_WRITE_BD_ADDR (at least on a CC2560A chip) expects the BD
589 * address to be MSB first, but bdaddr_t has the convention of being
592 baswap(&bdaddr_swapped
, bdaddr
);
593 skb
= __hci_cmd_sync(hdev
, HCI_VS_WRITE_BD_ADDR
, sizeof(bdaddr_t
),
594 &bdaddr_swapped
, HCI_INIT_TIMEOUT
);
598 return PTR_ERR_OR_ZERO(skb
);
601 static int ll_setup(struct hci_uart
*hu
)
604 struct ll_device
*lldev
;
605 struct serdev_device
*serdev
= hu
->serdev
;
611 lldev
= serdev_device_get_drvdata(serdev
);
613 hu
->hdev
->set_bdaddr
= ll_set_bdaddr
;
615 serdev_device_set_flow_control(serdev
, true);
618 /* Reset the Bluetooth device */
619 gpiod_set_value_cansleep(lldev
->enable_gpio
, 0);
621 gpiod_set_value_cansleep(lldev
->enable_gpio
, 1);
622 err
= serdev_device_wait_for_cts(serdev
, true, 200);
624 bt_dev_err(hu
->hdev
, "Failed to get CTS");
628 err
= download_firmware(lldev
);
632 /* Toggle BT_EN and retry */
633 bt_dev_err(hu
->hdev
, "download firmware failed, retrying...");
639 /* Set BD address if one was specified at probe */
640 if (!bacmp(&lldev
->bdaddr
, BDADDR_NONE
)) {
641 /* This means that there was an error getting the BD address
642 * during probe, so mark the device as having a bad address.
644 set_bit(HCI_QUIRK_INVALID_BDADDR
, &hu
->hdev
->quirks
);
645 } else if (bacmp(&lldev
->bdaddr
, BDADDR_ANY
)) {
646 err
= ll_set_bdaddr(hu
->hdev
, &lldev
->bdaddr
);
648 set_bit(HCI_QUIRK_INVALID_BDADDR
, &hu
->hdev
->quirks
);
651 /* Operational speed if any */
653 speed
= hu
->oper_speed
;
654 else if (hu
->proto
->oper_speed
)
655 speed
= hu
->proto
->oper_speed
;
660 __le32 speed_le
= cpu_to_le32(speed
);
663 skb
= __hci_cmd_sync(hu
->hdev
, HCI_VS_UPDATE_UART_HCI_BAUDRATE
,
664 sizeof(speed_le
), &speed_le
,
668 serdev_device_set_baudrate(serdev
, speed
);
675 static const struct hci_uart_proto llp
;
677 static int hci_ti_probe(struct serdev_device
*serdev
)
680 struct ll_device
*lldev
;
681 struct nvmem_cell
*bdaddr_cell
;
682 u32 max_speed
= 3000000;
684 lldev
= devm_kzalloc(&serdev
->dev
, sizeof(struct ll_device
), GFP_KERNEL
);
689 serdev_device_set_drvdata(serdev
, lldev
);
690 lldev
->serdev
= hu
->serdev
= serdev
;
692 lldev
->enable_gpio
= devm_gpiod_get_optional(&serdev
->dev
, "enable", GPIOD_OUT_LOW
);
693 if (IS_ERR(lldev
->enable_gpio
))
694 return PTR_ERR(lldev
->enable_gpio
);
696 lldev
->ext_clk
= devm_clk_get(&serdev
->dev
, "ext_clock");
697 if (IS_ERR(lldev
->ext_clk
) && PTR_ERR(lldev
->ext_clk
) != -ENOENT
)
698 return PTR_ERR(lldev
->ext_clk
);
700 of_property_read_u32(serdev
->dev
.of_node
, "max-speed", &max_speed
);
701 hci_uart_set_speeds(hu
, 115200, max_speed
);
703 /* optional BD address from nvram */
704 bdaddr_cell
= nvmem_cell_get(&serdev
->dev
, "bd-address");
705 if (IS_ERR(bdaddr_cell
)) {
706 int err
= PTR_ERR(bdaddr_cell
);
708 if (err
== -EPROBE_DEFER
)
711 /* ENOENT means there is no matching nvmem cell and ENOSYS
712 * means that nvmem is not enabled in the kernel configuration.
714 if (err
!= -ENOENT
&& err
!= -ENOSYS
) {
715 /* If there was some other error, give userspace a
716 * chance to fix the problem instead of failing to load
717 * the driver. Using BDADDR_NONE as a flag that is
718 * tested later in the setup function.
720 dev_warn(&serdev
->dev
,
721 "Failed to get \"bd-address\" nvmem cell (%d)\n",
723 bacpy(&lldev
->bdaddr
, BDADDR_NONE
);
729 bdaddr
= nvmem_cell_read(bdaddr_cell
, &len
);
730 nvmem_cell_put(bdaddr_cell
);
731 if (IS_ERR(bdaddr
)) {
732 dev_err(&serdev
->dev
, "Failed to read nvmem bd-address\n");
733 return PTR_ERR(bdaddr
);
735 if (len
!= sizeof(bdaddr_t
)) {
736 dev_err(&serdev
->dev
, "Invalid nvmem bd-address length\n");
741 /* As per the device tree bindings, the value from nvmem is
742 * expected to be MSB first, but in the kernel it is expected
743 * that bdaddr_t is LSB first.
745 baswap(&lldev
->bdaddr
, bdaddr
);
749 return hci_uart_register_device(hu
, &llp
);
752 static void hci_ti_remove(struct serdev_device
*serdev
)
754 struct ll_device
*lldev
= serdev_device_get_drvdata(serdev
);
756 hci_uart_unregister_device(&lldev
->hu
);
759 static const struct of_device_id hci_ti_of_match
[] = {
760 { .compatible
= "ti,cc2560" },
761 { .compatible
= "ti,wl1271-st" },
762 { .compatible
= "ti,wl1273-st" },
763 { .compatible
= "ti,wl1281-st" },
764 { .compatible
= "ti,wl1283-st" },
765 { .compatible
= "ti,wl1285-st" },
766 { .compatible
= "ti,wl1801-st" },
767 { .compatible
= "ti,wl1805-st" },
768 { .compatible
= "ti,wl1807-st" },
769 { .compatible
= "ti,wl1831-st" },
770 { .compatible
= "ti,wl1835-st" },
771 { .compatible
= "ti,wl1837-st" },
774 MODULE_DEVICE_TABLE(of
, hci_ti_of_match
);
776 static struct serdev_device_driver hci_ti_drv
= {
779 .of_match_table
= of_match_ptr(hci_ti_of_match
),
781 .probe
= hci_ti_probe
,
782 .remove
= hci_ti_remove
,
785 #define ll_setup NULL
788 static const struct hci_uart_proto llp
= {
795 .enqueue
= ll_enqueue
,
796 .dequeue
= ll_dequeue
,
800 int __init
ll_init(void)
802 serdev_device_driver_register(&hci_ti_drv
);
804 return hci_uart_register_proto(&llp
);
807 int __exit
ll_deinit(void)
809 serdev_device_driver_unregister(&hci_ti_drv
);
811 return hci_uart_unregister_proto(&llp
);