xref: /linux/drivers/net/ethernet/intel/ice/ice_common.h (revision ab93e0dd72c37d378dd936f031ffb83ff2bd87ce)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Copyright (c) 2018, Intel Corporation. */
3 
4 #ifndef _ICE_COMMON_H_
5 #define _ICE_COMMON_H_
6 
7 #include <linux/bitfield.h>
8 
9 #include "ice.h"
10 #include "ice_type.h"
11 #include "ice_nvm.h"
12 #include "ice_flex_pipe.h"
13 #include "ice_parser.h"
14 #include <linux/avf/virtchnl.h>
15 #include "ice_switch.h"
16 #include "ice_fdir.h"
17 
18 #define ICE_SQ_SEND_DELAY_TIME_MS	10
19 #define ICE_SQ_SEND_MAX_EXECUTE		3
20 
21 #define FEC_REG_SHIFT 2
22 #define FEC_RECV_ID_SHIFT 4
23 #define FEC_CORR_LOW_REG_PORT0 (0x02 << FEC_REG_SHIFT)
24 #define FEC_CORR_HIGH_REG_PORT0 (0x03 << FEC_REG_SHIFT)
25 #define FEC_UNCORR_LOW_REG_PORT0 (0x04 << FEC_REG_SHIFT)
26 #define FEC_UNCORR_HIGH_REG_PORT0 (0x05 << FEC_REG_SHIFT)
27 #define FEC_CORR_LOW_REG_PORT1 (0x42 << FEC_REG_SHIFT)
28 #define FEC_CORR_HIGH_REG_PORT1 (0x43 << FEC_REG_SHIFT)
29 #define FEC_UNCORR_LOW_REG_PORT1 (0x44 << FEC_REG_SHIFT)
30 #define FEC_UNCORR_HIGH_REG_PORT1 (0x45 << FEC_REG_SHIFT)
31 #define FEC_CORR_LOW_REG_PORT2 (0x4A << FEC_REG_SHIFT)
32 #define FEC_CORR_HIGH_REG_PORT2 (0x4B << FEC_REG_SHIFT)
33 #define FEC_UNCORR_LOW_REG_PORT2 (0x4C << FEC_REG_SHIFT)
34 #define FEC_UNCORR_HIGH_REG_PORT2 (0x4D << FEC_REG_SHIFT)
35 #define FEC_CORR_LOW_REG_PORT3 (0x52 << FEC_REG_SHIFT)
36 #define FEC_CORR_HIGH_REG_PORT3 (0x53 << FEC_REG_SHIFT)
37 #define FEC_UNCORR_LOW_REG_PORT3 (0x54 << FEC_REG_SHIFT)
38 #define FEC_UNCORR_HIGH_REG_PORT3 (0x55 << FEC_REG_SHIFT)
39 #define FEC_RECEIVER_ID_PCS0 (0x33 << FEC_RECV_ID_SHIFT)
40 #define FEC_RECEIVER_ID_PCS1 (0x34 << FEC_RECV_ID_SHIFT)
41 
42 #define ICE_CGU_R9			0x24
43 #define ICE_CGU_R9_TIME_REF_FREQ_SEL	GENMASK(2, 0)
44 #define ICE_CGU_R9_CLK_EREF0_EN		BIT(4)
45 #define ICE_CGU_R9_TIME_REF_EN		BIT(5)
46 #define ICE_CGU_R9_TIME_SYNC_EN		BIT(6)
47 #define ICE_CGU_R9_ONE_PPS_OUT_EN	BIT(7)
48 #define ICE_CGU_R9_ONE_PPS_OUT_AMP	GENMASK(19, 18)
49 
50 #define ICE_CGU_R16			0x40
51 #define ICE_CGU_R16_TSPLL_CK_REFCLKFREQ	GENMASK(31, 24)
52 
53 #define ICE_CGU_R19			0x4C
54 #define ICE_CGU_R19_TSPLL_FBDIV_INTGR_E82X	GENMASK(7, 0)
55 #define ICE_CGU_R19_TSPLL_FBDIV_INTGR_E825	GENMASK(9, 0)
56 #define ICE_CGU_R19_TSPLL_NDIVRATIO	GENMASK(19, 16)
57 
58 #define ICE_CGU_R22			0x58
59 #define ICE_CGU_R22_TIME1588CLK_DIV	GENMASK(23, 20)
60 #define ICE_CGU_R22_TIME1588CLK_DIV2	BIT(30)
61 
62 #define ICE_CGU_R23			0x5C
63 #define ICE_CGU_R24			0x60
64 #define ICE_CGU_R24_FBDIV_FRAC		GENMASK(21, 0)
65 #define ICE_CGU_R23_R24_TSPLL_ENABLE	BIT(24)
66 #define ICE_CGU_R23_R24_REF1588_CK_DIV	GENMASK(30, 27)
67 #define ICE_CGU_R23_R24_TIME_REF_SEL	BIT(31)
68 
69 #define ICE_CGU_BW_TDC			0x31C
70 #define ICE_CGU_BW_TDC_PLLLOCK_SEL	GENMASK(30, 29)
71 
72 #define ICE_CGU_RO_LOCK			0x3F0
73 #define ICE_CGU_RO_LOCK_TRUE_LOCK	BIT(12)
74 #define ICE_CGU_RO_LOCK_UNLOCK		BIT(13)
75 
76 #define ICE_CGU_CNTR_BIST		0x344
77 #define ICE_CGU_CNTR_BIST_PLLLOCK_SEL_0	BIT(15)
78 #define ICE_CGU_CNTR_BIST_PLLLOCK_SEL_1	BIT(16)
79 
80 #define ICE_CGU_RO_BWM_LF		0x370
81 #define ICE_CGU_RO_BWM_LF_TRUE_LOCK	BIT(12)
82 
83 int ice_init_hw(struct ice_hw *hw);
84 void ice_deinit_hw(struct ice_hw *hw);
85 int ice_check_reset(struct ice_hw *hw);
86 int ice_reset(struct ice_hw *hw, enum ice_reset_req req);
87 int ice_create_all_ctrlq(struct ice_hw *hw);
88 int ice_init_all_ctrlq(struct ice_hw *hw);
89 void ice_shutdown_all_ctrlq(struct ice_hw *hw, bool unloading);
90 void ice_destroy_all_ctrlq(struct ice_hw *hw);
91 int
92 ice_clean_rq_elem(struct ice_hw *hw, struct ice_ctl_q_info *cq,
93 		  struct ice_rq_event_info *e, u16 *pending);
94 int
95 ice_get_link_status(struct ice_port_info *pi, bool *link_up);
96 int ice_update_link_info(struct ice_port_info *pi);
97 int
98 ice_acquire_res(struct ice_hw *hw, enum ice_aq_res_ids res,
99 		enum ice_aq_res_access_type access, u32 timeout);
100 void ice_release_res(struct ice_hw *hw, enum ice_aq_res_ids res);
101 int
102 ice_alloc_hw_res(struct ice_hw *hw, u16 type, u16 num, bool btm, u16 *res);
103 int
104 ice_free_hw_res(struct ice_hw *hw, u16 type, u16 num, u16 *res);
105 int ice_aq_alloc_free_res(struct ice_hw *hw,
106 			  struct ice_aqc_alloc_free_res_elem *buf, u16 buf_size,
107 			  enum ice_adminq_opc opc);
108 bool ice_is_sbq_supported(struct ice_hw *hw);
109 struct ice_ctl_q_info *ice_get_sbq(struct ice_hw *hw);
110 int
111 ice_sq_send_cmd(struct ice_hw *hw, struct ice_ctl_q_info *cq,
112 		struct libie_aq_desc *desc, void *buf, u16 buf_size,
113 		struct ice_sq_cd *cd);
114 void ice_clear_pxe_mode(struct ice_hw *hw);
115 int ice_get_caps(struct ice_hw *hw);
116 
117 void ice_set_safe_mode_caps(struct ice_hw *hw);
118 
119 int ice_write_rxq_ctx(struct ice_hw *hw, struct ice_rlan_ctx *rlan_ctx,
120 		      u32 rxq_index);
121 int ice_read_rxq_ctx(struct ice_hw *hw, struct ice_rlan_ctx *rlan_ctx,
122 		     u32 rxq_index);
123 int ice_read_txq_ctx(struct ice_hw *hw, struct ice_tlan_ctx *tlan_ctx,
124 		     u32 txq_index);
125 int ice_write_txq_ctx(struct ice_hw *hw, struct ice_tlan_ctx *tlan_ctx,
126 		      u32 txq_index);
127 
128 int
129 ice_aq_get_rss_lut(struct ice_hw *hw, struct ice_aq_get_set_rss_lut_params *get_params);
130 int
131 ice_aq_set_rss_lut(struct ice_hw *hw, struct ice_aq_get_set_rss_lut_params *set_params);
132 int
133 ice_aq_get_rss_key(struct ice_hw *hw, u16 vsi_handle,
134 		   struct ice_aqc_get_set_rss_keys *keys);
135 int
136 ice_aq_set_rss_key(struct ice_hw *hw, u16 vsi_handle,
137 		   struct ice_aqc_get_set_rss_keys *keys);
138 
139 bool ice_check_sq_alive(struct ice_hw *hw, struct ice_ctl_q_info *cq);
140 int ice_aq_q_shutdown(struct ice_hw *hw, bool unloading);
141 void ice_fill_dflt_direct_cmd_desc(struct libie_aq_desc *desc, u16 opcode);
142 
143 void ice_pack_txq_ctx(const struct ice_tlan_ctx *ctx, ice_txq_ctx_buf_t *buf);
144 
145 extern struct mutex ice_global_cfg_lock_sw;
146 
147 int
148 ice_aq_send_cmd(struct ice_hw *hw, struct libie_aq_desc *desc,
149 		void *buf, u16 buf_size, struct ice_sq_cd *cd);
150 int ice_aq_get_fw_ver(struct ice_hw *hw, struct ice_sq_cd *cd);
151 
152 int
153 ice_aq_send_driver_ver(struct ice_hw *hw, struct ice_driver_ver *dv,
154 		       struct ice_sq_cd *cd);
155 int
156 ice_aq_set_port_params(struct ice_port_info *pi, bool double_vlan,
157 		       struct ice_sq_cd *cd);
158 int
159 ice_aq_get_phy_caps(struct ice_port_info *pi, bool qual_mods, u8 report_mode,
160 		    struct ice_aqc_get_phy_caps_data *caps,
161 		    struct ice_sq_cd *cd);
162 bool ice_is_phy_rclk_in_netlist(struct ice_hw *hw);
163 bool ice_is_clock_mux_in_netlist(struct ice_hw *hw);
164 bool ice_is_cgu_in_netlist(struct ice_hw *hw);
165 bool ice_is_gps_in_netlist(struct ice_hw *hw);
166 int
167 ice_aq_get_netlist_node(struct ice_hw *hw, struct ice_aqc_get_link_topo *cmd,
168 			u8 *node_part_number, u16 *node_handle);
169 int
170 ice_aq_list_caps(struct ice_hw *hw, void *buf, u16 buf_size, u32 *cap_count,
171 		 enum ice_adminq_opc opc, struct ice_sq_cd *cd);
172 int
173 ice_discover_dev_caps(struct ice_hw *hw, struct ice_hw_dev_caps *dev_caps);
174 void
175 ice_update_phy_type(u64 *phy_type_low, u64 *phy_type_high,
176 		    u16 link_speeds_bitmap);
177 int
178 ice_aq_manage_mac_write(struct ice_hw *hw, const u8 *mac_addr, u8 flags,
179 			struct ice_sq_cd *cd);
180 bool ice_is_generic_mac(struct ice_hw *hw);
181 int ice_clear_pf_cfg(struct ice_hw *hw);
182 int
183 ice_aq_set_phy_cfg(struct ice_hw *hw, struct ice_port_info *pi,
184 		   struct ice_aqc_set_phy_cfg_data *cfg, struct ice_sq_cd *cd);
185 bool ice_fw_supports_link_override(struct ice_hw *hw);
186 int
187 ice_get_link_default_override(struct ice_link_default_override_tlv *ldo,
188 			      struct ice_port_info *pi);
189 bool ice_is_phy_caps_an_enabled(struct ice_aqc_get_phy_caps_data *caps);
190 bool ice_is_fw_health_report_supported(struct ice_hw *hw);
191 int ice_aq_set_health_status_cfg(struct ice_hw *hw, u8 event_source);
192 int ice_aq_get_phy_equalization(struct ice_hw *hw, u16 data_in, u16 op_code,
193 				u8 serdes_num, int *output);
194 int
195 ice_aq_get_fec_stats(struct ice_hw *hw, u16 pcs_quad, u16 pcs_port,
196 		     enum ice_fec_stats_types fec_type, u32 *output);
197 
198 enum ice_fc_mode ice_caps_to_fc_mode(u8 caps);
199 enum ice_fec_mode ice_caps_to_fec_mode(u8 caps, u8 fec_options);
200 int
201 ice_set_fc(struct ice_port_info *pi, u8 *aq_failures,
202 	   bool ena_auto_link_update);
203 int
204 ice_cfg_phy_fc(struct ice_port_info *pi, struct ice_aqc_set_phy_cfg_data *cfg,
205 	       enum ice_fc_mode req_mode);
206 bool
207 ice_phy_caps_equals_cfg(struct ice_aqc_get_phy_caps_data *caps,
208 			struct ice_aqc_set_phy_cfg_data *cfg);
209 void
210 ice_copy_phy_caps_to_cfg(struct ice_port_info *pi,
211 			 struct ice_aqc_get_phy_caps_data *caps,
212 			 struct ice_aqc_set_phy_cfg_data *cfg);
213 int
214 ice_cfg_phy_fec(struct ice_port_info *pi, struct ice_aqc_set_phy_cfg_data *cfg,
215 		enum ice_fec_mode fec);
216 int
217 ice_aq_set_link_restart_an(struct ice_port_info *pi, bool ena_link,
218 			   struct ice_sq_cd *cd);
219 int
220 ice_aq_set_mac_cfg(struct ice_hw *hw, u16 max_frame_size, struct ice_sq_cd *cd);
221 int
222 ice_aq_get_link_info(struct ice_port_info *pi, bool ena_lse,
223 		     struct ice_link_status *link, struct ice_sq_cd *cd);
224 int
225 ice_aq_set_event_mask(struct ice_hw *hw, u8 port_num, u16 mask,
226 		      struct ice_sq_cd *cd);
227 int
228 ice_aq_set_mac_loopback(struct ice_hw *hw, bool ena_lpbk, struct ice_sq_cd *cd);
229 
230 int
231 ice_aq_set_port_id_led(struct ice_port_info *pi, bool is_orig_mode,
232 		       struct ice_sq_cd *cd);
233 int
234 ice_aq_get_port_options(struct ice_hw *hw,
235 			struct ice_aqc_get_port_options_elem *options,
236 			u8 *option_count, u8 lport, bool lport_valid,
237 			u8 *active_option_idx, bool *active_option_valid,
238 			u8 *pending_option_idx, bool *pending_option_valid);
239 int
240 ice_aq_set_port_option(struct ice_hw *hw, u8 lport, u8 lport_valid,
241 		       u8 new_option);
242 int ice_get_phy_lane_number(struct ice_hw *hw);
243 int
244 ice_aq_sff_eeprom(struct ice_hw *hw, u16 lport, u8 bus_addr,
245 		  u16 mem_addr, u8 page, u8 set_page, u8 *data, u8 length,
246 		  bool write, struct ice_sq_cd *cd);
247 u32 ice_get_link_speed(u16 index);
248 
249 int
250 ice_cfg_vsi_rdma(struct ice_port_info *pi, u16 vsi_handle, u16 tc_bitmap,
251 		 u16 *max_rdmaqs);
252 int
253 ice_ena_vsi_rdma_qset(struct ice_port_info *pi, u16 vsi_handle, u8 tc,
254 		      u16 *rdma_qset, u16 num_qsets, u32 *qset_teid);
255 int
256 ice_dis_vsi_rdma_qset(struct ice_port_info *pi, u16 count, u32 *qset_teid,
257 		      u16 *q_id);
258 int
259 ice_dis_vsi_txq(struct ice_port_info *pi, u16 vsi_handle, u8 tc, u8 num_queues,
260 		u16 *q_handle, u16 *q_ids, u32 *q_teids,
261 		enum ice_disq_rst_src rst_src, u16 vmvf_num,
262 		struct ice_sq_cd *cd);
263 int
264 ice_cfg_vsi_lan(struct ice_port_info *pi, u16 vsi_handle, u8 tc_bitmap,
265 		u16 *max_lanqs);
266 int
267 ice_ena_vsi_txq(struct ice_port_info *pi, u16 vsi_handle, u8 tc, u16 q_handle,
268 		u8 num_qgrps, struct ice_aqc_add_tx_qgrp *buf, u16 buf_size,
269 		struct ice_sq_cd *cd);
270 int
271 ice_aq_cfg_lan_txq(struct ice_hw *hw, struct ice_aqc_cfg_txqs_buf *buf,
272 		   u16 buf_size, u16 num_qs, u8 oldport, u8 newport,
273 		   struct ice_sq_cd *cd);
274 int ice_replay_vsi(struct ice_hw *hw, u16 vsi_handle);
275 void ice_replay_post(struct ice_hw *hw);
276 struct ice_q_ctx *
277 ice_get_lan_q_ctx(struct ice_hw *hw, u16 vsi_handle, u8 tc, u16 q_handle);
278 int ice_sbq_rw_reg(struct ice_hw *hw, struct ice_sbq_msg_input *in, u16 flag);
279 int ice_aq_get_cgu_input_pin_measure(struct ice_hw *hw, u8 dpll_idx,
280 				     struct ice_cgu_input_measure *meas,
281 				     u16 meas_num);
282 int
283 ice_aq_get_cgu_abilities(struct ice_hw *hw,
284 			 struct ice_aqc_get_cgu_abilities *abilities);
285 int
286 ice_aq_set_input_pin_cfg(struct ice_hw *hw, u8 input_idx, u8 flags1, u8 flags2,
287 			 u32 freq, s32 phase_delay);
288 int
289 ice_aq_get_input_pin_cfg(struct ice_hw *hw, u8 input_idx, u8 *status, u8 *type,
290 			 u8 *flags1, u8 *flags2, u32 *freq, s32 *phase_delay);
291 int
292 ice_aq_set_output_pin_cfg(struct ice_hw *hw, u8 output_idx, u8 flags,
293 			  u8 src_sel, u32 freq, s32 phase_delay);
294 int
295 ice_aq_get_output_pin_cfg(struct ice_hw *hw, u8 output_idx, u8 *flags,
296 			  u8 *src_sel, u32 *freq, u32 *src_freq);
297 int
298 ice_aq_get_cgu_dpll_status(struct ice_hw *hw, u8 dpll_num, u8 *ref_state,
299 			   u8 *dpll_state, u8 *config, s64 *phase_offset,
300 			   u8 *eec_mode);
301 int
302 ice_aq_set_cgu_dpll_config(struct ice_hw *hw, u8 dpll_num, u8 ref_state,
303 			   u8 config, u8 eec_mode);
304 int
305 ice_aq_set_cgu_ref_prio(struct ice_hw *hw, u8 dpll_num, u8 ref_idx,
306 			u8 ref_priority);
307 int
308 ice_aq_get_cgu_ref_prio(struct ice_hw *hw, u8 dpll_num, u8 ref_idx,
309 			u8 *ref_prio);
310 int
311 ice_aq_get_cgu_info(struct ice_hw *hw, u32 *cgu_id, u32 *cgu_cfg_ver,
312 		    u32 *cgu_fw_ver);
313 
314 int
315 ice_aq_set_phy_rec_clk_out(struct ice_hw *hw, u8 phy_output, bool enable,
316 			   u32 *freq);
317 int
318 ice_aq_get_phy_rec_clk_out(struct ice_hw *hw, u8 *phy_output, u8 *port_num,
319 			   u8 *flags, u16 *node_handle);
320 int ice_aq_get_sensor_reading(struct ice_hw *hw,
321 			      struct ice_aqc_get_sensor_reading_resp *data);
322 void
323 ice_stat_update40(struct ice_hw *hw, u32 reg, bool prev_stat_loaded,
324 		  u64 *prev_stat, u64 *cur_stat);
325 void
326 ice_stat_update32(struct ice_hw *hw, u32 reg, bool prev_stat_loaded,
327 		  u64 *prev_stat, u64 *cur_stat);
328 int
329 ice_sched_query_elem(struct ice_hw *hw, u32 node_teid,
330 		     struct ice_aqc_txsched_elem_data *buf);
331 int
332 ice_aq_set_gpio(struct ice_hw *hw, u16 gpio_ctrl_handle, u8 pin_idx, bool value,
333 		struct ice_sq_cd *cd);
334 int
335 ice_aq_get_gpio(struct ice_hw *hw, u16 gpio_ctrl_handle, u8 pin_idx,
336 		bool *value, struct ice_sq_cd *cd);
337 bool ice_is_100m_speed_supported(struct ice_hw *hw);
338 u16 ice_get_link_speed_based_on_phy_type(u64 phy_type_low, u64 phy_type_high);
339 int
340 ice_aq_set_lldp_mib(struct ice_hw *hw, u8 mib_type, void *buf, u16 buf_size,
341 		    struct ice_sq_cd *cd);
342 bool ice_fw_supports_lldp_fltr_ctrl(struct ice_hw *hw);
343 int ice_lldp_fltr_add_remove(struct ice_hw *hw, struct ice_vsi *vsi, bool add);
344 int ice_lldp_execute_pending_mib(struct ice_hw *hw);
345 int
346 ice_aq_read_i2c(struct ice_hw *hw, struct ice_aqc_link_topo_addr topo_addr,
347 		u16 bus_addr, __le16 addr, u8 params, u8 *data,
348 		struct ice_sq_cd *cd);
349 int
350 ice_aq_write_i2c(struct ice_hw *hw, struct ice_aqc_link_topo_addr topo_addr,
351 		 u16 bus_addr, __le16 addr, u8 params, const u8 *data,
352 		 struct ice_sq_cd *cd);
353 int ice_get_pca9575_handle(struct ice_hw *hw, u16 *pca9575_handle);
354 int ice_read_pca9575_reg(struct ice_hw *hw, u8 offset, u8 *data);
355 bool ice_fw_supports_report_dflt_cfg(struct ice_hw *hw);
356 int ice_read_cgu_reg(struct ice_hw *hw, u32 addr, u32 *val);
357 int ice_write_cgu_reg(struct ice_hw *hw, u32 addr, u32 val);
358 #endif /* _ICE_COMMON_H_ */
359