^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) /* SPDX-License-Identifier: GPL-2.0-only */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /****************************************************************************
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * Driver for Solarflare network controllers and boards
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) * Copyright 2007-2013 Solarflare Communications Inc.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) #ifndef EFX_ENUM_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) #define EFX_ENUM_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) * enum efx_loopback_mode - loopback modes
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) * @LOOPBACK_NONE: no loopback
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) * @LOOPBACK_DATA: data path loopback
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) * @LOOPBACK_GMAC: loopback within GMAC
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) * @LOOPBACK_XGMII: loopback after XMAC
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) * @LOOPBACK_XGXS: loopback within BPX after XGXS
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) * @LOOPBACK_XAUI: loopback within BPX before XAUI serdes
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) * @LOOPBACK_GMII: loopback within BPX after GMAC
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) * @LOOPBACK_SGMII: loopback within BPX within SGMII
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) * @LOOPBACK_XGBR: loopback within BPX within XGBR
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) * @LOOPBACK_XFI: loopback within BPX before XFI serdes
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) * @LOOPBACK_XAUI_FAR: loopback within BPX after XAUI serdes
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) * @LOOPBACK_GMII_FAR: loopback within BPX before SGMII
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) * @LOOPBACK_SGMII_FAR: loopback within BPX after SGMII
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) * @LOOPBACK_XFI_FAR: loopback after XFI serdes
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) * @LOOPBACK_GPHY: loopback within 1G PHY at unspecified level
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) * @LOOPBACK_PHYXS: loopback within 10G PHY at PHYXS level
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) * @LOOPBACK_PCS: loopback within 10G PHY at PCS level
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) * @LOOPBACK_PMAPMD: loopback within 10G PHY at PMAPMD level
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) * @LOOPBACK_XPORT: cross port loopback
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) * @LOOPBACK_XGMII_WS: wireside loopback excluding XMAC
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) * @LOOPBACK_XAUI_WS: wireside loopback within BPX within XAUI serdes
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) * @LOOPBACK_XAUI_WS_FAR: wireside loopback within BPX including XAUI serdes
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) * @LOOPBACK_XAUI_WS_NEAR: wireside loopback within BPX excluding XAUI serdes
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) * @LOOPBACK_GMII_WS: wireside loopback excluding GMAC
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) * @LOOPBACK_XFI_WS: wireside loopback excluding XFI serdes
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) * @LOOPBACK_XFI_WS_FAR: wireside loopback including XFI serdes
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) * @LOOPBACK_PHYXS_WS: wireside loopback within 10G PHY at PHYXS level
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) /* Please keep up-to-date w.r.t the following two #defines */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) enum efx_loopback_mode {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) LOOPBACK_NONE = 0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) LOOPBACK_DATA = 1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) LOOPBACK_GMAC = 2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) LOOPBACK_XGMII = 3,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) LOOPBACK_XGXS = 4,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) LOOPBACK_XAUI = 5,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) LOOPBACK_GMII = 6,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) LOOPBACK_SGMII = 7,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) LOOPBACK_XGBR = 8,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) LOOPBACK_XFI = 9,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) LOOPBACK_XAUI_FAR = 10,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) LOOPBACK_GMII_FAR = 11,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) LOOPBACK_SGMII_FAR = 12,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) LOOPBACK_XFI_FAR = 13,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) LOOPBACK_GPHY = 14,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) LOOPBACK_PHYXS = 15,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) LOOPBACK_PCS = 16,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) LOOPBACK_PMAPMD = 17,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) LOOPBACK_XPORT = 18,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) LOOPBACK_XGMII_WS = 19,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) LOOPBACK_XAUI_WS = 20,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) LOOPBACK_XAUI_WS_FAR = 21,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) LOOPBACK_XAUI_WS_NEAR = 22,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) LOOPBACK_GMII_WS = 23,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) LOOPBACK_XFI_WS = 24,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) LOOPBACK_XFI_WS_FAR = 25,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) LOOPBACK_PHYXS_WS = 26,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) LOOPBACK_MAX
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) #define LOOPBACK_TEST_MAX LOOPBACK_PMAPMD
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) /* These loopbacks occur within the controller */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) #define LOOPBACKS_INTERNAL ((1 << LOOPBACK_DATA) | \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) (1 << LOOPBACK_GMAC) | \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) (1 << LOOPBACK_XGMII)| \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) (1 << LOOPBACK_XGXS) | \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) (1 << LOOPBACK_XAUI) | \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) (1 << LOOPBACK_GMII) | \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) (1 << LOOPBACK_SGMII) | \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) (1 << LOOPBACK_SGMII) | \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) (1 << LOOPBACK_XGBR) | \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) (1 << LOOPBACK_XFI) | \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) (1 << LOOPBACK_XAUI_FAR) | \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) (1 << LOOPBACK_GMII_FAR) | \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) (1 << LOOPBACK_SGMII_FAR) | \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) (1 << LOOPBACK_XFI_FAR) | \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) (1 << LOOPBACK_XGMII_WS) | \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) (1 << LOOPBACK_XAUI_WS) | \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) (1 << LOOPBACK_XAUI_WS_FAR) | \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) (1 << LOOPBACK_XAUI_WS_NEAR) | \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) (1 << LOOPBACK_GMII_WS) | \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) (1 << LOOPBACK_XFI_WS) | \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) (1 << LOOPBACK_XFI_WS_FAR))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) #define LOOPBACKS_WS ((1 << LOOPBACK_XGMII_WS) | \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) (1 << LOOPBACK_XAUI_WS) | \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) (1 << LOOPBACK_XAUI_WS_FAR) | \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) (1 << LOOPBACK_XAUI_WS_NEAR) | \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) (1 << LOOPBACK_GMII_WS) | \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) (1 << LOOPBACK_XFI_WS) | \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) (1 << LOOPBACK_XFI_WS_FAR) | \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) (1 << LOOPBACK_PHYXS_WS))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) #define LOOPBACKS_EXTERNAL(_efx) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) ((_efx)->loopback_modes & ~LOOPBACKS_INTERNAL & \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) ~(1 << LOOPBACK_NONE))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) #define LOOPBACK_MASK(_efx) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) (1 << (_efx)->loopback_mode)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) #define LOOPBACK_INTERNAL(_efx) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) (!!(LOOPBACKS_INTERNAL & LOOPBACK_MASK(_efx)))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) #define LOOPBACK_EXTERNAL(_efx) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) (!!(LOOPBACK_MASK(_efx) & LOOPBACKS_EXTERNAL(_efx)))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) #define LOOPBACK_CHANGED(_from, _to, _mask) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) (!!((LOOPBACK_MASK(_from) ^ LOOPBACK_MASK(_to)) & (_mask)))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) #define LOOPBACK_OUT_OF(_from, _to, _mask) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) ((LOOPBACK_MASK(_from) & (_mask)) && !(LOOPBACK_MASK(_to) & (_mask)))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) /*****************************************************************************/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) * enum reset_type - reset types
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) * %RESET_TYPE_INVSIBLE, %RESET_TYPE_ALL, %RESET_TYPE_WORLD and
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) * %RESET_TYPE_DISABLE specify the method/scope of the reset. The
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) * other valuesspecify reasons, which efx_schedule_reset() will choose
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) * a method for.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) * Reset methods are numbered in order of increasing scope.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) * @RESET_TYPE_INVISIBLE: Reset datapath and MAC (Falcon only)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) * @RESET_TYPE_RECOVER_OR_ALL: Try to recover. Apply RESET_TYPE_ALL
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) * if unsuccessful.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) * @RESET_TYPE_ALL: Reset datapath, MAC and PHY
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) * @RESET_TYPE_WORLD: Reset as much as possible
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) * @RESET_TYPE_RECOVER_OR_DISABLE: Try to recover. Apply RESET_TYPE_DISABLE if
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) * unsuccessful.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) * @RESET_TYPE_DATAPATH: Reset datapath only.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) * @RESET_TYPE_MC_BIST: MC entering BIST mode.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) * @RESET_TYPE_DISABLE: Reset datapath, MAC and PHY; leave NIC disabled
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) * @RESET_TYPE_TX_WATCHDOG: reset due to TX watchdog
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) * @RESET_TYPE_INT_ERROR: reset due to internal error
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) * @RESET_TYPE_DMA_ERROR: DMA error
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) * @RESET_TYPE_TX_SKIP: hardware completed empty tx descriptors
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) * @RESET_TYPE_MC_FAILURE: MC reboot/assertion
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) * @RESET_TYPE_MCDI_TIMEOUT: MCDI timeout.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) enum reset_type {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) RESET_TYPE_INVISIBLE,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) RESET_TYPE_RECOVER_OR_ALL,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) RESET_TYPE_ALL,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) RESET_TYPE_WORLD,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) RESET_TYPE_RECOVER_OR_DISABLE,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) RESET_TYPE_DATAPATH,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) RESET_TYPE_MC_BIST,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) RESET_TYPE_DISABLE,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) RESET_TYPE_MAX_METHOD,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) RESET_TYPE_TX_WATCHDOG,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) RESET_TYPE_INT_ERROR,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165) RESET_TYPE_DMA_ERROR,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) RESET_TYPE_TX_SKIP,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) RESET_TYPE_MC_FAILURE,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) /* RESET_TYPE_MCDI_TIMEOUT is actually a method, not just a reason, but
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) * it doesn't fit the scope hierarchy (not well-ordered by inclusion).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170) * We encode this by having its enum value be greater than
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) * RESET_TYPE_MAX_METHOD.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) RESET_TYPE_MCDI_TIMEOUT,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174) RESET_TYPE_MAX,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) #endif /* EFX_ENUM_H */