Updating level 1 commands.

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

diff --git a/ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.h b/ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.h
index b0aa51bc1b3e034665a111972319214c6af894fb..eadb501e2003e8f82ecbedf803a88503d3e8c449 100644 (file)
--- a/ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.h
+++ b/ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.h
@@ -1,7 +1,7 @@
 /** @file\r
   Main file for NULL named library for level 1 shell command functions.\r
 \r
-  Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>\r
   This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
   which accompanies this distribution.  The full text of the license may be found at\r
@@ -12,6 +12,9 @@
 \r
 **/\r
 \r
+#if !defined (_UEFI_SHELL_LEVEL1_COMMANDS_LIB_H_)\r
+#define _UEFI_SHELL_LEVEL1_COMMANDS_LIB_H_\r
+\r
 #include <Uefi.h>\r
 #include <ShellBase.h>\r
 \r
@@ -39,6 +42,19 @@
 extern        EFI_HANDLE                        gShellLevel1HiiHandle;\r
 extern CONST  EFI_GUID                          gShellLevel1HiiGuid;\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
@@ -156,16 +172,27 @@ LIST_ENTRY *
   );\r
 \r
 /**\r
-  Function to move to a spacified tag in a script file structure.\r
-\r
-  @param[in] Function       The pointer to the function to move with.\r
-  @param[in] DecrementerTag The pointer to a string to decrement upon finding.\r
-  @param[in] IncrementerTag The pointer to a string to increment upon finding.\r
-  @param[in] Label          A Label to look for.\r
-  @param[in] ScriptFile     The script file structure to look in.\r
-  @param[in] MovePast       TRUE to go to the element just after the found one.  FALSE otherwise.\r
-  @param[in] FindOnly       FALSE to change the execution point in the script file structure.   TRUE otherwise.\r
-  @param[in] WrapAroundScript  TRUE to go to begining when end is hit, or vise versa.  FALSE otherwise.\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
 EFIAPI\r
@@ -174,9 +201,11 @@ MoveToTag (
   IN CONST CHAR16               *DecrementerTag,\r
   IN CONST CHAR16               *IncrementerTag,\r
   IN CONST CHAR16               *Label OPTIONAL,\r
-  IN SCRIPT_FILE                *ScriptFile,\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