EdkCompatibilityPkg: Remove EdkCompatibilityPkg

[mirror_edk2.git] / EdkCompatibilityPkg / Foundation / Framework / Protocol / FormCallback / FormCallback.h

diff --git a/EdkCompatibilityPkg/Foundation/Framework/Protocol/FormCallback/FormCallback.h b/EdkCompatibilityPkg/Foundation/Framework/Protocol/FormCallback/FormCallback.h
deleted file mode 100644 (file)
index 653d449..0000000
--- a/EdkCompatibilityPkg/Foundation/Framework/Protocol/FormCallback/FormCallback.h
+++ /dev/null
@@ -1,118 +0,0 @@
-/*++\r
-\r
-Copyright (c) 2004, 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
-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
-    FormCallback.h\r
-\r
-Abstract:\r
-\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
---*/\r
-\r
-#ifndef _FORM_CALLBACK_H_\r
-#define _FORM_CALLBACK_H_\r
-\r
-#include EFI_PROTOCOL_DEFINITION (FormBrowser)\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
-#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
-  EFI_IFR_DATA_ENTRY  Data[1];    // The in-line Data entries.\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[1];  // If returning an error - fill the string with null-terminated contents\r
-} EFI_HII_CALLBACK_PACKET;\r
-#pragma pack()\r
-//\r
-// The following types are currently defined:\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
-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
-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
-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