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