OpenCorePkg/Application/ControlMsrE2/ControlMsrE2.c

/** @file
  Control CFGLock BIOS Option

Copyright (c) 2020, Brumbaer. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution.  The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

**/

#include "ControlMsrE2.h"

//
// Maximum search contexts and matched options allowed
//
#define CONTEXTS_MAX  8
#define OPTIONS_MAX   9

VOID
IterateListHeaders (
  IN EFI_HII_HANDLE               *HiiHandles,
  IN EFI_HII_PACKAGE_LIST_HEADER  **ListHeaders,
  IN UINT32                       ListHeaderCount,
  IN EFI_STRING                   SearchString
  )
{
  UINT16                  OptionsCount;
  UINT16                  ContextsCount;
  ONE_OF_CONTEXT          Contexts[CONTEXTS_MAX];
  UINT32                  ListHeaderIndex;
  EFI_IFR_OP_HEADER       *IfrHeader;
  EFI_HII_PACKAGE_HEADER  *PkgHeader;
  BOOLEAN                 Stop;
  UINT32                  ContextIndex;
  UINT16                  Index;
  CHAR16                  Key;

  OptionsCount  = 0;
  ContextsCount = 0;

  for (ListHeaderIndex = 0; HiiHandles[ListHeaderIndex] != NULL && ContextsCount < CONTEXTS_MAX; ++ListHeaderIndex) {
    ListHeaders[ListHeaderIndex] = HiiExportPackageLists (HiiHandles[ListHeaderIndex]);

    if (ListHeaders[ListHeaderIndex] == NULL) {
      continue;
    }

    DEBUG ((
      DEBUG_INFO,
      "Package List: %g\n",
      &ListHeaders[ListHeaderIndex]->PackageListGuid
      ));

    PkgHeader = PADD (ListHeaders[ListHeaderIndex], sizeof (EFI_HII_PACKAGE_LIST_HEADER));

    while (ContextsCount < CONTEXTS_MAX) {
      DEBUG ((DEBUG_INFO, "Package Type: %02X ", PkgHeader->Type));

      if (PkgHeader->Type == EFI_HII_PACKAGE_END) {
        break;
      }

      if (PkgHeader->Type == EFI_HII_PACKAGE_FORMS) {
        IfrHeader = PADD (PkgHeader, sizeof (EFI_HII_PACKAGE_HEADER));
        //
        // Form Definition must start with FORM_SET_OP
        //
        if (IfrHeader->OpCode == EFI_IFR_FORM_SET_OP) {
          DEBUG ((
            DEBUG_INFO,
            "Form: %g\n",
            &((EFI_IFR_FORM_SET *)IfrHeader)->Guid
            ));

          if (IfrHeader->Length >= sizeof (GUID) + sizeof (EFI_IFR_FORM_SET)) {
            DEBUG ((
              DEBUG_INFO,
              "Class Guid: %g\n",
              PADD (IfrHeader, sizeof (EFI_IFR_FORM_SET))
              ));

            //
            // Checkup for Setup Form
            //
            if (CompareGuid (&gEfiHiiPlatformSetupFormsetGuid, PADD (IfrHeader, sizeof (EFI_IFR_FORM_SET)))) {
              Contexts[ContextsCount].SearchText     = SearchString;
              Contexts[ContextsCount].EfiHandle      = HiiHandles[ListHeaderIndex];
              Contexts[ContextsCount].ListHeader     = ListHeaders[ListHeaderIndex];
              Contexts[ContextsCount].PkgHeader      = PkgHeader;
              Contexts[ContextsCount].FirstIfrHeader = PADD (IfrHeader, IfrHeader->Length);
              Contexts[ContextsCount].IfrVarStore    = NULL;
              Contexts[ContextsCount].IfrOneOf       = NULL;
              Contexts[ContextsCount].StopAt         = DONT_STOP_AT;
              Contexts[ContextsCount].Count          = OptionsCount;

              IterateOpCode (
                Contexts[ContextsCount].FirstIfrHeader,
                EFI_IFR_ONE_OF_OP,
                NULL,
                &Contexts[ContextsCount],
                HandleIfrOption
                );

              if (Contexts[ContextsCount].Count != OptionsCount) {
                OptionsCount = Contexts[ContextsCount].Count;
                ++ContextsCount;
              }
            }
          }
        }
      }

      PkgHeader = PADD (PkgHeader, PkgHeader->Length);
    }

    DEBUG ((DEBUG_INFO, "\n"));
  }

  DEBUG ((DEBUG_INFO, "Context Count: %x Options Count %x\n", ContextsCount, OptionsCount));

  if ((OptionsCount > OPTIONS_MAX) || (ContextsCount == CONTEXTS_MAX)) {
    Print (L"Too many corresponding BIOS Options found. Try a different search string using interactive mode.\n");
  } else if (OptionsCount == 0) {
    Print (L"No corresponding BIOS Options found. Try a different search string using interactive mode.\n");
  } else {
    Key = '1';

    if (OptionsCount > 1) {
      do {
        Print (L"\nEnter choice (1..%x) ? ", OptionsCount);
        Key = ReadAnyKey ();
      } while ((Key != CHAR_ESC) && ((Key < '1') || (Key > '0' + OptionsCount)));

      Print (L"\n");
    }

    if (Key != CHAR_ESC) {
      Index = Key - '0';

      for (ContextIndex = 0; ContextIndex < ContextsCount; ++ContextIndex) {
        if (Contexts[ContextIndex].Count >= Index) {
          Contexts[ContextIndex].Count    = ContextIndex == 0 ? 0 : Contexts[ContextIndex - 1].Count;
          Contexts[ContextIndex].StopAt   = Index;
          Contexts[ContextIndex].IfrOneOf = NULL;

          IterateOpCode (
            Contexts[ContextIndex].FirstIfrHeader,
            EFI_IFR_ONE_OF_OP,
            &Stop,
            &Contexts[ContextIndex],
            HandleIfrOption
            );

          if (Contexts[ContextIndex].IfrOneOf != NULL) {
            HandleIfrVariable (&Contexts[ContextIndex]);
          }

          break;
        }
      }
    }
  }

  for (ListHeaderIndex = 0; ListHeaderIndex < ListHeaderCount; ++ListHeaderIndex) {
    if (ListHeaders[ListHeaderIndex] != NULL) {
      FreePool (ListHeaders[ListHeaderIndex]);
    }
  }
}

EFI_STATUS
SearchForString (
  IN EFI_STRING  SearchString
  )
{
  EFI_HII_HANDLE               *HiiHandles;
  EFI_HII_PACKAGE_LIST_HEADER  **ListHeaders;
  UINT32                       ListHeaderCount;

  Print (L"\nBIOS Options:\n");

  HiiHandles = HiiGetHiiHandles (NULL);
  if (HiiHandles == NULL) {
    Print (L"Could not retrieve HiiHandles.\n");
    return EFI_OUT_OF_RESOURCES;
  }

  for (ListHeaderCount = 0; HiiHandles[ListHeaderCount] != NULL; ++ListHeaderCount) {
  }

  //
  // Keep list alive 'til program finishes.
  // So that all lists can be searched, the results be displayed together.
  // And from all those one Option will be selected to be changed
  //
  ListHeaders = AllocatePool (sizeof (*ListHeaders) * ListHeaderCount);
  if (ListHeaders == NULL) {
    Print (L"Could not allocate memory for ListHeaders.\n");
    FreePool (HiiHandles);
    return EFI_OUT_OF_RESOURCES;
  }

  IterateListHeaders (HiiHandles, ListHeaders, ListHeaderCount, SearchString);

  FreePool (ListHeaders);
  FreePool (HiiHandles);
  return EFI_SUCCESS;
}

EFI_STATUS
EFIAPI
UefiMain (
  IN EFI_HANDLE        ImageHandle,
  IN EFI_SYSTEM_TABLE  *SystemTable
  )
{
  EFI_STATUS  Status;
  EFI_STRING  SearchString;

  Status = InterpretArguments ();
  if (!EFI_ERROR (Status)) {
    Status = VerifyMSRE2 ();
    if (!EFI_ERROR (Status)) {
      if (mArgumentFlags != ARG_VERIFY) {
        SearchString = AllocateCopyPool (L_STR_SIZE (L"cfg"), L"cfg");
        if (SearchString != NULL) {
          if (mArgumentFlags == ARG_INTERACTIVE) {
            ModifySearchString (&SearchString);
          }

          Status = SearchForString (SearchString);
          FreePool (SearchString);
        } else {
          Print (L"Could not allocate memory for SearchString\n");
          Status = EFI_OUT_OF_RESOURCES;
        }
      }
    } else {
      Print (L"Unable to verify MSR 0xE2 - %r\n", Status);
    }
  }

  Print (L"Press any key.\n");
  ReadAnyKey ();

  gST->ConOut->EnableCursor (gST->ConOut, TRUE);

  return Status;
}