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/module.h>
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>
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/system.h>
45 #include <linux/device.h>
46 #include <linux/firmware.h>
48 #include <pcmcia/cs.h>
49 #include <pcmcia/cistpl.h>
50 #include <pcmcia/ciscode.h>
51 #include <pcmcia/ds.h>
52 #include <pcmcia/cisreg.h>
54 #include <net/bluetooth/bluetooth.h>
55 #include <net/bluetooth/hci_core.h>
59 /* ======================== Module parameters ======================== */
62 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
63 MODULE_DESCRIPTION("Bluetooth driver for the 3Com Bluetooth PCMCIA card");
64 MODULE_LICENSE("GPL");
65 MODULE_FIRMWARE("BT3CPCC.bin");
69 /* ======================== Local structures ======================== */
72 typedef struct bt3c_info_t
{
73 struct pcmcia_device
*p_dev
;
77 spinlock_t lock
; /* For serializing operations */
79 struct sk_buff_head txq
;
80 unsigned long tx_state
;
82 unsigned long rx_state
;
83 unsigned long rx_count
;
84 struct sk_buff
*rx_skb
;
88 static int bt3c_config(struct pcmcia_device
*link
);
89 static void bt3c_release(struct pcmcia_device
*link
);
91 static void bt3c_detach(struct pcmcia_device
*p_dev
);
95 #define XMIT_SENDING 1
97 #define XMIT_WAITING 8
100 #define RECV_WAIT_PACKET_TYPE 0
101 #define RECV_WAIT_EVENT_HEADER 1
102 #define RECV_WAIT_ACL_HEADER 2
103 #define RECV_WAIT_SCO_HEADER 3
104 #define RECV_WAIT_DATA 4
108 /* ======================== Special I/O functions ======================== */
118 static inline void bt3c_address(unsigned int iobase
, unsigned short addr
)
120 outb(addr
& 0xff, iobase
+ ADDR_L
);
121 outb((addr
>> 8) & 0xff, iobase
+ ADDR_H
);
125 static inline void bt3c_put(unsigned int iobase
, unsigned short value
)
127 outb(value
& 0xff, iobase
+ DATA_L
);
128 outb((value
>> 8) & 0xff, iobase
+ DATA_H
);
132 static inline void bt3c_io_write(unsigned int iobase
, unsigned short addr
, unsigned short value
)
134 bt3c_address(iobase
, addr
);
135 bt3c_put(iobase
, value
);
139 static inline unsigned short bt3c_get(unsigned int iobase
)
141 unsigned short value
= inb(iobase
+ DATA_L
);
143 value
|= inb(iobase
+ DATA_H
) << 8;
149 static inline unsigned short bt3c_read(unsigned int iobase
, unsigned short addr
)
151 bt3c_address(iobase
, addr
);
153 return bt3c_get(iobase
);
158 /* ======================== Interrupt handling ======================== */
161 static int bt3c_write(unsigned int iobase
, int fifo_size
, __u8
*buf
, int len
)
165 bt3c_address(iobase
, 0x7080);
167 /* Fill FIFO with current frame */
168 while (actual
< len
) {
169 /* Transmit next byte */
170 bt3c_put(iobase
, buf
[actual
]);
174 bt3c_io_write(iobase
, 0x7005, actual
);
180 static void bt3c_write_wakeup(bt3c_info_t
*info
)
183 BT_ERR("Unknown device");
187 if (test_and_set_bit(XMIT_SENDING
, &(info
->tx_state
)))
191 register unsigned int iobase
= info
->p_dev
->resource
[0]->start
;
192 register struct sk_buff
*skb
;
195 if (!pcmcia_dev_present(info
->p_dev
))
199 if (!(skb
= skb_dequeue(&(info
->txq
)))) {
200 clear_bit(XMIT_SENDING
, &(info
->tx_state
));
205 len
= bt3c_write(iobase
, 256, skb
->data
, skb
->len
);
207 if (len
!= skb
->len
) {
208 BT_ERR("Very strange");
213 info
->hdev
->stat
.byte_tx
+= len
;
219 static void bt3c_receive(bt3c_info_t
*info
)
225 BT_ERR("Unknown device");
229 iobase
= info
->p_dev
->resource
[0]->start
;
231 avail
= bt3c_read(iobase
, 0x7006);
232 //printk("bt3c_cs: receiving %d bytes\n", avail);
234 bt3c_address(iobase
, 0x7480);
235 while (size
< avail
) {
237 info
->hdev
->stat
.byte_rx
++;
239 /* Allocate packet */
240 if (info
->rx_skb
== NULL
) {
241 info
->rx_state
= RECV_WAIT_PACKET_TYPE
;
243 if (!(info
->rx_skb
= bt_skb_alloc(HCI_MAX_FRAME_SIZE
, GFP_ATOMIC
))) {
244 BT_ERR("Can't allocate mem for new packet");
250 if (info
->rx_state
== RECV_WAIT_PACKET_TYPE
) {
252 info
->rx_skb
->dev
= (void *) info
->hdev
;
253 bt_cb(info
->rx_skb
)->pkt_type
= inb(iobase
+ DATA_L
);
254 inb(iobase
+ DATA_H
);
255 //printk("bt3c: PACKET_TYPE=%02x\n", bt_cb(info->rx_skb)->pkt_type);
257 switch (bt_cb(info
->rx_skb
)->pkt_type
) {
260 info
->rx_state
= RECV_WAIT_EVENT_HEADER
;
261 info
->rx_count
= HCI_EVENT_HDR_SIZE
;
264 case HCI_ACLDATA_PKT
:
265 info
->rx_state
= RECV_WAIT_ACL_HEADER
;
266 info
->rx_count
= HCI_ACL_HDR_SIZE
;
269 case HCI_SCODATA_PKT
:
270 info
->rx_state
= RECV_WAIT_SCO_HEADER
;
271 info
->rx_count
= HCI_SCO_HDR_SIZE
;
276 BT_ERR("Unknown HCI packet with type 0x%02x received", bt_cb(info
->rx_skb
)->pkt_type
);
277 info
->hdev
->stat
.err_rx
++;
278 clear_bit(HCI_RUNNING
, &(info
->hdev
->flags
));
280 kfree_skb(info
->rx_skb
);
288 __u8 x
= inb(iobase
+ DATA_L
);
290 *skb_put(info
->rx_skb
, 1) = x
;
291 inb(iobase
+ DATA_H
);
294 if (info
->rx_count
== 0) {
297 struct hci_event_hdr
*eh
;
298 struct hci_acl_hdr
*ah
;
299 struct hci_sco_hdr
*sh
;
301 switch (info
->rx_state
) {
303 case RECV_WAIT_EVENT_HEADER
:
304 eh
= hci_event_hdr(info
->rx_skb
);
305 info
->rx_state
= RECV_WAIT_DATA
;
306 info
->rx_count
= eh
->plen
;
309 case RECV_WAIT_ACL_HEADER
:
310 ah
= hci_acl_hdr(info
->rx_skb
);
311 dlen
= __le16_to_cpu(ah
->dlen
);
312 info
->rx_state
= RECV_WAIT_DATA
;
313 info
->rx_count
= dlen
;
316 case RECV_WAIT_SCO_HEADER
:
317 sh
= hci_sco_hdr(info
->rx_skb
);
318 info
->rx_state
= RECV_WAIT_DATA
;
319 info
->rx_count
= sh
->dlen
;
323 hci_recv_frame(info
->rx_skb
);
335 bt3c_io_write(iobase
, 0x7006, 0x0000);
339 static irqreturn_t
bt3c_interrupt(int irq
, void *dev_inst
)
341 bt3c_info_t
*info
= dev_inst
;
344 irqreturn_t r
= IRQ_NONE
;
346 if (!info
|| !info
->hdev
)
347 /* our irq handler is shared */
350 iobase
= info
->p_dev
->resource
[0]->start
;
352 spin_lock(&(info
->lock
));
354 iir
= inb(iobase
+ CONTROL
);
356 int stat
= bt3c_read(iobase
, 0x7001);
358 if ((stat
& 0xff) == 0x7f) {
359 BT_ERR("Very strange (stat=0x%04x)", stat
);
360 } else if ((stat
& 0xff) != 0xff) {
362 int status
= bt3c_read(iobase
, 0x7002) & 0x10;
363 BT_INFO("%s: Antenna %s", info
->hdev
->name
,
364 status
? "out" : "in");
369 //BT_ERR("Ack (stat=0x%04x)", stat);
370 clear_bit(XMIT_SENDING
, &(info
->tx_state
));
371 bt3c_write_wakeup(info
);
374 bt3c_io_write(iobase
, 0x7001, 0x0000);
376 outb(iir
, iobase
+ CONTROL
);
381 spin_unlock(&(info
->lock
));
388 /* ======================== HCI interface ======================== */
391 static int bt3c_hci_flush(struct hci_dev
*hdev
)
393 bt3c_info_t
*info
= (bt3c_info_t
*)(hdev
->driver_data
);
396 skb_queue_purge(&(info
->txq
));
402 static int bt3c_hci_open(struct hci_dev
*hdev
)
404 set_bit(HCI_RUNNING
, &(hdev
->flags
));
410 static int bt3c_hci_close(struct hci_dev
*hdev
)
412 if (!test_and_clear_bit(HCI_RUNNING
, &(hdev
->flags
)))
415 bt3c_hci_flush(hdev
);
421 static int bt3c_hci_send_frame(struct sk_buff
*skb
)
424 struct hci_dev
*hdev
= (struct hci_dev
*)(skb
->dev
);
428 BT_ERR("Frame for unknown HCI device (hdev=NULL)");
432 info
= (bt3c_info_t
*) (hdev
->driver_data
);
434 switch (bt_cb(skb
)->pkt_type
) {
435 case HCI_COMMAND_PKT
:
438 case HCI_ACLDATA_PKT
:
441 case HCI_SCODATA_PKT
:
446 /* Prepend skb with frame type */
447 memcpy(skb_push(skb
, 1), &bt_cb(skb
)->pkt_type
, 1);
448 skb_queue_tail(&(info
->txq
), skb
);
450 spin_lock_irqsave(&(info
->lock
), flags
);
452 bt3c_write_wakeup(info
);
454 spin_unlock_irqrestore(&(info
->lock
), flags
);
460 static void bt3c_hci_destruct(struct hci_dev
*hdev
)
465 static int bt3c_hci_ioctl(struct hci_dev
*hdev
, unsigned int cmd
, unsigned long arg
)
472 /* ======================== Card services HCI interaction ======================== */
475 static int bt3c_load_firmware(bt3c_info_t
*info
, const unsigned char *firmware
,
478 char *ptr
= (char *) firmware
;
480 unsigned int iobase
, size
, addr
, fcs
, tmp
;
483 iobase
= info
->p_dev
->resource
[0]->start
;
486 bt3c_io_write(iobase
, 0x8040, 0x0404);
487 bt3c_io_write(iobase
, 0x8040, 0x0400);
491 bt3c_io_write(iobase
, 0x8040, 0x0404);
498 BT_ERR("Bad address in firmware");
503 memset(b
, 0, sizeof(b
));
504 memcpy(b
, ptr
+ 2, 2);
505 size
= simple_strtoul(b
, NULL
, 16);
507 memset(b
, 0, sizeof(b
));
508 memcpy(b
, ptr
+ 4, 8);
509 addr
= simple_strtoul(b
, NULL
, 16);
511 memset(b
, 0, sizeof(b
));
512 memcpy(b
, ptr
+ (size
* 2) + 2, 2);
513 fcs
= simple_strtoul(b
, NULL
, 16);
515 memset(b
, 0, sizeof(b
));
516 for (tmp
= 0, i
= 0; i
< size
; i
++) {
517 memcpy(b
, ptr
+ (i
* 2) + 2, 2);
518 tmp
+= simple_strtol(b
, NULL
, 16);
521 if (((tmp
+ fcs
) & 0xff) != 0xff) {
522 BT_ERR("Checksum error in firmware");
528 bt3c_address(iobase
, addr
);
530 memset(b
, 0, sizeof(b
));
531 for (i
= 0; i
< (size
- 4) / 2; i
++) {
532 memcpy(b
, ptr
+ (i
* 4) + 12, 4);
533 tmp
= simple_strtoul(b
, NULL
, 16);
534 bt3c_put(iobase
, tmp
);
538 ptr
+= (size
* 2) + 6;
539 count
-= (size
* 2) + 6;
545 bt3c_address(iobase
, 0x3000);
546 outb(inb(iobase
+ CONTROL
) | 0x40, iobase
+ CONTROL
);
552 bt3c_io_write(iobase
, 0x7006, 0x0000);
553 bt3c_io_write(iobase
, 0x7005, 0x0000);
554 bt3c_io_write(iobase
, 0x7001, 0x0000);
560 static int bt3c_open(bt3c_info_t
*info
)
562 const struct firmware
*firmware
;
563 struct hci_dev
*hdev
;
566 spin_lock_init(&(info
->lock
));
568 skb_queue_head_init(&(info
->txq
));
570 info
->rx_state
= RECV_WAIT_PACKET_TYPE
;
574 /* Initialize HCI device */
575 hdev
= hci_alloc_dev();
577 BT_ERR("Can't allocate HCI device");
583 hdev
->bus
= HCI_PCCARD
;
584 hdev
->driver_data
= info
;
585 SET_HCIDEV_DEV(hdev
, &info
->p_dev
->dev
);
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
;
597 err
= request_firmware(&firmware
, "BT3CPCC.bin", &info
->p_dev
->dev
);
599 BT_ERR("Firmware request failed");
603 err
= bt3c_load_firmware(info
, firmware
->data
, firmware
->size
);
605 release_firmware(firmware
);
608 BT_ERR("Firmware loading failed");
612 /* Timeout before it is safe to send the first HCI packet */
615 /* Register HCI device */
616 err
= hci_register_dev(hdev
);
618 BT_ERR("Can't register HCI device");
631 static int bt3c_close(bt3c_info_t
*info
)
633 struct hci_dev
*hdev
= info
->hdev
;
638 bt3c_hci_close(hdev
);
640 if (hci_unregister_dev(hdev
) < 0)
641 BT_ERR("Can't unregister HCI device %s", hdev
->name
);
648 static int bt3c_probe(struct pcmcia_device
*link
)
652 /* Create new info device */
653 info
= kzalloc(sizeof(*info
), GFP_KERNEL
);
660 link
->resource
[0]->flags
|= IO_DATA_PATH_WIDTH_8
;
661 link
->resource
[0]->end
= 8;
663 link
->conf
.Attributes
= CONF_ENABLE_IRQ
;
664 link
->conf
.IntType
= INT_MEMORY_AND_IO
;
666 return bt3c_config(link
);
670 static void bt3c_detach(struct pcmcia_device
*link
)
672 bt3c_info_t
*info
= link
->priv
;
678 static int bt3c_check_config(struct pcmcia_device
*p_dev
,
679 cistpl_cftable_entry_t
*cf
,
680 cistpl_cftable_entry_t
*dflt
,
684 unsigned long try = (unsigned long) priv_data
;
686 p_dev
->io_lines
= (try == 0) ? 16 : cf
->io
.flags
& CISTPL_IO_LINES_MASK
;
688 if (cf
->vpp1
.present
& (1 << CISTPL_POWER_VNOM
))
689 p_dev
->conf
.Vpp
= cf
->vpp1
.param
[CISTPL_POWER_VNOM
] / 10000;
690 if ((cf
->io
.nwin
> 0) && (cf
->io
.win
[0].len
== 8) &&
691 (cf
->io
.win
[0].base
!= 0)) {
692 p_dev
->resource
[0]->start
= cf
->io
.win
[0].base
;
693 if (!pcmcia_request_io(p_dev
))
699 static int bt3c_check_config_notpicky(struct pcmcia_device
*p_dev
,
700 cistpl_cftable_entry_t
*cf
,
701 cistpl_cftable_entry_t
*dflt
,
705 static unsigned int base
[5] = { 0x3f8, 0x2f8, 0x3e8, 0x2e8, 0x0 };
708 if ((cf
->io
.nwin
> 0) && ((cf
->io
.flags
& CISTPL_IO_LINES_MASK
) <= 3)) {
709 for (j
= 0; j
< 5; j
++) {
710 p_dev
->resource
[0]->start
= base
[j
];
711 p_dev
->io_lines
= base
[j
] ? 16 : 3;
712 if (!pcmcia_request_io(p_dev
))
719 static int bt3c_config(struct pcmcia_device
*link
)
721 bt3c_info_t
*info
= link
->priv
;
725 /* First pass: look for a config entry that looks normal.
726 Two tries: without IO aliases, then with aliases */
727 for (try = 0; try < 2; try++)
728 if (!pcmcia_loop_config(link
, bt3c_check_config
, (void *) try))
731 /* Second pass: try to find an entry that isn't picky about
732 its base address, then try to grab any standard serial port
733 address, and finally try to get any free port. */
734 if (!pcmcia_loop_config(link
, bt3c_check_config_notpicky
, NULL
))
737 BT_ERR("No usable port range found");
741 i
= pcmcia_request_irq(link
, &bt3c_interrupt
);
745 i
= pcmcia_request_configuration(link
, &link
->conf
);
749 if (bt3c_open(info
) != 0)
760 static void bt3c_release(struct pcmcia_device
*link
)
762 bt3c_info_t
*info
= link
->priv
;
766 pcmcia_disable_device(link
);
770 static struct pcmcia_device_id bt3c_ids
[] = {
771 PCMCIA_DEVICE_PROD_ID13("3COM", "Bluetooth PC Card", 0xefce0a31, 0xd4ce9b02),
774 MODULE_DEVICE_TABLE(pcmcia
, bt3c_ids
);
776 static struct pcmcia_driver bt3c_driver
= {
777 .owner
= THIS_MODULE
,
782 .remove
= bt3c_detach
,
783 .id_table
= bt3c_ids
,
786 static int __init
init_bt3c_cs(void)
788 return pcmcia_register_driver(&bt3c_driver
);
792 static void __exit
exit_bt3c_cs(void)
794 pcmcia_unregister_driver(&bt3c_driver
);
797 module_init(init_bt3c_cs
);
798 module_exit(exit_bt3c_cs
);