drivers/net/e1000/base/e1000_api.h

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