Linux Audio

Check our new training course

Loading...
Note: File does not exist in v3.1.
   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_mark_last_busy(bdev->dev);
 330	pm_runtime_put_autosuspend(bdev->dev);
 331
 332	return IRQ_HANDLED;
 333}
 334
 335static int bcm_request_irq(struct bcm_data *bcm)
 336{
 337	struct bcm_device *bdev = bcm->dev;
 338	int err;
 339
 340	mutex_lock(&bcm_device_lock);
 341	if (!bcm_device_exists(bdev)) {
 342		err = -ENODEV;
 343		goto unlock;
 344	}
 345
 346	if (bdev->irq <= 0) {
 347		err = -EOPNOTSUPP;
 348		goto unlock;
 349	}
 350
 351	err = devm_request_irq(bdev->dev, bdev->irq, bcm_host_wake,
 352			       bdev->irq_active_low ? IRQF_TRIGGER_FALLING :
 353						      IRQF_TRIGGER_RISING,
 354			       "host_wake", bdev);
 355	if (err) {
 356		bdev->irq = err;
 357		goto unlock;
 358	}
 359
 360	bdev->irq_acquired = true;
 361
 362	device_init_wakeup(bdev->dev, true);
 363
 364	pm_runtime_set_autosuspend_delay(bdev->dev,
 365					 BCM_AUTOSUSPEND_DELAY);
 366	pm_runtime_use_autosuspend(bdev->dev);
 367	pm_runtime_set_active(bdev->dev);
 368	pm_runtime_enable(bdev->dev);
 369
 370unlock:
 371	mutex_unlock(&bcm_device_lock);
 372
 373	return err;
 374}
 375
 376static const struct bcm_set_sleep_mode default_sleep_params = {
 377	.sleep_mode = 1,	/* 0=Disabled, 1=UART, 2=Reserved, 3=USB */
 378	.idle_host = 2,		/* idle threshold HOST, in 300ms */
 379	.idle_dev = 2,		/* idle threshold device, in 300ms */
 380	.bt_wake_active = 1,	/* BT_WAKE active mode: 1 = high, 0 = low */
 381	.host_wake_active = 0,	/* HOST_WAKE active mode: 1 = high, 0 = low */
 382	.allow_host_sleep = 1,	/* Allow host sleep in SCO flag */
 383	.combine_modes = 1,	/* Combine sleep and LPM flag */
 384	.tristate_control = 0,	/* Allow tri-state control of UART tx flag */
 385	/* Irrelevant USB flags */
 386	.usb_auto_sleep = 0,
 387	.usb_resume_timeout = 0,
 388	.break_to_host = 0,
 389	.pulsed_host_wake = 1,
 390};
 391
 392static int bcm_setup_sleep(struct hci_uart *hu)
 393{
 394	struct bcm_data *bcm = hu->priv;
 395	struct sk_buff *skb;
 396	struct bcm_set_sleep_mode sleep_params = default_sleep_params;
 397
 398	sleep_params.host_wake_active = !bcm->dev->irq_active_low;
 399
 400	skb = __hci_cmd_sync(hu->hdev, 0xfc27, sizeof(sleep_params),
 401			     &sleep_params, HCI_INIT_TIMEOUT);
 402	if (IS_ERR(skb)) {
 403		int err = PTR_ERR(skb);
 404		bt_dev_err(hu->hdev, "Sleep VSC failed (%d)", err);
 405		return err;
 406	}
 407	kfree_skb(skb);
 408
 409	bt_dev_dbg(hu->hdev, "Set Sleep Parameters VSC succeeded");
 410
 411	return 0;
 412}
 413#else
 414static inline int bcm_request_irq(struct bcm_data *bcm) { return 0; }
 415static inline int bcm_setup_sleep(struct hci_uart *hu) { return 0; }
 416#endif
 417
 418static int bcm_set_diag(struct hci_dev *hdev, bool enable)
 419{
 420	struct hci_uart *hu = hci_get_drvdata(hdev);
 421	struct bcm_data *bcm = hu->priv;
 422	struct sk_buff *skb;
 423
 424	if (!test_bit(HCI_RUNNING, &hdev->flags))
 425		return -ENETDOWN;
 426
 427	skb = bt_skb_alloc(3, GFP_KERNEL);
 428	if (!skb)
 429		return -ENOMEM;
 430
 431	skb_put_u8(skb, BCM_LM_DIAG_PKT);
 432	skb_put_u8(skb, 0xf0);
 433	skb_put_u8(skb, enable);
 434
 435	skb_queue_tail(&bcm->txq, skb);
 436	hci_uart_tx_wakeup(hu);
 437
 438	return 0;
 439}
 440
 441static int bcm_open(struct hci_uart *hu)
 442{
 443	struct bcm_data *bcm;
 444	struct list_head *p;
 445	int err;
 446
 447	bt_dev_dbg(hu->hdev, "hu %p", hu);
 448
 449	if (!hci_uart_has_flow_control(hu))
 450		return -EOPNOTSUPP;
 451
 452	bcm = kzalloc(sizeof(*bcm), GFP_KERNEL);
 453	if (!bcm)
 454		return -ENOMEM;
 455
 456	skb_queue_head_init(&bcm->txq);
 457
 458	hu->priv = bcm;
 459
 460	mutex_lock(&bcm_device_lock);
 461
 462	if (hu->serdev) {
 463		bcm->dev = serdev_device_get_drvdata(hu->serdev);
 464		goto out;
 465	}
 466
 467	if (!hu->tty->dev)
 468		goto out;
 469
 470	list_for_each(p, &bcm_device_list) {
 471		struct bcm_device *dev = list_entry(p, struct bcm_device, list);
 472
 473		/* Retrieve saved bcm_device based on parent of the
 474		 * platform device (saved during device probe) and
 475		 * parent of tty device used by hci_uart
 476		 */
 477		if (hu->tty->dev->parent == dev->dev->parent) {
 478			bcm->dev = dev;
 479#ifdef CONFIG_PM
 480			dev->hu = hu;
 481#endif
 482			break;
 483		}
 484	}
 485
 486out:
 487	if (bcm->dev) {
 488		if (bcm->dev->use_autobaud_mode)
 489			hci_uart_set_flow_control(hu, false);	/* Assert BT_UART_CTS_N */
 490		else if (bcm->dev->drive_rts_on_open)
 491			hci_uart_set_flow_control(hu, true);
 492
 493		if (bcm->dev->use_autobaud_mode && bcm->dev->max_autobaud_speed)
 494			hu->init_speed = min(bcm->dev->oper_speed, bcm->dev->max_autobaud_speed);
 495		else
 496			hu->init_speed = bcm->dev->init_speed;
 497
 498		/* If oper_speed is set, ldisc/serdev will set the baudrate
 499		 * before calling setup()
 500		 */
 501		if (!bcm->dev->no_early_set_baudrate && !bcm->dev->use_autobaud_mode)
 502			hu->oper_speed = bcm->dev->oper_speed;
 503
 504		err = bcm_gpio_set_power(bcm->dev, true);
 505
 506		if (bcm->dev->drive_rts_on_open)
 507			hci_uart_set_flow_control(hu, false);
 508
 509		if (err)
 510			goto err_unset_hu;
 511	}
 512
 513	mutex_unlock(&bcm_device_lock);
 514	return 0;
 515
 516err_unset_hu:
 517#ifdef CONFIG_PM
 518	if (!hu->serdev)
 519		bcm->dev->hu = NULL;
 520#endif
 521	mutex_unlock(&bcm_device_lock);
 522	hu->priv = NULL;
 523	kfree(bcm);
 524	return err;
 525}
 526
 527static int bcm_close(struct hci_uart *hu)
 528{
 529	struct bcm_data *bcm = hu->priv;
 530	struct bcm_device *bdev = NULL;
 531	int err;
 532
 533	bt_dev_dbg(hu->hdev, "hu %p", hu);
 534
 535	/* Protect bcm->dev against removal of the device or driver */
 536	mutex_lock(&bcm_device_lock);
 537
 538	if (hu->serdev) {
 539		bdev = serdev_device_get_drvdata(hu->serdev);
 540	} else if (bcm_device_exists(bcm->dev)) {
 541		bdev = bcm->dev;
 542#ifdef CONFIG_PM
 543		bdev->hu = NULL;
 544#endif
 545	}
 546
 547	if (bdev) {
 548		if (IS_ENABLED(CONFIG_PM) && bdev->irq_acquired) {
 549			devm_free_irq(bdev->dev, bdev->irq, bdev);
 550			device_init_wakeup(bdev->dev, false);
 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
 570static 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
 581static 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 (test_bit(HCI_QUIRK_INVALID_BDADDR, &hu->hdev->quirks))
 647		set_bit(HCI_QUIRK_USE_BDADDR_PROPERTY, &hu->hdev->quirks);
 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
 683static 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
 694static 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->hdev, 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_mark_last_busy(bcm->dev->dev);
 714			pm_runtime_put_autosuspend(bcm->dev->dev);
 715		}
 716		mutex_unlock(&bcm_device_lock);
 717	}
 718
 719	return count;
 720}
 721
 722static int bcm_enqueue(struct hci_uart *hu, struct sk_buff *skb)
 723{
 724	struct bcm_data *bcm = hu->priv;
 725
 726	bt_dev_dbg(hu->hdev, "hu %p skb %p", hu, skb);
 727
 728	/* Prepend skb with frame type */
 729	memcpy(skb_push(skb, 1), &hci_skb_pkt_type(skb), 1);
 730	skb_queue_tail(&bcm->txq, skb);
 731
 732	return 0;
 733}
 734
 735static struct sk_buff *bcm_dequeue(struct hci_uart *hu)
 736{
 737	struct bcm_data *bcm = hu->priv;
 738	struct sk_buff *skb = NULL;
 739	struct bcm_device *bdev = NULL;
 740
 741	mutex_lock(&bcm_device_lock);
 742
 743	if (bcm_device_exists(bcm->dev)) {
 744		bdev = bcm->dev;
 745		pm_runtime_get_sync(bdev->dev);
 746		/* Shall be resumed here */
 747	}
 748
 749	skb = skb_dequeue(&bcm->txq);
 750
 751	if (bdev) {
 752		pm_runtime_mark_last_busy(bdev->dev);
 753		pm_runtime_put_autosuspend(bdev->dev);
 754	}
 755
 756	mutex_unlock(&bcm_device_lock);
 757
 758	return skb;
 759}
 760
 761#ifdef CONFIG_PM
 762static int bcm_suspend_device(struct device *dev)
 763{
 764	struct bcm_device *bdev = dev_get_drvdata(dev);
 765	int err;
 766
 767	bt_dev_dbg(bdev, "");
 768
 769	if (!bdev->is_suspended && bdev->hu) {
 770		hci_uart_set_flow_control(bdev->hu, true);
 771
 772		/* Once this returns, driver suspends BT via GPIO */
 773		bdev->is_suspended = true;
 774	}
 775
 776	/* Suspend the device */
 777	err = bdev->set_device_wakeup(bdev, false);
 778	if (err) {
 779		if (bdev->is_suspended && bdev->hu) {
 780			bdev->is_suspended = false;
 781			hci_uart_set_flow_control(bdev->hu, false);
 782		}
 783		return -EBUSY;
 784	}
 785
 786	bt_dev_dbg(bdev, "suspend, delaying 15 ms");
 787	msleep(15);
 788
 789	return 0;
 790}
 791
 792static int bcm_resume_device(struct device *dev)
 793{
 794	struct bcm_device *bdev = dev_get_drvdata(dev);
 795	int err;
 796
 797	bt_dev_dbg(bdev, "");
 798
 799	err = bdev->set_device_wakeup(bdev, true);
 800	if (err) {
 801		dev_err(dev, "Failed to power up\n");
 802		return err;
 803	}
 804
 805	bt_dev_dbg(bdev, "resume, delaying 15 ms");
 806	msleep(15);
 807
 808	/* When this executes, the device has woken up already */
 809	if (bdev->is_suspended && bdev->hu) {
 810		bdev->is_suspended = false;
 811
 812		hci_uart_set_flow_control(bdev->hu, false);
 813	}
 814
 815	return 0;
 816}
 817#endif
 818
 819#ifdef CONFIG_PM_SLEEP
 820/* suspend callback */
 821static int bcm_suspend(struct device *dev)
 822{
 823	struct bcm_device *bdev = dev_get_drvdata(dev);
 824	int error;
 825
 826	bt_dev_dbg(bdev, "suspend: is_suspended %d", bdev->is_suspended);
 827
 828	/*
 829	 * When used with a device instantiated as platform_device, bcm_suspend
 830	 * can be called at any time as long as the platform device is bound,
 831	 * so it should use bcm_device_lock to protect access to hci_uart
 832	 * and device_wake-up GPIO.
 833	 */
 834	mutex_lock(&bcm_device_lock);
 835
 836	if (!bdev->hu)
 837		goto unlock;
 838
 839	if (pm_runtime_active(dev))
 840		bcm_suspend_device(dev);
 841
 842	if (device_may_wakeup(dev) && bdev->irq > 0) {
 843		error = enable_irq_wake(bdev->irq);
 844		if (!error)
 845			bt_dev_dbg(bdev, "BCM irq: enabled");
 846	}
 847
 848unlock:
 849	mutex_unlock(&bcm_device_lock);
 850
 851	return 0;
 852}
 853
 854/* resume callback */
 855static int bcm_resume(struct device *dev)
 856{
 857	struct bcm_device *bdev = dev_get_drvdata(dev);
 858	int err = 0;
 859
 860	bt_dev_dbg(bdev, "resume: is_suspended %d", bdev->is_suspended);
 861
 862	/*
 863	 * When used with a device instantiated as platform_device, bcm_resume
 864	 * can be called at any time as long as platform device is bound,
 865	 * so it should use bcm_device_lock to protect access to hci_uart
 866	 * and device_wake-up GPIO.
 867	 */
 868	mutex_lock(&bcm_device_lock);
 869
 870	if (!bdev->hu)
 871		goto unlock;
 872
 873	if (device_may_wakeup(dev) && bdev->irq > 0) {
 874		disable_irq_wake(bdev->irq);
 875		bt_dev_dbg(bdev, "BCM irq: disabled");
 876	}
 877
 878	err = bcm_resume_device(dev);
 879
 880unlock:
 881	mutex_unlock(&bcm_device_lock);
 882
 883	if (!err) {
 884		pm_runtime_disable(dev);
 885		pm_runtime_set_active(dev);
 886		pm_runtime_enable(dev);
 887	}
 888
 889	return 0;
 890}
 891#endif
 892
 893/* Some firmware reports an IRQ which does not work (wrong pin in fw table?) */
 894static struct gpiod_lookup_table irq_on_int33fc02_pin17_gpios = {
 895	.dev_id = "serial0-0",
 896	.table = {
 897		GPIO_LOOKUP("INT33FC:02", 17, "host-wakeup-alt", GPIO_ACTIVE_HIGH),
 898		{ }
 899	},
 900};
 901
 902static const struct dmi_system_id bcm_broken_irq_dmi_table[] = {
 903	{
 904		.ident = "Acer Iconia One 7 B1-750",
 905		.matches = {
 906			DMI_MATCH(DMI_SYS_VENDOR, "Insyde"),
 907			DMI_MATCH(DMI_PRODUCT_NAME, "VESPA2"),
 908		},
 909		.driver_data = &irq_on_int33fc02_pin17_gpios,
 910	},
 911	{
 912		.ident = "Asus TF103C",
 913		.matches = {
 914			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
 915			DMI_MATCH(DMI_PRODUCT_NAME, "TF103C"),
 916		},
 917		.driver_data = &irq_on_int33fc02_pin17_gpios,
 918	},
 919	{
 920		.ident = "Lenovo Yoga Tablet 2 830F/L / 1050F/L",
 921		.matches = {
 922			DMI_MATCH(DMI_SYS_VENDOR, "Intel Corp."),
 923			DMI_MATCH(DMI_PRODUCT_NAME, "VALLEYVIEW C0 PLATFORM"),
 924			DMI_MATCH(DMI_BOARD_NAME, "BYT-T FFD8"),
 925			/* Partial match on beginning of BIOS version */
 926			DMI_MATCH(DMI_BIOS_VERSION, "BLADE_21"),
 927		},
 928		.driver_data = &irq_on_int33fc02_pin17_gpios,
 929	},
 930	{
 931		.ident = "Meegopad T08",
 932		.matches = {
 933			DMI_EXACT_MATCH(DMI_BOARD_VENDOR,
 934					"To be filled by OEM."),
 935			DMI_EXACT_MATCH(DMI_BOARD_NAME, "T3 MRD"),
 936			DMI_EXACT_MATCH(DMI_BOARD_VERSION, "V1.1"),
 937		},
 938	},
 939	{ }
 940};
 941
 942#ifdef CONFIG_ACPI
 943static const struct acpi_gpio_params first_gpio = { 0, 0, false };
 944static const struct acpi_gpio_params second_gpio = { 1, 0, false };
 945static const struct acpi_gpio_params third_gpio = { 2, 0, false };
 946
 947static const struct acpi_gpio_mapping acpi_bcm_int_last_gpios[] = {
 948	{ "device-wakeup-gpios", &first_gpio, 1 },
 949	{ "shutdown-gpios", &second_gpio, 1 },
 950	{ "host-wakeup-gpios", &third_gpio, 1 },
 951	{ },
 952};
 953
 954static const struct acpi_gpio_mapping acpi_bcm_int_first_gpios[] = {
 955	{ "host-wakeup-gpios", &first_gpio, 1 },
 956	{ "device-wakeup-gpios", &second_gpio, 1 },
 957	{ "shutdown-gpios", &third_gpio, 1 },
 958	{ },
 959};
 960
 961static int bcm_resource(struct acpi_resource *ares, void *data)
 962{
 963	struct bcm_device *dev = data;
 964	struct acpi_resource_extended_irq *irq;
 965	struct acpi_resource_gpio *gpio;
 966	struct acpi_resource_uart_serialbus *sb;
 967
 968	switch (ares->type) {
 969	case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
 970		irq = &ares->data.extended_irq;
 971		if (irq->polarity != ACPI_ACTIVE_LOW)
 972			dev_info(dev->dev, "ACPI Interrupt resource is active-high, this is usually wrong, treating the IRQ as active-low\n");
 973		dev->irq_active_low = true;
 974		break;
 975
 976	case ACPI_RESOURCE_TYPE_GPIO:
 977		gpio = &ares->data.gpio;
 978		if (gpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT) {
 979			dev->gpio_int_idx = dev->gpio_count;
 980			dev->irq_active_low = gpio->polarity == ACPI_ACTIVE_LOW;
 981		}
 982		dev->gpio_count++;
 983		break;
 984
 985	case ACPI_RESOURCE_TYPE_SERIAL_BUS:
 986		sb = &ares->data.uart_serial_bus;
 987		if (sb->type == ACPI_RESOURCE_SERIAL_TYPE_UART) {
 988			dev->init_speed = sb->default_baud_rate;
 989			dev->oper_speed = 4000000;
 990		}
 991		break;
 992
 993	default:
 994		break;
 995	}
 996
 997	return 0;
 998}
 999
1000static int bcm_apple_set_device_wakeup(struct bcm_device *dev, bool awake)
1001{
1002	if (ACPI_FAILURE(acpi_execute_simple_method(dev->btlp, NULL, !awake)))
1003		return -EIO;
1004
1005	return 0;
1006}
1007
1008static int bcm_apple_set_shutdown(struct bcm_device *dev, bool powered)
1009{
1010	if (ACPI_FAILURE(acpi_evaluate_object(powered ? dev->btpu : dev->btpd,
1011					      NULL, NULL, NULL)))
1012		return -EIO;
1013
1014	return 0;
1015}
1016
1017static int bcm_apple_get_resources(struct bcm_device *dev)
1018{
1019	struct acpi_device *adev = ACPI_COMPANION(dev->dev);
1020	const union acpi_object *obj;
1021
1022	if (!adev ||
1023	    ACPI_FAILURE(acpi_get_handle(adev->handle, "BTLP", &dev->btlp)) ||
1024	    ACPI_FAILURE(acpi_get_handle(adev->handle, "BTPU", &dev->btpu)) ||
1025	    ACPI_FAILURE(acpi_get_handle(adev->handle, "BTPD", &dev->btpd)))
1026		return -ENODEV;
1027
1028	if (!acpi_dev_get_property(adev, "baud", ACPI_TYPE_BUFFER, &obj) &&
1029	    obj->buffer.length == 8)
1030		dev->init_speed = *(u64 *)obj->buffer.pointer;
1031
1032	dev->set_device_wakeup = bcm_apple_set_device_wakeup;
1033	dev->set_shutdown = bcm_apple_set_shutdown;
1034
1035	return 0;
1036}
1037#else
1038static inline int bcm_apple_get_resources(struct bcm_device *dev)
1039{
1040	return -EOPNOTSUPP;
1041}
1042#endif /* CONFIG_ACPI */
1043
1044static int bcm_gpio_set_device_wakeup(struct bcm_device *dev, bool awake)
1045{
1046	gpiod_set_value_cansleep(dev->device_wakeup, awake);
1047	return 0;
1048}
1049
1050static int bcm_gpio_set_shutdown(struct bcm_device *dev, bool powered)
1051{
1052	gpiod_set_value_cansleep(dev->shutdown, powered);
1053	if (dev->reset)
1054		/*
1055		 * The reset line is asserted on powerdown and deasserted
1056		 * on poweron so the inverse of powered is used. Notice
1057		 * that the GPIO line BT_RST_N needs to be specified as
1058		 * active low in the device tree or similar system
1059		 * description.
1060		 */
1061		gpiod_set_value_cansleep(dev->reset, !powered);
1062	return 0;
1063}
1064
1065/* Try a bunch of names for TXCO */
1066static struct clk *bcm_get_txco(struct device *dev)
1067{
1068	struct clk *clk;
1069
1070	/* New explicit name */
1071	clk = devm_clk_get_optional(dev, "txco");
1072	if (clk)
1073		return clk;
1074
1075	/* Deprecated name */
1076	clk = devm_clk_get_optional(dev, "extclk");
1077	if (clk)
1078		return clk;
1079
1080	/* Original code used no name at all */
1081	return devm_clk_get_optional(dev, NULL);
1082}
1083
1084static int bcm_get_resources(struct bcm_device *dev)
1085{
1086	const struct dmi_system_id *broken_irq_dmi_id;
1087	const char *irq_con_id = "host-wakeup";
1088	int err;
1089
1090	dev->name = dev_name(dev->dev);
1091
1092	if (x86_apple_machine && !bcm_apple_get_resources(dev))
1093		return 0;
1094
1095	dev->txco_clk = bcm_get_txco(dev->dev);
1096	if (IS_ERR(dev->txco_clk))
1097		return PTR_ERR(dev->txco_clk);
1098
1099	dev->lpo_clk = devm_clk_get_optional(dev->dev, "lpo");
1100	if (IS_ERR(dev->lpo_clk))
1101		return PTR_ERR(dev->lpo_clk);
1102
1103	/* Check if we accidentally fetched the lpo clock twice */
1104	if (dev->lpo_clk && clk_is_match(dev->lpo_clk, dev->txco_clk)) {
1105		devm_clk_put(dev->dev, dev->txco_clk);
1106		dev->txco_clk = NULL;
1107	}
1108
1109	dev->device_wakeup = devm_gpiod_get_optional(dev->dev, "device-wakeup",
1110						     GPIOD_OUT_LOW);
1111	if (IS_ERR(dev->device_wakeup))
1112		return PTR_ERR(dev->device_wakeup);
1113
1114	dev->shutdown = devm_gpiod_get_optional(dev->dev, "shutdown",
1115						GPIOD_OUT_LOW);
1116	if (IS_ERR(dev->shutdown))
1117		return PTR_ERR(dev->shutdown);
1118
1119	dev->reset = devm_gpiod_get_optional(dev->dev, "reset",
1120					     GPIOD_OUT_LOW);
1121	if (IS_ERR(dev->reset))
1122		return PTR_ERR(dev->reset);
1123
1124	dev->set_device_wakeup = bcm_gpio_set_device_wakeup;
1125	dev->set_shutdown = bcm_gpio_set_shutdown;
1126
1127	dev->supplies[0].supply = "vbat";
1128	dev->supplies[1].supply = "vddio";
1129	err = devm_regulator_bulk_get(dev->dev, BCM_NUM_SUPPLIES,
1130				      dev->supplies);
1131	if (err)
1132		return err;
1133
1134	broken_irq_dmi_id = dmi_first_match(bcm_broken_irq_dmi_table);
1135	if (broken_irq_dmi_id && broken_irq_dmi_id->driver_data) {
1136		gpiod_add_lookup_table(broken_irq_dmi_id->driver_data);
1137		irq_con_id = "host-wakeup-alt";
1138		dev->irq_active_low = false;
1139		dev->irq = 0;
1140	}
1141
1142	/* IRQ can be declared in ACPI table as Interrupt or GpioInt */
1143	if (dev->irq <= 0) {
1144		struct gpio_desc *gpio;
1145
1146		gpio = devm_gpiod_get_optional(dev->dev, irq_con_id, GPIOD_IN);
1147		if (IS_ERR(gpio))
1148			return PTR_ERR(gpio);
1149
1150		dev->irq = gpiod_to_irq(gpio);
1151	}
1152
1153	if (broken_irq_dmi_id) {
1154		if (broken_irq_dmi_id->driver_data) {
1155			gpiod_remove_lookup_table(broken_irq_dmi_id->driver_data);
1156		} else {
1157			dev_info(dev->dev, "%s: Has a broken IRQ config, disabling IRQ support / runtime-pm\n",
1158				 broken_irq_dmi_id->ident);
1159			dev->irq = 0;
1160		}
1161	}
1162
1163	dev_dbg(dev->dev, "BCM irq: %d\n", dev->irq);
1164	return 0;
1165}
1166
1167#ifdef CONFIG_ACPI
1168static int bcm_acpi_probe(struct bcm_device *dev)
1169{
1170	LIST_HEAD(resources);
1171	const struct acpi_gpio_mapping *gpio_mapping = acpi_bcm_int_last_gpios;
1172	struct resource_entry *entry;
1173	int ret;
1174
1175	/* Retrieve UART ACPI info */
1176	dev->gpio_int_idx = -1;
1177	ret = acpi_dev_get_resources(ACPI_COMPANION(dev->dev),
1178				     &resources, bcm_resource, dev);
1179	if (ret < 0)
1180		return ret;
1181
1182	resource_list_for_each_entry(entry, &resources) {
1183		if (resource_type(entry->res) == IORESOURCE_IRQ) {
1184			dev->irq = entry->res->start;
1185			break;
1186		}
1187	}
1188	acpi_dev_free_resource_list(&resources);
1189
1190	/* If the DSDT uses an Interrupt resource for the IRQ, then there are
1191	 * only 2 GPIO resources, we use the irq-last mapping for this, since
1192	 * we already have an irq the 3th / last mapping will not be used.
1193	 */
1194	if (dev->irq)
1195		gpio_mapping = acpi_bcm_int_last_gpios;
1196	else if (dev->gpio_int_idx == 0)
1197		gpio_mapping = acpi_bcm_int_first_gpios;
1198	else if (dev->gpio_int_idx == 2)
1199		gpio_mapping = acpi_bcm_int_last_gpios;
1200	else
1201		dev_warn(dev->dev, "Unexpected ACPI gpio_int_idx: %d\n",
1202			 dev->gpio_int_idx);
1203
1204	/* Warn if our expectations are not met. */
1205	if (dev->gpio_count != (dev->irq ? 2 : 3))
1206		dev_warn(dev->dev, "Unexpected number of ACPI GPIOs: %d\n",
1207			 dev->gpio_count);
1208
1209	ret = devm_acpi_dev_add_driver_gpios(dev->dev, gpio_mapping);
1210	if (ret)
1211		return ret;
1212
1213	if (irq_polarity != -1) {
1214		dev->irq_active_low = irq_polarity;
1215		dev_warn(dev->dev, "Overwriting IRQ polarity to active %s by module-param\n",
1216			 dev->irq_active_low ? "low" : "high");
1217	}
1218
1219	return 0;
1220}
1221#else
1222static int bcm_acpi_probe(struct bcm_device *dev)
1223{
1224	return -EINVAL;
1225}
1226#endif /* CONFIG_ACPI */
1227
1228static int bcm_of_probe(struct bcm_device *bdev)
1229{
1230	bdev->use_autobaud_mode = device_property_read_bool(bdev->dev,
1231							    "brcm,requires-autobaud-mode");
1232	device_property_read_u32(bdev->dev, "max-speed", &bdev->oper_speed);
1233	device_property_read_u8_array(bdev->dev, "brcm,bt-pcm-int-params",
1234				      bdev->pcm_int_params, 5);
1235	bdev->irq = of_irq_get_byname(bdev->dev->of_node, "host-wakeup");
1236	bdev->irq_active_low = irq_get_trigger_type(bdev->irq)
1237			     & (IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_LEVEL_LOW);
1238	return 0;
1239}
1240
1241static int bcm_probe(struct platform_device *pdev)
1242{
1243	struct bcm_device *dev;
1244	int ret;
1245
1246	dev = devm_kzalloc(&pdev->dev, sizeof(*dev), GFP_KERNEL);
1247	if (!dev)
1248		return -ENOMEM;
1249
1250	dev->dev = &pdev->dev;
1251
1252	ret = platform_get_irq(pdev, 0);
1253	if (ret < 0)
1254		return ret;
1255
1256	dev->irq = ret;
1257
1258	/* Initialize routing field to an unused value */
1259	dev->pcm_int_params[0] = 0xff;
1260
1261	if (has_acpi_companion(&pdev->dev)) {
1262		ret = bcm_acpi_probe(dev);
1263		if (ret)
1264			return ret;
1265	}
1266
1267	ret = bcm_get_resources(dev);
1268	if (ret)
1269		return ret;
1270
1271	platform_set_drvdata(pdev, dev);
1272
1273	dev_info(&pdev->dev, "%s device registered.\n", dev->name);
1274
1275	/* Place this instance on the device list */
1276	mutex_lock(&bcm_device_lock);
1277	list_add_tail(&dev->list, &bcm_device_list);
1278	mutex_unlock(&bcm_device_lock);
1279
1280	ret = bcm_gpio_set_power(dev, false);
1281	if (ret)
1282		dev_err(&pdev->dev, "Failed to power down\n");
1283
1284	return 0;
1285}
1286
1287static void bcm_remove(struct platform_device *pdev)
1288{
1289	struct bcm_device *dev = platform_get_drvdata(pdev);
1290
1291	mutex_lock(&bcm_device_lock);
1292	list_del(&dev->list);
1293	mutex_unlock(&bcm_device_lock);
1294
1295	dev_info(&pdev->dev, "%s device unregistered.\n", dev->name);
1296}
1297
1298static const struct hci_uart_proto bcm_proto = {
1299	.id		= HCI_UART_BCM,
1300	.name		= "Broadcom",
1301	.manufacturer	= 15,
1302	.init_speed	= 115200,
1303	.open		= bcm_open,
1304	.close		= bcm_close,
1305	.flush		= bcm_flush,
1306	.setup		= bcm_setup,
1307	.set_baudrate	= bcm_set_baudrate,
1308	.recv		= bcm_recv,
1309	.enqueue	= bcm_enqueue,
1310	.dequeue	= bcm_dequeue,
1311};
1312
1313#ifdef CONFIG_ACPI
1314
1315/* bcm43430a0/a1 BT does not support 48MHz UART clock, limit to 2000000 baud */
1316static struct bcm_device_data bcm43430_device_data = {
1317	.max_speed = 2000000,
1318};
1319
1320static const struct acpi_device_id bcm_acpi_match[] = {
1321	{ "BCM2E00" },
1322	{ "BCM2E01" },
1323	{ "BCM2E02" },
1324	{ "BCM2E03" },
1325	{ "BCM2E04" },
1326	{ "BCM2E05" },
1327	{ "BCM2E06" },
1328	{ "BCM2E07" },
1329	{ "BCM2E08" },
1330	{ "BCM2E09" },
1331	{ "BCM2E0A" },
1332	{ "BCM2E0B" },
1333	{ "BCM2E0C" },
1334	{ "BCM2E0D" },
1335	{ "BCM2E0E" },
1336	{ "BCM2E0F" },
1337	{ "BCM2E10" },
1338	{ "BCM2E11" },
1339	{ "BCM2E12" },
1340	{ "BCM2E13" },
1341	{ "BCM2E14" },
1342	{ "BCM2E15" },
1343	{ "BCM2E16" },
1344	{ "BCM2E17" },
1345	{ "BCM2E18" },
1346	{ "BCM2E19" },
1347	{ "BCM2E1A" },
1348	{ "BCM2E1B" },
1349	{ "BCM2E1C" },
1350	{ "BCM2E1D" },
1351	{ "BCM2E1F" },
1352	{ "BCM2E20" },
1353	{ "BCM2E21" },
1354	{ "BCM2E22" },
1355	{ "BCM2E23" },
1356	{ "BCM2E24" },
1357	{ "BCM2E25" },
1358	{ "BCM2E26" },
1359	{ "BCM2E27" },
1360	{ "BCM2E28" },
1361	{ "BCM2E29" },
1362	{ "BCM2E2A" },
1363	{ "BCM2E2B" },
1364	{ "BCM2E2C" },
1365	{ "BCM2E2D" },
1366	{ "BCM2E2E" },
1367	{ "BCM2E2F" },
1368	{ "BCM2E30" },
1369	{ "BCM2E31" },
1370	{ "BCM2E32" },
1371	{ "BCM2E33" },
1372	{ "BCM2E34" },
1373	{ "BCM2E35" },
1374	{ "BCM2E36" },
1375	{ "BCM2E37" },
1376	{ "BCM2E38" },
1377	{ "BCM2E39" },
1378	{ "BCM2E3A" },
1379	{ "BCM2E3B" },
1380	{ "BCM2E3C" },
1381	{ "BCM2E3D" },
1382	{ "BCM2E3E" },
1383	{ "BCM2E3F" },
1384	{ "BCM2E40" },
1385	{ "BCM2E41" },
1386	{ "BCM2E42" },
1387	{ "BCM2E43" },
1388	{ "BCM2E44" },
1389	{ "BCM2E45" },
1390	{ "BCM2E46" },
1391	{ "BCM2E47" },
1392	{ "BCM2E48" },
1393	{ "BCM2E49" },
1394	{ "BCM2E4A" },
1395	{ "BCM2E4B" },
1396	{ "BCM2E4C" },
1397	{ "BCM2E4D" },
1398	{ "BCM2E4E" },
1399	{ "BCM2E4F" },
1400	{ "BCM2E50" },
1401	{ "BCM2E51" },
1402	{ "BCM2E52" },
1403	{ "BCM2E53" },
1404	{ "BCM2E54" },
1405	{ "BCM2E55" },
1406	{ "BCM2E56" },
1407	{ "BCM2E57" },
1408	{ "BCM2E58" },
1409	{ "BCM2E59" },
1410	{ "BCM2E5A" },
1411	{ "BCM2E5B" },
1412	{ "BCM2E5C" },
1413	{ "BCM2E5D" },
1414	{ "BCM2E5E" },
1415	{ "BCM2E5F" },
1416	{ "BCM2E60" },
1417	{ "BCM2E61" },
1418	{ "BCM2E62" },
1419	{ "BCM2E63" },
1420	{ "BCM2E64" },
1421	{ "BCM2E65" },
1422	{ "BCM2E66" },
1423	{ "BCM2E67" },
1424	{ "BCM2E68" },
1425	{ "BCM2E69" },
1426	{ "BCM2E6B" },
1427	{ "BCM2E6D" },
1428	{ "BCM2E6E" },
1429	{ "BCM2E6F" },
1430	{ "BCM2E70" },
1431	{ "BCM2E71" },
1432	{ "BCM2E72" },
1433	{ "BCM2E73" },
1434	{ "BCM2E74", (long)&bcm43430_device_data },
1435	{ "BCM2E75", (long)&bcm43430_device_data },
1436	{ "BCM2E76" },
1437	{ "BCM2E77" },
1438	{ "BCM2E78" },
1439	{ "BCM2E79" },
1440	{ "BCM2E7A" },
1441	{ "BCM2E7B", (long)&bcm43430_device_data },
1442	{ "BCM2E7C" },
1443	{ "BCM2E7D" },
1444	{ "BCM2E7E" },
1445	{ "BCM2E7F" },
1446	{ "BCM2E80", (long)&bcm43430_device_data },
1447	{ "BCM2E81" },
1448	{ "BCM2E82" },
1449	{ "BCM2E83" },
1450	{ "BCM2E84" },
1451	{ "BCM2E85" },
1452	{ "BCM2E86" },
1453	{ "BCM2E87" },
1454	{ "BCM2E88" },
1455	{ "BCM2E89", (long)&bcm43430_device_data },
1456	{ "BCM2E8A" },
1457	{ "BCM2E8B" },
1458	{ "BCM2E8C" },
1459	{ "BCM2E8D" },
1460	{ "BCM2E8E" },
1461	{ "BCM2E90" },
1462	{ "BCM2E92" },
1463	{ "BCM2E93" },
1464	{ "BCM2E94", (long)&bcm43430_device_data },
1465	{ "BCM2E95" },
1466	{ "BCM2E96" },
1467	{ "BCM2E97" },
1468	{ "BCM2E98" },
1469	{ "BCM2E99", (long)&bcm43430_device_data },
1470	{ "BCM2E9A" },
1471	{ "BCM2E9B", (long)&bcm43430_device_data },
1472	{ "BCM2E9C" },
1473	{ "BCM2E9D" },
1474	{ "BCM2E9F", (long)&bcm43430_device_data },
1475	{ "BCM2EA0" },
1476	{ "BCM2EA1" },
1477	{ "BCM2EA2", (long)&bcm43430_device_data },
1478	{ "BCM2EA3", (long)&bcm43430_device_data },
1479	{ "BCM2EA4", (long)&bcm43430_device_data }, /* bcm43455 */
1480	{ "BCM2EA5" },
1481	{ "BCM2EA6" },
1482	{ "BCM2EA7" },
1483	{ "BCM2EA8" },
1484	{ "BCM2EA9" },
1485	{ "BCM2EAA", (long)&bcm43430_device_data },
1486	{ "BCM2EAB", (long)&bcm43430_device_data },
1487	{ "BCM2EAC", (long)&bcm43430_device_data },
1488	{ },
1489};
1490MODULE_DEVICE_TABLE(acpi, bcm_acpi_match);
1491#endif
1492
1493/* suspend and resume callbacks */
1494static const struct dev_pm_ops bcm_pm_ops = {
1495	SET_SYSTEM_SLEEP_PM_OPS(bcm_suspend, bcm_resume)
1496	SET_RUNTIME_PM_OPS(bcm_suspend_device, bcm_resume_device, NULL)
1497};
1498
1499static struct platform_driver bcm_driver = {
1500	.probe = bcm_probe,
1501	.remove = bcm_remove,
1502	.driver = {
1503		.name = "hci_bcm",
1504		.acpi_match_table = ACPI_PTR(bcm_acpi_match),
1505		.pm = &bcm_pm_ops,
1506	},
1507};
1508
1509static int bcm_serdev_probe(struct serdev_device *serdev)
1510{
1511	struct bcm_device *bcmdev;
1512	const struct bcm_device_data *data;
1513	int err;
1514
1515	bcmdev = devm_kzalloc(&serdev->dev, sizeof(*bcmdev), GFP_KERNEL);
1516	if (!bcmdev)
1517		return -ENOMEM;
1518
1519	bcmdev->dev = &serdev->dev;
1520#ifdef CONFIG_PM
1521	bcmdev->hu = &bcmdev->serdev_hu;
1522#endif
1523	bcmdev->serdev_hu.serdev = serdev;
1524	serdev_device_set_drvdata(serdev, bcmdev);
1525
1526	/* Initialize routing field to an unused value */
1527	bcmdev->pcm_int_params[0] = 0xff;
1528
1529	if (has_acpi_companion(&serdev->dev))
1530		err = bcm_acpi_probe(bcmdev);
1531	else
1532		err = bcm_of_probe(bcmdev);
1533	if (err)
1534		return err;
1535
1536	err = bcm_get_resources(bcmdev);
1537	if (err)
1538		return err;
1539
1540	if (!bcmdev->shutdown) {
1541		dev_warn(&serdev->dev,
1542			 "No reset resource, using default baud rate\n");
1543		bcmdev->oper_speed = bcmdev->init_speed;
1544	}
1545
1546	err = bcm_gpio_set_power(bcmdev, false);
1547	if (err)
1548		dev_err(&serdev->dev, "Failed to power down\n");
1549
1550	data = device_get_match_data(bcmdev->dev);
1551	if (data) {
1552		bcmdev->max_autobaud_speed = data->max_autobaud_speed;
1553		bcmdev->no_early_set_baudrate = data->no_early_set_baudrate;
1554		bcmdev->drive_rts_on_open = data->drive_rts_on_open;
1555		bcmdev->no_uart_clock_set = data->no_uart_clock_set;
1556		if (data->max_speed && bcmdev->oper_speed > data->max_speed)
1557			bcmdev->oper_speed = data->max_speed;
1558	}
1559
1560	return hci_uart_register_device(&bcmdev->serdev_hu, &bcm_proto);
1561}
1562
1563static void bcm_serdev_remove(struct serdev_device *serdev)
1564{
1565	struct bcm_device *bcmdev = serdev_device_get_drvdata(serdev);
1566
1567	hci_uart_unregister_device(&bcmdev->serdev_hu);
1568}
1569
1570#ifdef CONFIG_OF
1571static struct bcm_device_data bcm4354_device_data = {
1572	.no_early_set_baudrate = true,
1573};
1574
1575static struct bcm_device_data bcm43438_device_data = {
1576	.drive_rts_on_open = true,
1577};
1578
1579static struct bcm_device_data cyw4373a0_device_data = {
1580	.no_uart_clock_set = true,
1581};
1582
1583static struct bcm_device_data cyw55572_device_data = {
1584	.max_autobaud_speed = 921600,
1585};
1586
1587static const struct of_device_id bcm_bluetooth_of_match[] = {
1588	{ .compatible = "brcm,bcm20702a1" },
1589	{ .compatible = "brcm,bcm4329-bt" },
1590	{ .compatible = "brcm,bcm4330-bt" },
1591	{ .compatible = "brcm,bcm4334-bt" },
1592	{ .compatible = "brcm,bcm4345c5" },
1593	{ .compatible = "brcm,bcm43430a0-bt" },
1594	{ .compatible = "brcm,bcm43430a1-bt" },
1595	{ .compatible = "brcm,bcm43438-bt", .data = &bcm43438_device_data },
1596	{ .compatible = "brcm,bcm4349-bt", .data = &bcm43438_device_data },
1597	{ .compatible = "brcm,bcm43540-bt", .data = &bcm4354_device_data },
1598	{ .compatible = "brcm,bcm4335a0" },
1599	{ .compatible = "cypress,cyw4373a0-bt", .data = &cyw4373a0_device_data },
1600	{ .compatible = "infineon,cyw55572-bt", .data = &cyw55572_device_data },
1601	{ },
1602};
1603MODULE_DEVICE_TABLE(of, bcm_bluetooth_of_match);
1604#endif
1605
1606static struct serdev_device_driver bcm_serdev_driver = {
1607	.probe = bcm_serdev_probe,
1608	.remove = bcm_serdev_remove,
1609	.driver = {
1610		.name = "hci_uart_bcm",
1611		.of_match_table = of_match_ptr(bcm_bluetooth_of_match),
1612		.acpi_match_table = ACPI_PTR(bcm_acpi_match),
1613		.pm = &bcm_pm_ops,
1614	},
1615};
1616
1617int __init bcm_init(void)
1618{
1619	/* For now, we need to keep both platform device
1620	 * driver (ACPI generated) and serdev driver (DT).
1621	 */
1622	platform_driver_register(&bcm_driver);
1623	serdev_device_driver_register(&bcm_serdev_driver);
1624
1625	return hci_uart_register_proto(&bcm_proto);
1626}
1627
1628int __exit bcm_deinit(void)
1629{
1630	platform_driver_unregister(&bcm_driver);
1631	serdev_device_driver_unregister(&bcm_serdev_driver);
1632
1633	return hci_uart_unregister_proto(&bcm_proto);
1634}