projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 7936fb6a | 1 | /** @file\r |
| d66e6c16 | 2 | Private MACRO, structure and function definitions for Setup Browser module.\r |
| 7936fb6a | 3 | \r |
| e5eed7d3 HT |
4 | Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r |
| 5 | This program and the accompanying materials\r | |
| 7936fb6a | 6 | are licensed and made available under the terms and conditions of the BSD License\r |
| 7 | which accompanies this distribution. The full text of the license may be found at\r | |
| 8 | http://opensource.org/licenses/bsd-license.php\r | |
| 9 | \r | |
| 10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
| 11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
| 12 | \r | |
| 13 | \r | |
| 14 | **/\r | |
| 15 | \r | |
| 16 | #ifndef _SETUP_H_\r | |
| 17 | #define _SETUP_H_\r | |
| 18 | \r | |
| 19 | \r | |
| 39099938 | 20 | #include <PiDxe.h>\r |
| 7936fb6a | 21 | \r |
| 7936fb6a | 22 | #include <Protocol/SimpleTextOut.h>\r |
| 23 | #include <Protocol/SimpleTextIn.h>\r | |
| 24 | #include <Protocol/FormBrowser2.h>\r | |
| 25 | #include <Protocol/DevicePath.h>\r | |
| 26 | #include <Protocol/UnicodeCollation.h>\r | |
| 27 | #include <Protocol/HiiConfigAccess.h>\r | |
| 28 | #include <Protocol/HiiConfigRouting.h>\r | |
| 29 | #include <Protocol/HiiDatabase.h>\r | |
| 30 | #include <Protocol/HiiString.h>\r | |
| cbf73e50 | 31 | #include <Protocol/UserManager.h>\r |
| 7936fb6a | 32 | \r |
| 5c526736 | 33 | #include <Guid/MdeModuleHii.h>\r |
| 0a1147ed | 34 | #include <Guid/HiiPlatformSetupFormset.h>\r |
| 2573712e | 35 | #include <Guid/HiiFormMapMethodGuid.h>\r |
| 7936fb6a | 36 | \r |
| 7936fb6a | 37 | #include <Library/PrintLib.h>\r |
| 38 | #include <Library/DebugLib.h>\r | |
| 39 | #include <Library/BaseMemoryLib.h>\r | |
| 40 | #include <Library/UefiRuntimeServicesTableLib.h>\r | |
| 41 | #include <Library/UefiDriverEntryPoint.h>\r | |
| 42 | #include <Library/UefiBootServicesTableLib.h>\r | |
| 43 | #include <Library/BaseLib.h>\r | |
| 44 | #include <Library/MemoryAllocationLib.h>\r | |
| 7936fb6a | 45 | #include <Library/HiiLib.h>\r |
| f511d656 | 46 | #include <Library/PcdLib.h>\r |
| cb7d01c0 | 47 | #include <Library/DevicePathLib.h>\r |
| 7936fb6a | 48 | \r |
| 49 | #include "Colors.h"\r | |
| 50 | \r | |
| 51 | //\r | |
| 52 | // This is the generated header file which includes whatever needs to be exported (strings + IFR)\r | |
| 53 | //\r | |
| 54 | \r | |
| 55 | extern UINT8 SetupBrowserStrings[];\r | |
| 56 | \r | |
| 57 | //\r | |
| 58 | // Screen definitions\r | |
| 59 | //\r | |
| 60 | #define BANNER_HEIGHT 6\r | |
| 61 | #define BANNER_COLUMNS 3\r | |
| c3161b25 | 62 | #define BANNER_LEFT_COLUMN_INDENT 1\r |
| 7936fb6a | 63 | \r |
| 64 | #define FRONT_PAGE_HEADER_HEIGHT 6\r | |
| 65 | #define NONE_FRONT_PAGE_HEADER_HEIGHT 3\r | |
| b6ca1fd8 | 66 | #define LEFT_SKIPPED_COLUMNS 3\r |
| 7936fb6a | 67 | #define FOOTER_HEIGHT 4\r |
| 68 | #define STATUS_BAR_HEIGHT 1\r | |
| 69 | #define SCROLL_ARROW_HEIGHT 1\r | |
| 70 | #define POPUP_PAD_SPACE_COUNT 5\r | |
| 71 | #define POPUP_FRAME_WIDTH 2\r | |
| 72 | \r | |
| 73 | //\r | |
| 74 | // Definition for function key setting\r | |
| 75 | //\r | |
| 76 | #define NONE_FUNCTION_KEY_SETTING 0\r | |
| 8b0fc5c1 | 77 | #define DEFAULT_FUNCTION_KEY_SETTING (FUNCTION_NINE | FUNCTION_TEN)\r |
| 7936fb6a | 78 | \r |
| 7936fb6a | 79 | #define FUNCTION_NINE (1 << 2)\r |
| 80 | #define FUNCTION_TEN (1 << 3)\r | |
| 81 | \r | |
| 82 | typedef struct {\r | |
| 83 | EFI_GUID FormSetGuid;\r | |
| 84 | UINTN KeySetting;\r | |
| 85 | } FUNCTIION_KEY_SETTING;\r | |
| 86 | \r | |
| 87 | //\r | |
| 88 | // Character definitions\r | |
| 89 | //\r | |
| 90 | #define CHAR_SPACE 0x0020\r | |
| 91 | #define UPPER_LOWER_CASE_OFFSET 0x20\r | |
| 92 | \r | |
| 93 | //\r | |
| 94 | // Time definitions\r | |
| 95 | //\r | |
| 96 | #define ONE_SECOND 10000000\r | |
| 97 | \r | |
| 98 | //\r | |
| 99 | // Display definitions\r | |
| 100 | //\r | |
| 101 | #define LEFT_HYPER_DELIMITER L'<'\r | |
| 102 | #define RIGHT_HYPER_DELIMITER L'>'\r | |
| 103 | \r | |
| 104 | #define LEFT_ONEOF_DELIMITER L'<'\r | |
| 105 | #define RIGHT_ONEOF_DELIMITER L'>'\r | |
| 106 | \r | |
| 107 | #define LEFT_NUMERIC_DELIMITER L'['\r | |
| 108 | #define RIGHT_NUMERIC_DELIMITER L']'\r | |
| 109 | \r | |
| 110 | #define LEFT_CHECKBOX_DELIMITER L'['\r | |
| 111 | #define RIGHT_CHECKBOX_DELIMITER L']'\r | |
| 112 | \r | |
| 113 | #define CHECK_ON L'X'\r | |
| 114 | #define CHECK_OFF L' '\r | |
| 115 | \r | |
| 116 | #define TIME_SEPARATOR L':'\r | |
| 117 | #define DATE_SEPARATOR L'/'\r | |
| 118 | \r | |
| 119 | #define YES_ANSWER L'Y'\r | |
| 120 | #define NO_ANSWER L'N'\r | |
| 121 | \r | |
| 122 | //\r | |
| 123 | // This is the Input Error Message\r | |
| 124 | //\r | |
| 125 | #define INPUT_ERROR 1\r | |
| 126 | \r | |
| 127 | //\r | |
| 128 | // This is the NV RAM update required Message\r | |
| 129 | //\r | |
| 130 | #define NV_UPDATE_REQUIRED 2\r | |
| 131 | \r | |
| 132 | //\r | |
| 133 | // Refresh the Status Bar with flags\r | |
| 134 | //\r | |
| 135 | #define REFRESH_STATUS_BAR 0xff\r | |
| 136 | \r | |
| 137 | //\r | |
| 138 | // Incremental string lenght of ConfigRequest\r | |
| 139 | //\r | |
| 140 | #define CONFIG_REQUEST_STRING_INCREMENTAL 1024\r | |
| 141 | \r | |
| 142 | //\r | |
| 143 | // HII value compare result\r | |
| 144 | //\r | |
| 145 | #define HII_VALUE_UNDEFINED 0\r | |
| 146 | #define HII_VALUE_EQUAL 1\r | |
| 147 | #define HII_VALUE_LESS_THAN 2\r | |
| 148 | #define HII_VALUE_GREATER_THAN 3\r | |
| 149 | \r | |
| 150 | //\r | |
| 151 | // Incremental size of stack for expression\r | |
| 152 | //\r | |
| 153 | #define EXPRESSION_STACK_SIZE_INCREMENT 0x100\r | |
| 154 | \r | |
| 77dfa7c7 | 155 | #define EFI_SPECIFICATION_MAJOR_VERSION 0x2\r |
| 156 | #define EFI_SPECIFICATION_MINOR_VERSION 0x1\r | |
| 157 | #define EFI_SPECIFICATION_ERRATA_VERSION 0x0\r | |
| 158 | #define EFI_IFR_SPECIFICATION_VERSION (UINT16)((EFI_SPECIFICATION_MAJOR_VERSION << 8) | (EFI_SPECIFICATION_MINOR_VERSION << 4) | EFI_SPECIFICATION_ERRATA_VERSION)\r | |
| 7936fb6a | 159 | \r |
| 7936fb6a | 160 | \r |
| f3f2e05d | 161 | #define SETUP_DRIVER_SIGNATURE SIGNATURE_32 ('F', 'B', 'D', 'V')\r |
| 7936fb6a | 162 | typedef struct {\r |
| 163 | UINT32 Signature;\r | |
| 164 | \r | |
| 165 | EFI_HANDLE Handle;\r | |
| 166 | \r | |
| 167 | //\r | |
| 168 | // Produced protocol\r | |
| 169 | //\r | |
| 170 | EFI_FORM_BROWSER2_PROTOCOL FormBrowser2;\r | |
| 7936fb6a | 171 | \r |
| 172 | } SETUP_DRIVER_PRIVATE_DATA;\r | |
| 173 | \r | |
| 174 | typedef struct {\r | |
| 175 | EFI_STRING_ID Banner[BANNER_HEIGHT][BANNER_COLUMNS];\r | |
| 176 | } BANNER_DATA;\r | |
| 177 | \r | |
| 178 | //\r | |
| 179 | // IFR relative definition\r | |
| 180 | //\r | |
| 181 | #define EFI_HII_EXPRESSION_INCONSISTENT_IF 0\r | |
| 182 | #define EFI_HII_EXPRESSION_NO_SUBMIT_IF 1\r | |
| 183 | #define EFI_HII_EXPRESSION_GRAY_OUT_IF 2\r | |
| 184 | #define EFI_HII_EXPRESSION_SUPPRESS_IF 3\r | |
| 185 | #define EFI_HII_EXPRESSION_DISABLE_IF 4\r | |
| 186 | #define EFI_HII_EXPRESSION_VALUE 5\r | |
| 187 | #define EFI_HII_EXPRESSION_RULE 6\r | |
| 2573712e LG |
188 | #define EFI_HII_EXPRESSION_READ 7\r |
| 189 | #define EFI_HII_EXPRESSION_WRITE 8\r | |
| 7936fb6a | 190 | \r |
| 191 | #define EFI_HII_VARSTORE_BUFFER 0\r | |
| 192 | #define EFI_HII_VARSTORE_NAME_VALUE 1\r | |
| 193 | #define EFI_HII_VARSTORE_EFI_VARIABLE 2\r | |
| 194 | \r | |
| 195 | #define FORM_INCONSISTENT_VALIDATION 0\r | |
| 196 | #define FORM_NO_SUBMIT_VALIDATION 1\r | |
| 197 | \r | |
| 40245175 LG |
198 | #define FORMSET_CLASS_PLATFORM_SETUP 0x0001\r |
| 199 | #define FORMSET_CLASS_FRONT_PAGE 0x0002\r | |
| 0a1147ed | 200 | \r |
| 7936fb6a | 201 | typedef struct {\r |
| 202 | UINT8 Type;\r | |
| 203 | EFI_IFR_TYPE_VALUE Value;\r | |
| 204 | } EFI_HII_VALUE;\r | |
| 205 | \r | |
| f3f2e05d | 206 | #define NAME_VALUE_NODE_SIGNATURE SIGNATURE_32 ('N', 'V', 'S', 'T')\r |
| 7936fb6a | 207 | \r |
| 208 | typedef struct {\r | |
| 209 | UINTN Signature;\r | |
| 210 | LIST_ENTRY Link;\r | |
| 211 | CHAR16 *Name;\r | |
| 212 | CHAR16 *Value;\r | |
| 213 | CHAR16 *EditValue;\r | |
| 214 | } NAME_VALUE_NODE;\r | |
| 215 | \r | |
| 216 | #define NAME_VALUE_NODE_FROM_LINK(a) CR (a, NAME_VALUE_NODE, Link, NAME_VALUE_NODE_SIGNATURE)\r | |
| 217 | \r | |
| f3f2e05d | 218 | #define FORMSET_STORAGE_SIGNATURE SIGNATURE_32 ('F', 'S', 'T', 'G')\r |
| 7936fb6a | 219 | \r |
| 220 | typedef struct {\r | |
| 221 | UINTN Signature;\r | |
| 222 | LIST_ENTRY Link;\r | |
| 223 | \r | |
| 224 | UINT8 Type; // Storage type\r | |
| 225 | \r | |
| 226 | UINT16 VarStoreId;\r | |
| 227 | EFI_GUID Guid;\r | |
| 228 | \r | |
| 229 | CHAR16 *Name; // For EFI_IFR_VARSTORE\r | |
| 230 | UINT16 Size;\r | |
| 231 | UINT8 *Buffer;\r | |
| 232 | UINT8 *EditBuffer; // Edit copy for Buffer Storage\r | |
| 233 | \r | |
| 234 | LIST_ENTRY NameValueListHead; // List of NAME_VALUE_NODE\r | |
| 235 | \r | |
| 236 | UINT32 Attributes; // For EFI_IFR_VARSTORE_EFI: EFI Variable attribute\r | |
| 237 | \r | |
| 238 | CHAR16 *ConfigHdr; // <ConfigHdr>\r | |
| 239 | CHAR16 *ConfigRequest; // <ConfigRequest> = <ConfigHdr> + <RequestElement>\r | |
| 240 | UINTN ElementCount; // Number of <RequestElement> in the <ConfigRequest>\r | |
| 241 | UINTN SpareStrLen; // Spare length of ConfigRequest string buffer\r | |
| 242 | } FORMSET_STORAGE;\r | |
| 243 | \r | |
| 244 | #define FORMSET_STORAGE_FROM_LINK(a) CR (a, FORMSET_STORAGE, Link, FORMSET_STORAGE_SIGNATURE)\r | |
| 245 | \r | |
| 2573712e LG |
246 | typedef union {\r |
| 247 | EFI_STRING_ID VarName;\r | |
| 248 | UINT16 VarOffset;\r | |
| 249 | } VAR_STORE_INFO;\r | |
| 250 | \r | |
| f3f2e05d | 251 | #define EXPRESSION_OPCODE_SIGNATURE SIGNATURE_32 ('E', 'X', 'O', 'P')\r |
| 7936fb6a | 252 | \r |
| 253 | typedef struct {\r | |
| 254 | UINTN Signature;\r | |
| 255 | LIST_ENTRY Link;\r | |
| 256 | \r | |
| 257 | UINT8 Operand;\r | |
| 258 | \r | |
| 259 | UINT8 Format; // For EFI_IFR_TO_STRING, EFI_IFR_FIND\r | |
| 260 | UINT8 Flags; // For EFI_IFR_SPAN\r | |
| 261 | UINT8 RuleId; // For EFI_IFR_RULE_REF\r | |
| 262 | \r | |
| 263 | EFI_HII_VALUE Value; // For EFI_IFR_EQ_ID_VAL, EFI_IFR_UINT64, EFI_IFR_UINT32, EFI_IFR_UINT16, EFI_IFR_UINT8, EFI_IFR_STRING_REF1\r | |
| 264 | \r | |
| 2654f642 | 265 | EFI_QUESTION_ID QuestionId; // For EFI_IFR_EQ_ID_ID, EFI_IFR_EQ_ID_VAL_LIST, EFI_IFR_QUESTION_REF1\r |
| 7936fb6a | 266 | EFI_QUESTION_ID QuestionId2;\r |
| 267 | \r | |
| 2654f642 | 268 | UINT16 ListLength; // For EFI_IFR_EQ_ID_VAL_LIST\r |
| 7936fb6a | 269 | UINT16 *ValueList;\r |
| 270 | \r | |
| 271 | EFI_STRING_ID DevicePath; // For EFI_IFR_QUESTION_REF3_2, EFI_IFR_QUESTION_REF3_3\r | |
| 272 | EFI_GUID Guid;\r | |
| 2573712e LG |
273 | \r |
| 274 | FORMSET_STORAGE *VarStorage; // For EFI_IFR_SET, EFI_IFR_GET\r | |
| 275 | VAR_STORE_INFO VarStoreInfo;// For EFI_IFR_SET, EFI_IFR_GET\r | |
| 276 | UINT8 ValueType; // For EFI_IFR_SET, EFI_IFR_GET\r | |
| 277 | UINT8 ValueWidth; // For EFI_IFR_SET, EFI_IFR_GET\r | |
| 278 | CHAR16 *ValueName; // For EFI_IFR_SET, EFI_IFR_GET\r | |
| 279 | LIST_ENTRY MapExpressionList; // nested expressions inside of Map opcode.\r | |
| 7936fb6a | 280 | } EXPRESSION_OPCODE;\r |
| 281 | \r | |
| 282 | #define EXPRESSION_OPCODE_FROM_LINK(a) CR (a, EXPRESSION_OPCODE, Link, EXPRESSION_OPCODE_SIGNATURE)\r | |
| 283 | \r | |
| f3f2e05d | 284 | #define FORM_EXPRESSION_SIGNATURE SIGNATURE_32 ('F', 'E', 'X', 'P')\r |
| 7936fb6a | 285 | \r |
| 286 | typedef struct {\r | |
| 287 | UINTN Signature;\r | |
| 288 | LIST_ENTRY Link;\r | |
| 289 | \r | |
| 290 | UINT8 Type; // Type for this expression\r | |
| 291 | \r | |
| 292 | UINT8 RuleId; // For EFI_IFR_RULE only\r | |
| 293 | EFI_STRING_ID Error; // For EFI_IFR_NO_SUBMIT_IF, EFI_IFR_INCONSISTENT_IF only\r | |
| 294 | \r | |
| 295 | EFI_HII_VALUE Result; // Expression evaluation result\r | |
| 296 | \r | |
| 297 | LIST_ENTRY OpCodeListHead; // OpCodes consist of this expression (EXPRESSION_OPCODE)\r | |
| 298 | } FORM_EXPRESSION;\r | |
| 299 | \r | |
| 300 | #define FORM_EXPRESSION_FROM_LINK(a) CR (a, FORM_EXPRESSION, Link, FORM_EXPRESSION_SIGNATURE)\r | |
| 301 | \r | |
| f3f2e05d | 302 | #define QUESTION_DEFAULT_SIGNATURE SIGNATURE_32 ('Q', 'D', 'F', 'T')\r |
| 7936fb6a | 303 | \r |
| 304 | typedef struct {\r | |
| 305 | UINTN Signature;\r | |
| 306 | LIST_ENTRY Link;\r | |
| 307 | \r | |
| 308 | UINT16 DefaultId;\r | |
| 309 | EFI_HII_VALUE Value; // Default value\r | |
| 310 | \r | |
| 311 | FORM_EXPRESSION *ValueExpression; // Not-NULL indicates default value is provided by EFI_IFR_VALUE\r | |
| 312 | } QUESTION_DEFAULT;\r | |
| 313 | \r | |
| 314 | #define QUESTION_DEFAULT_FROM_LINK(a) CR (a, QUESTION_DEFAULT, Link, QUESTION_DEFAULT_SIGNATURE)\r | |
| 315 | \r | |
| f3f2e05d | 316 | #define QUESTION_OPTION_SIGNATURE SIGNATURE_32 ('Q', 'O', 'P', 'T')\r |
| 7936fb6a | 317 | \r |
| 318 | typedef struct {\r | |
| 319 | UINTN Signature;\r | |
| 320 | LIST_ENTRY Link;\r | |
| 321 | \r | |
| 322 | EFI_STRING_ID Text;\r | |
| 323 | UINT8 Flags;\r | |
| 324 | EFI_HII_VALUE Value;\r | |
| 325 | EFI_IMAGE_ID ImageId;\r | |
| 326 | \r | |
| 327 | FORM_EXPRESSION *SuppressExpression; // Non-NULL indicates nested inside of SuppressIf\r | |
| 328 | } QUESTION_OPTION;\r | |
| 329 | \r | |
| 330 | #define QUESTION_OPTION_FROM_LINK(a) CR (a, QUESTION_OPTION, Link, QUESTION_OPTION_SIGNATURE)\r | |
| 331 | \r | |
| f3f2e05d | 332 | #define FORM_BROWSER_STATEMENT_SIGNATURE SIGNATURE_32 ('F', 'S', 'T', 'A')\r |
| 1ccdbf2a | 333 | \r |
| 7936fb6a | 334 | typedef struct {\r |
| 335 | UINTN Signature;\r | |
| 336 | LIST_ENTRY Link;\r | |
| 337 | \r | |
| 338 | UINT8 Operand; // The operand (first byte) of this Statement or Question\r | |
| 339 | \r | |
| 340 | //\r | |
| 341 | // Statement Header\r | |
| 342 | //\r | |
| 343 | EFI_STRING_ID Prompt;\r | |
| 344 | EFI_STRING_ID Help;\r | |
| 345 | EFI_STRING_ID TextTwo; // For EFI_IFR_TEXT\r | |
| 346 | \r | |
| 347 | //\r | |
| 348 | // Question Header\r | |
| 349 | //\r | |
| 350 | EFI_QUESTION_ID QuestionId; // The value of zero is reserved\r | |
| 351 | EFI_VARSTORE_ID VarStoreId; // A value of zero indicates no variable storage\r | |
| 352 | FORMSET_STORAGE *Storage;\r | |
| 1ccdbf2a | 353 | VAR_STORE_INFO VarStoreInfo;\r |
| 7936fb6a | 354 | UINT16 StorageWidth;\r |
| 355 | UINT8 QuestionFlags;\r | |
| 356 | CHAR16 *VariableName; // Name/Value or EFI Variable name\r | |
| 357 | CHAR16 *BlockName; // Buffer storage block name: "OFFSET=...WIDTH=..."\r | |
| 358 | \r | |
| 359 | EFI_HII_VALUE HiiValue; // Edit copy for checkbox, numberic, oneof\r | |
| 360 | UINT8 *BufferValue; // Edit copy for string, password, orderedlist\r | |
| d02847d3 | 361 | UINT8 ValueType; // Data type for orderedlist value array\r |
| 7936fb6a | 362 | \r |
| 363 | //\r | |
| 364 | // OpCode specific members\r | |
| 365 | //\r | |
| 366 | UINT8 Flags; // for EFI_IFR_CHECKBOX, EFI_IFR_DATE, EFI_IFR_NUMERIC, EFI_IFR_ONE_OF,\r | |
| 367 | // EFI_IFR_ORDERED_LIST, EFI_IFR_STRING,EFI_IFR_SUBTITLE,EFI_IFR_TIME, EFI_IFR_BANNER\r | |
| 368 | UINT8 MaxContainers; // for EFI_IFR_ORDERED_LIST\r | |
| 369 | \r | |
| 370 | UINT16 BannerLineNumber; // for EFI_IFR_BANNER, 1-based line number\r | |
| 371 | EFI_STRING_ID QuestionConfig; // for EFI_IFR_ACTION, if 0 then no configuration string will be processed\r | |
| 372 | \r | |
| 373 | UINT64 Minimum; // for EFI_IFR_ONE_OF/EFI_IFR_NUMERIC, it's Min/Max value\r | |
| 374 | UINT64 Maximum; // for EFI_IFR_STRING/EFI_IFR_PASSWORD, it's Min/Max length\r | |
| 375 | UINT64 Step;\r | |
| 376 | \r | |
| 377 | EFI_DEFAULT_ID DefaultId; // for EFI_IFR_RESET_BUTTON\r | |
| 378 | EFI_FORM_ID RefFormId; // for EFI_IFR_REF\r | |
| 379 | EFI_QUESTION_ID RefQuestionId; // for EFI_IFR_REF2\r | |
| 380 | EFI_GUID RefFormSetId; // for EFI_IFR_REF3\r | |
| 381 | EFI_STRING_ID RefDevicePath; // for EFI_IFR_REF4\r | |
| 382 | \r | |
| 383 | //\r | |
| 384 | // Get from IFR parsing\r | |
| 385 | //\r | |
| 386 | FORM_EXPRESSION *ValueExpression; // nested EFI_IFR_VALUE, provide Question value and indicate Question is ReadOnly\r | |
| 387 | LIST_ENTRY DefaultListHead; // nested EFI_IFR_DEFAULT list (QUESTION_DEFAULT), provide default values\r | |
| 388 | LIST_ENTRY OptionListHead; // nested EFI_IFR_ONE_OF_OPTION list (QUESTION_OPTION)\r | |
| 389 | \r | |
| 390 | EFI_IMAGE_ID ImageId; // nested EFI_IFR_IMAGE\r | |
| 391 | UINT8 RefreshInterval; // nested EFI_IFR_REFRESH, refresh interval(in seconds) for Question value, 0 means no refresh\r | |
| 392 | BOOLEAN InSubtitle; // nesting inside of EFI_IFR_SUBTITLE\r | |
| 393 | \r | |
| 394 | LIST_ENTRY InconsistentListHead;// nested inconsistent expression list (FORM_EXPRESSION)\r | |
| 395 | LIST_ENTRY NoSubmitListHead; // nested nosubmit expression list (FORM_EXPRESSION)\r | |
| 396 | FORM_EXPRESSION *GrayOutExpression; // nesting inside of GrayOutIf\r | |
| 397 | FORM_EXPRESSION *SuppressExpression; // nesting inside of SuppressIf\r | |
| 0a1147ed | 398 | FORM_EXPRESSION *DisableExpression; // nesting inside of DisableIf\r |
| 7936fb6a | 399 | \r |
| 2573712e LG |
400 | FORM_EXPRESSION *ReadExpression; // nested EFI_IFR_READ, provide this question value by read expression.\r |
| 401 | FORM_EXPRESSION *WriteExpression; // nested EFI_IFR_WRITE, evaluate write expression after this question value is set.\r | |
| 7936fb6a | 402 | } FORM_BROWSER_STATEMENT;\r |
| 403 | \r | |
| 404 | #define FORM_BROWSER_STATEMENT_FROM_LINK(a) CR (a, FORM_BROWSER_STATEMENT, Link, FORM_BROWSER_STATEMENT_SIGNATURE)\r | |
| 405 | \r | |
| f3f2e05d | 406 | #define FORM_BROWSER_FORM_SIGNATURE SIGNATURE_32 ('F', 'F', 'R', 'M')\r |
| 2573712e | 407 | #define STANDARD_MAP_FORM_TYPE 0x01\r |
| 7936fb6a | 408 | \r |
| 409 | typedef struct {\r | |
| 410 | UINTN Signature;\r | |
| 411 | LIST_ENTRY Link;\r | |
| 412 | \r | |
| 2573712e LG |
413 | UINT16 FormId; // FormId of normal form or formmap form.\r |
| 414 | EFI_STRING_ID FormTitle; // FormTile of normal form, or FormMapMethod title of formmap form.\r | |
| 415 | UINT16 FormType; // Specific form type for the different form.\r | |
| 7936fb6a | 416 | \r |
| 417 | EFI_IMAGE_ID ImageId;\r | |
| 418 | \r | |
| 419 | LIST_ENTRY ExpressionListHead; // List of Expressions (FORM_EXPRESSION)\r | |
| 420 | LIST_ENTRY StatementListHead; // List of Statements and Questions (FORM_BROWSER_STATEMENT)\r | |
| 0c66bc76 | 421 | FORM_EXPRESSION *SuppressExpression; // nesting inside of SuppressIf\r |
| 7936fb6a | 422 | } FORM_BROWSER_FORM;\r |
| 423 | \r | |
| 424 | #define FORM_BROWSER_FORM_FROM_LINK(a) CR (a, FORM_BROWSER_FORM, Link, FORM_BROWSER_FORM_SIGNATURE)\r | |
| 425 | \r | |
| f3f2e05d | 426 | #define FORMSET_DEFAULTSTORE_SIGNATURE SIGNATURE_32 ('F', 'D', 'F', 'S')\r |
| 7936fb6a | 427 | \r |
| 428 | typedef struct {\r | |
| 429 | UINTN Signature;\r | |
| 430 | LIST_ENTRY Link;\r | |
| 431 | \r | |
| 432 | UINT16 DefaultId;\r | |
| 433 | EFI_STRING_ID DefaultName;\r | |
| 434 | } FORMSET_DEFAULTSTORE;\r | |
| 435 | \r | |
| 436 | #define FORMSET_DEFAULTSTORE_FROM_LINK(a) CR (a, FORMSET_DEFAULTSTORE, Link, FORMSET_DEFAULTSTORE_SIGNATURE)\r | |
| 437 | \r | |
| 438 | typedef struct {\r | |
| 439 | EFI_HII_HANDLE HiiHandle;\r | |
| 440 | EFI_HANDLE DriverHandle;\r | |
| 441 | EFI_HII_CONFIG_ACCESS_PROTOCOL *ConfigAccess;\r | |
| 442 | EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r | |
| 443 | \r | |
| 444 | UINTN IfrBinaryLength;\r | |
| 445 | UINT8 *IfrBinaryData;\r | |
| 446 | \r | |
| 447 | EFI_GUID Guid;\r | |
| 448 | EFI_STRING_ID FormSetTitle;\r | |
| 449 | EFI_STRING_ID Help;\r | |
| 0a1147ed LG |
450 | UINT8 NumberOfClassGuid;\r |
| 451 | EFI_GUID ClassGuid[3]; // Up to three ClassGuid\r | |
| 452 | UINT16 Class; // Tiano extended Class code\r | |
| 453 | UINT16 SubClass; // Tiano extended Subclass code\r | |
| 7936fb6a | 454 | EFI_IMAGE_ID ImageId;\r |
| 455 | \r | |
| 456 | FORM_BROWSER_STATEMENT *StatementBuffer; // Buffer for all Statements and Questions\r | |
| 457 | EXPRESSION_OPCODE *ExpressionBuffer; // Buffer for all Expression OpCode\r | |
| 458 | \r | |
| 459 | LIST_ENTRY StorageListHead; // Storage list (FORMSET_STORAGE)\r | |
| 460 | LIST_ENTRY DefaultStoreListHead; // DefaultStore list (FORMSET_DEFAULTSTORE)\r | |
| 461 | LIST_ENTRY FormListHead; // Form list (FORM_BROWSER_FORM)\r | |
| 0c66bc76 | 462 | LIST_ENTRY ExpressionListHead; // List of Expressions (FORM_EXPRESSION)\r |
| 7936fb6a | 463 | } FORM_BROWSER_FORMSET;\r |
| 464 | \r | |
| ce6d12cc | 465 | #define BROWSER_CONTEXT_SIGNATURE SIGNATURE_32 ('B', 'C', 'T', 'X')\r |
| 466 | \r | |
| 467 | typedef struct {\r | |
| 468 | UINTN Signature;\r | |
| 469 | LIST_ENTRY Link;\r | |
| 470 | \r | |
| 471 | //\r | |
| 472 | // Globals defined in Setup.c\r | |
| 473 | //\r | |
| 474 | BANNER_DATA *BannerData;\r | |
| 475 | UINTN ClassOfVfr;\r | |
| 476 | UINTN FunctionKeySetting;\r | |
| 477 | BOOLEAN ResetRequired;\r | |
| 478 | BOOLEAN NvUpdateRequired;\r | |
| 479 | UINT16 Direction;\r | |
| 480 | EFI_SCREEN_DESCRIPTOR ScreenDimensions;\r | |
| 481 | CHAR16 *FunctionNineString;\r | |
| 482 | CHAR16 *FunctionTenString;\r | |
| 483 | CHAR16 *EnterString;\r | |
| 484 | CHAR16 *EnterCommitString;\r | |
| 485 | CHAR16 *EnterEscapeString;\r | |
| 486 | CHAR16 *EscapeString;\r | |
| 487 | CHAR16 *SaveFailed;\r | |
| 488 | CHAR16 *MoveHighlight;\r | |
| 489 | CHAR16 *MakeSelection;\r | |
| 490 | CHAR16 *DecNumericInput;\r | |
| 491 | CHAR16 *HexNumericInput;\r | |
| 492 | CHAR16 *ToggleCheckBox;\r | |
| 493 | CHAR16 *PromptForData;\r | |
| 494 | CHAR16 *PromptForPassword;\r | |
| 495 | CHAR16 *PromptForNewPassword;\r | |
| 496 | CHAR16 *ConfirmPassword;\r | |
| 497 | CHAR16 *ConfirmError;\r | |
| 498 | CHAR16 *PassowordInvalid;\r | |
| 499 | CHAR16 *PressEnter;\r | |
| 500 | CHAR16 *EmptyString;\r | |
| 501 | CHAR16 *AreYouSure;\r | |
| 502 | CHAR16 *YesResponse;\r | |
| 503 | CHAR16 *NoResponse;\r | |
| 504 | CHAR16 *MiniString;\r | |
| 505 | CHAR16 *PlusString;\r | |
| 506 | CHAR16 *MinusString;\r | |
| 507 | CHAR16 *AdjustNumber;\r | |
| 508 | CHAR16 *SaveChanges;\r | |
| 509 | CHAR16 *OptionMismatch;\r | |
| 2bb526f3 | 510 | CHAR16 *FormSuppress;\r |
| ce6d12cc | 511 | CHAR16 PromptBlockWidth;\r |
| 512 | CHAR16 OptionBlockWidth;\r | |
| 513 | CHAR16 HelpBlockWidth;\r | |
| 514 | FORM_BROWSER_FORMSET *OldFormSet;\r | |
| 515 | \r | |
| 516 | //\r | |
| 517 | // Globals defined in Ui.c\r | |
| 518 | //\r | |
| 519 | LIST_ENTRY MenuOption;\r | |
| 520 | VOID *MenuRefreshHead;\r | |
| 521 | } BROWSER_CONTEXT;\r | |
| 522 | \r | |
| 523 | #define BROWSER_CONTEXT_FROM_LINK(a) CR (a, BROWSER_CONTEXT, Link, BROWSER_CONTEXT_SIGNATURE)\r | |
| 7936fb6a | 524 | \r |
| 525 | extern EFI_HII_DATABASE_PROTOCOL *mHiiDatabase;\r | |
| 526 | extern EFI_HII_STRING_PROTOCOL *mHiiString;\r | |
| 527 | extern EFI_HII_CONFIG_ROUTING_PROTOCOL *mHiiConfigRouting;\r | |
| 528 | \r | |
| 0a1147ed LG |
529 | extern BANNER_DATA *gBannerData;\r |
| 530 | extern EFI_HII_HANDLE gFrontPageHandle;\r | |
| 7936fb6a | 531 | extern UINTN gClassOfVfr;\r |
| 532 | extern UINTN gFunctionKeySetting;\r | |
| 533 | extern BOOLEAN gResetRequired;\r | |
| 534 | extern BOOLEAN gNvUpdateRequired;\r | |
| 535 | extern EFI_HII_HANDLE gHiiHandle;\r | |
| 7936fb6a | 536 | extern UINT16 gDirection;\r |
| 537 | extern EFI_SCREEN_DESCRIPTOR gScreenDimensions;\r | |
| 7936fb6a | 538 | \r |
| d66e6c16 | 539 | extern FORM_BROWSER_FORMSET *gOldFormSet;\r |
| 540 | \r | |
| 7936fb6a | 541 | //\r |
| 542 | // Browser Global Strings\r | |
| 543 | //\r | |
| 7936fb6a | 544 | extern CHAR16 *gFunctionNineString;\r |
| 545 | extern CHAR16 *gFunctionTenString;\r | |
| 546 | extern CHAR16 *gEnterString;\r | |
| 547 | extern CHAR16 *gEnterCommitString;\r | |
| 8d00a0f1 | 548 | extern CHAR16 *gEnterEscapeString;\r |
| 7936fb6a | 549 | extern CHAR16 *gEscapeString;\r |
| 550 | extern CHAR16 *gSaveFailed;\r | |
| 551 | extern CHAR16 *gMoveHighlight;\r | |
| 552 | extern CHAR16 *gMakeSelection;\r | |
| 553 | extern CHAR16 *gDecNumericInput;\r | |
| 554 | extern CHAR16 *gHexNumericInput;\r | |
| 555 | extern CHAR16 *gToggleCheckBox;\r | |
| 556 | extern CHAR16 *gPromptForData;\r | |
| 557 | extern CHAR16 *gPromptForPassword;\r | |
| 558 | extern CHAR16 *gPromptForNewPassword;\r | |
| 559 | extern CHAR16 *gConfirmPassword;\r | |
| 560 | extern CHAR16 *gConfirmError;\r | |
| 561 | extern CHAR16 *gPassowordInvalid;\r | |
| 562 | extern CHAR16 *gPressEnter;\r | |
| 563 | extern CHAR16 *gEmptyString;\r | |
| 564 | extern CHAR16 *gAreYouSure;\r | |
| 565 | extern CHAR16 *gYesResponse;\r | |
| 566 | extern CHAR16 *gNoResponse;\r | |
| 567 | extern CHAR16 *gMiniString;\r | |
| 568 | extern CHAR16 *gPlusString;\r | |
| 569 | extern CHAR16 *gMinusString;\r | |
| 570 | extern CHAR16 *gAdjustNumber;\r | |
| ebe43565 | 571 | extern CHAR16 *gSaveChanges;\r |
| 8d00a0f1 | 572 | extern CHAR16 *gOptionMismatch;\r |
| 0c66bc76 | 573 | extern CHAR16 *gFormSuppress;\r |
| 7936fb6a | 574 | \r |
| 575 | extern CHAR16 gPromptBlockWidth;\r | |
| 576 | extern CHAR16 gOptionBlockWidth;\r | |
| 577 | extern CHAR16 gHelpBlockWidth;\r | |
| 578 | \r | |
| 579 | extern EFI_GUID gZeroGuid;\r | |
| 580 | extern EFI_GUID gTianoHiiIfrGuid;\r | |
| 581 | \r | |
| eccfeab1 | 582 | #include "Ui.h"\r |
| 7936fb6a | 583 | //\r |
| 584 | // Global Procedure Defines\r | |
| 585 | //\r | |
| 586 | \r | |
| 587 | /**\r | |
| 588 | Initialize the HII String Token to the correct values.\r | |
| 589 | \r | |
| 590 | **/\r | |
| 591 | VOID\r | |
| 592 | InitializeBrowserStrings (\r | |
| 593 | VOID\r | |
| ed66e1bc | 594 | );\r |
| 7936fb6a | 595 | \r |
| 596 | /**\r | |
| 597 | Prints a unicode string to the default console,\r | |
| 598 | using L"%s" format.\r | |
| 599 | \r | |
| 600 | @param String String pointer.\r | |
| 601 | \r | |
| 602 | @return Length of string printed to the console\r | |
| 603 | \r | |
| 604 | **/\r | |
| 605 | UINTN\r | |
| 606 | PrintString (\r | |
| 607 | IN CHAR16 *String\r | |
| ed66e1bc | 608 | );\r |
| 7936fb6a | 609 | \r |
| 610 | /**\r | |
| 611 | Prints a chracter to the default console,\r | |
| 612 | using L"%c" format.\r | |
| 613 | \r | |
| 614 | @param Character Character to print.\r | |
| 615 | \r | |
| 616 | @return Length of string printed to the console.\r | |
| 617 | \r | |
| 618 | **/\r | |
| 619 | UINTN\r | |
| 620 | PrintChar (\r | |
| 621 | CHAR16 Character\r | |
| ed66e1bc | 622 | );\r |
| 7936fb6a | 623 | \r |
| 624 | /**\r | |
| 625 | Prints a formatted unicode string to the default console, at\r | |
| 626 | the supplied cursor position.\r | |
| 627 | \r | |
| 628 | @param Column The cursor position to print the string at.\r | |
| 629 | @param Row The cursor position to print the string at\r | |
| 630 | @param Fmt Format string\r | |
| 631 | @param ... Variable argument list for formating string.\r | |
| 632 | \r | |
| 633 | @return Length of string printed to the console\r | |
| 634 | \r | |
| 635 | **/\r | |
| 636 | UINTN\r | |
| 8091267c | 637 | EFIAPI\r |
| 7936fb6a | 638 | PrintAt (\r |
| 639 | IN UINTN Column,\r | |
| 640 | IN UINTN Row,\r | |
| 641 | IN CHAR16 *Fmt,\r | |
| 642 | ...\r | |
| ed66e1bc | 643 | );\r |
| 7936fb6a | 644 | \r |
| 645 | /**\r | |
| 646 | Prints a unicode string to the default console, at\r | |
| 647 | the supplied cursor position, using L"%s" format.\r | |
| 648 | \r | |
| 649 | @param Column The cursor position to print the string at.\r | |
| 650 | @param Row The cursor position to print the string at\r | |
| 651 | @param String String pointer.\r | |
| 652 | \r | |
| 653 | @return Length of string printed to the console\r | |
| 654 | \r | |
| 655 | **/\r | |
| 656 | UINTN\r | |
| 657 | PrintStringAt (\r | |
| 658 | IN UINTN Column,\r | |
| 659 | IN UINTN Row,\r | |
| 660 | IN CHAR16 *String\r | |
| ed66e1bc | 661 | );\r |
| 7936fb6a | 662 | \r |
| 663 | /**\r | |
| 664 | Prints a chracter to the default console, at\r | |
| 665 | the supplied cursor position, using L"%c" format.\r | |
| 666 | \r | |
| 667 | @param Column The cursor position to print the string at.\r | |
| 668 | @param Row The cursor position to print the string at.\r | |
| 669 | @param Character Character to print.\r | |
| 670 | \r | |
| 671 | @return Length of string printed to the console.\r | |
| 672 | \r | |
| 673 | **/\r | |
| 674 | UINTN\r | |
| 675 | PrintCharAt (\r | |
| 676 | IN UINTN Column,\r | |
| 677 | IN UINTN Row,\r | |
| 678 | CHAR16 Character\r | |
| ed66e1bc | 679 | );\r |
| 7936fb6a | 680 | \r |
| 681 | /**\r | |
| 682 | Parse opcodes in the formset IFR binary.\r | |
| 683 | \r | |
| 684 | @param FormSet Pointer of the FormSet data structure.\r | |
| 685 | \r | |
| 686 | @retval EFI_SUCCESS Opcode parse success.\r | |
| 687 | @retval Other Opcode parse fail.\r | |
| 688 | \r | |
| 689 | **/\r | |
| 690 | EFI_STATUS\r | |
| 691 | ParseOpCodes (\r | |
| 692 | IN FORM_BROWSER_FORMSET *FormSet\r | |
| ed66e1bc | 693 | );\r |
| 7936fb6a | 694 | \r |
| 695 | /**\r | |
| 696 | Free resources allocated for a FormSet.\r | |
| 697 | \r | |
| 698 | @param FormSet Pointer of the FormSet\r | |
| 699 | \r | |
| 700 | **/\r | |
| 701 | VOID\r | |
| 702 | DestroyFormSet (\r | |
| 703 | IN OUT FORM_BROWSER_FORMSET *FormSet\r | |
| ed66e1bc | 704 | );\r |
| 7936fb6a | 705 | \r |
| 706 | /**\r | |
| 707 | This function displays the page frame.\r | |
| 708 | \r | |
| 709 | **/\r | |
| 710 | VOID\r | |
| 711 | DisplayPageFrame (\r | |
| 712 | VOID\r | |
| ed66e1bc | 713 | );\r |
| 7936fb6a | 714 | \r |
| 715 | /**\r | |
| 716 | Create a new string in HII Package List.\r | |
| 717 | \r | |
| 718 | @param String The String to be added\r | |
| 719 | @param HiiHandle The package list in the HII database to insert the\r | |
| 720 | specified string.\r | |
| 721 | \r | |
| 722 | @return The output string.\r | |
| 723 | \r | |
| 724 | **/\r | |
| 725 | EFI_STRING_ID\r | |
| 726 | NewString (\r | |
| 727 | IN CHAR16 *String,\r | |
| 728 | IN EFI_HII_HANDLE HiiHandle\r | |
| ed66e1bc | 729 | );\r |
| 7936fb6a | 730 | \r |
| 731 | /**\r | |
| 732 | Delete a string from HII Package List.\r | |
| 733 | \r | |
| 734 | @param StringId Id of the string in HII database.\r | |
| 735 | @param HiiHandle The HII package list handle.\r | |
| 736 | \r | |
| 737 | @retval EFI_SUCCESS The string was deleted successfully.\r | |
| 738 | \r | |
| 739 | **/\r | |
| 740 | EFI_STATUS\r | |
| 741 | DeleteString (\r | |
| 742 | IN EFI_STRING_ID StringId,\r | |
| 743 | IN EFI_HII_HANDLE HiiHandle\r | |
| ed66e1bc | 744 | );\r |
| 7936fb6a | 745 | \r |
| 746 | /**\r | |
| 747 | Get the string based on the StringId and HII Package List Handle.\r | |
| 748 | \r | |
| 749 | @param Token The String's ID.\r | |
| 750 | @param HiiHandle The package list in the HII database to search for\r | |
| 751 | the specified string.\r | |
| 752 | \r | |
| 753 | @return The output string.\r | |
| 754 | \r | |
| 755 | **/\r | |
| 756 | CHAR16 *\r | |
| 757 | GetToken (\r | |
| 758 | IN EFI_STRING_ID Token,\r | |
| 759 | IN EFI_HII_HANDLE HiiHandle\r | |
| ed66e1bc | 760 | );\r |
| 7936fb6a | 761 | \r |
| 762 | /**\r | |
| 763 | Draw a pop up windows based on the dimension, number of lines and\r | |
| 764 | strings specified.\r | |
| 765 | \r | |
| 766 | @param RequestedWidth The width of the pop-up.\r | |
| 767 | @param NumberOfLines The number of lines.\r | |
| f4bcc90f | 768 | @param Marker The variable argument list for the list of string to be printed.\r |
| 7936fb6a | 769 | \r |
| 770 | **/\r | |
| 771 | VOID\r | |
| 772 | CreateSharedPopUp (\r | |
| 773 | IN UINTN RequestedWidth,\r | |
| 774 | IN UINTN NumberOfLines,\r | |
| f4bcc90f | 775 | IN VA_LIST Marker\r |
| ed66e1bc | 776 | );\r |
| 7936fb6a | 777 | \r |
| 778 | /**\r | |
| 779 | Routine used to abstract a generic dialog interface and return the selected key or string\r | |
| 780 | \r | |
| 781 | @param NumberOfLines The number of lines for the dialog box\r | |
| 782 | @param HotKey Defines whether a single character is parsed\r | |
| 783 | (TRUE) and returned in KeyValue or a string is\r | |
| 784 | returned in StringBuffer. Two special characters\r | |
| 785 | are considered when entering a string, a SCAN_ESC\r | |
| 786 | and an CHAR_CARRIAGE_RETURN. SCAN_ESC terminates\r | |
| 787 | string input and returns\r | |
| 788 | @param MaximumStringSize The maximum size in bytes of a typed in string\r | |
| 789 | (each character is a CHAR16) and the minimum\r | |
| 790 | string returned is two bytes\r | |
| 791 | @param StringBuffer The passed in pointer to the buffer which will\r | |
| 792 | hold the typed in string if HotKey is FALSE\r | |
| 793 | @param KeyValue The EFI_KEY value returned if HotKey is TRUE..\r | |
| 7936fb6a | 794 | @param ... A series of (quantity == NumberOfLines) text\r |
| 795 | strings which will be used to construct the dialog\r | |
| 796 | box\r | |
| 797 | \r | |
| 798 | @retval EFI_SUCCESS Displayed dialog and received user interaction\r | |
| 799 | @retval EFI_INVALID_PARAMETER One of the parameters was invalid (e.g.\r | |
| 800 | (StringBuffer == NULL) && (HotKey == FALSE))\r | |
| 801 | @retval EFI_DEVICE_ERROR User typed in an ESC character to exit the routine\r | |
| 802 | \r | |
| 803 | **/\r | |
| 804 | EFI_STATUS\r | |
| 8091267c | 805 | EFIAPI\r |
| 7936fb6a | 806 | CreateDialog (\r |
| 807 | IN UINTN NumberOfLines,\r | |
| 808 | IN BOOLEAN HotKey,\r | |
| 809 | IN UINTN MaximumStringSize,\r | |
| 810 | OUT CHAR16 *StringBuffer,\r | |
| 811 | OUT EFI_INPUT_KEY *KeyValue,\r | |
| 7936fb6a | 812 | ...\r |
| ed66e1bc | 813 | );\r |
| 7936fb6a | 814 | \r |
| 2573712e LG |
815 | /**\r |
| 816 | Get Value for given Name from a NameValue Storage.\r | |
| 817 | \r | |
| 818 | @param Storage The NameValue Storage.\r | |
| 819 | @param Name The Name.\r | |
| 820 | @param Value The retured Value.\r | |
| 821 | \r | |
| 822 | @retval EFI_SUCCESS Value found for given Name.\r | |
| 823 | @retval EFI_NOT_FOUND No such Name found in NameValue storage.\r | |
| 824 | \r | |
| 825 | **/\r | |
| 826 | EFI_STATUS\r | |
| 827 | GetValueByName (\r | |
| 828 | IN FORMSET_STORAGE *Storage,\r | |
| 829 | IN CHAR16 *Name,\r | |
| 830 | IN OUT CHAR16 **Value\r | |
| 831 | );\r | |
| 832 | \r | |
| 833 | /**\r | |
| 834 | Set Value of given Name in a NameValue Storage.\r | |
| 835 | \r | |
| 836 | @param Storage The NameValue Storage.\r | |
| 837 | @param Name The Name.\r | |
| 838 | @param Value The Value to set.\r | |
| 839 | \r | |
| 840 | @retval EFI_SUCCESS Value found for given Name.\r | |
| 841 | @retval EFI_NOT_FOUND No such Name found in NameValue storage.\r | |
| 842 | \r | |
| 843 | **/\r | |
| 844 | EFI_STATUS\r | |
| 845 | SetValueByName (\r | |
| 846 | IN FORMSET_STORAGE *Storage,\r | |
| 847 | IN CHAR16 *Name,\r | |
| 848 | IN CHAR16 *Value\r | |
| 849 | );\r | |
| 850 | \r | |
| 7936fb6a | 851 | /**\r |
| 852 | Get Question's current Value.\r | |
| 853 | \r | |
| 854 | @param FormSet FormSet data structure.\r | |
| 855 | @param Form Form data structure.\r | |
| 856 | @param Question Question to be initialized.\r | |
| 857 | @param Cached TRUE: get from Edit copy FALSE: get from original\r | |
| 858 | Storage\r | |
| 859 | \r | |
| 860 | @retval EFI_SUCCESS The function completed successfully.\r | |
| 861 | \r | |
| 862 | **/\r | |
| 863 | EFI_STATUS\r | |
| 864 | GetQuestionValue (\r | |
| 865 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
| 866 | IN FORM_BROWSER_FORM *Form,\r | |
| 867 | IN OUT FORM_BROWSER_STATEMENT *Question,\r | |
| 868 | IN BOOLEAN Cached\r | |
| ed66e1bc | 869 | );\r |
| 7936fb6a | 870 | \r |
| 871 | /**\r | |
| 872 | Save Question Value to edit copy(cached) or Storage(uncached).\r | |
| 873 | \r | |
| 874 | @param FormSet FormSet data structure.\r | |
| 875 | @param Form Form data structure.\r | |
| 876 | @param Question Pointer to the Question.\r | |
| 877 | @param Cached TRUE: set to Edit copy FALSE: set to original\r | |
| 878 | Storage\r | |
| 879 | \r | |
| 880 | @retval EFI_SUCCESS The function completed successfully.\r | |
| 881 | \r | |
| 882 | **/\r | |
| 883 | EFI_STATUS\r | |
| 884 | SetQuestionValue (\r | |
| 885 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
| 886 | IN FORM_BROWSER_FORM *Form,\r | |
| 887 | IN OUT FORM_BROWSER_STATEMENT *Question,\r | |
| 888 | IN BOOLEAN Cached\r | |
| ed66e1bc | 889 | );\r |
| 7936fb6a | 890 | \r |
| 891 | /**\r | |
| 892 | Perform inconsistent check for a Form.\r | |
| 893 | \r | |
| 894 | @param FormSet FormSet data structure.\r | |
| 895 | @param Form Form data structure.\r | |
| 896 | @param Question The Question to be validated.\r | |
| 897 | @param Type Validation type: InConsistent or NoSubmit\r | |
| 898 | \r | |
| 899 | @retval EFI_SUCCESS Form validation pass.\r | |
| 900 | @retval other Form validation failed.\r | |
| 901 | \r | |
| 902 | **/\r | |
| 903 | EFI_STATUS\r | |
| 904 | ValidateQuestion (\r | |
| 905 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
| 906 | IN FORM_BROWSER_FORM *Form,\r | |
| 907 | IN FORM_BROWSER_STATEMENT *Question,\r | |
| 908 | IN UINTN Type\r | |
| ed66e1bc | 909 | );\r |
| 7936fb6a | 910 | \r |
| 911 | /**\r | |
| 912 | Submit a Form.\r | |
| 913 | \r | |
| 914 | @param FormSet FormSet data structure.\r | |
| 915 | @param Form Form data structure.\r | |
| 916 | \r | |
| 917 | @retval EFI_SUCCESS The function completed successfully.\r | |
| 918 | \r | |
| 919 | **/\r | |
| 920 | EFI_STATUS\r | |
| 921 | SubmitForm (\r | |
| 922 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
| 923 | IN FORM_BROWSER_FORM *Form\r | |
| ed66e1bc | 924 | );\r |
| 7936fb6a | 925 | \r |
| 926 | /**\r | |
| 927 | Reset Question to its default value.\r | |
| 928 | \r | |
| 929 | @param FormSet The form set.\r | |
| 930 | @param Form The form.\r | |
| 931 | @param Question The question.\r | |
| 932 | @param DefaultId The Class of the default.\r | |
| 933 | \r | |
| 934 | @retval EFI_SUCCESS Question is reset to default value.\r | |
| 935 | \r | |
| 936 | **/\r | |
| 937 | EFI_STATUS\r | |
| 938 | GetQuestionDefault (\r | |
| 939 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
| 940 | IN FORM_BROWSER_FORM *Form,\r | |
| 941 | IN FORM_BROWSER_STATEMENT *Question,\r | |
| 942 | IN UINT16 DefaultId\r | |
| ed66e1bc | 943 | );\r |
| 7936fb6a | 944 | \r |
| 945 | /**\r | |
| 946 | Get current setting of Questions.\r | |
| 947 | \r | |
| 948 | @param FormSet FormSet data structure.\r | |
| 949 | \r | |
| 950 | @retval EFI_SUCCESS The function completed successfully.\r | |
| 951 | \r | |
| 952 | **/\r | |
| 953 | EFI_STATUS\r | |
| 954 | InitializeCurrentSetting (\r | |
| 955 | IN OUT FORM_BROWSER_FORMSET *FormSet\r | |
| ed66e1bc | 956 | );\r |
| 7936fb6a | 957 | \r |
| 958 | /**\r | |
| 959 | Initialize the internal data structure of a FormSet.\r | |
| 960 | \r | |
| 961 | @param Handle PackageList Handle\r | |
| 962 | @param FormSetGuid GUID of a formset. If not specified (NULL or zero\r | |
| 963 | GUID), take the first FormSet found in package\r | |
| 964 | list.\r | |
| 965 | @param FormSet FormSet data structure.\r | |
| 966 | \r | |
| 967 | @retval EFI_SUCCESS The function completed successfully.\r | |
| 968 | @retval EFI_NOT_FOUND The specified FormSet could not be found.\r | |
| 969 | \r | |
| 970 | **/\r | |
| 971 | EFI_STATUS\r | |
| 972 | InitializeFormSet (\r | |
| 973 | IN EFI_HII_HANDLE Handle,\r | |
| 974 | IN OUT EFI_GUID *FormSetGuid,\r | |
| 975 | OUT FORM_BROWSER_FORMSET *FormSet\r | |
| ed66e1bc | 976 | );\r |
| 7936fb6a | 977 | \r |
| 978 | /**\r | |
| 979 | Reset Questions in a Form to their default value.\r | |
| 980 | \r | |
| 981 | @param FormSet FormSet data structure.\r | |
| 982 | @param Form The Form which to be reset.\r | |
| 983 | @param DefaultId The Class of the default.\r | |
| 984 | \r | |
| 985 | @retval EFI_SUCCESS The function completed successfully.\r | |
| 986 | \r | |
| 987 | **/\r | |
| 988 | EFI_STATUS\r | |
| 989 | ExtractFormDefault (\r | |
| 990 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
| 991 | IN FORM_BROWSER_FORM *Form,\r | |
| 992 | IN UINT16 DefaultId\r | |
| ed66e1bc | 993 | );\r |
| 7936fb6a | 994 | \r |
| 995 | /**\r | |
| 996 | Initialize Question's Edit copy from Storage.\r | |
| 997 | \r | |
| eccfeab1 LG |
998 | @param Selection Selection contains the information about \r |
| 999 | the Selection, form and formset to be displayed.\r | |
| 1000 | Selection action may be updated in retrieve callback.\r | |
| 7936fb6a | 1001 | @param FormSet FormSet data structure.\r |
| 1002 | @param Form Form data structure.\r | |
| 1003 | \r | |
| 1004 | @retval EFI_SUCCESS The function completed successfully.\r | |
| 1005 | \r | |
| 1006 | **/\r | |
| 1007 | EFI_STATUS\r | |
| 1008 | LoadFormConfig (\r | |
| eccfeab1 LG |
1009 | IN OUT UI_MENU_SELECTION *Selection,\r |
| 1010 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
| 1011 | IN FORM_BROWSER_FORM *Form\r | |
| ed66e1bc | 1012 | );\r |
| 7936fb6a | 1013 | \r |
| d66e6c16 | 1014 | /**\r |
| 1015 | Initialize Question's Edit copy from Storage for the whole Formset.\r | |
| 1016 | \r | |
| eccfeab1 LG |
1017 | @param Selection Selection contains the information about \r |
| 1018 | the Selection, form and formset to be displayed.\r | |
| 1019 | Selection action may be updated in retrieve callback.\r | |
| d66e6c16 | 1020 | @param FormSet FormSet data structure.\r |
| 1021 | \r | |
| 1022 | @retval EFI_SUCCESS The function completed successfully.\r | |
| 1023 | \r | |
| 1024 | **/\r | |
| 1025 | EFI_STATUS\r | |
| 1026 | LoadFormSetConfig (\r | |
| eccfeab1 LG |
1027 | IN OUT UI_MENU_SELECTION *Selection,\r |
| 1028 | IN FORM_BROWSER_FORMSET *FormSet\r | |
| d66e6c16 | 1029 | );\r |
| 1030 | \r | |
| 7936fb6a | 1031 | /**\r |
| 1032 | Convert setting of Buffer Storage or NameValue Storage to <ConfigResp>.\r | |
| 1033 | \r | |
| 1034 | @param Storage The Storage to be conveted.\r | |
| 1035 | @param ConfigResp The returned <ConfigResp>.\r | |
| 1036 | \r | |
| 1037 | @retval EFI_SUCCESS Convert success.\r | |
| 1038 | @retval EFI_INVALID_PARAMETER Incorrect storage type.\r | |
| 1039 | \r | |
| 1040 | **/\r | |
| 1041 | EFI_STATUS\r | |
| 1042 | StorageToConfigResp (\r | |
| 1043 | IN FORMSET_STORAGE *Storage,\r | |
| 1044 | IN CHAR16 **ConfigResp\r | |
| ed66e1bc | 1045 | );\r |
| 7936fb6a | 1046 | \r |
| 1047 | /**\r | |
| 1048 | Convert <ConfigResp> to settings in Buffer Storage or NameValue Storage.\r | |
| 1049 | \r | |
| 1050 | @param Storage The Storage to receive the settings.\r | |
| 1051 | @param ConfigResp The <ConfigResp> to be converted.\r | |
| 1052 | \r | |
| 1053 | @retval EFI_SUCCESS Convert success.\r | |
| 1054 | @retval EFI_INVALID_PARAMETER Incorrect storage type.\r | |
| 1055 | \r | |
| 1056 | **/\r | |
| 1057 | EFI_STATUS\r | |
| 1058 | ConfigRespToStorage (\r | |
| 1059 | IN FORMSET_STORAGE *Storage,\r | |
| 1060 | IN CHAR16 *ConfigResp\r | |
| ed66e1bc | 1061 | );\r |
| 7936fb6a | 1062 | \r |
| 1063 | /**\r | |
| 1064 | Fill storage's edit copy with settings requested from Configuration Driver.\r | |
| 1065 | \r | |
| 1066 | @param FormSet FormSet data structure.\r | |
| 1067 | @param Storage Buffer Storage.\r | |
| 1068 | \r | |
| 1069 | @retval EFI_SUCCESS The function completed successfully.\r | |
| 1070 | \r | |
| 1071 | **/\r | |
| 1072 | EFI_STATUS\r | |
| 1073 | LoadStorage (\r | |
| 1074 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
| 1075 | IN FORMSET_STORAGE *Storage\r | |
| ed66e1bc | 1076 | );\r |
| 7936fb6a | 1077 | \r |
| 1078 | /**\r | |
| 1079 | Fetch the Ifr binary data of a FormSet.\r | |
| 1080 | \r | |
| 1081 | @param Handle PackageList Handle\r | |
| 1082 | @param FormSetGuid GUID of a formset. If not specified (NULL or zero\r | |
| 1083 | GUID), take the first FormSet found in package\r | |
| 1084 | list.\r | |
| 1085 | @param BinaryLength The length of the FormSet IFR binary.\r | |
| 1086 | @param BinaryData The buffer designed to receive the FormSet.\r | |
| 1087 | \r | |
| 1088 | @retval EFI_SUCCESS Buffer filled with the requested FormSet.\r | |
| 1089 | BufferLength was updated.\r | |
| 1090 | @retval EFI_INVALID_PARAMETER The handle is unknown.\r | |
| 1091 | @retval EFI_NOT_FOUND A form or FormSet on the requested handle cannot\r | |
| 1092 | be found with the requested FormId.\r | |
| 1093 | \r | |
| 1094 | **/\r | |
| 1095 | EFI_STATUS\r | |
| 1096 | GetIfrBinaryData (\r | |
| 1097 | IN EFI_HII_HANDLE Handle,\r | |
| 1098 | IN OUT EFI_GUID *FormSetGuid,\r | |
| 1099 | OUT UINTN *BinaryLength,\r | |
| 1100 | OUT UINT8 **BinaryData\r | |
| ed66e1bc | 1101 | );\r |
| 7936fb6a | 1102 | \r |
| ce6d12cc | 1103 | /**\r |
| 1104 | Save globals used by previous call to SendForm(). SendForm() may be called from \r | |
| 1105 | HiiConfigAccess.Callback(), this will cause SendForm() be reentried.\r | |
| 1106 | So, save globals of previous call to SendForm() and restore them upon exit.\r | |
| 1107 | \r | |
| 1108 | **/\r | |
| 1109 | VOID\r | |
| 1110 | SaveBrowserContext (\r | |
| 1111 | VOID\r | |
| 1112 | );\r | |
| 1113 | \r | |
| 1114 | /**\r | |
| 1115 | Restore globals used by previous call to SendForm().\r | |
| 1116 | \r | |
| 1117 | **/\r | |
| 1118 | VOID\r | |
| 1119 | RestoreBrowserContext (\r | |
| 1120 | VOID\r | |
| 1121 | );\r | |
| 1122 | \r | |
| 7936fb6a | 1123 | /**\r |
| 1124 | This is the routine which an external caller uses to direct the browser\r | |
| 1125 | where to obtain it's information.\r | |
| 1126 | \r | |
| 1127 | \r | |
| 1128 | @param This The Form Browser protocol instanse.\r | |
| 1129 | @param Handles A pointer to an array of Handles. If HandleCount > 1 we\r | |
| 1130 | display a list of the formsets for the handles specified.\r | |
| 1131 | @param HandleCount The number of Handles specified in Handle.\r | |
| 1132 | @param FormSetGuid This field points to the EFI_GUID which must match the Guid\r | |
| 1133 | field in the EFI_IFR_FORM_SET op-code for the specified\r | |
| 1134 | forms-based package. If FormSetGuid is NULL, then this\r | |
| 1135 | function will display the first found forms package.\r | |
| 1136 | @param FormId This field specifies which EFI_IFR_FORM to render as the first\r | |
| 1137 | displayable page. If this field has a value of 0x0000, then\r | |
| 1138 | the forms browser will render the specified forms in their encoded order.\r | |
| 1139 | ScreenDimenions - This allows the browser to be called so that it occupies a\r | |
| 1140 | portion of the physical screen instead of dynamically determining the screen dimensions.\r | |
| 1141 | ActionRequest - Points to the action recommended by the form.\r | |
| d66e6c16 | 1142 | @param ScreenDimensions Points to recommended form dimensions, including any non-content area, in\r |
| 7936fb6a | 1143 | characters.\r |
| 1144 | @param ActionRequest Points to the action recommended by the form.\r | |
| 1145 | \r | |
| 1146 | @retval EFI_SUCCESS The function completed successfully.\r | |
| 1147 | @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r | |
| 1148 | @retval EFI_NOT_FOUND No valid forms could be found to display.\r | |
| 1149 | \r | |
| 1150 | **/\r | |
| 1151 | EFI_STATUS\r | |
| 1152 | EFIAPI\r | |
| 1153 | SendForm (\r | |
| 1154 | IN CONST EFI_FORM_BROWSER2_PROTOCOL *This,\r | |
| 1155 | IN EFI_HII_HANDLE *Handles,\r | |
| 1156 | IN UINTN HandleCount,\r | |
| 1157 | IN EFI_GUID *FormSetGuid, OPTIONAL\r | |
| 1158 | IN UINT16 FormId, OPTIONAL\r | |
| 1159 | IN CONST EFI_SCREEN_DESCRIPTOR *ScreenDimensions, OPTIONAL\r | |
| 1160 | OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest OPTIONAL\r | |
| ed66e1bc | 1161 | );\r |
| 7936fb6a | 1162 | \r |
| 1163 | /**\r | |
| 1164 | This function is called by a callback handler to retrieve uncommitted state\r | |
| 1165 | data from the browser.\r | |
| 1166 | \r | |
| 1167 | @param This A pointer to the EFI_FORM_BROWSER2_PROTOCOL\r | |
| 1168 | instance.\r | |
| 1169 | @param ResultsDataSize A pointer to the size of the buffer associated\r | |
| 1170 | with ResultsData.\r | |
| 1171 | @param ResultsData A string returned from an IFR browser or\r | |
| 1172 | equivalent. The results string will have no\r | |
| 1173 | routing information in them.\r | |
| 1174 | @param RetrieveData A BOOLEAN field which allows an agent to retrieve\r | |
| 1175 | (if RetrieveData = TRUE) data from the uncommitted\r | |
| 1176 | browser state information or set (if RetrieveData\r | |
| 1177 | = FALSE) data in the uncommitted browser state\r | |
| 1178 | information.\r | |
| 1179 | @param VariableGuid An optional field to indicate the target variable\r | |
| 1180 | GUID name to use.\r | |
| 1181 | @param VariableName An optional field to indicate the target\r | |
| 1182 | human-readable variable name.\r | |
| 1183 | \r | |
| 1184 | @retval EFI_SUCCESS The results have been distributed or are awaiting\r | |
| 1185 | distribution.\r | |
| 1186 | @retval EFI_BUFFER_TOO_SMALL The ResultsDataSize specified was too small to\r | |
| 1187 | contain the results data.\r | |
| 1188 | \r | |
| 1189 | **/\r | |
| 1190 | EFI_STATUS\r | |
| 1191 | EFIAPI\r | |
| 1192 | BrowserCallback (\r | |
| 1193 | IN CONST EFI_FORM_BROWSER2_PROTOCOL *This,\r | |
| 1194 | IN OUT UINTN *ResultsDataSize,\r | |
| 1195 | IN OUT EFI_STRING ResultsData,\r | |
| 1196 | IN BOOLEAN RetrieveData,\r | |
| 1197 | IN CONST EFI_GUID *VariableGuid, OPTIONAL\r | |
| 1198 | IN CONST CHAR16 *VariableName OPTIONAL\r | |
| ed66e1bc | 1199 | );\r |
| 7936fb6a | 1200 | \r |
| 1201 | #endif\r |