2 * Copyright (c) 2007-2016 Solarflare Communications Inc.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
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.
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.
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.
31 #ifndef _SYS_EFX_IMPL_H
32 #define _SYS_EFX_IMPL_H
36 #include "efx_regs_ef10.h"
38 /* FIXME: Add definition for driver generated software events */
39 #ifndef ESE_DZ_EV_CODE_DRV_GEN_EV
40 #define ESE_DZ_EV_CODE_DRV_GEN_EV FSE_AZ_EV_CODE_DRV_GEN_EV
45 #include "siena_impl.h"
46 #endif /* EFSYS_OPT_SIENA */
48 #if EFSYS_OPT_HUNTINGTON
49 #include "hunt_impl.h"
50 #endif /* EFSYS_OPT_HUNTINGTON */
53 #include "medford_impl.h"
54 #endif /* EFSYS_OPT_MEDFORD */
56 #if (EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD)
57 #include "ef10_impl.h"
58 #endif /* (EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD) */
64 #define EFX_MOD_MCDI 0x00000001
65 #define EFX_MOD_PROBE 0x00000002
66 #define EFX_MOD_NVRAM 0x00000004
67 #define EFX_MOD_VPD 0x00000008
68 #define EFX_MOD_NIC 0x00000010
69 #define EFX_MOD_INTR 0x00000020
70 #define EFX_MOD_EV 0x00000040
71 #define EFX_MOD_RX 0x00000080
72 #define EFX_MOD_TX 0x00000100
73 #define EFX_MOD_PORT 0x00000200
74 #define EFX_MOD_MON 0x00000400
75 #define EFX_MOD_FILTER 0x00001000
76 #define EFX_MOD_LIC 0x00002000
78 #define EFX_RESET_PHY 0x00000001
79 #define EFX_RESET_RXQ_ERR 0x00000002
80 #define EFX_RESET_TXQ_ERR 0x00000004
82 typedef enum efx_mac_type_e {
90 typedef struct efx_ev_ops_s {
91 efx_rc_t (*eevo_init)(efx_nic_t *);
92 void (*eevo_fini)(efx_nic_t *);
93 efx_rc_t (*eevo_qcreate)(efx_nic_t *, unsigned int,
94 efsys_mem_t *, size_t, uint32_t,
95 uint32_t, uint32_t, efx_evq_t *);
96 void (*eevo_qdestroy)(efx_evq_t *);
97 efx_rc_t (*eevo_qprime)(efx_evq_t *, unsigned int);
98 void (*eevo_qpost)(efx_evq_t *, uint16_t);
99 efx_rc_t (*eevo_qmoderate)(efx_evq_t *, unsigned int);
101 void (*eevo_qstats_update)(efx_evq_t *, efsys_stat_t *);
105 typedef struct efx_tx_ops_s {
106 efx_rc_t (*etxo_init)(efx_nic_t *);
107 void (*etxo_fini)(efx_nic_t *);
108 efx_rc_t (*etxo_qcreate)(efx_nic_t *,
109 unsigned int, unsigned int,
110 efsys_mem_t *, size_t,
112 efx_evq_t *, efx_txq_t *,
114 void (*etxo_qdestroy)(efx_txq_t *);
115 efx_rc_t (*etxo_qpost)(efx_txq_t *, efx_buffer_t *,
116 unsigned int, unsigned int,
118 void (*etxo_qpush)(efx_txq_t *, unsigned int, unsigned int);
119 efx_rc_t (*etxo_qpace)(efx_txq_t *, unsigned int);
120 efx_rc_t (*etxo_qflush)(efx_txq_t *);
121 void (*etxo_qenable)(efx_txq_t *);
122 efx_rc_t (*etxo_qpio_enable)(efx_txq_t *);
123 void (*etxo_qpio_disable)(efx_txq_t *);
124 efx_rc_t (*etxo_qpio_write)(efx_txq_t *, uint8_t *, size_t,
126 efx_rc_t (*etxo_qpio_post)(efx_txq_t *, size_t, unsigned int,
128 efx_rc_t (*etxo_qdesc_post)(efx_txq_t *, efx_desc_t *,
129 unsigned int, unsigned int,
131 void (*etxo_qdesc_dma_create)(efx_txq_t *, efsys_dma_addr_t,
134 void (*etxo_qdesc_tso_create)(efx_txq_t *, uint16_t,
137 void (*etxo_qdesc_tso2_create)(efx_txq_t *, uint16_t,
140 void (*etxo_qdesc_vlantci_create)(efx_txq_t *, uint16_t,
143 void (*etxo_qstats_update)(efx_txq_t *,
148 typedef struct efx_rx_ops_s {
149 efx_rc_t (*erxo_init)(efx_nic_t *);
150 void (*erxo_fini)(efx_nic_t *);
151 #if EFSYS_OPT_RX_SCATTER
152 efx_rc_t (*erxo_scatter_enable)(efx_nic_t *, unsigned int);
154 #if EFSYS_OPT_RX_SCALE
155 efx_rc_t (*erxo_scale_mode_set)(efx_nic_t *, efx_rx_hash_alg_t,
156 efx_rx_hash_type_t, boolean_t);
157 efx_rc_t (*erxo_scale_key_set)(efx_nic_t *, uint8_t *, size_t);
158 efx_rc_t (*erxo_scale_tbl_set)(efx_nic_t *, unsigned int *,
160 uint32_t (*erxo_prefix_hash)(efx_nic_t *, efx_rx_hash_alg_t,
162 #endif /* EFSYS_OPT_RX_SCALE */
163 efx_rc_t (*erxo_prefix_pktlen)(efx_nic_t *, uint8_t *,
165 void (*erxo_qpost)(efx_rxq_t *, efsys_dma_addr_t *, size_t,
166 unsigned int, unsigned int,
168 void (*erxo_qpush)(efx_rxq_t *, unsigned int, unsigned int *);
169 #if EFSYS_OPT_RX_PACKED_STREAM
170 void (*erxo_qps_update_credits)(efx_rxq_t *);
171 uint8_t * (*erxo_qps_packet_info)(efx_rxq_t *, uint8_t *,
173 uint16_t *, uint32_t *, uint32_t *);
175 efx_rc_t (*erxo_qflush)(efx_rxq_t *);
176 void (*erxo_qenable)(efx_rxq_t *);
177 efx_rc_t (*erxo_qcreate)(efx_nic_t *enp, unsigned int,
178 unsigned int, efx_rxq_type_t,
179 efsys_mem_t *, size_t, uint32_t,
180 efx_evq_t *, efx_rxq_t *);
181 void (*erxo_qdestroy)(efx_rxq_t *);
184 typedef struct efx_mac_ops_s {
185 efx_rc_t (*emo_poll)(efx_nic_t *, efx_link_mode_t *);
186 efx_rc_t (*emo_up)(efx_nic_t *, boolean_t *);
187 efx_rc_t (*emo_addr_set)(efx_nic_t *);
188 efx_rc_t (*emo_pdu_set)(efx_nic_t *);
189 efx_rc_t (*emo_pdu_get)(efx_nic_t *, size_t *);
190 efx_rc_t (*emo_reconfigure)(efx_nic_t *);
191 efx_rc_t (*emo_multicast_list_set)(efx_nic_t *);
192 efx_rc_t (*emo_filter_default_rxq_set)(efx_nic_t *,
193 efx_rxq_t *, boolean_t);
194 void (*emo_filter_default_rxq_clear)(efx_nic_t *);
195 #if EFSYS_OPT_LOOPBACK
196 efx_rc_t (*emo_loopback_set)(efx_nic_t *, efx_link_mode_t,
197 efx_loopback_type_t);
198 #endif /* EFSYS_OPT_LOOPBACK */
199 #if EFSYS_OPT_MAC_STATS
200 efx_rc_t (*emo_stats_get_mask)(efx_nic_t *, uint32_t *, size_t);
201 efx_rc_t (*emo_stats_clear)(efx_nic_t *);
202 efx_rc_t (*emo_stats_upload)(efx_nic_t *, efsys_mem_t *);
203 efx_rc_t (*emo_stats_periodic)(efx_nic_t *, efsys_mem_t *,
204 uint16_t, boolean_t);
205 efx_rc_t (*emo_stats_update)(efx_nic_t *, efsys_mem_t *,
206 efsys_stat_t *, uint32_t *);
207 #endif /* EFSYS_OPT_MAC_STATS */
210 typedef struct efx_phy_ops_s {
211 efx_rc_t (*epo_power)(efx_nic_t *, boolean_t); /* optional */
212 efx_rc_t (*epo_reset)(efx_nic_t *);
213 efx_rc_t (*epo_reconfigure)(efx_nic_t *);
214 efx_rc_t (*epo_verify)(efx_nic_t *);
215 efx_rc_t (*epo_oui_get)(efx_nic_t *, uint32_t *);
216 #if EFSYS_OPT_PHY_STATS
217 efx_rc_t (*epo_stats_update)(efx_nic_t *, efsys_mem_t *,
219 #endif /* EFSYS_OPT_PHY_STATS */
221 efx_rc_t (*epo_bist_enable_offline)(efx_nic_t *);
222 efx_rc_t (*epo_bist_start)(efx_nic_t *, efx_bist_type_t);
223 efx_rc_t (*epo_bist_poll)(efx_nic_t *, efx_bist_type_t,
224 efx_bist_result_t *, uint32_t *,
225 unsigned long *, size_t);
226 void (*epo_bist_stop)(efx_nic_t *, efx_bist_type_t);
227 #endif /* EFSYS_OPT_BIST */
231 typedef struct efx_filter_ops_s {
232 efx_rc_t (*efo_init)(efx_nic_t *);
233 void (*efo_fini)(efx_nic_t *);
234 efx_rc_t (*efo_restore)(efx_nic_t *);
235 efx_rc_t (*efo_add)(efx_nic_t *, efx_filter_spec_t *,
236 boolean_t may_replace);
237 efx_rc_t (*efo_delete)(efx_nic_t *, efx_filter_spec_t *);
238 efx_rc_t (*efo_supported_filters)(efx_nic_t *, uint32_t *,
240 efx_rc_t (*efo_reconfigure)(efx_nic_t *, uint8_t const *, boolean_t,
241 boolean_t, boolean_t, boolean_t,
242 uint8_t const *, uint32_t);
245 extern __checkReturn efx_rc_t
246 efx_filter_reconfigure(
248 __in_ecount(6) uint8_t const *mac_addr,
249 __in boolean_t all_unicst,
250 __in boolean_t mulcst,
251 __in boolean_t all_mulcst,
252 __in boolean_t brdcst,
253 __in_ecount(6*count) uint8_t const *addrs,
254 __in uint32_t count);
256 #endif /* EFSYS_OPT_FILTER */
259 typedef struct efx_port_s {
260 efx_mac_type_t ep_mac_type;
261 uint32_t ep_phy_type;
264 uint8_t ep_mac_addr[6];
265 efx_link_mode_t ep_link_mode;
266 boolean_t ep_all_unicst;
268 boolean_t ep_all_mulcst;
270 unsigned int ep_fcntl;
271 boolean_t ep_fcntl_autoneg;
272 efx_oword_t ep_multicst_hash[2];
273 uint8_t ep_mulcst_addr_list[EFX_MAC_ADDR_LEN *
274 EFX_MAC_MULTICAST_LIST_MAX];
275 uint32_t ep_mulcst_addr_count;
276 #if EFSYS_OPT_LOOPBACK
277 efx_loopback_type_t ep_loopback_type;
278 efx_link_mode_t ep_loopback_link_mode;
279 #endif /* EFSYS_OPT_LOOPBACK */
280 #if EFSYS_OPT_PHY_FLAGS
281 uint32_t ep_phy_flags;
282 #endif /* EFSYS_OPT_PHY_FLAGS */
283 #if EFSYS_OPT_PHY_LED_CONTROL
284 efx_phy_led_mode_t ep_phy_led_mode;
285 #endif /* EFSYS_OPT_PHY_LED_CONTROL */
286 efx_phy_media_type_t ep_fixed_port_type;
287 efx_phy_media_type_t ep_module_type;
288 uint32_t ep_adv_cap_mask;
289 uint32_t ep_lp_cap_mask;
290 uint32_t ep_default_adv_cap_mask;
291 uint32_t ep_phy_cap_mask;
292 boolean_t ep_mac_drain;
293 boolean_t ep_mac_stats_pending;
295 efx_bist_type_t ep_current_bist;
297 const efx_mac_ops_t *ep_emop;
298 const efx_phy_ops_t *ep_epop;
301 typedef struct efx_mon_ops_s {
302 #if EFSYS_OPT_MON_STATS
303 efx_rc_t (*emo_stats_update)(efx_nic_t *, efsys_mem_t *,
304 efx_mon_stat_value_t *);
305 #endif /* EFSYS_OPT_MON_STATS */
308 typedef struct efx_mon_s {
309 efx_mon_type_t em_type;
310 const efx_mon_ops_t *em_emop;
313 typedef struct efx_intr_ops_s {
314 efx_rc_t (*eio_init)(efx_nic_t *, efx_intr_type_t, efsys_mem_t *);
315 void (*eio_enable)(efx_nic_t *);
316 void (*eio_disable)(efx_nic_t *);
317 void (*eio_disable_unlocked)(efx_nic_t *);
318 efx_rc_t (*eio_trigger)(efx_nic_t *, unsigned int);
319 void (*eio_status_line)(efx_nic_t *, boolean_t *, uint32_t *);
320 void (*eio_status_message)(efx_nic_t *, unsigned int,
322 void (*eio_fatal)(efx_nic_t *);
323 void (*eio_fini)(efx_nic_t *);
326 typedef struct efx_intr_s {
327 const efx_intr_ops_t *ei_eiop;
328 efsys_mem_t *ei_esmp;
329 efx_intr_type_t ei_type;
330 unsigned int ei_level;
333 typedef struct efx_nic_ops_s {
334 efx_rc_t (*eno_probe)(efx_nic_t *);
335 efx_rc_t (*eno_board_cfg)(efx_nic_t *);
336 efx_rc_t (*eno_set_drv_limits)(efx_nic_t *, efx_drv_limits_t*);
337 efx_rc_t (*eno_reset)(efx_nic_t *);
338 efx_rc_t (*eno_init)(efx_nic_t *);
339 efx_rc_t (*eno_get_vi_pool)(efx_nic_t *, uint32_t *);
340 efx_rc_t (*eno_get_bar_region)(efx_nic_t *, efx_nic_region_t,
341 uint32_t *, size_t *);
343 efx_rc_t (*eno_register_test)(efx_nic_t *);
344 #endif /* EFSYS_OPT_DIAG */
345 void (*eno_fini)(efx_nic_t *);
346 void (*eno_unprobe)(efx_nic_t *);
349 #ifndef EFX_TXQ_LIMIT_TARGET
350 #define EFX_TXQ_LIMIT_TARGET 259
352 #ifndef EFX_RXQ_LIMIT_TARGET
353 #define EFX_RXQ_LIMIT_TARGET 512
355 #ifndef EFX_TXQ_DC_SIZE
356 #define EFX_TXQ_DC_SIZE 1 /* 16 descriptors */
358 #ifndef EFX_RXQ_DC_SIZE
359 #define EFX_RXQ_DC_SIZE 3 /* 64 descriptors */
366 typedef struct siena_filter_spec_s {
369 uint32_t sfs_dmaq_id;
370 uint32_t sfs_dword[3];
371 } siena_filter_spec_t;
373 typedef enum siena_filter_type_e {
374 EFX_SIENA_FILTER_RX_TCP_FULL, /* TCP/IPv4 {dIP,dTCP,sIP,sTCP} */
375 EFX_SIENA_FILTER_RX_TCP_WILD, /* TCP/IPv4 {dIP,dTCP, -, -} */
376 EFX_SIENA_FILTER_RX_UDP_FULL, /* UDP/IPv4 {dIP,dUDP,sIP,sUDP} */
377 EFX_SIENA_FILTER_RX_UDP_WILD, /* UDP/IPv4 {dIP,dUDP, -, -} */
378 EFX_SIENA_FILTER_RX_MAC_FULL, /* Ethernet {dMAC,VLAN} */
379 EFX_SIENA_FILTER_RX_MAC_WILD, /* Ethernet {dMAC, -} */
381 EFX_SIENA_FILTER_TX_TCP_FULL, /* TCP/IPv4 {dIP,dTCP,sIP,sTCP} */
382 EFX_SIENA_FILTER_TX_TCP_WILD, /* TCP/IPv4 { -, -,sIP,sTCP} */
383 EFX_SIENA_FILTER_TX_UDP_FULL, /* UDP/IPv4 {dIP,dTCP,sIP,sTCP} */
384 EFX_SIENA_FILTER_TX_UDP_WILD, /* UDP/IPv4 { -, -,sIP,sUDP} */
385 EFX_SIENA_FILTER_TX_MAC_FULL, /* Ethernet {sMAC,VLAN} */
386 EFX_SIENA_FILTER_TX_MAC_WILD, /* Ethernet {sMAC, -} */
388 EFX_SIENA_FILTER_NTYPES
389 } siena_filter_type_t;
391 typedef enum siena_filter_tbl_id_e {
392 EFX_SIENA_FILTER_TBL_RX_IP = 0,
393 EFX_SIENA_FILTER_TBL_RX_MAC,
394 EFX_SIENA_FILTER_TBL_TX_IP,
395 EFX_SIENA_FILTER_TBL_TX_MAC,
396 EFX_SIENA_FILTER_NTBLS
397 } siena_filter_tbl_id_t;
399 typedef struct siena_filter_tbl_s {
400 int sft_size; /* number of entries */
401 int sft_used; /* active count */
402 uint32_t *sft_bitmap; /* active bitmap */
403 siena_filter_spec_t *sft_spec; /* array of saved specs */
404 } siena_filter_tbl_t;
406 typedef struct siena_filter_s {
407 siena_filter_tbl_t sf_tbl[EFX_SIENA_FILTER_NTBLS];
408 unsigned int sf_depth[EFX_SIENA_FILTER_NTYPES];
411 #endif /* EFSYS_OPT_SIENA */
413 typedef struct efx_filter_s {
415 siena_filter_t *ef_siena_filter;
416 #endif /* EFSYS_OPT_SIENA */
417 #if EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD
418 ef10_filter_table_t *ef_ef10_filter_table;
419 #endif /* EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD */
425 siena_filter_tbl_clear(
427 __in siena_filter_tbl_id_t tbl);
429 #endif /* EFSYS_OPT_SIENA */
431 #endif /* EFSYS_OPT_FILTER */
435 typedef struct efx_mcdi_ops_s {
436 efx_rc_t (*emco_init)(efx_nic_t *, const efx_mcdi_transport_t *);
437 void (*emco_send_request)(efx_nic_t *, void *, size_t,
439 efx_rc_t (*emco_poll_reboot)(efx_nic_t *);
440 boolean_t (*emco_poll_response)(efx_nic_t *);
441 void (*emco_read_response)(efx_nic_t *, void *, size_t, size_t);
442 void (*emco_fini)(efx_nic_t *);
443 efx_rc_t (*emco_feature_supported)(efx_nic_t *,
444 efx_mcdi_feature_id_t, boolean_t *);
445 void (*emco_get_timeout)(efx_nic_t *, efx_mcdi_req_t *,
449 typedef struct efx_mcdi_s {
450 const efx_mcdi_ops_t *em_emcop;
451 const efx_mcdi_transport_t *em_emtp;
452 efx_mcdi_iface_t em_emip;
455 #endif /* EFSYS_OPT_MCDI */
458 typedef struct efx_nvram_ops_s {
460 efx_rc_t (*envo_test)(efx_nic_t *);
461 #endif /* EFSYS_OPT_DIAG */
462 efx_rc_t (*envo_type_to_partn)(efx_nic_t *, efx_nvram_type_t,
464 efx_rc_t (*envo_partn_size)(efx_nic_t *, uint32_t, size_t *);
465 efx_rc_t (*envo_partn_rw_start)(efx_nic_t *, uint32_t, size_t *);
466 efx_rc_t (*envo_partn_read)(efx_nic_t *, uint32_t,
467 unsigned int, caddr_t, size_t);
468 efx_rc_t (*envo_partn_erase)(efx_nic_t *, uint32_t,
469 unsigned int, size_t);
470 efx_rc_t (*envo_partn_write)(efx_nic_t *, uint32_t,
471 unsigned int, caddr_t, size_t);
472 efx_rc_t (*envo_partn_rw_finish)(efx_nic_t *, uint32_t);
473 efx_rc_t (*envo_partn_get_version)(efx_nic_t *, uint32_t,
474 uint32_t *, uint16_t *);
475 efx_rc_t (*envo_partn_set_version)(efx_nic_t *, uint32_t,
477 efx_rc_t (*envo_buffer_validate)(efx_nic_t *, uint32_t,
480 #endif /* EFSYS_OPT_NVRAM */
483 typedef struct efx_vpd_ops_s {
484 efx_rc_t (*evpdo_init)(efx_nic_t *);
485 efx_rc_t (*evpdo_size)(efx_nic_t *, size_t *);
486 efx_rc_t (*evpdo_read)(efx_nic_t *, caddr_t, size_t);
487 efx_rc_t (*evpdo_verify)(efx_nic_t *, caddr_t, size_t);
488 efx_rc_t (*evpdo_reinit)(efx_nic_t *, caddr_t, size_t);
489 efx_rc_t (*evpdo_get)(efx_nic_t *, caddr_t, size_t,
491 efx_rc_t (*evpdo_set)(efx_nic_t *, caddr_t, size_t,
493 efx_rc_t (*evpdo_next)(efx_nic_t *, caddr_t, size_t,
494 efx_vpd_value_t *, unsigned int *);
495 efx_rc_t (*evpdo_write)(efx_nic_t *, caddr_t, size_t);
496 void (*evpdo_fini)(efx_nic_t *);
498 #endif /* EFSYS_OPT_VPD */
500 #if EFSYS_OPT_VPD || EFSYS_OPT_NVRAM
502 __checkReturn efx_rc_t
503 efx_mcdi_nvram_partitions(
505 __out_bcount(size) caddr_t data,
507 __out unsigned int *npartnp);
509 __checkReturn efx_rc_t
510 efx_mcdi_nvram_metadata(
513 __out uint32_t *subtypep,
514 __out_ecount(4) uint16_t version[4],
515 __out_bcount_opt(size) char *descp,
518 __checkReturn efx_rc_t
522 __out_opt size_t *sizep,
523 __out_opt uint32_t *addressp,
524 __out_opt uint32_t *erase_sizep,
525 __out_opt uint32_t *write_sizep);
527 __checkReturn efx_rc_t
528 efx_mcdi_nvram_update_start(
530 __in uint32_t partn);
532 __checkReturn efx_rc_t
536 __in uint32_t offset,
537 __out_bcount(size) caddr_t data,
541 __checkReturn efx_rc_t
542 efx_mcdi_nvram_erase(
545 __in uint32_t offset,
548 __checkReturn efx_rc_t
549 efx_mcdi_nvram_write(
552 __in uint32_t offset,
553 __out_bcount(size) caddr_t data,
556 __checkReturn efx_rc_t
557 efx_mcdi_nvram_update_finish(
560 __in boolean_t reboot,
561 __out_opt uint32_t *resultp);
565 __checkReturn efx_rc_t
568 __in uint32_t partn);
570 #endif /* EFSYS_OPT_DIAG */
572 #endif /* EFSYS_OPT_VPD || EFSYS_OPT_NVRAM */
574 #if EFSYS_OPT_LICENSING
576 typedef struct efx_lic_ops_s {
577 efx_rc_t (*elo_update_licenses)(efx_nic_t *);
578 efx_rc_t (*elo_get_key_stats)(efx_nic_t *, efx_key_stats_t *);
579 efx_rc_t (*elo_app_state)(efx_nic_t *, uint64_t, boolean_t *);
580 efx_rc_t (*elo_get_id)(efx_nic_t *, size_t, uint32_t *,
581 size_t *, uint8_t *);
582 efx_rc_t (*elo_find_start)
583 (efx_nic_t *, caddr_t, size_t, uint32_t *);
584 efx_rc_t (*elo_find_end)(efx_nic_t *, caddr_t, size_t,
585 uint32_t, uint32_t *);
586 boolean_t (*elo_find_key)(efx_nic_t *, caddr_t, size_t,
587 uint32_t, uint32_t *, uint32_t *);
588 boolean_t (*elo_validate_key)(efx_nic_t *,
590 efx_rc_t (*elo_read_key)(efx_nic_t *,
591 caddr_t, size_t, uint32_t, uint32_t,
592 caddr_t, size_t, uint32_t *);
593 efx_rc_t (*elo_write_key)(efx_nic_t *,
594 caddr_t, size_t, uint32_t,
595 caddr_t, uint32_t, uint32_t *);
596 efx_rc_t (*elo_delete_key)(efx_nic_t *,
597 caddr_t, size_t, uint32_t,
598 uint32_t, uint32_t, uint32_t *);
599 efx_rc_t (*elo_create_partition)(efx_nic_t *,
601 efx_rc_t (*elo_finish_partition)(efx_nic_t *,
607 typedef struct efx_drv_cfg_s {
608 uint32_t edc_min_vi_count;
609 uint32_t edc_max_vi_count;
611 uint32_t edc_max_piobuf_count;
612 uint32_t edc_pio_alloc_size;
617 efx_family_t en_family;
618 uint32_t en_features;
619 efsys_identifier_t *en_esip;
620 efsys_lock_t *en_eslp;
621 efsys_bar_t *en_esbp;
622 unsigned int en_mod_flags;
623 unsigned int en_reset_flags;
624 efx_nic_cfg_t en_nic_cfg;
625 efx_drv_cfg_t en_drv_cfg;
629 uint32_t en_ev_qcount;
630 uint32_t en_rx_qcount;
631 uint32_t en_tx_qcount;
632 const efx_nic_ops_t *en_enop;
633 const efx_ev_ops_t *en_eevop;
634 const efx_tx_ops_t *en_etxop;
635 const efx_rx_ops_t *en_erxop;
637 efx_filter_t en_filter;
638 const efx_filter_ops_t *en_efop;
639 #endif /* EFSYS_OPT_FILTER */
642 #endif /* EFSYS_OPT_MCDI */
644 efx_nvram_type_t en_nvram_locked;
645 const efx_nvram_ops_t *en_envop;
646 #endif /* EFSYS_OPT_NVRAM */
648 const efx_vpd_ops_t *en_evpdop;
649 #endif /* EFSYS_OPT_VPD */
650 #if EFSYS_OPT_RX_SCALE
651 efx_rx_hash_support_t en_hash_support;
652 efx_rx_scale_support_t en_rss_support;
653 uint32_t en_rss_context;
654 #endif /* EFSYS_OPT_RX_SCALE */
655 uint32_t en_vport_id;
656 #if EFSYS_OPT_LICENSING
657 const efx_lic_ops_t *en_elop;
658 boolean_t en_licensing_supported;
663 #if EFSYS_OPT_NVRAM || EFSYS_OPT_VPD
664 unsigned int enu_partn_mask;
665 #endif /* EFSYS_OPT_NVRAM || EFSYS_OPT_VPD */
668 size_t enu_svpd_length;
669 #endif /* EFSYS_OPT_VPD */
672 #endif /* EFSYS_OPT_SIENA */
675 #if (EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD)
683 size_t ena_svpd_length;
684 #endif /* EFSYS_OPT_VPD */
685 efx_piobuf_handle_t ena_piobuf_handle[EF10_MAX_PIOBUF_NBUFS];
686 uint32_t ena_piobuf_count;
687 uint32_t ena_pio_alloc_map[EF10_MAX_PIOBUF_NBUFS];
688 uint32_t ena_pio_write_vi_base;
689 /* Memory BAR mapping regions */
690 uint32_t ena_uc_mem_map_offset;
691 size_t ena_uc_mem_map_size;
692 uint32_t ena_wc_mem_map_offset;
693 size_t ena_wc_mem_map_size;
696 #endif /* (EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD) */
700 #define EFX_NIC_MAGIC 0x02121996
702 typedef boolean_t (*efx_ev_handler_t)(efx_evq_t *, efx_qword_t *,
703 const efx_ev_callbacks_t *, void *);
705 typedef struct efx_evq_rxq_state_s {
706 unsigned int eers_rx_read_ptr;
707 unsigned int eers_rx_mask;
708 #if EFSYS_OPT_RX_PACKED_STREAM
709 unsigned int eers_rx_stream_npackets;
710 boolean_t eers_rx_packed_stream;
711 unsigned int eers_rx_packed_stream_credits;
713 } efx_evq_rxq_state_t;
718 unsigned int ee_index;
719 unsigned int ee_mask;
720 efsys_mem_t *ee_esmp;
722 uint32_t ee_stat[EV_NQSTATS];
723 #endif /* EFSYS_OPT_QSTATS */
725 efx_ev_handler_t ee_rx;
726 efx_ev_handler_t ee_tx;
727 efx_ev_handler_t ee_driver;
728 efx_ev_handler_t ee_global;
729 efx_ev_handler_t ee_drv_gen;
731 efx_ev_handler_t ee_mcdi;
732 #endif /* EFSYS_OPT_MCDI */
734 efx_evq_rxq_state_t ee_rxq_state[EFX_EV_RX_NLABELS];
739 #define EFX_EVQ_MAGIC 0x08081997
741 #define EFX_EVQ_SIENA_TIMER_QUANTUM_NS 6144 /* 768 cycles */
747 unsigned int er_index;
748 unsigned int er_label;
749 unsigned int er_mask;
750 efsys_mem_t *er_esmp;
753 #define EFX_RXQ_MAGIC 0x15022005
758 unsigned int et_index;
759 unsigned int et_mask;
760 efsys_mem_t *et_esmp;
761 #if EFSYS_OPT_HUNTINGTON
762 uint32_t et_pio_bufnum;
763 uint32_t et_pio_blknum;
764 uint32_t et_pio_write_offset;
765 uint32_t et_pio_offset;
769 uint32_t et_stat[TX_NQSTATS];
770 #endif /* EFSYS_OPT_QSTATS */
773 #define EFX_TXQ_MAGIC 0x05092005
775 #define EFX_MAC_ADDR_COPY(_dst, _src) \
777 (_dst)[0] = (_src)[0]; \
778 (_dst)[1] = (_src)[1]; \
779 (_dst)[2] = (_src)[2]; \
780 (_dst)[3] = (_src)[3]; \
781 (_dst)[4] = (_src)[4]; \
782 (_dst)[5] = (_src)[5]; \
783 _NOTE(CONSTANTCONDITION) \
786 #define EFX_MAC_BROADCAST_ADDR_SET(_dst) \
788 uint16_t *_d = (uint16_t *)(_dst); \
792 _NOTE(CONSTANTCONDITION) \
795 #if EFSYS_OPT_CHECK_REG
796 #define EFX_CHECK_REG(_enp, _reg) \
798 const char *name = #_reg; \
799 char min = name[4]; \
800 char max = name[5]; \
803 switch ((_enp)->en_family) { \
804 case EFX_FAMILY_SIENA: \
808 case EFX_FAMILY_HUNTINGTON: \
812 case EFX_FAMILY_MEDFORD: \
821 EFSYS_ASSERT3S(rev, >=, min); \
822 EFSYS_ASSERT3S(rev, <=, max); \
824 _NOTE(CONSTANTCONDITION) \
827 #define EFX_CHECK_REG(_enp, _reg) do { \
828 _NOTE(CONSTANTCONDITION) \
832 #define EFX_BAR_READD(_enp, _reg, _edp, _lock) \
834 EFX_CHECK_REG((_enp), (_reg)); \
835 EFSYS_BAR_READD((_enp)->en_esbp, _reg ## _OFST, \
837 EFSYS_PROBE3(efx_bar_readd, const char *, #_reg, \
838 uint32_t, _reg ## _OFST, \
839 uint32_t, (_edp)->ed_u32[0]); \
840 _NOTE(CONSTANTCONDITION) \
843 #define EFX_BAR_WRITED(_enp, _reg, _edp, _lock) \
845 EFX_CHECK_REG((_enp), (_reg)); \
846 EFSYS_PROBE3(efx_bar_writed, const char *, #_reg, \
847 uint32_t, _reg ## _OFST, \
848 uint32_t, (_edp)->ed_u32[0]); \
849 EFSYS_BAR_WRITED((_enp)->en_esbp, _reg ## _OFST, \
851 _NOTE(CONSTANTCONDITION) \
854 #define EFX_BAR_READQ(_enp, _reg, _eqp) \
856 EFX_CHECK_REG((_enp), (_reg)); \
857 EFSYS_BAR_READQ((_enp)->en_esbp, _reg ## _OFST, \
859 EFSYS_PROBE4(efx_bar_readq, const char *, #_reg, \
860 uint32_t, _reg ## _OFST, \
861 uint32_t, (_eqp)->eq_u32[1], \
862 uint32_t, (_eqp)->eq_u32[0]); \
863 _NOTE(CONSTANTCONDITION) \
866 #define EFX_BAR_WRITEQ(_enp, _reg, _eqp) \
868 EFX_CHECK_REG((_enp), (_reg)); \
869 EFSYS_PROBE4(efx_bar_writeq, const char *, #_reg, \
870 uint32_t, _reg ## _OFST, \
871 uint32_t, (_eqp)->eq_u32[1], \
872 uint32_t, (_eqp)->eq_u32[0]); \
873 EFSYS_BAR_WRITEQ((_enp)->en_esbp, _reg ## _OFST, \
875 _NOTE(CONSTANTCONDITION) \
878 #define EFX_BAR_READO(_enp, _reg, _eop) \
880 EFX_CHECK_REG((_enp), (_reg)); \
881 EFSYS_BAR_READO((_enp)->en_esbp, _reg ## _OFST, \
883 EFSYS_PROBE6(efx_bar_reado, const char *, #_reg, \
884 uint32_t, _reg ## _OFST, \
885 uint32_t, (_eop)->eo_u32[3], \
886 uint32_t, (_eop)->eo_u32[2], \
887 uint32_t, (_eop)->eo_u32[1], \
888 uint32_t, (_eop)->eo_u32[0]); \
889 _NOTE(CONSTANTCONDITION) \
892 #define EFX_BAR_WRITEO(_enp, _reg, _eop) \
894 EFX_CHECK_REG((_enp), (_reg)); \
895 EFSYS_PROBE6(efx_bar_writeo, const char *, #_reg, \
896 uint32_t, _reg ## _OFST, \
897 uint32_t, (_eop)->eo_u32[3], \
898 uint32_t, (_eop)->eo_u32[2], \
899 uint32_t, (_eop)->eo_u32[1], \
900 uint32_t, (_eop)->eo_u32[0]); \
901 EFSYS_BAR_WRITEO((_enp)->en_esbp, _reg ## _OFST, \
903 _NOTE(CONSTANTCONDITION) \
906 #define EFX_BAR_TBL_READD(_enp, _reg, _index, _edp, _lock) \
908 EFX_CHECK_REG((_enp), (_reg)); \
909 EFSYS_BAR_READD((_enp)->en_esbp, \
910 (_reg ## _OFST + ((_index) * _reg ## _STEP)), \
912 EFSYS_PROBE4(efx_bar_tbl_readd, const char *, #_reg, \
913 uint32_t, (_index), \
914 uint32_t, _reg ## _OFST, \
915 uint32_t, (_edp)->ed_u32[0]); \
916 _NOTE(CONSTANTCONDITION) \
919 #define EFX_BAR_TBL_WRITED(_enp, _reg, _index, _edp, _lock) \
921 EFX_CHECK_REG((_enp), (_reg)); \
922 EFSYS_PROBE4(efx_bar_tbl_writed, const char *, #_reg, \
923 uint32_t, (_index), \
924 uint32_t, _reg ## _OFST, \
925 uint32_t, (_edp)->ed_u32[0]); \
926 EFSYS_BAR_WRITED((_enp)->en_esbp, \
927 (_reg ## _OFST + ((_index) * _reg ## _STEP)), \
929 _NOTE(CONSTANTCONDITION) \
932 #define EFX_BAR_TBL_WRITED2(_enp, _reg, _index, _edp, _lock) \
934 EFX_CHECK_REG((_enp), (_reg)); \
935 EFSYS_PROBE4(efx_bar_tbl_writed, const char *, #_reg, \
936 uint32_t, (_index), \
937 uint32_t, _reg ## _OFST, \
938 uint32_t, (_edp)->ed_u32[0]); \
939 EFSYS_BAR_WRITED((_enp)->en_esbp, \
941 (2 * sizeof (efx_dword_t)) + \
942 ((_index) * _reg ## _STEP)), \
944 _NOTE(CONSTANTCONDITION) \
947 #define EFX_BAR_TBL_WRITED3(_enp, _reg, _index, _edp, _lock) \
949 EFX_CHECK_REG((_enp), (_reg)); \
950 EFSYS_PROBE4(efx_bar_tbl_writed, const char *, #_reg, \
951 uint32_t, (_index), \
952 uint32_t, _reg ## _OFST, \
953 uint32_t, (_edp)->ed_u32[0]); \
954 EFSYS_BAR_WRITED((_enp)->en_esbp, \
956 (3 * sizeof (efx_dword_t)) + \
957 ((_index) * _reg ## _STEP)), \
959 _NOTE(CONSTANTCONDITION) \
962 #define EFX_BAR_TBL_READQ(_enp, _reg, _index, _eqp) \
964 EFX_CHECK_REG((_enp), (_reg)); \
965 EFSYS_BAR_READQ((_enp)->en_esbp, \
966 (_reg ## _OFST + ((_index) * _reg ## _STEP)), \
968 EFSYS_PROBE5(efx_bar_tbl_readq, const char *, #_reg, \
969 uint32_t, (_index), \
970 uint32_t, _reg ## _OFST, \
971 uint32_t, (_eqp)->eq_u32[1], \
972 uint32_t, (_eqp)->eq_u32[0]); \
973 _NOTE(CONSTANTCONDITION) \
976 #define EFX_BAR_TBL_WRITEQ(_enp, _reg, _index, _eqp) \
978 EFX_CHECK_REG((_enp), (_reg)); \
979 EFSYS_PROBE5(efx_bar_tbl_writeq, const char *, #_reg, \
980 uint32_t, (_index), \
981 uint32_t, _reg ## _OFST, \
982 uint32_t, (_eqp)->eq_u32[1], \
983 uint32_t, (_eqp)->eq_u32[0]); \
984 EFSYS_BAR_WRITEQ((_enp)->en_esbp, \
985 (_reg ## _OFST + ((_index) * _reg ## _STEP)), \
987 _NOTE(CONSTANTCONDITION) \
990 #define EFX_BAR_TBL_READO(_enp, _reg, _index, _eop, _lock) \
992 EFX_CHECK_REG((_enp), (_reg)); \
993 EFSYS_BAR_READO((_enp)->en_esbp, \
994 (_reg ## _OFST + ((_index) * _reg ## _STEP)), \
996 EFSYS_PROBE7(efx_bar_tbl_reado, const char *, #_reg, \
997 uint32_t, (_index), \
998 uint32_t, _reg ## _OFST, \
999 uint32_t, (_eop)->eo_u32[3], \
1000 uint32_t, (_eop)->eo_u32[2], \
1001 uint32_t, (_eop)->eo_u32[1], \
1002 uint32_t, (_eop)->eo_u32[0]); \
1003 _NOTE(CONSTANTCONDITION) \
1006 #define EFX_BAR_TBL_WRITEO(_enp, _reg, _index, _eop, _lock) \
1008 EFX_CHECK_REG((_enp), (_reg)); \
1009 EFSYS_PROBE7(efx_bar_tbl_writeo, const char *, #_reg, \
1010 uint32_t, (_index), \
1011 uint32_t, _reg ## _OFST, \
1012 uint32_t, (_eop)->eo_u32[3], \
1013 uint32_t, (_eop)->eo_u32[2], \
1014 uint32_t, (_eop)->eo_u32[1], \
1015 uint32_t, (_eop)->eo_u32[0]); \
1016 EFSYS_BAR_WRITEO((_enp)->en_esbp, \
1017 (_reg ## _OFST + ((_index) * _reg ## _STEP)), \
1019 _NOTE(CONSTANTCONDITION) \
1023 * Allow drivers to perform optimised 128-bit doorbell writes.
1024 * The DMA descriptor pointers (RX_DESC_UPD and TX_DESC_UPD) are
1025 * special-cased in the BIU on the Falcon/Siena and EF10 architectures to avoid
1026 * the need for locking in the host, and are the only ones known to be safe to
1027 * use 128-bites write with.
1029 #define EFX_BAR_TBL_DOORBELL_WRITEO(_enp, _reg, _index, _eop) \
1031 EFX_CHECK_REG((_enp), (_reg)); \
1032 EFSYS_PROBE7(efx_bar_tbl_doorbell_writeo, \
1035 uint32_t, (_index), \
1036 uint32_t, _reg ## _OFST, \
1037 uint32_t, (_eop)->eo_u32[3], \
1038 uint32_t, (_eop)->eo_u32[2], \
1039 uint32_t, (_eop)->eo_u32[1], \
1040 uint32_t, (_eop)->eo_u32[0]); \
1041 EFSYS_BAR_DOORBELL_WRITEO((_enp)->en_esbp, \
1042 (_reg ## _OFST + ((_index) * _reg ## _STEP)), \
1044 _NOTE(CONSTANTCONDITION) \
1047 #define EFX_DMA_SYNC_QUEUE_FOR_DEVICE(_esmp, _entries, _wptr, _owptr) \
1049 unsigned int _new = (_wptr); \
1050 unsigned int _old = (_owptr); \
1052 if ((_new) >= (_old)) \
1053 EFSYS_DMA_SYNC_FOR_DEVICE((_esmp), \
1054 (_old) * sizeof (efx_desc_t), \
1055 ((_new) - (_old)) * sizeof (efx_desc_t)); \
1058 * It is cheaper to sync entire map than sync \
1059 * two parts especially when offset/size are \
1060 * ignored and entire map is synced in any case.\
1062 EFSYS_DMA_SYNC_FOR_DEVICE((_esmp), \
1064 (_entries) * sizeof (efx_desc_t)); \
1065 _NOTE(CONSTANTCONDITION) \
1068 extern __checkReturn efx_rc_t
1070 __in efx_nic_t *enp);
1072 extern __checkReturn efx_rc_t
1074 __in efx_nic_t *enp);
1077 efx_mac_multicast_hash_compute(
1078 __in_ecount(6*count) uint8_t const *addrs,
1080 __out efx_oword_t *hash_low,
1081 __out efx_oword_t *hash_high);
1083 extern __checkReturn efx_rc_t
1085 __in efx_nic_t *enp);
1089 __in efx_nic_t *enp);
1093 /* VPD utility functions */
1095 extern __checkReturn efx_rc_t
1096 efx_vpd_hunk_length(
1097 __in_bcount(size) caddr_t data,
1099 __out size_t *lengthp);
1101 extern __checkReturn efx_rc_t
1102 efx_vpd_hunk_verify(
1103 __in_bcount(size) caddr_t data,
1105 __out_opt boolean_t *cksummedp);
1107 extern __checkReturn efx_rc_t
1108 efx_vpd_hunk_reinit(
1109 __in_bcount(size) caddr_t data,
1111 __in boolean_t wantpid);
1113 extern __checkReturn efx_rc_t
1115 __in_bcount(size) caddr_t data,
1117 __in efx_vpd_tag_t tag,
1118 __in efx_vpd_keyword_t keyword,
1119 __out unsigned int *payloadp,
1120 __out uint8_t *paylenp);
1122 extern __checkReturn efx_rc_t
1124 __in_bcount(size) caddr_t data,
1126 __out efx_vpd_tag_t *tagp,
1127 __out efx_vpd_keyword_t *keyword,
1128 __out_opt unsigned int *payloadp,
1129 __out_opt uint8_t *paylenp,
1130 __inout unsigned int *contp);
1132 extern __checkReturn efx_rc_t
1134 __in_bcount(size) caddr_t data,
1136 __in efx_vpd_value_t *evvp);
1138 #endif /* EFSYS_OPT_VPD */
1142 extern efx_sram_pattern_fn_t __efx_sram_pattern_fns[];
1144 typedef struct efx_register_set_s {
1145 unsigned int address;
1149 } efx_register_set_t;
1151 extern __checkReturn efx_rc_t
1152 efx_nic_test_registers(
1153 __in efx_nic_t *enp,
1154 __in efx_register_set_t *rsp,
1157 extern __checkReturn efx_rc_t
1158 efx_nic_test_tables(
1159 __in efx_nic_t *enp,
1160 __in efx_register_set_t *rsp,
1161 __in efx_pattern_type_t pattern,
1164 #endif /* EFSYS_OPT_DIAG */
1168 extern __checkReturn efx_rc_t
1169 efx_mcdi_set_workaround(
1170 __in efx_nic_t *enp,
1172 __in boolean_t enabled,
1173 __out_opt uint32_t *flagsp);
1175 extern __checkReturn efx_rc_t
1176 efx_mcdi_get_workarounds(
1177 __in efx_nic_t *enp,
1178 __out_opt uint32_t *implementedp,
1179 __out_opt uint32_t *enabledp);
1181 #endif /* EFSYS_OPT_MCDI */
1183 #if EFSYS_OPT_MAC_STATS
1186 * Closed range of stats (i.e. the first and the last are included).
1187 * The last must be greater or equal (if the range is one item only) to
1190 struct efx_mac_stats_range {
1191 efx_mac_stat_t first;
1192 efx_mac_stat_t last;
1196 efx_mac_stats_mask_add_ranges(
1197 __inout_bcount(mask_size) uint32_t *maskp,
1198 __in size_t mask_size,
1199 __in_ecount(rng_count) const struct efx_mac_stats_range *rngp,
1200 __in unsigned int rng_count);
1202 #endif /* EFSYS_OPT_MAC_STATS */
1208 #endif /* _SYS_EFX_IMPL_H */