X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=IntelFrameworkPkg%2FInclude%2FProtocol%2FFormCallback.h;h=9c11bd60981c1ed4b3ed00051a449d42f0b61139;hp=8845864be31acd5569f4e86179f7e68b4ed88cf6;hb=61a30832e185b2a9994c28d49666d85cf2f737da;hpb=3e5a3960f8b99d0dcfa1c769161135a394336443 diff --git a/IntelFrameworkPkg/Include/Protocol/FormCallback.h b/IntelFrameworkPkg/Include/Protocol/FormCallback.h index 8845864be3..9c11bd6098 100644 --- a/IntelFrameworkPkg/Include/Protocol/FormCallback.h +++ b/IntelFrameworkPkg/Include/Protocol/FormCallback.h @@ -1,18 +1,18 @@ /** @file - The EFI_FORM_CALLBACK_PROTOCOL is the defined interface for access to custom - NV storage devices as well as communication of user selections in a more - interactive environment. This protocol should be published by hardware - specific drivers which want to export access to custom hardware storage or + The EFI_FORM_CALLBACK_PROTOCOL is the defined interface for access to custom + NV storage devices as well as communication of user selections in a more + interactive environment. This protocol should be published by hardware + specific drivers which want to export access to custom hardware storage or publish IFR which has a requirement to call back the original driver. - Copyright (c) 2006, Intel Corporation - All rights reserved. This program and the accompanying materials - are licensed and made available under the terms and conditions of the BSD License - which accompanies this distribution. The full text of the license may be found at - http://opensource.org/licenses/bsd-license.php + Copyright (c) 2006, Intel Corporation + All rights reserved. This program and the accompanying materials + are licensed and made available under the terms and conditions of the BSD License + which accompanies this distribution. The full text of the license may be found at + http://opensource.org/licenses/bsd-license.php - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. Module Name: FormCallback.h @@ -24,6 +24,9 @@ #ifndef __FORM_CALLBACK_H__ #define __FORM_CALLBACK_H__ +#include + +#include #define EFI_FORM_CALLBACK_PROTOCOL_GUID \ { \ @@ -66,6 +69,7 @@ typedef struct { // } EFI_IFR_DATA_ARRAY; + typedef union { EFI_IFR_DATA_ARRAY DataArray; // Primarily used by those who call back to their drivers and use HII as a repository EFI_IFR_PACKET DataPacket; // Primarily used by those which do not use HII as a repository @@ -86,7 +90,7 @@ typedef struct { // The following types are currently defined: // /** - Returns the value of a variable. + Returns the value of a variable. @param This A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance. @param VariableName A NULL-terminated Unicode string that is the @@ -118,7 +122,7 @@ EFI_STATUS ); /** - Sets the value of a variable. + Sets the value of a variable. @param This A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance. @param VariableName A NULL-terminated Unicode string that is the @@ -155,7 +159,7 @@ EFI_STATUS ); /** - This function is called to provide results data to the driver. + This function is called to provide results data to the driver. @param This A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance. @param KeyValue A unique value which is sent to the original exporting @@ -179,10 +183,10 @@ EFI_STATUS /** @par Protocol Description: - The EFI_FORM_CALLBACK_PROTOCOL is the defined interface for access to - custom NVS devices as well as communication of user selections in a more - interactive environment. This protocol should be published by hardware-specific - drivers that want to export access to custom hardware storage or publish IFR + The EFI_FORM_CALLBACK_PROTOCOL is the defined interface for access to + custom NVS devices as well as communication of user selections in a more + interactive environment. This protocol should be published by hardware-specific + drivers that want to export access to custom hardware storage or publish IFR that has a requirement to call back the original driver. @param NvRead @@ -192,7 +196,7 @@ EFI_STATUS The write operation to access the NV data serviced by a hardware-specific driver. @param Callback - The function that is called from the configuration browser to communicate key value pairs. + The function that is called from the configuration browser to communicate key value pairs. **/ struct _EFI_FORM_CALLBACK_PROTOCOL {