ShellPkg/Application/Shell/Shell.h

   1 /** @file
   2   function definitions for internal to shell 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 _SHELL_INTERNAL_HEADER_
  16 #define _SHELL_INTERNAL_HEADER_
  17
  18 #include <Uefi.h>
  19 #include <ShellBase.h>
  20
  21 #include <Guid/ShellVariableGuid.h>
  22
  23 #include <Protocol/LoadedImage.h>
  24 #include <Protocol/SimpleTextOut.h>
  25 #include <Protocol/EfiShell.h>
  26 #include <Protocol/EfiShellInterface.h>
  27 #include <Protocol/EfiShellEnvironment2.h>
  28 #include <Protocol/EfiShellParameters.h>
  29 #include <Protocol/BlockIo.h>
  30
  31 #include <Library/BaseLib.h>
  32 #include <Library/UefiApplicationEntryPoint.h>
  33 #include <Library/UefiLib.h>
  34 #include <Library/DebugLib.h>
  35 #include <Library/MemoryAllocationLib.h>
  36 #include <Library/ShellCommandLib.h>
  37 #include <Library/UefiRuntimeServicesTableLib.h>
  38 #include <Library/UefiBootServicesTableLib.h>
  39 #include <Library/DevicePathLib.h>
  40 #include <Library/BaseMemoryLib.h>
  41 #include <Library/PcdLib.h>
  42 #include <Library/ShellLib.h>
  43 #include <Library/SortLib.h>
  44 #include <Library/HiiLib.h>
  45 #include <Library/PrintLib.h>
  46 #include <Library/HandleParsingLib.h>
  47
  48 #include "ShellParametersProtocol.h"
  49 #include "ShellProtocol.h"
  50 #include "ShellEnvVar.h"
  51 #include "ConsoleLogger.h"
  52 #include "ShellManParser.h"
  53 #include "ConsoleWrappers.h"
  54
  55 typedef struct {
  56   LIST_ENTRY        Link;           ///< Standard linked list handler.
  57   SHELL_FILE_HANDLE *SplitStdOut;   ///< ConsoleOut for use in the split.
  58   SHELL_FILE_HANDLE *SplitStdIn;    ///< ConsoleIn for use in the split.
  59 } SPLIT_LIST;
  60
  61 typedef struct {
  62   UINT32  Startup:1;      ///< Was "-startup"       found on command line.
  63   UINT32  NoStartup:1;    ///< Was "-nostartup"     found on command line.
  64   UINT32  NoConsoleOut:1; ///< Was "-noconsoleout"  found on command line.
  65   UINT32  NoConsoleIn:1;  ///< Was "-noconsolein"   found on command line.
  66   UINT32  NoInterrupt:1;  ///< Was "-nointerrupt"   found on command line.
  67   UINT32  NoMap:1;        ///< Was "-nomap"         found on command line.
  68   UINT32  NoVersion:1;    ///< Was "-noversion"     found on command line.
  69   UINT32  Delay:1;        ///< Was "-delay[:n]      found on command line
  70   UINT32  Reserved:8;     ///< Extra bits
  71 } SHELL_BITS;
  72
  73 typedef union {
  74   SHELL_BITS  Bits;
  75   UINT16      AllBits;
  76 } SHELL_BIT_UNION;
  77
  78 typedef struct {
  79   SHELL_BIT_UNION BitUnion;
  80   UINTN           Delay;          ///< Seconds of delay default:5.
  81   CHAR16          *FileName;      ///< Filename to run upon successful initialization.
  82   CHAR16          *FileOptions;   ///< Options to pass to FileName.
  83 } SHELL_INIT_SETTINGS;
  84
  85 typedef struct {
  86   BUFFER_LIST                 CommandHistory;
  87   UINTN                       VisibleRowNumber;
  88   UINTN                       OriginalVisibleRowNumber;
  89   BOOLEAN                     InsertMode;           ///< Is the current typing mode insert (FALSE = overwrite).
  90 } SHELL_VIEWING_SETTINGS;
  91
  92 typedef struct {
  93   EFI_SHELL_PARAMETERS_PROTOCOL *NewShellParametersProtocol;
  94   EFI_SHELL_PROTOCOL            *NewEfiShellProtocol;
  95   BOOLEAN                       PageBreakEnabled;
  96   BOOLEAN                       RootShellInstance;
  97   SHELL_INIT_SETTINGS           ShellInitSettings;
  98   BUFFER_LIST                   BufferToFreeList;     ///< List of buffers that were returned to the user to free.
  99   SHELL_VIEWING_SETTINGS        ViewingSettings;
 100   EFI_HII_HANDLE                HiiHandle;            ///< Handle from HiiLib.
 101   UINTN                         LogScreenCount;       ///< How many screens of log information to save.
 102   EFI_EVENT                     UserBreakTimer;       ///< Timer event for polling for CTRL-C.
 103   EFI_DEVICE_PATH_PROTOCOL      *ImageDevPath;        ///< DevicePath for ourselves.
 104   EFI_DEVICE_PATH_PROTOCOL      *FileDevPath;         ///< DevicePath for ourselves.
 105   CONSOLE_LOGGER_PRIVATE_DATA   *ConsoleInfo;         ///< Pointer for ConsoleInformation.
 106   EFI_SHELL_PARAMETERS_PROTOCOL *OldShellParameters;  ///< old shell parameters to reinstall upon exiting.
 107   SHELL_PROTOCOL_HANDLE_LIST    OldShellList;         ///< List of other instances to reinstall when closing.
 108   SPLIT_LIST                    SplitList;            ///< List of Splits in FILO stack.
 109   EFI_HANDLE                    CtrlCNotifyHandle1;   ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
 110   EFI_HANDLE                    CtrlCNotifyHandle2;   ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
 111   EFI_HANDLE                    CtrlCNotifyHandle3;   ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
 112   EFI_HANDLE                    CtrlCNotifyHandle4;   ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
 113   EFI_HANDLE                    CtrlSNotifyHandle1;   ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
 114   EFI_HANDLE                    CtrlSNotifyHandle2;   ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
 115   EFI_HANDLE                    CtrlSNotifyHandle3;   ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
 116   EFI_HANDLE                    CtrlSNotifyHandle4;   ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
 117   BOOLEAN                       HaltOutput;           ///< TRUE to start a CTRL-S halt.
 118 } SHELL_INFO;
 119
 120 extern SHELL_INFO ShellInfoObject;
 121
 122 /**
 123   Sets all the alias' that were registered with the ShellCommandLib library.
 124
 125   @retval EFI_SUCCESS           all init commands were run sucessfully.
 126 **/
 127 EFI_STATUS
 128 EFIAPI
 129 SetBuiltInAlias(
 130   VOID
 131   );
 132
 133 /**
 134   This function will populate the 2 device path protocol parameters based on the
 135   global gImageHandle.  the DevPath will point to the device path for the handle that has
 136   loaded image protocol installed on it.  the FilePath will point to the device path
 137   for the file that was loaded.
 138
 139   @param[in,out] DevPath       on a sucessful return the device path to the loaded image
 140   @param[in,out] FilePath      on a sucessful return the device path to the file
 141
 142   @retval EFI_SUCCESS           the 2 device paths were sucessfully returned.
 143   @return other                 a error from gBS->HandleProtocol
 144
 145   @sa HandleProtocol
 146 **/
 147 EFI_STATUS
 148 EFIAPI
 149 GetDevicePathsForImageAndFile (
 150   IN OUT EFI_DEVICE_PATH_PROTOCOL **DevPath,
 151   IN OUT EFI_DEVICE_PATH_PROTOCOL **FilePath
 152   );
 153
 154 /**
 155   Process all Uefi Shell 2.0 command line options.
 156
 157   see Uefi Shell 2.0 section 3.2 for full details.
 158
 159   the command line should resemble the following:
 160
 161   shell.efi [ShellOpt-options] [options] [file-name [file-name-options]]
 162
 163   ShellOpt options  Options which control the initialization behavior of the shell.
 164                     These options are read from the EFI global variable "ShellOpt"
 165                     and are processed before options or file-name.
 166
 167   options           Options which control the initialization behavior of the shell.
 168
 169   file-name         The name of a UEFI shell application or script to be executed
 170                     after initialization is complete. By default, if file-name is
 171                     specified, then -nostartup is implied. Scripts are not supported
 172                     by level 0.
 173
 174   file-nameoptions  The command-line options that are passed to file-name when it
 175                     is invoked.
 176
 177   This will initialize the ShellInitSettings global variable.
 178
 179   @retval EFI_SUCCESS           the variable is initialized.
 180 **/
 181 EFI_STATUS
 182 EFIAPI
 183 ProcessCommandLine(
 184   VOID
 185   );
 186
 187 /**
 188   Handles all interaction with the default startup script.
 189
 190   this will check that the correct command line parameters were passed, handle the delay, and then start running the script.
 191
 192   @param[in] ImagePath          The path to the image for shell.  The first place to look for the startup script.
 193   @param[in] FilePath           The path to the file for shell.  The second place to look for the startup script.
 194
 195   @retval EFI_SUCCESS           The variable is initialized.
 196 **/
 197 EFI_STATUS
 198 EFIAPI
 199 DoStartupScript(
 200   IN EFI_DEVICE_PATH_PROTOCOL *ImagePath,
 201   IN EFI_DEVICE_PATH_PROTOCOL *FilePath
 202   );
 203
 204 /**
 205   Function to perform the shell prompt looping.  It will do a single prompt,
 206   dispatch the result, and then return.  It is expected that the caller will
 207   call this function in a loop many times.
 208
 209   @retval EFI_SUCCESS
 210   @retval RETURN_ABORTED
 211 **/
 212 EFI_STATUS
 213 EFIAPI
 214 DoShellPrompt (
 215   VOID
 216   );
 217
 218 /**
 219   Add a buffer to the Buffer To Free List for safely returning buffers to other
 220   places without risking letting them modify internal shell information.
 221
 222   @param Buffer   Something to pass to FreePool when the shell is exiting.
 223 **/
 224 VOID*
 225 EFIAPI
 226 AddBufferToFreeList(
 227   VOID *Buffer
 228   );
 229
 230 /**
 231   Add a buffer to the Command History List.
 232
 233   @param Buffer[in]     The line buffer to add.
 234 **/
 235 VOID
 236 EFIAPI
 237 AddLineToCommandHistory(
 238   IN CONST CHAR16 *Buffer
 239   );
 240
 241 /**
 242   Function will process and run a command line.
 243
 244   This will determine if the command line represents an internal shell command or dispatch an external application.
 245
 246   @param[in] CmdLine  the command line to parse
 247
 248   @retval EFI_SUCCESS     the command was completed
 249   @retval EFI_ABORTED     the command's operation was aborted
 250 **/
 251 EFI_STATUS
 252 EFIAPI
 253 RunCommand(
 254   IN CONST CHAR16   *CmdLine
 255   );
 256
 257 /**
 258   Function determins if the CommandName COULD be a valid command.  It does not determine whether
 259   this is a valid command.  It only checks for invalid characters.
 260
 261   @param[in] CommandName    The name to check
 262
 263   @retval TRUE              CommandName could be a command name
 264   @retval FALSE             CommandName could not be a valid command name
 265 **/
 266 BOOLEAN
 267 EFIAPI
 268 IsValidCommandName(
 269   IN CONST CHAR16     *CommandName
 270   );
 271
 272 /**
 273   Function to process a NSH script file via SHELL_FILE_HANDLE.
 274
 275   @param[in] Handle             The handle to the already opened file.
 276   @param[in] Name               The name of the script file.
 277
 278   @retval EFI_SUCCESS           the script completed sucessfully
 279 **/
 280 EFI_STATUS
 281 EFIAPI
 282 RunScriptFileHandle (
 283   IN SHELL_FILE_HANDLE  Handle,
 284   IN CONST CHAR16       *Name
 285   );
 286
 287 /**
 288   Function to process a NSH script file.
 289
 290   @param[in] ScriptPath         Pointer to the script file name (including file system path).
 291
 292   @retval EFI_SUCCESS           the script completed sucessfully
 293 **/
 294 EFI_STATUS
 295 EFIAPI
 296 RunScriptFile (
 297   IN CONST CHAR16 *ScriptPath
 298   );
 299
 300
 301 #endif //_SHELL_INTERNAL_HEADER_
 302