2 Main file for NULL named library for debug1 profile shell command functions.
4 Copyright (c) 2010 - 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
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
139 if (Char
>= L
'a' && Char
<= L
'z') {
140 return (CHAR16
) (Char
- (L
'a' - L
'A'));
147 Function returns a system configuration table that is stored in the
148 EFI System Table based on the provided GUID.
150 @param[in] TableGuid A pointer to the table's GUID type.
151 @param[in, out] Table On exit, a pointer to a system configuration table.
153 @retval EFI_SUCCESS A configuration table matching TableGuid was found.
154 @retval EFI_NOT_FOUND A configuration table matching TableGuid was not found.
158 GetSystemConfigurationTable (
159 IN EFI_GUID
*TableGuid
,
164 ASSERT (Table
!= NULL
);
166 for (Index
= 0; Index
< gST
->NumberOfTableEntries
; Index
++) {
167 if (CompareGuid (TableGuid
, &(gST
->ConfigurationTable
[Index
].VendorGuid
))) {
168 *Table
= gST
->ConfigurationTable
[Index
].VendorTable
;
173 return EFI_NOT_FOUND
;
177 Convert a Unicode character to numerical value.
179 This internal function only deal with Unicode character
180 which maps to a valid hexadecimal ASII character, i.e.
181 L'0' to L'9', L'a' to L'f' or L'A' to L'F'. For other
182 Unicode character, the value returned does not make sense.
184 @param Char The character to convert.
186 @return The numerical value converted.
195 if (Char
>= L
'0' && Char
<= L
'9') {
199 return (UINTN
) (10 + CharToUpper (Char
) - L
'A');
203 Convert a string representation of a guid to a Guid value.
205 @param[in] StringGuid The pointer to the string of a guid.
206 @param[in, out] Guid The pointer to the GUID structure to populate.
208 @retval EFI_INVALID_PARAMETER A parameter was invalid.
209 @retval EFI_SUCCESS The conversion was successful.
213 ConvertStringToGuid (
214 IN CONST CHAR16
*StringGuid
,
215 IN OUT EFI_GUID
*Guid
224 if (StringGuid
== NULL
) {
225 return (EFI_INVALID_PARAMETER
);
226 } else if (StrLen(StringGuid
) != 36) {
227 return (EFI_INVALID_PARAMETER
);
230 TempCopy
= StrnCatGrow(&TempCopy
, NULL
, StringGuid
, 0);
231 if (TempCopy
== NULL
) {
232 return (EFI_OUT_OF_RESOURCES
);
235 TempSpot
= StrStr(Walker
, L
"-");
236 if (TempSpot
!= NULL
) {
237 *TempSpot
= CHAR_NULL
;
239 Status
= ShellConvertStringToUint64(Walker
, &TempVal
, TRUE
, FALSE
);
240 if (EFI_ERROR(Status
)) {
244 Guid
->Data1
= (UINT32
)TempVal
;
246 TempSpot
= StrStr(Walker
, L
"-");
247 if (TempSpot
!= NULL
) {
248 *TempSpot
= CHAR_NULL
;
250 Status
= ShellConvertStringToUint64(Walker
, &TempVal
, TRUE
, FALSE
);
251 if (EFI_ERROR(Status
)) {
255 Guid
->Data2
= (UINT16
)TempVal
;
257 TempSpot
= StrStr(Walker
, L
"-");
258 if (TempSpot
!= NULL
) {
259 *TempSpot
= CHAR_NULL
;
261 Status
= ShellConvertStringToUint64(Walker
, &TempVal
, TRUE
, FALSE
);
262 if (EFI_ERROR(Status
)) {
266 Guid
->Data3
= (UINT16
)TempVal
;
268 Guid
->Data4
[0] = (UINT8
)(HexCharToUintn(Walker
[0]) * 16);
269 Guid
->Data4
[0] = (UINT8
)(Guid
->Data4
[0]+ (UINT8
)HexCharToUintn(Walker
[1]));
271 Guid
->Data4
[1] = (UINT8
)(HexCharToUintn(Walker
[0]) * 16);
272 Guid
->Data4
[1] = (UINT8
)(Guid
->Data4
[1] + (UINT8
)HexCharToUintn(Walker
[1]));
274 Guid
->Data4
[2] = (UINT8
)(HexCharToUintn(Walker
[0]) * 16);
275 Guid
->Data4
[2] = (UINT8
)(Guid
->Data4
[2] + (UINT8
)HexCharToUintn(Walker
[1]));
277 Guid
->Data4
[3] = (UINT8
)(HexCharToUintn(Walker
[0]) * 16);
278 Guid
->Data4
[3] = (UINT8
)(Guid
->Data4
[3] + (UINT8
)HexCharToUintn(Walker
[1]));
280 Guid
->Data4
[4] = (UINT8
)(HexCharToUintn(Walker
[0]) * 16);
281 Guid
->Data4
[4] = (UINT8
)(Guid
->Data4
[4] + (UINT8
)HexCharToUintn(Walker
[1]));
283 Guid
->Data4
[5] = (UINT8
)(HexCharToUintn(Walker
[0]) * 16);
284 Guid
->Data4
[5] = (UINT8
)(Guid
->Data4
[5] + (UINT8
)HexCharToUintn(Walker
[1]));
286 Guid
->Data4
[6] = (UINT8
)(HexCharToUintn(Walker
[0]) * 16);
287 Guid
->Data4
[6] = (UINT8
)(Guid
->Data4
[6] + (UINT8
)HexCharToUintn(Walker
[1]));
289 Guid
->Data4
[7] = (UINT8
)(HexCharToUintn(Walker
[0]) * 16);
290 Guid
->Data4
[7] = (UINT8
)(Guid
->Data4
[7] + (UINT8
)HexCharToUintn(Walker
[1]));
292 return (EFI_SUCCESS
);
296 Clear the line at the specified Row.
298 @param[in] Row The row number to be cleared ( start from 1 )
299 @param[in] LastCol The last printable column.
300 @param[in] LastRow The last printable row.
317 // prepare a blank line
319 SetMem16(Line
, LastCol
*sizeof(CHAR16
), L
' ');
321 if (Row
== LastRow
) {
323 // if CHAR_NULL is still at position 80, it will cause first line error
325 Line
[LastCol
- 1] = CHAR_NULL
;
327 Line
[LastCol
] = CHAR_NULL
;
331 // print out the blank line
333 ShellPrintEx (0, ((INT32
)Row
) - 1, Line
);
337 Determine if the character is valid for a filename.
339 @param[in] Ch The character to test.
341 @retval TRUE The character is valid.
342 @retval FALSE The character is not valid.
346 IsValidFileNameChar (
351 // See if there are any illegal characters within the name
353 if (Ch
< 0x20 || Ch
== L
'\"' || Ch
== L
'*' || Ch
== L
'/' || Ch
== L
'<' || Ch
== L
'>' || Ch
== L
'?' || Ch
== L
'|') {
361 Check if file name has illegal characters.
363 @param Name The filename to check.
365 @retval TRUE The filename is ok.
366 @retval FALSE The filename is not ok.
371 IN CONST CHAR16
*Name
379 // check the length of Name
381 for (Len
= 0, Index
= StrLen (Name
) - 1; Index
+ 1 != 0; Index
--, Len
++) {
382 if (Name
[Index
] == '\\' || Name
[Index
] == ':') {
387 if (Len
== 0 || Len
> 255) {
391 // check whether any char in Name not appears in valid file name char
393 for (Index
= 0; Index
< StrLen (Name
); Index
++) {
394 if (!IsValidFileNameChar (Name
[Index
])) {
403 Find a filename that is valid (not taken) with the given extension.
405 @param[in] Extension The file extension.
407 @retval NULL Something went wrong.
408 @return the valid filename.
412 EditGetDefaultFileName (
413 IN CONST CHAR16
*Extension
423 FileNameTmp
= CatSPrint (NULL
, L
"NewFile%d.%s", Suffix
, Extension
);
426 // after that filename changed to path
428 Status
= ShellFileExists (FileNameTmp
);
430 if (Status
== EFI_NOT_FOUND
) {
434 FreePool (FileNameTmp
);
437 } while (Suffix
!= 0);
439 FreePool (FileNameTmp
);
444 Read a file into an allocated buffer. The buffer is the responsibility
445 of the caller to free.
447 @param[in] FileName The filename of the file to open.
448 @param[out] Buffer Upon successful return, the pointer to the
449 address of the allocated buffer.
450 @param[out] BufferSize If not NULL, then the pointer to the size
451 of the allocated buffer.
452 @param[out] ReadOnly Upon successful return TRUE if the file is
453 read only. FALSE otherwise.
455 @retval EFI_NOT_FOUND The filename did not represent a file in the
457 @retval EFI_SUCCESS The file was read into the buffer.
458 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
459 @retval EFI_LOAD_ERROR The file read operation failed.
460 @retval EFI_INVALID_PARAMETER A parameter was invalid.
461 @retval EFI_INVALID_PARAMETER FileName was NULL.
462 @retval EFI_INVALID_PARAMETER FileName was a directory.
467 IN CONST CHAR16
*FileName
,
469 OUT UINTN
*BufferSize OPTIONAL
,
470 OUT BOOLEAN
*ReadOnly
473 VOID
*InternalBuffer
;
475 SHELL_FILE_HANDLE FileHandle
;
480 InternalBuffer
= NULL
;
484 Status
= EFI_SUCCESS
;
487 if (FileName
== NULL
|| Buffer
== NULL
|| ReadOnly
== NULL
) {
488 return (EFI_INVALID_PARAMETER
);
492 // try to open the file
494 Status
= ShellOpenFileByName (FileName
, &FileHandle
, EFI_FILE_MODE_READ
, 0);
496 if (!EFI_ERROR(Status
)) {
497 ASSERT(CreateFile
== FALSE
);
498 if (FileHandle
== NULL
) {
499 return EFI_LOAD_ERROR
;
502 Info
= ShellGetFileInfo(FileHandle
);
504 if (Info
->Attribute
& EFI_FILE_DIRECTORY
) {
506 return EFI_INVALID_PARAMETER
;
509 if (Info
->Attribute
& EFI_FILE_READ_ONLY
) {
517 FileSize
= (UINTN
) Info
->FileSize
;
520 } else if (Status
== EFI_NOT_FOUND
) {
522 // file not exists. add create and try again
524 Status
= ShellOpenFileByName (FileName
, &FileHandle
, EFI_FILE_MODE_READ
|EFI_FILE_MODE_WRITE
|EFI_FILE_MODE_CREATE
, 0);
525 if (EFI_ERROR (Status
)) {
529 // it worked. now delete it and move on with the name (now validated)
531 Status
= ShellDeleteFile (&FileHandle
);
532 if (Status
== EFI_WARN_DELETE_FAILURE
) {
533 Status
= EFI_ACCESS_DENIED
;
535 if (EFI_ERROR (Status
)) {
540 // file doesn't exist, so set CreateFile to TRUE and can't be read-only
551 // allocate buffer to read file
553 InternalBuffer
= AllocateZeroPool (FileSize
);
554 if (InternalBuffer
== NULL
) {
555 return EFI_OUT_OF_RESOURCES
;
558 // read file into InternalBuffer
560 Status
= ShellReadFile (FileHandle
, &FileSize
, InternalBuffer
);
561 ShellCloseFile(&FileHandle
);
563 if (EFI_ERROR (Status
)) {
564 SHELL_FREE_NON_NULL (InternalBuffer
);
565 return EFI_LOAD_ERROR
;
568 *Buffer
= InternalBuffer
;
569 if (BufferSize
!= NULL
) {
570 *BufferSize
= FileSize
;
572 return (EFI_SUCCESS
);