drivers/net/wireless/orinoco/hermes.c

   1 /* hermes.c
   2  *
   3  * Driver core for the "Hermes" wireless MAC controller, as used in
   4  * the Lucent Orinoco and Cabletron RoamAbout cards. It should also
   5  * work on the hfa3841 and hfa3842 MAC controller chips used in the
   6  * Prism II chipsets.
   7  *
   8  * This is not a complete driver, just low-level access routines for
   9  * the MAC controller itself.
  10  *
  11  * Based on the prism2 driver from Absolute Value Systems' linux-wlan
  12  * project, the Linux wvlan_cs driver, Lucent's HCF-Light
  13  * (wvlan_hcf.c) library, and the NetBSD wireless driver (in no
  14  * particular order).
  15  *
  16  * Copyright (C) 2000, David Gibson, Linuxcare Australia.
  17  * (C) Copyright David Gibson, IBM Corp. 2001-2003.
  18  *
  19  * The contents of this file are subject to the Mozilla Public License
  20  * Version 1.1 (the "License"); you may not use this file except in
  21  * compliance with the License. You may obtain a copy of the License
  22  * at http://www.mozilla.org/MPL/
  23  *
  24  * Software distributed under the License is distributed on an "AS IS"
  25  * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
  26  * the License for the specific language governing rights and
  27  * limitations under the License.
  28  *
  29  * Alternatively, the contents of this file may be used under the
  30  * terms of the GNU General Public License version 2 (the "GPL"), in
  31  * which case the provisions of the GPL are applicable instead of the
  32  * above.  If you wish to allow the use of your version of this file
  33  * only under the terms of the GPL and not to allow others to use your
  34  * version of this file under the MPL, indicate your decision by
  35  * deleting the provisions above and replace them with the notice and
  36  * other provisions required by the GPL.  If you do not delete the
  37  * provisions above, a recipient may use your version of this file
  38  * under either the MPL or the GPL.
  39  */
  40
  41 #include <linux/module.h>
  42 #include <linux/kernel.h>
  43 #include <linux/init.h>
  44 #include <linux/delay.h>
  45
  46 #include "hermes.h"
  47
  48 /* These are maximum timeouts. Most often, card wil react much faster */
  49 #define CMD_BUSY_TIMEOUT (100) /* In iterations of ~1us */
  50 #define CMD_INIT_TIMEOUT (50000) /* in iterations of ~10us */
  51 #define CMD_COMPL_TIMEOUT (20000) /* in iterations of ~10us */
  52 #define ALLOC_COMPL_TIMEOUT (1000) /* in iterations of ~10us */
  53
  54 /*
  55  * Debugging helpers
  56  */
  57
  58 #define DMSG(stuff...) do {printk(KERN_DEBUG "hermes @ %p: " , hw->iobase); \
  59                         printk(stuff); } while (0)
  60
  61 #undef HERMES_DEBUG
  62 #ifdef HERMES_DEBUG
  63 #include <stdarg.h>
  64
  65 #define DEBUG(lvl, stuff...) if ((lvl) <= HERMES_DEBUG) DMSG(stuff)
  66
  67 #else /* ! HERMES_DEBUG */
  68
  69 #define DEBUG(lvl, stuff...) do { } while (0)
  70
  71 #endif /* ! HERMES_DEBUG */
  72
  73 static const struct hermes_ops hermes_ops_local;
  74
  75 /*
  76  * Internal functions
  77  */
  78
  79 /* Issue a command to the chip. Waiting for it to complete is the caller's
  80    problem.
  81
  82    Returns -EBUSY if the command register is busy, 0 on success.
  83
  84    Callable from any context.
  85 */
  86 static int hermes_issue_cmd(hermes_t *hw, u16 cmd, u16 param0,
  87                             u16 param1, u16 param2)
  88 {
  89         int k = CMD_BUSY_TIMEOUT;
  90         u16 reg;
  91
  92         /* First wait for the command register to unbusy */
  93         reg = hermes_read_regn(hw, CMD);
  94         while ((reg & HERMES_CMD_BUSY) && k) {
  95                 k--;
  96                 udelay(1);
  97                 reg = hermes_read_regn(hw, CMD);
  98         }
  99         if (reg & HERMES_CMD_BUSY)
 100                 return -EBUSY;
 101
 102         hermes_write_regn(hw, PARAM2, param2);
 103         hermes_write_regn(hw, PARAM1, param1);
 104         hermes_write_regn(hw, PARAM0, param0);
 105         hermes_write_regn(hw, CMD, cmd);
 106
 107         return 0;
 108 }
 109
 110 /*
 111  * Function definitions
 112  */
 113
 114 /* For doing cmds that wipe the magic constant in SWSUPPORT0 */
 115 static int hermes_doicmd_wait(hermes_t *hw, u16 cmd,
 116                               u16 parm0, u16 parm1, u16 parm2,
 117                               struct hermes_response *resp)
 118 {
 119         int err = 0;
 120         int k;
 121         u16 status, reg;
 122
 123         err = hermes_issue_cmd(hw, cmd, parm0, parm1, parm2);
 124         if (err)
 125                 return err;
 126
 127         reg = hermes_read_regn(hw, EVSTAT);
 128         k = CMD_INIT_TIMEOUT;
 129         while ((!(reg & HERMES_EV_CMD)) && k) {
 130                 k--;
 131                 udelay(10);
 132                 reg = hermes_read_regn(hw, EVSTAT);
 133         }
 134
 135         hermes_write_regn(hw, SWSUPPORT0, HERMES_MAGIC);
 136
 137         if (!hermes_present(hw)) {
 138                 DEBUG(0, "hermes @ 0x%x: Card removed during reset.\n",
 139                        hw->iobase);
 140                 err = -ENODEV;
 141                 goto out;
 142         }
 143
 144         if (!(reg & HERMES_EV_CMD)) {
 145                 printk(KERN_ERR "hermes @ %p: "
 146                        "Timeout waiting for card to reset (reg=0x%04x)!\n",
 147                        hw->iobase, reg);
 148                 err = -ETIMEDOUT;
 149                 goto out;
 150         }
 151
 152         status = hermes_read_regn(hw, STATUS);
 153         if (resp) {
 154                 resp->status = status;
 155                 resp->resp0 = hermes_read_regn(hw, RESP0);
 156                 resp->resp1 = hermes_read_regn(hw, RESP1);
 157                 resp->resp2 = hermes_read_regn(hw, RESP2);
 158         }
 159
 160         hermes_write_regn(hw, EVACK, HERMES_EV_CMD);
 161
 162         if (status & HERMES_STATUS_RESULT)
 163                 err = -EIO;
 164 out:
 165         return err;
 166 }
 167
 168 void hermes_struct_init(hermes_t *hw, void __iomem *address, int reg_spacing)
 169 {
 170         hw->iobase = address;
 171         hw->reg_spacing = reg_spacing;
 172         hw->inten = 0x0;
 173         hw->ops = &hermes_ops_local;
 174 }
 175 EXPORT_SYMBOL(hermes_struct_init);
 176
 177 static int hermes_init(hermes_t *hw)
 178 {
 179         u16 reg;
 180         int err = 0;
 181         int k;
 182
 183         /* We don't want to be interrupted while resetting the chipset */
 184         hw->inten = 0x0;
 185         hermes_write_regn(hw, INTEN, 0);
 186         hermes_write_regn(hw, EVACK, 0xffff);
 187
 188         /* Normally it's a "can't happen" for the command register to
 189            be busy when we go to issue a command because we are
 190            serializing all commands.  However we want to have some
 191            chance of resetting the card even if it gets into a stupid
 192            state, so we actually wait to see if the command register
 193            will unbusy itself here. */
 194         k = CMD_BUSY_TIMEOUT;
 195         reg = hermes_read_regn(hw, CMD);
 196         while (k && (reg & HERMES_CMD_BUSY)) {
 197                 if (reg == 0xffff) /* Special case - the card has probably been
 198                                       removed, so don't wait for the timeout */
 199                         return -ENODEV;
 200
 201                 k--;
 202                 udelay(1);
 203                 reg = hermes_read_regn(hw, CMD);
 204         }
 205
 206         /* No need to explicitly handle the timeout - if we've timed
 207            out hermes_issue_cmd() will probably return -EBUSY below */
 208
 209         /* According to the documentation, EVSTAT may contain
 210            obsolete event occurrence information.  We have to acknowledge
 211            it by writing EVACK. */
 212         reg = hermes_read_regn(hw, EVSTAT);
 213         hermes_write_regn(hw, EVACK, reg);
 214
 215         /* We don't use hermes_docmd_wait here, because the reset wipes
 216            the magic constant in SWSUPPORT0 away, and it gets confused */
 217         err = hermes_doicmd_wait(hw, HERMES_CMD_INIT, 0, 0, 0, NULL);
 218
 219         return err;
 220 }
 221
 222 /* Issue a command to the chip, and (busy!) wait for it to
 223  * complete.
 224  *
 225  * Returns:
 226  *     < 0 on internal error
 227  *       0 on success
 228  *     > 0 on error returned by the firmware
 229  *
 230  * Callable from any context, but locking is your problem. */
 231 static int hermes_docmd_wait(hermes_t *hw, u16 cmd, u16 parm0,
 232                              struct hermes_response *resp)
 233 {
 234         int err;
 235         int k;
 236         u16 reg;
 237         u16 status;
 238
 239         err = hermes_issue_cmd(hw, cmd, parm0, 0, 0);
 240         if (err) {
 241                 if (!hermes_present(hw)) {
 242                         if (net_ratelimit())
 243                                 printk(KERN_WARNING "hermes @ %p: "
 244                                        "Card removed while issuing command "
 245                                        "0x%04x.\n", hw->iobase, cmd);
 246                         err = -ENODEV;
 247                 } else
 248                         if (net_ratelimit())
 249                                 printk(KERN_ERR "hermes @ %p: "
 250                                        "Error %d issuing command 0x%04x.\n",
 251                                        hw->iobase, err, cmd);
 252                 goto out;
 253         }
 254
 255         reg = hermes_read_regn(hw, EVSTAT);
 256         k = CMD_COMPL_TIMEOUT;
 257         while ((!(reg & HERMES_EV_CMD)) && k) {
 258                 k--;
 259                 udelay(10);
 260                 reg = hermes_read_regn(hw, EVSTAT);
 261         }
 262
 263         if (!hermes_present(hw)) {
 264                 printk(KERN_WARNING "hermes @ %p: Card removed "
 265                        "while waiting for command 0x%04x completion.\n",
 266                        hw->iobase, cmd);
 267                 err = -ENODEV;
 268                 goto out;
 269         }
 270
 271         if (!(reg & HERMES_EV_CMD)) {
 272                 printk(KERN_ERR "hermes @ %p: Timeout waiting for "
 273                        "command 0x%04x completion.\n", hw->iobase, cmd);
 274                 err = -ETIMEDOUT;
 275                 goto out;
 276         }
 277
 278         status = hermes_read_regn(hw, STATUS);
 279         if (resp) {
 280                 resp->status = status;
 281                 resp->resp0 = hermes_read_regn(hw, RESP0);
 282                 resp->resp1 = hermes_read_regn(hw, RESP1);
 283                 resp->resp2 = hermes_read_regn(hw, RESP2);
 284         }
 285
 286         hermes_write_regn(hw, EVACK, HERMES_EV_CMD);
 287
 288         if (status & HERMES_STATUS_RESULT)
 289                 err = -EIO;
 290
 291  out:
 292         return err;
 293 }
 294
 295 static int hermes_allocate(hermes_t *hw, u16 size, u16 *fid)
 296 {
 297         int err = 0;
 298         int k;
 299         u16 reg;
 300
 301         if ((size < HERMES_ALLOC_LEN_MIN) || (size > HERMES_ALLOC_LEN_MAX))
 302                 return -EINVAL;
 303
 304         err = hermes_docmd_wait(hw, HERMES_CMD_ALLOC, size, NULL);
 305         if (err)
 306                 return err;
 307
 308         reg = hermes_read_regn(hw, EVSTAT);
 309         k = ALLOC_COMPL_TIMEOUT;
 310         while ((!(reg & HERMES_EV_ALLOC)) && k) {
 311                 k--;
 312                 udelay(10);
 313                 reg = hermes_read_regn(hw, EVSTAT);
 314         }
 315
 316         if (!hermes_present(hw)) {
 317                 printk(KERN_WARNING "hermes @ %p: "
 318                        "Card removed waiting for frame allocation.\n",
 319                        hw->iobase);
 320                 return -ENODEV;
 321         }
 322
 323         if (!(reg & HERMES_EV_ALLOC)) {
 324                 printk(KERN_ERR "hermes @ %p: "
 325                        "Timeout waiting for frame allocation\n",
 326                        hw->iobase);
 327                 return -ETIMEDOUT;
 328         }
 329
 330         *fid = hermes_read_regn(hw, ALLOCFID);
 331         hermes_write_regn(hw, EVACK, HERMES_EV_ALLOC);
 332
 333         return 0;
 334 }
 335
 336 /* Set up a BAP to read a particular chunk of data from card's internal buffer.
 337  *
 338  * Returns:
 339  *     < 0 on internal failure (errno)
 340  *       0 on success
 341  *     > 0 on error
 342  * from firmware
 343  *
 344  * Callable from any context */
 345 static int hermes_bap_seek(hermes_t *hw, int bap, u16 id, u16 offset)
 346 {
 347         int sreg = bap ? HERMES_SELECT1 : HERMES_SELECT0;
 348         int oreg = bap ? HERMES_OFFSET1 : HERMES_OFFSET0;
 349         int k;
 350         u16 reg;
 351
 352         /* Paranoia.. */
 353         if ((offset > HERMES_BAP_OFFSET_MAX) || (offset % 2))
 354                 return -EINVAL;
 355
 356         k = HERMES_BAP_BUSY_TIMEOUT;
 357         reg = hermes_read_reg(hw, oreg);
 358         while ((reg & HERMES_OFFSET_BUSY) && k) {
 359                 k--;
 360                 udelay(1);
 361                 reg = hermes_read_reg(hw, oreg);
 362         }
 363
 364         if (reg & HERMES_OFFSET_BUSY)
 365                 return -ETIMEDOUT;
 366
 367         /* Now we actually set up the transfer */
 368         hermes_write_reg(hw, sreg, id);
 369         hermes_write_reg(hw, oreg, offset);
 370
 371         /* Wait for the BAP to be ready */
 372         k = HERMES_BAP_BUSY_TIMEOUT;
 373         reg = hermes_read_reg(hw, oreg);
 374         while ((reg & (HERMES_OFFSET_BUSY | HERMES_OFFSET_ERR)) && k) {
 375                 k--;
 376                 udelay(1);
 377                 reg = hermes_read_reg(hw, oreg);
 378         }
 379
 380         if (reg != offset) {
 381                 printk(KERN_ERR "hermes @ %p: BAP%d offset %s: "
 382                        "reg=0x%x id=0x%x offset=0x%x\n", hw->iobase, bap,
 383                        (reg & HERMES_OFFSET_BUSY) ? "timeout" : "error",
 384                        reg, id, offset);
 385
 386                 if (reg & HERMES_OFFSET_BUSY)
 387                         return -ETIMEDOUT;
 388
 389                 return -EIO;            /* error or wrong offset */
 390         }
 391
 392         return 0;
 393 }
 394
 395 /* Read a block of data from the chip's buffer, via the
 396  * BAP. Synchronization/serialization is the caller's problem.  len
 397  * must be even.
 398  *
 399  * Returns:
 400  *     < 0 on internal failure (errno)
 401  *       0 on success
 402  *     > 0 on error from firmware
 403  */
 404 static int hermes_bap_pread(hermes_t *hw, int bap, void *buf, int len,
 405                             u16 id, u16 offset)
 406 {
 407         int dreg = bap ? HERMES_DATA1 : HERMES_DATA0;
 408         int err = 0;
 409
 410         if ((len < 0) || (len % 2))
 411                 return -EINVAL;
 412
 413         err = hermes_bap_seek(hw, bap, id, offset);
 414         if (err)
 415                 goto out;
 416
 417         /* Actually do the transfer */
 418         hermes_read_words(hw, dreg, buf, len/2);
 419
 420  out:
 421         return err;
 422 }
 423
 424 /* Write a block of data to the chip's buffer, via the
 425  * BAP. Synchronization/serialization is the caller's problem.
 426  *
 427  * Returns:
 428  *     < 0 on internal failure (errno)
 429  *       0 on success
 430  *     > 0 on error from firmware
 431  */
 432 static int hermes_bap_pwrite(hermes_t *hw, int bap, const void *buf, int len,
 433                              u16 id, u16 offset)
 434 {
 435         int dreg = bap ? HERMES_DATA1 : HERMES_DATA0;
 436         int err = 0;
 437
 438         if (len < 0)
 439                 return -EINVAL;
 440
 441         err = hermes_bap_seek(hw, bap, id, offset);
 442         if (err)
 443                 goto out;
 444
 445         /* Actually do the transfer */
 446         hermes_write_bytes(hw, dreg, buf, len);
 447
 448  out:
 449         return err;
 450 }
 451
 452 /* Read a Length-Type-Value record from the card.
 453  *
 454  * If length is NULL, we ignore the length read from the card, and
 455  * read the entire buffer regardless. This is useful because some of
 456  * the configuration records appear to have incorrect lengths in
 457  * practice.
 458  *
 459  * Callable from user or bh context.  */
 460 static int hermes_read_ltv(hermes_t *hw, int bap, u16 rid, unsigned bufsize,
 461                            u16 *length, void *buf)
 462 {
 463         int err = 0;
 464         int dreg = bap ? HERMES_DATA1 : HERMES_DATA0;
 465         u16 rlength, rtype;
 466         unsigned nwords;
 467
 468         if (bufsize % 2)
 469                 return -EINVAL;
 470
 471         err = hermes_docmd_wait(hw, HERMES_CMD_ACCESS, rid, NULL);
 472         if (err)
 473                 return err;
 474
 475         err = hermes_bap_seek(hw, bap, rid, 0);
 476         if (err)
 477                 return err;
 478
 479         rlength = hermes_read_reg(hw, dreg);
 480
 481         if (!rlength)
 482                 return -ENODATA;
 483
 484         rtype = hermes_read_reg(hw, dreg);
 485
 486         if (length)
 487                 *length = rlength;
 488
 489         if (rtype != rid)
 490                 printk(KERN_WARNING "hermes @ %p: %s(): "
 491                        "rid (0x%04x) does not match type (0x%04x)\n",
 492                        hw->iobase, __func__, rid, rtype);
 493         if (HERMES_RECLEN_TO_BYTES(rlength) > bufsize)
 494                 printk(KERN_WARNING "hermes @ %p: "
 495                        "Truncating LTV record from %d to %d bytes. "
 496                        "(rid=0x%04x, len=0x%04x)\n", hw->iobase,
 497                        HERMES_RECLEN_TO_BYTES(rlength), bufsize, rid, rlength);
 498
 499         nwords = min((unsigned)rlength - 1, bufsize / 2);
 500         hermes_read_words(hw, dreg, buf, nwords);
 501
 502         return 0;
 503 }
 504
 505 static int hermes_write_ltv(hermes_t *hw, int bap, u16 rid,
 506                             u16 length, const void *value)
 507 {
 508         int dreg = bap ? HERMES_DATA1 : HERMES_DATA0;
 509         int err = 0;
 510         unsigned count;
 511
 512         if (length == 0)
 513                 return -EINVAL;
 514
 515         err = hermes_bap_seek(hw, bap, rid, 0);
 516         if (err)
 517                 return err;
 518
 519         hermes_write_reg(hw, dreg, length);
 520         hermes_write_reg(hw, dreg, rid);
 521
 522         count = length - 1;
 523
 524         hermes_write_bytes(hw, dreg, value, count << 1);
 525
 526         err = hermes_docmd_wait(hw, HERMES_CMD_ACCESS | HERMES_CMD_WRITE,
 527                                 rid, NULL);
 528
 529         return err;
 530 }
 531
 532 static void hermes_lock_irqsave(spinlock_t *lock,
 533                                 unsigned long *flags) __acquires(lock)
 534 {
 535         spin_lock_irqsave(lock, *flags);
 536 }
 537
 538 static void hermes_unlock_irqrestore(spinlock_t *lock,
 539                                      unsigned long *flags) __releases(lock)
 540 {
 541         spin_unlock_irqrestore(lock, *flags);
 542 }
 543
 544 static void hermes_lock_irq(spinlock_t *lock) __acquires(lock)
 545 {
 546         spin_lock_irq(lock);
 547 }
 548
 549 static void hermes_unlock_irq(spinlock_t *lock) __releases(lock)
 550 {
 551         spin_unlock_irq(lock);
 552 }
 553
 554 /* Hermes operations for local buses */
 555 static const struct hermes_ops hermes_ops_local = {
 556         .init = hermes_init,
 557         .cmd_wait = hermes_docmd_wait,
 558         .init_cmd_wait = hermes_doicmd_wait,
 559         .allocate = hermes_allocate,
 560         .read_ltv = hermes_read_ltv,
 561         .write_ltv = hermes_write_ltv,
 562         .bap_pread = hermes_bap_pread,
 563         .bap_pwrite = hermes_bap_pwrite,
 564         .lock_irqsave = hermes_lock_irqsave,
 565         .unlock_irqrestore = hermes_unlock_irqrestore,
 566         .lock_irq = hermes_lock_irq,
 567         .unlock_irq = hermes_unlock_irq,
 568 };