root/drivers/net/ethernet/freescale/enetc/enetc_hw.h
/* SPDX-License-Identifier: (GPL-2.0+ OR BSD-3-Clause) */
/* Copyright 2017-2019 NXP */

#include <linux/bitops.h>

#define ENETC_MM_VERIFY_SLEEP_US        USEC_PER_MSEC
#define ENETC_MM_VERIFY_RETRIES         3

#define ENETC_NUM_TC                    8

/* ENETC device IDs */
#define ENETC_DEV_ID_PF         0xe100
#define ENETC_DEV_ID_VF         0xef00
#define ENETC_DEV_ID_PTP        0xee02

/* ENETC register block BAR */
#define ENETC_BAR_REGS  0

/** SI regs, offset: 0h */
#define ENETC_SIMR      0
#define ENETC_SIMR_EN   BIT(31)
#define ENETC_SIMR_RSSE BIT(0)
#define ENETC_SICTR0    0x18
#define ENETC_SICTR1    0x1c
#define ENETC_SIPCAPR0  0x20
#define ENETC_SIPCAPR0_RSS      BIT(8)
#define ENETC_SIPCAPR0_RFS      BIT(2)
#define ENETC_SIPCAPR0_LSO      BIT(1)
#define ENETC_SIPCAPR1  0x24
#define ENETC_SITGTGR   0x30
#define ENETC_SIRBGCR   0x38
/* cache attribute registers for transactions initiated by ENETC */
#define ENETC_SICAR0    0x40
#define ENETC_SICAR1    0x44
#define ENETC_SICAR2    0x48
/* rd snoop, no alloc
 * wr snoop, no alloc, partial cache line update for BDs and full cache line
 * update for data
 */
#define ENETC_SICAR_RD_COHERENT 0x2b2b0000
#define ENETC_SICAR_WR_COHERENT 0x00006727
#define ENETC_SICAR_MSI 0x00300030 /* rd/wr device, no snoop, no alloc */

#define ENETC_SIPMAR0   0x80
#define ENETC_SIPMAR1   0x84
#define ENETC_SICVLANR1 0x90
#define ENETC_SICVLANR2 0x94
#define  SICVLANR_ETYPE GENMASK(15, 0)

/* VF-PF Message passing */
#define ENETC_DEFAULT_MSG_SIZE  1024    /* and max size */
/* msg size encoding: default and max msg value of 1024B encoded as 0 */
static inline u32 enetc_vsi_set_msize(u32 size)
{
        return size < ENETC_DEFAULT_MSG_SIZE ? size >> 5 : 0;
}

#define ENETC_PSIMSGRR  0x204
#define ENETC_PSIMSGRR_MR_MASK  GENMASK(2, 1)
#define ENETC_PSIMSGRR_MR(n) BIT((n) + 1) /* n = VSI index */
#define ENETC_PSIVMSGRCVAR0(n)  (0x210 + (n) * 0x8) /* n = VSI index */
#define ENETC_PSIVMSGRCVAR1(n)  (0x214 + (n) * 0x8)

#define ENETC_VSIMSGSR  0x204   /* RO */
#define ENETC_VSIMSGSR_MB       BIT(0)
#define ENETC_VSIMSGSR_MS       BIT(1)
#define ENETC_VSIMSGSNDAR0      0x210
#define ENETC_VSIMSGSNDAR1      0x214

#define ENETC_SIMSGSR_SET_MC(val) ((val) << 16)
#define ENETC_SIMSGSR_GET_MC(val) ((val) >> 16)

/* SI statistics */
#define ENETC_SIROCT    0x300
#define ENETC_SIRFRM    0x308
#define ENETC_SIRUCA    0x310
#define ENETC_SIRMCA    0x318
#define ENETC_SITOCT    0x320
#define ENETC_SITFRM    0x328
#define ENETC_SITUCA    0x330
#define ENETC_SITMCA    0x338
#define ENETC_RBDCR(n)  (0x8180 + (n) * 0x200)

/* Control BDR regs */
#define ENETC_SICBDRMR          0x800
#define ENETC_SICBDRSR          0x804   /* RO */
#define ENETC_SICBDRBAR0        0x810
#define ENETC_SICBDRBAR1        0x814
#define ENETC_SICBDRPIR         0x818
#define ENETC_SICBDRCIR         0x81c
#define ENETC_SICBDRLENR        0x820

#define ENETC_SICAPR0   0x900
#define ENETC_SICAPR1   0x904

#define ENETC_PSIIER    0xa00
#define ENETC_PSIIER_MR_MASK    GENMASK(2, 1)
#define ENETC_PSIIDR    0xa08
#define ENETC_SITXIDR   0xa18
#define ENETC_SIRXIDR   0xa28
#define ENETC_SIMSIVR   0xa30

#define ENETC_SIMSITRV(n) (0xB00 + (n) * 0x4)
#define ENETC_SIMSIRRV(n) (0xB80 + (n) * 0x4)

#define ENETC_SIUEFDCR  0xe28

#define ENETC_SIRFSCAPR 0x1200
#define ENETC_SIRFSCAPR_GET_NUM_RFS(val) ((val) & 0x7f)
#define ENETC_SIRSSCAPR 0x1600
#define ENETC_SIRSSCAPR_GET_NUM_RSS(val) (BIT((val) & 0xf) * 32)

/** SI BDR sub-blocks, n = 0..7 */
enum enetc_bdr_type {TX, RX};
#define ENETC_BDR_OFF(i)        ((i) * 0x200)
#define ENETC_BDR(t, i, r)      (0x8000 + (t) * 0x100 + ENETC_BDR_OFF(i) + (r))
/* RX BDR reg offsets */
#define ENETC_RBMR      0
#define ENETC_RBMR_BDS  BIT(2)
#define ENETC_RBMR_CM   BIT(4)
#define ENETC_RBMR_VTE  BIT(5)
#define ENETC_RBMR_EN   BIT(31)
#define ENETC_RBSR      0x4
#define ENETC_RBBSR     0x8
#define ENETC_RBCIR     0xc
#define ENETC_RBBAR0    0x10
#define ENETC_RBBAR1    0x14
#define ENETC_RBPIR     0x18
#define ENETC_RBLENR    0x20
#define ENETC_RBIER     0xa0
#define ENETC_RBIER_RXTIE       BIT(0)
#define ENETC_RBIDR     0xa4
#define ENETC_RBICR0    0xa8
#define ENETC_RBICR0_ICEN               BIT(31)
#define ENETC_RBICR0_ICPT_MASK          0x1ff
#define ENETC_RBICR0_SET_ICPT(n)        ((n) & ENETC_RBICR0_ICPT_MASK)
#define ENETC_RBICR1    0xac

/* TX BDR reg offsets */
#define ENETC_TBMR      0
#define ENETC_TBSR_BUSY BIT(0)
#define ENETC_TBMR_VIH  BIT(9)
#define ENETC_TBMR_PRIO_MASK            GENMASK(2, 0)
#define ENETC_TBMR_SET_PRIO(val)        ((val) & ENETC_TBMR_PRIO_MASK)
#define ENETC_TBMR_EN   BIT(31)
#define ENETC_TBSR      0x4
#define ENETC_TBBAR0    0x10
#define ENETC_TBBAR1    0x14
#define ENETC_TBPIR     0x18
#define ENETC_TBCIR     0x1c
#define ENETC_TBCIR_IDX_MASK    0xffff
#define ENETC_TBLENR    0x20
#define ENETC_TBIER     0xa0
#define ENETC_TBIER_TXTIE       BIT(0)
#define ENETC_TBIDR     0xa4
#define ENETC_TBICR0    0xa8
#define ENETC_TBICR0_ICEN               BIT(31)
#define ENETC_TBICR0_ICPT_MASK          0xf
#define ENETC_TBICR0_SET_ICPT(n) ((ilog2(n) + 1) & ENETC_TBICR0_ICPT_MASK)
#define ENETC_TBICR1    0xac

#define ENETC_RTBLENR_LEN(n)    ((n) & ~0x7)

/* Port regs, offset: 1_0000h */
#define ENETC_PORT_BASE         0x10000
#define ENETC_PMR               0x0000
#define ENETC_PMR_EN    GENMASK(18, 16)
#define ENETC_PMR_PSPEED_MASK GENMASK(11, 8)
#define ENETC_PMR_PSPEED_10M    0
#define ENETC_PMR_PSPEED_100M   BIT(8)
#define ENETC_PMR_PSPEED_1000M  BIT(9)
#define ENETC_PMR_PSPEED_2500M  BIT(10)
#define ENETC_PSR               0x0004 /* RO */
#define ENETC_PSIPMR            0x0018
#define ENETC_PSIPMR_SET_UP(n)  BIT(n) /* n = SI index */
#define ENETC_PSIPMR_SET_MP(n)  BIT((n) + 16)
#define ENETC_PSIPVMR           0x001c
#define ENETC_VLAN_PROMISC_MAP_ALL      0x7
#define ENETC_PSIPVMR_SET_VP(simap)     ((simap) & 0x7)
#define ENETC_PSIPVMR_SET_VUTA(simap)   (((simap) & 0x7) << 16)
#define ENETC_PSIPMAR0(n)       (0x0100 + (n) * 0x8) /* n = SI index */
#define ENETC_PSIPMAR1(n)       (0x0104 + (n) * 0x8)
#define ENETC_PVCLCTR           0x0208
#define ENETC_PCVLANR1          0x0210
#define ENETC_PCVLANR2          0x0214
#define ENETC_VLAN_TYPE_C       BIT(0)
#define ENETC_VLAN_TYPE_S       BIT(1)
#define ENETC_PVCLCTR_OVTPIDL(bmp)      ((bmp) & 0xff) /* VLAN_TYPE */
#define ENETC_PSIVLANR(n)       (0x0240 + (n) * 4) /* n = SI index */
#define ENETC_PSIVLAN_EN        BIT(31)
#define ENETC_PSIVLAN_SET_QOS(val)      ((u32)(val) << 12)
#define ENETC_PPAUONTR          0x0410
#define ENETC_PPAUOFFTR         0x0414
#define ENETC_PTXMBAR           0x0608
#define ENETC_PCAPR0            0x0900
#define ENETC_PCAPR0_RXBDR(val) ((val) >> 24)
#define ENETC_PCAPR0_TXBDR(val) (((val) >> 16) & 0xff)
#define ENETC_PCAPR0_PSFP       BIT(9)
#define ENETC_PCAPR0_QBV        BIT(4)
#define ENETC_PCAPR0_QBU        BIT(3)
#define ENETC_PCAPR1            0x0904
#define ENETC_PSICFGR0(n)       (0x0940 + (n) * 0xc)  /* n = SI index */
#define ENETC_PSICFGR0_SET_TXBDR(val)   ((val) & 0xff)
#define ENETC_PSICFGR0_SET_RXBDR(val)   (((val) & 0xff) << 16)
#define ENETC_PSICFGR0_VTE      BIT(12)
#define ENETC_PSICFGR0_SIVIE    BIT(14)
#define ENETC_PSICFGR0_ASE      BIT(15)
#define ENETC_PSICFGR0_SIVC(bmp)        (((bmp) & 0xff) << 24) /* VLAN_TYPE */

#define ENETC_PTCCBSR0(n)       (0x1110 + (n) * 8) /* n = 0 to 7*/
#define ENETC_CBSE              BIT(31)
#define ENETC_CBS_BW_MASK       GENMASK(6, 0)
#define ENETC_PTCCBSR1(n)       (0x1114 + (n) * 8) /* n = 0 to 7*/
#define ENETC_RSSHASH_KEY_SIZE  40
#define ENETC_PRSSCAPR          0x1404
#define ENETC_PRSSCAPR_GET_NUM_RSS(val) (BIT((val) & 0xf) * 32)
#define ENETC_PRSSK(n)          (0x1410 + (n) * 4) /* n = [0..9] */
#define ENETC_PSIVLANFMR        0x1700
#define ENETC_PSIVLANFMR_VS     BIT(0)
#define ENETC_PRFSMR            0x1800
#define ENETC_PRFSMR_RFSE       BIT(31)
#define ENETC_PRFSCAPR          0x1804
#define ENETC_PRFSCAPR_GET_NUM_RFS(val) ((((val) & 0xf) + 1) * 16)
#define ENETC_PSIRFSCFGR(n)     (0x1814 + (n) * 4) /* n = SI index */
#define ENETC_PFPMR             0x1900
#define ENETC_PFPMR_PMACE       BIT(1)
#define ENETC_EMDIO_BASE        0x1c00
#define ENETC_PSIUMHFR0(n, err) (((err) ? 0x1d08 : 0x1d00) + (n) * 0x10)
#define ENETC_PSIUMHFR1(n)      (0x1d04 + (n) * 0x10)
#define ENETC_PSIMMHFR0(n, err) (((err) ? 0x1d00 : 0x1d08) + (n) * 0x10)
#define ENETC_PSIMMHFR1(n)      (0x1d0c + (n) * 0x10)
#define ENETC_PSIVHFR0(n)       (0x1e00 + (n) * 8) /* n = SI index */
#define ENETC_PSIVHFR1(n)       (0x1e04 + (n) * 8) /* n = SI index */
#define ENETC_MMCSR             0x1f00
#define ENETC_MMCSR_LINK_FAIL   BIT(31)
#define ENETC_MMCSR_VT_MASK     GENMASK(29, 23) /* Verify Time */
#define ENETC_MMCSR_VT(x)       (((x) << 23) & ENETC_MMCSR_VT_MASK)
#define ENETC_MMCSR_GET_VT(x)   (((x) & ENETC_MMCSR_VT_MASK) >> 23)
#define ENETC_MMCSR_TXSTS_MASK  GENMASK(22, 21) /* Merge Status */
#define ENETC_MMCSR_GET_TXSTS(x) (((x) & ENETC_MMCSR_TXSTS_MASK) >> 21)
#define ENETC_MMCSR_VSTS_MASK   GENMASK(20, 18) /* Verify Status */
#define ENETC_MMCSR_GET_VSTS(x) (((x) & ENETC_MMCSR_VSTS_MASK) >> 18)
#define ENETC_MMCSR_VDIS        BIT(17) /* Verify Disabled */
#define ENETC_MMCSR_ME          BIT(16) /* Merge Enabled */
#define ENETC_MMCSR_RAFS_MASK   GENMASK(9, 8) /* Remote Additional Fragment Size */
#define ENETC_MMCSR_RAFS(x)     (((x) << 8) & ENETC_MMCSR_RAFS_MASK)
#define ENETC_MMCSR_GET_RAFS(x) (((x) & ENETC_MMCSR_RAFS_MASK) >> 8)
#define ENETC_MMCSR_LAFS_MASK   GENMASK(4, 3) /* Local Additional Fragment Size */
#define ENETC_MMCSR_GET_LAFS(x) (((x) & ENETC_MMCSR_LAFS_MASK) >> 3)
#define ENETC_MMCSR_LPA         BIT(2) /* Local Preemption Active */
#define ENETC_MMCSR_LPE         BIT(1) /* Local Preemption Enabled */
#define ENETC_MMCSR_LPS         BIT(0) /* Local Preemption Supported */
#define ENETC_MMFAECR           0x1f08
#define ENETC_MMFSECR           0x1f0c
#define ENETC_MMFAOCR           0x1f10
#define ENETC_MMFCRXR           0x1f14
#define ENETC_MMFCTXR           0x1f18
#define ENETC_MMHCR             0x1f1c
#define ENETC_PTCMSDUR(n)       (0x2020 + (n) * 4) /* n = TC index [0..7] */

#define ENETC_PMAC_OFFSET       0x1000

#define ENETC_PM0_CMD_CFG       0x8008
#define ENETC_PM0_TX_EN         BIT(0)
#define ENETC_PM0_RX_EN         BIT(1)
#define ENETC_PM0_PROMISC       BIT(4)
#define ENETC_PM0_PAUSE_IGN     BIT(8)
#define ENETC_PM0_CMD_XGLP      BIT(10)
#define ENETC_PM0_CMD_TXP       BIT(11)
#define ENETC_PM0_CMD_PHY_TX_EN BIT(15)
#define ENETC_PM0_CMD_SFD       BIT(21)
#define ENETC_PM0_MAXFRM        0x8014
#define ENETC_SET_TX_MTU(val)   ((val) << 16)
#define ENETC_SET_MAXFRM(val)   ((val) & 0xffff)
#define ENETC_PM0_RX_FIFO       0x801c
#define ENETC_PM0_RX_FIFO_VAL   1

#define ENETC_PM_IMDIO_BASE     0x8030

#define ENETC_PM0_PAUSE_QUANTA  0x8054
#define ENETC_PM0_PAUSE_THRESH  0x8064

#define ENETC_PM0_SINGLE_STEP           0x80c0
#define ENETC_PM0_SINGLE_STEP_CH        BIT(7)
#define ENETC_PM0_SINGLE_STEP_EN        BIT(31)
#define ENETC_SET_SINGLE_STEP_OFFSET(v) (((v) & 0xff) << 8)

#define ENETC_PM0_IF_MODE       0x8300
#define ENETC_PM0_IFM_RG        BIT(2)
#define ENETC_PM0_IFM_RLP       (BIT(5) | BIT(11))
#define ENETC_PM0_IFM_EN_AUTO   BIT(15)
#define ENETC_PM0_IFM_SSP_MASK  GENMASK(14, 13)
#define ENETC_PM0_IFM_SSP_1000  (2 << 13)
#define ENETC_PM0_IFM_SSP_100   (0 << 13)
#define ENETC_PM0_IFM_SSP_10    (1 << 13)
#define ENETC_PM0_IFM_FULL_DPX  BIT(12)
#define ENETC_PM0_IFM_IFMODE_MASK GENMASK(1, 0)
#define ENETC_PM0_IFM_IFMODE_XGMII 0
#define ENETC_PM0_IFM_IFMODE_GMII 2
#define ENETC_PSIDCAPR          0x1b08
#define ENETC_PSIDCAPR_MSK      GENMASK(15, 0)
#define ENETC_PSFCAPR           0x1b18
#define ENETC_PSFCAPR_MSK       GENMASK(15, 0)
#define ENETC_PSGCAPR           0x1b28
#define ENETC_PSGCAPR_GCL_MSK   GENMASK(18, 16)
#define ENETC_PSGCAPR_SGIT_MSK  GENMASK(15, 0)
#define ENETC_PFMCAPR           0x1b38
#define ENETC_PFMCAPR_MSK       GENMASK(15, 0)

/* Port MAC counters: Port MAC 0 corresponds to the eMAC and
 * Port MAC 1 to the pMAC.
 */
#define ENETC_PM_REOCT(mac)     (0x8100 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_RALN(mac)      (0x8110 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_RXPF(mac)      (0x8118 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_RFRM(mac)      (0x8120 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_RFCS(mac)      (0x8128 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_RVLAN(mac)     (0x8130 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_RERR(mac)      (0x8138 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_RUCA(mac)      (0x8140 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_RMCA(mac)      (0x8148 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_RBCA(mac)      (0x8150 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_RDRP(mac)      (0x8158 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_RPKT(mac)      (0x8160 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_RUND(mac)      (0x8168 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_R64(mac)       (0x8170 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_R127(mac)      (0x8178 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_R255(mac)      (0x8180 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_R511(mac)      (0x8188 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_R1023(mac)     (0x8190 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_R1522(mac)     (0x8198 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_R1523X(mac)    (0x81A0 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_ROVR(mac)      (0x81A8 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_RJBR(mac)      (0x81B0 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_RFRG(mac)      (0x81B8 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_RCNP(mac)      (0x81C0 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_RDRNTP(mac)    (0x81C8 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_TEOCT(mac)     (0x8200 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_TOCT(mac)      (0x8208 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_TCRSE(mac)     (0x8210 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_TXPF(mac)      (0x8218 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_TFRM(mac)      (0x8220 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_TFCS(mac)      (0x8228 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_TVLAN(mac)     (0x8230 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_TERR(mac)      (0x8238 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_TUCA(mac)      (0x8240 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_TMCA(mac)      (0x8248 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_TBCA(mac)      (0x8250 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_TPKT(mac)      (0x8260 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_TUND(mac)      (0x8268 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_T64(mac)       (0x8270 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_T127(mac)      (0x8278 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_T255(mac)      (0x8280 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_T511(mac)      (0x8288 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_T1023(mac)     (0x8290 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_T1522(mac)     (0x8298 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_T1523X(mac)    (0x82A0 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_TCNP(mac)      (0x82C0 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_TDFR(mac)      (0x82D0 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_TMCOL(mac)     (0x82D8 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_TSCOL(mac)     (0x82E0 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_TLCOL(mac)     (0x82E8 + ENETC_PMAC_OFFSET * (mac))
#define ENETC_PM_TECOL(mac)     (0x82F0 + ENETC_PMAC_OFFSET * (mac))

/* Port counters */
#define ENETC_PICDR(n)          (0x0700 + (n) * 8) /* n = [0..3] */
#define ENETC_PBFDSIR           0x0810
#define ENETC_PFDMSAPR          0x0814
#define ENETC_UFDMF             0x1680
#define ENETC_MFDMF             0x1684
#define ENETC_PUFDVFR           0x1780
#define ENETC_PMFDVFR           0x1784
#define ENETC_PBFDVFR           0x1788

/** Global regs, offset: 2_0000h */
#define ENETC_GLOBAL_BASE       0x20000
#define ENETC_G_EIPBRR0         0x0bf8
#define EIPBRR0_REVISION        GENMASK(15, 0)
#define ENETC_REV_1_0           0x0100
#define ENETC_REV_4_1           0X0401
#define ENETC_REV_4_3           0x0403

#define ENETC_G_EIPBRR1         0x0bfc
#define ENETC_G_EPFBLPR(n)      (0xd00 + 4 * (n))
#define ENETC_G_EPFBLPR1_XGMII  0x80000000

/* PCI device info */
struct enetc_hw {
        /* SI registers, used by all PCI functions */
        void __iomem *reg;
        /* Port registers, PF only */
        void __iomem *port;
        /* IP global registers, PF only */
        void __iomem *global;
};

/* ENETC register accessors */

/* MDIO issue workaround (on LS1028A) -
 * Due to a hardware issue, an access to MDIO registers
 * that is concurrent with other ENETC register accesses
 * may lead to the MDIO access being dropped or corrupted.
 * To protect the MDIO accesses a readers-writers locking
 * scheme is used, where the MDIO register accesses are
 * protected by write locks to insure exclusivity, while
 * the remaining ENETC registers are accessed under read
 * locks since they only compete with MDIO accesses.
 */
extern rwlock_t enetc_mdio_lock;

DECLARE_STATIC_KEY_FALSE(enetc_has_err050089);

/* use this locking primitive only on the fast datapath to
 * group together multiple non-MDIO register accesses to
 * minimize the overhead of the lock
 */
static inline void enetc_lock_mdio(void)
{
        if (static_branch_unlikely(&enetc_has_err050089))
                read_lock(&enetc_mdio_lock);
}

static inline void enetc_unlock_mdio(void)
{
        if (static_branch_unlikely(&enetc_has_err050089))
                read_unlock(&enetc_mdio_lock);
}

/* use these accessors only on the fast datapath under
 * the enetc_lock_mdio() locking primitive to minimize
 * the overhead of the lock
 */
static inline u32 enetc_rd_reg_hot(void __iomem *reg)
{
        if (static_branch_unlikely(&enetc_has_err050089))
                lockdep_assert_held(&enetc_mdio_lock);

        return ioread32(reg);
}

static inline void enetc_wr_reg_hot(void __iomem *reg, u32 val)
{
        if (static_branch_unlikely(&enetc_has_err050089))
                lockdep_assert_held(&enetc_mdio_lock);

        iowrite32(val, reg);
}

/* internal helpers for the MDIO w/a */
static inline u32 _enetc_rd_reg_wa(void __iomem *reg)
{
        u32 val;

        enetc_lock_mdio();
        val = ioread32(reg);
        enetc_unlock_mdio();

        return val;
}

static inline void _enetc_wr_reg_wa(void __iomem *reg, u32 val)
{
        enetc_lock_mdio();
        iowrite32(val, reg);
        enetc_unlock_mdio();
}

static inline u32 _enetc_rd_mdio_reg_wa(void __iomem *reg)
{
        unsigned long flags;
        u32 val;

        if (static_branch_unlikely(&enetc_has_err050089)) {
                write_lock_irqsave(&enetc_mdio_lock, flags);
                val = ioread32(reg);
                write_unlock_irqrestore(&enetc_mdio_lock, flags);
        } else {
                val = ioread32(reg);
        }

        return val;
}

static inline void _enetc_wr_mdio_reg_wa(void __iomem *reg, u32 val)
{
        unsigned long flags;

        if (static_branch_unlikely(&enetc_has_err050089)) {
                write_lock_irqsave(&enetc_mdio_lock, flags);
                iowrite32(val, reg);
                write_unlock_irqrestore(&enetc_mdio_lock, flags);
        } else {
                iowrite32(val, reg);
        }
}

#ifdef ioread64
static inline u64 _enetc_rd_reg64(void __iomem *reg)
{
        return ioread64(reg);
}
#else
/* using this to read out stats on 32b systems */
static inline u64 _enetc_rd_reg64(void __iomem *reg)
{
        u32 low, high, tmp;

        do {
                high = ioread32(reg + 4);
                low = ioread32(reg);
                tmp = ioread32(reg + 4);
        } while (high != tmp);

        return (u64)high << 32 | low;
}
#endif

static inline u64 _enetc_rd_reg64_wa(void __iomem *reg)
{
        u64 val;

        enetc_lock_mdio();
        val = _enetc_rd_reg64(reg);
        enetc_unlock_mdio();

        return val;
}

/* general register accessors */
#define enetc_rd_reg(reg)               _enetc_rd_reg_wa((reg))
#define enetc_wr_reg(reg, val)          _enetc_wr_reg_wa((reg), (val))
#define enetc_rd(hw, off)               enetc_rd_reg((hw)->reg + (off))
#define enetc_wr(hw, off, val)          enetc_wr_reg((hw)->reg + (off), val)
#define enetc_rd_hot(hw, off)           enetc_rd_reg_hot((hw)->reg + (off))
#define enetc_wr_hot(hw, off, val)      enetc_wr_reg_hot((hw)->reg + (off), val)
#define enetc_rd64(hw, off)             _enetc_rd_reg64_wa((hw)->reg + (off))
/* port register accessors - PF only */
#define enetc_port_rd(hw, off)          enetc_rd_reg((hw)->port + (off))
#define enetc_port_wr(hw, off, val)     enetc_wr_reg((hw)->port + (off), val)
#define enetc_port_rd64(hw, off)        _enetc_rd_reg64_wa((hw)->port + (off))
#define enetc_port_rd_mdio(hw, off)     _enetc_rd_mdio_reg_wa((hw)->port + (off))
#define enetc_port_wr_mdio(hw, off, val)        _enetc_wr_mdio_reg_wa(\
                                                        (hw)->port + (off), val)
/* global register accessors - PF only */
#define enetc_global_rd(hw, off)        enetc_rd_reg((hw)->global + (off))
#define enetc_global_wr(hw, off, val)   enetc_wr_reg((hw)->global + (off), val)
/* BDR register accessors, see ENETC_BDR() */
#define enetc_bdr_rd(hw, t, n, off) \
                                enetc_rd(hw, ENETC_BDR(t, n, off))
#define enetc_bdr_wr(hw, t, n, off, val) \
                                enetc_wr(hw, ENETC_BDR(t, n, off), val)
#define enetc_txbdr_rd(hw, n, off) enetc_bdr_rd(hw, TX, n, off)
#define enetc_rxbdr_rd(hw, n, off) enetc_bdr_rd(hw, RX, n, off)
#define enetc_txbdr_wr(hw, n, off, val) \
                                enetc_bdr_wr(hw, TX, n, off, val)
#define enetc_rxbdr_wr(hw, n, off, val) \
                                enetc_bdr_wr(hw, RX, n, off, val)

/* Buffer Descriptors (BD) */
union enetc_tx_bd {
        struct {
                __le64 addr;
                union {
                        __le16 buf_len;
                        __le16 hdr_len; /* For LSO, ENETC 4.1 and later */
                };
                __le16 frm_len;
                union {
                        struct {
                                u8 l3_aux0;
#define ENETC_TX_BD_L3_START    GENMASK(6, 0)
#define ENETC_TX_BD_IPCS        BIT(7)
                                u8 l3_aux1;
#define ENETC_TX_BD_L3_HDR_LEN  GENMASK(6, 0)
#define ENETC_TX_BD_L3T         BIT(7)
                                u8 l4_aux;
#define ENETC_TX_BD_L4T         GENMASK(7, 5)
#define ENETC_TXBD_L4T_UDP      1
#define ENETC_TXBD_L4T_TCP      2
                                u8 flags;
                        }; /* default layout */
                        __le32 txstart;
                        __le32 lstatus;
                };
        };
        struct {
                __le32 tstamp;
                __le16 tpid;
                __le16 vid;
                __le16 lso_sg_size; /* For ENETC 4.1 and later */
                __le16 frm_len_ext; /* For ENETC 4.1 and later */
                u8 reserved[2];
                u8 e_flags;
                u8 flags;
        } ext; /* Tx BD extension */
        struct {
                __le32 tstamp;
                u8 reserved[8];
                __le16 lso_err_count; /* For ENETC 4.1 and later */
                u8 status;
                u8 flags;
        } wb; /* writeback descriptor */
};

enum enetc_txbd_flags {
        ENETC_TXBD_FLAGS_L4CS = BIT(0), /* For ENETC 4.1 and later */
        ENETC_TXBD_FLAGS_TSE = BIT(1),
        ENETC_TXBD_FLAGS_LSO = BIT(1), /* For ENETC 4.1 and later */
        ENETC_TXBD_FLAGS_W = BIT(2),
        ENETC_TXBD_FLAGS_CSUM_LSO = BIT(3), /* For ENETC 4.1 and later */
        ENETC_TXBD_FLAGS_TXSTART = BIT(4),
        ENETC_TXBD_FLAGS_EX = BIT(6),
        ENETC_TXBD_FLAGS_F = BIT(7)
};
#define ENETC_TXBD_STATS_WIN    BIT(7)
#define ENETC_TXBD_TXSTART_MASK GENMASK(24, 0)
#define ENETC_TXBD_FLAGS_OFFSET 24
#define ENETC_TXBD_TSTAMP       GENMASK(29, 0)

static inline __le32 enetc_txbd_set_tx_start(u64 tx_start, u8 flags)
{
        u32 temp;

        temp = (tx_start >> 5 & ENETC_TXBD_TXSTART_MASK) |
               (flags << ENETC_TXBD_FLAGS_OFFSET);

        return cpu_to_le32(temp);
}

static inline void enetc_clear_tx_bd(union enetc_tx_bd *txbd)
{
        memset(txbd, 0, sizeof(*txbd));
}

/* Extension flags */
#define ENETC_TXBD_E_FLAGS_VLAN_INS     BIT(0)
#define ENETC_TXBD_E_FLAGS_ONE_STEP_PTP BIT(1)
#define ENETC_TXBD_E_FLAGS_TWO_STEP_PTP BIT(2)

union enetc_rx_bd {
        struct {
                __le64 addr;
                u8 reserved[8];
        } w;
        struct {
                __le16 inet_csum;
                __le16 parse_summary;
                __le32 rss_hash;
                __le16 buf_len;
                __le16 vlan_opt;
                union {
                        struct {
                                __le16 flags;
                                __le16 error;
                        };
                        __le32 lstatus;
                };
        } r;
        struct {
                __le32 tstamp;
                u8 reserved[12];
        } ext;
};

#define ENETC_RXBD_LSTATUS_R    BIT(30)
#define ENETC_RXBD_LSTATUS_F    BIT(31)
#define ENETC_RXBD_ERR_MASK     0xff
#define ENETC_RXBD_LSTATUS(flags)       ((flags) << 16)
#define ENETC_RXBD_FLAG_VLAN    BIT(9)
#define ENETC_RXBD_FLAG_TSTMP   BIT(10)
#define ENETC_RXBD_FLAG_TPID    GENMASK(1, 0)

#define ENETC_MAC_ADDR_FILT_CNT 8 /* # of supported entries per port */
#define EMETC_MAC_ADDR_FILT_RES 3 /* # of reserved entries at the beginning */
#define ENETC_MAX_NUM_VFS       2

#define ENETC_CBD_FLAGS_SF      BIT(7) /* short format */
#define ENETC_CBD_STATUS_MASK   0xf

#define ENETC_TPID_8021Q        0

struct enetc_cmd_rfse {
        u8 smac_h[6];
        u8 smac_m[6];
        u8 dmac_h[6];
        u8 dmac_m[6];
        __be32 sip_h[4];
        __be32 sip_m[4];
        __be32 dip_h[4];
        __be32 dip_m[4];
        u16 ethtype_h;
        u16 ethtype_m;
        u16 ethtype4_h;
        u16 ethtype4_m;
        u16 sport_h;
        u16 sport_m;
        u16 dport_h;
        u16 dport_m;
        u16 vlan_h;
        u16 vlan_m;
        u8 proto_h;
        u8 proto_m;
        u16 flags;
        u16 result;
        u16 mode;
};

#define ENETC_RFSE_EN   BIT(15)
#define ENETC_RFSE_MODE_BD      2

static inline void enetc_get_primary_mac_addr(struct enetc_hw *hw, u8 *addr)
{
        u32 upper;
        u16 lower;

        upper = __raw_readl(hw->reg + ENETC_SIPMAR0);
        lower = __raw_readl(hw->reg + ENETC_SIPMAR1);

        put_unaligned_le32(upper, addr);
        put_unaligned_le16(lower, addr + 4);
}

static inline void enetc_load_primary_mac_addr(struct enetc_hw *hw,
                                               struct net_device *ndev)
{
        u8 addr[ETH_ALEN];

        enetc_get_primary_mac_addr(hw, addr);
        eth_hw_addr_set(ndev, addr);
}

#define ENETC_SI_INT_IDX        0
/* base index for Rx/Tx interrupts */
#define ENETC_BDR_INT_BASE_IDX  1

/* Messaging */

/* Command completion status */
enum enetc_msg_cmd_status {
        ENETC_MSG_CMD_STATUS_OK,
        ENETC_MSG_CMD_STATUS_FAIL
};

/* VSI-PSI command message types */
enum enetc_msg_cmd_type {
        ENETC_MSG_CMD_MNG_MAC = 1, /* manage MAC address */
        ENETC_MSG_CMD_MNG_RX_MAC_FILTER,/* manage RX MAC table */
        ENETC_MSG_CMD_MNG_RX_VLAN_FILTER /* manage RX VLAN table */
};

/* VSI-PSI command action types */
enum enetc_msg_cmd_action_type {
        ENETC_MSG_CMD_MNG_ADD = 1,
        ENETC_MSG_CMD_MNG_REMOVE
};

/* PSI-VSI command header format */
struct enetc_msg_cmd_header {
        u16 type;       /* command class type */
        u16 id;         /* denotes the specific required action */
};

/* Common H/W utility functions */

static inline void enetc_bdr_enable_rxvlan(struct enetc_hw *hw, int idx,
                                           bool en)
{
        u32 val = enetc_rxbdr_rd(hw, idx, ENETC_RBMR);

        val = (val & ~ENETC_RBMR_VTE) | (en ? ENETC_RBMR_VTE : 0);
        enetc_rxbdr_wr(hw, idx, ENETC_RBMR, val);
}

static inline void enetc_bdr_enable_txvlan(struct enetc_hw *hw, int idx,
                                           bool en)
{
        u32 val = enetc_txbdr_rd(hw, idx, ENETC_TBMR);

        val = (val & ~ENETC_TBMR_VIH) | (en ? ENETC_TBMR_VIH : 0);
        enetc_txbdr_wr(hw, idx, ENETC_TBMR, val);
}

static inline void enetc_set_bdr_prio(struct enetc_hw *hw, int bdr_idx,
                                      int prio)
{
        u32 val = enetc_txbdr_rd(hw, bdr_idx, ENETC_TBMR);

        val &= ~ENETC_TBMR_PRIO_MASK;
        val |= ENETC_TBMR_SET_PRIO(prio);
        enetc_txbdr_wr(hw, bdr_idx, ENETC_TBMR, val);
}

enum bdcr_cmd_class {
        BDCR_CMD_UNSPEC = 0,
        BDCR_CMD_MAC_FILTER,
        BDCR_CMD_VLAN_FILTER,
        BDCR_CMD_RSS,
        BDCR_CMD_RFS,
        BDCR_CMD_PORT_GCL,
        BDCR_CMD_RECV_CLASSIFIER,
        BDCR_CMD_STREAM_IDENTIFY,
        BDCR_CMD_STREAM_FILTER,
        BDCR_CMD_STREAM_GCL,
        BDCR_CMD_FLOW_METER,
        __BDCR_CMD_MAX_LEN,
        BDCR_CMD_MAX_LEN = __BDCR_CMD_MAX_LEN - 1,
};

/* class 5, command 0 */
struct tgs_gcl_conf {
        u8      atc;    /* init gate value */
        u8      res[7];
        struct {
                u8      res1[4];
                __le16  acl_len;
                u8      res2[2];
        };
};

/* gate control list entry */
struct gce {
        __le32  period;
        u8      gate;
        u8      res[3];
};

/* tgs_gcl_conf address point to this data space */
struct tgs_gcl_data {
        __le32          btl;
        __le32          bth;
        __le32          ct;
        __le32          cte;
        struct gce      entry[];
};

/* class 7, command 0, Stream Identity Entry Configuration */
struct streamid_conf {
        __le32  stream_handle;  /* init gate value */
        __le32  iports;
                u8      id_type;
                u8      oui[3];
                u8      res[3];
                u8      en;
};

#define ENETC_CBDR_SID_VID_MASK 0xfff
#define ENETC_CBDR_SID_VIDM BIT(12)
#define ENETC_CBDR_SID_TG_MASK 0xc000
/* streamid_conf address point to this data space */
struct streamid_data {
        union {
                u8 dmac[6];
                u8 smac[6];
        };
        u16     vid_vidm_tg;
};

#define ENETC_CBDR_SFI_PRI_MASK 0x7
#define ENETC_CBDR_SFI_PRIM             BIT(3)
#define ENETC_CBDR_SFI_BLOV             BIT(4)
#define ENETC_CBDR_SFI_BLEN             BIT(5)
#define ENETC_CBDR_SFI_MSDUEN   BIT(6)
#define ENETC_CBDR_SFI_FMITEN   BIT(7)
#define ENETC_CBDR_SFI_ENABLE   BIT(7)
/* class 8, command 0, Stream Filter Instance, Short Format */
struct sfi_conf {
        __le32  stream_handle;
                u8      multi;
                u8      res[2];
                u8      sthm;
        /* Max Service Data Unit or Flow Meter Instance Table index.
         * Depending on the value of FLT this represents either Max
         * Service Data Unit (max frame size) allowed by the filter
         * entry or is an index into the Flow Meter Instance table
         * index identifying the policer which will be used to police
         * it.
         */
        __le16  fm_inst_table_index;
        __le16  msdu;
        __le16  sg_inst_table_index;
                u8      res1[2];
        __le32  input_ports;
                u8      res2[3];
                u8      en;
};

/* class 8, command 2 stream Filter Instance status query short format
 * command no need structure define
 * Stream Filter Instance Query Statistics Response data
 */
struct sfi_counter_data {
        u32 matchl;
        u32 matchh;
        u32 msdu_dropl;
        u32 msdu_droph;
        u32 stream_gate_dropl;
        u32 stream_gate_droph;
        u32 flow_meter_dropl;
        u32 flow_meter_droph;
};

#define ENETC_CBDR_SGI_OIPV_MASK 0x7
#define ENETC_CBDR_SGI_OIPV_EN  BIT(3)
#define ENETC_CBDR_SGI_CGTST    BIT(6)
#define ENETC_CBDR_SGI_OGTST    BIT(7)
#define ENETC_CBDR_SGI_CFG_CHG  BIT(1)
#define ENETC_CBDR_SGI_CFG_PND  BIT(2)
#define ENETC_CBDR_SGI_OEX              BIT(4)
#define ENETC_CBDR_SGI_OEXEN    BIT(5)
#define ENETC_CBDR_SGI_IRX              BIT(6)
#define ENETC_CBDR_SGI_IRXEN    BIT(7)
#define ENETC_CBDR_SGI_ACLLEN_MASK 0x3
#define ENETC_CBDR_SGI_OCLLEN_MASK 0xc
#define ENETC_CBDR_SGI_EN               BIT(7)
/* class 9, command 0, Stream Gate Instance Table, Short Format
 * class 9, command 2, Stream Gate Instance Table entry query write back
 * Short Format
 */
struct sgi_table {
        u8      res[8];
        u8      oipv;
        u8      res0[2];
        u8      ocgtst;
        u8      res1[7];
        u8      gset;
        u8      oacl_len;
        u8      res2[2];
        u8      en;
};

#define ENETC_CBDR_SGI_AIPV_MASK 0x7
#define ENETC_CBDR_SGI_AIPV_EN  BIT(3)
#define ENETC_CBDR_SGI_AGTST    BIT(7)

/* class 9, command 1, Stream Gate Control List, Long Format */
struct sgcl_conf {
        u8      aipv;
        u8      res[2];
        u8      agtst;
        u8      res1[4];
        union {
                struct {
                        u8 res2[4];
                        u8 acl_len;
                        u8 res3[3];
                };
                u8 cct[8]; /* Config change time */
        };
};

#define ENETC_CBDR_SGL_IOMEN    BIT(0)
#define ENETC_CBDR_SGL_IPVEN    BIT(3)
#define ENETC_CBDR_SGL_GTST             BIT(4)
#define ENETC_CBDR_SGL_IPV_MASK 0xe
/* Stream Gate Control List Entry */
struct sgce {
        u32     interval;
        u8      msdu[3];
        u8      multi;
};

/* stream control list class 9 , cmd 1 data buffer */
struct sgcl_data {
        u32             btl;
        u32             bth;
        u32             ct;
        u32             cte;
        struct sgce     sgcl[];
};

#define ENETC_CBDR_FMI_MR       BIT(0)
#define ENETC_CBDR_FMI_MREN     BIT(1)
#define ENETC_CBDR_FMI_DOY      BIT(2)
#define ENETC_CBDR_FMI_CM       BIT(3)
#define ENETC_CBDR_FMI_CF       BIT(4)
#define ENETC_CBDR_FMI_NDOR     BIT(5)
#define ENETC_CBDR_FMI_OALEN    BIT(6)
#define ENETC_CBDR_FMI_IRFPP_MASK GENMASK(4, 0)

/* class 10: command 0/1, Flow Meter Instance Set, short Format */
struct fmi_conf {
        __le32  cir;
        __le32  cbs;
        __le32  eir;
        __le32  ebs;
                u8      conf;
                u8      res1;
                u8      ir_fpp;
                u8      res2[4];
                u8      en;
};

struct enetc_cbd {
        union{
                struct sfi_conf sfi_conf;
                struct sgi_table sgi_table;
                struct fmi_conf fmi_conf;
                struct {
                        __le32  addr[2];
                        union {
                                __le32  opt[4];
                                struct tgs_gcl_conf     gcl_conf;
                                struct streamid_conf    sid_set;
                                struct sgcl_conf        sgcl_conf;
                        };
                };      /* Long format */
                __le32 data[6];
        };
        __le16 index;
        __le16 length;
        u8 cmd;
        u8 cls;
        u8 _res;
        u8 status_flags;
};

#define ENETC_CLK_400M          400000000ULL
#define ENETC_CLK_333M          333000000ULL

static inline u32 enetc_cycles_to_usecs(u32 cycles, u64 clk_freq)
{
        return (u32)div_u64(cycles * 1000000ULL, clk_freq);
}

static inline u32 enetc_usecs_to_cycles(u32 usecs, u64 clk_freq)
{
        return (u32)div_u64(usecs * clk_freq, 1000000ULL);
}

/* Port traffic class frame preemption register */
#define ENETC_PTCFPR(n)                 (0x1910 + (n) * 4) /* n = [0 ..7] */
#define ENETC_PTCFPR_FPE                BIT(31)

/* port time gating control register */
#define ENETC_PTGCR                     0x11a00
#define ENETC_PTGCR_TGE                 BIT(31)
#define ENETC_PTGCR_TGPE                BIT(30)

/* Port time gating capability register */
#define ENETC_PTGCAPR                   0x11a08
#define ENETC_PTGCAPR_MAX_GCL_LEN_MASK  GENMASK(15, 0)

/* Port time specific departure */
#define ENETC_PTCTSDR(n)        (0x1210 + 4 * (n))
#define ENETC_TSDE              BIT(31)

/* PSFP setting */
#define ENETC_PPSFPMR 0x11b00
#define ENETC_PPSFPMR_PSFPEN BIT(0)
#define ENETC_PPSFPMR_VS BIT(1)
#define ENETC_PPSFPMR_PVC BIT(2)
#define ENETC_PPSFPMR_PVZC BIT(3)