drivers/net/wireless/marvell/libertas/if_spi.c

   1 /*
   2  *      linux/drivers/net/wireless/libertas/if_spi.c
   3  *
   4  *      Driver for Marvell SPI WLAN cards.
   5  *
   6  *      Copyright 2008 Analog Devices Inc.
   7  *
   8  *      Authors:
   9  *      Andrey Yurovsky <andrey@cozybit.com>
  10  *      Colin McCabe <colin@cozybit.com>
  11  *
  12  *      Inspired by if_sdio.c, Copyright 2007-2008 Pierre Ossman
  13  *
  14  * This program is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation; either version 2 of the License, or
  17  * (at your option) any later version.
  18  */
  19
  20 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  21
  22 #include <linux/hardirq.h>
  23 #include <linux/interrupt.h>
  24 #include <linux/module.h>
  25 #include <linux/firmware.h>
  26 #include <linux/jiffies.h>
  27 #include <linux/list.h>
  28 #include <linux/netdevice.h>
  29 #include <linux/slab.h>
  30 #include <linux/spi/libertas_spi.h>
  31 #include <linux/spi/spi.h>
  32
  33 #include "host.h"
  34 #include "decl.h"
  35 #include "defs.h"
  36 #include "dev.h"
  37 #include "if_spi.h"
  38
  39 struct if_spi_packet {
  40         struct list_head                list;
  41         u16                             blen;
  42         u8                              buffer[0] __attribute__((aligned(4)));
  43 };
  44
  45 struct if_spi_card {
  46         struct spi_device               *spi;
  47         struct lbs_private              *priv;
  48         struct libertas_spi_platform_data *pdata;
  49
  50         /* The card ID and card revision, as reported by the hardware. */
  51         u16                             card_id;
  52         u8                              card_rev;
  53
  54         /* The last time that we initiated an SPU operation */
  55         unsigned long                   prev_xfer_time;
  56
  57         int                             use_dummy_writes;
  58         unsigned long                   spu_port_delay;
  59         unsigned long                   spu_reg_delay;
  60
  61         /* Handles all SPI communication (except for FW load) */
  62         struct workqueue_struct         *workqueue;
  63         struct work_struct              packet_work;
  64         struct work_struct              resume_work;
  65
  66         u8                              cmd_buffer[IF_SPI_CMD_BUF_SIZE];
  67
  68         /* A buffer of incoming packets from libertas core.
  69          * Since we can't sleep in hw_host_to_card, we have to buffer
  70          * them. */
  71         struct list_head                cmd_packet_list;
  72         struct list_head                data_packet_list;
  73
  74         /* Protects cmd_packet_list and data_packet_list */
  75         spinlock_t                      buffer_lock;
  76
  77         /* True is card suspended */
  78         u8                              suspended;
  79 };
  80
  81 static void free_if_spi_card(struct if_spi_card *card)
  82 {
  83         struct list_head *cursor, *next;
  84         struct if_spi_packet *packet;
  85
  86         list_for_each_safe(cursor, next, &card->cmd_packet_list) {
  87                 packet = container_of(cursor, struct if_spi_packet, list);
  88                 list_del(&packet->list);
  89                 kfree(packet);
  90         }
  91         list_for_each_safe(cursor, next, &card->data_packet_list) {
  92                 packet = container_of(cursor, struct if_spi_packet, list);
  93                 list_del(&packet->list);
  94                 kfree(packet);
  95         }
  96         kfree(card);
  97 }
  98
  99 #define MODEL_8385      0x04
 100 #define MODEL_8686      0x0b
 101 #define MODEL_8688      0x10
 102
 103 static const struct lbs_fw_table fw_table[] = {
 104         { MODEL_8385, "/*(DEBLOBBED)*/", "/*(DEBLOBBED)*/" },
 105         { MODEL_8385, "/*(DEBLOBBED)*/", "/*(DEBLOBBED)*/" },
 106         { MODEL_8686, "/*(DEBLOBBED)*/", "/*(DEBLOBBED)*/" },
 107         { MODEL_8686, "/*(DEBLOBBED)*/", "/*(DEBLOBBED)*/" },
 108         { MODEL_8688, "/*(DEBLOBBED)*/", "/*(DEBLOBBED)*/" },
 109         { 0, NULL, NULL }
 110 };
 111 /*(DEBLOBBED)*/
 112
 113
 114 /*
 115  * SPI Interface Unit Routines
 116  *
 117  * The SPU sits between the host and the WLAN module.
 118  * All communication with the firmware is through SPU transactions.
 119  *
 120  * First we have to put a SPU register name on the bus. Then we can
 121  * either read from or write to that register.
 122  *
 123  */
 124
 125 static void spu_transaction_init(struct if_spi_card *card)
 126 {
 127         if (!time_after(jiffies, card->prev_xfer_time + 1)) {
 128                 /* Unfortunately, the SPU requires a delay between successive
 129                  * transactions. If our last transaction was more than a jiffy
 130                  * ago, we have obviously already delayed enough.
 131                  * If not, we have to busy-wait to be on the safe side. */
 132                 ndelay(400);
 133         }
 134 }
 135
 136 static void spu_transaction_finish(struct if_spi_card *card)
 137 {
 138         card->prev_xfer_time = jiffies;
 139 }
 140
 141 /*
 142  * Write out a byte buffer to an SPI register,
 143  * using a series of 16-bit transfers.
 144  */
 145 static int spu_write(struct if_spi_card *card, u16 reg, const u8 *buf, int len)
 146 {
 147         int err = 0;
 148         __le16 reg_out = cpu_to_le16(reg | IF_SPI_WRITE_OPERATION_MASK);
 149         struct spi_message m;
 150         struct spi_transfer reg_trans;
 151         struct spi_transfer data_trans;
 152
 153         spi_message_init(&m);
 154         memset(&reg_trans, 0, sizeof(reg_trans));
 155         memset(&data_trans, 0, sizeof(data_trans));
 156
 157         /* You must give an even number of bytes to the SPU, even if it
 158          * doesn't care about the last one.  */
 159         BUG_ON(len & 0x1);
 160
 161         spu_transaction_init(card);
 162
 163         /* write SPU register index */
 164         reg_trans.tx_buf = &reg_out;
 165         reg_trans.len = sizeof(reg_out);
 166
 167         data_trans.tx_buf = buf;
 168         data_trans.len = len;
 169
 170         spi_message_add_tail(&reg_trans, &m);
 171         spi_message_add_tail(&data_trans, &m);
 172
 173         err = spi_sync(card->spi, &m);
 174         spu_transaction_finish(card);
 175         return err;
 176 }
 177
 178 static inline int spu_write_u16(struct if_spi_card *card, u16 reg, u16 val)
 179 {
 180         __le16 buff;
 181
 182         buff = cpu_to_le16(val);
 183         return spu_write(card, reg, (u8 *)&buff, sizeof(u16));
 184 }
 185
 186 static inline int spu_reg_is_port_reg(u16 reg)
 187 {
 188         switch (reg) {
 189         case IF_SPI_IO_RDWRPORT_REG:
 190         case IF_SPI_CMD_RDWRPORT_REG:
 191         case IF_SPI_DATA_RDWRPORT_REG:
 192                 return 1;
 193         default:
 194                 return 0;
 195         }
 196 }
 197
 198 static int spu_read(struct if_spi_card *card, u16 reg, u8 *buf, int len)
 199 {
 200         unsigned int delay;
 201         int err = 0;
 202         __le16 reg_out = cpu_to_le16(reg | IF_SPI_READ_OPERATION_MASK);
 203         struct spi_message m;
 204         struct spi_transfer reg_trans;
 205         struct spi_transfer dummy_trans;
 206         struct spi_transfer data_trans;
 207
 208         /*
 209          * You must take an even number of bytes from the SPU, even if you
 210          * don't care about the last one.
 211          */
 212         BUG_ON(len & 0x1);
 213
 214         spu_transaction_init(card);
 215
 216         spi_message_init(&m);
 217         memset(&reg_trans, 0, sizeof(reg_trans));
 218         memset(&dummy_trans, 0, sizeof(dummy_trans));
 219         memset(&data_trans, 0, sizeof(data_trans));
 220
 221         /* write SPU register index */
 222         reg_trans.tx_buf = &reg_out;
 223         reg_trans.len = sizeof(reg_out);
 224         spi_message_add_tail(&reg_trans, &m);
 225
 226         delay = spu_reg_is_port_reg(reg) ? card->spu_port_delay :
 227                                                 card->spu_reg_delay;
 228         if (card->use_dummy_writes) {
 229                 /* Clock in dummy cycles while the SPU fills the FIFO */
 230                 dummy_trans.len = delay / 8;
 231                 spi_message_add_tail(&dummy_trans, &m);
 232         } else {
 233                 /* Busy-wait while the SPU fills the FIFO */
 234                 reg_trans.delay_usecs =
 235                         DIV_ROUND_UP((100 + (delay * 10)), 1000);
 236         }
 237
 238         /* read in data */
 239         data_trans.rx_buf = buf;
 240         data_trans.len = len;
 241         spi_message_add_tail(&data_trans, &m);
 242
 243         err = spi_sync(card->spi, &m);
 244         spu_transaction_finish(card);
 245         return err;
 246 }
 247
 248 /* Read 16 bits from an SPI register */
 249 static inline int spu_read_u16(struct if_spi_card *card, u16 reg, u16 *val)
 250 {
 251         __le16 buf;
 252         int ret;
 253
 254         ret = spu_read(card, reg, (u8 *)&buf, sizeof(buf));
 255         if (ret == 0)
 256                 *val = le16_to_cpup(&buf);
 257         return ret;
 258 }
 259
 260 /*
 261  * Read 32 bits from an SPI register.
 262  * The low 16 bits are read first.
 263  */
 264 static int spu_read_u32(struct if_spi_card *card, u16 reg, u32 *val)
 265 {
 266         __le32 buf;
 267         int err;
 268
 269         err = spu_read(card, reg, (u8 *)&buf, sizeof(buf));
 270         if (!err)
 271                 *val = le32_to_cpup(&buf);
 272         return err;
 273 }
 274
 275 /*
 276  * Keep reading 16 bits from an SPI register until you get the correct result.
 277  *
 278  * If mask = 0, the correct result is any non-zero number.
 279  * If mask != 0, the correct result is any number where
 280  * number & target_mask == target
 281  *
 282  * Returns -ETIMEDOUT if a second passes without the correct result.
 283  */
 284 static int spu_wait_for_u16(struct if_spi_card *card, u16 reg,
 285                         u16 target_mask, u16 target)
 286 {
 287         int err;
 288         unsigned long timeout = jiffies + 5*HZ;
 289         while (1) {
 290                 u16 val;
 291                 err = spu_read_u16(card, reg, &val);
 292                 if (err)
 293                         return err;
 294                 if (target_mask) {
 295                         if ((val & target_mask) == target)
 296                                 return 0;
 297                 } else {
 298                         if (val)
 299                                 return 0;
 300                 }
 301                 udelay(100);
 302                 if (time_after(jiffies, timeout)) {
 303                         pr_err("%s: timeout with val=%02x, target_mask=%02x, target=%02x\n",
 304                                __func__, val, target_mask, target);
 305                         return -ETIMEDOUT;
 306                 }
 307         }
 308 }
 309
 310 /*
 311  * Read 16 bits from an SPI register until you receive a specific value.
 312  * Returns -ETIMEDOUT if a 4 tries pass without success.
 313  */
 314 static int spu_wait_for_u32(struct if_spi_card *card, u32 reg, u32 target)
 315 {
 316         int err, try;
 317         for (try = 0; try < 4; ++try) {
 318                 u32 val = 0;
 319                 err = spu_read_u32(card, reg, &val);
 320                 if (err)
 321                         return err;
 322                 if (val == target)
 323                         return 0;
 324                 mdelay(100);
 325         }
 326         return -ETIMEDOUT;
 327 }
 328
 329 static int spu_set_interrupt_mode(struct if_spi_card *card,
 330                            int suppress_host_int,
 331                            int auto_int)
 332 {
 333         int err = 0;
 334
 335         /*
 336          * We can suppress a host interrupt by clearing the appropriate
 337          * bit in the "host interrupt status mask" register
 338          */
 339         if (suppress_host_int) {
 340                 err = spu_write_u16(card, IF_SPI_HOST_INT_STATUS_MASK_REG, 0);
 341                 if (err)
 342                         return err;
 343         } else {
 344                 err = spu_write_u16(card, IF_SPI_HOST_INT_STATUS_MASK_REG,
 345                               IF_SPI_HISM_TX_DOWNLOAD_RDY |
 346                               IF_SPI_HISM_RX_UPLOAD_RDY |
 347                               IF_SPI_HISM_CMD_DOWNLOAD_RDY |
 348                               IF_SPI_HISM_CARDEVENT |
 349                               IF_SPI_HISM_CMD_UPLOAD_RDY);
 350                 if (err)
 351                         return err;
 352         }
 353
 354         /*
 355          * If auto-interrupts are on, the completion of certain transactions
 356          * will trigger an interrupt automatically. If auto-interrupts
 357          * are off, we need to set the "Card Interrupt Cause" register to
 358          * trigger a card interrupt.
 359          */
 360         if (auto_int) {
 361                 err = spu_write_u16(card, IF_SPI_HOST_INT_CTRL_REG,
 362                                 IF_SPI_HICT_TX_DOWNLOAD_OVER_AUTO |
 363                                 IF_SPI_HICT_RX_UPLOAD_OVER_AUTO |
 364                                 IF_SPI_HICT_CMD_DOWNLOAD_OVER_AUTO |
 365                                 IF_SPI_HICT_CMD_UPLOAD_OVER_AUTO);
 366                 if (err)
 367                         return err;
 368         } else {
 369                 err = spu_write_u16(card, IF_SPI_HOST_INT_STATUS_MASK_REG, 0);
 370                 if (err)
 371                         return err;
 372         }
 373         return err;
 374 }
 375
 376 static int spu_get_chip_revision(struct if_spi_card *card,
 377                                   u16 *card_id, u8 *card_rev)
 378 {
 379         int err = 0;
 380         u32 dev_ctrl;
 381         err = spu_read_u32(card, IF_SPI_DEVICEID_CTRL_REG, &dev_ctrl);
 382         if (err)
 383                 return err;
 384         *card_id = IF_SPI_DEVICEID_CTRL_REG_TO_CARD_ID(dev_ctrl);
 385         *card_rev = IF_SPI_DEVICEID_CTRL_REG_TO_CARD_REV(dev_ctrl);
 386         return err;
 387 }
 388
 389 static int spu_set_bus_mode(struct if_spi_card *card, u16 mode)
 390 {
 391         int err = 0;
 392         u16 rval;
 393         /* set bus mode */
 394         err = spu_write_u16(card, IF_SPI_SPU_BUS_MODE_REG, mode);
 395         if (err)
 396                 return err;
 397         /* Check that we were able to read back what we just wrote. */
 398         err = spu_read_u16(card, IF_SPI_SPU_BUS_MODE_REG, &rval);
 399         if (err)
 400                 return err;
 401         if ((rval & 0xF) != mode) {
 402                 pr_err("Can't read bus mode register\n");
 403                 return -EIO;
 404         }
 405         return 0;
 406 }
 407
 408 static int spu_init(struct if_spi_card *card, int use_dummy_writes)
 409 {
 410         int err = 0;
 411         u32 delay;
 412
 413         /*
 414          * We have to start up in timed delay mode so that we can safely
 415          * read the Delay Read Register.
 416          */
 417         card->use_dummy_writes = 0;
 418         err = spu_set_bus_mode(card,
 419                                 IF_SPI_BUS_MODE_SPI_CLOCK_PHASE_RISING |
 420                                 IF_SPI_BUS_MODE_DELAY_METHOD_TIMED |
 421                                 IF_SPI_BUS_MODE_16_BIT_ADDRESS_16_BIT_DATA);
 422         if (err)
 423                 return err;
 424         card->spu_port_delay = 1000;
 425         card->spu_reg_delay = 1000;
 426         err = spu_read_u32(card, IF_SPI_DELAY_READ_REG, &delay);
 427         if (err)
 428                 return err;
 429         card->spu_port_delay = delay & 0x0000ffff;
 430         card->spu_reg_delay = (delay & 0xffff0000) >> 16;
 431
 432         /* If dummy clock delay mode has been requested, switch to it now */
 433         if (use_dummy_writes) {
 434                 card->use_dummy_writes = 1;
 435                 err = spu_set_bus_mode(card,
 436                                 IF_SPI_BUS_MODE_SPI_CLOCK_PHASE_RISING |
 437                                 IF_SPI_BUS_MODE_DELAY_METHOD_DUMMY_CLOCK |
 438                                 IF_SPI_BUS_MODE_16_BIT_ADDRESS_16_BIT_DATA);
 439                 if (err)
 440                         return err;
 441         }
 442
 443         lbs_deb_spi("Initialized SPU unit. "
 444                     "spu_port_delay=0x%04lx, spu_reg_delay=0x%04lx\n",
 445                     card->spu_port_delay, card->spu_reg_delay);
 446         return err;
 447 }
 448
 449 /*
 450  * Firmware Loading
 451  */
 452
 453 static int if_spi_prog_helper_firmware(struct if_spi_card *card,
 454                                         const struct firmware *firmware)
 455 {
 456         int err = 0;
 457         int bytes_remaining;
 458         const u8 *fw;
 459         u8 temp[HELPER_FW_LOAD_CHUNK_SZ];
 460
 461         lbs_deb_enter(LBS_DEB_SPI);
 462
 463         err = spu_set_interrupt_mode(card, 1, 0);
 464         if (err)
 465                 goto out;
 466
 467         bytes_remaining = firmware->size;
 468         fw = firmware->data;
 469
 470         /* Load helper firmware image */
 471         while (bytes_remaining > 0) {
 472                 /*
 473                  * Scratch pad 1 should contain the number of bytes we
 474                  * want to download to the firmware
 475                  */
 476                 err = spu_write_u16(card, IF_SPI_SCRATCH_1_REG,
 477                                         HELPER_FW_LOAD_CHUNK_SZ);
 478                 if (err)
 479                         goto out;
 480
 481                 err = spu_wait_for_u16(card, IF_SPI_HOST_INT_STATUS_REG,
 482                                         IF_SPI_HIST_CMD_DOWNLOAD_RDY,
 483                                         IF_SPI_HIST_CMD_DOWNLOAD_RDY);
 484                 if (err)
 485                         goto out;
 486
 487                 /*
 488                  * Feed the data into the command read/write port reg
 489                  * in chunks of 64 bytes
 490                  */
 491                 memset(temp, 0, sizeof(temp));
 492                 memcpy(temp, fw,
 493                        min(bytes_remaining, HELPER_FW_LOAD_CHUNK_SZ));
 494                 mdelay(10);
 495                 err = spu_write(card, IF_SPI_CMD_RDWRPORT_REG,
 496                                         temp, HELPER_FW_LOAD_CHUNK_SZ);
 497                 if (err)
 498                         goto out;
 499
 500                 /* Interrupt the boot code */
 501                 err = spu_write_u16(card, IF_SPI_HOST_INT_STATUS_REG, 0);
 502                 if (err)
 503                         goto out;
 504                 err = spu_write_u16(card, IF_SPI_CARD_INT_CAUSE_REG,
 505                                        IF_SPI_CIC_CMD_DOWNLOAD_OVER);
 506                 if (err)
 507                         goto out;
 508                 bytes_remaining -= HELPER_FW_LOAD_CHUNK_SZ;
 509                 fw += HELPER_FW_LOAD_CHUNK_SZ;
 510         }
 511
 512         /*
 513          * Once the helper / single stage firmware download is complete,
 514          * write 0 to scratch pad 1 and interrupt the
 515          * bootloader. This completes the helper download.
 516          */
 517         err = spu_write_u16(card, IF_SPI_SCRATCH_1_REG, FIRMWARE_DNLD_OK);
 518         if (err)
 519                 goto out;
 520         err = spu_write_u16(card, IF_SPI_HOST_INT_STATUS_REG, 0);
 521         if (err)
 522                 goto out;
 523         err = spu_write_u16(card, IF_SPI_CARD_INT_CAUSE_REG,
 524                                 IF_SPI_CIC_CMD_DOWNLOAD_OVER);
 525 out:
 526         if (err)
 527                 pr_err("failed to load helper firmware (err=%d)\n", err);
 528         lbs_deb_leave_args(LBS_DEB_SPI, "err %d", err);
 529         return err;
 530 }
 531
 532 /*
 533  * Returns the length of the next packet the firmware expects us to send.
 534  * Sets crc_err if the previous transfer had a CRC error.
 535  */
 536 static int if_spi_prog_main_firmware_check_len(struct if_spi_card *card,
 537                                                 int *crc_err)
 538 {
 539         u16 len;
 540         int err = 0;
 541
 542         /*
 543          * wait until the host interrupt status register indicates
 544          * that we are ready to download
 545          */
 546         err = spu_wait_for_u16(card, IF_SPI_HOST_INT_STATUS_REG,
 547                                 IF_SPI_HIST_CMD_DOWNLOAD_RDY,
 548                                 IF_SPI_HIST_CMD_DOWNLOAD_RDY);
 549         if (err) {
 550                 pr_err("timed out waiting for host_int_status\n");
 551                 return err;
 552         }
 553
 554         /* Ask the device how many bytes of firmware it wants. */
 555         err = spu_read_u16(card, IF_SPI_SCRATCH_1_REG, &len);
 556         if (err)
 557                 return err;
 558
 559         if (len > IF_SPI_CMD_BUF_SIZE) {
 560                 pr_err("firmware load device requested a larger transfer than we are prepared to handle (len = %d)\n",
 561                        len);
 562                 return -EIO;
 563         }
 564         if (len & 0x1) {
 565                 lbs_deb_spi("%s: crc error\n", __func__);
 566                 len &= ~0x1;
 567                 *crc_err = 1;
 568         } else
 569                 *crc_err = 0;
 570
 571         return len;
 572 }
 573
 574 static int if_spi_prog_main_firmware(struct if_spi_card *card,
 575                                         const struct firmware *firmware)
 576 {
 577         struct lbs_private *priv = card->priv;
 578         int len, prev_len;
 579         int bytes, crc_err = 0, err = 0;
 580         const u8 *fw;
 581         u16 num_crc_errs;
 582
 583         lbs_deb_enter(LBS_DEB_SPI);
 584
 585         err = spu_set_interrupt_mode(card, 1, 0);
 586         if (err)
 587                 goto out;
 588
 589         err = spu_wait_for_u16(card, IF_SPI_SCRATCH_1_REG, 0, 0);
 590         if (err) {
 591                 netdev_err(priv->dev,
 592                            "%s: timed out waiting for initial scratch reg = 0\n",
 593                            __func__);
 594                 goto out;
 595         }
 596
 597         num_crc_errs = 0;
 598         prev_len = 0;
 599         bytes = firmware->size;
 600         fw = firmware->data;
 601         while ((len = if_spi_prog_main_firmware_check_len(card, &crc_err))) {
 602                 if (len < 0) {
 603                         err = len;
 604                         goto out;
 605                 }
 606                 if (bytes < 0) {
 607                         /*
 608                          * If there are no more bytes left, we would normally
 609                          * expect to have terminated with len = 0
 610                          */
 611                         netdev_err(priv->dev,
 612                                    "Firmware load wants more bytes than we have to offer.\n");
 613                         break;
 614                 }
 615                 if (crc_err) {
 616                         /* Previous transfer failed. */
 617                         if (++num_crc_errs > MAX_MAIN_FW_LOAD_CRC_ERR) {
 618                                 pr_err("Too many CRC errors encountered in firmware load.\n");
 619                                 err = -EIO;
 620                                 goto out;
 621                         }
 622                 } else {
 623                         /* Previous transfer succeeded. Advance counters. */
 624                         bytes -= prev_len;
 625                         fw += prev_len;
 626                 }
 627                 if (bytes < len) {
 628                         memset(card->cmd_buffer, 0, len);
 629                         memcpy(card->cmd_buffer, fw, bytes);
 630                 } else
 631                         memcpy(card->cmd_buffer, fw, len);
 632
 633                 err = spu_write_u16(card, IF_SPI_HOST_INT_STATUS_REG, 0);
 634                 if (err)
 635                         goto out;
 636                 err = spu_write(card, IF_SPI_CMD_RDWRPORT_REG,
 637                                 card->cmd_buffer, len);
 638                 if (err)
 639                         goto out;
 640                 err = spu_write_u16(card, IF_SPI_CARD_INT_CAUSE_REG ,
 641                                         IF_SPI_CIC_CMD_DOWNLOAD_OVER);
 642                 if (err)
 643                         goto out;
 644                 prev_len = len;
 645         }
 646         if (bytes > prev_len) {
 647                 pr_err("firmware load wants fewer bytes than we have to offer\n");
 648         }
 649
 650         /* Confirm firmware download */
 651         err = spu_wait_for_u32(card, IF_SPI_SCRATCH_4_REG,
 652                                         SUCCESSFUL_FW_DOWNLOAD_MAGIC);
 653         if (err) {
 654                 pr_err("failed to confirm the firmware download\n");
 655                 goto out;
 656         }
 657
 658 out:
 659         if (err)
 660                 pr_err("failed to load firmware (err=%d)\n", err);
 661         lbs_deb_leave_args(LBS_DEB_SPI, "err %d", err);
 662         return err;
 663 }
 664
 665 /*
 666  * SPI Transfer Thread
 667  *
 668  * The SPI worker handles all SPI transfers, so there is no need for a lock.
 669  */
 670
 671 /* Move a command from the card to the host */
 672 static int if_spi_c2h_cmd(struct if_spi_card *card)
 673 {
 674         struct lbs_private *priv = card->priv;
 675         unsigned long flags;
 676         int err = 0;
 677         u16 len;
 678         u8 i;
 679
 680         /*
 681          * We need a buffer big enough to handle whatever people send to
 682          * hw_host_to_card
 683          */
 684         BUILD_BUG_ON(IF_SPI_CMD_BUF_SIZE < LBS_CMD_BUFFER_SIZE);
 685         BUILD_BUG_ON(IF_SPI_CMD_BUF_SIZE < LBS_UPLD_SIZE);
 686
 687         /*
 688          * It's just annoying if the buffer size isn't a multiple of 4, because
 689          * then we might have len < IF_SPI_CMD_BUF_SIZE but
 690          * ALIGN(len, 4) > IF_SPI_CMD_BUF_SIZE
 691          */
 692         BUILD_BUG_ON(IF_SPI_CMD_BUF_SIZE % 4 != 0);
 693
 694         lbs_deb_enter(LBS_DEB_SPI);
 695
 696         /* How many bytes are there to read? */
 697         err = spu_read_u16(card, IF_SPI_SCRATCH_2_REG, &len);
 698         if (err)
 699                 goto out;
 700         if (!len) {
 701                 netdev_err(priv->dev, "%s: error: card has no data for host\n",
 702                            __func__);
 703                 err = -EINVAL;
 704                 goto out;
 705         } else if (len > IF_SPI_CMD_BUF_SIZE) {
 706                 netdev_err(priv->dev,
 707                            "%s: error: response packet too large: %d bytes, but maximum is %d\n",
 708                            __func__, len, IF_SPI_CMD_BUF_SIZE);
 709                 err = -EINVAL;
 710                 goto out;
 711         }
 712
 713         /* Read the data from the WLAN module into our command buffer */
 714         err = spu_read(card, IF_SPI_CMD_RDWRPORT_REG,
 715                                 card->cmd_buffer, ALIGN(len, 4));
 716         if (err)
 717                 goto out;
 718
 719         spin_lock_irqsave(&priv->driver_lock, flags);
 720         i = (priv->resp_idx == 0) ? 1 : 0;
 721         BUG_ON(priv->resp_len[i]);
 722         priv->resp_len[i] = len;
 723         memcpy(priv->resp_buf[i], card->cmd_buffer, len);
 724         lbs_notify_command_response(priv, i);
 725         spin_unlock_irqrestore(&priv->driver_lock, flags);
 726
 727 out:
 728         if (err)
 729                 netdev_err(priv->dev, "%s: err=%d\n", __func__, err);
 730         lbs_deb_leave(LBS_DEB_SPI);
 731         return err;
 732 }
 733
 734 /* Move data from the card to the host */
 735 static int if_spi_c2h_data(struct if_spi_card *card)
 736 {
 737         struct lbs_private *priv = card->priv;
 738         struct sk_buff *skb;
 739         char *data;
 740         u16 len;
 741         int err = 0;
 742
 743         lbs_deb_enter(LBS_DEB_SPI);
 744
 745         /* How many bytes are there to read? */
 746         err = spu_read_u16(card, IF_SPI_SCRATCH_1_REG, &len);
 747         if (err)
 748                 goto out;
 749         if (!len) {
 750                 netdev_err(priv->dev, "%s: error: card has no data for host\n",
 751                            __func__);
 752                 err = -EINVAL;
 753                 goto out;
 754         } else if (len > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE) {
 755                 netdev_err(priv->dev,
 756                            "%s: error: card has %d bytes of data, but our maximum skb size is %zu\n",
 757                            __func__, len, MRVDRV_ETH_RX_PACKET_BUFFER_SIZE);
 758                 err = -EINVAL;
 759                 goto out;
 760         }
 761
 762         /* TODO: should we allocate a smaller skb if we have less data? */
 763         skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE);
 764         if (!skb) {
 765                 err = -ENOBUFS;
 766                 goto out;
 767         }
 768         skb_reserve(skb, IPFIELD_ALIGN_OFFSET);
 769         data = skb_put(skb, len);
 770
 771         /* Read the data from the WLAN module into our skb... */
 772         err = spu_read(card, IF_SPI_DATA_RDWRPORT_REG, data, ALIGN(len, 4));
 773         if (err)
 774                 goto free_skb;
 775
 776         /* pass the SKB to libertas */
 777         err = lbs_process_rxed_packet(card->priv, skb);
 778         if (err)
 779                 goto free_skb;
 780
 781         /* success */
 782         goto out;
 783
 784 free_skb:
 785         dev_kfree_skb(skb);
 786 out:
 787         if (err)
 788                 netdev_err(priv->dev, "%s: err=%d\n", __func__, err);
 789         lbs_deb_leave(LBS_DEB_SPI);
 790         return err;
 791 }
 792
 793 /* Move data or a command from the host to the card. */
 794 static void if_spi_h2c(struct if_spi_card *card,
 795                         struct if_spi_packet *packet, int type)
 796 {
 797         struct lbs_private *priv = card->priv;
 798         int err = 0;
 799         u16 int_type, port_reg;
 800
 801         switch (type) {
 802         case MVMS_DAT:
 803                 int_type = IF_SPI_CIC_TX_DOWNLOAD_OVER;
 804                 port_reg = IF_SPI_DATA_RDWRPORT_REG;
 805                 break;
 806         case MVMS_CMD:
 807                 int_type = IF_SPI_CIC_CMD_DOWNLOAD_OVER;
 808                 port_reg = IF_SPI_CMD_RDWRPORT_REG;
 809                 break;
 810         default:
 811                 netdev_err(priv->dev, "can't transfer buffer of type %d\n",
 812                            type);
 813                 err = -EINVAL;
 814                 goto out;
 815         }
 816
 817         /* Write the data to the card */
 818         err = spu_write(card, port_reg, packet->buffer, packet->blen);
 819         if (err)
 820                 goto out;
 821
 822 out:
 823         kfree(packet);
 824
 825         if (err)
 826                 netdev_err(priv->dev, "%s: error %d\n", __func__, err);
 827 }
 828
 829 /* Inform the host about a card event */
 830 static void if_spi_e2h(struct if_spi_card *card)
 831 {
 832         int err = 0;
 833         u32 cause;
 834         struct lbs_private *priv = card->priv;
 835
 836         err = spu_read_u32(card, IF_SPI_SCRATCH_3_REG, &cause);
 837         if (err)
 838                 goto out;
 839
 840         /* re-enable the card event interrupt */
 841         spu_write_u16(card, IF_SPI_HOST_INT_STATUS_REG,
 842                         ~IF_SPI_HICU_CARD_EVENT);
 843
 844         /* generate a card interrupt */
 845         spu_write_u16(card, IF_SPI_CARD_INT_CAUSE_REG, IF_SPI_CIC_HOST_EVENT);
 846
 847         lbs_queue_event(priv, cause & 0xff);
 848 out:
 849         if (err)
 850                 netdev_err(priv->dev, "%s: error %d\n", __func__, err);
 851 }
 852
 853 static void if_spi_host_to_card_worker(struct work_struct *work)
 854 {
 855         int err;
 856         struct if_spi_card *card;
 857         u16 hiStatus;
 858         unsigned long flags;
 859         struct if_spi_packet *packet;
 860         struct lbs_private *priv;
 861
 862         card = container_of(work, struct if_spi_card, packet_work);
 863         priv = card->priv;
 864
 865         lbs_deb_enter(LBS_DEB_SPI);
 866
 867         /*
 868          * Read the host interrupt status register to see what we
 869          * can do.
 870          */
 871         err = spu_read_u16(card, IF_SPI_HOST_INT_STATUS_REG,
 872                                 &hiStatus);
 873         if (err) {
 874                 netdev_err(priv->dev, "I/O error\n");
 875                 goto err;
 876         }
 877
 878         if (hiStatus & IF_SPI_HIST_CMD_UPLOAD_RDY) {
 879                 err = if_spi_c2h_cmd(card);
 880                 if (err)
 881                         goto err;
 882         }
 883         if (hiStatus & IF_SPI_HIST_RX_UPLOAD_RDY) {
 884                 err = if_spi_c2h_data(card);
 885                 if (err)
 886                         goto err;
 887         }
 888
 889         /*
 890          * workaround: in PS mode, the card does not set the Command
 891          * Download Ready bit, but it sets TX Download Ready.
 892          */
 893         if (hiStatus & IF_SPI_HIST_CMD_DOWNLOAD_RDY ||
 894            (card->priv->psstate != PS_STATE_FULL_POWER &&
 895             (hiStatus & IF_SPI_HIST_TX_DOWNLOAD_RDY))) {
 896                 /*
 897                  * This means two things. First of all,
 898                  * if there was a previous command sent, the card has
 899                  * successfully received it.
 900                  * Secondly, it is now ready to download another
 901                  * command.
 902                  */
 903                 lbs_host_to_card_done(card->priv);
 904
 905                 /* Do we have any command packets from the host to send? */
 906                 packet = NULL;
 907                 spin_lock_irqsave(&card->buffer_lock, flags);
 908                 if (!list_empty(&card->cmd_packet_list)) {
 909                         packet = (struct if_spi_packet *)(card->
 910                                         cmd_packet_list.next);
 911                         list_del(&packet->list);
 912                 }
 913                 spin_unlock_irqrestore(&card->buffer_lock, flags);
 914
 915                 if (packet)
 916                         if_spi_h2c(card, packet, MVMS_CMD);
 917         }
 918         if (hiStatus & IF_SPI_HIST_TX_DOWNLOAD_RDY) {
 919                 /* Do we have any data packets from the host to send? */
 920                 packet = NULL;
 921                 spin_lock_irqsave(&card->buffer_lock, flags);
 922                 if (!list_empty(&card->data_packet_list)) {
 923                         packet = (struct if_spi_packet *)(card->
 924                                         data_packet_list.next);
 925                         list_del(&packet->list);
 926                 }
 927                 spin_unlock_irqrestore(&card->buffer_lock, flags);
 928
 929                 if (packet)
 930                         if_spi_h2c(card, packet, MVMS_DAT);
 931         }
 932         if (hiStatus & IF_SPI_HIST_CARD_EVENT)
 933                 if_spi_e2h(card);
 934
 935 err:
 936         if (err)
 937                 netdev_err(priv->dev, "%s: got error %d\n", __func__, err);
 938
 939         lbs_deb_leave(LBS_DEB_SPI);
 940 }
 941
 942 /*
 943  * Host to Card
 944  *
 945  * Called from Libertas to transfer some data to the WLAN device
 946  * We can't sleep here.
 947  */
 948 static int if_spi_host_to_card(struct lbs_private *priv,
 949                                 u8 type, u8 *buf, u16 nb)
 950 {
 951         int err = 0;
 952         unsigned long flags;
 953         struct if_spi_card *card = priv->card;
 954         struct if_spi_packet *packet;
 955         u16 blen;
 956
 957         lbs_deb_enter_args(LBS_DEB_SPI, "type %d, bytes %d", type, nb);
 958
 959         if (nb == 0) {
 960                 netdev_err(priv->dev, "%s: invalid size requested: %d\n",
 961                            __func__, nb);
 962                 err = -EINVAL;
 963                 goto out;
 964         }
 965         blen = ALIGN(nb, 4);
 966         packet = kzalloc(sizeof(struct if_spi_packet) + blen, GFP_ATOMIC);
 967         if (!packet) {
 968                 err = -ENOMEM;
 969                 goto out;
 970         }
 971         packet->blen = blen;
 972         memcpy(packet->buffer, buf, nb);
 973         memset(packet->buffer + nb, 0, blen - nb);
 974
 975         switch (type) {
 976         case MVMS_CMD:
 977                 priv->dnld_sent = DNLD_CMD_SENT;
 978                 spin_lock_irqsave(&card->buffer_lock, flags);
 979                 list_add_tail(&packet->list, &card->cmd_packet_list);
 980                 spin_unlock_irqrestore(&card->buffer_lock, flags);
 981                 break;
 982         case MVMS_DAT:
 983                 priv->dnld_sent = DNLD_DATA_SENT;
 984                 spin_lock_irqsave(&card->buffer_lock, flags);
 985                 list_add_tail(&packet->list, &card->data_packet_list);
 986                 spin_unlock_irqrestore(&card->buffer_lock, flags);
 987                 break;
 988         default:
 989                 kfree(packet);
 990                 netdev_err(priv->dev, "can't transfer buffer of type %d\n",
 991                            type);
 992                 err = -EINVAL;
 993                 break;
 994         }
 995
 996         /* Queue spi xfer work */
 997         queue_work(card->workqueue, &card->packet_work);
 998 out:
 999         lbs_deb_leave_args(LBS_DEB_SPI, "err=%d", err);
1000         return err;
1001 }
1002
1003 /*
1004  * Host Interrupts
1005  *
1006  * Service incoming interrupts from the WLAN device. We can't sleep here, so
1007  * don't try to talk on the SPI bus, just queue the SPI xfer work.
1008  */
1009 static irqreturn_t if_spi_host_interrupt(int irq, void *dev_id)
1010 {
1011         struct if_spi_card *card = dev_id;
1012
1013         queue_work(card->workqueue, &card->packet_work);
1014
1015         return IRQ_HANDLED;
1016 }
1017
1018 /*
1019  * SPI callbacks
1020  */
1021
1022 static int if_spi_init_card(struct if_spi_card *card)
1023 {
1024         struct lbs_private *priv = card->priv;
1025         int err, i;
1026         u32 scratch;
1027         const struct firmware *helper = NULL;
1028         const struct firmware *mainfw = NULL;
1029
1030         lbs_deb_enter(LBS_DEB_SPI);
1031
1032         err = spu_init(card, card->pdata->use_dummy_writes);
1033         if (err)
1034                 goto out;
1035         err = spu_get_chip_revision(card, &card->card_id, &card->card_rev);
1036         if (err)
1037                 goto out;
1038
1039         err = spu_read_u32(card, IF_SPI_SCRATCH_4_REG, &scratch);
1040         if (err)
1041                 goto out;
1042         if (scratch == SUCCESSFUL_FW_DOWNLOAD_MAGIC)
1043                 lbs_deb_spi("Firmware is already loaded for "
1044                             "Marvell WLAN 802.11 adapter\n");
1045         else {
1046                 /* Check if we support this card */
1047                 for (i = 0; i < ARRAY_SIZE(fw_table); i++) {
1048                         if (card->card_id == fw_table[i].model)
1049                                 break;
1050                 }
1051                 if (i == ARRAY_SIZE(fw_table)) {
1052                         netdev_err(priv->dev, "Unsupported chip_id: 0x%02x\n",
1053                                    card->card_id);
1054                         err = -ENODEV;
1055                         goto out;
1056                 }
1057
1058                 err = lbs_get_firmware(&card->spi->dev, card->card_id,
1059                                         &fw_table[0], &helper, &mainfw);
1060                 if (err) {
1061                         netdev_err(priv->dev, "failed to find firmware (%d)\n",
1062                                    err);
1063                         goto out;
1064                 }
1065
1066                 lbs_deb_spi("Initializing FW for Marvell WLAN 802.11 adapter "
1067                                 "(chip_id = 0x%04x, chip_rev = 0x%02x) "
1068                                 "attached to SPI bus_num %d, chip_select %d. "
1069                                 "spi->max_speed_hz=%d\n",
1070                                 card->card_id, card->card_rev,
1071                                 card->spi->master->bus_num,
1072                                 card->spi->chip_select,
1073                                 card->spi->max_speed_hz);
1074                 err = if_spi_prog_helper_firmware(card, helper);
1075                 if (err)
1076                         goto out;
1077                 err = if_spi_prog_main_firmware(card, mainfw);
1078                 if (err)
1079                         goto out;
1080                 lbs_deb_spi("loaded FW for Marvell WLAN 802.11 adapter\n");
1081         }
1082
1083         err = spu_set_interrupt_mode(card, 0, 1);
1084         if (err)
1085                 goto out;
1086
1087 out:
1088         lbs_deb_leave_args(LBS_DEB_SPI, "err %d\n", err);
1089         return err;
1090 }
1091
1092 static void if_spi_resume_worker(struct work_struct *work)
1093 {
1094         struct if_spi_card *card;
1095
1096         card = container_of(work, struct if_spi_card, resume_work);
1097
1098         if (card->suspended) {
1099                 if (card->pdata->setup)
1100                         card->pdata->setup(card->spi);
1101
1102                 /* Init card ... */
1103                 if_spi_init_card(card);
1104
1105                 enable_irq(card->spi->irq);
1106
1107                 /* And resume it ... */
1108                 lbs_resume(card->priv);
1109
1110                 card->suspended = 0;
1111         }
1112 }
1113
1114 static int if_spi_probe(struct spi_device *spi)
1115 {
1116         struct if_spi_card *card;
1117         struct lbs_private *priv = NULL;
1118         struct libertas_spi_platform_data *pdata = dev_get_platdata(&spi->dev);
1119         int err = 0;
1120
1121         lbs_deb_enter(LBS_DEB_SPI);
1122
1123         if (!pdata) {
1124                 err = -EINVAL;
1125                 goto out;
1126         }
1127
1128         if (pdata->setup) {
1129                 err = pdata->setup(spi);
1130                 if (err)
1131                         goto out;
1132         }
1133
1134         /* Allocate card structure to represent this specific device */
1135         card = kzalloc(sizeof(struct if_spi_card), GFP_KERNEL);
1136         if (!card) {
1137                 err = -ENOMEM;
1138                 goto teardown;
1139         }
1140         spi_set_drvdata(spi, card);
1141         card->pdata = pdata;
1142         card->spi = spi;
1143         card->prev_xfer_time = jiffies;
1144
1145         INIT_LIST_HEAD(&card->cmd_packet_list);
1146         INIT_LIST_HEAD(&card->data_packet_list);
1147         spin_lock_init(&card->buffer_lock);
1148
1149         /* Initialize the SPI Interface Unit */
1150
1151         /* Firmware load */
1152         err = if_spi_init_card(card);
1153         if (err)
1154                 goto free_card;
1155
1156         /*
1157          * Register our card with libertas.
1158          * This will call alloc_etherdev.
1159          */
1160         priv = lbs_add_card(card, &spi->dev);
1161         if (!priv) {
1162                 err = -ENOMEM;
1163                 goto free_card;
1164         }
1165         card->priv = priv;
1166         priv->setup_fw_on_resume = 1;
1167         priv->card = card;
1168         priv->hw_host_to_card = if_spi_host_to_card;
1169         priv->enter_deep_sleep = NULL;
1170         priv->exit_deep_sleep = NULL;
1171         priv->reset_deep_sleep_wakeup = NULL;
1172         priv->fw_ready = 1;
1173
1174         /* Initialize interrupt handling stuff. */
1175         card->workqueue = alloc_workqueue("libertas_spi", WQ_MEM_RECLAIM, 0);
1176         if (!card->workqueue) {
1177                 err = -ENOMEM;
1178                 goto remove_card;
1179         }
1180         INIT_WORK(&card->packet_work, if_spi_host_to_card_worker);
1181         INIT_WORK(&card->resume_work, if_spi_resume_worker);
1182
1183         err = request_irq(spi->irq, if_spi_host_interrupt,
1184                         IRQF_TRIGGER_FALLING, "libertas_spi", card);
1185         if (err) {
1186                 pr_err("can't get host irq line-- request_irq failed\n");
1187                 goto terminate_workqueue;
1188         }
1189
1190         /*
1191          * Start the card.
1192          * This will call register_netdev, and we'll start
1193          * getting interrupts...
1194          */
1195         err = lbs_start_card(priv);
1196         if (err)
1197                 goto release_irq;
1198
1199         lbs_deb_spi("Finished initializing WLAN module.\n");
1200
1201         /* successful exit */
1202         goto out;
1203
1204 release_irq:
1205         free_irq(spi->irq, card);
1206 terminate_workqueue:
1207         destroy_workqueue(card->workqueue);
1208 remove_card:
1209         lbs_remove_card(priv); /* will call free_netdev */
1210 free_card:
1211         free_if_spi_card(card);
1212 teardown:
1213         if (pdata->teardown)
1214                 pdata->teardown(spi);
1215 out:
1216         lbs_deb_leave_args(LBS_DEB_SPI, "err %d\n", err);
1217         return err;
1218 }
1219
1220 static int libertas_spi_remove(struct spi_device *spi)
1221 {
1222         struct if_spi_card *card = spi_get_drvdata(spi);
1223         struct lbs_private *priv = card->priv;
1224
1225         lbs_deb_spi("libertas_spi_remove\n");
1226         lbs_deb_enter(LBS_DEB_SPI);
1227
1228         cancel_work_sync(&card->resume_work);
1229
1230         lbs_stop_card(priv);
1231         lbs_remove_card(priv); /* will call free_netdev */
1232
1233         free_irq(spi->irq, card);
1234         destroy_workqueue(card->workqueue);
1235         if (card->pdata->teardown)
1236                 card->pdata->teardown(spi);
1237         free_if_spi_card(card);
1238         lbs_deb_leave(LBS_DEB_SPI);
1239         return 0;
1240 }
1241
1242 static int if_spi_suspend(struct device *dev)
1243 {
1244         struct spi_device *spi = to_spi_device(dev);
1245         struct if_spi_card *card = spi_get_drvdata(spi);
1246
1247         if (!card->suspended) {
1248                 lbs_suspend(card->priv);
1249                 flush_workqueue(card->workqueue);
1250                 disable_irq(spi->irq);
1251
1252                 if (card->pdata->teardown)
1253                         card->pdata->teardown(spi);
1254                 card->suspended = 1;
1255         }
1256
1257         return 0;
1258 }
1259
1260 static int if_spi_resume(struct device *dev)
1261 {
1262         struct spi_device *spi = to_spi_device(dev);
1263         struct if_spi_card *card = spi_get_drvdata(spi);
1264
1265         /* Schedule delayed work */
1266         schedule_work(&card->resume_work);
1267
1268         return 0;
1269 }
1270
1271 static const struct dev_pm_ops if_spi_pm_ops = {
1272         .suspend        = if_spi_suspend,
1273         .resume         = if_spi_resume,
1274 };
1275
1276 static struct spi_driver libertas_spi_driver = {
1277         .probe  = if_spi_probe,
1278         .remove = libertas_spi_remove,
1279         .driver = {
1280                 .name   = "libertas_spi",
1281                 .pm     = &if_spi_pm_ops,
1282         },
1283 };
1284
1285 /*
1286  * Module functions
1287  */
1288
1289 static int __init if_spi_init_module(void)
1290 {
1291         int ret = 0;
1292         lbs_deb_enter(LBS_DEB_SPI);
1293         printk(KERN_INFO "libertas_spi: Libertas SPI driver\n");
1294         ret = spi_register_driver(&libertas_spi_driver);
1295         lbs_deb_leave(LBS_DEB_SPI);
1296         return ret;
1297 }
1298
1299 static void __exit if_spi_exit_module(void)
1300 {
1301         lbs_deb_enter(LBS_DEB_SPI);
1302         spi_unregister_driver(&libertas_spi_driver);
1303         lbs_deb_leave(LBS_DEB_SPI);
1304 }
1305
1306 module_init(if_spi_init_module);
1307 module_exit(if_spi_exit_module);
1308
1309 MODULE_DESCRIPTION("Libertas SPI WLAN Driver");
1310 MODULE_AUTHOR("Andrey Yurovsky <andrey@cozybit.com>, "
1311               "Colin McCabe <colin@cozybit.com>");
1312 MODULE_LICENSE("GPL");
1313 MODULE_ALIAS("spi:libertas_spi");