| /* Copyright 2013 The ChromiumOS Authors | |
| * Use of this source code is governed by a BSD-style license that can be | |
| * found in the LICENSE file. | |
| */ | |
| #ifndef VBOOT_REFERENCE_GPT_MISC_H_ | |
| #define VBOOT_REFERENCE_GPT_MISC_H_ | |
| #include "gpt.h" | |
| #include "../2lib/include/2sysincludes.h" | |
| #include "../2lib/include/2constants.h" | |
| #ifdef __cplusplus | |
| extern "C" { | |
| #endif /* __cplusplus */ | |
| enum { | |
| GPT_SUCCESS = 0, | |
| GPT_ERROR_NO_VALID_KERNEL, | |
| GPT_ERROR_INVALID_HEADERS, | |
| GPT_ERROR_INVALID_ENTRIES, | |
| GPT_ERROR_INVALID_SECTOR_SIZE, | |
| GPT_ERROR_INVALID_SECTOR_NUMBER, | |
| GPT_ERROR_INVALID_UPDATE_TYPE, | |
| GPT_ERROR_CRC_CORRUPTED, | |
| GPT_ERROR_OUT_OF_REGION, | |
| GPT_ERROR_START_LBA_OVERLAP, | |
| GPT_ERROR_END_LBA_OVERLAP, | |
| GPT_ERROR_DUP_GUID, | |
| GPT_ERROR_INVALID_FLASH_GEOMETRY, | |
| GPT_ERROR_NO_SUCH_ENTRY, | |
| /* Number of errors */ | |
| GPT_ERROR_COUNT | |
| }; | |
| /* Bit masks for GptData.modified field. */ | |
| #define GPT_MODIFIED_HEADER1 0x01 | |
| #define GPT_MODIFIED_HEADER2 0x02 | |
| #define GPT_MODIFIED_ENTRIES1 0x04 | |
| #define GPT_MODIFIED_ENTRIES2 0x08 | |
| /* | |
| * The 'update_type' of GptUpdateKernelEntry(). We expose TRY and BAD only | |
| * because those are what verified boot needs. For more precise control on GPT | |
| * attribute bits, please refer to gpt_internal.h. | |
| */ | |
| enum { | |
| /* | |
| * System will be trying to boot the currently selected kernel | |
| * partition. Update its try count if necessary. | |
| */ | |
| GPT_UPDATE_ENTRY_TRY = 1, | |
| /* | |
| * The currently selected kernel partition failed validation. Mark | |
| * entry as invalid. | |
| */ | |
| GPT_UPDATE_ENTRY_BAD = 2, | |
| /* | |
| * Used for fastboot mode. If kernel partition slot is marked active, | |
| * its GPT entry is marked with S1,P2,T0. | |
| */ | |
| GPT_UPDATE_ENTRY_ACTIVE = 3, | |
| /* | |
| * Used for fastboot mode. If kernel partition slot is marked invalid, | |
| * its GPT entry is marked with S0,P0,T0. | |
| */ | |
| GPT_UPDATE_ENTRY_INVALID = 4, | |
| }; | |
| /* | |
| * A note about stored_on_device and gpt_drive_sectors: | |
| * | |
| * This code is used by both the "cgpt" utility and depthcharge/vboot. ATM, | |
| * depthcharge does not have logic to properly setup stored_on_device and | |
| * gpt_drive_sectors, but it does do a memset(gpt, 0, sizeof(GptData)). And so, | |
| * GPT_STORED_ON_DEVICE should be 0 to make stored_on_device compatible with | |
| * present behavior. At the same time, in vb2api_load_kernel() and GptLoad(), | |
| * we need to have simple shims to set gpt_drive_sectors to drive_sectors. | |
| * | |
| * TODO(namnguyen): Remove those shims when the firmware can set these fields. | |
| */ | |
| typedef struct { | |
| /* Fill in the following fields before calling GptInit() */ | |
| /* GPT primary header, from sector 1 of disk (size: 512 bytes) */ | |
| uint8_t *primary_header; | |
| /* GPT secondary header, from last sector of disk (size: 512 bytes) */ | |
| uint8_t *secondary_header; | |
| /* Primary GPT table, follows primary header */ | |
| uint8_t *primary_entries; | |
| /* Secondary GPT table, precedes secondary header */ | |
| uint8_t *secondary_entries; | |
| /* Size of a LBA sector, in bytes */ | |
| uint32_t sector_bytes; | |
| /* Size of drive in LBA sectors */ | |
| uint64_t drive_sectors; | |
| /* Flags */ | |
| uint32_t flags; | |
| /* Outputs */ | |
| /* Which inputs have been modified? GPT_MODIFIED_* */ | |
| uint8_t modified; | |
| /* | |
| * The current chromeos kernel index in partition table. -1 means not | |
| * found on drive. Note that GPT partition numbers are traditionally | |
| * 1-based, but we're using a zero-based index here. | |
| */ | |
| int current_kernel; | |
| /* Internal variables */ | |
| uint8_t valid_headers, valid_entries, ignored; | |
| int current_priority; | |
| } GptData; | |
| /** | |
| * Allocate and read GPT data from the drive. The sector_bytes and | |
| * drive_sectors fields should be filled on input. The primary and secondary | |
| * header and entries are filled on output. | |
| * | |
| * Returns 0 if successful, 1 if error. | |
| */ | |
| int AllocAndReadGptData(vb2ex_disk_handle_t disk_handle, GptData *gptdata); | |
| /** | |
| * Write any changes for the GPT data back to the drive, then free the buffers. | |
| */ | |
| int WriteAndFreeGptData(vb2ex_disk_handle_t disk_handle, GptData *gptdata); | |
| /** | |
| * Return 1 if the entry is unused, 0 if it is used. | |
| */ | |
| int IsUnusedEntry(const GptEntry *e); | |
| /** | |
| * Return size(in lba) of a partition represented by given GPT entry. | |
| */ | |
| uint64_t GptGetEntrySizeLba(const GptEntry *e); | |
| /** | |
| * Return size(in bytes) of a partition represented by given GPT entry. | |
| */ | |
| uint64_t GptGetEntrySizeBytes(const GptData *gpt, const GptEntry *e); | |
| /** | |
| * Return true if the entry is a Android VBMETA partition, else false. | |
| */ | |
| bool IsAndroid(const GptEntry *e); | |
| /** | |
| * Return true if the entry is a ChromeOS kernel partition, else false. | |
| */ | |
| bool IsChromeOS(const GptEntry *e); | |
| /** | |
| * Return true if the entry is a ChromeOS or Android partition, | |
| * else false. | |
| */ | |
| bool IsBootableEntry(const GptEntry *e); | |
| /* Getters and setters for partition attribute fields. */ | |
| int GetEntryRequired(const GptEntry *e); | |
| int GetEntryLegacyBoot(const GptEntry *e); | |
| int GetEntrySuccessful(const GptEntry *e); | |
| int GetEntryPriority(const GptEntry *e); | |
| int GetEntryTries(const GptEntry *e); | |
| int GetEntryErrorCounter(const GptEntry *e); | |
| void SetEntryRequired(GptEntry *e, int required); | |
| void SetEntryLegacyBoot(GptEntry *e, int legacy_boot); | |
| void SetEntrySuccessful(GptEntry *e, int successful); | |
| void SetEntryPriority(GptEntry *e, int priority); | |
| void SetEntryTries(GptEntry *e, int tries); | |
| void SetEntryErrorCounter(GptEntry *e, int error_counter); | |
| /** | |
| * Called when the primary entries are modified and the CRCs need to be | |
| * recalculated and propagated to the secondary entries | |
| */ | |
| void GptModified(GptData *gpt); | |
| #ifdef __cplusplus | |
| } | |
| #endif /* __cplusplus */ | |
| #endif /* VBOOT_REFERENCE_GPT_MISC_H_ */ |