diff options
Diffstat (limited to 'firmware/include/vboot_struct.h')
-rw-r--r-- | firmware/include/vboot_struct.h | 151 |
1 files changed, 148 insertions, 3 deletions
diff --git a/firmware/include/vboot_struct.h b/firmware/include/vboot_struct.h index 1e988ee1..f8fd8c80 100644 --- a/firmware/include/vboot_struct.h +++ b/firmware/include/vboot_struct.h @@ -131,10 +131,117 @@ typedef struct VbKernelPreambleHeader { #define EXPECTED_VBKERNELPREAMBLEHEADER_SIZE 96 +/* Constants and sub-structures for VbSharedDataHeader */ + +/* Magic number for recognizing VbSharedDataHeader ("VbSD") */ +#define VB_SHARED_DATA_MAGIC 0x44536256 + /* Minimum and recommended size of shared_data_blob in bytes. */ #define VB_SHARED_DATA_MIN_SIZE 3072 #define VB_SHARED_DATA_REC_SIZE 16384 +/* Flags for VbSharedDataHeader */ +/* LoadFirmware() tried firmware B because of VbNvStorage firmware B tries */ +#define VBSD_FWB_TRIED 0x00000001 +/* LoadKernel() verified the good kernel keyblock using the kernel subkey from + * the firmware. If this flag is not present, it just used the hash of the + * kernel keyblock. */ +#define VBSD_KERNEL_KEY_VERIFIED 0x00000002 +/* LoadFirmware() was told the developer switch was on */ +#define VBSD_LF_DEV_SWITCH_ON 0x00000004 + +/* Result codes for VbSharedDataHeader.check_fw_a_result (and b_result) */ +#define VBSD_LF_CHECK_NOT_DONE 0 +#define VBSD_LF_CHECK_DEV_MISMATCH 1 +#define VBSD_LF_CHECK_REC_MISMATCH 2 +#define VBSD_LF_CHECK_VERIFY_KEYBLOCK 3 +#define VBSD_LF_CHECK_KEY_ROLLBACK 4 +#define VBSD_LF_CHECK_DATA_KEY_PARSE 5 +#define VBSD_LF_CHECK_VERIFY_PREAMBLE 6 +#define VBSD_LF_CHECK_FW_ROLLBACK 7 +#define VBSD_LF_CHECK_HEADER_VALID 8 +#define VBSD_LF_CHECK_GET_FW_BODY 9 +#define VBSD_LF_CHECK_HASH_WRONG_SIZE 10 +#define VBSD_LF_CHECK_VERIFY_BODY 11 +#define VBSD_LF_CHECK_VALID 12 + +/* Boot mode for VbSharedDataHeader.lk_boot_mode */ +#define VBSD_LK_BOOT_MODE_RECOVERY 0 +#define VBSD_LK_BOOT_MODE_NORMAL 1 +#define VBSD_LK_BOOT_MODE_DEVELOPER 2 + +/* Flags for VbSharedDataKernelPart.flags */ +#define VBSD_LKP_FLAG_KEY_BLOCK_VALID 0x01 + +/* Result codes for VbSharedDataKernelPart.check_result */ +#define VBSD_LKP_CHECK_NOT_DONE 0 +#define VBSD_LKP_CHECK_TOO_SMALL 1 +#define VBSD_LKP_CHECK_READ_START 2 +#define VBSD_LKP_CHECK_KEY_BLOCK_SIG 3 +#define VBSD_LKP_CHECK_KEY_BLOCK_HASH 4 +#define VBSD_LKP_CHECK_DEV_MISMATCH 5 +#define VBSD_LKP_CHECK_REC_MISMATCH 6 +#define VBSD_LKP_CHECK_KEY_ROLLBACK 7 +#define VBSD_LKP_CHECK_DATA_KEY_PARSE 8 +#define VBSD_LKP_CHECK_VERIFY_PREAMBLE 9 +#define VBSD_LKP_CHECK_KERNEL_ROLLBACK 10 +#define VBSD_LKP_CHECK_PREAMBLE_VALID 11 +#define VBSD_LKP_CHECK_BODY_ADDRESS 12 +#define VBSD_LKP_CHECK_BODY_OFFSET 13 +#define VBSD_LKP_CHECK_BODY_EXCEEDS_MEM 15 +#define VBSD_LKP_CHECK_BODY_EXCEEDS_PART 16 +#define VBSD_LKP_CHECK_READ_DATA 17 +#define VBSD_LKP_CHECK_VERIFY_DATA 18 +#define VBSD_LKP_CHECK_KERNEL_GOOD 19 + + +/* Information about a single kernel partition check in LoadKernel() */ +typedef struct VbSharedDataKernelPart { + uint64_t sector_start; /* Start sector of partition */ + uint64_t sector_count; /* Sector count of partition */ + uint32_t combined_version; /* Combined key+kernel version */ + uint8_t gpt_index; /* Index of partition in GPT */ + uint8_t check_result; /* Check result; see VBSD_LKP_CHECK_* */ + uint8_t flags; /* Flags (see VBSD_LKP_FLAG_* */ + uint8_t reserved0; /* Reserved for padding */ +} VbSharedDataKernelPart; + +/* Number of kernel partitions to track per call. Must be power of 2. */ +#define VBSD_MAX_KERNEL_PARTS 8 + +/* Flags for VbSharedDataKernelCall.flags */ +/* Error initializing TPM in recovery mode */ +#define VBSD_LK_FLAG_REC_TPM_INIT_ERROR 0x00000001 + +/* Result codes for VbSharedDataKernelCall.check_result */ +#define VBSD_LKC_CHECK_NOT_DONE 0 +#define VBSD_LKC_CHECK_DEV_SWITCH_MISMATCH 1 +#define VBSD_LKC_CHECK_GPT_READ_ERROR 2 +#define VBSD_LKC_CHECK_GPT_PARSE_ERROR 3 +#define VBSD_LKC_CHECK_GOOD_PARTITION 4 +#define VBSD_LKC_CHECK_INVALID_PARTITIONS 5 +#define VBSD_LKC_CHECK_NO_PARTITIONS 6 + +/* Information about a single call to LoadKernel() */ +typedef struct VbSharedDataKernelCall { + uint32_t boot_flags; /* Bottom 32 bits of flags passed in + * LoadKernelParams.boot_flags */ + uint32_t flags; /* Debug flags; see VBSD_LK_FLAG_* */ + uint64_t sector_count; /* Number of sectors on drive */ + uint32_t sector_size; /* Sector size in bytes */ + uint8_t check_result; /* Check result; see VBSD_LKC_CHECK_* */ + uint8_t boot_mode; /* Boot mode for LoadKernel(); see + * VBSD_LK_BOOT_MODE_* constants */ + uint8_t test_error_num; /* Test error number, if non-zero */ + uint8_t return_code; /* Return code from LoadKernel() */ + uint8_t kernel_parts_found; /* Number of kernel partitions found */ + uint8_t reserved0[7]; /* Reserved for padding */ + VbSharedDataKernelPart parts[VBSD_MAX_KERNEL_PARTS]; /* Data on kernels */ +} VbSharedDataKernelCall; + +/* Number of kernel calls to track. Must be power of 2. */ +#define VBSD_MAX_KERNEL_CALLS 4 + /* Data shared between LoadFirmware(), LoadKernel(), and OS. * * The boot process is: @@ -149,17 +256,55 @@ typedef struct VbKernelPreambleHeader { * For example, via ACPI or ATAGs. */ typedef struct VbSharedDataHeader { /* Fields present in version 1 */ + uint32_t magic; /* Magic number for struct + * (VB_SHARED_DATA_MAGIC) */ uint32_t struct_version; /* Version of this structure */ uint64_t struct_size; /* Size of this structure in bytes */ uint64_t data_size; /* Size of shared data buffer in bytes */ uint64_t data_used; /* Amount of shared data used so far */ + uint32_t flags; /* Flags */ + uint32_t reserved0; /* Reserved for padding */ VbPublicKey kernel_subkey; /* Kernel subkey, from firmware */ uint64_t kernel_subkey_data_offset; /* Offset of kernel subkey data from * start of this struct */ - uint64_t kernel_subkey_data_size; /* Offset of kernel subkey data */ - - uint64_t flags; /* Flags */ + uint64_t kernel_subkey_data_size; /* Size of kernel subkey data */ + + /* Timer values from VbGetTimer(). Unused values are set to 0. If a + * function is called mutiple times, these are the times from the + * most recent call. */ + uint64_t timer_load_firmware_start_enter; /* LoadFirmwareStart() - enter */ + uint64_t timer_load_firmware_start_exit; /* LoadFirmwareStart() - exit */ + uint64_t timer_load_firmware_enter; /* LoadFirmware() - enter */ + uint64_t timer_load_firmware_exit; /* LoadFirmware() - exit */ + uint64_t timer_load_kernel_enter; /* LoadKernel() - enter */ + uint64_t timer_load_kernel_exit; /* LoadKernel() - exit */ + + /* Information stored in TPM, as retrieved by firmware */ + uint32_t fw_version_tpm; /* Current firmware version in TPM */ + uint32_t kernel_version_tpm; /* Current kernel version in TPM */ + + /* Debugging information from LoadFirmware() */ + uint8_t check_fw_a_result; /* Result of checking RW firmware A */ + uint8_t check_fw_b_result; /* Result of checking RW firmware B */ + uint8_t firmware_index; /* Firmware index returned by + * LoadFirmware() or 0xFF if failure */ + uint8_t reserved1; /* Reserved for padding */ + uint32_t fw_version_tpm_start; /* Firmware TPM version at start of + * LoadFirmware() */ + uint32_t fw_version_lowest; /* Firmware lowest version found */ + + /* Debugging information from LoadKernel() */ + uint32_t lk_call_count; /* Number of times LoadKernel() called */ + VbSharedDataKernelCall lk_calls[VBSD_MAX_KERNEL_CALLS]; /* Info on calls */ + + /* Offset and size of supplemental kernel data. Reserve space for these + * fields now, so that future LoadKernel() versions can store information + * there without needing to shift down whatever data the original + * LoadFirmware() might have put immediately following its + * VbSharedDataHeader. */ + uint64_t kernel_supplemental_offset; + uint64_t kernel_supplemental_size; /* After read-only firmware which uses version 1 is released, any additional * fields must be added below, and the struct version must be increased. |