2 * Copyright (c) 2007-2015 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.
33 #ifndef _SYS_EFX_IMPL_H
34 #define _SYS_EFX_IMPL_H
39 #include "efx_regs_ef10.h"
41 /* FIXME: Add definition for driver generated software events */
42 #ifndef ESE_DZ_EV_CODE_DRV_GEN_EV
43 #define ESE_DZ_EV_CODE_DRV_GEN_EV FSE_AZ_EV_CODE_DRV_GEN_EV
46 #include "efx_check.h"
50 #include "falcon_impl.h"
51 #endif /* EFSYS_OPT_FALCON */
54 #include "siena_impl.h"
55 #endif /* EFSYS_OPT_SIENA */
57 #if EFSYS_OPT_HUNTINGTON
58 #include "hunt_impl.h"
59 #endif /* EFSYS_OPT_HUNTINGTON */
62 #include "medford_impl.h"
63 #endif /* EFSYS_OPT_MEDFORD */
65 #if (EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD)
66 #include "ef10_impl.h"
67 #endif /* (EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD) */
73 #define EFX_MOD_MCDI 0x00000001
74 #define EFX_MOD_PROBE 0x00000002
75 #define EFX_MOD_NVRAM 0x00000004
76 #define EFX_MOD_VPD 0x00000008
77 #define EFX_MOD_NIC 0x00000010
78 #define EFX_MOD_INTR 0x00000020
79 #define EFX_MOD_EV 0x00000040
80 #define EFX_MOD_RX 0x00000080
81 #define EFX_MOD_TX 0x00000100
82 #define EFX_MOD_PORT 0x00000200
83 #define EFX_MOD_MON 0x00000400
84 #define EFX_MOD_WOL 0x00000800
85 #define EFX_MOD_FILTER 0x00001000
86 #define EFX_MOD_PKTFILTER 0x00002000
88 #define EFX_RESET_MAC 0x00000001
89 #define EFX_RESET_PHY 0x00000002
90 #define EFX_RESET_RXQ_ERR 0x00000004
91 #define EFX_RESET_TXQ_ERR 0x00000008
93 typedef enum efx_mac_type_e {
102 typedef struct efx_ev_ops_s {
103 efx_rc_t (*eevo_init)(efx_nic_t *);
104 void (*eevo_fini)(efx_nic_t *);
105 efx_rc_t (*eevo_qcreate)(efx_nic_t *, unsigned int,
106 efsys_mem_t *, size_t, uint32_t,
108 void (*eevo_qdestroy)(efx_evq_t *);
109 efx_rc_t (*eevo_qprime)(efx_evq_t *, unsigned int);
110 void (*eevo_qpost)(efx_evq_t *, uint16_t);
111 efx_rc_t (*eevo_qmoderate)(efx_evq_t *, unsigned int);
113 void (*eevo_qstats_update)(efx_evq_t *, efsys_stat_t *);
117 typedef struct efx_tx_ops_s {
118 efx_rc_t (*etxo_init)(efx_nic_t *);
119 void (*etxo_fini)(efx_nic_t *);
120 efx_rc_t (*etxo_qcreate)(efx_nic_t *,
121 unsigned int, unsigned int,
122 efsys_mem_t *, size_t,
124 efx_evq_t *, efx_txq_t *,
126 void (*etxo_qdestroy)(efx_txq_t *);
127 efx_rc_t (*etxo_qpost)(efx_txq_t *, efx_buffer_t *,
128 unsigned int, unsigned int,
130 void (*etxo_qpush)(efx_txq_t *, unsigned int, unsigned int);
131 efx_rc_t (*etxo_qpace)(efx_txq_t *, unsigned int);
132 efx_rc_t (*etxo_qflush)(efx_txq_t *);
133 void (*etxo_qenable)(efx_txq_t *);
134 efx_rc_t (*etxo_qpio_enable)(efx_txq_t *);
135 void (*etxo_qpio_disable)(efx_txq_t *);
136 efx_rc_t (*etxo_qpio_write)(efx_txq_t *,uint8_t *, size_t,
138 efx_rc_t (*etxo_qpio_post)(efx_txq_t *, size_t, unsigned int,
140 efx_rc_t (*etxo_qdesc_post)(efx_txq_t *, efx_desc_t *,
141 unsigned int, unsigned int,
143 void (*etxo_qdesc_dma_create)(efx_txq_t *, efsys_dma_addr_t,
146 void (*etxo_qdesc_tso_create)(efx_txq_t *, uint16_t,
149 void (*etxo_qdesc_vlantci_create)(efx_txq_t *, uint16_t,
152 void (*etxo_qstats_update)(efx_txq_t *,
157 typedef struct efx_rx_ops_s {
158 efx_rc_t (*erxo_init)(efx_nic_t *);
159 void (*erxo_fini)(efx_nic_t *);
160 #if EFSYS_OPT_RX_HDR_SPLIT
161 efx_rc_t (*erxo_hdr_split_enable)(efx_nic_t *, unsigned int,
164 #if EFSYS_OPT_RX_SCATTER
165 efx_rc_t (*erxo_scatter_enable)(efx_nic_t *, unsigned int);
167 #if EFSYS_OPT_RX_SCALE
168 efx_rc_t (*erxo_scale_mode_set)(efx_nic_t *, efx_rx_hash_alg_t,
169 efx_rx_hash_type_t, boolean_t);
170 efx_rc_t (*erxo_scale_key_set)(efx_nic_t *, uint8_t *, size_t);
171 efx_rc_t (*erxo_scale_tbl_set)(efx_nic_t *, unsigned int *,
174 void (*erxo_qpost)(efx_rxq_t *, efsys_dma_addr_t *, size_t,
175 unsigned int, unsigned int,
177 void (*erxo_qpush)(efx_rxq_t *, unsigned int, unsigned int *);
178 efx_rc_t (*erxo_qflush)(efx_rxq_t *);
179 void (*erxo_qenable)(efx_rxq_t *);
180 efx_rc_t (*erxo_qcreate)(efx_nic_t *enp, unsigned int,
181 unsigned int, efx_rxq_type_t,
182 efsys_mem_t *, size_t, uint32_t,
183 efx_evq_t *, efx_rxq_t *);
184 void (*erxo_qdestroy)(efx_rxq_t *);
187 typedef struct efx_mac_ops_s {
188 efx_rc_t (*emo_reset)(efx_nic_t *); /* optional */
189 efx_rc_t (*emo_poll)(efx_nic_t *, efx_link_mode_t *);
190 efx_rc_t (*emo_up)(efx_nic_t *, boolean_t *);
191 efx_rc_t (*emo_addr_set)(efx_nic_t *);
192 efx_rc_t (*emo_reconfigure)(efx_nic_t *);
193 efx_rc_t (*emo_multicast_list_set)(efx_nic_t *);
194 efx_rc_t (*emo_filter_default_rxq_set)(efx_nic_t *,
195 efx_rxq_t *, boolean_t);
196 void (*emo_filter_default_rxq_clear)(efx_nic_t *);
197 #if EFSYS_OPT_LOOPBACK
198 efx_rc_t (*emo_loopback_set)(efx_nic_t *, efx_link_mode_t,
199 efx_loopback_type_t);
200 #endif /* EFSYS_OPT_LOOPBACK */
201 #if EFSYS_OPT_MAC_STATS
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_uplink_check)(efx_nic_t *,
216 boolean_t *); /* optional */
217 efx_rc_t (*epo_downlink_check)(efx_nic_t *, efx_link_mode_t *,
218 unsigned int *, uint32_t *);
219 efx_rc_t (*epo_oui_get)(efx_nic_t *, uint32_t *);
220 #if EFSYS_OPT_PHY_STATS
221 efx_rc_t (*epo_stats_update)(efx_nic_t *, efsys_mem_t *,
223 #endif /* EFSYS_OPT_PHY_STATS */
224 #if EFSYS_OPT_PHY_PROPS
226 const char *(*epo_prop_name)(efx_nic_t *, unsigned int);
227 #endif /* EFSYS_OPT_PHY_PROPS */
228 efx_rc_t (*epo_prop_get)(efx_nic_t *, unsigned int, uint32_t,
230 efx_rc_t (*epo_prop_set)(efx_nic_t *, unsigned int, uint32_t);
231 #endif /* EFSYS_OPT_PHY_PROPS */
233 efx_rc_t (*epo_bist_enable_offline)(efx_nic_t *);
234 efx_rc_t (*epo_bist_start)(efx_nic_t *, efx_bist_type_t);
235 efx_rc_t (*epo_bist_poll)(efx_nic_t *, efx_bist_type_t,
236 efx_bist_result_t *, uint32_t *,
237 unsigned long *, size_t);
238 void (*epo_bist_stop)(efx_nic_t *, efx_bist_type_t);
239 #endif /* EFSYS_OPT_BIST */
243 typedef struct efx_filter_ops_s {
244 efx_rc_t (*efo_init)(efx_nic_t *);
245 void (*efo_fini)(efx_nic_t *);
246 efx_rc_t (*efo_restore)(efx_nic_t *);
247 efx_rc_t (*efo_add)(efx_nic_t *, efx_filter_spec_t *,
248 boolean_t may_replace);
249 efx_rc_t (*efo_delete)(efx_nic_t *, efx_filter_spec_t *);
250 efx_rc_t (*efo_supported_filters)(efx_nic_t *, uint32_t *, size_t *);
251 efx_rc_t (*efo_reconfigure)(efx_nic_t *, uint8_t const *, boolean_t,
252 boolean_t, boolean_t, boolean_t,
253 uint8_t const *, int);
256 extern __checkReturn efx_rc_t
257 efx_filter_reconfigure(
259 __in_ecount(6) uint8_t const *mac_addr,
260 __in boolean_t all_unicst,
261 __in boolean_t mulcst,
262 __in boolean_t all_mulcst,
263 __in boolean_t brdcst,
264 __in_ecount(6*count) uint8_t const *addrs,
267 #endif /* EFSYS_OPT_FILTER */
270 typedef struct efx_port_s {
271 efx_mac_type_t ep_mac_type;
272 uint32_t ep_phy_type;
275 uint8_t ep_mac_addr[6];
276 efx_link_mode_t ep_link_mode;
277 boolean_t ep_all_unicst;
279 boolean_t ep_all_mulcst;
281 unsigned int ep_fcntl;
282 boolean_t ep_fcntl_autoneg;
283 efx_oword_t ep_multicst_hash[2];
284 uint8_t ep_mulcst_addr_list[EFX_MAC_ADDR_LEN *
285 EFX_MAC_MULTICAST_LIST_MAX];
286 uint32_t ep_mulcst_addr_count;
287 #if EFSYS_OPT_LOOPBACK
288 efx_loopback_type_t ep_loopback_type;
289 efx_link_mode_t ep_loopback_link_mode;
290 #endif /* EFSYS_OPT_LOOPBACK */
291 #if EFSYS_OPT_PHY_FLAGS
292 uint32_t ep_phy_flags;
293 #endif /* EFSYS_OPT_PHY_FLAGS */
294 #if EFSYS_OPT_PHY_LED_CONTROL
295 efx_phy_led_mode_t ep_phy_led_mode;
296 #endif /* EFSYS_OPT_PHY_LED_CONTROL */
297 efx_phy_media_type_t ep_fixed_port_type;
298 efx_phy_media_type_t ep_module_type;
299 uint32_t ep_adv_cap_mask;
300 uint32_t ep_lp_cap_mask;
301 uint32_t ep_default_adv_cap_mask;
302 uint32_t ep_phy_cap_mask;
303 #if EFSYS_OPT_PHY_TXC43128 || EFSYS_OPT_PHY_QT2025C
306 unsigned int bug10934_count;
309 unsigned int bug17190_count;
313 boolean_t ep_mac_poll_needed; /* falcon only */
314 boolean_t ep_mac_up; /* falcon only */
315 uint32_t ep_fwver; /* falcon only */
316 boolean_t ep_mac_drain;
317 boolean_t ep_mac_stats_pending;
319 efx_bist_type_t ep_current_bist;
321 efx_mac_ops_t *ep_emop;
322 efx_phy_ops_t *ep_epop;
325 typedef struct efx_mon_ops_s {
326 efx_rc_t (*emo_reset)(efx_nic_t *);
327 efx_rc_t (*emo_reconfigure)(efx_nic_t *);
328 #if EFSYS_OPT_MON_STATS
329 efx_rc_t (*emo_stats_update)(efx_nic_t *, efsys_mem_t *,
330 efx_mon_stat_value_t *);
331 #endif /* EFSYS_OPT_MON_STATS */
334 typedef struct efx_mon_s {
335 efx_mon_type_t em_type;
336 efx_mon_ops_t *em_emop;
339 typedef struct efx_intr_ops_s {
340 efx_rc_t (*eio_init)(efx_nic_t *, efx_intr_type_t, efsys_mem_t *);
341 void (*eio_enable)(efx_nic_t *);
342 void (*eio_disable)(efx_nic_t *);
343 void (*eio_disable_unlocked)(efx_nic_t *);
344 efx_rc_t (*eio_trigger)(efx_nic_t *, unsigned int);
345 void (*eio_fini)(efx_nic_t *);
348 typedef struct efx_intr_s {
349 efx_intr_ops_t *ei_eiop;
350 efsys_mem_t *ei_esmp;
351 efx_intr_type_t ei_type;
352 unsigned int ei_level;
355 typedef struct efx_nic_ops_s {
356 efx_rc_t (*eno_probe)(efx_nic_t *);
357 efx_rc_t (*eno_set_drv_limits)(efx_nic_t *, efx_drv_limits_t*);
358 efx_rc_t (*eno_reset)(efx_nic_t *);
359 efx_rc_t (*eno_init)(efx_nic_t *);
360 efx_rc_t (*eno_get_vi_pool)(efx_nic_t *, uint32_t *);
361 efx_rc_t (*eno_get_bar_region)(efx_nic_t *, efx_nic_region_t,
362 uint32_t *, size_t *);
364 efx_rc_t (*eno_sram_test)(efx_nic_t *, efx_sram_pattern_fn_t);
365 efx_rc_t (*eno_register_test)(efx_nic_t *);
366 #endif /* EFSYS_OPT_DIAG */
367 void (*eno_fini)(efx_nic_t *);
368 void (*eno_unprobe)(efx_nic_t *);
371 #ifndef EFX_TXQ_LIMIT_TARGET
372 #define EFX_TXQ_LIMIT_TARGET 259
374 #ifndef EFX_RXQ_LIMIT_TARGET
375 #define EFX_RXQ_LIMIT_TARGET 512
377 #ifndef EFX_TXQ_DC_SIZE
378 #define EFX_TXQ_DC_SIZE 1 /* 16 descriptors */
380 #ifndef EFX_RXQ_DC_SIZE
381 #define EFX_RXQ_DC_SIZE 3 /* 64 descriptors */
386 typedef struct falconsiena_filter_spec_s {
389 uint32_t fsfs_dmaq_id;
390 uint32_t fsfs_dword[3];
391 } falconsiena_filter_spec_t;
393 typedef enum falconsiena_filter_type_e {
394 EFX_FS_FILTER_RX_TCP_FULL, /* TCP/IPv4 4-tuple {dIP,dTCP,sIP,sTCP} */
395 EFX_FS_FILTER_RX_TCP_WILD, /* TCP/IPv4 dest {dIP,dTCP, -, -} */
396 EFX_FS_FILTER_RX_UDP_FULL, /* UDP/IPv4 4-tuple {dIP,dUDP,sIP,sUDP} */
397 EFX_FS_FILTER_RX_UDP_WILD, /* UDP/IPv4 dest {dIP,dUDP, -, -} */
400 EFX_FS_FILTER_RX_MAC_FULL, /* Ethernet {dMAC,VLAN} */
401 EFX_FS_FILTER_RX_MAC_WILD, /* Ethernet {dMAC, -} */
403 EFX_FS_FILTER_TX_TCP_FULL, /* TCP/IPv4 {dIP,dTCP,sIP,sTCP} */
404 EFX_FS_FILTER_TX_TCP_WILD, /* TCP/IPv4 { -, -,sIP,sTCP} */
405 EFX_FS_FILTER_TX_UDP_FULL, /* UDP/IPv4 {dIP,dTCP,sIP,sTCP} */
406 EFX_FS_FILTER_TX_UDP_WILD, /* UDP/IPv4 source (host, port) */
408 EFX_FS_FILTER_TX_MAC_FULL, /* Ethernet source (MAC address, VLAN ID) */
409 EFX_FS_FILTER_TX_MAC_WILD, /* Ethernet source (MAC address) */
410 #endif /* EFSYS_OPT_SIENA */
413 } falconsiena_filter_type_t;
415 typedef enum falconsiena_filter_tbl_id_e {
416 EFX_FS_FILTER_TBL_RX_IP = 0,
417 EFX_FS_FILTER_TBL_RX_MAC,
418 EFX_FS_FILTER_TBL_TX_IP,
419 EFX_FS_FILTER_TBL_TX_MAC,
421 } falconsiena_filter_tbl_id_t;
423 typedef struct falconsiena_filter_tbl_s {
424 int fsft_size; /* number of entries */
425 int fsft_used; /* active count */
426 uint32_t *fsft_bitmap; /* active bitmap */
427 falconsiena_filter_spec_t *fsft_spec; /* array of saved specs */
428 } falconsiena_filter_tbl_t;
430 typedef struct falconsiena_filter_s {
431 falconsiena_filter_tbl_t fsf_tbl[EFX_FS_FILTER_NTBLS];
432 unsigned int fsf_depth[EFX_FS_FILTER_NTYPES];
433 } falconsiena_filter_t;
435 typedef struct efx_filter_s {
436 #if EFSYS_OPT_FALCON || EFSYS_OPT_SIENA
437 falconsiena_filter_t *ef_falconsiena_filter;
438 #endif /* EFSYS_OPT_FALCON || EFSYS_OPT_SIENA */
439 #if EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD
440 ef10_filter_table_t *ef_ef10_filter_table;
441 #endif /* EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD */
445 falconsiena_filter_tbl_clear(
447 __in falconsiena_filter_tbl_id_t tbl);
449 #endif /* EFSYS_OPT_FILTER */
453 typedef struct efx_mcdi_ops_s {
454 efx_rc_t (*emco_init)(efx_nic_t *, const efx_mcdi_transport_t *);
455 void (*emco_request_copyin)(efx_nic_t *, efx_mcdi_req_t *,
456 unsigned int, boolean_t, boolean_t);
457 void (*emco_request_copyout)(efx_nic_t *, efx_mcdi_req_t *);
458 efx_rc_t (*emco_poll_reboot)(efx_nic_t *);
459 boolean_t (*emco_poll_response)(efx_nic_t *);
460 void (*emco_read_response)(efx_nic_t *, void *, size_t, size_t);
461 void (*emco_fini)(efx_nic_t *);
462 efx_rc_t (*emco_feature_supported)(efx_nic_t *, efx_mcdi_feature_id_t, boolean_t *);
465 typedef struct efx_mcdi_s {
466 efx_mcdi_ops_t *em_emcop;
467 const efx_mcdi_transport_t *em_emtp;
468 efx_mcdi_iface_t em_emip;
471 #endif /* EFSYS_OPT_MCDI */
474 typedef struct efx_nvram_ops_s {
476 efx_rc_t (*envo_test)(efx_nic_t *);
477 #endif /* EFSYS_OPT_DIAG */
478 efx_rc_t (*envo_size)(efx_nic_t *, efx_nvram_type_t, size_t *);
479 efx_rc_t (*envo_get_version)(efx_nic_t *, efx_nvram_type_t,
480 uint32_t *, uint16_t *);
481 efx_rc_t (*envo_rw_start)(efx_nic_t *, efx_nvram_type_t, size_t *);
482 efx_rc_t (*envo_read_chunk)(efx_nic_t *, efx_nvram_type_t,
483 unsigned int, caddr_t, size_t);
484 efx_rc_t (*envo_erase)(efx_nic_t *, efx_nvram_type_t);
485 efx_rc_t (*envo_write_chunk)(efx_nic_t *, efx_nvram_type_t,
486 unsigned int, caddr_t, size_t);
487 void (*envo_rw_finish)(efx_nic_t *, efx_nvram_type_t);
488 efx_rc_t (*envo_set_version)(efx_nic_t *, efx_nvram_type_t,
492 #endif /* EFSYS_OPT_NVRAM */
495 typedef struct efx_vpd_ops_s {
496 efx_rc_t (*evpdo_init)(efx_nic_t *);
497 efx_rc_t (*evpdo_size)(efx_nic_t *, size_t *);
498 efx_rc_t (*evpdo_read)(efx_nic_t *, caddr_t, size_t);
499 efx_rc_t (*evpdo_verify)(efx_nic_t *, caddr_t, size_t);
500 efx_rc_t (*evpdo_reinit)(efx_nic_t *, caddr_t, size_t);
501 efx_rc_t (*evpdo_get)(efx_nic_t *, caddr_t, size_t,
503 efx_rc_t (*evpdo_set)(efx_nic_t *, caddr_t, size_t,
505 efx_rc_t (*evpdo_next)(efx_nic_t *, caddr_t, size_t,
506 efx_vpd_value_t *, unsigned int *);
507 efx_rc_t (*evpdo_write)(efx_nic_t *, caddr_t, size_t);
508 void (*evpdo_fini)(efx_nic_t *);
510 #endif /* EFSYS_OPT_VPD */
512 #if EFSYS_OPT_VPD || EFSYS_OPT_NVRAM
514 __checkReturn efx_rc_t
515 efx_mcdi_nvram_partitions(
517 __out_bcount(size) caddr_t data,
519 __out unsigned int *npartnp);
521 __checkReturn efx_rc_t
522 efx_mcdi_nvram_metadata(
525 __out uint32_t *subtypep,
526 __out_ecount(4) uint16_t version[4],
527 __out_bcount_opt(size) char *descp,
530 __checkReturn efx_rc_t
534 __out_opt size_t *sizep,
535 __out_opt uint32_t *addressp,
536 __out_opt uint32_t *erase_sizep,
537 __out_opt uint32_t *write_sizep);
539 __checkReturn efx_rc_t
540 efx_mcdi_nvram_update_start(
542 __in uint32_t partn);
544 __checkReturn efx_rc_t
548 __in uint32_t offset,
549 __out_bcount(size) caddr_t data,
552 __checkReturn efx_rc_t
553 efx_mcdi_nvram_erase(
556 __in uint32_t offset,
559 __checkReturn efx_rc_t
560 efx_mcdi_nvram_write(
563 __in uint32_t offset,
564 __out_bcount(size) caddr_t data,
567 __checkReturn efx_rc_t
568 efx_mcdi_nvram_update_finish(
571 __in boolean_t reboot);
575 __checkReturn efx_rc_t
578 __in uint32_t partn);
580 #endif /* EFSYS_OPT_DIAG */
582 #endif /* EFSYS_OPT_VPD || EFSYS_OPT_NVRAM */
584 typedef struct efx_drv_cfg_s {
585 uint32_t edc_min_vi_count;
586 uint32_t edc_max_vi_count;
588 uint32_t edc_max_piobuf_count;
589 uint32_t edc_pio_alloc_size;
594 efx_family_t en_family;
595 uint32_t en_features;
596 efsys_identifier_t *en_esip;
597 efsys_lock_t *en_eslp;
598 efsys_bar_t *en_esbp;
599 unsigned int en_mod_flags;
600 unsigned int en_reset_flags;
601 efx_nic_cfg_t en_nic_cfg;
602 efx_drv_cfg_t en_drv_cfg;
606 uint32_t en_ev_qcount;
607 uint32_t en_rx_qcount;
608 uint32_t en_tx_qcount;
609 efx_nic_ops_t *en_enop;
610 efx_ev_ops_t *en_eevop;
611 efx_tx_ops_t *en_etxop;
612 efx_rx_ops_t *en_erxop;
614 efx_filter_t en_filter;
615 efx_filter_ops_t *en_efop;
616 #endif /* EFSYS_OPT_FILTER */
619 #endif /* EFSYS_OPT_MCDI */
621 efx_nvram_type_t en_nvram_locked;
622 efx_nvram_ops_t *en_envop;
623 #endif /* EFSYS_OPT_NVRAM */
625 efx_vpd_ops_t *en_evpdop;
626 #endif /* EFSYS_OPT_VPD */
627 #if EFSYS_OPT_RX_SCALE
628 efx_rx_hash_support_t en_hash_support;
629 efx_rx_scale_support_t en_rss_support;
630 uint32_t en_rss_context;
631 #endif /* EFSYS_OPT_RX_SCALE */
632 uint32_t en_vport_id;
636 falcon_spi_dev_t enu_fsd[FALCON_SPI_NTYPES];
637 falcon_i2c_t enu_fip;
638 boolean_t enu_i2c_locked;
639 #if EFSYS_OPT_FALCON_NIC_CFG_OVERRIDE
640 const uint8_t *enu_forced_cfg;
641 #endif /* EFSYS_OPT_FALCON_NIC_CFG_OVERRIDE */
642 uint8_t enu_mon_devid;
643 #if EFSYS_OPT_PCIE_TUNE
644 unsigned int enu_nlanes;
645 #endif /* EFSYS_OPT_PCIE_TUNE */
646 uint16_t enu_board_rev;
647 boolean_t enu_internal_sram;
648 uint8_t enu_sram_num_bank;
649 uint8_t enu_sram_bank_size;
651 #endif /* EFSYS_OPT_FALCON */
654 #if EFSYS_OPT_NVRAM || EFSYS_OPT_VPD
655 unsigned int enu_partn_mask;
656 #endif /* EFSYS_OPT_NVRAM || EFSYS_OPT_VPD */
659 size_t enu_svpd_length;
660 #endif /* EFSYS_OPT_VPD */
663 #endif /* EFSYS_OPT_SIENA */
666 #if (EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD)
673 size_t ena_svpd_length;
674 #endif /* EFSYS_OPT_VPD */
675 efx_piobuf_handle_t ena_piobuf_handle[EF10_MAX_PIOBUF_NBUFS];
676 uint32_t ena_piobuf_count;
677 uint32_t ena_pio_alloc_map[EF10_MAX_PIOBUF_NBUFS];
678 uint32_t ena_pio_write_vi_base;
679 /* Memory BAR mapping regions */
680 uint32_t ena_uc_mem_map_offset;
681 size_t ena_uc_mem_map_size;
682 uint32_t ena_wc_mem_map_offset;
683 size_t ena_wc_mem_map_size;
686 #endif /* (EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD) */
690 #define EFX_NIC_MAGIC 0x02121996
692 typedef boolean_t (*efx_ev_handler_t)(efx_evq_t *, efx_qword_t *,
693 const efx_ev_callbacks_t *, void *);
695 typedef struct efx_evq_rxq_state_s {
696 unsigned int eers_rx_read_ptr;
697 unsigned int eers_rx_mask;
698 } efx_evq_rxq_state_t;
703 unsigned int ee_index;
704 unsigned int ee_mask;
705 efsys_mem_t *ee_esmp;
707 uint32_t ee_stat[EV_NQSTATS];
708 #endif /* EFSYS_OPT_QSTATS */
710 efx_ev_handler_t ee_rx;
711 efx_ev_handler_t ee_tx;
712 efx_ev_handler_t ee_driver;
713 efx_ev_handler_t ee_global;
714 efx_ev_handler_t ee_drv_gen;
716 efx_ev_handler_t ee_mcdi;
717 #endif /* EFSYS_OPT_MCDI */
719 efx_evq_rxq_state_t ee_rxq_state[EFX_EV_RX_NLABELS];
722 #define EFX_EVQ_MAGIC 0x08081997
724 #define EFX_EVQ_FALCON_TIMER_QUANTUM_NS 4968 /* 621 cycles */
725 #define EFX_EVQ_SIENA_TIMER_QUANTUM_NS 6144 /* 768 cycles */
731 unsigned int er_index;
732 unsigned int er_label;
733 unsigned int er_mask;
734 efsys_mem_t *er_esmp;
737 #define EFX_RXQ_MAGIC 0x15022005
742 unsigned int et_index;
743 unsigned int et_mask;
744 efsys_mem_t *et_esmp;
745 #if EFSYS_OPT_HUNTINGTON
746 uint32_t et_pio_bufnum;
747 uint32_t et_pio_blknum;
748 uint32_t et_pio_write_offset;
749 uint32_t et_pio_offset;
753 uint32_t et_stat[TX_NQSTATS];
754 #endif /* EFSYS_OPT_QSTATS */
757 #define EFX_TXQ_MAGIC 0x05092005
759 #define EFX_MAC_ADDR_COPY(_dst, _src) \
761 (_dst)[0] = (_src)[0]; \
762 (_dst)[1] = (_src)[1]; \
763 (_dst)[2] = (_src)[2]; \
764 (_dst)[3] = (_src)[3]; \
765 (_dst)[4] = (_src)[4]; \
766 (_dst)[5] = (_src)[5]; \
767 _NOTE(CONSTANTCONDITION) \
770 #define EFX_MAC_BROADCAST_ADDR_SET(_dst) \
772 uint16_t *_d = (uint16_t *)(_dst); \
776 _NOTE(CONSTANTCONDITION) \
779 #if EFSYS_OPT_CHECK_REG
780 #define EFX_CHECK_REG(_enp, _reg) \
782 const char *name = #_reg; \
783 char min = name[4]; \
784 char max = name[5]; \
787 switch ((_enp)->en_family) { \
788 case EFX_FAMILY_FALCON: \
792 case EFX_FAMILY_SIENA: \
796 case EFX_FAMILY_HUNTINGTON: \
800 case EFX_FAMILY_MEDFORD: \
809 EFSYS_ASSERT3S(rev, >=, min); \
810 EFSYS_ASSERT3S(rev, <=, max); \
812 _NOTE(CONSTANTCONDITION) \
815 #define EFX_CHECK_REG(_enp, _reg) do { \
816 _NOTE(CONSTANTCONDITION) \
820 #define EFX_BAR_READD(_enp, _reg, _edp, _lock) \
822 EFX_CHECK_REG((_enp), (_reg)); \
823 EFSYS_BAR_READD((_enp)->en_esbp, _reg ## _OFST, \
825 EFSYS_PROBE3(efx_bar_readd, const char *, #_reg, \
826 uint32_t, _reg ## _OFST, \
827 uint32_t, (_edp)->ed_u32[0]); \
828 _NOTE(CONSTANTCONDITION) \
831 #define EFX_BAR_WRITED(_enp, _reg, _edp, _lock) \
833 EFX_CHECK_REG((_enp), (_reg)); \
834 EFSYS_PROBE3(efx_bar_writed, const char *, #_reg, \
835 uint32_t, _reg ## _OFST, \
836 uint32_t, (_edp)->ed_u32[0]); \
837 EFSYS_BAR_WRITED((_enp)->en_esbp, _reg ## _OFST, \
839 _NOTE(CONSTANTCONDITION) \
842 #define EFX_BAR_READQ(_enp, _reg, _eqp) \
844 EFX_CHECK_REG((_enp), (_reg)); \
845 EFSYS_BAR_READQ((_enp)->en_esbp, _reg ## _OFST, \
847 EFSYS_PROBE4(efx_bar_readq, const char *, #_reg, \
848 uint32_t, _reg ## _OFST, \
849 uint32_t, (_eqp)->eq_u32[1], \
850 uint32_t, (_eqp)->eq_u32[0]); \
851 _NOTE(CONSTANTCONDITION) \
854 #define EFX_BAR_WRITEQ(_enp, _reg, _eqp) \
856 EFX_CHECK_REG((_enp), (_reg)); \
857 EFSYS_PROBE4(efx_bar_writeq, const char *, #_reg, \
858 uint32_t, _reg ## _OFST, \
859 uint32_t, (_eqp)->eq_u32[1], \
860 uint32_t, (_eqp)->eq_u32[0]); \
861 EFSYS_BAR_WRITEQ((_enp)->en_esbp, _reg ## _OFST, \
863 _NOTE(CONSTANTCONDITION) \
866 #define EFX_BAR_READO(_enp, _reg, _eop) \
868 EFX_CHECK_REG((_enp), (_reg)); \
869 EFSYS_BAR_READO((_enp)->en_esbp, _reg ## _OFST, \
871 EFSYS_PROBE6(efx_bar_reado, const char *, #_reg, \
872 uint32_t, _reg ## _OFST, \
873 uint32_t, (_eop)->eo_u32[3], \
874 uint32_t, (_eop)->eo_u32[2], \
875 uint32_t, (_eop)->eo_u32[1], \
876 uint32_t, (_eop)->eo_u32[0]); \
877 _NOTE(CONSTANTCONDITION) \
880 #define EFX_BAR_WRITEO(_enp, _reg, _eop) \
882 EFX_CHECK_REG((_enp), (_reg)); \
883 EFSYS_PROBE6(efx_bar_writeo, 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 EFSYS_BAR_WRITEO((_enp)->en_esbp, _reg ## _OFST, \
891 _NOTE(CONSTANTCONDITION) \
894 #define EFX_BAR_TBL_READD(_enp, _reg, _index, _edp, _lock) \
896 EFX_CHECK_REG((_enp), (_reg)); \
897 EFSYS_BAR_READD((_enp)->en_esbp, \
898 (_reg ## _OFST + ((_index) * _reg ## _STEP)), \
900 EFSYS_PROBE4(efx_bar_tbl_readd, const char *, #_reg, \
901 uint32_t, (_index), \
902 uint32_t, _reg ## _OFST, \
903 uint32_t, (_edp)->ed_u32[0]); \
904 _NOTE(CONSTANTCONDITION) \
907 #define EFX_BAR_TBL_WRITED(_enp, _reg, _index, _edp, _lock) \
909 EFX_CHECK_REG((_enp), (_reg)); \
910 EFSYS_PROBE4(efx_bar_tbl_writed, const char *, #_reg, \
911 uint32_t, (_index), \
912 uint32_t, _reg ## _OFST, \
913 uint32_t, (_edp)->ed_u32[0]); \
914 EFSYS_BAR_WRITED((_enp)->en_esbp, \
915 (_reg ## _OFST + ((_index) * _reg ## _STEP)), \
917 _NOTE(CONSTANTCONDITION) \
920 #define EFX_BAR_TBL_WRITED2(_enp, _reg, _index, _edp, _lock) \
922 EFX_CHECK_REG((_enp), (_reg)); \
923 EFSYS_PROBE4(efx_bar_tbl_writed, const char *, #_reg, \
924 uint32_t, (_index), \
925 uint32_t, _reg ## _OFST, \
926 uint32_t, (_edp)->ed_u32[0]); \
927 EFSYS_BAR_WRITED((_enp)->en_esbp, \
929 (2 * sizeof (efx_dword_t)) + \
930 ((_index) * _reg ## _STEP)), \
932 _NOTE(CONSTANTCONDITION) \
935 #define EFX_BAR_TBL_WRITED3(_enp, _reg, _index, _edp, _lock) \
937 EFX_CHECK_REG((_enp), (_reg)); \
938 EFSYS_PROBE4(efx_bar_tbl_writed, const char *, #_reg, \
939 uint32_t, (_index), \
940 uint32_t, _reg ## _OFST, \
941 uint32_t, (_edp)->ed_u32[0]); \
942 EFSYS_BAR_WRITED((_enp)->en_esbp, \
944 (3 * sizeof (efx_dword_t)) + \
945 ((_index) * _reg ## _STEP)), \
947 _NOTE(CONSTANTCONDITION) \
950 #define EFX_BAR_TBL_READQ(_enp, _reg, _index, _eqp) \
952 EFX_CHECK_REG((_enp), (_reg)); \
953 EFSYS_BAR_READQ((_enp)->en_esbp, \
954 (_reg ## _OFST + ((_index) * _reg ## _STEP)), \
956 EFSYS_PROBE5(efx_bar_tbl_readq, const char *, #_reg, \
957 uint32_t, (_index), \
958 uint32_t, _reg ## _OFST, \
959 uint32_t, (_eqp)->eq_u32[1], \
960 uint32_t, (_eqp)->eq_u32[0]); \
961 _NOTE(CONSTANTCONDITION) \
964 #define EFX_BAR_TBL_WRITEQ(_enp, _reg, _index, _eqp) \
966 EFX_CHECK_REG((_enp), (_reg)); \
967 EFSYS_PROBE5(efx_bar_tbl_writeq, const char *, #_reg, \
968 uint32_t, (_index), \
969 uint32_t, _reg ## _OFST, \
970 uint32_t, (_eqp)->eq_u32[1], \
971 uint32_t, (_eqp)->eq_u32[0]); \
972 EFSYS_BAR_WRITEQ((_enp)->en_esbp, \
973 (_reg ## _OFST + ((_index) * _reg ## _STEP)), \
975 _NOTE(CONSTANTCONDITION) \
978 #define EFX_BAR_TBL_READO(_enp, _reg, _index, _eop, _lock) \
980 EFX_CHECK_REG((_enp), (_reg)); \
981 EFSYS_BAR_READO((_enp)->en_esbp, \
982 (_reg ## _OFST + ((_index) * _reg ## _STEP)), \
984 EFSYS_PROBE7(efx_bar_tbl_reado, const char *, #_reg, \
985 uint32_t, (_index), \
986 uint32_t, _reg ## _OFST, \
987 uint32_t, (_eop)->eo_u32[3], \
988 uint32_t, (_eop)->eo_u32[2], \
989 uint32_t, (_eop)->eo_u32[1], \
990 uint32_t, (_eop)->eo_u32[0]); \
991 _NOTE(CONSTANTCONDITION) \
994 #define EFX_BAR_TBL_WRITEO(_enp, _reg, _index, _eop, _lock) \
996 EFX_CHECK_REG((_enp), (_reg)); \
997 EFSYS_PROBE7(efx_bar_tbl_writeo, const char *, #_reg, \
998 uint32_t, (_index), \
999 uint32_t, _reg ## _OFST, \
1000 uint32_t, (_eop)->eo_u32[3], \
1001 uint32_t, (_eop)->eo_u32[2], \
1002 uint32_t, (_eop)->eo_u32[1], \
1003 uint32_t, (_eop)->eo_u32[0]); \
1004 EFSYS_BAR_WRITEO((_enp)->en_esbp, \
1005 (_reg ## _OFST + ((_index) * _reg ## _STEP)), \
1007 _NOTE(CONSTANTCONDITION) \
1011 * Allow drivers to perform optimised 128-bit doorbell writes.
1012 * The DMA descriptor pointers (RX_DESC_UPD and TX_DESC_UPD) are
1013 * special-cased in the BIU on the Falcon/Siena and EF10 architectures to avoid
1014 * the need for locking in the host, and are the only ones known to be safe to
1015 * use 128-bites write with.
1017 #define EFX_BAR_TBL_DOORBELL_WRITEO(_enp, _reg, _index, _eop) \
1019 EFX_CHECK_REG((_enp), (_reg)); \
1020 EFSYS_PROBE7(efx_bar_tbl_doorbell_writeo, \
1023 uint32_t, (_index), \
1024 uint32_t, _reg ## _OFST, \
1025 uint32_t, (_eop)->eo_u32[3], \
1026 uint32_t, (_eop)->eo_u32[2], \
1027 uint32_t, (_eop)->eo_u32[1], \
1028 uint32_t, (_eop)->eo_u32[0]); \
1029 EFSYS_BAR_DOORBELL_WRITEO((_enp)->en_esbp, \
1030 (_reg ## _OFST + ((_index) * _reg ## _STEP)), \
1032 _NOTE(CONSTANTCONDITION) \
1035 #define EFX_DMA_SYNC_QUEUE_FOR_DEVICE(_esmp, _entries, _wptr, _owptr) \
1037 unsigned int _new = (_wptr); \
1038 unsigned int _old = (_owptr); \
1040 if ((_new) >= (_old)) \
1041 EFSYS_DMA_SYNC_FOR_DEVICE((_esmp), \
1042 (_old) * sizeof (efx_desc_t), \
1043 ((_new) - (_old)) * sizeof (efx_desc_t)); \
1046 * It is cheaper to sync entire map than sync \
1047 * two parts especially when offset/size are \
1048 * ignored and entire map is synced in any case.\
1050 EFSYS_DMA_SYNC_FOR_DEVICE((_esmp), \
1052 (_entries) * sizeof (efx_desc_t)); \
1053 _NOTE(CONSTANTCONDITION) \
1056 extern __checkReturn efx_rc_t
1058 __in efx_nic_t *enp);
1060 extern __checkReturn efx_rc_t
1062 __in efx_nic_t *enp);
1065 efx_mac_multicast_hash_compute(
1066 __in_ecount(6*count) uint8_t const *addrs,
1068 __out efx_oword_t *hash_low,
1069 __out efx_oword_t *hash_high);
1071 extern __checkReturn efx_rc_t
1073 __in efx_nic_t *enp);
1077 __in efx_nic_t *enp);
1081 /* VPD utility functions */
1083 extern __checkReturn efx_rc_t
1084 efx_vpd_hunk_length(
1085 __in_bcount(size) caddr_t data,
1087 __out size_t *lengthp);
1089 extern __checkReturn efx_rc_t
1090 efx_vpd_hunk_verify(
1091 __in_bcount(size) caddr_t data,
1093 __out_opt boolean_t *cksummedp);
1095 extern __checkReturn efx_rc_t
1096 efx_vpd_hunk_reinit(
1097 __in_bcount(size) caddr_t data,
1099 __in boolean_t wantpid);
1101 extern __checkReturn efx_rc_t
1103 __in_bcount(size) caddr_t data,
1105 __in efx_vpd_tag_t tag,
1106 __in efx_vpd_keyword_t keyword,
1107 __out unsigned int *payloadp,
1108 __out uint8_t *paylenp);
1110 extern __checkReturn efx_rc_t
1112 __in_bcount(size) caddr_t data,
1114 __out efx_vpd_tag_t *tagp,
1115 __out efx_vpd_keyword_t *keyword,
1116 __out_bcount_opt(*paylenp) unsigned int *payloadp,
1117 __out_opt uint8_t *paylenp,
1118 __inout unsigned int *contp);
1120 extern __checkReturn efx_rc_t
1122 __in_bcount(size) caddr_t data,
1124 __in efx_vpd_value_t *evvp);
1126 #endif /* EFSYS_OPT_VPD */
1130 extern efx_sram_pattern_fn_t __efx_sram_pattern_fns[];
1132 typedef struct efx_register_set_s {
1133 unsigned int address;
1137 } efx_register_set_t;
1139 extern __checkReturn efx_rc_t
1140 efx_nic_test_registers(
1141 __in efx_nic_t *enp,
1142 __in efx_register_set_t *rsp,
1145 extern __checkReturn efx_rc_t
1146 efx_nic_test_tables(
1147 __in efx_nic_t *enp,
1148 __in efx_register_set_t *rsp,
1149 __in efx_pattern_type_t pattern,
1152 #endif /* EFSYS_OPT_DIAG */
1156 extern __checkReturn efx_rc_t
1157 efx_mcdi_set_workaround(
1158 __in efx_nic_t *enp,
1160 __in boolean_t enabled,
1161 __out_opt uint32_t *flagsp);
1163 extern __checkReturn efx_rc_t
1164 efx_mcdi_get_workarounds(
1165 __in efx_nic_t *enp,
1166 __out_opt uint32_t *implementedp,
1167 __out_opt uint32_t *enabledp);
1169 #endif /* EFSYS_OPT_MCDI */
1175 #endif /* _SYS_EFX_IMPL_H */