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/config.h>
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/sched.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>
37 #include <linux/skbuff.h>
38 #include <linux/string.h>
39 #include <linux/serial.h>
40 #include <linux/serial_reg.h>
41 #include <asm/system.h>
42 #include <asm/bitops.h>
45 #include <pcmcia/version.h>
46 #include <pcmcia/cs_types.h>
47 #include <pcmcia/cs.h>
48 #include <pcmcia/cistpl.h>
49 #include <pcmcia/ciscode.h>
50 #include <pcmcia/ds.h>
51 #include <pcmcia/cisreg.h>
53 #include <net/bluetooth/bluetooth.h>
54 #include <net/bluetooth/hci_core.h>
58 /* ======================== Module parameters ======================== */
61 /* Bit map of interrupts to choose from */
62 static u_int irq_mask = 0xffff;
63 static int irq_list[4] = { -1 };
65 MODULE_PARM(irq_mask, "i");
66 MODULE_PARM(irq_list, "1-4i");
68 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
69 MODULE_DESCRIPTION("BlueZ driver for Nokia Connectivity Card DTL-1");
70 MODULE_LICENSE("GPL");
74 /* ======================== Local structures ======================== */
77 typedef struct dtl1_info_t {
83 spinlock_t lock; /* For serializing operations */
85 unsigned long flowmask; /* HCI flow mask */
88 struct sk_buff_head txq;
89 unsigned long tx_state;
91 unsigned long rx_state;
92 unsigned long rx_count;
93 struct sk_buff *rx_skb;
97 void dtl1_config(dev_link_t *link);
98 void dtl1_release(u_long arg);
99 int dtl1_event(event_t event, int priority, event_callback_args_t *args);
101 static dev_info_t dev_info = "dtl1_cs";
103 dev_link_t *dtl1_attach(void);
104 void dtl1_detach(dev_link_t *);
106 static dev_link_t *dev_list = NULL;
109 /* Transmit states */
110 #define XMIT_SENDING 1
111 #define XMIT_WAKEUP 2
112 #define XMIT_WAITING 8
114 /* Receiver States */
115 #define RECV_WAIT_NSH 0
116 #define RECV_WAIT_DATA 1
123 } __attribute__ ((packed)) nsh_t; /* Nokia Specific Header */
125 #define NSHL 4 /* Nokia Specific Header Length */
129 /* ======================== Interrupt handling ======================== */
132 static int dtl1_write(unsigned int iobase, int fifo_size, __u8 *buf, int len)
136 /* Tx FIFO should be empty */
137 if (!(inb(iobase + UART_LSR) & UART_LSR_THRE))
140 /* Fill FIFO with current frame */
141 while ((fifo_size-- > 0) && (actual < len)) {
142 /* Transmit next byte */
143 outb(buf[actual], iobase + UART_TX);
151 static void dtl1_write_wakeup(dtl1_info_t *info)
154 printk(KERN_WARNING "dtl1_cs: Call of write_wakeup for unknown device.\n");
158 if (test_bit(XMIT_WAITING, &(info->tx_state))) {
159 set_bit(XMIT_WAKEUP, &(info->tx_state));
163 if (test_and_set_bit(XMIT_SENDING, &(info->tx_state))) {
164 set_bit(XMIT_WAKEUP, &(info->tx_state));
169 register unsigned int iobase = info->link.io.BasePort1;
170 register struct sk_buff *skb;
173 clear_bit(XMIT_WAKEUP, &(info->tx_state));
175 if (!(info->link.state & DEV_PRESENT))
178 if (!(skb = skb_dequeue(&(info->txq))))
182 len = dtl1_write(iobase, 32, skb->data, skb->len);
184 if (len == skb->len) {
185 set_bit(XMIT_WAITING, &(info->tx_state));
189 skb_queue_head(&(info->txq), skb);
192 info->hdev.stat.byte_tx += len;
194 } while (test_bit(XMIT_WAKEUP, &(info->tx_state)));
196 clear_bit(XMIT_SENDING, &(info->tx_state));
200 static void dtl1_control(dtl1_info_t *info, struct sk_buff *skb)
202 u8 flowmask = *(u8 *)skb->data;
205 printk(KERN_INFO "dtl1_cs: Nokia control data = ");
206 for (i = 0; i < skb->len; i++) {
207 printk("%02x ", skb->data[i]);
211 /* transition to active state */
212 if (((info->flowmask & 0x07) == 0) && ((flowmask & 0x07) != 0)) {
213 clear_bit(XMIT_WAITING, &(info->tx_state));
214 dtl1_write_wakeup(info);
217 info->flowmask = flowmask;
223 static void dtl1_receive(dtl1_info_t *info)
230 printk(KERN_WARNING "dtl1_cs: Call of receive for unknown device.\n");
234 iobase = info->link.io.BasePort1;
237 info->hdev.stat.byte_rx++;
239 /* Allocate packet */
240 if (info->rx_skb == NULL)
241 if (!(info->rx_skb = bluez_skb_alloc(HCI_MAX_FRAME_SIZE, GFP_ATOMIC))) {
242 printk(KERN_WARNING "dtl1_cs: Can't allocate mem for new packet.\n");
243 info->rx_state = RECV_WAIT_NSH;
244 info->rx_count = NSHL;
248 *skb_put(info->rx_skb, 1) = inb(iobase + UART_RX);
249 nsh = (nsh_t *)info->rx_skb->data;
253 if (info->rx_count == 0) {
255 switch (info->rx_state) {
257 info->rx_state = RECV_WAIT_DATA;
258 info->rx_count = nsh->len + (nsh->len & 0x0001);
261 info->rx_skb->pkt_type = nsh->type;
263 /* remove PAD byte if it exists */
264 if (nsh->len & 0x0001) {
265 info->rx_skb->tail--;
270 skb_pull(info->rx_skb, NSHL);
272 switch (info->rx_skb->pkt_type) {
274 /* control data for the Nokia Card */
275 dtl1_control(info, info->rx_skb);
280 /* send frame to the HCI layer */
281 info->rx_skb->dev = (void *)&(info->hdev);
282 info->rx_skb->pkt_type &= 0x0f;
283 hci_recv_frame(info->rx_skb);
287 printk(KERN_WARNING "dtl1_cs: Unknown HCI packet with type 0x%02x received.\n", info->rx_skb->pkt_type);
288 kfree_skb(info->rx_skb);
292 info->rx_state = RECV_WAIT_NSH;
293 info->rx_count = NSHL;
300 /* Make sure we don't stay here to long */
301 if (boguscount++ > 32)
304 } while (inb(iobase + UART_LSR) & UART_LSR_DR);
308 void dtl1_interrupt(int irq, void *dev_inst, struct pt_regs *regs)
310 dtl1_info_t *info = dev_inst;
317 printk(KERN_WARNING "dtl1_cs: Call of irq %d for unknown device.\n", irq);
321 iobase = info->link.io.BasePort1;
323 spin_lock(&(info->lock));
325 iir = inb(iobase + UART_IIR) & UART_IIR_ID;
328 /* Clear interrupt */
329 lsr = inb(iobase + UART_LSR);
333 printk(KERN_NOTICE "dtl1_cs: RLSI\n");
336 /* Receive interrupt */
340 if (lsr & UART_LSR_THRE) {
341 /* Transmitter ready for data */
342 dtl1_write_wakeup(info);
346 printk(KERN_NOTICE "dtl1_cs: Unhandled IIR=%#x\n", iir);
350 /* Make sure we don't stay here to long */
351 if (boguscount++ > 100)
354 iir = inb(iobase + UART_IIR) & UART_IIR_ID;
358 msr = inb(iobase + UART_MSR);
360 if (info->ri_latch ^ (msr & UART_MSR_RI)) {
361 info->ri_latch = msr & UART_MSR_RI;
362 clear_bit(XMIT_WAITING, &(info->tx_state));
363 dtl1_write_wakeup(info);
366 spin_unlock(&(info->lock));
371 /* ======================== HCI interface ======================== */
374 static int dtl1_hci_open(struct hci_dev *hdev)
376 set_bit(HCI_RUNNING, &(hdev->flags));
382 static int dtl1_hci_flush(struct hci_dev *hdev)
384 dtl1_info_t *info = (dtl1_info_t *)(hdev->driver_data);
387 skb_queue_purge(&(info->txq));
393 static int dtl1_hci_close(struct hci_dev *hdev)
395 if (!test_and_clear_bit(HCI_RUNNING, &(hdev->flags)))
398 dtl1_hci_flush(hdev);
404 static int dtl1_hci_send_frame(struct sk_buff *skb)
407 struct hci_dev *hdev = (struct hci_dev *)(skb->dev);
412 printk(KERN_WARNING "dtl1_cs: Frame for unknown HCI device (hdev=NULL).");
416 info = (dtl1_info_t *)(hdev->driver_data);
418 switch (skb->pkt_type) {
419 case HCI_COMMAND_PKT:
423 case HCI_ACLDATA_PKT:
427 case HCI_SCODATA_PKT:
436 s = bluez_skb_alloc(NSHL + skb->len + 1, GFP_ATOMIC);
437 skb_reserve(s, NSHL);
438 memcpy(skb_put(s, skb->len), skb->data, skb->len);
439 if (skb->len & 0x0001)
440 *skb_put(s, 1) = 0; /* PAD */
442 /* Prepend skb with Nokia frame header and queue */
443 memcpy(skb_push(s, NSHL), &nsh, NSHL);
444 skb_queue_tail(&(info->txq), s);
446 dtl1_write_wakeup(info);
454 static void dtl1_hci_destruct(struct hci_dev *hdev)
459 static int dtl1_hci_ioctl(struct hci_dev *hdev, unsigned int cmd, unsigned long arg)
466 /* ======================== Card services HCI interaction ======================== */
469 int dtl1_open(dtl1_info_t *info)
472 unsigned int iobase = info->link.io.BasePort1;
473 struct hci_dev *hdev;
475 spin_lock_init(&(info->lock));
477 skb_queue_head_init(&(info->txq));
479 info->rx_state = RECV_WAIT_NSH;
480 info->rx_count = NSHL;
483 set_bit(XMIT_WAITING, &(info->tx_state));
485 spin_lock_irqsave(&(info->lock), flags);
488 outb(0, iobase + UART_MCR);
490 /* Turn off interrupts */
491 outb(0, iobase + UART_IER);
493 /* Initialize UART */
494 outb(UART_LCR_WLEN8, iobase + UART_LCR); /* Reset DLAB */
495 outb((UART_MCR_DTR | UART_MCR_RTS | UART_MCR_OUT2), iobase + UART_MCR);
497 info->ri_latch = inb(info->link.io.BasePort1 + UART_MSR) & UART_MSR_RI;
499 /* Turn on interrupts */
500 outb(UART_IER_RLSI | UART_IER_RDI | UART_IER_THRI, iobase + UART_IER);
502 spin_unlock_irqrestore(&(info->lock), flags);
504 /* Timeout before it is safe to send the first HCI packet */
505 set_current_state(TASK_INTERRUPTIBLE);
506 schedule_timeout(HZ * 2);
509 /* Initialize and register HCI device */
511 hdev = &(info->hdev);
513 hdev->type = HCI_PCCARD;
514 hdev->driver_data = info;
516 hdev->open = dtl1_hci_open;
517 hdev->close = dtl1_hci_close;
518 hdev->flush = dtl1_hci_flush;
519 hdev->send = dtl1_hci_send_frame;
520 hdev->destruct = dtl1_hci_destruct;
521 hdev->ioctl = dtl1_hci_ioctl;
523 if (hci_register_dev(hdev) < 0) {
524 printk(KERN_WARNING "dtl1_cs: Can't register HCI device %s.\n", hdev->name);
532 int dtl1_close(dtl1_info_t *info)
535 unsigned int iobase = info->link.io.BasePort1;
536 struct hci_dev *hdev = &(info->hdev);
538 if (info->link.state & DEV_CONFIG_PENDING)
541 dtl1_hci_close(hdev);
543 spin_lock_irqsave(&(info->lock), flags);
546 outb(0, iobase + UART_MCR);
548 /* Turn off interrupts */
549 outb(0, iobase + UART_IER);
551 spin_unlock_irqrestore(&(info->lock), flags);
553 if (hci_unregister_dev(hdev) < 0)
554 printk(KERN_WARNING "dtl1_cs: Can't unregister HCI device %s.\n", hdev->name);
561 /* ======================== Card services ======================== */
564 static void cs_error(client_handle_t handle, int func, int ret)
566 error_info_t err = { func, ret };
568 CardServices(ReportError, handle, &err);
572 dev_link_t *dtl1_attach(void)
575 client_reg_t client_reg;
579 /* Create new info device */
580 info = kmalloc(sizeof(*info), GFP_KERNEL);
583 memset(info, 0, sizeof(*info));
588 link->release.function = &dtl1_release;
589 link->release.data = (u_long)link;
590 link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
591 link->io.NumPorts1 = 8;
592 link->irq.Attributes = IRQ_TYPE_EXCLUSIVE | IRQ_HANDLE_PRESENT;
593 link->irq.IRQInfo1 = IRQ_INFO2_VALID | IRQ_LEVEL_ID;
595 if (irq_list[0] == -1)
596 link->irq.IRQInfo2 = irq_mask;
598 for (i = 0; i < 4; i++)
599 link->irq.IRQInfo2 |= 1 << irq_list[i];
601 link->irq.Handler = dtl1_interrupt;
602 link->irq.Instance = info;
604 link->conf.Attributes = CONF_ENABLE_IRQ;
606 link->conf.IntType = INT_MEMORY_AND_IO;
608 /* Register with Card Services */
609 link->next = dev_list;
611 client_reg.dev_info = &dev_info;
612 client_reg.Attributes = INFO_IO_CLIENT | INFO_CARD_SHARE;
613 client_reg.EventMask =
614 CS_EVENT_CARD_INSERTION | CS_EVENT_CARD_REMOVAL |
615 CS_EVENT_RESET_PHYSICAL | CS_EVENT_CARD_RESET |
616 CS_EVENT_PM_SUSPEND | CS_EVENT_PM_RESUME;
617 client_reg.event_handler = &dtl1_event;
618 client_reg.Version = 0x0210;
619 client_reg.event_callback_args.client_data = link;
621 ret = CardServices(RegisterClient, &link->handle, &client_reg);
622 if (ret != CS_SUCCESS) {
623 cs_error(link->handle, RegisterClient, ret);
632 void dtl1_detach(dev_link_t *link)
634 dtl1_info_t *info = link->priv;
638 /* Locate device structure */
639 for (linkp = &dev_list; *linkp; linkp = &(*linkp)->next)
646 del_timer(&link->release);
647 if (link->state & DEV_CONFIG)
648 dtl1_release((u_long)link);
651 ret = CardServices(DeregisterClient, link->handle);
652 if (ret != CS_SUCCESS)
653 cs_error(link->handle, DeregisterClient, ret);
656 /* Unlink device structure, free bits */
663 static int get_tuple(int fn, client_handle_t handle, tuple_t *tuple, cisparse_t *parse)
667 i = CardServices(fn, handle, tuple);
669 return CS_NO_MORE_ITEMS;
671 i = CardServices(GetTupleData, handle, tuple);
675 return CardServices(ParseTuple, handle, tuple, parse);
679 #define first_tuple(a, b, c) get_tuple(GetFirstTuple, a, b, c)
680 #define next_tuple(a, b, c) get_tuple(GetNextTuple, a, b, c)
682 void dtl1_config(dev_link_t *link)
684 client_handle_t handle = link->handle;
685 dtl1_info_t *info = link->priv;
689 cistpl_cftable_entry_t *cf = &parse.cftable_entry;
690 config_info_t config;
691 int i, last_ret, last_fn;
693 tuple.TupleData = (cisdata_t *)buf;
694 tuple.TupleOffset = 0;
695 tuple.TupleDataMax = 255;
696 tuple.Attributes = 0;
698 /* Get configuration register information */
699 tuple.DesiredTuple = CISTPL_CONFIG;
700 last_ret = first_tuple(handle, &tuple, &parse);
701 if (last_ret != CS_SUCCESS) {
702 last_fn = ParseTuple;
705 link->conf.ConfigBase = parse.config.base;
706 link->conf.Present = parse.config.rmask[0];
709 link->state |= DEV_CONFIG;
710 i = CardServices(GetConfigurationInfo, handle, &config);
711 link->conf.Vcc = config.Vcc;
713 tuple.TupleData = (cisdata_t *)buf;
714 tuple.TupleOffset = 0;
715 tuple.TupleDataMax = 255;
716 tuple.Attributes = 0;
717 tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
719 /* Look for a generic full-sized window */
720 link->io.NumPorts1 = 8;
721 i = first_tuple(handle, &tuple, &parse);
722 while (i != CS_NO_MORE_ITEMS) {
723 if ((i == CS_SUCCESS) && (cf->io.nwin == 1) && (cf->io.win[0].len > 8)) {
724 link->conf.ConfigIndex = cf->index;
725 link->io.BasePort1 = cf->io.win[0].base;
726 link->io.NumPorts1 = cf->io.win[0].len; /*yo */
727 link->io.IOAddrLines = cf->io.flags & CISTPL_IO_LINES_MASK;
728 i = CardServices(RequestIO, link->handle, &link->io);
732 i = next_tuple(handle, &tuple, &parse);
735 if (i != CS_SUCCESS) {
736 cs_error(link->handle, RequestIO, i);
740 i = CardServices(RequestIRQ, link->handle, &link->irq);
741 if (i != CS_SUCCESS) {
742 cs_error(link->handle, RequestIRQ, i);
743 link->irq.AssignedIRQ = 0;
746 i = CardServices(RequestConfiguration, link->handle, &link->conf);
747 if (i != CS_SUCCESS) {
748 cs_error(link->handle, RequestConfiguration, i);
754 if (dtl1_open(info) != 0)
757 strcpy(info->node.dev_name, info->hdev.name);
758 link->dev = &info->node;
759 link->state &= ~DEV_CONFIG_PENDING;
764 cs_error(link->handle, last_fn, last_ret);
767 dtl1_release((u_long)link);
771 void dtl1_release(u_long arg)
773 dev_link_t *link = (dev_link_t *)arg;
774 dtl1_info_t *info = link->priv;
776 if (link->state & DEV_PRESENT)
783 CardServices(ReleaseConfiguration, link->handle);
784 CardServices(ReleaseIO, link->handle, &link->io);
785 CardServices(ReleaseIRQ, link->handle, &link->irq);
787 link->state &= ~DEV_CONFIG;
791 int dtl1_event(event_t event, int priority, event_callback_args_t *args)
793 dev_link_t *link = args->client_data;
794 dtl1_info_t *info = link->priv;
797 case CS_EVENT_CARD_REMOVAL:
798 link->state &= ~DEV_PRESENT;
799 if (link->state & DEV_CONFIG) {
801 mod_timer(&link->release, jiffies + HZ / 20);
804 case CS_EVENT_CARD_INSERTION:
805 link->state |= DEV_PRESENT | DEV_CONFIG_PENDING;
808 case CS_EVENT_PM_SUSPEND:
809 link->state |= DEV_SUSPEND;
810 /* Fall through... */
811 case CS_EVENT_RESET_PHYSICAL:
812 if (link->state & DEV_CONFIG)
813 CardServices(ReleaseConfiguration, link->handle);
815 case CS_EVENT_PM_RESUME:
816 link->state &= ~DEV_SUSPEND;
817 /* Fall through... */
818 case CS_EVENT_CARD_RESET:
820 CardServices(RequestConfiguration, link->handle, &link->conf);
829 /* ======================== Module initialization ======================== */
832 int __init init_dtl1_cs(void)
837 CardServices(GetCardServicesInfo, &serv);
838 if (serv.Revision != CS_RELEASE_CODE) {
839 printk(KERN_NOTICE "dtl1_cs: Card Services release does not match!\n");
843 err = register_pccard_driver(&dev_info, &dtl1_attach, &dtl1_detach);
849 void __exit exit_dtl1_cs(void)
851 unregister_pccard_driver(&dev_info);
853 while (dev_list != NULL)
854 dtl1_detach(dev_list);
858 module_init(init_dtl1_cs);
859 module_exit(exit_dtl1_cs);