]>
Commit | Line | Data |
---|---|---|
a405b86d | 1 | /** @file\r |
2 | Member functions of EFI_SHELL_PROTOCOL and functions for creation,\r | |
3 | manipulation, and initialization of EFI_SHELL_PROTOCOL.\r | |
4 | \r | |
ecfd71af | 5 | Copyright (c) 2009 - 2012, Intel Corporation. All rights reserved.<BR>\r |
a405b86d | 6 | This program and the accompanying materials\r |
7 | are licensed and made available under the terms and conditions of the BSD License\r | |
8 | which accompanies this distribution. The full text of the license may be found at\r | |
9 | http://opensource.org/licenses/bsd-license.php\r | |
10 | \r | |
11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
13 | \r | |
14 | **/\r | |
15 | \r | |
16 | #include "Shell.h"\r | |
17 | #include <Library/FileHandleLib.h>\r | |
18 | \r | |
19 | /**\r | |
20 | Close an open file handle.\r | |
21 | \r | |
22 | This function closes a specified file handle. All "dirty" cached file data is\r | |
23 | flushed to the device, and the file is closed. In all cases the handle is\r | |
24 | closed.\r | |
25 | \r | |
26 | @param[in] FileHandle The file handle to close.\r | |
27 | \r | |
28 | @retval EFI_SUCCESS The file handle was closed successfully.\r | |
29 | **/\r | |
30 | EFI_STATUS\r | |
31 | EFIAPI\r | |
32 | EfiShellClose (\r | |
33 | IN SHELL_FILE_HANDLE FileHandle\r | |
34 | )\r | |
35 | {\r | |
36 | ShellFileHandleRemove(FileHandle);\r | |
8be0ba36 | 37 | return (FileHandleClose(ConvertShellHandleToEfiFileProtocol(FileHandle)));\r |
a405b86d | 38 | }\r |
39 | \r | |
733f138d | 40 | /**\r |
41 | Internal worker to determine whether there is a BlockIo somewhere\r | |
42 | upon the device path specified.\r | |
43 | \r | |
44 | @param[in] DevicePath The device path to test.\r | |
45 | \r | |
46 | @retval TRUE gEfiBlockIoProtocolGuid was installed on a handle with this device path\r | |
47 | @retval FALSE gEfiBlockIoProtocolGuid was not found.\r | |
48 | **/\r | |
49 | BOOLEAN\r | |
50 | EFIAPI\r | |
51 | InternalShellProtocolIsBlockIoPresent(\r | |
52 | IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath\r | |
53 | )\r | |
54 | {\r | |
55 | EFI_DEVICE_PATH_PROTOCOL *DevicePathCopy;\r | |
56 | EFI_STATUS Status;\r | |
57 | EFI_HANDLE Handle;\r | |
58 | \r | |
59 | Handle = NULL;\r | |
60 | \r | |
61 | DevicePathCopy = (EFI_DEVICE_PATH_PROTOCOL*)DevicePath;\r | |
62 | Status = gBS->LocateDevicePath(&gEfiBlockIoProtocolGuid, &DevicePathCopy, &Handle);\r | |
63 | \r | |
64 | if ((Handle != NULL) && (!EFI_ERROR(Status))) {\r | |
65 | return (TRUE);\r | |
66 | }\r | |
67 | return (FALSE);\r | |
68 | }\r | |
69 | \r | |
a405b86d | 70 | /**\r |
71 | Internal worker to determine whether there is a file system somewhere\r | |
72 | upon the device path specified.\r | |
73 | \r | |
74 | @param[in] DevicePath The device path to test.\r | |
75 | \r | |
76 | @retval TRUE gEfiSimpleFileSystemProtocolGuid was installed on a handle with this device path\r | |
77 | @retval FALSE gEfiSimpleFileSystemProtocolGuid was not found.\r | |
78 | **/\r | |
79 | BOOLEAN\r | |
80 | EFIAPI\r | |
81 | InternalShellProtocolIsSimpleFileSystemPresent(\r | |
82 | IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath\r | |
83 | )\r | |
84 | {\r | |
85 | EFI_DEVICE_PATH_PROTOCOL *DevicePathCopy;\r | |
86 | EFI_STATUS Status;\r | |
87 | EFI_HANDLE Handle;\r | |
88 | \r | |
89 | Handle = NULL;\r | |
90 | \r | |
91 | DevicePathCopy = (EFI_DEVICE_PATH_PROTOCOL*)DevicePath;\r | |
92 | Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &DevicePathCopy, &Handle);\r | |
93 | \r | |
94 | if ((Handle != NULL) && (!EFI_ERROR(Status))) {\r | |
95 | return (TRUE);\r | |
96 | }\r | |
97 | return (FALSE);\r | |
98 | }\r | |
99 | \r | |
100 | /**\r | |
101 | Internal worker debug helper function to print out maps as they are added.\r | |
102 | \r | |
103 | @param[in] Mapping string mapping that has been added\r | |
104 | @param[in] DevicePath pointer to device path that has been mapped.\r | |
105 | \r | |
106 | @retval EFI_SUCCESS the operation was successful.\r | |
107 | @return other an error ocurred\r | |
108 | \r | |
109 | @sa LocateHandle\r | |
110 | @sa OpenProtocol\r | |
111 | **/\r | |
112 | EFI_STATUS\r | |
113 | EFIAPI\r | |
114 | InternalShellProtocolDebugPrintMessage (\r | |
115 | IN CONST CHAR16 *Mapping,\r | |
116 | IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath\r | |
117 | )\r | |
118 | {\r | |
119 | EFI_DEVICE_PATH_TO_TEXT_PROTOCOL *DevicePathToText;\r | |
120 | EFI_STATUS Status;\r | |
121 | CHAR16 *Temp;\r | |
122 | \r | |
123 | Status = EFI_SUCCESS;\r | |
124 | DEBUG_CODE_BEGIN();\r | |
125 | DevicePathToText = NULL;\r | |
126 | \r | |
127 | Status = gBS->LocateProtocol(&gEfiDevicePathToTextProtocolGuid,\r | |
128 | NULL,\r | |
129 | (VOID**)&DevicePathToText);\r | |
130 | if (Mapping != NULL) {\r | |
131 | DEBUG((EFI_D_INFO, "Added new map item:\"%S\"\r\n", Mapping));\r | |
132 | }\r | |
133 | if (!EFI_ERROR(Status)) {\r | |
134 | if (DevicePath != NULL) {\r | |
135 | Temp = DevicePathToText->ConvertDevicePathToText(DevicePath, TRUE, TRUE);\r | |
136 | DEBUG((EFI_D_INFO, "DevicePath: %S\r\n", Temp));\r | |
137 | FreePool(Temp);\r | |
138 | }\r | |
139 | }\r | |
140 | DEBUG_CODE_END();\r | |
141 | return (Status);\r | |
142 | }\r | |
143 | \r | |
144 | /**\r | |
145 | This function creates a mapping for a device path.\r | |
146 | \r | |
147 | If both DeviecPath and Mapping are NULL, this will reset the mapping to default values.\r | |
148 | \r | |
149 | @param DevicePath Points to the device path. If this is NULL and Mapping points to a valid mapping,\r | |
150 | then the mapping will be deleted.\r | |
151 | @param Mapping Points to the NULL-terminated mapping for the device path. Must end with a ':'\r | |
152 | \r | |
153 | @retval EFI_SUCCESS Mapping created or deleted successfully.\r | |
154 | @retval EFI_NO_MAPPING There is no handle that corresponds exactly to DevicePath. See the\r | |
155 | boot service function LocateDevicePath().\r | |
156 | @retval EFI_ACCESS_DENIED The mapping is a built-in alias.\r | |
157 | @retval EFI_INVALID_PARAMETER Mapping was NULL\r | |
158 | @retval EFI_INVALID_PARAMETER Mapping did not end with a ':'\r | |
159 | @retval EFI_INVALID_PARAMETER DevicePath was not pointing at a device that had a SIMPLE_FILE_SYSTEM_PROTOCOL installed.\r | |
160 | @retval EFI_NOT_FOUND There was no mapping found to delete\r | |
161 | @retval EFI_OUT_OF_RESOURCES Memory allocation failed\r | |
162 | **/\r | |
163 | EFI_STATUS\r | |
164 | EFIAPI\r | |
165 | EfiShellSetMap(\r | |
166 | IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath OPTIONAL,\r | |
167 | IN CONST CHAR16 *Mapping\r | |
168 | )\r | |
169 | {\r | |
170 | EFI_STATUS Status;\r | |
171 | SHELL_MAP_LIST *MapListNode;\r | |
172 | \r | |
173 | if (Mapping == NULL){\r | |
174 | return (EFI_INVALID_PARAMETER);\r | |
175 | }\r | |
176 | \r | |
177 | if (Mapping[StrLen(Mapping)-1] != ':') {\r | |
178 | return (EFI_INVALID_PARAMETER);\r | |
179 | }\r | |
180 | \r | |
181 | //\r | |
182 | // Delete the mapping\r | |
183 | //\r | |
184 | if (DevicePath == NULL) {\r | |
185 | if (IsListEmpty(&gShellMapList.Link)) {\r | |
186 | return (EFI_NOT_FOUND);\r | |
187 | }\r | |
188 | for ( MapListNode = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)\r | |
189 | ; !IsNull(&gShellMapList.Link, &MapListNode->Link)\r | |
190 | ; MapListNode = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &MapListNode->Link)\r | |
191 | ){\r | |
192 | if (StringNoCaseCompare(&MapListNode->MapName, &Mapping) == 0) {\r | |
193 | RemoveEntryList(&MapListNode->Link);\r | |
194 | FreePool(MapListNode);\r | |
195 | return (EFI_SUCCESS);\r | |
196 | }\r | |
197 | } // for loop\r | |
198 | \r | |
199 | //\r | |
200 | // We didnt find one to delete\r | |
201 | //\r | |
202 | return (EFI_NOT_FOUND);\r | |
203 | }\r | |
204 | \r | |
205 | //\r | |
206 | // make sure this is a valid to add device path\r | |
207 | //\r | |
208 | ///@todo add BlockIo to this test...\r | |
733f138d | 209 | if (!InternalShellProtocolIsSimpleFileSystemPresent(DevicePath)\r |
210 | && !InternalShellProtocolIsBlockIoPresent(DevicePath)) {\r | |
a405b86d | 211 | return (EFI_INVALID_PARAMETER);\r |
212 | }\r | |
213 | \r | |
214 | //\r | |
215 | // First make sure there is no old mapping\r | |
216 | //\r | |
217 | Status = EfiShellSetMap(NULL, Mapping);\r | |
218 | if ((Status != EFI_SUCCESS) && (Status != EFI_NOT_FOUND)) {\r | |
219 | return (Status);\r | |
220 | }\r | |
221 | \r | |
222 | //\r | |
223 | // now add the new one.\r | |
224 | //\r | |
225 | Status = ShellCommandAddMapItemAndUpdatePath(Mapping, DevicePath, 0, FALSE);\r | |
226 | \r | |
227 | return(Status);\r | |
228 | }\r | |
229 | \r | |
230 | /**\r | |
231 | Gets the device path from the mapping.\r | |
232 | \r | |
233 | This function gets the device path associated with a mapping.\r | |
234 | \r | |
235 | @param Mapping A pointer to the mapping\r | |
236 | \r | |
237 | @retval !=NULL Pointer to the device path that corresponds to the\r | |
238 | device mapping. The returned pointer does not need\r | |
239 | to be freed.\r | |
240 | @retval NULL There is no device path associated with the\r | |
241 | specified mapping.\r | |
242 | **/\r | |
243 | CONST EFI_DEVICE_PATH_PROTOCOL *\r | |
244 | EFIAPI\r | |
245 | EfiShellGetDevicePathFromMap(\r | |
246 | IN CONST CHAR16 *Mapping\r | |
247 | )\r | |
248 | {\r | |
249 | SHELL_MAP_LIST *MapListItem;\r | |
250 | CHAR16 *NewName;\r | |
251 | UINTN Size;\r | |
252 | \r | |
253 | NewName = NULL;\r | |
254 | Size = 0;\r | |
255 | \r | |
256 | StrnCatGrow(&NewName, &Size, Mapping, 0);\r | |
257 | if (Mapping[StrLen(Mapping)-1] != L':') {\r | |
258 | StrnCatGrow(&NewName, &Size, L":", 0);\r | |
259 | }\r | |
260 | \r | |
261 | MapListItem = ShellCommandFindMapItem(NewName);\r | |
262 | \r | |
263 | FreePool(NewName);\r | |
264 | \r | |
265 | if (MapListItem != NULL) {\r | |
266 | return (MapListItem->DevicePath);\r | |
267 | }\r | |
268 | return(NULL);\r | |
269 | }\r | |
270 | \r | |
271 | /**\r | |
272 | Gets the mapping(s) that most closely matches the device path.\r | |
273 | \r | |
274 | This function gets the mapping which corresponds to the device path *DevicePath. If\r | |
275 | there is no exact match, then the mapping which most closely matches *DevicePath\r | |
276 | is returned, and *DevicePath is updated to point to the remaining portion of the\r | |
277 | device path. If there is an exact match, the mapping is returned and *DevicePath\r | |
278 | points to the end-of-device-path node.\r | |
279 | \r | |
280 | If there are multiple map names they will be semi-colon seperated in the\r | |
281 | NULL-terminated string.\r | |
282 | \r | |
283 | @param DevicePath On entry, points to a device path pointer. On\r | |
284 | exit, updates the pointer to point to the\r | |
285 | portion of the device path after the mapping.\r | |
286 | \r | |
287 | @retval NULL No mapping was found.\r | |
288 | @return !=NULL Pointer to NULL-terminated mapping. The buffer\r | |
289 | is callee allocated and should be freed by the caller.\r | |
290 | **/\r | |
291 | CONST CHAR16 *\r | |
292 | EFIAPI\r | |
293 | EfiShellGetMapFromDevicePath(\r | |
294 | IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath\r | |
295 | )\r | |
296 | {\r | |
297 | SHELL_MAP_LIST *Node;\r | |
298 | CHAR16 *PathForReturn;\r | |
299 | UINTN PathSize;\r | |
300 | // EFI_HANDLE PathHandle;\r | |
301 | // EFI_HANDLE MapHandle;\r | |
302 | // EFI_STATUS Status;\r | |
303 | // EFI_DEVICE_PATH_PROTOCOL *DevicePathCopy;\r | |
304 | // EFI_DEVICE_PATH_PROTOCOL *MapPathCopy;\r | |
305 | \r | |
306 | if (DevicePath == NULL || *DevicePath == NULL) {\r | |
307 | return (NULL);\r | |
308 | }\r | |
309 | \r | |
310 | PathForReturn = NULL;\r | |
311 | PathSize = 0;\r | |
312 | \r | |
313 | for ( Node = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)\r | |
314 | ; !IsNull(&gShellMapList.Link, &Node->Link)\r | |
315 | ; Node = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &Node->Link)\r | |
316 | ){\r | |
317 | //\r | |
318 | // check for exact match\r | |
319 | //\r | |
320 | if (DevicePathCompare(DevicePath, &Node->DevicePath) == 0) {\r | |
321 | ASSERT((PathForReturn == NULL && PathSize == 0) || (PathForReturn != NULL));\r | |
322 | if (PathSize != 0) {\r | |
323 | PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, L";", 0);\r | |
324 | }\r | |
325 | PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, Node->MapName, 0);\r | |
326 | }\r | |
327 | }\r | |
328 | if (PathForReturn != NULL) {\r | |
329 | while (!IsDevicePathEndType (*DevicePath)) {\r | |
330 | *DevicePath = NextDevicePathNode (*DevicePath);\r | |
331 | }\r | |
332 | SetDevicePathEndNode (*DevicePath);\r | |
333 | }\r | |
334 | /*\r | |
335 | ///@todo finish code for inexact matches.\r | |
336 | if (PathForReturn == NULL) {\r | |
337 | PathSize = 0;\r | |
338 | \r | |
339 | DevicePathCopy = DuplicateDevicePath(*DevicePath);\r | |
340 | ASSERT(DevicePathCopy != NULL);\r | |
341 | Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &DevicePathCopy, &PathHandle);\r | |
342 | ASSERT_EFI_ERROR(Status);\r | |
343 | //\r | |
344 | // check each of the device paths we have to get the root of the path for consist mappings\r | |
345 | //\r | |
346 | for ( Node = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)\r | |
347 | ; !IsNull(&gShellMapList.Link, &Node->Link)\r | |
348 | ; Node = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &Node->Link)\r | |
349 | ){\r | |
350 | if ((Node->Flags & SHELL_MAP_FLAGS_CONSIST) == 0) {\r | |
351 | continue;\r | |
352 | }\r | |
353 | MapPathCopy = DuplicateDevicePath(Node->DevicePath);\r | |
354 | ASSERT(MapPathCopy != NULL);\r | |
355 | Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &MapPathCopy, &MapHandle);\r | |
356 | if (MapHandle == PathHandle) {\r | |
357 | \r | |
358 | *DevicePath = DevicePathCopy;\r | |
359 | \r | |
360 | MapPathCopy = NULL;\r | |
361 | DevicePathCopy = NULL;\r | |
362 | PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, Node->MapName, 0);\r | |
363 | PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, L";", 0);\r | |
364 | break;\r | |
365 | }\r | |
366 | }\r | |
367 | //\r | |
368 | // now add on the non-consistent mappings\r | |
369 | //\r | |
370 | for ( Node = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)\r | |
371 | ; !IsNull(&gShellMapList.Link, &Node->Link)\r | |
372 | ; Node = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &Node->Link)\r | |
373 | ){\r | |
374 | if ((Node->Flags & SHELL_MAP_FLAGS_CONSIST) != 0) {\r | |
375 | continue;\r | |
376 | }\r | |
377 | MapPathCopy = Node->DevicePath;\r | |
378 | ASSERT(MapPathCopy != NULL);\r | |
379 | Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &MapPathCopy, &MapHandle);\r | |
380 | if (MapHandle == PathHandle) {\r | |
381 | PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, Node->MapName, 0);\r | |
382 | PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, L";", 0);\r | |
383 | break;\r | |
384 | }\r | |
385 | }\r | |
386 | }\r | |
387 | */\r | |
388 | \r | |
389 | return (AddBufferToFreeList(PathForReturn));\r | |
390 | }\r | |
391 | \r | |
392 | /**\r | |
393 | Converts a device path to a file system-style path.\r | |
394 | \r | |
395 | This function converts a device path to a file system path by replacing part, or all, of\r | |
396 | the device path with the file-system mapping. If there are more than one application\r | |
397 | file system mappings, the one that most closely matches Path will be used.\r | |
398 | \r | |
399 | @param Path The pointer to the device path\r | |
400 | \r | |
401 | @retval NULL the device path could not be found.\r | |
402 | @return all The pointer of the NULL-terminated file path. The path\r | |
403 | is callee-allocated and should be freed by the caller.\r | |
404 | **/\r | |
405 | CHAR16 *\r | |
406 | EFIAPI\r | |
407 | EfiShellGetFilePathFromDevicePath(\r | |
408 | IN CONST EFI_DEVICE_PATH_PROTOCOL *Path\r | |
409 | )\r | |
410 | {\r | |
411 | EFI_DEVICE_PATH_PROTOCOL *DevicePathCopy;\r | |
412 | EFI_DEVICE_PATH_PROTOCOL *MapPathCopy;\r | |
413 | SHELL_MAP_LIST *MapListItem;\r | |
414 | CHAR16 *PathForReturn;\r | |
415 | UINTN PathSize;\r | |
416 | EFI_HANDLE PathHandle;\r | |
417 | EFI_HANDLE MapHandle;\r | |
418 | EFI_STATUS Status;\r | |
419 | FILEPATH_DEVICE_PATH *FilePath;\r | |
f5020428 | 420 | FILEPATH_DEVICE_PATH *AlignedNode;\r |
a405b86d | 421 | \r |
422 | PathForReturn = NULL;\r | |
423 | PathSize = 0;\r | |
424 | \r | |
425 | DevicePathCopy = (EFI_DEVICE_PATH_PROTOCOL*)Path;\r | |
426 | ASSERT(DevicePathCopy != NULL);\r | |
427 | if (DevicePathCopy == NULL) {\r | |
428 | return (NULL);\r | |
429 | }\r | |
430 | ///@todo BlockIo?\r | |
431 | Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &DevicePathCopy, &PathHandle);\r | |
432 | \r | |
433 | if (EFI_ERROR(Status)) {\r | |
434 | return (NULL);\r | |
435 | }\r | |
436 | //\r | |
437 | // check each of the device paths we have to get the root of the path\r | |
438 | //\r | |
439 | for ( MapListItem = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)\r | |
440 | ; !IsNull(&gShellMapList.Link, &MapListItem->Link)\r | |
441 | ; MapListItem = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &MapListItem->Link)\r | |
442 | ){\r | |
443 | MapPathCopy = (EFI_DEVICE_PATH_PROTOCOL*)MapListItem->DevicePath;\r | |
444 | ASSERT(MapPathCopy != NULL);\r | |
445 | ///@todo BlockIo?\r | |
446 | Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &MapPathCopy, &MapHandle);\r | |
447 | if (MapHandle == PathHandle) {\r | |
448 | ASSERT((PathForReturn == NULL && PathSize == 0) || (PathForReturn != NULL));\r | |
449 | PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, MapListItem->MapName, 0);\r | |
450 | //\r | |
451 | // go through all the remaining nodes in the device path\r | |
452 | //\r | |
453 | for ( FilePath = (FILEPATH_DEVICE_PATH*)DevicePathCopy\r | |
454 | ; !IsDevicePathEnd (&FilePath->Header)\r | |
455 | ; FilePath = (FILEPATH_DEVICE_PATH*)NextDevicePathNode (&FilePath->Header)\r | |
456 | ){\r | |
457 | //\r | |
458 | // all the rest should be file path nodes\r | |
459 | //\r | |
460 | if ((DevicePathType(&FilePath->Header) != MEDIA_DEVICE_PATH) ||\r | |
461 | (DevicePathSubType(&FilePath->Header) != MEDIA_FILEPATH_DP)) {\r | |
462 | FreePool(PathForReturn);\r | |
463 | PathForReturn = NULL;\r | |
464 | ASSERT(FALSE);\r | |
465 | } else {\r | |
466 | //\r | |
467 | // append the path part onto the filepath.\r | |
468 | //\r | |
469 | ASSERT((PathForReturn == NULL && PathSize == 0) || (PathForReturn != NULL));\r | |
470 | PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, L"\\", 1);\r | |
f5020428 | 471 | \r |
472 | AlignedNode = AllocateCopyPool (DevicePathNodeLength(FilePath), FilePath);\r | |
473 | PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, AlignedNode->PathName, 0);\r | |
474 | FreePool(AlignedNode);\r | |
a405b86d | 475 | }\r |
476 | } // for loop of remaining nodes\r | |
477 | }\r | |
478 | if (PathForReturn != NULL) {\r | |
479 | break;\r | |
480 | }\r | |
481 | } // for loop of paths to check\r | |
482 | return(PathForReturn);\r | |
483 | }\r | |
484 | \r | |
485 | /**\r | |
486 | Converts a file system style name to a device path.\r | |
487 | \r | |
488 | This function converts a file system style name to a device path, by replacing any\r | |
489 | mapping references to the associated device path.\r | |
490 | \r | |
532691c8 | 491 | @param[in] Path The pointer to the path.\r |
a405b86d | 492 | \r |
532691c8 | 493 | @return The pointer of the file path. The file path is callee\r |
a405b86d | 494 | allocated and should be freed by the caller.\r |
532691c8 | 495 | @retval NULL The path could not be found.\r |
496 | @retval NULL There was not enough available memory.\r | |
a405b86d | 497 | **/\r |
498 | EFI_DEVICE_PATH_PROTOCOL *\r | |
499 | EFIAPI\r | |
500 | EfiShellGetDevicePathFromFilePath(\r | |
501 | IN CONST CHAR16 *Path\r | |
502 | )\r | |
503 | {\r | |
504 | CHAR16 *MapName;\r | |
505 | CHAR16 *NewPath;\r | |
506 | CONST CHAR16 *Cwd;\r | |
507 | UINTN Size;\r | |
508 | CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r | |
509 | EFI_DEVICE_PATH_PROTOCOL *DevicePathCopy;\r | |
510 | EFI_DEVICE_PATH_PROTOCOL *DevicePathCopyForFree;\r | |
511 | EFI_DEVICE_PATH_PROTOCOL *DevicePathForReturn;\r | |
512 | EFI_HANDLE Handle;\r | |
513 | EFI_STATUS Status;\r | |
514 | \r | |
8be0ba36 | 515 | if (Path == NULL) {\r |
516 | return (NULL);\r | |
517 | }\r | |
518 | \r | |
a405b86d | 519 | MapName = NULL;\r |
8be0ba36 | 520 | NewPath = NULL;\r |
a405b86d | 521 | \r |
522 | if (StrStr(Path, L":") == NULL) {\r | |
523 | Cwd = EfiShellGetCurDir(NULL);\r | |
524 | if (Cwd == NULL) {\r | |
525 | return (NULL);\r | |
526 | }\r | |
527 | Size = StrSize(Cwd);\r | |
528 | Size += StrSize(Path);\r | |
529 | NewPath = AllocateZeroPool(Size);\r | |
532691c8 | 530 | if (NewPath == NULL) {\r |
531 | return (NULL);\r | |
532 | }\r | |
a405b86d | 533 | StrCpy(NewPath, Cwd);\r |
733f138d | 534 | if (*Path == L'\\') {\r |
535 | Path++;\r | |
ab94587a | 536 | while (PathRemoveLastItem(NewPath)) ;\r |
a405b86d | 537 | }\r |
538 | StrCat(NewPath, Path);\r | |
539 | DevicePathForReturn = EfiShellGetDevicePathFromFilePath(NewPath);\r | |
540 | FreePool(NewPath);\r | |
541 | return (DevicePathForReturn);\r | |
542 | }\r | |
543 | \r | |
544 | Size = 0;\r | |
545 | //\r | |
546 | // find the part before (but including) the : for the map name\r | |
547 | //\r | |
548 | ASSERT((MapName == NULL && Size == 0) || (MapName != NULL));\r | |
549 | MapName = StrnCatGrow(&MapName, &Size, Path, (StrStr(Path, L":")-Path+1));\r | |
532691c8 | 550 | if (MapName == NULL || MapName[StrLen(MapName)-1] != L':') {\r |
a405b86d | 551 | return (NULL);\r |
552 | }\r | |
553 | \r | |
554 | //\r | |
555 | // look up the device path in the map\r | |
556 | //\r | |
557 | DevicePath = EfiShellGetDevicePathFromMap(MapName);\r | |
558 | if (DevicePath == NULL) {\r | |
559 | //\r | |
560 | // Must have been a bad Mapname\r | |
561 | //\r | |
562 | return (NULL);\r | |
563 | }\r | |
564 | \r | |
565 | //\r | |
566 | // make a copy for LocateDevicePath to modify (also save a pointer to call FreePool with)\r | |
567 | //\r | |
568 | DevicePathCopyForFree = DevicePathCopy = DuplicateDevicePath(DevicePath);\r | |
569 | if (DevicePathCopy == NULL) {\r | |
a405b86d | 570 | FreePool(MapName);\r |
571 | return (NULL);\r | |
572 | }\r | |
573 | \r | |
574 | //\r | |
575 | // get the handle\r | |
576 | //\r | |
577 | ///@todo BlockIo?\r | |
578 | Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &DevicePathCopy, &Handle);\r | |
579 | if (EFI_ERROR(Status)) {\r | |
580 | if (DevicePathCopyForFree != NULL) {\r | |
581 | FreePool(DevicePathCopyForFree);\r | |
582 | }\r | |
583 | FreePool(MapName);\r | |
584 | return (NULL);\r | |
585 | }\r | |
586 | \r | |
587 | //\r | |
588 | // build the full device path\r | |
589 | //\r | |
e35b5317 | 590 | if (*(Path+StrLen(MapName)+1) == CHAR_NULL) {\r |
591 | DevicePathForReturn = FileDevicePath(Handle, L"\\");\r | |
592 | } else {\r | |
f9125972 | 593 | DevicePathForReturn = FileDevicePath(Handle, Path+StrLen(MapName));\r |
e35b5317 | 594 | }\r |
a405b86d | 595 | \r |
596 | FreePool(MapName);\r | |
597 | if (DevicePathCopyForFree != NULL) {\r | |
598 | FreePool(DevicePathCopyForFree);\r | |
599 | }\r | |
600 | \r | |
601 | return (DevicePathForReturn);\r | |
602 | }\r | |
603 | \r | |
604 | /**\r | |
605 | Gets the name of the device specified by the device handle.\r | |
606 | \r | |
607 | This function gets the user-readable name of the device specified by the device\r | |
608 | handle. If no user-readable name could be generated, then *BestDeviceName will be\r | |
609 | NULL and EFI_NOT_FOUND will be returned.\r | |
610 | \r | |
611 | If EFI_DEVICE_NAME_USE_COMPONENT_NAME is set, then the function will return the\r | |
612 | device's name using the EFI_COMPONENT_NAME2_PROTOCOL, if present on\r | |
613 | DeviceHandle.\r | |
614 | \r | |
615 | If EFI_DEVICE_NAME_USE_DEVICE_PATH is set, then the function will return the\r | |
616 | device's name using the EFI_DEVICE_PATH_PROTOCOL, if present on DeviceHandle.\r | |
617 | If both EFI_DEVICE_NAME_USE_COMPONENT_NAME and\r | |
618 | EFI_DEVICE_NAME_USE_DEVICE_PATH are set, then\r | |
619 | EFI_DEVICE_NAME_USE_COMPONENT_NAME will have higher priority.\r | |
620 | \r | |
621 | @param DeviceHandle The handle of the device.\r | |
622 | @param Flags Determines the possible sources of component names.\r | |
623 | Valid bits are:\r | |
624 | EFI_DEVICE_NAME_USE_COMPONENT_NAME\r | |
625 | EFI_DEVICE_NAME_USE_DEVICE_PATH\r | |
626 | @param Language A pointer to the language specified for the device\r | |
627 | name, in the same format as described in the UEFI\r | |
628 | specification, Appendix M\r | |
629 | @param BestDeviceName On return, points to the callee-allocated NULL-\r | |
630 | terminated name of the device. If no device name\r | |
631 | could be found, points to NULL. The name must be\r | |
632 | freed by the caller...\r | |
633 | \r | |
634 | @retval EFI_SUCCESS Get the name successfully.\r | |
635 | @retval EFI_NOT_FOUND Fail to get the device name.\r | |
636 | @retval EFI_INVALID_PARAMETER Flags did not have a valid bit set.\r | |
637 | @retval EFI_INVALID_PARAMETER BestDeviceName was NULL\r | |
638 | @retval EFI_INVALID_PARAMETER DeviceHandle was NULL\r | |
639 | **/\r | |
640 | EFI_STATUS\r | |
641 | EFIAPI\r | |
642 | EfiShellGetDeviceName(\r | |
643 | IN EFI_HANDLE DeviceHandle,\r | |
644 | IN EFI_SHELL_DEVICE_NAME_FLAGS Flags,\r | |
645 | IN CHAR8 *Language,\r | |
646 | OUT CHAR16 **BestDeviceName\r | |
647 | )\r | |
648 | {\r | |
649 | EFI_STATUS Status;\r | |
650 | EFI_COMPONENT_NAME2_PROTOCOL *CompName2;\r | |
651 | EFI_DEVICE_PATH_TO_TEXT_PROTOCOL *DevicePathToText;\r | |
652 | EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r | |
653 | EFI_HANDLE *HandleList;\r | |
654 | UINTN HandleCount;\r | |
655 | UINTN LoopVar;\r | |
656 | CHAR16 *DeviceNameToReturn;\r | |
657 | CHAR8 *Lang;\r | |
658 | CHAR8 *TempChar;\r | |
659 | \r | |
733f138d | 660 | UINTN ParentControllerCount;\r |
661 | EFI_HANDLE *ParentControllerBuffer;\r | |
662 | UINTN ParentDriverCount;\r | |
663 | EFI_HANDLE *ParentDriverBuffer;\r | |
664 | \r | |
a405b86d | 665 | if (BestDeviceName == NULL ||\r |
666 | DeviceHandle == NULL\r | |
667 | ){\r | |
668 | return (EFI_INVALID_PARAMETER);\r | |
669 | }\r | |
670 | \r | |
671 | //\r | |
672 | // make sure one of the 2 supported bits is on\r | |
673 | //\r | |
674 | if (((Flags & EFI_DEVICE_NAME_USE_COMPONENT_NAME) == 0) &&\r | |
675 | ((Flags & EFI_DEVICE_NAME_USE_DEVICE_PATH) == 0)) {\r | |
676 | return (EFI_INVALID_PARAMETER);\r | |
677 | }\r | |
678 | \r | |
679 | DeviceNameToReturn = NULL;\r | |
680 | *BestDeviceName = NULL;\r | |
681 | HandleList = NULL;\r | |
682 | HandleCount = 0;\r | |
683 | Lang = NULL;\r | |
684 | \r | |
685 | if ((Flags & EFI_DEVICE_NAME_USE_COMPONENT_NAME) != 0) {\r | |
686 | Status = ParseHandleDatabaseByRelationship(\r | |
687 | NULL,\r | |
688 | DeviceHandle,\r | |
689 | HR_DRIVER_BINDING_HANDLE|HR_DEVICE_DRIVER,\r | |
690 | &HandleCount,\r | |
691 | &HandleList);\r | |
692 | for (LoopVar = 0; LoopVar < HandleCount ; LoopVar++){\r | |
693 | //\r | |
694 | // Go through those handles until we get one that passes for GetComponentName\r | |
695 | //\r | |
696 | Status = gBS->OpenProtocol(\r | |
697 | HandleList[LoopVar],\r | |
698 | &gEfiComponentName2ProtocolGuid,\r | |
699 | (VOID**)&CompName2,\r | |
700 | gImageHandle,\r | |
701 | NULL,\r | |
702 | EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r | |
703 | if (EFI_ERROR(Status)) {\r | |
704 | Status = gBS->OpenProtocol(\r | |
705 | HandleList[LoopVar],\r | |
706 | &gEfiComponentNameProtocolGuid,\r | |
707 | (VOID**)&CompName2,\r | |
708 | gImageHandle,\r | |
709 | NULL,\r | |
710 | EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r | |
711 | }\r | |
712 | \r | |
713 | if (EFI_ERROR(Status)) {\r | |
714 | continue;\r | |
715 | }\r | |
716 | if (Language == NULL) {\r | |
733f138d | 717 | Lang = AllocateZeroPool(AsciiStrSize(CompName2->SupportedLanguages));\r |
3c865f20 | 718 | if (Lang == NULL) {\r |
719 | return (EFI_OUT_OF_RESOURCES);\r | |
720 | }\r | |
a405b86d | 721 | AsciiStrCpy(Lang, CompName2->SupportedLanguages);\r |
722 | TempChar = AsciiStrStr(Lang, ";");\r | |
723 | if (TempChar != NULL){\r | |
724 | *TempChar = CHAR_NULL;\r | |
725 | }\r | |
726 | } else {\r | |
733f138d | 727 | Lang = AllocateZeroPool(AsciiStrSize(Language));\r |
3c865f20 | 728 | if (Lang == NULL) {\r |
729 | return (EFI_OUT_OF_RESOURCES);\r | |
730 | }\r | |
a405b86d | 731 | AsciiStrCpy(Lang, Language);\r |
732 | }\r | |
733 | Status = CompName2->GetControllerName(CompName2, DeviceHandle, NULL, Lang, &DeviceNameToReturn);\r | |
734 | FreePool(Lang);\r | |
735 | Lang = NULL;\r | |
736 | if (!EFI_ERROR(Status) && DeviceNameToReturn != NULL) {\r | |
737 | break;\r | |
738 | }\r | |
739 | }\r | |
740 | if (HandleList != NULL) {\r | |
741 | FreePool(HandleList);\r | |
742 | }\r | |
733f138d | 743 | \r |
744 | //\r | |
745 | // Now check the parent controller using this as the child.\r | |
746 | //\r | |
747 | if (DeviceNameToReturn == NULL){\r | |
748 | PARSE_HANDLE_DATABASE_PARENTS(DeviceHandle, &ParentControllerCount, &ParentControllerBuffer);\r | |
749 | for (LoopVar = 0 ; LoopVar < ParentControllerCount ; LoopVar++) {\r | |
750 | PARSE_HANDLE_DATABASE_UEFI_DRIVERS(ParentControllerBuffer[LoopVar], &ParentDriverCount, &ParentDriverBuffer);\r | |
751 | for (HandleCount = 0 ; HandleCount < ParentDriverCount ; HandleCount++) {\r | |
752 | //\r | |
753 | // try using that driver's component name with controller and our driver as the child.\r | |
754 | //\r | |
755 | Status = gBS->OpenProtocol(\r | |
756 | ParentDriverBuffer[HandleCount],\r | |
757 | &gEfiComponentName2ProtocolGuid,\r | |
758 | (VOID**)&CompName2,\r | |
759 | gImageHandle,\r | |
760 | NULL,\r | |
761 | EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r | |
762 | if (EFI_ERROR(Status)) {\r | |
763 | Status = gBS->OpenProtocol(\r | |
764 | ParentDriverBuffer[HandleCount],\r | |
765 | &gEfiComponentNameProtocolGuid,\r | |
766 | (VOID**)&CompName2,\r | |
767 | gImageHandle,\r | |
768 | NULL,\r | |
769 | EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r | |
770 | }\r | |
771 | \r | |
772 | if (EFI_ERROR(Status)) {\r | |
773 | continue;\r | |
774 | }\r | |
775 | if (Language == NULL) {\r | |
776 | Lang = AllocateZeroPool(AsciiStrSize(CompName2->SupportedLanguages));\r | |
777 | if (Lang == NULL) {\r | |
778 | return (EFI_OUT_OF_RESOURCES);\r | |
779 | }\r | |
780 | AsciiStrCpy(Lang, CompName2->SupportedLanguages);\r | |
781 | TempChar = AsciiStrStr(Lang, ";");\r | |
782 | if (TempChar != NULL){\r | |
783 | *TempChar = CHAR_NULL;\r | |
784 | }\r | |
785 | } else {\r | |
786 | Lang = AllocateZeroPool(AsciiStrSize(Language));\r | |
787 | if (Lang == NULL) {\r | |
788 | return (EFI_OUT_OF_RESOURCES);\r | |
789 | }\r | |
790 | AsciiStrCpy(Lang, Language);\r | |
791 | }\r | |
792 | Status = CompName2->GetControllerName(CompName2, ParentControllerBuffer[LoopVar], DeviceHandle, Lang, &DeviceNameToReturn);\r | |
793 | FreePool(Lang);\r | |
794 | Lang = NULL;\r | |
795 | if (!EFI_ERROR(Status) && DeviceNameToReturn != NULL) {\r | |
796 | break;\r | |
797 | }\r | |
798 | \r | |
799 | \r | |
800 | \r | |
801 | }\r | |
802 | SHELL_FREE_NON_NULL(ParentDriverBuffer);\r | |
803 | if (!EFI_ERROR(Status) && DeviceNameToReturn != NULL) {\r | |
804 | break;\r | |
805 | }\r | |
806 | }\r | |
807 | SHELL_FREE_NON_NULL(ParentControllerBuffer);\r | |
808 | }\r | |
809 | //\r | |
810 | // dont return on fail since we will try device path if that bit is on\r | |
811 | //\r | |
a405b86d | 812 | if (DeviceNameToReturn != NULL){\r |
3c865f20 | 813 | ASSERT(BestDeviceName != NULL);\r |
a405b86d | 814 | StrnCatGrow(BestDeviceName, NULL, DeviceNameToReturn, 0);\r |
815 | return (EFI_SUCCESS);\r | |
816 | }\r | |
a405b86d | 817 | }\r |
818 | if ((Flags & EFI_DEVICE_NAME_USE_DEVICE_PATH) != 0) {\r | |
819 | Status = gBS->LocateProtocol(\r | |
820 | &gEfiDevicePathToTextProtocolGuid,\r | |
821 | NULL,\r | |
822 | (VOID**)&DevicePathToText);\r | |
823 | //\r | |
824 | // we now have the device path to text protocol\r | |
825 | //\r | |
826 | if (!EFI_ERROR(Status)) {\r | |
827 | Status = gBS->OpenProtocol(\r | |
828 | DeviceHandle,\r | |
829 | &gEfiDevicePathProtocolGuid,\r | |
830 | (VOID**)&DevicePath,\r | |
831 | gImageHandle,\r | |
832 | NULL,\r | |
833 | EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r | |
834 | if (!EFI_ERROR(Status)) {\r | |
835 | //\r | |
836 | // use device path to text on the device path\r | |
837 | //\r | |
838 | *BestDeviceName = DevicePathToText->ConvertDevicePathToText(DevicePath, TRUE, TRUE);\r | |
839 | return (EFI_SUCCESS);\r | |
840 | }\r | |
841 | }\r | |
842 | }\r | |
843 | //\r | |
844 | // none of the selected bits worked.\r | |
845 | //\r | |
846 | return (EFI_NOT_FOUND);\r | |
847 | }\r | |
848 | \r | |
849 | /**\r | |
850 | Opens the root directory of a device on a handle\r | |
851 | \r | |
852 | This function opens the root directory of a device and returns a file handle to it.\r | |
853 | \r | |
854 | @param DeviceHandle The handle of the device that contains the volume.\r | |
855 | @param FileHandle On exit, points to the file handle corresponding to the root directory on the\r | |
856 | device.\r | |
857 | \r | |
858 | @retval EFI_SUCCESS Root opened successfully.\r | |
859 | @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory\r | |
860 | could not be opened.\r | |
861 | @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.\r | |
862 | @retval EFI_DEVICE_ERROR The device had an error\r | |
863 | **/\r | |
864 | EFI_STATUS\r | |
865 | EFIAPI\r | |
866 | EfiShellOpenRootByHandle(\r | |
867 | IN EFI_HANDLE DeviceHandle,\r | |
868 | OUT SHELL_FILE_HANDLE *FileHandle\r | |
869 | )\r | |
870 | {\r | |
871 | EFI_STATUS Status;\r | |
872 | EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *SimpleFileSystem;\r | |
873 | EFI_FILE_PROTOCOL *RealFileHandle;\r | |
874 | EFI_DEVICE_PATH_PROTOCOL *DevPath;\r | |
875 | \r | |
876 | //\r | |
877 | // get the simple file system interface\r | |
878 | //\r | |
879 | Status = gBS->OpenProtocol(DeviceHandle,\r | |
880 | &gEfiSimpleFileSystemProtocolGuid,\r | |
881 | (VOID**)&SimpleFileSystem,\r | |
882 | gImageHandle,\r | |
883 | NULL,\r | |
884 | EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r | |
885 | if (EFI_ERROR(Status)) {\r | |
886 | return (EFI_NOT_FOUND);\r | |
887 | }\r | |
888 | \r | |
889 | Status = gBS->OpenProtocol(DeviceHandle,\r | |
890 | &gEfiDevicePathProtocolGuid,\r | |
891 | (VOID**)&DevPath,\r | |
892 | gImageHandle,\r | |
893 | NULL,\r | |
894 | EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r | |
895 | if (EFI_ERROR(Status)) {\r | |
896 | return (EFI_NOT_FOUND);\r | |
897 | }\r | |
898 | //\r | |
899 | // Open the root volume now...\r | |
900 | //\r | |
901 | Status = SimpleFileSystem->OpenVolume(SimpleFileSystem, &RealFileHandle);\r | |
902 | *FileHandle = ConvertEfiFileProtocolToShellHandle(RealFileHandle, EfiShellGetMapFromDevicePath(&DevPath));\r | |
903 | return (Status);\r | |
904 | }\r | |
905 | \r | |
906 | /**\r | |
907 | Opens the root directory of a device.\r | |
908 | \r | |
909 | This function opens the root directory of a device and returns a file handle to it.\r | |
910 | \r | |
911 | @param DevicePath Points to the device path corresponding to the device where the\r | |
912 | EFI_SIMPLE_FILE_SYSTEM_PROTOCOL is installed.\r | |
913 | @param FileHandle On exit, points to the file handle corresponding to the root directory on the\r | |
914 | device.\r | |
915 | \r | |
916 | @retval EFI_SUCCESS Root opened successfully.\r | |
917 | @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory\r | |
918 | could not be opened.\r | |
919 | @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.\r | |
920 | @retval EFI_DEVICE_ERROR The device had an error\r | |
8be0ba36 | 921 | @retval EFI_INVALID_PARAMETER FileHandle is NULL.\r |
a405b86d | 922 | **/\r |
923 | EFI_STATUS\r | |
924 | EFIAPI\r | |
925 | EfiShellOpenRoot(\r | |
926 | IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r | |
927 | OUT SHELL_FILE_HANDLE *FileHandle\r | |
928 | )\r | |
929 | {\r | |
930 | EFI_STATUS Status;\r | |
931 | EFI_HANDLE Handle;\r | |
932 | \r | |
8be0ba36 | 933 | if (FileHandle == NULL) {\r |
934 | return (EFI_INVALID_PARAMETER);\r | |
935 | }\r | |
936 | \r | |
a405b86d | 937 | //\r |
938 | // find the handle of the device with that device handle and the file system\r | |
939 | //\r | |
940 | ///@todo BlockIo?\r | |
941 | Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid,\r | |
942 | &DevicePath,\r | |
943 | &Handle);\r | |
944 | if (EFI_ERROR(Status)) {\r | |
945 | return (EFI_NOT_FOUND);\r | |
946 | }\r | |
947 | \r | |
948 | return (EfiShellOpenRootByHandle(Handle, FileHandle));\r | |
949 | }\r | |
950 | \r | |
951 | /**\r | |
952 | Returns whether any script files are currently being processed.\r | |
953 | \r | |
954 | @retval TRUE There is at least one script file active.\r | |
955 | @retval FALSE No script files are active now.\r | |
956 | \r | |
957 | **/\r | |
958 | BOOLEAN\r | |
959 | EFIAPI\r | |
960 | EfiShellBatchIsActive (\r | |
961 | VOID\r | |
962 | )\r | |
963 | {\r | |
964 | if (ShellCommandGetCurrentScriptFile() == NULL) {\r | |
965 | return (FALSE);\r | |
966 | }\r | |
967 | return (TRUE);\r | |
968 | }\r | |
969 | \r | |
970 | /**\r | |
971 | Worker function to open a file based on a device path. this will open the root\r | |
972 | of the volume and then traverse down to the file itself.\r | |
973 | \r | |
974 | @param DevicePath Device Path of the file.\r | |
975 | @param FileHandle Pointer to the file upon a successful return.\r | |
976 | @param OpenMode mode to open file in.\r | |
977 | @param Attributes the File Attributes to use when creating a new file.\r | |
978 | \r | |
979 | @retval EFI_SUCCESS the file is open and FileHandle is valid\r | |
980 | @retval EFI_UNSUPPORTED the device path cotained non-path elements\r | |
981 | @retval other an error ocurred.\r | |
982 | **/\r | |
983 | EFI_STATUS\r | |
984 | EFIAPI\r | |
985 | InternalOpenFileDevicePath(\r | |
986 | IN OUT EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r | |
987 | OUT SHELL_FILE_HANDLE *FileHandle,\r | |
988 | IN UINT64 OpenMode,\r | |
989 | IN UINT64 Attributes OPTIONAL\r | |
990 | )\r | |
991 | {\r | |
992 | EFI_STATUS Status;\r | |
993 | FILEPATH_DEVICE_PATH *FilePathNode;\r | |
994 | EFI_HANDLE Handle;\r | |
995 | SHELL_FILE_HANDLE ShellHandle;\r | |
996 | EFI_FILE_PROTOCOL *Handle1;\r | |
997 | EFI_FILE_PROTOCOL *Handle2;\r | |
998 | EFI_DEVICE_PATH_PROTOCOL *DpCopy;\r | |
8be0ba36 | 999 | FILEPATH_DEVICE_PATH *AlignedNode;\r |
a405b86d | 1000 | \r |
8be0ba36 | 1001 | if (FileHandle == NULL) {\r |
1002 | return (EFI_INVALID_PARAMETER);\r | |
1003 | }\r | |
1004 | *FileHandle = NULL;\r | |
1005 | Handle1 = NULL;\r | |
1006 | Handle2 = NULL;\r | |
1007 | Handle = NULL;\r | |
1008 | DpCopy = DevicePath;\r | |
1009 | ShellHandle = NULL;\r | |
1010 | FilePathNode = NULL;\r | |
1011 | AlignedNode = NULL;\r | |
a405b86d | 1012 | \r |
1013 | Status = EfiShellOpenRoot(DevicePath, &ShellHandle);\r | |
1014 | \r | |
1015 | if (!EFI_ERROR(Status)) {\r | |
1016 | Handle1 = ConvertShellHandleToEfiFileProtocol(ShellHandle);\r | |
c154b997 | 1017 | if (Handle1 != NULL) {\r |
a405b86d | 1018 | //\r |
c154b997 | 1019 | // chop off the begining part before the file system part...\r |
a405b86d | 1020 | //\r |
c154b997 | 1021 | ///@todo BlockIo?\r |
1022 | Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid,\r | |
1023 | &DevicePath,\r | |
1024 | &Handle);\r | |
1025 | if (!EFI_ERROR(Status)) {\r | |
a405b86d | 1026 | //\r |
c154b997 | 1027 | // To access as a file system, the file path should only\r |
1028 | // contain file path components. Follow the file path nodes\r | |
1029 | // and find the target file\r | |
a405b86d | 1030 | //\r |
c154b997 | 1031 | for ( FilePathNode = (FILEPATH_DEVICE_PATH *)DevicePath\r |
1032 | ; !IsDevicePathEnd (&FilePathNode->Header)\r | |
1033 | ; FilePathNode = (FILEPATH_DEVICE_PATH *) NextDevicePathNode (&FilePathNode->Header)\r | |
1034 | ){\r | |
1035 | SHELL_FREE_NON_NULL(AlignedNode);\r | |
1036 | AlignedNode = AllocateCopyPool (DevicePathNodeLength(FilePathNode), FilePathNode);\r | |
a405b86d | 1037 | //\r |
c154b997 | 1038 | // For file system access each node should be a file path component\r |
a405b86d | 1039 | //\r |
c154b997 | 1040 | if (DevicePathType (&FilePathNode->Header) != MEDIA_DEVICE_PATH ||\r |
1041 | DevicePathSubType (&FilePathNode->Header) != MEDIA_FILEPATH_DP\r | |
1042 | ) {\r | |
1043 | Status = EFI_UNSUPPORTED;\r | |
1044 | break;\r | |
1045 | }\r | |
a405b86d | 1046 | \r |
1047 | //\r | |
c154b997 | 1048 | // Open this file path node\r |
a405b86d | 1049 | //\r |
c154b997 | 1050 | Handle2 = Handle1;\r |
1051 | Handle1 = NULL;\r | |
1052 | \r | |
a405b86d | 1053 | //\r |
c154b997 | 1054 | // if this is the last node in the DevicePath always create (if that was requested).\r |
a405b86d | 1055 | //\r |
c154b997 | 1056 | if (IsDevicePathEnd ((NextDevicePathNode (&FilePathNode->Header)))) {\r |
a405b86d | 1057 | Status = Handle2->Open (\r |
1058 | Handle2,\r | |
1059 | &Handle1,\r | |
8be0ba36 | 1060 | AlignedNode->PathName,\r |
a405b86d | 1061 | OpenMode,\r |
1062 | Attributes\r | |
1063 | );\r | |
c154b997 | 1064 | } else {\r |
1065 | \r | |
1066 | //\r | |
1067 | // This is not the last node and we dont want to 'create' existing\r | |
1068 | // directory entries...\r | |
1069 | //\r | |
1070 | \r | |
1071 | //\r | |
1072 | // open without letting it create\r | |
1073 | // prevents error on existing files/directories\r | |
1074 | //\r | |
1075 | Status = Handle2->Open (\r | |
1076 | Handle2,\r | |
1077 | &Handle1,\r | |
1078 | AlignedNode->PathName,\r | |
1079 | OpenMode &~EFI_FILE_MODE_CREATE,\r | |
1080 | Attributes\r | |
1081 | );\r | |
1082 | //\r | |
1083 | // if above failed now open and create the 'item'\r | |
1084 | // if OpenMode EFI_FILE_MODE_CREATE bit was on (but disabled above)\r | |
1085 | //\r | |
1086 | if ((EFI_ERROR (Status)) && ((OpenMode & EFI_FILE_MODE_CREATE) != 0)) {\r | |
1087 | Status = Handle2->Open (\r | |
1088 | Handle2,\r | |
1089 | &Handle1,\r | |
1090 | AlignedNode->PathName,\r | |
1091 | OpenMode,\r | |
1092 | Attributes\r | |
1093 | );\r | |
1094 | }\r | |
a405b86d | 1095 | }\r |
c154b997 | 1096 | //\r |
1097 | // Close the last node\r | |
1098 | //\r | |
1099 | ShellInfoObject.NewEfiShellProtocol->CloseFile (Handle2);\r | |
a405b86d | 1100 | \r |
c154b997 | 1101 | //\r |
1102 | // If there's been an error, stop\r | |
1103 | //\r | |
1104 | if (EFI_ERROR (Status)) {\r | |
1105 | break;\r | |
1106 | }\r | |
1107 | } // for loop\r | |
1108 | }\r | |
a405b86d | 1109 | }\r |
1110 | }\r | |
8be0ba36 | 1111 | SHELL_FREE_NON_NULL(AlignedNode);\r |
a405b86d | 1112 | if (EFI_ERROR(Status)) {\r |
1113 | if (Handle1 != NULL) {\r | |
8be0ba36 | 1114 | ShellInfoObject.NewEfiShellProtocol->CloseFile(Handle1);\r |
a405b86d | 1115 | }\r |
1116 | } else {\r | |
1117 | *FileHandle = ConvertEfiFileProtocolToShellHandle(Handle1, ShellFileHandleGetPath(ShellHandle));\r | |
1118 | }\r | |
1119 | return (Status);\r | |
1120 | }\r | |
1121 | \r | |
1122 | /**\r | |
1123 | Creates a file or directory by name.\r | |
1124 | \r | |
1125 | This function creates an empty new file or directory with the specified attributes and\r | |
1126 | returns the new file's handle. If the file already exists and is read-only, then\r | |
1127 | EFI_INVALID_PARAMETER will be returned.\r | |
1128 | \r | |
1129 | If the file already existed, it is truncated and its attributes updated. If the file is\r | |
1130 | created successfully, the FileHandle is the file's handle, else, the FileHandle is NULL.\r | |
1131 | \r | |
1132 | If the file name begins with >v, then the file handle which is returned refers to the\r | |
1133 | shell environment variable with the specified name. If the shell environment variable\r | |
1134 | already exists and is non-volatile then EFI_INVALID_PARAMETER is returned.\r | |
1135 | \r | |
1136 | @param FileName Pointer to NULL-terminated file path\r | |
1137 | @param FileAttribs The new file's attrbiutes. the different attributes are\r | |
1138 | described in EFI_FILE_PROTOCOL.Open().\r | |
1139 | @param FileHandle On return, points to the created file handle or directory's handle\r | |
1140 | \r | |
1141 | @retval EFI_SUCCESS The file was opened. FileHandle points to the new file's handle.\r | |
1142 | @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r | |
1143 | @retval EFI_UNSUPPORTED could not open the file path\r | |
1144 | @retval EFI_NOT_FOUND the specified file could not be found on the devide, or could not\r | |
1145 | file the file system on the device.\r | |
1146 | @retval EFI_NO_MEDIA the device has no medium.\r | |
1147 | @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no\r | |
1148 | longer supported.\r | |
1149 | @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according\r | |
1150 | the DirName.\r | |
1151 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
1152 | @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write\r | |
1153 | when the media is write-protected.\r | |
1154 | @retval EFI_ACCESS_DENIED The service denied access to the file.\r | |
1155 | @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file.\r | |
1156 | @retval EFI_VOLUME_FULL The volume is full.\r | |
1157 | **/\r | |
1158 | EFI_STATUS\r | |
1159 | EFIAPI\r | |
1160 | EfiShellCreateFile(\r | |
1161 | IN CONST CHAR16 *FileName,\r | |
1162 | IN UINT64 FileAttribs,\r | |
1163 | OUT SHELL_FILE_HANDLE *FileHandle\r | |
1164 | )\r | |
1165 | {\r | |
1166 | EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r | |
1167 | EFI_STATUS Status;\r | |
1168 | \r | |
1169 | //\r | |
1170 | // Is this for an environment variable\r | |
1171 | // do we start with >v\r | |
1172 | //\r | |
1173 | if (StrStr(FileName, L">v") == FileName) {\r | |
1174 | if (!IsVolatileEnv(FileName+2)) {\r | |
1175 | return (EFI_INVALID_PARAMETER);\r | |
1176 | }\r | |
1177 | *FileHandle = CreateFileInterfaceEnv(FileName+2);\r | |
1178 | return (EFI_SUCCESS);\r | |
1179 | }\r | |
1180 | \r | |
1181 | //\r | |
1182 | // We are opening a regular file.\r | |
1183 | //\r | |
1184 | DevicePath = EfiShellGetDevicePathFromFilePath(FileName);\r | |
1185 | if (DevicePath == NULL) {\r | |
1186 | return (EFI_NOT_FOUND);\r | |
1187 | }\r | |
1188 | \r | |
1189 | Status = InternalOpenFileDevicePath(DevicePath, FileHandle, EFI_FILE_MODE_READ|EFI_FILE_MODE_WRITE|EFI_FILE_MODE_CREATE, FileAttribs); // 0 = no specific file attributes\r | |
1190 | FreePool(DevicePath);\r | |
1191 | \r | |
1192 | return(Status);\r | |
1193 | }\r | |
1194 | \r | |
1195 | /**\r | |
1196 | Opens a file or a directory by file name.\r | |
1197 | \r | |
1198 | This function opens the specified file in the specified OpenMode and returns a file\r | |
1199 | handle.\r | |
1200 | If the file name begins with >v, then the file handle which is returned refers to the\r | |
1201 | shell environment variable with the specified name. If the shell environment variable\r | |
1202 | exists, is non-volatile and the OpenMode indicates EFI_FILE_MODE_WRITE, then\r | |
1203 | EFI_INVALID_PARAMETER is returned.\r | |
1204 | \r | |
1205 | If the file name is >i, then the file handle which is returned refers to the standard\r | |
1206 | input. If the OpenMode indicates EFI_FILE_MODE_WRITE, then EFI_INVALID_PARAMETER\r | |
1207 | is returned.\r | |
1208 | \r | |
1209 | If the file name is >o, then the file handle which is returned refers to the standard\r | |
1210 | output. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER\r | |
1211 | is returned.\r | |
1212 | \r | |
1213 | If the file name is >e, then the file handle which is returned refers to the standard\r | |
1214 | error. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER\r | |
1215 | is returned.\r | |
1216 | \r | |
1217 | If the file name is NUL, then the file handle that is returned refers to the standard NUL\r | |
1218 | file. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER is\r | |
1219 | returned.\r | |
1220 | \r | |
1221 | If return EFI_SUCCESS, the FileHandle is the opened file's handle, else, the\r | |
1222 | FileHandle is NULL.\r | |
1223 | \r | |
1224 | @param FileName Points to the NULL-terminated UCS-2 encoded file name.\r | |
1225 | @param FileHandle On return, points to the file handle.\r | |
1226 | @param OpenMode File open mode. Either EFI_FILE_MODE_READ or\r | |
1227 | EFI_FILE_MODE_WRITE from section 12.4 of the UEFI\r | |
1228 | Specification.\r | |
1229 | @retval EFI_SUCCESS The file was opened. FileHandle has the opened file's handle.\r | |
1230 | @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value. FileHandle is NULL.\r | |
1231 | @retval EFI_UNSUPPORTED Could not open the file path. FileHandle is NULL.\r | |
1232 | @retval EFI_NOT_FOUND The specified file could not be found on the device or the file\r | |
1233 | system could not be found on the device. FileHandle is NULL.\r | |
1234 | @retval EFI_NO_MEDIA The device has no medium. FileHandle is NULL.\r | |
1235 | @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no\r | |
1236 | longer supported. FileHandle is NULL.\r | |
1237 | @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according\r | |
1238 | the FileName. FileHandle is NULL.\r | |
1239 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted. FileHandle is NULL.\r | |
1240 | @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write\r | |
1241 | when the media is write-protected. FileHandle is NULL.\r | |
1242 | @retval EFI_ACCESS_DENIED The service denied access to the file. FileHandle is NULL.\r | |
1243 | @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file. FileHandle\r | |
1244 | is NULL.\r | |
1245 | @retval EFI_VOLUME_FULL The volume is full. FileHandle is NULL.\r | |
1246 | **/\r | |
1247 | EFI_STATUS\r | |
1248 | EFIAPI\r | |
1249 | EfiShellOpenFileByName(\r | |
1250 | IN CONST CHAR16 *FileName,\r | |
1251 | OUT SHELL_FILE_HANDLE *FileHandle,\r | |
1252 | IN UINT64 OpenMode\r | |
1253 | )\r | |
1254 | {\r | |
1255 | EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r | |
1256 | EFI_STATUS Status;\r | |
1257 | \r | |
1258 | *FileHandle = NULL;\r | |
1259 | \r | |
1260 | //\r | |
1261 | // Is this for StdIn\r | |
1262 | //\r | |
1263 | if (StrCmp(FileName, L">i") == 0) {\r | |
1264 | //\r | |
1265 | // make sure not writing to StdIn\r | |
1266 | //\r | |
1267 | if ((OpenMode & EFI_FILE_MODE_WRITE) != 0) {\r | |
1268 | return (EFI_INVALID_PARAMETER);\r | |
1269 | }\r | |
1270 | *FileHandle = ShellInfoObject.NewShellParametersProtocol->StdIn;\r | |
1271 | ASSERT(*FileHandle != NULL);\r | |
1272 | return (EFI_SUCCESS);\r | |
1273 | }\r | |
1274 | \r | |
1275 | //\r | |
1276 | // Is this for StdOut\r | |
1277 | //\r | |
1278 | if (StrCmp(FileName, L">o") == 0) {\r | |
1279 | //\r | |
1280 | // make sure not writing to StdIn\r | |
1281 | //\r | |
1282 | if ((OpenMode & EFI_FILE_MODE_READ) != 0) {\r | |
1283 | return (EFI_INVALID_PARAMETER);\r | |
1284 | }\r | |
1285 | *FileHandle = &FileInterfaceStdOut;\r | |
1286 | return (EFI_SUCCESS);\r | |
1287 | }\r | |
1288 | \r | |
1289 | //\r | |
1290 | // Is this for NUL file\r | |
1291 | //\r | |
1292 | if (StrCmp(FileName, L"NUL") == 0) {\r | |
1293 | *FileHandle = &FileInterfaceNulFile;\r | |
1294 | return (EFI_SUCCESS);\r | |
1295 | }\r | |
1296 | \r | |
1297 | //\r | |
1298 | // Is this for StdErr\r | |
1299 | //\r | |
1300 | if (StrCmp(FileName, L">e") == 0) {\r | |
1301 | //\r | |
1302 | // make sure not writing to StdIn\r | |
1303 | //\r | |
1304 | if ((OpenMode & EFI_FILE_MODE_READ) != 0) {\r | |
1305 | return (EFI_INVALID_PARAMETER);\r | |
1306 | }\r | |
1307 | *FileHandle = &FileInterfaceStdErr;\r | |
1308 | return (EFI_SUCCESS);\r | |
1309 | }\r | |
1310 | \r | |
1311 | //\r | |
1312 | // Is this for an environment variable\r | |
1313 | // do we start with >v\r | |
1314 | //\r | |
1315 | if (StrStr(FileName, L">v") == FileName) {\r | |
1316 | if (!IsVolatileEnv(FileName+2) &&\r | |
1317 | ((OpenMode & EFI_FILE_MODE_WRITE) != 0)) {\r | |
1318 | return (EFI_INVALID_PARAMETER);\r | |
1319 | }\r | |
1320 | *FileHandle = CreateFileInterfaceEnv(FileName+2);\r | |
1321 | return (EFI_SUCCESS);\r | |
1322 | }\r | |
1323 | \r | |
1324 | //\r | |
1325 | // We are opening a regular file.\r | |
1326 | //\r | |
1327 | DevicePath = EfiShellGetDevicePathFromFilePath(FileName);\r | |
1328 | // DEBUG_CODE(InternalShellProtocolDebugPrintMessage (NULL, DevicePath););\r | |
1329 | if (DevicePath == NULL) {\r | |
1330 | return (EFI_NOT_FOUND);\r | |
1331 | }\r | |
1332 | \r | |
1333 | //\r | |
1334 | // Copy the device path, open the file, then free the memory\r | |
1335 | //\r | |
1336 | Status = InternalOpenFileDevicePath(DevicePath, FileHandle, OpenMode, 0); // 0 = no specific file attributes\r | |
1337 | FreePool(DevicePath);\r | |
1338 | \r | |
1339 | return(Status);\r | |
1340 | }\r | |
1341 | \r | |
1342 | /**\r | |
1343 | Deletes the file specified by the file name.\r | |
1344 | \r | |
1345 | This function deletes a file.\r | |
1346 | \r | |
1347 | @param FileName Points to the NULL-terminated file name.\r | |
1348 | \r | |
1349 | @retval EFI_SUCCESS The file was closed and deleted, and the handle was closed.\r | |
1350 | @retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted.\r | |
1351 | @sa EfiShellCreateFile\r | |
1352 | **/\r | |
1353 | EFI_STATUS\r | |
1354 | EFIAPI\r | |
1355 | EfiShellDeleteFileByName(\r | |
1356 | IN CONST CHAR16 *FileName\r | |
1357 | )\r | |
1358 | {\r | |
1359 | SHELL_FILE_HANDLE FileHandle;\r | |
1360 | EFI_STATUS Status;\r | |
1361 | \r | |
1362 | //\r | |
1363 | // get a handle to the file\r | |
1364 | //\r | |
1365 | Status = EfiShellCreateFile(FileName,\r | |
1366 | 0,\r | |
1367 | &FileHandle);\r | |
1368 | if (EFI_ERROR(Status)) {\r | |
1369 | return (Status);\r | |
1370 | }\r | |
1371 | //\r | |
1372 | // now delete the file\r | |
1373 | //\r | |
1374 | return (ShellInfoObject.NewEfiShellProtocol->DeleteFile(FileHandle));\r | |
1375 | }\r | |
1376 | \r | |
1377 | /**\r | |
1378 | Disables the page break output mode.\r | |
1379 | **/\r | |
1380 | VOID\r | |
1381 | EFIAPI\r | |
1382 | EfiShellDisablePageBreak (\r | |
1383 | VOID\r | |
1384 | )\r | |
1385 | {\r | |
1386 | ShellInfoObject.PageBreakEnabled = FALSE;\r | |
1387 | }\r | |
1388 | \r | |
1389 | /**\r | |
1390 | Enables the page break output mode.\r | |
1391 | **/\r | |
1392 | VOID\r | |
1393 | EFIAPI\r | |
1394 | EfiShellEnablePageBreak (\r | |
1395 | VOID\r | |
1396 | )\r | |
1397 | {\r | |
1398 | ShellInfoObject.PageBreakEnabled = TRUE;\r | |
1399 | }\r | |
1400 | \r | |
1401 | /**\r | |
1402 | internal worker function to load and run an image via device path.\r | |
1403 | \r | |
1404 | @param ParentImageHandle A handle of the image that is executing the specified\r | |
1405 | command line.\r | |
1406 | @param DevicePath device path of the file to execute\r | |
1407 | @param CommandLine Points to the NULL-terminated UCS-2 encoded string\r | |
1408 | containing the command line. If NULL then the command-\r | |
1409 | line will be empty.\r | |
1410 | @param Environment Points to a NULL-terminated array of environment\r | |
1411 | variables with the format 'x=y', where x is the\r | |
1412 | environment variable name and y is the value. If this\r | |
1413 | is NULL, then the current shell environment is used.\r | |
1414 | @param StatusCode Points to the status code returned by the command.\r | |
1415 | \r | |
1416 | @retval EFI_SUCCESS The command executed successfully. The status code\r | |
1417 | returned by the command is pointed to by StatusCode.\r | |
1418 | @retval EFI_INVALID_PARAMETER The parameters are invalid.\r | |
1419 | @retval EFI_OUT_OF_RESOURCES Out of resources.\r | |
1420 | @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.\r | |
1421 | **/\r | |
1422 | EFI_STATUS\r | |
1423 | EFIAPI\r | |
1424 | InternalShellExecuteDevicePath(\r | |
1425 | IN CONST EFI_HANDLE *ParentImageHandle,\r | |
1426 | IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r | |
1427 | IN CONST CHAR16 *CommandLine OPTIONAL,\r | |
1428 | IN CONST CHAR16 **Environment OPTIONAL,\r | |
1429 | OUT EFI_STATUS *StatusCode OPTIONAL\r | |
1430 | )\r | |
1431 | {\r | |
1432 | EFI_STATUS Status;\r | |
1433 | EFI_HANDLE NewHandle;\r | |
1434 | EFI_LOADED_IMAGE_PROTOCOL *LoadedImage;\r | |
1435 | LIST_ENTRY OrigEnvs;\r | |
1436 | EFI_SHELL_PARAMETERS_PROTOCOL ShellParamsProtocol;\r | |
1437 | \r | |
1438 | if (ParentImageHandle == NULL) {\r | |
1439 | return (EFI_INVALID_PARAMETER);\r | |
1440 | }\r | |
1441 | \r | |
1442 | InitializeListHead(&OrigEnvs);\r | |
1443 | \r | |
1444 | NewHandle = NULL;\r | |
1445 | \r | |
1446 | //\r | |
1447 | // Load the image with:\r | |
1448 | // FALSE - not from boot manager and NULL, 0 being not already in memory\r | |
1449 | //\r | |
1450 | Status = gBS->LoadImage(\r | |
1451 | FALSE,\r | |
1452 | *ParentImageHandle,\r | |
1453 | (EFI_DEVICE_PATH_PROTOCOL*)DevicePath,\r | |
1454 | NULL,\r | |
1455 | 0,\r | |
1456 | &NewHandle);\r | |
1457 | \r | |
1458 | if (EFI_ERROR(Status)) {\r | |
1459 | if (NewHandle != NULL) {\r | |
1460 | gBS->UnloadImage(NewHandle);\r | |
1461 | }\r | |
1462 | return (Status);\r | |
1463 | }\r | |
1464 | Status = gBS->OpenProtocol(\r | |
1465 | NewHandle,\r | |
1466 | &gEfiLoadedImageProtocolGuid,\r | |
1467 | (VOID**)&LoadedImage,\r | |
1468 | gImageHandle,\r | |
1469 | NULL,\r | |
1470 | EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r | |
1471 | \r | |
1472 | if (!EFI_ERROR(Status)) {\r | |
1473 | ASSERT(LoadedImage->LoadOptionsSize == 0);\r | |
1474 | if (CommandLine != NULL) {\r | |
1475 | LoadedImage->LoadOptionsSize = (UINT32)StrSize(CommandLine);\r | |
1476 | LoadedImage->LoadOptions = (VOID*)CommandLine;\r | |
1477 | }\r | |
1478 | \r | |
1479 | //\r | |
1480 | // Save our current environment settings for later restoration if necessary\r | |
1481 | //\r | |
1482 | if (Environment != NULL) {\r | |
1483 | Status = GetEnvironmentVariableList(&OrigEnvs);\r | |
1484 | if (!EFI_ERROR(Status)) {\r | |
1485 | Status = SetEnvironmentVariables(Environment);\r | |
1486 | }\r | |
1487 | }\r | |
1488 | \r | |
1489 | //\r | |
1490 | // Initialize and install a shell parameters protocol on the image.\r | |
1491 | //\r | |
1492 | ShellParamsProtocol.StdIn = ShellInfoObject.NewShellParametersProtocol->StdIn;\r | |
1493 | ShellParamsProtocol.StdOut = ShellInfoObject.NewShellParametersProtocol->StdOut;\r | |
1494 | ShellParamsProtocol.StdErr = ShellInfoObject.NewShellParametersProtocol->StdErr;\r | |
1495 | Status = UpdateArgcArgv(&ShellParamsProtocol, CommandLine, NULL, NULL);\r | |
1496 | ASSERT_EFI_ERROR(Status);\r | |
1497 | Status = gBS->InstallProtocolInterface(&NewHandle, &gEfiShellParametersProtocolGuid, EFI_NATIVE_INTERFACE, &ShellParamsProtocol);\r | |
1498 | ASSERT_EFI_ERROR(Status);\r | |
1499 | \r | |
1500 | ///@todo initialize and install ShellInterface protocol on the new image for compatibility if - PcdGetBool(PcdShellSupportOldProtocols)\r | |
1501 | \r | |
1502 | //\r | |
1503 | // now start the image and if the caller wanted the return code pass it to them...\r | |
1504 | //\r | |
1505 | if (!EFI_ERROR(Status)) {\r | |
1506 | if (StatusCode != NULL) {\r | |
1507 | *StatusCode = gBS->StartImage(NewHandle, NULL, NULL);\r | |
1508 | } else {\r | |
1509 | Status = gBS->StartImage(NewHandle, NULL, NULL);\r | |
1510 | }\r | |
1511 | }\r | |
1512 | \r | |
1513 | //\r | |
1514 | // Cleanup (and dont overwrite errors)\r | |
1515 | //\r | |
1516 | if (EFI_ERROR(Status)) {\r | |
1517 | gBS->UninstallProtocolInterface(NewHandle, &gEfiShellParametersProtocolGuid, &ShellParamsProtocol);\r | |
1518 | } else {\r | |
1519 | Status = gBS->UninstallProtocolInterface(NewHandle, &gEfiShellParametersProtocolGuid, &ShellParamsProtocol);\r | |
1520 | ASSERT_EFI_ERROR(Status);\r | |
1521 | }\r | |
1522 | }\r | |
1523 | \r | |
1524 | if (!IsListEmpty(&OrigEnvs)) {\r | |
1525 | if (EFI_ERROR(Status)) {\r | |
1526 | SetEnvironmentVariableList(&OrigEnvs);\r | |
1527 | } else {\r | |
1528 | Status = SetEnvironmentVariableList(&OrigEnvs);\r | |
1529 | }\r | |
1530 | }\r | |
1531 | \r | |
1532 | return(Status);\r | |
1533 | }\r | |
1534 | /**\r | |
1535 | Execute the command line.\r | |
1536 | \r | |
1537 | This function creates a nested instance of the shell and executes the specified\r | |
1538 | command (CommandLine) with the specified environment (Environment). Upon return,\r | |
1539 | the status code returned by the specified command is placed in StatusCode.\r | |
1540 | \r | |
1541 | If Environment is NULL, then the current environment is used and all changes made\r | |
1542 | by the commands executed will be reflected in the current environment. If the\r | |
1543 | Environment is non-NULL, then the changes made will be discarded.\r | |
1544 | \r | |
1545 | The CommandLine is executed from the current working directory on the current\r | |
1546 | device.\r | |
1547 | \r | |
1548 | @param ParentImageHandle A handle of the image that is executing the specified\r | |
1549 | command line.\r | |
1550 | @param CommandLine Points to the NULL-terminated UCS-2 encoded string\r | |
1551 | containing the command line. If NULL then the command-\r | |
1552 | line will be empty.\r | |
1553 | @param Environment Points to a NULL-terminated array of environment\r | |
1554 | variables with the format 'x=y', where x is the\r | |
1555 | environment variable name and y is the value. If this\r | |
1556 | is NULL, then the current shell environment is used.\r | |
1557 | @param StatusCode Points to the status code returned by the command.\r | |
1558 | \r | |
1559 | @retval EFI_SUCCESS The command executed successfully. The status code\r | |
1560 | returned by the command is pointed to by StatusCode.\r | |
1561 | @retval EFI_INVALID_PARAMETER The parameters are invalid.\r | |
1562 | @retval EFI_OUT_OF_RESOURCES Out of resources.\r | |
1563 | @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.\r | |
1564 | @retval EFI_UNSUPPORTED The support level required for this function is not present.\r | |
1565 | \r | |
1566 | @sa InternalShellExecuteDevicePath\r | |
1567 | **/\r | |
1568 | EFI_STATUS\r | |
1569 | EFIAPI\r | |
1570 | EfiShellExecute(\r | |
1571 | IN EFI_HANDLE *ParentImageHandle,\r | |
1572 | IN CHAR16 *CommandLine OPTIONAL,\r | |
1573 | IN CHAR16 **Environment OPTIONAL,\r | |
1574 | OUT EFI_STATUS *StatusCode OPTIONAL\r | |
1575 | )\r | |
1576 | {\r | |
1577 | EFI_STATUS Status;\r | |
1578 | CHAR16 *Temp;\r | |
1579 | EFI_DEVICE_PATH_PROTOCOL *DevPath;\r | |
1580 | UINTN Size;\r | |
1581 | \r | |
1582 | if ((PcdGet8(PcdShellSupportLevel) < 1)) {\r | |
1583 | return (EFI_UNSUPPORTED);\r | |
1584 | }\r | |
1585 | \r | |
1586 | DevPath = AppendDevicePath (ShellInfoObject.ImageDevPath, ShellInfoObject.FileDevPath);\r | |
1587 | \r | |
1588 | DEBUG_CODE_BEGIN();\r | |
1589 | Temp = gDevPathToText->ConvertDevicePathToText(ShellInfoObject.FileDevPath, TRUE, TRUE);\r | |
1590 | FreePool(Temp);\r | |
1591 | Temp = gDevPathToText->ConvertDevicePathToText(ShellInfoObject.ImageDevPath, TRUE, TRUE);\r | |
1592 | FreePool(Temp);\r | |
1593 | Temp = gDevPathToText->ConvertDevicePathToText(DevPath, TRUE, TRUE);\r | |
1594 | FreePool(Temp);\r | |
1595 | DEBUG_CODE_END();\r | |
1596 | \r | |
1597 | Temp = NULL;\r | |
1598 | Size = 0;\r | |
1599 | ASSERT((Temp == NULL && Size == 0) || (Temp != NULL));\r | |
1600 | StrnCatGrow(&Temp, &Size, L"Shell.efi ", 0);\r | |
1601 | StrnCatGrow(&Temp, &Size, CommandLine, 0);\r | |
1602 | \r | |
1603 | Status = InternalShellExecuteDevicePath(\r | |
1604 | ParentImageHandle,\r | |
1605 | DevPath,\r | |
1606 | Temp,\r | |
1607 | (CONST CHAR16**)Environment,\r | |
1608 | StatusCode);\r | |
1609 | \r | |
1610 | //\r | |
1611 | // de-allocate and return\r | |
1612 | //\r | |
1613 | FreePool(DevPath);\r | |
1614 | FreePool(Temp);\r | |
1615 | return(Status);\r | |
1616 | }\r | |
1617 | \r | |
1618 | /**\r | |
1619 | Utility cleanup function for EFI_SHELL_FILE_INFO objects.\r | |
1620 | \r | |
1621 | 1) frees all pointers (non-NULL)\r | |
1622 | 2) Closes the SHELL_FILE_HANDLE\r | |
1623 | \r | |
1624 | @param FileListNode pointer to the list node to free\r | |
1625 | **/\r | |
1626 | VOID\r | |
1627 | EFIAPI\r | |
1628 | InternalFreeShellFileInfoNode(\r | |
1629 | IN EFI_SHELL_FILE_INFO *FileListNode\r | |
1630 | )\r | |
1631 | {\r | |
1632 | if (FileListNode->Info != NULL) {\r | |
1633 | FreePool((VOID*)FileListNode->Info);\r | |
1634 | }\r | |
1635 | if (FileListNode->FileName != NULL) {\r | |
1636 | FreePool((VOID*)FileListNode->FileName);\r | |
1637 | }\r | |
1638 | if (FileListNode->FullName != NULL) {\r | |
1639 | FreePool((VOID*)FileListNode->FullName);\r | |
1640 | }\r | |
1641 | if (FileListNode->Handle != NULL) {\r | |
1642 | ShellInfoObject.NewEfiShellProtocol->CloseFile(FileListNode->Handle);\r | |
1643 | }\r | |
1644 | FreePool(FileListNode);\r | |
1645 | }\r | |
1646 | /**\r | |
1647 | Frees the file list.\r | |
1648 | \r | |
1649 | This function cleans up the file list and any related data structures. It has no\r | |
1650 | impact on the files themselves.\r | |
1651 | \r | |
1652 | @param FileList The file list to free. Type EFI_SHELL_FILE_INFO is\r | |
1653 | defined in OpenFileList()\r | |
1654 | \r | |
1655 | @retval EFI_SUCCESS Free the file list successfully.\r | |
1656 | @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;\r | |
1657 | **/\r | |
1658 | EFI_STATUS\r | |
1659 | EFIAPI\r | |
1660 | EfiShellFreeFileList(\r | |
1661 | IN EFI_SHELL_FILE_INFO **FileList\r | |
1662 | )\r | |
1663 | {\r | |
1664 | EFI_SHELL_FILE_INFO *ShellFileListItem;\r | |
1665 | \r | |
1666 | if (FileList == NULL || *FileList == NULL) {\r | |
1667 | return (EFI_INVALID_PARAMETER);\r | |
1668 | }\r | |
1669 | \r | |
1670 | for ( ShellFileListItem = (EFI_SHELL_FILE_INFO*)GetFirstNode(&(*FileList)->Link)\r | |
1671 | ; !IsListEmpty(&(*FileList)->Link)\r | |
1672 | ; ShellFileListItem = (EFI_SHELL_FILE_INFO*)GetFirstNode(&(*FileList)->Link)\r | |
1673 | ){\r | |
1674 | RemoveEntryList(&ShellFileListItem->Link);\r | |
1675 | InternalFreeShellFileInfoNode(ShellFileListItem);\r | |
1676 | }\r | |
1677 | return(EFI_SUCCESS);\r | |
1678 | }\r | |
1679 | \r | |
1680 | /**\r | |
1681 | Deletes the duplicate file names files in the given file list.\r | |
1682 | \r | |
1683 | This function deletes the reduplicate files in the given file list.\r | |
1684 | \r | |
1685 | @param FileList A pointer to the first entry in the file list.\r | |
1686 | \r | |
1687 | @retval EFI_SUCCESS Always success.\r | |
1688 | @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;\r | |
1689 | **/\r | |
1690 | EFI_STATUS\r | |
1691 | EFIAPI\r | |
1692 | EfiShellRemoveDupInFileList(\r | |
1693 | IN EFI_SHELL_FILE_INFO **FileList\r | |
1694 | )\r | |
1695 | {\r | |
1696 | EFI_SHELL_FILE_INFO *ShellFileListItem;\r | |
1697 | EFI_SHELL_FILE_INFO *ShellFileListItem2;\r | |
1698 | \r | |
1699 | if (FileList == NULL || *FileList == NULL) {\r | |
1700 | return (EFI_INVALID_PARAMETER);\r | |
1701 | }\r | |
1702 | for ( ShellFileListItem = (EFI_SHELL_FILE_INFO*)GetFirstNode(&(*FileList)->Link)\r | |
1703 | ; !IsNull(&(*FileList)->Link, &ShellFileListItem->Link)\r | |
1704 | ; ShellFileListItem = (EFI_SHELL_FILE_INFO*)GetNextNode(&(*FileList)->Link, &ShellFileListItem->Link)\r | |
1705 | ){\r | |
1706 | for ( ShellFileListItem2 = (EFI_SHELL_FILE_INFO*)GetNextNode(&(*FileList)->Link, &ShellFileListItem->Link)\r | |
1707 | ; !IsNull(&(*FileList)->Link, &ShellFileListItem2->Link)\r | |
1708 | ; ShellFileListItem2 = (EFI_SHELL_FILE_INFO*)GetNextNode(&(*FileList)->Link, &ShellFileListItem2->Link)\r | |
1709 | ){\r | |
1710 | if (gUnicodeCollation->StriColl(\r | |
1711 | gUnicodeCollation,\r | |
1712 | (CHAR16*)ShellFileListItem->FullName,\r | |
1713 | (CHAR16*)ShellFileListItem2->FullName) == 0\r | |
1714 | ){\r | |
1715 | RemoveEntryList(&ShellFileListItem2->Link);\r | |
1716 | InternalFreeShellFileInfoNode(ShellFileListItem2);\r | |
1717 | }\r | |
1718 | }\r | |
1719 | }\r | |
1720 | return (EFI_SUCCESS);\r | |
1721 | }\r | |
1722 | /**\r | |
1723 | Allocates and duplicates a EFI_SHELL_FILE_INFO node.\r | |
1724 | \r | |
1725 | @param[in] Node The node to copy from.\r | |
1726 | @param[in] Save TRUE to set Node->Handle to NULL, FALSE otherwise.\r | |
1727 | \r | |
1728 | @retval NULL a memory allocation error ocurred\r | |
1729 | @return != NULL a pointer to the new node\r | |
1730 | **/\r | |
1731 | EFI_SHELL_FILE_INFO*\r | |
1732 | EFIAPI\r | |
1733 | InternalDuplicateShellFileInfo(\r | |
1734 | IN EFI_SHELL_FILE_INFO *Node,\r | |
1735 | IN BOOLEAN Save\r | |
1736 | )\r | |
1737 | {\r | |
1738 | EFI_SHELL_FILE_INFO *NewNode;\r | |
1739 | \r | |
733f138d | 1740 | NewNode = AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO));\r |
a405b86d | 1741 | if (NewNode == NULL) {\r |
1742 | return (NULL);\r | |
1743 | }\r | |
1744 | NewNode->FullName = AllocateZeroPool(StrSize(Node->FullName));\r | |
1745 | \r | |
1746 | NewNode->FileName = AllocateZeroPool(StrSize(Node->FileName));\r | |
733f138d | 1747 | NewNode->Info = AllocateZeroPool((UINTN)Node->Info->Size);\r |
a405b86d | 1748 | if ( NewNode->FullName == NULL\r |
1749 | || NewNode->FileName == NULL\r | |
1750 | || NewNode->Info == NULL\r | |
1751 | ){\r | |
1752 | return(NULL);\r | |
1753 | }\r | |
1754 | NewNode->Status = Node->Status;\r | |
1755 | NewNode->Handle = Node->Handle;\r | |
1756 | if (!Save) {\r | |
1757 | Node->Handle = NULL;\r | |
1758 | }\r | |
1759 | StrCpy((CHAR16*)NewNode->FullName, Node->FullName);\r | |
1760 | StrCpy((CHAR16*)NewNode->FileName, Node->FileName);\r | |
1761 | CopyMem(NewNode->Info, Node->Info, (UINTN)Node->Info->Size);\r | |
1762 | \r | |
1763 | return(NewNode);\r | |
1764 | }\r | |
1765 | \r | |
1766 | /**\r | |
1767 | Allocates and populates a EFI_SHELL_FILE_INFO structure. if any memory operation\r | |
1768 | failed it will return NULL.\r | |
1769 | \r | |
1770 | @param[in] BasePath the Path to prepend onto filename for FullPath\r | |
1771 | @param[in] Status Status member initial value.\r | |
1772 | @param[in] FullName FullName member initial value.\r | |
1773 | @param[in] FileName FileName member initial value.\r | |
1774 | @param[in] Handle Handle member initial value.\r | |
1775 | @param[in] Info Info struct to copy.\r | |
1776 | \r | |
1777 | @retval NULL An error ocurred.\r | |
1778 | @return a pointer to the newly allocated structure.\r | |
1779 | **/\r | |
1780 | EFI_SHELL_FILE_INFO *\r | |
1781 | EFIAPI\r | |
1782 | CreateAndPopulateShellFileInfo(\r | |
1783 | IN CONST CHAR16 *BasePath,\r | |
1784 | IN CONST EFI_STATUS Status,\r | |
1785 | IN CONST CHAR16 *FullName,\r | |
1786 | IN CONST CHAR16 *FileName,\r | |
1787 | IN CONST SHELL_FILE_HANDLE Handle,\r | |
1788 | IN CONST EFI_FILE_INFO *Info\r | |
1789 | )\r | |
1790 | {\r | |
1791 | EFI_SHELL_FILE_INFO *ShellFileListItem;\r | |
1792 | CHAR16 *TempString;\r | |
1793 | UINTN Size;\r | |
1794 | \r | |
1795 | TempString = NULL;\r | |
1796 | Size = 0;\r | |
1797 | \r | |
1798 | ShellFileListItem = AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO));\r | |
1799 | if (ShellFileListItem == NULL) {\r | |
1800 | return (NULL);\r | |
1801 | }\r | |
74fa83fd | 1802 | if (Info != NULL && Info->Size != 0) {\r |
a405b86d | 1803 | ShellFileListItem->Info = AllocateZeroPool((UINTN)Info->Size);\r |
1804 | if (ShellFileListItem->Info == NULL) {\r | |
1805 | FreePool(ShellFileListItem);\r | |
1806 | return (NULL);\r | |
1807 | }\r | |
1808 | CopyMem(ShellFileListItem->Info, Info, (UINTN)Info->Size);\r | |
1809 | } else {\r | |
1810 | ShellFileListItem->Info = NULL;\r | |
1811 | }\r | |
1812 | if (FileName != NULL) {\r | |
1813 | ASSERT(TempString == NULL);\r | |
1814 | ShellFileListItem->FileName = StrnCatGrow(&TempString, 0, FileName, 0);\r | |
1815 | if (ShellFileListItem->FileName == NULL) {\r | |
1816 | FreePool(ShellFileListItem->Info);\r | |
1817 | FreePool(ShellFileListItem);\r | |
1818 | return (NULL);\r | |
1819 | }\r | |
1820 | } else {\r | |
1821 | ShellFileListItem->FileName = NULL;\r | |
1822 | }\r | |
1823 | Size = 0;\r | |
1824 | TempString = NULL;\r | |
1825 | if (BasePath != NULL) {\r | |
1826 | ASSERT((TempString == NULL && Size == 0) || (TempString != NULL));\r | |
1827 | TempString = StrnCatGrow(&TempString, &Size, BasePath, 0);\r | |
1828 | if (TempString == NULL) {\r | |
1829 | FreePool((VOID*)ShellFileListItem->FileName);\r | |
1830 | FreePool(ShellFileListItem->Info);\r | |
1831 | FreePool(ShellFileListItem);\r | |
1832 | return (NULL);\r | |
1833 | }\r | |
1834 | }\r | |
1835 | if (ShellFileListItem->FileName != NULL) {\r | |
1836 | ASSERT((TempString == NULL && Size == 0) || (TempString != NULL));\r | |
1837 | TempString = StrnCatGrow(&TempString, &Size, ShellFileListItem->FileName, 0);\r | |
1838 | if (TempString == NULL) {\r | |
1839 | FreePool((VOID*)ShellFileListItem->FileName);\r | |
1840 | FreePool(ShellFileListItem->Info);\r | |
1841 | FreePool(ShellFileListItem);\r | |
1842 | return (NULL);\r | |
1843 | }\r | |
1844 | }\r | |
1845 | \r | |
1846 | ShellFileListItem->FullName = TempString;\r | |
1847 | ShellFileListItem->Status = Status;\r | |
1848 | ShellFileListItem->Handle = Handle;\r | |
1849 | \r | |
1850 | return (ShellFileListItem);\r | |
1851 | }\r | |
1852 | \r | |
1853 | /**\r | |
1854 | Find all files in a specified directory.\r | |
1855 | \r | |
1856 | @param FileDirHandle Handle of the directory to search.\r | |
1857 | @param FileList On return, points to the list of files in the directory\r | |
1858 | or NULL if there are no files in the directory.\r | |
1859 | \r | |
1860 | @retval EFI_SUCCESS File information was returned successfully.\r | |
1861 | @retval EFI_VOLUME_CORRUPTED The file system structures have been corrupted.\r | |
1862 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
1863 | @retval EFI_NO_MEDIA The device media is not present.\r | |
1864 | @retval EFI_INVALID_PARAMETER The FileDirHandle was not a directory.\r | |
1865 | @return An error from FileHandleGetFileName().\r | |
1866 | **/\r | |
1867 | EFI_STATUS\r | |
1868 | EFIAPI\r | |
1869 | EfiShellFindFilesInDir(\r | |
1870 | IN SHELL_FILE_HANDLE FileDirHandle,\r | |
1871 | OUT EFI_SHELL_FILE_INFO **FileList\r | |
1872 | )\r | |
1873 | {\r | |
1874 | EFI_SHELL_FILE_INFO *ShellFileList;\r | |
1875 | EFI_SHELL_FILE_INFO *ShellFileListItem;\r | |
1876 | EFI_FILE_INFO *FileInfo;\r | |
1877 | EFI_STATUS Status;\r | |
1878 | BOOLEAN NoFile;\r | |
1879 | CHAR16 *TempString;\r | |
1880 | CHAR16 *BasePath;\r | |
1881 | UINTN Size;\r | |
1882 | CHAR16 *TempSpot;\r | |
1883 | \r | |
1884 | Status = FileHandleGetFileName(FileDirHandle, &BasePath);\r | |
1885 | if (EFI_ERROR(Status)) {\r | |
1886 | return (Status);\r | |
1887 | }\r | |
1888 | \r | |
1889 | if (ShellFileHandleGetPath(FileDirHandle) != NULL) {\r | |
1890 | TempString = NULL;\r | |
1891 | Size = 0;\r | |
1892 | TempString = StrnCatGrow(&TempString, &Size, ShellFileHandleGetPath(FileDirHandle), 0);\r | |
532691c8 | 1893 | if (TempString == NULL) {\r |
1894 | return (EFI_OUT_OF_RESOURCES);\r | |
1895 | }\r | |
a405b86d | 1896 | TempSpot = StrStr(TempString, L";");\r |
1897 | \r | |
1898 | if (TempSpot != NULL) {\r | |
1899 | *TempSpot = CHAR_NULL;\r | |
1900 | }\r | |
1901 | \r | |
1902 | TempString = StrnCatGrow(&TempString, &Size, BasePath, 0);\r | |
532691c8 | 1903 | if (TempString == NULL) {\r |
1904 | return (EFI_OUT_OF_RESOURCES);\r | |
1905 | }\r | |
a405b86d | 1906 | BasePath = TempString;\r |
1907 | }\r | |
1908 | \r | |
1909 | NoFile = FALSE;\r | |
1910 | ShellFileList = NULL;\r | |
1911 | ShellFileListItem = NULL;\r | |
1912 | FileInfo = NULL;\r | |
1913 | Status = EFI_SUCCESS;\r | |
1914 | \r | |
1915 | \r | |
1916 | for ( Status = FileHandleFindFirstFile(FileDirHandle, &FileInfo)\r | |
1917 | ; !EFI_ERROR(Status) && !NoFile\r | |
1918 | ; Status = FileHandleFindNextFile(FileDirHandle, FileInfo, &NoFile)\r | |
1919 | ){\r | |
1920 | TempString = NULL;\r | |
1921 | Size = 0;\r | |
1922 | //\r | |
1923 | // allocate a new EFI_SHELL_FILE_INFO and populate it...\r | |
1924 | //\r | |
1925 | ASSERT((TempString == NULL && Size == 0) || (TempString != NULL));\r | |
1926 | TempString = StrnCatGrow(&TempString, &Size, BasePath, 0);\r | |
1927 | TempString = StrnCatGrow(&TempString, &Size, FileInfo->FileName, 0);\r | |
1928 | ShellFileListItem = CreateAndPopulateShellFileInfo(\r | |
1929 | BasePath,\r | |
1930 | EFI_SUCCESS, // success since we didnt fail to open it...\r | |
1931 | TempString,\r | |
1932 | FileInfo->FileName,\r | |
1933 | NULL, // no handle since not open\r | |
1934 | FileInfo);\r | |
1935 | \r | |
1936 | if (ShellFileList == NULL) {\r | |
1937 | ShellFileList = (EFI_SHELL_FILE_INFO*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO));\r | |
1938 | ASSERT(ShellFileList != NULL);\r | |
1939 | InitializeListHead(&ShellFileList->Link);\r | |
1940 | }\r | |
1941 | InsertTailList(&ShellFileList->Link, &ShellFileListItem->Link);\r | |
1942 | }\r | |
1943 | if (EFI_ERROR(Status)) {\r | |
1944 | EfiShellFreeFileList(&ShellFileList);\r | |
1945 | *FileList = NULL;\r | |
1946 | } else {\r | |
1947 | *FileList = ShellFileList;\r | |
1948 | }\r | |
1949 | SHELL_FREE_NON_NULL(BasePath);\r | |
1950 | return(Status);\r | |
1951 | }\r | |
1952 | \r | |
1953 | /**\r | |
1954 | Updates a file name to be preceeded by the mapped drive name\r | |
1955 | \r | |
4ff7e37b ED |
1956 | @param[in] BasePath the Mapped drive name to prepend\r |
1957 | @param[in, out] Path pointer to pointer to the file name to update.\r | |
a405b86d | 1958 | \r |
1959 | @retval EFI_SUCCESS\r | |
1960 | @retval EFI_OUT_OF_RESOURCES\r | |
1961 | **/\r | |
1962 | EFI_STATUS\r | |
1963 | EFIAPI\r | |
1964 | UpdateFileName(\r | |
1965 | IN CONST CHAR16 *BasePath,\r | |
1966 | IN OUT CHAR16 **Path\r | |
1967 | )\r | |
1968 | {\r | |
1969 | CHAR16 *Path2;\r | |
1970 | UINTN Path2Size;\r | |
1971 | \r | |
1972 | Path2Size = 0;\r | |
1973 | Path2 = NULL;\r | |
1974 | \r | |
1975 | ASSERT(Path != NULL);\r | |
1976 | ASSERT(*Path != NULL);\r | |
1977 | ASSERT(BasePath != NULL);\r | |
1978 | \r | |
1979 | //\r | |
1980 | // convert a local path to an absolute path\r | |
1981 | //\r | |
1982 | if (StrStr(*Path, L":") == NULL) {\r | |
1983 | ASSERT((Path2 == NULL && Path2Size == 0) || (Path2 != NULL));\r | |
1984 | StrnCatGrow(&Path2, &Path2Size, BasePath, 0);\r | |
1985 | if (Path2 == NULL) {\r | |
1986 | return (EFI_OUT_OF_RESOURCES);\r | |
1987 | }\r | |
1988 | ASSERT((Path2 == NULL && Path2Size == 0) || (Path2 != NULL));\r | |
1989 | StrnCatGrow(&Path2, &Path2Size, (*Path)[0] == L'\\'?(*Path) + 1 :*Path, 0);\r | |
1990 | if (Path2 == NULL) {\r | |
1991 | return (EFI_OUT_OF_RESOURCES);\r | |
1992 | }\r | |
1993 | }\r | |
1994 | \r | |
1995 | FreePool(*Path);\r | |
1996 | (*Path) = Path2;\r | |
1997 | \r | |
1998 | return (EFI_SUCCESS);\r | |
1999 | }\r | |
2000 | \r | |
2001 | /**\r | |
2002 | If FileHandle is a directory then the function reads from FileHandle and reads in\r | |
2003 | each of the FileInfo structures. If one of them matches the Pattern's first\r | |
2004 | "level" then it opens that handle and calls itself on that handle.\r | |
2005 | \r | |
2006 | If FileHandle is a file and matches all of the remaining Pattern (which would be\r | |
2007 | on its last node), then add a EFI_SHELL_FILE_INFO object for this file to fileList.\r | |
2008 | \r | |
a405b86d | 2009 | Upon a EFI_SUCCESS return fromt he function any the caller is responsible to call\r |
2010 | FreeFileList with FileList.\r | |
2011 | \r | |
4ff7e37b ED |
2012 | @param[in] FilePattern The FilePattern to check against.\r |
2013 | @param[in] UnicodeCollation The pointer to EFI_UNICODE_COLLATION_PROTOCOL structure\r | |
2014 | @param[in] FileHandle The FileHandle to start with\r | |
2015 | @param[in, out] FileList pointer to pointer to list of found files.\r | |
2016 | @param[in] ParentNode The node for the parent. Same file as identified by HANDLE.\r | |
2017 | @param[in] MapName The file system name this file is on.\r | |
a405b86d | 2018 | \r |
2019 | @retval EFI_SUCCESS all files were found and the FileList contains a list.\r | |
2020 | @retval EFI_NOT_FOUND no files were found\r | |
2021 | @retval EFI_OUT_OF_RESOURCES a memory allocation failed\r | |
2022 | **/\r | |
2023 | EFI_STATUS\r | |
2024 | EFIAPI\r | |
2025 | ShellSearchHandle(\r | |
2026 | IN CONST CHAR16 *FilePattern,\r | |
2027 | IN EFI_UNICODE_COLLATION_PROTOCOL *UnicodeCollation,\r | |
2028 | IN SHELL_FILE_HANDLE FileHandle,\r | |
2029 | IN OUT EFI_SHELL_FILE_INFO **FileList,\r | |
8be0ba36 | 2030 | IN CONST EFI_SHELL_FILE_INFO *ParentNode OPTIONAL,\r |
2031 | IN CONST CHAR16 *MapName\r | |
a405b86d | 2032 | )\r |
2033 | {\r | |
2034 | EFI_STATUS Status;\r | |
2035 | CONST CHAR16 *NextFilePatternStart;\r | |
2036 | CHAR16 *CurrentFilePattern;\r | |
2037 | EFI_SHELL_FILE_INFO *ShellInfo;\r | |
2038 | EFI_SHELL_FILE_INFO *ShellInfoNode;\r | |
2039 | EFI_SHELL_FILE_INFO *NewShellNode;\r | |
2040 | BOOLEAN Directory;\r | |
8be0ba36 | 2041 | CHAR16 *NewFullName;\r |
2042 | UINTN Size;\r | |
a405b86d | 2043 | \r |
2044 | if ( FilePattern == NULL\r | |
2045 | || UnicodeCollation == NULL\r | |
2046 | || FileList == NULL\r | |
2047 | ){\r | |
2048 | return (EFI_INVALID_PARAMETER);\r | |
2049 | }\r | |
2050 | ShellInfo = NULL;\r | |
2051 | CurrentFilePattern = NULL;\r | |
2052 | \r | |
2053 | if (*FilePattern == L'\\') {\r | |
2054 | FilePattern++;\r | |
2055 | }\r | |
2056 | \r | |
2057 | for( NextFilePatternStart = FilePattern\r | |
2058 | ; *NextFilePatternStart != CHAR_NULL && *NextFilePatternStart != L'\\'\r | |
2059 | ; NextFilePatternStart++);\r | |
2060 | \r | |
2061 | CurrentFilePattern = AllocateZeroPool((NextFilePatternStart-FilePattern+1)*sizeof(CHAR16));\r | |
2062 | ASSERT(CurrentFilePattern != NULL);\r | |
2063 | StrnCpy(CurrentFilePattern, FilePattern, NextFilePatternStart-FilePattern);\r | |
2064 | \r | |
2065 | if (CurrentFilePattern[0] == CHAR_NULL\r | |
2066 | &&NextFilePatternStart[0] == CHAR_NULL\r | |
2067 | ){\r | |
2068 | //\r | |
2069 | // Add the current parameter FileHandle to the list, then end...\r | |
2070 | //\r | |
2071 | if (ParentNode == NULL) {\r | |
2072 | Status = EFI_INVALID_PARAMETER;\r | |
2073 | } else {\r | |
2074 | NewShellNode = InternalDuplicateShellFileInfo((EFI_SHELL_FILE_INFO*)ParentNode, TRUE);\r | |
2075 | if (NewShellNode == NULL) {\r | |
2076 | Status = EFI_OUT_OF_RESOURCES;\r | |
2077 | } else {\r | |
2078 | NewShellNode->Handle = NULL;\r | |
2079 | if (*FileList == NULL) {\r | |
733f138d | 2080 | *FileList = AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO));\r |
a405b86d | 2081 | InitializeListHead(&((*FileList)->Link));\r |
2082 | }\r | |
2083 | \r | |
2084 | //\r | |
2085 | // Add to the returning to use list\r | |
2086 | //\r | |
2087 | InsertTailList(&(*FileList)->Link, &NewShellNode->Link);\r | |
2088 | \r | |
2089 | Status = EFI_SUCCESS;\r | |
2090 | }\r | |
2091 | }\r | |
2092 | } else {\r | |
2093 | Status = EfiShellFindFilesInDir(FileHandle, &ShellInfo);\r | |
2094 | \r | |
2095 | if (!EFI_ERROR(Status)){\r | |
2096 | if (StrStr(NextFilePatternStart, L"\\") != NULL){\r | |
2097 | Directory = TRUE;\r | |
2098 | } else {\r | |
2099 | Directory = FALSE;\r | |
2100 | }\r | |
2101 | for ( ShellInfoNode = (EFI_SHELL_FILE_INFO*)GetFirstNode(&ShellInfo->Link)\r | |
2102 | ; !IsNull (&ShellInfo->Link, &ShellInfoNode->Link)\r | |
2103 | ; ShellInfoNode = (EFI_SHELL_FILE_INFO*)GetNextNode(&ShellInfo->Link, &ShellInfoNode->Link)\r | |
2104 | ){\r | |
2105 | if (UnicodeCollation->MetaiMatch(UnicodeCollation, (CHAR16*)ShellInfoNode->FileName, CurrentFilePattern)){\r | |
8be0ba36 | 2106 | if (ShellInfoNode->FullName != NULL && StrStr(ShellInfoNode->FullName, L":") == NULL) {\r |
2107 | Size = StrSize(ShellInfoNode->FullName);\r | |
2108 | Size += StrSize(MapName) + sizeof(CHAR16);\r | |
2109 | NewFullName = AllocateZeroPool(Size);\r | |
2110 | if (NewFullName == NULL) {\r | |
2111 | Status = EFI_OUT_OF_RESOURCES;\r | |
2112 | } else {\r | |
2113 | StrCpy(NewFullName, MapName);\r | |
2114 | StrCat(NewFullName, ShellInfoNode->FullName+1);\r | |
2115 | FreePool((VOID*)ShellInfoNode->FullName);\r | |
2116 | ShellInfoNode->FullName = NewFullName;\r | |
2117 | }\r | |
2118 | }\r | |
c154b997 | 2119 | if (Directory && !EFI_ERROR(Status) && ShellInfoNode->FullName != NULL && ShellInfoNode->FileName != NULL){\r |
a405b86d | 2120 | //\r |
2121 | // should be a directory\r | |
2122 | //\r | |
2123 | \r | |
2124 | //\r | |
2125 | // don't open the . and .. directories\r | |
2126 | //\r | |
2127 | if ( (StrCmp(ShellInfoNode->FileName, L".") != 0)\r | |
2128 | && (StrCmp(ShellInfoNode->FileName, L"..") != 0)\r | |
2129 | ){\r | |
2130 | //\r | |
2131 | //\r | |
2132 | //\r | |
a405b86d | 2133 | if (EFI_ERROR(Status)) {\r |
2134 | break;\r | |
2135 | }\r | |
2136 | //\r | |
2137 | // Open the directory since we need that handle in the next recursion.\r | |
2138 | //\r | |
2139 | ShellInfoNode->Status = EfiShellOpenFileByName (ShellInfoNode->FullName, &ShellInfoNode->Handle, EFI_FILE_MODE_READ);\r | |
2140 | \r | |
2141 | //\r | |
2142 | // recurse with the next part of the pattern\r | |
2143 | //\r | |
8be0ba36 | 2144 | Status = ShellSearchHandle(NextFilePatternStart, UnicodeCollation, ShellInfoNode->Handle, FileList, ShellInfoNode, MapName);\r |
a405b86d | 2145 | }\r |
8be0ba36 | 2146 | } else if (!EFI_ERROR(Status)) {\r |
a405b86d | 2147 | //\r |
2148 | // should be a file\r | |
2149 | //\r | |
2150 | \r | |
2151 | //\r | |
2152 | // copy the information we need into a new Node\r | |
2153 | //\r | |
2154 | NewShellNode = InternalDuplicateShellFileInfo(ShellInfoNode, FALSE);\r | |
2155 | ASSERT(NewShellNode != NULL);\r | |
2156 | if (NewShellNode == NULL) {\r | |
2157 | Status = EFI_OUT_OF_RESOURCES;\r | |
2158 | }\r | |
2159 | if (*FileList == NULL) {\r | |
733f138d | 2160 | *FileList = AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO));\r |
a405b86d | 2161 | InitializeListHead(&((*FileList)->Link));\r |
2162 | }\r | |
2163 | \r | |
2164 | //\r | |
2165 | // Add to the returning to use list\r | |
2166 | //\r | |
2167 | InsertTailList(&(*FileList)->Link, &NewShellNode->Link);\r | |
2168 | }\r | |
2169 | }\r | |
2170 | if (EFI_ERROR(Status)) {\r | |
2171 | break;\r | |
2172 | }\r | |
2173 | }\r | |
2174 | if (EFI_ERROR(Status)) {\r | |
2175 | EfiShellFreeFileList(&ShellInfo);\r | |
2176 | } else {\r | |
2177 | Status = EfiShellFreeFileList(&ShellInfo);\r | |
2178 | }\r | |
2179 | }\r | |
2180 | }\r | |
2181 | \r | |
2182 | FreePool(CurrentFilePattern);\r | |
2183 | return (Status);\r | |
2184 | }\r | |
2185 | \r | |
2186 | /**\r | |
2187 | Find files that match a specified pattern.\r | |
2188 | \r | |
2189 | This function searches for all files and directories that match the specified\r | |
2190 | FilePattern. The FilePattern can contain wild-card characters. The resulting file\r | |
2191 | information is placed in the file list FileList.\r | |
2192 | \r | |
2193 | Wildcards are processed\r | |
2194 | according to the rules specified in UEFI Shell 2.0 spec section 3.7.1.\r | |
2195 | \r | |
2196 | The files in the file list are not opened. The OpenMode field is set to 0 and the FileInfo\r | |
2197 | field is set to NULL.\r | |
2198 | \r | |
2199 | if *FileList is not NULL then it must be a pre-existing and properly initialized list.\r | |
2200 | \r | |
2201 | @param FilePattern Points to a NULL-terminated shell file path, including wildcards.\r | |
2202 | @param FileList On return, points to the start of a file list containing the names\r | |
2203 | of all matching files or else points to NULL if no matching files\r | |
2204 | were found. only on a EFI_SUCCESS return will; this be non-NULL.\r | |
2205 | \r | |
2206 | @retval EFI_SUCCESS Files found. FileList is a valid list.\r | |
2207 | @retval EFI_NOT_FOUND No files found.\r | |
2208 | @retval EFI_NO_MEDIA The device has no media\r | |
2209 | @retval EFI_DEVICE_ERROR The device reported an error\r | |
2210 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted\r | |
2211 | **/\r | |
2212 | EFI_STATUS\r | |
2213 | EFIAPI\r | |
2214 | EfiShellFindFiles(\r | |
2215 | IN CONST CHAR16 *FilePattern,\r | |
2216 | OUT EFI_SHELL_FILE_INFO **FileList\r | |
2217 | )\r | |
2218 | {\r | |
2219 | EFI_STATUS Status;\r | |
2220 | CHAR16 *PatternCopy;\r | |
2221 | CHAR16 *PatternCurrentLocation;\r | |
2222 | EFI_DEVICE_PATH_PROTOCOL *RootDevicePath;\r | |
2223 | SHELL_FILE_HANDLE RootFileHandle;\r | |
2224 | CHAR16 *MapName;\r | |
2225 | UINTN Count;\r | |
2226 | \r | |
2227 | if ( FilePattern == NULL\r | |
2228 | || FileList == NULL\r | |
2229 | || StrStr(FilePattern, L":") == NULL\r | |
2230 | ){\r | |
2231 | return (EFI_INVALID_PARAMETER);\r | |
2232 | }\r | |
2233 | Status = EFI_SUCCESS;\r | |
2234 | RootDevicePath = NULL;\r | |
2235 | RootFileHandle = NULL;\r | |
2236 | MapName = NULL;\r | |
733f138d | 2237 | PatternCopy = AllocateZeroPool(StrSize(FilePattern));\r |
a405b86d | 2238 | if (PatternCopy == NULL) {\r |
2239 | return (EFI_OUT_OF_RESOURCES);\r | |
2240 | }\r | |
2241 | StrCpy(PatternCopy, FilePattern);\r | |
2242 | \r | |
ab94587a | 2243 | PatternCopy = PathCleanUpDirectories(PatternCopy);\r |
a405b86d | 2244 | \r |
2245 | Count = StrStr(PatternCopy, L":") - PatternCopy;\r | |
2246 | Count += 2;\r | |
2247 | \r | |
2248 | ASSERT(MapName == NULL);\r | |
2249 | MapName = StrnCatGrow(&MapName, NULL, PatternCopy, Count);\r | |
532691c8 | 2250 | if (MapName == NULL) {\r |
2251 | Status = EFI_OUT_OF_RESOURCES;\r | |
c8c22591 | 2252 | } else {\r |
a405b86d | 2253 | RootDevicePath = EfiShellGetDevicePathFromFilePath(PatternCopy);\r |
2254 | if (RootDevicePath == NULL) {\r | |
2255 | Status = EFI_INVALID_PARAMETER;\r | |
2256 | } else {\r | |
2257 | Status = EfiShellOpenRoot(RootDevicePath, &RootFileHandle);\r | |
2258 | if (!EFI_ERROR(Status)) {\r | |
2259 | for ( PatternCurrentLocation = PatternCopy\r | |
2260 | ; *PatternCurrentLocation != ':'\r | |
2261 | ; PatternCurrentLocation++);\r | |
2262 | PatternCurrentLocation++;\r | |
8be0ba36 | 2263 | Status = ShellSearchHandle(PatternCurrentLocation, gUnicodeCollation, RootFileHandle, FileList, NULL, MapName);\r |
a405b86d | 2264 | }\r |
2265 | FreePool(RootDevicePath);\r | |
2266 | }\r | |
2267 | }\r | |
2268 | \r | |
8be0ba36 | 2269 | SHELL_FREE_NON_NULL(PatternCopy);\r |
2270 | SHELL_FREE_NON_NULL(MapName);\r | |
a405b86d | 2271 | \r |
2272 | return(Status);\r | |
2273 | }\r | |
2274 | \r | |
2275 | /**\r | |
2276 | Opens the files that match the path specified.\r | |
2277 | \r | |
2278 | This function opens all of the files specified by Path. Wildcards are processed\r | |
2279 | according to the rules specified in UEFI Shell 2.0 spec section 3.7.1. Each\r | |
2280 | matching file has an EFI_SHELL_FILE_INFO structure created in a linked list.\r | |
2281 | \r | |
2282 | @param Path A pointer to the path string.\r | |
2283 | @param OpenMode Specifies the mode used to open each file, EFI_FILE_MODE_READ or\r | |
2284 | EFI_FILE_MODE_WRITE.\r | |
2285 | @param FileList Points to the start of a list of files opened.\r | |
2286 | \r | |
2287 | @retval EFI_SUCCESS Create the file list successfully.\r | |
2288 | @return Others Can't create the file list.\r | |
2289 | **/\r | |
2290 | EFI_STATUS\r | |
2291 | EFIAPI\r | |
2292 | EfiShellOpenFileList(\r | |
2293 | IN CHAR16 *Path,\r | |
2294 | IN UINT64 OpenMode,\r | |
2295 | IN OUT EFI_SHELL_FILE_INFO **FileList\r | |
2296 | )\r | |
2297 | {\r | |
2298 | EFI_STATUS Status;\r | |
2299 | EFI_SHELL_FILE_INFO *ShellFileListItem;\r | |
2300 | CHAR16 *Path2;\r | |
2301 | UINTN Path2Size;\r | |
2302 | CONST CHAR16 *CurDir;\r | |
733f138d | 2303 | BOOLEAN Found;\r |
a405b86d | 2304 | \r |
ab94587a | 2305 | PathCleanUpDirectories(Path);\r |
a405b86d | 2306 | \r |
2307 | Path2Size = 0;\r | |
2308 | Path2 = NULL;\r | |
2309 | \r | |
733f138d | 2310 | if (FileList == NULL || *FileList == NULL) {\r |
2311 | return (EFI_INVALID_PARAMETER);\r | |
2312 | }\r | |
a405b86d | 2313 | \r |
2314 | if (*Path == L'.' && *(Path+1) == L'\\') {\r | |
733f138d | 2315 | Path+=2;\r |
a405b86d | 2316 | }\r |
2317 | \r | |
2318 | //\r | |
2319 | // convert a local path to an absolute path\r | |
2320 | //\r | |
2321 | if (StrStr(Path, L":") == NULL) {\r | |
2322 | CurDir = EfiShellGetCurDir(NULL);\r | |
2323 | ASSERT((Path2 == NULL && Path2Size == 0) || (Path2 != NULL));\r | |
2324 | StrnCatGrow(&Path2, &Path2Size, CurDir, 0);\r | |
2325 | if (*Path == L'\\') {\r | |
2326 | Path++;\r | |
ab94587a | 2327 | while (PathRemoveLastItem(Path2)) ;\r |
a405b86d | 2328 | }\r |
2329 | ASSERT((Path2 == NULL && Path2Size == 0) || (Path2 != NULL));\r | |
2330 | StrnCatGrow(&Path2, &Path2Size, Path, 0);\r | |
2331 | } else {\r | |
2332 | ASSERT(Path2 == NULL);\r | |
2333 | StrnCatGrow(&Path2, NULL, Path, 0);\r | |
2334 | }\r | |
2335 | \r | |
ab94587a | 2336 | PathCleanUpDirectories (Path2);\r |
a405b86d | 2337 | \r |
2338 | //\r | |
2339 | // do the search\r | |
2340 | //\r | |
2341 | Status = EfiShellFindFiles(Path2, FileList);\r | |
2342 | \r | |
2343 | FreePool(Path2);\r | |
2344 | \r | |
2345 | if (EFI_ERROR(Status)) {\r | |
2346 | return (Status);\r | |
2347 | }\r | |
2348 | \r | |
733f138d | 2349 | Found = FALSE;\r |
a405b86d | 2350 | //\r |
2351 | // We had no errors so open all the files (that are not already opened...)\r | |
2352 | //\r | |
2353 | for ( ShellFileListItem = (EFI_SHELL_FILE_INFO*)GetFirstNode(&(*FileList)->Link)\r | |
2354 | ; !IsNull(&(*FileList)->Link, &ShellFileListItem->Link)\r | |
2355 | ; ShellFileListItem = (EFI_SHELL_FILE_INFO*)GetNextNode(&(*FileList)->Link, &ShellFileListItem->Link)\r | |
2356 | ){\r | |
2357 | if (ShellFileListItem->Status == 0 && ShellFileListItem->Handle == NULL) {\r | |
2358 | ShellFileListItem->Status = EfiShellOpenFileByName (ShellFileListItem->FullName, &ShellFileListItem->Handle, OpenMode);\r | |
733f138d | 2359 | Found = TRUE;\r |
a405b86d | 2360 | }\r |
2361 | }\r | |
2362 | \r | |
733f138d | 2363 | if (!Found) {\r |
2364 | return (EFI_NOT_FOUND);\r | |
2365 | }\r | |
a405b86d | 2366 | return(EFI_SUCCESS);\r |
2367 | }\r | |
2368 | \r | |
2369 | /**\r | |
2370 | This function updated with errata.\r | |
2371 | \r | |
2372 | Gets either a single or list of environment variables.\r | |
2373 | \r | |
2374 | If name is not NULL then this function returns the current value of the specified\r | |
2375 | environment variable.\r | |
2376 | \r | |
2377 | If Name is NULL, then a list of all environment variable names is returned. Each is a\r | |
2378 | NULL terminated string with a double NULL terminating the list.\r | |
2379 | \r | |
2380 | @param Name A pointer to the environment variable name. If\r | |
2381 | Name is NULL, then the function will return all\r | |
2382 | of the defined shell environment variables. In\r | |
2383 | the case where multiple environment variables are\r | |
2384 | being returned, each variable will be terminated by\r | |
2385 | a NULL, and the list will be terminated by a double\r | |
2386 | NULL.\r | |
2387 | \r | |
2388 | @return !=NULL A pointer to the returned string.\r | |
2389 | The returned pointer does not need to be freed by the caller.\r | |
2390 | \r | |
2391 | @retval NULL The environment variable doesn't exist or there are\r | |
2392 | no environment variables.\r | |
2393 | **/\r | |
2394 | CONST CHAR16 *\r | |
2395 | EFIAPI\r | |
2396 | EfiShellGetEnv(\r | |
2397 | IN CONST CHAR16 *Name\r | |
2398 | )\r | |
2399 | {\r | |
2400 | EFI_STATUS Status;\r | |
2401 | VOID *Buffer;\r | |
2402 | UINTN Size;\r | |
2403 | LIST_ENTRY List;\r | |
2404 | ENV_VAR_LIST *Node;\r | |
2405 | CHAR16 *CurrentWriteLocation;\r | |
2406 | \r | |
2407 | Size = 0;\r | |
2408 | Buffer = NULL;\r | |
2409 | \r | |
2410 | if (Name == NULL) {\r | |
2411 | //\r | |
2412 | // Get all our environment variables\r | |
2413 | //\r | |
2414 | InitializeListHead(&List);\r | |
2415 | Status = GetEnvironmentVariableList(&List);\r | |
2416 | if (EFI_ERROR(Status)){\r | |
2417 | return (NULL);\r | |
2418 | }\r | |
2419 | \r | |
2420 | //\r | |
2421 | // Build the semi-colon delimited list. (2 passes)\r | |
2422 | //\r | |
2423 | for ( Node = (ENV_VAR_LIST*)GetFirstNode(&List)\r | |
2424 | ; !IsNull(&List, &Node->Link)\r | |
2425 | ; Node = (ENV_VAR_LIST*)GetNextNode(&List, &Node->Link)\r | |
2426 | ){\r | |
2427 | ASSERT(Node->Key != NULL);\r | |
2428 | Size += StrSize(Node->Key);\r | |
2429 | }\r | |
2430 | \r | |
2431 | Size += 2*sizeof(CHAR16);\r | |
2432 | \r | |
2433 | Buffer = AllocateZeroPool(Size);\r | |
3c865f20 | 2434 | if (Buffer == NULL) {\r |
2435 | if (!IsListEmpty (&List)) {\r | |
2436 | FreeEnvironmentVariableList(&List);\r | |
2437 | }\r | |
2438 | return (NULL);\r | |
2439 | }\r | |
a405b86d | 2440 | CurrentWriteLocation = (CHAR16*)Buffer;\r |
2441 | \r | |
2442 | for ( Node = (ENV_VAR_LIST*)GetFirstNode(&List)\r | |
2443 | ; !IsNull(&List, &Node->Link)\r | |
2444 | ; Node = (ENV_VAR_LIST*)GetNextNode(&List, &Node->Link)\r | |
2445 | ){\r | |
2446 | ASSERT(Node->Key != NULL);\r | |
2447 | StrCpy(CurrentWriteLocation, Node->Key);\r | |
2448 | CurrentWriteLocation += StrLen(CurrentWriteLocation) + 1;\r | |
2449 | }\r | |
2450 | \r | |
2451 | //\r | |
2452 | // Free the list...\r | |
2453 | //\r | |
3c865f20 | 2454 | if (!IsListEmpty (&List)) {\r |
2455 | FreeEnvironmentVariableList(&List);\r | |
2456 | }\r | |
a405b86d | 2457 | } else {\r |
2458 | //\r | |
2459 | // We are doing a specific environment variable\r | |
2460 | //\r | |
2461 | \r | |
2462 | //\r | |
2463 | // get the size we need for this EnvVariable\r | |
2464 | //\r | |
2465 | Status = SHELL_GET_ENVIRONMENT_VARIABLE(Name, &Size, Buffer);\r | |
2466 | if (Status == EFI_BUFFER_TOO_SMALL) {\r | |
2467 | //\r | |
2468 | // Allocate the space and recall the get function\r | |
2469 | //\r | |
2470 | Buffer = AllocateZeroPool(Size);\r | |
2471 | ASSERT(Buffer != NULL);\r | |
2472 | Status = SHELL_GET_ENVIRONMENT_VARIABLE(Name, &Size, Buffer);\r | |
2473 | }\r | |
2474 | //\r | |
2475 | // we didnt get it (might not exist)\r | |
2476 | // free the memory if we allocated any and return NULL\r | |
2477 | //\r | |
2478 | if (EFI_ERROR(Status)) {\r | |
2479 | if (Buffer != NULL) {\r | |
2480 | FreePool(Buffer);\r | |
2481 | }\r | |
2482 | return (NULL);\r | |
2483 | }\r | |
2484 | }\r | |
2485 | \r | |
2486 | //\r | |
2487 | // return the buffer\r | |
2488 | //\r | |
2489 | return (AddBufferToFreeList(Buffer));\r | |
2490 | }\r | |
2491 | \r | |
2492 | /**\r | |
2493 | Internal variable setting function. Allows for setting of the read only variables.\r | |
2494 | \r | |
2495 | @param Name Points to the NULL-terminated environment variable name.\r | |
2496 | @param Value Points to the NULL-terminated environment variable value. If the value is an\r | |
2497 | empty string then the environment variable is deleted.\r | |
2498 | @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).\r | |
2499 | \r | |
2500 | @retval EFI_SUCCESS The environment variable was successfully updated.\r | |
2501 | **/\r | |
2502 | EFI_STATUS\r | |
2503 | EFIAPI\r | |
2504 | InternalEfiShellSetEnv(\r | |
2505 | IN CONST CHAR16 *Name,\r | |
2506 | IN CONST CHAR16 *Value,\r | |
2507 | IN BOOLEAN Volatile\r | |
2508 | )\r | |
2509 | {\r | |
2510 | if (Value == NULL || StrLen(Value) == 0) {\r | |
2511 | return (SHELL_DELETE_ENVIRONMENT_VARIABLE(Name));\r | |
2512 | } else {\r | |
2513 | SHELL_DELETE_ENVIRONMENT_VARIABLE(Name);\r | |
2514 | if (Volatile) {\r | |
2515 | return (SHELL_SET_ENVIRONMENT_VARIABLE_V(Name, StrSize(Value), Value));\r | |
2516 | } else {\r | |
2517 | return (SHELL_SET_ENVIRONMENT_VARIABLE_NV(Name, StrSize(Value), Value));\r | |
2518 | }\r | |
2519 | }\r | |
2520 | }\r | |
2521 | \r | |
2522 | /**\r | |
2523 | Sets the environment variable.\r | |
2524 | \r | |
2525 | This function changes the current value of the specified environment variable. If the\r | |
2526 | environment variable exists and the Value is an empty string, then the environment\r | |
2527 | variable is deleted. If the environment variable exists and the Value is not an empty\r | |
2528 | string, then the value of the environment variable is changed. If the environment\r | |
2529 | variable does not exist and the Value is an empty string, there is no action. If the\r | |
2530 | environment variable does not exist and the Value is a non-empty string, then the\r | |
2531 | environment variable is created and assigned the specified value.\r | |
2532 | \r | |
2533 | For a description of volatile and non-volatile environment variables, see UEFI Shell\r | |
2534 | 2.0 specification section 3.6.1.\r | |
2535 | \r | |
2536 | @param Name Points to the NULL-terminated environment variable name.\r | |
2537 | @param Value Points to the NULL-terminated environment variable value. If the value is an\r | |
2538 | empty string then the environment variable is deleted.\r | |
2539 | @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).\r | |
2540 | \r | |
2541 | @retval EFI_SUCCESS The environment variable was successfully updated.\r | |
2542 | **/\r | |
2543 | EFI_STATUS\r | |
2544 | EFIAPI\r | |
2545 | EfiShellSetEnv(\r | |
2546 | IN CONST CHAR16 *Name,\r | |
2547 | IN CONST CHAR16 *Value,\r | |
2548 | IN BOOLEAN Volatile\r | |
2549 | )\r | |
2550 | {\r | |
2551 | if (Name == NULL || *Name == CHAR_NULL) {\r | |
2552 | return (EFI_INVALID_PARAMETER);\r | |
2553 | }\r | |
2554 | //\r | |
2555 | // Make sure we dont 'set' a predefined read only variable\r | |
2556 | //\r | |
2557 | if (gUnicodeCollation->StriColl(\r | |
2558 | gUnicodeCollation,\r | |
2559 | (CHAR16*)Name,\r | |
2560 | L"cwd") == 0\r | |
2561 | ||gUnicodeCollation->StriColl(\r | |
2562 | gUnicodeCollation,\r | |
2563 | (CHAR16*)Name,\r | |
2564 | L"Lasterror") == 0\r | |
2565 | ||gUnicodeCollation->StriColl(\r | |
2566 | gUnicodeCollation,\r | |
2567 | (CHAR16*)Name,\r | |
2568 | L"profiles") == 0\r | |
2569 | ||gUnicodeCollation->StriColl(\r | |
2570 | gUnicodeCollation,\r | |
2571 | (CHAR16*)Name,\r | |
2572 | L"uefishellsupport") == 0\r | |
2573 | ||gUnicodeCollation->StriColl(\r | |
2574 | gUnicodeCollation,\r | |
2575 | (CHAR16*)Name,\r | |
2576 | L"uefishellversion") == 0\r | |
2577 | ||gUnicodeCollation->StriColl(\r | |
2578 | gUnicodeCollation,\r | |
2579 | (CHAR16*)Name,\r | |
2580 | L"uefiversion") == 0\r | |
2581 | ){\r | |
2582 | return (EFI_INVALID_PARAMETER);\r | |
2583 | }\r | |
2584 | return (InternalEfiShellSetEnv(Name, Value, Volatile));\r | |
2585 | }\r | |
2586 | \r | |
2587 | /**\r | |
2588 | Returns the current directory on the specified device.\r | |
2589 | \r | |
2590 | If FileSystemMapping is NULL, it returns the current working directory. If the\r | |
2591 | FileSystemMapping is not NULL, it returns the current directory associated with the\r | |
2592 | FileSystemMapping. In both cases, the returned name includes the file system\r | |
2593 | mapping (i.e. fs0:\current-dir).\r | |
2594 | \r | |
2595 | @param FileSystemMapping A pointer to the file system mapping. If NULL,\r | |
2596 | then the current working directory is returned.\r | |
2597 | \r | |
2598 | @retval !=NULL The current directory.\r | |
2599 | @retval NULL Current directory does not exist.\r | |
2600 | **/\r | |
2601 | CONST CHAR16 *\r | |
2602 | EFIAPI\r | |
2603 | EfiShellGetCurDir(\r | |
2604 | IN CONST CHAR16 *FileSystemMapping OPTIONAL\r | |
2605 | )\r | |
2606 | {\r | |
2607 | CHAR16 *PathToReturn;\r | |
2608 | UINTN Size;\r | |
2609 | SHELL_MAP_LIST *MapListItem;\r | |
2610 | if (!IsListEmpty(&gShellMapList.Link)) {\r | |
2611 | //\r | |
2612 | // if parameter is NULL, use current\r | |
2613 | //\r | |
2614 | if (FileSystemMapping == NULL) {\r | |
2615 | return (EfiShellGetEnv(L"cwd"));\r | |
2616 | } else {\r | |
2617 | Size = 0;\r | |
2618 | PathToReturn = NULL;\r | |
2619 | MapListItem = ShellCommandFindMapItem(FileSystemMapping);\r | |
2620 | if (MapListItem != NULL) {\r | |
2621 | ASSERT((PathToReturn == NULL && Size == 0) || (PathToReturn != NULL));\r | |
2622 | PathToReturn = StrnCatGrow(&PathToReturn, &Size, MapListItem->MapName, 0);\r | |
2623 | PathToReturn = StrnCatGrow(&PathToReturn, &Size, MapListItem->CurrentDirectoryPath, 0);\r | |
2624 | }\r | |
2625 | }\r | |
2626 | return (AddBufferToFreeList(PathToReturn));\r | |
2627 | } else {\r | |
2628 | return (NULL);\r | |
2629 | }\r | |
2630 | }\r | |
2631 | \r | |
2632 | /**\r | |
2633 | Changes the current directory on the specified device.\r | |
2634 | \r | |
2635 | If the FileSystem is NULL, and the directory Dir does not contain a file system's\r | |
2636 | mapped name, this function changes the current working directory.\r | |
2637 | \r | |
2638 | If the FileSystem is NULL and the directory Dir contains a mapped name, then the\r | |
2639 | current file system and the current directory on that file system are changed.\r | |
2640 | \r | |
2641 | If FileSystem is NULL, and Dir is not NULL, then this changes the current working file\r | |
2642 | system.\r | |
2643 | \r | |
2644 | If FileSystem is not NULL and Dir is not NULL, then this function changes the current\r | |
2645 | directory on the specified file system.\r | |
2646 | \r | |
2647 | If the current working directory or the current working file system is changed then the\r | |
2648 | %cwd% environment variable will be updated\r | |
2649 | \r | |
2650 | @param FileSystem A pointer to the file system's mapped name. If NULL, then the current working\r | |
2651 | directory is changed.\r | |
2652 | @param Dir Points to the NULL-terminated directory on the device specified by FileSystem.\r | |
2653 | \r | |
2654 | @retval EFI_SUCCESS The operation was sucessful\r | |
2655 | @retval EFI_NOT_FOUND The file system could not be found\r | |
2656 | **/\r | |
2657 | EFI_STATUS\r | |
2658 | EFIAPI\r | |
2659 | EfiShellSetCurDir(\r | |
2660 | IN CONST CHAR16 *FileSystem OPTIONAL,\r | |
2661 | IN CONST CHAR16 *Dir\r | |
2662 | )\r | |
2663 | {\r | |
2664 | CHAR16 *MapName;\r | |
2665 | SHELL_MAP_LIST *MapListItem;\r | |
2666 | UINTN Size;\r | |
2667 | EFI_STATUS Status;\r | |
2668 | CHAR16 *TempString;\r | |
2669 | CHAR16 *DirectoryName;\r | |
2670 | UINTN TempLen;\r | |
2671 | \r | |
2672 | Size = 0;\r | |
2673 | MapName = NULL;\r | |
2674 | MapListItem = NULL;\r | |
2675 | TempString = NULL;\r | |
2676 | DirectoryName = NULL;\r | |
2677 | \r | |
3c865f20 | 2678 | if ((FileSystem == NULL && Dir == NULL) || Dir == NULL) {\r |
a405b86d | 2679 | return (EFI_INVALID_PARAMETER);\r |
2680 | }\r | |
2681 | \r | |
2682 | if (IsListEmpty(&gShellMapList.Link)){\r | |
2683 | return (EFI_NOT_FOUND);\r | |
2684 | }\r | |
2685 | \r | |
2686 | DirectoryName = StrnCatGrow(&DirectoryName, NULL, Dir, 0);\r | |
2687 | ASSERT(DirectoryName != NULL);\r | |
2688 | \r | |
ab94587a | 2689 | PathCleanUpDirectories(DirectoryName);\r |
a405b86d | 2690 | \r |
2691 | if (FileSystem == NULL) {\r | |
2692 | //\r | |
2693 | // determine the file system mapping to use\r | |
2694 | //\r | |
2695 | if (StrStr(DirectoryName, L":") != NULL) {\r | |
2696 | ASSERT(MapName == NULL);\r | |
2697 | MapName = StrnCatGrow(&MapName, NULL, DirectoryName, (StrStr(DirectoryName, L":")-DirectoryName+1));\r | |
2698 | }\r | |
2699 | //\r | |
2700 | // find the file system mapping's entry in the list\r | |
2701 | // or use current\r | |
2702 | //\r | |
2703 | if (MapName != NULL) {\r | |
2704 | MapListItem = ShellCommandFindMapItem(MapName);\r | |
2705 | \r | |
2706 | //\r | |
2707 | // make that the current file system mapping\r | |
2708 | //\r | |
2709 | if (MapListItem != NULL) {\r | |
2710 | gShellCurDir = MapListItem;\r | |
2711 | }\r | |
2712 | } else {\r | |
2713 | MapListItem = gShellCurDir;\r | |
2714 | }\r | |
2715 | \r | |
2716 | if (MapListItem == NULL) {\r | |
2717 | return (EFI_NOT_FOUND);\r | |
2718 | }\r | |
2719 | \r | |
2720 | //\r | |
2721 | // now update the MapListItem's current directory\r | |
2722 | //\r | |
2723 | if (MapListItem->CurrentDirectoryPath != NULL && DirectoryName[StrLen(DirectoryName) - 1] != L':') {\r | |
2724 | FreePool(MapListItem->CurrentDirectoryPath);\r | |
2725 | MapListItem->CurrentDirectoryPath = NULL;\r | |
2726 | }\r | |
2727 | if (MapName != NULL) {\r | |
2728 | TempLen = StrLen(MapName);\r | |
2729 | if (TempLen != StrLen(DirectoryName)) {\r | |
2730 | ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));\r | |
2731 | MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, DirectoryName+StrLen(MapName), 0);\r | |
2732 | }\r | |
2733 | } else {\r | |
2734 | ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));\r | |
2735 | MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, DirectoryName, 0);\r | |
2736 | }\r | |
2737 | if ((MapListItem->CurrentDirectoryPath != NULL && MapListItem->CurrentDirectoryPath[StrLen(MapListItem->CurrentDirectoryPath)-1] != L'\\') || (MapListItem->CurrentDirectoryPath == NULL)) {\r | |
2738 | ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));\r | |
2739 | MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, L"\\", 0);\r | |
2740 | }\r | |
2741 | } else {\r | |
2742 | //\r | |
2743 | // cant have a mapping in the directory...\r | |
2744 | //\r | |
2745 | if (StrStr(DirectoryName, L":") != NULL) {\r | |
2746 | return (EFI_INVALID_PARAMETER);\r | |
2747 | }\r | |
2748 | //\r | |
2749 | // FileSystem != NULL\r | |
2750 | //\r | |
2751 | MapListItem = ShellCommandFindMapItem(FileSystem);\r | |
2752 | if (MapListItem == NULL) {\r | |
2753 | return (EFI_INVALID_PARAMETER);\r | |
2754 | }\r | |
2755 | // gShellCurDir = MapListItem;\r | |
2756 | if (DirectoryName != NULL) {\r | |
2757 | //\r | |
2758 | // change current dir on that file system\r | |
2759 | //\r | |
2760 | \r | |
2761 | if (MapListItem->CurrentDirectoryPath != NULL) {\r | |
2762 | FreePool(MapListItem->CurrentDirectoryPath);\r | |
2763 | DEBUG_CODE(MapListItem->CurrentDirectoryPath = NULL;);\r | |
2764 | }\r | |
2765 | // ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));\r | |
2766 | // MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, FileSystem, 0);\r | |
2767 | ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));\r | |
2768 | MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, L"\\", 0);\r | |
2769 | ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));\r | |
2770 | MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, DirectoryName, 0);\r | |
532691c8 | 2771 | if (MapListItem->CurrentDirectoryPath != NULL && MapListItem->CurrentDirectoryPath[StrLen(MapListItem->CurrentDirectoryPath)-1] != L'\\') {\r |
a405b86d | 2772 | ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));\r |
2773 | MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, L"\\", 0);\r | |
2774 | }\r | |
2775 | }\r | |
2776 | }\r | |
2777 | //\r | |
2778 | // if updated the current directory then update the environment variable\r | |
2779 | //\r | |
2780 | if (MapListItem == gShellCurDir) {\r | |
2781 | Size = 0;\r | |
2782 | ASSERT((TempString == NULL && Size == 0) || (TempString != NULL));\r | |
2783 | StrnCatGrow(&TempString, &Size, MapListItem->MapName, 0);\r | |
2784 | ASSERT((TempString == NULL && Size == 0) || (TempString != NULL));\r | |
2785 | StrnCatGrow(&TempString, &Size, MapListItem->CurrentDirectoryPath, 0);\r | |
2786 | Status = InternalEfiShellSetEnv(L"cwd", TempString, TRUE);\r | |
2787 | FreePool(TempString);\r | |
2788 | return (Status);\r | |
2789 | }\r | |
2790 | return(EFI_SUCCESS);\r | |
2791 | }\r | |
2792 | \r | |
2793 | /**\r | |
2794 | Return help information about a specific command.\r | |
2795 | \r | |
2796 | This function returns the help information for the specified command. The help text\r | |
2797 | can be internal to the shell or can be from a UEFI Shell manual page.\r | |
2798 | \r | |
2799 | If Sections is specified, then each section name listed will be compared in a casesensitive\r | |
2800 | manner, to the section names described in Appendix B. If the section exists,\r | |
2801 | it will be appended to the returned help text. If the section does not exist, no\r | |
2802 | information will be returned. If Sections is NULL, then all help text information\r | |
2803 | available will be returned.\r | |
2804 | \r | |
2805 | @param Command Points to the NULL-terminated UEFI Shell command name.\r | |
2806 | @param Sections Points to the NULL-terminated comma-delimited\r | |
2807 | section names to return. If NULL, then all\r | |
2808 | sections will be returned.\r | |
2809 | @param HelpText On return, points to a callee-allocated buffer\r | |
2810 | containing all specified help text.\r | |
2811 | \r | |
2812 | @retval EFI_SUCCESS The help text was returned.\r | |
2813 | @retval EFI_OUT_OF_RESOURCES The necessary buffer could not be allocated to hold the\r | |
2814 | returned help text.\r | |
2815 | @retval EFI_INVALID_PARAMETER HelpText is NULL\r | |
2816 | @retval EFI_NOT_FOUND There is no help text available for Command.\r | |
2817 | **/\r | |
2818 | EFI_STATUS\r | |
2819 | EFIAPI\r | |
2820 | EfiShellGetHelpText(\r | |
2821 | IN CONST CHAR16 *Command,\r | |
2822 | IN CONST CHAR16 *Sections OPTIONAL,\r | |
2823 | OUT CHAR16 **HelpText\r | |
2824 | )\r | |
2825 | {\r | |
2826 | CONST CHAR16 *ManFileName;\r | |
2827 | \r | |
2828 | ASSERT(HelpText != NULL);\r | |
2829 | \r | |
2830 | ManFileName = ShellCommandGetManFileNameHandler(Command);\r | |
2831 | \r | |
2832 | if (ManFileName != NULL) {\r | |
2833 | return (ProcessManFile(ManFileName, Command, Sections, NULL, HelpText));\r | |
2834 | } else {\r | |
2835 | return (ProcessManFile(Command, Command, Sections, NULL, HelpText));\r | |
2836 | }\r | |
2837 | }\r | |
2838 | \r | |
2839 | /**\r | |
2840 | Gets the enable status of the page break output mode.\r | |
2841 | \r | |
2842 | User can use this function to determine current page break mode.\r | |
2843 | \r | |
2844 | @retval TRUE The page break output mode is enabled.\r | |
2845 | @retval FALSE The page break output mode is disabled.\r | |
2846 | **/\r | |
2847 | BOOLEAN\r | |
2848 | EFIAPI\r | |
2849 | EfiShellGetPageBreak(\r | |
2850 | VOID\r | |
2851 | )\r | |
2852 | {\r | |
2853 | return(ShellInfoObject.PageBreakEnabled);\r | |
2854 | }\r | |
2855 | \r | |
2856 | /**\r | |
2857 | Judges whether the active shell is the root shell.\r | |
2858 | \r | |
2859 | This function makes the user to know that whether the active Shell is the root shell.\r | |
2860 | \r | |
2861 | @retval TRUE The active Shell is the root Shell.\r | |
2862 | @retval FALSE The active Shell is NOT the root Shell.\r | |
2863 | **/\r | |
2864 | BOOLEAN\r | |
2865 | EFIAPI\r | |
2866 | EfiShellIsRootShell(\r | |
2867 | VOID\r | |
2868 | )\r | |
2869 | {\r | |
2870 | return(ShellInfoObject.RootShellInstance);\r | |
2871 | }\r | |
2872 | \r | |
2873 | /**\r | |
2874 | function to return a semi-colon delimeted list of all alias' in the current shell\r | |
2875 | \r | |
2876 | up to caller to free the memory.\r | |
2877 | \r | |
2878 | @retval NULL No alias' were found\r | |
2879 | @retval NULL An error ocurred getting alias'\r | |
2880 | @return !NULL a list of all alias'\r | |
2881 | **/\r | |
2882 | CHAR16 *\r | |
2883 | EFIAPI\r | |
2884 | InternalEfiShellGetListAlias(\r | |
2885 | )\r | |
2886 | {\r | |
2887 | UINT64 MaxStorSize;\r | |
2888 | UINT64 RemStorSize;\r | |
2889 | UINT64 MaxVarSize;\r | |
2890 | EFI_STATUS Status;\r | |
2891 | EFI_GUID Guid;\r | |
2892 | CHAR16 *VariableName;\r | |
2893 | UINTN NameSize;\r | |
2894 | CHAR16 *RetVal;\r | |
2895 | UINTN RetSize;\r | |
2896 | CHAR16 *Alias;\r | |
2897 | \r | |
2898 | Status = gRT->QueryVariableInfo(EFI_VARIABLE_NON_VOLATILE|EFI_VARIABLE_BOOTSERVICE_ACCESS, &MaxStorSize, &RemStorSize, &MaxVarSize);\r | |
2899 | ASSERT_EFI_ERROR(Status);\r | |
2900 | \r | |
2901 | VariableName = AllocateZeroPool((UINTN)MaxVarSize);\r | |
2902 | RetSize = 0;\r | |
2903 | RetVal = NULL;\r | |
2904 | \r | |
3c865f20 | 2905 | if (VariableName == NULL) {\r |
2906 | return (NULL);\r | |
2907 | }\r | |
2908 | \r | |
a405b86d | 2909 | VariableName[0] = CHAR_NULL;\r |
2910 | \r | |
2911 | while (TRUE) {\r | |
2912 | NameSize = (UINTN)MaxVarSize;\r | |
2913 | Status = gRT->GetNextVariableName(&NameSize, VariableName, &Guid);\r | |
2914 | if (Status == EFI_NOT_FOUND){\r | |
2915 | break;\r | |
2916 | }\r | |
2917 | ASSERT_EFI_ERROR(Status);\r | |
2918 | if (EFI_ERROR(Status)) {\r | |
2919 | break;\r | |
2920 | }\r | |
2921 | if (CompareGuid(&Guid, &gShellAliasGuid)){\r | |
2922 | Alias = GetVariable(VariableName, &gShellAliasGuid);\r | |
2923 | ASSERT((RetVal == NULL && RetSize == 0) || (RetVal != NULL));\r | |
2924 | RetVal = StrnCatGrow(&RetVal, &RetSize, VariableName, 0);\r | |
2925 | RetVal = StrnCatGrow(&RetVal, &RetSize, L";", 0);\r | |
2926 | } // compare guid\r | |
2927 | } // while\r | |
2928 | FreePool(VariableName);\r | |
2929 | \r | |
2930 | return (RetVal);\r | |
2931 | }\r | |
2932 | \r | |
2933 | /**\r | |
2934 | This function returns the command associated with a alias or a list of all\r | |
2935 | alias'.\r | |
2936 | \r | |
2937 | @param[in] Alias Points to the NULL-terminated shell alias.\r | |
2938 | If this parameter is NULL, then all\r | |
2939 | aliases will be returned in ReturnedData.\r | |
2940 | @param[out] Volatile upon return of a single command if TRUE indicates\r | |
2941 | this is stored in a volatile fashion. FALSE otherwise.\r | |
2942 | \r | |
2943 | @return If Alias is not NULL, it will return a pointer to\r | |
2944 | the NULL-terminated command for that alias.\r | |
2945 | If Alias is NULL, ReturnedData points to a ';'\r | |
2946 | delimited list of alias (e.g.\r | |
2947 | ReturnedData = "dir;del;copy;mfp") that is NULL-terminated.\r | |
2948 | @retval NULL an error ocurred\r | |
2949 | @retval NULL Alias was not a valid Alias\r | |
2950 | **/\r | |
2951 | CONST CHAR16 *\r | |
2952 | EFIAPI\r | |
2953 | EfiShellGetAlias(\r | |
2954 | IN CONST CHAR16 *Alias,\r | |
2955 | OUT BOOLEAN *Volatile OPTIONAL\r | |
2956 | )\r | |
2957 | {\r | |
2958 | CHAR16 *RetVal;\r | |
2959 | UINTN RetSize;\r | |
2960 | UINT32 Attribs;\r | |
2961 | EFI_STATUS Status;\r | |
2962 | \r | |
2963 | if (Alias != NULL) {\r | |
2964 | if (Volatile == NULL) {\r | |
2965 | return (AddBufferToFreeList(GetVariable((CHAR16*)Alias, &gShellAliasGuid)));\r | |
2966 | }\r | |
2967 | RetSize = 0;\r | |
2968 | RetVal = NULL;\r | |
2969 | Status = gRT->GetVariable((CHAR16*)Alias, &gShellAliasGuid, &Attribs, &RetSize, RetVal);\r | |
2970 | if (Status == EFI_BUFFER_TOO_SMALL) {\r | |
2971 | RetVal = AllocateZeroPool(RetSize);\r | |
2972 | Status = gRT->GetVariable((CHAR16*)Alias, &gShellAliasGuid, &Attribs, &RetSize, RetVal);\r | |
2973 | }\r | |
2974 | if (EFI_ERROR(Status)) {\r | |
2975 | if (RetVal != NULL) {\r | |
2976 | FreePool(RetVal);\r | |
2977 | }\r | |
2978 | return (NULL);\r | |
2979 | }\r | |
2980 | if ((EFI_VARIABLE_NON_VOLATILE & Attribs) == EFI_VARIABLE_NON_VOLATILE) {\r | |
2981 | *Volatile = FALSE;\r | |
2982 | } else {\r | |
2983 | *Volatile = TRUE;\r | |
2984 | }\r | |
2985 | \r | |
2986 | return (AddBufferToFreeList(RetVal));\r | |
2987 | }\r | |
2988 | return (AddBufferToFreeList(InternalEfiShellGetListAlias()));\r | |
2989 | }\r | |
2990 | \r | |
2991 | /**\r | |
2992 | Changes a shell command alias.\r | |
2993 | \r | |
2994 | This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.\r | |
2995 | \r | |
2996 | this function does not check for built in alias'.\r | |
2997 | \r | |
2998 | @param[in] Command Points to the NULL-terminated shell command or existing alias.\r | |
2999 | @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and\r | |
3000 | Command refers to an alias, that alias will be deleted.\r | |
3001 | @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the\r | |
3002 | Alias being set will be stored in a non-volatile fashion.\r | |
3003 | \r | |
3004 | @retval EFI_SUCCESS Alias created or deleted successfully.\r | |
3005 | @retval EFI_NOT_FOUND the Alias intended to be deleted was not found\r | |
3006 | **/\r | |
3007 | EFI_STATUS\r | |
3008 | EFIAPI\r | |
3009 | InternalSetAlias(\r | |
3010 | IN CONST CHAR16 *Command,\r | |
3011 | IN CONST CHAR16 *Alias,\r | |
3012 | IN BOOLEAN Volatile\r | |
3013 | )\r | |
3014 | {\r | |
3015 | //\r | |
3016 | // We must be trying to remove one if Alias is NULL\r | |
3017 | //\r | |
3018 | if (Alias == NULL) {\r | |
3019 | //\r | |
3020 | // remove an alias (but passed in COMMAND parameter)\r | |
3021 | //\r | |
3022 | return (gRT->SetVariable((CHAR16*)Command, &gShellAliasGuid, 0, 0, NULL));\r | |
3023 | } else {\r | |
3024 | //\r | |
3025 | // Add and replace are the same\r | |
3026 | //\r | |
3027 | \r | |
3028 | // We dont check the error return on purpose since the variable may not exist.\r | |
3029 | gRT->SetVariable((CHAR16*)Command, &gShellAliasGuid, 0, 0, NULL);\r | |
3030 | \r | |
3031 | return (gRT->SetVariable((CHAR16*)Alias, &gShellAliasGuid, EFI_VARIABLE_BOOTSERVICE_ACCESS|(Volatile?0:EFI_VARIABLE_NON_VOLATILE), StrSize(Command), (VOID*)Command));\r | |
3032 | }\r | |
3033 | }\r | |
3034 | \r | |
3035 | /**\r | |
3036 | Changes a shell command alias.\r | |
3037 | \r | |
3038 | This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.\r | |
3039 | \r | |
3040 | \r | |
3041 | @param[in] Command Points to the NULL-terminated shell command or existing alias.\r | |
3042 | @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and\r | |
3043 | Command refers to an alias, that alias will be deleted.\r | |
3044 | @param[in] Replace If TRUE and the alias already exists, then the existing alias will be replaced. If\r | |
3045 | FALSE and the alias already exists, then the existing alias is unchanged and\r | |
3046 | EFI_ACCESS_DENIED is returned.\r | |
3047 | @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the\r | |
3048 | Alias being set will be stored in a non-volatile fashion.\r | |
3049 | \r | |
3050 | @retval EFI_SUCCESS Alias created or deleted successfully.\r | |
3051 | @retval EFI_NOT_FOUND the Alias intended to be deleted was not found\r | |
3052 | @retval EFI_ACCESS_DENIED The alias is a built-in alias or already existed and Replace was set to\r | |
3053 | FALSE.\r | |
3054 | **/\r | |
3055 | EFI_STATUS\r | |
3056 | EFIAPI\r | |
3057 | EfiShellSetAlias(\r | |
3058 | IN CONST CHAR16 *Command,\r | |
3059 | IN CONST CHAR16 *Alias,\r | |
3060 | IN BOOLEAN Replace,\r | |
3061 | IN BOOLEAN Volatile\r | |
3062 | )\r | |
3063 | {\r | |
3064 | //\r | |
3065 | // cant set over a built in alias\r | |
3066 | //\r | |
3067 | if (ShellCommandIsOnAliasList(Alias==NULL?Command:Alias)) {\r | |
3068 | return (EFI_ACCESS_DENIED);\r | |
3069 | }\r | |
3070 | if (Command == NULL || *Command == CHAR_NULL || StrLen(Command) == 0) {\r | |
3071 | return (EFI_INVALID_PARAMETER);\r | |
3072 | }\r | |
3073 | \r | |
3074 | if (EfiShellGetAlias(Command, NULL) != NULL && !Replace) {\r | |
3075 | return (EFI_ACCESS_DENIED);\r | |
3076 | }\r | |
3077 | \r | |
3078 | return (InternalSetAlias(Command, Alias, Volatile));\r | |
3079 | }\r | |
3080 | \r | |
3081 | // Pure FILE_HANDLE operations are passed to FileHandleLib\r | |
3082 | // these functions are indicated by the *\r | |
3083 | EFI_SHELL_PROTOCOL mShellProtocol = {\r | |
3084 | EfiShellExecute,\r | |
3085 | EfiShellGetEnv,\r | |
3086 | EfiShellSetEnv,\r | |
3087 | EfiShellGetAlias,\r | |
3088 | EfiShellSetAlias,\r | |
3089 | EfiShellGetHelpText,\r | |
3090 | EfiShellGetDevicePathFromMap,\r | |
3091 | EfiShellGetMapFromDevicePath,\r | |
3092 | EfiShellGetDevicePathFromFilePath,\r | |
3093 | EfiShellGetFilePathFromDevicePath,\r | |
3094 | EfiShellSetMap,\r | |
3095 | EfiShellGetCurDir,\r | |
3096 | EfiShellSetCurDir,\r | |
3097 | EfiShellOpenFileList,\r | |
3098 | EfiShellFreeFileList,\r | |
3099 | EfiShellRemoveDupInFileList,\r | |
3100 | EfiShellBatchIsActive,\r | |
3101 | EfiShellIsRootShell,\r | |
3102 | EfiShellEnablePageBreak,\r | |
3103 | EfiShellDisablePageBreak,\r | |
3104 | EfiShellGetPageBreak,\r | |
3105 | EfiShellGetDeviceName,\r | |
3106 | (EFI_SHELL_GET_FILE_INFO)FileHandleGetInfo, //*\r | |
3107 | (EFI_SHELL_SET_FILE_INFO)FileHandleSetInfo, //*\r | |
3108 | EfiShellOpenFileByName,\r | |
3109 | EfiShellClose,\r | |
3110 | EfiShellCreateFile,\r | |
3111 | (EFI_SHELL_READ_FILE)FileHandleRead, //*\r | |
3112 | (EFI_SHELL_WRITE_FILE)FileHandleWrite, //*\r | |
3113 | (EFI_SHELL_DELETE_FILE)FileHandleDelete, //*\r | |
3114 | EfiShellDeleteFileByName,\r | |
3115 | (EFI_SHELL_GET_FILE_POSITION)FileHandleGetPosition, //*\r | |
3116 | (EFI_SHELL_SET_FILE_POSITION)FileHandleSetPosition, //*\r | |
3117 | (EFI_SHELL_FLUSH_FILE)FileHandleFlush, //*\r | |
3118 | EfiShellFindFiles,\r | |
3119 | EfiShellFindFilesInDir,\r | |
3120 | (EFI_SHELL_GET_FILE_SIZE)FileHandleGetSize, //*\r | |
3121 | EfiShellOpenRoot,\r | |
3122 | EfiShellOpenRootByHandle,\r | |
3123 | NULL,\r | |
3124 | SHELL_MAJOR_VERSION,\r | |
3125 | SHELL_MINOR_VERSION\r | |
3126 | };\r | |
3127 | \r | |
3128 | /**\r | |
3129 | Function to create and install on the current handle.\r | |
3130 | \r | |
3131 | Will overwrite any existing ShellProtocols in the system to be sure that\r | |
3132 | the current shell is in control.\r | |
3133 | \r | |
3134 | This must be removed via calling CleanUpShellProtocol().\r | |
3135 | \r | |
4ff7e37b | 3136 | @param[in, out] NewShell The pointer to the pointer to the structure\r |
a405b86d | 3137 | to install.\r |
3138 | \r | |
3139 | @retval EFI_SUCCESS The operation was successful.\r | |
3140 | @return An error from LocateHandle, CreateEvent, or other core function.\r | |
3141 | **/\r | |
3142 | EFI_STATUS\r | |
3143 | EFIAPI\r | |
3144 | CreatePopulateInstallShellProtocol (\r | |
3145 | IN OUT EFI_SHELL_PROTOCOL **NewShell\r | |
3146 | )\r | |
3147 | {\r | |
3148 | EFI_STATUS Status;\r | |
3149 | UINTN BufferSize;\r | |
3150 | EFI_HANDLE *Buffer;\r | |
3151 | UINTN HandleCounter;\r | |
3152 | SHELL_PROTOCOL_HANDLE_LIST *OldProtocolNode;\r | |
3153 | \r | |
8be0ba36 | 3154 | if (NewShell == NULL) {\r |
3155 | return (EFI_INVALID_PARAMETER);\r | |
3156 | }\r | |
3157 | \r | |
a405b86d | 3158 | BufferSize = 0;\r |
3159 | Buffer = NULL;\r | |
3160 | OldProtocolNode = NULL;\r | |
3161 | InitializeListHead(&ShellInfoObject.OldShellList.Link);\r | |
3162 | \r | |
a405b86d | 3163 | //\r |
3164 | // Initialize EfiShellProtocol object...\r | |
3165 | //\r | |
a405b86d | 3166 | Status = gBS->CreateEvent(0,\r |
3167 | 0,\r | |
3168 | NULL,\r | |
3169 | NULL,\r | |
3170 | &mShellProtocol.ExecutionBreak);\r | |
8be0ba36 | 3171 | if (EFI_ERROR(Status)) {\r |
3172 | return (Status);\r | |
3173 | }\r | |
a405b86d | 3174 | \r |
3175 | //\r | |
3176 | // Get the size of the buffer we need.\r | |
3177 | //\r | |
3178 | Status = gBS->LocateHandle(ByProtocol,\r | |
3179 | &gEfiShellProtocolGuid,\r | |
3180 | NULL,\r | |
3181 | &BufferSize,\r | |
3182 | Buffer);\r | |
3183 | if (Status == EFI_BUFFER_TOO_SMALL) {\r | |
3184 | //\r | |
3185 | // Allocate and recall with buffer of correct size\r | |
3186 | //\r | |
3187 | Buffer = AllocateZeroPool(BufferSize);\r | |
8be0ba36 | 3188 | if (Buffer == NULL) {\r |
3189 | return (EFI_OUT_OF_RESOURCES);\r | |
3190 | }\r | |
a405b86d | 3191 | Status = gBS->LocateHandle(ByProtocol,\r |
3192 | &gEfiShellProtocolGuid,\r | |
3193 | NULL,\r | |
3194 | &BufferSize,\r | |
3195 | Buffer);\r | |
8be0ba36 | 3196 | if (EFI_ERROR(Status)) {\r |
3197 | FreePool(Buffer);\r | |
3198 | return (Status);\r | |
3199 | }\r | |
a405b86d | 3200 | //\r |
3201 | // now overwrite each of them, but save the info to restore when we end.\r | |
3202 | //\r | |
3203 | for (HandleCounter = 0 ; HandleCounter < (BufferSize/sizeof(EFI_HANDLE)) ; HandleCounter++) {\r | |
3204 | OldProtocolNode = AllocateZeroPool(sizeof(SHELL_PROTOCOL_HANDLE_LIST));\r | |
3205 | ASSERT(OldProtocolNode != NULL);\r | |
3206 | Status = gBS->OpenProtocol(Buffer[HandleCounter],\r | |
3207 | &gEfiShellProtocolGuid,\r | |
3208 | (VOID **) &(OldProtocolNode->Interface),\r | |
3209 | gImageHandle,\r | |
3210 | NULL,\r | |
3211 | EFI_OPEN_PROTOCOL_GET_PROTOCOL\r | |
3212 | );\r | |
3213 | if (!EFI_ERROR(Status)) {\r | |
3214 | //\r | |
3215 | // reinstall over the old one...\r | |
3216 | //\r | |
3217 | OldProtocolNode->Handle = Buffer[HandleCounter];\r | |
3218 | Status = gBS->ReinstallProtocolInterface(\r | |
3219 | OldProtocolNode->Handle,\r | |
3220 | &gEfiShellProtocolGuid,\r | |
3221 | OldProtocolNode->Interface,\r | |
8be0ba36 | 3222 | (VOID*)(&mShellProtocol));\r |
a405b86d | 3223 | if (!EFI_ERROR(Status)) {\r |
3224 | //\r | |
3225 | // we reinstalled sucessfully. log this so we can reverse it later.\r | |
3226 | //\r | |
3227 | \r | |
3228 | //\r | |
3229 | // add to the list for subsequent...\r | |
3230 | //\r | |
3231 | InsertTailList(&ShellInfoObject.OldShellList.Link, &OldProtocolNode->Link);\r | |
3232 | }\r | |
3233 | }\r | |
3234 | }\r | |
3235 | FreePool(Buffer);\r | |
3236 | } else if (Status == EFI_NOT_FOUND) {\r | |
3237 | ASSERT(IsListEmpty(&ShellInfoObject.OldShellList.Link));\r | |
3238 | //\r | |
3239 | // no one else published yet. just publish it ourselves.\r | |
3240 | //\r | |
3241 | Status = gBS->InstallProtocolInterface (\r | |
3242 | &gImageHandle,\r | |
3243 | &gEfiShellProtocolGuid,\r | |
3244 | EFI_NATIVE_INTERFACE,\r | |
8be0ba36 | 3245 | (VOID*)(&mShellProtocol));\r |
a405b86d | 3246 | }\r |
3247 | \r | |
3248 | if (PcdGetBool(PcdShellSupportOldProtocols)){\r | |
3249 | ///@todo support ShellEnvironment2\r | |
3250 | ///@todo do we need to support ShellEnvironment (not ShellEnvironment2) also?\r | |
3251 | }\r | |
3252 | \r | |
8be0ba36 | 3253 | if (!EFI_ERROR(Status)) {\r |
3254 | *NewShell = &mShellProtocol;\r | |
3255 | }\r | |
a405b86d | 3256 | return (Status);\r |
3257 | }\r | |
3258 | \r | |
3259 | /**\r | |
e9723321 | 3260 | Opposite of CreatePopulateInstallShellProtocol.\r |
a405b86d | 3261 | \r |
3262 | Free all memory and restore the system to the state it was in before calling\r | |
3263 | CreatePopulateInstallShellProtocol.\r | |
3264 | \r | |
4ff7e37b | 3265 | @param[in, out] NewShell The pointer to the new shell protocol structure.\r |
a405b86d | 3266 | \r |
3267 | @retval EFI_SUCCESS The operation was successful.\r | |
3268 | **/\r | |
3269 | EFI_STATUS\r | |
3270 | EFIAPI\r | |
3271 | CleanUpShellProtocol (\r | |
3272 | IN OUT EFI_SHELL_PROTOCOL *NewShell\r | |
3273 | )\r | |
3274 | {\r | |
8be0ba36 | 3275 | EFI_STATUS Status;\r |
3276 | SHELL_PROTOCOL_HANDLE_LIST *Node2;\r | |
3277 | EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *SimpleEx;\r | |
a405b86d | 3278 | \r |
3279 | //\r | |
3280 | // if we need to restore old protocols...\r | |
3281 | //\r | |
3282 | if (!IsListEmpty(&ShellInfoObject.OldShellList.Link)) {\r | |
3283 | for (Node2 = (SHELL_PROTOCOL_HANDLE_LIST *)GetFirstNode(&ShellInfoObject.OldShellList.Link)\r | |
3284 | ; !IsListEmpty (&ShellInfoObject.OldShellList.Link)\r | |
3285 | ; Node2 = (SHELL_PROTOCOL_HANDLE_LIST *)GetFirstNode(&ShellInfoObject.OldShellList.Link)\r | |
3286 | ){\r | |
3287 | RemoveEntryList(&Node2->Link);\r | |
3288 | Status = gBS->ReinstallProtocolInterface(Node2->Handle,\r | |
3289 | &gEfiShellProtocolGuid,\r | |
3290 | NewShell,\r | |
3291 | Node2->Interface);\r | |
a405b86d | 3292 | FreePool(Node2);\r |
3293 | }\r | |
3294 | } else {\r | |
3295 | //\r | |
3296 | // no need to restore\r | |
3297 | //\r | |
3298 | Status = gBS->UninstallProtocolInterface(gImageHandle,\r | |
3299 | &gEfiShellProtocolGuid,\r | |
3300 | NewShell);\r | |
a405b86d | 3301 | }\r |
3302 | Status = gBS->CloseEvent(NewShell->ExecutionBreak);\r | |
8be0ba36 | 3303 | NewShell->ExecutionBreak = NULL;\r |
3304 | \r | |
3305 | Status = gBS->OpenProtocol(\r | |
3306 | gST->ConsoleInHandle,\r | |
3307 | &gEfiSimpleTextInputExProtocolGuid,\r | |
3308 | (VOID**)&SimpleEx,\r | |
3309 | gImageHandle,\r | |
3310 | NULL,\r | |
3311 | EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r | |
3312 | \r | |
a7a394a4 | 3313 | if (!EFI_ERROR (Status)) {\r |
3314 | Status = SimpleEx->UnregisterKeyNotify(SimpleEx, ShellInfoObject.CtrlCNotifyHandle1);\r | |
3315 | Status = SimpleEx->UnregisterKeyNotify(SimpleEx, ShellInfoObject.CtrlCNotifyHandle2);\r | |
3316 | Status = SimpleEx->UnregisterKeyNotify(SimpleEx, ShellInfoObject.CtrlCNotifyHandle3);\r | |
3317 | Status = SimpleEx->UnregisterKeyNotify(SimpleEx, ShellInfoObject.CtrlCNotifyHandle4);\r | |
3318 | Status = SimpleEx->UnregisterKeyNotify(SimpleEx, ShellInfoObject.CtrlSNotifyHandle1);\r | |
3319 | Status = SimpleEx->UnregisterKeyNotify(SimpleEx, ShellInfoObject.CtrlSNotifyHandle2);\r | |
3320 | Status = SimpleEx->UnregisterKeyNotify(SimpleEx, ShellInfoObject.CtrlSNotifyHandle3);\r | |
3321 | Status = SimpleEx->UnregisterKeyNotify(SimpleEx, ShellInfoObject.CtrlSNotifyHandle4);\r | |
3322 | }\r | |
a405b86d | 3323 | return (Status);\r |
3324 | }\r | |
3325 | \r | |
8be0ba36 | 3326 | /**\r |
3327 | Notification function for keystrokes.\r | |
3328 | \r | |
3329 | @param[in] KeyData The key that was pressed.\r | |
3330 | \r | |
3331 | @retval EFI_SUCCESS The operation was successful.\r | |
3332 | **/\r | |
3333 | EFI_STATUS\r | |
3334 | EFIAPI\r | |
3335 | NotificationFunction(\r | |
3336 | IN EFI_KEY_DATA *KeyData\r | |
3337 | )\r | |
3338 | {\r | |
ecfd71af | 3339 | EFI_INPUT_KEY Key;\r |
3340 | if ((KeyData->Key.UnicodeChar == L'c' || KeyData->Key.UnicodeChar == 3) &&\r | |
733f138d | 3341 | (KeyData->KeyState.KeyShiftState == (EFI_SHIFT_STATE_VALID|EFI_LEFT_CONTROL_PRESSED) || KeyData->KeyState.KeyShiftState == (EFI_SHIFT_STATE_VALID|EFI_RIGHT_CONTROL_PRESSED))\r |
3342 | ){ \r | |
3343 | if (ShellInfoObject.NewEfiShellProtocol->ExecutionBreak == NULL) {\r | |
3344 | return (EFI_UNSUPPORTED);\r | |
3345 | }\r | |
3346 | return (gBS->SignalEvent(ShellInfoObject.NewEfiShellProtocol->ExecutionBreak));\r | |
3347 | } else if ((KeyData->Key.UnicodeChar == L's') &&\r | |
3348 | (KeyData->KeyState.KeyShiftState == (EFI_SHIFT_STATE_VALID|EFI_LEFT_CONTROL_PRESSED) || KeyData->KeyState.KeyShiftState == (EFI_SHIFT_STATE_VALID|EFI_RIGHT_CONTROL_PRESSED))\r | |
3349 | ){ \r | |
a49f6a2f | 3350 | ShellInfoObject.HaltOutput = TRUE;\r |
ecfd71af | 3351 | \r |
3352 | //\r | |
3353 | // Make sure that there are no pending keystrokes to pervent the pause.\r | |
3354 | //\r | |
3355 | gST->ConIn->Reset(gST->ConIn, FALSE);\r | |
3356 | while (gST->ConIn->ReadKeyStroke (gST->ConIn, &Key)==EFI_SUCCESS);\r | |
8be0ba36 | 3357 | }\r |
733f138d | 3358 | return (EFI_SUCCESS);\r |
8be0ba36 | 3359 | }\r |
3360 | \r | |
3361 | /**\r | |
3362 | Function to start monitoring for CTRL-C using SimpleTextInputEx. This \r | |
3363 | feature's enabled state was not known when the shell initially launched.\r | |
3364 | \r | |
3365 | @retval EFI_SUCCESS The feature is enabled.\r | |
3366 | @retval EFI_OUT_OF_RESOURCES There is not enough mnemory available.\r | |
3367 | **/\r | |
3368 | EFI_STATUS\r | |
3369 | EFIAPI\r | |
3370 | InernalEfiShellStartMonitor(\r | |
3371 | VOID\r | |
3372 | )\r | |
3373 | {\r | |
3374 | EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *SimpleEx;\r | |
3375 | EFI_KEY_DATA KeyData;\r | |
3376 | EFI_STATUS Status;\r | |
3377 | \r | |
3378 | Status = gBS->OpenProtocol(\r | |
3379 | gST->ConsoleInHandle,\r | |
3380 | &gEfiSimpleTextInputExProtocolGuid,\r | |
3381 | (VOID**)&SimpleEx,\r | |
3382 | gImageHandle,\r | |
3383 | NULL,\r | |
3384 | EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r | |
3385 | if (EFI_ERROR(Status)) {\r | |
3386 | ShellPrintHiiEx(\r | |
3387 | -1, \r | |
3388 | -1, \r | |
3389 | NULL,\r | |
3390 | STRING_TOKEN (STR_SHELL_NO_IN_EX),\r | |
3391 | ShellInfoObject.HiiHandle);\r | |
3392 | return (EFI_SUCCESS);\r | |
3393 | }\r | |
a405b86d | 3394 | \r |
8be0ba36 | 3395 | if (ShellInfoObject.NewEfiShellProtocol->ExecutionBreak == NULL) {\r |
3396 | return (EFI_UNSUPPORTED);\r | |
3397 | }\r | |
3398 | \r | |
3399 | KeyData.KeyState.KeyToggleState = 0;\r | |
3400 | KeyData.Key.ScanCode = 0;\r | |
3401 | KeyData.KeyState.KeyShiftState = EFI_SHIFT_STATE_VALID|EFI_LEFT_CONTROL_PRESSED;\r | |
3402 | KeyData.Key.UnicodeChar = L'c';\r | |
3403 | \r | |
3404 | Status = SimpleEx->RegisterKeyNotify(\r | |
3405 | SimpleEx,\r | |
3406 | &KeyData,\r | |
3407 | NotificationFunction,\r | |
3408 | &ShellInfoObject.CtrlCNotifyHandle1);\r | |
3409 | \r | |
3410 | KeyData.KeyState.KeyShiftState = EFI_SHIFT_STATE_VALID|EFI_RIGHT_CONTROL_PRESSED;\r | |
3411 | if (!EFI_ERROR(Status)) {\r | |
3412 | Status = SimpleEx->RegisterKeyNotify(\r | |
3413 | SimpleEx,\r | |
3414 | &KeyData,\r | |
3415 | NotificationFunction,\r | |
3416 | &ShellInfoObject.CtrlCNotifyHandle2);\r | |
3417 | }\r | |
3418 | KeyData.KeyState.KeyShiftState = EFI_SHIFT_STATE_VALID|EFI_LEFT_CONTROL_PRESSED;\r | |
3419 | KeyData.Key.UnicodeChar = 3;\r | |
3420 | if (!EFI_ERROR(Status)) {\r | |
3421 | Status = SimpleEx->RegisterKeyNotify(\r | |
3422 | SimpleEx,\r | |
3423 | &KeyData,\r | |
3424 | NotificationFunction,\r | |
3425 | &ShellInfoObject.CtrlCNotifyHandle3);\r | |
3426 | }\r | |
3427 | KeyData.KeyState.KeyShiftState = EFI_SHIFT_STATE_VALID|EFI_RIGHT_CONTROL_PRESSED;\r | |
3428 | if (!EFI_ERROR(Status)) {\r | |
3429 | Status = SimpleEx->RegisterKeyNotify(\r | |
3430 | SimpleEx,\r | |
3431 | &KeyData,\r | |
3432 | NotificationFunction,\r | |
3433 | &ShellInfoObject.CtrlCNotifyHandle4);\r | |
3434 | }\r | |
3435 | return (Status);\r | |
3436 | }\r |