drivers/net/enic/base/vnic_devcmd.h

   1 /*
   2  * Copyright 2008-2016 Cisco Systems, Inc.  All rights reserved.
   3  * Copyright 2007 Nuova Systems, Inc.  All rights reserved.
   4  *
   5  * Copyright (c) 2014, Cisco Systems, Inc.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  * 1. Redistributions of source code must retain the above copyright
  13  * notice, this list of conditions and the following disclaimer.
  14  *
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  * notice, this list of conditions and the following disclaimer in
  17  * the documentation and/or other materials provided with the
  18  * distribution.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  24  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  30  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  31  * POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  */
  34
  35 #ifndef _VNIC_DEVCMD_H_
  36 #define _VNIC_DEVCMD_H_
  37
  38 #define _CMD_NBITS      14
  39 #define _CMD_VTYPEBITS  10
  40 #define _CMD_FLAGSBITS  6
  41 #define _CMD_DIRBITS    2
  42
  43 #define _CMD_NMASK      ((1 << _CMD_NBITS)-1)
  44 #define _CMD_VTYPEMASK  ((1 << _CMD_VTYPEBITS)-1)
  45 #define _CMD_FLAGSMASK  ((1 << _CMD_FLAGSBITS)-1)
  46 #define _CMD_DIRMASK    ((1 << _CMD_DIRBITS)-1)
  47
  48 #define _CMD_NSHIFT     0
  49 #define _CMD_VTYPESHIFT (_CMD_NSHIFT+_CMD_NBITS)
  50 #define _CMD_FLAGSSHIFT (_CMD_VTYPESHIFT+_CMD_VTYPEBITS)
  51 #define _CMD_DIRSHIFT   (_CMD_FLAGSSHIFT+_CMD_FLAGSBITS)
  52
  53 /*
  54  * Direction bits (from host perspective).
  55  */
  56 #define _CMD_DIR_NONE   0U
  57 #define _CMD_DIR_WRITE  1U
  58 #define _CMD_DIR_READ   2U
  59 #define _CMD_DIR_RW     (_CMD_DIR_WRITE | _CMD_DIR_READ)
  60
  61 /*
  62  * Flag bits.
  63  */
  64 #define _CMD_FLAGS_NONE 0U
  65 #define _CMD_FLAGS_NOWAIT 1U
  66
  67 /*
  68  * vNIC type bits.
  69  */
  70 #define _CMD_VTYPE_NONE  0U
  71 #define _CMD_VTYPE_ENET  1U
  72 #define _CMD_VTYPE_FC    2U
  73 #define _CMD_VTYPE_SCSI  4U
  74 #define _CMD_VTYPE_ALL   (_CMD_VTYPE_ENET | _CMD_VTYPE_FC | _CMD_VTYPE_SCSI)
  75
  76 /*
  77  * Used to create cmds..
  78  */
  79 #define _CMDCF(dir, flags, vtype, nr)  \
  80         (((dir)   << _CMD_DIRSHIFT) | \
  81         ((flags) << _CMD_FLAGSSHIFT) | \
  82         ((vtype) << _CMD_VTYPESHIFT) | \
  83         ((nr)    << _CMD_NSHIFT))
  84 #define _CMDC(dir, vtype, nr)    _CMDCF(dir, 0, vtype, nr)
  85 #define _CMDCNW(dir, vtype, nr)  _CMDCF(dir, _CMD_FLAGS_NOWAIT, vtype, nr)
  86
  87 /*
  88  * Used to decode cmds..
  89  */
  90 #define _CMD_DIR(cmd)            (((cmd) >> _CMD_DIRSHIFT) & _CMD_DIRMASK)
  91 #define _CMD_FLAGS(cmd)          (((cmd) >> _CMD_FLAGSSHIFT) & _CMD_FLAGSMASK)
  92 #define _CMD_VTYPE(cmd)          (((cmd) >> _CMD_VTYPESHIFT) & _CMD_VTYPEMASK)
  93 #define _CMD_N(cmd)              (((cmd) >> _CMD_NSHIFT) & _CMD_NMASK)
  94
  95 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
  96
  97 enum vnic_devcmd_cmd {
  98         CMD_NONE                = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_NONE, 0),
  99
 100         /*
 101          * mcpu fw info in mem:
 102          * in:
 103          *   (u64)a0=paddr to struct vnic_devcmd_fw_info
 104          * action:
 105          *   Fills in struct vnic_devcmd_fw_info (128 bytes)
 106          * note:
 107          *   An old definition of CMD_MCPU_FW_INFO
 108          */
 109         CMD_MCPU_FW_INFO_OLD    = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 1),
 110
 111         /*
 112          * mcpu fw info in mem:
 113          * in:
 114          *   (u64)a0=paddr to struct vnic_devcmd_fw_info
 115          *   (u16)a1=size of the structure
 116          * out:
 117          *       (u16)a1=0                          for in:a1 = 0,
 118          *               data size actually written for other values.
 119          * action:
 120          *   Fills in first 128 bytes of vnic_devcmd_fw_info for in:a1 = 0,
 121          *            first in:a1 bytes               for 0 < in:a1 <= 132,
 122          *            132 bytes                       for other values of in:a1.
 123          * note:
 124          *   CMD_MCPU_FW_INFO and CMD_MCPU_FW_INFO_OLD have the same enum 1
 125          *   for source compatibility.
 126          */
 127         CMD_MCPU_FW_INFO        = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 1),
 128
 129         /* dev-specific block member:
 130          *    in: (u16)a0=offset,(u8)a1=size
 131          *    out: a0=value
 132          */
 133         CMD_DEV_SPEC            = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 2),
 134
 135         /* stats clear */
 136         CMD_STATS_CLEAR         = _CMDCNW(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 3),
 137
 138         /* stats dump in mem: (u64)a0=paddr to stats area,
 139          *                    (u16)a1=sizeof stats area */
 140         CMD_STATS_DUMP          = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 4),
 141
 142         /* set Rx packet filter: (u32)a0=filters (see CMD_PFILTER_*) */
 143         CMD_PACKET_FILTER       = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 7),
 144
 145         /* set Rx packet filter for all: (u32)a0=filters (see CMD_PFILTER_*) */
 146         CMD_PACKET_FILTER_ALL   = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 7),
 147
 148         /* hang detection notification */
 149         CMD_HANG_NOTIFY         = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 8),
 150
 151         /* MAC address in (u48)a0 */
 152         CMD_MAC_ADDR            = _CMDC(_CMD_DIR_READ,
 153                                         _CMD_VTYPE_ENET | _CMD_VTYPE_FC, 9),
 154 #define CMD_GET_MAC_ADDR CMD_MAC_ADDR   /* some uses are aliased */
 155
 156         /* add addr from (u48)a0 */
 157         CMD_ADDR_ADD            = _CMDCNW(_CMD_DIR_WRITE,
 158                                         _CMD_VTYPE_ENET | _CMD_VTYPE_FC, 12),
 159
 160         /* del addr from (u48)a0 */
 161         CMD_ADDR_DEL            = _CMDCNW(_CMD_DIR_WRITE,
 162                                         _CMD_VTYPE_ENET | _CMD_VTYPE_FC, 13),
 163
 164         /* add VLAN id in (u16)a0 */
 165         CMD_VLAN_ADD            = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 14),
 166
 167         /* del VLAN id in (u16)a0 */
 168         CMD_VLAN_DEL            = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 15),
 169
 170         /* nic_cfg in (u32)a0 */
 171         CMD_NIC_CFG             = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 16),
 172
 173         /* union vnic_rss_key in mem: (u64)a0=paddr, (u16)a1=len */
 174         CMD_RSS_KEY             = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 17),
 175
 176         /* union vnic_rss_cpu in mem: (u64)a0=paddr, (u16)a1=len */
 177         CMD_RSS_CPU             = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 18),
 178
 179         /* initiate softreset */
 180         CMD_SOFT_RESET          = _CMDCNW(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 19),
 181
 182         /* softreset status:
 183          *    out: a0=0 reset complete, a0=1 reset in progress */
 184         CMD_SOFT_RESET_STATUS   = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 20),
 185
 186         /* set struct vnic_devcmd_notify buffer in mem:
 187          * in:
 188          *   (u64)a0=paddr to notify (set paddr=0 to unset)
 189          *   (u32)a1 & 0x00000000ffffffff=sizeof(struct vnic_devcmd_notify)
 190          *   (u16)a1 & 0x0000ffff00000000=intr num (-1 for no intr)
 191          * out:
 192          *   (u32)a1 = effective size
 193          */
 194         CMD_NOTIFY              = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 21),
 195
 196         /* UNDI API: (u64)a0=paddr to s_PXENV_UNDI_ struct,
 197          *           (u8)a1=PXENV_UNDI_xxx */
 198         CMD_UNDI                = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 22),
 199
 200         /* initiate open sequence (u32)a0=flags (see CMD_OPENF_*) */
 201         CMD_OPEN                = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 23),
 202
 203         /* open status:
 204          *    out: a0=0 open complete, a0=1 open in progress */
 205         CMD_OPEN_STATUS         = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 24),
 206
 207         /* close vnic */
 208         CMD_CLOSE               = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 25),
 209
 210         /* initialize virtual link: (u32)a0=flags (see CMD_INITF_*) */
 211 /***** Replaced by CMD_INIT *****/
 212         CMD_INIT_v1             = _CMDCNW(_CMD_DIR_READ, _CMD_VTYPE_ALL, 26),
 213
 214         /* variant of CMD_INIT, with provisioning info
 215          *     (u64)a0=paddr of vnic_devcmd_provinfo
 216          *     (u32)a1=sizeof provision info */
 217         CMD_INIT_PROV_INFO      = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 27),
 218
 219         /* enable virtual link */
 220         CMD_ENABLE              = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 28),
 221
 222         /* enable virtual link, waiting variant. */
 223         CMD_ENABLE_WAIT         = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 28),
 224
 225         /* disable virtual link */
 226         CMD_DISABLE             = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 29),
 227
 228         /* stats dump sum of all vnic stats on same uplink in mem:
 229          *     (u64)a0=paddr
 230          *     (u16)a1=sizeof stats area */
 231         CMD_STATS_DUMP_ALL      = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 30),
 232
 233         /* init status:
 234          *    out: a0=0 init complete, a0=1 init in progress
 235          *         if a0=0, a1=errno */
 236         CMD_INIT_STATUS         = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 31),
 237
 238         /* INT13 API: (u64)a0=paddr to vnic_int13_params struct
 239          *            (u32)a1=INT13_CMD_xxx */
 240         CMD_INT13               = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_FC, 32),
 241
 242         /* logical uplink enable/disable: (u64)a0: 0/1=disable/enable */
 243         CMD_LOGICAL_UPLINK      = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 33),
 244
 245         /* undo initialize of virtual link */
 246         CMD_DEINIT              = _CMDCNW(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 34),
 247
 248         /* initialize virtual link: (u32)a0=flags (see CMD_INITF_*) */
 249         CMD_INIT                = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 35),
 250
 251         /* check fw capability of a cmd:
 252          * in:  (u32)a0=cmd
 253          * out: (u32)a0=errno, 0:valid cmd, a1=supported VNIC_STF_* bits */
 254         CMD_CAPABILITY          = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 36),
 255
 256         /* persistent binding info
 257          * in:  (u64)a0=paddr of arg
 258          *      (u32)a1=CMD_PERBI_XXX */
 259         CMD_PERBI               = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_FC, 37),
 260
 261         /* Interrupt Assert Register functionality
 262          * in: (u16)a0=interrupt number to assert
 263          */
 264         CMD_IAR                 = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 38),
 265
 266         /* initiate hangreset, like softreset after hang detected */
 267         CMD_HANG_RESET          = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 39),
 268
 269         /* hangreset status:
 270          *    out: a0=0 reset complete, a0=1 reset in progress */
 271         CMD_HANG_RESET_STATUS   = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 40),
 272
 273         /*
 274          * Set hw ingress packet vlan rewrite mode:
 275          * in:  (u32)a0=new vlan rewrite mode
 276          * out: (u32)a0=old vlan rewrite mode */
 277         CMD_IG_VLAN_REWRITE_MODE = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ENET, 41),
 278
 279         /*
 280          * in:  (u16)a0=bdf of target vnic
 281          *      (u32)a1=cmd to proxy
 282          *      a2-a15=args to cmd in a1
 283          * out: (u32)a0=status of proxied cmd
 284          *      a1-a15=out args of proxied cmd */
 285         CMD_PROXY_BY_BDF =      _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 42),
 286
 287         /*
 288          * As for BY_BDF except a0 is index of hvnlink subordinate vnic
 289          * or SR-IOV virtual vnic
 290          */
 291         CMD_PROXY_BY_INDEX =    _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 43),
 292
 293         /*
 294          * For HPP toggle:
 295          * adapter-info-get
 296          * in:  (u64)a0=phsical address of buffer passed in from caller.
 297          *      (u16)a1=size of buffer specified in a0.
 298          * out: (u64)a0=phsical address of buffer passed in from caller.
 299          *      (u16)a1=actual bytes from VIF-CONFIG-INFO TLV, or
 300          *              0 if no VIF-CONFIG-INFO TLV was ever received. */
 301         CMD_CONFIG_INFO_GET = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 44),
 302
 303         /*
 304          * INT13 API: (u64)a0=paddr to vnic_int13_params struct
 305          *            (u32)a1=INT13_CMD_xxx
 306          */
 307         CMD_INT13_ALL = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 45),
 308
 309         /*
 310          * Set default vlan:
 311          * in: (u16)a0=new default vlan
 312          *     (u16)a1=zero for overriding vlan with param a0,
 313          *                     non-zero for resetting vlan to the default
 314          * out: (u16)a0=old default vlan
 315          */
 316         CMD_SET_DEFAULT_VLAN = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 46),
 317
 318         /* init_prov_info2:
 319          * Variant of CMD_INIT_PROV_INFO, where it will not try to enable
 320          * the vnic until CMD_ENABLE2 is issued.
 321          *     (u64)a0=paddr of vnic_devcmd_provinfo
 322          *     (u32)a1=sizeof provision info */
 323         CMD_INIT_PROV_INFO2  = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 47),
 324
 325         /* enable2:
 326          *      (u32)a0=0                  ==> standby
 327          *             =CMD_ENABLE2_ACTIVE ==> active
 328          */
 329         CMD_ENABLE2 = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 48),
 330
 331         /*
 332          * cmd_status:
 333          *     Returns the status of the specified command
 334          * Input:
 335          *     a0 = command for which status is being queried.
 336          *          Possible values are:
 337          *              CMD_SOFT_RESET
 338          *              CMD_HANG_RESET
 339          *              CMD_OPEN
 340          *              CMD_INIT
 341          *              CMD_INIT_PROV_INFO
 342          *              CMD_DEINIT
 343          *              CMD_INIT_PROV_INFO2
 344          *              CMD_ENABLE2
 345          * Output:
 346          *     if status == STAT_ERROR
 347          *        a0 = ERR_ENOTSUPPORTED - status for command in a0 is
 348          *                                 not supported
 349          *     if status == STAT_NONE
 350          *        a0 = status of the devcmd specified in a0 as follows.
 351          *             ERR_SUCCESS   - command in a0 completed successfully
 352          *             ERR_EINPROGRESS - command in a0 is still in progress
 353          */
 354         CMD_STATUS = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 49),
 355
 356         /*
 357          * Returns interrupt coalescing timer conversion factors.
 358          * After calling this devcmd, ENIC driver can convert
 359          * interrupt coalescing timer in usec into CPU cycles as follows:
 360          *
 361          *   intr_timer_cycles = intr_timer_usec * multiplier / divisor
 362          *
 363          * Interrupt coalescing timer in usecs can be be converted/obtained
 364          * from CPU cycles as follows:
 365          *
 366          *   intr_timer_usec = intr_timer_cycles * divisor / multiplier
 367          *
 368          * in: none
 369          * out: (u32)a0 = multiplier
 370          *      (u32)a1 = divisor
 371          *      (u32)a2 = maximum timer value in usec
 372          */
 373         CMD_INTR_COAL_CONVERT = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 50),
 374
 375         /*
 376          * ISCSI DUMP API:
 377          * in: (u64)a0=paddr of the param or param itself
 378          *     (u32)a1=ISCSI_CMD_xxx
 379          */
 380         CMD_ISCSI_DUMP_REQ = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 51),
 381
 382         /*
 383          * ISCSI DUMP STATUS API:
 384          * in: (u32)a0=cmd tag
 385          * in: (u32)a1=ISCSI_CMD_xxx
 386          * out: (u32)a0=cmd status
 387          */
 388         CMD_ISCSI_DUMP_STATUS = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 52),
 389
 390         /*
 391          * Subvnic migration from MQ <--> VF.
 392          * Enable the LIF migration from MQ to VF and vice versa. MQ and VF
 393          * indexes are statically bound at the time of initialization.
 394          * Based on the direction of migration, the resources of either MQ or
 395          * the VF shall be attached to the LIF.
 396          * in:        (u32)a0=Direction of Migration
 397          *                                      0=> Migrate to VF
 398          *                                      1=> Migrate to MQ
 399          *            (u32)a1=VF index (MQ index)
 400          */
 401         CMD_MIGRATE_SUBVNIC = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 53),
 402
 403         /*
 404          * Register / Deregister the notification block for MQ subvnics
 405          * in:
 406          *   (u64)a0=paddr to notify (set paddr=0 to unset)
 407          *   (u32)a1 & 0x00000000ffffffff=sizeof(struct vnic_devcmd_notify)
 408          *   (u16)a1 & 0x0000ffff00000000=intr num (-1 for no intr)
 409          * out:
 410          *   (u32)a1 = effective size
 411          */
 412         CMD_SUBVNIC_NOTIFY = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 54),
 413
 414         /*
 415          * Set the predefined mac address as default
 416          * in:
 417          *   (u48)a0=mac addr
 418          */
 419         CMD_SET_MAC_ADDR = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 55),
 420
 421         /* Update the provisioning info of the given VIF
 422          *     (u64)a0=paddr of vnic_devcmd_provinfo
 423          *     (u32)a1=sizeof provision info */
 424         CMD_PROV_INFO_UPDATE = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 56),
 425
 426         /*
 427          * Initialization for the devcmd2 interface.
 428          * in: (u64) a0=host result buffer physical address
 429          * in: (u16) a1=number of entries in result buffer
 430          */
 431         CMD_INITIALIZE_DEVCMD2 = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 57),
 432
 433         /*
 434          * Add a filter.
 435          * in: (u64) a0= filter address
 436          *     (u32) a1= size of filter
 437          * out: (u32) a0=filter identifier
 438          *
 439          * Capability query:
 440          * out: (u64) a0= 1 if capability query supported
 441          *      (u64) a1= MAX filter type supported
 442          */
 443         CMD_ADD_FILTER = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ENET, 58),
 444
 445         /*
 446          * Delete a filter.
 447          * in: (u32) a0=filter identifier
 448          */
 449         CMD_DEL_FILTER = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 59),
 450
 451         /*
 452          * Enable a Queue Pair in User space NIC
 453          * in: (u32) a0=Queue Pair number
 454          *     (u32) a1= command
 455          */
 456         CMD_QP_ENABLE = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 60),
 457
 458         /*
 459          * Disable a Queue Pair in User space NIC
 460          * in: (u32) a0=Queue Pair number
 461          *     (u32) a1= command
 462          */
 463         CMD_QP_DISABLE = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 61),
 464
 465         /*
 466          * Stats dump Queue Pair in User space NIC
 467          * in: (u32) a0=Queue Pair number
 468          *     (u64) a1=host buffer addr for status dump
 469          *     (u32) a2=length of the buffer
 470          */
 471         CMD_QP_STATS_DUMP = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 62),
 472
 473         /*
 474          * Clear stats for Queue Pair in User space NIC
 475          * in: (u32) a0=Queue Pair number
 476          */
 477         CMD_QP_STATS_CLEAR = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 63),
 478
 479         /*
 480          * UEFI BOOT API: (u64)a0= UEFI FLS_CMD_xxx
 481          * (ui64)a1= paddr for the info buffer
 482          */
 483         CMD_FC_REQ = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_FC, 64),
 484
 485         /*
 486          * Return the iSCSI config details required by the EFI Option ROM
 487          * in:  (u32) a0=0 Get Boot Info for PXE eNIC as per pxe_boot_config_t
 488          *            a0=1 Get Boot info for iSCSI enic as per
 489          *            iscsi_boot_efi_cfg_t
 490          * in:  (u64) a1=Host address where iSCSI config info is returned
 491          */
 492         CMD_VNIC_BOOT_CONFIG_INFO = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 65),
 493
 494         /*
 495          * Create a Queue Pair (RoCE)
 496          * in: (u32) a0 = Queue Pair number
 497          *     (u32) a1 = Remote QP
 498          *     (u32) a2 = RDMA-RQ
 499          *     (u16) a3 = RQ Res Group
 500          *     (u16) a4 = SQ Res Group
 501          *     (u32) a5 = Protection Domain
 502          *     (u64) a6 = Remote MAC
 503          *     (u32) a7 = start PSN
 504          *     (u16) a8 = MSS
 505          *     (u32) a9 = protocol version
 506          */
 507         CMD_RDMA_QP_CREATE = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 66),
 508
 509         /*
 510          * Delete a Queue Pair (RoCE)
 511          * in: (u32) a0 = Queue Pair number
 512          */
 513         CMD_RDMA_QP_DELETE = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 67),
 514
 515         /*
 516          * Retrieve a Queue Pair's status information (RoCE)
 517          * in: (u32) a0 = Queue Pair number
 518          *     (u64) a1 = host buffer addr for QP status struct
 519          *     (u32) a2 = length of the buffer
 520          */
 521         CMD_RDMA_QP_STATUS = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ENET, 68),
 522
 523         /*
 524          * Use this devcmd for agreeing on the highest common version supported
 525          * by both driver and fw for by features who need such a facility.
 526          *  in:  (u64) a0 = feature (driver requests for the supported versions
 527          *                  on this feature)
 528          *  out: (u64) a0 = bitmap of all supported versions for that feature
 529          */
 530         CMD_GET_SUPP_FEATURE_VER = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ENET, 69),
 531
 532         /*
 533          * Initialize the RDMA notification work queue
 534          * in: (u64) a0 = host buffer address
 535          * in: (u16) a1 = number of entries in buffer
 536          * in: (u16) a2 = resource group number
 537          * in: (u16) a3 = CQ number to post completion
 538          */
 539         CMD_RDMA_INIT_INFO_BUF = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 70),
 540
 541         /*
 542          * De-init the RDMA notification work queue
 543          * in: (u64) a0=resource group number
 544          */
 545         CMD_RDMA_DEINIT_INFO_BUF = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 71),
 546
 547         /*
 548          * Control (Enable/Disable) overlay offloads on the given vnic
 549          * in: (u8) a0 = OVERLAY_FEATURE_NVGRE : NVGRE
 550          *          a0 = OVERLAY_FEATURE_VXLAN : VxLAN
 551          * in: (u8) a1 = OVERLAY_OFFLOAD_ENABLE : Enable or
 552          *          a1 = OVERLAY_OFFLOAD_DISABLE : Disable or
 553          *          a1 = OVERLAY_OFFLOAD_ENABLE_V2 : Enable with version 2
 554          */
 555         CMD_OVERLAY_OFFLOAD_CTRL =
 556                                 _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 72),
 557
 558         /*
 559          * Configuration of overlay offloads feature on a given vNIC
 560          * in: (u8) a0 = OVERLAY_CFG_VXLAN_PORT_UPDATE : VxLAN
 561          * in: (u16) a1 = unsigned short int port information
 562          */
 563         CMD_OVERLAY_OFFLOAD_CFG = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 73),
 564
 565         /*
 566          * Return the configured name for the device
 567          * in: (u64) a0=Host address where the name is copied
 568          *     (u32) a1=Size of the buffer
 569          */
 570         CMD_GET_CONFIG_NAME = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 74),
 571
 572         /*
 573          * Enable group interrupt for the VF
 574          * in: (u32) a0 = GRPINTR_ENABLE : enable
 575          *           a0 = GRPINTR_DISABLE : disable
 576          *           a0 = GRPINTR_UPD_VECT: update group vector addr
 577          * in: (u32) a1 = interrupt group count
 578          * in: (u64) a2 = Start of host buffer address for DMAing group
 579          *           vector bitmap
 580          * in: (u64) a3 = Stride between group vectors
 581          */
 582         CMD_CONFIG_GRPINTR = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 75),
 583
 584         /*
 585          * Set cq arrary base and size in a list of consective wqs and
 586          * rqs for a device
 587          * in: (u16) a0 = the wq relative index in the device.
 588          *              -1 indicates skipping wq configuration
 589          * in: (u16) a1 = the wcq relative index in the device
 590          * in: (u16) a2 = the rq relative index in the device
 591          *              -1 indicates skipping rq configuration
 592          * in: (u16) a3 = the rcq relative index in the device
 593          */
 594         CMD_CONFIG_CQ_ARRAY = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 76),
 595
 596         /*
 597          * Add an advanced filter.
 598          * in: (u64) a0= filter address
 599          *     (u32) a1= size of filter
 600          * out: (u32) a0=filter identifier
 601          *
 602          * Capability query:
 603          * in:  (u64) a1= supported filter capability exchange modes
 604          * out: (u64) a0= 1 if capability query supported
 605          *      if (u64) a1 = 0: a1 = MAX filter type supported
 606          *      if (u64) a1 & FILTER_CAP_MODE_V1_FLAG:
 607          *                       a1 = bitmask of supported filters
 608          *                       a2 = FILTER_CAP_MODE_V1
 609          *                       a3 = bitmask of supported actions
 610          */
 611         CMD_ADD_ADV_FILTER = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ENET, 77),
 612 };
 613
 614 /* Modes for exchanging advanced filter capabilities. The modes supported by
 615  * the driver are passed in the CMD_ADD_ADV_FILTER capability command and the
 616  * mode selected is returned.
 617  *    V0: the maximum filter type supported is returned
 618  *    V1: bitmasks of supported filters and actions are returned
 619  */
 620 enum filter_cap_mode {
 621         FILTER_CAP_MODE_V0 = 0,  /* Must always be 0 for legacy drivers */
 622         FILTER_CAP_MODE_V1 = 1,
 623 };
 624 #define FILTER_CAP_MODE_V1_FLAG (1 << FILTER_CAP_MODE_V1)
 625
 626 /* CMD_ENABLE2 flags */
 627 #define CMD_ENABLE2_STANDBY 0x0
 628 #define CMD_ENABLE2_ACTIVE  0x1
 629
 630 /* flags for CMD_OPEN */
 631 #define CMD_OPENF_OPROM         0x1     /* open coming from option rom */
 632
 633 /* flags for CMD_INIT */
 634 #define CMD_INITF_DEFAULT_MAC   0x1     /* init with default mac addr */
 635
 636 /* flags for CMD_PACKET_FILTER */
 637 #define CMD_PFILTER_DIRECTED            0x01
 638 #define CMD_PFILTER_MULTICAST           0x02
 639 #define CMD_PFILTER_BROADCAST           0x04
 640 #define CMD_PFILTER_PROMISCUOUS         0x08
 641 #define CMD_PFILTER_ALL_MULTICAST       0x10
 642
 643 /* Commands for CMD_QP_ENABLE/CM_QP_DISABLE */
 644 #define CMD_QP_RQWQ                     0x0
 645
 646 /* rewrite modes for CMD_IG_VLAN_REWRITE_MODE */
 647 #define IG_VLAN_REWRITE_MODE_DEFAULT_TRUNK              0
 648 #define IG_VLAN_REWRITE_MODE_UNTAG_DEFAULT_VLAN         1
 649 #define IG_VLAN_REWRITE_MODE_PRIORITY_TAG_DEFAULT_VLAN  2
 650 #define IG_VLAN_REWRITE_MODE_PASS_THRU                  3
 651
 652 enum vnic_devcmd_status {
 653         STAT_NONE = 0,
 654         STAT_BUSY = 1 << 0,     /* cmd in progress */
 655         STAT_ERROR = 1 << 1,    /* last cmd caused error (code in a0) */
 656         STAT_FAILOVER = 1 << 2, /* always set on vnics in pci standby state
 657                                  * if seen a failover to the standby happened
 658                                  */
 659 };
 660
 661 enum vnic_devcmd_error {
 662         ERR_SUCCESS = 0,
 663         ERR_EINVAL = 1,
 664         ERR_EFAULT = 2,
 665         ERR_EPERM = 3,
 666         ERR_EBUSY = 4,
 667         ERR_ECMDUNKNOWN = 5,
 668         ERR_EBADSTATE = 6,
 669         ERR_ENOMEM = 7,
 670         ERR_ETIMEDOUT = 8,
 671         ERR_ELINKDOWN = 9,
 672         ERR_EMAXRES = 10,
 673         ERR_ENOTSUPPORTED = 11,
 674         ERR_EINPROGRESS = 12,
 675         ERR_MAX
 676 };
 677
 678 /*
 679  * note: hw_version and asic_rev refer to the same thing,
 680  *       but have different formats. hw_version is
 681  *       a 32-byte string (e.g. "A2") and asic_rev is
 682  *       a 16-bit integer (e.g. 0xA2).
 683  */
 684 struct vnic_devcmd_fw_info {
 685         char fw_version[32];
 686         char fw_build[32];
 687         char hw_version[32];
 688         char hw_serial_number[32];
 689         u16 asic_type;
 690         u16 asic_rev;
 691 };
 692
 693 enum fwinfo_asic_type {
 694         FWINFO_ASIC_TYPE_UNKNOWN,
 695         FWINFO_ASIC_TYPE_PALO,
 696         FWINFO_ASIC_TYPE_SERENO,
 697         FWINFO_ASIC_TYPE_CRUZ,
 698 };
 699
 700 struct vnic_devcmd_notify {
 701         u32 csum;               /* checksum over following words */
 702
 703         u32 link_state;         /* link up == 1 */
 704         u32 port_speed;         /* effective port speed (rate limit) */
 705         u32 mtu;                /* MTU */
 706         u32 msglvl;             /* requested driver msg lvl */
 707         u32 uif;                /* uplink interface */
 708         u32 status;             /* status bits (see VNIC_STF_*) */
 709         u32 error;              /* error code (see ERR_*) for first ERR */
 710         u32 link_down_cnt;      /* running count of link down transitions */
 711         u32 perbi_rebuild_cnt;  /* running count of perbi rebuilds */
 712 };
 713 #define VNIC_STF_FATAL_ERR      0x0001  /* fatal fw error */
 714 #define VNIC_STF_STD_PAUSE      0x0002  /* standard link-level pause on */
 715 #define VNIC_STF_PFC_PAUSE      0x0004  /* priority flow control pause on */
 716 /* all supported status flags */
 717 #define VNIC_STF_ALL            (VNIC_STF_FATAL_ERR |\
 718                                  VNIC_STF_STD_PAUSE |\
 719                                  VNIC_STF_PFC_PAUSE |\
 720                                  0)
 721
 722 struct vnic_devcmd_provinfo {
 723         u8 oui[3];
 724         u8 type;
 725         u8 data[0];
 726 };
 727
 728 /*
 729  * These are used in flags field of different filters to denote
 730  * valid fields used.
 731  */
 732 #define FILTER_FIELD_VALID(fld) (1 << (fld - 1))
 733
 734 #define FILTER_FIELD_USNIC_VLAN    FILTER_FIELD_VALID(1)
 735 #define FILTER_FIELD_USNIC_ETHTYPE FILTER_FIELD_VALID(2)
 736 #define FILTER_FIELD_USNIC_PROTO   FILTER_FIELD_VALID(3)
 737 #define FILTER_FIELD_USNIC_ID      FILTER_FIELD_VALID(4)
 738
 739 #define FILTER_FIELDS_USNIC (FILTER_FIELD_USNIC_VLAN | \
 740                              FILTER_FIELD_USNIC_ETHTYPE | \
 741                              FILTER_FIELD_USNIC_PROTO | \
 742                              FILTER_FIELD_USNIC_ID)
 743
 744 struct filter_usnic_id {
 745         u32 flags;
 746         u16 vlan;
 747         u16 ethtype;
 748         u8 proto_version;
 749         u32 usnic_id;
 750 } __attribute__((packed));
 751
 752 #define FILTER_FIELD_5TUP_PROTO  FILTER_FIELD_VALID(1)
 753 #define FILTER_FIELD_5TUP_SRC_AD FILTER_FIELD_VALID(2)
 754 #define FILTER_FIELD_5TUP_DST_AD FILTER_FIELD_VALID(3)
 755 #define FILTER_FIELD_5TUP_SRC_PT FILTER_FIELD_VALID(4)
 756 #define FILTER_FIELD_5TUP_DST_PT FILTER_FIELD_VALID(5)
 757
 758 #define FILTER_FIELDS_IPV4_5TUPLE (FILTER_FIELD_5TUP_PROTO | \
 759                                    FILTER_FIELD_5TUP_SRC_AD | \
 760                                    FILTER_FIELD_5TUP_DST_AD | \
 761                                    FILTER_FIELD_5TUP_SRC_PT | \
 762                                    FILTER_FIELD_5TUP_DST_PT)
 763
 764 /* Enums for the protocol field. */
 765 enum protocol_e {
 766         PROTO_UDP = 0,
 767         PROTO_TCP = 1,
 768         PROTO_IPV4 = 2,
 769         PROTO_IPV6 = 3
 770 };
 771
 772 struct filter_ipv4_5tuple {
 773         u32 flags;
 774         u32 protocol;
 775         u32 src_addr;
 776         u32 dst_addr;
 777         u16 src_port;
 778         u16 dst_port;
 779 } __attribute__((packed));
 780
 781 #define FILTER_FIELD_VMQ_VLAN   FILTER_FIELD_VALID(1)
 782 #define FILTER_FIELD_VMQ_MAC    FILTER_FIELD_VALID(2)
 783
 784 #define FILTER_FIELDS_MAC_VLAN (FILTER_FIELD_VMQ_VLAN | \
 785                                 FILTER_FIELD_VMQ_MAC)
 786
 787 #define FILTER_FIELDS_NVGRE    FILTER_FIELD_VMQ_MAC
 788
 789 struct filter_mac_vlan {
 790         u32 flags;
 791         u16 vlan;
 792         u8 mac_addr[6];
 793 } __attribute__((packed));
 794
 795 #define FILTER_FIELD_VLAN_IP_3TUP_VLAN      FILTER_FIELD_VALID(1)
 796 #define FILTER_FIELD_VLAN_IP_3TUP_L3_PROTO  FILTER_FIELD_VALID(2)
 797 #define FILTER_FIELD_VLAN_IP_3TUP_DST_AD    FILTER_FIELD_VALID(3)
 798 #define FILTER_FIELD_VLAN_IP_3TUP_L4_PROTO  FILTER_FIELD_VALID(4)
 799 #define FILTER_FIELD_VLAN_IP_3TUP_DST_PT    FILTER_FIELD_VALID(5)
 800
 801 #define FILTER_FIELDS_VLAN_IP_3TUP (FILTER_FIELD_VLAN_IP_3TUP_VLAN | \
 802                                     FILTER_FIELD_VLAN_IP_3TUP_L3_PROTO | \
 803                                     FILTER_FIELD_VLAN_IP_3TUP_DST_AD | \
 804                                     FILTER_FIELD_VLAN_IP_3TUP_L4_PROTO | \
 805                                     FILTER_FIELD_VLAN_IP_3TUP_DST_PT)
 806
 807 struct filter_vlan_ip_3tuple {
 808         u32 flags;
 809         u16 vlan;
 810         u16 l3_protocol;
 811         union {
 812                 u32 dst_addr_v4;
 813                 u8 dst_addr_v6[16];
 814         } u;
 815         u32 l4_protocol;
 816         u16 dst_port;
 817 } __attribute__((packed));
 818
 819 #define FILTER_GENERIC_1_BYTES 64
 820
 821 enum filter_generic_1_layer {
 822         FILTER_GENERIC_1_L2,
 823         FILTER_GENERIC_1_L3,
 824         FILTER_GENERIC_1_L4,
 825         FILTER_GENERIC_1_L5,
 826         FILTER_GENERIC_1_NUM_LAYERS
 827 };
 828
 829 #define FILTER_GENERIC_1_IPV4       (1 << 0)
 830 #define FILTER_GENERIC_1_IPV6       (1 << 1)
 831 #define FILTER_GENERIC_1_UDP        (1 << 2)
 832 #define FILTER_GENERIC_1_TCP        (1 << 3)
 833 #define FILTER_GENERIC_1_TCP_OR_UDP (1 << 4)
 834 #define FILTER_GENERIC_1_IP4SUM_OK  (1 << 5)
 835 #define FILTER_GENERIC_1_L4SUM_OK   (1 << 6)
 836 #define FILTER_GENERIC_1_IPFRAG     (1 << 7)
 837
 838 #define FILTER_GENERIC_1_KEY_LEN 64
 839
 840 /*
 841  * Version 1 of generic filter specification
 842  * position is only 16 bits, reserving positions > 64k to be used by firmware
 843  */
 844 struct filter_generic_1 {
 845         u16 position;       /* lower position comes first */
 846         u32 mask_flags;
 847         u32 val_flags;
 848         u16 mask_vlan;
 849         u16 val_vlan;
 850         struct {
 851                 u8 mask[FILTER_GENERIC_1_KEY_LEN]; /* 0 bit means "don't care"*/
 852                 u8 val[FILTER_GENERIC_1_KEY_LEN];
 853         } __attribute__((packed)) layer[FILTER_GENERIC_1_NUM_LAYERS];
 854 } __attribute__((packed));
 855
 856 /* Specifies the filter_action type. */
 857 enum {
 858         FILTER_ACTION_RQ_STEERING = 0,
 859         FILTER_ACTION_V2 = 1,
 860         FILTER_ACTION_MAX
 861 };
 862
 863 struct filter_action {
 864         u32 type;
 865         union {
 866                 u32 rq_idx;
 867         } u;
 868 } __attribute__((packed));
 869
 870 #define FILTER_ACTION_RQ_STEERING_FLAG  (1 << 0)
 871 #define FILTER_ACTION_FILTER_ID_FLAG    (1 << 1)
 872 #define FILTER_ACTION_V2_ALL            (FILTER_ACTION_RQ_STEERING_FLAG \
 873                                          | FILTER_ACTION_FILTER_ID_FLAG)
 874
 875 /* Version 2 of filter action must be a strict extension of struct filter_action
 876  * where the first fields exactly match in size and meaning.
 877  */
 878 struct filter_action_v2 {
 879         u32 type;
 880         u32 rq_idx;
 881         u32 flags;                     /* use FILTER_ACTION_XXX_FLAG defines */
 882         u16 filter_id;
 883         u_int8_t reserved[32];         /* for future expansion */
 884 } __attribute__((packed));
 885
 886 /* Specifies the filter type. */
 887 enum filter_type {
 888         FILTER_USNIC_ID = 0,
 889         FILTER_IPV4_5TUPLE = 1,
 890         FILTER_MAC_VLAN = 2,
 891         FILTER_VLAN_IP_3TUPLE = 3,
 892         FILTER_NVGRE_VMQ = 4,
 893         FILTER_USNIC_IP = 5,
 894         FILTER_DPDK_1 = 6,
 895         FILTER_MAX
 896 };
 897
 898 #define FILTER_USNIC_ID_FLAG            (1 << FILTER_USNIC_ID)
 899 #define FILTER_IPV4_5TUPLE_FLAG         (1 << FILTER_IPV4_5TUPLE)
 900 #define FILTER_MAC_VLAN_FLAG            (1 << FILTER_MAC_VLAN)
 901 #define FILTER_VLAN_IP_3TUPLE_FLAG      (1 << FILTER_VLAN_IP_3TUPLE)
 902 #define FILTER_NVGRE_VMQ_FLAG           (1 << FILTER_NVGRE_VMQ)
 903 #define FILTER_USNIC_IP_FLAG            (1 << FILTER_USNIC_IP)
 904 #define FILTER_DPDK_1_FLAG              (1 << FILTER_DPDK_1)
 905 #define FILTER_V1_ALL                   (FILTER_USNIC_ID_FLAG | \
 906                                         FILTER_IPV4_5TUPLE_FLAG | \
 907                                         FILTER_MAC_VLAN_FLAG | \
 908                                         FILTER_VLAN_IP_3TUPLE_FLAG | \
 909                                         FILTER_NVGRE_VMQ_FLAG | \
 910                                         FILTER_USNIC_IP_FLAG | \
 911                                         FILTER_DPDK_1_FLAG)
 912
 913 struct filter {
 914         u32 type;
 915         union {
 916                 struct filter_usnic_id usnic;
 917                 struct filter_ipv4_5tuple ipv4;
 918                 struct filter_mac_vlan mac_vlan;
 919                 struct filter_vlan_ip_3tuple vlan_3tuple;
 920         } u;
 921 } __attribute__((packed));
 922
 923 /*
 924  * This is a strict superset of "struct filter" and exists only
 925  * because many drivers use "sizeof (struct filter)" in deciding TLV size.
 926  * This new, larger struct filter would cause any code that uses that method
 927  * to not work with older firmware, so we add filter_v2 to hold the
 928  * new filter types.  Drivers should use vnic_filter_size() to determine
 929  * the TLV size instead of sizeof (struct fiter_v2) to guard against future
 930  * growth.
 931  */
 932 struct filter_v2 {
 933         u32 type;
 934         union {
 935                 struct filter_usnic_id usnic;
 936                 struct filter_ipv4_5tuple ipv4;
 937                 struct filter_mac_vlan mac_vlan;
 938                 struct filter_vlan_ip_3tuple vlan_3tuple;
 939                 struct filter_generic_1 generic_1;
 940         } u;
 941 } __attribute__((packed));
 942
 943 enum {
 944         CLSF_TLV_FILTER = 0,
 945         CLSF_TLV_ACTION = 1,
 946 };
 947
 948 struct filter_tlv {
 949         u_int32_t type;
 950         u_int32_t length;
 951         u_int32_t val[0];
 952 };
 953
 954 /* Data for CMD_ADD_FILTER is 2 TLV and filter + action structs */
 955 #define FILTER_MAX_BUF_SIZE 100
 956 #define FILTER_V2_MAX_BUF_SIZE (sizeof(struct filter_v2) + \
 957         sizeof(struct filter_action_v2) + \
 958         (2 * sizeof(struct filter_tlv)))
 959
 960 /*
 961  * Compute actual structure size given filter type.  To be "future-proof,"
 962  * drivers should use this instead of "sizeof (struct filter_v2)" when
 963  * computing length for TLV.
 964  */
 965 static inline u_int32_t
 966 vnic_filter_size(struct filter_v2 *fp)
 967 {
 968         u_int32_t size;
 969
 970         switch (fp->type) {
 971         case FILTER_USNIC_ID:
 972                 size = sizeof(fp->u.usnic);
 973                 break;
 974         case FILTER_IPV4_5TUPLE:
 975                 size = sizeof(fp->u.ipv4);
 976                 break;
 977         case FILTER_MAC_VLAN:
 978         case FILTER_NVGRE_VMQ:
 979                 size = sizeof(fp->u.mac_vlan);
 980                 break;
 981         case FILTER_VLAN_IP_3TUPLE:
 982                 size = sizeof(fp->u.vlan_3tuple);
 983                 break;
 984         case FILTER_USNIC_IP:
 985         case FILTER_DPDK_1:
 986                 size = sizeof(fp->u.generic_1);
 987                 break;
 988         default:
 989                 size = sizeof(fp->u);
 990                 break;
 991         }
 992         size += sizeof(fp->type);
 993         return size;
 994 }
 995
 996
 997 enum {
 998         CLSF_ADD = 0,
 999         CLSF_DEL = 1,
1000 };
1001
1002 /*
1003  * Get the action structure size given action type. To be "future-proof,"
1004  * drivers should use this instead of "sizeof (struct filter_action_v2)"
1005  * when computing length for TLV.
1006  */
1007 static inline u_int32_t
1008 vnic_action_size(struct filter_action_v2 *fap)
1009 {
1010         u_int32_t size;
1011
1012         switch (fap->type) {
1013         case FILTER_ACTION_RQ_STEERING:
1014                 size = sizeof(struct filter_action);
1015                 break;
1016         case FILTER_ACTION_V2:
1017                 size = sizeof(struct filter_action_v2);
1018                 break;
1019         default:
1020                 size = sizeof(struct filter_action);
1021                 break;
1022         }
1023         return size;
1024 }
1025
1026 /*
1027  * Writing cmd register causes STAT_BUSY to get set in status register.
1028  * When cmd completes, STAT_BUSY will be cleared.
1029  *
1030  * If cmd completed successfully STAT_ERROR will be clear
1031  * and args registers contain cmd-specific results.
1032  *
1033  * If cmd error, STAT_ERROR will be set and args[0] contains error code.
1034  *
1035  * status register is read-only.  While STAT_BUSY is set,
1036  * all other register contents are read-only.
1037  */
1038
1039 /* Make sizeof(vnic_devcmd) a power-of-2 for I/O BAR. */
1040 #define VNIC_DEVCMD_NARGS 15
1041 struct vnic_devcmd {
1042         u32 status;                     /* RO */
1043         u32 cmd;                        /* RW */
1044         u64 args[VNIC_DEVCMD_NARGS];    /* RW cmd args (little-endian) */
1045 };
1046
1047 /*
1048  * Version 2 of the interface.
1049  *
1050  * Some things are carried over, notably the vnic_devcmd_cmd enum.
1051  */
1052
1053 /*
1054  * Flags for vnic_devcmd2.flags
1055  */
1056
1057 #define DEVCMD2_FNORESULT       0x1     /* Don't copy result to host */
1058
1059 #define VNIC_DEVCMD2_NARGS      VNIC_DEVCMD_NARGS
1060 struct vnic_devcmd2 {
1061         u16 pad;
1062         u16 flags;
1063         u32 cmd;                /* same command #defines as original */
1064         u64 args[VNIC_DEVCMD2_NARGS];
1065 };
1066
1067 #define VNIC_DEVCMD2_NRESULTS   VNIC_DEVCMD_NARGS
1068 struct devcmd2_result {
1069         u64 results[VNIC_DEVCMD2_NRESULTS];
1070         u32 pad;
1071         u16 completed_index;    /* into copy WQ */
1072         u8  error;              /* same error codes as original */
1073         u8  color;              /* 0 or 1 as with completion queues */
1074 };
1075
1076 #define DEVCMD2_RING_SIZE   32
1077 #define DEVCMD2_DESC_SIZE   128
1078
1079 #define DEVCMD2_RESULTS_SIZE_MAX   ((1 << 16) - 1)
1080
1081 /* Overlay related definitions */
1082
1083 /*
1084  * This enum lists the flag associated with each of the overlay features
1085  */
1086 typedef enum {
1087         OVERLAY_FEATURE_NVGRE = 1,
1088         OVERLAY_FEATURE_VXLAN,
1089         OVERLAY_FEATURE_MAX,
1090 } overlay_feature_t;
1091
1092 #define OVERLAY_OFFLOAD_ENABLE          0
1093 #define OVERLAY_OFFLOAD_DISABLE         1
1094 #define OVERLAY_OFFLOAD_ENABLE_V2       2
1095
1096 #define OVERLAY_CFG_VXLAN_PORT_UPDATE 0
1097
1098 /*
1099  * Use this enum to get the supported versions for each of these features
1100  * If you need to use the devcmd_get_supported_feature_version(), add
1101  * the new feature into this enum and install function handler in devcmd.c
1102  */
1103 typedef enum {
1104         VIC_FEATURE_VXLAN,
1105         VIC_FEATURE_RDMA,
1106         VIC_FEATURE_MAX,
1107 } vic_feature_t;
1108
1109 /*
1110  * CMD_CONFIG_GRPINTR subcommands
1111  */
1112 typedef enum {
1113         GRPINTR_ENABLE = 1,
1114         GRPINTR_DISABLE,
1115         GRPINTR_UPD_VECT,
1116 } grpintr_subcmd_t;
1117
1118 #endif /* _VNIC_DEVCMD_H_ */