/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright 2008-2017 Cisco Systems, Inc.  All rights reserved.
 * Copyright 2007 Nuova Systems, Inc.  All rights reserved.
 */

#ifndef _VNIC_DEVCMD_H_
#define _VNIC_DEVCMD_H_

#define _CMD_NBITS      14
#define _CMD_VTYPEBITS	10
#define _CMD_FLAGSBITS  6
#define _CMD_DIRBITS	2

#define _CMD_NMASK      ((1 << _CMD_NBITS)-1)
#define _CMD_VTYPEMASK  ((1 << _CMD_VTYPEBITS)-1)
#define _CMD_FLAGSMASK  ((1 << _CMD_FLAGSBITS)-1)
#define _CMD_DIRMASK    ((1 << _CMD_DIRBITS)-1)

#define _CMD_NSHIFT     0
#define _CMD_VTYPESHIFT (_CMD_NSHIFT+_CMD_NBITS)
#define _CMD_FLAGSSHIFT (_CMD_VTYPESHIFT+_CMD_VTYPEBITS)
#define _CMD_DIRSHIFT   (_CMD_FLAGSSHIFT+_CMD_FLAGSBITS)

/*
 * Direction bits (from host perspective).
 */
#define _CMD_DIR_NONE   0U
#define _CMD_DIR_WRITE  1U
#define _CMD_DIR_READ   2U
#define _CMD_DIR_RW     (_CMD_DIR_WRITE | _CMD_DIR_READ)

/*
 * Flag bits.
 */
#define _CMD_FLAGS_NONE 0U
#define _CMD_FLAGS_NOWAIT 1U

/*
 * vNIC type bits.
 */
#define _CMD_VTYPE_NONE  0U
#define _CMD_VTYPE_ENET  1U
#define _CMD_VTYPE_FC    2U
#define _CMD_VTYPE_SCSI  4U
#define _CMD_VTYPE_ALL   (_CMD_VTYPE_ENET | _CMD_VTYPE_FC | _CMD_VTYPE_SCSI)

/*
 * Used to create cmds..
 */
#define _CMDCF(dir, flags, vtype, nr)  \
	(((dir)   << _CMD_DIRSHIFT) | \
	((flags) << _CMD_FLAGSSHIFT) | \
	((vtype) << _CMD_VTYPESHIFT) | \
	((nr)    << _CMD_NSHIFT))
#define _CMDC(dir, vtype, nr)    _CMDCF(dir, 0, vtype, nr)
#define _CMDCNW(dir, vtype, nr)  _CMDCF(dir, _CMD_FLAGS_NOWAIT, vtype, nr)

/*
 * Used to decode cmds..
 */
#define _CMD_DIR(cmd)            (((cmd) >> _CMD_DIRSHIFT) & _CMD_DIRMASK)
#define _CMD_FLAGS(cmd)          (((cmd) >> _CMD_FLAGSSHIFT) & _CMD_FLAGSMASK)
#define _CMD_VTYPE(cmd)          (((cmd) >> _CMD_VTYPESHIFT) & _CMD_VTYPEMASK)
#define _CMD_N(cmd)              (((cmd) >> _CMD_NSHIFT) & _CMD_NMASK)

#define ARRAY_SIZE(x) RTE_DIM(x)

enum vnic_devcmd_cmd {
	CMD_NONE                = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_NONE, 0),

	/*
	 * mcpu fw info in mem:
	 * in:
	 *   (uint64_t)a0=paddr to struct vnic_devcmd_fw_info
	 * action:
	 *   Fills in struct vnic_devcmd_fw_info (128 bytes)
	 * note:
	 *   An old definition of CMD_MCPU_FW_INFO
	 */
	CMD_MCPU_FW_INFO_OLD    = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 1),

	/*
	 * mcpu fw info in mem:
	 * in:
	 *   (uint64_t)a0=paddr to struct vnic_devcmd_fw_info
	 *   (uint16_t)a1=size of the structure
	 * out:
	 *	 (uint16_t)a1=0                       for in:a1 = 0,
	 *	         data size actually written for other values.
	 * action:
	 *   Fills in first 128 bytes of vnic_devcmd_fw_info for in:a1 = 0,
	 *            first in:a1 bytes               for 0 < in:a1 <= 132,
	 *            132 bytes                       for other values of in:a1.
	 * note:
	 *   CMD_MCPU_FW_INFO and CMD_MCPU_FW_INFO_OLD have the same enum 1
	 *   for source compatibility.
	 */
	CMD_MCPU_FW_INFO        = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 1),

	/* dev-specific block member:
	 *    in: (uint16_t)a0=offset,(uint8_t)a1=size
	 *    out: a0=value
	 */
	CMD_DEV_SPEC            = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 2),

	/* stats clear */
	CMD_STATS_CLEAR         = _CMDCNW(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 3),

	/* stats dump in mem: (uint64_t)a0=paddr to stats area,
	 *                    (uint16_t)a1=sizeof stats area
	 */
	CMD_STATS_DUMP          = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 4),

	/* set Rx packet filter: (uint32_t)a0=filters (see CMD_PFILTER_*) */
	CMD_PACKET_FILTER	= _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 7),

	/* set Rx packet filter for all: (uint32_t)a0=filters
	 * (see CMD_PFILTER_*)
	 */
	CMD_PACKET_FILTER_ALL   = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 7),

	/* hang detection notification */
	CMD_HANG_NOTIFY         = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 8),

	/* MAC address in (u48)a0 */
	CMD_MAC_ADDR            = _CMDC(_CMD_DIR_READ,
					_CMD_VTYPE_ENET | _CMD_VTYPE_FC, 9),
#define CMD_GET_MAC_ADDR CMD_MAC_ADDR   /* some uses are aliased */

	/* add addr from (u48)a0 */
	CMD_ADDR_ADD            = _CMDCNW(_CMD_DIR_WRITE,
					_CMD_VTYPE_ENET | _CMD_VTYPE_FC, 12),

	/* del addr from (u48)a0 */
	CMD_ADDR_DEL            = _CMDCNW(_CMD_DIR_WRITE,
					_CMD_VTYPE_ENET | _CMD_VTYPE_FC, 13),

	/* add VLAN id in (uint16_t)a0 */
	CMD_VLAN_ADD            = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 14),

	/* del VLAN id in (uint16_t)a0 */
	CMD_VLAN_DEL            = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 15),

	/*
	 * nic_cfg in (uint32_t)a0
	 *
	 * Capability query:
	 * out: (uint64_t) a0= 1 if a1 is valid
	 *      (uint64_t) a1= (NIC_CFG bits supported) | (flags << 32)
	 *                              (flags are CMD_NIC_CFG_CAPF_xxx)
	 */
	CMD_NIC_CFG             = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 16),

	/*
	 * nic_cfg_chk  (same as nic_cfg, but may return error)
	 * in (uint32_t)a0
	 *
	 * Capability query:
	 * out: (uint64_t) a0= 1 if a1 is valid
	 *      (uint64_t) a1= (NIC_CFG bits supported) | (flags << 32)
	 *                              (flags are CMD_NIC_CFG_CAPF_xxx)
	 */
	CMD_NIC_CFG_CHK         = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 16),

	/* union vnic_rss_key in mem: (uint64_t)a0=paddr, (uint16_t)a1=len */
	CMD_RSS_KEY             = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 17),

	/* union vnic_rss_cpu in mem: (uint64_t)a0=paddr, (uint16_t)a1=len */
	CMD_RSS_CPU             = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 18),

	/* initiate softreset */
	CMD_SOFT_RESET          = _CMDCNW(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 19),

	/* softreset status:
	 *    out: a0=0 reset complete, a0=1 reset in progress */
	CMD_SOFT_RESET_STATUS   = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 20),

	/* set struct vnic_devcmd_notify buffer in mem:
	 * in:
	 *   (uint64_t)a0=paddr to notify (set paddr=0 to unset)
	 *   (uint32_t)a1 & 0x00000000ffffffff=sizeof(struct vnic_devcmd_notify)
	 *   (uint16_t)a1 & 0x0000ffff00000000=intr num (-1 for no intr)
	 * out:
	 *   (uint32_t)a1 = effective size
	 */
	CMD_NOTIFY              = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 21),

	/* UNDI API: (uint64_t)a0=paddr to s_PXENV_UNDI_ struct,
	 *           (uint8_t)a1=PXENV_UNDI_xxx
	 */
	CMD_UNDI                = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 22),

	/* initiate open sequence (uint32_t)a0=flags (see CMD_OPENF_*) */
	CMD_OPEN		= _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 23),

	/* open status:
	 *    out: a0=0 open complete, a0=1 open in progress */
	CMD_OPEN_STATUS		= _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 24),

	/* close vnic */
	CMD_CLOSE		= _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 25),

	/* initialize virtual link: (uint32_t)a0=flags (see CMD_INITF_*) */
/***** Replaced by CMD_INIT *****/
	CMD_INIT_v1		= _CMDCNW(_CMD_DIR_READ, _CMD_VTYPE_ALL, 26),

	/* variant of CMD_INIT, with provisioning info
	 *     (uint64_t)a0=paddr of vnic_devcmd_provinfo
	 *     (uint32_t)a1=sizeof provision info
	 */
	CMD_INIT_PROV_INFO	= _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 27),

	/* enable virtual link */
	CMD_ENABLE		= _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 28),

	/* enable virtual link, waiting variant. */
	CMD_ENABLE_WAIT		= _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 28),

	/* disable virtual link */
	CMD_DISABLE		= _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 29),

	/* stats dump sum of all vnic stats on same uplink in mem:
	 *     (uint64_t)a0=paddr
	 *     (uint16_t)a1=sizeof stats area
	 */
	CMD_STATS_DUMP_ALL	= _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 30),

	/* init status:
	 *    out: a0=0 init complete, a0=1 init in progress
	 *         if a0=0, a1=errno
	 */
	CMD_INIT_STATUS		= _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 31),

	/* INT13 API: (uint64_t)a0=paddr to vnic_int13_params struct
	 *            (uint32_t)a1=INT13_CMD_xxx
	 */
	CMD_INT13               = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_FC, 32),

	/* logical uplink enable/disable: (uint64_t)a0: 0/1=disable/enable */
	CMD_LOGICAL_UPLINK      = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 33),

	/* undo initialize of virtual link */
	CMD_DEINIT		= _CMDCNW(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 34),

	/* initialize virtual link: (uint32_t)a0=flags (see CMD_INITF_*) */
	CMD_INIT		= _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 35),

	/* check fw capability of a cmd:
	 * in:  (uint32_t)a0=cmd
	 * out: (uint32_t)a0=errno, 0:valid cmd, a1=supported VNIC_STF_* bits
	 */
	CMD_CAPABILITY		= _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 36),

	/* persistent binding info
	 * in:  (uint64_t)a0=paddr of arg
	 *      (uint32_t)a1=CMD_PERBI_XXX
	 */
	CMD_PERBI		= _CMDC(_CMD_DIR_RW, _CMD_VTYPE_FC, 37),

	/* Interrupt Assert Register functionality
	 * in: (uint16_t)a0=interrupt number to assert
	 */
	CMD_IAR			= _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 38),

	/* initiate hangreset, like softreset after hang detected */
	CMD_HANG_RESET		= _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 39),

	/* hangreset status:
	 *    out: a0=0 reset complete, a0=1 reset in progress
	 */
	CMD_HANG_RESET_STATUS   = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 40),

	/*
	 * Set hw ingress packet vlan rewrite mode:
	 * in:  (uint32_t)a0=new vlan rewrite mode
	 * out: (uint32_t)a0=old vlan rewrite mode
	 */
	CMD_IG_VLAN_REWRITE_MODE = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ENET, 41),

	/*
	 * in:  (uint16_t)a0=bdf of target vnic
	 *      (uint32_t)a1=cmd to proxy
	 *      a2-a15=args to cmd in a1
	 * out: (uint32_t)a0=status of proxied cmd
	 *      a1-a15=out args of proxied cmd
	 */
	CMD_PROXY_BY_BDF =	_CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 42),

	/*
	 * As for BY_BDF except a0 is index of hvnlink subordinate vnic
	 * or SR-IOV virtual vnic
	 */
	CMD_PROXY_BY_INDEX =    _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 43),

	/*
	 * For HPP toggle:
	 * adapter-info-get
	 * in:  (uint64_t)a0=phsical address of buffer passed in from caller.
	 *      (uint16_t)a1=size of buffer specified in a0.
	 * out: (uint64_t)a0=phsical address of buffer passed in from caller.
	 *      (uint16_t)a1=actual bytes from VIF-CONFIG-INFO TLV, or
	 *              0 if no VIF-CONFIG-INFO TLV was ever received.
	 */
	CMD_CONFIG_INFO_GET = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 44),

	/*
	 * INT13 API: (uint64_t)a0=paddr to vnic_int13_params struct
	 *            (uint32_t)a1=INT13_CMD_xxx
	 */
	CMD_INT13_ALL = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 45),

	/*
	 * Set default vlan:
	 * in: (uint16_t)a0=new default vlan
	 *     (uint16_t)a1=zero for overriding vlan with param a0,
	 *		       non-zero for resetting vlan to the default
	 * out: (uint16_t)a0=old default vlan
	 */
	CMD_SET_DEFAULT_VLAN = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 46),

	/* init_prov_info2:
	 * Variant of CMD_INIT_PROV_INFO, where it will not try to enable
	 * the vnic until CMD_ENABLE2 is issued.
	 *     (uint64_t)a0=paddr of vnic_devcmd_provinfo
	 *     (uint32_t)a1=sizeof provision info
	 */
	CMD_INIT_PROV_INFO2  = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 47),

	/* enable2:
	 *      (uint32_t)a0=0                  ==> standby
	 *             =CMD_ENABLE2_ACTIVE ==> active
	 */
	CMD_ENABLE2 = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 48),

	/*
	 * cmd_status:
	 *     Returns the status of the specified command
	 * Input:
	 *     a0 = command for which status is being queried.
	 *          Possible values are:
	 *              CMD_SOFT_RESET
	 *              CMD_HANG_RESET
	 *              CMD_OPEN
	 *              CMD_INIT
	 *              CMD_INIT_PROV_INFO
	 *              CMD_DEINIT
	 *              CMD_INIT_PROV_INFO2
	 *              CMD_ENABLE2
	 * Output:
	 *     if status == STAT_ERROR
	 *        a0 = ERR_ENOTSUPPORTED - status for command in a0 is
	 *                                 not supported
	 *     if status == STAT_NONE
	 *        a0 = status of the devcmd specified in a0 as follows.
	 *             ERR_SUCCESS   - command in a0 completed successfully
	 *             ERR_EINPROGRESS - command in a0 is still in progress
	 */
	CMD_STATUS = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 49),

	/*
	 * Returns interrupt coalescing timer conversion factors.
	 * After calling this devcmd, ENIC driver can convert
	 * interrupt coalescing timer in usec into CPU cycles as follows:
	 *
	 *   intr_timer_cycles = intr_timer_usec * multiplier / divisor
	 *
	 * Interrupt coalescing timer in usecs can be be converted/obtained
	 * from CPU cycles as follows:
	 *
	 *   intr_timer_usec = intr_timer_cycles * divisor / multiplier
	 *
	 * in: none
	 * out: (uint32_t)a0 = multiplier
	 *      (uint32_t)a1 = divisor
	 *      (uint32_t)a2 = maximum timer value in usec
	 */
	CMD_INTR_COAL_CONVERT = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 50),

	/*
	 * ISCSI DUMP API:
	 * in: (uint64_t)a0=paddr of the param or param itself
	 *     (uint32_t)a1=ISCSI_CMD_xxx
	 */
	CMD_ISCSI_DUMP_REQ = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 51),

	/*
	 * ISCSI DUMP STATUS API:
	 * in: (uint32_t)a0=cmd tag
	 * in: (uint32_t)a1=ISCSI_CMD_xxx
	 * out: (uint32_t)a0=cmd status
	 */
	CMD_ISCSI_DUMP_STATUS = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 52),

	/*
	 * Subvnic migration from MQ <--> VF.
	 * Enable the LIF migration from MQ to VF and vice versa. MQ and VF
	 * indexes are statically bound at the time of initialization.
	 * Based on the direction of migration, the resources of either MQ or
	 * the VF shall be attached to the LIF.
	 * in:        (uint32_t)a0=Direction of Migration
	 *					0=> Migrate to VF
	 *					1=> Migrate to MQ
	 *            (uint32_t)a1=VF index (MQ index)
	 */
	CMD_MIGRATE_SUBVNIC = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 53),

	/*
	 * Register / Deregister the notification block for MQ subvnics
	 * in:
	 *   (uint64_t)a0=paddr to notify (set paddr=0 to unset)
	 *   (uint32_t)a1 & 0x00000000ffffffff=sizeof(struct vnic_devcmd_notify)
	 *   (uint16_t)a1 & 0x0000ffff00000000=intr num (-1 for no intr)
	 * out:
	 *   (uint32_t)a1 = effective size
	 */
	CMD_SUBVNIC_NOTIFY = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 54),

	/*
	 * Set the predefined mac address as default
	 * in:
	 *   (u48)a0=mac addr
	 */
	CMD_SET_MAC_ADDR = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 55),

	/* Update the provisioning info of the given VIF
	 *     (uint64_t)a0=paddr of vnic_devcmd_provinfo
	 *     (uint32_t)a1=sizeof provision info
	 */
	CMD_PROV_INFO_UPDATE = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 56),

	/*
	 * Initialization for the devcmd2 interface.
	 * in: (uint64_t) a0=host result buffer physical address
	 * in: (uint16_t) a1=number of entries in result buffer
	 */
	CMD_INITIALIZE_DEVCMD2 = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 57),

	/*
	 * Add a filter.
	 * in: (uint64_t) a0= filter address
	 *     (uint32_t) a1= size of filter
	 * out: (uint32_t) a0=filter identifier
	 *
	 * Capability query:
	 * out: (uint64_t) a0= 1 if capability query supported
	 *      (uint64_t) a1= MAX filter type supported
	 */
	CMD_ADD_FILTER = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ENET, 58),

	/*
	 * Delete a filter.
	 * in: (uint32_t) a0=filter identifier
	 */
	CMD_DEL_FILTER = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 59),

	/*
	 * Enable a Queue Pair in User space NIC
	 * in: (uint32_t) a0=Queue Pair number
	 *     (uint32_t) a1= command
	 */
	CMD_QP_ENABLE = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 60),

	/*
	 * Disable a Queue Pair in User space NIC
	 * in: (uint32_t) a0=Queue Pair number
	 *     (uint32_t) a1= command
	 */
	CMD_QP_DISABLE = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 61),

	/*
	 * Stats dump Queue Pair in User space NIC
	 * in: (uint32_t) a0=Queue Pair number
	 *     (uint64_t) a1=host buffer addr for status dump
	 *     (uint32_t) a2=length of the buffer
	 */
	CMD_QP_STATS_DUMP = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 62),

	/*
	 * Clear stats for Queue Pair in User space NIC
	 * in: (uint32_t) a0=Queue Pair number
	 */
	CMD_QP_STATS_CLEAR = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 63),

	/*
	 * UEFI BOOT API: (uint64_t)a0= UEFI FLS_CMD_xxx
	 * (ui64)a1= paddr for the info buffer
	 */
	CMD_FC_REQ = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_FC, 64),

	/*
	 * Return the iSCSI config details required by the EFI Option ROM
	 * in:  (uint32_t) a0=0 Get Boot Info for PXE eNIC as per
	 *      pxe_boot_config_t
	 *            a0=1 Get Boot info for iSCSI enic as per
	 *            iscsi_boot_efi_cfg_t
	 * in:  (uint64_t) a1=Host address where iSCSI config info is returned
	 */
	CMD_VNIC_BOOT_CONFIG_INFO = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 65),

	/*
	 * Create a Queue Pair (RoCE)
	 * in: (uint32_t) a0 = Queue Pair number
	 *     (uint32_t) a1 = Remote QP
	 *     (uint32_t) a2 = RDMA-RQ
	 *     (uint16_t) a3 = RQ Res Group
	 *     (uint16_t) a4 = SQ Res Group
	 *     (uint32_t) a5 = Protection Domain
	 *     (uint64_t) a6 = Remote MAC
	 *     (uint32_t) a7 = start PSN
	 *     (uint16_t) a8 = MSS
	 *     (uint32_t) a9 = protocol version
	 */
	CMD_RDMA_QP_CREATE = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 66),

	/*
	 * Delete a Queue Pair (RoCE)
	 * in: (uint32_t) a0 = Queue Pair number
	 */
	CMD_RDMA_QP_DELETE = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 67),

	/*
	 * Retrieve a Queue Pair's status information (RoCE)
	 * in: (uint32_t) a0 = Queue Pair number
	 *     (uint64_t) a1 = host buffer addr for QP status struct
	 *     (uint32_t) a2 = length of the buffer
	 */
	CMD_RDMA_QP_STATUS = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ENET, 68),

	/*
	 * Use this devcmd for agreeing on the highest common version supported
	 * by both driver and fw for by features who need such a facility.
	 *  in:  (uint64_t) a0 = feature (driver requests for the supported
	 *       versions on this feature)
	 *  out: (uint64_t) a0 = bitmap of all supported versions for that
	 *       feature
	 */
	CMD_GET_SUPP_FEATURE_VER = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ENET, 69),

	/*
	 * Initialize the RDMA notification work queue
	 * in: (uint64_t) a0 = host buffer address
	 * in: (uint16_t) a1 = number of entries in buffer
	 * in: (uint16_t) a2 = resource group number
	 * in: (uint16_t) a3 = CQ number to post completion
	 */
	CMD_RDMA_INIT_INFO_BUF = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 70),

	/*
	 * De-init the RDMA notification work queue
	 * in: (uint64_t) a0=resource group number
	 */
	CMD_RDMA_DEINIT_INFO_BUF = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 71),

	/*
	 * Control (Enable/Disable) overlay offloads on the given vnic
	 * in: (uint8_t) a0 = OVERLAY_FEATURE_NVGRE : NVGRE
	 *          a0 = OVERLAY_FEATURE_VXLAN : VxLAN
	 *          a0 = OVERLAY_FEATURE_GENEVE : Geneve
	 * in: (uint8_t) a1 = OVERLAY_OFFLOAD_ENABLE : Enable or
	 *          a1 = OVERLAY_OFFLOAD_DISABLE : Disable or
	 *          a1 = OVERLAY_OFFLOAD_ENABLE_V2 : Enable with version 2
	 */
	CMD_OVERLAY_OFFLOAD_CTRL =
				_CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 72),

	/*
	 * Configuration of overlay offloads feature on a given vNIC
	 * in: (uint8_t) a0 = OVERLAY_CFG_VXLAN_PORT_UPDATE : VxLAN
	 *               OVERLAY_CFG_GENEVE_PORT_UPDATE : Geneve
	 * in: (uint16_t) a1 = unsigned short int port information
	 */
	CMD_OVERLAY_OFFLOAD_CFG = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 73),

	/*
	 * Return the configured name for the device
	 * in: (uint64_t) a0=Host address where the name is copied
	 *     (uint32_t) a1=Size of the buffer
	 */
	CMD_GET_CONFIG_NAME = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 74),

	/*
	 * Enable group interrupt for the VF
	 * in: (uint32_t) a0 = GRPINTR_ENABLE : enable
	 *           a0 = GRPINTR_DISABLE : disable
	 *           a0 = GRPINTR_UPD_VECT: update group vector addr
	 * in: (uint32_t) a1 = interrupt group count
	 * in: (uint64_t) a2 = Start of host buffer address for DMAing group
	 *           vector bitmap
	 * in: (uint64_t) a3 = Stride between group vectors
	 */
	CMD_CONFIG_GRPINTR = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 75),

	/*
	 * Set cq arrary base and size in a list of consective wqs and
	 * rqs for a device
	 * in: (uint16_t) a0 = the wq relative index in the device.
	 *		-1 indicates skipping wq configuration
	 * in: (uint16_t) a1 = the wcq relative index in the device
	 * in: (uint16_t) a2 = the rq relative index in the device
	 *		-1 indicates skipping rq configuration
	 * in: (uint16_t) a3 = the rcq relative index in the device
	 */
	CMD_CONFIG_CQ_ARRAY = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 76),

	/*
	 * Add an advanced filter.
	 * in: (uint64_t) a0= filter address
	 *     (uint32_t) a1= size of filter
	 * out: (uint32_t) a0=filter identifier
	 *
	 * Capability query:
	 * in:  (uint64_t) a1= supported filter capability exchange modes
	 * out: (uint64_t) a0= 1 if capability query supported
	 *      if (uint64_t) a1 = 0: a1 = MAX filter type supported
	 *      if (uint64_t) a1 & FILTER_CAP_MODE_V1_FLAG:
	 *                       a1 = bitmask of supported filters
	 *                       a2 = FILTER_CAP_MODE_V1
	 *                       a3 = bitmask of supported actions
	 */
	CMD_ADD_ADV_FILTER = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ENET, 77),

	/*
	 * Perform a Flow Manager Operation (see flowman_api.h)
	 * in:	(uint32_t) a0 = sub-command
	 *	(uint64_t) a1..15 = (sub-command specific)
	 *
	 * All arguments that have not been assigned a meaning should be
	 * initialized to 0 to allow for better driver forward compatibility.
	 */
	CMD_FLOW_MANAGER_OP = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ENET, 88),

	/*
	 * Set extended CQ field in MREGS of RQ (or all RQs)
	 * for given vNIC
	 * in: (u64) a0 = RQ selection (VNIC_RQ_ALL for all RQs)
	 *     (u32) a1 = CQ entry size
	 *	   VNIC_RQ_CQ_ENTRY_SIZE_16 --> 16 bytes
	 *	   VNIC_RQ_CQ_ENTRY_SIZE_32 --> 32 bytes
	 *	   VNIC_RQ_CQ_ENTRY_SIZE_64 --> 64 bytes
	 *
	 * Capability query:
	 * out: (u32) a0 = errno, 0:valid cmd
	 *	(u32) a1 = value consisting of supported entries
	 *	   bit 0: 16 bytes
	 *	   bit 1: 32 bytes
	 *	   bit 2: 64 bytes
	 */
	CMD_CQ_ENTRY_SIZE_SET = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 90),
};

/* Modes for exchanging advanced filter capabilities. The modes supported by
 * the driver are passed in the CMD_ADD_ADV_FILTER capability command and the
 * mode selected is returned.
 *    V0: the maximum filter type supported is returned
 *    V1: bitmasks of supported filters and actions are returned
 */
enum filter_cap_mode {
	FILTER_CAP_MODE_V0 = 0,  /* Must always be 0 for legacy drivers */
	FILTER_CAP_MODE_V1 = 1,
};
#define FILTER_CAP_MODE_V1_FLAG (1 << FILTER_CAP_MODE_V1)

/* CMD_ENABLE2 flags */
#define CMD_ENABLE2_STANDBY 0x0
#define CMD_ENABLE2_ACTIVE  0x1

/* flags for CMD_OPEN */
#define CMD_OPENF_OPROM		0x1	/* open coming from option rom */
#define CMD_OPENF_IG_DESCCACHE	0x2	/* Do not flush IG DESC cache */

/* flags for CMD_INIT */
#define CMD_INITF_DEFAULT_MAC	0x1	/* init with default mac addr */

/* flags for CMD_NIC_CFG */
#define CMD_NIC_CFG_CAPF_UDP_WEAK	(1ULL << 0) /* Bodega-style UDP RSS */

/* flags for CMD_PACKET_FILTER */
#define CMD_PFILTER_DIRECTED		0x01
#define CMD_PFILTER_MULTICAST		0x02
#define CMD_PFILTER_BROADCAST		0x04
#define CMD_PFILTER_PROMISCUOUS		0x08
#define CMD_PFILTER_ALL_MULTICAST	0x10

/* Commands for CMD_QP_ENABLE/CM_QP_DISABLE */
#define CMD_QP_RQWQ                     0x0

/* rewrite modes for CMD_IG_VLAN_REWRITE_MODE */
#define IG_VLAN_REWRITE_MODE_DEFAULT_TRUNK              0
#define IG_VLAN_REWRITE_MODE_UNTAG_DEFAULT_VLAN         1
#define IG_VLAN_REWRITE_MODE_PRIORITY_TAG_DEFAULT_VLAN  2
#define IG_VLAN_REWRITE_MODE_PASS_THRU                  3

enum vnic_devcmd_status {
	STAT_NONE = 0,
	STAT_BUSY = 1 << 0,	/* cmd in progress */
	STAT_ERROR = 1 << 1,	/* last cmd caused error (code in a0) */
	STAT_FAILOVER = 1 << 2, /* always set on vnics in pci standby state
				 * if seen a failover to the standby happened
				 */
};

enum vnic_devcmd_error {
	ERR_SUCCESS = 0,
	ERR_EINVAL = 1,
	ERR_EFAULT = 2,
	ERR_EPERM = 3,
	ERR_EBUSY = 4,
	ERR_ECMDUNKNOWN = 5,
	ERR_EBADSTATE = 6,
	ERR_ENOMEM = 7,
	ERR_ETIMEDOUT = 8,
	ERR_ELINKDOWN = 9,
	ERR_EMAXRES = 10,
	ERR_ENOTSUPPORTED = 11,
	ERR_EINPROGRESS = 12,
	ERR_MAX
};

/*
 * note: hw_version and asic_rev refer to the same thing,
 *       but have different formats. hw_version is
 *       a 32-byte string (e.g. "A2") and asic_rev is
 *       a 16-bit integer (e.g. 0xA2).
 */
struct vnic_devcmd_fw_info {
	char fw_version[32];
	char fw_build[32];
	char hw_version[32];
	char hw_serial_number[32];
	uint16_t asic_type;
	uint16_t asic_rev;
};

enum fwinfo_asic_type {
	FWINFO_ASIC_TYPE_UNKNOWN,
	FWINFO_ASIC_TYPE_PALO,
	FWINFO_ASIC_TYPE_SERENO,
	FWINFO_ASIC_TYPE_CRUZ,
};

struct vnic_devcmd_notify {
	uint32_t csum;		/* checksum over following words */

	uint32_t link_state;		/* link up == 1 */
	uint32_t port_speed;		/* effective port speed (rate limit) */
	uint32_t mtu;			/* MTU */
	uint32_t msglvl;		/* requested driver msg lvl */
	uint32_t uif;			/* uplink interface */
	uint32_t status;		/* status bits (see VNIC_STF_*) */
	uint32_t error;			/* error code (see ERR_*) for 1st ERR */
	uint32_t link_down_cnt;		/* running count of link down
					 * transitions
					 */
	uint32_t perbi_rebuild_cnt;	/* running count of perbi rebuilds */
};
#define VNIC_STF_FATAL_ERR	0x0001	/* fatal fw error */
#define VNIC_STF_STD_PAUSE	0x0002	/* standard link-level pause on */
#define VNIC_STF_PFC_PAUSE	0x0004	/* priority flow control pause on */
/* all supported status flags */
#define VNIC_STF_ALL		(VNIC_STF_FATAL_ERR |\
				 VNIC_STF_STD_PAUSE |\
				 VNIC_STF_PFC_PAUSE |\
				 0)

struct vnic_devcmd_provinfo {
	uint8_t oui[3];
	uint8_t type;
	uint8_t data[0];
};

/*
 * These are used in flags field of different filters to denote
 * valid fields used.
 */
#define FILTER_FIELD_VALID(fld) (1 << (fld - 1))

#define FILTER_FIELD_USNIC_VLAN    FILTER_FIELD_VALID(1)
#define FILTER_FIELD_USNIC_ETHTYPE FILTER_FIELD_VALID(2)
#define FILTER_FIELD_USNIC_PROTO   FILTER_FIELD_VALID(3)
#define FILTER_FIELD_USNIC_ID      FILTER_FIELD_VALID(4)

#define FILTER_FIELDS_USNIC (FILTER_FIELD_USNIC_VLAN | \
			     FILTER_FIELD_USNIC_ETHTYPE | \
			     FILTER_FIELD_USNIC_PROTO | \
			     FILTER_FIELD_USNIC_ID)

struct filter_usnic_id {
	uint32_t flags;
	uint16_t vlan;
	uint16_t ethtype;
	uint8_t proto_version;
	uint32_t usnic_id;
} __rte_packed;

#define FILTER_FIELD_5TUP_PROTO  FILTER_FIELD_VALID(1)
#define FILTER_FIELD_5TUP_SRC_AD FILTER_FIELD_VALID(2)
#define FILTER_FIELD_5TUP_DST_AD FILTER_FIELD_VALID(3)
#define FILTER_FIELD_5TUP_SRC_PT FILTER_FIELD_VALID(4)
#define FILTER_FIELD_5TUP_DST_PT FILTER_FIELD_VALID(5)

#define FILTER_FIELDS_IPV4_5TUPLE (FILTER_FIELD_5TUP_PROTO | \
				   FILTER_FIELD_5TUP_SRC_AD | \
				   FILTER_FIELD_5TUP_DST_AD | \
				   FILTER_FIELD_5TUP_SRC_PT | \
				   FILTER_FIELD_5TUP_DST_PT)

/* Enums for the protocol field. */
enum protocol_e {
	PROTO_UDP = 0,
	PROTO_TCP = 1,
	PROTO_IPV4 = 2,
	PROTO_IPV6 = 3
};

struct filter_ipv4_5tuple {
	uint32_t flags;
	uint32_t protocol;
	uint32_t src_addr;
	uint32_t dst_addr;
	uint16_t src_port;
	uint16_t dst_port;
} __rte_packed;

#define FILTER_FIELD_VMQ_VLAN   FILTER_FIELD_VALID(1)
#define FILTER_FIELD_VMQ_MAC    FILTER_FIELD_VALID(2)

#define FILTER_FIELDS_MAC_VLAN (FILTER_FIELD_VMQ_VLAN | \
				FILTER_FIELD_VMQ_MAC)

#define FILTER_FIELDS_NVGRE    FILTER_FIELD_VMQ_MAC

struct filter_mac_vlan {
	uint32_t flags;
	uint16_t vlan;
	uint8_t mac_addr[6];
} __rte_packed;

#define FILTER_FIELD_VLAN_IP_3TUP_VLAN      FILTER_FIELD_VALID(1)
#define FILTER_FIELD_VLAN_IP_3TUP_L3_PROTO  FILTER_FIELD_VALID(2)
#define FILTER_FIELD_VLAN_IP_3TUP_DST_AD    FILTER_FIELD_VALID(3)
#define FILTER_FIELD_VLAN_IP_3TUP_L4_PROTO  FILTER_FIELD_VALID(4)
#define FILTER_FIELD_VLAN_IP_3TUP_DST_PT    FILTER_FIELD_VALID(5)

#define FILTER_FIELDS_VLAN_IP_3TUP (FILTER_FIELD_VLAN_IP_3TUP_VLAN | \
				    FILTER_FIELD_VLAN_IP_3TUP_L3_PROTO | \
				    FILTER_FIELD_VLAN_IP_3TUP_DST_AD | \
				    FILTER_FIELD_VLAN_IP_3TUP_L4_PROTO | \
				    FILTER_FIELD_VLAN_IP_3TUP_DST_PT)

struct filter_vlan_ip_3tuple {
	uint32_t flags;
	uint16_t vlan;
	uint16_t l3_protocol;
	union {
		uint32_t dst_addr_v4;
		uint8_t dst_addr_v6[16];
	} u;
	uint32_t l4_protocol;
	uint16_t dst_port;
} __rte_packed;

#define FILTER_GENERIC_1_BYTES 64

enum filter_generic_1_layer {
	FILTER_GENERIC_1_L2,
	FILTER_GENERIC_1_L3,
	FILTER_GENERIC_1_L4,
	FILTER_GENERIC_1_L5,
	FILTER_GENERIC_1_NUM_LAYERS
};

#define FILTER_GENERIC_1_IPV4       (1 << 0)
#define FILTER_GENERIC_1_IPV6       (1 << 1)
#define FILTER_GENERIC_1_UDP        (1 << 2)
#define FILTER_GENERIC_1_TCP        (1 << 3)
#define FILTER_GENERIC_1_TCP_OR_UDP (1 << 4)
#define FILTER_GENERIC_1_IP4SUM_OK  (1 << 5)
#define FILTER_GENERIC_1_L4SUM_OK   (1 << 6)
#define FILTER_GENERIC_1_IPFRAG     (1 << 7)

#define FILTER_GENERIC_1_KEY_LEN 64

/*
 * Version 1 of generic filter specification
 * position is only 16 bits, reserving positions > 64k to be used by firmware
 */
struct filter_generic_1 {
	uint16_t position;       /* lower position comes first */
	uint32_t mask_flags;
	uint32_t val_flags;
	uint16_t mask_vlan;
	uint16_t val_vlan;
	struct {
		uint8_t mask[FILTER_GENERIC_1_KEY_LEN]; /* 0 bit means
							 * " don't care"
							 */
		uint8_t val[FILTER_GENERIC_1_KEY_LEN];
	} __rte_packed layer[FILTER_GENERIC_1_NUM_LAYERS];
} __rte_packed;

/* Specifies the filter_action type. */
enum {
	FILTER_ACTION_RQ_STEERING = 0,
	FILTER_ACTION_V2 = 1,
	FILTER_ACTION_MAX
};

struct filter_action {
	uint32_t type;
	union {
		uint32_t rq_idx;
	} u;
} __rte_packed;

#define FILTER_ACTION_RQ_STEERING_FLAG	(1 << 0)
#define FILTER_ACTION_FILTER_ID_FLAG	(1 << 1)
#define FILTER_ACTION_DROP_FLAG		(1 << 2)
#define FILTER_ACTION_COUNTER_FLAG	(1 << 3)
#define FILTER_ACTION_V2_ALL		(FILTER_ACTION_RQ_STEERING_FLAG \
					 | FILTER_ACTION_DROP_FLAG \
					 | FILTER_ACTION_FILTER_ID_FLAG)

/* Version 2 of filter action must be a strict extension of struct
 * filter_action where the first fields exactly match in size and meaning.
 */
struct filter_action_v2 {
	uint32_t type;
	uint32_t rq_idx;
	uint32_t flags;               /* use FILTER_ACTION_XXX_FLAG defines */
	uint16_t filter_id;
	uint8_t reserved[32];         /* for future expansion */
} __rte_packed;

/* Specifies the filter type. */
enum filter_type {
	FILTER_USNIC_ID = 0,
	FILTER_IPV4_5TUPLE = 1,
	FILTER_MAC_VLAN = 2,
	FILTER_VLAN_IP_3TUPLE = 3,
	FILTER_NVGRE_VMQ = 4,
	FILTER_USNIC_IP = 5,
	FILTER_DPDK_1 = 6,
	FILTER_FLOWMAN = 7,
	FILTER_MAX
};

#define FILTER_USNIC_ID_FLAG		(1 << FILTER_USNIC_ID)
#define FILTER_IPV4_5TUPLE_FLAG		(1 << FILTER_IPV4_5TUPLE)
#define FILTER_MAC_VLAN_FLAG		(1 << FILTER_MAC_VLAN)
#define FILTER_VLAN_IP_3TUPLE_FLAG	(1 << FILTER_VLAN_IP_3TUPLE)
#define FILTER_NVGRE_VMQ_FLAG		(1 << FILTER_NVGRE_VMQ)
#define FILTER_USNIC_IP_FLAG		(1 << FILTER_USNIC_IP)
#define FILTER_DPDK_1_FLAG		(1 << FILTER_DPDK_1)
#define FILTER_V1_ALL			(FILTER_USNIC_ID_FLAG | \
					FILTER_IPV4_5TUPLE_FLAG | \
					FILTER_MAC_VLAN_FLAG | \
					FILTER_VLAN_IP_3TUPLE_FLAG | \
					FILTER_NVGRE_VMQ_FLAG | \
					FILTER_USNIC_IP_FLAG | \
					FILTER_DPDK_1_FLAG)

struct filter {
	uint32_t type;
	union {
		struct filter_usnic_id usnic;
		struct filter_ipv4_5tuple ipv4;
		struct filter_mac_vlan mac_vlan;
		struct filter_vlan_ip_3tuple vlan_3tuple;
	} u;
} __rte_packed;

/*
 * This is a strict superset of "struct filter" and exists only
 * because many drivers use "sizeof (struct filter)" in deciding TLV size.
 * This new, larger struct filter would cause any code that uses that method
 * to not work with older firmware, so we add filter_v2 to hold the
 * new filter types.  Drivers should use vnic_filter_size() to determine
 * the TLV size instead of sizeof (struct fiter_v2) to guard against future
 * growth.
 */
struct filter_v2 {
	uint32_t type;
	union {
		struct filter_usnic_id usnic;
		struct filter_ipv4_5tuple ipv4;
		struct filter_mac_vlan mac_vlan;
		struct filter_vlan_ip_3tuple vlan_3tuple;
		struct filter_generic_1 generic_1;
	} u;
} __rte_packed;

enum {
	CLSF_TLV_FILTER = 0,
	CLSF_TLV_ACTION = 1,
};

struct filter_tlv {
	uint32_t type;
	uint32_t length;
	uint32_t val[];
};

/* Data for CMD_ADD_FILTER is 2 TLV and filter + action structs */
#define FILTER_MAX_BUF_SIZE 100
#define FILTER_V2_MAX_BUF_SIZE (sizeof(struct filter_v2) + \
	sizeof(struct filter_action_v2) + \
	(2 * sizeof(struct filter_tlv)))

/*
 * Compute actual structure size given filter type.  To be "future-proof,"
 * drivers should use this instead of "sizeof (struct filter_v2)" when
 * computing length for TLV.
 */
static inline uint32_t
vnic_filter_size(struct filter_v2 *fp)
{
	uint32_t size;

	switch (fp->type) {
	case FILTER_USNIC_ID:
		size = sizeof(fp->u.usnic);
		break;
	case FILTER_IPV4_5TUPLE:
		size = sizeof(fp->u.ipv4);
		break;
	case FILTER_MAC_VLAN:
	case FILTER_NVGRE_VMQ:
		size = sizeof(fp->u.mac_vlan);
		break;
	case FILTER_VLAN_IP_3TUPLE:
		size = sizeof(fp->u.vlan_3tuple);
		break;
	case FILTER_USNIC_IP:
	case FILTER_DPDK_1:
		size = sizeof(fp->u.generic_1);
		break;
	default:
		size = sizeof(fp->u);
		break;
	}
	size += sizeof(fp->type);
	return size;
}


enum {
	CLSF_ADD = 0,
	CLSF_DEL = 1,
};

/*
 * Get the action structure size given action type. To be "future-proof,"
 * drivers should use this instead of "sizeof (struct filter_action_v2)"
 * when computing length for TLV.
 */
static inline uint32_t
vnic_action_size(struct filter_action_v2 *fap)
{
	uint32_t size;

	switch (fap->type) {
	case FILTER_ACTION_RQ_STEERING:
		size = sizeof(struct filter_action);
		break;
	case FILTER_ACTION_V2:
		size = sizeof(struct filter_action_v2);
		break;
	default:
		size = sizeof(struct filter_action);
		break;
	}
	return size;
}

/*
 * Writing cmd register causes STAT_BUSY to get set in status register.
 * When cmd completes, STAT_BUSY will be cleared.
 *
 * If cmd completed successfully STAT_ERROR will be clear
 * and args registers contain cmd-specific results.
 *
 * If cmd error, STAT_ERROR will be set and args[0] contains error code.
 *
 * status register is read-only.  While STAT_BUSY is set,
 * all other register contents are read-only.
 */

/* Make sizeof(vnic_devcmd) a power-of-2 for I/O BAR. */
#define VNIC_DEVCMD_NARGS 15
struct vnic_devcmd {
	uint32_t status;			/* RO */
	uint32_t cmd;				/* RW */
	uint64_t args[VNIC_DEVCMD_NARGS];	/* RW cmd args (little-endian)*/
};

/*
 * Version 2 of the interface.
 *
 * Some things are carried over, notably the vnic_devcmd_cmd enum.
 */

/*
 * Flags for vnic_devcmd2.flags
 */

#define DEVCMD2_FNORESULT       0x1     /* Don't copy result to host */

#define VNIC_DEVCMD2_NARGS      VNIC_DEVCMD_NARGS
struct vnic_devcmd2 {
	uint16_t pad;
	uint16_t flags;
	uint32_t cmd;                /* same command #defines as original */
	uint64_t args[VNIC_DEVCMD2_NARGS];
};

#define VNIC_DEVCMD2_NRESULTS   VNIC_DEVCMD_NARGS
struct devcmd2_result {
	uint64_t results[VNIC_DEVCMD2_NRESULTS];
	uint32_t pad;
	uint16_t completed_index;    /* into copy WQ */
	uint8_t  error;              /* same error codes as original */
	uint8_t  color;              /* 0 or 1 as with completion queues */
};

#define DEVCMD2_RING_SIZE   32
#define DEVCMD2_DESC_SIZE   128

#define DEVCMD2_RESULTS_SIZE_MAX   ((1 << 16) - 1)

/* Overlay related definitions */

/*
 * This enum lists the flag associated with each of the overlay features
 */
typedef enum {
	OVERLAY_FEATURE_NVGRE = 1,
	OVERLAY_FEATURE_VXLAN,
	OVERLAY_FEATURE_GENEVE,
	OVERLAY_FEATURE_MAX,
} overlay_feature_t;

#define OVERLAY_OFFLOAD_ENABLE          0
#define OVERLAY_OFFLOAD_DISABLE         1
#define OVERLAY_OFFLOAD_ENABLE_V2       2

#define OVERLAY_CFG_VXLAN_PORT_UPDATE 0
#define OVERLAY_CFG_GENEVE_PORT_UPDATE 1

/*
 * Use this enum to get the supported versions for each of these features
 * If you need to use the devcmd_get_supported_feature_version(), add
 * the new feature into this enum and install function handler in devcmd.c
 */
typedef enum {
	VIC_FEATURE_VXLAN,
	VIC_FEATURE_RDMA,
	VIC_FEATURE_GENEVE,
	VIC_FEATURE_MAX,
} vic_feature_t;

/*
 * These flags are used in args[1] of devcmd CMD_GET_SUPP_FEATURE_VER
 * to indicate the host driver about the VxLAN and Multi WQ features
 * supported
 */
#define FEATURE_VXLAN_IPV6_INNER	(1 << 0)
#define FEATURE_VXLAN_IPV6_OUTER	(1 << 1)
#define FEATURE_VXLAN_MULTI_WQ		(1 << 2)

#define FEATURE_VXLAN_IPV6		(FEATURE_VXLAN_IPV6_INNER | \
					 FEATURE_VXLAN_IPV6_OUTER)
/* Support Geneve option bytes */
#define FEATURE_GENEVE_OPTIONS		(1 << 0)

/*
 * CMD_CONFIG_GRPINTR subcommands
 */
typedef enum {
	GRPINTR_ENABLE = 1,
	GRPINTR_DISABLE,
	GRPINTR_UPD_VECT,
} grpintr_subcmd_t;

/*
 * Defines and Capabilities for CMD_CQ_ENTRY_SIZE_SET
 */
#define VNIC_RQ_ALL			(~0ULL)

#define VNIC_RQ_CQ_ENTRY_SIZE_16	0
#define VNIC_RQ_CQ_ENTRY_SIZE_32	1
#define VNIC_RQ_CQ_ENTRY_SIZE_64	2

#define VNIC_RQ_CQ_ENTRY_SIZE_16_CAPABLE	(1 << VNIC_RQ_CQ_ENTRY_SIZE_16)
#define VNIC_RQ_CQ_ENTRY_SIZE_32_CAPABLE	(1 << VNIC_RQ_CQ_ENTRY_SIZE_32)
#define VNIC_RQ_CQ_ENTRY_SIZE_64_CAPABLE	(1 << VNIC_RQ_CQ_ENTRY_SIZE_64)

#endif /* _VNIC_DEVCMD_H_ */
