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),
141 /* nic_cfg in (u32)a0 */
142 CMD_NIC_CFG = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 16),
144 /* union vnic_rss_key in mem: (u64)a0=paddr, (u16)a1=len */
145 CMD_RSS_KEY = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 17),
147 /* union vnic_rss_cpu in mem: (u64)a0=paddr, (u16)a1=len */
148 CMD_RSS_CPU = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 18),
150 /* initiate softreset */
151 CMD_SOFT_RESET = _CMDCNW(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 19),
154 * out: a0=0 reset complete, a0=1 reset in progress */
155 CMD_SOFT_RESET_STATUS = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 20),
157 /* set struct vnic_devcmd_notify buffer in mem:
159 * (u64)a0=paddr to notify (set paddr=0 to unset)
160 * (u32)a1 & 0x00000000ffffffff=sizeof(struct vnic_devcmd_notify)
161 * (u16)a1 & 0x0000ffff00000000=intr num (-1 for no intr)
163 * (u32)a1 = effective size
165 CMD_NOTIFY = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 21),
167 /* UNDI API: (u64)a0=paddr to s_PXENV_UNDI_ struct,
168 * (u8)a1=PXENV_UNDI_xxx */
169 CMD_UNDI = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 22),
171 /* initiate open sequence (u32)a0=flags (see CMD_OPENF_*) */
172 CMD_OPEN = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 23),
175 * out: a0=0 open complete, a0=1 open in progress */
176 CMD_OPEN_STATUS = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 24),
179 CMD_CLOSE = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 25),
181 /* initialize virtual link: (u32)a0=flags (see CMD_INITF_*) */
182 /***** Replaced by CMD_INIT *****/
183 CMD_INIT_v1 = _CMDCNW(_CMD_DIR_READ, _CMD_VTYPE_ALL, 26),
185 /* variant of CMD_INIT, with provisioning info
186 * (u64)a0=paddr of vnic_devcmd_provinfo
187 * (u32)a1=sizeof provision info */
188 CMD_INIT_PROV_INFO = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 27),
190 /* enable virtual link */
191 CMD_ENABLE = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 28),
193 /* enable virtual link, waiting variant. */
194 CMD_ENABLE_WAIT = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 28),
196 /* disable virtual link */
197 CMD_DISABLE = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 29),
199 /* stats dump sum of all vnic stats on same uplink in mem:
201 * (u16)a1=sizeof stats area */
202 CMD_STATS_DUMP_ALL = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 30),
205 * out: a0=0 init complete, a0=1 init in progress
206 * if a0=0, a1=errno */
207 CMD_INIT_STATUS = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 31),
209 /* INT13 API: (u64)a0=paddr to vnic_int13_params struct
210 * (u32)a1=INT13_CMD_xxx */
211 CMD_INT13 = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_FC, 32),
213 /* logical uplink enable/disable: (u64)a0: 0/1=disable/enable */
214 CMD_LOGICAL_UPLINK = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 33),
216 /* undo initialize of virtual link */
217 CMD_DEINIT = _CMDCNW(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 34),
219 /* initialize virtual link: (u32)a0=flags (see CMD_INITF_*) */
220 CMD_INIT = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 35),
222 /* check fw capability of a cmd:
224 * out: (u32)a0=errno, 0:valid cmd, a1=supported VNIC_STF_* bits */
225 CMD_CAPABILITY = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 36),
227 /* persistent binding info
228 * in: (u64)a0=paddr of arg
229 * (u32)a1=CMD_PERBI_XXX */
230 CMD_PERBI = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_FC, 37),
232 /* Interrupt Assert Register functionality
233 * in: (u16)a0=interrupt number to assert
235 CMD_IAR = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 38),
237 /* initiate hangreset, like softreset after hang detected */
238 CMD_HANG_RESET = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 39),
241 * out: a0=0 reset complete, a0=1 reset in progress */
242 CMD_HANG_RESET_STATUS = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 40),
245 * Set hw ingress packet vlan rewrite mode:
246 * in: (u32)a0=new vlan rewrite mode
247 * out: (u32)a0=old vlan rewrite mode */
248 CMD_IG_VLAN_REWRITE_MODE = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ENET, 41),
251 * in: (u16)a0=bdf of target vnic
252 * (u32)a1=cmd to proxy
253 * a2-a15=args to cmd in a1
254 * out: (u32)a0=status of proxied cmd
255 * a1-a15=out args of proxied cmd */
256 CMD_PROXY_BY_BDF = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 42),
259 * As for BY_BDF except a0 is index of hvnlink subordinate vnic
260 * or SR-IOV virtual vnic
262 CMD_PROXY_BY_INDEX = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 43),
267 * in: (u64)a0=phsical address of buffer passed in from caller.
268 * (u16)a1=size of buffer specified in a0.
269 * out: (u64)a0=phsical address of buffer passed in from caller.
270 * (u16)a1=actual bytes from VIF-CONFIG-INFO TLV, or
271 * 0 if no VIF-CONFIG-INFO TLV was ever received. */
272 CMD_CONFIG_INFO_GET = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 44),
275 * INT13 API: (u64)a0=paddr to vnic_int13_params struct
276 * (u32)a1=INT13_CMD_xxx
278 CMD_INT13_ALL = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 45),
282 * in: (u16)a0=new default vlan
283 * (u16)a1=zero for overriding vlan with param a0,
284 * non-zero for resetting vlan to the default
285 * out: (u16)a0=old default vlan
287 CMD_SET_DEFAULT_VLAN = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 46),
290 * Variant of CMD_INIT_PROV_INFO, where it will not try to enable
291 * the vnic until CMD_ENABLE2 is issued.
292 * (u64)a0=paddr of vnic_devcmd_provinfo
293 * (u32)a1=sizeof provision info */
294 CMD_INIT_PROV_INFO2 = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 47),
297 * (u32)a0=0 ==> standby
298 * =CMD_ENABLE2_ACTIVE ==> active
300 CMD_ENABLE2 = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 48),
304 * Returns the status of the specified command
306 * a0 = command for which status is being queried.
307 * Possible values are:
314 * CMD_INIT_PROV_INFO2
317 * if status == STAT_ERROR
318 * a0 = ERR_ENOTSUPPORTED - status for command in a0 is
320 * if status == STAT_NONE
321 * a0 = status of the devcmd specified in a0 as follows.
322 * ERR_SUCCESS - command in a0 completed successfully
323 * ERR_EINPROGRESS - command in a0 is still in progress
325 CMD_STATUS = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 49),
328 * Returns interrupt coalescing timer conversion factors.
329 * After calling this devcmd, ENIC driver can convert
330 * interrupt coalescing timer in usec into CPU cycles as follows:
332 * intr_timer_cycles = intr_timer_usec * multiplier / divisor
334 * Interrupt coalescing timer in usecs can be be converted/obtained
335 * from CPU cycles as follows:
337 * intr_timer_usec = intr_timer_cycles * divisor / multiplier
340 * out: (u32)a0 = multiplier
342 * (u32)a2 = maximum timer value in usec
344 CMD_INTR_COAL_CONVERT = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 50),
348 * in: (u64)a0=paddr of the param or param itself
349 * (u32)a1=ISCSI_CMD_xxx
351 CMD_ISCSI_DUMP_REQ = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 51),
354 * ISCSI DUMP STATUS API:
355 * in: (u32)a0=cmd tag
356 * in: (u32)a1=ISCSI_CMD_xxx
357 * out: (u32)a0=cmd status
359 CMD_ISCSI_DUMP_STATUS = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 52),
362 * Subvnic migration from MQ <--> VF.
363 * Enable the LIF migration from MQ to VF and vice versa. MQ and VF
364 * indexes are statically bound at the time of initialization.
365 * Based on the direction of migration, the resources of either MQ or
366 * the VF shall be attached to the LIF.
367 * in: (u32)a0=Direction of Migration
370 * (u32)a1=VF index (MQ index)
372 CMD_MIGRATE_SUBVNIC = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 53),
375 * Register / Deregister the notification block for MQ subvnics
377 * (u64)a0=paddr to notify (set paddr=0 to unset)
378 * (u32)a1 & 0x00000000ffffffff=sizeof(struct vnic_devcmd_notify)
379 * (u16)a1 & 0x0000ffff00000000=intr num (-1 for no intr)
381 * (u32)a1 = effective size
383 CMD_SUBVNIC_NOTIFY = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 54),
386 * Set the predefined mac address as default
390 CMD_SET_MAC_ADDR = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 55),
392 /* Update the provisioning info of the given VIF
393 * (u64)a0=paddr of vnic_devcmd_provinfo
394 * (u32)a1=sizeof provision info */
395 CMD_PROV_INFO_UPDATE = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 56),
398 * Initialization for the devcmd2 interface.
399 * in: (u64) a0=host result buffer physical address
400 * in: (u16) a1=number of entries in result buffer
402 CMD_INITIALIZE_DEVCMD2 = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 57),
406 * in: (u64) a0= filter address
407 * (u32) a1= size of filter
408 * out: (u32) a0=filter identifier
411 * out: (u64) a0= 1 if capability query supported
412 * (u64) a1= MAX filter type supported
414 CMD_ADD_FILTER = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ENET, 58),
418 * in: (u32) a0=filter identifier
420 CMD_DEL_FILTER = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 59),
423 * Enable a Queue Pair in User space NIC
424 * in: (u32) a0=Queue Pair number
427 CMD_QP_ENABLE = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 60),
430 * Disable a Queue Pair in User space NIC
431 * in: (u32) a0=Queue Pair number
434 CMD_QP_DISABLE = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 61),
437 * Stats dump Queue Pair in User space NIC
438 * in: (u32) a0=Queue Pair number
439 * (u64) a1=host buffer addr for status dump
440 * (u32) a2=length of the buffer
442 CMD_QP_STATS_DUMP = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 62),
445 * Clear stats for Queue Pair in User space NIC
446 * in: (u32) a0=Queue Pair number
448 CMD_QP_STATS_CLEAR = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 63),
451 * UEFI BOOT API: (u64)a0= UEFI FLS_CMD_xxx
452 * (ui64)a1= paddr for the info buffer
454 CMD_FC_REQ = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_FC, 64),
457 * Return the iSCSI config details required by the EFI Option ROM
458 * in: (u32) a0=0 Get Boot Info for PXE eNIC as per pxe_boot_config_t
459 * a0=1 Get Boot info for iSCSI enic as per
460 * iscsi_boot_efi_cfg_t
461 * in: (u64) a1=Host address where iSCSI config info is returned
463 CMD_VNIC_BOOT_CONFIG_INFO = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 65),
466 * Create a Queue Pair (RoCE)
467 * in: (u32) a0 = Queue Pair number
468 * (u32) a1 = Remote QP
470 * (u16) a3 = RQ Res Group
471 * (u16) a4 = SQ Res Group
472 * (u32) a5 = Protection Domain
473 * (u64) a6 = Remote MAC
474 * (u32) a7 = start PSN
476 * (u32) a9 = protocol version
478 CMD_RDMA_QP_CREATE = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 66),
481 * Delete a Queue Pair (RoCE)
482 * in: (u32) a0 = Queue Pair number
484 CMD_RDMA_QP_DELETE = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 67),
487 * Retrieve a Queue Pair's status information (RoCE)
488 * in: (u32) a0 = Queue Pair number
489 * (u64) a1 = host buffer addr for QP status struct
490 * (u32) a2 = length of the buffer
492 CMD_RDMA_QP_STATUS = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ENET, 68),
495 * Use this devcmd for agreeing on the highest common version supported
496 * by both driver and fw for by features who need such a facility.
497 * in: (u64) a0 = feature (driver requests for the supported versions
499 * out: (u64) a0 = bitmap of all supported versions for that feature
501 CMD_GET_SUPP_FEATURE_VER = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ENET, 69),
504 * Initialize the RDMA notification work queue
505 * in: (u64) a0 = host buffer address
506 * in: (u16) a1 = number of entries in buffer
507 * in: (u16) a2 = resource group number
508 * in: (u16) a3 = CQ number to post completion
510 CMD_RDMA_INIT_INFO_BUF = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 70),
513 * De-init the RDMA notification work queue
514 * in: (u64) a0=resource group number
516 CMD_RDMA_DEINIT_INFO_BUF = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 71),
519 * Control (Enable/Disable) overlay offloads on the given vnic
520 * in: (u8) a0 = OVERLAY_FEATURE_NVGRE : NVGRE
521 * a0 = OVERLAY_FEATURE_VXLAN : VxLAN
522 * in: (u8) a1 = OVERLAY_OFFLOAD_ENABLE : Enable or
523 * a1 = OVERLAY_OFFLOAD_DISABLE : Disable or
524 * a1 = OVERLAY_OFFLOAD_ENABLE_V2 : Enable with version 2
526 CMD_OVERLAY_OFFLOAD_CTRL =
527 _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 72),
530 * Configuration of overlay offloads feature on a given vNIC
531 * in: (u8) a0 = OVERLAY_CFG_VXLAN_PORT_UPDATE : VxLAN
532 * in: (u16) a1 = unsigned short int port information
534 CMD_OVERLAY_OFFLOAD_CFG = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 73),
537 * Return the configured name for the device
538 * in: (u64) a0=Host address where the name is copied
539 * (u32) a1=Size of the buffer
541 CMD_GET_CONFIG_NAME = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 74),
544 * Enable group interrupt for the VF
545 * in: (u32) a0 = GRPINTR_ENABLE : enable
546 * a0 = GRPINTR_DISABLE : disable
547 * a0 = GRPINTR_UPD_VECT: update group vector addr
548 * in: (u32) a1 = interrupt group count
549 * in: (u64) a2 = Start of host buffer address for DMAing group
551 * in: (u64) a3 = Stride between group vectors
553 CMD_CONFIG_GRPINTR = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 75),
556 * Set cq arrary base and size in a list of consective wqs and
558 * in: (u16) a0 = the wq relative index in the device.
559 * -1 indicates skipping wq configuration
560 * in: (u16) a1 = the wcq relative index in the device
561 * in: (u16) a2 = the rq relative index in the device
562 * -1 indicates skipping rq configuration
563 * in: (u16) a3 = the rcq relative index in the device
565 CMD_CONFIG_CQ_ARRAY = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 76),
568 * Add an advanced filter.
569 * in: (u64) a0= filter address
570 * (u32) a1= size of filter
571 * out: (u32) a0=filter identifier
574 * in: (u64) a1= supported filter capability exchange modes
575 * out: (u64) a0= 1 if capability query supported
576 * if (u64) a1 = 0: a1 = MAX filter type supported
577 * if (u64) a1 & FILTER_CAP_MODE_V1_FLAG:
578 * a1 = bitmask of supported filters
579 * a2 = FILTER_CAP_MODE_V1
580 * a3 = bitmask of supported actions
582 CMD_ADD_ADV_FILTER = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ENET, 77),
585 /* Modes for exchanging advanced filter capabilities. The modes supported by
586 * the driver are passed in the CMD_ADD_ADV_FILTER capability command and the
587 * mode selected is returned.
588 * V0: the maximum filter type supported is returned
589 * V1: bitmasks of supported filters and actions are returned
591 enum filter_cap_mode {
592 FILTER_CAP_MODE_V0 = 0, /* Must always be 0 for legacy drivers */
593 FILTER_CAP_MODE_V1 = 1,
595 #define FILTER_CAP_MODE_V1_FLAG (1 << FILTER_CAP_MODE_V1)
597 /* CMD_ENABLE2 flags */
598 #define CMD_ENABLE2_STANDBY 0x0
599 #define CMD_ENABLE2_ACTIVE 0x1
601 /* flags for CMD_OPEN */
602 #define CMD_OPENF_OPROM 0x1 /* open coming from option rom */
603 #define CMD_OPENF_IG_DESCCACHE 0x2 /* Do not flush IG DESC cache */
605 /* flags for CMD_INIT */
606 #define CMD_INITF_DEFAULT_MAC 0x1 /* init with default mac addr */
608 /* flags for CMD_PACKET_FILTER */
609 #define CMD_PFILTER_DIRECTED 0x01
610 #define CMD_PFILTER_MULTICAST 0x02
611 #define CMD_PFILTER_BROADCAST 0x04
612 #define CMD_PFILTER_PROMISCUOUS 0x08
613 #define CMD_PFILTER_ALL_MULTICAST 0x10
615 /* Commands for CMD_QP_ENABLE/CM_QP_DISABLE */
616 #define CMD_QP_RQWQ 0x0
618 /* rewrite modes for CMD_IG_VLAN_REWRITE_MODE */
619 #define IG_VLAN_REWRITE_MODE_DEFAULT_TRUNK 0
620 #define IG_VLAN_REWRITE_MODE_UNTAG_DEFAULT_VLAN 1
621 #define IG_VLAN_REWRITE_MODE_PRIORITY_TAG_DEFAULT_VLAN 2
622 #define IG_VLAN_REWRITE_MODE_PASS_THRU 3
624 enum vnic_devcmd_status {
626 STAT_BUSY = 1 << 0, /* cmd in progress */
627 STAT_ERROR = 1 << 1, /* last cmd caused error (code in a0) */
628 STAT_FAILOVER = 1 << 2, /* always set on vnics in pci standby state
629 * if seen a failover to the standby happened
633 enum vnic_devcmd_error {
645 ERR_ENOTSUPPORTED = 11,
646 ERR_EINPROGRESS = 12,
651 * note: hw_version and asic_rev refer to the same thing,
652 * but have different formats. hw_version is
653 * a 32-byte string (e.g. "A2") and asic_rev is
654 * a 16-bit integer (e.g. 0xA2).
656 struct vnic_devcmd_fw_info {
660 char hw_serial_number[32];
665 enum fwinfo_asic_type {
666 FWINFO_ASIC_TYPE_UNKNOWN,
667 FWINFO_ASIC_TYPE_PALO,
668 FWINFO_ASIC_TYPE_SERENO,
669 FWINFO_ASIC_TYPE_CRUZ,
672 struct vnic_devcmd_notify {
673 u32 csum; /* checksum over following words */
675 u32 link_state; /* link up == 1 */
676 u32 port_speed; /* effective port speed (rate limit) */
678 u32 msglvl; /* requested driver msg lvl */
679 u32 uif; /* uplink interface */
680 u32 status; /* status bits (see VNIC_STF_*) */
681 u32 error; /* error code (see ERR_*) for first ERR */
682 u32 link_down_cnt; /* running count of link down transitions */
683 u32 perbi_rebuild_cnt; /* running count of perbi rebuilds */
685 #define VNIC_STF_FATAL_ERR 0x0001 /* fatal fw error */
686 #define VNIC_STF_STD_PAUSE 0x0002 /* standard link-level pause on */
687 #define VNIC_STF_PFC_PAUSE 0x0004 /* priority flow control pause on */
688 /* all supported status flags */
689 #define VNIC_STF_ALL (VNIC_STF_FATAL_ERR |\
690 VNIC_STF_STD_PAUSE |\
691 VNIC_STF_PFC_PAUSE |\
694 struct vnic_devcmd_provinfo {
701 * These are used in flags field of different filters to denote
704 #define FILTER_FIELD_VALID(fld) (1 << (fld - 1))
706 #define FILTER_FIELD_USNIC_VLAN FILTER_FIELD_VALID(1)
707 #define FILTER_FIELD_USNIC_ETHTYPE FILTER_FIELD_VALID(2)
708 #define FILTER_FIELD_USNIC_PROTO FILTER_FIELD_VALID(3)
709 #define FILTER_FIELD_USNIC_ID FILTER_FIELD_VALID(4)
711 #define FILTER_FIELDS_USNIC (FILTER_FIELD_USNIC_VLAN | \
712 FILTER_FIELD_USNIC_ETHTYPE | \
713 FILTER_FIELD_USNIC_PROTO | \
714 FILTER_FIELD_USNIC_ID)
716 struct filter_usnic_id {
722 } __attribute__((packed));
724 #define FILTER_FIELD_5TUP_PROTO FILTER_FIELD_VALID(1)
725 #define FILTER_FIELD_5TUP_SRC_AD FILTER_FIELD_VALID(2)
726 #define FILTER_FIELD_5TUP_DST_AD FILTER_FIELD_VALID(3)
727 #define FILTER_FIELD_5TUP_SRC_PT FILTER_FIELD_VALID(4)
728 #define FILTER_FIELD_5TUP_DST_PT FILTER_FIELD_VALID(5)
730 #define FILTER_FIELDS_IPV4_5TUPLE (FILTER_FIELD_5TUP_PROTO | \
731 FILTER_FIELD_5TUP_SRC_AD | \
732 FILTER_FIELD_5TUP_DST_AD | \
733 FILTER_FIELD_5TUP_SRC_PT | \
734 FILTER_FIELD_5TUP_DST_PT)
736 /* Enums for the protocol field. */
744 struct filter_ipv4_5tuple {
751 } __attribute__((packed));
753 #define FILTER_FIELD_VMQ_VLAN FILTER_FIELD_VALID(1)
754 #define FILTER_FIELD_VMQ_MAC FILTER_FIELD_VALID(2)
756 #define FILTER_FIELDS_MAC_VLAN (FILTER_FIELD_VMQ_VLAN | \
757 FILTER_FIELD_VMQ_MAC)
759 #define FILTER_FIELDS_NVGRE FILTER_FIELD_VMQ_MAC
761 struct filter_mac_vlan {
765 } __attribute__((packed));
767 #define FILTER_FIELD_VLAN_IP_3TUP_VLAN FILTER_FIELD_VALID(1)
768 #define FILTER_FIELD_VLAN_IP_3TUP_L3_PROTO FILTER_FIELD_VALID(2)
769 #define FILTER_FIELD_VLAN_IP_3TUP_DST_AD FILTER_FIELD_VALID(3)
770 #define FILTER_FIELD_VLAN_IP_3TUP_L4_PROTO FILTER_FIELD_VALID(4)
771 #define FILTER_FIELD_VLAN_IP_3TUP_DST_PT FILTER_FIELD_VALID(5)
773 #define FILTER_FIELDS_VLAN_IP_3TUP (FILTER_FIELD_VLAN_IP_3TUP_VLAN | \
774 FILTER_FIELD_VLAN_IP_3TUP_L3_PROTO | \
775 FILTER_FIELD_VLAN_IP_3TUP_DST_AD | \
776 FILTER_FIELD_VLAN_IP_3TUP_L4_PROTO | \
777 FILTER_FIELD_VLAN_IP_3TUP_DST_PT)
779 struct filter_vlan_ip_3tuple {
789 } __attribute__((packed));
791 #define FILTER_GENERIC_1_BYTES 64
793 enum filter_generic_1_layer {
798 FILTER_GENERIC_1_NUM_LAYERS
801 #define FILTER_GENERIC_1_IPV4 (1 << 0)
802 #define FILTER_GENERIC_1_IPV6 (1 << 1)
803 #define FILTER_GENERIC_1_UDP (1 << 2)
804 #define FILTER_GENERIC_1_TCP (1 << 3)
805 #define FILTER_GENERIC_1_TCP_OR_UDP (1 << 4)
806 #define FILTER_GENERIC_1_IP4SUM_OK (1 << 5)
807 #define FILTER_GENERIC_1_L4SUM_OK (1 << 6)
808 #define FILTER_GENERIC_1_IPFRAG (1 << 7)
810 #define FILTER_GENERIC_1_KEY_LEN 64
813 * Version 1 of generic filter specification
814 * position is only 16 bits, reserving positions > 64k to be used by firmware
816 struct filter_generic_1 {
817 u16 position; /* lower position comes first */
823 u8 mask[FILTER_GENERIC_1_KEY_LEN]; /* 0 bit means "don't care"*/
824 u8 val[FILTER_GENERIC_1_KEY_LEN];
825 } __attribute__((packed)) layer[FILTER_GENERIC_1_NUM_LAYERS];
826 } __attribute__((packed));
828 /* Specifies the filter_action type. */
830 FILTER_ACTION_RQ_STEERING = 0,
831 FILTER_ACTION_V2 = 1,
835 struct filter_action {
840 } __attribute__((packed));
842 #define FILTER_ACTION_RQ_STEERING_FLAG (1 << 0)
843 #define FILTER_ACTION_FILTER_ID_FLAG (1 << 1)
844 #define FILTER_ACTION_DROP_FLAG (1 << 2)
845 #define FILTER_ACTION_V2_ALL (FILTER_ACTION_RQ_STEERING_FLAG \
846 | FILTER_ACTION_DROP_FLAG \
847 | FILTER_ACTION_FILTER_ID_FLAG)
849 /* Version 2 of filter action must be a strict extension of struct filter_action
850 * where the first fields exactly match in size and meaning.
852 struct filter_action_v2 {
855 u32 flags; /* use FILTER_ACTION_XXX_FLAG defines */
857 u_int8_t reserved[32]; /* for future expansion */
858 } __attribute__((packed));
860 /* Specifies the filter type. */
863 FILTER_IPV4_5TUPLE = 1,
865 FILTER_VLAN_IP_3TUPLE = 3,
866 FILTER_NVGRE_VMQ = 4,
872 #define FILTER_USNIC_ID_FLAG (1 << FILTER_USNIC_ID)
873 #define FILTER_IPV4_5TUPLE_FLAG (1 << FILTER_IPV4_5TUPLE)
874 #define FILTER_MAC_VLAN_FLAG (1 << FILTER_MAC_VLAN)
875 #define FILTER_VLAN_IP_3TUPLE_FLAG (1 << FILTER_VLAN_IP_3TUPLE)
876 #define FILTER_NVGRE_VMQ_FLAG (1 << FILTER_NVGRE_VMQ)
877 #define FILTER_USNIC_IP_FLAG (1 << FILTER_USNIC_IP)
878 #define FILTER_DPDK_1_FLAG (1 << FILTER_DPDK_1)
879 #define FILTER_V1_ALL (FILTER_USNIC_ID_FLAG | \
880 FILTER_IPV4_5TUPLE_FLAG | \
881 FILTER_MAC_VLAN_FLAG | \
882 FILTER_VLAN_IP_3TUPLE_FLAG | \
883 FILTER_NVGRE_VMQ_FLAG | \
884 FILTER_USNIC_IP_FLAG | \
890 struct filter_usnic_id usnic;
891 struct filter_ipv4_5tuple ipv4;
892 struct filter_mac_vlan mac_vlan;
893 struct filter_vlan_ip_3tuple vlan_3tuple;
895 } __attribute__((packed));
898 * This is a strict superset of "struct filter" and exists only
899 * because many drivers use "sizeof (struct filter)" in deciding TLV size.
900 * This new, larger struct filter would cause any code that uses that method
901 * to not work with older firmware, so we add filter_v2 to hold the
902 * new filter types. Drivers should use vnic_filter_size() to determine
903 * the TLV size instead of sizeof (struct fiter_v2) to guard against future
909 struct filter_usnic_id usnic;
910 struct filter_ipv4_5tuple ipv4;
911 struct filter_mac_vlan mac_vlan;
912 struct filter_vlan_ip_3tuple vlan_3tuple;
913 struct filter_generic_1 generic_1;
915 } __attribute__((packed));
928 /* Data for CMD_ADD_FILTER is 2 TLV and filter + action structs */
929 #define FILTER_MAX_BUF_SIZE 100
930 #define FILTER_V2_MAX_BUF_SIZE (sizeof(struct filter_v2) + \
931 sizeof(struct filter_action_v2) + \
932 (2 * sizeof(struct filter_tlv)))
935 * Compute actual structure size given filter type. To be "future-proof,"
936 * drivers should use this instead of "sizeof (struct filter_v2)" when
937 * computing length for TLV.
939 static inline u_int32_t
940 vnic_filter_size(struct filter_v2 *fp)
945 case FILTER_USNIC_ID:
946 size = sizeof(fp->u.usnic);
948 case FILTER_IPV4_5TUPLE:
949 size = sizeof(fp->u.ipv4);
951 case FILTER_MAC_VLAN:
952 case FILTER_NVGRE_VMQ:
953 size = sizeof(fp->u.mac_vlan);
955 case FILTER_VLAN_IP_3TUPLE:
956 size = sizeof(fp->u.vlan_3tuple);
958 case FILTER_USNIC_IP:
960 size = sizeof(fp->u.generic_1);
963 size = sizeof(fp->u);
966 size += sizeof(fp->type);
977 * Get the action structure size given action type. To be "future-proof,"
978 * drivers should use this instead of "sizeof (struct filter_action_v2)"
979 * when computing length for TLV.
981 static inline u_int32_t
982 vnic_action_size(struct filter_action_v2 *fap)
987 case FILTER_ACTION_RQ_STEERING:
988 size = sizeof(struct filter_action);
990 case FILTER_ACTION_V2:
991 size = sizeof(struct filter_action_v2);
994 size = sizeof(struct filter_action);
1001 * Writing cmd register causes STAT_BUSY to get set in status register.
1002 * When cmd completes, STAT_BUSY will be cleared.
1004 * If cmd completed successfully STAT_ERROR will be clear
1005 * and args registers contain cmd-specific results.
1007 * If cmd error, STAT_ERROR will be set and args[0] contains error code.
1009 * status register is read-only. While STAT_BUSY is set,
1010 * all other register contents are read-only.
1013 /* Make sizeof(vnic_devcmd) a power-of-2 for I/O BAR. */
1014 #define VNIC_DEVCMD_NARGS 15
1015 struct vnic_devcmd {
1016 u32 status; /* RO */
1018 u64 args[VNIC_DEVCMD_NARGS]; /* RW cmd args (little-endian) */
1022 * Version 2 of the interface.
1024 * Some things are carried over, notably the vnic_devcmd_cmd enum.
1028 * Flags for vnic_devcmd2.flags
1031 #define DEVCMD2_FNORESULT 0x1 /* Don't copy result to host */
1033 #define VNIC_DEVCMD2_NARGS VNIC_DEVCMD_NARGS
1034 struct vnic_devcmd2 {
1037 u32 cmd; /* same command #defines as original */
1038 u64 args[VNIC_DEVCMD2_NARGS];
1041 #define VNIC_DEVCMD2_NRESULTS VNIC_DEVCMD_NARGS
1042 struct devcmd2_result {
1043 u64 results[VNIC_DEVCMD2_NRESULTS];
1045 u16 completed_index; /* into copy WQ */
1046 u8 error; /* same error codes as original */
1047 u8 color; /* 0 or 1 as with completion queues */
1050 #define DEVCMD2_RING_SIZE 32
1051 #define DEVCMD2_DESC_SIZE 128
1053 #define DEVCMD2_RESULTS_SIZE_MAX ((1 << 16) - 1)
1055 /* Overlay related definitions */
1058 * This enum lists the flag associated with each of the overlay features
1061 OVERLAY_FEATURE_NVGRE = 1,
1062 OVERLAY_FEATURE_VXLAN,
1063 OVERLAY_FEATURE_MAX,
1064 } overlay_feature_t;
1066 #define OVERLAY_OFFLOAD_ENABLE 0
1067 #define OVERLAY_OFFLOAD_DISABLE 1
1068 #define OVERLAY_OFFLOAD_ENABLE_V2 2
1070 #define OVERLAY_CFG_VXLAN_PORT_UPDATE 0
1073 * Use this enum to get the supported versions for each of these features
1074 * If you need to use the devcmd_get_supported_feature_version(), add
1075 * the new feature into this enum and install function handler in devcmd.c
1084 * CMD_CONFIG_GRPINTR subcommands
1092 #endif /* _VNIC_DEVCMD_H_ */