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