Merge master.kernel.org:/pub/scm/linux/kernel/git/gregkh/driver-2.6
[linux-2.6/btrfs-unstable.git] / drivers / bluetooth / bt3c_cs.c
blobb94ac2f9f7baf2d5e9cc0641e52de23cd1536d13
1 /*
3 * Driver for the 3Com Bluetooth PCMCIA card
5 * Copyright (C) 2001-2002 Marcel Holtmann <marcel@holtmann.org>
6 * Jose Orlando Pereira <jop@di.uminho.pt>
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;
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.
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.
24 #include <linux/config.h>
25 #include <linux/module.h>
27 #include <linux/kernel.h>
28 #include <linux/init.h>
29 #include <linux/slab.h>
30 #include <linux/types.h>
31 #include <linux/sched.h>
32 #include <linux/delay.h>
33 #include <linux/errno.h>
34 #include <linux/ptrace.h>
35 #include <linux/ioport.h>
36 #include <linux/spinlock.h>
37 #include <linux/moduleparam.h>
39 #include <linux/skbuff.h>
40 #include <linux/string.h>
41 #include <linux/serial.h>
42 #include <linux/serial_reg.h>
43 #include <linux/bitops.h>
44 #include <asm/system.h>
45 #include <asm/io.h>
47 #include <linux/device.h>
48 #include <linux/firmware.h>
50 #include <pcmcia/cs_types.h>
51 #include <pcmcia/cs.h>
52 #include <pcmcia/cistpl.h>
53 #include <pcmcia/ciscode.h>
54 #include <pcmcia/ds.h>
55 #include <pcmcia/cisreg.h>
57 #include <net/bluetooth/bluetooth.h>
58 #include <net/bluetooth/hci_core.h>
62 /* ======================== Module parameters ======================== */
65 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>, Jose Orlando Pereira <jop@di.uminho.pt>");
66 MODULE_DESCRIPTION("Bluetooth driver for the 3Com Bluetooth PCMCIA card");
67 MODULE_LICENSE("GPL");
71 /* ======================== Local structures ======================== */
74 typedef struct bt3c_info_t {
75 struct pcmcia_device *p_dev;
76 dev_node_t node;
78 struct hci_dev *hdev;
80 spinlock_t lock; /* For serializing operations */
82 struct sk_buff_head txq;
83 unsigned long tx_state;
85 unsigned long rx_state;
86 unsigned long rx_count;
87 struct sk_buff *rx_skb;
88 } bt3c_info_t;
91 static int bt3c_config(struct pcmcia_device *link);
92 static void bt3c_release(struct pcmcia_device *link);
94 static void bt3c_detach(struct pcmcia_device *p_dev);
97 /* Transmit states */
98 #define XMIT_SENDING 1
99 #define XMIT_WAKEUP 2
100 #define XMIT_WAITING 8
102 /* Receiver states */
103 #define RECV_WAIT_PACKET_TYPE 0
104 #define RECV_WAIT_EVENT_HEADER 1
105 #define RECV_WAIT_ACL_HEADER 2
106 #define RECV_WAIT_SCO_HEADER 3
107 #define RECV_WAIT_DATA 4
111 /* ======================== Special I/O functions ======================== */
114 #define DATA_L 0
115 #define DATA_H 1
116 #define ADDR_L 2
117 #define ADDR_H 3
118 #define CONTROL 4
121 static inline void bt3c_address(unsigned int iobase, unsigned short addr)
123 outb(addr & 0xff, iobase + ADDR_L);
124 outb((addr >> 8) & 0xff, iobase + ADDR_H);
128 static inline void bt3c_put(unsigned int iobase, unsigned short value)
130 outb(value & 0xff, iobase + DATA_L);
131 outb((value >> 8) & 0xff, iobase + DATA_H);
135 static inline void bt3c_io_write(unsigned int iobase, unsigned short addr, unsigned short value)
137 bt3c_address(iobase, addr);
138 bt3c_put(iobase, value);
142 static inline unsigned short bt3c_get(unsigned int iobase)
144 unsigned short value = inb(iobase + DATA_L);
146 value |= inb(iobase + DATA_H) << 8;
148 return value;
152 static inline unsigned short bt3c_read(unsigned int iobase, unsigned short addr)
154 bt3c_address(iobase, addr);
156 return bt3c_get(iobase);
161 /* ======================== Interrupt handling ======================== */
164 static int bt3c_write(unsigned int iobase, int fifo_size, __u8 *buf, int len)
166 int actual = 0;
168 bt3c_address(iobase, 0x7080);
170 /* Fill FIFO with current frame */
171 while (actual < len) {
172 /* Transmit next byte */
173 bt3c_put(iobase, buf[actual]);
174 actual++;
177 bt3c_io_write(iobase, 0x7005, actual);
179 return actual;
183 static void bt3c_write_wakeup(bt3c_info_t *info)
185 if (!info) {
186 BT_ERR("Unknown device");
187 return;
190 if (test_and_set_bit(XMIT_SENDING, &(info->tx_state)))
191 return;
193 do {
194 register unsigned int iobase = info->p_dev->io.BasePort1;
195 register struct sk_buff *skb;
196 register int len;
198 if (!pcmcia_dev_present(info->p_dev))
199 break;
202 if (!(skb = skb_dequeue(&(info->txq)))) {
203 clear_bit(XMIT_SENDING, &(info->tx_state));
204 break;
207 /* Send frame */
208 len = bt3c_write(iobase, 256, skb->data, skb->len);
210 if (len != skb->len) {
211 BT_ERR("Very strange");
214 kfree_skb(skb);
216 info->hdev->stat.byte_tx += len;
218 } while (0);
222 static void bt3c_receive(bt3c_info_t *info)
224 unsigned int iobase;
225 int size = 0, avail;
227 if (!info) {
228 BT_ERR("Unknown device");
229 return;
232 iobase = info->p_dev->io.BasePort1;
234 avail = bt3c_read(iobase, 0x7006);
235 //printk("bt3c_cs: receiving %d bytes\n", avail);
237 bt3c_address(iobase, 0x7480);
238 while (size < avail) {
239 size++;
240 info->hdev->stat.byte_rx++;
242 /* Allocate packet */
243 if (info->rx_skb == NULL) {
244 info->rx_state = RECV_WAIT_PACKET_TYPE;
245 info->rx_count = 0;
246 if (!(info->rx_skb = bt_skb_alloc(HCI_MAX_FRAME_SIZE, GFP_ATOMIC))) {
247 BT_ERR("Can't allocate mem for new packet");
248 return;
253 if (info->rx_state == RECV_WAIT_PACKET_TYPE) {
255 info->rx_skb->dev = (void *) info->hdev;
256 bt_cb(info->rx_skb)->pkt_type = inb(iobase + DATA_L);
257 inb(iobase + DATA_H);
258 //printk("bt3c: PACKET_TYPE=%02x\n", bt_cb(info->rx_skb)->pkt_type);
260 switch (bt_cb(info->rx_skb)->pkt_type) {
262 case HCI_EVENT_PKT:
263 info->rx_state = RECV_WAIT_EVENT_HEADER;
264 info->rx_count = HCI_EVENT_HDR_SIZE;
265 break;
267 case HCI_ACLDATA_PKT:
268 info->rx_state = RECV_WAIT_ACL_HEADER;
269 info->rx_count = HCI_ACL_HDR_SIZE;
270 break;
272 case HCI_SCODATA_PKT:
273 info->rx_state = RECV_WAIT_SCO_HEADER;
274 info->rx_count = HCI_SCO_HDR_SIZE;
275 break;
277 default:
278 /* Unknown packet */
279 BT_ERR("Unknown HCI packet with type 0x%02x received", bt_cb(info->rx_skb)->pkt_type);
280 info->hdev->stat.err_rx++;
281 clear_bit(HCI_RUNNING, &(info->hdev->flags));
283 kfree_skb(info->rx_skb);
284 info->rx_skb = NULL;
285 break;
289 } else {
291 __u8 x = inb(iobase + DATA_L);
293 *skb_put(info->rx_skb, 1) = x;
294 inb(iobase + DATA_H);
295 info->rx_count--;
297 if (info->rx_count == 0) {
299 int dlen;
300 struct hci_event_hdr *eh;
301 struct hci_acl_hdr *ah;
302 struct hci_sco_hdr *sh;
304 switch (info->rx_state) {
306 case RECV_WAIT_EVENT_HEADER:
307 eh = (struct hci_event_hdr *)(info->rx_skb->data);
308 info->rx_state = RECV_WAIT_DATA;
309 info->rx_count = eh->plen;
310 break;
312 case RECV_WAIT_ACL_HEADER:
313 ah = (struct hci_acl_hdr *)(info->rx_skb->data);
314 dlen = __le16_to_cpu(ah->dlen);
315 info->rx_state = RECV_WAIT_DATA;
316 info->rx_count = dlen;
317 break;
319 case RECV_WAIT_SCO_HEADER:
320 sh = (struct hci_sco_hdr *)(info->rx_skb->data);
321 info->rx_state = RECV_WAIT_DATA;
322 info->rx_count = sh->dlen;
323 break;
325 case RECV_WAIT_DATA:
326 hci_recv_frame(info->rx_skb);
327 info->rx_skb = NULL;
328 break;
338 bt3c_io_write(iobase, 0x7006, 0x0000);
342 static irqreturn_t bt3c_interrupt(int irq, void *dev_inst, struct pt_regs *regs)
344 bt3c_info_t *info = dev_inst;
345 unsigned int iobase;
346 int iir;
348 if (!info || !info->hdev) {
349 BT_ERR("Call of irq %d for unknown device", irq);
350 return IRQ_NONE;
353 iobase = info->p_dev->io.BasePort1;
355 spin_lock(&(info->lock));
357 iir = inb(iobase + CONTROL);
358 if (iir & 0x80) {
359 int stat = bt3c_read(iobase, 0x7001);
361 if ((stat & 0xff) == 0x7f) {
362 BT_ERR("Very strange (stat=0x%04x)", stat);
363 } else if ((stat & 0xff) != 0xff) {
364 if (stat & 0x0020) {
365 int stat = bt3c_read(iobase, 0x7002) & 0x10;
366 BT_INFO("%s: Antenna %s", info->hdev->name,
367 stat ? "out" : "in");
369 if (stat & 0x0001)
370 bt3c_receive(info);
371 if (stat & 0x0002) {
372 //BT_ERR("Ack (stat=0x%04x)", stat);
373 clear_bit(XMIT_SENDING, &(info->tx_state));
374 bt3c_write_wakeup(info);
377 bt3c_io_write(iobase, 0x7001, 0x0000);
379 outb(iir, iobase + CONTROL);
383 spin_unlock(&(info->lock));
385 return IRQ_HANDLED;
390 /* ======================== HCI interface ======================== */
393 static int bt3c_hci_flush(struct hci_dev *hdev)
395 bt3c_info_t *info = (bt3c_info_t *)(hdev->driver_data);
397 /* Drop TX queue */
398 skb_queue_purge(&(info->txq));
400 return 0;
404 static int bt3c_hci_open(struct hci_dev *hdev)
406 set_bit(HCI_RUNNING, &(hdev->flags));
408 return 0;
412 static int bt3c_hci_close(struct hci_dev *hdev)
414 if (!test_and_clear_bit(HCI_RUNNING, &(hdev->flags)))
415 return 0;
417 bt3c_hci_flush(hdev);
419 return 0;
423 static int bt3c_hci_send_frame(struct sk_buff *skb)
425 bt3c_info_t *info;
426 struct hci_dev *hdev = (struct hci_dev *)(skb->dev);
427 unsigned long flags;
429 if (!hdev) {
430 BT_ERR("Frame for unknown HCI device (hdev=NULL)");
431 return -ENODEV;
434 info = (bt3c_info_t *) (hdev->driver_data);
436 switch (bt_cb(skb)->pkt_type) {
437 case HCI_COMMAND_PKT:
438 hdev->stat.cmd_tx++;
439 break;
440 case HCI_ACLDATA_PKT:
441 hdev->stat.acl_tx++;
442 break;
443 case HCI_SCODATA_PKT:
444 hdev->stat.sco_tx++;
445 break;
448 /* Prepend skb with frame type */
449 memcpy(skb_push(skb, 1), &bt_cb(skb)->pkt_type, 1);
450 skb_queue_tail(&(info->txq), skb);
452 spin_lock_irqsave(&(info->lock), flags);
454 bt3c_write_wakeup(info);
456 spin_unlock_irqrestore(&(info->lock), flags);
458 return 0;
462 static void bt3c_hci_destruct(struct hci_dev *hdev)
467 static int bt3c_hci_ioctl(struct hci_dev *hdev, unsigned int cmd, unsigned long arg)
469 return -ENOIOCTLCMD;
474 /* ======================== Card services HCI interaction ======================== */
477 static int bt3c_load_firmware(bt3c_info_t *info, unsigned char *firmware, int count)
479 char *ptr = (char *) firmware;
480 char b[9];
481 unsigned int iobase, size, addr, fcs, tmp;
482 int i, err = 0;
484 iobase = info->p_dev->io.BasePort1;
486 /* Reset */
487 bt3c_io_write(iobase, 0x8040, 0x0404);
488 bt3c_io_write(iobase, 0x8040, 0x0400);
490 udelay(1);
492 bt3c_io_write(iobase, 0x8040, 0x0404);
494 udelay(17);
496 /* Load */
497 while (count) {
498 if (ptr[0] != 'S') {
499 BT_ERR("Bad address in firmware");
500 err = -EFAULT;
501 goto error;
504 memset(b, 0, sizeof(b));
505 memcpy(b, ptr + 2, 2);
506 size = simple_strtol(b, NULL, 16);
508 memset(b, 0, sizeof(b));
509 memcpy(b, ptr + 4, 8);
510 addr = simple_strtol(b, NULL, 16);
512 memset(b, 0, sizeof(b));
513 memcpy(b, ptr + (size * 2) + 2, 2);
514 fcs = simple_strtol(b, NULL, 16);
516 memset(b, 0, sizeof(b));
517 for (tmp = 0, i = 0; i < size; i++) {
518 memcpy(b, ptr + (i * 2) + 2, 2);
519 tmp += simple_strtol(b, NULL, 16);
522 if (((tmp + fcs) & 0xff) != 0xff) {
523 BT_ERR("Checksum error in firmware");
524 err = -EILSEQ;
525 goto error;
528 if (ptr[1] == '3') {
529 bt3c_address(iobase, addr);
531 memset(b, 0, sizeof(b));
532 for (i = 0; i < (size - 4) / 2; i++) {
533 memcpy(b, ptr + (i * 4) + 12, 4);
534 tmp = simple_strtol(b, NULL, 16);
535 bt3c_put(iobase, tmp);
539 ptr += (size * 2) + 6;
540 count -= (size * 2) + 6;
543 udelay(17);
545 /* Boot */
546 bt3c_address(iobase, 0x3000);
547 outb(inb(iobase + CONTROL) | 0x40, iobase + CONTROL);
549 error:
550 udelay(17);
552 /* Clear */
553 bt3c_io_write(iobase, 0x7006, 0x0000);
554 bt3c_io_write(iobase, 0x7005, 0x0000);
555 bt3c_io_write(iobase, 0x7001, 0x0000);
557 return err;
561 static int bt3c_open(bt3c_info_t *info)
563 const struct firmware *firmware;
564 struct hci_dev *hdev;
565 int err;
567 spin_lock_init(&(info->lock));
569 skb_queue_head_init(&(info->txq));
571 info->rx_state = RECV_WAIT_PACKET_TYPE;
572 info->rx_count = 0;
573 info->rx_skb = NULL;
575 /* Initialize HCI device */
576 hdev = hci_alloc_dev();
577 if (!hdev) {
578 BT_ERR("Can't allocate HCI device");
579 return -ENOMEM;
582 info->hdev = hdev;
584 hdev->type = HCI_PCCARD;
585 hdev->driver_data = info;
587 hdev->open = bt3c_hci_open;
588 hdev->close = bt3c_hci_close;
589 hdev->flush = bt3c_hci_flush;
590 hdev->send = bt3c_hci_send_frame;
591 hdev->destruct = bt3c_hci_destruct;
592 hdev->ioctl = bt3c_hci_ioctl;
594 hdev->owner = THIS_MODULE;
596 /* Load firmware */
597 err = request_firmware(&firmware, "BT3CPCC.bin", &info->p_dev->dev);
598 if (err < 0) {
599 BT_ERR("Firmware request failed");
600 goto error;
603 err = bt3c_load_firmware(info, firmware->data, firmware->size);
605 release_firmware(firmware);
607 if (err < 0) {
608 BT_ERR("Firmware loading failed");
609 goto error;
612 /* Timeout before it is safe to send the first HCI packet */
613 msleep(1000);
615 /* Register HCI device */
616 err = hci_register_dev(hdev);
617 if (err < 0) {
618 BT_ERR("Can't register HCI device");
619 goto error;
622 return 0;
624 error:
625 info->hdev = NULL;
626 hci_free_dev(hdev);
627 return err;
631 static int bt3c_close(bt3c_info_t *info)
633 struct hci_dev *hdev = info->hdev;
635 if (!hdev)
636 return -ENODEV;
638 bt3c_hci_close(hdev);
640 if (hci_unregister_dev(hdev) < 0)
641 BT_ERR("Can't unregister HCI device %s", hdev->name);
643 hci_free_dev(hdev);
645 return 0;
648 static int bt3c_probe(struct pcmcia_device *link)
650 bt3c_info_t *info;
652 /* Create new info device */
653 info = kzalloc(sizeof(*info), GFP_KERNEL);
654 if (!info)
655 return -ENOMEM;
657 info->p_dev = link;
658 link->priv = info;
660 link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
661 link->io.NumPorts1 = 8;
662 link->irq.Attributes = IRQ_TYPE_EXCLUSIVE | IRQ_HANDLE_PRESENT;
663 link->irq.IRQInfo1 = IRQ_LEVEL_ID;
665 link->irq.Handler = bt3c_interrupt;
666 link->irq.Instance = info;
668 link->conf.Attributes = CONF_ENABLE_IRQ;
669 link->conf.IntType = INT_MEMORY_AND_IO;
671 return bt3c_config(link);
675 static void bt3c_detach(struct pcmcia_device *link)
677 bt3c_info_t *info = link->priv;
679 bt3c_release(link);
680 kfree(info);
683 static int get_tuple(struct pcmcia_device *handle, tuple_t *tuple, cisparse_t *parse)
685 int i;
687 i = pcmcia_get_tuple_data(handle, tuple);
688 if (i != CS_SUCCESS)
689 return i;
691 return pcmcia_parse_tuple(handle, tuple, parse);
694 static int first_tuple(struct pcmcia_device *handle, tuple_t *tuple, cisparse_t *parse)
696 if (pcmcia_get_first_tuple(handle, tuple) != CS_SUCCESS)
697 return CS_NO_MORE_ITEMS;
698 return get_tuple(handle, tuple, parse);
701 static int next_tuple(struct pcmcia_device *handle, tuple_t *tuple, cisparse_t *parse)
703 if (pcmcia_get_next_tuple(handle, tuple) != CS_SUCCESS)
704 return CS_NO_MORE_ITEMS;
705 return get_tuple(handle, tuple, parse);
708 static int bt3c_config(struct pcmcia_device *link)
710 static kio_addr_t base[5] = { 0x3f8, 0x2f8, 0x3e8, 0x2e8, 0x0 };
711 bt3c_info_t *info = link->priv;
712 tuple_t tuple;
713 u_short buf[256];
714 cisparse_t parse;
715 cistpl_cftable_entry_t *cf = &parse.cftable_entry;
716 int i, j, try, last_ret, last_fn;
718 tuple.TupleData = (cisdata_t *)buf;
719 tuple.TupleOffset = 0;
720 tuple.TupleDataMax = 255;
721 tuple.Attributes = 0;
723 /* Get configuration register information */
724 tuple.DesiredTuple = CISTPL_CONFIG;
725 last_ret = first_tuple(link, &tuple, &parse);
726 if (last_ret != CS_SUCCESS) {
727 last_fn = ParseTuple;
728 goto cs_failed;
730 link->conf.ConfigBase = parse.config.base;
731 link->conf.Present = parse.config.rmask[0];
733 /* First pass: look for a config entry that looks normal. */
734 tuple.TupleData = (cisdata_t *)buf;
735 tuple.TupleOffset = 0;
736 tuple.TupleDataMax = 255;
737 tuple.Attributes = 0;
738 tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
739 /* Two tries: without IO aliases, then with aliases */
740 for (try = 0; try < 2; try++) {
741 i = first_tuple(link, &tuple, &parse);
742 while (i != CS_NO_MORE_ITEMS) {
743 if (i != CS_SUCCESS)
744 goto next_entry;
745 if (cf->vpp1.present & (1 << CISTPL_POWER_VNOM))
746 link->conf.Vpp = cf->vpp1.param[CISTPL_POWER_VNOM] / 10000;
747 if ((cf->io.nwin > 0) && (cf->io.win[0].len == 8) && (cf->io.win[0].base != 0)) {
748 link->conf.ConfigIndex = cf->index;
749 link->io.BasePort1 = cf->io.win[0].base;
750 link->io.IOAddrLines = (try == 0) ? 16 : cf->io.flags & CISTPL_IO_LINES_MASK;
751 i = pcmcia_request_io(link, &link->io);
752 if (i == CS_SUCCESS)
753 goto found_port;
755 next_entry:
756 i = next_tuple(link, &tuple, &parse);
760 /* Second pass: try to find an entry that isn't picky about
761 its base address, then try to grab any standard serial port
762 address, and finally try to get any free port. */
763 i = first_tuple(link, &tuple, &parse);
764 while (i != CS_NO_MORE_ITEMS) {
765 if ((i == CS_SUCCESS) && (cf->io.nwin > 0) && ((cf->io.flags & CISTPL_IO_LINES_MASK) <= 3)) {
766 link->conf.ConfigIndex = cf->index;
767 for (j = 0; j < 5; j++) {
768 link->io.BasePort1 = base[j];
769 link->io.IOAddrLines = base[j] ? 16 : 3;
770 i = pcmcia_request_io(link, &link->io);
771 if (i == CS_SUCCESS)
772 goto found_port;
775 i = next_tuple(link, &tuple, &parse);
778 found_port:
779 if (i != CS_SUCCESS) {
780 BT_ERR("No usable port range found");
781 cs_error(link, RequestIO, i);
782 goto failed;
785 i = pcmcia_request_irq(link, &link->irq);
786 if (i != CS_SUCCESS) {
787 cs_error(link, RequestIRQ, i);
788 link->irq.AssignedIRQ = 0;
791 i = pcmcia_request_configuration(link, &link->conf);
792 if (i != CS_SUCCESS) {
793 cs_error(link, RequestConfiguration, i);
794 goto failed;
797 if (bt3c_open(info) != 0)
798 goto failed;
800 strcpy(info->node.dev_name, info->hdev->name);
801 link->dev_node = &info->node;
803 return 0;
805 cs_failed:
806 cs_error(link, last_fn, last_ret);
808 failed:
809 bt3c_release(link);
810 return -ENODEV;
814 static void bt3c_release(struct pcmcia_device *link)
816 bt3c_info_t *info = link->priv;
818 bt3c_close(info);
820 pcmcia_disable_device(link);
824 static struct pcmcia_device_id bt3c_ids[] = {
825 PCMCIA_DEVICE_PROD_ID13("3COM", "Bluetooth PC Card", 0xefce0a31, 0xd4ce9b02),
826 PCMCIA_DEVICE_NULL
828 MODULE_DEVICE_TABLE(pcmcia, bt3c_ids);
830 static struct pcmcia_driver bt3c_driver = {
831 .owner = THIS_MODULE,
832 .drv = {
833 .name = "bt3c_cs",
835 .probe = bt3c_probe,
836 .remove = bt3c_detach,
837 .id_table = bt3c_ids,
840 static int __init init_bt3c_cs(void)
842 return pcmcia_register_driver(&bt3c_driver);
846 static void __exit exit_bt3c_cs(void)
848 pcmcia_unregister_driver(&bt3c_driver);
851 module_init(init_bt3c_cs);
852 module_exit(exit_bt3c_cs);