3 * A driver for Nokia Connectivity Card DTL-1 devices
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>
41 #include <asm/system.h>
44 #include <pcmcia/cs_types.h>
45 #include <pcmcia/cs.h>
46 #include <pcmcia/cistpl.h>
47 #include <pcmcia/ciscode.h>
48 #include <pcmcia/ds.h>
49 #include <pcmcia/cisreg.h>
51 #include <net/bluetooth/bluetooth.h>
52 #include <net/bluetooth/hci_core.h>
56 /* ======================== Module parameters ======================== */
59 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
60 MODULE_DESCRIPTION("Bluetooth driver for Nokia Connectivity Card DTL-1");
61 MODULE_LICENSE("GPL");
65 /* ======================== Local structures ======================== */
68 typedef struct dtl1_info_t
{
69 struct pcmcia_device
*p_dev
;
74 spinlock_t lock
; /* For serializing operations */
76 unsigned long flowmask
; /* HCI flow mask */
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 dtl1_config(struct pcmcia_device
*link
);
89 static void dtl1_release(struct pcmcia_device
*link
);
91 static void dtl1_detach(struct pcmcia_device
*p_dev
);
95 #define XMIT_SENDING 1
97 #define XMIT_WAITING 8
100 #define RECV_WAIT_NSH 0
101 #define RECV_WAIT_DATA 1
108 } __attribute__ ((packed
)) nsh_t
; /* Nokia Specific Header */
110 #define NSHL 4 /* Nokia Specific Header Length */
114 /* ======================== Interrupt handling ======================== */
117 static int dtl1_write(unsigned int iobase
, int fifo_size
, __u8
*buf
, int len
)
121 /* Tx FIFO should be empty */
122 if (!(inb(iobase
+ UART_LSR
) & UART_LSR_THRE
))
125 /* Fill FIFO with current frame */
126 while ((fifo_size
-- > 0) && (actual
< len
)) {
127 /* Transmit next byte */
128 outb(buf
[actual
], iobase
+ UART_TX
);
136 static void dtl1_write_wakeup(dtl1_info_t
*info
)
139 BT_ERR("Unknown device");
143 if (test_bit(XMIT_WAITING
, &(info
->tx_state
))) {
144 set_bit(XMIT_WAKEUP
, &(info
->tx_state
));
148 if (test_and_set_bit(XMIT_SENDING
, &(info
->tx_state
))) {
149 set_bit(XMIT_WAKEUP
, &(info
->tx_state
));
154 register unsigned int iobase
= info
->p_dev
->io
.BasePort1
;
155 register struct sk_buff
*skb
;
158 clear_bit(XMIT_WAKEUP
, &(info
->tx_state
));
160 if (!pcmcia_dev_present(info
->p_dev
))
163 if (!(skb
= skb_dequeue(&(info
->txq
))))
167 len
= dtl1_write(iobase
, 32, skb
->data
, skb
->len
);
169 if (len
== skb
->len
) {
170 set_bit(XMIT_WAITING
, &(info
->tx_state
));
174 skb_queue_head(&(info
->txq
), skb
);
177 info
->hdev
->stat
.byte_tx
+= len
;
179 } while (test_bit(XMIT_WAKEUP
, &(info
->tx_state
)));
181 clear_bit(XMIT_SENDING
, &(info
->tx_state
));
185 static void dtl1_control(dtl1_info_t
*info
, struct sk_buff
*skb
)
187 u8 flowmask
= *(u8
*)skb
->data
;
190 printk(KERN_INFO
"Bluetooth: Nokia control data =");
191 for (i
= 0; i
< skb
->len
; i
++) {
192 printk(" %02x", skb
->data
[i
]);
196 /* transition to active state */
197 if (((info
->flowmask
& 0x07) == 0) && ((flowmask
& 0x07) != 0)) {
198 clear_bit(XMIT_WAITING
, &(info
->tx_state
));
199 dtl1_write_wakeup(info
);
202 info
->flowmask
= flowmask
;
208 static void dtl1_receive(dtl1_info_t
*info
)
215 BT_ERR("Unknown device");
219 iobase
= info
->p_dev
->io
.BasePort1
;
222 info
->hdev
->stat
.byte_rx
++;
224 /* Allocate packet */
225 if (info
->rx_skb
== NULL
)
226 if (!(info
->rx_skb
= bt_skb_alloc(HCI_MAX_FRAME_SIZE
, GFP_ATOMIC
))) {
227 BT_ERR("Can't allocate mem for new packet");
228 info
->rx_state
= RECV_WAIT_NSH
;
229 info
->rx_count
= NSHL
;
233 *skb_put(info
->rx_skb
, 1) = inb(iobase
+ UART_RX
);
234 nsh
= (nsh_t
*)info
->rx_skb
->data
;
238 if (info
->rx_count
== 0) {
240 switch (info
->rx_state
) {
242 info
->rx_state
= RECV_WAIT_DATA
;
243 info
->rx_count
= nsh
->len
+ (nsh
->len
& 0x0001);
246 bt_cb(info
->rx_skb
)->pkt_type
= nsh
->type
;
248 /* remove PAD byte if it exists */
249 if (nsh
->len
& 0x0001) {
250 info
->rx_skb
->tail
--;
255 skb_pull(info
->rx_skb
, NSHL
);
257 switch (bt_cb(info
->rx_skb
)->pkt_type
) {
259 /* control data for the Nokia Card */
260 dtl1_control(info
, info
->rx_skb
);
265 /* send frame to the HCI layer */
266 info
->rx_skb
->dev
= (void *) info
->hdev
;
267 bt_cb(info
->rx_skb
)->pkt_type
&= 0x0f;
268 hci_recv_frame(info
->rx_skb
);
272 BT_ERR("Unknown HCI packet with type 0x%02x received", bt_cb(info
->rx_skb
)->pkt_type
);
273 kfree_skb(info
->rx_skb
);
277 info
->rx_state
= RECV_WAIT_NSH
;
278 info
->rx_count
= NSHL
;
285 /* Make sure we don't stay here too long */
286 if (boguscount
++ > 32)
289 } while (inb(iobase
+ UART_LSR
) & UART_LSR_DR
);
293 static irqreturn_t
dtl1_interrupt(int irq
, void *dev_inst
)
295 dtl1_info_t
*info
= dev_inst
;
301 if (!info
|| !info
->hdev
) {
302 BT_ERR("Call of irq %d for unknown device", irq
);
306 iobase
= info
->p_dev
->io
.BasePort1
;
308 spin_lock(&(info
->lock
));
310 iir
= inb(iobase
+ UART_IIR
) & UART_IIR_ID
;
313 /* Clear interrupt */
314 lsr
= inb(iobase
+ UART_LSR
);
321 /* Receive interrupt */
325 if (lsr
& UART_LSR_THRE
) {
326 /* Transmitter ready for data */
327 dtl1_write_wakeup(info
);
331 BT_ERR("Unhandled IIR=%#x", iir
);
335 /* Make sure we don't stay here too long */
336 if (boguscount
++ > 100)
339 iir
= inb(iobase
+ UART_IIR
) & UART_IIR_ID
;
343 msr
= inb(iobase
+ UART_MSR
);
345 if (info
->ri_latch
^ (msr
& UART_MSR_RI
)) {
346 info
->ri_latch
= msr
& UART_MSR_RI
;
347 clear_bit(XMIT_WAITING
, &(info
->tx_state
));
348 dtl1_write_wakeup(info
);
351 spin_unlock(&(info
->lock
));
358 /* ======================== HCI interface ======================== */
361 static int dtl1_hci_open(struct hci_dev
*hdev
)
363 set_bit(HCI_RUNNING
, &(hdev
->flags
));
369 static int dtl1_hci_flush(struct hci_dev
*hdev
)
371 dtl1_info_t
*info
= (dtl1_info_t
*)(hdev
->driver_data
);
374 skb_queue_purge(&(info
->txq
));
380 static int dtl1_hci_close(struct hci_dev
*hdev
)
382 if (!test_and_clear_bit(HCI_RUNNING
, &(hdev
->flags
)))
385 dtl1_hci_flush(hdev
);
391 static int dtl1_hci_send_frame(struct sk_buff
*skb
)
394 struct hci_dev
*hdev
= (struct hci_dev
*)(skb
->dev
);
399 BT_ERR("Frame for unknown HCI device (hdev=NULL)");
403 info
= (dtl1_info_t
*)(hdev
->driver_data
);
405 switch (bt_cb(skb
)->pkt_type
) {
406 case HCI_COMMAND_PKT
:
410 case HCI_ACLDATA_PKT
:
414 case HCI_SCODATA_PKT
:
423 s
= bt_skb_alloc(NSHL
+ skb
->len
+ 1, GFP_ATOMIC
);
427 skb_reserve(s
, NSHL
);
428 skb_copy_from_linear_data(skb
, skb_put(s
, skb
->len
), skb
->len
);
429 if (skb
->len
& 0x0001)
430 *skb_put(s
, 1) = 0; /* PAD */
432 /* Prepend skb with Nokia frame header and queue */
433 memcpy(skb_push(s
, NSHL
), &nsh
, NSHL
);
434 skb_queue_tail(&(info
->txq
), s
);
436 dtl1_write_wakeup(info
);
444 static void dtl1_hci_destruct(struct hci_dev
*hdev
)
449 static int dtl1_hci_ioctl(struct hci_dev
*hdev
, unsigned int cmd
, unsigned long arg
)
456 /* ======================== Card services HCI interaction ======================== */
459 static int dtl1_open(dtl1_info_t
*info
)
462 unsigned int iobase
= info
->p_dev
->io
.BasePort1
;
463 struct hci_dev
*hdev
;
465 spin_lock_init(&(info
->lock
));
467 skb_queue_head_init(&(info
->txq
));
469 info
->rx_state
= RECV_WAIT_NSH
;
470 info
->rx_count
= NSHL
;
473 set_bit(XMIT_WAITING
, &(info
->tx_state
));
475 /* Initialize HCI device */
476 hdev
= hci_alloc_dev();
478 BT_ERR("Can't allocate HCI device");
484 hdev
->type
= HCI_PCCARD
;
485 hdev
->driver_data
= info
;
486 SET_HCIDEV_DEV(hdev
, &info
->p_dev
->dev
);
488 hdev
->open
= dtl1_hci_open
;
489 hdev
->close
= dtl1_hci_close
;
490 hdev
->flush
= dtl1_hci_flush
;
491 hdev
->send
= dtl1_hci_send_frame
;
492 hdev
->destruct
= dtl1_hci_destruct
;
493 hdev
->ioctl
= dtl1_hci_ioctl
;
495 hdev
->owner
= THIS_MODULE
;
497 spin_lock_irqsave(&(info
->lock
), flags
);
500 outb(0, iobase
+ UART_MCR
);
502 /* Turn off interrupts */
503 outb(0, iobase
+ UART_IER
);
505 /* Initialize UART */
506 outb(UART_LCR_WLEN8
, iobase
+ UART_LCR
); /* Reset DLAB */
507 outb((UART_MCR_DTR
| UART_MCR_RTS
| UART_MCR_OUT2
), iobase
+ UART_MCR
);
509 info
->ri_latch
= inb(info
->p_dev
->io
.BasePort1
+ UART_MSR
) & UART_MSR_RI
;
511 /* Turn on interrupts */
512 outb(UART_IER_RLSI
| UART_IER_RDI
| UART_IER_THRI
, iobase
+ UART_IER
);
514 spin_unlock_irqrestore(&(info
->lock
), flags
);
516 /* Timeout before it is safe to send the first HCI packet */
519 /* Register HCI device */
520 if (hci_register_dev(hdev
) < 0) {
521 BT_ERR("Can't register HCI device");
531 static int dtl1_close(dtl1_info_t
*info
)
534 unsigned int iobase
= info
->p_dev
->io
.BasePort1
;
535 struct hci_dev
*hdev
= info
->hdev
;
540 dtl1_hci_close(hdev
);
542 spin_lock_irqsave(&(info
->lock
), flags
);
545 outb(0, iobase
+ UART_MCR
);
547 /* Turn off interrupts */
548 outb(0, iobase
+ UART_IER
);
550 spin_unlock_irqrestore(&(info
->lock
), flags
);
552 if (hci_unregister_dev(hdev
) < 0)
553 BT_ERR("Can't unregister HCI device %s", hdev
->name
);
560 static int dtl1_probe(struct pcmcia_device
*link
)
564 /* Create new info device */
565 info
= kzalloc(sizeof(*info
), GFP_KERNEL
);
572 link
->io
.Attributes1
= IO_DATA_PATH_WIDTH_8
;
573 link
->io
.NumPorts1
= 8;
574 link
->irq
.Attributes
= IRQ_TYPE_EXCLUSIVE
| IRQ_HANDLE_PRESENT
;
575 link
->irq
.IRQInfo1
= IRQ_LEVEL_ID
;
577 link
->irq
.Handler
= dtl1_interrupt
;
578 link
->irq
.Instance
= info
;
580 link
->conf
.Attributes
= CONF_ENABLE_IRQ
;
581 link
->conf
.IntType
= INT_MEMORY_AND_IO
;
583 return dtl1_config(link
);
587 static void dtl1_detach(struct pcmcia_device
*link
)
589 dtl1_info_t
*info
= link
->priv
;
596 static int get_tuple(struct pcmcia_device
*handle
, tuple_t
*tuple
, cisparse_t
*parse
)
600 i
= pcmcia_get_tuple_data(handle
, tuple
);
604 return pcmcia_parse_tuple(handle
, tuple
, parse
);
607 static int first_tuple(struct pcmcia_device
*handle
, tuple_t
*tuple
, cisparse_t
*parse
)
609 if (pcmcia_get_first_tuple(handle
, tuple
) != CS_SUCCESS
)
610 return CS_NO_MORE_ITEMS
;
611 return get_tuple(handle
, tuple
, parse
);
614 static int next_tuple(struct pcmcia_device
*handle
, tuple_t
*tuple
, cisparse_t
*parse
)
616 if (pcmcia_get_next_tuple(handle
, tuple
) != CS_SUCCESS
)
617 return CS_NO_MORE_ITEMS
;
618 return get_tuple(handle
, tuple
, parse
);
621 static int dtl1_config(struct pcmcia_device
*link
)
623 dtl1_info_t
*info
= link
->priv
;
627 cistpl_cftable_entry_t
*cf
= &parse
.cftable_entry
;
630 tuple
.TupleData
= (cisdata_t
*)buf
;
631 tuple
.TupleOffset
= 0;
632 tuple
.TupleDataMax
= 255;
633 tuple
.Attributes
= 0;
634 tuple
.DesiredTuple
= CISTPL_CFTABLE_ENTRY
;
636 /* Look for a generic full-sized window */
637 link
->io
.NumPorts1
= 8;
638 i
= first_tuple(link
, &tuple
, &parse
);
639 while (i
!= CS_NO_MORE_ITEMS
) {
640 if ((i
== CS_SUCCESS
) && (cf
->io
.nwin
== 1) && (cf
->io
.win
[0].len
> 8)) {
641 link
->conf
.ConfigIndex
= cf
->index
;
642 link
->io
.BasePort1
= cf
->io
.win
[0].base
;
643 link
->io
.NumPorts1
= cf
->io
.win
[0].len
; /*yo */
644 link
->io
.IOAddrLines
= cf
->io
.flags
& CISTPL_IO_LINES_MASK
;
645 i
= pcmcia_request_io(link
, &link
->io
);
649 i
= next_tuple(link
, &tuple
, &parse
);
652 if (i
!= CS_SUCCESS
) {
653 cs_error(link
, RequestIO
, i
);
657 i
= pcmcia_request_irq(link
, &link
->irq
);
658 if (i
!= CS_SUCCESS
) {
659 cs_error(link
, RequestIRQ
, i
);
660 link
->irq
.AssignedIRQ
= 0;
663 i
= pcmcia_request_configuration(link
, &link
->conf
);
664 if (i
!= CS_SUCCESS
) {
665 cs_error(link
, RequestConfiguration
, i
);
669 if (dtl1_open(info
) != 0)
672 strcpy(info
->node
.dev_name
, info
->hdev
->name
);
673 link
->dev_node
= &info
->node
;
683 static void dtl1_release(struct pcmcia_device
*link
)
685 dtl1_info_t
*info
= link
->priv
;
689 pcmcia_disable_device(link
);
693 static struct pcmcia_device_id dtl1_ids
[] = {
694 PCMCIA_DEVICE_PROD_ID12("Nokia Mobile Phones", "DTL-1", 0xe1bfdd64, 0xe168480d),
695 PCMCIA_DEVICE_PROD_ID12("Nokia Mobile Phones", "DTL-4", 0xe1bfdd64, 0x9102bc82),
696 PCMCIA_DEVICE_PROD_ID12("Socket", "CF", 0xb38bcc2e, 0x44ebf863),
697 PCMCIA_DEVICE_PROD_ID12("Socket", "CF+ Personal Network Card", 0xb38bcc2e, 0xe732bae3),
700 MODULE_DEVICE_TABLE(pcmcia
, dtl1_ids
);
702 static struct pcmcia_driver dtl1_driver
= {
703 .owner
= THIS_MODULE
,
708 .remove
= dtl1_detach
,
709 .id_table
= dtl1_ids
,
712 static int __init
init_dtl1_cs(void)
714 return pcmcia_register_driver(&dtl1_driver
);
718 static void __exit
exit_dtl1_cs(void)
720 pcmcia_unregister_driver(&dtl1_driver
);
723 module_init(init_dtl1_cs
);
724 module_exit(exit_dtl1_cs
);