hci_bcm.c

   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 */
  60struct 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 */
 112struct 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 */
 155struct 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 */
 163static DEFINE_MUTEX(bcm_device_lock);
 164static LIST_HEAD(bcm_device_list);
 165
 166static int irq_polarity = -1;
 167module_param(irq_polarity, int, 0444);
 168MODULE_PARM_DESC(irq_polarity, "IRQ polarity 0: active-high 1: active-low");
 169
 170static 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
 178static 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 */
 229static 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
 249static 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
 307err_revert_shutdown:
 308	dev->set_shutdown(dev, !powered);
 309err_txco_clk_disable:
 310	if (powered && !dev->res_enabled)
 311		clk_disable_unprepare(dev->txco_clk);
 312err_lpo_clk_disable:
 313	if (powered && !dev->res_enabled)
 314		clk_disable_unprepare(dev->lpo_clk);
 315err_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
 322static 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
 334static 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
 369unlock:
 370	mutex_unlock(&bcm_device_lock);
 371
 372	return err;
 373}
 374
 375static 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
 391static 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
 413static inline int bcm_request_irq(struct bcm_data *bcm) { return 0; }
 414static inline int bcm_setup_sleep(struct hci_uart *hu) { return 0; }
 415#endif
 416
 417static 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
 440static 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(sizeof(*bcm), GFP_KERNEL);
 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
 485out:
 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
 515err_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
 526static 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_disable(bdev->dev);
 551		}
 552
 553		err = bcm_gpio_set_power(bdev, false);
 554		if (err)
 555			bt_dev_err(hu->hdev, "Failed to power down");
 556		else
 557			pm_runtime_set_suspended(bdev->dev);
 558	}
 559	mutex_unlock(&bcm_device_lock);
 560
 561	skb_queue_purge(&bcm->txq);
 562	kfree_skb(bcm->rx_skb);
 563	kfree(bcm);
 564
 565	hu->priv = NULL;
 566	return 0;
 567}
 568
 569static int bcm_flush(struct hci_uart *hu)
 570{
 571	struct bcm_data *bcm = hu->priv;
 572
 573	bt_dev_dbg(hu->hdev, "hu %p", hu);
 574
 575	skb_queue_purge(&bcm->txq);
 576
 577	return 0;
 578}
 579
 580static int bcm_setup(struct hci_uart *hu)
 581{
 582	struct bcm_data *bcm = hu->priv;
 583	bool fw_load_done = false;
 584	bool use_autobaud_mode = (bcm->dev ? bcm->dev->use_autobaud_mode : 0);
 585	unsigned int speed;
 586	int err;
 587
 588	bt_dev_dbg(hu->hdev, "hu %p", hu);
 589
 590	hu->hdev->set_diag = bcm_set_diag;
 591	hu->hdev->set_bdaddr = btbcm_set_bdaddr;
 592
 593	err = btbcm_initialize(hu->hdev, &fw_load_done, use_autobaud_mode);
 594	if (err)
 595		return err;
 596
 597	if (!fw_load_done)
 598		return 0;
 599
 600	/* Init speed if any */
 601	if (bcm->dev && bcm->dev->init_speed)
 602		speed = bcm->dev->init_speed;
 603	else if (hu->proto->init_speed)
 604		speed = hu->proto->init_speed;
 605	else
 606		speed = 0;
 607
 608	if (speed)
 609		host_set_baudrate(hu, speed);
 610
 611	/* Operational speed if any */
 612	if (hu->oper_speed)
 613		speed = hu->oper_speed;
 614	else if (bcm->dev && bcm->dev->oper_speed)
 615		speed = bcm->dev->oper_speed;
 616	else if (hu->proto->oper_speed)
 617		speed = hu->proto->oper_speed;
 618	else
 619		speed = 0;
 620
 621	if (speed) {
 622		err = bcm_set_baudrate(hu, speed);
 623		if (!err)
 624			host_set_baudrate(hu, speed);
 625	}
 626
 627	/* PCM parameters if provided */
 628	if (bcm->dev && bcm->dev->pcm_int_params[0] != 0xff) {
 629		struct bcm_set_pcm_int_params params;
 630
 631		btbcm_read_pcm_int_params(hu->hdev, &params);
 632
 633		memcpy(&params, bcm->dev->pcm_int_params, 5);
 634		btbcm_write_pcm_int_params(hu->hdev, &params);
 635	}
 636
 637	err = btbcm_finalize(hu->hdev, &fw_load_done, use_autobaud_mode);
 638	if (err)
 639		return err;
 640
 641	/* Some devices ship with the controller default address.
 642	 * Allow the bootloader to set a valid address through the
 643	 * device tree.
 644	 */
 645	if (hci_test_quirk(hu->hdev, HCI_QUIRK_INVALID_BDADDR))
 646		hci_set_quirk(hu->hdev, HCI_QUIRK_USE_BDADDR_PROPERTY);
 647
 648	if (!bcm_request_irq(bcm))
 649		err = bcm_setup_sleep(hu);
 650
 651	return err;
 652}
 653
 654#define BCM_RECV_LM_DIAG \
 655	.type = BCM_LM_DIAG_PKT, \
 656	.hlen = BCM_LM_DIAG_SIZE, \
 657	.loff = 0, \
 658	.lsize = 0, \
 659	.maxlen = BCM_LM_DIAG_SIZE
 660
 661#define BCM_RECV_NULL \
 662	.type = BCM_NULL_PKT, \
 663	.hlen = BCM_NULL_SIZE, \
 664	.loff = 0, \
 665	.lsize = 0, \
 666	.maxlen = BCM_NULL_SIZE
 667
 668#define BCM_RECV_TYPE49 \
 669	.type = BCM_TYPE49_PKT, \
 670	.hlen = BCM_TYPE49_SIZE, \
 671	.loff = 0, \
 672	.lsize = 0, \
 673	.maxlen = BCM_TYPE49_SIZE
 674
 675#define BCM_RECV_TYPE52 \
 676	.type = BCM_TYPE52_PKT, \
 677	.hlen = BCM_TYPE52_SIZE, \
 678	.loff = 0, \
 679	.lsize = 0, \
 680	.maxlen = BCM_TYPE52_SIZE
 681
 682static const struct h4_recv_pkt bcm_recv_pkts[] = {
 683	{ H4_RECV_ACL,      .recv = hci_recv_frame },
 684	{ H4_RECV_SCO,      .recv = hci_recv_frame },
 685	{ H4_RECV_EVENT,    .recv = hci_recv_frame },
 686	{ H4_RECV_ISO,      .recv = hci_recv_frame },
 687	{ BCM_RECV_LM_DIAG, .recv = hci_recv_diag  },
 688	{ BCM_RECV_NULL,    .recv = hci_recv_diag  },
 689	{ BCM_RECV_TYPE49,  .recv = hci_recv_diag  },
 690	{ BCM_RECV_TYPE52,  .recv = hci_recv_diag  },
 691};
 692
 693static int bcm_recv(struct hci_uart *hu, const void *data, int count)
 694{
 695	struct bcm_data *bcm = hu->priv;
 696
 697	if (!test_bit(HCI_UART_REGISTERED, &hu->flags))
 698		return -EUNATCH;
 699
 700	bcm->rx_skb = h4_recv_buf(hu, bcm->rx_skb, data, count,
 701				  bcm_recv_pkts, ARRAY_SIZE(bcm_recv_pkts));
 702	if (IS_ERR(bcm->rx_skb)) {
 703		int err = PTR_ERR(bcm->rx_skb);
 704		bt_dev_err(hu->hdev, "Frame reassembly failed (%d)", err);
 705		bcm->rx_skb = NULL;
 706		return err;
 707	} else if (!bcm->rx_skb) {
 708		/* Delay auto-suspend when receiving completed packet */
 709		mutex_lock(&bcm_device_lock);
 710		if (bcm->dev && bcm_device_exists(bcm->dev)) {
 711			pm_runtime_get(bcm->dev->dev);
 712			pm_runtime_put_autosuspend(bcm->dev->dev);
 713		}
 714		mutex_unlock(&bcm_device_lock);
 715	}
 716
 717	return count;
 718}
 719
 720static int bcm_enqueue(struct hci_uart *hu, struct sk_buff *skb)
 721{
 722	struct bcm_data *bcm = hu->priv;
 723
 724	bt_dev_dbg(hu->hdev, "hu %p skb %p", hu, skb);
 725
 726	/* Prepend skb with frame type */
 727	memcpy(skb_push(skb, 1), &hci_skb_pkt_type(skb), 1);
 728	skb_queue_tail(&bcm->txq, skb);
 729
 730	return 0;
 731}
 732
 733static struct sk_buff *bcm_dequeue(struct hci_uart *hu)
 734{
 735	struct bcm_data *bcm = hu->priv;
 736	struct sk_buff *skb = NULL;
 737	struct bcm_device *bdev = NULL;
 738
 739	mutex_lock(&bcm_device_lock);
 740
 741	if (bcm_device_exists(bcm->dev)) {
 742		bdev = bcm->dev;
 743		pm_runtime_get_sync(bdev->dev);
 744		/* Shall be resumed here */
 745	}
 746
 747	skb = skb_dequeue(&bcm->txq);
 748
 749	if (bdev)
 750		pm_runtime_put_autosuspend(bdev->dev);
 751
 752	mutex_unlock(&bcm_device_lock);
 753
 754	return skb;
 755}
 756
 757#ifdef CONFIG_PM
 758static int bcm_suspend_device(struct device *dev)
 759{
 760	struct bcm_device *bdev = dev_get_drvdata(dev);
 761	int err;
 762
 763	bt_dev_dbg(bdev, "");
 764
 765	if (!bdev->is_suspended && bdev->hu) {
 766		hci_uart_set_flow_control(bdev->hu, true);
 767
 768		/* Once this returns, driver suspends BT via GPIO */
 769		bdev->is_suspended = true;
 770	}
 771
 772	/* Suspend the device */
 773	err = bdev->set_device_wakeup(bdev, false);
 774	if (err) {
 775		if (bdev->is_suspended && bdev->hu) {
 776			bdev->is_suspended = false;
 777			hci_uart_set_flow_control(bdev->hu, false);
 778		}
 779		return -EBUSY;
 780	}
 781
 782	bt_dev_dbg(bdev, "suspend, delaying 15 ms");
 783	msleep(15);
 784
 785	return 0;
 786}
 787
 788static int bcm_resume_device(struct device *dev)
 789{
 790	struct bcm_device *bdev = dev_get_drvdata(dev);
 791	int err;
 792
 793	bt_dev_dbg(bdev, "");
 794
 795	err = bdev->set_device_wakeup(bdev, true);
 796	if (err) {
 797		dev_err(dev, "Failed to power up\n");
 798		return err;
 799	}
 800
 801	bt_dev_dbg(bdev, "resume, delaying 15 ms");
 802	msleep(15);
 803
 804	/* When this executes, the device has woken up already */
 805	if (bdev->is_suspended && bdev->hu) {
 806		bdev->is_suspended = false;
 807
 808		hci_uart_set_flow_control(bdev->hu, false);
 809	}
 810
 811	return 0;
 812}
 813#endif
 814
 815#ifdef CONFIG_PM_SLEEP
 816/* suspend callback */
 817static int bcm_suspend(struct device *dev)
 818{
 819	struct bcm_device *bdev = dev_get_drvdata(dev);
 820	int error;
 821
 822	bt_dev_dbg(bdev, "suspend: is_suspended %d", bdev->is_suspended);
 823
 824	/*
 825	 * When used with a device instantiated as platform_device, bcm_suspend
 826	 * can be called at any time as long as the platform device is bound,
 827	 * so it should use bcm_device_lock to protect access to hci_uart
 828	 * and device_wake-up GPIO.
 829	 */
 830	mutex_lock(&bcm_device_lock);
 831
 832	if (!bdev->hu)
 833		goto unlock;
 834
 835	if (pm_runtime_active(dev))
 836		bcm_suspend_device(dev);
 837
 838	if (device_may_wakeup(dev) && bdev->irq > 0) {
 839		error = enable_irq_wake(bdev->irq);
 840		if (!error)
 841			bt_dev_dbg(bdev, "BCM irq: enabled");
 842	}
 843
 844unlock:
 845	mutex_unlock(&bcm_device_lock);
 846
 847	return 0;
 848}
 849
 850/* resume callback */
 851static int bcm_resume(struct device *dev)
 852{
 853	struct bcm_device *bdev = dev_get_drvdata(dev);
 854	int err = 0;
 855
 856	bt_dev_dbg(bdev, "resume: is_suspended %d", bdev->is_suspended);
 857
 858	/*
 859	 * When used with a device instantiated as platform_device, bcm_resume
 860	 * can be called at any time as long as platform device is bound,
 861	 * so it should use bcm_device_lock to protect access to hci_uart
 862	 * and device_wake-up GPIO.
 863	 */
 864	mutex_lock(&bcm_device_lock);
 865
 866	if (!bdev->hu)
 867		goto unlock;
 868
 869	if (device_may_wakeup(dev) && bdev->irq > 0) {
 870		disable_irq_wake(bdev->irq);
 871		bt_dev_dbg(bdev, "BCM irq: disabled");
 872	}
 873
 874	err = bcm_resume_device(dev);
 875
 876unlock:
 877	mutex_unlock(&bcm_device_lock);
 878
 879	if (!err) {
 880		pm_runtime_disable(dev);
 881		pm_runtime_set_active(dev);
 882		pm_runtime_enable(dev);
 883	}
 884
 885	return 0;
 886}
 887#endif
 888
 889/* Some firmware reports an IRQ which does not work (wrong pin in fw table?) */
 890static struct gpiod_lookup_table irq_on_int33fc02_pin17_gpios = {
 891	.dev_id = "serial0-0",
 892	.table = {
 893		GPIO_LOOKUP("INT33FC:02", 17, "host-wakeup-alt", GPIO_ACTIVE_HIGH),
 894		{ }
 895	},
 896};
 897
 898static const struct dmi_system_id bcm_broken_irq_dmi_table[] = {
 899	{
 900		.ident = "Acer Iconia One 7 B1-750",
 901		.matches = {
 902			DMI_MATCH(DMI_SYS_VENDOR, "Insyde"),
 903			DMI_MATCH(DMI_PRODUCT_NAME, "VESPA2"),
 904		},
 905		.driver_data = &irq_on_int33fc02_pin17_gpios,
 906	},
 907	{
 908		.ident = "Asus TF103C",
 909		.matches = {
 910			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
 911			DMI_MATCH(DMI_PRODUCT_NAME, "TF103C"),
 912		},
 913		.driver_data = &irq_on_int33fc02_pin17_gpios,
 914	},
 915	{
 916		.ident = "Lenovo Yoga Tablet 2 830F/L / 1050F/L",
 917		.matches = {
 918			DMI_MATCH(DMI_SYS_VENDOR, "Intel Corp."),
 919			DMI_MATCH(DMI_PRODUCT_NAME, "VALLEYVIEW C0 PLATFORM"),
 920			DMI_MATCH(DMI_BOARD_NAME, "BYT-T FFD8"),
 921			/* Partial match on beginning of BIOS version */
 922			DMI_MATCH(DMI_BIOS_VERSION, "BLADE_21"),
 923		},
 924		.driver_data = &irq_on_int33fc02_pin17_gpios,
 925	},
 926	{
 927		.ident = "Meegopad T08",
 928		.matches = {
 929			DMI_EXACT_MATCH(DMI_BOARD_VENDOR,
 930					"To be filled by OEM."),
 931			DMI_EXACT_MATCH(DMI_BOARD_NAME, "T3 MRD"),
 932			DMI_EXACT_MATCH(DMI_BOARD_VERSION, "V1.1"),
 933		},
 934	},
 935	{ }
 936};
 937
 938#ifdef CONFIG_ACPI
 939static const struct acpi_gpio_params first_gpio = { 0, 0, false };
 940static const struct acpi_gpio_params second_gpio = { 1, 0, false };
 941static const struct acpi_gpio_params third_gpio = { 2, 0, false };
 942
 943static const struct acpi_gpio_mapping acpi_bcm_int_last_gpios[] = {
 944	{ "device-wakeup-gpios", &first_gpio, 1 },
 945	{ "shutdown-gpios", &second_gpio, 1 },
 946	{ "host-wakeup-gpios", &third_gpio, 1 },
 947	{ },
 948};
 949
 950static const struct acpi_gpio_mapping acpi_bcm_int_first_gpios[] = {
 951	{ "host-wakeup-gpios", &first_gpio, 1 },
 952	{ "device-wakeup-gpios", &second_gpio, 1 },
 953	{ "shutdown-gpios", &third_gpio, 1 },
 954	{ },
 955};
 956
 957static int bcm_resource(struct acpi_resource *ares, void *data)
 958{
 959	struct bcm_device *dev = data;
 960	struct acpi_resource_extended_irq *irq;
 961	struct acpi_resource_gpio *gpio;
 962	struct acpi_resource_uart_serialbus *sb;
 963
 964	switch (ares->type) {
 965	case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
 966		irq = &ares->data.extended_irq;
 967		if (irq->polarity != ACPI_ACTIVE_LOW)
 968			dev_info(dev->dev, "ACPI Interrupt resource is active-high, this is usually wrong, treating the IRQ as active-low\n");
 969		dev->irq_active_low = true;
 970		break;
 971
 972	case ACPI_RESOURCE_TYPE_GPIO:
 973		gpio = &ares->data.gpio;
 974		if (gpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT) {
 975			dev->gpio_int_idx = dev->gpio_count;
 976			dev->irq_active_low = gpio->polarity == ACPI_ACTIVE_LOW;
 977		}
 978		dev->gpio_count++;
 979		break;
 980
 981	case ACPI_RESOURCE_TYPE_SERIAL_BUS:
 982		sb = &ares->data.uart_serial_bus;
 983		if (sb->type == ACPI_RESOURCE_SERIAL_TYPE_UART) {
 984			dev->init_speed = sb->default_baud_rate;
 985			dev->oper_speed = 4000000;
 986		}
 987		break;
 988
 989	default:
 990		break;
 991	}
 992
 993	return 0;
 994}
 995
 996static int bcm_apple_set_device_wakeup(struct bcm_device *dev, bool awake)
 997{
 998	if (ACPI_FAILURE(acpi_execute_simple_method(dev->btlp, NULL, !awake)))
 999		return -EIO;
1000
1001	return 0;
1002}
1003
1004static int bcm_apple_set_shutdown(struct bcm_device *dev, bool powered)
1005{
1006	if (ACPI_FAILURE(acpi_evaluate_object(powered ? dev->btpu : dev->btpd,
1007					      NULL, NULL, NULL)))
1008		return -EIO;
1009
1010	return 0;
1011}
1012
1013static int bcm_apple_get_resources(struct bcm_device *dev)
1014{
1015	struct acpi_device *adev = ACPI_COMPANION(dev->dev);
1016	const union acpi_object *obj;
1017
1018	if (!adev ||
1019	    ACPI_FAILURE(acpi_get_handle(adev->handle, "BTLP", &dev->btlp)) ||
1020	    ACPI_FAILURE(acpi_get_handle(adev->handle, "BTPU", &dev->btpu)) ||
1021	    ACPI_FAILURE(acpi_get_handle(adev->handle, "BTPD", &dev->btpd)))
1022		return -ENODEV;
1023
1024	if (!acpi_dev_get_property(adev, "baud", ACPI_TYPE_BUFFER, &obj) &&
1025	    obj->buffer.length == 8)
1026		dev->init_speed = *(u64 *)obj->buffer.pointer;
1027
1028	dev->set_device_wakeup = bcm_apple_set_device_wakeup;
1029	dev->set_shutdown = bcm_apple_set_shutdown;
1030
1031	return 0;
1032}
1033#else
1034static inline int bcm_apple_get_resources(struct bcm_device *dev)
1035{
1036	return -EOPNOTSUPP;
1037}
1038#endif /* CONFIG_ACPI */
1039
1040static int bcm_gpio_set_device_wakeup(struct bcm_device *dev, bool awake)
1041{
1042	gpiod_set_value_cansleep(dev->device_wakeup, awake);
1043	return 0;
1044}
1045
1046static int bcm_gpio_set_shutdown(struct bcm_device *dev, bool powered)
1047{
1048	gpiod_set_value_cansleep(dev->shutdown, powered);
1049	if (dev->reset)
1050		/*
1051		 * The reset line is asserted on powerdown and deasserted
1052		 * on poweron so the inverse of powered is used. Notice
1053		 * that the GPIO line BT_RST_N needs to be specified as
1054		 * active low in the device tree or similar system
1055		 * description.
1056		 */
1057		gpiod_set_value_cansleep(dev->reset, !powered);
1058	return 0;
1059}
1060
1061/* Try a bunch of names for TXCO */
1062static struct clk *bcm_get_txco(struct device *dev)
1063{
1064	struct clk *clk;
1065
1066	/* New explicit name */
1067	clk = devm_clk_get_optional(dev, "txco");
1068	if (clk)
1069		return clk;
1070
1071	/* Deprecated name */
1072	clk = devm_clk_get_optional(dev, "extclk");
1073	if (clk)
1074		return clk;
1075
1076	/* Original code used no name at all */
1077	return devm_clk_get_optional(dev, NULL);
1078}
1079
1080static int bcm_get_resources(struct bcm_device *dev)
1081{
1082	const struct dmi_system_id *broken_irq_dmi_id;
1083	const char *irq_con_id = "host-wakeup";
1084	int err;
1085
1086	dev->name = dev_name(dev->dev);
1087
1088	if (x86_apple_machine && !bcm_apple_get_resources(dev))
1089		return 0;
1090
1091	dev->txco_clk = bcm_get_txco(dev->dev);
1092	if (IS_ERR(dev->txco_clk))
1093		return PTR_ERR(dev->txco_clk);
1094
1095	dev->lpo_clk = devm_clk_get_optional(dev->dev, "lpo");
1096	if (IS_ERR(dev->lpo_clk))
1097		return PTR_ERR(dev->lpo_clk);
1098
1099	/* Check if we accidentally fetched the lpo clock twice */
1100	if (dev->lpo_clk && clk_is_match(dev->lpo_clk, dev->txco_clk)) {
1101		devm_clk_put(dev->dev, dev->txco_clk);
1102		dev->txco_clk = NULL;
1103	}
1104
1105	dev->device_wakeup = devm_gpiod_get_optional(dev->dev, "device-wakeup",
1106						     GPIOD_OUT_LOW);
1107	if (IS_ERR(dev->device_wakeup))
1108		return PTR_ERR(dev->device_wakeup);
1109
1110	dev->shutdown = devm_gpiod_get_optional(dev->dev, "shutdown",
1111						GPIOD_OUT_LOW);
1112	if (IS_ERR(dev->shutdown))
1113		return PTR_ERR(dev->shutdown);
1114
1115	dev->reset = devm_gpiod_get_optional(dev->dev, "reset",
1116					     GPIOD_OUT_LOW);
1117	if (IS_ERR(dev->reset))
1118		return PTR_ERR(dev->reset);
1119
1120	dev->set_device_wakeup = bcm_gpio_set_device_wakeup;
1121	dev->set_shutdown = bcm_gpio_set_shutdown;
1122
1123	dev->supplies[0].supply = "vbat";
1124	dev->supplies[1].supply = "vddio";
1125	err = devm_regulator_bulk_get(dev->dev, BCM_NUM_SUPPLIES,
1126				      dev->supplies);
1127	if (err)
1128		return err;
1129
1130	broken_irq_dmi_id = dmi_first_match(bcm_broken_irq_dmi_table);
1131	if (broken_irq_dmi_id && broken_irq_dmi_id->driver_data) {
1132		gpiod_add_lookup_table(broken_irq_dmi_id->driver_data);
1133		irq_con_id = "host-wakeup-alt";
1134		dev->irq_active_low = false;
1135		dev->irq = 0;
1136	}
1137
1138	/* IRQ can be declared in ACPI table as Interrupt or GpioInt */
1139	if (dev->irq <= 0) {
1140		struct gpio_desc *gpio;
1141
1142		gpio = devm_gpiod_get_optional(dev->dev, irq_con_id, GPIOD_IN);
1143		if (IS_ERR(gpio))
1144			return PTR_ERR(gpio);
1145
1146		dev->irq = gpiod_to_irq(gpio);
1147	}
1148
1149	if (broken_irq_dmi_id) {
1150		if (broken_irq_dmi_id->driver_data) {
1151			gpiod_remove_lookup_table(broken_irq_dmi_id->driver_data);
1152		} else {
1153			dev_info(dev->dev, "%s: Has a broken IRQ config, disabling IRQ support / runtime-pm\n",
1154				 broken_irq_dmi_id->ident);
1155			dev->irq = 0;
1156		}
1157	}
1158
1159	dev_dbg(dev->dev, "BCM irq: %d\n", dev->irq);
1160	return 0;
1161}
1162
1163#ifdef CONFIG_ACPI
1164static int bcm_acpi_probe(struct bcm_device *dev)
1165{
1166	LIST_HEAD(resources);
1167	const struct acpi_gpio_mapping *gpio_mapping = acpi_bcm_int_last_gpios;
1168	struct resource_entry *entry;
1169	int ret;
1170
1171	/* Retrieve UART ACPI info */
1172	dev->gpio_int_idx = -1;
1173	ret = acpi_dev_get_resources(ACPI_COMPANION(dev->dev),
1174				     &resources, bcm_resource, dev);
1175	if (ret < 0)
1176		return ret;
1177
1178	resource_list_for_each_entry(entry, &resources) {
1179		if (resource_type(entry->res) == IORESOURCE_IRQ) {
1180			dev->irq = entry->res->start;
1181			break;
1182		}
1183	}
1184	acpi_dev_free_resource_list(&resources);
1185
1186	/* If the DSDT uses an Interrupt resource for the IRQ, then there are
1187	 * only 2 GPIO resources, we use the irq-last mapping for this, since
1188	 * we already have an irq the 3th / last mapping will not be used.
1189	 */
1190	if (dev->irq)
1191		gpio_mapping = acpi_bcm_int_last_gpios;
1192	else if (dev->gpio_int_idx == 0)
1193		gpio_mapping = acpi_bcm_int_first_gpios;
1194	else if (dev->gpio_int_idx == 2)
1195		gpio_mapping = acpi_bcm_int_last_gpios;
1196	else
1197		dev_warn(dev->dev, "Unexpected ACPI gpio_int_idx: %d\n",
1198			 dev->gpio_int_idx);
1199
1200	/* Warn if our expectations are not met. */
1201	if (dev->gpio_count != (dev->irq ? 2 : 3))
1202		dev_warn(dev->dev, "Unexpected number of ACPI GPIOs: %d\n",
1203			 dev->gpio_count);
1204
1205	ret = devm_acpi_dev_add_driver_gpios(dev->dev, gpio_mapping);
1206	if (ret)
1207		return ret;
1208
1209	if (irq_polarity != -1) {
1210		dev->irq_active_low = irq_polarity;
1211		dev_warn(dev->dev, "Overwriting IRQ polarity to active %s by module-param\n",
1212			 dev->irq_active_low ? "low" : "high");
1213	}
1214
1215	return 0;
1216}
1217#else
1218static int bcm_acpi_probe(struct bcm_device *dev)
1219{
1220	return -EINVAL;
1221}
1222#endif /* CONFIG_ACPI */
1223
1224static int bcm_of_probe(struct bcm_device *bdev)
1225{
1226	bdev->use_autobaud_mode = device_property_read_bool(bdev->dev,
1227							    "brcm,requires-autobaud-mode");
1228	device_property_read_u32(bdev->dev, "max-speed", &bdev->oper_speed);
1229	device_property_read_u8_array(bdev->dev, "brcm,bt-pcm-int-params",
1230				      bdev->pcm_int_params, 5);
1231	bdev->irq = of_irq_get_byname(bdev->dev->of_node, "host-wakeup");
1232	bdev->irq_active_low = irq_get_trigger_type(bdev->irq)
1233			     & (IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_LEVEL_LOW);
1234	return 0;
1235}
1236
1237static int bcm_probe(struct platform_device *pdev)
1238{
1239	struct bcm_device *dev;
1240	int ret;
1241
1242	dev = devm_kzalloc(&pdev->dev, sizeof(*dev), GFP_KERNEL);
1243	if (!dev)
1244		return -ENOMEM;
1245
1246	dev->dev = &pdev->dev;
1247
1248	ret = platform_get_irq(pdev, 0);
1249	if (ret < 0)
1250		return ret;
1251
1252	dev->irq = ret;
1253
1254	/* Initialize routing field to an unused value */
1255	dev->pcm_int_params[0] = 0xff;
1256
1257	if (has_acpi_companion(&pdev->dev)) {
1258		ret = bcm_acpi_probe(dev);
1259		if (ret)
1260			return ret;
1261	}
1262
1263	ret = bcm_get_resources(dev);
1264	if (ret)
1265		return ret;
1266
1267	platform_set_drvdata(pdev, dev);
1268
1269	dev_info(&pdev->dev, "%s device registered.\n", dev->name);
1270
1271	/* Place this instance on the device list */
1272	mutex_lock(&bcm_device_lock);
1273	list_add_tail(&dev->list, &bcm_device_list);
1274	mutex_unlock(&bcm_device_lock);
1275
1276	ret = bcm_gpio_set_power(dev, false);
1277	if (ret)
1278		dev_err(&pdev->dev, "Failed to power down\n");
1279
1280	return 0;
1281}
1282
1283static void bcm_remove(struct platform_device *pdev)
1284{
1285	struct bcm_device *dev = platform_get_drvdata(pdev);
1286
1287	mutex_lock(&bcm_device_lock);
1288	list_del(&dev->list);
1289	mutex_unlock(&bcm_device_lock);
1290
1291	dev_info(&pdev->dev, "%s device unregistered.\n", dev->name);
1292}
1293
1294static const struct hci_uart_proto bcm_proto = {
1295	.id		= HCI_UART_BCM,
1296	.name		= "Broadcom",
1297	.manufacturer	= 15,
1298	.init_speed	= 115200,
1299	.open		= bcm_open,
1300	.close		= bcm_close,
1301	.flush		= bcm_flush,
1302	.setup		= bcm_setup,
1303	.set_baudrate	= bcm_set_baudrate,
1304	.recv		= bcm_recv,
1305	.enqueue	= bcm_enqueue,
1306	.dequeue	= bcm_dequeue,
1307};
1308
1309#ifdef CONFIG_ACPI
1310
1311/* bcm43430a0/a1 BT does not support 48MHz UART clock, limit to 2000000 baud */
1312static struct bcm_device_data bcm43430_device_data = {
1313	.max_speed = 2000000,
1314};
1315
1316static const struct acpi_device_id bcm_acpi_match[] = {
1317	{ "BCM2E00" },
1318	{ "BCM2E01" },
1319	{ "BCM2E02" },
1320	{ "BCM2E03" },
1321	{ "BCM2E04" },
1322	{ "BCM2E05" },
1323	{ "BCM2E06" },
1324	{ "BCM2E07" },
1325	{ "BCM2E08" },
1326	{ "BCM2E09" },
1327	{ "BCM2E0A" },
1328	{ "BCM2E0B" },
1329	{ "BCM2E0C" },
1330	{ "BCM2E0D" },
1331	{ "BCM2E0E" },
1332	{ "BCM2E0F" },
1333	{ "BCM2E10" },
1334	{ "BCM2E11" },
1335	{ "BCM2E12" },
1336	{ "BCM2E13" },
1337	{ "BCM2E14" },
1338	{ "BCM2E15" },
1339	{ "BCM2E16" },
1340	{ "BCM2E17" },
1341	{ "BCM2E18" },
1342	{ "BCM2E19" },
1343	{ "BCM2E1A" },
1344	{ "BCM2E1B" },
1345	{ "BCM2E1C" },
1346	{ "BCM2E1D" },
1347	{ "BCM2E1F" },
1348	{ "BCM2E20" },
1349	{ "BCM2E21" },
1350	{ "BCM2E22" },
1351	{ "BCM2E23" },
1352	{ "BCM2E24" },
1353	{ "BCM2E25" },
1354	{ "BCM2E26" },
1355	{ "BCM2E27" },
1356	{ "BCM2E28" },
1357	{ "BCM2E29" },
1358	{ "BCM2E2A" },
1359	{ "BCM2E2B" },
1360	{ "BCM2E2C" },
1361	{ "BCM2E2D" },
1362	{ "BCM2E2E" },
1363	{ "BCM2E2F" },
1364	{ "BCM2E30" },
1365	{ "BCM2E31" },
1366	{ "BCM2E32" },
1367	{ "BCM2E33" },
1368	{ "BCM2E34" },
1369	{ "BCM2E35" },
1370	{ "BCM2E36" },
1371	{ "BCM2E37" },
1372	{ "BCM2E38" },
1373	{ "BCM2E39" },
1374	{ "BCM2E3A" },
1375	{ "BCM2E3B" },
1376	{ "BCM2E3C" },
1377	{ "BCM2E3D" },
1378	{ "BCM2E3E" },
1379	{ "BCM2E3F" },
1380	{ "BCM2E40" },
1381	{ "BCM2E41" },
1382	{ "BCM2E42" },
1383	{ "BCM2E43" },
1384	{ "BCM2E44" },
1385	{ "BCM2E45" },
1386	{ "BCM2E46" },
1387	{ "BCM2E47" },
1388	{ "BCM2E48" },
1389	{ "BCM2E49" },
1390	{ "BCM2E4A" },
1391	{ "BCM2E4B" },
1392	{ "BCM2E4C" },
1393	{ "BCM2E4D" },
1394	{ "BCM2E4E" },
1395	{ "BCM2E4F" },
1396	{ "BCM2E50" },
1397	{ "BCM2E51" },
1398	{ "BCM2E52" },
1399	{ "BCM2E53" },
1400	{ "BCM2E54" },
1401	{ "BCM2E55" },
1402	{ "BCM2E56" },
1403	{ "BCM2E57" },
1404	{ "BCM2E58" },
1405	{ "BCM2E59" },
1406	{ "BCM2E5A" },
1407	{ "BCM2E5B" },
1408	{ "BCM2E5C" },
1409	{ "BCM2E5D" },
1410	{ "BCM2E5E" },
1411	{ "BCM2E5F" },
1412	{ "BCM2E60" },
1413	{ "BCM2E61" },
1414	{ "BCM2E62" },
1415	{ "BCM2E63" },
1416	{ "BCM2E64" },
1417	{ "BCM2E65" },
1418	{ "BCM2E66" },
1419	{ "BCM2E67" },
1420	{ "BCM2E68" },
1421	{ "BCM2E69" },
1422	{ "BCM2E6B" },
1423	{ "BCM2E6D" },
1424	{ "BCM2E6E" },
1425	{ "BCM2E6F" },
1426	{ "BCM2E70" },
1427	{ "BCM2E71" },
1428	{ "BCM2E72" },
1429	{ "BCM2E73" },
1430	{ "BCM2E74", (long)&bcm43430_device_data },
1431	{ "BCM2E75", (long)&bcm43430_device_data },
1432	{ "BCM2E76" },
1433	{ "BCM2E77" },
1434	{ "BCM2E78" },
1435	{ "BCM2E79" },
1436	{ "BCM2E7A" },
1437	{ "BCM2E7B", (long)&bcm43430_device_data },
1438	{ "BCM2E7C" },
1439	{ "BCM2E7D" },
1440	{ "BCM2E7E" },
1441	{ "BCM2E7F" },
1442	{ "BCM2E80", (long)&bcm43430_device_data },
1443	{ "BCM2E81" },
1444	{ "BCM2E82" },
1445	{ "BCM2E83" },
1446	{ "BCM2E84" },
1447	{ "BCM2E85" },
1448	{ "BCM2E86" },
1449	{ "BCM2E87" },
1450	{ "BCM2E88" },
1451	{ "BCM2E89", (long)&bcm43430_device_data },
1452	{ "BCM2E8A" },
1453	{ "BCM2E8B" },
1454	{ "BCM2E8C" },
1455	{ "BCM2E8D" },
1456	{ "BCM2E8E" },
1457	{ "BCM2E90" },
1458	{ "BCM2E92" },
1459	{ "BCM2E93" },
1460	{ "BCM2E94", (long)&bcm43430_device_data },
1461	{ "BCM2E95" },
1462	{ "BCM2E96" },
1463	{ "BCM2E97" },
1464	{ "BCM2E98" },
1465	{ "BCM2E99", (long)&bcm43430_device_data },
1466	{ "BCM2E9A" },
1467	{ "BCM2E9B", (long)&bcm43430_device_data },
1468	{ "BCM2E9C" },
1469	{ "BCM2E9D" },
1470	{ "BCM2E9F", (long)&bcm43430_device_data },
1471	{ "BCM2EA0" },
1472	{ "BCM2EA1" },
1473	{ "BCM2EA2", (long)&bcm43430_device_data },
1474	{ "BCM2EA3", (long)&bcm43430_device_data },
1475	{ "BCM2EA4", (long)&bcm43430_device_data }, /* bcm43455 */
1476	{ "BCM2EA5" },
1477	{ "BCM2EA6" },
1478	{ "BCM2EA7" },
1479	{ "BCM2EA8" },
1480	{ "BCM2EA9" },
1481	{ "BCM2EAA", (long)&bcm43430_device_data },
1482	{ "BCM2EAB", (long)&bcm43430_device_data },
1483	{ "BCM2EAC", (long)&bcm43430_device_data },
1484	{ },
1485};
1486MODULE_DEVICE_TABLE(acpi, bcm_acpi_match);
1487#endif
1488
1489/* suspend and resume callbacks */
1490static const struct dev_pm_ops bcm_pm_ops = {
1491	SET_SYSTEM_SLEEP_PM_OPS(bcm_suspend, bcm_resume)
1492	SET_RUNTIME_PM_OPS(bcm_suspend_device, bcm_resume_device, NULL)
1493};
1494
1495static struct platform_driver bcm_driver = {
1496	.probe = bcm_probe,
1497	.remove = bcm_remove,
1498	.driver = {
1499		.name = "hci_bcm",
1500		.acpi_match_table = ACPI_PTR(bcm_acpi_match),
1501		.pm = &bcm_pm_ops,
1502	},
1503};
1504
1505static int bcm_serdev_probe(struct serdev_device *serdev)
1506{
1507	struct bcm_device *bcmdev;
1508	const struct bcm_device_data *data;
1509	int err;
1510
1511	bcmdev = devm_kzalloc(&serdev->dev, sizeof(*bcmdev), GFP_KERNEL);
1512	if (!bcmdev)
1513		return -ENOMEM;
1514
1515	bcmdev->dev = &serdev->dev;
1516#ifdef CONFIG_PM
1517	bcmdev->hu = &bcmdev->serdev_hu;
1518#endif
1519	bcmdev->serdev_hu.serdev = serdev;
1520	serdev_device_set_drvdata(serdev, bcmdev);
1521
1522	/* Initialize routing field to an unused value */
1523	bcmdev->pcm_int_params[0] = 0xff;
1524
1525	if (has_acpi_companion(&serdev->dev))
1526		err = bcm_acpi_probe(bcmdev);
1527	else
1528		err = bcm_of_probe(bcmdev);
1529	if (err)
1530		return err;
1531
1532	err = bcm_get_resources(bcmdev);
1533	if (err)
1534		return err;
1535
1536	if (!bcmdev->shutdown) {
1537		dev_warn(&serdev->dev,
1538			 "No reset resource, using default baud rate\n");
1539		bcmdev->oper_speed = bcmdev->init_speed;
1540	}
1541
1542	err = bcm_gpio_set_power(bcmdev, false);
1543	if (err)
1544		dev_err(&serdev->dev, "Failed to power down\n");
1545
1546	data = device_get_match_data(bcmdev->dev);
1547	if (data) {
1548		bcmdev->max_autobaud_speed = data->max_autobaud_speed;
1549		bcmdev->no_early_set_baudrate = data->no_early_set_baudrate;
1550		bcmdev->drive_rts_on_open = data->drive_rts_on_open;
1551		bcmdev->no_uart_clock_set = data->no_uart_clock_set;
1552		if (data->max_speed && bcmdev->oper_speed > data->max_speed)
1553			bcmdev->oper_speed = data->max_speed;
1554	}
1555
1556	return hci_uart_register_device(&bcmdev->serdev_hu, &bcm_proto);
1557}
1558
1559static void bcm_serdev_remove(struct serdev_device *serdev)
1560{
1561	struct bcm_device *bcmdev = serdev_device_get_drvdata(serdev);
1562
1563	hci_uart_unregister_device(&bcmdev->serdev_hu);
1564}
1565
1566#ifdef CONFIG_OF
1567static struct bcm_device_data bcm4354_device_data = {
1568	.no_early_set_baudrate = true,
1569};
1570
1571static struct bcm_device_data bcm43438_device_data = {
1572	.drive_rts_on_open = true,
1573};
1574
1575static struct bcm_device_data cyw4373a0_device_data = {
1576	.no_uart_clock_set = true,
1577};
1578
1579static struct bcm_device_data cyw55572_device_data = {
1580	.max_autobaud_speed = 921600,
1581};
1582
1583static const struct of_device_id bcm_bluetooth_of_match[] = {
1584	{ .compatible = "brcm,bcm20702a1" },
1585	{ .compatible = "brcm,bcm4329-bt" },
1586	{ .compatible = "brcm,bcm4330-bt" },
1587	{ .compatible = "brcm,bcm4334-bt" },
1588	{ .compatible = "brcm,bcm4345c5" },
1589	{ .compatible = "brcm,bcm43430a0-bt" },
1590	{ .compatible = "brcm,bcm43430a1-bt" },
1591	{ .compatible = "brcm,bcm43438-bt", .data = &bcm43438_device_data },
1592	{ .compatible = "brcm,bcm4349-bt", .data = &bcm43438_device_data },
1593	{ .compatible = "brcm,bcm43540-bt", .data = &bcm4354_device_data },
1594	{ .compatible = "brcm,bcm4335a0" },
1595	{ .compatible = "cypress,cyw4373a0-bt", .data = &cyw4373a0_device_data },
1596	{ .compatible = "infineon,cyw55572-bt", .data = &cyw55572_device_data },
1597	{ },
1598};
1599MODULE_DEVICE_TABLE(of, bcm_bluetooth_of_match);
1600#endif
1601
1602static struct serdev_device_driver bcm_serdev_driver = {
1603	.probe = bcm_serdev_probe,
1604	.remove = bcm_serdev_remove,
1605	.driver = {
1606		.name = "hci_uart_bcm",
1607		.of_match_table = of_match_ptr(bcm_bluetooth_of_match),
1608		.acpi_match_table = ACPI_PTR(bcm_acpi_match),
1609		.pm = &bcm_pm_ops,
1610	},
1611};
1612
1613int __init bcm_init(void)
1614{
1615	/* For now, we need to keep both platform device
1616	 * driver (ACPI generated) and serdev driver (DT).
1617	 */
1618	platform_driver_register(&bcm_driver);
1619	serdev_device_driver_register(&bcm_serdev_driver);
1620
1621	return hci_uart_register_proto(&bcm_proto);
1622}
1623
1624int __exit bcm_deinit(void)
1625{
1626	platform_driver_unregister(&bcm_driver);
1627	serdev_device_driver_unregister(&bcm_serdev_driver);
1628
1629	return hci_uart_unregister_proto(&bcm_proto);
1630}