diff options
Diffstat (limited to 'firmware/include/load_firmware_fw.h')
| -rw-r--r-- | firmware/include/load_firmware_fw.h | 86 |
1 files changed, 86 insertions, 0 deletions
diff --git a/firmware/include/load_firmware_fw.h b/firmware/include/load_firmware_fw.h new file mode 100644 index 00000000..8ba67cf7 --- /dev/null +++ b/firmware/include/load_firmware_fw.h @@ -0,0 +1,86 @@ +/* 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" + +/* 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() */ +#define LOAD_FIRMWARE_SUCCESS 0 /* Success */ +#define LOAD_FIRMWARE_RECOVERY 1 /* Reboot to recovery mode */ + +typedef struct LoadFirmwareParams { + /* Inputs to LoadFirmware() */ + void *firmware_root_key_blob; /* Key used to sign firmware header */ + void *verification_block_0; /* Key block + preamble for firmware 0 */ + void *verification_block_1; /* Key block + preamble for firmware 1 */ + uint64_t verification_size_0; /* Verification block 0 size in bytes */ + 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. */ + + /* 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; + +} LoadFirmwareParams; + + +/* Functions provided by PEI to LoadFirmware() */ + +/* Get the firmware body data for [firmware_index], which is either + * 0 (the first firmware image) or 1 (the second firmware image). + * + * This function must call UpdateFirmwareBodyHash() before returning, + * to update the secure hash for the firmware image. For best + * performance, the reader should call this function periodically + * during the read, so that updating the hash can be pipelined with + * the read. If the reader cannot update the hash during the read + * process, it should call UpdateFirmwareBodyHash() on the entire + * firmeware data after the read, before returning. + * + * Returns 0 if successful or non-zero if error. */ +int GetFirmwareBody(LoadFirmwareParams* params, uint64_t firmware_index); + + +/* Functions provided by verified boot library to PEI */ + +/* Attempts to load the rewritable firmware. + * + * Returns LOAD_FIRMWARE_SUCCESS if successful, error code on failure. */ +int LoadFirmware(LoadFirmwareParams* params); + + +/* Update the data hash for the current firmware image, extending it + * by [size] bytes stored in [*data]. This function must only be + * called inside GetFirmwareBody(). */ +void UpdateFirmwareBodyHash(LoadFirmwareParams* params, + uint8_t* data, uint64_t size); + + + + +#endif /* VBOOT_REFERENCE_LOAD_FIRMWARE_FW_H_ */ |