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