xref: /linux/drivers/net/ethernet/intel/igc/igc_hw.h (revision 91ec2035134982b98fab0609a9fd8480e8217dc1)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Copyright (c)  2018 Intel Corporation */
3 
4 #ifndef _IGC_HW_H_
5 #define _IGC_HW_H_
6 
7 #include <linux/types.h>
8 #include <linux/if_ether.h>
9 #include <linux/netdevice.h>
10 
11 #include "igc_regs.h"
12 #include "igc_defines.h"
13 #include "igc_mac.h"
14 #include "igc_phy.h"
15 #include "igc_nvm.h"
16 #include "igc_i225.h"
17 #include "igc_base.h"
18 
19 #define IGC_DEV_ID_I225_LM			0x15F2
20 #define IGC_DEV_ID_I225_V			0x15F3
21 #define IGC_DEV_ID_I225_I			0x15F8
22 #define IGC_DEV_ID_I220_V			0x15F7
23 #define IGC_DEV_ID_I225_K			0x3100
24 #define IGC_DEV_ID_I225_K2			0x3101
25 #define IGC_DEV_ID_I226_K			0x3102
26 #define IGC_DEV_ID_I225_LMVP			0x5502
27 #define IGC_DEV_ID_I226_LMVP			0x5503
28 #define IGC_DEV_ID_I225_IT			0x0D9F
29 #define IGC_DEV_ID_I226_LM			0x125B
30 #define IGC_DEV_ID_I226_V			0x125C
31 #define IGC_DEV_ID_I226_IT			0x125D
32 #define IGC_DEV_ID_I221_V			0x125E
33 #define IGC_DEV_ID_I226_BLANK_NVM		0x125F
34 #define IGC_DEV_ID_I225_BLANK_NVM		0x15FD
35 
36 /* Function pointers for the MAC. */
37 struct igc_mac_operations {
38 	s32 (*check_for_link)(struct igc_hw *hw);
39 	s32 (*reset_hw)(struct igc_hw *hw);
40 	s32 (*init_hw)(struct igc_hw *hw);
41 	s32 (*setup_physical_interface)(struct igc_hw *hw);
42 	void (*rar_set)(struct igc_hw *hw, u8 *address, u32 index);
43 	s32 (*read_mac_addr)(struct igc_hw *hw);
44 	s32 (*get_speed_and_duplex)(struct igc_hw *hw, u16 *speed,
45 				    u16 *duplex);
46 	s32 (*acquire_swfw_sync)(struct igc_hw *hw, u16 mask);
47 	void (*release_swfw_sync)(struct igc_hw *hw, u16 mask);
48 };
49 
50 enum igc_mac_type {
51 	igc_undefined = 0,
52 	igc_i225,
53 	igc_num_macs  /* List is 1-based, so subtract 1 for true count. */
54 };
55 
56 enum igc_media_type {
57 	igc_media_type_unknown = 0,
58 	igc_media_type_copper = 1,
59 	igc_num_media_types
60 };
61 
62 enum igc_nvm_type {
63 	igc_nvm_unknown = 0,
64 	igc_nvm_eeprom_spi,
65 };
66 
67 struct igc_info {
68 	s32 (*get_invariants)(struct igc_hw *hw);
69 	struct igc_mac_operations *mac_ops;
70 	const struct igc_phy_operations *phy_ops;
71 	struct igc_nvm_operations *nvm_ops;
72 };
73 
74 extern const struct igc_info igc_base_info;
75 
76 enum igc_forced_speed_duplex {
77 	IGC_FORCED_10H,
78 	IGC_FORCED_10F,
79 	IGC_FORCED_100H,
80 	IGC_FORCED_100F,
81 };
82 
83 struct igc_mac_info {
84 	struct igc_mac_operations ops;
85 
86 	u8 addr[ETH_ALEN];
87 	u8 perm_addr[ETH_ALEN];
88 
89 	enum igc_mac_type type;
90 
91 	u32 mc_filter_type;
92 
93 	u16 mta_reg_count;
94 	u16 uta_reg_count;
95 
96 	u32 mta_shadow[MAX_MTA_REG];
97 	u16 rar_entry_count;
98 
99 	bool asf_firmware_present;
100 	bool arc_subsystem_valid;
101 
102 	bool get_link_status;
103 	bool autoneg_enabled;
104 	enum igc_forced_speed_duplex forced_speed_duplex;
105 };
106 
107 struct igc_nvm_operations {
108 	s32 (*acquire)(struct igc_hw *hw);
109 	s32 (*read)(struct igc_hw *hw, u16 offset, u16 i, u16 *data);
110 	void (*release)(struct igc_hw *hw);
111 	s32 (*write)(struct igc_hw *hw, u16 offset, u16 i, u16 *data);
112 	s32 (*update)(struct igc_hw *hw);
113 	s32 (*validate)(struct igc_hw *hw);
114 };
115 
116 struct igc_phy_operations {
117 	s32 (*acquire)(struct igc_hw *hw);
118 	s32 (*check_reset_block)(struct igc_hw *hw);
119 	s32 (*force_speed_duplex)(struct igc_hw *hw);
120 	s32 (*get_phy_info)(struct igc_hw *hw);
121 	s32 (*read_reg)(struct igc_hw *hw, u32 address, u16 *data);
122 	void (*release)(struct igc_hw *hw);
123 	s32 (*reset)(struct igc_hw *hw);
124 	s32 (*write_reg)(struct igc_hw *hw, u32 address, u16 data);
125 };
126 
127 struct igc_nvm_info {
128 	struct igc_nvm_operations ops;
129 	enum igc_nvm_type type;
130 
131 	u16 word_size;
132 	u16 delay_usec;
133 	u16 address_bits;
134 	u16 opcode_bits;
135 	u16 page_size;
136 };
137 
138 struct igc_phy_info {
139 	struct igc_phy_operations ops;
140 
141 	u32 addr;
142 	u32 id;
143 	u32 reset_delay_us; /* in usec */
144 	u32 revision;
145 
146 	enum igc_media_type media_type;
147 
148 	u16 autoneg_advertised;
149 	u16 autoneg_mask;
150 
151 	u8 mdix;
152 
153 	bool is_mdix;
154 	bool speed_downgraded;
155 	bool autoneg_wait_to_complete;
156 };
157 
158 struct igc_bus_info {
159 	u16 func;
160 	u16 pci_cmd_word;
161 };
162 
163 enum igc_fc_mode {
164 	igc_fc_none = 0,
165 	igc_fc_rx_pause,
166 	igc_fc_tx_pause,
167 	igc_fc_full,
168 	igc_fc_default = 0xFF
169 };
170 
171 struct igc_fc_info {
172 	u32 high_water;     /* Flow control high-water mark */
173 	u32 low_water;      /* Flow control low-water mark */
174 	u16 pause_time;     /* Flow control pause timer */
175 	bool send_xon;      /* Flow control send XON */
176 	bool strict_ieee;   /* Strict IEEE mode */
177 	enum igc_fc_mode current_mode; /* Type of flow control */
178 	enum igc_fc_mode requested_mode;
179 };
180 
181 struct igc_dev_spec_base {
182 	bool clear_semaphore_once;
183 	bool eee_enable;
184 };
185 
186 struct igc_hw {
187 	void *back;
188 
189 	u8 __iomem *hw_addr;
190 	unsigned long io_base;
191 
192 	struct igc_mac_info  mac;
193 	struct igc_fc_info   fc;
194 	struct igc_nvm_info  nvm;
195 	struct igc_phy_info  phy;
196 
197 	struct igc_bus_info bus;
198 
199 	union {
200 		struct igc_dev_spec_base	_base;
201 	} dev_spec;
202 
203 	u16 device_id;
204 	u16 subsystem_vendor_id;
205 	u16 subsystem_device_id;
206 	u16 vendor_id;
207 
208 	u8 revision_id;
209 };
210 
211 /* Statistics counters collected by the MAC */
212 struct igc_hw_stats {
213 	u64 crcerrs;
214 	u64 algnerrc;
215 	u64 symerrs;
216 	u64 rxerrc;
217 	u64 mpc;
218 	u64 scc;
219 	u64 ecol;
220 	u64 mcc;
221 	u64 latecol;
222 	u64 colc;
223 	u64 dc;
224 	u64 tncrs;
225 	u64 sec;
226 	u64 cexterr;
227 	u64 rlec;
228 	u64 xonrxc;
229 	u64 xontxc;
230 	u64 xoffrxc;
231 	u64 xofftxc;
232 	u64 fcruc;
233 	u64 prc64;
234 	u64 prc127;
235 	u64 prc255;
236 	u64 prc511;
237 	u64 prc1023;
238 	u64 prc1522;
239 	u64 tlpic;
240 	u64 rlpic;
241 	u64 gprc;
242 	u64 bprc;
243 	u64 mprc;
244 	u64 gptc;
245 	u64 gorc;
246 	u64 gotc;
247 	u64 rnbc;
248 	u64 ruc;
249 	u64 rfc;
250 	u64 roc;
251 	u64 rjc;
252 	u64 mgprc;
253 	u64 mgpdc;
254 	u64 mgptc;
255 	u64 tor;
256 	u64 tot;
257 	u64 tpr;
258 	u64 tpt;
259 	u64 ptc64;
260 	u64 ptc127;
261 	u64 ptc255;
262 	u64 ptc511;
263 	u64 ptc1023;
264 	u64 ptc1522;
265 	u64 mptc;
266 	u64 bptc;
267 	u64 tsctc;
268 	u64 tsctfc;
269 	u64 iac;
270 	u64 htdpmc;
271 	u64 rpthc;
272 	u64 hgptc;
273 	u64 hgorc;
274 	u64 hgotc;
275 	u64 lenerrs;
276 	u64 scvpc;
277 	u64 hrmpc;
278 	u64 doosync;
279 	u64 o2bgptc;
280 	u64 o2bspc;
281 	u64 b2ospc;
282 	u64 b2ogprc;
283 	u64 txdrop;
284 };
285 
286 struct net_device *igc_get_hw_dev(struct igc_hw *hw);
287 #define hw_dbg(format, arg...) \
288 	netdev_dbg(igc_get_hw_dev(hw), format, ##arg)
289 
290 #endif /* _IGC_HW_H_ */
291