3 * Bluetooth HCI Three-wire UART driver
5 * Copyright (C) 2012 Intel Corporation
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 #include <linux/kernel.h>
25 #include <linux/errno.h>
26 #include <linux/skbuff.h>
28 #include <net/bluetooth/bluetooth.h>
29 #include <net/bluetooth/hci_core.h>
33 #define HCI_3WIRE_ACK_PKT 0
34 #define HCI_3WIRE_LINK_PKT 15
36 /* Sliding window size */
37 #define H5_TX_WIN_MAX 4
39 #define H5_ACK_TIMEOUT msecs_to_jiffies(250)
40 #define H5_SYNC_TIMEOUT msecs_to_jiffies(100)
43 * Maximum Three-wire packet:
44 * 4 byte header + max value for 12-bit length + 2 bytes for CRC
46 #define H5_MAX_LEN (4 + 0xfff + 2)
48 /* Convenience macros for reading Three-wire header values */
49 #define H5_HDR_SEQ(hdr) ((hdr)[0] & 0x07)
50 #define H5_HDR_ACK(hdr) (((hdr)[0] >> 3) & 0x07)
51 #define H5_HDR_CRC(hdr) (((hdr)[0] >> 6) & 0x01)
52 #define H5_HDR_RELIABLE(hdr) (((hdr)[0] >> 7) & 0x01)
53 #define H5_HDR_PKT_TYPE(hdr) ((hdr)[1] & 0x0f)
54 #define H5_HDR_LEN(hdr) ((((hdr)[1] >> 4) & 0x0f) + ((hdr)[2] << 4))
56 #define SLIP_DELIMITER 0xc0
58 #define SLIP_ESC_DELIM 0xdc
59 #define SLIP_ESC_ESC 0xdd
63 H5_RX_ESC
, /* SLIP escape mode */
64 H5_TX_ACK_REQ
, /* Pending ack to send */
68 struct sk_buff_head unack
; /* Unack'ed packets queue */
69 struct sk_buff_head rel
; /* Reliable packets queue */
70 struct sk_buff_head unrel
; /* Unreliable packets queue */
74 struct sk_buff
*rx_skb
; /* Receive buffer */
75 size_t rx_pending
; /* Expecting more bytes */
76 u8 rx_ack
; /* Last ack number received */
78 int (*rx_func
)(struct hci_uart
*hu
, u8 c
);
80 struct timer_list timer
; /* Retransmission timer */
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 */
99 static void h5_reset_rx(struct h5
*h5
);
101 static void h5_link_control(struct hci_uart
*hu
, const void *data
, size_t len
)
103 struct h5
*h5
= hu
->priv
;
104 struct sk_buff
*nskb
;
106 nskb
= alloc_skb(3, GFP_ATOMIC
);
110 hci_skb_pkt_type(nskb
) = HCI_3WIRE_LINK_PKT
;
112 memcpy(skb_put(nskb
, len
), data
, len
);
114 skb_queue_tail(&h5
->unrel
, nskb
);
117 static u8
h5_cfg_field(struct h5
*h5
)
119 /* Sliding window size (first 3 bits) */
120 return h5
->tx_win
& 0x07;
123 static void h5_timed_event(unsigned long arg
)
125 const unsigned char sync_req
[] = { 0x01, 0x7e };
126 unsigned char conf_req
[3] = { 0x03, 0xfc };
127 struct hci_uart
*hu
= (struct hci_uart
*)arg
;
128 struct h5
*h5
= hu
->priv
;
132 BT_DBG("%s", hu
->hdev
->name
);
134 if (h5
->state
== H5_UNINITIALIZED
)
135 h5_link_control(hu
, sync_req
, sizeof(sync_req
));
137 if (h5
->state
== H5_INITIALIZED
) {
138 conf_req
[2] = h5_cfg_field(h5
);
139 h5_link_control(hu
, conf_req
, sizeof(conf_req
));
142 if (h5
->state
!= H5_ACTIVE
) {
143 mod_timer(&h5
->timer
, jiffies
+ H5_SYNC_TIMEOUT
);
147 if (h5
->sleep
!= H5_AWAKE
) {
148 h5
->sleep
= H5_SLEEPING
;
152 BT_DBG("hu %p retransmitting %u pkts", hu
, h5
->unack
.qlen
);
154 spin_lock_irqsave_nested(&h5
->unack
.lock
, flags
, SINGLE_DEPTH_NESTING
);
156 while ((skb
= __skb_dequeue_tail(&h5
->unack
)) != NULL
) {
157 h5
->tx_seq
= (h5
->tx_seq
- 1) & 0x07;
158 skb_queue_head(&h5
->rel
, skb
);
161 spin_unlock_irqrestore(&h5
->unack
.lock
, flags
);
164 hci_uart_tx_wakeup(hu
);
167 static void h5_peer_reset(struct hci_uart
*hu
)
169 struct h5
*h5
= hu
->priv
;
171 BT_ERR("Peer device has reset");
173 h5
->state
= H5_UNINITIALIZED
;
175 del_timer(&h5
->timer
);
177 skb_queue_purge(&h5
->rel
);
178 skb_queue_purge(&h5
->unrel
);
179 skb_queue_purge(&h5
->unack
);
184 /* Send reset request to upper stack */
185 hci_reset_dev(hu
->hdev
);
188 static int h5_open(struct hci_uart
*hu
)
191 const unsigned char sync
[] = { 0x01, 0x7e };
195 h5
= kzalloc(sizeof(*h5
), GFP_KERNEL
);
201 skb_queue_head_init(&h5
->unack
);
202 skb_queue_head_init(&h5
->rel
);
203 skb_queue_head_init(&h5
->unrel
);
207 init_timer(&h5
->timer
);
208 h5
->timer
.function
= h5_timed_event
;
209 h5
->timer
.data
= (unsigned long)hu
;
211 h5
->tx_win
= H5_TX_WIN_MAX
;
213 set_bit(HCI_UART_INIT_PENDING
, &hu
->hdev_flags
);
215 /* Send initial sync request */
216 h5_link_control(hu
, sync
, sizeof(sync
));
217 mod_timer(&h5
->timer
, jiffies
+ H5_SYNC_TIMEOUT
);
222 static int h5_close(struct hci_uart
*hu
)
224 struct h5
*h5
= hu
->priv
;
226 del_timer_sync(&h5
->timer
);
228 skb_queue_purge(&h5
->unack
);
229 skb_queue_purge(&h5
->rel
);
230 skb_queue_purge(&h5
->unrel
);
237 static void h5_pkt_cull(struct h5
*h5
)
239 struct sk_buff
*skb
, *tmp
;
244 spin_lock_irqsave(&h5
->unack
.lock
, flags
);
246 to_remove
= skb_queue_len(&h5
->unack
);
252 while (to_remove
> 0) {
253 if (h5
->rx_ack
== seq
)
257 seq
= (seq
- 1) & 0x07;
260 if (seq
!= h5
->rx_ack
)
261 BT_ERR("Controller acked invalid packet");
264 skb_queue_walk_safe(&h5
->unack
, skb
, tmp
) {
265 if (i
++ >= to_remove
)
268 __skb_unlink(skb
, &h5
->unack
);
272 if (skb_queue_empty(&h5
->unack
))
273 del_timer(&h5
->timer
);
276 spin_unlock_irqrestore(&h5
->unack
.lock
, flags
);
279 static void h5_handle_internal_rx(struct hci_uart
*hu
)
281 struct h5
*h5
= hu
->priv
;
282 const unsigned char sync_req
[] = { 0x01, 0x7e };
283 const unsigned char sync_rsp
[] = { 0x02, 0x7d };
284 unsigned char conf_req
[3] = { 0x03, 0xfc };
285 const unsigned char conf_rsp
[] = { 0x04, 0x7b };
286 const unsigned char wakeup_req
[] = { 0x05, 0xfa };
287 const unsigned char woken_req
[] = { 0x06, 0xf9 };
288 const unsigned char sleep_req
[] = { 0x07, 0x78 };
289 const unsigned char *hdr
= h5
->rx_skb
->data
;
290 const unsigned char *data
= &h5
->rx_skb
->data
[4];
292 BT_DBG("%s", hu
->hdev
->name
);
294 if (H5_HDR_PKT_TYPE(hdr
) != HCI_3WIRE_LINK_PKT
)
297 if (H5_HDR_LEN(hdr
) < 2)
300 conf_req
[2] = h5_cfg_field(h5
);
302 if (memcmp(data
, sync_req
, 2) == 0) {
303 if (h5
->state
== H5_ACTIVE
)
305 h5_link_control(hu
, sync_rsp
, 2);
306 } else if (memcmp(data
, sync_rsp
, 2) == 0) {
307 if (h5
->state
== H5_ACTIVE
)
309 h5
->state
= H5_INITIALIZED
;
310 h5_link_control(hu
, conf_req
, 3);
311 } else if (memcmp(data
, conf_req
, 2) == 0) {
312 h5_link_control(hu
, conf_rsp
, 2);
313 h5_link_control(hu
, conf_req
, 3);
314 } else if (memcmp(data
, conf_rsp
, 2) == 0) {
315 if (H5_HDR_LEN(hdr
) > 2)
316 h5
->tx_win
= (data
[2] & 0x07);
317 BT_DBG("Three-wire init complete. tx_win %u", h5
->tx_win
);
318 h5
->state
= H5_ACTIVE
;
319 hci_uart_init_ready(hu
);
321 } else if (memcmp(data
, sleep_req
, 2) == 0) {
322 BT_DBG("Peer went to sleep");
323 h5
->sleep
= H5_SLEEPING
;
325 } else if (memcmp(data
, woken_req
, 2) == 0) {
326 BT_DBG("Peer woke up");
327 h5
->sleep
= H5_AWAKE
;
328 } else if (memcmp(data
, wakeup_req
, 2) == 0) {
329 BT_DBG("Peer requested wakeup");
330 h5_link_control(hu
, woken_req
, 2);
331 h5
->sleep
= H5_AWAKE
;
333 BT_DBG("Link Control: 0x%02hhx 0x%02hhx", data
[0], data
[1]);
337 hci_uart_tx_wakeup(hu
);
340 static void h5_complete_rx_pkt(struct hci_uart
*hu
)
342 struct h5
*h5
= hu
->priv
;
343 const unsigned char *hdr
= h5
->rx_skb
->data
;
345 if (H5_HDR_RELIABLE(hdr
)) {
346 h5
->tx_ack
= (h5
->tx_ack
+ 1) % 8;
347 set_bit(H5_TX_ACK_REQ
, &h5
->flags
);
348 hci_uart_tx_wakeup(hu
);
351 h5
->rx_ack
= H5_HDR_ACK(hdr
);
355 switch (H5_HDR_PKT_TYPE(hdr
)) {
357 case HCI_ACLDATA_PKT
:
358 case HCI_SCODATA_PKT
:
359 hci_skb_pkt_type(h5
->rx_skb
) = H5_HDR_PKT_TYPE(hdr
);
361 /* Remove Three-wire header */
362 skb_pull(h5
->rx_skb
, 4);
364 hci_recv_frame(hu
->hdev
, h5
->rx_skb
);
370 h5_handle_internal_rx(hu
);
377 static int h5_rx_crc(struct hci_uart
*hu
, unsigned char c
)
379 h5_complete_rx_pkt(hu
);
384 static int h5_rx_payload(struct hci_uart
*hu
, unsigned char c
)
386 struct h5
*h5
= hu
->priv
;
387 const unsigned char *hdr
= h5
->rx_skb
->data
;
389 if (H5_HDR_CRC(hdr
)) {
390 h5
->rx_func
= h5_rx_crc
;
393 h5_complete_rx_pkt(hu
);
399 static int h5_rx_3wire_hdr(struct hci_uart
*hu
, unsigned char c
)
401 struct h5
*h5
= hu
->priv
;
402 const unsigned char *hdr
= h5
->rx_skb
->data
;
404 BT_DBG("%s rx: seq %u ack %u crc %u rel %u type %u len %u",
405 hu
->hdev
->name
, H5_HDR_SEQ(hdr
), H5_HDR_ACK(hdr
),
406 H5_HDR_CRC(hdr
), H5_HDR_RELIABLE(hdr
), H5_HDR_PKT_TYPE(hdr
),
409 if (((hdr
[0] + hdr
[1] + hdr
[2] + hdr
[3]) & 0xff) != 0xff) {
410 BT_ERR("Invalid header checksum");
415 if (H5_HDR_RELIABLE(hdr
) && H5_HDR_SEQ(hdr
) != h5
->tx_ack
) {
416 BT_ERR("Out-of-order packet arrived (%u != %u)",
417 H5_HDR_SEQ(hdr
), h5
->tx_ack
);
422 if (h5
->state
!= H5_ACTIVE
&&
423 H5_HDR_PKT_TYPE(hdr
) != HCI_3WIRE_LINK_PKT
) {
424 BT_ERR("Non-link packet received in non-active state");
429 h5
->rx_func
= h5_rx_payload
;
430 h5
->rx_pending
= H5_HDR_LEN(hdr
);
435 static int h5_rx_pkt_start(struct hci_uart
*hu
, unsigned char c
)
437 struct h5
*h5
= hu
->priv
;
439 if (c
== SLIP_DELIMITER
)
442 h5
->rx_func
= h5_rx_3wire_hdr
;
445 h5
->rx_skb
= bt_skb_alloc(H5_MAX_LEN
, GFP_ATOMIC
);
447 BT_ERR("Can't allocate mem for new packet");
452 h5
->rx_skb
->dev
= (void *)hu
->hdev
;
457 static int h5_rx_delimiter(struct hci_uart
*hu
, unsigned char c
)
459 struct h5
*h5
= hu
->priv
;
461 if (c
== SLIP_DELIMITER
)
462 h5
->rx_func
= h5_rx_pkt_start
;
467 static void h5_unslip_one_byte(struct h5
*h5
, unsigned char c
)
469 const u8 delim
= SLIP_DELIMITER
, esc
= SLIP_ESC
;
472 if (!test_bit(H5_RX_ESC
, &h5
->flags
) && c
== SLIP_ESC
) {
473 set_bit(H5_RX_ESC
, &h5
->flags
);
477 if (test_and_clear_bit(H5_RX_ESC
, &h5
->flags
)) {
486 BT_ERR("Invalid esc byte 0x%02hhx", c
);
492 memcpy(skb_put(h5
->rx_skb
, 1), byte
, 1);
495 BT_DBG("unsliped 0x%02hhx, rx_pending %zu", *byte
, h5
->rx_pending
);
498 static void h5_reset_rx(struct h5
*h5
)
501 kfree_skb(h5
->rx_skb
);
505 h5
->rx_func
= h5_rx_delimiter
;
507 clear_bit(H5_RX_ESC
, &h5
->flags
);
510 static int h5_recv(struct hci_uart
*hu
, const void *data
, int count
)
512 struct h5
*h5
= hu
->priv
;
513 const unsigned char *ptr
= data
;
515 BT_DBG("%s pending %zu count %d", hu
->hdev
->name
, h5
->rx_pending
,
521 if (h5
->rx_pending
> 0) {
522 if (*ptr
== SLIP_DELIMITER
) {
523 BT_ERR("Too short H5 packet");
528 h5_unslip_one_byte(h5
, *ptr
);
534 processed
= h5
->rx_func(hu
, *ptr
);
545 static int h5_enqueue(struct hci_uart
*hu
, struct sk_buff
*skb
)
547 struct h5
*h5
= hu
->priv
;
549 if (skb
->len
> 0xfff) {
550 BT_ERR("Packet too long (%u bytes)", skb
->len
);
555 if (h5
->state
!= H5_ACTIVE
) {
556 BT_ERR("Ignoring HCI data in non-active state");
561 switch (hci_skb_pkt_type(skb
)) {
562 case HCI_ACLDATA_PKT
:
563 case HCI_COMMAND_PKT
:
564 skb_queue_tail(&h5
->rel
, skb
);
567 case HCI_SCODATA_PKT
:
568 skb_queue_tail(&h5
->unrel
, skb
);
572 BT_ERR("Unknown packet type %u", hci_skb_pkt_type(skb
));
580 static void h5_slip_delim(struct sk_buff
*skb
)
582 const char delim
= SLIP_DELIMITER
;
584 memcpy(skb_put(skb
, 1), &delim
, 1);
587 static void h5_slip_one_byte(struct sk_buff
*skb
, u8 c
)
589 const char esc_delim
[2] = { SLIP_ESC
, SLIP_ESC_DELIM
};
590 const char esc_esc
[2] = { SLIP_ESC
, SLIP_ESC_ESC
};
594 memcpy(skb_put(skb
, 2), &esc_delim
, 2);
597 memcpy(skb_put(skb
, 2), &esc_esc
, 2);
600 memcpy(skb_put(skb
, 1), &c
, 1);
604 static bool valid_packet_type(u8 type
)
607 case HCI_ACLDATA_PKT
:
608 case HCI_COMMAND_PKT
:
609 case HCI_SCODATA_PKT
:
610 case HCI_3WIRE_LINK_PKT
:
611 case HCI_3WIRE_ACK_PKT
:
618 static struct sk_buff
*h5_prepare_pkt(struct hci_uart
*hu
, u8 pkt_type
,
619 const u8
*data
, size_t len
)
621 struct h5
*h5
= hu
->priv
;
622 struct sk_buff
*nskb
;
626 if (!valid_packet_type(pkt_type
)) {
627 BT_ERR("Unknown packet type %u", pkt_type
);
632 * Max len of packet: (original len + 4 (H5 hdr) + 2 (crc)) * 2
633 * (because bytes 0xc0 and 0xdb are escaped, worst case is when
634 * the packet is all made of 0xc0 and 0xdb) + 2 (0xc0
635 * delimiters at start and end).
637 nskb
= alloc_skb((len
+ 6) * 2 + 2, GFP_ATOMIC
);
641 hci_skb_pkt_type(nskb
) = pkt_type
;
645 hdr
[0] = h5
->tx_ack
<< 3;
646 clear_bit(H5_TX_ACK_REQ
, &h5
->flags
);
648 /* Reliable packet? */
649 if (pkt_type
== HCI_ACLDATA_PKT
|| pkt_type
== HCI_COMMAND_PKT
) {
651 hdr
[0] |= h5
->tx_seq
;
652 h5
->tx_seq
= (h5
->tx_seq
+ 1) % 8;
655 hdr
[1] = pkt_type
| ((len
& 0x0f) << 4);
657 hdr
[3] = ~((hdr
[0] + hdr
[1] + hdr
[2]) & 0xff);
659 BT_DBG("%s tx: seq %u ack %u crc %u rel %u type %u len %u",
660 hu
->hdev
->name
, H5_HDR_SEQ(hdr
), H5_HDR_ACK(hdr
),
661 H5_HDR_CRC(hdr
), H5_HDR_RELIABLE(hdr
), H5_HDR_PKT_TYPE(hdr
),
664 for (i
= 0; i
< 4; i
++)
665 h5_slip_one_byte(nskb
, hdr
[i
]);
667 for (i
= 0; i
< len
; i
++)
668 h5_slip_one_byte(nskb
, data
[i
]);
675 static struct sk_buff
*h5_dequeue(struct hci_uart
*hu
)
677 struct h5
*h5
= hu
->priv
;
679 struct sk_buff
*skb
, *nskb
;
681 if (h5
->sleep
!= H5_AWAKE
) {
682 const unsigned char wakeup_req
[] = { 0x05, 0xfa };
684 if (h5
->sleep
== H5_WAKING_UP
)
687 h5
->sleep
= H5_WAKING_UP
;
688 BT_DBG("Sending wakeup request");
690 mod_timer(&h5
->timer
, jiffies
+ HZ
/ 100);
691 return h5_prepare_pkt(hu
, HCI_3WIRE_LINK_PKT
, wakeup_req
, 2);
694 skb
= skb_dequeue(&h5
->unrel
);
696 nskb
= h5_prepare_pkt(hu
, hci_skb_pkt_type(skb
),
697 skb
->data
, skb
->len
);
703 skb_queue_head(&h5
->unrel
, skb
);
704 BT_ERR("Could not dequeue pkt because alloc_skb failed");
707 spin_lock_irqsave_nested(&h5
->unack
.lock
, flags
, SINGLE_DEPTH_NESTING
);
709 if (h5
->unack
.qlen
>= h5
->tx_win
)
712 skb
= skb_dequeue(&h5
->rel
);
714 nskb
= h5_prepare_pkt(hu
, hci_skb_pkt_type(skb
),
715 skb
->data
, skb
->len
);
717 __skb_queue_tail(&h5
->unack
, skb
);
718 mod_timer(&h5
->timer
, jiffies
+ H5_ACK_TIMEOUT
);
719 spin_unlock_irqrestore(&h5
->unack
.lock
, flags
);
723 skb_queue_head(&h5
->rel
, skb
);
724 BT_ERR("Could not dequeue pkt because alloc_skb failed");
728 spin_unlock_irqrestore(&h5
->unack
.lock
, flags
);
730 if (test_bit(H5_TX_ACK_REQ
, &h5
->flags
))
731 return h5_prepare_pkt(hu
, HCI_3WIRE_ACK_PKT
, NULL
, 0);
736 static int h5_flush(struct hci_uart
*hu
)
742 static const struct hci_uart_proto h5p
= {
743 .id
= HCI_UART_3WIRE
,
744 .name
= "Three-wire (H5)",
748 .enqueue
= h5_enqueue
,
749 .dequeue
= h5_dequeue
,
753 int __init
h5_init(void)
755 return hci_uart_register_proto(&h5p
);
758 int __exit
h5_deinit(void)
760 return hci_uart_unregister_proto(&h5p
);