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/slab.h>
  32 #include <linux/firmware.h>
  33 #include <linux/netdevice.h>
  34 #include <linux/delay.h>
  35 #include <linux/mmc/card.h>
  36 #include <linux/mmc/sdio_func.h>
  37 #include <linux/mmc/sdio_ids.h>
  38 #include <linux/mmc/sdio.h>
  39 #include <linux/mmc/host.h>
  40
  41 #include "host.h"
  42 #include "decl.h"
  43 #include "defs.h"
  44 #include "dev.h"
  45 #include "cmd.h"
  46 #include "if_sdio.h"
  47
  48 /* The if_sdio_remove() callback function is called when
  49  * user removes this module from kernel space or ejects
  50  * the card from the slot. The driver handles these 2 cases
  51  * differently for SD8688 combo chip.
  52  * If the user is removing the module, the FUNC_SHUTDOWN
  53  * command for SD8688 is sent to the firmware.
  54  * If the card is removed, there is no need to send this command.
  55  *
  56  * The variable 'user_rmmod' is used to distinguish these two
  57  * scenarios. This flag is initialized as FALSE in case the card
  58  * is removed, and will be set to TRUE for module removal when
  59  * module_exit function is called.
  60  */
  61 static u8 user_rmmod;
  62
  63 static char *lbs_helper_name = NULL;
  64 module_param_named(helper_name, lbs_helper_name, charp, 0644);
  65
  66 static char *lbs_fw_name = NULL;
  67 module_param_named(fw_name, lbs_fw_name, charp, 0644);
  68
  69 static const struct sdio_device_id if_sdio_ids[] = {
  70         { SDIO_DEVICE(SDIO_VENDOR_ID_MARVELL,
  71                         SDIO_DEVICE_ID_MARVELL_LIBERTAS) },
  72         { SDIO_DEVICE(SDIO_VENDOR_ID_MARVELL,
  73                         SDIO_DEVICE_ID_MARVELL_8688WLAN) },
  74         { /* end: all zeroes */                         },
  75 };
  76
  77 MODULE_DEVICE_TABLE(sdio, if_sdio_ids);
  78
  79 struct if_sdio_model {
  80         int model;
  81         const char *helper;
  82         const char *firmware;
  83 };
  84
  85 static struct if_sdio_model if_sdio_models[] = {
  86         {
  87                 /* 8385 */
  88                 .model = IF_SDIO_MODEL_8385,
  89                 .helper = "sd8385_helper.bin",
  90                 .firmware = "sd8385.bin",
  91         },
  92         {
  93                 /* 8686 */
  94                 .model = IF_SDIO_MODEL_8686,
  95                 .helper = "sd8686_helper.bin",
  96                 .firmware = "sd8686.bin",
  97         },
  98         {
  99                 /* 8688 */
 100                 .model = IF_SDIO_MODEL_8688,
 101                 .helper = "sd8688_helper.bin",
 102                 .firmware = "sd8688.bin",
 103         },
 104 };
 105 MODULE_FIRMWARE("sd8385_helper.bin");
 106 MODULE_FIRMWARE("sd8385.bin");
 107 MODULE_FIRMWARE("sd8686_helper.bin");
 108 MODULE_FIRMWARE("sd8686.bin");
 109 MODULE_FIRMWARE("sd8688_helper.bin");
 110 MODULE_FIRMWARE("sd8688.bin");
 111
 112 struct if_sdio_packet {
 113         struct if_sdio_packet   *next;
 114         u16                     nb;
 115         u8                      buffer[0] __attribute__((aligned(4)));
 116 };
 117
 118 struct if_sdio_card {
 119         struct sdio_func        *func;
 120         struct lbs_private      *priv;
 121
 122         int                     model;
 123         unsigned long           ioport;
 124         unsigned int            scratch_reg;
 125
 126         const char              *helper;
 127         const char              *firmware;
 128
 129         u8                      buffer[65536];
 130
 131         spinlock_t              lock;
 132         struct if_sdio_packet   *packets;
 133
 134         struct workqueue_struct *workqueue;
 135         struct work_struct      packet_worker;
 136
 137         u8                      rx_unit;
 138 };
 139
 140 /********************************************************************/
 141 /* I/O                                                              */
 142 /********************************************************************/
 143
 144 /*
 145  *  For SD8385/SD8686, this function reads firmware status after
 146  *  the image is downloaded, or reads RX packet length when
 147  *  interrupt (with IF_SDIO_H_INT_UPLD bit set) is received.
 148  *  For SD8688, this function reads firmware status only.
 149  */
 150 static u16 if_sdio_read_scratch(struct if_sdio_card *card, int *err)
 151 {
 152         int ret;
 153         u16 scratch;
 154
 155         scratch = sdio_readb(card->func, card->scratch_reg, &ret);
 156         if (!ret)
 157                 scratch |= sdio_readb(card->func, card->scratch_reg + 1,
 158                                         &ret) << 8;
 159
 160         if (err)
 161                 *err = ret;
 162
 163         if (ret)
 164                 return 0xffff;
 165
 166         return scratch;
 167 }
 168
 169 static u8 if_sdio_read_rx_unit(struct if_sdio_card *card)
 170 {
 171         int ret;
 172         u8 rx_unit;
 173
 174         rx_unit = sdio_readb(card->func, IF_SDIO_RX_UNIT, &ret);
 175
 176         if (ret)
 177                 rx_unit = 0;
 178
 179         return rx_unit;
 180 }
 181
 182 static u16 if_sdio_read_rx_len(struct if_sdio_card *card, int *err)
 183 {
 184         int ret;
 185         u16 rx_len;
 186
 187         switch (card->model) {
 188         case IF_SDIO_MODEL_8385:
 189         case IF_SDIO_MODEL_8686:
 190                 rx_len = if_sdio_read_scratch(card, &ret);
 191                 break;
 192         case IF_SDIO_MODEL_8688:
 193         default: /* for newer chipsets */
 194                 rx_len = sdio_readb(card->func, IF_SDIO_RX_LEN, &ret);
 195                 if (!ret)
 196                         rx_len <<= card->rx_unit;
 197                 else
 198                         rx_len = 0xffff;        /* invalid length */
 199
 200                 break;
 201         }
 202
 203         if (err)
 204                 *err = ret;
 205
 206         return rx_len;
 207 }
 208
 209 static int if_sdio_handle_cmd(struct if_sdio_card *card,
 210                 u8 *buffer, unsigned size)
 211 {
 212         struct lbs_private *priv = card->priv;
 213         int ret;
 214         unsigned long flags;
 215         u8 i;
 216
 217         lbs_deb_enter(LBS_DEB_SDIO);
 218
 219         if (size > LBS_CMD_BUFFER_SIZE) {
 220                 lbs_deb_sdio("response packet too large (%d bytes)\n",
 221                         (int)size);
 222                 ret = -E2BIG;
 223                 goto out;
 224         }
 225
 226         spin_lock_irqsave(&priv->driver_lock, flags);
 227
 228         i = (priv->resp_idx == 0) ? 1 : 0;
 229         BUG_ON(priv->resp_len[i]);
 230         priv->resp_len[i] = size;
 231         memcpy(priv->resp_buf[i], buffer, size);
 232         lbs_notify_command_response(priv, i);
 233
 234         spin_unlock_irqrestore(&card->priv->driver_lock, flags);
 235
 236         ret = 0;
 237
 238 out:
 239         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
 240         return ret;
 241 }
 242
 243 static int if_sdio_handle_data(struct if_sdio_card *card,
 244                 u8 *buffer, unsigned size)
 245 {
 246         int ret;
 247         struct sk_buff *skb;
 248         char *data;
 249
 250         lbs_deb_enter(LBS_DEB_SDIO);
 251
 252         if (size > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE) {
 253                 lbs_deb_sdio("response packet too large (%d bytes)\n",
 254                         (int)size);
 255                 ret = -E2BIG;
 256                 goto out;
 257         }
 258
 259         skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE + NET_IP_ALIGN);
 260         if (!skb) {
 261                 ret = -ENOMEM;
 262                 goto out;
 263         }
 264
 265         skb_reserve(skb, NET_IP_ALIGN);
 266
 267         data = skb_put(skb, size);
 268
 269         memcpy(data, buffer, size);
 270
 271         lbs_process_rxed_packet(card->priv, skb);
 272
 273         ret = 0;
 274
 275 out:
 276         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
 277
 278         return ret;
 279 }
 280
 281 static int if_sdio_handle_event(struct if_sdio_card *card,
 282                 u8 *buffer, unsigned size)
 283 {
 284         int ret;
 285         u32 event;
 286
 287         lbs_deb_enter(LBS_DEB_SDIO);
 288
 289         if (card->model == IF_SDIO_MODEL_8385) {
 290                 event = sdio_readb(card->func, IF_SDIO_EVENT, &ret);
 291                 if (ret)
 292                         goto out;
 293
 294                 /* right shift 3 bits to get the event id */
 295                 event >>= 3;
 296         } else {
 297                 if (size < 4) {
 298                         lbs_deb_sdio("event packet too small (%d bytes)\n",
 299                                 (int)size);
 300                         ret = -EINVAL;
 301                         goto out;
 302                 }
 303                 event = buffer[3] << 24;
 304                 event |= buffer[2] << 16;
 305                 event |= buffer[1] << 8;
 306                 event |= buffer[0] << 0;
 307         }
 308
 309         lbs_queue_event(card->priv, event & 0xFF);
 310         ret = 0;
 311
 312 out:
 313         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
 314
 315         return ret;
 316 }
 317
 318 static int if_sdio_wait_status(struct if_sdio_card *card, const u8 condition)
 319 {
 320         u8 status;
 321         unsigned long timeout;
 322         int ret = 0;
 323
 324         timeout = jiffies + HZ;
 325         while (1) {
 326                 status = sdio_readb(card->func, IF_SDIO_STATUS, &ret);
 327                 if (ret || (status & condition))
 328                         break;
 329                 if (time_after(jiffies, timeout))
 330                         return -ETIMEDOUT;
 331                 mdelay(1);
 332         }
 333         return ret;
 334 }
 335
 336 static int if_sdio_card_to_host(struct if_sdio_card *card)
 337 {
 338         int ret;
 339         u16 size, type, chunk;
 340
 341         lbs_deb_enter(LBS_DEB_SDIO);
 342
 343         size = if_sdio_read_rx_len(card, &ret);
 344         if (ret)
 345                 goto out;
 346
 347         if (size < 4) {
 348                 lbs_deb_sdio("invalid packet size (%d bytes) from firmware\n",
 349                         (int)size);
 350                 ret = -EINVAL;
 351                 goto out;
 352         }
 353
 354         ret = if_sdio_wait_status(card, IF_SDIO_IO_RDY);
 355         if (ret)
 356                 goto out;
 357
 358         /*
 359          * The transfer must be in one transaction or the firmware
 360          * goes suicidal. There's no way to guarantee that for all
 361          * controllers, but we can at least try.
 362          */
 363         chunk = sdio_align_size(card->func, size);
 364
 365         ret = sdio_readsb(card->func, card->buffer, card->ioport, chunk);
 366         if (ret)
 367                 goto out;
 368
 369         chunk = card->buffer[0] | (card->buffer[1] << 8);
 370         type = card->buffer[2] | (card->buffer[3] << 8);
 371
 372         lbs_deb_sdio("packet of type %d and size %d bytes\n",
 373                 (int)type, (int)chunk);
 374
 375         if (chunk > size) {
 376                 lbs_deb_sdio("packet fragment (%d > %d)\n",
 377                         (int)chunk, (int)size);
 378                 ret = -EINVAL;
 379                 goto out;
 380         }
 381
 382         if (chunk < size) {
 383                 lbs_deb_sdio("packet fragment (%d < %d)\n",
 384                         (int)chunk, (int)size);
 385         }
 386
 387         switch (type) {
 388         case MVMS_CMD:
 389                 ret = if_sdio_handle_cmd(card, card->buffer + 4, chunk - 4);
 390                 if (ret)
 391                         goto out;
 392                 break;
 393         case MVMS_DAT:
 394                 ret = if_sdio_handle_data(card, card->buffer + 4, chunk - 4);
 395                 if (ret)
 396                         goto out;
 397                 break;
 398         case MVMS_EVENT:
 399                 ret = if_sdio_handle_event(card, card->buffer + 4, chunk - 4);
 400                 if (ret)
 401                         goto out;
 402                 break;
 403         default:
 404                 lbs_deb_sdio("invalid type (%d) from firmware\n",
 405                                 (int)type);
 406                 ret = -EINVAL;
 407                 goto out;
 408         }
 409
 410 out:
 411         if (ret)
 412                 lbs_pr_err("problem fetching packet from firmware\n");
 413
 414         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
 415
 416         return ret;
 417 }
 418
 419 static void if_sdio_host_to_card_worker(struct work_struct *work)
 420 {
 421         struct if_sdio_card *card;
 422         struct if_sdio_packet *packet;
 423         int ret;
 424         unsigned long flags;
 425
 426         lbs_deb_enter(LBS_DEB_SDIO);
 427
 428         card = container_of(work, struct if_sdio_card, packet_worker);
 429
 430         while (1) {
 431                 spin_lock_irqsave(&card->lock, flags);
 432                 packet = card->packets;
 433                 if (packet)
 434                         card->packets = packet->next;
 435                 spin_unlock_irqrestore(&card->lock, flags);
 436
 437                 if (!packet)
 438                         break;
 439
 440                 sdio_claim_host(card->func);
 441
 442                 ret = if_sdio_wait_status(card, IF_SDIO_IO_RDY);
 443                 if (ret == 0) {
 444                         ret = sdio_writesb(card->func, card->ioport,
 445                                            packet->buffer, packet->nb);
 446                 }
 447
 448                 if (ret)
 449                         lbs_pr_err("error %d sending packet to firmware\n", ret);
 450
 451                 sdio_release_host(card->func);
 452
 453                 kfree(packet);
 454         }
 455
 456         lbs_deb_leave(LBS_DEB_SDIO);
 457 }
 458
 459 /********************************************************************/
 460 /* Firmware                                                         */
 461 /********************************************************************/
 462
 463 #define FW_DL_READY_STATUS (IF_SDIO_IO_RDY | IF_SDIO_DL_RDY)
 464
 465 static int if_sdio_prog_helper(struct if_sdio_card *card)
 466 {
 467         int ret;
 468         const struct firmware *fw;
 469         unsigned long timeout;
 470         u8 *chunk_buffer;
 471         u32 chunk_size;
 472         const u8 *firmware;
 473         size_t size;
 474
 475         lbs_deb_enter(LBS_DEB_SDIO);
 476
 477         ret = request_firmware(&fw, card->helper, &card->func->dev);
 478         if (ret) {
 479                 lbs_pr_err("can't load helper firmware\n");
 480                 goto out;
 481         }
 482
 483         chunk_buffer = kzalloc(64, GFP_KERNEL);
 484         if (!chunk_buffer) {
 485                 ret = -ENOMEM;
 486                 goto release_fw;
 487         }
 488
 489         sdio_claim_host(card->func);
 490
 491         ret = sdio_set_block_size(card->func, 32);
 492         if (ret)
 493                 goto release;
 494
 495         firmware = fw->data;
 496         size = fw->size;
 497
 498         while (size) {
 499                 ret = if_sdio_wait_status(card, FW_DL_READY_STATUS);
 500                 if (ret)
 501                         goto release;
 502
 503                 /* On some platforms (like Davinci) the chip needs more time
 504                  * between helper blocks.
 505                  */
 506                 mdelay(2);
 507
 508                 chunk_size = min(size, (size_t)60);
 509
 510                 *((__le32*)chunk_buffer) = cpu_to_le32(chunk_size);
 511                 memcpy(chunk_buffer + 4, firmware, chunk_size);
 512 /*
 513                 lbs_deb_sdio("sending %d bytes chunk\n", chunk_size);
 514 */
 515                 ret = sdio_writesb(card->func, card->ioport,
 516                                 chunk_buffer, 64);
 517                 if (ret)
 518                         goto release;
 519
 520                 firmware += chunk_size;
 521                 size -= chunk_size;
 522         }
 523
 524         /* an empty block marks the end of the transfer */
 525         memset(chunk_buffer, 0, 4);
 526         ret = sdio_writesb(card->func, card->ioport, chunk_buffer, 64);
 527         if (ret)
 528                 goto release;
 529
 530         lbs_deb_sdio("waiting for helper to boot...\n");
 531
 532         /* wait for the helper to boot by looking at the size register */
 533         timeout = jiffies + HZ;
 534         while (1) {
 535                 u16 req_size;
 536
 537                 req_size = sdio_readb(card->func, IF_SDIO_RD_BASE, &ret);
 538                 if (ret)
 539                         goto release;
 540
 541                 req_size |= sdio_readb(card->func, IF_SDIO_RD_BASE + 1, &ret) << 8;
 542                 if (ret)
 543                         goto release;
 544
 545                 if (req_size != 0)
 546                         break;
 547
 548                 if (time_after(jiffies, timeout)) {
 549                         ret = -ETIMEDOUT;
 550                         goto release;
 551                 }
 552
 553                 msleep(10);
 554         }
 555
 556         ret = 0;
 557
 558 release:
 559         sdio_release_host(card->func);
 560         kfree(chunk_buffer);
 561 release_fw:
 562         release_firmware(fw);
 563
 564 out:
 565         if (ret)
 566                 lbs_pr_err("failed to load helper firmware\n");
 567
 568         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
 569
 570         return ret;
 571 }
 572
 573 static int if_sdio_prog_real(struct if_sdio_card *card)
 574 {
 575         int ret;
 576         const struct firmware *fw;
 577         unsigned long timeout;
 578         u8 *chunk_buffer;
 579         u32 chunk_size;
 580         const u8 *firmware;
 581         size_t size, req_size;
 582
 583         lbs_deb_enter(LBS_DEB_SDIO);
 584
 585         ret = request_firmware(&fw, card->firmware, &card->func->dev);
 586         if (ret) {
 587                 lbs_pr_err("can't load firmware\n");
 588                 goto out;
 589         }
 590
 591         chunk_buffer = kzalloc(512, GFP_KERNEL);
 592         if (!chunk_buffer) {
 593                 ret = -ENOMEM;
 594                 goto release_fw;
 595         }
 596
 597         sdio_claim_host(card->func);
 598
 599         ret = sdio_set_block_size(card->func, 32);
 600         if (ret)
 601                 goto release;
 602
 603         firmware = fw->data;
 604         size = fw->size;
 605
 606         while (size) {
 607                 ret = if_sdio_wait_status(card, FW_DL_READY_STATUS);
 608                 if (ret)
 609                         goto release;
 610
 611                 req_size = sdio_readb(card->func, IF_SDIO_RD_BASE, &ret);
 612                 if (ret)
 613                         goto release;
 614
 615                 req_size |= sdio_readb(card->func, IF_SDIO_RD_BASE + 1, &ret) << 8;
 616                 if (ret)
 617                         goto release;
 618 /*
 619                 lbs_deb_sdio("firmware wants %d bytes\n", (int)req_size);
 620 */
 621                 if (req_size == 0) {
 622                         lbs_deb_sdio("firmware helper gave up early\n");
 623                         ret = -EIO;
 624                         goto release;
 625                 }
 626
 627                 if (req_size & 0x01) {
 628                         lbs_deb_sdio("firmware helper signalled error\n");
 629                         ret = -EIO;
 630                         goto release;
 631                 }
 632
 633                 if (req_size > size)
 634                         req_size = size;
 635
 636                 while (req_size) {
 637                         chunk_size = min(req_size, (size_t)512);
 638
 639                         memcpy(chunk_buffer, firmware, chunk_size);
 640 /*
 641                         lbs_deb_sdio("sending %d bytes (%d bytes) chunk\n",
 642                                 chunk_size, (chunk_size + 31) / 32 * 32);
 643 */
 644                         ret = sdio_writesb(card->func, card->ioport,
 645                                 chunk_buffer, roundup(chunk_size, 32));
 646                         if (ret)
 647                                 goto release;
 648
 649                         firmware += chunk_size;
 650                         size -= chunk_size;
 651                         req_size -= chunk_size;
 652                 }
 653         }
 654
 655         ret = 0;
 656
 657         lbs_deb_sdio("waiting for firmware to boot...\n");
 658
 659         /* wait for the firmware to boot */
 660         timeout = jiffies + HZ;
 661         while (1) {
 662                 u16 scratch;
 663
 664                 scratch = if_sdio_read_scratch(card, &ret);
 665                 if (ret)
 666                         goto release;
 667
 668                 if (scratch == IF_SDIO_FIRMWARE_OK)
 669                         break;
 670
 671                 if (time_after(jiffies, timeout)) {
 672                         ret = -ETIMEDOUT;
 673                         goto release;
 674                 }
 675
 676                 msleep(10);
 677         }
 678
 679         ret = 0;
 680
 681 release:
 682         sdio_release_host(card->func);
 683         kfree(chunk_buffer);
 684 release_fw:
 685         release_firmware(fw);
 686
 687 out:
 688         if (ret)
 689                 lbs_pr_err("failed to load firmware\n");
 690
 691         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
 692
 693         return ret;
 694 }
 695
 696 static int if_sdio_prog_firmware(struct if_sdio_card *card)
 697 {
 698         int ret;
 699         u16 scratch;
 700
 701         lbs_deb_enter(LBS_DEB_SDIO);
 702
 703         sdio_claim_host(card->func);
 704         scratch = if_sdio_read_scratch(card, &ret);
 705         sdio_release_host(card->func);
 706
 707         if (ret)
 708                 goto out;
 709
 710         lbs_deb_sdio("firmware status = %#x\n", scratch);
 711
 712         if (scratch == IF_SDIO_FIRMWARE_OK) {
 713                 lbs_deb_sdio("firmware already loaded\n");
 714                 goto success;
 715         }
 716
 717         ret = if_sdio_prog_helper(card);
 718         if (ret)
 719                 goto out;
 720
 721         ret = if_sdio_prog_real(card);
 722         if (ret)
 723                 goto out;
 724
 725 success:
 726         sdio_claim_host(card->func);
 727         sdio_set_block_size(card->func, IF_SDIO_BLOCK_SIZE);
 728         sdio_release_host(card->func);
 729         ret = 0;
 730
 731 out:
 732         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
 733
 734         return ret;
 735 }
 736
 737 /*******************************************************************/
 738 /* Libertas callbacks                                              */
 739 /*******************************************************************/
 740
 741 static int if_sdio_host_to_card(struct lbs_private *priv,
 742                 u8 type, u8 *buf, u16 nb)
 743 {
 744         int ret;
 745         struct if_sdio_card *card;
 746         struct if_sdio_packet *packet, *cur;
 747         u16 size;
 748         unsigned long flags;
 749
 750         lbs_deb_enter_args(LBS_DEB_SDIO, "type %d, bytes %d", type, nb);
 751
 752         card = priv->card;
 753
 754         if (nb > (65536 - sizeof(struct if_sdio_packet) - 4)) {
 755                 ret = -EINVAL;
 756                 goto out;
 757         }
 758
 759         /*
 760          * The transfer must be in one transaction or the firmware
 761          * goes suicidal. There's no way to guarantee that for all
 762          * controllers, but we can at least try.
 763          */
 764         size = sdio_align_size(card->func, nb + 4);
 765
 766         packet = kzalloc(sizeof(struct if_sdio_packet) + size,
 767                         GFP_ATOMIC);
 768         if (!packet) {
 769                 ret = -ENOMEM;
 770                 goto out;
 771         }
 772
 773         packet->next = NULL;
 774         packet->nb = size;
 775
 776         /*
 777          * SDIO specific header.
 778          */
 779         packet->buffer[0] = (nb + 4) & 0xff;
 780         packet->buffer[1] = ((nb + 4) >> 8) & 0xff;
 781         packet->buffer[2] = type;
 782         packet->buffer[3] = 0;
 783
 784         memcpy(packet->buffer + 4, buf, nb);
 785
 786         spin_lock_irqsave(&card->lock, flags);
 787
 788         if (!card->packets)
 789                 card->packets = packet;
 790         else {
 791                 cur = card->packets;
 792                 while (cur->next)
 793                         cur = cur->next;
 794                 cur->next = packet;
 795         }
 796
 797         switch (type) {
 798         case MVMS_CMD:
 799                 priv->dnld_sent = DNLD_CMD_SENT;
 800                 break;
 801         case MVMS_DAT:
 802                 priv->dnld_sent = DNLD_DATA_SENT;
 803                 break;
 804         default:
 805                 lbs_deb_sdio("unknown packet type %d\n", (int)type);
 806         }
 807
 808         spin_unlock_irqrestore(&card->lock, flags);
 809
 810         queue_work(card->workqueue, &card->packet_worker);
 811
 812         ret = 0;
 813
 814 out:
 815         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
 816
 817         return ret;
 818 }
 819
 820 static int if_sdio_enter_deep_sleep(struct lbs_private *priv)
 821 {
 822         int ret = -1;
 823         struct cmd_header cmd;
 824
 825         memset(&cmd, 0, sizeof(cmd));
 826
 827         lbs_deb_sdio("send DEEP_SLEEP command\n");
 828         ret = __lbs_cmd(priv, CMD_802_11_DEEP_SLEEP, &cmd, sizeof(cmd),
 829                         lbs_cmd_copyback, (unsigned long) &cmd);
 830         if (ret)
 831                 lbs_pr_err("DEEP_SLEEP cmd failed\n");
 832
 833         mdelay(200);
 834         return ret;
 835 }
 836
 837 static int if_sdio_exit_deep_sleep(struct lbs_private *priv)
 838 {
 839         struct if_sdio_card *card = priv->card;
 840         int ret = -1;
 841
 842         lbs_deb_enter(LBS_DEB_SDIO);
 843         sdio_claim_host(card->func);
 844
 845         sdio_writeb(card->func, HOST_POWER_UP, CONFIGURATION_REG, &ret);
 846         if (ret)
 847                 lbs_pr_err("sdio_writeb failed!\n");
 848
 849         sdio_release_host(card->func);
 850         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
 851         return ret;
 852 }
 853
 854 static int if_sdio_reset_deep_sleep_wakeup(struct lbs_private *priv)
 855 {
 856         struct if_sdio_card *card = priv->card;
 857         int ret = -1;
 858
 859         lbs_deb_enter(LBS_DEB_SDIO);
 860         sdio_claim_host(card->func);
 861
 862         sdio_writeb(card->func, 0, CONFIGURATION_REG, &ret);
 863         if (ret)
 864                 lbs_pr_err("sdio_writeb failed!\n");
 865
 866         sdio_release_host(card->func);
 867         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
 868         return ret;
 869
 870 }
 871
 872 /*******************************************************************/
 873 /* SDIO callbacks                                                  */
 874 /*******************************************************************/
 875
 876 static void if_sdio_interrupt(struct sdio_func *func)
 877 {
 878         int ret;
 879         struct if_sdio_card *card;
 880         u8 cause;
 881
 882         lbs_deb_enter(LBS_DEB_SDIO);
 883
 884         card = sdio_get_drvdata(func);
 885
 886         cause = sdio_readb(card->func, IF_SDIO_H_INT_STATUS, &ret);
 887         if (ret)
 888                 goto out;
 889
 890         lbs_deb_sdio("interrupt: 0x%X\n", (unsigned)cause);
 891
 892         sdio_writeb(card->func, ~cause, IF_SDIO_H_INT_STATUS, &ret);
 893         if (ret)
 894                 goto out;
 895
 896         /*
 897          * Ignore the define name, this really means the card has
 898          * successfully received the command.
 899          */
 900         card->priv->is_activity_detected = 1;
 901         if (cause & IF_SDIO_H_INT_DNLD)
 902                 lbs_host_to_card_done(card->priv);
 903
 904
 905         if (cause & IF_SDIO_H_INT_UPLD) {
 906                 ret = if_sdio_card_to_host(card);
 907                 if (ret)
 908                         goto out;
 909         }
 910
 911         ret = 0;
 912
 913 out:
 914         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
 915 }
 916
 917 static int if_sdio_probe(struct sdio_func *func,
 918                 const struct sdio_device_id *id)
 919 {
 920         struct if_sdio_card *card;
 921         struct lbs_private *priv;
 922         int ret, i;
 923         unsigned int model;
 924         struct if_sdio_packet *packet;
 925         struct mmc_host *host = func->card->host;
 926
 927         lbs_deb_enter(LBS_DEB_SDIO);
 928
 929         for (i = 0;i < func->card->num_info;i++) {
 930                 if (sscanf(func->card->info[i],
 931                                 "802.11 SDIO ID: %x", &model) == 1)
 932                         break;
 933                 if (sscanf(func->card->info[i],
 934                                 "ID: %x", &model) == 1)
 935                         break;
 936                 if (!strcmp(func->card->info[i], "IBIS Wireless SDIO Card")) {
 937                         model = IF_SDIO_MODEL_8385;
 938                         break;
 939                 }
 940         }
 941
 942         if (i == func->card->num_info) {
 943                 lbs_pr_err("unable to identify card model\n");
 944                 return -ENODEV;
 945         }
 946
 947         card = kzalloc(sizeof(struct if_sdio_card), GFP_KERNEL);
 948         if (!card)
 949                 return -ENOMEM;
 950
 951         card->func = func;
 952         card->model = model;
 953
 954         switch (card->model) {
 955         case IF_SDIO_MODEL_8385:
 956                 card->scratch_reg = IF_SDIO_SCRATCH_OLD;
 957                 break;
 958         case IF_SDIO_MODEL_8686:
 959                 card->scratch_reg = IF_SDIO_SCRATCH;
 960                 break;
 961         case IF_SDIO_MODEL_8688:
 962         default: /* for newer chipsets */
 963                 card->scratch_reg = IF_SDIO_FW_STATUS;
 964                 break;
 965         }
 966
 967         spin_lock_init(&card->lock);
 968         card->workqueue = create_workqueue("libertas_sdio");
 969         INIT_WORK(&card->packet_worker, if_sdio_host_to_card_worker);
 970
 971         for (i = 0;i < ARRAY_SIZE(if_sdio_models);i++) {
 972                 if (card->model == if_sdio_models[i].model)
 973                         break;
 974         }
 975
 976         if (i == ARRAY_SIZE(if_sdio_models)) {
 977                 lbs_pr_err("unknown card model 0x%x\n", card->model);
 978                 ret = -ENODEV;
 979                 goto free;
 980         }
 981
 982         card->helper = if_sdio_models[i].helper;
 983         card->firmware = if_sdio_models[i].firmware;
 984
 985         if (lbs_helper_name) {
 986                 lbs_deb_sdio("overriding helper firmware: %s\n",
 987                         lbs_helper_name);
 988                 card->helper = lbs_helper_name;
 989         }
 990
 991         if (lbs_fw_name) {
 992                 lbs_deb_sdio("overriding firmware: %s\n", lbs_fw_name);
 993                 card->firmware = lbs_fw_name;
 994         }
 995
 996         sdio_claim_host(func);
 997
 998         ret = sdio_enable_func(func);
 999         if (ret)
1000                 goto release;
1001
1002         ret = sdio_claim_irq(func, if_sdio_interrupt);
1003         if (ret)
1004                 goto disable;
1005
1006         /* For 1-bit transfers to the 8686 model, we need to enable the
1007          * interrupt flag in the CCCR register. Set the MMC_QUIRK_LENIENT_FN0
1008          * bit to allow access to non-vendor registers. */
1009         if ((card->model == IF_SDIO_MODEL_8686) &&
1010             (host->caps & MMC_CAP_SDIO_IRQ) &&
1011             (host->ios.bus_width == MMC_BUS_WIDTH_1)) {
1012                 u8 reg;
1013
1014                 func->card->quirks |= MMC_QUIRK_LENIENT_FN0;
1015                 reg = sdio_f0_readb(func, SDIO_CCCR_IF, &ret);
1016                 if (ret)
1017                         goto release_int;
1018
1019                 reg |= SDIO_BUS_ECSI;
1020                 sdio_f0_writeb(func, reg, SDIO_CCCR_IF, &ret);
1021                 if (ret)
1022                         goto release_int;
1023         }
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");