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