1 /* SPDX-License-Identifier: BSD-3-Clause
3 * Copyright (c) 2009-2018 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 EFSYS_KMEM_ALLOC(enp->en_esip, size, scfg);
45 if ((rc = siena_nvram_partn_read(enp, partn, 0,
46 (caddr_t)scfg, SIENA_NVRAM_CHUNK)) != 0)
49 /* Verify the magic number */
50 if (EFX_DWORD_FIELD(scfg->magic, EFX_DWORD_0) !=
51 SIENA_MC_STATIC_CONFIG_MAGIC) {
56 /* All future versions of the structure must be backwards compatible */
57 EFX_STATIC_ASSERT(SIENA_MC_STATIC_CONFIG_VERSION == 0);
59 hdr_length = EFX_WORD_FIELD(scfg->length, EFX_WORD_0);
60 vpd_offset = EFX_DWORD_FIELD(scfg->static_vpd_offset, EFX_DWORD_0);
61 vpd_length = EFX_DWORD_FIELD(scfg->static_vpd_length, EFX_DWORD_0);
63 /* Verify the hdr doesn't overflow the sector size */
64 if (hdr_length > size || vpd_offset > size || vpd_length > size ||
65 vpd_length + vpd_offset > size) {
70 /* Read the remainder of scfg + static vpd */
71 region = vpd_offset + vpd_length;
72 if (region > SIENA_NVRAM_CHUNK) {
73 if ((rc = siena_nvram_partn_read(enp, partn, SIENA_NVRAM_CHUNK,
74 (caddr_t)scfg + SIENA_NVRAM_CHUNK,
75 region - SIENA_NVRAM_CHUNK)) != 0)
81 for (pos = 0; pos < hdr_length; pos++)
82 cksum += ((uint8_t *)scfg)[pos];
91 /* Copy the vpd data out */
92 EFSYS_KMEM_ALLOC(enp->en_esip, vpd_length, svpd);
97 memcpy(svpd, (caddr_t)scfg + vpd_offset, vpd_length);
100 EFSYS_KMEM_FREE(enp->en_esip, size, scfg);
120 EFSYS_KMEM_FREE(enp->en_esip, size, scfg);
125 EFSYS_PROBE1(fail1, efx_rc_t, rc);
130 __checkReturn efx_rc_t
134 efx_mcdi_iface_t *emip = &(enp->en_mcdi.em_emip);
140 EFSYS_ASSERT(enp->en_family == EFX_FAMILY_SIENA);
142 partn = (emip->emi_port == 1)
143 ? MC_CMD_NVRAM_TYPE_STATIC_CFG_PORT0
144 : MC_CMD_NVRAM_TYPE_STATIC_CFG_PORT1;
147 * We need the static VPD sector to present a unified static+dynamic
148 * VPD, that is, basically on every read, write, verify cycle. Since
149 * it should *never* change we can just cache it here.
151 if ((rc = siena_vpd_get_static(enp, partn, &svpd, &size)) != 0)
154 if (svpd != NULL && size > 0) {
155 if ((rc = efx_vpd_hunk_verify(svpd, size, NULL)) != 0)
159 enp->en_u.siena.enu_svpd = svpd;
160 enp->en_u.siena.enu_svpd_length = size;
167 EFSYS_KMEM_FREE(enp->en_esip, size, svpd);
169 EFSYS_PROBE1(fail1, efx_rc_t, rc);
174 __checkReturn efx_rc_t
179 efx_mcdi_iface_t *emip = &(enp->en_mcdi.em_emip);
183 EFSYS_ASSERT(enp->en_family == EFX_FAMILY_SIENA);
186 * This function returns the total size the user should allocate
187 * for all VPD operations. We've already cached the static vpd,
188 * so we just need to return an upper bound on the dynamic vpd.
189 * Since the dynamic_config structure can change under our feet,
190 * (as version numbers are inserted), just be safe and return the
191 * total size of the dynamic_config *sector*
193 partn = (emip->emi_port == 1)
194 ? MC_CMD_NVRAM_TYPE_DYNAMIC_CFG_PORT0
195 : MC_CMD_NVRAM_TYPE_DYNAMIC_CFG_PORT1;
197 if ((rc = siena_nvram_partn_size(enp, partn, sizep)) != 0)
203 EFSYS_PROBE1(fail1, efx_rc_t, rc);
208 __checkReturn efx_rc_t
211 __out_bcount(size) caddr_t data,
214 efx_mcdi_iface_t *emip = &(enp->en_mcdi.em_emip);
215 siena_mc_dynamic_config_hdr_t *dcfg = NULL;
216 unsigned int vpd_length;
217 unsigned int vpd_offset;
218 unsigned int dcfg_partn;
222 EFSYS_ASSERT(enp->en_family == EFX_FAMILY_SIENA);
224 dcfg_partn = (emip->emi_port == 1)
225 ? MC_CMD_NVRAM_TYPE_DYNAMIC_CFG_PORT0
226 : MC_CMD_NVRAM_TYPE_DYNAMIC_CFG_PORT1;
228 if ((rc = siena_nvram_get_dynamic_cfg(enp, dcfg_partn,
229 B_TRUE, &dcfg, &dcfg_size)) != 0)
232 vpd_length = EFX_DWORD_FIELD(dcfg->dynamic_vpd_length, EFX_DWORD_0);
233 vpd_offset = EFX_DWORD_FIELD(dcfg->dynamic_vpd_offset, EFX_DWORD_0);
235 if (vpd_length > size) {
236 rc = EFAULT; /* Invalid dcfg: header bigger than sector */
240 EFSYS_ASSERT3U(vpd_length, <=, size);
241 memcpy(data, (caddr_t)dcfg + vpd_offset, vpd_length);
243 /* Pad data with all-1s, consistent with update operations */
244 memset(data + vpd_length, 0xff, size - vpd_length);
246 EFSYS_KMEM_FREE(enp->en_esip, dcfg_size, dcfg);
253 EFSYS_KMEM_FREE(enp->en_esip, dcfg_size, dcfg);
255 EFSYS_PROBE1(fail1, efx_rc_t, rc);
260 __checkReturn efx_rc_t
263 __in_bcount(size) caddr_t data,
268 efx_vpd_keyword_t skey;
269 efx_vpd_keyword_t dkey;
275 EFSYS_ASSERT(enp->en_family == EFX_FAMILY_SIENA);
278 * Strictly you could take the view that dynamic vpd is optional.
279 * Instead, to conform more closely to the read/verify/reinit()
280 * paradigm, we require dynamic vpd. siena_vpd_reinit() will
281 * reinitialize it as required.
283 if ((rc = efx_vpd_hunk_verify(data, size, NULL)) != 0)
287 * Verify that there is no duplication between the static and
288 * dynamic cfg sectors.
290 if (enp->en_u.siena.enu_svpd_length == 0)
294 _NOTE(CONSTANTCONDITION)
296 if ((rc = efx_vpd_hunk_next(data, size, &dtag,
297 &dkey, NULL, NULL, &dcont)) != 0)
303 * Skip the RV keyword. It should be present in both the static
304 * and dynamic cfg sectors.
306 if (dtag == EFX_VPD_RO && dkey == EFX_VPD_KEYWORD('R', 'V'))
310 _NOTE(CONSTANTCONDITION)
312 if ((rc = efx_vpd_hunk_next(
313 enp->en_u.siena.enu_svpd,
314 enp->en_u.siena.enu_svpd_length, &stag, &skey,
315 NULL, NULL, &scont)) != 0)
320 if (stag == dtag && skey == dkey) {
337 EFSYS_PROBE1(fail1, efx_rc_t, rc);
342 __checkReturn efx_rc_t
345 __in_bcount(size) caddr_t data,
352 * Only create a PID if the dynamic cfg doesn't have one
354 if (enp->en_u.siena.enu_svpd_length == 0)
360 rc = efx_vpd_hunk_get(enp->en_u.siena.enu_svpd,
361 enp->en_u.siena.enu_svpd_length,
362 EFX_VPD_ID, 0, &offset, &length);
365 else if (rc == ENOENT)
371 if ((rc = efx_vpd_hunk_reinit(data, size, wantpid)) != 0)
379 EFSYS_PROBE1(fail1, efx_rc_t, rc);
384 __checkReturn efx_rc_t
387 __in_bcount(size) caddr_t data,
389 __inout efx_vpd_value_t *evvp)
395 EFSYS_ASSERT(enp->en_family == EFX_FAMILY_SIENA);
397 /* Attempt to satisfy the request from svpd first */
398 if (enp->en_u.siena.enu_svpd_length > 0) {
399 if ((rc = efx_vpd_hunk_get(enp->en_u.siena.enu_svpd,
400 enp->en_u.siena.enu_svpd_length, evvp->evv_tag,
401 evvp->evv_keyword, &offset, &length)) == 0) {
402 evvp->evv_length = length;
403 memcpy(evvp->evv_value,
404 enp->en_u.siena.enu_svpd + offset, length);
406 } else if (rc != ENOENT)
410 /* And then from the provided data buffer */
411 if ((rc = efx_vpd_hunk_get(data, size, evvp->evv_tag,
412 evvp->evv_keyword, &offset, &length)) != 0) {
419 evvp->evv_length = length;
420 memcpy(evvp->evv_value, data + offset, length);
427 EFSYS_PROBE1(fail1, efx_rc_t, rc);
432 __checkReturn efx_rc_t
435 __in_bcount(size) caddr_t data,
437 __in efx_vpd_value_t *evvp)
441 EFSYS_ASSERT(enp->en_family == EFX_FAMILY_SIENA);
443 /* If the provided (tag,keyword) exists in svpd, then it is readonly */
444 if (enp->en_u.siena.enu_svpd_length > 0) {
448 if ((rc = efx_vpd_hunk_get(enp->en_u.siena.enu_svpd,
449 enp->en_u.siena.enu_svpd_length, evvp->evv_tag,
450 evvp->evv_keyword, &offset, &length)) == 0) {
456 if ((rc = efx_vpd_hunk_set(data, size, evvp)) != 0)
464 EFSYS_PROBE1(fail1, efx_rc_t, rc);
469 __checkReturn efx_rc_t
472 __in_bcount(size) caddr_t data,
474 __out efx_vpd_value_t *evvp,
475 __inout unsigned int *contp)
477 _NOTE(ARGUNUSED(enp, data, size, evvp, contp))
482 __checkReturn efx_rc_t
485 __in_bcount(size) caddr_t data,
488 efx_mcdi_iface_t *emip = &(enp->en_mcdi.em_emip);
489 siena_mc_dynamic_config_hdr_t *dcfg = NULL;
490 unsigned int vpd_offset;
491 unsigned int dcfg_partn;
492 unsigned int hdr_length;
495 size_t partn_size, dcfg_size;
499 EFSYS_ASSERT(enp->en_family == EFX_FAMILY_SIENA);
501 /* Determine total length of all tags */
502 if ((rc = efx_vpd_hunk_length(data, size, &vpd_length)) != 0)
505 /* Lock dynamic config sector for write, and read structure only */
506 dcfg_partn = (emip->emi_port == 1)
507 ? MC_CMD_NVRAM_TYPE_DYNAMIC_CFG_PORT0
508 : MC_CMD_NVRAM_TYPE_DYNAMIC_CFG_PORT1;
510 if ((rc = siena_nvram_partn_size(enp, dcfg_partn, &partn_size)) != 0)
513 if ((rc = siena_nvram_partn_lock(enp, dcfg_partn)) != 0)
516 if ((rc = siena_nvram_get_dynamic_cfg(enp, dcfg_partn,
517 B_FALSE, &dcfg, &dcfg_size)) != 0)
520 hdr_length = EFX_WORD_FIELD(dcfg->length, EFX_WORD_0);
522 /* Allocated memory should have room for the new VPD */
523 if (hdr_length + vpd_length > dcfg_size) {
528 /* Copy in new vpd and update header */
529 vpd_offset = dcfg_size - vpd_length;
530 EFX_POPULATE_DWORD_1(dcfg->dynamic_vpd_offset, EFX_DWORD_0, vpd_offset);
531 memcpy((caddr_t)dcfg + vpd_offset, data, vpd_length);
532 EFX_POPULATE_DWORD_1(dcfg->dynamic_vpd_length, EFX_DWORD_0, vpd_length);
534 /* Update the checksum */
536 for (pos = 0; pos < hdr_length; pos++)
537 cksum += ((uint8_t *)dcfg)[pos];
538 dcfg->csum.eb_u8[0] -= cksum;
540 /* Erase and write the new sector */
541 if ((rc = siena_nvram_partn_erase(enp, dcfg_partn, 0, partn_size)) != 0)
544 /* Write out the new structure to nvram */
545 if ((rc = siena_nvram_partn_write(enp, dcfg_partn, 0, (caddr_t)dcfg,
546 vpd_offset + vpd_length)) != 0)
549 EFSYS_KMEM_FREE(enp->en_esip, dcfg_size, dcfg);
551 siena_nvram_partn_unlock(enp, dcfg_partn, NULL);
562 EFSYS_KMEM_FREE(enp->en_esip, dcfg_size, dcfg);
566 siena_nvram_partn_unlock(enp, dcfg_partn, NULL);
572 EFSYS_PROBE1(fail1, efx_rc_t, rc);
581 EFSYS_ASSERT(enp->en_family == EFX_FAMILY_SIENA);
583 if (enp->en_u.siena.enu_svpd_length > 0) {
584 EFSYS_KMEM_FREE(enp->en_esip, enp->en_u.siena.enu_svpd_length,
585 enp->en_u.siena.enu_svpd);
587 enp->en_u.siena.enu_svpd = NULL;
588 enp->en_u.siena.enu_svpd_length = 0;
592 #endif /* EFSYS_OPT_SIENA */
594 #endif /* EFSYS_OPT_VPD */