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