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>
44 #include <linux/device.h>
45 #include <linux/firmware.h>
47 #include <pcmcia/cistpl.h>
48 #include <pcmcia/ciscode.h>
49 #include <pcmcia/ds.h>
50 #include <pcmcia/cisreg.h>
52 #include <net/bluetooth/bluetooth.h>
53 #include <net/bluetooth/hci_core.h>
57 /* ======================== Module parameters ======================== */
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");
67 /* ======================== Local structures ======================== */
70 typedef struct bt3c_info_t
{
71 struct pcmcia_device
*p_dev
;
75 spinlock_t lock
; /* For serializing operations */
77 struct sk_buff_head txq
;
78 unsigned long tx_state
;
80 unsigned long rx_state
;
81 unsigned long rx_count
;
82 struct sk_buff
*rx_skb
;
86 static int bt3c_config(struct pcmcia_device
*link
);
87 static void bt3c_release(struct pcmcia_device
*link
);
89 static void bt3c_detach(struct pcmcia_device
*p_dev
);
93 #define XMIT_SENDING 1
95 #define XMIT_WAITING 8
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
106 /* ======================== Special I/O functions ======================== */
116 static inline void bt3c_address(unsigned int iobase
, unsigned short addr
)
118 outb(addr
& 0xff, iobase
+ ADDR_L
);
119 outb((addr
>> 8) & 0xff, iobase
+ ADDR_H
);
123 static inline void bt3c_put(unsigned int iobase
, unsigned short value
)
125 outb(value
& 0xff, iobase
+ DATA_L
);
126 outb((value
>> 8) & 0xff, iobase
+ DATA_H
);
130 static inline void bt3c_io_write(unsigned int iobase
, unsigned short addr
, unsigned short value
)
132 bt3c_address(iobase
, addr
);
133 bt3c_put(iobase
, value
);
137 static inline unsigned short bt3c_get(unsigned int iobase
)
139 unsigned short value
= inb(iobase
+ DATA_L
);
141 value
|= inb(iobase
+ DATA_H
) << 8;
147 static inline unsigned short bt3c_read(unsigned int iobase
, unsigned short addr
)
149 bt3c_address(iobase
, addr
);
151 return bt3c_get(iobase
);
156 /* ======================== Interrupt handling ======================== */
159 static int bt3c_write(unsigned int iobase
, int fifo_size
, __u8
*buf
, int len
)
163 bt3c_address(iobase
, 0x7080);
165 /* Fill FIFO with current frame */
166 while (actual
< len
) {
167 /* Transmit next byte */
168 bt3c_put(iobase
, buf
[actual
]);
172 bt3c_io_write(iobase
, 0x7005, actual
);
178 static void bt3c_write_wakeup(bt3c_info_t
*info
)
181 BT_ERR("Unknown device");
185 if (test_and_set_bit(XMIT_SENDING
, &(info
->tx_state
)))
189 unsigned int iobase
= info
->p_dev
->resource
[0]->start
;
190 register struct sk_buff
*skb
;
193 if (!pcmcia_dev_present(info
->p_dev
))
197 if (!(skb
= skb_dequeue(&(info
->txq
)))) {
198 clear_bit(XMIT_SENDING
, &(info
->tx_state
));
203 len
= bt3c_write(iobase
, 256, skb
->data
, skb
->len
);
205 if (len
!= skb
->len
) {
206 BT_ERR("Very strange");
211 info
->hdev
->stat
.byte_tx
+= len
;
217 static void bt3c_receive(bt3c_info_t
*info
)
223 BT_ERR("Unknown device");
227 iobase
= info
->p_dev
->resource
[0]->start
;
229 avail
= bt3c_read(iobase
, 0x7006);
230 //printk("bt3c_cs: receiving %d bytes\n", avail);
232 bt3c_address(iobase
, 0x7480);
233 while (size
< avail
) {
235 info
->hdev
->stat
.byte_rx
++;
237 /* Allocate packet */
238 if (info
->rx_skb
== NULL
) {
239 info
->rx_state
= RECV_WAIT_PACKET_TYPE
;
241 if (!(info
->rx_skb
= bt_skb_alloc(HCI_MAX_FRAME_SIZE
, GFP_ATOMIC
))) {
242 BT_ERR("Can't allocate mem for new packet");
248 if (info
->rx_state
== RECV_WAIT_PACKET_TYPE
) {
250 bt_cb(info
->rx_skb
)->pkt_type
= inb(iobase
+ DATA_L
);
251 inb(iobase
+ DATA_H
);
252 //printk("bt3c: PACKET_TYPE=%02x\n", bt_cb(info->rx_skb)->pkt_type);
254 switch (bt_cb(info
->rx_skb
)->pkt_type
) {
257 info
->rx_state
= RECV_WAIT_EVENT_HEADER
;
258 info
->rx_count
= HCI_EVENT_HDR_SIZE
;
261 case HCI_ACLDATA_PKT
:
262 info
->rx_state
= RECV_WAIT_ACL_HEADER
;
263 info
->rx_count
= HCI_ACL_HDR_SIZE
;
266 case HCI_SCODATA_PKT
:
267 info
->rx_state
= RECV_WAIT_SCO_HEADER
;
268 info
->rx_count
= HCI_SCO_HDR_SIZE
;
273 BT_ERR("Unknown HCI packet with type 0x%02x received", bt_cb(info
->rx_skb
)->pkt_type
);
274 info
->hdev
->stat
.err_rx
++;
275 clear_bit(HCI_RUNNING
, &(info
->hdev
->flags
));
277 kfree_skb(info
->rx_skb
);
285 __u8 x
= inb(iobase
+ DATA_L
);
287 *skb_put(info
->rx_skb
, 1) = x
;
288 inb(iobase
+ DATA_H
);
291 if (info
->rx_count
== 0) {
294 struct hci_event_hdr
*eh
;
295 struct hci_acl_hdr
*ah
;
296 struct hci_sco_hdr
*sh
;
298 switch (info
->rx_state
) {
300 case RECV_WAIT_EVENT_HEADER
:
301 eh
= hci_event_hdr(info
->rx_skb
);
302 info
->rx_state
= RECV_WAIT_DATA
;
303 info
->rx_count
= eh
->plen
;
306 case RECV_WAIT_ACL_HEADER
:
307 ah
= hci_acl_hdr(info
->rx_skb
);
308 dlen
= __le16_to_cpu(ah
->dlen
);
309 info
->rx_state
= RECV_WAIT_DATA
;
310 info
->rx_count
= dlen
;
313 case RECV_WAIT_SCO_HEADER
:
314 sh
= hci_sco_hdr(info
->rx_skb
);
315 info
->rx_state
= RECV_WAIT_DATA
;
316 info
->rx_count
= sh
->dlen
;
320 hci_recv_frame(info
->hdev
, info
->rx_skb
);
332 bt3c_io_write(iobase
, 0x7006, 0x0000);
336 static irqreturn_t
bt3c_interrupt(int irq
, void *dev_inst
)
338 bt3c_info_t
*info
= dev_inst
;
341 irqreturn_t r
= IRQ_NONE
;
343 if (!info
|| !info
->hdev
)
344 /* our irq handler is shared */
347 iobase
= info
->p_dev
->resource
[0]->start
;
349 spin_lock(&(info
->lock
));
351 iir
= inb(iobase
+ CONTROL
);
353 int stat
= bt3c_read(iobase
, 0x7001);
355 if ((stat
& 0xff) == 0x7f) {
356 BT_ERR("Very strange (stat=0x%04x)", stat
);
357 } else if ((stat
& 0xff) != 0xff) {
359 int status
= bt3c_read(iobase
, 0x7002) & 0x10;
360 BT_INFO("%s: Antenna %s", info
->hdev
->name
,
361 status
? "out" : "in");
366 //BT_ERR("Ack (stat=0x%04x)", stat);
367 clear_bit(XMIT_SENDING
, &(info
->tx_state
));
368 bt3c_write_wakeup(info
);
371 bt3c_io_write(iobase
, 0x7001, 0x0000);
373 outb(iir
, iobase
+ CONTROL
);
378 spin_unlock(&(info
->lock
));
385 /* ======================== HCI interface ======================== */
388 static int bt3c_hci_flush(struct hci_dev
*hdev
)
390 bt3c_info_t
*info
= hci_get_drvdata(hdev
);
393 skb_queue_purge(&(info
->txq
));
399 static int bt3c_hci_open(struct hci_dev
*hdev
)
401 set_bit(HCI_RUNNING
, &(hdev
->flags
));
407 static int bt3c_hci_close(struct hci_dev
*hdev
)
409 if (!test_and_clear_bit(HCI_RUNNING
, &(hdev
->flags
)))
412 bt3c_hci_flush(hdev
);
418 static int bt3c_hci_send_frame(struct hci_dev
*hdev
, struct sk_buff
*skb
)
420 bt3c_info_t
*info
= hci_get_drvdata(hdev
);
423 switch (bt_cb(skb
)->pkt_type
) {
424 case HCI_COMMAND_PKT
:
427 case HCI_ACLDATA_PKT
:
430 case HCI_SCODATA_PKT
:
435 /* Prepend skb with frame type */
436 memcpy(skb_push(skb
, 1), &bt_cb(skb
)->pkt_type
, 1);
437 skb_queue_tail(&(info
->txq
), skb
);
439 spin_lock_irqsave(&(info
->lock
), flags
);
441 bt3c_write_wakeup(info
);
443 spin_unlock_irqrestore(&(info
->lock
), flags
);
450 /* ======================== Card services HCI interaction ======================== */
453 static int bt3c_load_firmware(bt3c_info_t
*info
, const unsigned char *firmware
,
456 char *ptr
= (char *) firmware
;
458 unsigned int iobase
, size
, addr
, fcs
, tmp
;
461 iobase
= info
->p_dev
->resource
[0]->start
;
464 bt3c_io_write(iobase
, 0x8040, 0x0404);
465 bt3c_io_write(iobase
, 0x8040, 0x0400);
469 bt3c_io_write(iobase
, 0x8040, 0x0404);
476 BT_ERR("Bad address in firmware");
481 memset(b
, 0, sizeof(b
));
482 memcpy(b
, ptr
+ 2, 2);
483 size
= simple_strtoul(b
, NULL
, 16);
485 memset(b
, 0, sizeof(b
));
486 memcpy(b
, ptr
+ 4, 8);
487 addr
= simple_strtoul(b
, NULL
, 16);
489 memset(b
, 0, sizeof(b
));
490 memcpy(b
, ptr
+ (size
* 2) + 2, 2);
491 fcs
= simple_strtoul(b
, NULL
, 16);
493 memset(b
, 0, sizeof(b
));
494 for (tmp
= 0, i
= 0; i
< size
; i
++) {
495 memcpy(b
, ptr
+ (i
* 2) + 2, 2);
496 tmp
+= simple_strtol(b
, NULL
, 16);
499 if (((tmp
+ fcs
) & 0xff) != 0xff) {
500 BT_ERR("Checksum error in firmware");
506 bt3c_address(iobase
, addr
);
508 memset(b
, 0, sizeof(b
));
509 for (i
= 0; i
< (size
- 4) / 2; i
++) {
510 memcpy(b
, ptr
+ (i
* 4) + 12, 4);
511 tmp
= simple_strtoul(b
, NULL
, 16);
512 bt3c_put(iobase
, tmp
);
516 ptr
+= (size
* 2) + 6;
517 count
-= (size
* 2) + 6;
523 bt3c_address(iobase
, 0x3000);
524 outb(inb(iobase
+ CONTROL
) | 0x40, iobase
+ CONTROL
);
530 bt3c_io_write(iobase
, 0x7006, 0x0000);
531 bt3c_io_write(iobase
, 0x7005, 0x0000);
532 bt3c_io_write(iobase
, 0x7001, 0x0000);
538 static int bt3c_open(bt3c_info_t
*info
)
540 const struct firmware
*firmware
;
541 struct hci_dev
*hdev
;
544 spin_lock_init(&(info
->lock
));
546 skb_queue_head_init(&(info
->txq
));
548 info
->rx_state
= RECV_WAIT_PACKET_TYPE
;
552 /* Initialize HCI device */
553 hdev
= hci_alloc_dev();
555 BT_ERR("Can't allocate HCI device");
561 hdev
->bus
= HCI_PCCARD
;
562 hci_set_drvdata(hdev
, info
);
563 SET_HCIDEV_DEV(hdev
, &info
->p_dev
->dev
);
565 hdev
->open
= bt3c_hci_open
;
566 hdev
->close
= bt3c_hci_close
;
567 hdev
->flush
= bt3c_hci_flush
;
568 hdev
->send
= bt3c_hci_send_frame
;
571 err
= request_firmware(&firmware
, "BT3CPCC.bin", &info
->p_dev
->dev
);
573 BT_ERR("Firmware request failed");
577 err
= bt3c_load_firmware(info
, firmware
->data
, firmware
->size
);
579 release_firmware(firmware
);
582 BT_ERR("Firmware loading failed");
586 /* Timeout before it is safe to send the first HCI packet */
589 /* Register HCI device */
590 err
= hci_register_dev(hdev
);
592 BT_ERR("Can't register HCI device");
605 static int bt3c_close(bt3c_info_t
*info
)
607 struct hci_dev
*hdev
= info
->hdev
;
612 bt3c_hci_close(hdev
);
614 hci_unregister_dev(hdev
);
620 static int bt3c_probe(struct pcmcia_device
*link
)
624 /* Create new info device */
625 info
= devm_kzalloc(&link
->dev
, sizeof(*info
), GFP_KERNEL
);
632 link
->config_flags
|= CONF_ENABLE_IRQ
| CONF_AUTO_SET_VPP
|
635 return bt3c_config(link
);
639 static void bt3c_detach(struct pcmcia_device
*link
)
644 static int bt3c_check_config(struct pcmcia_device
*p_dev
, void *priv_data
)
646 int *try = priv_data
;
649 p_dev
->io_lines
= 16;
651 if ((p_dev
->resource
[0]->end
!= 8) || (p_dev
->resource
[0]->start
== 0))
654 p_dev
->resource
[0]->end
= 8;
655 p_dev
->resource
[0]->flags
&= ~IO_DATA_PATH_WIDTH
;
656 p_dev
->resource
[0]->flags
|= IO_DATA_PATH_WIDTH_8
;
658 return pcmcia_request_io(p_dev
);
661 static int bt3c_check_config_notpicky(struct pcmcia_device
*p_dev
,
664 static unsigned int base
[5] = { 0x3f8, 0x2f8, 0x3e8, 0x2e8, 0x0 };
667 if (p_dev
->io_lines
> 3)
670 p_dev
->resource
[0]->flags
&= ~IO_DATA_PATH_WIDTH
;
671 p_dev
->resource
[0]->flags
|= IO_DATA_PATH_WIDTH_8
;
672 p_dev
->resource
[0]->end
= 8;
674 for (j
= 0; j
< 5; j
++) {
675 p_dev
->resource
[0]->start
= base
[j
];
676 p_dev
->io_lines
= base
[j
] ? 16 : 3;
677 if (!pcmcia_request_io(p_dev
))
683 static int bt3c_config(struct pcmcia_device
*link
)
685 bt3c_info_t
*info
= link
->priv
;
689 /* First pass: look for a config entry that looks normal.
690 Two tries: without IO aliases, then with aliases */
691 for (try = 0; try < 2; try++)
692 if (!pcmcia_loop_config(link
, bt3c_check_config
, (void *) try))
695 /* Second pass: try to find an entry that isn't picky about
696 its base address, then try to grab any standard serial port
697 address, and finally try to get any free port. */
698 if (!pcmcia_loop_config(link
, bt3c_check_config_notpicky
, NULL
))
701 BT_ERR("No usable port range found");
705 i
= pcmcia_request_irq(link
, &bt3c_interrupt
);
709 i
= pcmcia_enable_device(link
);
713 if (bt3c_open(info
) != 0)
724 static void bt3c_release(struct pcmcia_device
*link
)
726 bt3c_info_t
*info
= link
->priv
;
730 pcmcia_disable_device(link
);
734 static const struct pcmcia_device_id bt3c_ids
[] = {
735 PCMCIA_DEVICE_PROD_ID13("3COM", "Bluetooth PC Card", 0xefce0a31, 0xd4ce9b02),
738 MODULE_DEVICE_TABLE(pcmcia
, bt3c_ids
);
740 static struct pcmcia_driver bt3c_driver
= {
741 .owner
= THIS_MODULE
,
744 .remove
= bt3c_detach
,
745 .id_table
= bt3c_ids
,
747 module_pcmcia_driver(bt3c_driver
);