1 /**
2  * Marvell Bluetooth driver
3  *
4  * Copyright (C) 2009, Marvell International Ltd.
5  *
6  * This software file (the "File") is distributed by Marvell International
7  * Ltd. under the terms of the GNU General Public License Version 2, June 1991
8  * (the "License").  You may use, redistribute and/or modify this File in
9  * accordance with the terms and conditions of the License, a copy of which
10  * is available by writing to the Free Software Foundation, Inc.,
11  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or on the
12  * worldwide web at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
13  *
14  *
15  * THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE
17  * ARE EXPRESSLY DISCLAIMED.  The License provides additional details about
18  * this warranty disclaimer.
19  **/
20 
21 #include <linux/module.h>
22 #include <linux/of.h>
23 #include <net/bluetooth/bluetooth.h>
24 #include <net/bluetooth/hci_core.h>
25 
26 #include "btmrvl_drv.h"
27 
28 #define VERSION "1.0"
29 
30 /*
31  * This function is called by interface specific interrupt handler.
32  * It updates Power Save & Host Sleep states, and wakes up the main
33  * thread.
34  */
35 void btmrvl_interrupt(struct btmrvl_private *priv)
36 {
37 	priv->adapter->ps_state = PS_AWAKE;
38 
39 	priv->adapter->wakeup_tries = 0;
40 
41 	priv->adapter->int_count++;
42 
43 	wake_up_interruptible(&priv->main_thread.wait_q);
44 }
45 EXPORT_SYMBOL_GPL(btmrvl_interrupt);
46 
47 bool btmrvl_check_evtpkt(struct btmrvl_private *priv, struct sk_buff *skb)
48 {
49 	struct hci_event_hdr *hdr = (void *) skb->data;
50 
51 	if (hdr->evt == HCI_EV_CMD_COMPLETE) {
52 		struct hci_ev_cmd_complete *ec;
53 		u16 opcode;
54 
55 		ec = (void *) (skb->data + HCI_EVENT_HDR_SIZE);
56 		opcode = __le16_to_cpu(ec->opcode);
57 
58 		if (priv->btmrvl_dev.sendcmdflag) {
59 			priv->btmrvl_dev.sendcmdflag = false;
60 			priv->adapter->cmd_complete = true;
61 			wake_up_interruptible(&priv->adapter->cmd_wait_q);
62 
63 			if (hci_opcode_ogf(opcode) == 0x3F) {
64 				BT_DBG("vendor event skipped: opcode=%#4.4x",
65 				       opcode);
66 				kfree_skb(skb);
67 				return false;
68 			}
69 		}
70 	}
71 
72 	return true;
73 }
74 EXPORT_SYMBOL_GPL(btmrvl_check_evtpkt);
75 
76 int btmrvl_process_event(struct btmrvl_private *priv, struct sk_buff *skb)
77 {
78 	struct btmrvl_adapter *adapter = priv->adapter;
79 	struct btmrvl_event *event;
80 	int ret = 0;
81 
82 	event = (struct btmrvl_event *) skb->data;
83 	if (event->ec != 0xff) {
84 		BT_DBG("Not Marvell Event=%x", event->ec);
85 		ret = -EINVAL;
86 		goto exit;
87 	}
88 
89 	switch (event->data[0]) {
90 	case BT_EVENT_AUTO_SLEEP_MODE:
91 		if (!event->data[2]) {
92 			if (event->data[1] == BT_PS_ENABLE)
93 				adapter->psmode = 1;
94 			else
95 				adapter->psmode = 0;
96 			BT_DBG("PS Mode:%s",
97 				(adapter->psmode) ? "Enable" : "Disable");
98 		} else {
99 			BT_DBG("PS Mode command failed");
100 		}
101 		break;
102 
103 	case BT_EVENT_HOST_SLEEP_CONFIG:
104 		if (!event->data[3])
105 			BT_DBG("gpio=%x, gap=%x", event->data[1],
106 							event->data[2]);
107 		else
108 			BT_DBG("HSCFG command failed");
109 		break;
110 
111 	case BT_EVENT_HOST_SLEEP_ENABLE:
112 		if (!event->data[1]) {
113 			adapter->hs_state = HS_ACTIVATED;
114 			if (adapter->psmode)
115 				adapter->ps_state = PS_SLEEP;
116 			BT_DBG("HS ACTIVATED!");
117 		} else {
118 			BT_DBG("HS Enable failed");
119 		}
120 		break;
121 
122 	case BT_EVENT_MODULE_CFG_REQ:
123 		if (priv->btmrvl_dev.sendcmdflag &&
124 				event->data[1] == MODULE_BRINGUP_REQ) {
125 			BT_DBG("EVENT:%s",
126 				((event->data[2] == MODULE_BROUGHT_UP) ||
127 				(event->data[2] == MODULE_ALREADY_UP)) ?
128 				"Bring-up succeed" : "Bring-up failed");
129 
130 			if (event->length > 3 && event->data[3])
131 				priv->btmrvl_dev.dev_type = HCI_AMP;
132 			else
133 				priv->btmrvl_dev.dev_type = HCI_BREDR;
134 
135 			BT_DBG("dev_type: %d", priv->btmrvl_dev.dev_type);
136 		} else if (priv->btmrvl_dev.sendcmdflag &&
137 				event->data[1] == MODULE_SHUTDOWN_REQ) {
138 			BT_DBG("EVENT:%s", (event->data[2]) ?
139 				"Shutdown failed" : "Shutdown succeed");
140 		} else {
141 			BT_DBG("BT_CMD_MODULE_CFG_REQ resp for APP");
142 			ret = -EINVAL;
143 		}
144 		break;
145 
146 	case BT_EVENT_POWER_STATE:
147 		if (event->data[1] == BT_PS_SLEEP)
148 			adapter->ps_state = PS_SLEEP;
149 		BT_DBG("EVENT:%s",
150 			(adapter->ps_state) ? "PS_SLEEP" : "PS_AWAKE");
151 		break;
152 
153 	default:
154 		BT_DBG("Unknown Event=%d", event->data[0]);
155 		ret = -EINVAL;
156 		break;
157 	}
158 
159 exit:
160 	if (!ret)
161 		kfree_skb(skb);
162 
163 	return ret;
164 }
165 EXPORT_SYMBOL_GPL(btmrvl_process_event);
166 
167 static int btmrvl_send_sync_cmd(struct btmrvl_private *priv, u16 opcode,
168 				const void *param, u8 len)
169 {
170 	struct sk_buff *skb;
171 	struct hci_command_hdr *hdr;
172 
173 	skb = bt_skb_alloc(HCI_COMMAND_HDR_SIZE + len, GFP_ATOMIC);
174 	if (skb == NULL) {
175 		BT_ERR("No free skb");
176 		return -ENOMEM;
177 	}
178 
179 	hdr = (struct hci_command_hdr *)skb_put(skb, HCI_COMMAND_HDR_SIZE);
180 	hdr->opcode = cpu_to_le16(opcode);
181 	hdr->plen = len;
182 
183 	if (len)
184 		memcpy(skb_put(skb, len), param, len);
185 
186 	bt_cb(skb)->pkt_type = MRVL_VENDOR_PKT;
187 
188 	skb_queue_head(&priv->adapter->tx_queue, skb);
189 
190 	priv->btmrvl_dev.sendcmdflag = true;
191 
192 	priv->adapter->cmd_complete = false;
193 
194 	wake_up_interruptible(&priv->main_thread.wait_q);
195 
196 	if (!wait_event_interruptible_timeout(priv->adapter->cmd_wait_q,
197 				priv->adapter->cmd_complete,
198 				msecs_to_jiffies(WAIT_UNTIL_CMD_RESP)))
199 		return -ETIMEDOUT;
200 
201 	return 0;
202 }
203 
204 int btmrvl_send_module_cfg_cmd(struct btmrvl_private *priv, int subcmd)
205 {
206 	int ret;
207 
208 	ret = btmrvl_send_sync_cmd(priv, BT_CMD_MODULE_CFG_REQ, &subcmd, 1);
209 	if (ret)
210 		BT_ERR("module_cfg_cmd(%x) failed\n", subcmd);
211 
212 	return ret;
213 }
214 EXPORT_SYMBOL_GPL(btmrvl_send_module_cfg_cmd);
215 
216 int btmrvl_send_hscfg_cmd(struct btmrvl_private *priv)
217 {
218 	int ret;
219 	u8 param[2];
220 
221 	param[0] = (priv->btmrvl_dev.gpio_gap & 0xff00) >> 8;
222 	param[1] = (u8) (priv->btmrvl_dev.gpio_gap & 0x00ff);
223 
224 	BT_DBG("Sending HSCFG Command, gpio=0x%x, gap=0x%x",
225 	       param[0], param[1]);
226 
227 	ret = btmrvl_send_sync_cmd(priv, BT_CMD_HOST_SLEEP_CONFIG, param, 2);
228 	if (ret)
229 		BT_ERR("HSCFG command failed\n");
230 
231 	return ret;
232 }
233 EXPORT_SYMBOL_GPL(btmrvl_send_hscfg_cmd);
234 
235 int btmrvl_enable_ps(struct btmrvl_private *priv)
236 {
237 	int ret;
238 	u8 param;
239 
240 	if (priv->btmrvl_dev.psmode)
241 		param = BT_PS_ENABLE;
242 	else
243 		param = BT_PS_DISABLE;
244 
245 	ret = btmrvl_send_sync_cmd(priv, BT_CMD_AUTO_SLEEP_MODE, &param, 1);
246 	if (ret)
247 		BT_ERR("PSMODE command failed\n");
248 
249 	return 0;
250 }
251 EXPORT_SYMBOL_GPL(btmrvl_enable_ps);
252 
253 int btmrvl_enable_hs(struct btmrvl_private *priv)
254 {
255 	int ret;
256 
257 	ret = btmrvl_send_sync_cmd(priv, BT_CMD_HOST_SLEEP_ENABLE, NULL, 0);
258 	if (ret)
259 		BT_ERR("Host sleep enable command failed\n");
260 
261 	return ret;
262 }
263 EXPORT_SYMBOL_GPL(btmrvl_enable_hs);
264 
265 int btmrvl_prepare_command(struct btmrvl_private *priv)
266 {
267 	int ret = 0;
268 
269 	if (priv->btmrvl_dev.hscfgcmd) {
270 		priv->btmrvl_dev.hscfgcmd = 0;
271 		btmrvl_send_hscfg_cmd(priv);
272 	}
273 
274 	if (priv->btmrvl_dev.pscmd) {
275 		priv->btmrvl_dev.pscmd = 0;
276 		btmrvl_enable_ps(priv);
277 	}
278 
279 	if (priv->btmrvl_dev.hscmd) {
280 		priv->btmrvl_dev.hscmd = 0;
281 
282 		if (priv->btmrvl_dev.hsmode) {
283 			ret = btmrvl_enable_hs(priv);
284 		} else {
285 			ret = priv->hw_wakeup_firmware(priv);
286 			priv->adapter->hs_state = HS_DEACTIVATED;
287 		}
288 	}
289 
290 	return ret;
291 }
292 
293 static int btmrvl_tx_pkt(struct btmrvl_private *priv, struct sk_buff *skb)
294 {
295 	int ret = 0;
296 
297 	if (!skb || !skb->data)
298 		return -EINVAL;
299 
300 	if (!skb->len || ((skb->len + BTM_HEADER_LEN) > BTM_UPLD_SIZE)) {
301 		BT_ERR("Tx Error: Bad skb length %d : %d",
302 						skb->len, BTM_UPLD_SIZE);
303 		return -EINVAL;
304 	}
305 
306 	if (skb_headroom(skb) < BTM_HEADER_LEN) {
307 		struct sk_buff *tmp = skb;
308 
309 		skb = skb_realloc_headroom(skb, BTM_HEADER_LEN);
310 		if (!skb) {
311 			BT_ERR("Tx Error: realloc_headroom failed %d",
312 				BTM_HEADER_LEN);
313 			skb = tmp;
314 			return -EINVAL;
315 		}
316 
317 		kfree_skb(tmp);
318 	}
319 
320 	skb_push(skb, BTM_HEADER_LEN);
321 
322 	/* header type: byte[3]
323 	 * HCI_COMMAND = 1, ACL_DATA = 2, SCO_DATA = 3, 0xFE = Vendor
324 	 * header length: byte[2][1][0]
325 	 */
326 
327 	skb->data[0] = (skb->len & 0x0000ff);
328 	skb->data[1] = (skb->len & 0x00ff00) >> 8;
329 	skb->data[2] = (skb->len & 0xff0000) >> 16;
330 	skb->data[3] = bt_cb(skb)->pkt_type;
331 
332 	if (priv->hw_host_to_card)
333 		ret = priv->hw_host_to_card(priv, skb->data, skb->len);
334 
335 	return ret;
336 }
337 
338 static void btmrvl_init_adapter(struct btmrvl_private *priv)
339 {
340 	skb_queue_head_init(&priv->adapter->tx_queue);
341 
342 	priv->adapter->ps_state = PS_AWAKE;
343 
344 	init_waitqueue_head(&priv->adapter->cmd_wait_q);
345 }
346 
347 static void btmrvl_free_adapter(struct btmrvl_private *priv)
348 {
349 	skb_queue_purge(&priv->adapter->tx_queue);
350 
351 	kfree(priv->adapter);
352 
353 	priv->adapter = NULL;
354 }
355 
356 static int btmrvl_send_frame(struct hci_dev *hdev, struct sk_buff *skb)
357 {
358 	struct btmrvl_private *priv = hci_get_drvdata(hdev);
359 
360 	BT_DBG("type=%d, len=%d", skb->pkt_type, skb->len);
361 
362 	if (!test_bit(HCI_RUNNING, &hdev->flags)) {
363 		BT_ERR("Failed testing HCI_RUNING, flags=%lx", hdev->flags);
364 		print_hex_dump_bytes("data: ", DUMP_PREFIX_OFFSET,
365 							skb->data, skb->len);
366 		return -EBUSY;
367 	}
368 
369 	switch (bt_cb(skb)->pkt_type) {
370 	case HCI_COMMAND_PKT:
371 		hdev->stat.cmd_tx++;
372 		break;
373 
374 	case HCI_ACLDATA_PKT:
375 		hdev->stat.acl_tx++;
376 		break;
377 
378 	case HCI_SCODATA_PKT:
379 		hdev->stat.sco_tx++;
380 		break;
381 	}
382 
383 	skb_queue_tail(&priv->adapter->tx_queue, skb);
384 
385 	wake_up_interruptible(&priv->main_thread.wait_q);
386 
387 	return 0;
388 }
389 
390 static int btmrvl_flush(struct hci_dev *hdev)
391 {
392 	struct btmrvl_private *priv = hci_get_drvdata(hdev);
393 
394 	skb_queue_purge(&priv->adapter->tx_queue);
395 
396 	return 0;
397 }
398 
399 static int btmrvl_close(struct hci_dev *hdev)
400 {
401 	struct btmrvl_private *priv = hci_get_drvdata(hdev);
402 
403 	if (!test_and_clear_bit(HCI_RUNNING, &hdev->flags))
404 		return 0;
405 
406 	skb_queue_purge(&priv->adapter->tx_queue);
407 
408 	return 0;
409 }
410 
411 static int btmrvl_open(struct hci_dev *hdev)
412 {
413 	set_bit(HCI_RUNNING, &hdev->flags);
414 
415 	return 0;
416 }
417 
418 static int btmrvl_download_cal_data(struct btmrvl_private *priv,
419 				    u8 *data, int len)
420 {
421 	int ret;
422 
423 	data[0] = 0x00;
424 	data[1] = 0x00;
425 	data[2] = 0x00;
426 	data[3] = len;
427 
428 	print_hex_dump_bytes("Calibration data: ",
429 			     DUMP_PREFIX_OFFSET, data, BT_CAL_HDR_LEN + len);
430 
431 	ret = btmrvl_send_sync_cmd(priv, BT_CMD_LOAD_CONFIG_DATA, data,
432 				   BT_CAL_HDR_LEN + len);
433 	if (ret)
434 		BT_ERR("Failed to download caibration data\n");
435 
436 	return 0;
437 }
438 
439 static int btmrvl_cal_data_dt(struct btmrvl_private *priv)
440 {
441 	struct device_node *dt_node;
442 	u8 cal_data[BT_CAL_HDR_LEN + BT_CAL_DATA_SIZE];
443 	const char name[] = "btmrvl_caldata";
444 	const char property[] = "btmrvl,caldata";
445 	int ret;
446 
447 	dt_node = of_find_node_by_name(NULL, name);
448 	if (!dt_node)
449 		return -ENODEV;
450 
451 	ret = of_property_read_u8_array(dt_node, property,
452 					cal_data + BT_CAL_HDR_LEN,
453 					BT_CAL_DATA_SIZE);
454 	if (ret)
455 		return ret;
456 
457 	BT_DBG("Use cal data from device tree");
458 	ret = btmrvl_download_cal_data(priv, cal_data, BT_CAL_DATA_SIZE);
459 	if (ret) {
460 		BT_ERR("Fail to download calibrate data");
461 		return ret;
462 	}
463 
464 	return 0;
465 }
466 
467 static int btmrvl_setup(struct hci_dev *hdev)
468 {
469 	struct btmrvl_private *priv = hci_get_drvdata(hdev);
470 
471 	btmrvl_send_module_cfg_cmd(priv, MODULE_BRINGUP_REQ);
472 
473 	btmrvl_cal_data_dt(priv);
474 
475 	priv->btmrvl_dev.psmode = 1;
476 	btmrvl_enable_ps(priv);
477 
478 	priv->btmrvl_dev.gpio_gap = 0xffff;
479 	btmrvl_send_hscfg_cmd(priv);
480 
481 	return 0;
482 }
483 
484 /*
485  * This function handles the event generated by firmware, rx data
486  * received from firmware, and tx data sent from kernel.
487  */
488 static int btmrvl_service_main_thread(void *data)
489 {
490 	struct btmrvl_thread *thread = data;
491 	struct btmrvl_private *priv = thread->priv;
492 	struct btmrvl_adapter *adapter = priv->adapter;
493 	wait_queue_t wait;
494 	struct sk_buff *skb;
495 	ulong flags;
496 
497 	init_waitqueue_entry(&wait, current);
498 
499 	for (;;) {
500 		add_wait_queue(&thread->wait_q, &wait);
501 
502 		set_current_state(TASK_INTERRUPTIBLE);
503 		if (kthread_should_stop()) {
504 			BT_DBG("main_thread: break from main thread");
505 			break;
506 		}
507 
508 		if (adapter->wakeup_tries ||
509 				((!adapter->int_count) &&
510 				(!priv->btmrvl_dev.tx_dnld_rdy ||
511 				skb_queue_empty(&adapter->tx_queue)))) {
512 			BT_DBG("main_thread is sleeping...");
513 			schedule();
514 		}
515 
516 		set_current_state(TASK_RUNNING);
517 
518 		remove_wait_queue(&thread->wait_q, &wait);
519 
520 		BT_DBG("main_thread woke up");
521 
522 		spin_lock_irqsave(&priv->driver_lock, flags);
523 		if (adapter->int_count) {
524 			adapter->int_count = 0;
525 			spin_unlock_irqrestore(&priv->driver_lock, flags);
526 			priv->hw_process_int_status(priv);
527 		} else if (adapter->ps_state == PS_SLEEP &&
528 					!skb_queue_empty(&adapter->tx_queue)) {
529 			spin_unlock_irqrestore(&priv->driver_lock, flags);
530 			adapter->wakeup_tries++;
531 			priv->hw_wakeup_firmware(priv);
532 			continue;
533 		} else {
534 			spin_unlock_irqrestore(&priv->driver_lock, flags);
535 		}
536 
537 		if (adapter->ps_state == PS_SLEEP)
538 			continue;
539 
540 		if (!priv->btmrvl_dev.tx_dnld_rdy)
541 			continue;
542 
543 		skb = skb_dequeue(&adapter->tx_queue);
544 		if (skb) {
545 			if (btmrvl_tx_pkt(priv, skb))
546 				priv->btmrvl_dev.hcidev->stat.err_tx++;
547 			else
548 				priv->btmrvl_dev.hcidev->stat.byte_tx += skb->len;
549 
550 			kfree_skb(skb);
551 		}
552 	}
553 
554 	return 0;
555 }
556 
557 int btmrvl_register_hdev(struct btmrvl_private *priv)
558 {
559 	struct hci_dev *hdev = NULL;
560 	int ret;
561 
562 	hdev = hci_alloc_dev();
563 	if (!hdev) {
564 		BT_ERR("Can not allocate HCI device");
565 		goto err_hdev;
566 	}
567 
568 	priv->btmrvl_dev.hcidev = hdev;
569 	hci_set_drvdata(hdev, priv);
570 
571 	hdev->bus   = HCI_SDIO;
572 	hdev->open  = btmrvl_open;
573 	hdev->close = btmrvl_close;
574 	hdev->flush = btmrvl_flush;
575 	hdev->send  = btmrvl_send_frame;
576 	hdev->setup = btmrvl_setup;
577 
578 	hdev->dev_type = priv->btmrvl_dev.dev_type;
579 
580 	ret = hci_register_dev(hdev);
581 	if (ret < 0) {
582 		BT_ERR("Can not register HCI device");
583 		goto err_hci_register_dev;
584 	}
585 
586 #ifdef CONFIG_DEBUG_FS
587 	btmrvl_debugfs_init(hdev);
588 #endif
589 
590 	return 0;
591 
592 err_hci_register_dev:
593 	hci_free_dev(hdev);
594 
595 err_hdev:
596 	/* Stop the thread servicing the interrupts */
597 	kthread_stop(priv->main_thread.task);
598 
599 	btmrvl_free_adapter(priv);
600 	kfree(priv);
601 
602 	return -ENOMEM;
603 }
604 EXPORT_SYMBOL_GPL(btmrvl_register_hdev);
605 
606 struct btmrvl_private *btmrvl_add_card(void *card)
607 {
608 	struct btmrvl_private *priv;
609 
610 	priv = kzalloc(sizeof(*priv), GFP_KERNEL);
611 	if (!priv) {
612 		BT_ERR("Can not allocate priv");
613 		goto err_priv;
614 	}
615 
616 	priv->adapter = kzalloc(sizeof(*priv->adapter), GFP_KERNEL);
617 	if (!priv->adapter) {
618 		BT_ERR("Allocate buffer for btmrvl_adapter failed!");
619 		goto err_adapter;
620 	}
621 
622 	btmrvl_init_adapter(priv);
623 
624 	BT_DBG("Starting kthread...");
625 	priv->main_thread.priv = priv;
626 	spin_lock_init(&priv->driver_lock);
627 
628 	init_waitqueue_head(&priv->main_thread.wait_q);
629 	priv->main_thread.task = kthread_run(btmrvl_service_main_thread,
630 				&priv->main_thread, "btmrvl_main_service");
631 
632 	priv->btmrvl_dev.card = card;
633 	priv->btmrvl_dev.tx_dnld_rdy = true;
634 
635 	return priv;
636 
637 err_adapter:
638 	kfree(priv);
639 
640 err_priv:
641 	return NULL;
642 }
643 EXPORT_SYMBOL_GPL(btmrvl_add_card);
644 
645 int btmrvl_remove_card(struct btmrvl_private *priv)
646 {
647 	struct hci_dev *hdev;
648 
649 	hdev = priv->btmrvl_dev.hcidev;
650 
651 	wake_up_interruptible(&priv->adapter->cmd_wait_q);
652 
653 	kthread_stop(priv->main_thread.task);
654 
655 #ifdef CONFIG_DEBUG_FS
656 	btmrvl_debugfs_remove(hdev);
657 #endif
658 
659 	hci_unregister_dev(hdev);
660 
661 	hci_free_dev(hdev);
662 
663 	priv->btmrvl_dev.hcidev = NULL;
664 
665 	btmrvl_free_adapter(priv);
666 
667 	kfree(priv);
668 
669 	return 0;
670 }
671 EXPORT_SYMBOL_GPL(btmrvl_remove_card);
672 
673 MODULE_AUTHOR("Marvell International Ltd.");
674 MODULE_DESCRIPTION("Marvell Bluetooth driver ver " VERSION);
675 MODULE_VERSION(VERSION);
676 MODULE_LICENSE("GPL v2");
677