gpt_misc.h revision b3d38f5c620da89662deb1a08971c5025d6c1132
17c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg/* Copyright (c) 2013 The Chromium OS Authors. All rights reserved. 27c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * Use of this source code is governed by a BSD-style license that can be 37c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * found in the LICENSE file. 47c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg */ 57c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg 67c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg#ifndef VBOOT_REFERENCE_CGPT_MISC_H_ 77c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg#define VBOOT_REFERENCE_CGPT_MISC_H_ 87c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg 97c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg#include "vboot_api.h" 107c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg 117c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenbergenum { 127c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg GPT_SUCCESS = 0, 137c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg GPT_ERROR_NO_VALID_KERNEL, 147c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg GPT_ERROR_INVALID_HEADERS, 157c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg GPT_ERROR_INVALID_ENTRIES, 167c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg GPT_ERROR_INVALID_SECTOR_SIZE, 177c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg GPT_ERROR_INVALID_SECTOR_NUMBER, 187c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg GPT_ERROR_INVALID_UPDATE_TYPE, 197c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg GPT_ERROR_CRC_CORRUPTED, 207c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg GPT_ERROR_OUT_OF_REGION, 217c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg GPT_ERROR_START_LBA_OVERLAP, 227c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg GPT_ERROR_END_LBA_OVERLAP, 237c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg GPT_ERROR_DUP_GUID, 247c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg GPT_ERROR_INVALID_FLASH_GEOMETRY, 257c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg GPT_ERROR_NO_SUCH_ENTRY, 267c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg /* Number of errors */ 277c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg GPT_ERROR_COUNT 287c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg}; 297c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg 307c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg/* Bit masks for GptData.modified field. */ 317c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg#define GPT_MODIFIED_HEADER1 0x01 327c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg#define GPT_MODIFIED_HEADER2 0x02 337c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg#define GPT_MODIFIED_ENTRIES1 0x04 347c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg#define GPT_MODIFIED_ENTRIES2 0x08 357c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg 367c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg/* 377c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * Size of GptData.primary_entries and secondary_entries: 128 bytes/entry * 128 387c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * entries. 397c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg */ 407c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg#define TOTAL_ENTRIES_SIZE 16384 417c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg 427c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg/* 437c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * The 'update_type' of GptUpdateKernelEntry(). We expose TRY and BAD only 447c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * because those are what verified boot needs. For more precise control on GPT 457c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * attribute bits, please refer to gpt_internal.h. 467c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg */ 477c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenbergenum { 487c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg /* 497c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * System will be trying to boot the currently selected kernel 507c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * partition. Update its try count if necessary. 517c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg */ 527c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg GPT_UPDATE_ENTRY_TRY = 1, 537c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg /* 547c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * The currently selected kernel partition failed validation. Mark 557c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * entry as invalid. 567c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg */ 577c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg GPT_UPDATE_ENTRY_BAD = 2, 587c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg}; 597c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg 60b3d38f5c620da89662deb1a08971c5025d6c1132Dan Ehrenberg/* If this bit is 1, the GPT is stored in another from the streaming data */ 61b3d38f5c620da89662deb1a08971c5025d6c1132Dan Ehrenberg#define GPT_FLAG_EXTERNAL 0x1 626ee52d9a929d00e871e7316240b54f381146fbc6Nam T. Nguyen 636ee52d9a929d00e871e7316240b54f381146fbc6Nam T. Nguyen/* 646ee52d9a929d00e871e7316240b54f381146fbc6Nam T. Nguyen * A note about stored_on_device and gpt_drive_sectors: 656ee52d9a929d00e871e7316240b54f381146fbc6Nam T. Nguyen * 666ee52d9a929d00e871e7316240b54f381146fbc6Nam T. Nguyen * This code is used by both the "cgpt" utility and depthcharge/vboot. ATM, 676ee52d9a929d00e871e7316240b54f381146fbc6Nam T. Nguyen * depthcharge does not have logic to properly setup stored_on_device and 686ee52d9a929d00e871e7316240b54f381146fbc6Nam T. Nguyen * gpt_drive_sectors, but it does do a memset(gpt, 0, sizeof(GptData)). And so, 696ee52d9a929d00e871e7316240b54f381146fbc6Nam T. Nguyen * GPT_STORED_ON_DEVICE should be 0 to make stored_on_device compatible with 706ee52d9a929d00e871e7316240b54f381146fbc6Nam T. Nguyen * present behavior. At the same time, in vboot_kernel:LoadKernel(), and 716ee52d9a929d00e871e7316240b54f381146fbc6Nam T. Nguyen * cgpt_common:GptLoad(), we need to have simple shims to set gpt_drive_sectors 726ee52d9a929d00e871e7316240b54f381146fbc6Nam T. Nguyen * to drive_sectors. 736ee52d9a929d00e871e7316240b54f381146fbc6Nam T. Nguyen * 746ee52d9a929d00e871e7316240b54f381146fbc6Nam T. Nguyen * TODO(namnguyen): Remove those shims when the firmware can set these fields. 756ee52d9a929d00e871e7316240b54f381146fbc6Nam T. Nguyen */ 767c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenbergtypedef struct { 777c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg /* Fill in the following fields before calling GptInit() */ 787c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg /* GPT primary header, from sector 1 of disk (size: 512 bytes) */ 797c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg uint8_t *primary_header; 807c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg /* GPT secondary header, from last sector of disk (size: 512 bytes) */ 817c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg uint8_t *secondary_header; 827c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg /* Primary GPT table, follows primary header (size: 16 KB) */ 837c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg uint8_t *primary_entries; 847c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg /* Secondary GPT table, precedes secondary header (size: 16 KB) */ 857c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg uint8_t *secondary_entries; 867c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg /* Size of a LBA sector, in bytes */ 877c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg uint32_t sector_bytes; 886ee52d9a929d00e871e7316240b54f381146fbc6Nam T. Nguyen /* Size of drive (that the partitions are on) in LBA sectors */ 89b3d38f5c620da89662deb1a08971c5025d6c1132Dan Ehrenberg uint64_t streaming_drive_sectors; 906ee52d9a929d00e871e7316240b54f381146fbc6Nam T. Nguyen /* Size of the device that holds the GPT structures, 512-byte sectors */ 916ee52d9a929d00e871e7316240b54f381146fbc6Nam T. Nguyen uint64_t gpt_drive_sectors; 92b3d38f5c620da89662deb1a08971c5025d6c1132Dan Ehrenberg /* Flags */ 93b3d38f5c620da89662deb1a08971c5025d6c1132Dan Ehrenberg uint32_t flags; 947c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg 957c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg /* Outputs */ 967c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg /* Which inputs have been modified? GPT_MODIFIED_* */ 977c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg uint8_t modified; 987c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg /* 997c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * The current chromeos kernel index in partition table. -1 means not 1007c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * found on drive. Note that GPT partition numbers are traditionally 1017c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * 1-based, but we're using a zero-based index here. 1027c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg */ 1037c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg int current_kernel; 1047c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg 1057c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg /* Internal variables */ 1067c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg uint32_t valid_headers, valid_entries; 1077c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg int current_priority; 1087c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg} GptData; 1097c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg 1107c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg/** 1117c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * Initializes the GPT data structure's internal state. 1127c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * 1137c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * The following fields must be filled before calling this function: 1147c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * 1157c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * primary_header 1167c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * secondary_header 1177c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * primary_entries 1187c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * secondary_entries 1197c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * sector_bytes 1207c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * drive_sectors 1216ee52d9a929d00e871e7316240b54f381146fbc6Nam T. Nguyen * stored_on_device 1226ee52d9a929d00e871e7316240b54f381146fbc6Nam T. Nguyen * gpt_device_sectors 1237c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * 1247c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * On return the modified field may be set, if the GPT data has been modified 1257c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * and should be written to disk. 1267c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * 1277c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * Returns GPT_SUCCESS if successful, non-zero if error: 1287c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * GPT_ERROR_INVALID_HEADERS, both partition table headers are invalid, enters 1297c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * recovery mode, 1307c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * GPT_ERROR_INVALID_ENTRIES, both partition table entries are invalid, enters 1317c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * recovery mode, 1327c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * GPT_ERROR_INVALID_SECTOR_SIZE, size of a sector is not supported, 1337c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * GPT_ERROR_INVALID_SECTOR_NUMBER, number of sectors in drive is invalid (too 1347c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * small) */ 1357c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenbergint GptInit(GptData *gpt); 1367c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg 1377c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg/** 1387c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * Allocate and read GPT data from the drive. The sector_bytes and 1397c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * drive_sectors fields should be filled on input. The primary and secondary 1407c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * header and entries are filled on output. 1417c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * 1427c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * Returns 0 if successful, 1 if error. 1437c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg */ 1447c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenbergint AllocAndReadGptData(VbExDiskHandle_t disk_handle, GptData *gptdata); 1457c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg 1467c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg/** 1477c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg * Write any changes for the GPT data back to the drive, then free the buffers. 1487c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg */ 1497c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenbergint WriteAndFreeGptData(VbExDiskHandle_t disk_handle, GptData *gptdata); 1507c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg 1517c2beb08380410ca6847abdac23e11ded2d1b625Dan Ehrenberg#endif /* VBOOT_REFERENCE_CGPT_MISC_H_ */ 152