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