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 - 2011, 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 #ifndef _UEFI_SHELL_LEVEL3_COMMANDS_LIB_H_
  16 #define _UEFI_SHELL_LEVEL3_COMMANDS_LIB_H_
  17
  18 #include <Uefi.h>
  19 #include <ShellBase.h>
  20
  21 #include <Guid/ShellLibHiiGuid.h>
  22
  23 #include <Protocol/EfiShell.h>
  24 #include <Protocol/EfiShellParameters.h>
  25 #include <Protocol/DevicePath.h>
  26 #include <Protocol/LoadedImage.h>
  27 #include <Protocol/UnicodeCollation.h>
  28 #include <Protocol/DevicePathToText.h>
  29
  30 #include <Library/BaseLib.h>
  31 #include <Library/BaseMemoryLib.h>
  32 #include <Library/DebugLib.h>
  33 #include <Library/MemoryAllocationLib.h>
  34 #include <Library/PcdLib.h>
  35 #include <Library/ShellCommandLib.h>
  36 #include <Library/ShellLib.h>
  37 #include <Library/UefiLib.h>
  38 #include <Library/UefiRuntimeServicesTableLib.h>
  39 #include <Library/UefiBootServicesTableLib.h>
  40 #include <Library/HiiLib.h>
  41 #include <Library/FileHandleLib.h>
  42
  43 extern EFI_HANDLE gShellLevel3HiiHandle;
  44
  45 /**
  46   Function for 'type' command.
  47
  48   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
  49   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
  50 **/
  51 SHELL_STATUS
  52 EFIAPI
  53 ShellCommandRunType (
  54   IN EFI_HANDLE        ImageHandle,
  55   IN EFI_SYSTEM_TABLE  *SystemTable
  56   );
  57
  58 /**
  59   Function for 'touch' command.
  60
  61   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
  62   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
  63 **/
  64 SHELL_STATUS
  65 EFIAPI
  66 ShellCommandRunTouch (
  67   IN EFI_HANDLE        ImageHandle,
  68   IN EFI_SYSTEM_TABLE  *SystemTable
  69   );
  70
  71 /**
  72   Function for 'ver' command.
  73
  74   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
  75   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
  76 **/
  77 SHELL_STATUS
  78 EFIAPI
  79 ShellCommandRunVer (
  80   IN EFI_HANDLE        ImageHandle,
  81   IN EFI_SYSTEM_TABLE  *SystemTable
  82   );
  83
  84 /**
  85   Function for 'alias' command.
  86
  87   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
  88   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
  89 **/
  90 SHELL_STATUS
  91 EFIAPI
  92 ShellCommandRunAlias (
  93   IN EFI_HANDLE        ImageHandle,
  94   IN EFI_SYSTEM_TABLE  *SystemTable
  95   );
  96
  97 /**
  98   Function for 'cls' command.
  99
 100   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 101   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 102 **/
 103 SHELL_STATUS
 104 EFIAPI
 105 ShellCommandRunCls (
 106   IN EFI_HANDLE        ImageHandle,
 107   IN EFI_SYSTEM_TABLE  *SystemTable
 108   );
 109
 110 /**
 111   Function for 'echo' command.
 112
 113   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 114   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 115 **/
 116 SHELL_STATUS
 117 EFIAPI
 118 ShellCommandRunEcho (
 119   IN EFI_HANDLE        ImageHandle,
 120   IN EFI_SYSTEM_TABLE  *SystemTable
 121   );
 122
 123 /**
 124   Function for 'pause' command.
 125
 126   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 127   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 128 **/
 129 SHELL_STATUS
 130 EFIAPI
 131 ShellCommandRunPause (
 132   IN EFI_HANDLE        ImageHandle,
 133   IN EFI_SYSTEM_TABLE  *SystemTable
 134   );
 135
 136 /**
 137   Function for 'getmtc' command.
 138
 139   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 140   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 141 **/
 142 SHELL_STATUS
 143 EFIAPI
 144 ShellCommandRunGetMtc (
 145   IN EFI_HANDLE        ImageHandle,
 146   IN EFI_SYSTEM_TABLE  *SystemTable
 147   );
 148
 149 /**
 150   Function for 'help' command.
 151
 152   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 153   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 154 **/
 155 SHELL_STATUS
 156 EFIAPI
 157 ShellCommandRunHelp (
 158   IN EFI_HANDLE        ImageHandle,
 159   IN EFI_SYSTEM_TABLE  *SystemTable
 160   );
 161
 162 #endif
 163