2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2009-2016 Solarflare Communications Inc.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are met:
10 * 1. Redistributions of source code must retain the above copyright notice,
11 * this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright notice,
13 * this list of conditions and the following disclaimer in the documentation
14 * and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
18 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
20 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
21 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
22 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
23 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
25 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
26 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 * The views and conclusions contained in the software and documentation are
29 * those of the authors and should not be interpreted as representing official
30 * policies, either expressed or implied, of the FreeBSD Project.
35 #ifndef _SYS_SIENA_IMPL_H
36 #define _SYS_SIENA_IMPL_H
41 #include "siena_flash.h"
47 #ifndef EFX_TXQ_DC_SIZE
48 #define EFX_TXQ_DC_SIZE 1 /* 16 descriptors */
50 #ifndef EFX_RXQ_DC_SIZE
51 #define EFX_RXQ_DC_SIZE 3 /* 64 descriptors */
53 #define EFX_TXQ_DC_NDESCS(_dcsize) (8 << (_dcsize))
55 #define SIENA_NVRAM_CHUNK 0x80
58 extern __checkReturn efx_rc_t
62 extern __checkReturn efx_rc_t
66 extern __checkReturn efx_rc_t
72 extern efx_sram_pattern_fn_t __efx_sram_pattern_fns[];
74 typedef struct siena_register_set_s {
79 } siena_register_set_t;
81 extern __checkReturn efx_rc_t
82 siena_nic_register_test(
85 #endif /* EFSYS_OPT_DIAG */
95 #define SIENA_SRAM_ROWS 0x12000
103 extern __checkReturn efx_rc_t
106 __in efx_sram_pattern_fn_t func);
108 #endif /* EFSYS_OPT_DIAG */
112 extern __checkReturn efx_rc_t
115 __in const efx_mcdi_transport_t *mtp);
118 siena_mcdi_send_request(
120 __in_bcount(hdr_len) void *hdrp,
122 __in_bcount(sdu_len) void *sdup,
123 __in size_t sdu_len);
125 extern __checkReturn boolean_t
126 siena_mcdi_poll_response(
127 __in efx_nic_t *enp);
130 siena_mcdi_read_response(
132 __out_bcount(length) void *bufferp,
137 siena_mcdi_poll_reboot(
138 __in efx_nic_t *enp);
142 __in efx_nic_t *enp);
144 extern __checkReturn efx_rc_t
145 siena_mcdi_feature_supported(
147 __in efx_mcdi_feature_id_t id,
148 __out boolean_t *supportedp);
151 siena_mcdi_get_timeout(
153 __in efx_mcdi_req_t *emrp,
154 __out uint32_t *timeoutp);
156 #endif /* EFSYS_OPT_MCDI */
158 #if EFSYS_OPT_NVRAM || EFSYS_OPT_VPD
160 extern __checkReturn efx_rc_t
161 siena_nvram_partn_lock(
163 __in uint32_t partn);
165 extern __checkReturn efx_rc_t
166 siena_nvram_partn_unlock(
169 __out_opt uint32_t *verify_resultp);
171 extern __checkReturn efx_rc_t
172 siena_nvram_get_dynamic_cfg(
176 __out siena_mc_dynamic_config_hdr_t **dcfgp,
177 __out size_t *sizep);
179 #endif /* EFSYS_OPT_VPD || EFSYS_OPT_NVRAM */
185 extern __checkReturn efx_rc_t
187 __in efx_nic_t *enp);
189 #endif /* EFSYS_OPT_DIAG */
191 extern __checkReturn efx_rc_t
192 siena_nvram_get_subtype(
195 __out uint32_t *subtypep);
197 extern __checkReturn efx_rc_t
198 siena_nvram_type_to_partn(
200 __in efx_nvram_type_t type,
201 __out uint32_t *partnp);
203 extern __checkReturn efx_rc_t
204 siena_nvram_partn_size(
207 __out size_t *sizep);
209 extern __checkReturn efx_rc_t
210 siena_nvram_partn_rw_start(
213 __out size_t *chunk_sizep);
215 extern __checkReturn efx_rc_t
216 siena_nvram_partn_read(
219 __in unsigned int offset,
220 __out_bcount(size) caddr_t data,
223 extern __checkReturn efx_rc_t
224 siena_nvram_partn_erase(
227 __in unsigned int offset,
230 extern __checkReturn efx_rc_t
231 siena_nvram_partn_write(
234 __in unsigned int offset,
235 __out_bcount(size) caddr_t data,
238 extern __checkReturn efx_rc_t
239 siena_nvram_partn_rw_finish(
242 __out_opt uint32_t *verify_resultp);
244 extern __checkReturn efx_rc_t
245 siena_nvram_partn_get_version(
248 __out uint32_t *subtypep,
249 __out_ecount(4) uint16_t version[4]);
251 extern __checkReturn efx_rc_t
252 siena_nvram_partn_set_version(
255 __in_ecount(4) uint16_t version[4]);
257 #endif /* EFSYS_OPT_NVRAM */
261 extern __checkReturn efx_rc_t
263 __in efx_nic_t *enp);
265 extern __checkReturn efx_rc_t
268 __out size_t *sizep);
270 extern __checkReturn efx_rc_t
273 __out_bcount(size) caddr_t data,
276 extern __checkReturn efx_rc_t
279 __in_bcount(size) caddr_t data,
282 extern __checkReturn efx_rc_t
285 __in_bcount(size) caddr_t data,
288 extern __checkReturn efx_rc_t
291 __in_bcount(size) caddr_t data,
293 __inout efx_vpd_value_t *evvp);
295 extern __checkReturn efx_rc_t
298 __in_bcount(size) caddr_t data,
300 __in efx_vpd_value_t *evvp);
302 extern __checkReturn efx_rc_t
305 __in_bcount(size) caddr_t data,
307 __out efx_vpd_value_t *evvp,
308 __inout unsigned int *contp);
310 extern __checkReturn efx_rc_t
313 __in_bcount(size) caddr_t data,
318 __in efx_nic_t *enp);
320 #endif /* EFSYS_OPT_VPD */
322 typedef struct siena_link_state_s {
323 uint32_t sls_adv_cap_mask;
324 uint32_t sls_lp_cap_mask;
325 unsigned int sls_fcntl;
326 efx_link_mode_t sls_link_mode;
327 #if EFSYS_OPT_LOOPBACK
328 efx_loopback_type_t sls_loopback;
330 boolean_t sls_mac_up;
331 } siena_link_state_t;
336 __in efx_qword_t *eqp,
337 __out efx_link_mode_t *link_modep);
339 extern __checkReturn efx_rc_t
342 __out siena_link_state_t *slsp);
344 extern __checkReturn efx_rc_t
349 extern __checkReturn efx_rc_t
350 siena_phy_reconfigure(
351 __in efx_nic_t *enp);
353 extern __checkReturn efx_rc_t
355 __in efx_nic_t *enp);
357 extern __checkReturn efx_rc_t
360 __out uint32_t *ouip);
362 #if EFSYS_OPT_PHY_STATS
365 siena_phy_decode_stats(
368 __in_opt efsys_mem_t *esmp,
369 __out_opt uint64_t *smaskp,
370 __inout_ecount_opt(EFX_PHY_NSTATS) uint32_t *stat);
372 extern __checkReturn efx_rc_t
373 siena_phy_stats_update(
375 __in efsys_mem_t *esmp,
376 __inout_ecount(EFX_PHY_NSTATS) uint32_t *stat);
378 #endif /* EFSYS_OPT_PHY_STATS */
382 extern __checkReturn efx_rc_t
383 siena_phy_bist_start(
385 __in efx_bist_type_t type);
387 extern __checkReturn efx_rc_t
390 __in efx_bist_type_t type,
391 __out efx_bist_result_t *resultp,
392 __out_opt __drv_when(count > 0, __notnull)
393 uint32_t *value_maskp,
394 __out_ecount_opt(count) __drv_when(count > 0, __notnull)
395 unsigned long *valuesp,
401 __in efx_bist_type_t type);
403 #endif /* EFSYS_OPT_BIST */
405 extern __checkReturn efx_rc_t
408 __out efx_link_mode_t *link_modep);
410 extern __checkReturn efx_rc_t
413 __out boolean_t *mac_upp);
415 extern __checkReturn efx_rc_t
416 siena_mac_reconfigure(
417 __in efx_nic_t *enp);
419 extern __checkReturn efx_rc_t
424 #if EFSYS_OPT_LOOPBACK
426 extern __checkReturn efx_rc_t
427 siena_mac_loopback_set(
429 __in efx_link_mode_t link_mode,
430 __in efx_loopback_type_t loopback_type);
432 #endif /* EFSYS_OPT_LOOPBACK */
434 #if EFSYS_OPT_MAC_STATS
436 extern __checkReturn efx_rc_t
437 siena_mac_stats_get_mask(
439 __inout_bcount(mask_size) uint32_t *maskp,
440 __in size_t mask_size);
442 extern __checkReturn efx_rc_t
443 siena_mac_stats_update(
445 __in efsys_mem_t *esmp,
446 __inout_ecount(EFX_MAC_NSTATS) efsys_stat_t *stat,
447 __inout_opt uint32_t *generationp);
449 #endif /* EFSYS_OPT_MAC_STATS */
455 #endif /* _SYS_SIENA_IMPL_H */