xref: /linux/drivers/bluetooth/btmtksdio.c (revision 41fb0cf1bced59c1fe178cf6cc9f716b5da9e40e)
1 // SPDX-License-Identifier: GPL-2.0
2 // Copyright (c) 2019 MediaTek Inc.
3 
4 /*
5  * Bluetooth support for MediaTek SDIO devices
6  *
7  * This file is written based on btsdio.c and btmtkuart.c.
8  *
9  * Author: Sean Wang <sean.wang@mediatek.com>
10  *
11  */
12 
13 #include <asm/unaligned.h>
14 #include <linux/atomic.h>
15 #include <linux/init.h>
16 #include <linux/iopoll.h>
17 #include <linux/kernel.h>
18 #include <linux/module.h>
19 #include <linux/pm_runtime.h>
20 #include <linux/skbuff.h>
21 
22 #include <linux/mmc/host.h>
23 #include <linux/mmc/sdio_ids.h>
24 #include <linux/mmc/sdio_func.h>
25 
26 #include <net/bluetooth/bluetooth.h>
27 #include <net/bluetooth/hci_core.h>
28 
29 #include "h4_recv.h"
30 #include "btmtk.h"
31 
32 #define VERSION "0.1"
33 
34 #define MTKBTSDIO_AUTOSUSPEND_DELAY	8000
35 
36 static bool enable_autosuspend;
37 
38 struct btmtksdio_data {
39 	const char *fwname;
40 	u16 chipid;
41 };
42 
43 static const struct btmtksdio_data mt7663_data = {
44 	.fwname = FIRMWARE_MT7663,
45 	.chipid = 0x7663,
46 };
47 
48 static const struct btmtksdio_data mt7668_data = {
49 	.fwname = FIRMWARE_MT7668,
50 	.chipid = 0x7668,
51 };
52 
53 static const struct btmtksdio_data mt7921_data = {
54 	.fwname = FIRMWARE_MT7961,
55 	.chipid = 0x7921,
56 };
57 
58 static const struct sdio_device_id btmtksdio_table[] = {
59 	{SDIO_DEVICE(SDIO_VENDOR_ID_MEDIATEK, SDIO_DEVICE_ID_MEDIATEK_MT7663),
60 	 .driver_data = (kernel_ulong_t)&mt7663_data },
61 	{SDIO_DEVICE(SDIO_VENDOR_ID_MEDIATEK, SDIO_DEVICE_ID_MEDIATEK_MT7668),
62 	 .driver_data = (kernel_ulong_t)&mt7668_data },
63 	{SDIO_DEVICE(SDIO_VENDOR_ID_MEDIATEK, SDIO_DEVICE_ID_MEDIATEK_MT7961),
64 	 .driver_data = (kernel_ulong_t)&mt7921_data },
65 	{ }	/* Terminating entry */
66 };
67 MODULE_DEVICE_TABLE(sdio, btmtksdio_table);
68 
69 #define MTK_REG_CHLPCR		0x4	/* W1S */
70 #define C_INT_EN_SET		BIT(0)
71 #define C_INT_EN_CLR		BIT(1)
72 #define C_FW_OWN_REQ_SET	BIT(8)  /* For write */
73 #define C_COM_DRV_OWN		BIT(8)  /* For read */
74 #define C_FW_OWN_REQ_CLR	BIT(9)
75 
76 #define MTK_REG_CSDIOCSR	0x8
77 #define SDIO_RE_INIT_EN		BIT(0)
78 #define SDIO_INT_CTL		BIT(2)
79 
80 #define MTK_REG_CHCR		0xc
81 #define C_INT_CLR_CTRL		BIT(1)
82 
83 /* CHISR have the same bits field definition with CHIER */
84 #define MTK_REG_CHISR		0x10
85 #define MTK_REG_CHIER		0x14
86 #define FW_OWN_BACK_INT		BIT(0)
87 #define RX_DONE_INT		BIT(1)
88 #define TX_EMPTY		BIT(2)
89 #define TX_FIFO_OVERFLOW	BIT(8)
90 #define RX_PKT_LEN		GENMASK(31, 16)
91 
92 #define MTK_REG_CTDR		0x18
93 
94 #define MTK_REG_CRDR		0x1c
95 
96 #define MTK_REG_CRPLR		0x24
97 
98 #define MTK_SDIO_BLOCK_SIZE	256
99 
100 #define BTMTKSDIO_TX_WAIT_VND_EVT	1
101 
102 struct mtkbtsdio_hdr {
103 	__le16	len;
104 	__le16	reserved;
105 	u8	bt_type;
106 } __packed;
107 
108 struct btmtksdio_dev {
109 	struct hci_dev *hdev;
110 	struct sdio_func *func;
111 	struct device *dev;
112 
113 	struct work_struct txrx_work;
114 	unsigned long tx_state;
115 	struct sk_buff_head txq;
116 	bool hw_tx_ready;
117 
118 	struct sk_buff *evt_skb;
119 
120 	const struct btmtksdio_data *data;
121 };
122 
123 static int mtk_hci_wmt_sync(struct hci_dev *hdev,
124 			    struct btmtk_hci_wmt_params *wmt_params)
125 {
126 	struct btmtksdio_dev *bdev = hci_get_drvdata(hdev);
127 	struct btmtk_hci_wmt_evt_funcc *wmt_evt_funcc;
128 	struct btmtk_hci_wmt_evt_reg *wmt_evt_reg;
129 	u32 hlen, status = BTMTK_WMT_INVALID;
130 	struct btmtk_hci_wmt_evt *wmt_evt;
131 	struct btmtk_hci_wmt_cmd *wc;
132 	struct btmtk_wmt_hdr *hdr;
133 	int err;
134 
135 	/* Send the WMT command and wait until the WMT event returns */
136 	hlen = sizeof(*hdr) + wmt_params->dlen;
137 	if (hlen > 255)
138 		return -EINVAL;
139 
140 	wc = kzalloc(hlen, GFP_KERNEL);
141 	if (!wc)
142 		return -ENOMEM;
143 
144 	hdr = &wc->hdr;
145 	hdr->dir = 1;
146 	hdr->op = wmt_params->op;
147 	hdr->dlen = cpu_to_le16(wmt_params->dlen + 1);
148 	hdr->flag = wmt_params->flag;
149 	memcpy(wc->data, wmt_params->data, wmt_params->dlen);
150 
151 	set_bit(BTMTKSDIO_TX_WAIT_VND_EVT, &bdev->tx_state);
152 
153 	err = __hci_cmd_send(hdev, 0xfc6f, hlen, wc);
154 	if (err < 0) {
155 		clear_bit(BTMTKSDIO_TX_WAIT_VND_EVT, &bdev->tx_state);
156 		goto err_free_wc;
157 	}
158 
159 	/* The vendor specific WMT commands are all answered by a vendor
160 	 * specific event and will not have the Command Status or Command
161 	 * Complete as with usual HCI command flow control.
162 	 *
163 	 * After sending the command, wait for BTMTKSDIO_TX_WAIT_VND_EVT
164 	 * state to be cleared. The driver specific event receive routine
165 	 * will clear that state and with that indicate completion of the
166 	 * WMT command.
167 	 */
168 	err = wait_on_bit_timeout(&bdev->tx_state, BTMTKSDIO_TX_WAIT_VND_EVT,
169 				  TASK_INTERRUPTIBLE, HCI_INIT_TIMEOUT);
170 	if (err == -EINTR) {
171 		bt_dev_err(hdev, "Execution of wmt command interrupted");
172 		clear_bit(BTMTKSDIO_TX_WAIT_VND_EVT, &bdev->tx_state);
173 		goto err_free_wc;
174 	}
175 
176 	if (err) {
177 		bt_dev_err(hdev, "Execution of wmt command timed out");
178 		clear_bit(BTMTKSDIO_TX_WAIT_VND_EVT, &bdev->tx_state);
179 		err = -ETIMEDOUT;
180 		goto err_free_wc;
181 	}
182 
183 	/* Parse and handle the return WMT event */
184 	wmt_evt = (struct btmtk_hci_wmt_evt *)bdev->evt_skb->data;
185 	if (wmt_evt->whdr.op != hdr->op) {
186 		bt_dev_err(hdev, "Wrong op received %d expected %d",
187 			   wmt_evt->whdr.op, hdr->op);
188 		err = -EIO;
189 		goto err_free_skb;
190 	}
191 
192 	switch (wmt_evt->whdr.op) {
193 	case BTMTK_WMT_SEMAPHORE:
194 		if (wmt_evt->whdr.flag == 2)
195 			status = BTMTK_WMT_PATCH_UNDONE;
196 		else
197 			status = BTMTK_WMT_PATCH_DONE;
198 		break;
199 	case BTMTK_WMT_FUNC_CTRL:
200 		wmt_evt_funcc = (struct btmtk_hci_wmt_evt_funcc *)wmt_evt;
201 		if (be16_to_cpu(wmt_evt_funcc->status) == 0x404)
202 			status = BTMTK_WMT_ON_DONE;
203 		else if (be16_to_cpu(wmt_evt_funcc->status) == 0x420)
204 			status = BTMTK_WMT_ON_PROGRESS;
205 		else
206 			status = BTMTK_WMT_ON_UNDONE;
207 		break;
208 	case BTMTK_WMT_PATCH_DWNLD:
209 		if (wmt_evt->whdr.flag == 2)
210 			status = BTMTK_WMT_PATCH_DONE;
211 		else if (wmt_evt->whdr.flag == 1)
212 			status = BTMTK_WMT_PATCH_PROGRESS;
213 		else
214 			status = BTMTK_WMT_PATCH_UNDONE;
215 		break;
216 	case BTMTK_WMT_REGISTER:
217 		wmt_evt_reg = (struct btmtk_hci_wmt_evt_reg *)wmt_evt;
218 		if (le16_to_cpu(wmt_evt->whdr.dlen) == 12)
219 			status = le32_to_cpu(wmt_evt_reg->val);
220 		break;
221 	}
222 
223 	if (wmt_params->status)
224 		*wmt_params->status = status;
225 
226 err_free_skb:
227 	kfree_skb(bdev->evt_skb);
228 	bdev->evt_skb = NULL;
229 err_free_wc:
230 	kfree(wc);
231 
232 	return err;
233 }
234 
235 static int btmtksdio_tx_packet(struct btmtksdio_dev *bdev,
236 			       struct sk_buff *skb)
237 {
238 	struct mtkbtsdio_hdr *sdio_hdr;
239 	int err;
240 
241 	/* Make sure that there are enough rooms for SDIO header */
242 	if (unlikely(skb_headroom(skb) < sizeof(*sdio_hdr))) {
243 		err = pskb_expand_head(skb, sizeof(*sdio_hdr), 0,
244 				       GFP_ATOMIC);
245 		if (err < 0)
246 			return err;
247 	}
248 
249 	/* Prepend MediaTek SDIO Specific Header */
250 	skb_push(skb, sizeof(*sdio_hdr));
251 
252 	sdio_hdr = (void *)skb->data;
253 	sdio_hdr->len = cpu_to_le16(skb->len);
254 	sdio_hdr->reserved = cpu_to_le16(0);
255 	sdio_hdr->bt_type = hci_skb_pkt_type(skb);
256 
257 	bdev->hw_tx_ready = false;
258 	err = sdio_writesb(bdev->func, MTK_REG_CTDR, skb->data,
259 			   round_up(skb->len, MTK_SDIO_BLOCK_SIZE));
260 	if (err < 0)
261 		goto err_skb_pull;
262 
263 	bdev->hdev->stat.byte_tx += skb->len;
264 
265 	kfree_skb(skb);
266 
267 	return 0;
268 
269 err_skb_pull:
270 	skb_pull(skb, sizeof(*sdio_hdr));
271 
272 	return err;
273 }
274 
275 static u32 btmtksdio_drv_own_query(struct btmtksdio_dev *bdev)
276 {
277 	return sdio_readl(bdev->func, MTK_REG_CHLPCR, NULL);
278 }
279 
280 static int btmtksdio_recv_event(struct hci_dev *hdev, struct sk_buff *skb)
281 {
282 	struct btmtksdio_dev *bdev = hci_get_drvdata(hdev);
283 	struct hci_event_hdr *hdr = (void *)skb->data;
284 	int err;
285 
286 	/* Fix up the vendor event id with 0xff for vendor specific instead
287 	 * of 0xe4 so that event send via monitoring socket can be parsed
288 	 * properly.
289 	 */
290 	if (hdr->evt == 0xe4)
291 		hdr->evt = HCI_EV_VENDOR;
292 
293 	/* When someone waits for the WMT event, the skb is being cloned
294 	 * and being processed the events from there then.
295 	 */
296 	if (test_bit(BTMTKSDIO_TX_WAIT_VND_EVT, &bdev->tx_state)) {
297 		bdev->evt_skb = skb_clone(skb, GFP_KERNEL);
298 		if (!bdev->evt_skb) {
299 			err = -ENOMEM;
300 			goto err_out;
301 		}
302 	}
303 
304 	err = hci_recv_frame(hdev, skb);
305 	if (err < 0)
306 		goto err_free_skb;
307 
308 	if (hdr->evt == HCI_EV_VENDOR) {
309 		if (test_and_clear_bit(BTMTKSDIO_TX_WAIT_VND_EVT,
310 				       &bdev->tx_state)) {
311 			/* Barrier to sync with other CPUs */
312 			smp_mb__after_atomic();
313 			wake_up_bit(&bdev->tx_state, BTMTKSDIO_TX_WAIT_VND_EVT);
314 		}
315 	}
316 
317 	return 0;
318 
319 err_free_skb:
320 	kfree_skb(bdev->evt_skb);
321 	bdev->evt_skb = NULL;
322 
323 err_out:
324 	return err;
325 }
326 
327 static const struct h4_recv_pkt mtk_recv_pkts[] = {
328 	{ H4_RECV_ACL,      .recv = hci_recv_frame },
329 	{ H4_RECV_SCO,      .recv = hci_recv_frame },
330 	{ H4_RECV_EVENT,    .recv = btmtksdio_recv_event },
331 };
332 
333 static int btmtksdio_rx_packet(struct btmtksdio_dev *bdev, u16 rx_size)
334 {
335 	const struct h4_recv_pkt *pkts = mtk_recv_pkts;
336 	int pkts_count = ARRAY_SIZE(mtk_recv_pkts);
337 	struct mtkbtsdio_hdr *sdio_hdr;
338 	int err, i, pad_size;
339 	struct sk_buff *skb;
340 	u16 dlen;
341 
342 	if (rx_size < sizeof(*sdio_hdr))
343 		return -EILSEQ;
344 
345 	/* A SDIO packet is exactly containing a Bluetooth packet */
346 	skb = bt_skb_alloc(rx_size, GFP_KERNEL);
347 	if (!skb)
348 		return -ENOMEM;
349 
350 	skb_put(skb, rx_size);
351 
352 	err = sdio_readsb(bdev->func, skb->data, MTK_REG_CRDR, rx_size);
353 	if (err < 0)
354 		goto err_kfree_skb;
355 
356 	sdio_hdr = (void *)skb->data;
357 
358 	/* We assume the default error as -EILSEQ simply to make the error path
359 	 * be cleaner.
360 	 */
361 	err = -EILSEQ;
362 
363 	if (rx_size != le16_to_cpu(sdio_hdr->len)) {
364 		bt_dev_err(bdev->hdev, "Rx size in sdio header is mismatched ");
365 		goto err_kfree_skb;
366 	}
367 
368 	hci_skb_pkt_type(skb) = sdio_hdr->bt_type;
369 
370 	/* Remove MediaTek SDIO header */
371 	skb_pull(skb, sizeof(*sdio_hdr));
372 
373 	/* We have to dig into the packet to get payload size and then know how
374 	 * many padding bytes at the tail, these padding bytes should be removed
375 	 * before the packet is indicated to the core layer.
376 	 */
377 	for (i = 0; i < pkts_count; i++) {
378 		if (sdio_hdr->bt_type == (&pkts[i])->type)
379 			break;
380 	}
381 
382 	if (i >= pkts_count) {
383 		bt_dev_err(bdev->hdev, "Invalid bt type 0x%02x",
384 			   sdio_hdr->bt_type);
385 		goto err_kfree_skb;
386 	}
387 
388 	/* Remaining bytes cannot hold a header*/
389 	if (skb->len < (&pkts[i])->hlen) {
390 		bt_dev_err(bdev->hdev, "The size of bt header is mismatched");
391 		goto err_kfree_skb;
392 	}
393 
394 	switch ((&pkts[i])->lsize) {
395 	case 1:
396 		dlen = skb->data[(&pkts[i])->loff];
397 		break;
398 	case 2:
399 		dlen = get_unaligned_le16(skb->data +
400 						  (&pkts[i])->loff);
401 		break;
402 	default:
403 		goto err_kfree_skb;
404 	}
405 
406 	pad_size = skb->len - (&pkts[i])->hlen -  dlen;
407 
408 	/* Remaining bytes cannot hold a payload */
409 	if (pad_size < 0) {
410 		bt_dev_err(bdev->hdev, "The size of bt payload is mismatched");
411 		goto err_kfree_skb;
412 	}
413 
414 	/* Remove padding bytes */
415 	skb_trim(skb, skb->len - pad_size);
416 
417 	/* Complete frame */
418 	(&pkts[i])->recv(bdev->hdev, skb);
419 
420 	bdev->hdev->stat.byte_rx += rx_size;
421 
422 	return 0;
423 
424 err_kfree_skb:
425 	kfree_skb(skb);
426 
427 	return err;
428 }
429 
430 static void btmtksdio_txrx_work(struct work_struct *work)
431 {
432 	struct btmtksdio_dev *bdev = container_of(work, struct btmtksdio_dev,
433 						  txrx_work);
434 	unsigned long txrx_timeout;
435 	u32 int_status, rx_size;
436 	struct sk_buff *skb;
437 	int err;
438 
439 	pm_runtime_get_sync(bdev->dev);
440 
441 	sdio_claim_host(bdev->func);
442 
443 	/* Disable interrupt */
444 	sdio_writel(bdev->func, C_INT_EN_CLR, MTK_REG_CHLPCR, 0);
445 
446 	txrx_timeout = jiffies + 5 * HZ;
447 
448 	do {
449 		int_status = sdio_readl(bdev->func, MTK_REG_CHISR, NULL);
450 
451 		/* Ack an interrupt as soon as possible before any operation on
452 		 * hardware.
453 		 *
454 		 * Note that we don't ack any status during operations to avoid race
455 		 * condition between the host and the device such as it's possible to
456 		 * mistakenly ack RX_DONE for the next packet and then cause interrupts
457 		 * not be raised again but there is still pending data in the hardware
458 		 * FIFO.
459 		 */
460 		sdio_writel(bdev->func, int_status, MTK_REG_CHISR, NULL);
461 
462 		if (int_status & FW_OWN_BACK_INT)
463 			bt_dev_dbg(bdev->hdev, "Get fw own back");
464 
465 		if (int_status & TX_EMPTY)
466 			bdev->hw_tx_ready = true;
467 		else if (unlikely(int_status & TX_FIFO_OVERFLOW))
468 			bt_dev_warn(bdev->hdev, "Tx fifo overflow");
469 
470 		if (bdev->hw_tx_ready) {
471 			skb = skb_dequeue(&bdev->txq);
472 			if (skb) {
473 				err = btmtksdio_tx_packet(bdev, skb);
474 				if (err < 0) {
475 					bdev->hdev->stat.err_tx++;
476 					skb_queue_head(&bdev->txq, skb);
477 				}
478 			}
479 		}
480 
481 		if (int_status & RX_DONE_INT) {
482 			rx_size = sdio_readl(bdev->func, MTK_REG_CRPLR, NULL);
483 			rx_size = (rx_size & RX_PKT_LEN) >> 16;
484 			if (btmtksdio_rx_packet(bdev, rx_size) < 0)
485 				bdev->hdev->stat.err_rx++;
486 		}
487 	} while (int_status || time_is_before_jiffies(txrx_timeout));
488 
489 	/* Enable interrupt */
490 	sdio_writel(bdev->func, C_INT_EN_SET, MTK_REG_CHLPCR, 0);
491 
492 	sdio_release_host(bdev->func);
493 
494 	pm_runtime_mark_last_busy(bdev->dev);
495 	pm_runtime_put_autosuspend(bdev->dev);
496 }
497 
498 static void btmtksdio_interrupt(struct sdio_func *func)
499 {
500 	struct btmtksdio_dev *bdev = sdio_get_drvdata(func);
501 
502 	/* Disable interrupt */
503 	sdio_writel(bdev->func, C_INT_EN_CLR, MTK_REG_CHLPCR, 0);
504 
505 	schedule_work(&bdev->txrx_work);
506 }
507 
508 static int btmtksdio_open(struct hci_dev *hdev)
509 {
510 	struct btmtksdio_dev *bdev = hci_get_drvdata(hdev);
511 	u32 status, val;
512 	int err;
513 
514 	sdio_claim_host(bdev->func);
515 
516 	err = sdio_enable_func(bdev->func);
517 	if (err < 0)
518 		goto err_release_host;
519 
520 	/* Get ownership from the device */
521 	sdio_writel(bdev->func, C_FW_OWN_REQ_CLR, MTK_REG_CHLPCR, &err);
522 	if (err < 0)
523 		goto err_disable_func;
524 
525 	err = readx_poll_timeout(btmtksdio_drv_own_query, bdev, status,
526 				 status & C_COM_DRV_OWN, 2000, 1000000);
527 	if (err < 0) {
528 		bt_dev_err(bdev->hdev, "Cannot get ownership from device");
529 		goto err_disable_func;
530 	}
531 
532 	/* Disable interrupt & mask out all interrupt sources */
533 	sdio_writel(bdev->func, C_INT_EN_CLR, MTK_REG_CHLPCR, &err);
534 	if (err < 0)
535 		goto err_disable_func;
536 
537 	sdio_writel(bdev->func, 0, MTK_REG_CHIER, &err);
538 	if (err < 0)
539 		goto err_disable_func;
540 
541 	err = sdio_claim_irq(bdev->func, btmtksdio_interrupt);
542 	if (err < 0)
543 		goto err_disable_func;
544 
545 	err = sdio_set_block_size(bdev->func, MTK_SDIO_BLOCK_SIZE);
546 	if (err < 0)
547 		goto err_release_irq;
548 
549 	/* SDIO CMD 5 allows the SDIO device back to idle state an
550 	 * synchronous interrupt is supported in SDIO 4-bit mode
551 	 */
552 	val = sdio_readl(bdev->func, MTK_REG_CSDIOCSR, &err);
553 	if (err < 0)
554 		goto err_release_irq;
555 
556 	val |= SDIO_INT_CTL;
557 	sdio_writel(bdev->func, val, MTK_REG_CSDIOCSR, &err);
558 	if (err < 0)
559 		goto err_release_irq;
560 
561 	/* Explitly set write-1-clear method */
562 	val = sdio_readl(bdev->func, MTK_REG_CHCR, &err);
563 	if (err < 0)
564 		goto err_release_irq;
565 
566 	val |= C_INT_CLR_CTRL;
567 	sdio_writel(bdev->func, val, MTK_REG_CHCR, &err);
568 	if (err < 0)
569 		goto err_release_irq;
570 
571 	/* Setup interrupt sources */
572 	sdio_writel(bdev->func, RX_DONE_INT | TX_EMPTY | TX_FIFO_OVERFLOW,
573 		    MTK_REG_CHIER, &err);
574 	if (err < 0)
575 		goto err_release_irq;
576 
577 	/* Enable interrupt */
578 	sdio_writel(bdev->func, C_INT_EN_SET, MTK_REG_CHLPCR, &err);
579 	if (err < 0)
580 		goto err_release_irq;
581 
582 	sdio_release_host(bdev->func);
583 
584 	return 0;
585 
586 err_release_irq:
587 	sdio_release_irq(bdev->func);
588 
589 err_disable_func:
590 	sdio_disable_func(bdev->func);
591 
592 err_release_host:
593 	sdio_release_host(bdev->func);
594 
595 	return err;
596 }
597 
598 static int btmtksdio_close(struct hci_dev *hdev)
599 {
600 	struct btmtksdio_dev *bdev = hci_get_drvdata(hdev);
601 	u32 status;
602 	int err;
603 
604 	sdio_claim_host(bdev->func);
605 
606 	/* Disable interrupt */
607 	sdio_writel(bdev->func, C_INT_EN_CLR, MTK_REG_CHLPCR, NULL);
608 
609 	sdio_release_irq(bdev->func);
610 
611 	cancel_work_sync(&bdev->txrx_work);
612 
613 	/* Return ownership to the device */
614 	sdio_writel(bdev->func, C_FW_OWN_REQ_SET, MTK_REG_CHLPCR, NULL);
615 
616 	err = readx_poll_timeout(btmtksdio_drv_own_query, bdev, status,
617 				 !(status & C_COM_DRV_OWN), 2000, 1000000);
618 	if (err < 0)
619 		bt_dev_err(bdev->hdev, "Cannot return ownership to device");
620 
621 	sdio_disable_func(bdev->func);
622 
623 	sdio_release_host(bdev->func);
624 
625 	return 0;
626 }
627 
628 static int btmtksdio_flush(struct hci_dev *hdev)
629 {
630 	struct btmtksdio_dev *bdev = hci_get_drvdata(hdev);
631 
632 	skb_queue_purge(&bdev->txq);
633 
634 	cancel_work_sync(&bdev->txrx_work);
635 
636 	return 0;
637 }
638 
639 static int btmtksdio_func_query(struct hci_dev *hdev)
640 {
641 	struct btmtk_hci_wmt_params wmt_params;
642 	int status, err;
643 	u8 param = 0;
644 
645 	/* Query whether the function is enabled */
646 	wmt_params.op = BTMTK_WMT_FUNC_CTRL;
647 	wmt_params.flag = 4;
648 	wmt_params.dlen = sizeof(param);
649 	wmt_params.data = &param;
650 	wmt_params.status = &status;
651 
652 	err = mtk_hci_wmt_sync(hdev, &wmt_params);
653 	if (err < 0) {
654 		bt_dev_err(hdev, "Failed to query function status (%d)", err);
655 		return err;
656 	}
657 
658 	return status;
659 }
660 
661 static int mt76xx_setup(struct hci_dev *hdev, const char *fwname)
662 {
663 	struct btmtk_hci_wmt_params wmt_params;
664 	struct btmtk_tci_sleep tci_sleep;
665 	struct sk_buff *skb;
666 	int err, status;
667 	u8 param = 0x1;
668 
669 	/* Query whether the firmware is already download */
670 	wmt_params.op = BTMTK_WMT_SEMAPHORE;
671 	wmt_params.flag = 1;
672 	wmt_params.dlen = 0;
673 	wmt_params.data = NULL;
674 	wmt_params.status = &status;
675 
676 	err = mtk_hci_wmt_sync(hdev, &wmt_params);
677 	if (err < 0) {
678 		bt_dev_err(hdev, "Failed to query firmware status (%d)", err);
679 		return err;
680 	}
681 
682 	if (status == BTMTK_WMT_PATCH_DONE) {
683 		bt_dev_info(hdev, "Firmware already downloaded");
684 		goto ignore_setup_fw;
685 	}
686 
687 	/* Setup a firmware which the device definitely requires */
688 	err = btmtk_setup_firmware(hdev, fwname, mtk_hci_wmt_sync);
689 	if (err < 0)
690 		return err;
691 
692 ignore_setup_fw:
693 	/* Query whether the device is already enabled */
694 	err = readx_poll_timeout(btmtksdio_func_query, hdev, status,
695 				 status < 0 || status != BTMTK_WMT_ON_PROGRESS,
696 				 2000, 5000000);
697 	/* -ETIMEDOUT happens */
698 	if (err < 0)
699 		return err;
700 
701 	/* The other errors happen in btusb_mtk_func_query */
702 	if (status < 0)
703 		return status;
704 
705 	if (status == BTMTK_WMT_ON_DONE) {
706 		bt_dev_info(hdev, "function already on");
707 		goto ignore_func_on;
708 	}
709 
710 	/* Enable Bluetooth protocol */
711 	wmt_params.op = BTMTK_WMT_FUNC_CTRL;
712 	wmt_params.flag = 0;
713 	wmt_params.dlen = sizeof(param);
714 	wmt_params.data = &param;
715 	wmt_params.status = NULL;
716 
717 	err = mtk_hci_wmt_sync(hdev, &wmt_params);
718 	if (err < 0) {
719 		bt_dev_err(hdev, "Failed to send wmt func ctrl (%d)", err);
720 		return err;
721 	}
722 
723 ignore_func_on:
724 	/* Apply the low power environment setup */
725 	tci_sleep.mode = 0x5;
726 	tci_sleep.duration = cpu_to_le16(0x640);
727 	tci_sleep.host_duration = cpu_to_le16(0x640);
728 	tci_sleep.host_wakeup_pin = 0;
729 	tci_sleep.time_compensation = 0;
730 
731 	skb = __hci_cmd_sync(hdev, 0xfc7a, sizeof(tci_sleep), &tci_sleep,
732 			     HCI_INIT_TIMEOUT);
733 	if (IS_ERR(skb)) {
734 		err = PTR_ERR(skb);
735 		bt_dev_err(hdev, "Failed to apply low power setting (%d)", err);
736 		return err;
737 	}
738 	kfree_skb(skb);
739 
740 	return 0;
741 }
742 
743 static int mt79xx_setup(struct hci_dev *hdev, const char *fwname)
744 {
745 	struct btmtk_hci_wmt_params wmt_params;
746 	u8 param = 0x1;
747 	int err;
748 
749 	err = btmtk_setup_firmware_79xx(hdev, fwname, mtk_hci_wmt_sync);
750 	if (err < 0) {
751 		bt_dev_err(hdev, "Failed to setup 79xx firmware (%d)", err);
752 		return err;
753 	}
754 
755 	/* Enable Bluetooth protocol */
756 	wmt_params.op = BTMTK_WMT_FUNC_CTRL;
757 	wmt_params.flag = 0;
758 	wmt_params.dlen = sizeof(param);
759 	wmt_params.data = &param;
760 	wmt_params.status = NULL;
761 
762 	err = mtk_hci_wmt_sync(hdev, &wmt_params);
763 	if (err < 0) {
764 		bt_dev_err(hdev, "Failed to send wmt func ctrl (%d)", err);
765 		return err;
766 	}
767 
768 	return err;
769 }
770 
771 static int btsdio_mtk_reg_read(struct hci_dev *hdev, u32 reg, u32 *val)
772 {
773 	struct btmtk_hci_wmt_params wmt_params;
774 	struct reg_read_cmd {
775 		u8 type;
776 		u8 rsv;
777 		u8 num;
778 		__le32 addr;
779 	} __packed reg_read = {
780 		.type = 1,
781 		.num = 1,
782 	};
783 	u32 status;
784 	int err;
785 
786 	reg_read.addr = cpu_to_le32(reg);
787 	wmt_params.op = BTMTK_WMT_REGISTER;
788 	wmt_params.flag = BTMTK_WMT_REG_READ;
789 	wmt_params.dlen = sizeof(reg_read);
790 	wmt_params.data = &reg_read;
791 	wmt_params.status = &status;
792 
793 	err = mtk_hci_wmt_sync(hdev, &wmt_params);
794 	if (err < 0) {
795 		bt_dev_err(hdev, "Failed to read reg(%d)", err);
796 		return err;
797 	}
798 
799 	*val = status;
800 
801 	return err;
802 }
803 
804 static int btmtksdio_setup(struct hci_dev *hdev)
805 {
806 	struct btmtksdio_dev *bdev = hci_get_drvdata(hdev);
807 	ktime_t calltime, delta, rettime;
808 	unsigned long long duration;
809 	char fwname[64];
810 	int err, dev_id;
811 	u32 fw_version = 0;
812 
813 	calltime = ktime_get();
814 	bdev->hw_tx_ready = true;
815 
816 	switch (bdev->data->chipid) {
817 	case 0x7921:
818 		err = btsdio_mtk_reg_read(hdev, 0x70010200, &dev_id);
819 		if (err < 0) {
820 			bt_dev_err(hdev, "Failed to get device id (%d)", err);
821 			return err;
822 		}
823 
824 		err = btsdio_mtk_reg_read(hdev, 0x80021004, &fw_version);
825 		if (err < 0) {
826 			bt_dev_err(hdev, "Failed to get fw version (%d)", err);
827 			return err;
828 		}
829 
830 		snprintf(fwname, sizeof(fwname),
831 			 "mediatek/BT_RAM_CODE_MT%04x_1_%x_hdr.bin",
832 			 dev_id & 0xffff, (fw_version & 0xff) + 1);
833 		err = mt79xx_setup(hdev, fwname);
834 		if (err < 0)
835 			return err;
836 		break;
837 	case 0x7663:
838 	case 0x7668:
839 		err = mt76xx_setup(hdev, bdev->data->fwname);
840 		if (err < 0)
841 			return err;
842 		break;
843 	default:
844 		return -ENODEV;
845 	}
846 
847 	rettime = ktime_get();
848 	delta = ktime_sub(rettime, calltime);
849 	duration = (unsigned long long)ktime_to_ns(delta) >> 10;
850 
851 	pm_runtime_set_autosuspend_delay(bdev->dev,
852 					 MTKBTSDIO_AUTOSUSPEND_DELAY);
853 	pm_runtime_use_autosuspend(bdev->dev);
854 
855 	err = pm_runtime_set_active(bdev->dev);
856 	if (err < 0)
857 		return err;
858 
859 	/* Default forbid runtime auto suspend, that can be allowed by
860 	 * enable_autosuspend flag or the PM runtime entry under sysfs.
861 	 */
862 	pm_runtime_forbid(bdev->dev);
863 	pm_runtime_enable(bdev->dev);
864 
865 	if (enable_autosuspend)
866 		pm_runtime_allow(bdev->dev);
867 
868 	bt_dev_info(hdev, "Device setup in %llu usecs", duration);
869 
870 	return 0;
871 }
872 
873 static int btmtksdio_shutdown(struct hci_dev *hdev)
874 {
875 	struct btmtksdio_dev *bdev = hci_get_drvdata(hdev);
876 	struct btmtk_hci_wmt_params wmt_params;
877 	u8 param = 0x0;
878 	int err;
879 
880 	/* Get back the state to be consistent with the state
881 	 * in btmtksdio_setup.
882 	 */
883 	pm_runtime_get_sync(bdev->dev);
884 
885 	/* Disable the device */
886 	wmt_params.op = BTMTK_WMT_FUNC_CTRL;
887 	wmt_params.flag = 0;
888 	wmt_params.dlen = sizeof(param);
889 	wmt_params.data = &param;
890 	wmt_params.status = NULL;
891 
892 	err = mtk_hci_wmt_sync(hdev, &wmt_params);
893 	if (err < 0) {
894 		bt_dev_err(hdev, "Failed to send wmt func ctrl (%d)", err);
895 		return err;
896 	}
897 
898 	pm_runtime_put_noidle(bdev->dev);
899 	pm_runtime_disable(bdev->dev);
900 
901 	return 0;
902 }
903 
904 static int btmtksdio_send_frame(struct hci_dev *hdev, struct sk_buff *skb)
905 {
906 	struct btmtksdio_dev *bdev = hci_get_drvdata(hdev);
907 
908 	switch (hci_skb_pkt_type(skb)) {
909 	case HCI_COMMAND_PKT:
910 		hdev->stat.cmd_tx++;
911 		break;
912 
913 	case HCI_ACLDATA_PKT:
914 		hdev->stat.acl_tx++;
915 		break;
916 
917 	case HCI_SCODATA_PKT:
918 		hdev->stat.sco_tx++;
919 		break;
920 
921 	default:
922 		return -EILSEQ;
923 	}
924 
925 	skb_queue_tail(&bdev->txq, skb);
926 
927 	schedule_work(&bdev->txrx_work);
928 
929 	return 0;
930 }
931 
932 static int btmtksdio_probe(struct sdio_func *func,
933 			   const struct sdio_device_id *id)
934 {
935 	struct btmtksdio_dev *bdev;
936 	struct hci_dev *hdev;
937 	int err;
938 
939 	bdev = devm_kzalloc(&func->dev, sizeof(*bdev), GFP_KERNEL);
940 	if (!bdev)
941 		return -ENOMEM;
942 
943 	bdev->data = (void *)id->driver_data;
944 	if (!bdev->data)
945 		return -ENODEV;
946 
947 	bdev->dev = &func->dev;
948 	bdev->func = func;
949 
950 	INIT_WORK(&bdev->txrx_work, btmtksdio_txrx_work);
951 	skb_queue_head_init(&bdev->txq);
952 
953 	/* Initialize and register HCI device */
954 	hdev = hci_alloc_dev();
955 	if (!hdev) {
956 		dev_err(&func->dev, "Can't allocate HCI device\n");
957 		return -ENOMEM;
958 	}
959 
960 	bdev->hdev = hdev;
961 
962 	hdev->bus = HCI_SDIO;
963 	hci_set_drvdata(hdev, bdev);
964 
965 	hdev->open     = btmtksdio_open;
966 	hdev->close    = btmtksdio_close;
967 	hdev->flush    = btmtksdio_flush;
968 	hdev->setup    = btmtksdio_setup;
969 	hdev->shutdown = btmtksdio_shutdown;
970 	hdev->send     = btmtksdio_send_frame;
971 	hdev->set_bdaddr = btmtk_set_bdaddr;
972 
973 	SET_HCIDEV_DEV(hdev, &func->dev);
974 
975 	hdev->manufacturer = 70;
976 	set_bit(HCI_QUIRK_NON_PERSISTENT_SETUP, &hdev->quirks);
977 
978 	err = hci_register_dev(hdev);
979 	if (err < 0) {
980 		dev_err(&func->dev, "Can't register HCI device\n");
981 		hci_free_dev(hdev);
982 		return err;
983 	}
984 
985 	sdio_set_drvdata(func, bdev);
986 
987 	/* pm_runtime_enable would be done after the firmware is being
988 	 * downloaded because the core layer probably already enables
989 	 * runtime PM for this func such as the case host->caps &
990 	 * MMC_CAP_POWER_OFF_CARD.
991 	 */
992 	if (pm_runtime_enabled(bdev->dev))
993 		pm_runtime_disable(bdev->dev);
994 
995 	/* As explaination in drivers/mmc/core/sdio_bus.c tells us:
996 	 * Unbound SDIO functions are always suspended.
997 	 * During probe, the function is set active and the usage count
998 	 * is incremented.  If the driver supports runtime PM,
999 	 * it should call pm_runtime_put_noidle() in its probe routine and
1000 	 * pm_runtime_get_noresume() in its remove routine.
1001 	 *
1002 	 * So, put a pm_runtime_put_noidle here !
1003 	 */
1004 	pm_runtime_put_noidle(bdev->dev);
1005 
1006 	return 0;
1007 }
1008 
1009 static void btmtksdio_remove(struct sdio_func *func)
1010 {
1011 	struct btmtksdio_dev *bdev = sdio_get_drvdata(func);
1012 	struct hci_dev *hdev;
1013 
1014 	if (!bdev)
1015 		return;
1016 
1017 	/* Be consistent the state in btmtksdio_probe */
1018 	pm_runtime_get_noresume(bdev->dev);
1019 
1020 	hdev = bdev->hdev;
1021 
1022 	sdio_set_drvdata(func, NULL);
1023 	hci_unregister_dev(hdev);
1024 	hci_free_dev(hdev);
1025 }
1026 
1027 #ifdef CONFIG_PM
1028 static int btmtksdio_runtime_suspend(struct device *dev)
1029 {
1030 	struct sdio_func *func = dev_to_sdio_func(dev);
1031 	struct btmtksdio_dev *bdev;
1032 	u32 status;
1033 	int err;
1034 
1035 	bdev = sdio_get_drvdata(func);
1036 	if (!bdev)
1037 		return 0;
1038 
1039 	sdio_claim_host(bdev->func);
1040 
1041 	sdio_writel(bdev->func, C_FW_OWN_REQ_SET, MTK_REG_CHLPCR, &err);
1042 	if (err < 0)
1043 		goto out;
1044 
1045 	err = readx_poll_timeout(btmtksdio_drv_own_query, bdev, status,
1046 				 !(status & C_COM_DRV_OWN), 2000, 1000000);
1047 out:
1048 	bt_dev_info(bdev->hdev, "status (%d) return ownership to device", err);
1049 
1050 	sdio_release_host(bdev->func);
1051 
1052 	return err;
1053 }
1054 
1055 static int btmtksdio_runtime_resume(struct device *dev)
1056 {
1057 	struct sdio_func *func = dev_to_sdio_func(dev);
1058 	struct btmtksdio_dev *bdev;
1059 	u32 status;
1060 	int err;
1061 
1062 	bdev = sdio_get_drvdata(func);
1063 	if (!bdev)
1064 		return 0;
1065 
1066 	sdio_claim_host(bdev->func);
1067 
1068 	sdio_writel(bdev->func, C_FW_OWN_REQ_CLR, MTK_REG_CHLPCR, &err);
1069 	if (err < 0)
1070 		goto out;
1071 
1072 	err = readx_poll_timeout(btmtksdio_drv_own_query, bdev, status,
1073 				 status & C_COM_DRV_OWN, 2000, 1000000);
1074 out:
1075 	bt_dev_info(bdev->hdev, "status (%d) get ownership from device", err);
1076 
1077 	sdio_release_host(bdev->func);
1078 
1079 	return err;
1080 }
1081 
1082 static UNIVERSAL_DEV_PM_OPS(btmtksdio_pm_ops, btmtksdio_runtime_suspend,
1083 			    btmtksdio_runtime_resume, NULL);
1084 #define BTMTKSDIO_PM_OPS (&btmtksdio_pm_ops)
1085 #else	/* CONFIG_PM */
1086 #define BTMTKSDIO_PM_OPS NULL
1087 #endif	/* CONFIG_PM */
1088 
1089 static struct sdio_driver btmtksdio_driver = {
1090 	.name		= "btmtksdio",
1091 	.probe		= btmtksdio_probe,
1092 	.remove		= btmtksdio_remove,
1093 	.id_table	= btmtksdio_table,
1094 	.drv = {
1095 		.owner = THIS_MODULE,
1096 		.pm = BTMTKSDIO_PM_OPS,
1097 	}
1098 };
1099 
1100 module_sdio_driver(btmtksdio_driver);
1101 
1102 module_param(enable_autosuspend, bool, 0644);
1103 MODULE_PARM_DESC(enable_autosuspend, "Enable autosuspend by default");
1104 
1105 MODULE_AUTHOR("Sean Wang <sean.wang@mediatek.com>");
1106 MODULE_DESCRIPTION("MediaTek Bluetooth SDIO driver ver " VERSION);
1107 MODULE_VERSION(VERSION);
1108 MODULE_LICENSE("GPL");
1109