Back to home page

OSCL-LXR

 
 

    


0001 /* SPDX-License-Identifier: GPL-2.0-or-later */
0002 /* Applied Micro X-Gene SoC Ethernet Driver
0003  *
0004  * Copyright (c) 2014, Applied Micro Circuits Corporation
0005  * Authors: Iyappan Subramanian <isubramanian@apm.com>
0006  *      Ravi Patel <rapatel@apm.com>
0007  *      Keyur Chudgar <kchudgar@apm.com>
0008  */
0009 
0010 #ifndef __XGENE_ENET_HW_H__
0011 #define __XGENE_ENET_HW_H__
0012 
0013 #include "xgene_enet_main.h"
0014 
0015 struct xgene_enet_pdata;
0016 struct xgene_enet_stats;
0017 struct xgene_enet_desc_ring;
0018 
0019 /* clears and then set bits */
0020 static inline void xgene_set_bits(u32 *dst, u32 val, u32 start, u32 len)
0021 {
0022     u32 end = start + len - 1;
0023     u32 mask = GENMASK(end, start);
0024 
0025     *dst &= ~mask;
0026     *dst |= (val << start) & mask;
0027 }
0028 
0029 static inline u32 xgene_get_bits(u32 val, u32 start, u32 end)
0030 {
0031     return (val & GENMASK(end, start)) >> start;
0032 }
0033 
0034 enum xgene_enet_rm {
0035     RM0,
0036     RM1,
0037     RM3 = 3
0038 };
0039 
0040 #define CSR_RING_ID     0x0008
0041 #define OVERWRITE       BIT(31)
0042 #define IS_BUFFER_POOL      BIT(20)
0043 #define PREFETCH_BUF_EN     BIT(21)
0044 #define CSR_RING_ID_BUF     0x000c
0045 #define CSR_PBM_COAL        0x0014
0046 #define CSR_PBM_CTICK0      0x0018
0047 #define CSR_PBM_CTICK1      0x001c
0048 #define CSR_PBM_CTICK2      0x0020
0049 #define CSR_PBM_CTICK3      0x0024
0050 #define CSR_THRESHOLD0_SET1 0x0030
0051 #define CSR_THRESHOLD1_SET1 0x0034
0052 #define CSR_RING_NE_INT_MODE    0x017c
0053 #define CSR_RING_CONFIG     0x006c
0054 #define CSR_RING_WR_BASE    0x0070
0055 #define NUM_RING_CONFIG     5
0056 #define BUFPOOL_MODE        3
0057 #define INC_DEC_CMD_ADDR    0x002c
0058 #define UDP_HDR_SIZE        2
0059 #define BUF_LEN_CODE_2K     0x5000
0060 
0061 #define CREATE_MASK(pos, len)       GENMASK((pos)+(len)-1, (pos))
0062 #define CREATE_MASK_ULL(pos, len)   GENMASK_ULL((pos)+(len)-1, (pos))
0063 
0064 /* Empty slot soft signature */
0065 #define EMPTY_SLOT_INDEX    1
0066 #define EMPTY_SLOT      ~0ULL
0067 
0068 #define WORK_DESC_SIZE      32
0069 #define BUFPOOL_DESC_SIZE   16
0070 
0071 #define RING_OWNER_MASK     GENMASK(9, 6)
0072 #define RING_BUFNUM_MASK    GENMASK(5, 0)
0073 
0074 #define SELTHRSH_POS        3
0075 #define SELTHRSH_LEN        3
0076 #define RINGADDRL_POS       5
0077 #define RINGADDRL_LEN       27
0078 #define RINGADDRH_POS       0
0079 #define RINGADDRH_LEN       7
0080 #define RINGSIZE_POS        23
0081 #define RINGSIZE_LEN        3
0082 #define RINGTYPE_POS        19
0083 #define RINGTYPE_LEN        2
0084 #define RINGMODE_POS        20
0085 #define RINGMODE_LEN        3
0086 #define RECOMTIMEOUTL_POS   28
0087 #define RECOMTIMEOUTL_LEN   4
0088 #define RECOMTIMEOUTH_POS   0
0089 #define RECOMTIMEOUTH_LEN   3
0090 #define NUMMSGSINQ_POS      1
0091 #define NUMMSGSINQ_LEN      16
0092 #define ACCEPTLERR      BIT(19)
0093 #define QCOHERENT       BIT(4)
0094 #define RECOMBBUF       BIT(27)
0095 
0096 #define MAC_OFFSET          0x30
0097 #define OFFSET_4            0x04
0098 #define OFFSET_8            0x08
0099 
0100 #define BLOCK_ETH_CSR_OFFSET        0x2000
0101 #define BLOCK_ETH_CLE_CSR_OFFSET    0x6000
0102 #define BLOCK_ETH_RING_IF_OFFSET    0x9000
0103 #define BLOCK_ETH_CLKRST_CSR_OFFSET 0xc000
0104 #define BLOCK_ETH_DIAG_CSR_OFFSET   0xD000
0105 #define BLOCK_ETH_MAC_OFFSET        0x0000
0106 #define BLOCK_ETH_STATS_OFFSET      0x0000
0107 #define BLOCK_ETH_MAC_CSR_OFFSET    0x2800
0108 
0109 #define CLKEN_ADDR          0xc208
0110 #define SRST_ADDR           0xc200
0111 
0112 #define MAC_ADDR_REG_OFFSET     0x00
0113 #define MAC_COMMAND_REG_OFFSET      0x04
0114 #define MAC_WRITE_REG_OFFSET        0x08
0115 #define MAC_READ_REG_OFFSET     0x0c
0116 #define MAC_COMMAND_DONE_REG_OFFSET 0x10
0117 
0118 #define STAT_ADDR_REG_OFFSET            0x14
0119 #define STAT_COMMAND_REG_OFFSET         0x18
0120 #define STAT_WRITE_REG_OFFSET           0x1c
0121 #define STAT_READ_REG_OFFSET            0x20
0122 #define STAT_COMMAND_DONE_REG_OFFSET    0x24
0123 
0124 #define PCS_ADDR_REG_OFFSET     0x00
0125 #define PCS_COMMAND_REG_OFFSET      0x04
0126 #define PCS_WRITE_REG_OFFSET        0x08
0127 #define PCS_READ_REG_OFFSET     0x0c
0128 #define PCS_COMMAND_DONE_REG_OFFSET 0x10
0129 
0130 #define MII_MGMT_CONFIG_ADDR        0x20
0131 #define MII_MGMT_COMMAND_ADDR       0x24
0132 #define MII_MGMT_ADDRESS_ADDR       0x28
0133 #define MII_MGMT_CONTROL_ADDR       0x2c
0134 #define MII_MGMT_STATUS_ADDR        0x30
0135 #define MII_MGMT_INDICATORS_ADDR    0x34
0136 
0137 #define BUSY_MASK           BIT(0)
0138 #define READ_CYCLE_MASK         BIT(0)
0139 #define PHY_CONTROL_SET(dst, val)   xgene_set_bits(dst, val, 0, 16)
0140 
0141 #define ENET_SPARE_CFG_REG_ADDR     0x0750
0142 #define RSIF_CONFIG_REG_ADDR        0x0010
0143 #define RSIF_RAM_DBG_REG0_ADDR      0x0048
0144 #define RGMII_REG_0_ADDR        0x07e0
0145 #define CFG_LINK_AGGR_RESUME_0_ADDR 0x07c8
0146 #define DEBUG_REG_ADDR          0x0700
0147 #define CFG_BYPASS_ADDR         0x0294
0148 #define CLE_BYPASS_REG0_0_ADDR      0x0490
0149 #define CLE_BYPASS_REG1_0_ADDR      0x0494
0150 #define CFG_RSIF_FPBUFF_TIMEOUT_EN  BIT(31)
0151 #define RESUME_TX           BIT(0)
0152 #define CFG_SPEED_1250          BIT(24)
0153 #define TX_PORT0            BIT(0)
0154 #define CFG_BYPASS_UNISEC_TX        BIT(2)
0155 #define CFG_BYPASS_UNISEC_RX        BIT(1)
0156 #define CFG_CLE_BYPASS_EN0      BIT(31)
0157 #define CFG_TXCLK_MUXSEL0_SET(dst, val) xgene_set_bits(dst, val, 29, 3)
0158 #define CFG_RXCLK_MUXSEL0_SET(dst, val) xgene_set_bits(dst, val, 26, 3)
0159 
0160 #define CFG_CLE_IP_PROTOCOL0_SET(dst, val)  xgene_set_bits(dst, val, 16, 2)
0161 #define CFG_CLE_IP_HDR_LEN_SET(dst, val)    xgene_set_bits(dst, val, 8, 5)
0162 #define CFG_CLE_DSTQID0_SET(dst, val)       xgene_set_bits(dst, val, 0, 12)
0163 #define CFG_CLE_FPSEL0_SET(dst, val)        xgene_set_bits(dst, val, 16, 4)
0164 #define CFG_CLE_NXTFPSEL0_SET(dst, val)     xgene_set_bits(dst, val, 20, 4)
0165 #define CFG_MACMODE_SET(dst, val)       xgene_set_bits(dst, val, 18, 2)
0166 #define CFG_WAITASYNCRD_SET(dst, val)       xgene_set_bits(dst, val, 0, 16)
0167 #define CFG_CLE_DSTQID0(val)        ((val) & GENMASK(11, 0))
0168 #define CFG_CLE_FPSEL0(val)     (((val) << 16) & GENMASK(19, 16))
0169 #define CSR_ECM_CFG_0_ADDR      0x0220
0170 #define CSR_ECM_CFG_1_ADDR      0x0224
0171 #define CSR_MULTI_DPF0_ADDR     0x0230
0172 #define RXBUF_PAUSE_THRESH      0x0534
0173 #define RXBUF_PAUSE_OFF_THRESH      0x0540
0174 #define DEF_PAUSE_THRES         0x7d
0175 #define DEF_PAUSE_OFF_THRES     0x6d
0176 #define DEF_QUANTA          0x8000
0177 #define NORM_PAUSE_OPCODE       0x0001
0178 #define PAUSE_XON_EN            BIT(30)
0179 #define MULTI_DPF_AUTOCTRL      BIT(28)
0180 #define CFG_CLE_NXTFPSEL0(val)      (((val) << 20) & GENMASK(23, 20))
0181 #define ICM_CONFIG0_REG_0_ADDR      0x0400
0182 #define ICM_CONFIG2_REG_0_ADDR      0x0410
0183 #define ECM_CONFIG0_REG_0_ADDR      0x0500
0184 #define ECM_CONFIG0_REG_1_ADDR      0x0504
0185 #define ICM_ECM_DROP_COUNT_REG0_ADDR    0x0508
0186 #define ICM_ECM_DROP_COUNT_REG1_ADDR    0x050c
0187 #define RX_DV_GATE_REG_0_ADDR       0x05fc
0188 #define TX_DV_GATE_EN0          BIT(2)
0189 #define RX_DV_GATE_EN0          BIT(1)
0190 #define RESUME_RX0          BIT(0)
0191 #define ENET_CFGSSQMIFPRESET_ADDR       0x14
0192 #define ENET_CFGSSQMIWQRESET_ADDR       0x1c
0193 #define ENET_CFGSSQMIWQASSOC_ADDR       0xe0
0194 #define ENET_CFGSSQMIFPQASSOC_ADDR      0xdc
0195 #define ENET_CFGSSQMIQMLITEFPQASSOC_ADDR    0xf0
0196 #define ENET_CFGSSQMIQMLITEWQASSOC_ADDR     0xf4
0197 #define ENET_CFG_MEM_RAM_SHUTDOWN_ADDR      0x70
0198 #define ENET_BLOCK_MEM_RDY_ADDR         0x74
0199 #define MAC_CONFIG_1_ADDR           0x00
0200 #define MAC_CONFIG_2_ADDR           0x04
0201 #define MAX_FRAME_LEN_ADDR          0x10
0202 #define INTERFACE_CONTROL_ADDR          0x38
0203 #define STATION_ADDR0_ADDR          0x40
0204 #define STATION_ADDR1_ADDR          0x44
0205 #define PHY_ADDR_SET(dst, val)          xgene_set_bits(dst, val, 8, 5)
0206 #define REG_ADDR_SET(dst, val)          xgene_set_bits(dst, val, 0, 5)
0207 #define ENET_INTERFACE_MODE2_SET(dst, val)  xgene_set_bits(dst, val, 8, 2)
0208 #define MGMT_CLOCK_SEL_SET(dst, val)        xgene_set_bits(dst, val, 0, 3)
0209 #define SOFT_RESET1         BIT(31)
0210 #define TX_EN               BIT(0)
0211 #define RX_EN               BIT(2)
0212 #define TX_FLOW_EN          BIT(4)
0213 #define RX_FLOW_EN          BIT(5)
0214 #define ENET_LHD_MODE           BIT(25)
0215 #define ENET_GHD_MODE           BIT(26)
0216 #define FULL_DUPLEX2            BIT(0)
0217 #define PAD_CRC             BIT(2)
0218 #define LENGTH_CHK          BIT(4)
0219 
0220 #define TR64_ADDR   0x20
0221 #define TR127_ADDR  0x21
0222 #define TR255_ADDR  0x22
0223 #define TR511_ADDR  0x23
0224 #define TR1K_ADDR   0x24
0225 #define TRMAX_ADDR  0x25
0226 #define TRMGV_ADDR  0x26
0227 
0228 #define RFCS_ADDR   0x29
0229 #define RMCA_ADDR   0x2a
0230 #define RBCA_ADDR   0x2b
0231 #define RXCF_ADDR   0x2c
0232 #define RXPF_ADDR   0x2d
0233 #define RXUO_ADDR   0x2e
0234 #define RALN_ADDR   0x2f
0235 #define RFLR_ADDR   0x30
0236 #define RCDE_ADDR   0x31
0237 #define RCSE_ADDR   0x32
0238 #define RUND_ADDR   0x33
0239 #define ROVR_ADDR   0x34
0240 #define RFRG_ADDR   0x35
0241 #define RJBR_ADDR   0x36
0242 #define RDRP_ADDR   0x37
0243 
0244 #define TMCA_ADDR   0x3a
0245 #define TBCA_ADDR   0x3b
0246 #define TXPF_ADDR   0x3c
0247 #define TDFR_ADDR   0x3d
0248 #define TEDF_ADDR   0x3e
0249 #define TSCL_ADDR   0x3f
0250 #define TMCL_ADDR   0x40
0251 #define TLCL_ADDR   0x41
0252 #define TXCL_ADDR   0x42
0253 #define TNCL_ADDR   0x43
0254 #define TPFH_ADDR   0x44
0255 #define TDRP_ADDR   0x45
0256 #define TJBR_ADDR   0x46
0257 #define TFCS_ADDR   0x47
0258 #define TXCF_ADDR   0x48
0259 #define TOVR_ADDR   0x49
0260 #define TUND_ADDR   0x4a
0261 #define TFRG_ADDR   0x4b
0262 #define DUMP_ADDR   0x27
0263 
0264 #define ECM_DROP_COUNT(src) xgene_get_bits(src, 0, 15)
0265 #define ICM_DROP_COUNT(src) xgene_get_bits(src, 16, 31)
0266 
0267 #define TSO_IPPROTO_TCP         1
0268 
0269 #define USERINFO_POS            0
0270 #define USERINFO_LEN            32
0271 #define FPQNUM_POS          32
0272 #define FPQNUM_LEN          12
0273 #define ELERR_POS                       46
0274 #define ELERR_LEN                       2
0275 #define NV_POS              50
0276 #define NV_LEN              1
0277 #define LL_POS              51
0278 #define LL_LEN              1
0279 #define LERR_POS            60
0280 #define LERR_LEN            3
0281 #define STASH_POS           52
0282 #define STASH_LEN           2
0283 #define BUFDATALEN_POS          48
0284 #define BUFDATALEN_LEN          15
0285 #define DATAADDR_POS            0
0286 #define DATAADDR_LEN            42
0287 #define COHERENT_POS            63
0288 #define HENQNUM_POS         48
0289 #define HENQNUM_LEN         12
0290 #define TYPESEL_POS         44
0291 #define TYPESEL_LEN         4
0292 #define ETHHDR_POS          12
0293 #define ETHHDR_LEN          8
0294 #define IC_POS              35  /* Insert CRC */
0295 #define TCPHDR_POS          0
0296 #define TCPHDR_LEN          6
0297 #define IPHDR_POS           6
0298 #define IPHDR_LEN           6
0299 #define MSS_POS             20
0300 #define MSS_LEN             2
0301 #define EC_POS              22  /* Enable checksum */
0302 #define EC_LEN              1
0303 #define ET_POS              23  /* Enable TSO */
0304 #define IS_POS              24  /* IP protocol select */
0305 #define IS_LEN              1
0306 #define TYPE_ETH_WORK_MESSAGE_POS   44
0307 #define LL_BYTES_MSB_POS        56
0308 #define LL_BYTES_MSB_LEN        8
0309 #define LL_BYTES_LSB_POS        48
0310 #define LL_BYTES_LSB_LEN        12
0311 #define LL_LEN_POS          48
0312 #define LL_LEN_LEN          8
0313 #define DATALEN_MASK            GENMASK(11, 0)
0314 
0315 #define LAST_BUFFER         (0x7800ULL << BUFDATALEN_POS)
0316 
0317 #define TSO_MSS0_POS            0
0318 #define TSO_MSS0_LEN            14
0319 #define TSO_MSS1_POS            16
0320 #define TSO_MSS1_LEN            14
0321 
0322 struct xgene_enet_raw_desc {
0323     __le64 m0;
0324     __le64 m1;
0325     __le64 m2;
0326     __le64 m3;
0327 };
0328 
0329 struct xgene_enet_raw_desc16 {
0330     __le64 m0;
0331     __le64 m1;
0332 };
0333 
0334 static inline void xgene_enet_mark_desc_slot_empty(void *desc_slot_ptr)
0335 {
0336     __le64 *desc_slot = desc_slot_ptr;
0337 
0338     desc_slot[EMPTY_SLOT_INDEX] = cpu_to_le64(EMPTY_SLOT);
0339 }
0340 
0341 static inline bool xgene_enet_is_desc_slot_empty(void *desc_slot_ptr)
0342 {
0343     __le64 *desc_slot = desc_slot_ptr;
0344 
0345     return (desc_slot[EMPTY_SLOT_INDEX] == cpu_to_le64(EMPTY_SLOT));
0346 }
0347 
0348 enum xgene_enet_ring_cfgsize {
0349     RING_CFGSIZE_512B,
0350     RING_CFGSIZE_2KB,
0351     RING_CFGSIZE_16KB,
0352     RING_CFGSIZE_64KB,
0353     RING_CFGSIZE_512KB,
0354     RING_CFGSIZE_INVALID
0355 };
0356 
0357 enum xgene_enet_ring_type {
0358     RING_DISABLED,
0359     RING_REGULAR,
0360     RING_BUFPOOL
0361 };
0362 
0363 enum xgene_ring_owner {
0364     RING_OWNER_ETH0,
0365     RING_OWNER_ETH1,
0366     RING_OWNER_CPU = 15,
0367     RING_OWNER_INVALID
0368 };
0369 
0370 enum xgene_enet_ring_bufnum {
0371     RING_BUFNUM_REGULAR = 0x0,
0372     RING_BUFNUM_BUFPOOL = 0x20,
0373     RING_BUFNUM_INVALID
0374 };
0375 
0376 enum xgene_enet_err_code {
0377     HBF_READ_DATA = 3,
0378     HBF_LL_READ = 4,
0379     BAD_WORK_MSG = 6,
0380     BUFPOOL_TIMEOUT = 15,
0381     INGRESS_CRC = 16,
0382     INGRESS_CHECKSUM = 17,
0383     INGRESS_TRUNC_FRAME = 18,
0384     INGRESS_PKT_LEN = 19,
0385     INGRESS_PKT_UNDER = 20,
0386     INGRESS_FIFO_OVERRUN = 21,
0387     INGRESS_CHECKSUM_COMPUTE = 26,
0388     ERR_CODE_INVALID
0389 };
0390 
0391 static inline enum xgene_ring_owner xgene_enet_ring_owner(u16 id)
0392 {
0393     return (id & RING_OWNER_MASK) >> 6;
0394 }
0395 
0396 static inline u8 xgene_enet_ring_bufnum(u16 id)
0397 {
0398     return id & RING_BUFNUM_MASK;
0399 }
0400 
0401 static inline bool xgene_enet_is_bufpool(u16 id)
0402 {
0403     return ((id & RING_BUFNUM_MASK) >= 0x20) ? true : false;
0404 }
0405 
0406 static inline u8 xgene_enet_get_fpsel(u16 id)
0407 {
0408     if (xgene_enet_is_bufpool(id))
0409         return xgene_enet_ring_bufnum(id) - RING_BUFNUM_BUFPOOL;
0410 
0411     return 0;
0412 }
0413 
0414 static inline u16 xgene_enet_get_numslots(u16 id, u32 size)
0415 {
0416     bool is_bufpool = xgene_enet_is_bufpool(id);
0417 
0418     return (is_bufpool) ? size / BUFPOOL_DESC_SIZE :
0419               size / WORK_DESC_SIZE;
0420 }
0421 
0422 void xgene_enet_parse_error(struct xgene_enet_desc_ring *ring,
0423                 enum xgene_enet_err_code status);
0424 int xgene_enet_mdio_config(struct xgene_enet_pdata *pdata);
0425 void xgene_enet_mdio_remove(struct xgene_enet_pdata *pdata);
0426 bool xgene_ring_mgr_init(struct xgene_enet_pdata *p);
0427 int xgene_enet_phy_connect(struct net_device *ndev);
0428 void xgene_enet_phy_disconnect(struct xgene_enet_pdata *pdata);
0429 u32 xgene_enet_rd_mac(struct xgene_enet_pdata *pdata, u32 rd_addr);
0430 void xgene_enet_wr_mac(struct xgene_enet_pdata *pdata, u32 wr_addr,
0431                u32 wr_data);
0432 u32 xgene_enet_rd_stat(struct xgene_enet_pdata *pdata, u32 rd_addr);
0433 
0434 extern const struct xgene_mac_ops xgene_gmac_ops;
0435 extern const struct xgene_port_ops xgene_gport_ops;
0436 extern struct xgene_ring_ops xgene_ring1_ops;
0437 
0438 #endif /* __XGENE_ENET_HW_H__ */