2 Include file matches things in PI for multiple module types.
4 Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials are licensed and made available under
6 the terms and conditions of the BSD License that accompanies this distribution.
7 The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php.
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13 @par Revision Reference:
14 These elements are defined in UEFI Platform Initialization Specification 1.2.
18 #ifndef __PI_MULTIPHASE_H__
19 #define __PI_MULTIPHASE_H__
21 FILE_LICENCE ( BSD3 );
23 #include <ipxe/efi/Pi/PiFirmwareVolume.h>
24 #include <ipxe/efi/Pi/PiFirmwareFile.h>
25 #include <ipxe/efi/Pi/PiBootMode.h>
26 #include <ipxe/efi/Pi/PiHob.h>
27 #include <ipxe/efi/Pi/PiDependency.h>
28 #include <ipxe/efi/Pi/PiStatusCode.h>
29 #include <ipxe/efi/Pi/PiS3BootScript.h>
32 Produces an error code in the range reserved for use by the Platform Initialization
33 Architecture Specification.
35 The supported 32-bit range is 0xA0000000-0xBFFFFFFF
36 The supported 64-bit range is 0xA000000000000000-0xBFFFFFFFFFFFFFFF
38 @param StatusCode The status code value to convert into a warning code.
39 StatusCode must be in the range 0x00000000..0x1FFFFFFF.
41 @return The value specified by StatusCode in the PI reserved range.
44 #define DXE_ERROR(StatusCode) (MAX_BIT | (MAX_BIT >> 2) | StatusCode)
47 /// If this value is returned by an EFI image, then the image should be unloaded.
49 #define EFI_REQUEST_UNLOAD_IMAGE DXE_ERROR (1)
52 /// If this value is returned by an API, it means the capability is not yet
53 /// installed/available/ready to use.
55 #define EFI_NOT_AVAILABLE_YET DXE_ERROR (2)
58 /// Success and warning codes reserved for use by PI.
59 /// Supported 32-bit range is 0x20000000-0x3fffffff.
60 /// Supported 64-bit range is 0x2000000000000000-0x3fffffffffffffff.
62 #define PI_ENCODE_WARNING(a) ((MAX_BIT >> 2) | (a))
65 /// Error codes reserved for use by PI.
66 /// Supported 32-bit range is 0xa0000000-0xbfffffff.
67 /// Supported 64-bit range is 0xa000000000000000-0xbfffffffffffffff.
69 #define PI_ENCODE_ERROR(a) (MAX_BIT | (MAX_BIT >> 2) | (a))
72 /// Return status codes defined in SMM CIS.
74 #define EFI_INTERRUPT_PENDING PI_ENCODE_ERROR (0)
76 #define EFI_WARN_INTERRUPT_SOURCE_PENDING PI_ENCODE_WARNING (0)
77 #define EFI_WARN_INTERRUPT_SOURCE_QUIESCED PI_ENCODE_WARNING (1)
80 /// Bitmask of values for Authentication Status.
81 /// Authentication Status is returned from EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL
82 /// and the EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI
84 /// xx00 Image was not signed.
85 /// xxx1 Platform security policy override. Assumes the same meaning as 0010 (the image was signed, the
86 /// signature was tested, and the signature passed authentication test).
87 /// 0010 Image was signed, the signature was tested, and the signature passed authentication test.
88 /// 0110 Image was signed and the signature was not tested.
89 /// 1010 Image was signed, the signature was tested, and the signature failed the authentication test.
92 #define EFI_AUTH_STATUS_PLATFORM_OVERRIDE 0x01
93 #define EFI_AUTH_STATUS_IMAGE_SIGNED 0x02
94 #define EFI_AUTH_STATUS_NOT_TESTED 0x04
95 #define EFI_AUTH_STATUS_TEST_FAILED 0x08
96 #define EFI_AUTH_STATUS_ALL 0x0f
100 /// SMRAM states and capabilities
102 #define EFI_SMRAM_OPEN 0x00000001
103 #define EFI_SMRAM_CLOSED 0x00000002
104 #define EFI_SMRAM_LOCKED 0x00000004
105 #define EFI_CACHEABLE 0x00000008
106 #define EFI_ALLOCATED 0x00000010
107 #define EFI_NEEDS_TESTING 0x00000020
108 #define EFI_NEEDS_ECC_INITIALIZATION 0x00000040
111 /// Structure describing a SMRAM region and its accessibility attributes.
115 /// Designates the physical address of the SMRAM in memory. This view of memory is
116 /// the same as seen by I/O-based agents, for example, but it may not be the address seen
117 /// by the processors.
119 EFI_PHYSICAL_ADDRESS PhysicalStart;
121 /// Designates the address of the SMRAM, as seen by software executing on the
122 /// processors. This address may or may not match PhysicalStart.
124 EFI_PHYSICAL_ADDRESS CpuStart;
126 /// Describes the number of bytes in the SMRAM region.
130 /// Describes the accessibility attributes of the SMRAM. These attributes include the
131 /// hardware state (e.g., Open/Closed/Locked), capability (e.g., cacheable), logical
132 /// allocation (e.g., allocated), and pre-use initialization (e.g., needs testing/ECC
136 } EFI_SMRAM_DESCRIPTOR;
149 /// The returned information associated with the requested TokenNumber. If
150 /// TokenNumber is 0, then PcdType is set to EFI_PCD_TYPE_8.
152 EFI_PCD_TYPE PcdType;
154 /// The size of the data in bytes associated with the TokenNumber specified. If
155 /// TokenNumber is 0, then PcdSize is set 0.
159 /// The null-terminated ASCII string associated with a given token. If the
160 /// TokenNumber specified was 0, then this field corresponds to the null-terminated
161 /// ASCII string associated with the token's namespace Guid. If NULL, there is no
162 /// name associated with this request.