1 /* SPDX-License-Identifier: BSD-3-Clause
3 * Copyright (c) 2012-2018 Solarflare Communications Inc.
11 #if EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD
16 #error "WITH_MCDI_V2 required for EF10 MCDIv2 commands."
20 __checkReturn efx_rc_t
23 __in const efx_mcdi_transport_t *emtp)
25 efx_mcdi_iface_t *emip = &(enp->en_mcdi.em_emip);
26 efsys_mem_t *esmp = emtp->emt_dma_mem;
30 EFSYS_ASSERT(enp->en_family == EFX_FAMILY_HUNTINGTON ||
31 enp->en_family == EFX_FAMILY_MEDFORD);
32 EFSYS_ASSERT(enp->en_features & EFX_FEATURE_MCDI_DMA);
35 * All EF10 firmware supports MCDIv2 and MCDIv1.
36 * Medford BootROM supports MCDIv2 and MCDIv1.
37 * Huntington BootROM supports MCDIv1 only.
39 emip->emi_max_version = 2;
41 /* A host DMA buffer is required for EF10 MCDI */
48 * Ensure that the MC doorbell is in a known state before issuing MCDI
49 * commands. The recovery algorithm requires that the MC command buffer
50 * must be 256 byte aligned. See bug24769.
52 if ((EFSYS_MEM_ADDR(esmp) & 0xFF) != 0) {
56 EFX_POPULATE_DWORD_1(dword, EFX_DWORD_0, 1);
57 EFX_BAR_WRITED(enp, ER_DZ_MC_DB_HWRD_REG, &dword, B_FALSE);
59 /* Save initial MC reboot status */
60 (void) ef10_mcdi_poll_reboot(enp);
62 /* Start a new epoch (allow fresh MCDI requests to succeed) */
63 efx_mcdi_new_epoch(enp);
70 EFSYS_PROBE1(fail1, efx_rc_t, rc);
79 efx_mcdi_iface_t *emip = &(enp->en_mcdi.em_emip);
81 emip->emi_new_epoch = B_FALSE;
85 * In older firmware all commands are processed in a single thread, so a long
86 * running command for one PCIe function can block processing for another
87 * function (see bug 61269).
89 * In newer firmware that supports multithreaded MCDI processing, we can extend
90 * the timeout for long-running requests which we know firmware may choose to
91 * process in a background thread.
93 #define EF10_MCDI_CMD_TIMEOUT_US (10 * 1000 * 1000)
94 #define EF10_MCDI_CMD_LONG_TIMEOUT_US (60 * 1000 * 1000)
97 ef10_mcdi_get_timeout(
99 __in efx_mcdi_req_t *emrp,
100 __out uint32_t *timeoutp)
102 efx_nic_cfg_t *encp = &(enp->en_nic_cfg);
104 switch (emrp->emr_cmd) {
105 case MC_CMD_POLL_BIST:
106 case MC_CMD_NVRAM_ERASE:
107 case MC_CMD_LICENSING_V3:
108 case MC_CMD_NVRAM_UPDATE_FINISH:
109 if (encp->enc_nvram_update_verify_result_supported != B_FALSE) {
111 * Potentially longer running commands, which firmware
112 * may choose to process in a background thread.
114 *timeoutp = EF10_MCDI_CMD_LONG_TIMEOUT_US;
119 *timeoutp = EF10_MCDI_CMD_TIMEOUT_US;
125 ef10_mcdi_send_request(
127 __in_bcount(hdr_len) void *hdrp,
129 __in_bcount(sdu_len) void *sdup,
132 const efx_mcdi_transport_t *emtp = enp->en_mcdi.em_emtp;
133 efsys_mem_t *esmp = emtp->emt_dma_mem;
137 EFSYS_ASSERT(enp->en_family == EFX_FAMILY_HUNTINGTON ||
138 enp->en_family == EFX_FAMILY_MEDFORD);
140 /* Write the header */
141 for (pos = 0; pos < hdr_len; pos += sizeof (efx_dword_t)) {
142 dword = *(efx_dword_t *)((uint8_t *)hdrp + pos);
143 EFSYS_MEM_WRITED(esmp, pos, &dword);
146 /* Write the payload */
147 for (pos = 0; pos < sdu_len; pos += sizeof (efx_dword_t)) {
148 dword = *(efx_dword_t *)((uint8_t *)sdup + pos);
149 EFSYS_MEM_WRITED(esmp, hdr_len + pos, &dword);
152 /* Guarantee ordering of memory (MCDI request) and PIO (MC doorbell) */
153 EFSYS_DMA_SYNC_FOR_DEVICE(esmp, 0, hdr_len + sdu_len);
154 EFSYS_PIO_WRITE_BARRIER();
156 /* Ring the doorbell to post the command DMA address to the MC */
157 EFX_POPULATE_DWORD_1(dword, EFX_DWORD_0,
158 EFSYS_MEM_ADDR(esmp) >> 32);
159 EFX_BAR_WRITED(enp, ER_DZ_MC_DB_LWRD_REG, &dword, B_FALSE);
161 EFX_POPULATE_DWORD_1(dword, EFX_DWORD_0,
162 EFSYS_MEM_ADDR(esmp) & 0xffffffff);
163 EFX_BAR_WRITED(enp, ER_DZ_MC_DB_HWRD_REG, &dword, B_FALSE);
166 __checkReturn boolean_t
167 ef10_mcdi_poll_response(
170 const efx_mcdi_transport_t *emtp = enp->en_mcdi.em_emtp;
171 efsys_mem_t *esmp = emtp->emt_dma_mem;
174 EFSYS_MEM_READD(esmp, 0, &hdr);
175 EFSYS_MEM_READ_BARRIER();
177 return (EFX_DWORD_FIELD(hdr, MCDI_HEADER_RESPONSE) ? B_TRUE : B_FALSE);
181 ef10_mcdi_read_response(
183 __out_bcount(length) void *bufferp,
187 const efx_mcdi_transport_t *emtp = enp->en_mcdi.em_emtp;
188 efsys_mem_t *esmp = emtp->emt_dma_mem;
192 for (pos = 0; pos < length; pos += sizeof (efx_dword_t)) {
193 EFSYS_MEM_READD(esmp, offset + pos, &data);
194 memcpy((uint8_t *)bufferp + pos, &data,
195 MIN(sizeof (data), length - pos));
200 ef10_mcdi_poll_reboot(
203 efx_mcdi_iface_t *emip = &(enp->en_mcdi.em_emip);
209 old_status = emip->emi_mc_reboot_status;
211 /* Update MC reboot status word */
212 EFX_BAR_TBL_READD(enp, ER_DZ_BIU_MC_SFT_STATUS_REG, 0, &dword, B_FALSE);
213 new_status = dword.ed_u32[0];
215 /* MC has rebooted if the value has changed */
216 if (new_status != old_status) {
217 emip->emi_mc_reboot_status = new_status;
220 * FIXME: Ignore detected MC REBOOT for now.
222 * The Siena support for checking for MC reboot from status
223 * flags is broken - see comments in siena_mcdi_poll_reboot().
224 * As the generic MCDI code is shared the EF10 reboot
225 * detection suffers similar problems.
227 * Do not report an error when the boot status changes until
228 * this can be handled by common code drivers (and reworked to
229 * support Siena too).
231 _NOTE(CONSTANTCONDITION)
241 EFSYS_PROBE1(fail1, efx_rc_t, rc);
246 __checkReturn efx_rc_t
247 ef10_mcdi_feature_supported(
249 __in efx_mcdi_feature_id_t id,
250 __out boolean_t *supportedp)
252 efx_nic_cfg_t *encp = &(enp->en_nic_cfg);
253 uint32_t privilege_mask = encp->enc_privilege_mask;
256 EFSYS_ASSERT(enp->en_family == EFX_FAMILY_HUNTINGTON ||
257 enp->en_family == EFX_FAMILY_MEDFORD);
260 * Use privilege mask state at MCDI attach.
264 case EFX_MCDI_FEATURE_FW_UPDATE:
266 * Admin privilege must be used prior to introduction of
270 EFX_MCDI_HAVE_PRIVILEGE(privilege_mask, ADMIN);
272 case EFX_MCDI_FEATURE_LINK_CONTROL:
274 * Admin privilege used prior to introduction of
278 EFX_MCDI_HAVE_PRIVILEGE(privilege_mask, LINK) ||
279 EFX_MCDI_HAVE_PRIVILEGE(privilege_mask, ADMIN);
281 case EFX_MCDI_FEATURE_MACADDR_CHANGE:
283 * Admin privilege must be used prior to introduction of
284 * mac spoofing privilege (at v4.6), which is used up to
285 * introduction of change mac spoofing privilege (at v4.7)
288 EFX_MCDI_HAVE_PRIVILEGE(privilege_mask, CHANGE_MAC) ||
289 EFX_MCDI_HAVE_PRIVILEGE(privilege_mask, MAC_SPOOFING) ||
290 EFX_MCDI_HAVE_PRIVILEGE(privilege_mask, ADMIN);
292 case EFX_MCDI_FEATURE_MAC_SPOOFING:
294 * Admin privilege must be used prior to introduction of
295 * mac spoofing privilege (at v4.6), which is used up to
296 * introduction of mac spoofing TX privilege (at v4.7)
299 EFX_MCDI_HAVE_PRIVILEGE(privilege_mask, MAC_SPOOFING_TX) ||
300 EFX_MCDI_HAVE_PRIVILEGE(privilege_mask, MAC_SPOOFING) ||
301 EFX_MCDI_HAVE_PRIVILEGE(privilege_mask, ADMIN);
311 EFSYS_PROBE1(fail1, efx_rc_t, rc);
316 #endif /* EFSYS_OPT_MCDI */
318 #endif /* EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD */