1 /* SPDX-License-Identifier: BSD-3-Clause
3 * Copyright(c) 2019-2021 Xilinx, Inc.
4 * Copyright(c) 2009-2019 Solarflare Communications Inc.
7 #ifndef _SYS_EFX_MCDI_H
8 #define _SYS_EFX_MCDI_H
11 #include "efx_regs_mcdi.h"
14 #include "efx_regs_mcdi_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;
63 __inout efx_mcdi_req_t *emrp);
67 efx_mcdi_execute_quiet(
69 __inout efx_mcdi_req_t *emrp);
75 __in unsigned int seq,
76 __in unsigned int outlen,
79 #if EFSYS_OPT_MCDI_PROXY_AUTH
81 extern __checkReturn efx_rc_t
82 efx_mcdi_get_proxy_handle(
84 __in efx_mcdi_req_t *emrp,
85 __out uint32_t *handlep);
89 efx_mcdi_ev_proxy_response(
91 __in unsigned int handle,
92 __in unsigned int status);
95 #if EFSYS_OPT_MCDI_PROXY_AUTH_SERVER
98 efx_mcdi_ev_proxy_request(
100 __in unsigned int index);
101 #endif /* EFSYS_OPT_MCDI_PROXY_AUTH_SERVER */
110 extern __checkReturn efx_rc_t
111 efx_mcdi_request_errcode(
112 __in unsigned int err);
116 efx_mcdi_raise_exception(
118 __in_opt efx_mcdi_req_t *emrp,
122 * Flags that name portions of extended version information
124 * The values match their MCDI counterparts.
126 #define EFX_MCDI_VERSION_BOARD_INFO (1U << 4)
128 typedef struct efx_mcdi_version_s {
129 /* Basic version information */
130 uint16_t emv_version[4];
131 uint32_t emv_firmware;
134 * Extended version information
136 * Valid portions of obtained information are indicated by flags.
140 /* Information valid if emv_flags has EFX_MCDI_VERSION_BOARD_INFO set */
141 efx_nic_board_info_t emv_board_info;
142 } efx_mcdi_version_t;
145 extern __checkReturn efx_rc_t
146 efx_mcdi_get_version(
148 __in uint32_t flags_req,
149 __out efx_mcdi_version_t *verp);
151 typedef enum efx_mcdi_boot_e {
152 EFX_MCDI_BOOT_PRIMARY,
153 EFX_MCDI_BOOT_SECONDARY,
158 extern __checkReturn efx_rc_t
161 __out_ecount_opt(4) uint16_t versionp[4],
162 __out_opt uint32_t *buildp,
163 __out_opt efx_mcdi_boot_t *statusp);
166 extern __checkReturn efx_rc_t
167 efx_mcdi_get_capabilities(
169 __out_opt uint32_t *flagsp,
170 __out_opt uint16_t *rx_dpcpu_fw_idp,
171 __out_opt uint16_t *tx_dpcpu_fw_idp,
172 __out_opt uint32_t *flags2p,
173 __out_opt uint32_t *tso2ncp);
176 extern __checkReturn efx_rc_t
177 efx_mcdi_read_assertion(
178 __in efx_nic_t *enp);
181 extern __checkReturn efx_rc_t
182 efx_mcdi_exit_assertion_handler(
183 __in efx_nic_t *enp);
186 extern __checkReturn efx_rc_t
189 __in boolean_t attach);
192 extern __checkReturn efx_rc_t
193 efx_mcdi_get_board_cfg(
195 __out_opt uint32_t *board_typep,
196 __out_opt efx_dword_t *capabilitiesp,
197 __out_ecount_opt(6) uint8_t mac_addrp[6]);
200 extern __checkReturn efx_rc_t
201 efx_mcdi_get_phy_cfg(
202 __in efx_nic_t *enp);
205 extern __checkReturn efx_rc_t
206 efx_mcdi_firmware_update_supported(
208 __out boolean_t *supportedp);
211 extern __checkReturn efx_rc_t
212 efx_mcdi_macaddr_change_supported(
214 __out boolean_t *supportedp);
217 extern __checkReturn efx_rc_t
218 efx_mcdi_link_control_supported(
220 __out boolean_t *supportedp);
223 extern __checkReturn efx_rc_t
224 efx_mcdi_mac_spoofing_supported(
226 __out boolean_t *supportedp);
232 extern __checkReturn efx_rc_t
233 efx_mcdi_bist_enable_offline(
234 __in efx_nic_t *enp);
235 #endif /* EFX_OPTS_EF10() */
237 extern __checkReturn efx_rc_t
240 __in efx_bist_type_t type);
241 #endif /* EFSYS_OPT_BIST */
244 extern __checkReturn efx_rc_t
245 efx_mcdi_get_resource_limits(
247 __out_opt uint32_t *nevqp,
248 __out_opt uint32_t *nrxqp,
249 __out_opt uint32_t *ntxqp);
252 extern __checkReturn efx_rc_t
254 __in efx_nic_t *enp);
257 extern __checkReturn efx_rc_t
258 efx_mcdi_mac_stats_clear(
259 __in efx_nic_t *enp);
262 extern __checkReturn efx_rc_t
263 efx_mcdi_mac_stats_upload(
265 __in efsys_mem_t *esmp);
268 extern __checkReturn efx_rc_t
269 efx_mcdi_mac_stats_periodic(
271 __in efsys_mem_t *esmp,
272 __in uint16_t period_ms,
273 __in boolean_t events);
276 #if EFSYS_OPT_LOOPBACK
278 extern __checkReturn efx_rc_t
279 efx_mcdi_get_loopback_modes(
280 __in efx_nic_t *enp);
281 #endif /* EFSYS_OPT_LOOPBACK */
284 extern __checkReturn efx_rc_t
285 efx_mcdi_phy_module_get_info(
287 __in uint8_t dev_addr,
290 __out_bcount(len) uint8_t *data);
293 extern __checkReturn efx_rc_t
294 efx_mcdi_get_nic_addr_info(
296 __out uint32_t *mapping_typep);
298 struct efx_nic_dma_region_info_s;
301 extern __checkReturn efx_rc_t
302 efx_mcdi_get_nic_addr_regions(
304 __out struct efx_nic_dma_region_info_s *endrip);
307 extern __checkReturn efx_rc_t
308 efx_mcdi_set_nic_addr_regions(
310 __in const struct efx_nic_dma_region_info_s *endrip);
312 #define MCDI_IN(_emr, _type, _ofst) \
313 ((_type *)((_emr).emr_in_buf + (_ofst)))
315 #define MCDI_IN2(_emr, _type, _ofst) \
316 MCDI_IN(_emr, _type, MC_CMD_ ## _ofst ## _OFST)
318 #define MCDI_IN_SET_BYTE(_emr, _ofst, _value) \
319 EFX_POPULATE_BYTE_1(*MCDI_IN2(_emr, efx_byte_t, _ofst), \
322 #define MCDI_IN_SET_WORD(_emr, _ofst, _value) \
323 EFX_POPULATE_WORD_1(*MCDI_IN2(_emr, efx_word_t, _ofst), \
326 #define MCDI_IN_SET_DWORD(_emr, _ofst, _value) \
327 EFX_POPULATE_DWORD_1(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
330 #define MCDI_IN_SET_DWORD_FIELD(_emr, _ofst, _field, _value) \
331 EFX_SET_DWORD_FIELD(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
332 MC_CMD_ ## _field, _value)
334 #define MCDI_IN_SET_INDEXED_DWORD(_emr, _ofst, _idx, _value) \
335 EFX_POPULATE_DWORD_1(*(MCDI_IN2(_emr, efx_dword_t, _ofst) + \
336 (_idx)), EFX_DWORD_0, _value) \
338 #define MCDI_IN_SET_QWORD(_emr, _ofst, _value) \
339 EFX_POPULATE_QWORD_2(*MCDI_IN2(_emr, efx_qword_t, _ofst), \
340 EFX_DWORD_0, ((_value) & 0xffffffff), \
341 EFX_DWORD_1, ((_value) >> 32))
343 #define MCDI_IN_SET_INDEXED_QWORD(_emr, _ofst, _idx, _value) \
344 EFX_POPULATE_QWORD_2(*(MCDI_IN2(_emr, efx_qword_t, _ofst) + \
346 EFX_DWORD_0, ((_value) & 0xffffffff), \
347 EFX_DWORD_1, ((_value) >> 32))
349 #define MCDI_IN_POPULATE_DWORD_1(_emr, _ofst, _field1, _value1) \
350 EFX_POPULATE_DWORD_1(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
351 MC_CMD_ ## _field1, _value1)
353 #define MCDI_IN_POPULATE_DWORD_2(_emr, _ofst, _field1, _value1, \
355 EFX_POPULATE_DWORD_2(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
356 MC_CMD_ ## _field1, _value1, \
357 MC_CMD_ ## _field2, _value2)
359 #define MCDI_IN_POPULATE_DWORD_3(_emr, _ofst, _field1, _value1, \
360 _field2, _value2, _field3, _value3) \
361 EFX_POPULATE_DWORD_3(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
362 MC_CMD_ ## _field1, _value1, \
363 MC_CMD_ ## _field2, _value2, \
364 MC_CMD_ ## _field3, _value3)
366 #define MCDI_IN_POPULATE_DWORD_4(_emr, _ofst, _field1, _value1, \
367 _field2, _value2, _field3, _value3, _field4, _value4) \
368 EFX_POPULATE_DWORD_4(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
369 MC_CMD_ ## _field1, _value1, \
370 MC_CMD_ ## _field2, _value2, \
371 MC_CMD_ ## _field3, _value3, \
372 MC_CMD_ ## _field4, _value4)
374 #define MCDI_IN_POPULATE_DWORD_5(_emr, _ofst, _field1, _value1, \
375 _field2, _value2, _field3, _value3, _field4, _value4, \
377 EFX_POPULATE_DWORD_5(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
378 MC_CMD_ ## _field1, _value1, \
379 MC_CMD_ ## _field2, _value2, \
380 MC_CMD_ ## _field3, _value3, \
381 MC_CMD_ ## _field4, _value4, \
382 MC_CMD_ ## _field5, _value5)
384 #define MCDI_IN_POPULATE_DWORD_6(_emr, _ofst, _field1, _value1, \
385 _field2, _value2, _field3, _value3, _field4, _value4, \
386 _field5, _value5, _field6, _value6) \
387 EFX_POPULATE_DWORD_6(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
388 MC_CMD_ ## _field1, _value1, \
389 MC_CMD_ ## _field2, _value2, \
390 MC_CMD_ ## _field3, _value3, \
391 MC_CMD_ ## _field4, _value4, \
392 MC_CMD_ ## _field5, _value5, \
393 MC_CMD_ ## _field6, _value6)
395 #define MCDI_IN_POPULATE_DWORD_7(_emr, _ofst, _field1, _value1, \
396 _field2, _value2, _field3, _value3, _field4, _value4, \
397 _field5, _value5, _field6, _value6, _field7, _value7) \
398 EFX_POPULATE_DWORD_7(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
399 MC_CMD_ ## _field1, _value1, \
400 MC_CMD_ ## _field2, _value2, \
401 MC_CMD_ ## _field3, _value3, \
402 MC_CMD_ ## _field4, _value4, \
403 MC_CMD_ ## _field5, _value5, \
404 MC_CMD_ ## _field6, _value6, \
405 MC_CMD_ ## _field7, _value7)
407 #define MCDI_IN_POPULATE_DWORD_8(_emr, _ofst, _field1, _value1, \
408 _field2, _value2, _field3, _value3, _field4, _value4, \
409 _field5, _value5, _field6, _value6, _field7, _value7, \
411 EFX_POPULATE_DWORD_8(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
412 MC_CMD_ ## _field1, _value1, \
413 MC_CMD_ ## _field2, _value2, \
414 MC_CMD_ ## _field3, _value3, \
415 MC_CMD_ ## _field4, _value4, \
416 MC_CMD_ ## _field5, _value5, \
417 MC_CMD_ ## _field6, _value6, \
418 MC_CMD_ ## _field7, _value7, \
419 MC_CMD_ ## _field8, _value8)
421 #define MCDI_IN_POPULATE_DWORD_9(_emr, _ofst, _field1, _value1, \
422 _field2, _value2, _field3, _value3, _field4, _value4, \
423 _field5, _value5, _field6, _value6, _field7, _value7, \
424 _field8, _value8, _field9, _value9) \
425 EFX_POPULATE_DWORD_9(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
426 MC_CMD_ ## _field1, _value1, \
427 MC_CMD_ ## _field2, _value2, \
428 MC_CMD_ ## _field3, _value3, \
429 MC_CMD_ ## _field4, _value4, \
430 MC_CMD_ ## _field5, _value5, \
431 MC_CMD_ ## _field6, _value6, \
432 MC_CMD_ ## _field7, _value7, \
433 MC_CMD_ ## _field8, _value8, \
434 MC_CMD_ ## _field9, _value9)
436 #define MCDI_IN_POPULATE_DWORD_10(_emr, _ofst, _field1, _value1, \
437 _field2, _value2, _field3, _value3, _field4, _value4, \
438 _field5, _value5, _field6, _value6, _field7, _value7, \
439 _field8, _value8, _field9, _value9, _field10, _value10) \
440 EFX_POPULATE_DWORD_10(*MCDI_IN2(_emr, efx_dword_t, _ofst), \
441 MC_CMD_ ## _field1, _value1, \
442 MC_CMD_ ## _field2, _value2, \
443 MC_CMD_ ## _field3, _value3, \
444 MC_CMD_ ## _field4, _value4, \
445 MC_CMD_ ## _field5, _value5, \
446 MC_CMD_ ## _field6, _value6, \
447 MC_CMD_ ## _field7, _value7, \
448 MC_CMD_ ## _field8, _value8, \
449 MC_CMD_ ## _field9, _value9, \
450 MC_CMD_ ## _field10, _value10)
453 * Native setters (MCDI_IN_SET_*_NATIVE) are used when MCDI field is in
454 * network order to avoid conversion to little-endian that is done in
457 #define MCDI_IN_SET_WORD_NATIVE(_emr, _ofst, _value) \
458 MCDI_IN2((_emr), efx_word_t, _ofst)->ew_u16[0] = (_value)
460 #define MCDI_IN_SET_DWORD_NATIVE(_emr, _ofst, _value) \
461 MCDI_IN2((_emr), efx_dword_t, _ofst)->ed_u32[0] = (_value)
463 #define MCDI_OUT(_emr, _type, _ofst) \
464 ((_type *)((_emr).emr_out_buf + (_ofst)))
466 #define MCDI_OUT2(_emr, _type, _ofst) \
467 MCDI_OUT(_emr, _type, MC_CMD_ ## _ofst ## _OFST)
469 #define MCDI_OUT_BYTE(_emr, _ofst) \
470 EFX_BYTE_FIELD(*MCDI_OUT2(_emr, efx_byte_t, _ofst), \
473 #define MCDI_OUT_WORD(_emr, _ofst) \
474 EFX_WORD_FIELD(*MCDI_OUT2(_emr, efx_word_t, _ofst), \
477 #define MCDI_OUT_WORD_FIELD(_emr, _ofst, _field) \
478 EFX_WORD_FIELD(*MCDI_OUT2(_emr, efx_word_t, _ofst), \
481 #define MCDI_OUT_DWORD(_emr, _ofst) \
482 EFX_DWORD_FIELD(*MCDI_OUT2(_emr, efx_dword_t, _ofst), \
485 #define MCDI_OUT_DWORD_FIELD(_emr, _ofst, _field) \
486 EFX_DWORD_FIELD(*MCDI_OUT2(_emr, efx_dword_t, _ofst), \
489 #define MCDI_OUT_INDEXED_DWORD(_emr, _ofst, _idx) \
490 MCDI_OUT_INDEXED_DWORD_FIELD(_emr, _ofst, _idx, EFX_DWORD_0)
492 #define MCDI_OUT_INDEXED_DWORD_FIELD(_emr, _ofst, _idx, _field) \
493 EFX_DWORD_FIELD(*(MCDI_OUT2(_emr, efx_dword_t, _ofst) + \
496 #define MCDI_OUT_INDEXED_STRUCT_MEMBER(_emr, _type, _arr_ofst, _idx, \
498 ((_type *)(MCDI_OUT2(_emr, uint8_t, _arr_ofst) + \
499 _idx * MC_CMD_ ## _arr_ofst ## _LEN + \
500 _member_ofst ## _OFST))
502 #define MCDI_OUT_INDEXED_MEMBER_DWORD(_emr, _arr_ofst, _idx, \
505 *(MCDI_OUT_INDEXED_STRUCT_MEMBER(_emr, efx_dword_t, \
510 #define MCDI_OUT_INDEXED_MEMBER_QWORD(_emr, _arr_ofst, _idx, \
512 ((uint64_t)EFX_QWORD_FIELD( \
513 *(MCDI_OUT_INDEXED_STRUCT_MEMBER(_emr, efx_qword_t, \
517 (uint64_t)EFX_QWORD_FIELD( \
518 *(MCDI_OUT_INDEXED_STRUCT_MEMBER(_emr, efx_qword_t, \
523 #define MCDI_STRUCT_MEMBER(_buf, _type, _ofst) \
524 ((_type *)((char *)_buf + _ofst ## _OFST)) \
526 #define MCDI_STRUCT_BYTE(_buf, _ofst) \
527 EFX_BYTE_FIELD(*MCDI_STRUCT_MEMBER(_buf, efx_byte_t, _ofst), \
530 #define MCDI_STRUCT_BYTE_FIELD(_buf, _ofst, _field) \
531 EFX_BYTE_FIELD(*MCDI_STRUCT_MEMBER(_buf, efx_byte_t, _ofst), \
534 #define MCDI_STRUCT_WORD(_buf, _ofst) \
535 EFX_WORD_FIELD(*MCDI_STRUCT_MEMBER(_buf, efx_word_t, _ofst), \
538 #define MCDI_STRUCT_WORD_FIELD(_buf, _ofst, _field) \
539 EFX_WORD_FIELD(*MCDI_STRUCT_MEMBER(_buf, efx_word_t, _ofst), \
542 #define MCDI_STRUCT_DWORD(_buf, _ofst) \
543 EFX_DWORD_FIELD(*MCDI_STRUCT_MEMBER(_buf, efx_dword_t, _ofst), \
546 #define MCDI_STRUCT_DWORD_FIELD(_buf, _ofst, _field) \
547 EFX_DWORD_FIELD(*MCDI_STRUCT_MEMBER(_buf, efx_dword_t, _ofst), \
550 #define MCDI_EV_FIELD(_eqp, _field) \
551 EFX_QWORD_FIELD(*_eqp, MCDI_EVENT_ ## _field)
553 #define MCDI_CMD_DWORD_FIELD(_edp, _field) \
554 EFX_DWORD_FIELD(*_edp, MC_CMD_ ## _field)
556 #define EFX_MCDI_HAVE_PRIVILEGE(mask, priv) \
557 (((mask) & (MC_CMD_PRIVILEGE_MASK_IN_GRP_ ## priv)) == \
558 (MC_CMD_PRIVILEGE_MASK_IN_GRP_ ## priv))
560 #define EFX_MCDI_BUF_SIZE(_in_len, _out_len) \
561 EFX_P2ROUNDUP(size_t, \
562 MAX(MAX(_in_len, _out_len), (2 * sizeof (efx_dword_t))),\
563 sizeof (efx_dword_t))
566 * The buffer size must be a multiple of dword to ensure that MCDI works
567 * properly with Siena based boards (which use on-chip buffer). Also, it
568 * should be at minimum the size of two dwords to allow space for extended
569 * error responses if the request/response buffer sizes are smaller.
571 #define EFX_MCDI_DECLARE_BUF(_name, _in_len, _out_len) \
572 uint8_t _name[EFX_MCDI_BUF_SIZE(_in_len, _out_len)] = {0}
574 typedef enum efx_mcdi_feature_id_e {
575 EFX_MCDI_FEATURE_FW_UPDATE = 0,
576 EFX_MCDI_FEATURE_LINK_CONTROL,
577 EFX_MCDI_FEATURE_MACADDR_CHANGE,
578 EFX_MCDI_FEATURE_MAC_SPOOFING,
579 EFX_MCDI_FEATURE_NIDS
580 } efx_mcdi_feature_id_t;
586 #endif /* _SYS_EFX_MCDI_H */