2 Main file for NULL named library for level 2 shell command functions.
5 attrib, cd, cp, date*, time*, rm, reset,
6 load, ls, map, mkdir, mv, parse, set, timezone*
9 * functions are non-interactive only
12 Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.<BR>
13 This program and the accompanying materials
14 are licensed and made available under the terms and conditions of the BSD License
15 which accompanies this distribution. The full text of the license may be found at
16 http://opensource.org/licenses/bsd-license.php
18 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
19 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
23 #ifndef _UEFI_SHELL_LEVEL2_COMMANDS_LIB_H_
24 #define _UEFI_SHELL_LEVEL2_COMMANDS_LIB_H_
27 #include <ShellBase.h>
29 #include <Guid/ShellLibHiiGuid.h>
31 #include <Protocol/EfiShell.h>
32 #include <Protocol/EfiShellParameters.h>
33 #include <Protocol/DevicePath.h>
34 #include <Protocol/LoadedImage.h>
35 #include <Protocol/UnicodeCollation.h>
37 #include <Library/BaseLib.h>
38 #include <Library/BaseMemoryLib.h>
39 #include <Library/DebugLib.h>
40 #include <Library/MemoryAllocationLib.h>
41 #include <Library/PcdLib.h>
42 #include <Library/ShellCommandLib.h>
43 #include <Library/ShellLib.h>
44 #include <Library/UefiLib.h>
45 #include <Library/UefiRuntimeServicesTableLib.h>
46 #include <Library/UefiBootServicesTableLib.h>
47 #include <Library/HiiLib.h>
48 #include <Library/SortLib.h>
49 #include <Library/FileHandleLib.h>
51 extern CONST CHAR16 mFileName
[];
52 extern EFI_HANDLE gShellLevel2HiiHandle
;
55 Function for 'attrib' command.
57 @param[in] ImageHandle Handle to the Image (NULL if Internal).
58 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
62 ShellCommandRunAttrib (
63 IN EFI_HANDLE ImageHandle
,
64 IN EFI_SYSTEM_TABLE
*SystemTable
68 Function for 'date' command.
70 @param[in] ImageHandle Handle to the Image (NULL if Internal).
71 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
76 IN EFI_HANDLE ImageHandle
,
77 IN EFI_SYSTEM_TABLE
*SystemTable
81 Function for 'time' command.
83 @param[in] ImageHandle Handle to the Image (NULL if Internal).
84 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
89 IN EFI_HANDLE ImageHandle
,
90 IN EFI_SYSTEM_TABLE
*SystemTable
94 Function for 'load' command.
96 @param[in] ImageHandle Handle to the Image (NULL if Internal).
97 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
101 ShellCommandRunLoad (
102 IN EFI_HANDLE ImageHandle
,
103 IN EFI_SYSTEM_TABLE
*SystemTable
107 Function for 'ls' command.
109 @param[in] ImageHandle Handle to the Image (NULL if Internal).
110 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
115 IN EFI_HANDLE ImageHandle
,
116 IN EFI_SYSTEM_TABLE
*SystemTable
120 Function for 'map' command.
122 @param[in] ImageHandle Handle to the Image (NULL if Internal).
123 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
128 IN EFI_HANDLE ImageHandle
,
129 IN EFI_SYSTEM_TABLE
*SystemTable
133 Function for 'reset' command.
135 @param[in] ImageHandle Handle to the Image (NULL if Internal).
136 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
140 ShellCommandRunReset (
141 IN EFI_HANDLE ImageHandle
,
142 IN EFI_SYSTEM_TABLE
*SystemTable
146 Function for 'timezone' command.
148 @param[in] ImageHandle Handle to the Image (NULL if Internal).
149 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
153 ShellCommandRunTimeZone (
154 IN EFI_HANDLE ImageHandle
,
155 IN EFI_SYSTEM_TABLE
*SystemTable
159 Function for 'set' command.
161 @param[in] ImageHandle Handle to the Image (NULL if Internal).
162 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
167 IN EFI_HANDLE ImageHandle
,
168 IN EFI_SYSTEM_TABLE
*SystemTable
172 Function for 'mkdir' command.
174 @param[in] ImageHandle Handle to the Image (NULL if Internal).
175 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
179 ShellCommandRunMkDir (
180 IN EFI_HANDLE ImageHandle
,
181 IN EFI_SYSTEM_TABLE
*SystemTable
185 Function for 'cd' command.
187 @param[in] ImageHandle Handle to the Image (NULL if Internal).
188 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
193 IN EFI_HANDLE ImageHandle
,
194 IN EFI_SYSTEM_TABLE
*SystemTable
198 Function for 'cp' command.
200 @param[in] ImageHandle Handle to the Image (NULL if Internal).
201 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
206 IN EFI_HANDLE ImageHandle
,
207 IN EFI_SYSTEM_TABLE
*SystemTable
211 Function for 'parse' command.
213 @param[in] ImageHandle Handle to the Image (NULL if Internal).
214 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
218 ShellCommandRunParse (
219 IN EFI_HANDLE ImageHandle
,
220 IN EFI_SYSTEM_TABLE
*SystemTable
224 Function for 'rm' command.
226 @param[in] ImageHandle Handle to the Image (NULL if Internal).
227 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
232 IN EFI_HANDLE ImageHandle
,
233 IN EFI_SYSTEM_TABLE
*SystemTable
237 Function for 'mv' command.
239 @param[in] ImageHandle Handle to the Image (NULL if Internal).
240 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
245 IN EFI_HANDLE ImageHandle
,
246 IN EFI_SYSTEM_TABLE
*SystemTable
250 returns a fully qualified directory (contains a map drive at the begining)
251 path from a unknown directory path.
253 If Path is already fully qualified this will return a duplicat otherwise this
254 will use get the current directory and use that to build the fully qualified
257 if the return value is not NULL it must be caller freed.
259 @param[in] Path The unknown Path Value
261 @retval NULL A memory allocation failed
262 @retval NULL a fully qualified path could not be discovered.
263 @retval other pointer to a fuly qualified path.
267 GetFullyQualifiedPath(
268 IN CONST CHAR16
* Path
272 Function to verify all intermediate directories in the path.
274 @param[in] Path The pointer to the path to fix.
276 @retval EFI_SUCCESS The operation was successful.
280 VerifyIntermediateDirectories (
281 IN CONST CHAR16
*Path
285 CaseInsensitive length limited string comparison.
287 @param[in] Source Pointer to first string.
288 @param[in] Target Pointer to second string.
289 @param[in] Count Number of characters to compare.
291 @retval 0 The strings are the same.
292 @return non-zero if the strings are different.
297 IN CONST CHAR16
*Source
,
298 IN CONST CHAR16
*Target
,
303 Cleans off all the quotes in the string.
305 @param[in] OriginalString pointer to the string to be cleaned.
306 @param[out] CleanString The new string with all quotes removed.
307 Memory allocated in the function and free
310 @retval EFI_SUCCESS The operation was successful.
314 ShellLevel2StripQuotes (
315 IN CONST CHAR16
*OriginalString
,
316 OUT CHAR16
**CleanString
320 Function for 'Vol' command.
322 @param[in] ImageHandle Handle to the Image (NULL if Internal).
323 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
328 IN EFI_HANDLE ImageHandle
,
329 IN EFI_SYSTEM_TABLE
*SystemTable
333 Function to Copy one file to another location
335 If the destination exists the user will be prompted and the result put into *resp
337 @param[in] Source pointer to source file name
338 @param[in] Dest pointer to destination file name
339 @param[out] Resp pointer to response from question. Pass back on looped calling
340 @param[in] SilentMode whether to run in quiet mode or not
342 @retval SHELL_SUCCESS The source file was copied to the destination
347 IN CONST CHAR16
*Source
,
348 IN CONST CHAR16
*Dest
,
350 IN BOOLEAN SilentMode
354 Delete a node and all nodes under it (including sub directories).
356 @param[in] Node The node to start deleting with.
357 @param[in] Quiet TRUE to print no messages.
359 @retval SHELL_SUCCESS The operation was successful.
360 @retval SHELL_ACCESS_DENIED A file was read only.
361 @retval SHELL_ABORTED The abort message was received.
362 @retval SHELL_DEVICE_ERROR A device error occured reading this Node.
367 IN EFI_SHELL_FILE_INFO
*Node
,
368 IN CONST BOOLEAN Quiet