2 Main file for NULL named library for debug1 profile shell command functions.
4 Copyright (c) 2010 - 2017, 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 #include "UefiShellDebug1CommandsLib.h"
16 #include <Library/BcfgCommandLib.h>
18 STATIC CONST CHAR16 mFileName
[] = L
"Debug1Commands";
19 EFI_HANDLE gShellDebug1HiiHandle
= NULL
;
22 Gets the debug file name. This will be used if HII is not working.
24 @retval NULL No file is available.
25 @return The NULL-terminated filename to get help from.
29 ShellCommandGetManFileNameDebug1 (
37 Constructor for the Shell Debug1 Commands library.
39 @param ImageHandle the image handle of the process
40 @param SystemTable the EFI System Table pointer
42 @retval EFI_SUCCESS the shell command handlers were installed sucessfully
43 @retval EFI_UNSUPPORTED the shell level required was not found.
47 UefiShellDebug1CommandsLibConstructor (
48 IN EFI_HANDLE ImageHandle
,
49 IN EFI_SYSTEM_TABLE
*SystemTable
53 // check our bit of the profiles mask
55 if ((PcdGet8(PcdShellProfileMask
) & BIT1
) == 0) {
60 // install the HII stuff.
62 gShellDebug1HiiHandle
= HiiAddPackages (&gShellDebug1HiiGuid
, gImageHandle
, UefiShellDebug1CommandsLibStrings
, NULL
);
63 if (gShellDebug1HiiHandle
== NULL
) {
64 return (EFI_DEVICE_ERROR
);
68 // install our shell command handlers that are always installed
70 ShellCommandRegisterCommandName(L
"setsize", ShellCommandRunSetSize
, ShellCommandGetManFileNameDebug1
, 0, L
"Debug1", TRUE
, gShellDebug1HiiHandle
, STRING_TOKEN(STR_GET_HELP_SETSIZE
) );
71 ShellCommandRegisterCommandName(L
"comp", ShellCommandRunComp
, ShellCommandGetManFileNameDebug1
, 0, L
"Debug1", TRUE
, gShellDebug1HiiHandle
, STRING_TOKEN(STR_GET_HELP_COMP
) );
72 ShellCommandRegisterCommandName(L
"mode", ShellCommandRunMode
, ShellCommandGetManFileNameDebug1
, 0, L
"Debug1", TRUE
, gShellDebug1HiiHandle
, STRING_TOKEN(STR_GET_HELP_MODE
) );
73 ShellCommandRegisterCommandName(L
"memmap", ShellCommandRunMemMap
, ShellCommandGetManFileNameDebug1
, 0, L
"Debug1", TRUE
, gShellDebug1HiiHandle
, STRING_TOKEN(STR_GET_HELP_MEMMAP
) );
74 ShellCommandRegisterCommandName(L
"eficompress", ShellCommandRunEfiCompress
, ShellCommandGetManFileNameDebug1
, 0, L
"Debug1", TRUE
, gShellDebug1HiiHandle
, STRING_TOKEN(STR_GET_HELP_EFICOMPRESS
) );
75 ShellCommandRegisterCommandName(L
"efidecompress", ShellCommandRunEfiDecompress
, ShellCommandGetManFileNameDebug1
, 0, L
"Debug1", TRUE
, gShellDebug1HiiHandle
, STRING_TOKEN(STR_GET_HELP_EFIDCOMPRESS
) );
76 ShellCommandRegisterCommandName(L
"dmem", ShellCommandRunDmem
, ShellCommandGetManFileNameDebug1
, 0, L
"Debug1", TRUE
, gShellDebug1HiiHandle
, STRING_TOKEN(STR_GET_HELP_DMEM
) );
77 ShellCommandRegisterCommandName(L
"loadpcirom", ShellCommandRunLoadPciRom
, ShellCommandGetManFileNameDebug1
, 0, L
"Debug1", TRUE
, gShellDebug1HiiHandle
, STRING_TOKEN(STR_GET_HELP_LOAD_PCI_ROM
) );
78 ShellCommandRegisterCommandName(L
"mm", ShellCommandRunMm
, ShellCommandGetManFileNameDebug1
, 0, L
"Debug1", TRUE
, gShellDebug1HiiHandle
, STRING_TOKEN(STR_GET_HELP_MM
) );
79 ShellCommandRegisterCommandName(L
"setvar", ShellCommandRunSetVar
, ShellCommandGetManFileNameDebug1
, 0, L
"Debug1", TRUE
, gShellDebug1HiiHandle
, STRING_TOKEN(STR_GET_HELP_SETVAR
) );
80 ShellCommandRegisterCommandName(L
"sermode", ShellCommandRunSerMode
, ShellCommandGetManFileNameDebug1
, 0, L
"Debug1", TRUE
, gShellDebug1HiiHandle
, STRING_TOKEN(STR_GET_HELP_SERMODE
) );
81 ShellCommandRegisterCommandName(L
"pci", ShellCommandRunPci
, ShellCommandGetManFileNameDebug1
, 0, L
"Debug1", TRUE
, gShellDebug1HiiHandle
, STRING_TOKEN(STR_GET_HELP_PCI
) );
82 ShellCommandRegisterCommandName(L
"smbiosview", ShellCommandRunSmbiosView
, ShellCommandGetManFileNameDebug1
, 0, L
"Debug1", TRUE
, gShellDebug1HiiHandle
, STRING_TOKEN(STR_GET_HELP_SMBIOSVIEW
) );
83 ShellCommandRegisterCommandName(L
"dmpstore", ShellCommandRunDmpStore
, ShellCommandGetManFileNameDebug1
, 0, L
"Debug1", TRUE
, gShellDebug1HiiHandle
, STRING_TOKEN(STR_GET_HELP_DMPSTORE
) );
84 ShellCommandRegisterCommandName(L
"dblk", ShellCommandRunDblk
, ShellCommandGetManFileNameDebug1
, 0, L
"Debug1", TRUE
, gShellDebug1HiiHandle
, STRING_TOKEN(STR_GET_HELP_DBLK
) );
85 ShellCommandRegisterCommandName(L
"edit", ShellCommandRunEdit
, ShellCommandGetManFileNameDebug1
, 0, L
"Debug1", TRUE
, gShellDebug1HiiHandle
, STRING_TOKEN(STR_GET_HELP_EDIT
) );
86 ShellCommandRegisterCommandName(L
"hexedit", ShellCommandRunHexEdit
, ShellCommandGetManFileNameDebug1
, 0, L
"Debug1", TRUE
, gShellDebug1HiiHandle
, STRING_TOKEN(STR_GET_HELP_HEXEDIT
) );
88 ShellCommandRegisterAlias(L
"dmem", L
"mem");
90 BcfgLibraryRegisterBcfgCommand(ImageHandle
, SystemTable
, L
"Debug1");
96 Destructor for the library. free any resources.
98 @param ImageHandle The image handle of the process.
99 @param SystemTable The EFI System Table pointer.
103 UefiShellDebug1CommandsLibDestructor (
104 IN EFI_HANDLE ImageHandle
,
105 IN EFI_SYSTEM_TABLE
*SystemTable
108 if (gShellDebug1HiiHandle
!= NULL
) {
109 HiiRemovePackages(gShellDebug1HiiHandle
);
112 BcfgLibraryUnregisterBcfgCommand(ImageHandle
, SystemTable
);
113 return (EFI_SUCCESS
);
117 Convert a Unicode character to upper case only if
118 it maps to a valid small-case ASCII character.
120 This internal function only deal with Unicode character
121 which maps to a valid small-case ASCII character, i.e.
122 L'a' to L'z'. For other Unicode character, the input character
123 is returned directly.
125 @param Char The character to convert.
127 @retval LowerCharacter If the Char is with range L'a' to L'z'.
128 @retval Unchanged Otherwise.
131 //Stolen from MdePkg Baselib
138 if (Char
>= L
'a' && Char
<= L
'z') {
139 return (CHAR16
) (Char
- (L
'a' - L
'A'));
146 Function returns a system configuration table that is stored in the
147 EFI System Table based on the provided GUID.
149 @param[in] TableGuid A pointer to the table's GUID type.
150 @param[in, out] Table On exit, a pointer to a system configuration table.
152 @retval EFI_SUCCESS A configuration table matching TableGuid was found.
153 @retval EFI_NOT_FOUND A configuration table matching TableGuid was not found.
156 GetSystemConfigurationTable (
157 IN EFI_GUID
*TableGuid
,
162 ASSERT (Table
!= NULL
);
164 for (Index
= 0; Index
< gST
->NumberOfTableEntries
; Index
++) {
165 if (CompareGuid (TableGuid
, &(gST
->ConfigurationTable
[Index
].VendorGuid
))) {
166 *Table
= gST
->ConfigurationTable
[Index
].VendorTable
;
171 return EFI_NOT_FOUND
;
175 Clear the line at the specified Row.
177 @param[in] Row The row number to be cleared ( start from 1 )
178 @param[in] LastCol The last printable column.
179 @param[in] LastRow The last printable row.
195 // prepare a blank line
197 SetMem16(Line
, LastCol
*sizeof(CHAR16
), L
' ');
199 if (Row
== LastRow
) {
201 // if CHAR_NULL is still at position 80, it will cause first line error
203 Line
[LastCol
- 1] = CHAR_NULL
;
205 Line
[LastCol
] = CHAR_NULL
;
209 // print out the blank line
211 ShellPrintEx (0, ((INT32
)Row
) - 1, Line
);
215 Determine if the character is valid for a filename.
217 @param[in] Ch The character to test.
219 @retval TRUE The character is valid.
220 @retval FALSE The character is not valid.
223 IsValidFileNameChar (
228 // See if there are any illegal characters within the name
230 if (Ch
< 0x20 || Ch
== L
'\"' || Ch
== L
'*' || Ch
== L
'/' || Ch
== L
'<' || Ch
== L
'>' || Ch
== L
'?' || Ch
== L
'|') {
238 Check if file name has illegal characters.
240 @param Name The filename to check.
242 @retval TRUE The filename is ok.
243 @retval FALSE The filename is not ok.
247 IN CONST CHAR16
*Name
255 // check the length of Name
257 for (Len
= 0, Index
= StrLen (Name
) - 1; Index
+ 1 != 0; Index
--, Len
++) {
258 if (Name
[Index
] == '\\' || Name
[Index
] == ':') {
263 if (Len
== 0 || Len
> 255) {
267 // check whether any char in Name not appears in valid file name char
269 for (Index
= 0; Index
< StrLen (Name
); Index
++) {
270 if (!IsValidFileNameChar (Name
[Index
])) {
279 Find a filename that is valid (not taken) with the given extension.
281 @param[in] Extension The file extension.
283 @retval NULL Something went wrong.
284 @return the valid filename.
287 EditGetDefaultFileName (
288 IN CONST CHAR16
*Extension
298 FileNameTmp
= CatSPrint (NULL
, L
"NewFile%d.%s", Suffix
, Extension
);
301 // after that filename changed to path
303 Status
= ShellFileExists (FileNameTmp
);
305 if (Status
== EFI_NOT_FOUND
) {
309 FreePool (FileNameTmp
);
312 } while (Suffix
!= 0);
314 FreePool (FileNameTmp
);
319 Read a file into an allocated buffer. The buffer is the responsibility
320 of the caller to free.
322 @param[in] FileName The filename of the file to open.
323 @param[out] Buffer Upon successful return, the pointer to the
324 address of the allocated buffer.
325 @param[out] BufferSize If not NULL, then the pointer to the size
326 of the allocated buffer.
327 @param[out] ReadOnly Upon successful return TRUE if the file is
328 read only. FALSE otherwise.
330 @retval EFI_NOT_FOUND The filename did not represent a file in the
332 @retval EFI_SUCCESS The file was read into the buffer.
333 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
334 @retval EFI_LOAD_ERROR The file read operation failed.
335 @retval EFI_INVALID_PARAMETER A parameter was invalid.
336 @retval EFI_INVALID_PARAMETER FileName was NULL.
337 @retval EFI_INVALID_PARAMETER FileName was a directory.
341 IN CONST CHAR16
*FileName
,
343 OUT UINTN
*BufferSize OPTIONAL
,
344 OUT BOOLEAN
*ReadOnly
347 VOID
*InternalBuffer
;
349 SHELL_FILE_HANDLE FileHandle
;
354 InternalBuffer
= NULL
;
358 Status
= EFI_SUCCESS
;
361 if (FileName
== NULL
|| Buffer
== NULL
|| ReadOnly
== NULL
) {
362 return (EFI_INVALID_PARAMETER
);
366 // try to open the file
368 Status
= ShellOpenFileByName (FileName
, &FileHandle
, EFI_FILE_MODE_READ
, 0);
370 if (!EFI_ERROR(Status
)) {
371 ASSERT(CreateFile
== FALSE
);
372 if (FileHandle
== NULL
) {
373 return EFI_LOAD_ERROR
;
376 Info
= ShellGetFileInfo(FileHandle
);
378 if (Info
->Attribute
& EFI_FILE_DIRECTORY
) {
380 return EFI_INVALID_PARAMETER
;
383 if (Info
->Attribute
& EFI_FILE_READ_ONLY
) {
391 FileSize
= (UINTN
) Info
->FileSize
;
394 } else if (Status
== EFI_NOT_FOUND
) {
396 // file not exists. add create and try again
398 Status
= ShellOpenFileByName (FileName
, &FileHandle
, EFI_FILE_MODE_READ
|EFI_FILE_MODE_WRITE
|EFI_FILE_MODE_CREATE
, 0);
399 if (EFI_ERROR (Status
)) {
403 // it worked. now delete it and move on with the name (now validated)
405 Status
= ShellDeleteFile (&FileHandle
);
406 if (Status
== EFI_WARN_DELETE_FAILURE
) {
407 Status
= EFI_ACCESS_DENIED
;
409 if (EFI_ERROR (Status
)) {
414 // file doesn't exist, so set CreateFile to TRUE and can't be read-only
425 // allocate buffer to read file
427 InternalBuffer
= AllocateZeroPool (FileSize
);
428 if (InternalBuffer
== NULL
) {
429 return EFI_OUT_OF_RESOURCES
;
432 // read file into InternalBuffer
434 Status
= ShellReadFile (FileHandle
, &FileSize
, InternalBuffer
);
435 ShellCloseFile(&FileHandle
);
437 if (EFI_ERROR (Status
)) {
438 SHELL_FREE_NON_NULL (InternalBuffer
);
439 return EFI_LOAD_ERROR
;
442 *Buffer
= InternalBuffer
;
443 if (BufferSize
!= NULL
) {
444 *BufferSize
= FileSize
;
446 return (EFI_SUCCESS
);