2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2009-2016 Solarflare Communications Inc.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are met:
10 * 1. Redistributions of source code must retain the above copyright notice,
11 * this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright notice,
13 * this list of conditions and the following disclaimer in the documentation
14 * and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
18 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
20 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
21 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
22 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
23 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
25 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
26 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 * The views and conclusions contained in the software and documentation are
29 * those of the authors and should not be interpreted as representing official
30 * policies, either expressed or implied, of the FreeBSD Project.
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
43 static const efx_nvram_ops_t __efx_nvram_siena_ops = {
45 siena_nvram_test, /* envo_test */
46 #endif /* EFSYS_OPT_DIAG */
47 siena_nvram_type_to_partn, /* envo_type_to_partn */
48 siena_nvram_partn_size, /* envo_partn_size */
49 siena_nvram_partn_rw_start, /* envo_partn_rw_start */
50 siena_nvram_partn_read, /* envo_partn_read */
51 siena_nvram_partn_read, /* envo_partn_read_backup */
52 siena_nvram_partn_erase, /* envo_partn_erase */
53 siena_nvram_partn_write, /* envo_partn_write */
54 siena_nvram_partn_rw_finish, /* envo_partn_rw_finish */
55 siena_nvram_partn_get_version, /* envo_partn_get_version */
56 siena_nvram_partn_set_version, /* envo_partn_set_version */
57 NULL, /* envo_partn_validate */
60 #endif /* EFSYS_OPT_SIENA */
62 #if EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD || EFSYS_OPT_MEDFORD2
64 static const efx_nvram_ops_t __efx_nvram_ef10_ops = {
66 ef10_nvram_test, /* envo_test */
67 #endif /* EFSYS_OPT_DIAG */
68 ef10_nvram_type_to_partn, /* envo_type_to_partn */
69 ef10_nvram_partn_size, /* envo_partn_size */
70 ef10_nvram_partn_rw_start, /* envo_partn_rw_start */
71 ef10_nvram_partn_read, /* envo_partn_read */
72 ef10_nvram_partn_read_backup, /* envo_partn_read_backup */
73 ef10_nvram_partn_erase, /* envo_partn_erase */
74 ef10_nvram_partn_write, /* envo_partn_write */
75 ef10_nvram_partn_rw_finish, /* envo_partn_rw_finish */
76 ef10_nvram_partn_get_version, /* envo_partn_get_version */
77 ef10_nvram_partn_set_version, /* envo_partn_set_version */
78 ef10_nvram_buffer_validate, /* envo_buffer_validate */
81 #endif /* EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD || EFSYS_OPT_MEDFORD2 */
83 __checkReturn efx_rc_t
87 const efx_nvram_ops_t *envop;
90 EFSYS_ASSERT3U(enp->en_magic, ==, EFX_NIC_MAGIC);
91 EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_PROBE);
92 EFSYS_ASSERT(!(enp->en_mod_flags & EFX_MOD_NVRAM));
94 switch (enp->en_family) {
96 case EFX_FAMILY_SIENA:
97 envop = &__efx_nvram_siena_ops;
99 #endif /* EFSYS_OPT_SIENA */
101 #if EFSYS_OPT_HUNTINGTON
102 case EFX_FAMILY_HUNTINGTON:
103 envop = &__efx_nvram_ef10_ops;
105 #endif /* EFSYS_OPT_HUNTINGTON */
107 #if EFSYS_OPT_MEDFORD
108 case EFX_FAMILY_MEDFORD:
109 envop = &__efx_nvram_ef10_ops;
111 #endif /* EFSYS_OPT_MEDFORD */
113 #if EFSYS_OPT_MEDFORD2
114 case EFX_FAMILY_MEDFORD2:
115 envop = &__efx_nvram_ef10_ops;
117 #endif /* EFSYS_OPT_MEDFORD2 */
125 enp->en_envop = envop;
126 enp->en_mod_flags |= EFX_MOD_NVRAM;
128 enp->en_nvram_partn_locked = EFX_NVRAM_PARTN_INVALID;
133 EFSYS_PROBE1(fail1, efx_rc_t, rc);
140 __checkReturn efx_rc_t
144 const efx_nvram_ops_t *envop = enp->en_envop;
147 EFSYS_ASSERT3U(enp->en_magic, ==, EFX_NIC_MAGIC);
148 EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_NVRAM);
150 if ((rc = envop->envo_test(enp)) != 0)
156 EFSYS_PROBE1(fail1, efx_rc_t, rc);
161 #endif /* EFSYS_OPT_DIAG */
163 __checkReturn efx_rc_t
166 __in efx_nvram_type_t type,
169 const efx_nvram_ops_t *envop = enp->en_envop;
173 EFSYS_ASSERT3U(enp->en_magic, ==, EFX_NIC_MAGIC);
174 EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_NVRAM);
176 if ((rc = envop->envo_type_to_partn(enp, type, &partn)) != 0)
179 if ((rc = envop->envo_partn_size(enp, partn, sizep)) != 0)
187 EFSYS_PROBE1(fail1, efx_rc_t, rc);
193 __checkReturn efx_rc_t
194 efx_nvram_get_version(
196 __in efx_nvram_type_t type,
197 __out uint32_t *subtypep,
198 __out_ecount(4) uint16_t version[4])
200 const efx_nvram_ops_t *envop = enp->en_envop;
204 EFSYS_ASSERT3U(enp->en_magic, ==, EFX_NIC_MAGIC);
205 EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_PROBE);
206 EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_NVRAM);
208 if ((rc = envop->envo_type_to_partn(enp, type, &partn)) != 0)
211 if ((rc = envop->envo_partn_get_version(enp, partn,
212 subtypep, version)) != 0)
220 EFSYS_PROBE1(fail1, efx_rc_t, rc);
225 __checkReturn efx_rc_t
228 __in efx_nvram_type_t type,
229 __out_opt size_t *chunk_sizep)
231 const efx_nvram_ops_t *envop = enp->en_envop;
235 EFSYS_ASSERT3U(enp->en_magic, ==, EFX_NIC_MAGIC);
236 EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_NVRAM);
238 if ((rc = envop->envo_type_to_partn(enp, type, &partn)) != 0)
241 EFSYS_ASSERT3U(enp->en_nvram_partn_locked, ==, EFX_NVRAM_PARTN_INVALID);
243 if ((rc = envop->envo_partn_rw_start(enp, partn, chunk_sizep)) != 0)
246 enp->en_nvram_partn_locked = partn;
253 EFSYS_PROBE1(fail1, efx_rc_t, rc);
258 __checkReturn efx_rc_t
259 efx_nvram_read_chunk(
261 __in efx_nvram_type_t type,
262 __in unsigned int offset,
263 __out_bcount(size) caddr_t data,
266 const efx_nvram_ops_t *envop = enp->en_envop;
270 EFSYS_ASSERT3U(enp->en_magic, ==, EFX_NIC_MAGIC);
271 EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_NVRAM);
273 if ((rc = envop->envo_type_to_partn(enp, type, &partn)) != 0)
276 EFSYS_ASSERT3U(enp->en_nvram_partn_locked, ==, partn);
278 if ((rc = envop->envo_partn_read(enp, partn, offset, data, size)) != 0)
286 EFSYS_PROBE1(fail1, efx_rc_t, rc);
292 * Read from the backup (writeable) store of an A/B partition.
293 * For non A/B partitions, there is only a single store, and so this
294 * function has the same behaviour as efx_nvram_read_chunk().
296 __checkReturn efx_rc_t
297 efx_nvram_read_backup(
299 __in efx_nvram_type_t type,
300 __in unsigned int offset,
301 __out_bcount(size) caddr_t data,
304 const efx_nvram_ops_t *envop = enp->en_envop;
308 EFSYS_ASSERT3U(enp->en_magic, ==, EFX_NIC_MAGIC);
309 EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_NVRAM);
311 if ((rc = envop->envo_type_to_partn(enp, type, &partn)) != 0)
314 EFSYS_ASSERT3U(enp->en_nvram_partn_locked, ==, partn);
316 if ((rc = envop->envo_partn_read_backup(enp, partn, offset,
325 EFSYS_PROBE1(fail1, efx_rc_t, rc);
330 __checkReturn efx_rc_t
333 __in efx_nvram_type_t type)
335 const efx_nvram_ops_t *envop = enp->en_envop;
336 unsigned int offset = 0;
341 EFSYS_ASSERT3U(enp->en_magic, ==, EFX_NIC_MAGIC);
342 EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_NVRAM);
344 if ((rc = envop->envo_type_to_partn(enp, type, &partn)) != 0)
347 EFSYS_ASSERT3U(enp->en_nvram_partn_locked, ==, partn);
349 if ((rc = envop->envo_partn_size(enp, partn, &size)) != 0)
352 if ((rc = envop->envo_partn_erase(enp, partn, offset, size)) != 0)
362 EFSYS_PROBE1(fail1, efx_rc_t, rc);
367 __checkReturn efx_rc_t
368 efx_nvram_write_chunk(
370 __in efx_nvram_type_t type,
371 __in unsigned int offset,
372 __in_bcount(size) caddr_t data,
375 const efx_nvram_ops_t *envop = enp->en_envop;
379 EFSYS_ASSERT3U(enp->en_magic, ==, EFX_NIC_MAGIC);
380 EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_NVRAM);
382 if ((rc = envop->envo_type_to_partn(enp, type, &partn)) != 0)
385 EFSYS_ASSERT3U(enp->en_nvram_partn_locked, ==, partn);
387 if ((rc = envop->envo_partn_write(enp, partn, offset, data, size)) != 0)
395 EFSYS_PROBE1(fail1, efx_rc_t, rc);
400 __checkReturn efx_rc_t
403 __in efx_nvram_type_t type,
404 __out_opt uint32_t *verify_resultp)
406 const efx_nvram_ops_t *envop = enp->en_envop;
408 uint32_t verify_result = 0;
411 EFSYS_ASSERT3U(enp->en_magic, ==, EFX_NIC_MAGIC);
412 EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_NVRAM);
414 if ((rc = envop->envo_type_to_partn(enp, type, &partn)) != 0)
417 EFSYS_ASSERT3U(enp->en_nvram_partn_locked, ==, partn);
419 if ((rc = envop->envo_partn_rw_finish(enp, partn, &verify_result)) != 0)
422 enp->en_nvram_partn_locked = EFX_NVRAM_PARTN_INVALID;
424 if (verify_resultp != NULL)
425 *verify_resultp = verify_result;
431 enp->en_nvram_partn_locked = EFX_NVRAM_PARTN_INVALID;
434 EFSYS_PROBE1(fail1, efx_rc_t, rc);
436 /* Always report verification result */
437 if (verify_resultp != NULL)
438 *verify_resultp = verify_result;
443 __checkReturn efx_rc_t
444 efx_nvram_set_version(
446 __in efx_nvram_type_t type,
447 __in_ecount(4) uint16_t version[4])
449 const efx_nvram_ops_t *envop = enp->en_envop;
453 EFSYS_ASSERT3U(enp->en_magic, ==, EFX_NIC_MAGIC);
454 EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_PROBE);
455 EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_NVRAM);
457 if ((rc = envop->envo_type_to_partn(enp, type, &partn)) != 0)
461 * The Siena implementation of envo_set_version() will attempt to
462 * acquire the NVRAM_UPDATE lock for the DYNAMIC_CONFIG partition.
463 * Therefore, you can't have already acquired the NVRAM_UPDATE lock.
465 EFSYS_ASSERT3U(enp->en_nvram_partn_locked, ==, EFX_NVRAM_PARTN_INVALID);
467 if ((rc = envop->envo_partn_set_version(enp, partn, version)) != 0)
475 EFSYS_PROBE1(fail1, efx_rc_t, rc);
480 /* Validate buffer contents (before writing to flash) */
481 __checkReturn efx_rc_t
484 __in efx_nvram_type_t type,
485 __in_bcount(partn_size) caddr_t partn_data,
486 __in size_t partn_size)
488 const efx_nvram_ops_t *envop = enp->en_envop;
492 EFSYS_ASSERT3U(enp->en_magic, ==, EFX_NIC_MAGIC);
493 EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_PROBE);
494 EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_NVRAM);
496 if ((rc = envop->envo_type_to_partn(enp, type, &partn)) != 0)
499 if (envop->envo_buffer_validate != NULL) {
500 if ((rc = envop->envo_buffer_validate(partn,
501 partn_data, partn_size)) != 0)
510 EFSYS_PROBE1(fail1, efx_rc_t, rc);
520 EFSYS_ASSERT3U(enp->en_magic, ==, EFX_NIC_MAGIC);
521 EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_PROBE);
522 EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_NVRAM);
524 EFSYS_ASSERT3U(enp->en_nvram_partn_locked, ==, EFX_NVRAM_PARTN_INVALID);
526 enp->en_envop = NULL;
527 enp->en_mod_flags &= ~EFX_MOD_NVRAM;
530 #endif /* EFSYS_OPT_NVRAM */
532 #if EFSYS_OPT_NVRAM || EFSYS_OPT_VPD
535 * Internal MCDI request handling
538 __checkReturn efx_rc_t
539 efx_mcdi_nvram_partitions(
541 __out_bcount(size) caddr_t data,
543 __out unsigned int *npartnp)
546 EFX_MCDI_DECLARE_BUF(payload, MC_CMD_NVRAM_PARTITIONS_IN_LEN,
547 MC_CMD_NVRAM_PARTITIONS_OUT_LENMAX);
551 req.emr_cmd = MC_CMD_NVRAM_PARTITIONS;
552 req.emr_in_buf = payload;
553 req.emr_in_length = MC_CMD_NVRAM_PARTITIONS_IN_LEN;
554 req.emr_out_buf = payload;
555 req.emr_out_length = MC_CMD_NVRAM_PARTITIONS_OUT_LENMAX;
557 efx_mcdi_execute(enp, &req);
559 if (req.emr_rc != 0) {
564 if (req.emr_out_length_used < MC_CMD_NVRAM_PARTITIONS_OUT_LENMIN) {
568 npartn = MCDI_OUT_DWORD(req, NVRAM_PARTITIONS_OUT_NUM_PARTITIONS);
570 if (req.emr_out_length_used < MC_CMD_NVRAM_PARTITIONS_OUT_LEN(npartn)) {
575 if (size < npartn * sizeof (uint32_t)) {
583 MCDI_OUT2(req, uint32_t, NVRAM_PARTITIONS_OUT_TYPE_ID),
584 (npartn * sizeof (uint32_t)));
593 EFSYS_PROBE1(fail1, efx_rc_t, rc);
598 __checkReturn efx_rc_t
599 efx_mcdi_nvram_metadata(
602 __out uint32_t *subtypep,
603 __out_ecount(4) uint16_t version[4],
604 __out_bcount_opt(size) char *descp,
608 EFX_MCDI_DECLARE_BUF(payload, MC_CMD_NVRAM_METADATA_IN_LEN,
609 MC_CMD_NVRAM_METADATA_OUT_LENMAX);
612 req.emr_cmd = MC_CMD_NVRAM_METADATA;
613 req.emr_in_buf = payload;
614 req.emr_in_length = MC_CMD_NVRAM_METADATA_IN_LEN;
615 req.emr_out_buf = payload;
616 req.emr_out_length = MC_CMD_NVRAM_METADATA_OUT_LENMAX;
618 MCDI_IN_SET_DWORD(req, NVRAM_METADATA_IN_TYPE, partn);
620 efx_mcdi_execute_quiet(enp, &req);
622 if (req.emr_rc != 0) {
627 if (req.emr_out_length_used < MC_CMD_NVRAM_METADATA_OUT_LENMIN) {
632 if (MCDI_OUT_DWORD_FIELD(req, NVRAM_METADATA_OUT_FLAGS,
633 NVRAM_METADATA_OUT_SUBTYPE_VALID)) {
634 *subtypep = MCDI_OUT_DWORD(req, NVRAM_METADATA_OUT_SUBTYPE);
639 if (MCDI_OUT_DWORD_FIELD(req, NVRAM_METADATA_OUT_FLAGS,
640 NVRAM_METADATA_OUT_VERSION_VALID)) {
641 version[0] = MCDI_OUT_WORD(req, NVRAM_METADATA_OUT_VERSION_W);
642 version[1] = MCDI_OUT_WORD(req, NVRAM_METADATA_OUT_VERSION_X);
643 version[2] = MCDI_OUT_WORD(req, NVRAM_METADATA_OUT_VERSION_Y);
644 version[3] = MCDI_OUT_WORD(req, NVRAM_METADATA_OUT_VERSION_Z);
646 version[0] = version[1] = version[2] = version[3] = 0;
649 if (MCDI_OUT_DWORD_FIELD(req, NVRAM_METADATA_OUT_FLAGS,
650 NVRAM_METADATA_OUT_DESCRIPTION_VALID)) {
651 /* Return optional descrition string */
652 if ((descp != NULL) && (size > 0)) {
656 desclen = (req.emr_out_length_used
657 - MC_CMD_NVRAM_METADATA_OUT_LEN(0));
659 EFSYS_ASSERT3U(desclen, <=,
660 MC_CMD_NVRAM_METADATA_OUT_DESCRIPTION_MAXNUM);
662 if (size < desclen) {
667 memcpy(descp, MCDI_OUT2(req, char,
668 NVRAM_METADATA_OUT_DESCRIPTION),
671 /* Ensure string is NUL terminated */
672 descp[desclen] = '\0';
683 EFSYS_PROBE1(fail1, efx_rc_t, rc);
688 __checkReturn efx_rc_t
692 __out_opt size_t *sizep,
693 __out_opt uint32_t *addressp,
694 __out_opt uint32_t *erase_sizep,
695 __out_opt uint32_t *write_sizep)
697 EFX_MCDI_DECLARE_BUF(payload, MC_CMD_NVRAM_INFO_IN_LEN,
698 MC_CMD_NVRAM_INFO_V2_OUT_LEN);
702 req.emr_cmd = MC_CMD_NVRAM_INFO;
703 req.emr_in_buf = payload;
704 req.emr_in_length = MC_CMD_NVRAM_INFO_IN_LEN;
705 req.emr_out_buf = payload;
706 req.emr_out_length = MC_CMD_NVRAM_INFO_V2_OUT_LEN;
708 MCDI_IN_SET_DWORD(req, NVRAM_INFO_IN_TYPE, partn);
710 efx_mcdi_execute_quiet(enp, &req);
712 if (req.emr_rc != 0) {
717 if (req.emr_out_length_used < MC_CMD_NVRAM_INFO_OUT_LEN) {
723 *sizep = MCDI_OUT_DWORD(req, NVRAM_INFO_OUT_SIZE);
726 *addressp = MCDI_OUT_DWORD(req, NVRAM_INFO_OUT_PHYSADDR);
729 *erase_sizep = MCDI_OUT_DWORD(req, NVRAM_INFO_OUT_ERASESIZE);
733 (req.emr_out_length_used <
734 MC_CMD_NVRAM_INFO_V2_OUT_LEN) ?
735 0 : MCDI_OUT_DWORD(req, NVRAM_INFO_V2_OUT_WRITESIZE);
743 EFSYS_PROBE1(fail1, efx_rc_t, rc);
749 * MC_CMD_NVRAM_UPDATE_START_V2 must be used to support firmware-verified
750 * NVRAM updates. Older firmware will ignore the flags field in the request.
752 __checkReturn efx_rc_t
753 efx_mcdi_nvram_update_start(
757 EFX_MCDI_DECLARE_BUF(payload, MC_CMD_NVRAM_UPDATE_START_V2_IN_LEN,
758 MC_CMD_NVRAM_UPDATE_START_OUT_LEN);
762 req.emr_cmd = MC_CMD_NVRAM_UPDATE_START;
763 req.emr_in_buf = payload;
764 req.emr_in_length = MC_CMD_NVRAM_UPDATE_START_V2_IN_LEN;
765 req.emr_out_buf = payload;
766 req.emr_out_length = MC_CMD_NVRAM_UPDATE_START_OUT_LEN;
768 MCDI_IN_SET_DWORD(req, NVRAM_UPDATE_START_V2_IN_TYPE, partn);
770 MCDI_IN_POPULATE_DWORD_1(req, NVRAM_UPDATE_START_V2_IN_FLAGS,
771 NVRAM_UPDATE_START_V2_IN_FLAG_REPORT_VERIFY_RESULT, 1);
773 efx_mcdi_execute(enp, &req);
775 if (req.emr_rc != 0) {
783 EFSYS_PROBE1(fail1, efx_rc_t, rc);
788 __checkReturn efx_rc_t
792 __in uint32_t offset,
793 __out_bcount(size) caddr_t data,
798 EFX_MCDI_DECLARE_BUF(payload, MC_CMD_NVRAM_READ_IN_V2_LEN,
799 MC_CMD_NVRAM_READ_OUT_LENMAX);
802 if (size > MC_CMD_NVRAM_READ_OUT_LENMAX) {
807 req.emr_cmd = MC_CMD_NVRAM_READ;
808 req.emr_in_buf = payload;
809 req.emr_in_length = MC_CMD_NVRAM_READ_IN_V2_LEN;
810 req.emr_out_buf = payload;
811 req.emr_out_length = MC_CMD_NVRAM_READ_OUT_LENMAX;
813 MCDI_IN_SET_DWORD(req, NVRAM_READ_IN_V2_TYPE, partn);
814 MCDI_IN_SET_DWORD(req, NVRAM_READ_IN_V2_OFFSET, offset);
815 MCDI_IN_SET_DWORD(req, NVRAM_READ_IN_V2_LENGTH, size);
816 MCDI_IN_SET_DWORD(req, NVRAM_READ_IN_V2_MODE, mode);
818 efx_mcdi_execute(enp, &req);
820 if (req.emr_rc != 0) {
825 if (req.emr_out_length_used < MC_CMD_NVRAM_READ_OUT_LEN(size)) {
831 MCDI_OUT2(req, uint8_t, NVRAM_READ_OUT_READ_BUFFER),
839 EFSYS_PROBE1(fail1, efx_rc_t, rc);
844 __checkReturn efx_rc_t
845 efx_mcdi_nvram_erase(
848 __in uint32_t offset,
852 EFX_MCDI_DECLARE_BUF(payload, MC_CMD_NVRAM_ERASE_IN_LEN,
853 MC_CMD_NVRAM_ERASE_OUT_LEN);
856 req.emr_cmd = MC_CMD_NVRAM_ERASE;
857 req.emr_in_buf = payload;
858 req.emr_in_length = MC_CMD_NVRAM_ERASE_IN_LEN;
859 req.emr_out_buf = payload;
860 req.emr_out_length = MC_CMD_NVRAM_ERASE_OUT_LEN;
862 MCDI_IN_SET_DWORD(req, NVRAM_ERASE_IN_TYPE, partn);
863 MCDI_IN_SET_DWORD(req, NVRAM_ERASE_IN_OFFSET, offset);
864 MCDI_IN_SET_DWORD(req, NVRAM_ERASE_IN_LENGTH, size);
866 efx_mcdi_execute(enp, &req);
868 if (req.emr_rc != 0) {
876 EFSYS_PROBE1(fail1, efx_rc_t, rc);
882 * The NVRAM_WRITE MCDI command is a V1 command and so is supported by both
883 * Sienna and EF10 based boards. However EF10 based boards support the use
884 * of this command with payloads up to the maximum MCDI V2 payload length.
886 __checkReturn efx_rc_t
887 efx_mcdi_nvram_write(
890 __in uint32_t offset,
891 __in_bcount(size) caddr_t data,
897 size_t max_data_size;
898 size_t payload_len = enp->en_nic_cfg.enc_mcdi_max_payload_length;
900 max_data_size = payload_len - MC_CMD_NVRAM_WRITE_IN_LEN(0);
901 EFSYS_ASSERT3U(payload_len, >, 0);
902 EFSYS_ASSERT3U(max_data_size, <, payload_len);
904 if (size > max_data_size) {
909 EFSYS_KMEM_ALLOC(enp->en_esip, payload_len, payload);
910 if (payload == NULL) {
915 (void) memset(payload, 0, payload_len);
916 req.emr_cmd = MC_CMD_NVRAM_WRITE;
917 req.emr_in_buf = payload;
918 req.emr_in_length = MC_CMD_NVRAM_WRITE_IN_LEN(size);
919 req.emr_out_buf = payload;
920 req.emr_out_length = MC_CMD_NVRAM_WRITE_OUT_LEN;
922 MCDI_IN_SET_DWORD(req, NVRAM_WRITE_IN_TYPE, partn);
923 MCDI_IN_SET_DWORD(req, NVRAM_WRITE_IN_OFFSET, offset);
924 MCDI_IN_SET_DWORD(req, NVRAM_WRITE_IN_LENGTH, size);
926 memcpy(MCDI_IN2(req, uint8_t, NVRAM_WRITE_IN_WRITE_BUFFER),
929 efx_mcdi_execute(enp, &req);
931 if (req.emr_rc != 0) {
936 EFSYS_KMEM_FREE(enp->en_esip, payload_len, payload);
942 EFSYS_KMEM_FREE(enp->en_esip, payload_len, payload);
946 EFSYS_PROBE1(fail1, efx_rc_t, rc);
953 * MC_CMD_NVRAM_UPDATE_FINISH_V2 must be used to support firmware-verified
954 * NVRAM updates. Older firmware will ignore the flags field in the request.
956 __checkReturn efx_rc_t
957 efx_mcdi_nvram_update_finish(
960 __in boolean_t reboot,
961 __out_opt uint32_t *verify_resultp)
963 const efx_nic_cfg_t *encp = &enp->en_nic_cfg;
965 EFX_MCDI_DECLARE_BUF(payload, MC_CMD_NVRAM_UPDATE_FINISH_V2_IN_LEN,
966 MC_CMD_NVRAM_UPDATE_FINISH_V2_OUT_LEN);
967 uint32_t verify_result = MC_CMD_NVRAM_VERIFY_RC_UNKNOWN;
970 req.emr_cmd = MC_CMD_NVRAM_UPDATE_FINISH;
971 req.emr_in_buf = payload;
972 req.emr_in_length = MC_CMD_NVRAM_UPDATE_FINISH_V2_IN_LEN;
973 req.emr_out_buf = payload;
974 req.emr_out_length = MC_CMD_NVRAM_UPDATE_FINISH_V2_OUT_LEN;
976 MCDI_IN_SET_DWORD(req, NVRAM_UPDATE_FINISH_V2_IN_TYPE, partn);
977 MCDI_IN_SET_DWORD(req, NVRAM_UPDATE_FINISH_V2_IN_REBOOT, reboot);
979 MCDI_IN_POPULATE_DWORD_1(req, NVRAM_UPDATE_FINISH_V2_IN_FLAGS,
980 NVRAM_UPDATE_FINISH_V2_IN_FLAG_REPORT_VERIFY_RESULT, 1);
982 efx_mcdi_execute(enp, &req);
984 if (req.emr_rc != 0) {
989 if (req.emr_out_length_used < MC_CMD_NVRAM_UPDATE_FINISH_V2_OUT_LEN) {
990 verify_result = MC_CMD_NVRAM_VERIFY_RC_UNKNOWN;
991 if (encp->enc_nvram_update_verify_result_supported) {
992 /* Result of update verification is missing */
998 MCDI_OUT_DWORD(req, NVRAM_UPDATE_FINISH_V2_OUT_RESULT_CODE);
1001 if ((encp->enc_nvram_update_verify_result_supported) &&
1002 (verify_result != MC_CMD_NVRAM_VERIFY_RC_SUCCESS)) {
1003 /* Update verification failed */
1008 if (verify_resultp != NULL)
1009 *verify_resultp = verify_result;
1018 EFSYS_PROBE1(fail1, efx_rc_t, rc);
1020 /* Always report verification result */
1021 if (verify_resultp != NULL)
1022 *verify_resultp = verify_result;
1029 __checkReturn efx_rc_t
1030 efx_mcdi_nvram_test(
1031 __in efx_nic_t *enp,
1032 __in uint32_t partn)
1035 EFX_MCDI_DECLARE_BUF(payload, MC_CMD_NVRAM_TEST_IN_LEN,
1036 MC_CMD_NVRAM_TEST_OUT_LEN);
1040 req.emr_cmd = MC_CMD_NVRAM_TEST;
1041 req.emr_in_buf = payload;
1042 req.emr_in_length = MC_CMD_NVRAM_TEST_IN_LEN;
1043 req.emr_out_buf = payload;
1044 req.emr_out_length = MC_CMD_NVRAM_TEST_OUT_LEN;
1046 MCDI_IN_SET_DWORD(req, NVRAM_TEST_IN_TYPE, partn);
1048 efx_mcdi_execute(enp, &req);
1050 if (req.emr_rc != 0) {
1055 if (req.emr_out_length_used < MC_CMD_NVRAM_TEST_OUT_LEN) {
1060 result = MCDI_OUT_DWORD(req, NVRAM_TEST_OUT_RESULT);
1061 if (result == MC_CMD_NVRAM_TEST_FAIL) {
1063 EFSYS_PROBE1(nvram_test_failure, int, partn);
1076 EFSYS_PROBE1(fail1, efx_rc_t, rc);
1081 #endif /* EFSYS_OPT_DIAG */
1084 #endif /* EFSYS_OPT_NVRAM || EFSYS_OPT_VPD */