add some definitions about HII
[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / FormCallback.h
index 8845864..9c11bd6 100644 (file)
@@ -1,18 +1,18 @@
 /** @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
+  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
+  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
+  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
@@ -24,6 +24,9 @@
 #ifndef __FORM_CALLBACK_H__\r
 #define __FORM_CALLBACK_H__\r
 \r
+#include <PiDxe.h>\r
+\r
+#include <Protocol/FrameworkHii.h>\r
 \r
 #define EFI_FORM_CALLBACK_PROTOCOL_GUID \\r
   { \\r
@@ -66,6 +69,7 @@ typedef struct {
   //\r
 } EFI_IFR_DATA_ARRAY;\r
 \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
@@ -86,7 +90,7 @@ typedef struct {
 // The following types are currently defined:\r
 //\r
 /**\r
-  Returns the value of a variable. \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
@@ -118,7 +122,7 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Sets the value of a variable. \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
@@ -155,7 +159,7 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  This function is called to provide results data to the driver. \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
@@ -179,10 +183,10 @@ EFI_STATUS
 \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
+  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
@@ -192,7 +196,7 @@ EFI_STATUS
   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
+  The function that is called from the configuration browser to communicate key value pairs.\r
 \r
 **/\r
 struct _EFI_FORM_CALLBACK_PROTOCOL {\r