drivers/net/ethernet/mediatek/mtk_eth_soc.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  *
   4  *   Copyright (C) 2009-2016 John Crispin <blogic@openwrt.org>
   5  *   Copyright (C) 2009-2016 Felix Fietkau <nbd@openwrt.org>
   6  *   Copyright (C) 2013-2016 Michael Lee <igvtee@gmail.com>
   7  */
   8
   9 #ifndef MTK_ETH_H
  10 #define MTK_ETH_H
  11
  12 #include <linux/dma-mapping.h>
  13 #include <linux/netdevice.h>
  14 #include <linux/of_net.h>
  15 #include <linux/u64_stats_sync.h>
  16 #include <linux/refcount.h>
  17 #include <linux/phylink.h>
  18
  19 #define MTK_QDMA_PAGE_SIZE      2048
  20 #define MTK_MAX_RX_LENGTH       1536
  21 #define MTK_TX_DMA_BUF_LEN      0x3fff
  22 #define MTK_DMA_SIZE            256
  23 #define MTK_NAPI_WEIGHT         64
  24 #define MTK_MAC_COUNT           2
  25 #define MTK_RX_ETH_HLEN         (VLAN_ETH_HLEN + VLAN_HLEN + ETH_FCS_LEN)
  26 #define MTK_RX_HLEN             (NET_SKB_PAD + MTK_RX_ETH_HLEN + NET_IP_ALIGN)
  27 #define MTK_DMA_DUMMY_DESC      0xffffffff
  28 #define MTK_DEFAULT_MSG_ENABLE  (NETIF_MSG_DRV | \
  29                                  NETIF_MSG_PROBE | \
  30                                  NETIF_MSG_LINK | \
  31                                  NETIF_MSG_TIMER | \
  32                                  NETIF_MSG_IFDOWN | \
  33                                  NETIF_MSG_IFUP | \
  34                                  NETIF_MSG_RX_ERR | \
  35                                  NETIF_MSG_TX_ERR)
  36 #define MTK_HW_FEATURES         (NETIF_F_IP_CSUM | \
  37                                  NETIF_F_RXCSUM | \
  38                                  NETIF_F_HW_VLAN_CTAG_TX | \
  39                                  NETIF_F_HW_VLAN_CTAG_RX | \
  40                                  NETIF_F_SG | NETIF_F_TSO | \
  41                                  NETIF_F_TSO6 | \
  42                                  NETIF_F_IPV6_CSUM)
  43 #define MTK_HW_FEATURES_MT7628  (NETIF_F_SG | NETIF_F_RXCSUM)
  44 #define NEXT_DESP_IDX(X, Y)     (((X) + 1) & ((Y) - 1))
  45
  46 #define MTK_MAX_RX_RING_NUM     4
  47 #define MTK_HW_LRO_DMA_SIZE     8
  48
  49 #define MTK_MAX_LRO_RX_LENGTH           (4096 * 3)
  50 #define MTK_MAX_LRO_IP_CNT              2
  51 #define MTK_HW_LRO_TIMER_UNIT           1       /* 20 us */
  52 #define MTK_HW_LRO_REFRESH_TIME         50000   /* 1 sec. */
  53 #define MTK_HW_LRO_AGG_TIME             10      /* 200us */
  54 #define MTK_HW_LRO_AGE_TIME             50      /* 1ms */
  55 #define MTK_HW_LRO_MAX_AGG_CNT          64
  56 #define MTK_HW_LRO_BW_THRE              3000
  57 #define MTK_HW_LRO_REPLACE_DELTA        1000
  58 #define MTK_HW_LRO_SDL_REMAIN_ROOM      1522
  59
  60 /* Frame Engine Global Reset Register */
  61 #define MTK_RST_GL              0x04
  62 #define RST_GL_PSE              BIT(0)
  63
  64 /* Frame Engine Interrupt Status Register */
  65 #define MTK_INT_STATUS2         0x08
  66 #define MTK_GDM1_AF             BIT(28)
  67 #define MTK_GDM2_AF             BIT(29)
  68
  69 /* PDMA HW LRO Alter Flow Timer Register */
  70 #define MTK_PDMA_LRO_ALT_REFRESH_TIMER  0x1c
  71
  72 /* Frame Engine Interrupt Grouping Register */
  73 #define MTK_FE_INT_GRP          0x20
  74
  75 /* CDMP Ingress Control Register */
  76 #define MTK_CDMQ_IG_CTRL        0x1400
  77 #define MTK_CDMQ_STAG_EN        BIT(0)
  78
  79 /* CDMP Exgress Control Register */
  80 #define MTK_CDMP_EG_CTRL        0x404
  81
  82 /* GDM Exgress Control Register */
  83 #define MTK_GDMA_FWD_CFG(x)     (0x500 + (x * 0x1000))
  84 #define MTK_GDMA_ICS_EN         BIT(22)
  85 #define MTK_GDMA_TCS_EN         BIT(21)
  86 #define MTK_GDMA_UCS_EN         BIT(20)
  87 #define MTK_GDMA_TO_PDMA        0x0
  88 #define MTK_GDMA_DROP_ALL       0x7777
  89
  90 /* Unicast Filter MAC Address Register - Low */
  91 #define MTK_GDMA_MAC_ADRL(x)    (0x508 + (x * 0x1000))
  92
  93 /* Unicast Filter MAC Address Register - High */
  94 #define MTK_GDMA_MAC_ADRH(x)    (0x50C + (x * 0x1000))
  95
  96 /* PDMA RX Base Pointer Register */
  97 #define MTK_PRX_BASE_PTR0       0x900
  98 #define MTK_PRX_BASE_PTR_CFG(x) (MTK_PRX_BASE_PTR0 + (x * 0x10))
  99
 100 /* PDMA RX Maximum Count Register */
 101 #define MTK_PRX_MAX_CNT0        0x904
 102 #define MTK_PRX_MAX_CNT_CFG(x)  (MTK_PRX_MAX_CNT0 + (x * 0x10))
 103
 104 /* PDMA RX CPU Pointer Register */
 105 #define MTK_PRX_CRX_IDX0        0x908
 106 #define MTK_PRX_CRX_IDX_CFG(x)  (MTK_PRX_CRX_IDX0 + (x * 0x10))
 107
 108 /* PDMA HW LRO Control Registers */
 109 #define MTK_PDMA_LRO_CTRL_DW0   0x980
 110 #define MTK_LRO_EN                      BIT(0)
 111 #define MTK_L3_CKS_UPD_EN               BIT(7)
 112 #define MTK_LRO_ALT_PKT_CNT_MODE        BIT(21)
 113 #define MTK_LRO_RING_RELINQUISH_REQ     (0x7 << 26)
 114 #define MTK_LRO_RING_RELINQUISH_DONE    (0x7 << 29)
 115
 116 #define MTK_PDMA_LRO_CTRL_DW1   0x984
 117 #define MTK_PDMA_LRO_CTRL_DW2   0x988
 118 #define MTK_PDMA_LRO_CTRL_DW3   0x98c
 119 #define MTK_ADMA_MODE           BIT(15)
 120 #define MTK_LRO_MIN_RXD_SDL     (MTK_HW_LRO_SDL_REMAIN_ROOM << 16)
 121
 122 /* PDMA Global Configuration Register */
 123 #define MTK_PDMA_GLO_CFG        0xa04
 124 #define MTK_MULTI_EN            BIT(10)
 125 #define MTK_PDMA_SIZE_8DWORDS   (1 << 4)
 126
 127 /* PDMA Reset Index Register */
 128 #define MTK_PDMA_RST_IDX        0xa08
 129 #define MTK_PST_DRX_IDX0        BIT(16)
 130 #define MTK_PST_DRX_IDX_CFG(x)  (MTK_PST_DRX_IDX0 << (x))
 131
 132 /* PDMA Delay Interrupt Register */
 133 #define MTK_PDMA_DELAY_INT              0xa0c
 134 #define MTK_PDMA_DELAY_RX_EN            BIT(15)
 135 #define MTK_PDMA_DELAY_RX_PINT          4
 136 #define MTK_PDMA_DELAY_RX_PINT_SHIFT    8
 137 #define MTK_PDMA_DELAY_RX_PTIME         4
 138 #define MTK_PDMA_DELAY_RX_DELAY         \
 139         (MTK_PDMA_DELAY_RX_EN | MTK_PDMA_DELAY_RX_PTIME | \
 140         (MTK_PDMA_DELAY_RX_PINT << MTK_PDMA_DELAY_RX_PINT_SHIFT))
 141
 142 /* PDMA Interrupt Status Register */
 143 #define MTK_PDMA_INT_STATUS     0xa20
 144
 145 /* PDMA Interrupt Mask Register */
 146 #define MTK_PDMA_INT_MASK       0xa28
 147
 148 /* PDMA HW LRO Alter Flow Delta Register */
 149 #define MTK_PDMA_LRO_ALT_SCORE_DELTA    0xa4c
 150
 151 /* PDMA Interrupt grouping registers */
 152 #define MTK_PDMA_INT_GRP1       0xa50
 153 #define MTK_PDMA_INT_GRP2       0xa54
 154
 155 /* PDMA HW LRO IP Setting Registers */
 156 #define MTK_LRO_RX_RING0_DIP_DW0        0xb04
 157 #define MTK_LRO_DIP_DW0_CFG(x)          (MTK_LRO_RX_RING0_DIP_DW0 + (x * 0x40))
 158 #define MTK_RING_MYIP_VLD               BIT(9)
 159
 160 /* PDMA HW LRO Ring Control Registers */
 161 #define MTK_LRO_RX_RING0_CTRL_DW1       0xb28
 162 #define MTK_LRO_RX_RING0_CTRL_DW2       0xb2c
 163 #define MTK_LRO_RX_RING0_CTRL_DW3       0xb30
 164 #define MTK_LRO_CTRL_DW1_CFG(x)         (MTK_LRO_RX_RING0_CTRL_DW1 + (x * 0x40))
 165 #define MTK_LRO_CTRL_DW2_CFG(x)         (MTK_LRO_RX_RING0_CTRL_DW2 + (x * 0x40))
 166 #define MTK_LRO_CTRL_DW3_CFG(x)         (MTK_LRO_RX_RING0_CTRL_DW3 + (x * 0x40))
 167 #define MTK_RING_AGE_TIME_L             ((MTK_HW_LRO_AGE_TIME & 0x3ff) << 22)
 168 #define MTK_RING_AGE_TIME_H             ((MTK_HW_LRO_AGE_TIME >> 10) & 0x3f)
 169 #define MTK_RING_AUTO_LERAN_MODE        (3 << 6)
 170 #define MTK_RING_VLD                    BIT(8)
 171 #define MTK_RING_MAX_AGG_TIME           ((MTK_HW_LRO_AGG_TIME & 0xffff) << 10)
 172 #define MTK_RING_MAX_AGG_CNT_L          ((MTK_HW_LRO_MAX_AGG_CNT & 0x3f) << 26)
 173 #define MTK_RING_MAX_AGG_CNT_H          ((MTK_HW_LRO_MAX_AGG_CNT >> 6) & 0x3)
 174
 175 /* QDMA TX Queue Configuration Registers */
 176 #define MTK_QTX_CFG(x)          (0x1800 + (x * 0x10))
 177 #define QDMA_RES_THRES          4
 178
 179 /* QDMA TX Queue Scheduler Registers */
 180 #define MTK_QTX_SCH(x)          (0x1804 + (x * 0x10))
 181
 182 /* QDMA RX Base Pointer Register */
 183 #define MTK_QRX_BASE_PTR0       0x1900
 184
 185 /* QDMA RX Maximum Count Register */
 186 #define MTK_QRX_MAX_CNT0        0x1904
 187
 188 /* QDMA RX CPU Pointer Register */
 189 #define MTK_QRX_CRX_IDX0        0x1908
 190
 191 /* QDMA RX DMA Pointer Register */
 192 #define MTK_QRX_DRX_IDX0        0x190C
 193
 194 /* QDMA Global Configuration Register */
 195 #define MTK_QDMA_GLO_CFG        0x1A04
 196 #define MTK_RX_2B_OFFSET        BIT(31)
 197 #define MTK_RX_BT_32DWORDS      (3 << 11)
 198 #define MTK_NDP_CO_PRO          BIT(10)
 199 #define MTK_TX_WB_DDONE         BIT(6)
 200 #define MTK_DMA_SIZE_16DWORDS   (2 << 4)
 201 #define MTK_RX_DMA_BUSY         BIT(3)
 202 #define MTK_TX_DMA_BUSY         BIT(1)
 203 #define MTK_RX_DMA_EN           BIT(2)
 204 #define MTK_TX_DMA_EN           BIT(0)
 205 #define MTK_DMA_BUSY_TIMEOUT    HZ
 206
 207 /* QDMA Reset Index Register */
 208 #define MTK_QDMA_RST_IDX        0x1A08
 209
 210 /* QDMA Delay Interrupt Register */
 211 #define MTK_QDMA_DELAY_INT      0x1A0C
 212
 213 /* QDMA Flow Control Register */
 214 #define MTK_QDMA_FC_THRES       0x1A10
 215 #define FC_THRES_DROP_MODE      BIT(20)
 216 #define FC_THRES_DROP_EN        (7 << 16)
 217 #define FC_THRES_MIN            0x4444
 218
 219 /* QDMA Interrupt Status Register */
 220 #define MTK_QDMA_INT_STATUS     0x1A18
 221 #define MTK_RX_DONE_DLY         BIT(30)
 222 #define MTK_RX_DONE_INT3        BIT(19)
 223 #define MTK_RX_DONE_INT2        BIT(18)
 224 #define MTK_RX_DONE_INT1        BIT(17)
 225 #define MTK_RX_DONE_INT0        BIT(16)
 226 #define MTK_TX_DONE_INT3        BIT(3)
 227 #define MTK_TX_DONE_INT2        BIT(2)
 228 #define MTK_TX_DONE_INT1        BIT(1)
 229 #define MTK_TX_DONE_INT0        BIT(0)
 230 #define MTK_RX_DONE_INT         MTK_RX_DONE_DLY
 231 #define MTK_TX_DONE_INT         (MTK_TX_DONE_INT0 | MTK_TX_DONE_INT1 | \
 232                                  MTK_TX_DONE_INT2 | MTK_TX_DONE_INT3)
 233
 234 /* QDMA Interrupt grouping registers */
 235 #define MTK_QDMA_INT_GRP1       0x1a20
 236 #define MTK_QDMA_INT_GRP2       0x1a24
 237 #define MTK_RLS_DONE_INT        BIT(0)
 238
 239 /* QDMA Interrupt Status Register */
 240 #define MTK_QDMA_INT_MASK       0x1A1C
 241
 242 /* QDMA Interrupt Mask Register */
 243 #define MTK_QDMA_HRED2          0x1A44
 244
 245 /* QDMA TX Forward CPU Pointer Register */
 246 #define MTK_QTX_CTX_PTR         0x1B00
 247
 248 /* QDMA TX Forward DMA Pointer Register */
 249 #define MTK_QTX_DTX_PTR         0x1B04
 250
 251 /* QDMA TX Release CPU Pointer Register */
 252 #define MTK_QTX_CRX_PTR         0x1B10
 253
 254 /* QDMA TX Release DMA Pointer Register */
 255 #define MTK_QTX_DRX_PTR         0x1B14
 256
 257 /* QDMA FQ Head Pointer Register */
 258 #define MTK_QDMA_FQ_HEAD        0x1B20
 259
 260 /* QDMA FQ Head Pointer Register */
 261 #define MTK_QDMA_FQ_TAIL        0x1B24
 262
 263 /* QDMA FQ Free Page Counter Register */
 264 #define MTK_QDMA_FQ_CNT         0x1B28
 265
 266 /* QDMA FQ Free Page Buffer Length Register */
 267 #define MTK_QDMA_FQ_BLEN        0x1B2C
 268
 269 /* GMA1 Received Good Byte Count Register */
 270 #define MTK_GDM1_TX_GBCNT       0x2400
 271 #define MTK_STAT_OFFSET         0x40
 272
 273 /* QDMA descriptor txd4 */
 274 #define TX_DMA_CHKSUM           (0x7 << 29)
 275 #define TX_DMA_TSO              BIT(28)
 276 #define TX_DMA_FPORT_SHIFT      25
 277 #define TX_DMA_FPORT_MASK       0x7
 278 #define TX_DMA_INS_VLAN         BIT(16)
 279
 280 /* QDMA descriptor txd3 */
 281 #define TX_DMA_OWNER_CPU        BIT(31)
 282 #define TX_DMA_LS0              BIT(30)
 283 #define TX_DMA_PLEN0(_x)        (((_x) & MTK_TX_DMA_BUF_LEN) << 16)
 284 #define TX_DMA_PLEN1(_x)        ((_x) & MTK_TX_DMA_BUF_LEN)
 285 #define TX_DMA_SWC              BIT(14)
 286 #define TX_DMA_SDL(_x)          (((_x) & 0x3fff) << 16)
 287
 288 /* PDMA on MT7628 */
 289 #define TX_DMA_DONE             BIT(31)
 290 #define TX_DMA_LS1              BIT(14)
 291 #define TX_DMA_DESP2_DEF        (TX_DMA_LS0 | TX_DMA_DONE)
 292
 293 /* QDMA descriptor rxd2 */
 294 #define RX_DMA_DONE             BIT(31)
 295 #define RX_DMA_LSO              BIT(30)
 296 #define RX_DMA_PLEN0(_x)        (((_x) & 0x3fff) << 16)
 297 #define RX_DMA_GET_PLEN0(_x)    (((_x) >> 16) & 0x3fff)
 298
 299 /* QDMA descriptor rxd3 */
 300 #define RX_DMA_VID(_x)          ((_x) & 0xfff)
 301
 302 /* QDMA descriptor rxd4 */
 303 #define RX_DMA_L4_VALID         BIT(24)
 304 #define RX_DMA_L4_VALID_PDMA    BIT(30)         /* when PDMA is used */
 305 #define RX_DMA_FPORT_SHIFT      19
 306 #define RX_DMA_FPORT_MASK       0x7
 307
 308 /* PHY Indirect Access Control registers */
 309 #define MTK_PHY_IAC             0x10004
 310 #define PHY_IAC_ACCESS          BIT(31)
 311 #define PHY_IAC_READ            BIT(19)
 312 #define PHY_IAC_WRITE           BIT(18)
 313 #define PHY_IAC_START           BIT(16)
 314 #define PHY_IAC_ADDR_SHIFT      20
 315 #define PHY_IAC_REG_SHIFT       25
 316 #define PHY_IAC_TIMEOUT         HZ
 317
 318 #define MTK_MAC_MISC            0x1000c
 319 #define MTK_MUX_TO_ESW          BIT(0)
 320
 321 /* Mac control registers */
 322 #define MTK_MAC_MCR(x)          (0x10100 + (x * 0x100))
 323 #define MAC_MCR_MAX_RX_1536     BIT(24)
 324 #define MAC_MCR_IPG_CFG         (BIT(18) | BIT(16))
 325 #define MAC_MCR_FORCE_MODE      BIT(15)
 326 #define MAC_MCR_TX_EN           BIT(14)
 327 #define MAC_MCR_RX_EN           BIT(13)
 328 #define MAC_MCR_BACKOFF_EN      BIT(9)
 329 #define MAC_MCR_BACKPR_EN       BIT(8)
 330 #define MAC_MCR_FORCE_RX_FC     BIT(5)
 331 #define MAC_MCR_FORCE_TX_FC     BIT(4)
 332 #define MAC_MCR_SPEED_1000      BIT(3)
 333 #define MAC_MCR_SPEED_100       BIT(2)
 334 #define MAC_MCR_FORCE_DPX       BIT(1)
 335 #define MAC_MCR_FORCE_LINK      BIT(0)
 336 #define MAC_MCR_FORCE_LINK_DOWN (MAC_MCR_FORCE_MODE)
 337
 338 /* Mac status registers */
 339 #define MTK_MAC_MSR(x)          (0x10108 + (x * 0x100))
 340 #define MAC_MSR_EEE1G           BIT(7)
 341 #define MAC_MSR_EEE100M         BIT(6)
 342 #define MAC_MSR_RX_FC           BIT(5)
 343 #define MAC_MSR_TX_FC           BIT(4)
 344 #define MAC_MSR_SPEED_1000      BIT(3)
 345 #define MAC_MSR_SPEED_100       BIT(2)
 346 #define MAC_MSR_SPEED_MASK      (MAC_MSR_SPEED_1000 | MAC_MSR_SPEED_100)
 347 #define MAC_MSR_DPX             BIT(1)
 348 #define MAC_MSR_LINK            BIT(0)
 349
 350 /* TRGMII RXC control register */
 351 #define TRGMII_RCK_CTRL         0x10300
 352 #define DQSI0(x)                ((x << 0) & GENMASK(6, 0))
 353 #define DQSI1(x)                ((x << 8) & GENMASK(14, 8))
 354 #define RXCTL_DMWTLAT(x)        ((x << 16) & GENMASK(18, 16))
 355 #define RXC_RST                 BIT(31)
 356 #define RXC_DQSISEL             BIT(30)
 357 #define RCK_CTRL_RGMII_1000     (RXC_DQSISEL | RXCTL_DMWTLAT(2) | DQSI1(16))
 358 #define RCK_CTRL_RGMII_10_100   RXCTL_DMWTLAT(2)
 359
 360 #define NUM_TRGMII_CTRL         5
 361
 362 /* TRGMII RXC control register */
 363 #define TRGMII_TCK_CTRL         0x10340
 364 #define TXCTL_DMWTLAT(x)        ((x << 16) & GENMASK(18, 16))
 365 #define TXC_INV                 BIT(30)
 366 #define TCK_CTRL_RGMII_1000     TXCTL_DMWTLAT(2)
 367 #define TCK_CTRL_RGMII_10_100   (TXC_INV | TXCTL_DMWTLAT(2))
 368
 369 /* TRGMII TX Drive Strength */
 370 #define TRGMII_TD_ODT(i)        (0x10354 + 8 * (i))
 371 #define  TD_DM_DRVP(x)          ((x) & 0xf)
 372 #define  TD_DM_DRVN(x)          (((x) & 0xf) << 4)
 373
 374 /* TRGMII Interface mode register */
 375 #define INTF_MODE               0x10390
 376 #define TRGMII_INTF_DIS         BIT(0)
 377 #define TRGMII_MODE             BIT(1)
 378 #define TRGMII_CENTRAL_ALIGNED  BIT(2)
 379 #define INTF_MODE_RGMII_1000    (TRGMII_MODE | TRGMII_CENTRAL_ALIGNED)
 380 #define INTF_MODE_RGMII_10_100  0
 381
 382 /* GPIO port control registers for GMAC 2*/
 383 #define GPIO_OD33_CTRL8         0x4c0
 384 #define GPIO_BIAS_CTRL          0xed0
 385 #define GPIO_DRV_SEL10          0xf00
 386
 387 /* ethernet subsystem chip id register */
 388 #define ETHSYS_CHIPID0_3        0x0
 389 #define ETHSYS_CHIPID4_7        0x4
 390 #define MT7623_ETH              7623
 391 #define MT7622_ETH              7622
 392 #define MT7621_ETH              7621
 393
 394 /* ethernet system control register */
 395 #define ETHSYS_SYSCFG           0x10
 396 #define SYSCFG_DRAM_TYPE_DDR2   BIT(4)
 397
 398 /* ethernet subsystem config register */
 399 #define ETHSYS_SYSCFG0          0x14
 400 #define SYSCFG0_GE_MASK         0x3
 401 #define SYSCFG0_GE_MODE(x, y)   (x << (12 + (y * 2)))
 402 #define SYSCFG0_SGMII_MASK     GENMASK(9, 8)
 403 #define SYSCFG0_SGMII_GMAC1    ((2 << 8) & SYSCFG0_SGMII_MASK)
 404 #define SYSCFG0_SGMII_GMAC2    ((3 << 8) & SYSCFG0_SGMII_MASK)
 405 #define SYSCFG0_SGMII_GMAC1_V2 BIT(9)
 406 #define SYSCFG0_SGMII_GMAC2_V2 BIT(8)
 407
 408
 409 /* ethernet subsystem clock register */
 410 #define ETHSYS_CLKCFG0          0x2c
 411 #define ETHSYS_TRGMII_CLK_SEL362_5      BIT(11)
 412 #define ETHSYS_TRGMII_MT7621_MASK       (BIT(5) | BIT(6))
 413 #define ETHSYS_TRGMII_MT7621_APLL       BIT(6)
 414 #define ETHSYS_TRGMII_MT7621_DDR_PLL    BIT(5)
 415
 416 /* ethernet reset control register */
 417 #define ETHSYS_RSTCTRL          0x34
 418 #define RSTCTRL_FE              BIT(6)
 419 #define RSTCTRL_PPE             BIT(31)
 420
 421 /* SGMII subsystem config registers */
 422 /* Register to auto-negotiation restart */
 423 #define SGMSYS_PCS_CONTROL_1    0x0
 424 #define SGMII_AN_RESTART        BIT(9)
 425 #define SGMII_ISOLATE           BIT(10)
 426 #define SGMII_AN_ENABLE         BIT(12)
 427 #define SGMII_LINK_STATYS       BIT(18)
 428 #define SGMII_AN_ABILITY        BIT(19)
 429 #define SGMII_AN_COMPLETE       BIT(21)
 430 #define SGMII_PCS_FAULT         BIT(23)
 431 #define SGMII_AN_EXPANSION_CLR  BIT(30)
 432
 433 /* Register to programmable link timer, the unit in 2 * 8ns */
 434 #define SGMSYS_PCS_LINK_TIMER   0x18
 435 #define SGMII_LINK_TIMER_DEFAULT        (0x186a0 & GENMASK(19, 0))
 436
 437 /* Register to control remote fault */
 438 #define SGMSYS_SGMII_MODE               0x20
 439 #define SGMII_IF_MODE_BIT0              BIT(0)
 440 #define SGMII_SPEED_DUPLEX_AN           BIT(1)
 441 #define SGMII_SPEED_10                  0x0
 442 #define SGMII_SPEED_100                 BIT(2)
 443 #define SGMII_SPEED_1000                BIT(3)
 444 #define SGMII_DUPLEX_FULL               BIT(4)
 445 #define SGMII_IF_MODE_BIT5              BIT(5)
 446 #define SGMII_REMOTE_FAULT_DIS          BIT(8)
 447 #define SGMII_CODE_SYNC_SET_VAL         BIT(9)
 448 #define SGMII_CODE_SYNC_SET_EN          BIT(10)
 449 #define SGMII_SEND_AN_ERROR_EN          BIT(11)
 450 #define SGMII_IF_MODE_MASK              GENMASK(5, 1)
 451
 452 /* Register to set SGMII speed, ANA RG_ Control Signals III*/
 453 #define SGMSYS_ANA_RG_CS3       0x2028
 454 #define RG_PHY_SPEED_MASK       (BIT(2) | BIT(3))
 455 #define RG_PHY_SPEED_1_25G      0x0
 456 #define RG_PHY_SPEED_3_125G     BIT(2)
 457
 458 /* Register to power up QPHY */
 459 #define SGMSYS_QPHY_PWR_STATE_CTRL 0xe8
 460 #define SGMII_PHYA_PWD          BIT(4)
 461
 462 /* Infrasys subsystem config registers */
 463 #define INFRA_MISC2            0x70c
 464 #define CO_QPHY_SEL            BIT(0)
 465 #define GEPHY_MAC_SEL          BIT(1)
 466
 467 /* MT7628/88 specific stuff */
 468 #define MT7628_PDMA_OFFSET      0x0800
 469 #define MT7628_SDM_OFFSET       0x0c00
 470
 471 #define MT7628_TX_BASE_PTR0     (MT7628_PDMA_OFFSET + 0x00)
 472 #define MT7628_TX_MAX_CNT0      (MT7628_PDMA_OFFSET + 0x04)
 473 #define MT7628_TX_CTX_IDX0      (MT7628_PDMA_OFFSET + 0x08)
 474 #define MT7628_TX_DTX_IDX0      (MT7628_PDMA_OFFSET + 0x0c)
 475 #define MT7628_PST_DTX_IDX0     BIT(0)
 476
 477 #define MT7628_SDM_MAC_ADRL     (MT7628_SDM_OFFSET + 0x0c)
 478 #define MT7628_SDM_MAC_ADRH     (MT7628_SDM_OFFSET + 0x10)
 479
 480 struct mtk_rx_dma {
 481         unsigned int rxd1;
 482         unsigned int rxd2;
 483         unsigned int rxd3;
 484         unsigned int rxd4;
 485 } __packed __aligned(4);
 486
 487 struct mtk_tx_dma {
 488         unsigned int txd1;
 489         unsigned int txd2;
 490         unsigned int txd3;
 491         unsigned int txd4;
 492 } __packed __aligned(4);
 493
 494 struct mtk_eth;
 495 struct mtk_mac;
 496
 497 /* struct mtk_hw_stats - the structure that holds the traffic statistics.
 498  * @stats_lock:         make sure that stats operations are atomic
 499  * @reg_offset:         the status register offset of the SoC
 500  * @syncp:              the refcount
 501  *
 502  * All of the supported SoCs have hardware counters for traffic statistics.
 503  * Whenever the status IRQ triggers we can read the latest stats from these
 504  * counters and store them in this struct.
 505  */
 506 struct mtk_hw_stats {
 507         u64 tx_bytes;
 508         u64 tx_packets;
 509         u64 tx_skip;
 510         u64 tx_collisions;
 511         u64 rx_bytes;
 512         u64 rx_packets;
 513         u64 rx_overflow;
 514         u64 rx_fcs_errors;
 515         u64 rx_short_errors;
 516         u64 rx_long_errors;
 517         u64 rx_checksum_errors;
 518         u64 rx_flow_control_packets;
 519
 520         spinlock_t              stats_lock;
 521         u32                     reg_offset;
 522         struct u64_stats_sync   syncp;
 523 };
 524
 525 enum mtk_tx_flags {
 526         /* PDMA descriptor can point at 1-2 segments. This enum allows us to
 527          * track how memory was allocated so that it can be freed properly.
 528          */
 529         MTK_TX_FLAGS_SINGLE0    = 0x01,
 530         MTK_TX_FLAGS_PAGE0      = 0x02,
 531
 532         /* MTK_TX_FLAGS_FPORTx allows tracking which port the transmitted
 533          * SKB out instead of looking up through hardware TX descriptor.
 534          */
 535         MTK_TX_FLAGS_FPORT0     = 0x04,
 536         MTK_TX_FLAGS_FPORT1     = 0x08,
 537 };
 538
 539 /* This enum allows us to identify how the clock is defined on the array of the
 540  * clock in the order
 541  */
 542 enum mtk_clks_map {
 543         MTK_CLK_ETHIF,
 544         MTK_CLK_SGMIITOP,
 545         MTK_CLK_ESW,
 546         MTK_CLK_GP0,
 547         MTK_CLK_GP1,
 548         MTK_CLK_GP2,
 549         MTK_CLK_FE,
 550         MTK_CLK_TRGPLL,
 551         MTK_CLK_SGMII_TX_250M,
 552         MTK_CLK_SGMII_RX_250M,
 553         MTK_CLK_SGMII_CDR_REF,
 554         MTK_CLK_SGMII_CDR_FB,
 555         MTK_CLK_SGMII2_TX_250M,
 556         MTK_CLK_SGMII2_RX_250M,
 557         MTK_CLK_SGMII2_CDR_REF,
 558         MTK_CLK_SGMII2_CDR_FB,
 559         MTK_CLK_SGMII_CK,
 560         MTK_CLK_ETH2PLL,
 561         MTK_CLK_MAX
 562 };
 563
 564 #define MT7623_CLKS_BITMAP      (BIT(MTK_CLK_ETHIF) | BIT(MTK_CLK_ESW) |  \
 565                                  BIT(MTK_CLK_GP1) | BIT(MTK_CLK_GP2) | \
 566                                  BIT(MTK_CLK_TRGPLL))
 567 #define MT7622_CLKS_BITMAP      (BIT(MTK_CLK_ETHIF) | BIT(MTK_CLK_ESW) |  \
 568                                  BIT(MTK_CLK_GP0) | BIT(MTK_CLK_GP1) | \
 569                                  BIT(MTK_CLK_GP2) | \
 570                                  BIT(MTK_CLK_SGMII_TX_250M) | \
 571                                  BIT(MTK_CLK_SGMII_RX_250M) | \
 572                                  BIT(MTK_CLK_SGMII_CDR_REF) | \
 573                                  BIT(MTK_CLK_SGMII_CDR_FB) | \
 574                                  BIT(MTK_CLK_SGMII_CK) | \
 575                                  BIT(MTK_CLK_ETH2PLL))
 576 #define MT7621_CLKS_BITMAP      (0)
 577 #define MT7628_CLKS_BITMAP      (0)
 578 #define MT7629_CLKS_BITMAP      (BIT(MTK_CLK_ETHIF) | BIT(MTK_CLK_ESW) |  \
 579                                  BIT(MTK_CLK_GP0) | BIT(MTK_CLK_GP1) | \
 580                                  BIT(MTK_CLK_GP2) | BIT(MTK_CLK_FE) | \
 581                                  BIT(MTK_CLK_SGMII_TX_250M) | \
 582                                  BIT(MTK_CLK_SGMII_RX_250M) | \
 583                                  BIT(MTK_CLK_SGMII_CDR_REF) | \
 584                                  BIT(MTK_CLK_SGMII_CDR_FB) | \
 585                                  BIT(MTK_CLK_SGMII2_TX_250M) | \
 586                                  BIT(MTK_CLK_SGMII2_RX_250M) | \
 587                                  BIT(MTK_CLK_SGMII2_CDR_REF) | \
 588                                  BIT(MTK_CLK_SGMII2_CDR_FB) | \
 589                                  BIT(MTK_CLK_SGMII_CK) | \
 590                                  BIT(MTK_CLK_ETH2PLL) | BIT(MTK_CLK_SGMIITOP))
 591
 592 enum mtk_dev_state {
 593         MTK_HW_INIT,
 594         MTK_RESETTING
 595 };
 596
 597 /* struct mtk_tx_buf -  This struct holds the pointers to the memory pointed at
 598  *                      by the TX descriptor    s
 599  * @skb:                The SKB pointer of the packet being sent
 600  * @dma_addr0:          The base addr of the first segment
 601  * @dma_len0:           The length of the first segment
 602  * @dma_addr1:          The base addr of the second segment
 603  * @dma_len1:           The length of the second segment
 604  */
 605 struct mtk_tx_buf {
 606         struct sk_buff *skb;
 607         u32 flags;
 608         DEFINE_DMA_UNMAP_ADDR(dma_addr0);
 609         DEFINE_DMA_UNMAP_LEN(dma_len0);
 610         DEFINE_DMA_UNMAP_ADDR(dma_addr1);
 611         DEFINE_DMA_UNMAP_LEN(dma_len1);
 612 };
 613
 614 /* struct mtk_tx_ring - This struct holds info describing a TX ring
 615  * @dma:                The descriptor ring
 616  * @buf:                The memory pointed at by the ring
 617  * @phys:               The physical addr of tx_buf
 618  * @next_free:          Pointer to the next free descriptor
 619  * @last_free:          Pointer to the last free descriptor
 620  * @thresh:             The threshold of minimum amount of free descriptors
 621  * @free_count:         QDMA uses a linked list. Track how many free descriptors
 622  *                      are present
 623  */
 624 struct mtk_tx_ring {
 625         struct mtk_tx_dma *dma;
 626         struct mtk_tx_buf *buf;
 627         dma_addr_t phys;
 628         struct mtk_tx_dma *next_free;
 629         struct mtk_tx_dma *last_free;
 630         u16 thresh;
 631         atomic_t free_count;
 632         int dma_size;
 633         struct mtk_tx_dma *dma_pdma;    /* For MT7628/88 PDMA handling */
 634         dma_addr_t phys_pdma;
 635         int cpu_idx;
 636 };
 637
 638 /* PDMA rx ring mode */
 639 enum mtk_rx_flags {
 640         MTK_RX_FLAGS_NORMAL = 0,
 641         MTK_RX_FLAGS_HWLRO,
 642         MTK_RX_FLAGS_QDMA,
 643 };
 644
 645 /* struct mtk_rx_ring - This struct holds info describing a RX ring
 646  * @dma:                The descriptor ring
 647  * @data:               The memory pointed at by the ring
 648  * @phys:               The physical addr of rx_buf
 649  * @frag_size:          How big can each fragment be
 650  * @buf_size:           The size of each packet buffer
 651  * @calc_idx:           The current head of ring
 652  */
 653 struct mtk_rx_ring {
 654         struct mtk_rx_dma *dma;
 655         u8 **data;
 656         dma_addr_t phys;
 657         u16 frag_size;
 658         u16 buf_size;
 659         u16 dma_size;
 660         bool calc_idx_update;
 661         u16 calc_idx;
 662         u32 crx_idx_reg;
 663 };
 664
 665 enum mkt_eth_capabilities {
 666         MTK_RGMII_BIT = 0,
 667         MTK_TRGMII_BIT,
 668         MTK_SGMII_BIT,
 669         MTK_ESW_BIT,
 670         MTK_GEPHY_BIT,
 671         MTK_MUX_BIT,
 672         MTK_INFRA_BIT,
 673         MTK_SHARED_SGMII_BIT,
 674         MTK_HWLRO_BIT,
 675         MTK_SHARED_INT_BIT,
 676         MTK_TRGMII_MT7621_CLK_BIT,
 677         MTK_QDMA_BIT,
 678         MTK_SOC_MT7628_BIT,
 679
 680         /* MUX BITS*/
 681         MTK_ETH_MUX_GDM1_TO_GMAC1_ESW_BIT,
 682         MTK_ETH_MUX_GMAC2_GMAC0_TO_GEPHY_BIT,
 683         MTK_ETH_MUX_U3_GMAC2_TO_QPHY_BIT,
 684         MTK_ETH_MUX_GMAC1_GMAC2_TO_SGMII_RGMII_BIT,
 685         MTK_ETH_MUX_GMAC12_TO_GEPHY_SGMII_BIT,
 686
 687         /* PATH BITS */
 688         MTK_ETH_PATH_GMAC1_RGMII_BIT,
 689         MTK_ETH_PATH_GMAC1_TRGMII_BIT,
 690         MTK_ETH_PATH_GMAC1_SGMII_BIT,
 691         MTK_ETH_PATH_GMAC2_RGMII_BIT,
 692         MTK_ETH_PATH_GMAC2_SGMII_BIT,
 693         MTK_ETH_PATH_GMAC2_GEPHY_BIT,
 694         MTK_ETH_PATH_GDM1_ESW_BIT,
 695 };
 696
 697 /* Supported hardware group on SoCs */
 698 #define MTK_RGMII               BIT(MTK_RGMII_BIT)
 699 #define MTK_TRGMII              BIT(MTK_TRGMII_BIT)
 700 #define MTK_SGMII               BIT(MTK_SGMII_BIT)
 701 #define MTK_ESW                 BIT(MTK_ESW_BIT)
 702 #define MTK_GEPHY               BIT(MTK_GEPHY_BIT)
 703 #define MTK_MUX                 BIT(MTK_MUX_BIT)
 704 #define MTK_INFRA               BIT(MTK_INFRA_BIT)
 705 #define MTK_SHARED_SGMII        BIT(MTK_SHARED_SGMII_BIT)
 706 #define MTK_HWLRO               BIT(MTK_HWLRO_BIT)
 707 #define MTK_SHARED_INT          BIT(MTK_SHARED_INT_BIT)
 708 #define MTK_TRGMII_MT7621_CLK   BIT(MTK_TRGMII_MT7621_CLK_BIT)
 709 #define MTK_QDMA                BIT(MTK_QDMA_BIT)
 710 #define MTK_SOC_MT7628          BIT(MTK_SOC_MT7628_BIT)
 711
 712 #define MTK_ETH_MUX_GDM1_TO_GMAC1_ESW           \
 713         BIT(MTK_ETH_MUX_GDM1_TO_GMAC1_ESW_BIT)
 714 #define MTK_ETH_MUX_GMAC2_GMAC0_TO_GEPHY        \
 715         BIT(MTK_ETH_MUX_GMAC2_GMAC0_TO_GEPHY_BIT)
 716 #define MTK_ETH_MUX_U3_GMAC2_TO_QPHY            \
 717         BIT(MTK_ETH_MUX_U3_GMAC2_TO_QPHY_BIT)
 718 #define MTK_ETH_MUX_GMAC1_GMAC2_TO_SGMII_RGMII  \
 719         BIT(MTK_ETH_MUX_GMAC1_GMAC2_TO_SGMII_RGMII_BIT)
 720 #define MTK_ETH_MUX_GMAC12_TO_GEPHY_SGMII       \
 721         BIT(MTK_ETH_MUX_GMAC12_TO_GEPHY_SGMII_BIT)
 722
 723 /* Supported path present on SoCs */
 724 #define MTK_ETH_PATH_GMAC1_RGMII        BIT(MTK_ETH_PATH_GMAC1_RGMII_BIT)
 725 #define MTK_ETH_PATH_GMAC1_TRGMII       BIT(MTK_ETH_PATH_GMAC1_TRGMII_BIT)
 726 #define MTK_ETH_PATH_GMAC1_SGMII        BIT(MTK_ETH_PATH_GMAC1_SGMII_BIT)
 727 #define MTK_ETH_PATH_GMAC2_RGMII        BIT(MTK_ETH_PATH_GMAC2_RGMII_BIT)
 728 #define MTK_ETH_PATH_GMAC2_SGMII        BIT(MTK_ETH_PATH_GMAC2_SGMII_BIT)
 729 #define MTK_ETH_PATH_GMAC2_GEPHY        BIT(MTK_ETH_PATH_GMAC2_GEPHY_BIT)
 730 #define MTK_ETH_PATH_GDM1_ESW           BIT(MTK_ETH_PATH_GDM1_ESW_BIT)
 731
 732 #define MTK_GMAC1_RGMII         (MTK_ETH_PATH_GMAC1_RGMII | MTK_RGMII)
 733 #define MTK_GMAC1_TRGMII        (MTK_ETH_PATH_GMAC1_TRGMII | MTK_TRGMII)
 734 #define MTK_GMAC1_SGMII         (MTK_ETH_PATH_GMAC1_SGMII | MTK_SGMII)
 735 #define MTK_GMAC2_RGMII         (MTK_ETH_PATH_GMAC2_RGMII | MTK_RGMII)
 736 #define MTK_GMAC2_SGMII         (MTK_ETH_PATH_GMAC2_SGMII | MTK_SGMII)
 737 #define MTK_GMAC2_GEPHY         (MTK_ETH_PATH_GMAC2_GEPHY | MTK_GEPHY)
 738 #define MTK_GDM1_ESW            (MTK_ETH_PATH_GDM1_ESW | MTK_ESW)
 739
 740 /* MUXes present on SoCs */
 741 /* 0: GDM1 -> GMAC1, 1: GDM1 -> ESW */
 742 #define MTK_MUX_GDM1_TO_GMAC1_ESW (MTK_ETH_MUX_GDM1_TO_GMAC1_ESW | MTK_MUX)
 743
 744 /* 0: GMAC2 -> GEPHY, 1: GMAC0 -> GePHY */
 745 #define MTK_MUX_GMAC2_GMAC0_TO_GEPHY    \
 746         (MTK_ETH_MUX_GMAC2_GMAC0_TO_GEPHY | MTK_MUX | MTK_INFRA)
 747
 748 /* 0: U3 -> QPHY, 1: GMAC2 -> QPHY */
 749 #define MTK_MUX_U3_GMAC2_TO_QPHY        \
 750         (MTK_ETH_MUX_U3_GMAC2_TO_QPHY | MTK_MUX | MTK_INFRA)
 751
 752 /* 2: GMAC1 -> SGMII, 3: GMAC2 -> SGMII */
 753 #define MTK_MUX_GMAC1_GMAC2_TO_SGMII_RGMII      \
 754         (MTK_ETH_MUX_GMAC1_GMAC2_TO_SGMII_RGMII | MTK_MUX | \
 755         MTK_SHARED_SGMII)
 756
 757 /* 0: GMACx -> GEPHY, 1: GMACx -> SGMII where x is 1 or 2 */
 758 #define MTK_MUX_GMAC12_TO_GEPHY_SGMII   \
 759         (MTK_ETH_MUX_GMAC12_TO_GEPHY_SGMII | MTK_MUX)
 760
 761 #define MTK_HAS_CAPS(caps, _x)          (((caps) & (_x)) == (_x))
 762
 763 #define MT7621_CAPS  (MTK_GMAC1_RGMII | MTK_GMAC1_TRGMII | \
 764                       MTK_GMAC2_RGMII | MTK_SHARED_INT | \
 765                       MTK_TRGMII_MT7621_CLK | MTK_QDMA)
 766
 767 #define MT7622_CAPS  (MTK_GMAC1_RGMII | MTK_GMAC1_SGMII | MTK_GMAC2_RGMII | \
 768                       MTK_GMAC2_SGMII | MTK_GDM1_ESW | \
 769                       MTK_MUX_GDM1_TO_GMAC1_ESW | \
 770                       MTK_MUX_GMAC1_GMAC2_TO_SGMII_RGMII | MTK_QDMA)
 771
 772 #define MT7623_CAPS  (MTK_GMAC1_RGMII | MTK_GMAC1_TRGMII | MTK_GMAC2_RGMII | \
 773                       MTK_QDMA)
 774
 775 #define MT7628_CAPS  (MTK_SHARED_INT | MTK_SOC_MT7628)
 776
 777 #define MT7629_CAPS  (MTK_GMAC1_SGMII | MTK_GMAC2_SGMII | MTK_GMAC2_GEPHY | \
 778                       MTK_GDM1_ESW | MTK_MUX_GDM1_TO_GMAC1_ESW | \
 779                       MTK_MUX_GMAC2_GMAC0_TO_GEPHY | \
 780                       MTK_MUX_U3_GMAC2_TO_QPHY | \
 781                       MTK_MUX_GMAC12_TO_GEPHY_SGMII | MTK_QDMA)
 782
 783 /* struct mtk_eth_data -        This is the structure holding all differences
 784  *                              among various plaforms
 785  * @ana_rgc3:                   The offset for register ANA_RGC3 related to
 786  *                              sgmiisys syscon
 787  * @caps                        Flags shown the extra capability for the SoC
 788  * @hw_features                 Flags shown HW features
 789  * @required_clks               Flags shown the bitmap for required clocks on
 790  *                              the target SoC
 791  * @required_pctl               A bool value to show whether the SoC requires
 792  *                              the extra setup for those pins used by GMAC.
 793  */
 794 struct mtk_soc_data {
 795         u32             ana_rgc3;
 796         u32             caps;
 797         u32             required_clks;
 798         bool            required_pctl;
 799         netdev_features_t hw_features;
 800 };
 801
 802 /* currently no SoC has more than 2 macs */
 803 #define MTK_MAX_DEVS                    2
 804
 805 #define MTK_SGMII_PHYSPEED_AN          BIT(31)
 806 #define MTK_SGMII_PHYSPEED_MASK        GENMASK(2, 0)
 807 #define MTK_SGMII_PHYSPEED_1000        BIT(0)
 808 #define MTK_SGMII_PHYSPEED_2500        BIT(1)
 809 #define MTK_HAS_FLAGS(flags, _x)       (((flags) & (_x)) == (_x))
 810
 811 /* struct mtk_sgmii -  This is the structure holding sgmii regmap and its
 812  *                     characteristics
 813  * @regmap:            The register map pointing at the range used to setup
 814  *                     SGMII modes
 815  * @flags:             The enum refers to which mode the sgmii wants to run on
 816  * @ana_rgc3:          The offset refers to register ANA_RGC3 related to regmap
 817  */
 818
 819 struct mtk_sgmii {
 820         struct regmap   *regmap[MTK_MAX_DEVS];
 821         u32             flags[MTK_MAX_DEVS];
 822         u32             ana_rgc3;
 823 };
 824
 825 /* struct mtk_eth -     This is the main datasructure for holding the state
 826  *                      of the driver
 827  * @dev:                The device pointer
 828  * @base:               The mapped register i/o base
 829  * @page_lock:          Make sure that register operations are atomic
 830  * @tx_irq__lock:       Make sure that IRQ register operations are atomic
 831  * @rx_irq__lock:       Make sure that IRQ register operations are atomic
 832  * @dummy_dev:          we run 2 netdevs on 1 physical DMA ring and need a
 833  *                      dummy for NAPI to work
 834  * @netdev:             The netdev instances
 835  * @mac:                Each netdev is linked to a physical MAC
 836  * @irq:                The IRQ that we are using
 837  * @msg_enable:         Ethtool msg level
 838  * @ethsys:             The register map pointing at the range used to setup
 839  *                      MII modes
 840  * @infra:              The register map pointing at the range used to setup
 841  *                      SGMII and GePHY path
 842  * @pctl:               The register map pointing at the range used to setup
 843  *                      GMAC port drive/slew values
 844  * @dma_refcnt:         track how many netdevs are using the DMA engine
 845  * @tx_ring:            Pointer to the memory holding info about the TX ring
 846  * @rx_ring:            Pointer to the memory holding info about the RX ring
 847  * @rx_ring_qdma:       Pointer to the memory holding info about the QDMA RX ring
 848  * @tx_napi:            The TX NAPI struct
 849  * @rx_napi:            The RX NAPI struct
 850  * @scratch_ring:       Newer SoCs need memory for a second HW managed TX ring
 851  * @phy_scratch_ring:   physical address of scratch_ring
 852  * @scratch_head:       The scratch memory that scratch_ring points to.
 853  * @clks:               clock array for all clocks required
 854  * @mii_bus:            If there is a bus we need to create an instance for it
 855  * @pending_work:       The workqueue used to reset the dma ring
 856  * @state:              Initialization and runtime state of the device
 857  * @soc:                Holding specific data among vaious SoCs
 858  */
 859
 860 struct mtk_eth {
 861         struct device                   *dev;
 862         void __iomem                    *base;
 863         spinlock_t                      page_lock;
 864         spinlock_t                      tx_irq_lock;
 865         spinlock_t                      rx_irq_lock;
 866         struct net_device               dummy_dev;
 867         struct net_device               *netdev[MTK_MAX_DEVS];
 868         struct mtk_mac                  *mac[MTK_MAX_DEVS];
 869         int                             irq[3];
 870         u32                             msg_enable;
 871         unsigned long                   sysclk;
 872         struct regmap                   *ethsys;
 873         struct regmap                   *infra;
 874         struct mtk_sgmii                *sgmii;
 875         struct regmap                   *pctl;
 876         bool                            hwlro;
 877         refcount_t                      dma_refcnt;
 878         struct mtk_tx_ring              tx_ring;
 879         struct mtk_rx_ring              rx_ring[MTK_MAX_RX_RING_NUM];
 880         struct mtk_rx_ring              rx_ring_qdma;
 881         struct napi_struct              tx_napi;
 882         struct napi_struct              rx_napi;
 883         struct mtk_tx_dma               *scratch_ring;
 884         dma_addr_t                      phy_scratch_ring;
 885         void                            *scratch_head;
 886         struct clk                      *clks[MTK_CLK_MAX];
 887
 888         struct mii_bus                  *mii_bus;
 889         struct work_struct              pending_work;
 890         unsigned long                   state;
 891
 892         const struct mtk_soc_data       *soc;
 893
 894         u32                             tx_int_mask_reg;
 895         u32                             tx_int_status_reg;
 896         u32                             rx_dma_l4_valid;
 897         int                             ip_align;
 898 };
 899
 900 /* struct mtk_mac -     the structure that holds the info about the MACs of the
 901  *                      SoC
 902  * @id:                 The number of the MAC
 903  * @interface:          Interface mode kept for detecting change in hw settings
 904  * @of_node:            Our devicetree node
 905  * @hw:                 Backpointer to our main datastruture
 906  * @hw_stats:           Packet statistics counter
 907  */
 908 struct mtk_mac {
 909         int                             id;
 910         phy_interface_t                 interface;
 911         unsigned int                    mode;
 912         int                             speed;
 913         struct device_node              *of_node;
 914         struct phylink                  *phylink;
 915         struct phylink_config           phylink_config;
 916         struct mtk_eth                  *hw;
 917         struct mtk_hw_stats             *hw_stats;
 918         __be32                          hwlro_ip[MTK_MAX_LRO_IP_CNT];
 919         int                             hwlro_ip_cnt;
 920 };
 921
 922 /* the struct describing the SoC. these are declared in the soc_xyz.c files */
 923 extern const struct of_device_id of_mtk_match[];
 924
 925 /* read the hardware status register */
 926 void mtk_stats_update_mac(struct mtk_mac *mac);
 927
 928 void mtk_w32(struct mtk_eth *eth, u32 val, unsigned reg);
 929 u32 mtk_r32(struct mtk_eth *eth, unsigned reg);
 930
 931 int mtk_sgmii_init(struct mtk_sgmii *ss, struct device_node *np,
 932                    u32 ana_rgc3);
 933 int mtk_sgmii_setup_mode_an(struct mtk_sgmii *ss, int id);
 934 int mtk_sgmii_setup_mode_force(struct mtk_sgmii *ss, int id,
 935                                const struct phylink_link_state *state);
 936 void mtk_sgmii_restart_an(struct mtk_eth *eth, int mac_id);
 937
 938 int mtk_gmac_sgmii_path_setup(struct mtk_eth *eth, int mac_id);
 939 int mtk_gmac_gephy_path_setup(struct mtk_eth *eth, int mac_id);
 940 int mtk_gmac_rgmii_path_setup(struct mtk_eth *eth, int mac_id);
 941
 942 #endif /* MTK_ETH_H */