ShellPkg/Library/UefiShellBcfgCommandLib/UefiShellBcfgCommandLib.c

   1 /** @file
   2   Main file for BCFG command.
   3
   4   Copyright (c) 2014, Hewlett-Packard Development Company, L.P.<BR>
   5   Copyright (c) 2010 - 2014, Intel Corporation. All rights reserved.<BR>
   6   This program and the accompanying materials
   7   are licensed and made available under the terms and conditions of the BSD License
   8   which accompanies this distribution.  The full text of the license may be found at
   9   http://opensource.org/licenses/bsd-license.php
  10
  11   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16
  17 #include <Uefi.h>
  18 #include <ShellBase.h>
  19
  20 #include <Guid/GlobalVariable.h>
  21 #include <Guid/ShellLibHiiGuid.h>
  22
  23 #include <Protocol/EfiShell.h>
  24 #include <Protocol/EfiShellParameters.h>
  25 #include <Protocol/DevicePath.h>
  26 #include <Protocol/LoadedImage.h>
  27 #include <Protocol/UnicodeCollation.h>
  28
  29 #include <Library/BaseLib.h>
  30 #include <Library/BaseMemoryLib.h>
  31 #include <Library/DebugLib.h>
  32 #include <Library/MemoryAllocationLib.h>
  33 #include <Library/PcdLib.h>
  34 #include <Library/ShellCommandLib.h>
  35 #include <Library/ShellLib.h>
  36 #include <Library/SortLib.h>
  37 #include <Library/UefiLib.h>
  38 #include <Library/UefiRuntimeServicesTableLib.h>
  39 #include <Library/UefiBootServicesTableLib.h>
  40 #include <Library/HiiLib.h>
  41 #include <Library/FileHandleLib.h>
  42 #include <Library/PrintLib.h>
  43 #include <Library/HandleParsingLib.h>
  44 #include <Library/DevicePathLib.h>
  45
  46 STATIC CONST CHAR16 mFileName[] = L"ShellCommands";
  47 STATIC EFI_HANDLE gShellBcfgHiiHandle  = NULL;
  48
  49 typedef enum {
  50   BcfgTargetBootOrder    = 0,
  51   BcfgTargetDriverOrder  = 1,
  52   BcfgTargetMax          = 2
  53 } BCFG_OPERATION_TARGET;
  54
  55 typedef enum {
  56   BcfgTypeDump       = 0,
  57   BcfgTypeAdd        = 1,
  58   BcfgTypeAddp       = 2,
  59   BcfgTypeAddh       = 3,
  60   BcfgTypeRm         = 4,
  61   BcfgTypeMv         = 5,
  62   BcfgTypeOpt        = 6,
  63   BcfgTypeMax        = 7
  64 } BCFG_OPERATION_TYPE;
  65
  66 typedef struct {
  67   BCFG_OPERATION_TARGET Target;
  68   BCFG_OPERATION_TYPE   Type;
  69   UINT16                Number1;
  70   UINT16                Number2;
  71   UINTN                 HandleIndex;
  72   CHAR16                *FileName;
  73   CHAR16                *Description;
  74   UINT16                *Order;
  75   CONST CHAR16          *OptData;
  76 } BGFG_OPERATION;
  77
  78 /**
  79   Update the optional data for a boot or driver option.
  80
  81   If optional data exists it will be changed.
  82
  83   @param[in]      Index     The boot or driver option index update.
  84   @param[in]      DataSize  The size in bytes of Data.
  85   @param[in]      Data      The buffer for the optioanl data.
  86   @param[in]      Target    The target of the operation.
  87
  88   @retval EFI_SUCCESS       The data was sucessfully updated.
  89   @retval other             A error occured.
  90 **/
  91 EFI_STATUS
  92 EFIAPI
  93 UpdateOptionalData(
  94   UINT16                          Index,
  95   UINTN                           DataSize,
  96   UINT8                           *Data,
  97   IN CONST BCFG_OPERATION_TARGET  Target
  98   )
  99 {
 100   EFI_STATUS  Status;
 101   CHAR16      VariableName[12];
 102   UINTN       OriginalSize;
 103   UINT8       *OriginalData;
 104   UINTN       NewSize;
 105   UINT8       *NewData;
 106   UINTN       OriginalOptionDataSize;
 107
 108   UnicodeSPrint(VariableName, sizeof(VariableName), L"%s%04x", Target == BcfgTargetBootOrder?L"Boot":L"Driver", Index);
 109
 110   OriginalSize = 0;
 111   OriginalData = NULL;
 112   NewData      = NULL;
 113   NewSize      = 0;
 114
 115   Status = gRT->GetVariable(
 116       VariableName,
 117       (EFI_GUID*)&gEfiGlobalVariableGuid,
 118       NULL,
 119       &OriginalSize,
 120       OriginalData);
 121   if (Status == EFI_BUFFER_TOO_SMALL) {
 122     OriginalData = AllocateZeroPool(OriginalSize);
 123     if (OriginalData == NULL) {
 124       return (EFI_OUT_OF_RESOURCES);
 125     }
 126     Status = gRT->GetVariable(
 127         VariableName,
 128         (EFI_GUID*)&gEfiGlobalVariableGuid,
 129         NULL,
 130         &OriginalSize,
 131         OriginalData);
 132   }
 133
 134   if (!EFI_ERROR(Status)) {
 135     //
 136     // Allocate new struct and discard old optional data.
 137     //
 138     ASSERT (OriginalData != NULL);
 139     OriginalOptionDataSize  = sizeof(UINT32) + sizeof(UINT16) + StrSize(((CHAR16*)(OriginalData + sizeof(UINT32) + sizeof(UINT16))));
 140     OriginalOptionDataSize += (*(UINT16*)(OriginalData + sizeof(UINT32)));
 141     OriginalOptionDataSize -= OriginalSize;
 142     NewSize = OriginalSize - OriginalOptionDataSize + DataSize;
 143     NewData = AllocateCopyPool(NewSize, OriginalData);
 144     if (NewData == NULL) {
 145       Status = EFI_OUT_OF_RESOURCES;
 146     } else {
 147       CopyMem(NewData + OriginalSize - OriginalOptionDataSize, Data, DataSize);
 148     }
 149   }
 150
 151   if (!EFI_ERROR(Status)) {
 152     //
 153     // put the data back under the variable
 154     //
 155     Status = gRT->SetVariable(
 156       VariableName,
 157       (EFI_GUID*)&gEfiGlobalVariableGuid,
 158       EFI_VARIABLE_NON_VOLATILE|EFI_VARIABLE_BOOTSERVICE_ACCESS|EFI_VARIABLE_RUNTIME_ACCESS,
 159       NewSize,
 160       NewData);
 161   }
 162
 163   SHELL_FREE_NON_NULL(OriginalData);
 164   SHELL_FREE_NON_NULL(NewData);
 165   return (Status);
 166 }
 167
 168 /**
 169   This function will get a CRC for a boot option.
 170
 171   @param[in, out] Crc         The CRC value to return.
 172   @param[in]      BootIndex   The boot option index to CRC.
 173
 174   @retval EFI_SUCCESS           The CRC was sucessfully returned.
 175   @retval other                 A error occured.
 176 **/
 177 EFI_STATUS
 178 EFIAPI
 179 GetBootOptionCrc(
 180   UINT32      *Crc,
 181   UINT16      BootIndex
 182   )
 183 {
 184   CHAR16      VariableName[12];
 185   EFI_STATUS  Status;
 186   UINT8       *Buffer;
 187   UINTN       BufferSize;
 188
 189   Buffer      = NULL;
 190   BufferSize  = 0;
 191
 192   //
 193   // Get the data Buffer
 194   //
 195   UnicodeSPrint(VariableName, sizeof(VariableName), L"%Boot%04x", BootIndex);
 196   Status = gRT->GetVariable(
 197       VariableName,
 198       (EFI_GUID*)&gEfiGlobalVariableGuid,
 199       NULL,
 200       &BufferSize,
 201       NULL);
 202   if (Status == EFI_BUFFER_TOO_SMALL) {
 203     Buffer = AllocateZeroPool(BufferSize);
 204     Status = gRT->GetVariable(
 205         VariableName,
 206         (EFI_GUID*)&gEfiGlobalVariableGuid,
 207         NULL,
 208         &BufferSize,
 209         Buffer);
 210   }
 211
 212   //
 213   // Get the CRC computed
 214   //
 215   if (!EFI_ERROR(Status)) {
 216     Status = gBS->CalculateCrc32 (Buffer, BufferSize, Crc);
 217   }
 218
 219   SHELL_FREE_NON_NULL(Buffer);
 220   return EFI_SUCCESS;
 221 }
 222
 223 /**
 224   This function will populate the device path protocol parameter based on TheHandle.
 225
 226   @param[in]      TheHandle     Driver handle.
 227   @param[in, out] FilePath      On a sucessful return the device path to the handle.
 228
 229   @retval EFI_SUCCESS           The device path was sucessfully returned.
 230   @retval other                 A error from gBS->HandleProtocol.
 231
 232   @sa HandleProtocol
 233 **/
 234 EFI_STATUS
 235 EFIAPI
 236 GetDevicePathForDriverHandle (
 237   IN EFI_HANDLE                   TheHandle,
 238   IN OUT EFI_DEVICE_PATH_PROTOCOL **FilePath
 239   )
 240 {
 241   EFI_STATUS                Status;
 242   EFI_LOADED_IMAGE_PROTOCOL *LoadedImage;
 243   EFI_DEVICE_PATH_PROTOCOL  *ImageDevicePath;
 244
 245   Status = gBS->OpenProtocol (
 246                 TheHandle,
 247                 &gEfiLoadedImageProtocolGuid,
 248                 (VOID**)&LoadedImage,
 249                 gImageHandle,
 250                 NULL,
 251                 EFI_OPEN_PROTOCOL_GET_PROTOCOL
 252                );
 253   if (!EFI_ERROR (Status)) {
 254     Status = gBS->OpenProtocol (
 255                   LoadedImage->DeviceHandle,
 256                   &gEfiDevicePathProtocolGuid,
 257                   (VOID**)&ImageDevicePath,
 258                   gImageHandle,
 259                   NULL,
 260                   EFI_OPEN_PROTOCOL_GET_PROTOCOL
 261                  );
 262     if (!EFI_ERROR (Status)) {
 263 //      *DevPath  = DuplicateDevicePath (ImageDevicePath);
 264 //      *FilePath = DuplicateDevicePath (LoadedImage->FilePath);
 265         *FilePath = AppendDevicePath(ImageDevicePath,LoadedImage->FilePath);
 266       gBS->CloseProtocol(
 267                   LoadedImage->DeviceHandle,
 268                   &gEfiDevicePathProtocolGuid,
 269                   gImageHandle,
 270                   NULL);
 271     }
 272     gBS->CloseProtocol(
 273                 TheHandle,
 274                 &gEfiLoadedImageProtocolGuid,
 275                 gImageHandle,
 276                 NULL);
 277   }
 278   return (Status);
 279 }
 280
 281 /**
 282   Function to add a option.
 283
 284   @param[in] Position       The position to add Target at.
 285   @param[in] File           The file to make the target.
 286   @param[in] Desc           The description text.
 287   @param[in] CurrentOrder   The pointer to the current order of items.
 288   @param[in] OrderCount     The number if items in CurrentOrder.
 289   @param[in] Target         The info on the option to add.
 290   @param[in] UseHandle      TRUE to use HandleNumber, FALSE to use File and Desc.
 291   @param[in] UsePath        TRUE to convert to devicepath.
 292   @param[in] HandleNumber   The handle number to add.
 293
 294   @retval SHELL_SUCCESS             The operation was successful.
 295   @retval SHELL_INVALID_PARAMETER   A parameter was invalid.
 296 **/
 297 SHELL_STATUS
 298 EFIAPI
 299 BcfgAdd(
 300   IN       UINTN                  Position,
 301   IN CONST CHAR16                 *File,
 302   IN CONST CHAR16                 *Desc,
 303   IN CONST UINT16                 *CurrentOrder,
 304   IN CONST UINTN                  OrderCount,
 305   IN CONST BCFG_OPERATION_TARGET  Target,
 306   IN CONST BOOLEAN                UseHandle,
 307   IN CONST BOOLEAN                UsePath,
 308   IN CONST UINTN                  HandleNumber
 309   )
 310 {
 311   EFI_STATUS                Status;
 312   EFI_DEVICE_PATH_PROTOCOL  *DevicePath;
 313   EFI_DEVICE_PATH_PROTOCOL  *FilePath;
 314   CHAR16                    *Str;
 315   UINT8                     *TempByteBuffer;
 316   UINT8                     *TempByteStart;
 317   EFI_SHELL_FILE_INFO       *Arg;
 318   EFI_SHELL_FILE_INFO       *FileList;
 319   CHAR16                    OptionStr[40];
 320   UINTN                     DescSize, FilePathSize;
 321   BOOLEAN                   Found;
 322   UINTN                     TargetLocation;
 323   UINTN                     Index;
 324   EFI_HANDLE                *Handles;
 325   EFI_HANDLE                CurHandle;
 326   UINTN                     DriverBindingHandleCount;
 327   UINTN                     ParentControllerHandleCount;
 328   UINTN                     ChildControllerHandleCount;
 329   SHELL_STATUS              ShellStatus;
 330   UINT16                    *NewOrder;
 331
 332   if (!UseHandle) {
 333     if (File == NULL || Desc == NULL) {
 334       return (SHELL_INVALID_PARAMETER);
 335     }
 336   } else {
 337     if (HandleNumber == 0) {
 338       return (SHELL_INVALID_PARAMETER);
 339     }
 340   }
 341
 342   if (Position > OrderCount) {
 343     Position =  OrderCount;
 344   }
 345
 346   Str             = NULL;
 347   FilePath        = NULL;
 348   FileList        = NULL;
 349   Handles         = NULL;
 350   ShellStatus     = SHELL_SUCCESS;
 351   TargetLocation  = 0xFFFF;
 352
 353   if (UseHandle) {
 354     CurHandle = ConvertHandleIndexToHandle(HandleNumber);
 355     if (CurHandle == NULL) {
 356       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellBcfgHiiHandle, L"Handle Number");
 357       ShellStatus = SHELL_INVALID_PARAMETER;
 358     } else {
 359       if (Target == BcfgTargetBootOrder) {
 360         //
 361         //Make sure that the handle should point to a real controller
 362         //
 363         Status = PARSE_HANDLE_DATABASE_UEFI_DRIVERS (
 364                    CurHandle,
 365                    &DriverBindingHandleCount,
 366                    NULL);
 367
 368         Status = PARSE_HANDLE_DATABASE_PARENTS (
 369                    CurHandle,
 370                    &ParentControllerHandleCount,
 371                    NULL);
 372
 373         Status = ParseHandleDatabaseForChildControllers (
 374                    CurHandle,
 375                    &ChildControllerHandleCount,
 376                    NULL);
 377
 378         if (DriverBindingHandleCount > 0
 379               || ParentControllerHandleCount > 0
 380               || ChildControllerHandleCount > 0) {
 381           FilePath = NULL;
 382           Status = gBS->HandleProtocol (
 383                      CurHandle,
 384                      &gEfiDevicePathProtocolGuid,
 385                      (VOID**)&FilePath);
 386         }
 387         if (EFI_ERROR (Status)) {
 388           ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_BCFG_HANDLE), gShellBcfgHiiHandle, HandleNumber);
 389           ShellStatus = SHELL_INVALID_PARAMETER;
 390         }
 391       } else {
 392         //
 393         //Make sure that the handle should point to driver, not a controller.
 394         //
 395         Status = PARSE_HANDLE_DATABASE_UEFI_DRIVERS (
 396                    CurHandle,
 397                    &DriverBindingHandleCount,
 398                    NULL);
 399
 400         Status = PARSE_HANDLE_DATABASE_PARENTS (
 401                    CurHandle,
 402                    &ParentControllerHandleCount,
 403                    NULL);
 404
 405         Status = ParseHandleDatabaseForChildControllers (
 406                    CurHandle,
 407                    &ChildControllerHandleCount,
 408                    NULL);
 409
 410         Status = gBS->HandleProtocol (
 411                    CurHandle,
 412                    &gEfiDevicePathProtocolGuid,
 413                    (VOID**)&FilePath);
 414
 415         if (DriverBindingHandleCount > 0
 416               || ParentControllerHandleCount > 0
 417               || ChildControllerHandleCount > 0
 418               || !EFI_ERROR(Status) ) {
 419           ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellBcfgHiiHandle, L"Handle Number");
 420           ShellStatus = SHELL_INVALID_PARAMETER;
 421         } else {
 422           //
 423           // Get the DevicePath from the loaded image information.
 424           //
 425           Status = GetDevicePathForDriverHandle(CurHandle, &FilePath);
 426         }
 427       }
 428     }
 429   } else {
 430     //
 431     // Get file info
 432     //
 433     ShellOpenFileMetaArg ((CHAR16*)File, EFI_FILE_MODE_READ, &FileList);
 434
 435     if (FileList == NULL) {
 436       //
 437       // If filename matched nothing fail
 438       //
 439       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_FILE_OPEN_FAIL), gShellBcfgHiiHandle, File);
 440       ShellStatus = SHELL_INVALID_PARAMETER;
 441     } else if (FileList->Link.ForwardLink != FileList->Link.BackLink) {
 442       //
 443       // If filename expanded to multiple names, fail
 444       //
 445       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_BCFG_FILE), gShellBcfgHiiHandle, File);
 446       ShellStatus = SHELL_INVALID_PARAMETER;
 447     } else {
 448       Arg = (EFI_SHELL_FILE_INFO*)GetFirstNode(&FileList->Link);
 449       if (EFI_ERROR(Arg->Status)) {
 450         ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_BCFG_FILE_OPEN), gShellBcfgHiiHandle, File, Arg->Status);
 451         ShellStatus = SHELL_INVALID_PARAMETER;
 452       } else {
 453         //
 454         // Build FilePath to the filename
 455         //
 456
 457         //
 458         // get the device path
 459         //
 460         DevicePath = gEfiShellProtocol->GetDevicePathFromFilePath(Arg->FullName);
 461         if (DevicePath == NULL) {
 462           ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_BCFG_FILE_DP), gShellBcfgHiiHandle, Arg->FullName);
 463           ShellStatus = SHELL_UNSUPPORTED;
 464         } else {
 465 /*
 466           if (UsePath) {
 467             DevPath = DevicePath;
 468             while (!IsDevicePathEnd(DevPath)) {
 469               if ((DevicePathType(DevPath) == MEDIA_DEVICE_PATH) &&
 470                 (DevicePathSubType(DevPath) == MEDIA_HARDDRIVE_DP)) {
 471
 472                 //
 473                 // If we find it use it instead
 474                 //
 475                 DevicePath = DevPath;
 476                 break;
 477               }
 478               DevPath = NextDevicePathNode(DevPath);
 479             }
 480             //
 481             // append the file
 482             //
 483             for(StringWalker=Arg->FullName; *StringWalker != CHAR_NULL && *StringWalker != ':'; StringWalker++);
 484             FileNode = FileDevicePath(NULL, StringWalker+1);
 485             FilePath = AppendDevicePath(DevicePath, FileNode);
 486             FreePool(FileNode);
 487           } else {
 488 */
 489             FilePath = DuplicateDevicePath(DevicePath);
 490 /*
 491           }
 492 */
 493           FreePool(DevicePath);
 494         }
 495       }
 496     }
 497   }
 498
 499
 500   if (ShellStatus == SHELL_SUCCESS) {
 501     //
 502     // Find a free target ,a brute force implementation
 503     //
 504     Found = FALSE;
 505     for (TargetLocation=0; TargetLocation < 0xFFFF; TargetLocation++) {
 506       Found = TRUE;
 507       for (Index=0; Index < OrderCount; Index++) {
 508         if (CurrentOrder[Index] == TargetLocation) {
 509           Found = FALSE;
 510           break;
 511         }
 512       }
 513
 514       if (Found) {
 515         break;
 516       }
 517     }
 518
 519     if (TargetLocation == 0xFFFF) {
 520       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_BCFG_TARGET_NF), gShellBcfgHiiHandle);
 521     } else {
 522       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_BCFG_TARGET), gShellBcfgHiiHandle, TargetLocation);
 523     }
 524   }
 525
 526   if (ShellStatus == SHELL_SUCCESS) {
 527     //
 528     // Add the option
 529     //
 530     DescSize = StrSize(Desc);
 531     FilePathSize = GetDevicePathSize (FilePath);
 532
 533     TempByteBuffer = AllocateZeroPool(sizeof(UINT32) + sizeof(UINT16) + DescSize + FilePathSize);
 534     if (TempByteBuffer != NULL) {
 535       TempByteStart  = TempByteBuffer;
 536       *((UINT32 *) TempByteBuffer) = LOAD_OPTION_ACTIVE;      // Attributes
 537       TempByteBuffer += sizeof (UINT32);
 538
 539       *((UINT16 *) TempByteBuffer) = (UINT16)FilePathSize;    // FilePathListLength
 540       TempByteBuffer += sizeof (UINT16);
 541
 542       CopyMem (TempByteBuffer, Desc, DescSize);
 543       TempByteBuffer += DescSize;
 544       ASSERT (FilePath != NULL);
 545       CopyMem (TempByteBuffer, FilePath, FilePathSize);
 546
 547       UnicodeSPrint (OptionStr, sizeof(OptionStr), L"%s%04x", Target == BcfgTargetBootOrder?L"Boot":L"Driver", TargetLocation);
 548       Status = gRT->SetVariable (
 549             OptionStr,
 550             &gEfiGlobalVariableGuid,
 551             EFI_VARIABLE_NON_VOLATILE|EFI_VARIABLE_BOOTSERVICE_ACCESS|EFI_VARIABLE_RUNTIME_ACCESS,
 552             sizeof(UINT32) + sizeof(UINT16) + DescSize + FilePathSize,
 553             TempByteStart
 554            );
 555
 556       FreePool(TempByteStart);
 557     } else {
 558       Status = EFI_OUT_OF_RESOURCES;
 559     }
 560
 561     if (EFI_ERROR(Status)) {
 562       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_BCFG_SET_VAR_FAIL), gShellBcfgHiiHandle, OptionStr, Status);
 563     } else {
 564       NewOrder = AllocateZeroPool((OrderCount+1)*sizeof(NewOrder[0]));
 565       ASSERT(NewOrder != NULL);
 566       CopyMem(NewOrder, CurrentOrder, (OrderCount)*sizeof(NewOrder[0]));
 567
 568       //
 569       // Insert target into order list
 570       //
 571       for (Index=OrderCount; Index > Position; Index--) {
 572         NewOrder[Index] = NewOrder[Index-1];
 573       }
 574
 575       NewOrder[Position] = (UINT16) TargetLocation;
 576       Status = gRT->SetVariable (
 577         Target == BcfgTargetBootOrder?L"BootOrder":L"DriverOrder",
 578         &gEfiGlobalVariableGuid,
 579         EFI_VARIABLE_NON_VOLATILE|EFI_VARIABLE_BOOTSERVICE_ACCESS|EFI_VARIABLE_RUNTIME_ACCESS,
 580         (OrderCount+1) * sizeof(UINT16),
 581         NewOrder
 582        );
 583
 584       FreePool(NewOrder);
 585
 586       if (EFI_ERROR(Status)) {
 587         ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_BCFG_WRITE_FAIL), gShellBcfgHiiHandle, Target == BcfgTargetBootOrder?L"BootOrder":L"DriverOrder", Status);
 588         ShellStatus = SHELL_INVALID_PARAMETER;
 589       } else {
 590         Print (L"bcfg: Add %s as %x\n", OptionStr, Position);
 591       }
 592     }
 593   }
 594
 595 //
 596 //If always Free FilePath, will free devicepath in system when use "addh"
 597 //
 598   if (FilePath!=NULL && !UseHandle) {
 599     FreePool (FilePath);
 600   }
 601
 602   if (Str != NULL) {
 603     FreePool(Str);
 604   }
 605
 606   if (Handles != NULL) {
 607     FreePool (Handles);
 608   }
 609
 610   if (FileList != NULL) {
 611     ShellCloseFileMetaArg (&FileList);
 612   }
 613
 614   return (ShellStatus);
 615 }
 616
 617 /**
 618   Funciton to remove an item.
 619
 620   @param[in] Target         The target item to move.
 621   @param[in] CurrentOrder   The pointer to the current order of items.
 622   @param[in] OrderCount     The number if items in CurrentOrder.
 623   @param[in] Location       The current location of the Target.
 624
 625   @retval SHELL_SUCCESS             The operation was successful.
 626   @retval SHELL_INVALID_PARAMETER   A parameter was invalid.
 627 **/
 628 SHELL_STATUS
 629 EFIAPI
 630 BcfgRemove(
 631   IN CONST BCFG_OPERATION_TARGET  Target,
 632   IN CONST UINT16                 *CurrentOrder,
 633   IN CONST UINTN                  OrderCount,
 634   IN CONST UINT16                 Location
 635   )
 636 {
 637   CHAR16      VariableName[12];
 638   UINT16      *NewOrder;
 639   EFI_STATUS  Status;
 640   UINTN       NewCount;
 641
 642   UnicodeSPrint(VariableName, sizeof(VariableName), L"%s%04x", Target == BcfgTargetBootOrder?L"Boot":L"Driver", CurrentOrder[Location]);
 643   Status = gRT->SetVariable(
 644     VariableName,
 645     (EFI_GUID*)&gEfiGlobalVariableGuid,
 646     EFI_VARIABLE_NON_VOLATILE|EFI_VARIABLE_BOOTSERVICE_ACCESS|EFI_VARIABLE_RUNTIME_ACCESS,
 647     0,
 648     NULL);
 649   if (EFI_ERROR(Status)) {
 650     ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_BCFG_WRITE_FAIL), gShellBcfgHiiHandle, VariableName, Status);
 651     return (SHELL_INVALID_PARAMETER);
 652   }
 653   NewOrder = AllocateZeroPool(OrderCount*sizeof(CurrentOrder[0]));
 654   if (NewOrder != NULL) {
 655     NewCount = OrderCount;
 656     CopyMem(NewOrder, CurrentOrder, OrderCount*sizeof(CurrentOrder[0]));
 657     CopyMem(NewOrder+Location, NewOrder+Location+1, (OrderCount - Location - 1)*sizeof(CurrentOrder[0]));
 658     NewCount--;
 659
 660     Status = gRT->SetVariable(
 661       Target == BcfgTargetBootOrder?(CHAR16*)L"BootOrder":(CHAR16*)L"DriverOrder",
 662       (EFI_GUID*)&gEfiGlobalVariableGuid,
 663       EFI_VARIABLE_NON_VOLATILE|EFI_VARIABLE_BOOTSERVICE_ACCESS|EFI_VARIABLE_RUNTIME_ACCESS,
 664       NewCount*sizeof(NewOrder[0]),
 665       NewOrder);
 666     FreePool(NewOrder);
 667   } else {
 668     Status = EFI_OUT_OF_RESOURCES;
 669   }
 670   if (EFI_ERROR(Status)) {
 671     ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_BCFG_WRITE_FAIL), gShellBcfgHiiHandle, Target == BcfgTargetBootOrder?(CHAR16*)L"BootOrder":(CHAR16*)L"DriverOrder", Status);
 672     return (SHELL_INVALID_PARAMETER);
 673   }
 674   return (SHELL_SUCCESS);
 675 }
 676
 677 /**
 678   Funciton to move a item to another location.
 679
 680   @param[in] Target         The target item to move.
 681   @param[in] CurrentOrder   The pointer to the current order of items.
 682   @param[in] OrderCount     The number if items in CurrentOrder.
 683   @param[in] OldLocation    The current location of the Target.
 684   @param[in] NewLocation    The desired location of the Target.
 685
 686   @retval SHELL_SUCCESS             The operation was successful.
 687   @retval SHELL_INVALID_PARAMETER   A parameter was invalid.
 688 **/
 689 SHELL_STATUS
 690 EFIAPI
 691 BcfgMove(
 692   IN CONST BCFG_OPERATION_TARGET  Target,
 693   IN CONST UINT16                 *CurrentOrder,
 694   IN CONST UINTN                  OrderCount,
 695   IN CONST UINT16                 OldLocation,
 696   IN       UINT16                 NewLocation
 697   )
 698 {
 699   UINT16            *NewOrder;
 700   EFI_STATUS        Status;
 701   UINT16            Temp;
 702
 703   NewOrder = AllocateCopyPool(OrderCount*sizeof(CurrentOrder[0]), CurrentOrder);
 704   if (NewOrder == NULL) {
 705     return (SHELL_OUT_OF_RESOURCES);
 706   }
 707
 708   //
 709   // correct the new location
 710   //
 711   if (NewLocation >= OrderCount) {
 712     if (OrderCount > 0) {
 713       NewLocation = (UINT16)OrderCount - 1;
 714     } else {
 715       NewLocation = 0;
 716     }
 717   }
 718
 719   Temp = CurrentOrder[OldLocation];
 720   CopyMem(NewOrder+OldLocation, NewOrder+OldLocation+1, (OrderCount - OldLocation - 1)*sizeof(CurrentOrder[0]));
 721   CopyMem(NewOrder+NewLocation+1, NewOrder+NewLocation, (OrderCount - NewLocation - 1)*sizeof(CurrentOrder[0]));
 722   NewOrder[NewLocation] = Temp;
 723
 724   Status = gRT->SetVariable(
 725     Target == BcfgTargetBootOrder?(CHAR16*)L"BootOrder":(CHAR16*)L"DriverOrder",
 726     (EFI_GUID*)&gEfiGlobalVariableGuid,
 727     EFI_VARIABLE_NON_VOLATILE|EFI_VARIABLE_BOOTSERVICE_ACCESS|EFI_VARIABLE_RUNTIME_ACCESS,
 728     OrderCount*sizeof(CurrentOrder[0]),
 729     NewOrder);
 730
 731   FreePool(NewOrder);
 732
 733   if (EFI_ERROR(Status)) {
 734     ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_BCFG_WRITE_FAIL), gShellBcfgHiiHandle, Target == BcfgTargetBootOrder?(CHAR16*)L"BootOrder":(CHAR16*)L"DriverOrder", Status);
 735     return (SHELL_INVALID_PARAMETER);
 736   }
 737   return (SHELL_SUCCESS);
 738 }
 739
 740 /**
 741   Function to add optional data to an option.
 742
 743   @param[in] OptData      The optional data to add.
 744   @param[in] CurrentOrder The pointer to the current order of items.
 745   @param[in] OrderCount   The number if items in CurrentOrder.
 746   @param[in] Target       The target of the operation.
 747
 748   @retval SHELL_SUCCESS   The operation was succesful.
 749 **/
 750 SHELL_STATUS
 751 EFIAPI
 752 BcfgAddOpt(
 753   IN CONST CHAR16                 *OptData,
 754   IN CONST UINT16                 *CurrentOrder,
 755   IN CONST UINTN                  OrderCount,
 756   IN CONST BCFG_OPERATION_TARGET  Target
 757   )
 758 {
 759   EFI_KEY_OPTION  NewKeyOption;
 760   EFI_KEY_OPTION *KeyOptionBuffer;
 761   SHELL_STATUS    ShellStatus;
 762   EFI_STATUS      Status;
 763   UINT16          OptionIndex;
 764   UINT16          LoopCounter;
 765   UINT64          Intermediate;
 766   CONST CHAR16    *Temp;
 767   CONST CHAR16    *Walker;
 768   CHAR16          *FileName;
 769   CHAR16          *Temp2;
 770   CHAR16          *Data;
 771   UINT16          KeyIndex;
 772   CHAR16          VariableName[12];
 773
 774   SHELL_FILE_HANDLE FileHandle;
 775
 776   Status          = EFI_SUCCESS;
 777   ShellStatus     = SHELL_SUCCESS;
 778   Walker          = OptData;
 779   FileName        = NULL;
 780   Data            = NULL;
 781   KeyOptionBuffer = NULL;
 782
 783   ZeroMem(&NewKeyOption, sizeof(EFI_KEY_OPTION));
 784
 785   while(Walker[0] == L' ') {
 786     Walker++;
 787   }
 788
 789   //
 790   // Get the index of the variable we are changing.
 791   //
 792   Status = ShellConvertStringToUint64(Walker, &Intermediate, FALSE, TRUE);
 793   if (EFI_ERROR(Status) || (((UINT16)Intermediate) != Intermediate) || StrStr(Walker, L" ") == NULL || ((UINT16)Intermediate) > ((UINT16)OrderCount)) {
 794     ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellBcfgHiiHandle, L"Option Index");
 795     ShellStatus = SHELL_INVALID_PARAMETER;
 796     return (ShellStatus);
 797   }
 798   OptionIndex = (UINT16)Intermediate;
 799
 800   Temp = StrStr(Walker, L" ");
 801   if (Temp != NULL) {
 802     Walker = Temp;
 803   }
 804   while(Walker[0] == L' ') {
 805     Walker++;
 806   }
 807
 808   //
 809   // determine whether we have file with data, quote delimited information, or a hot-key
 810   //
 811   if (Walker[0] == L'\"') {
 812     //
 813     // quoted filename or quoted information.
 814     //
 815     Temp = StrStr(Walker+1, L"\"");
 816     if (Temp == NULL || StrLen(Temp) != 1) {
 817       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellBcfgHiiHandle, Walker);
 818       ShellStatus = SHELL_INVALID_PARAMETER;
 819     } else {
 820       FileName = StrnCatGrow(&FileName, NULL, Walker+1, 0);
 821       if (FileName == NULL) {
 822         ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_OUT_MEM), gShellBcfgHiiHandle);
 823         ShellStatus = SHELL_OUT_OF_RESOURCES;
 824         return (ShellStatus);
 825       }
 826       Temp2 = StrStr(FileName, L"\"");
 827       ASSERT(Temp2 != NULL);
 828       Temp2[0] = CHAR_NULL;
 829       Temp2++;
 830       if (StrLen(Temp2)>0) {
 831         ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellBcfgHiiHandle, Walker);
 832         ShellStatus = SHELL_INVALID_PARAMETER;
 833       }
 834       if (EFI_ERROR(ShellFileExists(Walker))) {
 835         //
 836         // Not a file.  must be misc information.
 837         //
 838         Data     = FileName;
 839         FileName = NULL;
 840       } else {
 841         FileName = StrnCatGrow(&FileName, NULL, Walker, 0);
 842       }
 843     }
 844   } else {
 845     //
 846     // filename or hot key information.
 847     //
 848     if (StrStr(Walker, L" ") == NULL) {
 849       //
 850       // filename
 851       //
 852       if (EFI_ERROR(ShellFileExists(Walker))) {
 853         ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_FIND_FAIL), gShellBcfgHiiHandle, Walker);
 854         ShellStatus = SHELL_INVALID_PARAMETER;
 855       } else {
 856         FileName = StrnCatGrow(&FileName, NULL, Walker, 0);
 857       }
 858     } else {
 859       if (Target != BcfgTargetBootOrder) {
 860         ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_BOOT_ONLY), gShellBcfgHiiHandle);
 861         ShellStatus = SHELL_INVALID_PARAMETER;
 862       }
 863
 864       if (ShellStatus == SHELL_SUCCESS) {
 865         //
 866         // Get hot key information
 867         //
 868         Status = ShellConvertStringToUint64(Walker, &Intermediate, FALSE, TRUE);
 869         if (EFI_ERROR(Status) || (((UINT32)Intermediate) != Intermediate) || StrStr(Walker, L" ") == NULL) {
 870           ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellBcfgHiiHandle, Walker);
 871           ShellStatus = SHELL_INVALID_PARAMETER;
 872         }
 873         NewKeyOption.KeyData.PackedValue = (UINT32)Intermediate;
 874         Temp = StrStr(Walker, L" ");
 875         if (Temp != NULL) {
 876           Walker = Temp;
 877         }
 878         while(Walker[0] == L' ') {
 879           Walker++;
 880         }
 881       }
 882
 883       if (ShellStatus == SHELL_SUCCESS) {
 884         //
 885         // Now we know how many EFI_INPUT_KEY structs we need to attach to the end of the EFI_KEY_OPTION struct.
 886         // Re-allocate with the added information.
 887         //
 888         KeyOptionBuffer = AllocateCopyPool(sizeof(EFI_KEY_OPTION) + (sizeof(EFI_INPUT_KEY) * NewKeyOption.KeyData.Options.InputKeyCount), &NewKeyOption);
 889         if (KeyOptionBuffer == NULL) {
 890           ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_NO_MEM), gShellBcfgHiiHandle);
 891           ShellStatus = SHELL_OUT_OF_RESOURCES;
 892         }
 893       }
 894       for (LoopCounter = 0 ; ShellStatus == SHELL_SUCCESS && LoopCounter < NewKeyOption.KeyData.Options.InputKeyCount; LoopCounter++) {
 895         //
 896         // ScanCode
 897         //
 898         Status = ShellConvertStringToUint64(Walker, &Intermediate, FALSE, TRUE);
 899         if (EFI_ERROR(Status) || (((UINT16)Intermediate) != Intermediate) || StrStr(Walker, L" ") == NULL) {
 900           ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellBcfgHiiHandle, Walker);
 901           ShellStatus = SHELL_INVALID_PARAMETER;
 902         }
 903         ((EFI_INPUT_KEY*)(((UINT8*)KeyOptionBuffer) + sizeof(EFI_KEY_OPTION)))[LoopCounter].ScanCode = (UINT16)Intermediate;
 904         Temp = StrStr(Walker, L" ");
 905         if (Temp != NULL) {
 906           Walker = Temp;
 907         }
 908         while(Walker[0] == L' ') {
 909           Walker++;
 910         }
 911
 912         //
 913         // UnicodeChar
 914         //
 915         Status = ShellConvertStringToUint64(Walker, &Intermediate, FALSE, TRUE);
 916         if (EFI_ERROR(Status) || (((UINT16)Intermediate) != Intermediate)) {
 917           ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellBcfgHiiHandle, Walker);
 918           ShellStatus = SHELL_INVALID_PARAMETER;
 919         }
 920         ((EFI_INPUT_KEY*)(((UINT8*)KeyOptionBuffer) + sizeof(EFI_KEY_OPTION)))[LoopCounter].UnicodeChar = (UINT16)Intermediate;
 921         Temp = StrStr(Walker, L" ");
 922         if (Temp != NULL) {
 923           Walker = Temp;
 924         }
 925         while(Walker[0] == L' ') {
 926           Walker++;
 927         }
 928       }
 929
 930       if (ShellStatus == SHELL_SUCCESS) {
 931         //
 932         // Now do the BootOption / BootOptionCrc
 933         //
 934         ASSERT (OptionIndex <= OrderCount);
 935         KeyOptionBuffer->BootOption    = CurrentOrder[OptionIndex];
 936         Status = GetBootOptionCrc(&(KeyOptionBuffer->BootOptionCrc), KeyOptionBuffer->BootOption);
 937         if (EFI_ERROR(Status)) {
 938           ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellBcfgHiiHandle, L"Option Index");
 939           ShellStatus = SHELL_INVALID_PARAMETER;
 940         }
 941       }
 942
 943       if (ShellStatus == SHELL_SUCCESS) {
 944         for (Temp2 = NULL, KeyIndex = 0 ; KeyIndex < 0xFFFF ; KeyIndex++) {
 945           UnicodeSPrint(VariableName, sizeof(VariableName), L"Key%04x", KeyIndex);
 946           Status = gRT->GetVariable(
 947               VariableName,
 948               (EFI_GUID*)&gEfiGlobalVariableGuid,
 949               NULL,
 950               (UINTN*)&Intermediate,
 951               NULL);
 952           if (Status == EFI_NOT_FOUND) {
 953             break;
 954           }
 955         }
 956         Status = gRT->SetVariable(
 957           VariableName,
 958           (EFI_GUID*)&gEfiGlobalVariableGuid,
 959           EFI_VARIABLE_NON_VOLATILE|EFI_VARIABLE_BOOTSERVICE_ACCESS|EFI_VARIABLE_RUNTIME_ACCESS,
 960           sizeof(EFI_KEY_OPTION) + (sizeof(EFI_INPUT_KEY) * NewKeyOption.KeyData.Options.InputKeyCount),
 961           KeyOptionBuffer);
 962         if (EFI_ERROR(Status)) {
 963           ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_BCFG_SET_VAR_FAIL), gShellBcfgHiiHandle, VariableName, Status);
 964           ShellStatus = SHELL_INVALID_PARAMETER;
 965         }
 966         ASSERT(FileName == NULL && Data == NULL);
 967       }
 968     }
 969   }
 970
 971   //
 972   // Shouldn't be possible to have have both. Neither is ok though.
 973   //
 974   ASSERT(FileName == NULL || Data == NULL);
 975
 976   if (ShellStatus == SHELL_SUCCESS && (FileName != NULL || Data != NULL)) {
 977     if (FileName != NULL) {
 978       //
 979       // Open the file and populate the data buffer.
 980       //
 981       Status = ShellOpenFileByName(
 982         FileName,
 983         &FileHandle,
 984         EFI_FILE_MODE_READ,
 985         0);
 986       if (!EFI_ERROR(Status)) {
 987         Status = ShellGetFileSize(FileHandle, &Intermediate);
 988       }
 989       Data = AllocateZeroPool((UINTN)Intermediate);
 990       if (Data == NULL) {
 991         ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_NO_MEM), gShellBcfgHiiHandle);
 992         ShellStatus = SHELL_OUT_OF_RESOURCES;
 993       }
 994       if (!EFI_ERROR(Status)) {
 995         Status = ShellReadFile(FileHandle, (UINTN *)&Intermediate, Data);
 996       }
 997     } else {
 998       Intermediate = StrSize(Data);
 999     }
1000
1001     if (!EFI_ERROR(Status) && ShellStatus == SHELL_SUCCESS && Data != NULL) {
1002       Status = UpdateOptionalData(CurrentOrder[OptionIndex], (UINTN)Intermediate, (UINT8*)Data, Target);
1003       if (EFI_ERROR(Status)) {
1004         ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_BCFG_SET_VAR_FAIL), gShellBcfgHiiHandle, VariableName, Status);
1005         ShellStatus = SHELL_INVALID_PARAMETER;
1006       }
1007     }
1008     if (EFI_ERROR(Status) && ShellStatus == SHELL_SUCCESS) {
1009       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_BCFG_SET_VAR_FAIL), gShellBcfgHiiHandle, VariableName, Status);
1010       ShellStatus = SHELL_INVALID_PARAMETER;
1011     }
1012   }
1013
1014   SHELL_FREE_NON_NULL(Data);
1015   SHELL_FREE_NON_NULL(KeyOptionBuffer);
1016   SHELL_FREE_NON_NULL(FileName);
1017   return ShellStatus;
1018 }
1019
1020 /**
1021   Function to dump the Bcfg information.
1022
1023   @param[in] Op             The operation.
1024   @param[in] OrderCount     How many to dump.
1025   @param[in] CurrentOrder   The pointer to the current order of items.
1026   @param[in] VerboseOutput  TRUE for extra output.  FALSE otherwise.
1027
1028   @retval SHELL_SUCCESS           The dump was successful.
1029   @retval SHELL_INVALID_PARAMETER A parameter was invalid.
1030 **/
1031 SHELL_STATUS
1032 EFIAPI
1033 BcfgDisplayDump(
1034   IN CONST CHAR16   *Op,
1035   IN CONST UINTN    OrderCount,
1036   IN CONST UINT16   *CurrentOrder,
1037   IN CONST BOOLEAN  VerboseOutput
1038   )
1039 {
1040   EFI_STATUS  Status;
1041   UINT8       *Buffer;
1042   UINTN       BufferSize;
1043   CHAR16      VariableName[12];
1044   UINTN       LoopVar;
1045   UINTN       LoopVar2;
1046   CHAR16      *DevPathString;
1047   VOID        *DevPath;
1048
1049   if (OrderCount == 0) {
1050     ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN(STR_BCFG_NONE), gShellBcfgHiiHandle);
1051     return (SHELL_SUCCESS);
1052   }
1053
1054   for (LoopVar = 0 ; LoopVar < OrderCount ; LoopVar++) {
1055     Buffer      = NULL;
1056     BufferSize  = 0;
1057     UnicodeSPrint(VariableName, sizeof(VariableName), L"%s%04x", Op, CurrentOrder[LoopVar]);
1058
1059     Status = gRT->GetVariable(
1060         VariableName,
1061         (EFI_GUID*)&gEfiGlobalVariableGuid,
1062         NULL,
1063         &BufferSize,
1064         Buffer);
1065     if (Status == EFI_BUFFER_TOO_SMALL) {
1066       Buffer = AllocateZeroPool(BufferSize);
1067       Status = gRT->GetVariable(
1068           VariableName,
1069           (EFI_GUID*)&gEfiGlobalVariableGuid,
1070           NULL,
1071           &BufferSize,
1072           Buffer);
1073     }
1074
1075     if (EFI_ERROR(Status) || Buffer == NULL) {
1076       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_BCFG_READ_FAIL), gShellBcfgHiiHandle, VariableName, Status);
1077       return (SHELL_INVALID_PARAMETER);
1078     }
1079
1080     if ((*(UINT16*)(Buffer+4)) != 0) {
1081       DevPath = AllocateZeroPool(*(UINT16*)(Buffer+4));
1082       if (DevPath == NULL) {
1083         DevPathString = NULL;
1084       } else {
1085         CopyMem(DevPath, Buffer+6+StrSize((CHAR16*)(Buffer+6)), *(UINT16*)(Buffer+4));
1086         DevPathString = ConvertDevicePathToText(DevPath, TRUE, FALSE);
1087       }
1088     } else {
1089       DevPath       = NULL;
1090       DevPathString = NULL;
1091     }
1092     ShellPrintHiiEx(
1093       -1,
1094       -1,
1095       NULL,
1096       STRING_TOKEN(STR_BCFG_LOAD_OPTIONS),
1097       gShellBcfgHiiHandle,
1098       LoopVar,
1099       VariableName,
1100       (CHAR16*)(Buffer+6),
1101       DevPathString,
1102       (StrSize((CHAR16*)(Buffer+6)) + *(UINT16*)(Buffer+4) + 6) <= BufferSize?L'N':L'Y');
1103     if (VerboseOutput) {
1104       for (LoopVar2 = (StrSize((CHAR16*)(Buffer+6)) + *(UINT16*)(Buffer+4) + 6);LoopVar2<BufferSize;LoopVar2++){
1105         ShellPrintEx(
1106           -1,
1107           -1,
1108           NULL,
1109           L"%02x",
1110           Buffer[LoopVar2]);
1111       }
1112       ShellPrintEx(
1113         -1,
1114         -1,
1115         NULL,
1116         L"\r\n");
1117     }
1118
1119     if (Buffer != NULL) {
1120       FreePool(Buffer);
1121     }
1122     if (DevPath != NULL) {
1123       FreePool(DevPath);
1124     }
1125     if (DevPathString != NULL) {
1126       FreePool(DevPathString);
1127     }
1128   }
1129   return (SHELL_SUCCESS);
1130 }
1131
1132 /**
1133   Function to initialize the BCFG operation structure.
1134
1135   @param[in] Struct   The stuct to initialize.
1136 **/
1137 VOID
1138 EFIAPI
1139 InitBcfgStruct(
1140   IN BGFG_OPERATION *Struct
1141   )
1142 {
1143   ASSERT(Struct != NULL);
1144   Struct->Target      = BcfgTargetMax;
1145   Struct->Type        = BcfgTypeMax;
1146   Struct->Number1     = 0;
1147   Struct->Number2     = 0;
1148   Struct->HandleIndex = 0;
1149   Struct->FileName    = NULL;
1150   Struct->Description = NULL;
1151   Struct->Order       = NULL;
1152   Struct->OptData     = NULL;
1153 }
1154
1155
1156 STATIC CONST SHELL_PARAM_ITEM ParamList[] = {
1157   {L"-v", TypeFlag},
1158   {L"-opt", TypeMaxValue},
1159   {NULL, TypeMax}
1160   };
1161
1162 /**
1163   Function for 'bcfg' command.
1164
1165   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
1166   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
1167 **/
1168 SHELL_STATUS
1169 EFIAPI
1170 ShellCommandRunBcfg (
1171   IN EFI_HANDLE        ImageHandle,
1172   IN EFI_SYSTEM_TABLE  *SystemTable
1173   )
1174 {
1175   EFI_STATUS            Status;
1176   LIST_ENTRY            *Package;
1177   CHAR16                *ProblemParam;
1178   SHELL_STATUS          ShellStatus;
1179   UINTN                 ParamNumber;
1180   CONST CHAR16          *CurrentParam;
1181   BGFG_OPERATION        CurrentOperation;
1182   UINTN                 Length;
1183   UINT64                Intermediate;
1184   UINT16                Count;
1185
1186   Length              = 0;
1187   ProblemParam        = NULL;
1188   Package             = NULL;
1189   ShellStatus         = SHELL_SUCCESS;
1190
1191   InitBcfgStruct(&CurrentOperation);
1192
1193   //
1194   // initialize the shell lib (we must be in non-auto-init...)
1195   //
1196   Status = ShellInitialize();
1197   ASSERT_EFI_ERROR(Status);
1198
1199   Status = CommandInit();
1200   ASSERT_EFI_ERROR(Status);
1201
1202   //
1203   // parse the command line
1204   //
1205   Status = ShellCommandLineParse (ParamList, &Package, &ProblemParam, TRUE);
1206   if (EFI_ERROR(Status)) {
1207     if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {
1208       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellBcfgHiiHandle, ProblemParam);
1209       FreePool(ProblemParam);
1210       ShellStatus = SHELL_INVALID_PARAMETER;
1211     } else {
1212       ASSERT(FALSE);
1213     }
1214   } else {
1215     //
1216     // Read in if we are doing -OPT
1217     //
1218     if (ShellCommandLineGetFlag(Package, L"-opt")) {
1219       CurrentOperation.OptData = ShellCommandLineGetValue(Package, L"-opt");
1220       if (CurrentOperation.OptData == NULL) {
1221         ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM_VAL), gShellBcfgHiiHandle, L"-opt");
1222         ShellStatus = SHELL_INVALID_PARAMETER;
1223       }
1224       CurrentOperation.Type = BcfgTypeOpt;
1225     }
1226
1227     //
1228     // small block to read the target of the operation
1229     //
1230     if ((ShellCommandLineGetCount(Package) < 3 && CurrentOperation.Type != BcfgTypeOpt) ||
1231         (ShellCommandLineGetCount(Package) < 2 && CurrentOperation.Type == BcfgTypeOpt)
1232        ){
1233       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellBcfgHiiHandle);
1234       ShellStatus = SHELL_INVALID_PARAMETER;
1235     } else if (gUnicodeCollation->StriColl(gUnicodeCollation, (CHAR16*)ShellCommandLineGetRawValue(Package, 1), L"driver") == 0) {
1236       CurrentOperation.Target = BcfgTargetDriverOrder;
1237     } else if (gUnicodeCollation->StriColl(gUnicodeCollation, (CHAR16*)ShellCommandLineGetRawValue(Package, 1), L"boot") == 0) {
1238       CurrentOperation.Target = BcfgTargetBootOrder;
1239     } else {
1240       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_NO_DRIVER_BOOT), gShellBcfgHiiHandle);
1241       ShellStatus = SHELL_INVALID_PARAMETER;
1242     }
1243
1244
1245     //
1246     // Read in the boot or driver order environment variable (not needed for opt)
1247     //
1248     if (ShellStatus == SHELL_SUCCESS && CurrentOperation.Target < BcfgTargetMax) {
1249       Length = 0;
1250       Status = gRT->GetVariable(
1251         CurrentOperation.Target == BcfgTargetBootOrder?(CHAR16*)L"BootOrder":(CHAR16*)L"DriverOrder",
1252         (EFI_GUID*)&gEfiGlobalVariableGuid,
1253         NULL,
1254         &Length,
1255         CurrentOperation.Order);
1256       if (Status == EFI_BUFFER_TOO_SMALL) {
1257         CurrentOperation.Order = AllocateZeroPool(Length+(4*sizeof(CurrentOperation.Order[0])));
1258         if (CurrentOperation.Order == NULL) {
1259           ShellStatus = SHELL_OUT_OF_RESOURCES;
1260         } else {
1261           Status = gRT->GetVariable(
1262             CurrentOperation.Target == BcfgTargetBootOrder?(CHAR16*)L"BootOrder":(CHAR16*)L"DriverOrder",
1263             (EFI_GUID*)&gEfiGlobalVariableGuid,
1264             NULL,
1265             &Length,
1266             CurrentOperation.Order);
1267         }
1268       }
1269     }
1270
1271     Count = (UINT16) (Length / sizeof(CurrentOperation.Order[0]));
1272
1273     //
1274     // large block to read the type of operation and verify parameter types for the info.
1275     //
1276     if (ShellStatus == SHELL_SUCCESS && CurrentOperation.Target < BcfgTargetMax) {
1277       for (ParamNumber = 2 ; ParamNumber < ShellCommandLineGetCount(Package) && ShellStatus == SHELL_SUCCESS; ParamNumber++) {
1278         CurrentParam = ShellCommandLineGetRawValue(Package, ParamNumber);
1279         if        (gUnicodeCollation->StriColl(gUnicodeCollation, (CHAR16*)CurrentParam, L"dump") == 0)    {
1280           CurrentOperation.Type = BcfgTypeDump;
1281         } else if (ShellCommandLineGetFlag(Package, L"-v")) {
1282           ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellBcfgHiiHandle, L"-v (without dump)");
1283           ShellStatus = SHELL_INVALID_PARAMETER;
1284         } else if (gUnicodeCollation->StriColl(gUnicodeCollation, (CHAR16*)CurrentParam, L"add") == 0)     {
1285           if ((ParamNumber + 3) >= ShellCommandLineGetCount(Package)) {
1286             ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellBcfgHiiHandle);
1287             ShellStatus = SHELL_INVALID_PARAMETER;
1288           }
1289           CurrentOperation.Type = BcfgTypeAdd;
1290           CurrentParam = ShellCommandLineGetRawValue(Package, ++ParamNumber);
1291           if (CurrentParam == NULL || !ShellIsHexOrDecimalNumber(CurrentParam, TRUE, FALSE)) {
1292             ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellBcfgHiiHandle, CurrentParam);
1293             ShellStatus = SHELL_INVALID_PARAMETER;
1294           } else {
1295             Status = ShellConvertStringToUint64(CurrentParam, &Intermediate, TRUE, FALSE);
1296             CurrentOperation.Number1     = (UINT16)Intermediate;
1297             ASSERT(CurrentOperation.FileName == NULL);
1298             CurrentOperation.FileName    = StrnCatGrow(&CurrentOperation.FileName   , NULL, ShellCommandLineGetRawValue(Package, ++ParamNumber), 0);
1299             ASSERT(CurrentOperation.Description == NULL);
1300             CurrentOperation.Description = StrnCatGrow(&CurrentOperation.Description, NULL, ShellCommandLineGetRawValue(Package, ++ParamNumber), 0);
1301           }
1302         } else if (gUnicodeCollation->StriColl(gUnicodeCollation, (CHAR16*)CurrentParam, L"addp") == 0)    {
1303           if ((ParamNumber + 3) >= ShellCommandLineGetCount(Package)) {
1304             ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellBcfgHiiHandle);
1305             ShellStatus = SHELL_INVALID_PARAMETER;
1306           }
1307           CurrentOperation.Type = BcfgTypeAddp;
1308           CurrentParam = ShellCommandLineGetRawValue(Package, ++ParamNumber);
1309           if (CurrentParam == NULL || !ShellIsHexOrDecimalNumber(CurrentParam, TRUE, FALSE)) {
1310             ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellBcfgHiiHandle, CurrentParam);
1311             ShellStatus = SHELL_INVALID_PARAMETER;
1312           } else {
1313             Status = ShellConvertStringToUint64(CurrentParam, &Intermediate, TRUE, FALSE);
1314             CurrentOperation.Number1     = (UINT16)Intermediate;
1315             ASSERT(CurrentOperation.FileName == NULL);
1316             CurrentOperation.FileName    = StrnCatGrow(&CurrentOperation.FileName   , NULL, ShellCommandLineGetRawValue(Package, ++ParamNumber), 0);
1317             ASSERT(CurrentOperation.Description == NULL);
1318             CurrentOperation.Description = StrnCatGrow(&CurrentOperation.Description, NULL, ShellCommandLineGetRawValue(Package, ++ParamNumber), 0);
1319           }
1320         } else if (gUnicodeCollation->StriColl(gUnicodeCollation, (CHAR16*)CurrentParam, L"addh") == 0)    {
1321           if ((ParamNumber + 3) >= ShellCommandLineGetCount(Package)) {
1322             ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellBcfgHiiHandle);
1323             ShellStatus = SHELL_INVALID_PARAMETER;
1324           }
1325           CurrentOperation.Type = BcfgTypeAddh;
1326           CurrentParam = ShellCommandLineGetRawValue(Package, ++ParamNumber);
1327           if (CurrentParam == NULL || !ShellIsHexOrDecimalNumber(CurrentParam, TRUE, FALSE)) {
1328             ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellBcfgHiiHandle, CurrentParam);
1329             ShellStatus = SHELL_INVALID_PARAMETER;
1330           } else {
1331             Status = ShellConvertStringToUint64(CurrentParam, &Intermediate, TRUE, FALSE);
1332             CurrentOperation.Number1     = (UINT16)Intermediate;
1333             CurrentParam = ShellCommandLineGetRawValue(Package, ++ParamNumber);
1334             if (CurrentParam == NULL || !ShellIsHexOrDecimalNumber(CurrentParam, TRUE, FALSE)) {
1335               ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellBcfgHiiHandle, CurrentParam);
1336               ShellStatus = SHELL_INVALID_PARAMETER;
1337             } else {
1338               Status = ShellConvertStringToUint64(CurrentParam, &Intermediate, TRUE, FALSE);
1339               CurrentOperation.HandleIndex = (UINT16)Intermediate;
1340               ASSERT(CurrentOperation.Description == NULL);
1341               CurrentOperation.Description = StrnCatGrow(&CurrentOperation.Description, NULL, ShellCommandLineGetRawValue(Package, ++ParamNumber), 0);
1342             }
1343           }
1344         } else if (gUnicodeCollation->StriColl(gUnicodeCollation, (CHAR16*)CurrentParam, L"rm") == 0)      {
1345           if ((ParamNumber + 1) >= ShellCommandLineGetCount(Package)) {
1346             ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellBcfgHiiHandle);
1347             ShellStatus = SHELL_INVALID_PARAMETER;
1348           }
1349           CurrentOperation.Type = BcfgTypeRm;
1350           CurrentParam = ShellCommandLineGetRawValue(Package, ++ParamNumber);
1351           if (CurrentParam == NULL || !ShellIsHexOrDecimalNumber(CurrentParam, TRUE, FALSE)) {
1352             ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellBcfgHiiHandle, CurrentParam);
1353             ShellStatus = SHELL_INVALID_PARAMETER;
1354           } else {
1355             Status = ShellConvertStringToUint64(CurrentParam, &Intermediate, TRUE, FALSE);
1356             CurrentOperation.Number1     = (UINT16)Intermediate;
1357             if (CurrentOperation.Number1 >= Count){
1358               ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_BCFG_NUMB_RANGE), gShellBcfgHiiHandle, Count);
1359               ShellStatus = SHELL_INVALID_PARAMETER;
1360             }
1361           }
1362         } else if (gUnicodeCollation->StriColl(gUnicodeCollation, (CHAR16*)CurrentParam, L"mv") == 0)      {
1363           if ((ParamNumber + 2) >= ShellCommandLineGetCount(Package)) {
1364             ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellBcfgHiiHandle);
1365             ShellStatus = SHELL_INVALID_PARAMETER;
1366           }
1367           CurrentOperation.Type = BcfgTypeMv;
1368           CurrentParam = ShellCommandLineGetRawValue(Package, ++ParamNumber);
1369           if (CurrentParam == NULL || !ShellIsHexOrDecimalNumber(CurrentParam, TRUE, FALSE)) {
1370             ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellBcfgHiiHandle, CurrentParam);
1371             ShellStatus = SHELL_INVALID_PARAMETER;
1372           } else {
1373             Status = ShellConvertStringToUint64(CurrentParam, &Intermediate, TRUE, FALSE);
1374             CurrentOperation.Number1     = (UINT16)Intermediate;
1375             if (CurrentOperation.Number1 >= Count){
1376               ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_BCFG_NUMB_RANGE), gShellBcfgHiiHandle, Count);
1377               ShellStatus = SHELL_INVALID_PARAMETER;
1378             } else {
1379               CurrentParam = ShellCommandLineGetRawValue(Package, ++ParamNumber);
1380               if (CurrentParam == NULL || !ShellIsHexOrDecimalNumber(CurrentParam, TRUE, FALSE)) {
1381                 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellBcfgHiiHandle, CurrentParam);
1382                 ShellStatus = SHELL_INVALID_PARAMETER;
1383               } else {
1384                 Status = ShellConvertStringToUint64(CurrentParam, &Intermediate, TRUE, FALSE);
1385                 CurrentOperation.Number2     = (UINT16)Intermediate;
1386               }
1387               if (CurrentOperation.Number2 == CurrentOperation.Number1
1388                 ||CurrentOperation.Number2 >= Count
1389                ){
1390                 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_BCFG_NUMB_RANGE), gShellBcfgHiiHandle, Count);
1391                 ShellStatus = SHELL_INVALID_PARAMETER;
1392               }
1393             }
1394           }
1395         } else {
1396           ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellBcfgHiiHandle, CurrentParam);
1397           ShellStatus = SHELL_INVALID_PARAMETER;
1398         }
1399       }
1400     }
1401     if (ShellStatus == SHELL_SUCCESS && CurrentOperation.Target < BcfgTargetMax && CurrentOperation.Type < BcfgTypeMax) {
1402       //
1403       // we have all the info.  Do the work
1404       //
1405       switch (CurrentOperation.Type) {
1406         case   BcfgTypeDump:
1407           ShellStatus = BcfgDisplayDump(
1408             CurrentOperation.Target == BcfgTargetBootOrder?L"Boot":L"Driver",
1409             Count,
1410             CurrentOperation.Order,
1411             ShellCommandLineGetFlag(Package, L"-v"));
1412           break;
1413         case   BcfgTypeMv:
1414           ShellStatus = BcfgMove(
1415             CurrentOperation.Target,
1416             CurrentOperation.Order,
1417             Count,
1418             CurrentOperation.Number1,
1419             CurrentOperation.Number2);
1420           break;
1421         case   BcfgTypeRm:
1422           ShellStatus = BcfgRemove(
1423             CurrentOperation.Target,
1424             CurrentOperation.Order,
1425             Count,
1426             CurrentOperation.Number1);
1427           break;
1428         case   BcfgTypeAdd:
1429         case   BcfgTypeAddp:
1430         case   BcfgTypeAddh:
1431           ShellStatus = BcfgAdd(
1432             CurrentOperation.Number1,
1433             CurrentOperation.FileName,
1434             CurrentOperation.Description==NULL?L"":CurrentOperation.Description,
1435             CurrentOperation.Order,
1436             Count,
1437             CurrentOperation.Target,
1438             (BOOLEAN)(CurrentOperation.Type == BcfgTypeAddh),
1439             (BOOLEAN)(CurrentOperation.Type == BcfgTypeAddp),
1440             CurrentOperation.HandleIndex);
1441           break;
1442         case   BcfgTypeOpt:
1443           ShellStatus = BcfgAddOpt(
1444             CurrentOperation.OptData,
1445             CurrentOperation.Order,
1446             Count,
1447             CurrentOperation.Target);
1448           break;
1449         default:
1450           ASSERT(FALSE);
1451       }
1452     }
1453   }
1454
1455   if (Package != NULL) {
1456     ShellCommandLineFreeVarList (Package);
1457   }
1458   if (CurrentOperation.FileName != NULL) {
1459     FreePool(CurrentOperation.FileName);
1460   }
1461   if (CurrentOperation.Description != NULL) {
1462     FreePool(CurrentOperation.Description);
1463   }
1464   if (CurrentOperation.Order != NULL) {
1465     FreePool(CurrentOperation.Order);
1466   }
1467
1468   return (ShellStatus);
1469 }
1470
1471
1472 /**
1473   Function to get the filename with help context if HII will not be used.
1474
1475   @return   The filename with help text in it.
1476 **/
1477 CONST CHAR16*
1478 EFIAPI
1479 ShellCommandGetManFileNameBcfg (
1480   VOID
1481   )
1482 {
1483   return (mFileName);
1484 }
1485
1486 /**
1487   "Constructor" for the library.
1488
1489   This will register the handler for the bcfg command.
1490
1491   @param[in] ImageHandle    the image handle of the process
1492   @param[in] SystemTable    the EFI System Table pointer
1493   @param[in] Name           the profile name to use
1494
1495   @retval EFI_SUCCESS        the shell command handlers were installed sucessfully
1496   @retval EFI_UNSUPPORTED    the shell level required was not found.
1497 **/
1498 EFI_STATUS
1499 EFIAPI
1500 BcfgLibraryRegisterBcfgCommand (
1501   IN EFI_HANDLE        ImageHandle,
1502   IN EFI_SYSTEM_TABLE  *SystemTable,
1503   IN CONST CHAR16      *Name
1504   )
1505 {
1506   if (gShellBcfgHiiHandle != NULL) {
1507     return (EFI_SUCCESS);
1508   }
1509
1510   gShellBcfgHiiHandle = HiiAddPackages (&gShellBcfgHiiGuid, gImageHandle, UefiShellBcfgCommandLibStrings, NULL);
1511   if (gShellBcfgHiiHandle == NULL) {
1512     return (EFI_DEVICE_ERROR);
1513   }
1514
1515   //
1516   // install our shell command handler
1517   //
1518   ShellCommandRegisterCommandName(L"bcfg", ShellCommandRunBcfg , ShellCommandGetManFileNameBcfg, 0, Name, FALSE, gShellBcfgHiiHandle, STRING_TOKEN(STR_GET_HELP_BCFG));
1519
1520   return (EFI_SUCCESS);
1521 }
1522
1523 /**
1524   Destructor for the library.  free any resources.
1525
1526   @param ImageHandle            The image handle of the process.
1527   @param SystemTable            The EFI System Table pointer.
1528 **/
1529 EFI_STATUS
1530 EFIAPI
1531 BcfgLibraryUnregisterBcfgCommand (
1532   IN EFI_HANDLE        ImageHandle,
1533   IN EFI_SYSTEM_TABLE  *SystemTable
1534   )
1535 {
1536   if (gShellBcfgHiiHandle != NULL) {
1537     HiiRemovePackages(gShellBcfgHiiHandle);
1538   }
1539   gShellBcfgHiiHandle = NULL;
1540   return (EFI_SUCCESS);
1541 }
1542