drivers/net/wireless/libertas/if_sdio.c

   1 /*
   2  *  linux/drivers/net/wireless/libertas/if_sdio.c
   3  *
   4  *  Copyright 2007-2008 Pierre Ossman
   5  *
   6  * Inspired by if_cs.c, Copyright 2007 Holger Schurig
   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 as published by
  10  * the Free Software Foundation; either version 2 of the License, or (at
  11  * your option) any later version.
  12  *
  13  * This hardware has more or less no CMD53 support, so all registers
  14  * must be accessed using sdio_readb()/sdio_writeb().
  15  *
  16  * Transfers must be in one transaction or the firmware goes bonkers.
  17  * This means that the transfer must either be small enough to do a
  18  * byte based transfer or it must be padded to a multiple of the
  19  * current block size.
  20  *
  21  * As SDIO is still new to the kernel, it is unfortunately common with
  22  * bugs in the host controllers related to that. One such bug is that
  23  * controllers cannot do transfers that aren't a multiple of 4 bytes.
  24  * If you don't have time to fix the host controller driver, you can
  25  * work around the problem by modifying if_sdio_host_to_card() and
  26  * if_sdio_card_to_host() to pad the data.
  27  */
  28
  29 #include <linux/kernel.h>
  30 #include <linux/moduleparam.h>
  31 #include <linux/firmware.h>
  32 #include <linux/netdevice.h>
  33 #include <linux/delay.h>
  34 #include <linux/mmc/card.h>
  35 #include <linux/mmc/sdio_func.h>
  36 #include <linux/mmc/sdio_ids.h>
  37
  38 #include "host.h"
  39 #include "decl.h"
  40 #include "defs.h"
  41 #include "dev.h"
  42 #include "cmd.h"
  43 #include "if_sdio.h"
  44
  45 /* The if_sdio_remove() callback function is called when
  46  * user removes this module from kernel space or ejects
  47  * the card from the slot. The driver handles these 2 cases
  48  * differently for SD8688 combo chip.
  49  * If the user is removing the module, the FUNC_SHUTDOWN
  50  * command for SD8688 is sent to the firmware.
  51  * If the card is removed, there is no need to send this command.
  52  *
  53  * The variable 'user_rmmod' is used to distinguish these two
  54  * scenarios. This flag is initialized as FALSE in case the card
  55  * is removed, and will be set to TRUE for module removal when
  56  * module_exit function is called.
  57  */
  58 static u8 user_rmmod;
  59
  60 static char *lbs_helper_name = NULL;
  61 module_param_named(helper_name, lbs_helper_name, charp, 0644);
  62
  63 static char *lbs_fw_name = NULL;
  64 module_param_named(fw_name, lbs_fw_name, charp, 0644);
  65
  66 static const struct sdio_device_id if_sdio_ids[] = {
  67         { SDIO_DEVICE(SDIO_VENDOR_ID_MARVELL,
  68                         SDIO_DEVICE_ID_MARVELL_LIBERTAS) },
  69         { SDIO_DEVICE(SDIO_VENDOR_ID_MARVELL,
  70                         SDIO_DEVICE_ID_MARVELL_8688WLAN) },
  71         { /* end: all zeroes */                         },
  72 };
  73
  74 MODULE_DEVICE_TABLE(sdio, if_sdio_ids);
  75
  76 struct if_sdio_model {
  77         int model;
  78         const char *helper;
  79         const char *firmware;
  80 };
  81
  82 static struct if_sdio_model if_sdio_models[] = {
  83         {
  84                 /* 8385 */
  85                 .model = IF_SDIO_MODEL_8385,
  86                 .helper = "sd8385_helper.bin",
  87                 .firmware = "sd8385.bin",
  88         },
  89         {
  90                 /* 8686 */
  91                 .model = IF_SDIO_MODEL_8686,
  92                 .helper = "sd8686_helper.bin",
  93                 .firmware = "sd8686.bin",
  94         },
  95         {
  96                 /* 8688 */
  97                 .model = IF_SDIO_MODEL_8688,
  98                 .helper = "sd8688_helper.bin",
  99                 .firmware = "sd8688.bin",
 100         },
 101 };
 102 MODULE_FIRMWARE("sd8385_helper.bin");
 103 MODULE_FIRMWARE("sd8385.bin");
 104 MODULE_FIRMWARE("sd8686_helper.bin");
 105 MODULE_FIRMWARE("sd8686.bin");
 106 MODULE_FIRMWARE("sd8688_helper.bin");
 107 MODULE_FIRMWARE("sd8688.bin");
 108
 109 struct if_sdio_packet {
 110         struct if_sdio_packet   *next;
 111         u16                     nb;
 112         u8                      buffer[0] __attribute__((aligned(4)));
 113 };
 114
 115 struct if_sdio_card {
 116         struct sdio_func        *func;
 117         struct lbs_private      *priv;
 118
 119         int                     model;
 120         unsigned long           ioport;
 121         unsigned int            scratch_reg;
 122
 123         const char              *helper;
 124         const char              *firmware;
 125
 126         u8                      buffer[65536];
 127
 128         spinlock_t              lock;
 129         struct if_sdio_packet   *packets;
 130
 131         struct workqueue_struct *workqueue;
 132         struct work_struct      packet_worker;
 133
 134         u8                      rx_unit;
 135 };
 136
 137 /********************************************************************/
 138 /* I/O                                                              */
 139 /********************************************************************/
 140
 141 /*
 142  *  For SD8385/SD8686, this function reads firmware status after
 143  *  the image is downloaded, or reads RX packet length when
 144  *  interrupt (with IF_SDIO_H_INT_UPLD bit set) is received.
 145  *  For SD8688, this function reads firmware status only.
 146  */
 147 static u16 if_sdio_read_scratch(struct if_sdio_card *card, int *err)
 148 {
 149         int ret;
 150         u16 scratch;
 151
 152         scratch = sdio_readb(card->func, card->scratch_reg, &ret);
 153         if (!ret)
 154                 scratch |= sdio_readb(card->func, card->scratch_reg + 1,
 155                                         &ret) << 8;
 156
 157         if (err)
 158                 *err = ret;
 159
 160         if (ret)
 161                 return 0xffff;
 162
 163         return scratch;
 164 }
 165
 166 static u8 if_sdio_read_rx_unit(struct if_sdio_card *card)
 167 {
 168         int ret;
 169         u8 rx_unit;
 170
 171         rx_unit = sdio_readb(card->func, IF_SDIO_RX_UNIT, &ret);
 172
 173         if (ret)
 174                 rx_unit = 0;
 175
 176         return rx_unit;
 177 }
 178
 179 static u16 if_sdio_read_rx_len(struct if_sdio_card *card, int *err)
 180 {
 181         int ret;
 182         u16 rx_len;
 183
 184         switch (card->model) {
 185         case IF_SDIO_MODEL_8385:
 186         case IF_SDIO_MODEL_8686:
 187                 rx_len = if_sdio_read_scratch(card, &ret);
 188                 break;
 189         case IF_SDIO_MODEL_8688:
 190         default: /* for newer chipsets */
 191                 rx_len = sdio_readb(card->func, IF_SDIO_RX_LEN, &ret);
 192                 if (!ret)
 193                         rx_len <<= card->rx_unit;
 194                 else
 195                         rx_len = 0xffff;        /* invalid length */
 196
 197                 break;
 198         }
 199
 200         if (err)
 201                 *err = ret;
 202
 203         return rx_len;
 204 }
 205
 206 static int if_sdio_handle_cmd(struct if_sdio_card *card,
 207                 u8 *buffer, unsigned size)
 208 {
 209         struct lbs_private *priv = card->priv;
 210         int ret;
 211         unsigned long flags;
 212         u8 i;
 213
 214         lbs_deb_enter(LBS_DEB_SDIO);
 215
 216         if (size > LBS_CMD_BUFFER_SIZE) {
 217                 lbs_deb_sdio("response packet too large (%d bytes)\n",
 218                         (int)size);
 219                 ret = -E2BIG;
 220                 goto out;
 221         }
 222
 223         spin_lock_irqsave(&priv->driver_lock, flags);
 224
 225         i = (priv->resp_idx == 0) ? 1 : 0;
 226         BUG_ON(priv->resp_len[i]);
 227         priv->resp_len[i] = size;
 228         memcpy(priv->resp_buf[i], buffer, size);
 229         lbs_notify_command_response(priv, i);
 230
 231         spin_unlock_irqrestore(&card->priv->driver_lock, flags);
 232
 233         ret = 0;
 234
 235 out:
 236         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
 237         return ret;
 238 }
 239
 240 static int if_sdio_handle_data(struct if_sdio_card *card,
 241                 u8 *buffer, unsigned size)
 242 {
 243         int ret;
 244         struct sk_buff *skb;
 245         char *data;
 246
 247         lbs_deb_enter(LBS_DEB_SDIO);
 248
 249         if (size > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE) {
 250                 lbs_deb_sdio("response packet too large (%d bytes)\n",
 251                         (int)size);
 252                 ret = -E2BIG;
 253                 goto out;
 254         }
 255
 256         skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE + NET_IP_ALIGN);
 257         if (!skb) {
 258                 ret = -ENOMEM;
 259                 goto out;
 260         }
 261
 262         skb_reserve(skb, NET_IP_ALIGN);
 263
 264         data = skb_put(skb, size);
 265
 266         memcpy(data, buffer, size);
 267
 268         lbs_process_rxed_packet(card->priv, skb);
 269
 270         ret = 0;
 271
 272 out:
 273         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
 274
 275         return ret;
 276 }
 277
 278 static int if_sdio_handle_event(struct if_sdio_card *card,
 279                 u8 *buffer, unsigned size)
 280 {
 281         int ret;
 282         u32 event;
 283
 284         lbs_deb_enter(LBS_DEB_SDIO);
 285
 286         if (card->model == IF_SDIO_MODEL_8385) {
 287                 event = sdio_readb(card->func, IF_SDIO_EVENT, &ret);
 288                 if (ret)
 289                         goto out;
 290
 291                 /* right shift 3 bits to get the event id */
 292                 event >>= 3;
 293         } else {
 294                 if (size < 4) {
 295                         lbs_deb_sdio("event packet too small (%d bytes)\n",
 296                                 (int)size);
 297                         ret = -EINVAL;
 298                         goto out;
 299                 }
 300                 event = buffer[3] << 24;
 301                 event |= buffer[2] << 16;
 302                 event |= buffer[1] << 8;
 303                 event |= buffer[0] << 0;
 304         }
 305
 306         lbs_queue_event(card->priv, event & 0xFF);
 307         ret = 0;
 308
 309 out:
 310         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
 311
 312         return ret;
 313 }
 314
 315 static int if_sdio_card_to_host(struct if_sdio_card *card)
 316 {
 317         int ret;
 318         u8 status;
 319         u16 size, type, chunk;
 320         unsigned long timeout;
 321
 322         lbs_deb_enter(LBS_DEB_SDIO);
 323
 324         size = if_sdio_read_rx_len(card, &ret);
 325         if (ret)
 326                 goto out;
 327
 328         if (size < 4) {
 329                 lbs_deb_sdio("invalid packet size (%d bytes) from firmware\n",
 330                         (int)size);
 331                 ret = -EINVAL;
 332                 goto out;
 333         }
 334
 335         timeout = jiffies + HZ;
 336         while (1) {
 337                 status = sdio_readb(card->func, IF_SDIO_STATUS, &ret);
 338                 if (ret)
 339                         goto out;
 340                 if (status & IF_SDIO_IO_RDY)
 341                         break;
 342                 if (time_after(jiffies, timeout)) {
 343                         ret = -ETIMEDOUT;
 344                         goto out;
 345                 }
 346                 mdelay(1);
 347         }
 348
 349         /*
 350          * The transfer must be in one transaction or the firmware
 351          * goes suicidal. There's no way to guarantee that for all
 352          * controllers, but we can at least try.
 353          */
 354         chunk = sdio_align_size(card->func, size);
 355
 356         ret = sdio_readsb(card->func, card->buffer, card->ioport, chunk);
 357         if (ret)
 358                 goto out;
 359
 360         chunk = card->buffer[0] | (card->buffer[1] << 8);
 361         type = card->buffer[2] | (card->buffer[3] << 8);
 362
 363         lbs_deb_sdio("packet of type %d and size %d bytes\n",
 364                 (int)type, (int)chunk);
 365
 366         if (chunk > size) {
 367                 lbs_deb_sdio("packet fragment (%d > %d)\n",
 368                         (int)chunk, (int)size);
 369                 ret = -EINVAL;
 370                 goto out;
 371         }
 372
 373         if (chunk < size) {
 374                 lbs_deb_sdio("packet fragment (%d < %d)\n",
 375                         (int)chunk, (int)size);
 376         }
 377
 378         switch (type) {
 379         case MVMS_CMD:
 380                 ret = if_sdio_handle_cmd(card, card->buffer + 4, chunk - 4);
 381                 if (ret)
 382                         goto out;
 383                 break;
 384         case MVMS_DAT:
 385                 ret = if_sdio_handle_data(card, card->buffer + 4, chunk - 4);
 386                 if (ret)
 387                         goto out;
 388                 break;
 389         case MVMS_EVENT:
 390                 ret = if_sdio_handle_event(card, card->buffer + 4, chunk - 4);
 391                 if (ret)
 392                         goto out;
 393                 break;
 394         default:
 395                 lbs_deb_sdio("invalid type (%d) from firmware\n",
 396                                 (int)type);
 397                 ret = -EINVAL;
 398                 goto out;
 399         }
 400
 401 out:
 402         if (ret)
 403                 lbs_pr_err("problem fetching packet from firmware\n");
 404
 405         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
 406
 407         return ret;
 408 }
 409
 410 static void if_sdio_host_to_card_worker(struct work_struct *work)
 411 {
 412         struct if_sdio_card *card;
 413         struct if_sdio_packet *packet;
 414         unsigned long timeout;
 415         u8 status;
 416         int ret;
 417         unsigned long flags;
 418
 419         lbs_deb_enter(LBS_DEB_SDIO);
 420
 421         card = container_of(work, struct if_sdio_card, packet_worker);
 422
 423         while (1) {
 424                 spin_lock_irqsave(&card->lock, flags);
 425                 packet = card->packets;
 426                 if (packet)
 427                         card->packets = packet->next;
 428                 spin_unlock_irqrestore(&card->lock, flags);
 429
 430                 if (!packet)
 431                         break;
 432
 433                 sdio_claim_host(card->func);
 434
 435                 timeout = jiffies + HZ;
 436                 while (1) {
 437                         status = sdio_readb(card->func, IF_SDIO_STATUS, &ret);
 438                         if (ret)
 439                                 goto release;
 440                         if (status & IF_SDIO_IO_RDY)
 441                                 break;
 442                         if (time_after(jiffies, timeout)) {
 443                                 ret = -ETIMEDOUT;
 444                                 goto release;
 445                         }
 446                         mdelay(1);
 447                 }
 448
 449                 ret = sdio_writesb(card->func, card->ioport,
 450                                 packet->buffer, packet->nb);
 451                 if (ret)
 452                         goto release;
 453 release:
 454                 sdio_release_host(card->func);
 455
 456                 kfree(packet);
 457         }
 458
 459         lbs_deb_leave(LBS_DEB_SDIO);
 460 }
 461
 462 /********************************************************************/
 463 /* Firmware                                                         */
 464 /********************************************************************/
 465
 466 static int if_sdio_prog_helper(struct if_sdio_card *card)
 467 {
 468         int ret;
 469         u8 status;
 470         const struct firmware *fw;
 471         unsigned long timeout;
 472         u8 *chunk_buffer;
 473         u32 chunk_size;
 474         const u8 *firmware;
 475         size_t size;
 476
 477         lbs_deb_enter(LBS_DEB_SDIO);
 478
 479         ret = request_firmware(&fw, card->helper, &card->func->dev);
 480         if (ret) {
 481                 lbs_pr_err("can't load helper firmware\n");
 482                 goto out;
 483         }
 484
 485         chunk_buffer = kzalloc(64, GFP_KERNEL);
 486         if (!chunk_buffer) {
 487                 ret = -ENOMEM;
 488                 goto release_fw;
 489         }
 490
 491         sdio_claim_host(card->func);
 492
 493         ret = sdio_set_block_size(card->func, 32);
 494         if (ret)
 495                 goto release;
 496
 497         firmware = fw->data;
 498         size = fw->size;
 499
 500         while (size) {
 501                 timeout = jiffies + HZ;
 502                 while (1) {
 503                         status = sdio_readb(card->func, IF_SDIO_STATUS, &ret);
 504                         if (ret)
 505                                 goto release;
 506                         if ((status & IF_SDIO_IO_RDY) &&
 507                                         (status & IF_SDIO_DL_RDY))
 508                                 break;
 509                         if (time_after(jiffies, timeout)) {
 510                                 ret = -ETIMEDOUT;
 511                                 goto release;
 512                         }
 513                         mdelay(1);
 514                 }
 515
 516                 chunk_size = min(size, (size_t)60);
 517
 518                 *((__le32*)chunk_buffer) = cpu_to_le32(chunk_size);
 519                 memcpy(chunk_buffer + 4, firmware, chunk_size);
 520 /*
 521                 lbs_deb_sdio("sending %d bytes chunk\n", chunk_size);
 522 */
 523                 ret = sdio_writesb(card->func, card->ioport,
 524                                 chunk_buffer, 64);
 525                 if (ret)
 526                         goto release;
 527
 528                 firmware += chunk_size;
 529                 size -= chunk_size;
 530         }
 531
 532         /* an empty block marks the end of the transfer */
 533         memset(chunk_buffer, 0, 4);
 534         ret = sdio_writesb(card->func, card->ioport, chunk_buffer, 64);
 535         if (ret)
 536                 goto release;
 537
 538         lbs_deb_sdio("waiting for helper to boot...\n");
 539
 540         /* wait for the helper to boot by looking at the size register */
 541         timeout = jiffies + HZ;
 542         while (1) {
 543                 u16 req_size;
 544
 545                 req_size = sdio_readb(card->func, IF_SDIO_RD_BASE, &ret);
 546                 if (ret)
 547                         goto release;
 548
 549                 req_size |= sdio_readb(card->func, IF_SDIO_RD_BASE + 1, &ret) << 8;
 550                 if (ret)
 551                         goto release;
 552
 553                 if (req_size != 0)
 554                         break;
 555
 556                 if (time_after(jiffies, timeout)) {
 557                         ret = -ETIMEDOUT;
 558                         goto release;
 559                 }
 560
 561                 msleep(10);
 562         }
 563
 564         ret = 0;
 565
 566 release:
 567         sdio_release_host(card->func);
 568         kfree(chunk_buffer);
 569 release_fw:
 570         release_firmware(fw);
 571
 572 out:
 573         if (ret)
 574                 lbs_pr_err("failed to load helper firmware\n");
 575
 576         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
 577
 578         return ret;
 579 }
 580
 581 static int if_sdio_prog_real(struct if_sdio_card *card)
 582 {
 583         int ret;
 584         u8 status;
 585         const struct firmware *fw;
 586         unsigned long timeout;
 587         u8 *chunk_buffer;
 588         u32 chunk_size;
 589         const u8 *firmware;
 590         size_t size, req_size;
 591
 592         lbs_deb_enter(LBS_DEB_SDIO);
 593
 594         ret = request_firmware(&fw, card->firmware, &card->func->dev);
 595         if (ret) {
 596                 lbs_pr_err("can't load firmware\n");
 597                 goto out;
 598         }
 599
 600         chunk_buffer = kzalloc(512, GFP_KERNEL);
 601         if (!chunk_buffer) {
 602                 ret = -ENOMEM;
 603                 goto release_fw;
 604         }
 605
 606         sdio_claim_host(card->func);
 607
 608         ret = sdio_set_block_size(card->func, 32);
 609         if (ret)
 610                 goto release;
 611
 612         firmware = fw->data;
 613         size = fw->size;
 614
 615         while (size) {
 616                 timeout = jiffies + HZ;
 617                 while (1) {
 618                         status = sdio_readb(card->func, IF_SDIO_STATUS, &ret);
 619                         if (ret)
 620                                 goto release;
 621                         if ((status & IF_SDIO_IO_RDY) &&
 622                                         (status & IF_SDIO_DL_RDY))
 623                                 break;
 624                         if (time_after(jiffies, timeout)) {
 625                                 ret = -ETIMEDOUT;
 626                                 goto release;
 627                         }
 628                         mdelay(1);
 629                 }
 630
 631                 req_size = sdio_readb(card->func, IF_SDIO_RD_BASE, &ret);
 632                 if (ret)
 633                         goto release;
 634
 635                 req_size |= sdio_readb(card->func, IF_SDIO_RD_BASE + 1, &ret) << 8;
 636                 if (ret)
 637                         goto release;
 638 /*
 639                 lbs_deb_sdio("firmware wants %d bytes\n", (int)req_size);
 640 */
 641                 if (req_size == 0) {
 642                         lbs_deb_sdio("firmware helper gave up early\n");
 643                         ret = -EIO;
 644                         goto release;
 645                 }
 646
 647                 if (req_size & 0x01) {
 648                         lbs_deb_sdio("firmware helper signalled error\n");
 649                         ret = -EIO;
 650                         goto release;
 651                 }
 652
 653                 if (req_size > size)
 654                         req_size = size;
 655
 656                 while (req_size) {
 657                         chunk_size = min(req_size, (size_t)512);
 658
 659                         memcpy(chunk_buffer, firmware, chunk_size);
 660 /*
 661                         lbs_deb_sdio("sending %d bytes (%d bytes) chunk\n",
 662                                 chunk_size, (chunk_size + 31) / 32 * 32);
 663 */
 664                         ret = sdio_writesb(card->func, card->ioport,
 665                                 chunk_buffer, roundup(chunk_size, 32));
 666                         if (ret)
 667                                 goto release;
 668
 669                         firmware += chunk_size;
 670                         size -= chunk_size;
 671                         req_size -= chunk_size;
 672                 }
 673         }
 674
 675         ret = 0;
 676
 677         lbs_deb_sdio("waiting for firmware to boot...\n");
 678
 679         /* wait for the firmware to boot */
 680         timeout = jiffies + HZ;
 681         while (1) {
 682                 u16 scratch;
 683
 684                 scratch = if_sdio_read_scratch(card, &ret);
 685                 if (ret)
 686                         goto release;
 687
 688                 if (scratch == IF_SDIO_FIRMWARE_OK)
 689                         break;
 690
 691                 if (time_after(jiffies, timeout)) {
 692                         ret = -ETIMEDOUT;
 693                         goto release;
 694                 }
 695
 696                 msleep(10);
 697         }
 698
 699         ret = 0;
 700
 701 release:
 702         sdio_release_host(card->func);
 703         kfree(chunk_buffer);
 704 release_fw:
 705         release_firmware(fw);
 706
 707 out:
 708         if (ret)
 709                 lbs_pr_err("failed to load firmware\n");
 710
 711         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
 712
 713         return ret;
 714 }
 715
 716 static int if_sdio_prog_firmware(struct if_sdio_card *card)
 717 {
 718         int ret;
 719         u16 scratch;
 720
 721         lbs_deb_enter(LBS_DEB_SDIO);
 722
 723         sdio_claim_host(card->func);
 724         scratch = if_sdio_read_scratch(card, &ret);
 725         sdio_release_host(card->func);
 726
 727         if (ret)
 728                 goto out;
 729
 730         lbs_deb_sdio("firmware status = %#x\n", scratch);
 731
 732         if (scratch == IF_SDIO_FIRMWARE_OK) {
 733                 lbs_deb_sdio("firmware already loaded\n");
 734                 goto success;
 735         }
 736
 737         ret = if_sdio_prog_helper(card);
 738         if (ret)
 739                 goto out;
 740
 741         ret = if_sdio_prog_real(card);
 742         if (ret)
 743                 goto out;
 744
 745 success:
 746         sdio_claim_host(card->func);
 747         sdio_set_block_size(card->func, IF_SDIO_BLOCK_SIZE);
 748         sdio_release_host(card->func);
 749         ret = 0;
 750
 751 out:
 752         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
 753
 754         return ret;
 755 }
 756
 757 /*******************************************************************/
 758 /* Libertas callbacks                                              */
 759 /*******************************************************************/
 760
 761 static int if_sdio_host_to_card(struct lbs_private *priv,
 762                 u8 type, u8 *buf, u16 nb)
 763 {
 764         int ret;
 765         struct if_sdio_card *card;
 766         struct if_sdio_packet *packet, *cur;
 767         u16 size;
 768         unsigned long flags;
 769
 770         lbs_deb_enter_args(LBS_DEB_SDIO, "type %d, bytes %d", type, nb);
 771
 772         card = priv->card;
 773
 774         if (nb > (65536 - sizeof(struct if_sdio_packet) - 4)) {
 775                 ret = -EINVAL;
 776                 goto out;
 777         }
 778
 779         /*
 780          * The transfer must be in one transaction or the firmware
 781          * goes suicidal. There's no way to guarantee that for all
 782          * controllers, but we can at least try.
 783          */
 784         size = sdio_align_size(card->func, nb + 4);
 785
 786         packet = kzalloc(sizeof(struct if_sdio_packet) + size,
 787                         GFP_ATOMIC);
 788         if (!packet) {
 789                 ret = -ENOMEM;
 790                 goto out;
 791         }
 792
 793         packet->next = NULL;
 794         packet->nb = size;
 795
 796         /*
 797          * SDIO specific header.
 798          */
 799         packet->buffer[0] = (nb + 4) & 0xff;
 800         packet->buffer[1] = ((nb + 4) >> 8) & 0xff;
 801         packet->buffer[2] = type;
 802         packet->buffer[3] = 0;
 803
 804         memcpy(packet->buffer + 4, buf, nb);
 805
 806         spin_lock_irqsave(&card->lock, flags);
 807
 808         if (!card->packets)
 809                 card->packets = packet;
 810         else {
 811                 cur = card->packets;
 812                 while (cur->next)
 813                         cur = cur->next;
 814                 cur->next = packet;
 815         }
 816
 817         switch (type) {
 818         case MVMS_CMD:
 819                 priv->dnld_sent = DNLD_CMD_SENT;
 820                 break;
 821         case MVMS_DAT:
 822                 priv->dnld_sent = DNLD_DATA_SENT;
 823                 break;
 824         default:
 825                 lbs_deb_sdio("unknown packet type %d\n", (int)type);
 826         }
 827
 828         spin_unlock_irqrestore(&card->lock, flags);
 829
 830         queue_work(card->workqueue, &card->packet_worker);
 831
 832         ret = 0;
 833
 834 out:
 835         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
 836
 837         return ret;
 838 }
 839
 840 static int if_sdio_enter_deep_sleep(struct lbs_private *priv)
 841 {
 842         int ret = -1;
 843         struct cmd_header cmd;
 844
 845         memset(&cmd, 0, sizeof(cmd));
 846
 847         lbs_deb_sdio("send DEEP_SLEEP command\n");
 848         ret = __lbs_cmd(priv, CMD_802_11_DEEP_SLEEP, &cmd, sizeof(cmd),
 849                         lbs_cmd_copyback, (unsigned long) &cmd);
 850         if (ret)
 851                 lbs_pr_err("DEEP_SLEEP cmd failed\n");
 852
 853         mdelay(200);
 854         return ret;
 855 }
 856
 857 static int if_sdio_exit_deep_sleep(struct lbs_private *priv)
 858 {
 859         struct if_sdio_card *card = priv->card;
 860         int ret = -1;
 861
 862         lbs_deb_enter(LBS_DEB_SDIO);
 863         sdio_claim_host(card->func);
 864
 865         sdio_writeb(card->func, HOST_POWER_UP, CONFIGURATION_REG, &ret);
 866         if (ret)
 867                 lbs_pr_err("sdio_writeb failed!\n");
 868
 869         sdio_release_host(card->func);
 870         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
 871         return ret;
 872 }
 873
 874 static int if_sdio_reset_deep_sleep_wakeup(struct lbs_private *priv)
 875 {
 876         struct if_sdio_card *card = priv->card;
 877         int ret = -1;
 878
 879         lbs_deb_enter(LBS_DEB_SDIO);
 880         sdio_claim_host(card->func);
 881
 882         sdio_writeb(card->func, 0, CONFIGURATION_REG, &ret);
 883         if (ret)
 884                 lbs_pr_err("sdio_writeb failed!\n");
 885
 886         sdio_release_host(card->func);
 887         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
 888         return ret;
 889
 890 }
 891
 892 /*******************************************************************/
 893 /* SDIO callbacks                                                  */
 894 /*******************************************************************/
 895
 896 static void if_sdio_interrupt(struct sdio_func *func)
 897 {
 898         int ret;
 899         struct if_sdio_card *card;
 900         u8 cause;
 901
 902         lbs_deb_enter(LBS_DEB_SDIO);
 903
 904         card = sdio_get_drvdata(func);
 905
 906         cause = sdio_readb(card->func, IF_SDIO_H_INT_STATUS, &ret);
 907         if (ret)
 908                 goto out;
 909
 910         lbs_deb_sdio("interrupt: 0x%X\n", (unsigned)cause);
 911
 912         sdio_writeb(card->func, ~cause, IF_SDIO_H_INT_STATUS, &ret);
 913         if (ret)
 914                 goto out;
 915
 916         /*
 917          * Ignore the define name, this really means the card has
 918          * successfully received the command.
 919          */
 920         card->priv->is_activity_detected = 1;
 921         if (cause & IF_SDIO_H_INT_DNLD)
 922                 lbs_host_to_card_done(card->priv);
 923
 924
 925         if (cause & IF_SDIO_H_INT_UPLD) {
 926                 ret = if_sdio_card_to_host(card);
 927                 if (ret)
 928                         goto out;
 929         }
 930
 931         ret = 0;
 932
 933 out:
 934         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
 935 }
 936
 937 static int if_sdio_probe(struct sdio_func *func,
 938                 const struct sdio_device_id *id)
 939 {
 940         struct if_sdio_card *card;
 941         struct lbs_private *priv;
 942         int ret, i;
 943         unsigned int model;
 944         struct if_sdio_packet *packet;
 945
 946         lbs_deb_enter(LBS_DEB_SDIO);
 947
 948         for (i = 0;i < func->card->num_info;i++) {
 949                 if (sscanf(func->card->info[i],
 950                                 "802.11 SDIO ID: %x", &model) == 1)
 951                         break;
 952                 if (sscanf(func->card->info[i],
 953                                 "ID: %x", &model) == 1)
 954                         break;
 955                 if (!strcmp(func->card->info[i], "IBIS Wireless SDIO Card")) {
 956                         model = IF_SDIO_MODEL_8385;
 957                         break;
 958                 }
 959         }
 960
 961         if (i == func->card->num_info) {
 962                 lbs_pr_err("unable to identify card model\n");
 963                 return -ENODEV;
 964         }
 965
 966         card = kzalloc(sizeof(struct if_sdio_card), GFP_KERNEL);
 967         if (!card)
 968                 return -ENOMEM;
 969
 970         card->func = func;
 971         card->model = model;
 972
 973         switch (card->model) {
 974         case IF_SDIO_MODEL_8385:
 975                 card->scratch_reg = IF_SDIO_SCRATCH_OLD;
 976                 break;
 977         case IF_SDIO_MODEL_8686:
 978                 card->scratch_reg = IF_SDIO_SCRATCH;
 979                 break;
 980         case IF_SDIO_MODEL_8688:
 981         default: /* for newer chipsets */
 982                 card->scratch_reg = IF_SDIO_FW_STATUS;
 983                 break;
 984         }
 985
 986         spin_lock_init(&card->lock);
 987         card->workqueue = create_workqueue("libertas_sdio");
 988         INIT_WORK(&card->packet_worker, if_sdio_host_to_card_worker);
 989
 990         for (i = 0;i < ARRAY_SIZE(if_sdio_models);i++) {
 991                 if (card->model == if_sdio_models[i].model)
 992                         break;
 993         }
 994
 995         if (i == ARRAY_SIZE(if_sdio_models)) {
 996                 lbs_pr_err("unknown card model 0x%x\n", card->model);
 997                 ret = -ENODEV;
 998                 goto free;
 999         }
1000
1001         card->helper = if_sdio_models[i].helper;
1002         card->firmware = if_sdio_models[i].firmware;
1003
1004         if (lbs_helper_name) {
1005                 lbs_deb_sdio("overriding helper firmware: %s\n",
1006                         lbs_helper_name);
1007                 card->helper = lbs_helper_name;
1008         }
1009
1010         if (lbs_fw_name) {
1011                 lbs_deb_sdio("overriding firmware: %s\n", lbs_fw_name);
1012                 card->firmware = lbs_fw_name;
1013         }
1014
1015         sdio_claim_host(func);
1016
1017         ret = sdio_enable_func(func);
1018         if (ret)
1019                 goto release;
1020
1021         ret = sdio_claim_irq(func, if_sdio_interrupt);
1022         if (ret)
1023                 goto disable;
1024
1025         card->ioport = sdio_readb(func, IF_SDIO_IOPORT, &ret);
1026         if (ret)
1027                 goto release_int;
1028
1029         card->ioport |= sdio_readb(func, IF_SDIO_IOPORT + 1, &ret) << 8;
1030         if (ret)
1031                 goto release_int;
1032
1033         card->ioport |= sdio_readb(func, IF_SDIO_IOPORT + 2, &ret) << 16;
1034         if (ret)
1035                 goto release_int;
1036
1037         sdio_release_host(func);
1038
1039         sdio_set_drvdata(func, card);
1040
1041         lbs_deb_sdio("class = 0x%X, vendor = 0x%X, "
1042                         "device = 0x%X, model = 0x%X, ioport = 0x%X\n",
1043                         func->class, func->vendor, func->device,
1044                         model, (unsigned)card->ioport);
1045
1046         ret = if_sdio_prog_firmware(card);
1047         if (ret)
1048                 goto reclaim;
1049
1050         priv = lbs_add_card(card, &func->dev);
1051         if (!priv) {
1052                 ret = -ENOMEM;
1053                 goto reclaim;
1054         }
1055
1056         card->priv = priv;
1057
1058         priv->card = card;
1059         priv->hw_host_to_card = if_sdio_host_to_card;
1060         priv->enter_deep_sleep = if_sdio_enter_deep_sleep;
1061         priv->exit_deep_sleep = if_sdio_exit_deep_sleep;
1062         priv->reset_deep_sleep_wakeup = if_sdio_reset_deep_sleep_wakeup;
1063
1064         priv->fw_ready = 1;
1065
1066         sdio_claim_host(func);
1067
1068         /*
1069          * Get rx_unit if the chip is SD8688 or newer.
1070          * SD8385 & SD8686 do not have rx_unit.
1071          */
1072         if ((card->model != IF_SDIO_MODEL_8385)
1073                         && (card->model != IF_SDIO_MODEL_8686))
1074                 card->rx_unit = if_sdio_read_rx_unit(card);
1075         else
1076                 card->rx_unit = 0;
1077
1078         /*
1079          * Enable interrupts now that everything is set up
1080          */
1081         sdio_writeb(func, 0x0f, IF_SDIO_H_INT_MASK, &ret);
1082         sdio_release_host(func);
1083         if (ret)
1084                 goto reclaim;
1085
1086         /*
1087          * FUNC_INIT is required for SD8688 WLAN/BT multiple functions
1088          */
1089         if (card->model == IF_SDIO_MODEL_8688) {
1090                 struct cmd_header cmd;
1091
1092                 memset(&cmd, 0, sizeof(cmd));
1093
1094                 lbs_deb_sdio("send function INIT command\n");
1095                 if (__lbs_cmd(priv, CMD_FUNC_INIT, &cmd, sizeof(cmd),
1096                                 lbs_cmd_copyback, (unsigned long) &cmd))
1097                         lbs_pr_alert("CMD_FUNC_INIT cmd failed\n");
1098         }
1099
1100         ret = lbs_start_card(priv);
1101         if (ret)
1102                 goto err_activate_card;
1103
1104 out:
1105         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
1106
1107         return ret;
1108
1109 err_activate_card:
1110         flush_workqueue(card->workqueue);
1111         lbs_remove_card(priv);
1112 reclaim:
1113         sdio_claim_host(func);
1114 release_int:
1115         sdio_release_irq(func);
1116 disable:
1117         sdio_disable_func(func);
1118 release:
1119         sdio_release_host(func);
1120 free:
1121         destroy_workqueue(card->workqueue);
1122         while (card->packets) {
1123                 packet = card->packets;
1124                 card->packets = card->packets->next;
1125                 kfree(packet);
1126         }
1127
1128         kfree(card);
1129
1130         goto out;
1131 }
1132
1133 static void if_sdio_remove(struct sdio_func *func)
1134 {
1135         struct if_sdio_card *card;
1136         struct if_sdio_packet *packet;
1137
1138         lbs_deb_enter(LBS_DEB_SDIO);
1139
1140         card = sdio_get_drvdata(func);
1141
1142         if (user_rmmod && (card->model == IF_SDIO_MODEL_8688)) {
1143                 /*
1144                  * FUNC_SHUTDOWN is required for SD8688 WLAN/BT
1145                  * multiple functions
1146                  */
1147                 struct cmd_header cmd;
1148
1149                 memset(&cmd, 0, sizeof(cmd));
1150
1151                 lbs_deb_sdio("send function SHUTDOWN command\n");
1152                 if (__lbs_cmd(card->priv, CMD_FUNC_SHUTDOWN,
1153                                 &cmd, sizeof(cmd), lbs_cmd_copyback,
1154                                 (unsigned long) &cmd))
1155                         lbs_pr_alert("CMD_FUNC_SHUTDOWN cmd failed\n");
1156         }
1157
1158
1159         lbs_deb_sdio("call remove card\n");
1160         lbs_stop_card(card->priv);
1161         lbs_remove_card(card->priv);
1162         card->priv->surpriseremoved = 1;
1163
1164         flush_workqueue(card->workqueue);
1165         destroy_workqueue(card->workqueue);
1166
1167         sdio_claim_host(func);
1168         sdio_release_irq(func);
1169         sdio_disable_func(func);
1170         sdio_release_host(func);
1171
1172         while (card->packets) {
1173                 packet = card->packets;
1174                 card->packets = card->packets->next;
1175                 kfree(packet);
1176         }
1177
1178         kfree(card);
1179
1180         lbs_deb_leave(LBS_DEB_SDIO);
1181 }
1182
1183 static struct sdio_driver if_sdio_driver = {
1184         .name           = "libertas_sdio",
1185         .id_table       = if_sdio_ids,
1186         .probe          = if_sdio_probe,
1187         .remove         = if_sdio_remove,
1188 };
1189
1190 /*******************************************************************/
1191 /* Module functions                                                */
1192 /*******************************************************************/
1193
1194 static int __init if_sdio_init_module(void)
1195 {
1196         int ret = 0;
1197
1198         lbs_deb_enter(LBS_DEB_SDIO);
1199
1200         printk(KERN_INFO "libertas_sdio: Libertas SDIO driver\n");
1201         printk(KERN_INFO "libertas_sdio: Copyright Pierre Ossman\n");
1202
1203         ret = sdio_register_driver(&if_sdio_driver);
1204
1205         /* Clear the flag in case user removes the card. */
1206         user_rmmod = 0;
1207
1208         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
1209
1210         return ret;
1211 }
1212
1213 static void __exit if_sdio_exit_module(void)
1214 {
1215         lbs_deb_enter(LBS_DEB_SDIO);
1216
1217         /* Set the flag as user is removing this module. */
1218         user_rmmod = 1;
1219
1220         sdio_unregister_driver(&if_sdio_driver);
1221
1222         lbs_deb_leave(LBS_DEB_SDIO);
1223 }
1224
1225 module_init(if_sdio_init_module);
1226 module_exit(if_sdio_exit_module);
1227
1228 MODULE_DESCRIPTION("Libertas SDIO WLAN Driver");
1229 MODULE_AUTHOR("Pierre Ossman");
1230 MODULE_LICENSE("GPL");