lib/librte_pmd_enic/vnic/vnic_devcmd.h

   1 /*
   2  * Copyright 2008-2010 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 #ident "$Id: vnic_devcmd.h 173135 2014-05-16 03:14:07Z sanpilla $"
  35
  36 #ifndef _VNIC_DEVCMD_H_
  37 #define _VNIC_DEVCMD_H_
  38
  39 #define _CMD_NBITS      14
  40 #define _CMD_VTYPEBITS  10
  41 #define _CMD_FLAGSBITS  6
  42 #define _CMD_DIRBITS    2
  43
  44 #define _CMD_NMASK      ((1 << _CMD_NBITS)-1)
  45 #define _CMD_VTYPEMASK  ((1 << _CMD_VTYPEBITS)-1)
  46 #define _CMD_FLAGSMASK  ((1 << _CMD_FLAGSBITS)-1)
  47 #define _CMD_DIRMASK    ((1 << _CMD_DIRBITS)-1)
  48
  49 #define _CMD_NSHIFT     0
  50 #define _CMD_VTYPESHIFT (_CMD_NSHIFT+_CMD_NBITS)
  51 #define _CMD_FLAGSSHIFT (_CMD_VTYPESHIFT+_CMD_VTYPEBITS)
  52 #define _CMD_DIRSHIFT   (_CMD_FLAGSSHIFT+_CMD_FLAGSBITS)
  53
  54 /*
  55  * Direction bits (from host perspective).
  56  */
  57 #define _CMD_DIR_NONE   0U
  58 #define _CMD_DIR_WRITE  1U
  59 #define _CMD_DIR_READ   2U
  60 #define _CMD_DIR_RW     (_CMD_DIR_WRITE | _CMD_DIR_READ)
  61
  62 /*
  63  * Flag bits.
  64  */
  65 #define _CMD_FLAGS_NONE 0U
  66 #define _CMD_FLAGS_NOWAIT 1U
  67
  68 /*
  69  * vNIC type bits.
  70  */
  71 #define _CMD_VTYPE_NONE  0U
  72 #define _CMD_VTYPE_ENET  1U
  73 #define _CMD_VTYPE_FC    2U
  74 #define _CMD_VTYPE_SCSI  4U
  75 #define _CMD_VTYPE_ALL   (_CMD_VTYPE_ENET | _CMD_VTYPE_FC | _CMD_VTYPE_SCSI)
  76
  77 /*
  78  * Used to create cmds..
  79  */
  80 #define _CMDCF(dir, flags, vtype, nr)  \
  81         (((dir)   << _CMD_DIRSHIFT) | \
  82         ((flags) << _CMD_FLAGSSHIFT) | \
  83         ((vtype) << _CMD_VTYPESHIFT) | \
  84         ((nr)    << _CMD_NSHIFT))
  85 #define _CMDC(dir, vtype, nr)    _CMDCF(dir, 0, vtype, nr)
  86 #define _CMDCNW(dir, vtype, nr)  _CMDCF(dir, _CMD_FLAGS_NOWAIT, vtype, nr)
  87
  88 /*
  89  * Used to decode cmds..
  90  */
  91 #define _CMD_DIR(cmd)            (((cmd) >> _CMD_DIRSHIFT) & _CMD_DIRMASK)
  92 #define _CMD_FLAGS(cmd)          (((cmd) >> _CMD_FLAGSSHIFT) & _CMD_FLAGSMASK)
  93 #define _CMD_VTYPE(cmd)          (((cmd) >> _CMD_VTYPESHIFT) & _CMD_VTYPEMASK)
  94 #define _CMD_N(cmd)              (((cmd) >> _CMD_NSHIFT) & _CMD_NMASK)
  95
  96 enum vnic_devcmd_cmd {
  97         CMD_NONE                = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_NONE, 0),
  98
  99         /*
 100          * mcpu fw info in mem:
 101          * in:
 102          *   (u64)a0=paddr to struct vnic_devcmd_fw_info
 103          * action:
 104          *   Fills in struct vnic_devcmd_fw_info (128 bytes)
 105          * note:
 106          *   An old definition of CMD_MCPU_FW_INFO
 107          */
 108         CMD_MCPU_FW_INFO_OLD    = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 1),
 109
 110         /*
 111          * mcpu fw info in mem:
 112          * in:
 113          *   (u64)a0=paddr to struct vnic_devcmd_fw_info
 114          *   (u16)a1=size of the structure
 115          * out:
 116          *       (u16)a1=0                          for in:a1 = 0,
 117          *               data size actually written for other values.
 118          * action:
 119          *   Fills in first 128 bytes of vnic_devcmd_fw_info for in:a1 = 0,
 120          *            first in:a1 bytes               for 0 < in:a1 <= 132,
 121          *            132 bytes                       for other values of in:a1.
 122          * note:
 123          *   CMD_MCPU_FW_INFO and CMD_MCPU_FW_INFO_OLD have the same enum 1
 124          *   for source compatibility.
 125          */
 126         CMD_MCPU_FW_INFO        = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 1),
 127
 128         /* dev-specific block member:
 129          *    in: (u16)a0=offset,(u8)a1=size
 130          *    out: a0=value */
 131         CMD_DEV_SPEC            = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 2),
 132
 133         /* stats clear */
 134         CMD_STATS_CLEAR         = _CMDCNW(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 3),
 135
 136         /* stats dump in mem: (u64)a0=paddr to stats area,
 137          *                    (u16)a1=sizeof stats area */
 138         CMD_STATS_DUMP          = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 4),
 139
 140         /* set Rx packet filter: (u32)a0=filters (see CMD_PFILTER_*) */
 141         CMD_PACKET_FILTER       = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 7),
 142
 143         /* set Rx packet filter for all: (u32)a0=filters (see CMD_PFILTER_*) */
 144         CMD_PACKET_FILTER_ALL   = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 7),
 145
 146         /* hang detection notification */
 147         CMD_HANG_NOTIFY         = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 8),
 148
 149         /* MAC address in (u48)a0 */
 150         CMD_GET_MAC_ADDR        = _CMDC(_CMD_DIR_READ,
 151                                         _CMD_VTYPE_ENET | _CMD_VTYPE_FC, 9),
 152
 153         /* add addr from (u48)a0 */
 154         CMD_ADDR_ADD            = _CMDCNW(_CMD_DIR_WRITE,
 155                                         _CMD_VTYPE_ENET | _CMD_VTYPE_FC, 12),
 156
 157         /* del addr from (u48)a0 */
 158         CMD_ADDR_DEL            = _CMDCNW(_CMD_DIR_WRITE,
 159                                         _CMD_VTYPE_ENET | _CMD_VTYPE_FC, 13),
 160
 161         /* add VLAN id in (u16)a0 */
 162         CMD_VLAN_ADD            = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 14),
 163
 164         /* del VLAN id in (u16)a0 */
 165         CMD_VLAN_DEL            = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 15),
 166
 167         /* nic_cfg in (u32)a0 */
 168         CMD_NIC_CFG             = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 16),
 169
 170         /* union vnic_rss_key in mem: (u64)a0=paddr, (u16)a1=len */
 171         CMD_RSS_KEY             = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 17),
 172
 173         /* union vnic_rss_cpu in mem: (u64)a0=paddr, (u16)a1=len */
 174         CMD_RSS_CPU             = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 18),
 175
 176         /* initiate softreset */
 177         CMD_SOFT_RESET          = _CMDCNW(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 19),
 178
 179         /* softreset status:
 180          *    out: a0=0 reset complete, a0=1 reset in progress */
 181         CMD_SOFT_RESET_STATUS   = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 20),
 182
 183         /* set struct vnic_devcmd_notify buffer in mem:
 184          * in:
 185          *   (u64)a0=paddr to notify (set paddr=0 to unset)
 186          *   (u32)a1 & 0x00000000ffffffff=sizeof(struct vnic_devcmd_notify)
 187          *   (u16)a1 & 0x0000ffff00000000=intr num (-1 for no intr)
 188          * out:
 189          *   (u32)a1 = effective size
 190          */
 191         CMD_NOTIFY              = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 21),
 192
 193         /* UNDI API: (u64)a0=paddr to s_PXENV_UNDI_ struct,
 194          *           (u8)a1=PXENV_UNDI_xxx */
 195         CMD_UNDI                = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 22),
 196
 197         /* initiate open sequence (u32)a0=flags (see CMD_OPENF_*) */
 198         CMD_OPEN                = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 23),
 199
 200         /* open status:
 201          *    out: a0=0 open complete, a0=1 open in progress */
 202         CMD_OPEN_STATUS         = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 24),
 203
 204         /* close vnic */
 205         CMD_CLOSE               = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 25),
 206
 207         /* initialize virtual link: (u32)a0=flags (see CMD_INITF_*) */
 208 /***** Replaced by CMD_INIT *****/
 209         CMD_INIT_v1             = _CMDCNW(_CMD_DIR_READ, _CMD_VTYPE_ALL, 26),
 210
 211         /* variant of CMD_INIT, with provisioning info
 212          *     (u64)a0=paddr of vnic_devcmd_provinfo
 213          *     (u32)a1=sizeof provision info */
 214         CMD_INIT_PROV_INFO      = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 27),
 215
 216         /* enable virtual link */
 217         CMD_ENABLE              = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 28),
 218
 219         /* enable virtual link, waiting variant. */
 220         CMD_ENABLE_WAIT         = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 28),
 221
 222         /* disable virtual link */
 223         CMD_DISABLE             = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 29),
 224
 225         /* stats dump sum of all vnic stats on same uplink in mem:
 226          *     (u64)a0=paddr
 227          *     (u16)a1=sizeof stats area */
 228         CMD_STATS_DUMP_ALL      = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 30),
 229
 230         /* init status:
 231          *    out: a0=0 init complete, a0=1 init in progress
 232          *         if a0=0, a1=errno */
 233         CMD_INIT_STATUS         = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 31),
 234
 235         /* INT13 API: (u64)a0=paddr to vnic_int13_params struct
 236          *            (u32)a1=INT13_CMD_xxx */
 237         CMD_INT13               = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_FC, 32),
 238
 239         /* logical uplink enable/disable: (u64)a0: 0/1=disable/enable */
 240         CMD_LOGICAL_UPLINK      = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 33),
 241
 242         /* undo initialize of virtual link */
 243         CMD_DEINIT              = _CMDCNW(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 34),
 244
 245         /* initialize virtual link: (u32)a0=flags (see CMD_INITF_*) */
 246         CMD_INIT                = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 35),
 247
 248         /* check fw capability of a cmd:
 249          * in:  (u32)a0=cmd
 250          * out: (u32)a0=errno, 0:valid cmd, a1=supported VNIC_STF_* bits */
 251         CMD_CAPABILITY          = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 36),
 252
 253         /* persistent binding info
 254          * in:  (u64)a0=paddr of arg
 255          *      (u32)a1=CMD_PERBI_XXX */
 256         CMD_PERBI               = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_FC, 37),
 257
 258         /* Interrupt Assert Register functionality
 259          * in: (u16)a0=interrupt number to assert
 260          */
 261         CMD_IAR                 = _CMDCNW(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 38),
 262
 263         /* initiate hangreset, like softreset after hang detected */
 264         CMD_HANG_RESET          = _CMDC(_CMD_DIR_NONE, _CMD_VTYPE_ALL, 39),
 265
 266         /* hangreset status:
 267          *    out: a0=0 reset complete, a0=1 reset in progress */
 268         CMD_HANG_RESET_STATUS   = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 40),
 269
 270         /*
 271          * Set hw ingress packet vlan rewrite mode:
 272          * in:  (u32)a0=new vlan rewrite mode
 273          * out: (u32)a0=old vlan rewrite mode */
 274         CMD_IG_VLAN_REWRITE_MODE = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ENET, 41),
 275
 276         /*
 277          * in:  (u16)a0=bdf of target vnic
 278          *      (u32)a1=cmd to proxy
 279          *      a2-a15=args to cmd in a1
 280          * out: (u32)a0=status of proxied cmd
 281          *      a1-a15=out args of proxied cmd */
 282         CMD_PROXY_BY_BDF =      _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 42),
 283
 284         /*
 285          * As for BY_BDF except a0 is index of hvnlink subordinate vnic
 286          * or SR-IOV virtual vnic
 287          */
 288         CMD_PROXY_BY_INDEX =    _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 43),
 289
 290         /*
 291          * For HPP toggle:
 292          * adapter-info-get
 293          * in:  (u64)a0=phsical address of buffer passed in from caller.
 294          *      (u16)a1=size of buffer specified in a0.
 295          * out: (u64)a0=phsical address of buffer passed in from caller.
 296          *      (u16)a1=actual bytes from VIF-CONFIG-INFO TLV, or
 297          *              0 if no VIF-CONFIG-INFO TLV was ever received. */
 298         CMD_CONFIG_INFO_GET = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 44),
 299
 300         /*
 301          * INT13 API: (u64)a0=paddr to vnic_int13_params struct
 302          *            (u32)a1=INT13_CMD_xxx
 303          */
 304         CMD_INT13_ALL = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 45),
 305
 306         /*
 307          * Set default vlan:
 308          * in: (u16)a0=new default vlan
 309          *     (u16)a1=zero for overriding vlan with param a0,
 310          *                     non-zero for resetting vlan to the default
 311          * out: (u16)a0=old default vlan
 312          */
 313         CMD_SET_DEFAULT_VLAN = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 46),
 314
 315         /* init_prov_info2:
 316          * Variant of CMD_INIT_PROV_INFO, where it will not try to enable
 317          * the vnic until CMD_ENABLE2 is issued.
 318          *     (u64)a0=paddr of vnic_devcmd_provinfo
 319          *     (u32)a1=sizeof provision info */
 320         CMD_INIT_PROV_INFO2  = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 47),
 321
 322         /* enable2:
 323          *      (u32)a0=0                  ==> standby
 324          *             =CMD_ENABLE2_ACTIVE ==> active
 325          */
 326         CMD_ENABLE2 = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 48),
 327
 328         /*
 329          * cmd_status:
 330          *     Returns the status of the specified command
 331          * Input:
 332          *     a0 = command for which status is being queried.
 333          *          Possible values are:
 334          *              CMD_SOFT_RESET
 335          *              CMD_HANG_RESET
 336          *              CMD_OPEN
 337          *              CMD_INIT
 338          *              CMD_INIT_PROV_INFO
 339          *              CMD_DEINIT
 340          *              CMD_INIT_PROV_INFO2
 341          *              CMD_ENABLE2
 342          * Output:
 343          *     if status == STAT_ERROR
 344          *        a0 = ERR_ENOTSUPPORTED - status for command in a0 is
 345          *                                 not supported
 346          *     if status == STAT_NONE
 347          *        a0 = status of the devcmd specified in a0 as follows.
 348          *             ERR_SUCCESS   - command in a0 completed successfully
 349          *             ERR_EINPROGRESS - command in a0 is still in progress
 350          */
 351         CMD_STATUS = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 49),
 352
 353         /*
 354          * Returns interrupt coalescing timer conversion factors.
 355          * After calling this devcmd, ENIC driver can convert
 356          * interrupt coalescing timer in usec into CPU cycles as follows:
 357          *
 358          *   intr_timer_cycles = intr_timer_usec * multiplier / divisor
 359          *
 360          * Interrupt coalescing timer in usecs can be be converted/obtained
 361          * from CPU cycles as follows:
 362          *
 363          *   intr_timer_usec = intr_timer_cycles * divisor / multiplier
 364          *
 365          * in: none
 366          * out: (u32)a0 = multiplier
 367          *      (u32)a1 = divisor
 368          *      (u32)a2 = maximum timer value in usec
 369          */
 370         CMD_INTR_COAL_CONVERT = _CMDC(_CMD_DIR_READ, _CMD_VTYPE_ALL, 50),
 371
 372         /*
 373          * ISCSI DUMP API:
 374          * in: (u64)a0=paddr of the param or param itself
 375          *     (u32)a1=ISCSI_CMD_xxx
 376          */
 377         CMD_ISCSI_DUMP_REQ = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 51),
 378
 379         /*
 380          * ISCSI DUMP STATUS API:
 381          * in: (u32)a0=cmd tag
 382          * in: (u32)a1=ISCSI_CMD_xxx
 383          * out: (u32)a0=cmd status
 384          */
 385         CMD_ISCSI_DUMP_STATUS = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 52),
 386
 387         /*
 388          * Subvnic migration from MQ <--> VF.
 389          * Enable the LIF migration from MQ to VF and vice versa. MQ and VF
 390          * indexes are statically bound at the time of initialization.
 391          * Based on the
 392          * direction of migration, the resources of either MQ or the VF shall
 393          * be attached to the LIF.
 394          * in:        (u32)a0=Direction of Migration
 395          *                                      0=> Migrate to VF
 396          *                                      1=> Migrate to MQ
 397          *            (u32)a1=VF index (MQ index)
 398          */
 399         CMD_MIGRATE_SUBVNIC = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 53),
 400
 401
 402         /*
 403          * Register / Deregister the notification block for MQ subvnics
 404          * in:
 405          *   (u64)a0=paddr to notify (set paddr=0 to unset)
 406          *   (u32)a1 & 0x00000000ffffffff=sizeof(struct vnic_devcmd_notify)
 407          *   (u16)a1 & 0x0000ffff00000000=intr num (-1 for no intr)
 408          * out:
 409          *   (u32)a1 = effective size
 410          */
 411         CMD_SUBVNIC_NOTIFY = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ALL, 54),
 412
 413         /*
 414          * Set the predefined mac address as default
 415          * in:
 416          *   (u48)a0=mac addr
 417          */
 418         CMD_SET_MAC_ADDR = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 55),
 419
 420         /* Update the provisioning info of the given VIF
 421          *     (u64)a0=paddr of vnic_devcmd_provinfo
 422          *     (u32)a1=sizeof provision info */
 423         CMD_PROV_INFO_UPDATE = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 56),
 424
 425         /*
 426          * Initialization for the devcmd2 interface.
 427          * in: (u64) a0=host result buffer physical address
 428          * in: (u16) a1=number of entries in result buffer
 429          */
 430         CMD_INITIALIZE_DEVCMD2 = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ALL, 57),
 431
 432         /*
 433          * Add a filter.
 434          * in: (u64) a0= filter address
 435          *     (u32) a1= size of filter
 436          * out: (u32) a0=filter identifier
 437          */
 438         CMD_ADD_FILTER = _CMDC(_CMD_DIR_RW, _CMD_VTYPE_ENET, 58),
 439
 440         /*
 441          * Delete a filter.
 442          * in: (u32) a0=filter identifier
 443          */
 444         CMD_DEL_FILTER = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 59),
 445
 446         /*
 447          * Enable a Queue Pair in User space NIC
 448          * in: (u32) a0=Queue Pair number
 449          *     (u32) a1= command
 450          */
 451         CMD_QP_ENABLE = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 60),
 452
 453         /*
 454          * Disable a Queue Pair in User space NIC
 455          * in: (u32) a0=Queue Pair number
 456          *     (u32) a1= command
 457          */
 458         CMD_QP_DISABLE = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 61),
 459
 460         /*
 461          * Stats dump Queue Pair in User space NIC
 462          * in: (u32) a0=Queue Pair number
 463          *     (u64) a1=host buffer addr for status dump
 464          *     (u32) a2=length of the buffer
 465          */
 466         CMD_QP_STATS_DUMP = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 62),
 467
 468         /*
 469          * Clear stats for Queue Pair in User space NIC
 470          * in: (u32) a0=Queue Pair number
 471          */
 472         CMD_QP_STATS_CLEAR = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 63),
 473
 474         /*
 475          * Enable/Disable overlay offloads on the given vnic
 476          * in: (u8) a0 = OVERLAY_FEATURE_NVGRE : NVGRE
 477          *          a0 = OVERLAY_FEATURE_VXLAN : VxLAN
 478          * in: (u8) a1 = OVERLAY_OFFLOAD_ENABLE : Enable
 479          *          a1 = OVERLAY_OFFLOAD_DISABLE : Disable
 480          */
 481         CMD_OVERLAY_OFFLOAD_ENABLE_DISABLE =
 482                 _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 72),
 483
 484         /*
 485          * Configuration of overlay offloads feature on a given vNIC
 486          * in: (u8) a0 = DEVCMD_OVERLAY_NVGRE : NVGRE
 487          *          a0 = DEVCMD_OVERLAY_VXLAN : VxLAN
 488          * in: (u8) a1 = VXLAN_PORT_UPDATE : VxLAN
 489          * in: (u16) a2 = unsigned short int port information
 490          */
 491         CMD_OVERLAY_OFFLOAD_CFG = _CMDC(_CMD_DIR_WRITE, _CMD_VTYPE_ENET, 73),
 492 };
 493
 494 /* CMD_ENABLE2 flags */
 495 #define CMD_ENABLE2_STANDBY 0x0
 496 #define CMD_ENABLE2_ACTIVE  0x1
 497
 498 /* flags for CMD_OPEN */
 499 #define CMD_OPENF_OPROM         0x1     /* open coming from option rom */
 500
 501 /* flags for CMD_INIT */
 502 #define CMD_INITF_DEFAULT_MAC   0x1     /* init with default mac addr */
 503
 504 /* flags for CMD_PACKET_FILTER */
 505 #define CMD_PFILTER_DIRECTED            0x01
 506 #define CMD_PFILTER_MULTICAST           0x02
 507 #define CMD_PFILTER_BROADCAST           0x04
 508 #define CMD_PFILTER_PROMISCUOUS         0x08
 509 #define CMD_PFILTER_ALL_MULTICAST       0x10
 510
 511 /* Commands for CMD_QP_ENABLE/CM_QP_DISABLE */
 512 #define CMD_QP_RQWQ                     0x0
 513
 514 /* rewrite modes for CMD_IG_VLAN_REWRITE_MODE */
 515 #define IG_VLAN_REWRITE_MODE_DEFAULT_TRUNK              0
 516 #define IG_VLAN_REWRITE_MODE_UNTAG_DEFAULT_VLAN         1
 517 #define IG_VLAN_REWRITE_MODE_PRIORITY_TAG_DEFAULT_VLAN  2
 518 #define IG_VLAN_REWRITE_MODE_PASS_THRU                  3
 519
 520 enum vnic_devcmd_status {
 521         STAT_NONE = 0,
 522         STAT_BUSY = 1 << 0,     /* cmd in progress */
 523         STAT_ERROR = 1 << 1,    /* last cmd caused error (code in a0) */
 524 };
 525
 526 enum vnic_devcmd_error {
 527         ERR_SUCCESS = 0,
 528         ERR_EINVAL = 1,
 529         ERR_EFAULT = 2,
 530         ERR_EPERM = 3,
 531         ERR_EBUSY = 4,
 532         ERR_ECMDUNKNOWN = 5,
 533         ERR_EBADSTATE = 6,
 534         ERR_ENOMEM = 7,
 535         ERR_ETIMEDOUT = 8,
 536         ERR_ELINKDOWN = 9,
 537         ERR_EMAXRES = 10,
 538         ERR_ENOTSUPPORTED = 11,
 539         ERR_EINPROGRESS = 12,
 540         ERR_MAX
 541 };
 542
 543 /*
 544  * note: hw_version and asic_rev refer to the same thing,
 545  *       but have different formats. hw_version is
 546  *       a 32-byte string (e.g. "A2") and asic_rev is
 547  *       a 16-bit integer (e.g. 0xA2).
 548  */
 549 struct vnic_devcmd_fw_info {
 550         char fw_version[32];
 551         char fw_build[32];
 552         char hw_version[32];
 553         char hw_serial_number[32];
 554         u16 asic_type;
 555         u16 asic_rev;
 556 };
 557
 558 enum fwinfo_asic_type {
 559         FWINFO_ASIC_TYPE_UNKNOWN,
 560         FWINFO_ASIC_TYPE_PALO,
 561         FWINFO_ASIC_TYPE_SERENO,
 562 };
 563
 564
 565 struct vnic_devcmd_notify {
 566         u32 csum;               /* checksum over following words */
 567
 568         u32 link_state;         /* link up == 1 */
 569         u32 port_speed;         /* effective port speed (rate limit) */
 570         u32 mtu;                /* MTU */
 571         u32 msglvl;             /* requested driver msg lvl */
 572         u32 uif;                /* uplink interface */
 573         u32 status;             /* status bits (see VNIC_STF_*) */
 574         u32 error;              /* error code (see ERR_*) for first ERR */
 575         u32 link_down_cnt;      /* running count of link down transitions */
 576         u32 perbi_rebuild_cnt;  /* running count of perbi rebuilds */
 577 };
 578 #define VNIC_STF_FATAL_ERR      0x0001  /* fatal fw error */
 579 #define VNIC_STF_STD_PAUSE      0x0002  /* standard link-level pause on */
 580 #define VNIC_STF_PFC_PAUSE      0x0004  /* priority flow control pause on */
 581 /* all supported status flags */
 582 #define VNIC_STF_ALL            (VNIC_STF_FATAL_ERR |\
 583                                  VNIC_STF_STD_PAUSE |\
 584                                  VNIC_STF_PFC_PAUSE |\
 585                                  0)
 586
 587 struct vnic_devcmd_provinfo {
 588         u8 oui[3];
 589         u8 type;
 590         u8 data[0];
 591 };
 592
 593 /*
 594  * These are used in flags field of different filters to denote
 595  * valid fields used.
 596  */
 597 #define FILTER_FIELD_VALID(fld) (1 << (fld - 1))
 598
 599 #define FILTER_FIELDS_USNIC (FILTER_FIELD_VALID(1) | \
 600                              FILTER_FIELD_VALID(2) | \
 601                              FILTER_FIELD_VALID(3) | \
 602                              FILTER_FIELD_VALID(4))
 603
 604 #define FILTER_FIELDS_IPV4_5TUPLE (FILTER_FIELD_VALID(1) | \
 605                                    FILTER_FIELD_VALID(2) | \
 606                                    FILTER_FIELD_VALID(3) | \
 607                                    FILTER_FIELD_VALID(4) | \
 608                                    FILTER_FIELD_VALID(5))
 609
 610 #define FILTER_FIELDS_MAC_VLAN (FILTER_FIELD_VALID(1) | \
 611                                 FILTER_FIELD_VALID(2))
 612
 613 #define FILTER_FIELD_USNIC_VLAN    FILTER_FIELD_VALID(1)
 614 #define FILTER_FIELD_USNIC_ETHTYPE FILTER_FIELD_VALID(2)
 615 #define FILTER_FIELD_USNIC_PROTO   FILTER_FIELD_VALID(3)
 616 #define FILTER_FIELD_USNIC_ID      FILTER_FIELD_VALID(4)
 617
 618 struct filter_usnic_id {
 619         u32 flags;
 620         u16 vlan;
 621         u16 ethtype;
 622         u8 proto_version;
 623         u32 usnic_id;
 624 } __attribute__((packed));
 625
 626 #define FILTER_FIELD_5TUP_PROTO  FILTER_FIELD_VALID(1)
 627 #define FILTER_FIELD_5TUP_SRC_AD FILTER_FIELD_VALID(2)
 628 #define FILTER_FIELD_5TUP_DST_AD FILTER_FIELD_VALID(3)
 629 #define FILTER_FIELD_5TUP_SRC_PT FILTER_FIELD_VALID(4)
 630 #define FILTER_FIELD_5TUP_DST_PT FILTER_FIELD_VALID(5)
 631
 632 /* Enums for the protocol field. */
 633 enum protocol_e {
 634         PROTO_UDP = 0,
 635         PROTO_TCP = 1,
 636 };
 637
 638 struct filter_ipv4_5tuple {
 639         u32 flags;
 640         u32 protocol;
 641         u32 src_addr;
 642         u32 dst_addr;
 643         u16 src_port;
 644         u16 dst_port;
 645 } __attribute__((packed));
 646
 647 #define FILTER_FIELD_VMQ_VLAN   FILTER_FIELD_VALID(1)
 648 #define FILTER_FIELD_VMQ_MAC    FILTER_FIELD_VALID(2)
 649
 650 struct filter_mac_vlan {
 651         u32 flags;
 652         u16 vlan;
 653         u8 mac_addr[6];
 654 } __attribute__((packed));
 655
 656 /* Specifies the filter_action type. */
 657 enum {
 658         FILTER_ACTION_RQ_STEERING = 0,
 659         FILTER_ACTION_MAX
 660 };
 661
 662 struct filter_action {
 663         u32 type;
 664         union {
 665                 u32 rq_idx;
 666         } u;
 667 } __attribute__((packed));
 668
 669 /* Specifies the filter type. */
 670 enum filter_type {
 671         FILTER_USNIC_ID = 0,
 672         FILTER_IPV4_5TUPLE = 1,
 673         FILTER_MAC_VLAN = 2,
 674         FILTER_MAX
 675 };
 676
 677 struct filter {
 678         u32 type;
 679         union {
 680                 struct filter_usnic_id usnic;
 681                 struct filter_ipv4_5tuple ipv4;
 682                 struct filter_mac_vlan mac_vlan;
 683         } u;
 684 } __attribute__((packed));
 685
 686 enum {
 687         CLSF_TLV_FILTER = 0,
 688         CLSF_TLV_ACTION = 1,
 689 };
 690
 691 #define FILTER_MAX_BUF_SIZE 100  /* Maximum size of buffer to CMD_ADD_FILTER */
 692
 693 struct filter_tlv {
 694         uint32_t type;
 695         uint32_t length;
 696         uint32_t val[0];
 697 };
 698
 699 enum {
 700         CLSF_ADD = 0,
 701         CLSF_DEL = 1,
 702 };
 703
 704 /*
 705  * Writing cmd register causes STAT_BUSY to get set in status register.
 706  * When cmd completes, STAT_BUSY will be cleared.
 707  *
 708  * If cmd completed successfully STAT_ERROR will be clear
 709  * and args registers contain cmd-specific results.
 710  *
 711  * If cmd error, STAT_ERROR will be set and args[0] contains error code.
 712  *
 713  * status register is read-only.  While STAT_BUSY is set,
 714  * all other register contents are read-only.
 715  */
 716
 717 /* Make sizeof(vnic_devcmd) a power-of-2 for I/O BAR. */
 718 #define VNIC_DEVCMD_NARGS 15
 719 struct vnic_devcmd {
 720         u32 status;                     /* RO */
 721         u32 cmd;                        /* RW */
 722         u64 args[VNIC_DEVCMD_NARGS];    /* RW cmd args (little-endian) */
 723 };
 724
 725 /*
 726  * Version 2 of the interface.
 727  *
 728  * Some things are carried over, notably the vnic_devcmd_cmd enum.
 729  */
 730
 731 /*
 732  * Flags for vnic_devcmd2.flags
 733  */
 734
 735 #define DEVCMD2_FNORESULT       0x1     /* Don't copy result to host */
 736
 737 #define VNIC_DEVCMD2_NARGS      VNIC_DEVCMD_NARGS
 738 struct vnic_devcmd2 {
 739         u16 pad;
 740         u16 flags;
 741         u32 cmd;                /* same command #defines as original */
 742         u64 args[VNIC_DEVCMD2_NARGS];
 743 };
 744
 745 #define VNIC_DEVCMD2_NRESULTS   VNIC_DEVCMD_NARGS
 746 struct devcmd2_result {
 747         u64 results[VNIC_DEVCMD2_NRESULTS];
 748         u32 pad;
 749         u16 completed_index;    /* into copy WQ */
 750         u8  error;              /* same error codes as original */
 751         u8  color;              /* 0 or 1 as with completion queues */
 752 };
 753
 754 #define DEVCMD2_RING_SIZE   32
 755 #define DEVCMD2_DESC_SIZE   128
 756
 757 #define DEVCMD2_RESULTS_SIZE_MAX   ((1 << 16) - 1)
 758
 759 /* Overlay related definitions */
 760
 761 /*
 762  * This enum lists the flag associated with each of the overlay features
 763  */
 764 typedef enum {
 765         OVERLAY_FEATURE_NVGRE = 1,
 766         OVERLAY_FEATURE_VXLAN,
 767         OVERLAY_FEATURE_MAX,
 768 } overlay_feature_t;
 769
 770 #define OVERLAY_OFFLOAD_ENABLE 0
 771 #define OVERLAY_OFFLOAD_DISABLE 1
 772
 773 #define OVERLAY_CFG_VXLAN_PORT_UPDATE 0
 774 #endif /* _VNIC_DEVCMD_H_ */