]> git.proxmox.com Git - mirror_edk2.git/blame - MdePkg/Include/Pi/PiHob.h
Fix doxygen issue:
[mirror_edk2.git] / MdePkg / Include / Pi / PiHob.h
CommitLineData
c311f86b 1/** @file\r
00edb218 2 HOB related definitions in PI.\r
959ccb23 3\r
00edb218
A
4 Copyright (c) 2006 - 2007, Intel Corporation \r
5 All rights reserved. This program and the accompanying materials \r
6 are licensed and made available under the terms and conditions of the BSD License \r
7 which accompanies this distribution. The full text of the license may be found at \r
8 http://opensource.org/licenses/bsd-license.php \r
959ccb23 9\r
00edb218
A
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
959ccb23 12\r
00edb218
A
13 @par Revision Reference:\r
14 Version 1.0.\r
959ccb23 15\r
16**/\r
17\r
18#ifndef __PI_HOB_H__\r
19#define __PI_HOB_H__\r
20\r
0b3cac32 21#include <ProcessorBind.h>\r
22#include <Pi/PiBootMode.h>\r
23#include <Uefi/UefiBaseType.h>\r
24#include <Uefi/UefiMultiPhase.h>\r
25\r
959ccb23 26//\r
27// HobType of EFI_HOB_GENERIC_HEADER.\r
28// \r
00edb218
A
29#define EFI_HOB_TYPE_HANDOFF 0x0001\r
30#define EFI_HOB_TYPE_MEMORY_ALLOCATION 0x0002\r
31#define EFI_HOB_TYPE_RESOURCE_DESCRIPTOR 0x0003\r
32#define EFI_HOB_TYPE_GUID_EXTENSION 0x0004\r
33#define EFI_HOB_TYPE_FV 0x0005\r
34#define EFI_HOB_TYPE_CPU 0x0006\r
35#define EFI_HOB_TYPE_MEMORY_POOL 0x0007\r
36#define EFI_HOB_TYPE_FV2 0x0009\r
37#define EFI_HOB_TYPE_LOAD_PEIM 0x000A\r
38#define EFI_HOB_TYPE_UNUSED 0xFFFE\r
39#define EFI_HOB_TYPE_END_OF_HOB_LIST 0xFFFF\r
959ccb23 40\r
dc53faa3 41///\r
42/// Describes the format and size of the data inside the HOB. \r
43/// All HOBs must contain this generic HOB header.\r
44/// \r
00edb218
A
45typedef struct {\r
46 UINT16 HobType;\r
47 UINT16 HobLength;\r
48 UINT32 Reserved;\r
959ccb23 49} EFI_HOB_GENERIC_HEADER;\r
50\r
51\r
dc53faa3 52///\r
53/// Value of version ofinEFI_HOB_HANDOFF_INFO_TABLE.\r
54/// \r
959ccb23 55#define EFI_HOB_HANDOFF_TABLE_VERSION 0x0009\r
dc53faa3 56\r
57///\r
58/// Contains general state information used by the HOB producer phase. \r
59/// This HOB must be the first one in the HOB list.\r
60/// \r
00edb218
A
61typedef struct {\r
62 EFI_HOB_GENERIC_HEADER Header;\r
63 UINT32 Version;\r
64 EFI_BOOT_MODE BootMode;\r
65 EFI_PHYSICAL_ADDRESS EfiMemoryTop;\r
66 EFI_PHYSICAL_ADDRESS EfiMemoryBottom;\r
67 EFI_PHYSICAL_ADDRESS EfiFreeMemoryTop;\r
68 EFI_PHYSICAL_ADDRESS EfiFreeMemoryBottom;\r
69 EFI_PHYSICAL_ADDRESS EfiEndOfHobList;\r
959ccb23 70} EFI_HOB_HANDOFF_INFO_TABLE;\r
71\r
dc53faa3 72/// EFI_HOB_MEMORY_ALLOCATION_HEADER describes the\r
73/// various attributes of the logical memory allocation. The type field will be used for\r
74/// subsequent inclusion in the UEFI memory map.\r
00edb218 75typedef struct {\r
dc53faa3 76 ///\r
77