drivers/net/sfc/base/efx_check.h

   1 /*
   2  * Copyright (c) 2012-2016 Solarflare Communications Inc.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are met:
   7  *
   8  * 1. Redistributions of source code must retain the above copyright notice,
   9  *    this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright notice,
  11  *    this list of conditions and the following disclaimer in the documentation
  12  *    and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  15  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  16  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  21  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  22  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  23  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  24  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  *
  26  * The views and conclusions contained in the software and documentation are
  27  * those of the authors and should not be interpreted as representing official
  28  * policies, either expressed or implied, of the FreeBSD Project.
  29  */
  30
  31 #ifndef _SYS_EFX_CHECK_H
  32 #define _SYS_EFX_CHECK_H
  33
  34 #include "efsys.h"
  35
  36 /*
  37  * Check that the efsys.h header in client code has a valid combination of
  38  * EFSYS_OPT_xxx options.
  39  *
  40  * NOTE: Keep checks for obsolete options here to ensure that they are removed
  41  * from client code (and do not reappear in merges from other branches).
  42  */
  43
  44 #ifdef EFSYS_OPT_FALCON
  45 # error "FALCON is obsolete and is not supported."
  46 #endif
  47
  48 #if EFSYS_OPT_CHECK_REG
  49 /* Verify chip implements accessed registers */
  50 # if !(EFSYS_OPT_SIENA || EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD)
  51 #  error "CHECK_REG requires SIENA or HUNTINGTON or MEDFORD"
  52 # endif
  53 #endif /* EFSYS_OPT_CHECK_REG */
  54
  55 #if EFSYS_OPT_DECODE_INTR_FATAL
  56 /* Decode fatal errors */
  57 # if !EFSYS_OPT_SIENA
  58 #  error "INTR_FATAL requires SIENA"
  59 # endif
  60 #endif /* EFSYS_OPT_DECODE_INTR_FATAL */
  61
  62 #if EFSYS_OPT_DIAG
  63 /* Support diagnostic hardware tests */
  64 # if !(EFSYS_OPT_SIENA || EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD)
  65 #  error "DIAG requires SIENA or HUNTINGTON or MEDFORD"
  66 # endif
  67 #endif /* EFSYS_OPT_DIAG */
  68
  69 #if EFSYS_OPT_EV_PREFETCH
  70 /* Support optimized EVQ data access */
  71 # if !(EFSYS_OPT_SIENA || EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD)
  72 #  error "EV_PREFETCH requires SIENA or HUNTINGTON or MEDFORD"
  73 # endif
  74 #endif /* EFSYS_OPT_EV_PREFETCH */
  75
  76 #ifdef EFSYS_OPT_FALCON_NIC_CFG_OVERRIDE
  77 # error "FALCON_NIC_CFG_OVERRIDE is obsolete and is not supported."
  78 #endif
  79
  80 #if EFSYS_OPT_FILTER
  81 /* Support hardware packet filters */
  82 # if !(EFSYS_OPT_SIENA || EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD)
  83 #  error "FILTER requires SIENA or HUNTINGTON or MEDFORD"
  84 # endif
  85 #endif /* EFSYS_OPT_FILTER */
  86
  87 #if (EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD)
  88 # if !EFSYS_OPT_FILTER
  89 #  error "HUNTINGTON or MEDFORD requires FILTER"
  90 # endif
  91 #endif /* EFSYS_OPT_HUNTINGTON */
  92
  93 #if EFSYS_OPT_LOOPBACK
  94 /* Support hardware loopback modes */
  95 # if !(EFSYS_OPT_SIENA || EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD)
  96 #  error "LOOPBACK requires SIENA or HUNTINGTON or MEDFORD"
  97 # endif
  98 #endif /* EFSYS_OPT_LOOPBACK */
  99
 100 #ifdef EFSYS_OPT_MAC_FALCON_GMAC
 101 # error "MAC_FALCON_GMAC is obsolete and is not supported."
 102 #endif
 103
 104 #ifdef EFSYS_OPT_MAC_FALCON_XMAC
 105 # error "MAC_FALCON_XMAC is obsolete and is not supported."
 106 #endif
 107
 108 #if EFSYS_OPT_MAC_STATS
 109 /* Support MAC statistics */
 110 # if !(EFSYS_OPT_SIENA || EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD)
 111 #  error "MAC_STATS requires SIENA or HUNTINGTON or MEDFORD"
 112 # endif
 113 #endif /* EFSYS_OPT_MAC_STATS */
 114
 115 #if EFSYS_OPT_MCDI
 116 /* Support management controller messages */
 117 # if !(EFSYS_OPT_SIENA || EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD)
 118 #  error "MCDI requires SIENA or HUNTINGTON or MEDFORD"
 119 # endif
 120 #endif /* EFSYS_OPT_MCDI */
 121
 122 #if (EFSYS_OPT_SIENA || EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD)
 123 # if !EFSYS_OPT_MCDI
 124 #  error "SIENA or HUNTINGTON or MEDFORD requires MCDI"
 125 # endif
 126 #endif
 127
 128 #if EFSYS_OPT_MCDI_LOGGING
 129 /* Support MCDI logging */
 130 # if !EFSYS_OPT_MCDI
 131 #  error "MCDI_LOGGING requires MCDI"
 132 # endif
 133 #endif /* EFSYS_OPT_MCDI_LOGGING */
 134
 135 #if EFSYS_OPT_MCDI_PROXY_AUTH
 136 /* Support MCDI proxy authorization */
 137 # if !EFSYS_OPT_MCDI
 138 #  error "MCDI_PROXY_AUTH requires MCDI"
 139 # endif
 140 #endif /* EFSYS_OPT_MCDI_PROXY_AUTH */
 141
 142 #ifdef EFSYS_OPT_MON_LM87
 143 # error "MON_LM87 is obsolete and is not supported."
 144 #endif
 145
 146 #ifdef EFSYS_OPT_MON_MAX6647
 147 # error "MON_MAX6647 is obsolete and is not supported."
 148 #endif
 149
 150 #ifdef EFSYS_OPT_MON_NULL
 151 # error "MON_NULL is obsolete and is not supported."
 152 #endif
 153
 154 #ifdef EFSYS_OPT_MON_SIENA
 155 #  error "MON_SIENA is obsolete (replaced by MON_MCDI)."
 156 #endif
 157
 158 #ifdef EFSYS_OPT_MON_HUNTINGTON
 159 #  error "MON_HUNTINGTON is obsolete (replaced by MON_MCDI)."
 160 #endif
 161
 162 #if EFSYS_OPT_NAMES
 163 /* Support printable names for statistics */
 164 # if !(EFSYS_OPT_LOOPBACK || EFSYS_OPT_MAC_STATS || EFSYS_OPT_MCDI || \
 165         EFSYS_MON_STATS || EFSYS_OPT_PHY_STATS || EFSYS_OPT_QSTATS)
 166 #  error "NAMES requires LOOPBACK or xxxSTATS or MCDI"
 167 # endif
 168 #endif /* EFSYS_OPT_NAMES */
 169
 170 #ifdef EFSYS_OPT_NVRAM_FALCON_BOOTROM
 171 # error "NVRAM_FALCON_BOOTROM is obsolete and is not supported."
 172 #endif
 173
 174 #ifdef EFSYS_OPT_NVRAM_SFT9001
 175 # error "NVRAM_SFT9001 is obsolete and is not supported."
 176 #endif
 177
 178 #ifdef EFSYS_OPT_NVRAM_SFX7101
 179 # error "NVRAM_SFX7101 is obsolete and is not supported."
 180 #endif
 181
 182 #ifdef EFSYS_OPT_PCIE_TUNE
 183 # error "PCIE_TUNE is obsolete and is not supported."
 184 #endif
 185
 186 #ifdef EFSYS_OPT_PHY_BIST
 187 # error "PHY_BIST is obsolete (replaced by BIST)."
 188 #endif
 189
 190 #if EFSYS_OPT_PHY_FLAGS
 191 /* Support PHY flags */
 192 # if !EFSYS_OPT_SIENA
 193 #  error "PHY_FLAGS requires SIENA"
 194 # endif
 195 #endif /* EFSYS_OPT_PHY_FLAGS */
 196
 197 #if EFSYS_OPT_PHY_LED_CONTROL
 198 /* Support for PHY LED control */
 199 # if !EFSYS_OPT_SIENA
 200 #  error "PHY_LED_CONTROL requires SIENA"
 201 # endif
 202 #endif /* EFSYS_OPT_PHY_LED_CONTROL */
 203
 204 #ifdef EFSYS_OPT_PHY_NULL
 205 # error "PHY_NULL is obsolete and is not supported."
 206 #endif
 207
 208 #ifdef EFSYS_OPT_PHY_PM8358
 209 # error "PHY_PM8358 is obsolete and is not supported."
 210 #endif
 211
 212 #ifdef EFSYS_OPT_PHY_PROPS
 213 # error "PHY_PROPS is obsolete and is not supported."
 214 #endif
 215
 216 #ifdef EFSYS_OPT_PHY_QT2022C2
 217 # error "PHY_QT2022C2 is obsolete and is not supported."
 218 #endif
 219
 220 #ifdef EFSYS_OPT_PHY_QT2025C
 221 # error "PHY_QT2025C is obsolete and is not supported."
 222 #endif
 223
 224 #ifdef EFSYS_OPT_PHY_SFT9001
 225 # error "PHY_SFT9001 is obsolete and is not supported."
 226 #endif
 227
 228 #ifdef EFSYS_OPT_PHY_SFX7101
 229 # error "PHY_SFX7101 is obsolete and is not supported."
 230 #endif
 231
 232 #if EFSYS_OPT_PHY_STATS
 233 /* Support PHY statistics */
 234 # if !EFSYS_OPT_SIENA
 235 #  error "PHY_STATS requires SIENA"
 236 # endif
 237 #endif /* EFSYS_OPT_PHY_STATS */
 238
 239 #ifdef EFSYS_OPT_PHY_TXC43128
 240 # error "PHY_TXC43128 is obsolete and is not supported."
 241 #endif
 242
 243 #if EFSYS_OPT_QSTATS
 244 /* Support EVQ/RXQ/TXQ statistics */
 245 # if !(EFSYS_OPT_SIENA || EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD)
 246 #  error "QSTATS requires SIENA or HUNTINGTON or MEDFORD"
 247 # endif
 248 #endif /* EFSYS_OPT_QSTATS */
 249
 250 #ifdef EFSYS_OPT_RX_HDR_SPLIT
 251 # error "RX_HDR_SPLIT is obsolete and is not supported"
 252 #endif
 253
 254 #if EFSYS_OPT_RX_SCALE
 255 /* Support receive scaling (RSS) */
 256 # if !(EFSYS_OPT_SIENA || EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD)
 257 #  error "RX_SCALE requires SIENA or HUNTINGTON or MEDFORD"
 258 # endif
 259 #endif /* EFSYS_OPT_RX_SCALE */
 260
 261 #if EFSYS_OPT_RX_SCATTER
 262 /* Support receive scatter DMA */
 263 # if !(EFSYS_OPT_SIENA || EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD)
 264 #  error "RX_SCATTER requires SIENA or HUNTINGTON or MEDFORD"
 265 # endif
 266 #endif /* EFSYS_OPT_RX_SCATTER */
 267
 268 #ifdef EFSYS_OPT_STAT_NAME
 269 # error "STAT_NAME is obsolete (replaced by NAMES)."
 270 #endif
 271
 272 #ifdef EFSYS_OPT_WOL
 273 # error "WOL is obsolete and is not supported"
 274 #endif /* EFSYS_OPT_WOL */
 275
 276 #ifdef EFSYS_OPT_MCAST_FILTER_LIST
 277 #  error "MCAST_FILTER_LIST is obsolete and is not supported"
 278 #endif
 279
 280 #if EFSYS_OPT_BIST
 281 /* Support BIST */
 282 # if !(EFSYS_OPT_SIENA || EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD)
 283 #  error "BIST requires SIENA or HUNTINGTON or MEDFORD"
 284 # endif
 285 #endif /* EFSYS_OPT_BIST */
 286
 287 #if EFSYS_OPT_ALLOW_UNCONFIGURED_NIC
 288 /* Support adapters with missing static config (for factory use only) */
 289 # if !EFSYS_OPT_MEDFORD
 290 #  error "ALLOW_UNCONFIGURED_NIC requires MEDFORD"
 291 # endif
 292 #endif /* EFSYS_OPT_ALLOW_UNCONFIGURED_NIC */
 293
 294 #endif /* _SYS_EFX_CHECK_H */