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_phy_type {
57 	igc_phy_unknown = 0,
58 	igc_phy_i225,
59 };
60 
61 enum igc_media_type {
62 	igc_media_type_unknown = 0,
63 	igc_media_type_copper = 1,
64 	igc_num_media_types
65 };
66 
67 enum igc_nvm_type {
68 	igc_nvm_unknown = 0,
69 	igc_nvm_eeprom_spi,
70 };
71 
72 struct igc_info {
73 	s32 (*get_invariants)(struct igc_hw *hw);
74 	struct igc_mac_operations *mac_ops;
75 	const struct igc_phy_operations *phy_ops;
76 	struct igc_nvm_operations *nvm_ops;
77 };
78 
79 extern const struct igc_info igc_base_info;
80 
81 struct igc_mac_info {
82 	struct igc_mac_operations ops;
83 
84 	u8 addr[ETH_ALEN];
85 	u8 perm_addr[ETH_ALEN];
86 
87 	enum igc_mac_type type;
88 
89 	u32 mc_filter_type;
90 
91 	u16 mta_reg_count;
92 	u16 uta_reg_count;
93 
94 	u32 mta_shadow[MAX_MTA_REG];
95 	u16 rar_entry_count;
96 
97 	u8 forced_speed_duplex;
98 
99 	bool asf_firmware_present;
100 	bool arc_subsystem_valid;
101 
102 	bool autoneg;
103 	bool autoneg_failed;
104 	bool get_link_status;
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 	enum igc_phy_type type;
142 
143 	u32 addr;
144 	u32 id;
145 	u32 reset_delay_us; /* in usec */
146 	u32 revision;
147 
148 	enum igc_media_type media_type;
149 
150 	u16 autoneg_advertised;
151 	u16 autoneg_mask;
152 
153 	u8 mdix;
154 
155 	bool is_mdix;
156 	bool speed_downgraded;
157 	bool autoneg_wait_to_complete;
158 };
159 
160 struct igc_bus_info {
161 	u16 func;
162 	u16 pci_cmd_word;
163 };
164 
165 enum igc_fc_mode {
166 	igc_fc_none = 0,
167 	igc_fc_rx_pause,
168 	igc_fc_tx_pause,
169 	igc_fc_full,
170 	igc_fc_default = 0xFF
171 };
172 
173 struct igc_fc_info {
174 	u32 high_water;     /* Flow control high-water mark */
175 	u32 low_water;      /* Flow control low-water mark */
176 	u16 pause_time;     /* Flow control pause timer */
177 	bool send_xon;      /* Flow control send XON */
178 	bool strict_ieee;   /* Strict IEEE mode */
179 	enum igc_fc_mode current_mode; /* Type of flow control */
180 	enum igc_fc_mode requested_mode;
181 };
182 
183 struct igc_dev_spec_base {
184 	bool clear_semaphore_once;
185 	bool eee_enable;
186 };
187 
188 struct igc_hw {
189 	void *back;
190 
191 	u8 __iomem *hw_addr;
192 	unsigned long io_base;
193 
194 	struct igc_mac_info  mac;
195 	struct igc_fc_info   fc;
196 	struct igc_nvm_info  nvm;
197 	struct igc_phy_info  phy;
198 
199 	struct igc_bus_info bus;
200 
201 	union {
202 		struct igc_dev_spec_base	_base;
203 	} dev_spec;
204 
205 	u16 device_id;
206 	u16 subsystem_vendor_id;
207 	u16 subsystem_device_id;
208 	u16 vendor_id;
209 
210 	u8 revision_id;
211 };
212 
213 /* Statistics counters collected by the MAC */
214 struct igc_hw_stats {
215 	u64 crcerrs;
216 	u64 algnerrc;
217 	u64 symerrs;
218 	u64 rxerrc;
219 	u64 mpc;
220 	u64 scc;
221 	u64 ecol;
222 	u64 mcc;
223 	u64 latecol;
224 	u64 colc;
225 	u64 dc;
226 	u64 tncrs;
227 	u64 sec;
228 	u64 cexterr;
229 	u64 rlec;
230 	u64 xonrxc;
231 	u64 xontxc;
232 	u64 xoffrxc;
233 	u64 xofftxc;
234 	u64 fcruc;
235 	u64 prc64;
236 	u64 prc127;
237 	u64 prc255;
238 	u64 prc511;
239 	u64 prc1023;
240 	u64 prc1522;
241 	u64 tlpic;
242 	u64 rlpic;
243 	u64 gprc;
244 	u64 bprc;
245 	u64 mprc;
246 	u64 gptc;
247 	u64 gorc;
248 	u64 gotc;
249 	u64 rnbc;
250 	u64 ruc;
251 	u64 rfc;
252 	u64 roc;
253 	u64 rjc;
254 	u64 mgprc;
255 	u64 mgpdc;
256 	u64 mgptc;
257 	u64 tor;
258 	u64 tot;
259 	u64 tpr;
260 	u64 tpt;
261 	u64 ptc64;
262 	u64 ptc127;
263 	u64 ptc255;
264 	u64 ptc511;
265 	u64 ptc1023;
266 	u64 ptc1522;
267 	u64 mptc;
268 	u64 bptc;
269 	u64 tsctc;
270 	u64 tsctfc;
271 	u64 iac;
272 	u64 htdpmc;
273 	u64 rpthc;
274 	u64 hgptc;
275 	u64 hgorc;
276 	u64 hgotc;
277 	u64 lenerrs;
278 	u64 scvpc;
279 	u64 hrmpc;
280 	u64 doosync;
281 	u64 o2bgptc;
282 	u64 o2bspc;
283 	u64 b2ospc;
284 	u64 b2ogprc;
285 };
286 
287 struct net_device *igc_get_hw_dev(struct igc_hw *hw);
288 #define hw_dbg(format, arg...) \
289 	netdev_dbg(igc_get_hw_dev(hw), format, ##arg)
290 
291 s32  igc_read_pcie_cap_reg(struct igc_hw *hw, u32 reg, u16 *value);
292 s32  igc_write_pcie_cap_reg(struct igc_hw *hw, u32 reg, u16 *value);
293 void igc_read_pci_cfg(struct igc_hw *hw, u32 reg, u16 *value);
294 void igc_write_pci_cfg(struct igc_hw *hw, u32 reg, u16 *value);
295 
296 #endif /* _IGC_HW_H_ */
297