1 /* SPDX-License-Identifier: GPL-2.0+ */
3 * ENETC ethernet controller driver
4 * Copyright 2017-2019 NXP
10 #include <linux/bitops.h>
11 #define enetc_dbg(dev, fmt, args...) debug("%s:" fmt, dev->name, ##args)
13 /* PCI function IDs */
14 #define PCI_DEVICE_ID_ENETC_ETH 0xE100
15 #define PCI_DEVICE_ID_ENETC_MDIO 0xEE01
17 /* ENETC Ethernet controller registers */
18 /* Station interface register offsets */
19 #define ENETC_SIMR 0x000
20 #define ENETC_SIMR_EN BIT(31)
21 #define ENETC_SICAR0 0x040
22 /* write cache cfg: snoop, no allocate, data & BD coherent */
23 #define ENETC_SICAR_WR_CFG 0x6767
24 /* read cache cfg: coherent copy, look up, don't alloc in cache */
25 #define ENETC_SICAR_RD_CFG 0x27270000
26 #define ENETC_SIROCT 0x300
27 #define ENETC_SIRFRM 0x308
28 #define ENETC_SITOCT 0x320
29 #define ENETC_SITFRM 0x328
31 /* Rx/Tx Buffer Descriptor Ring registers */
32 enum enetc_bdr_type {TX, RX};
33 #define ENETC_BDR(type, n, off) (0x8000 + (type) * 0x100 + (n) * 0x200 + (off))
34 #define ENETC_BDR_IDX_MASK 0xffff
36 /* Rx BDR reg offsets */
37 #define ENETC_RBMR 0x00
38 #define ENETC_RBMR_EN BIT(31)
39 #define ENETC_RBBSR 0x08
40 /* initial consumer index for Rx BDR */
41 #define ENETC_RBCIR 0x0c
42 #define ENETC_RBBAR0 0x10
43 #define ENETC_RBBAR1 0x14
44 #define ENETC_RBPIR 0x18
45 #define ENETC_RBLENR 0x20
47 /* Tx BDR reg offsets */
48 #define ENETC_TBMR 0x00
49 #define ENETC_TBMR_EN BIT(31)
50 #define ENETC_TBBAR0 0x10
51 #define ENETC_TBBAR1 0x14
52 #define ENETC_TBPIR 0x18
53 #define ENETC_TBCIR 0x1c
54 #define ENETC_TBLENR 0x20
56 /* Port registers offset */
57 #define ENETC_PORT_REGS_OFF 0x10000
60 #define ENETC_PMR 0x0000
61 #define ENETC_PMR_SI0_EN BIT(16)
62 #define ENETC_PSIPMMR 0x0018
63 #define ENETC_PSIPMAR0 0x0100
64 #define ENETC_PSIPMAR1 0x0104
65 #define ENETC_PCAPR0 0x0900
66 #define ENETC_PCAPRO_MDIO BIT(11)
67 #define ENETC_PSICFGR(n) (0x0940 + (n) * 0x10)
68 #define ENETC_PSICFGR_SET_TXBDR(val) ((val) & 0xff)
69 #define ENETC_PSICFGR_SET_RXBDR(val) (((val) & 0xff) << 16)
70 /* MAC configuration */
71 #define ENETC_PM_CC 0x8008
72 #define ENETC_PM_CC_DEFAULT 0x0810
73 #define ENETC_PM_CC_RX_TX_EN 0x8813
74 #define ENETC_PM_MAXFRM 0x8014
75 #define ENETC_RX_MAXFRM_SIZE PKTSIZE_ALIGN
76 #define ENETC_PM_IMDIO_BASE 0x8030
77 #define ENETC_PM_IF_MODE 0x8300
78 #define ENETC_PM_IF_MODE_RG BIT(2)
79 #define ENETC_PM_IF_MODE_AN_ENA BIT(15)
80 #define ENETC_PM_IF_IFMODE_MASK GENMASK(1, 0)
82 /* buffer descriptors count must be multiple of 8 and aligned to 128 bytes */
83 #define ENETC_BD_CNT CONFIG_SYS_RX_ETH_BUFFER
84 #define ENETC_BD_ALIGN 128
86 /* single pair of Rx/Tx rings */
87 #define ENETC_RX_BDR_CNT 1
88 #define ENETC_TX_BDR_CNT 1
89 #define ENETC_RX_BDR_ID 0
90 #define ENETC_TX_BDR_ID 0
92 /* Tx buffer descriptor */
101 #define ENETC_TXBD_FLAGS_F BIT(15)
102 #define ENETC_POLL_TRIES 32000
104 /* Rx buffer descriptor */
106 /* SW provided BD format */
112 /* ENETC returned BD format */
115 __le16 parse_summary;
129 #define ENETC_RXBD_STATUS_R(status) (((status) >> 30) & 0x1)
130 #define ENETC_RXBD_STATUS_F(status) (((status) >> 31) & 0x1)
131 #define ENETC_RXBD_STATUS_ERRORS(status) (((status) >> 16) & 0xff)
132 #define ENETC_RXBD_STATUS(flags) ((flags) << 16)
134 /* Tx/Rx ring info */
138 /* next BD index to use */
144 /* ENETC private structure */
146 struct enetc_tx_bd *enetc_txbd;
147 union enetc_rx_bd *enetc_rxbd;
149 void *regs_base; /* base ENETC registers */
150 void *port_regs; /* base ENETC port registers */
152 /* Rx/Tx buffer descriptor rings info */
153 struct bd_ring tx_bdr;
154 struct bd_ring rx_bdr;
157 struct mii_dev imdio;
158 struct phy_device *phy;
161 /* register accessors */
162 #define enetc_read_reg(x) readl((x))
163 #define enetc_write_reg(x, val) writel((val), (x))
164 #define enetc_read(priv, off) enetc_read_reg((priv)->regs_base + (off))
165 #define enetc_write(priv, off, v) \
166 enetc_write_reg((priv)->regs_base + (off), v)
168 /* port register accessors */
169 #define enetc_port_regs(priv, off) ((priv)->port_regs + (off))
170 #define enetc_read_port(priv, off) \
171 enetc_read_reg(enetc_port_regs((priv), (off)))
172 #define enetc_write_port(priv, off, v) \
173 enetc_write_reg(enetc_port_regs((priv), (off)), v)
175 /* BDR register accessors, see ENETC_BDR() */
176 #define enetc_bdr_read(priv, t, n, off) \
177 enetc_read(priv, ENETC_BDR(t, n, off))
178 #define enetc_bdr_write(priv, t, n, off, val) \
179 enetc_write(priv, ENETC_BDR(t, n, off), val)
181 /* PCS / internal SoC PHY ID, it defaults to 0 on all interfaces */
182 #define ENETC_PCS_PHY_ADDR 0
185 #define ENETC_PCS_CR 0x00
186 #define ENETC_PCS_CR_RESET_AN 0x1200
187 #define ENETC_PCS_CR_DEF_VAL 0x0140
188 #define ENETC_PCS_CR_RST BIT(15)
189 #define ENETC_PCS_DEV_ABILITY 0x04
190 #define ENETC_PCS_DEV_ABILITY_SGMII 0x4001
191 #define ENETC_PCS_DEV_ABILITY_SXGMII 0x5001
192 #define ENETC_PCS_LINK_TIMER1 0x12
193 #define ENETC_PCS_LINK_TIMER1_VAL 0x06a0
194 #define ENETC_PCS_LINK_TIMER2 0x13
195 #define ENETC_PCS_LINK_TIMER2_VAL 0x0003
196 #define ENETC_PCS_IF_MODE 0x14
197 #define ENETC_PCS_IF_MODE_SGMII BIT(0)
198 #define ENETC_PCS_IF_MODE_SGMII_AN BIT(1)
199 #define ENETC_PCS_IF_MODE_SPEED_1G BIT(3)
201 /* PCS replicator block for USXGMII */
202 #define ENETC_PCS_DEVAD_REPL 0x1f
204 /* ENETC external MDIO registers */
205 #define ENETC_MDIO_BASE 0x1c00
206 #define ENETC_MDIO_CFG 0x00
207 #define ENETC_EMDIO_CFG_C22 0x00809508
208 #define ENETC_EMDIO_CFG_C45 0x00809548
209 #define ENETC_EMDIO_CFG_RD_ER BIT(1)
210 #define ENETC_EMDIO_CFG_BSY BIT(0)
211 #define ENETC_MDIO_CTL 0x04
212 #define ENETC_MDIO_CTL_READ BIT(15)
213 #define ENETC_MDIO_DATA 0x08
214 #define ENETC_MDIO_STAT 0x0c
216 #define ENETC_MDIO_READ_ERR 0xffff
218 struct enetc_mdio_priv {
223 * these functions are implemented by ENETC_MDIO and are re-used by ENETC driver
224 * to drive serdes / internal SoC PHYs
226 int enetc_mdio_read_priv(struct enetc_mdio_priv *priv, int addr, int devad,
228 int enetc_mdio_write_priv(struct enetc_mdio_priv *priv, int addr, int devad,
231 /* sets up primary MAC addresses in DT/IERB */
232 void fdt_fixup_enetc_mac(void *blob);
234 #endif /* _ENETC_H */