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