sys/dev/sfxge/common/ef10_impl.h

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