xref: /openbmc/linux/drivers/bluetooth/hci_bcm.c (revision a06c488d)
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_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(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 	mutex_lock(&bcm_device_lock);
291 	list_for_each(p, &bcm_device_list) {
292 		struct bcm_device *dev = list_entry(p, struct bcm_device, list);
293 
294 		/* Retrieve saved bcm_device based on parent of the
295 		 * platform device (saved during device probe) and
296 		 * parent of tty device used by hci_uart
297 		 */
298 		if (hu->tty->dev->parent == dev->pdev->dev.parent) {
299 			bcm->dev = dev;
300 			hu->init_speed = dev->init_speed;
301 #ifdef CONFIG_PM
302 			dev->hu = hu;
303 #endif
304 			bcm_gpio_set_power(bcm->dev, true);
305 			break;
306 		}
307 	}
308 
309 	mutex_unlock(&bcm_device_lock);
310 
311 	return 0;
312 }
313 
314 static int bcm_close(struct hci_uart *hu)
315 {
316 	struct bcm_data *bcm = hu->priv;
317 	struct bcm_device *bdev = bcm->dev;
318 
319 	bt_dev_dbg(hu->hdev, "hu %p", hu);
320 
321 	/* Protect bcm->dev against removal of the device or driver */
322 	mutex_lock(&bcm_device_lock);
323 	if (bcm_device_exists(bdev)) {
324 		bcm_gpio_set_power(bdev, false);
325 #ifdef CONFIG_PM
326 		pm_runtime_disable(&bdev->pdev->dev);
327 		pm_runtime_set_suspended(&bdev->pdev->dev);
328 
329 		if (device_can_wakeup(&bdev->pdev->dev)) {
330 			devm_free_irq(&bdev->pdev->dev, bdev->irq, bdev);
331 			device_init_wakeup(&bdev->pdev->dev, false);
332 		}
333 
334 		bdev->hu = NULL;
335 #endif
336 	}
337 	mutex_unlock(&bcm_device_lock);
338 
339 	skb_queue_purge(&bcm->txq);
340 	kfree_skb(bcm->rx_skb);
341 	kfree(bcm);
342 
343 	hu->priv = NULL;
344 	return 0;
345 }
346 
347 static int bcm_flush(struct hci_uart *hu)
348 {
349 	struct bcm_data *bcm = hu->priv;
350 
351 	bt_dev_dbg(hu->hdev, "hu %p", hu);
352 
353 	skb_queue_purge(&bcm->txq);
354 
355 	return 0;
356 }
357 
358 static int bcm_setup(struct hci_uart *hu)
359 {
360 	struct bcm_data *bcm = hu->priv;
361 	char fw_name[64];
362 	const struct firmware *fw;
363 	unsigned int speed;
364 	int err;
365 
366 	bt_dev_dbg(hu->hdev, "hu %p", hu);
367 
368 	hu->hdev->set_diag = bcm_set_diag;
369 	hu->hdev->set_bdaddr = btbcm_set_bdaddr;
370 
371 	err = btbcm_initialize(hu->hdev, fw_name, sizeof(fw_name));
372 	if (err)
373 		return err;
374 
375 	err = request_firmware(&fw, fw_name, &hu->hdev->dev);
376 	if (err < 0) {
377 		bt_dev_info(hu->hdev, "BCM: Patch %s not found", fw_name);
378 		return 0;
379 	}
380 
381 	err = btbcm_patchram(hu->hdev, fw);
382 	if (err) {
383 		bt_dev_info(hu->hdev, "BCM: Patch failed (%d)", err);
384 		goto finalize;
385 	}
386 
387 	/* Init speed if any */
388 	if (hu->init_speed)
389 		speed = hu->init_speed;
390 	else if (hu->proto->init_speed)
391 		speed = hu->proto->init_speed;
392 	else
393 		speed = 0;
394 
395 	if (speed)
396 		hci_uart_set_baudrate(hu, speed);
397 
398 	/* Operational speed if any */
399 	if (hu->oper_speed)
400 		speed = hu->oper_speed;
401 	else if (hu->proto->oper_speed)
402 		speed = hu->proto->oper_speed;
403 	else
404 		speed = 0;
405 
406 	if (speed) {
407 		err = bcm_set_baudrate(hu, speed);
408 		if (!err)
409 			hci_uart_set_baudrate(hu, speed);
410 	}
411 
412 finalize:
413 	release_firmware(fw);
414 
415 	err = btbcm_finalize(hu->hdev);
416 	if (err)
417 		return err;
418 
419 	err = bcm_request_irq(bcm);
420 	if (!err)
421 		err = bcm_setup_sleep(hu);
422 
423 	return err;
424 }
425 
426 #define BCM_RECV_LM_DIAG \
427 	.type = BCM_LM_DIAG_PKT, \
428 	.hlen = BCM_LM_DIAG_SIZE, \
429 	.loff = 0, \
430 	.lsize = 0, \
431 	.maxlen = BCM_LM_DIAG_SIZE
432 
433 static const struct h4_recv_pkt bcm_recv_pkts[] = {
434 	{ H4_RECV_ACL,      .recv = hci_recv_frame },
435 	{ H4_RECV_SCO,      .recv = hci_recv_frame },
436 	{ H4_RECV_EVENT,    .recv = hci_recv_frame },
437 	{ BCM_RECV_LM_DIAG, .recv = hci_recv_diag  },
438 };
439 
440 static int bcm_recv(struct hci_uart *hu, const void *data, int count)
441 {
442 	struct bcm_data *bcm = hu->priv;
443 
444 	if (!test_bit(HCI_UART_REGISTERED, &hu->flags))
445 		return -EUNATCH;
446 
447 	bcm->rx_skb = h4_recv_buf(hu->hdev, bcm->rx_skb, data, count,
448 				  bcm_recv_pkts, ARRAY_SIZE(bcm_recv_pkts));
449 	if (IS_ERR(bcm->rx_skb)) {
450 		int err = PTR_ERR(bcm->rx_skb);
451 		bt_dev_err(hu->hdev, "Frame reassembly failed (%d)", err);
452 		bcm->rx_skb = NULL;
453 		return err;
454 	} else if (!bcm->rx_skb) {
455 		/* Delay auto-suspend when receiving completed packet */
456 		mutex_lock(&bcm_device_lock);
457 		if (bcm->dev && bcm_device_exists(bcm->dev)) {
458 			pm_runtime_get(&bcm->dev->pdev->dev);
459 			pm_runtime_mark_last_busy(&bcm->dev->pdev->dev);
460 			pm_runtime_put_autosuspend(&bcm->dev->pdev->dev);
461 		}
462 		mutex_unlock(&bcm_device_lock);
463 	}
464 
465 	return count;
466 }
467 
468 static int bcm_enqueue(struct hci_uart *hu, struct sk_buff *skb)
469 {
470 	struct bcm_data *bcm = hu->priv;
471 
472 	bt_dev_dbg(hu->hdev, "hu %p skb %p", hu, skb);
473 
474 	/* Prepend skb with frame type */
475 	memcpy(skb_push(skb, 1), &hci_skb_pkt_type(skb), 1);
476 	skb_queue_tail(&bcm->txq, skb);
477 
478 	return 0;
479 }
480 
481 static struct sk_buff *bcm_dequeue(struct hci_uart *hu)
482 {
483 	struct bcm_data *bcm = hu->priv;
484 	struct sk_buff *skb = NULL;
485 	struct bcm_device *bdev = NULL;
486 
487 	mutex_lock(&bcm_device_lock);
488 
489 	if (bcm_device_exists(bcm->dev)) {
490 		bdev = bcm->dev;
491 		pm_runtime_get_sync(&bdev->pdev->dev);
492 		/* Shall be resumed here */
493 	}
494 
495 	skb = skb_dequeue(&bcm->txq);
496 
497 	if (bdev) {
498 		pm_runtime_mark_last_busy(&bdev->pdev->dev);
499 		pm_runtime_put_autosuspend(&bdev->pdev->dev);
500 	}
501 
502 	mutex_unlock(&bcm_device_lock);
503 
504 	return skb;
505 }
506 
507 #ifdef CONFIG_PM
508 static int bcm_suspend_device(struct device *dev)
509 {
510 	struct bcm_device *bdev = platform_get_drvdata(to_platform_device(dev));
511 
512 	bt_dev_dbg(bdev, "");
513 
514 	if (!bdev->is_suspended && bdev->hu) {
515 		hci_uart_set_flow_control(bdev->hu, true);
516 
517 		/* Once this returns, driver suspends BT via GPIO */
518 		bdev->is_suspended = true;
519 	}
520 
521 	/* Suspend the device */
522 	if (bdev->device_wakeup) {
523 		gpiod_set_value(bdev->device_wakeup, false);
524 		bt_dev_dbg(bdev, "suspend, delaying 15 ms");
525 		mdelay(15);
526 	}
527 
528 	return 0;
529 }
530 
531 static int bcm_resume_device(struct device *dev)
532 {
533 	struct bcm_device *bdev = platform_get_drvdata(to_platform_device(dev));
534 
535 	bt_dev_dbg(bdev, "");
536 
537 	if (bdev->device_wakeup) {
538 		gpiod_set_value(bdev->device_wakeup, true);
539 		bt_dev_dbg(bdev, "resume, delaying 15 ms");
540 		mdelay(15);
541 	}
542 
543 	/* When this executes, the device has woken up already */
544 	if (bdev->is_suspended && bdev->hu) {
545 		bdev->is_suspended = false;
546 
547 		hci_uart_set_flow_control(bdev->hu, false);
548 	}
549 
550 	return 0;
551 }
552 #endif
553 
554 #ifdef CONFIG_PM_SLEEP
555 /* Platform suspend callback */
556 static int bcm_suspend(struct device *dev)
557 {
558 	struct bcm_device *bdev = platform_get_drvdata(to_platform_device(dev));
559 	int error;
560 
561 	bt_dev_dbg(bdev, "suspend: is_suspended %d", bdev->is_suspended);
562 
563 	/* bcm_suspend can be called at any time as long as platform device is
564 	 * bound, so it should use bcm_device_lock to protect access to hci_uart
565 	 * and device_wake-up GPIO.
566 	 */
567 	mutex_lock(&bcm_device_lock);
568 
569 	if (!bdev->hu)
570 		goto unlock;
571 
572 	if (pm_runtime_active(dev))
573 		bcm_suspend_device(dev);
574 
575 	if (device_may_wakeup(&bdev->pdev->dev)) {
576 		error = enable_irq_wake(bdev->irq);
577 		if (!error)
578 			bt_dev_dbg(bdev, "BCM irq: enabled");
579 	}
580 
581 unlock:
582 	mutex_unlock(&bcm_device_lock);
583 
584 	return 0;
585 }
586 
587 /* Platform resume callback */
588 static int bcm_resume(struct device *dev)
589 {
590 	struct bcm_device *bdev = platform_get_drvdata(to_platform_device(dev));
591 
592 	bt_dev_dbg(bdev, "resume: is_suspended %d", bdev->is_suspended);
593 
594 	/* bcm_resume can be called at any time as long as platform device is
595 	 * bound, so it should use bcm_device_lock to protect access to hci_uart
596 	 * and device_wake-up GPIO.
597 	 */
598 	mutex_lock(&bcm_device_lock);
599 
600 	if (!bdev->hu)
601 		goto unlock;
602 
603 	if (device_may_wakeup(&bdev->pdev->dev)) {
604 		disable_irq_wake(bdev->irq);
605 		bt_dev_dbg(bdev, "BCM irq: disabled");
606 	}
607 
608 	bcm_resume_device(dev);
609 
610 unlock:
611 	mutex_unlock(&bcm_device_lock);
612 
613 	pm_runtime_disable(dev);
614 	pm_runtime_set_active(dev);
615 	pm_runtime_enable(dev);
616 
617 	return 0;
618 }
619 #endif
620 
621 static const struct acpi_gpio_params device_wakeup_gpios = { 0, 0, false };
622 static const struct acpi_gpio_params shutdown_gpios = { 1, 0, false };
623 static const struct acpi_gpio_params host_wakeup_gpios = { 2, 0, false };
624 
625 static const struct acpi_gpio_mapping acpi_bcm_default_gpios[] = {
626 	{ "device-wakeup-gpios", &device_wakeup_gpios, 1 },
627 	{ "shutdown-gpios", &shutdown_gpios, 1 },
628 	{ "host-wakeup-gpios", &host_wakeup_gpios, 1 },
629 	{ },
630 };
631 
632 #ifdef CONFIG_ACPI
633 static u8 acpi_active_low = ACPI_ACTIVE_LOW;
634 
635 /* IRQ polarity of some chipsets are not defined correctly in ACPI table. */
636 static const struct dmi_system_id bcm_wrong_irq_dmi_table[] = {
637 	{
638 		.ident = "Asus T100TA",
639 		.matches = {
640 			DMI_EXACT_MATCH(DMI_SYS_VENDOR,
641 					"ASUSTeK COMPUTER INC."),
642 			DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "T100TA"),
643 		},
644 		.driver_data = &acpi_active_low,
645 	},
646 	{ }
647 };
648 
649 static int bcm_resource(struct acpi_resource *ares, void *data)
650 {
651 	struct bcm_device *dev = data;
652 	struct acpi_resource_extended_irq *irq;
653 	struct acpi_resource_gpio *gpio;
654 	struct acpi_resource_uart_serialbus *sb;
655 
656 	switch (ares->type) {
657 	case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
658 		irq = &ares->data.extended_irq;
659 		dev->irq_polarity = irq->polarity;
660 		break;
661 
662 	case ACPI_RESOURCE_TYPE_GPIO:
663 		gpio = &ares->data.gpio;
664 		if (gpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT)
665 			dev->irq_polarity = gpio->polarity;
666 		break;
667 
668 	case ACPI_RESOURCE_TYPE_SERIAL_BUS:
669 		sb = &ares->data.uart_serial_bus;
670 		if (sb->type == ACPI_RESOURCE_SERIAL_TYPE_UART)
671 			dev->init_speed = sb->default_baud_rate;
672 		break;
673 
674 	default:
675 		break;
676 	}
677 
678 	/* Always tell the ACPI core to skip this resource */
679 	return 1;
680 }
681 
682 static int bcm_acpi_probe(struct bcm_device *dev)
683 {
684 	struct platform_device *pdev = dev->pdev;
685 	LIST_HEAD(resources);
686 	const struct dmi_system_id *dmi_id;
687 	int ret;
688 
689 	/* Retrieve GPIO data */
690 	dev->name = dev_name(&pdev->dev);
691 	ret = acpi_dev_add_driver_gpios(ACPI_COMPANION(&pdev->dev),
692 					acpi_bcm_default_gpios);
693 	if (ret)
694 		return ret;
695 
696 	dev->clk = devm_clk_get(&pdev->dev, NULL);
697 
698 	dev->device_wakeup = devm_gpiod_get_optional(&pdev->dev,
699 						     "device-wakeup",
700 						     GPIOD_OUT_LOW);
701 	if (IS_ERR(dev->device_wakeup))
702 		return PTR_ERR(dev->device_wakeup);
703 
704 	dev->shutdown = devm_gpiod_get_optional(&pdev->dev, "shutdown",
705 						GPIOD_OUT_LOW);
706 	if (IS_ERR(dev->shutdown))
707 		return PTR_ERR(dev->shutdown);
708 
709 	/* IRQ can be declared in ACPI table as Interrupt or GpioInt */
710 	dev->irq = platform_get_irq(pdev, 0);
711 	if (dev->irq <= 0) {
712 		struct gpio_desc *gpio;
713 
714 		gpio = devm_gpiod_get_optional(&pdev->dev, "host-wakeup",
715 					       GPIOD_IN);
716 		if (IS_ERR(gpio))
717 			return PTR_ERR(gpio);
718 
719 		dev->irq = gpiod_to_irq(gpio);
720 	}
721 
722 	dev_info(&pdev->dev, "BCM irq: %d\n", dev->irq);
723 
724 	/* Make sure at-least one of the GPIO is defined and that
725 	 * a name is specified for this instance
726 	 */
727 	if ((!dev->device_wakeup && !dev->shutdown) || !dev->name) {
728 		dev_err(&pdev->dev, "invalid platform data\n");
729 		return -EINVAL;
730 	}
731 
732 	/* Retrieve UART ACPI info */
733 	ret = acpi_dev_get_resources(ACPI_COMPANION(&dev->pdev->dev),
734 				     &resources, bcm_resource, dev);
735 	if (ret < 0)
736 		return ret;
737 	acpi_dev_free_resource_list(&resources);
738 
739 	dmi_id = dmi_first_match(bcm_wrong_irq_dmi_table);
740 	if (dmi_id) {
741 		bt_dev_warn(dev, "%s: Overwriting IRQ polarity to active low",
742 			    dmi_id->ident);
743 		dev->irq_polarity = *(u8 *)dmi_id->driver_data;
744 	}
745 
746 	return 0;
747 }
748 #else
749 static int bcm_acpi_probe(struct bcm_device *dev)
750 {
751 	return -EINVAL;
752 }
753 #endif /* CONFIG_ACPI */
754 
755 static int bcm_probe(struct platform_device *pdev)
756 {
757 	struct bcm_device *dev;
758 	int ret;
759 
760 	dev = devm_kzalloc(&pdev->dev, sizeof(*dev), GFP_KERNEL);
761 	if (!dev)
762 		return -ENOMEM;
763 
764 	dev->pdev = pdev;
765 
766 	ret = bcm_acpi_probe(dev);
767 	if (ret)
768 		return ret;
769 
770 	platform_set_drvdata(pdev, dev);
771 
772 	dev_info(&pdev->dev, "%s device registered.\n", dev->name);
773 
774 	/* Place this instance on the device list */
775 	mutex_lock(&bcm_device_lock);
776 	list_add_tail(&dev->list, &bcm_device_list);
777 	mutex_unlock(&bcm_device_lock);
778 
779 	bcm_gpio_set_power(dev, false);
780 
781 	return 0;
782 }
783 
784 static int bcm_remove(struct platform_device *pdev)
785 {
786 	struct bcm_device *dev = platform_get_drvdata(pdev);
787 
788 	mutex_lock(&bcm_device_lock);
789 	list_del(&dev->list);
790 	mutex_unlock(&bcm_device_lock);
791 
792 	acpi_dev_remove_driver_gpios(ACPI_COMPANION(&pdev->dev));
793 
794 	dev_info(&pdev->dev, "%s device unregistered.\n", dev->name);
795 
796 	return 0;
797 }
798 
799 static const struct hci_uart_proto bcm_proto = {
800 	.id		= HCI_UART_BCM,
801 	.name		= "BCM",
802 	.manufacturer	= 15,
803 	.init_speed	= 115200,
804 	.oper_speed	= 4000000,
805 	.open		= bcm_open,
806 	.close		= bcm_close,
807 	.flush		= bcm_flush,
808 	.setup		= bcm_setup,
809 	.set_baudrate	= bcm_set_baudrate,
810 	.recv		= bcm_recv,
811 	.enqueue	= bcm_enqueue,
812 	.dequeue	= bcm_dequeue,
813 };
814 
815 #ifdef CONFIG_ACPI
816 static const struct acpi_device_id bcm_acpi_match[] = {
817 	{ "BCM2E1A", 0 },
818 	{ "BCM2E39", 0 },
819 	{ "BCM2E3A", 0 },
820 	{ "BCM2E3D", 0 },
821 	{ "BCM2E3F", 0 },
822 	{ "BCM2E40", 0 },
823 	{ "BCM2E64", 0 },
824 	{ "BCM2E65", 0 },
825 	{ "BCM2E67", 0 },
826 	{ "BCM2E7B", 0 },
827 	{ },
828 };
829 MODULE_DEVICE_TABLE(acpi, bcm_acpi_match);
830 #endif
831 
832 /* Platform suspend and resume callbacks */
833 static const struct dev_pm_ops bcm_pm_ops = {
834 	SET_SYSTEM_SLEEP_PM_OPS(bcm_suspend, bcm_resume)
835 	SET_RUNTIME_PM_OPS(bcm_suspend_device, bcm_resume_device, NULL)
836 };
837 
838 static struct platform_driver bcm_driver = {
839 	.probe = bcm_probe,
840 	.remove = bcm_remove,
841 	.driver = {
842 		.name = "hci_bcm",
843 		.acpi_match_table = ACPI_PTR(bcm_acpi_match),
844 		.pm = &bcm_pm_ops,
845 	},
846 };
847 
848 int __init bcm_init(void)
849 {
850 	platform_driver_register(&bcm_driver);
851 
852 	return hci_uart_register_proto(&bcm_proto);
853 }
854 
855 int __exit bcm_deinit(void)
856 {
857 	platform_driver_unregister(&bcm_driver);
858 
859 	return hci_uart_unregister_proto(&bcm_proto);
860 }
861