Merge tag 'asoc-v3.18-rc2' of git://git.kernel.org/pub/scm/linux/kernel/git/broonie...
[linux-drm-fsl-dcu.git] / drivers / bluetooth / bt3c_cs.c
1 /*
2  *
3  *  Driver for the 3Com Bluetooth PCMCIA card
4  *
5  *  Copyright (C) 2001-2002  Marcel Holtmann <marcel@holtmann.org>
6  *                           Jose Orlando Pereira <jop@di.uminho.pt>
7  *
8  *
9  *  This program is free software; you can redistribute it and/or modify
10  *  it under the terms of the GNU General Public License version 2 as
11  *  published by the Free Software Foundation;
12  *
13  *  Software distributed under the License is distributed on an "AS
14  *  IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
15  *  implied. See the License for the specific language governing
16  *  rights and limitations under the License.
17  *
18  *  The initial developer of the original code is David A. Hinds
19  *  <dahinds@users.sourceforge.net>.  Portions created by David A. Hinds
20  *  are Copyright (C) 1999 David A. Hinds.  All Rights Reserved.
21  *
22  */
23
24 #include <linux/module.h>
25
26 #include <linux/kernel.h>
27 #include <linux/init.h>
28 #include <linux/slab.h>
29 #include <linux/types.h>
30 #include <linux/delay.h>
31 #include <linux/errno.h>
32 #include <linux/ptrace.h>
33 #include <linux/ioport.h>
34 #include <linux/spinlock.h>
35 #include <linux/moduleparam.h>
36
37 #include <linux/skbuff.h>
38 #include <linux/string.h>
39 #include <linux/serial.h>
40 #include <linux/serial_reg.h>
41 #include <linux/bitops.h>
42 #include <asm/io.h>
43
44 #include <linux/device.h>
45 #include <linux/firmware.h>
46
47 #include <pcmcia/cistpl.h>
48 #include <pcmcia/ciscode.h>
49 #include <pcmcia/ds.h>
50 #include <pcmcia/cisreg.h>
51
52 #include <net/bluetooth/bluetooth.h>
53 #include <net/bluetooth/hci_core.h>
54
55
56
57 /* ======================== Module parameters ======================== */
58
59
60 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
61 MODULE_DESCRIPTION("Bluetooth driver for the 3Com Bluetooth PCMCIA card");
62 MODULE_LICENSE("GPL");
63 MODULE_FIRMWARE("BT3CPCC.bin");
64
65
66
67 /* ======================== Local structures ======================== */
68
69
70 struct bt3c_info {
71         struct pcmcia_device *p_dev;
72
73         struct hci_dev *hdev;
74
75         spinlock_t lock;                /* For serializing operations */
76
77         struct sk_buff_head txq;
78         unsigned long tx_state;
79
80         unsigned long rx_state;
81         unsigned long rx_count;
82         struct sk_buff *rx_skb;
83 };
84
85
86 static int bt3c_config(struct pcmcia_device *link);
87 static void bt3c_release(struct pcmcia_device *link);
88
89 static void bt3c_detach(struct pcmcia_device *p_dev);
90
91
92 /* Transmit states  */
93 #define XMIT_SENDING  1
94 #define XMIT_WAKEUP   2
95 #define XMIT_WAITING  8
96
97 /* Receiver states */
98 #define RECV_WAIT_PACKET_TYPE   0
99 #define RECV_WAIT_EVENT_HEADER  1
100 #define RECV_WAIT_ACL_HEADER    2
101 #define RECV_WAIT_SCO_HEADER    3
102 #define RECV_WAIT_DATA          4
103
104
105
106 /* ======================== Special I/O functions ======================== */
107
108
109 #define DATA_L   0
110 #define DATA_H   1
111 #define ADDR_L   2
112 #define ADDR_H   3
113 #define CONTROL  4
114
115
116 static inline void bt3c_address(unsigned int iobase, unsigned short addr)
117 {
118         outb(addr & 0xff, iobase + ADDR_L);
119         outb((addr >> 8) & 0xff, iobase + ADDR_H);
120 }
121
122
123 static inline void bt3c_put(unsigned int iobase, unsigned short value)
124 {
125         outb(value & 0xff, iobase + DATA_L);
126         outb((value >> 8) & 0xff, iobase + DATA_H);
127 }
128
129
130 static inline void bt3c_io_write(unsigned int iobase, unsigned short addr, unsigned short value)
131 {
132         bt3c_address(iobase, addr);
133         bt3c_put(iobase, value);
134 }
135
136
137 static inline unsigned short bt3c_get(unsigned int iobase)
138 {
139         unsigned short value = inb(iobase + DATA_L);
140
141         value |= inb(iobase + DATA_H) << 8;
142
143         return value;
144 }
145
146
147 static inline unsigned short bt3c_read(unsigned int iobase, unsigned short addr)
148 {
149         bt3c_address(iobase, addr);
150
151         return bt3c_get(iobase);
152 }
153
154
155
156 /* ======================== Interrupt handling ======================== */
157
158
159 static int bt3c_write(unsigned int iobase, int fifo_size, __u8 *buf, int len)
160 {
161         int actual = 0;
162
163         bt3c_address(iobase, 0x7080);
164
165         /* Fill FIFO with current frame */
166         while (actual < len) {
167                 /* Transmit next byte */
168                 bt3c_put(iobase, buf[actual]);
169                 actual++;
170         }
171
172         bt3c_io_write(iobase, 0x7005, actual);
173
174         return actual;
175 }
176
177
178 static void bt3c_write_wakeup(struct bt3c_info *info)
179 {
180         if (!info) {
181                 BT_ERR("Unknown device");
182                 return;
183         }
184
185         if (test_and_set_bit(XMIT_SENDING, &(info->tx_state)))
186                 return;
187
188         do {
189                 unsigned int iobase = info->p_dev->resource[0]->start;
190                 register struct sk_buff *skb;
191                 int len;
192
193                 if (!pcmcia_dev_present(info->p_dev))
194                         break;
195
196                 skb = skb_dequeue(&(info->txq));
197                 if (!skb) {
198                         clear_bit(XMIT_SENDING, &(info->tx_state));
199                         break;
200                 }
201
202                 /* Send frame */
203                 len = bt3c_write(iobase, 256, skb->data, skb->len);
204
205                 if (len != skb->len) {
206                         BT_ERR("Very strange");
207                 }
208
209                 kfree_skb(skb);
210
211                 info->hdev->stat.byte_tx += len;
212
213         } while (0);
214 }
215
216
217 static void bt3c_receive(struct bt3c_info *info)
218 {
219         unsigned int iobase;
220         int size = 0, avail;
221
222         if (!info) {
223                 BT_ERR("Unknown device");
224                 return;
225         }
226
227         iobase = info->p_dev->resource[0]->start;
228
229         avail = bt3c_read(iobase, 0x7006);
230         //printk("bt3c_cs: receiving %d bytes\n", avail);
231
232         bt3c_address(iobase, 0x7480);
233         while (size < avail) {
234                 size++;
235                 info->hdev->stat.byte_rx++;
236
237                 /* Allocate packet */
238                 if (info->rx_skb == NULL) {
239                         info->rx_state = RECV_WAIT_PACKET_TYPE;
240                         info->rx_count = 0;
241                         info->rx_skb = bt_skb_alloc(HCI_MAX_FRAME_SIZE, GFP_ATOMIC);
242                         if (!info->rx_skb) {
243                                 BT_ERR("Can't allocate mem for new packet");
244                                 return;
245                         }
246                 }
247
248
249                 if (info->rx_state == RECV_WAIT_PACKET_TYPE) {
250
251                         bt_cb(info->rx_skb)->pkt_type = inb(iobase + DATA_L);
252                         inb(iobase + DATA_H);
253                         //printk("bt3c: PACKET_TYPE=%02x\n", bt_cb(info->rx_skb)->pkt_type);
254
255                         switch (bt_cb(info->rx_skb)->pkt_type) {
256
257                         case HCI_EVENT_PKT:
258                                 info->rx_state = RECV_WAIT_EVENT_HEADER;
259                                 info->rx_count = HCI_EVENT_HDR_SIZE;
260                                 break;
261
262                         case HCI_ACLDATA_PKT:
263                                 info->rx_state = RECV_WAIT_ACL_HEADER;
264                                 info->rx_count = HCI_ACL_HDR_SIZE;
265                                 break;
266
267                         case HCI_SCODATA_PKT:
268                                 info->rx_state = RECV_WAIT_SCO_HEADER;
269                                 info->rx_count = HCI_SCO_HDR_SIZE;
270                                 break;
271
272                         default:
273                                 /* Unknown packet */
274                                 BT_ERR("Unknown HCI packet with type 0x%02x received", bt_cb(info->rx_skb)->pkt_type);
275                                 info->hdev->stat.err_rx++;
276                                 clear_bit(HCI_RUNNING, &(info->hdev->flags));
277
278                                 kfree_skb(info->rx_skb);
279                                 info->rx_skb = NULL;
280                                 break;
281
282                         }
283
284                 } else {
285
286                         __u8 x = inb(iobase + DATA_L);
287
288                         *skb_put(info->rx_skb, 1) = x;
289                         inb(iobase + DATA_H);
290                         info->rx_count--;
291
292                         if (info->rx_count == 0) {
293
294                                 int dlen;
295                                 struct hci_event_hdr *eh;
296                                 struct hci_acl_hdr *ah;
297                                 struct hci_sco_hdr *sh;
298
299                                 switch (info->rx_state) {
300
301                                 case RECV_WAIT_EVENT_HEADER:
302                                         eh = hci_event_hdr(info->rx_skb);
303                                         info->rx_state = RECV_WAIT_DATA;
304                                         info->rx_count = eh->plen;
305                                         break;
306
307                                 case RECV_WAIT_ACL_HEADER:
308                                         ah = hci_acl_hdr(info->rx_skb);
309                                         dlen = __le16_to_cpu(ah->dlen);
310                                         info->rx_state = RECV_WAIT_DATA;
311                                         info->rx_count = dlen;
312                                         break;
313
314                                 case RECV_WAIT_SCO_HEADER:
315                                         sh = hci_sco_hdr(info->rx_skb);
316                                         info->rx_state = RECV_WAIT_DATA;
317                                         info->rx_count = sh->dlen;
318                                         break;
319
320                                 case RECV_WAIT_DATA:
321                                         hci_recv_frame(info->hdev, info->rx_skb);
322                                         info->rx_skb = NULL;
323                                         break;
324
325                                 }
326
327                         }
328
329                 }
330
331         }
332
333         bt3c_io_write(iobase, 0x7006, 0x0000);
334 }
335
336
337 static irqreturn_t bt3c_interrupt(int irq, void *dev_inst)
338 {
339         struct bt3c_info *info = dev_inst;
340         unsigned int iobase;
341         int iir;
342         irqreturn_t r = IRQ_NONE;
343
344         if (!info || !info->hdev)
345                 /* our irq handler is shared */
346                 return IRQ_NONE;
347
348         iobase = info->p_dev->resource[0]->start;
349
350         spin_lock(&(info->lock));
351
352         iir = inb(iobase + CONTROL);
353         if (iir & 0x80) {
354                 int stat = bt3c_read(iobase, 0x7001);
355
356                 if ((stat & 0xff) == 0x7f) {
357                         BT_ERR("Very strange (stat=0x%04x)", stat);
358                 } else if ((stat & 0xff) != 0xff) {
359                         if (stat & 0x0020) {
360                                 int status = bt3c_read(iobase, 0x7002) & 0x10;
361                                 BT_INFO("%s: Antenna %s", info->hdev->name,
362                                                         status ? "out" : "in");
363                         }
364                         if (stat & 0x0001)
365                                 bt3c_receive(info);
366                         if (stat & 0x0002) {
367                                 //BT_ERR("Ack (stat=0x%04x)", stat);
368                                 clear_bit(XMIT_SENDING, &(info->tx_state));
369                                 bt3c_write_wakeup(info);
370                         }
371
372                         bt3c_io_write(iobase, 0x7001, 0x0000);
373
374                         outb(iir, iobase + CONTROL);
375                 }
376                 r = IRQ_HANDLED;
377         }
378
379         spin_unlock(&(info->lock));
380
381         return r;
382 }
383
384
385
386 /* ======================== HCI interface ======================== */
387
388
389 static int bt3c_hci_flush(struct hci_dev *hdev)
390 {
391         struct bt3c_info *info = hci_get_drvdata(hdev);
392
393         /* Drop TX queue */
394         skb_queue_purge(&(info->txq));
395
396         return 0;
397 }
398
399
400 static int bt3c_hci_open(struct hci_dev *hdev)
401 {
402         set_bit(HCI_RUNNING, &(hdev->flags));
403
404         return 0;
405 }
406
407
408 static int bt3c_hci_close(struct hci_dev *hdev)
409 {
410         if (!test_and_clear_bit(HCI_RUNNING, &(hdev->flags)))
411                 return 0;
412
413         bt3c_hci_flush(hdev);
414
415         return 0;
416 }
417
418
419 static int bt3c_hci_send_frame(struct hci_dev *hdev, struct sk_buff *skb)
420 {
421         struct bt3c_info *info = hci_get_drvdata(hdev);
422         unsigned long flags;
423
424         switch (bt_cb(skb)->pkt_type) {
425         case HCI_COMMAND_PKT:
426                 hdev->stat.cmd_tx++;
427                 break;
428         case HCI_ACLDATA_PKT:
429                 hdev->stat.acl_tx++;
430                 break;
431         case HCI_SCODATA_PKT:
432                 hdev->stat.sco_tx++;
433                 break;
434         };
435
436         /* Prepend skb with frame type */
437         memcpy(skb_push(skb, 1), &bt_cb(skb)->pkt_type, 1);
438         skb_queue_tail(&(info->txq), skb);
439
440         spin_lock_irqsave(&(info->lock), flags);
441
442         bt3c_write_wakeup(info);
443
444         spin_unlock_irqrestore(&(info->lock), flags);
445
446         return 0;
447 }
448
449
450
451 /* ======================== Card services HCI interaction ======================== */
452
453
454 static int bt3c_load_firmware(struct bt3c_info *info,
455                               const unsigned char *firmware,
456                               int count)
457 {
458         char *ptr = (char *) firmware;
459         char b[9];
460         unsigned int iobase, size, addr, fcs, tmp;
461         int i, err = 0;
462
463         iobase = info->p_dev->resource[0]->start;
464
465         /* Reset */
466         bt3c_io_write(iobase, 0x8040, 0x0404);
467         bt3c_io_write(iobase, 0x8040, 0x0400);
468
469         udelay(1);
470
471         bt3c_io_write(iobase, 0x8040, 0x0404);
472
473         udelay(17);
474
475         /* Load */
476         while (count) {
477                 if (ptr[0] != 'S') {
478                         BT_ERR("Bad address in firmware");
479                         err = -EFAULT;
480                         goto error;
481                 }
482
483                 memset(b, 0, sizeof(b));
484                 memcpy(b, ptr + 2, 2);
485                 size = simple_strtoul(b, NULL, 16);
486
487                 memset(b, 0, sizeof(b));
488                 memcpy(b, ptr + 4, 8);
489                 addr = simple_strtoul(b, NULL, 16);
490
491                 memset(b, 0, sizeof(b));
492                 memcpy(b, ptr + (size * 2) + 2, 2);
493                 fcs = simple_strtoul(b, NULL, 16);
494
495                 memset(b, 0, sizeof(b));
496                 for (tmp = 0, i = 0; i < size; i++) {
497                         memcpy(b, ptr + (i * 2) + 2, 2);
498                         tmp += simple_strtol(b, NULL, 16);
499                 }
500
501                 if (((tmp + fcs) & 0xff) != 0xff) {
502                         BT_ERR("Checksum error in firmware");
503                         err = -EILSEQ;
504                         goto error;
505                 }
506
507                 if (ptr[1] == '3') {
508                         bt3c_address(iobase, addr);
509
510                         memset(b, 0, sizeof(b));
511                         for (i = 0; i < (size - 4) / 2; i++) {
512                                 memcpy(b, ptr + (i * 4) + 12, 4);
513                                 tmp = simple_strtoul(b, NULL, 16);
514                                 bt3c_put(iobase, tmp);
515                         }
516                 }
517
518                 ptr   += (size * 2) + 6;
519                 count -= (size * 2) + 6;
520         }
521
522         udelay(17);
523
524         /* Boot */
525         bt3c_address(iobase, 0x3000);
526         outb(inb(iobase + CONTROL) | 0x40, iobase + CONTROL);
527
528 error:
529         udelay(17);
530
531         /* Clear */
532         bt3c_io_write(iobase, 0x7006, 0x0000);
533         bt3c_io_write(iobase, 0x7005, 0x0000);
534         bt3c_io_write(iobase, 0x7001, 0x0000);
535
536         return err;
537 }
538
539
540 static int bt3c_open(struct bt3c_info *info)
541 {
542         const struct firmware *firmware;
543         struct hci_dev *hdev;
544         int err;
545
546         spin_lock_init(&(info->lock));
547
548         skb_queue_head_init(&(info->txq));
549
550         info->rx_state = RECV_WAIT_PACKET_TYPE;
551         info->rx_count = 0;
552         info->rx_skb = NULL;
553
554         /* Initialize HCI device */
555         hdev = hci_alloc_dev();
556         if (!hdev) {
557                 BT_ERR("Can't allocate HCI device");
558                 return -ENOMEM;
559         }
560
561         info->hdev = hdev;
562
563         hdev->bus = HCI_PCCARD;
564         hci_set_drvdata(hdev, info);
565         SET_HCIDEV_DEV(hdev, &info->p_dev->dev);
566
567         hdev->open  = bt3c_hci_open;
568         hdev->close = bt3c_hci_close;
569         hdev->flush = bt3c_hci_flush;
570         hdev->send  = bt3c_hci_send_frame;
571
572         /* Load firmware */
573         err = request_firmware(&firmware, "BT3CPCC.bin", &info->p_dev->dev);
574         if (err < 0) {
575                 BT_ERR("Firmware request failed");
576                 goto error;
577         }
578
579         err = bt3c_load_firmware(info, firmware->data, firmware->size);
580
581         release_firmware(firmware);
582
583         if (err < 0) {
584                 BT_ERR("Firmware loading failed");
585                 goto error;
586         }
587
588         /* Timeout before it is safe to send the first HCI packet */
589         msleep(1000);
590
591         /* Register HCI device */
592         err = hci_register_dev(hdev);
593         if (err < 0) {
594                 BT_ERR("Can't register HCI device");
595                 goto error;
596         }
597
598         return 0;
599
600 error:
601         info->hdev = NULL;
602         hci_free_dev(hdev);
603         return err;
604 }
605
606
607 static int bt3c_close(struct bt3c_info *info)
608 {
609         struct hci_dev *hdev = info->hdev;
610
611         if (!hdev)
612                 return -ENODEV;
613
614         bt3c_hci_close(hdev);
615
616         hci_unregister_dev(hdev);
617         hci_free_dev(hdev);
618
619         return 0;
620 }
621
622 static int bt3c_probe(struct pcmcia_device *link)
623 {
624         struct bt3c_info *info;
625
626         /* Create new info device */
627         info = devm_kzalloc(&link->dev, sizeof(*info), GFP_KERNEL);
628         if (!info)
629                 return -ENOMEM;
630
631         info->p_dev = link;
632         link->priv = info;
633
634         link->config_flags |= CONF_ENABLE_IRQ | CONF_AUTO_SET_VPP |
635                 CONF_AUTO_SET_IO;
636
637         return bt3c_config(link);
638 }
639
640
641 static void bt3c_detach(struct pcmcia_device *link)
642 {
643         bt3c_release(link);
644 }
645
646 static int bt3c_check_config(struct pcmcia_device *p_dev, void *priv_data)
647 {
648         int *try = priv_data;
649
650         if (!try)
651                 p_dev->io_lines = 16;
652
653         if ((p_dev->resource[0]->end != 8) || (p_dev->resource[0]->start == 0))
654                 return -EINVAL;
655
656         p_dev->resource[0]->end = 8;
657         p_dev->resource[0]->flags &= ~IO_DATA_PATH_WIDTH;
658         p_dev->resource[0]->flags |= IO_DATA_PATH_WIDTH_8;
659
660         return pcmcia_request_io(p_dev);
661 }
662
663 static int bt3c_check_config_notpicky(struct pcmcia_device *p_dev,
664                                       void *priv_data)
665 {
666         static unsigned int base[5] = { 0x3f8, 0x2f8, 0x3e8, 0x2e8, 0x0 };
667         int j;
668
669         if (p_dev->io_lines > 3)
670                 return -ENODEV;
671
672         p_dev->resource[0]->flags &= ~IO_DATA_PATH_WIDTH;
673         p_dev->resource[0]->flags |= IO_DATA_PATH_WIDTH_8;
674         p_dev->resource[0]->end = 8;
675
676         for (j = 0; j < 5; j++) {
677                 p_dev->resource[0]->start = base[j];
678                 p_dev->io_lines = base[j] ? 16 : 3;
679                 if (!pcmcia_request_io(p_dev))
680                         return 0;
681         }
682         return -ENODEV;
683 }
684
685 static int bt3c_config(struct pcmcia_device *link)
686 {
687         struct bt3c_info *info = link->priv;
688         int i;
689         unsigned long try;
690
691         /* First pass: look for a config entry that looks normal.
692            Two tries: without IO aliases, then with aliases */
693         for (try = 0; try < 2; try++)
694                 if (!pcmcia_loop_config(link, bt3c_check_config, (void *) try))
695                         goto found_port;
696
697         /* Second pass: try to find an entry that isn't picky about
698            its base address, then try to grab any standard serial port
699            address, and finally try to get any free port. */
700         if (!pcmcia_loop_config(link, bt3c_check_config_notpicky, NULL))
701                 goto found_port;
702
703         BT_ERR("No usable port range found");
704         goto failed;
705
706 found_port:
707         i = pcmcia_request_irq(link, &bt3c_interrupt);
708         if (i != 0)
709                 goto failed;
710
711         i = pcmcia_enable_device(link);
712         if (i != 0)
713                 goto failed;
714
715         if (bt3c_open(info) != 0)
716                 goto failed;
717
718         return 0;
719
720 failed:
721         bt3c_release(link);
722         return -ENODEV;
723 }
724
725
726 static void bt3c_release(struct pcmcia_device *link)
727 {
728         struct bt3c_info *info = link->priv;
729
730         bt3c_close(info);
731
732         pcmcia_disable_device(link);
733 }
734
735
736 static const struct pcmcia_device_id bt3c_ids[] = {
737         PCMCIA_DEVICE_PROD_ID13("3COM", "Bluetooth PC Card", 0xefce0a31, 0xd4ce9b02),
738         PCMCIA_DEVICE_NULL
739 };
740 MODULE_DEVICE_TABLE(pcmcia, bt3c_ids);
741
742 static struct pcmcia_driver bt3c_driver = {
743         .owner          = THIS_MODULE,
744         .name           = "bt3c_cs",
745         .probe          = bt3c_probe,
746         .remove         = bt3c_detach,
747         .id_table       = bt3c_ids,
748 };
749 module_pcmcia_driver(bt3c_driver);