drivers/net/ngbe/base/ngbe_type.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2018-2021 Beijing WangXun Technology Co., Ltd.
   3  * Copyright(c) 2010-2017 Intel Corporation
   4  */
   5
   6 #ifndef _NGBE_TYPE_H_
   7 #define _NGBE_TYPE_H_
   8
   9 #define NGBE_LINK_UP_TIME       90 /* 9.0 Seconds */
  10
  11 #define NGBE_FRAME_SIZE_MAX       (9728) /* Maximum frame size, +FCS */
  12 #define NGBE_FRAME_SIZE_DFT       (1522) /* Default frame size, +FCS */
  13 #define NGBE_NUM_POOL             (32)
  14 #define NGBE_MAX_QP               (8)
  15 #define NGBE_MAX_UTA              128
  16
  17 #define NGBE_ALIGN              128 /* as intel did */
  18 #define NGBE_ISB_SIZE           16
  19
  20 #include "ngbe_status.h"
  21 #include "ngbe_osdep.h"
  22 #include "ngbe_devids.h"
  23
  24 struct ngbe_thermal_diode_data {
  25         s16 temp;
  26         s16 alarm_thresh;
  27         s16 dalarm_thresh;
  28 };
  29
  30 struct ngbe_thermal_sensor_data {
  31         struct ngbe_thermal_diode_data sensor[1];
  32 };
  33
  34 enum ngbe_eeprom_type {
  35         ngbe_eeprom_unknown = 0,
  36         ngbe_eeprom_spi,
  37         ngbe_eeprom_flash,
  38         ngbe_eeprom_none /* No NVM support */
  39 };
  40
  41 enum ngbe_mac_type {
  42         ngbe_mac_unknown = 0,
  43         ngbe_mac_em,
  44         ngbe_mac_em_vf,
  45         ngbe_num_macs
  46 };
  47
  48 enum ngbe_phy_type {
  49         ngbe_phy_unknown = 0,
  50         ngbe_phy_none,
  51         ngbe_phy_rtl,
  52         ngbe_phy_mvl,
  53         ngbe_phy_mvl_sfi,
  54         ngbe_phy_yt8521s,
  55         ngbe_phy_yt8521s_sfi,
  56         ngbe_phy_zte,
  57         ngbe_phy_cu_mtd,
  58 };
  59
  60 enum ngbe_media_type {
  61         ngbe_media_type_unknown = 0,
  62         ngbe_media_type_fiber,
  63         ngbe_media_type_fiber_qsfp,
  64         ngbe_media_type_copper,
  65         ngbe_media_type_backplane,
  66         ngbe_media_type_cx4,
  67         ngbe_media_type_virtual
  68 };
  69
  70 /* Flow Control Settings */
  71 enum ngbe_fc_mode {
  72         ngbe_fc_none = 0,
  73         ngbe_fc_rx_pause,
  74         ngbe_fc_tx_pause,
  75         ngbe_fc_full,
  76         ngbe_fc_default
  77 };
  78
  79 struct ngbe_hw;
  80
  81 struct ngbe_addr_filter_info {
  82         u32 num_mc_addrs;
  83         u32 mta_in_use;
  84 };
  85
  86 /* Bus parameters */
  87 struct ngbe_bus_info {
  88         void (*set_lan_id)(struct ngbe_hw *hw);
  89
  90         u16 func;
  91         u8 lan_id;
  92 };
  93
  94 /* Flow control parameters */
  95 struct ngbe_fc_info {
  96         u32 high_water; /* Flow Ctrl High-water */
  97         u32 low_water; /* Flow Ctrl Low-water */
  98         u16 pause_time; /* Flow Control Pause timer */
  99         bool send_xon; /* Flow control send XON */
 100         bool strict_ieee; /* Strict IEEE mode */
 101         bool disable_fc_autoneg; /* Do not autonegotiate FC */
 102         bool fc_was_autonegged; /* Is current_mode the result of autonegging? */
 103         enum ngbe_fc_mode current_mode; /* FC mode in effect */
 104         enum ngbe_fc_mode requested_mode; /* FC mode requested by caller */
 105 };
 106
 107 /* Statistics counters collected by the MAC */
 108 /* PB[] RxTx */
 109 struct ngbe_pb_stats {
 110         u64 tx_pb_xon_packets;
 111         u64 rx_pb_xon_packets;
 112         u64 tx_pb_xoff_packets;
 113         u64 rx_pb_xoff_packets;
 114         u64 rx_pb_dropped;
 115         u64 rx_pb_mbuf_alloc_errors;
 116         u64 tx_pb_xon2off_packets;
 117 };
 118
 119 /* QP[] RxTx */
 120 struct ngbe_qp_stats {
 121         u64 rx_qp_packets;
 122         u64 tx_qp_packets;
 123         u64 rx_qp_bytes;
 124         u64 tx_qp_bytes;
 125         u64 rx_qp_mc_packets;
 126 };
 127
 128 struct ngbe_hw_stats {
 129         /* MNG RxTx */
 130         u64 mng_bmc2host_packets;
 131         u64 mng_host2bmc_packets;
 132         /* Basix RxTx */
 133         u64 rx_drop_packets;
 134         u64 tx_drop_packets;
 135         u64 rx_dma_drop;
 136         u64 tx_secdrp_packets;
 137         u64 rx_packets;
 138         u64 tx_packets;
 139         u64 rx_bytes;
 140         u64 tx_bytes;
 141         u64 rx_total_bytes;
 142         u64 rx_total_packets;
 143         u64 tx_total_packets;
 144         u64 rx_total_missed_packets;
 145         u64 rx_broadcast_packets;
 146         u64 tx_broadcast_packets;
 147         u64 rx_multicast_packets;
 148         u64 tx_multicast_packets;
 149         u64 rx_management_packets;
 150         u64 tx_management_packets;
 151         u64 rx_management_dropped;
 152
 153         /* Basic Error */
 154         u64 rx_crc_errors;
 155         u64 rx_illegal_byte_errors;
 156         u64 rx_error_bytes;
 157         u64 rx_mac_short_packet_dropped;
 158         u64 rx_length_errors;
 159         u64 rx_undersize_errors;
 160         u64 rx_fragment_errors;
 161         u64 rx_oversize_errors;
 162         u64 rx_jabber_errors;
 163         u64 rx_l3_l4_xsum_error;
 164         u64 mac_local_errors;
 165         u64 mac_remote_errors;
 166
 167         /* MACSEC */
 168         u64 tx_macsec_pkts_untagged;
 169         u64 tx_macsec_pkts_encrypted;
 170         u64 tx_macsec_pkts_protected;
 171         u64 tx_macsec_octets_encrypted;
 172         u64 tx_macsec_octets_protected;
 173         u64 rx_macsec_pkts_untagged;
 174         u64 rx_macsec_pkts_badtag;
 175         u64 rx_macsec_pkts_nosci;
 176         u64 rx_macsec_pkts_unknownsci;
 177         u64 rx_macsec_octets_decrypted;
 178         u64 rx_macsec_octets_validated;
 179         u64 rx_macsec_sc_pkts_unchecked;
 180         u64 rx_macsec_sc_pkts_delayed;
 181         u64 rx_macsec_sc_pkts_late;
 182         u64 rx_macsec_sa_pkts_ok;
 183         u64 rx_macsec_sa_pkts_invalid;
 184         u64 rx_macsec_sa_pkts_notvalid;
 185         u64 rx_macsec_sa_pkts_unusedsa;
 186         u64 rx_macsec_sa_pkts_notusingsa;
 187
 188         /* MAC RxTx */
 189         u64 rx_size_64_packets;
 190         u64 rx_size_65_to_127_packets;
 191         u64 rx_size_128_to_255_packets;
 192         u64 rx_size_256_to_511_packets;
 193         u64 rx_size_512_to_1023_packets;
 194         u64 rx_size_1024_to_max_packets;
 195         u64 tx_size_64_packets;
 196         u64 tx_size_65_to_127_packets;
 197         u64 tx_size_128_to_255_packets;
 198         u64 tx_size_256_to_511_packets;
 199         u64 tx_size_512_to_1023_packets;
 200         u64 tx_size_1024_to_max_packets;
 201
 202         /* Flow Control */
 203         u64 tx_xon_packets;
 204         u64 rx_xon_packets;
 205         u64 tx_xoff_packets;
 206         u64 rx_xoff_packets;
 207
 208         u64 rx_up_dropped;
 209
 210         u64 rdb_pkt_cnt;
 211         u64 rdb_repli_cnt;
 212         u64 rdb_drp_cnt;
 213
 214         /* QP[] RxTx */
 215         struct {
 216                 u64 rx_qp_packets;
 217                 u64 tx_qp_packets;
 218                 u64 rx_qp_bytes;
 219                 u64 tx_qp_bytes;
 220                 u64 rx_qp_mc_packets;
 221                 u64 tx_qp_mc_packets;
 222                 u64 rx_qp_bc_packets;
 223                 u64 tx_qp_bc_packets;
 224         } qp[NGBE_MAX_QP];
 225
 226 };
 227
 228 /* iterator type for walking multicast address lists */
 229 typedef u8* (*ngbe_mc_addr_itr) (struct ngbe_hw *hw, u8 **mc_addr_ptr,
 230                                   u32 *vmdq);
 231
 232 struct ngbe_rom_info {
 233         s32 (*init_params)(struct ngbe_hw *hw);
 234         s32 (*readw_buffer)(struct ngbe_hw *hw, u32 offset, u32 words,
 235                             void *data);
 236         s32 (*read32)(struct ngbe_hw *hw, u32 addr, u32 *data);
 237         s32 (*writew_buffer)(struct ngbe_hw *hw, u32 offset, u32 words,
 238                              void *data);
 239         s32 (*validate_checksum)(struct ngbe_hw *hw, u16 *checksum_val);
 240
 241         enum ngbe_eeprom_type type;
 242         u32 semaphore_delay;
 243         u16 word_size;
 244         u16 address_bits;
 245         u16 word_page_size;
 246         u32 sw_addr;
 247         u32 saved_version;
 248         u16 cksum_devcap;
 249 };
 250
 251 struct ngbe_mac_info {
 252         s32 (*init_hw)(struct ngbe_hw *hw);
 253         s32 (*reset_hw)(struct ngbe_hw *hw);
 254         s32 (*start_hw)(struct ngbe_hw *hw);
 255         s32 (*stop_hw)(struct ngbe_hw *hw);
 256         s32 (*clear_hw_cntrs)(struct ngbe_hw *hw);
 257         s32 (*get_mac_addr)(struct ngbe_hw *hw, u8 *mac_addr);
 258         s32 (*enable_rx_dma)(struct ngbe_hw *hw, u32 regval);
 259         s32 (*disable_sec_rx_path)(struct ngbe_hw *hw);
 260         s32 (*enable_sec_rx_path)(struct ngbe_hw *hw);
 261         s32 (*acquire_swfw_sync)(struct ngbe_hw *hw, u32 mask);
 262         void (*release_swfw_sync)(struct ngbe_hw *hw, u32 mask);
 263
 264         /* Link */
 265         s32 (*setup_link)(struct ngbe_hw *hw, u32 speed,
 266                                bool autoneg_wait_to_complete);
 267         s32 (*check_link)(struct ngbe_hw *hw, u32 *speed,
 268                                bool *link_up, bool link_up_wait_to_complete);
 269         s32 (*get_link_capabilities)(struct ngbe_hw *hw,
 270                                       u32 *speed, bool *autoneg);
 271
 272         /* LED */
 273         s32 (*led_on)(struct ngbe_hw *hw, u32 index);
 274         s32 (*led_off)(struct ngbe_hw *hw, u32 index);
 275
 276         /* RAR */
 277         s32 (*set_rar)(struct ngbe_hw *hw, u32 index, u8 *addr, u32 vmdq,
 278                           u32 enable_addr);
 279         s32 (*clear_rar)(struct ngbe_hw *hw, u32 index);
 280         s32 (*set_vmdq)(struct ngbe_hw *hw, u32 rar, u32 vmdq);
 281         s32 (*clear_vmdq)(struct ngbe_hw *hw, u32 rar, u32 vmdq);
 282         s32 (*init_rx_addrs)(struct ngbe_hw *hw);
 283         s32 (*update_mc_addr_list)(struct ngbe_hw *hw, u8 *mc_addr_list,
 284                                       u32 mc_addr_count,
 285                                       ngbe_mc_addr_itr func, bool clear);
 286         s32 (*clear_vfta)(struct ngbe_hw *hw);
 287         s32 (*set_vfta)(struct ngbe_hw *hw, u32 vlan,
 288                          u32 vind, bool vlan_on, bool vlvf_bypass);
 289         s32 (*set_vlvf)(struct ngbe_hw *hw, u32 vlan, u32 vind,
 290                            bool vlan_on, u32 *vfta_delta, u32 vfta,
 291                            bool vlvf_bypass);
 292         void (*set_mac_anti_spoofing)(struct ngbe_hw *hw, bool enable, int vf);
 293         void (*set_vlan_anti_spoofing)(struct ngbe_hw *hw,
 294                                         bool enable, int vf);
 295
 296         /* Flow Control */
 297         s32 (*fc_enable)(struct ngbe_hw *hw);
 298         s32 (*setup_fc)(struct ngbe_hw *hw);
 299         void (*fc_autoneg)(struct ngbe_hw *hw);
 300
 301         /* Manageability interface */
 302         s32 (*init_thermal_sensor_thresh)(struct ngbe_hw *hw);
 303         s32 (*check_overtemp)(struct ngbe_hw *hw);
 304
 305         enum ngbe_mac_type type;
 306         u8 addr[ETH_ADDR_LEN];
 307         u8 perm_addr[ETH_ADDR_LEN];
 308 #define NGBE_MAX_MTA                    128
 309         u32 mta_shadow[NGBE_MAX_MTA];
 310         s32 mc_filter_type;
 311         u32 mcft_size;
 312         u32 vft_size;
 313         u32 num_rar_entries;
 314         u32 max_tx_queues;
 315         u32 max_rx_queues;
 316         bool get_link_status;
 317         struct ngbe_thermal_sensor_data  thermal_sensor_data;
 318         bool set_lben;
 319         u32  max_link_up_time;
 320
 321         u32 default_speeds;
 322         bool autoneg;
 323 };
 324
 325 struct ngbe_phy_info {
 326         s32 (*identify)(struct ngbe_hw *hw);
 327         s32 (*init_hw)(struct ngbe_hw *hw);
 328         s32 (*reset_hw)(struct ngbe_hw *hw);
 329         s32 (*read_reg)(struct ngbe_hw *hw, u32 reg_addr,
 330                                 u32 device_type, u16 *phy_data);
 331         s32 (*write_reg)(struct ngbe_hw *hw, u32 reg_addr,
 332                                 u32 device_type, u16 phy_data);
 333         s32 (*read_reg_unlocked)(struct ngbe_hw *hw, u32 reg_addr,
 334                                 u32 device_type, u16 *phy_data);
 335         s32 (*write_reg_unlocked)(struct ngbe_hw *hw, u32 reg_addr,
 336                                 u32 device_type, u16 phy_data);
 337         s32 (*setup_link)(struct ngbe_hw *hw, u32 speed,
 338                                 bool autoneg_wait_to_complete);
 339         s32 (*check_link)(struct ngbe_hw *hw, u32 *speed, bool *link_up);
 340         s32 (*set_phy_power)(struct ngbe_hw *hw, bool on);
 341         s32 (*get_adv_pause)(struct ngbe_hw *hw, u8 *pause_bit);
 342         s32 (*get_lp_adv_pause)(struct ngbe_hw *hw, u8 *pause_bit);
 343         s32 (*set_pause_adv)(struct ngbe_hw *hw, u16 pause_bit);
 344
 345         enum ngbe_media_type media_type;
 346         enum ngbe_phy_type type;
 347         u32 addr;
 348         u32 id;
 349         u32 revision;
 350         u32 phy_semaphore_mask;
 351         bool reset_disable;
 352         u32 autoneg_advertised;
 353 };
 354
 355 struct ngbe_mbx_stats {
 356         u32 msgs_tx;
 357         u32 msgs_rx;
 358
 359         u32 acks;
 360         u32 reqs;
 361         u32 rsts;
 362 };
 363
 364 struct ngbe_mbx_info {
 365         void (*init_params)(struct ngbe_hw *hw);
 366         s32  (*read)(struct ngbe_hw *hw, u32 *msg, u16 size, u16 vf_number);
 367         s32  (*write)(struct ngbe_hw *hw, u32 *msg, u16 size, u16 vf_number);
 368         s32  (*check_for_msg)(struct ngbe_hw *hw, u16 mbx_id);
 369         s32  (*check_for_ack)(struct ngbe_hw *hw, u16 mbx_id);
 370         s32  (*check_for_rst)(struct ngbe_hw *hw, u16 mbx_id);
 371
 372         struct ngbe_mbx_stats stats;
 373         u32 timeout;
 374         u32 usec_delay;
 375         u16 size;
 376 };
 377
 378 enum ngbe_isb_idx {
 379         NGBE_ISB_HEADER,
 380         NGBE_ISB_MISC,
 381         NGBE_ISB_VEC0,
 382         NGBE_ISB_VEC1,
 383         NGBE_ISB_MAX
 384 };
 385
 386 struct ngbe_hw {
 387         void IOMEM *hw_addr;
 388         void *back;
 389         struct ngbe_mac_info mac;
 390         struct ngbe_addr_filter_info addr_ctrl;
 391         struct ngbe_fc_info fc;
 392         struct ngbe_phy_info phy;
 393         struct ngbe_rom_info rom;
 394         struct ngbe_bus_info bus;
 395         struct ngbe_mbx_info mbx;
 396         u16 device_id;
 397         u16 vendor_id;
 398         u16 sub_device_id;
 399         u16 sub_system_id;
 400         u32 eeprom_id;
 401         u8 revision_id;
 402         bool adapter_stopped;
 403
 404         uint64_t isb_dma;
 405         void IOMEM *isb_mem;
 406         u16 nb_rx_queues;
 407         u16 nb_tx_queues;
 408
 409         u32 mode;
 410
 411         u32 q_rx_regs[8 * 4];
 412         u32 q_tx_regs[8 * 4];
 413         bool offset_loaded;
 414         bool is_pf;
 415         struct {
 416                 u64 rx_qp_packets;
 417                 u64 tx_qp_packets;
 418                 u64 rx_qp_bytes;
 419                 u64 tx_qp_bytes;
 420                 u64 rx_qp_mc_packets;
 421                 u64 tx_qp_mc_packets;
 422                 u64 rx_qp_bc_packets;
 423                 u64 tx_qp_bc_packets;
 424         } qp_last[NGBE_MAX_QP];
 425 };
 426
 427 #include "ngbe_regs.h"
 428 #include "ngbe_dummy.h"
 429
 430 #endif /* _NGBE_TYPE_H_ */