xref: /dpdk/drivers/common/sfc_efx/base/efx_impl.h (revision bc8e32473cc3978d763a1387eaa8244bcf75e77d)
1 /* SPDX-License-Identifier: BSD-3-Clause
2  *
3  * Copyright(c) 2019-2020 Xilinx, Inc.
4  * Copyright(c) 2007-2019 Solarflare Communications Inc.
5  */
6 
7 #ifndef	_SYS_EFX_IMPL_H
8 #define	_SYS_EFX_IMPL_H
9 
10 #include "efx.h"
11 #include "efx_regs.h"
12 #include "efx_regs_ef10.h"
13 #include "efx_regs_ef100.h"
14 #if EFSYS_OPT_MCDI
15 #include "efx_mcdi.h"
16 #endif	/* EFSYS_OPT_MCDI */
17 
18 /* FIXME: Add definition for driver generated software events */
19 #ifndef	ESE_DZ_EV_CODE_DRV_GEN_EV
20 #define	ESE_DZ_EV_CODE_DRV_GEN_EV FSE_AZ_EV_CODE_DRV_GEN_EV
21 #endif
22 
23 
24 #if EFSYS_OPT_SIENA
25 #include "siena_impl.h"
26 #endif	/* EFSYS_OPT_SIENA */
27 
28 #if EFSYS_OPT_HUNTINGTON
29 #include "hunt_impl.h"
30 #endif	/* EFSYS_OPT_HUNTINGTON */
31 
32 #if EFSYS_OPT_MEDFORD
33 #include "medford_impl.h"
34 #endif	/* EFSYS_OPT_MEDFORD */
35 
36 #if EFSYS_OPT_MEDFORD2
37 #include "medford2_impl.h"
38 #endif	/* EFSYS_OPT_MEDFORD2 */
39 
40 #if EFSYS_OPT_RIVERHEAD || EFX_OPTS_EF10()
41 #include "ef10_impl.h"
42 #endif	/* EFSYS_OPT_RIVERHEAD || EFX_OPTS_EF10() */
43 
44 #if EFSYS_OPT_RIVERHEAD
45 #include "rhead_impl.h"
46 #endif	/* EFSYS_OPT_RIVERHEAD */
47 
48 #ifdef	__cplusplus
49 extern "C" {
50 #endif
51 
52 #define	EFX_MOD_MCDI		0x00000001
53 #define	EFX_MOD_PROBE		0x00000002
54 #define	EFX_MOD_NVRAM		0x00000004
55 #define	EFX_MOD_VPD		0x00000008
56 #define	EFX_MOD_NIC		0x00000010
57 #define	EFX_MOD_INTR		0x00000020
58 #define	EFX_MOD_EV		0x00000040
59 #define	EFX_MOD_RX		0x00000080
60 #define	EFX_MOD_TX		0x00000100
61 #define	EFX_MOD_PORT		0x00000200
62 #define	EFX_MOD_MON		0x00000400
63 #define	EFX_MOD_FILTER		0x00001000
64 #define	EFX_MOD_LIC		0x00002000
65 #define	EFX_MOD_TUNNEL		0x00004000
66 #define	EFX_MOD_EVB		0x00008000
67 #define	EFX_MOD_PROXY		0x00010000
68 
69 #define	EFX_RESET_PHY		0x00000001
70 #define	EFX_RESET_RXQ_ERR	0x00000002
71 #define	EFX_RESET_TXQ_ERR	0x00000004
72 #define	EFX_RESET_HW_UNAVAIL	0x00000008
73 
74 typedef enum efx_mac_type_e {
75 	EFX_MAC_INVALID = 0,
76 	EFX_MAC_SIENA,
77 	EFX_MAC_HUNTINGTON,
78 	EFX_MAC_MEDFORD,
79 	EFX_MAC_MEDFORD2,
80 	EFX_MAC_RIVERHEAD,
81 	EFX_MAC_NTYPES
82 } efx_mac_type_t;
83 
84 typedef struct efx_ev_ops_s {
85 	efx_rc_t	(*eevo_init)(efx_nic_t *);
86 	void		(*eevo_fini)(efx_nic_t *);
87 	efx_rc_t	(*eevo_qcreate)(efx_nic_t *, unsigned int,
88 					  efsys_mem_t *, size_t, uint32_t,
89 					  uint32_t, uint32_t, efx_evq_t *);
90 	void		(*eevo_qdestroy)(efx_evq_t *);
91 	efx_rc_t	(*eevo_qprime)(efx_evq_t *, unsigned int);
92 	void		(*eevo_qpost)(efx_evq_t *, uint16_t);
93 	void		(*eevo_qpoll)(efx_evq_t *, unsigned int *,
94 					const efx_ev_callbacks_t *, void *);
95 	efx_rc_t	(*eevo_qmoderate)(efx_evq_t *, unsigned int);
96 #if EFSYS_OPT_QSTATS
97 	void		(*eevo_qstats_update)(efx_evq_t *, efsys_stat_t *);
98 #endif
99 } efx_ev_ops_t;
100 
101 typedef struct efx_tx_ops_s {
102 	efx_rc_t	(*etxo_init)(efx_nic_t *);
103 	void		(*etxo_fini)(efx_nic_t *);
104 	efx_rc_t	(*etxo_qcreate)(efx_nic_t *,
105 					unsigned int, unsigned int,
106 					efsys_mem_t *, size_t,
107 					uint32_t, uint16_t,
108 					efx_evq_t *, efx_txq_t *,
109 					unsigned int *);
110 	void		(*etxo_qdestroy)(efx_txq_t *);
111 	efx_rc_t	(*etxo_qpost)(efx_txq_t *, efx_buffer_t *,
112 				      unsigned int, unsigned int,
113 				      unsigned int *);
114 	void		(*etxo_qpush)(efx_txq_t *, unsigned int, unsigned int);
115 	efx_rc_t	(*etxo_qpace)(efx_txq_t *, unsigned int);
116 	efx_rc_t	(*etxo_qflush)(efx_txq_t *);
117 	void		(*etxo_qenable)(efx_txq_t *);
118 	efx_rc_t	(*etxo_qpio_enable)(efx_txq_t *);
119 	void		(*etxo_qpio_disable)(efx_txq_t *);
120 	efx_rc_t	(*etxo_qpio_write)(efx_txq_t *, uint8_t *, size_t,
121 					   size_t);
122 	efx_rc_t	(*etxo_qpio_post)(efx_txq_t *, size_t, unsigned int,
123 					   unsigned int *);
124 	efx_rc_t	(*etxo_qdesc_post)(efx_txq_t *, efx_desc_t *,
125 				      unsigned int, unsigned int,
126 				      unsigned int *);
127 	void		(*etxo_qdesc_dma_create)(efx_txq_t *, efsys_dma_addr_t,
128 						size_t, boolean_t,
129 						efx_desc_t *);
130 	void		(*etxo_qdesc_tso_create)(efx_txq_t *, uint16_t,
131 						uint32_t, uint8_t,
132 						efx_desc_t *);
133 	void		(*etxo_qdesc_tso2_create)(efx_txq_t *, uint16_t,
134 						uint16_t, uint32_t, uint16_t,
135 						efx_desc_t *, int);
136 	void		(*etxo_qdesc_vlantci_create)(efx_txq_t *, uint16_t,
137 						efx_desc_t *);
138 	void		(*etxo_qdesc_checksum_create)(efx_txq_t *, uint16_t,
139 						efx_desc_t *);
140 #if EFSYS_OPT_QSTATS
141 	void		(*etxo_qstats_update)(efx_txq_t *,
142 					      efsys_stat_t *);
143 #endif
144 } efx_tx_ops_t;
145 
146 typedef union efx_rxq_type_data_u {
147 	struct {
148 		size_t		ed_buf_size;
149 	} ertd_default;
150 #if EFSYS_OPT_RX_PACKED_STREAM
151 	struct {
152 		uint32_t	eps_buf_size;
153 	} ertd_packed_stream;
154 #endif
155 #if EFSYS_OPT_RX_ES_SUPER_BUFFER
156 	struct {
157 		uint32_t	eessb_bufs_per_desc;
158 		uint32_t	eessb_max_dma_len;
159 		uint32_t	eessb_buf_stride;
160 		uint32_t	eessb_hol_block_timeout;
161 	} ertd_es_super_buffer;
162 #endif
163 } efx_rxq_type_data_t;
164 
165 typedef struct efx_rx_ops_s {
166 	efx_rc_t	(*erxo_init)(efx_nic_t *);
167 	void		(*erxo_fini)(efx_nic_t *);
168 #if EFSYS_OPT_RX_SCATTER
169 	efx_rc_t	(*erxo_scatter_enable)(efx_nic_t *, unsigned int);
170 #endif
171 #if EFSYS_OPT_RX_SCALE
172 	efx_rc_t	(*erxo_scale_context_alloc)(efx_nic_t *,
173 						    efx_rx_scale_context_type_t,
174 						    uint32_t, uint32_t *);
175 	efx_rc_t	(*erxo_scale_context_free)(efx_nic_t *, uint32_t);
176 	efx_rc_t	(*erxo_scale_mode_set)(efx_nic_t *, uint32_t,
177 					       efx_rx_hash_alg_t,
178 					       efx_rx_hash_type_t, boolean_t);
179 	efx_rc_t	(*erxo_scale_key_set)(efx_nic_t *, uint32_t,
180 					      uint8_t *, size_t);
181 	efx_rc_t	(*erxo_scale_tbl_set)(efx_nic_t *, uint32_t,
182 					      unsigned int *, size_t);
183 	uint32_t	(*erxo_prefix_hash)(efx_nic_t *, efx_rx_hash_alg_t,
184 					    uint8_t *);
185 #endif /* EFSYS_OPT_RX_SCALE */
186 	efx_rc_t	(*erxo_prefix_pktlen)(efx_nic_t *, uint8_t *,
187 					      uint16_t *);
188 	void		(*erxo_qpost)(efx_rxq_t *, efsys_dma_addr_t *, size_t,
189 				      unsigned int, unsigned int,
190 				      unsigned int);
191 	void		(*erxo_qpush)(efx_rxq_t *, unsigned int, unsigned int *);
192 #if EFSYS_OPT_RX_PACKED_STREAM
193 	void		(*erxo_qpush_ps_credits)(efx_rxq_t *);
194 	uint8_t *	(*erxo_qps_packet_info)(efx_rxq_t *, uint8_t *,
195 						uint32_t, uint32_t,
196 						uint16_t *, uint32_t *, uint32_t *);
197 #endif
198 	efx_rc_t	(*erxo_qflush)(efx_rxq_t *);
199 	void		(*erxo_qenable)(efx_rxq_t *);
200 	efx_rc_t	(*erxo_qcreate)(efx_nic_t *enp, unsigned int,
201 					unsigned int, efx_rxq_type_t,
202 					const efx_rxq_type_data_t *,
203 					efsys_mem_t *, size_t, uint32_t,
204 					unsigned int,
205 					efx_evq_t *, efx_rxq_t *);
206 	void		(*erxo_qdestroy)(efx_rxq_t *);
207 } efx_rx_ops_t;
208 
209 typedef struct efx_mac_ops_s {
210 	efx_rc_t	(*emo_poll)(efx_nic_t *, efx_link_mode_t *);
211 	efx_rc_t	(*emo_up)(efx_nic_t *, boolean_t *);
212 	efx_rc_t	(*emo_addr_set)(efx_nic_t *);
213 	efx_rc_t	(*emo_pdu_set)(efx_nic_t *);
214 	efx_rc_t	(*emo_pdu_get)(efx_nic_t *, size_t *);
215 	efx_rc_t	(*emo_reconfigure)(efx_nic_t *);
216 	efx_rc_t	(*emo_multicast_list_set)(efx_nic_t *);
217 	efx_rc_t	(*emo_filter_default_rxq_set)(efx_nic_t *,
218 						      efx_rxq_t *, boolean_t);
219 	void		(*emo_filter_default_rxq_clear)(efx_nic_t *);
220 #if EFSYS_OPT_LOOPBACK
221 	efx_rc_t	(*emo_loopback_set)(efx_nic_t *, efx_link_mode_t,
222 					    efx_loopback_type_t);
223 #endif	/* EFSYS_OPT_LOOPBACK */
224 #if EFSYS_OPT_MAC_STATS
225 	efx_rc_t	(*emo_stats_get_mask)(efx_nic_t *, uint32_t *, size_t);
226 	efx_rc_t	(*emo_stats_clear)(efx_nic_t *);
227 	efx_rc_t	(*emo_stats_upload)(efx_nic_t *, efsys_mem_t *);
228 	efx_rc_t	(*emo_stats_periodic)(efx_nic_t *, efsys_mem_t *,
229 					      uint16_t, boolean_t);
230 	efx_rc_t	(*emo_stats_update)(efx_nic_t *, efsys_mem_t *,
231 					    efsys_stat_t *, uint32_t *);
232 #endif	/* EFSYS_OPT_MAC_STATS */
233 } efx_mac_ops_t;
234 
235 typedef struct efx_phy_ops_s {
236 	efx_rc_t	(*epo_power)(efx_nic_t *, boolean_t); /* optional */
237 	efx_rc_t	(*epo_reset)(efx_nic_t *);
238 	efx_rc_t	(*epo_reconfigure)(efx_nic_t *);
239 	efx_rc_t	(*epo_verify)(efx_nic_t *);
240 	efx_rc_t	(*epo_oui_get)(efx_nic_t *, uint32_t *);
241 	efx_rc_t	(*epo_link_state_get)(efx_nic_t *, efx_phy_link_state_t *);
242 #if EFSYS_OPT_PHY_STATS
243 	efx_rc_t	(*epo_stats_update)(efx_nic_t *, efsys_mem_t *,
244 					    uint32_t *);
245 #endif	/* EFSYS_OPT_PHY_STATS */
246 #if EFSYS_OPT_BIST
247 	efx_rc_t	(*epo_bist_enable_offline)(efx_nic_t *);
248 	efx_rc_t	(*epo_bist_start)(efx_nic_t *, efx_bist_type_t);
249 	efx_rc_t	(*epo_bist_poll)(efx_nic_t *, efx_bist_type_t,
250 					 efx_bist_result_t *, uint32_t *,
251 					 unsigned long *, size_t);
252 	void		(*epo_bist_stop)(efx_nic_t *, efx_bist_type_t);
253 #endif	/* EFSYS_OPT_BIST */
254 } efx_phy_ops_t;
255 
256 #if EFSYS_OPT_FILTER
257 
258 /*
259  * Policy for replacing existing filter when inserting a new one.
260  * Note that all policies allow for storing the new lower priority
261  * filters as overridden by existing higher priority ones. It is needed
262  * to restore the lower priority filters on higher priority ones removal.
263  */
264 typedef enum efx_filter_replacement_policy_e {
265 	/* Cannot replace existing filter */
266 	EFX_FILTER_REPLACEMENT_NEVER,
267 	/* Higher priority filters can replace lower priotiry ones */
268 	EFX_FILTER_REPLACEMENT_HIGHER_PRIORITY,
269 	/*
270 	 * Higher priority filters can replace lower priority ones and
271 	 * equal priority filters can replace each other.
272 	 */
273 	EFX_FILTER_REPLACEMENT_HIGHER_OR_EQUAL_PRIORITY,
274 } efx_filter_replacement_policy_t;
275 
276 typedef struct efx_filter_ops_s {
277 	efx_rc_t	(*efo_init)(efx_nic_t *);
278 	void		(*efo_fini)(efx_nic_t *);
279 	efx_rc_t	(*efo_restore)(efx_nic_t *);
280 	efx_rc_t	(*efo_add)(efx_nic_t *, efx_filter_spec_t *,
281 				   efx_filter_replacement_policy_t policy);
282 	efx_rc_t	(*efo_delete)(efx_nic_t *, efx_filter_spec_t *);
283 	efx_rc_t	(*efo_supported_filters)(efx_nic_t *, uint32_t *,
284 				   size_t, size_t *);
285 	efx_rc_t	(*efo_reconfigure)(efx_nic_t *, uint8_t const *, boolean_t,
286 				   boolean_t, boolean_t, boolean_t,
287 				   uint8_t const *, uint32_t);
288 } efx_filter_ops_t;
289 
290 LIBEFX_INTERNAL
291 extern	__checkReturn	efx_rc_t
292 efx_filter_reconfigure(
293 	__in				efx_nic_t *enp,
294 	__in_ecount(6)			uint8_t const *mac_addr,
295 	__in				boolean_t all_unicst,
296 	__in				boolean_t mulcst,
297 	__in				boolean_t all_mulcst,
298 	__in				boolean_t brdcst,
299 	__in_ecount(6*count)		uint8_t const *addrs,
300 	__in				uint32_t count);
301 
302 #endif /* EFSYS_OPT_FILTER */
303 
304 #if EFSYS_OPT_TUNNEL
305 typedef struct efx_tunnel_ops_s {
306 	efx_rc_t	(*eto_reconfigure)(efx_nic_t *);
307 	void		(*eto_fini)(efx_nic_t *);
308 } efx_tunnel_ops_t;
309 #endif /* EFSYS_OPT_TUNNEL */
310 
311 typedef struct efx_port_s {
312 	efx_mac_type_t		ep_mac_type;
313 	uint32_t		ep_phy_type;
314 	uint8_t			ep_port;
315 	uint32_t		ep_mac_pdu;
316 	uint8_t			ep_mac_addr[6];
317 	efx_link_mode_t		ep_link_mode;
318 	boolean_t		ep_all_unicst;
319 	boolean_t		ep_all_unicst_inserted;
320 	boolean_t		ep_mulcst;
321 	boolean_t		ep_all_mulcst;
322 	boolean_t		ep_all_mulcst_inserted;
323 	boolean_t		ep_brdcst;
324 	unsigned int		ep_fcntl;
325 	boolean_t		ep_fcntl_autoneg;
326 	efx_oword_t		ep_multicst_hash[2];
327 	uint8_t			ep_mulcst_addr_list[EFX_MAC_ADDR_LEN *
328 						    EFX_MAC_MULTICAST_LIST_MAX];
329 	uint32_t		ep_mulcst_addr_count;
330 #if EFSYS_OPT_LOOPBACK
331 	efx_loopback_type_t	ep_loopback_type;
332 	efx_link_mode_t		ep_loopback_link_mode;
333 #endif	/* EFSYS_OPT_LOOPBACK */
334 #if EFSYS_OPT_PHY_FLAGS
335 	uint32_t		ep_phy_flags;
336 #endif	/* EFSYS_OPT_PHY_FLAGS */
337 #if EFSYS_OPT_PHY_LED_CONTROL
338 	efx_phy_led_mode_t	ep_phy_led_mode;
339 #endif	/* EFSYS_OPT_PHY_LED_CONTROL */
340 	efx_phy_media_type_t	ep_fixed_port_type;
341 	efx_phy_media_type_t	ep_module_type;
342 	uint32_t		ep_adv_cap_mask;
343 	uint32_t		ep_lp_cap_mask;
344 	uint32_t		ep_default_adv_cap_mask;
345 	uint32_t		ep_phy_cap_mask;
346 	boolean_t		ep_mac_drain;
347 #if EFSYS_OPT_BIST
348 	efx_bist_type_t		ep_current_bist;
349 #endif
350 	const efx_mac_ops_t	*ep_emop;
351 	const efx_phy_ops_t	*ep_epop;
352 } efx_port_t;
353 
354 typedef struct efx_mon_ops_s {
355 #if EFSYS_OPT_MON_STATS
356 	efx_rc_t	(*emo_stats_update)(efx_nic_t *, efsys_mem_t *,
357 					    efx_mon_stat_value_t *);
358 	efx_rc_t	(*emo_limits_update)(efx_nic_t *,
359 					     efx_mon_stat_limits_t *);
360 #endif	/* EFSYS_OPT_MON_STATS */
361 } efx_mon_ops_t;
362 
363 typedef struct efx_mon_s {
364 	efx_mon_type_t		em_type;
365 	const efx_mon_ops_t	*em_emop;
366 } efx_mon_t;
367 
368 typedef struct efx_intr_ops_s {
369 	efx_rc_t	(*eio_init)(efx_nic_t *, efx_intr_type_t, efsys_mem_t *);
370 	void		(*eio_enable)(efx_nic_t *);
371 	void		(*eio_disable)(efx_nic_t *);
372 	void		(*eio_disable_unlocked)(efx_nic_t *);
373 	efx_rc_t	(*eio_trigger)(efx_nic_t *, unsigned int);
374 	void		(*eio_status_line)(efx_nic_t *, boolean_t *, uint32_t *);
375 	void		(*eio_status_message)(efx_nic_t *, unsigned int,
376 				 boolean_t *);
377 	void		(*eio_fatal)(efx_nic_t *);
378 	void		(*eio_fini)(efx_nic_t *);
379 } efx_intr_ops_t;
380 
381 typedef struct efx_intr_s {
382 	const efx_intr_ops_t	*ei_eiop;
383 	efsys_mem_t		*ei_esmp;
384 	efx_intr_type_t		ei_type;
385 	unsigned int		ei_level;
386 } efx_intr_t;
387 
388 typedef struct efx_nic_ops_s {
389 	efx_rc_t	(*eno_probe)(efx_nic_t *);
390 	efx_rc_t	(*eno_board_cfg)(efx_nic_t *);
391 	efx_rc_t	(*eno_set_drv_limits)(efx_nic_t *, efx_drv_limits_t*);
392 	efx_rc_t	(*eno_reset)(efx_nic_t *);
393 	efx_rc_t	(*eno_init)(efx_nic_t *);
394 	efx_rc_t	(*eno_get_vi_pool)(efx_nic_t *, uint32_t *);
395 	efx_rc_t	(*eno_get_bar_region)(efx_nic_t *, efx_nic_region_t,
396 					uint32_t *, size_t *);
397 	boolean_t	(*eno_hw_unavailable)(efx_nic_t *);
398 	void		(*eno_set_hw_unavailable)(efx_nic_t *);
399 #if EFSYS_OPT_DIAG
400 	efx_rc_t	(*eno_register_test)(efx_nic_t *);
401 #endif	/* EFSYS_OPT_DIAG */
402 	void		(*eno_fini)(efx_nic_t *);
403 	void		(*eno_unprobe)(efx_nic_t *);
404 } efx_nic_ops_t;
405 
406 #ifndef EFX_TXQ_LIMIT_TARGET
407 #define	EFX_TXQ_LIMIT_TARGET 259
408 #endif
409 #ifndef EFX_RXQ_LIMIT_TARGET
410 #define	EFX_RXQ_LIMIT_TARGET 512
411 #endif
412 
413 
414 #if EFSYS_OPT_FILTER
415 
416 #if EFSYS_OPT_SIENA
417 
418 typedef struct siena_filter_spec_s {
419 	uint8_t		sfs_type;
420 	uint32_t	sfs_flags;
421 	uint32_t	sfs_dmaq_id;
422 	uint32_t	sfs_dword[3];
423 } siena_filter_spec_t;
424 
425 typedef enum siena_filter_type_e {
426 	EFX_SIENA_FILTER_RX_TCP_FULL,	/* TCP/IPv4 {dIP,dTCP,sIP,sTCP} */
427 	EFX_SIENA_FILTER_RX_TCP_WILD,	/* TCP/IPv4 {dIP,dTCP,  -,   -} */
428 	EFX_SIENA_FILTER_RX_UDP_FULL,	/* UDP/IPv4 {dIP,dUDP,sIP,sUDP} */
429 	EFX_SIENA_FILTER_RX_UDP_WILD,	/* UDP/IPv4 {dIP,dUDP,  -,   -} */
430 	EFX_SIENA_FILTER_RX_MAC_FULL,	/* Ethernet {dMAC,VLAN} */
431 	EFX_SIENA_FILTER_RX_MAC_WILD,	/* Ethernet {dMAC,   -} */
432 
433 	EFX_SIENA_FILTER_TX_TCP_FULL,	/* TCP/IPv4 {dIP,dTCP,sIP,sTCP} */
434 	EFX_SIENA_FILTER_TX_TCP_WILD,	/* TCP/IPv4 {  -,   -,sIP,sTCP} */
435 	EFX_SIENA_FILTER_TX_UDP_FULL,	/* UDP/IPv4 {dIP,dTCP,sIP,sTCP} */
436 	EFX_SIENA_FILTER_TX_UDP_WILD,	/* UDP/IPv4 {  -,   -,sIP,sUDP} */
437 	EFX_SIENA_FILTER_TX_MAC_FULL,	/* Ethernet {sMAC,VLAN} */
438 	EFX_SIENA_FILTER_TX_MAC_WILD,	/* Ethernet {sMAC,   -} */
439 
440 	EFX_SIENA_FILTER_NTYPES
441 } siena_filter_type_t;
442 
443 typedef enum siena_filter_tbl_id_e {
444 	EFX_SIENA_FILTER_TBL_RX_IP = 0,
445 	EFX_SIENA_FILTER_TBL_RX_MAC,
446 	EFX_SIENA_FILTER_TBL_TX_IP,
447 	EFX_SIENA_FILTER_TBL_TX_MAC,
448 	EFX_SIENA_FILTER_NTBLS
449 } siena_filter_tbl_id_t;
450 
451 typedef struct siena_filter_tbl_s {
452 	int			sft_size;	/* number of entries */
453 	int			sft_used;	/* active count */
454 	uint32_t		*sft_bitmap;	/* active bitmap */
455 	siena_filter_spec_t	*sft_spec;	/* array of saved specs */
456 } siena_filter_tbl_t;
457 
458 typedef struct siena_filter_s {
459 	siena_filter_tbl_t	sf_tbl[EFX_SIENA_FILTER_NTBLS];
460 	unsigned int		sf_depth[EFX_SIENA_FILTER_NTYPES];
461 } siena_filter_t;
462 
463 #endif	/* EFSYS_OPT_SIENA */
464 
465 typedef struct efx_filter_s {
466 #if EFSYS_OPT_SIENA
467 	siena_filter_t		*ef_siena_filter;
468 #endif /* EFSYS_OPT_SIENA */
469 #if EFSYS_OPT_RIVERHEAD || EFX_OPTS_EF10()
470 	ef10_filter_table_t	*ef_ef10_filter_table;
471 #endif /* EFSYS_OPT_RIVERHEAD || EFX_OPTS_EF10() */
472 } efx_filter_t;
473 
474 #if EFSYS_OPT_SIENA
475 
476 LIBEFX_INTERNAL
477 extern			void
478 siena_filter_tbl_clear(
479 	__in		efx_nic_t *enp,
480 	__in		siena_filter_tbl_id_t tbl);
481 
482 #endif	/* EFSYS_OPT_SIENA */
483 
484 #endif	/* EFSYS_OPT_FILTER */
485 
486 #if EFSYS_OPT_MCDI
487 
488 #define	EFX_TUNNEL_MAXNENTRIES	(16)
489 
490 #if EFSYS_OPT_TUNNEL
491 
492 /* State of a UDP tunnel table entry */
493 typedef enum efx_tunnel_udp_entry_state_e {
494 	EFX_TUNNEL_UDP_ENTRY_ADDED, /* Tunnel addition is requested */
495 	EFX_TUNNEL_UDP_ENTRY_REMOVED, /* Tunnel removal is requested */
496 	EFX_TUNNEL_UDP_ENTRY_APPLIED, /* Tunnel is applied by HW */
497 } efx_tunnel_udp_entry_state_t;
498 
499 #if EFSYS_OPT_RIVERHEAD
500 typedef uint32_t	efx_vnic_encap_rule_handle_t;
501 #endif /* EFSYS_OPT_RIVERHEAD */
502 
503 typedef struct efx_tunnel_udp_entry_s {
504 	uint16_t			etue_port; /* host/cpu-endian */
505 	uint16_t			etue_protocol;
506 	boolean_t			etue_busy;
507 	efx_tunnel_udp_entry_state_t	etue_state;
508 #if EFSYS_OPT_RIVERHEAD
509 	efx_vnic_encap_rule_handle_t	etue_handle;
510 #endif /* EFSYS_OPT_RIVERHEAD */
511 } efx_tunnel_udp_entry_t;
512 
513 typedef struct efx_tunnel_cfg_s {
514 	efx_tunnel_udp_entry_t	etc_udp_entries[EFX_TUNNEL_MAXNENTRIES];
515 	unsigned int		etc_udp_entries_num;
516 } efx_tunnel_cfg_t;
517 
518 #endif /* EFSYS_OPT_TUNNEL */
519 
520 typedef struct efx_mcdi_ops_s {
521 	efx_rc_t	(*emco_init)(efx_nic_t *, const efx_mcdi_transport_t *);
522 	void		(*emco_send_request)(efx_nic_t *, void *, size_t,
523 					void *, size_t);
524 	efx_rc_t	(*emco_poll_reboot)(efx_nic_t *);
525 	boolean_t	(*emco_poll_response)(efx_nic_t *);
526 	void		(*emco_read_response)(efx_nic_t *, void *, size_t, size_t);
527 	void		(*emco_fini)(efx_nic_t *);
528 	efx_rc_t	(*emco_feature_supported)(efx_nic_t *,
529 					    efx_mcdi_feature_id_t, boolean_t *);
530 	void		(*emco_get_timeout)(efx_nic_t *, efx_mcdi_req_t *,
531 					    uint32_t *);
532 } efx_mcdi_ops_t;
533 
534 typedef struct efx_mcdi_s {
535 	const efx_mcdi_ops_t		*em_emcop;
536 	const efx_mcdi_transport_t	*em_emtp;
537 	efx_mcdi_iface_t		em_emip;
538 } efx_mcdi_t;
539 
540 #endif /* EFSYS_OPT_MCDI */
541 
542 #if EFSYS_OPT_NVRAM
543 
544 /* Invalid partition ID for en_nvram_partn_locked field of efx_nc_t */
545 #define	EFX_NVRAM_PARTN_INVALID		(0xffffffffu)
546 
547 typedef struct efx_nvram_ops_s {
548 #if EFSYS_OPT_DIAG
549 	efx_rc_t	(*envo_test)(efx_nic_t *);
550 #endif	/* EFSYS_OPT_DIAG */
551 	efx_rc_t	(*envo_type_to_partn)(efx_nic_t *, efx_nvram_type_t,
552 					    uint32_t *);
553 	efx_rc_t	(*envo_partn_info)(efx_nic_t *, uint32_t,
554 					    efx_nvram_info_t *);
555 	efx_rc_t	(*envo_partn_rw_start)(efx_nic_t *, uint32_t, size_t *);
556 	efx_rc_t	(*envo_partn_read)(efx_nic_t *, uint32_t,
557 					    unsigned int, caddr_t, size_t);
558 	efx_rc_t	(*envo_partn_read_backup)(efx_nic_t *, uint32_t,
559 					    unsigned int, caddr_t, size_t);
560 	efx_rc_t	(*envo_partn_erase)(efx_nic_t *, uint32_t,
561 					    unsigned int, size_t);
562 	efx_rc_t	(*envo_partn_write)(efx_nic_t *, uint32_t,
563 					    unsigned int, caddr_t, size_t);
564 	efx_rc_t	(*envo_partn_rw_finish)(efx_nic_t *, uint32_t,
565 					    uint32_t *);
566 	efx_rc_t	(*envo_partn_get_version)(efx_nic_t *, uint32_t,
567 					    uint32_t *, uint16_t *);
568 	efx_rc_t	(*envo_partn_set_version)(efx_nic_t *, uint32_t,
569 					    uint16_t *);
570 	efx_rc_t	(*envo_buffer_validate)(uint32_t,
571 					    caddr_t, size_t);
572 } efx_nvram_ops_t;
573 #endif /* EFSYS_OPT_NVRAM */
574 
575 #if EFSYS_OPT_VPD
576 typedef struct efx_vpd_ops_s {
577 	efx_rc_t	(*evpdo_init)(efx_nic_t *);
578 	efx_rc_t	(*evpdo_size)(efx_nic_t *, size_t *);
579 	efx_rc_t	(*evpdo_read)(efx_nic_t *, caddr_t, size_t);
580 	efx_rc_t	(*evpdo_verify)(efx_nic_t *, caddr_t, size_t);
581 	efx_rc_t	(*evpdo_reinit)(efx_nic_t *, caddr_t, size_t);
582 	efx_rc_t	(*evpdo_get)(efx_nic_t *, caddr_t, size_t,
583 					efx_vpd_value_t *);
584 	efx_rc_t	(*evpdo_set)(efx_nic_t *, caddr_t, size_t,
585 					efx_vpd_value_t *);
586 	efx_rc_t	(*evpdo_next)(efx_nic_t *, caddr_t, size_t,
587 					efx_vpd_value_t *, unsigned int *);
588 	efx_rc_t	(*evpdo_write)(efx_nic_t *, caddr_t, size_t);
589 	void		(*evpdo_fini)(efx_nic_t *);
590 } efx_vpd_ops_t;
591 #endif	/* EFSYS_OPT_VPD */
592 
593 #if EFSYS_OPT_VPD || EFSYS_OPT_NVRAM
594 
595 LIBEFX_INTERNAL
596 extern	__checkReturn		efx_rc_t
597 efx_mcdi_nvram_partitions(
598 	__in			efx_nic_t *enp,
599 	__out_bcount(size)	caddr_t data,
600 	__in			size_t size,
601 	__out			unsigned int *npartnp);
602 
603 LIBEFX_INTERNAL
604 extern	__checkReturn		efx_rc_t
605 efx_mcdi_nvram_metadata(
606 	__in			efx_nic_t *enp,
607 	__in			uint32_t partn,
608 	__out			uint32_t *subtypep,
609 	__out_ecount(4)		uint16_t version[4],
610 	__out_bcount_opt(size)	char *descp,
611 	__in			size_t size);
612 
613 LIBEFX_INTERNAL
614 extern	__checkReturn		efx_rc_t
615 efx_mcdi_nvram_info(
616 	__in			efx_nic_t *enp,
617 	__in			uint32_t partn,
618 	__out			efx_nvram_info_t *eni);
619 
620 LIBEFX_INTERNAL
621 extern	__checkReturn		efx_rc_t
622 efx_mcdi_nvram_update_start(
623 	__in			efx_nic_t *enp,
624 	__in			uint32_t partn);
625 
626 LIBEFX_INTERNAL
627 extern	__checkReturn		efx_rc_t
628 efx_mcdi_nvram_read(
629 	__in			efx_nic_t *enp,
630 	__in			uint32_t partn,
631 	__in			uint32_t offset,
632 	__out_bcount(size)	caddr_t data,
633 	__in			size_t size,
634 	__in			uint32_t mode);
635 
636 LIBEFX_INTERNAL
637 extern	__checkReturn		efx_rc_t
638 efx_mcdi_nvram_erase(
639 	__in			efx_nic_t *enp,
640 	__in			uint32_t partn,
641 	__in			uint32_t offset,
642 	__in			size_t size);
643 
644 LIBEFX_INTERNAL
645 extern	__checkReturn		efx_rc_t
646 efx_mcdi_nvram_write(
647 	__in			efx_nic_t *enp,
648 	__in			uint32_t partn,
649 	__in			uint32_t offset,
650 	__in_bcount(size)	caddr_t data,
651 	__in			size_t size);
652 
653 #define	EFX_NVRAM_UPDATE_FLAGS_BACKGROUND	0x00000001
654 #define	EFX_NVRAM_UPDATE_FLAGS_POLL		0x00000002
655 
656 LIBEFX_INTERNAL
657 extern	__checkReturn		efx_rc_t
658 efx_mcdi_nvram_update_finish(
659 	__in			efx_nic_t *enp,
660 	__in			uint32_t partn,
661 	__in			boolean_t reboot,
662 	__in			uint32_t flags,
663 	__out_opt		uint32_t *verify_resultp);
664 
665 #if EFSYS_OPT_DIAG
666 
667 LIBEFX_INTERNAL
668 extern	__checkReturn		efx_rc_t
669 efx_mcdi_nvram_test(
670 	__in			efx_nic_t *enp,
671 	__in			uint32_t partn);
672 
673 #endif	/* EFSYS_OPT_DIAG */
674 
675 #endif /* EFSYS_OPT_VPD || EFSYS_OPT_NVRAM */
676 
677 #if EFSYS_OPT_LICENSING
678 
679 typedef struct efx_lic_ops_s {
680 	efx_rc_t	(*elo_update_licenses)(efx_nic_t *);
681 	efx_rc_t	(*elo_get_key_stats)(efx_nic_t *, efx_key_stats_t *);
682 	efx_rc_t	(*elo_app_state)(efx_nic_t *, uint64_t, boolean_t *);
683 	efx_rc_t	(*elo_get_id)(efx_nic_t *, size_t, uint32_t *,
684 				      size_t *, uint8_t *);
685 	efx_rc_t	(*elo_find_start)
686 				(efx_nic_t *, caddr_t, size_t, uint32_t *);
687 	efx_rc_t	(*elo_find_end)(efx_nic_t *, caddr_t, size_t,
688 				uint32_t, uint32_t *);
689 	boolean_t	(*elo_find_key)(efx_nic_t *, caddr_t, size_t,
690 				uint32_t, uint32_t *, uint32_t *);
691 	boolean_t	(*elo_validate_key)(efx_nic_t *,
692 				caddr_t, uint32_t);
693 	efx_rc_t	(*elo_read_key)(efx_nic_t *,
694 				caddr_t, size_t, uint32_t, uint32_t,
695 				caddr_t, size_t, uint32_t *);
696 	efx_rc_t	(*elo_write_key)(efx_nic_t *,
697 				caddr_t, size_t, uint32_t,
698 				caddr_t, uint32_t, uint32_t *);
699 	efx_rc_t	(*elo_delete_key)(efx_nic_t *,
700 				caddr_t, size_t, uint32_t,
701 				uint32_t, uint32_t, uint32_t *);
702 	efx_rc_t	(*elo_create_partition)(efx_nic_t *,
703 				caddr_t, size_t);
704 	efx_rc_t	(*elo_finish_partition)(efx_nic_t *,
705 				caddr_t, size_t);
706 } efx_lic_ops_t;
707 
708 #endif
709 
710 #if EFSYS_OPT_EVB
711 
712 struct efx_vswitch_s {
713 	efx_nic_t		*ev_enp;
714 	efx_vswitch_id_t	ev_vswitch_id;
715 	uint32_t		ev_num_vports;
716 	/*
717 	 * Vport configuration array: index 0 to store PF configuration
718 	 * and next ev_num_vports-1 entries hold VFs configuration.
719 	 */
720 	efx_vport_config_t	*ev_evcp;
721 };
722 
723 typedef struct efx_evb_ops_s {
724 	efx_rc_t	(*eeo_init)(efx_nic_t *);
725 	void		(*eeo_fini)(efx_nic_t *);
726 	efx_rc_t	(*eeo_vswitch_alloc)(efx_nic_t *, efx_vswitch_id_t *);
727 	efx_rc_t	(*eeo_vswitch_free)(efx_nic_t *, efx_vswitch_id_t);
728 	efx_rc_t	(*eeo_vport_alloc)(efx_nic_t *, efx_vswitch_id_t,
729 						efx_vport_type_t, uint16_t,
730 						boolean_t, efx_vport_id_t *);
731 	efx_rc_t	(*eeo_vport_free)(efx_nic_t *, efx_vswitch_id_t,
732 						efx_vport_id_t);
733 	efx_rc_t	(*eeo_vport_mac_addr_add)(efx_nic_t *, efx_vswitch_id_t,
734 						efx_vport_id_t, uint8_t *);
735 	efx_rc_t	(*eeo_vport_mac_addr_del)(efx_nic_t *, efx_vswitch_id_t,
736 						efx_vport_id_t, uint8_t *);
737 	efx_rc_t	(*eeo_vadaptor_alloc)(efx_nic_t *, efx_vswitch_id_t,
738 						efx_vport_id_t);
739 	efx_rc_t	(*eeo_vadaptor_free)(efx_nic_t *, efx_vswitch_id_t,
740 						efx_vport_id_t);
741 	efx_rc_t	(*eeo_vport_assign)(efx_nic_t *, efx_vswitch_id_t,
742 						efx_vport_id_t, uint32_t);
743 	efx_rc_t	(*eeo_vport_reconfigure)(efx_nic_t *, efx_vswitch_id_t,
744 							efx_vport_id_t,
745 							uint16_t *, uint8_t *,
746 							boolean_t *);
747 	efx_rc_t	(*eeo_vport_stats)(efx_nic_t *, efx_vswitch_id_t,
748 						efx_vport_id_t, efsys_mem_t *);
749 } efx_evb_ops_t;
750 
751 LIBEFX_INTERNAL
752 extern __checkReturn	boolean_t
753 efx_is_zero_eth_addr(
754 	__in_bcount(EFX_MAC_ADDR_LEN)	const uint8_t *addrp);
755 
756 #endif /* EFSYS_OPT_EVB */
757 
758 #if EFSYS_OPT_MCDI_PROXY_AUTH_SERVER
759 
760 #define	EFX_PROXY_CONFIGURE_MAGIC	0xAB2015EF
761 
762 
763 typedef struct efx_proxy_ops_s {
764 	efx_rc_t	(*epo_init)(efx_nic_t *);
765 	void		(*epo_fini)(efx_nic_t *);
766 	efx_rc_t	(*epo_mc_config)(efx_nic_t *, efsys_mem_t *,
767 					efsys_mem_t *, efsys_mem_t *,
768 					uint32_t, uint32_t *, size_t);
769 	efx_rc_t	(*epo_disable)(efx_nic_t *);
770 	efx_rc_t	(*epo_privilege_modify)(efx_nic_t *, uint32_t, uint32_t,
771 					uint32_t, uint32_t, uint32_t);
772 	efx_rc_t	(*epo_set_privilege_mask)(efx_nic_t *, uint32_t,
773 					uint32_t, uint32_t);
774 	efx_rc_t	(*epo_complete_request)(efx_nic_t *, uint32_t,
775 					uint32_t, uint32_t);
776 	efx_rc_t	(*epo_exec_cmd)(efx_nic_t *, efx_proxy_cmd_params_t *);
777 	efx_rc_t	(*epo_get_privilege_mask)(efx_nic_t *, uint32_t,
778 					uint32_t, uint32_t *);
779 } efx_proxy_ops_t;
780 
781 #endif /* EFSYS_OPT_MCDI_PROXY_AUTH_SERVER */
782 
783 #if EFSYS_OPT_MAE
784 
785 typedef struct efx_mae_field_cap_s {
786 	uint32_t			emfc_support;
787 	boolean_t			emfc_mask_affects_class;
788 	boolean_t			emfc_match_affects_class;
789 } efx_mae_field_cap_t;
790 
791 typedef struct efx_mae_s {
792 	uint32_t			em_max_n_action_prios;
793 	/*
794 	 * The number of MAE field IDs recognised by the FW implementation.
795 	 * Any field ID greater than or equal to this value is unsupported.
796 	 */
797 	uint32_t			em_max_nfields;
798 	/** Action rule match field capabilities. */
799 	efx_mae_field_cap_t		*em_action_rule_field_caps;
800 	size_t				em_action_rule_field_caps_size;
801 	uint32_t			em_max_n_outer_prios;
802 	uint32_t			em_encap_types_supported;
803 	/** Outer rule match field capabilities. */
804 	efx_mae_field_cap_t		*em_outer_rule_field_caps;
805 	size_t				em_outer_rule_field_caps_size;
806 } efx_mae_t;
807 
808 #endif /* EFSYS_OPT_MAE */
809 
810 #define	EFX_DRV_VER_MAX		20
811 
812 typedef struct efx_drv_cfg_s {
813 	uint32_t		edc_min_vi_count;
814 	uint32_t		edc_max_vi_count;
815 
816 	uint32_t		edc_max_piobuf_count;
817 	uint32_t		edc_pio_alloc_size;
818 } efx_drv_cfg_t;
819 
820 struct efx_nic_s {
821 	uint32_t		en_magic;
822 	efx_family_t		en_family;
823 	uint32_t		en_features;
824 	efsys_identifier_t	*en_esip;
825 	efsys_lock_t		*en_eslp;
826 	efsys_bar_t		*en_esbp;
827 	unsigned int		en_mod_flags;
828 	unsigned int		en_reset_flags;
829 	efx_nic_cfg_t		en_nic_cfg;
830 	efx_drv_cfg_t		en_drv_cfg;
831 	efx_port_t		en_port;
832 	efx_mon_t		en_mon;
833 	efx_intr_t		en_intr;
834 	uint32_t		en_ev_qcount;
835 	uint32_t		en_rx_qcount;
836 	uint32_t		en_tx_qcount;
837 	const efx_nic_ops_t	*en_enop;
838 	const efx_ev_ops_t	*en_eevop;
839 	const efx_tx_ops_t	*en_etxop;
840 	const efx_rx_ops_t	*en_erxop;
841 	efx_fw_variant_t	efv;
842 	char			en_drv_version[EFX_DRV_VER_MAX];
843 #if EFSYS_OPT_FILTER
844 	efx_filter_t		en_filter;
845 	const efx_filter_ops_t	*en_efop;
846 #endif	/* EFSYS_OPT_FILTER */
847 #if EFSYS_OPT_TUNNEL
848 	efx_tunnel_cfg_t	en_tunnel_cfg;
849 	const efx_tunnel_ops_t	*en_etop;
850 #endif /* EFSYS_OPT_TUNNEL */
851 #if EFSYS_OPT_MCDI
852 	efx_mcdi_t		en_mcdi;
853 #endif	/* EFSYS_OPT_MCDI */
854 #if EFSYS_OPT_NVRAM
855 	uint32_t		en_nvram_partn_locked;
856 	const efx_nvram_ops_t	*en_envop;
857 #endif	/* EFSYS_OPT_NVRAM */
858 #if EFSYS_OPT_VPD
859 	const efx_vpd_ops_t	*en_evpdop;
860 #endif	/* EFSYS_OPT_VPD */
861 #if EFSYS_OPT_RX_SCALE
862 	efx_rx_hash_support_t		en_hash_support;
863 	efx_rx_scale_context_type_t	en_rss_context_type;
864 	uint32_t			en_rss_context;
865 #endif	/* EFSYS_OPT_RX_SCALE */
866 	uint32_t		en_vport_id;
867 #if EFSYS_OPT_LICENSING
868 	const efx_lic_ops_t	*en_elop;
869 	boolean_t		en_licensing_supported;
870 #endif
871 	union {
872 #if EFSYS_OPT_SIENA
873 		struct {
874 #if EFSYS_OPT_NVRAM || EFSYS_OPT_VPD
875 			unsigned int		enu_partn_mask;
876 #endif	/* EFSYS_OPT_NVRAM || EFSYS_OPT_VPD */
877 #if EFSYS_OPT_VPD
878 			caddr_t			enu_svpd;
879 			size_t			enu_svpd_length;
880 #endif	/* EFSYS_OPT_VPD */
881 			int			enu_unused;
882 		} siena;
883 #endif	/* EFSYS_OPT_SIENA */
884 		int	enu_unused;
885 	} en_u;
886 #if EFSYS_OPT_RIVERHEAD || EFX_OPTS_EF10()
887 	union en_arch {
888 		struct {
889 			int			ena_vi_base;
890 			int			ena_vi_count;
891 			int			ena_vi_shift;
892 			uint32_t		ena_fcw_base;
893 #if EFSYS_OPT_VPD
894 			caddr_t			ena_svpd;
895 			size_t			ena_svpd_length;
896 #endif	/* EFSYS_OPT_VPD */
897 			efx_piobuf_handle_t	ena_piobuf_handle[EF10_MAX_PIOBUF_NBUFS];
898 			uint32_t		ena_piobuf_count;
899 			uint32_t		ena_pio_alloc_map[EF10_MAX_PIOBUF_NBUFS];
900 			uint32_t		ena_pio_write_vi_base;
901 			/* Memory BAR mapping regions */
902 			uint32_t		ena_uc_mem_map_offset;
903 			size_t			ena_uc_mem_map_size;
904 			uint32_t		ena_wc_mem_map_offset;
905 			size_t			ena_wc_mem_map_size;
906 		} ef10;
907 	} en_arch;
908 #endif	/* EFSYS_OPT_RIVERHEAD || EFX_OPTS_EF10() */
909 #if EFSYS_OPT_EVB
910 	const efx_evb_ops_t	*en_eeop;
911 	struct efx_vswitch_s    *en_vswitchp;
912 #endif	/* EFSYS_OPT_EVB */
913 #if EFSYS_OPT_MCDI_PROXY_AUTH_SERVER
914 	const efx_proxy_ops_t	*en_epop;
915 #endif	/* EFSYS_OPT_MCDI_PROXY_AUTH_SERVER */
916 #if EFSYS_OPT_MAE
917 	efx_mae_t		*en_maep;
918 #endif	/* EFSYS_OPT_MAE */
919 };
920 
921 #define	EFX_FAMILY_IS_EF10(_enp) \
922 	((_enp)->en_family == EFX_FAMILY_MEDFORD2 || \
923 	 (_enp)->en_family == EFX_FAMILY_MEDFORD || \
924 	 (_enp)->en_family == EFX_FAMILY_HUNTINGTON)
925 
926 #define	EFX_FAMILY_IS_EF100(_enp) \
927 	((_enp)->en_family == EFX_FAMILY_RIVERHEAD)
928 
929 
930 #define	EFX_NIC_MAGIC	0x02121996
931 
932 typedef	boolean_t (*efx_ev_handler_t)(efx_evq_t *, efx_qword_t *,
933     const efx_ev_callbacks_t *, void *);
934 
935 #if EFSYS_OPT_EV_EXTENDED_WIDTH
936 typedef	boolean_t (*efx_ev_ew_handler_t)(efx_evq_t *, efx_xword_t *,
937     const efx_ev_callbacks_t *, void *);
938 #endif /* EFSYS_OPT_EV_EXTENDED_WIDTH */
939 
940 typedef struct efx_evq_rxq_state_s {
941 	unsigned int			eers_rx_read_ptr;
942 	unsigned int			eers_rx_mask;
943 #if EFSYS_OPT_RX_PACKED_STREAM || EFSYS_OPT_RX_ES_SUPER_BUFFER
944 	unsigned int			eers_rx_stream_npackets;
945 	boolean_t			eers_rx_packed_stream;
946 #endif
947 #if EFSYS_OPT_RX_PACKED_STREAM
948 	unsigned int			eers_rx_packed_stream_credits;
949 #endif
950 } efx_evq_rxq_state_t;
951 
952 struct efx_evq_s {
953 	uint32_t			ee_magic;
954 	uint32_t			ee_flags;
955 	efx_nic_t			*ee_enp;
956 	unsigned int			ee_index;
957 	unsigned int			ee_mask;
958 	efsys_mem_t			*ee_esmp;
959 #if EFSYS_OPT_QSTATS
960 	uint32_t			ee_stat[EV_NQSTATS];
961 #endif	/* EFSYS_OPT_QSTATS */
962 
963 	efx_ev_handler_t		ee_rx;
964 	efx_ev_handler_t		ee_tx;
965 	efx_ev_handler_t		ee_driver;
966 	efx_ev_handler_t		ee_global;
967 	efx_ev_handler_t		ee_drv_gen;
968 #if EFSYS_OPT_MCDI
969 	efx_ev_handler_t		ee_mcdi;
970 #endif	/* EFSYS_OPT_MCDI */
971 
972 #if EFSYS_OPT_DESC_PROXY
973 	efx_ev_ew_handler_t		ee_ew_txq_desc;
974 	efx_ev_ew_handler_t		ee_ew_virtq_desc;
975 #endif /* EFSYS_OPT_DESC_PROXY */
976 
977 	efx_evq_rxq_state_t		ee_rxq_state[EFX_EV_RX_NLABELS];
978 };
979 
980 #define	EFX_EVQ_MAGIC	0x08081997
981 
982 #define	EFX_EVQ_SIENA_TIMER_QUANTUM_NS	6144 /* 768 cycles */
983 
984 #if EFSYS_OPT_QSTATS
985 #define	EFX_EV_QSTAT_INCR(_eep, _stat)					\
986 	do {								\
987 		(_eep)->ee_stat[_stat]++;				\
988 	_NOTE(CONSTANTCONDITION)					\
989 	} while (B_FALSE)
990 #else
991 #define	EFX_EV_QSTAT_INCR(_eep, _stat)
992 #endif
993 
994 struct efx_rxq_s {
995 	uint32_t			er_magic;
996 	efx_nic_t			*er_enp;
997 	efx_evq_t			*er_eep;
998 	unsigned int			er_index;
999 	unsigned int			er_label;
1000 	unsigned int			er_mask;
1001 	size_t				er_buf_size;
1002 	efsys_mem_t			*er_esmp;
1003 	efx_evq_rxq_state_t		*er_ev_qstate;
1004 	efx_rx_prefix_layout_t		er_prefix_layout;
1005 };
1006 
1007 #define	EFX_RXQ_MAGIC	0x15022005
1008 
1009 struct efx_txq_s {
1010 	uint32_t			et_magic;
1011 	efx_nic_t			*et_enp;
1012 	unsigned int			et_index;
1013 	unsigned int			et_mask;
1014 	efsys_mem_t			*et_esmp;
1015 #if EFSYS_OPT_HUNTINGTON
1016 	uint32_t			et_pio_bufnum;
1017 	uint32_t			et_pio_blknum;
1018 	uint32_t			et_pio_write_offset;
1019 	uint32_t			et_pio_offset;
1020 	size_t				et_pio_size;
1021 #endif
1022 #if EFSYS_OPT_QSTATS
1023 	uint32_t			et_stat[TX_NQSTATS];
1024 #endif	/* EFSYS_OPT_QSTATS */
1025 };
1026 
1027 #define	EFX_TXQ_MAGIC	0x05092005
1028 
1029 #define	EFX_MAC_ADDR_COPY(_dst, _src)					\
1030 	do {								\
1031 		(_dst)[0] = (_src)[0];					\
1032 		(_dst)[1] = (_src)[1];					\
1033 		(_dst)[2] = (_src)[2];					\
1034 		(_dst)[3] = (_src)[3];					\
1035 		(_dst)[4] = (_src)[4];					\
1036 		(_dst)[5] = (_src)[5];					\
1037 	_NOTE(CONSTANTCONDITION)					\
1038 	} while (B_FALSE)
1039 
1040 #define	EFX_MAC_BROADCAST_ADDR_SET(_dst)				\
1041 	do {								\
1042 		uint16_t *_d = (uint16_t *)(_dst);			\
1043 		_d[0] = 0xffff;						\
1044 		_d[1] = 0xffff;						\
1045 		_d[2] = 0xffff;						\
1046 	_NOTE(CONSTANTCONDITION)					\
1047 	} while (B_FALSE)
1048 
1049 #if EFSYS_OPT_CHECK_REG
1050 #define	EFX_CHECK_REG(_enp, _reg)					\
1051 	do {								\
1052 		const char *name = #_reg;				\
1053 		char min = name[4];					\
1054 		char max = name[5];					\
1055 		char rev;						\
1056 									\
1057 		switch ((_enp)->en_family) {				\
1058 		case EFX_FAMILY_SIENA:					\
1059 			rev = 'C';					\
1060 			break;						\
1061 									\
1062 		case EFX_FAMILY_HUNTINGTON:				\
1063 			rev = 'D';					\
1064 			break;						\
1065 									\
1066 		case EFX_FAMILY_MEDFORD:				\
1067 			rev = 'E';					\
1068 			break;						\
1069 									\
1070 		case EFX_FAMILY_MEDFORD2:				\
1071 			rev = 'F';					\
1072 			break;						\
1073 									\
1074 		case EFX_FAMILY_RIVERHEAD:				\
1075 			rev = 'G';					\
1076 			break;						\
1077 									\
1078 		default:						\
1079 			rev = '?';					\
1080 			break;						\
1081 		}							\
1082 									\
1083 		EFSYS_ASSERT3S(rev, >=, min);				\
1084 		EFSYS_ASSERT3S(rev, <=, max);				\
1085 									\
1086 	_NOTE(CONSTANTCONDITION)					\
1087 	} while (B_FALSE)
1088 #else
1089 #define	EFX_CHECK_REG(_enp, _reg) do {					\
1090 	_NOTE(CONSTANTCONDITION)					\
1091 	} while (B_FALSE)
1092 #endif
1093 
1094 #define	EFX_BAR_READD(_enp, _reg, _edp, _lock)				\
1095 	do {								\
1096 		EFX_CHECK_REG((_enp), (_reg));				\
1097 		EFSYS_BAR_READD((_enp)->en_esbp, _reg ## _OFST,		\
1098 		    (_edp), (_lock));					\
1099 		EFSYS_PROBE3(efx_bar_readd, const char *, #_reg,	\
1100 		    uint32_t, _reg ## _OFST,				\
1101 		    uint32_t, (_edp)->ed_u32[0]);			\
1102 	_NOTE(CONSTANTCONDITION)					\
1103 	} while (B_FALSE)
1104 
1105 #define	EFX_BAR_WRITED(_enp, _reg, _edp, _lock)				\
1106 	do {								\
1107 		EFX_CHECK_REG((_enp), (_reg));				\
1108 		EFSYS_PROBE3(efx_bar_writed, const char *, #_reg,	\
1109 		    uint32_t, _reg ## _OFST,				\
1110 		    uint32_t, (_edp)->ed_u32[0]);			\
1111 		EFSYS_BAR_WRITED((_enp)->en_esbp, _reg ## _OFST,	\
1112 		    (_edp), (_lock));					\
1113 	_NOTE(CONSTANTCONDITION)					\
1114 	} while (B_FALSE)
1115 
1116 #define	EFX_BAR_READQ(_enp, _reg, _eqp)					\
1117 	do {								\
1118 		EFX_CHECK_REG((_enp), (_reg));				\
1119 		EFSYS_BAR_READQ((_enp)->en_esbp, _reg ## _OFST,		\
1120 		    (_eqp));						\
1121 		EFSYS_PROBE4(efx_bar_readq, const char *, #_reg,	\
1122 		    uint32_t, _reg ## _OFST,				\
1123 		    uint32_t, (_eqp)->eq_u32[1],			\
1124 		    uint32_t, (_eqp)->eq_u32[0]);			\
1125 	_NOTE(CONSTANTCONDITION)					\
1126 	} while (B_FALSE)
1127 
1128 #define	EFX_BAR_WRITEQ(_enp, _reg, _eqp)				\
1129 	do {								\
1130 		EFX_CHECK_REG((_enp), (_reg));				\
1131 		EFSYS_PROBE4(efx_bar_writeq, const char *, #_reg,	\
1132 		    uint32_t, _reg ## _OFST,				\
1133 		    uint32_t, (_eqp)->eq_u32[1],			\
1134 		    uint32_t, (_eqp)->eq_u32[0]);			\
1135 		EFSYS_BAR_WRITEQ((_enp)->en_esbp, _reg ## _OFST,	\
1136 		    (_eqp));						\
1137 	_NOTE(CONSTANTCONDITION)					\
1138 	} while (B_FALSE)
1139 
1140 #define	EFX_BAR_READO(_enp, _reg, _eop)					\
1141 	do {								\
1142 		EFX_CHECK_REG((_enp), (_reg));				\
1143 		EFSYS_BAR_READO((_enp)->en_esbp, _reg ## _OFST,		\
1144 		    (_eop), B_TRUE);					\
1145 		EFSYS_PROBE6(efx_bar_reado, const char *, #_reg,	\
1146 		    uint32_t, _reg ## _OFST,				\
1147 		    uint32_t, (_eop)->eo_u32[3],			\
1148 		    uint32_t, (_eop)->eo_u32[2],			\
1149 		    uint32_t, (_eop)->eo_u32[1],			\
1150 		    uint32_t, (_eop)->eo_u32[0]);			\
1151 	_NOTE(CONSTANTCONDITION)					\
1152 	} while (B_FALSE)
1153 
1154 #define	EFX_BAR_WRITEO(_enp, _reg, _eop)				\
1155 	do {								\
1156 		EFX_CHECK_REG((_enp), (_reg));				\
1157 		EFSYS_PROBE6(efx_bar_writeo, const char *, #_reg,	\
1158 		    uint32_t, _reg ## _OFST,				\
1159 		    uint32_t, (_eop)->eo_u32[3],			\
1160 		    uint32_t, (_eop)->eo_u32[2],			\
1161 		    uint32_t, (_eop)->eo_u32[1],			\
1162 		    uint32_t, (_eop)->eo_u32[0]);			\
1163 		EFSYS_BAR_WRITEO((_enp)->en_esbp, _reg ## _OFST,	\
1164 		    (_eop), B_TRUE);					\
1165 	_NOTE(CONSTANTCONDITION)					\
1166 	} while (B_FALSE)
1167 
1168 /*
1169  * Accessors for memory BAR non-VI tables.
1170  *
1171  * Code used on EF10 *must* use EFX_BAR_VI_*() macros for per-VI registers,
1172  * to ensure the correct runtime VI window size is used on Medford2.
1173  *
1174  * Code used on EF100 *must* use EFX_BAR_FCW_* macros for function control
1175  * window registers, to ensure the correct starting offset is used.
1176  *
1177  * Siena-only code may continue using EFX_BAR_TBL_*() macros for VI registers.
1178  */
1179 
1180 #define	EFX_BAR_TBL_READD(_enp, _reg, _index, _edp, _lock)		\
1181 	do {								\
1182 		EFX_CHECK_REG((_enp), (_reg));				\
1183 		EFSYS_BAR_READD((_enp)->en_esbp,			\
1184 		    (_reg ## _OFST + ((_index) * _reg ## _STEP)),	\
1185 		    (_edp), (_lock));					\
1186 		EFSYS_PROBE4(efx_bar_tbl_readd, const char *, #_reg,	\
1187 		    uint32_t, (_index),					\
1188 		    uint32_t, _reg ## _OFST,				\
1189 		    uint32_t, (_edp)->ed_u32[0]);			\
1190 	_NOTE(CONSTANTCONDITION)					\
1191 	} while (B_FALSE)
1192 
1193 #define	EFX_BAR_TBL_WRITED(_enp, _reg, _index, _edp, _lock)		\
1194 	do {								\
1195 		EFX_CHECK_REG((_enp), (_reg));				\
1196 		EFSYS_PROBE4(efx_bar_tbl_writed, const char *, #_reg,	\
1197 		    uint32_t, (_index),					\
1198 		    uint32_t, _reg ## _OFST,				\
1199 		    uint32_t, (_edp)->ed_u32[0]);			\
1200 		EFSYS_BAR_WRITED((_enp)->en_esbp,			\
1201 		    (_reg ## _OFST + ((_index) * _reg ## _STEP)),	\
1202 		    (_edp), (_lock));					\
1203 	_NOTE(CONSTANTCONDITION)					\
1204 	} while (B_FALSE)
1205 
1206 #define	EFX_BAR_TBL_WRITED3(_enp, _reg, _index, _edp, _lock)		\
1207 	do {								\
1208 		EFX_CHECK_REG((_enp), (_reg));				\
1209 		EFSYS_PROBE4(efx_bar_tbl_writed, const char *, #_reg,	\
1210 		    uint32_t, (_index),					\
1211 		    uint32_t, _reg ## _OFST,				\
1212 		    uint32_t, (_edp)->ed_u32[0]);			\
1213 		EFSYS_BAR_WRITED((_enp)->en_esbp,			\
1214 		    (_reg ## _OFST +					\
1215 		    (3 * sizeof (efx_dword_t)) +			\
1216 		    ((_index) * _reg ## _STEP)),			\
1217 		    (_edp), (_lock));					\
1218 	_NOTE(CONSTANTCONDITION)					\
1219 	} while (B_FALSE)
1220 
1221 #define	EFX_BAR_TBL_READQ(_enp, _reg, _index, _eqp)			\
1222 	do {								\
1223 		EFX_CHECK_REG((_enp), (_reg));				\
1224 		EFSYS_BAR_READQ((_enp)->en_esbp,			\
1225 		    (_reg ## _OFST + ((_index) * _reg ## _STEP)),	\
1226 		    (_eqp));						\
1227 		EFSYS_PROBE5(efx_bar_tbl_readq, const char *, #_reg,	\
1228 		    uint32_t, (_index),					\
1229 		    uint32_t, _reg ## _OFST,				\
1230 		    uint32_t, (_eqp)->eq_u32[1],			\
1231 		    uint32_t, (_eqp)->eq_u32[0]);			\
1232 	_NOTE(CONSTANTCONDITION)					\
1233 	} while (B_FALSE)
1234 
1235 #define	EFX_BAR_TBL_WRITEQ(_enp, _reg, _index, _eqp)			\
1236 	do {								\
1237 		EFX_CHECK_REG((_enp), (_reg));				\
1238 		EFSYS_PROBE5(efx_bar_tbl_writeq, const char *, #_reg,	\
1239 		    uint32_t, (_index),					\
1240 		    uint32_t, _reg ## _OFST,				\
1241 		    uint32_t, (_eqp)->eq_u32[1],			\
1242 		    uint32_t, (_eqp)->eq_u32[0]);			\
1243 		EFSYS_BAR_WRITEQ((_enp)->en_esbp,			\
1244 		    (_reg ## _OFST + ((_index) * _reg ## _STEP)),	\
1245 		    (_eqp));						\
1246 	_NOTE(CONSTANTCONDITION)					\
1247 	} while (B_FALSE)
1248 
1249 #define	EFX_BAR_TBL_READO(_enp, _reg, _index, _eop, _lock)		\
1250 	do {								\
1251 		EFX_CHECK_REG((_enp), (_reg));				\
1252 		EFSYS_BAR_READO((_enp)->en_esbp,			\
1253 		    (_reg ## _OFST + ((_index) * _reg ## _STEP)),	\
1254 		    (_eop), (_lock));					\
1255 		EFSYS_PROBE7(efx_bar_tbl_reado, const char *, #_reg,	\
1256 		    uint32_t, (_index),					\
1257 		    uint32_t, _reg ## _OFST,				\
1258 		    uint32_t, (_eop)->eo_u32[3],			\
1259 		    uint32_t, (_eop)->eo_u32[2],			\
1260 		    uint32_t, (_eop)->eo_u32[1],			\
1261 		    uint32_t, (_eop)->eo_u32[0]);			\
1262 	_NOTE(CONSTANTCONDITION)					\
1263 	} while (B_FALSE)
1264 
1265 #define	EFX_BAR_TBL_WRITEO(_enp, _reg, _index, _eop, _lock)		\
1266 	do {								\
1267 		EFX_CHECK_REG((_enp), (_reg));				\
1268 		EFSYS_PROBE7(efx_bar_tbl_writeo, const char *, #_reg,	\
1269 		    uint32_t, (_index),					\
1270 		    uint32_t, _reg ## _OFST,				\
1271 		    uint32_t, (_eop)->eo_u32[3],			\
1272 		    uint32_t, (_eop)->eo_u32[2],			\
1273 		    uint32_t, (_eop)->eo_u32[1],			\
1274 		    uint32_t, (_eop)->eo_u32[0]);			\
1275 		EFSYS_BAR_WRITEO((_enp)->en_esbp,			\
1276 		    (_reg ## _OFST + ((_index) * _reg ## _STEP)),	\
1277 		    (_eop), (_lock));					\
1278 	_NOTE(CONSTANTCONDITION)					\
1279 	} while (B_FALSE)
1280 
1281 /*
1282  * Accessors for memory BAR function control window registers.
1283  *
1284  * The function control window is located at an offset which can be
1285  * non-zero in case of Riverhead.
1286  */
1287 
1288 #if EFSYS_OPT_RIVERHEAD
1289 
1290 #define	EFX_BAR_FCW_READD(_enp, _reg, _edp)				\
1291 	do {								\
1292 		EFX_CHECK_REG((_enp), (_reg));				\
1293 		EFSYS_BAR_READD((_enp)->en_esbp, _reg ## _OFST +	\
1294 		    (_enp)->en_arch.ef10.ena_fcw_base,			\
1295 		    (_edp), B_FALSE);					\
1296 		EFSYS_PROBE3(efx_bar_fcw_readd, const char *, #_reg,	\
1297 		    uint32_t, _reg ## _OFST,				\
1298 		    uint32_t, (_edp)->ed_u32[0]);			\
1299 	_NOTE(CONSTANTCONDITION)					\
1300 	} while (B_FALSE)
1301 
1302 #define	EFX_BAR_FCW_WRITED(_enp, _reg, _edp)				\
1303 	do {								\
1304 		EFX_CHECK_REG((_enp), (_reg));				\
1305 		EFSYS_PROBE3(efx_bar_fcw_writed, const char *, #_reg,	\
1306 		    uint32_t, _reg ## _OFST,				\
1307 		    uint32_t, (_edp)->ed_u32[0]);			\
1308 		EFSYS_BAR_WRITED((_enp)->en_esbp, _reg ## _OFST +	\
1309 		    (_enp)->en_arch.ef10.ena_fcw_base,			\
1310 		    (_edp), B_FALSE);					\
1311 	_NOTE(CONSTANTCONDITION)					\
1312 	} while (B_FALSE)
1313 
1314 #endif	/* EFSYS_OPT_RIVERHEAD */
1315 
1316 /*
1317  * Accessors for memory BAR per-VI registers.
1318  *
1319  * The VI window size is 8KB for Medford and all earlier controllers.
1320  * For Medford2, the VI window size can be 8KB, 16KB or 64KB.
1321  */
1322 
1323 #define	EFX_BAR_VI_READD(_enp, _reg, _index, _edp, _lock)		\
1324 	do {								\
1325 		EFX_CHECK_REG((_enp), (_reg));				\
1326 		EFSYS_BAR_READD((_enp)->en_esbp,			\
1327 		    ((_reg ## _OFST) +					\
1328 		    ((_index) << (_enp)->en_nic_cfg.enc_vi_window_shift)), \
1329 		    (_edp), (_lock));					\
1330 		EFSYS_PROBE4(efx_bar_vi_readd, const char *, #_reg,	\
1331 		    uint32_t, (_index),					\
1332 		    uint32_t, _reg ## _OFST,				\
1333 		    uint32_t, (_edp)->ed_u32[0]);			\
1334 	_NOTE(CONSTANTCONDITION)					\
1335 	} while (B_FALSE)
1336 
1337 #define	EFX_BAR_VI_WRITED(_enp, _reg, _index, _edp, _lock)		\
1338 	do {								\
1339 		EFX_CHECK_REG((_enp), (_reg));				\
1340 		EFSYS_PROBE4(efx_bar_vi_writed, const char *, #_reg,	\
1341 		    uint32_t, (_index),					\
1342 		    uint32_t, _reg ## _OFST,				\
1343 		    uint32_t, (_edp)->ed_u32[0]);			\
1344 		EFSYS_BAR_WRITED((_enp)->en_esbp,			\
1345 		    ((_reg ## _OFST) +					\
1346 		    ((_index) << (_enp)->en_nic_cfg.enc_vi_window_shift)), \
1347 		    (_edp), (_lock));					\
1348 	_NOTE(CONSTANTCONDITION)					\
1349 	} while (B_FALSE)
1350 
1351 #define	EFX_BAR_VI_WRITED2(_enp, _reg, _index, _edp, _lock)		\
1352 	do {								\
1353 		EFX_CHECK_REG((_enp), (_reg));				\
1354 		EFSYS_PROBE4(efx_bar_vi_writed, const char *, #_reg,	\
1355 		    uint32_t, (_index),					\
1356 		    uint32_t, _reg ## _OFST,				\
1357 		    uint32_t, (_edp)->ed_u32[0]);			\
1358 		EFSYS_BAR_WRITED((_enp)->en_esbp,			\
1359 		    ((_reg ## _OFST) +					\
1360 		    (2 * sizeof (efx_dword_t)) +			\
1361 		    ((_index) << (_enp)->en_nic_cfg.enc_vi_window_shift)), \
1362 		    (_edp), (_lock));					\
1363 	_NOTE(CONSTANTCONDITION)					\
1364 	} while (B_FALSE)
1365 
1366 /*
1367  * Allow drivers to perform optimised 128-bit VI doorbell writes.
1368  * The DMA descriptor pointers (RX_DESC_UPD and TX_DESC_UPD) are
1369  * special-cased in the BIU on the Falcon/Siena and EF10 architectures to avoid
1370  * the need for locking in the host, and are the only ones known to be safe to
1371  * use 128-bites write with.
1372  */
1373 #define	EFX_BAR_VI_DOORBELL_WRITEO(_enp, _reg, _index, _eop)		\
1374 	do {								\
1375 		EFX_CHECK_REG((_enp), (_reg));				\
1376 		EFSYS_PROBE7(efx_bar_vi_doorbell_writeo,		\
1377 		    const char *, #_reg,				\
1378 		    uint32_t, (_index),					\
1379 		    uint32_t, _reg ## _OFST,				\
1380 		    uint32_t, (_eop)->eo_u32[3],			\
1381 		    uint32_t, (_eop)->eo_u32[2],			\
1382 		    uint32_t, (_eop)->eo_u32[1],			\
1383 		    uint32_t, (_eop)->eo_u32[0]);			\
1384 		EFSYS_BAR_DOORBELL_WRITEO((_enp)->en_esbp,		\
1385 		    (_reg ## _OFST +					\
1386 		    ((_index) << (_enp)->en_nic_cfg.enc_vi_window_shift)), \
1387 		    (_eop));						\
1388 	_NOTE(CONSTANTCONDITION)					\
1389 	} while (B_FALSE)
1390 
1391 #define	EFX_DMA_SYNC_QUEUE_FOR_DEVICE(_esmp, _entries, _desc_size,	\
1392 				      _wptr, _owptr)			\
1393 	do {								\
1394 		unsigned int _new = (_wptr);				\
1395 		unsigned int _old = (_owptr);				\
1396 									\
1397 		if ((_new) >= (_old))					\
1398 			EFSYS_DMA_SYNC_FOR_DEVICE((_esmp),		\
1399 			    (_old) * (_desc_size),			\
1400 			    ((_new) - (_old)) * (_desc_size));		\
1401 		else							\
1402 			/*						\
1403 			 * It is cheaper to sync entire map than sync	\
1404 			 * two parts especially when offset/size are	\
1405 			 * ignored and entire map is synced in any case.\
1406 			 */						\
1407 			EFSYS_DMA_SYNC_FOR_DEVICE((_esmp),		\
1408 			    0,						\
1409 			    (_entries) * (_desc_size));			\
1410 	_NOTE(CONSTANTCONDITION)					\
1411 	} while (B_FALSE)
1412 
1413 LIBEFX_INTERNAL
1414 extern	__checkReturn	efx_rc_t
1415 efx_mac_select(
1416 	__in		efx_nic_t *enp);
1417 
1418 LIBEFX_INTERNAL
1419 extern	void
1420 efx_mac_multicast_hash_compute(
1421 	__in_ecount(6*count)		uint8_t const *addrs,
1422 	__in				int count,
1423 	__out				efx_oword_t *hash_low,
1424 	__out				efx_oword_t *hash_high);
1425 
1426 LIBEFX_INTERNAL
1427 extern	__checkReturn	efx_rc_t
1428 efx_phy_probe(
1429 	__in		efx_nic_t *enp);
1430 
1431 LIBEFX_INTERNAL
1432 extern			void
1433 efx_phy_unprobe(
1434 	__in		efx_nic_t *enp);
1435 
1436 #if EFSYS_OPT_VPD
1437 
1438 /* VPD utility functions */
1439 
1440 LIBEFX_INTERNAL
1441 extern	__checkReturn		efx_rc_t
1442 efx_vpd_hunk_length(
1443 	__in_bcount(size)	caddr_t data,
1444 	__in			size_t size,
1445 	__out			size_t *lengthp);
1446 
1447 LIBEFX_INTERNAL
1448 extern	__checkReturn		efx_rc_t
1449 efx_vpd_hunk_verify(
1450 	__in_bcount(size)	caddr_t data,
1451 	__in			size_t size,
1452 	__out_opt		boolean_t *cksummedp);
1453 
1454 LIBEFX_INTERNAL
1455 extern	__checkReturn		efx_rc_t
1456 efx_vpd_hunk_reinit(
1457 	__in_bcount(size)	caddr_t data,
1458 	__in			size_t size,
1459 	__in			boolean_t wantpid);
1460 
1461 LIBEFX_INTERNAL
1462 extern	__checkReturn		efx_rc_t
1463 efx_vpd_hunk_get(
1464 	__in_bcount(size)	caddr_t data,
1465 	__in			size_t size,
1466 	__in			efx_vpd_tag_t tag,
1467 	__in			efx_vpd_keyword_t keyword,
1468 	__out			unsigned int *payloadp,
1469 	__out			uint8_t *paylenp);
1470 
1471 LIBEFX_INTERNAL
1472 extern	__checkReturn			efx_rc_t
1473 efx_vpd_hunk_next(
1474 	__in_bcount(size)		caddr_t data,
1475 	__in				size_t size,
1476 	__out				efx_vpd_tag_t *tagp,
1477 	__out				efx_vpd_keyword_t *keyword,
1478 	__out_opt			unsigned int *payloadp,
1479 	__out_opt			uint8_t *paylenp,
1480 	__inout				unsigned int *contp);
1481 
1482 LIBEFX_INTERNAL
1483 extern	__checkReturn		efx_rc_t
1484 efx_vpd_hunk_set(
1485 	__in_bcount(size)	caddr_t data,
1486 	__in			size_t size,
1487 	__in			efx_vpd_value_t *evvp);
1488 
1489 #endif	/* EFSYS_OPT_VPD */
1490 
1491 #if EFSYS_OPT_MCDI
1492 
1493 LIBEFX_INTERNAL
1494 extern	__checkReturn		efx_rc_t
1495 efx_mcdi_set_workaround(
1496 	__in			efx_nic_t *enp,
1497 	__in			uint32_t type,
1498 	__in			boolean_t enabled,
1499 	__out_opt		uint32_t *flagsp);
1500 
1501 LIBEFX_INTERNAL
1502 extern	__checkReturn		efx_rc_t
1503 efx_mcdi_get_workarounds(
1504 	__in			efx_nic_t *enp,
1505 	__out_opt		uint32_t *implementedp,
1506 	__out_opt		uint32_t *enabledp);
1507 
1508 #if EFSYS_OPT_RIVERHEAD || EFX_OPTS_EF10()
1509 
1510 LIBEFX_INTERNAL
1511 extern	__checkReturn	efx_rc_t
1512 efx_mcdi_init_evq(
1513 	__in		efx_nic_t *enp,
1514 	__in		unsigned int instance,
1515 	__in		efsys_mem_t *esmp,
1516 	__in		size_t nevs,
1517 	__in		uint32_t irq,
1518 	__in		uint32_t us,
1519 	__in		uint32_t flags,
1520 	__in		boolean_t low_latency);
1521 
1522 LIBEFX_INTERNAL
1523 extern	__checkReturn	efx_rc_t
1524 efx_mcdi_fini_evq(
1525 	__in		efx_nic_t *enp,
1526 	__in		uint32_t instance);
1527 
1528 typedef struct efx_mcdi_init_rxq_params_s {
1529 	boolean_t	disable_scatter;
1530 	boolean_t	want_inner_classes;
1531 	uint32_t	buf_size;
1532 	uint32_t	ps_buf_size;
1533 	uint32_t	es_bufs_per_desc;
1534 	uint32_t	es_max_dma_len;
1535 	uint32_t	es_buf_stride;
1536 	uint32_t	hol_block_timeout;
1537 	uint32_t	prefix_id;
1538 } efx_mcdi_init_rxq_params_t;
1539 
1540 LIBEFX_INTERNAL
1541 extern	__checkReturn	efx_rc_t
1542 efx_mcdi_init_rxq(
1543 	__in		efx_nic_t *enp,
1544 	__in		uint32_t ndescs,
1545 	__in		efx_evq_t *eep,
1546 	__in		uint32_t label,
1547 	__in		uint32_t instance,
1548 	__in		efsys_mem_t *esmp,
1549 	__in		const efx_mcdi_init_rxq_params_t *params);
1550 
1551 LIBEFX_INTERNAL
1552 extern	__checkReturn	efx_rc_t
1553 efx_mcdi_fini_rxq(
1554 	__in		efx_nic_t *enp,
1555 	__in		uint32_t instance);
1556 
1557 LIBEFX_INTERNAL
1558 extern	__checkReturn	efx_rc_t
1559 efx_mcdi_init_txq(
1560 	__in		efx_nic_t *enp,
1561 	__in		uint32_t ndescs,
1562 	__in		uint32_t target_evq,
1563 	__in		uint32_t label,
1564 	__in		uint32_t instance,
1565 	__in		uint16_t flags,
1566 	__in		efsys_mem_t *esmp);
1567 
1568 LIBEFX_INTERNAL
1569 extern	__checkReturn	efx_rc_t
1570 efx_mcdi_fini_txq(
1571 	__in		efx_nic_t *enp,
1572 	__in		uint32_t instance);
1573 
1574 #endif	/* EFSYS_OPT_RIVERHEAD || EFX_OPTS_EF10() */
1575 
1576 #endif /* EFSYS_OPT_MCDI */
1577 
1578 #if EFSYS_OPT_MAC_STATS
1579 
1580 /*
1581  * Closed range of stats (i.e. the first and the last are included).
1582  * The last must be greater or equal (if the range is one item only) to
1583  * the first.
1584  */
1585 struct efx_mac_stats_range {
1586 	efx_mac_stat_t		first;
1587 	efx_mac_stat_t		last;
1588 };
1589 
1590 typedef enum efx_stats_action_e {
1591 	EFX_STATS_CLEAR,
1592 	EFX_STATS_UPLOAD,
1593 	EFX_STATS_ENABLE_NOEVENTS,
1594 	EFX_STATS_ENABLE_EVENTS,
1595 	EFX_STATS_DISABLE,
1596 } efx_stats_action_t;
1597 
1598 LIBEFX_INTERNAL
1599 extern					efx_rc_t
1600 efx_mac_stats_mask_add_ranges(
1601 	__inout_bcount(mask_size)	uint32_t *maskp,
1602 	__in				size_t mask_size,
1603 	__in_ecount(rng_count)		const struct efx_mac_stats_range *rngp,
1604 	__in				unsigned int rng_count);
1605 
1606 LIBEFX_INTERNAL
1607 extern	__checkReturn	efx_rc_t
1608 efx_mcdi_mac_stats(
1609 	__in		efx_nic_t *enp,
1610 	__in		uint32_t vport_id,
1611 	__in_opt	efsys_mem_t *esmp,
1612 	__in		efx_stats_action_t action,
1613 	__in		uint16_t period_ms);
1614 
1615 #endif	/* EFSYS_OPT_MAC_STATS */
1616 
1617 #if EFSYS_OPT_PCI
1618 
1619 /*
1620  * Find the next extended capability in a PCI device's config space
1621  * with specified capability id.
1622  * Passing 0 offset makes the function search from the start.
1623  * If search succeeds, found capability is in modified offset.
1624  *
1625  * Returns ENOENT if a capability is not found.
1626  */
1627 LIBEFX_INTERNAL
1628 extern	__checkReturn			efx_rc_t
1629 efx_pci_config_find_next_ext_cap(
1630 	__in				efsys_pci_config_t *espcp,
1631 	__in				const efx_pci_ops_t *epop,
1632 	__in				uint16_t cap_id,
1633 	__inout				size_t *offsetp);
1634 
1635 /*
1636  * Get the next extended capability in a PCI device's config space.
1637  * Passing 0 offset makes the function get the first capability.
1638  * If search succeeds, the capability is in modified offset.
1639  *
1640  * Returns ENOENT if there is no next capability.
1641  */
1642 LIBEFX_INTERNAL
1643 extern	__checkReturn			efx_rc_t
1644 efx_pci_config_next_ext_cap(
1645 	__in				efsys_pci_config_t *espcp,
1646 	__in				const efx_pci_ops_t *epop,
1647 	__inout				size_t *offsetp);
1648 
1649 /*
1650  * Find the next Xilinx capabilities table location by searching
1651  * PCI extended capabilities.
1652  *
1653  * Returns ENOENT if a table location is not found.
1654  */
1655 LIBEFX_INTERNAL
1656 extern	__checkReturn			efx_rc_t
1657 efx_pci_find_next_xilinx_cap_table(
1658 	__in				efsys_pci_config_t *espcp,
1659 	__in				const efx_pci_ops_t *epop,
1660 	__inout				size_t *pci_cap_offsetp,
1661 	__out				unsigned int *xilinx_tbl_barp,
1662 	__out				efsys_dma_addr_t *xilinx_tbl_offsetp);
1663 
1664 /*
1665  * Read a Xilinx extended PCI capability that gives the location
1666  * of a Xilinx capabilities table.
1667  *
1668  * Returns ENOENT if the extended PCI capability does not contain
1669  * Xilinx capabilities table locator.
1670  */
1671 LIBEFX_INTERNAL
1672 extern	__checkReturn			efx_rc_t
1673 efx_pci_read_ext_cap_xilinx_table(
1674 	__in				efsys_pci_config_t *espcp,
1675 	__in				const efx_pci_ops_t *epop,
1676 	__in				size_t cap_offset,
1677 	__out				unsigned int *barp,
1678 	__out				efsys_dma_addr_t *offsetp);
1679 
1680 /*
1681  * Find a capability with specified format_id in a Xilinx capabilities table.
1682  * Searching is started from provided offset, taking skip_first into account.
1683  * If search succeeds, found capability is in modified offset.
1684  *
1685  * Returns ENOENT if an entry with specified format id is not found.
1686  */
1687 LIBEFX_INTERNAL
1688 extern	__checkReturn			efx_rc_t
1689 efx_pci_xilinx_cap_tbl_find(
1690 	__in				efsys_bar_t *esbp,
1691 	__in				uint32_t format_id,
1692 	__in				boolean_t skip_first,
1693 	__inout				efsys_dma_addr_t *entry_offsetp);
1694 
1695 #endif /* EFSYS_OPT_PCI */
1696 
1697 #if EFSYS_OPT_MAE
1698 
1699 struct efx_mae_match_spec_s {
1700 	efx_mae_rule_type_t		emms_type;
1701 	uint32_t			emms_prio;
1702 	union emms_mask_value_pairs {
1703 		uint8_t			action[MAE_FIELD_MASK_VALUE_PAIRS_LEN];
1704 		uint8_t			outer[MAE_ENC_FIELD_PAIRS_LEN];
1705 	} emms_mask_value_pairs;
1706 };
1707 
1708 typedef enum efx_mae_action_e {
1709 	/* These actions are strictly ordered. */
1710 	EFX_MAE_ACTION_VLAN_POP,
1711 	EFX_MAE_ACTION_VLAN_PUSH,
1712 
1713 	/*
1714 	 * These actions are not strictly ordered and can
1715 	 * be passed by a client in any order (before DELIVER).
1716 	 * However, these enumerants must be kept compactly
1717 	 * in the end of the enumeration (before DELIVER).
1718 	 */
1719 	EFX_MAE_ACTION_FLAG,
1720 	EFX_MAE_ACTION_MARK,
1721 
1722 	/* DELIVER is always the last action. */
1723 	EFX_MAE_ACTION_DELIVER,
1724 
1725 	EFX_MAE_NACTIONS
1726 } efx_mae_action_t;
1727 
1728 /* MAE VLAN_POP action can handle 1 or 2 tags. */
1729 #define	EFX_MAE_VLAN_POP_MAX_NTAGS	(2)
1730 
1731 /* MAE VLAN_PUSH action can handle 1 or 2 tags. */
1732 #define	EFX_MAE_VLAN_PUSH_MAX_NTAGS	(2)
1733 
1734 typedef struct efx_mae_action_vlan_push_s {
1735 	uint16_t			emavp_tpid_be;
1736 	uint16_t			emavp_tci_be;
1737 } efx_mae_action_vlan_push_t;
1738 
1739 struct efx_mae_actions_s {
1740 	/* Bitmap of actions in spec, indexed by action type */
1741 	uint32_t			ema_actions;
1742 
1743 	unsigned int			ema_n_vlan_tags_to_pop;
1744 	unsigned int			ema_n_vlan_tags_to_push;
1745 	efx_mae_action_vlan_push_t	ema_vlan_push_descs[
1746 	    EFX_MAE_VLAN_PUSH_MAX_NTAGS];
1747 	uint32_t			ema_mark_value;
1748 	efx_mport_sel_t			ema_deliver_mport;
1749 };
1750 
1751 #endif /* EFSYS_OPT_MAE */
1752 
1753 #ifdef	__cplusplus
1754 }
1755 #endif
1756 
1757 #endif	/* _SYS_EFX_IMPL_H */
1758