drivers/net/dsa/mt7530.h

   1 /*
   2  * Copyright (C) 2017 Sean Wang <sean.wang@mediatek.com>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License version 2 as
   6  * published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  */
  13
  14 #ifndef __MT7530_H
  15 #define __MT7530_H
  16
  17 #define MT7530_NUM_PORTS                7
  18 #define MT7530_CPU_PORT                 6
  19 #define MT7530_NUM_FDB_RECORDS          2048
  20 #define MT7530_ALL_MEMBERS              0xff
  21
  22 #define NUM_TRGMII_CTRL                 5
  23
  24 #define TRGMII_BASE(x)                  (0x10000 + (x))
  25
  26 /* Registers to ethsys access */
  27 #define ETHSYS_CLKCFG0                  0x2c
  28 #define  ETHSYS_TRGMII_CLK_SEL362_5     BIT(11)
  29
  30 #define SYSC_REG_RSTCTRL                0x34
  31 #define  RESET_MCM                      BIT(2)
  32
  33 /* Registers to mac forward control for unknown frames */
  34 #define MT7530_MFC                      0x10
  35 #define  BC_FFP(x)                      (((x) & 0xff) << 24)
  36 #define  UNM_FFP(x)                     (((x) & 0xff) << 16)
  37 #define  UNM_FFP_MASK                   UNM_FFP(~0)
  38 #define  UNU_FFP(x)                     (((x) & 0xff) << 8)
  39 #define  UNU_FFP_MASK                   UNU_FFP(~0)
  40
  41 /* Registers for address table access */
  42 #define MT7530_ATA1                     0x74
  43 #define  STATIC_EMP                     0
  44 #define  STATIC_ENT                     3
  45 #define MT7530_ATA2                     0x78
  46
  47 /* Register for address table write data */
  48 #define MT7530_ATWD                     0x7c
  49
  50 /* Register for address table control */
  51 #define MT7530_ATC                      0x80
  52 #define  ATC_HASH                       (((x) & 0xfff) << 16)
  53 #define  ATC_BUSY                       BIT(15)
  54 #define  ATC_SRCH_END                   BIT(14)
  55 #define  ATC_SRCH_HIT                   BIT(13)
  56 #define  ATC_INVALID                    BIT(12)
  57 #define  ATC_MAT(x)                     (((x) & 0xf) << 8)
  58 #define  ATC_MAT_MACTAB                 ATC_MAT(0)
  59
  60 enum mt7530_fdb_cmd {
  61         MT7530_FDB_READ = 0,
  62         MT7530_FDB_WRITE = 1,
  63         MT7530_FDB_FLUSH = 2,
  64         MT7530_FDB_START = 4,
  65         MT7530_FDB_NEXT = 5,
  66 };
  67
  68 /* Registers for table search read address */
  69 #define MT7530_TSRA1                    0x84
  70 #define  MAC_BYTE_0                     24
  71 #define  MAC_BYTE_1                     16
  72 #define  MAC_BYTE_2                     8
  73 #define  MAC_BYTE_3                     0
  74 #define  MAC_BYTE_MASK                  0xff
  75
  76 #define MT7530_TSRA2                    0x88
  77 #define  MAC_BYTE_4                     24
  78 #define  MAC_BYTE_5                     16
  79 #define  CVID                           0
  80 #define  CVID_MASK                      0xfff
  81
  82 #define MT7530_ATRD                     0x8C
  83 #define  AGE_TIMER                      24
  84 #define  AGE_TIMER_MASK                 0xff
  85 #define  PORT_MAP                       4
  86 #define  PORT_MAP_MASK                  0xff
  87 #define  ENT_STATUS                     2
  88 #define  ENT_STATUS_MASK                0x3
  89
  90 /* Register for vlan table control */
  91 #define MT7530_VTCR                     0x90
  92 #define  VTCR_BUSY                      BIT(31)
  93 #define  VTCR_INVALID                   BIT(16)
  94 #define  VTCR_FUNC(x)                   (((x) & 0xf) << 12)
  95 #define  VTCR_VID                       ((x) & 0xfff)
  96
  97 enum mt7530_vlan_cmd {
  98         /* Read/Write the specified VID entry from VAWD register based
  99          * on VID.
 100          */
 101         MT7530_VTCR_RD_VID = 0,
 102         MT7530_VTCR_WR_VID = 1,
 103 };
 104
 105 /* Register for setup vlan and acl write data */
 106 #define MT7530_VAWD1                    0x94
 107 #define  PORT_STAG                      BIT(31)
 108 /* Independent VLAN Learning */
 109 #define  IVL_MAC                        BIT(30)
 110 /* Per VLAN Egress Tag Control */
 111 #define  VTAG_EN                        BIT(28)
 112 /* VLAN Member Control */
 113 #define  PORT_MEM(x)                    (((x) & 0xff) << 16)
 114 /* VLAN Entry Valid */
 115 #define  VLAN_VALID                     BIT(0)
 116 #define  PORT_MEM_SHFT                  16
 117 #define  PORT_MEM_MASK                  0xff
 118
 119 #define MT7530_VAWD2                    0x98
 120 /* Egress Tag Control */
 121 #define  ETAG_CTRL_P(p, x)              (((x) & 0x3) << ((p) << 1))
 122 #define  ETAG_CTRL_P_MASK(p)            ETAG_CTRL_P(p, 3)
 123
 124 enum mt7530_vlan_egress_attr {
 125         MT7530_VLAN_EGRESS_UNTAG = 0,
 126         MT7530_VLAN_EGRESS_TAG = 2,
 127         MT7530_VLAN_EGRESS_STACK = 3,
 128 };
 129
 130 /* Register for port STP state control */
 131 #define MT7530_SSP_P(x)                 (0x2000 + ((x) * 0x100))
 132 #define  FID_PST(x)                     ((x) & 0x3)
 133 #define  FID_PST_MASK                   FID_PST(0x3)
 134
 135 enum mt7530_stp_state {
 136         MT7530_STP_DISABLED = 0,
 137         MT7530_STP_BLOCKING = 1,
 138         MT7530_STP_LISTENING = 1,
 139         MT7530_STP_LEARNING = 2,
 140         MT7530_STP_FORWARDING  = 3
 141 };
 142
 143 /* Register for port control */
 144 #define MT7530_PCR_P(x)                 (0x2004 + ((x) * 0x100))
 145 #define  PORT_VLAN(x)                   ((x) & 0x3)
 146
 147 enum mt7530_port_mode {
 148         /* Port Matrix Mode: Frames are forwarded by the PCR_MATRIX members. */
 149         MT7530_PORT_MATRIX_MODE = PORT_VLAN(0),
 150
 151         /* Fallback Mode: Forward received frames with ingress ports that do
 152          * not belong to the VLAN member. Frames whose VID is not listed on
 153          * the VLAN table are forwarded by the PCR_MATRIX members.
 154          */
 155         MT7530_PORT_FALLBACK_MODE = PORT_VLAN(1),
 156
 157         /* Security Mode: Discard any frame due to ingress membership
 158          * violation or VID missed on the VLAN table.
 159          */
 160         MT7530_PORT_SECURITY_MODE = PORT_VLAN(3),
 161 };
 162
 163 #define  PCR_MATRIX(x)                  (((x) & 0xff) << 16)
 164 #define  PORT_PRI(x)                    (((x) & 0x7) << 24)
 165 #define  EG_TAG(x)                      (((x) & 0x3) << 28)
 166 #define  PCR_MATRIX_MASK                PCR_MATRIX(0xff)
 167 #define  PCR_MATRIX_CLR                 PCR_MATRIX(0)
 168 #define  PCR_PORT_VLAN_MASK             PORT_VLAN(3)
 169
 170 /* Register for port security control */
 171 #define MT7530_PSC_P(x)                 (0x200c + ((x) * 0x100))
 172 #define  SA_DIS                         BIT(4)
 173
 174 /* Register for port vlan control */
 175 #define MT7530_PVC_P(x)                 (0x2010 + ((x) * 0x100))
 176 #define  PORT_SPEC_TAG                  BIT(5)
 177 #define  PVC_EG_TAG(x)                  (((x) & 0x7) << 8)
 178 #define  PVC_EG_TAG_MASK                PVC_EG_TAG(7)
 179 #define  VLAN_ATTR(x)                   (((x) & 0x3) << 6)
 180 #define  VLAN_ATTR_MASK                 VLAN_ATTR(3)
 181
 182 enum mt7530_vlan_port_eg_tag {
 183         MT7530_VLAN_EG_DISABLED = 0,
 184         MT7530_VLAN_EG_CONSISTENT = 1,
 185 };
 186
 187 enum mt7530_vlan_port_attr {
 188         MT7530_VLAN_USER = 0,
 189         MT7530_VLAN_TRANSPARENT = 3,
 190 };
 191
 192 #define  STAG_VPID                      (((x) & 0xffff) << 16)
 193
 194 /* Register for port port-and-protocol based vlan 1 control */
 195 #define MT7530_PPBV1_P(x)               (0x2014 + ((x) * 0x100))
 196 #define  G0_PORT_VID(x)                 (((x) & 0xfff) << 0)
 197 #define  G0_PORT_VID_MASK               G0_PORT_VID(0xfff)
 198 #define  G0_PORT_VID_DEF                G0_PORT_VID(1)
 199
 200 /* Register for port MAC control register */
 201 #define MT7530_PMCR_P(x)                (0x3000 + ((x) * 0x100))
 202 #define  PMCR_IFG_XMIT(x)               (((x) & 0x3) << 18)
 203 #define  PMCR_MAC_MODE                  BIT(16)
 204 #define  PMCR_FORCE_MODE                BIT(15)
 205 #define  PMCR_TX_EN                     BIT(14)
 206 #define  PMCR_RX_EN                     BIT(13)
 207 #define  PMCR_BACKOFF_EN                BIT(9)
 208 #define  PMCR_BACKPR_EN                 BIT(8)
 209 #define  PMCR_TX_FC_EN                  BIT(5)
 210 #define  PMCR_RX_FC_EN                  BIT(4)
 211 #define  PMCR_FORCE_SPEED_1000          BIT(3)
 212 #define  PMCR_FORCE_SPEED_100           BIT(2)
 213 #define  PMCR_FORCE_FDX                 BIT(1)
 214 #define  PMCR_FORCE_LNK                 BIT(0)
 215 #define  PMCR_COMMON_LINK               (PMCR_IFG_XMIT(1) | PMCR_MAC_MODE | \
 216                                          PMCR_BACKOFF_EN | PMCR_BACKPR_EN | \
 217                                          PMCR_TX_EN | PMCR_RX_EN | \
 218                                          PMCR_TX_FC_EN | PMCR_RX_FC_EN)
 219 #define  PMCR_CPUP_LINK                 (PMCR_COMMON_LINK | PMCR_FORCE_MODE | \
 220                                          PMCR_FORCE_SPEED_1000 | \
 221                                          PMCR_FORCE_FDX | \
 222                                          PMCR_FORCE_LNK)
 223 #define  PMCR_USERP_LINK                PMCR_COMMON_LINK
 224 #define  PMCR_FIXED_LINK                (PMCR_IFG_XMIT(1) | PMCR_MAC_MODE | \
 225                                          PMCR_FORCE_MODE | PMCR_TX_EN | \
 226                                          PMCR_RX_EN | PMCR_BACKPR_EN | \
 227                                          PMCR_BACKOFF_EN | \
 228                                          PMCR_FORCE_SPEED_1000 | \
 229                                          PMCR_FORCE_FDX | \
 230                                          PMCR_FORCE_LNK)
 231 #define PMCR_FIXED_LINK_FC              (PMCR_FIXED_LINK | \
 232                                          PMCR_TX_FC_EN | PMCR_RX_FC_EN)
 233
 234 #define MT7530_PMSR_P(x)                (0x3008 + (x) * 0x100)
 235
 236 /* Register for MIB */
 237 #define MT7530_PORT_MIB_COUNTER(x)      (0x4000 + (x) * 0x100)
 238 #define MT7530_MIB_CCR                  0x4fe0
 239 #define  CCR_MIB_ENABLE                 BIT(31)
 240 #define  CCR_RX_OCT_CNT_GOOD            BIT(7)
 241 #define  CCR_RX_OCT_CNT_BAD             BIT(6)
 242 #define  CCR_TX_OCT_CNT_GOOD            BIT(5)
 243 #define  CCR_TX_OCT_CNT_BAD             BIT(4)
 244 #define  CCR_MIB_FLUSH                  (CCR_RX_OCT_CNT_GOOD | \
 245                                          CCR_RX_OCT_CNT_BAD | \
 246                                          CCR_TX_OCT_CNT_GOOD | \
 247                                          CCR_TX_OCT_CNT_BAD)
 248 #define  CCR_MIB_ACTIVATE               (CCR_MIB_ENABLE | \
 249                                          CCR_RX_OCT_CNT_GOOD | \
 250                                          CCR_RX_OCT_CNT_BAD | \
 251                                          CCR_TX_OCT_CNT_GOOD | \
 252                                          CCR_TX_OCT_CNT_BAD)
 253 /* Register for system reset */
 254 #define MT7530_SYS_CTRL                 0x7000
 255 #define  SYS_CTRL_PHY_RST               BIT(2)
 256 #define  SYS_CTRL_SW_RST                BIT(1)
 257 #define  SYS_CTRL_REG_RST               BIT(0)
 258
 259 /* Register for hw trap status */
 260 #define MT7530_HWTRAP                   0x7800
 261
 262 /* Register for hw trap modification */
 263 #define MT7530_MHWTRAP                  0x7804
 264 #define  MHWTRAP_MANUAL                 BIT(16)
 265 #define  MHWTRAP_P5_MAC_SEL             BIT(13)
 266 #define  MHWTRAP_P6_DIS                 BIT(8)
 267 #define  MHWTRAP_P5_RGMII_MODE          BIT(7)
 268 #define  MHWTRAP_P5_DIS                 BIT(6)
 269 #define  MHWTRAP_PHY_ACCESS             BIT(5)
 270
 271 /* Register for TOP signal control */
 272 #define MT7530_TOP_SIG_CTRL             0x7808
 273 #define  TOP_SIG_CTRL_NORMAL            (BIT(17) | BIT(16))
 274
 275 #define MT7530_IO_DRV_CR                0x7810
 276 #define  P5_IO_CLK_DRV(x)               ((x) & 0x3)
 277 #define  P5_IO_DATA_DRV(x)              (((x) & 0x3) << 4)
 278
 279 #define MT7530_P6ECR                    0x7830
 280 #define  P6_INTF_MODE_MASK              0x3
 281 #define  P6_INTF_MODE(x)                ((x) & 0x3)
 282
 283 /* Registers for TRGMII on the both side */
 284 #define MT7530_TRGMII_RCK_CTRL          0x7a00
 285 #define GSW_TRGMII_RCK_CTRL             0x300
 286 #define  RX_RST                         BIT(31)
 287 #define  RXC_DQSISEL                    BIT(30)
 288 #define  DQSI1_TAP_MASK                 (0x7f << 8)
 289 #define  DQSI0_TAP_MASK                 0x7f
 290 #define  DQSI1_TAP(x)                   (((x) & 0x7f) << 8)
 291 #define  DQSI0_TAP(x)                   ((x) & 0x7f)
 292
 293 #define MT7530_TRGMII_RCK_RTT           0x7a04
 294 #define GSW_TRGMII_RCK_RTT              0x304
 295 #define  DQS1_GATE                      BIT(31)
 296 #define  DQS0_GATE                      BIT(30)
 297
 298 #define MT7530_TRGMII_RD(x)             (0x7a10 + (x) * 8)
 299 #define GSW_TRGMII_RD(x)                (0x310 + (x) * 8)
 300 #define  BSLIP_EN                       BIT(31)
 301 #define  EDGE_CHK                       BIT(30)
 302 #define  RD_TAP_MASK                    0x7f
 303 #define  RD_TAP(x)                      ((x) & 0x7f)
 304
 305 #define GSW_TRGMII_TXCTRL               0x340
 306 #define MT7530_TRGMII_TXCTRL            0x7a40
 307 #define  TRAIN_TXEN                     BIT(31)
 308 #define  TXC_INV                        BIT(30)
 309 #define  TX_RST                         BIT(28)
 310
 311 #define MT7530_TRGMII_TD_ODT(i)         (0x7a54 + 8 * (i))
 312 #define GSW_TRGMII_TD_ODT(i)            (0x354 + 8 * (i))
 313 #define  TD_DM_DRVP(x)                  ((x) & 0xf)
 314 #define  TD_DM_DRVN(x)                  (((x) & 0xf) << 4)
 315
 316 #define GSW_INTF_MODE                   0x390
 317 #define  INTF_MODE_TRGMII               BIT(1)
 318
 319 #define MT7530_TRGMII_TCK_CTRL          0x7a78
 320 #define  TCK_TAP(x)                     (((x) & 0xf) << 8)
 321
 322 #define MT7530_P5RGMIIRXCR              0x7b00
 323 #define  CSR_RGMII_EDGE_ALIGN           BIT(8)
 324 #define  CSR_RGMII_RXC_0DEG_CFG(x)      ((x) & 0xf)
 325
 326 #define MT7530_P5RGMIITXCR              0x7b04
 327 #define  CSR_RGMII_TXC_CFG(x)           ((x) & 0x1f)
 328
 329 #define MT7530_CREV                     0x7ffc
 330 #define  CHIP_NAME_SHIFT                16
 331 #define  MT7530_ID                      0x7530
 332
 333 /* Registers for core PLL access through mmd indirect */
 334 #define CORE_PLL_GROUP2                 0x401
 335 #define  RG_SYSPLL_EN_NORMAL            BIT(15)
 336 #define  RG_SYSPLL_VODEN                BIT(14)
 337 #define  RG_SYSPLL_LF                   BIT(13)
 338 #define  RG_SYSPLL_RST_DLY(x)           (((x) & 0x3) << 12)
 339 #define  RG_SYSPLL_LVROD_EN             BIT(10)
 340 #define  RG_SYSPLL_PREDIV(x)            (((x) & 0x3) << 8)
 341 #define  RG_SYSPLL_POSDIV(x)            (((x) & 0x3) << 5)
 342 #define  RG_SYSPLL_FBKSEL               BIT(4)
 343 #define  RT_SYSPLL_EN_AFE_OLT           BIT(0)
 344
 345 #define CORE_PLL_GROUP4                 0x403
 346 #define  RG_SYSPLL_DDSFBK_EN            BIT(12)
 347 #define  RG_SYSPLL_BIAS_EN              BIT(11)
 348 #define  RG_SYSPLL_BIAS_LPF_EN          BIT(10)
 349
 350 #define CORE_PLL_GROUP5                 0x404
 351 #define  RG_LCDDS_PCW_NCPO1(x)          ((x) & 0xffff)
 352
 353 #define CORE_PLL_GROUP6                 0x405
 354 #define  RG_LCDDS_PCW_NCPO0(x)          ((x) & 0xffff)
 355
 356 #define CORE_PLL_GROUP7                 0x406
 357 #define  RG_LCDDS_PWDB                  BIT(15)
 358 #define  RG_LCDDS_ISO_EN                BIT(13)
 359 #define  RG_LCCDS_C(x)                  (((x) & 0x7) << 4)
 360 #define  RG_LCDDS_PCW_NCPO_CHG          BIT(3)
 361
 362 #define CORE_PLL_GROUP10                0x409
 363 #define  RG_LCDDS_SSC_DELTA(x)          ((x) & 0xfff)
 364
 365 #define CORE_PLL_GROUP11                0x40a
 366 #define  RG_LCDDS_SSC_DELTA1(x)         ((x) & 0xfff)
 367
 368 #define CORE_GSWPLL_GRP1                0x40d
 369 #define  RG_GSWPLL_PREDIV(x)            (((x) & 0x3) << 14)
 370 #define  RG_GSWPLL_POSDIV_200M(x)       (((x) & 0x3) << 12)
 371 #define  RG_GSWPLL_EN_PRE               BIT(11)
 372 #define  RG_GSWPLL_FBKSEL               BIT(10)
 373 #define  RG_GSWPLL_BP                   BIT(9)
 374 #define  RG_GSWPLL_BR                   BIT(8)
 375 #define  RG_GSWPLL_FBKDIV_200M(x)       ((x) & 0xff)
 376
 377 #define CORE_GSWPLL_GRP2                0x40e
 378 #define  RG_GSWPLL_POSDIV_500M(x)       (((x) & 0x3) << 8)
 379 #define  RG_GSWPLL_FBKDIV_500M(x)       ((x) & 0xff)
 380
 381 #define CORE_TRGMII_GSW_CLK_CG          0x410
 382 #define  REG_GSWCK_EN                   BIT(0)
 383 #define  REG_TRGMIICK_EN                BIT(1)
 384
 385 #define MIB_DESC(_s, _o, _n)    \
 386         {                       \
 387                 .size = (_s),   \
 388                 .offset = (_o), \
 389                 .name = (_n),   \
 390         }
 391
 392 struct mt7530_mib_desc {
 393         unsigned int size;
 394         unsigned int offset;
 395         const char *name;
 396 };
 397
 398 struct mt7530_fdb {
 399         u16 vid;
 400         u8 port_mask;
 401         u8 aging;
 402         u8 mac[6];
 403         bool noarp;
 404 };
 405
 406 /* struct mt7530_port - This is the main data structure for holding the state
 407  *                      of the port.
 408  * @enable:     The status used for show port is enabled or not.
 409  * @pm:         The matrix used to show all connections with the port.
 410  * @pvid:       The VLAN specified is to be considered a PVID at ingress.  Any
 411  *              untagged frames will be assigned to the related VLAN.
 412  * @vlan_filtering: The flags indicating whether the port that can recognize
 413  *                  VLAN-tagged frames.
 414  */
 415 struct mt7530_port {
 416         bool enable;
 417         u32 pm;
 418         u16 pvid;
 419         bool vlan_filtering;
 420 };
 421
 422 /* struct mt7530_priv - This is the main data structure for holding the state
 423  *                      of the driver
 424  * @dev:                The device pointer
 425  * @ds:                 The pointer to the dsa core structure
 426  * @bus:                The bus used for the device and built-in PHY
 427  * @rstc:               The pointer to reset control used by MCM
 428  * @ethernet:           The regmap used for access TRGMII-based registers
 429  * @core_pwr:           The power supplied into the core
 430  * @io_pwr:             The power supplied into the I/O
 431  * @reset:              The descriptor for GPIO line tied to its reset pin
 432  * @mcm:                Flag for distinguishing if standalone IC or module
 433  *                      coupling
 434  * @ports:              Holding the state among ports
 435  * @reg_mutex:          The lock for protecting among process accessing
 436  *                      registers
 437  */
 438 struct mt7530_priv {
 439         struct device           *dev;
 440         struct dsa_switch       *ds;
 441         struct mii_bus          *bus;
 442         struct reset_control    *rstc;
 443         struct regmap           *ethernet;
 444         struct regulator        *core_pwr;
 445         struct regulator        *io_pwr;
 446         struct gpio_desc        *reset;
 447         bool                    mcm;
 448
 449         struct mt7530_port      ports[MT7530_NUM_PORTS];
 450         /* protect among processes for registers access*/
 451         struct mutex reg_mutex;
 452 };
 453
 454 struct mt7530_hw_vlan_entry {
 455         int port;
 456         u8  old_members;
 457         bool untagged;
 458 };
 459
 460 static inline void mt7530_hw_vlan_entry_init(struct mt7530_hw_vlan_entry *e,
 461                                              int port, bool untagged)
 462 {
 463         e->port = port;
 464         e->untagged = untagged;
 465 }
 466
 467 typedef void (*mt7530_vlan_op)(struct mt7530_priv *,
 468                                struct mt7530_hw_vlan_entry *);
 469
 470 struct mt7530_hw_stats {
 471         const char      *string;
 472         u16             reg;
 473         u8              sizeof_stat;
 474 };
 475
 476 struct mt7530_dummy_poll {
 477         struct mt7530_priv *priv;
 478         u32 reg;
 479 };
 480
 481 static inline void INIT_MT7530_DUMMY_POLL(struct mt7530_dummy_poll *p,
 482                                           struct mt7530_priv *priv, u32 reg)
 483 {
 484         p->priv = priv;
 485         p->reg = reg;
 486 }
 487
 488 #endif /* __MT7530_H */