ShellPkg: acpiview: Add GT Frame Number validation to GTDT parser

[mirror_edk2.git] / ShellPkg / Library / UefiShellLevel1CommandsLib / UefiShellLevel1CommandsLib.h

/** @file\r
  Main file for NULL named library for level 1 shell command functions.\r
\r
  Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _UEFI_SHELL_LEVEL1_COMMANDS_LIB_H_\r
#define _UEFI_SHELL_LEVEL1_COMMANDS_LIB_H_\r
\r
#include <Uefi.h>\r
\r
#include <Guid/ShellLibHiiGuid.h>\r
\r
#include <Protocol/Shell.h>\r
#include <Protocol/ShellParameters.h>\r
#include <Protocol/DevicePath.h>\r
#include <Protocol/LoadedImage.h>\r
#include <Protocol/UnicodeCollation.h>\r
\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/ShellCommandLib.h>\r
#include <Library/ShellLib.h>\r
#include <Library/SortLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/HiiLib.h>\r
#include <Library/FileHandleLib.h>\r
\r
extern        EFI_HANDLE                        gShellLevel1HiiHandle;\r
\r
/**\r
  Function for 'stall' command.\r
\r
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
**/\r
SHELL_STATUS\r
EFIAPI\r
ShellCommandRunStall (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
/**\r
  Function for 'exit' command.\r
\r
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
**/\r
SHELL_STATUS\r
EFIAPI\r
ShellCommandRunExit (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
/**\r
  Function for 'endif' command.\r
\r
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
**/\r
SHELL_STATUS\r
EFIAPI\r
ShellCommandRunEndIf (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
/**\r
  Function for 'for' command.\r
\r
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
**/\r
SHELL_STATUS\r
EFIAPI\r
ShellCommandRunFor (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
/**\r
  Function for 'endfor' command.\r
\r
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
**/\r
SHELL_STATUS\r
EFIAPI\r
ShellCommandRunEndFor (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
/**\r
  Function for 'if' command.\r
\r
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
**/\r
SHELL_STATUS\r
EFIAPI\r
ShellCommandRunIf (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
/**\r
  Function for 'goto' command.\r
\r
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
**/\r
SHELL_STATUS\r
EFIAPI\r
ShellCommandRunGoto (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
/**\r
  Function for 'shift' command.\r
\r
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
**/\r
SHELL_STATUS\r
EFIAPI\r
ShellCommandRunShift (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
\r
/**\r
  Function for 'else' command.\r
\r
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
**/\r
SHELL_STATUS\r
EFIAPI\r
ShellCommandRunElse (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
///\r
/// Function prototype for BOTH GetNextNode and GetPreviousNode...\r
/// This is used to control the MoveToTag function direction...\r
///\r
typedef\r
LIST_ENTRY *\r
(EFIAPI *LIST_MANIP_FUNC)(\r
  IN CONST LIST_ENTRY *List,\r
  IN CONST LIST_ENTRY *Node\r
  );\r
\r
/**\r
  Move the script pointer from 1 tag (line) to another.\r
\r
  It functions so that count starts at 1 and it increases or decreases when it\r
  hits the specified tags.  when it hits zero the location has been found.\r
\r
  DecrementerTag and IncrementerTag are used to get around for/endfor and\r
  similar paired types where the entire middle should be ignored.\r
\r
  If label is used it will be used instead of the count.\r
\r
  @param[in] Function          The function to use to enumerate through the\r
                               list.  Normally GetNextNode or GetPreviousNode.\r
  @param[in] DecrementerTag    The tag to decrement the count at.\r
  @param[in] IncrementerTag    The tag to increment the count at.\r
  @param[in] Label             A label to look for.\r
  @param[in, out] ScriptFile   The pointer to the current script file structure.\r
  @param[in] MovePast          TRUE makes function return 1 past the found\r
                               location.\r
  @param[in] FindOnly          TRUE to not change the ScriptFile.\r
  @param[in] WrapAroundScript  TRUE to wrap end-to-begining or vise versa in\r
                               searching.\r
**/\r
BOOLEAN\r
MoveToTag (\r
  IN CONST LIST_MANIP_FUNC      Function,\r
  IN CONST CHAR16               *DecrementerTag,\r
  IN CONST CHAR16               *IncrementerTag,\r
  IN CONST CHAR16               *Label OPTIONAL,\r
  IN OUT SCRIPT_FILE            *ScriptFile,\r
  IN CONST BOOLEAN              MovePast,\r
  IN CONST BOOLEAN              FindOnly,\r
  IN CONST BOOLEAN              WrapAroundScript\r
  );\r
\r
#endif\r
\r