2 * Copyright (c) 2009-2016 Solarflare Communications Inc.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
8 * 1. Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright notice,
11 * this list of conditions and the following disclaimer in the documentation
12 * and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
15 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
16 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
18 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
21 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
22 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
23 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
24 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 * The views and conclusions contained in the software and documentation are
27 * those of the authors and should not be interpreted as representing official
28 * policies, either expressed or implied, of the FreeBSD Project.
31 #ifndef _SYS_EFX_MCDI_H
32 #define _SYS_EFX_MCDI_H
35 #include "efx_regs_mcdi.h"
42 * A reboot/assertion causes the MCDI status word to be set after the
43 * command word is set or a REBOOT event is sent. If we notice a reboot
44 * via these mechanisms then wait 10ms for the status word to be set.
46 #define EFX_MCDI_STATUS_SLEEP_US 10000
48 struct efx_mcdi_req_s {
50 /* Inputs: Command #, input buffer and length */
54 /* Outputs: retcode, buffer, length, and length used*/
57 size_t emr_out_length;
58 size_t emr_out_length_used;
59 /* Internals: low level transport details */
60 unsigned int emr_err_code;
61 unsigned int emr_err_arg;
64 typedef struct efx_mcdi_iface_s {
65 unsigned int emi_port;
66 unsigned int emi_max_version;
68 efx_mcdi_req_t *emi_pending_req;
70 boolean_t emi_new_epoch;
72 uint32_t emi_poll_cnt;
73 uint32_t emi_mc_reboot_status;
79 __inout efx_mcdi_req_t *emrp);
82 efx_mcdi_execute_quiet(
84 __inout efx_mcdi_req_t *emrp);
89 __in unsigned int seq,
90 __in unsigned int outlen,
98 extern __checkReturn efx_rc_t
99 efx_mcdi_request_errcode(
100 __in unsigned int err);
103 efx_mcdi_raise_exception(
105 __in_opt efx_mcdi_req_t *emrp,
108 typedef enum efx_mcdi_boot_e {
109 EFX_MCDI_BOOT_PRIMARY,
110 EFX_MCDI_BOOT_SECONDARY,
114 extern __checkReturn efx_rc_t
117 __out_ecount_opt(4) uint16_t versionp[4],
118 __out_opt uint32_t *buildp,
119 __out_opt efx_mcdi_boot_t *statusp);
121 extern __checkReturn efx_rc_t
122 efx_mcdi_read_assertion(
123 __in efx_nic_t *enp);
125 extern __checkReturn efx_rc_t
126 efx_mcdi_exit_assertion_handler(
127 __in efx_nic_t *enp);
129 extern __checkReturn efx_rc_t
132 __in boolean_t attach);
134 extern __checkReturn efx_rc_t
135 efx_mcdi_get_board_cfg(
137 __out_opt uint32_t *board_typep,
138 __out_opt efx_dword_t *capabilitiesp,
139 __out_ecount_opt(6) uint8_t mac_addrp[6]);
141 extern __checkReturn efx_rc_t
142 efx_mcdi_get_phy_cfg(
143 __in efx_nic_t *enp);
145 extern __checkReturn efx_rc_t
146 efx_mcdi_firmware_update_supported(
148 __out boolean_t *supportedp);
150 extern __checkReturn efx_rc_t
151 efx_mcdi_macaddr_change_supported(
153 __out boolean_t *supportedp);
155 extern __checkReturn efx_rc_t
156 efx_mcdi_link_control_supported(
158 __out boolean_t *supportedp);
160 extern __checkReturn efx_rc_t
161 efx_mcdi_mac_spoofing_supported(
163 __out boolean_t *supportedp);
166 extern __checkReturn efx_rc_t
167 efx_mcdi_get_resource_limits(
169 __out_opt uint32_t *nevqp,
170 __out_opt uint32_t *nrxqp,
171 __out_opt uint32_t *ntxqp);
173 extern __checkReturn efx_rc_t
175 __in efx_nic_t *enp);
177 extern __checkReturn efx_rc_t
178 efx_mcdi_mac_stats_clear(
179 __in efx_nic_t *enp);
181 extern __checkReturn efx_rc_t
182 efx_mcdi_mac_stats_upload(
184 __in efsys_mem_t *esmp);
186 extern __checkReturn efx_rc_t
187 efx_mcdi_mac_stats_periodic(
189 __in efsys_mem_t *esmp,
190 __in uint16_t period,
191 __in boolean_t events);
194 extern __checkReturn efx_rc_t
195 efx_mcdi_phy_module_get_info(
197 __in uint8_t dev_addr,
200 __out_bcount(len) uint8_t *data);
202 #define MCDI_IN(_emr, _type, _ofst) \
203 ((_type *)((_emr).emr_in_buf + (_ofst)))
205 #define MCDI_IN2(_emr, _type, _ofst) \
206 MCDI_IN(_emr, _type, MC_CMD_ ## _ofst ## _OFST)
208 #define MCDI_IN_SET_BYTE(_emr, _ofst, _value) \
209 EFX_POPULATE_BYTE_1(*MCDI_IN2(_emr, efx_byte_t, _ofst), \
212 #define MCDI_IN_SET_WORD(_emr, _ofst, _value) \
213 EFX_POPULATE_WORD_1(*MCDI_IN2(_emr, efx_word_t, _ofst), \
216 #define MCDI_IN_SET_DWORD(_emr, _ofst, _value) \
217 EFX_POPULATE_DWORD_1(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
220 #define MCDI_IN_SET_DWORD_FIELD(_emr, _ofst, _field, _value) \
221 EFX_SET_DWORD_FIELD(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
222 MC_CMD_ ## _field, _value)
224 #define MCDI_IN_POPULATE_DWORD_1(_emr, _ofst, _field1, _value1) \
225 EFX_POPULATE_DWORD_1(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
226 MC_CMD_ ## _field1, _value1)
228 #define MCDI_IN_POPULATE_DWORD_2(_emr, _ofst, _field1, _value1, \
230 EFX_POPULATE_DWORD_2(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
231 MC_CMD_ ## _field1, _value1, \
232 MC_CMD_ ## _field2, _value2)
234 #define MCDI_IN_POPULATE_DWORD_3(_emr, _ofst, _field1, _value1, \
235 _field2, _value2, _field3, _value3) \
236 EFX_POPULATE_DWORD_3(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
237 MC_CMD_ ## _field1, _value1, \
238 MC_CMD_ ## _field2, _value2, \
239 MC_CMD_ ## _field3, _value3)
241 #define MCDI_IN_POPULATE_DWORD_4(_emr, _ofst, _field1, _value1, \
242 _field2, _value2, _field3, _value3, _field4, _value4) \
243 EFX_POPULATE_DWORD_4(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
244 MC_CMD_ ## _field1, _value1, \
245 MC_CMD_ ## _field2, _value2, \
246 MC_CMD_ ## _field3, _value3, \
247 MC_CMD_ ## _field4, _value4)
249 #define MCDI_IN_POPULATE_DWORD_5(_emr, _ofst, _field1, _value1, \
250 _field2, _value2, _field3, _value3, _field4, _value4, \
252 EFX_POPULATE_DWORD_5(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
253 MC_CMD_ ## _field1, _value1, \
254 MC_CMD_ ## _field2, _value2, \
255 MC_CMD_ ## _field3, _value3, \
256 MC_CMD_ ## _field4, _value4, \
257 MC_CMD_ ## _field5, _value5)
259 #define MCDI_IN_POPULATE_DWORD_6(_emr, _ofst, _field1, _value1, \
260 _field2, _value2, _field3, _value3, _field4, _value4, \
261 _field5, _value5, _field6, _value6) \
262 EFX_POPULATE_DWORD_6(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
263 MC_CMD_ ## _field1, _value1, \
264 MC_CMD_ ## _field2, _value2, \
265 MC_CMD_ ## _field3, _value3, \
266 MC_CMD_ ## _field4, _value4, \
267 MC_CMD_ ## _field5, _value5, \
268 MC_CMD_ ## _field6, _value6)
270 #define MCDI_IN_POPULATE_DWORD_7(_emr, _ofst, _field1, _value1, \
271 _field2, _value2, _field3, _value3, _field4, _value4, \
272 _field5, _value5, _field6, _value6, _field7, _value7) \
273 EFX_POPULATE_DWORD_7(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
274 MC_CMD_ ## _field1, _value1, \
275 MC_CMD_ ## _field2, _value2, \
276 MC_CMD_ ## _field3, _value3, \
277 MC_CMD_ ## _field4, _value4, \
278 MC_CMD_ ## _field5, _value5, \
279 MC_CMD_ ## _field6, _value6, \
280 MC_CMD_ ## _field7, _value7)
282 #define MCDI_IN_POPULATE_DWORD_8(_emr, _ofst, _field1, _value1, \
283 _field2, _value2, _field3, _value3, _field4, _value4, \
284 _field5, _value5, _field6, _value6, _field7, _value7, \
286 EFX_POPULATE_DWORD_8(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
287 MC_CMD_ ## _field1, _value1, \
288 MC_CMD_ ## _field2, _value2, \
289 MC_CMD_ ## _field3, _value3, \
290 MC_CMD_ ## _field4, _value4, \
291 MC_CMD_ ## _field5, _value5, \
292 MC_CMD_ ## _field6, _value6, \
293 MC_CMD_ ## _field7, _value7, \
294 MC_CMD_ ## _field8, _value8)
296 #define MCDI_IN_POPULATE_DWORD_9(_emr, _ofst, _field1, _value1, \
297 _field2, _value2, _field3, _value3, _field4, _value4, \
298 _field5, _value5, _field6, _value6, _field7, _value7, \
299 _field8, _value8, _field9, _value9) \
300 EFX_POPULATE_DWORD_9(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
301 MC_CMD_ ## _field1, _value1, \
302 MC_CMD_ ## _field2, _value2, \
303 MC_CMD_ ## _field3, _value3, \
304 MC_CMD_ ## _field4, _value4, \
305 MC_CMD_ ## _field5, _value5, \
306 MC_CMD_ ## _field6, _value6, \
307 MC_CMD_ ## _field7, _value7, \
308 MC_CMD_ ## _field8, _value8, \
309 MC_CMD_ ## _field9, _value9)
311 #define MCDI_IN_POPULATE_DWORD_10(_emr, _ofst, _field1, _value1, \
312 _field2, _value2, _field3, _value3, _field4, _value4, \
313 _field5, _value5, _field6, _value6, _field7, _value7, \
314 _field8, _value8, _field9, _value9, _field10, _value10) \
315 EFX_POPULATE_DWORD_10(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
316 MC_CMD_ ## _field1, _value1, \
317 MC_CMD_ ## _field2, _value2, \
318 MC_CMD_ ## _field3, _value3, \
319 MC_CMD_ ## _field4, _value4, \
320 MC_CMD_ ## _field5, _value5, \
321 MC_CMD_ ## _field6, _value6, \
322 MC_CMD_ ## _field7, _value7, \
323 MC_CMD_ ## _field8, _value8, \
324 MC_CMD_ ## _field9, _value9, \
325 MC_CMD_ ## _field10, _value10)
327 #define MCDI_OUT(_emr, _type, _ofst) \
328 ((_type *)((_emr).emr_out_buf + (_ofst)))
330 #define MCDI_OUT2(_emr, _type, _ofst) \
331 MCDI_OUT(_emr, _type, MC_CMD_ ## _ofst ## _OFST)
333 #define MCDI_OUT_BYTE(_emr, _ofst) \
334 EFX_BYTE_FIELD(*MCDI_OUT2(_emr, efx_byte_t, _ofst), \
337 #define MCDI_OUT_WORD(_emr, _ofst) \
338 EFX_WORD_FIELD(*MCDI_OUT2(_emr, efx_word_t, _ofst), \
341 #define MCDI_OUT_DWORD(_emr, _ofst) \
342 EFX_DWORD_FIELD(*MCDI_OUT2(_emr, efx_dword_t, _ofst), \
345 #define MCDI_OUT_DWORD_FIELD(_emr, _ofst, _field) \
346 EFX_DWORD_FIELD(*MCDI_OUT2(_emr, efx_dword_t, _ofst), \
349 #define MCDI_EV_FIELD(_eqp, _field) \
350 EFX_QWORD_FIELD(*_eqp, MCDI_EVENT_ ## _field)
352 #define MCDI_CMD_DWORD_FIELD(_edp, _field) \
353 EFX_DWORD_FIELD(*_edp, MC_CMD_ ## _field)
355 #define EFX_MCDI_HAVE_PRIVILEGE(mask, priv) \
356 (((mask) & (MC_CMD_PRIVILEGE_MASK_IN_GRP_ ## priv)) == \
357 (MC_CMD_PRIVILEGE_MASK_IN_GRP_ ## priv))
359 typedef enum efx_mcdi_feature_id_e {
360 EFX_MCDI_FEATURE_FW_UPDATE = 0,
361 EFX_MCDI_FEATURE_LINK_CONTROL,
362 EFX_MCDI_FEATURE_MACADDR_CHANGE,
363 EFX_MCDI_FEATURE_MAC_SPOOFING,
364 EFX_MCDI_FEATURE_NIDS
365 } efx_mcdi_feature_id_t;
371 #endif /* _SYS_EFX_MCDI_H */