git.oblomov.eu Git - linux-2.6/blob - 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 MODULE_DESCRIPTION("Low-level driver helper for Lucent Hermes chipset"
  49                    " and Prism II HFA384x wireless MAC controller");
  50 MODULE_AUTHOR("Pavel Roskin <proski@gnu.org>"
  51         " & David Gibson <hermes@gibson.dropbear.id.au>");
  52 MODULE_LICENSE("Dual MPL/GPL");
  53
  54 /* These are maximum timeouts. Most often, card wil react much faster */
  55 #define CMD_BUSY_TIMEOUT (100) /* In iterations of ~1us */
  56 #define CMD_INIT_TIMEOUT (50000) /* in iterations of ~10us */
  57 #define CMD_COMPL_TIMEOUT (20000) /* in iterations of ~10us */
  58 #define ALLOC_COMPL_TIMEOUT (1000) /* in iterations of ~10us */
  59
  60 /*
  61  * Debugging helpers
  62  */
  63
  64 #define DMSG(stuff...) do {printk(KERN_DEBUG "hermes @ %p: " , hw->iobase); \
  65                         printk(stuff); } while (0)
  66
  67 #undef HERMES_DEBUG
  68 #ifdef HERMES_DEBUG
  69 #include <stdarg.h>
  70
  71 #define DEBUG(lvl, stuff...) if ((lvl) <= HERMES_DEBUG) DMSG(stuff)
  72
  73 #else /* ! HERMES_DEBUG */
  74
  75 #define DEBUG(lvl, stuff...) do { } while (0)
  76
  77 #endif /* ! HERMES_DEBUG */
  78
  79
  80 /*
  81  * Internal functions
  82  */
  83
  84 /* Issue a command to the chip. Waiting for it to complete is the caller's
  85    problem.
  86
  87    Returns -EBUSY if the command register is busy, 0 on success.
  88
  89    Callable from any context.
  90 */
  91 static int hermes_issue_cmd(hermes_t *hw, u16 cmd, u16 param0,
  92                             u16 param1, u16 param2)
  93 {
  94         int k = CMD_BUSY_TIMEOUT;
  95         u16 reg;
  96
  97         /* First wait for the command register to unbusy */
  98         reg = hermes_read_regn(hw, CMD);
  99         while ((reg & HERMES_CMD_BUSY) && k) {
 100                 k--;
 101                 udelay(1);
 102                 reg = hermes_read_regn(hw, CMD);
 103         }
 104         if (reg & HERMES_CMD_BUSY)
 105                 return -EBUSY;
 106
 107         hermes_write_regn(hw, PARAM2, param2);
 108         hermes_write_regn(hw, PARAM1, param1);
 109         hermes_write_regn(hw, PARAM0, param0);
 110         hermes_write_regn(hw, CMD, cmd);
 111
 112         return 0;
 113 }
 114
 115 /*
 116  * Function definitions
 117  */
 118
 119 /* For doing cmds that wipe the magic constant in SWSUPPORT0 */
 120 int hermes_doicmd_wait(hermes_t *hw, u16 cmd,
 121                        u16 parm0, u16 parm1, u16 parm2,
 122                        struct hermes_response *resp)
 123 {
 124         int err = 0;
 125         int k;
 126         u16 status, reg;
 127
 128         err = hermes_issue_cmd(hw, cmd, parm0, parm1, parm2);
 129         if (err)
 130                 return err;
 131
 132         reg = hermes_read_regn(hw, EVSTAT);
 133         k = CMD_INIT_TIMEOUT;
 134         while ((!(reg & HERMES_EV_CMD)) && k) {
 135                 k--;
 136                 udelay(10);
 137                 reg = hermes_read_regn(hw, EVSTAT);
 138         }
 139
 140         hermes_write_regn(hw, SWSUPPORT0, HERMES_MAGIC);
 141
 142         if (!hermes_present(hw)) {
 143                 DEBUG(0, "hermes @ 0x%x: Card removed during reset.\n",
 144                        hw->iobase);
 145                 err = -ENODEV;
 146                 goto out;
 147         }
 148
 149         if (!(reg & HERMES_EV_CMD)) {
 150                 printk(KERN_ERR "hermes @ %p: "
 151                        "Timeout waiting for card to reset (reg=0x%04x)!\n",
 152                        hw->iobase, reg);
 153                 err = -ETIMEDOUT;
 154                 goto out;
 155         }
 156
 157         status = hermes_read_regn(hw, STATUS);
 158         if (resp) {
 159                 resp->status = status;
 160                 resp->resp0 = hermes_read_regn(hw, RESP0);
 161                 resp->resp1 = hermes_read_regn(hw, RESP1);
 162                 resp->resp2 = hermes_read_regn(hw, RESP2);
 163         }
 164
 165         hermes_write_regn(hw, EVACK, HERMES_EV_CMD);
 166
 167         if (status & HERMES_STATUS_RESULT)
 168                 err = -EIO;
 169 out:
 170         return err;
 171 }
 172 EXPORT_SYMBOL(hermes_doicmd_wait);
 173
 174 void hermes_struct_init(hermes_t *hw, void __iomem *address, int reg_spacing)
 175 {
 176         hw->iobase = address;
 177         hw->reg_spacing = reg_spacing;
 178         hw->inten = 0x0;
 179 }
 180 EXPORT_SYMBOL(hermes_struct_init);
 181
 182 int hermes_init(hermes_t *hw)
 183 {
 184         u16 reg;
 185         int err = 0;
 186         int k;
 187
 188         /* We don't want to be interrupted while resetting the chipset */
 189         hw->inten = 0x0;
 190         hermes_write_regn(hw, INTEN, 0);
 191         hermes_write_regn(hw, EVACK, 0xffff);
 192
 193         /* Normally it's a "can't happen" for the command register to
 194            be busy when we go to issue a command because we are
 195            serializing all commands.  However we want to have some
 196            chance of resetting the card even if it gets into a stupid
 197            state, so we actually wait to see if the command register
 198            will unbusy itself here. */
 199         k = CMD_BUSY_TIMEOUT;
 200         reg = hermes_read_regn(hw, CMD);
 201         while (k && (reg & HERMES_CMD_BUSY)) {
 202                 if (reg == 0xffff) /* Special case - the card has probably been
 203                                       removed, so don't wait for the timeout */
 204                         return -ENODEV;
 205
 206                 k--;
 207                 udelay(1);
 208                 reg = hermes_read_regn(hw, CMD);
 209         }
 210
 211         /* No need to explicitly handle the timeout - if we've timed
 212            out hermes_issue_cmd() will probably return -EBUSY below */
 213
 214         /* According to the documentation, EVSTAT may contain
 215            obsolete event occurrence information.  We have to acknowledge
 216            it by writing EVACK. */
 217         reg = hermes_read_regn(hw, EVSTAT);
 218         hermes_write_regn(hw, EVACK, reg);
 219
 220         /* We don't use hermes_docmd_wait here, because the reset wipes
 221            the magic constant in SWSUPPORT0 away, and it gets confused */
 222         err = hermes_doicmd_wait(hw, HERMES_CMD_INIT, 0, 0, 0, NULL);
 223
 224         return err;
 225 }
 226 EXPORT_SYMBOL(hermes_init);
 227
 228 /* Issue a command to the chip, and (busy!) wait for it to
 229  * complete.
 230  *
 231  * Returns:
 232  *     < 0 on internal error
 233  *       0 on success
 234  *     > 0 on error returned by the firmware
 235  *
 236  * Callable from any context, but locking is your problem. */
 237 int hermes_docmd_wait(hermes_t *hw, u16 cmd, u16 parm0,
 238                       struct hermes_response *resp)
 239 {
 240         int err;
 241         int k;
 242         u16 reg;
 243         u16 status;
 244
 245         err = hermes_issue_cmd(hw, cmd, parm0, 0, 0);
 246         if (err) {
 247                 if (!hermes_present(hw)) {
 248                         if (net_ratelimit())
 249                                 printk(KERN_WARNING "hermes @ %p: "
 250                                        "Card removed while issuing command "
 251                                        "0x%04x.\n", hw->iobase, cmd);
 252                         err = -ENODEV;
 253                 } else
 254                         if (net_ratelimit())
 255                                 printk(KERN_ERR "hermes @ %p: "
 256                                        "Error %d issuing command 0x%04x.\n",
 257                                        hw->iobase, err, cmd);
 258                 goto out;
 259         }
 260
 261         reg = hermes_read_regn(hw, EVSTAT);
 262         k = CMD_COMPL_TIMEOUT;
 263         while ((!(reg & HERMES_EV_CMD)) && k) {
 264                 k--;
 265                 udelay(10);
 266                 reg = hermes_read_regn(hw, EVSTAT);
 267         }
 268
 269         if (!hermes_present(hw)) {
 270                 printk(KERN_WARNING "hermes @ %p: Card removed "
 271                        "while waiting for command 0x%04x completion.\n",
 272                        hw->iobase, cmd);
 273                 err = -ENODEV;
 274                 goto out;
 275         }
 276
 277         if (!(reg & HERMES_EV_CMD)) {
 278                 printk(KERN_ERR "hermes @ %p: Timeout waiting for "
 279                        "command 0x%04x completion.\n", hw->iobase, cmd);
 280                 err = -ETIMEDOUT;
 281                 goto out;
 282         }
 283
 284         status = hermes_read_regn(hw, STATUS);
 285         if (resp) {
 286                 resp->status = status;
 287                 resp->resp0 = hermes_read_regn(hw, RESP0);
 288                 resp->resp1 = hermes_read_regn(hw, RESP1);
 289                 resp->resp2 = hermes_read_regn(hw, RESP2);
 290         }
 291
 292         hermes_write_regn(hw, EVACK, HERMES_EV_CMD);
 293
 294         if (status & HERMES_STATUS_RESULT)
 295                 err = -EIO;
 296
 297  out:
 298         return err;
 299 }
 300 EXPORT_SYMBOL(hermes_docmd_wait);
 301
 302 int hermes_allocate(hermes_t *hw, u16 size, u16 *fid)
 303 {
 304         int err = 0;
 305         int k;
 306         u16 reg;
 307
 308         if ((size < HERMES_ALLOC_LEN_MIN) || (size > HERMES_ALLOC_LEN_MAX))
 309                 return -EINVAL;
 310
 311         err = hermes_docmd_wait(hw, HERMES_CMD_ALLOC, size, NULL);
 312         if (err)
 313                 return err;
 314
 315         reg = hermes_read_regn(hw, EVSTAT);
 316         k = ALLOC_COMPL_TIMEOUT;
 317         while ((!(reg & HERMES_EV_ALLOC)) && k) {
 318                 k--;
 319                 udelay(10);
 320                 reg = hermes_read_regn(hw, EVSTAT);
 321         }
 322
 323         if (!hermes_present(hw)) {
 324                 printk(KERN_WARNING "hermes @ %p: "
 325                        "Card removed waiting for frame allocation.\n",
 326                        hw->iobase);
 327                 return -ENODEV;
 328         }
 329
 330         if (!(reg & HERMES_EV_ALLOC)) {
 331                 printk(KERN_ERR "hermes @ %p: "
 332                        "Timeout waiting for frame allocation\n",
 333                        hw->iobase);
 334                 return -ETIMEDOUT;
 335         }
 336
 337         *fid = hermes_read_regn(hw, ALLOCFID);
 338         hermes_write_regn(hw, EVACK, HERMES_EV_ALLOC);
 339
 340         return 0;
 341 }
 342 EXPORT_SYMBOL(hermes_allocate);
 343
 344 /* Set up a BAP to read a particular chunk of data from card's internal buffer.
 345  *
 346  * Returns:
 347  *     < 0 on internal failure (errno)
 348  *       0 on success
 349  *     > 0 on error
 350  * from firmware
 351  *
 352  * Callable from any context */
 353 static int hermes_bap_seek(hermes_t *hw, int bap, u16 id, u16 offset)
 354 {
 355         int sreg = bap ? HERMES_SELECT1 : HERMES_SELECT0;
 356         int oreg = bap ? HERMES_OFFSET1 : HERMES_OFFSET0;
 357         int k;
 358         u16 reg;
 359
 360         /* Paranoia.. */
 361         if ((offset > HERMES_BAP_OFFSET_MAX) || (offset % 2))
 362                 return -EINVAL;
 363
 364         k = HERMES_BAP_BUSY_TIMEOUT;
 365         reg = hermes_read_reg(hw, oreg);
 366         while ((reg & HERMES_OFFSET_BUSY) && k) {
 367                 k--;
 368                 udelay(1);
 369                 reg = hermes_read_reg(hw, oreg);
 370         }
 371
 372         if (reg & HERMES_OFFSET_BUSY)
 373                 return -ETIMEDOUT;
 374
 375         /* Now we actually set up the transfer */
 376         hermes_write_reg(hw, sreg, id);
 377         hermes_write_reg(hw, oreg, offset);
 378
 379         /* Wait for the BAP to be ready */
 380         k = HERMES_BAP_BUSY_TIMEOUT;
 381         reg = hermes_read_reg(hw, oreg);
 382         while ((reg & (HERMES_OFFSET_BUSY | HERMES_OFFSET_ERR)) && k) {
 383                 k--;
 384                 udelay(1);
 385                 reg = hermes_read_reg(hw, oreg);
 386         }
 387
 388         if (reg != offset) {
 389                 printk(KERN_ERR "hermes @ %p: BAP%d offset %s: "
 390                        "reg=0x%x id=0x%x offset=0x%x\n", hw->iobase, bap,
 391                        (reg & HERMES_OFFSET_BUSY) ? "timeout" : "error",
 392                        reg, id, offset);
 393
 394                 if (reg & HERMES_OFFSET_BUSY)
 395                         return -ETIMEDOUT;
 396
 397                 return -EIO;            /* error or wrong offset */
 398         }
 399
 400         return 0;
 401 }
 402
 403 /* Read a block of data from the chip's buffer, via the
 404  * BAP. Synchronization/serialization is the caller's problem.  len
 405  * must be even.
 406  *
 407  * Returns:
 408  *     < 0 on internal failure (errno)
 409  *       0 on success
 410  *     > 0 on error from firmware
 411  */
 412 int hermes_bap_pread(hermes_t *hw, int bap, void *buf, int len,
 413                      u16 id, u16 offset)
 414 {
 415         int dreg = bap ? HERMES_DATA1 : HERMES_DATA0;
 416         int err = 0;
 417
 418         if ((len < 0) || (len % 2))
 419                 return -EINVAL;
 420
 421         err = hermes_bap_seek(hw, bap, id, offset);
 422         if (err)
 423                 goto out;
 424
 425         /* Actually do the transfer */
 426         hermes_read_words(hw, dreg, buf, len/2);
 427
 428  out:
 429         return err;
 430 }
 431 EXPORT_SYMBOL(hermes_bap_pread);
 432
 433 /* Write a block of data to the chip's buffer, via the
 434  * BAP. Synchronization/serialization is the caller's problem.
 435  *
 436  * Returns:
 437  *     < 0 on internal failure (errno)
 438  *       0 on success
 439  *     > 0 on error from firmware
 440  */
 441 int hermes_bap_pwrite(hermes_t *hw, int bap, const void *buf, int len,
 442                       u16 id, u16 offset)
 443 {
 444         int dreg = bap ? HERMES_DATA1 : HERMES_DATA0;
 445         int err = 0;
 446
 447         if (len < 0)
 448                 return -EINVAL;
 449
 450         err = hermes_bap_seek(hw, bap, id, offset);
 451         if (err)
 452                 goto out;
 453
 454         /* Actually do the transfer */
 455         hermes_write_bytes(hw, dreg, buf, len);
 456
 457  out:
 458         return err;
 459 }
 460 EXPORT_SYMBOL(hermes_bap_pwrite);
 461
 462 /* Read a Length-Type-Value record from the card.
 463  *
 464  * If length is NULL, we ignore the length read from the card, and
 465  * read the entire buffer regardless. This is useful because some of
 466  * the configuration records appear to have incorrect lengths in
 467  * practice.
 468  *
 469  * Callable from user or bh context.  */
 470 int hermes_read_ltv(hermes_t *hw, int bap, u16 rid, unsigned bufsize,
 471                     u16 *length, void *buf)
 472 {
 473         int err = 0;
 474         int dreg = bap ? HERMES_DATA1 : HERMES_DATA0;
 475         u16 rlength, rtype;
 476         unsigned nwords;
 477
 478         if ((bufsize < 0) || (bufsize % 2))
 479                 return -EINVAL;
 480
 481         err = hermes_docmd_wait(hw, HERMES_CMD_ACCESS, rid, NULL);
 482         if (err)
 483                 return err;
 484
 485         err = hermes_bap_seek(hw, bap, rid, 0);
 486         if (err)
 487                 return err;
 488
 489         rlength = hermes_read_reg(hw, dreg);
 490
 491         if (!rlength)
 492                 return -ENODATA;
 493
 494         rtype = hermes_read_reg(hw, dreg);
 495
 496         if (length)
 497                 *length = rlength;
 498
 499         if (rtype != rid)
 500                 printk(KERN_WARNING "hermes @ %p: %s(): "
 501                        "rid (0x%04x) does not match type (0x%04x)\n",
 502                        hw->iobase, __func__, rid, rtype);
 503         if (HERMES_RECLEN_TO_BYTES(rlength) > bufsize)
 504                 printk(KERN_WARNING "hermes @ %p: "
 505                        "Truncating LTV record from %d to %d bytes. "
 506                        "(rid=0x%04x, len=0x%04x)\n", hw->iobase,
 507                        HERMES_RECLEN_TO_BYTES(rlength), bufsize, rid, rlength);
 508
 509         nwords = min((unsigned)rlength - 1, bufsize / 2);
 510         hermes_read_words(hw, dreg, buf, nwords);
 511
 512         return 0;
 513 }
 514 EXPORT_SYMBOL(hermes_read_ltv);
 515
 516 int hermes_write_ltv(hermes_t *hw, int bap, u16 rid,
 517                      u16 length, const void *value)
 518 {
 519         int dreg = bap ? HERMES_DATA1 : HERMES_DATA0;
 520         int err = 0;
 521         unsigned count;
 522
 523         if (length == 0)
 524                 return -EINVAL;
 525
 526         err = hermes_bap_seek(hw, bap, rid, 0);
 527         if (err)
 528                 return err;
 529
 530         hermes_write_reg(hw, dreg, length);
 531         hermes_write_reg(hw, dreg, rid);
 532
 533         count = length - 1;
 534
 535         hermes_write_bytes(hw, dreg, value, count << 1);
 536
 537         err = hermes_docmd_wait(hw, HERMES_CMD_ACCESS | HERMES_CMD_WRITE,
 538                                 rid, NULL);
 539
 540         return err;
 541 }
 542 EXPORT_SYMBOL(hermes_write_ltv);
 543
 544 static int __init init_hermes(void)
 545 {
 546         return 0;
 547 }
 548
 549 static void __exit exit_hermes(void)
 550 {
 551 }
 552
 553 module_init(init_hermes);
 554 module_exit(exit_hermes);