drivers/net/wireless/libertas/if_cs.c

   1 /*
   2
   3   Driver for the Marvell 8385 based compact flash WLAN cards.
   4
   5   (C) 2007 by Holger Schurig <hs4233@mail.mn-solutions.de>
   6
   7   This program is free software; you can redistribute it and/or modify
   8   it under the terms of the GNU General Public License as published by
   9   the Free Software Foundation; either version 2 of the License, or
  10   (at your option) any later version.
  11
  12   This program is distributed in the hope that it will be useful,
  13   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15   GNU General Public License for more details.
  16
  17   You should have received a copy of the GNU General Public License
  18   along with this program; see the file COPYING.  If not, write to
  19   the Free Software Foundation, Inc., 51 Franklin Steet, Fifth Floor,
  20   Boston, MA 02110-1301, USA.
  21
  22 */
  23
  24 #include <linux/module.h>
  25 #include <linux/delay.h>
  26 #include <linux/moduleparam.h>
  27 #include <linux/firmware.h>
  28 #include <linux/netdevice.h>
  29
  30 #include <pcmcia/cs_types.h>
  31 #include <pcmcia/cs.h>
  32 #include <pcmcia/cistpl.h>
  33 #include <pcmcia/ds.h>
  34
  35 #include <linux/io.h>
  36
  37 #define DRV_NAME "libertas_cs"
  38
  39 #include "decl.h"
  40 #include "defs.h"
  41 #include "dev.h"
  42
  43
  44 /********************************************************************/
  45 /* Module stuff                                                     */
  46 /********************************************************************/
  47
  48 MODULE_AUTHOR("Holger Schurig <hs4233@mail.mn-solutions.de>");
  49 MODULE_DESCRIPTION("Driver for Marvell 83xx compact flash WLAN cards");
  50 MODULE_LICENSE("GPL");
  51
  52
  53
  54 /********************************************************************/
  55 /* Data structures                                                  */
  56 /********************************************************************/
  57
  58 struct if_cs_card {
  59         struct pcmcia_device *p_dev;
  60         wlan_private *priv;
  61         void __iomem *iobase;
  62 };
  63
  64
  65
  66 /********************************************************************/
  67 /* Hardware access                                                  */
  68 /********************************************************************/
  69
  70 /* This define enables wrapper functions which allow you
  71    to dump all register accesses. You normally won't this,
  72    except for development */
  73 /* #define DEBUG_IO */
  74
  75 #ifdef DEBUG_IO
  76 static int debug_output = 0;
  77 #else
  78 /* This way the compiler optimizes the printk's away */
  79 #define debug_output 0
  80 #endif
  81
  82 static inline unsigned int if_cs_read8(struct if_cs_card *card, uint reg)
  83 {
  84         unsigned int val = ioread8(card->iobase + reg);
  85         if (debug_output)
  86                 printk(KERN_INFO "##inb %08x<%02x\n", reg, val);
  87         return val;
  88 }
  89 static inline unsigned int if_cs_read16(struct if_cs_card *card, uint reg)
  90 {
  91         unsigned int val = ioread16(card->iobase + reg);
  92         if (debug_output)
  93                 printk(KERN_INFO "##inw %08x<%04x\n", reg, val);
  94         return val;
  95 }
  96 static inline void if_cs_read16_rep(
  97         struct if_cs_card *card,
  98         uint reg,
  99         void *buf,
 100         unsigned long count)
 101 {
 102         if (debug_output)
 103                 printk(KERN_INFO "##insw %08x<(0x%lx words)\n",
 104                         reg, count);
 105         ioread16_rep(card->iobase + reg, buf, count);
 106 }
 107
 108 static inline void if_cs_write8(struct if_cs_card *card, uint reg, u8 val)
 109 {
 110         if (debug_output)
 111                 printk(KERN_INFO "##outb %08x>%02x\n", reg, val);
 112         iowrite8(val, card->iobase + reg);
 113 }
 114
 115 static inline void if_cs_write16(struct if_cs_card *card, uint reg, u16 val)
 116 {
 117         if (debug_output)
 118                 printk(KERN_INFO "##outw %08x>%04x\n", reg, val);
 119         iowrite16(val, card->iobase + reg);
 120 }
 121
 122 static inline void if_cs_write16_rep(
 123         struct if_cs_card *card,
 124         uint reg,
 125         void *buf,
 126         unsigned long count)
 127 {
 128         if (debug_output)
 129                 printk(KERN_INFO "##outsw %08x>(0x%lx words)\n",
 130                         reg, count);
 131         iowrite16_rep(card->iobase + reg, buf, count);
 132 }
 133
 134
 135 /*
 136  * I know that polling/delaying is frowned upon. However, this procedure
 137  * with polling is needed while downloading the firmware. At this stage,
 138  * the hardware does unfortunately not create any interrupts.
 139  *
 140  * Fortunately, this function is never used once the firmware is in
 141  * the card. :-)
 142  *
 143  * As a reference, see the "Firmware Specification v5.1", page 18
 144  * and 19. I did not follow their suggested timing to the word,
 145  * but this works nice & fast anyway.
 146  */
 147 static int if_cs_poll_while_fw_download(struct if_cs_card *card, uint addr, u8 reg)
 148 {
 149         int i;
 150
 151         for (i = 0; i < 500; i++) {
 152                 u8 val = if_cs_read8(card, addr);
 153                 if (val == reg)
 154                         return i;
 155                 udelay(100);
 156         }
 157         return -ETIME;
 158 }
 159
 160
 161
 162 /* Host control registers and their bit definitions */
 163
 164 #define IF_CS_H_STATUS                  0x00000000
 165 #define IF_CS_H_STATUS_TX_OVER          0x0001
 166 #define IF_CS_H_STATUS_RX_OVER          0x0002
 167 #define IF_CS_H_STATUS_DNLD_OVER        0x0004
 168
 169 #define IF_CS_H_INT_CAUSE               0x00000002
 170 #define IF_CS_H_IC_TX_OVER              0x0001
 171 #define IF_CS_H_IC_RX_OVER              0x0002
 172 #define IF_CS_H_IC_DNLD_OVER            0x0004
 173 #define IF_CS_H_IC_HOST_EVENT           0x0008
 174 #define IF_CS_H_IC_MASK                 0x001f
 175
 176 #define IF_CS_H_INT_MASK                0x00000004
 177 #define IF_CS_H_IM_MASK                 0x001f
 178
 179 #define IF_CS_H_WRITE_LEN               0x00000014
 180
 181 #define IF_CS_H_WRITE                   0x00000016
 182
 183 #define IF_CS_H_CMD_LEN                 0x00000018
 184
 185 #define IF_CS_H_CMD                     0x0000001A
 186
 187 #define IF_CS_C_READ_LEN                0x00000024
 188
 189 #define IF_CS_H_READ                    0x00000010
 190
 191 /* Card control registers and their bit definitions */
 192
 193 #define IF_CS_C_STATUS                  0x00000020
 194 #define IF_CS_C_S_TX_DNLD_RDY           0x0001
 195 #define IF_CS_C_S_RX_UPLD_RDY           0x0002
 196 #define IF_CS_C_S_CMD_DNLD_RDY          0x0004
 197 #define IF_CS_C_S_CMD_UPLD_RDY          0x0008
 198 #define IF_CS_C_S_CARDEVENT             0x0010
 199 #define IF_CS_C_S_MASK                  0x001f
 200 #define IF_CS_C_S_STATUS_MASK           0x7f00
 201 /* The following definitions should be the same as the MRVDRV_ ones */
 202
 203 #if MRVDRV_CMD_DNLD_RDY != IF_CS_C_S_CMD_DNLD_RDY
 204 #error MRVDRV_CMD_DNLD_RDY and IF_CS_C_S_CMD_DNLD_RDY not in sync
 205 #endif
 206 #if MRVDRV_CMD_UPLD_RDY != IF_CS_C_S_CMD_UPLD_RDY
 207 #error MRVDRV_CMD_UPLD_RDY and IF_CS_C_S_CMD_UPLD_RDY not in sync
 208 #endif
 209 #if MRVDRV_CARDEVENT != IF_CS_C_S_CARDEVENT
 210 #error MRVDRV_CARDEVENT and IF_CS_C_S_CARDEVENT not in sync
 211 #endif
 212
 213 #define IF_CS_C_INT_CAUSE               0x00000022
 214 #define IF_CS_C_IC_MASK                 0x001f
 215
 216 #define IF_CS_C_SQ_READ_LOW             0x00000028
 217 #define IF_CS_C_SQ_HELPER_OK            0x10
 218
 219 #define IF_CS_C_CMD_LEN                 0x00000030
 220
 221 #define IF_CS_C_CMD                     0x00000012
 222
 223 #define IF_CS_SCRATCH                   0x0000003F
 224
 225
 226
 227 /********************************************************************/
 228 /* Interrupts                                                       */
 229 /********************************************************************/
 230
 231 static inline void if_cs_enable_ints(struct if_cs_card *card)
 232 {
 233         lbs_deb_enter(LBS_DEB_CS);
 234         if_cs_write16(card, IF_CS_H_INT_MASK, 0);
 235 }
 236
 237 static inline void if_cs_disable_ints(struct if_cs_card *card)
 238 {
 239         lbs_deb_enter(LBS_DEB_CS);
 240         if_cs_write16(card, IF_CS_H_INT_MASK, IF_CS_H_IM_MASK);
 241 }
 242
 243 static irqreturn_t if_cs_interrupt(int irq, void *data)
 244 {
 245         struct if_cs_card *card = (struct if_cs_card *)data;
 246         u16 int_cause;
 247
 248         lbs_deb_enter(LBS_DEB_CS);
 249
 250         int_cause = if_cs_read16(card, IF_CS_C_INT_CAUSE);
 251         if(int_cause == 0x0) {
 252                 /* Not for us */
 253                 return IRQ_NONE;
 254
 255         } else if(int_cause == 0xffff) {
 256                 /* Read in junk, the card has probably been removed */
 257                 card->priv->adapter->surpriseremoved = 1;
 258
 259         } else {
 260                 if(int_cause & IF_CS_H_IC_TX_OVER) {
 261                         card->priv->dnld_sent = DNLD_RES_RECEIVED;
 262                         if (!card->priv->adapter->cur_cmd)
 263                                 wake_up_interruptible(&card->priv->waitq);
 264
 265                         if (card->priv->adapter->connect_status == LIBERTAS_CONNECTED)
 266                                 netif_wake_queue(card->priv->dev);
 267                 }
 268
 269                 /* clear interrupt */
 270                 if_cs_write16(card, IF_CS_C_INT_CAUSE, int_cause & IF_CS_C_IC_MASK);
 271         }
 272
 273         libertas_interrupt(card->priv->dev);
 274
 275         return IRQ_HANDLED;
 276 }
 277
 278
 279
 280
 281 /********************************************************************/
 282 /* I/O                                                              */
 283 /********************************************************************/
 284
 285 /*
 286  * Called from if_cs_host_to_card to send a command to the hardware
 287  */
 288 static int if_cs_send_cmd(wlan_private *priv, u8 *buf, u16 nb)
 289 {
 290         struct if_cs_card *card = (struct if_cs_card *)priv->card;
 291         int ret = -1;
 292         int loops = 0;
 293
 294         lbs_deb_enter(LBS_DEB_CS);
 295
 296         /* Is hardware ready? */
 297         while (1) {
 298                 u16 val = if_cs_read16(card, IF_CS_C_STATUS);
 299                 if (val & IF_CS_C_S_CMD_DNLD_RDY)
 300                         break;
 301                 if (++loops > 100) {
 302                         lbs_pr_err("card not ready for commands\n");
 303                         goto done;
 304                 }
 305                 mdelay(1);
 306         }
 307
 308         if_cs_write16(card, IF_CS_H_CMD_LEN, nb);
 309
 310         if_cs_write16_rep(card, IF_CS_H_CMD, buf, nb / 2);
 311         /* Are we supposed to transfer an odd amount of bytes? */
 312         if (nb & 1)
 313                 if_cs_write8(card, IF_CS_H_CMD, buf[nb-1]);
 314
 315         /* "Assert the download over interrupt command in the Host
 316          * status register" */
 317         if_cs_write16(card, IF_CS_H_STATUS, IF_CS_H_STATUS_DNLD_OVER);
 318
 319         /* "Assert the download over interrupt command in the Card
 320          * interrupt case register" */
 321         if_cs_write16(card, IF_CS_H_INT_CAUSE, IF_CS_H_IC_DNLD_OVER);
 322         ret = 0;
 323
 324 done:
 325         lbs_deb_leave_args(LBS_DEB_CS, "ret %d", ret);
 326         return ret;
 327 }
 328
 329
 330 /*
 331  * Called from if_cs_host_to_card to send a data to the hardware
 332  */
 333 static void if_cs_send_data(wlan_private *priv, u8 *buf, u16 nb)
 334 {
 335         struct if_cs_card *card = (struct if_cs_card *)priv->card;
 336
 337         lbs_deb_enter(LBS_DEB_CS);
 338
 339         if_cs_write16(card, IF_CS_H_WRITE_LEN, nb);
 340
 341         /* write even number of bytes, then odd byte if necessary */
 342         if_cs_write16_rep(card, IF_CS_H_WRITE, buf, nb / 2);
 343         if (nb & 1)
 344                 if_cs_write8(card, IF_CS_H_WRITE, buf[nb-1]);
 345
 346         if_cs_write16(card, IF_CS_H_STATUS, IF_CS_H_STATUS_TX_OVER);
 347         if_cs_write16(card, IF_CS_H_INT_CAUSE, IF_CS_H_STATUS_TX_OVER);
 348
 349         lbs_deb_leave(LBS_DEB_CS);
 350 }
 351
 352
 353 /*
 354  * Get the command result out of the card.
 355  */
 356 static int if_cs_receive_cmdres(wlan_private *priv, u8* data, u32 *len)
 357 {
 358         int ret = -1;
 359         u16 val;
 360
 361         lbs_deb_enter(LBS_DEB_CS);
 362
 363         /* is hardware ready? */
 364         val = if_cs_read16(priv->card, IF_CS_C_STATUS);
 365         if ((val & IF_CS_C_S_CMD_UPLD_RDY) == 0) {
 366                 lbs_pr_err("card not ready for CMD\n");
 367                 goto out;
 368         }
 369
 370         *len = if_cs_read16(priv->card, IF_CS_C_CMD_LEN);
 371         if ((*len == 0) || (*len > MRVDRV_SIZE_OF_CMD_BUFFER)) {
 372                 lbs_pr_err("card cmd buffer has invalid # of bytes (%d)\n", *len);
 373                 goto out;
 374         }
 375
 376         /* read even number of bytes, then odd byte if necessary */
 377         if_cs_read16_rep(priv->card, IF_CS_C_CMD, data, *len/sizeof(u16));
 378         if (*len & 1)
 379                 data[*len-1] = if_cs_read8(priv->card, IF_CS_C_CMD);
 380
 381         ret = 0;
 382 out:
 383         lbs_deb_leave_args(LBS_DEB_CS, "ret %d, len %d", ret, *len);
 384         return ret;
 385 }
 386
 387
 388 static struct sk_buff *if_cs_receive_data(wlan_private *priv)
 389 {
 390         struct sk_buff *skb = NULL;
 391         u16 len;
 392         u8 *data;
 393
 394         lbs_deb_enter(LBS_DEB_CS);
 395
 396         len = if_cs_read16(priv->card, IF_CS_C_READ_LEN);
 397         if (len == 0 || len > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE) {
 398                 lbs_pr_err("card data buffer has invalid # of bytes (%d)\n", len);
 399                 priv->stats.rx_dropped++;
 400                 printk(KERN_INFO "##HS %s:%d TODO\n", __FUNCTION__, __LINE__);
 401                 goto dat_err;
 402         }
 403
 404         //TODO: skb = dev_alloc_skb(len+ETH_FRAME_LEN+MRVDRV_SNAP_HEADER_LEN+EXTRA_LEN);
 405         skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE + 2);
 406         if (!skb)
 407                 goto out;
 408         skb_put(skb, len);
 409         skb_reserve(skb, 2);/* 16 byte align */
 410         data = skb->data;
 411
 412         /* read even number of bytes, then odd byte if necessary */
 413         if_cs_read16_rep(priv->card, IF_CS_H_READ, data, len/sizeof(u16));
 414         if (len & 1)
 415                 data[len-1] = if_cs_read8(priv->card, IF_CS_H_READ);
 416
 417 dat_err:
 418         if_cs_write16(priv->card, IF_CS_H_STATUS, IF_CS_H_STATUS_RX_OVER);
 419         if_cs_write16(priv->card, IF_CS_H_INT_CAUSE, IF_CS_H_IC_RX_OVER);
 420
 421 out:
 422         lbs_deb_leave_args(LBS_DEB_CS, "ret %p", skb);
 423         return skb;
 424 }
 425
 426
 427
 428 /********************************************************************/
 429 /* Firmware                                                         */
 430 /********************************************************************/
 431
 432 /*
 433  * Tries to program the helper firmware.
 434  *
 435  * Return 0 on success
 436  */
 437 static int if_cs_prog_helper(struct if_cs_card *card)
 438 {
 439         int ret = 0;
 440         int sent = 0;
 441         u8  scratch;
 442         const struct firmware *fw;
 443
 444         lbs_deb_enter(LBS_DEB_CS);
 445
 446         scratch = if_cs_read8(card, IF_CS_SCRATCH);
 447
 448         /* "If the value is 0x5a, the firmware is already
 449          * downloaded successfully"
 450          */
 451         if (scratch == 0x5a)
 452                 goto done;
 453
 454         /* "If the value is != 00, it is invalid value of register */
 455         if (scratch != 0x00) {
 456                 ret = -ENODEV;
 457                 goto done;
 458         }
 459
 460         /* TODO: make firmware file configurable */
 461         ret = request_firmware(&fw, "libertas_cs_helper.fw",
 462                 &handle_to_dev(card->p_dev));
 463         if (ret) {
 464                 lbs_pr_err("can't load helper firmware\n");
 465                 ret = -ENODEV;
 466                 goto done;
 467         }
 468         lbs_deb_cs("helper size %td\n", fw->size);
 469
 470         /* "Set the 5 bytes of the helper image to 0" */
 471         /* Not needed, this contains an ARM branch instruction */
 472
 473         for (;;) {
 474                 /* "the number of bytes to send is 256" */
 475                 int count = 256;
 476                 int remain = fw->size - sent;
 477
 478                 if (remain < count)
 479                         count = remain;
 480                 /* printk(KERN_INFO "//HS %d loading %d of %d bytes\n",
 481                         __LINE__, sent, fw->size); */
 482
 483                 /* "write the number of bytes to be sent to the I/O Command
 484                  * write length register" */
 485                 if_cs_write16(card, IF_CS_H_CMD_LEN, count);
 486
 487                 /* "write this to I/O Command port register as 16 bit writes */
 488                 if (count)
 489                         if_cs_write16_rep(card, IF_CS_H_CMD,
 490                                 &fw->data[sent],
 491                                 count >> 1);
 492
 493                 /* "Assert the download over interrupt command in the Host
 494                  * status register" */
 495                 if_cs_write8(card, IF_CS_H_STATUS, IF_CS_H_STATUS_DNLD_OVER);
 496
 497                 /* "Assert the download over interrupt command in the Card
 498                  * interrupt case register" */
 499                 if_cs_write16(card, IF_CS_H_INT_CAUSE, IF_CS_H_IC_DNLD_OVER);
 500
 501                 /* "The host polls the Card Status register ... for 50 ms before
 502                    declaring a failure */
 503                 ret = if_cs_poll_while_fw_download(card, IF_CS_C_STATUS,
 504                         IF_CS_C_S_CMD_DNLD_RDY);
 505                 if (ret < 0) {
 506                         lbs_pr_err("can't download helper at 0x%x, ret %d\n",
 507                                 sent, ret);
 508                         goto done;
 509                 }
 510
 511                 if (count == 0)
 512                         break;
 513
 514                 sent += count;
 515         }
 516
 517         release_firmware(fw);
 518         ret = 0;
 519
 520 done:
 521         lbs_deb_leave_args(LBS_DEB_CS, "ret %d", ret);
 522         return ret;
 523 }
 524
 525
 526 static int if_cs_prog_real(struct if_cs_card *card)
 527 {
 528         const struct firmware *fw;
 529         int ret = 0;
 530         int retry = 0;
 531         int len = 0;
 532         int sent;
 533
 534         lbs_deb_enter(LBS_DEB_CS);
 535
 536         /* TODO: make firmware file configurable */
 537         ret = request_firmware(&fw, "libertas_cs.fw",
 538                 &handle_to_dev(card->p_dev));
 539         if (ret) {
 540                 lbs_pr_err("can't load firmware\n");
 541                 ret = -ENODEV;
 542                 goto done;
 543         }
 544         lbs_deb_cs("fw size %td\n", fw->size);
 545
 546         ret = if_cs_poll_while_fw_download(card, IF_CS_C_SQ_READ_LOW, IF_CS_C_SQ_HELPER_OK);
 547         if (ret < 0) {
 548                 int i;
 549                 lbs_pr_err("helper firmware doesn't answer\n");
 550                 for (i = 0; i < 0x50; i += 2)
 551                         printk(KERN_INFO "## HS %02x: %04x\n",
 552                                 i, if_cs_read16(card, i));
 553                 goto err_release;
 554         }
 555
 556         for (sent = 0; sent < fw->size; sent += len) {
 557                 len = if_cs_read16(card, IF_CS_C_SQ_READ_LOW);
 558                 /* printk(KERN_INFO "//HS %d loading %d of %d bytes\n",
 559                         __LINE__, sent, fw->size); */
 560                 if (len & 1) {
 561                         retry++;
 562                         lbs_pr_info("odd, need to retry this firmware block\n");
 563                 } else {
 564                         retry = 0;
 565                 }
 566
 567                 if (retry > 20) {
 568                         lbs_pr_err("could not download firmware\n");
 569                         ret = -ENODEV;
 570                         goto err_release;
 571                 }
 572                 if (retry) {
 573                         sent -= len;
 574                 }
 575
 576
 577                 if_cs_write16(card, IF_CS_H_CMD_LEN, len);
 578
 579                 if_cs_write16_rep(card, IF_CS_H_CMD,
 580                         &fw->data[sent],
 581                         (len+1) >> 1);
 582                 if_cs_write8(card, IF_CS_H_STATUS, IF_CS_H_STATUS_DNLD_OVER);
 583                 if_cs_write16(card, IF_CS_H_INT_CAUSE, IF_CS_H_IC_DNLD_OVER);
 584
 585                 ret = if_cs_poll_while_fw_download(card, IF_CS_C_STATUS,
 586                         IF_CS_C_S_CMD_DNLD_RDY);
 587                 if (ret < 0) {
 588                         lbs_pr_err("can't download firmware at 0x%x\n", sent);
 589                         goto err_release;
 590                 }
 591         }
 592
 593         ret = if_cs_poll_while_fw_download(card, IF_CS_SCRATCH, 0x5a);
 594         if (ret < 0) {
 595                 lbs_pr_err("firmware download failed\n");
 596                 goto err_release;
 597         }
 598
 599         ret = 0;
 600         goto done;
 601
 602
 603 err_release:
 604         release_firmware(fw);
 605
 606 done:
 607         lbs_deb_leave_args(LBS_DEB_CS, "ret %d", ret);
 608         return ret;
 609 }
 610
 611
 612
 613 /********************************************************************/
 614 /* Callback functions for libertas.ko                               */
 615 /********************************************************************/
 616
 617 /* Send commands or data packets to the card */
 618 static int if_cs_host_to_card(wlan_private *priv, u8 type, u8 *buf, u16 nb)
 619 {
 620         int ret = -1;
 621
 622         lbs_deb_enter_args(LBS_DEB_CS, "type %d, bytes %d", type, nb);
 623
 624         switch (type) {
 625         case MVMS_DAT:
 626                 priv->dnld_sent = DNLD_DATA_SENT;
 627                 if_cs_send_data(priv, buf, nb);
 628                 ret = 0;
 629                 break;
 630         case MVMS_CMD:
 631                 priv->dnld_sent = DNLD_CMD_SENT;
 632                 ret = if_cs_send_cmd(priv, buf, nb);
 633                 break;
 634         default:
 635                 lbs_pr_err("%s: unsupported type %d\n", __FUNCTION__, type);
 636         }
 637
 638         lbs_deb_leave_args(LBS_DEB_CS, "ret %d", ret);
 639         return ret;
 640 }
 641
 642
 643 static int if_cs_get_int_status(wlan_private *priv, u8 *ireg)
 644 {
 645         struct if_cs_card *card = (struct if_cs_card *)priv->card;
 646         //wlan_adapter *adapter = priv->adapter;
 647         int ret = 0;
 648         u16 int_cause;
 649         u8 *cmdbuf;
 650         *ireg = 0;
 651
 652         lbs_deb_enter(LBS_DEB_CS);
 653
 654         if (priv->adapter->surpriseremoved)
 655                 goto out;
 656
 657         int_cause = if_cs_read16(card, IF_CS_C_INT_CAUSE) & IF_CS_C_IC_MASK;
 658         if_cs_write16(card, IF_CS_C_INT_CAUSE, int_cause);
 659
 660         *ireg = if_cs_read16(card, IF_CS_C_STATUS) & IF_CS_C_S_MASK;
 661
 662         if (!*ireg)
 663                 goto sbi_get_int_status_exit;
 664
 665 sbi_get_int_status_exit:
 666
 667         /* is there a data packet for us? */
 668         if (*ireg & IF_CS_C_S_RX_UPLD_RDY) {
 669                 struct sk_buff *skb = if_cs_receive_data(priv);
 670                 libertas_process_rxed_packet(priv, skb);
 671                 *ireg &= ~IF_CS_C_S_RX_UPLD_RDY;
 672         }
 673
 674         if (*ireg & IF_CS_C_S_TX_DNLD_RDY) {
 675                 priv->dnld_sent = DNLD_RES_RECEIVED;
 676         }
 677
 678         /* Card has a command result for us */
 679         if (*ireg & IF_CS_C_S_CMD_UPLD_RDY) {
 680                 spin_lock(&priv->adapter->driver_lock);
 681                 if (!priv->adapter->cur_cmd) {
 682                         cmdbuf = priv->upld_buf;
 683                         priv->adapter->hisregcpy &= ~IF_CS_C_S_RX_UPLD_RDY;
 684                 } else {
 685                         cmdbuf = priv->adapter->cur_cmd->bufvirtualaddr;
 686                 }
 687
 688                 ret = if_cs_receive_cmdres(priv, cmdbuf, &priv->upld_len);
 689                 spin_unlock(&priv->adapter->driver_lock);
 690                 if (ret < 0)
 691                         lbs_pr_err("could not receive cmd from card\n");
 692         }
 693
 694 out:
 695         lbs_deb_leave_args(LBS_DEB_CS, "ret %d, ireg 0x%x, hisregcpy 0x%x", ret, *ireg, priv->adapter->hisregcpy);
 696         return ret;
 697 }
 698
 699
 700 static int if_cs_read_event_cause(wlan_private *priv)
 701 {
 702         lbs_deb_enter(LBS_DEB_CS);
 703
 704         priv->adapter->eventcause = (if_cs_read16(priv->card, IF_CS_C_STATUS) & IF_CS_C_S_STATUS_MASK) >> 5;
 705         if_cs_write16(priv->card, IF_CS_H_INT_CAUSE, IF_CS_H_IC_HOST_EVENT);
 706
 707         return 0;
 708 }
 709
 710
 711
 712 /********************************************************************/
 713 /* Card Services                                                    */
 714 /********************************************************************/
 715
 716 /*
 717  * After a card is removed, if_cs_release() will unregister the
 718  * device, and release the PCMCIA configuration.  If the device is
 719  * still open, this will be postponed until it is closed.
 720  */
 721 static void if_cs_release(struct pcmcia_device *p_dev)
 722 {
 723         struct if_cs_card *card = p_dev->priv;
 724
 725         lbs_deb_enter(LBS_DEB_CS);
 726
 727         pcmcia_disable_device(p_dev);
 728         free_irq(p_dev->irq.AssignedIRQ, card);
 729         if (card->iobase)
 730                 ioport_unmap(card->iobase);
 731
 732         lbs_deb_leave(LBS_DEB_CS);
 733 }
 734
 735
 736 /*
 737  * This creates an "instance" of the driver, allocating local data
 738  * structures for one device.  The device is registered with Card
 739  * Services.
 740  *
 741  * The dev_link structure is initialized, but we don't actually
 742  * configure the card at this point -- we wait until we receive a card
 743  * insertion event.
 744  */
 745 static int if_cs_probe(struct pcmcia_device *p_dev)
 746 {
 747         int ret = -ENOMEM;
 748         wlan_private *priv;
 749         struct if_cs_card *card;
 750         /* CIS parsing */
 751         tuple_t tuple;
 752         cisparse_t parse;
 753         cistpl_cftable_entry_t *cfg = &parse.cftable_entry;
 754         cistpl_io_t *io = &cfg->io;
 755         u_char buf[64];
 756
 757         lbs_deb_enter(LBS_DEB_CS);
 758
 759         card = kzalloc(sizeof(struct if_cs_card), GFP_KERNEL);
 760         if (!card) {
 761                 lbs_pr_err("error in kzalloc\n");
 762                 goto out;
 763         }
 764         card->p_dev = p_dev;
 765         p_dev->priv = card;
 766
 767         p_dev->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING;
 768         p_dev->irq.Handler = NULL;
 769         p_dev->irq.IRQInfo1 = IRQ_INFO2_VALID | IRQ_LEVEL_ID;
 770
 771         p_dev->conf.Attributes = 0;
 772         p_dev->conf.IntType = INT_MEMORY_AND_IO;
 773
 774         tuple.Attributes = 0;
 775         tuple.TupleData = buf;
 776         tuple.TupleDataMax = sizeof(buf);
 777         tuple.TupleOffset = 0;
 778
 779         tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
 780         if ((ret = pcmcia_get_first_tuple(p_dev, &tuple)) != 0 ||
 781             (ret = pcmcia_get_tuple_data(p_dev, &tuple)) != 0 ||
 782             (ret = pcmcia_parse_tuple(p_dev, &tuple, &parse)) != 0)
 783         {
 784                 lbs_pr_err("error in pcmcia_get_first_tuple etc\n");
 785                 goto out1;
 786         }
 787
 788         p_dev->conf.ConfigIndex = cfg->index;
 789
 790         /* Do we need to allocate an interrupt? */
 791         if (cfg->irq.IRQInfo1) {
 792                 p_dev->conf.Attributes |= CONF_ENABLE_IRQ;
 793         }
 794
 795         /* IO window settings */
 796         if (cfg->io.nwin != 1) {
 797                 lbs_pr_err("wrong CIS (check number of IO windows)\n");
 798                 ret = -ENODEV;
 799                 goto out1;
 800         }
 801         p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
 802         p_dev->io.BasePort1 = io->win[0].base;
 803         p_dev->io.NumPorts1 = io->win[0].len;
 804
 805         /* This reserves IO space but doesn't actually enable it */
 806         ret = pcmcia_request_io(p_dev, &p_dev->io);
 807         if (ret) {
 808                 lbs_pr_err("error in pcmcia_request_io\n");
 809                 goto out1;
 810         }
 811
 812         /*
 813          * Allocate an interrupt line.  Note that this does not assign
 814          * a handler to the interrupt, unless the 'Handler' member of
 815          * the irq structure is initialized.
 816          */
 817         if (p_dev->conf.Attributes & CONF_ENABLE_IRQ) {
 818                 ret = pcmcia_request_irq(p_dev, &p_dev->irq);
 819                 if (ret) {
 820                         lbs_pr_err("error in pcmcia_request_irq\n");
 821                         goto out1;
 822                 }
 823         }
 824
 825         /* Initialize io access */
 826         card->iobase = ioport_map(p_dev->io.BasePort1, p_dev->io.NumPorts1);
 827         if (!card->iobase) {
 828                 lbs_pr_err("error in ioport_map\n");
 829                 ret = -EIO;
 830                 goto out1;
 831         }
 832
 833         /*
 834          * This actually configures the PCMCIA socket -- setting up
 835          * the I/O windows and the interrupt mapping, and putting the
 836          * card and host interface into "Memory and IO" mode.
 837          */
 838         ret = pcmcia_request_configuration(p_dev, &p_dev->conf);
 839         if (ret) {
 840                 lbs_pr_err("error in pcmcia_request_configuration\n");
 841                 goto out2;
 842         }
 843
 844         /* Finally, report what we've done */
 845         lbs_deb_cs("irq %d, io 0x%04x-0x%04x\n",
 846                p_dev->irq.AssignedIRQ, p_dev->io.BasePort1,
 847                p_dev->io.BasePort1 + p_dev->io.NumPorts1 - 1);
 848
 849
 850         /* Load the firmware early, before calling into libertas.ko */
 851         ret = if_cs_prog_helper(card);
 852         if (ret == 0)
 853                 ret = if_cs_prog_real(card);
 854         if (ret)
 855                 goto out2;
 856
 857         /* Make this card known to the libertas driver */
 858         priv = libertas_add_card(card, &p_dev->dev);
 859         if (!priv) {
 860                 ret = -ENOMEM;
 861                 goto out2;
 862         }
 863
 864         /* Store pointers to our call-back functions */
 865         card->priv = priv;
 866         priv->card = card;
 867         priv->hw_host_to_card     = if_cs_host_to_card;
 868         priv->hw_get_int_status   = if_cs_get_int_status;
 869         priv->hw_read_event_cause = if_cs_read_event_cause;
 870
 871         priv->adapter->fw_ready = 1;
 872
 873         /* Now actually get the IRQ */
 874         ret = request_irq(p_dev->irq.AssignedIRQ, if_cs_interrupt,
 875                 IRQF_SHARED, DRV_NAME, card);
 876         if (ret) {
 877                 lbs_pr_err("error in request_irq\n");
 878                 goto out3;
 879         }
 880
 881         if_cs_enable_ints(card);
 882
 883         /* And finally bring the card up */
 884         if (libertas_start_card(priv) != 0) {
 885                 lbs_pr_err("could not activate card\n");
 886                 goto out3;
 887         }
 888
 889         ret = 0;
 890         goto out;
 891
 892 out3:
 893         libertas_remove_card(priv);
 894 out2:
 895         ioport_unmap(card->iobase);
 896 out1:
 897         pcmcia_disable_device(p_dev);
 898 out:
 899         lbs_deb_leave_args(LBS_DEB_CS, "ret %d", ret);
 900         return ret;
 901 }
 902
 903
 904 /*
 905  * This deletes a driver "instance".  The device is de-registered with
 906  * Card Services.  If it has been released, all local data structures
 907  * are freed.  Otherwise, the structures will be freed when the device
 908  * is released.
 909  */
 910 static void if_cs_detach(struct pcmcia_device *p_dev)
 911 {
 912         struct if_cs_card *card = p_dev->priv;
 913
 914         lbs_deb_enter(LBS_DEB_CS);
 915
 916         libertas_stop_card(card->priv);
 917         libertas_remove_card(card->priv);
 918         if_cs_disable_ints(card);
 919         if_cs_release(p_dev);
 920         kfree(card);
 921
 922         lbs_deb_leave(LBS_DEB_CS);
 923 }
 924
 925
 926
 927 /********************************************************************/
 928 /* Module initialization                                            */
 929 /********************************************************************/
 930
 931 static struct pcmcia_device_id if_cs_ids[] = {
 932         PCMCIA_DEVICE_MANF_CARD(0x02df, 0x8103),
 933         PCMCIA_DEVICE_NULL,
 934 };
 935 MODULE_DEVICE_TABLE(pcmcia, if_cs_ids);
 936
 937
 938 static struct pcmcia_driver libertas_driver = {
 939         .owner          = THIS_MODULE,
 940         .drv            = {
 941                 .name   = DRV_NAME,
 942         },
 943         .probe          = if_cs_probe,
 944         .remove         = if_cs_detach,
 945         .id_table       = if_cs_ids,
 946 };
 947
 948
 949 static int __init if_cs_init(void)
 950 {
 951         int ret;
 952
 953         lbs_deb_enter(LBS_DEB_CS);
 954         ret = pcmcia_register_driver(&libertas_driver);
 955         lbs_deb_leave(LBS_DEB_CS);
 956         return ret;
 957 }
 958
 959
 960 static void __exit if_cs_exit(void)
 961 {
 962         lbs_deb_enter(LBS_DEB_CS);
 963         pcmcia_unregister_driver(&libertas_driver);
 964         lbs_deb_leave(LBS_DEB_CS);
 965 }
 966
 967
 968 module_init(if_cs_init);
 969 module_exit(if_cs_exit);