drivers/net/sfc/base/efx_impl.h

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