VbNvStorage cleanup and comments

firmware/include/load_firmware_fw.h

 /* Copyright (c) 2010 The Chromium OS Authors. All rights reserved.
  * Use of this source code is governed by a BSD-style license that can be
  * found in the LICENSE file.
  *
  * High-level firmware API for loading and verifying rewritable firmware.
  * (Firmware Portion)
  */
 
 #ifndef VBOOT_REFERENCE_LOAD_FIRMWARE_FW_H_
 #define VBOOT_REFERENCE_LOAD_FIRMWARE_FW_H_
 
 #include "sysincludes.h"
+#include "vboot_nvstorage.h"
 
 /* Recommended size of kernel_sign_key_blob in bytes, for
  * implementations which must preallocate a transfer buffer between
  * boot phases */
 #define LOAD_FIRMWARE_KEY_BLOB_REC_SIZE 2104
 
 /* Return codes for LoadFirmware() and S3Resume(). */
 #define LOAD_FIRMWARE_SUCCESS 0   /* Success */
 #define LOAD_FIRMWARE_RECOVERY 1  /* Reboot to recovery mode */
 #define LOAD_FIRMWARE_REBOOT 2    /* Reboot to same mode as current boot */
@@ skipping 12 matching lines @@
   uint64_t verification_size_1;  /* Verification block 1 size in bytes */
   void *kernel_sign_key_blob;    /* Destination buffer for key to use
                                   * when loading kernel.  Pass this
                                   * data to LoadKernel() in
                                   * LoadKernelParams.header_sign_key_blob. */
   uint64_t kernel_sign_key_size; /* Size of kernel signing key blob
                                   * buffer, in bytes.  On output, this
                                   * will contain the actual key blob
                                   * size placed into the buffer. */
   uint64_t boot_flags;           /* Boot flags */
+  VbNvContext* nv_context;       /* Context for NV storage.  nv_context->raw
+                                  * must be filled before calling
+                                  * LoadFirmware().  On output, check
+                                  * nv_context->raw_changed to see if
+                                  * nv_context->raw has been modified and
+                                  * needs saving. */
 
   /* Outputs from LoadFirmware(); valid only if LoadFirmware() returns
    * LOAD_FIRMWARE_SUCCESS. */
   uint64_t firmware_index;       /* Firmware index to run. */
 
   /* Internal data for LoadFirmware() / UpdateFirmwareBodyHash(). */
   void* load_firmware_internal;
 
   /* Internal data for caller / GetFirmwareBody(). */
   void* caller_internal;
@@ skipping 31 matching lines @@
  * called inside GetFirmwareBody(). */
 void UpdateFirmwareBodyHash(LoadFirmwareParams* params,
                             uint8_t* data, uint64_t size);
 
 /* Handle S3 resume.
  *
  * Returns LOAD_FIRMWARE_SUCCESS if successful, error code on failure. */
 int S3Resume(void);
 
 #endif  /* VBOOT_REFERENCE_LOAD_FIRMWARE_FW_H_ */