Merge tag 'trace-v5.11-rc2' of git://git.kernel.org/pub/scm/linux/kernel/git/rostedt...
[linux/fpc-iii.git] / drivers / bluetooth / hci_h5.c
blob7be16a7f653bd07d9a99238afdb1dbe8de01e94a
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
4 * Bluetooth HCI Three-wire UART driver
6 * Copyright (C) 2012 Intel Corporation
7 */
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/serdev.h>
16 #include <linux/skbuff.h>
18 #include <net/bluetooth/bluetooth.h>
19 #include <net/bluetooth/hci_core.h>
21 #include "btrtl.h"
22 #include "hci_uart.h"
24 #define HCI_3WIRE_ACK_PKT 0
25 #define HCI_3WIRE_LINK_PKT 15
27 /* Sliding window size */
28 #define H5_TX_WIN_MAX 4
30 #define H5_ACK_TIMEOUT msecs_to_jiffies(250)
31 #define H5_SYNC_TIMEOUT msecs_to_jiffies(100)
34 * Maximum Three-wire packet:
35 * 4 byte header + max value for 12-bit length + 2 bytes for CRC
37 #define H5_MAX_LEN (4 + 0xfff + 2)
39 /* Convenience macros for reading Three-wire header values */
40 #define H5_HDR_SEQ(hdr) ((hdr)[0] & 0x07)
41 #define H5_HDR_ACK(hdr) (((hdr)[0] >> 3) & 0x07)
42 #define H5_HDR_CRC(hdr) (((hdr)[0] >> 6) & 0x01)
43 #define H5_HDR_RELIABLE(hdr) (((hdr)[0] >> 7) & 0x01)
44 #define H5_HDR_PKT_TYPE(hdr) ((hdr)[1] & 0x0f)
45 #define H5_HDR_LEN(hdr) ((((hdr)[1] >> 4) & 0x0f) + ((hdr)[2] << 4))
47 #define SLIP_DELIMITER 0xc0
48 #define SLIP_ESC 0xdb
49 #define SLIP_ESC_DELIM 0xdc
50 #define SLIP_ESC_ESC 0xdd
52 /* H5 state flags */
53 enum {
54 H5_RX_ESC, /* SLIP escape mode */
55 H5_TX_ACK_REQ, /* Pending ack to send */
58 struct h5 {
59 /* Must be the first member, hci_serdev.c expects this. */
60 struct hci_uart serdev_hu;
62 struct sk_buff_head unack; /* Unack'ed packets queue */
63 struct sk_buff_head rel; /* Reliable packets queue */
64 struct sk_buff_head unrel; /* Unreliable packets queue */
66 unsigned long flags;
68 struct sk_buff *rx_skb; /* Receive buffer */
69 size_t rx_pending; /* Expecting more bytes */
70 u8 rx_ack; /* Last ack number received */
72 int (*rx_func)(struct hci_uart *hu, u8 c);
74 struct timer_list timer; /* Retransmission timer */
75 struct hci_uart *hu; /* Parent HCI UART */
77 u8 tx_seq; /* Next seq number to send */
78 u8 tx_ack; /* Next ack number to send */
79 u8 tx_win; /* Sliding window size */
81 enum {
82 H5_UNINITIALIZED,
83 H5_INITIALIZED,
84 H5_ACTIVE,
85 } state;
87 enum {
88 H5_AWAKE,
89 H5_SLEEPING,
90 H5_WAKING_UP,
91 } sleep;
93 const struct h5_vnd *vnd;
94 const char *id;
96 struct gpio_desc *enable_gpio;
97 struct gpio_desc *device_wake_gpio;
100 struct h5_vnd {
101 int (*setup)(struct h5 *h5);
102 void (*open)(struct h5 *h5);
103 void (*close)(struct h5 *h5);
104 int (*suspend)(struct h5 *h5);
105 int (*resume)(struct h5 *h5);
106 const struct acpi_gpio_mapping *acpi_gpio_map;
109 static void h5_reset_rx(struct h5 *h5);
111 static void h5_link_control(struct hci_uart *hu, const void *data, size_t len)
113 struct h5 *h5 = hu->priv;
114 struct sk_buff *nskb;
116 nskb = alloc_skb(3, GFP_ATOMIC);
117 if (!nskb)
118 return;
120 hci_skb_pkt_type(nskb) = HCI_3WIRE_LINK_PKT;
122 skb_put_data(nskb, data, len);
124 skb_queue_tail(&h5->unrel, nskb);
127 static u8 h5_cfg_field(struct h5 *h5)
129 /* Sliding window size (first 3 bits) */
130 return h5->tx_win & 0x07;
133 static void h5_timed_event(struct timer_list *t)
135 const unsigned char sync_req[] = { 0x01, 0x7e };
136 unsigned char conf_req[3] = { 0x03, 0xfc };
137 struct h5 *h5 = from_timer(h5, t, timer);
138 struct hci_uart *hu = h5->hu;
139 struct sk_buff *skb;
140 unsigned long flags;
142 BT_DBG("%s", hu->hdev->name);
144 if (h5->state == H5_UNINITIALIZED)
145 h5_link_control(hu, sync_req, sizeof(sync_req));
147 if (h5->state == H5_INITIALIZED) {
148 conf_req[2] = h5_cfg_field(h5);
149 h5_link_control(hu, conf_req, sizeof(conf_req));
152 if (h5->state != H5_ACTIVE) {
153 mod_timer(&h5->timer, jiffies + H5_SYNC_TIMEOUT);
154 goto wakeup;
157 if (h5->sleep != H5_AWAKE) {
158 h5->sleep = H5_SLEEPING;
159 goto wakeup;
162 BT_DBG("hu %p retransmitting %u pkts", hu, h5->unack.qlen);
164 spin_lock_irqsave_nested(&h5->unack.lock, flags, SINGLE_DEPTH_NESTING);
166 while ((skb = __skb_dequeue_tail(&h5->unack)) != NULL) {
167 h5->tx_seq = (h5->tx_seq - 1) & 0x07;
168 skb_queue_head(&h5->rel, skb);
171 spin_unlock_irqrestore(&h5->unack.lock, flags);
173 wakeup:
174 hci_uart_tx_wakeup(hu);
177 static void h5_peer_reset(struct hci_uart *hu)
179 struct h5 *h5 = hu->priv;
181 bt_dev_err(hu->hdev, "Peer device has reset");
183 h5->state = H5_UNINITIALIZED;
185 del_timer(&h5->timer);
187 skb_queue_purge(&h5->rel);
188 skb_queue_purge(&h5->unrel);
189 skb_queue_purge(&h5->unack);
191 h5->tx_seq = 0;
192 h5->tx_ack = 0;
194 /* Send reset request to upper stack */
195 hci_reset_dev(hu->hdev);
198 static int h5_open(struct hci_uart *hu)
200 struct h5 *h5;
201 const unsigned char sync[] = { 0x01, 0x7e };
203 BT_DBG("hu %p", hu);
205 if (hu->serdev) {
206 h5 = serdev_device_get_drvdata(hu->serdev);
207 } else {
208 h5 = kzalloc(sizeof(*h5), GFP_KERNEL);
209 if (!h5)
210 return -ENOMEM;
213 hu->priv = h5;
214 h5->hu = hu;
216 skb_queue_head_init(&h5->unack);
217 skb_queue_head_init(&h5->rel);
218 skb_queue_head_init(&h5->unrel);
220 h5_reset_rx(h5);
222 timer_setup(&h5->timer, h5_timed_event, 0);
224 h5->tx_win = H5_TX_WIN_MAX;
226 if (h5->vnd && h5->vnd->open)
227 h5->vnd->open(h5);
229 set_bit(HCI_UART_INIT_PENDING, &hu->hdev_flags);
231 /* Send initial sync request */
232 h5_link_control(hu, sync, sizeof(sync));
233 mod_timer(&h5->timer, jiffies + H5_SYNC_TIMEOUT);
235 return 0;
238 static int h5_close(struct hci_uart *hu)
240 struct h5 *h5 = hu->priv;
242 del_timer_sync(&h5->timer);
244 skb_queue_purge(&h5->unack);
245 skb_queue_purge(&h5->rel);
246 skb_queue_purge(&h5->unrel);
248 kfree_skb(h5->rx_skb);
249 h5->rx_skb = NULL;
251 if (h5->vnd && h5->vnd->close)
252 h5->vnd->close(h5);
254 if (!hu->serdev)
255 kfree(h5);
257 return 0;
260 static int h5_setup(struct hci_uart *hu)
262 struct h5 *h5 = hu->priv;
264 if (h5->vnd && h5->vnd->setup)
265 return h5->vnd->setup(h5);
267 return 0;
270 static void h5_pkt_cull(struct h5 *h5)
272 struct sk_buff *skb, *tmp;
273 unsigned long flags;
274 int i, to_remove;
275 u8 seq;
277 spin_lock_irqsave(&h5->unack.lock, flags);
279 to_remove = skb_queue_len(&h5->unack);
280 if (to_remove == 0)
281 goto unlock;
283 seq = h5->tx_seq;
285 while (to_remove > 0) {
286 if (h5->rx_ack == seq)
287 break;
289 to_remove--;
290 seq = (seq - 1) & 0x07;
293 if (seq != h5->rx_ack)
294 BT_ERR("Controller acked invalid packet");
296 i = 0;
297 skb_queue_walk_safe(&h5->unack, skb, tmp) {
298 if (i++ >= to_remove)
299 break;
301 __skb_unlink(skb, &h5->unack);
302 kfree_skb(skb);
305 if (skb_queue_empty(&h5->unack))
306 del_timer(&h5->timer);
308 unlock:
309 spin_unlock_irqrestore(&h5->unack.lock, flags);
312 static void h5_handle_internal_rx(struct hci_uart *hu)
314 struct h5 *h5 = hu->priv;
315 const unsigned char sync_req[] = { 0x01, 0x7e };
316 const unsigned char sync_rsp[] = { 0x02, 0x7d };
317 unsigned char conf_req[3] = { 0x03, 0xfc };
318 const unsigned char conf_rsp[] = { 0x04, 0x7b };
319 const unsigned char wakeup_req[] = { 0x05, 0xfa };
320 const unsigned char woken_req[] = { 0x06, 0xf9 };
321 const unsigned char sleep_req[] = { 0x07, 0x78 };
322 const unsigned char *hdr = h5->rx_skb->data;
323 const unsigned char *data = &h5->rx_skb->data[4];
325 BT_DBG("%s", hu->hdev->name);
327 if (H5_HDR_PKT_TYPE(hdr) != HCI_3WIRE_LINK_PKT)
328 return;
330 if (H5_HDR_LEN(hdr) < 2)
331 return;
333 conf_req[2] = h5_cfg_field(h5);
335 if (memcmp(data, sync_req, 2) == 0) {
336 if (h5->state == H5_ACTIVE)
337 h5_peer_reset(hu);
338 h5_link_control(hu, sync_rsp, 2);
339 } else if (memcmp(data, sync_rsp, 2) == 0) {
340 if (h5->state == H5_ACTIVE)
341 h5_peer_reset(hu);
342 h5->state = H5_INITIALIZED;
343 h5_link_control(hu, conf_req, 3);
344 } else if (memcmp(data, conf_req, 2) == 0) {
345 h5_link_control(hu, conf_rsp, 2);
346 h5_link_control(hu, conf_req, 3);
347 } else if (memcmp(data, conf_rsp, 2) == 0) {
348 if (H5_HDR_LEN(hdr) > 2)
349 h5->tx_win = (data[2] & 0x07);
350 BT_DBG("Three-wire init complete. tx_win %u", h5->tx_win);
351 h5->state = H5_ACTIVE;
352 hci_uart_init_ready(hu);
353 return;
354 } else if (memcmp(data, sleep_req, 2) == 0) {
355 BT_DBG("Peer went to sleep");
356 h5->sleep = H5_SLEEPING;
357 return;
358 } else if (memcmp(data, woken_req, 2) == 0) {
359 BT_DBG("Peer woke up");
360 h5->sleep = H5_AWAKE;
361 } else if (memcmp(data, wakeup_req, 2) == 0) {
362 BT_DBG("Peer requested wakeup");
363 h5_link_control(hu, woken_req, 2);
364 h5->sleep = H5_AWAKE;
365 } else {
366 BT_DBG("Link Control: 0x%02hhx 0x%02hhx", data[0], data[1]);
367 return;
370 hci_uart_tx_wakeup(hu);
373 static void h5_complete_rx_pkt(struct hci_uart *hu)
375 struct h5 *h5 = hu->priv;
376 const unsigned char *hdr = h5->rx_skb->data;
378 if (H5_HDR_RELIABLE(hdr)) {
379 h5->tx_ack = (h5->tx_ack + 1) % 8;
380 set_bit(H5_TX_ACK_REQ, &h5->flags);
381 hci_uart_tx_wakeup(hu);
384 h5->rx_ack = H5_HDR_ACK(hdr);
386 h5_pkt_cull(h5);
388 switch (H5_HDR_PKT_TYPE(hdr)) {
389 case HCI_EVENT_PKT:
390 case HCI_ACLDATA_PKT:
391 case HCI_SCODATA_PKT:
392 case HCI_ISODATA_PKT:
393 hci_skb_pkt_type(h5->rx_skb) = H5_HDR_PKT_TYPE(hdr);
395 /* Remove Three-wire header */
396 skb_pull(h5->rx_skb, 4);
398 hci_recv_frame(hu->hdev, h5->rx_skb);
399 h5->rx_skb = NULL;
401 break;
403 default:
404 h5_handle_internal_rx(hu);
405 break;
408 h5_reset_rx(h5);
411 static int h5_rx_crc(struct hci_uart *hu, unsigned char c)
413 h5_complete_rx_pkt(hu);
415 return 0;
418 static int h5_rx_payload(struct hci_uart *hu, unsigned char c)
420 struct h5 *h5 = hu->priv;
421 const unsigned char *hdr = h5->rx_skb->data;
423 if (H5_HDR_CRC(hdr)) {
424 h5->rx_func = h5_rx_crc;
425 h5->rx_pending = 2;
426 } else {
427 h5_complete_rx_pkt(hu);
430 return 0;
433 static int h5_rx_3wire_hdr(struct hci_uart *hu, unsigned char c)
435 struct h5 *h5 = hu->priv;
436 const unsigned char *hdr = h5->rx_skb->data;
438 BT_DBG("%s rx: seq %u ack %u crc %u rel %u type %u len %u",
439 hu->hdev->name, H5_HDR_SEQ(hdr), H5_HDR_ACK(hdr),
440 H5_HDR_CRC(hdr), H5_HDR_RELIABLE(hdr), H5_HDR_PKT_TYPE(hdr),
441 H5_HDR_LEN(hdr));
443 if (((hdr[0] + hdr[1] + hdr[2] + hdr[3]) & 0xff) != 0xff) {
444 bt_dev_err(hu->hdev, "Invalid header checksum");
445 h5_reset_rx(h5);
446 return 0;
449 if (H5_HDR_RELIABLE(hdr) && H5_HDR_SEQ(hdr) != h5->tx_ack) {
450 bt_dev_err(hu->hdev, "Out-of-order packet arrived (%u != %u)",
451 H5_HDR_SEQ(hdr), h5->tx_ack);
452 h5_reset_rx(h5);
453 return 0;
456 if (h5->state != H5_ACTIVE &&
457 H5_HDR_PKT_TYPE(hdr) != HCI_3WIRE_LINK_PKT) {
458 bt_dev_err(hu->hdev, "Non-link packet received in non-active state");
459 h5_reset_rx(h5);
460 return 0;
463 h5->rx_func = h5_rx_payload;
464 h5->rx_pending = H5_HDR_LEN(hdr);
466 return 0;
469 static int h5_rx_pkt_start(struct hci_uart *hu, unsigned char c)
471 struct h5 *h5 = hu->priv;
473 if (c == SLIP_DELIMITER)
474 return 1;
476 h5->rx_func = h5_rx_3wire_hdr;
477 h5->rx_pending = 4;
479 h5->rx_skb = bt_skb_alloc(H5_MAX_LEN, GFP_ATOMIC);
480 if (!h5->rx_skb) {
481 bt_dev_err(hu->hdev, "Can't allocate mem for new packet");
482 h5_reset_rx(h5);
483 return -ENOMEM;
486 h5->rx_skb->dev = (void *)hu->hdev;
488 return 0;
491 static int h5_rx_delimiter(struct hci_uart *hu, unsigned char c)
493 struct h5 *h5 = hu->priv;
495 if (c == SLIP_DELIMITER)
496 h5->rx_func = h5_rx_pkt_start;
498 return 1;
501 static void h5_unslip_one_byte(struct h5 *h5, unsigned char c)
503 const u8 delim = SLIP_DELIMITER, esc = SLIP_ESC;
504 const u8 *byte = &c;
506 if (!test_bit(H5_RX_ESC, &h5->flags) && c == SLIP_ESC) {
507 set_bit(H5_RX_ESC, &h5->flags);
508 return;
511 if (test_and_clear_bit(H5_RX_ESC, &h5->flags)) {
512 switch (c) {
513 case SLIP_ESC_DELIM:
514 byte = &delim;
515 break;
516 case SLIP_ESC_ESC:
517 byte = &esc;
518 break;
519 default:
520 BT_ERR("Invalid esc byte 0x%02hhx", c);
521 h5_reset_rx(h5);
522 return;
526 skb_put_data(h5->rx_skb, byte, 1);
527 h5->rx_pending--;
529 BT_DBG("unslipped 0x%02hhx, rx_pending %zu", *byte, h5->rx_pending);
532 static void h5_reset_rx(struct h5 *h5)
534 if (h5->rx_skb) {
535 kfree_skb(h5->rx_skb);
536 h5->rx_skb = NULL;
539 h5->rx_func = h5_rx_delimiter;
540 h5->rx_pending = 0;
541 clear_bit(H5_RX_ESC, &h5->flags);
544 static int h5_recv(struct hci_uart *hu, const void *data, int count)
546 struct h5 *h5 = hu->priv;
547 const unsigned char *ptr = data;
549 BT_DBG("%s pending %zu count %d", hu->hdev->name, h5->rx_pending,
550 count);
552 while (count > 0) {
553 int processed;
555 if (h5->rx_pending > 0) {
556 if (*ptr == SLIP_DELIMITER) {
557 bt_dev_err(hu->hdev, "Too short H5 packet");
558 h5_reset_rx(h5);
559 continue;
562 h5_unslip_one_byte(h5, *ptr);
564 ptr++; count--;
565 continue;
568 processed = h5->rx_func(hu, *ptr);
569 if (processed < 0)
570 return processed;
572 ptr += processed;
573 count -= processed;
576 return 0;
579 static int h5_enqueue(struct hci_uart *hu, struct sk_buff *skb)
581 struct h5 *h5 = hu->priv;
583 if (skb->len > 0xfff) {
584 bt_dev_err(hu->hdev, "Packet too long (%u bytes)", skb->len);
585 kfree_skb(skb);
586 return 0;
589 if (h5->state != H5_ACTIVE) {
590 bt_dev_err(hu->hdev, "Ignoring HCI data in non-active state");
591 kfree_skb(skb);
592 return 0;
595 switch (hci_skb_pkt_type(skb)) {
596 case HCI_ACLDATA_PKT:
597 case HCI_COMMAND_PKT:
598 skb_queue_tail(&h5->rel, skb);
599 break;
601 case HCI_SCODATA_PKT:
602 case HCI_ISODATA_PKT:
603 skb_queue_tail(&h5->unrel, skb);
604 break;
606 default:
607 bt_dev_err(hu->hdev, "Unknown packet type %u", hci_skb_pkt_type(skb));
608 kfree_skb(skb);
609 break;
612 return 0;
615 static void h5_slip_delim(struct sk_buff *skb)
617 const char delim = SLIP_DELIMITER;
619 skb_put_data(skb, &delim, 1);
622 static void h5_slip_one_byte(struct sk_buff *skb, u8 c)
624 const char esc_delim[2] = { SLIP_ESC, SLIP_ESC_DELIM };
625 const char esc_esc[2] = { SLIP_ESC, SLIP_ESC_ESC };
627 switch (c) {
628 case SLIP_DELIMITER:
629 skb_put_data(skb, &esc_delim, 2);
630 break;
631 case SLIP_ESC:
632 skb_put_data(skb, &esc_esc, 2);
633 break;
634 default:
635 skb_put_data(skb, &c, 1);
639 static bool valid_packet_type(u8 type)
641 switch (type) {
642 case HCI_ACLDATA_PKT:
643 case HCI_COMMAND_PKT:
644 case HCI_SCODATA_PKT:
645 case HCI_ISODATA_PKT:
646 case HCI_3WIRE_LINK_PKT:
647 case HCI_3WIRE_ACK_PKT:
648 return true;
649 default:
650 return false;
654 static struct sk_buff *h5_prepare_pkt(struct hci_uart *hu, u8 pkt_type,
655 const u8 *data, size_t len)
657 struct h5 *h5 = hu->priv;
658 struct sk_buff *nskb;
659 u8 hdr[4];
660 int i;
662 if (!valid_packet_type(pkt_type)) {
663 bt_dev_err(hu->hdev, "Unknown packet type %u", pkt_type);
664 return NULL;
668 * Max len of packet: (original len + 4 (H5 hdr) + 2 (crc)) * 2
669 * (because bytes 0xc0 and 0xdb are escaped, worst case is when
670 * the packet is all made of 0xc0 and 0xdb) + 2 (0xc0
671 * delimiters at start and end).
673 nskb = alloc_skb((len + 6) * 2 + 2, GFP_ATOMIC);
674 if (!nskb)
675 return NULL;
677 hci_skb_pkt_type(nskb) = pkt_type;
679 h5_slip_delim(nskb);
681 hdr[0] = h5->tx_ack << 3;
682 clear_bit(H5_TX_ACK_REQ, &h5->flags);
684 /* Reliable packet? */
685 if (pkt_type == HCI_ACLDATA_PKT || pkt_type == HCI_COMMAND_PKT) {
686 hdr[0] |= 1 << 7;
687 hdr[0] |= h5->tx_seq;
688 h5->tx_seq = (h5->tx_seq + 1) % 8;
691 hdr[1] = pkt_type | ((len & 0x0f) << 4);
692 hdr[2] = len >> 4;
693 hdr[3] = ~((hdr[0] + hdr[1] + hdr[2]) & 0xff);
695 BT_DBG("%s tx: seq %u ack %u crc %u rel %u type %u len %u",
696 hu->hdev->name, H5_HDR_SEQ(hdr), H5_HDR_ACK(hdr),
697 H5_HDR_CRC(hdr), H5_HDR_RELIABLE(hdr), H5_HDR_PKT_TYPE(hdr),
698 H5_HDR_LEN(hdr));
700 for (i = 0; i < 4; i++)
701 h5_slip_one_byte(nskb, hdr[i]);
703 for (i = 0; i < len; i++)
704 h5_slip_one_byte(nskb, data[i]);
706 h5_slip_delim(nskb);
708 return nskb;
711 static struct sk_buff *h5_dequeue(struct hci_uart *hu)
713 struct h5 *h5 = hu->priv;
714 unsigned long flags;
715 struct sk_buff *skb, *nskb;
717 if (h5->sleep != H5_AWAKE) {
718 const unsigned char wakeup_req[] = { 0x05, 0xfa };
720 if (h5->sleep == H5_WAKING_UP)
721 return NULL;
723 h5->sleep = H5_WAKING_UP;
724 BT_DBG("Sending wakeup request");
726 mod_timer(&h5->timer, jiffies + HZ / 100);
727 return h5_prepare_pkt(hu, HCI_3WIRE_LINK_PKT, wakeup_req, 2);
730 skb = skb_dequeue(&h5->unrel);
731 if (skb) {
732 nskb = h5_prepare_pkt(hu, hci_skb_pkt_type(skb),
733 skb->data, skb->len);
734 if (nskb) {
735 kfree_skb(skb);
736 return nskb;
739 skb_queue_head(&h5->unrel, skb);
740 bt_dev_err(hu->hdev, "Could not dequeue pkt because alloc_skb failed");
743 spin_lock_irqsave_nested(&h5->unack.lock, flags, SINGLE_DEPTH_NESTING);
745 if (h5->unack.qlen >= h5->tx_win)
746 goto unlock;
748 skb = skb_dequeue(&h5->rel);
749 if (skb) {
750 nskb = h5_prepare_pkt(hu, hci_skb_pkt_type(skb),
751 skb->data, skb->len);
752 if (nskb) {
753 __skb_queue_tail(&h5->unack, skb);
754 mod_timer(&h5->timer, jiffies + H5_ACK_TIMEOUT);
755 spin_unlock_irqrestore(&h5->unack.lock, flags);
756 return nskb;
759 skb_queue_head(&h5->rel, skb);
760 bt_dev_err(hu->hdev, "Could not dequeue pkt because alloc_skb failed");
763 unlock:
764 spin_unlock_irqrestore(&h5->unack.lock, flags);
766 if (test_bit(H5_TX_ACK_REQ, &h5->flags))
767 return h5_prepare_pkt(hu, HCI_3WIRE_ACK_PKT, NULL, 0);
769 return NULL;
772 static int h5_flush(struct hci_uart *hu)
774 BT_DBG("hu %p", hu);
775 return 0;
778 static const struct hci_uart_proto h5p = {
779 .id = HCI_UART_3WIRE,
780 .name = "Three-wire (H5)",
781 .open = h5_open,
782 .close = h5_close,
783 .setup = h5_setup,
784 .recv = h5_recv,
785 .enqueue = h5_enqueue,
786 .dequeue = h5_dequeue,
787 .flush = h5_flush,
790 static int h5_serdev_probe(struct serdev_device *serdev)
792 struct device *dev = &serdev->dev;
793 struct h5 *h5;
795 h5 = devm_kzalloc(dev, sizeof(*h5), GFP_KERNEL);
796 if (!h5)
797 return -ENOMEM;
799 h5->hu = &h5->serdev_hu;
800 h5->serdev_hu.serdev = serdev;
801 serdev_device_set_drvdata(serdev, h5);
803 if (has_acpi_companion(dev)) {
804 const struct acpi_device_id *match;
806 match = acpi_match_device(dev->driver->acpi_match_table, dev);
807 if (!match)
808 return -ENODEV;
810 h5->vnd = (const struct h5_vnd *)match->driver_data;
811 h5->id = (char *)match->id;
813 if (h5->vnd->acpi_gpio_map)
814 devm_acpi_dev_add_driver_gpios(dev,
815 h5->vnd->acpi_gpio_map);
816 } else {
817 const void *data;
819 data = of_device_get_match_data(dev);
820 if (!data)
821 return -ENODEV;
823 h5->vnd = (const struct h5_vnd *)data;
827 h5->enable_gpio = devm_gpiod_get_optional(dev, "enable", GPIOD_OUT_LOW);
828 if (IS_ERR(h5->enable_gpio))
829 return PTR_ERR(h5->enable_gpio);
831 h5->device_wake_gpio = devm_gpiod_get_optional(dev, "device-wake",
832 GPIOD_OUT_LOW);
833 if (IS_ERR(h5->device_wake_gpio))
834 return PTR_ERR(h5->device_wake_gpio);
836 return hci_uart_register_device(&h5->serdev_hu, &h5p);
839 static void h5_serdev_remove(struct serdev_device *serdev)
841 struct h5 *h5 = serdev_device_get_drvdata(serdev);
843 hci_uart_unregister_device(&h5->serdev_hu);
846 static int __maybe_unused h5_serdev_suspend(struct device *dev)
848 struct h5 *h5 = dev_get_drvdata(dev);
849 int ret = 0;
851 if (h5->vnd && h5->vnd->suspend)
852 ret = h5->vnd->suspend(h5);
854 return ret;
857 static int __maybe_unused h5_serdev_resume(struct device *dev)
859 struct h5 *h5 = dev_get_drvdata(dev);
860 int ret = 0;
862 if (h5->vnd && h5->vnd->resume)
863 ret = h5->vnd->resume(h5);
865 return ret;
868 #ifdef CONFIG_BT_HCIUART_RTL
869 static int h5_btrtl_setup(struct h5 *h5)
871 struct btrtl_device_info *btrtl_dev;
872 struct sk_buff *skb;
873 __le32 baudrate_data;
874 u32 device_baudrate;
875 unsigned int controller_baudrate;
876 bool flow_control;
877 int err;
879 btrtl_dev = btrtl_initialize(h5->hu->hdev, h5->id);
880 if (IS_ERR(btrtl_dev))
881 return PTR_ERR(btrtl_dev);
883 err = btrtl_get_uart_settings(h5->hu->hdev, btrtl_dev,
884 &controller_baudrate, &device_baudrate,
885 &flow_control);
886 if (err)
887 goto out_free;
889 baudrate_data = cpu_to_le32(device_baudrate);
890 skb = __hci_cmd_sync(h5->hu->hdev, 0xfc17, sizeof(baudrate_data),
891 &baudrate_data, HCI_INIT_TIMEOUT);
892 if (IS_ERR(skb)) {
893 rtl_dev_err(h5->hu->hdev, "set baud rate command failed\n");
894 err = PTR_ERR(skb);
895 goto out_free;
896 } else {
897 kfree_skb(skb);
899 /* Give the device some time to set up the new baudrate. */
900 usleep_range(10000, 20000);
902 serdev_device_set_baudrate(h5->hu->serdev, controller_baudrate);
903 serdev_device_set_flow_control(h5->hu->serdev, flow_control);
905 err = btrtl_download_firmware(h5->hu->hdev, btrtl_dev);
906 /* Give the device some time before the hci-core sends it a reset */
907 usleep_range(10000, 20000);
909 out_free:
910 btrtl_free(btrtl_dev);
912 return err;
915 static void h5_btrtl_open(struct h5 *h5)
917 /* Devices always start with these fixed parameters */
918 serdev_device_set_flow_control(h5->hu->serdev, false);
919 serdev_device_set_parity(h5->hu->serdev, SERDEV_PARITY_EVEN);
920 serdev_device_set_baudrate(h5->hu->serdev, 115200);
922 /* The controller needs up to 500ms to wakeup */
923 gpiod_set_value_cansleep(h5->enable_gpio, 1);
924 gpiod_set_value_cansleep(h5->device_wake_gpio, 1);
925 msleep(500);
928 static void h5_btrtl_close(struct h5 *h5)
930 gpiod_set_value_cansleep(h5->device_wake_gpio, 0);
931 gpiod_set_value_cansleep(h5->enable_gpio, 0);
934 /* Suspend/resume support. On many devices the RTL BT device loses power during
935 * suspend/resume, causing it to lose its firmware and all state. So we simply
936 * turn it off on suspend and reprobe on resume. This mirrors how RTL devices
937 * are handled in the USB driver, where the USB_QUIRK_RESET_RESUME is used which
938 * also causes a reprobe on resume.
940 static int h5_btrtl_suspend(struct h5 *h5)
942 serdev_device_set_flow_control(h5->hu->serdev, false);
943 gpiod_set_value_cansleep(h5->device_wake_gpio, 0);
944 gpiod_set_value_cansleep(h5->enable_gpio, 0);
945 return 0;
948 struct h5_btrtl_reprobe {
949 struct device *dev;
950 struct work_struct work;
953 static void h5_btrtl_reprobe_worker(struct work_struct *work)
955 struct h5_btrtl_reprobe *reprobe =
956 container_of(work, struct h5_btrtl_reprobe, work);
957 int ret;
959 ret = device_reprobe(reprobe->dev);
960 if (ret && ret != -EPROBE_DEFER)
961 dev_err(reprobe->dev, "Reprobe error %d\n", ret);
963 put_device(reprobe->dev);
964 kfree(reprobe);
965 module_put(THIS_MODULE);
968 static int h5_btrtl_resume(struct h5 *h5)
970 struct h5_btrtl_reprobe *reprobe;
972 reprobe = kzalloc(sizeof(*reprobe), GFP_KERNEL);
973 if (!reprobe)
974 return -ENOMEM;
976 __module_get(THIS_MODULE);
978 INIT_WORK(&reprobe->work, h5_btrtl_reprobe_worker);
979 reprobe->dev = get_device(&h5->hu->serdev->dev);
980 queue_work(system_long_wq, &reprobe->work);
981 return 0;
984 static const struct acpi_gpio_params btrtl_device_wake_gpios = { 0, 0, false };
985 static const struct acpi_gpio_params btrtl_enable_gpios = { 1, 0, false };
986 static const struct acpi_gpio_params btrtl_host_wake_gpios = { 2, 0, false };
987 static const struct acpi_gpio_mapping acpi_btrtl_gpios[] = {
988 { "device-wake-gpios", &btrtl_device_wake_gpios, 1 },
989 { "enable-gpios", &btrtl_enable_gpios, 1 },
990 { "host-wake-gpios", &btrtl_host_wake_gpios, 1 },
994 static struct h5_vnd rtl_vnd = {
995 .setup = h5_btrtl_setup,
996 .open = h5_btrtl_open,
997 .close = h5_btrtl_close,
998 .suspend = h5_btrtl_suspend,
999 .resume = h5_btrtl_resume,
1000 .acpi_gpio_map = acpi_btrtl_gpios,
1002 #endif
1004 #ifdef CONFIG_ACPI
1005 static const struct acpi_device_id h5_acpi_match[] = {
1006 #ifdef CONFIG_BT_HCIUART_RTL
1007 { "OBDA0623", (kernel_ulong_t)&rtl_vnd },
1008 { "OBDA8723", (kernel_ulong_t)&rtl_vnd },
1009 #endif
1010 { },
1012 MODULE_DEVICE_TABLE(acpi, h5_acpi_match);
1013 #endif
1015 static const struct dev_pm_ops h5_serdev_pm_ops = {
1016 SET_SYSTEM_SLEEP_PM_OPS(h5_serdev_suspend, h5_serdev_resume)
1019 static const struct of_device_id rtl_bluetooth_of_match[] = {
1020 #ifdef CONFIG_BT_HCIUART_RTL
1021 { .compatible = "realtek,rtl8822cs-bt",
1022 .data = (const void *)&rtl_vnd },
1023 { .compatible = "realtek,rtl8723bs-bt",
1024 .data = (const void *)&rtl_vnd },
1025 #endif
1026 { },
1028 MODULE_DEVICE_TABLE(of, rtl_bluetooth_of_match);
1030 static struct serdev_device_driver h5_serdev_driver = {
1031 .probe = h5_serdev_probe,
1032 .remove = h5_serdev_remove,
1033 .driver = {
1034 .name = "hci_uart_h5",
1035 .acpi_match_table = ACPI_PTR(h5_acpi_match),
1036 .pm = &h5_serdev_pm_ops,
1037 .of_match_table = rtl_bluetooth_of_match,
1041 int __init h5_init(void)
1043 serdev_device_driver_register(&h5_serdev_driver);
1044 return hci_uart_register_proto(&h5p);
1047 int __exit h5_deinit(void)
1049 serdev_device_driver_unregister(&h5_serdev_driver);
1050 return hci_uart_unregister_proto(&h5p);