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