xref: /openbmc/linux/drivers/bluetooth/hci_bcm.c (revision efe4a1ac)
1 /*
2  *
3  *  Bluetooth HCI UART driver for Broadcom devices
4  *
5  *  Copyright (C) 2015  Intel Corporation
6  *
7  *
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.
12  *
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.
17  *
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
21  *
22  */
23 
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/acpi.h>
30 #include <linux/platform_device.h>
31 #include <linux/clk.h>
32 #include <linux/gpio/consumer.h>
33 #include <linux/tty.h>
34 #include <linux/interrupt.h>
35 #include <linux/dmi.h>
36 #include <linux/pm_runtime.h>
37 
38 #include <net/bluetooth/bluetooth.h>
39 #include <net/bluetooth/hci_core.h>
40 
41 #include "btbcm.h"
42 #include "hci_uart.h"
43 
44 #define BCM_LM_DIAG_PKT 0x07
45 #define BCM_LM_DIAG_SIZE 63
46 
47 #define BCM_AUTOSUSPEND_DELAY	5000 /* default autosleep delay */
48 
49 struct bcm_device {
50 	struct list_head	list;
51 
52 	struct platform_device	*pdev;
53 
54 	const char		*name;
55 	struct gpio_desc	*device_wakeup;
56 	struct gpio_desc	*shutdown;
57 
58 	struct clk		*clk;
59 	bool			clk_enabled;
60 
61 	u32			init_speed;
62 	int			irq;
63 	u8			irq_polarity;
64 
65 #ifdef CONFIG_PM
66 	struct hci_uart		*hu;
67 	bool			is_suspended; /* suspend/resume flag */
68 #endif
69 };
70 
71 struct bcm_data {
72 	struct sk_buff		*rx_skb;
73 	struct sk_buff_head	txq;
74 
75 	struct bcm_device	*dev;
76 };
77 
78 /* List of BCM BT UART devices */
79 static DEFINE_MUTEX(bcm_device_lock);
80 static LIST_HEAD(bcm_device_list);
81 
82 static int bcm_set_baudrate(struct hci_uart *hu, unsigned int speed)
83 {
84 	struct hci_dev *hdev = hu->hdev;
85 	struct sk_buff *skb;
86 	struct bcm_update_uart_baud_rate param;
87 
88 	if (speed > 3000000) {
89 		struct bcm_write_uart_clock_setting clock;
90 
91 		clock.type = BCM_UART_CLOCK_48MHZ;
92 
93 		bt_dev_dbg(hdev, "Set Controller clock (%d)", clock.type);
94 
95 		/* This Broadcom specific command changes the UART's controller
96 		 * clock for baud rate > 3000000.
97 		 */
98 		skb = __hci_cmd_sync(hdev, 0xfc45, 1, &clock, HCI_INIT_TIMEOUT);
99 		if (IS_ERR(skb)) {
100 			int err = PTR_ERR(skb);
101 			bt_dev_err(hdev, "BCM: failed to write clock (%d)",
102 				   err);
103 			return err;
104 		}
105 
106 		kfree_skb(skb);
107 	}
108 
109 	bt_dev_dbg(hdev, "Set Controller UART speed to %d bit/s", speed);
110 
111 	param.zero = cpu_to_le16(0);
112 	param.baud_rate = cpu_to_le32(speed);
113 
114 	/* This Broadcom specific command changes the UART's controller baud
115 	 * rate.
116 	 */
117 	skb = __hci_cmd_sync(hdev, 0xfc18, sizeof(param), &param,
118 			     HCI_INIT_TIMEOUT);
119 	if (IS_ERR(skb)) {
120 		int err = PTR_ERR(skb);
121 		bt_dev_err(hdev, "BCM: failed to write update baudrate (%d)",
122 			   err);
123 		return err;
124 	}
125 
126 	kfree_skb(skb);
127 
128 	return 0;
129 }
130 
131 /* bcm_device_exists should be protected by bcm_device_lock */
132 static bool bcm_device_exists(struct bcm_device *device)
133 {
134 	struct list_head *p;
135 
136 	list_for_each(p, &bcm_device_list) {
137 		struct bcm_device *dev = list_entry(p, struct bcm_device, list);
138 
139 		if (device == dev)
140 			return true;
141 	}
142 
143 	return false;
144 }
145 
146 static int bcm_gpio_set_power(struct bcm_device *dev, bool powered)
147 {
148 	if (powered && !IS_ERR(dev->clk) && !dev->clk_enabled)
149 		clk_prepare_enable(dev->clk);
150 
151 	gpiod_set_value(dev->shutdown, powered);
152 	gpiod_set_value(dev->device_wakeup, powered);
153 
154 	if (!powered && !IS_ERR(dev->clk) && dev->clk_enabled)
155 		clk_disable_unprepare(dev->clk);
156 
157 	dev->clk_enabled = powered;
158 
159 	return 0;
160 }
161 
162 #ifdef CONFIG_PM
163 static irqreturn_t bcm_host_wake(int irq, void *data)
164 {
165 	struct bcm_device *bdev = data;
166 
167 	bt_dev_dbg(bdev, "Host wake IRQ");
168 
169 	pm_runtime_get(&bdev->pdev->dev);
170 	pm_runtime_mark_last_busy(&bdev->pdev->dev);
171 	pm_runtime_put_autosuspend(&bdev->pdev->dev);
172 
173 	return IRQ_HANDLED;
174 }
175 
176 static int bcm_request_irq(struct bcm_data *bcm)
177 {
178 	struct bcm_device *bdev = bcm->dev;
179 	int err = 0;
180 
181 	/* If this is not a platform device, do not enable PM functionalities */
182 	mutex_lock(&bcm_device_lock);
183 	if (!bcm_device_exists(bdev)) {
184 		err = -ENODEV;
185 		goto unlock;
186 	}
187 
188 	if (bdev->irq > 0) {
189 		err = devm_request_irq(&bdev->pdev->dev, bdev->irq,
190 				       bcm_host_wake, IRQF_TRIGGER_RISING,
191 				       "host_wake", bdev);
192 		if (err)
193 			goto unlock;
194 
195 		device_init_wakeup(&bdev->pdev->dev, true);
196 
197 		pm_runtime_set_autosuspend_delay(&bdev->pdev->dev,
198 						 BCM_AUTOSUSPEND_DELAY);
199 		pm_runtime_use_autosuspend(&bdev->pdev->dev);
200 		pm_runtime_set_active(&bdev->pdev->dev);
201 		pm_runtime_enable(&bdev->pdev->dev);
202 	}
203 
204 unlock:
205 	mutex_unlock(&bcm_device_lock);
206 
207 	return err;
208 }
209 
210 static const struct bcm_set_sleep_mode default_sleep_params = {
211 	.sleep_mode = 1,	/* 0=Disabled, 1=UART, 2=Reserved, 3=USB */
212 	.idle_host = 2,		/* idle threshold HOST, in 300ms */
213 	.idle_dev = 2,		/* idle threshold device, in 300ms */
214 	.bt_wake_active = 1,	/* BT_WAKE active mode: 1 = high, 0 = low */
215 	.host_wake_active = 0,	/* HOST_WAKE active mode: 1 = high, 0 = low */
216 	.allow_host_sleep = 1,	/* Allow host sleep in SCO flag */
217 	.combine_modes = 1,	/* Combine sleep and LPM flag */
218 	.tristate_control = 0,	/* Allow tri-state control of UART tx flag */
219 	/* Irrelevant USB flags */
220 	.usb_auto_sleep = 0,
221 	.usb_resume_timeout = 0,
222 	.pulsed_host_wake = 0,
223 	.break_to_host = 0
224 };
225 
226 static int bcm_setup_sleep(struct hci_uart *hu)
227 {
228 	struct bcm_data *bcm = hu->priv;
229 	struct sk_buff *skb;
230 	struct bcm_set_sleep_mode sleep_params = default_sleep_params;
231 
232 	sleep_params.host_wake_active = !bcm->dev->irq_polarity;
233 
234 	skb = __hci_cmd_sync(hu->hdev, 0xfc27, sizeof(sleep_params),
235 			     &sleep_params, HCI_INIT_TIMEOUT);
236 	if (IS_ERR(skb)) {
237 		int err = PTR_ERR(skb);
238 		bt_dev_err(hu->hdev, "Sleep VSC failed (%d)", err);
239 		return err;
240 	}
241 	kfree_skb(skb);
242 
243 	bt_dev_dbg(hu->hdev, "Set Sleep Parameters VSC succeeded");
244 
245 	return 0;
246 }
247 #else
248 static inline int bcm_request_irq(struct bcm_data *bcm) { return 0; }
249 static inline int bcm_setup_sleep(struct hci_uart *hu) { return 0; }
250 #endif
251 
252 static int bcm_set_diag(struct hci_dev *hdev, bool enable)
253 {
254 	struct hci_uart *hu = hci_get_drvdata(hdev);
255 	struct bcm_data *bcm = hu->priv;
256 	struct sk_buff *skb;
257 
258 	if (!test_bit(HCI_RUNNING, &hdev->flags))
259 		return -ENETDOWN;
260 
261 	skb = bt_skb_alloc(3, GFP_KERNEL);
262 	if (!skb)
263 		return -ENOMEM;
264 
265 	*skb_put(skb, 1) = BCM_LM_DIAG_PKT;
266 	*skb_put(skb, 1) = 0xf0;
267 	*skb_put(skb, 1) = enable;
268 
269 	skb_queue_tail(&bcm->txq, skb);
270 	hci_uart_tx_wakeup(hu);
271 
272 	return 0;
273 }
274 
275 static int bcm_open(struct hci_uart *hu)
276 {
277 	struct bcm_data *bcm;
278 	struct list_head *p;
279 
280 	bt_dev_dbg(hu->hdev, "hu %p", hu);
281 
282 	bcm = kzalloc(sizeof(*bcm), GFP_KERNEL);
283 	if (!bcm)
284 		return -ENOMEM;
285 
286 	skb_queue_head_init(&bcm->txq);
287 
288 	hu->priv = bcm;
289 
290 	if (!hu->tty->dev)
291 		goto out;
292 
293 	mutex_lock(&bcm_device_lock);
294 	list_for_each(p, &bcm_device_list) {
295 		struct bcm_device *dev = list_entry(p, struct bcm_device, list);
296 
297 		/* Retrieve saved bcm_device based on parent of the
298 		 * platform device (saved during device probe) and
299 		 * parent of tty device used by hci_uart
300 		 */
301 		if (hu->tty->dev->parent == dev->pdev->dev.parent) {
302 			bcm->dev = dev;
303 			hu->init_speed = dev->init_speed;
304 #ifdef CONFIG_PM
305 			dev->hu = hu;
306 #endif
307 			bcm_gpio_set_power(bcm->dev, true);
308 			break;
309 		}
310 	}
311 
312 	mutex_unlock(&bcm_device_lock);
313 out:
314 	return 0;
315 }
316 
317 static int bcm_close(struct hci_uart *hu)
318 {
319 	struct bcm_data *bcm = hu->priv;
320 	struct bcm_device *bdev = bcm->dev;
321 
322 	bt_dev_dbg(hu->hdev, "hu %p", hu);
323 
324 	/* Protect bcm->dev against removal of the device or driver */
325 	mutex_lock(&bcm_device_lock);
326 	if (bcm_device_exists(bdev)) {
327 		bcm_gpio_set_power(bdev, false);
328 #ifdef CONFIG_PM
329 		pm_runtime_disable(&bdev->pdev->dev);
330 		pm_runtime_set_suspended(&bdev->pdev->dev);
331 
332 		if (device_can_wakeup(&bdev->pdev->dev)) {
333 			devm_free_irq(&bdev->pdev->dev, bdev->irq, bdev);
334 			device_init_wakeup(&bdev->pdev->dev, false);
335 		}
336 
337 		bdev->hu = NULL;
338 #endif
339 	}
340 	mutex_unlock(&bcm_device_lock);
341 
342 	skb_queue_purge(&bcm->txq);
343 	kfree_skb(bcm->rx_skb);
344 	kfree(bcm);
345 
346 	hu->priv = NULL;
347 	return 0;
348 }
349 
350 static int bcm_flush(struct hci_uart *hu)
351 {
352 	struct bcm_data *bcm = hu->priv;
353 
354 	bt_dev_dbg(hu->hdev, "hu %p", hu);
355 
356 	skb_queue_purge(&bcm->txq);
357 
358 	return 0;
359 }
360 
361 static int bcm_setup(struct hci_uart *hu)
362 {
363 	struct bcm_data *bcm = hu->priv;
364 	char fw_name[64];
365 	const struct firmware *fw;
366 	unsigned int speed;
367 	int err;
368 
369 	bt_dev_dbg(hu->hdev, "hu %p", hu);
370 
371 	hu->hdev->set_diag = bcm_set_diag;
372 	hu->hdev->set_bdaddr = btbcm_set_bdaddr;
373 
374 	err = btbcm_initialize(hu->hdev, fw_name, sizeof(fw_name));
375 	if (err)
376 		return err;
377 
378 	err = request_firmware(&fw, fw_name, &hu->hdev->dev);
379 	if (err < 0) {
380 		bt_dev_info(hu->hdev, "BCM: Patch %s not found", fw_name);
381 		return 0;
382 	}
383 
384 	err = btbcm_patchram(hu->hdev, fw);
385 	if (err) {
386 		bt_dev_info(hu->hdev, "BCM: Patch failed (%d)", err);
387 		goto finalize;
388 	}
389 
390 	/* Init speed if any */
391 	if (hu->init_speed)
392 		speed = hu->init_speed;
393 	else if (hu->proto->init_speed)
394 		speed = hu->proto->init_speed;
395 	else
396 		speed = 0;
397 
398 	if (speed)
399 		hci_uart_set_baudrate(hu, speed);
400 
401 	/* Operational speed if any */
402 	if (hu->oper_speed)
403 		speed = hu->oper_speed;
404 	else if (hu->proto->oper_speed)
405 		speed = hu->proto->oper_speed;
406 	else
407 		speed = 0;
408 
409 	if (speed) {
410 		err = bcm_set_baudrate(hu, speed);
411 		if (!err)
412 			hci_uart_set_baudrate(hu, speed);
413 	}
414 
415 finalize:
416 	release_firmware(fw);
417 
418 	err = btbcm_finalize(hu->hdev);
419 	if (err)
420 		return err;
421 
422 	err = bcm_request_irq(bcm);
423 	if (!err)
424 		err = bcm_setup_sleep(hu);
425 
426 	return err;
427 }
428 
429 #define BCM_RECV_LM_DIAG \
430 	.type = BCM_LM_DIAG_PKT, \
431 	.hlen = BCM_LM_DIAG_SIZE, \
432 	.loff = 0, \
433 	.lsize = 0, \
434 	.maxlen = BCM_LM_DIAG_SIZE
435 
436 static const struct h4_recv_pkt bcm_recv_pkts[] = {
437 	{ H4_RECV_ACL,      .recv = hci_recv_frame },
438 	{ H4_RECV_SCO,      .recv = hci_recv_frame },
439 	{ H4_RECV_EVENT,    .recv = hci_recv_frame },
440 	{ BCM_RECV_LM_DIAG, .recv = hci_recv_diag  },
441 };
442 
443 static int bcm_recv(struct hci_uart *hu, const void *data, int count)
444 {
445 	struct bcm_data *bcm = hu->priv;
446 
447 	if (!test_bit(HCI_UART_REGISTERED, &hu->flags))
448 		return -EUNATCH;
449 
450 	bcm->rx_skb = h4_recv_buf(hu->hdev, bcm->rx_skb, data, count,
451 				  bcm_recv_pkts, ARRAY_SIZE(bcm_recv_pkts));
452 	if (IS_ERR(bcm->rx_skb)) {
453 		int err = PTR_ERR(bcm->rx_skb);
454 		bt_dev_err(hu->hdev, "Frame reassembly failed (%d)", err);
455 		bcm->rx_skb = NULL;
456 		return err;
457 	} else if (!bcm->rx_skb) {
458 		/* Delay auto-suspend when receiving completed packet */
459 		mutex_lock(&bcm_device_lock);
460 		if (bcm->dev && bcm_device_exists(bcm->dev)) {
461 			pm_runtime_get(&bcm->dev->pdev->dev);
462 			pm_runtime_mark_last_busy(&bcm->dev->pdev->dev);
463 			pm_runtime_put_autosuspend(&bcm->dev->pdev->dev);
464 		}
465 		mutex_unlock(&bcm_device_lock);
466 	}
467 
468 	return count;
469 }
470 
471 static int bcm_enqueue(struct hci_uart *hu, struct sk_buff *skb)
472 {
473 	struct bcm_data *bcm = hu->priv;
474 
475 	bt_dev_dbg(hu->hdev, "hu %p skb %p", hu, skb);
476 
477 	/* Prepend skb with frame type */
478 	memcpy(skb_push(skb, 1), &hci_skb_pkt_type(skb), 1);
479 	skb_queue_tail(&bcm->txq, skb);
480 
481 	return 0;
482 }
483 
484 static struct sk_buff *bcm_dequeue(struct hci_uart *hu)
485 {
486 	struct bcm_data *bcm = hu->priv;
487 	struct sk_buff *skb = NULL;
488 	struct bcm_device *bdev = NULL;
489 
490 	mutex_lock(&bcm_device_lock);
491 
492 	if (bcm_device_exists(bcm->dev)) {
493 		bdev = bcm->dev;
494 		pm_runtime_get_sync(&bdev->pdev->dev);
495 		/* Shall be resumed here */
496 	}
497 
498 	skb = skb_dequeue(&bcm->txq);
499 
500 	if (bdev) {
501 		pm_runtime_mark_last_busy(&bdev->pdev->dev);
502 		pm_runtime_put_autosuspend(&bdev->pdev->dev);
503 	}
504 
505 	mutex_unlock(&bcm_device_lock);
506 
507 	return skb;
508 }
509 
510 #ifdef CONFIG_PM
511 static int bcm_suspend_device(struct device *dev)
512 {
513 	struct bcm_device *bdev = platform_get_drvdata(to_platform_device(dev));
514 
515 	bt_dev_dbg(bdev, "");
516 
517 	if (!bdev->is_suspended && bdev->hu) {
518 		hci_uart_set_flow_control(bdev->hu, true);
519 
520 		/* Once this returns, driver suspends BT via GPIO */
521 		bdev->is_suspended = true;
522 	}
523 
524 	/* Suspend the device */
525 	if (bdev->device_wakeup) {
526 		gpiod_set_value(bdev->device_wakeup, false);
527 		bt_dev_dbg(bdev, "suspend, delaying 15 ms");
528 		mdelay(15);
529 	}
530 
531 	return 0;
532 }
533 
534 static int bcm_resume_device(struct device *dev)
535 {
536 	struct bcm_device *bdev = platform_get_drvdata(to_platform_device(dev));
537 
538 	bt_dev_dbg(bdev, "");
539 
540 	if (bdev->device_wakeup) {
541 		gpiod_set_value(bdev->device_wakeup, true);
542 		bt_dev_dbg(bdev, "resume, delaying 15 ms");
543 		mdelay(15);
544 	}
545 
546 	/* When this executes, the device has woken up already */
547 	if (bdev->is_suspended && bdev->hu) {
548 		bdev->is_suspended = false;
549 
550 		hci_uart_set_flow_control(bdev->hu, false);
551 	}
552 
553 	return 0;
554 }
555 #endif
556 
557 #ifdef CONFIG_PM_SLEEP
558 /* Platform suspend callback */
559 static int bcm_suspend(struct device *dev)
560 {
561 	struct bcm_device *bdev = platform_get_drvdata(to_platform_device(dev));
562 	int error;
563 
564 	bt_dev_dbg(bdev, "suspend: is_suspended %d", bdev->is_suspended);
565 
566 	/* bcm_suspend can be called at any time as long as platform device is
567 	 * bound, so it should use bcm_device_lock to protect access to hci_uart
568 	 * and device_wake-up GPIO.
569 	 */
570 	mutex_lock(&bcm_device_lock);
571 
572 	if (!bdev->hu)
573 		goto unlock;
574 
575 	if (pm_runtime_active(dev))
576 		bcm_suspend_device(dev);
577 
578 	if (device_may_wakeup(&bdev->pdev->dev)) {
579 		error = enable_irq_wake(bdev->irq);
580 		if (!error)
581 			bt_dev_dbg(bdev, "BCM irq: enabled");
582 	}
583 
584 unlock:
585 	mutex_unlock(&bcm_device_lock);
586 
587 	return 0;
588 }
589 
590 /* Platform resume callback */
591 static int bcm_resume(struct device *dev)
592 {
593 	struct bcm_device *bdev = platform_get_drvdata(to_platform_device(dev));
594 
595 	bt_dev_dbg(bdev, "resume: is_suspended %d", bdev->is_suspended);
596 
597 	/* bcm_resume can be called at any time as long as platform device is
598 	 * bound, so it should use bcm_device_lock to protect access to hci_uart
599 	 * and device_wake-up GPIO.
600 	 */
601 	mutex_lock(&bcm_device_lock);
602 
603 	if (!bdev->hu)
604 		goto unlock;
605 
606 	if (device_may_wakeup(&bdev->pdev->dev)) {
607 		disable_irq_wake(bdev->irq);
608 		bt_dev_dbg(bdev, "BCM irq: disabled");
609 	}
610 
611 	bcm_resume_device(dev);
612 
613 unlock:
614 	mutex_unlock(&bcm_device_lock);
615 
616 	pm_runtime_disable(dev);
617 	pm_runtime_set_active(dev);
618 	pm_runtime_enable(dev);
619 
620 	return 0;
621 }
622 #endif
623 
624 static const struct acpi_gpio_params int_last_device_wakeup_gpios = { 0, 0, false };
625 static const struct acpi_gpio_params int_last_shutdown_gpios = { 1, 0, false };
626 static const struct acpi_gpio_params int_last_host_wakeup_gpios = { 2, 0, false };
627 
628 static const struct acpi_gpio_mapping acpi_bcm_int_last_gpios[] = {
629 	{ "device-wakeup-gpios", &int_last_device_wakeup_gpios, 1 },
630 	{ "shutdown-gpios", &int_last_shutdown_gpios, 1 },
631 	{ "host-wakeup-gpios", &int_last_host_wakeup_gpios, 1 },
632 	{ },
633 };
634 
635 static const struct acpi_gpio_params int_first_host_wakeup_gpios = { 0, 0, false };
636 static const struct acpi_gpio_params int_first_device_wakeup_gpios = { 1, 0, false };
637 static const struct acpi_gpio_params int_first_shutdown_gpios = { 2, 0, false };
638 
639 static const struct acpi_gpio_mapping acpi_bcm_int_first_gpios[] = {
640 	{ "device-wakeup-gpios", &int_first_device_wakeup_gpios, 1 },
641 	{ "shutdown-gpios", &int_first_shutdown_gpios, 1 },
642 	{ "host-wakeup-gpios", &int_first_host_wakeup_gpios, 1 },
643 	{ },
644 };
645 
646 #ifdef CONFIG_ACPI
647 static u8 acpi_active_low = ACPI_ACTIVE_LOW;
648 
649 /* IRQ polarity of some chipsets are not defined correctly in ACPI table. */
650 static const struct dmi_system_id bcm_wrong_irq_dmi_table[] = {
651 	{
652 		.ident = "Asus T100TA",
653 		.matches = {
654 			DMI_EXACT_MATCH(DMI_SYS_VENDOR,
655 					"ASUSTeK COMPUTER INC."),
656 			DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "T100TA"),
657 		},
658 		.driver_data = &acpi_active_low,
659 	},
660 	{	/* Handle ThinkPad 8 tablets with BCM2E55 chipset ACPI ID */
661 		.ident = "Lenovo ThinkPad 8",
662 		.matches = {
663 			DMI_EXACT_MATCH(DMI_SYS_VENDOR, "LENOVO"),
664 			DMI_EXACT_MATCH(DMI_PRODUCT_VERSION, "ThinkPad 8"),
665 		},
666 		.driver_data = &acpi_active_low,
667 	},
668 	{ }
669 };
670 
671 static int bcm_resource(struct acpi_resource *ares, void *data)
672 {
673 	struct bcm_device *dev = data;
674 	struct acpi_resource_extended_irq *irq;
675 	struct acpi_resource_gpio *gpio;
676 	struct acpi_resource_uart_serialbus *sb;
677 
678 	switch (ares->type) {
679 	case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
680 		irq = &ares->data.extended_irq;
681 		dev->irq_polarity = irq->polarity;
682 		break;
683 
684 	case ACPI_RESOURCE_TYPE_GPIO:
685 		gpio = &ares->data.gpio;
686 		if (gpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT)
687 			dev->irq_polarity = gpio->polarity;
688 		break;
689 
690 	case ACPI_RESOURCE_TYPE_SERIAL_BUS:
691 		sb = &ares->data.uart_serial_bus;
692 		if (sb->type == ACPI_RESOURCE_SERIAL_TYPE_UART)
693 			dev->init_speed = sb->default_baud_rate;
694 		break;
695 
696 	default:
697 		break;
698 	}
699 
700 	/* Always tell the ACPI core to skip this resource */
701 	return 1;
702 }
703 #endif /* CONFIG_ACPI */
704 
705 static int bcm_platform_probe(struct bcm_device *dev)
706 {
707 	struct platform_device *pdev = dev->pdev;
708 
709 	dev->name = dev_name(&pdev->dev);
710 
711 	dev->clk = devm_clk_get(&pdev->dev, NULL);
712 
713 	dev->device_wakeup = devm_gpiod_get_optional(&pdev->dev,
714 						     "device-wakeup",
715 						     GPIOD_OUT_LOW);
716 	if (IS_ERR(dev->device_wakeup))
717 		return PTR_ERR(dev->device_wakeup);
718 
719 	dev->shutdown = devm_gpiod_get_optional(&pdev->dev, "shutdown",
720 						GPIOD_OUT_LOW);
721 	if (IS_ERR(dev->shutdown))
722 		return PTR_ERR(dev->shutdown);
723 
724 	/* IRQ can be declared in ACPI table as Interrupt or GpioInt */
725 	dev->irq = platform_get_irq(pdev, 0);
726 	if (dev->irq <= 0) {
727 		struct gpio_desc *gpio;
728 
729 		gpio = devm_gpiod_get_optional(&pdev->dev, "host-wakeup",
730 					       GPIOD_IN);
731 		if (IS_ERR(gpio))
732 			return PTR_ERR(gpio);
733 
734 		dev->irq = gpiod_to_irq(gpio);
735 	}
736 
737 	dev_info(&pdev->dev, "BCM irq: %d\n", dev->irq);
738 
739 	/* Make sure at-least one of the GPIO is defined and that
740 	 * a name is specified for this instance
741 	 */
742 	if ((!dev->device_wakeup && !dev->shutdown) || !dev->name) {
743 		dev_err(&pdev->dev, "invalid platform data\n");
744 		return -EINVAL;
745 	}
746 
747 	return 0;
748 }
749 
750 #ifdef CONFIG_ACPI
751 static int bcm_acpi_probe(struct bcm_device *dev)
752 {
753 	struct platform_device *pdev = dev->pdev;
754 	LIST_HEAD(resources);
755 	const struct dmi_system_id *dmi_id;
756 	const struct acpi_gpio_mapping *gpio_mapping = acpi_bcm_int_last_gpios;
757 	const struct acpi_device_id *id;
758 	int ret;
759 
760 	/* Retrieve GPIO data */
761 	id = acpi_match_device(pdev->dev.driver->acpi_match_table, &pdev->dev);
762 	if (id)
763 		gpio_mapping = (const struct acpi_gpio_mapping *) id->driver_data;
764 
765 	ret = acpi_dev_add_driver_gpios(ACPI_COMPANION(&pdev->dev),
766 					gpio_mapping);
767 	if (ret)
768 		return ret;
769 
770 	ret = bcm_platform_probe(dev);
771 	if (ret)
772 		return ret;
773 
774 	/* Retrieve UART ACPI info */
775 	ret = acpi_dev_get_resources(ACPI_COMPANION(&dev->pdev->dev),
776 				     &resources, bcm_resource, dev);
777 	if (ret < 0)
778 		return ret;
779 	acpi_dev_free_resource_list(&resources);
780 
781 	dmi_id = dmi_first_match(bcm_wrong_irq_dmi_table);
782 	if (dmi_id) {
783 		bt_dev_warn(dev, "%s: Overwriting IRQ polarity to active low",
784 			    dmi_id->ident);
785 		dev->irq_polarity = *(u8 *)dmi_id->driver_data;
786 	}
787 
788 	return 0;
789 }
790 #else
791 static int bcm_acpi_probe(struct bcm_device *dev)
792 {
793 	return -EINVAL;
794 }
795 #endif /* CONFIG_ACPI */
796 
797 static int bcm_probe(struct platform_device *pdev)
798 {
799 	struct bcm_device *dev;
800 	int ret;
801 
802 	dev = devm_kzalloc(&pdev->dev, sizeof(*dev), GFP_KERNEL);
803 	if (!dev)
804 		return -ENOMEM;
805 
806 	dev->pdev = pdev;
807 
808 	if (has_acpi_companion(&pdev->dev))
809 		ret = bcm_acpi_probe(dev);
810 	else
811 		ret = bcm_platform_probe(dev);
812 	if (ret)
813 		return ret;
814 
815 	platform_set_drvdata(pdev, dev);
816 
817 	dev_info(&pdev->dev, "%s device registered.\n", dev->name);
818 
819 	/* Place this instance on the device list */
820 	mutex_lock(&bcm_device_lock);
821 	list_add_tail(&dev->list, &bcm_device_list);
822 	mutex_unlock(&bcm_device_lock);
823 
824 	bcm_gpio_set_power(dev, false);
825 
826 	return 0;
827 }
828 
829 static int bcm_remove(struct platform_device *pdev)
830 {
831 	struct bcm_device *dev = platform_get_drvdata(pdev);
832 
833 	mutex_lock(&bcm_device_lock);
834 	list_del(&dev->list);
835 	mutex_unlock(&bcm_device_lock);
836 
837 	acpi_dev_remove_driver_gpios(ACPI_COMPANION(&pdev->dev));
838 
839 	dev_info(&pdev->dev, "%s device unregistered.\n", dev->name);
840 
841 	return 0;
842 }
843 
844 static const struct hci_uart_proto bcm_proto = {
845 	.id		= HCI_UART_BCM,
846 	.name		= "Broadcom",
847 	.manufacturer	= 15,
848 	.init_speed	= 115200,
849 	.oper_speed	= 4000000,
850 	.open		= bcm_open,
851 	.close		= bcm_close,
852 	.flush		= bcm_flush,
853 	.setup		= bcm_setup,
854 	.set_baudrate	= bcm_set_baudrate,
855 	.recv		= bcm_recv,
856 	.enqueue	= bcm_enqueue,
857 	.dequeue	= bcm_dequeue,
858 };
859 
860 #ifdef CONFIG_ACPI
861 static const struct acpi_device_id bcm_acpi_match[] = {
862 	{ "BCM2E1A", (kernel_ulong_t)&acpi_bcm_int_last_gpios },
863 	{ "BCM2E39", (kernel_ulong_t)&acpi_bcm_int_last_gpios },
864 	{ "BCM2E3A", (kernel_ulong_t)&acpi_bcm_int_last_gpios },
865 	{ "BCM2E3D", (kernel_ulong_t)&acpi_bcm_int_last_gpios },
866 	{ "BCM2E3F", (kernel_ulong_t)&acpi_bcm_int_last_gpios },
867 	{ "BCM2E40", (kernel_ulong_t)&acpi_bcm_int_last_gpios },
868 	{ "BCM2E54", (kernel_ulong_t)&acpi_bcm_int_last_gpios },
869 	{ "BCM2E55", (kernel_ulong_t)&acpi_bcm_int_last_gpios },
870 	{ "BCM2E64", (kernel_ulong_t)&acpi_bcm_int_last_gpios },
871 	{ "BCM2E65", (kernel_ulong_t)&acpi_bcm_int_last_gpios },
872 	{ "BCM2E67", (kernel_ulong_t)&acpi_bcm_int_last_gpios },
873 	{ "BCM2E71", (kernel_ulong_t)&acpi_bcm_int_last_gpios },
874 	{ "BCM2E7B", (kernel_ulong_t)&acpi_bcm_int_last_gpios },
875 	{ "BCM2E7C", (kernel_ulong_t)&acpi_bcm_int_last_gpios },
876 	{ "BCM2E95", (kernel_ulong_t)&acpi_bcm_int_first_gpios },
877 	{ "BCM2E96", (kernel_ulong_t)&acpi_bcm_int_first_gpios },
878 	{ },
879 };
880 MODULE_DEVICE_TABLE(acpi, bcm_acpi_match);
881 #endif
882 
883 /* Platform suspend and resume callbacks */
884 static const struct dev_pm_ops bcm_pm_ops = {
885 	SET_SYSTEM_SLEEP_PM_OPS(bcm_suspend, bcm_resume)
886 	SET_RUNTIME_PM_OPS(bcm_suspend_device, bcm_resume_device, NULL)
887 };
888 
889 static struct platform_driver bcm_driver = {
890 	.probe = bcm_probe,
891 	.remove = bcm_remove,
892 	.driver = {
893 		.name = "hci_bcm",
894 		.acpi_match_table = ACPI_PTR(bcm_acpi_match),
895 		.pm = &bcm_pm_ops,
896 	},
897 };
898 
899 int __init bcm_init(void)
900 {
901 	platform_driver_register(&bcm_driver);
902 
903 	return hci_uart_register_proto(&bcm_proto);
904 }
905 
906 int __exit bcm_deinit(void)
907 {
908 	platform_driver_unregister(&bcm_driver);
909 
910 	return hci_uart_unregister_proto(&bcm_proto);
911 }
912