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