]> git.kernelconcepts.de Git - karo-tx-linux.git/blob - drivers/bluetooth/hci_bcm.c
Merge git://git.kernel.org/pub/scm/linux/kernel/git/davem/net
[karo-tx-linux.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/platform_device.h>
31 #include <linux/clk.h>
32 #include <linux/gpio/consumer.h>
33 #include <linux/tty.h>
34 #include <linux/interrupt.h>
35
36 #include <net/bluetooth/bluetooth.h>
37 #include <net/bluetooth/hci_core.h>
38
39 #include "btbcm.h"
40 #include "hci_uart.h"
41
42 struct bcm_device {
43         struct list_head        list;
44
45         struct platform_device  *pdev;
46
47         const char              *name;
48         struct gpio_desc        *device_wakeup;
49         struct gpio_desc        *shutdown;
50
51         struct clk              *clk;
52         bool                    clk_enabled;
53
54         u32                     init_speed;
55         int                     irq;
56         u8                      irq_polarity;
57
58 #ifdef CONFIG_PM_SLEEP
59         struct hci_uart         *hu;
60         bool                    is_suspended; /* suspend/resume flag */
61 #endif
62 };
63
64 struct bcm_data {
65         struct sk_buff          *rx_skb;
66         struct sk_buff_head     txq;
67
68         struct bcm_device       *dev;
69 };
70
71 /* List of BCM BT UART devices */
72 static DEFINE_MUTEX(bcm_device_lock);
73 static LIST_HEAD(bcm_device_list);
74
75 static int bcm_set_baudrate(struct hci_uart *hu, unsigned int speed)
76 {
77         struct hci_dev *hdev = hu->hdev;
78         struct sk_buff *skb;
79         struct bcm_update_uart_baud_rate param;
80
81         if (speed > 3000000) {
82                 struct bcm_write_uart_clock_setting clock;
83
84                 clock.type = BCM_UART_CLOCK_48MHZ;
85
86                 bt_dev_dbg(hdev, "Set Controller clock (%d)", clock.type);
87
88                 /* This Broadcom specific command changes the UART's controller
89                  * clock for baud rate > 3000000.
90                  */
91                 skb = __hci_cmd_sync(hdev, 0xfc45, 1, &clock, HCI_INIT_TIMEOUT);
92                 if (IS_ERR(skb)) {
93                         int err = PTR_ERR(skb);
94                         bt_dev_err(hdev, "BCM: failed to write clock (%d)",
95                                    err);
96                         return err;
97                 }
98
99                 kfree_skb(skb);
100         }
101
102         bt_dev_dbg(hdev, "Set Controller UART speed to %d bit/s", speed);
103
104         param.zero = cpu_to_le16(0);
105         param.baud_rate = cpu_to_le32(speed);
106
107         /* This Broadcom specific command changes the UART's controller baud
108          * rate.
109          */
110         skb = __hci_cmd_sync(hdev, 0xfc18, sizeof(param), &param,
111                              HCI_INIT_TIMEOUT);
112         if (IS_ERR(skb)) {
113                 int err = PTR_ERR(skb);
114                 bt_dev_err(hdev, "BCM: failed to write update baudrate (%d)",
115                            err);
116                 return err;
117         }
118
119         kfree_skb(skb);
120
121         return 0;
122 }
123
124 /* bcm_device_exists should be protected by bcm_device_lock */
125 static bool bcm_device_exists(struct bcm_device *device)
126 {
127         struct list_head *p;
128
129         list_for_each(p, &bcm_device_list) {
130                 struct bcm_device *dev = list_entry(p, struct bcm_device, list);
131
132                 if (device == dev)
133                         return true;
134         }
135
136         return false;
137 }
138
139 static int bcm_gpio_set_power(struct bcm_device *dev, bool powered)
140 {
141         if (powered && !IS_ERR(dev->clk) && !dev->clk_enabled)
142                 clk_enable(dev->clk);
143
144         gpiod_set_value(dev->shutdown, powered);
145         gpiod_set_value(dev->device_wakeup, powered);
146
147         if (!powered && !IS_ERR(dev->clk) && dev->clk_enabled)
148                 clk_disable(dev->clk);
149
150         dev->clk_enabled = powered;
151
152         return 0;
153 }
154
155 #ifdef CONFIG_PM_SLEEP
156 static irqreturn_t bcm_host_wake(int irq, void *data)
157 {
158         struct bcm_device *bdev = data;
159
160         bt_dev_dbg(bdev, "Host wake IRQ");
161
162         return IRQ_HANDLED;
163 }
164
165 static int bcm_request_irq(struct bcm_data *bcm)
166 {
167         struct bcm_device *bdev = bcm->dev;
168         int err = 0;
169
170         /* If this is not a platform device, do not enable PM functionalities */
171         mutex_lock(&bcm_device_lock);
172         if (!bcm_device_exists(bdev)) {
173                 err = -ENODEV;
174                 goto unlock;
175         }
176
177         if (bdev->irq > 0) {
178                 err = devm_request_irq(&bdev->pdev->dev, bdev->irq,
179                                        bcm_host_wake, IRQF_TRIGGER_RISING,
180                                        "host_wake", bdev);
181                 if (err)
182                         goto unlock;
183
184                 device_init_wakeup(&bdev->pdev->dev, true);
185         }
186
187 unlock:
188         mutex_unlock(&bcm_device_lock);
189
190         return err;
191 }
192
193 static const struct bcm_set_sleep_mode default_sleep_params = {
194         .sleep_mode = 1,        /* 0=Disabled, 1=UART, 2=Reserved, 3=USB */
195         .idle_host = 2,         /* idle threshold HOST, in 300ms */
196         .idle_dev = 2,          /* idle threshold device, in 300ms */
197         .bt_wake_active = 1,    /* BT_WAKE active mode: 1 = high, 0 = low */
198         .host_wake_active = 0,  /* HOST_WAKE active mode: 1 = high, 0 = low */
199         .allow_host_sleep = 1,  /* Allow host sleep in SCO flag */
200         .combine_modes = 0,     /* Combine sleep and LPM flag */
201         .tristate_control = 0,  /* Allow tri-state control of UART tx flag */
202         /* Irrelevant USB flags */
203         .usb_auto_sleep = 0,
204         .usb_resume_timeout = 0,
205         .pulsed_host_wake = 0,
206         .break_to_host = 0
207 };
208
209 static int bcm_setup_sleep(struct hci_uart *hu)
210 {
211         struct bcm_data *bcm = hu->priv;
212         struct sk_buff *skb;
213         struct bcm_set_sleep_mode sleep_params = default_sleep_params;
214
215         sleep_params.host_wake_active = !bcm->dev->irq_polarity;
216
217         skb = __hci_cmd_sync(hu->hdev, 0xfc27, sizeof(sleep_params),
218                              &sleep_params, HCI_INIT_TIMEOUT);
219         if (IS_ERR(skb)) {
220                 int err = PTR_ERR(skb);
221                 bt_dev_err(hu->hdev, "Sleep VSC failed (%d)", err);
222                 return err;
223         }
224         kfree_skb(skb);
225
226         bt_dev_dbg(hu->hdev, "Set Sleep Parameters VSC succeeded");
227
228         return 0;
229 }
230 #else
231 static inline int bcm_request_irq(struct bcm_data *bcm) { return 0; }
232 static inline int bcm_setup_sleep(struct hci_uart *hu) { return 0; }
233 #endif
234
235 static int bcm_open(struct hci_uart *hu)
236 {
237         struct bcm_data *bcm;
238         struct list_head *p;
239
240         bt_dev_dbg(hu->hdev, "hu %p", hu);
241
242         bcm = kzalloc(sizeof(*bcm), GFP_KERNEL);
243         if (!bcm)
244                 return -ENOMEM;
245
246         skb_queue_head_init(&bcm->txq);
247
248         hu->priv = bcm;
249
250         mutex_lock(&bcm_device_lock);
251         list_for_each(p, &bcm_device_list) {
252                 struct bcm_device *dev = list_entry(p, struct bcm_device, list);
253
254                 /* Retrieve saved bcm_device based on parent of the
255                  * platform device (saved during device probe) and
256                  * parent of tty device used by hci_uart
257                  */
258                 if (hu->tty->dev->parent == dev->pdev->dev.parent) {
259                         bcm->dev = dev;
260                         hu->init_speed = dev->init_speed;
261 #ifdef CONFIG_PM_SLEEP
262                         dev->hu = hu;
263 #endif
264                         bcm_gpio_set_power(bcm->dev, true);
265                         break;
266                 }
267         }
268
269         mutex_unlock(&bcm_device_lock);
270
271         return 0;
272 }
273
274 static int bcm_close(struct hci_uart *hu)
275 {
276         struct bcm_data *bcm = hu->priv;
277         struct bcm_device *bdev = bcm->dev;
278
279         bt_dev_dbg(hu->hdev, "hu %p", hu);
280
281         /* Protect bcm->dev against removal of the device or driver */
282         mutex_lock(&bcm_device_lock);
283         if (bcm_device_exists(bdev)) {
284                 bcm_gpio_set_power(bdev, false);
285 #ifdef CONFIG_PM_SLEEP
286                 if (device_can_wakeup(&bdev->pdev->dev)) {
287                         devm_free_irq(&bdev->pdev->dev, bdev->irq, bdev);
288                         device_init_wakeup(&bdev->pdev->dev, false);
289                 }
290
291                 bdev->hu = NULL;
292 #endif
293         }
294         mutex_unlock(&bcm_device_lock);
295
296         skb_queue_purge(&bcm->txq);
297         kfree_skb(bcm->rx_skb);
298         kfree(bcm);
299
300         hu->priv = NULL;
301         return 0;
302 }
303
304 static int bcm_flush(struct hci_uart *hu)
305 {
306         struct bcm_data *bcm = hu->priv;
307
308         bt_dev_dbg(hu->hdev, "hu %p", hu);
309
310         skb_queue_purge(&bcm->txq);
311
312         return 0;
313 }
314
315 static int bcm_setup(struct hci_uart *hu)
316 {
317         struct bcm_data *bcm = hu->priv;
318         char fw_name[64];
319         const struct firmware *fw;
320         unsigned int speed;
321         int err;
322
323         bt_dev_dbg(hu->hdev, "hu %p", hu);
324
325         hu->hdev->set_bdaddr = btbcm_set_bdaddr;
326
327         err = btbcm_initialize(hu->hdev, fw_name, sizeof(fw_name));
328         if (err)
329                 return err;
330
331         err = request_firmware(&fw, fw_name, &hu->hdev->dev);
332         if (err < 0) {
333                 bt_dev_info(hu->hdev, "BCM: Patch %s not found", fw_name);
334                 return 0;
335         }
336
337         err = btbcm_patchram(hu->hdev, fw);
338         if (err) {
339                 bt_dev_info(hu->hdev, "BCM: Patch failed (%d)", err);
340                 goto finalize;
341         }
342
343         /* Init speed if any */
344         if (hu->init_speed)
345                 speed = hu->init_speed;
346         else if (hu->proto->init_speed)
347                 speed = hu->proto->init_speed;
348         else
349                 speed = 0;
350
351         if (speed)
352                 hci_uart_set_baudrate(hu, speed);
353
354         /* Operational speed if any */
355         if (hu->oper_speed)
356                 speed = hu->oper_speed;
357         else if (hu->proto->oper_speed)
358                 speed = hu->proto->oper_speed;
359         else
360                 speed = 0;
361
362         if (speed) {
363                 err = bcm_set_baudrate(hu, speed);
364                 if (!err)
365                         hci_uart_set_baudrate(hu, speed);
366         }
367
368 finalize:
369         release_firmware(fw);
370
371         err = btbcm_finalize(hu->hdev);
372         if (err)
373                 return err;
374
375         err = bcm_request_irq(bcm);
376         if (!err)
377                 err = bcm_setup_sleep(hu);
378
379         return err;
380 }
381
382 static const struct h4_recv_pkt bcm_recv_pkts[] = {
383         { H4_RECV_ACL,   .recv = hci_recv_frame },
384         { H4_RECV_SCO,   .recv = hci_recv_frame },
385         { H4_RECV_EVENT, .recv = hci_recv_frame },
386 };
387
388 static int bcm_recv(struct hci_uart *hu, const void *data, int count)
389 {
390         struct bcm_data *bcm = hu->priv;
391
392         if (!test_bit(HCI_UART_REGISTERED, &hu->flags))
393                 return -EUNATCH;
394
395         bcm->rx_skb = h4_recv_buf(hu->hdev, bcm->rx_skb, data, count,
396                                   bcm_recv_pkts, ARRAY_SIZE(bcm_recv_pkts));
397         if (IS_ERR(bcm->rx_skb)) {
398                 int err = PTR_ERR(bcm->rx_skb);
399                 bt_dev_err(hu->hdev, "Frame reassembly failed (%d)", err);
400                 bcm->rx_skb = NULL;
401                 return err;
402         }
403
404         return count;
405 }
406
407 static int bcm_enqueue(struct hci_uart *hu, struct sk_buff *skb)
408 {
409         struct bcm_data *bcm = hu->priv;
410
411         bt_dev_dbg(hu->hdev, "hu %p skb %p", hu, skb);
412
413         /* Prepend skb with frame type */
414         memcpy(skb_push(skb, 1), &bt_cb(skb)->pkt_type, 1);
415         skb_queue_tail(&bcm->txq, skb);
416
417         return 0;
418 }
419
420 static struct sk_buff *bcm_dequeue(struct hci_uart *hu)
421 {
422         struct bcm_data *bcm = hu->priv;
423
424         return skb_dequeue(&bcm->txq);
425 }
426
427 #ifdef CONFIG_PM_SLEEP
428 /* Platform suspend callback */
429 static int bcm_suspend(struct device *dev)
430 {
431         struct bcm_device *bdev = platform_get_drvdata(to_platform_device(dev));
432         int error;
433
434         bt_dev_dbg(bdev, "suspend: is_suspended %d", bdev->is_suspended);
435
436         mutex_lock(&bcm_device_lock);
437
438         if (!bdev->hu)
439                 goto unlock;
440
441         if (!bdev->is_suspended) {
442                 hci_uart_set_flow_control(bdev->hu, true);
443
444                 /* Once this callback returns, driver suspends BT via GPIO */
445                 bdev->is_suspended = true;
446         }
447
448         /* Suspend the device */
449         if (bdev->device_wakeup) {
450                 gpiod_set_value(bdev->device_wakeup, false);
451                 bt_dev_dbg(bdev, "suspend, delaying 15 ms");
452                 mdelay(15);
453         }
454
455         if (device_may_wakeup(&bdev->pdev->dev)) {
456                 error = enable_irq_wake(bdev->irq);
457                 if (!error)
458                         bt_dev_dbg(bdev, "BCM irq: enabled");
459         }
460
461 unlock:
462         mutex_unlock(&bcm_device_lock);
463
464         return 0;
465 }
466
467 /* Platform resume callback */
468 static int bcm_resume(struct device *dev)
469 {
470         struct bcm_device *bdev = platform_get_drvdata(to_platform_device(dev));
471
472         bt_dev_dbg(bdev, "resume: is_suspended %d", bdev->is_suspended);
473
474         mutex_lock(&bcm_device_lock);
475
476         if (!bdev->hu)
477                 goto unlock;
478
479         if (device_may_wakeup(&bdev->pdev->dev)) {
480                 disable_irq_wake(bdev->irq);
481                 bt_dev_dbg(bdev, "BCM irq: disabled");
482         }
483
484         if (bdev->device_wakeup) {
485                 gpiod_set_value(bdev->device_wakeup, true);
486                 bt_dev_dbg(bdev, "resume, delaying 15 ms");
487                 mdelay(15);
488         }
489
490         /* When this callback executes, the device has woken up already */
491         if (bdev->is_suspended) {
492                 bdev->is_suspended = false;
493
494                 hci_uart_set_flow_control(bdev->hu, false);
495         }
496
497 unlock:
498         mutex_unlock(&bcm_device_lock);
499
500         return 0;
501 }
502 #endif
503
504 static const struct acpi_gpio_params device_wakeup_gpios = { 0, 0, false };
505 static const struct acpi_gpio_params shutdown_gpios = { 1, 0, false };
506 static const struct acpi_gpio_params host_wakeup_gpios = { 2, 0, false };
507
508 static const struct acpi_gpio_mapping acpi_bcm_default_gpios[] = {
509         { "device-wakeup-gpios", &device_wakeup_gpios, 1 },
510         { "shutdown-gpios", &shutdown_gpios, 1 },
511         { "host-wakeup-gpios", &host_wakeup_gpios, 1 },
512         { },
513 };
514
515 #ifdef CONFIG_ACPI
516 static int bcm_resource(struct acpi_resource *ares, void *data)
517 {
518         struct bcm_device *dev = data;
519         struct acpi_resource_extended_irq *irq;
520         struct acpi_resource_gpio *gpio;
521         struct acpi_resource_uart_serialbus *sb;
522
523         switch (ares->type) {
524         case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
525                 irq = &ares->data.extended_irq;
526                 dev->irq_polarity = irq->polarity;
527                 break;
528
529         case ACPI_RESOURCE_TYPE_GPIO:
530                 gpio = &ares->data.gpio;
531                 if (gpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT)
532                         dev->irq_polarity = gpio->polarity;
533                 break;
534
535         case ACPI_RESOURCE_TYPE_SERIAL_BUS:
536                 sb = &ares->data.uart_serial_bus;
537                 if (sb->type == ACPI_RESOURCE_SERIAL_TYPE_UART)
538                         dev->init_speed = sb->default_baud_rate;
539                 break;
540
541         default:
542                 break;
543         }
544
545         /* Always tell the ACPI core to skip this resource */
546         return 1;
547 }
548
549 static int bcm_acpi_probe(struct bcm_device *dev)
550 {
551         struct platform_device *pdev = dev->pdev;
552         const struct acpi_device_id *id;
553         struct acpi_device *adev;
554         LIST_HEAD(resources);
555         int ret;
556
557         id = acpi_match_device(pdev->dev.driver->acpi_match_table, &pdev->dev);
558         if (!id)
559                 return -ENODEV;
560
561         /* Retrieve GPIO data */
562         dev->name = dev_name(&pdev->dev);
563         ret = acpi_dev_add_driver_gpios(ACPI_COMPANION(&pdev->dev),
564                                         acpi_bcm_default_gpios);
565         if (ret)
566                 return ret;
567
568         dev->clk = devm_clk_get(&pdev->dev, NULL);
569
570         dev->device_wakeup = devm_gpiod_get_optional(&pdev->dev,
571                                                      "device-wakeup",
572                                                      GPIOD_OUT_LOW);
573         if (IS_ERR(dev->device_wakeup))
574                 return PTR_ERR(dev->device_wakeup);
575
576         dev->shutdown = devm_gpiod_get_optional(&pdev->dev, "shutdown",
577                                                 GPIOD_OUT_LOW);
578         if (IS_ERR(dev->shutdown))
579                 return PTR_ERR(dev->shutdown);
580
581         /* IRQ can be declared in ACPI table as Interrupt or GpioInt */
582         dev->irq = platform_get_irq(pdev, 0);
583         if (dev->irq <= 0) {
584                 struct gpio_desc *gpio;
585
586                 gpio = devm_gpiod_get_optional(&pdev->dev, "host-wakeup",
587                                                GPIOD_IN);
588                 if (IS_ERR(gpio))
589                         return PTR_ERR(gpio);
590
591                 dev->irq = gpiod_to_irq(gpio);
592         }
593
594         dev_info(&pdev->dev, "BCM irq: %d\n", dev->irq);
595
596         /* Make sure at-least one of the GPIO is defined and that
597          * a name is specified for this instance
598          */
599         if ((!dev->device_wakeup && !dev->shutdown) || !dev->name) {
600                 dev_err(&pdev->dev, "invalid platform data\n");
601                 return -EINVAL;
602         }
603
604         /* Retrieve UART ACPI info */
605         adev = ACPI_COMPANION(&dev->pdev->dev);
606         if (!adev)
607                 return 0;
608
609         acpi_dev_get_resources(adev, &resources, bcm_resource, dev);
610
611         return 0;
612 }
613 #else
614 static int bcm_acpi_probe(struct bcm_device *dev)
615 {
616         return -EINVAL;
617 }
618 #endif /* CONFIG_ACPI */
619
620 static int bcm_probe(struct platform_device *pdev)
621 {
622         struct bcm_device *dev;
623         struct acpi_device_id *pdata = pdev->dev.platform_data;
624         int ret;
625
626         dev = devm_kzalloc(&pdev->dev, sizeof(*dev), GFP_KERNEL);
627         if (!dev)
628                 return -ENOMEM;
629
630         dev->pdev = pdev;
631
632         if (ACPI_HANDLE(&pdev->dev)) {
633                 ret = bcm_acpi_probe(dev);
634                 if (ret)
635                         return ret;
636         } else if (pdata) {
637                 dev->name = pdata->id;
638         } else {
639                 return -ENODEV;
640         }
641
642         platform_set_drvdata(pdev, dev);
643
644         dev_info(&pdev->dev, "%s device registered.\n", dev->name);
645
646         /* Place this instance on the device list */
647         mutex_lock(&bcm_device_lock);
648         list_add_tail(&dev->list, &bcm_device_list);
649         mutex_unlock(&bcm_device_lock);
650
651         bcm_gpio_set_power(dev, false);
652
653         return 0;
654 }
655
656 static int bcm_remove(struct platform_device *pdev)
657 {
658         struct bcm_device *dev = platform_get_drvdata(pdev);
659
660         mutex_lock(&bcm_device_lock);
661         list_del(&dev->list);
662         mutex_unlock(&bcm_device_lock);
663
664         acpi_dev_remove_driver_gpios(ACPI_COMPANION(&pdev->dev));
665
666         dev_info(&pdev->dev, "%s device unregistered.\n", dev->name);
667
668         return 0;
669 }
670
671 static const struct hci_uart_proto bcm_proto = {
672         .id             = HCI_UART_BCM,
673         .name           = "BCM",
674         .init_speed     = 115200,
675         .oper_speed     = 4000000,
676         .open           = bcm_open,
677         .close          = bcm_close,
678         .flush          = bcm_flush,
679         .setup          = bcm_setup,
680         .set_baudrate   = bcm_set_baudrate,
681         .recv           = bcm_recv,
682         .enqueue        = bcm_enqueue,
683         .dequeue        = bcm_dequeue,
684 };
685
686 #ifdef CONFIG_ACPI
687 static const struct acpi_device_id bcm_acpi_match[] = {
688         { "BCM2E39", 0 },
689         { "BCM2E67", 0 },
690         { },
691 };
692 MODULE_DEVICE_TABLE(acpi, bcm_acpi_match);
693 #endif
694
695 /* Platform suspend and resume callbacks */
696 static SIMPLE_DEV_PM_OPS(bcm_pm_ops, bcm_suspend, bcm_resume);
697
698 static struct platform_driver bcm_driver = {
699         .probe = bcm_probe,
700         .remove = bcm_remove,
701         .driver = {
702                 .name = "hci_bcm",
703                 .acpi_match_table = ACPI_PTR(bcm_acpi_match),
704                 .pm = &bcm_pm_ops,
705         },
706 };
707
708 int __init bcm_init(void)
709 {
710         platform_driver_register(&bcm_driver);
711
712         return hci_uart_register_proto(&bcm_proto);
713 }
714
715 int __exit bcm_deinit(void)
716 {
717         platform_driver_unregister(&bcm_driver);
718
719         return hci_uart_unregister_proto(&bcm_proto);
720 }