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