2 function definitions for internal to shell functions.
4 (C) Copyright 2014, Hewlett-Packard Development Company, L.P.
5 Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #ifndef _SHELL_INTERNAL_HEADER_
17 #define _SHELL_INTERNAL_HEADER_
20 #include <ShellBase.h>
22 #include <Guid/ShellVariableGuid.h>
23 #include <Guid/ShellAliasGuid.h>
25 #include <Protocol/LoadedImage.h>
26 #include <Protocol/SimpleTextOut.h>
27 #include <Protocol/EfiShell.h>
28 #include <Protocol/EfiShellInterface.h>
29 #include <Protocol/EfiShellEnvironment2.h>
30 #include <Protocol/EfiShellParameters.h>
31 #include <Protocol/BlockIo.h>
33 #include <Library/BaseLib.h>
34 #include <Library/UefiApplicationEntryPoint.h>
35 #include <Library/UefiLib.h>
36 #include <Library/DebugLib.h>
37 #include <Library/MemoryAllocationLib.h>
38 #include <Library/ShellCommandLib.h>
39 #include <Library/UefiRuntimeServicesTableLib.h>
40 #include <Library/UefiBootServicesTableLib.h>
41 #include <Library/DevicePathLib.h>
42 #include <Library/BaseMemoryLib.h>
43 #include <Library/PcdLib.h>
44 #include <Library/ShellLib.h>
45 #include <Library/SortLib.h>
46 #include <Library/HiiLib.h>
47 #include <Library/PrintLib.h>
48 #include <Library/HandleParsingLib.h>
49 #include <Library/PathLib.h>
50 #include <Library/FileHandleLib.h>
52 #include "ShellParametersProtocol.h"
53 #include "ShellProtocol.h"
54 #include "ShellEnvVar.h"
55 #include "ConsoleLogger.h"
56 #include "ShellManParser.h"
57 #include "ConsoleWrappers.h"
58 #include "FileHandleWrappers.h"
61 LIST_ENTRY Link
; ///< Standard linked list handler.
62 SHELL_FILE_HANDLE
*SplitStdOut
; ///< ConsoleOut for use in the split.
63 SHELL_FILE_HANDLE
*SplitStdIn
; ///< ConsoleIn for use in the split.
67 UINT32 Startup
:1; ///< Was "-startup" found on command line.
68 UINT32 NoStartup
:1; ///< Was "-nostartup" found on command line.
69 UINT32 NoConsoleOut
:1; ///< Was "-noconsoleout" found on command line.
70 UINT32 NoConsoleIn
:1; ///< Was "-noconsolein" found on command line.
71 UINT32 NoInterrupt
:1; ///< Was "-nointerrupt" found on command line.
72 UINT32 NoMap
:1; ///< Was "-nomap" found on command line.
73 UINT32 NoVersion
:1; ///< Was "-noversion" found on command line.
74 UINT32 Delay
:1; ///< Was "-delay[:n] found on command line
75 UINT32 Exit
:1; ///< Was "-_exit" found on command line
76 UINT32 Reserved
:7; ///< Extra bits
85 SHELL_BIT_UNION BitUnion
;
86 UINTN Delay
; ///< Seconds of delay default:5.
87 CHAR16
*FileName
; ///< Filename to run upon successful initialization.
88 CHAR16
*FileOptions
; ///< Options to pass to FileName.
89 } SHELL_INIT_SETTINGS
;
92 BUFFER_LIST CommandHistory
;
93 UINTN VisibleRowNumber
;
94 UINTN OriginalVisibleRowNumber
;
95 BOOLEAN InsertMode
; ///< Is the current typing mode insert (FALSE = overwrite).
96 } SHELL_VIEWING_SETTINGS
;
99 EFI_SHELL_PARAMETERS_PROTOCOL
*NewShellParametersProtocol
;
100 EFI_SHELL_PROTOCOL
*NewEfiShellProtocol
;
101 BOOLEAN PageBreakEnabled
;
102 BOOLEAN RootShellInstance
;
103 SHELL_INIT_SETTINGS ShellInitSettings
;
104 BUFFER_LIST BufferToFreeList
; ///< List of buffers that were returned to the user to free.
105 SHELL_VIEWING_SETTINGS ViewingSettings
;
106 EFI_HII_HANDLE HiiHandle
; ///< Handle from HiiLib.
107 UINTN LogScreenCount
; ///< How many screens of log information to save.
108 EFI_EVENT UserBreakTimer
; ///< Timer event for polling for CTRL-C.
109 EFI_DEVICE_PATH_PROTOCOL
*ImageDevPath
; ///< DevicePath for ourselves.
110 EFI_DEVICE_PATH_PROTOCOL
*FileDevPath
; ///< DevicePath for ourselves.
111 CONSOLE_LOGGER_PRIVATE_DATA
*ConsoleInfo
; ///< Pointer for ConsoleInformation.
112 EFI_SHELL_PARAMETERS_PROTOCOL
*OldShellParameters
; ///< old shell parameters to reinstall upon exiting.
113 SHELL_PROTOCOL_HANDLE_LIST OldShellList
; ///< List of other instances to reinstall when closing.
114 SPLIT_LIST SplitList
; ///< List of Splits in FILO stack.
115 VOID
*CtrlCNotifyHandle1
; ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
116 VOID
*CtrlCNotifyHandle2
; ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
117 VOID
*CtrlCNotifyHandle3
; ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
118 VOID
*CtrlCNotifyHandle4
; ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
119 VOID
*CtrlSNotifyHandle1
; ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
120 VOID
*CtrlSNotifyHandle2
; ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
121 VOID
*CtrlSNotifyHandle3
; ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
122 VOID
*CtrlSNotifyHandle4
; ///< The NotifyHandle returned from SimpleTextInputEx.RegisterKeyNotify.
123 BOOLEAN HaltOutput
; ///< TRUE to start a CTRL-S halt.
126 extern SHELL_INFO ShellInfoObject
;
134 } SHELL_OPERATION_TYPES
;
137 Converts the command line to it's post-processed form. this replaces variables and alias' per UEFI Shell spec.
139 @param[in,out] CmdLine pointer to the command line to update
141 @retval EFI_SUCCESS The operation was successful
142 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
143 @return some other error occured
147 ProcessCommandLineToFinal(
148 IN OUT CHAR16
**CmdLine
152 Function to update the shell variable "lasterror".
154 @param[in] ErrorCode the error code to put into lasterror
159 IN CONST SHELL_STATUS ErrorCode
163 Sets all the alias' that were registered with the ShellCommandLib library.
165 @retval EFI_SUCCESS all init commands were run sucessfully.
174 This function will populate the 2 device path protocol parameters based on the
175 global gImageHandle. the DevPath will point to the device path for the handle that has
176 loaded image protocol installed on it. the FilePath will point to the device path
177 for the file that was loaded.
179 @param[in, out] DevPath on a sucessful return the device path to the loaded image
180 @param[in, out] FilePath on a sucessful return the device path to the file
182 @retval EFI_SUCCESS the 2 device paths were sucessfully returned.
183 @return other a error from gBS->HandleProtocol
189 GetDevicePathsForImageAndFile (
190 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevPath
,
191 IN OUT EFI_DEVICE_PATH_PROTOCOL
**FilePath
195 Process all Uefi Shell 2.0 command line options.
197 see Uefi Shell 2.0 section 3.2 for full details.
199 the command line should resemble the following:
201 shell.efi [ShellOpt-options] [options] [file-name [file-name-options]]
203 ShellOpt options Options which control the initialization behavior of the shell.
204 These options are read from the EFI global variable "ShellOpt"
205 and are processed before options or file-name.
207 options Options which control the initialization behavior of the shell.
209 file-name The name of a UEFI shell application or script to be executed
210 after initialization is complete. By default, if file-name is
211 specified, then -nostartup is implied. Scripts are not supported
214 file-nameoptions The command-line options that are passed to file-name when it
217 This will initialize the ShellInitSettings global variable.
219 @retval EFI_SUCCESS the variable is initialized.
228 Handles all interaction with the default startup script.
230 this will check that the correct command line parameters were passed, handle the delay, and then start running the script.
232 @param[in] ImagePath The path to the image for shell. The first place to look for the startup script.
233 @param[in] FilePath The path to the file for shell. The second place to look for the startup script.
234 @param[out] ExitStatus The exit code of the script. Ignored if NULL.
235 Invalid when this function returns an error.
237 @retval EFI_SUCCESS The variable is initialized.
242 IN EFI_DEVICE_PATH_PROTOCOL
*ImagePath
,
243 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
,
244 OUT SHELL_STATUS
*ExitStatus
248 Function to perform the shell prompt looping. It will do a single prompt,
249 dispatch the result, and then return. It is expected that the caller will
250 call this function in a loop many times.
253 @retval RETURN_ABORTED
262 Add a buffer to the Buffer To Free List for safely returning buffers to other
263 places without risking letting them modify internal shell information.
265 @param Buffer Something to pass to FreePool when the shell is exiting.
274 Add a buffer to the Command History List.
276 @param Buffer[in] The line buffer to add.
280 AddLineToCommandHistory(
281 IN CONST CHAR16
*Buffer
285 Function will process and run a command line.
287 This will determine if the command line represents an internal shell command or dispatch an external application.
289 @param[in] CmdLine the command line to parse
290 @param[out] ExitStatus The exit status of the command. Ignored if NULL.
292 @retval EFI_SUCCESS the command was completed
293 @retval EFI_ABORTED the command's operation was aborted
298 IN CONST CHAR16
*CmdLine
,
299 OUT SHELL_STATUS
*ExitStatus
303 Function determins if the CommandName COULD be a valid command. It does not determine whether
304 this is a valid command. It only checks for invalid characters.
306 @param[in] CommandName The name to check
308 @retval TRUE CommandName could be a command name
309 @retval FALSE CommandName could not be a valid command name
314 IN CONST CHAR16
*CommandName
318 Function to process a NSH script file via SHELL_FILE_HANDLE.
320 @param[in] Handle The handle to the already opened file.
321 @param[in] Name The name of the script file.
323 @param[out] ExitStatus The exit code of the script. Ignored if NULL.
324 Invalid when this function returns an error.
326 @retval EFI_SUCCESS the script completed sucessfully
330 RunScriptFileHandle (
331 IN SHELL_FILE_HANDLE Handle
,
332 IN CONST CHAR16
*Name
,
333 OUT SHELL_STATUS
*ExitStatus
337 Function to process a NSH script file.
339 @param[in] ScriptPath Pointer to the script file name (including file system path).
340 @param[in] Handle the handle of the script file already opened.
341 @param[in] CmdLine the command line to run.
342 @param[in] ParamProtocol the shell parameters protocol pointer
344 @param[out] ExitStatus The exit code of the script. Ignored if NULL.
345 Invalid when this function returns an error.
347 @retval EFI_SUCCESS the script completed sucessfully
352 IN CONST CHAR16
*ScriptPath
,
353 IN SHELL_FILE_HANDLE Handle OPTIONAL
,
354 IN CONST CHAR16
*CmdLine
,
355 IN EFI_SHELL_PARAMETERS_PROTOCOL
*ParamProtocol
,
356 OUT SHELL_STATUS
*ExitStatus
359 #endif //_SHELL_INTERNAL_HEADER_