3 * Bluetooth HCI UART driver for marvell devices
5 * Copyright (C) 2016 Marvell International Ltd.
6 * Copyright (C) 2016 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>
27 #include <linux/firmware.h>
28 #include <linux/module.h>
29 #include <linux/tty.h>
31 #include <net/bluetooth/bluetooth.h>
32 #include <net/bluetooth/hci_core.h>
36 #define HCI_FW_REQ_PKT 0xA5
37 #define HCI_CHIP_VER_PKT 0xAA
41 #define MRVL_RAW_DATA 0x1F
44 STATE_CHIP_VER_PENDING,
49 struct sk_buff *rx_skb;
50 struct sk_buff_head txq;
51 struct sk_buff_head rawq;
61 #define HCI_MRVL_PKT_SIZE 4
63 static int mrvl_open(struct hci_uart *hu)
65 struct mrvl_data *mrvl;
69 if (!hci_uart_has_flow_control(hu))
72 mrvl = kzalloc(sizeof(*mrvl), GFP_KERNEL);
76 skb_queue_head_init(&mrvl->txq);
77 skb_queue_head_init(&mrvl->rawq);
79 set_bit(STATE_CHIP_VER_PENDING, &mrvl->flags);
85 static int mrvl_close(struct hci_uart *hu)
87 struct mrvl_data *mrvl = hu->priv;
91 skb_queue_purge(&mrvl->txq);
92 skb_queue_purge(&mrvl->rawq);
93 kfree_skb(mrvl->rx_skb);
100 static int mrvl_flush(struct hci_uart *hu)
102 struct mrvl_data *mrvl = hu->priv;
106 skb_queue_purge(&mrvl->txq);
107 skb_queue_purge(&mrvl->rawq);
112 static struct sk_buff *mrvl_dequeue(struct hci_uart *hu)
114 struct mrvl_data *mrvl = hu->priv;
117 skb = skb_dequeue(&mrvl->txq);
120 skb = skb_dequeue(&mrvl->rawq);
122 /* Prepend skb with frame type */
123 memcpy(skb_push(skb, 1), &bt_cb(skb)->pkt_type, 1);
129 static int mrvl_enqueue(struct hci_uart *hu, struct sk_buff *skb)
131 struct mrvl_data *mrvl = hu->priv;
133 skb_queue_tail(&mrvl->txq, skb);
137 static void mrvl_send_ack(struct hci_uart *hu, unsigned char type)
139 struct mrvl_data *mrvl = hu->priv;
142 /* No H4 payload, only 1 byte header */
143 skb = bt_skb_alloc(0, GFP_ATOMIC);
145 bt_dev_err(hu->hdev, "Unable to alloc ack/nak packet");
148 hci_skb_pkt_type(skb) = type;
150 skb_queue_tail(&mrvl->txq, skb);
151 hci_uart_tx_wakeup(hu);
154 static int mrvl_recv_fw_req(struct hci_dev *hdev, struct sk_buff *skb)
156 struct hci_mrvl_pkt *pkt = (void *)skb->data;
157 struct hci_uart *hu = hci_get_drvdata(hdev);
158 struct mrvl_data *mrvl = hu->priv;
161 if ((pkt->lhs ^ pkt->rhs) != 0xffff) {
162 bt_dev_err(hdev, "Corrupted mrvl header");
163 mrvl_send_ack(hu, MRVL_NAK);
167 mrvl_send_ack(hu, MRVL_ACK);
169 if (!test_bit(STATE_FW_REQ_PENDING, &mrvl->flags)) {
170 bt_dev_err(hdev, "Received unexpected firmware request");
175 mrvl->tx_len = le16_to_cpu(pkt->lhs);
177 clear_bit(STATE_FW_REQ_PENDING, &mrvl->flags);
178 smp_mb__after_atomic();
179 wake_up_bit(&mrvl->flags, STATE_FW_REQ_PENDING);
186 static int mrvl_recv_chip_ver(struct hci_dev *hdev, struct sk_buff *skb)
188 struct hci_mrvl_pkt *pkt = (void *)skb->data;
189 struct hci_uart *hu = hci_get_drvdata(hdev);
190 struct mrvl_data *mrvl = hu->priv;
191 u16 version = le16_to_cpu(pkt->lhs);
194 if ((pkt->lhs ^ pkt->rhs) != 0xffff) {
195 bt_dev_err(hdev, "Corrupted mrvl header");
196 mrvl_send_ack(hu, MRVL_NAK);
200 mrvl_send_ack(hu, MRVL_ACK);
202 if (!test_bit(STATE_CHIP_VER_PENDING, &mrvl->flags)) {
203 bt_dev_err(hdev, "Received unexpected chip version");
208 mrvl->rev = version >> 8;
210 bt_dev_info(hdev, "Controller id = %x, rev = %x", mrvl->id, mrvl->rev);
212 clear_bit(STATE_CHIP_VER_PENDING, &mrvl->flags);
213 smp_mb__after_atomic();
214 wake_up_bit(&mrvl->flags, STATE_CHIP_VER_PENDING);
221 #define HCI_RECV_CHIP_VER \
222 .type = HCI_CHIP_VER_PKT, \
223 .hlen = HCI_MRVL_PKT_SIZE, \
226 .maxlen = HCI_MRVL_PKT_SIZE
228 #define HCI_RECV_FW_REQ \
229 .type = HCI_FW_REQ_PKT, \
230 .hlen = HCI_MRVL_PKT_SIZE, \
233 .maxlen = HCI_MRVL_PKT_SIZE
235 static const struct h4_recv_pkt mrvl_recv_pkts[] = {
236 { H4_RECV_ACL, .recv = hci_recv_frame },
237 { H4_RECV_SCO, .recv = hci_recv_frame },
238 { H4_RECV_EVENT, .recv = hci_recv_frame },
239 { HCI_RECV_FW_REQ, .recv = mrvl_recv_fw_req },
240 { HCI_RECV_CHIP_VER, .recv = mrvl_recv_chip_ver },
243 static int mrvl_recv(struct hci_uart *hu, const void *data, int count)
245 struct mrvl_data *mrvl = hu->priv;
247 if (!test_bit(HCI_UART_REGISTERED, &hu->flags))
250 mrvl->rx_skb = h4_recv_buf(hu->hdev, mrvl->rx_skb, data, count,
252 ARRAY_SIZE(mrvl_recv_pkts));
253 if (IS_ERR(mrvl->rx_skb)) {
254 int err = PTR_ERR(mrvl->rx_skb);
255 bt_dev_err(hu->hdev, "Frame reassembly failed (%d)", err);
263 static int mrvl_load_firmware(struct hci_dev *hdev, const char *name)
265 struct hci_uart *hu = hci_get_drvdata(hdev);
266 struct mrvl_data *mrvl = hu->priv;
267 const struct firmware *fw = NULL;
268 const u8 *fw_ptr, *fw_max;
271 err = reject_firmware(&fw, name, &hdev->dev);
273 bt_dev_err(hdev, "Failed to load firmware file %s", name);
278 fw_max = fw->data + fw->size;
280 bt_dev_info(hdev, "Loading %s", name);
282 set_bit(STATE_FW_REQ_PENDING, &mrvl->flags);
284 while (fw_ptr <= fw_max) {
287 /* Controller drives the firmware load by sending firmware
288 * request packets containing the expected fragment size.
290 err = wait_on_bit_timeout(&mrvl->flags, STATE_FW_REQ_PENDING,
292 msecs_to_jiffies(2000));
294 bt_dev_err(hdev, "Firmware load interrupted");
298 bt_dev_err(hdev, "Firmware request timeout");
303 bt_dev_dbg(hdev, "Firmware request, expecting %d bytes",
306 if (fw_ptr == fw_max) {
307 /* Controller requests a null size once firmware is
308 * fully loaded. If controller expects more data, there
312 bt_dev_info(hdev, "Firmware loading complete");
314 bt_dev_err(hdev, "Firmware loading failure");
320 if (fw_ptr + mrvl->tx_len > fw_max) {
321 mrvl->tx_len = fw_max - fw_ptr;
322 bt_dev_dbg(hdev, "Adjusting tx_len to %d",
326 skb = bt_skb_alloc(mrvl->tx_len, GFP_KERNEL);
328 bt_dev_err(hdev, "Failed to alloc mem for FW packet");
332 bt_cb(skb)->pkt_type = MRVL_RAW_DATA;
334 skb_put_data(skb, fw_ptr, mrvl->tx_len);
335 fw_ptr += mrvl->tx_len;
337 set_bit(STATE_FW_REQ_PENDING, &mrvl->flags);
339 skb_queue_tail(&mrvl->rawq, skb);
340 hci_uart_tx_wakeup(hu);
343 release_firmware(fw);
347 static int mrvl_setup(struct hci_uart *hu)
351 hci_uart_set_flow_control(hu, true);
353 err = mrvl_load_firmware(hu->hdev, "/*(DEBLOBBED)*/");
355 bt_dev_err(hu->hdev, "Unable to download firmware helper");
359 hci_uart_set_baudrate(hu, 3000000);
360 hci_uart_set_flow_control(hu, false);
362 err = mrvl_load_firmware(hu->hdev, "/*(DEBLOBBED)*/");
369 static const struct hci_uart_proto mrvl_proto = {
372 .init_speed = 115200,
378 .enqueue = mrvl_enqueue,
379 .dequeue = mrvl_dequeue,
382 int __init mrvl_init(void)
384 return hci_uart_register_proto(&mrvl_proto);
387 int __exit mrvl_deinit(void)
389 return hci_uart_unregister_proto(&mrvl_proto);