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_link_mode_t         els_link_mode;
 600 #if EFSYS_OPT_LOOPBACK
 601         efx_loopback_type_t     els_loopback;
 602 #endif
 603         boolean_t               els_mac_up;
 604 } ef10_link_state_t;
 605
 606 extern                  void
 607 ef10_phy_link_ev(
 608         __in            efx_nic_t *enp,
 609         __in            efx_qword_t *eqp,
 610         __out           efx_link_mode_t *link_modep);
 611
 612 extern  __checkReturn   efx_rc_t
 613 ef10_phy_get_link(
 614         __in            efx_nic_t *enp,
 615         __out           ef10_link_state_t *elsp);
 616
 617 extern  __checkReturn   efx_rc_t
 618 ef10_phy_power(
 619         __in            efx_nic_t *enp,
 620         __in            boolean_t on);
 621
 622 extern  __checkReturn   efx_rc_t
 623 ef10_phy_reconfigure(
 624         __in            efx_nic_t *enp);
 625
 626 extern  __checkReturn   efx_rc_t
 627 ef10_phy_verify(
 628         __in            efx_nic_t *enp);
 629
 630 extern  __checkReturn   efx_rc_t
 631 ef10_phy_oui_get(
 632         __in            efx_nic_t *enp,
 633         __out           uint32_t *ouip);
 634
 635 #if EFSYS_OPT_PHY_STATS
 636
 637 extern  __checkReturn                   efx_rc_t
 638 ef10_phy_stats_update(
 639         __in                            efx_nic_t *enp,
 640         __in                            efsys_mem_t *esmp,
 641         __inout_ecount(EFX_PHY_NSTATS)  uint32_t *stat);
 642
 643 #endif  /* EFSYS_OPT_PHY_STATS */
 644
 645 #if EFSYS_OPT_BIST
 646
 647 extern  __checkReturn           efx_rc_t
 648 ef10_bist_enable_offline(
 649         __in                    efx_nic_t *enp);
 650
 651 extern  __checkReturn           efx_rc_t
 652 ef10_bist_start(
 653         __in                    efx_nic_t *enp,
 654         __in                    efx_bist_type_t type);
 655
 656 extern  __checkReturn           efx_rc_t
 657 ef10_bist_poll(
 658         __in                    efx_nic_t *enp,
 659         __in                    efx_bist_type_t type,
 660         __out                   efx_bist_result_t *resultp,
 661         __out_opt __drv_when(count > 0, __notnull)
 662         uint32_t        *value_maskp,
 663         __out_ecount_opt(count) __drv_when(count > 0, __notnull)
 664         unsigned long   *valuesp,
 665         __in                    size_t count);
 666
 667 extern                          void
 668 ef10_bist_stop(
 669         __in                    efx_nic_t *enp,
 670         __in                    efx_bist_type_t type);
 671
 672 #endif  /* EFSYS_OPT_BIST */
 673
 674 /* TX */
 675
 676 extern  __checkReturn   efx_rc_t
 677 ef10_tx_init(
 678         __in            efx_nic_t *enp);
 679
 680 extern                  void
 681 ef10_tx_fini(
 682         __in            efx_nic_t *enp);
 683
 684 extern  __checkReturn   efx_rc_t
 685 ef10_tx_qcreate(
 686         __in            efx_nic_t *enp,
 687         __in            unsigned int index,
 688         __in            unsigned int label,
 689         __in            efsys_mem_t *esmp,
 690         __in            size_t ndescs,
 691         __in            uint32_t id,
 692         __in            uint16_t flags,
 693         __in            efx_evq_t *eep,
 694         __in            efx_txq_t *etp,
 695         __out           unsigned int *addedp);
 696
 697 extern          void
 698 ef10_tx_qdestroy(
 699         __in            efx_txq_t *etp);
 700
 701 extern  __checkReturn           efx_rc_t
 702 ef10_tx_qpost(
 703         __in                    efx_txq_t *etp,
 704         __in_ecount(ndescs)     efx_buffer_t *ebp,
 705         __in                    unsigned int ndescs,
 706         __in                    unsigned int completed,
 707         __inout                 unsigned int *addedp);
 708
 709 extern                  void
 710 ef10_tx_qpush(
 711         __in            efx_txq_t *etp,
 712         __in            unsigned int added,
 713         __in            unsigned int pushed);
 714
 715 #if EFSYS_OPT_RX_PACKED_STREAM
 716 extern                  void
 717 ef10_rx_qpush_ps_credits(
 718         __in            efx_rxq_t *erp);
 719
 720 extern  __checkReturn   uint8_t *
 721 ef10_rx_qps_packet_info(
 722         __in            efx_rxq_t *erp,
 723         __in            uint8_t *buffer,
 724         __in            uint32_t buffer_length,
 725         __in            uint32_t current_offset,
 726         __out           uint16_t *lengthp,
 727         __out           uint32_t *next_offsetp,
 728         __out           uint32_t *timestamp);
 729 #endif
 730
 731 extern  __checkReturn   efx_rc_t
 732 ef10_tx_qpace(
 733         __in            efx_txq_t *etp,
 734         __in            unsigned int ns);
 735
 736 extern  __checkReturn   efx_rc_t
 737 ef10_tx_qflush(
 738         __in            efx_txq_t *etp);
 739
 740 extern                  void
 741 ef10_tx_qenable(
 742         __in            efx_txq_t *etp);
 743
 744 extern  __checkReturn   efx_rc_t
 745 ef10_tx_qpio_enable(
 746         __in            efx_txq_t *etp);
 747
 748 extern                  void
 749 ef10_tx_qpio_disable(
 750         __in            efx_txq_t *etp);
 751
 752 extern  __checkReturn   efx_rc_t
 753 ef10_tx_qpio_write(
 754         __in                    efx_txq_t *etp,
 755         __in_ecount(buf_length) uint8_t *buffer,
 756         __in                    size_t buf_length,
 757         __in                    size_t pio_buf_offset);
 758
 759 extern  __checkReturn   efx_rc_t
 760 ef10_tx_qpio_post(
 761         __in                    efx_txq_t *etp,
 762         __in                    size_t pkt_length,
 763         __in                    unsigned int completed,
 764         __inout                 unsigned int *addedp);
 765
 766 extern  __checkReturn   efx_rc_t
 767 ef10_tx_qdesc_post(
 768         __in            efx_txq_t *etp,
 769         __in_ecount(n)  efx_desc_t *ed,
 770         __in            unsigned int n,
 771         __in            unsigned int completed,
 772         __inout         unsigned int *addedp);
 773
 774 extern  void
 775 ef10_tx_qdesc_dma_create(
 776         __in    efx_txq_t *etp,
 777         __in    efsys_dma_addr_t addr,
 778         __in    size_t size,
 779         __in    boolean_t eop,
 780         __out   efx_desc_t *edp);
 781
 782 extern  void
 783 ef10_tx_qdesc_tso_create(
 784         __in    efx_txq_t *etp,
 785         __in    uint16_t ipv4_id,
 786         __in    uint32_t tcp_seq,
 787         __in    uint8_t  tcp_flags,
 788         __out   efx_desc_t *edp);
 789
 790 extern  void
 791 ef10_tx_qdesc_tso2_create(
 792         __in                    efx_txq_t *etp,
 793         __in                    uint16_t ipv4_id,
 794         __in                    uint16_t outer_ipv4_id,
 795         __in                    uint32_t tcp_seq,
 796         __in                    uint16_t tcp_mss,
 797         __out_ecount(count)     efx_desc_t *edp,
 798         __in                    int count);
 799
 800 extern  void
 801 ef10_tx_qdesc_vlantci_create(
 802         __in    efx_txq_t *etp,
 803         __in    uint16_t vlan_tci,
 804         __out   efx_desc_t *edp);
 805
 806 extern  void
 807 ef10_tx_qdesc_checksum_create(
 808         __in    efx_txq_t *etp,
 809         __in    uint16_t flags,
 810         __out   efx_desc_t *edp);
 811
 812 #if EFSYS_OPT_QSTATS
 813
 814 extern                  void
 815 ef10_tx_qstats_update(
 816         __in                            efx_txq_t *etp,
 817         __inout_ecount(TX_NQSTATS)      efsys_stat_t *stat);
 818
 819 #endif /* EFSYS_OPT_QSTATS */
 820
 821 typedef uint32_t        efx_piobuf_handle_t;
 822
 823 #define EFX_PIOBUF_HANDLE_INVALID       ((efx_piobuf_handle_t)-1)
 824
 825 extern  __checkReturn   efx_rc_t
 826 ef10_nic_pio_alloc(
 827         __inout         efx_nic_t *enp,
 828         __out           uint32_t *bufnump,
 829         __out           efx_piobuf_handle_t *handlep,
 830         __out           uint32_t *blknump,
 831         __out           uint32_t *offsetp,
 832         __out           size_t *sizep);
 833
 834 extern  __checkReturn   efx_rc_t
 835 ef10_nic_pio_free(
 836         __inout         efx_nic_t *enp,
 837         __in            uint32_t bufnum,
 838         __in            uint32_t blknum);
 839
 840 extern  __checkReturn   efx_rc_t
 841 ef10_nic_pio_link(
 842         __inout         efx_nic_t *enp,
 843         __in            uint32_t vi_index,
 844         __in            efx_piobuf_handle_t handle);
 845
 846 extern  __checkReturn   efx_rc_t
 847 ef10_nic_pio_unlink(
 848         __inout         efx_nic_t *enp,
 849         __in            uint32_t vi_index);
 850
 851
 852 /* VPD */
 853
 854 #if EFSYS_OPT_VPD
 855
 856 extern  __checkReturn           efx_rc_t
 857 ef10_vpd_init(
 858         __in                    efx_nic_t *enp);
 859
 860 extern  __checkReturn           efx_rc_t
 861 ef10_vpd_size(
 862         __in                    efx_nic_t *enp,
 863         __out                   size_t *sizep);
 864
 865 extern  __checkReturn           efx_rc_t
 866 ef10_vpd_read(
 867         __in                    efx_nic_t *enp,
 868         __out_bcount(size)      caddr_t data,
 869         __in                    size_t size);
 870
 871 extern  __checkReturn           efx_rc_t
 872 ef10_vpd_verify(
 873         __in                    efx_nic_t *enp,
 874         __in_bcount(size)       caddr_t data,
 875         __in                    size_t size);
 876
 877 extern  __checkReturn           efx_rc_t
 878 ef10_vpd_reinit(
 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_get(
 885         __in                    efx_nic_t *enp,
 886         __in_bcount(size)       caddr_t data,
 887         __in                    size_t size,
 888         __inout                 efx_vpd_value_t *evvp);
 889
 890 extern  __checkReturn           efx_rc_t
 891 ef10_vpd_set(
 892         __in                    efx_nic_t *enp,
 893         __in_bcount(size)       caddr_t data,
 894         __in                    size_t size,
 895         __in                    efx_vpd_value_t *evvp);
 896
 897 extern  __checkReturn           efx_rc_t
 898 ef10_vpd_next(
 899         __in                    efx_nic_t *enp,
 900         __in_bcount(size)       caddr_t data,
 901         __in                    size_t size,
 902         __out                   efx_vpd_value_t *evvp,
 903         __inout                 unsigned int *contp);
 904
 905 extern __checkReturn            efx_rc_t
 906 ef10_vpd_write(
 907         __in                    efx_nic_t *enp,
 908         __in_bcount(size)       caddr_t data,
 909         __in                    size_t size);
 910
 911 extern                          void
 912 ef10_vpd_fini(
 913         __in                    efx_nic_t *enp);
 914
 915 #endif  /* EFSYS_OPT_VPD */
 916
 917
 918 /* RX */
 919
 920 extern  __checkReturn   efx_rc_t
 921 ef10_rx_init(
 922         __in            efx_nic_t *enp);
 923
 924 #if EFSYS_OPT_RX_SCATTER
 925 extern  __checkReturn   efx_rc_t
 926 ef10_rx_scatter_enable(
 927         __in            efx_nic_t *enp,
 928         __in            unsigned int buf_size);
 929 #endif  /* EFSYS_OPT_RX_SCATTER */
 930
 931
 932 #if EFSYS_OPT_RX_SCALE
 933
 934 extern  __checkReturn   efx_rc_t
 935 ef10_rx_scale_context_alloc(
 936         __in            efx_nic_t *enp,
 937         __in            efx_rx_scale_context_type_t type,
 938         __in            uint32_t num_queues,
 939         __out           uint32_t *rss_contextp);
 940
 941 extern  __checkReturn   efx_rc_t
 942 ef10_rx_scale_context_free(
 943         __in            efx_nic_t *enp,
 944         __in            uint32_t rss_context);
 945
 946 extern  __checkReturn   efx_rc_t
 947 ef10_rx_scale_mode_set(
 948         __in            efx_nic_t *enp,
 949         __in            uint32_t rss_context,
 950         __in            efx_rx_hash_alg_t alg,
 951         __in            efx_rx_hash_type_t type,
 952         __in            boolean_t insert);
 953
 954 extern  __checkReturn   efx_rc_t
 955 ef10_rx_scale_key_set(
 956         __in            efx_nic_t *enp,
 957         __in            uint32_t rss_context,
 958         __in_ecount(n)  uint8_t *key,
 959         __in            size_t n);
 960
 961 extern  __checkReturn   efx_rc_t
 962 ef10_rx_scale_tbl_set(
 963         __in            efx_nic_t *enp,
 964         __in            uint32_t rss_context,
 965         __in_ecount(n)  unsigned int *table,
 966         __in            size_t n);
 967
 968 extern  __checkReturn   uint32_t
 969 ef10_rx_prefix_hash(
 970         __in            efx_nic_t *enp,
 971         __in            efx_rx_hash_alg_t func,
 972         __in            uint8_t *buffer);
 973
 974 #endif /* EFSYS_OPT_RX_SCALE */
 975
 976 extern  __checkReturn   efx_rc_t
 977 ef10_rx_prefix_pktlen(
 978         __in            efx_nic_t *enp,
 979         __in            uint8_t *buffer,
 980         __out           uint16_t *lengthp);
 981
 982 extern                          void
 983 ef10_rx_qpost(
 984         __in                    efx_rxq_t *erp,
 985         __in_ecount(ndescs)     efsys_dma_addr_t *addrp,
 986         __in                    size_t size,
 987         __in                    unsigned int ndescs,
 988         __in                    unsigned int completed,
 989         __in                    unsigned int added);
 990
 991 extern                  void
 992 ef10_rx_qpush(
 993         __in            efx_rxq_t *erp,
 994         __in            unsigned int added,
 995         __inout         unsigned int *pushedp);
 996
 997 extern  __checkReturn   efx_rc_t
 998 ef10_rx_qflush(
 999         __in            efx_rxq_t *erp);
1000
1001 extern          void
1002 ef10_rx_qenable(
1003         __in            efx_rxq_t *erp);
1004
1005 union efx_rxq_type_data_u;
1006
1007 extern  __checkReturn   efx_rc_t
1008 ef10_rx_qcreate(
1009         __in            efx_nic_t *enp,
1010         __in            unsigned int index,
1011         __in            unsigned int label,
1012         __in            efx_rxq_type_t type,
1013         __in            const union efx_rxq_type_data_u *type_data,
1014         __in            efsys_mem_t *esmp,
1015         __in            size_t ndescs,
1016         __in            uint32_t id,
1017         __in            unsigned int flags,
1018         __in            efx_evq_t *eep,
1019         __in            efx_rxq_t *erp);
1020
1021 extern                  void
1022 ef10_rx_qdestroy(
1023         __in            efx_rxq_t *erp);
1024
1025 extern                  void
1026 ef10_rx_fini(
1027         __in            efx_nic_t *enp);
1028
1029 #if EFSYS_OPT_FILTER
1030
1031 typedef struct ef10_filter_handle_s {
1032         uint32_t        efh_lo;
1033         uint32_t        efh_hi;
1034 } ef10_filter_handle_t;
1035
1036 typedef struct ef10_filter_entry_s {
1037         uintptr_t efe_spec; /* pointer to filter spec plus busy bit */
1038         ef10_filter_handle_t efe_handle;
1039 } ef10_filter_entry_t;
1040
1041 /*
1042  * BUSY flag indicates that an update is in progress.
1043  * AUTO_OLD flag is used to mark and sweep MAC packet filters.
1044  */
1045 #define EFX_EF10_FILTER_FLAG_BUSY       1U
1046 #define EFX_EF10_FILTER_FLAG_AUTO_OLD   2U
1047 #define EFX_EF10_FILTER_FLAGS           3U
1048
1049 /*
1050  * Size of the hash table used by the driver. Doesn't need to be the
1051  * same size as the hardware's table.
1052  */
1053 #define EFX_EF10_FILTER_TBL_ROWS 8192
1054
1055 /* Only need to allow for one directed and one unknown unicast filter */
1056 #define EFX_EF10_FILTER_UNICAST_FILTERS_MAX     2
1057
1058 /* Allow for the broadcast address to be added to the multicast list */
1059 #define EFX_EF10_FILTER_MULTICAST_FILTERS_MAX   (EFX_MAC_MULTICAST_LIST_MAX + 1)
1060
1061 /*
1062  * For encapsulated packets, there is one filter each for each combination of
1063  * IPv4 or IPv6 outer frame, VXLAN, GENEVE or NVGRE packet type, and unicast or
1064  * multicast inner frames.
1065  */
1066 #define EFX_EF10_FILTER_ENCAP_FILTERS_MAX       12
1067
1068 typedef struct ef10_filter_table_s {
1069         ef10_filter_entry_t     eft_entry[EFX_EF10_FILTER_TBL_ROWS];
1070         efx_rxq_t               *eft_default_rxq;
1071         boolean_t               eft_using_rss;
1072         uint32_t                eft_unicst_filter_indexes[
1073             EFX_EF10_FILTER_UNICAST_FILTERS_MAX];
1074         uint32_t                eft_unicst_filter_count;
1075         uint32_t                eft_mulcst_filter_indexes[
1076             EFX_EF10_FILTER_MULTICAST_FILTERS_MAX];
1077         uint32_t                eft_mulcst_filter_count;
1078         boolean_t               eft_using_all_mulcst;
1079         uint32_t                eft_encap_filter_indexes[
1080             EFX_EF10_FILTER_ENCAP_FILTERS_MAX];
1081         uint32_t                eft_encap_filter_count;
1082 } ef10_filter_table_t;
1083
1084         __checkReturn   efx_rc_t
1085 ef10_filter_init(
1086         __in            efx_nic_t *enp);
1087
1088                         void
1089 ef10_filter_fini(
1090         __in            efx_nic_t *enp);
1091
1092         __checkReturn   efx_rc_t
1093 ef10_filter_restore(
1094         __in            efx_nic_t *enp);
1095
1096         __checkReturn   efx_rc_t
1097 ef10_filter_add(
1098         __in            efx_nic_t *enp,
1099         __inout         efx_filter_spec_t *spec,
1100         __in            boolean_t may_replace);
1101
1102         __checkReturn   efx_rc_t
1103 ef10_filter_delete(
1104         __in            efx_nic_t *enp,
1105         __inout         efx_filter_spec_t *spec);
1106
1107 extern  __checkReturn   efx_rc_t
1108 ef10_filter_supported_filters(
1109         __in                            efx_nic_t *enp,
1110         __out_ecount(buffer_length)     uint32_t *buffer,
1111         __in                            size_t buffer_length,
1112         __out                           size_t *list_lengthp);
1113
1114 extern  __checkReturn   efx_rc_t
1115 ef10_filter_reconfigure(
1116         __in                            efx_nic_t *enp,
1117         __in_ecount(6)                  uint8_t const *mac_addr,
1118         __in                            boolean_t all_unicst,
1119         __in                            boolean_t mulcst,
1120         __in                            boolean_t all_mulcst,
1121         __in                            boolean_t brdcst,
1122         __in_ecount(6*count)            uint8_t const *addrs,
1123         __in                            uint32_t count);
1124
1125 extern          void
1126 ef10_filter_get_default_rxq(
1127         __in            efx_nic_t *enp,
1128         __out           efx_rxq_t **erpp,
1129         __out           boolean_t *using_rss);
1130
1131 extern          void
1132 ef10_filter_default_rxq_set(
1133         __in            efx_nic_t *enp,
1134         __in            efx_rxq_t *erp,
1135         __in            boolean_t using_rss);
1136
1137 extern          void
1138 ef10_filter_default_rxq_clear(
1139         __in            efx_nic_t *enp);
1140
1141
1142 #endif /* EFSYS_OPT_FILTER */
1143
1144 extern  __checkReturn                   efx_rc_t
1145 efx_mcdi_get_function_info(
1146         __in                            efx_nic_t *enp,
1147         __out                           uint32_t *pfp,
1148         __out_opt                       uint32_t *vfp);
1149
1150 extern  __checkReturn           efx_rc_t
1151 efx_mcdi_privilege_mask(
1152         __in                    efx_nic_t *enp,
1153         __in                    uint32_t pf,
1154         __in                    uint32_t vf,
1155         __out                   uint32_t *maskp);
1156
1157 extern  __checkReturn   efx_rc_t
1158 efx_mcdi_get_port_assignment(
1159         __in            efx_nic_t *enp,
1160         __out           uint32_t *portp);
1161
1162 extern  __checkReturn   efx_rc_t
1163 efx_mcdi_get_port_modes(
1164         __in            efx_nic_t *enp,
1165         __out           uint32_t *modesp,
1166         __out_opt       uint32_t *current_modep,
1167         __out_opt       uint32_t *default_modep);
1168
1169 extern  __checkReturn   efx_rc_t
1170 ef10_nic_get_port_mode_bandwidth(
1171         __in            uint32_t port_mode,
1172         __out           uint32_t *bandwidth_mbpsp);
1173
1174 extern  __checkReturn   efx_rc_t
1175 efx_mcdi_get_mac_address_pf(
1176         __in                    efx_nic_t *enp,
1177         __out_ecount_opt(6)     uint8_t mac_addrp[6]);
1178
1179 extern  __checkReturn   efx_rc_t
1180 efx_mcdi_get_mac_address_vf(
1181         __in                    efx_nic_t *enp,
1182         __out_ecount_opt(6)     uint8_t mac_addrp[6]);
1183
1184 extern  __checkReturn   efx_rc_t
1185 efx_mcdi_get_clock(
1186         __in            efx_nic_t *enp,
1187         __out           uint32_t *sys_freqp,
1188         __out           uint32_t *dpcpu_freqp);
1189
1190
1191 extern  __checkReturn   efx_rc_t
1192 efx_mcdi_get_rxdp_config(
1193         __in            efx_nic_t *enp,
1194         __out           uint32_t *end_paddingp);
1195
1196 extern  __checkReturn   efx_rc_t
1197 efx_mcdi_get_vector_cfg(
1198         __in            efx_nic_t *enp,
1199         __out_opt       uint32_t *vec_basep,
1200         __out_opt       uint32_t *pf_nvecp,
1201         __out_opt       uint32_t *vf_nvecp);
1202
1203 extern  __checkReturn           efx_rc_t
1204 ef10_get_privilege_mask(
1205         __in                    efx_nic_t *enp,
1206         __out                   uint32_t *maskp);
1207
1208 #if EFSYS_OPT_FW_SUBVARIANT_AWARE
1209
1210 extern  __checkReturn   efx_rc_t
1211 efx_mcdi_get_nic_global(
1212         __in            efx_nic_t *enp,
1213         __in            uint32_t key,
1214         __out           uint32_t *valuep);
1215
1216 extern  __checkReturn   efx_rc_t
1217 efx_mcdi_set_nic_global(
1218         __in            efx_nic_t *enp,
1219         __in            uint32_t key,
1220         __in            uint32_t value);
1221
1222 #endif  /* EFSYS_OPT_FW_SUBVARIANT_AWARE */
1223
1224
1225 #if EFSYS_OPT_RX_PACKED_STREAM
1226
1227 /* Data space per credit in packed stream mode */
1228 #define EFX_RX_PACKED_STREAM_MEM_PER_CREDIT (1 << 16)
1229
1230 /*
1231  * Received packets are always aligned at this boundary. Also there always
1232  * exists a gap of this size between packets.
1233  * (see SF-112241-TC, 4.5)
1234  */
1235 #define EFX_RX_PACKED_STREAM_ALIGNMENT 64
1236
1237 /*
1238  * Size of a pseudo-header prepended to received packets
1239  * in packed stream mode
1240  */
1241 #define EFX_RX_PACKED_STREAM_RX_PREFIX_SIZE 8
1242
1243 /* Minimum space for packet in packed stream mode */
1244 #define EFX_RX_PACKED_STREAM_MIN_PACKET_SPACE                \
1245         P2ROUNDUP(EFX_RX_PACKED_STREAM_RX_PREFIX_SIZE +      \
1246             EFX_MAC_PDU_MIN +                                \
1247             EFX_RX_PACKED_STREAM_ALIGNMENT,                  \
1248             EFX_RX_PACKED_STREAM_ALIGNMENT)
1249
1250 /* Maximum number of credits */
1251 #define EFX_RX_PACKED_STREAM_MAX_CREDITS 127
1252
1253 #endif /* EFSYS_OPT_RX_PACKED_STREAM */
1254
1255 #if EFSYS_OPT_RX_ES_SUPER_BUFFER
1256
1257 /*
1258  * Maximum DMA length and buffer stride alignment.
1259  * (see SF-119419-TC, 3.2)
1260  */
1261 #define EFX_RX_ES_SUPER_BUFFER_BUF_ALIGNMENT    64
1262
1263 #endif
1264
1265 #ifdef  __cplusplus
1266 }
1267 #endif
1268
1269 #endif  /* _SYS_EF10_IMPL_H */