]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Include/Guid/SystemNvDataGuid.h
Add additional comments for structure definition.
[mirror_edk2.git] / MdeModulePkg / Include / Guid / SystemNvDataGuid.h
1 /** @file
2 This file defines NvDataHob GUIDs for System Non Volatile HOB entries
3 in the HOB list and NV system hob entry structure.
4 It also defines NvDataFv GUID used as the signature of FTW working block header.
5
6 Copyright (c) 2006 - 2008, Intel Corporation
7 All rights reserved. This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
11
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
14
15 **/
16
17 #ifndef __SYSTEM_NV_DATA_GUID_H__
18 #define __SYSTEM_NV_DATA_GUID_H__
19
20 #define EFI_SYSTEM_NV_DATA_FV_GUID \
21 {0xfff12b8d, 0x7696, 0x4c8b, {0xa9, 0x85, 0x27, 0x47, 0x7, 0x5b, 0x4f, 0x50} }
22
23 #define EFI_SYSTEM_NV_DATA_HOB_GUID \
24 {0xd6e5092d, 0xc7b2, 0x4872, {0xaf, 0x66, 0xfd, 0xc0, 0xe6, 0xf9, 0x5e, 0x78} }
25
26 ///
27 /// Hob entry for NV data region
28 ///
29 typedef struct {
30 EFI_GUID SystemNvDataHobGuid; /// EFI_SYSTEM_NV_DATA_HOB_GUID
31 EFI_GUID SystemNvDataFvGuid; /// Guid specifies the NvData Fv for the specific purpose, such as FTW, Error Log.
32 EFI_LBA StartLba; /// The starting logical block index.
33 UINTN StartLbaOffset; /// Offset into the starting block at which to the start of NvData region.
34 EFI_LBA EndLba; /// The last logical block index.
35 UINTN EndLbaOffset; /// Offset into the last block at which to the end of Nvdata region.
36 UINT32 DataTypeSignature; /// NvData type in the specified NV range.
37 } NV_SYSTEM_DATA_GUID_TYPE;
38
39 extern EFI_GUID gEfiSystemNvDataHobGuid;
40
41 ///
42 /// NvDataFv GUID used as the signature of FTW working block header.
43 ///
44 extern EFI_GUID gEfiSystemNvDataFvGuid;
45
46 #endif