Commit | Line | Data |
---|---|---|
01f2e4ea SF |
1 | /* |
2 | * Copyright 2008 Cisco Systems, Inc. All rights reserved. | |
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 | ||
101 | /* hang detection notification */ | |
102 | CMD_HANG_NOTIFY = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 8), | |
103 | ||
104 | /* MAC address in (u48)a0 */ | |
105 | CMD_MAC_ADDR = _CMDC(_CMD_DIR_READ, | |
106 | _CMD_VTYPE_ENET | _CMD_VTYPE_FC, 9), | |
107 | ||
01f2e4ea SF |
108 | /* add addr from (u48)a0 */ |
109 | CMD_ADDR_ADD = _CMDCNW(_CMD_DIR_WRITE, | |
110 | _CMD_VTYPE_ENET | _CMD_VTYPE_FC, 12), | |
111 | ||
112 | /* del addr from (u48)a0 */ | |
113 | CMD_ADDR_DEL = _CMDCNW(_CMD_DIR_WRITE, | |
114 | _CMD_VTYPE_ENET | _CMD_VTYPE_FC, 13), | |
115 | ||
116 | /* add VLAN id in (u16)a0 */ | |
117 | CMD_VLAN_ADD = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 14), | |
118 | ||
119 | /* del VLAN id in (u16)a0 */ | |
120 | CMD_VLAN_DEL = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 15), | |
121 | ||
122 | /* nic_cfg in (u32)a0 */ | |
123 | CMD_NIC_CFG = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 16), | |
124 | ||
125 | /* union vnic_rss_key in mem: (u64)a0=paddr, (u16)a1=len */ | |
126 | CMD_RSS_KEY = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 17), | |
127 | ||
128 | /* union vnic_rss_cpu in mem: (u64)a0=paddr, (u16)a1=len */ | |
129 | CMD_RSS_CPU = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 18), | |
130 | ||
131 | /* initiate softreset */ | |
132 | CMD_SOFT_RESET = _CMDCNW(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 19), | |
133 | ||
134 | /* softreset status: | |
135 | * out: a0=0 reset complete, a0=1 reset in progress */ | |
136 | CMD_SOFT_RESET_STATUS = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 20), | |
137 | ||
138 | /* set struct vnic_devcmd_notify buffer in mem: | |
139 | * in: | |
140 | * (u64)a0=paddr to notify (set paddr=0 to unset) | |
141 | * (u32)a1 & 0x00000000ffffffff=sizeof(struct vnic_devcmd_notify) | |
142 | * (u16)a1 & 0x0000ffff00000000=intr num (-1 for no intr) | |
143 | * out: | |
144 | * (u32)a1 = effective size | |
145 | */ | |
146 | CMD_NOTIFY = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 21), | |
147 | ||
148 | /* UNDI API: (u64)a0=paddr to s_PXENV_UNDI_ struct, | |
149 | * (u8)a1=PXENV_UNDI_xxx */ | |
150 | CMD_UNDI = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 22), | |
151 | ||
152 | /* initiate open sequence (u32)a0=flags (see CMD_OPENF_*) */ | |
153 | CMD_OPEN = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 23), | |
154 | ||
155 | /* open status: | |
156 | * out: a0=0 open complete, a0=1 open in progress */ | |
157 | CMD_OPEN_STATUS = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 24), | |
158 | ||
159 | /* close vnic */ | |
160 | CMD_CLOSE = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 25), | |
161 | ||
162 | /* initialize virtual link: (u32)a0=flags (see CMD_INITF_*) */ | |
27372bf5 SF |
163 | /***** Replaced by CMD_INIT *****/ |
164 | CMD_INIT_v1 = _CMDCNW(_CMD_DIR_READ, _CMD_VTYPE_ALL, 26), | |
01f2e4ea SF |
165 | |
166 | /* variant of CMD_INIT, with provisioning info | |
167 | * (u64)a0=paddr of vnic_devcmd_provinfo | |
168 | * (u32)a1=sizeof provision info */ | |
169 | CMD_INIT_PROV_INFO = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 27), | |
170 | ||
171 | /* enable virtual link */ | |
172 | CMD_ENABLE = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 28), | |
173 | ||
174 | /* disable virtual link */ | |
175 | CMD_DISABLE = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 29), | |
176 | ||
d73149f5 SF |
177 | /* stats dump sum of all vnic stats on same uplink in mem: |
178 | * (u64)a0=paddr | |
179 | * (u16)a1=sizeof stats area */ | |
01f2e4ea SF |
180 | CMD_STATS_DUMP_ALL = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 30), |
181 | ||
182 | /* init status: | |
183 | * out: a0=0 init complete, a0=1 init in progress | |
184 | * if a0=0, a1=errno */ | |
185 | CMD_INIT_STATUS = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 31), | |
186 | ||
187 | /* INT13 API: (u64)a0=paddr to vnic_int13_params struct | |
4cdc44a2 | 188 | * (u32)a1=INT13_CMD_xxx */ |
01f2e4ea SF |
189 | CMD_INT13 = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_FC, 32), |
190 | ||
191 | /* logical uplink enable/disable: (u64)a0: 0/1=disable/enable */ | |
192 | CMD_LOGICAL_UPLINK = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 33), | |
193 | ||
194 | /* undo initialize of virtual link */ | |
195 | CMD_DEINIT = _CMDCNW(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 34), | |
27372bf5 SF |
196 | |
197 | /* initialize virtual link: (u32)a0=flags (see CMD_INITF_*) */ | |
198 | CMD_INIT = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 35), | |
199 | ||
200 | /* check fw capability of a cmd: | |
201 | * in: (u32)a0=cmd | |
202 | * out: (u32)a0=errno, 0:valid cmd, a1=supported VNIC_STF_* bits */ | |
203 | CMD_CAPABILITY = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 36), | |
4cdc44a2 SF |
204 | |
205 | /* persistent binding info | |
206 | * in: (u64)a0=paddr of arg | |
207 | * (u32)a1=CMD_PERBI_XXX */ | |
d73149f5 SF |
208 | CMD_PERBI = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_FC, 37), |
209 | ||
210 | /* Interrupt Assert Register functionality | |
211 | * in: (u16)a0=interrupt number to assert | |
212 | */ | |
213 | CMD_IAR = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 38), | |
01f2e4ea SF |
214 | }; |
215 | ||
216 | /* flags for CMD_OPEN */ | |
217 | #define CMD_OPENF_OPROM 0x1 /* open coming from option rom */ | |
218 | ||
219 | /* flags for CMD_INIT */ | |
220 | #define CMD_INITF_DEFAULT_MAC 0x1 /* init with default mac addr */ | |
221 | ||
222 | /* flags for CMD_PACKET_FILTER */ | |
223 | #define CMD_PFILTER_DIRECTED 0x01 | |
224 | #define CMD_PFILTER_MULTICAST 0x02 | |
225 | #define CMD_PFILTER_BROADCAST 0x04 | |
226 | #define CMD_PFILTER_PROMISCUOUS 0x08 | |
227 | #define CMD_PFILTER_ALL_MULTICAST 0x10 | |
228 | ||
229 | enum vnic_devcmd_status { | |
230 | STAT_NONE = 0, | |
231 | STAT_BUSY = 1 << 0, /* cmd in progress */ | |
232 | STAT_ERROR = 1 << 1, /* last cmd caused error (code in a0) */ | |
233 | }; | |
234 | ||
235 | enum vnic_devcmd_error { | |
236 | ERR_SUCCESS = 0, | |
237 | ERR_EINVAL = 1, | |
238 | ERR_EFAULT = 2, | |
239 | ERR_EPERM = 3, | |
240 | ERR_EBUSY = 4, | |
241 | ERR_ECMDUNKNOWN = 5, | |
242 | ERR_EBADSTATE = 6, | |
243 | ERR_ENOMEM = 7, | |
244 | ERR_ETIMEDOUT = 8, | |
245 | ERR_ELINKDOWN = 9, | |
d73149f5 | 246 | ERR_EMAXRES = 10, |
01f2e4ea SF |
247 | }; |
248 | ||
249 | struct vnic_devcmd_fw_info { | |
250 | char fw_version[32]; | |
251 | char fw_build[32]; | |
252 | char hw_version[32]; | |
253 | char hw_serial_number[32]; | |
254 | }; | |
255 | ||
256 | struct vnic_devcmd_notify { | |
257 | u32 csum; /* checksum over following words */ | |
258 | ||
259 | u32 link_state; /* link up == 1 */ | |
260 | u32 port_speed; /* effective port speed (rate limit) */ | |
261 | u32 mtu; /* MTU */ | |
262 | u32 msglvl; /* requested driver msg lvl */ | |
263 | u32 uif; /* uplink interface */ | |
264 | u32 status; /* status bits (see VNIC_STF_*) */ | |
265 | u32 error; /* error code (see ERR_*) for first ERR */ | |
27372bf5 | 266 | u32 link_down_cnt; /* running count of link down transitions */ |
4cdc44a2 | 267 | u32 perbi_rebuild_cnt; /* running count of perbi rebuilds */ |
01f2e4ea SF |
268 | }; |
269 | #define VNIC_STF_FATAL_ERR 0x0001 /* fatal fw error */ | |
27372bf5 SF |
270 | #define VNIC_STF_STD_PAUSE 0x0002 /* standard link-level pause on */ |
271 | #define VNIC_STF_PFC_PAUSE 0x0004 /* priority flow control pause on */ | |
272 | /* all supported status flags */ | |
273 | #define VNIC_STF_ALL (VNIC_STF_FATAL_ERR |\ | |
274 | VNIC_STF_STD_PAUSE |\ | |
275 | VNIC_STF_PFC_PAUSE |\ | |
276 | 0) | |
01f2e4ea SF |
277 | |
278 | struct vnic_devcmd_provinfo { | |
279 | u8 oui[3]; | |
280 | u8 type; | |
281 | u8 data[0]; | |
282 | }; | |
283 | ||
284 | /* | |
285 | * Writing cmd register causes STAT_BUSY to get set in status register. | |
286 | * When cmd completes, STAT_BUSY will be cleared. | |
287 | * | |
288 | * If cmd completed successfully STAT_ERROR will be clear | |
289 | * and args registers contain cmd-specific results. | |
290 | * | |
291 | * If cmd error, STAT_ERROR will be set and args[0] contains error code. | |
292 | * | |
293 | * status register is read-only. While STAT_BUSY is set, | |
294 | * all other register contents are read-only. | |
295 | */ | |
296 | ||
297 | /* Make sizeof(vnic_devcmd) a power-of-2 for I/O BAR. */ | |
298 | #define VNIC_DEVCMD_NARGS 15 | |
299 | struct vnic_devcmd { | |
300 | u32 status; /* RO */ | |
301 | u32 cmd; /* RW */ | |
302 | u64 args[VNIC_DEVCMD_NARGS]; /* RW cmd args (little-endian) */ | |
303 | }; | |
304 | ||
305 | #endif /* _VNIC_DEVCMD_H_ */ |