blob: 58ce83fa40716329eda3c7ff2ed451fa507dacf9 [file] [log] [blame]
/* Copyright (c) 2013 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.
#include "gpt.h"
#include "vboot_api.h"
enum {
/* Number of errors */
/* Bit masks for GptData.modified field. */
* 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.
* The currently selected kernel partition failed validation. Mark
* entry as invalid.
* Used for fastboot mode. If kernel partition slot is marked active,
* its GPT entry is marked with S1,P2,T0.
* Used for fastboot mode. If kernel partition slot is marked invalid,
* its GPT entry is marked with S0,P0,T0.
/* If this bit is 1, the GPT is stored in another from the streaming data */
* 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 vboot_kernel:LoadKernel(), and
* cgpt_common: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 (that the partitions are on) in LBA sectors */
uint64_t streaming_drive_sectors;
/* Size of the device that holds the GPT structures, 512-byte sectors */
uint64_t gpt_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;
* Initializes the GPT data structure's internal state.
* The following fields must be filled before calling this function:
* primary_header
* secondary_header
* primary_entries
* secondary_entries
* sector_bytes
* drive_sectors
* stored_on_device
* gpt_device_sectors
* On return the modified field may be set, if the GPT data has been modified
* and should be written to disk.
* Returns GPT_SUCCESS if successful, non-zero if error:
* GPT_ERROR_INVALID_HEADERS, both partition table headers are invalid, enters
* recovery mode,
* GPT_ERROR_INVALID_ENTRIES, both partition table entries are invalid, enters
* recovery mode,
* GPT_ERROR_INVALID_SECTOR_SIZE, size of a sector is not supported,
* GPT_ERROR_INVALID_SECTOR_NUMBER, number of sectors in drive is invalid (too
* small) */
int GptInit(GptData *gpt);
* Return the nth instance of parition entry matching the partition type guid
* from the gpt table. Instance value starts from 0. If the entry is not found,
* it returns NULL.
GptEntry *GptFindNthEntry(GptData *gpt, const Guid *guid, unsigned int n);
* 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(VbExDiskHandle_t disk_handle, GptData *gptdata);
* Write any changes for the GPT data back to the drive, then free the buffers.
int WriteAndFreeGptData(VbExDiskHandle_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.
size_t GptGetEntrySizeLba(const GptEntry *e);
* Return size(in bytes) of a partition represented by given GPT entry.
size_t GptGetEntrySizeBytes(const GptData *gpt, const GptEntry *e);
* Updates the kernel entry with the specified index, using the specified type
* of update (GPT_UPDATE_ENTRY_*).
* On return the modified field may be set, if the GPT data has been modified
* and should be written to disk.
* Returns GPT_SUCCESS if successful, else
* GPT_ERROR_INVALID_UPDATE_TYPE, invalid 'update_type' is given.
int GptUpdateKernelWithEntry(GptData *gpt, GptEntry *e, uint32_t update_type);
* Updates the kernel entry identified by current_kernel field. If
* current_kernel is not set it returns an error.
* Returns GPT_SUCCESS if successful, else
* GPT_ERROR_INVALID_UPDATE_TYPE, invalid 'update_type' is given.
int GptUpdateKernelEntry(GptData *gpt, uint32_t update_type);
/* Getters and setters for partition attribute fields. */
int GetEntryLegacyBoot(const GptEntry *e);
int GetEntrySuccessful(const GptEntry *e);
int GetEntryPriority(const GptEntry *e);
int GetEntryTries(const GptEntry *e);
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);