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 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  30
  31 #include <linux/kernel.h>
  32 #include <linux/module.h>
  33 #include <linux/slab.h>
  34 #include <linux/firmware.h>
  35 #include <linux/netdevice.h>
  36 #include <linux/delay.h>
  37 #include <linux/mmc/card.h>
  38 #include <linux/mmc/sdio_func.h>
  39 #include <linux/mmc/sdio_ids.h>
  40 #include <linux/mmc/sdio.h>
  41 #include <linux/mmc/host.h>
  42 #include <linux/pm_runtime.h>
  43
  44 #include "host.h"
  45 #include "decl.h"
  46 #include "defs.h"
  47 #include "dev.h"
  48 #include "cmd.h"
  49 #include "if_sdio.h"
  50
  51 static void if_sdio_interrupt(struct sdio_func *func);
  52
  53 /* The if_sdio_remove() callback function is called when
  54  * user removes this module from kernel space or ejects
  55  * the card from the slot. The driver handles these 2 cases
  56  * differently for SD8688 combo chip.
  57  * If the user is removing the module, the FUNC_SHUTDOWN
  58  * command for SD8688 is sent to the firmware.
  59  * If the card is removed, there is no need to send this command.
  60  *
  61  * The variable 'user_rmmod' is used to distinguish these two
  62  * scenarios. This flag is initialized as FALSE in case the card
  63  * is removed, and will be set to TRUE for module removal when
  64  * module_exit function is called.
  65  */
  66 static u8 user_rmmod;
  67
  68 static const struct sdio_device_id if_sdio_ids[] = {
  69         { SDIO_DEVICE(SDIO_VENDOR_ID_MARVELL,
  70                         SDIO_DEVICE_ID_MARVELL_LIBERTAS) },
  71         { SDIO_DEVICE(SDIO_VENDOR_ID_MARVELL,
  72                         SDIO_DEVICE_ID_MARVELL_8688WLAN) },
  73         { /* end: all zeroes */                         },
  74 };
  75
  76 MODULE_DEVICE_TABLE(sdio, if_sdio_ids);
  77
  78 #define MODEL_8385      0x04
  79 #define MODEL_8686      0x0b
  80 #define MODEL_8688      0x10
  81
  82 static const struct lbs_fw_table fw_table[] = {
  83         { MODEL_8385, "/*(DEBLOBBED)*/", "/*(DEBLOBBED)*/" },
  84         { MODEL_8385, "/*(DEBLOBBED)*/", "/*(DEBLOBBED)*/" },
  85         { MODEL_8686, "/*(DEBLOBBED)*/", "/*(DEBLOBBED)*/" },
  86         { MODEL_8686, "/*(DEBLOBBED)*/", "/*(DEBLOBBED)*/" },
  87         { MODEL_8686, "/*(DEBLOBBED)*/", "/*(DEBLOBBED)*/" },
  88         { MODEL_8688, "/*(DEBLOBBED)*/", "/*(DEBLOBBED)*/" },
  89         { MODEL_8688, "/*(DEBLOBBED)*/", "/*(DEBLOBBED)*/" },
  90         { 0, NULL, NULL }
  91 };
  92 /*(DEBLOBBED)*/
  93
  94 struct if_sdio_packet {
  95         struct if_sdio_packet   *next;
  96         u16                     nb;
  97         u8                      buffer[0] __attribute__((aligned(4)));
  98 };
  99
 100 struct if_sdio_card {
 101         struct sdio_func        *func;
 102         struct lbs_private      *priv;
 103
 104         int                     model;
 105         unsigned long           ioport;
 106         unsigned int            scratch_reg;
 107         bool                    started;
 108         wait_queue_head_t       pwron_waitq;
 109
 110         u8                      buffer[65536] __attribute__((aligned(4)));
 111
 112         spinlock_t              lock;
 113         struct if_sdio_packet   *packets;
 114
 115         struct workqueue_struct *workqueue;
 116         struct work_struct      packet_worker;
 117
 118         u8                      rx_unit;
 119 };
 120
 121 static void if_sdio_finish_power_on(struct if_sdio_card *card);
 122 static int if_sdio_power_off(struct if_sdio_card *card);
 123
 124 /********************************************************************/
 125 /* I/O                                                              */
 126 /********************************************************************/
 127
 128 /*
 129  *  For SD8385/SD8686, this function reads firmware status after
 130  *  the image is downloaded, or reads RX packet length when
 131  *  interrupt (with IF_SDIO_H_INT_UPLD bit set) is received.
 132  *  For SD8688, this function reads firmware status only.
 133  */
 134 static u16 if_sdio_read_scratch(struct if_sdio_card *card, int *err)
 135 {
 136         int ret;
 137         u16 scratch;
 138
 139         scratch = sdio_readb(card->func, card->scratch_reg, &ret);
 140         if (!ret)
 141                 scratch |= sdio_readb(card->func, card->scratch_reg + 1,
 142                                         &ret) << 8;
 143
 144         if (err)
 145                 *err = ret;
 146
 147         if (ret)
 148                 return 0xffff;
 149
 150         return scratch;
 151 }
 152
 153 static u8 if_sdio_read_rx_unit(struct if_sdio_card *card)
 154 {
 155         int ret;
 156         u8 rx_unit;
 157
 158         rx_unit = sdio_readb(card->func, IF_SDIO_RX_UNIT, &ret);
 159
 160         if (ret)
 161                 rx_unit = 0;
 162
 163         return rx_unit;
 164 }
 165
 166 static u16 if_sdio_read_rx_len(struct if_sdio_card *card, int *err)
 167 {
 168         int ret;
 169         u16 rx_len;
 170
 171         switch (card->model) {
 172         case MODEL_8385:
 173         case MODEL_8686:
 174                 rx_len = if_sdio_read_scratch(card, &ret);
 175                 break;
 176         case MODEL_8688:
 177         default: /* for newer chipsets */
 178                 rx_len = sdio_readb(card->func, IF_SDIO_RX_LEN, &ret);
 179                 if (!ret)
 180                         rx_len <<= card->rx_unit;
 181                 else
 182                         rx_len = 0xffff;        /* invalid length */
 183
 184                 break;
 185         }
 186
 187         if (err)
 188                 *err = ret;
 189
 190         return rx_len;
 191 }
 192
 193 static int if_sdio_handle_cmd(struct if_sdio_card *card,
 194                 u8 *buffer, unsigned size)
 195 {
 196         struct lbs_private *priv = card->priv;
 197         int ret;
 198         unsigned long flags;
 199         u8 i;
 200
 201         lbs_deb_enter(LBS_DEB_SDIO);
 202
 203         if (size > LBS_CMD_BUFFER_SIZE) {
 204                 lbs_deb_sdio("response packet too large (%d bytes)\n",
 205                         (int)size);
 206                 ret = -E2BIG;
 207                 goto out;
 208         }
 209
 210         spin_lock_irqsave(&priv->driver_lock, flags);
 211
 212         i = (priv->resp_idx == 0) ? 1 : 0;
 213         BUG_ON(priv->resp_len[i]);
 214         priv->resp_len[i] = size;
 215         memcpy(priv->resp_buf[i], buffer, size);
 216         lbs_notify_command_response(priv, i);
 217
 218         spin_unlock_irqrestore(&card->priv->driver_lock, flags);
 219
 220         ret = 0;
 221
 222 out:
 223         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
 224         return ret;
 225 }
 226
 227 static int if_sdio_handle_data(struct if_sdio_card *card,
 228                 u8 *buffer, unsigned size)
 229 {
 230         int ret;
 231         struct sk_buff *skb;
 232         char *data;
 233
 234         lbs_deb_enter(LBS_DEB_SDIO);
 235
 236         if (size > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE) {
 237                 lbs_deb_sdio("response packet too large (%d bytes)\n",
 238                         (int)size);
 239                 ret = -E2BIG;
 240                 goto out;
 241         }
 242
 243         skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE + NET_IP_ALIGN);
 244         if (!skb) {
 245                 ret = -ENOMEM;
 246                 goto out;
 247         }
 248
 249         skb_reserve(skb, NET_IP_ALIGN);
 250
 251         data = skb_put(skb, size);
 252
 253         memcpy(data, buffer, size);
 254
 255         lbs_process_rxed_packet(card->priv, skb);
 256
 257         ret = 0;
 258
 259 out:
 260         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
 261
 262         return ret;
 263 }
 264
 265 static int if_sdio_handle_event(struct if_sdio_card *card,
 266                 u8 *buffer, unsigned size)
 267 {
 268         int ret;
 269         u32 event;
 270
 271         lbs_deb_enter(LBS_DEB_SDIO);
 272
 273         if (card->model == MODEL_8385) {
 274                 event = sdio_readb(card->func, IF_SDIO_EVENT, &ret);
 275                 if (ret)
 276                         goto out;
 277
 278                 /* right shift 3 bits to get the event id */
 279                 event >>= 3;
 280         } else {
 281                 if (size < 4) {
 282                         lbs_deb_sdio("event packet too small (%d bytes)\n",
 283                                 (int)size);
 284                         ret = -EINVAL;
 285                         goto out;
 286                 }
 287                 event = buffer[3] << 24;
 288                 event |= buffer[2] << 16;
 289                 event |= buffer[1] << 8;
 290                 event |= buffer[0] << 0;
 291         }
 292
 293         lbs_queue_event(card->priv, event & 0xFF);
 294         ret = 0;
 295
 296 out:
 297         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
 298
 299         return ret;
 300 }
 301
 302 static int if_sdio_wait_status(struct if_sdio_card *card, const u8 condition)
 303 {
 304         u8 status;
 305         unsigned long timeout;
 306         int ret = 0;
 307
 308         timeout = jiffies + HZ;
 309         while (1) {
 310                 status = sdio_readb(card->func, IF_SDIO_STATUS, &ret);
 311                 if (ret)
 312                         return ret;
 313                 if ((status & condition) == condition)
 314                         break;
 315                 if (time_after(jiffies, timeout))
 316                         return -ETIMEDOUT;
 317                 mdelay(1);
 318         }
 319         return ret;
 320 }
 321
 322 static int if_sdio_card_to_host(struct if_sdio_card *card)
 323 {
 324         int ret;
 325         u16 size, type, chunk;
 326
 327         lbs_deb_enter(LBS_DEB_SDIO);
 328
 329         size = if_sdio_read_rx_len(card, &ret);
 330         if (ret)
 331                 goto out;
 332
 333         if (size < 4) {
 334                 lbs_deb_sdio("invalid packet size (%d bytes) from firmware\n",
 335                         (int)size);
 336                 ret = -EINVAL;
 337                 goto out;
 338         }
 339
 340         ret = if_sdio_wait_status(card, IF_SDIO_IO_RDY);
 341         if (ret)
 342                 goto out;
 343
 344         /*
 345          * The transfer must be in one transaction or the firmware
 346          * goes suicidal. There's no way to guarantee that for all
 347          * controllers, but we can at least try.
 348          */
 349         chunk = sdio_align_size(card->func, size);
 350
 351         ret = sdio_readsb(card->func, card->buffer, card->ioport, chunk);
 352         if (ret)
 353                 goto out;
 354
 355         chunk = card->buffer[0] | (card->buffer[1] << 8);
 356         type = card->buffer[2] | (card->buffer[3] << 8);
 357
 358         lbs_deb_sdio("packet of type %d and size %d bytes\n",
 359                 (int)type, (int)chunk);
 360
 361         if (chunk > size) {
 362                 lbs_deb_sdio("packet fragment (%d > %d)\n",
 363                         (int)chunk, (int)size);
 364                 ret = -EINVAL;
 365                 goto out;
 366         }
 367
 368         if (chunk < size) {
 369                 lbs_deb_sdio("packet fragment (%d < %d)\n",
 370                         (int)chunk, (int)size);
 371         }
 372
 373         switch (type) {
 374         case MVMS_CMD:
 375                 ret = if_sdio_handle_cmd(card, card->buffer + 4, chunk - 4);
 376                 if (ret)
 377                         goto out;
 378                 break;
 379         case MVMS_DAT:
 380                 ret = if_sdio_handle_data(card, card->buffer + 4, chunk - 4);
 381                 if (ret)
 382                         goto out;
 383                 break;
 384         case MVMS_EVENT:
 385                 ret = if_sdio_handle_event(card, card->buffer + 4, chunk - 4);
 386                 if (ret)
 387                         goto out;
 388                 break;
 389         default:
 390                 lbs_deb_sdio("invalid type (%d) from firmware\n",
 391                                 (int)type);
 392                 ret = -EINVAL;
 393                 goto out;
 394         }
 395
 396 out:
 397         if (ret)
 398                 pr_err("problem fetching packet from firmware\n");
 399
 400         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
 401
 402         return ret;
 403 }
 404
 405 static void if_sdio_host_to_card_worker(struct work_struct *work)
 406 {
 407         struct if_sdio_card *card;
 408         struct if_sdio_packet *packet;
 409         int ret;
 410         unsigned long flags;
 411
 412         lbs_deb_enter(LBS_DEB_SDIO);
 413
 414         card = container_of(work, struct if_sdio_card, packet_worker);
 415
 416         while (1) {
 417                 spin_lock_irqsave(&card->lock, flags);
 418                 packet = card->packets;
 419                 if (packet)
 420                         card->packets = packet->next;
 421                 spin_unlock_irqrestore(&card->lock, flags);
 422
 423                 if (!packet)
 424                         break;
 425
 426                 sdio_claim_host(card->func);
 427
 428                 ret = if_sdio_wait_status(card, IF_SDIO_IO_RDY);
 429                 if (ret == 0) {
 430                         ret = sdio_writesb(card->func, card->ioport,
 431                                            packet->buffer, packet->nb);
 432                 }
 433
 434                 if (ret)
 435                         pr_err("error %d sending packet to firmware\n", ret);
 436
 437                 sdio_release_host(card->func);
 438
 439                 kfree(packet);
 440         }
 441
 442         lbs_deb_leave(LBS_DEB_SDIO);
 443 }
 444
 445 /********************************************************************/
 446 /* Firmware                                                         */
 447 /********************************************************************/
 448
 449 #define FW_DL_READY_STATUS (IF_SDIO_IO_RDY | IF_SDIO_DL_RDY)
 450
 451 static int if_sdio_prog_helper(struct if_sdio_card *card,
 452                                 const struct firmware *fw)
 453 {
 454         int ret;
 455         unsigned long timeout;
 456         u8 *chunk_buffer;
 457         u32 chunk_size;
 458         const u8 *firmware;
 459         size_t size;
 460
 461         lbs_deb_enter(LBS_DEB_SDIO);
 462
 463         chunk_buffer = kzalloc(64, GFP_KERNEL);
 464         if (!chunk_buffer) {
 465                 ret = -ENOMEM;
 466                 goto out;
 467         }
 468
 469         sdio_claim_host(card->func);
 470
 471         ret = sdio_set_block_size(card->func, 32);
 472         if (ret)
 473                 goto release;
 474
 475         firmware = fw->data;
 476         size = fw->size;
 477
 478         while (size) {
 479                 ret = if_sdio_wait_status(card, FW_DL_READY_STATUS);
 480                 if (ret)
 481                         goto release;
 482
 483                 /* On some platforms (like Davinci) the chip needs more time
 484                  * between helper blocks.
 485                  */
 486                 mdelay(2);
 487
 488                 chunk_size = min_t(size_t, size, 60);
 489
 490                 *((__le32*)chunk_buffer) = cpu_to_le32(chunk_size);
 491                 memcpy(chunk_buffer + 4, firmware, chunk_size);
 492 /*
 493                 lbs_deb_sdio("sending %d bytes chunk\n", chunk_size);
 494 */
 495                 ret = sdio_writesb(card->func, card->ioport,
 496                                 chunk_buffer, 64);
 497                 if (ret)
 498                         goto release;
 499
 500                 firmware += chunk_size;
 501                 size -= chunk_size;
 502         }
 503
 504         /* an empty block marks the end of the transfer */
 505         memset(chunk_buffer, 0, 4);
 506         ret = sdio_writesb(card->func, card->ioport, chunk_buffer, 64);
 507         if (ret)
 508                 goto release;
 509
 510         lbs_deb_sdio("waiting for helper to boot...\n");
 511
 512         /* wait for the helper to boot by looking at the size register */
 513         timeout = jiffies + HZ;
 514         while (1) {
 515                 u16 req_size;
 516
 517                 req_size = sdio_readb(card->func, IF_SDIO_RD_BASE, &ret);
 518                 if (ret)
 519                         goto release;
 520
 521                 req_size |= sdio_readb(card->func, IF_SDIO_RD_BASE + 1, &ret) << 8;
 522                 if (ret)
 523                         goto release;
 524
 525                 if (req_size != 0)
 526                         break;
 527
 528                 if (time_after(jiffies, timeout)) {
 529                         ret = -ETIMEDOUT;
 530                         goto release;
 531                 }
 532
 533                 msleep(10);
 534         }
 535
 536         ret = 0;
 537
 538 release:
 539         sdio_release_host(card->func);
 540         kfree(chunk_buffer);
 541
 542 out:
 543         if (ret)
 544                 pr_err("failed to load helper firmware\n");
 545
 546         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
 547         return ret;
 548 }
 549
 550 static int if_sdio_prog_real(struct if_sdio_card *card,
 551                                 const struct firmware *fw)
 552 {
 553         int ret;
 554         unsigned long timeout;
 555         u8 *chunk_buffer;
 556         u32 chunk_size;
 557         const u8 *firmware;
 558         size_t size, req_size;
 559
 560         lbs_deb_enter(LBS_DEB_SDIO);
 561
 562         chunk_buffer = kzalloc(512, GFP_KERNEL);
 563         if (!chunk_buffer) {
 564                 ret = -ENOMEM;
 565                 goto out;
 566         }
 567
 568         sdio_claim_host(card->func);
 569
 570         ret = sdio_set_block_size(card->func, 32);
 571         if (ret)
 572                 goto release;
 573
 574         firmware = fw->data;
 575         size = fw->size;
 576
 577         while (size) {
 578                 timeout = jiffies + HZ;
 579                 while (1) {
 580                         ret = if_sdio_wait_status(card, FW_DL_READY_STATUS);
 581                         if (ret)
 582                                 goto release;
 583
 584                         req_size = sdio_readb(card->func, IF_SDIO_RD_BASE,
 585                                         &ret);
 586                         if (ret)
 587                                 goto release;
 588
 589                         req_size |= sdio_readb(card->func, IF_SDIO_RD_BASE + 1,
 590                                         &ret) << 8;
 591                         if (ret)
 592                                 goto release;
 593
 594                         /*
 595                          * For SD8688 wait until the length is not 0, 1 or 2
 596                          * before downloading the first FW block,
 597                          * since BOOT code writes the register to indicate the
 598                          * helper/FW download winner,
 599                          * the value could be 1 or 2 (Func1 or Func2).
 600                          */
 601                         if ((size != fw->size) || (req_size > 2))
 602                                 break;
 603                         if (time_after(jiffies, timeout)) {
 604                                 ret = -ETIMEDOUT;
 605                                 goto release;
 606                         }
 607                         mdelay(1);
 608                 }
 609
 610 /*
 611                 lbs_deb_sdio("firmware wants %d bytes\n", (int)req_size);
 612 */
 613                 if (req_size == 0) {
 614                         lbs_deb_sdio("firmware helper gave up early\n");
 615                         ret = -EIO;
 616                         goto release;
 617                 }
 618
 619                 if (req_size & 0x01) {
 620                         lbs_deb_sdio("firmware helper signalled error\n");
 621                         ret = -EIO;
 622                         goto release;
 623                 }
 624
 625                 if (req_size > size)
 626                         req_size = size;
 627
 628                 while (req_size) {
 629                         chunk_size = min_t(size_t, req_size, 512);
 630
 631                         memcpy(chunk_buffer, firmware, chunk_size);
 632 /*
 633                         lbs_deb_sdio("sending %d bytes (%d bytes) chunk\n",
 634                                 chunk_size, (chunk_size + 31) / 32 * 32);
 635 */
 636                         ret = sdio_writesb(card->func, card->ioport,
 637                                 chunk_buffer, roundup(chunk_size, 32));
 638                         if (ret)
 639                                 goto release;
 640
 641                         firmware += chunk_size;
 642                         size -= chunk_size;
 643                         req_size -= chunk_size;
 644                 }
 645         }
 646
 647         ret = 0;
 648
 649         lbs_deb_sdio("waiting for firmware to boot...\n");
 650
 651         /* wait for the firmware to boot */
 652         timeout = jiffies + HZ;
 653         while (1) {
 654                 u16 scratch;
 655
 656                 scratch = if_sdio_read_scratch(card, &ret);
 657                 if (ret)
 658                         goto release;
 659
 660                 if (scratch == IF_SDIO_FIRMWARE_OK)
 661                         break;
 662
 663                 if (time_after(jiffies, timeout)) {
 664                         ret = -ETIMEDOUT;
 665                         goto release;
 666                 }
 667
 668                 msleep(10);
 669         }
 670
 671         ret = 0;
 672
 673 release:
 674         sdio_release_host(card->func);
 675         kfree(chunk_buffer);
 676
 677 out:
 678         if (ret)
 679                 pr_err("failed to load firmware\n");
 680
 681         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
 682         return ret;
 683 }
 684
 685 static void if_sdio_do_prog_firmware(struct lbs_private *priv, int ret,
 686                                      const struct firmware *helper,
 687                                      const struct firmware *mainfw)
 688 {
 689         struct if_sdio_card *card = priv->card;
 690
 691         if (ret) {
 692                 pr_err("failed to find firmware (%d)\n", ret);
 693                 return;
 694         }
 695
 696         ret = if_sdio_prog_helper(card, helper);
 697         if (ret)
 698                 return;
 699
 700         lbs_deb_sdio("Helper firmware loaded\n");
 701
 702         ret = if_sdio_prog_real(card, mainfw);
 703         if (ret)
 704                 return;
 705
 706         lbs_deb_sdio("Firmware loaded\n");
 707         if_sdio_finish_power_on(card);
 708 }
 709
 710 static int if_sdio_prog_firmware(struct if_sdio_card *card)
 711 {
 712         int ret;
 713         u16 scratch;
 714
 715         lbs_deb_enter(LBS_DEB_SDIO);
 716
 717         /*
 718          * Disable interrupts
 719          */
 720         sdio_claim_host(card->func);
 721         sdio_writeb(card->func, 0x00, IF_SDIO_H_INT_MASK, &ret);
 722         sdio_release_host(card->func);
 723
 724         sdio_claim_host(card->func);
 725         scratch = if_sdio_read_scratch(card, &ret);
 726         sdio_release_host(card->func);
 727
 728         lbs_deb_sdio("firmware status = %#x\n", scratch);
 729         lbs_deb_sdio("scratch ret = %d\n", ret);
 730
 731         if (ret)
 732                 goto out;
 733
 734
 735         /*
 736          * The manual clearly describes that FEDC is the right code to use
 737          * to detect firmware presence, but for SD8686 it is not that simple.
 738          * Scratch is also used to store the RX packet length, so we lose
 739          * the FEDC value early on. So we use a non-zero check in order
 740          * to validate firmware presence.
 741          * Additionally, the SD8686 in the Gumstix always has the high scratch
 742          * bit set, even when the firmware is not loaded. So we have to
 743          * exclude that from the test.
 744          */
 745         if (scratch == IF_SDIO_FIRMWARE_OK) {
 746                 lbs_deb_sdio("firmware already loaded\n");
 747                 if_sdio_finish_power_on(card);
 748                 return 0;
 749         } else if ((card->model == MODEL_8686) && (scratch & 0x7fff)) {
 750                 lbs_deb_sdio("firmware may be running\n");
 751                 if_sdio_finish_power_on(card);
 752                 return 0;
 753         }
 754
 755         ret = lbs_get_firmware_async(card->priv, &card->func->dev, card->model,
 756                                      fw_table, if_sdio_do_prog_firmware);
 757
 758 out:
 759         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
 760         return ret;
 761 }
 762
 763 /********************************************************************/
 764 /* Power management                                                 */
 765 /********************************************************************/
 766
 767 /* Finish power on sequence (after firmware is loaded) */
 768 static void if_sdio_finish_power_on(struct if_sdio_card *card)
 769 {
 770         struct sdio_func *func = card->func;
 771         struct lbs_private *priv = card->priv;
 772         int ret;
 773
 774         sdio_claim_host(func);
 775         sdio_set_block_size(card->func, IF_SDIO_BLOCK_SIZE);
 776
 777         /*
 778          * Get rx_unit if the chip is SD8688 or newer.
 779          * SD8385 & SD8686 do not have rx_unit.
 780          */
 781         if ((card->model != MODEL_8385)
 782                         && (card->model != MODEL_8686))
 783                 card->rx_unit = if_sdio_read_rx_unit(card);
 784         else
 785                 card->rx_unit = 0;
 786
 787         /*
 788          * Set up the interrupt handler late.
 789          *
 790          * If we set it up earlier, the (buggy) hardware generates a spurious
 791          * interrupt, even before the interrupt has been enabled, with
 792          * CCCR_INTx = 0.
 793          *
 794          * We register the interrupt handler late so that we can handle any
 795          * spurious interrupts, and also to avoid generation of that known
 796          * spurious interrupt in the first place.
 797          */
 798         ret = sdio_claim_irq(func, if_sdio_interrupt);
 799         if (ret)
 800                 goto release;
 801
 802         /*
 803          * Enable interrupts now that everything is set up
 804          */
 805         sdio_writeb(func, 0x0f, IF_SDIO_H_INT_MASK, &ret);
 806         if (ret)
 807                 goto release_irq;
 808
 809         sdio_release_host(func);
 810
 811         /* Set fw_ready before queuing any commands so that
 812          * lbs_thread won't block from sending them to firmware.
 813          */
 814         priv->fw_ready = 1;
 815
 816         /*
 817          * FUNC_INIT is required for SD8688 WLAN/BT multiple functions
 818          */
 819         if (card->model == MODEL_8688) {
 820                 struct cmd_header cmd;
 821
 822                 memset(&cmd, 0, sizeof(cmd));
 823
 824                 lbs_deb_sdio("send function INIT command\n");
 825                 if (__lbs_cmd(priv, CMD_FUNC_INIT, &cmd, sizeof(cmd),
 826                                 lbs_cmd_copyback, (unsigned long) &cmd))
 827                         netdev_alert(priv->dev, "CMD_FUNC_INIT cmd failed\n");
 828         }
 829
 830         wake_up(&card->pwron_waitq);
 831
 832         if (!card->started) {
 833                 ret = lbs_start_card(priv);
 834                 if_sdio_power_off(card);
 835                 if (ret == 0) {
 836                         card->started = true;
 837                         /* Tell PM core that we don't need the card to be
 838                          * powered now */
 839                         pm_runtime_put(&func->dev);
 840                 }
 841         }
 842
 843         return;
 844
 845 release_irq:
 846         sdio_release_irq(func);
 847 release:
 848         sdio_release_host(func);
 849 }
 850
 851 static int if_sdio_power_on(struct if_sdio_card *card)
 852 {
 853         struct sdio_func *func = card->func;
 854         struct mmc_host *host = func->card->host;
 855         int ret;
 856
 857         sdio_claim_host(func);
 858
 859         ret = sdio_enable_func(func);
 860         if (ret)
 861                 goto release;
 862
 863         /* For 1-bit transfers to the 8686 model, we need to enable the
 864          * interrupt flag in the CCCR register. Set the MMC_QUIRK_LENIENT_FN0
 865          * bit to allow access to non-vendor registers. */
 866         if ((card->model == MODEL_8686) &&
 867             (host->caps & MMC_CAP_SDIO_IRQ) &&
 868             (host->ios.bus_width == MMC_BUS_WIDTH_1)) {
 869                 u8 reg;
 870
 871                 func->card->quirks |= MMC_QUIRK_LENIENT_FN0;
 872                 reg = sdio_f0_readb(func, SDIO_CCCR_IF, &ret);
 873                 if (ret)
 874                         goto disable;
 875
 876                 reg |= SDIO_BUS_ECSI;
 877                 sdio_f0_writeb(func, reg, SDIO_CCCR_IF, &ret);
 878                 if (ret)
 879                         goto disable;
 880         }
 881
 882         card->ioport = sdio_readb(func, IF_SDIO_IOPORT, &ret);
 883         if (ret)
 884                 goto disable;
 885
 886         card->ioport |= sdio_readb(func, IF_SDIO_IOPORT + 1, &ret) << 8;
 887         if (ret)
 888                 goto disable;
 889
 890         card->ioport |= sdio_readb(func, IF_SDIO_IOPORT + 2, &ret) << 16;
 891         if (ret)
 892                 goto disable;
 893
 894         sdio_release_host(func);
 895         ret = if_sdio_prog_firmware(card);
 896         if (ret) {
 897                 sdio_claim_host(func);
 898                 goto disable;
 899         }
 900
 901         return 0;
 902
 903 disable:
 904         sdio_disable_func(func);
 905 release:
 906         sdio_release_host(func);
 907         return ret;
 908 }
 909
 910 static int if_sdio_power_off(struct if_sdio_card *card)
 911 {
 912         struct sdio_func *func = card->func;
 913         struct lbs_private *priv = card->priv;
 914
 915         priv->fw_ready = 0;
 916
 917         sdio_claim_host(func);
 918         sdio_release_irq(func);
 919         sdio_disable_func(func);
 920         sdio_release_host(func);
 921         return 0;
 922 }
 923
 924
 925 /*******************************************************************/
 926 /* Libertas callbacks                                              */
 927 /*******************************************************************/
 928
 929 static int if_sdio_host_to_card(struct lbs_private *priv,
 930                 u8 type, u8 *buf, u16 nb)
 931 {
 932         int ret;
 933         struct if_sdio_card *card;
 934         struct if_sdio_packet *packet, *cur;
 935         u16 size;
 936         unsigned long flags;
 937
 938         lbs_deb_enter_args(LBS_DEB_SDIO, "type %d, bytes %d", type, nb);
 939
 940         card = priv->card;
 941
 942         if (nb > (65536 - sizeof(struct if_sdio_packet) - 4)) {
 943                 ret = -EINVAL;
 944                 goto out;
 945         }
 946
 947         /*
 948          * The transfer must be in one transaction or the firmware
 949          * goes suicidal. There's no way to guarantee that for all
 950          * controllers, but we can at least try.
 951          */
 952         size = sdio_align_size(card->func, nb + 4);
 953
 954         packet = kzalloc(sizeof(struct if_sdio_packet) + size,
 955                         GFP_ATOMIC);
 956         if (!packet) {
 957                 ret = -ENOMEM;
 958                 goto out;
 959         }
 960
 961         packet->next = NULL;
 962         packet->nb = size;
 963
 964         /*
 965          * SDIO specific header.
 966          */
 967         packet->buffer[0] = (nb + 4) & 0xff;
 968         packet->buffer[1] = ((nb + 4) >> 8) & 0xff;
 969         packet->buffer[2] = type;
 970         packet->buffer[3] = 0;
 971
 972         memcpy(packet->buffer + 4, buf, nb);
 973
 974         spin_lock_irqsave(&card->lock, flags);
 975
 976         if (!card->packets)
 977                 card->packets = packet;
 978         else {
 979                 cur = card->packets;
 980                 while (cur->next)
 981                         cur = cur->next;
 982                 cur->next = packet;
 983         }
 984
 985         switch (type) {
 986         case MVMS_CMD:
 987                 priv->dnld_sent = DNLD_CMD_SENT;
 988                 break;
 989         case MVMS_DAT:
 990                 priv->dnld_sent = DNLD_DATA_SENT;
 991                 break;
 992         default:
 993                 lbs_deb_sdio("unknown packet type %d\n", (int)type);
 994         }
 995
 996         spin_unlock_irqrestore(&card->lock, flags);
 997
 998         queue_work(card->workqueue, &card->packet_worker);
 999
1000         ret = 0;
1001
1002 out:
1003         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
1004
1005         return ret;
1006 }
1007
1008 static int if_sdio_enter_deep_sleep(struct lbs_private *priv)
1009 {
1010         int ret = -1;
1011         struct cmd_header cmd;
1012
1013         memset(&cmd, 0, sizeof(cmd));
1014
1015         lbs_deb_sdio("send DEEP_SLEEP command\n");
1016         ret = __lbs_cmd(priv, CMD_802_11_DEEP_SLEEP, &cmd, sizeof(cmd),
1017                         lbs_cmd_copyback, (unsigned long) &cmd);
1018         if (ret)
1019                 netdev_err(priv->dev, "DEEP_SLEEP cmd failed\n");
1020
1021         mdelay(200);
1022         return ret;
1023 }
1024
1025 static int if_sdio_exit_deep_sleep(struct lbs_private *priv)
1026 {
1027         struct if_sdio_card *card = priv->card;
1028         int ret = -1;
1029
1030         lbs_deb_enter(LBS_DEB_SDIO);
1031         sdio_claim_host(card->func);
1032
1033         sdio_writeb(card->func, HOST_POWER_UP, CONFIGURATION_REG, &ret);
1034         if (ret)
1035                 netdev_err(priv->dev, "sdio_writeb failed!\n");
1036
1037         sdio_release_host(card->func);
1038         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
1039         return ret;
1040 }
1041
1042 static int if_sdio_reset_deep_sleep_wakeup(struct lbs_private *priv)
1043 {
1044         struct if_sdio_card *card = priv->card;
1045         int ret = -1;
1046
1047         lbs_deb_enter(LBS_DEB_SDIO);
1048         sdio_claim_host(card->func);
1049
1050         sdio_writeb(card->func, 0, CONFIGURATION_REG, &ret);
1051         if (ret)
1052                 netdev_err(priv->dev, "sdio_writeb failed!\n");
1053
1054         sdio_release_host(card->func);
1055         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
1056         return ret;
1057
1058 }
1059
1060 static struct mmc_host *reset_host;
1061
1062 static void if_sdio_reset_card_worker(struct work_struct *work)
1063 {
1064         /*
1065          * The actual reset operation must be run outside of lbs_thread. This
1066          * is because mmc_remove_host() will cause the device to be instantly
1067          * destroyed, and the libertas driver then needs to end lbs_thread,
1068          * leading to a deadlock.
1069          *
1070          * We run it in a workqueue totally independent from the if_sdio_card
1071          * instance for that reason.
1072          */
1073
1074         pr_info("Resetting card...");
1075         mmc_remove_host(reset_host);
1076         mmc_add_host(reset_host);
1077 }
1078 static DECLARE_WORK(card_reset_work, if_sdio_reset_card_worker);
1079
1080 static void if_sdio_reset_card(struct lbs_private *priv)
1081 {
1082         struct if_sdio_card *card = priv->card;
1083
1084         if (work_pending(&card_reset_work))
1085                 return;
1086
1087         reset_host = card->func->card->host;
1088         schedule_work(&card_reset_work);
1089 }
1090
1091 static int if_sdio_power_save(struct lbs_private *priv)
1092 {
1093         struct if_sdio_card *card = priv->card;
1094         int ret;
1095
1096         flush_workqueue(card->workqueue);
1097
1098         ret = if_sdio_power_off(card);
1099
1100         /* Let runtime PM know the card is powered off */
1101         pm_runtime_put_sync(&card->func->dev);
1102
1103         return ret;
1104 }
1105
1106 static int if_sdio_power_restore(struct lbs_private *priv)
1107 {
1108         struct if_sdio_card *card = priv->card;
1109         int r;
1110
1111         /* Make sure the card will not be powered off by runtime PM */
1112         pm_runtime_get_sync(&card->func->dev);
1113
1114         r = if_sdio_power_on(card);
1115         if (r)
1116                 return r;
1117
1118         wait_event(card->pwron_waitq, priv->fw_ready);
1119         return 0;
1120 }
1121
1122
1123 /*******************************************************************/
1124 /* SDIO callbacks                                                  */
1125 /*******************************************************************/
1126
1127 static void if_sdio_interrupt(struct sdio_func *func)
1128 {
1129         int ret;
1130         struct if_sdio_card *card;
1131         u8 cause;
1132
1133         lbs_deb_enter(LBS_DEB_SDIO);
1134
1135         card = sdio_get_drvdata(func);
1136
1137         cause = sdio_readb(card->func, IF_SDIO_H_INT_STATUS, &ret);
1138         if (ret || !cause)
1139                 goto out;
1140
1141         lbs_deb_sdio("interrupt: 0x%X\n", (unsigned)cause);
1142
1143         sdio_writeb(card->func, ~cause, IF_SDIO_H_INT_STATUS, &ret);
1144         if (ret)
1145                 goto out;
1146
1147         /*
1148          * Ignore the define name, this really means the card has
1149          * successfully received the command.
1150          */
1151         card->priv->is_activity_detected = 1;
1152         if (cause & IF_SDIO_H_INT_DNLD)
1153                 lbs_host_to_card_done(card->priv);
1154
1155
1156         if (cause & IF_SDIO_H_INT_UPLD) {
1157                 ret = if_sdio_card_to_host(card);
1158                 if (ret)
1159                         goto out;
1160         }
1161
1162         ret = 0;
1163
1164 out:
1165         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
1166 }
1167
1168 static int if_sdio_probe(struct sdio_func *func,
1169                 const struct sdio_device_id *id)
1170 {
1171         struct if_sdio_card *card;
1172         struct lbs_private *priv;
1173         int ret, i;
1174         unsigned int model;
1175         struct if_sdio_packet *packet;
1176
1177         lbs_deb_enter(LBS_DEB_SDIO);
1178
1179         for (i = 0;i < func->card->num_info;i++) {
1180                 if (sscanf(func->card->info[i],
1181                                 "802.11 SDIO ID: %x", &model) == 1)
1182                         break;
1183                 if (sscanf(func->card->info[i],
1184                                 "ID: %x", &model) == 1)
1185                         break;
1186                 if (!strcmp(func->card->info[i], "IBIS Wireless SDIO Card")) {
1187                         model = MODEL_8385;
1188                         break;
1189                 }
1190         }
1191
1192         if (i == func->card->num_info) {
1193                 pr_err("unable to identify card model\n");
1194                 return -ENODEV;
1195         }
1196
1197         card = kzalloc(sizeof(struct if_sdio_card), GFP_KERNEL);
1198         if (!card)
1199                 return -ENOMEM;
1200
1201         card->func = func;
1202         card->model = model;
1203
1204         switch (card->model) {
1205         case MODEL_8385:
1206                 card->scratch_reg = IF_SDIO_SCRATCH_OLD;
1207                 break;
1208         case MODEL_8686:
1209                 card->scratch_reg = IF_SDIO_SCRATCH;
1210                 break;
1211         case MODEL_8688:
1212         default: /* for newer chipsets */
1213                 card->scratch_reg = IF_SDIO_FW_STATUS;
1214                 break;
1215         }
1216
1217         spin_lock_init(&card->lock);
1218         card->workqueue = create_workqueue("libertas_sdio");
1219         if (unlikely(!card->workqueue)) {
1220                 ret = -ENOMEM;
1221                 goto err_queue;
1222         }
1223         INIT_WORK(&card->packet_worker, if_sdio_host_to_card_worker);
1224         init_waitqueue_head(&card->pwron_waitq);
1225
1226         /* Check if we support this card */
1227         for (i = 0; i < ARRAY_SIZE(fw_table); i++) {
1228                 if (card->model == fw_table[i].model)
1229                         break;
1230         }
1231         if (i == ARRAY_SIZE(fw_table)) {
1232                 pr_err("unknown card model 0x%x\n", card->model);
1233                 ret = -ENODEV;
1234                 goto free;
1235         }
1236
1237         sdio_set_drvdata(func, card);
1238
1239         lbs_deb_sdio("class = 0x%X, vendor = 0x%X, "
1240                         "device = 0x%X, model = 0x%X, ioport = 0x%X\n",
1241                         func->class, func->vendor, func->device,
1242                         model, (unsigned)card->ioport);
1243
1244
1245         priv = lbs_add_card(card, &func->dev);
1246         if (!priv) {
1247                 ret = -ENOMEM;
1248                 goto free;
1249         }
1250
1251         card->priv = priv;
1252
1253         priv->card = card;
1254         priv->hw_host_to_card = if_sdio_host_to_card;
1255         priv->enter_deep_sleep = if_sdio_enter_deep_sleep;
1256         priv->exit_deep_sleep = if_sdio_exit_deep_sleep;
1257         priv->reset_deep_sleep_wakeup = if_sdio_reset_deep_sleep_wakeup;
1258         priv->reset_card = if_sdio_reset_card;
1259         priv->power_save = if_sdio_power_save;
1260         priv->power_restore = if_sdio_power_restore;
1261
1262         ret = if_sdio_power_on(card);
1263         if (ret)
1264                 goto err_activate_card;
1265
1266 out:
1267         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
1268
1269         return ret;
1270
1271 err_activate_card:
1272         flush_workqueue(card->workqueue);
1273         lbs_remove_card(priv);
1274 free:
1275         destroy_workqueue(card->workqueue);
1276 err_queue:
1277         while (card->packets) {
1278                 packet = card->packets;
1279                 card->packets = card->packets->next;
1280                 kfree(packet);
1281         }
1282
1283         kfree(card);
1284
1285         goto out;
1286 }
1287
1288 static void if_sdio_remove(struct sdio_func *func)
1289 {
1290         struct if_sdio_card *card;
1291         struct if_sdio_packet *packet;
1292
1293         lbs_deb_enter(LBS_DEB_SDIO);
1294
1295         card = sdio_get_drvdata(func);
1296
1297         /* Undo decrement done above in if_sdio_probe */
1298         pm_runtime_get_noresume(&func->dev);
1299
1300         if (user_rmmod && (card->model == MODEL_8688)) {
1301                 /*
1302                  * FUNC_SHUTDOWN is required for SD8688 WLAN/BT
1303                  * multiple functions
1304                  */
1305                 struct cmd_header cmd;
1306
1307                 memset(&cmd, 0, sizeof(cmd));
1308
1309                 lbs_deb_sdio("send function SHUTDOWN command\n");
1310                 if (__lbs_cmd(card->priv, CMD_FUNC_SHUTDOWN,
1311                                 &cmd, sizeof(cmd), lbs_cmd_copyback,
1312                                 (unsigned long) &cmd))
1313                         pr_alert("CMD_FUNC_SHUTDOWN cmd failed\n");
1314         }
1315
1316
1317         lbs_deb_sdio("call remove card\n");
1318         lbs_stop_card(card->priv);
1319         lbs_remove_card(card->priv);
1320
1321         flush_workqueue(card->workqueue);
1322         destroy_workqueue(card->workqueue);
1323
1324         while (card->packets) {
1325                 packet = card->packets;
1326                 card->packets = card->packets->next;
1327                 kfree(packet);
1328         }
1329
1330         kfree(card);
1331         lbs_deb_leave(LBS_DEB_SDIO);
1332 }
1333
1334 static int if_sdio_suspend(struct device *dev)
1335 {
1336         struct sdio_func *func = dev_to_sdio_func(dev);
1337         int ret;
1338         struct if_sdio_card *card = sdio_get_drvdata(func);
1339
1340         mmc_pm_flag_t flags = sdio_get_host_pm_caps(func);
1341
1342         /* If we're powered off anyway, just let the mmc layer remove the
1343          * card. */
1344         if (!lbs_iface_active(card->priv))
1345                 return -ENOSYS;
1346
1347         dev_info(dev, "%s: suspend: PM flags = 0x%x\n",
1348                  sdio_func_id(func), flags);
1349
1350         /* If we aren't being asked to wake on anything, we should bail out
1351          * and let the SD stack power down the card.
1352          */
1353         if (card->priv->wol_criteria == EHS_REMOVE_WAKEUP) {
1354                 dev_info(dev, "Suspend without wake params -- powering down card\n");
1355                 return -ENOSYS;
1356         }
1357
1358         if (!(flags & MMC_PM_KEEP_POWER)) {
1359                 dev_err(dev, "%s: cannot remain alive while host is suspended\n",
1360                         sdio_func_id(func));
1361                 return -ENOSYS;
1362         }
1363
1364         ret = sdio_set_host_pm_flags(func, MMC_PM_KEEP_POWER);
1365         if (ret)
1366                 return ret;
1367
1368         ret = lbs_suspend(card->priv);
1369         if (ret)
1370                 return ret;
1371
1372         return sdio_set_host_pm_flags(func, MMC_PM_WAKE_SDIO_IRQ);
1373 }
1374
1375 static int if_sdio_resume(struct device *dev)
1376 {
1377         struct sdio_func *func = dev_to_sdio_func(dev);
1378         struct if_sdio_card *card = sdio_get_drvdata(func);
1379         int ret;
1380
1381         dev_info(dev, "%s: resume: we're back\n", sdio_func_id(func));
1382
1383         ret = lbs_resume(card->priv);
1384
1385         return ret;
1386 }
1387
1388 static const struct dev_pm_ops if_sdio_pm_ops = {
1389         .suspend        = if_sdio_suspend,
1390         .resume         = if_sdio_resume,
1391 };
1392
1393 static struct sdio_driver if_sdio_driver = {
1394         .name           = "libertas_sdio",
1395         .id_table       = if_sdio_ids,
1396         .probe          = if_sdio_probe,
1397         .remove         = if_sdio_remove,
1398         .drv = {
1399                 .pm = &if_sdio_pm_ops,
1400         },
1401 };
1402
1403 /*******************************************************************/
1404 /* Module functions                                                */
1405 /*******************************************************************/
1406
1407 static int __init if_sdio_init_module(void)
1408 {
1409         int ret = 0;
1410
1411         lbs_deb_enter(LBS_DEB_SDIO);
1412
1413         printk(KERN_INFO "libertas_sdio: Libertas SDIO driver\n");
1414         printk(KERN_INFO "libertas_sdio: Copyright Pierre Ossman\n");
1415
1416         ret = sdio_register_driver(&if_sdio_driver);
1417
1418         /* Clear the flag in case user removes the card. */
1419         user_rmmod = 0;
1420
1421         lbs_deb_leave_args(LBS_DEB_SDIO, "ret %d", ret);
1422
1423         return ret;
1424 }
1425
1426 static void __exit if_sdio_exit_module(void)
1427 {
1428         lbs_deb_enter(LBS_DEB_SDIO);
1429
1430         /* Set the flag as user is removing this module. */
1431         user_rmmod = 1;
1432
1433         cancel_work_sync(&card_reset_work);
1434
1435         sdio_unregister_driver(&if_sdio_driver);
1436
1437         lbs_deb_leave(LBS_DEB_SDIO);
1438 }
1439
1440 module_init(if_sdio_init_module);
1441 module_exit(if_sdio_exit_module);
1442
1443 MODULE_DESCRIPTION("Libertas SDIO WLAN Driver");
1444 MODULE_AUTHOR("Pierre Ossman");
1445 MODULE_LICENSE("GPL");