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.
34 #ident "$Id: vnic_devcmd.h 173135 2014-05-16 03:14:07Z sanpilla $"
36 #ifndef _VNIC_DEVCMD_H_
37 #define _VNIC_DEVCMD_H_
40 #define _CMD_VTYPEBITS 10
41 #define _CMD_FLAGSBITS 6
42 #define _CMD_DIRBITS 2
44 #define _CMD_NMASK ((1 << _CMD_NBITS)-1)
45 #define _CMD_VTYPEMASK ((1 << _CMD_VTYPEBITS)-1)
46 #define _CMD_FLAGSMASK ((1 << _CMD_FLAGSBITS)-1)
47 #define _CMD_DIRMASK ((1 << _CMD_DIRBITS)-1)
50 #define _CMD_VTYPESHIFT (_CMD_NSHIFT+_CMD_NBITS)
51 #define _CMD_FLAGSSHIFT (_CMD_VTYPESHIFT+_CMD_VTYPEBITS)
52 #define _CMD_DIRSHIFT (_CMD_FLAGSSHIFT+_CMD_FLAGSBITS)
55 * Direction bits (from host perspective).
57 #define _CMD_DIR_NONE 0U
58 #define _CMD_DIR_WRITE 1U
59 #define _CMD_DIR_READ 2U
60 #define _CMD_DIR_RW (_CMD_DIR_WRITE | _CMD_DIR_READ)
65 #define _CMD_FLAGS_NONE 0U
66 #define _CMD_FLAGS_NOWAIT 1U
71 #define _CMD_VTYPE_NONE 0U
72 #define _CMD_VTYPE_ENET 1U
73 #define _CMD_VTYPE_FC 2U
74 #define _CMD_VTYPE_SCSI 4U
75 #define _CMD_VTYPE_ALL (_CMD_VTYPE_ENET | _CMD_VTYPE_FC | _CMD_VTYPE_SCSI)
78 * Used to create cmds..
80 #define _CMDCF(dir, flags, vtype, nr) \
81 (((dir) << _CMD_DIRSHIFT) | \
82 ((flags) << _CMD_FLAGSSHIFT) | \
83 ((vtype) << _CMD_VTYPESHIFT) | \
84 ((nr) << _CMD_NSHIFT))
85 #define _CMDC(dir, vtype, nr) _CMDCF(dir, 0, vtype, nr)
86 #define _CMDCNW(dir, vtype, nr) _CMDCF(dir, _CMD_FLAGS_NOWAIT, vtype, nr)
89 * Used to decode cmds..
91 #define _CMD_DIR(cmd) (((cmd) >> _CMD_DIRSHIFT) & _CMD_DIRMASK)
92 #define _CMD_FLAGS(cmd) (((cmd) >> _CMD_FLAGSSHIFT) & _CMD_FLAGSMASK)
93 #define _CMD_VTYPE(cmd) (((cmd) >> _CMD_VTYPESHIFT) & _CMD_VTYPEMASK)
94 #define _CMD_N(cmd) (((cmd) >> _CMD_NSHIFT) & _CMD_NMASK)
96 enum vnic_devcmd_cmd {
97 CMD_NONE = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_NONE, 0),
100 * mcpu fw info in mem:
102 * (u64)a0=paddr to struct vnic_devcmd_fw_info
104 * Fills in struct vnic_devcmd_fw_info (128 bytes)
106 * An old definition of CMD_MCPU_FW_INFO
108 CMD_MCPU_FW_INFO_OLD = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 1),
111 * mcpu fw info in mem:
113 * (u64)a0=paddr to struct vnic_devcmd_fw_info
114 * (u16)a1=size of the structure
116 * (u16)a1=0 for in:a1 = 0,
117 * data size actually written for other values.
119 * Fills in first 128 bytes of vnic_devcmd_fw_info for in:a1 = 0,
120 * first in:a1 bytes for 0 < in:a1 <= 132,
121 * 132 bytes for other values of in:a1.
123 * CMD_MCPU_FW_INFO and CMD_MCPU_FW_INFO_OLD have the same enum 1
124 * for source compatibility.
126 CMD_MCPU_FW_INFO = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 1),
128 /* dev-specific block member:
129 * in: (u16)a0=offset,(u8)a1=size
131 CMD_DEV_SPEC = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 2),
134 CMD_STATS_CLEAR = _CMDCNW(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 3),
136 /* stats dump in mem: (u64)a0=paddr to stats area,
137 * (u16)a1=sizeof stats area */
138 CMD_STATS_DUMP = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 4),
140 /* set Rx packet filter: (u32)a0=filters (see CMD_PFILTER_*) */
141 CMD_PACKET_FILTER = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 7),
143 /* set Rx packet filter for all: (u32)a0=filters (see CMD_PFILTER_*) */
144 CMD_PACKET_FILTER_ALL = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 7),
146 /* hang detection notification */
147 CMD_HANG_NOTIFY = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 8),
149 /* MAC address in (u48)a0 */
150 CMD_GET_MAC_ADDR = _CMDC(_CMD_DIR_READ,
151 _CMD_VTYPE_ENET | _CMD_VTYPE_FC, 9),
153 /* add addr from (u48)a0 */
154 CMD_ADDR_ADD = _CMDCNW(_CMD_DIR_WRITE,
155 _CMD_VTYPE_ENET | _CMD_VTYPE_FC, 12),
157 /* del addr from (u48)a0 */
158 CMD_ADDR_DEL = _CMDCNW(_CMD_DIR_WRITE,
159 _CMD_VTYPE_ENET | _CMD_VTYPE_FC, 13),
161 /* add VLAN id in (u16)a0 */
162 CMD_VLAN_ADD = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 14),
164 /* del VLAN id in (u16)a0 */
165 CMD_VLAN_DEL = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 15),
167 /* nic_cfg in (u32)a0 */
168 CMD_NIC_CFG = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 16),
170 /* union vnic_rss_key in mem: (u64)a0=paddr, (u16)a1=len */
171 CMD_RSS_KEY = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 17),
173 /* union vnic_rss_cpu in mem: (u64)a0=paddr, (u16)a1=len */
174 CMD_RSS_CPU = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 18),
176 /* initiate softreset */
177 CMD_SOFT_RESET = _CMDCNW(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 19),
180 * out: a0=0 reset complete, a0=1 reset in progress */
181 CMD_SOFT_RESET_STATUS = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 20),
183 /* set struct vnic_devcmd_notify buffer in mem:
185 * (u64)a0=paddr to notify (set paddr=0 to unset)
186 * (u32)a1 & 0x00000000ffffffff=sizeof(struct vnic_devcmd_notify)
187 * (u16)a1 & 0x0000ffff00000000=intr num (-1 for no intr)
189 * (u32)a1 = effective size
191 CMD_NOTIFY = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 21),
193 /* UNDI API: (u64)a0=paddr to s_PXENV_UNDI_ struct,
194 * (u8)a1=PXENV_UNDI_xxx */
195 CMD_UNDI = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 22),
197 /* initiate open sequence (u32)a0=flags (see CMD_OPENF_*) */
198 CMD_OPEN = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 23),
201 * out: a0=0 open complete, a0=1 open in progress */
202 CMD_OPEN_STATUS = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 24),
205 CMD_CLOSE = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 25),
207 /* initialize virtual link: (u32)a0=flags (see CMD_INITF_*) */
208 /***** Replaced by CMD_INIT *****/
209 CMD_INIT_v1 = _CMDCNW(_CMD_DIR_READ, _CMD_VTYPE_ALL, 26),
211 /* variant of CMD_INIT, with provisioning info
212 * (u64)a0=paddr of vnic_devcmd_provinfo
213 * (u32)a1=sizeof provision info */
214 CMD_INIT_PROV_INFO = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 27),
216 /* enable virtual link */
217 CMD_ENABLE = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 28),
219 /* enable virtual link, waiting variant. */
220 CMD_ENABLE_WAIT = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 28),
222 /* disable virtual link */
223 CMD_DISABLE = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 29),
225 /* stats dump sum of all vnic stats on same uplink in mem:
227 * (u16)a1=sizeof stats area */
228 CMD_STATS_DUMP_ALL = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 30),
231 * out: a0=0 init complete, a0=1 init in progress
232 * if a0=0, a1=errno */
233 CMD_INIT_STATUS = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 31),
235 /* INT13 API: (u64)a0=paddr to vnic_int13_params struct
236 * (u32)a1=INT13_CMD_xxx */
237 CMD_INT13 = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_FC, 32),
239 /* logical uplink enable/disable: (u64)a0: 0/1=disable/enable */
240 CMD_LOGICAL_UPLINK = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 33),
242 /* undo initialize of virtual link */
243 CMD_DEINIT = _CMDCNW(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 34),
245 /* initialize virtual link: (u32)a0=flags (see CMD_INITF_*) */
246 CMD_INIT = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 35),
248 /* check fw capability of a cmd:
250 * out: (u32)a0=errno, 0:valid cmd, a1=supported VNIC_STF_* bits */
251 CMD_CAPABILITY = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 36),
253 /* persistent binding info
254 * in: (u64)a0=paddr of arg
255 * (u32)a1=CMD_PERBI_XXX */
256 CMD_PERBI = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_FC, 37),
258 /* Interrupt Assert Register functionality
259 * in: (u16)a0=interrupt number to assert
261 CMD_IAR = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 38),
263 /* initiate hangreset, like softreset after hang detected */
264 CMD_HANG_RESET = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 39),
267 * out: a0=0 reset complete, a0=1 reset in progress */
268 CMD_HANG_RESET_STATUS = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 40),
271 * Set hw ingress packet vlan rewrite mode:
272 * in: (u32)a0=new vlan rewrite mode
273 * out: (u32)a0=old vlan rewrite mode */
274 CMD_IG_VLAN_REWRITE_MODE = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ENET, 41),
277 * in: (u16)a0=bdf of target vnic
278 * (u32)a1=cmd to proxy
279 * a2-a15=args to cmd in a1
280 * out: (u32)a0=status of proxied cmd
281 * a1-a15=out args of proxied cmd */
282 CMD_PROXY_BY_BDF = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 42),
285 * As for BY_BDF except a0 is index of hvnlink subordinate vnic
286 * or SR-IOV virtual vnic
288 CMD_PROXY_BY_INDEX = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 43),
293 * in: (u64)a0=phsical address of buffer passed in from caller.
294 * (u16)a1=size of buffer specified in a0.
295 * out: (u64)a0=phsical address of buffer passed in from caller.
296 * (u16)a1=actual bytes from VIF-CONFIG-INFO TLV, or
297 * 0 if no VIF-CONFIG-INFO TLV was ever received. */
298 CMD_CONFIG_INFO_GET = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 44),
301 * INT13 API: (u64)a0=paddr to vnic_int13_params struct
302 * (u32)a1=INT13_CMD_xxx
304 CMD_INT13_ALL = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 45),
308 * in: (u16)a0=new default vlan
309 * (u16)a1=zero for overriding vlan with param a0,
310 * non-zero for resetting vlan to the default
311 * out: (u16)a0=old default vlan
313 CMD_SET_DEFAULT_VLAN = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 46),
316 * Variant of CMD_INIT_PROV_INFO, where it will not try to enable
317 * the vnic until CMD_ENABLE2 is issued.
318 * (u64)a0=paddr of vnic_devcmd_provinfo
319 * (u32)a1=sizeof provision info */
320 CMD_INIT_PROV_INFO2 = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 47),
323 * (u32)a0=0 ==> standby
324 * =CMD_ENABLE2_ACTIVE ==> active
326 CMD_ENABLE2 = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 48),
330 * Returns the status of the specified command
332 * a0 = command for which status is being queried.
333 * Possible values are:
340 * CMD_INIT_PROV_INFO2
343 * if status == STAT_ERROR
344 * a0 = ERR_ENOTSUPPORTED - status for command in a0 is
346 * if status == STAT_NONE
347 * a0 = status of the devcmd specified in a0 as follows.
348 * ERR_SUCCESS - command in a0 completed successfully
349 * ERR_EINPROGRESS - command in a0 is still in progress
351 CMD_STATUS = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 49),
354 * Returns interrupt coalescing timer conversion factors.
355 * After calling this devcmd, ENIC driver can convert
356 * interrupt coalescing timer in usec into CPU cycles as follows:
358 * intr_timer_cycles = intr_timer_usec * multiplier / divisor
360 * Interrupt coalescing timer in usecs can be be converted/obtained
361 * from CPU cycles as follows:
363 * intr_timer_usec = intr_timer_cycles * divisor / multiplier
366 * out: (u32)a0 = multiplier
368 * (u32)a2 = maximum timer value in usec
370 CMD_INTR_COAL_CONVERT = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 50),
374 * in: (u64)a0=paddr of the param or param itself
375 * (u32)a1=ISCSI_CMD_xxx
377 CMD_ISCSI_DUMP_REQ = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 51),
380 * ISCSI DUMP STATUS API:
381 * in: (u32)a0=cmd tag
382 * in: (u32)a1=ISCSI_CMD_xxx
383 * out: (u32)a0=cmd status
385 CMD_ISCSI_DUMP_STATUS = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 52),
388 * Subvnic migration from MQ <--> VF.
389 * Enable the LIF migration from MQ to VF and vice versa. MQ and VF
390 * indexes are statically bound at the time of initialization.
392 * direction of migration, the resources of either MQ or the VF shall
393 * be attached to the LIF.
394 * in: (u32)a0=Direction of Migration
397 * (u32)a1=VF index (MQ index)
399 CMD_MIGRATE_SUBVNIC = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 53),
403 * Register / Deregister the notification block for MQ subvnics
405 * (u64)a0=paddr to notify (set paddr=0 to unset)
406 * (u32)a1 & 0x00000000ffffffff=sizeof(struct vnic_devcmd_notify)
407 * (u16)a1 & 0x0000ffff00000000=intr num (-1 for no intr)
409 * (u32)a1 = effective size
411 CMD_SUBVNIC_NOTIFY = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 54),
414 * Set the predefined mac address as default
418 CMD_SET_MAC_ADDR = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 55),
420 /* Update the provisioning info of the given VIF
421 * (u64)a0=paddr of vnic_devcmd_provinfo
422 * (u32)a1=sizeof provision info */
423 CMD_PROV_INFO_UPDATE = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 56),
426 * Initialization for the devcmd2 interface.
427 * in: (u64) a0=host result buffer physical address
428 * in: (u16) a1=number of entries in result buffer
430 CMD_INITIALIZE_DEVCMD2 = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 57),
434 * in: (u64) a0= filter address
435 * (u32) a1= size of filter
436 * out: (u32) a0=filter identifier
438 CMD_ADD_FILTER = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ENET, 58),
442 * in: (u32) a0=filter identifier
444 CMD_DEL_FILTER = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 59),
447 * Enable a Queue Pair in User space NIC
448 * in: (u32) a0=Queue Pair number
451 CMD_QP_ENABLE = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 60),
454 * Disable a Queue Pair in User space NIC
455 * in: (u32) a0=Queue Pair number
458 CMD_QP_DISABLE = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 61),
461 * Stats dump Queue Pair in User space NIC
462 * in: (u32) a0=Queue Pair number
463 * (u64) a1=host buffer addr for status dump
464 * (u32) a2=length of the buffer
466 CMD_QP_STATS_DUMP = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 62),
469 * Clear stats for Queue Pair in User space NIC
470 * in: (u32) a0=Queue Pair number
472 CMD_QP_STATS_CLEAR = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 63),
475 * Enable/Disable overlay offloads on the given vnic
476 * in: (u8) a0 = OVERLAY_FEATURE_NVGRE : NVGRE
477 * a0 = OVERLAY_FEATURE_VXLAN : VxLAN
478 * in: (u8) a1 = OVERLAY_OFFLOAD_ENABLE : Enable
479 * a1 = OVERLAY_OFFLOAD_DISABLE : Disable
481 CMD_OVERLAY_OFFLOAD_ENABLE_DISABLE =
482 _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 72),
485 * Configuration of overlay offloads feature on a given vNIC
486 * in: (u8) a0 = DEVCMD_OVERLAY_NVGRE : NVGRE
487 * a0 = DEVCMD_OVERLAY_VXLAN : VxLAN
488 * in: (u8) a1 = VXLAN_PORT_UPDATE : VxLAN
489 * in: (u16) a2 = unsigned short int port information
491 CMD_OVERLAY_OFFLOAD_CFG = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 73),
494 /* CMD_ENABLE2 flags */
495 #define CMD_ENABLE2_STANDBY 0x0
496 #define CMD_ENABLE2_ACTIVE 0x1
498 /* flags for CMD_OPEN */
499 #define CMD_OPENF_OPROM 0x1 /* open coming from option rom */
501 /* flags for CMD_INIT */
502 #define CMD_INITF_DEFAULT_MAC 0x1 /* init with default mac addr */
504 /* flags for CMD_PACKET_FILTER */
505 #define CMD_PFILTER_DIRECTED 0x01
506 #define CMD_PFILTER_MULTICAST 0x02
507 #define CMD_PFILTER_BROADCAST 0x04
508 #define CMD_PFILTER_PROMISCUOUS 0x08
509 #define CMD_PFILTER_ALL_MULTICAST 0x10
511 /* Commands for CMD_QP_ENABLE/CM_QP_DISABLE */
512 #define CMD_QP_RQWQ 0x0
514 /* rewrite modes for CMD_IG_VLAN_REWRITE_MODE */
515 #define IG_VLAN_REWRITE_MODE_DEFAULT_TRUNK 0
516 #define IG_VLAN_REWRITE_MODE_UNTAG_DEFAULT_VLAN 1
517 #define IG_VLAN_REWRITE_MODE_PRIORITY_TAG_DEFAULT_VLAN 2
518 #define IG_VLAN_REWRITE_MODE_PASS_THRU 3
520 enum vnic_devcmd_status {
522 STAT_BUSY = 1 << 0, /* cmd in progress */
523 STAT_ERROR = 1 << 1, /* last cmd caused error (code in a0) */
526 enum vnic_devcmd_error {
538 ERR_ENOTSUPPORTED = 11,
539 ERR_EINPROGRESS = 12,
544 * note: hw_version and asic_rev refer to the same thing,
545 * but have different formats. hw_version is
546 * a 32-byte string (e.g. "A2") and asic_rev is
547 * a 16-bit integer (e.g. 0xA2).
549 struct vnic_devcmd_fw_info {
553 char hw_serial_number[32];
558 enum fwinfo_asic_type {
559 FWINFO_ASIC_TYPE_UNKNOWN,
560 FWINFO_ASIC_TYPE_PALO,
561 FWINFO_ASIC_TYPE_SERENO,
565 struct vnic_devcmd_notify {
566 u32 csum; /* checksum over following words */
568 u32 link_state; /* link up == 1 */
569 u32 port_speed; /* effective port speed (rate limit) */
571 u32 msglvl; /* requested driver msg lvl */
572 u32 uif; /* uplink interface */
573 u32 status; /* status bits (see VNIC_STF_*) */
574 u32 error; /* error code (see ERR_*) for first ERR */
575 u32 link_down_cnt; /* running count of link down transitions */
576 u32 perbi_rebuild_cnt; /* running count of perbi rebuilds */
578 #define VNIC_STF_FATAL_ERR 0x0001 /* fatal fw error */
579 #define VNIC_STF_STD_PAUSE 0x0002 /* standard link-level pause on */
580 #define VNIC_STF_PFC_PAUSE 0x0004 /* priority flow control pause on */
581 /* all supported status flags */
582 #define VNIC_STF_ALL (VNIC_STF_FATAL_ERR |\
583 VNIC_STF_STD_PAUSE |\
584 VNIC_STF_PFC_PAUSE |\
587 struct vnic_devcmd_provinfo {
594 * These are used in flags field of different filters to denote
597 #define FILTER_FIELD_VALID(fld) (1 << (fld - 1))
599 #define FILTER_FIELDS_USNIC (FILTER_FIELD_VALID(1) | \
600 FILTER_FIELD_VALID(2) | \
601 FILTER_FIELD_VALID(3) | \
602 FILTER_FIELD_VALID(4))
604 #define FILTER_FIELDS_IPV4_5TUPLE (FILTER_FIELD_VALID(1) | \
605 FILTER_FIELD_VALID(2) | \
606 FILTER_FIELD_VALID(3) | \
607 FILTER_FIELD_VALID(4) | \
608 FILTER_FIELD_VALID(5))
610 #define FILTER_FIELDS_MAC_VLAN (FILTER_FIELD_VALID(1) | \
611 FILTER_FIELD_VALID(2))
613 #define FILTER_FIELD_USNIC_VLAN FILTER_FIELD_VALID(1)
614 #define FILTER_FIELD_USNIC_ETHTYPE FILTER_FIELD_VALID(2)
615 #define FILTER_FIELD_USNIC_PROTO FILTER_FIELD_VALID(3)
616 #define FILTER_FIELD_USNIC_ID FILTER_FIELD_VALID(4)
618 struct filter_usnic_id {
624 } __attribute__((packed));
626 #define FILTER_FIELD_5TUP_PROTO FILTER_FIELD_VALID(1)
627 #define FILTER_FIELD_5TUP_SRC_AD FILTER_FIELD_VALID(2)
628 #define FILTER_FIELD_5TUP_DST_AD FILTER_FIELD_VALID(3)
629 #define FILTER_FIELD_5TUP_SRC_PT FILTER_FIELD_VALID(4)
630 #define FILTER_FIELD_5TUP_DST_PT FILTER_FIELD_VALID(5)
632 /* Enums for the protocol field. */
638 struct filter_ipv4_5tuple {
645 } __attribute__((packed));
647 #define FILTER_FIELD_VMQ_VLAN FILTER_FIELD_VALID(1)
648 #define FILTER_FIELD_VMQ_MAC FILTER_FIELD_VALID(2)
650 struct filter_mac_vlan {
654 } __attribute__((packed));
656 /* Specifies the filter_action type. */
658 FILTER_ACTION_RQ_STEERING = 0,
662 struct filter_action {
667 } __attribute__((packed));
669 /* Specifies the filter type. */
672 FILTER_IPV4_5TUPLE = 1,
680 struct filter_usnic_id usnic;
681 struct filter_ipv4_5tuple ipv4;
682 struct filter_mac_vlan mac_vlan;
684 } __attribute__((packed));
691 #define FILTER_MAX_BUF_SIZE 100 /* Maximum size of buffer to CMD_ADD_FILTER */
705 * Writing cmd register causes STAT_BUSY to get set in status register.
706 * When cmd completes, STAT_BUSY will be cleared.
708 * If cmd completed successfully STAT_ERROR will be clear
709 * and args registers contain cmd-specific results.
711 * If cmd error, STAT_ERROR will be set and args[0] contains error code.
713 * status register is read-only. While STAT_BUSY is set,
714 * all other register contents are read-only.
717 /* Make sizeof(vnic_devcmd) a power-of-2 for I/O BAR. */
718 #define VNIC_DEVCMD_NARGS 15
722 u64 args[VNIC_DEVCMD_NARGS]; /* RW cmd args (little-endian) */
726 * Version 2 of the interface.
728 * Some things are carried over, notably the vnic_devcmd_cmd enum.
732 * Flags for vnic_devcmd2.flags
735 #define DEVCMD2_FNORESULT 0x1 /* Don't copy result to host */
737 #define VNIC_DEVCMD2_NARGS VNIC_DEVCMD_NARGS
738 struct vnic_devcmd2 {
741 u32 cmd; /* same command #defines as original */
742 u64 args[VNIC_DEVCMD2_NARGS];
745 #define VNIC_DEVCMD2_NRESULTS VNIC_DEVCMD_NARGS
746 struct devcmd2_result {
747 u64 results[VNIC_DEVCMD2_NRESULTS];
749 u16 completed_index; /* into copy WQ */
750 u8 error; /* same error codes as original */
751 u8 color; /* 0 or 1 as with completion queues */
754 #define DEVCMD2_RING_SIZE 32
755 #define DEVCMD2_DESC_SIZE 128
757 #define DEVCMD2_RESULTS_SIZE_MAX ((1 << 16) - 1)
759 /* Overlay related definitions */
762 * This enum lists the flag associated with each of the overlay features
765 OVERLAY_FEATURE_NVGRE = 1,
766 OVERLAY_FEATURE_VXLAN,
770 #define OVERLAY_OFFLOAD_ENABLE 0
771 #define OVERLAY_OFFLOAD_DISABLE 1
773 #define OVERLAY_CFG_VXLAN_PORT_UPDATE 0
774 #endif /* _VNIC_DEVCMD_H_ */