1 // SPDX-License-Identifier: GPL-2.0-or-later
4 * Bluetooth HCI Three-wire UART driver
6 * Copyright (C) 2012 Intel Corporation
9 #include <linux/acpi.h>
10 #include <linux/errno.h>
11 #include <linux/gpio/consumer.h>
12 #include <linux/kernel.h>
13 #include <linux/mod_devicetable.h>
14 #include <linux/of_device.h>
15 #include <linux/pm_runtime.h>
16 #include <linux/serdev.h>
17 #include <linux/skbuff.h>
19 #include <net/bluetooth/bluetooth.h>
20 #include <net/bluetooth/hci_core.h>
25 #define SUSPEND_TIMEOUT_MS 6000
27 #define HCI_3WIRE_ACK_PKT 0
28 #define HCI_3WIRE_LINK_PKT 15
30 /* Sliding window size */
31 #define H5_TX_WIN_MAX 4
33 #define H5_ACK_TIMEOUT msecs_to_jiffies(250)
34 #define H5_SYNC_TIMEOUT msecs_to_jiffies(100)
37 * Maximum Three-wire packet:
38 * 4 byte header + max value for 12-bit length + 2 bytes for CRC
40 #define H5_MAX_LEN (4 + 0xfff + 2)
42 /* Convenience macros for reading Three-wire header values */
43 #define H5_HDR_SEQ(hdr) ((hdr)[0] & 0x07)
44 #define H5_HDR_ACK(hdr) (((hdr)[0] >> 3) & 0x07)
45 #define H5_HDR_CRC(hdr) (((hdr)[0] >> 6) & 0x01)
46 #define H5_HDR_RELIABLE(hdr) (((hdr)[0] >> 7) & 0x01)
47 #define H5_HDR_PKT_TYPE(hdr) ((hdr)[1] & 0x0f)
48 #define H5_HDR_LEN(hdr) ((((hdr)[1] >> 4) & 0x0f) + ((hdr)[2] << 4))
50 #define SLIP_DELIMITER 0xc0
52 #define SLIP_ESC_DELIM 0xdc
53 #define SLIP_ESC_ESC 0xdd
57 H5_RX_ESC
, /* SLIP escape mode */
58 H5_TX_ACK_REQ
, /* Pending ack to send */
59 H5_WAKEUP_DISABLE
, /* Device cannot wake host */
60 H5_HW_FLOW_CONTROL
, /* Use HW flow control */
64 /* Must be the first member, hci_serdev.c expects this. */
65 struct hci_uart serdev_hu
;
67 struct sk_buff_head unack
; /* Unack'ed packets queue */
68 struct sk_buff_head rel
; /* Reliable packets queue */
69 struct sk_buff_head unrel
; /* Unreliable packets queue */
73 struct sk_buff
*rx_skb
; /* Receive buffer */
74 size_t rx_pending
; /* Expecting more bytes */
75 u8 rx_ack
; /* Last ack number received */
77 int (*rx_func
)(struct hci_uart
*hu
, u8 c
);
79 struct timer_list timer
; /* Retransmission timer */
80 struct hci_uart
*hu
; /* Parent HCI UART */
82 u8 tx_seq
; /* Next seq number to send */
83 u8 tx_ack
; /* Next ack number to send */
84 u8 tx_win
; /* Sliding window size */
98 const struct h5_vnd
*vnd
;
101 struct gpio_desc
*enable_gpio
;
102 struct gpio_desc
*device_wake_gpio
;
105 enum h5_driver_info
{
106 H5_INFO_WAKEUP_DISABLE
= BIT(0),
110 int (*setup
)(struct h5
*h5
);
111 void (*open
)(struct h5
*h5
);
112 void (*close
)(struct h5
*h5
);
113 int (*suspend
)(struct h5
*h5
);
114 int (*resume
)(struct h5
*h5
);
115 const struct acpi_gpio_mapping
*acpi_gpio_map
;
118 struct h5_device_data
{
119 uint32_t driver_info
;
123 static void h5_reset_rx(struct h5
*h5
);
125 static void h5_link_control(struct hci_uart
*hu
, const void *data
, size_t len
)
127 struct h5
*h5
= hu
->priv
;
128 struct sk_buff
*nskb
;
130 nskb
= alloc_skb(3, GFP_ATOMIC
);
134 hci_skb_pkt_type(nskb
) = HCI_3WIRE_LINK_PKT
;
136 skb_put_data(nskb
, data
, len
);
138 skb_queue_tail(&h5
->unrel
, nskb
);
141 static u8
h5_cfg_field(struct h5
*h5
)
143 /* Sliding window size (first 3 bits) */
144 return h5
->tx_win
& 0x07;
147 static void h5_timed_event(struct timer_list
*t
)
149 const unsigned char sync_req
[] = { 0x01, 0x7e };
150 unsigned char conf_req
[3] = { 0x03, 0xfc };
151 struct h5
*h5
= from_timer(h5
, t
, timer
);
152 struct hci_uart
*hu
= h5
->hu
;
156 BT_DBG("%s", hu
->hdev
->name
);
158 if (h5
->state
== H5_UNINITIALIZED
)
159 h5_link_control(hu
, sync_req
, sizeof(sync_req
));
161 if (h5
->state
== H5_INITIALIZED
) {
162 conf_req
[2] = h5_cfg_field(h5
);
163 h5_link_control(hu
, conf_req
, sizeof(conf_req
));
166 if (h5
->state
!= H5_ACTIVE
) {
167 mod_timer(&h5
->timer
, jiffies
+ H5_SYNC_TIMEOUT
);
171 if (h5
->sleep
!= H5_AWAKE
) {
172 h5
->sleep
= H5_SLEEPING
;
176 BT_DBG("hu %p retransmitting %u pkts", hu
, h5
->unack
.qlen
);
178 spin_lock_irqsave_nested(&h5
->unack
.lock
, flags
, SINGLE_DEPTH_NESTING
);
180 while ((skb
= __skb_dequeue_tail(&h5
->unack
)) != NULL
) {
181 h5
->tx_seq
= (h5
->tx_seq
- 1) & 0x07;
182 skb_queue_head(&h5
->rel
, skb
);
185 spin_unlock_irqrestore(&h5
->unack
.lock
, flags
);
188 hci_uart_tx_wakeup(hu
);
191 static void h5_peer_reset(struct hci_uart
*hu
)
193 struct h5
*h5
= hu
->priv
;
195 bt_dev_err(hu
->hdev
, "Peer device has reset");
197 h5
->state
= H5_UNINITIALIZED
;
199 del_timer(&h5
->timer
);
201 skb_queue_purge(&h5
->rel
);
202 skb_queue_purge(&h5
->unrel
);
203 skb_queue_purge(&h5
->unack
);
208 /* Send reset request to upper stack */
209 hci_reset_dev(hu
->hdev
);
212 static int h5_open(struct hci_uart
*hu
)
215 const unsigned char sync
[] = { 0x01, 0x7e };
220 h5
= serdev_device_get_drvdata(hu
->serdev
);
222 h5
= kzalloc(sizeof(*h5
), GFP_KERNEL
);
230 skb_queue_head_init(&h5
->unack
);
231 skb_queue_head_init(&h5
->rel
);
232 skb_queue_head_init(&h5
->unrel
);
236 timer_setup(&h5
->timer
, h5_timed_event
, 0);
238 h5
->tx_win
= H5_TX_WIN_MAX
;
240 if (h5
->vnd
&& h5
->vnd
->open
)
243 set_bit(HCI_UART_INIT_PENDING
, &hu
->hdev_flags
);
245 /* Send initial sync request */
246 h5_link_control(hu
, sync
, sizeof(sync
));
247 mod_timer(&h5
->timer
, jiffies
+ H5_SYNC_TIMEOUT
);
252 static int h5_close(struct hci_uart
*hu
)
254 struct h5
*h5
= hu
->priv
;
256 del_timer_sync(&h5
->timer
);
258 skb_queue_purge(&h5
->unack
);
259 skb_queue_purge(&h5
->rel
);
260 skb_queue_purge(&h5
->unrel
);
262 kfree_skb(h5
->rx_skb
);
265 if (h5
->vnd
&& h5
->vnd
->close
)
274 static int h5_setup(struct hci_uart
*hu
)
276 struct h5
*h5
= hu
->priv
;
278 if (h5
->vnd
&& h5
->vnd
->setup
)
279 return h5
->vnd
->setup(h5
);
284 static void h5_pkt_cull(struct h5
*h5
)
286 struct sk_buff
*skb
, *tmp
;
291 spin_lock_irqsave(&h5
->unack
.lock
, flags
);
293 to_remove
= skb_queue_len(&h5
->unack
);
299 while (to_remove
> 0) {
300 if (h5
->rx_ack
== seq
)
304 seq
= (seq
- 1) & 0x07;
307 if (seq
!= h5
->rx_ack
)
308 BT_ERR("Controller acked invalid packet");
311 skb_queue_walk_safe(&h5
->unack
, skb
, tmp
) {
312 if (i
++ >= to_remove
)
315 __skb_unlink(skb
, &h5
->unack
);
319 if (skb_queue_empty(&h5
->unack
))
320 del_timer(&h5
->timer
);
323 spin_unlock_irqrestore(&h5
->unack
.lock
, flags
);
326 static void h5_handle_internal_rx(struct hci_uart
*hu
)
328 struct h5
*h5
= hu
->priv
;
329 const unsigned char sync_req
[] = { 0x01, 0x7e };
330 const unsigned char sync_rsp
[] = { 0x02, 0x7d };
331 unsigned char conf_req
[3] = { 0x03, 0xfc };
332 const unsigned char conf_rsp
[] = { 0x04, 0x7b };
333 const unsigned char wakeup_req
[] = { 0x05, 0xfa };
334 const unsigned char woken_req
[] = { 0x06, 0xf9 };
335 const unsigned char sleep_req
[] = { 0x07, 0x78 };
336 const unsigned char *hdr
= h5
->rx_skb
->data
;
337 const unsigned char *data
= &h5
->rx_skb
->data
[4];
339 BT_DBG("%s", hu
->hdev
->name
);
341 if (H5_HDR_PKT_TYPE(hdr
) != HCI_3WIRE_LINK_PKT
)
344 if (H5_HDR_LEN(hdr
) < 2)
347 conf_req
[2] = h5_cfg_field(h5
);
349 if (memcmp(data
, sync_req
, 2) == 0) {
350 if (h5
->state
== H5_ACTIVE
)
352 h5_link_control(hu
, sync_rsp
, 2);
353 } else if (memcmp(data
, sync_rsp
, 2) == 0) {
354 if (h5
->state
== H5_ACTIVE
)
356 h5
->state
= H5_INITIALIZED
;
357 h5_link_control(hu
, conf_req
, 3);
358 } else if (memcmp(data
, conf_req
, 2) == 0) {
359 h5_link_control(hu
, conf_rsp
, 2);
360 h5_link_control(hu
, conf_req
, 3);
361 } else if (memcmp(data
, conf_rsp
, 2) == 0) {
362 if (H5_HDR_LEN(hdr
) > 2)
363 h5
->tx_win
= (data
[2] & 0x07);
364 BT_DBG("Three-wire init complete. tx_win %u", h5
->tx_win
);
365 h5
->state
= H5_ACTIVE
;
366 hci_uart_init_ready(hu
);
368 } else if (memcmp(data
, sleep_req
, 2) == 0) {
369 BT_DBG("Peer went to sleep");
370 h5
->sleep
= H5_SLEEPING
;
372 } else if (memcmp(data
, woken_req
, 2) == 0) {
373 BT_DBG("Peer woke up");
374 h5
->sleep
= H5_AWAKE
;
375 } else if (memcmp(data
, wakeup_req
, 2) == 0) {
376 BT_DBG("Peer requested wakeup");
377 h5_link_control(hu
, woken_req
, 2);
378 h5
->sleep
= H5_AWAKE
;
380 BT_DBG("Link Control: 0x%02hhx 0x%02hhx", data
[0], data
[1]);
384 hci_uart_tx_wakeup(hu
);
387 static void h5_complete_rx_pkt(struct hci_uart
*hu
)
389 struct h5
*h5
= hu
->priv
;
390 const unsigned char *hdr
= h5
->rx_skb
->data
;
392 if (H5_HDR_RELIABLE(hdr
)) {
393 h5
->tx_ack
= (h5
->tx_ack
+ 1) % 8;
394 set_bit(H5_TX_ACK_REQ
, &h5
->flags
);
395 hci_uart_tx_wakeup(hu
);
398 h5
->rx_ack
= H5_HDR_ACK(hdr
);
402 switch (H5_HDR_PKT_TYPE(hdr
)) {
404 case HCI_ACLDATA_PKT
:
405 case HCI_SCODATA_PKT
:
406 case HCI_ISODATA_PKT
:
407 hci_skb_pkt_type(h5
->rx_skb
) = H5_HDR_PKT_TYPE(hdr
);
409 /* Remove Three-wire header */
410 skb_pull(h5
->rx_skb
, 4);
412 hci_recv_frame(hu
->hdev
, h5
->rx_skb
);
418 h5_handle_internal_rx(hu
);
425 static int h5_rx_crc(struct hci_uart
*hu
, unsigned char c
)
427 h5_complete_rx_pkt(hu
);
432 static int h5_rx_payload(struct hci_uart
*hu
, unsigned char c
)
434 struct h5
*h5
= hu
->priv
;
435 const unsigned char *hdr
= h5
->rx_skb
->data
;
437 if (H5_HDR_CRC(hdr
)) {
438 h5
->rx_func
= h5_rx_crc
;
441 h5_complete_rx_pkt(hu
);
447 static int h5_rx_3wire_hdr(struct hci_uart
*hu
, unsigned char c
)
449 struct h5
*h5
= hu
->priv
;
450 const unsigned char *hdr
= h5
->rx_skb
->data
;
452 BT_DBG("%s rx: seq %u ack %u crc %u rel %u type %u len %u",
453 hu
->hdev
->name
, H5_HDR_SEQ(hdr
), H5_HDR_ACK(hdr
),
454 H5_HDR_CRC(hdr
), H5_HDR_RELIABLE(hdr
), H5_HDR_PKT_TYPE(hdr
),
457 if (((hdr
[0] + hdr
[1] + hdr
[2] + hdr
[3]) & 0xff) != 0xff) {
458 bt_dev_err(hu
->hdev
, "Invalid header checksum");
463 if (H5_HDR_RELIABLE(hdr
) && H5_HDR_SEQ(hdr
) != h5
->tx_ack
) {
464 bt_dev_err(hu
->hdev
, "Out-of-order packet arrived (%u != %u)",
465 H5_HDR_SEQ(hdr
), h5
->tx_ack
);
470 if (h5
->state
!= H5_ACTIVE
&&
471 H5_HDR_PKT_TYPE(hdr
) != HCI_3WIRE_LINK_PKT
) {
472 bt_dev_err(hu
->hdev
, "Non-link packet received in non-active state");
477 h5
->rx_func
= h5_rx_payload
;
478 h5
->rx_pending
= H5_HDR_LEN(hdr
);
483 static int h5_rx_pkt_start(struct hci_uart
*hu
, unsigned char c
)
485 struct h5
*h5
= hu
->priv
;
487 if (c
== SLIP_DELIMITER
)
490 h5
->rx_func
= h5_rx_3wire_hdr
;
493 h5
->rx_skb
= bt_skb_alloc(H5_MAX_LEN
, GFP_ATOMIC
);
495 bt_dev_err(hu
->hdev
, "Can't allocate mem for new packet");
500 h5
->rx_skb
->dev
= (void *)hu
->hdev
;
505 static int h5_rx_delimiter(struct hci_uart
*hu
, unsigned char c
)
507 struct h5
*h5
= hu
->priv
;
509 if (c
== SLIP_DELIMITER
)
510 h5
->rx_func
= h5_rx_pkt_start
;
515 static void h5_unslip_one_byte(struct h5
*h5
, unsigned char c
)
517 const u8 delim
= SLIP_DELIMITER
, esc
= SLIP_ESC
;
520 if (!test_bit(H5_RX_ESC
, &h5
->flags
) && c
== SLIP_ESC
) {
521 set_bit(H5_RX_ESC
, &h5
->flags
);
525 if (test_and_clear_bit(H5_RX_ESC
, &h5
->flags
)) {
534 BT_ERR("Invalid esc byte 0x%02hhx", c
);
540 skb_put_data(h5
->rx_skb
, byte
, 1);
543 BT_DBG("unslipped 0x%02hhx, rx_pending %zu", *byte
, h5
->rx_pending
);
546 static void h5_reset_rx(struct h5
*h5
)
549 kfree_skb(h5
->rx_skb
);
553 h5
->rx_func
= h5_rx_delimiter
;
555 clear_bit(H5_RX_ESC
, &h5
->flags
);
558 static int h5_recv(struct hci_uart
*hu
, const void *data
, int count
)
560 struct h5
*h5
= hu
->priv
;
561 const unsigned char *ptr
= data
;
563 BT_DBG("%s pending %zu count %d", hu
->hdev
->name
, h5
->rx_pending
,
569 if (h5
->rx_pending
> 0) {
570 if (*ptr
== SLIP_DELIMITER
) {
571 bt_dev_err(hu
->hdev
, "Too short H5 packet");
576 h5_unslip_one_byte(h5
, *ptr
);
582 processed
= h5
->rx_func(hu
, *ptr
);
591 pm_runtime_get(&hu
->serdev
->dev
);
592 pm_runtime_mark_last_busy(&hu
->serdev
->dev
);
593 pm_runtime_put_autosuspend(&hu
->serdev
->dev
);
599 static int h5_enqueue(struct hci_uart
*hu
, struct sk_buff
*skb
)
601 struct h5
*h5
= hu
->priv
;
603 if (skb
->len
> 0xfff) {
604 bt_dev_err(hu
->hdev
, "Packet too long (%u bytes)", skb
->len
);
609 if (h5
->state
!= H5_ACTIVE
) {
610 bt_dev_err(hu
->hdev
, "Ignoring HCI data in non-active state");
615 switch (hci_skb_pkt_type(skb
)) {
616 case HCI_ACLDATA_PKT
:
617 case HCI_COMMAND_PKT
:
618 skb_queue_tail(&h5
->rel
, skb
);
621 case HCI_SCODATA_PKT
:
622 case HCI_ISODATA_PKT
:
623 skb_queue_tail(&h5
->unrel
, skb
);
627 bt_dev_err(hu
->hdev
, "Unknown packet type %u", hci_skb_pkt_type(skb
));
633 pm_runtime_get_sync(&hu
->serdev
->dev
);
634 pm_runtime_mark_last_busy(&hu
->serdev
->dev
);
635 pm_runtime_put_autosuspend(&hu
->serdev
->dev
);
641 static void h5_slip_delim(struct sk_buff
*skb
)
643 const char delim
= SLIP_DELIMITER
;
645 skb_put_data(skb
, &delim
, 1);
648 static void h5_slip_one_byte(struct sk_buff
*skb
, u8 c
)
650 const char esc_delim
[2] = { SLIP_ESC
, SLIP_ESC_DELIM
};
651 const char esc_esc
[2] = { SLIP_ESC
, SLIP_ESC_ESC
};
655 skb_put_data(skb
, &esc_delim
, 2);
658 skb_put_data(skb
, &esc_esc
, 2);
661 skb_put_data(skb
, &c
, 1);
665 static bool valid_packet_type(u8 type
)
668 case HCI_ACLDATA_PKT
:
669 case HCI_COMMAND_PKT
:
670 case HCI_SCODATA_PKT
:
671 case HCI_ISODATA_PKT
:
672 case HCI_3WIRE_LINK_PKT
:
673 case HCI_3WIRE_ACK_PKT
:
680 static struct sk_buff
*h5_prepare_pkt(struct hci_uart
*hu
, u8 pkt_type
,
681 const u8
*data
, size_t len
)
683 struct h5
*h5
= hu
->priv
;
684 struct sk_buff
*nskb
;
688 if (!valid_packet_type(pkt_type
)) {
689 bt_dev_err(hu
->hdev
, "Unknown packet type %u", pkt_type
);
694 * Max len of packet: (original len + 4 (H5 hdr) + 2 (crc)) * 2
695 * (because bytes 0xc0 and 0xdb are escaped, worst case is when
696 * the packet is all made of 0xc0 and 0xdb) + 2 (0xc0
697 * delimiters at start and end).
699 nskb
= alloc_skb((len
+ 6) * 2 + 2, GFP_ATOMIC
);
703 hci_skb_pkt_type(nskb
) = pkt_type
;
707 hdr
[0] = h5
->tx_ack
<< 3;
708 clear_bit(H5_TX_ACK_REQ
, &h5
->flags
);
710 /* Reliable packet? */
711 if (pkt_type
== HCI_ACLDATA_PKT
|| pkt_type
== HCI_COMMAND_PKT
) {
713 hdr
[0] |= h5
->tx_seq
;
714 h5
->tx_seq
= (h5
->tx_seq
+ 1) % 8;
717 hdr
[1] = pkt_type
| ((len
& 0x0f) << 4);
719 hdr
[3] = ~((hdr
[0] + hdr
[1] + hdr
[2]) & 0xff);
721 BT_DBG("%s tx: seq %u ack %u crc %u rel %u type %u len %u",
722 hu
->hdev
->name
, H5_HDR_SEQ(hdr
), H5_HDR_ACK(hdr
),
723 H5_HDR_CRC(hdr
), H5_HDR_RELIABLE(hdr
), H5_HDR_PKT_TYPE(hdr
),
726 for (i
= 0; i
< 4; i
++)
727 h5_slip_one_byte(nskb
, hdr
[i
]);
729 for (i
= 0; i
< len
; i
++)
730 h5_slip_one_byte(nskb
, data
[i
]);
737 static struct sk_buff
*h5_dequeue(struct hci_uart
*hu
)
739 struct h5
*h5
= hu
->priv
;
741 struct sk_buff
*skb
, *nskb
;
743 if (h5
->sleep
!= H5_AWAKE
) {
744 const unsigned char wakeup_req
[] = { 0x05, 0xfa };
746 if (h5
->sleep
== H5_WAKING_UP
)
749 h5
->sleep
= H5_WAKING_UP
;
750 BT_DBG("Sending wakeup request");
752 mod_timer(&h5
->timer
, jiffies
+ HZ
/ 100);
753 return h5_prepare_pkt(hu
, HCI_3WIRE_LINK_PKT
, wakeup_req
, 2);
756 skb
= skb_dequeue(&h5
->unrel
);
758 nskb
= h5_prepare_pkt(hu
, hci_skb_pkt_type(skb
),
759 skb
->data
, skb
->len
);
765 skb_queue_head(&h5
->unrel
, skb
);
766 bt_dev_err(hu
->hdev
, "Could not dequeue pkt because alloc_skb failed");
769 spin_lock_irqsave_nested(&h5
->unack
.lock
, flags
, SINGLE_DEPTH_NESTING
);
771 if (h5
->unack
.qlen
>= h5
->tx_win
)
774 skb
= skb_dequeue(&h5
->rel
);
776 nskb
= h5_prepare_pkt(hu
, hci_skb_pkt_type(skb
),
777 skb
->data
, skb
->len
);
779 __skb_queue_tail(&h5
->unack
, skb
);
780 mod_timer(&h5
->timer
, jiffies
+ H5_ACK_TIMEOUT
);
781 spin_unlock_irqrestore(&h5
->unack
.lock
, flags
);
785 skb_queue_head(&h5
->rel
, skb
);
786 bt_dev_err(hu
->hdev
, "Could not dequeue pkt because alloc_skb failed");
790 spin_unlock_irqrestore(&h5
->unack
.lock
, flags
);
792 if (test_bit(H5_TX_ACK_REQ
, &h5
->flags
))
793 return h5_prepare_pkt(hu
, HCI_3WIRE_ACK_PKT
, NULL
, 0);
798 static int h5_flush(struct hci_uart
*hu
)
804 static const struct hci_uart_proto h5p
= {
805 .id
= HCI_UART_3WIRE
,
806 .name
= "Three-wire (H5)",
811 .enqueue
= h5_enqueue
,
812 .dequeue
= h5_dequeue
,
816 static int h5_serdev_probe(struct serdev_device
*serdev
)
818 struct device
*dev
= &serdev
->dev
;
820 const struct h5_device_data
*data
;
823 h5
= devm_kzalloc(dev
, sizeof(*h5
), GFP_KERNEL
);
827 h5
->hu
= &h5
->serdev_hu
;
828 h5
->serdev_hu
.serdev
= serdev
;
829 serdev_device_set_drvdata(serdev
, h5
);
831 if (has_acpi_companion(dev
)) {
832 const struct acpi_device_id
*match
;
834 match
= acpi_match_device(dev
->driver
->acpi_match_table
, dev
);
838 data
= (const struct h5_device_data
*)match
->driver_data
;
840 h5
->id
= (char *)match
->id
;
842 if (h5
->vnd
->acpi_gpio_map
)
843 devm_acpi_dev_add_driver_gpios(dev
,
844 h5
->vnd
->acpi_gpio_map
);
846 data
= of_device_get_match_data(dev
);
853 if (data
->driver_info
& H5_INFO_WAKEUP_DISABLE
)
854 set_bit(H5_WAKEUP_DISABLE
, &h5
->flags
);
856 h5
->enable_gpio
= devm_gpiod_get_optional(dev
, "enable", GPIOD_OUT_LOW
);
857 if (IS_ERR(h5
->enable_gpio
))
858 return PTR_ERR(h5
->enable_gpio
);
860 h5
->device_wake_gpio
= devm_gpiod_get_optional(dev
, "device-wake",
862 if (IS_ERR(h5
->device_wake_gpio
))
863 return PTR_ERR(h5
->device_wake_gpio
);
865 err
= hci_uart_register_device(&h5
->serdev_hu
, &h5p
);
872 static void h5_serdev_remove(struct serdev_device
*serdev
)
874 struct h5
*h5
= serdev_device_get_drvdata(serdev
);
876 hci_uart_unregister_device(&h5
->serdev_hu
);
879 static int __maybe_unused
h5_serdev_suspend(struct device
*dev
)
881 struct h5
*h5
= dev_get_drvdata(dev
);
884 if (h5
->vnd
&& h5
->vnd
->suspend
)
885 ret
= h5
->vnd
->suspend(h5
);
890 static int __maybe_unused
h5_serdev_resume(struct device
*dev
)
892 struct h5
*h5
= dev_get_drvdata(dev
);
895 if (h5
->vnd
&& h5
->vnd
->resume
)
896 ret
= h5
->vnd
->resume(h5
);
901 #ifdef CONFIG_BT_HCIUART_RTL
902 static int h5_btrtl_setup(struct h5
*h5
)
904 struct btrtl_device_info
*btrtl_dev
;
906 __le32 baudrate_data
;
908 unsigned int controller_baudrate
;
912 btrtl_dev
= btrtl_initialize(h5
->hu
->hdev
, h5
->id
);
913 if (IS_ERR(btrtl_dev
))
914 return PTR_ERR(btrtl_dev
);
916 err
= btrtl_get_uart_settings(h5
->hu
->hdev
, btrtl_dev
,
917 &controller_baudrate
, &device_baudrate
,
922 baudrate_data
= cpu_to_le32(device_baudrate
);
923 skb
= __hci_cmd_sync(h5
->hu
->hdev
, 0xfc17, sizeof(baudrate_data
),
924 &baudrate_data
, HCI_INIT_TIMEOUT
);
926 rtl_dev_err(h5
->hu
->hdev
, "set baud rate command failed\n");
932 /* Give the device some time to set up the new baudrate. */
933 usleep_range(10000, 20000);
935 serdev_device_set_baudrate(h5
->hu
->serdev
, controller_baudrate
);
936 serdev_device_set_flow_control(h5
->hu
->serdev
, flow_control
);
939 set_bit(H5_HW_FLOW_CONTROL
, &h5
->flags
);
941 err
= btrtl_download_firmware(h5
->hu
->hdev
, btrtl_dev
);
942 /* Give the device some time before the hci-core sends it a reset */
943 usleep_range(10000, 20000);
945 btrtl_set_quirks(h5
->hu
->hdev
, btrtl_dev
);
948 btrtl_free(btrtl_dev
);
953 static void h5_btrtl_open(struct h5
*h5
)
956 * Since h5_btrtl_resume() does a device_reprobe() the suspend handling
957 * done by the hci_suspend_notifier is not necessary; it actually causes
958 * delays and a bunch of errors to get logged, so disable it.
960 if (test_bit(H5_WAKEUP_DISABLE
, &h5
->flags
))
961 set_bit(HCI_UART_NO_SUSPEND_NOTIFIER
, &h5
->hu
->flags
);
963 /* Devices always start with these fixed parameters */
964 serdev_device_set_flow_control(h5
->hu
->serdev
, false);
965 serdev_device_set_parity(h5
->hu
->serdev
, SERDEV_PARITY_EVEN
);
966 serdev_device_set_baudrate(h5
->hu
->serdev
, 115200);
968 if (!test_bit(H5_WAKEUP_DISABLE
, &h5
->flags
)) {
969 pm_runtime_set_active(&h5
->hu
->serdev
->dev
);
970 pm_runtime_use_autosuspend(&h5
->hu
->serdev
->dev
);
971 pm_runtime_set_autosuspend_delay(&h5
->hu
->serdev
->dev
,
973 pm_runtime_enable(&h5
->hu
->serdev
->dev
);
976 /* The controller needs up to 500ms to wakeup */
977 gpiod_set_value_cansleep(h5
->enable_gpio
, 1);
978 gpiod_set_value_cansleep(h5
->device_wake_gpio
, 1);
982 static void h5_btrtl_close(struct h5
*h5
)
984 if (!test_bit(H5_WAKEUP_DISABLE
, &h5
->flags
))
985 pm_runtime_disable(&h5
->hu
->serdev
->dev
);
987 gpiod_set_value_cansleep(h5
->device_wake_gpio
, 0);
988 gpiod_set_value_cansleep(h5
->enable_gpio
, 0);
991 /* Suspend/resume support. On many devices the RTL BT device loses power during
992 * suspend/resume, causing it to lose its firmware and all state. So we simply
993 * turn it off on suspend and reprobe on resume. This mirrors how RTL devices
994 * are handled in the USB driver, where the BTUSB_WAKEUP_DISABLE is used which
995 * also causes a reprobe on resume.
997 static int h5_btrtl_suspend(struct h5
*h5
)
999 serdev_device_set_flow_control(h5
->hu
->serdev
, false);
1000 gpiod_set_value_cansleep(h5
->device_wake_gpio
, 0);
1002 if (test_bit(H5_WAKEUP_DISABLE
, &h5
->flags
))
1003 gpiod_set_value_cansleep(h5
->enable_gpio
, 0);
1008 struct h5_btrtl_reprobe
{
1010 struct work_struct work
;
1013 static void h5_btrtl_reprobe_worker(struct work_struct
*work
)
1015 struct h5_btrtl_reprobe
*reprobe
=
1016 container_of(work
, struct h5_btrtl_reprobe
, work
);
1019 ret
= device_reprobe(reprobe
->dev
);
1020 if (ret
&& ret
!= -EPROBE_DEFER
)
1021 dev_err(reprobe
->dev
, "Reprobe error %d\n", ret
);
1023 put_device(reprobe
->dev
);
1025 module_put(THIS_MODULE
);
1028 static int h5_btrtl_resume(struct h5
*h5
)
1030 if (test_bit(H5_WAKEUP_DISABLE
, &h5
->flags
)) {
1031 struct h5_btrtl_reprobe
*reprobe
;
1033 reprobe
= kzalloc(sizeof(*reprobe
), GFP_KERNEL
);
1037 __module_get(THIS_MODULE
);
1039 INIT_WORK(&reprobe
->work
, h5_btrtl_reprobe_worker
);
1040 reprobe
->dev
= get_device(&h5
->hu
->serdev
->dev
);
1041 queue_work(system_long_wq
, &reprobe
->work
);
1043 gpiod_set_value_cansleep(h5
->device_wake_gpio
, 1);
1045 if (test_bit(H5_HW_FLOW_CONTROL
, &h5
->flags
))
1046 serdev_device_set_flow_control(h5
->hu
->serdev
, true);
1052 static const struct acpi_gpio_params btrtl_device_wake_gpios
= { 0, 0, false };
1053 static const struct acpi_gpio_params btrtl_enable_gpios
= { 1, 0, false };
1054 static const struct acpi_gpio_params btrtl_host_wake_gpios
= { 2, 0, false };
1055 static const struct acpi_gpio_mapping acpi_btrtl_gpios
[] = {
1056 { "device-wake-gpios", &btrtl_device_wake_gpios
, 1 },
1057 { "enable-gpios", &btrtl_enable_gpios
, 1 },
1058 { "host-wake-gpios", &btrtl_host_wake_gpios
, 1 },
1062 static struct h5_vnd rtl_vnd
= {
1063 .setup
= h5_btrtl_setup
,
1064 .open
= h5_btrtl_open
,
1065 .close
= h5_btrtl_close
,
1066 .suspend
= h5_btrtl_suspend
,
1067 .resume
= h5_btrtl_resume
,
1068 .acpi_gpio_map
= acpi_btrtl_gpios
,
1071 static const struct h5_device_data h5_data_rtl8822cs
= {
1075 static const struct h5_device_data h5_data_rtl8723bs
= {
1076 .driver_info
= H5_INFO_WAKEUP_DISABLE
,
1082 static const struct acpi_device_id h5_acpi_match
[] = {
1083 #ifdef CONFIG_BT_HCIUART_RTL
1084 { "OBDA0623", (kernel_ulong_t
)&h5_data_rtl8723bs
},
1085 { "OBDA8723", (kernel_ulong_t
)&h5_data_rtl8723bs
},
1089 MODULE_DEVICE_TABLE(acpi
, h5_acpi_match
);
1092 static const struct dev_pm_ops h5_serdev_pm_ops
= {
1093 SET_SYSTEM_SLEEP_PM_OPS(h5_serdev_suspend
, h5_serdev_resume
)
1094 SET_RUNTIME_PM_OPS(h5_serdev_suspend
, h5_serdev_resume
, NULL
)
1097 static const struct of_device_id rtl_bluetooth_of_match
[] = {
1098 #ifdef CONFIG_BT_HCIUART_RTL
1099 { .compatible
= "realtek,rtl8822cs-bt",
1100 .data
= (const void *)&h5_data_rtl8822cs
},
1101 { .compatible
= "realtek,rtl8723bs-bt",
1102 .data
= (const void *)&h5_data_rtl8723bs
},
1103 { .compatible
= "realtek,rtl8723ds-bt",
1104 .data
= (const void *)&h5_data_rtl8723bs
},
1108 MODULE_DEVICE_TABLE(of
, rtl_bluetooth_of_match
);
1110 static struct serdev_device_driver h5_serdev_driver
= {
1111 .probe
= h5_serdev_probe
,
1112 .remove
= h5_serdev_remove
,
1114 .name
= "hci_uart_h5",
1115 .acpi_match_table
= ACPI_PTR(h5_acpi_match
),
1116 .pm
= &h5_serdev_pm_ops
,
1117 .of_match_table
= rtl_bluetooth_of_match
,
1121 int __init
h5_init(void)
1123 serdev_device_driver_register(&h5_serdev_driver
);
1124 return hci_uart_register_proto(&h5p
);
1127 int __exit
h5_deinit(void)
1129 serdev_device_driver_unregister(&h5_serdev_driver
);
1130 return hci_uart_unregister_proto(&h5p
);