]>
Commit | Line | Data |
---|---|---|
d1f95000 | 1 | /** @file\r |
2 | \r | |
4ca9b6c4 LG |
3 | The EFI HII results processing protocol invokes this type of protocol \r |
4 | when it needs to forward results to a driver's configuration handler. \r | |
5 | This protocol is published by drivers providing and requesting \r | |
6 | configuration data from HII. It may only be invoked by HII.\r | |
d1f95000 | 7 | \r |
e1f1fb16 | 8 | Copyright (c) 2006 - 2009, Intel Corporation\r |
d1f95000 | 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 | |
d1f95000 | 17 | **/\r |
18 | \r | |
19 | \r | |
20 | #ifndef __EFI_HII_CONFIG_ACCESS_H__\r | |
21 | #define __EFI_HII_CONFIG_ACCESS_H__\r | |
22 | \r | |
7d582d6b | 23 | #include <Protocol/FormBrowser2.h>\r |
1528fae8 | 24 | \r |
5a1fc221 | 25 | #define EFI_HII_CONFIG_ACCESS_PROTOCOL_GUID \\r |
d1f95000 | 26 | { 0x330d4706, 0xf2a0, 0x4e4f, { 0xa3, 0x69, 0xb6, 0x6f, 0xa8, 0xd5, 0x43, 0x85 } }\r |
27 | \r | |
28 | typedef struct _EFI_HII_CONFIG_ACCESS_PROTOCOL EFI_HII_CONFIG_ACCESS_PROTOCOL;\r | |
29 | \r | |
7d582d6b | 30 | typedef UINTN EFI_BROWSER_ACTION;\r |
31 | \r | |
0cd118f7 LG |
32 | #define EFI_BROWSER_ACTION_CHANGING 0\r |
33 | #define EFI_BROWSER_ACTION_CHANGED 1\r | |
34 | #define EFI_BROWSER_ACTION_RETRIEVE 2\r | |
35 | #define EFI_BROWSER_ACTION_FORM_OPEN 3\r | |
36 | #define EFI_BROWSER_ACTION_FORM_CLOSE 4\r | |
7d582d6b | 37 | \r |
d1f95000 | 38 | /**\r |
39 | \r | |
40 | This function allows the caller to request the current\r | |
41 | configuration for one or more named elements. The resulting\r | |
42 | string is in <ConfigAltResp> format. Any and all alternative\r | |
43 | configuration strings shall also be appended to the end of the\r | |
44 | current configuration string. If they are, they must appear\r | |
45 | after the current configuration. They must contain the same\r | |
46 | routing (GUID, NAME, PATH) as the current configuration string.\r | |
47 | They must have an additional description indicating the type of\r | |
48 | alternative configuration the string represents,\r | |
49 | "ALTCFG=<StringToken>". That <StringToken> (when\r | |
50 | converted from Hex UNICODE to binary) is a reference to a\r | |
51 | string in the associated string pack.\r | |
52 | \r | |
4ca9b6c4 | 53 | @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r |
d1f95000 | 54 | \r |
4ca9b6c4 LG |
55 | @param Request A null-terminated Unicode string in\r |
56 | <ConfigRequest> format. Note that this\r | |
57 | includes the routing information as well as\r | |
58 | the configurable name / value pairs. It is\r | |
59 | invalid for this string to be in\r | |
60 | <MultiConfigRequest> format.\r | |
d1f95000 | 61 | \r |
62 | @param Progress On return, points to a character in the\r | |
63 | Request string. Points to the string's null\r | |
64 | terminator if request was successful. Points\r | |
65 | to the most recent "&" before the first\r | |
66 | failing name / value pair (or the beginning\r | |
67 | of the string if the failure is in the first\r | |
68 | name / value pair) if the request was not\r | |
69 | successful\r | |
70 | \r | |
4ca9b6c4 LG |
71 | @param Results A null-terminated Unicode string in\r |
72 | <ConfigAltResp> format which has all values\r | |
73 | filled in for the names in the Request string.\r | |
74 | String to be allocated by the called function.\r | |
d1f95000 | 75 | \r |
4ca9b6c4 LG |
76 | @retval EFI_SUCCESS The Results string is filled with the\r |
77 | values corresponding to all requested\r | |
78 | names.\r | |
d1f95000 | 79 | \r |
e1f1fb16 | 80 | @retval EFI_OUT_OF_RESOURCES Not enough memory to store the\r |
4ca9b6c4 LG |
81 | parts of the results that must be\r |
82 | stored awaiting possible future\r | |
83 | protocols.\r | |
d1f95000 | 84 | \r |
85 | @retval EFI_INVALID_PARAMETER For example, passing in a NULL\r | |
86 | for the Request parameter\r | |
87 | would result in this type of\r | |
88 | error. In this case, the\r | |
89 | Progress parameter would be\r | |
90 | set to NULL. \r | |
91 | \r | |
4ca9b6c4 LG |
92 | @retval EFI_NOT_FOUND Routing data doesn't match any\r |
93 | known driver. Progress set to the\r | |
94 | first character in the routing header.\r | |
95 | Note: There is no requirement that the\r | |
96 | driver validate the routing data. It\r | |
97 | must skip the <ConfigHdr> in order to\r | |
98 | process the names.\r | |
d1f95000 | 99 | \r |
100 | @retval EFI_INVALID_PARAMETER Illegal syntax. Progress set\r | |
630b4187 | 101 | to most recent "&" before the\r |
d1f95000 | 102 | error or the beginning of the\r |
103 | string.\r | |
104 | \r | |
105 | @retval EFI_INVALID_PARAMETER Unknown name. Progress points\r | |
106 | to the & before the name in\r | |
107 | question.\r | |
108 | \r | |
109 | **/\r | |
110 | typedef\r | |
111 | EFI_STATUS\r | |
8b13229b | 112 | (EFIAPI * EFI_HII_ACCESS_EXTRACT_CONFIG)(\r |
d1f95000 | 113 | IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r |
114 | IN CONST EFI_STRING Request,\r | |
115 | OUT EFI_STRING *Progress,\r | |
116 | OUT EFI_STRING *Results\r | |
117 | );\r | |
118 | \r | |
119 | \r | |
120 | /**\r | |
121 | \r | |
122 | This function applies changes in a driver's configuration.\r | |
123 | Input is a Configuration, which has the routing data for this\r | |
124 | driver followed by name / value configuration pairs. The driver\r | |
125 | must apply those pairs to its configurable storage. If the\r | |
126 | driver's configuration is stored in a linear block of data\r | |
1cea34d4 | 127 | and the driver's name / value pairs are in <BlockConfig>\r |
d1f95000 | 128 | format, it may use the ConfigToBlock helper function (above) to\r |
129 | simplify the job.\r | |
130 | \r | |
4ca9b6c4 | 131 | @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r |
d1f95000 | 132 | \r |
133 | @param Configuration A null-terminated Unicode string in\r | |
4ca9b6c4 LG |
134 | <ConfigString> format. \r |
135 | \r | |
136 | @param Progress A pointer to a string filled in with the\r | |
d1f95000 | 137 | offset of the most recent '&' before the\r |
138 | first failing name / value pair (or the\r | |
139 | beginn ing of the string if the failure\r | |
140 | is in the first name / value pair) or\r | |
141 | the terminating NULL if all was\r | |
142 | successful.\r | |
143 | \r | |
4ca9b6c4 LG |
144 | @retval EFI_SUCCESS The results have been distributed or are\r |
145 | awaiting distribution.\r | |
d1f95000 | 146 | \r |
e1f1fb16 | 147 | @retval EFI_OUT_OF_RESOURCES Not enough memory to store the\r |
4ca9b6c4 LG |
148 | parts of the results that must be\r |
149 | stored awaiting possible future\r | |
150 | protocols.\r | |
d1f95000 | 151 | \r |
152 | @retval EFI_INVALID_PARAMETERS Passing in a NULL for the\r | |
153 | Results parameter would result\r | |
154 | in this type of error.\r | |
155 | \r | |
4ca9b6c4 LG |
156 | @retval EFI_NOT_FOUND Target for the specified routing data\r |
157 | was not found\r | |
d1f95000 | 158 | \r |
159 | **/\r | |
160 | typedef\r | |
161 | EFI_STATUS\r | |
8b13229b | 162 | (EFIAPI * EFI_HII_ACCESS_ROUTE_CONFIG)(\r |
d1f95000 | 163 | IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r |
164 | IN CONST EFI_STRING Configuration,\r | |
165 | OUT EFI_STRING *Progress\r | |
166 | );\r | |
167 | \r | |
168 | /**\r | |
169 | \r | |
170 | This function is called to provide results data to the driver.\r | |
171 | This data consists of a unique key that is used to identify\r | |
172 | which data is either being passed back or being asked for.\r | |
173 | \r | |
4ca9b6c4 LG |
174 | @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r |
175 | @param Action Specifies the type of action taken by the browser.\r | |
176 | @param QuestionId A unique value which is sent to the original\r | |
177 | exporting driver so that it can identify the type\r | |
178 | of data to expect. The format of the data tends to \r | |
630b4187 | 179 | vary based on the opcode that generated the callback.\r |
4ca9b6c4 LG |
180 | @param Type The type of value for the question.\r |
181 | @param Value A pointer to the data being sent to the original\r | |
182 | exporting driver.\r | |
183 | @param ActionRequest On return, points to the action requested by the\r | |
184 | callback function.\r | |
185 | \r | |
186 | @retval EFI_SUCCESS The callback successfully handled the action.\r | |
187 | @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the\r | |
188 | variable and its data.\r | |
189 | @retval EFI_DEVICE_ERROR The variable could not be saved.\r | |
190 | @retval EFI_UNSUPPORTED The specified Action is not supported by the\r | |
191 | callback.\r | |
d1f95000 | 192 | **/\r |
193 | typedef\r | |
194 | EFI_STATUS\r | |
8b13229b | 195 | (EFIAPI *EFI_HII_ACCESS_FORM_CALLBACK)(\r |
0cd118f7 LG |
196 | IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r |
197 | IN EFI_BROWSER_ACTION Action,\r | |
198 | IN EFI_QUESTION_ID QuestionId,\r | |
199 | IN UINT8 Type,\r | |
200 | IN OUT EFI_IFR_TYPE_VALUE *Value,\r | |
201 | OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest\r | |
5a1fc221 | 202 | )\r |
203 | ;\r | |
721b16af | 204 | \r |
44717a39 | 205 | ///\r |
206 | /// This protocol provides a callable interface between the HII and\r | |
207 | /// drivers. Only drivers which provide IFR data to HII are required\r | |
208 | /// to publish this protocol.\r | |
209 | ///\r | |
d1f95000 | 210 | struct _EFI_HII_CONFIG_ACCESS_PROTOCOL {\r |
5a1fc221 | 211 | EFI_HII_ACCESS_EXTRACT_CONFIG ExtractConfig;\r |
212 | EFI_HII_ACCESS_ROUTE_CONFIG RouteConfig;\r | |
213 | EFI_HII_ACCESS_FORM_CALLBACK Callback;\r | |
d1f95000 | 214 | } ;\r |
215 | \r | |
216 | extern EFI_GUID gEfiHiiConfigAccessProtocolGuid;\r | |
217 | \r | |
218 | #endif\r | |
219 | \r | |
7d582d6b | 220 | \r |