1 /* SPDX-License-Identifier: BSD-3-Clause
3 * Copyright (c) 2009-2018 Solarflare Communications Inc.
12 #if EFSYS_OPT_VPD || EFSYS_OPT_NVRAM
14 __checkReturn efx_rc_t
15 siena_nvram_partn_size(
21 efx_nvram_info_t eni = { 0 };
23 if ((1 << partn) & ~enp->en_u.siena.enu_partn_mask) {
28 if ((rc = efx_mcdi_nvram_info(enp, partn, &eni)) != 0)
31 *sizep = eni.eni_partn_size;
38 EFSYS_PROBE1(fail1, efx_rc_t, rc);
43 __checkReturn efx_rc_t
44 siena_nvram_partn_info(
47 __out efx_nvram_info_t * enip)
51 if ((rc = efx_mcdi_nvram_info(enp, partn, enip)) != 0)
54 if (enip->eni_write_size == 0)
55 enip->eni_write_size = SIENA_NVRAM_CHUNK;
60 EFSYS_PROBE1(fail1, efx_rc_t, rc);
66 __checkReturn efx_rc_t
67 siena_nvram_partn_lock(
73 if ((rc = efx_mcdi_nvram_update_start(enp, partn)) != 0) {
80 EFSYS_PROBE1(fail1, efx_rc_t, rc);
85 __checkReturn efx_rc_t
86 siena_nvram_partn_read(
89 __in unsigned int offset,
90 __out_bcount(size) caddr_t data,
97 chunk = MIN(size, SIENA_NVRAM_CHUNK);
99 if ((rc = efx_mcdi_nvram_read(enp, partn, offset, data, chunk,
100 MC_CMD_NVRAM_READ_IN_V2_DEFAULT)) != 0) {
112 EFSYS_PROBE1(fail1, efx_rc_t, rc);
117 __checkReturn efx_rc_t
118 siena_nvram_partn_erase(
121 __in unsigned int offset,
126 if ((rc = efx_mcdi_nvram_erase(enp, partn, offset, size)) != 0) {
133 EFSYS_PROBE1(fail1, efx_rc_t, rc);
138 __checkReturn efx_rc_t
139 siena_nvram_partn_write(
142 __in unsigned int offset,
143 __out_bcount(size) caddr_t data,
150 chunk = MIN(size, SIENA_NVRAM_CHUNK);
152 if ((rc = efx_mcdi_nvram_write(enp, partn, offset,
153 data, chunk)) != 0) {
165 EFSYS_PROBE1(fail1, efx_rc_t, rc);
170 __checkReturn efx_rc_t
171 siena_nvram_partn_unlock(
174 __out_opt uint32_t *verify_resultp)
180 * Reboot into the new image only for PHYs. The driver has to
181 * explicitly cope with an MC reboot after a firmware update.
183 reboot = (partn == MC_CMD_NVRAM_TYPE_PHY_PORT0 ||
184 partn == MC_CMD_NVRAM_TYPE_PHY_PORT1 ||
185 partn == MC_CMD_NVRAM_TYPE_DISABLED_CALLISTO);
187 rc = efx_mcdi_nvram_update_finish(enp, partn, reboot, verify_resultp);
194 EFSYS_PROBE1(fail1, efx_rc_t, rc);
199 #endif /* EFSYS_OPT_VPD || EFSYS_OPT_NVRAM */
203 typedef struct siena_parttbl_entry_s {
206 efx_nvram_type_t nvtype;
207 } siena_parttbl_entry_t;
209 static siena_parttbl_entry_t siena_parttbl[] = {
210 {MC_CMD_NVRAM_TYPE_DISABLED_CALLISTO, 1, EFX_NVRAM_NULLPHY},
211 {MC_CMD_NVRAM_TYPE_DISABLED_CALLISTO, 2, EFX_NVRAM_NULLPHY},
212 {MC_CMD_NVRAM_TYPE_MC_FW, 1, EFX_NVRAM_MC_FIRMWARE},
213 {MC_CMD_NVRAM_TYPE_MC_FW, 2, EFX_NVRAM_MC_FIRMWARE},
214 {MC_CMD_NVRAM_TYPE_MC_FW_BACKUP, 1, EFX_NVRAM_MC_GOLDEN},
215 {MC_CMD_NVRAM_TYPE_MC_FW_BACKUP, 2, EFX_NVRAM_MC_GOLDEN},
216 {MC_CMD_NVRAM_TYPE_EXP_ROM, 1, EFX_NVRAM_BOOTROM},
217 {MC_CMD_NVRAM_TYPE_EXP_ROM, 2, EFX_NVRAM_BOOTROM},
218 {MC_CMD_NVRAM_TYPE_EXP_ROM_CFG_PORT0, 1, EFX_NVRAM_BOOTROM_CFG},
219 {MC_CMD_NVRAM_TYPE_EXP_ROM_CFG_PORT1, 2, EFX_NVRAM_BOOTROM_CFG},
220 {MC_CMD_NVRAM_TYPE_PHY_PORT0, 1, EFX_NVRAM_PHY},
221 {MC_CMD_NVRAM_TYPE_PHY_PORT1, 2, EFX_NVRAM_PHY},
222 {MC_CMD_NVRAM_TYPE_FPGA, 1, EFX_NVRAM_FPGA},
223 {MC_CMD_NVRAM_TYPE_FPGA, 2, EFX_NVRAM_FPGA},
224 {MC_CMD_NVRAM_TYPE_FPGA_BACKUP, 1, EFX_NVRAM_FPGA_BACKUP},
225 {MC_CMD_NVRAM_TYPE_FPGA_BACKUP, 2, EFX_NVRAM_FPGA_BACKUP},
226 {MC_CMD_NVRAM_TYPE_FC_FW, 1, EFX_NVRAM_FCFW},
227 {MC_CMD_NVRAM_TYPE_FC_FW, 2, EFX_NVRAM_FCFW},
228 {MC_CMD_NVRAM_TYPE_CPLD, 1, EFX_NVRAM_CPLD},
229 {MC_CMD_NVRAM_TYPE_CPLD, 2, EFX_NVRAM_CPLD},
230 {MC_CMD_NVRAM_TYPE_LICENSE, 1, EFX_NVRAM_LICENSE},
231 {MC_CMD_NVRAM_TYPE_LICENSE, 2, EFX_NVRAM_LICENSE}
234 __checkReturn efx_rc_t
235 siena_nvram_type_to_partn(
237 __in efx_nvram_type_t type,
238 __out uint32_t *partnp)
240 efx_mcdi_iface_t *emip = &(enp->en_mcdi.em_emip);
243 EFSYS_ASSERT3U(type, !=, EFX_NVRAM_INVALID);
244 EFSYS_ASSERT3U(type, <, EFX_NVRAM_NTYPES);
245 EFSYS_ASSERT(partnp != NULL);
247 for (i = 0; i < EFX_ARRAY_SIZE(siena_parttbl); i++) {
248 siena_parttbl_entry_t *entry = &siena_parttbl[i];
250 if (entry->port == emip->emi_port && entry->nvtype == type) {
251 *partnp = entry->partn;
262 __checkReturn efx_rc_t
266 efx_mcdi_iface_t *emip = &(enp->en_mcdi.em_emip);
267 siena_parttbl_entry_t *entry;
272 * Iterate over the list of supported partition types
273 * applicable to *this* port
275 for (i = 0; i < EFX_ARRAY_SIZE(siena_parttbl); i++) {
276 entry = &siena_parttbl[i];
278 if (entry->port != emip->emi_port ||
279 !(enp->en_u.siena.enu_partn_mask & (1 << entry->partn)))
282 if ((rc = efx_mcdi_nvram_test(enp, entry->partn)) != 0) {
290 EFSYS_PROBE1(fail1, efx_rc_t, rc);
295 #endif /* EFSYS_OPT_DIAG */
298 #define SIENA_DYNAMIC_CFG_SIZE(_nitems) \
299 (sizeof (siena_mc_dynamic_config_hdr_t) + ((_nitems) * \
300 sizeof (((siena_mc_dynamic_config_hdr_t *)NULL)->fw_version[0])))
302 __checkReturn efx_rc_t
303 siena_nvram_get_dynamic_cfg(
307 __out siena_mc_dynamic_config_hdr_t **dcfgp,
310 siena_mc_dynamic_config_hdr_t *dcfg = NULL;
313 unsigned int vpd_offset;
314 unsigned int vpd_length;
315 unsigned int hdr_length;
316 unsigned int nversions;
321 EFSYS_ASSERT(partn == MC_CMD_NVRAM_TYPE_DYNAMIC_CFG_PORT0 ||
322 partn == MC_CMD_NVRAM_TYPE_DYNAMIC_CFG_PORT1);
325 * Allocate sufficient memory for the entire dynamiccfg area, even
326 * if we're not actually going to read in the VPD.
328 if ((rc = siena_nvram_partn_size(enp, partn, &size)) != 0)
331 if (size < SIENA_NVRAM_CHUNK) {
336 EFSYS_KMEM_ALLOC(enp->en_esip, size, dcfg);
342 if ((rc = siena_nvram_partn_read(enp, partn, 0,
343 (caddr_t)dcfg, SIENA_NVRAM_CHUNK)) != 0)
346 /* Verify the magic */
347 if (EFX_DWORD_FIELD(dcfg->magic, EFX_DWORD_0)
348 != SIENA_MC_DYNAMIC_CONFIG_MAGIC)
351 /* All future versions of the structure must be backwards compatible */
352 EFX_STATIC_ASSERT(SIENA_MC_DYNAMIC_CONFIG_VERSION == 0);
354 hdr_length = EFX_WORD_FIELD(dcfg->length, EFX_WORD_0);
355 nversions = EFX_DWORD_FIELD(dcfg->num_fw_version_items, EFX_DWORD_0);
356 vpd_offset = EFX_DWORD_FIELD(dcfg->dynamic_vpd_offset, EFX_DWORD_0);
357 vpd_length = EFX_DWORD_FIELD(dcfg->dynamic_vpd_length, EFX_DWORD_0);
359 /* Verify the hdr doesn't overflow the partn size */
360 if (hdr_length > size || vpd_offset > size || vpd_length > size ||
361 vpd_length + vpd_offset > size)
364 /* Verify the header has room for all it's versions */
365 if (hdr_length < SIENA_DYNAMIC_CFG_SIZE(0) ||
366 hdr_length < SIENA_DYNAMIC_CFG_SIZE(nversions))
370 * Read the remaining portion of the dcfg, either including
371 * the whole of VPD (there is no vpd length in this structure,
372 * so we have to parse each tag), or just the dcfg header itself
374 region = vpd ? vpd_offset + vpd_length : hdr_length;
375 if (region > SIENA_NVRAM_CHUNK) {
376 if ((rc = siena_nvram_partn_read(enp, partn, SIENA_NVRAM_CHUNK,
377 (caddr_t)dcfg + SIENA_NVRAM_CHUNK,
378 region - SIENA_NVRAM_CHUNK)) != 0)
382 /* Verify checksum */
384 for (pos = 0; pos < hdr_length; pos++)
385 cksum += ((uint8_t *)dcfg)[pos];
392 EFSYS_PROBE(invalid4);
394 EFSYS_PROBE(invalid3);
396 EFSYS_PROBE(invalid2);
398 EFSYS_PROBE(invalid1);
401 * Construct a new "null" dcfg, with an empty version vector,
402 * and an empty VPD chunk trailing. This has the neat side effect
403 * of testing the exception paths in the write path.
405 EFX_POPULATE_DWORD_1(dcfg->magic,
406 EFX_DWORD_0, SIENA_MC_DYNAMIC_CONFIG_MAGIC);
407 EFX_POPULATE_WORD_1(dcfg->length, EFX_WORD_0, sizeof (*dcfg));
408 EFX_POPULATE_BYTE_1(dcfg->version, EFX_BYTE_0,
409 SIENA_MC_DYNAMIC_CONFIG_VERSION);
410 EFX_POPULATE_DWORD_1(dcfg->dynamic_vpd_offset,
411 EFX_DWORD_0, sizeof (*dcfg));
412 EFX_POPULATE_DWORD_1(dcfg->dynamic_vpd_length, EFX_DWORD_0, 0);
413 EFX_POPULATE_DWORD_1(dcfg->num_fw_version_items, EFX_DWORD_0, 0);
426 EFSYS_KMEM_FREE(enp->en_esip, size, dcfg);
433 EFSYS_PROBE1(fail1, efx_rc_t, rc);
438 __checkReturn efx_rc_t
439 siena_nvram_get_subtype(
442 __out uint32_t *subtypep)
445 EFX_MCDI_DECLARE_BUF(payload, MC_CMD_GET_BOARD_CFG_IN_LEN,
446 MC_CMD_GET_BOARD_CFG_OUT_LENMAX);
450 req.emr_cmd = MC_CMD_GET_BOARD_CFG;
451 req.emr_in_buf = payload;
452 req.emr_in_length = MC_CMD_GET_BOARD_CFG_IN_LEN;
453 req.emr_out_buf = payload;
454 req.emr_out_length = MC_CMD_GET_BOARD_CFG_OUT_LENMAX;
456 efx_mcdi_execute(enp, &req);
458 if (req.emr_rc != 0) {
463 if (req.emr_out_length_used < MC_CMD_GET_BOARD_CFG_OUT_LENMIN) {
468 if (req.emr_out_length_used <
469 MC_CMD_GET_BOARD_CFG_OUT_FW_SUBTYPE_LIST_OFST +
470 (partn + 1) * sizeof (efx_word_t)) {
475 fw_list = MCDI_OUT2(req, efx_word_t,
476 GET_BOARD_CFG_OUT_FW_SUBTYPE_LIST);
477 *subtypep = EFX_WORD_FIELD(fw_list[partn], EFX_WORD_0);
486 EFSYS_PROBE1(fail1, efx_rc_t, rc);
491 __checkReturn efx_rc_t
492 siena_nvram_partn_get_version(
495 __out uint32_t *subtypep,
496 __out_ecount(4) uint16_t version[4])
498 siena_mc_dynamic_config_hdr_t *dcfg;
499 siena_parttbl_entry_t *entry;
504 if ((1 << partn) & ~enp->en_u.siena.enu_partn_mask) {
509 if ((rc = siena_nvram_get_subtype(enp, partn, subtypep)) != 0)
513 * Some partitions are accessible from both ports (for instance BOOTROM)
514 * Find the highest version reported by all dcfg structures on ports
515 * that have access to this partition.
517 version[0] = version[1] = version[2] = version[3] = 0;
518 for (i = 0; i < EFX_ARRAY_SIZE(siena_parttbl); i++) {
519 siena_mc_fw_version_t *verp;
524 entry = &siena_parttbl[i];
525 if (entry->partn != partn)
528 dcfg_partn = (entry->port == 1)
529 ? MC_CMD_NVRAM_TYPE_DYNAMIC_CFG_PORT0
530 : MC_CMD_NVRAM_TYPE_DYNAMIC_CFG_PORT1;
532 * Ingore missing partitions on port 2, assuming they're due
533 * to to running on a single port part.
535 if ((1 << dcfg_partn) & ~enp->en_u.siena.enu_partn_mask) {
536 if (entry->port == 2)
540 if ((rc = siena_nvram_get_dynamic_cfg(enp, dcfg_partn,
541 B_FALSE, &dcfg, &length)) != 0)
544 nitems = EFX_DWORD_FIELD(dcfg->num_fw_version_items,
546 if (nitems < entry->partn)
549 verp = &dcfg->fw_version[partn];
550 temp[0] = EFX_WORD_FIELD(verp->version_w, EFX_WORD_0);
551 temp[1] = EFX_WORD_FIELD(verp->version_x, EFX_WORD_0);
552 temp[2] = EFX_WORD_FIELD(verp->version_y, EFX_WORD_0);
553 temp[3] = EFX_WORD_FIELD(verp->version_z, EFX_WORD_0);
554 if (memcmp(version, temp, sizeof (temp)) < 0)
555 memcpy(version, temp, sizeof (temp));
558 EFSYS_KMEM_FREE(enp->en_esip, length, dcfg);
568 EFSYS_PROBE1(fail1, efx_rc_t, rc);
573 __checkReturn efx_rc_t
574 siena_nvram_partn_rw_start(
577 __out size_t *chunk_sizep)
581 if ((rc = siena_nvram_partn_lock(enp, partn)) != 0)
584 if (chunk_sizep != NULL)
585 *chunk_sizep = SIENA_NVRAM_CHUNK;
590 EFSYS_PROBE1(fail1, efx_rc_t, rc);
595 __checkReturn efx_rc_t
596 siena_nvram_partn_rw_finish(
599 __out_opt uint32_t *verify_resultp)
603 if ((rc = siena_nvram_partn_unlock(enp, partn, verify_resultp)) != 0)
609 EFSYS_PROBE1(fail1, efx_rc_t, rc);
614 __checkReturn efx_rc_t
615 siena_nvram_partn_set_version(
618 __in_ecount(4) uint16_t version[4])
620 efx_mcdi_iface_t *emip = &(enp->en_mcdi.em_emip);
621 siena_mc_dynamic_config_hdr_t *dcfg = NULL;
622 siena_mc_fw_version_t *fwverp;
625 unsigned int hdr_length;
626 unsigned int vpd_length;
627 unsigned int vpd_offset;
629 unsigned int required_hdr_length;
636 dcfg_partn = (emip->emi_port == 1)
637 ? MC_CMD_NVRAM_TYPE_DYNAMIC_CFG_PORT0
638 : MC_CMD_NVRAM_TYPE_DYNAMIC_CFG_PORT1;
640 if ((rc = siena_nvram_partn_size(enp, dcfg_partn, &dcfg_size)) != 0)
643 if ((rc = siena_nvram_partn_lock(enp, dcfg_partn)) != 0)
646 if ((rc = siena_nvram_get_dynamic_cfg(enp, dcfg_partn,
647 B_TRUE, &dcfg, &length)) != 0)
650 hdr_length = EFX_WORD_FIELD(dcfg->length, EFX_WORD_0);
651 nitems = EFX_DWORD_FIELD(dcfg->num_fw_version_items, EFX_DWORD_0);
652 vpd_length = EFX_DWORD_FIELD(dcfg->dynamic_vpd_length, EFX_DWORD_0);
653 vpd_offset = EFX_DWORD_FIELD(dcfg->dynamic_vpd_offset, EFX_DWORD_0);
656 * NOTE: This function will blatt any fields trailing the version
657 * vector, or the VPD chunk.
659 required_hdr_length = SIENA_DYNAMIC_CFG_SIZE(partn + 1);
660 if (required_hdr_length + vpd_length > length) {
665 if (vpd_offset < required_hdr_length) {
666 (void) memmove((caddr_t)dcfg + required_hdr_length,
667 (caddr_t)dcfg + vpd_offset, vpd_length);
668 vpd_offset = required_hdr_length;
669 EFX_POPULATE_DWORD_1(dcfg->dynamic_vpd_offset,
670 EFX_DWORD_0, vpd_offset);
673 if (hdr_length < required_hdr_length) {
674 (void) memset((caddr_t)dcfg + hdr_length, 0,
675 required_hdr_length - hdr_length);
676 hdr_length = required_hdr_length;
677 EFX_POPULATE_WORD_1(dcfg->length,
678 EFX_WORD_0, hdr_length);
681 /* Get the subtype to insert into the fw_subtype array */
682 if ((rc = siena_nvram_get_subtype(enp, partn, &subtype)) != 0)
685 /* Fill out the new version */
686 fwverp = &dcfg->fw_version[partn];
687 EFX_POPULATE_DWORD_1(fwverp->fw_subtype, EFX_DWORD_0, subtype);
688 EFX_POPULATE_WORD_1(fwverp->version_w, EFX_WORD_0, version[0]);
689 EFX_POPULATE_WORD_1(fwverp->version_x, EFX_WORD_0, version[1]);
690 EFX_POPULATE_WORD_1(fwverp->version_y, EFX_WORD_0, version[2]);
691 EFX_POPULATE_WORD_1(fwverp->version_z, EFX_WORD_0, version[3]);
693 /* Update the version count */
694 if (nitems < partn + 1) {
696 EFX_POPULATE_DWORD_1(dcfg->num_fw_version_items,
697 EFX_DWORD_0, nitems);
700 /* Update the checksum */
702 for (pos = 0; pos < hdr_length; pos++)
703 cksum += ((uint8_t *)dcfg)[pos];
704 dcfg->csum.eb_u8[0] -= cksum;
706 /* Erase and write the new partition */
707 if ((rc = siena_nvram_partn_erase(enp, dcfg_partn, 0, dcfg_size)) != 0)
710 /* Write out the new structure to nvram */
711 if ((rc = siena_nvram_partn_write(enp, dcfg_partn, 0,
712 (caddr_t)dcfg, vpd_offset + vpd_length)) != 0)
715 EFSYS_KMEM_FREE(enp->en_esip, length, dcfg);
717 siena_nvram_partn_unlock(enp, dcfg_partn, NULL);
730 EFSYS_KMEM_FREE(enp->en_esip, length, dcfg);
736 EFSYS_PROBE1(fail1, efx_rc_t, rc);
741 #endif /* EFSYS_OPT_NVRAM */
743 #endif /* EFSYS_OPT_SIENA */