MdeModulePkg: Apply uncrustify changes

[mirror_edk2.git] / MdeModulePkg / Library / BootMaintenanceManagerUiLib / BootMaintenanceManagerCustomizedUiSupport.c

/** @file\r
The functions for Boot Maintainence Main menu.\r
\r
Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "BootMaintenanceManager.h"\r
#include "BootMaintenanceManagerCustomizedUiSupport.h"\r
\r
#define UI_HII_DRIVER_LIST_SIZE  0x8\r
\r
typedef struct {\r
  EFI_STRING_ID    PromptId;\r
  EFI_STRING_ID    HelpId;\r
  EFI_STRING_ID    DevicePathId;\r
  EFI_GUID         FormSetGuid;\r
  BOOLEAN          EmptyLineAfter;\r
} UI_HII_DRIVER_INSTANCE;\r
\r
STATIC UI_HII_DRIVER_INSTANCE  *gHiiDriverList;\r
\r
/**\r
  Create the dynamic item to allow user to set the "BootNext" vaule.\r
\r
  @param[in]    HiiHandle           The hii handle for the Uiapp driver.\r
  @param[in]    StartOpCodeHandle   The opcode handle to save the new opcode.\r
\r
**/\r
VOID\r
BmmCreateBootNextMenu (\r
  IN EFI_HII_HANDLE  HiiHandle,\r
  IN VOID            *StartOpCodeHandle\r
  )\r
{\r
  BM_MENU_ENTRY    *NewMenuEntry;\r
  BM_LOAD_CONTEXT  *NewLoadContext;\r
  UINT16           Index;\r
  VOID             *OptionsOpCodeHandle;\r
  UINT32           BootNextIndex;\r
\r
  if (BootOptionMenu.MenuNumber == 0) {\r
    return;\r
  }\r
\r
  BootNextIndex = NONE_BOOTNEXT_VALUE;\r
\r
  OptionsOpCodeHandle = HiiAllocateOpCodeHandle ();\r
  ASSERT (OptionsOpCodeHandle != NULL);\r
\r
  for (Index = 0; Index < BootOptionMenu.MenuNumber; Index++) {\r
    NewMenuEntry   = BOpt_GetMenuEntry (&BootOptionMenu, Index);\r
    NewLoadContext = (BM_LOAD_CONTEXT *)NewMenuEntry->VariableContext;\r
\r
    if (NewLoadContext->IsBootNext) {\r
      HiiCreateOneOfOptionOpCode (\r
        OptionsOpCodeHandle,\r
        NewMenuEntry->DisplayStringToken,\r
        EFI_IFR_OPTION_DEFAULT,\r
        EFI_IFR_TYPE_NUM_SIZE_32,\r
        Index\r
        );\r
      BootNextIndex = Index;\r
    } else {\r
      HiiCreateOneOfOptionOpCode (\r
        OptionsOpCodeHandle,\r
        NewMenuEntry->DisplayStringToken,\r
        0,\r
        EFI_IFR_TYPE_NUM_SIZE_32,\r
        Index\r
        );\r
    }\r
  }\r
\r
  if (BootNextIndex == NONE_BOOTNEXT_VALUE) {\r
    HiiCreateOneOfOptionOpCode (\r
      OptionsOpCodeHandle,\r
      STRING_TOKEN (STR_NONE),\r
      EFI_IFR_OPTION_DEFAULT,\r
      EFI_IFR_TYPE_NUM_SIZE_32,\r
      NONE_BOOTNEXT_VALUE\r
      );\r
  } else {\r
    HiiCreateOneOfOptionOpCode (\r
      OptionsOpCodeHandle,\r
      STRING_TOKEN (STR_NONE),\r
      0,\r
      EFI_IFR_TYPE_NUM_SIZE_32,\r
      NONE_BOOTNEXT_VALUE\r
      );\r
  }\r
\r
  HiiCreateOneOfOpCode (\r
    StartOpCodeHandle,\r
    (EFI_QUESTION_ID)BOOT_NEXT_QUESTION_ID,\r
    VARSTORE_ID_BOOT_MAINT,\r
    BOOT_NEXT_VAR_OFFSET,\r
    STRING_TOKEN (STR_BOOT_NEXT),\r
    STRING_TOKEN (STR_BOOT_NEXT_HELP),\r
    0,\r
    EFI_IFR_NUMERIC_SIZE_4,\r
    OptionsOpCodeHandle,\r
    NULL\r
    );\r
\r
  HiiFreeOpCodeHandle (OptionsOpCodeHandle);\r
}\r
\r
/**\r
  Create Time Out Menu in the page.\r
\r
  @param[in]    HiiHandle           The hii handle for the Uiapp driver.\r
  @param[in]    StartOpCodeHandle   The opcode handle to save the new opcode.\r
\r
**/\r
VOID\r
BmmCreateTimeOutMenu (\r
  IN EFI_HII_HANDLE  HiiHandle,\r
  IN VOID            *StartOpCodeHandle\r
  )\r
{\r
  HiiCreateNumericOpCode (\r
    StartOpCodeHandle,\r
    (EFI_QUESTION_ID)FORM_TIME_OUT_ID,\r
    VARSTORE_ID_BOOT_MAINT,\r
    BOOT_TIME_OUT_VAR_OFFSET,\r
    STRING_TOKEN (STR_NUM_AUTO_BOOT),\r
    STRING_TOKEN (STR_HLP_AUTO_BOOT),\r
    EFI_IFR_FLAG_CALLBACK,\r
    EFI_IFR_NUMERIC_SIZE_2 | EFI_IFR_DISPLAY_UINT_DEC,\r
    0,\r
    65535,\r
    0,\r
    NULL\r
    );\r
}\r
\r
/**\r
  Create Boot Option menu in the page.\r
\r
  @param[in]    HiiHandle           The hii handle for the Uiapp driver.\r
  @param[in]    StartOpCodeHandle   The opcode handle to save the new opcode.\r
\r
**/\r
VOID\r
BmmCreateBootOptionMenu (\r
  IN EFI_HII_HANDLE  HiiHandle,\r
  IN VOID            *StartOpCodeHandle\r
  )\r
{\r
  HiiCreateGotoOpCode (\r
    StartOpCodeHandle,\r
    FORM_BOOT_SETUP_ID,\r
    STRING_TOKEN (STR_FORM_BOOT_SETUP_TITLE),\r
    STRING_TOKEN (STR_FORM_BOOT_SETUP_HELP),\r
    EFI_IFR_FLAG_CALLBACK,\r
    FORM_BOOT_SETUP_ID\r
    );\r
}\r
\r
/**\r
  Create Driver Option menu in the page.\r
\r
  @param[in]    HiiHandle           The hii handle for the Uiapp driver.\r
  @param[in]    StartOpCodeHandle   The opcode handle to save the new opcode.\r
\r
**/\r
VOID\r
BmmCreateDriverOptionMenu (\r
  IN EFI_HII_HANDLE  HiiHandle,\r
  IN VOID            *StartOpCodeHandle\r
  )\r
{\r
  HiiCreateGotoOpCode (\r
    StartOpCodeHandle,\r
    FORM_DRIVER_SETUP_ID,\r
    STRING_TOKEN (STR_FORM_DRIVER_SETUP_TITLE),\r
    STRING_TOKEN (STR_FORM_DRIVER_SETUP_HELP),\r
    EFI_IFR_FLAG_CALLBACK,\r
    FORM_DRIVER_SETUP_ID\r
    );\r
}\r
\r
/**\r
  Create Com Option menu in the page.\r
\r
  @param[in]    HiiHandle           The hii handle for the Uiapp driver.\r
  @param[in]    StartOpCodeHandle   The opcode handle to save the new opcode.\r
\r
**/\r
VOID\r
BmmCreateComOptionMenu (\r
  IN EFI_HII_HANDLE  HiiHandle,\r
  IN VOID            *StartOpCodeHandle\r
  )\r
{\r
  HiiCreateGotoOpCode (\r
    StartOpCodeHandle,\r
    FORM_CON_MAIN_ID,\r
    STRING_TOKEN (STR_FORM_CON_MAIN_TITLE),\r
    STRING_TOKEN (STR_FORM_CON_MAIN_HELP),\r
    EFI_IFR_FLAG_CALLBACK,\r
    FORM_CON_MAIN_ID\r
    );\r
}\r
\r
/**\r
  Create Com Option menu in the page.\r
\r
  @param[in]    HiiHandle           The hii handle for the Uiapp driver.\r
  @param[in]    StartOpCodeHandle   The opcode handle to save the new opcode.\r
\r
**/\r
VOID\r
BmmCreateBootFromFileMenu (\r
  IN EFI_HII_HANDLE  HiiHandle,\r
  IN VOID            *StartOpCodeHandle\r
  )\r
{\r
  HiiCreateGotoOpCode (\r
    StartOpCodeHandle,\r
    FORM_MAIN_ID,\r
    STRING_TOKEN (STR_BOOT_FROM_FILE),\r
    STRING_TOKEN (STR_BOOT_FROM_FILE_HELP),\r
    EFI_IFR_FLAG_CALLBACK,\r
    KEY_VALUE_BOOT_FROM_FILE\r
    );\r
}\r
\r
/**\r
  Create empty line menu in the front page.\r
\r
  @param    HiiHandle           The hii handle for the Uiapp driver.\r
  @param    StartOpCodeHandle   The opcode handle to save the new opcode.\r
\r
**/\r
VOID\r
BmmCreateEmptyLine (\r
  IN EFI_HII_HANDLE  HiiHandle,\r
  IN VOID            *StartOpCodeHandle\r
  )\r
{\r
  HiiCreateSubTitleOpCode (StartOpCodeHandle, STRING_TOKEN (STR_NULL_STRING), 0, 0, 0);\r
}\r
\r
/**\r
  Extract device path for given HII handle and class guid.\r
\r
  @param Handle          The HII handle.\r
\r
  @retval  NULL          Fail to get the device path string.\r
  @return  PathString    Get the device path string.\r
\r
**/\r
CHAR16 *\r
ExtractDevicePathFromHandle (\r
  IN      EFI_HII_HANDLE  Handle\r
  )\r
{\r
  EFI_STATUS  Status;\r
  EFI_HANDLE  DriverHandle;\r
\r
  ASSERT (Handle != NULL);\r
\r
  if (Handle == NULL) {\r
    return NULL;\r
  }\r
\r
  Status = gHiiDatabase->GetPackageListHandle (gHiiDatabase, Handle, &DriverHandle);\r
  if (EFI_ERROR (Status)) {\r
    return NULL;\r
  }\r
\r
  return ConvertDevicePathToText (DevicePathFromHandle (DriverHandle), FALSE, FALSE);\r
}\r
\r
/**\r
  Check whether this driver need to be shown in the front page.\r
\r
  @param    HiiHandle           The hii handle for the driver.\r
  @param    Guid                The special guid for the driver which is the target.\r
  @param    PromptId            Return the prompt string id.\r
  @param    HelpId              Return the help string id.\r
  @param    FormsetGuid         Return the formset guid info.\r
\r
  @retval   EFI_SUCCESS         Search the driver success\r
\r
**/\r
BOOLEAN\r
IsRequiredDriver (\r
  IN  EFI_HII_HANDLE  HiiHandle,\r
  IN  EFI_GUID        *Guid,\r
  OUT EFI_STRING_ID   *PromptId,\r
  OUT EFI_STRING_ID   *HelpId,\r
  OUT VOID            *FormsetGuid\r
  )\r
{\r
  EFI_STATUS        Status;\r
  UINT8             ClassGuidNum;\r
  EFI_GUID          *ClassGuid;\r
  EFI_IFR_FORM_SET  *Buffer;\r
  UINTN             BufferSize;\r
  UINT8             *Ptr;\r
  UINTN             TempSize;\r
  BOOLEAN           RetVal;\r
\r
  Status = HiiGetFormSetFromHiiHandle (HiiHandle, &Buffer, &BufferSize);\r
  if (EFI_ERROR (Status)) {\r
    return FALSE;\r
  }\r
\r
  RetVal   = FALSE;\r
  TempSize = 0;\r
  Ptr      = (UINT8 *)Buffer;\r
  while (TempSize < BufferSize) {\r
    TempSize += ((EFI_IFR_OP_HEADER *)Ptr)->Length;\r
\r
    if (((EFI_IFR_OP_HEADER *)Ptr)->Length <= OFFSET_OF (EFI_IFR_FORM_SET, Flags)) {\r
      Ptr += ((EFI_IFR_OP_HEADER *)Ptr)->Length;\r
      continue;\r
    }\r
\r
    ClassGuidNum = (UINT8)(((EFI_IFR_FORM_SET *)Ptr)->Flags & 0x3);\r
    ClassGuid    = (EFI_GUID *)(VOID *)(Ptr + sizeof (EFI_IFR_FORM_SET));\r
    while (ClassGuidNum-- > 0) {\r
      if (!CompareGuid (Guid, ClassGuid)) {\r
        ClassGuid++;\r
        continue;\r
      }\r
\r
      *PromptId = ((EFI_IFR_FORM_SET *)Ptr)->FormSetTitle;\r
      *HelpId   = ((EFI_IFR_FORM_SET *)Ptr)->Help;\r
      CopyMem (FormsetGuid, &((EFI_IFR_FORM_SET *)Ptr)->Guid, sizeof (EFI_GUID));\r
      RetVal = TRUE;\r
    }\r
  }\r
\r
  FreePool (Buffer);\r
\r
  return RetVal;\r
}\r
\r
/**\r
  Search the drivers in the system which need to show in the front page\r
  and insert the menu to the front page.\r
\r
  @param    HiiHandle           The hii handle for the Uiapp driver.\r
  @param    ClassGuid           The class guid for the driver which is the target.\r
  @param    SpecialHandlerFn    The pointer to the specail handler function, if any.\r
  @param    StartOpCodeHandle   The opcode handle to save the new opcode.\r
\r
  @retval   EFI_SUCCESS         Search the driver success\r
\r
**/\r
EFI_STATUS\r
BmmListThirdPartyDrivers (\r
  IN EFI_HII_HANDLE          HiiHandle,\r
  IN EFI_GUID                *ClassGuid,\r
  IN DRIVER_SPECIAL_HANDLER  SpecialHandlerFn,\r
  IN VOID                    *StartOpCodeHandle\r
  )\r
{\r
  UINTN                   Index;\r
  EFI_STRING              String;\r
  EFI_STRING_ID           Token;\r
  EFI_STRING_ID           TokenHelp;\r
  EFI_HII_HANDLE          *HiiHandles;\r
  CHAR16                  *DevicePathStr;\r
  UINTN                   Count;\r
  UINTN                   CurrentSize;\r
  UI_HII_DRIVER_INSTANCE  *DriverListPtr;\r
  EFI_STRING              NewName;\r
  BOOLEAN                 EmptyLineAfter;\r
\r
  if (gHiiDriverList != NULL) {\r
    FreePool (gHiiDriverList);\r
  }\r
\r
  HiiHandles = HiiGetHiiHandles (NULL);\r
  ASSERT (HiiHandles != NULL);\r
\r
  gHiiDriverList = AllocateZeroPool (UI_HII_DRIVER_LIST_SIZE * sizeof (UI_HII_DRIVER_INSTANCE));\r
  ASSERT (gHiiDriverList != NULL);\r
  DriverListPtr = gHiiDriverList;\r
  CurrentSize   = UI_HII_DRIVER_LIST_SIZE;\r
\r
  for (Index = 0, Count = 0; HiiHandles[Index] != NULL; Index++) {\r
    if (!IsRequiredDriver (HiiHandles[Index], ClassGuid, &Token, &TokenHelp, &gHiiDriverList[Count].FormSetGuid)) {\r
      continue;\r
    }\r
\r
    String = HiiGetString (HiiHandles[Index], Token, NULL);\r
    if (String == NULL) {\r
      String = HiiGetString (HiiHandle, STRING_TOKEN (STR_MISSING_STRING), NULL);\r
      ASSERT (String != NULL);\r
    } else if (SpecialHandlerFn != NULL) {\r
      //\r
      // Check whether need to rename the driver name.\r
      //\r
      EmptyLineAfter = FALSE;\r
      if (SpecialHandlerFn (String, &NewName, &EmptyLineAfter)) {\r
        FreePool (String);\r
        String                              = NewName;\r
        DriverListPtr[Count].EmptyLineAfter = EmptyLineAfter;\r
      }\r
    }\r
\r
    DriverListPtr[Count].PromptId = HiiSetString (HiiHandle, 0, String, NULL);\r
    FreePool (String);\r
\r
    String = HiiGetString (HiiHandles[Index], TokenHelp, NULL);\r
    if (String == NULL) {\r
      String = HiiGetString (HiiHandle, STRING_TOKEN (STR_MISSING_STRING), NULL);\r
      ASSERT (String != NULL);\r
    }\r
\r
    DriverListPtr[Count].HelpId = HiiSetString (HiiHandle, 0, String, NULL);\r
    FreePool (String);\r
\r
    DevicePathStr = ExtractDevicePathFromHandle (HiiHandles[Index]);\r
    if (DevicePathStr != NULL) {\r
      DriverListPtr[Count].DevicePathId = HiiSetString (HiiHandle, 0, DevicePathStr, NULL);\r
      FreePool (DevicePathStr);\r
    } else {\r
      DriverListPtr[Count].DevicePathId = 0;\r
    }\r
\r
    Count++;\r
    if (Count >= CurrentSize) {\r
      DriverListPtr = ReallocatePool (\r
                        CurrentSize * sizeof (UI_HII_DRIVER_INSTANCE),\r
                        (Count + UI_HII_DRIVER_LIST_SIZE)\r
                        * sizeof (UI_HII_DRIVER_INSTANCE),\r
                        gHiiDriverList\r
                        );\r
      ASSERT (DriverListPtr != NULL);\r
      gHiiDriverList = DriverListPtr;\r
      CurrentSize   += UI_HII_DRIVER_LIST_SIZE;\r
    }\r
  }\r
\r
  FreePool (HiiHandles);\r
\r
  Index = 0;\r
  while (gHiiDriverList[Index].PromptId != 0) {\r
    HiiCreateGotoExOpCode (\r
      StartOpCodeHandle,\r
      0,\r
      gHiiDriverList[Index].PromptId,\r
      gHiiDriverList[Index].HelpId,\r
      0,\r
      0,\r
      0,\r
      &gHiiDriverList[Index].FormSetGuid,\r
      gHiiDriverList[Index].DevicePathId\r
      );\r
\r
    if (gHiiDriverList[Index].EmptyLineAfter) {\r
      BmmCreateEmptyLine (HiiHandle, StartOpCodeHandle);\r
    }\r
\r
    Index++;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r