drivers/net/sfc/base/efx_impl.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  *
   3  * Copyright (c) 2007-2018 Solarflare Communications Inc.
   4  * All rights reserved.
   5  */
   6
   7 #ifndef _SYS_EFX_IMPL_H
   8 #define _SYS_EFX_IMPL_H
   9
  10 #include "efx.h"
  11 #include "efx_regs.h"
  12 #include "efx_regs_ef10.h"
  13
  14 /* FIXME: Add definition for driver generated software events */
  15 #ifndef ESE_DZ_EV_CODE_DRV_GEN_EV
  16 #define ESE_DZ_EV_CODE_DRV_GEN_EV FSE_AZ_EV_CODE_DRV_GEN_EV
  17 #endif
  18
  19
  20 #if EFSYS_OPT_SIENA
  21 #include "siena_impl.h"
  22 #endif  /* EFSYS_OPT_SIENA */
  23
  24 #if EFSYS_OPT_HUNTINGTON
  25 #include "hunt_impl.h"
  26 #endif  /* EFSYS_OPT_HUNTINGTON */
  27
  28 #if EFSYS_OPT_MEDFORD
  29 #include "medford_impl.h"
  30 #endif  /* EFSYS_OPT_MEDFORD */
  31
  32 #if EFSYS_OPT_MEDFORD2
  33 #include "medford2_impl.h"
  34 #endif  /* EFSYS_OPT_MEDFORD2 */
  35
  36 #if EFX_OPTS_EF10()
  37 #include "ef10_impl.h"
  38 #endif  /* EFX_OPTS_EF10() */
  39
  40 #ifdef  __cplusplus
  41 extern "C" {
  42 #endif
  43
  44 #define EFX_MOD_MCDI            0x00000001
  45 #define EFX_MOD_PROBE           0x00000002
  46 #define EFX_MOD_NVRAM           0x00000004
  47 #define EFX_MOD_VPD             0x00000008
  48 #define EFX_MOD_NIC             0x00000010
  49 #define EFX_MOD_INTR            0x00000020
  50 #define EFX_MOD_EV              0x00000040
  51 #define EFX_MOD_RX              0x00000080
  52 #define EFX_MOD_TX              0x00000100
  53 #define EFX_MOD_PORT            0x00000200
  54 #define EFX_MOD_MON             0x00000400
  55 #define EFX_MOD_FILTER          0x00001000
  56 #define EFX_MOD_LIC             0x00002000
  57 #define EFX_MOD_TUNNEL          0x00004000
  58
  59 #define EFX_RESET_PHY           0x00000001
  60 #define EFX_RESET_RXQ_ERR       0x00000002
  61 #define EFX_RESET_TXQ_ERR       0x00000004
  62 #define EFX_RESET_HW_UNAVAIL    0x00000008
  63
  64 typedef enum efx_mac_type_e {
  65         EFX_MAC_INVALID = 0,
  66         EFX_MAC_SIENA,
  67         EFX_MAC_HUNTINGTON,
  68         EFX_MAC_MEDFORD,
  69         EFX_MAC_MEDFORD2,
  70         EFX_MAC_NTYPES
  71 } efx_mac_type_t;
  72
  73 typedef struct efx_ev_ops_s {
  74         efx_rc_t        (*eevo_init)(efx_nic_t *);
  75         void            (*eevo_fini)(efx_nic_t *);
  76         efx_rc_t        (*eevo_qcreate)(efx_nic_t *, unsigned int,
  77                                           efsys_mem_t *, size_t, uint32_t,
  78                                           uint32_t, uint32_t, efx_evq_t *);
  79         void            (*eevo_qdestroy)(efx_evq_t *);
  80         efx_rc_t        (*eevo_qprime)(efx_evq_t *, unsigned int);
  81         void            (*eevo_qpost)(efx_evq_t *, uint16_t);
  82         efx_rc_t        (*eevo_qmoderate)(efx_evq_t *, unsigned int);
  83 #if EFSYS_OPT_QSTATS
  84         void            (*eevo_qstats_update)(efx_evq_t *, efsys_stat_t *);
  85 #endif
  86 } efx_ev_ops_t;
  87
  88 typedef struct efx_tx_ops_s {
  89         efx_rc_t        (*etxo_init)(efx_nic_t *);
  90         void            (*etxo_fini)(efx_nic_t *);
  91         efx_rc_t        (*etxo_qcreate)(efx_nic_t *,
  92                                         unsigned int, unsigned int,
  93                                         efsys_mem_t *, size_t,
  94                                         uint32_t, uint16_t,
  95                                         efx_evq_t *, efx_txq_t *,
  96                                         unsigned int *);
  97         void            (*etxo_qdestroy)(efx_txq_t *);
  98         efx_rc_t        (*etxo_qpost)(efx_txq_t *, efx_buffer_t *,
  99                                       unsigned int, unsigned int,
 100                                       unsigned int *);
 101         void            (*etxo_qpush)(efx_txq_t *, unsigned int, unsigned int);
 102         efx_rc_t        (*etxo_qpace)(efx_txq_t *, unsigned int);
 103         efx_rc_t        (*etxo_qflush)(efx_txq_t *);
 104         void            (*etxo_qenable)(efx_txq_t *);
 105         efx_rc_t        (*etxo_qpio_enable)(efx_txq_t *);
 106         void            (*etxo_qpio_disable)(efx_txq_t *);
 107         efx_rc_t        (*etxo_qpio_write)(efx_txq_t *, uint8_t *, size_t,
 108                                            size_t);
 109         efx_rc_t        (*etxo_qpio_post)(efx_txq_t *, size_t, unsigned int,
 110                                            unsigned int *);
 111         efx_rc_t        (*etxo_qdesc_post)(efx_txq_t *, efx_desc_t *,
 112                                       unsigned int, unsigned int,
 113                                       unsigned int *);
 114         void            (*etxo_qdesc_dma_create)(efx_txq_t *, efsys_dma_addr_t,
 115                                                 size_t, boolean_t,
 116                                                 efx_desc_t *);
 117         void            (*etxo_qdesc_tso_create)(efx_txq_t *, uint16_t,
 118                                                 uint32_t, uint8_t,
 119                                                 efx_desc_t *);
 120         void            (*etxo_qdesc_tso2_create)(efx_txq_t *, uint16_t,
 121                                                 uint16_t, uint32_t, uint16_t,
 122                                                 efx_desc_t *, int);
 123         void            (*etxo_qdesc_vlantci_create)(efx_txq_t *, uint16_t,
 124                                                 efx_desc_t *);
 125         void            (*etxo_qdesc_checksum_create)(efx_txq_t *, uint16_t,
 126                                                 efx_desc_t *);
 127 #if EFSYS_OPT_QSTATS
 128         void            (*etxo_qstats_update)(efx_txq_t *,
 129                                               efsys_stat_t *);
 130 #endif
 131 } efx_tx_ops_t;
 132
 133 typedef union efx_rxq_type_data_u {
 134         struct {
 135                 size_t          ed_buf_size;
 136         } ertd_default;
 137 #if EFSYS_OPT_RX_PACKED_STREAM
 138         struct {
 139                 uint32_t        eps_buf_size;
 140         } ertd_packed_stream;
 141 #endif
 142 #if EFSYS_OPT_RX_ES_SUPER_BUFFER
 143         struct {
 144                 uint32_t        eessb_bufs_per_desc;
 145                 uint32_t        eessb_max_dma_len;
 146                 uint32_t        eessb_buf_stride;
 147                 uint32_t        eessb_hol_block_timeout;
 148         } ertd_es_super_buffer;
 149 #endif
 150 } efx_rxq_type_data_t;
 151
 152 typedef struct efx_rx_ops_s {
 153         efx_rc_t        (*erxo_init)(efx_nic_t *);
 154         void            (*erxo_fini)(efx_nic_t *);
 155 #if EFSYS_OPT_RX_SCATTER
 156         efx_rc_t        (*erxo_scatter_enable)(efx_nic_t *, unsigned int);
 157 #endif
 158 #if EFSYS_OPT_RX_SCALE
 159         efx_rc_t        (*erxo_scale_context_alloc)(efx_nic_t *,
 160                                                     efx_rx_scale_context_type_t,
 161                                                     uint32_t, uint32_t *);
 162         efx_rc_t        (*erxo_scale_context_free)(efx_nic_t *, uint32_t);
 163         efx_rc_t        (*erxo_scale_mode_set)(efx_nic_t *, uint32_t,
 164                                                efx_rx_hash_alg_t,
 165                                                efx_rx_hash_type_t, boolean_t);
 166         efx_rc_t        (*erxo_scale_key_set)(efx_nic_t *, uint32_t,
 167                                               uint8_t *, size_t);
 168         efx_rc_t        (*erxo_scale_tbl_set)(efx_nic_t *, uint32_t,
 169                                               unsigned int *, size_t);
 170         uint32_t        (*erxo_prefix_hash)(efx_nic_t *, efx_rx_hash_alg_t,
 171                                             uint8_t *);
 172 #endif /* EFSYS_OPT_RX_SCALE */
 173         efx_rc_t        (*erxo_prefix_pktlen)(efx_nic_t *, uint8_t *,
 174                                               uint16_t *);
 175         void            (*erxo_qpost)(efx_rxq_t *, efsys_dma_addr_t *, size_t,
 176                                       unsigned int, unsigned int,
 177                                       unsigned int);
 178         void            (*erxo_qpush)(efx_rxq_t *, unsigned int, unsigned int *);
 179 #if EFSYS_OPT_RX_PACKED_STREAM
 180         void            (*erxo_qpush_ps_credits)(efx_rxq_t *);
 181         uint8_t *       (*erxo_qps_packet_info)(efx_rxq_t *, uint8_t *,
 182                                                 uint32_t, uint32_t,
 183                                                 uint16_t *, uint32_t *, uint32_t *);
 184 #endif
 185         efx_rc_t        (*erxo_qflush)(efx_rxq_t *);
 186         void            (*erxo_qenable)(efx_rxq_t *);
 187         efx_rc_t        (*erxo_qcreate)(efx_nic_t *enp, unsigned int,
 188                                         unsigned int, efx_rxq_type_t,
 189                                         const efx_rxq_type_data_t *,
 190                                         efsys_mem_t *, size_t, uint32_t,
 191                                         unsigned int,
 192                                         efx_evq_t *, efx_rxq_t *);
 193         void            (*erxo_qdestroy)(efx_rxq_t *);
 194 } efx_rx_ops_t;
 195
 196 typedef struct efx_mac_ops_s {
 197         efx_rc_t        (*emo_poll)(efx_nic_t *, efx_link_mode_t *);
 198         efx_rc_t        (*emo_up)(efx_nic_t *, boolean_t *);
 199         efx_rc_t        (*emo_addr_set)(efx_nic_t *);
 200         efx_rc_t        (*emo_pdu_set)(efx_nic_t *);
 201         efx_rc_t        (*emo_pdu_get)(efx_nic_t *, size_t *);
 202         efx_rc_t        (*emo_reconfigure)(efx_nic_t *);
 203         efx_rc_t        (*emo_multicast_list_set)(efx_nic_t *);
 204         efx_rc_t        (*emo_filter_default_rxq_set)(efx_nic_t *,
 205                                                       efx_rxq_t *, boolean_t);
 206         void            (*emo_filter_default_rxq_clear)(efx_nic_t *);
 207 #if EFSYS_OPT_LOOPBACK
 208         efx_rc_t        (*emo_loopback_set)(efx_nic_t *, efx_link_mode_t,
 209                                             efx_loopback_type_t);
 210 #endif  /* EFSYS_OPT_LOOPBACK */
 211 #if EFSYS_OPT_MAC_STATS
 212         efx_rc_t        (*emo_stats_get_mask)(efx_nic_t *, uint32_t *, size_t);
 213         efx_rc_t        (*emo_stats_clear)(efx_nic_t *);
 214         efx_rc_t        (*emo_stats_upload)(efx_nic_t *, efsys_mem_t *);
 215         efx_rc_t        (*emo_stats_periodic)(efx_nic_t *, efsys_mem_t *,
 216                                               uint16_t, boolean_t);
 217         efx_rc_t        (*emo_stats_update)(efx_nic_t *, efsys_mem_t *,
 218                                             efsys_stat_t *, uint32_t *);
 219 #endif  /* EFSYS_OPT_MAC_STATS */
 220 } efx_mac_ops_t;
 221
 222 typedef struct efx_phy_ops_s {
 223         efx_rc_t        (*epo_power)(efx_nic_t *, boolean_t); /* optional */
 224         efx_rc_t        (*epo_reset)(efx_nic_t *);
 225         efx_rc_t        (*epo_reconfigure)(efx_nic_t *);
 226         efx_rc_t        (*epo_verify)(efx_nic_t *);
 227         efx_rc_t        (*epo_oui_get)(efx_nic_t *, uint32_t *);
 228         efx_rc_t        (*epo_link_state_get)(efx_nic_t *, efx_phy_link_state_t *);
 229 #if EFSYS_OPT_PHY_STATS
 230         efx_rc_t        (*epo_stats_update)(efx_nic_t *, efsys_mem_t *,
 231                                             uint32_t *);
 232 #endif  /* EFSYS_OPT_PHY_STATS */
 233 #if EFSYS_OPT_BIST
 234         efx_rc_t        (*epo_bist_enable_offline)(efx_nic_t *);
 235         efx_rc_t        (*epo_bist_start)(efx_nic_t *, efx_bist_type_t);
 236         efx_rc_t        (*epo_bist_poll)(efx_nic_t *, efx_bist_type_t,
 237                                          efx_bist_result_t *, uint32_t *,
 238                                          unsigned long *, size_t);
 239         void            (*epo_bist_stop)(efx_nic_t *, efx_bist_type_t);
 240 #endif  /* EFSYS_OPT_BIST */
 241 } efx_phy_ops_t;
 242
 243 #if EFSYS_OPT_FILTER
 244 typedef struct efx_filter_ops_s {
 245         efx_rc_t        (*efo_init)(efx_nic_t *);
 246         void            (*efo_fini)(efx_nic_t *);
 247         efx_rc_t        (*efo_restore)(efx_nic_t *);
 248         efx_rc_t        (*efo_add)(efx_nic_t *, efx_filter_spec_t *,
 249                                    boolean_t may_replace);
 250         efx_rc_t        (*efo_delete)(efx_nic_t *, efx_filter_spec_t *);
 251         efx_rc_t        (*efo_supported_filters)(efx_nic_t *, uint32_t *,
 252                                    size_t, size_t *);
 253         efx_rc_t        (*efo_reconfigure)(efx_nic_t *, uint8_t const *, boolean_t,
 254                                    boolean_t, boolean_t, boolean_t,
 255                                    uint8_t const *, uint32_t);
 256 } efx_filter_ops_t;
 257
 258 extern  __checkReturn   efx_rc_t
 259 efx_filter_reconfigure(
 260         __in                            efx_nic_t *enp,
 261         __in_ecount(6)                  uint8_t const *mac_addr,
 262         __in                            boolean_t all_unicst,
 263         __in                            boolean_t mulcst,
 264         __in                            boolean_t all_mulcst,
 265         __in                            boolean_t brdcst,
 266         __in_ecount(6*count)            uint8_t const *addrs,
 267         __in                            uint32_t count);
 268
 269 #endif /* EFSYS_OPT_FILTER */
 270
 271 #if EFSYS_OPT_TUNNEL
 272 typedef struct efx_tunnel_ops_s {
 273         boolean_t       (*eto_udp_encap_supported)(efx_nic_t *);
 274         efx_rc_t        (*eto_reconfigure)(efx_nic_t *);
 275 } efx_tunnel_ops_t;
 276 #endif /* EFSYS_OPT_TUNNEL */
 277
 278 typedef struct efx_port_s {
 279         efx_mac_type_t          ep_mac_type;
 280         uint32_t                ep_phy_type;
 281         uint8_t                 ep_port;
 282         uint32_t                ep_mac_pdu;
 283         uint8_t                 ep_mac_addr[6];
 284         efx_link_mode_t         ep_link_mode;
 285         boolean_t               ep_all_unicst;
 286         boolean_t               ep_mulcst;
 287         boolean_t               ep_all_mulcst;
 288         boolean_t               ep_brdcst;
 289         unsigned int            ep_fcntl;
 290         boolean_t               ep_fcntl_autoneg;
 291         efx_oword_t             ep_multicst_hash[2];
 292         uint8_t                 ep_mulcst_addr_list[EFX_MAC_ADDR_LEN *
 293                                                     EFX_MAC_MULTICAST_LIST_MAX];
 294         uint32_t                ep_mulcst_addr_count;
 295 #if EFSYS_OPT_LOOPBACK
 296         efx_loopback_type_t     ep_loopback_type;
 297         efx_link_mode_t         ep_loopback_link_mode;
 298 #endif  /* EFSYS_OPT_LOOPBACK */
 299 #if EFSYS_OPT_PHY_FLAGS
 300         uint32_t                ep_phy_flags;
 301 #endif  /* EFSYS_OPT_PHY_FLAGS */
 302 #if EFSYS_OPT_PHY_LED_CONTROL
 303         efx_phy_led_mode_t      ep_phy_led_mode;
 304 #endif  /* EFSYS_OPT_PHY_LED_CONTROL */
 305         efx_phy_media_type_t    ep_fixed_port_type;
 306         efx_phy_media_type_t    ep_module_type;
 307         uint32_t                ep_adv_cap_mask;
 308         uint32_t                ep_lp_cap_mask;
 309         uint32_t                ep_default_adv_cap_mask;
 310         uint32_t                ep_phy_cap_mask;
 311         boolean_t               ep_mac_drain;
 312 #if EFSYS_OPT_BIST
 313         efx_bist_type_t         ep_current_bist;
 314 #endif
 315         const efx_mac_ops_t     *ep_emop;
 316         const efx_phy_ops_t     *ep_epop;
 317 } efx_port_t;
 318
 319 typedef struct efx_mon_ops_s {
 320 #if EFSYS_OPT_MON_STATS
 321         efx_rc_t        (*emo_stats_update)(efx_nic_t *, efsys_mem_t *,
 322                                             efx_mon_stat_value_t *);
 323         efx_rc_t        (*emo_limits_update)(efx_nic_t *,
 324                                              efx_mon_stat_limits_t *);
 325 #endif  /* EFSYS_OPT_MON_STATS */
 326 } efx_mon_ops_t;
 327
 328 typedef struct efx_mon_s {
 329         efx_mon_type_t          em_type;
 330         const efx_mon_ops_t     *em_emop;
 331 } efx_mon_t;
 332
 333 typedef struct efx_intr_ops_s {
 334         efx_rc_t        (*eio_init)(efx_nic_t *, efx_intr_type_t, efsys_mem_t *);
 335         void            (*eio_enable)(efx_nic_t *);
 336         void            (*eio_disable)(efx_nic_t *);
 337         void            (*eio_disable_unlocked)(efx_nic_t *);
 338         efx_rc_t        (*eio_trigger)(efx_nic_t *, unsigned int);
 339         void            (*eio_status_line)(efx_nic_t *, boolean_t *, uint32_t *);
 340         void            (*eio_status_message)(efx_nic_t *, unsigned int,
 341                                  boolean_t *);
 342         void            (*eio_fatal)(efx_nic_t *);
 343         void            (*eio_fini)(efx_nic_t *);
 344 } efx_intr_ops_t;
 345
 346 typedef struct efx_intr_s {
 347         const efx_intr_ops_t    *ei_eiop;
 348         efsys_mem_t             *ei_esmp;
 349         efx_intr_type_t         ei_type;
 350         unsigned int            ei_level;
 351 } efx_intr_t;
 352
 353 typedef struct efx_nic_ops_s {
 354         efx_rc_t        (*eno_probe)(efx_nic_t *);
 355         efx_rc_t        (*eno_board_cfg)(efx_nic_t *);
 356         efx_rc_t        (*eno_set_drv_limits)(efx_nic_t *, efx_drv_limits_t*);
 357         efx_rc_t        (*eno_reset)(efx_nic_t *);
 358         efx_rc_t        (*eno_init)(efx_nic_t *);
 359         efx_rc_t        (*eno_get_vi_pool)(efx_nic_t *, uint32_t *);
 360         efx_rc_t        (*eno_get_bar_region)(efx_nic_t *, efx_nic_region_t,
 361                                         uint32_t *, size_t *);
 362         boolean_t       (*eno_hw_unavailable)(efx_nic_t *);
 363         void            (*eno_set_hw_unavailable)(efx_nic_t *);
 364 #if EFSYS_OPT_DIAG
 365         efx_rc_t        (*eno_register_test)(efx_nic_t *);
 366 #endif  /* EFSYS_OPT_DIAG */
 367         void            (*eno_fini)(efx_nic_t *);
 368         void            (*eno_unprobe)(efx_nic_t *);
 369 } efx_nic_ops_t;
 370
 371 #ifndef EFX_TXQ_LIMIT_TARGET
 372 #define EFX_TXQ_LIMIT_TARGET 259
 373 #endif
 374 #ifndef EFX_RXQ_LIMIT_TARGET
 375 #define EFX_RXQ_LIMIT_TARGET 512
 376 #endif
 377
 378
 379 #if EFSYS_OPT_FILTER
 380
 381 #if EFSYS_OPT_SIENA
 382
 383 typedef struct siena_filter_spec_s {
 384         uint8_t         sfs_type;
 385         uint32_t        sfs_flags;
 386         uint32_t        sfs_dmaq_id;
 387         uint32_t        sfs_dword[3];
 388 } siena_filter_spec_t;
 389
 390 typedef enum siena_filter_type_e {
 391         EFX_SIENA_FILTER_RX_TCP_FULL,   /* TCP/IPv4 {dIP,dTCP,sIP,sTCP} */
 392         EFX_SIENA_FILTER_RX_TCP_WILD,   /* TCP/IPv4 {dIP,dTCP,  -,   -} */
 393         EFX_SIENA_FILTER_RX_UDP_FULL,   /* UDP/IPv4 {dIP,dUDP,sIP,sUDP} */
 394         EFX_SIENA_FILTER_RX_UDP_WILD,   /* UDP/IPv4 {dIP,dUDP,  -,   -} */
 395         EFX_SIENA_FILTER_RX_MAC_FULL,   /* Ethernet {dMAC,VLAN} */
 396         EFX_SIENA_FILTER_RX_MAC_WILD,   /* Ethernet {dMAC,   -} */
 397
 398         EFX_SIENA_FILTER_TX_TCP_FULL,   /* TCP/IPv4 {dIP,dTCP,sIP,sTCP} */
 399         EFX_SIENA_FILTER_TX_TCP_WILD,   /* TCP/IPv4 {  -,   -,sIP,sTCP} */
 400         EFX_SIENA_FILTER_TX_UDP_FULL,   /* UDP/IPv4 {dIP,dTCP,sIP,sTCP} */
 401         EFX_SIENA_FILTER_TX_UDP_WILD,   /* UDP/IPv4 {  -,   -,sIP,sUDP} */
 402         EFX_SIENA_FILTER_TX_MAC_FULL,   /* Ethernet {sMAC,VLAN} */
 403         EFX_SIENA_FILTER_TX_MAC_WILD,   /* Ethernet {sMAC,   -} */
 404
 405         EFX_SIENA_FILTER_NTYPES
 406 } siena_filter_type_t;
 407
 408 typedef enum siena_filter_tbl_id_e {
 409         EFX_SIENA_FILTER_TBL_RX_IP = 0,
 410         EFX_SIENA_FILTER_TBL_RX_MAC,
 411         EFX_SIENA_FILTER_TBL_TX_IP,
 412         EFX_SIENA_FILTER_TBL_TX_MAC,
 413         EFX_SIENA_FILTER_NTBLS
 414 } siena_filter_tbl_id_t;
 415
 416 typedef struct siena_filter_tbl_s {
 417         int                     sft_size;       /* number of entries */
 418         int                     sft_used;       /* active count */
 419         uint32_t                *sft_bitmap;    /* active bitmap */
 420         siena_filter_spec_t     *sft_spec;      /* array of saved specs */
 421 } siena_filter_tbl_t;
 422
 423 typedef struct siena_filter_s {
 424         siena_filter_tbl_t      sf_tbl[EFX_SIENA_FILTER_NTBLS];
 425         unsigned int            sf_depth[EFX_SIENA_FILTER_NTYPES];
 426 } siena_filter_t;
 427
 428 #endif  /* EFSYS_OPT_SIENA */
 429
 430 typedef struct efx_filter_s {
 431 #if EFSYS_OPT_SIENA
 432         siena_filter_t          *ef_siena_filter;
 433 #endif /* EFSYS_OPT_SIENA */
 434 #if EFX_OPTS_EF10()
 435         ef10_filter_table_t     *ef_ef10_filter_table;
 436 #endif /* EFX_OPTS_EF10() */
 437 } efx_filter_t;
 438
 439 #if EFSYS_OPT_SIENA
 440
 441 extern                  void
 442 siena_filter_tbl_clear(
 443         __in            efx_nic_t *enp,
 444         __in            siena_filter_tbl_id_t tbl);
 445
 446 #endif  /* EFSYS_OPT_SIENA */
 447
 448 #endif  /* EFSYS_OPT_FILTER */
 449
 450 #if EFSYS_OPT_MCDI
 451
 452 #define EFX_TUNNEL_MAXNENTRIES  (16)
 453
 454 #if EFSYS_OPT_TUNNEL
 455
 456 typedef struct efx_tunnel_udp_entry_s {
 457         uint16_t                        etue_port; /* host/cpu-endian */
 458         uint16_t                        etue_protocol;
 459 } efx_tunnel_udp_entry_t;
 460
 461 typedef struct efx_tunnel_cfg_s {
 462         efx_tunnel_udp_entry_t  etc_udp_entries[EFX_TUNNEL_MAXNENTRIES];
 463         unsigned int            etc_udp_entries_num;
 464 } efx_tunnel_cfg_t;
 465
 466 #endif /* EFSYS_OPT_TUNNEL */
 467
 468 typedef struct efx_mcdi_ops_s {
 469         efx_rc_t        (*emco_init)(efx_nic_t *, const efx_mcdi_transport_t *);
 470         void            (*emco_send_request)(efx_nic_t *, void *, size_t,
 471                                         void *, size_t);
 472         efx_rc_t        (*emco_poll_reboot)(efx_nic_t *);
 473         boolean_t       (*emco_poll_response)(efx_nic_t *);
 474         void            (*emco_read_response)(efx_nic_t *, void *, size_t, size_t);
 475         void            (*emco_fini)(efx_nic_t *);
 476         efx_rc_t        (*emco_feature_supported)(efx_nic_t *,
 477                                             efx_mcdi_feature_id_t, boolean_t *);
 478         void            (*emco_get_timeout)(efx_nic_t *, efx_mcdi_req_t *,
 479                                             uint32_t *);
 480 } efx_mcdi_ops_t;
 481
 482 typedef struct efx_mcdi_s {
 483         const efx_mcdi_ops_t            *em_emcop;
 484         const efx_mcdi_transport_t      *em_emtp;
 485         efx_mcdi_iface_t                em_emip;
 486 } efx_mcdi_t;
 487
 488 #endif /* EFSYS_OPT_MCDI */
 489
 490 #if EFSYS_OPT_NVRAM
 491
 492 /* Invalid partition ID for en_nvram_partn_locked field of efx_nc_t */
 493 #define EFX_NVRAM_PARTN_INVALID         (0xffffffffu)
 494
 495 typedef struct efx_nvram_ops_s {
 496 #if EFSYS_OPT_DIAG
 497         efx_rc_t        (*envo_test)(efx_nic_t *);
 498 #endif  /* EFSYS_OPT_DIAG */
 499         efx_rc_t        (*envo_type_to_partn)(efx_nic_t *, efx_nvram_type_t,
 500                                             uint32_t *);
 501         efx_rc_t        (*envo_partn_size)(efx_nic_t *, uint32_t, size_t *);
 502         efx_rc_t        (*envo_partn_rw_start)(efx_nic_t *, uint32_t, size_t *);
 503         efx_rc_t        (*envo_partn_read)(efx_nic_t *, uint32_t,
 504                                             unsigned int, caddr_t, size_t);
 505         efx_rc_t        (*envo_partn_read_backup)(efx_nic_t *, uint32_t,
 506                                             unsigned int, caddr_t, size_t);
 507         efx_rc_t        (*envo_partn_erase)(efx_nic_t *, uint32_t,
 508                                             unsigned int, size_t);
 509         efx_rc_t        (*envo_partn_write)(efx_nic_t *, uint32_t,
 510                                             unsigned int, caddr_t, size_t);
 511         efx_rc_t        (*envo_partn_rw_finish)(efx_nic_t *, uint32_t,
 512                                             uint32_t *);
 513         efx_rc_t        (*envo_partn_get_version)(efx_nic_t *, uint32_t,
 514                                             uint32_t *, uint16_t *);
 515         efx_rc_t        (*envo_partn_set_version)(efx_nic_t *, uint32_t,
 516                                             uint16_t *);
 517         efx_rc_t        (*envo_buffer_validate)(uint32_t,
 518                                             caddr_t, size_t);
 519 } efx_nvram_ops_t;
 520 #endif /* EFSYS_OPT_NVRAM */
 521
 522 #if EFSYS_OPT_VPD
 523 typedef struct efx_vpd_ops_s {
 524         efx_rc_t        (*evpdo_init)(efx_nic_t *);
 525         efx_rc_t        (*evpdo_size)(efx_nic_t *, size_t *);
 526         efx_rc_t        (*evpdo_read)(efx_nic_t *, caddr_t, size_t);
 527         efx_rc_t        (*evpdo_verify)(efx_nic_t *, caddr_t, size_t);
 528         efx_rc_t        (*evpdo_reinit)(efx_nic_t *, caddr_t, size_t);
 529         efx_rc_t        (*evpdo_get)(efx_nic_t *, caddr_t, size_t,
 530                                         efx_vpd_value_t *);
 531         efx_rc_t        (*evpdo_set)(efx_nic_t *, caddr_t, size_t,
 532                                         efx_vpd_value_t *);
 533         efx_rc_t        (*evpdo_next)(efx_nic_t *, caddr_t, size_t,
 534                                         efx_vpd_value_t *, unsigned int *);
 535         efx_rc_t        (*evpdo_write)(efx_nic_t *, caddr_t, size_t);
 536         void            (*evpdo_fini)(efx_nic_t *);
 537 } efx_vpd_ops_t;
 538 #endif  /* EFSYS_OPT_VPD */
 539
 540 #if EFSYS_OPT_VPD || EFSYS_OPT_NVRAM
 541
 542         __checkReturn           efx_rc_t
 543 efx_mcdi_nvram_partitions(
 544         __in                    efx_nic_t *enp,
 545         __out_bcount(size)      caddr_t data,
 546         __in                    size_t size,
 547         __out                   unsigned int *npartnp);
 548
 549         __checkReturn           efx_rc_t
 550 efx_mcdi_nvram_metadata(
 551         __in                    efx_nic_t *enp,
 552         __in                    uint32_t partn,
 553         __out                   uint32_t *subtypep,
 554         __out_ecount(4)         uint16_t version[4],
 555         __out_bcount_opt(size)  char *descp,
 556         __in                    size_t size);
 557
 558         __checkReturn           efx_rc_t
 559 efx_mcdi_nvram_info(
 560         __in                    efx_nic_t *enp,
 561         __in                    uint32_t partn,
 562         __out_opt               size_t *sizep,
 563         __out_opt               uint32_t *addressp,
 564         __out_opt               uint32_t *erase_sizep,
 565         __out_opt               uint32_t *write_sizep);
 566
 567         __checkReturn           efx_rc_t
 568 efx_mcdi_nvram_update_start(
 569         __in                    efx_nic_t *enp,
 570         __in                    uint32_t partn);
 571
 572         __checkReturn           efx_rc_t
 573 efx_mcdi_nvram_read(
 574         __in                    efx_nic_t *enp,
 575         __in                    uint32_t partn,
 576         __in                    uint32_t offset,
 577         __out_bcount(size)      caddr_t data,
 578         __in                    size_t size,
 579         __in                    uint32_t mode);
 580
 581         __checkReturn           efx_rc_t
 582 efx_mcdi_nvram_erase(
 583         __in                    efx_nic_t *enp,
 584         __in                    uint32_t partn,
 585         __in                    uint32_t offset,
 586         __in                    size_t size);
 587
 588         __checkReturn           efx_rc_t
 589 efx_mcdi_nvram_write(
 590         __in                    efx_nic_t *enp,
 591         __in                    uint32_t partn,
 592         __in                    uint32_t offset,
 593         __in_bcount(size)       caddr_t data,
 594         __in                    size_t size);
 595
 596         __checkReturn           efx_rc_t
 597 efx_mcdi_nvram_update_finish(
 598         __in                    efx_nic_t *enp,
 599         __in                    uint32_t partn,
 600         __in                    boolean_t reboot,
 601         __out_opt               uint32_t *verify_resultp);
 602
 603 #if EFSYS_OPT_DIAG
 604
 605         __checkReturn           efx_rc_t
 606 efx_mcdi_nvram_test(
 607         __in                    efx_nic_t *enp,
 608         __in                    uint32_t partn);
 609
 610 #endif  /* EFSYS_OPT_DIAG */
 611
 612 #endif /* EFSYS_OPT_VPD || EFSYS_OPT_NVRAM */
 613
 614 #if EFSYS_OPT_LICENSING
 615
 616 typedef struct efx_lic_ops_s {
 617         efx_rc_t        (*elo_update_licenses)(efx_nic_t *);
 618         efx_rc_t        (*elo_get_key_stats)(efx_nic_t *, efx_key_stats_t *);
 619         efx_rc_t        (*elo_app_state)(efx_nic_t *, uint64_t, boolean_t *);
 620         efx_rc_t        (*elo_get_id)(efx_nic_t *, size_t, uint32_t *,
 621                                       size_t *, uint8_t *);
 622         efx_rc_t        (*elo_find_start)
 623                                 (efx_nic_t *, caddr_t, size_t, uint32_t *);
 624         efx_rc_t        (*elo_find_end)(efx_nic_t *, caddr_t, size_t,
 625                                 uint32_t, uint32_t *);
 626         boolean_t       (*elo_find_key)(efx_nic_t *, caddr_t, size_t,
 627                                 uint32_t, uint32_t *, uint32_t *);
 628         boolean_t       (*elo_validate_key)(efx_nic_t *,
 629                                 caddr_t, uint32_t);
 630         efx_rc_t        (*elo_read_key)(efx_nic_t *,
 631                                 caddr_t, size_t, uint32_t, uint32_t,
 632                                 caddr_t, size_t, uint32_t *);
 633         efx_rc_t        (*elo_write_key)(efx_nic_t *,
 634                                 caddr_t, size_t, uint32_t,
 635                                 caddr_t, uint32_t, uint32_t *);
 636         efx_rc_t        (*elo_delete_key)(efx_nic_t *,
 637                                 caddr_t, size_t, uint32_t,
 638                                 uint32_t, uint32_t, uint32_t *);
 639         efx_rc_t        (*elo_create_partition)(efx_nic_t *,
 640                                 caddr_t, size_t);
 641         efx_rc_t        (*elo_finish_partition)(efx_nic_t *,
 642                                 caddr_t, size_t);
 643 } efx_lic_ops_t;
 644
 645 #endif
 646
 647 typedef struct efx_drv_cfg_s {
 648         uint32_t                edc_min_vi_count;
 649         uint32_t                edc_max_vi_count;
 650
 651         uint32_t                edc_max_piobuf_count;
 652         uint32_t                edc_pio_alloc_size;
 653 } efx_drv_cfg_t;
 654
 655 struct efx_nic_s {
 656         uint32_t                en_magic;
 657         efx_family_t            en_family;
 658         uint32_t                en_features;
 659         efsys_identifier_t      *en_esip;
 660         efsys_lock_t            *en_eslp;
 661         efsys_bar_t             *en_esbp;
 662         unsigned int            en_mod_flags;
 663         unsigned int            en_reset_flags;
 664         efx_nic_cfg_t           en_nic_cfg;
 665         efx_drv_cfg_t           en_drv_cfg;
 666         efx_port_t              en_port;
 667         efx_mon_t               en_mon;
 668         efx_intr_t              en_intr;
 669         uint32_t                en_ev_qcount;
 670         uint32_t                en_rx_qcount;
 671         uint32_t                en_tx_qcount;
 672         const efx_nic_ops_t     *en_enop;
 673         const efx_ev_ops_t      *en_eevop;
 674         const efx_tx_ops_t      *en_etxop;
 675         const efx_rx_ops_t      *en_erxop;
 676         efx_fw_variant_t        efv;
 677 #if EFSYS_OPT_FILTER
 678         efx_filter_t            en_filter;
 679         const efx_filter_ops_t  *en_efop;
 680 #endif  /* EFSYS_OPT_FILTER */
 681 #if EFSYS_OPT_TUNNEL
 682         efx_tunnel_cfg_t        en_tunnel_cfg;
 683         const efx_tunnel_ops_t  *en_etop;
 684 #endif /* EFSYS_OPT_TUNNEL */
 685 #if EFSYS_OPT_MCDI
 686         efx_mcdi_t              en_mcdi;
 687 #endif  /* EFSYS_OPT_MCDI */
 688 #if EFSYS_OPT_NVRAM
 689         uint32_t                en_nvram_partn_locked;
 690         const efx_nvram_ops_t   *en_envop;
 691 #endif  /* EFSYS_OPT_NVRAM */
 692 #if EFSYS_OPT_VPD
 693         const efx_vpd_ops_t     *en_evpdop;
 694 #endif  /* EFSYS_OPT_VPD */
 695 #if EFSYS_OPT_RX_SCALE
 696         efx_rx_hash_support_t           en_hash_support;
 697         efx_rx_scale_context_type_t     en_rss_context_type;
 698         uint32_t                        en_rss_context;
 699 #endif  /* EFSYS_OPT_RX_SCALE */
 700         uint32_t                en_vport_id;
 701 #if EFSYS_OPT_LICENSING
 702         const efx_lic_ops_t     *en_elop;
 703         boolean_t               en_licensing_supported;
 704 #endif
 705         union {
 706 #if EFSYS_OPT_SIENA
 707                 struct {
 708 #if EFSYS_OPT_NVRAM || EFSYS_OPT_VPD
 709                         unsigned int            enu_partn_mask;
 710 #endif  /* EFSYS_OPT_NVRAM || EFSYS_OPT_VPD */
 711 #if EFSYS_OPT_VPD
 712                         caddr_t                 enu_svpd;
 713                         size_t                  enu_svpd_length;
 714 #endif  /* EFSYS_OPT_VPD */
 715                         int                     enu_unused;
 716                 } siena;
 717 #endif  /* EFSYS_OPT_SIENA */
 718                 int     enu_unused;
 719         } en_u;
 720 #if EFX_OPTS_EF10()
 721         union en_arch {
 722                 struct {
 723                         int                     ena_vi_base;
 724                         int                     ena_vi_count;
 725                         int                     ena_vi_shift;
 726 #if EFSYS_OPT_VPD
 727                         caddr_t                 ena_svpd;
 728                         size_t                  ena_svpd_length;
 729 #endif  /* EFSYS_OPT_VPD */
 730                         efx_piobuf_handle_t     ena_piobuf_handle[EF10_MAX_PIOBUF_NBUFS];
 731                         uint32_t                ena_piobuf_count;
 732                         uint32_t                ena_pio_alloc_map[EF10_MAX_PIOBUF_NBUFS];
 733                         uint32_t                ena_pio_write_vi_base;
 734                         /* Memory BAR mapping regions */
 735                         uint32_t                ena_uc_mem_map_offset;
 736                         size_t                  ena_uc_mem_map_size;
 737                         uint32_t                ena_wc_mem_map_offset;
 738                         size_t                  ena_wc_mem_map_size;
 739                 } ef10;
 740         } en_arch;
 741 #endif  /* EFX_OPTS_EF10() */
 742 };
 743
 744 #define EFX_FAMILY_IS_EF10(_enp) \
 745         ((_enp)->en_family == EFX_FAMILY_MEDFORD2 || \
 746          (_enp)->en_family == EFX_FAMILY_MEDFORD || \
 747          (_enp)->en_family == EFX_FAMILY_HUNTINGTON)
 748
 749
 750 #define EFX_NIC_MAGIC   0x02121996
 751
 752 typedef boolean_t (*efx_ev_handler_t)(efx_evq_t *, efx_qword_t *,
 753     const efx_ev_callbacks_t *, void *);
 754
 755 typedef struct efx_evq_rxq_state_s {
 756         unsigned int                    eers_rx_read_ptr;
 757         unsigned int                    eers_rx_mask;
 758 #if EFSYS_OPT_RX_PACKED_STREAM || EFSYS_OPT_RX_ES_SUPER_BUFFER
 759         unsigned int                    eers_rx_stream_npackets;
 760         boolean_t                       eers_rx_packed_stream;
 761 #endif
 762 #if EFSYS_OPT_RX_PACKED_STREAM
 763         unsigned int                    eers_rx_packed_stream_credits;
 764 #endif
 765 } efx_evq_rxq_state_t;
 766
 767 struct efx_evq_s {
 768         uint32_t                        ee_magic;
 769         uint32_t                        ee_flags;
 770         efx_nic_t                       *ee_enp;
 771         unsigned int                    ee_index;
 772         unsigned int                    ee_mask;
 773         efsys_mem_t                     *ee_esmp;
 774 #if EFSYS_OPT_QSTATS
 775         uint32_t                        ee_stat[EV_NQSTATS];
 776 #endif  /* EFSYS_OPT_QSTATS */
 777
 778         efx_ev_handler_t                ee_rx;
 779         efx_ev_handler_t                ee_tx;
 780         efx_ev_handler_t                ee_driver;
 781         efx_ev_handler_t                ee_global;
 782         efx_ev_handler_t                ee_drv_gen;
 783 #if EFSYS_OPT_MCDI
 784         efx_ev_handler_t                ee_mcdi;
 785 #endif  /* EFSYS_OPT_MCDI */
 786
 787         efx_evq_rxq_state_t             ee_rxq_state[EFX_EV_RX_NLABELS];
 788 };
 789
 790 #define EFX_EVQ_MAGIC   0x08081997
 791
 792 #define EFX_EVQ_SIENA_TIMER_QUANTUM_NS  6144 /* 768 cycles */
 793
 794 struct efx_rxq_s {
 795         uint32_t                        er_magic;
 796         efx_nic_t                       *er_enp;
 797         efx_evq_t                       *er_eep;
 798         unsigned int                    er_index;
 799         unsigned int                    er_label;
 800         unsigned int                    er_mask;
 801         size_t                          er_buf_size;
 802         efsys_mem_t                     *er_esmp;
 803         efx_evq_rxq_state_t             *er_ev_qstate;
 804 };
 805
 806 #define EFX_RXQ_MAGIC   0x15022005
 807
 808 struct efx_txq_s {
 809         uint32_t                        et_magic;
 810         efx_nic_t                       *et_enp;
 811         unsigned int                    et_index;
 812         unsigned int                    et_mask;
 813         efsys_mem_t                     *et_esmp;
 814 #if EFSYS_OPT_HUNTINGTON
 815         uint32_t                        et_pio_bufnum;
 816         uint32_t                        et_pio_blknum;
 817         uint32_t                        et_pio_write_offset;
 818         uint32_t                        et_pio_offset;
 819         size_t                          et_pio_size;
 820 #endif
 821 #if EFSYS_OPT_QSTATS
 822         uint32_t                        et_stat[TX_NQSTATS];
 823 #endif  /* EFSYS_OPT_QSTATS */
 824 };
 825
 826 #define EFX_TXQ_MAGIC   0x05092005
 827
 828 #define EFX_MAC_ADDR_COPY(_dst, _src)                                   \
 829         do {                                                            \
 830                 (_dst)[0] = (_src)[0];                                  \
 831                 (_dst)[1] = (_src)[1];                                  \
 832                 (_dst)[2] = (_src)[2];                                  \
 833                 (_dst)[3] = (_src)[3];                                  \
 834                 (_dst)[4] = (_src)[4];                                  \
 835                 (_dst)[5] = (_src)[5];                                  \
 836         _NOTE(CONSTANTCONDITION)                                        \
 837         } while (B_FALSE)
 838
 839 #define EFX_MAC_BROADCAST_ADDR_SET(_dst)                                \
 840         do {                                                            \
 841                 uint16_t *_d = (uint16_t *)(_dst);                      \
 842                 _d[0] = 0xffff;                                         \
 843                 _d[1] = 0xffff;                                         \
 844                 _d[2] = 0xffff;                                         \
 845         _NOTE(CONSTANTCONDITION)                                        \
 846         } while (B_FALSE)
 847
 848 #if EFSYS_OPT_CHECK_REG
 849 #define EFX_CHECK_REG(_enp, _reg)                                       \
 850         do {                                                            \
 851                 const char *name = #_reg;                               \
 852                 char min = name[4];                                     \
 853                 char max = name[5];                                     \
 854                 char rev;                                               \
 855                                                                         \
 856                 switch ((_enp)->en_family) {                            \
 857                 case EFX_FAMILY_SIENA:                                  \
 858                         rev = 'C';                                      \
 859                         break;                                          \
 860                                                                         \
 861                 case EFX_FAMILY_HUNTINGTON:                             \
 862                         rev = 'D';                                      \
 863                         break;                                          \
 864                                                                         \
 865                 case EFX_FAMILY_MEDFORD:                                \
 866                         rev = 'E';                                      \
 867                         break;                                          \
 868                                                                         \
 869                 case EFX_FAMILY_MEDFORD2:                               \
 870                         rev = 'F';                                      \
 871                         break;                                          \
 872                                                                         \
 873                 default:                                                \
 874                         rev = '?';                                      \
 875                         break;                                          \
 876                 }                                                       \
 877                                                                         \
 878                 EFSYS_ASSERT3S(rev, >=, min);                           \
 879                 EFSYS_ASSERT3S(rev, <=, max);                           \
 880                                                                         \
 881         _NOTE(CONSTANTCONDITION)                                        \
 882         } while (B_FALSE)
 883 #else
 884 #define EFX_CHECK_REG(_enp, _reg) do {                                  \
 885         _NOTE(CONSTANTCONDITION)                                        \
 886         } while (B_FALSE)
 887 #endif
 888
 889 #define EFX_BAR_READD(_enp, _reg, _edp, _lock)                          \
 890         do {                                                            \
 891                 EFX_CHECK_REG((_enp), (_reg));                          \
 892                 EFSYS_BAR_READD((_enp)->en_esbp, _reg ## _OFST,         \
 893                     (_edp), (_lock));                                   \
 894                 EFSYS_PROBE3(efx_bar_readd, const char *, #_reg,        \
 895                     uint32_t, _reg ## _OFST,                            \
 896                     uint32_t, (_edp)->ed_u32[0]);                       \
 897         _NOTE(CONSTANTCONDITION)                                        \
 898         } while (B_FALSE)
 899
 900 #define EFX_BAR_WRITED(_enp, _reg, _edp, _lock)                         \
 901         do {                                                            \
 902                 EFX_CHECK_REG((_enp), (_reg));                          \
 903                 EFSYS_PROBE3(efx_bar_writed, const char *, #_reg,       \
 904                     uint32_t, _reg ## _OFST,                            \
 905                     uint32_t, (_edp)->ed_u32[0]);                       \
 906                 EFSYS_BAR_WRITED((_enp)->en_esbp, _reg ## _OFST,        \
 907                     (_edp), (_lock));                                   \
 908         _NOTE(CONSTANTCONDITION)                                        \
 909         } while (B_FALSE)
 910
 911 #define EFX_BAR_READQ(_enp, _reg, _eqp)                                 \
 912         do {                                                            \
 913                 EFX_CHECK_REG((_enp), (_reg));                          \
 914                 EFSYS_BAR_READQ((_enp)->en_esbp, _reg ## _OFST,         \
 915                     (_eqp));                                            \
 916                 EFSYS_PROBE4(efx_bar_readq, const char *, #_reg,        \
 917                     uint32_t, _reg ## _OFST,                            \
 918                     uint32_t, (_eqp)->eq_u32[1],                        \
 919                     uint32_t, (_eqp)->eq_u32[0]);                       \
 920         _NOTE(CONSTANTCONDITION)                                        \
 921         } while (B_FALSE)
 922
 923 #define EFX_BAR_WRITEQ(_enp, _reg, _eqp)                                \
 924         do {                                                            \
 925                 EFX_CHECK_REG((_enp), (_reg));                          \
 926                 EFSYS_PROBE4(efx_bar_writeq, const char *, #_reg,       \
 927                     uint32_t, _reg ## _OFST,                            \
 928                     uint32_t, (_eqp)->eq_u32[1],                        \
 929                     uint32_t, (_eqp)->eq_u32[0]);                       \
 930                 EFSYS_BAR_WRITEQ((_enp)->en_esbp, _reg ## _OFST,        \
 931                     (_eqp));                                            \
 932         _NOTE(CONSTANTCONDITION)                                        \
 933         } while (B_FALSE)
 934
 935 #define EFX_BAR_READO(_enp, _reg, _eop)                                 \
 936         do {                                                            \
 937                 EFX_CHECK_REG((_enp), (_reg));                          \
 938                 EFSYS_BAR_READO((_enp)->en_esbp, _reg ## _OFST,         \
 939                     (_eop), B_TRUE);                                    \
 940                 EFSYS_PROBE6(efx_bar_reado, const char *, #_reg,        \
 941                     uint32_t, _reg ## _OFST,                            \
 942                     uint32_t, (_eop)->eo_u32[3],                        \
 943                     uint32_t, (_eop)->eo_u32[2],                        \
 944                     uint32_t, (_eop)->eo_u32[1],                        \
 945                     uint32_t, (_eop)->eo_u32[0]);                       \
 946         _NOTE(CONSTANTCONDITION)                                        \
 947         } while (B_FALSE)
 948
 949 #define EFX_BAR_WRITEO(_enp, _reg, _eop)                                \
 950         do {                                                            \
 951                 EFX_CHECK_REG((_enp), (_reg));                          \
 952                 EFSYS_PROBE6(efx_bar_writeo, const char *, #_reg,       \
 953                     uint32_t, _reg ## _OFST,                            \
 954                     uint32_t, (_eop)->eo_u32[3],                        \
 955                     uint32_t, (_eop)->eo_u32[2],                        \
 956                     uint32_t, (_eop)->eo_u32[1],                        \
 957                     uint32_t, (_eop)->eo_u32[0]);                       \
 958                 EFSYS_BAR_WRITEO((_enp)->en_esbp, _reg ## _OFST,        \
 959                     (_eop), B_TRUE);                                    \
 960         _NOTE(CONSTANTCONDITION)                                        \
 961         } while (B_FALSE)
 962
 963 /*
 964  * Accessors for memory BAR non-VI tables.
 965  *
 966  * Code used on EF10 *must* use EFX_BAR_VI_*() macros for per-VI registers,
 967  * to ensure the correct runtime VI window size is used on Medford2.
 968  *
 969  * Siena-only code may continue using EFX_BAR_TBL_*() macros for VI registers.
 970  */
 971
 972 #define EFX_BAR_TBL_READD(_enp, _reg, _index, _edp, _lock)              \
 973         do {                                                            \
 974                 EFX_CHECK_REG((_enp), (_reg));                          \
 975                 EFSYS_BAR_READD((_enp)->en_esbp,                        \
 976                     (_reg ## _OFST + ((_index) * _reg ## _STEP)),       \
 977                     (_edp), (_lock));                                   \
 978                 EFSYS_PROBE4(efx_bar_tbl_readd, const char *, #_reg,    \
 979                     uint32_t, (_index),                                 \
 980                     uint32_t, _reg ## _OFST,                            \
 981                     uint32_t, (_edp)->ed_u32[0]);                       \
 982         _NOTE(CONSTANTCONDITION)                                        \
 983         } while (B_FALSE)
 984
 985 #define EFX_BAR_TBL_WRITED(_enp, _reg, _index, _edp, _lock)             \
 986         do {                                                            \
 987                 EFX_CHECK_REG((_enp), (_reg));                          \
 988                 EFSYS_PROBE4(efx_bar_tbl_writed, const char *, #_reg,   \
 989                     uint32_t, (_index),                                 \
 990                     uint32_t, _reg ## _OFST,                            \
 991                     uint32_t, (_edp)->ed_u32[0]);                       \
 992                 EFSYS_BAR_WRITED((_enp)->en_esbp,                       \
 993                     (_reg ## _OFST + ((_index) * _reg ## _STEP)),       \
 994                     (_edp), (_lock));                                   \
 995         _NOTE(CONSTANTCONDITION)                                        \
 996         } while (B_FALSE)
 997
 998 #define EFX_BAR_TBL_WRITED3(_enp, _reg, _index, _edp, _lock)            \
 999         do {                                                            \
1000                 EFX_CHECK_REG((_enp), (_reg));                          \
1001                 EFSYS_PROBE4(efx_bar_tbl_writed, const char *, #_reg,   \
1002                     uint32_t, (_index),                                 \
1003                     uint32_t, _reg ## _OFST,                            \
1004                     uint32_t, (_edp)->ed_u32[0]);                       \
1005                 EFSYS_BAR_WRITED((_enp)->en_esbp,                       \
1006                     (_reg ## _OFST +                                    \
1007                     (3 * sizeof (efx_dword_t)) +                        \
1008                     ((_index) * _reg ## _STEP)),                        \
1009                     (_edp), (_lock));                                   \
1010         _NOTE(CONSTANTCONDITION)                                        \
1011         } while (B_FALSE)
1012
1013 #define EFX_BAR_TBL_READQ(_enp, _reg, _index, _eqp)                     \
1014         do {                                                            \
1015                 EFX_CHECK_REG((_enp), (_reg));                          \
1016                 EFSYS_BAR_READQ((_enp)->en_esbp,                        \
1017                     (_reg ## _OFST + ((_index) * _reg ## _STEP)),       \
1018                     (_eqp));                                            \
1019                 EFSYS_PROBE5(efx_bar_tbl_readq, const char *, #_reg,    \
1020                     uint32_t, (_index),                                 \
1021                     uint32_t, _reg ## _OFST,                            \
1022                     uint32_t, (_eqp)->eq_u32[1],                        \
1023                     uint32_t, (_eqp)->eq_u32[0]);                       \
1024         _NOTE(CONSTANTCONDITION)                                        \
1025         } while (B_FALSE)
1026
1027 #define EFX_BAR_TBL_WRITEQ(_enp, _reg, _index, _eqp)                    \
1028         do {                                                            \
1029                 EFX_CHECK_REG((_enp), (_reg));                          \
1030                 EFSYS_PROBE5(efx_bar_tbl_writeq, const char *, #_reg,   \
1031                     uint32_t, (_index),                                 \
1032                     uint32_t, _reg ## _OFST,                            \
1033                     uint32_t, (_eqp)->eq_u32[1],                        \
1034                     uint32_t, (_eqp)->eq_u32[0]);                       \
1035                 EFSYS_BAR_WRITEQ((_enp)->en_esbp,                       \
1036                     (_reg ## _OFST + ((_index) * _reg ## _STEP)),       \
1037                     (_eqp));                                            \
1038         _NOTE(CONSTANTCONDITION)                                        \
1039         } while (B_FALSE)
1040
1041 #define EFX_BAR_TBL_READO(_enp, _reg, _index, _eop, _lock)              \
1042         do {                                                            \
1043                 EFX_CHECK_REG((_enp), (_reg));                          \
1044                 EFSYS_BAR_READO((_enp)->en_esbp,                        \
1045                     (_reg ## _OFST + ((_index) * _reg ## _STEP)),       \
1046                     (_eop), (_lock));                                   \
1047                 EFSYS_PROBE7(efx_bar_tbl_reado, const char *, #_reg,    \
1048                     uint32_t, (_index),                                 \
1049                     uint32_t, _reg ## _OFST,                            \
1050                     uint32_t, (_eop)->eo_u32[3],                        \
1051                     uint32_t, (_eop)->eo_u32[2],                        \
1052                     uint32_t, (_eop)->eo_u32[1],                        \
1053                     uint32_t, (_eop)->eo_u32[0]);                       \
1054         _NOTE(CONSTANTCONDITION)                                        \
1055         } while (B_FALSE)
1056
1057 #define EFX_BAR_TBL_WRITEO(_enp, _reg, _index, _eop, _lock)             \
1058         do {                                                            \
1059                 EFX_CHECK_REG((_enp), (_reg));                          \
1060                 EFSYS_PROBE7(efx_bar_tbl_writeo, const char *, #_reg,   \
1061                     uint32_t, (_index),                                 \
1062                     uint32_t, _reg ## _OFST,                            \
1063                     uint32_t, (_eop)->eo_u32[3],                        \
1064                     uint32_t, (_eop)->eo_u32[2],                        \
1065                     uint32_t, (_eop)->eo_u32[1],                        \
1066                     uint32_t, (_eop)->eo_u32[0]);                       \
1067                 EFSYS_BAR_WRITEO((_enp)->en_esbp,                       \
1068                     (_reg ## _OFST + ((_index) * _reg ## _STEP)),       \
1069                     (_eop), (_lock));                                   \
1070         _NOTE(CONSTANTCONDITION)                                        \
1071         } while (B_FALSE)
1072
1073 /*
1074  * Accessors for memory BAR per-VI registers.
1075  *
1076  * The VI window size is 8KB for Medford and all earlier controllers.
1077  * For Medford2, the VI window size can be 8KB, 16KB or 64KB.
1078  */
1079
1080 #define EFX_BAR_VI_READD(_enp, _reg, _index, _edp, _lock)               \
1081         do {                                                            \
1082                 EFX_CHECK_REG((_enp), (_reg));                          \
1083                 EFSYS_BAR_READD((_enp)->en_esbp,                        \
1084                     ((_reg ## _OFST) +                                  \
1085                     ((_index) << (_enp)->en_nic_cfg.enc_vi_window_shift)), \
1086                     (_edp), (_lock));                                   \
1087                 EFSYS_PROBE4(efx_bar_vi_readd, const char *, #_reg,     \
1088                     uint32_t, (_index),                                 \
1089                     uint32_t, _reg ## _OFST,                            \
1090                     uint32_t, (_edp)->ed_u32[0]);                       \
1091         _NOTE(CONSTANTCONDITION)                                        \
1092         } while (B_FALSE)
1093
1094 #define EFX_BAR_VI_WRITED(_enp, _reg, _index, _edp, _lock)              \
1095         do {                                                            \
1096                 EFX_CHECK_REG((_enp), (_reg));                          \
1097                 EFSYS_PROBE4(efx_bar_vi_writed, const char *, #_reg,    \
1098                     uint32_t, (_index),                                 \
1099                     uint32_t, _reg ## _OFST,                            \
1100                     uint32_t, (_edp)->ed_u32[0]);                       \
1101                 EFSYS_BAR_WRITED((_enp)->en_esbp,                       \
1102                     ((_reg ## _OFST) +                                  \
1103                     ((_index) << (_enp)->en_nic_cfg.enc_vi_window_shift)), \
1104                     (_edp), (_lock));                                   \
1105         _NOTE(CONSTANTCONDITION)                                        \
1106         } while (B_FALSE)
1107
1108 #define EFX_BAR_VI_WRITED2(_enp, _reg, _index, _edp, _lock)             \
1109         do {                                                            \
1110                 EFX_CHECK_REG((_enp), (_reg));                          \
1111                 EFSYS_PROBE4(efx_bar_vi_writed, const char *, #_reg,    \
1112                     uint32_t, (_index),                                 \
1113                     uint32_t, _reg ## _OFST,                            \
1114                     uint32_t, (_edp)->ed_u32[0]);                       \
1115                 EFSYS_BAR_WRITED((_enp)->en_esbp,                       \
1116                     ((_reg ## _OFST) +                                  \
1117                     (2 * sizeof (efx_dword_t)) +                        \
1118                     ((_index) << (_enp)->en_nic_cfg.enc_vi_window_shift)), \
1119                     (_edp), (_lock));                                   \
1120         _NOTE(CONSTANTCONDITION)                                        \
1121         } while (B_FALSE)
1122
1123 /*
1124  * Allow drivers to perform optimised 128-bit VI doorbell writes.
1125  * The DMA descriptor pointers (RX_DESC_UPD and TX_DESC_UPD) are
1126  * special-cased in the BIU on the Falcon/Siena and EF10 architectures to avoid
1127  * the need for locking in the host, and are the only ones known to be safe to
1128  * use 128-bites write with.
1129  */
1130 #define EFX_BAR_VI_DOORBELL_WRITEO(_enp, _reg, _index, _eop)            \
1131         do {                                                            \
1132                 EFX_CHECK_REG((_enp), (_reg));                          \
1133                 EFSYS_PROBE7(efx_bar_vi_doorbell_writeo,                \
1134                     const char *, #_reg,                                \
1135                     uint32_t, (_index),                                 \
1136                     uint32_t, _reg ## _OFST,                            \
1137                     uint32_t, (_eop)->eo_u32[3],                        \
1138                     uint32_t, (_eop)->eo_u32[2],                        \
1139                     uint32_t, (_eop)->eo_u32[1],                        \
1140                     uint32_t, (_eop)->eo_u32[0]);                       \
1141                 EFSYS_BAR_DOORBELL_WRITEO((_enp)->en_esbp,              \
1142                     (_reg ## _OFST +                                    \
1143                     ((_index) << (_enp)->en_nic_cfg.enc_vi_window_shift)), \
1144                     (_eop));                                            \
1145         _NOTE(CONSTANTCONDITION)                                        \
1146         } while (B_FALSE)
1147
1148 #define EFX_DMA_SYNC_QUEUE_FOR_DEVICE(_esmp, _entries, _wptr, _owptr)   \
1149         do {                                                            \
1150                 unsigned int _new = (_wptr);                            \
1151                 unsigned int _old = (_owptr);                           \
1152                                                                         \
1153                 if ((_new) >= (_old))                                   \
1154                         EFSYS_DMA_SYNC_FOR_DEVICE((_esmp),              \
1155                             (_old) * sizeof (efx_desc_t),               \
1156                             ((_new) - (_old)) * sizeof (efx_desc_t));   \
1157                 else                                                    \
1158                         /*                                              \
1159                          * It is cheaper to sync entire map than sync   \
1160                          * two parts especially when offset/size are    \
1161                          * ignored and entire map is synced in any case.\
1162                          */                                             \
1163                         EFSYS_DMA_SYNC_FOR_DEVICE((_esmp),              \
1164                             0,                                          \
1165                             (_entries) * sizeof (efx_desc_t));          \
1166         _NOTE(CONSTANTCONDITION)                                        \
1167         } while (B_FALSE)
1168
1169 extern  __checkReturn   efx_rc_t
1170 efx_mac_select(
1171         __in            efx_nic_t *enp);
1172
1173 extern  void
1174 efx_mac_multicast_hash_compute(
1175         __in_ecount(6*count)            uint8_t const *addrs,
1176         __in                            int count,
1177         __out                           efx_oword_t *hash_low,
1178         __out                           efx_oword_t *hash_high);
1179
1180 extern  __checkReturn   efx_rc_t
1181 efx_phy_probe(
1182         __in            efx_nic_t *enp);
1183
1184 extern                  void
1185 efx_phy_unprobe(
1186         __in            efx_nic_t *enp);
1187
1188 #if EFSYS_OPT_VPD
1189
1190 /* VPD utility functions */
1191
1192 extern  __checkReturn           efx_rc_t
1193 efx_vpd_hunk_length(
1194         __in_bcount(size)       caddr_t data,
1195         __in                    size_t size,
1196         __out                   size_t *lengthp);
1197
1198 extern  __checkReturn           efx_rc_t
1199 efx_vpd_hunk_verify(
1200         __in_bcount(size)       caddr_t data,
1201         __in                    size_t size,
1202         __out_opt               boolean_t *cksummedp);
1203
1204 extern  __checkReturn           efx_rc_t
1205 efx_vpd_hunk_reinit(
1206         __in_bcount(size)       caddr_t data,
1207         __in                    size_t size,
1208         __in                    boolean_t wantpid);
1209
1210 extern  __checkReturn           efx_rc_t
1211 efx_vpd_hunk_get(
1212         __in_bcount(size)       caddr_t data,
1213         __in                    size_t size,
1214         __in                    efx_vpd_tag_t tag,
1215         __in                    efx_vpd_keyword_t keyword,
1216         __out                   unsigned int *payloadp,
1217         __out                   uint8_t *paylenp);
1218
1219 extern  __checkReturn                   efx_rc_t
1220 efx_vpd_hunk_next(
1221         __in_bcount(size)               caddr_t data,
1222         __in                            size_t size,
1223         __out                           efx_vpd_tag_t *tagp,
1224         __out                           efx_vpd_keyword_t *keyword,
1225         __out_opt                       unsigned int *payloadp,
1226         __out_opt                       uint8_t *paylenp,
1227         __inout                         unsigned int *contp);
1228
1229 extern  __checkReturn           efx_rc_t
1230 efx_vpd_hunk_set(
1231         __in_bcount(size)       caddr_t data,
1232         __in                    size_t size,
1233         __in                    efx_vpd_value_t *evvp);
1234
1235 #endif  /* EFSYS_OPT_VPD */
1236
1237 #if EFSYS_OPT_MCDI
1238
1239 extern  __checkReturn           efx_rc_t
1240 efx_mcdi_set_workaround(
1241         __in                    efx_nic_t *enp,
1242         __in                    uint32_t type,
1243         __in                    boolean_t enabled,
1244         __out_opt               uint32_t *flagsp);
1245
1246 extern  __checkReturn           efx_rc_t
1247 efx_mcdi_get_workarounds(
1248         __in                    efx_nic_t *enp,
1249         __out_opt               uint32_t *implementedp,
1250         __out_opt               uint32_t *enabledp);
1251
1252 #endif /* EFSYS_OPT_MCDI */
1253
1254 #if EFSYS_OPT_MAC_STATS
1255
1256 /*
1257  * Closed range of stats (i.e. the first and the last are included).
1258  * The last must be greater or equal (if the range is one item only) to
1259  * the first.
1260  */
1261 struct efx_mac_stats_range {
1262         efx_mac_stat_t          first;
1263         efx_mac_stat_t          last;
1264 };
1265
1266 extern                                  efx_rc_t
1267 efx_mac_stats_mask_add_ranges(
1268         __inout_bcount(mask_size)       uint32_t *maskp,
1269         __in                            size_t mask_size,
1270         __in_ecount(rng_count)          const struct efx_mac_stats_range *rngp,
1271         __in                            unsigned int rng_count);
1272
1273 #endif  /* EFSYS_OPT_MAC_STATS */
1274
1275 #ifdef  __cplusplus
1276 }
1277 #endif
1278
1279 #endif  /* _SYS_EFX_IMPL_H */