3 * Bluetooth driver for the Anycom BlueCard (LSE039/LSE041)
5 * Copyright (C) 2001-2002 Marcel Holtmann <marcel@holtmann.org>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation;
12 * Software distributed under the License is distributed on an "AS
13 * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
14 * implied. See the License for the specific language governing
15 * rights and limitations under the License.
17 * The initial developer of the original code is David A. Hinds
18 * <dahinds@users.sourceforge.net>. Portions created by David A. Hinds
19 * are Copyright (C) 1999 David A. Hinds. All Rights Reserved.
23 #include <linux/module.h>
25 #include <linux/kernel.h>
26 #include <linux/init.h>
27 #include <linux/slab.h>
28 #include <linux/types.h>
29 #include <linux/sched.h>
30 #include <linux/delay.h>
31 #include <linux/timer.h>
32 #include <linux/errno.h>
33 #include <linux/ptrace.h>
34 #include <linux/ioport.h>
35 #include <linux/spinlock.h>
36 #include <linux/moduleparam.h>
37 #include <linux/wait.h>
39 #include <linux/skbuff.h>
42 #include <pcmcia/cistpl.h>
43 #include <pcmcia/ciscode.h>
44 #include <pcmcia/ds.h>
45 #include <pcmcia/cisreg.h>
47 #include <net/bluetooth/bluetooth.h>
48 #include <net/bluetooth/hci_core.h>
52 /* ======================== Module parameters ======================== */
55 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
56 MODULE_DESCRIPTION("Bluetooth driver for the Anycom BlueCard (LSE039/LSE041)");
57 MODULE_LICENSE("GPL");
61 /* ======================== Local structures ======================== */
64 struct bluecard_info {
65 struct pcmcia_device *p_dev;
69 spinlock_t lock; /* For serializing operations */
70 struct timer_list timer; /* For LED control */
72 struct sk_buff_head txq;
73 unsigned long tx_state;
75 unsigned long rx_state;
76 unsigned long rx_count;
77 struct sk_buff *rx_skb;
79 unsigned char ctrl_reg;
80 unsigned long hw_state; /* Status of the hardware and LED control */
84 static int bluecard_config(struct pcmcia_device *link);
85 static void bluecard_release(struct pcmcia_device *link);
87 static void bluecard_detach(struct pcmcia_device *p_dev);
90 /* Default baud rate: 57600, 115200, 230400 or 460800 */
91 #define DEFAULT_BAUD_RATE 230400
96 #define CARD_HAS_PCCARD_ID 4
97 #define CARD_HAS_POWER_LED 5
98 #define CARD_HAS_ACTIVITY_LED 6
100 /* Transmit states */
101 #define XMIT_SENDING 1
102 #define XMIT_WAKEUP 2
103 #define XMIT_BUFFER_NUMBER 5 /* unset = buffer one, set = buffer two */
104 #define XMIT_BUF_ONE_READY 6
105 #define XMIT_BUF_TWO_READY 7
106 #define XMIT_SENDING_READY 8
108 /* Receiver states */
109 #define RECV_WAIT_PACKET_TYPE 0
110 #define RECV_WAIT_EVENT_HEADER 1
111 #define RECV_WAIT_ACL_HEADER 2
112 #define RECV_WAIT_SCO_HEADER 3
113 #define RECV_WAIT_DATA 4
115 /* Special packet types */
116 #define PKT_BAUD_RATE_57600 0x80
117 #define PKT_BAUD_RATE_115200 0x81
118 #define PKT_BAUD_RATE_230400 0x82
119 #define PKT_BAUD_RATE_460800 0x83
122 /* These are the register offsets */
123 #define REG_COMMAND 0x20
124 #define REG_INTERRUPT 0x21
125 #define REG_CONTROL 0x22
126 #define REG_RX_CONTROL 0x24
127 #define REG_CARD_RESET 0x30
128 #define REG_LED_CTRL 0x30
131 #define REG_COMMAND_TX_BUF_ONE 0x01
132 #define REG_COMMAND_TX_BUF_TWO 0x02
133 #define REG_COMMAND_RX_BUF_ONE 0x04
134 #define REG_COMMAND_RX_BUF_TWO 0x08
135 #define REG_COMMAND_RX_WIN_ONE 0x00
136 #define REG_COMMAND_RX_WIN_TWO 0x10
139 #define REG_CONTROL_BAUD_RATE_57600 0x00
140 #define REG_CONTROL_BAUD_RATE_115200 0x01
141 #define REG_CONTROL_BAUD_RATE_230400 0x02
142 #define REG_CONTROL_BAUD_RATE_460800 0x03
143 #define REG_CONTROL_RTS 0x04
144 #define REG_CONTROL_BT_ON 0x08
145 #define REG_CONTROL_BT_RESET 0x10
146 #define REG_CONTROL_BT_RES_PU 0x20
147 #define REG_CONTROL_INTERRUPT 0x40
148 #define REG_CONTROL_CARD_RESET 0x80
151 #define RTS_LEVEL_SHIFT_BITS 0x02
155 /* ======================== LED handling routines ======================== */
158 static void bluecard_activity_led_timeout(u_long arg)
160 struct bluecard_info *info = (struct bluecard_info *)arg;
161 unsigned int iobase = info->p_dev->resource[0]->start;
163 if (!test_bit(CARD_HAS_PCCARD_ID, &(info->hw_state)))
166 if (test_bit(CARD_HAS_ACTIVITY_LED, &(info->hw_state))) {
167 /* Disable activity LED */
168 outb(0x08 | 0x20, iobase + 0x30);
170 /* Disable power LED */
171 outb(0x00, iobase + 0x30);
176 static void bluecard_enable_activity_led(struct bluecard_info *info)
178 unsigned int iobase = info->p_dev->resource[0]->start;
180 if (!test_bit(CARD_HAS_PCCARD_ID, &(info->hw_state)))
183 if (test_bit(CARD_HAS_ACTIVITY_LED, &(info->hw_state))) {
184 /* Enable activity LED */
185 outb(0x10 | 0x40, iobase + 0x30);
187 /* Stop the LED after HZ/4 */
188 mod_timer(&(info->timer), jiffies + HZ / 4);
190 /* Enable power LED */
191 outb(0x08 | 0x20, iobase + 0x30);
193 /* Stop the LED after HZ/2 */
194 mod_timer(&(info->timer), jiffies + HZ / 2);
200 /* ======================== Interrupt handling ======================== */
203 static int bluecard_write(unsigned int iobase, unsigned int offset, __u8 *buf, int len)
207 actual = (len > 15) ? 15 : len;
209 outb_p(actual, iobase + offset);
211 for (i = 0; i < actual; i++)
212 outb_p(buf[i], iobase + offset + i + 1);
218 static void bluecard_write_wakeup(struct bluecard_info *info)
221 BT_ERR("Unknown device");
225 if (!test_bit(XMIT_SENDING_READY, &(info->tx_state)))
228 if (test_and_set_bit(XMIT_SENDING, &(info->tx_state))) {
229 set_bit(XMIT_WAKEUP, &(info->tx_state));
234 unsigned int iobase = info->p_dev->resource[0]->start;
236 unsigned char command;
237 unsigned long ready_bit;
238 register struct sk_buff *skb;
241 clear_bit(XMIT_WAKEUP, &(info->tx_state));
243 if (!pcmcia_dev_present(info->p_dev))
246 if (test_bit(XMIT_BUFFER_NUMBER, &(info->tx_state))) {
247 if (!test_bit(XMIT_BUF_TWO_READY, &(info->tx_state)))
250 command = REG_COMMAND_TX_BUF_TWO;
251 ready_bit = XMIT_BUF_TWO_READY;
253 if (!test_bit(XMIT_BUF_ONE_READY, &(info->tx_state)))
256 command = REG_COMMAND_TX_BUF_ONE;
257 ready_bit = XMIT_BUF_ONE_READY;
260 skb = skb_dequeue(&(info->txq));
264 if (bt_cb(skb)->pkt_type & 0x80) {
266 info->ctrl_reg |= REG_CONTROL_RTS;
267 outb(info->ctrl_reg, iobase + REG_CONTROL);
271 bluecard_enable_activity_led(info);
274 len = bluecard_write(iobase, offset, skb->data, skb->len);
276 /* Tell the FPGA to send the data */
277 outb_p(command, iobase + REG_COMMAND);
279 /* Mark the buffer as dirty */
280 clear_bit(ready_bit, &(info->tx_state));
282 if (bt_cb(skb)->pkt_type & 0x80) {
283 DECLARE_WAIT_QUEUE_HEAD_ONSTACK(wq);
286 unsigned char baud_reg;
288 switch (bt_cb(skb)->pkt_type) {
289 case PKT_BAUD_RATE_460800:
290 baud_reg = REG_CONTROL_BAUD_RATE_460800;
292 case PKT_BAUD_RATE_230400:
293 baud_reg = REG_CONTROL_BAUD_RATE_230400;
295 case PKT_BAUD_RATE_115200:
296 baud_reg = REG_CONTROL_BAUD_RATE_115200;
298 case PKT_BAUD_RATE_57600:
299 /* Fall through... */
301 baud_reg = REG_CONTROL_BAUD_RATE_57600;
305 /* Wait until the command reaches the baseband */
306 prepare_to_wait(&wq, &wait, TASK_INTERRUPTIBLE);
307 schedule_timeout(HZ/10);
308 finish_wait(&wq, &wait);
310 /* Set baud on baseband */
311 info->ctrl_reg &= ~0x03;
312 info->ctrl_reg |= baud_reg;
313 outb(info->ctrl_reg, iobase + REG_CONTROL);
316 info->ctrl_reg &= ~REG_CONTROL_RTS;
317 outb(info->ctrl_reg, iobase + REG_CONTROL);
319 /* Wait before the next HCI packet can be send */
320 prepare_to_wait(&wq, &wait, TASK_INTERRUPTIBLE);
321 schedule_timeout(HZ);
322 finish_wait(&wq, &wait);
325 if (len == skb->len) {
329 skb_queue_head(&(info->txq), skb);
332 info->hdev->stat.byte_tx += len;
335 change_bit(XMIT_BUFFER_NUMBER, &(info->tx_state));
337 } while (test_bit(XMIT_WAKEUP, &(info->tx_state)));
339 clear_bit(XMIT_SENDING, &(info->tx_state));
343 static int bluecard_read(unsigned int iobase, unsigned int offset, __u8 *buf, int size)
347 outb(REG_COMMAND_RX_WIN_ONE, iobase + REG_COMMAND);
349 len = inb(iobase + offset);
356 outb(REG_COMMAND_RX_WIN_TWO, iobase + REG_COMMAND);
360 buf[n] = inb(iobase + offset + i);
371 static void bluecard_receive(struct bluecard_info *info,
375 unsigned char buf[31];
379 BT_ERR("Unknown device");
383 iobase = info->p_dev->resource[0]->start;
385 if (test_bit(XMIT_SENDING_READY, &(info->tx_state)))
386 bluecard_enable_activity_led(info);
388 len = bluecard_read(iobase, offset, buf, sizeof(buf));
390 for (i = 0; i < len; i++) {
392 /* Allocate packet */
394 info->rx_state = RECV_WAIT_PACKET_TYPE;
396 info->rx_skb = bt_skb_alloc(HCI_MAX_FRAME_SIZE, GFP_ATOMIC);
398 BT_ERR("Can't allocate mem for new packet");
403 if (info->rx_state == RECV_WAIT_PACKET_TYPE) {
405 bt_cb(info->rx_skb)->pkt_type = buf[i];
407 switch (bt_cb(info->rx_skb)->pkt_type) {
411 if (offset != 0x00) {
412 set_bit(XMIT_BUF_ONE_READY, &(info->tx_state));
413 set_bit(XMIT_BUF_TWO_READY, &(info->tx_state));
414 set_bit(XMIT_SENDING_READY, &(info->tx_state));
415 bluecard_write_wakeup(info);
418 kfree_skb(info->rx_skb);
423 info->rx_state = RECV_WAIT_EVENT_HEADER;
424 info->rx_count = HCI_EVENT_HDR_SIZE;
427 case HCI_ACLDATA_PKT:
428 info->rx_state = RECV_WAIT_ACL_HEADER;
429 info->rx_count = HCI_ACL_HDR_SIZE;
432 case HCI_SCODATA_PKT:
433 info->rx_state = RECV_WAIT_SCO_HEADER;
434 info->rx_count = HCI_SCO_HDR_SIZE;
439 BT_ERR("Unknown HCI packet with type 0x%02x received", bt_cb(info->rx_skb)->pkt_type);
440 info->hdev->stat.err_rx++;
442 kfree_skb(info->rx_skb);
450 *skb_put(info->rx_skb, 1) = buf[i];
453 if (info->rx_count == 0) {
456 struct hci_event_hdr *eh;
457 struct hci_acl_hdr *ah;
458 struct hci_sco_hdr *sh;
460 switch (info->rx_state) {
462 case RECV_WAIT_EVENT_HEADER:
463 eh = hci_event_hdr(info->rx_skb);
464 info->rx_state = RECV_WAIT_DATA;
465 info->rx_count = eh->plen;
468 case RECV_WAIT_ACL_HEADER:
469 ah = hci_acl_hdr(info->rx_skb);
470 dlen = __le16_to_cpu(ah->dlen);
471 info->rx_state = RECV_WAIT_DATA;
472 info->rx_count = dlen;
475 case RECV_WAIT_SCO_HEADER:
476 sh = hci_sco_hdr(info->rx_skb);
477 info->rx_state = RECV_WAIT_DATA;
478 info->rx_count = sh->dlen;
482 hci_recv_frame(info->hdev, info->rx_skb);
495 info->hdev->stat.byte_rx += len;
499 static irqreturn_t bluecard_interrupt(int irq, void *dev_inst)
501 struct bluecard_info *info = dev_inst;
505 if (!info || !info->hdev)
506 /* our irq handler is shared */
509 if (!test_bit(CARD_READY, &(info->hw_state)))
512 iobase = info->p_dev->resource[0]->start;
514 spin_lock(&(info->lock));
516 /* Disable interrupt */
517 info->ctrl_reg &= ~REG_CONTROL_INTERRUPT;
518 outb(info->ctrl_reg, iobase + REG_CONTROL);
520 reg = inb(iobase + REG_INTERRUPT);
522 if ((reg != 0x00) && (reg != 0xff)) {
525 bluecard_receive(info, 0x00);
526 outb(0x04, iobase + REG_INTERRUPT);
527 outb(REG_COMMAND_RX_BUF_ONE, iobase + REG_COMMAND);
531 bluecard_receive(info, 0x10);
532 outb(0x08, iobase + REG_INTERRUPT);
533 outb(REG_COMMAND_RX_BUF_TWO, iobase + REG_COMMAND);
537 set_bit(XMIT_BUF_ONE_READY, &(info->tx_state));
538 outb(0x01, iobase + REG_INTERRUPT);
539 bluecard_write_wakeup(info);
543 set_bit(XMIT_BUF_TWO_READY, &(info->tx_state));
544 outb(0x02, iobase + REG_INTERRUPT);
545 bluecard_write_wakeup(info);
550 /* Enable interrupt */
551 info->ctrl_reg |= REG_CONTROL_INTERRUPT;
552 outb(info->ctrl_reg, iobase + REG_CONTROL);
554 spin_unlock(&(info->lock));
561 /* ======================== Device specific HCI commands ======================== */
564 static int bluecard_hci_set_baud_rate(struct hci_dev *hdev, int baud)
566 struct bluecard_info *info = hci_get_drvdata(hdev);
569 /* Ericsson baud rate command */
570 unsigned char cmd[] = { HCI_COMMAND_PKT, 0x09, 0xfc, 0x01, 0x03 };
572 skb = bt_skb_alloc(HCI_MAX_FRAME_SIZE, GFP_ATOMIC);
574 BT_ERR("Can't allocate mem for new packet");
581 bt_cb(skb)->pkt_type = PKT_BAUD_RATE_460800;
585 bt_cb(skb)->pkt_type = PKT_BAUD_RATE_230400;
589 bt_cb(skb)->pkt_type = PKT_BAUD_RATE_115200;
592 /* Fall through... */
595 bt_cb(skb)->pkt_type = PKT_BAUD_RATE_57600;
599 memcpy(skb_put(skb, sizeof(cmd)), cmd, sizeof(cmd));
601 skb_queue_tail(&(info->txq), skb);
603 bluecard_write_wakeup(info);
610 /* ======================== HCI interface ======================== */
613 static int bluecard_hci_flush(struct hci_dev *hdev)
615 struct bluecard_info *info = hci_get_drvdata(hdev);
618 skb_queue_purge(&(info->txq));
624 static int bluecard_hci_open(struct hci_dev *hdev)
626 struct bluecard_info *info = hci_get_drvdata(hdev);
628 if (test_bit(CARD_HAS_PCCARD_ID, &(info->hw_state)))
629 bluecard_hci_set_baud_rate(hdev, DEFAULT_BAUD_RATE);
631 if (test_bit(CARD_HAS_PCCARD_ID, &(info->hw_state))) {
632 unsigned int iobase = info->p_dev->resource[0]->start;
635 outb(0x08 | 0x20, iobase + 0x30);
642 static int bluecard_hci_close(struct hci_dev *hdev)
644 struct bluecard_info *info = hci_get_drvdata(hdev);
646 bluecard_hci_flush(hdev);
648 if (test_bit(CARD_HAS_PCCARD_ID, &(info->hw_state))) {
649 unsigned int iobase = info->p_dev->resource[0]->start;
652 outb(0x00, iobase + 0x30);
659 static int bluecard_hci_send_frame(struct hci_dev *hdev, struct sk_buff *skb)
661 struct bluecard_info *info = hci_get_drvdata(hdev);
663 switch (bt_cb(skb)->pkt_type) {
664 case HCI_COMMAND_PKT:
667 case HCI_ACLDATA_PKT:
670 case HCI_SCODATA_PKT:
675 /* Prepend skb with frame type */
676 memcpy(skb_push(skb, 1), &bt_cb(skb)->pkt_type, 1);
677 skb_queue_tail(&(info->txq), skb);
679 bluecard_write_wakeup(info);
686 /* ======================== Card services HCI interaction ======================== */
689 static int bluecard_open(struct bluecard_info *info)
691 unsigned int iobase = info->p_dev->resource[0]->start;
692 struct hci_dev *hdev;
695 spin_lock_init(&(info->lock));
697 init_timer(&(info->timer));
698 info->timer.function = &bluecard_activity_led_timeout;
699 info->timer.data = (u_long)info;
701 skb_queue_head_init(&(info->txq));
703 info->rx_state = RECV_WAIT_PACKET_TYPE;
707 /* Initialize HCI device */
708 hdev = hci_alloc_dev();
710 BT_ERR("Can't allocate HCI device");
716 hdev->bus = HCI_PCCARD;
717 hci_set_drvdata(hdev, info);
718 SET_HCIDEV_DEV(hdev, &info->p_dev->dev);
720 hdev->open = bluecard_hci_open;
721 hdev->close = bluecard_hci_close;
722 hdev->flush = bluecard_hci_flush;
723 hdev->send = bluecard_hci_send_frame;
725 id = inb(iobase + 0x30);
727 if ((id & 0x0f) == 0x02)
728 set_bit(CARD_HAS_PCCARD_ID, &(info->hw_state));
731 set_bit(CARD_HAS_POWER_LED, &(info->hw_state));
734 set_bit(CARD_HAS_ACTIVITY_LED, &(info->hw_state));
737 info->ctrl_reg = REG_CONTROL_BT_RESET | REG_CONTROL_CARD_RESET;
738 outb(info->ctrl_reg, iobase + REG_CONTROL);
741 outb(0x80, iobase + 0x30);
747 outb(0x00, iobase + 0x30);
750 info->ctrl_reg = REG_CONTROL_BT_ON | REG_CONTROL_BT_RES_PU;
751 outb(info->ctrl_reg, iobase + REG_CONTROL);
753 /* Enable interrupt */
754 outb(0xff, iobase + REG_INTERRUPT);
755 info->ctrl_reg |= REG_CONTROL_INTERRUPT;
756 outb(info->ctrl_reg, iobase + REG_CONTROL);
758 if ((id & 0x0f) == 0x03) {
760 info->ctrl_reg |= REG_CONTROL_RTS;
761 outb(info->ctrl_reg, iobase + REG_CONTROL);
764 info->ctrl_reg |= 0x03;
765 outb(info->ctrl_reg, iobase + REG_CONTROL);
768 info->ctrl_reg &= ~REG_CONTROL_RTS;
769 outb(info->ctrl_reg, iobase + REG_CONTROL);
771 set_bit(XMIT_BUF_ONE_READY, &(info->tx_state));
772 set_bit(XMIT_BUF_TWO_READY, &(info->tx_state));
773 set_bit(XMIT_SENDING_READY, &(info->tx_state));
776 /* Start the RX buffers */
777 outb(REG_COMMAND_RX_BUF_ONE, iobase + REG_COMMAND);
778 outb(REG_COMMAND_RX_BUF_TWO, iobase + REG_COMMAND);
780 /* Signal that the hardware is ready */
781 set_bit(CARD_READY, &(info->hw_state));
784 skb_queue_purge(&(info->txq));
786 /* Control the point at which RTS is enabled */
787 outb((0x0f << RTS_LEVEL_SHIFT_BITS) | 1, iobase + REG_RX_CONTROL);
789 /* Timeout before it is safe to send the first HCI packet */
792 /* Register HCI device */
793 if (hci_register_dev(hdev) < 0) {
794 BT_ERR("Can't register HCI device");
804 static int bluecard_close(struct bluecard_info *info)
806 unsigned int iobase = info->p_dev->resource[0]->start;
807 struct hci_dev *hdev = info->hdev;
812 bluecard_hci_close(hdev);
814 clear_bit(CARD_READY, &(info->hw_state));
817 info->ctrl_reg = REG_CONTROL_BT_RESET | REG_CONTROL_CARD_RESET;
818 outb(info->ctrl_reg, iobase + REG_CONTROL);
821 outb(0x80, iobase + 0x30);
823 hci_unregister_dev(hdev);
829 static int bluecard_probe(struct pcmcia_device *link)
831 struct bluecard_info *info;
833 /* Create new info device */
834 info = devm_kzalloc(&link->dev, sizeof(*info), GFP_KERNEL);
841 link->config_flags |= CONF_ENABLE_IRQ;
843 return bluecard_config(link);
847 static void bluecard_detach(struct pcmcia_device *link)
849 bluecard_release(link);
853 static int bluecard_config(struct pcmcia_device *link)
855 struct bluecard_info *info = link->priv;
858 link->config_index = 0x20;
860 link->resource[0]->flags |= IO_DATA_PATH_WIDTH_8;
861 link->resource[0]->end = 64;
864 for (n = 0; n < 0x400; n += 0x40) {
865 link->resource[0]->start = n ^ 0x300;
866 i = pcmcia_request_io(link);
874 i = pcmcia_request_irq(link, bluecard_interrupt);
878 i = pcmcia_enable_device(link);
882 if (bluecard_open(info) != 0)
888 bluecard_release(link);
893 static void bluecard_release(struct pcmcia_device *link)
895 struct bluecard_info *info = link->priv;
897 bluecard_close(info);
899 del_timer_sync(&(info->timer));
901 pcmcia_disable_device(link);
904 static const struct pcmcia_device_id bluecard_ids[] = {
905 PCMCIA_DEVICE_PROD_ID12("BlueCard", "LSE041", 0xbaf16fbf, 0x657cc15e),
906 PCMCIA_DEVICE_PROD_ID12("BTCFCARD", "LSE139", 0xe3987764, 0x2524b59c),
907 PCMCIA_DEVICE_PROD_ID12("WSS", "LSE039", 0x0a0736ec, 0x24e6dfab),
910 MODULE_DEVICE_TABLE(pcmcia, bluecard_ids);
912 static struct pcmcia_driver bluecard_driver = {
913 .owner = THIS_MODULE,
914 .name = "bluecard_cs",
915 .probe = bluecard_probe,
916 .remove = bluecard_detach,
917 .id_table = bluecard_ids,
919 module_pcmcia_driver(bluecard_driver);