--- /dev/null
+/** @file\r
+ This file declares Read-only Variable Service PPI\r
+\r
+ Copyright (c) 2006, Intel Corporation \r
+ All rights reserved. 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
+ http://opensource.org/licenses/bsd-license.php \r
+\r
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
+\r
+ Module Name: ReadOnlyVariable.h\r
+\r
+ @par Revision Reference:\r
+ This PPI is defined in PEI CIS\r
+ Version 0.91.\r
+\r
+**/\r
+\r
+#ifndef __PEI_READ_ONLY_VARIABLE_PPI_H__\r
+#define __PEI_READ_ONLY_VARIABLE_PPI_H__\r
+\r
+#define EFI_PEI_READ_ONLY_VARIABLE_ACCESS_PPI_GUID \\r
+ { \\r
+ 0x3cdc90c6, 0x13fb, 0x4a75, {0x9e, 0x79, 0x59, 0xe9, 0xdd, 0x78, 0xb9, 0xfa } \\r
+ }\r
+\r
+typedef struct _EFI_PEI_READ_ONLY_VARIABLE_PPI EFI_PEI_READ_ONLY_VARIABLE_PPI;\r
+\r
+//\r
+// Variable attributes\r
+//\r
+#define EFI_VARIABLE_NON_VOLATILE 0x00000001\r
+#define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x00000002\r
+#define EFI_VARIABLE_RUNTIME_ACCESS 0x00000004\r
+#define EFI_VARIABLE_READ_ONLY 0x00000008\r
+\r
+/**\r
+ Get Variable value by Name and GUID pair\r
+\r
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+ @param VariableName A NULL-terminated Unicode string that is the name of the vendor's variable.\r
+ @param VendorGuid A unique identifier for the vendor.\r
+ @param Attributes If not NULL, a pointer to the memory location to return\r
+ the attributes bitmask for the variable.\r
+ @param DataSize On input, the size in bytes of the return Data buffer.\r
+ On output, the size of data returned in Data.\r
+ @param Data The buffer to return the contents of the variable.\r
+\r
+ @retval EFI_SUCCESS The function completed successfully.\r
+ @retval EFI_NOT_FOUND The variable was not found.\r
+ @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result.\r
+ @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
+ @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.\r
+\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_PEI_GET_VARIABLE) (\r
+ IN EFI_PEI_SERVICES **PeiServices,\r
+ IN CHAR16 *VariableName,\r
+ IN EFI_GUID *VendorGuid,\r
+ OUT UINT32 *Attributes OPTIONAL,\r
+ IN OUT UINTN *DataSize,\r
+ OUT VOID *Data\r
+ );\r
+\r
+/**\r
+ This function can be called multiple times to retrieve the VariableName \r
+ and VendorGuid of all variables currently available in the system. On each call \r
+ to GetNextVariableName() the previous results are passed into the interface, \r
+ and on output the interface returns the next variable name data. When the \r
+ entire variable list has been returned, the error EFI_NOT_FOUND is returned.\r
+\r
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+ @param VariableNameSize The size of the VariableName buffer.\r
+ @param VariableName On input, supplies the last VariableName that was\r
+ returned by GetNextVariableName(). On output, returns the Null-terminated\r
+ Unicode string of the current variable.\r
+ @param VendorGuid On input, supplies the last VendorGuid that was\r
+ returned by GetNextVariableName(). On output, returns the VendorGuid\r
+ of the current variable.\r
+\r
+ @retval EFI_SUCCESS The function completed successfully.\r
+ @retval EFI_NOT_FOUND The next variable was not found.\r
+ @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.\r
+ @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
+ @retval EFI_DEVICE_ERROR The variable name could not be retrieved due to a hardware error.\r
+\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_PEI_GET_NEXT_VARIABLE_NAME) (\r
+ IN EFI_PEI_SERVICES **PeiServices,\r
+ IN OUT UINTN *VariableNameSize,\r
+ IN OUT CHAR16 *VariableName,\r
+ IN OUT EFI_GUID *VendorGuid\r
+ );\r
+\r
+/**\r
+ @par Ppi Description:\r
+ This PPI provides a lightweight, read-only variant of the full EFI \r
+ variable services. \r
+\r
+ @param GetVariable\r
+ A service to ascertain a given variable name.\r
+\r
+ @param GetNextVariableName\r
+ A service to ascertain a variable based upon a given, known variable\r
+\r
+**/\r
+struct _EFI_PEI_READ_ONLY_VARIABLE_PPI {\r
+ EFI_PEI_GET_VARIABLE PeiGetVariable;\r
+ EFI_PEI_GET_NEXT_VARIABLE_NAME PeiGetNextVariableName;\r
+};\r
+\r
+extern EFI_GUID gEfiPeiReadOnlyVariablePpiGuid;\r
+\r
+#endif\r
--- /dev/null
+/** @file\r
+ This file declares Section Extraction PPI.\r
+\r
+ Copyright (c) 2006, Intel Corporation \r
+ All rights reserved. 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
+ http://opensource.org/licenses/bsd-license.php \r
+\r
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
+\r
+ Module Name: SectionExtraction.h\r
+\r
+ @par Revision Reference:\r
+ This PPI is defined in PEI CIS.\r
+ Version 0.91.\r
+\r
+**/\r
+\r
+#ifndef __SECTION_EXTRACTION_PPI_H__\r
+#define __SECTION_EXTRACTION_PPI_H__\r
+\r
+#define EFI_PEI_SECTION_EXTRACTION_PPI_GUID \\r
+ { \\r
+ 0x4F89E208, 0xE144, 0x4804, {0x9E, 0xC8, 0x0F, 0x89, 0x4F, 0x7E, 0x36, 0xD7 } \\r
+ }\r
+\r
+typedef struct _EFI_PEI_SECTION_EXTRACTION_PPI EFI_PEI_SECTION_EXTRACTION_PPI;\r
+\r
+//\r
+// Bit values for AuthenticationStatus\r
+//\r
+#define EFI_PEI_AUTH_STATUS_PLATFORM_OVERRIDE 0x01\r
+#define EFI_PEI_AUTH_STATUS_IMAGE_SIGNED 0x02\r
+#define EFI_PEI_AUTH_STATUS_NOT_TESTED 0x04\r
+#define EFI_PEI_AUTH_STATUS_TEST_FAILED 0x08\r
+\r
+/**\r
+ The function is used to retrieve a section from within a section file.\r
+ It will retrieve both encapsulation sections and leaf sections in their entirety,\r
+ exclusive of the section header.\r
+\r
+ @param PeiServices Pointer to the PEI Services Table.\r
+ @param This Indicates the calling context\r
+ @param SectionType Pointer to an EFI_SECTION_TYPE. If SectionType == NULL,\r
+ the contents of the entire section are returned in Buffer. If SectionType\r
+ is not NULL, only the requested section is returned.\r
+ @param SectionDefinitionGuid \r
+ Pointer to an EFI_GUID.\r
+ If SectionType == EFI_SECTION_GUID_DEFINED, SectionDefinitionGuid\r
+ indicates for which section GUID to search.\r
+ If SectionType != EFI_SECTION_GUID_DEFINED, SectionDefinitionGuid\r
+ is unused and is ignored.\r
+ @param SectionInstance If SectionType is not NULL, indicates which\r
+ instance of the requested section type to return.\r
+ @param Buffer Pointer to a pointer to a buffer in which the section\r
+ contents are returned.\r
+ @param BufferSize A pointer to a caller-allocated UINT32.On input, *BufferSize\r
+ indicates the size in bytes of the memory region pointed to by Buffer.On output,\r
+ *BufferSize contains the number of bytes required to read the section.\r
+ @param AuthenticationStatus \r
+ A pointer to a caller-allocated UINT32 in\r
+ which any metadata from encapsulating GUID-defined sections is returned.\r
+\r
+ @retval EFI_SUCCESS The section was successfully processed and the section\r
+ contents were returned in Buffer.\r
+ @retval EFI_PROTOCOL_ERROR A GUID-defined section was encountered in\r
+ the file with its EFI_GUIDED_SECTION_PROCESSING_REQUIRED bit set, but\r
+ there was no corresponding GUIDed Section Extraction Protocol in the\r
+ handle database.*Buffer is unmodified.\r
+ @retval EFI_NOT_FOUND The requested section does not exist.*Buffer is unmodified.\r
+ @retval EFI_OUT_OF_RESOURCES The system has insufficient resources to process the request.\r
+ @retval EFI_INVALID_PARAMETER The SectionStreamHandle does not exist.\r
+ @retval EFI_WARN_TOO_SMALL The size of the input buffer is insufficient to\r
+ contain the requested section. The input buffer is filled and contents are\r
+ section contents are truncated.\r
+\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_PEI_GET_SECTION) (\r
+ IN EFI_PEI_SERVICES **PeiServices,\r
+ IN EFI_PEI_SECTION_EXTRACTION_PPI *This,\r
+ IN EFI_SECTION_TYPE *SectionType,\r
+ IN EFI_GUID *SectionDefinitionGuid, OPTIONAL\r
+ IN UINTN SectionInstance,\r
+ IN VOID **Buffer,\r
+ IN OUT UINT32 *BufferSize,\r
+ OUT UINT32 *AuthenticationStatus\r
+ );\r
+\r
+/**\r
+ @par Ppi Description:\r
+ This PPI supports encapsulating sections, such as GUIDed sections used to \r
+ authenticate the file encapsulation of other domain-specific wrapping.\r
+\r
+ @param GetSection\r
+ Retrieves a section from within a section file.\r
+\r
+**/\r
+struct _EFI_PEI_SECTION_EXTRACTION_PPI {\r
+ EFI_PEI_GET_SECTION PeiGetSection;\r
+};\r
+\r
+extern EFI_GUID gEfiPeiSectionExtractionPpiGuid;\r
+\r
+#endif\r
--- /dev/null
+/** @file\r
+ This file declares Security Architectural PPI.\r
+\r
+ Copyright (c) 2006, Intel Corporation \r
+ All rights reserved. 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
+ http://opensource.org/licenses/bsd-license.php \r
+\r
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
+\r
+ Module Name: Security.h\r
+\r
+ @par Revision Reference:\r
+ This PPI is defined in PEI CIS.\r
+ Version 0.91.\r
+\r
+**/\r
+\r
+#ifndef __SECURITY_PPI_H__\r
+#define __SECURITY_PPI_H__\r
+\r
+#define EFI_PEI_SECURITY_PPI_GUID \\r
+ { \\r
+ 0x1388066e, 0x3a57, 0x4efa, {0x98, 0xf3, 0xc1, 0x2f, 0x3a, 0x95, 0x8a, 0x29 } \\r
+ }\r
+\r
+typedef struct _EFI_PEI_SECURITY_PPI EFI_PEI_SECURITY_PPI;\r
+\r
+/**\r
+ Allows the platform builder to implement a security policy in response \r
+ to varying file authentication states.\r
+\r
+ @param PeiServices Pointer to the PEI Services Table.\r
+ @param This Interface pointer that implements the particular EFI_PEI_SECURITY_PPI instance.\r
+ @param AuthenticationStatus \r
+ Status returned by the verification service as part of section extraction.\r
+ @param FfsFileHeader Pointer to the file under review.\r
+ @param DeferExecution Pointer to a variable that alerts the PEI Foundation to defer execution of a PEIM.\r
+\r
+ @retval EFI_SUCCESS The service performed its action successfully.\r
+ @retval EFI_SECURITY_VIOLATION The object cannot be trusted\r
+\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_PEI_SECURITY_AUTHENTICATION_STATE) (\r
+ IN EFI_PEI_SERVICES **PeiServices,\r
+ IN EFI_PEI_SECURITY_PPI *This,\r
+ IN UINT32 AuthenticationStatus,\r
+ IN EFI_FFS_FILE_HEADER *FfsFileHeader,\r
+ IN OUT BOOLEAN *StartCrisisRecovery\r
+ );\r
+\r
+/**\r
+ @par Ppi Description:\r
+ This PPI is installed by some platform PEIM that abstracts the security \r
+ policy to the PEI Foundation, namely the case of a PEIM's authentication \r
+ state being returned during the PEI section extraction process. \r
+\r
+ @param AuthenticationState\r
+ Allows the platform builder to implement a security policy in response \r
+ to varying file authentication states.\r
+\r
+**/\r
+struct _EFI_PEI_SECURITY_PPI {\r
+ EFI_PEI_SECURITY_AUTHENTICATION_STATE AuthenticationState;\r
+};\r
+\r
+extern EFI_GUID gEfiPeiSecurityPpiGuid;\r
+\r
+#endif\r
--- /dev/null
+/*++\r
+\r
+Copyright (c) 2006, Intel Corporation \r
+All rights reserved. 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
+http://opensource.org/licenses/bsd-license.php \r
+ \r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
+\r
+Module Name:\r
+\r
+ AcpiS3Save.h\r
+\r
+Abstract:\r
+\r
+ \r
+--*/\r
+\r
+#ifndef _ACPI_S3_SAVE_PROTOCOL_H\r
+#define _ACPI_S3_SAVE_PROTOCOL_H\r
+\r
+//\r
+// Forward reference for pure ANSI compatability\r
+//\r
+typedef struct _EFI_ACPI_S3_SAVE_PROTOCOL EFI_ACPI_S3_SAVE_PROTOCOL;\r
+\r
+//\r
+// S3 Save Protocol GUID\r
+//\r
+#define EFI_ACPI_S3_SAVE_GUID \\r
+ { \\r
+ 0x125f2de1, 0xfb85, 0x440c, {0xa5, 0x4c, 0x4d, 0x99, 0x35, 0x8a, 0x8d, 0x38 } \\r
+ }\r
+\r
+//\r
+// Protocol Data Structures\r
+//\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_ACPI_S3_SAVE) (\r
+ IN EFI_ACPI_S3_SAVE_PROTOCOL * This,\r
+ IN VOID * LegacyMemoryAddress \r
+ );\r
+\r
+typedef \r
+EFI_STATUS \r
+(EFIAPI *EFI_ACPI_GET_LEGACY_MEMORY_SIZE) (\r
+ IN EFI_ACPI_S3_SAVE_PROTOCOL * This,\r
+ OUT UINTN * Size\r
+);\r
+\r
+struct _EFI_ACPI_S3_SAVE_PROTOCOL {\r
+ EFI_ACPI_GET_LEGACY_MEMORY_SIZE GetLegacyMemorySize;\r
+ EFI_ACPI_S3_SAVE S3Save;\r
+};\r
+\r
+extern EFI_GUID gEfiAcpiS3SaveProtocolGuid;\r
+\r
+#endif\r
--- /dev/null
+/** @file\r
+ This file declares Firmware Volume Dispatch protocol.\r
+\r
+ Presence of this protocol tells the dispatch to dispatch from this Firmware \r
+ Volume\r
+\r
+ Copyright (c) 2006, Intel Corporation \r
+ All rights reserved. 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
+ http://opensource.org/licenses/bsd-license.php \r
+\r
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
+\r
+ Module Name: FirmwareVolumeDispatch.h\r
+\r
+ @par Revision Reference:\r
+ This protol will be defined in DXE CIS Spec.\r
+ Version 0.91C.\r
+\r
+**/\r
+\r
+#ifndef __FIRMWARE_VOLUME_DISPATCH_H__\r
+#define __FIRMWARE_VOLUME_DISPATCH_H__\r
+\r
+#define EFI_FIRMWARE_VOLUME_DISPATCH_PROTOCOL_GUID \\r
+ { 0x7aa35a69, 0x506c, 0x444f, {0xa7, 0xaf, 0x69, 0x4b, 0xf5, 0x6f, 0x71, 0xc8 } }\r
+\r
+\r
+extern EFI_GUID gEfiFirmwareVolumeDispatchProtocolGuid;\r
+\r
+#endif\r
--- /dev/null
+/** @file\r
+ The EFI_FORM_CALLBACK_PROTOCOL is the defined interface for access to custom \r
+ NV storage devices as well as communication of user selections in a more \r
+ interactive environment. This protocol should be published by hardware \r
+ specific drivers which want to export access to custom hardware storage or \r
+ publish IFR which has a requirement to call back the original driver.\r
+\r
+ Copyright (c) 2006, Intel Corporation \r
+ All rights reserved. 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
+ http://opensource.org/licenses/bsd-license.php \r
+\r
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
+\r
+ Module Name: FormCallback.h\r
+\r
+ @par Revision Reference:\r
+ This protocol is defined in HII spec 0.92.\r
+\r
+**/\r
+\r
+#ifndef __FORM_CALLBACK_H__\r
+#define __FORM_CALLBACK_H__\r
+\r
+\r
+#define EFI_FORM_CALLBACK_PROTOCOL_GUID \\r
+ { \\r
+ 0xf3e4543d, 0xcf35, 0x6cef, {0x35, 0xc4, 0x4f, 0xe6, 0x34, 0x4d, 0xfc, 0x54 } \\r
+ }\r
+\r
+//\r
+// Forward reference for pure ANSI compatability\r
+//\r
+typedef struct _EFI_FORM_CALLBACK_PROTOCOL EFI_FORM_CALLBACK_PROTOCOL;\r
+\r
+\r
+#define RESET_REQUIRED 1 // Flags setting to signify that the callback operation resulted in an eventual\r
+// reset to be done upon exit of the browser\r
+//\r
+#define EXIT_REQUIRED 2 // Flags setting to signify that after the processing of the callback results - exit the browser\r
+#define SAVE_REQUIRED 4 // Flags setting to signify that after the processing of the callback results - save the NV data\r
+#define NV_CHANGED 8 // Flags setting to signify that after the processing of the callback results - turn the NV flag on\r
+#define NV_NOT_CHANGED 16 // Flags setting to signify that after the processing of the callback results - turn the NV flag off\r
+#pragma pack(1)\r
+typedef struct {\r
+ UINT8 OpCode; // Likely a string, numeric, or one-of\r
+ UINT8 Length; // Length of the EFI_IFR_DATA_ENTRY packet\r
+ UINT16 Flags; // Flags settings to determine what behavior is desired from the browser after the callback\r
+ VOID *Data; // The data in the form based on the op-code type - this is not a pointer to the data, the data follows immediately\r
+ // If the OpCode is a OneOf or Numeric type - Data is a UINT16 value\r
+ // If the OpCode is a String type - Data is a CHAR16[x] type\r
+ // If the OpCode is a Checkbox type - Data is a UINT8 value\r
+ // If the OpCode is a NV Access type - Data is a EFI_IFR_NV_DATA structure\r
+ //\r
+} EFI_IFR_DATA_ENTRY;\r
+\r
+typedef struct {\r
+ VOID *NvRamMap; // If the flag of the op-code specified retrieval of a copy of the NVRAM map,\r
+ // this is a pointer to a buffer copy\r
+ //\r
+ UINT32 EntryCount; // How many EFI_IFR_DATA_ENTRY entries\r
+ //\r
+ // EFI_IFR_DATA_ENTRY Data[1]; // The in-line Data entries.\r
+ //\r
+} EFI_IFR_DATA_ARRAY;\r
+\r
+typedef union {\r
+ EFI_IFR_DATA_ARRAY DataArray; // Primarily used by those who call back to their drivers and use HII as a repository\r
+ EFI_IFR_PACKET DataPacket; // Primarily used by those which do not use HII as a repository\r
+ CHAR16 *String; // If returning an error - fill the string with null-terminated contents\r
+} EFI_HII_CALLBACK_PACKET;\r
+\r
+typedef struct {\r
+ EFI_IFR_OP_HEADER Header;\r
+ UINT16 QuestionId; // Offset into the map\r
+ UINT8 StorageWidth; // Width of the value\r
+ //\r
+ // CHAR8 Data[1]; // The Data itself\r
+ //\r
+} EFI_IFR_NV_DATA;\r
+\r
+#pragma pack()\r
+//\r
+// The following types are currently defined:\r
+//\r
+/**\r
+ Returns the value of a variable. \r
+\r
+ @param This A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance.\r
+ @param VariableName A NULL-terminated Unicode string that is the\r
+ name of the vendor's variable.\r
+ @param VendorGuid A unique identifier for the vendor.\r
+ @param Attributes If not NULL, a pointer to the memory location to\r
+ return the attribute's bit-mask for the variable.\r
+ @param DataSize The size in bytes of the Buffer. A size of zero causes\r
+ the variable to be deleted.\r
+ @param Buffer The buffer to return the contents of the variable.\r
+\r
+ @retval EFI_SUCCESS The function completed successfully.\r
+ @retval EFI_NOT_FOUND The variable was not found.\r
+ @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result.\r
+ DataSize has been updated with the size needed to complete the request.\r
+ @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
+ @retval EFI_DEVICE_ERROR The variable could not be saved due to a hardware failure.\r
+\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_NV_READ) (\r
+ IN EFI_FORM_CALLBACK_PROTOCOL *This,\r
+ IN CHAR16 *VariableName,\r
+ IN EFI_GUID *VendorGuid,\r
+ OUT UINT32 *Attributes OPTIONAL,\r
+ IN OUT UINTN *DataSize,\r
+ OUT VOID *Buffer\r
+ );\r
+\r
+/**\r
+ Sets the value of a variable. \r
+\r
+ @param This A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance.\r
+ @param VariableName A NULL-terminated Unicode string that is the\r
+ name of the vendor's variable. Each VariableName is unique for each VendorGuid.\r
+ @param VendorGuid A unique identifier for the vendor.\r
+ @param Attributes Attributes bit-mask to set for the variable.\r
+ @param DataSize The size in bytes of the Buffer. A size of zero causes\r
+ the variable to be deleted.\r
+ @param Buffer The buffer containing the contents of the variable.\r
+ @param ResetRequired Returns a value from the driver that abstracts\r
+ this information and will enable a system to know if a system reset\r
+ is required to achieve the configuration changes being enabled through\r
+ this function.\r
+\r
+ @retval EFI_SUCCESS The firmware has successfully stored the variable and\r
+ its data as defined by the Attributes.\r
+ @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold\r
+ the variable and its data.\r
+ @retval EFI_INVALID_PARAMETER An invalid combination of Attributes bits\r
+ was supplied, or the DataSize exceeds the maximum allowed.\r
+ @retval EFI_DEVICE_ERROR The variable could not be saved due to a hardware failure.\r
+\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_NV_WRITE) (\r
+ IN EFI_FORM_CALLBACK_PROTOCOL *This,\r
+ IN CHAR16 *VariableName,\r
+ IN EFI_GUID *VendorGuid,\r
+ IN UINT32 Attributes,\r
+ IN UINTN DataSize,\r
+ IN VOID *Buffer,\r
+ OUT BOOLEAN *ResetRequired\r
+ );\r
+\r
+/**\r
+ This function is called to provide results data to the driver. \r
+\r
+ @param This A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance.\r
+ @param KeyValue A unique value which is sent to the original exporting\r
+ driver so that it can identify the type of data to expect. The format of\r
+ the data tends to vary based on the opcode that generated the callback.\r
+ @param Data A pointer to the data being sent to the original exporting driver.\r
+ @param Packet A pointer to a packet of information which a driver passes\r
+ back to the browser.\r
+\r
+ @return Status Code\r
+\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_FORM_CALLBACK) (\r
+ IN EFI_FORM_CALLBACK_PROTOCOL *This,\r
+ IN UINT16 KeyValue,\r
+ IN EFI_IFR_DATA_ARRAY *Data,\r
+ OUT EFI_HII_CALLBACK_PACKET **Packet\r
+ );\r
+\r
+/**\r
+ @par Protocol Description:\r
+ The EFI_FORM_CALLBACK_PROTOCOL is the defined interface for access to \r
+ custom NVS devices as well as communication of user selections in a more \r
+ interactive environment. This protocol should be published by hardware-specific \r
+ drivers that want to export access to custom hardware storage or publish IFR \r
+ that has a requirement to call back the original driver.\r
+\r
+ @param NvRead\r
+ The read operation to access the NV data serviced by a hardware-specific driver.\r
+\r
+ @param NvWrite\r
+ The write operation to access the NV data serviced by a hardware-specific driver.\r
+\r
+ @param Callback\r
+ The function that is called from the configuration browser to communicate key value pairs. \r
+\r
+**/\r
+struct _EFI_FORM_CALLBACK_PROTOCOL {\r
+ EFI_NV_READ NvRead;\r
+ EFI_NV_WRITE NvWrite;\r
+ EFI_FORM_CALLBACK Callback;\r
+};\r
+\r
+extern EFI_GUID gEfiFormCallbackProtocolGuid;\r
+\r
+#endif\r
--- /dev/null
+/** @file\r
+ This file declares GUIDed section extraction protocol.\r
+\r
+ This interface provides a means of decoding a GUID defined encapsulation \r
+ section. There may be multiple different GUIDs associated with the GUIDed\r
+ section extraction protocol. That is, all instances of the GUIDed section\r
+ extraction protocol must have the same interface structure.\r
+\r
+ Copyright (c) 2006, Intel Corporation \r
+ All rights reserved. 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
+ http://opensource.org/licenses/bsd-license.php \r
+\r
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
+\r
+ Module Name: GuidedSectionExtraction.h\r
+\r
+ @par Revision Reference:\r
+ This protocol is defined in Firmware Volume Specification.\r
+ Version 0.9\r
+\r
+**/\r
+\r
+#ifndef __GUIDED_SECTION_EXTRACTION_PROTOCOL_H__\r
+#define __GUIDED_SECTION_EXTRACTION_PROTOCOL_H__\r
+\r
+\r
+//\r
+// Protocol GUID definition. Each GUIDed section extraction protocol has the\r
+// same interface but with different GUID. All the GUIDs is defined here.\r
+// May add multiple GUIDs here.\r
+//\r
+#define EFI_CRC32_GUIDED_SECTION_EXTRACTION_PROTOCOL_GUID \\r
+ { \\r
+ 0xFC1BCDB0, 0x7D31, 0x49aa, {0x93, 0x6A, 0xA4, 0x60, 0x0D, 0x9D, 0xD0, 0x83 } \\r
+ }\r
+\r
+//\r
+// Forward reference for pure ANSI compatability\r
+//\r
+typedef struct _EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL;\r
+\r
+//\r
+// Protocol member functions\r
+//\r
+/**\r
+ Processes the input section and returns the data contained therein along \r
+ with the authentication status.\r
+\r
+ @param This Indicates the EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL instance.\r
+ @param InputSection Buffer containing the input GUIDed section to be processed.\r
+ @param OutputBuffer *OutputBuffer is allocated from boot services pool memory\r
+ and contains the new section stream.\r
+ @param OutputSize A pointer to a caller-allocated UINTN in which the size\r
+ of *OutputBuffer allocation is stored.\r
+ @param AuthenticationStatus A pointer to a caller-allocated UINT32 that\r
+ indicates the authentication status of the output buffer.\r
+ \r
+ @retval EFI_SUCCESS The InputSection was successfully processed and the\r
+ section contents were returned.\r
+ @retval EFI_OUT_OF_RESOURCES The system has insufficient resources to\r
+ process the request.\r
+ @retval EFI_INVALID_PARAMETER The GUID in InputSection does not match\r
+ this instance of the GUIDed Section Extraction Protocol.\r
+\r
+**/\r
+\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_EXTRACT_GUIDED_SECTION) (\r
+ IN EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL *This,\r
+ IN VOID *InputSection,\r
+ OUT VOID **OutputBuffer,\r
+ OUT UINTN *OutputSize,\r
+ OUT UINT32 *AuthenticationStatus\r
+ );\r
+\r
+//\r
+// Protocol definition\r
+//\r
+/**\r
+ @par Protocol Description:\r
+ If a GUID-defined section is encountered when doing section extraction, \r
+ the section extraction driver calls the appropriate instance of the GUIDed \r
+ Section Extraction Protocol to extract the section stream contained therein.\r
+\r
+ @param ExtractSection\r
+ Takes the GUIDed section as input and produces the section stream data. \r
+\r
+**/\r
+struct _EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL {\r
+ EFI_EXTRACT_GUIDED_SECTION ExtractSection;\r
+};\r
+\r
+//\r
+// may add other GUID here\r
+//\r
+extern EFI_GUID gEfiCrc32GuidedSectionExtractionProtocolGuid;\r
+\r
+#endif\r
gEfiFrameworkDevicePathGuid = { 0xb7084e63, 0x46b7, 0x4d1a, { 0x86, 0x77, 0xe3, 0x0b, 0x53, 0xdb, 0xf0, 0x50 }}\r
gSmmCommunicateHeaderGuid = { 0xf328e36c, 0x23b6, 0x4a95, { 0x85, 0x4b, 0x32, 0xe1, 0x95, 0x34, 0xcd, 0x75 }}\r
gEfiSmmPeiSmramMemoryReserveGuid = { 0x6dadf1d1, 0xd4cc, 0x4910, { 0xbb, 0x6e, 0x82, 0xb1, 0xfd, 0x80, 0xff, 0x3d }}\r
+ gEfiCapsuleGuid = { 0x3B6686BD, 0x0D76, 0x4030, { 0xB7, 0x0E, 0xB5, 0x51, 0x9E, 0x2F, 0xC5, 0xA0 }}\r
\r
\r
\r
#\r
################################################################################\r
[Protocols.common]\r
+ gEfiCrc32GuidedSectionExtractionProtocolGuid = { 0xFC1BCDB0, 0x7D31, 0x49AA, { 0x93, 0x6A, 0xA4, 0x60, 0x0D, 0x9D, 0xD0, 0x83 }}\r
+ gEfiFormCallbackProtocolGuid = { 0xF3E4543D, 0xCF35, 0x6CEF, { 0x35, 0xC4, 0x4F, 0xE6, 0x34, 0x4D, 0xFC, 0x54 }}\r
+ gEfiFirmwareVolumeDispatchProtocolGuid = { 0x7AA35A69, 0x506C, 0x444F, { 0xA7, 0xAF, 0x69, 0x4B, 0xF5, 0x6F, 0x71, 0xC8 }}\r
+ gEfiAcpiS3SaveProtocolGuid = { 0x125F2DE1, 0xFB85, 0x440C, { 0xA5, 0x4C, 0x4D, 0x99, 0x35, 0x8A, 0x8D, 0x38 }}\r
gEfiAcpiSupportProtocolGuid = { 0xdbff9d55, 0x89b7, 0x46da, { 0xbd, 0xdf, 0x67, 0x7d, 0x3d, 0xc0, 0x24, 0x1d }}\r
gEfiBootScriptSaveProtocolGuid = { 0x470e1529, 0xb79e, 0x4e32, { 0xa0, 0xfe, 0x6a, 0x15, 0x6d, 0x29, 0xf9, 0xb2 }}\r
gEfiCpuIoProtocolGuid = { 0xB0732526, 0x38C8, 0x4b40, { 0x88, 0x77, 0x61, 0xc7, 0xb0, 0x6a, 0xac, 0x45 }}\r
gEfiSmmSxDispatchProtocolGuid = { 0x14fc52be, 0x01dc, 0x426c, { 0x91, 0xae, 0xa2, 0x3c, 0x3e, 0x22, 0x0a, 0xe8 }}\r
\r
\r
+\r
+\r
+################################################################################\r
+#\r
+# Global Ppis Definition section - list of Global Ppis C Name Data Structures\r
+# that are provided by this package.\r
+#\r
+################################################################################\r
+[Ppis.common]\r
+ gEfiPeiReadOnlyVariablePpiGuid = { 0x3CDC90C6, 0x13FB, 0x4A75, { 0x9E, 0x79, 0x59, 0xE9, 0xDD, 0x78, 0xB9, 0xFA }}\r
+ gEfiPeiSectionExtractionPpiGuid = { 0x4F89E208, 0xE144, 0x4804, { 0x9E, 0xC8, 0x0F, 0x89, 0x4F, 0x7E, 0x36, 0xD7 }}\r
+ gEfiPeiSecurityPpiGuid = { 0x1388066E, 0x3A57, 0x4EFA, { 0x98, 0xF3, 0xC1, 0x2F, 0x3A, 0x95, 0x8A, 0x29 }}\r
+ gEfiPeiVirtualBlockIoPpiGuid = { 0x695d8aa1, 0x42ee, 0x4c46, { 0x80, 0x5c, 0x6e, 0xa6, 0xbc, 0xe7, 0x99, 0xe3 }}\r
+ gEfiPei144FloppyBlockIoPpiGuid = { 0xda6855bd, 0x07b7, 0x4c05, { 0x9e, 0xd8, 0xe2, 0x59, 0xfd, 0x36, 0x0e, 0x22 }}\r
+ gEfiPeiIdeBlockIoPpiGuid = { 0x0964e5b22, 0x6459, 0x11d2, { 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b }}\r
+ gEfiPeiBootScriptExecuterPpiGuid = { 0xabd42895, 0x78cf, 0x4872, { 0x84, 0x44, 0x1b, 0x5c, 0x18, 0x0b, 0xfb, 0xff }}\r
+ gEfiPeiRecoveryModulePpiGuid = { 0xFB6D9542, 0x612D, 0x4f45, { 0x87, 0x2f, 0x5c, 0xff, 0x52, 0xe9, 0x3d, 0xcf }}\r
+ gEfiPeiS3ResumePpiGuid = { 0x4426CCB2, 0xE684, 0x4a8a, { 0xae, 0x40, 0x20, 0xd4, 0xb0, 0x25, 0xb7, 0x10 }}\r
+ gEfiPeiSmbusPpiGuid = { 0xabd42895, 0x78cf, 0x4872, { 0x84, 0x44, 0x1b, 0x5c, 0x18, 0x0b, 0xfb, 0xda }}\r
+\r
+\r
<IncludePkgHeader ModuleType="DXE_SMM_DRIVER">Include/FrameworkSmm.h</IncludePkgHeader>\r
</PackageHeaders>\r
<GuidDeclarations>\r
+ <Entry Name="Capsule">\r
+ <C_Name>gEfiCapsuleGuid</C_Name>\r
+ <GuidValue>3B6686BD-0D76-4030-B70E-B5519E2FC5A0</GuidValue>\r
+ <HelpText/>\r
+ </Entry>\r
<Entry Name="SmramMemoryReserve" GuidTypeList="HOB">\r
<C_Name>gEfiSmmPeiSmramMemoryReserveGuid</C_Name>\r
<GuidValue>6dadf1d1-d4cc-4910-bb6e-82b1fd80ff3d</GuidValue>\r
<GuidValue>dbff9d55-89b7-46da-bddf-677d3dc0241d</GuidValue>\r
<HelpText>ACPI Support protocol</HelpText>\r
</Entry>\r
+ <Entry Name="AcpiS3Save">\r
+ <C_Name>gEfiAcpiS3SaveProtocolGuid</C_Name>\r
+ <GuidValue>125F2DE1-FB85-440C-A54C-4D99358A8D38</GuidValue>\r
+ <HelpText/>\r
+ </Entry>\r
+ <Entry Name="FirmwareVolumeDispatch">\r
+ <C_Name>gEfiFirmwareVolumeDispatchProtocolGuid</C_Name>\r
+ <GuidValue>7AA35A69-506C-444F-A7AF-694BF56F71C8</GuidValue>\r
+ <HelpText/>\r
+ </Entry>\r
+ <Entry Name="FormCallback">\r
+ <C_Name>gEfiFormCallbackProtocolGuid</C_Name>\r
+ <GuidValue>F3E4543D-CF35-6CEF-35C4-4FE6344DFC54</GuidValue>\r
+ <HelpText/>\r
+ </Entry>\r
+ <Entry Name="Crc32GuidedSectionExtraction">\r
+ <C_Name>gEfiCrc32GuidedSectionExtractionProtocolGuid</C_Name>\r
+ <GuidValue>FC1BCDB0-7D31-49AA-936A-A4600D9DD083</GuidValue>\r
+ <HelpText/>\r
+ </Entry>\r
</ProtocolDeclarations>\r
<PpiDeclarations>\r
<Entry Name="Smbus">\r
<GuidValue>695d8aa1-42ee-4c46-805c-6ea6bce799e3</GuidValue>\r
<HelpText>Virtual Block I/O PPI</HelpText>\r
</Entry>\r
+ <Entry Name="Security">\r
+ <C_Name>gEfiPeiSecurityPpiGuid</C_Name>\r
+ <GuidValue>1388066E-3A57-4EFA-98F3-C12F3A958A29</GuidValue>\r
+ <HelpText/>\r
+ </Entry>\r
+ <Entry Name="SectionExtraction">\r
+ <C_Name>gEfiPeiSectionExtractionPpiGuid</C_Name>\r
+ <GuidValue>4F89E208-E144-4804-9EC8-0F894F7E36D7</GuidValue>\r
+ <HelpText/>\r
+ </Entry>\r
+ <Entry Name="ReadOnlyVariable">\r
+ <C_Name>gEfiPeiReadOnlyVariablePpiGuid</C_Name>\r
+ <GuidValue>3CDC90C6-13FB-4A75-9E79-59E9DD78B9FA</GuidValue>\r
+ <HelpText/>\r
+ </Entry>\r
</PpiDeclarations>\r
</PackageSurfaceArea>
\ No newline at end of file
projects / mirror_edk2.git / commitdiff