ShellPkg/Library/UefiShellLevel3CommandsLib/UefiShellLevel3CommandsLib.h

   1 /** @file
   2   header file for NULL named library for level 3 shell command functions.
   3
   4   Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved. <BR>
   5   This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #include <Uefi.h>
  16 #include <ShellBase.h>
  17
  18 #include <Protocol/EfiShell.h>
  19 #include <Protocol/EfiShellParameters.h>
  20 #include <Protocol/DevicePath.h>
  21 #include <Protocol/LoadedImage.h>
  22 #include <Protocol/UnicodeCollation.h>
  23 #include <Protocol/DevicePathToText.h>
  24
  25 #include <Library/BaseLib.h>
  26 #include <Library/BaseMemoryLib.h>
  27 #include <Library/DebugLib.h>
  28 #include <Library/MemoryAllocationLib.h>
  29 #include <Library/PcdLib.h>
  30 #include <Library/ShellCommandLib.h>
  31 #include <Library/ShellLib.h>
  32 #include <Library/UefiLib.h>
  33 #include <Library/UefiRuntimeServicesTableLib.h>
  34 #include <Library/UefiBootServicesTableLib.h>
  35 #include <Library/HiiLib.h>
  36 #include <Library/FileHandleLib.h>
  37
  38 extern EFI_HANDLE gShellLevel3HiiHandle;
  39
  40 /**
  41   Function for 'type' command.
  42
  43   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
  44   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
  45 **/
  46 SHELL_STATUS
  47 EFIAPI
  48 ShellCommandRunType (
  49   IN EFI_HANDLE        ImageHandle,
  50   IN EFI_SYSTEM_TABLE  *SystemTable
  51   );
  52
  53 /**
  54   Function for 'touch' command.
  55
  56   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
  57   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
  58 **/
  59 SHELL_STATUS
  60 EFIAPI
  61 ShellCommandRunTouch (
  62   IN EFI_HANDLE        ImageHandle,
  63   IN EFI_SYSTEM_TABLE  *SystemTable
  64   );
  65
  66 /**
  67   Function for 'ver' command.
  68
  69   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
  70   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
  71 **/
  72 SHELL_STATUS
  73 EFIAPI
  74 ShellCommandRunVer (
  75   IN EFI_HANDLE        ImageHandle,
  76   IN EFI_SYSTEM_TABLE  *SystemTable
  77   );
  78
  79 /**
  80   Function for 'alias' command.
  81
  82   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
  83   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
  84 **/
  85 SHELL_STATUS
  86 EFIAPI
  87 ShellCommandRunAlias (
  88   IN EFI_HANDLE        ImageHandle,
  89   IN EFI_SYSTEM_TABLE  *SystemTable
  90   );
  91
  92 /**
  93   Function for 'cls' command.
  94
  95   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
  96   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
  97 **/
  98 SHELL_STATUS
  99 EFIAPI
 100 ShellCommandRunCls (
 101   IN EFI_HANDLE        ImageHandle,
 102   IN EFI_SYSTEM_TABLE  *SystemTable
 103   );
 104
 105 /**
 106   Function for 'echo' command.
 107
 108   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 109   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 110 **/
 111 SHELL_STATUS
 112 EFIAPI
 113 ShellCommandRunEcho (
 114   IN EFI_HANDLE        ImageHandle,
 115   IN EFI_SYSTEM_TABLE  *SystemTable
 116   );
 117
 118 /**
 119   Function for 'pause' command.
 120
 121   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 122   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 123 **/
 124 SHELL_STATUS
 125 EFIAPI
 126 ShellCommandRunPause (
 127   IN EFI_HANDLE        ImageHandle,
 128   IN EFI_SYSTEM_TABLE  *SystemTable
 129   );
 130
 131 /**
 132   Function for 'getmtc' command.
 133
 134   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 135   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 136 **/
 137 SHELL_STATUS
 138 EFIAPI
 139 ShellCommandRunGetMtc (
 140   IN EFI_HANDLE        ImageHandle,
 141   IN EFI_SYSTEM_TABLE  *SystemTable
 142   );
 143
 144 /**
 145   Function for 'help' command.
 146
 147   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 148   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 149 **/
 150 SHELL_STATUS
 151 EFIAPI
 152 ShellCommandRunHelp (
 153   IN EFI_HANDLE        ImageHandle,
 154   IN EFI_SYSTEM_TABLE  *SystemTable
 155   );
 156