projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 93e3992d | 1 | /** @file\r |
| 53cf48e0 | 2 | This is an example of how a driver might export data to the HII protocol to be\r |
| 3 | later utilized by the Setup Protocol\r | |
| 4 | \r | |
| e5eed7d3 HT |
5 | Copyright (c) 2004 - 2010, Intel Corporation. All rights reserved.<BR>\r |
| 6 | This program and the accompanying materials\r | |
| 93e3992d | 7 | are licensed and made available under the terms and conditions of the BSD License\r |
| 8 | which accompanies this distribution. The full text of the license may be found at\r | |
| 9 | http://opensource.org/licenses/bsd-license.php\r | |
| 10 | \r | |
| 11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
| 12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
| 13 | \r | |
| 93e3992d | 14 | **/\r |
| 15 | \r | |
| 16 | \r | |
| 17 | #include "DriverSample.h"\r | |
| 18 | \r | |
| 7e3bcccb | 19 | #define DISPLAY_ONLY_MY_ITEM 0x0002\r |
| 93e3992d | 20 | \r |
| 21 | EFI_GUID mFormSetGuid = FORMSET_GUID;\r | |
| 22 | EFI_GUID mInventoryGuid = INVENTORY_GUID;\r | |
| 23 | \r | |
| 24 | CHAR16 VariableName[] = L"MyIfrNVData";\r | |
| 2f3065c0 LG |
25 | EFI_HANDLE DriverHandle[2] = {NULL, NULL};\r |
| 26 | DRIVER_SAMPLE_PRIVATE_DATA *PrivateData = NULL;\r | |
| 27 | \r | |
| 28 | HII_VENDOR_DEVICE_PATH mHiiVendorDevicePath0 = {\r | |
| f6f910dd | 29 | {\r |
| 30 | {\r | |
| 31 | HARDWARE_DEVICE_PATH,\r | |
| 32 | HW_VENDOR_DP,\r | |
| 33 | {\r | |
| 34 | (UINT8) (sizeof (VENDOR_DEVICE_PATH)),\r | |
| 35 | (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)\r | |
| 36 | }\r | |
| 37 | },\r | |
| 38 | //\r | |
| 39 | // {C153B68D-EBFC-488e-B110-662867745B87}\r | |
| 40 | //\r | |
| 41 | { 0xc153b68d, 0xebfc, 0x488e, { 0xb1, 0x10, 0x66, 0x28, 0x67, 0x74, 0x5b, 0x87 } }\r | |
| 42 | },\r | |
| 43 | {\r | |
| 44 | END_DEVICE_PATH_TYPE,\r | |
| 45 | END_ENTIRE_DEVICE_PATH_SUBTYPE,\r | |
| a6973cff | 46 | {\r |
| f6f910dd | 47 | (UINT8) (END_DEVICE_PATH_LENGTH),\r |
| 48 | (UINT8) ((END_DEVICE_PATH_LENGTH) >> 8)\r | |
| 49 | }\r | |
| 50 | }\r | |
| 51 | };\r | |
| 52 | \r | |
| 2f3065c0 | 53 | HII_VENDOR_DEVICE_PATH mHiiVendorDevicePath1 = {\r |
| f6f910dd | 54 | {\r |
| 55 | {\r | |
| 56 | HARDWARE_DEVICE_PATH,\r | |
| 57 | HW_VENDOR_DP,\r | |
| 58 | {\r | |
| 59 | (UINT8) (sizeof (VENDOR_DEVICE_PATH)),\r | |
| 60 | (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)\r | |
| 61 | }\r | |
| 62 | },\r | |
| 63 | //\r | |
| 64 | // {06F37F07-0C48-40e9-8436-0A08A0BB76B0}\r | |
| 65 | //\r | |
| 66 | { 0x6f37f07, 0xc48, 0x40e9, { 0x84, 0x36, 0xa, 0x8, 0xa0, 0xbb, 0x76, 0xb0 } }\r | |
| 67 | },\r | |
| 68 | {\r | |
| 69 | END_DEVICE_PATH_TYPE,\r | |
| 70 | END_ENTIRE_DEVICE_PATH_SUBTYPE,\r | |
| a6973cff | 71 | {\r |
| f6f910dd | 72 | (UINT8) (END_DEVICE_PATH_LENGTH),\r |
| 73 | (UINT8) ((END_DEVICE_PATH_LENGTH) >> 8)\r | |
| 74 | }\r | |
| 75 | }\r | |
| 76 | };\r | |
| 77 | \r | |
| 7064c0a5 | 78 | /**\r |
| 79 | Encode the password using a simple algorithm.\r | |
| a6973cff | 80 | \r |
| 7064c0a5 | 81 | @param Password The string to be encoded.\r |
| 82 | @param MaxSize The size of the string.\r | |
| a6973cff | 83 | \r |
| 7064c0a5 | 84 | **/\r |
| 93e3992d | 85 | VOID\r |
| 86 | EncodePassword (\r | |
| 87 | IN CHAR16 *Password,\r | |
| 5a829f56 | 88 | IN UINTN MaxSize\r |
| 93e3992d | 89 | )\r |
| 90 | {\r | |
| 91 | UINTN Index;\r | |
| 92 | UINTN Loop;\r | |
| 93 | CHAR16 *Buffer;\r | |
| 94 | CHAR16 *Key;\r | |
| 95 | \r | |
| 96 | Key = L"MAR10648567";\r | |
| 97 | Buffer = AllocateZeroPool (MaxSize);\r | |
| 98 | ASSERT (Buffer != NULL);\r | |
| 99 | \r | |
| 100 | for (Index = 0; Key[Index] != 0; Index++) {\r | |
| 101 | for (Loop = 0; Loop < (UINT8) (MaxSize / 2); Loop++) {\r | |
| 102 | Buffer[Loop] = (CHAR16) (Password[Loop] ^ Key[Index]);\r | |
| 103 | }\r | |
| 104 | }\r | |
| 105 | \r | |
| 106 | CopyMem (Password, Buffer, MaxSize);\r | |
| 107 | \r | |
| 53cf48e0 | 108 | FreePool (Buffer);\r |
| 93e3992d | 109 | return ;\r |
| 110 | }\r | |
| 111 | \r | |
| 7064c0a5 | 112 | /**\r |
| 113 | Validate the user's password.\r | |
| a6973cff | 114 | \r |
| 7064c0a5 | 115 | @param PrivateData This driver's private context data.\r |
| 116 | @param StringId The user's input.\r | |
| a6973cff | 117 | \r |
| 7064c0a5 | 118 | @retval EFI_SUCCESS The user's input matches the password.\r |
| 119 | @retval EFI_NOT_READY The user's input does not match the password.\r | |
| 120 | **/\r | |
| 93e3992d | 121 | EFI_STATUS\r |
| 122 | ValidatePassword (\r | |
| 7064c0a5 | 123 | IN DRIVER_SAMPLE_PRIVATE_DATA *PrivateData,\r |
| 124 | IN EFI_STRING_ID StringId\r | |
| 93e3992d | 125 | )\r |
| 126 | {\r | |
| 127 | EFI_STATUS Status;\r | |
| 128 | UINTN Index;\r | |
| 129 | UINTN BufferSize;\r | |
| 84f9a9ec | 130 | UINTN PasswordMaxSize;\r |
| 93e3992d | 131 | CHAR16 *Password;\r |
| 132 | CHAR16 *EncodedPassword;\r | |
| 133 | BOOLEAN OldPassword;\r | |
| 134 | \r | |
| 135 | //\r | |
| 136 | // Get encoded password first\r | |
| 137 | //\r | |
| 138 | BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r | |
| 139 | Status = gRT->GetVariable (\r | |
| 140 | VariableName,\r | |
| 141 | &mFormSetGuid,\r | |
| 142 | NULL,\r | |
| 143 | &BufferSize,\r | |
| 144 | &PrivateData->Configuration\r | |
| 145 | );\r | |
| 146 | if (EFI_ERROR (Status)) {\r | |
| 147 | //\r | |
| 148 | // Old password not exist, prompt for new password\r | |
| 149 | //\r | |
| 150 | return EFI_SUCCESS;\r | |
| 151 | }\r | |
| 152 | \r | |
| 153 | OldPassword = FALSE;\r | |
| 84f9a9ec | 154 | PasswordMaxSize = sizeof (PrivateData->Configuration.WhatIsThePassword2);\r |
| 93e3992d | 155 | //\r |
| 156 | // Check whether we have any old password set\r | |
| 157 | //\r | |
| 84f9a9ec | 158 | for (Index = 0; Index < PasswordMaxSize / sizeof (UINT16); Index++) {\r |
| 93e3992d | 159 | if (PrivateData->Configuration.WhatIsThePassword2[Index] != 0) {\r |
| 160 | OldPassword = TRUE;\r | |
| 161 | break;\r | |
| 162 | }\r | |
| 163 | }\r | |
| 164 | if (!OldPassword) {\r | |
| 165 | //\r | |
| 166 | // Old password not exist, return EFI_SUCCESS to prompt for new password\r | |
| 167 | //\r | |
| 168 | return EFI_SUCCESS;\r | |
| 169 | }\r | |
| 170 | \r | |
| 171 | //\r | |
| 172 | // Get user input password\r | |
| 173 | //\r | |
| cb7d01c0 | 174 | Password = HiiGetString (PrivateData->HiiHandle[0], StringId, NULL);\r |
| 175 | if (Password == NULL) {\r | |
| 176 | return EFI_NOT_READY;\r | |
| 177 | }\r | |
| 84f9a9ec | 178 | if (StrSize (Password) > PasswordMaxSize) {\r |
| 53cf48e0 | 179 | FreePool (Password);\r |
| cb7d01c0 | 180 | return EFI_NOT_READY;\r |
| 93e3992d | 181 | }\r |
| 182 | \r | |
| 183 | //\r | |
| 184 | // Validate old password\r | |
| 185 | //\r | |
| 84f9a9ec | 186 | EncodedPassword = AllocateZeroPool (PasswordMaxSize);\r |
| 93e3992d | 187 | ASSERT (EncodedPassword != NULL);\r |
| 84f9a9ec LG |
188 | StrnCpy (EncodedPassword, Password, StrLen (Password));\r |
| 189 | EncodePassword (EncodedPassword, StrLen (EncodedPassword) * sizeof (CHAR16));\r | |
| e35eb8af | 190 | if (CompareMem (EncodedPassword, PrivateData->Configuration.WhatIsThePassword2, PasswordMaxSize) != 0) {\r |
| 93e3992d | 191 | //\r |
| 192 | // Old password mismatch, return EFI_NOT_READY to prompt for error message\r | |
| 193 | //\r | |
| 194 | Status = EFI_NOT_READY;\r | |
| 195 | } else {\r | |
| 196 | Status = EFI_SUCCESS;\r | |
| 197 | }\r | |
| 198 | \r | |
| 53cf48e0 | 199 | FreePool (Password);\r |
| 200 | FreePool (EncodedPassword);\r | |
| 93e3992d | 201 | \r |
| 202 | return Status;\r | |
| 203 | }\r | |
| 204 | \r | |
| 7064c0a5 | 205 | /**\r |
| 206 | Encode the password using a simple algorithm.\r | |
| a6973cff | 207 | \r |
| 7064c0a5 | 208 | @param PrivateData This driver's private context data.\r |
| 209 | @param StringId The password from User.\r | |
| a6973cff | 210 | \r |
| 7064c0a5 | 211 | @retval EFI_SUCESS The operation is successful.\r |
| 212 | @return Other value if gRT->SetVariable () fails.\r | |
| a6973cff | 213 | \r |
| 7064c0a5 | 214 | **/\r |
| 93e3992d | 215 | EFI_STATUS\r |
| 216 | SetPassword (\r | |
| 7064c0a5 | 217 | IN DRIVER_SAMPLE_PRIVATE_DATA *PrivateData,\r |
| 218 | IN EFI_STRING_ID StringId\r | |
| 93e3992d | 219 | )\r |
| 220 | {\r | |
| 221 | EFI_STATUS Status;\r | |
| 93e3992d | 222 | CHAR16 *Password;\r |
| cb7d01c0 | 223 | CHAR16 *TempPassword;\r |
| 5a829f56 | 224 | UINTN PasswordSize;\r |
| 93e3992d | 225 | DRIVER_SAMPLE_CONFIGURATION *Configuration;\r |
| 7e3bcccb | 226 | UINTN BufferSize;\r |
| 93e3992d | 227 | \r |
| 228 | //\r | |
| 229 | // Get Buffer Storage data from EFI variable\r | |
| 230 | //\r | |
| 231 | BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r | |
| 232 | Status = gRT->GetVariable (\r | |
| 233 | VariableName,\r | |
| 234 | &mFormSetGuid,\r | |
| 235 | NULL,\r | |
| 236 | &BufferSize,\r | |
| 237 | &PrivateData->Configuration\r | |
| 238 | );\r | |
| 239 | if (EFI_ERROR (Status)) {\r | |
| 240 | return Status;\r | |
| 241 | }\r | |
| 242 | \r | |
| 243 | //\r | |
| 244 | // Get user input password\r | |
| 245 | //\r | |
| 246 | Password = &PrivateData->Configuration.WhatIsThePassword2[0];\r | |
| a6973cff | 247 | PasswordSize = sizeof (PrivateData->Configuration.WhatIsThePassword2);\r |
| 5a829f56 | 248 | ZeroMem (Password, PasswordSize);\r |
| a6973cff | 249 | \r |
| cb7d01c0 | 250 | TempPassword = HiiGetString (PrivateData->HiiHandle[0], StringId, NULL);\r |
| 251 | if (TempPassword == NULL) {\r | |
| 252 | return EFI_NOT_READY;\r | |
| 253 | }\r | |
| 84f9a9ec | 254 | if (StrSize (TempPassword) > PasswordSize) {\r |
| cb7d01c0 | 255 | FreePool (TempPassword);\r |
| 256 | return EFI_NOT_READY;\r | |
| 93e3992d | 257 | }\r |
| 84f9a9ec | 258 | StrnCpy (Password, TempPassword, StrLen (TempPassword));\r |
| cb7d01c0 | 259 | FreePool (TempPassword);\r |
| 93e3992d | 260 | \r |
| 261 | //\r | |
| 262 | // Retrive uncommitted data from Browser\r | |
| 263 | //\r | |
| 1d451ff9 LG |
264 | Configuration = AllocateZeroPool (sizeof (DRIVER_SAMPLE_CONFIGURATION));\r |
| 265 | ASSERT (Configuration != NULL);\r | |
| 266 | if (HiiGetBrowserData (&mFormSetGuid, VariableName, sizeof (DRIVER_SAMPLE_CONFIGURATION), (UINT8 *) Configuration)) {\r | |
| 93e3992d | 267 | //\r |
| 268 | // Update password's clear text in the screen\r | |
| 269 | //\r | |
| 84f9a9ec | 270 | CopyMem (Configuration->PasswordClearText, Password, StrSize (Password));\r |
| 93e3992d | 271 | \r |
| 272 | //\r | |
| 273 | // Update uncommitted data of Browser\r | |
| 274 | //\r | |
| 7e3bcccb LG |
275 | HiiSetBrowserData (\r |
| 276 | &mFormSetGuid,\r | |
| 277 | VariableName,\r | |
| 278 | sizeof (DRIVER_SAMPLE_CONFIGURATION),\r | |
| 279 | (UINT8 *) Configuration,\r | |
| 280 | NULL\r | |
| 281 | );\r | |
| 93e3992d | 282 | }\r |
| 7e3bcccb | 283 | \r |
| 1d451ff9 LG |
284 | //\r |
| 285 | // Free Configuration Buffer\r | |
| 286 | //\r | |
| 287 | FreePool (Configuration);\r | |
| 288 | \r | |
| 93e3992d | 289 | \r |
| 290 | //\r | |
| 291 | // Set password\r | |
| 292 | //\r | |
| 84f9a9ec | 293 | EncodePassword (Password, StrLen (Password) * 2);\r |
| 93e3992d | 294 | Status = gRT->SetVariable(\r |
| 295 | VariableName,\r | |
| 296 | &mFormSetGuid,\r | |
| 297 | EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r | |
| 298 | sizeof (DRIVER_SAMPLE_CONFIGURATION),\r | |
| 299 | &PrivateData->Configuration\r | |
| 300 | );\r | |
| 301 | return Status;\r | |
| 302 | }\r | |
| 303 | \r | |
| 38ebfecb LG |
304 | /**\r |
| 305 | Update names of Name/Value storage to current language.\r | |
| 306 | \r | |
| 307 | @param PrivateData Points to the driver private data.\r | |
| 308 | \r | |
| 309 | @retval EFI_SUCCESS All names are successfully updated.\r | |
| 310 | @retval EFI_NOT_FOUND Failed to get Name from HII database.\r | |
| 311 | \r | |
| 312 | **/\r | |
| 313 | EFI_STATUS\r | |
| 314 | LoadNameValueNames (\r | |
| 315 | IN DRIVER_SAMPLE_PRIVATE_DATA *PrivateData\r | |
| 316 | )\r | |
| 317 | {\r | |
| 318 | UINTN Index;\r | |
| 319 | \r | |
| 320 | //\r | |
| 321 | // Get Name/Value name string of current language\r | |
| 322 | //\r | |
| 323 | for (Index = 0; Index < NAME_VALUE_NAME_NUMBER; Index++) {\r | |
| 324 | PrivateData->NameValueName[Index] = HiiGetString (\r | |
| 325 | PrivateData->HiiHandle[0],\r | |
| 326 | PrivateData->NameStringId[Index],\r | |
| 327 | NULL\r | |
| 328 | );\r | |
| 329 | if (PrivateData->NameValueName[Index] == NULL) {\r | |
| 330 | return EFI_NOT_FOUND;\r | |
| 331 | }\r | |
| 332 | }\r | |
| 333 | \r | |
| 334 | return EFI_SUCCESS;\r | |
| 335 | }\r | |
| 93e3992d | 336 | \r |
| 337 | /**\r | |
| 338 | This function allows a caller to extract the current configuration for one\r | |
| 339 | or more named elements from the target driver.\r | |
| 340 | \r | |
| 341 | @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r | |
| 342 | @param Request A null-terminated Unicode string in\r | |
| 343 | <ConfigRequest> format.\r | |
| 344 | @param Progress On return, points to a character in the Request\r | |
| 345 | string. Points to the string's null terminator if\r | |
| 346 | request was successful. Points to the most recent\r | |
| 347 | '&' before the first failing name/value pair (or\r | |
| 348 | the beginning of the string if the failure is in\r | |
| 349 | the first name/value pair) if the request was not\r | |
| 350 | successful.\r | |
| 351 | @param Results A null-terminated Unicode string in\r | |
| 352 | <ConfigAltResp> format which has all values filled\r | |
| 353 | in for the names in the Request string. String to\r | |
| 354 | be allocated by the called function.\r | |
| 355 | \r | |
| 356 | @retval EFI_SUCCESS The Results is filled with the requested values.\r | |
| 357 | @retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.\r | |
| e35eb8af | 358 | @retval EFI_INVALID_PARAMETER Request is illegal syntax, or unknown name.\r |
| 93e3992d | 359 | @retval EFI_NOT_FOUND Routing data doesn't match any storage in this\r |
| 360 | driver.\r | |
| 361 | \r | |
| 362 | **/\r | |
| 363 | EFI_STATUS\r | |
| 364 | EFIAPI\r | |
| 365 | ExtractConfig (\r | |
| 366 | IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r | |
| 367 | IN CONST EFI_STRING Request,\r | |
| 368 | OUT EFI_STRING *Progress,\r | |
| 369 | OUT EFI_STRING *Results\r | |
| 370 | )\r | |
| 371 | {\r | |
| 372 | EFI_STATUS Status;\r | |
| 373 | UINTN BufferSize;\r | |
| 374 | DRIVER_SAMPLE_PRIVATE_DATA *PrivateData;\r | |
| 375 | EFI_HII_CONFIG_ROUTING_PROTOCOL *HiiConfigRouting;\r | |
| 84f9a9ec | 376 | EFI_STRING ConfigRequest;\r |
| 086cd2c8 | 377 | EFI_STRING ConfigRequestHdr;\r |
| 84f9a9ec | 378 | UINTN Size;\r |
| 38ebfecb LG |
379 | EFI_STRING Value;\r |
| 380 | UINTN ValueStrLen;\r | |
| 381 | CHAR16 BackupChar;\r | |
| 382 | CHAR16 *StrPointer;\r | |
| 59aefb7e | 383 | BOOLEAN AllocatedRequest;\r |
| 38ebfecb | 384 | \r |
| 59aefb7e | 385 | if (Progress == NULL || Results == NULL) {\r |
| ae79d2f9 LG |
386 | return EFI_INVALID_PARAMETER;\r |
| 387 | }\r | |
| 84f9a9ec LG |
388 | //\r |
| 389 | // Initialize the local variables.\r | |
| 390 | //\r | |
| 086cd2c8 LG |
391 | ConfigRequestHdr = NULL;\r |
| 392 | ConfigRequest = NULL;\r | |
| 393 | Size = 0;\r | |
| 394 | *Progress = Request;\r | |
| 59aefb7e | 395 | AllocatedRequest = FALSE;\r |
| 93e3992d | 396 | \r |
| 397 | PrivateData = DRIVER_SAMPLE_PRIVATE_FROM_THIS (This);\r | |
| 398 | HiiConfigRouting = PrivateData->HiiConfigRouting;\r | |
| 399 | \r | |
| 8d00a0f1 | 400 | //\r |
| 84f9a9ec LG |
401 | // Get Buffer Storage data from EFI variable.\r |
| 402 | // Try to get the current setting from variable.\r | |
| 93e3992d | 403 | //\r |
| 404 | BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r | |
| 04da0b4a LG |
405 | Status = gRT->GetVariable (\r |
| 406 | VariableName,\r | |
| 407 | &mFormSetGuid,\r | |
| 408 | NULL,\r | |
| 409 | &BufferSize,\r | |
| 410 | &PrivateData->Configuration\r | |
| 411 | );\r | |
| 412 | if (EFI_ERROR (Status)) {\r | |
| de482998 | 413 | return EFI_NOT_FOUND;\r |
| 04da0b4a | 414 | }\r |
| a6973cff | 415 | \r |
| 8d00a0f1 | 416 | if (Request == NULL) {\r |
| 417 | //\r | |
| 84f9a9ec | 418 | // Request is set to NULL, construct full request string.\r |
| 7e3bcccb | 419 | //\r |
| 84f9a9ec | 420 | \r |
| 84f9a9ec | 421 | //\r |
| a6973cff | 422 | // Allocate and fill a buffer large enough to hold the <ConfigHdr> template\r |
| 84f9a9ec LG |
423 | // followed by "&OFFSET=0&WIDTH=WWWWWWWWWWWWWWWW" followed by a Null-terminator\r |
| 424 | //\r | |
| 086cd2c8 | 425 | ConfigRequestHdr = HiiConstructConfigHdr (&mFormSetGuid, VariableName, PrivateData->DriverHandle[0]);\r |
| 59aefb7e | 426 | Size = (StrLen (ConfigRequestHdr) + 32 + 1) * sizeof (CHAR16);\r |
| 84f9a9ec | 427 | ConfigRequest = AllocateZeroPool (Size);\r |
| 1bd57b6e | 428 | ASSERT (ConfigRequest != NULL);\r |
| 59aefb7e | 429 | AllocatedRequest = TRUE;\r |
| 086cd2c8 LG |
430 | UnicodeSPrint (ConfigRequest, Size, L"%s&OFFSET=0&WIDTH=%016LX", ConfigRequestHdr, (UINT64)BufferSize);\r |
| 431 | FreePool (ConfigRequestHdr);\r | |
| 84f9a9ec | 432 | } else {\r |
| de482998 LG |
433 | //\r |
| 434 | // Check routing data in <ConfigHdr>.\r | |
| 435 | // Note: if only one Storage is used, then this checking could be skipped.\r | |
| 436 | //\r | |
| 38ebfecb | 437 | if (!HiiIsConfigHdrMatch (Request, &mFormSetGuid, NULL)) {\r |
| de482998 | 438 | return EFI_NOT_FOUND;\r |
| 84f9a9ec | 439 | }\r |
| 59aefb7e LG |
440 | //\r |
| 441 | // Set Request to the unified request string.\r | |
| 442 | //\r | |
| de482998 | 443 | ConfigRequest = Request;\r |
| 38ebfecb | 444 | //\r |
| 59aefb7e | 445 | // Check whether Request includes Request Element.\r |
| 38ebfecb LG |
446 | //\r |
| 447 | if (StrStr (Request, L"OFFSET") == NULL) {\r | |
| 448 | //\r | |
| 59aefb7e | 449 | // Check Request Element does exist in Reques String\r |
| 38ebfecb | 450 | //\r |
| 59aefb7e LG |
451 | StrPointer = StrStr (Request, L"PATH");\r |
| 452 | if (StrPointer == NULL) {\r | |
| 453 | return EFI_INVALID_PARAMETER;\r | |
| 454 | }\r | |
| 455 | if (StrStr (StrPointer, L"&") == NULL) {\r | |
| 456 | Size = (StrLen (Request) + 32 + 1) * sizeof (CHAR16);\r | |
| 457 | ConfigRequest = AllocateZeroPool (Size);\r | |
| 1bd57b6e | 458 | ASSERT (ConfigRequest != NULL);\r |
| 59aefb7e LG |
459 | AllocatedRequest = TRUE;\r |
| 460 | UnicodeSPrint (ConfigRequest, Size, L"%s&OFFSET=0&WIDTH=%016LX", Request, (UINT64)BufferSize);\r | |
| 38ebfecb | 461 | }\r |
| 59aefb7e LG |
462 | }\r |
| 463 | }\r | |
| 38ebfecb | 464 | \r |
| 59aefb7e LG |
465 | //\r |
| 466 | // Check if requesting Name/Value storage\r | |
| 467 | //\r | |
| 468 | if (StrStr (ConfigRequest, L"OFFSET") == NULL) {\r | |
| 469 | //\r | |
| 470 | // Update Name/Value storage Names\r | |
| 471 | //\r | |
| 472 | Status = LoadNameValueNames (PrivateData);\r | |
| 473 | if (EFI_ERROR (Status)) {\r | |
| 474 | return Status;\r | |
| 475 | }\r | |
| 38ebfecb | 476 | \r |
| 59aefb7e LG |
477 | //\r |
| 478 | // Allocate memory for <ConfigResp>, e.g. Name0=0x11, Name1=0x1234, Name2="ABCD"\r | |
| 479 | // <Request> ::=<ConfigHdr>&Name0&Name1&Name2\r | |
| 480 | // <ConfigResp>::=<ConfigHdr>&Name0=11&Name1=1234&Name2=0041004200430044\r | |
| 481 | //\r | |
| 482 | BufferSize = (StrLen (ConfigRequest) +\r | |
| 483 | 1 + sizeof (PrivateData->Configuration.NameValueVar0) * 2 +\r | |
| 484 | 1 + sizeof (PrivateData->Configuration.NameValueVar1) * 2 +\r | |
| 485 | 1 + sizeof (PrivateData->Configuration.NameValueVar2) * 2 + 1) * sizeof (CHAR16);\r | |
| 486 | *Results = AllocateZeroPool (BufferSize);\r | |
| 487 | ASSERT (*Results != NULL);\r | |
| 488 | StrCpy (*Results, ConfigRequest);\r | |
| 489 | Value = *Results;\r | |
| 38ebfecb | 490 | \r |
| 59aefb7e LG |
491 | //\r |
| 492 | // Append value of NameValueVar0, type is UINT8\r | |
| 493 | //\r | |
| 494 | if ((Value = StrStr (*Results, PrivateData->NameValueName[0])) != NULL) {\r | |
| 495 | Value += StrLen (PrivateData->NameValueName[0]);\r | |
| 496 | ValueStrLen = ((sizeof (PrivateData->Configuration.NameValueVar0) * 2) + 1);\r | |
| 497 | CopyMem (Value + ValueStrLen, Value, StrSize (Value));\r | |
| 498 | \r | |
| 499 | BackupChar = Value[ValueStrLen];\r | |
| 500 | *Value++ = L'=';\r | |
| 501 | Value += UnicodeValueToString (\r | |
| 502 | Value, \r | |
| 503 | PREFIX_ZERO | RADIX_HEX, \r | |
| 504 | PrivateData->Configuration.NameValueVar0, \r | |
| 505 | sizeof (PrivateData->Configuration.NameValueVar0) * 2\r | |
| 506 | );\r | |
| 507 | *Value = BackupChar;\r | |
| 508 | }\r | |
| 509 | \r | |
| 510 | //\r | |
| 511 | // Append value of NameValueVar1, type is UINT16\r | |
| 512 | //\r | |
| 513 | if ((Value = StrStr (*Results, PrivateData->NameValueName[1])) != NULL) {\r | |
| 514 | Value += StrLen (PrivateData->NameValueName[1]);\r | |
| 515 | ValueStrLen = ((sizeof (PrivateData->Configuration.NameValueVar1) * 2) + 1);\r | |
| 516 | CopyMem (Value + ValueStrLen, Value, StrSize (Value));\r | |
| 517 | \r | |
| 518 | BackupChar = Value[ValueStrLen];\r | |
| 519 | *Value++ = L'=';\r | |
| 520 | Value += UnicodeValueToString (\r | |
| 521 | Value, \r | |
| 522 | PREFIX_ZERO | RADIX_HEX, \r | |
| 523 | PrivateData->Configuration.NameValueVar1, \r | |
| 524 | sizeof (PrivateData->Configuration.NameValueVar1) * 2\r | |
| 525 | );\r | |
| 526 | *Value = BackupChar;\r | |
| 527 | }\r | |
| 528 | \r | |
| 529 | //\r | |
| 530 | // Append value of NameValueVar2, type is CHAR16 *\r | |
| 531 | //\r | |
| 532 | if ((Value = StrStr (*Results, PrivateData->NameValueName[2])) != NULL) {\r | |
| 533 | Value += StrLen (PrivateData->NameValueName[2]);\r | |
| 534 | ValueStrLen = StrLen (PrivateData->Configuration.NameValueVar2) * 4 + 1;\r | |
| 535 | CopyMem (Value + ValueStrLen, Value, StrSize (Value));\r | |
| 38ebfecb | 536 | \r |
| 59aefb7e | 537 | *Value++ = L'=';\r |
| 38ebfecb | 538 | //\r |
| 59aefb7e | 539 | // Convert Unicode String to Config String, e.g. "ABCD" => "0041004200430044"\r |
| 38ebfecb | 540 | //\r |
| 59aefb7e LG |
541 | StrPointer = (CHAR16 *) PrivateData->Configuration.NameValueVar2;\r |
| 542 | for (; *StrPointer != L'\0'; StrPointer++) {\r | |
| 543 | Value += UnicodeValueToString (Value, PREFIX_ZERO | RADIX_HEX, *StrPointer, 4);\r | |
| 38ebfecb | 544 | }\r |
| 38ebfecb | 545 | }\r |
| 59aefb7e LG |
546 | \r |
| 547 | Status = EFI_SUCCESS;\r | |
| 548 | } else {\r | |
| 549 | //\r | |
| 550 | // Convert buffer data to <ConfigResp> by helper function BlockToConfig()\r | |
| 551 | //\r | |
| 552 | Status = HiiConfigRouting->BlockToConfig (\r | |
| 553 | HiiConfigRouting,\r | |
| 554 | ConfigRequest,\r | |
| 555 | (UINT8 *) &PrivateData->Configuration,\r | |
| 556 | BufferSize,\r | |
| 557 | Results,\r | |
| 558 | Progress\r | |
| 559 | );\r | |
| 8d00a0f1 | 560 | }\r |
| 561 | \r | |
| 93e3992d | 562 | //\r |
| 59aefb7e | 563 | // Free the allocated config request string.\r |
| 93e3992d | 564 | //\r |
| 59aefb7e | 565 | if (AllocatedRequest) {\r |
| 84f9a9ec | 566 | FreePool (ConfigRequest);\r |
| 59aefb7e LG |
567 | }\r |
| 568 | //\r | |
| 569 | // Set Progress string to the original request string.\r | |
| 570 | //\r | |
| 571 | if (Request == NULL) {\r | |
| 1f1cb2f2 | 572 | *Progress = NULL;\r |
| 59aefb7e LG |
573 | } else if (StrStr (Request, L"OFFSET") == NULL) {\r |
| 574 | *Progress = Request + StrLen (Request);\r | |
| 84f9a9ec LG |
575 | }\r |
| 576 | \r | |
| 93e3992d | 577 | return Status;\r |
| 578 | }\r | |
| 579 | \r | |
| 580 | \r | |
| 581 | /**\r | |
| 582 | This function processes the results of changes in configuration.\r | |
| 583 | \r | |
| 584 | @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r | |
| 585 | @param Configuration A null-terminated Unicode string in <ConfigResp>\r | |
| 586 | format.\r | |
| 587 | @param Progress A pointer to a string filled in with the offset of\r | |
| 588 | the most recent '&' before the first failing\r | |
| 589 | name/value pair (or the beginning of the string if\r | |
| 590 | the failure is in the first name/value pair) or\r | |
| 591 | the terminating NULL if all was successful.\r | |
| 592 | \r | |
| 593 | @retval EFI_SUCCESS The Results is processed successfully.\r | |
| 594 | @retval EFI_INVALID_PARAMETER Configuration is NULL.\r | |
| 595 | @retval EFI_NOT_FOUND Routing data doesn't match any storage in this\r | |
| 596 | driver.\r | |
| 597 | \r | |
| 598 | **/\r | |
| 599 | EFI_STATUS\r | |
| 600 | EFIAPI\r | |
| 601 | RouteConfig (\r | |
| 602 | IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r | |
| 603 | IN CONST EFI_STRING Configuration,\r | |
| 604 | OUT EFI_STRING *Progress\r | |
| 605 | )\r | |
| 606 | {\r | |
| 607 | EFI_STATUS Status;\r | |
| 608 | UINTN BufferSize;\r | |
| 609 | DRIVER_SAMPLE_PRIVATE_DATA *PrivateData;\r | |
| 610 | EFI_HII_CONFIG_ROUTING_PROTOCOL *HiiConfigRouting;\r | |
| 38ebfecb LG |
611 | CHAR16 *Value;\r |
| 612 | CHAR16 *StrPtr;\r | |
| 613 | CHAR16 TemStr[5];\r | |
| 614 | UINT8 *DataBuffer;\r | |
| 615 | UINT8 DigitUint8;\r | |
| 616 | UINTN Index;\r | |
| 617 | CHAR16 *StrBuffer;\r | |
| 93e3992d | 618 | \r |
| f5e9ff82 | 619 | if (Configuration == NULL || Progress == NULL) {\r |
| 8d00a0f1 | 620 | return EFI_INVALID_PARAMETER;\r |
| 621 | }\r | |
| 622 | \r | |
| 93e3992d | 623 | PrivateData = DRIVER_SAMPLE_PRIVATE_FROM_THIS (This);\r |
| 624 | HiiConfigRouting = PrivateData->HiiConfigRouting;\r | |
| f5e9ff82 | 625 | *Progress = Configuration;\r |
| 93e3992d | 626 | \r |
| 84f9a9ec | 627 | //\r |
| 8d00a0f1 | 628 | // Check routing data in <ConfigHdr>.\r |
| 629 | // Note: if only one Storage is used, then this checking could be skipped.\r | |
| 630 | //\r | |
| 38ebfecb | 631 | if (!HiiIsConfigHdrMatch (Configuration, &mFormSetGuid, NULL)) {\r |
| 8d00a0f1 | 632 | return EFI_NOT_FOUND;\r |
| 633 | }\r | |
| 634 | \r | |
| 93e3992d | 635 | //\r |
| 636 | // Get Buffer Storage data from EFI variable\r | |
| 637 | //\r | |
| 638 | BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r | |
| 04da0b4a LG |
639 | Status = gRT->GetVariable (\r |
| 640 | VariableName,\r | |
| 641 | &mFormSetGuid,\r | |
| 642 | NULL,\r | |
| 643 | &BufferSize,\r | |
| 644 | &PrivateData->Configuration\r | |
| 645 | );\r | |
| 646 | if (EFI_ERROR (Status)) {\r | |
| 647 | return Status;\r | |
| 648 | }\r | |
| 93e3992d | 649 | \r |
| 38ebfecb LG |
650 | //\r |
| 651 | // Check if configuring Name/Value storage\r | |
| 652 | //\r | |
| 653 | if (StrStr (Configuration, L"OFFSET") == NULL) {\r | |
| 654 | //\r | |
| 655 | // Update Name/Value storage Names\r | |
| 656 | //\r | |
| 657 | Status = LoadNameValueNames (PrivateData);\r | |
| 658 | if (EFI_ERROR (Status)) {\r | |
| 659 | return Status;\r | |
| 660 | }\r | |
| 661 | \r | |
| 662 | //\r | |
| 663 | // Convert value for NameValueVar0\r | |
| 664 | //\r | |
| 665 | if ((Value = StrStr (Configuration, PrivateData->NameValueName[0])) != NULL) {\r | |
| 666 | //\r | |
| 667 | // Skip "Name="\r | |
| 668 | //\r | |
| 669 | Value += StrLen (PrivateData->NameValueName[0]);\r | |
| 670 | Value++;\r | |
| 671 | //\r | |
| 672 | // Get Value String\r | |
| 673 | //\r | |
| 674 | StrPtr = StrStr (Value, L"&");\r | |
| 675 | if (StrPtr == NULL) {\r | |
| 676 | StrPtr = Value + StrLen (Value);\r | |
| 677 | }\r | |
| 678 | //\r | |
| 679 | // Convert Value to Buffer data\r | |
| 680 | //\r | |
| 681 | DataBuffer = (UINT8 *) &PrivateData->Configuration.NameValueVar0;\r | |
| 682 | ZeroMem (TemStr, sizeof (TemStr));\r | |
| 683 | for (Index = 0, StrPtr --; StrPtr >= Value; StrPtr --, Index ++) {\r | |
| 684 | TemStr[0] = *StrPtr;\r | |
| 685 | DigitUint8 = (UINT8) StrHexToUint64 (TemStr);\r | |
| 686 | if ((Index & 1) == 0) {\r | |
| 687 | DataBuffer [Index/2] = DigitUint8;\r | |
| 688 | } else {\r | |
| 689 | DataBuffer [Index/2] = (UINT8) ((UINT8) (DigitUint8 << 4) + DataBuffer [Index/2]);\r | |
| 690 | }\r | |
| 691 | }\r | |
| 692 | }\r | |
| 693 | \r | |
| 694 | //\r | |
| 695 | // Convert value for NameValueVar1\r | |
| 696 | //\r | |
| 697 | if ((Value = StrStr (Configuration, PrivateData->NameValueName[1])) != NULL) {\r | |
| 698 | //\r | |
| 699 | // Skip "Name="\r | |
| 700 | //\r | |
| 701 | Value += StrLen (PrivateData->NameValueName[1]);\r | |
| 702 | Value++;\r | |
| 703 | //\r | |
| 704 | // Get Value String\r | |
| 705 | //\r | |
| 706 | StrPtr = StrStr (Value, L"&");\r | |
| 707 | if (StrPtr == NULL) {\r | |
| 708 | StrPtr = Value + StrLen (Value);\r | |
| 709 | }\r | |
| 710 | //\r | |
| 711 | // Convert Value to Buffer data\r | |
| 712 | //\r | |
| 713 | DataBuffer = (UINT8 *) &PrivateData->Configuration.NameValueVar1;\r | |
| 714 | ZeroMem (TemStr, sizeof (TemStr));\r | |
| 715 | for (Index = 0, StrPtr --; StrPtr >= Value; StrPtr --, Index ++) {\r | |
| 716 | TemStr[0] = *StrPtr;\r | |
| 717 | DigitUint8 = (UINT8) StrHexToUint64 (TemStr);\r | |
| 718 | if ((Index & 1) == 0) {\r | |
| 719 | DataBuffer [Index/2] = DigitUint8;\r | |
| 720 | } else {\r | |
| 721 | DataBuffer [Index/2] = (UINT8) ((UINT8) (DigitUint8 << 4) + DataBuffer [Index/2]);\r | |
| 722 | }\r | |
| 723 | }\r | |
| 724 | }\r | |
| 725 | \r | |
| 726 | //\r | |
| 727 | // Convert value for NameValueVar2\r | |
| 728 | //\r | |
| 729 | if ((Value = StrStr (Configuration, PrivateData->NameValueName[2])) != NULL) {\r | |
| 730 | //\r | |
| 731 | // Skip "Name="\r | |
| 732 | //\r | |
| 733 | Value += StrLen (PrivateData->NameValueName[2]);\r | |
| 734 | Value++;\r | |
| 735 | //\r | |
| 736 | // Get Value String\r | |
| 737 | //\r | |
| 738 | StrPtr = StrStr (Value, L"&");\r | |
| 739 | if (StrPtr == NULL) {\r | |
| 740 | StrPtr = Value + StrLen (Value);\r | |
| 741 | }\r | |
| 742 | //\r | |
| 743 | // Convert Config String to Unicode String, e.g "0041004200430044" => "ABCD"\r | |
| 744 | //\r | |
| 745 | StrBuffer = (CHAR16 *) PrivateData->Configuration.NameValueVar2;\r | |
| 746 | ZeroMem (TemStr, sizeof (TemStr));\r | |
| 747 | while (Value < StrPtr) {\r | |
| 748 | StrnCpy (TemStr, Value, 4);\r | |
| 749 | *(StrBuffer++) = (CHAR16) StrHexToUint64 (TemStr);\r | |
| 750 | Value += 4;\r | |
| 751 | }\r | |
| 752 | *StrBuffer = L'\0';\r | |
| 753 | }\r | |
| 754 | \r | |
| 755 | //\r | |
| 756 | // Store Buffer Storage back to EFI variable\r | |
| 757 | //\r | |
| 758 | Status = gRT->SetVariable(\r | |
| 759 | VariableName,\r | |
| 760 | &mFormSetGuid,\r | |
| 761 | EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r | |
| 762 | sizeof (DRIVER_SAMPLE_CONFIGURATION),\r | |
| 763 | &PrivateData->Configuration\r | |
| 764 | );\r | |
| 765 | \r | |
| 766 | return Status;\r | |
| 767 | }\r | |
| 768 | \r | |
| 93e3992d | 769 | //\r |
| 770 | // Convert <ConfigResp> to buffer data by helper function ConfigToBlock()\r | |
| 771 | //\r | |
| 772 | BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r | |
| 773 | Status = HiiConfigRouting->ConfigToBlock (\r | |
| 774 | HiiConfigRouting,\r | |
| 775 | Configuration,\r | |
| 776 | (UINT8 *) &PrivateData->Configuration,\r | |
| 777 | &BufferSize,\r | |
| 778 | Progress\r | |
| 779 | );\r | |
| 780 | if (EFI_ERROR (Status)) {\r | |
| 781 | return Status;\r | |
| 782 | }\r | |
| 783 | \r | |
| 784 | //\r | |
| 785 | // Store Buffer Storage back to EFI variable\r | |
| 786 | //\r | |
| 787 | Status = gRT->SetVariable(\r | |
| 788 | VariableName,\r | |
| 789 | &mFormSetGuid,\r | |
| 790 | EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r | |
| 791 | sizeof (DRIVER_SAMPLE_CONFIGURATION),\r | |
| 792 | &PrivateData->Configuration\r | |
| 793 | );\r | |
| 794 | \r | |
| 795 | return Status;\r | |
| 796 | }\r | |
| 797 | \r | |
| 798 | \r | |
| 799 | /**\r | |
| 800 | This function processes the results of changes in configuration.\r | |
| 801 | \r | |
| 802 | @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r | |
| 803 | @param Action Specifies the type of action taken by the browser.\r | |
| 804 | @param QuestionId A unique value which is sent to the original\r | |
| 805 | exporting driver so that it can identify the type\r | |
| 806 | of data to expect.\r | |
| 807 | @param Type The type of value for the question.\r | |
| 808 | @param Value A pointer to the data being sent to the original\r | |
| 809 | exporting driver.\r | |
| 810 | @param ActionRequest On return, points to the action requested by the\r | |
| 811 | callback function.\r | |
| 812 | \r | |
| 813 | @retval EFI_SUCCESS The callback successfully handled the action.\r | |
| 814 | @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the\r | |
| 815 | variable and its data.\r | |
| 816 | @retval EFI_DEVICE_ERROR The variable could not be saved.\r | |
| 817 | @retval EFI_UNSUPPORTED The specified Action is not supported by the\r | |
| 818 | callback.\r | |
| 819 | \r | |
| 820 | **/\r | |
| 821 | EFI_STATUS\r | |
| 822 | EFIAPI\r | |
| 823 | DriverCallback (\r | |
| 824 | IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r | |
| 825 | IN EFI_BROWSER_ACTION Action,\r | |
| 826 | IN EFI_QUESTION_ID QuestionId,\r | |
| 827 | IN UINT8 Type,\r | |
| 828 | IN EFI_IFR_TYPE_VALUE *Value,\r | |
| 829 | OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest\r | |
| 830 | )\r | |
| 831 | {\r | |
| 832 | DRIVER_SAMPLE_PRIVATE_DATA *PrivateData;\r | |
| 833 | EFI_STATUS Status;\r | |
| 8d00a0f1 | 834 | UINT8 MyVar;\r |
| 7e3bcccb LG |
835 | VOID *StartOpCodeHandle;\r |
| 836 | VOID *OptionsOpCodeHandle;\r | |
| 837 | EFI_IFR_GUID_LABEL *StartLabel;\r | |
| 838 | VOID *EndOpCodeHandle;\r | |
| 839 | EFI_IFR_GUID_LABEL *EndLabel;\r | |
| a6973cff | 840 | EFI_INPUT_KEY Key;\r |
| 841 | DRIVER_SAMPLE_CONFIGURATION *Configuration;\r | |
| 16019c85 | 842 | UINTN MyVarSize;\r |
| a6973cff | 843 | \r |
| 844 | if (Action == EFI_BROWSER_ACTION_FORM_OPEN) {\r | |
| 5adb8db7 LG |
845 | if (QuestionId == 0x1234) {\r |
| 846 | //\r | |
| 847 | // Sample CallBack for UEFI FORM_OPEN action:\r | |
| 848 | // Add Save action into Form 3 when Form 1 is opened.\r | |
| 849 | // This will be done only in FORM_OPEN CallBack of question with ID 0x1234 from Form 1.\r | |
| 850 | //\r | |
| 851 | PrivateData = DRIVER_SAMPLE_PRIVATE_FROM_THIS (This);\r | |
| a6973cff | 852 | \r |
| 5adb8db7 LG |
853 | //\r |
| 854 | // Initialize the container for dynamic opcodes\r | |
| 855 | //\r | |
| 856 | StartOpCodeHandle = HiiAllocateOpCodeHandle ();\r | |
| 857 | ASSERT (StartOpCodeHandle != NULL);\r | |
| a6973cff | 858 | \r |
| 5adb8db7 LG |
859 | //\r |
| 860 | // Create Hii Extend Label OpCode as the start opcode\r | |
| 861 | //\r | |
| 862 | StartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (StartOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));\r | |
| 863 | StartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;\r | |
| 864 | StartLabel->Number = LABEL_UPDATE2;\r | |
| 865 | \r | |
| 866 | HiiCreateActionOpCode (\r | |
| 867 | StartOpCodeHandle, // Container for dynamic created opcodes\r | |
| 868 | 0x1238, // Question ID\r | |
| 869 | STRING_TOKEN(STR_SAVE_TEXT), // Prompt text\r | |
| 870 | STRING_TOKEN(STR_SAVE_TEXT), // Help text\r | |
| 871 | EFI_IFR_FLAG_CALLBACK, // Question flag\r | |
| 872 | 0 // Action String ID\r | |
| a6973cff | 873 | );\r |
| 874 | \r | |
| 5adb8db7 LG |
875 | HiiUpdateForm (\r |
| 876 | PrivateData->HiiHandle[0], // HII handle\r | |
| 877 | &mFormSetGuid, // Formset GUID\r | |
| 878 | 0x3, // Form ID\r | |
| 879 | StartOpCodeHandle, // Label for where to insert opcodes\r | |
| 880 | NULL // Insert data\r | |
| 881 | );\r | |
| 882 | \r | |
| 883 | HiiFreeOpCodeHandle (StartOpCodeHandle);\r | |
| 884 | }\r | |
| a6973cff | 885 | return EFI_SUCCESS;\r |
| 886 | }\r | |
| 887 | \r | |
| 888 | if (Action == EFI_BROWSER_ACTION_FORM_CLOSE) {\r | |
| 5adb8db7 LG |
889 | if (QuestionId == 0x5678) {\r |
| 890 | //\r | |
| 891 | // Sample CallBack for UEFI FORM_CLOSE action:\r | |
| 892 | // Show up a pop-up to specify Form 3 will be closed when exit Form 3.\r | |
| 893 | //\r | |
| 894 | do {\r | |
| 895 | CreatePopUp (\r | |
| 896 | EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE,\r | |
| 897 | &Key,\r | |
| 898 | L"",\r | |
| 899 | L"You are going to leave third Form!",\r | |
| 900 | L"Press ESC or ENTER to continue ...",\r | |
| 901 | L"",\r | |
| 902 | NULL\r | |
| 903 | );\r | |
| 904 | } while ((Key.ScanCode != SCAN_ESC) && (Key.UnicodeChar != CHAR_CARRIAGE_RETURN));\r | |
| 905 | }\r | |
| a6973cff | 906 | return EFI_SUCCESS;\r |
| 907 | }\r | |
| 93e3992d | 908 | \r |
| 909 | if ((Value == NULL) || (ActionRequest == NULL)) {\r | |
| 910 | return EFI_INVALID_PARAMETER;\r | |
| 911 | }\r | |
| a6973cff | 912 | \r |
| a6973cff | 913 | \r |
| 93e3992d | 914 | Status = EFI_SUCCESS;\r |
| 915 | PrivateData = DRIVER_SAMPLE_PRIVATE_FROM_THIS (This);\r | |
| 916 | \r | |
| 917 | switch (QuestionId) {\r | |
| 918 | case 0x1234:\r | |
| 919 | //\r | |
| 8d00a0f1 | 920 | // Initialize the container for dynamic opcodes\r |
| 93e3992d | 921 | //\r |
| 7e3bcccb LG |
922 | StartOpCodeHandle = HiiAllocateOpCodeHandle ();\r |
| 923 | ASSERT (StartOpCodeHandle != NULL);\r | |
| 924 | \r | |
| 925 | EndOpCodeHandle = HiiAllocateOpCodeHandle ();\r | |
| 926 | ASSERT (EndOpCodeHandle != NULL);\r | |
| 927 | \r | |
| 928 | //\r | |
| 929 | // Create Hii Extend Label OpCode as the start opcode\r | |
| 930 | //\r | |
| 931 | StartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (StartOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));\r | |
| 932 | StartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;\r | |
| 933 | StartLabel->Number = LABEL_UPDATE1;\r | |
| 934 | \r | |
| 935 | //\r | |
| 936 | // Create Hii Extend Label OpCode as the end opcode\r | |
| 937 | //\r | |
| 938 | EndLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (EndOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));\r | |
| 939 | EndLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;\r | |
| 940 | EndLabel->Number = LABEL_END;\r | |
| 941 | \r | |
| 942 | HiiCreateActionOpCode (\r | |
| 943 | StartOpCodeHandle, // Container for dynamic created opcodes\r | |
| 944 | 0x1237, // Question ID\r | |
| 945 | STRING_TOKEN(STR_EXIT_TEXT), // Prompt text\r | |
| 946 | STRING_TOKEN(STR_EXIT_TEXT), // Help text\r | |
| 947 | EFI_IFR_FLAG_CALLBACK, // Question flag\r | |
| 948 | 0 // Action String ID\r | |
| 949 | );\r | |
| 950 | \r | |
| 951 | //\r | |
| 952 | // Create Option OpCode\r | |
| 953 | //\r | |
| 954 | OptionsOpCodeHandle = HiiAllocateOpCodeHandle ();\r | |
| 955 | ASSERT (OptionsOpCodeHandle != NULL);\r | |
| 956 | \r | |
| 957 | HiiCreateOneOfOptionOpCode (\r | |
| 958 | OptionsOpCodeHandle,\r | |
| 959 | STRING_TOKEN (STR_BOOT_OPTION1),\r | |
| 960 | 0,\r | |
| 961 | EFI_IFR_NUMERIC_SIZE_1,\r | |
| 962 | 1\r | |
| 963 | );\r | |
| 964 | \r | |
| 965 | HiiCreateOneOfOptionOpCode (\r | |
| 966 | OptionsOpCodeHandle,\r | |
| 967 | STRING_TOKEN (STR_BOOT_OPTION2),\r | |
| 968 | 0,\r | |
| 969 | EFI_IFR_NUMERIC_SIZE_1,\r | |
| 970 | 2\r | |
| 971 | );\r | |
| 972 | \r | |
| 973 | //\r | |
| 974 | // Prepare initial value for the dynamic created oneof Question\r | |
| 975 | //\r | |
| 976 | PrivateData->Configuration.DynamicOneof = 2;\r | |
| 977 | Status = gRT->SetVariable(\r | |
| 978 | VariableName,\r | |
| 979 | &mFormSetGuid,\r | |
| 980 | EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r | |
| 981 | sizeof (DRIVER_SAMPLE_CONFIGURATION),\r | |
| 982 | &PrivateData->Configuration\r | |
| 983 | );\r | |
| 984 | \r | |
| a6973cff | 985 | //\r |
| 986 | // Set initial vlaue of dynamic created oneof Question in Form Browser\r | |
| 987 | //\r | |
| 988 | Configuration = AllocateZeroPool (sizeof (DRIVER_SAMPLE_CONFIGURATION));\r | |
| 989 | ASSERT (Configuration != NULL);\r | |
| 824e8a52 | 990 | if (HiiGetBrowserData (&mFormSetGuid, VariableName, sizeof (DRIVER_SAMPLE_CONFIGURATION), (UINT8 *) Configuration)) {\r |
| a6973cff | 991 | Configuration->DynamicOneof = 2;\r |
| 992 | \r | |
| 993 | //\r | |
| 994 | // Update uncommitted data of Browser\r | |
| 995 | //\r | |
| 996 | HiiSetBrowserData (\r | |
| 997 | &mFormSetGuid,\r | |
| 998 | VariableName,\r | |
| 999 | sizeof (DRIVER_SAMPLE_CONFIGURATION),\r | |
| 1000 | (UINT8 *) Configuration,\r | |
| 1001 | NULL\r | |
| 1002 | );\r | |
| 1003 | }\r | |
| 1004 | FreePool (Configuration);\r | |
| 1005 | \r | |
| 7e3bcccb LG |
1006 | HiiCreateOneOfOpCode (\r |
| 1007 | StartOpCodeHandle, // Container for dynamic created opcodes\r | |
| 1008 | 0x8001, // Question ID (or call it "key")\r | |
| 1009 | CONFIGURATION_VARSTORE_ID, // VarStore ID\r | |
| 1010 | (UINT16) DYNAMIC_ONE_OF_VAR_OFFSET, // Offset in Buffer Storage\r | |
| 1011 | STRING_TOKEN (STR_ONE_OF_PROMPT), // Question prompt text\r | |
| 1012 | STRING_TOKEN (STR_ONE_OF_HELP), // Question help text\r | |
| 1013 | EFI_IFR_FLAG_CALLBACK, // Question flag\r | |
| 1014 | EFI_IFR_NUMERIC_SIZE_1, // Data type of Question Value\r | |
| 1015 | OptionsOpCodeHandle, // Option Opcode list\r | |
| 1016 | NULL // Default Opcode is NULl\r | |
| 1017 | );\r | |
| 1018 | \r | |
| 1019 | HiiCreateOrderedListOpCode (\r | |
| 1020 | StartOpCodeHandle, // Container for dynamic created opcodes\r | |
| 1021 | 0x8002, // Question ID\r | |
| 1022 | CONFIGURATION_VARSTORE_ID, // VarStore ID\r | |
| 1023 | (UINT16) DYNAMIC_ORDERED_LIST_VAR_OFFSET, // Offset in Buffer Storage\r | |
| 1024 | STRING_TOKEN (STR_BOOT_OPTIONS), // Question prompt text\r | |
| 1025 | STRING_TOKEN (STR_BOOT_OPTIONS), // Question help text\r | |
| 1026 | EFI_IFR_FLAG_RESET_REQUIRED, // Question flag\r | |
| 1027 | 0, // Ordered list flag, e.g. EFI_IFR_UNIQUE_SET\r | |
| 1028 | EFI_IFR_NUMERIC_SIZE_1, // Data type of Question value\r | |
| 1029 | 5, // Maximum container\r | |
| 1030 | OptionsOpCodeHandle, // Option Opcode list\r | |
| 1031 | NULL // Default Opcode is NULl\r | |
| 1032 | );\r | |
| 1033 | \r | |
| 5adb8db7 LG |
1034 | HiiCreateTextOpCode (\r |
| 1035 | StartOpCodeHandle,\r | |
| 1036 | STRING_TOKEN(STR_TEXT_SAMPLE_HELP),\r | |
| 1037 | STRING_TOKEN(STR_TEXT_SAMPLE_HELP),\r | |
| 1038 | STRING_TOKEN(STR_TEXT_SAMPLE_STRING)\r | |
| 1039 | );\r | |
| 1040 | \r | |
| 1041 | HiiCreateDateOpCode (\r | |
| 1042 | StartOpCodeHandle,\r | |
| 1043 | 0x8004,\r | |
| 1044 | 0x0,\r | |
| 1045 | 0x0,\r | |
| 1046 | STRING_TOKEN(STR_DATE_SAMPLE_HELP),\r | |
| 1047 | STRING_TOKEN(STR_DATE_SAMPLE_HELP),\r | |
| 1048 | 0,\r | |
| 1049 | QF_DATE_STORAGE_TIME,\r | |
| 1050 | NULL\r | |
| 1051 | );\r | |
| 1052 | \r | |
| 1053 | HiiCreateTimeOpCode (\r | |
| 1054 | StartOpCodeHandle,\r | |
| 1055 | 0x8005,\r | |
| 1056 | 0x0,\r | |
| 1057 | 0x0,\r | |
| 1058 | STRING_TOKEN(STR_TIME_SAMPLE_HELP),\r | |
| 1059 | STRING_TOKEN(STR_TIME_SAMPLE_HELP),\r | |
| 1060 | 0,\r | |
| 1061 | QF_TIME_STORAGE_TIME,\r | |
| 1062 | NULL\r | |
| 1063 | );\r | |
| 1064 | \r | |
| 7e3bcccb LG |
1065 | HiiCreateGotoOpCode (\r |
| 1066 | StartOpCodeHandle, // Container for dynamic created opcodes\r | |
| 1067 | 1, // Target Form ID\r | |
| 1068 | STRING_TOKEN (STR_GOTO_FORM1), // Prompt text\r | |
| 1069 | STRING_TOKEN (STR_GOTO_HELP), // Help text\r | |
| 1070 | 0, // Question flag\r | |
| 1071 | 0x8003 // Question ID\r | |
| 1072 | );\r | |
| 1073 | \r | |
| 1074 | HiiUpdateForm (\r | |
| 1075 | PrivateData->HiiHandle[0], // HII handle\r | |
| 1076 | &mFormSetGuid, // Formset GUID\r | |
| 1077 | 0x1234, // Form ID\r | |
| 1078 | StartOpCodeHandle, // Label for where to insert opcodes\r | |
| 1079 | EndOpCodeHandle // Replace data\r | |
| 1080 | );\r | |
| 1081 | \r | |
| 1082 | HiiFreeOpCodeHandle (StartOpCodeHandle);\r | |
| 1083 | HiiFreeOpCodeHandle (OptionsOpCodeHandle);\r | |
| a6973cff | 1084 | HiiFreeOpCodeHandle (EndOpCodeHandle);\r |
| 7e3bcccb | 1085 | break;\r |
| a6973cff | 1086 | \r |
| 7e3bcccb LG |
1087 | case 0x5678:\r |
| 1088 | //\r | |
| 1089 | // We will reach here once the Question is refreshed\r | |
| 1090 | //\r | |
| 1091 | \r | |
| 1092 | //\r | |
| 1093 | // Initialize the container for dynamic opcodes\r | |
| 1094 | //\r | |
| 1095 | StartOpCodeHandle = HiiAllocateOpCodeHandle ();\r | |
| 1096 | ASSERT (StartOpCodeHandle != NULL);\r | |
| 1097 | \r | |
| 1098 | //\r | |
| 1099 | // Create Hii Extend Label OpCode as the start opcode\r | |
| 1100 | //\r | |
| 1101 | StartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (StartOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));\r | |
| 1102 | StartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;\r | |
| 1103 | StartLabel->Number = LABEL_UPDATE2;\r | |
| 1104 | \r | |
| 1105 | HiiCreateActionOpCode (\r | |
| 1106 | StartOpCodeHandle, // Container for dynamic created opcodes\r | |
| 1107 | 0x1237, // Question ID\r | |
| 1108 | STRING_TOKEN(STR_EXIT_TEXT), // Prompt text\r | |
| 1109 | STRING_TOKEN(STR_EXIT_TEXT), // Help text\r | |
| 1110 | EFI_IFR_FLAG_CALLBACK, // Question flag\r | |
| 1111 | 0 // Action String ID\r | |
| 1112 | );\r | |
| a6973cff | 1113 | \r |
| 7e3bcccb LG |
1114 | HiiUpdateForm (\r |
| 1115 | PrivateData->HiiHandle[0], // HII handle\r | |
| 1116 | &mFormSetGuid, // Formset GUID\r | |
| 1117 | 0x3, // Form ID\r | |
| 1118 | StartOpCodeHandle, // Label for where to insert opcodes\r | |
| 1119 | NULL // Insert data\r | |
| 1120 | );\r | |
| 1121 | \r | |
| a6973cff | 1122 | HiiFreeOpCodeHandle (StartOpCodeHandle);\r |
| 1123 | \r | |
| 7e3bcccb LG |
1124 | //\r |
| 1125 | // Refresh the Question value\r | |
| 1126 | //\r | |
| 1127 | PrivateData->Configuration.DynamicRefresh++;\r | |
| 1128 | Status = gRT->SetVariable(\r | |
| 1129 | VariableName,\r | |
| 1130 | &mFormSetGuid,\r | |
| 1131 | EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r | |
| 1132 | sizeof (DRIVER_SAMPLE_CONFIGURATION),\r | |
| 1133 | &PrivateData->Configuration\r | |
| 1134 | );\r | |
| a6973cff | 1135 | \r |
| 7e3bcccb LG |
1136 | //\r |
| 1137 | // Change an EFI Variable storage (MyEfiVar) asynchronous, this will cause\r | |
| 1138 | // the first statement in Form 3 be suppressed\r | |
| 1139 | //\r | |
| 16019c85 | 1140 | MyVarSize = 1;\r |
| 7e3bcccb LG |
1141 | MyVar = 111;\r |
| 1142 | Status = gRT->SetVariable(\r | |
| 1143 | L"MyVar",\r | |
| 1144 | &mFormSetGuid,\r | |
| 1145 | EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r | |
| 16019c85 | 1146 | MyVarSize,\r |
| 7e3bcccb LG |
1147 | &MyVar\r |
| 1148 | );\r | |
| 93e3992d | 1149 | break;\r |
| 1150 | \r | |
| 1151 | case 0x1237:\r | |
| 1152 | //\r | |
| 1153 | // User press "Exit now", request Browser to exit\r | |
| 1154 | //\r | |
| 1155 | *ActionRequest = EFI_BROWSER_ACTION_REQUEST_EXIT;\r | |
| 1156 | break;\r | |
| 1157 | \r | |
| 1158 | case 0x1238:\r | |
| 1159 | //\r | |
| 1160 | // User press "Save now", request Browser to save the uncommitted data.\r | |
| 1161 | //\r | |
| 1162 | *ActionRequest = EFI_BROWSER_ACTION_REQUEST_SUBMIT;\r | |
| 1163 | break;\r | |
| 1164 | \r | |
| 1165 | case 0x2000:\r | |
| e2100bfa ED |
1166 | //\r |
| 1167 | // Only used to update the state.\r | |
| 1168 | //\r | |
| 1169 | if ((Type == EFI_IFR_TYPE_STRING) && (Value->string == 0) && \r | |
| 1170 | (PrivateData->PasswordState == BROWSER_STATE_SET_PASSWORD)) {\r | |
| 1171 | PrivateData->PasswordState = BROWSER_STATE_VALIDATE_PASSWORD;\r | |
| 1172 | return EFI_INVALID_PARAMETER;\r | |
| 1173 | }\r | |
| 1174 | \r | |
| 93e3992d | 1175 | //\r |
| 1176 | // When try to set a new password, user will be chanlleged with old password.\r | |
| 1177 | // The Callback is responsible for validating old password input by user,\r | |
| 1178 | // If Callback return EFI_SUCCESS, it indicates validation pass.\r | |
| 1179 | //\r | |
| 1180 | switch (PrivateData->PasswordState) {\r | |
| 1181 | case BROWSER_STATE_VALIDATE_PASSWORD:\r | |
| 1182 | Status = ValidatePassword (PrivateData, Value->string);\r | |
| 1183 | if (Status == EFI_SUCCESS) {\r | |
| 1184 | PrivateData->PasswordState = BROWSER_STATE_SET_PASSWORD;\r | |
| 1185 | }\r | |
| 1186 | break;\r | |
| 1187 | \r | |
| 1188 | case BROWSER_STATE_SET_PASSWORD:\r | |
| 1189 | Status = SetPassword (PrivateData, Value->string);\r | |
| 1190 | PrivateData->PasswordState = BROWSER_STATE_VALIDATE_PASSWORD;\r | |
| 1191 | break;\r | |
| 1192 | \r | |
| 1193 | default:\r | |
| 1194 | break;\r | |
| 1195 | }\r | |
| 1196 | \r | |
| 1197 | break;\r | |
| 1198 | \r | |
| 16019c85 LG |
1199 | case 0x1111:\r |
| 1200 | //\r | |
| 1201 | // EfiVarstore question takes sample action (print value as debug information) \r | |
| 1202 | // after read/write question.\r | |
| 1203 | //\r | |
| 1204 | MyVarSize = 1;\r | |
| 1205 | Status = gRT->GetVariable(\r | |
| 1206 | L"MyVar",\r | |
| 1207 | &mFormSetGuid,\r | |
| 1208 | NULL,\r | |
| 1209 | &MyVarSize,\r | |
| 1210 | &MyVar\r | |
| 1211 | );\r | |
| 1212 | ASSERT_EFI_ERROR (Status);\r | |
| 1213 | DEBUG ((DEBUG_INFO, "EfiVarstore question: Tall value is %d with value width %d\n", MyVar, MyVarSize));\r | |
| 93e3992d | 1214 | default:\r |
| 1215 | break;\r | |
| 1216 | }\r | |
| 1217 | \r | |
| 1218 | return Status;\r | |
| 1219 | }\r | |
| 1220 | \r | |
| 7064c0a5 | 1221 | /**\r |
| 1222 | Main entry for this driver.\r | |
| a6973cff | 1223 | \r |
| 7064c0a5 | 1224 | @param ImageHandle Image handle this driver.\r |
| 1225 | @param SystemTable Pointer to SystemTable.\r | |
| 1226 | \r | |
| 1227 | @retval EFI_SUCESS This function always complete successfully.\r | |
| 1228 | \r | |
| 1229 | **/\r | |
| 93e3992d | 1230 | EFI_STATUS\r |
| 1231 | EFIAPI\r | |
| 1232 | DriverSampleInit (\r | |
| 1233 | IN EFI_HANDLE ImageHandle,\r | |
| 1234 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
| 1235 | )\r | |
| 1236 | {\r | |
| 1237 | EFI_STATUS Status;\r | |
| 93e3992d | 1238 | EFI_HII_HANDLE HiiHandle[2];\r |
| 93e3992d | 1239 | EFI_SCREEN_DESCRIPTOR Screen;\r |
| 1240 | EFI_HII_DATABASE_PROTOCOL *HiiDatabase;\r | |
| 1241 | EFI_HII_STRING_PROTOCOL *HiiString;\r | |
| 1242 | EFI_FORM_BROWSER2_PROTOCOL *FormBrowser2;\r | |
| 1243 | EFI_HII_CONFIG_ROUTING_PROTOCOL *HiiConfigRouting;\r | |
| 1244 | CHAR16 *NewString;\r | |
| 1245 | UINTN BufferSize;\r | |
| 1246 | DRIVER_SAMPLE_CONFIGURATION *Configuration;\r | |
| 84f9a9ec | 1247 | BOOLEAN ActionFlag;\r |
| a6973cff | 1248 | EFI_STRING ConfigRequestHdr;\r |
| 1249 | \r | |
| 93e3992d | 1250 | //\r |
| 84f9a9ec | 1251 | // Initialize the local variables.\r |
| 93e3992d | 1252 | //\r |
| 84f9a9ec | 1253 | ConfigRequestHdr = NULL;\r |
| 93e3992d | 1254 | //\r |
| 1255 | // Initialize screen dimensions for SendForm().\r | |
| 1256 | // Remove 3 characters from top and bottom\r | |
| 1257 | //\r | |
| 1258 | ZeroMem (&Screen, sizeof (EFI_SCREEN_DESCRIPTOR));\r | |
| 1259 | gST->ConOut->QueryMode (gST->ConOut, gST->ConOut->Mode->Mode, &Screen.RightColumn, &Screen.BottomRow);\r | |
| 1260 | \r | |
| 1261 | Screen.TopRow = 3;\r | |
| 1262 | Screen.BottomRow = Screen.BottomRow - 3;\r | |
| 1263 | \r | |
| 1264 | //\r | |
| 1265 | // Initialize driver private data\r | |
| 1266 | //\r | |
| ccee6099 | 1267 | PrivateData = AllocateZeroPool (sizeof (DRIVER_SAMPLE_PRIVATE_DATA));\r |
| 93e3992d | 1268 | if (PrivateData == NULL) {\r |
| 1269 | return EFI_OUT_OF_RESOURCES;\r | |
| 1270 | }\r | |
| 1271 | \r | |
| 1272 | PrivateData->Signature = DRIVER_SAMPLE_PRIVATE_SIGNATURE;\r | |
| 1273 | \r | |
| 1274 | PrivateData->ConfigAccess.ExtractConfig = ExtractConfig;\r | |
| 1275 | PrivateData->ConfigAccess.RouteConfig = RouteConfig;\r | |
| 1276 | PrivateData->ConfigAccess.Callback = DriverCallback;\r | |
| 1277 | PrivateData->PasswordState = BROWSER_STATE_VALIDATE_PASSWORD;\r | |
| 1278 | \r | |
| 1279 | //\r | |
| 1280 | // Locate Hii Database protocol\r | |
| 1281 | //\r | |
| 1282 | Status = gBS->LocateProtocol (&gEfiHiiDatabaseProtocolGuid, NULL, (VOID **) &HiiDatabase);\r | |
| 1283 | if (EFI_ERROR (Status)) {\r | |
| 1284 | return Status;\r | |
| 1285 | }\r | |
| 1286 | PrivateData->HiiDatabase = HiiDatabase;\r | |
| 1287 | \r | |
| 1288 | //\r | |
| 1289 | // Locate HiiString protocol\r | |
| 1290 | //\r | |
| 1291 | Status = gBS->LocateProtocol (&gEfiHiiStringProtocolGuid, NULL, (VOID **) &HiiString);\r | |
| 1292 | if (EFI_ERROR (Status)) {\r | |
| 1293 | return Status;\r | |
| 1294 | }\r | |
| 1295 | PrivateData->HiiString = HiiString;\r | |
| 1296 | \r | |
| 1297 | //\r | |
| 1298 | // Locate Formbrowser2 protocol\r | |
| 1299 | //\r | |
| 1300 | Status = gBS->LocateProtocol (&gEfiFormBrowser2ProtocolGuid, NULL, (VOID **) &FormBrowser2);\r | |
| 1301 | if (EFI_ERROR (Status)) {\r | |
| 1302 | return Status;\r | |
| 1303 | }\r | |
| 1304 | PrivateData->FormBrowser2 = FormBrowser2;\r | |
| 1305 | \r | |
| 1306 | //\r | |
| 1307 | // Locate ConfigRouting protocol\r | |
| 1308 | //\r | |
| 1309 | Status = gBS->LocateProtocol (&gEfiHiiConfigRoutingProtocolGuid, NULL, (VOID **) &HiiConfigRouting);\r | |
| 1310 | if (EFI_ERROR (Status)) {\r | |
| 1311 | return Status;\r | |
| 1312 | }\r | |
| 1313 | PrivateData->HiiConfigRouting = HiiConfigRouting;\r | |
| 1314 | \r | |
| f6f910dd | 1315 | Status = gBS->InstallMultipleProtocolInterfaces (\r |
| 93e3992d | 1316 | &DriverHandle[0],\r |
| f6f910dd | 1317 | &gEfiDevicePathProtocolGuid,\r |
| 2f3065c0 | 1318 | &mHiiVendorDevicePath0,\r |
| 93e3992d | 1319 | &gEfiHiiConfigAccessProtocolGuid,\r |
| f6f910dd | 1320 | &PrivateData->ConfigAccess,\r |
| 1321 | NULL\r | |
| 93e3992d | 1322 | );\r |
| 1323 | ASSERT_EFI_ERROR (Status);\r | |
| 1324 | \r | |
| f6f910dd | 1325 | PrivateData->DriverHandle[0] = DriverHandle[0];\r |
| 1326 | \r | |
| 93e3992d | 1327 | //\r |
| 1328 | // Publish our HII data\r | |
| 1329 | //\r | |
| cb7d01c0 | 1330 | HiiHandle[0] = HiiAddPackages (\r |
| 1331 | &mFormSetGuid,\r | |
| 1332 | DriverHandle[0],\r | |
| 1333 | DriverSampleStrings,\r | |
| 1334 | VfrBin,\r | |
| 1335 | NULL\r | |
| 1336 | );\r | |
| 1337 | if (HiiHandle[0] == NULL) {\r | |
| 93e3992d | 1338 | return EFI_OUT_OF_RESOURCES;\r |
| 1339 | }\r | |
| 1340 | \r | |
| 93e3992d | 1341 | PrivateData->HiiHandle[0] = HiiHandle[0];\r |
| 1342 | \r | |
| 1343 | //\r | |
| 1344 | // Publish another Fromset\r | |
| 1345 | //\r | |
| f6f910dd | 1346 | Status = gBS->InstallMultipleProtocolInterfaces (\r |
| 1347 | &DriverHandle[1],\r | |
| 1348 | &gEfiDevicePathProtocolGuid,\r | |
| 2f3065c0 | 1349 | &mHiiVendorDevicePath1,\r |
| f6f910dd | 1350 | NULL\r |
| 1351 | );\r | |
| 1352 | ASSERT_EFI_ERROR (Status);\r | |
| 1353 | \r | |
| 93e3992d | 1354 | PrivateData->DriverHandle[1] = DriverHandle[1];\r |
| 1355 | \r | |
| cb7d01c0 | 1356 | HiiHandle[1] = HiiAddPackages (\r |
| 1357 | &mInventoryGuid,\r | |
| 1358 | DriverHandle[1],\r | |
| 1359 | DriverSampleStrings,\r | |
| 1360 | InventoryBin,\r | |
| 1361 | NULL\r | |
| 1362 | );\r | |
| 1363 | if (HiiHandle[1] == NULL) {\r | |
| 38ebfecb | 1364 | DriverSampleUnload (ImageHandle);\r |
| 93e3992d | 1365 | return EFI_OUT_OF_RESOURCES;\r |
| 1366 | }\r | |
| 1367 | \r | |
| 93e3992d | 1368 | PrivateData->HiiHandle[1] = HiiHandle[1];\r |
| 1369 | \r | |
| 1370 | //\r | |
| 1371 | // Very simple example of how one would update a string that is already\r | |
| 1372 | // in the HII database\r | |
| 1373 | //\r | |
| 1374 | NewString = L"700 Mhz";\r | |
| 1375 | \r | |
| cb7d01c0 | 1376 | if (HiiSetString (HiiHandle[0], STRING_TOKEN (STR_CPU_STRING2), NewString, NULL) == 0) {\r |
| 38ebfecb | 1377 | DriverSampleUnload (ImageHandle);\r |
| cb7d01c0 | 1378 | return EFI_OUT_OF_RESOURCES;\r |
| 93e3992d | 1379 | }\r |
| 1380 | \r | |
| 38ebfecb LG |
1381 | HiiSetString (HiiHandle[0], 0, NewString, NULL);\r |
| 1382 | \r | |
| 1383 | //\r | |
| 1384 | // Initialize Name/Value name String ID\r | |
| 1385 | //\r | |
| 1386 | PrivateData->NameStringId[0] = STR_NAME_VALUE_VAR_NAME0;\r | |
| 1387 | PrivateData->NameStringId[1] = STR_NAME_VALUE_VAR_NAME1;\r | |
| 1388 | PrivateData->NameStringId[2] = STR_NAME_VALUE_VAR_NAME2;\r | |
| 1389 | \r | |
| 93e3992d | 1390 | //\r |
| 1391 | // Initialize configuration data\r | |
| 1392 | //\r | |
| 1393 | Configuration = &PrivateData->Configuration;\r | |
| 1394 | ZeroMem (Configuration, sizeof (DRIVER_SAMPLE_CONFIGURATION));\r | |
| 1395 | \r | |
| 1396 | //\r | |
| 1397 | // Try to read NV config EFI variable first\r | |
| 1398 | //\r | |
| 84f9a9ec LG |
1399 | ConfigRequestHdr = HiiConstructConfigHdr (&mFormSetGuid, VariableName, DriverHandle[0]);\r |
| 1400 | ASSERT (ConfigRequestHdr != NULL);\r | |
| 1401 | \r | |
| 93e3992d | 1402 | BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r |
| 1403 | Status = gRT->GetVariable (VariableName, &mFormSetGuid, NULL, &BufferSize, Configuration);\r | |
| 84f9a9ec | 1404 | if (EFI_ERROR (Status)) {\r |
| 04da0b4a LG |
1405 | //\r |
| 1406 | // Store zero data Buffer Storage to EFI variable\r | |
| 1407 | //\r | |
| 1408 | Status = gRT->SetVariable(\r | |
| 1409 | VariableName,\r | |
| 1410 | &mFormSetGuid,\r | |
| 1411 | EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r | |
| 1412 | sizeof (DRIVER_SAMPLE_CONFIGURATION),\r | |
| 1413 | Configuration\r | |
| 1414 | );\r | |
| 1415 | ASSERT (Status == EFI_SUCCESS);\r | |
| 93e3992d | 1416 | //\r |
| 1417 | // EFI variable for NV config doesn't exit, we should build this variable\r | |
| 1418 | // based on default values stored in IFR\r | |
| 1419 | //\r | |
| 84f9a9ec LG |
1420 | ActionFlag = HiiSetToDefaults (ConfigRequestHdr, EFI_HII_DEFAULT_CLASS_STANDARD);\r |
| 1421 | ASSERT (ActionFlag);\r | |
| 1422 | } else {\r | |
| 1423 | //\r | |
| 1424 | // EFI variable does exist and Validate Current Setting\r | |
| 1425 | //\r | |
| 1426 | ActionFlag = HiiValidateSettings (ConfigRequestHdr);\r | |
| 1427 | ASSERT (ActionFlag);\r | |
| 93e3992d | 1428 | }\r |
| a6973cff | 1429 | \r |
| 84f9a9ec LG |
1430 | FreePool (ConfigRequestHdr);\r |
| 1431 | \r | |
| 93e3992d | 1432 | \r |
| 1433 | //\r | |
| a6973cff | 1434 | // In default, this driver is built into Flash device image,\r |
| 7e3bcccb | 1435 | // the following code doesn't run.\r |
| 93e3992d | 1436 | //\r |
| 7e3bcccb | 1437 | \r |
| 2f3065c0 | 1438 | //\r |
| 7e3bcccb | 1439 | // Example of how to display only the item we sent to HII\r |
| a6973cff | 1440 | // When this driver is not built into Flash device image,\r |
| 7e3bcccb | 1441 | // it need to call SendForm to show front page by itself.\r |
| 2f3065c0 | 1442 | //\r |
| 7e3bcccb LG |
1443 | if (DISPLAY_ONLY_MY_ITEM <= 1) {\r |
| 1444 | //\r | |
| 1445 | // Have the browser pull out our copy of the data, and only display our data\r | |
| 1446 | //\r | |
| 1447 | Status = FormBrowser2->SendForm (\r | |
| 1448 | FormBrowser2,\r | |
| 1449 | &(HiiHandle[DISPLAY_ONLY_MY_ITEM]),\r | |
| 1450 | 1,\r | |
| 1451 | NULL,\r | |
| 1452 | 0,\r | |
| 1453 | NULL,\r | |
| 1454 | NULL\r | |
| 1455 | );\r | |
| a6973cff | 1456 | \r |
| 14d59fa1 | 1457 | HiiRemovePackages (HiiHandle[0]);\r |
| a6973cff | 1458 | \r |
| 14d59fa1 | 1459 | HiiRemovePackages (HiiHandle[1]);\r |
| 2f3065c0 LG |
1460 | }\r |
| 1461 | \r | |
| 84f9a9ec | 1462 | return EFI_SUCCESS;\r |
| 2f3065c0 LG |
1463 | }\r |
| 1464 | \r | |
| 1465 | /**\r | |
| 1466 | Unloads the application and its installed protocol.\r | |
| 1467 | \r | |
| 1468 | @param[in] ImageHandle Handle that identifies the image to be unloaded.\r | |
| 1469 | \r | |
| 1470 | @retval EFI_SUCCESS The image has been unloaded.\r | |
| 1471 | **/\r | |
| 1472 | EFI_STATUS\r | |
| 1473 | EFIAPI\r | |
| 1474 | DriverSampleUnload (\r | |
| 1475 | IN EFI_HANDLE ImageHandle\r | |
| 1476 | )\r | |
| 1477 | {\r | |
| 38ebfecb | 1478 | UINTN Index;\r |
| f0c855b2 | 1479 | \r |
| 1480 | ASSERT (PrivateData != NULL);\r | |
| 1481 | \r | |
| 2f3065c0 LG |
1482 | if (DriverHandle[0] != NULL) {\r |
| 1483 | gBS->UninstallMultipleProtocolInterfaces (\r | |
| 1484 | DriverHandle[0],\r | |
| 1485 | &gEfiDevicePathProtocolGuid,\r | |
| 1486 | &mHiiVendorDevicePath0,\r | |
| 1487 | &gEfiHiiConfigAccessProtocolGuid,\r | |
| 1488 | &PrivateData->ConfigAccess,\r | |
| 1489 | NULL\r | |
| 1490 | );\r | |
| ccee6099 | 1491 | DriverHandle[0] = NULL;\r |
| 2f3065c0 LG |
1492 | }\r |
| 1493 | \r | |
| 1494 | if (DriverHandle[1] != NULL) {\r | |
| 1495 | gBS->UninstallMultipleProtocolInterfaces (\r | |
| 1496 | DriverHandle[1],\r | |
| 1497 | &gEfiDevicePathProtocolGuid,\r | |
| 1498 | &mHiiVendorDevicePath1,\r | |
| 1499 | NULL\r | |
| 1500 | );\r | |
| ccee6099 | 1501 | DriverHandle[1] = NULL;\r |
| 2f3065c0 LG |
1502 | }\r |
| 1503 | \r | |
| 14d59fa1 LG |
1504 | if (PrivateData->HiiHandle[0] != NULL) {\r |
| 1505 | HiiRemovePackages (PrivateData->HiiHandle[0]);\r | |
| 1506 | }\r | |
| 1507 | \r | |
| 1508 | if (PrivateData->HiiHandle[1] != NULL) {\r | |
| 1509 | HiiRemovePackages (PrivateData->HiiHandle[1]);\r | |
| 1510 | }\r | |
| 1511 | \r | |
| f0c855b2 | 1512 | for (Index = 0; Index < NAME_VALUE_NAME_NUMBER; Index++) {\r |
| 1513 | if (PrivateData->NameValueName[Index] != NULL) {\r | |
| 1514 | FreePool (PrivateData->NameValueName[Index]);\r | |
| 38ebfecb | 1515 | }\r |
| 93e3992d | 1516 | }\r |
| f0c855b2 | 1517 | FreePool (PrivateData);\r |
| 1518 | PrivateData = NULL;\r | |
| 93e3992d | 1519 | \r |
| 1520 | return EFI_SUCCESS;\r | |
| 1521 | }\r |