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