2c96cc9c036bcf843031021c0e64bdda50c67439
[platform/kernel/linux-rpi.git] / drivers / bluetooth / hci_bcm.c
1 /*
2  *
3  *  Bluetooth HCI UART driver for Broadcom devices
4  *
5  *  Copyright (C) 2015  Intel Corporation
6  *
7  *
8  *  This program is free software; you can redistribute it and/or modify
9  *  it under the terms of the GNU General Public License as published by
10  *  the Free Software Foundation; either version 2 of the License, or
11  *  (at your option) any later version.
12  *
13  *  This program is distributed in the hope that it will be useful,
14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  *  GNU General Public License for more details.
17  *
18  *  You should have received a copy of the GNU General Public License
19  *  along with this program; if not, write to the Free Software
20  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  *
22  */
23
24 #include <linux/kernel.h>
25 #include <linux/errno.h>
26 #include <linux/skbuff.h>
27 #include <linux/firmware.h>
28 #include <linux/module.h>
29 #include <linux/acpi.h>
30 #include <linux/of.h>
31 #include <linux/property.h>
32 #include <linux/platform_data/x86/apple.h>
33 #include <linux/platform_device.h>
34 #include <linux/clk.h>
35 #include <linux/gpio/consumer.h>
36 #include <linux/tty.h>
37 #include <linux/interrupt.h>
38 #include <linux/dmi.h>
39 #include <linux/pm_runtime.h>
40 #include <linux/serdev.h>
41
42 #include <net/bluetooth/bluetooth.h>
43 #include <net/bluetooth/hci_core.h>
44
45 #include "btbcm.h"
46 #include "hci_uart.h"
47
48 #define BCM_NULL_PKT 0x00
49 #define BCM_NULL_SIZE 0
50
51 #define BCM_LM_DIAG_PKT 0x07
52 #define BCM_LM_DIAG_SIZE 63
53
54 #define BCM_AUTOSUSPEND_DELAY   5000 /* default autosleep delay */
55
56 /**
57  * struct bcm_device - device driver resources
58  * @serdev_hu: HCI UART controller struct
59  * @list: bcm_device_list node
60  * @dev: physical UART slave
61  * @name: device name logged by bt_dev_*() functions
62  * @device_wakeup: BT_WAKE pin,
63  *      assert = Bluetooth device must wake up or remain awake,
64  *      deassert = Bluetooth device may sleep when sleep criteria are met
65  * @shutdown: BT_REG_ON pin,
66  *      power up or power down Bluetooth device internal regulators
67  * @set_device_wakeup: callback to toggle BT_WAKE pin
68  *      either by accessing @device_wakeup or by calling @btlp
69  * @set_shutdown: callback to toggle BT_REG_ON pin
70  *      either by accessing @shutdown or by calling @btpu/@btpd
71  * @btlp: Apple ACPI method to toggle BT_WAKE pin ("Bluetooth Low Power")
72  * @btpu: Apple ACPI method to drive BT_REG_ON pin high ("Bluetooth Power Up")
73  * @btpd: Apple ACPI method to drive BT_REG_ON pin low ("Bluetooth Power Down")
74  * @clk: clock used by Bluetooth device
75  * @clk_enabled: whether @clk is prepared and enabled
76  * @init_speed: default baudrate of Bluetooth device;
77  *      the host UART is initially set to this baudrate so that
78  *      it can configure the Bluetooth device for @oper_speed
79  * @oper_speed: preferred baudrate of Bluetooth device;
80  *      set to 0 if @init_speed is already the preferred baudrate
81  * @irq: interrupt triggered by HOST_WAKE_BT pin
82  * @irq_active_low: whether @irq is active low
83  * @hu: pointer to HCI UART controller struct,
84  *      used to disable flow control during runtime suspend and system sleep
85  * @is_suspended: whether flow control is currently disabled
86  */
87 struct bcm_device {
88         /* Must be the first member, hci_serdev.c expects this. */
89         struct hci_uart         serdev_hu;
90         struct list_head        list;
91
92         struct device           *dev;
93
94         const char              *name;
95         struct gpio_desc        *device_wakeup;
96         struct gpio_desc        *shutdown;
97         int                     (*set_device_wakeup)(struct bcm_device *, bool);
98         int                     (*set_shutdown)(struct bcm_device *, bool);
99 #ifdef CONFIG_ACPI
100         acpi_handle             btlp, btpu, btpd;
101         int                     gpio_count;
102         int                     gpio_int_idx;
103 #endif
104
105         struct clk              *clk;
106         bool                    clk_enabled;
107
108         u32                     init_speed;
109         u32                     oper_speed;
110         int                     irq;
111         bool                    irq_active_low;
112
113 #ifdef CONFIG_PM
114         struct hci_uart         *hu;
115         bool                    is_suspended;
116 #endif
117 };
118
119 /* generic bcm uart resources */
120 struct bcm_data {
121         struct sk_buff          *rx_skb;
122         struct sk_buff_head     txq;
123
124         struct bcm_device       *dev;
125 };
126
127 /* List of BCM BT UART devices */
128 static DEFINE_MUTEX(bcm_device_lock);
129 static LIST_HEAD(bcm_device_list);
130
131 static int irq_polarity = -1;
132 module_param(irq_polarity, int, 0444);
133 MODULE_PARM_DESC(irq_polarity, "IRQ polarity 0: active-high 1: active-low");
134
135 static inline void host_set_baudrate(struct hci_uart *hu, unsigned int speed)
136 {
137         if (hu->serdev)
138                 serdev_device_set_baudrate(hu->serdev, speed);
139         else
140                 hci_uart_set_baudrate(hu, speed);
141 }
142
143 static int bcm_set_baudrate(struct hci_uart *hu, unsigned int speed)
144 {
145         struct hci_dev *hdev = hu->hdev;
146         struct sk_buff *skb;
147         struct bcm_update_uart_baud_rate param;
148
149         if (speed > 3000000) {
150                 struct bcm_write_uart_clock_setting clock;
151
152                 clock.type = BCM_UART_CLOCK_48MHZ;
153
154                 bt_dev_dbg(hdev, "Set Controller clock (%d)", clock.type);
155
156                 /* This Broadcom specific command changes the UART's controller
157                  * clock for baud rate > 3000000.
158                  */
159                 skb = __hci_cmd_sync(hdev, 0xfc45, 1, &clock, HCI_INIT_TIMEOUT);
160                 if (IS_ERR(skb)) {
161                         int err = PTR_ERR(skb);
162                         bt_dev_err(hdev, "BCM: failed to write clock (%d)",
163                                    err);
164                         return err;
165                 }
166
167                 kfree_skb(skb);
168         }
169
170         bt_dev_dbg(hdev, "Set Controller UART speed to %d bit/s", speed);
171
172         param.zero = cpu_to_le16(0);
173         param.baud_rate = cpu_to_le32(speed);
174
175         /* This Broadcom specific command changes the UART's controller baud
176          * rate.
177          */
178         skb = __hci_cmd_sync(hdev, 0xfc18, sizeof(param), &param,
179                              HCI_INIT_TIMEOUT);
180         if (IS_ERR(skb)) {
181                 int err = PTR_ERR(skb);
182                 bt_dev_err(hdev, "BCM: failed to write update baudrate (%d)",
183                            err);
184                 return err;
185         }
186
187         kfree_skb(skb);
188
189         return 0;
190 }
191
192 /* bcm_device_exists should be protected by bcm_device_lock */
193 static bool bcm_device_exists(struct bcm_device *device)
194 {
195         struct list_head *p;
196
197 #ifdef CONFIG_PM
198         /* Devices using serdev always exist */
199         if (device && device->hu && device->hu->serdev)
200                 return true;
201 #endif
202
203         list_for_each(p, &bcm_device_list) {
204                 struct bcm_device *dev = list_entry(p, struct bcm_device, list);
205
206                 if (device == dev)
207                         return true;
208         }
209
210         return false;
211 }
212
213 static int bcm_gpio_set_power(struct bcm_device *dev, bool powered)
214 {
215         int err;
216
217         if (powered && !IS_ERR(dev->clk) && !dev->clk_enabled) {
218                 err = clk_prepare_enable(dev->clk);
219                 if (err)
220                         return err;
221         }
222
223         err = dev->set_shutdown(dev, powered);
224         if (err)
225                 goto err_clk_disable;
226
227         err = dev->set_device_wakeup(dev, powered);
228         if (err)
229                 goto err_revert_shutdown;
230
231         if (!powered && !IS_ERR(dev->clk) && dev->clk_enabled)
232                 clk_disable_unprepare(dev->clk);
233
234         dev->clk_enabled = powered;
235
236         return 0;
237
238 err_revert_shutdown:
239         dev->set_shutdown(dev, !powered);
240 err_clk_disable:
241         if (powered && !IS_ERR(dev->clk) && !dev->clk_enabled)
242                 clk_disable_unprepare(dev->clk);
243         return err;
244 }
245
246 #ifdef CONFIG_PM
247 static irqreturn_t bcm_host_wake(int irq, void *data)
248 {
249         struct bcm_device *bdev = data;
250
251         bt_dev_dbg(bdev, "Host wake IRQ");
252
253         pm_runtime_get(bdev->dev);
254         pm_runtime_mark_last_busy(bdev->dev);
255         pm_runtime_put_autosuspend(bdev->dev);
256
257         return IRQ_HANDLED;
258 }
259
260 static int bcm_request_irq(struct bcm_data *bcm)
261 {
262         struct bcm_device *bdev = bcm->dev;
263         int err;
264
265         mutex_lock(&bcm_device_lock);
266         if (!bcm_device_exists(bdev)) {
267                 err = -ENODEV;
268                 goto unlock;
269         }
270
271         if (bdev->irq <= 0) {
272                 err = -EOPNOTSUPP;
273                 goto unlock;
274         }
275
276         err = devm_request_irq(bdev->dev, bdev->irq, bcm_host_wake,
277                                bdev->irq_active_low ? IRQF_TRIGGER_FALLING :
278                                                       IRQF_TRIGGER_RISING,
279                                "host_wake", bdev);
280         if (err) {
281                 bdev->irq = err;
282                 goto unlock;
283         }
284
285         device_init_wakeup(bdev->dev, true);
286
287         pm_runtime_set_autosuspend_delay(bdev->dev,
288                                          BCM_AUTOSUSPEND_DELAY);
289         pm_runtime_use_autosuspend(bdev->dev);
290         pm_runtime_set_active(bdev->dev);
291         pm_runtime_enable(bdev->dev);
292
293 unlock:
294         mutex_unlock(&bcm_device_lock);
295
296         return err;
297 }
298
299 static const struct bcm_set_sleep_mode default_sleep_params = {
300         .sleep_mode = 1,        /* 0=Disabled, 1=UART, 2=Reserved, 3=USB */
301         .idle_host = 2,         /* idle threshold HOST, in 300ms */
302         .idle_dev = 2,          /* idle threshold device, in 300ms */
303         .bt_wake_active = 1,    /* BT_WAKE active mode: 1 = high, 0 = low */
304         .host_wake_active = 0,  /* HOST_WAKE active mode: 1 = high, 0 = low */
305         .allow_host_sleep = 1,  /* Allow host sleep in SCO flag */
306         .combine_modes = 1,     /* Combine sleep and LPM flag */
307         .tristate_control = 0,  /* Allow tri-state control of UART tx flag */
308         /* Irrelevant USB flags */
309         .usb_auto_sleep = 0,
310         .usb_resume_timeout = 0,
311         .break_to_host = 0,
312         .pulsed_host_wake = 1,
313 };
314
315 static int bcm_setup_sleep(struct hci_uart *hu)
316 {
317         struct bcm_data *bcm = hu->priv;
318         struct sk_buff *skb;
319         struct bcm_set_sleep_mode sleep_params = default_sleep_params;
320
321         sleep_params.host_wake_active = !bcm->dev->irq_active_low;
322
323         skb = __hci_cmd_sync(hu->hdev, 0xfc27, sizeof(sleep_params),
324                              &sleep_params, HCI_INIT_TIMEOUT);
325         if (IS_ERR(skb)) {
326                 int err = PTR_ERR(skb);
327                 bt_dev_err(hu->hdev, "Sleep VSC failed (%d)", err);
328                 return err;
329         }
330         kfree_skb(skb);
331
332         bt_dev_dbg(hu->hdev, "Set Sleep Parameters VSC succeeded");
333
334         return 0;
335 }
336 #else
337 static inline int bcm_request_irq(struct bcm_data *bcm) { return 0; }
338 static inline int bcm_setup_sleep(struct hci_uart *hu) { return 0; }
339 #endif
340
341 static int bcm_set_diag(struct hci_dev *hdev, bool enable)
342 {
343         struct hci_uart *hu = hci_get_drvdata(hdev);
344         struct bcm_data *bcm = hu->priv;
345         struct sk_buff *skb;
346
347         if (!test_bit(HCI_RUNNING, &hdev->flags))
348                 return -ENETDOWN;
349
350         skb = bt_skb_alloc(3, GFP_KERNEL);
351         if (!skb)
352                 return -ENOMEM;
353
354         skb_put_u8(skb, BCM_LM_DIAG_PKT);
355         skb_put_u8(skb, 0xf0);
356         skb_put_u8(skb, enable);
357
358         skb_queue_tail(&bcm->txq, skb);
359         hci_uart_tx_wakeup(hu);
360
361         return 0;
362 }
363
364 static int bcm_open(struct hci_uart *hu)
365 {
366         struct bcm_data *bcm;
367         struct list_head *p;
368         int err;
369
370         bt_dev_dbg(hu->hdev, "hu %p", hu);
371
372         if (!hci_uart_has_flow_control(hu))
373                 return -EOPNOTSUPP;
374
375         bcm = kzalloc(sizeof(*bcm), GFP_KERNEL);
376         if (!bcm)
377                 return -ENOMEM;
378
379         skb_queue_head_init(&bcm->txq);
380
381         hu->priv = bcm;
382
383         mutex_lock(&bcm_device_lock);
384
385         if (hu->serdev) {
386                 bcm->dev = serdev_device_get_drvdata(hu->serdev);
387                 goto out;
388         }
389
390         if (!hu->tty->dev)
391                 goto out;
392
393         list_for_each(p, &bcm_device_list) {
394                 struct bcm_device *dev = list_entry(p, struct bcm_device, list);
395
396                 /* Retrieve saved bcm_device based on parent of the
397                  * platform device (saved during device probe) and
398                  * parent of tty device used by hci_uart
399                  */
400                 if (hu->tty->dev->parent == dev->dev->parent) {
401                         bcm->dev = dev;
402 #ifdef CONFIG_PM
403                         dev->hu = hu;
404 #endif
405                         break;
406                 }
407         }
408
409 out:
410         if (bcm->dev) {
411                 hu->init_speed = bcm->dev->init_speed;
412                 hu->oper_speed = bcm->dev->oper_speed;
413                 err = bcm_gpio_set_power(bcm->dev, true);
414                 if (err)
415                         goto err_unset_hu;
416         }
417
418         mutex_unlock(&bcm_device_lock);
419         return 0;
420
421 err_unset_hu:
422 #ifdef CONFIG_PM
423         if (!hu->serdev)
424                 bcm->dev->hu = NULL;
425 #endif
426         mutex_unlock(&bcm_device_lock);
427         hu->priv = NULL;
428         kfree(bcm);
429         return err;
430 }
431
432 static int bcm_close(struct hci_uart *hu)
433 {
434         struct bcm_data *bcm = hu->priv;
435         struct bcm_device *bdev = NULL;
436         int err;
437
438         bt_dev_dbg(hu->hdev, "hu %p", hu);
439
440         /* Protect bcm->dev against removal of the device or driver */
441         mutex_lock(&bcm_device_lock);
442
443         if (hu->serdev) {
444                 bdev = serdev_device_get_drvdata(hu->serdev);
445         } else if (bcm_device_exists(bcm->dev)) {
446                 bdev = bcm->dev;
447 #ifdef CONFIG_PM
448                 bdev->hu = NULL;
449 #endif
450         }
451
452         if (bdev) {
453                 if (IS_ENABLED(CONFIG_PM) && bdev->irq > 0) {
454                         devm_free_irq(bdev->dev, bdev->irq, bdev);
455                         device_init_wakeup(bdev->dev, false);
456                         pm_runtime_disable(bdev->dev);
457                 }
458
459                 err = bcm_gpio_set_power(bdev, false);
460                 if (err)
461                         bt_dev_err(hu->hdev, "Failed to power down");
462                 else
463                         pm_runtime_set_suspended(bdev->dev);
464         }
465         mutex_unlock(&bcm_device_lock);
466
467         skb_queue_purge(&bcm->txq);
468         kfree_skb(bcm->rx_skb);
469         kfree(bcm);
470
471         hu->priv = NULL;
472         return 0;
473 }
474
475 static int bcm_flush(struct hci_uart *hu)
476 {
477         struct bcm_data *bcm = hu->priv;
478
479         bt_dev_dbg(hu->hdev, "hu %p", hu);
480
481         skb_queue_purge(&bcm->txq);
482
483         return 0;
484 }
485
486 static int bcm_setup(struct hci_uart *hu)
487 {
488         struct bcm_data *bcm = hu->priv;
489         char fw_name[64];
490         const struct firmware *fw;
491         unsigned int speed;
492         int err;
493
494         bt_dev_dbg(hu->hdev, "hu %p", hu);
495
496         hu->hdev->set_diag = bcm_set_diag;
497         hu->hdev->set_bdaddr = btbcm_set_bdaddr;
498
499         err = btbcm_initialize(hu->hdev, fw_name, sizeof(fw_name), false);
500         if (err)
501                 return err;
502
503         err = request_firmware(&fw, fw_name, &hu->hdev->dev);
504         if (err < 0) {
505                 bt_dev_info(hu->hdev, "BCM: Patch %s not found", fw_name);
506                 return 0;
507         }
508
509         err = btbcm_patchram(hu->hdev, fw);
510         if (err) {
511                 bt_dev_info(hu->hdev, "BCM: Patch failed (%d)", err);
512                 goto finalize;
513         }
514
515         /* Init speed if any */
516         if (hu->init_speed)
517                 speed = hu->init_speed;
518         else if (hu->proto->init_speed)
519                 speed = hu->proto->init_speed;
520         else
521                 speed = 0;
522
523         if (speed)
524                 host_set_baudrate(hu, speed);
525
526         /* Operational speed if any */
527         if (hu->oper_speed)
528                 speed = hu->oper_speed;
529         else if (hu->proto->oper_speed)
530                 speed = hu->proto->oper_speed;
531         else
532                 speed = 0;
533
534         if (speed) {
535                 err = bcm_set_baudrate(hu, speed);
536                 if (!err)
537                         host_set_baudrate(hu, speed);
538         }
539
540 finalize:
541         release_firmware(fw);
542
543         err = btbcm_finalize(hu->hdev);
544         if (err)
545                 return err;
546
547         if (!bcm_request_irq(bcm))
548                 err = bcm_setup_sleep(hu);
549
550         return err;
551 }
552
553 #define BCM_RECV_LM_DIAG \
554         .type = BCM_LM_DIAG_PKT, \
555         .hlen = BCM_LM_DIAG_SIZE, \
556         .loff = 0, \
557         .lsize = 0, \
558         .maxlen = BCM_LM_DIAG_SIZE
559
560 #define BCM_RECV_NULL \
561         .type = BCM_NULL_PKT, \
562         .hlen = BCM_NULL_SIZE, \
563         .loff = 0, \
564         .lsize = 0, \
565         .maxlen = BCM_NULL_SIZE
566
567 static const struct h4_recv_pkt bcm_recv_pkts[] = {
568         { H4_RECV_ACL,      .recv = hci_recv_frame },
569         { H4_RECV_SCO,      .recv = hci_recv_frame },
570         { H4_RECV_EVENT,    .recv = hci_recv_frame },
571         { BCM_RECV_LM_DIAG, .recv = hci_recv_diag  },
572         { BCM_RECV_NULL,    .recv = hci_recv_diag  },
573 };
574
575 static int bcm_recv(struct hci_uart *hu, const void *data, int count)
576 {
577         struct bcm_data *bcm = hu->priv;
578
579         if (!test_bit(HCI_UART_REGISTERED, &hu->flags))
580                 return -EUNATCH;
581
582         bcm->rx_skb = h4_recv_buf(hu->hdev, bcm->rx_skb, data, count,
583                                   bcm_recv_pkts, ARRAY_SIZE(bcm_recv_pkts));
584         if (IS_ERR(bcm->rx_skb)) {
585                 int err = PTR_ERR(bcm->rx_skb);
586                 bt_dev_err(hu->hdev, "Frame reassembly failed (%d)", err);
587                 bcm->rx_skb = NULL;
588                 return err;
589         } else if (!bcm->rx_skb) {
590                 /* Delay auto-suspend when receiving completed packet */
591                 mutex_lock(&bcm_device_lock);
592                 if (bcm->dev && bcm_device_exists(bcm->dev)) {
593                         pm_runtime_get(bcm->dev->dev);
594                         pm_runtime_mark_last_busy(bcm->dev->dev);
595                         pm_runtime_put_autosuspend(bcm->dev->dev);
596                 }
597                 mutex_unlock(&bcm_device_lock);
598         }
599
600         return count;
601 }
602
603 static int bcm_enqueue(struct hci_uart *hu, struct sk_buff *skb)
604 {
605         struct bcm_data *bcm = hu->priv;
606
607         bt_dev_dbg(hu->hdev, "hu %p skb %p", hu, skb);
608
609         /* Prepend skb with frame type */
610         memcpy(skb_push(skb, 1), &hci_skb_pkt_type(skb), 1);
611         skb_queue_tail(&bcm->txq, skb);
612
613         return 0;
614 }
615
616 static struct sk_buff *bcm_dequeue(struct hci_uart *hu)
617 {
618         struct bcm_data *bcm = hu->priv;
619         struct sk_buff *skb = NULL;
620         struct bcm_device *bdev = NULL;
621
622         mutex_lock(&bcm_device_lock);
623
624         if (bcm_device_exists(bcm->dev)) {
625                 bdev = bcm->dev;
626                 pm_runtime_get_sync(bdev->dev);
627                 /* Shall be resumed here */
628         }
629
630         skb = skb_dequeue(&bcm->txq);
631
632         if (bdev) {
633                 pm_runtime_mark_last_busy(bdev->dev);
634                 pm_runtime_put_autosuspend(bdev->dev);
635         }
636
637         mutex_unlock(&bcm_device_lock);
638
639         return skb;
640 }
641
642 #ifdef CONFIG_PM
643 static int bcm_suspend_device(struct device *dev)
644 {
645         struct bcm_device *bdev = dev_get_drvdata(dev);
646         int err;
647
648         bt_dev_dbg(bdev, "");
649
650         if (!bdev->is_suspended && bdev->hu) {
651                 hci_uart_set_flow_control(bdev->hu, true);
652
653                 /* Once this returns, driver suspends BT via GPIO */
654                 bdev->is_suspended = true;
655         }
656
657         /* Suspend the device */
658         err = bdev->set_device_wakeup(bdev, false);
659         if (err) {
660                 if (bdev->is_suspended && bdev->hu) {
661                         bdev->is_suspended = false;
662                         hci_uart_set_flow_control(bdev->hu, false);
663                 }
664                 return -EBUSY;
665         }
666
667         bt_dev_dbg(bdev, "suspend, delaying 15 ms");
668         msleep(15);
669
670         return 0;
671 }
672
673 static int bcm_resume_device(struct device *dev)
674 {
675         struct bcm_device *bdev = dev_get_drvdata(dev);
676         int err;
677
678         bt_dev_dbg(bdev, "");
679
680         err = bdev->set_device_wakeup(bdev, true);
681         if (err) {
682                 dev_err(dev, "Failed to power up\n");
683                 return err;
684         }
685
686         bt_dev_dbg(bdev, "resume, delaying 15 ms");
687         msleep(15);
688
689         /* When this executes, the device has woken up already */
690         if (bdev->is_suspended && bdev->hu) {
691                 bdev->is_suspended = false;
692
693                 hci_uart_set_flow_control(bdev->hu, false);
694         }
695
696         return 0;
697 }
698 #endif
699
700 #ifdef CONFIG_PM_SLEEP
701 /* suspend callback */
702 static int bcm_suspend(struct device *dev)
703 {
704         struct bcm_device *bdev = dev_get_drvdata(dev);
705         int error;
706
707         bt_dev_dbg(bdev, "suspend: is_suspended %d", bdev->is_suspended);
708
709         /*
710          * When used with a device instantiated as platform_device, bcm_suspend
711          * can be called at any time as long as the platform device is bound,
712          * so it should use bcm_device_lock to protect access to hci_uart
713          * and device_wake-up GPIO.
714          */
715         mutex_lock(&bcm_device_lock);
716
717         if (!bdev->hu)
718                 goto unlock;
719
720         if (pm_runtime_active(dev))
721                 bcm_suspend_device(dev);
722
723         if (device_may_wakeup(dev) && bdev->irq > 0) {
724                 error = enable_irq_wake(bdev->irq);
725                 if (!error)
726                         bt_dev_dbg(bdev, "BCM irq: enabled");
727         }
728
729 unlock:
730         mutex_unlock(&bcm_device_lock);
731
732         return 0;
733 }
734
735 /* resume callback */
736 static int bcm_resume(struct device *dev)
737 {
738         struct bcm_device *bdev = dev_get_drvdata(dev);
739         int err = 0;
740
741         bt_dev_dbg(bdev, "resume: is_suspended %d", bdev->is_suspended);
742
743         /*
744          * When used with a device instantiated as platform_device, bcm_resume
745          * can be called at any time as long as platform device is bound,
746          * so it should use bcm_device_lock to protect access to hci_uart
747          * and device_wake-up GPIO.
748          */
749         mutex_lock(&bcm_device_lock);
750
751         if (!bdev->hu)
752                 goto unlock;
753
754         if (device_may_wakeup(dev) && bdev->irq > 0) {
755                 disable_irq_wake(bdev->irq);
756                 bt_dev_dbg(bdev, "BCM irq: disabled");
757         }
758
759         err = bcm_resume_device(dev);
760
761 unlock:
762         mutex_unlock(&bcm_device_lock);
763
764         if (!err) {
765                 pm_runtime_disable(dev);
766                 pm_runtime_set_active(dev);
767                 pm_runtime_enable(dev);
768         }
769
770         return 0;
771 }
772 #endif
773
774 static const struct acpi_gpio_params first_gpio = { 0, 0, false };
775 static const struct acpi_gpio_params second_gpio = { 1, 0, false };
776 static const struct acpi_gpio_params third_gpio = { 2, 0, false };
777
778 static const struct acpi_gpio_mapping acpi_bcm_int_last_gpios[] = {
779         { "device-wakeup-gpios", &first_gpio, 1 },
780         { "shutdown-gpios", &second_gpio, 1 },
781         { "host-wakeup-gpios", &third_gpio, 1 },
782         { },
783 };
784
785 static const struct acpi_gpio_mapping acpi_bcm_int_first_gpios[] = {
786         { "host-wakeup-gpios", &first_gpio, 1 },
787         { "device-wakeup-gpios", &second_gpio, 1 },
788         { "shutdown-gpios", &third_gpio, 1 },
789         { },
790 };
791
792 /* Some firmware reports an IRQ which does not work (wrong pin in fw table?) */
793 static const struct dmi_system_id bcm_broken_irq_dmi_table[] = {
794         {
795                 .ident = "Meegopad T08",
796                 .matches = {
797                         DMI_EXACT_MATCH(DMI_BOARD_VENDOR,
798                                         "To be filled by OEM."),
799                         DMI_EXACT_MATCH(DMI_BOARD_NAME, "T3 MRD"),
800                         DMI_EXACT_MATCH(DMI_BOARD_VERSION, "V1.1"),
801                 },
802         },
803         { }
804 };
805
806 #ifdef CONFIG_ACPI
807 static int bcm_resource(struct acpi_resource *ares, void *data)
808 {
809         struct bcm_device *dev = data;
810         struct acpi_resource_extended_irq *irq;
811         struct acpi_resource_gpio *gpio;
812         struct acpi_resource_uart_serialbus *sb;
813
814         switch (ares->type) {
815         case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
816                 irq = &ares->data.extended_irq;
817                 if (irq->polarity != ACPI_ACTIVE_LOW)
818                         dev_info(dev->dev, "ACPI Interrupt resource is active-high, this is usually wrong, treating the IRQ as active-low\n");
819                 dev->irq_active_low = true;
820                 break;
821
822         case ACPI_RESOURCE_TYPE_GPIO:
823                 gpio = &ares->data.gpio;
824                 if (gpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT) {
825                         dev->gpio_int_idx = dev->gpio_count;
826                         dev->irq_active_low = gpio->polarity == ACPI_ACTIVE_LOW;
827                 }
828                 dev->gpio_count++;
829                 break;
830
831         case ACPI_RESOURCE_TYPE_SERIAL_BUS:
832                 sb = &ares->data.uart_serial_bus;
833                 if (sb->type == ACPI_RESOURCE_SERIAL_TYPE_UART) {
834                         dev->init_speed = sb->default_baud_rate;
835                         dev->oper_speed = 4000000;
836                 }
837                 break;
838
839         default:
840                 break;
841         }
842
843         return 0;
844 }
845
846 static int bcm_apple_set_device_wakeup(struct bcm_device *dev, bool awake)
847 {
848         if (ACPI_FAILURE(acpi_execute_simple_method(dev->btlp, NULL, !awake)))
849                 return -EIO;
850
851         return 0;
852 }
853
854 static int bcm_apple_set_shutdown(struct bcm_device *dev, bool powered)
855 {
856         if (ACPI_FAILURE(acpi_evaluate_object(powered ? dev->btpu : dev->btpd,
857                                               NULL, NULL, NULL)))
858                 return -EIO;
859
860         return 0;
861 }
862
863 static int bcm_apple_get_resources(struct bcm_device *dev)
864 {
865         struct acpi_device *adev = ACPI_COMPANION(dev->dev);
866         const union acpi_object *obj;
867
868         if (!adev ||
869             ACPI_FAILURE(acpi_get_handle(adev->handle, "BTLP", &dev->btlp)) ||
870             ACPI_FAILURE(acpi_get_handle(adev->handle, "BTPU", &dev->btpu)) ||
871             ACPI_FAILURE(acpi_get_handle(adev->handle, "BTPD", &dev->btpd)))
872                 return -ENODEV;
873
874         if (!acpi_dev_get_property(adev, "baud", ACPI_TYPE_BUFFER, &obj) &&
875             obj->buffer.length == 8)
876                 dev->init_speed = *(u64 *)obj->buffer.pointer;
877
878         dev->set_device_wakeup = bcm_apple_set_device_wakeup;
879         dev->set_shutdown = bcm_apple_set_shutdown;
880
881         return 0;
882 }
883 #else
884 static inline int bcm_apple_get_resources(struct bcm_device *dev)
885 {
886         return -EOPNOTSUPP;
887 }
888 #endif /* CONFIG_ACPI */
889
890 static int bcm_gpio_set_device_wakeup(struct bcm_device *dev, bool awake)
891 {
892         gpiod_set_value_cansleep(dev->device_wakeup, awake);
893         return 0;
894 }
895
896 static int bcm_gpio_set_shutdown(struct bcm_device *dev, bool powered)
897 {
898         gpiod_set_value_cansleep(dev->shutdown, powered);
899         return 0;
900 }
901
902 static int bcm_get_resources(struct bcm_device *dev)
903 {
904         const struct dmi_system_id *dmi_id;
905
906         dev->name = dev_name(dev->dev);
907
908         if (x86_apple_machine && !bcm_apple_get_resources(dev))
909                 return 0;
910
911         dev->clk = devm_clk_get(dev->dev, NULL);
912
913         /* Handle deferred probing */
914         if (dev->clk == ERR_PTR(-EPROBE_DEFER))
915                 return PTR_ERR(dev->clk);
916
917         dev->device_wakeup = devm_gpiod_get_optional(dev->dev, "device-wakeup",
918                                                      GPIOD_OUT_LOW);
919         if (IS_ERR(dev->device_wakeup))
920                 return PTR_ERR(dev->device_wakeup);
921
922         dev->shutdown = devm_gpiod_get_optional(dev->dev, "shutdown",
923                                                 GPIOD_OUT_LOW);
924         if (IS_ERR(dev->shutdown))
925                 return PTR_ERR(dev->shutdown);
926
927         dev->set_device_wakeup = bcm_gpio_set_device_wakeup;
928         dev->set_shutdown = bcm_gpio_set_shutdown;
929
930         /* IRQ can be declared in ACPI table as Interrupt or GpioInt */
931         if (dev->irq <= 0) {
932                 struct gpio_desc *gpio;
933
934                 gpio = devm_gpiod_get_optional(dev->dev, "host-wakeup",
935                                                GPIOD_IN);
936                 if (IS_ERR(gpio))
937                         return PTR_ERR(gpio);
938
939                 dev->irq = gpiod_to_irq(gpio);
940         }
941
942         dmi_id = dmi_first_match(bcm_broken_irq_dmi_table);
943         if (dmi_id) {
944                 dev_info(dev->dev, "%s: Has a broken IRQ config, disabling IRQ support / runtime-pm\n",
945                          dmi_id->ident);
946                 dev->irq = 0;
947         }
948
949         dev_dbg(dev->dev, "BCM irq: %d\n", dev->irq);
950         return 0;
951 }
952
953 #ifdef CONFIG_ACPI
954 static int bcm_acpi_probe(struct bcm_device *dev)
955 {
956         LIST_HEAD(resources);
957         const struct acpi_gpio_mapping *gpio_mapping = acpi_bcm_int_last_gpios;
958         struct resource_entry *entry;
959         int ret;
960
961         /* Retrieve UART ACPI info */
962         dev->gpio_int_idx = -1;
963         ret = acpi_dev_get_resources(ACPI_COMPANION(dev->dev),
964                                      &resources, bcm_resource, dev);
965         if (ret < 0)
966                 return ret;
967
968         resource_list_for_each_entry(entry, &resources) {
969                 if (resource_type(entry->res) == IORESOURCE_IRQ) {
970                         dev->irq = entry->res->start;
971                         break;
972                 }
973         }
974         acpi_dev_free_resource_list(&resources);
975
976         /* If the DSDT uses an Interrupt resource for the IRQ, then there are
977          * only 2 GPIO resources, we use the irq-last mapping for this, since
978          * we already have an irq the 3th / last mapping will not be used.
979          */
980         if (dev->irq)
981                 gpio_mapping = acpi_bcm_int_last_gpios;
982         else if (dev->gpio_int_idx == 0)
983                 gpio_mapping = acpi_bcm_int_first_gpios;
984         else if (dev->gpio_int_idx == 2)
985                 gpio_mapping = acpi_bcm_int_last_gpios;
986         else
987                 dev_warn(dev->dev, "Unexpected ACPI gpio_int_idx: %d\n",
988                          dev->gpio_int_idx);
989
990         /* Warn if our expectations are not met. */
991         if (dev->gpio_count != (dev->irq ? 2 : 3))
992                 dev_warn(dev->dev, "Unexpected number of ACPI GPIOs: %d\n",
993                          dev->gpio_count);
994
995         ret = devm_acpi_dev_add_driver_gpios(dev->dev, gpio_mapping);
996         if (ret)
997                 return ret;
998
999         if (irq_polarity != -1) {
1000                 dev->irq_active_low = irq_polarity;
1001                 dev_warn(dev->dev, "Overwriting IRQ polarity to active %s by module-param\n",
1002                          dev->irq_active_low ? "low" : "high");
1003         }
1004
1005         return 0;
1006 }
1007 #else
1008 static int bcm_acpi_probe(struct bcm_device *dev)
1009 {
1010         return -EINVAL;
1011 }
1012 #endif /* CONFIG_ACPI */
1013
1014 static int bcm_of_probe(struct bcm_device *bdev)
1015 {
1016         device_property_read_u32(bdev->dev, "max-speed", &bdev->oper_speed);
1017         return 0;
1018 }
1019
1020 static int bcm_probe(struct platform_device *pdev)
1021 {
1022         struct bcm_device *dev;
1023         int ret;
1024
1025         dev = devm_kzalloc(&pdev->dev, sizeof(*dev), GFP_KERNEL);
1026         if (!dev)
1027                 return -ENOMEM;
1028
1029         dev->dev = &pdev->dev;
1030         dev->irq = platform_get_irq(pdev, 0);
1031
1032         if (has_acpi_companion(&pdev->dev)) {
1033                 ret = bcm_acpi_probe(dev);
1034                 if (ret)
1035                         return ret;
1036         }
1037
1038         ret = bcm_get_resources(dev);
1039         if (ret)
1040                 return ret;
1041
1042         platform_set_drvdata(pdev, dev);
1043
1044         dev_info(&pdev->dev, "%s device registered.\n", dev->name);
1045
1046         /* Place this instance on the device list */
1047         mutex_lock(&bcm_device_lock);
1048         list_add_tail(&dev->list, &bcm_device_list);
1049         mutex_unlock(&bcm_device_lock);
1050
1051         ret = bcm_gpio_set_power(dev, false);
1052         if (ret)
1053                 dev_err(&pdev->dev, "Failed to power down\n");
1054
1055         return 0;
1056 }
1057
1058 static int bcm_remove(struct platform_device *pdev)
1059 {
1060         struct bcm_device *dev = platform_get_drvdata(pdev);
1061
1062         mutex_lock(&bcm_device_lock);
1063         list_del(&dev->list);
1064         mutex_unlock(&bcm_device_lock);
1065
1066         dev_info(&pdev->dev, "%s device unregistered.\n", dev->name);
1067
1068         return 0;
1069 }
1070
1071 static const struct hci_uart_proto bcm_proto = {
1072         .id             = HCI_UART_BCM,
1073         .name           = "Broadcom",
1074         .manufacturer   = 15,
1075         .init_speed     = 115200,
1076 #ifdef TIZEN_BT
1077         .oper_speed     = 460800,
1078 #endif
1079         .open           = bcm_open,
1080         .close          = bcm_close,
1081         .flush          = bcm_flush,
1082         .setup          = bcm_setup,
1083         .set_baudrate   = bcm_set_baudrate,
1084         .recv           = bcm_recv,
1085         .enqueue        = bcm_enqueue,
1086         .dequeue        = bcm_dequeue,
1087 };
1088
1089 #ifdef CONFIG_ACPI
1090 static const struct acpi_device_id bcm_acpi_match[] = {
1091         { "BCM2E00" },
1092         { "BCM2E01" },
1093         { "BCM2E02" },
1094         { "BCM2E03" },
1095         { "BCM2E04" },
1096         { "BCM2E05" },
1097         { "BCM2E06" },
1098         { "BCM2E07" },
1099         { "BCM2E08" },
1100         { "BCM2E09" },
1101         { "BCM2E0A" },
1102         { "BCM2E0B" },
1103         { "BCM2E0C" },
1104         { "BCM2E0D" },
1105         { "BCM2E0E" },
1106         { "BCM2E0F" },
1107         { "BCM2E10" },
1108         { "BCM2E11" },
1109         { "BCM2E12" },
1110         { "BCM2E13" },
1111         { "BCM2E14" },
1112         { "BCM2E15" },
1113         { "BCM2E16" },
1114         { "BCM2E17" },
1115         { "BCM2E18" },
1116         { "BCM2E19" },
1117         { "BCM2E1A" },
1118         { "BCM2E1B" },
1119         { "BCM2E1C" },
1120         { "BCM2E1D" },
1121         { "BCM2E1F" },
1122         { "BCM2E20" },
1123         { "BCM2E21" },
1124         { "BCM2E22" },
1125         { "BCM2E23" },
1126         { "BCM2E24" },
1127         { "BCM2E25" },
1128         { "BCM2E26" },
1129         { "BCM2E27" },
1130         { "BCM2E28" },
1131         { "BCM2E29" },
1132         { "BCM2E2A" },
1133         { "BCM2E2B" },
1134         { "BCM2E2C" },
1135         { "BCM2E2D" },
1136         { "BCM2E2E" },
1137         { "BCM2E2F" },
1138         { "BCM2E30" },
1139         { "BCM2E31" },
1140         { "BCM2E32" },
1141         { "BCM2E33" },
1142         { "BCM2E34" },
1143         { "BCM2E35" },
1144         { "BCM2E36" },
1145         { "BCM2E37" },
1146         { "BCM2E38" },
1147         { "BCM2E39" },
1148         { "BCM2E3A" },
1149         { "BCM2E3B" },
1150         { "BCM2E3C" },
1151         { "BCM2E3D" },
1152         { "BCM2E3E" },
1153         { "BCM2E3F" },
1154         { "BCM2E40" },
1155         { "BCM2E41" },
1156         { "BCM2E42" },
1157         { "BCM2E43" },
1158         { "BCM2E44" },
1159         { "BCM2E45" },
1160         { "BCM2E46" },
1161         { "BCM2E47" },
1162         { "BCM2E48" },
1163         { "BCM2E49" },
1164         { "BCM2E4A" },
1165         { "BCM2E4B" },
1166         { "BCM2E4C" },
1167         { "BCM2E4D" },
1168         { "BCM2E4E" },
1169         { "BCM2E4F" },
1170         { "BCM2E50" },
1171         { "BCM2E51" },
1172         { "BCM2E52" },
1173         { "BCM2E53" },
1174         { "BCM2E54" },
1175         { "BCM2E55" },
1176         { "BCM2E56" },
1177         { "BCM2E57" },
1178         { "BCM2E58" },
1179         { "BCM2E59" },
1180         { "BCM2E5A" },
1181         { "BCM2E5B" },
1182         { "BCM2E5C" },
1183         { "BCM2E5D" },
1184         { "BCM2E5E" },
1185         { "BCM2E5F" },
1186         { "BCM2E60" },
1187         { "BCM2E61" },
1188         { "BCM2E62" },
1189         { "BCM2E63" },
1190         { "BCM2E64" },
1191         { "BCM2E65" },
1192         { "BCM2E66" },
1193         { "BCM2E67" },
1194         { "BCM2E68" },
1195         { "BCM2E69" },
1196         { "BCM2E6B" },
1197         { "BCM2E6D" },
1198         { "BCM2E6E" },
1199         { "BCM2E6F" },
1200         { "BCM2E70" },
1201         { "BCM2E71" },
1202         { "BCM2E72" },
1203         { "BCM2E73" },
1204         { "BCM2E74" },
1205         { "BCM2E75" },
1206         { "BCM2E76" },
1207         { "BCM2E77" },
1208         { "BCM2E78" },
1209         { "BCM2E79" },
1210         { "BCM2E7A" },
1211         { "BCM2E7B" },
1212         { "BCM2E7C" },
1213         { "BCM2E7D" },
1214         { "BCM2E7E" },
1215         { "BCM2E7F" },
1216         { "BCM2E80" },
1217         { "BCM2E81" },
1218         { "BCM2E82" },
1219         { "BCM2E83" },
1220         { "BCM2E84" },
1221         { "BCM2E85" },
1222         { "BCM2E86" },
1223         { "BCM2E87" },
1224         { "BCM2E88" },
1225         { "BCM2E89" },
1226         { "BCM2E8A" },
1227         { "BCM2E8B" },
1228         { "BCM2E8C" },
1229         { "BCM2E8D" },
1230         { "BCM2E8E" },
1231         { "BCM2E90" },
1232         { "BCM2E92" },
1233         { "BCM2E93" },
1234         { "BCM2E94" },
1235         { "BCM2E95" },
1236         { "BCM2E96" },
1237         { "BCM2E97" },
1238         { "BCM2E98" },
1239         { "BCM2E99" },
1240         { "BCM2E9A" },
1241         { "BCM2E9B" },
1242         { "BCM2E9C" },
1243         { "BCM2E9D" },
1244         { "BCM2EA0" },
1245         { "BCM2EA1" },
1246         { "BCM2EA2" },
1247         { "BCM2EA3" },
1248         { "BCM2EA4" },
1249         { "BCM2EA5" },
1250         { "BCM2EA6" },
1251         { "BCM2EA7" },
1252         { "BCM2EA8" },
1253         { "BCM2EA9" },
1254         { "BCM2EAA" },
1255         { "BCM2EAB" },
1256         { "BCM2EAC" },
1257         { },
1258 };
1259 MODULE_DEVICE_TABLE(acpi, bcm_acpi_match);
1260 #endif
1261
1262 /* suspend and resume callbacks */
1263 static const struct dev_pm_ops bcm_pm_ops = {
1264         SET_SYSTEM_SLEEP_PM_OPS(bcm_suspend, bcm_resume)
1265         SET_RUNTIME_PM_OPS(bcm_suspend_device, bcm_resume_device, NULL)
1266 };
1267
1268 static struct platform_driver bcm_driver = {
1269         .probe = bcm_probe,
1270         .remove = bcm_remove,
1271         .driver = {
1272                 .name = "hci_bcm",
1273                 .acpi_match_table = ACPI_PTR(bcm_acpi_match),
1274                 .pm = &bcm_pm_ops,
1275         },
1276 };
1277
1278 static int bcm_serdev_probe(struct serdev_device *serdev)
1279 {
1280         struct bcm_device *bcmdev;
1281         int err;
1282
1283         bcmdev = devm_kzalloc(&serdev->dev, sizeof(*bcmdev), GFP_KERNEL);
1284         if (!bcmdev)
1285                 return -ENOMEM;
1286
1287         bcmdev->dev = &serdev->dev;
1288 #ifdef CONFIG_PM
1289         bcmdev->hu = &bcmdev->serdev_hu;
1290 #endif
1291         bcmdev->serdev_hu.serdev = serdev;
1292         serdev_device_set_drvdata(serdev, bcmdev);
1293
1294         if (has_acpi_companion(&serdev->dev))
1295                 err = bcm_acpi_probe(bcmdev);
1296         else
1297                 err = bcm_of_probe(bcmdev);
1298         if (err)
1299                 return err;
1300
1301         err = bcm_get_resources(bcmdev);
1302         if (err)
1303                 return err;
1304
1305         if (!bcmdev->shutdown) {
1306                 dev_warn(&serdev->dev,
1307                          "No reset resource, using default baud rate\n");
1308                 bcmdev->oper_speed = bcmdev->init_speed;
1309         }
1310
1311         err = bcm_gpio_set_power(bcmdev, false);
1312         if (err)
1313                 dev_err(&serdev->dev, "Failed to power down\n");
1314
1315         return hci_uart_register_device(&bcmdev->serdev_hu, &bcm_proto);
1316 }
1317
1318 static void bcm_serdev_remove(struct serdev_device *serdev)
1319 {
1320         struct bcm_device *bcmdev = serdev_device_get_drvdata(serdev);
1321
1322         hci_uart_unregister_device(&bcmdev->serdev_hu);
1323 }
1324
1325 #ifdef CONFIG_OF
1326 static const struct of_device_id bcm_bluetooth_of_match[] = {
1327         { .compatible = "brcm,bcm43438-bt" },
1328         { },
1329 };
1330 MODULE_DEVICE_TABLE(of, bcm_bluetooth_of_match);
1331 #endif
1332
1333 static struct serdev_device_driver bcm_serdev_driver = {
1334         .probe = bcm_serdev_probe,
1335         .remove = bcm_serdev_remove,
1336         .driver = {
1337                 .name = "hci_uart_bcm",
1338                 .of_match_table = of_match_ptr(bcm_bluetooth_of_match),
1339                 .acpi_match_table = ACPI_PTR(bcm_acpi_match),
1340                 .pm = &bcm_pm_ops,
1341         },
1342 };
1343
1344 int __init bcm_init(void)
1345 {
1346         /* For now, we need to keep both platform device
1347          * driver (ACPI generated) and serdev driver (DT).
1348          */
1349         platform_driver_register(&bcm_driver);
1350         serdev_device_driver_register(&bcm_serdev_driver);
1351
1352         return hci_uart_register_proto(&bcm_proto);
1353 }
1354
1355 int __exit bcm_deinit(void)
1356 {
1357         platform_driver_unregister(&bcm_driver);
1358         serdev_device_driver_unregister(&bcm_serdev_driver);
1359
1360         return hci_uart_unregister_proto(&bcm_proto);
1361 }