[deliverable/linux.git] / drivers / net / wireless / orinoco / hermes.c

/* hermes.c
 *
 * Driver core for the "Hermes" wireless MAC controller, as used in
 * the Lucent Orinoco and Cabletron RoamAbout cards. It should also
 * work on the hfa3841 and hfa3842 MAC controller chips used in the
 * Prism II chipsets.
 *
 * This is not a complete driver, just low-level access routines for
 * the MAC controller itself.
 *
 * Based on the prism2 driver from Absolute Value Systems' linux-wlan
 * project, the Linux wvlan_cs driver, Lucent's HCF-Light
 * (wvlan_hcf.c) library, and the NetBSD wireless driver (in no
 * particular order).
 *
 * Copyright (C) 2000, David Gibson, Linuxcare Australia.
 * (C) Copyright David Gibson, IBM Corp. 2001-2003.
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.1 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License
 * at http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and
 * limitations under the License.
 *
 * Alternatively, the contents of this file may be used under the
 * terms of the GNU General Public License version 2 (the "GPL"), in
 * which case the provisions of the GPL are applicable instead of the
 * above.  If you wish to allow the use of your version of this file
 * only under the terms of the GPL and not to allow others to use your
 * version of this file under the MPL, indicate your decision by
 * deleting the provisions above and replace them with the notice and
 * other provisions required by the GPL.  If you do not delete the
 * provisions above, a recipient may use your version of this file
 * under either the MPL or the GPL.
 */

#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/init.h>
#include <linux/delay.h>

#include "hermes.h"

/* These are maximum timeouts. Most often, card wil react much faster */
#define CMD_BUSY_TIMEOUT (100) /* In iterations of ~1us */
#define CMD_INIT_TIMEOUT (50000) /* in iterations of ~10us */
#define CMD_COMPL_TIMEOUT (20000) /* in iterations of ~10us */
#define ALLOC_COMPL_TIMEOUT (1000) /* in iterations of ~10us */

/*
 * Debugging helpers
 */

#define DMSG(stuff...) do {printk(KERN_DEBUG "hermes @ %p: " , hw->iobase); \
			printk(stuff); } while (0)

#undef HERMES_DEBUG
#ifdef HERMES_DEBUG
#include <stdarg.h>

#define DEBUG(lvl, stuff...) if ((lvl) <= HERMES_DEBUG) DMSG(stuff)

#else /* ! HERMES_DEBUG */

#define DEBUG(lvl, stuff...) do { } while (0)

#endif /* ! HERMES_DEBUG */


/*
 * Internal functions
 */

/* Issue a command to the chip. Waiting for it to complete is the caller's
   problem.

   Returns -EBUSY if the command register is busy, 0 on success.

   Callable from any context.
*/
static int hermes_issue_cmd(hermes_t *hw, u16 cmd, u16 param0,
			    u16 param1, u16 param2)
{
	int k = CMD_BUSY_TIMEOUT;
	u16 reg;

	/* First wait for the command register to unbusy */
	reg = hermes_read_regn(hw, CMD);
	while ((reg & HERMES_CMD_BUSY) && k) {
		k--;
		udelay(1);
		reg = hermes_read_regn(hw, CMD);
	}
	if (reg & HERMES_CMD_BUSY)
		return -EBUSY;

	hermes_write_regn(hw, PARAM2, param2);
	hermes_write_regn(hw, PARAM1, param1);
	hermes_write_regn(hw, PARAM0, param0);
	hermes_write_regn(hw, CMD, cmd);

	return 0;
}

/*
 * Function definitions
 */

/* For doing cmds that wipe the magic constant in SWSUPPORT0 */
int hermes_doicmd_wait(hermes_t *hw, u16 cmd,
		       u16 parm0, u16 parm1, u16 parm2,
		       struct hermes_response *resp)
{
	int err = 0;
	int k;
	u16 status, reg;

	err = hermes_issue_cmd(hw, cmd, parm0, parm1, parm2);
	if (err)
		return err;

	reg = hermes_read_regn(hw, EVSTAT);
	k = CMD_INIT_TIMEOUT;
	while ((!(reg & HERMES_EV_CMD)) && k) {
		k--;
		udelay(10);
		reg = hermes_read_regn(hw, EVSTAT);
	}

	hermes_write_regn(hw, SWSUPPORT0, HERMES_MAGIC);

	if (!hermes_present(hw)) {
		DEBUG(0, "hermes @ 0x%x: Card removed during reset.\n",
		       hw->iobase);
		err = -ENODEV;
		goto out;
	}

	if (!(reg & HERMES_EV_CMD)) {
		printk(KERN_ERR "hermes @ %p: "
		       "Timeout waiting for card to reset (reg=0x%04x)!\n",
		       hw->iobase, reg);
		err = -ETIMEDOUT;
		goto out;
	}

	status = hermes_read_regn(hw, STATUS);
	if (resp) {
		resp->status = status;
		resp->resp0 = hermes_read_regn(hw, RESP0);
		resp->resp1 = hermes_read_regn(hw, RESP1);
		resp->resp2 = hermes_read_regn(hw, RESP2);
	}

	hermes_write_regn(hw, EVACK, HERMES_EV_CMD);

	if (status & HERMES_STATUS_RESULT)
		err = -EIO;
out:
	return err;
}
EXPORT_SYMBOL(hermes_doicmd_wait);

void hermes_struct_init(hermes_t *hw, void __iomem *address, int reg_spacing)
{
	hw->iobase = address;
	hw->reg_spacing = reg_spacing;
	hw->inten = 0x0;
}
EXPORT_SYMBOL(hermes_struct_init);

int hermes_init(hermes_t *hw)
{
	u16 reg;
	int err = 0;
	int k;

	/* We don't want to be interrupted while resetting the chipset */
	hw->inten = 0x0;
	hermes_write_regn(hw, INTEN, 0);
	hermes_write_regn(hw, EVACK, 0xffff);

	/* Normally it's a "can't happen" for the command register to
	   be busy when we go to issue a command because we are
	   serializing all commands.  However we want to have some
	   chance of resetting the card even if it gets into a stupid
	   state, so we actually wait to see if the command register
	   will unbusy itself here. */
	k = CMD_BUSY_TIMEOUT;
	reg = hermes_read_regn(hw, CMD);
	while (k && (reg & HERMES_CMD_BUSY)) {
		if (reg == 0xffff) /* Special case - the card has probably been
				      removed, so don't wait for the timeout */
			return -ENODEV;

		k--;
		udelay(1);
		reg = hermes_read_regn(hw, CMD);
	}

	/* No need to explicitly handle the timeout - if we've timed
	   out hermes_issue_cmd() will probably return -EBUSY below */

	/* According to the documentation, EVSTAT may contain
	   obsolete event occurrence information.  We have to acknowledge
	   it by writing EVACK. */
	reg = hermes_read_regn(hw, EVSTAT);
	hermes_write_regn(hw, EVACK, reg);

	/* We don't use hermes_docmd_wait here, because the reset wipes
	   the magic constant in SWSUPPORT0 away, and it gets confused */
	err = hermes_doicmd_wait(hw, HERMES_CMD_INIT, 0, 0, 0, NULL);

	return err;
}
EXPORT_SYMBOL(hermes_init);

/* Issue a command to the chip, and (busy!) wait for it to
 * complete.
 *
 * Returns:
 *     < 0 on internal error
 *       0 on success
 *     > 0 on error returned by the firmware
 *
 * Callable from any context, but locking is your problem. */
int hermes_docmd_wait(hermes_t *hw, u16 cmd, u16 parm0,
		      struct hermes_response *resp)
{
	int err;
	int k;
	u16 reg;
	u16 status;

	err = hermes_issue_cmd(hw, cmd, parm0, 0, 0);
	if (err) {
		if (!hermes_present(hw)) {
			if (net_ratelimit())
				printk(KERN_WARNING "hermes @ %p: "
				       "Card removed while issuing command "
				       "0x%04x.\n", hw->iobase, cmd);
			err = -ENODEV;
		} else
			if (net_ratelimit())
				printk(KERN_ERR "hermes @ %p: "
				       "Error %d issuing command 0x%04x.\n",
				       hw->iobase, err, cmd);
		goto out;
	}

	reg = hermes_read_regn(hw, EVSTAT);
	k = CMD_COMPL_TIMEOUT;
	while ((!(reg & HERMES_EV_CMD)) && k) {
		k--;
		udelay(10);
		reg = hermes_read_regn(hw, EVSTAT);
	}

	if (!hermes_present(hw)) {
		printk(KERN_WARNING "hermes @ %p: Card removed "
		       "while waiting for command 0x%04x completion.\n",
		       hw->iobase, cmd);
		err = -ENODEV;
		goto out;
	}

	if (!(reg & HERMES_EV_CMD)) {
		printk(KERN_ERR "hermes @ %p: Timeout waiting for "
		       "command 0x%04x completion.\n", hw->iobase, cmd);
		err = -ETIMEDOUT;
		goto out;
	}

	status = hermes_read_regn(hw, STATUS);
	if (resp) {
		resp->status = status;
		resp->resp0 = hermes_read_regn(hw, RESP0);
		resp->resp1 = hermes_read_regn(hw, RESP1);
		resp->resp2 = hermes_read_regn(hw, RESP2);
	}

	hermes_write_regn(hw, EVACK, HERMES_EV_CMD);

	if (status & HERMES_STATUS_RESULT)
		err = -EIO;

 out:
	return err;
}
EXPORT_SYMBOL(hermes_docmd_wait);

int hermes_allocate(hermes_t *hw, u16 size, u16 *fid)
{
	int err = 0;
	int k;
	u16 reg;

	if ((size < HERMES_ALLOC_LEN_MIN) || (size > HERMES_ALLOC_LEN_MAX))
		return -EINVAL;

	err = hermes_docmd_wait(hw, HERMES_CMD_ALLOC, size, NULL);
	if (err)
		return err;

	reg = hermes_read_regn(hw, EVSTAT);
	k = ALLOC_COMPL_TIMEOUT;
	while ((!(reg & HERMES_EV_ALLOC)) && k) {
		k--;
		udelay(10);
		reg = hermes_read_regn(hw, EVSTAT);
	}

	if (!hermes_present(hw)) {
		printk(KERN_WARNING "hermes @ %p: "
		       "Card removed waiting for frame allocation.\n",
		       hw->iobase);
		return -ENODEV;
	}

	if (!(reg & HERMES_EV_ALLOC)) {
		printk(KERN_ERR "hermes @ %p: "
		       "Timeout waiting for frame allocation\n",
		       hw->iobase);
		return -ETIMEDOUT;
	}

	*fid = hermes_read_regn(hw, ALLOCFID);
	hermes_write_regn(hw, EVACK, HERMES_EV_ALLOC);

	return 0;
}
EXPORT_SYMBOL(hermes_allocate);

/* Set up a BAP to read a particular chunk of data from card's internal buffer.
 *
 * Returns:
 *     < 0 on internal failure (errno)
 *       0 on success
 *     > 0 on error
 * from firmware
 *
 * Callable from any context */
static int hermes_bap_seek(hermes_t *hw, int bap, u16 id, u16 offset)
{
	int sreg = bap ? HERMES_SELECT1 : HERMES_SELECT0;
	int oreg = bap ? HERMES_OFFSET1 : HERMES_OFFSET0;
	int k;
	u16 reg;

	/* Paranoia.. */
	if ((offset > HERMES_BAP_OFFSET_MAX) || (offset % 2))
		return -EINVAL;

	k = HERMES_BAP_BUSY_TIMEOUT;
	reg = hermes_read_reg(hw, oreg);
	while ((reg & HERMES_OFFSET_BUSY) && k) {
		k--;
		udelay(1);
		reg = hermes_read_reg(hw, oreg);
	}

	if (reg & HERMES_OFFSET_BUSY)
		return -ETIMEDOUT;

	/* Now we actually set up the transfer */
	hermes_write_reg(hw, sreg, id);
	hermes_write_reg(hw, oreg, offset);

	/* Wait for the BAP to be ready */
	k = HERMES_BAP_BUSY_TIMEOUT;
	reg = hermes_read_reg(hw, oreg);
	while ((reg & (HERMES_OFFSET_BUSY | HERMES_OFFSET_ERR)) && k) {
		k--;
		udelay(1);
		reg = hermes_read_reg(hw, oreg);
	}

	if (reg != offset) {
		printk(KERN_ERR "hermes @ %p: BAP%d offset %s: "
		       "reg=0x%x id=0x%x offset=0x%x\n", hw->iobase, bap,
		       (reg & HERMES_OFFSET_BUSY) ? "timeout" : "error",
		       reg, id, offset);

		if (reg & HERMES_OFFSET_BUSY)
			return -ETIMEDOUT;

		return -EIO;		/* error or wrong offset */
	}

	return 0;
}

/* Read a block of data from the chip's buffer, via the
 * BAP. Synchronization/serialization is the caller's problem.  len
 * must be even.
 *
 * Returns:
 *     < 0 on internal failure (errno)
 *       0 on success
 *     > 0 on error from firmware
 */
int hermes_bap_pread(hermes_t *hw, int bap, void *buf, int len,
		     u16 id, u16 offset)
{
	int dreg = bap ? HERMES_DATA1 : HERMES_DATA0;
	int err = 0;

	if ((len < 0) || (len % 2))
		return -EINVAL;

	err = hermes_bap_seek(hw, bap, id, offset);
	if (err)
		goto out;

	/* Actually do the transfer */
	hermes_read_words(hw, dreg, buf, len/2);

 out:
	return err;
}
EXPORT_SYMBOL(hermes_bap_pread);

/* Write a block of data to the chip's buffer, via the
 * BAP. Synchronization/serialization is the caller's problem.
 *
 * Returns:
 *     < 0 on internal failure (errno)
 *       0 on success
 *     > 0 on error from firmware
 */
int hermes_bap_pwrite(hermes_t *hw, int bap, const void *buf, int len,
		      u16 id, u16 offset)
{
	int dreg = bap ? HERMES_DATA1 : HERMES_DATA0;
	int err = 0;

	if (len < 0)
		return -EINVAL;

	err = hermes_bap_seek(hw, bap, id, offset);
	if (err)
		goto out;

	/* Actually do the transfer */
	hermes_write_bytes(hw, dreg, buf, len);

 out:
	return err;
}
EXPORT_SYMBOL(hermes_bap_pwrite);

/* Read a Length-Type-Value record from the card.
 *
 * If length is NULL, we ignore the length read from the card, and
 * read the entire buffer regardless. This is useful because some of
 * the configuration records appear to have incorrect lengths in
 * practice.
 *
 * Callable from user or bh context.  */
int hermes_read_ltv(hermes_t *hw, int bap, u16 rid, unsigned bufsize,
		    u16 *length, void *buf)
{
	int err = 0;
	int dreg = bap ? HERMES_DATA1 : HERMES_DATA0;
	u16 rlength, rtype;
	unsigned nwords;

	if (bufsize % 2)
		return -EINVAL;

	err = hermes_docmd_wait(hw, HERMES_CMD_ACCESS, rid, NULL);
	if (err)
		return err;

	err = hermes_bap_seek(hw, bap, rid, 0);
	if (err)
		return err;

	rlength = hermes_read_reg(hw, dreg);

	if (!rlength)
		return -ENODATA;

	rtype = hermes_read_reg(hw, dreg);

	if (length)
		*length = rlength;

	if (rtype != rid)
		printk(KERN_WARNING "hermes @ %p: %s(): "
		       "rid (0x%04x) does not match type (0x%04x)\n",
		       hw->iobase, __func__, rid, rtype);
	if (HERMES_RECLEN_TO_BYTES(rlength) > bufsize)
		printk(KERN_WARNING "hermes @ %p: "
		       "Truncating LTV record from %d to %d bytes. "
		       "(rid=0x%04x, len=0x%04x)\n", hw->iobase,
		       HERMES_RECLEN_TO_BYTES(rlength), bufsize, rid, rlength);

	nwords = min((unsigned)rlength - 1, bufsize / 2);
	hermes_read_words(hw, dreg, buf, nwords);

	return 0;
}
EXPORT_SYMBOL(hermes_read_ltv);

int hermes_write_ltv(hermes_t *hw, int bap, u16 rid,
		     u16 length, const void *value)
{
	int dreg = bap ? HERMES_DATA1 : HERMES_DATA0;
	int err = 0;
	unsigned count;

	if (length == 0)
		return -EINVAL;

	err = hermes_bap_seek(hw, bap, rid, 0);
	if (err)
		return err;

	hermes_write_reg(hw, dreg, length);
	hermes_write_reg(hw, dreg, rid);

	count = length - 1;

	hermes_write_bytes(hw, dreg, value, count << 1);

	err = hermes_docmd_wait(hw, HERMES_CMD_ACCESS | HERMES_CMD_WRITE,
				rid, NULL);

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