1 /* Applied Micro X-Gene SoC Ethernet Driver
3 * Copyright (c) 2014, Applied Micro Circuits Corporation
4 * Authors: Iyappan Subramanian <isubramanian@apm.com>
5 * Ravi Patel <rapatel@apm.com>
6 * Keyur Chudgar <kchudgar@apm.com>
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; either version 2 of the License, or (at your
11 * option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #ifndef __XGENE_ENET_HW_H__
23 #define __XGENE_ENET_HW_H__
25 #include "xgene_enet_main.h"
27 struct xgene_enet_pdata;
28 struct xgene_enet_stats;
29 struct xgene_enet_desc_ring;
31 /* clears and then set bits */
32 static inline void xgene_set_bits(u32 *dst, u32 val, u32 start, u32 len)
34 u32 end = start + len - 1;
35 u32 mask = GENMASK(end, start);
38 *dst |= (val << start) & mask;
41 static inline u32 xgene_get_bits(u32 val, u32 start, u32 end)
43 return (val & GENMASK(end, start)) >> start;
52 #define CSR_RING_ID 0x0008
53 #define OVERWRITE BIT(31)
54 #define IS_BUFFER_POOL BIT(20)
55 #define PREFETCH_BUF_EN BIT(21)
56 #define CSR_RING_ID_BUF 0x000c
57 #define CSR_PBM_COAL 0x0014
58 #define CSR_PBM_CTICK1 0x001c
59 #define CSR_PBM_CTICK2 0x0020
60 #define CSR_THRESHOLD0_SET1 0x0030
61 #define CSR_THRESHOLD1_SET1 0x0034
62 #define CSR_RING_NE_INT_MODE 0x017c
63 #define CSR_RING_CONFIG 0x006c
64 #define CSR_RING_WR_BASE 0x0070
65 #define NUM_RING_CONFIG 5
66 #define BUFPOOL_MODE 3
67 #define INC_DEC_CMD_ADDR 0x002c
68 #define UDP_HDR_SIZE 2
69 #define BUF_LEN_CODE_2K 0x5000
71 #define CREATE_MASK(pos, len) GENMASK((pos)+(len)-1, (pos))
72 #define CREATE_MASK_ULL(pos, len) GENMASK_ULL((pos)+(len)-1, (pos))
74 /* Empty slot soft signature */
75 #define EMPTY_SLOT_INDEX 1
76 #define EMPTY_SLOT ~0ULL
78 #define WORK_DESC_SIZE 32
79 #define BUFPOOL_DESC_SIZE 16
81 #define RING_OWNER_MASK GENMASK(9, 6)
82 #define RING_BUFNUM_MASK GENMASK(5, 0)
84 #define SELTHRSH_POS 3
85 #define SELTHRSH_LEN 3
86 #define RINGADDRL_POS 5
87 #define RINGADDRL_LEN 27
88 #define RINGADDRH_POS 0
89 #define RINGADDRH_LEN 6
90 #define RINGSIZE_POS 23
91 #define RINGSIZE_LEN 3
92 #define RINGTYPE_POS 19
93 #define RINGTYPE_LEN 2
94 #define RINGMODE_POS 20
95 #define RINGMODE_LEN 3
96 #define RECOMTIMEOUTL_POS 28
97 #define RECOMTIMEOUTL_LEN 3
98 #define RECOMTIMEOUTH_POS 0
99 #define RECOMTIMEOUTH_LEN 2
100 #define NUMMSGSINQ_POS 1
101 #define NUMMSGSINQ_LEN 16
102 #define ACCEPTLERR BIT(19)
103 #define QCOHERENT BIT(4)
104 #define RECOMBBUF BIT(27)
106 #define MAC_OFFSET 0x30
108 #define BLOCK_ETH_CSR_OFFSET 0x2000
109 #define BLOCK_ETH_CLE_CSR_OFFSET 0x6000
110 #define BLOCK_ETH_RING_IF_OFFSET 0x9000
111 #define BLOCK_ETH_CLKRST_CSR_OFFSET 0xc000
112 #define BLOCK_ETH_DIAG_CSR_OFFSET 0xD000
113 #define BLOCK_ETH_MAC_OFFSET 0x0000
114 #define BLOCK_ETH_MAC_CSR_OFFSET 0x2800
116 #define CLKEN_ADDR 0xc208
117 #define SRST_ADDR 0xc200
119 #define MAC_ADDR_REG_OFFSET 0x00
120 #define MAC_COMMAND_REG_OFFSET 0x04
121 #define MAC_WRITE_REG_OFFSET 0x08
122 #define MAC_READ_REG_OFFSET 0x0c
123 #define MAC_COMMAND_DONE_REG_OFFSET 0x10
125 #define MII_MGMT_CONFIG_ADDR 0x20
126 #define MII_MGMT_COMMAND_ADDR 0x24
127 #define MII_MGMT_ADDRESS_ADDR 0x28
128 #define MII_MGMT_CONTROL_ADDR 0x2c
129 #define MII_MGMT_STATUS_ADDR 0x30
130 #define MII_MGMT_INDICATORS_ADDR 0x34
132 #define BUSY_MASK BIT(0)
133 #define READ_CYCLE_MASK BIT(0)
134 #define PHY_CONTROL_SET(dst, val) xgene_set_bits(dst, val, 0, 16)
136 #define ENET_SPARE_CFG_REG_ADDR 0x0750
137 #define RSIF_CONFIG_REG_ADDR 0x0010
138 #define RSIF_RAM_DBG_REG0_ADDR 0x0048
139 #define RGMII_REG_0_ADDR 0x07e0
140 #define CFG_LINK_AGGR_RESUME_0_ADDR 0x07c8
141 #define DEBUG_REG_ADDR 0x0700
142 #define CFG_BYPASS_ADDR 0x0294
143 #define CLE_BYPASS_REG0_0_ADDR 0x0490
144 #define CLE_BYPASS_REG1_0_ADDR 0x0494
145 #define CFG_RSIF_FPBUFF_TIMEOUT_EN BIT(31)
146 #define RESUME_TX BIT(0)
147 #define CFG_SPEED_1250 BIT(24)
148 #define TX_PORT0 BIT(0)
149 #define CFG_BYPASS_UNISEC_TX BIT(2)
150 #define CFG_BYPASS_UNISEC_RX BIT(1)
151 #define CFG_CLE_BYPASS_EN0 BIT(31)
152 #define CFG_TXCLK_MUXSEL0_SET(dst, val) xgene_set_bits(dst, val, 29, 3)
153 #define CFG_RXCLK_MUXSEL0_SET(dst, val) xgene_set_bits(dst, val, 26, 3)
155 #define CFG_CLE_IP_PROTOCOL0_SET(dst, val) xgene_set_bits(dst, val, 16, 2)
156 #define CFG_CLE_DSTQID0_SET(dst, val) xgene_set_bits(dst, val, 0, 12)
157 #define CFG_CLE_FPSEL0_SET(dst, val) xgene_set_bits(dst, val, 16, 4)
158 #define CFG_MACMODE_SET(dst, val) xgene_set_bits(dst, val, 18, 2)
159 #define CFG_WAITASYNCRD_SET(dst, val) xgene_set_bits(dst, val, 0, 16)
160 #define CFG_CLE_DSTQID0(val) (val & GENMASK(11, 0))
161 #define CFG_CLE_FPSEL0(val) ((val << 16) & GENMASK(19, 16))
162 #define ICM_CONFIG0_REG_0_ADDR 0x0400
163 #define ICM_CONFIG2_REG_0_ADDR 0x0410
164 #define RX_DV_GATE_REG_0_ADDR 0x05fc
165 #define TX_DV_GATE_EN0 BIT(2)
166 #define RX_DV_GATE_EN0 BIT(1)
167 #define RESUME_RX0 BIT(0)
168 #define ENET_CFGSSQMIWQASSOC_ADDR 0xe0
169 #define ENET_CFGSSQMIFPQASSOC_ADDR 0xdc
170 #define ENET_CFGSSQMIQMLITEFPQASSOC_ADDR 0xf0
171 #define ENET_CFGSSQMIQMLITEWQASSOC_ADDR 0xf4
172 #define ENET_CFG_MEM_RAM_SHUTDOWN_ADDR 0x70
173 #define ENET_BLOCK_MEM_RDY_ADDR 0x74
174 #define MAC_CONFIG_1_ADDR 0x00
175 #define MAC_CONFIG_2_ADDR 0x04
176 #define MAX_FRAME_LEN_ADDR 0x10
177 #define INTERFACE_CONTROL_ADDR 0x38
178 #define STATION_ADDR0_ADDR 0x40
179 #define STATION_ADDR1_ADDR 0x44
180 #define PHY_ADDR_SET(dst, val) xgene_set_bits(dst, val, 8, 5)
181 #define REG_ADDR_SET(dst, val) xgene_set_bits(dst, val, 0, 5)
182 #define ENET_INTERFACE_MODE2_SET(dst, val) xgene_set_bits(dst, val, 8, 2)
183 #define MGMT_CLOCK_SEL_SET(dst, val) xgene_set_bits(dst, val, 0, 3)
184 #define SOFT_RESET1 BIT(31)
187 #define ENET_LHD_MODE BIT(25)
188 #define ENET_GHD_MODE BIT(26)
189 #define FULL_DUPLEX2 BIT(0)
190 #define PAD_CRC BIT(2)
191 #define SCAN_AUTO_INCR BIT(5)
192 #define TBYT_ADDR 0x38
193 #define TPKT_ADDR 0x39
194 #define TDRP_ADDR 0x45
195 #define TFCS_ADDR 0x47
196 #define TUND_ADDR 0x4a
198 #define TSO_IPPROTO_TCP 1
200 #define USERINFO_POS 0
201 #define USERINFO_LEN 32
202 #define FPQNUM_POS 32
203 #define FPQNUM_LEN 12
212 #define BUFDATALEN_POS 48
213 #define BUFDATALEN_LEN 15
214 #define DATAADDR_POS 0
215 #define DATAADDR_LEN 42
216 #define COHERENT_POS 63
217 #define HENQNUM_POS 48
218 #define HENQNUM_LEN 12
219 #define TYPESEL_POS 44
220 #define TYPESEL_LEN 4
221 #define ETHHDR_POS 12
223 #define IC_POS 35 /* Insert CRC */
228 #define EC_POS 22 /* Enable checksum */
230 #define ET_POS 23 /* Enable TSO */
231 #define IS_POS 24 /* IP protocol select */
233 #define TYPE_ETH_WORK_MESSAGE_POS 44
234 #define LL_BYTES_MSB_POS 56
235 #define LL_BYTES_MSB_LEN 8
236 #define LL_BYTES_LSB_POS 48
237 #define LL_BYTES_LSB_LEN 12
238 #define LL_LEN_POS 48
240 #define DATALEN_MASK GENMASK(11, 0)
242 #define LAST_BUFFER (0x7800ULL << BUFDATALEN_POS)
244 struct xgene_enet_raw_desc {
251 struct xgene_enet_raw_desc16 {
256 static inline void xgene_enet_mark_desc_slot_empty(void *desc_slot_ptr)
258 __le64 *desc_slot = desc_slot_ptr;
260 desc_slot[EMPTY_SLOT_INDEX] = cpu_to_le64(EMPTY_SLOT);
263 static inline bool xgene_enet_is_desc_slot_empty(void *desc_slot_ptr)
265 __le64 *desc_slot = desc_slot_ptr;
267 return (desc_slot[EMPTY_SLOT_INDEX] == cpu_to_le64(EMPTY_SLOT));
270 enum xgene_enet_ring_cfgsize {
279 enum xgene_enet_ring_type {
285 enum xgene_ring_owner {
292 enum xgene_enet_ring_bufnum {
293 RING_BUFNUM_REGULAR = 0x0,
294 RING_BUFNUM_BUFPOOL = 0x20,
298 enum xgene_enet_cmd {
299 XGENE_ENET_WR_CMD = BIT(31),
300 XGENE_ENET_RD_CMD = BIT(30)
303 enum xgene_enet_err_code {
307 BUFPOOL_TIMEOUT = 15,
309 INGRESS_CHECKSUM = 17,
310 INGRESS_TRUNC_FRAME = 18,
311 INGRESS_PKT_LEN = 19,
312 INGRESS_PKT_UNDER = 20,
313 INGRESS_FIFO_OVERRUN = 21,
314 INGRESS_CHECKSUM_COMPUTE = 26,
318 static inline enum xgene_ring_owner xgene_enet_ring_owner(u16 id)
320 return (id & RING_OWNER_MASK) >> 6;
323 static inline u8 xgene_enet_ring_bufnum(u16 id)
325 return id & RING_BUFNUM_MASK;
328 static inline bool xgene_enet_is_bufpool(u16 id)
330 return ((id & RING_BUFNUM_MASK) >= 0x20) ? true : false;
333 static inline u16 xgene_enet_get_numslots(u16 id, u32 size)
335 bool is_bufpool = xgene_enet_is_bufpool(id);
337 return (is_bufpool) ? size / BUFPOOL_DESC_SIZE :
338 size / WORK_DESC_SIZE;
341 void xgene_enet_parse_error(struct xgene_enet_desc_ring *ring,
342 struct xgene_enet_pdata *pdata,
343 enum xgene_enet_err_code status);
345 int xgene_enet_mdio_config(struct xgene_enet_pdata *pdata);
346 void xgene_enet_mdio_remove(struct xgene_enet_pdata *pdata);
347 bool xgene_ring_mgr_init(struct xgene_enet_pdata *p);
349 extern const struct xgene_mac_ops xgene_gmac_ops;
350 extern const struct xgene_port_ops xgene_gport_ops;
351 extern struct xgene_ring_ops xgene_ring1_ops;
353 #endif /* __XGENE_ENET_HW_H__ */