3 * Driver for Bluetooth PCMCIA cards with HCI UART interface
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/delay.h>
30 #include <linux/errno.h>
31 #include <linux/ptrace.h>
32 #include <linux/ioport.h>
33 #include <linux/spinlock.h>
34 #include <linux/moduleparam.h>
36 #include <linux/skbuff.h>
37 #include <linux/string.h>
38 #include <linux/serial.h>
39 #include <linux/serial_reg.h>
40 #include <linux/bitops.h>
43 #include <pcmcia/cistpl.h>
44 #include <pcmcia/ciscode.h>
45 #include <pcmcia/ds.h>
46 #include <pcmcia/cisreg.h>
48 #include <net/bluetooth/bluetooth.h>
49 #include <net/bluetooth/hci_core.h>
53 /* ======================== Module parameters ======================== */
56 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
57 MODULE_DESCRIPTION("Bluetooth driver for Bluetooth PCMCIA cards with HCI UART interface");
58 MODULE_LICENSE("GPL");
62 /* ======================== Local structures ======================== */
65 typedef struct btuart_info_t
{
66 struct pcmcia_device
*p_dev
;
70 spinlock_t lock
; /* For serializing operations */
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
;
81 static int btuart_config(struct pcmcia_device
*link
);
82 static void btuart_release(struct pcmcia_device
*link
);
84 static void btuart_detach(struct pcmcia_device
*p_dev
);
87 /* Maximum baud rate */
88 #define SPEED_MAX 115200
90 /* Default baud rate: 57600, 115200, 230400 or 460800 */
91 #define DEFAULT_BAUD_RATE 115200
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 /* ======================== Interrupt handling ======================== */
111 static int btuart_write(unsigned int iobase
, int fifo_size
, __u8
*buf
, int len
)
115 /* Tx FIFO should be empty */
116 if (!(inb(iobase
+ UART_LSR
) & UART_LSR_THRE
))
119 /* Fill FIFO with current frame */
120 while ((fifo_size
-- > 0) && (actual
< len
)) {
121 /* Transmit next byte */
122 outb(buf
[actual
], iobase
+ UART_TX
);
130 static void btuart_write_wakeup(btuart_info_t
*info
)
133 BT_ERR("Unknown device");
137 if (test_and_set_bit(XMIT_SENDING
, &(info
->tx_state
))) {
138 set_bit(XMIT_WAKEUP
, &(info
->tx_state
));
143 unsigned int iobase
= info
->p_dev
->resource
[0]->start
;
144 register struct sk_buff
*skb
;
147 clear_bit(XMIT_WAKEUP
, &(info
->tx_state
));
149 if (!pcmcia_dev_present(info
->p_dev
))
152 skb
= skb_dequeue(&(info
->txq
));
157 len
= btuart_write(iobase
, 16, skb
->data
, skb
->len
);
158 set_bit(XMIT_WAKEUP
, &(info
->tx_state
));
160 if (len
== skb
->len
) {
164 skb_queue_head(&(info
->txq
), skb
);
167 info
->hdev
->stat
.byte_tx
+= len
;
169 } while (test_bit(XMIT_WAKEUP
, &(info
->tx_state
)));
171 clear_bit(XMIT_SENDING
, &(info
->tx_state
));
175 static void btuart_receive(btuart_info_t
*info
)
181 BT_ERR("Unknown device");
185 iobase
= info
->p_dev
->resource
[0]->start
;
188 info
->hdev
->stat
.byte_rx
++;
190 /* Allocate packet */
191 if (info
->rx_skb
== NULL
) {
192 info
->rx_state
= RECV_WAIT_PACKET_TYPE
;
194 info
->rx_skb
= bt_skb_alloc(HCI_MAX_FRAME_SIZE
, GFP_ATOMIC
);
196 BT_ERR("Can't allocate mem for new packet");
201 if (info
->rx_state
== RECV_WAIT_PACKET_TYPE
) {
203 bt_cb(info
->rx_skb
)->pkt_type
= inb(iobase
+ UART_RX
);
205 switch (bt_cb(info
->rx_skb
)->pkt_type
) {
208 info
->rx_state
= RECV_WAIT_EVENT_HEADER
;
209 info
->rx_count
= HCI_EVENT_HDR_SIZE
;
212 case HCI_ACLDATA_PKT
:
213 info
->rx_state
= RECV_WAIT_ACL_HEADER
;
214 info
->rx_count
= HCI_ACL_HDR_SIZE
;
217 case HCI_SCODATA_PKT
:
218 info
->rx_state
= RECV_WAIT_SCO_HEADER
;
219 info
->rx_count
= HCI_SCO_HDR_SIZE
;
224 BT_ERR("Unknown HCI packet with type 0x%02x received", bt_cb(info
->rx_skb
)->pkt_type
);
225 info
->hdev
->stat
.err_rx
++;
226 clear_bit(HCI_RUNNING
, &(info
->hdev
->flags
));
228 kfree_skb(info
->rx_skb
);
236 *skb_put(info
->rx_skb
, 1) = inb(iobase
+ UART_RX
);
239 if (info
->rx_count
== 0) {
242 struct hci_event_hdr
*eh
;
243 struct hci_acl_hdr
*ah
;
244 struct hci_sco_hdr
*sh
;
247 switch (info
->rx_state
) {
249 case RECV_WAIT_EVENT_HEADER
:
250 eh
= hci_event_hdr(info
->rx_skb
);
251 info
->rx_state
= RECV_WAIT_DATA
;
252 info
->rx_count
= eh
->plen
;
255 case RECV_WAIT_ACL_HEADER
:
256 ah
= hci_acl_hdr(info
->rx_skb
);
257 dlen
= __le16_to_cpu(ah
->dlen
);
258 info
->rx_state
= RECV_WAIT_DATA
;
259 info
->rx_count
= dlen
;
262 case RECV_WAIT_SCO_HEADER
:
263 sh
= hci_sco_hdr(info
->rx_skb
);
264 info
->rx_state
= RECV_WAIT_DATA
;
265 info
->rx_count
= sh
->dlen
;
269 hci_recv_frame(info
->hdev
, info
->rx_skb
);
279 /* Make sure we don't stay here too long */
280 if (boguscount
++ > 16)
283 } while (inb(iobase
+ UART_LSR
) & UART_LSR_DR
);
287 static irqreturn_t
btuart_interrupt(int irq
, void *dev_inst
)
289 btuart_info_t
*info
= dev_inst
;
293 irqreturn_t r
= IRQ_NONE
;
295 if (!info
|| !info
->hdev
)
296 /* our irq handler is shared */
299 iobase
= info
->p_dev
->resource
[0]->start
;
301 spin_lock(&(info
->lock
));
303 iir
= inb(iobase
+ UART_IIR
) & UART_IIR_ID
;
307 /* Clear interrupt */
308 lsr
= inb(iobase
+ UART_LSR
);
315 /* Receive interrupt */
316 btuart_receive(info
);
319 if (lsr
& UART_LSR_THRE
) {
320 /* Transmitter ready for data */
321 btuart_write_wakeup(info
);
325 BT_ERR("Unhandled IIR=%#x", iir
);
329 /* Make sure we don't stay here too long */
330 if (boguscount
++ > 100)
333 iir
= inb(iobase
+ UART_IIR
) & UART_IIR_ID
;
337 spin_unlock(&(info
->lock
));
343 static void btuart_change_speed(btuart_info_t
*info
, unsigned int speed
)
347 int fcr
; /* FIFO control reg */
348 int lcr
; /* Line control reg */
352 BT_ERR("Unknown device");
356 iobase
= info
->p_dev
->resource
[0]->start
;
358 spin_lock_irqsave(&(info
->lock
), flags
);
360 /* Turn off interrupts */
361 outb(0, iobase
+ UART_IER
);
363 divisor
= SPEED_MAX
/ speed
;
365 fcr
= UART_FCR_ENABLE_FIFO
| UART_FCR_CLEAR_RCVR
| UART_FCR_CLEAR_XMIT
;
368 * Use trigger level 1 to avoid 3 ms. timeout delay at 9600 bps, and
369 * almost 1,7 ms at 19200 bps. At speeds above that we can just forget
370 * about this timeout since it will always be fast enough.
374 fcr
|= UART_FCR_TRIGGER_1
;
376 fcr
|= UART_FCR_TRIGGER_14
;
378 /* Bluetooth cards use 8N1 */
379 lcr
= UART_LCR_WLEN8
;
381 outb(UART_LCR_DLAB
| lcr
, iobase
+ UART_LCR
); /* Set DLAB */
382 outb(divisor
& 0xff, iobase
+ UART_DLL
); /* Set speed */
383 outb(divisor
>> 8, iobase
+ UART_DLM
);
384 outb(lcr
, iobase
+ UART_LCR
); /* Set 8N1 */
385 outb(fcr
, iobase
+ UART_FCR
); /* Enable FIFO's */
387 /* Turn on interrupts */
388 outb(UART_IER_RLSI
| UART_IER_RDI
| UART_IER_THRI
, iobase
+ UART_IER
);
390 spin_unlock_irqrestore(&(info
->lock
), flags
);
395 /* ======================== HCI interface ======================== */
398 static int btuart_hci_flush(struct hci_dev
*hdev
)
400 btuart_info_t
*info
= hci_get_drvdata(hdev
);
403 skb_queue_purge(&(info
->txq
));
409 static int btuart_hci_open(struct hci_dev
*hdev
)
411 set_bit(HCI_RUNNING
, &(hdev
->flags
));
417 static int btuart_hci_close(struct hci_dev
*hdev
)
419 if (!test_and_clear_bit(HCI_RUNNING
, &(hdev
->flags
)))
422 btuart_hci_flush(hdev
);
428 static int btuart_hci_send_frame(struct hci_dev
*hdev
, struct sk_buff
*skb
)
430 btuart_info_t
*info
= hci_get_drvdata(hdev
);
432 switch (bt_cb(skb
)->pkt_type
) {
433 case HCI_COMMAND_PKT
:
436 case HCI_ACLDATA_PKT
:
439 case HCI_SCODATA_PKT
:
444 /* Prepend skb with frame type */
445 memcpy(skb_push(skb
, 1), &bt_cb(skb
)->pkt_type
, 1);
446 skb_queue_tail(&(info
->txq
), skb
);
448 btuart_write_wakeup(info
);
455 /* ======================== Card services HCI interaction ======================== */
458 static int btuart_open(btuart_info_t
*info
)
461 unsigned int iobase
= info
->p_dev
->resource
[0]->start
;
462 struct hci_dev
*hdev
;
464 spin_lock_init(&(info
->lock
));
466 skb_queue_head_init(&(info
->txq
));
468 info
->rx_state
= RECV_WAIT_PACKET_TYPE
;
472 /* Initialize HCI device */
473 hdev
= hci_alloc_dev();
475 BT_ERR("Can't allocate HCI device");
481 hdev
->bus
= HCI_PCCARD
;
482 hci_set_drvdata(hdev
, info
);
483 SET_HCIDEV_DEV(hdev
, &info
->p_dev
->dev
);
485 hdev
->open
= btuart_hci_open
;
486 hdev
->close
= btuart_hci_close
;
487 hdev
->flush
= btuart_hci_flush
;
488 hdev
->send
= btuart_hci_send_frame
;
490 spin_lock_irqsave(&(info
->lock
), flags
);
493 outb(0, iobase
+ UART_MCR
);
495 /* Turn off interrupts */
496 outb(0, iobase
+ UART_IER
);
498 /* Initialize UART */
499 outb(UART_LCR_WLEN8
, iobase
+ UART_LCR
); /* Reset DLAB */
500 outb((UART_MCR_DTR
| UART_MCR_RTS
| UART_MCR_OUT2
), iobase
+ UART_MCR
);
502 /* Turn on interrupts */
503 // outb(UART_IER_RLSI | UART_IER_RDI | UART_IER_THRI, iobase + UART_IER);
505 spin_unlock_irqrestore(&(info
->lock
), flags
);
507 btuart_change_speed(info
, DEFAULT_BAUD_RATE
);
509 /* Timeout before it is safe to send the first HCI packet */
512 /* Register HCI device */
513 if (hci_register_dev(hdev
) < 0) {
514 BT_ERR("Can't register HCI device");
524 static int btuart_close(btuart_info_t
*info
)
527 unsigned int iobase
= info
->p_dev
->resource
[0]->start
;
528 struct hci_dev
*hdev
= info
->hdev
;
533 btuart_hci_close(hdev
);
535 spin_lock_irqsave(&(info
->lock
), flags
);
538 outb(0, iobase
+ UART_MCR
);
540 /* Turn off interrupts */
541 outb(0, iobase
+ UART_IER
);
543 spin_unlock_irqrestore(&(info
->lock
), flags
);
545 hci_unregister_dev(hdev
);
551 static int btuart_probe(struct pcmcia_device
*link
)
555 /* Create new info device */
556 info
= devm_kzalloc(&link
->dev
, sizeof(*info
), GFP_KERNEL
);
563 link
->config_flags
|= CONF_ENABLE_IRQ
| CONF_AUTO_SET_VPP
|
566 return btuart_config(link
);
570 static void btuart_detach(struct pcmcia_device
*link
)
572 btuart_release(link
);
575 static int btuart_check_config(struct pcmcia_device
*p_dev
, void *priv_data
)
577 int *try = priv_data
;
580 p_dev
->io_lines
= 16;
582 if ((p_dev
->resource
[0]->end
!= 8) || (p_dev
->resource
[0]->start
== 0))
585 p_dev
->resource
[0]->end
= 8;
586 p_dev
->resource
[0]->flags
&= ~IO_DATA_PATH_WIDTH
;
587 p_dev
->resource
[0]->flags
|= IO_DATA_PATH_WIDTH_8
;
589 return pcmcia_request_io(p_dev
);
592 static int btuart_check_config_notpicky(struct pcmcia_device
*p_dev
,
595 static unsigned int base
[5] = { 0x3f8, 0x2f8, 0x3e8, 0x2e8, 0x0 };
598 if (p_dev
->io_lines
> 3)
601 p_dev
->resource
[0]->flags
&= ~IO_DATA_PATH_WIDTH
;
602 p_dev
->resource
[0]->flags
|= IO_DATA_PATH_WIDTH_8
;
603 p_dev
->resource
[0]->end
= 8;
605 for (j
= 0; j
< 5; j
++) {
606 p_dev
->resource
[0]->start
= base
[j
];
607 p_dev
->io_lines
= base
[j
] ? 16 : 3;
608 if (!pcmcia_request_io(p_dev
))
614 static int btuart_config(struct pcmcia_device
*link
)
616 btuart_info_t
*info
= link
->priv
;
620 /* First pass: look for a config entry that looks normal.
621 Two tries: without IO aliases, then with aliases */
622 for (try = 0; try < 2; try++)
623 if (!pcmcia_loop_config(link
, btuart_check_config
, &try))
626 /* Second pass: try to find an entry that isn't picky about
627 its base address, then try to grab any standard serial port
628 address, and finally try to get any free port. */
629 if (!pcmcia_loop_config(link
, btuart_check_config_notpicky
, NULL
))
632 BT_ERR("No usable port range found");
636 i
= pcmcia_request_irq(link
, btuart_interrupt
);
640 i
= pcmcia_enable_device(link
);
644 if (btuart_open(info
) != 0)
650 btuart_release(link
);
655 static void btuart_release(struct pcmcia_device
*link
)
657 btuart_info_t
*info
= link
->priv
;
661 pcmcia_disable_device(link
);
664 static const struct pcmcia_device_id btuart_ids
[] = {
665 /* don't use this driver. Use serial_cs + hci_uart instead */
668 MODULE_DEVICE_TABLE(pcmcia
, btuart_ids
);
670 static struct pcmcia_driver btuart_driver
= {
671 .owner
= THIS_MODULE
,
673 .probe
= btuart_probe
,
674 .remove
= btuart_detach
,
675 .id_table
= btuart_ids
,
677 module_pcmcia_driver(btuart_driver
);