drivers/net/ethernet/netronome/nfp/nfp_net_ctrl.h

   1 /*
   2  * Copyright (C) 2015-2017 Netronome Systems, Inc.
   3  *
   4  * This software is dual licensed under the GNU General License Version 2,
   5  * June 1991 as shown in the file COPYING in the top-level directory of this
   6  * source tree or the BSD 2-Clause License provided below.  You have the
   7  * option to license this software under the complete terms of either license.
   8  *
   9  * The BSD 2-Clause License:
  10  *
  11  *     Redistribution and use in source and binary forms, with or
  12  *     without modification, are permitted provided that the following
  13  *     conditions are met:
  14  *
  15  *      1. Redistributions of source code must retain the above
  16  *         copyright notice, this list of conditions and the following
  17  *         disclaimer.
  18  *
  19  *      2. Redistributions in binary form must reproduce the above
  20  *         copyright notice, this list of conditions and the following
  21  *         disclaimer in the documentation and/or other materials
  22  *         provided with the distribution.
  23  *
  24  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  25  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  26  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  27  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  28  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  29  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  30  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  31  * SOFTWARE.
  32  */
  33
  34 /*
  35  * nfp_net_ctrl.h
  36  * Netronome network device driver: Control BAR layout
  37  * Authors: Jakub Kicinski <jakub.kicinski@netronome.com>
  38  *          Jason McMullan <jason.mcmullan@netronome.com>
  39  *          Rolf Neugebauer <rolf.neugebauer@netronome.com>
  40  *          Brad Petrus <brad.petrus@netronome.com>
  41  */
  42
  43 #ifndef _NFP_NET_CTRL_H_
  44 #define _NFP_NET_CTRL_H_
  45
  46 #include <linux/types.h>
  47
  48 /**
  49  * Configuration BAR size.
  50  *
  51  * The configuration BAR is 8K in size, but due to
  52  * THB-350, 32k needs to be reserved.
  53  */
  54 #define NFP_NET_CFG_BAR_SZ              (32 * 1024)
  55
  56 /**
  57  * Offset in Freelist buffer where packet starts on RX
  58  */
  59 #define NFP_NET_RX_OFFSET               32
  60
  61 /**
  62  * LSO parameters
  63  * %NFP_NET_LSO_MAX_HDR_SZ:     Maximum header size supported for LSO frames
  64  * %NFP_NET_LSO_MAX_SEGS:       Maximum number of segments LSO frame can produce
  65  */
  66 #define NFP_NET_LSO_MAX_HDR_SZ          255
  67 #define NFP_NET_LSO_MAX_SEGS            64
  68
  69 /**
  70  * Prepend field types
  71  */
  72 #define NFP_NET_META_FIELD_SIZE         4
  73 #define NFP_NET_META_HASH               1 /* next field carries hash type */
  74 #define NFP_NET_META_MARK               2
  75 #define NFP_NET_META_PORTID             5
  76 #define NFP_NET_META_CSUM               6 /* checksum complete type */
  77
  78 #define NFP_META_PORT_ID_CTRL           ~0U
  79
  80 /**
  81  * Hash type pre-pended when a RSS hash was computed
  82  */
  83 #define NFP_NET_RSS_NONE                0
  84 #define NFP_NET_RSS_IPV4                1
  85 #define NFP_NET_RSS_IPV6                2
  86 #define NFP_NET_RSS_IPV6_EX             3
  87 #define NFP_NET_RSS_IPV4_TCP            4
  88 #define NFP_NET_RSS_IPV6_TCP            5
  89 #define NFP_NET_RSS_IPV6_EX_TCP         6
  90 #define NFP_NET_RSS_IPV4_UDP            7
  91 #define NFP_NET_RSS_IPV6_UDP            8
  92 #define NFP_NET_RSS_IPV6_EX_UDP         9
  93
  94 /**
  95  * Ring counts
  96  * %NFP_NET_TXR_MAX:         Maximum number of TX rings
  97  * %NFP_NET_RXR_MAX:         Maximum number of RX rings
  98  */
  99 #define NFP_NET_TXR_MAX                 64
 100 #define NFP_NET_RXR_MAX                 64
 101
 102 /**
 103  * Read/Write config words (0x0000 - 0x002c)
 104  * %NFP_NET_CFG_CTRL:        Global control
 105  * %NFP_NET_CFG_UPDATE:      Indicate which fields are updated
 106  * %NFP_NET_CFG_TXRS_ENABLE: Bitmask of enabled TX rings
 107  * %NFP_NET_CFG_RXRS_ENABLE: Bitmask of enabled RX rings
 108  * %NFP_NET_CFG_MTU:         Set MTU size
 109  * %NFP_NET_CFG_FLBUFSZ:     Set freelist buffer size (must be larger than MTU)
 110  * %NFP_NET_CFG_EXN:         MSI-X table entry for exceptions
 111  * %NFP_NET_CFG_LSC:         MSI-X table entry for link state changes
 112  * %NFP_NET_CFG_MACADDR:     MAC address
 113  *
 114  * TODO:
 115  * - define Error details in UPDATE
 116  */
 117 #define NFP_NET_CFG_CTRL                0x0000
 118 #define   NFP_NET_CFG_CTRL_ENABLE         (0x1 <<  0) /* Global enable */
 119 #define   NFP_NET_CFG_CTRL_PROMISC        (0x1 <<  1) /* Enable Promisc mode */
 120 #define   NFP_NET_CFG_CTRL_L2BC           (0x1 <<  2) /* Allow L2 Broadcast */
 121 #define   NFP_NET_CFG_CTRL_L2MC           (0x1 <<  3) /* Allow L2 Multicast */
 122 #define   NFP_NET_CFG_CTRL_RXCSUM         (0x1 <<  4) /* Enable RX Checksum */
 123 #define   NFP_NET_CFG_CTRL_TXCSUM         (0x1 <<  5) /* Enable TX Checksum */
 124 #define   NFP_NET_CFG_CTRL_RXVLAN         (0x1 <<  6) /* Enable VLAN strip */
 125 #define   NFP_NET_CFG_CTRL_TXVLAN         (0x1 <<  7) /* Enable VLAN insert */
 126 #define   NFP_NET_CFG_CTRL_SCATTER        (0x1 <<  8) /* Scatter DMA */
 127 #define   NFP_NET_CFG_CTRL_GATHER         (0x1 <<  9) /* Gather DMA */
 128 #define   NFP_NET_CFG_CTRL_LSO            (0x1 << 10) /* LSO/TSO (version 1) */
 129 #define   NFP_NET_CFG_CTRL_CTAG_FILTER    (0x1 << 11) /* VLAN CTAG filtering */
 130 #define   NFP_NET_CFG_CTRL_RINGCFG        (0x1 << 16) /* Ring runtime changes */
 131 #define   NFP_NET_CFG_CTRL_RSS            (0x1 << 17) /* RSS (version 1) */
 132 #define   NFP_NET_CFG_CTRL_IRQMOD         (0x1 << 18) /* Interrupt moderation */
 133 #define   NFP_NET_CFG_CTRL_RINGPRIO       (0x1 << 19) /* Ring priorities */
 134 #define   NFP_NET_CFG_CTRL_MSIXAUTO       (0x1 << 20) /* MSI-X auto-masking */
 135 #define   NFP_NET_CFG_CTRL_TXRWB          (0x1 << 21) /* Write-back of TX ring*/
 136 #define   NFP_NET_CFG_CTRL_L2SWITCH       (0x1 << 22) /* L2 Switch */
 137 #define   NFP_NET_CFG_CTRL_L2SWITCH_LOCAL (0x1 << 23) /* Switch to local */
 138 #define   NFP_NET_CFG_CTRL_VXLAN          (0x1 << 24) /* VXLAN tunnel support */
 139 #define   NFP_NET_CFG_CTRL_NVGRE          (0x1 << 25) /* NVGRE tunnel support */
 140 #define   NFP_NET_CFG_CTRL_BPF            (0x1 << 27) /* BPF offload capable */
 141 #define   NFP_NET_CFG_CTRL_LSO2           (0x1 << 28) /* LSO/TSO (version 2) */
 142 #define   NFP_NET_CFG_CTRL_RSS2           (0x1 << 29) /* RSS (version 2) */
 143 #define   NFP_NET_CFG_CTRL_CSUM_COMPLETE  (0x1 << 30) /* Checksum complete */
 144 #define   NFP_NET_CFG_CTRL_LIVE_ADDR      (0x1 << 31) /* live MAC addr change */
 145
 146 #define NFP_NET_CFG_CTRL_LSO_ANY        (NFP_NET_CFG_CTRL_LSO | \
 147                                          NFP_NET_CFG_CTRL_LSO2)
 148 #define NFP_NET_CFG_CTRL_RSS_ANY        (NFP_NET_CFG_CTRL_RSS | \
 149                                          NFP_NET_CFG_CTRL_RSS2)
 150 #define NFP_NET_CFG_CTRL_RXCSUM_ANY     (NFP_NET_CFG_CTRL_RXCSUM | \
 151                                          NFP_NET_CFG_CTRL_CSUM_COMPLETE)
 152 #define NFP_NET_CFG_CTRL_CHAIN_META     (NFP_NET_CFG_CTRL_RSS2 | \
 153                                          NFP_NET_CFG_CTRL_CSUM_COMPLETE)
 154
 155 #define NFP_NET_CFG_UPDATE              0x0004
 156 #define   NFP_NET_CFG_UPDATE_GEN          (0x1 <<  0) /* General update */
 157 #define   NFP_NET_CFG_UPDATE_RING         (0x1 <<  1) /* Ring config change */
 158 #define   NFP_NET_CFG_UPDATE_RSS          (0x1 <<  2) /* RSS config change */
 159 #define   NFP_NET_CFG_UPDATE_TXRPRIO      (0x1 <<  3) /* TX Ring prio change */
 160 #define   NFP_NET_CFG_UPDATE_RXRPRIO      (0x1 <<  4) /* RX Ring prio change */
 161 #define   NFP_NET_CFG_UPDATE_MSIX         (0x1 <<  5) /* MSI-X change */
 162 #define   NFP_NET_CFG_UPDATE_L2SWITCH     (0x1 <<  6) /* Switch changes */
 163 #define   NFP_NET_CFG_UPDATE_RESET        (0x1 <<  7) /* Update due to FLR */
 164 #define   NFP_NET_CFG_UPDATE_IRQMOD       (0x1 <<  8) /* IRQ mod change */
 165 #define   NFP_NET_CFG_UPDATE_VXLAN        (0x1 <<  9) /* VXLAN port change */
 166 #define   NFP_NET_CFG_UPDATE_BPF          (0x1 << 10) /* BPF program load */
 167 #define   NFP_NET_CFG_UPDATE_MACADDR      (0x1 << 11) /* MAC address change */
 168 #define   NFP_NET_CFG_UPDATE_MBOX         (0x1 << 12) /* Mailbox update */
 169 #define   NFP_NET_CFG_UPDATE_VF           (0x1 << 13) /* VF settings change */
 170 #define   NFP_NET_CFG_UPDATE_ERR          (0x1 << 31) /* A error occurred */
 171 #define NFP_NET_CFG_TXRS_ENABLE         0x0008
 172 #define NFP_NET_CFG_RXRS_ENABLE         0x0010
 173 #define NFP_NET_CFG_MTU                 0x0018
 174 #define NFP_NET_CFG_FLBUFSZ             0x001c
 175 #define NFP_NET_CFG_EXN                 0x001f
 176 #define NFP_NET_CFG_LSC                 0x0020
 177 #define NFP_NET_CFG_MACADDR             0x0024
 178
 179 /**
 180  * Read-only words (0x0030 - 0x0050):
 181  * %NFP_NET_CFG_VERSION:     Firmware version number
 182  * %NFP_NET_CFG_STS:         Status
 183  * %NFP_NET_CFG_CAP:         Capabilities (same bits as %NFP_NET_CFG_CTRL)
 184  * %NFP_NET_CFG_MAX_TXRINGS: Maximum number of TX rings
 185  * %NFP_NET_CFG_MAX_RXRINGS: Maximum number of RX rings
 186  * %NFP_NET_CFG_MAX_MTU:     Maximum support MTU
 187  * %NFP_NET_CFG_START_TXQ:   Start Queue Control Queue to use for TX (PF only)
 188  * %NFP_NET_CFG_START_RXQ:   Start Queue Control Queue to use for RX (PF only)
 189  *
 190  * TODO:
 191  * - define more STS bits
 192  */
 193 #define NFP_NET_CFG_VERSION             0x0030
 194 #define   NFP_NET_CFG_VERSION_RESERVED_MASK     (0xff << 24)
 195 #define   NFP_NET_CFG_VERSION_CLASS_MASK  (0xff << 16)
 196 #define   NFP_NET_CFG_VERSION_CLASS(x)    (((x) & 0xff) << 16)
 197 #define   NFP_NET_CFG_VERSION_CLASS_GENERIC     0
 198 #define   NFP_NET_CFG_VERSION_MAJOR_MASK  (0xff <<  8)
 199 #define   NFP_NET_CFG_VERSION_MAJOR(x)    (((x) & 0xff) <<  8)
 200 #define   NFP_NET_CFG_VERSION_MINOR_MASK  (0xff <<  0)
 201 #define   NFP_NET_CFG_VERSION_MINOR(x)    (((x) & 0xff) <<  0)
 202 #define NFP_NET_CFG_STS                 0x0034
 203 #define   NFP_NET_CFG_STS_LINK            (0x1 << 0) /* Link up or down */
 204 /* Link rate */
 205 #define   NFP_NET_CFG_STS_LINK_RATE_SHIFT 1
 206 #define   NFP_NET_CFG_STS_LINK_RATE_MASK  0xF
 207 #define   NFP_NET_CFG_STS_LINK_RATE       \
 208         (NFP_NET_CFG_STS_LINK_RATE_MASK << NFP_NET_CFG_STS_LINK_RATE_SHIFT)
 209 #define   NFP_NET_CFG_STS_LINK_RATE_UNSUPPORTED   0
 210 #define   NFP_NET_CFG_STS_LINK_RATE_UNKNOWN       1
 211 #define   NFP_NET_CFG_STS_LINK_RATE_1G            2
 212 #define   NFP_NET_CFG_STS_LINK_RATE_10G           3
 213 #define   NFP_NET_CFG_STS_LINK_RATE_25G           4
 214 #define   NFP_NET_CFG_STS_LINK_RATE_40G           5
 215 #define   NFP_NET_CFG_STS_LINK_RATE_50G           6
 216 #define   NFP_NET_CFG_STS_LINK_RATE_100G          7
 217 #define NFP_NET_CFG_CAP                 0x0038
 218 #define NFP_NET_CFG_MAX_TXRINGS         0x003c
 219 #define NFP_NET_CFG_MAX_RXRINGS         0x0040
 220 #define NFP_NET_CFG_MAX_MTU             0x0044
 221 /* Next two words are being used by VFs for solving THB350 issue */
 222 #define NFP_NET_CFG_START_TXQ           0x0048
 223 #define NFP_NET_CFG_START_RXQ           0x004c
 224
 225 /**
 226  * Prepend configuration
 227  */
 228 #define NFP_NET_CFG_RX_OFFSET           0x0050
 229 #define NFP_NET_CFG_RX_OFFSET_DYNAMIC           0       /* Prepend mode */
 230
 231 /**
 232  * RSS capabilities
 233  * %NFP_NET_CFG_RSS_CAP_HFUNC:  supported hash functions (same bits as
 234  *                              %NFP_NET_CFG_RSS_HFUNC)
 235  */
 236 #define NFP_NET_CFG_RSS_CAP             0x0054
 237 #define   NFP_NET_CFG_RSS_CAP_HFUNC       0xff000000
 238
 239 /**
 240  * TLV area start
 241  * %NFP_NET_CFG_TLV_BASE:       start anchor of the TLV area
 242  */
 243 #define NFP_NET_CFG_TLV_BASE            0x0058
 244
 245 /**
 246  * VXLAN/UDP encap configuration
 247  * %NFP_NET_CFG_VXLAN_PORT:     Base address of table of tunnels' UDP dst ports
 248  * %NFP_NET_CFG_VXLAN_SZ:       Size of the UDP port table in bytes
 249  */
 250 #define NFP_NET_CFG_VXLAN_PORT          0x0060
 251 #define NFP_NET_CFG_VXLAN_SZ              0x0008
 252
 253 /**
 254  * BPF section
 255  * %NFP_NET_CFG_BPF_ABI:        BPF ABI version
 256  * %NFP_NET_CFG_BPF_CAP:        BPF capabilities
 257  * %NFP_NET_CFG_BPF_MAX_LEN:    Maximum size of JITed BPF code in bytes
 258  * %NFP_NET_CFG_BPF_START:      Offset at which BPF will be loaded
 259  * %NFP_NET_CFG_BPF_DONE:       Offset to jump to on exit
 260  * %NFP_NET_CFG_BPF_STACK_SZ:   Total size of stack area in 64B chunks
 261  * %NFP_NET_CFG_BPF_INL_MTU:    Packet data split offset in 64B chunks
 262  * %NFP_NET_CFG_BPF_SIZE:       Size of the JITed BPF code in instructions
 263  * %NFP_NET_CFG_BPF_ADDR:       DMA address of the buffer with JITed BPF code
 264  */
 265 #define NFP_NET_CFG_BPF_ABI             0x0080
 266 #define   NFP_NET_BPF_ABI               2
 267 #define NFP_NET_CFG_BPF_CAP             0x0081
 268 #define   NFP_NET_BPF_CAP_RELO          (1 << 0) /* seamless reload */
 269 #define NFP_NET_CFG_BPF_MAX_LEN         0x0082
 270 #define NFP_NET_CFG_BPF_START           0x0084
 271 #define NFP_NET_CFG_BPF_DONE            0x0086
 272 #define NFP_NET_CFG_BPF_STACK_SZ        0x0088
 273 #define NFP_NET_CFG_BPF_INL_MTU         0x0089
 274 #define NFP_NET_CFG_BPF_SIZE            0x008e
 275 #define NFP_NET_CFG_BPF_ADDR            0x0090
 276 #define   NFP_NET_CFG_BPF_CFG_8CTX      (1 << 0) /* 8ctx mode */
 277 #define   NFP_NET_CFG_BPF_CFG_MASK      7ULL
 278 #define   NFP_NET_CFG_BPF_ADDR_MASK     (~NFP_NET_CFG_BPF_CFG_MASK)
 279
 280 /**
 281  * 40B reserved for future use (0x0098 - 0x00c0)
 282  */
 283 #define NFP_NET_CFG_RESERVED            0x0098
 284 #define NFP_NET_CFG_RESERVED_SZ         0x0028
 285
 286 /**
 287  * RSS configuration (0x0100 - 0x01ac):
 288  * Used only when NFP_NET_CFG_CTRL_RSS is enabled
 289  * %NFP_NET_CFG_RSS_CFG:     RSS configuration word
 290  * %NFP_NET_CFG_RSS_KEY:     RSS "secret" key
 291  * %NFP_NET_CFG_RSS_ITBL:    RSS indirection table
 292  */
 293 #define NFP_NET_CFG_RSS_BASE            0x0100
 294 #define NFP_NET_CFG_RSS_CTRL            NFP_NET_CFG_RSS_BASE
 295 #define   NFP_NET_CFG_RSS_MASK            (0x7f)
 296 #define   NFP_NET_CFG_RSS_MASK_of(_x)     ((_x) & 0x7f)
 297 #define   NFP_NET_CFG_RSS_IPV4            (1 <<  8) /* RSS for IPv4 */
 298 #define   NFP_NET_CFG_RSS_IPV6            (1 <<  9) /* RSS for IPv6 */
 299 #define   NFP_NET_CFG_RSS_IPV4_TCP        (1 << 10) /* RSS for IPv4/TCP */
 300 #define   NFP_NET_CFG_RSS_IPV4_UDP        (1 << 11) /* RSS for IPv4/UDP */
 301 #define   NFP_NET_CFG_RSS_IPV6_TCP        (1 << 12) /* RSS for IPv6/TCP */
 302 #define   NFP_NET_CFG_RSS_IPV6_UDP        (1 << 13) /* RSS for IPv6/UDP */
 303 #define   NFP_NET_CFG_RSS_HFUNC           0xff000000
 304 #define   NFP_NET_CFG_RSS_TOEPLITZ        (1 << 24) /* Use Toeplitz hash */
 305 #define   NFP_NET_CFG_RSS_XOR             (1 << 25) /* Use XOR as hash */
 306 #define   NFP_NET_CFG_RSS_CRC32           (1 << 26) /* Use CRC32 as hash */
 307 #define   NFP_NET_CFG_RSS_HFUNCS          3
 308 #define NFP_NET_CFG_RSS_KEY             (NFP_NET_CFG_RSS_BASE + 0x4)
 309 #define NFP_NET_CFG_RSS_KEY_SZ          0x28
 310 #define NFP_NET_CFG_RSS_ITBL            (NFP_NET_CFG_RSS_BASE + 0x4 + \
 311                                          NFP_NET_CFG_RSS_KEY_SZ)
 312 #define NFP_NET_CFG_RSS_ITBL_SZ         0x80
 313
 314 /**
 315  * TX ring configuration (0x200 - 0x800)
 316  * %NFP_NET_CFG_TXR_BASE:    Base offset for TX ring configuration
 317  * %NFP_NET_CFG_TXR_ADDR:    Per TX ring DMA address (8B entries)
 318  * %NFP_NET_CFG_TXR_WB_ADDR: Per TX ring write back DMA address (8B entries)
 319  * %NFP_NET_CFG_TXR_SZ:      Per TX ring ring size (1B entries)
 320  * %NFP_NET_CFG_TXR_VEC:     Per TX ring MSI-X table entry (1B entries)
 321  * %NFP_NET_CFG_TXR_PRIO:    Per TX ring priority (1B entries)
 322  * %NFP_NET_CFG_TXR_IRQ_MOD: Per TX ring interrupt moderation packet
 323  */
 324 #define NFP_NET_CFG_TXR_BASE            0x0200
 325 #define NFP_NET_CFG_TXR_ADDR(_x)        (NFP_NET_CFG_TXR_BASE + ((_x) * 0x8))
 326 #define NFP_NET_CFG_TXR_WB_ADDR(_x)     (NFP_NET_CFG_TXR_BASE + 0x200 + \
 327                                          ((_x) * 0x8))
 328 #define NFP_NET_CFG_TXR_SZ(_x)          (NFP_NET_CFG_TXR_BASE + 0x400 + (_x))
 329 #define NFP_NET_CFG_TXR_VEC(_x)         (NFP_NET_CFG_TXR_BASE + 0x440 + (_x))
 330 #define NFP_NET_CFG_TXR_PRIO(_x)        (NFP_NET_CFG_TXR_BASE + 0x480 + (_x))
 331 #define NFP_NET_CFG_TXR_IRQ_MOD(_x)     (NFP_NET_CFG_TXR_BASE + 0x500 + \
 332                                          ((_x) * 0x4))
 333
 334 /**
 335  * RX ring configuration (0x0800 - 0x0c00)
 336  * %NFP_NET_CFG_RXR_BASE:    Base offset for RX ring configuration
 337  * %NFP_NET_CFG_RXR_ADDR:    Per RX ring DMA address (8B entries)
 338  * %NFP_NET_CFG_RXR_SZ:      Per RX ring ring size (1B entries)
 339  * %NFP_NET_CFG_RXR_VEC:     Per RX ring MSI-X table entry (1B entries)
 340  * %NFP_NET_CFG_RXR_PRIO:    Per RX ring priority (1B entries)
 341  * %NFP_NET_CFG_RXR_IRQ_MOD: Per RX ring interrupt moderation (4B entries)
 342  */
 343 #define NFP_NET_CFG_RXR_BASE            0x0800
 344 #define NFP_NET_CFG_RXR_ADDR(_x)        (NFP_NET_CFG_RXR_BASE + ((_x) * 0x8))
 345 #define NFP_NET_CFG_RXR_SZ(_x)          (NFP_NET_CFG_RXR_BASE + 0x200 + (_x))
 346 #define NFP_NET_CFG_RXR_VEC(_x)         (NFP_NET_CFG_RXR_BASE + 0x240 + (_x))
 347 #define NFP_NET_CFG_RXR_PRIO(_x)        (NFP_NET_CFG_RXR_BASE + 0x280 + (_x))
 348 #define NFP_NET_CFG_RXR_IRQ_MOD(_x)     (NFP_NET_CFG_RXR_BASE + 0x300 + \
 349                                          ((_x) * 0x4))
 350
 351 /**
 352  * Interrupt Control/Cause registers (0x0c00 - 0x0d00)
 353  * These registers are only used when MSI-X auto-masking is not
 354  * enabled (%NFP_NET_CFG_CTRL_MSIXAUTO not set).  The array is index
 355  * by MSI-X entry and are 1B in size.  If an entry is zero, the
 356  * corresponding entry is enabled.  If the FW generates an interrupt,
 357  * it writes a cause into the corresponding field.  This also masks
 358  * the MSI-X entry and the host driver must clear the register to
 359  * re-enable the interrupt.
 360  */
 361 #define NFP_NET_CFG_ICR_BASE            0x0c00
 362 #define NFP_NET_CFG_ICR(_x)             (NFP_NET_CFG_ICR_BASE + (_x))
 363 #define   NFP_NET_CFG_ICR_UNMASKED      0x0
 364 #define   NFP_NET_CFG_ICR_RXTX          0x1
 365 #define   NFP_NET_CFG_ICR_LSC           0x2
 366
 367 /**
 368  * General device stats (0x0d00 - 0x0d90)
 369  * all counters are 64bit.
 370  */
 371 #define NFP_NET_CFG_STATS_BASE          0x0d00
 372 #define NFP_NET_CFG_STATS_RX_DISCARDS   (NFP_NET_CFG_STATS_BASE + 0x00)
 373 #define NFP_NET_CFG_STATS_RX_ERRORS     (NFP_NET_CFG_STATS_BASE + 0x08)
 374 #define NFP_NET_CFG_STATS_RX_OCTETS     (NFP_NET_CFG_STATS_BASE + 0x10)
 375 #define NFP_NET_CFG_STATS_RX_UC_OCTETS  (NFP_NET_CFG_STATS_BASE + 0x18)
 376 #define NFP_NET_CFG_STATS_RX_MC_OCTETS  (NFP_NET_CFG_STATS_BASE + 0x20)
 377 #define NFP_NET_CFG_STATS_RX_BC_OCTETS  (NFP_NET_CFG_STATS_BASE + 0x28)
 378 #define NFP_NET_CFG_STATS_RX_FRAMES     (NFP_NET_CFG_STATS_BASE + 0x30)
 379 #define NFP_NET_CFG_STATS_RX_MC_FRAMES  (NFP_NET_CFG_STATS_BASE + 0x38)
 380 #define NFP_NET_CFG_STATS_RX_BC_FRAMES  (NFP_NET_CFG_STATS_BASE + 0x40)
 381
 382 #define NFP_NET_CFG_STATS_TX_DISCARDS   (NFP_NET_CFG_STATS_BASE + 0x48)
 383 #define NFP_NET_CFG_STATS_TX_ERRORS     (NFP_NET_CFG_STATS_BASE + 0x50)
 384 #define NFP_NET_CFG_STATS_TX_OCTETS     (NFP_NET_CFG_STATS_BASE + 0x58)
 385 #define NFP_NET_CFG_STATS_TX_UC_OCTETS  (NFP_NET_CFG_STATS_BASE + 0x60)
 386 #define NFP_NET_CFG_STATS_TX_MC_OCTETS  (NFP_NET_CFG_STATS_BASE + 0x68)
 387 #define NFP_NET_CFG_STATS_TX_BC_OCTETS  (NFP_NET_CFG_STATS_BASE + 0x70)
 388 #define NFP_NET_CFG_STATS_TX_FRAMES     (NFP_NET_CFG_STATS_BASE + 0x78)
 389 #define NFP_NET_CFG_STATS_TX_MC_FRAMES  (NFP_NET_CFG_STATS_BASE + 0x80)
 390 #define NFP_NET_CFG_STATS_TX_BC_FRAMES  (NFP_NET_CFG_STATS_BASE + 0x88)
 391
 392 #define NFP_NET_CFG_STATS_APP0_FRAMES   (NFP_NET_CFG_STATS_BASE + 0x90)
 393 #define NFP_NET_CFG_STATS_APP0_BYTES    (NFP_NET_CFG_STATS_BASE + 0x98)
 394 #define NFP_NET_CFG_STATS_APP1_FRAMES   (NFP_NET_CFG_STATS_BASE + 0xa0)
 395 #define NFP_NET_CFG_STATS_APP1_BYTES    (NFP_NET_CFG_STATS_BASE + 0xa8)
 396 #define NFP_NET_CFG_STATS_APP2_FRAMES   (NFP_NET_CFG_STATS_BASE + 0xb0)
 397 #define NFP_NET_CFG_STATS_APP2_BYTES    (NFP_NET_CFG_STATS_BASE + 0xb8)
 398 #define NFP_NET_CFG_STATS_APP3_FRAMES   (NFP_NET_CFG_STATS_BASE + 0xc0)
 399 #define NFP_NET_CFG_STATS_APP3_BYTES    (NFP_NET_CFG_STATS_BASE + 0xc8)
 400
 401 /**
 402  * Per ring stats (0x1000 - 0x1800)
 403  * options, 64bit per entry
 404  * %NFP_NET_CFG_TXR_STATS:   TX ring statistics (Packet and Byte count)
 405  * %NFP_NET_CFG_RXR_STATS:   RX ring statistics (Packet and Byte count)
 406  */
 407 #define NFP_NET_CFG_TXR_STATS_BASE      0x1000
 408 #define NFP_NET_CFG_TXR_STATS(_x)       (NFP_NET_CFG_TXR_STATS_BASE + \
 409                                          ((_x) * 0x10))
 410 #define NFP_NET_CFG_RXR_STATS_BASE      0x1400
 411 #define NFP_NET_CFG_RXR_STATS(_x)       (NFP_NET_CFG_RXR_STATS_BASE + \
 412                                          ((_x) * 0x10))
 413
 414 /**
 415  * General use mailbox area (0x1800 - 0x19ff)
 416  * 4B used for update command and 4B return code
 417  * followed by a max of 504B of variable length value
 418  */
 419 #define NFP_NET_CFG_MBOX_BASE           0x1800
 420 #define NFP_NET_CFG_MBOX_VAL_MAX_SZ     0x1F8
 421
 422 #define NFP_NET_CFG_MBOX_SIMPLE_CMD     0x0
 423 #define NFP_NET_CFG_MBOX_SIMPLE_RET     0x4
 424 #define NFP_NET_CFG_MBOX_SIMPLE_VAL     0x8
 425 #define NFP_NET_CFG_MBOX_SIMPLE_LEN     0x12
 426
 427 #define NFP_NET_CFG_MBOX_CMD_CTAG_FILTER_ADD 1
 428 #define NFP_NET_CFG_MBOX_CMD_CTAG_FILTER_KILL 2
 429
 430 /**
 431  * VLAN filtering using general use mailbox
 432  * %NFP_NET_CFG_VLAN_FILTER:            Base address of VLAN filter mailbox
 433  * %NFP_NET_CFG_VLAN_FILTER_VID:        VLAN ID to filter
 434  * %NFP_NET_CFG_VLAN_FILTER_PROTO:      VLAN proto to filter
 435  * %NFP_NET_CFG_VXLAN_SZ:               Size of the VLAN filter mailbox in bytes
 436  */
 437 #define NFP_NET_CFG_VLAN_FILTER         NFP_NET_CFG_MBOX_SIMPLE_VAL
 438 #define  NFP_NET_CFG_VLAN_FILTER_VID    NFP_NET_CFG_VLAN_FILTER
 439 #define  NFP_NET_CFG_VLAN_FILTER_PROTO   (NFP_NET_CFG_VLAN_FILTER + 2)
 440 #define NFP_NET_CFG_VLAN_FILTER_SZ       0x0004
 441
 442 /**
 443  * TLV capabilities
 444  * %NFP_NET_CFG_TLV_TYPE:       Offset of type within the TLV
 445  * %NFP_NET_CFG_TLV_TYPE_REQUIRED: Driver must be able to parse the TLV
 446  * %NFP_NET_CFG_TLV_LENGTH:     Offset of length within the TLV
 447  * %NFP_NET_CFG_TLV_LENGTH_INC: TLV length increments
 448  * %NFP_NET_CFG_TLV_VALUE:      Offset of value with the TLV
 449  *
 450  * List of simple TLV structures, first one starts at %NFP_NET_CFG_TLV_BASE.
 451  * Last structure must be of type %NFP_NET_CFG_TLV_TYPE_END.  Presence of TLVs
 452  * is indicated by %NFP_NET_CFG_TLV_BASE being non-zero.  TLV structures may
 453  * fill the entire remainder of the BAR or be shorter.  FW must make sure TLVs
 454  * don't conflict with other features which allocate space beyond
 455  * %NFP_NET_CFG_TLV_BASE.  %NFP_NET_CFG_TLV_TYPE_RESERVED should be used to wrap
 456  * space used by such features.
 457  * Note that the 4 byte TLV header is not counted in %NFP_NET_CFG_TLV_LENGTH.
 458  */
 459 #define NFP_NET_CFG_TLV_TYPE            0x00
 460 #define   NFP_NET_CFG_TLV_TYPE_REQUIRED   0x8000
 461 #define NFP_NET_CFG_TLV_LENGTH          0x02
 462 #define   NFP_NET_CFG_TLV_LENGTH_INC      4
 463 #define NFP_NET_CFG_TLV_VALUE           0x04
 464
 465 #define NFP_NET_CFG_TLV_HEADER_REQUIRED 0x80000000
 466 #define NFP_NET_CFG_TLV_HEADER_TYPE     0x7fff0000
 467 #define NFP_NET_CFG_TLV_HEADER_LENGTH   0x0000ffff
 468
 469 /**
 470  * Capability TLV types
 471  *
 472  * %NFP_NET_CFG_TLV_TYPE_UNKNOWN:
 473  * Special TLV type to catch bugs, should never be encountered.  Drivers should
 474  * treat encountering this type as error and refuse to probe.
 475  *
 476  * %NFP_NET_CFG_TLV_TYPE_RESERVED:
 477  * Reserved space, may contain legacy fixed-offset fields, or be used for
 478  * padding.  The use of this type should be otherwise avoided.
 479  *
 480  * %NFP_NET_CFG_TLV_TYPE_END:
 481  * Empty, end of TLV list.  Must be the last TLV.  Drivers will stop processing
 482  * further TLVs when encountered.
 483  *
 484  * %NFP_NET_CFG_TLV_TYPE_ME_FREQ:
 485  * Single word, ME frequency in MHz as used in calculation for
 486  * %NFP_NET_CFG_RXR_IRQ_MOD and %NFP_NET_CFG_TXR_IRQ_MOD.
 487  *
 488  * %NFP_NET_CFG_TLV_TYPE_MBOX:
 489  * Variable, mailbox area.  Overwrites the default location which is
 490  * %NFP_NET_CFG_MBOX_BASE and length %NFP_NET_CFG_MBOX_VAL_MAX_SZ.
 491  */
 492 #define NFP_NET_CFG_TLV_TYPE_UNKNOWN            0
 493 #define NFP_NET_CFG_TLV_TYPE_RESERVED           1
 494 #define NFP_NET_CFG_TLV_TYPE_END                2
 495 #define NFP_NET_CFG_TLV_TYPE_ME_FREQ            3
 496 #define NFP_NET_CFG_TLV_TYPE_MBOX               4
 497
 498 struct device;
 499
 500 /**
 501  * struct nfp_net_tlv_caps - parsed control BAR TLV capabilities
 502  * @me_freq_mhz:        ME clock_freq (MHz)
 503  * @mbox_off:           vNIC mailbox area offset
 504  * @mbox_len:           vNIC mailbox area length
 505  */
 506 struct nfp_net_tlv_caps {
 507         u32 me_freq_mhz;
 508         unsigned int mbox_off;
 509         unsigned int mbox_len;
 510 };
 511
 512 int nfp_net_tlv_caps_parse(struct device *dev, u8 __iomem *ctrl_mem,
 513                            struct nfp_net_tlv_caps *caps);
 514
 515 static inline bool nfp_net_has_mbox(struct nfp_net_tlv_caps *caps)
 516 {
 517         return caps->mbox_len >= NFP_NET_CFG_MBOX_SIMPLE_LEN;
 518 }
 519
 520 #endif /* _NFP_NET_CTRL_H_ */