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_erase(
 447         __in                    efx_nic_t *enp,
 448         __in                    uint32_t partn,
 449         __in                    unsigned int offset,
 450         __in                    size_t size);
 451
 452 extern  __checkReturn           efx_rc_t
 453 ef10_nvram_partn_write(
 454         __in                    efx_nic_t *enp,
 455         __in                    uint32_t partn,
 456         __in                    unsigned int offset,
 457         __out_bcount(size)      caddr_t data,
 458         __in                    size_t size);
 459
 460 extern  __checkReturn           efx_rc_t
 461 ef10_nvram_partn_rw_finish(
 462         __in                    efx_nic_t *enp,
 463         __in                    uint32_t partn);
 464
 465 extern  __checkReturn           efx_rc_t
 466 ef10_nvram_partn_get_version(
 467         __in                    efx_nic_t *enp,
 468         __in                    uint32_t partn,
 469         __out                   uint32_t *subtypep,
 470         __out_ecount(4)         uint16_t version[4]);
 471
 472 extern  __checkReturn           efx_rc_t
 473 ef10_nvram_partn_set_version(
 474         __in                    efx_nic_t *enp,
 475         __in                    uint32_t partn,
 476         __in_ecount(4)          uint16_t version[4]);
 477
 478 extern  __checkReturn           efx_rc_t
 479 ef10_nvram_buffer_validate(
 480         __in                    efx_nic_t *enp,
 481         __in                    uint32_t partn,
 482         __in_bcount(buffer_size)
 483                                 caddr_t bufferp,
 484         __in                    size_t buffer_size);
 485
 486 extern  __checkReturn           efx_rc_t
 487 ef10_nvram_buffer_create(
 488         __in                    efx_nic_t *enp,
 489         __in                    uint16_t partn_type,
 490         __in_bcount(buffer_size)
 491                                 caddr_t bufferp,
 492         __in                    size_t buffer_size);
 493
 494 extern  __checkReturn           efx_rc_t
 495 ef10_nvram_buffer_find_item_start(
 496         __in_bcount(buffer_size)
 497                                 caddr_t bufferp,
 498         __in                    size_t buffer_size,
 499         __out                   uint32_t *startp
 500         );
 501
 502 extern  __checkReturn           efx_rc_t
 503 ef10_nvram_buffer_find_end(
 504         __in_bcount(buffer_size)
 505                                 caddr_t bufferp,
 506         __in                    size_t buffer_size,
 507         __in                    uint32_t offset,
 508         __out                   uint32_t *endp
 509         );
 510
 511 extern  __checkReturn   __success(return != B_FALSE)    boolean_t
 512 ef10_nvram_buffer_find_item(
 513         __in_bcount(buffer_size)
 514                                 caddr_t bufferp,
 515         __in                    size_t buffer_size,
 516         __in                    uint32_t offset,
 517         __out                   uint32_t *startp,
 518         __out                   uint32_t *lengthp
 519         );
 520
 521 extern  __checkReturn           efx_rc_t
 522 ef10_nvram_buffer_get_item(
 523         __in_bcount(buffer_size)
 524                                 caddr_t bufferp,
 525         __in                    size_t buffer_size,
 526         __in                    uint32_t offset,
 527         __in                    uint32_t length,
 528         __out_bcount_part(item_max_size, *lengthp)
 529                                 caddr_t itemp,
 530         __in                    size_t item_max_size,
 531         __out                   uint32_t *lengthp
 532         );
 533
 534 extern  __checkReturn           efx_rc_t
 535 ef10_nvram_buffer_insert_item(
 536         __in_bcount(buffer_size)
 537                                 caddr_t bufferp,
 538         __in                    size_t buffer_size,
 539         __in                    uint32_t offset,
 540         __in_bcount(length)     caddr_t keyp,
 541         __in                    uint32_t length,
 542         __out                   uint32_t *lengthp
 543         );
 544
 545 extern  __checkReturn           efx_rc_t
 546 ef10_nvram_buffer_delete_item(
 547         __in_bcount(buffer_size)
 548                                 caddr_t bufferp,
 549         __in                    size_t buffer_size,
 550         __in                    uint32_t offset,
 551         __in                    uint32_t length,
 552         __in                    uint32_t end
 553         );
 554
 555 extern  __checkReturn           efx_rc_t
 556 ef10_nvram_buffer_finish(
 557         __in_bcount(buffer_size)
 558                                 caddr_t bufferp,
 559         __in                    size_t buffer_size
 560         );
 561
 562 #endif  /* EFSYS_OPT_NVRAM */
 563
 564
 565 /* PHY */
 566
 567 typedef struct ef10_link_state_s {
 568         uint32_t                els_adv_cap_mask;
 569         uint32_t                els_lp_cap_mask;
 570         unsigned int            els_fcntl;
 571         efx_link_mode_t         els_link_mode;
 572 #if EFSYS_OPT_LOOPBACK
 573         efx_loopback_type_t     els_loopback;
 574 #endif
 575         boolean_t               els_mac_up;
 576 } ef10_link_state_t;
 577
 578 extern                  void
 579 ef10_phy_link_ev(
 580         __in            efx_nic_t *enp,
 581         __in            efx_qword_t *eqp,
 582         __out           efx_link_mode_t *link_modep);
 583
 584 extern  __checkReturn   efx_rc_t
 585 ef10_phy_get_link(
 586         __in            efx_nic_t *enp,
 587         __out           ef10_link_state_t *elsp);
 588
 589 extern  __checkReturn   efx_rc_t
 590 ef10_phy_power(
 591         __in            efx_nic_t *enp,
 592         __in            boolean_t on);
 593
 594 extern  __checkReturn   efx_rc_t
 595 ef10_phy_reconfigure(
 596         __in            efx_nic_t *enp);
 597
 598 extern  __checkReturn   efx_rc_t
 599 ef10_phy_verify(
 600         __in            efx_nic_t *enp);
 601
 602 extern  __checkReturn   efx_rc_t
 603 ef10_phy_oui_get(
 604         __in            efx_nic_t *enp,
 605         __out           uint32_t *ouip);
 606
 607 #if EFSYS_OPT_PHY_STATS
 608
 609 extern  __checkReturn                   efx_rc_t
 610 ef10_phy_stats_update(
 611         __in                            efx_nic_t *enp,
 612         __in                            efsys_mem_t *esmp,
 613         __inout_ecount(EFX_PHY_NSTATS)  uint32_t *stat);
 614
 615 #endif  /* EFSYS_OPT_PHY_STATS */
 616
 617 #if EFSYS_OPT_BIST
 618
 619 extern  __checkReturn           efx_rc_t
 620 ef10_bist_enable_offline(
 621         __in                    efx_nic_t *enp);
 622
 623 extern  __checkReturn           efx_rc_t
 624 ef10_bist_start(
 625         __in                    efx_nic_t *enp,
 626         __in                    efx_bist_type_t type);
 627
 628 extern  __checkReturn           efx_rc_t
 629 ef10_bist_poll(
 630         __in                    efx_nic_t *enp,
 631         __in                    efx_bist_type_t type,
 632         __out                   efx_bist_result_t *resultp,
 633         __out_opt __drv_when(count > 0, __notnull)
 634         uint32_t        *value_maskp,
 635         __out_ecount_opt(count) __drv_when(count > 0, __notnull)
 636         unsigned long   *valuesp,
 637         __in                    size_t count);
 638
 639 extern                          void
 640 ef10_bist_stop(
 641         __in                    efx_nic_t *enp,
 642         __in                    efx_bist_type_t type);
 643
 644 #endif  /* EFSYS_OPT_BIST */
 645
 646 /* TX */
 647
 648 extern  __checkReturn   efx_rc_t
 649 ef10_tx_init(
 650         __in            efx_nic_t *enp);
 651
 652 extern                  void
 653 ef10_tx_fini(
 654         __in            efx_nic_t *enp);
 655
 656 extern  __checkReturn   efx_rc_t
 657 ef10_tx_qcreate(
 658         __in            efx_nic_t *enp,
 659         __in            unsigned int index,
 660         __in            unsigned int label,
 661         __in            efsys_mem_t *esmp,
 662         __in            size_t n,
 663         __in            uint32_t id,
 664         __in            uint16_t flags,
 665         __in            efx_evq_t *eep,
 666         __in            efx_txq_t *etp,
 667         __out           unsigned int *addedp);
 668
 669 extern          void
 670 ef10_tx_qdestroy(
 671         __in            efx_txq_t *etp);
 672
 673 extern  __checkReturn   efx_rc_t
 674 ef10_tx_qpost(
 675         __in            efx_txq_t *etp,
 676         __in_ecount(n)  efx_buffer_t *eb,
 677         __in            unsigned int n,
 678         __in            unsigned int completed,
 679         __inout         unsigned int *addedp);
 680
 681 extern                  void
 682 ef10_tx_qpush(
 683         __in            efx_txq_t *etp,
 684         __in            unsigned int added,
 685         __in            unsigned int pushed);
 686
 687 #if EFSYS_OPT_RX_PACKED_STREAM
 688 extern                  void
 689 ef10_rx_qps_update_credits(
 690         __in    efx_rxq_t *erp);
 691
 692 extern  __checkReturn   uint8_t *
 693 ef10_rx_qps_packet_info(
 694         __in            efx_rxq_t *erp,
 695         __in            uint8_t *buffer,
 696         __in            uint32_t buffer_length,
 697         __in            uint32_t current_offset,
 698         __out           uint16_t *lengthp,
 699         __out           uint32_t *next_offsetp,
 700         __out           uint32_t *timestamp);
 701 #endif
 702
 703 extern  __checkReturn   efx_rc_t
 704 ef10_tx_qpace(
 705         __in            efx_txq_t *etp,
 706         __in            unsigned int ns);
 707
 708 extern  __checkReturn   efx_rc_t
 709 ef10_tx_qflush(
 710         __in            efx_txq_t *etp);
 711
 712 extern                  void
 713 ef10_tx_qenable(
 714         __in            efx_txq_t *etp);
 715
 716 extern  __checkReturn   efx_rc_t
 717 ef10_tx_qpio_enable(
 718         __in            efx_txq_t *etp);
 719
 720 extern                  void
 721 ef10_tx_qpio_disable(
 722         __in            efx_txq_t *etp);
 723
 724 extern  __checkReturn   efx_rc_t
 725 ef10_tx_qpio_write(
 726         __in                    efx_txq_t *etp,
 727         __in_ecount(buf_length) uint8_t *buffer,
 728         __in                    size_t buf_length,
 729         __in                    size_t pio_buf_offset);
 730
 731 extern  __checkReturn   efx_rc_t
 732 ef10_tx_qpio_post(
 733         __in                    efx_txq_t *etp,
 734         __in                    size_t pkt_length,
 735         __in                    unsigned int completed,
 736         __inout                 unsigned int *addedp);
 737
 738 extern  __checkReturn   efx_rc_t
 739 ef10_tx_qdesc_post(
 740         __in            efx_txq_t *etp,
 741         __in_ecount(n)  efx_desc_t *ed,
 742         __in            unsigned int n,
 743         __in            unsigned int completed,
 744         __inout         unsigned int *addedp);
 745
 746 extern  void
 747 ef10_tx_qdesc_dma_create(
 748         __in    efx_txq_t *etp,
 749         __in    efsys_dma_addr_t addr,
 750         __in    size_t size,
 751         __in    boolean_t eop,
 752         __out   efx_desc_t *edp);
 753
 754 extern  void
 755 ef10_tx_qdesc_tso_create(
 756         __in    efx_txq_t *etp,
 757         __in    uint16_t ipv4_id,
 758         __in    uint32_t tcp_seq,
 759         __in    uint8_t  tcp_flags,
 760         __out   efx_desc_t *edp);
 761
 762 extern  void
 763 ef10_tx_qdesc_tso2_create(
 764         __in                    efx_txq_t *etp,
 765         __in                    uint16_t ipv4_id,
 766         __in                    uint32_t tcp_seq,
 767         __in                    uint16_t tcp_mss,
 768         __out_ecount(count)     efx_desc_t *edp,
 769         __in                    int count);
 770
 771 extern  void
 772 ef10_tx_qdesc_vlantci_create(
 773         __in    efx_txq_t *etp,
 774         __in    uint16_t vlan_tci,
 775         __out   efx_desc_t *edp);
 776
 777
 778 #if EFSYS_OPT_QSTATS
 779
 780 extern                  void
 781 ef10_tx_qstats_update(
 782         __in                            efx_txq_t *etp,
 783         __inout_ecount(TX_NQSTATS)      efsys_stat_t *stat);
 784
 785 #endif /* EFSYS_OPT_QSTATS */
 786
 787 typedef uint32_t        efx_piobuf_handle_t;
 788
 789 #define EFX_PIOBUF_HANDLE_INVALID       ((efx_piobuf_handle_t) -1)
 790
 791 extern  __checkReturn   efx_rc_t
 792 ef10_nic_pio_alloc(
 793         __inout         efx_nic_t *enp,
 794         __out           uint32_t *bufnump,
 795         __out           efx_piobuf_handle_t *handlep,
 796         __out           uint32_t *blknump,
 797         __out           uint32_t *offsetp,
 798         __out           size_t *sizep);
 799
 800 extern  __checkReturn   efx_rc_t
 801 ef10_nic_pio_free(
 802         __inout         efx_nic_t *enp,
 803         __in            uint32_t bufnum,
 804         __in            uint32_t blknum);
 805
 806 extern  __checkReturn   efx_rc_t
 807 ef10_nic_pio_link(
 808         __inout         efx_nic_t *enp,
 809         __in            uint32_t vi_index,
 810         __in            efx_piobuf_handle_t handle);
 811
 812 extern  __checkReturn   efx_rc_t
 813 ef10_nic_pio_unlink(
 814         __inout         efx_nic_t *enp,
 815         __in            uint32_t vi_index);
 816
 817
 818 /* VPD */
 819
 820 #if EFSYS_OPT_VPD
 821
 822 extern  __checkReturn           efx_rc_t
 823 ef10_vpd_init(
 824         __in                    efx_nic_t *enp);
 825
 826 extern  __checkReturn           efx_rc_t
 827 ef10_vpd_size(
 828         __in                    efx_nic_t *enp,
 829         __out                   size_t *sizep);
 830
 831 extern  __checkReturn           efx_rc_t
 832 ef10_vpd_read(
 833         __in                    efx_nic_t *enp,
 834         __out_bcount(size)      caddr_t data,
 835         __in                    size_t size);
 836
 837 extern  __checkReturn           efx_rc_t
 838 ef10_vpd_verify(
 839         __in                    efx_nic_t *enp,
 840         __in_bcount(size)       caddr_t data,
 841         __in                    size_t size);
 842
 843 extern  __checkReturn           efx_rc_t
 844 ef10_vpd_reinit(
 845         __in                    efx_nic_t *enp,
 846         __in_bcount(size)       caddr_t data,
 847         __in                    size_t size);
 848
 849 extern  __checkReturn           efx_rc_t
 850 ef10_vpd_get(
 851         __in                    efx_nic_t *enp,
 852         __in_bcount(size)       caddr_t data,
 853         __in                    size_t size,
 854         __inout                 efx_vpd_value_t *evvp);
 855
 856 extern  __checkReturn           efx_rc_t
 857 ef10_vpd_set(
 858         __in                    efx_nic_t *enp,
 859         __in_bcount(size)       caddr_t data,
 860         __in                    size_t size,
 861         __in                    efx_vpd_value_t *evvp);
 862
 863 extern  __checkReturn           efx_rc_t
 864 ef10_vpd_next(
 865         __in                    efx_nic_t *enp,
 866         __in_bcount(size)       caddr_t data,
 867         __in                    size_t size,
 868         __out                   efx_vpd_value_t *evvp,
 869         __inout                 unsigned int *contp);
 870
 871 extern __checkReturn            efx_rc_t
 872 ef10_vpd_write(
 873         __in                    efx_nic_t *enp,
 874         __in_bcount(size)       caddr_t data,
 875         __in                    size_t size);
 876
 877 extern                          void
 878 ef10_vpd_fini(
 879         __in                    efx_nic_t *enp);
 880
 881 #endif  /* EFSYS_OPT_VPD */
 882
 883
 884 /* RX */
 885
 886 extern  __checkReturn   efx_rc_t
 887 ef10_rx_init(
 888         __in            efx_nic_t *enp);
 889
 890 #if EFSYS_OPT_RX_SCATTER
 891 extern  __checkReturn   efx_rc_t
 892 ef10_rx_scatter_enable(
 893         __in            efx_nic_t *enp,
 894         __in            unsigned int buf_size);
 895 #endif  /* EFSYS_OPT_RX_SCATTER */
 896
 897
 898 #if EFSYS_OPT_RX_SCALE
 899
 900 extern  __checkReturn   efx_rc_t
 901 ef10_rx_scale_context_alloc(
 902         __in            efx_nic_t *enp,
 903         __in            efx_rx_scale_context_type_t type,
 904         __in            uint32_t num_queues,
 905         __out           uint32_t *rss_contextp);
 906
 907 extern  __checkReturn   efx_rc_t
 908 ef10_rx_scale_context_free(
 909         __in            efx_nic_t *enp,
 910         __in            uint32_t rss_context);
 911
 912 extern  __checkReturn   efx_rc_t
 913 ef10_rx_scale_mode_set(
 914         __in            efx_nic_t *enp,
 915         __in            uint32_t rss_context,
 916         __in            efx_rx_hash_alg_t alg,
 917         __in            efx_rx_hash_type_t type,
 918         __in            boolean_t insert);
 919
 920 extern  __checkReturn   efx_rc_t
 921 ef10_rx_scale_key_set(
 922         __in            efx_nic_t *enp,
 923         __in            uint32_t rss_context,
 924         __in_ecount(n)  uint8_t *key,
 925         __in            size_t n);
 926
 927 extern  __checkReturn   efx_rc_t
 928 ef10_rx_scale_tbl_set(
 929         __in            efx_nic_t *enp,
 930         __in            uint32_t rss_context,
 931         __in_ecount(n)  unsigned int *table,
 932         __in            size_t n);
 933
 934 extern  __checkReturn   uint32_t
 935 ef10_rx_prefix_hash(
 936         __in            efx_nic_t *enp,
 937         __in            efx_rx_hash_alg_t func,
 938         __in            uint8_t *buffer);
 939
 940 #endif /* EFSYS_OPT_RX_SCALE */
 941
 942 extern  __checkReturn   efx_rc_t
 943 ef10_rx_prefix_pktlen(
 944         __in            efx_nic_t *enp,
 945         __in            uint8_t *buffer,
 946         __out           uint16_t *lengthp);
 947
 948 extern                  void
 949 ef10_rx_qpost(
 950         __in            efx_rxq_t *erp,
 951         __in_ecount(n)  efsys_dma_addr_t *addrp,
 952         __in            size_t size,
 953         __in            unsigned int n,
 954         __in            unsigned int completed,
 955         __in            unsigned int added);
 956
 957 extern                  void
 958 ef10_rx_qpush(
 959         __in            efx_rxq_t *erp,
 960         __in            unsigned int added,
 961         __inout         unsigned int *pushedp);
 962
 963 extern  __checkReturn   efx_rc_t
 964 ef10_rx_qflush(
 965         __in            efx_rxq_t *erp);
 966
 967 extern          void
 968 ef10_rx_qenable(
 969         __in            efx_rxq_t *erp);
 970
 971 extern  __checkReturn   efx_rc_t
 972 ef10_rx_qcreate(
 973         __in            efx_nic_t *enp,
 974         __in            unsigned int index,
 975         __in            unsigned int label,
 976         __in            efx_rxq_type_t type,
 977         __in            efsys_mem_t *esmp,
 978         __in            size_t n,
 979         __in            uint32_t id,
 980         __in            efx_evq_t *eep,
 981         __in            efx_rxq_t *erp);
 982
 983 extern                  void
 984 ef10_rx_qdestroy(
 985         __in            efx_rxq_t *erp);
 986
 987 extern                  void
 988 ef10_rx_fini(
 989         __in            efx_nic_t *enp);
 990
 991 #if EFSYS_OPT_FILTER
 992
 993 typedef struct ef10_filter_handle_s {
 994         uint32_t        efh_lo;
 995         uint32_t        efh_hi;
 996 } ef10_filter_handle_t;
 997
 998 typedef struct ef10_filter_entry_s {
 999         uintptr_t efe_spec; /* pointer to filter spec plus busy bit */
1000         ef10_filter_handle_t efe_handle;
1001 } ef10_filter_entry_t;
1002
1003 /*
1004  * BUSY flag indicates that an update is in progress.
1005  * AUTO_OLD flag is used to mark and sweep MAC packet filters.
1006  */
1007 #define EFX_EF10_FILTER_FLAG_BUSY       1U
1008 #define EFX_EF10_FILTER_FLAG_AUTO_OLD   2U
1009 #define EFX_EF10_FILTER_FLAGS           3U
1010
1011 /*
1012  * Size of the hash table used by the driver. Doesn't need to be the
1013  * same size as the hardware's table.
1014  */
1015 #define EFX_EF10_FILTER_TBL_ROWS 8192
1016
1017 /* Only need to allow for one directed and one unknown unicast filter */
1018 #define EFX_EF10_FILTER_UNICAST_FILTERS_MAX     2
1019
1020 /* Allow for the broadcast address to be added to the multicast list */
1021 #define EFX_EF10_FILTER_MULTICAST_FILTERS_MAX   (EFX_MAC_MULTICAST_LIST_MAX + 1)
1022
1023 /*
1024  * For encapsulated packets, there is one filter each for each combination of
1025  * IPv4 or IPv6 outer frame, VXLAN, GENEVE or NVGRE packet type, and unicast or
1026  * multicast inner frames.
1027  */
1028 #define EFX_EF10_FILTER_ENCAP_FILTERS_MAX       12
1029
1030 typedef struct ef10_filter_table_s {
1031         ef10_filter_entry_t     eft_entry[EFX_EF10_FILTER_TBL_ROWS];
1032         efx_rxq_t               *eft_default_rxq;
1033         boolean_t               eft_using_rss;
1034         uint32_t                eft_unicst_filter_indexes[
1035             EFX_EF10_FILTER_UNICAST_FILTERS_MAX];
1036         uint32_t                eft_unicst_filter_count;
1037         uint32_t                eft_mulcst_filter_indexes[
1038             EFX_EF10_FILTER_MULTICAST_FILTERS_MAX];
1039         uint32_t                eft_mulcst_filter_count;
1040         boolean_t               eft_using_all_mulcst;
1041         uint32_t                eft_encap_filter_indexes[
1042             EFX_EF10_FILTER_ENCAP_FILTERS_MAX];
1043         uint32_t                eft_encap_filter_count;
1044 } ef10_filter_table_t;
1045
1046         __checkReturn   efx_rc_t
1047 ef10_filter_init(
1048         __in            efx_nic_t *enp);
1049
1050                         void
1051 ef10_filter_fini(
1052         __in            efx_nic_t *enp);
1053
1054         __checkReturn   efx_rc_t
1055 ef10_filter_restore(
1056         __in            efx_nic_t *enp);
1057
1058         __checkReturn   efx_rc_t
1059 ef10_filter_add(
1060         __in            efx_nic_t *enp,
1061         __inout         efx_filter_spec_t *spec,
1062         __in            boolean_t may_replace);
1063
1064         __checkReturn   efx_rc_t
1065 ef10_filter_delete(
1066         __in            efx_nic_t *enp,
1067         __inout         efx_filter_spec_t *spec);
1068
1069 extern  __checkReturn   efx_rc_t
1070 ef10_filter_supported_filters(
1071         __in                            efx_nic_t *enp,
1072         __out_ecount(buffer_length)     uint32_t *buffer,
1073         __in                            size_t buffer_length,
1074         __out                           size_t *list_lengthp);
1075
1076 extern  __checkReturn   efx_rc_t
1077 ef10_filter_reconfigure(
1078         __in                            efx_nic_t *enp,
1079         __in_ecount(6)                  uint8_t const *mac_addr,
1080         __in                            boolean_t all_unicst,
1081         __in                            boolean_t mulcst,
1082         __in                            boolean_t all_mulcst,
1083         __in                            boolean_t brdcst,
1084         __in_ecount(6*count)            uint8_t const *addrs,
1085         __in                            uint32_t count);
1086
1087 extern          void
1088 ef10_filter_get_default_rxq(
1089         __in            efx_nic_t *enp,
1090         __out           efx_rxq_t **erpp,
1091         __out           boolean_t *using_rss);
1092
1093 extern          void
1094 ef10_filter_default_rxq_set(
1095         __in            efx_nic_t *enp,
1096         __in            efx_rxq_t *erp,
1097         __in            boolean_t using_rss);
1098
1099 extern          void
1100 ef10_filter_default_rxq_clear(
1101         __in            efx_nic_t *enp);
1102
1103
1104 #endif /* EFSYS_OPT_FILTER */
1105
1106 extern  __checkReturn                   efx_rc_t
1107 efx_mcdi_get_function_info(
1108         __in                            efx_nic_t *enp,
1109         __out                           uint32_t *pfp,
1110         __out_opt                       uint32_t *vfp);
1111
1112 extern  __checkReturn           efx_rc_t
1113 efx_mcdi_privilege_mask(
1114         __in                    efx_nic_t *enp,
1115         __in                    uint32_t pf,
1116         __in                    uint32_t vf,
1117         __out                   uint32_t *maskp);
1118
1119 extern  __checkReturn   efx_rc_t
1120 efx_mcdi_get_port_assignment(
1121         __in            efx_nic_t *enp,
1122         __out           uint32_t *portp);
1123
1124 extern  __checkReturn   efx_rc_t
1125 efx_mcdi_get_port_modes(
1126         __in            efx_nic_t *enp,
1127         __out           uint32_t *modesp,
1128         __out_opt       uint32_t *current_modep);
1129
1130 extern  __checkReturn   efx_rc_t
1131 ef10_nic_get_port_mode_bandwidth(
1132         __in            uint32_t port_mode,
1133         __out           uint32_t *bandwidth_mbpsp);
1134
1135 extern  __checkReturn   efx_rc_t
1136 efx_mcdi_get_mac_address_pf(
1137         __in                    efx_nic_t *enp,
1138         __out_ecount_opt(6)     uint8_t mac_addrp[6]);
1139
1140 extern  __checkReturn   efx_rc_t
1141 efx_mcdi_get_mac_address_vf(
1142         __in                    efx_nic_t *enp,
1143         __out_ecount_opt(6)     uint8_t mac_addrp[6]);
1144
1145 extern  __checkReturn   efx_rc_t
1146 efx_mcdi_get_clock(
1147         __in            efx_nic_t *enp,
1148         __out           uint32_t *sys_freqp,
1149         __out           uint32_t *dpcpu_freqp);
1150
1151
1152 extern  __checkReturn   efx_rc_t
1153 efx_mcdi_get_vector_cfg(
1154         __in            efx_nic_t *enp,
1155         __out_opt       uint32_t *vec_basep,
1156         __out_opt       uint32_t *pf_nvecp,
1157         __out_opt       uint32_t *vf_nvecp);
1158
1159 extern  __checkReturn   efx_rc_t
1160 ef10_get_datapath_caps(
1161         __in            efx_nic_t *enp);
1162
1163 extern  __checkReturn           efx_rc_t
1164 ef10_get_privilege_mask(
1165         __in                    efx_nic_t *enp,
1166         __out                   uint32_t *maskp);
1167
1168 extern  __checkReturn   efx_rc_t
1169 ef10_external_port_mapping(
1170         __in            efx_nic_t *enp,
1171         __in            uint32_t port,
1172         __out           uint8_t *external_portp);
1173
1174 #if EFSYS_OPT_RX_PACKED_STREAM
1175
1176 /* Data space per credit in packed stream mode */
1177 #define EFX_RX_PACKED_STREAM_MEM_PER_CREDIT (1 << 16)
1178
1179 /*
1180  * Received packets are always aligned at this boundary. Also there always
1181  * exists a gap of this size between packets.
1182  * (see SF-112241-TC, 4.5)
1183  */
1184 #define EFX_RX_PACKED_STREAM_ALIGNMENT 64
1185
1186 /*
1187  * Size of a pseudo-header prepended to received packets
1188  * in packed stream mode
1189  */
1190 #define EFX_RX_PACKED_STREAM_RX_PREFIX_SIZE 8
1191
1192 /* Minimum space for packet in packed stream mode */
1193 #define EFX_RX_PACKED_STREAM_MIN_PACKET_SPACE                \
1194         P2ROUNDUP(EFX_RX_PACKED_STREAM_RX_PREFIX_SIZE +      \
1195                   EFX_MAC_PDU_MIN +                          \
1196                   EFX_RX_PACKED_STREAM_ALIGNMENT,            \
1197                   EFX_RX_PACKED_STREAM_ALIGNMENT)
1198
1199 /* Maximum number of credits */
1200 #define EFX_RX_PACKED_STREAM_MAX_CREDITS 127
1201
1202 #endif /* EFSYS_OPT_RX_PACKED_STREAM */
1203
1204 #ifdef  __cplusplus
1205 }
1206 #endif
1207
1208 #endif  /* _SYS_EF10_IMPL_H */