drivers/net/sfc/base/ef10_impl.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  *
   3  * Copyright (c) 2015-2018 Solarflare Communications Inc.
   4  * All rights reserved.
   5  */
   6
   7 #ifndef _SYS_EF10_IMPL_H
   8 #define _SYS_EF10_IMPL_H
   9
  10 #ifdef  __cplusplus
  11 extern "C" {
  12 #endif
  13
  14
  15 /* Number of hardware PIO buffers (for compile-time resource dimensions) */
  16 #define EF10_MAX_PIOBUF_NBUFS   (16)
  17
  18 #if EFSYS_OPT_HUNTINGTON
  19 # if (EF10_MAX_PIOBUF_NBUFS < HUNT_PIOBUF_NBUFS)
  20 #  error "EF10_MAX_PIOBUF_NBUFS too small"
  21 # endif
  22 #endif /* EFSYS_OPT_HUNTINGTON */
  23 #if EFSYS_OPT_MEDFORD
  24 # if (EF10_MAX_PIOBUF_NBUFS < MEDFORD_PIOBUF_NBUFS)
  25 #  error "EF10_MAX_PIOBUF_NBUFS too small"
  26 # endif
  27 #endif /* EFSYS_OPT_MEDFORD */
  28 #if EFSYS_OPT_MEDFORD2
  29 # if (EF10_MAX_PIOBUF_NBUFS < MEDFORD2_PIOBUF_NBUFS)
  30 #  error "EF10_MAX_PIOBUF_NBUFS too small"
  31 # endif
  32 #endif /* EFSYS_OPT_MEDFORD2 */
  33
  34
  35
  36 /*
  37  * FIXME: This is just a power of 2 which fits in an MCDI v1 message, and could
  38  * possibly be increased, or the write size reported by newer firmware used
  39  * instead.
  40  */
  41 #define EF10_NVRAM_CHUNK 0x80
  42
  43 /*
  44  * Alignment requirement for value written to RX WPTR: the WPTR must be aligned
  45  * to an 8 descriptor boundary.
  46  */
  47 #define EF10_RX_WPTR_ALIGN 8
  48
  49 /*
  50  * Max byte offset into the packet the TCP header must start for the hardware
  51  * to be able to parse the packet correctly.
  52  */
  53 #define EF10_TCP_HEADER_OFFSET_LIMIT    208
  54
  55 /* Invalid RSS context handle */
  56 #define EF10_RSS_CONTEXT_INVALID        (0xffffffff)
  57
  58
  59 /* EV */
  60
  61         __checkReturn   efx_rc_t
  62 ef10_ev_init(
  63         __in            efx_nic_t *enp);
  64
  65                         void
  66 ef10_ev_fini(
  67         __in            efx_nic_t *enp);
  68
  69         __checkReturn   efx_rc_t
  70 ef10_ev_qcreate(
  71         __in            efx_nic_t *enp,
  72         __in            unsigned int index,
  73         __in            efsys_mem_t *esmp,
  74         __in            size_t ndescs,
  75         __in            uint32_t id,
  76         __in            uint32_t us,
  77         __in            uint32_t flags,
  78         __in            efx_evq_t *eep);
  79
  80                         void
  81 ef10_ev_qdestroy(
  82         __in            efx_evq_t *eep);
  83
  84         __checkReturn   efx_rc_t
  85 ef10_ev_qprime(
  86         __in            efx_evq_t *eep,
  87         __in            unsigned int count);
  88
  89                         void
  90 ef10_ev_qpost(
  91         __in    efx_evq_t *eep,
  92         __in    uint16_t data);
  93
  94         __checkReturn   efx_rc_t
  95 ef10_ev_qmoderate(
  96         __in            efx_evq_t *eep,
  97         __in            unsigned int us);
  98
  99 #if EFSYS_OPT_QSTATS
 100                         void
 101 ef10_ev_qstats_update(
 102         __in                            efx_evq_t *eep,
 103         __inout_ecount(EV_NQSTATS)      efsys_stat_t *stat);
 104 #endif /* EFSYS_OPT_QSTATS */
 105
 106                 void
 107 ef10_ev_rxlabel_init(
 108         __in            efx_evq_t *eep,
 109         __in            efx_rxq_t *erp,
 110         __in            unsigned int label,
 111         __in            efx_rxq_type_t type);
 112
 113                 void
 114 ef10_ev_rxlabel_fini(
 115         __in            efx_evq_t *eep,
 116         __in            unsigned int label);
 117
 118 /* INTR */
 119
 120         __checkReturn   efx_rc_t
 121 ef10_intr_init(
 122         __in            efx_nic_t *enp,
 123         __in            efx_intr_type_t type,
 124         __in            efsys_mem_t *esmp);
 125
 126                         void
 127 ef10_intr_enable(
 128         __in            efx_nic_t *enp);
 129
 130                         void
 131 ef10_intr_disable(
 132         __in            efx_nic_t *enp);
 133
 134                         void
 135 ef10_intr_disable_unlocked(
 136         __in            efx_nic_t *enp);
 137
 138         __checkReturn   efx_rc_t
 139 ef10_intr_trigger(
 140         __in            efx_nic_t *enp,
 141         __in            unsigned int level);
 142
 143                         void
 144 ef10_intr_status_line(
 145         __in            efx_nic_t *enp,
 146         __out           boolean_t *fatalp,
 147         __out           uint32_t *qmaskp);
 148
 149                         void
 150 ef10_intr_status_message(
 151         __in            efx_nic_t *enp,
 152         __in            unsigned int message,
 153         __out           boolean_t *fatalp);
 154
 155                         void
 156 ef10_intr_fatal(
 157         __in            efx_nic_t *enp);
 158                         void
 159 ef10_intr_fini(
 160         __in            efx_nic_t *enp);
 161
 162 /* NIC */
 163
 164 extern  __checkReturn   efx_rc_t
 165 ef10_nic_probe(
 166         __in            efx_nic_t *enp);
 167
 168 extern  __checkReturn   efx_rc_t
 169 ef10_nic_set_drv_limits(
 170         __inout         efx_nic_t *enp,
 171         __in            efx_drv_limits_t *edlp);
 172
 173 extern  __checkReturn   efx_rc_t
 174 ef10_nic_get_vi_pool(
 175         __in            efx_nic_t *enp,
 176         __out           uint32_t *vi_countp);
 177
 178 extern  __checkReturn   efx_rc_t
 179 ef10_nic_get_bar_region(
 180         __in            efx_nic_t *enp,
 181         __in            efx_nic_region_t region,
 182         __out           uint32_t *offsetp,
 183         __out           size_t *sizep);
 184
 185 extern  __checkReturn   efx_rc_t
 186 ef10_nic_reset(
 187         __in            efx_nic_t *enp);
 188
 189 extern  __checkReturn   efx_rc_t
 190 ef10_nic_init(
 191         __in            efx_nic_t *enp);
 192
 193 extern  __checkReturn   boolean_t
 194 ef10_nic_hw_unavailable(
 195         __in            efx_nic_t *enp);
 196
 197 extern                  void
 198 ef10_nic_set_hw_unavailable(
 199         __in            efx_nic_t *enp);
 200
 201 #if EFSYS_OPT_DIAG
 202
 203 extern  __checkReturn   efx_rc_t
 204 ef10_nic_register_test(
 205         __in            efx_nic_t *enp);
 206
 207 #endif  /* EFSYS_OPT_DIAG */
 208
 209 extern                  void
 210 ef10_nic_fini(
 211         __in            efx_nic_t *enp);
 212
 213 extern                  void
 214 ef10_nic_unprobe(
 215         __in            efx_nic_t *enp);
 216
 217
 218 /* MAC */
 219
 220 extern  __checkReturn   efx_rc_t
 221 ef10_mac_poll(
 222         __in            efx_nic_t *enp,
 223         __out           efx_link_mode_t *link_modep);
 224
 225 extern  __checkReturn   efx_rc_t
 226 ef10_mac_up(
 227         __in            efx_nic_t *enp,
 228         __out           boolean_t *mac_upp);
 229
 230 extern  __checkReturn   efx_rc_t
 231 ef10_mac_addr_set(
 232         __in    efx_nic_t *enp);
 233
 234 extern  __checkReturn   efx_rc_t
 235 ef10_mac_pdu_set(
 236         __in    efx_nic_t *enp);
 237
 238 extern  __checkReturn   efx_rc_t
 239 ef10_mac_pdu_get(
 240         __in    efx_nic_t *enp,
 241         __out   size_t *pdu);
 242
 243 extern  __checkReturn   efx_rc_t
 244 ef10_mac_reconfigure(
 245         __in    efx_nic_t *enp);
 246
 247 extern  __checkReturn   efx_rc_t
 248 ef10_mac_multicast_list_set(
 249         __in                            efx_nic_t *enp);
 250
 251 extern  __checkReturn   efx_rc_t
 252 ef10_mac_filter_default_rxq_set(
 253         __in            efx_nic_t *enp,
 254         __in            efx_rxq_t *erp,
 255         __in            boolean_t using_rss);
 256
 257 extern                  void
 258 ef10_mac_filter_default_rxq_clear(
 259         __in            efx_nic_t *enp);
 260
 261 #if EFSYS_OPT_LOOPBACK
 262
 263 extern  __checkReturn   efx_rc_t
 264 ef10_mac_loopback_set(
 265         __in            efx_nic_t *enp,
 266         __in            efx_link_mode_t link_mode,
 267         __in            efx_loopback_type_t loopback_type);
 268
 269 #endif  /* EFSYS_OPT_LOOPBACK */
 270
 271 #if EFSYS_OPT_MAC_STATS
 272
 273 extern  __checkReturn                   efx_rc_t
 274 ef10_mac_stats_get_mask(
 275         __in                            efx_nic_t *enp,
 276         __inout_bcount(mask_size)       uint32_t *maskp,
 277         __in                            size_t mask_size);
 278
 279 extern  __checkReturn                   efx_rc_t
 280 ef10_mac_stats_update(
 281         __in                            efx_nic_t *enp,
 282         __in                            efsys_mem_t *esmp,
 283         __inout_ecount(EFX_MAC_NSTATS)  efsys_stat_t *stat,
 284         __inout_opt                     uint32_t *generationp);
 285
 286 #endif  /* EFSYS_OPT_MAC_STATS */
 287
 288
 289 /* MCDI */
 290
 291 #if EFSYS_OPT_MCDI
 292
 293 extern  __checkReturn   efx_rc_t
 294 ef10_mcdi_init(
 295         __in            efx_nic_t *enp,
 296         __in            const efx_mcdi_transport_t *mtp);
 297
 298 extern                  void
 299 ef10_mcdi_fini(
 300         __in            efx_nic_t *enp);
 301
 302 extern                  void
 303 ef10_mcdi_send_request(
 304         __in                    efx_nic_t *enp,
 305         __in_bcount(hdr_len)    void *hdrp,
 306         __in                    size_t hdr_len,
 307         __in_bcount(sdu_len)    void *sdup,
 308         __in                    size_t sdu_len);
 309
 310 extern  __checkReturn   boolean_t
 311 ef10_mcdi_poll_response(
 312         __in            efx_nic_t *enp);
 313
 314 extern                  void
 315 ef10_mcdi_read_response(
 316         __in                    efx_nic_t *enp,
 317         __out_bcount(length)    void *bufferp,
 318         __in                    size_t offset,
 319         __in                    size_t length);
 320
 321 extern                  efx_rc_t
 322 ef10_mcdi_poll_reboot(
 323         __in            efx_nic_t *enp);
 324
 325 extern  __checkReturn   efx_rc_t
 326 ef10_mcdi_feature_supported(
 327         __in            efx_nic_t *enp,
 328         __in            efx_mcdi_feature_id_t id,
 329         __out           boolean_t *supportedp);
 330
 331 extern                  void
 332 ef10_mcdi_get_timeout(
 333         __in            efx_nic_t *enp,
 334         __in            efx_mcdi_req_t *emrp,
 335         __out           uint32_t *timeoutp);
 336
 337 #endif /* EFSYS_OPT_MCDI */
 338
 339 /* NVRAM */
 340
 341 #if EFSYS_OPT_NVRAM || EFSYS_OPT_VPD
 342
 343 extern  __checkReturn           efx_rc_t
 344 ef10_nvram_buf_read_tlv(
 345         __in                            efx_nic_t *enp,
 346         __in_bcount(max_seg_size)       caddr_t seg_data,
 347         __in                            size_t max_seg_size,
 348         __in                            uint32_t tag,
 349         __deref_out_bcount_opt(*sizep)  caddr_t *datap,
 350         __out                           size_t *sizep);
 351
 352 extern  __checkReturn           efx_rc_t
 353 ef10_nvram_buf_write_tlv(
 354         __inout_bcount(partn_size)      caddr_t partn_data,
 355         __in                            size_t partn_size,
 356         __in                            uint32_t tag,
 357         __in_bcount(tag_size)           caddr_t tag_data,
 358         __in                            size_t tag_size,
 359         __out                           size_t *total_lengthp);
 360
 361 extern  __checkReturn           efx_rc_t
 362 ef10_nvram_partn_read_tlv(
 363         __in                            efx_nic_t *enp,
 364         __in                            uint32_t partn,
 365         __in                            uint32_t tag,
 366         __deref_out_bcount_opt(*sizep)  caddr_t *datap,
 367         __out                           size_t *sizep);
 368
 369 extern  __checkReturn           efx_rc_t
 370 ef10_nvram_partn_write_tlv(
 371         __in                    efx_nic_t *enp,
 372         __in                    uint32_t partn,
 373         __in                    uint32_t tag,
 374         __in_bcount(size)       caddr_t data,
 375         __in                    size_t size);
 376
 377 extern  __checkReturn           efx_rc_t
 378 ef10_nvram_partn_write_segment_tlv(
 379         __in                    efx_nic_t *enp,
 380         __in                    uint32_t partn,
 381         __in                    uint32_t tag,
 382         __in_bcount(size)       caddr_t data,
 383         __in                    size_t size,
 384         __in                    boolean_t all_segments);
 385
 386 extern  __checkReturn           efx_rc_t
 387 ef10_nvram_partn_lock(
 388         __in                    efx_nic_t *enp,
 389         __in                    uint32_t partn);
 390
 391 extern  __checkReturn           efx_rc_t
 392 ef10_nvram_partn_unlock(
 393         __in                    efx_nic_t *enp,
 394         __in                    uint32_t partn,
 395         __out_opt               uint32_t *resultp);
 396
 397 #endif /* EFSYS_OPT_NVRAM || EFSYS_OPT_VPD */
 398
 399 #if EFSYS_OPT_NVRAM
 400
 401 #if EFSYS_OPT_DIAG
 402
 403 extern  __checkReturn           efx_rc_t
 404 ef10_nvram_test(
 405         __in                    efx_nic_t *enp);
 406
 407 #endif  /* EFSYS_OPT_DIAG */
 408
 409 extern  __checkReturn           efx_rc_t
 410 ef10_nvram_type_to_partn(
 411         __in                    efx_nic_t *enp,
 412         __in                    efx_nvram_type_t type,
 413         __out                   uint32_t *partnp);
 414
 415 extern  __checkReturn           efx_rc_t
 416 ef10_nvram_partn_size(
 417         __in                    efx_nic_t *enp,
 418         __in                    uint32_t partn,
 419         __out                   size_t *sizep);
 420
 421 extern  __checkReturn           efx_rc_t
 422 ef10_nvram_partn_rw_start(
 423         __in                    efx_nic_t *enp,
 424         __in                    uint32_t partn,
 425         __out                   size_t *chunk_sizep);
 426
 427 extern  __checkReturn           efx_rc_t
 428 ef10_nvram_partn_read_mode(
 429         __in                    efx_nic_t *enp,
 430         __in                    uint32_t partn,
 431         __in                    unsigned int offset,
 432         __out_bcount(size)      caddr_t data,
 433         __in                    size_t size,
 434         __in                    uint32_t mode);
 435
 436 extern  __checkReturn           efx_rc_t
 437 ef10_nvram_partn_read(
 438         __in                    efx_nic_t *enp,
 439         __in                    uint32_t partn,
 440         __in                    unsigned int offset,
 441         __out_bcount(size)      caddr_t data,
 442         __in                    size_t size);
 443
 444 extern  __checkReturn           efx_rc_t
 445 ef10_nvram_partn_read_backup(
 446         __in                    efx_nic_t *enp,
 447         __in                    uint32_t partn,
 448         __in                    unsigned int offset,
 449         __out_bcount(size)      caddr_t data,
 450         __in                    size_t size);
 451
 452 extern  __checkReturn           efx_rc_t
 453 ef10_nvram_partn_erase(
 454         __in                    efx_nic_t *enp,
 455         __in                    uint32_t partn,
 456         __in                    unsigned int offset,
 457         __in                    size_t size);
 458
 459 extern  __checkReturn           efx_rc_t
 460 ef10_nvram_partn_write(
 461         __in                    efx_nic_t *enp,
 462         __in                    uint32_t partn,
 463         __in                    unsigned int offset,
 464         __in_bcount(size)       caddr_t data,
 465         __in                    size_t size);
 466
 467 extern  __checkReturn           efx_rc_t
 468 ef10_nvram_partn_rw_finish(
 469         __in                    efx_nic_t *enp,
 470         __in                    uint32_t partn,
 471         __out_opt               uint32_t *verify_resultp);
 472
 473 extern  __checkReturn           efx_rc_t
 474 ef10_nvram_partn_get_version(
 475         __in                    efx_nic_t *enp,
 476         __in                    uint32_t partn,
 477         __out                   uint32_t *subtypep,
 478         __out_ecount(4)         uint16_t version[4]);
 479
 480 extern  __checkReturn           efx_rc_t
 481 ef10_nvram_partn_set_version(
 482         __in                    efx_nic_t *enp,
 483         __in                    uint32_t partn,
 484         __in_ecount(4)          uint16_t version[4]);
 485
 486 extern  __checkReturn           efx_rc_t
 487 ef10_nvram_buffer_validate(
 488         __in                    uint32_t partn,
 489         __in_bcount(buffer_size)
 490                                 caddr_t bufferp,
 491         __in                    size_t buffer_size);
 492
 493 extern                  void
 494 ef10_nvram_buffer_init(
 495         __out_bcount(buffer_size)
 496                                 caddr_t bufferp,
 497         __in                    size_t buffer_size);
 498
 499 extern  __checkReturn           efx_rc_t
 500 ef10_nvram_buffer_create(
 501         __in                    uint32_t partn_type,
 502         __out_bcount(buffer_size)
 503                                 caddr_t bufferp,
 504         __in                    size_t buffer_size);
 505
 506 extern  __checkReturn           efx_rc_t
 507 ef10_nvram_buffer_find_item_start(
 508         __in_bcount(buffer_size)
 509                                 caddr_t bufferp,
 510         __in                    size_t buffer_size,
 511         __out                   uint32_t *startp);
 512
 513 extern  __checkReturn           efx_rc_t
 514 ef10_nvram_buffer_find_end(
 515         __in_bcount(buffer_size)
 516                                 caddr_t bufferp,
 517         __in                    size_t buffer_size,
 518         __in                    uint32_t offset,
 519         __out                   uint32_t *endp);
 520
 521 extern  __checkReturn   __success(return != B_FALSE)    boolean_t
 522 ef10_nvram_buffer_find_item(
 523         __in_bcount(buffer_size)
 524                                 caddr_t bufferp,
 525         __in                    size_t buffer_size,
 526         __in                    uint32_t offset,
 527         __out                   uint32_t *startp,
 528         __out                   uint32_t *lengthp);
 529
 530 extern  __checkReturn           efx_rc_t
 531 ef10_nvram_buffer_peek_item(
 532         __in_bcount(buffer_size)
 533                                 caddr_t bufferp,
 534         __in                    size_t buffer_size,
 535         __in                    uint32_t offset,
 536         __out                   uint32_t *tagp,
 537         __out                   uint32_t *lengthp,
 538         __out                   uint32_t *value_offsetp);
 539
 540 extern  __checkReturn           efx_rc_t
 541 ef10_nvram_buffer_get_item(
 542         __in_bcount(buffer_size)
 543                                 caddr_t bufferp,
 544         __in                    size_t buffer_size,
 545         __in                    uint32_t offset,
 546         __in                    uint32_t length,
 547         __out                   uint32_t *tagp,
 548         __out_bcount_part(value_max_size, *lengthp)
 549                                 caddr_t valuep,
 550         __in                    size_t value_max_size,
 551         __out                   uint32_t *lengthp);
 552
 553 extern  __checkReturn           efx_rc_t
 554 ef10_nvram_buffer_insert_item(
 555         __in_bcount(buffer_size)
 556                                 caddr_t bufferp,
 557         __in                    size_t buffer_size,
 558         __in                    uint32_t offset,
 559         __in                    uint32_t tag,
 560         __in_bcount(length)     caddr_t valuep,
 561         __in                    uint32_t length,
 562         __out                   uint32_t *lengthp);
 563
 564 extern  __checkReturn           efx_rc_t
 565 ef10_nvram_buffer_modify_item(
 566         __in_bcount(buffer_size)
 567                                 caddr_t bufferp,
 568         __in                    size_t buffer_size,
 569         __in                    uint32_t offset,
 570         __in                    uint32_t tag,
 571         __in_bcount(length)     caddr_t valuep,
 572         __in                    uint32_t length,
 573         __out                   uint32_t *lengthp);
 574
 575 extern  __checkReturn           efx_rc_t
 576 ef10_nvram_buffer_delete_item(
 577         __in_bcount(buffer_size)
 578                                 caddr_t bufferp,
 579         __in                    size_t buffer_size,
 580         __in                    uint32_t offset,
 581         __in                    uint32_t length,
 582         __in                    uint32_t end);
 583
 584 extern  __checkReturn           efx_rc_t
 585 ef10_nvram_buffer_finish(
 586         __in_bcount(buffer_size)
 587                                 caddr_t bufferp,
 588         __in                    size_t buffer_size);
 589
 590 #endif  /* EFSYS_OPT_NVRAM */
 591
 592
 593 /* PHY */
 594
 595 typedef struct ef10_link_state_s {
 596         uint32_t                els_adv_cap_mask;
 597         uint32_t                els_lp_cap_mask;
 598         unsigned int            els_fcntl;
 599         efx_phy_fec_type_t      els_fec;
 600         efx_link_mode_t         els_link_mode;
 601 #if EFSYS_OPT_LOOPBACK
 602         efx_loopback_type_t     els_loopback;
 603 #endif
 604         boolean_t               els_mac_up;
 605 } ef10_link_state_t;
 606
 607 extern                  void
 608 ef10_phy_link_ev(
 609         __in            efx_nic_t *enp,
 610         __in            efx_qword_t *eqp,
 611         __out           efx_link_mode_t *link_modep);
 612
 613 extern  __checkReturn   efx_rc_t
 614 ef10_phy_get_link(
 615         __in            efx_nic_t *enp,
 616         __out           ef10_link_state_t *elsp);
 617
 618 extern  __checkReturn   efx_rc_t
 619 ef10_phy_power(
 620         __in            efx_nic_t *enp,
 621         __in            boolean_t on);
 622
 623 extern  __checkReturn   efx_rc_t
 624 ef10_phy_reconfigure(
 625         __in            efx_nic_t *enp);
 626
 627 extern  __checkReturn   efx_rc_t
 628 ef10_phy_verify(
 629         __in            efx_nic_t *enp);
 630
 631 extern  __checkReturn   efx_rc_t
 632 ef10_phy_oui_get(
 633         __in            efx_nic_t *enp,
 634         __out           uint32_t *ouip);
 635
 636 extern  __checkReturn   efx_rc_t
 637 ef10_phy_fec_type_get(
 638         __in            efx_nic_t *enp,
 639         __out           efx_phy_fec_type_t *fecp);
 640
 641 #if EFSYS_OPT_PHY_STATS
 642
 643 extern  __checkReturn                   efx_rc_t
 644 ef10_phy_stats_update(
 645         __in                            efx_nic_t *enp,
 646         __in                            efsys_mem_t *esmp,
 647         __inout_ecount(EFX_PHY_NSTATS)  uint32_t *stat);
 648
 649 #endif  /* EFSYS_OPT_PHY_STATS */
 650
 651 #if EFSYS_OPT_BIST
 652
 653 extern  __checkReturn           efx_rc_t
 654 ef10_bist_enable_offline(
 655         __in                    efx_nic_t *enp);
 656
 657 extern  __checkReturn           efx_rc_t
 658 ef10_bist_start(
 659         __in                    efx_nic_t *enp,
 660         __in                    efx_bist_type_t type);
 661
 662 extern  __checkReturn           efx_rc_t
 663 ef10_bist_poll(
 664         __in                    efx_nic_t *enp,
 665         __in                    efx_bist_type_t type,
 666         __out                   efx_bist_result_t *resultp,
 667         __out_opt __drv_when(count > 0, __notnull)
 668         uint32_t        *value_maskp,
 669         __out_ecount_opt(count) __drv_when(count > 0, __notnull)
 670         unsigned long   *valuesp,
 671         __in                    size_t count);
 672
 673 extern                          void
 674 ef10_bist_stop(
 675         __in                    efx_nic_t *enp,
 676         __in                    efx_bist_type_t type);
 677
 678 #endif  /* EFSYS_OPT_BIST */
 679
 680 /* TX */
 681
 682 extern  __checkReturn   efx_rc_t
 683 ef10_tx_init(
 684         __in            efx_nic_t *enp);
 685
 686 extern                  void
 687 ef10_tx_fini(
 688         __in            efx_nic_t *enp);
 689
 690 extern  __checkReturn   efx_rc_t
 691 ef10_tx_qcreate(
 692         __in            efx_nic_t *enp,
 693         __in            unsigned int index,
 694         __in            unsigned int label,
 695         __in            efsys_mem_t *esmp,
 696         __in            size_t ndescs,
 697         __in            uint32_t id,
 698         __in            uint16_t flags,
 699         __in            efx_evq_t *eep,
 700         __in            efx_txq_t *etp,
 701         __out           unsigned int *addedp);
 702
 703 extern          void
 704 ef10_tx_qdestroy(
 705         __in            efx_txq_t *etp);
 706
 707 extern  __checkReturn           efx_rc_t
 708 ef10_tx_qpost(
 709         __in                    efx_txq_t *etp,
 710         __in_ecount(ndescs)     efx_buffer_t *ebp,
 711         __in                    unsigned int ndescs,
 712         __in                    unsigned int completed,
 713         __inout                 unsigned int *addedp);
 714
 715 extern                  void
 716 ef10_tx_qpush(
 717         __in            efx_txq_t *etp,
 718         __in            unsigned int added,
 719         __in            unsigned int pushed);
 720
 721 #if EFSYS_OPT_RX_PACKED_STREAM
 722 extern                  void
 723 ef10_rx_qpush_ps_credits(
 724         __in            efx_rxq_t *erp);
 725
 726 extern  __checkReturn   uint8_t *
 727 ef10_rx_qps_packet_info(
 728         __in            efx_rxq_t *erp,
 729         __in            uint8_t *buffer,
 730         __in            uint32_t buffer_length,
 731         __in            uint32_t current_offset,
 732         __out           uint16_t *lengthp,
 733         __out           uint32_t *next_offsetp,
 734         __out           uint32_t *timestamp);
 735 #endif
 736
 737 extern  __checkReturn   efx_rc_t
 738 ef10_tx_qpace(
 739         __in            efx_txq_t *etp,
 740         __in            unsigned int ns);
 741
 742 extern  __checkReturn   efx_rc_t
 743 ef10_tx_qflush(
 744         __in            efx_txq_t *etp);
 745
 746 extern                  void
 747 ef10_tx_qenable(
 748         __in            efx_txq_t *etp);
 749
 750 extern  __checkReturn   efx_rc_t
 751 ef10_tx_qpio_enable(
 752         __in            efx_txq_t *etp);
 753
 754 extern                  void
 755 ef10_tx_qpio_disable(
 756         __in            efx_txq_t *etp);
 757
 758 extern  __checkReturn   efx_rc_t
 759 ef10_tx_qpio_write(
 760         __in                    efx_txq_t *etp,
 761         __in_ecount(buf_length) uint8_t *buffer,
 762         __in                    size_t buf_length,
 763         __in                    size_t pio_buf_offset);
 764
 765 extern  __checkReturn   efx_rc_t
 766 ef10_tx_qpio_post(
 767         __in                    efx_txq_t *etp,
 768         __in                    size_t pkt_length,
 769         __in                    unsigned int completed,
 770         __inout                 unsigned int *addedp);
 771
 772 extern  __checkReturn   efx_rc_t
 773 ef10_tx_qdesc_post(
 774         __in            efx_txq_t *etp,
 775         __in_ecount(n)  efx_desc_t *ed,
 776         __in            unsigned int n,
 777         __in            unsigned int completed,
 778         __inout         unsigned int *addedp);
 779
 780 extern  void
 781 ef10_tx_qdesc_dma_create(
 782         __in    efx_txq_t *etp,
 783         __in    efsys_dma_addr_t addr,
 784         __in    size_t size,
 785         __in    boolean_t eop,
 786         __out   efx_desc_t *edp);
 787
 788 extern  void
 789 ef10_tx_qdesc_tso_create(
 790         __in    efx_txq_t *etp,
 791         __in    uint16_t ipv4_id,
 792         __in    uint32_t tcp_seq,
 793         __in    uint8_t  tcp_flags,
 794         __out   efx_desc_t *edp);
 795
 796 extern  void
 797 ef10_tx_qdesc_tso2_create(
 798         __in                    efx_txq_t *etp,
 799         __in                    uint16_t ipv4_id,
 800         __in                    uint16_t outer_ipv4_id,
 801         __in                    uint32_t tcp_seq,
 802         __in                    uint16_t tcp_mss,
 803         __out_ecount(count)     efx_desc_t *edp,
 804         __in                    int count);
 805
 806 extern  void
 807 ef10_tx_qdesc_vlantci_create(
 808         __in    efx_txq_t *etp,
 809         __in    uint16_t vlan_tci,
 810         __out   efx_desc_t *edp);
 811
 812 extern  void
 813 ef10_tx_qdesc_checksum_create(
 814         __in    efx_txq_t *etp,
 815         __in    uint16_t flags,
 816         __out   efx_desc_t *edp);
 817
 818 #if EFSYS_OPT_QSTATS
 819
 820 extern                  void
 821 ef10_tx_qstats_update(
 822         __in                            efx_txq_t *etp,
 823         __inout_ecount(TX_NQSTATS)      efsys_stat_t *stat);
 824
 825 #endif /* EFSYS_OPT_QSTATS */
 826
 827 typedef uint32_t        efx_piobuf_handle_t;
 828
 829 #define EFX_PIOBUF_HANDLE_INVALID       ((efx_piobuf_handle_t)-1)
 830
 831 extern  __checkReturn   efx_rc_t
 832 ef10_nic_pio_alloc(
 833         __inout         efx_nic_t *enp,
 834         __out           uint32_t *bufnump,
 835         __out           efx_piobuf_handle_t *handlep,
 836         __out           uint32_t *blknump,
 837         __out           uint32_t *offsetp,
 838         __out           size_t *sizep);
 839
 840 extern  __checkReturn   efx_rc_t
 841 ef10_nic_pio_free(
 842         __inout         efx_nic_t *enp,
 843         __in            uint32_t bufnum,
 844         __in            uint32_t blknum);
 845
 846 extern  __checkReturn   efx_rc_t
 847 ef10_nic_pio_link(
 848         __inout         efx_nic_t *enp,
 849         __in            uint32_t vi_index,
 850         __in            efx_piobuf_handle_t handle);
 851
 852 extern  __checkReturn   efx_rc_t
 853 ef10_nic_pio_unlink(
 854         __inout         efx_nic_t *enp,
 855         __in            uint32_t vi_index);
 856
 857
 858 /* VPD */
 859
 860 #if EFSYS_OPT_VPD
 861
 862 extern  __checkReturn           efx_rc_t
 863 ef10_vpd_init(
 864         __in                    efx_nic_t *enp);
 865
 866 extern  __checkReturn           efx_rc_t
 867 ef10_vpd_size(
 868         __in                    efx_nic_t *enp,
 869         __out                   size_t *sizep);
 870
 871 extern  __checkReturn           efx_rc_t
 872 ef10_vpd_read(
 873         __in                    efx_nic_t *enp,
 874         __out_bcount(size)      caddr_t data,
 875         __in                    size_t size);
 876
 877 extern  __checkReturn           efx_rc_t
 878 ef10_vpd_verify(
 879         __in                    efx_nic_t *enp,
 880         __in_bcount(size)       caddr_t data,
 881         __in                    size_t size);
 882
 883 extern  __checkReturn           efx_rc_t
 884 ef10_vpd_reinit(
 885         __in                    efx_nic_t *enp,
 886         __in_bcount(size)       caddr_t data,
 887         __in                    size_t size);
 888
 889 extern  __checkReturn           efx_rc_t
 890 ef10_vpd_get(
 891         __in                    efx_nic_t *enp,
 892         __in_bcount(size)       caddr_t data,
 893         __in                    size_t size,
 894         __inout                 efx_vpd_value_t *evvp);
 895
 896 extern  __checkReturn           efx_rc_t
 897 ef10_vpd_set(
 898         __in                    efx_nic_t *enp,
 899         __in_bcount(size)       caddr_t data,
 900         __in                    size_t size,
 901         __in                    efx_vpd_value_t *evvp);
 902
 903 extern  __checkReturn           efx_rc_t
 904 ef10_vpd_next(
 905         __in                    efx_nic_t *enp,
 906         __in_bcount(size)       caddr_t data,
 907         __in                    size_t size,
 908         __out                   efx_vpd_value_t *evvp,
 909         __inout                 unsigned int *contp);
 910
 911 extern __checkReturn            efx_rc_t
 912 ef10_vpd_write(
 913         __in                    efx_nic_t *enp,
 914         __in_bcount(size)       caddr_t data,
 915         __in                    size_t size);
 916
 917 extern                          void
 918 ef10_vpd_fini(
 919         __in                    efx_nic_t *enp);
 920
 921 #endif  /* EFSYS_OPT_VPD */
 922
 923
 924 /* RX */
 925
 926 extern  __checkReturn   efx_rc_t
 927 ef10_rx_init(
 928         __in            efx_nic_t *enp);
 929
 930 #if EFSYS_OPT_RX_SCATTER
 931 extern  __checkReturn   efx_rc_t
 932 ef10_rx_scatter_enable(
 933         __in            efx_nic_t *enp,
 934         __in            unsigned int buf_size);
 935 #endif  /* EFSYS_OPT_RX_SCATTER */
 936
 937
 938 #if EFSYS_OPT_RX_SCALE
 939
 940 extern  __checkReturn   efx_rc_t
 941 ef10_rx_scale_context_alloc(
 942         __in            efx_nic_t *enp,
 943         __in            efx_rx_scale_context_type_t type,
 944         __in            uint32_t num_queues,
 945         __out           uint32_t *rss_contextp);
 946
 947 extern  __checkReturn   efx_rc_t
 948 ef10_rx_scale_context_free(
 949         __in            efx_nic_t *enp,
 950         __in            uint32_t rss_context);
 951
 952 extern  __checkReturn   efx_rc_t
 953 ef10_rx_scale_mode_set(
 954         __in            efx_nic_t *enp,
 955         __in            uint32_t rss_context,
 956         __in            efx_rx_hash_alg_t alg,
 957         __in            efx_rx_hash_type_t type,
 958         __in            boolean_t insert);
 959
 960 extern  __checkReturn   efx_rc_t
 961 ef10_rx_scale_key_set(
 962         __in            efx_nic_t *enp,
 963         __in            uint32_t rss_context,
 964         __in_ecount(n)  uint8_t *key,
 965         __in            size_t n);
 966
 967 extern  __checkReturn   efx_rc_t
 968 ef10_rx_scale_tbl_set(
 969         __in            efx_nic_t *enp,
 970         __in            uint32_t rss_context,
 971         __in_ecount(n)  unsigned int *table,
 972         __in            size_t n);
 973
 974 extern  __checkReturn   uint32_t
 975 ef10_rx_prefix_hash(
 976         __in            efx_nic_t *enp,
 977         __in            efx_rx_hash_alg_t func,
 978         __in            uint8_t *buffer);
 979
 980 #endif /* EFSYS_OPT_RX_SCALE */
 981
 982 extern  __checkReturn   efx_rc_t
 983 ef10_rx_prefix_pktlen(
 984         __in            efx_nic_t *enp,
 985         __in            uint8_t *buffer,
 986         __out           uint16_t *lengthp);
 987
 988 extern                          void
 989 ef10_rx_qpost(
 990         __in                    efx_rxq_t *erp,
 991         __in_ecount(ndescs)     efsys_dma_addr_t *addrp,
 992         __in                    size_t size,
 993         __in                    unsigned int ndescs,
 994         __in                    unsigned int completed,
 995         __in                    unsigned int added);
 996
 997 extern                  void
 998 ef10_rx_qpush(
 999         __in            efx_rxq_t *erp,
1000         __in            unsigned int added,
1001         __inout         unsigned int *pushedp);
1002
1003 extern  __checkReturn   efx_rc_t
1004 ef10_rx_qflush(
1005         __in            efx_rxq_t *erp);
1006
1007 extern          void
1008 ef10_rx_qenable(
1009         __in            efx_rxq_t *erp);
1010
1011 union efx_rxq_type_data_u;
1012
1013 extern  __checkReturn   efx_rc_t
1014 ef10_rx_qcreate(
1015         __in            efx_nic_t *enp,
1016         __in            unsigned int index,
1017         __in            unsigned int label,
1018         __in            efx_rxq_type_t type,
1019         __in            const union efx_rxq_type_data_u *type_data,
1020         __in            efsys_mem_t *esmp,
1021         __in            size_t ndescs,
1022         __in            uint32_t id,
1023         __in            unsigned int flags,
1024         __in            efx_evq_t *eep,
1025         __in            efx_rxq_t *erp);
1026
1027 extern                  void
1028 ef10_rx_qdestroy(
1029         __in            efx_rxq_t *erp);
1030
1031 extern                  void
1032 ef10_rx_fini(
1033         __in            efx_nic_t *enp);
1034
1035 #if EFSYS_OPT_FILTER
1036
1037 typedef struct ef10_filter_handle_s {
1038         uint32_t        efh_lo;
1039         uint32_t        efh_hi;
1040 } ef10_filter_handle_t;
1041
1042 typedef struct ef10_filter_entry_s {
1043         uintptr_t efe_spec; /* pointer to filter spec plus busy bit */
1044         ef10_filter_handle_t efe_handle;
1045 } ef10_filter_entry_t;
1046
1047 /*
1048  * BUSY flag indicates that an update is in progress.
1049  * AUTO_OLD flag is used to mark and sweep MAC packet filters.
1050  */
1051 #define EFX_EF10_FILTER_FLAG_BUSY       1U
1052 #define EFX_EF10_FILTER_FLAG_AUTO_OLD   2U
1053 #define EFX_EF10_FILTER_FLAGS           3U
1054
1055 /*
1056  * Size of the hash table used by the driver. Doesn't need to be the
1057  * same size as the hardware's table.
1058  */
1059 #define EFX_EF10_FILTER_TBL_ROWS 8192
1060
1061 /* Only need to allow for one directed and one unknown unicast filter */
1062 #define EFX_EF10_FILTER_UNICAST_FILTERS_MAX     2
1063
1064 /* Allow for the broadcast address to be added to the multicast list */
1065 #define EFX_EF10_FILTER_MULTICAST_FILTERS_MAX   (EFX_MAC_MULTICAST_LIST_MAX + 1)
1066
1067 /*
1068  * For encapsulated packets, there is one filter each for each combination of
1069  * IPv4 or IPv6 outer frame, VXLAN, GENEVE or NVGRE packet type, and unicast or
1070  * multicast inner frames.
1071  */
1072 #define EFX_EF10_FILTER_ENCAP_FILTERS_MAX       12
1073
1074 typedef struct ef10_filter_table_s {
1075         ef10_filter_entry_t     eft_entry[EFX_EF10_FILTER_TBL_ROWS];
1076         efx_rxq_t               *eft_default_rxq;
1077         boolean_t               eft_using_rss;
1078         uint32_t                eft_unicst_filter_indexes[
1079             EFX_EF10_FILTER_UNICAST_FILTERS_MAX];
1080         uint32_t                eft_unicst_filter_count;
1081         uint32_t                eft_mulcst_filter_indexes[
1082             EFX_EF10_FILTER_MULTICAST_FILTERS_MAX];
1083         uint32_t                eft_mulcst_filter_count;
1084         boolean_t               eft_using_all_mulcst;
1085         uint32_t                eft_encap_filter_indexes[
1086             EFX_EF10_FILTER_ENCAP_FILTERS_MAX];
1087         uint32_t                eft_encap_filter_count;
1088 } ef10_filter_table_t;
1089
1090         __checkReturn   efx_rc_t
1091 ef10_filter_init(
1092         __in            efx_nic_t *enp);
1093
1094                         void
1095 ef10_filter_fini(
1096         __in            efx_nic_t *enp);
1097
1098         __checkReturn   efx_rc_t
1099 ef10_filter_restore(
1100         __in            efx_nic_t *enp);
1101
1102         __checkReturn   efx_rc_t
1103 ef10_filter_add(
1104         __in            efx_nic_t *enp,
1105         __inout         efx_filter_spec_t *spec,
1106         __in            boolean_t may_replace);
1107
1108         __checkReturn   efx_rc_t
1109 ef10_filter_delete(
1110         __in            efx_nic_t *enp,
1111         __inout         efx_filter_spec_t *spec);
1112
1113 extern  __checkReturn   efx_rc_t
1114 ef10_filter_supported_filters(
1115         __in                            efx_nic_t *enp,
1116         __out_ecount(buffer_length)     uint32_t *buffer,
1117         __in                            size_t buffer_length,
1118         __out                           size_t *list_lengthp);
1119
1120 extern  __checkReturn   efx_rc_t
1121 ef10_filter_reconfigure(
1122         __in                            efx_nic_t *enp,
1123         __in_ecount(6)                  uint8_t const *mac_addr,
1124         __in                            boolean_t all_unicst,
1125         __in                            boolean_t mulcst,
1126         __in                            boolean_t all_mulcst,
1127         __in                            boolean_t brdcst,
1128         __in_ecount(6*count)            uint8_t const *addrs,
1129         __in                            uint32_t count);
1130
1131 extern          void
1132 ef10_filter_get_default_rxq(
1133         __in            efx_nic_t *enp,
1134         __out           efx_rxq_t **erpp,
1135         __out           boolean_t *using_rss);
1136
1137 extern          void
1138 ef10_filter_default_rxq_set(
1139         __in            efx_nic_t *enp,
1140         __in            efx_rxq_t *erp,
1141         __in            boolean_t using_rss);
1142
1143 extern          void
1144 ef10_filter_default_rxq_clear(
1145         __in            efx_nic_t *enp);
1146
1147
1148 #endif /* EFSYS_OPT_FILTER */
1149
1150 extern  __checkReturn                   efx_rc_t
1151 efx_mcdi_get_function_info(
1152         __in                            efx_nic_t *enp,
1153         __out                           uint32_t *pfp,
1154         __out_opt                       uint32_t *vfp);
1155
1156 extern  __checkReturn           efx_rc_t
1157 efx_mcdi_privilege_mask(
1158         __in                    efx_nic_t *enp,
1159         __in                    uint32_t pf,
1160         __in                    uint32_t vf,
1161         __out                   uint32_t *maskp);
1162
1163 extern  __checkReturn   efx_rc_t
1164 efx_mcdi_get_port_assignment(
1165         __in            efx_nic_t *enp,
1166         __out           uint32_t *portp);
1167
1168 extern  __checkReturn   efx_rc_t
1169 efx_mcdi_get_port_modes(
1170         __in            efx_nic_t *enp,
1171         __out           uint32_t *modesp,
1172         __out_opt       uint32_t *current_modep,
1173         __out_opt       uint32_t *default_modep);
1174
1175 extern  __checkReturn   efx_rc_t
1176 ef10_nic_get_port_mode_bandwidth(
1177         __in            efx_nic_t *enp,
1178         __out           uint32_t *bandwidth_mbpsp);
1179
1180 extern  __checkReturn   efx_rc_t
1181 efx_mcdi_get_mac_address_pf(
1182         __in                    efx_nic_t *enp,
1183         __out_ecount_opt(6)     uint8_t mac_addrp[6]);
1184
1185 extern  __checkReturn   efx_rc_t
1186 efx_mcdi_get_mac_address_vf(
1187         __in                    efx_nic_t *enp,
1188         __out_ecount_opt(6)     uint8_t mac_addrp[6]);
1189
1190 extern  __checkReturn   efx_rc_t
1191 efx_mcdi_get_clock(
1192         __in            efx_nic_t *enp,
1193         __out           uint32_t *sys_freqp,
1194         __out           uint32_t *dpcpu_freqp);
1195
1196
1197 extern  __checkReturn   efx_rc_t
1198 efx_mcdi_get_rxdp_config(
1199         __in            efx_nic_t *enp,
1200         __out           uint32_t *end_paddingp);
1201
1202 extern  __checkReturn   efx_rc_t
1203 efx_mcdi_get_vector_cfg(
1204         __in            efx_nic_t *enp,
1205         __out_opt       uint32_t *vec_basep,
1206         __out_opt       uint32_t *pf_nvecp,
1207         __out_opt       uint32_t *vf_nvecp);
1208
1209 extern  __checkReturn           efx_rc_t
1210 ef10_get_privilege_mask(
1211         __in                    efx_nic_t *enp,
1212         __out                   uint32_t *maskp);
1213
1214 #if EFSYS_OPT_FW_SUBVARIANT_AWARE
1215
1216 extern  __checkReturn   efx_rc_t
1217 efx_mcdi_get_nic_global(
1218         __in            efx_nic_t *enp,
1219         __in            uint32_t key,
1220         __out           uint32_t *valuep);
1221
1222 extern  __checkReturn   efx_rc_t
1223 efx_mcdi_set_nic_global(
1224         __in            efx_nic_t *enp,
1225         __in            uint32_t key,
1226         __in            uint32_t value);
1227
1228 #endif  /* EFSYS_OPT_FW_SUBVARIANT_AWARE */
1229
1230
1231 #if EFSYS_OPT_RX_PACKED_STREAM
1232
1233 /* Data space per credit in packed stream mode */
1234 #define EFX_RX_PACKED_STREAM_MEM_PER_CREDIT (1 << 16)
1235
1236 /*
1237  * Received packets are always aligned at this boundary. Also there always
1238  * exists a gap of this size between packets.
1239  * (see SF-112241-TC, 4.5)
1240  */
1241 #define EFX_RX_PACKED_STREAM_ALIGNMENT 64
1242
1243 /*
1244  * Size of a pseudo-header prepended to received packets
1245  * in packed stream mode
1246  */
1247 #define EFX_RX_PACKED_STREAM_RX_PREFIX_SIZE 8
1248
1249 /* Minimum space for packet in packed stream mode */
1250 #define EFX_RX_PACKED_STREAM_MIN_PACKET_SPACE                \
1251         P2ROUNDUP(EFX_RX_PACKED_STREAM_RX_PREFIX_SIZE +      \
1252             EFX_MAC_PDU_MIN +                                \
1253             EFX_RX_PACKED_STREAM_ALIGNMENT,                  \
1254             EFX_RX_PACKED_STREAM_ALIGNMENT)
1255
1256 /* Maximum number of credits */
1257 #define EFX_RX_PACKED_STREAM_MAX_CREDITS 127
1258
1259 #endif /* EFSYS_OPT_RX_PACKED_STREAM */
1260
1261 #if EFSYS_OPT_RX_ES_SUPER_BUFFER
1262
1263 /*
1264  * Maximum DMA length and buffer stride alignment.
1265  * (see SF-119419-TC, 3.2)
1266  */
1267 #define EFX_RX_ES_SUPER_BUFFER_BUF_ALIGNMENT    64
1268
1269 #endif
1270
1271 #ifdef  __cplusplus
1272 }
1273 #endif
1274
1275 #endif  /* _SYS_EF10_IMPL_H */