drivers/net/sfc/base/ef10_impl.h

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