1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright 2008-2017 Cisco Systems, Inc. All rights reserved.
3 * Copyright 2007 Nuova Systems, Inc. All rights reserved.
6 #ifndef _VNIC_DEVCMD_H_
7 #define _VNIC_DEVCMD_H_
10 #define _CMD_VTYPEBITS 10
11 #define _CMD_FLAGSBITS 6
12 #define _CMD_DIRBITS 2
14 #define _CMD_NMASK ((1 << _CMD_NBITS)-1)
15 #define _CMD_VTYPEMASK ((1 << _CMD_VTYPEBITS)-1)
16 #define _CMD_FLAGSMASK ((1 << _CMD_FLAGSBITS)-1)
17 #define _CMD_DIRMASK ((1 << _CMD_DIRBITS)-1)
20 #define _CMD_VTYPESHIFT (_CMD_NSHIFT+_CMD_NBITS)
21 #define _CMD_FLAGSSHIFT (_CMD_VTYPESHIFT+_CMD_VTYPEBITS)
22 #define _CMD_DIRSHIFT (_CMD_FLAGSSHIFT+_CMD_FLAGSBITS)
25 * Direction bits (from host perspective).
27 #define _CMD_DIR_NONE 0U
28 #define _CMD_DIR_WRITE 1U
29 #define _CMD_DIR_READ 2U
30 #define _CMD_DIR_RW (_CMD_DIR_WRITE | _CMD_DIR_READ)
35 #define _CMD_FLAGS_NONE 0U
36 #define _CMD_FLAGS_NOWAIT 1U
41 #define _CMD_VTYPE_NONE 0U
42 #define _CMD_VTYPE_ENET 1U
43 #define _CMD_VTYPE_FC 2U
44 #define _CMD_VTYPE_SCSI 4U
45 #define _CMD_VTYPE_ALL (_CMD_VTYPE_ENET | _CMD_VTYPE_FC | _CMD_VTYPE_SCSI)
48 * Used to create cmds..
50 #define _CMDCF(dir, flags, vtype, nr) \
51 (((dir) << _CMD_DIRSHIFT) | \
52 ((flags) << _CMD_FLAGSSHIFT) | \
53 ((vtype) << _CMD_VTYPESHIFT) | \
54 ((nr) << _CMD_NSHIFT))
55 #define _CMDC(dir, vtype, nr) _CMDCF(dir, 0, vtype, nr)
56 #define _CMDCNW(dir, vtype, nr) _CMDCF(dir, _CMD_FLAGS_NOWAIT, vtype, nr)
59 * Used to decode cmds..
61 #define _CMD_DIR(cmd) (((cmd) >> _CMD_DIRSHIFT) & _CMD_DIRMASK)
62 #define _CMD_FLAGS(cmd) (((cmd) >> _CMD_FLAGSSHIFT) & _CMD_FLAGSMASK)
63 #define _CMD_VTYPE(cmd) (((cmd) >> _CMD_VTYPESHIFT) & _CMD_VTYPEMASK)
64 #define _CMD_N(cmd) (((cmd) >> _CMD_NSHIFT) & _CMD_NMASK)
66 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
68 enum vnic_devcmd_cmd {
69 CMD_NONE = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_NONE, 0),
72 * mcpu fw info in mem:
74 * (u64)a0=paddr to struct vnic_devcmd_fw_info
76 * Fills in struct vnic_devcmd_fw_info (128 bytes)
78 * An old definition of CMD_MCPU_FW_INFO
80 CMD_MCPU_FW_INFO_OLD = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 1),
83 * mcpu fw info in mem:
85 * (u64)a0=paddr to struct vnic_devcmd_fw_info
86 * (u16)a1=size of the structure
88 * (u16)a1=0 for in:a1 = 0,
89 * data size actually written for other values.
91 * Fills in first 128 bytes of vnic_devcmd_fw_info for in:a1 = 0,
92 * first in:a1 bytes for 0 < in:a1 <= 132,
93 * 132 bytes for other values of in:a1.
95 * CMD_MCPU_FW_INFO and CMD_MCPU_FW_INFO_OLD have the same enum 1
96 * for source compatibility.
98 CMD_MCPU_FW_INFO = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 1),
100 /* dev-specific block member:
101 * in: (u16)a0=offset,(u8)a1=size
104 CMD_DEV_SPEC = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 2),
107 CMD_STATS_CLEAR = _CMDCNW(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 3),
109 /* stats dump in mem: (u64)a0=paddr to stats area,
110 * (u16)a1=sizeof stats area */
111 CMD_STATS_DUMP = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 4),
113 /* set Rx packet filter: (u32)a0=filters (see CMD_PFILTER_*) */
114 CMD_PACKET_FILTER = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 7),
116 /* set Rx packet filter for all: (u32)a0=filters (see CMD_PFILTER_*) */
117 CMD_PACKET_FILTER_ALL = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 7),
119 /* hang detection notification */
120 CMD_HANG_NOTIFY = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 8),
122 /* MAC address in (u48)a0 */
123 CMD_MAC_ADDR = _CMDC(_CMD_DIR_READ,
124 _CMD_VTYPE_ENET | _CMD_VTYPE_FC, 9),
125 #define CMD_GET_MAC_ADDR CMD_MAC_ADDR /* some uses are aliased */
127 /* add addr from (u48)a0 */
128 CMD_ADDR_ADD = _CMDCNW(_CMD_DIR_WRITE,
129 _CMD_VTYPE_ENET | _CMD_VTYPE_FC, 12),
131 /* del addr from (u48)a0 */
132 CMD_ADDR_DEL = _CMDCNW(_CMD_DIR_WRITE,
133 _CMD_VTYPE_ENET | _CMD_VTYPE_FC, 13),
135 /* add VLAN id in (u16)a0 */
136 CMD_VLAN_ADD = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 14),
138 /* del VLAN id in (u16)a0 */
139 CMD_VLAN_DEL = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 15),
145 * out: (u64) a0= 1 if a1 is valid
146 * (u64) a1= (NIC_CFG bits supported) | (flags << 32)
147 * (flags are CMD_NIC_CFG_CAPF_xxx)
149 CMD_NIC_CFG = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 16),
152 * nic_cfg_chk (same as nic_cfg, but may return error)
156 * out: (u64) a0= 1 if a1 is valid
157 * (u64) a1= (NIC_CFG bits supported) | (flags << 32)
158 * (flags are CMD_NIC_CFG_CAPF_xxx)
160 CMD_NIC_CFG_CHK = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 16),
162 /* union vnic_rss_key in mem: (u64)a0=paddr, (u16)a1=len */
163 CMD_RSS_KEY = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 17),
165 /* union vnic_rss_cpu in mem: (u64)a0=paddr, (u16)a1=len */
166 CMD_RSS_CPU = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 18),
168 /* initiate softreset */
169 CMD_SOFT_RESET = _CMDCNW(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 19),
172 * out: a0=0 reset complete, a0=1 reset in progress */
173 CMD_SOFT_RESET_STATUS = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 20),
175 /* set struct vnic_devcmd_notify buffer in mem:
177 * (u64)a0=paddr to notify (set paddr=0 to unset)
178 * (u32)a1 & 0x00000000ffffffff=sizeof(struct vnic_devcmd_notify)
179 * (u16)a1 & 0x0000ffff00000000=intr num (-1 for no intr)
181 * (u32)a1 = effective size
183 CMD_NOTIFY = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 21),
185 /* UNDI API: (u64)a0=paddr to s_PXENV_UNDI_ struct,
186 * (u8)a1=PXENV_UNDI_xxx */
187 CMD_UNDI = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 22),
189 /* initiate open sequence (u32)a0=flags (see CMD_OPENF_*) */
190 CMD_OPEN = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 23),
193 * out: a0=0 open complete, a0=1 open in progress */
194 CMD_OPEN_STATUS = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 24),
197 CMD_CLOSE = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 25),
199 /* initialize virtual link: (u32)a0=flags (see CMD_INITF_*) */
200 /***** Replaced by CMD_INIT *****/
201 CMD_INIT_v1 = _CMDCNW(_CMD_DIR_READ, _CMD_VTYPE_ALL, 26),
203 /* variant of CMD_INIT, with provisioning info
204 * (u64)a0=paddr of vnic_devcmd_provinfo
205 * (u32)a1=sizeof provision info */
206 CMD_INIT_PROV_INFO = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 27),
208 /* enable virtual link */
209 CMD_ENABLE = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 28),
211 /* enable virtual link, waiting variant. */
212 CMD_ENABLE_WAIT = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 28),
214 /* disable virtual link */
215 CMD_DISABLE = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 29),
217 /* stats dump sum of all vnic stats on same uplink in mem:
219 * (u16)a1=sizeof stats area */
220 CMD_STATS_DUMP_ALL = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 30),
223 * out: a0=0 init complete, a0=1 init in progress
224 * if a0=0, a1=errno */
225 CMD_INIT_STATUS = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 31),
227 /* INT13 API: (u64)a0=paddr to vnic_int13_params struct
228 * (u32)a1=INT13_CMD_xxx */
229 CMD_INT13 = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_FC, 32),
231 /* logical uplink enable/disable: (u64)a0: 0/1=disable/enable */
232 CMD_LOGICAL_UPLINK = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 33),
234 /* undo initialize of virtual link */
235 CMD_DEINIT = _CMDCNW(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 34),
237 /* initialize virtual link: (u32)a0=flags (see CMD_INITF_*) */
238 CMD_INIT = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 35),
240 /* check fw capability of a cmd:
242 * out: (u32)a0=errno, 0:valid cmd, a1=supported VNIC_STF_* bits */
243 CMD_CAPABILITY = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 36),
245 /* persistent binding info
246 * in: (u64)a0=paddr of arg
247 * (u32)a1=CMD_PERBI_XXX */
248 CMD_PERBI = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_FC, 37),
250 /* Interrupt Assert Register functionality
251 * in: (u16)a0=interrupt number to assert
253 CMD_IAR = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 38),
255 /* initiate hangreset, like softreset after hang detected */
256 CMD_HANG_RESET = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 39),
259 * out: a0=0 reset complete, a0=1 reset in progress */
260 CMD_HANG_RESET_STATUS = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 40),
263 * Set hw ingress packet vlan rewrite mode:
264 * in: (u32)a0=new vlan rewrite mode
265 * out: (u32)a0=old vlan rewrite mode */
266 CMD_IG_VLAN_REWRITE_MODE = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ENET, 41),
269 * in: (u16)a0=bdf of target vnic
270 * (u32)a1=cmd to proxy
271 * a2-a15=args to cmd in a1
272 * out: (u32)a0=status of proxied cmd
273 * a1-a15=out args of proxied cmd */
274 CMD_PROXY_BY_BDF = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 42),
277 * As for BY_BDF except a0 is index of hvnlink subordinate vnic
278 * or SR-IOV virtual vnic
280 CMD_PROXY_BY_INDEX = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 43),
285 * in: (u64)a0=phsical address of buffer passed in from caller.
286 * (u16)a1=size of buffer specified in a0.
287 * out: (u64)a0=phsical address of buffer passed in from caller.
288 * (u16)a1=actual bytes from VIF-CONFIG-INFO TLV, or
289 * 0 if no VIF-CONFIG-INFO TLV was ever received. */
290 CMD_CONFIG_INFO_GET = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 44),
293 * INT13 API: (u64)a0=paddr to vnic_int13_params struct
294 * (u32)a1=INT13_CMD_xxx
296 CMD_INT13_ALL = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 45),
300 * in: (u16)a0=new default vlan
301 * (u16)a1=zero for overriding vlan with param a0,
302 * non-zero for resetting vlan to the default
303 * out: (u16)a0=old default vlan
305 CMD_SET_DEFAULT_VLAN = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 46),
308 * Variant of CMD_INIT_PROV_INFO, where it will not try to enable
309 * the vnic until CMD_ENABLE2 is issued.
310 * (u64)a0=paddr of vnic_devcmd_provinfo
311 * (u32)a1=sizeof provision info */
312 CMD_INIT_PROV_INFO2 = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 47),
315 * (u32)a0=0 ==> standby
316 * =CMD_ENABLE2_ACTIVE ==> active
318 CMD_ENABLE2 = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 48),
322 * Returns the status of the specified command
324 * a0 = command for which status is being queried.
325 * Possible values are:
332 * CMD_INIT_PROV_INFO2
335 * if status == STAT_ERROR
336 * a0 = ERR_ENOTSUPPORTED - status for command in a0 is
338 * if status == STAT_NONE
339 * a0 = status of the devcmd specified in a0 as follows.
340 * ERR_SUCCESS - command in a0 completed successfully
341 * ERR_EINPROGRESS - command in a0 is still in progress
343 CMD_STATUS = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 49),
346 * Returns interrupt coalescing timer conversion factors.
347 * After calling this devcmd, ENIC driver can convert
348 * interrupt coalescing timer in usec into CPU cycles as follows:
350 * intr_timer_cycles = intr_timer_usec * multiplier / divisor
352 * Interrupt coalescing timer in usecs can be be converted/obtained
353 * from CPU cycles as follows:
355 * intr_timer_usec = intr_timer_cycles * divisor / multiplier
358 * out: (u32)a0 = multiplier
360 * (u32)a2 = maximum timer value in usec
362 CMD_INTR_COAL_CONVERT = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 50),
366 * in: (u64)a0=paddr of the param or param itself
367 * (u32)a1=ISCSI_CMD_xxx
369 CMD_ISCSI_DUMP_REQ = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 51),
372 * ISCSI DUMP STATUS API:
373 * in: (u32)a0=cmd tag
374 * in: (u32)a1=ISCSI_CMD_xxx
375 * out: (u32)a0=cmd status
377 CMD_ISCSI_DUMP_STATUS = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 52),
380 * Subvnic migration from MQ <--> VF.
381 * Enable the LIF migration from MQ to VF and vice versa. MQ and VF
382 * indexes are statically bound at the time of initialization.
383 * Based on the direction of migration, the resources of either MQ or
384 * the VF shall be attached to the LIF.
385 * in: (u32)a0=Direction of Migration
388 * (u32)a1=VF index (MQ index)
390 CMD_MIGRATE_SUBVNIC = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 53),
393 * Register / Deregister the notification block for MQ subvnics
395 * (u64)a0=paddr to notify (set paddr=0 to unset)
396 * (u32)a1 & 0x00000000ffffffff=sizeof(struct vnic_devcmd_notify)
397 * (u16)a1 & 0x0000ffff00000000=intr num (-1 for no intr)
399 * (u32)a1 = effective size
401 CMD_SUBVNIC_NOTIFY = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 54),
404 * Set the predefined mac address as default
408 CMD_SET_MAC_ADDR = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 55),
410 /* Update the provisioning info of the given VIF
411 * (u64)a0=paddr of vnic_devcmd_provinfo
412 * (u32)a1=sizeof provision info */
413 CMD_PROV_INFO_UPDATE = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 56),
416 * Initialization for the devcmd2 interface.
417 * in: (u64) a0=host result buffer physical address
418 * in: (u16) a1=number of entries in result buffer
420 CMD_INITIALIZE_DEVCMD2 = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 57),
424 * in: (u64) a0= filter address
425 * (u32) a1= size of filter
426 * out: (u32) a0=filter identifier
429 * out: (u64) a0= 1 if capability query supported
430 * (u64) a1= MAX filter type supported
432 CMD_ADD_FILTER = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ENET, 58),
436 * in: (u32) a0=filter identifier
438 CMD_DEL_FILTER = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 59),
441 * Enable a Queue Pair in User space NIC
442 * in: (u32) a0=Queue Pair number
445 CMD_QP_ENABLE = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 60),
448 * Disable a Queue Pair in User space NIC
449 * in: (u32) a0=Queue Pair number
452 CMD_QP_DISABLE = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 61),
455 * Stats dump Queue Pair in User space NIC
456 * in: (u32) a0=Queue Pair number
457 * (u64) a1=host buffer addr for status dump
458 * (u32) a2=length of the buffer
460 CMD_QP_STATS_DUMP = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 62),
463 * Clear stats for Queue Pair in User space NIC
464 * in: (u32) a0=Queue Pair number
466 CMD_QP_STATS_CLEAR = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 63),
469 * UEFI BOOT API: (u64)a0= UEFI FLS_CMD_xxx
470 * (ui64)a1= paddr for the info buffer
472 CMD_FC_REQ = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_FC, 64),
475 * Return the iSCSI config details required by the EFI Option ROM
476 * in: (u32) a0=0 Get Boot Info for PXE eNIC as per pxe_boot_config_t
477 * a0=1 Get Boot info for iSCSI enic as per
478 * iscsi_boot_efi_cfg_t
479 * in: (u64) a1=Host address where iSCSI config info is returned
481 CMD_VNIC_BOOT_CONFIG_INFO = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 65),
484 * Create a Queue Pair (RoCE)
485 * in: (u32) a0 = Queue Pair number
486 * (u32) a1 = Remote QP
488 * (u16) a3 = RQ Res Group
489 * (u16) a4 = SQ Res Group
490 * (u32) a5 = Protection Domain
491 * (u64) a6 = Remote MAC
492 * (u32) a7 = start PSN
494 * (u32) a9 = protocol version
496 CMD_RDMA_QP_CREATE = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 66),
499 * Delete a Queue Pair (RoCE)
500 * in: (u32) a0 = Queue Pair number
502 CMD_RDMA_QP_DELETE = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 67),
505 * Retrieve a Queue Pair's status information (RoCE)
506 * in: (u32) a0 = Queue Pair number
507 * (u64) a1 = host buffer addr for QP status struct
508 * (u32) a2 = length of the buffer
510 CMD_RDMA_QP_STATUS = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ENET, 68),
513 * Use this devcmd for agreeing on the highest common version supported
514 * by both driver and fw for by features who need such a facility.
515 * in: (u64) a0 = feature (driver requests for the supported versions
517 * out: (u64) a0 = bitmap of all supported versions for that feature
519 CMD_GET_SUPP_FEATURE_VER = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ENET, 69),
522 * Initialize the RDMA notification work queue
523 * in: (u64) a0 = host buffer address
524 * in: (u16) a1 = number of entries in buffer
525 * in: (u16) a2 = resource group number
526 * in: (u16) a3 = CQ number to post completion
528 CMD_RDMA_INIT_INFO_BUF = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 70),
531 * De-init the RDMA notification work queue
532 * in: (u64) a0=resource group number
534 CMD_RDMA_DEINIT_INFO_BUF = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 71),
537 * Control (Enable/Disable) overlay offloads on the given vnic
538 * in: (u8) a0 = OVERLAY_FEATURE_NVGRE : NVGRE
539 * a0 = OVERLAY_FEATURE_VXLAN : VxLAN
540 * in: (u8) a1 = OVERLAY_OFFLOAD_ENABLE : Enable or
541 * a1 = OVERLAY_OFFLOAD_DISABLE : Disable or
542 * a1 = OVERLAY_OFFLOAD_ENABLE_V2 : Enable with version 2
544 CMD_OVERLAY_OFFLOAD_CTRL =
545 _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 72),
548 * Configuration of overlay offloads feature on a given vNIC
549 * in: (u8) a0 = OVERLAY_CFG_VXLAN_PORT_UPDATE : VxLAN
550 * in: (u16) a1 = unsigned short int port information
552 CMD_OVERLAY_OFFLOAD_CFG = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 73),
555 * Return the configured name for the device
556 * in: (u64) a0=Host address where the name is copied
557 * (u32) a1=Size of the buffer
559 CMD_GET_CONFIG_NAME = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 74),
562 * Enable group interrupt for the VF
563 * in: (u32) a0 = GRPINTR_ENABLE : enable
564 * a0 = GRPINTR_DISABLE : disable
565 * a0 = GRPINTR_UPD_VECT: update group vector addr
566 * in: (u32) a1 = interrupt group count
567 * in: (u64) a2 = Start of host buffer address for DMAing group
569 * in: (u64) a3 = Stride between group vectors
571 CMD_CONFIG_GRPINTR = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 75),
574 * Set cq arrary base and size in a list of consective wqs and
576 * in: (u16) a0 = the wq relative index in the device.
577 * -1 indicates skipping wq configuration
578 * in: (u16) a1 = the wcq relative index in the device
579 * in: (u16) a2 = the rq relative index in the device
580 * -1 indicates skipping rq configuration
581 * in: (u16) a3 = the rcq relative index in the device
583 CMD_CONFIG_CQ_ARRAY = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 76),
586 * Add an advanced filter.
587 * in: (u64) a0= filter address
588 * (u32) a1= size of filter
589 * out: (u32) a0=filter identifier
592 * in: (u64) a1= supported filter capability exchange modes
593 * out: (u64) a0= 1 if capability query supported
594 * if (u64) a1 = 0: a1 = MAX filter type supported
595 * if (u64) a1 & FILTER_CAP_MODE_V1_FLAG:
596 * a1 = bitmask of supported filters
597 * a2 = FILTER_CAP_MODE_V1
598 * a3 = bitmask of supported actions
600 CMD_ADD_ADV_FILTER = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ENET, 77),
603 /* Modes for exchanging advanced filter capabilities. The modes supported by
604 * the driver are passed in the CMD_ADD_ADV_FILTER capability command and the
605 * mode selected is returned.
606 * V0: the maximum filter type supported is returned
607 * V1: bitmasks of supported filters and actions are returned
609 enum filter_cap_mode {
610 FILTER_CAP_MODE_V0 = 0, /* Must always be 0 for legacy drivers */
611 FILTER_CAP_MODE_V1 = 1,
613 #define FILTER_CAP_MODE_V1_FLAG (1 << FILTER_CAP_MODE_V1)
615 /* CMD_ENABLE2 flags */
616 #define CMD_ENABLE2_STANDBY 0x0
617 #define CMD_ENABLE2_ACTIVE 0x1
619 /* flags for CMD_OPEN */
620 #define CMD_OPENF_OPROM 0x1 /* open coming from option rom */
621 #define CMD_OPENF_IG_DESCCACHE 0x2 /* Do not flush IG DESC cache */
623 /* flags for CMD_INIT */
624 #define CMD_INITF_DEFAULT_MAC 0x1 /* init with default mac addr */
626 /* flags for CMD_NIC_CFG */
627 #define CMD_NIC_CFG_CAPF_UDP_WEAK (1ULL << 0) /* Bodega-style UDP RSS */
629 /* flags for CMD_PACKET_FILTER */
630 #define CMD_PFILTER_DIRECTED 0x01
631 #define CMD_PFILTER_MULTICAST 0x02
632 #define CMD_PFILTER_BROADCAST 0x04
633 #define CMD_PFILTER_PROMISCUOUS 0x08
634 #define CMD_PFILTER_ALL_MULTICAST 0x10
636 /* Commands for CMD_QP_ENABLE/CM_QP_DISABLE */
637 #define CMD_QP_RQWQ 0x0
639 /* rewrite modes for CMD_IG_VLAN_REWRITE_MODE */
640 #define IG_VLAN_REWRITE_MODE_DEFAULT_TRUNK 0
641 #define IG_VLAN_REWRITE_MODE_UNTAG_DEFAULT_VLAN 1
642 #define IG_VLAN_REWRITE_MODE_PRIORITY_TAG_DEFAULT_VLAN 2
643 #define IG_VLAN_REWRITE_MODE_PASS_THRU 3
645 enum vnic_devcmd_status {
647 STAT_BUSY = 1 << 0, /* cmd in progress */
648 STAT_ERROR = 1 << 1, /* last cmd caused error (code in a0) */
649 STAT_FAILOVER = 1 << 2, /* always set on vnics in pci standby state
650 * if seen a failover to the standby happened
654 enum vnic_devcmd_error {
666 ERR_ENOTSUPPORTED = 11,
667 ERR_EINPROGRESS = 12,
672 * note: hw_version and asic_rev refer to the same thing,
673 * but have different formats. hw_version is
674 * a 32-byte string (e.g. "A2") and asic_rev is
675 * a 16-bit integer (e.g. 0xA2).
677 struct vnic_devcmd_fw_info {
681 char hw_serial_number[32];
686 enum fwinfo_asic_type {
687 FWINFO_ASIC_TYPE_UNKNOWN,
688 FWINFO_ASIC_TYPE_PALO,
689 FWINFO_ASIC_TYPE_SERENO,
690 FWINFO_ASIC_TYPE_CRUZ,
693 struct vnic_devcmd_notify {
694 u32 csum; /* checksum over following words */
696 u32 link_state; /* link up == 1 */
697 u32 port_speed; /* effective port speed (rate limit) */
699 u32 msglvl; /* requested driver msg lvl */
700 u32 uif; /* uplink interface */
701 u32 status; /* status bits (see VNIC_STF_*) */
702 u32 error; /* error code (see ERR_*) for first ERR */
703 u32 link_down_cnt; /* running count of link down transitions */
704 u32 perbi_rebuild_cnt; /* running count of perbi rebuilds */
706 #define VNIC_STF_FATAL_ERR 0x0001 /* fatal fw error */
707 #define VNIC_STF_STD_PAUSE 0x0002 /* standard link-level pause on */
708 #define VNIC_STF_PFC_PAUSE 0x0004 /* priority flow control pause on */
709 /* all supported status flags */
710 #define VNIC_STF_ALL (VNIC_STF_FATAL_ERR |\
711 VNIC_STF_STD_PAUSE |\
712 VNIC_STF_PFC_PAUSE |\
715 struct vnic_devcmd_provinfo {
722 * These are used in flags field of different filters to denote
725 #define FILTER_FIELD_VALID(fld) (1 << (fld - 1))
727 #define FILTER_FIELD_USNIC_VLAN FILTER_FIELD_VALID(1)
728 #define FILTER_FIELD_USNIC_ETHTYPE FILTER_FIELD_VALID(2)
729 #define FILTER_FIELD_USNIC_PROTO FILTER_FIELD_VALID(3)
730 #define FILTER_FIELD_USNIC_ID FILTER_FIELD_VALID(4)
732 #define FILTER_FIELDS_USNIC (FILTER_FIELD_USNIC_VLAN | \
733 FILTER_FIELD_USNIC_ETHTYPE | \
734 FILTER_FIELD_USNIC_PROTO | \
735 FILTER_FIELD_USNIC_ID)
737 struct filter_usnic_id {
743 } __attribute__((packed));
745 #define FILTER_FIELD_5TUP_PROTO FILTER_FIELD_VALID(1)
746 #define FILTER_FIELD_5TUP_SRC_AD FILTER_FIELD_VALID(2)
747 #define FILTER_FIELD_5TUP_DST_AD FILTER_FIELD_VALID(3)
748 #define FILTER_FIELD_5TUP_SRC_PT FILTER_FIELD_VALID(4)
749 #define FILTER_FIELD_5TUP_DST_PT FILTER_FIELD_VALID(5)
751 #define FILTER_FIELDS_IPV4_5TUPLE (FILTER_FIELD_5TUP_PROTO | \
752 FILTER_FIELD_5TUP_SRC_AD | \
753 FILTER_FIELD_5TUP_DST_AD | \
754 FILTER_FIELD_5TUP_SRC_PT | \
755 FILTER_FIELD_5TUP_DST_PT)
757 /* Enums for the protocol field. */
765 struct filter_ipv4_5tuple {
772 } __attribute__((packed));
774 #define FILTER_FIELD_VMQ_VLAN FILTER_FIELD_VALID(1)
775 #define FILTER_FIELD_VMQ_MAC FILTER_FIELD_VALID(2)
777 #define FILTER_FIELDS_MAC_VLAN (FILTER_FIELD_VMQ_VLAN | \
778 FILTER_FIELD_VMQ_MAC)
780 #define FILTER_FIELDS_NVGRE FILTER_FIELD_VMQ_MAC
782 struct filter_mac_vlan {
786 } __attribute__((packed));
788 #define FILTER_FIELD_VLAN_IP_3TUP_VLAN FILTER_FIELD_VALID(1)
789 #define FILTER_FIELD_VLAN_IP_3TUP_L3_PROTO FILTER_FIELD_VALID(2)
790 #define FILTER_FIELD_VLAN_IP_3TUP_DST_AD FILTER_FIELD_VALID(3)
791 #define FILTER_FIELD_VLAN_IP_3TUP_L4_PROTO FILTER_FIELD_VALID(4)
792 #define FILTER_FIELD_VLAN_IP_3TUP_DST_PT FILTER_FIELD_VALID(5)
794 #define FILTER_FIELDS_VLAN_IP_3TUP (FILTER_FIELD_VLAN_IP_3TUP_VLAN | \
795 FILTER_FIELD_VLAN_IP_3TUP_L3_PROTO | \
796 FILTER_FIELD_VLAN_IP_3TUP_DST_AD | \
797 FILTER_FIELD_VLAN_IP_3TUP_L4_PROTO | \
798 FILTER_FIELD_VLAN_IP_3TUP_DST_PT)
800 struct filter_vlan_ip_3tuple {
810 } __attribute__((packed));
812 #define FILTER_GENERIC_1_BYTES 64
814 enum filter_generic_1_layer {
819 FILTER_GENERIC_1_NUM_LAYERS
822 #define FILTER_GENERIC_1_IPV4 (1 << 0)
823 #define FILTER_GENERIC_1_IPV6 (1 << 1)
824 #define FILTER_GENERIC_1_UDP (1 << 2)
825 #define FILTER_GENERIC_1_TCP (1 << 3)
826 #define FILTER_GENERIC_1_TCP_OR_UDP (1 << 4)
827 #define FILTER_GENERIC_1_IP4SUM_OK (1 << 5)
828 #define FILTER_GENERIC_1_L4SUM_OK (1 << 6)
829 #define FILTER_GENERIC_1_IPFRAG (1 << 7)
831 #define FILTER_GENERIC_1_KEY_LEN 64
834 * Version 1 of generic filter specification
835 * position is only 16 bits, reserving positions > 64k to be used by firmware
837 struct filter_generic_1 {
838 u16 position; /* lower position comes first */
844 u8 mask[FILTER_GENERIC_1_KEY_LEN]; /* 0 bit means "don't care"*/
845 u8 val[FILTER_GENERIC_1_KEY_LEN];
846 } __attribute__((packed)) layer[FILTER_GENERIC_1_NUM_LAYERS];
847 } __attribute__((packed));
849 /* Specifies the filter_action type. */
851 FILTER_ACTION_RQ_STEERING = 0,
852 FILTER_ACTION_V2 = 1,
856 struct filter_action {
861 } __attribute__((packed));
863 #define FILTER_ACTION_RQ_STEERING_FLAG (1 << 0)
864 #define FILTER_ACTION_FILTER_ID_FLAG (1 << 1)
865 #define FILTER_ACTION_DROP_FLAG (1 << 2)
866 #define FILTER_ACTION_V2_ALL (FILTER_ACTION_RQ_STEERING_FLAG \
867 | FILTER_ACTION_DROP_FLAG \
868 | FILTER_ACTION_FILTER_ID_FLAG)
870 /* Version 2 of filter action must be a strict extension of struct filter_action
871 * where the first fields exactly match in size and meaning.
873 struct filter_action_v2 {
876 u32 flags; /* use FILTER_ACTION_XXX_FLAG defines */
878 u_int8_t reserved[32]; /* for future expansion */
879 } __attribute__((packed));
881 /* Specifies the filter type. */
884 FILTER_IPV4_5TUPLE = 1,
886 FILTER_VLAN_IP_3TUPLE = 3,
887 FILTER_NVGRE_VMQ = 4,
893 #define FILTER_USNIC_ID_FLAG (1 << FILTER_USNIC_ID)
894 #define FILTER_IPV4_5TUPLE_FLAG (1 << FILTER_IPV4_5TUPLE)
895 #define FILTER_MAC_VLAN_FLAG (1 << FILTER_MAC_VLAN)
896 #define FILTER_VLAN_IP_3TUPLE_FLAG (1 << FILTER_VLAN_IP_3TUPLE)
897 #define FILTER_NVGRE_VMQ_FLAG (1 << FILTER_NVGRE_VMQ)
898 #define FILTER_USNIC_IP_FLAG (1 << FILTER_USNIC_IP)
899 #define FILTER_DPDK_1_FLAG (1 << FILTER_DPDK_1)
900 #define FILTER_V1_ALL (FILTER_USNIC_ID_FLAG | \
901 FILTER_IPV4_5TUPLE_FLAG | \
902 FILTER_MAC_VLAN_FLAG | \
903 FILTER_VLAN_IP_3TUPLE_FLAG | \
904 FILTER_NVGRE_VMQ_FLAG | \
905 FILTER_USNIC_IP_FLAG | \
911 struct filter_usnic_id usnic;
912 struct filter_ipv4_5tuple ipv4;
913 struct filter_mac_vlan mac_vlan;
914 struct filter_vlan_ip_3tuple vlan_3tuple;
916 } __attribute__((packed));
919 * This is a strict superset of "struct filter" and exists only
920 * because many drivers use "sizeof (struct filter)" in deciding TLV size.
921 * This new, larger struct filter would cause any code that uses that method
922 * to not work with older firmware, so we add filter_v2 to hold the
923 * new filter types. Drivers should use vnic_filter_size() to determine
924 * the TLV size instead of sizeof (struct fiter_v2) to guard against future
930 struct filter_usnic_id usnic;
931 struct filter_ipv4_5tuple ipv4;
932 struct filter_mac_vlan mac_vlan;
933 struct filter_vlan_ip_3tuple vlan_3tuple;
934 struct filter_generic_1 generic_1;
936 } __attribute__((packed));
949 /* Data for CMD_ADD_FILTER is 2 TLV and filter + action structs */
950 #define FILTER_MAX_BUF_SIZE 100
951 #define FILTER_V2_MAX_BUF_SIZE (sizeof(struct filter_v2) + \
952 sizeof(struct filter_action_v2) + \
953 (2 * sizeof(struct filter_tlv)))
956 * Compute actual structure size given filter type. To be "future-proof,"
957 * drivers should use this instead of "sizeof (struct filter_v2)" when
958 * computing length for TLV.
960 static inline u_int32_t
961 vnic_filter_size(struct filter_v2 *fp)
966 case FILTER_USNIC_ID:
967 size = sizeof(fp->u.usnic);
969 case FILTER_IPV4_5TUPLE:
970 size = sizeof(fp->u.ipv4);
972 case FILTER_MAC_VLAN:
973 case FILTER_NVGRE_VMQ:
974 size = sizeof(fp->u.mac_vlan);
976 case FILTER_VLAN_IP_3TUPLE:
977 size = sizeof(fp->u.vlan_3tuple);
979 case FILTER_USNIC_IP:
981 size = sizeof(fp->u.generic_1);
984 size = sizeof(fp->u);
987 size += sizeof(fp->type);
998 * Get the action structure size given action type. To be "future-proof,"
999 * drivers should use this instead of "sizeof (struct filter_action_v2)"
1000 * when computing length for TLV.
1002 static inline u_int32_t
1003 vnic_action_size(struct filter_action_v2 *fap)
1007 switch (fap->type) {
1008 case FILTER_ACTION_RQ_STEERING:
1009 size = sizeof(struct filter_action);
1011 case FILTER_ACTION_V2:
1012 size = sizeof(struct filter_action_v2);
1015 size = sizeof(struct filter_action);
1022 * Writing cmd register causes STAT_BUSY to get set in status register.
1023 * When cmd completes, STAT_BUSY will be cleared.
1025 * If cmd completed successfully STAT_ERROR will be clear
1026 * and args registers contain cmd-specific results.
1028 * If cmd error, STAT_ERROR will be set and args[0] contains error code.
1030 * status register is read-only. While STAT_BUSY is set,
1031 * all other register contents are read-only.
1034 /* Make sizeof(vnic_devcmd) a power-of-2 for I/O BAR. */
1035 #define VNIC_DEVCMD_NARGS 15
1036 struct vnic_devcmd {
1037 u32 status; /* RO */
1039 u64 args[VNIC_DEVCMD_NARGS]; /* RW cmd args (little-endian) */
1043 * Version 2 of the interface.
1045 * Some things are carried over, notably the vnic_devcmd_cmd enum.
1049 * Flags for vnic_devcmd2.flags
1052 #define DEVCMD2_FNORESULT 0x1 /* Don't copy result to host */
1054 #define VNIC_DEVCMD2_NARGS VNIC_DEVCMD_NARGS
1055 struct vnic_devcmd2 {
1058 u32 cmd; /* same command #defines as original */
1059 u64 args[VNIC_DEVCMD2_NARGS];
1062 #define VNIC_DEVCMD2_NRESULTS VNIC_DEVCMD_NARGS
1063 struct devcmd2_result {
1064 u64 results[VNIC_DEVCMD2_NRESULTS];
1066 u16 completed_index; /* into copy WQ */
1067 u8 error; /* same error codes as original */
1068 u8 color; /* 0 or 1 as with completion queues */
1071 #define DEVCMD2_RING_SIZE 32
1072 #define DEVCMD2_DESC_SIZE 128
1074 #define DEVCMD2_RESULTS_SIZE_MAX ((1 << 16) - 1)
1076 /* Overlay related definitions */
1079 * This enum lists the flag associated with each of the overlay features
1082 OVERLAY_FEATURE_NVGRE = 1,
1083 OVERLAY_FEATURE_VXLAN,
1084 OVERLAY_FEATURE_MAX,
1085 } overlay_feature_t;
1087 #define OVERLAY_OFFLOAD_ENABLE 0
1088 #define OVERLAY_OFFLOAD_DISABLE 1
1089 #define OVERLAY_OFFLOAD_ENABLE_V2 2
1091 #define OVERLAY_CFG_VXLAN_PORT_UPDATE 0
1094 * Use this enum to get the supported versions for each of these features
1095 * If you need to use the devcmd_get_supported_feature_version(), add
1096 * the new feature into this enum and install function handler in devcmd.c
1105 * These flags are used in args[1] of devcmd CMD_GET_SUPP_FEATURE_VER
1106 * to indicate the host driver about the VxLAN and Multi WQ features
1109 #define FEATURE_VXLAN_IPV6_INNER (1 << 0)
1110 #define FEATURE_VXLAN_IPV6_OUTER (1 << 1)
1111 #define FEATURE_VXLAN_MULTI_WQ (1 << 2)
1113 #define FEATURE_VXLAN_IPV6 (FEATURE_VXLAN_IPV6_INNER | \
1114 FEATURE_VXLAN_IPV6_OUTER)
1117 * CMD_CONFIG_GRPINTR subcommands
1125 #endif /* _VNIC_DEVCMD_H_ */