1 /* SPDX-License-Identifier: BSD-3-Clause
3 * Copyright(c) 2019-2021 Xilinx, Inc.
4 * Copyright(c) 2009-2019 Solarflare Communications Inc.
14 static __checkReturn efx_rc_t
18 __deref_out_bcount_opt(*sizep) caddr_t *svpdp,
21 siena_mc_static_config_hdr_t *scfg;
25 unsigned int vpd_offset;
26 unsigned int vpd_length;
27 unsigned int hdr_length;
32 EFSYS_ASSERT(partn == MC_CMD_NVRAM_TYPE_STATIC_CFG_PORT0 ||
33 partn == MC_CMD_NVRAM_TYPE_STATIC_CFG_PORT1);
35 /* Allocate sufficient memory for the entire static cfg area */
36 if ((rc = siena_nvram_partn_size(enp, partn, &size)) != 0)
39 if (size < SIENA_NVRAM_CHUNK) {
44 EFSYS_KMEM_ALLOC(enp->en_esip, size, scfg);
50 if ((rc = siena_nvram_partn_read(enp, partn, 0,
51 (caddr_t)scfg, SIENA_NVRAM_CHUNK)) != 0)
54 /* Verify the magic number */
55 if (EFX_DWORD_FIELD(scfg->magic, EFX_DWORD_0) !=
56 SIENA_MC_STATIC_CONFIG_MAGIC) {
61 /* All future versions of the structure must be backwards compatible */
62 EFX_STATIC_ASSERT(SIENA_MC_STATIC_CONFIG_VERSION == 0);
64 hdr_length = EFX_WORD_FIELD(scfg->length, EFX_WORD_0);
65 vpd_offset = EFX_DWORD_FIELD(scfg->static_vpd_offset, EFX_DWORD_0);
66 vpd_length = EFX_DWORD_FIELD(scfg->static_vpd_length, EFX_DWORD_0);
68 /* Verify the hdr doesn't overflow the sector size */
69 if (hdr_length > size || vpd_offset > size || vpd_length > size ||
70 vpd_length + vpd_offset > size) {
75 /* Read the remainder of scfg + static vpd */
76 region = vpd_offset + vpd_length;
77 if (region > SIENA_NVRAM_CHUNK) {
78 if ((rc = siena_nvram_partn_read(enp, partn, SIENA_NVRAM_CHUNK,
79 (caddr_t)scfg + SIENA_NVRAM_CHUNK,
80 region - SIENA_NVRAM_CHUNK)) != 0)
86 for (pos = 0; pos < hdr_length; pos++)
87 cksum += ((uint8_t *)scfg)[pos];
96 /* Copy the vpd data out */
97 EFSYS_KMEM_ALLOC(enp->en_esip, vpd_length, svpd);
102 memcpy(svpd, (caddr_t)scfg + vpd_offset, vpd_length);
105 EFSYS_KMEM_FREE(enp->en_esip, size, scfg);
125 EFSYS_KMEM_FREE(enp->en_esip, size, scfg);
132 EFSYS_PROBE1(fail1, efx_rc_t, rc);
137 __checkReturn efx_rc_t
141 efx_mcdi_iface_t *emip = &(enp->en_mcdi.em_emip);
147 EFSYS_ASSERT(enp->en_family == EFX_FAMILY_SIENA);
149 partn = (emip->emi_port == 1)
150 ? MC_CMD_NVRAM_TYPE_STATIC_CFG_PORT0
151 : MC_CMD_NVRAM_TYPE_STATIC_CFG_PORT1;
154 * We need the static VPD sector to present a unified static+dynamic
155 * VPD, that is, basically on every read, write, verify cycle. Since
156 * it should *never* change we can just cache it here.
158 if ((rc = siena_vpd_get_static(enp, partn, &svpd, &size)) != 0)
161 if (svpd != NULL && size > 0) {
162 if ((rc = efx_vpd_hunk_verify(svpd, size, NULL)) != 0)
166 enp->en_u.siena.enu_svpd = svpd;
167 enp->en_u.siena.enu_svpd_length = size;
174 EFSYS_KMEM_FREE(enp->en_esip, size, svpd);
176 EFSYS_PROBE1(fail1, efx_rc_t, rc);
181 __checkReturn efx_rc_t
186 efx_mcdi_iface_t *emip = &(enp->en_mcdi.em_emip);
190 EFSYS_ASSERT(enp->en_family == EFX_FAMILY_SIENA);
193 * This function returns the total size the user should allocate
194 * for all VPD operations. We've already cached the static vpd,
195 * so we just need to return an upper bound on the dynamic vpd.
196 * Since the dynamic_config structure can change under our feet,
197 * (as version numbers are inserted), just be safe and return the
198 * total size of the dynamic_config *sector*
200 partn = (emip->emi_port == 1)
201 ? MC_CMD_NVRAM_TYPE_DYNAMIC_CFG_PORT0
202 : MC_CMD_NVRAM_TYPE_DYNAMIC_CFG_PORT1;
204 if ((rc = siena_nvram_partn_size(enp, partn, sizep)) != 0)
210 EFSYS_PROBE1(fail1, efx_rc_t, rc);
215 __checkReturn efx_rc_t
218 __out_bcount(size) caddr_t data,
221 efx_mcdi_iface_t *emip = &(enp->en_mcdi.em_emip);
222 siena_mc_dynamic_config_hdr_t *dcfg = NULL;
223 unsigned int vpd_length;
224 unsigned int vpd_offset;
225 unsigned int dcfg_partn;
229 EFSYS_ASSERT(enp->en_family == EFX_FAMILY_SIENA);
231 dcfg_partn = (emip->emi_port == 1)
232 ? MC_CMD_NVRAM_TYPE_DYNAMIC_CFG_PORT0
233 : MC_CMD_NVRAM_TYPE_DYNAMIC_CFG_PORT1;
235 if ((rc = siena_nvram_get_dynamic_cfg(enp, dcfg_partn,
236 B_TRUE, &dcfg, &dcfg_size)) != 0)
239 vpd_length = EFX_DWORD_FIELD(dcfg->dynamic_vpd_length, EFX_DWORD_0);
240 vpd_offset = EFX_DWORD_FIELD(dcfg->dynamic_vpd_offset, EFX_DWORD_0);
242 if (vpd_length > size) {
243 rc = EFAULT; /* Invalid dcfg: header bigger than sector */
247 EFSYS_ASSERT3U(vpd_length, <=, size);
248 memcpy(data, (caddr_t)dcfg + vpd_offset, vpd_length);
250 /* Pad data with all-1s, consistent with update operations */
251 memset(data + vpd_length, 0xff, size - vpd_length);
253 EFSYS_KMEM_FREE(enp->en_esip, dcfg_size, dcfg);
260 EFSYS_KMEM_FREE(enp->en_esip, dcfg_size, dcfg);
262 EFSYS_PROBE1(fail1, efx_rc_t, rc);
267 __checkReturn efx_rc_t
270 __in_bcount(size) caddr_t data,
275 efx_vpd_keyword_t skey;
276 efx_vpd_keyword_t dkey;
282 EFSYS_ASSERT(enp->en_family == EFX_FAMILY_SIENA);
285 * Strictly you could take the view that dynamic vpd is optional.
286 * Instead, to conform more closely to the read/verify/reinit()
287 * paradigm, we require dynamic vpd. siena_vpd_reinit() will
288 * reinitialize it as required.
290 if ((rc = efx_vpd_hunk_verify(data, size, NULL)) != 0)
294 * Verify that there is no duplication between the static and
295 * dynamic cfg sectors.
297 if (enp->en_u.siena.enu_svpd_length == 0)
301 _NOTE(CONSTANTCONDITION)
303 if ((rc = efx_vpd_hunk_next(data, size, &dtag,
304 &dkey, NULL, NULL, &dcont)) != 0)
310 * Skip the RV keyword. It should be present in both the static
311 * and dynamic cfg sectors.
313 if (dtag == EFX_VPD_RO && dkey == EFX_VPD_KEYWORD('R', 'V'))
317 _NOTE(CONSTANTCONDITION)
319 if ((rc = efx_vpd_hunk_next(
320 enp->en_u.siena.enu_svpd,
321 enp->en_u.siena.enu_svpd_length, &stag, &skey,
322 NULL, NULL, &scont)) != 0)
327 if (stag == dtag && skey == dkey) {
344 EFSYS_PROBE1(fail1, efx_rc_t, rc);
349 __checkReturn efx_rc_t
352 __in_bcount(size) caddr_t data,
359 * Only create a PID if the dynamic cfg doesn't have one
361 if (enp->en_u.siena.enu_svpd_length == 0)
367 rc = efx_vpd_hunk_get(enp->en_u.siena.enu_svpd,
368 enp->en_u.siena.enu_svpd_length,
369 EFX_VPD_ID, 0, &offset, &length);
372 else if (rc == ENOENT)
378 if ((rc = efx_vpd_hunk_reinit(data, size, wantpid)) != 0)
386 EFSYS_PROBE1(fail1, efx_rc_t, rc);
391 __checkReturn efx_rc_t
394 __in_bcount(size) caddr_t data,
396 __inout efx_vpd_value_t *evvp)
402 EFSYS_ASSERT(enp->en_family == EFX_FAMILY_SIENA);
404 /* Attempt to satisfy the request from svpd first */
405 if (enp->en_u.siena.enu_svpd_length > 0) {
406 if ((rc = efx_vpd_hunk_get(enp->en_u.siena.enu_svpd,
407 enp->en_u.siena.enu_svpd_length, evvp->evv_tag,
408 evvp->evv_keyword, &offset, &length)) == 0) {
409 evvp->evv_length = length;
410 memcpy(evvp->evv_value,
411 enp->en_u.siena.enu_svpd + offset, length);
413 } else if (rc != ENOENT)
417 /* And then from the provided data buffer */
418 if ((rc = efx_vpd_hunk_get(data, size, evvp->evv_tag,
419 evvp->evv_keyword, &offset, &length)) != 0) {
426 evvp->evv_length = length;
427 memcpy(evvp->evv_value, data + offset, length);
434 EFSYS_PROBE1(fail1, efx_rc_t, rc);
439 __checkReturn efx_rc_t
442 __in_bcount(size) caddr_t data,
444 __in efx_vpd_value_t *evvp)
448 EFSYS_ASSERT(enp->en_family == EFX_FAMILY_SIENA);
450 /* If the provided (tag,keyword) exists in svpd, then it is readonly */
451 if (enp->en_u.siena.enu_svpd_length > 0) {
455 if ((rc = efx_vpd_hunk_get(enp->en_u.siena.enu_svpd,
456 enp->en_u.siena.enu_svpd_length, evvp->evv_tag,
457 evvp->evv_keyword, &offset, &length)) == 0) {
463 if ((rc = efx_vpd_hunk_set(data, size, evvp)) != 0)
471 EFSYS_PROBE1(fail1, efx_rc_t, rc);
476 __checkReturn efx_rc_t
479 __in_bcount(size) caddr_t data,
481 __out efx_vpd_value_t *evvp,
482 __inout unsigned int *contp)
484 _NOTE(ARGUNUSED(enp, data, size, evvp, contp))
489 __checkReturn efx_rc_t
492 __in_bcount(size) caddr_t data,
495 efx_mcdi_iface_t *emip = &(enp->en_mcdi.em_emip);
496 siena_mc_dynamic_config_hdr_t *dcfg = NULL;
497 unsigned int vpd_offset;
498 unsigned int dcfg_partn;
499 unsigned int hdr_length;
502 size_t partn_size, dcfg_size;
506 EFSYS_ASSERT(enp->en_family == EFX_FAMILY_SIENA);
508 /* Determine total length of all tags */
509 if ((rc = efx_vpd_hunk_length(data, size, &vpd_length)) != 0)
512 /* Lock dynamic config sector for write, and read structure only */
513 dcfg_partn = (emip->emi_port == 1)
514 ? MC_CMD_NVRAM_TYPE_DYNAMIC_CFG_PORT0
515 : MC_CMD_NVRAM_TYPE_DYNAMIC_CFG_PORT1;
517 if ((rc = siena_nvram_partn_size(enp, dcfg_partn, &partn_size)) != 0)
520 if ((rc = siena_nvram_partn_lock(enp, dcfg_partn)) != 0)
523 if ((rc = siena_nvram_get_dynamic_cfg(enp, dcfg_partn,
524 B_FALSE, &dcfg, &dcfg_size)) != 0)
527 hdr_length = EFX_WORD_FIELD(dcfg->length, EFX_WORD_0);
529 /* Allocated memory should have room for the new VPD */
530 if (hdr_length + vpd_length > dcfg_size) {
535 /* Copy in new vpd and update header */
536 vpd_offset = dcfg_size - vpd_length;
537 EFX_POPULATE_DWORD_1(dcfg->dynamic_vpd_offset, EFX_DWORD_0, vpd_offset);
538 memcpy((caddr_t)dcfg + vpd_offset, data, vpd_length);
539 EFX_POPULATE_DWORD_1(dcfg->dynamic_vpd_length, EFX_DWORD_0, vpd_length);
541 /* Update the checksum */
543 for (pos = 0; pos < hdr_length; pos++)
544 cksum += ((uint8_t *)dcfg)[pos];
545 dcfg->csum.eb_u8[0] -= cksum;
547 /* Erase and write the new sector */
548 if ((rc = siena_nvram_partn_erase(enp, dcfg_partn, 0, partn_size)) != 0)
551 /* Write out the new structure to nvram */
552 if ((rc = siena_nvram_partn_write(enp, dcfg_partn, 0, (caddr_t)dcfg,
553 vpd_offset + vpd_length)) != 0)
556 EFSYS_KMEM_FREE(enp->en_esip, dcfg_size, dcfg);
558 siena_nvram_partn_unlock(enp, dcfg_partn, NULL);
569 EFSYS_KMEM_FREE(enp->en_esip, dcfg_size, dcfg);
573 siena_nvram_partn_unlock(enp, dcfg_partn, NULL);
579 EFSYS_PROBE1(fail1, efx_rc_t, rc);
588 EFSYS_ASSERT(enp->en_family == EFX_FAMILY_SIENA);
590 if (enp->en_u.siena.enu_svpd_length > 0) {
591 EFSYS_KMEM_FREE(enp->en_esip, enp->en_u.siena.enu_svpd_length,
592 enp->en_u.siena.enu_svpd);
594 enp->en_u.siena.enu_svpd = NULL;
595 enp->en_u.siena.enu_svpd_length = 0;
599 #endif /* EFSYS_OPT_SIENA */
601 #endif /* EFSYS_OPT_VPD */