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
8 * This is not a complete driver, just low-level access routines for
9 * the MAC controller itself.
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
16 * Copyright (C) 2000, David Gibson, Linuxcare Australia.
17 * (C) Copyright David Gibson, IBM Corp. 2001-2003.
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/
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.
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.
41 #include <linux/module.h>
42 #include <linux/kernel.h>
43 #include <linux/init.h>
44 #include <linux/delay.h>
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 */
55 * AUX port access. To unlock the AUX port write the access keys to the
56 * PARAM0-2 registers, then write HERMES_AUX_ENABLE to the HERMES_CONTROL
57 * register. Then read it and make sure it's HERMES_AUX_ENABLED.
59 #define HERMES_AUX_ENABLE 0x8000 /* Enable auxiliary port access */
60 #define HERMES_AUX_DISABLE 0x4000 /* Disable to auxiliary port access */
61 #define HERMES_AUX_ENABLED 0xC000 /* Auxiliary port is open */
62 #define HERMES_AUX_DISABLED 0x0000 /* Auxiliary port is closed */
64 #define HERMES_AUX_PW0 0xFE01
65 #define HERMES_AUX_PW1 0xDC23
66 #define HERMES_AUX_PW2 0xBA45
68 /* HERMES_CMD_DOWNLD */
69 #define HERMES_PROGRAM_DISABLE (0x0000 | HERMES_CMD_DOWNLD)
70 #define HERMES_PROGRAM_ENABLE_VOLATILE (0x0100 | HERMES_CMD_DOWNLD)
71 #define HERMES_PROGRAM_ENABLE_NON_VOLATILE (0x0200 | HERMES_CMD_DOWNLD)
72 #define HERMES_PROGRAM_NON_VOLATILE (0x0300 | HERMES_CMD_DOWNLD)
78 #define DMSG(stuff...) do {printk(KERN_DEBUG "hermes @ %p: " , hw->iobase); \
79 printk(stuff); } while (0)
85 #define DEBUG(lvl, stuff...) if ((lvl) <= HERMES_DEBUG) DMSG(stuff)
87 #else /* ! HERMES_DEBUG */
89 #define DEBUG(lvl, stuff...) do { } while (0)
91 #endif /* ! HERMES_DEBUG */
93 static const struct hermes_ops hermes_ops_local
;
99 /* Issue a command to the chip. Waiting for it to complete is the caller's
102 Returns -EBUSY if the command register is busy, 0 on success.
104 Callable from any context.
106 static int hermes_issue_cmd(struct hermes
*hw
, u16 cmd
, u16 param0
,
107 u16 param1
, u16 param2
)
109 int k
= CMD_BUSY_TIMEOUT
;
112 /* First wait for the command register to unbusy */
113 reg
= hermes_read_regn(hw
, CMD
);
114 while ((reg
& HERMES_CMD_BUSY
) && k
) {
117 reg
= hermes_read_regn(hw
, CMD
);
119 if (reg
& HERMES_CMD_BUSY
)
122 hermes_write_regn(hw
, PARAM2
, param2
);
123 hermes_write_regn(hw
, PARAM1
, param1
);
124 hermes_write_regn(hw
, PARAM0
, param0
);
125 hermes_write_regn(hw
, CMD
, cmd
);
131 * Function definitions
134 /* For doing cmds that wipe the magic constant in SWSUPPORT0 */
135 static int hermes_doicmd_wait(struct hermes
*hw
, u16 cmd
,
136 u16 parm0
, u16 parm1
, u16 parm2
,
137 struct hermes_response
*resp
)
143 err
= hermes_issue_cmd(hw
, cmd
, parm0
, parm1
, parm2
);
147 reg
= hermes_read_regn(hw
, EVSTAT
);
148 k
= CMD_INIT_TIMEOUT
;
149 while ((!(reg
& HERMES_EV_CMD
)) && k
) {
152 reg
= hermes_read_regn(hw
, EVSTAT
);
155 hermes_write_regn(hw
, SWSUPPORT0
, HERMES_MAGIC
);
157 if (!hermes_present(hw
)) {
158 DEBUG(0, "hermes @ 0x%x: Card removed during reset.\n",
164 if (!(reg
& HERMES_EV_CMD
)) {
165 printk(KERN_ERR
"hermes @ %p: "
166 "Timeout waiting for card to reset (reg=0x%04x)!\n",
172 status
= hermes_read_regn(hw
, STATUS
);
174 resp
->status
= status
;
175 resp
->resp0
= hermes_read_regn(hw
, RESP0
);
176 resp
->resp1
= hermes_read_regn(hw
, RESP1
);
177 resp
->resp2
= hermes_read_regn(hw
, RESP2
);
180 hermes_write_regn(hw
, EVACK
, HERMES_EV_CMD
);
182 if (status
& HERMES_STATUS_RESULT
)
188 void hermes_struct_init(struct hermes
*hw
, void __iomem
*address
,
191 hw
->iobase
= address
;
192 hw
->reg_spacing
= reg_spacing
;
194 hw
->eeprom_pda
= false;
195 hw
->ops
= &hermes_ops_local
;
197 EXPORT_SYMBOL(hermes_struct_init
);
199 static int hermes_init(struct hermes
*hw
)
205 /* We don't want to be interrupted while resetting the chipset */
207 hermes_write_regn(hw
, INTEN
, 0);
208 hermes_write_regn(hw
, EVACK
, 0xffff);
210 /* Normally it's a "can't happen" for the command register to
211 be busy when we go to issue a command because we are
212 serializing all commands. However we want to have some
213 chance of resetting the card even if it gets into a stupid
214 state, so we actually wait to see if the command register
215 will unbusy itself here. */
216 k
= CMD_BUSY_TIMEOUT
;
217 reg
= hermes_read_regn(hw
, CMD
);
218 while (k
&& (reg
& HERMES_CMD_BUSY
)) {
219 if (reg
== 0xffff) /* Special case - the card has probably been
220 removed, so don't wait for the timeout */
225 reg
= hermes_read_regn(hw
, CMD
);
228 /* No need to explicitly handle the timeout - if we've timed
229 out hermes_issue_cmd() will probably return -EBUSY below */
231 /* According to the documentation, EVSTAT may contain
232 obsolete event occurrence information. We have to acknowledge
233 it by writing EVACK. */
234 reg
= hermes_read_regn(hw
, EVSTAT
);
235 hermes_write_regn(hw
, EVACK
, reg
);
237 /* We don't use hermes_docmd_wait here, because the reset wipes
238 the magic constant in SWSUPPORT0 away, and it gets confused */
239 err
= hermes_doicmd_wait(hw
, HERMES_CMD_INIT
, 0, 0, 0, NULL
);
244 /* Issue a command to the chip, and (busy!) wait for it to
248 * < 0 on internal error
250 * > 0 on error returned by the firmware
252 * Callable from any context, but locking is your problem. */
253 static int hermes_docmd_wait(struct hermes
*hw
, u16 cmd
, u16 parm0
,
254 struct hermes_response
*resp
)
261 err
= hermes_issue_cmd(hw
, cmd
, parm0
, 0, 0);
263 if (!hermes_present(hw
)) {
265 printk(KERN_WARNING
"hermes @ %p: "
266 "Card removed while issuing command "
267 "0x%04x.\n", hw
->iobase
, cmd
);
271 printk(KERN_ERR
"hermes @ %p: "
272 "Error %d issuing command 0x%04x.\n",
273 hw
->iobase
, err
, cmd
);
277 reg
= hermes_read_regn(hw
, EVSTAT
);
278 k
= CMD_COMPL_TIMEOUT
;
279 while ((!(reg
& HERMES_EV_CMD
)) && k
) {
282 reg
= hermes_read_regn(hw
, EVSTAT
);
285 if (!hermes_present(hw
)) {
286 printk(KERN_WARNING
"hermes @ %p: Card removed "
287 "while waiting for command 0x%04x completion.\n",
293 if (!(reg
& HERMES_EV_CMD
)) {
294 printk(KERN_ERR
"hermes @ %p: Timeout waiting for "
295 "command 0x%04x completion.\n", hw
->iobase
, cmd
);
300 status
= hermes_read_regn(hw
, STATUS
);
302 resp
->status
= status
;
303 resp
->resp0
= hermes_read_regn(hw
, RESP0
);
304 resp
->resp1
= hermes_read_regn(hw
, RESP1
);
305 resp
->resp2
= hermes_read_regn(hw
, RESP2
);
308 hermes_write_regn(hw
, EVACK
, HERMES_EV_CMD
);
310 if (status
& HERMES_STATUS_RESULT
)
317 static int hermes_allocate(struct hermes
*hw
, u16 size
, u16
*fid
)
323 if ((size
< HERMES_ALLOC_LEN_MIN
) || (size
> HERMES_ALLOC_LEN_MAX
))
326 err
= hermes_docmd_wait(hw
, HERMES_CMD_ALLOC
, size
, NULL
);
330 reg
= hermes_read_regn(hw
, EVSTAT
);
331 k
= ALLOC_COMPL_TIMEOUT
;
332 while ((!(reg
& HERMES_EV_ALLOC
)) && k
) {
335 reg
= hermes_read_regn(hw
, EVSTAT
);
338 if (!hermes_present(hw
)) {
339 printk(KERN_WARNING
"hermes @ %p: "
340 "Card removed waiting for frame allocation.\n",
345 if (!(reg
& HERMES_EV_ALLOC
)) {
346 printk(KERN_ERR
"hermes @ %p: "
347 "Timeout waiting for frame allocation\n",
352 *fid
= hermes_read_regn(hw
, ALLOCFID
);
353 hermes_write_regn(hw
, EVACK
, HERMES_EV_ALLOC
);
358 /* Set up a BAP to read a particular chunk of data from card's internal buffer.
361 * < 0 on internal failure (errno)
366 * Callable from any context */
367 static int hermes_bap_seek(struct hermes
*hw
, int bap
, u16 id
, u16 offset
)
369 int sreg
= bap
? HERMES_SELECT1
: HERMES_SELECT0
;
370 int oreg
= bap
? HERMES_OFFSET1
: HERMES_OFFSET0
;
375 if ((offset
> HERMES_BAP_OFFSET_MAX
) || (offset
% 2))
378 k
= HERMES_BAP_BUSY_TIMEOUT
;
379 reg
= hermes_read_reg(hw
, oreg
);
380 while ((reg
& HERMES_OFFSET_BUSY
) && k
) {
383 reg
= hermes_read_reg(hw
, oreg
);
386 if (reg
& HERMES_OFFSET_BUSY
)
389 /* Now we actually set up the transfer */
390 hermes_write_reg(hw
, sreg
, id
);
391 hermes_write_reg(hw
, oreg
, offset
);
393 /* Wait for the BAP to be ready */
394 k
= HERMES_BAP_BUSY_TIMEOUT
;
395 reg
= hermes_read_reg(hw
, oreg
);
396 while ((reg
& (HERMES_OFFSET_BUSY
| HERMES_OFFSET_ERR
)) && k
) {
399 reg
= hermes_read_reg(hw
, oreg
);
403 printk(KERN_ERR
"hermes @ %p: BAP%d offset %s: "
404 "reg=0x%x id=0x%x offset=0x%x\n", hw
->iobase
, bap
,
405 (reg
& HERMES_OFFSET_BUSY
) ? "timeout" : "error",
408 if (reg
& HERMES_OFFSET_BUSY
)
411 return -EIO
; /* error or wrong offset */
417 /* Read a block of data from the chip's buffer, via the
418 * BAP. Synchronization/serialization is the caller's problem. len
422 * < 0 on internal failure (errno)
424 * > 0 on error from firmware
426 static int hermes_bap_pread(struct hermes
*hw
, int bap
, void *buf
, int len
,
429 int dreg
= bap
? HERMES_DATA1
: HERMES_DATA0
;
432 if ((len
< 0) || (len
% 2))
435 err
= hermes_bap_seek(hw
, bap
, id
, offset
);
439 /* Actually do the transfer */
440 hermes_read_words(hw
, dreg
, buf
, len
/ 2);
446 /* Write a block of data to the chip's buffer, via the
447 * BAP. Synchronization/serialization is the caller's problem.
450 * < 0 on internal failure (errno)
452 * > 0 on error from firmware
454 static int hermes_bap_pwrite(struct hermes
*hw
, int bap
, const void *buf
,
455 int len
, u16 id
, u16 offset
)
457 int dreg
= bap
? HERMES_DATA1
: HERMES_DATA0
;
463 err
= hermes_bap_seek(hw
, bap
, id
, offset
);
467 /* Actually do the transfer */
468 hermes_write_bytes(hw
, dreg
, buf
, len
);
474 /* Read a Length-Type-Value record from the card.
476 * If length is NULL, we ignore the length read from the card, and
477 * read the entire buffer regardless. This is useful because some of
478 * the configuration records appear to have incorrect lengths in
481 * Callable from user or bh context. */
482 static int hermes_read_ltv(struct hermes
*hw
, int bap
, u16 rid
,
483 unsigned bufsize
, u16
*length
, void *buf
)
486 int dreg
= bap
? HERMES_DATA1
: HERMES_DATA0
;
493 err
= hermes_docmd_wait(hw
, HERMES_CMD_ACCESS
, rid
, NULL
);
497 err
= hermes_bap_seek(hw
, bap
, rid
, 0);
501 rlength
= hermes_read_reg(hw
, dreg
);
506 rtype
= hermes_read_reg(hw
, dreg
);
512 printk(KERN_WARNING
"hermes @ %p: %s(): "
513 "rid (0x%04x) does not match type (0x%04x)\n",
514 hw
->iobase
, __func__
, rid
, rtype
);
515 if (HERMES_RECLEN_TO_BYTES(rlength
) > bufsize
)
516 printk(KERN_WARNING
"hermes @ %p: "
517 "Truncating LTV record from %d to %d bytes. "
518 "(rid=0x%04x, len=0x%04x)\n", hw
->iobase
,
519 HERMES_RECLEN_TO_BYTES(rlength
), bufsize
, rid
, rlength
);
521 nwords
= min((unsigned)rlength
- 1, bufsize
/ 2);
522 hermes_read_words(hw
, dreg
, buf
, nwords
);
527 static int hermes_write_ltv(struct hermes
*hw
, int bap
, u16 rid
,
528 u16 length
, const void *value
)
530 int dreg
= bap
? HERMES_DATA1
: HERMES_DATA0
;
537 err
= hermes_bap_seek(hw
, bap
, rid
, 0);
541 hermes_write_reg(hw
, dreg
, length
);
542 hermes_write_reg(hw
, dreg
, rid
);
546 hermes_write_bytes(hw
, dreg
, value
, count
<< 1);
548 err
= hermes_docmd_wait(hw
, HERMES_CMD_ACCESS
| HERMES_CMD_WRITE
,
554 /*** Hermes AUX control ***/
557 hermes_aux_setaddr(struct hermes
*hw
, u32 addr
)
559 hermes_write_reg(hw
, HERMES_AUXPAGE
, (u16
) (addr
>> 7));
560 hermes_write_reg(hw
, HERMES_AUXOFFSET
, (u16
) (addr
& 0x7F));
564 hermes_aux_control(struct hermes
*hw
, int enabled
)
566 int desired_state
= enabled
? HERMES_AUX_ENABLED
: HERMES_AUX_DISABLED
;
567 int action
= enabled
? HERMES_AUX_ENABLE
: HERMES_AUX_DISABLE
;
571 if (hermes_read_reg(hw
, HERMES_CONTROL
) == desired_state
)
574 hermes_write_reg(hw
, HERMES_PARAM0
, HERMES_AUX_PW0
);
575 hermes_write_reg(hw
, HERMES_PARAM1
, HERMES_AUX_PW1
);
576 hermes_write_reg(hw
, HERMES_PARAM2
, HERMES_AUX_PW2
);
577 hermes_write_reg(hw
, HERMES_CONTROL
, action
);
579 for (i
= 0; i
< 20; i
++) {
581 if (hermes_read_reg(hw
, HERMES_CONTROL
) ==
589 /*** Hermes programming ***/
591 /* About to start programming data (Hermes I)
592 * offset is the entry point
594 * Spectrum_cs' Symbol fw does not require this
595 * wl_lkm Agere fw does
596 * Don't know about intersil
598 static int hermesi_program_init(struct hermes
*hw
, u32 offset
)
602 /* Disable interrupts?*/
604 /*hermes_write_regn(hw, INTEN, 0);*/
605 /*hermes_set_irqmask(hw, 0);*/
607 /* Acknowledge any outstanding command */
608 hermes_write_regn(hw
, EVACK
, 0xFFFF);
610 /* Using init_cmd_wait rather than cmd_wait */
611 err
= hw
->ops
->init_cmd_wait(hw
,
612 0x0100 | HERMES_CMD_INIT
,
617 err
= hw
->ops
->init_cmd_wait(hw
,
618 0x0000 | HERMES_CMD_INIT
,
623 err
= hermes_aux_control(hw
, 1);
624 pr_debug("AUX enable returned %d\n", err
);
629 pr_debug("Enabling volatile, EP 0x%08x\n", offset
);
630 err
= hw
->ops
->init_cmd_wait(hw
,
631 HERMES_PROGRAM_ENABLE_VOLATILE
,
636 pr_debug("PROGRAM_ENABLE returned %d\n", err
);
641 /* Done programming data (Hermes I)
643 * Spectrum_cs' Symbol fw does not require this
644 * wl_lkm Agere fw does
645 * Don't know about intersil
647 static int hermesi_program_end(struct hermes
*hw
)
649 struct hermes_response resp
;
653 rc
= hw
->ops
->cmd_wait(hw
, HERMES_PROGRAM_DISABLE
, 0, &resp
);
655 pr_debug("PROGRAM_DISABLE returned %d, "
656 "r0 0x%04x, r1 0x%04x, r2 0x%04x\n",
657 rc
, resp
.resp0
, resp
.resp1
, resp
.resp2
);
660 ((resp
.status
& HERMES_STATUS_CMDCODE
) != HERMES_CMD_DOWNLD
))
663 err
= hermes_aux_control(hw
, 0);
664 pr_debug("AUX disable returned %d\n", err
);
666 /* Acknowledge any outstanding command */
667 hermes_write_regn(hw
, EVACK
, 0xFFFF);
669 /* Reinitialise, ignoring return */
670 (void) hw
->ops
->init_cmd_wait(hw
, 0x0000 | HERMES_CMD_INIT
,
673 return rc
? rc
: err
;
676 static int hermes_program_bytes(struct hermes
*hw
, const char *data
,
679 /* wl lkm splits the programming into chunks of 2000 bytes.
680 * This restriction appears to come from USB. The PCMCIA
681 * adapters can program the whole lot in one go */
682 hermes_aux_setaddr(hw
, addr
);
683 hermes_write_bytes(hw
, HERMES_AUXDATA
, data
, len
);
687 /* Read PDA from the adapter */
688 static int hermes_read_pda(struct hermes
*hw
, __le16
*pda
, u32 pda_addr
,
693 u16 data_len
= pda_len
;
696 if (hw
->eeprom_pda
) {
697 /* PDA of spectrum symbol is in eeprom */
699 /* Issue command to read EEPROM */
700 ret
= hw
->ops
->cmd_wait(hw
, HERMES_CMD_READMIF
, 0, NULL
);
704 /* wl_lkm does not include PDA size in the PDA area.
705 * We will pad the information into pda, so other routines
706 * don't have to be modified */
707 pda
[0] = cpu_to_le16(pda_len
- 2);
708 /* Includes CFG_PROD_DATA but not itself */
709 pda
[1] = cpu_to_le16(0x0800); /* CFG_PROD_DATA */
710 data_len
= pda_len
- 4;
714 /* Open auxiliary port */
715 ret
= hermes_aux_control(hw
, 1);
716 pr_debug("AUX enable returned %d\n", ret
);
721 hermes_aux_setaddr(hw
, pda_addr
);
722 hermes_read_words(hw
, HERMES_AUXDATA
, data
, data_len
/ 2);
725 ret
= hermes_aux_control(hw
, 0);
726 pr_debug("AUX disable returned %d\n", ret
);
728 /* Check PDA length */
729 pda_size
= le16_to_cpu(pda
[0]);
730 pr_debug("Actual PDA length %d, Max allowed %d\n",
732 if (pda_size
> pda_len
)
738 static void hermes_lock_irqsave(spinlock_t
*lock
,
739 unsigned long *flags
) __acquires(lock
)
741 spin_lock_irqsave(lock
, *flags
);
744 static void hermes_unlock_irqrestore(spinlock_t
*lock
,
745 unsigned long *flags
) __releases(lock
)
747 spin_unlock_irqrestore(lock
, *flags
);
750 static void hermes_lock_irq(spinlock_t
*lock
) __acquires(lock
)
755 static void hermes_unlock_irq(spinlock_t
*lock
) __releases(lock
)
757 spin_unlock_irq(lock
);
760 /* Hermes operations for local buses */
761 static const struct hermes_ops hermes_ops_local
= {
763 .cmd_wait
= hermes_docmd_wait
,
764 .init_cmd_wait
= hermes_doicmd_wait
,
765 .allocate
= hermes_allocate
,
766 .read_ltv
= hermes_read_ltv
,
767 .write_ltv
= hermes_write_ltv
,
768 .bap_pread
= hermes_bap_pread
,
769 .bap_pwrite
= hermes_bap_pwrite
,
770 .read_pda
= hermes_read_pda
,
771 .program_init
= hermesi_program_init
,
772 .program_end
= hermesi_program_end
,
773 .program
= hermes_program_bytes
,
774 .lock_irqsave
= hermes_lock_irqsave
,
775 .unlock_irqrestore
= hermes_unlock_irqrestore
,
776 .lock_irq
= hermes_lock_irq
,
777 .unlock_irq
= hermes_unlock_irq
,