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 ======================== */
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(struct btuart_info
*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(struct btuart_info
*info
)
181 BT_ERR("Unknown device");
185 iobase
= info
->p_dev
->resource
[0]->start
;
188 info
->hdev
->stat
.byte_rx
++;
190 /* Allocate packet */
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 hci_skb_pkt_type(info
->rx_skb
) = inb(iobase
+ UART_RX
);
205 switch (hci_skb_pkt_type(info
->rx_skb
)) {
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",
225 hci_skb_pkt_type(info
->rx_skb
));
226 info
->hdev
->stat
.err_rx
++;
228 kfree_skb(info
->rx_skb
);
236 skb_put_u8(info
->rx_skb
, 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 struct btuart_info
*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(struct btuart_info
*info
,
348 int fcr
; /* FIFO control reg */
349 int lcr
; /* Line control reg */
353 BT_ERR("Unknown device");
357 iobase
= info
->p_dev
->resource
[0]->start
;
359 spin_lock_irqsave(&(info
->lock
), flags
);
361 /* Turn off interrupts */
362 outb(0, iobase
+ UART_IER
);
364 divisor
= SPEED_MAX
/ speed
;
366 fcr
= UART_FCR_ENABLE_FIFO
| UART_FCR_CLEAR_RCVR
| UART_FCR_CLEAR_XMIT
;
369 * Use trigger level 1 to avoid 3 ms. timeout delay at 9600 bps, and
370 * almost 1,7 ms at 19200 bps. At speeds above that we can just forget
371 * about this timeout since it will always be fast enough.
375 fcr
|= UART_FCR_TRIGGER_1
;
377 fcr
|= UART_FCR_TRIGGER_14
;
379 /* Bluetooth cards use 8N1 */
380 lcr
= UART_LCR_WLEN8
;
382 outb(UART_LCR_DLAB
| lcr
, iobase
+ UART_LCR
); /* Set DLAB */
383 outb(divisor
& 0xff, iobase
+ UART_DLL
); /* Set speed */
384 outb(divisor
>> 8, iobase
+ UART_DLM
);
385 outb(lcr
, iobase
+ UART_LCR
); /* Set 8N1 */
386 outb(fcr
, iobase
+ UART_FCR
); /* Enable FIFO's */
388 /* Turn on interrupts */
389 outb(UART_IER_RLSI
| UART_IER_RDI
| UART_IER_THRI
, iobase
+ UART_IER
);
391 spin_unlock_irqrestore(&(info
->lock
), flags
);
396 /* ======================== HCI interface ======================== */
399 static int btuart_hci_flush(struct hci_dev
*hdev
)
401 struct btuart_info
*info
= hci_get_drvdata(hdev
);
404 skb_queue_purge(&(info
->txq
));
410 static int btuart_hci_open(struct hci_dev
*hdev
)
416 static int btuart_hci_close(struct hci_dev
*hdev
)
418 btuart_hci_flush(hdev
);
424 static int btuart_hci_send_frame(struct hci_dev
*hdev
, struct sk_buff
*skb
)
426 struct btuart_info
*info
= hci_get_drvdata(hdev
);
428 switch (hci_skb_pkt_type(skb
)) {
429 case HCI_COMMAND_PKT
:
432 case HCI_ACLDATA_PKT
:
435 case HCI_SCODATA_PKT
:
440 /* Prepend skb with frame type */
441 memcpy(skb_push(skb
, 1), &hci_skb_pkt_type(skb
), 1);
442 skb_queue_tail(&(info
->txq
), skb
);
444 btuart_write_wakeup(info
);
451 /* ======================== Card services HCI interaction ======================== */
454 static int btuart_open(struct btuart_info
*info
)
457 unsigned int iobase
= info
->p_dev
->resource
[0]->start
;
458 struct hci_dev
*hdev
;
460 spin_lock_init(&(info
->lock
));
462 skb_queue_head_init(&(info
->txq
));
464 info
->rx_state
= RECV_WAIT_PACKET_TYPE
;
468 /* Initialize HCI device */
469 hdev
= hci_alloc_dev();
471 BT_ERR("Can't allocate HCI device");
477 hdev
->bus
= HCI_PCCARD
;
478 hci_set_drvdata(hdev
, info
);
479 SET_HCIDEV_DEV(hdev
, &info
->p_dev
->dev
);
481 hdev
->open
= btuart_hci_open
;
482 hdev
->close
= btuart_hci_close
;
483 hdev
->flush
= btuart_hci_flush
;
484 hdev
->send
= btuart_hci_send_frame
;
486 spin_lock_irqsave(&(info
->lock
), flags
);
489 outb(0, iobase
+ UART_MCR
);
491 /* Turn off interrupts */
492 outb(0, iobase
+ UART_IER
);
494 /* Initialize UART */
495 outb(UART_LCR_WLEN8
, iobase
+ UART_LCR
); /* Reset DLAB */
496 outb((UART_MCR_DTR
| UART_MCR_RTS
| UART_MCR_OUT2
), iobase
+ UART_MCR
);
498 /* Turn on interrupts */
499 // outb(UART_IER_RLSI | UART_IER_RDI | UART_IER_THRI, iobase + UART_IER);
501 spin_unlock_irqrestore(&(info
->lock
), flags
);
503 btuart_change_speed(info
, DEFAULT_BAUD_RATE
);
505 /* Timeout before it is safe to send the first HCI packet */
508 /* Register HCI device */
509 if (hci_register_dev(hdev
) < 0) {
510 BT_ERR("Can't register HCI device");
520 static int btuart_close(struct btuart_info
*info
)
523 unsigned int iobase
= info
->p_dev
->resource
[0]->start
;
524 struct hci_dev
*hdev
= info
->hdev
;
529 btuart_hci_close(hdev
);
531 spin_lock_irqsave(&(info
->lock
), flags
);
534 outb(0, iobase
+ UART_MCR
);
536 /* Turn off interrupts */
537 outb(0, iobase
+ UART_IER
);
539 spin_unlock_irqrestore(&(info
->lock
), flags
);
541 hci_unregister_dev(hdev
);
547 static int btuart_probe(struct pcmcia_device
*link
)
549 struct btuart_info
*info
;
551 /* Create new info device */
552 info
= devm_kzalloc(&link
->dev
, sizeof(*info
), GFP_KERNEL
);
559 link
->config_flags
|= CONF_ENABLE_IRQ
| CONF_AUTO_SET_VPP
|
562 return btuart_config(link
);
566 static void btuart_detach(struct pcmcia_device
*link
)
568 btuart_release(link
);
571 static int btuart_check_config(struct pcmcia_device
*p_dev
, void *priv_data
)
573 int *try = priv_data
;
576 p_dev
->io_lines
= 16;
578 if ((p_dev
->resource
[0]->end
!= 8) || (p_dev
->resource
[0]->start
== 0))
581 p_dev
->resource
[0]->end
= 8;
582 p_dev
->resource
[0]->flags
&= ~IO_DATA_PATH_WIDTH
;
583 p_dev
->resource
[0]->flags
|= IO_DATA_PATH_WIDTH_8
;
585 return pcmcia_request_io(p_dev
);
588 static int btuart_check_config_notpicky(struct pcmcia_device
*p_dev
,
591 static unsigned int base
[5] = { 0x3f8, 0x2f8, 0x3e8, 0x2e8, 0x0 };
594 if (p_dev
->io_lines
> 3)
597 p_dev
->resource
[0]->flags
&= ~IO_DATA_PATH_WIDTH
;
598 p_dev
->resource
[0]->flags
|= IO_DATA_PATH_WIDTH_8
;
599 p_dev
->resource
[0]->end
= 8;
601 for (j
= 0; j
< 5; j
++) {
602 p_dev
->resource
[0]->start
= base
[j
];
603 p_dev
->io_lines
= base
[j
] ? 16 : 3;
604 if (!pcmcia_request_io(p_dev
))
610 static int btuart_config(struct pcmcia_device
*link
)
612 struct btuart_info
*info
= link
->priv
;
616 /* First pass: look for a config entry that looks normal.
617 * Two tries: without IO aliases, then with aliases
619 for (try = 0; try < 2; try++)
620 if (!pcmcia_loop_config(link
, btuart_check_config
, &try))
623 /* Second pass: try to find an entry that isn't picky about
624 * its base address, then try to grab any standard serial port
625 * address, and finally try to get any free port.
627 if (!pcmcia_loop_config(link
, btuart_check_config_notpicky
, NULL
))
630 BT_ERR("No usable port range found");
634 i
= pcmcia_request_irq(link
, btuart_interrupt
);
638 i
= pcmcia_enable_device(link
);
642 if (btuart_open(info
) != 0)
648 btuart_release(link
);
653 static void btuart_release(struct pcmcia_device
*link
)
655 struct btuart_info
*info
= link
->priv
;
659 pcmcia_disable_device(link
);
662 static const struct pcmcia_device_id btuart_ids
[] = {
663 /* don't use this driver. Use serial_cs + hci_uart instead */
666 MODULE_DEVICE_TABLE(pcmcia
, btuart_ids
);
668 static struct pcmcia_driver btuart_driver
= {
669 .owner
= THIS_MODULE
,
671 .probe
= btuart_probe
,
672 .remove
= btuart_detach
,
673 .id_table
= btuart_ids
,
675 module_pcmcia_driver(btuart_driver
);