drivers/net/sfc/base/siena_impl.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  *
   3  * Copyright (c) 2009-2018 Solarflare Communications Inc.
   4  * All rights reserved.
   5  */
   6
   7 #ifndef _SYS_SIENA_IMPL_H
   8 #define _SYS_SIENA_IMPL_H
   9
  10 #include "efx.h"
  11 #include "efx_regs.h"
  12 #include "efx_mcdi.h"
  13 #include "siena_flash.h"
  14
  15 #ifdef  __cplusplus
  16 extern "C" {
  17 #endif
  18
  19 #ifndef EFX_TXQ_DC_SIZE
  20 #define EFX_TXQ_DC_SIZE 1 /* 16 descriptors */
  21 #endif
  22 #ifndef EFX_RXQ_DC_SIZE
  23 #define EFX_RXQ_DC_SIZE 3 /* 64 descriptors */
  24 #endif
  25 #define EFX_TXQ_DC_NDESCS(_dcsize)      (8 << (_dcsize))
  26 #define EFX_RXQ_DC_NDESCS(_dcsize)      (8 << (_dcsize))
  27
  28 #define SIENA_EVQ_MAXNEVS       32768
  29 #define SIENA_EVQ_MINNEVS       512
  30
  31 #define SIENA_TXQ_MAXNDESCS     4096
  32 #define SIENA_TXQ_MINNDESCS     512
  33
  34 #define SIENA_RXQ_MAXNDESCS     4096
  35 #define SIENA_RXQ_MINNDESCS     512
  36
  37 #define SIENA_NVRAM_CHUNK 0x80
  38
  39
  40 extern  __checkReturn   efx_rc_t
  41 siena_nic_probe(
  42         __in            efx_nic_t *enp);
  43
  44 extern  __checkReturn   efx_rc_t
  45 siena_nic_reset(
  46         __in            efx_nic_t *enp);
  47
  48 extern  __checkReturn   efx_rc_t
  49 siena_nic_init(
  50         __in            efx_nic_t *enp);
  51
  52 #if EFSYS_OPT_DIAG
  53
  54 extern  efx_sram_pattern_fn_t   __efx_sram_pattern_fns[];
  55
  56 typedef struct siena_register_set_s {
  57         unsigned int            address;
  58         unsigned int            step;
  59         unsigned int            rows;
  60         efx_oword_t             mask;
  61 } siena_register_set_t;
  62
  63 extern  __checkReturn   efx_rc_t
  64 siena_nic_register_test(
  65         __in            efx_nic_t *enp);
  66
  67 #endif  /* EFSYS_OPT_DIAG */
  68
  69 extern                  void
  70 siena_nic_fini(
  71         __in            efx_nic_t *enp);
  72
  73 extern                  void
  74 siena_nic_unprobe(
  75         __in            efx_nic_t *enp);
  76
  77 #define SIENA_SRAM_ROWS 0x12000
  78
  79 extern                  void
  80 siena_sram_init(
  81         __in            efx_nic_t *enp);
  82
  83 #if EFSYS_OPT_DIAG
  84
  85 extern  __checkReturn   efx_rc_t
  86 siena_sram_test(
  87         __in            efx_nic_t *enp,
  88         __in            efx_sram_pattern_fn_t func);
  89
  90 #endif  /* EFSYS_OPT_DIAG */
  91
  92 #if EFSYS_OPT_MCDI
  93
  94 extern  __checkReturn   efx_rc_t
  95 siena_mcdi_init(
  96         __in            efx_nic_t *enp,
  97         __in            const efx_mcdi_transport_t *mtp);
  98
  99 extern                  void
 100 siena_mcdi_send_request(
 101         __in                    efx_nic_t *enp,
 102         __in_bcount(hdr_len)    void *hdrp,
 103         __in                    size_t hdr_len,
 104         __in_bcount(sdu_len)    void *sdup,
 105         __in                    size_t sdu_len);
 106
 107 extern  __checkReturn   boolean_t
 108 siena_mcdi_poll_response(
 109         __in            efx_nic_t *enp);
 110
 111 extern                  void
 112 siena_mcdi_read_response(
 113         __in                    efx_nic_t *enp,
 114         __out_bcount(length)    void *bufferp,
 115         __in                    size_t offset,
 116         __in                    size_t length);
 117
 118 extern                  efx_rc_t
 119 siena_mcdi_poll_reboot(
 120         __in            efx_nic_t *enp);
 121
 122 extern                  void
 123 siena_mcdi_fini(
 124         __in            efx_nic_t *enp);
 125
 126 extern  __checkReturn   efx_rc_t
 127 siena_mcdi_feature_supported(
 128         __in            efx_nic_t *enp,
 129         __in            efx_mcdi_feature_id_t id,
 130         __out           boolean_t *supportedp);
 131
 132 extern                  void
 133 siena_mcdi_get_timeout(
 134         __in            efx_nic_t *enp,
 135         __in            efx_mcdi_req_t *emrp,
 136         __out           uint32_t *timeoutp);
 137
 138 #endif /* EFSYS_OPT_MCDI */
 139
 140 #if EFSYS_OPT_NVRAM || EFSYS_OPT_VPD
 141
 142 extern  __checkReturn           efx_rc_t
 143 siena_nvram_partn_lock(
 144         __in                    efx_nic_t *enp,
 145         __in                    uint32_t partn);
 146
 147 extern  __checkReturn           efx_rc_t
 148 siena_nvram_partn_unlock(
 149         __in                    efx_nic_t *enp,
 150         __in                    uint32_t partn,
 151         __out_opt               uint32_t *verify_resultp);
 152
 153 extern  __checkReturn           efx_rc_t
 154 siena_nvram_get_dynamic_cfg(
 155         __in                    efx_nic_t *enp,
 156         __in                    uint32_t partn,
 157         __in                    boolean_t vpd,
 158         __out                   siena_mc_dynamic_config_hdr_t **dcfgp,
 159         __out                   size_t *sizep);
 160
 161 #endif  /* EFSYS_OPT_VPD || EFSYS_OPT_NVRAM */
 162
 163 #if EFSYS_OPT_NVRAM
 164
 165 #if EFSYS_OPT_DIAG
 166
 167 extern  __checkReturn           efx_rc_t
 168 siena_nvram_test(
 169         __in                    efx_nic_t *enp);
 170
 171 #endif  /* EFSYS_OPT_DIAG */
 172
 173 extern  __checkReturn           efx_rc_t
 174 siena_nvram_get_subtype(
 175         __in                    efx_nic_t *enp,
 176         __in                    uint32_t partn,
 177         __out                   uint32_t *subtypep);
 178
 179 extern  __checkReturn           efx_rc_t
 180 siena_nvram_type_to_partn(
 181         __in                    efx_nic_t *enp,
 182         __in                    efx_nvram_type_t type,
 183         __out                   uint32_t *partnp);
 184
 185 extern  __checkReturn           efx_rc_t
 186 siena_nvram_partn_size(
 187         __in                    efx_nic_t *enp,
 188         __in                    uint32_t partn,
 189         __out                   size_t *sizep);
 190
 191 extern  __checkReturn           efx_rc_t
 192 siena_nvram_partn_rw_start(
 193         __in                    efx_nic_t *enp,
 194         __in                    uint32_t partn,
 195         __out                   size_t *chunk_sizep);
 196
 197 extern  __checkReturn           efx_rc_t
 198 siena_nvram_partn_read(
 199         __in                    efx_nic_t *enp,
 200         __in                    uint32_t partn,
 201         __in                    unsigned int offset,
 202         __out_bcount(size)      caddr_t data,
 203         __in                    size_t size);
 204
 205 extern  __checkReturn           efx_rc_t
 206 siena_nvram_partn_erase(
 207         __in                    efx_nic_t *enp,
 208         __in                    uint32_t partn,
 209         __in                    unsigned int offset,
 210         __in                    size_t size);
 211
 212 extern  __checkReturn           efx_rc_t
 213 siena_nvram_partn_write(
 214         __in                    efx_nic_t *enp,
 215         __in                    uint32_t partn,
 216         __in                    unsigned int offset,
 217         __out_bcount(size)      caddr_t data,
 218         __in                    size_t size);
 219
 220 extern  __checkReturn           efx_rc_t
 221 siena_nvram_partn_rw_finish(
 222         __in                    efx_nic_t *enp,
 223         __in                    uint32_t partn,
 224         __out_opt               uint32_t *verify_resultp);
 225
 226 extern  __checkReturn           efx_rc_t
 227 siena_nvram_partn_get_version(
 228         __in                    efx_nic_t *enp,
 229         __in                    uint32_t partn,
 230         __out                   uint32_t *subtypep,
 231         __out_ecount(4)         uint16_t version[4]);
 232
 233 extern  __checkReturn           efx_rc_t
 234 siena_nvram_partn_set_version(
 235         __in                    efx_nic_t *enp,
 236         __in                    uint32_t partn,
 237         __in_ecount(4)          uint16_t version[4]);
 238
 239 #endif  /* EFSYS_OPT_NVRAM */
 240
 241 #if EFSYS_OPT_VPD
 242
 243 extern  __checkReturn           efx_rc_t
 244 siena_vpd_init(
 245         __in                    efx_nic_t *enp);
 246
 247 extern  __checkReturn           efx_rc_t
 248 siena_vpd_size(
 249         __in                    efx_nic_t *enp,
 250         __out                   size_t *sizep);
 251
 252 extern  __checkReturn           efx_rc_t
 253 siena_vpd_read(
 254         __in                    efx_nic_t *enp,
 255         __out_bcount(size)      caddr_t data,
 256         __in                    size_t size);
 257
 258 extern  __checkReturn           efx_rc_t
 259 siena_vpd_verify(
 260         __in                    efx_nic_t *enp,
 261         __in_bcount(size)       caddr_t data,
 262         __in                    size_t size);
 263
 264 extern  __checkReturn           efx_rc_t
 265 siena_vpd_reinit(
 266         __in                    efx_nic_t *enp,
 267         __in_bcount(size)       caddr_t data,
 268         __in                    size_t size);
 269
 270 extern  __checkReturn           efx_rc_t
 271 siena_vpd_get(
 272         __in                    efx_nic_t *enp,
 273         __in_bcount(size)       caddr_t data,
 274         __in                    size_t size,
 275         __inout                 efx_vpd_value_t *evvp);
 276
 277 extern  __checkReturn           efx_rc_t
 278 siena_vpd_set(
 279         __in                    efx_nic_t *enp,
 280         __in_bcount(size)       caddr_t data,
 281         __in                    size_t size,
 282         __in                    efx_vpd_value_t *evvp);
 283
 284 extern  __checkReturn           efx_rc_t
 285 siena_vpd_next(
 286         __in                    efx_nic_t *enp,
 287         __in_bcount(size)       caddr_t data,
 288         __in                    size_t size,
 289         __out                   efx_vpd_value_t *evvp,
 290         __inout                 unsigned int *contp);
 291
 292 extern __checkReturn            efx_rc_t
 293 siena_vpd_write(
 294         __in                    efx_nic_t *enp,
 295         __in_bcount(size)       caddr_t data,
 296         __in                    size_t size);
 297
 298 extern                          void
 299 siena_vpd_fini(
 300         __in                    efx_nic_t *enp);
 301
 302 #endif  /* EFSYS_OPT_VPD */
 303
 304 typedef struct siena_link_state_s {
 305         uint32_t                sls_adv_cap_mask;
 306         uint32_t                sls_lp_cap_mask;
 307         unsigned int            sls_fcntl;
 308         efx_link_mode_t         sls_link_mode;
 309 #if EFSYS_OPT_LOOPBACK
 310         efx_loopback_type_t     sls_loopback;
 311 #endif
 312         boolean_t               sls_mac_up;
 313 } siena_link_state_t;
 314
 315 extern                  void
 316 siena_phy_link_ev(
 317         __in            efx_nic_t *enp,
 318         __in            efx_qword_t *eqp,
 319         __out           efx_link_mode_t *link_modep);
 320
 321 extern  __checkReturn   efx_rc_t
 322 siena_phy_get_link(
 323         __in            efx_nic_t *enp,
 324         __out           siena_link_state_t *slsp);
 325
 326 extern  __checkReturn   efx_rc_t
 327 siena_phy_power(
 328         __in            efx_nic_t *enp,
 329         __in            boolean_t on);
 330
 331 extern  __checkReturn   efx_rc_t
 332 siena_phy_reconfigure(
 333         __in            efx_nic_t *enp);
 334
 335 extern  __checkReturn   efx_rc_t
 336 siena_phy_verify(
 337         __in            efx_nic_t *enp);
 338
 339 extern  __checkReturn   efx_rc_t
 340 siena_phy_oui_get(
 341         __in            efx_nic_t *enp,
 342         __out           uint32_t *ouip);
 343
 344 #if EFSYS_OPT_PHY_STATS
 345
 346 extern                                          void
 347 siena_phy_decode_stats(
 348         __in                                    efx_nic_t *enp,
 349         __in                                    uint32_t vmask,
 350         __in_opt                                efsys_mem_t *esmp,
 351         __out_opt                               uint64_t *smaskp,
 352         __inout_ecount_opt(EFX_PHY_NSTATS)      uint32_t *stat);
 353
 354 extern  __checkReturn                   efx_rc_t
 355 siena_phy_stats_update(
 356         __in                            efx_nic_t *enp,
 357         __in                            efsys_mem_t *esmp,
 358         __inout_ecount(EFX_PHY_NSTATS)  uint32_t *stat);
 359
 360 #endif  /* EFSYS_OPT_PHY_STATS */
 361
 362 #if EFSYS_OPT_BIST
 363
 364 extern  __checkReturn           efx_rc_t
 365 siena_phy_bist_start(
 366         __in                    efx_nic_t *enp,
 367         __in                    efx_bist_type_t type);
 368
 369 extern  __checkReturn           efx_rc_t
 370 siena_phy_bist_poll(
 371         __in                    efx_nic_t *enp,
 372         __in                    efx_bist_type_t type,
 373         __out                   efx_bist_result_t *resultp,
 374         __out_opt __drv_when(count > 0, __notnull)
 375         uint32_t        *value_maskp,
 376         __out_ecount_opt(count) __drv_when(count > 0, __notnull)
 377         unsigned long   *valuesp,
 378         __in                    size_t count);
 379
 380 extern                          void
 381 siena_phy_bist_stop(
 382         __in                    efx_nic_t *enp,
 383         __in                    efx_bist_type_t type);
 384
 385 #endif  /* EFSYS_OPT_BIST */
 386
 387 extern  __checkReturn   efx_rc_t
 388 siena_mac_poll(
 389         __in            efx_nic_t *enp,
 390         __out           efx_link_mode_t *link_modep);
 391
 392 extern  __checkReturn   efx_rc_t
 393 siena_mac_up(
 394         __in            efx_nic_t *enp,
 395         __out           boolean_t *mac_upp);
 396
 397 extern  __checkReturn   efx_rc_t
 398 siena_mac_reconfigure(
 399         __in    efx_nic_t *enp);
 400
 401 extern  __checkReturn   efx_rc_t
 402 siena_mac_pdu_get(
 403         __in    efx_nic_t *enp,
 404         __out   size_t *pdu);
 405
 406 #if EFSYS_OPT_LOOPBACK
 407
 408 extern  __checkReturn   efx_rc_t
 409 siena_mac_loopback_set(
 410         __in            efx_nic_t *enp,
 411         __in            efx_link_mode_t link_mode,
 412         __in            efx_loopback_type_t loopback_type);
 413
 414 #endif  /* EFSYS_OPT_LOOPBACK */
 415
 416 #if EFSYS_OPT_MAC_STATS
 417
 418 extern  __checkReturn                   efx_rc_t
 419 siena_mac_stats_get_mask(
 420         __in                            efx_nic_t *enp,
 421         __inout_bcount(mask_size)       uint32_t *maskp,
 422         __in                            size_t mask_size);
 423
 424 extern  __checkReturn                   efx_rc_t
 425 siena_mac_stats_update(
 426         __in                            efx_nic_t *enp,
 427         __in                            efsys_mem_t *esmp,
 428         __inout_ecount(EFX_MAC_NSTATS)  efsys_stat_t *stat,
 429         __inout_opt                     uint32_t *generationp);
 430
 431 #endif  /* EFSYS_OPT_MAC_STATS */
 432
 433 #ifdef  __cplusplus
 434 }
 435 #endif
 436
 437 #endif  /* _SYS_SIENA_IMPL_H */