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;
 
 303         iobase = info->p_dev->io.BasePort1;
 
 305         spin_lock(&(info->lock));
 
 307         iir = inb(iobase + UART_IIR) & UART_IIR_ID;
 
 310                 /* Clear interrupt */
 
 311                 lsr = inb(iobase + UART_LSR);
 
 318                         /* Receive interrupt */
 
 322                         if (lsr & UART_LSR_THRE) {
 
 323                                 /* Transmitter ready for data */
 
 324                                 dtl1_write_wakeup(info);
 
 328                         BT_ERR("Unhandled IIR=%#x", iir);
 
 332                 /* Make sure we don't stay here too long */
 
 333                 if (boguscount++ > 100)
 
 336                 iir = inb(iobase + UART_IIR) & UART_IIR_ID;
 
 340         msr = inb(iobase + UART_MSR);
 
 342         if (info->ri_latch ^ (msr & UART_MSR_RI)) {
 
 343                 info->ri_latch = msr & UART_MSR_RI;
 
 344                 clear_bit(XMIT_WAITING, &(info->tx_state));
 
 345                 dtl1_write_wakeup(info);
 
 348         spin_unlock(&(info->lock));
 
 355 /* ======================== HCI interface ======================== */
 
 358 static int dtl1_hci_open(struct hci_dev *hdev)
 
 360         set_bit(HCI_RUNNING, &(hdev->flags));
 
 366 static int dtl1_hci_flush(struct hci_dev *hdev)
 
 368         dtl1_info_t *info = (dtl1_info_t *)(hdev->driver_data);
 
 371         skb_queue_purge(&(info->txq));
 
 377 static int dtl1_hci_close(struct hci_dev *hdev)
 
 379         if (!test_and_clear_bit(HCI_RUNNING, &(hdev->flags)))
 
 382         dtl1_hci_flush(hdev);
 
 388 static int dtl1_hci_send_frame(struct sk_buff *skb)
 
 391         struct hci_dev *hdev = (struct hci_dev *)(skb->dev);
 
 396                 BT_ERR("Frame for unknown HCI device (hdev=NULL)");
 
 400         info = (dtl1_info_t *)(hdev->driver_data);
 
 402         switch (bt_cb(skb)->pkt_type) {
 
 403         case HCI_COMMAND_PKT:
 
 407         case HCI_ACLDATA_PKT:
 
 411         case HCI_SCODATA_PKT:
 
 420         s = bt_skb_alloc(NSHL + skb->len + 1, GFP_ATOMIC);
 
 424         skb_reserve(s, NSHL);
 
 425         skb_copy_from_linear_data(skb, skb_put(s, skb->len), skb->len);
 
 426         if (skb->len & 0x0001)
 
 427                 *skb_put(s, 1) = 0;     /* PAD */
 
 429         /* Prepend skb with Nokia frame header and queue */
 
 430         memcpy(skb_push(s, NSHL), &nsh, NSHL);
 
 431         skb_queue_tail(&(info->txq), s);
 
 433         dtl1_write_wakeup(info);
 
 441 static void dtl1_hci_destruct(struct hci_dev *hdev)
 
 446 static int dtl1_hci_ioctl(struct hci_dev *hdev, unsigned int cmd,  unsigned long arg)
 
 453 /* ======================== Card services HCI interaction ======================== */
 
 456 static int dtl1_open(dtl1_info_t *info)
 
 459         unsigned int iobase = info->p_dev->io.BasePort1;
 
 460         struct hci_dev *hdev;
 
 462         spin_lock_init(&(info->lock));
 
 464         skb_queue_head_init(&(info->txq));
 
 466         info->rx_state = RECV_WAIT_NSH;
 
 467         info->rx_count = NSHL;
 
 470         set_bit(XMIT_WAITING, &(info->tx_state));
 
 472         /* Initialize HCI device */
 
 473         hdev = hci_alloc_dev();
 
 475                 BT_ERR("Can't allocate HCI device");
 
 481         hdev->type = HCI_PCCARD;
 
 482         hdev->driver_data = info;
 
 483         SET_HCIDEV_DEV(hdev, &info->p_dev->dev);
 
 485         hdev->open     = dtl1_hci_open;
 
 486         hdev->close    = dtl1_hci_close;
 
 487         hdev->flush    = dtl1_hci_flush;
 
 488         hdev->send     = dtl1_hci_send_frame;
 
 489         hdev->destruct = dtl1_hci_destruct;
 
 490         hdev->ioctl    = dtl1_hci_ioctl;
 
 492         hdev->owner = THIS_MODULE;
 
 494         spin_lock_irqsave(&(info->lock), flags);
 
 497         outb(0, iobase + UART_MCR);
 
 499         /* Turn off interrupts */
 
 500         outb(0, iobase + UART_IER);
 
 502         /* Initialize UART */
 
 503         outb(UART_LCR_WLEN8, iobase + UART_LCR);        /* Reset DLAB */
 
 504         outb((UART_MCR_DTR | UART_MCR_RTS | UART_MCR_OUT2), iobase + UART_MCR);
 
 506         info->ri_latch = inb(info->p_dev->io.BasePort1 + UART_MSR) & UART_MSR_RI;
 
 508         /* Turn on interrupts */
 
 509         outb(UART_IER_RLSI | UART_IER_RDI | UART_IER_THRI, iobase + UART_IER);
 
 511         spin_unlock_irqrestore(&(info->lock), flags);
 
 513         /* Timeout before it is safe to send the first HCI packet */
 
 516         /* Register HCI device */
 
 517         if (hci_register_dev(hdev) < 0) {
 
 518                 BT_ERR("Can't register HCI device");
 
 528 static int dtl1_close(dtl1_info_t *info)
 
 531         unsigned int iobase = info->p_dev->io.BasePort1;
 
 532         struct hci_dev *hdev = info->hdev;
 
 537         dtl1_hci_close(hdev);
 
 539         spin_lock_irqsave(&(info->lock), flags);
 
 542         outb(0, iobase + UART_MCR);
 
 544         /* Turn off interrupts */
 
 545         outb(0, iobase + UART_IER);
 
 547         spin_unlock_irqrestore(&(info->lock), flags);
 
 549         if (hci_unregister_dev(hdev) < 0)
 
 550                 BT_ERR("Can't unregister HCI device %s", hdev->name);
 
 557 static int dtl1_probe(struct pcmcia_device *link)
 
 561         /* Create new info device */
 
 562         info = kzalloc(sizeof(*info), GFP_KERNEL);
 
 569         link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
 
 570         link->io.NumPorts1 = 8;
 
 571         link->irq.Attributes = IRQ_TYPE_EXCLUSIVE | IRQ_HANDLE_PRESENT;
 
 572         link->irq.IRQInfo1 = IRQ_LEVEL_ID;
 
 574         link->irq.Handler = dtl1_interrupt;
 
 575         link->irq.Instance = info;
 
 577         link->conf.Attributes = CONF_ENABLE_IRQ;
 
 578         link->conf.IntType = INT_MEMORY_AND_IO;
 
 580         return dtl1_config(link);
 
 584 static void dtl1_detach(struct pcmcia_device *link)
 
 586         dtl1_info_t *info = link->priv;
 
 593 static int get_tuple(struct pcmcia_device *handle, tuple_t *tuple, cisparse_t *parse)
 
 597         i = pcmcia_get_tuple_data(handle, tuple);
 
 601         return pcmcia_parse_tuple(handle, tuple, parse);
 
 604 static int first_tuple(struct pcmcia_device *handle, tuple_t *tuple, cisparse_t *parse)
 
 606         if (pcmcia_get_first_tuple(handle, tuple) != CS_SUCCESS)
 
 607                 return CS_NO_MORE_ITEMS;
 
 608         return get_tuple(handle, tuple, parse);
 
 611 static int next_tuple(struct pcmcia_device *handle, tuple_t *tuple, cisparse_t *parse)
 
 613         if (pcmcia_get_next_tuple(handle, tuple) != CS_SUCCESS)
 
 614                 return CS_NO_MORE_ITEMS;
 
 615         return get_tuple(handle, tuple, parse);
 
 618 static int dtl1_config(struct pcmcia_device *link)
 
 620         dtl1_info_t *info = link->priv;
 
 624         cistpl_cftable_entry_t *cf = &parse.cftable_entry;
 
 627         tuple.TupleData = (cisdata_t *)buf;
 
 628         tuple.TupleOffset = 0;
 
 629         tuple.TupleDataMax = 255;
 
 630         tuple.Attributes = 0;
 
 631         tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
 
 633         /* Look for a generic full-sized window */
 
 634         link->io.NumPorts1 = 8;
 
 635         i = first_tuple(link, &tuple, &parse);
 
 636         while (i != CS_NO_MORE_ITEMS) {
 
 637                 if ((i == CS_SUCCESS) && (cf->io.nwin == 1) && (cf->io.win[0].len > 8)) {
 
 638                         link->conf.ConfigIndex = cf->index;
 
 639                         link->io.BasePort1 = cf->io.win[0].base;
 
 640                         link->io.NumPorts1 = cf->io.win[0].len; /*yo */
 
 641                         link->io.IOAddrLines = cf->io.flags & CISTPL_IO_LINES_MASK;
 
 642                         i = pcmcia_request_io(link, &link->io);
 
 646                 i = next_tuple(link, &tuple, &parse);
 
 649         if (i != CS_SUCCESS) {
 
 650                 cs_error(link, RequestIO, i);
 
 654         i = pcmcia_request_irq(link, &link->irq);
 
 655         if (i != CS_SUCCESS) {
 
 656                 cs_error(link, RequestIRQ, i);
 
 657                 link->irq.AssignedIRQ = 0;
 
 660         i = pcmcia_request_configuration(link, &link->conf);
 
 661         if (i != CS_SUCCESS) {
 
 662                 cs_error(link, RequestConfiguration, i);
 
 666         if (dtl1_open(info) != 0)
 
 669         strcpy(info->node.dev_name, info->hdev->name);
 
 670         link->dev_node = &info->node;
 
 680 static void dtl1_release(struct pcmcia_device *link)
 
 682         dtl1_info_t *info = link->priv;
 
 686         pcmcia_disable_device(link);
 
 690 static struct pcmcia_device_id dtl1_ids[] = {
 
 691         PCMCIA_DEVICE_PROD_ID12("Nokia Mobile Phones", "DTL-1", 0xe1bfdd64, 0xe168480d),
 
 692         PCMCIA_DEVICE_PROD_ID12("Nokia Mobile Phones", "DTL-4", 0xe1bfdd64, 0x9102bc82),
 
 693         PCMCIA_DEVICE_PROD_ID12("Socket", "CF", 0xb38bcc2e, 0x44ebf863),
 
 694         PCMCIA_DEVICE_PROD_ID12("Socket", "CF+ Personal Network Card", 0xb38bcc2e, 0xe732bae3),
 
 697 MODULE_DEVICE_TABLE(pcmcia, dtl1_ids);
 
 699 static struct pcmcia_driver dtl1_driver = {
 
 700         .owner          = THIS_MODULE,
 
 705         .remove         = dtl1_detach,
 
 706         .id_table       = dtl1_ids,
 
 709 static int __init init_dtl1_cs(void)
 
 711         return pcmcia_register_driver(&dtl1_driver);
 
 715 static void __exit exit_dtl1_cs(void)
 
 717         pcmcia_unregister_driver(&dtl1_driver);
 
 720 module_init(init_dtl1_cs);
 
 721 module_exit(exit_dtl1_cs);