1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright(c) 2001 - 2015 Intel Corporation 3 */ 4 5 #ifndef _E1000_API_H_ 6 #define _E1000_API_H_ 7 8 #include "e1000_hw.h" 9 10 extern void e1000_init_function_pointers_82542(struct e1000_hw *hw); 11 extern void e1000_init_function_pointers_82543(struct e1000_hw *hw); 12 extern void e1000_init_function_pointers_82540(struct e1000_hw *hw); 13 extern void e1000_init_function_pointers_82571(struct e1000_hw *hw); 14 extern void e1000_init_function_pointers_82541(struct e1000_hw *hw); 15 extern void e1000_init_function_pointers_80003es2lan(struct e1000_hw *hw); 16 extern void e1000_init_function_pointers_ich8lan(struct e1000_hw *hw); 17 extern void e1000_init_function_pointers_82575(struct e1000_hw *hw); 18 extern void e1000_rx_fifo_flush_82575(struct e1000_hw *hw); 19 extern void e1000_init_function_pointers_vf(struct e1000_hw *hw); 20 extern void e1000_power_up_fiber_serdes_link(struct e1000_hw *hw); 21 extern void e1000_shutdown_fiber_serdes_link(struct e1000_hw *hw); 22 extern void e1000_init_function_pointers_i210(struct e1000_hw *hw); 23 24 s32 e1000_set_obff_timer(struct e1000_hw *hw, u32 itr); 25 s32 e1000_set_mac_type(struct e1000_hw *hw); 26 s32 e1000_setup_init_funcs(struct e1000_hw *hw, bool init_device); 27 s32 e1000_init_mac_params(struct e1000_hw *hw); 28 s32 e1000_init_nvm_params(struct e1000_hw *hw); 29 s32 e1000_init_phy_params(struct e1000_hw *hw); 30 s32 e1000_init_mbx_params(struct e1000_hw *hw); 31 s32 e1000_get_bus_info(struct e1000_hw *hw); 32 void e1000_clear_vfta(struct e1000_hw *hw); 33 void e1000_write_vfta(struct e1000_hw *hw, u32 offset, u32 value); 34 s32 e1000_force_mac_fc(struct e1000_hw *hw); 35 s32 e1000_check_for_link(struct e1000_hw *hw); 36 s32 e1000_reset_hw(struct e1000_hw *hw); 37 s32 e1000_init_hw(struct e1000_hw *hw); 38 s32 e1000_setup_link(struct e1000_hw *hw); 39 s32 e1000_get_speed_and_duplex(struct e1000_hw *hw, u16 *speed, u16 *duplex); 40 s32 e1000_disable_pcie_master(struct e1000_hw *hw); 41 void e1000_config_collision_dist(struct e1000_hw *hw); 42 int e1000_rar_set(struct e1000_hw *hw, u8 *addr, u32 index); 43 u32 e1000_hash_mc_addr(struct e1000_hw *hw, u8 *mc_addr); 44 void e1000_update_mc_addr_list(struct e1000_hw *hw, u8 *mc_addr_list, 45 u32 mc_addr_count); 46 s32 e1000_setup_led(struct e1000_hw *hw); 47 s32 e1000_cleanup_led(struct e1000_hw *hw); 48 s32 e1000_check_reset_block(struct e1000_hw *hw); 49 s32 e1000_blink_led(struct e1000_hw *hw); 50 s32 e1000_led_on(struct e1000_hw *hw); 51 s32 e1000_led_off(struct e1000_hw *hw); 52 s32 e1000_id_led_init(struct e1000_hw *hw); 53 void e1000_reset_adaptive(struct e1000_hw *hw); 54 void e1000_update_adaptive(struct e1000_hw *hw); 55 s32 e1000_get_cable_length(struct e1000_hw *hw); 56 s32 e1000_validate_mdi_setting(struct e1000_hw *hw); 57 s32 e1000_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data); 58 s32 e1000_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data); 59 s32 e1000_write_8bit_ctrl_reg(struct e1000_hw *hw, u32 reg, u32 offset, 60 u8 data); 61 s32 e1000_get_phy_info(struct e1000_hw *hw); 62 void e1000_release_phy(struct e1000_hw *hw); 63 s32 e1000_acquire_phy(struct e1000_hw *hw); 64 s32 e1000_cfg_on_link_up(struct e1000_hw *hw); 65 s32 e1000_phy_hw_reset(struct e1000_hw *hw); 66 s32 e1000_phy_commit(struct e1000_hw *hw); 67 void e1000_power_up_phy(struct e1000_hw *hw); 68 void e1000_power_down_phy(struct e1000_hw *hw); 69 s32 e1000_read_mac_addr(struct e1000_hw *hw); 70 s32 e1000_read_pba_num(struct e1000_hw *hw, u32 *part_num); 71 s32 e1000_read_pba_string(struct e1000_hw *hw, u8 *pba_num, u32 pba_num_size); 72 s32 e1000_read_pba_length(struct e1000_hw *hw, u32 *pba_num_size); 73 void e1000_reload_nvm(struct e1000_hw *hw); 74 s32 e1000_update_nvm_checksum(struct e1000_hw *hw); 75 s32 e1000_validate_nvm_checksum(struct e1000_hw *hw); 76 s32 e1000_read_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data); 77 s32 e1000_read_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 *data); 78 s32 e1000_write_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 data); 79 s32 e1000_write_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data); 80 s32 e1000_set_d3_lplu_state(struct e1000_hw *hw, bool active); 81 s32 e1000_set_d0_lplu_state(struct e1000_hw *hw, bool active); 82 bool e1000_check_mng_mode(struct e1000_hw *hw); 83 bool e1000_enable_tx_pkt_filtering(struct e1000_hw *hw); 84 s32 e1000_mng_enable_host_if(struct e1000_hw *hw); 85 s32 e1000_mng_host_if_write(struct e1000_hw *hw, u8 *buffer, u16 length, 86 u16 offset, u8 *sum); 87 s32 e1000_mng_write_cmd_header(struct e1000_hw *hw, 88 struct e1000_host_mng_command_header *hdr); 89 s32 e1000_mng_write_dhcp_info(struct e1000_hw *hw, u8 *buffer, u16 length); 90 u32 e1000_translate_register_82542(u32 reg); 91 92 93 94 /* 95 * TBI_ACCEPT macro definition: 96 * 97 * This macro requires: 98 * a = a pointer to struct e1000_hw 99 * status = the 8 bit status field of the Rx descriptor with EOP set 100 * errors = the 8 bit error field of the Rx descriptor with EOP set 101 * length = the sum of all the length fields of the Rx descriptors that 102 * make up the current frame 103 * last_byte = the last byte of the frame DMAed by the hardware 104 * min_frame_size = the minimum frame length we want to accept. 105 * max_frame_size = the maximum frame length we want to accept. 106 * 107 * This macro is a conditional that should be used in the interrupt 108 * handler's Rx processing routine when RxErrors have been detected. 109 * 110 * Typical use: 111 * ... 112 * if (TBI_ACCEPT) { 113 * accept_frame = true; 114 * e1000_tbi_adjust_stats(adapter, MacAddress); 115 * frame_length--; 116 * } else { 117 * accept_frame = false; 118 * } 119 * ... 120 */ 121 122 /* The carrier extension symbol, as received by the NIC. */ 123 #define CARRIER_EXTENSION 0x0F 124 125 #define TBI_ACCEPT(a, status, errors, length, last_byte, \ 126 min_frame_size, max_frame_size) \ 127 (e1000_tbi_sbp_enabled_82543(a) && \ 128 (((errors) & E1000_RXD_ERR_FRAME_ERR_MASK) == E1000_RXD_ERR_CE) && \ 129 ((last_byte) == CARRIER_EXTENSION) && \ 130 (((status) & E1000_RXD_STAT_VP) ? \ 131 (((length) > ((min_frame_size) - VLAN_TAG_SIZE)) && \ 132 ((length) <= ((max_frame_size) + 1))) : \ 133 (((length) > (min_frame_size)) && \ 134 ((length) <= ((max_frame_size) + VLAN_TAG_SIZE + 1))))) 135 136 #define E1000_MAX(a, b) ((a) > (b) ? (a) : (b)) 137 #define E1000_DIVIDE_ROUND_UP(a, b) (((a) + (b) - 1) / (b)) /* ceil(a/b) */ 138 #endif /* _E1000_API_H_ */ 139