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                                         bt_cb(info->rx_skb)->pkt_type &= 0x0f;
 260                                         hci_recv_frame(info->hdev, info->rx_skb);
 261                                         break;
 262                                 default:
 263                                         /* unknown packet */
 264                                         BT_ERR("Unknown HCI packet with type 0x%02x received", bt_cb(info->rx_skb)->pkt_type);
 265                                         kfree_skb(info->rx_skb);
 266                                         break;
 267                                 }
 268
 269                                 info->rx_state = RECV_WAIT_NSH;
 270                                 info->rx_count = NSHL;
 271                                 info->rx_skb = NULL;
 272                                 break;
 273                         }
 274
 275                 }
 276
 277                 /* Make sure we don't stay here too long */
 278                 if (boguscount++ > 32)
 279                         break;
 280
 281         } while (inb(iobase + UART_LSR) & UART_LSR_DR);
 282 }
 283
 284
 285 static irqreturn_t dtl1_interrupt(int irq, void *dev_inst)
 286 {
 287         dtl1_info_t *info = dev_inst;
 288         unsigned int iobase;
 289         unsigned char msr;
 290         int boguscount = 0;
 291         int iir, lsr;
 292         irqreturn_t r = IRQ_NONE;
 293
 294         if (!info || !info->hdev)
 295                 /* our irq handler is shared */
 296                 return IRQ_NONE;
 297
 298         iobase = info->p_dev->resource[0]->start;
 299
 300         spin_lock(&(info->lock));
 301
 302         iir = inb(iobase + UART_IIR) & UART_IIR_ID;
 303         while (iir) {
 304
 305                 r = IRQ_HANDLED;
 306                 /* Clear interrupt */
 307                 lsr = inb(iobase + UART_LSR);
 308
 309                 switch (iir) {
 310                 case UART_IIR_RLSI:
 311                         BT_ERR("RLSI");
 312                         break;
 313                 case UART_IIR_RDI:
 314                         /* Receive interrupt */
 315                         dtl1_receive(info);
 316                         break;
 317                 case UART_IIR_THRI:
 318                         if (lsr & UART_LSR_THRE) {
 319                                 /* Transmitter ready for data */
 320                                 dtl1_write_wakeup(info);
 321                         }
 322                         break;
 323                 default:
 324                         BT_ERR("Unhandled IIR=%#x", iir);
 325                         break;
 326                 }
 327
 328                 /* Make sure we don't stay here too long */
 329                 if (boguscount++ > 100)
 330                         break;
 331
 332                 iir = inb(iobase + UART_IIR) & UART_IIR_ID;
 333
 334         }
 335
 336         msr = inb(iobase + UART_MSR);
 337
 338         if (info->ri_latch ^ (msr & UART_MSR_RI)) {
 339                 info->ri_latch = msr & UART_MSR_RI;
 340                 clear_bit(XMIT_WAITING, &(info->tx_state));
 341                 dtl1_write_wakeup(info);
 342                 r = IRQ_HANDLED;
 343         }
 344
 345         spin_unlock(&(info->lock));
 346
 347         return r;
 348 }
 349
 350
 351
 352 /* ======================== HCI interface ======================== */
 353
 354
 355 static int dtl1_hci_open(struct hci_dev *hdev)
 356 {
 357         set_bit(HCI_RUNNING, &(hdev->flags));
 358
 359         return 0;
 360 }
 361
 362
 363 static int dtl1_hci_flush(struct hci_dev *hdev)
 364 {
 365         dtl1_info_t *info = hci_get_drvdata(hdev);
 366
 367         /* Drop TX queue */
 368         skb_queue_purge(&(info->txq));
 369
 370         return 0;
 371 }
 372
 373
 374 static int dtl1_hci_close(struct hci_dev *hdev)
 375 {
 376         if (!test_and_clear_bit(HCI_RUNNING, &(hdev->flags)))
 377                 return 0;
 378
 379         dtl1_hci_flush(hdev);
 380
 381         return 0;
 382 }
 383
 384
 385 static int dtl1_hci_send_frame(struct hci_dev *hdev, struct sk_buff *skb)
 386 {
 387         dtl1_info_t *info = hci_get_drvdata(hdev);
 388         struct sk_buff *s;
 389         nsh_t nsh;
 390
 391         switch (bt_cb(skb)->pkt_type) {
 392         case HCI_COMMAND_PKT:
 393                 hdev->stat.cmd_tx++;
 394                 nsh.type = 0x81;
 395                 break;
 396         case HCI_ACLDATA_PKT:
 397                 hdev->stat.acl_tx++;
 398                 nsh.type = 0x82;
 399                 break;
 400         case HCI_SCODATA_PKT:
 401                 hdev->stat.sco_tx++;
 402                 nsh.type = 0x83;
 403                 break;
 404         default:
 405                 return -EILSEQ;
 406         };
 407
 408         nsh.zero = 0;
 409         nsh.len = skb->len;
 410
 411         s = bt_skb_alloc(NSHL + skb->len + 1, GFP_ATOMIC);
 412         if (!s)
 413                 return -ENOMEM;
 414
 415         skb_reserve(s, NSHL);
 416         skb_copy_from_linear_data(skb, skb_put(s, skb->len), skb->len);
 417         if (skb->len & 0x0001)
 418                 *skb_put(s, 1) = 0;     /* PAD */
 419
 420         /* Prepend skb with Nokia frame header and queue */
 421         memcpy(skb_push(s, NSHL), &nsh, NSHL);
 422         skb_queue_tail(&(info->txq), s);
 423
 424         dtl1_write_wakeup(info);
 425
 426         kfree_skb(skb);
 427
 428         return 0;
 429 }
 430
 431
 432
 433 /* ======================== Card services HCI interaction ======================== */
 434
 435
 436 static int dtl1_open(dtl1_info_t *info)
 437 {
 438         unsigned long flags;
 439         unsigned int iobase = info->p_dev->resource[0]->start;
 440         struct hci_dev *hdev;
 441
 442         spin_lock_init(&(info->lock));
 443
 444         skb_queue_head_init(&(info->txq));
 445
 446         info->rx_state = RECV_WAIT_NSH;
 447         info->rx_count = NSHL;
 448         info->rx_skb = NULL;
 449
 450         set_bit(XMIT_WAITING, &(info->tx_state));
 451
 452         /* Initialize HCI device */
 453         hdev = hci_alloc_dev();
 454         if (!hdev) {
 455                 BT_ERR("Can't allocate HCI device");
 456                 return -ENOMEM;
 457         }
 458
 459         info->hdev = hdev;
 460
 461         hdev->bus = HCI_PCCARD;
 462         hci_set_drvdata(hdev, info);
 463         SET_HCIDEV_DEV(hdev, &info->p_dev->dev);
 464
 465         hdev->open  = dtl1_hci_open;
 466         hdev->close = dtl1_hci_close;
 467         hdev->flush = dtl1_hci_flush;
 468         hdev->send  = dtl1_hci_send_frame;
 469
 470         spin_lock_irqsave(&(info->lock), flags);
 471
 472         /* Reset UART */
 473         outb(0, iobase + UART_MCR);
 474
 475         /* Turn off interrupts */
 476         outb(0, iobase + UART_IER);
 477
 478         /* Initialize UART */
 479         outb(UART_LCR_WLEN8, iobase + UART_LCR);        /* Reset DLAB */
 480         outb((UART_MCR_DTR | UART_MCR_RTS | UART_MCR_OUT2), iobase + UART_MCR);
 481
 482         info->ri_latch = inb(info->p_dev->resource[0]->start + UART_MSR)
 483                                 & UART_MSR_RI;
 484
 485         /* Turn on interrupts */
 486         outb(UART_IER_RLSI | UART_IER_RDI | UART_IER_THRI, iobase + UART_IER);
 487
 488         spin_unlock_irqrestore(&(info->lock), flags);
 489
 490         /* Timeout before it is safe to send the first HCI packet */
 491         msleep(2000);
 492
 493         /* Register HCI device */
 494         if (hci_register_dev(hdev) < 0) {
 495                 BT_ERR("Can't register HCI device");
 496                 info->hdev = NULL;
 497                 hci_free_dev(hdev);
 498                 return -ENODEV;
 499         }
 500
 501         return 0;
 502 }
 503
 504
 505 static int dtl1_close(dtl1_info_t *info)
 506 {
 507         unsigned long flags;
 508         unsigned int iobase = info->p_dev->resource[0]->start;
 509         struct hci_dev *hdev = info->hdev;
 510
 511         if (!hdev)
 512                 return -ENODEV;
 513
 514         dtl1_hci_close(hdev);
 515
 516         spin_lock_irqsave(&(info->lock), flags);
 517
 518         /* Reset UART */
 519         outb(0, iobase + UART_MCR);
 520
 521         /* Turn off interrupts */
 522         outb(0, iobase + UART_IER);
 523
 524         spin_unlock_irqrestore(&(info->lock), flags);
 525
 526         hci_unregister_dev(hdev);
 527         hci_free_dev(hdev);
 528
 529         return 0;
 530 }
 531
 532 static int dtl1_probe(struct pcmcia_device *link)
 533 {
 534         dtl1_info_t *info;
 535
 536         /* Create new info device */
 537         info = devm_kzalloc(&link->dev, sizeof(*info), GFP_KERNEL);
 538         if (!info)
 539                 return -ENOMEM;
 540
 541         info->p_dev = link;
 542         link->priv = info;
 543
 544         link->config_flags |= CONF_ENABLE_IRQ | CONF_AUTO_SET_IO;
 545
 546         return dtl1_config(link);
 547 }
 548
 549
 550 static void dtl1_detach(struct pcmcia_device *link)
 551 {
 552         dtl1_info_t *info = link->priv;
 553
 554         dtl1_close(info);
 555         pcmcia_disable_device(link);
 556 }
 557
 558 static int dtl1_confcheck(struct pcmcia_device *p_dev, void *priv_data)
 559 {
 560         if ((p_dev->resource[1]->end) || (p_dev->resource[1]->end < 8))
 561                 return -ENODEV;
 562
 563         p_dev->resource[0]->flags &= ~IO_DATA_PATH_WIDTH;
 564         p_dev->resource[0]->flags |= IO_DATA_PATH_WIDTH_8;
 565
 566         return pcmcia_request_io(p_dev);
 567 }
 568
 569 static int dtl1_config(struct pcmcia_device *link)
 570 {
 571         dtl1_info_t *info = link->priv;
 572         int ret;
 573
 574         /* Look for a generic full-sized window */
 575         link->resource[0]->end = 8;
 576         ret = pcmcia_loop_config(link, dtl1_confcheck, NULL);
 577         if (ret)
 578                 goto failed;
 579
 580         ret = pcmcia_request_irq(link, dtl1_interrupt);
 581         if (ret)
 582                 goto failed;
 583
 584         ret = pcmcia_enable_device(link);
 585         if (ret)
 586                 goto failed;
 587
 588         ret = dtl1_open(info);
 589         if (ret)
 590                 goto failed;
 591
 592         return 0;
 593
 594 failed:
 595         dtl1_detach(link);
 596         return ret;
 597 }
 598
 599 static const struct pcmcia_device_id dtl1_ids[] = {
 600         PCMCIA_DEVICE_PROD_ID12("Nokia Mobile Phones", "DTL-1", 0xe1bfdd64, 0xe168480d),
 601         PCMCIA_DEVICE_PROD_ID12("Nokia Mobile Phones", "DTL-4", 0xe1bfdd64, 0x9102bc82),
 602         PCMCIA_DEVICE_PROD_ID12("Socket", "CF", 0xb38bcc2e, 0x44ebf863),
 603         PCMCIA_DEVICE_PROD_ID12("Socket", "CF+ Personal Network Card", 0xb38bcc2e, 0xe732bae3),
 604         PCMCIA_DEVICE_NULL
 605 };
 606 MODULE_DEVICE_TABLE(pcmcia, dtl1_ids);
 607
 608 static struct pcmcia_driver dtl1_driver = {
 609         .owner          = THIS_MODULE,
 610         .name           = "dtl1_cs",
 611         .probe          = dtl1_probe,
 612         .remove         = dtl1_detach,
 613         .id_table       = dtl1_ids,
 614 };
 615 module_pcmcia_driver(dtl1_driver);