xref: /linux/drivers/bluetooth/hci_bcm.c (revision d257f9bf06129613de539ea71ecea60848b662cd)
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_u8(skb, BCM_LM_DIAG_PKT);
266 	skb_put_u8(skb, 0xf0);
267 	skb_put_u8(skb, 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 	if (!bcm_request_irq(bcm))
423 		err = bcm_setup_sleep(hu);
424 
425 	return err;
426 }
427 
428 #define BCM_RECV_LM_DIAG \
429 	.type = BCM_LM_DIAG_PKT, \
430 	.hlen = BCM_LM_DIAG_SIZE, \
431 	.loff = 0, \
432 	.lsize = 0, \
433 	.maxlen = BCM_LM_DIAG_SIZE
434 
435 static const struct h4_recv_pkt bcm_recv_pkts[] = {
436 	{ H4_RECV_ACL,      .recv = hci_recv_frame },
437 	{ H4_RECV_SCO,      .recv = hci_recv_frame },
438 	{ H4_RECV_EVENT,    .recv = hci_recv_frame },
439 	{ BCM_RECV_LM_DIAG, .recv = hci_recv_diag  },
440 };
441 
442 static int bcm_recv(struct hci_uart *hu, const void *data, int count)
443 {
444 	struct bcm_data *bcm = hu->priv;
445 
446 	if (!test_bit(HCI_UART_REGISTERED, &hu->flags))
447 		return -EUNATCH;
448 
449 	bcm->rx_skb = h4_recv_buf(hu->hdev, bcm->rx_skb, data, count,
450 				  bcm_recv_pkts, ARRAY_SIZE(bcm_recv_pkts));
451 	if (IS_ERR(bcm->rx_skb)) {
452 		int err = PTR_ERR(bcm->rx_skb);
453 		bt_dev_err(hu->hdev, "Frame reassembly failed (%d)", err);
454 		bcm->rx_skb = NULL;
455 		return err;
456 	} else if (!bcm->rx_skb) {
457 		/* Delay auto-suspend when receiving completed packet */
458 		mutex_lock(&bcm_device_lock);
459 		if (bcm->dev && bcm_device_exists(bcm->dev)) {
460 			pm_runtime_get(&bcm->dev->pdev->dev);
461 			pm_runtime_mark_last_busy(&bcm->dev->pdev->dev);
462 			pm_runtime_put_autosuspend(&bcm->dev->pdev->dev);
463 		}
464 		mutex_unlock(&bcm_device_lock);
465 	}
466 
467 	return count;
468 }
469 
470 static int bcm_enqueue(struct hci_uart *hu, struct sk_buff *skb)
471 {
472 	struct bcm_data *bcm = hu->priv;
473 
474 	bt_dev_dbg(hu->hdev, "hu %p skb %p", hu, skb);
475 
476 	/* Prepend skb with frame type */
477 	memcpy(skb_push(skb, 1), &hci_skb_pkt_type(skb), 1);
478 	skb_queue_tail(&bcm->txq, skb);
479 
480 	return 0;
481 }
482 
483 static struct sk_buff *bcm_dequeue(struct hci_uart *hu)
484 {
485 	struct bcm_data *bcm = hu->priv;
486 	struct sk_buff *skb = NULL;
487 	struct bcm_device *bdev = NULL;
488 
489 	mutex_lock(&bcm_device_lock);
490 
491 	if (bcm_device_exists(bcm->dev)) {
492 		bdev = bcm->dev;
493 		pm_runtime_get_sync(&bdev->pdev->dev);
494 		/* Shall be resumed here */
495 	}
496 
497 	skb = skb_dequeue(&bcm->txq);
498 
499 	if (bdev) {
500 		pm_runtime_mark_last_busy(&bdev->pdev->dev);
501 		pm_runtime_put_autosuspend(&bdev->pdev->dev);
502 	}
503 
504 	mutex_unlock(&bcm_device_lock);
505 
506 	return skb;
507 }
508 
509 #ifdef CONFIG_PM
510 static int bcm_suspend_device(struct device *dev)
511 {
512 	struct bcm_device *bdev = platform_get_drvdata(to_platform_device(dev));
513 
514 	bt_dev_dbg(bdev, "");
515 
516 	if (!bdev->is_suspended && bdev->hu) {
517 		hci_uart_set_flow_control(bdev->hu, true);
518 
519 		/* Once this returns, driver suspends BT via GPIO */
520 		bdev->is_suspended = true;
521 	}
522 
523 	/* Suspend the device */
524 	if (bdev->device_wakeup) {
525 		gpiod_set_value(bdev->device_wakeup, false);
526 		bt_dev_dbg(bdev, "suspend, delaying 15 ms");
527 		mdelay(15);
528 	}
529 
530 	return 0;
531 }
532 
533 static int bcm_resume_device(struct device *dev)
534 {
535 	struct bcm_device *bdev = platform_get_drvdata(to_platform_device(dev));
536 
537 	bt_dev_dbg(bdev, "");
538 
539 	if (bdev->device_wakeup) {
540 		gpiod_set_value(bdev->device_wakeup, true);
541 		bt_dev_dbg(bdev, "resume, delaying 15 ms");
542 		mdelay(15);
543 	}
544 
545 	/* When this executes, the device has woken up already */
546 	if (bdev->is_suspended && bdev->hu) {
547 		bdev->is_suspended = false;
548 
549 		hci_uart_set_flow_control(bdev->hu, false);
550 	}
551 
552 	return 0;
553 }
554 #endif
555 
556 #ifdef CONFIG_PM_SLEEP
557 /* Platform suspend callback */
558 static int bcm_suspend(struct device *dev)
559 {
560 	struct bcm_device *bdev = platform_get_drvdata(to_platform_device(dev));
561 	int error;
562 
563 	bt_dev_dbg(bdev, "suspend: is_suspended %d", bdev->is_suspended);
564 
565 	/* bcm_suspend can be called at any time as long as platform device is
566 	 * bound, so it should use bcm_device_lock to protect access to hci_uart
567 	 * and device_wake-up GPIO.
568 	 */
569 	mutex_lock(&bcm_device_lock);
570 
571 	if (!bdev->hu)
572 		goto unlock;
573 
574 	if (pm_runtime_active(dev))
575 		bcm_suspend_device(dev);
576 
577 	if (device_may_wakeup(&bdev->pdev->dev)) {
578 		error = enable_irq_wake(bdev->irq);
579 		if (!error)
580 			bt_dev_dbg(bdev, "BCM irq: enabled");
581 	}
582 
583 unlock:
584 	mutex_unlock(&bcm_device_lock);
585 
586 	return 0;
587 }
588 
589 /* Platform resume callback */
590 static int bcm_resume(struct device *dev)
591 {
592 	struct bcm_device *bdev = platform_get_drvdata(to_platform_device(dev));
593 
594 	bt_dev_dbg(bdev, "resume: is_suspended %d", bdev->is_suspended);
595 
596 	/* bcm_resume can be called at any time as long as platform device is
597 	 * bound, so it should use bcm_device_lock to protect access to hci_uart
598 	 * and device_wake-up GPIO.
599 	 */
600 	mutex_lock(&bcm_device_lock);
601 
602 	if (!bdev->hu)
603 		goto unlock;
604 
605 	if (device_may_wakeup(&bdev->pdev->dev)) {
606 		disable_irq_wake(bdev->irq);
607 		bt_dev_dbg(bdev, "BCM irq: disabled");
608 	}
609 
610 	bcm_resume_device(dev);
611 
612 unlock:
613 	mutex_unlock(&bcm_device_lock);
614 
615 	pm_runtime_disable(dev);
616 	pm_runtime_set_active(dev);
617 	pm_runtime_enable(dev);
618 
619 	return 0;
620 }
621 #endif
622 
623 static const struct acpi_gpio_params int_last_device_wakeup_gpios = { 0, 0, false };
624 static const struct acpi_gpio_params int_last_shutdown_gpios = { 1, 0, false };
625 static const struct acpi_gpio_params int_last_host_wakeup_gpios = { 2, 0, false };
626 
627 static const struct acpi_gpio_mapping acpi_bcm_int_last_gpios[] = {
628 	{ "device-wakeup-gpios", &int_last_device_wakeup_gpios, 1 },
629 	{ "shutdown-gpios", &int_last_shutdown_gpios, 1 },
630 	{ "host-wakeup-gpios", &int_last_host_wakeup_gpios, 1 },
631 	{ },
632 };
633 
634 static const struct acpi_gpio_params int_first_host_wakeup_gpios = { 0, 0, false };
635 static const struct acpi_gpio_params int_first_device_wakeup_gpios = { 1, 0, false };
636 static const struct acpi_gpio_params int_first_shutdown_gpios = { 2, 0, false };
637 
638 static const struct acpi_gpio_mapping acpi_bcm_int_first_gpios[] = {
639 	{ "device-wakeup-gpios", &int_first_device_wakeup_gpios, 1 },
640 	{ "shutdown-gpios", &int_first_shutdown_gpios, 1 },
641 	{ "host-wakeup-gpios", &int_first_host_wakeup_gpios, 1 },
642 	{ },
643 };
644 
645 #ifdef CONFIG_ACPI
646 static u8 acpi_active_low = ACPI_ACTIVE_LOW;
647 
648 /* IRQ polarity of some chipsets are not defined correctly in ACPI table. */
649 static const struct dmi_system_id bcm_wrong_irq_dmi_table[] = {
650 	{
651 		.ident = "Asus T100TA",
652 		.matches = {
653 			DMI_EXACT_MATCH(DMI_SYS_VENDOR,
654 					"ASUSTeK COMPUTER INC."),
655 			DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "T100TA"),
656 		},
657 		.driver_data = &acpi_active_low,
658 	},
659 	{
660 		.ident = "Asus T100CHI",
661 		.matches = {
662 			DMI_EXACT_MATCH(DMI_SYS_VENDOR,
663 					"ASUSTeK COMPUTER INC."),
664 			DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "T100CHI"),
665 		},
666 		.driver_data = &acpi_active_low,
667 	},
668 	{	/* Handle ThinkPad 8 tablets with BCM2E55 chipset ACPI ID */
669 		.ident = "Lenovo ThinkPad 8",
670 		.matches = {
671 			DMI_EXACT_MATCH(DMI_SYS_VENDOR, "LENOVO"),
672 			DMI_EXACT_MATCH(DMI_PRODUCT_VERSION, "ThinkPad 8"),
673 		},
674 		.driver_data = &acpi_active_low,
675 	},
676 	{ }
677 };
678 
679 static int bcm_resource(struct acpi_resource *ares, void *data)
680 {
681 	struct bcm_device *dev = data;
682 	struct acpi_resource_extended_irq *irq;
683 	struct acpi_resource_gpio *gpio;
684 	struct acpi_resource_uart_serialbus *sb;
685 
686 	switch (ares->type) {
687 	case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
688 		irq = &ares->data.extended_irq;
689 		dev->irq_polarity = irq->polarity;
690 		break;
691 
692 	case ACPI_RESOURCE_TYPE_GPIO:
693 		gpio = &ares->data.gpio;
694 		if (gpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT)
695 			dev->irq_polarity = gpio->polarity;
696 		break;
697 
698 	case ACPI_RESOURCE_TYPE_SERIAL_BUS:
699 		sb = &ares->data.uart_serial_bus;
700 		if (sb->type == ACPI_RESOURCE_SERIAL_TYPE_UART)
701 			dev->init_speed = sb->default_baud_rate;
702 		break;
703 
704 	default:
705 		break;
706 	}
707 
708 	/* Always tell the ACPI core to skip this resource */
709 	return 1;
710 }
711 #endif /* CONFIG_ACPI */
712 
713 static int bcm_platform_probe(struct bcm_device *dev)
714 {
715 	struct platform_device *pdev = dev->pdev;
716 
717 	dev->name = dev_name(&pdev->dev);
718 
719 	dev->clk = devm_clk_get(&pdev->dev, NULL);
720 
721 	dev->device_wakeup = devm_gpiod_get_optional(&pdev->dev,
722 						     "device-wakeup",
723 						     GPIOD_OUT_LOW);
724 	if (IS_ERR(dev->device_wakeup))
725 		return PTR_ERR(dev->device_wakeup);
726 
727 	dev->shutdown = devm_gpiod_get_optional(&pdev->dev, "shutdown",
728 						GPIOD_OUT_LOW);
729 	if (IS_ERR(dev->shutdown))
730 		return PTR_ERR(dev->shutdown);
731 
732 	/* IRQ can be declared in ACPI table as Interrupt or GpioInt */
733 	dev->irq = platform_get_irq(pdev, 0);
734 	if (dev->irq <= 0) {
735 		struct gpio_desc *gpio;
736 
737 		gpio = devm_gpiod_get_optional(&pdev->dev, "host-wakeup",
738 					       GPIOD_IN);
739 		if (IS_ERR(gpio))
740 			return PTR_ERR(gpio);
741 
742 		dev->irq = gpiod_to_irq(gpio);
743 	}
744 
745 	dev_info(&pdev->dev, "BCM irq: %d\n", dev->irq);
746 
747 	/* Make sure at-least one of the GPIO is defined and that
748 	 * a name is specified for this instance
749 	 */
750 	if ((!dev->device_wakeup && !dev->shutdown) || !dev->name) {
751 		dev_err(&pdev->dev, "invalid platform data\n");
752 		return -EINVAL;
753 	}
754 
755 	return 0;
756 }
757 
758 #ifdef CONFIG_ACPI
759 static int bcm_acpi_probe(struct bcm_device *dev)
760 {
761 	struct platform_device *pdev = dev->pdev;
762 	LIST_HEAD(resources);
763 	const struct dmi_system_id *dmi_id;
764 	const struct acpi_gpio_mapping *gpio_mapping = acpi_bcm_int_last_gpios;
765 	const struct acpi_device_id *id;
766 	int ret;
767 
768 	/* Retrieve GPIO data */
769 	id = acpi_match_device(pdev->dev.driver->acpi_match_table, &pdev->dev);
770 	if (id)
771 		gpio_mapping = (const struct acpi_gpio_mapping *) id->driver_data;
772 
773 	ret = devm_acpi_dev_add_driver_gpios(&pdev->dev, gpio_mapping);
774 	if (ret)
775 		return ret;
776 
777 	ret = bcm_platform_probe(dev);
778 	if (ret)
779 		return ret;
780 
781 	/* Retrieve UART ACPI info */
782 	ret = acpi_dev_get_resources(ACPI_COMPANION(&dev->pdev->dev),
783 				     &resources, bcm_resource, dev);
784 	if (ret < 0)
785 		return ret;
786 	acpi_dev_free_resource_list(&resources);
787 
788 	dmi_id = dmi_first_match(bcm_wrong_irq_dmi_table);
789 	if (dmi_id) {
790 		bt_dev_warn(dev, "%s: Overwriting IRQ polarity to active low",
791 			    dmi_id->ident);
792 		dev->irq_polarity = *(u8 *)dmi_id->driver_data;
793 	}
794 
795 	return 0;
796 }
797 #else
798 static int bcm_acpi_probe(struct bcm_device *dev)
799 {
800 	return -EINVAL;
801 }
802 #endif /* CONFIG_ACPI */
803 
804 static int bcm_probe(struct platform_device *pdev)
805 {
806 	struct bcm_device *dev;
807 	int ret;
808 
809 	dev = devm_kzalloc(&pdev->dev, sizeof(*dev), GFP_KERNEL);
810 	if (!dev)
811 		return -ENOMEM;
812 
813 	dev->pdev = pdev;
814 
815 	if (has_acpi_companion(&pdev->dev))
816 		ret = bcm_acpi_probe(dev);
817 	else
818 		ret = bcm_platform_probe(dev);
819 	if (ret)
820 		return ret;
821 
822 	platform_set_drvdata(pdev, dev);
823 
824 	dev_info(&pdev->dev, "%s device registered.\n", dev->name);
825 
826 	/* Place this instance on the device list */
827 	mutex_lock(&bcm_device_lock);
828 	list_add_tail(&dev->list, &bcm_device_list);
829 	mutex_unlock(&bcm_device_lock);
830 
831 	bcm_gpio_set_power(dev, false);
832 
833 	return 0;
834 }
835 
836 static int bcm_remove(struct platform_device *pdev)
837 {
838 	struct bcm_device *dev = platform_get_drvdata(pdev);
839 
840 	mutex_lock(&bcm_device_lock);
841 	list_del(&dev->list);
842 	mutex_unlock(&bcm_device_lock);
843 
844 	dev_info(&pdev->dev, "%s device unregistered.\n", dev->name);
845 
846 	return 0;
847 }
848 
849 static const struct hci_uart_proto bcm_proto = {
850 	.id		= HCI_UART_BCM,
851 	.name		= "Broadcom",
852 	.manufacturer	= 15,
853 	.init_speed	= 115200,
854 	.oper_speed	= 4000000,
855 	.open		= bcm_open,
856 	.close		= bcm_close,
857 	.flush		= bcm_flush,
858 	.setup		= bcm_setup,
859 	.set_baudrate	= bcm_set_baudrate,
860 	.recv		= bcm_recv,
861 	.enqueue	= bcm_enqueue,
862 	.dequeue	= bcm_dequeue,
863 };
864 
865 #ifdef CONFIG_ACPI
866 static const struct acpi_device_id bcm_acpi_match[] = {
867 	{ "BCM2E1A", (kernel_ulong_t)&acpi_bcm_int_last_gpios },
868 	{ "BCM2E39", (kernel_ulong_t)&acpi_bcm_int_last_gpios },
869 	{ "BCM2E3A", (kernel_ulong_t)&acpi_bcm_int_last_gpios },
870 	{ "BCM2E3D", (kernel_ulong_t)&acpi_bcm_int_last_gpios },
871 	{ "BCM2E3F", (kernel_ulong_t)&acpi_bcm_int_last_gpios },
872 	{ "BCM2E40", (kernel_ulong_t)&acpi_bcm_int_last_gpios },
873 	{ "BCM2E54", (kernel_ulong_t)&acpi_bcm_int_last_gpios },
874 	{ "BCM2E55", (kernel_ulong_t)&acpi_bcm_int_last_gpios },
875 	{ "BCM2E64", (kernel_ulong_t)&acpi_bcm_int_last_gpios },
876 	{ "BCM2E65", (kernel_ulong_t)&acpi_bcm_int_last_gpios },
877 	{ "BCM2E67", (kernel_ulong_t)&acpi_bcm_int_last_gpios },
878 	{ "BCM2E71", (kernel_ulong_t)&acpi_bcm_int_last_gpios },
879 	{ "BCM2E7B", (kernel_ulong_t)&acpi_bcm_int_last_gpios },
880 	{ "BCM2E7C", (kernel_ulong_t)&acpi_bcm_int_last_gpios },
881 	{ "BCM2E95", (kernel_ulong_t)&acpi_bcm_int_first_gpios },
882 	{ "BCM2E96", (kernel_ulong_t)&acpi_bcm_int_first_gpios },
883 	{ },
884 };
885 MODULE_DEVICE_TABLE(acpi, bcm_acpi_match);
886 #endif
887 
888 /* Platform suspend and resume callbacks */
889 static const struct dev_pm_ops bcm_pm_ops = {
890 	SET_SYSTEM_SLEEP_PM_OPS(bcm_suspend, bcm_resume)
891 	SET_RUNTIME_PM_OPS(bcm_suspend_device, bcm_resume_device, NULL)
892 };
893 
894 static struct platform_driver bcm_driver = {
895 	.probe = bcm_probe,
896 	.remove = bcm_remove,
897 	.driver = {
898 		.name = "hci_bcm",
899 		.acpi_match_table = ACPI_PTR(bcm_acpi_match),
900 		.pm = &bcm_pm_ops,
901 	},
902 };
903 
904 int __init bcm_init(void)
905 {
906 	platform_driver_register(&bcm_driver);
907 
908 	return hci_uart_register_proto(&bcm_proto);
909 }
910 
911 int __exit bcm_deinit(void)
912 {
913 	platform_driver_unregister(&bcm_driver);
914 
915 	return hci_uart_unregister_proto(&bcm_proto);
916 }
917