2 * Copyright 2008-2010 Cisco Systems, Inc. All rights reserved.
3 * Copyright 2007 Nuova Systems, Inc. All rights reserved.
5 * Copyright (c) 2014, Cisco Systems, Inc.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
30 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 * POSSIBILITY OF SUCH DAMAGE.
35 #ifndef _VNIC_DEVCMD_H_
36 #define _VNIC_DEVCMD_H_
39 #define _CMD_VTYPEBITS 10
40 #define _CMD_FLAGSBITS 6
41 #define _CMD_DIRBITS 2
43 #define _CMD_NMASK ((1 << _CMD_NBITS)-1)
44 #define _CMD_VTYPEMASK ((1 << _CMD_VTYPEBITS)-1)
45 #define _CMD_FLAGSMASK ((1 << _CMD_FLAGSBITS)-1)
46 #define _CMD_DIRMASK ((1 << _CMD_DIRBITS)-1)
49 #define _CMD_VTYPESHIFT (_CMD_NSHIFT+_CMD_NBITS)
50 #define _CMD_FLAGSSHIFT (_CMD_VTYPESHIFT+_CMD_VTYPEBITS)
51 #define _CMD_DIRSHIFT (_CMD_FLAGSSHIFT+_CMD_FLAGSBITS)
54 * Direction bits (from host perspective).
56 #define _CMD_DIR_NONE 0U
57 #define _CMD_DIR_WRITE 1U
58 #define _CMD_DIR_READ 2U
59 #define _CMD_DIR_RW (_CMD_DIR_WRITE | _CMD_DIR_READ)
64 #define _CMD_FLAGS_NONE 0U
65 #define _CMD_FLAGS_NOWAIT 1U
70 #define _CMD_VTYPE_NONE 0U
71 #define _CMD_VTYPE_ENET 1U
72 #define _CMD_VTYPE_FC 2U
73 #define _CMD_VTYPE_SCSI 4U
74 #define _CMD_VTYPE_ALL (_CMD_VTYPE_ENET | _CMD_VTYPE_FC | _CMD_VTYPE_SCSI)
77 * Used to create cmds..
79 #define _CMDCF(dir, flags, vtype, nr) \
80 (((dir) << _CMD_DIRSHIFT) | \
81 ((flags) << _CMD_FLAGSSHIFT) | \
82 ((vtype) << _CMD_VTYPESHIFT) | \
83 ((nr) << _CMD_NSHIFT))
84 #define _CMDC(dir, vtype, nr) _CMDCF(dir, 0, vtype, nr)
85 #define _CMDCNW(dir, vtype, nr) _CMDCF(dir, _CMD_FLAGS_NOWAIT, vtype, nr)
88 * Used to decode cmds..
90 #define _CMD_DIR(cmd) (((cmd) >> _CMD_DIRSHIFT) & _CMD_DIRMASK)
91 #define _CMD_FLAGS(cmd) (((cmd) >> _CMD_FLAGSSHIFT) & _CMD_FLAGSMASK)
92 #define _CMD_VTYPE(cmd) (((cmd) >> _CMD_VTYPESHIFT) & _CMD_VTYPEMASK)
93 #define _CMD_N(cmd) (((cmd) >> _CMD_NSHIFT) & _CMD_NMASK)
95 enum vnic_devcmd_cmd {
96 CMD_NONE = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_NONE, 0),
99 * mcpu fw info in mem:
101 * (u64)a0=paddr to struct vnic_devcmd_fw_info
103 * Fills in struct vnic_devcmd_fw_info (128 bytes)
105 * An old definition of CMD_MCPU_FW_INFO
107 CMD_MCPU_FW_INFO_OLD = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 1),
110 * mcpu fw info in mem:
112 * (u64)a0=paddr to struct vnic_devcmd_fw_info
113 * (u16)a1=size of the structure
115 * (u16)a1=0 for in:a1 = 0,
116 * data size actually written for other values.
118 * Fills in first 128 bytes of vnic_devcmd_fw_info for in:a1 = 0,
119 * first in:a1 bytes for 0 < in:a1 <= 132,
120 * 132 bytes for other values of in:a1.
122 * CMD_MCPU_FW_INFO and CMD_MCPU_FW_INFO_OLD have the same enum 1
123 * for source compatibility.
125 CMD_MCPU_FW_INFO = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 1),
127 /* dev-specific block member:
128 * in: (u16)a0=offset,(u8)a1=size
130 CMD_DEV_SPEC = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 2),
133 CMD_STATS_CLEAR = _CMDCNW(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 3),
135 /* stats dump in mem: (u64)a0=paddr to stats area,
136 * (u16)a1=sizeof stats area */
137 CMD_STATS_DUMP = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 4),
139 /* set Rx packet filter: (u32)a0=filters (see CMD_PFILTER_*) */
140 CMD_PACKET_FILTER = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 7),
142 /* set Rx packet filter for all: (u32)a0=filters (see CMD_PFILTER_*) */
143 CMD_PACKET_FILTER_ALL = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 7),
145 /* hang detection notification */
146 CMD_HANG_NOTIFY = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 8),
148 /* MAC address in (u48)a0 */
149 CMD_GET_MAC_ADDR = _CMDC(_CMD_DIR_READ,
150 _CMD_VTYPE_ENET | _CMD_VTYPE_FC, 9),
152 /* add addr from (u48)a0 */
153 CMD_ADDR_ADD = _CMDCNW(_CMD_DIR_WRITE,
154 _CMD_VTYPE_ENET | _CMD_VTYPE_FC, 12),
156 /* del addr from (u48)a0 */
157 CMD_ADDR_DEL = _CMDCNW(_CMD_DIR_WRITE,
158 _CMD_VTYPE_ENET | _CMD_VTYPE_FC, 13),
160 /* add VLAN id in (u16)a0 */
161 CMD_VLAN_ADD = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 14),
163 /* del VLAN id in (u16)a0 */
164 CMD_VLAN_DEL = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 15),
166 /* nic_cfg in (u32)a0 */
167 CMD_NIC_CFG = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 16),
169 /* union vnic_rss_key in mem: (u64)a0=paddr, (u16)a1=len */
170 CMD_RSS_KEY = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 17),
172 /* union vnic_rss_cpu in mem: (u64)a0=paddr, (u16)a1=len */
173 CMD_RSS_CPU = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 18),
175 /* initiate softreset */
176 CMD_SOFT_RESET = _CMDCNW(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 19),
179 * out: a0=0 reset complete, a0=1 reset in progress */
180 CMD_SOFT_RESET_STATUS = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 20),
182 /* set struct vnic_devcmd_notify buffer in mem:
184 * (u64)a0=paddr to notify (set paddr=0 to unset)
185 * (u32)a1 & 0x00000000ffffffff=sizeof(struct vnic_devcmd_notify)
186 * (u16)a1 & 0x0000ffff00000000=intr num (-1 for no intr)
188 * (u32)a1 = effective size
190 CMD_NOTIFY = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 21),
192 /* UNDI API: (u64)a0=paddr to s_PXENV_UNDI_ struct,
193 * (u8)a1=PXENV_UNDI_xxx */
194 CMD_UNDI = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 22),
196 /* initiate open sequence (u32)a0=flags (see CMD_OPENF_*) */
197 CMD_OPEN = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 23),
200 * out: a0=0 open complete, a0=1 open in progress */
201 CMD_OPEN_STATUS = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 24),
204 CMD_CLOSE = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 25),
206 /* initialize virtual link: (u32)a0=flags (see CMD_INITF_*) */
207 /***** Replaced by CMD_INIT *****/
208 CMD_INIT_v1 = _CMDCNW(_CMD_DIR_READ, _CMD_VTYPE_ALL, 26),
210 /* variant of CMD_INIT, with provisioning info
211 * (u64)a0=paddr of vnic_devcmd_provinfo
212 * (u32)a1=sizeof provision info */
213 CMD_INIT_PROV_INFO = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 27),
215 /* enable virtual link */
216 CMD_ENABLE = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 28),
218 /* enable virtual link, waiting variant. */
219 CMD_ENABLE_WAIT = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 28),
221 /* disable virtual link */
222 CMD_DISABLE = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 29),
224 /* stats dump sum of all vnic stats on same uplink in mem:
226 * (u16)a1=sizeof stats area */
227 CMD_STATS_DUMP_ALL = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 30),
230 * out: a0=0 init complete, a0=1 init in progress
231 * if a0=0, a1=errno */
232 CMD_INIT_STATUS = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 31),
234 /* INT13 API: (u64)a0=paddr to vnic_int13_params struct
235 * (u32)a1=INT13_CMD_xxx */
236 CMD_INT13 = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_FC, 32),
238 /* logical uplink enable/disable: (u64)a0: 0/1=disable/enable */
239 CMD_LOGICAL_UPLINK = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 33),
241 /* undo initialize of virtual link */
242 CMD_DEINIT = _CMDCNW(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 34),
244 /* initialize virtual link: (u32)a0=flags (see CMD_INITF_*) */
245 CMD_INIT = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 35),
247 /* check fw capability of a cmd:
249 * out: (u32)a0=errno, 0:valid cmd, a1=supported VNIC_STF_* bits */
250 CMD_CAPABILITY = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 36),
252 /* persistent binding info
253 * in: (u64)a0=paddr of arg
254 * (u32)a1=CMD_PERBI_XXX */
255 CMD_PERBI = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_FC, 37),
257 /* Interrupt Assert Register functionality
258 * in: (u16)a0=interrupt number to assert
260 CMD_IAR = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 38),
262 /* initiate hangreset, like softreset after hang detected */
263 CMD_HANG_RESET = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 39),
266 * out: a0=0 reset complete, a0=1 reset in progress */
267 CMD_HANG_RESET_STATUS = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 40),
270 * Set hw ingress packet vlan rewrite mode:
271 * in: (u32)a0=new vlan rewrite mode
272 * out: (u32)a0=old vlan rewrite mode */
273 CMD_IG_VLAN_REWRITE_MODE = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ENET, 41),
276 * in: (u16)a0=bdf of target vnic
277 * (u32)a1=cmd to proxy
278 * a2-a15=args to cmd in a1
279 * out: (u32)a0=status of proxied cmd
280 * a1-a15=out args of proxied cmd */
281 CMD_PROXY_BY_BDF = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 42),
284 * As for BY_BDF except a0 is index of hvnlink subordinate vnic
285 * or SR-IOV virtual vnic
287 CMD_PROXY_BY_INDEX = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 43),
292 * in: (u64)a0=phsical address of buffer passed in from caller.
293 * (u16)a1=size of buffer specified in a0.
294 * out: (u64)a0=phsical address of buffer passed in from caller.
295 * (u16)a1=actual bytes from VIF-CONFIG-INFO TLV, or
296 * 0 if no VIF-CONFIG-INFO TLV was ever received. */
297 CMD_CONFIG_INFO_GET = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 44),
300 * INT13 API: (u64)a0=paddr to vnic_int13_params struct
301 * (u32)a1=INT13_CMD_xxx
303 CMD_INT13_ALL = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 45),
307 * in: (u16)a0=new default vlan
308 * (u16)a1=zero for overriding vlan with param a0,
309 * non-zero for resetting vlan to the default
310 * out: (u16)a0=old default vlan
312 CMD_SET_DEFAULT_VLAN = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 46),
315 * Variant of CMD_INIT_PROV_INFO, where it will not try to enable
316 * the vnic until CMD_ENABLE2 is issued.
317 * (u64)a0=paddr of vnic_devcmd_provinfo
318 * (u32)a1=sizeof provision info */
319 CMD_INIT_PROV_INFO2 = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 47),
322 * (u32)a0=0 ==> standby
323 * =CMD_ENABLE2_ACTIVE ==> active
325 CMD_ENABLE2 = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 48),
329 * Returns the status of the specified command
331 * a0 = command for which status is being queried.
332 * Possible values are:
339 * CMD_INIT_PROV_INFO2
342 * if status == STAT_ERROR
343 * a0 = ERR_ENOTSUPPORTED - status for command in a0 is
345 * if status == STAT_NONE
346 * a0 = status of the devcmd specified in a0 as follows.
347 * ERR_SUCCESS - command in a0 completed successfully
348 * ERR_EINPROGRESS - command in a0 is still in progress
350 CMD_STATUS = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 49),
353 * Returns interrupt coalescing timer conversion factors.
354 * After calling this devcmd, ENIC driver can convert
355 * interrupt coalescing timer in usec into CPU cycles as follows:
357 * intr_timer_cycles = intr_timer_usec * multiplier / divisor
359 * Interrupt coalescing timer in usecs can be be converted/obtained
360 * from CPU cycles as follows:
362 * intr_timer_usec = intr_timer_cycles * divisor / multiplier
365 * out: (u32)a0 = multiplier
367 * (u32)a2 = maximum timer value in usec
369 CMD_INTR_COAL_CONVERT = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 50),
373 * in: (u64)a0=paddr of the param or param itself
374 * (u32)a1=ISCSI_CMD_xxx
376 CMD_ISCSI_DUMP_REQ = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 51),
379 * ISCSI DUMP STATUS API:
380 * in: (u32)a0=cmd tag
381 * in: (u32)a1=ISCSI_CMD_xxx
382 * out: (u32)a0=cmd status
384 CMD_ISCSI_DUMP_STATUS = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 52),
387 * Subvnic migration from MQ <--> VF.
388 * Enable the LIF migration from MQ to VF and vice versa. MQ and VF
389 * indexes are statically bound at the time of initialization.
391 * direction of migration, the resources of either MQ or the VF shall
392 * be attached to the LIF.
393 * in: (u32)a0=Direction of Migration
396 * (u32)a1=VF index (MQ index)
398 CMD_MIGRATE_SUBVNIC = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 53),
402 * Register / Deregister the notification block for MQ subvnics
404 * (u64)a0=paddr to notify (set paddr=0 to unset)
405 * (u32)a1 & 0x00000000ffffffff=sizeof(struct vnic_devcmd_notify)
406 * (u16)a1 & 0x0000ffff00000000=intr num (-1 for no intr)
408 * (u32)a1 = effective size
410 CMD_SUBVNIC_NOTIFY = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 54),
413 * Set the predefined mac address as default
417 CMD_SET_MAC_ADDR = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 55),
419 /* Update the provisioning info of the given VIF
420 * (u64)a0=paddr of vnic_devcmd_provinfo
421 * (u32)a1=sizeof provision info */
422 CMD_PROV_INFO_UPDATE = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 56),
425 * Initialization for the devcmd2 interface.
426 * in: (u64) a0=host result buffer physical address
427 * in: (u16) a1=number of entries in result buffer
429 CMD_INITIALIZE_DEVCMD2 = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 57),
433 * in: (u64) a0= filter address
434 * (u32) a1= size of filter
435 * out: (u32) a0=filter identifier
437 CMD_ADD_FILTER = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ENET, 58),
441 * in: (u32) a0=filter identifier
443 CMD_DEL_FILTER = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 59),
446 * Enable a Queue Pair in User space NIC
447 * in: (u32) a0=Queue Pair number
450 CMD_QP_ENABLE = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 60),
453 * Disable a Queue Pair in User space NIC
454 * in: (u32) a0=Queue Pair number
457 CMD_QP_DISABLE = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 61),
460 * Stats dump Queue Pair in User space NIC
461 * in: (u32) a0=Queue Pair number
462 * (u64) a1=host buffer addr for status dump
463 * (u32) a2=length of the buffer
465 CMD_QP_STATS_DUMP = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 62),
468 * Clear stats for Queue Pair in User space NIC
469 * in: (u32) a0=Queue Pair number
471 CMD_QP_STATS_CLEAR = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 63),
474 * Enable/Disable overlay offloads on the given vnic
475 * in: (u8) a0 = OVERLAY_FEATURE_NVGRE : NVGRE
476 * a0 = OVERLAY_FEATURE_VXLAN : VxLAN
477 * in: (u8) a1 = OVERLAY_OFFLOAD_ENABLE : Enable
478 * a1 = OVERLAY_OFFLOAD_DISABLE : Disable
480 CMD_OVERLAY_OFFLOAD_ENABLE_DISABLE =
481 _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 72),
484 * Configuration of overlay offloads feature on a given vNIC
485 * in: (u8) a0 = DEVCMD_OVERLAY_NVGRE : NVGRE
486 * a0 = DEVCMD_OVERLAY_VXLAN : VxLAN
487 * in: (u8) a1 = VXLAN_PORT_UPDATE : VxLAN
488 * in: (u16) a2 = unsigned short int port information
490 CMD_OVERLAY_OFFLOAD_CFG = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 73),
493 /* CMD_ENABLE2 flags */
494 #define CMD_ENABLE2_STANDBY 0x0
495 #define CMD_ENABLE2_ACTIVE 0x1
497 /* flags for CMD_OPEN */
498 #define CMD_OPENF_OPROM 0x1 /* open coming from option rom */
500 /* flags for CMD_INIT */
501 #define CMD_INITF_DEFAULT_MAC 0x1 /* init with default mac addr */
503 /* flags for CMD_PACKET_FILTER */
504 #define CMD_PFILTER_DIRECTED 0x01
505 #define CMD_PFILTER_MULTICAST 0x02
506 #define CMD_PFILTER_BROADCAST 0x04
507 #define CMD_PFILTER_PROMISCUOUS 0x08
508 #define CMD_PFILTER_ALL_MULTICAST 0x10
510 /* Commands for CMD_QP_ENABLE/CM_QP_DISABLE */
511 #define CMD_QP_RQWQ 0x0
513 /* rewrite modes for CMD_IG_VLAN_REWRITE_MODE */
514 #define IG_VLAN_REWRITE_MODE_DEFAULT_TRUNK 0
515 #define IG_VLAN_REWRITE_MODE_UNTAG_DEFAULT_VLAN 1
516 #define IG_VLAN_REWRITE_MODE_PRIORITY_TAG_DEFAULT_VLAN 2
517 #define IG_VLAN_REWRITE_MODE_PASS_THRU 3
519 enum vnic_devcmd_status {
521 STAT_BUSY = 1 << 0, /* cmd in progress */
522 STAT_ERROR = 1 << 1, /* last cmd caused error (code in a0) */
525 enum vnic_devcmd_error {
537 ERR_ENOTSUPPORTED = 11,
538 ERR_EINPROGRESS = 12,
543 * note: hw_version and asic_rev refer to the same thing,
544 * but have different formats. hw_version is
545 * a 32-byte string (e.g. "A2") and asic_rev is
546 * a 16-bit integer (e.g. 0xA2).
548 struct vnic_devcmd_fw_info {
552 char hw_serial_number[32];
557 enum fwinfo_asic_type {
558 FWINFO_ASIC_TYPE_UNKNOWN,
559 FWINFO_ASIC_TYPE_PALO,
560 FWINFO_ASIC_TYPE_SERENO,
564 struct vnic_devcmd_notify {
565 u32 csum; /* checksum over following words */
567 u32 link_state; /* link up == 1 */
568 u32 port_speed; /* effective port speed (rate limit) */
570 u32 msglvl; /* requested driver msg lvl */
571 u32 uif; /* uplink interface */
572 u32 status; /* status bits (see VNIC_STF_*) */
573 u32 error; /* error code (see ERR_*) for first ERR */
574 u32 link_down_cnt; /* running count of link down transitions */
575 u32 perbi_rebuild_cnt; /* running count of perbi rebuilds */
577 #define VNIC_STF_FATAL_ERR 0x0001 /* fatal fw error */
578 #define VNIC_STF_STD_PAUSE 0x0002 /* standard link-level pause on */
579 #define VNIC_STF_PFC_PAUSE 0x0004 /* priority flow control pause on */
580 /* all supported status flags */
581 #define VNIC_STF_ALL (VNIC_STF_FATAL_ERR |\
582 VNIC_STF_STD_PAUSE |\
583 VNIC_STF_PFC_PAUSE |\
586 struct vnic_devcmd_provinfo {
593 * These are used in flags field of different filters to denote
596 #define FILTER_FIELD_VALID(fld) (1 << (fld - 1))
598 #define FILTER_FIELDS_USNIC (FILTER_FIELD_VALID(1) | \
599 FILTER_FIELD_VALID(2) | \
600 FILTER_FIELD_VALID(3) | \
601 FILTER_FIELD_VALID(4))
603 #define FILTER_FIELDS_IPV4_5TUPLE (FILTER_FIELD_VALID(1) | \
604 FILTER_FIELD_VALID(2) | \
605 FILTER_FIELD_VALID(3) | \
606 FILTER_FIELD_VALID(4) | \
607 FILTER_FIELD_VALID(5))
609 #define FILTER_FIELDS_MAC_VLAN (FILTER_FIELD_VALID(1) | \
610 FILTER_FIELD_VALID(2))
612 #define FILTER_FIELD_USNIC_VLAN FILTER_FIELD_VALID(1)
613 #define FILTER_FIELD_USNIC_ETHTYPE FILTER_FIELD_VALID(2)
614 #define FILTER_FIELD_USNIC_PROTO FILTER_FIELD_VALID(3)
615 #define FILTER_FIELD_USNIC_ID FILTER_FIELD_VALID(4)
617 struct filter_usnic_id {
623 } __attribute__((packed));
625 #define FILTER_FIELD_5TUP_PROTO FILTER_FIELD_VALID(1)
626 #define FILTER_FIELD_5TUP_SRC_AD FILTER_FIELD_VALID(2)
627 #define FILTER_FIELD_5TUP_DST_AD FILTER_FIELD_VALID(3)
628 #define FILTER_FIELD_5TUP_SRC_PT FILTER_FIELD_VALID(4)
629 #define FILTER_FIELD_5TUP_DST_PT FILTER_FIELD_VALID(5)
631 /* Enums for the protocol field. */
637 struct filter_ipv4_5tuple {
644 } __attribute__((packed));
646 #define FILTER_FIELD_VMQ_VLAN FILTER_FIELD_VALID(1)
647 #define FILTER_FIELD_VMQ_MAC FILTER_FIELD_VALID(2)
649 struct filter_mac_vlan {
653 } __attribute__((packed));
655 /* Specifies the filter_action type. */
657 FILTER_ACTION_RQ_STEERING = 0,
661 struct filter_action {
666 } __attribute__((packed));
668 /* Specifies the filter type. */
671 FILTER_IPV4_5TUPLE = 1,
679 struct filter_usnic_id usnic;
680 struct filter_ipv4_5tuple ipv4;
681 struct filter_mac_vlan mac_vlan;
683 } __attribute__((packed));
690 #define FILTER_MAX_BUF_SIZE 100 /* Maximum size of buffer to CMD_ADD_FILTER */
704 * Writing cmd register causes STAT_BUSY to get set in status register.
705 * When cmd completes, STAT_BUSY will be cleared.
707 * If cmd completed successfully STAT_ERROR will be clear
708 * and args registers contain cmd-specific results.
710 * If cmd error, STAT_ERROR will be set and args[0] contains error code.
712 * status register is read-only. While STAT_BUSY is set,
713 * all other register contents are read-only.
716 /* Make sizeof(vnic_devcmd) a power-of-2 for I/O BAR. */
717 #define VNIC_DEVCMD_NARGS 15
721 u64 args[VNIC_DEVCMD_NARGS]; /* RW cmd args (little-endian) */
725 * Version 2 of the interface.
727 * Some things are carried over, notably the vnic_devcmd_cmd enum.
731 * Flags for vnic_devcmd2.flags
734 #define DEVCMD2_FNORESULT 0x1 /* Don't copy result to host */
736 #define VNIC_DEVCMD2_NARGS VNIC_DEVCMD_NARGS
737 struct vnic_devcmd2 {
740 u32 cmd; /* same command #defines as original */
741 u64 args[VNIC_DEVCMD2_NARGS];
744 #define VNIC_DEVCMD2_NRESULTS VNIC_DEVCMD_NARGS
745 struct devcmd2_result {
746 u64 results[VNIC_DEVCMD2_NRESULTS];
748 u16 completed_index; /* into copy WQ */
749 u8 error; /* same error codes as original */
750 u8 color; /* 0 or 1 as with completion queues */
753 #define DEVCMD2_RING_SIZE 32
754 #define DEVCMD2_DESC_SIZE 128
756 #define DEVCMD2_RESULTS_SIZE_MAX ((1 << 16) - 1)
758 /* Overlay related definitions */
761 * This enum lists the flag associated with each of the overlay features
764 OVERLAY_FEATURE_NVGRE = 1,
765 OVERLAY_FEATURE_VXLAN,
769 #define OVERLAY_OFFLOAD_ENABLE 0
770 #define OVERLAY_OFFLOAD_DISABLE 1
772 #define OVERLAY_CFG_VXLAN_PORT_UPDATE 0
773 #endif /* _VNIC_DEVCMD_H_ */