1 /* SPDX-License-Identifier: BSD-3-Clause
3 * Copyright (c) 2009-2018 Solarflare Communications Inc.
7 #ifndef _SYS_EFX_MCDI_H
8 #define _SYS_EFX_MCDI_H
11 #include "efx_regs_mcdi.h"
14 #include "mc_driver_pcol_strs.h"
15 #endif /* EFSYS_OPT_NAMES */
22 * A reboot/assertion causes the MCDI status word to be set after the
23 * command word is set or a REBOOT event is sent. If we notice a reboot
24 * via these mechanisms then wait 10ms for the status word to be set.
26 #define EFX_MCDI_STATUS_SLEEP_US 10000
28 struct efx_mcdi_req_s {
30 /* Inputs: Command #, input buffer and length */
34 /* Outputs: retcode, buffer, length, and length used */
37 size_t emr_out_length;
38 size_t emr_out_length_used;
39 /* Internals: low level transport details */
40 unsigned int emr_err_code;
41 unsigned int emr_err_arg;
42 #if EFSYS_OPT_MCDI_PROXY_AUTH
43 uint32_t emr_proxy_handle;
47 typedef struct efx_mcdi_iface_s {
48 unsigned int emi_port;
49 unsigned int emi_max_version;
51 efx_mcdi_req_t *emi_pending_req;
53 boolean_t emi_new_epoch;
55 uint32_t emi_poll_cnt;
56 uint32_t emi_mc_reboot_status;
62 __inout efx_mcdi_req_t *emrp);
65 efx_mcdi_execute_quiet(
67 __inout efx_mcdi_req_t *emrp);
72 __in unsigned int seq,
73 __in unsigned int outlen,
76 #if EFSYS_OPT_MCDI_PROXY_AUTH
77 extern __checkReturn efx_rc_t
78 efx_mcdi_get_proxy_handle(
80 __in efx_mcdi_req_t *emrp,
81 __out uint32_t *handlep);
84 efx_mcdi_ev_proxy_response(
86 __in unsigned int handle,
87 __in unsigned int status);
95 extern __checkReturn efx_rc_t
96 efx_mcdi_request_errcode(
97 __in unsigned int err);
100 efx_mcdi_raise_exception(
102 __in_opt efx_mcdi_req_t *emrp,
105 typedef enum efx_mcdi_boot_e {
106 EFX_MCDI_BOOT_PRIMARY,
107 EFX_MCDI_BOOT_SECONDARY,
111 extern __checkReturn efx_rc_t
114 __out_ecount_opt(4) uint16_t versionp[4],
115 __out_opt uint32_t *buildp,
116 __out_opt efx_mcdi_boot_t *statusp);
118 extern __checkReturn efx_rc_t
119 efx_mcdi_get_capabilities(
121 __out_opt uint32_t *flagsp,
122 __out_opt uint16_t *rx_dpcpu_fw_idp,
123 __out_opt uint16_t *tx_dpcpu_fw_idp,
124 __out_opt uint32_t *flags2p,
125 __out_opt uint32_t *tso2ncp);
127 extern __checkReturn efx_rc_t
128 efx_mcdi_read_assertion(
129 __in efx_nic_t *enp);
131 extern __checkReturn efx_rc_t
132 efx_mcdi_exit_assertion_handler(
133 __in efx_nic_t *enp);
135 extern __checkReturn efx_rc_t
138 __in boolean_t attach);
140 extern __checkReturn efx_rc_t
141 efx_mcdi_get_board_cfg(
143 __out_opt uint32_t *board_typep,
144 __out_opt efx_dword_t *capabilitiesp,
145 __out_ecount_opt(6) uint8_t mac_addrp[6]);
147 extern __checkReturn efx_rc_t
148 efx_mcdi_get_phy_cfg(
149 __in efx_nic_t *enp);
151 extern __checkReturn efx_rc_t
152 efx_mcdi_firmware_update_supported(
154 __out boolean_t *supportedp);
156 extern __checkReturn efx_rc_t
157 efx_mcdi_macaddr_change_supported(
159 __out boolean_t *supportedp);
161 extern __checkReturn efx_rc_t
162 efx_mcdi_link_control_supported(
164 __out boolean_t *supportedp);
166 extern __checkReturn efx_rc_t
167 efx_mcdi_mac_spoofing_supported(
169 __out boolean_t *supportedp);
173 #if EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD || EFSYS_OPT_MEDFORD2
174 extern __checkReturn efx_rc_t
175 efx_mcdi_bist_enable_offline(
176 __in efx_nic_t *enp);
177 #endif /* EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD || EFSYS_OPT_MEDFORD2 */
178 extern __checkReturn efx_rc_t
181 __in efx_bist_type_t type);
182 #endif /* EFSYS_OPT_BIST */
184 extern __checkReturn efx_rc_t
185 efx_mcdi_get_resource_limits(
187 __out_opt uint32_t *nevqp,
188 __out_opt uint32_t *nrxqp,
189 __out_opt uint32_t *ntxqp);
191 extern __checkReturn efx_rc_t
193 __in efx_nic_t *enp);
195 extern __checkReturn efx_rc_t
196 efx_mcdi_mac_stats_clear(
197 __in efx_nic_t *enp);
199 extern __checkReturn efx_rc_t
200 efx_mcdi_mac_stats_upload(
202 __in efsys_mem_t *esmp);
204 extern __checkReturn efx_rc_t
205 efx_mcdi_mac_stats_periodic(
207 __in efsys_mem_t *esmp,
208 __in uint16_t period_ms,
209 __in boolean_t events);
212 #if EFSYS_OPT_LOOPBACK
213 extern __checkReturn efx_rc_t
214 efx_mcdi_get_loopback_modes(
215 __in efx_nic_t *enp);
216 #endif /* EFSYS_OPT_LOOPBACK */
218 extern __checkReturn efx_rc_t
219 efx_mcdi_phy_module_get_info(
221 __in uint8_t dev_addr,
224 __out_bcount(len) uint8_t *data);
226 #define MCDI_IN(_emr, _type, _ofst) \
227 ((_type *)((_emr).emr_in_buf + (_ofst)))
229 #define MCDI_IN2(_emr, _type, _ofst) \
230 MCDI_IN(_emr, _type, MC_CMD_ ## _ofst ## _OFST)
232 #define MCDI_IN_SET_BYTE(_emr, _ofst, _value) \
233 EFX_POPULATE_BYTE_1(*MCDI_IN2(_emr, efx_byte_t, _ofst), \
236 #define MCDI_IN_SET_WORD(_emr, _ofst, _value) \
237 EFX_POPULATE_WORD_1(*MCDI_IN2(_emr, efx_word_t, _ofst), \
240 #define MCDI_IN_SET_DWORD(_emr, _ofst, _value) \
241 EFX_POPULATE_DWORD_1(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
244 #define MCDI_IN_SET_DWORD_FIELD(_emr, _ofst, _field, _value) \
245 EFX_SET_DWORD_FIELD(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
246 MC_CMD_ ## _field, _value)
248 #define MCDI_IN_POPULATE_DWORD_1(_emr, _ofst, _field1, _value1) \
249 EFX_POPULATE_DWORD_1(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
250 MC_CMD_ ## _field1, _value1)
252 #define MCDI_IN_POPULATE_DWORD_2(_emr, _ofst, _field1, _value1, \
254 EFX_POPULATE_DWORD_2(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
255 MC_CMD_ ## _field1, _value1, \
256 MC_CMD_ ## _field2, _value2)
258 #define MCDI_IN_POPULATE_DWORD_3(_emr, _ofst, _field1, _value1, \
259 _field2, _value2, _field3, _value3) \
260 EFX_POPULATE_DWORD_3(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
261 MC_CMD_ ## _field1, _value1, \
262 MC_CMD_ ## _field2, _value2, \
263 MC_CMD_ ## _field3, _value3)
265 #define MCDI_IN_POPULATE_DWORD_4(_emr, _ofst, _field1, _value1, \
266 _field2, _value2, _field3, _value3, _field4, _value4) \
267 EFX_POPULATE_DWORD_4(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
268 MC_CMD_ ## _field1, _value1, \
269 MC_CMD_ ## _field2, _value2, \
270 MC_CMD_ ## _field3, _value3, \
271 MC_CMD_ ## _field4, _value4)
273 #define MCDI_IN_POPULATE_DWORD_5(_emr, _ofst, _field1, _value1, \
274 _field2, _value2, _field3, _value3, _field4, _value4, \
276 EFX_POPULATE_DWORD_5(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
277 MC_CMD_ ## _field1, _value1, \
278 MC_CMD_ ## _field2, _value2, \
279 MC_CMD_ ## _field3, _value3, \
280 MC_CMD_ ## _field4, _value4, \
281 MC_CMD_ ## _field5, _value5)
283 #define MCDI_IN_POPULATE_DWORD_6(_emr, _ofst, _field1, _value1, \
284 _field2, _value2, _field3, _value3, _field4, _value4, \
285 _field5, _value5, _field6, _value6) \
286 EFX_POPULATE_DWORD_6(*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)
294 #define MCDI_IN_POPULATE_DWORD_7(_emr, _ofst, _field1, _value1, \
295 _field2, _value2, _field3, _value3, _field4, _value4, \
296 _field5, _value5, _field6, _value6, _field7, _value7) \
297 EFX_POPULATE_DWORD_7(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
298 MC_CMD_ ## _field1, _value1, \
299 MC_CMD_ ## _field2, _value2, \
300 MC_CMD_ ## _field3, _value3, \
301 MC_CMD_ ## _field4, _value4, \
302 MC_CMD_ ## _field5, _value5, \
303 MC_CMD_ ## _field6, _value6, \
304 MC_CMD_ ## _field7, _value7)
306 #define MCDI_IN_POPULATE_DWORD_8(_emr, _ofst, _field1, _value1, \
307 _field2, _value2, _field3, _value3, _field4, _value4, \
308 _field5, _value5, _field6, _value6, _field7, _value7, \
310 EFX_POPULATE_DWORD_8(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
311 MC_CMD_ ## _field1, _value1, \
312 MC_CMD_ ## _field2, _value2, \
313 MC_CMD_ ## _field3, _value3, \
314 MC_CMD_ ## _field4, _value4, \
315 MC_CMD_ ## _field5, _value5, \
316 MC_CMD_ ## _field6, _value6, \
317 MC_CMD_ ## _field7, _value7, \
318 MC_CMD_ ## _field8, _value8)
320 #define MCDI_IN_POPULATE_DWORD_9(_emr, _ofst, _field1, _value1, \
321 _field2, _value2, _field3, _value3, _field4, _value4, \
322 _field5, _value5, _field6, _value6, _field7, _value7, \
323 _field8, _value8, _field9, _value9) \
324 EFX_POPULATE_DWORD_9(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
325 MC_CMD_ ## _field1, _value1, \
326 MC_CMD_ ## _field2, _value2, \
327 MC_CMD_ ## _field3, _value3, \
328 MC_CMD_ ## _field4, _value4, \
329 MC_CMD_ ## _field5, _value5, \
330 MC_CMD_ ## _field6, _value6, \
331 MC_CMD_ ## _field7, _value7, \
332 MC_CMD_ ## _field8, _value8, \
333 MC_CMD_ ## _field9, _value9)
335 #define MCDI_IN_POPULATE_DWORD_10(_emr, _ofst, _field1, _value1, \
336 _field2, _value2, _field3, _value3, _field4, _value4, \
337 _field5, _value5, _field6, _value6, _field7, _value7, \
338 _field8, _value8, _field9, _value9, _field10, _value10) \
339 EFX_POPULATE_DWORD_10(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
340 MC_CMD_ ## _field1, _value1, \
341 MC_CMD_ ## _field2, _value2, \
342 MC_CMD_ ## _field3, _value3, \
343 MC_CMD_ ## _field4, _value4, \
344 MC_CMD_ ## _field5, _value5, \
345 MC_CMD_ ## _field6, _value6, \
346 MC_CMD_ ## _field7, _value7, \
347 MC_CMD_ ## _field8, _value8, \
348 MC_CMD_ ## _field9, _value9, \
349 MC_CMD_ ## _field10, _value10)
351 #define MCDI_OUT(_emr, _type, _ofst) \
352 ((_type *)((_emr).emr_out_buf + (_ofst)))
354 #define MCDI_OUT2(_emr, _type, _ofst) \
355 MCDI_OUT(_emr, _type, MC_CMD_ ## _ofst ## _OFST)
357 #define MCDI_OUT_BYTE(_emr, _ofst) \
358 EFX_BYTE_FIELD(*MCDI_OUT2(_emr, efx_byte_t, _ofst), \
361 #define MCDI_OUT_WORD(_emr, _ofst) \
362 EFX_WORD_FIELD(*MCDI_OUT2(_emr, efx_word_t, _ofst), \
365 #define MCDI_OUT_WORD_FIELD(_emr, _ofst, _field) \
366 EFX_WORD_FIELD(*MCDI_OUT2(_emr, efx_word_t, _ofst), \
369 #define MCDI_OUT_DWORD(_emr, _ofst) \
370 EFX_DWORD_FIELD(*MCDI_OUT2(_emr, efx_dword_t, _ofst), \
373 #define MCDI_OUT_DWORD_FIELD(_emr, _ofst, _field) \
374 EFX_DWORD_FIELD(*MCDI_OUT2(_emr, efx_dword_t, _ofst), \
377 #define MCDI_EV_FIELD(_eqp, _field) \
378 EFX_QWORD_FIELD(*_eqp, MCDI_EVENT_ ## _field)
380 #define MCDI_CMD_DWORD_FIELD(_edp, _field) \
381 EFX_DWORD_FIELD(*_edp, MC_CMD_ ## _field)
383 #define EFX_MCDI_HAVE_PRIVILEGE(mask, priv) \
384 (((mask) & (MC_CMD_PRIVILEGE_MASK_IN_GRP_ ## priv)) == \
385 (MC_CMD_PRIVILEGE_MASK_IN_GRP_ ## priv))
388 * The buffer size must be a multiple of dword to ensure that MCDI works
389 * properly with Siena based boards (which use on-chip buffer). Also, it
390 * should be at minimum the size of two dwords to allow space for extended
391 * error responses if the request/response buffer sizes are smaller.
393 #define EFX_MCDI_DECLARE_BUF(_name, _in_len, _out_len) \
394 uint8_t _name[P2ROUNDUP(MAX(MAX(_in_len, _out_len), \
395 (2 * sizeof (efx_dword_t))), \
396 sizeof (efx_dword_t))] = {0}
398 typedef enum efx_mcdi_feature_id_e {
399 EFX_MCDI_FEATURE_FW_UPDATE = 0,
400 EFX_MCDI_FEATURE_LINK_CONTROL,
401 EFX_MCDI_FEATURE_MACADDR_CHANGE,
402 EFX_MCDI_FEATURE_MAC_SPOOFING,
403 EFX_MCDI_FEATURE_NIDS
404 } efx_mcdi_feature_id_t;
410 #endif /* _SYS_EFX_MCDI_H */