drivers/net/sfc/base/ef10_tlv_layout.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  *
   3  * Copyright (c) 2012-2018 Solarflare Communications Inc.
   4  * All rights reserved.
   5  */
   6
   7 /* These structures define the layouts for the TLV items stored in static and
   8  * dynamic configuration partitions in NVRAM for EF10 (Huntington etc.).
   9  *
  10  * They contain the same sort of information that was kept in the
  11  * siena_mc_static_config_hdr_t and siena_mc_dynamic_config_hdr_t structures
  12  * (defined in <ci/mgmt/mc_flash_layout.h> and <ci/mgmt/mc_dynamic_cfg.h>) for
  13  * Siena.
  14  *
  15  * These are used directly by the MC and should also be usable directly on host
  16  * systems which are little-endian and do not do strange things with structure
  17  * padding.  (Big-endian host systems will require some byte-swapping.)
  18  *
  19  *                                    -----
  20  *
  21  * Please refer to SF-108797-SW for a general overview of the TLV partition
  22  * format.
  23  *
  24  *                                    -----
  25  *
  26  * The current tag IDs have a general structure: with the exception of the
  27  * special values defined in the document, they are of the form 0xLTTTNNNN,
  28  * where:
  29  *
  30  *   -  L is a location, indicating where this tag is expected to be found:
  31  *        0: static configuration
  32  *        1: dynamic configuration
  33  *        2: firmware internal use
  34  *        3: license partition
  35  *
  36  *   -  TTT is a type, which is just a unique value.  The same type value
  37  *      might appear in both locations, indicating a relationship between
  38  *      the items (e.g. static and dynamic VPD below).
  39  *
  40  *   -  NNNN is an index of some form.  Some item types are per-port, some
  41  *      are per-PF, some are per-partition-type.
  42  *
  43  *                                    -----
  44  *
  45  * As with the previous Siena structures, each structure here is laid out
  46  * carefully: values are aligned to their natural boundary, with explicit
  47  * padding fields added where necessary.  (No, technically this does not
  48  * absolutely guarantee portability.  But, in practice, compilers are generally
  49  * sensible enough not to introduce completely pointless padding, and it works
  50  * well enough.)
  51  */
  52
  53
  54 #ifndef CI_MGMT_TLV_LAYOUT_H
  55 #define CI_MGMT_TLV_LAYOUT_H
  56
  57
  58 /* ----------------------------------------------------------------------------
  59  *  General structure (defined by SF-108797-SW)
  60  * ----------------------------------------------------------------------------
  61  */
  62
  63
  64 /* The "end" tag.
  65  *
  66  * (Note that this is *not* followed by length or value fields: anything after
  67  * the tag itself is irrelevant.)
  68  */
  69
  70 #define TLV_TAG_END                     (0xEEEEEEEE)
  71
  72
  73 /* Other special reserved tag values.
  74  */
  75
  76 #define TLV_TAG_SKIP                    (0x00000000)
  77 #define TLV_TAG_INVALID                 (0xFFFFFFFF)
  78
  79
  80 /* TLV partition header.
  81  *
  82  * In a TLV partition, this must be the first item in the sequence, at offset
  83  * 0.
  84  */
  85
  86 #define TLV_TAG_PARTITION_HEADER        (0xEF10DA7A)
  87
  88 struct tlv_partition_header {
  89   uint32_t tag;
  90   uint32_t length;
  91   uint16_t type_id;
  92 /* 0 indicates the default segment (always located at offset 0), while other values
  93  * are for RFID-selectable presets that should immediately follow the default segment.
  94  * The default segment may also have preset > 0, which means that it is a preset
  95  * selected through an RFID command and copied by FW to the location at offset 0. */
  96   uint16_t preset;
  97   uint32_t generation;
  98   uint32_t total_length;
  99 };
 100
 101
 102 /* TLV partition trailer.
 103  *
 104  * In a TLV partition, this must be the last item in the sequence, immediately
 105  * preceding the TLV_TAG_END word.
 106  */
 107
 108 #define TLV_TAG_PARTITION_TRAILER       (0xEF101A57)
 109
 110 struct tlv_partition_trailer {
 111   uint32_t tag;
 112   uint32_t length;
 113   uint32_t generation;
 114   uint32_t checksum;
 115 };
 116
 117
 118 /* Appendable TLV partition header.
 119  *
 120  * In an appendable TLV partition, this must be the first item in the sequence,
 121  * at offset 0.  (Note that, unlike the configuration partitions, there is no
 122  * trailer before the TLV_TAG_END word.)
 123  */
 124
 125 #define TLV_TAG_APPENDABLE_PARTITION_HEADER (0xEF10ADA7)
 126
 127 struct tlv_appendable_partition_header {
 128   uint32_t tag;
 129   uint32_t length;
 130   uint16_t type_id;
 131   uint16_t reserved;
 132 };
 133
 134
 135 /* ----------------------------------------------------------------------------
 136  *  Configuration items
 137  * ----------------------------------------------------------------------------
 138  */
 139
 140
 141 /* NIC global capabilities.
 142  */
 143
 144 #define TLV_TAG_GLOBAL_CAPABILITIES     (0x00010000)
 145
 146 struct tlv_global_capabilities {
 147   uint32_t tag;
 148   uint32_t length;
 149   uint32_t flags;
 150 };
 151
 152
 153 /* Siena-style per-port MAC address allocation.
 154  *
 155  * There are <count> addresses, starting at <base_address> and incrementing
 156  * by adding <stride> to the low-order byte(s).
 157  *
 158  * (See also TLV_TAG_GLOBAL_MAC for an alternative, specifying a global pool
 159  * of contiguous MAC addresses for the firmware to allocate as it sees fit.)
 160  */
 161
 162 #define TLV_TAG_PORT_MAC(port)          (0x00020000 + (port))
 163
 164 struct tlv_port_mac {
 165   uint32_t tag;
 166   uint32_t length;
 167   uint8_t  base_address[6];
 168   uint16_t reserved;
 169   uint16_t count;
 170   uint16_t stride;
 171 };
 172
 173
 174 /* Static VPD.
 175  *
 176  * This is the portion of VPD which is set at manufacturing time and not
 177  * expected to change.  It is formatted as a standard PCI VPD block. There are
 178  * global and per-pf TLVs for this, the global TLV is new for Medford and is
 179  * used in preference to the per-pf TLV.
 180  */
 181
 182 #define TLV_TAG_PF_STATIC_VPD(pf)       (0x00030000 + (pf))
 183
 184 struct tlv_pf_static_vpd {
 185   uint32_t tag;
 186   uint32_t length;
 187   uint8_t  bytes[];
 188 };
 189
 190 #define TLV_TAG_GLOBAL_STATIC_VPD       (0x001f0000)
 191
 192 struct tlv_global_static_vpd {
 193   uint32_t tag;
 194   uint32_t length;
 195   uint8_t  bytes[];
 196 };
 197
 198
 199 /* Dynamic VPD.
 200  *
 201  * This is the portion of VPD which may be changed (e.g. by firmware updates).
 202  * It is formatted as a standard PCI VPD block. There are global and per-pf TLVs
 203  * for this, the global TLV is new for Medford and is used in preference to the
 204  * per-pf TLV.
 205  */
 206
 207 #define TLV_TAG_PF_DYNAMIC_VPD(pf)      (0x10030000 + (pf))
 208
 209 struct tlv_pf_dynamic_vpd {
 210   uint32_t tag;
 211   uint32_t length;
 212   uint8_t  bytes[];
 213 };
 214
 215 #define TLV_TAG_GLOBAL_DYNAMIC_VPD      (0x10200000)
 216
 217 struct tlv_global_dynamic_vpd {
 218   uint32_t tag;
 219   uint32_t length;
 220   uint8_t  bytes[];
 221 };
 222
 223
 224 /* "DBI" PCI config space changes.
 225  *
 226  * This is a set of edits made to the default PCI config space values before
 227  * the device is allowed to enumerate. There are global and per-pf TLVs for
 228  * this, the global TLV is new for Medford and is used in preference to the
 229  * per-pf TLV.
 230  */
 231
 232 #define TLV_TAG_PF_DBI(pf)              (0x00040000 + (pf))
 233
 234 struct tlv_pf_dbi {
 235   uint32_t tag;
 236   uint32_t length;
 237   struct {
 238     uint16_t addr;
 239     uint16_t byte_enables;
 240     uint32_t value;
 241   } items[];
 242 };
 243
 244
 245 #define TLV_TAG_GLOBAL_DBI              (0x00210000)
 246
 247 struct tlv_global_dbi {
 248   uint32_t tag;
 249   uint32_t length;
 250   struct {
 251     uint16_t addr;
 252     uint16_t byte_enables;
 253     uint32_t value;
 254   } items[];
 255 };
 256
 257
 258 /* Partition subtype codes.
 259  *
 260  * A subtype may optionally be stored for each type of partition present in
 261  * the NVRAM.  For example, this may be used to allow a generic firmware update
 262  * utility to select a specific variant of firmware for a specific variant of
 263  * board.
 264  *
 265  * The description[] field is an optional string which is returned in the
 266  * MC_CMD_NVRAM_METADATA response if present.
 267  */
 268
 269 #define TLV_TAG_PARTITION_SUBTYPE(type) (0x00050000 + (type))
 270
 271 struct tlv_partition_subtype {
 272   uint32_t tag;
 273   uint32_t length;
 274   uint32_t subtype;
 275   uint8_t  description[];
 276 };
 277
 278
 279 /* Partition version codes.
 280  *
 281  * A version may optionally be stored for each type of partition present in
 282  * the NVRAM.  This provides a standard way of tracking the currently stored
 283  * version of each of the various component images.
 284  */
 285
 286 #define TLV_TAG_PARTITION_VERSION(type) (0x10060000 + (type))
 287
 288 struct tlv_partition_version {
 289   uint32_t tag;
 290   uint32_t length;
 291   uint16_t version_w;
 292   uint16_t version_x;
 293   uint16_t version_y;
 294   uint16_t version_z;
 295 };
 296
 297 /* Global PCIe configuration */
 298
 299 #define TLV_TAG_GLOBAL_PCIE_CONFIG (0x10070000)
 300
 301 struct tlv_pcie_config {
 302   uint32_t tag;
 303   uint32_t length;
 304   int16_t max_pf_number;                        /**< Largest PF RID (lower PFs may be hidden) */
 305   uint16_t pf_aper;                             /**< BIU aperture for PF BAR2 */
 306   uint16_t vf_aper;                             /**< BIU aperture for VF BAR0 */
 307   uint16_t int_aper;                            /**< BIU aperture for PF BAR4 and VF BAR2 */
 308 #define TLV_MAX_PF_DEFAULT (-1)                 /* Use FW default for largest PF RID  */
 309 #define TLV_APER_DEFAULT (0xFFFF)               /* Use FW default for a given aperture */
 310 };
 311
 312 /* Per-PF configuration. Note that not all these fields are necessarily useful
 313  * as the apertures are constrained by the BIU settings (the one case we do
 314  * use is to make BAR2 bigger than the BIU thinks to reserve space), but we can
 315  * tidy things up later */
 316
 317 #define TLV_TAG_PF_PCIE_CONFIG(pf)  (0x10080000 + (pf))
 318
 319 struct tlv_per_pf_pcie_config {
 320   uint32_t tag;
 321   uint32_t length;
 322   uint8_t vfs_total;
 323   uint8_t port_allocation;
 324   uint16_t vectors_per_pf;
 325   uint16_t vectors_per_vf;
 326   uint8_t pf_bar0_aperture;
 327   uint8_t pf_bar2_aperture;
 328   uint8_t vf_bar0_aperture;
 329   uint8_t vf_base;
 330   uint16_t supp_pagesz;
 331   uint16_t msix_vec_base;
 332 };
 333
 334
 335 /* Development ONLY. This is a single TLV tag for all the gubbins
 336  * that can be set through the MC command-line other than the PCIe
 337  * settings. This is a temporary measure. */
 338 #define TLV_TAG_TMP_GUBBINS (0x10090000)        /* legacy symbol - do not use */
 339 #define TLV_TAG_TMP_GUBBINS_HUNT TLV_TAG_TMP_GUBBINS
 340
 341 struct tlv_tmp_gubbins {
 342   uint32_t tag;
 343   uint32_t length;
 344   /* Consumed by dpcpu.c */
 345   uint64_t tx0_tags;     /* Bitmap */
 346   uint64_t tx1_tags;     /* Bitmap */
 347   uint64_t dl_tags;      /* Bitmap */
 348   uint32_t flags;
 349 #define TLV_DPCPU_TX_STRIPE (1) /* No longer used, has no effect */
 350 #define TLV_DPCPU_BIU_TAGS  (2) /* Use BIU tag manager */
 351 #define TLV_DPCPU_TX0_TAGS  (4) /* tx0_tags is valid */
 352 #define TLV_DPCPU_TX1_TAGS  (8) /* tx1_tags is valid */
 353 #define TLV_DPCPU_DL_TAGS  (16) /* dl_tags is valid */
 354   /* Consumed by features.c */
 355   uint32_t dut_features;        /* All 1s -> leave alone */
 356   int8_t with_rmon;             /* 0 -> off, 1 -> on, -1 -> leave alone */
 357   /* Consumed by clocks_hunt.c */
 358   int8_t clk_mode;             /* 0 -> off, 1 -> on, -1 -> leave alone */
 359   /* No longer used, superseded by TLV_TAG_DESCRIPTOR_CACHE_CONFIG. */
 360   int8_t rx_dc_size;           /* -1 -> leave alone */
 361   int8_t tx_dc_size;
 362   int16_t num_q_allocs;
 363 };
 364
 365 /* Global port configuration
 366  *
 367  * This is now deprecated in favour of a platform-provided default
 368  * and dynamic config override via tlv_global_port_options.
 369  */
 370 #define TLV_TAG_GLOBAL_PORT_CONFIG      (0x000a0000)
 371
 372 struct tlv_global_port_config {
 373   uint32_t tag;
 374   uint32_t length;
 375   uint32_t ports_per_core;
 376   uint32_t max_port_speed;
 377 };
 378
 379
 380 /* Firmware options.
 381  *
 382  * This is intended for user-configurable selection of optional firmware
 383  * features and variants.
 384  *
 385  * Initially, this consists only of the satellite CPU firmware variant
 386  * selection, but this tag could be extended in the future (using the
 387  * tag length to determine whether additional fields are present).
 388  */
 389
 390 #define TLV_TAG_FIRMWARE_OPTIONS        (0x100b0000)
 391
 392 struct tlv_firmware_options {
 393   uint32_t tag;
 394   uint32_t length;
 395   uint32_t firmware_variant;
 396 #define TLV_FIRMWARE_VARIANT_DRIVER_SELECTED (0xffffffff)
 397
 398 /* These are the values for overriding the driver's choice; the definitions
 399  * are taken from MCDI so that they don't get out of step.  Include
 400  * <ci/mgmt/mc_driver_pcol.h> or the equivalent from your driver's tree if
 401  * you need to use these constants.
 402  */
 403 #define TLV_FIRMWARE_VARIANT_FULL_FEATURED   MC_CMD_FW_FULL_FEATURED
 404 #define TLV_FIRMWARE_VARIANT_LOW_LATENCY     MC_CMD_FW_LOW_LATENCY
 405 #define TLV_FIRMWARE_VARIANT_PACKED_STREAM   MC_CMD_FW_PACKED_STREAM
 406 #define TLV_FIRMWARE_VARIANT_HIGH_TX_RATE    MC_CMD_FW_HIGH_TX_RATE
 407 #define TLV_FIRMWARE_VARIANT_PACKED_STREAM_HASH_MODE_1 \
 408                                              MC_CMD_FW_PACKED_STREAM_HASH_MODE_1
 409 #define TLV_FIRMWARE_VARIANT_RULES_ENGINE    MC_CMD_FW_RULES_ENGINE
 410 };
 411
 412 /* Voltage settings
 413  *
 414  * Intended for boards with A0 silicon where the core voltage may
 415  * need tweaking. Most likely set once when the pass voltage is
 416  * determined. */
 417
 418 #define TLV_TAG_0V9_SETTINGS (0x000c0000)
 419
 420 struct tlv_0v9_settings {
 421   uint32_t tag;
 422   uint32_t length;
 423   uint16_t flags; /* Boards with high 0v9 settings may need active cooling */
 424 #define TLV_TAG_0V9_REQUIRES_FAN (1)
 425   uint16_t target_voltage; /* In millivolts */
 426   /* Since the limits are meant to be centred to the target (and must at least
 427    * contain it) they need setting as well. */
 428   uint16_t warn_low;       /* In millivolts */
 429   uint16_t warn_high;      /* In millivolts */
 430   uint16_t panic_low;      /* In millivolts */
 431   uint16_t panic_high;     /* In millivolts */
 432 };
 433
 434
 435 /* Clock configuration */
 436
 437 #define TLV_TAG_CLOCK_CONFIG       (0x000d0000) /* legacy symbol - do not use */
 438 #define TLV_TAG_CLOCK_CONFIG_HUNT  TLV_TAG_CLOCK_CONFIG
 439
 440 struct tlv_clock_config {
 441   uint32_t tag;
 442   uint32_t length;
 443   uint16_t clk_sys;        /* MHz */
 444   uint16_t clk_dpcpu;      /* MHz */
 445   uint16_t clk_icore;      /* MHz */
 446   uint16_t clk_pcs;        /* MHz */
 447 };
 448
 449 #define TLV_TAG_CLOCK_CONFIG_MEDFORD      (0x00100000)
 450
 451 struct tlv_clock_config_medford {
 452   uint32_t tag;
 453   uint32_t length;
 454   uint16_t clk_sys;        /* MHz */
 455   uint16_t clk_mc;         /* MHz */
 456   uint16_t clk_rmon;       /* MHz */
 457   uint16_t clk_vswitch;    /* MHz */
 458   uint16_t clk_dpcpu;      /* MHz */
 459   uint16_t clk_pcs;        /* MHz */
 460 };
 461
 462
 463 /* EF10-style global pool of MAC addresses.
 464  *
 465  * There are <count> addresses, starting at <base_address>, which are
 466  * contiguous.  Firmware is responsible for allocating addresses from this
 467  * pool to ports / PFs as appropriate.
 468  */
 469
 470 #define TLV_TAG_GLOBAL_MAC              (0x000e0000)
 471
 472 struct tlv_global_mac {
 473   uint32_t tag;
 474   uint32_t length;
 475   uint8_t  base_address[6];
 476   uint16_t reserved1;
 477   uint16_t count;
 478   uint16_t reserved2;
 479 };
 480
 481 #define TLV_TAG_ATB_0V9_TARGET     (0x000f0000) /* legacy symbol - do not use */
 482 #define TLV_TAG_ATB_0V9_TARGET_HUNT     TLV_TAG_ATB_0V9_TARGET
 483
 484 /* The target value for the 0v9 power rail measured on-chip at the
 485  * analogue test bus */
 486 struct tlv_0v9_atb_target {
 487   uint32_t tag;
 488   uint32_t length;
 489   uint16_t millivolts;
 490   uint16_t reserved;
 491 };
 492
 493 /* Factory settings for amplitude calibration of the PCIE TX serdes */
 494 #define TLV_TAG_TX_PCIE_AMP_CONFIG  (0x00220000)
 495 struct tlv_pcie_tx_amp_config {
 496   uint32_t tag;
 497   uint32_t length;
 498   uint8_t quad_tx_imp2k[4];
 499   uint8_t quad_tx_imp50[4];
 500   uint8_t lane_amp[16];
 501 };
 502
 503
 504 /* Global PCIe configuration, second revision. This represents the visible PFs
 505  * by a bitmap rather than having the number of the highest visible one. As such
 506  * it can (for a 16-PF chip) represent a superset of what TLV_TAG_GLOBAL_PCIE_CONFIG
 507  * can and it should be used in place of that tag in future (but compatibility with
 508  * the old tag will be left in the firmware indefinitely).  */
 509
 510 #define TLV_TAG_GLOBAL_PCIE_CONFIG_R2 (0x10100000)
 511
 512 struct tlv_pcie_config_r2 {
 513   uint32_t tag;
 514   uint32_t length;
 515   uint16_t visible_pfs;                         /**< Bitmap of visible PFs */
 516   uint16_t pf_aper;                             /**< BIU aperture for PF BAR2 */
 517   uint16_t vf_aper;                             /**< BIU aperture for VF BAR0 */
 518   uint16_t int_aper;                            /**< BIU aperture for PF BAR4 and VF BAR2 */
 519 };
 520
 521 /* Dynamic port mode.
 522  *
 523  * Allows selecting alternate port configuration for platforms that support it
 524  * (e.g. 1x40G vs 2x10G on Milano, 1x40G vs 4x10G on Medford). This affects the
 525  * number of externally visible ports (and, hence, PF to port mapping), so must
 526  * be done at boot time.
 527  *
 528  * This tag supercedes tlv_global_port_config.
 529  */
 530
 531 #define TLV_TAG_GLOBAL_PORT_MODE         (0x10110000)
 532
 533 struct tlv_global_port_mode {
 534   uint32_t tag;
 535   uint32_t length;
 536   uint32_t port_mode;
 537 #define TLV_PORT_MODE_DEFAULT           (0xffffffff) /* Default for given platform */
 538 #define TLV_PORT_MODE_10G                        (0) /* 10G, single SFP/10G-KR */
 539 #define TLV_PORT_MODE_40G                        (1) /* 40G, single QSFP/40G-KR */
 540 #define TLV_PORT_MODE_10G_10G                    (2) /* 2x10G, dual SFP/10G-KR or single QSFP */
 541 #define TLV_PORT_MODE_40G_40G                    (3) /* 40G + 40G, dual QSFP/40G-KR (Greenport, Medford) */
 542 #define TLV_PORT_MODE_10G_10G_10G_10G            (4) /* 2x10G + 2x10G, quad SFP/10G-KR or dual QSFP (Greenport) */
 543 #define TLV_PORT_MODE_10G_10G_10G_10G_Q1         (4) /* 4x10G, single QSFP, cage 0 (Medford) */
 544 #define TLV_PORT_MODE_10G_10G_10G_10G_Q          (5) /* 4x10G, single QSFP, cage 0 (Medford) OBSOLETE DO NOT USE */
 545 #define TLV_PORT_MODE_40G_10G_10G                (6) /* 1x40G + 2x10G, dual QSFP (Greenport, Medford) */
 546 #define TLV_PORT_MODE_10G_10G_40G                (7) /* 2x10G + 1x40G, dual QSFP (Greenport, Medford) */
 547 #define TLV_PORT_MODE_10G_10G_10G_10G_Q2         (8) /* 4x10G, single QSFP, cage 1 (Medford) */
 548 #define TLV_PORT_MODE_10G_10G_10G_10G_Q1_Q2      (9) /* 2x10G + 2x10G, dual QSFP (Medford) */
 549 #define TLV_PORT_MODE_MAX TLV_PORT_MODE_10G_10G_10G_10G_Q1_Q2
 550 };
 551
 552 /* Type of the v-switch created implicitly by the firmware */
 553
 554 #define TLV_TAG_VSWITCH_TYPE(port)       (0x10120000 + (port))
 555
 556 struct tlv_vswitch_type {
 557   uint32_t tag;
 558   uint32_t length;
 559   uint32_t vswitch_type;
 560 #define TLV_VSWITCH_TYPE_DEFAULT        (0xffffffff) /* Firmware default; equivalent to no TLV present for a given port */
 561 #define TLV_VSWITCH_TYPE_NONE                    (0)
 562 #define TLV_VSWITCH_TYPE_VLAN                    (1)
 563 #define TLV_VSWITCH_TYPE_VEB                     (2)
 564 #define TLV_VSWITCH_TYPE_VEPA                    (3)
 565 #define TLV_VSWITCH_TYPE_MUX                     (4)
 566 #define TLV_VSWITCH_TYPE_TEST                    (5)
 567 };
 568
 569 /* A VLAN tag for the v-port created implicitly by the firmware */
 570
 571 #define TLV_TAG_VPORT_VLAN_TAG(pf)               (0x10130000 + (pf))
 572
 573 struct tlv_vport_vlan_tag {
 574   uint32_t tag;
 575   uint32_t length;
 576   uint32_t vlan_tag;
 577 #define TLV_VPORT_NO_VLAN_TAG                    (0xFFFFFFFF) /* Default in the absence of TLV for a given PF */
 578 };
 579
 580 /* Offset to be applied to the 0v9 setting, wherever it came from */
 581
 582 #define TLV_TAG_ATB_0V9_OFFSET           (0x10140000)
 583
 584 struct tlv_0v9_atb_offset {
 585   uint32_t tag;
 586   uint32_t length;
 587   int16_t  offset_millivolts;
 588   uint16_t reserved;
 589 };
 590
 591 /* A privilege mask given on reset to all non-admin PCIe functions (that is other than first-PF-per-port).
 592  * The meaning of particular bits is defined in mcdi_ef10.yml under MC_CMD_PRIVILEGE_MASK, see also bug 44583.
 593  * TLV_TAG_PRIVILEGE_MASK_ADD specifies bits that should be added (ORed) to firmware default while
 594  * TLV_TAG_PRIVILEGE_MASK_REM specifies bits that should be removed (ANDed) from firmware default:
 595  * Initial_privilege_mask = (firmware_default_mask | privilege_mask_add) & ~privilege_mask_rem */
 596
 597 #define TLV_TAG_PRIVILEGE_MASK          (0x10150000) /* legacy symbol - do not use */
 598
 599 struct tlv_privilege_mask {                          /* legacy structure - do not use */
 600   uint32_t tag;
 601   uint32_t length;
 602   uint32_t privilege_mask;
 603 };
 604
 605 #define TLV_TAG_PRIVILEGE_MASK_ADD      (0x10150000)
 606
 607 struct tlv_privilege_mask_add {
 608   uint32_t tag;
 609   uint32_t length;
 610   uint32_t privilege_mask_add;
 611 };
 612
 613 #define TLV_TAG_PRIVILEGE_MASK_REM      (0x10160000)
 614
 615 struct tlv_privilege_mask_rem {
 616   uint32_t tag;
 617   uint32_t length;
 618   uint32_t privilege_mask_rem;
 619 };
 620
 621 /* Additional privileges given to all PFs.
 622  * This tag takes precedence over TLV_TAG_PRIVILEGE_MASK_REM. */
 623
 624 #define TLV_TAG_PRIVILEGE_MASK_ADD_ALL_PFS         (0x10190000)
 625
 626 struct tlv_privilege_mask_add_all_pfs {
 627   uint32_t tag;
 628   uint32_t length;
 629   uint32_t privilege_mask_add;
 630 };
 631
 632 /* Additional privileges given to a selected PF.
 633  * This tag takes precedence over TLV_TAG_PRIVILEGE_MASK_REM. */
 634
 635 #define TLV_TAG_PRIVILEGE_MASK_ADD_SINGLE_PF(pf)   (0x101A0000 + (pf))
 636
 637 struct tlv_privilege_mask_add_single_pf {
 638   uint32_t tag;
 639   uint32_t length;
 640   uint32_t privilege_mask_add;
 641 };
 642
 643 /* Turning on/off the PFIOV mode.
 644  * This tag only takes effect if TLV_TAG_VSWITCH_TYPE is missing or set to DEFAULT. */
 645
 646 #define TLV_TAG_PFIOV(port)             (0x10170000 + (port))
 647
 648 struct tlv_pfiov {
 649   uint32_t tag;
 650   uint32_t length;
 651   uint32_t pfiov;
 652 #define TLV_PFIOV_OFF                    (0) /* Default */
 653 #define TLV_PFIOV_ON                     (1)
 654 };
 655
 656 /* Multicast filter chaining mode selection.
 657  *
 658  * When enabled, multicast packets are delivered to all recipients of all
 659  * matching multicast filters, with the exception that IP multicast filters
 660  * will steal traffic from MAC multicast filters on a per-function basis.
 661  * (New behaviour.)
 662  *
 663  * When disabled, multicast packets will always be delivered only to the
 664  * recipients of the highest priority matching multicast filter.
 665  * (Legacy behaviour.)
 666  *
 667  * The DEFAULT mode (which is the same as the tag not being present at all)
 668  * is equivalent to ENABLED in production builds, and DISABLED in eftest
 669  * builds.
 670  *
 671  * This option is intended to provide run-time control over this feature
 672  * while it is being stabilised and may be withdrawn at some point in the
 673  * future; the new behaviour is intended to become the standard behaviour.
 674  */
 675
 676 #define TLV_TAG_MCAST_FILTER_CHAINING   (0x10180000)
 677
 678 struct tlv_mcast_filter_chaining {
 679   uint32_t tag;
 680   uint32_t length;
 681   uint32_t mode;
 682 #define TLV_MCAST_FILTER_CHAINING_DEFAULT  (0xffffffff)
 683 #define TLV_MCAST_FILTER_CHAINING_DISABLED (0)
 684 #define TLV_MCAST_FILTER_CHAINING_ENABLED  (1)
 685 };
 686
 687 /* Pacer rate limit per PF */
 688 #define TLV_TAG_RATE_LIMIT(pf)    (0x101b0000 + (pf))
 689
 690 struct tlv_rate_limit {
 691   uint32_t tag;
 692   uint32_t length;
 693   uint32_t rate_mbps;
 694 };
 695
 696 /* OCSD Enable/Disable
 697  *
 698  * This setting allows OCSD to be disabled. This is a requirement for HP
 699  * servers to support PCI passthrough for virtualization.
 700  *
 701  * The DEFAULT mode (which is the same as the tag not being present) is
 702  * equivalent to ENABLED.
 703  *
 704  * This option is not used by the MCFW, and is entirely handled by the various
 705  * drivers that support OCSD, by reading the setting before they attempt
 706  * to enable OCSD.
 707  *
 708  * bit0: OCSD Disabled/Enabled
 709  */
 710
 711 #define TLV_TAG_OCSD (0x101C0000)
 712
 713 struct tlv_ocsd {
 714   uint32_t tag;
 715   uint32_t length;
 716   uint32_t mode;
 717 #define TLV_OCSD_DISABLED 0
 718 #define TLV_OCSD_ENABLED 1 /* Default */
 719 };
 720
 721 /* Descriptor cache config.
 722  *
 723  * Sets the sizes of the TX and RX descriptor caches as a power of 2. It also
 724  * sets the total number of VIs. When the number of VIs is reduced VIs are taken
 725  * away from the highest numbered port first, so a vi_count of 1024 means 1024
 726  * VIs on the first port and 0 on the second (on a Torino).
 727  */
 728
 729 #define TLV_TAG_DESCRIPTOR_CACHE_CONFIG    (0x101d0000)
 730
 731 struct tlv_descriptor_cache_config {
 732   uint32_t tag;
 733   uint32_t length;
 734   uint8_t rx_desc_cache_size;
 735   uint8_t tx_desc_cache_size;
 736   uint16_t vi_count;
 737 };
 738 #define TLV_DESC_CACHE_DEFAULT (0xff)
 739 #define TLV_VI_COUNT_DEFAULT   (0xffff)
 740
 741 /* RX event merging config (read batching).
 742  *
 743  * Sets the global maximum number of events for the merging bins, and the
 744  * global timeout configuration for the bins.
 745  */
 746
 747 #define TLV_TAG_RX_EVENT_MERGING_CONFIG    (0x101e0000)
 748
 749 struct tlv_rx_event_merging_config {
 750   uint32_t  tag;
 751   uint32_t  length;
 752   uint32_t  max_events;
 753 #define TLV_RX_EVENT_MERGING_CONFIG_MAX_EVENTS_MAX ((1 << 4) - 1)
 754   uint32_t  timeout_ns;
 755 };
 756 #define TLV_RX_EVENT_MERGING_MAX_EVENTS_DEFAULT (0xffffffff)
 757 #define TLV_RX_EVENT_MERGING_TIMEOUT_NS_DEFAULT (0xffffffff)
 758
 759 #define TLV_TAG_PCIE_LINK_SETTINGS (0x101f0000)
 760 struct tlv_pcie_link_settings {
 761   uint32_t tag;
 762   uint32_t length;
 763   uint16_t gen;   /* Target PCIe generation: 1, 2, 3 */
 764   uint16_t width; /* Number of lanes */
 765 };
 766
 767 /* TX event merging config.
 768  *
 769  * Sets the global maximum number of events for the merging bins, and the
 770  * global timeout configuration for the bins, and the global timeout for
 771  * empty queues.
 772  */
 773 #define TLV_TAG_TX_EVENT_MERGING_CONFIG    (0x10210000)
 774 struct tlv_tx_event_merging_config {
 775   uint32_t  tag;
 776   uint32_t  length;
 777   uint32_t  max_events;
 778 #define TLV_TX_EVENT_MERGING_CONFIG_MAX_EVENTS_MAX ((1 << 4) - 1)
 779   uint32_t  timeout_ns;
 780   uint32_t  qempty_timeout_ns; /* Medford only */
 781 };
 782 #define TLV_TX_EVENT_MERGING_MAX_EVENTS_DEFAULT (0xffffffff)
 783 #define TLV_TX_EVENT_MERGING_TIMEOUT_NS_DEFAULT (0xffffffff)
 784 #define TLV_TX_EVENT_MERGING_QEMPTY_TIMEOUT_NS_DEFAULT (0xffffffff)
 785
 786 #define TLV_TAG_LICENSE (0x30800000)
 787
 788 typedef struct tlv_license {
 789   uint32_t  tag;
 790   uint32_t  length;
 791   uint8_t   data[];
 792 } tlv_license_t;
 793
 794 /* TSA NIC IP address configuration
 795  *
 796  * Sets the TSA NIC IP address statically via configuration tool or dynamically
 797  * via DHCP via snooping based on the mode selection (0=Static, 1=DHCP, 2=Snoop)
 798  *
 799  * NOTE: This TAG is temporarily placed in the dynamic config partition and will
 800  * be moved to a private partition during TSA development. It is not used in any
 801  * released code yet.
 802  */
 803
 804 #define TLV_TAG_TMP_TSAN_CONFIG         (0x10220000)
 805
 806 #define TLV_TSAN_IP_MODE_STATIC         (0)
 807 #define TLV_TSAN_IP_MODE_DHCP           (1)
 808 #define TLV_TSAN_IP_MODE_SNOOP          (2)
 809 typedef struct tlv_tsan_config {
 810   uint32_t tag;
 811   uint32_t length;
 812   uint32_t mode;
 813   uint32_t ip;
 814   uint32_t netmask;
 815   uint32_t gateway;
 816   uint32_t port;
 817   uint32_t bind_retry;  /* DEPRECATED */
 818   uint32_t bind_bkout;  /* DEPRECATED */
 819 } tlv_tsan_config_t;
 820
 821 /* TSA Controller IP address configuration
 822  *
 823  * Sets the TSA Controller IP address statically via configuration tool
 824  *
 825  * NOTE: This TAG is temporarily placed in the dynamic config partition and will
 826  * be moved to a private partition during TSA development. It is not used in any
 827  * released code yet.
 828  */
 829
 830 #define TLV_TAG_TMP_TSAC_CONFIG         (0x10230000)
 831
 832 #define TLV_MAX_TSACS (4)
 833 typedef struct tlv_tsac_config {
 834   uint32_t tag;
 835   uint32_t length;
 836   uint32_t num_tsacs;
 837   uint32_t ip[TLV_MAX_TSACS];
 838   uint32_t port[TLV_MAX_TSACS];
 839 } tlv_tsac_config_t;
 840
 841 /* Binding ticket
 842  *
 843  * Sets the TSA NIC binding ticket used for binding process between the TSA NIC
 844  * and the TSA Controller
 845  *
 846  * NOTE: This TAG is temporarily placed in the dynamic config partition and will
 847  * be moved to a private partition during TSA development. It is not used in any
 848  * released code yet.
 849  */
 850
 851 #define TLV_TAG_TMP_BINDING_TICKET      (0x10240000)
 852
 853 typedef struct tlv_binding_ticket {
 854   uint32_t tag;
 855   uint32_t length;
 856   uint8_t  bytes[];
 857 } tlv_binding_ticket_t;
 858
 859 /* Solarflare private key  (DEPRECATED)
 860  *
 861  * Sets the Solareflare private key used for signing during the binding process
 862  *
 863  * NOTE: This TAG is temporarily placed in the dynamic config partition and will
 864  * be moved to a private partition during TSA development. It is not used in any
 865  * released code yet.
 866  */
 867
 868 #define TLV_TAG_TMP_PIK_SF              (0x10250000)    /* DEPRECATED */
 869
 870 typedef struct tlv_pik_sf {
 871   uint32_t tag;
 872   uint32_t length;
 873   uint8_t  bytes[];
 874 } tlv_pik_sf_t;
 875
 876 /* CA root certificate
 877  *
 878  * Sets the CA root certificate used for TSA Controller verfication during
 879  * TLS connection setup between the TSA NIC and the TSA Controller
 880  *
 881  * NOTE: This TAG is temporarily placed in the dynamic config partition and will
 882  * be moved to a private partition during TSA development. It is not used in any
 883  * released code yet.
 884  */
 885
 886 #define TLV_TAG_TMP_CA_ROOT_CERT        (0x10260000)
 887
 888 typedef struct tlv_ca_root_cert {
 889   uint32_t tag;
 890   uint32_t length;
 891   uint8_t  bytes[];
 892 } tlv_ca_root_cert_t;
 893
 894 /* Tx vFIFO Low latency configuration
 895  *
 896  * To keep the desired booting behaviour for the switch, it just requires to
 897  * know if the low latency mode is enabled.
 898  */
 899
 900 #define TLV_TAG_TX_VFIFO_ULL_MODE       (0x10270000)
 901 struct tlv_tx_vfifo_ull_mode {
 902   uint32_t tag;
 903   uint32_t length;
 904   uint8_t  mode;
 905 #define TLV_TX_VFIFO_ULL_MODE_DEFAULT    0
 906 };
 907
 908 /* BIU mode
 909  *
 910  * Medford2 tag for selecting VI window decode (see values below)
 911  */
 912 #define TLV_TAG_BIU_VI_WINDOW_MODE       (0x10280000)
 913 struct tlv_biu_vi_window_mode {
 914   uint32_t tag;
 915   uint32_t length;
 916   uint8_t  mode;
 917 #define TLV_BIU_VI_WINDOW_MODE_8K    0  /*  8k per VI, CTPIO not mapped, medford/hunt compatible */
 918 #define TLV_BIU_VI_WINDOW_MODE_16K   1  /* 16k per VI, CTPIO mapped */
 919 #define TLV_BIU_VI_WINDOW_MODE_64K   2  /* 64k per VI, CTPIO mapped, POWER-friendly */
 920 };
 921
 922 /* FastPD mode
 923  *
 924  * Medford2 tag for configuring the FastPD mode (see values below)
 925  */
 926 #define TLV_TAG_FASTPD_MODE(port)       (0x10290000 + (port))
 927 struct tlv_fastpd_mode {
 928   uint32_t tag;
 929   uint32_t length;
 930   uint8_t  mode;
 931 #define TLV_FASTPD_MODE_SOFT_ALL       0  /* All packets to the SoftPD */
 932 #define TLV_FASTPD_MODE_FAST_ALL       1  /* All packets to the FastPD */
 933 #define TLV_FASTPD_MODE_FAST_SUPPORTED 2  /* Supported packet types to the FastPD; everything else to the SoftPD  */
 934 };
 935
 936 #endif /* CI_MGMT_TLV_LAYOUT_H */