mirror of
				https://github.com/acidanthera/audk.git
				synced 2025-11-04 13:35:48 +01:00 
			
		
		
		
	Signed-off-by: Ruiyu Ni <ruiyu.ni@intel.com> Reviewed-by: Feng Tian <feng.tian@intel.com> Reviewed-by: Elvin Li <elvin.li@intel.com> Reviewed-by: Eric Dong <eric.dong@intel.com> Reviewed-by: Star Zeng <star.zeng@intel.com> Reviewed-by: Jaben Carsey <jaben.carsey@intel.com> Reviewed-by: Guo Dong <guo.dong@intel.com> git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@14505 6f19259b-4bc3-4df7-8a09-765794883524
		
			
				
	
	
		
			212 lines
		
	
	
		
			6.0 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			212 lines
		
	
	
		
			6.0 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
/** @file
 | 
						|
  Main file for NULL named library for level 1 shell command functions.
 | 
						|
 | 
						|
  Copyright (c) 2009 - 2013, Intel Corporation. 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.
 | 
						|
 | 
						|
**/
 | 
						|
 | 
						|
#ifndef _UEFI_SHELL_LEVEL1_COMMANDS_LIB_H_
 | 
						|
#define _UEFI_SHELL_LEVEL1_COMMANDS_LIB_H_
 | 
						|
 | 
						|
#include <Uefi.h>
 | 
						|
#include <ShellBase.h>
 | 
						|
 | 
						|
#include <Guid/ShellLibHiiGuid.h>
 | 
						|
 | 
						|
#include <Protocol/EfiShell.h>
 | 
						|
#include <Protocol/EfiShellParameters.h>
 | 
						|
#include <Protocol/DevicePath.h>
 | 
						|
#include <Protocol/LoadedImage.h>
 | 
						|
#include <Protocol/UnicodeCollation.h>
 | 
						|
 | 
						|
#include <Library/BaseLib.h>
 | 
						|
#include <Library/BaseMemoryLib.h>
 | 
						|
#include <Library/DebugLib.h>
 | 
						|
#include <Library/MemoryAllocationLib.h>
 | 
						|
#include <Library/PcdLib.h>
 | 
						|
#include <Library/ShellCommandLib.h>
 | 
						|
#include <Library/ShellLib.h>
 | 
						|
#include <Library/SortLib.h>
 | 
						|
#include <Library/UefiLib.h>
 | 
						|
#include <Library/UefiRuntimeServicesTableLib.h>
 | 
						|
#include <Library/UefiBootServicesTableLib.h>
 | 
						|
#include <Library/HiiLib.h>
 | 
						|
#include <Library/FileHandleLib.h>
 | 
						|
 | 
						|
extern        EFI_HANDLE                        gShellLevel1HiiHandle;
 | 
						|
 | 
						|
/**
 | 
						|
  Function for 'stall' command.
 | 
						|
 | 
						|
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 | 
						|
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 | 
						|
**/
 | 
						|
SHELL_STATUS
 | 
						|
EFIAPI
 | 
						|
ShellCommandRunStall (
 | 
						|
  IN EFI_HANDLE        ImageHandle,
 | 
						|
  IN EFI_SYSTEM_TABLE  *SystemTable
 | 
						|
  );
 | 
						|
 | 
						|
/**
 | 
						|
  Function for 'exit' command.
 | 
						|
 | 
						|
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 | 
						|
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 | 
						|
**/
 | 
						|
SHELL_STATUS
 | 
						|
EFIAPI
 | 
						|
ShellCommandRunExit (
 | 
						|
  IN EFI_HANDLE        ImageHandle,
 | 
						|
  IN EFI_SYSTEM_TABLE  *SystemTable
 | 
						|
  );
 | 
						|
 | 
						|
/**
 | 
						|
  Function for 'endif' command.
 | 
						|
 | 
						|
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 | 
						|
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 | 
						|
**/
 | 
						|
SHELL_STATUS
 | 
						|
EFIAPI
 | 
						|
ShellCommandRunEndIf (
 | 
						|
  IN EFI_HANDLE        ImageHandle,
 | 
						|
  IN EFI_SYSTEM_TABLE  *SystemTable
 | 
						|
  );
 | 
						|
 | 
						|
/**
 | 
						|
  Function for 'for' command.
 | 
						|
 | 
						|
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 | 
						|
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 | 
						|
**/
 | 
						|
SHELL_STATUS
 | 
						|
EFIAPI
 | 
						|
ShellCommandRunFor (
 | 
						|
  IN EFI_HANDLE        ImageHandle,
 | 
						|
  IN EFI_SYSTEM_TABLE  *SystemTable
 | 
						|
  );
 | 
						|
 | 
						|
/**
 | 
						|
  Function for 'endfor' command.
 | 
						|
 | 
						|
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 | 
						|
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 | 
						|
**/
 | 
						|
SHELL_STATUS
 | 
						|
EFIAPI
 | 
						|
ShellCommandRunEndFor (
 | 
						|
  IN EFI_HANDLE        ImageHandle,
 | 
						|
  IN EFI_SYSTEM_TABLE  *SystemTable
 | 
						|
  );
 | 
						|
 | 
						|
/**
 | 
						|
  Function for 'if' command.
 | 
						|
 | 
						|
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 | 
						|
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 | 
						|
**/
 | 
						|
SHELL_STATUS
 | 
						|
EFIAPI
 | 
						|
ShellCommandRunIf (
 | 
						|
  IN EFI_HANDLE        ImageHandle,
 | 
						|
  IN EFI_SYSTEM_TABLE  *SystemTable
 | 
						|
  );
 | 
						|
 | 
						|
/**
 | 
						|
  Function for 'goto' command.
 | 
						|
 | 
						|
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 | 
						|
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 | 
						|
**/
 | 
						|
SHELL_STATUS
 | 
						|
EFIAPI
 | 
						|
ShellCommandRunGoto (
 | 
						|
  IN EFI_HANDLE        ImageHandle,
 | 
						|
  IN EFI_SYSTEM_TABLE  *SystemTable
 | 
						|
  );
 | 
						|
 | 
						|
/**
 | 
						|
  Function for 'shift' command.
 | 
						|
 | 
						|
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 | 
						|
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 | 
						|
**/
 | 
						|
SHELL_STATUS
 | 
						|
EFIAPI
 | 
						|
ShellCommandRunShift (
 | 
						|
  IN EFI_HANDLE        ImageHandle,
 | 
						|
  IN EFI_SYSTEM_TABLE  *SystemTable
 | 
						|
  );
 | 
						|
 | 
						|
 | 
						|
/**
 | 
						|
  Function for 'else' command.
 | 
						|
 | 
						|
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 | 
						|
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 | 
						|
**/
 | 
						|
SHELL_STATUS
 | 
						|
EFIAPI
 | 
						|
ShellCommandRunElse (
 | 
						|
  IN EFI_HANDLE        ImageHandle,
 | 
						|
  IN EFI_SYSTEM_TABLE  *SystemTable
 | 
						|
  );
 | 
						|
 | 
						|
///
 | 
						|
/// Function prototype for BOTH GetNextNode and GetPreviousNode...
 | 
						|
/// This is used to control the MoveToTag function direction...
 | 
						|
///
 | 
						|
typedef
 | 
						|
LIST_ENTRY *
 | 
						|
(EFIAPI *LIST_MANIP_FUNC)(
 | 
						|
  IN CONST LIST_ENTRY *List,
 | 
						|
  IN CONST LIST_ENTRY *Node
 | 
						|
  );
 | 
						|
 | 
						|
/**
 | 
						|
  Move the script pointer from 1 tag (line) to another.
 | 
						|
 | 
						|
  It functions so that count starts at 1 and it increases or decreases when it
 | 
						|
  hits the specified tags.  when it hits zero the location has been found.
 | 
						|
 | 
						|
  DecrementerTag and IncrementerTag are used to get around for/endfor and 
 | 
						|
  similar paired types where the entire middle should be ignored.
 | 
						|
 | 
						|
  If label is used it will be used instead of the count.
 | 
						|
 | 
						|
  @param[in] Function          The function to use to enumerate through the 
 | 
						|
                               list.  Normally GetNextNode or GetPreviousNode.
 | 
						|
  @param[in] DecrementerTag    The tag to decrement the count at.
 | 
						|
  @param[in] IncrementerTag    The tag to increment the count at.
 | 
						|
  @param[in] Label             A label to look for.
 | 
						|
  @param[in, out] ScriptFile   The pointer to the current script file structure.
 | 
						|
  @param[in] MovePast          TRUE makes function return 1 past the found 
 | 
						|
                               location.
 | 
						|
  @param[in] FindOnly          TRUE to not change the ScriptFile.
 | 
						|
  @param[in] WrapAroundScript  TRUE to wrap end-to-begining or vise versa in 
 | 
						|
                               searching.
 | 
						|
**/
 | 
						|
BOOLEAN
 | 
						|
EFIAPI
 | 
						|
MoveToTag (
 | 
						|
  IN CONST LIST_MANIP_FUNC      Function,
 | 
						|
  IN CONST CHAR16               *DecrementerTag,
 | 
						|
  IN CONST CHAR16               *IncrementerTag,
 | 
						|
  IN CONST CHAR16               *Label OPTIONAL,
 | 
						|
  IN OUT SCRIPT_FILE            *ScriptFile,
 | 
						|
  IN CONST BOOLEAN              MovePast,
 | 
						|
  IN CONST BOOLEAN              FindOnly,
 | 
						|
  IN CONST BOOLEAN              WrapAroundScript
 | 
						|
  );
 | 
						|
 | 
						|
#endif
 | 
						|
 |