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