2 * Copyright 2008 Cisco Systems, Inc. All rights reserved.
3 * Copyright 2007 Nuova Systems, Inc. All rights reserved.
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.
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
18 #ifndef _VNIC_DEVCMD_H_
19 #define _VNIC_DEVCMD_H_
22 #define _CMD_VTYPEBITS 10
23 #define _CMD_FLAGSBITS 6
24 #define _CMD_DIRBITS 2
26 #define _CMD_NMASK ((1 << _CMD_NBITS)-1)
27 #define _CMD_VTYPEMASK ((1 << _CMD_VTYPEBITS)-1)
28 #define _CMD_FLAGSMASK ((1 << _CMD_FLAGSBITS)-1)
29 #define _CMD_DIRMASK ((1 << _CMD_DIRBITS)-1)
32 #define _CMD_VTYPESHIFT (_CMD_NSHIFT+_CMD_NBITS)
33 #define _CMD_FLAGSSHIFT (_CMD_VTYPESHIFT+_CMD_VTYPEBITS)
34 #define _CMD_DIRSHIFT (_CMD_FLAGSSHIFT+_CMD_FLAGSBITS)
37 * Direction bits (from host perspective).
39 #define _CMD_DIR_NONE 0U
40 #define _CMD_DIR_WRITE 1U
41 #define _CMD_DIR_READ 2U
42 #define _CMD_DIR_RW (_CMD_DIR_WRITE | _CMD_DIR_READ)
47 #define _CMD_FLAGS_NONE 0U
48 #define _CMD_FLAGS_NOWAIT 1U
53 #define _CMD_VTYPE_NONE 0U
54 #define _CMD_VTYPE_ENET 1U
55 #define _CMD_VTYPE_FC 2U
56 #define _CMD_VTYPE_SCSI 4U
57 #define _CMD_VTYPE_ALL (_CMD_VTYPE_ENET | _CMD_VTYPE_FC | _CMD_VTYPE_SCSI)
60 * Used to create cmds..
62 #define _CMDCF(dir, flags, vtype, nr) \
63 (((dir) << _CMD_DIRSHIFT) | \
64 ((flags) << _CMD_FLAGSSHIFT) | \
65 ((vtype) << _CMD_VTYPESHIFT) | \
66 ((nr) << _CMD_NSHIFT))
67 #define _CMDC(dir, vtype, nr) _CMDCF(dir, 0, vtype, nr)
68 #define _CMDCNW(dir, vtype, nr) _CMDCF(dir, _CMD_FLAGS_NOWAIT, vtype, nr)
71 * Used to decode cmds..
73 #define _CMD_DIR(cmd) (((cmd) >> _CMD_DIRSHIFT) & _CMD_DIRMASK)
74 #define _CMD_FLAGS(cmd) (((cmd) >> _CMD_FLAGSSHIFT) & _CMD_FLAGSMASK)
75 #define _CMD_VTYPE(cmd) (((cmd) >> _CMD_VTYPESHIFT) & _CMD_VTYPEMASK)
76 #define _CMD_N(cmd) (((cmd) >> _CMD_NSHIFT) & _CMD_NMASK)
78 enum vnic_devcmd_cmd
{
79 CMD_NONE
= _CMDC(_CMD_DIR_NONE
, _CMD_VTYPE_NONE
, 0),
81 /* mcpu fw info in mem: (u64)a0=paddr to struct vnic_devcmd_fw_info */
82 CMD_MCPU_FW_INFO
= _CMDC(_CMD_DIR_WRITE
, _CMD_VTYPE_ALL
, 1),
84 /* dev-specific block member:
85 * in: (u16)a0=offset,(u8)a1=size
87 CMD_DEV_SPEC
= _CMDC(_CMD_DIR_RW
, _CMD_VTYPE_ALL
, 2),
90 CMD_STATS_CLEAR
= _CMDCNW(_CMD_DIR_NONE
, _CMD_VTYPE_ALL
, 3),
92 /* stats dump in mem: (u64)a0=paddr to stats area,
93 * (u16)a1=sizeof stats area */
94 CMD_STATS_DUMP
= _CMDC(_CMD_DIR_WRITE
, _CMD_VTYPE_ALL
, 4),
96 /* set Rx packet filter: (u32)a0=filters (see CMD_PFILTER_*) */
97 CMD_PACKET_FILTER
= _CMDCNW(_CMD_DIR_WRITE
, _CMD_VTYPE_ALL
, 7),
99 /* hang detection notification */
100 CMD_HANG_NOTIFY
= _CMDC(_CMD_DIR_NONE
, _CMD_VTYPE_ALL
, 8),
102 /* MAC address in (u48)a0 */
103 CMD_MAC_ADDR
= _CMDC(_CMD_DIR_READ
,
104 _CMD_VTYPE_ENET
| _CMD_VTYPE_FC
, 9),
106 /* disable/enable promisc mode: (u8)a0=0/1 */
107 CMD_PROMISC_MODE
= _CMDCNW(_CMD_DIR_WRITE
, _CMD_VTYPE_ENET
, 10),
109 /* disable/enable all-multi mode: (u8)a0=0/1 */
110 CMD_ALLMULTI_MODE
= _CMDCNW(_CMD_DIR_WRITE
, _CMD_VTYPE_ENET
, 11),
112 /* add addr from (u48)a0 */
113 CMD_ADDR_ADD
= _CMDCNW(_CMD_DIR_WRITE
,
114 _CMD_VTYPE_ENET
| _CMD_VTYPE_FC
, 12),
116 /* del addr from (u48)a0 */
117 CMD_ADDR_DEL
= _CMDCNW(_CMD_DIR_WRITE
,
118 _CMD_VTYPE_ENET
| _CMD_VTYPE_FC
, 13),
120 /* add VLAN id in (u16)a0 */
121 CMD_VLAN_ADD
= _CMDCNW(_CMD_DIR_WRITE
, _CMD_VTYPE_ENET
, 14),
123 /* del VLAN id in (u16)a0 */
124 CMD_VLAN_DEL
= _CMDCNW(_CMD_DIR_WRITE
, _CMD_VTYPE_ENET
, 15),
126 /* nic_cfg in (u32)a0 */
127 CMD_NIC_CFG
= _CMDCNW(_CMD_DIR_WRITE
, _CMD_VTYPE_ALL
, 16),
129 /* union vnic_rss_key in mem: (u64)a0=paddr, (u16)a1=len */
130 CMD_RSS_KEY
= _CMDC(_CMD_DIR_WRITE
, _CMD_VTYPE_ENET
, 17),
132 /* union vnic_rss_cpu in mem: (u64)a0=paddr, (u16)a1=len */
133 CMD_RSS_CPU
= _CMDC(_CMD_DIR_WRITE
, _CMD_VTYPE_ENET
, 18),
135 /* initiate softreset */
136 CMD_SOFT_RESET
= _CMDCNW(_CMD_DIR_NONE
, _CMD_VTYPE_ALL
, 19),
139 * out: a0=0 reset complete, a0=1 reset in progress */
140 CMD_SOFT_RESET_STATUS
= _CMDC(_CMD_DIR_READ
, _CMD_VTYPE_ALL
, 20),
142 /* set struct vnic_devcmd_notify buffer in mem:
144 * (u64)a0=paddr to notify (set paddr=0 to unset)
145 * (u32)a1 & 0x00000000ffffffff=sizeof(struct vnic_devcmd_notify)
146 * (u16)a1 & 0x0000ffff00000000=intr num (-1 for no intr)
148 * (u32)a1 = effective size
150 CMD_NOTIFY
= _CMDC(_CMD_DIR_RW
, _CMD_VTYPE_ALL
, 21),
152 /* UNDI API: (u64)a0=paddr to s_PXENV_UNDI_ struct,
153 * (u8)a1=PXENV_UNDI_xxx */
154 CMD_UNDI
= _CMDC(_CMD_DIR_WRITE
, _CMD_VTYPE_ENET
, 22),
156 /* initiate open sequence (u32)a0=flags (see CMD_OPENF_*) */
157 CMD_OPEN
= _CMDCNW(_CMD_DIR_WRITE
, _CMD_VTYPE_ALL
, 23),
160 * out: a0=0 open complete, a0=1 open in progress */
161 CMD_OPEN_STATUS
= _CMDC(_CMD_DIR_READ
, _CMD_VTYPE_ALL
, 24),
164 CMD_CLOSE
= _CMDC(_CMD_DIR_NONE
, _CMD_VTYPE_ALL
, 25),
166 /* initialize virtual link: (u32)a0=flags (see CMD_INITF_*) */
167 CMD_INIT
= _CMDCNW(_CMD_DIR_READ
, _CMD_VTYPE_ALL
, 26),
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),
174 /* enable virtual link */
175 CMD_ENABLE
= _CMDCNW(_CMD_DIR_WRITE
, _CMD_VTYPE_ALL
, 28),
177 /* disable virtual link */
178 CMD_DISABLE
= _CMDC(_CMD_DIR_NONE
, _CMD_VTYPE_ALL
, 29),
180 /* stats dump all vnics on uplink in mem: (u64)a0=paddr (u32)a1=uif */
181 CMD_STATS_DUMP_ALL
= _CMDC(_CMD_DIR_WRITE
, _CMD_VTYPE_ALL
, 30),
184 * out: a0=0 init complete, a0=1 init in progress
185 * if a0=0, a1=errno */
186 CMD_INIT_STATUS
= _CMDC(_CMD_DIR_READ
, _CMD_VTYPE_ALL
, 31),
188 /* INT13 API: (u64)a0=paddr to vnic_int13_params struct
189 * (u8)a1=INT13_CMD_xxx */
190 CMD_INT13
= _CMDC(_CMD_DIR_WRITE
, _CMD_VTYPE_FC
, 32),
192 /* logical uplink enable/disable: (u64)a0: 0/1=disable/enable */
193 CMD_LOGICAL_UPLINK
= _CMDCNW(_CMD_DIR_WRITE
, _CMD_VTYPE_ENET
, 33),
195 /* undo initialize of virtual link */
196 CMD_DEINIT
= _CMDCNW(_CMD_DIR_NONE
, _CMD_VTYPE_ALL
, 34),
199 /* flags for CMD_OPEN */
200 #define CMD_OPENF_OPROM 0x1 /* open coming from option rom */
202 /* flags for CMD_INIT */
203 #define CMD_INITF_DEFAULT_MAC 0x1 /* init with default mac addr */
205 /* flags for CMD_PACKET_FILTER */
206 #define CMD_PFILTER_DIRECTED 0x01
207 #define CMD_PFILTER_MULTICAST 0x02
208 #define CMD_PFILTER_BROADCAST 0x04
209 #define CMD_PFILTER_PROMISCUOUS 0x08
210 #define CMD_PFILTER_ALL_MULTICAST 0x10
212 enum vnic_devcmd_status
{
214 STAT_BUSY
= 1 << 0, /* cmd in progress */
215 STAT_ERROR
= 1 << 1, /* last cmd caused error (code in a0) */
218 enum vnic_devcmd_error
{
231 struct vnic_devcmd_fw_info
{
235 char hw_serial_number
[32];
238 struct vnic_devcmd_notify
{
239 u32 csum
; /* checksum over following words */
241 u32 link_state
; /* link up == 1 */
242 u32 port_speed
; /* effective port speed (rate limit) */
244 u32 msglvl
; /* requested driver msg lvl */
245 u32 uif
; /* uplink interface */
246 u32 status
; /* status bits (see VNIC_STF_*) */
247 u32 error
; /* error code (see ERR_*) for first ERR */
248 u32 link_down_cnt
; /* running count of link down transitions */
250 #define VNIC_STF_FATAL_ERR 0x0001 /* fatal fw error */
252 struct vnic_devcmd_provinfo
{
259 * Writing cmd register causes STAT_BUSY to get set in status register.
260 * When cmd completes, STAT_BUSY will be cleared.
262 * If cmd completed successfully STAT_ERROR will be clear
263 * and args registers contain cmd-specific results.
265 * If cmd error, STAT_ERROR will be set and args[0] contains error code.
267 * status register is read-only. While STAT_BUSY is set,
268 * all other register contents are read-only.
271 /* Make sizeof(vnic_devcmd) a power-of-2 for I/O BAR. */
272 #define VNIC_DEVCMD_NARGS 15
276 u64 args
[VNIC_DEVCMD_NARGS
]; /* RW cmd args (little-endian) */
279 #endif /* _VNIC_DEVCMD_H_ */