]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/dev/sfxge/common/ef10_impl.h
sfxge(4): add support to get active FEC type
[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_phy_fec_type_t      els_fec;
626         efx_link_mode_t         els_link_mode;
627 #if EFSYS_OPT_LOOPBACK
628         efx_loopback_type_t     els_loopback;
629 #endif
630         boolean_t               els_mac_up;
631 } ef10_link_state_t;
632
633 extern                  void
634 ef10_phy_link_ev(
635         __in            efx_nic_t *enp,
636         __in            efx_qword_t *eqp,
637         __out           efx_link_mode_t *link_modep);
638
639 extern  __checkReturn   efx_rc_t
640 ef10_phy_get_link(
641         __in            efx_nic_t *enp,
642         __out           ef10_link_state_t *elsp);
643
644 extern  __checkReturn   efx_rc_t
645 ef10_phy_power(
646         __in            efx_nic_t *enp,
647         __in            boolean_t on);
648
649 extern  __checkReturn   efx_rc_t
650 ef10_phy_reconfigure(
651         __in            efx_nic_t *enp);
652
653 extern  __checkReturn   efx_rc_t
654 ef10_phy_verify(
655         __in            efx_nic_t *enp);
656
657 extern  __checkReturn   efx_rc_t
658 ef10_phy_oui_get(
659         __in            efx_nic_t *enp,
660         __out           uint32_t *ouip);
661
662 extern  __checkReturn   efx_rc_t
663 ef10_phy_fec_type_get(
664         __in            efx_nic_t *enp,
665         __out           efx_phy_fec_type_t *fecp);
666
667 #if EFSYS_OPT_PHY_STATS
668
669 extern  __checkReturn                   efx_rc_t
670 ef10_phy_stats_update(
671         __in                            efx_nic_t *enp,
672         __in                            efsys_mem_t *esmp,
673         __inout_ecount(EFX_PHY_NSTATS)  uint32_t *stat);
674
675 #endif  /* EFSYS_OPT_PHY_STATS */
676
677 #if EFSYS_OPT_BIST
678
679 extern  __checkReturn           efx_rc_t
680 ef10_bist_enable_offline(
681         __in                    efx_nic_t *enp);
682
683 extern  __checkReturn           efx_rc_t
684 ef10_bist_start(
685         __in                    efx_nic_t *enp,
686         __in                    efx_bist_type_t type);
687
688 extern  __checkReturn           efx_rc_t
689 ef10_bist_poll(
690         __in                    efx_nic_t *enp,
691         __in                    efx_bist_type_t type,
692         __out                   efx_bist_result_t *resultp,
693         __out_opt __drv_when(count > 0, __notnull)
694         uint32_t        *value_maskp,
695         __out_ecount_opt(count) __drv_when(count > 0, __notnull)
696         unsigned long   *valuesp,
697         __in                    size_t count);
698
699 extern                          void
700 ef10_bist_stop(
701         __in                    efx_nic_t *enp,
702         __in                    efx_bist_type_t type);
703
704 #endif  /* EFSYS_OPT_BIST */
705
706 /* TX */
707
708 extern  __checkReturn   efx_rc_t
709 ef10_tx_init(
710         __in            efx_nic_t *enp);
711
712 extern                  void
713 ef10_tx_fini(
714         __in            efx_nic_t *enp);
715
716 extern  __checkReturn   efx_rc_t
717 ef10_tx_qcreate(
718         __in            efx_nic_t *enp,
719         __in            unsigned int index,
720         __in            unsigned int label,
721         __in            efsys_mem_t *esmp,
722         __in            size_t ndescs,
723         __in            uint32_t id,
724         __in            uint16_t flags,
725         __in            efx_evq_t *eep,
726         __in            efx_txq_t *etp,
727         __out           unsigned int *addedp);
728
729 extern          void
730 ef10_tx_qdestroy(
731         __in            efx_txq_t *etp);
732
733 extern  __checkReturn           efx_rc_t
734 ef10_tx_qpost(
735         __in                    efx_txq_t *etp,
736         __in_ecount(ndescs)     efx_buffer_t *ebp,
737         __in                    unsigned int ndescs,
738         __in                    unsigned int completed,
739         __inout                 unsigned int *addedp);
740
741 extern                  void
742 ef10_tx_qpush(
743         __in            efx_txq_t *etp,
744         __in            unsigned int added,
745         __in            unsigned int pushed);
746
747 #if EFSYS_OPT_RX_PACKED_STREAM
748 extern                  void
749 ef10_rx_qpush_ps_credits(
750         __in            efx_rxq_t *erp);
751
752 extern  __checkReturn   uint8_t *
753 ef10_rx_qps_packet_info(
754         __in            efx_rxq_t *erp,
755         __in            uint8_t *buffer,
756         __in            uint32_t buffer_length,
757         __in            uint32_t current_offset,
758         __out           uint16_t *lengthp,
759         __out           uint32_t *next_offsetp,
760         __out           uint32_t *timestamp);
761 #endif
762
763 extern  __checkReturn   efx_rc_t
764 ef10_tx_qpace(
765         __in            efx_txq_t *etp,
766         __in            unsigned int ns);
767
768 extern  __checkReturn   efx_rc_t
769 ef10_tx_qflush(
770         __in            efx_txq_t *etp);
771
772 extern                  void
773 ef10_tx_qenable(
774         __in            efx_txq_t *etp);
775
776 extern  __checkReturn   efx_rc_t
777 ef10_tx_qpio_enable(
778         __in            efx_txq_t *etp);
779
780 extern                  void
781 ef10_tx_qpio_disable(
782         __in            efx_txq_t *etp);
783
784 extern  __checkReturn   efx_rc_t
785 ef10_tx_qpio_write(
786         __in                    efx_txq_t *etp,
787         __in_ecount(buf_length) uint8_t *buffer,
788         __in                    size_t buf_length,
789         __in                    size_t pio_buf_offset);
790
791 extern  __checkReturn   efx_rc_t
792 ef10_tx_qpio_post(
793         __in                    efx_txq_t *etp,
794         __in                    size_t pkt_length,
795         __in                    unsigned int completed,
796         __inout                 unsigned int *addedp);
797
798 extern  __checkReturn   efx_rc_t
799 ef10_tx_qdesc_post(
800         __in            efx_txq_t *etp,
801         __in_ecount(n)  efx_desc_t *ed,
802         __in            unsigned int n,
803         __in            unsigned int completed,
804         __inout         unsigned int *addedp);
805
806 extern  void
807 ef10_tx_qdesc_dma_create(
808         __in    efx_txq_t *etp,
809         __in    efsys_dma_addr_t addr,
810         __in    size_t size,
811         __in    boolean_t eop,
812         __out   efx_desc_t *edp);
813
814 extern  void
815 ef10_tx_qdesc_tso_create(
816         __in    efx_txq_t *etp,
817         __in    uint16_t ipv4_id,
818         __in    uint32_t tcp_seq,
819         __in    uint8_t  tcp_flags,
820         __out   efx_desc_t *edp);
821
822 extern  void
823 ef10_tx_qdesc_tso2_create(
824         __in                    efx_txq_t *etp,
825         __in                    uint16_t ipv4_id,
826         __in                    uint16_t outer_ipv4_id,
827         __in                    uint32_t tcp_seq,
828         __in                    uint16_t tcp_mss,
829         __out_ecount(count)     efx_desc_t *edp,
830         __in                    int count);
831
832 extern  void
833 ef10_tx_qdesc_vlantci_create(
834         __in    efx_txq_t *etp,
835         __in    uint16_t vlan_tci,
836         __out   efx_desc_t *edp);
837
838 extern  void
839 ef10_tx_qdesc_checksum_create(
840         __in    efx_txq_t *etp,
841         __in    uint16_t flags,
842         __out   efx_desc_t *edp);
843
844 #if EFSYS_OPT_QSTATS
845
846 extern                  void
847 ef10_tx_qstats_update(
848         __in                            efx_txq_t *etp,
849         __inout_ecount(TX_NQSTATS)      efsys_stat_t *stat);
850
851 #endif /* EFSYS_OPT_QSTATS */
852
853 typedef uint32_t        efx_piobuf_handle_t;
854
855 #define EFX_PIOBUF_HANDLE_INVALID       ((efx_piobuf_handle_t)-1)
856
857 extern  __checkReturn   efx_rc_t
858 ef10_nic_pio_alloc(
859         __inout         efx_nic_t *enp,
860         __out           uint32_t *bufnump,
861         __out           efx_piobuf_handle_t *handlep,
862         __out           uint32_t *blknump,
863         __out           uint32_t *offsetp,
864         __out           size_t *sizep);
865
866 extern  __checkReturn   efx_rc_t
867 ef10_nic_pio_free(
868         __inout         efx_nic_t *enp,
869         __in            uint32_t bufnum,
870         __in            uint32_t blknum);
871
872 extern  __checkReturn   efx_rc_t
873 ef10_nic_pio_link(
874         __inout         efx_nic_t *enp,
875         __in            uint32_t vi_index,
876         __in            efx_piobuf_handle_t handle);
877
878 extern  __checkReturn   efx_rc_t
879 ef10_nic_pio_unlink(
880         __inout         efx_nic_t *enp,
881         __in            uint32_t vi_index);
882
883
884 /* VPD */
885
886 #if EFSYS_OPT_VPD
887
888 extern  __checkReturn           efx_rc_t
889 ef10_vpd_init(
890         __in                    efx_nic_t *enp);
891
892 extern  __checkReturn           efx_rc_t
893 ef10_vpd_size(
894         __in                    efx_nic_t *enp,
895         __out                   size_t *sizep);
896
897 extern  __checkReturn           efx_rc_t
898 ef10_vpd_read(
899         __in                    efx_nic_t *enp,
900         __out_bcount(size)      caddr_t data,
901         __in                    size_t size);
902
903 extern  __checkReturn           efx_rc_t
904 ef10_vpd_verify(
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_reinit(
911         __in                    efx_nic_t *enp,
912         __in_bcount(size)       caddr_t data,
913         __in                    size_t size);
914
915 extern  __checkReturn           efx_rc_t
916 ef10_vpd_get(
917         __in                    efx_nic_t *enp,
918         __in_bcount(size)       caddr_t data,
919         __in                    size_t size,
920         __inout                 efx_vpd_value_t *evvp);
921
922 extern  __checkReturn           efx_rc_t
923 ef10_vpd_set(
924         __in                    efx_nic_t *enp,
925         __in_bcount(size)       caddr_t data,
926         __in                    size_t size,
927         __in                    efx_vpd_value_t *evvp);
928
929 extern  __checkReturn           efx_rc_t
930 ef10_vpd_next(
931         __in                    efx_nic_t *enp,
932         __in_bcount(size)       caddr_t data,
933         __in                    size_t size,
934         __out                   efx_vpd_value_t *evvp,
935         __inout                 unsigned int *contp);
936
937 extern __checkReturn            efx_rc_t
938 ef10_vpd_write(
939         __in                    efx_nic_t *enp,
940         __in_bcount(size)       caddr_t data,
941         __in                    size_t size);
942
943 extern                          void
944 ef10_vpd_fini(
945         __in                    efx_nic_t *enp);
946
947 #endif  /* EFSYS_OPT_VPD */
948
949
950 /* RX */
951
952 extern  __checkReturn   efx_rc_t
953 ef10_rx_init(
954         __in            efx_nic_t *enp);
955
956 #if EFSYS_OPT_RX_SCATTER
957 extern  __checkReturn   efx_rc_t
958 ef10_rx_scatter_enable(
959         __in            efx_nic_t *enp,
960         __in            unsigned int buf_size);
961 #endif  /* EFSYS_OPT_RX_SCATTER */
962
963
964 #if EFSYS_OPT_RX_SCALE
965
966 extern  __checkReturn   efx_rc_t
967 ef10_rx_scale_context_alloc(
968         __in            efx_nic_t *enp,
969         __in            efx_rx_scale_context_type_t type,
970         __in            uint32_t num_queues,
971         __out           uint32_t *rss_contextp);
972
973 extern  __checkReturn   efx_rc_t
974 ef10_rx_scale_context_free(
975         __in            efx_nic_t *enp,
976         __in            uint32_t rss_context);
977
978 extern  __checkReturn   efx_rc_t
979 ef10_rx_scale_mode_set(
980         __in            efx_nic_t *enp,
981         __in            uint32_t rss_context,
982         __in            efx_rx_hash_alg_t alg,
983         __in            efx_rx_hash_type_t type,
984         __in            boolean_t insert);
985
986 extern  __checkReturn   efx_rc_t
987 ef10_rx_scale_key_set(
988         __in            efx_nic_t *enp,
989         __in            uint32_t rss_context,
990         __in_ecount(n)  uint8_t *key,
991         __in            size_t n);
992
993 extern  __checkReturn   efx_rc_t
994 ef10_rx_scale_tbl_set(
995         __in            efx_nic_t *enp,
996         __in            uint32_t rss_context,
997         __in_ecount(n)  unsigned int *table,
998         __in            size_t n);
999
1000 extern  __checkReturn   uint32_t
1001 ef10_rx_prefix_hash(
1002         __in            efx_nic_t *enp,
1003         __in            efx_rx_hash_alg_t func,
1004         __in            uint8_t *buffer);
1005
1006 #endif /* EFSYS_OPT_RX_SCALE */
1007
1008 extern  __checkReturn   efx_rc_t
1009 ef10_rx_prefix_pktlen(
1010         __in            efx_nic_t *enp,
1011         __in            uint8_t *buffer,
1012         __out           uint16_t *lengthp);
1013
1014 extern                          void
1015 ef10_rx_qpost(
1016         __in                    efx_rxq_t *erp,
1017         __in_ecount(ndescs)     efsys_dma_addr_t *addrp,
1018         __in                    size_t size,
1019         __in                    unsigned int ndescs,
1020         __in                    unsigned int completed,
1021         __in                    unsigned int added);
1022
1023 extern                  void
1024 ef10_rx_qpush(
1025         __in            efx_rxq_t *erp,
1026         __in            unsigned int added,
1027         __inout         unsigned int *pushedp);
1028
1029 extern  __checkReturn   efx_rc_t
1030 ef10_rx_qflush(
1031         __in            efx_rxq_t *erp);
1032
1033 extern          void
1034 ef10_rx_qenable(
1035         __in            efx_rxq_t *erp);
1036
1037 union efx_rxq_type_data_u;
1038
1039 extern  __checkReturn   efx_rc_t
1040 ef10_rx_qcreate(
1041         __in            efx_nic_t *enp,
1042         __in            unsigned int index,
1043         __in            unsigned int label,
1044         __in            efx_rxq_type_t type,
1045         __in            const union efx_rxq_type_data_u *type_data,
1046         __in            efsys_mem_t *esmp,
1047         __in            size_t ndescs,
1048         __in            uint32_t id,
1049         __in            unsigned int flags,
1050         __in            efx_evq_t *eep,
1051         __in            efx_rxq_t *erp);
1052
1053 extern                  void
1054 ef10_rx_qdestroy(
1055         __in            efx_rxq_t *erp);
1056
1057 extern                  void
1058 ef10_rx_fini(
1059         __in            efx_nic_t *enp);
1060
1061 #if EFSYS_OPT_FILTER
1062
1063 typedef struct ef10_filter_handle_s {
1064         uint32_t        efh_lo;
1065         uint32_t        efh_hi;
1066 } ef10_filter_handle_t;
1067
1068 typedef struct ef10_filter_entry_s {
1069         uintptr_t efe_spec; /* pointer to filter spec plus busy bit */
1070         ef10_filter_handle_t efe_handle;
1071 } ef10_filter_entry_t;
1072
1073 /*
1074  * BUSY flag indicates that an update is in progress.
1075  * AUTO_OLD flag is used to mark and sweep MAC packet filters.
1076  */
1077 #define EFX_EF10_FILTER_FLAG_BUSY       1U
1078 #define EFX_EF10_FILTER_FLAG_AUTO_OLD   2U
1079 #define EFX_EF10_FILTER_FLAGS           3U
1080
1081 /*
1082  * Size of the hash table used by the driver. Doesn't need to be the
1083  * same size as the hardware's table.
1084  */
1085 #define EFX_EF10_FILTER_TBL_ROWS 8192
1086
1087 /* Only need to allow for one directed and one unknown unicast filter */
1088 #define EFX_EF10_FILTER_UNICAST_FILTERS_MAX     2
1089
1090 /* Allow for the broadcast address to be added to the multicast list */
1091 #define EFX_EF10_FILTER_MULTICAST_FILTERS_MAX   (EFX_MAC_MULTICAST_LIST_MAX + 1)
1092
1093 /*
1094  * For encapsulated packets, there is one filter each for each combination of
1095  * IPv4 or IPv6 outer frame, VXLAN, GENEVE or NVGRE packet type, and unicast or
1096  * multicast inner frames.
1097  */
1098 #define EFX_EF10_FILTER_ENCAP_FILTERS_MAX       12
1099
1100 typedef struct ef10_filter_table_s {
1101         ef10_filter_entry_t     eft_entry[EFX_EF10_FILTER_TBL_ROWS];
1102         efx_rxq_t               *eft_default_rxq;
1103         boolean_t               eft_using_rss;
1104         uint32_t                eft_unicst_filter_indexes[
1105             EFX_EF10_FILTER_UNICAST_FILTERS_MAX];
1106         uint32_t                eft_unicst_filter_count;
1107         uint32_t                eft_mulcst_filter_indexes[
1108             EFX_EF10_FILTER_MULTICAST_FILTERS_MAX];
1109         uint32_t                eft_mulcst_filter_count;
1110         boolean_t               eft_using_all_mulcst;
1111         uint32_t                eft_encap_filter_indexes[
1112             EFX_EF10_FILTER_ENCAP_FILTERS_MAX];
1113         uint32_t                eft_encap_filter_count;
1114 } ef10_filter_table_t;
1115
1116         __checkReturn   efx_rc_t
1117 ef10_filter_init(
1118         __in            efx_nic_t *enp);
1119
1120                         void
1121 ef10_filter_fini(
1122         __in            efx_nic_t *enp);
1123
1124         __checkReturn   efx_rc_t
1125 ef10_filter_restore(
1126         __in            efx_nic_t *enp);
1127
1128         __checkReturn   efx_rc_t
1129 ef10_filter_add(
1130         __in            efx_nic_t *enp,
1131         __inout         efx_filter_spec_t *spec,
1132         __in            boolean_t may_replace);
1133
1134         __checkReturn   efx_rc_t
1135 ef10_filter_delete(
1136         __in            efx_nic_t *enp,
1137         __inout         efx_filter_spec_t *spec);
1138
1139 extern  __checkReturn   efx_rc_t
1140 ef10_filter_supported_filters(
1141         __in                            efx_nic_t *enp,
1142         __out_ecount(buffer_length)     uint32_t *buffer,
1143         __in                            size_t buffer_length,
1144         __out                           size_t *list_lengthp);
1145
1146 extern  __checkReturn   efx_rc_t
1147 ef10_filter_reconfigure(
1148         __in                            efx_nic_t *enp,
1149         __in_ecount(6)                  uint8_t const *mac_addr,
1150         __in                            boolean_t all_unicst,
1151         __in                            boolean_t mulcst,
1152         __in                            boolean_t all_mulcst,
1153         __in                            boolean_t brdcst,
1154         __in_ecount(6*count)            uint8_t const *addrs,
1155         __in                            uint32_t count);
1156
1157 extern          void
1158 ef10_filter_get_default_rxq(
1159         __in            efx_nic_t *enp,
1160         __out           efx_rxq_t **erpp,
1161         __out           boolean_t *using_rss);
1162
1163 extern          void
1164 ef10_filter_default_rxq_set(
1165         __in            efx_nic_t *enp,
1166         __in            efx_rxq_t *erp,
1167         __in            boolean_t using_rss);
1168
1169 extern          void
1170 ef10_filter_default_rxq_clear(
1171         __in            efx_nic_t *enp);
1172
1173
1174 #endif /* EFSYS_OPT_FILTER */
1175
1176 extern  __checkReturn                   efx_rc_t
1177 efx_mcdi_get_function_info(
1178         __in                            efx_nic_t *enp,
1179         __out                           uint32_t *pfp,
1180         __out_opt                       uint32_t *vfp);
1181
1182 extern  __checkReturn           efx_rc_t
1183 efx_mcdi_privilege_mask(
1184         __in                    efx_nic_t *enp,
1185         __in                    uint32_t pf,
1186         __in                    uint32_t vf,
1187         __out                   uint32_t *maskp);
1188
1189 extern  __checkReturn   efx_rc_t
1190 efx_mcdi_get_port_assignment(
1191         __in            efx_nic_t *enp,
1192         __out           uint32_t *portp);
1193
1194 extern  __checkReturn   efx_rc_t
1195 efx_mcdi_get_port_modes(
1196         __in            efx_nic_t *enp,
1197         __out           uint32_t *modesp,
1198         __out_opt       uint32_t *current_modep,
1199         __out_opt       uint32_t *default_modep);
1200
1201 extern  __checkReturn   efx_rc_t
1202 ef10_nic_get_port_mode_bandwidth(
1203         __in            uint32_t port_mode,
1204         __out           uint32_t *bandwidth_mbpsp);
1205
1206 extern  __checkReturn   efx_rc_t
1207 efx_mcdi_get_mac_address_pf(
1208         __in                    efx_nic_t *enp,
1209         __out_ecount_opt(6)     uint8_t mac_addrp[6]);
1210
1211 extern  __checkReturn   efx_rc_t
1212 efx_mcdi_get_mac_address_vf(
1213         __in                    efx_nic_t *enp,
1214         __out_ecount_opt(6)     uint8_t mac_addrp[6]);
1215
1216 extern  __checkReturn   efx_rc_t
1217 efx_mcdi_get_clock(
1218         __in            efx_nic_t *enp,
1219         __out           uint32_t *sys_freqp,
1220         __out           uint32_t *dpcpu_freqp);
1221
1222
1223 extern  __checkReturn   efx_rc_t
1224 efx_mcdi_get_rxdp_config(
1225         __in            efx_nic_t *enp,
1226         __out           uint32_t *end_paddingp);
1227
1228 extern  __checkReturn   efx_rc_t
1229 efx_mcdi_get_vector_cfg(
1230         __in            efx_nic_t *enp,
1231         __out_opt       uint32_t *vec_basep,
1232         __out_opt       uint32_t *pf_nvecp,
1233         __out_opt       uint32_t *vf_nvecp);
1234
1235 extern  __checkReturn           efx_rc_t
1236 ef10_get_privilege_mask(
1237         __in                    efx_nic_t *enp,
1238         __out                   uint32_t *maskp);
1239
1240 #if EFSYS_OPT_FW_SUBVARIANT_AWARE
1241
1242 extern  __checkReturn   efx_rc_t
1243 efx_mcdi_get_nic_global(
1244         __in            efx_nic_t *enp,
1245         __in            uint32_t key,
1246         __out           uint32_t *valuep);
1247
1248 extern  __checkReturn   efx_rc_t
1249 efx_mcdi_set_nic_global(
1250         __in            efx_nic_t *enp,
1251         __in            uint32_t key,
1252         __in            uint32_t value);
1253
1254 #endif  /* EFSYS_OPT_FW_SUBVARIANT_AWARE */
1255
1256
1257 #if EFSYS_OPT_RX_PACKED_STREAM
1258
1259 /* Data space per credit in packed stream mode */
1260 #define EFX_RX_PACKED_STREAM_MEM_PER_CREDIT (1 << 16)
1261
1262 /*
1263  * Received packets are always aligned at this boundary. Also there always
1264  * exists a gap of this size between packets.
1265  * (see SF-112241-TC, 4.5)
1266  */
1267 #define EFX_RX_PACKED_STREAM_ALIGNMENT 64
1268
1269 /*
1270  * Size of a pseudo-header prepended to received packets
1271  * in packed stream mode
1272  */
1273 #define EFX_RX_PACKED_STREAM_RX_PREFIX_SIZE 8
1274
1275 /* Minimum space for packet in packed stream mode */
1276 #define EFX_RX_PACKED_STREAM_MIN_PACKET_SPACE                \
1277         P2ROUNDUP(EFX_RX_PACKED_STREAM_RX_PREFIX_SIZE +      \
1278             EFX_MAC_PDU_MIN +                                \
1279             EFX_RX_PACKED_STREAM_ALIGNMENT,                  \
1280             EFX_RX_PACKED_STREAM_ALIGNMENT)
1281
1282 /* Maximum number of credits */
1283 #define EFX_RX_PACKED_STREAM_MAX_CREDITS 127
1284
1285 #endif /* EFSYS_OPT_RX_PACKED_STREAM */
1286
1287 #if EFSYS_OPT_RX_ES_SUPER_BUFFER
1288
1289 /*
1290  * Maximum DMA length and buffer stride alignment.
1291  * (see SF-119419-TC, 3.2)
1292  */
1293 #define EFX_RX_ES_SUPER_BUFFER_BUF_ALIGNMENT    64
1294
1295 #endif
1296
1297 #ifdef  __cplusplus
1298 }
1299 #endif
1300
1301 #endif  /* _SYS_EF10_IMPL_H */