IntelFrameworkPkg/Include/Protocol/FormCallback.h

   1 /** @file
   2   The EFI_FORM_CALLBACK_PROTOCOL is the defined interface for access to custom
   3   NV storage devices as well as communication of user selections in a more
   4   interactive environment.  This protocol should be published by hardware
   5   specific drivers which want to export access to custom hardware storage or
   6   publish IFR which has a requirement to call back the original driver.
   7
   8   Copyright (c) 2006, Intel Corporation
   9   All rights reserved. This program and the accompanying materials
  10   are licensed and made available under the terms and conditions of the BSD License
  11   which accompanies this distribution.  The full text of the license may be found at
  12   http://opensource.org/licenses/bsd-license.php
  13
  14   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  15   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  16
  17   Module Name:  FormCallback.h
  18
  19   @par Revision Reference:
  20   This protocol is defined in HII spec 0.92.
  21
  22 **/
  23
  24 #ifndef __FORM_CALLBACK_H__
  25 #define __FORM_CALLBACK_H__
  26
  27
  28 #define EFI_FORM_CALLBACK_PROTOCOL_GUID \
  29   { \
  30     0xf3e4543d, 0xcf35, 0x6cef, {0x35, 0xc4, 0x4f, 0xe6, 0x34, 0x4d, 0xfc, 0x54 } \
  31   }
  32
  33 //
  34 // Forward reference for pure ANSI compatability
  35 //
  36 typedef struct _EFI_FORM_CALLBACK_PROTOCOL  EFI_FORM_CALLBACK_PROTOCOL;
  37
  38
  39 #define RESET_REQUIRED  1 // Flags setting to signify that the callback operation resulted in an eventual
  40 // reset to be done upon exit of the browser
  41 //
  42 #define EXIT_REQUIRED   2   // Flags setting to signify that after the processing of the callback results - exit the browser
  43 #define SAVE_REQUIRED   4   // Flags setting to signify that after the processing of the callback results - save the NV data
  44 #define NV_CHANGED      8   // Flags setting to signify that after the processing of the callback results - turn the NV flag on
  45 #define NV_NOT_CHANGED  16  // Flags setting to signify that after the processing of the callback results - turn the NV flag off
  46 #pragma pack(1)
  47 typedef struct {
  48   UINT8   OpCode;           // Likely a string, numeric, or one-of
  49   UINT8   Length;           // Length of the EFI_IFR_DATA_ENTRY packet
  50   UINT16  Flags;            // Flags settings to determine what behavior is desired from the browser after the callback
  51   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
  52   // If the OpCode is a OneOf or Numeric type - Data is a UINT16 value
  53   // If the OpCode is a String type - Data is a CHAR16[x] type
  54   // If the OpCode is a Checkbox type - Data is a UINT8 value
  55   // If the OpCode is a NV Access type - Data is a EFI_IFR_NV_DATA structure
  56   //
  57 } EFI_IFR_DATA_ENTRY;
  58
  59 typedef struct {
  60   VOID                *NvRamMap;  // If the flag of the op-code specified retrieval of a copy of the NVRAM map,
  61   // this is a pointer to a buffer copy
  62   //
  63   UINT32              EntryCount; // How many EFI_IFR_DATA_ENTRY entries
  64   //
  65   // EFI_IFR_DATA_ENTRY  Data[1];    // The in-line Data entries.
  66   //
  67 } EFI_IFR_DATA_ARRAY;
  68
  69 typedef union {
  70   EFI_IFR_DATA_ARRAY  DataArray;  // Primarily used by those who call back to their drivers and use HII as a repository
  71   EFI_IFR_PACKET      DataPacket; // Primarily used by those which do not use HII as a repository
  72   CHAR16              *String;  // If returning an error - fill the string with null-terminated contents
  73 } EFI_HII_CALLBACK_PACKET;
  74
  75 typedef struct {
  76   EFI_IFR_OP_HEADER Header;
  77   UINT16            QuestionId;   // Offset into the map
  78   UINT8             StorageWidth; // Width of the value
  79   //
  80   // CHAR8             Data[1];      // The Data itself
  81   //
  82 } EFI_IFR_NV_DATA;
  83
  84 #pragma pack()
  85 //
  86 // The following types are currently defined:
  87 //
  88 /**
  89   Returns the value of a variable.
  90
  91   @param  This                  A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance.
  92   @param  VariableName          A NULL-terminated Unicode string that is the
  93                                 name of the vendor's variable.
  94   @param  VendorGuid            A unique identifier for the vendor.
  95   @param  Attributes            If not NULL, a pointer to the memory location to
  96                                 return the attribute's bit-mask for the variable.
  97   @param  DataSize              The size in bytes of the Buffer. A size of zero causes
  98                                 the variable to be deleted.
  99   @param  Buffer                The buffer to return the contents of the variable.
 100
 101   @retval EFI_SUCCESS           The function completed successfully.
 102   @retval EFI_NOT_FOUND         The variable was not found.
 103   @retval EFI_BUFFER_TOO_SMALL  The DataSize is too small for the result.
 104                                 DataSize has been updated with the size needed to complete the request.
 105   @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
 106   @retval EFI_DEVICE_ERROR      The variable could not be saved due to a hardware failure.
 107
 108 **/
 109 typedef
 110 EFI_STATUS
 111 (EFIAPI *EFI_NV_READ) (
 112   IN     EFI_FORM_CALLBACK_PROTOCOL    *This,
 113   IN     CHAR16                        *VariableName,
 114   IN     EFI_GUID                      *VendorGuid,
 115   OUT    UINT32                        *Attributes OPTIONAL,
 116   IN OUT UINTN                         *DataSize,
 117   OUT    VOID                          *Buffer
 118   );
 119
 120 /**
 121   Sets the value of a variable.
 122
 123   @param  This                  A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance.
 124   @param  VariableName          A NULL-terminated Unicode string that is the
 125                                 name of the vendor's variable. Each VariableName is unique for each VendorGuid.
 126   @param  VendorGuid            A unique identifier for the vendor.
 127   @param  Attributes            Attributes bit-mask to set for the variable.
 128   @param  DataSize              The size in bytes of the Buffer. A size of zero causes
 129                                 the variable to be deleted.
 130   @param  Buffer                The buffer containing the contents of the variable.
 131   @param  ResetRequired         Returns a value from the driver that abstracts
 132                                 this information and will enable a system to know if a system reset
 133                                 is required to achieve the configuration changes being enabled through
 134                                 this function.
 135
 136   @retval EFI_SUCCESS           The firmware has successfully stored the variable and
 137                                 its data as defined by the Attributes.
 138   @retval EFI_OUT_OF_RESOURCES  Not enough storage is available to hold
 139                                 the variable and its data.
 140   @retval EFI_INVALID_PARAMETER An invalid combination of Attributes bits
 141                                 was supplied, or the DataSize exceeds the maximum allowed.
 142   @retval EFI_DEVICE_ERROR      The variable could not be saved due to a hardware failure.
 143
 144 **/
 145 typedef
 146 EFI_STATUS
 147 (EFIAPI *EFI_NV_WRITE) (
 148   IN     EFI_FORM_CALLBACK_PROTOCOL    *This,
 149   IN     CHAR16                        *VariableName,
 150   IN     EFI_GUID                      *VendorGuid,
 151   IN     UINT32                        Attributes,
 152   IN     UINTN                         DataSize,
 153   IN     VOID                          *Buffer,
 154   OUT    BOOLEAN                       *ResetRequired
 155   );
 156
 157 /**
 158   This function is called to provide results data to the driver.
 159
 160   @param  This                  A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance.
 161   @param  KeyValue              A unique value which is sent to the original exporting
 162                                 driver so that it can identify the type of data to expect. The format of
 163                                 the data tends to vary based on the opcode that generated the callback.
 164   @param  Data                  A pointer to the data being sent to the original exporting driver.
 165   @param  Packet                A pointer to a packet of information which a driver passes
 166                                 back to the browser.
 167
 168   @return Status Code
 169
 170 **/
 171 typedef
 172 EFI_STATUS
 173 (EFIAPI *EFI_FORM_CALLBACK) (
 174   IN     EFI_FORM_CALLBACK_PROTOCOL    *This,
 175   IN     UINT16                        KeyValue,
 176   IN     EFI_IFR_DATA_ARRAY            *Data,
 177   OUT    EFI_HII_CALLBACK_PACKET       **Packet
 178   );
 179
 180 /**
 181   @par Protocol Description:
 182   The EFI_FORM_CALLBACK_PROTOCOL is the defined interface for access to
 183   custom NVS devices as well as communication of user selections in a more
 184   interactive environment. This protocol should be published by hardware-specific
 185   drivers that want to export access to custom hardware storage or publish IFR
 186   that has a requirement to call back the original driver.
 187
 188   @param NvRead
 189   The read operation to access the NV data serviced by a hardware-specific driver.
 190
 191   @param NvWrite
 192   The write operation to access the NV data serviced by a hardware-specific driver.
 193
 194   @param Callback
 195   The function that is called from the configuration browser to communicate key value pairs.
 196
 197 **/
 198 struct _EFI_FORM_CALLBACK_PROTOCOL {
 199   EFI_NV_READ       NvRead;
 200   EFI_NV_WRITE      NvWrite;
 201   EFI_FORM_CALLBACK Callback;
 202 };
 203
 204 extern EFI_GUID gEfiFormCallbackProtocolGuid;
 205
 206 #endif