xref: /linux/drivers/bluetooth/hci_bcm.c (revision 3a2c4d55e32ad65efebdb6de44eef3bfa08bb49d)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  *
4  *  Bluetooth HCI UART driver for Broadcom devices
5  *
6  *  Copyright (C) 2015  Intel Corporation
7  */
8 
9 #include <linux/kernel.h>
10 #include <linux/errno.h>
11 #include <linux/skbuff.h>
12 #include <linux/firmware.h>
13 #include <linux/module.h>
14 #include <linux/acpi.h>
15 #include <linux/of.h>
16 #include <linux/of_irq.h>
17 #include <linux/property.h>
18 #include <linux/platform_data/x86/apple.h>
19 #include <linux/platform_device.h>
20 #include <linux/regulator/consumer.h>
21 #include <linux/clk.h>
22 #include <linux/gpio/consumer.h>
23 #include <linux/gpio/machine.h>
24 #include <linux/tty.h>
25 #include <linux/interrupt.h>
26 #include <linux/dmi.h>
27 #include <linux/pm_runtime.h>
28 #include <linux/serdev.h>
29 
30 #include <net/bluetooth/bluetooth.h>
31 #include <net/bluetooth/hci_core.h>
32 
33 #include "btbcm.h"
34 #include "hci_uart.h"
35 
36 #define BCM_NULL_PKT 0x00
37 #define BCM_NULL_SIZE 0
38 
39 #define BCM_LM_DIAG_PKT 0x07
40 #define BCM_LM_DIAG_SIZE 63
41 
42 #define BCM_TYPE49_PKT 0x31
43 #define BCM_TYPE49_SIZE 0
44 
45 #define BCM_TYPE52_PKT 0x34
46 #define BCM_TYPE52_SIZE 0
47 
48 #define BCM_AUTOSUSPEND_DELAY	5000 /* default autosleep delay */
49 
50 #define BCM_NUM_SUPPLIES 2
51 
52 /**
53  * struct bcm_device_data - device specific data
54  * @no_early_set_baudrate: Disallow set baudrate before driver setup()
55  * @drive_rts_on_open: drive RTS signal on ->open() when platform requires it
56  * @no_uart_clock_set: UART clock set command for >3Mbps mode is unavailable
57  * @max_autobaud_speed: max baudrate supported by device in autobaud mode
58  * @max_speed: max baudrate supported
59  */
60 struct bcm_device_data {
61 	bool	no_early_set_baudrate;
62 	bool	drive_rts_on_open;
63 	bool	no_uart_clock_set;
64 	u32	max_autobaud_speed;
65 	u32	max_speed;
66 };
67 
68 /**
69  * struct bcm_device - device driver resources
70  * @serdev_hu: HCI UART controller struct
71  * @list: bcm_device_list node
72  * @dev: physical UART slave
73  * @name: device name logged by bt_dev_*() functions
74  * @device_wakeup: BT_WAKE pin,
75  *	assert = Bluetooth device must wake up or remain awake,
76  *	deassert = Bluetooth device may sleep when sleep criteria are met
77  * @shutdown: BT_REG_ON pin,
78  *	power up or power down Bluetooth device internal regulators
79  * @reset: BT_RST_N pin,
80  *	active low resets the Bluetooth logic core
81  * @set_device_wakeup: callback to toggle BT_WAKE pin
82  *	either by accessing @device_wakeup or by calling @btlp
83  * @set_shutdown: callback to toggle BT_REG_ON pin
84  *	either by accessing @shutdown or by calling @btpu/@btpd
85  * @btlp: Apple ACPI method to toggle BT_WAKE pin ("Bluetooth Low Power")
86  * @btpu: Apple ACPI method to drive BT_REG_ON pin high ("Bluetooth Power Up")
87  * @btpd: Apple ACPI method to drive BT_REG_ON pin low ("Bluetooth Power Down")
88  * @gpio_count: internal counter for GPIO resources associated with ACPI device
89  * @gpio_int_idx: index in _CRS for GpioInt() resource
90  * @txco_clk: external reference frequency clock used by Bluetooth device
91  * @lpo_clk: external LPO clock used by Bluetooth device
92  * @supplies: VBAT and VDDIO supplies used by Bluetooth device
93  * @res_enabled: whether clocks and supplies are prepared and enabled
94  * @init_speed: default baudrate of Bluetooth device;
95  *	the host UART is initially set to this baudrate so that
96  *	it can configure the Bluetooth device for @oper_speed
97  * @oper_speed: preferred baudrate of Bluetooth device;
98  *	set to 0 if @init_speed is already the preferred baudrate
99  * @irq: interrupt triggered by HOST_WAKE_BT pin
100  * @irq_active_low: whether @irq is active low
101  * @irq_acquired: flag to show if IRQ handler has been assigned
102  * @hu: pointer to HCI UART controller struct,
103  *	used to disable flow control during runtime suspend and system sleep
104  * @is_suspended: whether flow control is currently disabled
105  * @no_early_set_baudrate: don't set_baudrate before setup()
106  * @drive_rts_on_open: drive RTS signal on ->open() when platform requires it
107  * @no_uart_clock_set: UART clock set command for >3Mbps mode is unavailable
108  * @pcm_int_params: keep the initial PCM configuration
109  * @use_autobaud_mode: start Bluetooth device in autobaud mode
110  * @max_autobaud_speed: max baudrate supported by device in autobaud mode
111  */
112 struct bcm_device {
113 	/* Must be the first member, hci_serdev.c expects this. */
114 	struct hci_uart		serdev_hu;
115 	struct list_head	list;
116 
117 	struct device		*dev;
118 
119 	const char		*name;
120 	struct gpio_desc	*device_wakeup;
121 	struct gpio_desc	*shutdown;
122 	struct gpio_desc	*reset;
123 	int			(*set_device_wakeup)(struct bcm_device *, bool);
124 	int			(*set_shutdown)(struct bcm_device *, bool);
125 #ifdef CONFIG_ACPI
126 	acpi_handle		btlp, btpu, btpd;
127 	int			gpio_count;
128 	int			gpio_int_idx;
129 #endif
130 
131 	struct clk		*txco_clk;
132 	struct clk		*lpo_clk;
133 	struct regulator_bulk_data supplies[BCM_NUM_SUPPLIES];
134 	bool			res_enabled;
135 
136 	u32			init_speed;
137 	u32			oper_speed;
138 	int			irq;
139 	bool			irq_active_low;
140 	bool			irq_acquired;
141 
142 #ifdef CONFIG_PM
143 	struct hci_uart		*hu;
144 	bool			is_suspended;
145 #endif
146 	bool			no_early_set_baudrate;
147 	bool			drive_rts_on_open;
148 	bool			no_uart_clock_set;
149 	bool			use_autobaud_mode;
150 	u8			pcm_int_params[5];
151 	u32			max_autobaud_speed;
152 };
153 
154 /* generic bcm uart resources */
155 struct bcm_data {
156 	struct sk_buff		*rx_skb;
157 	struct sk_buff_head	txq;
158 
159 	struct bcm_device	*dev;
160 };
161 
162 /* List of BCM BT UART devices */
163 static DEFINE_MUTEX(bcm_device_lock);
164 static LIST_HEAD(bcm_device_list);
165 
166 static int irq_polarity = -1;
167 module_param(irq_polarity, int, 0444);
168 MODULE_PARM_DESC(irq_polarity, "IRQ polarity 0: active-high 1: active-low");
169 
170 static inline void host_set_baudrate(struct hci_uart *hu, unsigned int speed)
171 {
172 	if (hu->serdev)
173 		serdev_device_set_baudrate(hu->serdev, speed);
174 	else
175 		hci_uart_set_baudrate(hu, speed);
176 }
177 
178 static int bcm_set_baudrate(struct hci_uart *hu, unsigned int speed)
179 {
180 	struct hci_dev *hdev = hu->hdev;
181 	struct bcm_data *bcm = hu->priv;
182 	struct sk_buff *skb;
183 	struct bcm_update_uart_baud_rate param;
184 
185 	if (speed > 3000000 && !bcm->dev->no_uart_clock_set) {
186 		struct bcm_write_uart_clock_setting clock;
187 
188 		clock.type = BCM_UART_CLOCK_48MHZ;
189 
190 		bt_dev_dbg(hdev, "Set Controller clock (%d)", clock.type);
191 
192 		/* This Broadcom specific command changes the UART's controller
193 		 * clock for baud rate > 3000000.
194 		 */
195 		skb = __hci_cmd_sync(hdev, 0xfc45, 1, &clock, HCI_INIT_TIMEOUT);
196 		if (IS_ERR(skb)) {
197 			int err = PTR_ERR(skb);
198 			bt_dev_err(hdev, "BCM: failed to write clock (%d)",
199 				   err);
200 			return err;
201 		}
202 
203 		kfree_skb(skb);
204 	}
205 
206 	bt_dev_dbg(hdev, "Set Controller UART speed to %d bit/s", speed);
207 
208 	param.zero = cpu_to_le16(0);
209 	param.baud_rate = cpu_to_le32(speed);
210 
211 	/* This Broadcom specific command changes the UART's controller baud
212 	 * rate.
213 	 */
214 	skb = __hci_cmd_sync(hdev, 0xfc18, sizeof(param), &param,
215 			     HCI_INIT_TIMEOUT);
216 	if (IS_ERR(skb)) {
217 		int err = PTR_ERR(skb);
218 		bt_dev_err(hdev, "BCM: failed to write update baudrate (%d)",
219 			   err);
220 		return err;
221 	}
222 
223 	kfree_skb(skb);
224 
225 	return 0;
226 }
227 
228 /* bcm_device_exists should be protected by bcm_device_lock */
229 static bool bcm_device_exists(struct bcm_device *device)
230 {
231 	struct list_head *p;
232 
233 #ifdef CONFIG_PM
234 	/* Devices using serdev always exist */
235 	if (device && device->hu && device->hu->serdev)
236 		return true;
237 #endif
238 
239 	list_for_each(p, &bcm_device_list) {
240 		struct bcm_device *dev = list_entry(p, struct bcm_device, list);
241 
242 		if (device == dev)
243 			return true;
244 	}
245 
246 	return false;
247 }
248 
249 static int bcm_gpio_set_power(struct bcm_device *dev, bool powered)
250 {
251 	int err;
252 
253 	if (powered && !dev->res_enabled) {
254 		/* Intel Macs use bcm_apple_get_resources() and don't
255 		 * have regulator supplies configured.
256 		 */
257 		if (dev->supplies[0].supply) {
258 			err = regulator_bulk_enable(BCM_NUM_SUPPLIES,
259 						    dev->supplies);
260 			if (err)
261 				return err;
262 		}
263 
264 		/* LPO clock needs to be 32.768 kHz */
265 		err = clk_set_rate(dev->lpo_clk, 32768);
266 		if (err) {
267 			dev_err(dev->dev, "Could not set LPO clock rate\n");
268 			goto err_regulator_disable;
269 		}
270 
271 		err = clk_prepare_enable(dev->lpo_clk);
272 		if (err)
273 			goto err_regulator_disable;
274 
275 		err = clk_prepare_enable(dev->txco_clk);
276 		if (err)
277 			goto err_lpo_clk_disable;
278 	}
279 
280 	err = dev->set_shutdown(dev, powered);
281 	if (err)
282 		goto err_txco_clk_disable;
283 
284 	err = dev->set_device_wakeup(dev, powered);
285 	if (err)
286 		goto err_revert_shutdown;
287 
288 	if (!powered && dev->res_enabled) {
289 		clk_disable_unprepare(dev->txco_clk);
290 		clk_disable_unprepare(dev->lpo_clk);
291 
292 		/* Intel Macs use bcm_apple_get_resources() and don't
293 		 * have regulator supplies configured.
294 		 */
295 		if (dev->supplies[0].supply)
296 			regulator_bulk_disable(BCM_NUM_SUPPLIES,
297 					       dev->supplies);
298 	}
299 
300 	/* wait for device to power on and come out of reset */
301 	usleep_range(100000, 120000);
302 
303 	dev->res_enabled = powered;
304 
305 	return 0;
306 
307 err_revert_shutdown:
308 	dev->set_shutdown(dev, !powered);
309 err_txco_clk_disable:
310 	if (powered && !dev->res_enabled)
311 		clk_disable_unprepare(dev->txco_clk);
312 err_lpo_clk_disable:
313 	if (powered && !dev->res_enabled)
314 		clk_disable_unprepare(dev->lpo_clk);
315 err_regulator_disable:
316 	if (powered && !dev->res_enabled)
317 		regulator_bulk_disable(BCM_NUM_SUPPLIES, dev->supplies);
318 	return err;
319 }
320 
321 #ifdef CONFIG_PM
322 static irqreturn_t bcm_host_wake(int irq, void *data)
323 {
324 	struct bcm_device *bdev = data;
325 
326 	bt_dev_dbg(bdev, "Host wake IRQ");
327 
328 	pm_runtime_get(bdev->dev);
329 	pm_runtime_put_autosuspend(bdev->dev);
330 
331 	return IRQ_HANDLED;
332 }
333 
334 static int bcm_request_irq(struct bcm_data *bcm)
335 {
336 	struct bcm_device *bdev = bcm->dev;
337 	int err;
338 
339 	mutex_lock(&bcm_device_lock);
340 	if (!bcm_device_exists(bdev)) {
341 		err = -ENODEV;
342 		goto unlock;
343 	}
344 
345 	if (bdev->irq <= 0) {
346 		err = -EOPNOTSUPP;
347 		goto unlock;
348 	}
349 
350 	err = devm_request_irq(bdev->dev, bdev->irq, bcm_host_wake,
351 			       bdev->irq_active_low ? IRQF_TRIGGER_FALLING :
352 						      IRQF_TRIGGER_RISING,
353 			       "host_wake", bdev);
354 	if (err) {
355 		bdev->irq = err;
356 		goto unlock;
357 	}
358 
359 	bdev->irq_acquired = true;
360 
361 	device_init_wakeup(bdev->dev, true);
362 
363 	pm_runtime_set_autosuspend_delay(bdev->dev,
364 					 BCM_AUTOSUSPEND_DELAY);
365 	pm_runtime_use_autosuspend(bdev->dev);
366 	pm_runtime_set_active(bdev->dev);
367 	pm_runtime_enable(bdev->dev);
368 
369 unlock:
370 	mutex_unlock(&bcm_device_lock);
371 
372 	return err;
373 }
374 
375 static const struct bcm_set_sleep_mode default_sleep_params = {
376 	.sleep_mode = 1,	/* 0=Disabled, 1=UART, 2=Reserved, 3=USB */
377 	.idle_host = 2,		/* idle threshold HOST, in 300ms */
378 	.idle_dev = 2,		/* idle threshold device, in 300ms */
379 	.bt_wake_active = 1,	/* BT_WAKE active mode: 1 = high, 0 = low */
380 	.host_wake_active = 0,	/* HOST_WAKE active mode: 1 = high, 0 = low */
381 	.allow_host_sleep = 1,	/* Allow host sleep in SCO flag */
382 	.combine_modes = 1,	/* Combine sleep and LPM flag */
383 	.tristate_control = 0,	/* Allow tri-state control of UART tx flag */
384 	/* Irrelevant USB flags */
385 	.usb_auto_sleep = 0,
386 	.usb_resume_timeout = 0,
387 	.break_to_host = 0,
388 	.pulsed_host_wake = 1,
389 };
390 
391 static int bcm_setup_sleep(struct hci_uart *hu)
392 {
393 	struct bcm_data *bcm = hu->priv;
394 	struct sk_buff *skb;
395 	struct bcm_set_sleep_mode sleep_params = default_sleep_params;
396 
397 	sleep_params.host_wake_active = !bcm->dev->irq_active_low;
398 
399 	skb = __hci_cmd_sync(hu->hdev, 0xfc27, sizeof(sleep_params),
400 			     &sleep_params, HCI_INIT_TIMEOUT);
401 	if (IS_ERR(skb)) {
402 		int err = PTR_ERR(skb);
403 		bt_dev_err(hu->hdev, "Sleep VSC failed (%d)", err);
404 		return err;
405 	}
406 	kfree_skb(skb);
407 
408 	bt_dev_dbg(hu->hdev, "Set Sleep Parameters VSC succeeded");
409 
410 	return 0;
411 }
412 #else
413 static inline int bcm_request_irq(struct bcm_data *bcm) { return 0; }
414 static inline int bcm_setup_sleep(struct hci_uart *hu) { return 0; }
415 #endif
416 
417 static int bcm_set_diag(struct hci_dev *hdev, bool enable)
418 {
419 	struct hci_uart *hu = hci_get_drvdata(hdev);
420 	struct bcm_data *bcm = hu->priv;
421 	struct sk_buff *skb;
422 
423 	if (!test_bit(HCI_RUNNING, &hdev->flags))
424 		return -ENETDOWN;
425 
426 	skb = bt_skb_alloc(3, GFP_KERNEL);
427 	if (!skb)
428 		return -ENOMEM;
429 
430 	skb_put_u8(skb, BCM_LM_DIAG_PKT);
431 	skb_put_u8(skb, 0xf0);
432 	skb_put_u8(skb, enable);
433 
434 	skb_queue_tail(&bcm->txq, skb);
435 	hci_uart_tx_wakeup(hu);
436 
437 	return 0;
438 }
439 
440 static int bcm_open(struct hci_uart *hu)
441 {
442 	struct bcm_data *bcm;
443 	struct list_head *p;
444 	int err;
445 
446 	bt_dev_dbg(hu->hdev, "hu %p", hu);
447 
448 	if (!hci_uart_has_flow_control(hu))
449 		return -EOPNOTSUPP;
450 
451 	bcm = kzalloc_obj(*bcm);
452 	if (!bcm)
453 		return -ENOMEM;
454 
455 	skb_queue_head_init(&bcm->txq);
456 
457 	hu->priv = bcm;
458 
459 	mutex_lock(&bcm_device_lock);
460 
461 	if (hu->serdev) {
462 		bcm->dev = serdev_device_get_drvdata(hu->serdev);
463 		goto out;
464 	}
465 
466 	if (!hu->tty->dev)
467 		goto out;
468 
469 	list_for_each(p, &bcm_device_list) {
470 		struct bcm_device *dev = list_entry(p, struct bcm_device, list);
471 
472 		/* Retrieve saved bcm_device based on parent of the
473 		 * platform device (saved during device probe) and
474 		 * parent of tty device used by hci_uart
475 		 */
476 		if (hu->tty->dev->parent == dev->dev->parent) {
477 			bcm->dev = dev;
478 #ifdef CONFIG_PM
479 			dev->hu = hu;
480 #endif
481 			break;
482 		}
483 	}
484 
485 out:
486 	if (bcm->dev) {
487 		if (bcm->dev->use_autobaud_mode)
488 			hci_uart_set_flow_control(hu, false);	/* Assert BT_UART_CTS_N */
489 		else if (bcm->dev->drive_rts_on_open)
490 			hci_uart_set_flow_control(hu, true);
491 
492 		if (bcm->dev->use_autobaud_mode && bcm->dev->max_autobaud_speed)
493 			hu->init_speed = min(bcm->dev->oper_speed, bcm->dev->max_autobaud_speed);
494 		else
495 			hu->init_speed = bcm->dev->init_speed;
496 
497 		/* If oper_speed is set, ldisc/serdev will set the baudrate
498 		 * before calling setup()
499 		 */
500 		if (!bcm->dev->no_early_set_baudrate && !bcm->dev->use_autobaud_mode)
501 			hu->oper_speed = bcm->dev->oper_speed;
502 
503 		err = bcm_gpio_set_power(bcm->dev, true);
504 
505 		if (bcm->dev->drive_rts_on_open)
506 			hci_uart_set_flow_control(hu, false);
507 
508 		if (err)
509 			goto err_unset_hu;
510 	}
511 
512 	mutex_unlock(&bcm_device_lock);
513 	return 0;
514 
515 err_unset_hu:
516 #ifdef CONFIG_PM
517 	if (!hu->serdev)
518 		bcm->dev->hu = NULL;
519 #endif
520 	mutex_unlock(&bcm_device_lock);
521 	hu->priv = NULL;
522 	kfree(bcm);
523 	return err;
524 }
525 
526 static int bcm_close(struct hci_uart *hu)
527 {
528 	struct bcm_data *bcm = hu->priv;
529 	struct bcm_device *bdev = NULL;
530 	int err;
531 
532 	bt_dev_dbg(hu->hdev, "hu %p", hu);
533 
534 	/* Protect bcm->dev against removal of the device or driver */
535 	mutex_lock(&bcm_device_lock);
536 
537 	if (hu->serdev) {
538 		bdev = serdev_device_get_drvdata(hu->serdev);
539 	} else if (bcm_device_exists(bcm->dev)) {
540 		bdev = bcm->dev;
541 #ifdef CONFIG_PM
542 		bdev->hu = NULL;
543 #endif
544 	}
545 
546 	if (bdev) {
547 		if (IS_ENABLED(CONFIG_PM) && bdev->irq_acquired) {
548 			devm_free_irq(bdev->dev, bdev->irq, bdev);
549 			device_init_wakeup(bdev->dev, false);
550 			pm_runtime_dont_use_autosuspend(bdev->dev);
551 			pm_runtime_disable(bdev->dev);
552 		}
553 
554 		err = bcm_gpio_set_power(bdev, false);
555 		if (err)
556 			bt_dev_err(hu->hdev, "Failed to power down");
557 		else
558 			pm_runtime_set_suspended(bdev->dev);
559 	}
560 	mutex_unlock(&bcm_device_lock);
561 
562 	skb_queue_purge(&bcm->txq);
563 	kfree_skb(bcm->rx_skb);
564 	kfree(bcm);
565 
566 	hu->priv = NULL;
567 	return 0;
568 }
569 
570 static int bcm_flush(struct hci_uart *hu)
571 {
572 	struct bcm_data *bcm = hu->priv;
573 
574 	bt_dev_dbg(hu->hdev, "hu %p", hu);
575 
576 	skb_queue_purge(&bcm->txq);
577 
578 	return 0;
579 }
580 
581 static int bcm_setup(struct hci_uart *hu)
582 {
583 	struct bcm_data *bcm = hu->priv;
584 	bool fw_load_done = false;
585 	bool use_autobaud_mode = (bcm->dev ? bcm->dev->use_autobaud_mode : 0);
586 	unsigned int speed;
587 	int err;
588 
589 	bt_dev_dbg(hu->hdev, "hu %p", hu);
590 
591 	hu->hdev->set_diag = bcm_set_diag;
592 	hu->hdev->set_bdaddr = btbcm_set_bdaddr;
593 
594 	err = btbcm_initialize(hu->hdev, &fw_load_done, use_autobaud_mode);
595 	if (err)
596 		return err;
597 
598 	if (!fw_load_done)
599 		return 0;
600 
601 	/* Init speed if any */
602 	if (bcm->dev && bcm->dev->init_speed)
603 		speed = bcm->dev->init_speed;
604 	else if (hu->proto->init_speed)
605 		speed = hu->proto->init_speed;
606 	else
607 		speed = 0;
608 
609 	if (speed)
610 		host_set_baudrate(hu, speed);
611 
612 	/* Operational speed if any */
613 	if (hu->oper_speed)
614 		speed = hu->oper_speed;
615 	else if (bcm->dev && bcm->dev->oper_speed)
616 		speed = bcm->dev->oper_speed;
617 	else if (hu->proto->oper_speed)
618 		speed = hu->proto->oper_speed;
619 	else
620 		speed = 0;
621 
622 	if (speed) {
623 		err = bcm_set_baudrate(hu, speed);
624 		if (!err)
625 			host_set_baudrate(hu, speed);
626 	}
627 
628 	/* PCM parameters if provided */
629 	if (bcm->dev && bcm->dev->pcm_int_params[0] != 0xff) {
630 		struct bcm_set_pcm_int_params params;
631 
632 		btbcm_read_pcm_int_params(hu->hdev, &params);
633 
634 		memcpy(&params, bcm->dev->pcm_int_params, 5);
635 		btbcm_write_pcm_int_params(hu->hdev, &params);
636 	}
637 
638 	err = btbcm_finalize(hu->hdev, &fw_load_done, use_autobaud_mode);
639 	if (err)
640 		return err;
641 
642 	/* Some devices ship with the controller default address.
643 	 * Allow the bootloader to set a valid address through the
644 	 * device tree.
645 	 */
646 	if (hci_test_quirk(hu->hdev, HCI_QUIRK_INVALID_BDADDR))
647 		hci_set_quirk(hu->hdev, HCI_QUIRK_USE_BDADDR_PROPERTY);
648 
649 	if (!bcm_request_irq(bcm))
650 		err = bcm_setup_sleep(hu);
651 
652 	return err;
653 }
654 
655 #define BCM_RECV_LM_DIAG \
656 	.type = BCM_LM_DIAG_PKT, \
657 	.hlen = BCM_LM_DIAG_SIZE, \
658 	.loff = 0, \
659 	.lsize = 0, \
660 	.maxlen = BCM_LM_DIAG_SIZE
661 
662 #define BCM_RECV_NULL \
663 	.type = BCM_NULL_PKT, \
664 	.hlen = BCM_NULL_SIZE, \
665 	.loff = 0, \
666 	.lsize = 0, \
667 	.maxlen = BCM_NULL_SIZE
668 
669 #define BCM_RECV_TYPE49 \
670 	.type = BCM_TYPE49_PKT, \
671 	.hlen = BCM_TYPE49_SIZE, \
672 	.loff = 0, \
673 	.lsize = 0, \
674 	.maxlen = BCM_TYPE49_SIZE
675 
676 #define BCM_RECV_TYPE52 \
677 	.type = BCM_TYPE52_PKT, \
678 	.hlen = BCM_TYPE52_SIZE, \
679 	.loff = 0, \
680 	.lsize = 0, \
681 	.maxlen = BCM_TYPE52_SIZE
682 
683 static const struct h4_recv_pkt bcm_recv_pkts[] = {
684 	{ H4_RECV_ACL,      .recv = hci_recv_frame },
685 	{ H4_RECV_SCO,      .recv = hci_recv_frame },
686 	{ H4_RECV_EVENT,    .recv = hci_recv_frame },
687 	{ H4_RECV_ISO,      .recv = hci_recv_frame },
688 	{ BCM_RECV_LM_DIAG, .recv = hci_recv_diag  },
689 	{ BCM_RECV_NULL,    .recv = hci_recv_diag  },
690 	{ BCM_RECV_TYPE49,  .recv = hci_recv_diag  },
691 	{ BCM_RECV_TYPE52,  .recv = hci_recv_diag  },
692 };
693 
694 static int bcm_recv(struct hci_uart *hu, const void *data, int count)
695 {
696 	struct bcm_data *bcm = hu->priv;
697 
698 	if (!test_bit(HCI_UART_REGISTERED, &hu->flags))
699 		return -EUNATCH;
700 
701 	bcm->rx_skb = h4_recv_buf(hu, bcm->rx_skb, data, count,
702 				  bcm_recv_pkts, ARRAY_SIZE(bcm_recv_pkts));
703 	if (IS_ERR(bcm->rx_skb)) {
704 		int err = PTR_ERR(bcm->rx_skb);
705 		bt_dev_err(hu->hdev, "Frame reassembly failed (%d)", err);
706 		bcm->rx_skb = NULL;
707 		return err;
708 	} else if (!bcm->rx_skb) {
709 		/* Delay auto-suspend when receiving completed packet */
710 		mutex_lock(&bcm_device_lock);
711 		if (bcm->dev && bcm_device_exists(bcm->dev)) {
712 			pm_runtime_get(bcm->dev->dev);
713 			pm_runtime_put_autosuspend(bcm->dev->dev);
714 		}
715 		mutex_unlock(&bcm_device_lock);
716 	}
717 
718 	return count;
719 }
720 
721 static int bcm_enqueue(struct hci_uart *hu, struct sk_buff *skb)
722 {
723 	struct bcm_data *bcm = hu->priv;
724 
725 	bt_dev_dbg(hu->hdev, "hu %p skb %p", hu, skb);
726 
727 	/* Prepend skb with frame type */
728 	memcpy(skb_push(skb, 1), &hci_skb_pkt_type(skb), 1);
729 	skb_queue_tail(&bcm->txq, skb);
730 
731 	return 0;
732 }
733 
734 static struct sk_buff *bcm_dequeue(struct hci_uart *hu)
735 {
736 	struct bcm_data *bcm = hu->priv;
737 	struct sk_buff *skb = NULL;
738 	struct bcm_device *bdev = NULL;
739 
740 	mutex_lock(&bcm_device_lock);
741 
742 	if (bcm_device_exists(bcm->dev)) {
743 		bdev = bcm->dev;
744 		pm_runtime_get_sync(bdev->dev);
745 		/* Shall be resumed here */
746 	}
747 
748 	skb = skb_dequeue(&bcm->txq);
749 
750 	if (bdev)
751 		pm_runtime_put_autosuspend(bdev->dev);
752 
753 	mutex_unlock(&bcm_device_lock);
754 
755 	return skb;
756 }
757 
758 #ifdef CONFIG_PM
759 static int bcm_suspend_device(struct device *dev)
760 {
761 	struct bcm_device *bdev = dev_get_drvdata(dev);
762 	int err;
763 
764 	bt_dev_dbg(bdev, "");
765 
766 	if (!bdev->is_suspended && bdev->hu) {
767 		hci_uart_set_flow_control(bdev->hu, true);
768 
769 		/* Once this returns, driver suspends BT via GPIO */
770 		bdev->is_suspended = true;
771 	}
772 
773 	/* Suspend the device */
774 	err = bdev->set_device_wakeup(bdev, false);
775 	if (err) {
776 		if (bdev->is_suspended && bdev->hu) {
777 			bdev->is_suspended = false;
778 			hci_uart_set_flow_control(bdev->hu, false);
779 		}
780 		return -EBUSY;
781 	}
782 
783 	bt_dev_dbg(bdev, "suspend, delaying 15 ms");
784 	msleep(15);
785 
786 	return 0;
787 }
788 
789 static int bcm_resume_device(struct device *dev)
790 {
791 	struct bcm_device *bdev = dev_get_drvdata(dev);
792 	int err;
793 
794 	bt_dev_dbg(bdev, "");
795 
796 	err = bdev->set_device_wakeup(bdev, true);
797 	if (err) {
798 		dev_err(dev, "Failed to power up\n");
799 		return err;
800 	}
801 
802 	bt_dev_dbg(bdev, "resume, delaying 15 ms");
803 	msleep(15);
804 
805 	/* When this executes, the device has woken up already */
806 	if (bdev->is_suspended && bdev->hu) {
807 		bdev->is_suspended = false;
808 
809 		hci_uart_set_flow_control(bdev->hu, false);
810 	}
811 
812 	return 0;
813 }
814 #endif
815 
816 #ifdef CONFIG_PM_SLEEP
817 /* suspend callback */
818 static int bcm_suspend(struct device *dev)
819 {
820 	struct bcm_device *bdev = dev_get_drvdata(dev);
821 	int error;
822 
823 	bt_dev_dbg(bdev, "suspend: is_suspended %d", bdev->is_suspended);
824 
825 	/*
826 	 * When used with a device instantiated as platform_device, bcm_suspend
827 	 * can be called at any time as long as the platform device is bound,
828 	 * so it should use bcm_device_lock to protect access to hci_uart
829 	 * and device_wake-up GPIO.
830 	 */
831 	mutex_lock(&bcm_device_lock);
832 
833 	if (!bdev->hu)
834 		goto unlock;
835 
836 	if (pm_runtime_active(dev))
837 		bcm_suspend_device(dev);
838 
839 	if (device_may_wakeup(dev) && bdev->irq > 0) {
840 		error = enable_irq_wake(bdev->irq);
841 		if (!error)
842 			bt_dev_dbg(bdev, "BCM irq: enabled");
843 	}
844 
845 unlock:
846 	mutex_unlock(&bcm_device_lock);
847 
848 	return 0;
849 }
850 
851 /* resume callback */
852 static int bcm_resume(struct device *dev)
853 {
854 	struct bcm_device *bdev = dev_get_drvdata(dev);
855 	int err = 0;
856 
857 	bt_dev_dbg(bdev, "resume: is_suspended %d", bdev->is_suspended);
858 
859 	/*
860 	 * When used with a device instantiated as platform_device, bcm_resume
861 	 * can be called at any time as long as platform device is bound,
862 	 * so it should use bcm_device_lock to protect access to hci_uart
863 	 * and device_wake-up GPIO.
864 	 */
865 	mutex_lock(&bcm_device_lock);
866 
867 	if (!bdev->hu)
868 		goto unlock;
869 
870 	if (device_may_wakeup(dev) && bdev->irq > 0) {
871 		disable_irq_wake(bdev->irq);
872 		bt_dev_dbg(bdev, "BCM irq: disabled");
873 	}
874 
875 	err = bcm_resume_device(dev);
876 
877 unlock:
878 	mutex_unlock(&bcm_device_lock);
879 
880 	if (!err) {
881 		pm_runtime_disable(dev);
882 		pm_runtime_set_active(dev);
883 		pm_runtime_enable(dev);
884 	}
885 
886 	return 0;
887 }
888 #endif
889 
890 /* Some firmware reports an IRQ which does not work (wrong pin in fw table?) */
891 static struct gpiod_lookup_table irq_on_int33fc02_pin17_gpios = {
892 	.dev_id = "serial0-0",
893 	.table = {
894 		GPIO_LOOKUP("INT33FC:02", 17, "host-wakeup-alt", GPIO_ACTIVE_HIGH),
895 		{ }
896 	},
897 };
898 
899 static const struct dmi_system_id bcm_broken_irq_dmi_table[] = {
900 	{
901 		.ident = "Acer Iconia One 7 B1-750",
902 		.matches = {
903 			DMI_MATCH(DMI_SYS_VENDOR, "Insyde"),
904 			DMI_MATCH(DMI_PRODUCT_NAME, "VESPA2"),
905 		},
906 		.driver_data = &irq_on_int33fc02_pin17_gpios,
907 	},
908 	{
909 		.ident = "Asus TF103C",
910 		.matches = {
911 			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
912 			DMI_MATCH(DMI_PRODUCT_NAME, "TF103C"),
913 		},
914 		.driver_data = &irq_on_int33fc02_pin17_gpios,
915 	},
916 	{
917 		.ident = "Lenovo Yoga Tablet 2 830F/L / 1050F/L",
918 		.matches = {
919 			DMI_MATCH(DMI_SYS_VENDOR, "Intel Corp."),
920 			DMI_MATCH(DMI_PRODUCT_NAME, "VALLEYVIEW C0 PLATFORM"),
921 			DMI_MATCH(DMI_BOARD_NAME, "BYT-T FFD8"),
922 			/* Partial match on beginning of BIOS version */
923 			DMI_MATCH(DMI_BIOS_VERSION, "BLADE_21"),
924 		},
925 		.driver_data = &irq_on_int33fc02_pin17_gpios,
926 	},
927 	{
928 		.ident = "Meegopad T08",
929 		.matches = {
930 			DMI_EXACT_MATCH(DMI_BOARD_VENDOR,
931 					"To be filled by OEM."),
932 			DMI_EXACT_MATCH(DMI_BOARD_NAME, "T3 MRD"),
933 			DMI_EXACT_MATCH(DMI_BOARD_VERSION, "V1.1"),
934 		},
935 	},
936 	{ }
937 };
938 
939 #ifdef CONFIG_ACPI
940 static const struct acpi_gpio_params first_gpio = { 0, 0, false };
941 static const struct acpi_gpio_params second_gpio = { 1, 0, false };
942 static const struct acpi_gpio_params third_gpio = { 2, 0, false };
943 
944 static const struct acpi_gpio_mapping acpi_bcm_int_last_gpios[] = {
945 	{ "device-wakeup-gpios", &first_gpio, 1 },
946 	{ "shutdown-gpios", &second_gpio, 1 },
947 	{ "host-wakeup-gpios", &third_gpio, 1 },
948 	{ },
949 };
950 
951 static const struct acpi_gpio_mapping acpi_bcm_int_first_gpios[] = {
952 	{ "host-wakeup-gpios", &first_gpio, 1 },
953 	{ "device-wakeup-gpios", &second_gpio, 1 },
954 	{ "shutdown-gpios", &third_gpio, 1 },
955 	{ },
956 };
957 
958 static int bcm_resource(struct acpi_resource *ares, void *data)
959 {
960 	struct bcm_device *dev = data;
961 	struct acpi_resource_extended_irq *irq;
962 	struct acpi_resource_gpio *gpio;
963 	struct acpi_resource_uart_serialbus *sb;
964 
965 	switch (ares->type) {
966 	case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
967 		irq = &ares->data.extended_irq;
968 		if (irq->polarity != ACPI_ACTIVE_LOW)
969 			dev_info(dev->dev, "ACPI Interrupt resource is active-high, this is usually wrong, treating the IRQ as active-low\n");
970 		dev->irq_active_low = true;
971 		break;
972 
973 	case ACPI_RESOURCE_TYPE_GPIO:
974 		gpio = &ares->data.gpio;
975 		if (gpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT) {
976 			dev->gpio_int_idx = dev->gpio_count;
977 			dev->irq_active_low = gpio->polarity == ACPI_ACTIVE_LOW;
978 		}
979 		dev->gpio_count++;
980 		break;
981 
982 	case ACPI_RESOURCE_TYPE_SERIAL_BUS:
983 		sb = &ares->data.uart_serial_bus;
984 		if (sb->type == ACPI_RESOURCE_SERIAL_TYPE_UART) {
985 			dev->init_speed = sb->default_baud_rate;
986 			dev->oper_speed = 4000000;
987 		}
988 		break;
989 
990 	default:
991 		break;
992 	}
993 
994 	return 0;
995 }
996 
997 static int bcm_apple_set_device_wakeup(struct bcm_device *dev, bool awake)
998 {
999 	if (ACPI_FAILURE(acpi_execute_simple_method(dev->btlp, NULL, !awake)))
1000 		return -EIO;
1001 
1002 	return 0;
1003 }
1004 
1005 static int bcm_apple_set_shutdown(struct bcm_device *dev, bool powered)
1006 {
1007 	if (ACPI_FAILURE(acpi_evaluate_object(powered ? dev->btpu : dev->btpd,
1008 					      NULL, NULL, NULL)))
1009 		return -EIO;
1010 
1011 	return 0;
1012 }
1013 
1014 static int bcm_apple_get_resources(struct bcm_device *dev)
1015 {
1016 	struct acpi_device *adev = ACPI_COMPANION(dev->dev);
1017 	const union acpi_object *obj;
1018 
1019 	if (!adev ||
1020 	    ACPI_FAILURE(acpi_get_handle(adev->handle, "BTLP", &dev->btlp)) ||
1021 	    ACPI_FAILURE(acpi_get_handle(adev->handle, "BTPU", &dev->btpu)) ||
1022 	    ACPI_FAILURE(acpi_get_handle(adev->handle, "BTPD", &dev->btpd)))
1023 		return -ENODEV;
1024 
1025 	if (!acpi_dev_get_property(adev, "baud", ACPI_TYPE_BUFFER, &obj) &&
1026 	    obj->buffer.length == 8)
1027 		dev->init_speed = *(u64 *)obj->buffer.pointer;
1028 
1029 	dev->set_device_wakeup = bcm_apple_set_device_wakeup;
1030 	dev->set_shutdown = bcm_apple_set_shutdown;
1031 
1032 	return 0;
1033 }
1034 #else
1035 static inline int bcm_apple_get_resources(struct bcm_device *dev)
1036 {
1037 	return -EOPNOTSUPP;
1038 }
1039 #endif /* CONFIG_ACPI */
1040 
1041 static int bcm_gpio_set_device_wakeup(struct bcm_device *dev, bool awake)
1042 {
1043 	gpiod_set_value_cansleep(dev->device_wakeup, awake);
1044 	return 0;
1045 }
1046 
1047 static int bcm_gpio_set_shutdown(struct bcm_device *dev, bool powered)
1048 {
1049 	gpiod_set_value_cansleep(dev->shutdown, powered);
1050 	if (dev->reset)
1051 		/*
1052 		 * The reset line is asserted on powerdown and deasserted
1053 		 * on poweron so the inverse of powered is used. Notice
1054 		 * that the GPIO line BT_RST_N needs to be specified as
1055 		 * active low in the device tree or similar system
1056 		 * description.
1057 		 */
1058 		gpiod_set_value_cansleep(dev->reset, !powered);
1059 	return 0;
1060 }
1061 
1062 /* Try a bunch of names for TXCO */
1063 static struct clk *bcm_get_txco(struct device *dev)
1064 {
1065 	struct clk *clk;
1066 
1067 	/* New explicit name */
1068 	clk = devm_clk_get_optional(dev, "txco");
1069 	if (clk)
1070 		return clk;
1071 
1072 	/* Deprecated name */
1073 	clk = devm_clk_get_optional(dev, "extclk");
1074 	if (clk)
1075 		return clk;
1076 
1077 	/* Original code used no name at all */
1078 	return devm_clk_get_optional(dev, NULL);
1079 }
1080 
1081 static int bcm_get_resources(struct bcm_device *dev)
1082 {
1083 	const struct dmi_system_id *broken_irq_dmi_id;
1084 	const char *irq_con_id = "host-wakeup";
1085 	int err;
1086 
1087 	dev->name = dev_name(dev->dev);
1088 
1089 	if (x86_apple_machine && !bcm_apple_get_resources(dev))
1090 		return 0;
1091 
1092 	dev->txco_clk = bcm_get_txco(dev->dev);
1093 	if (IS_ERR(dev->txco_clk))
1094 		return PTR_ERR(dev->txco_clk);
1095 
1096 	dev->lpo_clk = devm_clk_get_optional(dev->dev, "lpo");
1097 	if (IS_ERR(dev->lpo_clk))
1098 		return PTR_ERR(dev->lpo_clk);
1099 
1100 	/* Check if we accidentally fetched the lpo clock twice */
1101 	if (dev->lpo_clk && clk_is_match(dev->lpo_clk, dev->txco_clk)) {
1102 		devm_clk_put(dev->dev, dev->txco_clk);
1103 		dev->txco_clk = NULL;
1104 	}
1105 
1106 	dev->device_wakeup = devm_gpiod_get_optional(dev->dev, "device-wakeup",
1107 						     GPIOD_OUT_LOW);
1108 	if (IS_ERR(dev->device_wakeup))
1109 		return PTR_ERR(dev->device_wakeup);
1110 
1111 	dev->shutdown = devm_gpiod_get_optional(dev->dev, "shutdown",
1112 						GPIOD_OUT_LOW);
1113 	if (IS_ERR(dev->shutdown))
1114 		return PTR_ERR(dev->shutdown);
1115 
1116 	dev->reset = devm_gpiod_get_optional(dev->dev, "reset",
1117 					     GPIOD_OUT_LOW);
1118 	if (IS_ERR(dev->reset))
1119 		return PTR_ERR(dev->reset);
1120 
1121 	dev->set_device_wakeup = bcm_gpio_set_device_wakeup;
1122 	dev->set_shutdown = bcm_gpio_set_shutdown;
1123 
1124 	dev->supplies[0].supply = "vbat";
1125 	dev->supplies[1].supply = "vddio";
1126 	err = devm_regulator_bulk_get(dev->dev, BCM_NUM_SUPPLIES,
1127 				      dev->supplies);
1128 	if (err)
1129 		return err;
1130 
1131 	broken_irq_dmi_id = dmi_first_match(bcm_broken_irq_dmi_table);
1132 	if (broken_irq_dmi_id && broken_irq_dmi_id->driver_data) {
1133 		gpiod_add_lookup_table(broken_irq_dmi_id->driver_data);
1134 		irq_con_id = "host-wakeup-alt";
1135 		dev->irq_active_low = false;
1136 		dev->irq = 0;
1137 	}
1138 
1139 	/* IRQ can be declared in ACPI table as Interrupt or GpioInt */
1140 	if (dev->irq <= 0) {
1141 		struct gpio_desc *gpio;
1142 
1143 		gpio = devm_gpiod_get_optional(dev->dev, irq_con_id, GPIOD_IN);
1144 		if (IS_ERR(gpio))
1145 			return PTR_ERR(gpio);
1146 
1147 		dev->irq = gpiod_to_irq(gpio);
1148 	}
1149 
1150 	if (broken_irq_dmi_id) {
1151 		if (broken_irq_dmi_id->driver_data) {
1152 			gpiod_remove_lookup_table(broken_irq_dmi_id->driver_data);
1153 		} else {
1154 			dev_info(dev->dev, "%s: Has a broken IRQ config, disabling IRQ support / runtime-pm\n",
1155 				 broken_irq_dmi_id->ident);
1156 			dev->irq = 0;
1157 		}
1158 	}
1159 
1160 	dev_dbg(dev->dev, "BCM irq: %d\n", dev->irq);
1161 	return 0;
1162 }
1163 
1164 #ifdef CONFIG_ACPI
1165 static int bcm_acpi_probe(struct bcm_device *dev)
1166 {
1167 	LIST_HEAD(resources);
1168 	const struct acpi_gpio_mapping *gpio_mapping = acpi_bcm_int_last_gpios;
1169 	struct resource_entry *entry;
1170 	int ret;
1171 
1172 	/* Retrieve UART ACPI info */
1173 	dev->gpio_int_idx = -1;
1174 	ret = acpi_dev_get_resources(ACPI_COMPANION(dev->dev),
1175 				     &resources, bcm_resource, dev);
1176 	if (ret < 0)
1177 		return ret;
1178 
1179 	resource_list_for_each_entry(entry, &resources) {
1180 		if (resource_type(entry->res) == IORESOURCE_IRQ) {
1181 			dev->irq = entry->res->start;
1182 			break;
1183 		}
1184 	}
1185 	acpi_dev_free_resource_list(&resources);
1186 
1187 	/* If the DSDT uses an Interrupt resource for the IRQ, then there are
1188 	 * only 2 GPIO resources, we use the irq-last mapping for this, since
1189 	 * we already have an irq the 3th / last mapping will not be used.
1190 	 */
1191 	if (dev->irq)
1192 		gpio_mapping = acpi_bcm_int_last_gpios;
1193 	else if (dev->gpio_int_idx == 0)
1194 		gpio_mapping = acpi_bcm_int_first_gpios;
1195 	else if (dev->gpio_int_idx == 2)
1196 		gpio_mapping = acpi_bcm_int_last_gpios;
1197 	else
1198 		dev_warn(dev->dev, "Unexpected ACPI gpio_int_idx: %d\n",
1199 			 dev->gpio_int_idx);
1200 
1201 	/* Warn if our expectations are not met. */
1202 	if (dev->gpio_count != (dev->irq ? 2 : 3))
1203 		dev_warn(dev->dev, "Unexpected number of ACPI GPIOs: %d\n",
1204 			 dev->gpio_count);
1205 
1206 	ret = devm_acpi_dev_add_driver_gpios(dev->dev, gpio_mapping);
1207 	if (ret)
1208 		return ret;
1209 
1210 	if (irq_polarity != -1) {
1211 		dev->irq_active_low = irq_polarity;
1212 		dev_warn(dev->dev, "Overwriting IRQ polarity to active %s by module-param\n",
1213 			 dev->irq_active_low ? "low" : "high");
1214 	}
1215 
1216 	return 0;
1217 }
1218 #else
1219 static int bcm_acpi_probe(struct bcm_device *dev)
1220 {
1221 	return -EINVAL;
1222 }
1223 #endif /* CONFIG_ACPI */
1224 
1225 static int bcm_of_probe(struct bcm_device *bdev)
1226 {
1227 	bdev->use_autobaud_mode = device_property_read_bool(bdev->dev,
1228 							    "brcm,requires-autobaud-mode");
1229 	device_property_read_u32(bdev->dev, "max-speed", &bdev->oper_speed);
1230 	device_property_read_u8_array(bdev->dev, "brcm,bt-pcm-int-params",
1231 				      bdev->pcm_int_params, 5);
1232 	bdev->irq = of_irq_get_byname(bdev->dev->of_node, "host-wakeup");
1233 	bdev->irq_active_low = irq_get_trigger_type(bdev->irq)
1234 			     & (IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_LEVEL_LOW);
1235 	return 0;
1236 }
1237 
1238 static int bcm_probe(struct platform_device *pdev)
1239 {
1240 	struct bcm_device *dev;
1241 	int ret;
1242 
1243 	dev = devm_kzalloc(&pdev->dev, sizeof(*dev), GFP_KERNEL);
1244 	if (!dev)
1245 		return -ENOMEM;
1246 
1247 	dev->dev = &pdev->dev;
1248 
1249 	ret = platform_get_irq(pdev, 0);
1250 	if (ret < 0)
1251 		return ret;
1252 
1253 	dev->irq = ret;
1254 
1255 	/* Initialize routing field to an unused value */
1256 	dev->pcm_int_params[0] = 0xff;
1257 
1258 	if (has_acpi_companion(&pdev->dev)) {
1259 		ret = bcm_acpi_probe(dev);
1260 		if (ret)
1261 			return ret;
1262 	}
1263 
1264 	ret = bcm_get_resources(dev);
1265 	if (ret)
1266 		return ret;
1267 
1268 	platform_set_drvdata(pdev, dev);
1269 
1270 	dev_info(&pdev->dev, "%s device registered.\n", dev->name);
1271 
1272 	/* Place this instance on the device list */
1273 	mutex_lock(&bcm_device_lock);
1274 	list_add_tail(&dev->list, &bcm_device_list);
1275 	mutex_unlock(&bcm_device_lock);
1276 
1277 	ret = bcm_gpio_set_power(dev, false);
1278 	if (ret)
1279 		dev_err(&pdev->dev, "Failed to power down\n");
1280 
1281 	return 0;
1282 }
1283 
1284 static void bcm_remove(struct platform_device *pdev)
1285 {
1286 	struct bcm_device *dev = platform_get_drvdata(pdev);
1287 
1288 	mutex_lock(&bcm_device_lock);
1289 	list_del(&dev->list);
1290 	mutex_unlock(&bcm_device_lock);
1291 
1292 	dev_info(&pdev->dev, "%s device unregistered.\n", dev->name);
1293 }
1294 
1295 static const struct hci_uart_proto bcm_proto = {
1296 	.id		= HCI_UART_BCM,
1297 	.name		= "Broadcom",
1298 	.manufacturer	= 15,
1299 	.init_speed	= 115200,
1300 	.open		= bcm_open,
1301 	.close		= bcm_close,
1302 	.flush		= bcm_flush,
1303 	.setup		= bcm_setup,
1304 	.set_baudrate	= bcm_set_baudrate,
1305 	.recv		= bcm_recv,
1306 	.enqueue	= bcm_enqueue,
1307 	.dequeue	= bcm_dequeue,
1308 };
1309 
1310 #ifdef CONFIG_ACPI
1311 
1312 /* bcm43430a0/a1 BT does not support 48MHz UART clock, limit to 2000000 baud */
1313 static struct bcm_device_data bcm43430_device_data = {
1314 	.max_speed = 2000000,
1315 };
1316 
1317 static const struct acpi_device_id bcm_acpi_match[] = {
1318 	{ .id = "BCM2E00" },
1319 	{ .id = "BCM2E01" },
1320 	{ .id = "BCM2E02" },
1321 	{ .id = "BCM2E03" },
1322 	{ .id = "BCM2E04" },
1323 	{ .id = "BCM2E05" },
1324 	{ .id = "BCM2E06" },
1325 	{ .id = "BCM2E07" },
1326 	{ .id = "BCM2E08" },
1327 	{ .id = "BCM2E09" },
1328 	{ .id = "BCM2E0A" },
1329 	{ .id = "BCM2E0B" },
1330 	{ .id = "BCM2E0C" },
1331 	{ .id = "BCM2E0D" },
1332 	{ .id = "BCM2E0E" },
1333 	{ .id = "BCM2E0F" },
1334 	{ .id = "BCM2E10" },
1335 	{ .id = "BCM2E11" },
1336 	{ .id = "BCM2E12" },
1337 	{ .id = "BCM2E13" },
1338 	{ .id = "BCM2E14" },
1339 	{ .id = "BCM2E15" },
1340 	{ .id = "BCM2E16" },
1341 	{ .id = "BCM2E17" },
1342 	{ .id = "BCM2E18" },
1343 	{ .id = "BCM2E19" },
1344 	{ .id = "BCM2E1A" },
1345 	{ .id = "BCM2E1B" },
1346 	{ .id = "BCM2E1C" },
1347 	{ .id = "BCM2E1D" },
1348 	{ .id = "BCM2E1F" },
1349 	{ .id = "BCM2E20" },
1350 	{ .id = "BCM2E21" },
1351 	{ .id = "BCM2E22" },
1352 	{ .id = "BCM2E23" },
1353 	{ .id = "BCM2E24" },
1354 	{ .id = "BCM2E25" },
1355 	{ .id = "BCM2E26" },
1356 	{ .id = "BCM2E27" },
1357 	{ .id = "BCM2E28" },
1358 	{ .id = "BCM2E29" },
1359 	{ .id = "BCM2E2A" },
1360 	{ .id = "BCM2E2B" },
1361 	{ .id = "BCM2E2C" },
1362 	{ .id = "BCM2E2D" },
1363 	{ .id = "BCM2E2E" },
1364 	{ .id = "BCM2E2F" },
1365 	{ .id = "BCM2E30" },
1366 	{ .id = "BCM2E31" },
1367 	{ .id = "BCM2E32" },
1368 	{ .id = "BCM2E33" },
1369 	{ .id = "BCM2E34" },
1370 	{ .id = "BCM2E35" },
1371 	{ .id = "BCM2E36" },
1372 	{ .id = "BCM2E37" },
1373 	{ .id = "BCM2E38" },
1374 	{ .id = "BCM2E39" },
1375 	{ .id = "BCM2E3A" },
1376 	{ .id = "BCM2E3B" },
1377 	{ .id = "BCM2E3C" },
1378 	{ .id = "BCM2E3D" },
1379 	{ .id = "BCM2E3E" },
1380 	{ .id = "BCM2E3F" },
1381 	{ .id = "BCM2E40" },
1382 	{ .id = "BCM2E41" },
1383 	{ .id = "BCM2E42" },
1384 	{ .id = "BCM2E43" },
1385 	{ .id = "BCM2E44" },
1386 	{ .id = "BCM2E45" },
1387 	{ .id = "BCM2E46" },
1388 	{ .id = "BCM2E47" },
1389 	{ .id = "BCM2E48" },
1390 	{ .id = "BCM2E49" },
1391 	{ .id = "BCM2E4A" },
1392 	{ .id = "BCM2E4B" },
1393 	{ .id = "BCM2E4C" },
1394 	{ .id = "BCM2E4D" },
1395 	{ .id = "BCM2E4E" },
1396 	{ .id = "BCM2E4F" },
1397 	{ .id = "BCM2E50" },
1398 	{ .id = "BCM2E51" },
1399 	{ .id = "BCM2E52" },
1400 	{ .id = "BCM2E53" },
1401 	{ .id = "BCM2E54" },
1402 	{ .id = "BCM2E55" },
1403 	{ .id = "BCM2E56" },
1404 	{ .id = "BCM2E57" },
1405 	{ .id = "BCM2E58" },
1406 	{ .id = "BCM2E59" },
1407 	{ .id = "BCM2E5A" },
1408 	{ .id = "BCM2E5B" },
1409 	{ .id = "BCM2E5C" },
1410 	{ .id = "BCM2E5D" },
1411 	{ .id = "BCM2E5E" },
1412 	{ .id = "BCM2E5F" },
1413 	{ .id = "BCM2E60" },
1414 	{ .id = "BCM2E61" },
1415 	{ .id = "BCM2E62" },
1416 	{ .id = "BCM2E63" },
1417 	{ .id = "BCM2E64" },
1418 	{ .id = "BCM2E65" },
1419 	{ .id = "BCM2E66" },
1420 	{ .id = "BCM2E67" },
1421 	{ .id = "BCM2E68" },
1422 	{ .id = "BCM2E69" },
1423 	{ .id = "BCM2E6B" },
1424 	{ .id = "BCM2E6D" },
1425 	{ .id = "BCM2E6E" },
1426 	{ .id = "BCM2E6F" },
1427 	{ .id = "BCM2E70" },
1428 	{ .id = "BCM2E71" },
1429 	{ .id = "BCM2E72" },
1430 	{ .id = "BCM2E73" },
1431 	{ .id = "BCM2E74", .driver_data = (long)&bcm43430_device_data },
1432 	{ .id = "BCM2E75", .driver_data = (long)&bcm43430_device_data },
1433 	{ .id = "BCM2E76" },
1434 	{ .id = "BCM2E77" },
1435 	{ .id = "BCM2E78" },
1436 	{ .id = "BCM2E79" },
1437 	{ .id = "BCM2E7A" },
1438 	{ .id = "BCM2E7B", .driver_data = (long)&bcm43430_device_data },
1439 	{ .id = "BCM2E7C" },
1440 	{ .id = "BCM2E7D" },
1441 	{ .id = "BCM2E7E" },
1442 	{ .id = "BCM2E7F" },
1443 	{ .id = "BCM2E80", .driver_data = (long)&bcm43430_device_data },
1444 	{ .id = "BCM2E81" },
1445 	{ .id = "BCM2E82" },
1446 	{ .id = "BCM2E83" },
1447 	{ .id = "BCM2E84" },
1448 	{ .id = "BCM2E85" },
1449 	{ .id = "BCM2E86" },
1450 	{ .id = "BCM2E87" },
1451 	{ .id = "BCM2E88" },
1452 	{ .id = "BCM2E89", .driver_data = (long)&bcm43430_device_data },
1453 	{ .id = "BCM2E8A" },
1454 	{ .id = "BCM2E8B" },
1455 	{ .id = "BCM2E8C" },
1456 	{ .id = "BCM2E8D" },
1457 	{ .id = "BCM2E8E" },
1458 	{ .id = "BCM2E90" },
1459 	{ .id = "BCM2E92" },
1460 	{ .id = "BCM2E93" },
1461 	{ .id = "BCM2E94", .driver_data = (long)&bcm43430_device_data },
1462 	{ .id = "BCM2E95" },
1463 	{ .id = "BCM2E96" },
1464 	{ .id = "BCM2E97" },
1465 	{ .id = "BCM2E98" },
1466 	{ .id = "BCM2E99", .driver_data = (long)&bcm43430_device_data },
1467 	{ .id = "BCM2E9A" },
1468 	{ .id = "BCM2E9B", .driver_data = (long)&bcm43430_device_data },
1469 	{ .id = "BCM2E9C" },
1470 	{ .id = "BCM2E9D" },
1471 	{ .id = "BCM2E9F", .driver_data = (long)&bcm43430_device_data },
1472 	{ .id = "BCM2EA0" },
1473 	{ .id = "BCM2EA1" },
1474 	{ .id = "BCM2EA2", .driver_data = (long)&bcm43430_device_data },
1475 	{ .id = "BCM2EA3", .driver_data = (long)&bcm43430_device_data },
1476 	{ .id = "BCM2EA4", .driver_data = (long)&bcm43430_device_data }, /* bcm43455 */
1477 	{ .id = "BCM2EA5" },
1478 	{ .id = "BCM2EA6" },
1479 	{ .id = "BCM2EA7" },
1480 	{ .id = "BCM2EA8" },
1481 	{ .id = "BCM2EA9" },
1482 	{ .id = "BCM2EAA", .driver_data = (long)&bcm43430_device_data },
1483 	{ .id = "BCM2EAB", .driver_data = (long)&bcm43430_device_data },
1484 	{ .id = "BCM2EAC", .driver_data = (long)&bcm43430_device_data },
1485 	{ }
1486 };
1487 MODULE_DEVICE_TABLE(acpi, bcm_acpi_match);
1488 #endif
1489 
1490 /* suspend and resume callbacks */
1491 static const struct dev_pm_ops bcm_pm_ops = {
1492 	SET_SYSTEM_SLEEP_PM_OPS(bcm_suspend, bcm_resume)
1493 	SET_RUNTIME_PM_OPS(bcm_suspend_device, bcm_resume_device, NULL)
1494 };
1495 
1496 static struct platform_driver bcm_driver = {
1497 	.probe = bcm_probe,
1498 	.remove = bcm_remove,
1499 	.driver = {
1500 		.name = "hci_bcm",
1501 		.acpi_match_table = ACPI_PTR(bcm_acpi_match),
1502 		.pm = &bcm_pm_ops,
1503 	},
1504 };
1505 
1506 static int bcm_serdev_probe(struct serdev_device *serdev)
1507 {
1508 	struct bcm_device *bcmdev;
1509 	const struct bcm_device_data *data;
1510 	int err;
1511 
1512 	bcmdev = devm_kzalloc(&serdev->dev, sizeof(*bcmdev), GFP_KERNEL);
1513 	if (!bcmdev)
1514 		return -ENOMEM;
1515 
1516 	bcmdev->dev = &serdev->dev;
1517 #ifdef CONFIG_PM
1518 	bcmdev->hu = &bcmdev->serdev_hu;
1519 #endif
1520 	bcmdev->serdev_hu.serdev = serdev;
1521 	serdev_device_set_drvdata(serdev, bcmdev);
1522 
1523 	/* Initialize routing field to an unused value */
1524 	bcmdev->pcm_int_params[0] = 0xff;
1525 
1526 	if (has_acpi_companion(&serdev->dev))
1527 		err = bcm_acpi_probe(bcmdev);
1528 	else
1529 		err = bcm_of_probe(bcmdev);
1530 	if (err)
1531 		return err;
1532 
1533 	err = bcm_get_resources(bcmdev);
1534 	if (err)
1535 		return err;
1536 
1537 	if (!bcmdev->shutdown) {
1538 		dev_warn(&serdev->dev,
1539 			 "No reset resource, using default baud rate\n");
1540 		bcmdev->oper_speed = bcmdev->init_speed;
1541 	}
1542 
1543 	err = bcm_gpio_set_power(bcmdev, false);
1544 	if (err)
1545 		dev_err(&serdev->dev, "Failed to power down\n");
1546 
1547 	data = device_get_match_data(bcmdev->dev);
1548 	if (data) {
1549 		bcmdev->max_autobaud_speed = data->max_autobaud_speed;
1550 		bcmdev->no_early_set_baudrate = data->no_early_set_baudrate;
1551 		bcmdev->drive_rts_on_open = data->drive_rts_on_open;
1552 		bcmdev->no_uart_clock_set = data->no_uart_clock_set;
1553 		if (data->max_speed && bcmdev->oper_speed > data->max_speed)
1554 			bcmdev->oper_speed = data->max_speed;
1555 	}
1556 
1557 	return hci_uart_register_device(&bcmdev->serdev_hu, &bcm_proto);
1558 }
1559 
1560 static void bcm_serdev_remove(struct serdev_device *serdev)
1561 {
1562 	struct bcm_device *bcmdev = serdev_device_get_drvdata(serdev);
1563 
1564 	hci_uart_unregister_device(&bcmdev->serdev_hu);
1565 }
1566 
1567 #ifdef CONFIG_OF
1568 static struct bcm_device_data bcm4354_device_data = {
1569 	.no_early_set_baudrate = true,
1570 };
1571 
1572 static struct bcm_device_data bcm43438_device_data = {
1573 	.drive_rts_on_open = true,
1574 };
1575 
1576 static struct bcm_device_data cyw4373a0_device_data = {
1577 	.no_uart_clock_set = true,
1578 };
1579 
1580 static struct bcm_device_data cyw55572_device_data = {
1581 	.max_autobaud_speed = 921600,
1582 };
1583 
1584 static const struct of_device_id bcm_bluetooth_of_match[] = {
1585 	{ .compatible = "brcm,bcm20702a1" },
1586 	{ .compatible = "brcm,bcm4329-bt" },
1587 	{ .compatible = "brcm,bcm4330-bt" },
1588 	{ .compatible = "brcm,bcm4334-bt" },
1589 	{ .compatible = "brcm,bcm4345c5" },
1590 	{ .compatible = "brcm,bcm43430a0-bt" },
1591 	{ .compatible = "brcm,bcm43430a1-bt" },
1592 	{ .compatible = "brcm,bcm43438-bt", .data = &bcm43438_device_data },
1593 	{ .compatible = "brcm,bcm4349-bt", .data = &bcm43438_device_data },
1594 	{ .compatible = "brcm,bcm43540-bt", .data = &bcm4354_device_data },
1595 	{ .compatible = "brcm,bcm4335a0" },
1596 	{ .compatible = "cypress,cyw4373a0-bt", .data = &cyw4373a0_device_data },
1597 	{ .compatible = "infineon,cyw55572-bt", .data = &cyw55572_device_data },
1598 	{ },
1599 };
1600 MODULE_DEVICE_TABLE(of, bcm_bluetooth_of_match);
1601 #endif
1602 
1603 static struct serdev_device_driver bcm_serdev_driver = {
1604 	.probe = bcm_serdev_probe,
1605 	.remove = bcm_serdev_remove,
1606 	.driver = {
1607 		.name = "hci_uart_bcm",
1608 		.of_match_table = of_match_ptr(bcm_bluetooth_of_match),
1609 		.acpi_match_table = ACPI_PTR(bcm_acpi_match),
1610 		.pm = &bcm_pm_ops,
1611 	},
1612 };
1613 
1614 int __init bcm_init(void)
1615 {
1616 	/* For now, we need to keep both platform device
1617 	 * driver (ACPI generated) and serdev driver (DT).
1618 	 */
1619 	platform_driver_register(&bcm_driver);
1620 	serdev_device_driver_register(&bcm_serdev_driver);
1621 
1622 	return hci_uart_register_proto(&bcm_proto);
1623 }
1624 
1625 int __exit bcm_deinit(void)
1626 {
1627 	platform_driver_unregister(&bcm_driver);
1628 	serdev_device_driver_unregister(&bcm_serdev_driver);
1629 
1630 	return hci_uart_unregister_proto(&bcm_proto);
1631 }
1632