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