xref: /linux/drivers/net/ethernet/smsc/smsc9420.h (revision 4f2c0a4acffbec01079c28f839422e64ddeff004)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2  /***************************************************************************
3  *
4  * Copyright (C) 2007,2008  SMSC
5  *
6  ***************************************************************************
7  */
8 
9 #ifndef _SMSC9420_H
10 #define _SMSC9420_H
11 
12 #define TX_RING_SIZE			(32)
13 #define RX_RING_SIZE			(128)
14 
15 /* interrupt deassertion in multiples of 10us */
16 #define INT_DEAS_TIME			(50)
17 
18 #define SMSC_BAR			(3)
19 
20 #ifdef __BIG_ENDIAN
21 /* Register set is duplicated for BE at an offset of 0x200 */
22 #define LAN9420_CPSR_ENDIAN_OFFSET	(0x200)
23 #else
24 #define LAN9420_CPSR_ENDIAN_OFFSET	(0)
25 #endif
26 
27 #define PCI_VENDOR_ID_9420		(0x1055)
28 #define PCI_DEVICE_ID_9420		(0xE420)
29 
30 #define LAN_REGISTER_EXTENT		(0x400)
31 
32 #define SMSC9420_EEPROM_SIZE		((u32)11)
33 #define SMSC9420_EEPROM_MAGIC		(0x9420)
34 
35 #define PKT_BUF_SZ			(VLAN_ETH_FRAME_LEN + NET_IP_ALIGN + 4)
36 
37 /***********************************************/
38 /* DMA Controller Control and Status Registers */
39 /***********************************************/
40 #define BUS_MODE			(0x00)
41 #define BUS_MODE_SWR_			(BIT(0))
42 #define BUS_MODE_DMA_BURST_LENGTH_1	(BIT(8))
43 #define BUS_MODE_DMA_BURST_LENGTH_2	(BIT(9))
44 #define BUS_MODE_DMA_BURST_LENGTH_4	(BIT(10))
45 #define BUS_MODE_DMA_BURST_LENGTH_8	(BIT(11))
46 #define BUS_MODE_DMA_BURST_LENGTH_16	(BIT(12))
47 #define BUS_MODE_DMA_BURST_LENGTH_32	(BIT(13))
48 #define BUS_MODE_DBO_			(BIT(20))
49 
50 #define TX_POLL_DEMAND			(0x04)
51 
52 #define RX_POLL_DEMAND			(0x08)
53 
54 #define RX_BASE_ADDR			(0x0C)
55 
56 #define TX_BASE_ADDR			(0x10)
57 
58 #define DMAC_STATUS			(0x14)
59 #define DMAC_STS_TS_			(7 << 20)
60 #define DMAC_STS_RS_ 			(7 << 17)
61 #define DMAC_STS_NIS_			(BIT(16))
62 #define DMAC_STS_AIS_			(BIT(15))
63 #define DMAC_STS_RWT_			(BIT(9))
64 #define DMAC_STS_RXPS_			(BIT(8))
65 #define DMAC_STS_RXBU_			(BIT(7))
66 #define DMAC_STS_RX_			(BIT(6))
67 #define DMAC_STS_TXUNF_			(BIT(5))
68 #define DMAC_STS_TXBU_			(BIT(2))
69 #define DMAC_STS_TXPS_			(BIT(1))
70 #define DMAC_STS_TX_			(BIT(0))
71 
72 #define DMAC_CONTROL			(0x18)
73 #define DMAC_CONTROL_TTM_		(BIT(22))
74 #define DMAC_CONTROL_SF_		(BIT(21))
75 #define DMAC_CONTROL_ST_		(BIT(13))
76 #define DMAC_CONTROL_OSF_		(BIT(2))
77 #define DMAC_CONTROL_SR_		(BIT(1))
78 
79 #define DMAC_INTR_ENA			(0x1C)
80 #define DMAC_INTR_ENA_NIS_		(BIT(16))
81 #define DMAC_INTR_ENA_AIS_		(BIT(15))
82 #define DMAC_INTR_ENA_RWT_		(BIT(9))
83 #define DMAC_INTR_ENA_RXPS_		(BIT(8))
84 #define DMAC_INTR_ENA_RXBU_		(BIT(7))
85 #define DMAC_INTR_ENA_RX_		(BIT(6))
86 #define DMAC_INTR_ENA_TXBU_		(BIT(2))
87 #define DMAC_INTR_ENA_TXPS_		(BIT(1))
88 #define DMAC_INTR_ENA_TX_		(BIT(0))
89 
90 #define MISS_FRAME_CNTR			(0x20)
91 
92 #define TX_BUFF_ADDR			(0x50)
93 
94 #define RX_BUFF_ADDR			(0x54)
95 
96 /* Transmit Descriptor Bit Defs */
97 #define TDES0_OWN_			(0x80000000)
98 #define TDES0_ERROR_SUMMARY_		(0x00008000)
99 #define TDES0_LOSS_OF_CARRIER_		(0x00000800)
100 #define TDES0_NO_CARRIER_		(0x00000400)
101 #define TDES0_LATE_COLLISION_		(0x00000200)
102 #define TDES0_EXCESSIVE_COLLISIONS_	(0x00000100)
103 #define TDES0_HEARTBEAT_FAIL_		(0x00000080)
104 #define TDES0_COLLISION_COUNT_MASK_	(0x00000078)
105 #define TDES0_COLLISION_COUNT_SHFT_	(3)
106 #define TDES0_EXCESSIVE_DEFERRAL_	(0x00000004)
107 #define TDES0_DEFERRED_			(0x00000001)
108 
109 #define TDES1_IC_			0x80000000
110 #define TDES1_LS_			0x40000000
111 #define TDES1_FS_			0x20000000
112 #define TDES1_TXCSEN_			0x08000000
113 #define TDES1_TER_			(BIT(25))
114 #define TDES1_TCH_			0x01000000
115 
116 /* Receive Descriptor 0 Bit Defs */
117 #define RDES0_OWN_			(0x80000000)
118 #define RDES0_FRAME_LENGTH_MASK_	(0x07FF0000)
119 #define RDES0_FRAME_LENGTH_SHFT_	(16)
120 #define RDES0_ERROR_SUMMARY_		(0x00008000)
121 #define RDES0_DESCRIPTOR_ERROR_		(0x00004000)
122 #define RDES0_LENGTH_ERROR_		(0x00001000)
123 #define RDES0_RUNT_FRAME_		(0x00000800)
124 #define RDES0_MULTICAST_FRAME_		(0x00000400)
125 #define RDES0_FIRST_DESCRIPTOR_		(0x00000200)
126 #define RDES0_LAST_DESCRIPTOR_		(0x00000100)
127 #define RDES0_FRAME_TOO_LONG_		(0x00000080)
128 #define RDES0_COLLISION_SEEN_		(0x00000040)
129 #define RDES0_FRAME_TYPE_		(0x00000020)
130 #define RDES0_WATCHDOG_TIMEOUT_		(0x00000010)
131 #define RDES0_MII_ERROR_		(0x00000008)
132 #define RDES0_DRIBBLING_BIT_		(0x00000004)
133 #define RDES0_CRC_ERROR_		(0x00000002)
134 
135 /* Receive Descriptor 1 Bit Defs */
136 #define RDES1_RER_			(0x02000000)
137 
138 /***********************************************/
139 /*       MAC Control and Status Registers      */
140 /***********************************************/
141 #define MAC_CR				(0x80)
142 #define MAC_CR_RXALL_			(0x80000000)
143 #define MAC_CR_DIS_RXOWN_		(0x00800000)
144 #define MAC_CR_LOOPBK_			(0x00200000)
145 #define MAC_CR_FDPX_			(0x00100000)
146 #define MAC_CR_MCPAS_			(0x00080000)
147 #define MAC_CR_PRMS_			(0x00040000)
148 #define MAC_CR_INVFILT_			(0x00020000)
149 #define MAC_CR_PASSBAD_			(0x00010000)
150 #define MAC_CR_HFILT_			(0x00008000)
151 #define MAC_CR_HPFILT_			(0x00002000)
152 #define MAC_CR_LCOLL_			(0x00001000)
153 #define MAC_CR_DIS_BCAST_		(0x00000800)
154 #define MAC_CR_DIS_RTRY_		(0x00000400)
155 #define MAC_CR_PADSTR_			(0x00000100)
156 #define MAC_CR_BOLMT_MSK		(0x000000C0)
157 #define MAC_CR_MFCHK_			(0x00000020)
158 #define MAC_CR_TXEN_			(0x00000008)
159 #define MAC_CR_RXEN_			(0x00000004)
160 
161 #define ADDRH				(0x84)
162 
163 #define ADDRL				(0x88)
164 
165 #define HASHH				(0x8C)
166 
167 #define HASHL				(0x90)
168 
169 #define MII_ACCESS			(0x94)
170 #define MII_ACCESS_MII_BUSY_		(0x00000001)
171 #define MII_ACCESS_MII_WRITE_		(0x00000002)
172 #define MII_ACCESS_MII_READ_		(0x00000000)
173 #define MII_ACCESS_INDX_MSK_		(0x000007C0)
174 #define MII_ACCESS_PHYADDR_MSK_		(0x0000F8C0)
175 #define MII_ACCESS_INDX_SHFT_CNT	(6)
176 #define MII_ACCESS_PHYADDR_SHFT_CNT	(11)
177 
178 #define MII_DATA			(0x98)
179 
180 #define FLOW				(0x9C)
181 
182 #define VLAN1				(0xA0)
183 
184 #define VLAN2				(0xA4)
185 
186 #define WUFF				(0xA8)
187 
188 #define WUCSR				(0xAC)
189 
190 #define COE_CR				(0xB0)
191 #define TX_COE_EN			(0x00010000)
192 #define RX_COE_MODE			(0x00000002)
193 #define RX_COE_EN			(0x00000001)
194 
195 /***********************************************/
196 /*     System Control and Status Registers     */
197 /***********************************************/
198 #define ID_REV				(0xC0)
199 
200 #define INT_CTL				(0xC4)
201 #define INT_CTL_SW_INT_EN_		(0x00008000)
202 #define INT_CTL_SBERR_INT_EN_		(1 << 12)
203 #define INT_CTL_MBERR_INT_EN_		(1 << 13)
204 #define INT_CTL_GPT_INT_EN_		(0x00000008)
205 #define INT_CTL_PHY_INT_EN_		(0x00000004)
206 #define INT_CTL_WAKE_INT_EN_		(0x00000002)
207 
208 #define INT_STAT			(0xC8)
209 #define INT_STAT_SW_INT_		(1 << 15)
210 #define INT_STAT_MBERR_INT_		(1 << 13)
211 #define INT_STAT_SBERR_INT_		(1 << 12)
212 #define INT_STAT_GPT_INT_		(1 << 3)
213 #define INT_STAT_PHY_INT_		(0x00000004)
214 #define INT_STAT_WAKE_INT_		(0x00000002)
215 #define INT_STAT_DMAC_INT_		(0x00000001)
216 
217 #define INT_CFG				(0xCC)
218 #define INT_CFG_IRQ_INT_		(0x00080000)
219 #define INT_CFG_IRQ_EN_			(0x00040000)
220 #define INT_CFG_INT_DEAS_CLR_		(0x00000200)
221 #define INT_CFG_INT_DEAS_MASK		(0x000000FF)
222 
223 #define GPIO_CFG			(0xD0)
224 #define GPIO_CFG_LED_3_			(0x40000000)
225 #define GPIO_CFG_LED_2_			(0x20000000)
226 #define GPIO_CFG_LED_1_			(0x10000000)
227 #define GPIO_CFG_EEPR_EN_		(0x00700000)
228 
229 #define GPT_CFG				(0xD4)
230 #define GPT_CFG_TIMER_EN_		(0x20000000)
231 
232 #define GPT_CNT				(0xD8)
233 
234 #define BUS_CFG				(0xDC)
235 #define BUS_CFG_RXTXWEIGHT_1_1		(0 << 25)
236 #define BUS_CFG_RXTXWEIGHT_2_1		(1 << 25)
237 #define BUS_CFG_RXTXWEIGHT_3_1		(2 << 25)
238 #define BUS_CFG_RXTXWEIGHT_4_1		(3 << 25)
239 
240 #define PMT_CTRL			(0xE0)
241 
242 #define FREE_RUN			(0xF4)
243 
244 #define E2P_CMD				(0xF8)
245 #define E2P_CMD_EPC_BUSY_		(0x80000000)
246 #define E2P_CMD_EPC_CMD_		(0x70000000)
247 #define E2P_CMD_EPC_CMD_READ_		(0x00000000)
248 #define E2P_CMD_EPC_CMD_EWDS_		(0x10000000)
249 #define E2P_CMD_EPC_CMD_EWEN_		(0x20000000)
250 #define E2P_CMD_EPC_CMD_WRITE_		(0x30000000)
251 #define E2P_CMD_EPC_CMD_WRAL_		(0x40000000)
252 #define E2P_CMD_EPC_CMD_ERASE_		(0x50000000)
253 #define E2P_CMD_EPC_CMD_ERAL_		(0x60000000)
254 #define E2P_CMD_EPC_CMD_RELOAD_		(0x70000000)
255 #define E2P_CMD_EPC_TIMEOUT_		(0x00000200)
256 #define E2P_CMD_MAC_ADDR_LOADED_	(0x00000100)
257 #define E2P_CMD_EPC_ADDR_		(0x000000FF)
258 
259 #define E2P_DATA			(0xFC)
260 #define E2P_DATA_EEPROM_DATA_		(0x000000FF)
261 
262 #endif /* _SMSC9420_H */
263