[net-next-2.6.git] / drivers / net / enic / vnic_devcmd.h

/*
 * Copyright 2008-2010 Cisco Systems, Inc.  All rights reserved.
 * Copyright 2007 Nuova Systems, Inc.  All rights reserved.
 *
 * This program is free software; you may redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; version 2 of the License.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 */

#ifndef _VNIC_DEVCMD_H_
#define _VNIC_DEVCMD_H_

#define _CMD_NBITS      14
#define _CMD_VTYPEBITS	10
#define _CMD_FLAGSBITS  6
#define _CMD_DIRBITS	2

#define _CMD_NMASK      ((1 << _CMD_NBITS)-1)
#define _CMD_VTYPEMASK  ((1 << _CMD_VTYPEBITS)-1)
#define _CMD_FLAGSMASK  ((1 << _CMD_FLAGSBITS)-1)
#define _CMD_DIRMASK    ((1 << _CMD_DIRBITS)-1)

#define _CMD_NSHIFT     0
#define _CMD_VTYPESHIFT (_CMD_NSHIFT+_CMD_NBITS)
#define _CMD_FLAGSSHIFT (_CMD_VTYPESHIFT+_CMD_VTYPEBITS)
#define _CMD_DIRSHIFT   (_CMD_FLAGSSHIFT+_CMD_FLAGSBITS)

/*
 * Direction bits (from host perspective).
 */
#define _CMD_DIR_NONE   0U
#define _CMD_DIR_WRITE  1U
#define _CMD_DIR_READ   2U
#define _CMD_DIR_RW     (_CMD_DIR_WRITE | _CMD_DIR_READ)

/*
 * Flag bits.
 */
#define _CMD_FLAGS_NONE 0U
#define _CMD_FLAGS_NOWAIT 1U

/*
 * vNIC type bits.
 */
#define _CMD_VTYPE_NONE  0U
#define _CMD_VTYPE_ENET  1U
#define _CMD_VTYPE_FC    2U
#define _CMD_VTYPE_SCSI  4U
#define _CMD_VTYPE_ALL   (_CMD_VTYPE_ENET | _CMD_VTYPE_FC | _CMD_VTYPE_SCSI)

/*
 * Used to create cmds..
*/
#define _CMDCF(dir, flags, vtype, nr)  \
	(((dir)   << _CMD_DIRSHIFT) | \
	((flags) << _CMD_FLAGSSHIFT) | \
	((vtype) << _CMD_VTYPESHIFT) | \
	((nr)    << _CMD_NSHIFT))
#define _CMDC(dir, vtype, nr)    _CMDCF(dir, 0, vtype, nr)
#define _CMDCNW(dir, vtype, nr)  _CMDCF(dir, _CMD_FLAGS_NOWAIT, vtype, nr)

/*
 * Used to decode cmds..
*/
#define _CMD_DIR(cmd)            (((cmd) >> _CMD_DIRSHIFT) & _CMD_DIRMASK)
#define _CMD_FLAGS(cmd)          (((cmd) >> _CMD_FLAGSSHIFT) & _CMD_FLAGSMASK)
#define _CMD_VTYPE(cmd)          (((cmd) >> _CMD_VTYPESHIFT) & _CMD_VTYPEMASK)
#define _CMD_N(cmd)              (((cmd) >> _CMD_NSHIFT) & _CMD_NMASK)

enum vnic_devcmd_cmd {
	CMD_NONE                = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_NONE, 0),

	/* mcpu fw info in mem: (u64)a0=paddr to struct vnic_devcmd_fw_info */
	CMD_MCPU_FW_INFO        = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 1),

	/* dev-specific block member:
	 *    in: (u16)a0=offset,(u8)a1=size
	 *    out: a0=value */
	CMD_DEV_SPEC            = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 2),

	/* stats clear */
	CMD_STATS_CLEAR         = _CMDCNW(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 3),

	/* stats dump in mem: (u64)a0=paddr to stats area,
	 *                    (u16)a1=sizeof stats area */
	CMD_STATS_DUMP          = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 4),

	/* set Rx packet filter: (u32)a0=filters (see CMD_PFILTER_*) */
	CMD_PACKET_FILTER	= _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 7),

	/* set Rx packet filter for all: (u32)a0=filters (see CMD_PFILTER_*) */
	CMD_PACKET_FILTER_ALL   = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 7),

	/* hang detection notification */
	CMD_HANG_NOTIFY         = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 8),

	/* MAC address in (u48)a0 */
	CMD_MAC_ADDR            = _CMDC(_CMD_DIR_READ,
					_CMD_VTYPE_ENET | _CMD_VTYPE_FC, 9),

	/* add addr from (u48)a0 */
	CMD_ADDR_ADD            = _CMDCNW(_CMD_DIR_WRITE,
					_CMD_VTYPE_ENET | _CMD_VTYPE_FC, 12),

	/* del addr from (u48)a0 */
	CMD_ADDR_DEL            = _CMDCNW(_CMD_DIR_WRITE,
					_CMD_VTYPE_ENET | _CMD_VTYPE_FC, 13),

	/* add VLAN id in (u16)a0 */
	CMD_VLAN_ADD            = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 14),

	/* del VLAN id in (u16)a0 */
	CMD_VLAN_DEL            = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 15),

	/* nic_cfg in (u32)a0 */
	CMD_NIC_CFG             = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 16),

	/* union vnic_rss_key in mem: (u64)a0=paddr, (u16)a1=len */
	CMD_RSS_KEY             = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 17),

	/* union vnic_rss_cpu in mem: (u64)a0=paddr, (u16)a1=len */
	CMD_RSS_CPU             = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 18),

	/* initiate softreset */
	CMD_SOFT_RESET          = _CMDCNW(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 19),

	/* softreset status:
	 *    out: a0=0 reset complete, a0=1 reset in progress */
	CMD_SOFT_RESET_STATUS   = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 20),

	/* set struct vnic_devcmd_notify buffer in mem:
	 * in:
	 *   (u64)a0=paddr to notify (set paddr=0 to unset)
	 *   (u32)a1 & 0x00000000ffffffff=sizeof(struct vnic_devcmd_notify)
	 *   (u16)a1 & 0x0000ffff00000000=intr num (-1 for no intr)
	 * out:
	 *   (u32)a1 = effective size
	 */
	CMD_NOTIFY              = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 21),

	/* UNDI API: (u64)a0=paddr to s_PXENV_UNDI_ struct,
	 *           (u8)a1=PXENV_UNDI_xxx */
	CMD_UNDI                = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 22),

	/* initiate open sequence (u32)a0=flags (see CMD_OPENF_*) */
	CMD_OPEN		= _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 23),

	/* open status:
	 *    out: a0=0 open complete, a0=1 open in progress */
	CMD_OPEN_STATUS		= _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 24),

	/* close vnic */
	CMD_CLOSE		= _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 25),

	/* initialize virtual link: (u32)a0=flags (see CMD_INITF_*) */
/***** Replaced by CMD_INIT *****/
	CMD_INIT_v1		= _CMDCNW(_CMD_DIR_READ, _CMD_VTYPE_ALL, 26),

	/* variant of CMD_INIT, with provisioning info
	 *     (u64)a0=paddr of vnic_devcmd_provinfo
	 *     (u32)a1=sizeof provision info */
	CMD_INIT_PROV_INFO	= _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 27),

	/* enable virtual link */
	CMD_ENABLE		= _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 28),

	/* enable virtual link, waiting variant. */
	CMD_ENABLE_WAIT		= _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 28),

	/* disable virtual link */
	CMD_DISABLE		= _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 29),

	/* stats dump sum of all vnic stats on same uplink in mem:
	 *     (u64)a0=paddr
	 *     (u16)a1=sizeof stats area */
	CMD_STATS_DUMP_ALL	= _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 30),

	/* init status:
	 *    out: a0=0 init complete, a0=1 init in progress
	 *         if a0=0, a1=errno */
	CMD_INIT_STATUS		= _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 31),

	/* INT13 API: (u64)a0=paddr to vnic_int13_params struct
	 *            (u32)a1=INT13_CMD_xxx */
	CMD_INT13               = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_FC, 32),

	/* logical uplink enable/disable: (u64)a0: 0/1=disable/enable */
	CMD_LOGICAL_UPLINK      = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 33),

	/* undo initialize of virtual link */
	CMD_DEINIT		= _CMDCNW(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 34),

	/* initialize virtual link: (u32)a0=flags (see CMD_INITF_*) */
	CMD_INIT		= _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 35),

	/* check fw capability of a cmd:
	 * in:  (u32)a0=cmd
	 * out: (u32)a0=errno, 0:valid cmd, a1=supported VNIC_STF_* bits */
	CMD_CAPABILITY		= _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 36),

	/* persistent binding info
	 * in:  (u64)a0=paddr of arg
	 *      (u32)a1=CMD_PERBI_XXX */
	CMD_PERBI		= _CMDC(_CMD_DIR_RW, _CMD_VTYPE_FC, 37),

	/* Interrupt Assert Register functionality
	 * in: (u16)a0=interrupt number to assert
	 */
	CMD_IAR			= _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 38),

	/* initiate hangreset, like softreset after hang detected */
	CMD_HANG_RESET		= _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 39),

	/* hangreset status:
	 *    out: a0=0 reset complete, a0=1 reset in progress */
	CMD_HANG_RESET_STATUS   = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 40),

	/*
	 * Set hw ingress packet vlan rewrite mode:
	 * in:  (u32)a0=new vlan rewrite mode
	 * out: (u32)a0=old vlan rewrite mode */
	CMD_IG_VLAN_REWRITE_MODE = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ENET, 41),

	/*
	 * in:  (u16)a0=bdf of target vnic
	 *      (u32)a1=cmd to proxy
	 *      a2-a15=args to cmd in a1
	 * out: (u32)a0=status of proxied cmd
	 *      a1-a15=out args of proxied cmd */
	CMD_PROXY_BY_BDF =	_CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 42),

	/*
	 * As for BY_BDF except a0 is index of hvnlink subordinate vnic
	 * or SR-IOV virtual vnic */
	CMD_PROXY_BY_INDEX =    _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 43),

	/*
	 * in:  (u64)a0=paddr of buffer to put latest VIC VIF-CONFIG-INFO TLV in
	 *      (u32)a1=length of buffer in a0
	 * out: (u64)a0=paddr of buffer with latest VIC VIF-CONFIG-INFO TLV
	 *      (u32)a1=actual length of latest VIC VIF-CONFIG-INFO TLV */
	CMD_CONFIG_INFO_GET     = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 44),
};

/* flags for CMD_OPEN */
#define CMD_OPENF_OPROM		0x1	/* open coming from option rom */

/* flags for CMD_INIT */
#define CMD_INITF_DEFAULT_MAC	0x1	/* init with default mac addr */

/* flags for CMD_PACKET_FILTER */
#define CMD_PFILTER_DIRECTED		0x01
#define CMD_PFILTER_MULTICAST		0x02
#define CMD_PFILTER_BROADCAST		0x04
#define CMD_PFILTER_PROMISCUOUS		0x08
#define CMD_PFILTER_ALL_MULTICAST	0x10

/* rewrite modes for CMD_IG_VLAN_REWRITE_MODE */
#define IG_VLAN_REWRITE_MODE_DEFAULT_TRUNK              0
#define IG_VLAN_REWRITE_MODE_UNTAG_DEFAULT_VLAN         1
#define IG_VLAN_REWRITE_MODE_PRIORITY_TAG_DEFAULT_VLAN  2
#define IG_VLAN_REWRITE_MODE_PASS_THRU                  3

enum vnic_devcmd_status {
	STAT_NONE = 0,
	STAT_BUSY = 1 << 0,	/* cmd in progress */
	STAT_ERROR = 1 << 1,	/* last cmd caused error (code in a0) */
};

enum vnic_devcmd_error {
	ERR_SUCCESS = 0,
	ERR_EINVAL = 1,
	ERR_EFAULT = 2,
	ERR_EPERM = 3,
	ERR_EBUSY = 4,
	ERR_ECMDUNKNOWN = 5,
	ERR_EBADSTATE = 6,
	ERR_ENOMEM = 7,
	ERR_ETIMEDOUT = 8,
	ERR_ELINKDOWN = 9,
	ERR_EMAXRES = 10,
};

struct vnic_devcmd_fw_info {
	char fw_version[32];
	char fw_build[32];
	char hw_version[32];
	char hw_serial_number[32];
};

struct vnic_devcmd_notify {
	u32 csum;		/* checksum over following words */

	u32 link_state;		/* link up == 1 */
	u32 port_speed;		/* effective port speed (rate limit) */
	u32 mtu;		/* MTU */
	u32 msglvl;		/* requested driver msg lvl */
	u32 uif;		/* uplink interface */
	u32 status;		/* status bits (see VNIC_STF_*) */
	u32 error;		/* error code (see ERR_*) for first ERR */
	u32 link_down_cnt;	/* running count of link down transitions */
	u32 perbi_rebuild_cnt;	/* running count of perbi rebuilds */
};
#define VNIC_STF_FATAL_ERR	0x0001	/* fatal fw error */
#define VNIC_STF_STD_PAUSE	0x0002	/* standard link-level pause on */
#define VNIC_STF_PFC_PAUSE	0x0004	/* priority flow control pause on */
/* all supported status flags */
#define VNIC_STF_ALL		(VNIC_STF_FATAL_ERR |\
				 VNIC_STF_STD_PAUSE |\
				 VNIC_STF_PFC_PAUSE |\
				 0)

struct vnic_devcmd_provinfo {
	u8 oui[3];
	u8 type;
	u8 data[0];
};

/*
 * Writing cmd register causes STAT_BUSY to get set in status register.
 * When cmd completes, STAT_BUSY will be cleared.
 *
 * If cmd completed successfully STAT_ERROR will be clear
 * and args registers contain cmd-specific results.
 *
 * If cmd error, STAT_ERROR will be set and args[0] contains error code.
 *
 * status register is read-only.  While STAT_BUSY is set,
 * all other register contents are read-only.
 */

/* Make sizeof(vnic_devcmd) a power-of-2 for I/O BAR. */
#define VNIC_DEVCMD_NARGS 15
struct vnic_devcmd {
	u32 status;			/* RO */
	u32 cmd;			/* RW */
	u64 args[VNIC_DEVCMD_NARGS];	/* RW cmd args (little-endian) */
};

#endif /* _VNIC_DEVCMD_H_ */
Commit	Line	Data
01f2e4ea	1	/*
29046f9b	2	* Copyright 2008-2010 Cisco Systems, Inc. All rights reserved.
01f2e4ea SF	3	* Copyright 2007 Nuova Systems, Inc. All rights reserved.
	4	*
	5	* This program is free software; you may redistribute it and/or modify
	6	* it under the terms of the GNU General Public License as published by
	7	* the Free Software Foundation; version 2 of the License.
	8	*
	9	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
	10	* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
	11	* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
	12	* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
	13	* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
	14	* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
	15	* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	16	* SOFTWARE.
	17	*
	18	*/
	19
	20	#ifndef _VNIC_DEVCMD_H_
	21	#define _VNIC_DEVCMD_H_
	22
	23	#define _CMD_NBITS 14
	24	#define _CMD_VTYPEBITS 10
	25	#define _CMD_FLAGSBITS 6
	26	#define _CMD_DIRBITS 2
	27
	28	#define _CMD_NMASK ((1 << _CMD_NBITS)-1)
	29	#define _CMD_VTYPEMASK ((1 << _CMD_VTYPEBITS)-1)
	30	#define _CMD_FLAGSMASK ((1 << _CMD_FLAGSBITS)-1)
	31	#define _CMD_DIRMASK ((1 << _CMD_DIRBITS)-1)
	32
	33	#define _CMD_NSHIFT 0
	34	#define _CMD_VTYPESHIFT (_CMD_NSHIFT+_CMD_NBITS)
	35	#define _CMD_FLAGSSHIFT (_CMD_VTYPESHIFT+_CMD_VTYPEBITS)
	36	#define _CMD_DIRSHIFT (_CMD_FLAGSSHIFT+_CMD_FLAGSBITS)
	37
	38	/*
	39	* Direction bits (from host perspective).
	40	*/
	41	#define _CMD_DIR_NONE 0U
	42	#define _CMD_DIR_WRITE 1U
	43	#define _CMD_DIR_READ 2U
	44	#define _CMD_DIR_RW (_CMD_DIR_WRITE \| _CMD_DIR_READ)
	45
	46	/*
	47	* Flag bits.
	48	*/
	49	#define _CMD_FLAGS_NONE 0U
	50	#define _CMD_FLAGS_NOWAIT 1U
	51
	52	/*
	53	* vNIC type bits.
	54	*/
	55	#define _CMD_VTYPE_NONE 0U
	56	#define _CMD_VTYPE_ENET 1U
	57	#define _CMD_VTYPE_FC 2U
	58	#define _CMD_VTYPE_SCSI 4U
	59	#define _CMD_VTYPE_ALL (_CMD_VTYPE_ENET \| _CMD_VTYPE_FC \| _CMD_VTYPE_SCSI)
	60
	61	/*
	62	* Used to create cmds..
	63	*/
	64	#define _CMDCF(dir, flags, vtype, nr) \
	65	(((dir) << _CMD_DIRSHIFT) \| \
	66	((flags) << _CMD_FLAGSSHIFT) \| \
67	((vtype) << _CMD_VTYPESHIFT) \| \
68	((nr) << _CMD_NSHIFT))
69	#define _CMDC(dir, vtype, nr) _CMDCF(dir, 0, vtype, nr)
70	#define _CMDCNW(dir, vtype, nr) _CMDCF(dir, _CMD_FLAGS_NOWAIT, vtype, nr)
71
72	/*
73	* Used to decode cmds..
74	*/
75	#define _CMD_DIR(cmd) (((cmd) >> _CMD_DIRSHIFT) & _CMD_DIRMASK)
76	#define _CMD_FLAGS(cmd) (((cmd) >> _CMD_FLAGSSHIFT) & _CMD_FLAGSMASK)
77	#define _CMD_VTYPE(cmd) (((cmd) >> _CMD_VTYPESHIFT) & _CMD_VTYPEMASK)
78	#define _CMD_N(cmd) (((cmd) >> _CMD_NSHIFT) & _CMD_NMASK)
79
80	enum vnic_devcmd_cmd {
81	CMD_NONE = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_NONE, 0),
82
83	/* mcpu fw info in mem: (u64)a0=paddr to struct vnic_devcmd_fw_info */
84	CMD_MCPU_FW_INFO = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 1),
85
86	/* dev-specific block member:
87	* in: (u16)a0=offset,(u8)a1=size
88	* out: a0=value */
89	CMD_DEV_SPEC = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 2),
90
91	/* stats clear */
92	CMD_STATS_CLEAR = _CMDCNW(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 3),
93
94	/* stats dump in mem: (u64)a0=paddr to stats area,
95	* (u16)a1=sizeof stats area */
96	CMD_STATS_DUMP = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 4),
97
98	/* set Rx packet filter: (u32)a0=filters (see CMD_PFILTER_) /
99	CMD_PACKET_FILTER = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 7),
100
70feadf3 VK	101	/* set Rx packet filter for all: (u32)a0=filters (see CMD_PFILTER_) /
	102	CMD_PACKET_FILTER_ALL = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 7),
	103
01f2e4ea SF	104	/* hang detection notification */
	105	CMD_HANG_NOTIFY = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 8),
	106
	107	/* MAC address in (u48)a0 */
	108	CMD_MAC_ADDR = _CMDC(_CMD_DIR_READ,
	109	_CMD_VTYPE_ENET \| _CMD_VTYPE_FC, 9),
	110
01f2e4ea SF	111	/* add addr from (u48)a0 */
	112	CMD_ADDR_ADD = _CMDCNW(_CMD_DIR_WRITE,
	113	_CMD_VTYPE_ENET \| _CMD_VTYPE_FC, 12),
	114
	115	/* del addr from (u48)a0 */
	116	CMD_ADDR_DEL = _CMDCNW(_CMD_DIR_WRITE,
	117	_CMD_VTYPE_ENET \| _CMD_VTYPE_FC, 13),
	118
	119	/* add VLAN id in (u16)a0 */
	120	CMD_VLAN_ADD = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 14),
	121
	122	/* del VLAN id in (u16)a0 */
	123	CMD_VLAN_DEL = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 15),
	124
	125	/* nic_cfg in (u32)a0 */
	126	CMD_NIC_CFG = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 16),
	127
	128	/* union vnic_rss_key in mem: (u64)a0=paddr, (u16)a1=len */
	129	CMD_RSS_KEY = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 17),
	130
	131	/* union vnic_rss_cpu in mem: (u64)a0=paddr, (u16)a1=len */
	132	CMD_RSS_CPU = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 18),
	133
	134	/* initiate softreset */
	135	CMD_SOFT_RESET = _CMDCNW(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 19),
	136
	137	/* softreset status:
	138	* out: a0=0 reset complete, a0=1 reset in progress */
	139	CMD_SOFT_RESET_STATUS = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 20),
	140
	141	/* set struct vnic_devcmd_notify buffer in mem:
	142	* in:
	143	* (u64)a0=paddr to notify (set paddr=0 to unset)
	144	* (u32)a1 & 0x00000000ffffffff=sizeof(struct vnic_devcmd_notify)
	145	* (u16)a1 & 0x0000ffff00000000=intr num (-1 for no intr)
	146	* out:
	147	* (u32)a1 = effective size
	148	*/
	149	CMD_NOTIFY = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 21),
	150
	151	/* UNDI API: (u64)a0=paddr to s_PXENV_UNDI_ struct,
	152	* (u8)a1=PXENV_UNDI_xxx */
	153	CMD_UNDI = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 22),
	154
	155	/* initiate open sequence (u32)a0=flags (see CMD_OPENF_) /
	156	CMD_OPEN = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 23),
	157
	158	/* open status:
	159	* out: a0=0 open complete, a0=1 open in progress */
	160	CMD_OPEN_STATUS = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 24),
	161
	162	/* close vnic */
	163	CMD_CLOSE = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 25),
	164
	165	/* initialize virtual link: (u32)a0=flags (see CMD_INITF_) /
27372bf5 SF	166	/*** Replaced by CMD_INIT ***/
27372bf5 SF	167	CMD_INIT_v1 = _CMDCNW(_CMD_DIR_READ, _CMD_VTYPE_ALL, 26),
01f2e4ea SF	168
	169	/* variant of CMD_INIT, with provisioning info
	170	* (u64)a0=paddr of vnic_devcmd_provinfo
	171	* (u32)a1=sizeof provision info */
	172	CMD_INIT_PROV_INFO = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 27),
	173
	174	/* enable virtual link */
	175	CMD_ENABLE = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 28),
	176
70feadf3 VK	177	/* enable virtual link, waiting variant. */
	178	CMD_ENABLE_WAIT = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 28),
	179
01f2e4ea SF	180	/* disable virtual link */
	181	CMD_DISABLE = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 29),
	182
d73149f5 SF	183	/* stats dump sum of all vnic stats on same uplink in mem:
	184	* (u64)a0=paddr
	185	* (u16)a1=sizeof stats area */
01f2e4ea SF	186	CMD_STATS_DUMP_ALL = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 30),
	187
	188	/* init status:
	189	* out: a0=0 init complete, a0=1 init in progress
	190	* if a0=0, a1=errno */
	191	CMD_INIT_STATUS = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 31),
	192
	193	/* INT13 API: (u64)a0=paddr to vnic_int13_params struct
4cdc44a2	194	* (u32)a1=INT13_CMD_xxx */
01f2e4ea SF	195	CMD_INT13 = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_FC, 32),
	196
	197	/* logical uplink enable/disable: (u64)a0: 0/1=disable/enable */
	198	CMD_LOGICAL_UPLINK = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 33),
	199
	200	/* undo initialize of virtual link */
	201	CMD_DEINIT = _CMDCNW(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 34),
27372bf5 SF	202
	203	/* initialize virtual link: (u32)a0=flags (see CMD_INITF_) /
	204	CMD_INIT = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 35),
	205
	206	/* check fw capability of a cmd:
	207	* in: (u32)a0=cmd
	208	* out: (u32)a0=errno, 0:valid cmd, a1=supported VNIC_STF_* bits */
	209	CMD_CAPABILITY = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 36),
4cdc44a2 SF	210
	211	/* persistent binding info
	212	* in: (u64)a0=paddr of arg
	213	* (u32)a1=CMD_PERBI_XXX */
d73149f5 SF	214	CMD_PERBI = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_FC, 37),
	215
	216	/* Interrupt Assert Register functionality
	217	* in: (u16)a0=interrupt number to assert
	218	*/
	219	CMD_IAR = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 38),
f8cac14a	220
99ef5639 VK	221	/* initiate hangreset, like softreset after hang detected */
	222	CMD_HANG_RESET = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 39),
	223
	224	/* hangreset status:
	225	* out: a0=0 reset complete, a0=1 reset in progress */
	226	CMD_HANG_RESET_STATUS = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 40),
	227
f8cac14a VK	228	/*
	229	* Set hw ingress packet vlan rewrite mode:
	230	* in: (u32)a0=new vlan rewrite mode
	231	* out: (u32)a0=old vlan rewrite mode */
	232	CMD_IG_VLAN_REWRITE_MODE = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ENET, 41),
70feadf3 VK	233
	234	/*
	235	* in: (u16)a0=bdf of target vnic
	236	* (u32)a1=cmd to proxy
	237	* a2-a15=args to cmd in a1
	238	* out: (u32)a0=status of proxied cmd
	239	* a1-a15=out args of proxied cmd */
	240	CMD_PROXY_BY_BDF = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 42),
ae94abe1 RP	241
	242	/*
	243	* As for BY_BDF except a0 is index of hvnlink subordinate vnic
	244	* or SR-IOV virtual vnic */
	245	CMD_PROXY_BY_INDEX = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 43),
	246
	247	/*
	248	* in: (u64)a0=paddr of buffer to put latest VIC VIF-CONFIG-INFO TLV in
	249	* (u32)a1=length of buffer in a0
	250	* out: (u64)a0=paddr of buffer with latest VIC VIF-CONFIG-INFO TLV
	251	* (u32)a1=actual length of latest VIC VIF-CONFIG-INFO TLV */
	252	CMD_CONFIG_INFO_GET = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 44),
01f2e4ea SF	253	};
	254
	255	/* flags for CMD_OPEN */
	256	#define CMD_OPENF_OPROM 0x1 /* open coming from option rom */
	257
	258	/* flags for CMD_INIT */
	259	#define CMD_INITF_DEFAULT_MAC 0x1 /* init with default mac addr */
	260
	261	/* flags for CMD_PACKET_FILTER */
	262	#define CMD_PFILTER_DIRECTED 0x01
	263	#define CMD_PFILTER_MULTICAST 0x02
	264	#define CMD_PFILTER_BROADCAST 0x04
	265	#define CMD_PFILTER_PROMISCUOUS 0x08
	266	#define CMD_PFILTER_ALL_MULTICAST 0x10
	267
f8cac14a VK	268	/* rewrite modes for CMD_IG_VLAN_REWRITE_MODE */
	269	#define IG_VLAN_REWRITE_MODE_DEFAULT_TRUNK 0
	270	#define IG_VLAN_REWRITE_MODE_UNTAG_DEFAULT_VLAN 1
	271	#define IG_VLAN_REWRITE_MODE_PRIORITY_TAG_DEFAULT_VLAN 2
	272	#define IG_VLAN_REWRITE_MODE_PASS_THRU 3
	273
01f2e4ea SF	274	enum vnic_devcmd_status {
	275	STAT_NONE = 0,
	276	STAT_BUSY = 1 << 0, /* cmd in progress */
	277	STAT_ERROR = 1 << 1, /* last cmd caused error (code in a0) */
	278	};
	279
	280	enum vnic_devcmd_error {
	281	ERR_SUCCESS = 0,
	282	ERR_EINVAL = 1,
	283	ERR_EFAULT = 2,
	284	ERR_EPERM = 3,
	285	ERR_EBUSY = 4,
	286	ERR_ECMDUNKNOWN = 5,
	287	ERR_EBADSTATE = 6,
	288	ERR_ENOMEM = 7,
	289	ERR_ETIMEDOUT = 8,
	290	ERR_ELINKDOWN = 9,
d73149f5	291	ERR_EMAXRES = 10,
01f2e4ea SF	292	};
	293
	294	struct vnic_devcmd_fw_info {
	295	char fw_version[32];
	296	char fw_build[32];
	297	char hw_version[32];
	298	char hw_serial_number[32];
	299	};
	300
	301	struct vnic_devcmd_notify {
	302	u32 csum; /* checksum over following words */
	303
	304	u32 link_state; /* link up == 1 */
	305	u32 port_speed; /* effective port speed (rate limit) */
	306	u32 mtu; /* MTU */
	307	u32 msglvl; /* requested driver msg lvl */
	308	u32 uif; /* uplink interface */
	309	u32 status; /* status bits (see VNIC_STF_) /
	310	u32 error; /* error code (see ERR_) for first ERR /
27372bf5	311	u32 link_down_cnt; /* running count of link down transitions */
4cdc44a2	312	u32 perbi_rebuild_cnt; /* running count of perbi rebuilds */
01f2e4ea SF	313	};
01f2e4ea SF	314	#define VNIC_STF_FATAL_ERR 0x0001 /* fatal fw error */
27372bf5 SF	315	#define VNIC_STF_STD_PAUSE 0x0002 /* standard link-level pause on */
	316	#define VNIC_STF_PFC_PAUSE 0x0004 /* priority flow control pause on */
	317	/* all supported status flags */
	318	#define VNIC_STF_ALL (VNIC_STF_FATAL_ERR \|\
	319	VNIC_STF_STD_PAUSE \|\
	320	VNIC_STF_PFC_PAUSE \|\
	321	0)
01f2e4ea SF	322
	323	struct vnic_devcmd_provinfo {
	324	u8 oui[3];
	325	u8 type;
	326	u8 data[0];
	327	};
	328
	329	/*
	330	* Writing cmd register causes STAT_BUSY to get set in status register.
	331	* When cmd completes, STAT_BUSY will be cleared.
	332	*
	333	* If cmd completed successfully STAT_ERROR will be clear
	334	* and args registers contain cmd-specific results.
	335	*
	336	* If cmd error, STAT_ERROR will be set and args[0] contains error code.
	337	*
	338	* status register is read-only. While STAT_BUSY is set,
	339	* all other register contents are read-only.
	340	*/
	341
	342	/* Make sizeof(vnic_devcmd) a power-of-2 for I/O BAR. */
	343	#define VNIC_DEVCMD_NARGS 15
	344	struct vnic_devcmd {
	345	u32 status; /* RO */
	346	u32 cmd; /* RW */
	347	u64 args[VNIC_DEVCMD_NARGS]; /* RW cmd args (little-endian) */
	348	};
	349
	350	#endif /* _VNIC_DEVCMD_H_ */