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