2 Main file for NULL named library for Profile1 shell command functions.
4 Copyright (c) 2010 - 2015, 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
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.
15 #ifndef _UEFI_SHELL_DEBUG1_COMMANDS_LIB_H_
16 #define _UEFI_SHELL_DEBUG1_COMMANDS_LIB_H_
19 #include <ShellBase.h>
21 #include <Guid/GlobalVariable.h>
22 #include <Guid/ConsoleInDevice.h>
23 #include <Guid/ConsoleOutDevice.h>
24 #include <Guid/FileSystemInfo.h>
25 #include <Guid/ShellLibHiiGuid.h>
27 #include <Protocol/EfiShell.h>
28 #include <Protocol/EfiShellParameters.h>
29 #include <Protocol/DevicePath.h>
30 #include <Protocol/LoadedImage.h>
31 #include <Protocol/UnicodeCollation.h>
32 #include <Protocol/DriverDiagnostics2.h>
33 #include <Protocol/DriverDiagnostics.h>
34 #include <Protocol/PlatformDriverOverride.h>
35 #include <Protocol/BusSpecificDriverOverride.h>
36 #include <Protocol/PlatformToDriverConfiguration.h>
37 #include <Protocol/DriverSupportedEfiVersion.h>
38 #include <Protocol/DriverFamilyOverride.h>
39 #include <Protocol/DriverHealth.h>
40 #include <Protocol/SimplePointer.h>
41 #include <Protocol/CpuIo2.h>
42 #include <Protocol/PciRootBridgeIo.h>
44 #include <Library/BaseLib.h>
45 #include <Library/BaseMemoryLib.h>
46 #include <Library/DebugLib.h>
47 #include <Library/MemoryAllocationLib.h>
48 #include <Library/PcdLib.h>
49 #include <Library/ShellCommandLib.h>
50 #include <Library/ShellLib.h>
51 #include <Library/SortLib.h>
52 #include <Library/UefiLib.h>
53 #include <Library/UefiRuntimeServicesTableLib.h>
54 #include <Library/UefiBootServicesTableLib.h>
55 #include <Library/HiiLib.h>
56 #include <Library/FileHandleLib.h>
57 #include <Library/DevicePathLib.h>
58 #include <Library/PrintLib.h>
59 #include <Library/HandleParsingLib.h>
62 extern EFI_HANDLE gShellDebug1HiiHandle
;
65 Function printing hex output to the console.
67 @param[in] Indent Number of spaces to indent.
68 @param[in] Offset Offset to start with.
69 @param[in] DataSize Length of data.
70 @param[in] UserData Pointer to some data.
81 Function returns a system configuration table that is stored in the
82 EFI System Table based on the provided GUID.
84 @param[in] TableGuid A pointer to the table's GUID type.
85 @param[in, out] Table On exit, a pointer to a system configuration table.
87 @retval EFI_SUCCESS A configuration table matching TableGuid was found.
88 @retval EFI_NOT_FOUND A configuration table matching TableGuid was not found.
92 GetSystemConfigurationTable (
93 IN EFI_GUID
*TableGuid
,
98 Convert a string representation of a GUID to the GUID value.
100 @param[in] StringGuid The pointer to the string containing a GUID printed.
101 @param[in, out] Guid The pointer to the buffer to get the GUID value.
105 ConvertStringToGuid (
106 IN CONST CHAR16
*StringGuid
,
107 IN OUT EFI_GUID
*Guid
111 Convert a Unicode character to numerical value.
113 This internal function only deal with Unicode character
114 which maps to a valid hexadecimal ASII character, i.e.
115 L'0' to L'9', L'a' to L'f' or L'A' to L'F'. For other
116 Unicode character, the value returned does not make sense.
118 @param Char The character to convert.
120 @return The numerical value converted.
130 Function for 'setsize' command.
132 @param[in] ImageHandle Handle to the Image (NULL if Internal).
133 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
137 ShellCommandRunSetSize (
138 IN EFI_HANDLE ImageHandle
,
139 IN EFI_SYSTEM_TABLE
*SystemTable
143 Function for 'comp' command.
145 @param[in] ImageHandle Handle to the Image (NULL if Internal).
146 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
150 ShellCommandRunComp (
151 IN EFI_HANDLE ImageHandle
,
152 IN EFI_SYSTEM_TABLE
*SystemTable
156 Function for 'mode' command.
158 @param[in] ImageHandle Handle to the Image (NULL if Internal).
159 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
163 ShellCommandRunMode (
164 IN EFI_HANDLE ImageHandle
,
165 IN EFI_SYSTEM_TABLE
*SystemTable
169 Function for 'memmap' command.
171 @param[in] ImageHandle Handle to the Image (NULL if Internal).
172 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
176 ShellCommandRunMemMap (
177 IN EFI_HANDLE ImageHandle
,
178 IN EFI_SYSTEM_TABLE
*SystemTable
182 Function for 'compress' command.
184 @param[in] ImageHandle Handle to the Image (NULL if Internal).
185 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
189 ShellCommandRunEfiCompress (
190 IN EFI_HANDLE ImageHandle
,
191 IN EFI_SYSTEM_TABLE
*SystemTable
195 Function for 'decompress' command.
197 @param[in] ImageHandle Handle to the Image (NULL if Internal).
198 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
202 ShellCommandRunEfiDecompress (
203 IN EFI_HANDLE ImageHandle
,
204 IN EFI_SYSTEM_TABLE
*SystemTable
208 Function for 'dmem' command.
210 @param[in] ImageHandle Handle to the Image (NULL if Internal).
211 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
215 ShellCommandRunDmem (
216 IN EFI_HANDLE ImageHandle
,
217 IN EFI_SYSTEM_TABLE
*SystemTable
221 Function for 'loadpcirom' command.
223 @param[in] ImageHandle Handle to the Image (NULL if Internal).
224 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
228 ShellCommandRunLoadPciRom (
229 IN EFI_HANDLE ImageHandle
,
230 IN EFI_SYSTEM_TABLE
*SystemTable
234 Function for 'mm' command.
236 @param[in] ImageHandle Handle to the Image (NULL if Internal).
237 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
242 IN EFI_HANDLE ImageHandle
,
243 IN EFI_SYSTEM_TABLE
*SystemTable
247 Function for 'setvar' command.
249 @param[in] ImageHandle Handle to the Image (NULL if Internal).
250 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
254 ShellCommandRunSetVar (
255 IN EFI_HANDLE ImageHandle
,
256 IN EFI_SYSTEM_TABLE
*SystemTable
260 Function for 'sermode' command.
262 @param[in] ImageHandle Handle to the Image (NULL if Internal).
263 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
267 ShellCommandRunSerMode (
268 IN EFI_HANDLE ImageHandle
,
269 IN EFI_SYSTEM_TABLE
*SystemTable
273 Function for 'bcfg' command.
275 @param[in] ImageHandle Handle to the Image (NULL if Internal).
276 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
280 ShellCommandRunBcfg (
281 IN EFI_HANDLE ImageHandle
,
282 IN EFI_SYSTEM_TABLE
*SystemTable
286 Function for 'pci' command.
288 @param[in] ImageHandle Handle to the Image (NULL if Internal).
289 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
294 IN EFI_HANDLE ImageHandle
,
295 IN EFI_SYSTEM_TABLE
*SystemTable
299 Function for 'smbiosview' command.
301 @param[in] ImageHandle Handle to the Image (NULL if Internal).
302 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
306 ShellCommandRunSmbiosView (
307 IN EFI_HANDLE ImageHandle
,
308 IN EFI_SYSTEM_TABLE
*SystemTable
312 Function for 'dmpstore' command.
314 @param[in] ImageHandle Handle to the Image (NULL if Internal).
315 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
319 ShellCommandRunDmpStore (
320 IN EFI_HANDLE ImageHandle
,
321 IN EFI_SYSTEM_TABLE
*SystemTable
325 Function for 'dblk' command.
327 @param[in] ImageHandle Handle to the Image (NULL if Internal).
328 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
332 ShellCommandRunDblk (
333 IN EFI_HANDLE ImageHandle
,
334 IN EFI_SYSTEM_TABLE
*SystemTable
338 Function for 'edit' command.
340 @param[in] ImageHandle Handle to the Image (NULL if Internal).
341 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
345 ShellCommandRunEdit (
346 IN EFI_HANDLE ImageHandle
,
347 IN EFI_SYSTEM_TABLE
*SystemTable
351 Function for 'hexedit' command.
353 @param[in] ImageHandle Handle to the Image (NULL if Internal).
354 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
358 ShellCommandRunHexEdit (
359 IN EFI_HANDLE ImageHandle
,
360 IN EFI_SYSTEM_TABLE
*SystemTable
364 Clear the line at the specified Row.
366 @param[in] Row The row number to be cleared ( start from 1 )
367 @param[in] LastCol The last printable column.
368 @param[in] LastRow The last printable row.
379 Check if file name has illegal characters.
381 @param Name The filename to check.
383 @retval TRUE The filename is ok.
384 @retval FALSE The filename is not ok.
389 IN CONST CHAR16
*Name
393 Find a filename that is valid (not taken) with the given extension.
395 @param[in] Extension The file extension.
397 @retval NULL Something went wrong.
398 @return the valid filename.
402 EditGetDefaultFileName (
403 IN CONST CHAR16
*Extension
407 Read a file into an allocated buffer. The buffer is the responsibility
408 of the caller to free.
410 @param[in] FileName The filename of the file to open.
411 @param[out] Buffer Upon successful return, the pointer to the
412 address of the allocated buffer.
413 @param[out] BufferSize If not NULL, then the pointer to the size
414 of the allocated buffer.
415 @param[out] ReadOnly Upon successful return TRUE if the file is
416 read only. FALSE otherwise.
418 @retval EFI_NOT_FOUND The filename did not represent a file in the
419 file system. Directories cannot be read with
421 @retval EFI_SUCCESS The file was read into the buffer.
422 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
423 @retval EFI_LOAD_ERROR The file read operation failed.
424 @retval EFI_INVALID_PARAMETER A parameter was invalid.
425 @retval EFI_INVALID_PARAMETER FileName was NULL.
426 @retval EFI_INVALID_PARAMETER FileName was a directory.
431 IN CONST CHAR16
*FileName
,
433 OUT UINTN
*BufferSize OPTIONAL
,
434 OUT BOOLEAN
*ReadOnly