]>
Commit | Line | Data |
---|---|---|
5c08e117 | 1 | /** @file\r |
2 | BDS library definition, include the file and data structure\r | |
3 | \r | |
53473721 | 4 | Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>\r |
180a5a35 | 5 | This program and the accompanying materials\r |
5c08e117 | 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 | |
9 | \r | |
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 | |
12 | \r | |
13 | **/\r | |
14 | \r | |
15 | #ifndef _INTERNAL_BDS_LIB_H_\r | |
16 | #define _INTERNAL_BDS_LIB_H_\r | |
17 | \r | |
79bc7a89 | 18 | #include <FrameworkDxe.h>\r |
5c08e117 | 19 | \r |
2828833e | 20 | #include <IndustryStandard/Pci.h>\r |
67d63227 | 21 | #include <IndustryStandard/PeImage.h>\r |
5c08e117 | 22 | \r |
23 | #include <Protocol/BlockIo.h>\r | |
24 | #include <Protocol/LoadedImage.h>\r | |
25 | #include <Protocol/Cpu.h>\r | |
26 | #include <Protocol/SimpleFileSystem.h>\r | |
ff482c56 | 27 | #include <Protocol/LoadFile.h>\r |
5c08e117 | 28 | #include <Protocol/DebugPort.h>\r |
29 | #include <Protocol/DevicePath.h>\r | |
30 | #include <Protocol/SimpleTextIn.h>\r | |
31 | #include <Protocol/LegacyBios.h>\r | |
32 | #include <Protocol/SimpleTextOut.h>\r | |
33 | #include <Protocol/SimpleNetwork.h>\r | |
5c08e117 | 34 | #include <Protocol/FirmwareVolume2.h>\r |
35 | #include <Protocol/PciIo.h>\r | |
5c08e117 | 36 | #include <Protocol/OEMBadging.h>\r |
5c08e117 | 37 | #include <Protocol/GraphicsOutput.h>\r |
38 | #include <Protocol/UgaDraw.h>\r | |
39 | #include <Protocol/HiiFont.h>\r | |
40 | #include <Protocol/HiiImage.h>\r | |
7389fdd0 | 41 | #include <Protocol/UsbIo.h>\r |
2df686c6 | 42 | #include <Protocol/BootLogo.h>\r |
5c08e117 | 43 | \r |
5c08e117 | 44 | #include <Guid/MemoryTypeInformation.h>\r |
45 | #include <Guid/FileInfo.h>\r | |
46 | #include <Guid/GlobalVariable.h>\r | |
47 | #include <Guid/PcAnsi.h>\r | |
e24fc103 LG |
48 | #include <Guid/BdsLibHii.h>\r |
49 | #include <Guid/HdBootVariable.h>\r | |
50 | #include <Guid/LastEnumLang.h>\r | |
16e5944a | 51 | #include <Guid/LegacyDevOrder.h>\r |
69fc8f08 | 52 | #include <Guid/StatusCodeDataTypeVariable.h>\r |
5c08e117 | 53 | \r |
54 | #include <Library/PrintLib.h>\r | |
55 | #include <Library/DebugLib.h>\r | |
56 | #include <Library/BaseMemoryLib.h>\r | |
57 | #include <Library/UefiBootServicesTableLib.h>\r | |
58 | #include <Library/UefiLib.h>\r | |
59 | #include <Library/MemoryAllocationLib.h>\r | |
60 | #include <Library/DxeServicesTableLib.h>\r | |
61 | #include <Library/UefiRuntimeServicesTableLib.h>\r | |
62 | #include <Library/HobLib.h>\r | |
63 | #include <Library/BaseLib.h>\r | |
64 | #include <Library/DevicePathLib.h>\r | |
65 | #include <Library/PerformanceLib.h>\r | |
66 | #include <Library/PcdLib.h>\r | |
5c08e117 | 67 | #include <Library/PeCoffGetEntryPointLib.h>\r |
68 | #include <Library/GenericBdsLib.h>\r | |
69 | #include <Library/TimerLib.h>\r | |
70 | #include <Library/PcdLib.h>\r | |
71 | #include <Library/DxeServicesLib.h>\r | |
79b7a6a1 | 72 | #include <Library/ReportStatusCodeLib.h>\r |
53473721 | 73 | #include <Library/BmpSupportLib.h>\r |
5c08e117 | 74 | \r |
a95f236b | 75 | #if !defined (EFI_REMOVABLE_MEDIA_FILE_NAME)\r |
76 | #if defined (MDE_CPU_EBC)\r | |
77 | //\r | |
78 | // Uefi specification only defines the default boot file name for IA32, X64\r | |
79 | // and IPF processor, so need define boot file name for EBC architecture here.\r | |
80 | //\r | |
81 | #define EFI_REMOVABLE_MEDIA_FILE_NAME L"\\EFI\\BOOT\\BOOTEBC.EFI"\r | |
82 | #else\r | |
83 | #error "Can not determine the default boot file name for unknown processor type!"\r | |
84 | #endif\r | |
85 | #endif\r | |
5c08e117 | 86 | \r |
67d63227 LG |
87 | /**\r |
88 | Get the headers (dos, image, optional header) from an image\r | |
89 | \r | |
90 | @param Device SimpleFileSystem device handle\r | |
91 | @param FileName File name for the image\r | |
92 | @param DosHeader Pointer to dos header\r | |
93 | @param Hdr The buffer in which to return the PE32, PE32+, or TE header.\r | |
94 | \r | |
95 | @retval EFI_SUCCESS Successfully get the machine type.\r | |
96 | @retval EFI_NOT_FOUND The file is not found.\r | |
97 | @retval EFI_LOAD_ERROR File is not a valid image file.\r | |
98 | \r | |
99 | **/\r | |
100 | EFI_STATUS\r | |
101 | EFIAPI\r | |
102 | BdsLibGetImageHeader (\r | |
103 | IN EFI_HANDLE Device,\r | |
104 | IN CHAR16 *FileName,\r | |
105 | OUT EFI_IMAGE_DOS_HEADER *DosHeader,\r | |
106 | OUT EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr\r | |
107 | );\r | |
108 | \r | |
7caf72a9 | 109 | /**\r |
0a6f4824 | 110 | This routine adjust the memory information for different memory type and\r |
7caf72a9 RN |
111 | save them into the variables for next boot.\r |
112 | **/\r | |
113 | VOID\r | |
114 | BdsSetMemoryTypeInformationVariable (\r | |
115 | VOID\r | |
116 | );\r | |
117 | \r | |
8c08a567 ED |
118 | /**\r |
119 | Validate the EFI Boot#### or Driver#### variable (VendorGuid/Name)\r | |
120 | \r | |
121 | @param Variable Boot#### variable data.\r | |
122 | @param VariableSize Returns the size of the EFI variable that was read\r | |
123 | \r | |
124 | @retval TRUE The variable data is correct.\r | |
125 | @retval FALSE The variable data is corrupted.\r | |
126 | \r | |
127 | **/\r | |
0a6f4824 | 128 | BOOLEAN\r |
8c08a567 ED |
129 | ValidateOption (\r |
130 | UINT8 *Variable,\r | |
131 | UINTN VariableSize\r | |
132 | );\r | |
133 | \r | |
69fc8f08 RN |
134 | /**\r |
135 | Set the variable and report the error through status code upon failure.\r | |
136 | \r | |
137 | @param VariableName A Null-terminated string that is the name of the vendor's variable.\r | |
138 | Each VariableName is unique for each VendorGuid. VariableName must\r | |
139 | contain 1 or more characters. If VariableName is an empty string,\r | |
140 | then EFI_INVALID_PARAMETER is returned.\r | |
141 | @param VendorGuid A unique identifier for the vendor.\r | |
142 | @param Attributes Attributes bitmask to set for the variable.\r | |
0a6f4824 LG |
143 | @param DataSize The size in bytes of the Data buffer. Unless the EFI_VARIABLE_APPEND_WRITE,\r |
144 | EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS, or\r | |
145 | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS attribute is set, a size of zero\r | |
146 | causes the variable to be deleted. When the EFI_VARIABLE_APPEND_WRITE attribute is\r | |
147 | set, then a SetVariable() call with a DataSize of zero will not cause any change to\r | |
148 | the variable value (the timestamp associated with the variable may be updated however\r | |
149 | even if no new data value is provided,see the description of the\r | |
150 | EFI_VARIABLE_AUTHENTICATION_2 descriptor below. In this case the DataSize will not\r | |
151 | be zero since the EFI_VARIABLE_AUTHENTICATION_2 descriptor will be populated).\r | |
69fc8f08 RN |
152 | @param Data The contents for the variable.\r |
153 | \r | |
154 | @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as\r | |
155 | defined by the Attributes.\r | |
156 | @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits, name, and GUID was supplied, or the\r | |
157 | DataSize exceeds the maximum allowed.\r | |
158 | @retval EFI_INVALID_PARAMETER VariableName is an empty string.\r | |
159 | @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.\r | |
160 | @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.\r | |
161 | @retval EFI_WRITE_PROTECTED The variable in question is read-only.\r | |
162 | @retval EFI_WRITE_PROTECTED The variable in question cannot be deleted.\r | |
0a6f4824 LG |
163 | @retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS\r |
164 | or EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACESS being set, but the AuthInfo\r | |
69fc8f08 RN |
165 | does NOT pass the validation check carried out by the firmware.\r |
166 | \r | |
167 | @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.\r | |
168 | **/\r | |
169 | EFI_STATUS\r | |
170 | SetVariableAndReportStatusCodeOnError (\r | |
171 | IN CHAR16 *VariableName,\r | |
172 | IN EFI_GUID *VendorGuid,\r | |
173 | IN UINT32 Attributes,\r | |
174 | IN UINTN DataSize,\r | |
175 | IN VOID *Data\r | |
176 | );\r | |
177 | \r | |
5c08e117 | 178 | #endif // _BDS_LIB_H_\r |