1/******************************************************************************
2  SPDX-License-Identifier: BSD-3-Clause
3
4  Copyright (c) 2001-2020, Intel Corporation
5  All rights reserved.
6
7  Redistribution and use in source and binary forms, with or without
8  modification, are permitted provided that the following conditions are met:
9
10   1. Redistributions of source code must retain the above copyright notice,
11      this list of conditions and the following disclaimer.
12
13   2. Redistributions in binary form must reproduce the above copyright
14      notice, this list of conditions and the following disclaimer in the
15      documentation and/or other materials provided with the distribution.
16
17   3. Neither the name of the Intel Corporation nor the names of its
18      contributors may be used to endorse or promote products derived from
19      this software without specific prior written permission.
20
21  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
25  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  POSSIBILITY OF SUCH DAMAGE.
32
33******************************************************************************/
34
35#ifndef _IXGBE_COMMON_H_
36#define _IXGBE_COMMON_H_
37
38#include "ixgbe_type.h"
39#define IXGBE_WRITE_REG64(hw, reg, value) \
40	do { \
41		IXGBE_WRITE_REG(hw, reg, (u32) value); \
42		IXGBE_WRITE_REG(hw, reg + 4, (u32) (value >> 32)); \
43	} while (0)
44#define IXGBE_REMOVED(a) (0)
45struct ixgbe_pba {
46	u16 word[2];
47	u16 *pba_block;
48};
49
50void ixgbe_dcb_get_rtrup2tc_generic(struct ixgbe_hw *hw, u8 *map);
51
52u16 ixgbe_get_pcie_msix_count_generic(struct ixgbe_hw *hw);
53s32 ixgbe_init_ops_generic(struct ixgbe_hw *hw);
54s32 ixgbe_init_hw_generic(struct ixgbe_hw *hw);
55s32 ixgbe_start_hw_generic(struct ixgbe_hw *hw);
56void ixgbe_start_hw_gen2(struct ixgbe_hw *hw);
57s32 ixgbe_clear_hw_cntrs_generic(struct ixgbe_hw *hw);
58s32 ixgbe_read_pba_num_generic(struct ixgbe_hw *hw, u32 *pba_num);
59s32 ixgbe_read_pba_string_generic(struct ixgbe_hw *hw, u8 *pba_num,
60				  u32 pba_num_size);
61s32 ixgbe_read_pba_raw(struct ixgbe_hw *hw, u16 *eeprom_buf,
62		       u32 eeprom_buf_size, u16 max_pba_block_size,
63		       struct ixgbe_pba *pba);
64s32 ixgbe_write_pba_raw(struct ixgbe_hw *hw, u16 *eeprom_buf,
65			u32 eeprom_buf_size, struct ixgbe_pba *pba);
66s32 ixgbe_get_pba_block_size(struct ixgbe_hw *hw, u16 *eeprom_buf,
67			     u32 eeprom_buf_size, u16 *pba_block_size);
68s32 ixgbe_get_mac_addr_generic(struct ixgbe_hw *hw, u8 *mac_addr);
69s32 ixgbe_get_bus_info_generic(struct ixgbe_hw *hw);
70void ixgbe_set_pci_config_data_generic(struct ixgbe_hw *hw, u16 link_status);
71void ixgbe_set_lan_id_multi_port_pcie(struct ixgbe_hw *hw);
72s32 ixgbe_stop_adapter_generic(struct ixgbe_hw *hw);
73
74s32 ixgbe_led_on_generic(struct ixgbe_hw *hw, u32 index);
75s32 ixgbe_led_off_generic(struct ixgbe_hw *hw, u32 index);
76s32 ixgbe_init_led_link_act_generic(struct ixgbe_hw *hw);
77
78s32 ixgbe_init_eeprom_params_generic(struct ixgbe_hw *hw);
79s32 ixgbe_write_eeprom_generic(struct ixgbe_hw *hw, u16 offset, u16 data);
80s32 ixgbe_write_eeprom_buffer_bit_bang_generic(struct ixgbe_hw *hw, u16 offset,
81					       u16 words, u16 *data);
82s32 ixgbe_read_eerd_generic(struct ixgbe_hw *hw, u16 offset, u16 *data);
83s32 ixgbe_read_eerd_buffer_generic(struct ixgbe_hw *hw, u16 offset,
84				   u16 words, u16 *data);
85s32 ixgbe_write_eewr_generic(struct ixgbe_hw *hw, u16 offset, u16 data);
86s32 ixgbe_write_eewr_buffer_generic(struct ixgbe_hw *hw, u16 offset,
87				    u16 words, u16 *data);
88s32 ixgbe_read_eeprom_bit_bang_generic(struct ixgbe_hw *hw, u16 offset,
89				       u16 *data);
90s32 ixgbe_read_eeprom_buffer_bit_bang_generic(struct ixgbe_hw *hw, u16 offset,
91					      u16 words, u16 *data);
92s32 ixgbe_calc_eeprom_checksum_generic(struct ixgbe_hw *hw);
93s32 ixgbe_validate_eeprom_checksum_generic(struct ixgbe_hw *hw,
94					   u16 *checksum_val);
95s32 ixgbe_update_eeprom_checksum_generic(struct ixgbe_hw *hw);
96s32 ixgbe_poll_eerd_eewr_done(struct ixgbe_hw *hw, u32 ee_reg);
97
98s32 ixgbe_set_rar_generic(struct ixgbe_hw *hw, u32 index, u8 *addr, u32 vmdq,
99			  u32 enable_addr);
100s32 ixgbe_clear_rar_generic(struct ixgbe_hw *hw, u32 index);
101s32 ixgbe_init_rx_addrs_generic(struct ixgbe_hw *hw);
102s32 ixgbe_update_mc_addr_list_generic(struct ixgbe_hw *hw, u8 *mc_addr_list,
103				      u32 mc_addr_count,
104				      ixgbe_mc_addr_itr func, bool clear);
105s32 ixgbe_update_uc_addr_list_generic(struct ixgbe_hw *hw, u8 *addr_list,
106				      u32 addr_count, ixgbe_mc_addr_itr func);
107s32 ixgbe_enable_mc_generic(struct ixgbe_hw *hw);
108s32 ixgbe_disable_mc_generic(struct ixgbe_hw *hw);
109s32 ixgbe_enable_rx_dma_generic(struct ixgbe_hw *hw, u32 regval);
110s32 ixgbe_disable_sec_rx_path_generic(struct ixgbe_hw *hw);
111s32 ixgbe_enable_sec_rx_path_generic(struct ixgbe_hw *hw);
112
113s32 ixgbe_fc_enable_generic(struct ixgbe_hw *hw);
114bool ixgbe_device_supports_autoneg_fc(struct ixgbe_hw *hw);
115void ixgbe_fc_autoneg(struct ixgbe_hw *hw);
116s32 ixgbe_setup_fc_generic(struct ixgbe_hw *hw);
117
118s32 ixgbe_validate_mac_addr(u8 *mac_addr);
119s32 ixgbe_acquire_swfw_sync(struct ixgbe_hw *hw, u32 mask);
120void ixgbe_release_swfw_sync(struct ixgbe_hw *hw, u32 mask);
121s32 ixgbe_disable_pcie_master(struct ixgbe_hw *hw);
122
123s32 prot_autoc_read_generic(struct ixgbe_hw *hw, bool *, u32 *reg_val);
124s32 prot_autoc_write_generic(struct ixgbe_hw *hw, u32 reg_val, bool locked);
125
126s32 ixgbe_blink_led_start_generic(struct ixgbe_hw *hw, u32 index);
127s32 ixgbe_blink_led_stop_generic(struct ixgbe_hw *hw, u32 index);
128
129s32 ixgbe_get_san_mac_addr_generic(struct ixgbe_hw *hw, u8 *san_mac_addr);
130s32 ixgbe_set_san_mac_addr_generic(struct ixgbe_hw *hw, u8 *san_mac_addr);
131
132s32 ixgbe_set_vmdq_generic(struct ixgbe_hw *hw, u32 rar, u32 vmdq);
133s32 ixgbe_set_vmdq_san_mac_generic(struct ixgbe_hw *hw, u32 vmdq);
134s32 ixgbe_clear_vmdq_generic(struct ixgbe_hw *hw, u32 rar, u32 vmdq);
135s32 ixgbe_insert_mac_addr_generic(struct ixgbe_hw *hw, u8 *addr, u32 vmdq);
136s32 ixgbe_init_uta_tables_generic(struct ixgbe_hw *hw);
137s32 ixgbe_set_vfta_generic(struct ixgbe_hw *hw, u32 vlan,
138			 u32 vind, bool vlan_on, bool vlvf_bypass);
139s32 ixgbe_set_vlvf_generic(struct ixgbe_hw *hw, u32 vlan, u32 vind,
140			   bool vlan_on, u32 *vfta_delta, u32 vfta,
141			   bool vlvf_bypass);
142s32 ixgbe_clear_vfta_generic(struct ixgbe_hw *hw);
143s32 ixgbe_find_vlvf_slot(struct ixgbe_hw *hw, u32 vlan, bool vlvf_bypass);
144
145s32 ixgbe_check_mac_link_generic(struct ixgbe_hw *hw,
146			       ixgbe_link_speed *speed,
147			       bool *link_up, bool link_up_wait_to_complete);
148
149s32 ixgbe_get_wwn_prefix_generic(struct ixgbe_hw *hw, u16 *wwnn_prefix,
150				 u16 *wwpn_prefix);
151
152s32 ixgbe_get_fcoe_boot_status_generic(struct ixgbe_hw *hw, u16 *bs);
153void ixgbe_set_mac_anti_spoofing(struct ixgbe_hw *hw, bool enable, int vf);
154void ixgbe_set_vlan_anti_spoofing(struct ixgbe_hw *hw, bool enable, int vf);
155s32 ixgbe_get_device_caps_generic(struct ixgbe_hw *hw, u16 *device_caps);
156void ixgbe_set_rxpba_generic(struct ixgbe_hw *hw, int num_pb, u32 headroom,
157			     int strategy);
158void ixgbe_enable_relaxed_ordering_gen2(struct ixgbe_hw *hw);
159s32 ixgbe_set_fw_drv_ver_generic(struct ixgbe_hw *hw, u8 maj, u8 min,
160				 u8 build, u8 ver, u16 len, const char *str);
161u8 ixgbe_calculate_checksum(u8 *buffer, u32 length);
162s32 ixgbe_host_interface_command(struct ixgbe_hw *hw, u32 *buffer,
163				 u32 length, u32 timeout, bool return_data);
164s32 ixgbe_hic_unlocked(struct ixgbe_hw *, u32 *buffer, u32 length, u32 timeout);
165s32 ixgbe_shutdown_fw_phy(struct ixgbe_hw *);
166s32 ixgbe_fw_phy_activity(struct ixgbe_hw *, u16 activity,
167			  u32 (*data)[FW_PHY_ACT_DATA_COUNT]);
168void ixgbe_clear_tx_pending(struct ixgbe_hw *hw);
169s32 ixgbe_bypass_rw_generic(struct ixgbe_hw *hw, u32 cmd, u32 *status);
170bool ixgbe_bypass_valid_rd_generic(u32 in_reg, u32 out_reg);
171s32 ixgbe_bypass_set_generic(struct ixgbe_hw *hw, u32 ctrl, u32 event,
172			     u32 action);
173s32 ixgbe_bypass_rd_eep_generic(struct ixgbe_hw *hw, u32 addr, u8 *value);
174
175extern s32 ixgbe_reset_pipeline_82599(struct ixgbe_hw *hw);
176extern void ixgbe_stop_mac_link_on_d3_82599(struct ixgbe_hw *hw);
177bool ixgbe_mng_present(struct ixgbe_hw *hw);
178bool ixgbe_mng_enabled(struct ixgbe_hw *hw);
179
180#define IXGBE_I2C_THERMAL_SENSOR_ADDR	0xF8
181#define IXGBE_EMC_INTERNAL_DATA		0x00
182#define IXGBE_EMC_INTERNAL_THERM_LIMIT	0x20
183#define IXGBE_EMC_DIODE1_DATA		0x01
184#define IXGBE_EMC_DIODE1_THERM_LIMIT	0x19
185#define IXGBE_EMC_DIODE2_DATA		0x23
186#define IXGBE_EMC_DIODE2_THERM_LIMIT	0x1A
187#define IXGBE_EMC_DIODE3_DATA		0x2A
188#define IXGBE_EMC_DIODE3_THERM_LIMIT	0x30
189
190s32 ixgbe_get_thermal_sensor_data_generic(struct ixgbe_hw *hw);
191s32 ixgbe_init_thermal_sensor_thresh_generic(struct ixgbe_hw *hw);
192
193void ixgbe_get_etk_id(struct ixgbe_hw *hw, struct ixgbe_nvm_version *nvm_ver);
194void ixgbe_get_oem_prod_version(struct ixgbe_hw *hw,
195				struct ixgbe_nvm_version *nvm_ver);
196void ixgbe_get_orom_version(struct ixgbe_hw *hw,
197			    struct ixgbe_nvm_version *nvm_ver);
198void ixgbe_disable_rx_generic(struct ixgbe_hw *hw);
199void ixgbe_enable_rx_generic(struct ixgbe_hw *hw);
200s32 ixgbe_setup_mac_link_multispeed_fiber(struct ixgbe_hw *hw,
201					  ixgbe_link_speed speed,
202					  bool autoneg_wait_to_complete);
203void ixgbe_set_soft_rate_select_speed(struct ixgbe_hw *hw,
204				      ixgbe_link_speed speed);
205#endif /* IXGBE_COMMON */
206