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