2 Dir for EBL (Embedded Boot Loader)
4 Copyright (c) 2007, Intel Corporation. All rights reserved.<BR>
5 Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
6 (C) Copyright 2015 Hewlett Packard Enterprise Development LP<BR>
9 This program and the accompanying materials
10 are licensed and made available under the terms and conditions of the BSD License
11 which accompanies this distribution. The full text of the license may be found at
12 http://opensource.org/licenses/bsd-license.php
14 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
15 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 Module Name: CmdTemplate.c
19 Search/Replace Dir with the name of your new command
26 GLOBAL_REMOVE_IF_UNREFERENCED CHAR8
*gFvFileType
[] = {
43 Perform a dir on a device. The device must support Simple File System Protocol
47 Argv[1] - Device Name:path. Path is optional
48 Argv[2] - Optional filename to match on. A leading * means match substring
49 Argv[3] - Optional FV file type
51 dir fs1:\efi ; perform a dir on fs1: device in the efi directory
52 dir fs1:\efi *.efi; perform a dir on fs1: device in the efi directory but
53 only print out files that contain the string *.efi
54 dir fv1:\ ; perform a dir on fv1: device in the efi directory
55 NOTE: fv devices do not contain subdirs
56 dir fv1:\ * PEIM ; will match all files of type PEIM
58 @param Argc Number of command arguments in Argv
59 @param Argv Array of strings that represent the parsed command line.
60 Argv[0] is the command name
74 EFI_FILE_INFO
*DirInfo
;
77 CHAR16
*MatchSubString
;
78 EFI_STATUS GetNextFileStatus
;
80 EFI_FV_FILETYPE SearchType
;
82 EFI_FV_FILE_ATTRIBUTES Attributes
;
85 EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
;
86 UINT32 AuthenticationStatus
;
89 EFI_FV_FILETYPE Index
;
92 CHAR16 UnicodeFileName
[MAX_CMD_LINE
];
107 File
= EfiOpen (Path
, EFI_FILE_MODE_READ
, 0);
112 if (File
->Type
== EfiOpenFirmwareVolume
) {
115 SearchType
= EFI_FV_FILETYPE_ALL
;
116 UnicodeFileName
[0] = '\0';
117 MatchSubString
= &UnicodeFileName
[0];
119 AsciiStrToUnicodeStrS (Argv
[2], UnicodeFileName
,
120 ARRAY_SIZE (UnicodeFileName
));
121 if (UnicodeFileName
[0] == '*') {
122 // Handle *Name substring matching
123 MatchSubString
= &UnicodeFileName
[1];
126 // Handle file type matchs
128 // match a specific file type, always last argument
129 Length
= AsciiStrLen (Argv
[3]);
130 for (Index
= 1, BestMatchCount
= 0; Index
< sizeof (gFvFileType
)/sizeof (CHAR8
*); Index
++) {
131 if (AsciiStriCmp (gFvFileType
[Index
], Argv
[3]) == 0) {
137 if (AsciiStrniCmp (Argv
[3], gFvFileType
[Index
], Length
) == 0) {
138 // partial match, so keep looking to make sure there is only one partial match
144 if (BestMatchCount
> 1) {
145 SearchType
= EFI_FV_FILETYPE_ALL
;
156 GetNextFileStatus
= Fv
->GetNextFile (
164 if (!EFI_ERROR (GetNextFileStatus
)) {
166 // Calculate size of entire file
169 Status
= Fv
->ReadFile (
176 &AuthenticationStatus
178 if (!((Status
== EFI_BUFFER_TOO_SMALL
) || !EFI_ERROR (Status
))) {
179 // EFI_SUCCESS or EFI_BUFFER_TOO_SMALL mean size is valid
183 TypeStr
= (Type
<= EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE
) ? gFvFileType
[Type
] : "UNKNOWN";
185 // read the UI seciton to do a name match.
187 Status
= Fv
->ReadSection (
190 EFI_SECTION_USER_INTERFACE
,
194 &AuthenticationStatus
196 if (!EFI_ERROR (Status
)) {
197 if (StrStr (Section
, MatchSubString
) != NULL
) {
198 AsciiPrint ("%,9d %7a %g %s\n", Size
, TypeStr
, &NameGuid
, Section
);
199 if (EblAnyKeyToContinueQtoQuit (&CurrentRow
, FALSE
)) {
205 if (*MatchSubString
== '\0') {
206 AsciiPrint ("%,9d %7a %g\n", Size
, TypeStr
, &NameGuid
);
207 if (EblAnyKeyToContinueQtoQuit (&CurrentRow
, FALSE
)) {
213 } while (!EFI_ERROR (GetNextFileStatus
));
215 if (SearchType
== EFI_FV_FILETYPE_ALL
) {
216 AsciiPrint ("%,20d bytes in files %,d bytes free\n", TotalSize
, File
->FvSize
- File
->FvHeaderSize
- TotalSize
);
220 } else if ((File
->Type
== EfiOpenFileSystem
) || (File
->Type
== EfiOpenBlockIo
)) {
221 // Simple File System DIR
223 if (File
->FsFileInfo
== NULL
) {
227 if (!(File
->FsFileInfo
->Attribute
& EFI_FILE_DIRECTORY
)) {
231 // Handle *Name substring matching
232 MatchSubString
= NULL
;
233 UnicodeFileName
[0] = '\0';
235 AsciiStrToUnicodeStrS (Argv
[2], UnicodeFileName
, MAX_CMD_LINE
);
236 if (UnicodeFileName
[0] == '*') {
237 MatchSubString
= &UnicodeFileName
[1];
241 File
->FsFileHandle
->SetPosition (File
->FsFileHandle
, 0);
242 for (CurrentRow
= 0;;) {
243 // First read gets the size
246 Status
= File
->FsFileHandle
->Read (File
->FsFileHandle
, &ReadSize
, DirInfo
);
247 if (Status
== EFI_BUFFER_TOO_SMALL
) {
248 // Allocate the buffer for the real read
249 DirInfo
= AllocatePool (ReadSize
);
250 if (DirInfo
== NULL
) {
255 Status
= File
->FsFileHandle
->Read (File
->FsFileHandle
, &ReadSize
, DirInfo
);
256 if ((EFI_ERROR (Status
)) || (ReadSize
== 0)) {
263 if (MatchSubString
!= NULL
) {
264 if (StrStr (&DirInfo
->FileName
[0], MatchSubString
) == NULL
) {
265 // does not match *name argument, so skip
268 } else if (UnicodeFileName
[0] != '\0') {
269 // is not an exact match for name argument, so skip
270 if (StrCmp (&DirInfo
->FileName
[0], UnicodeFileName
) != 0) {
275 if (DirInfo
->Attribute
& EFI_FILE_DIRECTORY
) {
276 AsciiPrint (" <DIR> %s\n", &DirInfo
->FileName
[0]);
278 AsciiPrint ("%,14ld %s\n", DirInfo
->FileSize
, &DirInfo
->FileName
[0]);
281 if (EblAnyKeyToContinueQtoQuit (&CurrentRow
, FALSE
)) {
289 if (DirInfo
!= NULL
) {
300 Change the Current Working Directory
303 Argv[1] - Device Name:path. Path is optional
305 @param Argc Number of command arguments in Argv
306 @param Argv Array of strings that represent the parsed command line.
307 Argv[0] is the command name
323 return EfiSetCwd (Argv
[1]);
328 GLOBAL_REMOVE_IF_UNREFERENCED
const EBL_COMMAND_TABLE mCmdDirTemplate
[] =
332 " dirdev [*match]; directory listing of dirdev. opt match a substring",
338 " device - set the current working directory",
346 Initialize the commands in this in this file
349 EblInitializeDirCmd (
353 if (FeaturePcdGet (PcdEmbeddedDirCmd
)) {
354 EblAddCommands (mCmdDirTemplate
, sizeof (mCmdDirTemplate
)/sizeof (EBL_COMMAND_TABLE
));