drivers/bluetooth/dtl1_cs.c

   1 /*
   2  *
   3  *  A driver for Nokia Connectivity Card DTL-1 devices
   4  *
   5  *  Copyright (C) 2001-2002  Marcel Holtmann <marcel@holtmann.org>
   6  *
   7  *
   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;
  11  *
  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.
  16  *
  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.
  20  *
  21  */
  22
  23 #include <linux/module.h>
  24
  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>
  35
  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>
  42 #include <asm/io.h>
  43
  44 #include <pcmcia/cs.h>
  45 #include <pcmcia/cistpl.h>
  46 #include <pcmcia/ciscode.h>
  47 #include <pcmcia/ds.h>
  48 #include <pcmcia/cisreg.h>
  49
  50 #include <net/bluetooth/bluetooth.h>
  51 #include <net/bluetooth/hci_core.h>
  52
  53
  54
  55 /* ======================== Module parameters ======================== */
  56
  57
  58 MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
  59 MODULE_DESCRIPTION("Bluetooth driver for Nokia Connectivity Card DTL-1");
  60 MODULE_LICENSE("GPL");
  61
  62
  63
  64 /* ======================== Local structures ======================== */
  65
  66
  67 typedef struct dtl1_info_t {
  68         struct pcmcia_device *p_dev;
  69
  70         struct hci_dev *hdev;
  71
  72         spinlock_t lock;                /* For serializing operations */
  73
  74         unsigned long flowmask;         /* HCI flow mask */
  75         int ri_latch;
  76
  77         struct sk_buff_head txq;
  78         unsigned long tx_state;
  79
  80         unsigned long rx_state;
  81         unsigned long rx_count;
  82         struct sk_buff *rx_skb;
  83 } dtl1_info_t;
  84
  85
  86 static int dtl1_config(struct pcmcia_device *link);
  87 static void dtl1_release(struct pcmcia_device *link);
  88
  89 static void dtl1_detach(struct pcmcia_device *p_dev);
  90
  91
  92 /* Transmit states  */
  93 #define XMIT_SENDING  1
  94 #define XMIT_WAKEUP   2
  95 #define XMIT_WAITING  8
  96
  97 /* Receiver States */
  98 #define RECV_WAIT_NSH   0
  99 #define RECV_WAIT_DATA  1
 100
 101
 102 typedef struct {
 103         u8 type;
 104         u8 zero;
 105         u16 len;
 106 } __packed nsh_t;       /* Nokia Specific Header */
 107
 108 #define NSHL  4                         /* Nokia Specific Header Length */
 109
 110
 111
 112 /* ======================== Interrupt handling ======================== */
 113
 114
 115 static int dtl1_write(unsigned int iobase, int fifo_size, __u8 *buf, int len)
 116 {
 117         int actual = 0;
 118
 119         /* Tx FIFO should be empty */
 120         if (!(inb(iobase + UART_LSR) & UART_LSR_THRE))
 121                 return 0;
 122
 123         /* Fill FIFO with current frame */
 124         while ((fifo_size-- > 0) && (actual < len)) {
 125                 /* Transmit next byte */
 126                 outb(buf[actual], iobase + UART_TX);
 127                 actual++;
 128         }
 129
 130         return actual;
 131 }
 132
 133
 134 static void dtl1_write_wakeup(dtl1_info_t *info)
 135 {
 136         if (!info) {
 137                 BT_ERR("Unknown device");
 138                 return;
 139         }
 140
 141         if (test_bit(XMIT_WAITING, &(info->tx_state))) {
 142                 set_bit(XMIT_WAKEUP, &(info->tx_state));
 143                 return;
 144         }
 145
 146         if (test_and_set_bit(XMIT_SENDING, &(info->tx_state))) {
 147                 set_bit(XMIT_WAKEUP, &(info->tx_state));
 148                 return;
 149         }
 150
 151         do {
 152                 register unsigned int iobase = info->p_dev->resource[0]->start;
 153                 register struct sk_buff *skb;
 154                 register int len;
 155
 156                 clear_bit(XMIT_WAKEUP, &(info->tx_state));
 157
 158                 if (!pcmcia_dev_present(info->p_dev))
 159                         return;
 160
 161                 if (!(skb = skb_dequeue(&(info->txq))))
 162                         break;
 163
 164                 /* Send frame */
 165                 len = dtl1_write(iobase, 32, skb->data, skb->len);
 166
 167                 if (len == skb->len) {
 168                         set_bit(XMIT_WAITING, &(info->tx_state));
 169                         kfree_skb(skb);
 170                 } else {
 171                         skb_pull(skb, len);
 172                         skb_queue_head(&(info->txq), skb);
 173                 }
 174
 175                 info->hdev->stat.byte_tx += len;
 176
 177         } while (test_bit(XMIT_WAKEUP, &(info->tx_state)));
 178
 179         clear_bit(XMIT_SENDING, &(info->tx_state));
 180 }
 181
 182
 183 static void dtl1_control(dtl1_info_t *info, struct sk_buff *skb)
 184 {
 185         u8 flowmask = *(u8 *)skb->data;
 186         int i;
 187
 188         printk(KERN_INFO "Bluetooth: Nokia control data =");
 189         for (i = 0; i < skb->len; i++) {
 190                 printk(" %02x", skb->data[i]);
 191         }
 192         printk("\n");
 193
 194         /* transition to active state */
 195         if (((info->flowmask & 0x07) == 0) && ((flowmask & 0x07) != 0)) {
 196                 clear_bit(XMIT_WAITING, &(info->tx_state));
 197                 dtl1_write_wakeup(info);
 198         }
 199
 200         info->flowmask = flowmask;
 201
 202         kfree_skb(skb);
 203 }
 204
 205
 206 static void dtl1_receive(dtl1_info_t *info)
 207 {
 208         unsigned int iobase;
 209         nsh_t *nsh;
 210         int boguscount = 0;
 211
 212         if (!info) {
 213                 BT_ERR("Unknown device");
 214                 return;
 215         }
 216
 217         iobase = info->p_dev->resource[0]->start;
 218
 219         do {
 220                 info->hdev->stat.byte_rx++;
 221
 222                 /* Allocate packet */
 223                 if (info->rx_skb == NULL)
 224                         if (!(info->rx_skb = bt_skb_alloc(HCI_MAX_FRAME_SIZE, GFP_ATOMIC))) {
 225                                 BT_ERR("Can't allocate mem for new packet");
 226                                 info->rx_state = RECV_WAIT_NSH;
 227                                 info->rx_count = NSHL;
 228                                 return;
 229                         }
 230
 231                 *skb_put(info->rx_skb, 1) = inb(iobase + UART_RX);
 232                 nsh = (nsh_t *)info->rx_skb->data;
 233
 234                 info->rx_count--;
 235
 236                 if (info->rx_count == 0) {
 237
 238                         switch (info->rx_state) {
 239                         case RECV_WAIT_NSH:
 240                                 info->rx_state = RECV_WAIT_DATA;
 241                                 info->rx_count = nsh->len + (nsh->len & 0x0001);
 242                                 break;
 243                         case RECV_WAIT_DATA:
 244                                 bt_cb(info->rx_skb)->pkt_type = nsh->type;
 245
 246                                 /* remove PAD byte if it exists */
 247                                 if (nsh->len & 0x0001) {
 248                                         info->rx_skb->tail--;
 249                                         info->rx_skb->len--;
 250                                 }
 251
 252                                 /* remove NSH */
 253                                 skb_pull(info->rx_skb, NSHL);
 254
 255                                 switch (bt_cb(info->rx_skb)->pkt_type) {
 256                                 case 0x80:
 257                                         /* control data for the Nokia Card */
 258                                         dtl1_control(info, info->rx_skb);
 259                                         break;
 260                                 case 0x82:
 261                                 case 0x83:
 262                                 case 0x84:
 263                                         /* send frame to the HCI layer */
 264                                         info->rx_skb->dev = (void *) info->hdev;
 265                                         bt_cb(info->rx_skb)->pkt_type &= 0x0f;
 266                                         hci_recv_frame(info->rx_skb);
 267                                         break;
 268                                 default:
 269                                         /* unknown packet */
 270                                         BT_ERR("Unknown HCI packet with type 0x%02x received", bt_cb(info->rx_skb)->pkt_type);
 271                                         kfree_skb(info->rx_skb);
 272                                         break;
 273                                 }
 274
 275                                 info->rx_state = RECV_WAIT_NSH;
 276                                 info->rx_count = NSHL;
 277                                 info->rx_skb = NULL;
 278                                 break;
 279                         }
 280
 281                 }
 282
 283                 /* Make sure we don't stay here too long */
 284                 if (boguscount++ > 32)
 285                         break;
 286
 287         } while (inb(iobase + UART_LSR) & UART_LSR_DR);
 288 }
 289
 290
 291 static irqreturn_t dtl1_interrupt(int irq, void *dev_inst)
 292 {
 293         dtl1_info_t *info = dev_inst;
 294         unsigned int iobase;
 295         unsigned char msr;
 296         int boguscount = 0;
 297         int iir, lsr;
 298         irqreturn_t r = IRQ_NONE;
 299
 300         if (!info || !info->hdev)
 301                 /* our irq handler is shared */
 302                 return IRQ_NONE;
 303
 304         iobase = info->p_dev->resource[0]->start;
 305
 306         spin_lock(&(info->lock));
 307
 308         iir = inb(iobase + UART_IIR) & UART_IIR_ID;
 309         while (iir) {
 310
 311                 r = IRQ_HANDLED;
 312                 /* Clear interrupt */
 313                 lsr = inb(iobase + UART_LSR);
 314
 315                 switch (iir) {
 316                 case UART_IIR_RLSI:
 317                         BT_ERR("RLSI");
 318                         break;
 319                 case UART_IIR_RDI:
 320                         /* Receive interrupt */
 321                         dtl1_receive(info);
 322                         break;
 323                 case UART_IIR_THRI:
 324                         if (lsr & UART_LSR_THRE) {
 325                                 /* Transmitter ready for data */
 326                                 dtl1_write_wakeup(info);
 327                         }
 328                         break;
 329                 default:
 330                         BT_ERR("Unhandled IIR=%#x", iir);
 331                         break;
 332                 }
 333
 334                 /* Make sure we don't stay here too long */
 335                 if (boguscount++ > 100)
 336                         break;
 337
 338                 iir = inb(iobase + UART_IIR) & UART_IIR_ID;
 339
 340         }
 341
 342         msr = inb(iobase + UART_MSR);
 343
 344         if (info->ri_latch ^ (msr & UART_MSR_RI)) {
 345                 info->ri_latch = msr & UART_MSR_RI;
 346                 clear_bit(XMIT_WAITING, &(info->tx_state));
 347                 dtl1_write_wakeup(info);
 348                 r = IRQ_HANDLED;
 349         }
 350
 351         spin_unlock(&(info->lock));
 352
 353         return r;
 354 }
 355
 356
 357
 358 /* ======================== HCI interface ======================== */
 359
 360
 361 static int dtl1_hci_open(struct hci_dev *hdev)
 362 {
 363         set_bit(HCI_RUNNING, &(hdev->flags));
 364
 365         return 0;
 366 }
 367
 368
 369 static int dtl1_hci_flush(struct hci_dev *hdev)
 370 {
 371         dtl1_info_t *info = (dtl1_info_t *)(hdev->driver_data);
 372
 373         /* Drop TX queue */
 374         skb_queue_purge(&(info->txq));
 375
 376         return 0;
 377 }
 378
 379
 380 static int dtl1_hci_close(struct hci_dev *hdev)
 381 {
 382         if (!test_and_clear_bit(HCI_RUNNING, &(hdev->flags)))
 383                 return 0;
 384
 385         dtl1_hci_flush(hdev);
 386
 387         return 0;
 388 }
 389
 390
 391 static int dtl1_hci_send_frame(struct sk_buff *skb)
 392 {
 393         dtl1_info_t *info;
 394         struct hci_dev *hdev = (struct hci_dev *)(skb->dev);
 395         struct sk_buff *s;
 396         nsh_t nsh;
 397
 398         if (!hdev) {
 399                 BT_ERR("Frame for unknown HCI device (hdev=NULL)");
 400                 return -ENODEV;
 401         }
 402
 403         info = (dtl1_info_t *)(hdev->driver_data);
 404
 405         switch (bt_cb(skb)->pkt_type) {
 406         case HCI_COMMAND_PKT:
 407                 hdev->stat.cmd_tx++;
 408                 nsh.type = 0x81;
 409                 break;
 410         case HCI_ACLDATA_PKT:
 411                 hdev->stat.acl_tx++;
 412                 nsh.type = 0x82;
 413                 break;
 414         case HCI_SCODATA_PKT:
 415                 hdev->stat.sco_tx++;
 416                 nsh.type = 0x83;
 417                 break;
 418         default:
 419                 return -EILSEQ;
 420         };
 421
 422         nsh.zero = 0;
 423         nsh.len = skb->len;
 424
 425         s = bt_skb_alloc(NSHL + skb->len + 1, GFP_ATOMIC);
 426         if (!s)
 427                 return -ENOMEM;
 428
 429         skb_reserve(s, NSHL);
 430         skb_copy_from_linear_data(skb, skb_put(s, skb->len), skb->len);
 431         if (skb->len & 0x0001)
 432                 *skb_put(s, 1) = 0;     /* PAD */
 433
 434         /* Prepend skb with Nokia frame header and queue */
 435         memcpy(skb_push(s, NSHL), &nsh, NSHL);
 436         skb_queue_tail(&(info->txq), s);
 437
 438         dtl1_write_wakeup(info);
 439
 440         kfree_skb(skb);
 441
 442         return 0;
 443 }
 444
 445
 446 static void dtl1_hci_destruct(struct hci_dev *hdev)
 447 {
 448 }
 449
 450
 451 static int dtl1_hci_ioctl(struct hci_dev *hdev, unsigned int cmd,  unsigned long arg)
 452 {
 453         return -ENOIOCTLCMD;
 454 }
 455
 456
 457
 458 /* ======================== Card services HCI interaction ======================== */
 459
 460
 461 static int dtl1_open(dtl1_info_t *info)
 462 {
 463         unsigned long flags;
 464         unsigned int iobase = info->p_dev->resource[0]->start;
 465         struct hci_dev *hdev;
 466
 467         spin_lock_init(&(info->lock));
 468
 469         skb_queue_head_init(&(info->txq));
 470
 471         info->rx_state = RECV_WAIT_NSH;
 472         info->rx_count = NSHL;
 473         info->rx_skb = NULL;
 474
 475         set_bit(XMIT_WAITING, &(info->tx_state));
 476
 477         /* Initialize HCI device */
 478         hdev = hci_alloc_dev();
 479         if (!hdev) {
 480                 BT_ERR("Can't allocate HCI device");
 481                 return -ENOMEM;
 482         }
 483
 484         info->hdev = hdev;
 485
 486         hdev->bus = HCI_PCCARD;
 487         hdev->driver_data = info;
 488         SET_HCIDEV_DEV(hdev, &info->p_dev->dev);
 489
 490         hdev->open     = dtl1_hci_open;
 491         hdev->close    = dtl1_hci_close;
 492         hdev->flush    = dtl1_hci_flush;
 493         hdev->send     = dtl1_hci_send_frame;
 494         hdev->destruct = dtl1_hci_destruct;
 495         hdev->ioctl    = dtl1_hci_ioctl;
 496
 497         hdev->owner = THIS_MODULE;
 498
 499         spin_lock_irqsave(&(info->lock), flags);
 500
 501         /* Reset UART */
 502         outb(0, iobase + UART_MCR);
 503
 504         /* Turn off interrupts */
 505         outb(0, iobase + UART_IER);
 506
 507         /* Initialize UART */
 508         outb(UART_LCR_WLEN8, iobase + UART_LCR);        /* Reset DLAB */
 509         outb((UART_MCR_DTR | UART_MCR_RTS | UART_MCR_OUT2), iobase + UART_MCR);
 510
 511         info->ri_latch = inb(info->p_dev->resource[0]->start + UART_MSR)
 512                                 & UART_MSR_RI;
 513
 514         /* Turn on interrupts */
 515         outb(UART_IER_RLSI | UART_IER_RDI | UART_IER_THRI, iobase + UART_IER);
 516
 517         spin_unlock_irqrestore(&(info->lock), flags);
 518
 519         /* Timeout before it is safe to send the first HCI packet */
 520         msleep(2000);
 521
 522         /* Register HCI device */
 523         if (hci_register_dev(hdev) < 0) {
 524                 BT_ERR("Can't register HCI device");
 525                 info->hdev = NULL;
 526                 hci_free_dev(hdev);
 527                 return -ENODEV;
 528         }
 529
 530         return 0;
 531 }
 532
 533
 534 static int dtl1_close(dtl1_info_t *info)
 535 {
 536         unsigned long flags;
 537         unsigned int iobase = info->p_dev->resource[0]->start;
 538         struct hci_dev *hdev = info->hdev;
 539
 540         if (!hdev)
 541                 return -ENODEV;
 542
 543         dtl1_hci_close(hdev);
 544
 545         spin_lock_irqsave(&(info->lock), flags);
 546
 547         /* Reset UART */
 548         outb(0, iobase + UART_MCR);
 549
 550         /* Turn off interrupts */
 551         outb(0, iobase + UART_IER);
 552
 553         spin_unlock_irqrestore(&(info->lock), flags);
 554
 555         if (hci_unregister_dev(hdev) < 0)
 556                 BT_ERR("Can't unregister HCI device %s", hdev->name);
 557
 558         hci_free_dev(hdev);
 559
 560         return 0;
 561 }
 562
 563 static int dtl1_probe(struct pcmcia_device *link)
 564 {
 565         dtl1_info_t *info;
 566
 567         /* Create new info device */
 568         info = kzalloc(sizeof(*info), GFP_KERNEL);
 569         if (!info)
 570                 return -ENOMEM;
 571
 572         info->p_dev = link;
 573         link->priv = info;
 574
 575         link->resource[0]->flags |= IO_DATA_PATH_WIDTH_8;
 576         link->resource[0]->end = 8;
 577
 578         link->conf.Attributes = CONF_ENABLE_IRQ;
 579         link->conf.IntType = INT_MEMORY_AND_IO;
 580
 581         return dtl1_config(link);
 582 }
 583
 584
 585 static void dtl1_detach(struct pcmcia_device *link)
 586 {
 587         dtl1_info_t *info = link->priv;
 588
 589         dtl1_release(link);
 590
 591         kfree(info);
 592 }
 593
 594 static int dtl1_confcheck(struct pcmcia_device *p_dev,
 595                           cistpl_cftable_entry_t *cf,
 596                           cistpl_cftable_entry_t *dflt,
 597                           unsigned int vcc,
 598                           void *priv_data)
 599 {
 600         if ((cf->io.nwin != 1) || (cf->io.win[0].len <= 8))
 601                 return -ENODEV;
 602
 603         p_dev->resource[0]->start = cf->io.win[0].base;
 604         p_dev->resource[0]->end = cf->io.win[0].len;    /*yo */
 605         p_dev->io_lines = cf->io.flags & CISTPL_IO_LINES_MASK;
 606         return pcmcia_request_io(p_dev);
 607 }
 608
 609 static int dtl1_config(struct pcmcia_device *link)
 610 {
 611         dtl1_info_t *info = link->priv;
 612         int i;
 613
 614         /* Look for a generic full-sized window */
 615         link->resource[0]->end = 8;
 616         if (pcmcia_loop_config(link, dtl1_confcheck, NULL) < 0)
 617                 goto failed;
 618
 619         i = pcmcia_request_irq(link, dtl1_interrupt);
 620         if (i != 0)
 621                 goto failed;
 622
 623         i = pcmcia_request_configuration(link, &link->conf);
 624         if (i != 0)
 625                 goto failed;
 626
 627         if (dtl1_open(info) != 0)
 628                 goto failed;
 629
 630         return 0;
 631
 632 failed:
 633         dtl1_release(link);
 634         return -ENODEV;
 635 }
 636
 637
 638 static void dtl1_release(struct pcmcia_device *link)
 639 {
 640         dtl1_info_t *info = link->priv;
 641
 642         dtl1_close(info);
 643
 644         pcmcia_disable_device(link);
 645 }
 646
 647
 648 static struct pcmcia_device_id dtl1_ids[] = {
 649         PCMCIA_DEVICE_PROD_ID12("Nokia Mobile Phones", "DTL-1", 0xe1bfdd64, 0xe168480d),
 650         PCMCIA_DEVICE_PROD_ID12("Nokia Mobile Phones", "DTL-4", 0xe1bfdd64, 0x9102bc82),
 651         PCMCIA_DEVICE_PROD_ID12("Socket", "CF", 0xb38bcc2e, 0x44ebf863),
 652         PCMCIA_DEVICE_PROD_ID12("Socket", "CF+ Personal Network Card", 0xb38bcc2e, 0xe732bae3),
 653         PCMCIA_DEVICE_NULL
 654 };
 655 MODULE_DEVICE_TABLE(pcmcia, dtl1_ids);
 656
 657 static struct pcmcia_driver dtl1_driver = {
 658         .owner          = THIS_MODULE,
 659         .drv            = {
 660                 .name   = "dtl1_cs",
 661         },
 662         .probe          = dtl1_probe,
 663         .remove         = dtl1_detach,
 664         .id_table       = dtl1_ids,
 665 };
 666
 667 static int __init init_dtl1_cs(void)
 668 {
 669         return pcmcia_register_driver(&dtl1_driver);
 670 }
 671
 672
 673 static void __exit exit_dtl1_cs(void)
 674 {
 675         pcmcia_unregister_driver(&dtl1_driver);
 676 }
 677
 678 module_init(init_dtl1_cs);
 679 module_exit(exit_dtl1_cs);