]> git.proxmox.com Git - mirror_edk2.git/blobdiff - IntelFrameworkModulePkg/Library/GenericBdsLib/InternalBdsLib.h
IntelFrameworkModulePkg: Clean up source files
[mirror_edk2.git] / IntelFrameworkModulePkg / Library / GenericBdsLib / InternalBdsLib.h
index d5b5b3bd0208c5384dd73779562952f506f7a776..3ec9ba987cb3af328025fe9a99abaafcedd4a401 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   BDS library definition, include the file and data structure\r
 \r
-Copyright (c) 2004 - 2012, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -31,10 +31,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Protocol/LegacyBios.h>\r
 #include <Protocol/SimpleTextOut.h>\r
 #include <Protocol/SimpleNetwork.h>\r
-#include <Protocol/DevicePathToText.h>\r
 #include <Protocol/FirmwareVolume2.h>\r
 #include <Protocol/PciIo.h>\r
-#include <Protocol/AcpiS3Save.h>\r
 #include <Protocol/OEMBadging.h>\r
 #include <Protocol/GraphicsOutput.h>\r
 #include <Protocol/UgaDraw.h>\r
@@ -47,11 +45,11 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Guid/FileInfo.h>\r
 #include <Guid/GlobalVariable.h>\r
 #include <Guid/PcAnsi.h>\r
-#include <Guid/Performance.h>\r
 #include <Guid/BdsLibHii.h>\r
 #include <Guid/HdBootVariable.h>\r
 #include <Guid/LastEnumLang.h>\r
 #include <Guid/LegacyDevOrder.h>\r
+#include <Guid/StatusCodeDataTypeVariable.h>\r
 \r
 #include <Library/PrintLib.h>\r
 #include <Library/DebugLib.h>\r
@@ -72,6 +70,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Library/PcdLib.h>\r
 #include <Library/DxeServicesLib.h>\r
 #include <Library/ReportStatusCodeLib.h>\r
+#include <Library/BmpSupportLib.h>\r
 \r
 #if !defined (EFI_REMOVABLE_MEDIA_FILE_NAME)\r
     #if defined (MDE_CPU_EBC)\r
@@ -85,32 +84,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
     #endif\r
 #endif\r
 \r
-/**\r
-\r
-  Allocates a block of memory to store performance data.\r
-\r
-**/\r
-VOID\r
-AllocateMemoryForPerformanceData (\r
-  VOID\r
-  );\r
-\r
-/**\r
-\r
-  Writes performance data of booting into the allocated memory.\r
-  OS can process these records.\r
-\r
-  @param  Event                 The triggered event.\r
-  @param  Context               Context for this event.\r
-\r
-**/\r
-VOID\r
-EFIAPI\r
-WriteBootToOsPerformanceData (\r
-  IN EFI_EVENT  Event,\r
-  IN VOID       *Context\r
-  );\r
-\r
 /**\r
   Get the headers (dos, image, optional header) from an image\r
 \r
@@ -134,7 +107,7 @@ BdsLibGetImageHeader (
   );\r
 \r
 /**\r
-  This routine adjust the memory information for different memory type and \r
+  This routine adjust the memory information for different memory type and\r
   save them into the variables for next boot.\r
 **/\r
 VOID\r
@@ -152,34 +125,54 @@ BdsSetMemoryTypeInformationVariable (
   @retval FALSE                 The variable data is corrupted.\r
 \r
 **/\r
-BOOLEAN \r
+BOOLEAN\r
 ValidateOption (\r
   UINT8                     *Variable,\r
   UINTN                     VariableSize\r
   );\r
 \r
 /**\r
-  This function will create all handles associate with every device\r
-  path node. If the handle associate with one device path node can not\r
-  be created successfully, Dispatch service which load the missing drivers\r
-  is called basing on input parameter, since in some cases no driver \r
-  dependency is assumed exist, so may need not to call this service.\r
-\r
-  @param  DevicePathToConnect   The device path which will be connected, it can be\r
-                                a multi-instance device path\r
-  @param  NeedDispatch          Whether requires dispatch service during connection \r
-\r
-  @retval EFI_SUCCESS           All handles associate with every device path  node\r
-                                have been created\r
-  @retval EFI_OUT_OF_RESOURCES  There is no resource to create new handles\r
-  @retval EFI_NOT_FOUND         Create the handle associate with one device  path\r
-                                node failed\r
-\r
+  Set the variable and report the error through status code upon failure.\r
+\r
+  @param  VariableName           A Null-terminated string that is the name of the vendor's variable.\r
+                                 Each VariableName is unique for each VendorGuid. VariableName must\r
+                                 contain 1 or more characters. If VariableName is an empty string,\r
+                                 then EFI_INVALID_PARAMETER is returned.\r
+  @param  VendorGuid             A unique identifier for the vendor.\r
+  @param  Attributes             Attributes bitmask to set for the variable.\r
+  @param  DataSize               The size in bytes of the Data buffer. Unless the EFI_VARIABLE_APPEND_WRITE,\r
+                                 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS, or\r
+                                 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS attribute is set, a size of zero\r
+                                 causes the variable to be deleted. When the EFI_VARIABLE_APPEND_WRITE attribute is\r
+                                 set, then a SetVariable() call with a DataSize of zero will not cause any change to\r
+                                 the variable value (the timestamp associated with the variable may be updated however\r
+                                 even if no new data value is provided,see the description of the\r
+                                 EFI_VARIABLE_AUTHENTICATION_2 descriptor below. In this case the DataSize will not\r
+                                 be zero since the EFI_VARIABLE_AUTHENTICATION_2 descriptor will be populated).\r
+  @param  Data                   The contents for the variable.\r
+\r
+  @retval EFI_SUCCESS            The firmware has successfully stored the variable and its data as\r
+                                 defined by the Attributes.\r
+  @retval EFI_INVALID_PARAMETER  An invalid combination of attribute bits, name, and GUID was supplied, or the\r
+                                 DataSize exceeds the maximum allowed.\r
+  @retval EFI_INVALID_PARAMETER  VariableName is an empty string.\r
+  @retval EFI_OUT_OF_RESOURCES   Not enough storage is available to hold the variable and its data.\r
+  @retval EFI_DEVICE_ERROR       The variable could not be retrieved due to a hardware error.\r
+  @retval EFI_WRITE_PROTECTED    The variable in question is read-only.\r
+  @retval EFI_WRITE_PROTECTED    The variable in question cannot be deleted.\r
+  @retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS\r
+                                 or EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACESS being set, but the AuthInfo\r
+                                 does NOT pass the validation check carried out by the firmware.\r
+\r
+  @retval EFI_NOT_FOUND          The variable trying to be updated or deleted was not found.\r
 **/\r
 EFI_STATUS\r
-ConnectDevicePathInternal (\r
-  IN EFI_DEVICE_PATH_PROTOCOL  *DevicePathToConnect,\r
-  IN BOOLEAN                   NeedDispatch\r
+SetVariableAndReportStatusCodeOnError (\r
+  IN CHAR16     *VariableName,\r
+  IN EFI_GUID   *VendorGuid,\r
+  IN UINT32     Attributes,\r
+  IN UINTN      DataSize,\r
+  IN VOID       *Data\r
   );\r
 \r
 #endif // _BDS_LIB_H_\r