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 #define H5_TXWINSIZE 4
38 #define H5_ACK_TIMEOUT msecs_to_jiffies(250)
39 #define H5_SYNC_TIMEOUT msecs_to_jiffies(100)
42 * Maximum Three-wire packet:
43 * 4 byte header + max value for 12-bit length + 2 bytes for CRC
45 #define H5_MAX_LEN (4 + 0xfff + 2)
47 /* Convenience macros for reading Three-wire header values */
48 #define H5_HDR_SEQ(hdr) ((hdr)[0] & 0x07)
49 #define H5_HDR_ACK(hdr) (((hdr)[0] >> 3) & 0x07)
50 #define H5_HDR_CRC(hdr) (((hdr)[0] >> 6) & 0x01)
51 #define H5_HDR_RELIABLE(hdr) (((hdr)[0] >> 7) & 0x01)
52 #define H5_HDR_PKT_TYPE(hdr) ((hdr)[1] & 0x0f)
53 #define H5_HDR_LEN(hdr) ((((hdr)[1] >> 4) & 0xff) + ((hdr)[2] << 4))
55 #define SLIP_DELIMITER 0xc0
57 #define SLIP_ESC_DELIM 0xdc
58 #define SLIP_ESC_ESC 0xdd
61 struct sk_buff_head unack
; /* Unack'ed packets queue */
62 struct sk_buff_head rel
; /* Reliable packets queue */
63 struct sk_buff_head unrel
; /* Unreliable packets queue */
65 struct sk_buff
*rx_skb
; /* Receive buffer */
66 size_t rx_pending
; /* Expecting more bytes */
67 bool rx_esc
; /* SLIP escape mode */
68 u8 rx_ack
; /* Last ack number received */
70 int (*rx_func
) (struct hci_uart
*hu
, u8 c
);
72 struct timer_list timer
; /* Retransmission timer */
74 bool tx_ack_req
; /* Pending ack to send */
75 u8 tx_seq
; /* Next seq number to send */
76 u8 tx_ack
; /* Next ack number to send */
91 static void h5_reset_rx(struct h5
*h5
);
93 static void h5_link_control(struct hci_uart
*hu
, const void *data
, size_t len
)
95 struct h5
*h5
= hu
->priv
;
98 nskb
= alloc_skb(3, GFP_ATOMIC
);
102 bt_cb(nskb
)->pkt_type
= HCI_3WIRE_LINK_PKT
;
104 memcpy(skb_put(nskb
, len
), data
, len
);
106 skb_queue_tail(&h5
->unrel
, nskb
);
109 static void h5_timed_event(unsigned long arg
)
111 const unsigned char sync_req
[] = { 0x01, 0x7e };
112 const unsigned char conf_req
[] = { 0x03, 0xfc, 0x01 };
113 struct hci_uart
*hu
= (struct hci_uart
*) arg
;
114 struct h5
*h5
= hu
->priv
;
118 BT_DBG("%s", hu
->hdev
->name
);
120 if (h5
->state
== H5_UNINITIALIZED
)
121 h5_link_control(hu
, sync_req
, sizeof(sync_req
));
123 if (h5
->state
== H5_INITIALIZED
)
124 h5_link_control(hu
, conf_req
, sizeof(conf_req
));
126 if (h5
->state
!= H5_ACTIVE
) {
127 mod_timer(&h5
->timer
, jiffies
+ H5_SYNC_TIMEOUT
);
131 if (h5
->sleep
!= H5_AWAKE
) {
132 h5
->sleep
= H5_SLEEPING
;
136 BT_DBG("hu %p retransmitting %u pkts", hu
, h5
->unack
.qlen
);
138 spin_lock_irqsave_nested(&h5
->unack
.lock
, flags
, SINGLE_DEPTH_NESTING
);
140 while ((skb
= __skb_dequeue_tail(&h5
->unack
)) != NULL
) {
141 h5
->tx_seq
= (h5
->tx_seq
- 1) & 0x07;
142 skb_queue_head(&h5
->rel
, skb
);
145 spin_unlock_irqrestore(&h5
->unack
.lock
, flags
);
148 hci_uart_tx_wakeup(hu
);
151 static int h5_open(struct hci_uart
*hu
)
154 const unsigned char sync
[] = { 0x01, 0x7e };
158 h5
= kzalloc(sizeof(*h5
), GFP_KERNEL
);
164 skb_queue_head_init(&h5
->unack
);
165 skb_queue_head_init(&h5
->rel
);
166 skb_queue_head_init(&h5
->unrel
);
170 init_timer(&h5
->timer
);
171 h5
->timer
.function
= h5_timed_event
;
172 h5
->timer
.data
= (unsigned long) hu
;
174 set_bit(HCI_UART_INIT_PENDING
, &hu
->hdev_flags
);
176 /* Send initial sync request */
177 h5_link_control(hu
, sync
, sizeof(sync
));
178 mod_timer(&h5
->timer
, jiffies
+ H5_SYNC_TIMEOUT
);
183 static int h5_close(struct hci_uart
*hu
)
185 struct h5
*h5
= hu
->priv
;
187 skb_queue_purge(&h5
->unack
);
188 skb_queue_purge(&h5
->rel
);
189 skb_queue_purge(&h5
->unrel
);
191 del_timer(&h5
->timer
);
198 static void h5_pkt_cull(struct h5
*h5
)
200 struct sk_buff
*skb
, *tmp
;
205 spin_lock_irqsave(&h5
->unack
.lock
, flags
);
207 to_remove
= skb_queue_len(&h5
->unack
);
213 while (to_remove
> 0) {
214 if (h5
->rx_ack
== seq
)
221 if (seq
!= h5
->rx_ack
)
222 BT_ERR("Controller acked invalid packet");
225 skb_queue_walk_safe(&h5
->unack
, skb
, tmp
) {
226 if (i
++ >= to_remove
)
229 __skb_unlink(skb
, &h5
->unack
);
233 if (skb_queue_empty(&h5
->unack
))
234 del_timer(&h5
->timer
);
237 spin_unlock_irqrestore(&h5
->unack
.lock
, flags
);
240 static void h5_handle_internal_rx(struct hci_uart
*hu
)
242 struct h5
*h5
= hu
->priv
;
243 const unsigned char sync_req
[] = { 0x01, 0x7e };
244 const unsigned char sync_rsp
[] = { 0x02, 0x7d };
245 const unsigned char conf_req
[] = { 0x03, 0xfc, 0x01 };
246 const unsigned char conf_rsp
[] = { 0x04, 0x7b, 0x01 };
247 const unsigned char wakeup_req
[] = { 0x05, 0xfa };
248 const unsigned char woken_req
[] = { 0x06, 0xf9 };
249 const unsigned char sleep_req
[] = { 0x07, 0x78 };
250 const unsigned char *hdr
= h5
->rx_skb
->data
;
251 const unsigned char *data
= &h5
->rx_skb
->data
[4];
253 BT_DBG("%s", hu
->hdev
->name
);
255 if (H5_HDR_PKT_TYPE(hdr
) != HCI_3WIRE_LINK_PKT
)
258 if (H5_HDR_LEN(hdr
) < 2)
261 if (memcmp(data
, sync_req
, 2) == 0) {
262 h5_link_control(hu
, sync_rsp
, 2);
263 } else if (memcmp(data
, sync_rsp
, 2) == 0) {
264 h5
->state
= H5_INITIALIZED
;
265 h5_link_control(hu
, conf_req
, 3);
266 } else if (memcmp(data
, conf_req
, 2) == 0) {
267 h5_link_control(hu
, conf_rsp
, 2);
268 h5_link_control(hu
, conf_req
, 3);
269 } else if (memcmp(data
, conf_rsp
, 2) == 0) {
270 BT_DBG("Three-wire init sequence complete");
271 h5
->state
= H5_ACTIVE
;
272 hci_uart_init_ready(hu
);
274 } else if (memcmp(data
, sleep_req
, 2) == 0) {
275 BT_DBG("Peer went to sleep");
276 h5
->sleep
= H5_SLEEPING
;
278 } else if (memcmp(data
, woken_req
, 2) == 0) {
279 BT_DBG("Peer woke up");
280 h5
->sleep
= H5_AWAKE
;
281 } else if (memcmp(data
, wakeup_req
, 2) == 0) {
282 BT_DBG("Peer requested wakeup");
283 h5_link_control(hu
, woken_req
, 2);
284 h5
->sleep
= H5_AWAKE
;
286 BT_DBG("Link Control: 0x%02hhx 0x%02hhx", data
[0], data
[1]);
290 hci_uart_tx_wakeup(hu
);
293 static void h5_complete_rx_pkt(struct hci_uart
*hu
)
295 struct h5
*h5
= hu
->priv
;
296 const unsigned char *hdr
= h5
->rx_skb
->data
;
298 if (H5_HDR_RELIABLE(hdr
)) {
299 h5
->tx_ack
= (h5
->tx_ack
+ 1) % 8;
300 h5
->tx_ack_req
= true;
301 hci_uart_tx_wakeup(hu
);
304 h5
->rx_ack
= H5_HDR_ACK(hdr
);
308 switch (H5_HDR_PKT_TYPE(hdr
)) {
310 case HCI_ACLDATA_PKT
:
311 case HCI_SCODATA_PKT
:
312 bt_cb(h5
->rx_skb
)->pkt_type
= H5_HDR_PKT_TYPE(hdr
);
314 /* Remove Three-wire header */
315 skb_pull(h5
->rx_skb
, 4);
317 hci_recv_frame(h5
->rx_skb
);
323 h5_handle_internal_rx(hu
);
330 static int h5_rx_crc(struct hci_uart
*hu
, unsigned char c
)
332 struct h5
*h5
= hu
->priv
;
334 h5_complete_rx_pkt(hu
);
340 static int h5_rx_payload(struct hci_uart
*hu
, unsigned char c
)
342 struct h5
*h5
= hu
->priv
;
343 const unsigned char *hdr
= h5
->rx_skb
->data
;
345 if (H5_HDR_CRC(hdr
)) {
346 h5
->rx_func
= h5_rx_crc
;
349 h5_complete_rx_pkt(hu
);
356 static int h5_rx_3wire_hdr(struct hci_uart
*hu
, unsigned char c
)
358 struct h5
*h5
= hu
->priv
;
359 const unsigned char *hdr
= h5
->rx_skb
->data
;
361 BT_DBG("%s rx: seq %u ack %u crc %u rel %u type %u len %u",
362 hu
->hdev
->name
, H5_HDR_SEQ(hdr
), H5_HDR_ACK(hdr
),
363 H5_HDR_CRC(hdr
), H5_HDR_RELIABLE(hdr
), H5_HDR_PKT_TYPE(hdr
),
366 if (((hdr
[0] + hdr
[1] + hdr
[2] + hdr
[3]) & 0xff) != 0xff) {
367 BT_ERR("Invalid header checksum");
372 if (H5_HDR_RELIABLE(hdr
) && H5_HDR_SEQ(hdr
) != h5
->tx_ack
) {
373 BT_ERR("Out-of-order packet arrived (%u != %u)",
374 H5_HDR_SEQ(hdr
), h5
->tx_ack
);
379 if (h5
->state
!= H5_ACTIVE
&&
380 H5_HDR_PKT_TYPE(hdr
) != HCI_3WIRE_LINK_PKT
) {
381 BT_ERR("Non-link packet received in non-active state");
385 h5
->rx_func
= h5_rx_payload
;
386 h5
->rx_pending
= H5_HDR_LEN(hdr
);
391 static int h5_rx_pkt_start(struct hci_uart
*hu
, unsigned char c
)
393 struct h5
*h5
= hu
->priv
;
395 if (c
== SLIP_DELIMITER
)
398 h5
->rx_func
= h5_rx_3wire_hdr
;
401 h5
->rx_skb
= bt_skb_alloc(H5_MAX_LEN
, GFP_ATOMIC
);
403 BT_ERR("Can't allocate mem for new packet");
408 h5
->rx_skb
->dev
= (void *) hu
->hdev
;
413 static int h5_rx_delimiter(struct hci_uart
*hu
, unsigned char c
)
415 struct h5
*h5
= hu
->priv
;
417 if (c
== SLIP_DELIMITER
)
418 h5
->rx_func
= h5_rx_pkt_start
;
423 static void h5_unslip_one_byte(struct h5
*h5
, unsigned char c
)
425 const u8 delim
= SLIP_DELIMITER
, esc
= SLIP_ESC
;
428 if (!h5
->rx_esc
&& c
== SLIP_ESC
) {
442 BT_ERR("Invalid esc byte 0x%02hhx", c
);
450 memcpy(skb_put(h5
->rx_skb
, 1), byte
, 1);
453 BT_DBG("unsliped 0x%02hhx, rx_pending %zu", *byte
, h5
->rx_pending
);
456 static void h5_reset_rx(struct h5
*h5
)
459 kfree_skb(h5
->rx_skb
);
463 h5
->rx_func
= h5_rx_delimiter
;
468 static int h5_recv(struct hci_uart
*hu
, void *data
, int count
)
470 struct h5
*h5
= hu
->priv
;
471 unsigned char *ptr
= data
;
473 BT_DBG("%s pending %zu count %d", hu
->hdev
->name
, h5
->rx_pending
,
479 if (h5
->rx_pending
> 0) {
480 if (*ptr
== SLIP_DELIMITER
) {
481 BT_ERR("Too short H5 packet");
486 h5_unslip_one_byte(h5
, *ptr
);
492 processed
= h5
->rx_func(hu
, *ptr
);
503 static int h5_enqueue(struct hci_uart
*hu
, struct sk_buff
*skb
)
505 struct h5
*h5
= hu
->priv
;
507 if (skb
->len
> 0xfff) {
508 BT_ERR("Packet too long (%u bytes)", skb
->len
);
513 if (h5
->state
!= H5_ACTIVE
) {
514 BT_ERR("Ignoring HCI data in non-active state");
519 switch (bt_cb(skb
)->pkt_type
) {
520 case HCI_ACLDATA_PKT
:
521 case HCI_COMMAND_PKT
:
522 skb_queue_tail(&h5
->rel
, skb
);
525 case HCI_SCODATA_PKT
:
526 skb_queue_tail(&h5
->unrel
, skb
);
530 BT_ERR("Unknown packet type %u", bt_cb(skb
)->pkt_type
);
538 static void h5_slip_delim(struct sk_buff
*skb
)
540 const char delim
= SLIP_DELIMITER
;
542 memcpy(skb_put(skb
, 1), &delim
, 1);
545 static void h5_slip_one_byte(struct sk_buff
*skb
, u8 c
)
547 const char esc_delim
[2] = { SLIP_ESC
, SLIP_ESC_DELIM
};
548 const char esc_esc
[2] = { SLIP_ESC
, SLIP_ESC_ESC
};
552 memcpy(skb_put(skb
, 2), &esc_delim
, 2);
555 memcpy(skb_put(skb
, 2), &esc_esc
, 2);
558 memcpy(skb_put(skb
, 1), &c
, 1);
562 static bool valid_packet_type(u8 type
)
565 case HCI_ACLDATA_PKT
:
566 case HCI_COMMAND_PKT
:
567 case HCI_SCODATA_PKT
:
568 case HCI_3WIRE_LINK_PKT
:
569 case HCI_3WIRE_ACK_PKT
:
576 static struct sk_buff
*h5_prepare_pkt(struct hci_uart
*hu
, u8 pkt_type
,
577 const u8
*data
, size_t len
)
579 struct h5
*h5
= hu
->priv
;
580 struct sk_buff
*nskb
;
584 if (!valid_packet_type(pkt_type
)) {
585 BT_ERR("Unknown packet type %u", pkt_type
);
590 * Max len of packet: (original len + 4 (H5 hdr) + 2 (crc)) * 2
591 * (because bytes 0xc0 and 0xdb are escaped, worst case is when
592 * the packet is all made of 0xc0 and 0xdb) + 2 (0xc0
593 * delimiters at start and end).
595 nskb
= alloc_skb((len
+ 6) * 2 + 2, GFP_ATOMIC
);
599 bt_cb(nskb
)->pkt_type
= pkt_type
;
603 hdr
[0] = h5
->tx_ack
<< 3;
604 h5
->tx_ack_req
= false;
606 /* Reliable packet? */
607 if (pkt_type
== HCI_ACLDATA_PKT
|| pkt_type
== HCI_COMMAND_PKT
) {
609 hdr
[0] |= h5
->tx_seq
;
610 h5
->tx_seq
= (h5
->tx_seq
+ 1) % 8;
613 hdr
[1] = pkt_type
| ((len
& 0x0f) << 4);
615 hdr
[3] = ~((hdr
[0] + hdr
[1] + hdr
[2]) & 0xff);
617 BT_DBG("%s tx: seq %u ack %u crc %u rel %u type %u len %u",
618 hu
->hdev
->name
, H5_HDR_SEQ(hdr
), H5_HDR_ACK(hdr
),
619 H5_HDR_CRC(hdr
), H5_HDR_RELIABLE(hdr
), H5_HDR_PKT_TYPE(hdr
),
622 for (i
= 0; i
< 4; i
++)
623 h5_slip_one_byte(nskb
, hdr
[i
]);
625 for (i
= 0; i
< len
; i
++)
626 h5_slip_one_byte(nskb
, data
[i
]);
633 static struct sk_buff
*h5_dequeue(struct hci_uart
*hu
)
635 struct h5
*h5
= hu
->priv
;
637 struct sk_buff
*skb
, *nskb
;
639 if (h5
->sleep
!= H5_AWAKE
) {
640 const unsigned char wakeup_req
[] = { 0x05, 0xfa };
642 if (h5
->sleep
== H5_WAKING_UP
)
645 h5
->sleep
= H5_WAKING_UP
;
646 BT_DBG("Sending wakeup request");
648 mod_timer(&h5
->timer
, jiffies
+ HZ
/ 100);
649 return h5_prepare_pkt(hu
, HCI_3WIRE_LINK_PKT
, wakeup_req
, 2);
652 if ((skb
= skb_dequeue(&h5
->unrel
)) != NULL
) {
653 nskb
= h5_prepare_pkt(hu
, bt_cb(skb
)->pkt_type
,
654 skb
->data
, skb
->len
);
660 skb_queue_head(&h5
->unrel
, skb
);
661 BT_ERR("Could not dequeue pkt because alloc_skb failed");
664 spin_lock_irqsave_nested(&h5
->unack
.lock
, flags
, SINGLE_DEPTH_NESTING
);
666 if (h5
->unack
.qlen
>= H5_TXWINSIZE
)
669 if ((skb
= skb_dequeue(&h5
->rel
)) != NULL
) {
670 nskb
= h5_prepare_pkt(hu
, bt_cb(skb
)->pkt_type
,
671 skb
->data
, skb
->len
);
673 __skb_queue_tail(&h5
->unack
, skb
);
674 mod_timer(&h5
->timer
, jiffies
+ H5_ACK_TIMEOUT
);
675 spin_unlock_irqrestore(&h5
->unack
.lock
, flags
);
679 skb_queue_head(&h5
->rel
, skb
);
680 BT_ERR("Could not dequeue pkt because alloc_skb failed");
684 spin_unlock_irqrestore(&h5
->unack
.lock
, flags
);
687 return h5_prepare_pkt(hu
, HCI_3WIRE_ACK_PKT
, NULL
, 0);
692 static int h5_flush(struct hci_uart
*hu
)
698 static struct hci_uart_proto h5p
= {
699 .id
= HCI_UART_3WIRE
,
703 .enqueue
= h5_enqueue
,
704 .dequeue
= h5_dequeue
,
708 int __init
h5_init(void)
710 int err
= hci_uart_register_proto(&h5p
);
713 BT_INFO("HCI Three-wire UART (H5) protocol initialized");
715 BT_ERR("HCI Three-wire UART (H5) protocol init failed");
720 int __exit
h5_deinit(void)
722 return hci_uart_unregister_proto(&h5p
);
This page took 0.05032 seconds and 6 git commands to generate.