2 Main file for vol shell level 2 function.
4 (C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>
5 Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>
6 SPDX-License-Identifier: BSD-2-Clause-Patent
10 #include "UefiShellLevel2CommandsLib.h"
11 #include <Guid/FileSystemInfo.h>
12 #include <Guid/FileSystemVolumeLabelInfo.h>
15 Print the info or change the volume info.
17 @param[in] Path String with starting path.
18 @param[in] Delete TRUE to delete the volume label. FALSE otherwise.
19 @param[in] Name New name to set to the volume label.
21 @retval SHELL_SUCCESS The operation was sucessful.
25 IN CONST CHAR16
*Path
,
26 IN CONST BOOLEAN Delete
,
27 IN CONST CHAR16
*Name OPTIONAL
31 SHELL_STATUS ShellStatus
;
32 EFI_FILE_SYSTEM_INFO
*SysInfo
;
34 SHELL_FILE_HANDLE ShellFileHandle
;
35 EFI_FILE_PROTOCOL
*EfiFpHandle
;
39 ShellStatus
= SHELL_SUCCESS
;
43 (StrStr (Name
, L
"%") != NULL
) ||
44 (StrStr (Name
, L
"^") != NULL
) ||
45 (StrStr (Name
, L
"*") != NULL
) ||
46 (StrStr (Name
, L
"+") != NULL
) ||
47 (StrStr (Name
, L
"=") != NULL
) ||
48 (StrStr (Name
, L
"[") != NULL
) ||
49 (StrStr (Name
, L
"]") != NULL
) ||
50 (StrStr (Name
, L
"|") != NULL
) ||
51 (StrStr (Name
, L
":") != NULL
) ||
52 (StrStr (Name
, L
";") != NULL
) ||
53 (StrStr (Name
, L
"\"") != NULL
) ||
54 (StrStr (Name
, L
"<") != NULL
) ||
55 (StrStr (Name
, L
">") != NULL
) ||
56 (StrStr (Name
, L
"?") != NULL
) ||
57 (StrStr (Name
, L
"/") != NULL
) ||
58 (StrStr (Name
, L
" ") != NULL
))
61 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_GEN_PARAM_INV
), gShellLevel2HiiHandle
, L
"vol", Name
);
62 return (SHELL_INVALID_PARAMETER
);
65 Status
= gEfiShellProtocol
->OpenFileByName (
68 Name
!= NULL
? EFI_FILE_MODE_READ
|EFI_FILE_MODE_WRITE
: EFI_FILE_MODE_READ
71 if (EFI_ERROR (Status
) || (ShellFileHandle
== NULL
)) {
72 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_GEN_FILE_OPEN_FAIL
), gShellLevel2HiiHandle
, L
"vol", Path
);
73 return (SHELL_ACCESS_DENIED
);
77 // Get the Volume Info from ShellFileHandle
81 EfiFpHandle
= ConvertShellHandleToEfiFileProtocol (ShellFileHandle
);
82 Status
= EfiFpHandle
->GetInfo (
84 &gEfiFileSystemInfoGuid
,
89 if (Status
== EFI_BUFFER_TOO_SMALL
) {
90 SysInfo
= AllocateZeroPool (SysInfoSize
);
91 Status
= EfiFpHandle
->GetInfo (
93 &gEfiFileSystemInfoGuid
,
99 ASSERT (SysInfo
!= NULL
);
102 *((CHAR16
*)SysInfo
->VolumeLabel
) = CHAR_NULL
;
103 SysInfo
->Size
= SIZE_OF_EFI_FILE_SYSTEM_INFO
+ StrSize (SysInfo
->VolumeLabel
);
104 Status
= EfiFpHandle
->SetInfo (
106 &gEfiFileSystemInfoGuid
,
107 (UINTN
)SysInfo
->Size
,
110 } else if (Name
!= NULL
) {
111 Size1
= StrSize (Name
);
112 Size2
= StrSize (SysInfo
->VolumeLabel
);
114 SysInfo
= ReallocatePool ((UINTN
)SysInfo
->Size
, (UINTN
)SysInfo
->Size
+ Size1
- Size2
, SysInfo
);
115 if (SysInfo
== NULL
) {
116 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_GEN_OUT_MEM
), gShellLevel2HiiHandle
, L
"vol");
117 ShellStatus
= SHELL_OUT_OF_RESOURCES
;
121 if (SysInfo
!= NULL
) {
123 (CHAR16
*)SysInfo
->VolumeLabel
,
124 (Size1
> Size2
? Size1
/sizeof (CHAR16
) : Size2
/sizeof (CHAR16
)),
127 SysInfo
->Size
= SIZE_OF_EFI_FILE_SYSTEM_INFO
+ Size1
;
128 Status
= EfiFpHandle
->SetInfo (
130 &gEfiFileSystemInfoGuid
,
131 (UINTN
)SysInfo
->Size
,
139 if (Delete
|| (Name
!= NULL
)) {
140 if (EFI_ERROR (Status
)) {
141 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_GEN_FILE_AD
), gShellLevel2HiiHandle
, L
"vol", Path
);
142 ShellStatus
= SHELL_ACCESS_DENIED
;
149 Status
= EfiFpHandle
->GetInfo (
151 &gEfiFileSystemInfoGuid
,
156 if (Status
== EFI_BUFFER_TOO_SMALL
) {
157 SysInfo
= AllocateZeroPool (SysInfoSize
);
158 Status
= EfiFpHandle
->GetInfo (
160 &gEfiFileSystemInfoGuid
,
166 gEfiShellProtocol
->CloseFile (ShellFileHandle
);
168 ASSERT (SysInfo
!= NULL
);
170 if (SysInfo
!= NULL
) {
172 // print VolumeInfo table
176 gST
->ConOut
->Mode
->CursorRow
,
178 STRING_TOKEN (STR_VOL_VOLINFO
),
179 gShellLevel2HiiHandle
,
180 SysInfo
->VolumeLabel
,
181 SysInfo
->ReadOnly
? L
"r" : L
"rw",
186 SHELL_FREE_NON_NULL (SysInfo
);
189 return (ShellStatus
);
192 STATIC CONST SHELL_PARAM_ITEM ParamList
[] = {
194 { L
"-n", TypeValue
},
199 Function for 'Vol' command.
201 @param[in] ImageHandle Handle to the Image (NULL if Internal).
202 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
207 IN EFI_HANDLE ImageHandle
,
208 IN EFI_SYSTEM_TABLE
*SystemTable
213 CHAR16
*ProblemParam
;
214 SHELL_STATUS ShellStatus
;
215 CONST CHAR16
*PathName
;
216 CONST CHAR16
*CurDir
;
221 CONST CHAR16
*NewName
;
225 ShellStatus
= SHELL_SUCCESS
;
231 // initialize the shell lib (we must be in non-auto-init...)
233 Status
= ShellInitialize ();
234 ASSERT_EFI_ERROR (Status
);
237 // Fix local copies of the protocol pointers
239 Status
= CommandInit ();
240 ASSERT_EFI_ERROR (Status
);
243 // parse the command line
245 Status
= ShellCommandLineParse (ParamList
, &Package
, &ProblemParam
, TRUE
);
246 if (EFI_ERROR (Status
)) {
247 if ((Status
== EFI_VOLUME_CORRUPTED
) && (ProblemParam
!= NULL
)) {
248 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_GEN_PROBLEM
), gShellLevel2HiiHandle
, L
"vol", ProblemParam
);
249 FreePool (ProblemParam
);
250 ShellStatus
= SHELL_INVALID_PARAMETER
;
258 if (ShellCommandLineGetFlag (Package
, L
"-?")) {
262 if (ShellCommandLineGetCount (Package
) > 2) {
263 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_GEN_TOO_MANY
), gShellLevel2HiiHandle
, L
"vol");
264 ShellStatus
= SHELL_INVALID_PARAMETER
;
266 PathName
= ShellCommandLineGetRawValue (Package
, 1);
267 if (PathName
== NULL
) {
268 CurDir
= gEfiShellProtocol
->GetCurDir (NULL
);
269 if (CurDir
== NULL
) {
270 ShellStatus
= SHELL_NOT_FOUND
;
271 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_GEN_NO_CWD
), gShellLevel2HiiHandle
, L
"vol");
277 if (PathName
!= NULL
) {
278 TempSpot
= StrStr (PathName
, L
":");
279 if (TempSpot
!= NULL
) {
280 *TempSpot
= CHAR_NULL
;
283 TempSpot
= StrStr (PathName
, L
"\\");
284 if (TempSpot
!= NULL
) {
285 *TempSpot
= CHAR_NULL
;
288 StrnCatGrow (&FullPath
, &Length
, PathName
, 0);
289 StrnCatGrow (&FullPath
, &Length
, L
":\\", 0);
290 DeleteMode
= ShellCommandLineGetFlag (Package
, L
"-d");
291 NewName
= ShellCommandLineGetValue (Package
, L
"-n");
292 if (DeleteMode
&& ShellCommandLineGetFlag (Package
, L
"-n")) {
293 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_GEN_PARAM_CONFLICT
), gShellLevel2HiiHandle
, L
"vol", L
"-d", L
"-n");
294 ShellStatus
= SHELL_INVALID_PARAMETER
;
295 } else if (ShellCommandLineGetFlag (Package
, L
"-n") && (NewName
== NULL
)) {
296 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_GEN_NO_VALUE
), gShellLevel2HiiHandle
, L
"vol", L
"-n");
297 ShellStatus
= SHELL_INVALID_PARAMETER
;
298 } else if ((NewName
!= NULL
) && (StrLen (NewName
) > 11)) {
299 ShellPrintHiiEx (-1, -1, NULL
, STRING_TOKEN (STR_GEN_PROBLEM_VAL
), gShellLevel2HiiHandle
, L
"vol", NewName
, L
"-n");
300 ShellStatus
= SHELL_INVALID_PARAMETER
;
301 } else if (ShellStatus
== SHELL_SUCCESS
) {
302 ShellStatus
= HandleVol (
312 SHELL_FREE_NON_NULL (FullPath
);
315 // free the command line package
317 ShellCommandLineFreeVarList (Package
);
319 return (ShellStatus
);