4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Member functions of EFI_SHELL_PROTOCOL and functions for creation,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync manipulation, and initialization of EFI_SHELL_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Close an open file handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function closes a specified file handle. All "dirty" cached file data is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync flushed to the device, and the file is closed. In all cases the handle is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileHandle The file handle to close.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The file handle was closed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return (FileHandleClose(ConvertShellHandleToEfiFileProtocol(FileHandle)));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Internal worker to determine whether there is a BlockIo somewhere
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync upon the device path specified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DevicePath The device path to test.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE gEfiBlockIoProtocolGuid was installed on a handle with this device path
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE gEfiBlockIoProtocolGuid was not found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DevicePathCopy = (EFI_DEVICE_PATH_PROTOCOL*)DevicePath;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gBS->LocateDevicePath(&gEfiBlockIoProtocolGuid, &DevicePathCopy, &Handle);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Internal worker to determine whether there is a file system somewhere
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync upon the device path specified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DevicePath The device path to test.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE gEfiSimpleFileSystemProtocolGuid was installed on a handle with this device path
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE gEfiSimpleFileSystemProtocolGuid was not found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DevicePathCopy = (EFI_DEVICE_PATH_PROTOCOL*)DevicePath;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &DevicePathCopy, &Handle);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Internal worker debug helper function to print out maps as they are added.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Mapping string mapping that has been added
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DevicePath pointer to device path that has been mapped.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS the operation was successful.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return other an error ocurred
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @sa LocateHandle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @sa OpenProtocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_DEVICE_PATH_TO_TEXT_PROTOCOL *DevicePathToText;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gBS->LocateProtocol(&gEfiDevicePathToTextProtocolGuid,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DEBUG((EFI_D_INFO, "Added new map item:\"%S\"\r\n", Mapping));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Temp = DevicePathToText->ConvertDevicePathToText(DevicePath, TRUE, TRUE);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function creates a mapping for a device path.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If both DeviecPath and Mapping are NULL, this will reset the mapping to default values.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DevicePath Points to the device path. If this is NULL and Mapping points to a valid mapping,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then the mapping will be deleted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Mapping Points to the NULL-terminated mapping for the device path. Must end with a ':'
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Mapping created or deleted successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING There is no handle that corresponds exactly to DevicePath. See the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync boot service function LocateDevicePath().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The mapping is a built-in alias.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Mapping was NULL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Mapping did not end with a ':'
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER DevicePath was not pointing at a device that had a SIMPLE_FILE_SYSTEM_PROTOCOL installed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND There was no mapping found to delete
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Memory allocation failed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath OPTIONAL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Delete the mapping
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for ( MapListNode = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ; MapListNode = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &MapListNode->Link)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (StringNoCaseCompare(&MapListNode->MapName, &Mapping) == 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync } // for loop
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // We didnt find one to delete
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // make sure this is a valid to add device path
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///@todo add BlockIo to this test...
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (!InternalShellProtocolIsSimpleFileSystemPresent(DevicePath)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync && !InternalShellProtocolIsBlockIoPresent(DevicePath)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // First make sure there is no old mapping
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((Status != EFI_SUCCESS) && (Status != EFI_NOT_FOUND)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // now add the new one.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = ShellCommandAddMapItemAndUpdatePath(Mapping, DevicePath, 0, FALSE);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Gets the device path from the mapping.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function gets the device path associated with a mapping.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Mapping A pointer to the mapping
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval !=NULL Pointer to the device path that corresponds to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync device mapping. The returned pointer does not need
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to be freed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL There is no device path associated with the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified mapping.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Gets the mapping(s) that most closely matches the device path.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function gets the mapping which corresponds to the device path *DevicePath. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync there is no exact match, then the mapping which most closely matches *DevicePath
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is returned, and *DevicePath is updated to point to the remaining portion of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync device path. If there is an exact match, the mapping is returned and *DevicePath
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync points to the end-of-device-path node.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If there are multiple map names they will be semi-colon seperated in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NULL-terminated string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DevicePath On entry, points to a device path pointer. On
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync exit, updates the pointer to point to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync portion of the device path after the mapping.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL No mapping was found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return !=NULL Pointer to NULL-terminated mapping. The buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is callee allocated and should be freed by the caller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// EFI_HANDLE PathHandle;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// EFI_HANDLE MapHandle;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// EFI_STATUS Status;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// EFI_DEVICE_PATH_PROTOCOL *DevicePathCopy;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// EFI_DEVICE_PATH_PROTOCOL *MapPathCopy;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for ( Node = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ; Node = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &Node->Link)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // check for exact match
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (DevicePathCompare(DevicePath, &Node->DevicePath) == 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT((PathForReturn == NULL && PathSize == 0) || (PathForReturn != NULL));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, L";", 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, Node->MapName, 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///@todo finish code for inexact matches.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (PathForReturn == NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PathSize = 0;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DevicePathCopy = DuplicateDevicePath(*DevicePath);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT(DevicePathCopy != NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &DevicePathCopy, &PathHandle);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT_EFI_ERROR(Status);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // check each of the device paths we have to get the root of the path for consist mappings
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for ( Node = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ; !IsNull(&gShellMapList.Link, &Node->Link)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ; Node = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &Node->Link)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((Node->Flags & SHELL_MAP_FLAGS_CONSIST) == 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MapPathCopy = DuplicateDevicePath(Node->DevicePath);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT(MapPathCopy != NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &MapPathCopy, &MapHandle);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (MapHandle == PathHandle) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *DevicePath = DevicePathCopy;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MapPathCopy = NULL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DevicePathCopy = NULL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, Node->MapName, 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, L";", 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // now add on the non-consistent mappings
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for ( Node = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ; !IsNull(&gShellMapList.Link, &Node->Link)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ; Node = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &Node->Link)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((Node->Flags & SHELL_MAP_FLAGS_CONSIST) != 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MapPathCopy = Node->DevicePath;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT(MapPathCopy != NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &MapPathCopy, &MapHandle);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (MapHandle == PathHandle) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, Node->MapName, 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, L";", 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Converts a device path to a file system-style path.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function converts a device path to a file system path by replacing part, or all, of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the device path with the file-system mapping. If there are more than one application
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync file system mappings, the one that most closely matches Path will be used.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Path The pointer to the device path
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL the device path could not be found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return all The pointer of the NULL-terminated file path. The path
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is callee-allocated and should be freed by the caller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///@todo BlockIo?
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &DevicePathCopy, &PathHandle);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // check each of the device paths we have to get the root of the path
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for ( MapListItem = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ; MapListItem = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &MapListItem->Link)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MapPathCopy = (EFI_DEVICE_PATH_PROTOCOL*)MapListItem->DevicePath;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///@todo BlockIo?
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &MapPathCopy, &MapHandle);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT((PathForReturn == NULL && PathSize == 0) || (PathForReturn != NULL));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, MapListItem->MapName, 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // go through all the remaining nodes in the device path
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for ( FilePath = (FILEPATH_DEVICE_PATH*)DevicePathCopy
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ; FilePath = (FILEPATH_DEVICE_PATH*)NextDevicePathNode (&FilePath->Header)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // all the rest should be file path nodes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((DevicePathType(&FilePath->Header) != MEDIA_DEVICE_PATH) ||
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (DevicePathSubType(&FilePath->Header) != MEDIA_FILEPATH_DP)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // append the path part onto the filepath.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT((PathForReturn == NULL && PathSize == 0) || (PathForReturn != NULL));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, L"\\", 1);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AlignedNode = AllocateCopyPool (DevicePathNodeLength(FilePath), FilePath);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, AlignedNode->PathName, 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync } // for loop of remaining nodes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync } // for loop of paths to check
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Converts a file system style name to a device path.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function converts a file system style name to a device path, by replacing any
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mapping references to the associated device path.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Path The pointer to the path.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The pointer of the file path. The file path is callee
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync allocated and should be freed by the caller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL The path could not be found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL There was not enough available memory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DevicePathForReturn = EfiShellGetDevicePathFromFilePath(NewPath);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // find the part before (but including) the : for the map name
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT((MapName == NULL && Size == 0) || (MapName != NULL));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MapName = StrnCatGrow(&MapName, &Size, Path, (StrStr(Path, L":")-Path+1));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (MapName == NULL || MapName[StrLen(MapName)-1] != L':') {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // look up the device path in the map
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DevicePath = EfiShellGetDevicePathFromMap(MapName);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Must have been a bad Mapname
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // make a copy for LocateDevicePath to modify (also save a pointer to call FreePool with)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DevicePathCopyForFree = DevicePathCopy = DuplicateDevicePath(DevicePath);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // get the handle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///@todo BlockIo?
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &DevicePathCopy, &Handle);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // build the full device path
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DevicePathForReturn = FileDevicePath(Handle, L"\\");
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DevicePathForReturn = FileDevicePath(Handle, Path+StrLen(MapName));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Gets the name of the device specified by the device handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function gets the user-readable name of the device specified by the device
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync handle. If no user-readable name could be generated, then *BestDeviceName will be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NULL and EFI_NOT_FOUND will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If EFI_DEVICE_NAME_USE_COMPONENT_NAME is set, then the function will return the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync device's name using the EFI_COMPONENT_NAME2_PROTOCOL, if present on
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DeviceHandle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If EFI_DEVICE_NAME_USE_DEVICE_PATH is set, then the function will return the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync device's name using the EFI_DEVICE_PATH_PROTOCOL, if present on DeviceHandle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If both EFI_DEVICE_NAME_USE_COMPONENT_NAME and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_DEVICE_NAME_USE_DEVICE_PATH are set, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_DEVICE_NAME_USE_COMPONENT_NAME will have higher priority.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DeviceHandle The handle of the device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Flags Determines the possible sources of component names.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Valid bits are:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_DEVICE_NAME_USE_COMPONENT_NAME
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_DEVICE_NAME_USE_DEVICE_PATH
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Language A pointer to the language specified for the device
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync name, in the same format as described in the UEFI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specification, Appendix M
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BestDeviceName On return, points to the callee-allocated NULL-
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync terminated name of the device. If no device name
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync could be found, points to NULL. The name must be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync freed by the caller...
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Get the name successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND Fail to get the device name.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Flags did not have a valid bit set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER BestDeviceName was NULL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER DeviceHandle was NULL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_DEVICE_PATH_TO_TEXT_PROTOCOL *DevicePathToText;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // make sure one of the 2 supported bits is on
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (((Flags & EFI_DEVICE_NAME_USE_COMPONENT_NAME) == 0) &&
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ((Flags & EFI_DEVICE_NAME_USE_DEVICE_PATH) == 0)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((Flags & EFI_DEVICE_NAME_USE_COMPONENT_NAME) != 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (LoopVar = 0; LoopVar < HandleCount ; LoopVar++){
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Go through those handles until we get one that passes for GetComponentName
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Lang = AllocateZeroPool(AsciiStrSize(CompName2->SupportedLanguages));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = CompName2->GetControllerName(CompName2, DeviceHandle, NULL, Lang, &DeviceNameToReturn);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (!EFI_ERROR(Status) && DeviceNameToReturn != NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Now check the parent controller using this as the child.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PARSE_HANDLE_DATABASE_PARENTS(DeviceHandle, &ParentControllerCount, &ParentControllerBuffer);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (LoopVar = 0 ; LoopVar < ParentControllerCount ; LoopVar++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PARSE_HANDLE_DATABASE_UEFI_DRIVERS(ParentControllerBuffer[LoopVar], &ParentDriverCount, &ParentDriverBuffer);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (HandleCount = 0 ; HandleCount < ParentDriverCount ; HandleCount++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // try using that driver's component name with controller and our driver as the child.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Lang = AllocateZeroPool(AsciiStrSize(CompName2->SupportedLanguages));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = CompName2->GetControllerName(CompName2, ParentControllerBuffer[LoopVar], DeviceHandle, Lang, &DeviceNameToReturn);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (!EFI_ERROR(Status) && DeviceNameToReturn != NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (!EFI_ERROR(Status) && DeviceNameToReturn != NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // dont return on fail since we will try device path if that bit is on
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync StrnCatGrow(BestDeviceName, NULL, DeviceNameToReturn, 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((Flags & EFI_DEVICE_NAME_USE_DEVICE_PATH) != 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // we now have the device path to text protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // use device path to text on the device path
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *BestDeviceName = DevicePathToText->ConvertDevicePathToText(DevicePath, TRUE, TRUE);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // none of the selected bits worked.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Opens the root directory of a device on a handle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function opens the root directory of a device and returns a file handle to it.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DeviceHandle The handle of the device that contains the volume.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileHandle On exit, points to the file handle corresponding to the root directory on the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Root opened successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync could not be opened.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The device had an error
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // get the simple file system interface
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Open the root volume now...
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = SimpleFileSystem->OpenVolume(SimpleFileSystem, &RealFileHandle);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *FileHandle = ConvertEfiFileProtocolToShellHandle(RealFileHandle, EfiShellGetMapFromDevicePath(&DevPath));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Opens the root directory of a device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function opens the root directory of a device and returns a file handle to it.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DevicePath Points to the device path corresponding to the device where the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_SIMPLE_FILE_SYSTEM_PROTOCOL is installed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileHandle On exit, points to the file handle corresponding to the root directory on the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Root opened successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync could not be opened.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The device had an error
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER FileHandle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // find the handle of the device with that device handle and the file system
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///@todo BlockIo?
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return (EfiShellOpenRootByHandle(Handle, FileHandle));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns whether any script files are currently being processed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE There is at least one script file active.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE No script files are active now.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Worker function to open a file based on a device path. this will open the root
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the volume and then traverse down to the file itself.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DevicePath Device Path of the file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileHandle Pointer to the file upon a successful return.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param OpenMode mode to open file in.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Attributes the File Attributes to use when creating a new file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS the file is open and FileHandle is valid
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED the device path cotained non-path elements
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval other an error ocurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = EfiShellOpenRoot(DevicePath, &ShellHandle);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Handle1 = ConvertShellHandleToEfiFileProtocol(ShellHandle);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // chop off the begining part before the file system part...
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///@todo BlockIo?
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // To access as a file system, the file path should only
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // contain file path components. Follow the file path nodes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // and find the target file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for ( FilePathNode = (FILEPATH_DEVICE_PATH *)DevicePath
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ; FilePathNode = (FILEPATH_DEVICE_PATH *) NextDevicePathNode (&FilePathNode->Header)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AlignedNode = AllocateCopyPool (DevicePathNodeLength(FilePathNode), FilePathNode);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // For file system access each node should be a file path component
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (DevicePathType (&FilePathNode->Header) != MEDIA_DEVICE_PATH ||
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DevicePathSubType (&FilePathNode->Header) != MEDIA_FILEPATH_DP
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Open this file path node
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // if this is the last node in the DevicePath always create (if that was requested).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (IsDevicePathEnd ((NextDevicePathNode (&FilePathNode->Header)))) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // This is not the last node and we dont want to 'create' existing
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // directory entries...
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // open without letting it create
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // prevents error on existing files/directories
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // if above failed now open and create the 'item'
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // if OpenMode EFI_FILE_MODE_CREATE bit was on (but disabled above)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((EFI_ERROR (Status)) && ((OpenMode & EFI_FILE_MODE_CREATE) != 0)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Close the last node
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ShellInfoObject.NewEfiShellProtocol->CloseFile (Handle2);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If there's been an error, stop
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync } // for loop
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ShellInfoObject.NewEfiShellProtocol->CloseFile(Handle1);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *FileHandle = ConvertEfiFileProtocolToShellHandle(Handle1, ShellFileHandleGetPath(ShellHandle));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Creates a file or directory by name.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function creates an empty new file or directory with the specified attributes and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync returns the new file's handle. If the file already exists and is read-only, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_INVALID_PARAMETER will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the file already existed, it is truncated and its attributes updated. If the file is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync created successfully, the FileHandle is the file's handle, else, the FileHandle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the file name begins with >v, then the file handle which is returned refers to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync shell environment variable with the specified name. If the shell environment variable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync already exists and is non-volatile then EFI_INVALID_PARAMETER is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileName Pointer to NULL-terminated file path
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileAttribs The new file's attrbiutes. the different attributes are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync described in EFI_FILE_PROTOCOL.Open().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileHandle On return, points to the created file handle or directory's handle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The file was opened. FileHandle points to the new file's handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED could not open the file path
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND the specified file could not be found on the devide, or could not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync file the file system on the device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MEDIA the device has no medium.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync longer supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the DirName.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync when the media is write-protected.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The service denied access to the file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_VOLUME_FULL The volume is full.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Is this for an environment variable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // do we start with >v
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // We are opening a regular file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DevicePath = EfiShellGetDevicePathFromFilePath(FileName);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = InternalOpenFileDevicePath(DevicePath, FileHandle, EFI_FILE_MODE_READ|EFI_FILE_MODE_WRITE|EFI_FILE_MODE_CREATE, FileAttribs); // 0 = no specific file attributes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Opens a file or a directory by file name.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function opens the specified file in the specified OpenMode and returns a file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the file name begins with >v, then the file handle which is returned refers to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync shell environment variable with the specified name. If the shell environment variable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync exists, is non-volatile and the OpenMode indicates EFI_FILE_MODE_WRITE, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_INVALID_PARAMETER is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the file name is >i, then the file handle which is returned refers to the standard
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync input. If the OpenMode indicates EFI_FILE_MODE_WRITE, then EFI_INVALID_PARAMETER
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the file name is >o, then the file handle which is returned refers to the standard
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync output. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the file name is >e, then the file handle which is returned refers to the standard
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync error. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the file name is NUL, then the file handle that is returned refers to the standard NUL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync file. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If return EFI_SUCCESS, the FileHandle is the opened file's handle, else, the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FileHandle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileName Points to the NULL-terminated UCS-2 encoded file name.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileHandle On return, points to the file handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param OpenMode File open mode. Either EFI_FILE_MODE_READ or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_FILE_MODE_WRITE from section 12.4 of the UEFI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The file was opened. FileHandle has the opened file's handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value. FileHandle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED Could not open the file path. FileHandle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The specified file could not be found on the device or the file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync system could not be found on the device. FileHandle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MEDIA The device has no medium. FileHandle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync longer supported. FileHandle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the FileName. FileHandle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted. FileHandle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync when the media is write-protected. FileHandle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The service denied access to the file. FileHandle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file. FileHandle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_VOLUME_FULL The volume is full. FileHandle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Is this for StdIn
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // make sure not writing to StdIn
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *FileHandle = ShellInfoObject.NewShellParametersProtocol->StdIn;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Is this for StdOut
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // make sure not writing to StdIn
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Is this for NUL file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Is this for StdErr
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // make sure not writing to StdIn
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Is this for an environment variable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // do we start with >v
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // We are opening a regular file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DevicePath = EfiShellGetDevicePathFromFilePath(FileName);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// DEBUG_CODE(InternalShellProtocolDebugPrintMessage (NULL, DevicePath););
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Copy the device path, open the file, then free the memory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = InternalOpenFileDevicePath(DevicePath, FileHandle, OpenMode, 0); // 0 = no specific file attributes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Deletes the file specified by the file name.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function deletes a file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileName Points to the NULL-terminated file name.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The file was closed and deleted, and the handle was closed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @sa EfiShellCreateFile
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // get a handle to the file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // now delete the file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return (ShellInfoObject.NewEfiShellProtocol->DeleteFile(FileHandle));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Disables the page break output mode.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Enables the page break output mode.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync internal worker function to load and run an image via device path.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ParentImageHandle A handle of the image that is executing the specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync command line.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DevicePath device path of the file to execute
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CommandLine Points to the NULL-terminated UCS-2 encoded string
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync containing the command line. If NULL then the command-
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync line will be empty.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Environment Points to a NULL-terminated array of environment
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync variables with the format 'x=y', where x is the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync environment variable name and y is the value. If this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is NULL, then the current shell environment is used.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StatusCode Points to the status code returned by the command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The command executed successfully. The status code
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync returned by the command is pointed to by StatusCode.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The parameters are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Out of resources.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Load the image with:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // FALSE - not from boot manager and NULL, 0 being not already in memory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync LoadedImage->LoadOptionsSize = (UINT32)StrSize(CommandLine);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Save our current environment settings for later restoration if necessary
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Initialize and install a shell parameters protocol on the image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ShellParamsProtocol.StdIn = ShellInfoObject.NewShellParametersProtocol->StdIn;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ShellParamsProtocol.StdOut = ShellInfoObject.NewShellParametersProtocol->StdOut;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ShellParamsProtocol.StdErr = ShellInfoObject.NewShellParametersProtocol->StdErr;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = UpdateArgcArgv(&ShellParamsProtocol, CommandLine, NULL, NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gBS->InstallProtocolInterface(&NewHandle, &gEfiShellParametersProtocolGuid, EFI_NATIVE_INTERFACE, &ShellParamsProtocol);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///@todo initialize and install ShellInterface protocol on the new image for compatibility if - PcdGetBool(PcdShellSupportOldProtocols)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // now start the image and if the caller wanted the return code pass it to them...
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *StatusCode = gBS->StartImage(NewHandle, NULL, NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Cleanup (and dont overwrite errors)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync gBS->UninstallProtocolInterface(NewHandle, &gEfiShellParametersProtocolGuid, &ShellParamsProtocol);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gBS->UninstallProtocolInterface(NewHandle, &gEfiShellParametersProtocolGuid, &ShellParamsProtocol);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Execute the command line.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function creates a nested instance of the shell and executes the specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync command (CommandLine) with the specified environment (Environment). Upon return,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the status code returned by the specified command is placed in StatusCode.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Environment is NULL, then the current environment is used and all changes made
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by the commands executed will be reflected in the current environment. If the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Environment is non-NULL, then the changes made will be discarded.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The CommandLine is executed from the current working directory on the current
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ParentImageHandle A handle of the image that is executing the specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync command line.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CommandLine Points to the NULL-terminated UCS-2 encoded string
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync containing the command line. If NULL then the command-
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync line will be empty.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Environment Points to a NULL-terminated array of environment
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync variables with the format 'x=y', where x is the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync environment variable name and y is the value. If this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is NULL, then the current shell environment is used.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StatusCode Points to the status code returned by the command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The command executed successfully. The status code
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync returned by the command is pointed to by StatusCode.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The parameters are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Out of resources.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The support level required for this function is not present.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @sa InternalShellExecuteDevicePath
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DevPath = AppendDevicePath (ShellInfoObject.ImageDevPath, ShellInfoObject.FileDevPath);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Temp = gDevPathToText->ConvertDevicePathToText(ShellInfoObject.FileDevPath, TRUE, TRUE);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Temp = gDevPathToText->ConvertDevicePathToText(ShellInfoObject.ImageDevPath, TRUE, TRUE);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Temp = gDevPathToText->ConvertDevicePathToText(DevPath, TRUE, TRUE);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT((Temp == NULL && Size == 0) || (Temp != NULL));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // de-allocate and return
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Utility cleanup function for EFI_SHELL_FILE_INFO objects.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 1) frees all pointers (non-NULL)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 2) Closes the SHELL_FILE_HANDLE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileListNode pointer to the list node to free
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ShellInfoObject.NewEfiShellProtocol->CloseFile(FileListNode->Handle);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Frees the file list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function cleans up the file list and any related data structures. It has no
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync impact on the files themselves.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileList The file list to free. Type EFI_SHELL_FILE_INFO is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync defined in OpenFileList()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Free the file list successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for ( ShellFileListItem = (EFI_SHELL_FILE_INFO*)GetFirstNode(&(*FileList)->Link)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ; ShellFileListItem = (EFI_SHELL_FILE_INFO*)GetFirstNode(&(*FileList)->Link)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Deletes the duplicate file names files in the given file list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function deletes the reduplicate files in the given file list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileList A pointer to the first entry in the file list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Always success.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for ( ShellFileListItem = (EFI_SHELL_FILE_INFO*)GetFirstNode(&(*FileList)->Link)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ; !IsNull(&(*FileList)->Link, &ShellFileListItem->Link)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ; ShellFileListItem = (EFI_SHELL_FILE_INFO*)GetNextNode(&(*FileList)->Link, &ShellFileListItem->Link)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for ( ShellFileListItem2 = (EFI_SHELL_FILE_INFO*)GetNextNode(&(*FileList)->Link, &ShellFileListItem->Link)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ; !IsNull(&(*FileList)->Link, &ShellFileListItem2->Link)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ; ShellFileListItem2 = (EFI_SHELL_FILE_INFO*)GetNextNode(&(*FileList)->Link, &ShellFileListItem2->Link)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Allocates and duplicates a EFI_SHELL_FILE_INFO node.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Node The node to copy from.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Save TRUE to set Node->Handle to NULL, FALSE otherwise.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL a memory allocation error ocurred
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return != NULL a pointer to the new node
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NewNode = AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NewNode->FullName = AllocateZeroPool(StrSize(Node->FullName));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NewNode->FileName = AllocateZeroPool(StrSize(Node->FileName));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NewNode->Info = AllocateZeroPool((UINTN)Node->Info->Size);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync StrCpy((CHAR16*)NewNode->FullName, Node->FullName);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync StrCpy((CHAR16*)NewNode->FileName, Node->FileName);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem(NewNode->Info, Node->Info, (UINTN)Node->Info->Size);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Allocates and populates a EFI_SHELL_FILE_INFO structure. if any memory operation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync failed it will return NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] BasePath the Path to prepend onto filename for FullPath
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Status Status member initial value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FullName FullName member initial value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileName FileName member initial value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Handle Handle member initial value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Info Info struct to copy.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL An error ocurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return a pointer to the newly allocated structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ShellFileListItem = AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ShellFileListItem->Info = AllocateZeroPool((UINTN)Info->Size);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem(ShellFileListItem->Info, Info, (UINTN)Info->Size);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ShellFileListItem->FileName = StrnCatGrow(&TempString, 0, FileName, 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT((TempString == NULL && Size == 0) || (TempString != NULL));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TempString = StrnCatGrow(&TempString, &Size, BasePath, 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT((TempString == NULL && Size == 0) || (TempString != NULL));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TempString = StrnCatGrow(&TempString, &Size, ShellFileListItem->FileName, 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Find all files in a specified directory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileDirHandle Handle of the directory to search.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileList On return, points to the list of files in the directory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync or NULL if there are no files in the directory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS File information was returned successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_VOLUME_CORRUPTED The file system structures have been corrupted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The device reported an error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MEDIA The device media is not present.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The FileDirHandle was not a directory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return An error from FileHandleGetFileName().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = FileHandleGetFileName(FileDirHandle, &BasePath);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (ShellFileHandleGetPath(FileDirHandle) != NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TempString = StrnCatGrow(&TempString, &Size, ShellFileHandleGetPath(FileDirHandle), 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TempString = StrnCatGrow(&TempString, &Size, BasePath, 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for ( Status = FileHandleFindFirstFile(FileDirHandle, &FileInfo)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ; Status = FileHandleFindNextFile(FileDirHandle, FileInfo, &NoFile)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // allocate a new EFI_SHELL_FILE_INFO and populate it...
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT((TempString == NULL && Size == 0) || (TempString != NULL));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TempString = StrnCatGrow(&TempString, &Size, BasePath, 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TempString = StrnCatGrow(&TempString, &Size, FileInfo->FileName, 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ShellFileListItem = CreateAndPopulateShellFileInfo(
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_SUCCESS, // success since we didnt fail to open it...
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ShellFileList = (EFI_SHELL_FILE_INFO*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync InsertTailList(&ShellFileList->Link, &ShellFileListItem->Link);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Updates a file name to be preceeded by the mapped drive name
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] BasePath the Mapped drive name to prepend
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Path pointer to pointer to the file name to update.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // convert a local path to an absolute path
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT((Path2 == NULL && Path2Size == 0) || (Path2 != NULL));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT((Path2 == NULL && Path2Size == 0) || (Path2 != NULL));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync StrnCatGrow(&Path2, &Path2Size, (*Path)[0] == L'\\'?(*Path) + 1 :*Path, 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If FileHandle is a directory then the function reads from FileHandle and reads in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync each of the FileInfo structures. If one of them matches the Pattern's first
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync "level" then it opens that handle and calls itself on that handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If FileHandle is a file and matches all of the remaining Pattern (which would be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync on its last node), then add a EFI_SHELL_FILE_INFO object for this file to fileList.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Upon a EFI_SUCCESS return fromt he function any the caller is responsible to call
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FreeFileList with FileList.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FilePattern The FilePattern to check against.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] UnicodeCollation The pointer to EFI_UNICODE_COLLATION_PROTOCOL structure
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileHandle The FileHandle to start with
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] FileList pointer to pointer to list of found files.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ParentNode The node for the parent. Same file as identified by HANDLE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] MapName The file system name this file is on.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS all files were found and the FileList contains a list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND no files were found
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES a memory allocation failed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_UNICODE_COLLATION_PROTOCOL *UnicodeCollation,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ; *NextFilePatternStart != CHAR_NULL && *NextFilePatternStart != L'\\'
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CurrentFilePattern = AllocateZeroPool((NextFilePatternStart-FilePattern+1)*sizeof(CHAR16));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync StrnCpy(CurrentFilePattern, FilePattern, NextFilePatternStart-FilePattern);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Add the current parameter FileHandle to the list, then end...
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NewShellNode = InternalDuplicateShellFileInfo((EFI_SHELL_FILE_INFO*)ParentNode, TRUE);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *FileList = AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Add to the returning to use list
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync InsertTailList(&(*FileList)->Link, &NewShellNode->Link);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = EfiShellFindFilesInDir(FileHandle, &ShellInfo);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for ( ShellInfoNode = (EFI_SHELL_FILE_INFO*)GetFirstNode(&ShellInfo->Link)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ; ShellInfoNode = (EFI_SHELL_FILE_INFO*)GetNextNode(&ShellInfo->Link, &ShellInfoNode->Link)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (UnicodeCollation->MetaiMatch(UnicodeCollation, (CHAR16*)ShellInfoNode->FileName, CurrentFilePattern)){
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (ShellInfoNode->FullName != NULL && StrStr(ShellInfoNode->FullName, L":") == NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (Directory && !EFI_ERROR(Status) && ShellInfoNode->FullName != NULL && ShellInfoNode->FileName != NULL){
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // should be a directory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // don't open the . and .. directories
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Open the directory since we need that handle in the next recursion.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ShellInfoNode->Status = EfiShellOpenFileByName (ShellInfoNode->FullName, &ShellInfoNode->Handle, EFI_FILE_MODE_READ);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // recurse with the next part of the pattern
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = ShellSearchHandle(NextFilePatternStart, UnicodeCollation, ShellInfoNode->Handle, FileList, ShellInfoNode, MapName);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // should be a file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // copy the information we need into a new Node
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NewShellNode = InternalDuplicateShellFileInfo(ShellInfoNode, FALSE);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *FileList = AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Add to the returning to use list
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync InsertTailList(&(*FileList)->Link, &NewShellNode->Link);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Find files that match a specified pattern.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function searches for all files and directories that match the specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FilePattern. The FilePattern can contain wild-card characters. The resulting file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information is placed in the file list FileList.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Wildcards are processed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync according to the rules specified in UEFI Shell 2.0 spec section 3.7.1.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The files in the file list are not opened. The OpenMode field is set to 0 and the FileInfo
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync field is set to NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if *FileList is not NULL then it must be a pre-existing and properly initialized list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FilePattern Points to a NULL-terminated shell file path, including wildcards.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileList On return, points to the start of a file list containing the names
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of all matching files or else points to NULL if no matching files
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync were found. only on a EFI_SUCCESS return will; this be non-NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Files found. FileList is a valid list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND No files found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MEDIA The device has no media
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The device reported an error
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PatternCopy = AllocateZeroPool(StrSize(FilePattern));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MapName = StrnCatGrow(&MapName, NULL, PatternCopy, Count);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RootDevicePath = EfiShellGetDevicePathFromFilePath(PatternCopy);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = EfiShellOpenRoot(RootDevicePath, &RootFileHandle);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = ShellSearchHandle(PatternCurrentLocation, gUnicodeCollation, RootFileHandle, FileList, NULL, MapName);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Opens the files that match the path specified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function opens all of the files specified by Path. Wildcards are processed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync according to the rules specified in UEFI Shell 2.0 spec section 3.7.1. Each
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync matching file has an EFI_SHELL_FILE_INFO structure created in a linked list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Path A pointer to the path string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param OpenMode Specifies the mode used to open each file, EFI_FILE_MODE_READ or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_FILE_MODE_WRITE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileList Points to the start of a list of files opened.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Create the file list successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return Others Can't create the file list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // convert a local path to an absolute path
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT((Path2 == NULL && Path2Size == 0) || (Path2 != NULL));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT((Path2 == NULL && Path2Size == 0) || (Path2 != NULL));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // do the search
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // We had no errors so open all the files (that are not already opened...)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for ( ShellFileListItem = (EFI_SHELL_FILE_INFO*)GetFirstNode(&(*FileList)->Link)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ; !IsNull(&(*FileList)->Link, &ShellFileListItem->Link)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ; ShellFileListItem = (EFI_SHELL_FILE_INFO*)GetNextNode(&(*FileList)->Link, &ShellFileListItem->Link)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (ShellFileListItem->Status == 0 && ShellFileListItem->Handle == NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ShellFileListItem->Status = EfiShellOpenFileByName (ShellFileListItem->FullName, &ShellFileListItem->Handle, OpenMode);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function updated with errata.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Gets either a single or list of environment variables.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If name is not NULL then this function returns the current value of the specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync environment variable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Name is NULL, then a list of all environment variable names is returned. Each is a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NULL terminated string with a double NULL terminating the list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Name A pointer to the environment variable name. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Name is NULL, then the function will return all
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the defined shell environment variables. In
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the case where multiple environment variables are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync being returned, each variable will be terminated by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync a NULL, and the list will be terminated by a double
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return !=NULL A pointer to the returned string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The returned pointer does not need to be freed by the caller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL The environment variable doesn't exist or there are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync no environment variables.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Get all our environment variables
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Build the semi-colon delimited list. (2 passes)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ; Node = (ENV_VAR_LIST*)GetNextNode(&List, &Node->Link)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ; Node = (ENV_VAR_LIST*)GetNextNode(&List, &Node->Link)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CurrentWriteLocation += StrLen(CurrentWriteLocation) + 1;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Free the list...
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // We are doing a specific environment variable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // get the size we need for this EnvVariable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = SHELL_GET_ENVIRONMENT_VARIABLE(Name, &Size, Buffer);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Allocate the space and recall the get function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = SHELL_GET_ENVIRONMENT_VARIABLE(Name, &Size, Buffer);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // we didnt get it (might not exist)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // free the memory if we allocated any and return NULL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // return the buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Internal variable setting function. Allows for setting of the read only variables.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Name Points to the NULL-terminated environment variable name.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Value Points to the NULL-terminated environment variable value. If the value is an
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync empty string then the environment variable is deleted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The environment variable was successfully updated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return (SHELL_SET_ENVIRONMENT_VARIABLE_V(Name, StrSize(Value), Value));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return (SHELL_SET_ENVIRONMENT_VARIABLE_NV(Name, StrSize(Value), Value));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sets the environment variable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function changes the current value of the specified environment variable. If the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync environment variable exists and the Value is an empty string, then the environment
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync variable is deleted. If the environment variable exists and the Value is not an empty
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync string, then the value of the environment variable is changed. If the environment
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync variable does not exist and the Value is an empty string, there is no action. If the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync environment variable does not exist and the Value is a non-empty string, then the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync environment variable is created and assigned the specified value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync For a description of volatile and non-volatile environment variables, see UEFI Shell
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 2.0 specification section 3.6.1.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Name Points to the NULL-terminated environment variable name.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Value Points to the NULL-terminated environment variable value. If the value is an
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync empty string then the environment variable is deleted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The environment variable was successfully updated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Make sure we dont 'set' a predefined read only variable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync L"cwd") == 0
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync L"Lasterror") == 0
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync L"profiles") == 0
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync L"uefishellsupport") == 0
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync L"uefishellversion") == 0
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync L"uefiversion") == 0
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return (InternalEfiShellSetEnv(Name, Value, Volatile));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns the current directory on the specified device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If FileSystemMapping is NULL, it returns the current working directory. If the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FileSystemMapping is not NULL, it returns the current directory associated with the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FileSystemMapping. In both cases, the returned name includes the file system
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mapping (i.e. fs0:\current-dir).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileSystemMapping A pointer to the file system mapping. If NULL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then the current working directory is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval !=NULL The current directory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL Current directory does not exist.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // if parameter is NULL, use current
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MapListItem = ShellCommandFindMapItem(FileSystemMapping);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT((PathToReturn == NULL && Size == 0) || (PathToReturn != NULL));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PathToReturn = StrnCatGrow(&PathToReturn, &Size, MapListItem->MapName, 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PathToReturn = StrnCatGrow(&PathToReturn, &Size, MapListItem->CurrentDirectoryPath, 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Changes the current directory on the specified device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the FileSystem is NULL, and the directory Dir does not contain a file system's
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mapped name, this function changes the current working directory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the FileSystem is NULL and the directory Dir contains a mapped name, then the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync current file system and the current directory on that file system are changed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If FileSystem is NULL, and Dir is not NULL, then this changes the current working file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If FileSystem is not NULL and Dir is not NULL, then this function changes the current
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync directory on the specified file system.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the current working directory or the current working file system is changed then the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync %cwd% environment variable will be updated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileSystem A pointer to the file system's mapped name. If NULL, then the current working
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync directory is changed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Dir Points to the NULL-terminated directory on the device specified by FileSystem.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The operation was sucessful
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The file system could not be found
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((FileSystem == NULL && Dir == NULL) || Dir == NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DirectoryName = StrnCatGrow(&DirectoryName, NULL, Dir, 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // determine the file system mapping to use
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MapName = StrnCatGrow(&MapName, NULL, DirectoryName, (StrStr(DirectoryName, L":")-DirectoryName+1));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // find the file system mapping's entry in the list
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // or use current
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // make that the current file system mapping
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // now update the MapListItem's current directory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (MapListItem->CurrentDirectoryPath != NULL && DirectoryName[StrLen(DirectoryName) - 1] != L':') {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, DirectoryName+StrLen(MapName), 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, DirectoryName, 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((MapListItem->CurrentDirectoryPath != NULL && MapListItem->CurrentDirectoryPath[StrLen(MapListItem->CurrentDirectoryPath)-1] != L'\\') || (MapListItem->CurrentDirectoryPath == NULL)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, L"\\", 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // cant have a mapping in the directory...
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // FileSystem != NULL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// gShellCurDir = MapListItem;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // change current dir on that file system
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DEBUG_CODE(MapListItem->CurrentDirectoryPath = NULL;);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, FileSystem, 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, L"\\", 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, DirectoryName, 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (MapListItem->CurrentDirectoryPath != NULL && MapListItem->CurrentDirectoryPath[StrLen(MapListItem->CurrentDirectoryPath)-1] != L'\\') {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, L"\\", 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // if updated the current directory then update the environment variable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT((TempString == NULL && Size == 0) || (TempString != NULL));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync StrnCatGrow(&TempString, &Size, MapListItem->MapName, 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT((TempString == NULL && Size == 0) || (TempString != NULL));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync StrnCatGrow(&TempString, &Size, MapListItem->CurrentDirectoryPath, 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = InternalEfiShellSetEnv(L"cwd", TempString, TRUE);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Return help information about a specific command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns the help information for the specified command. The help text
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync can be internal to the shell or can be from a UEFI Shell manual page.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Sections is specified, then each section name listed will be compared in a casesensitive
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync manner, to the section names described in Appendix B. If the section exists,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync it will be appended to the returned help text. If the section does not exist, no
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information will be returned. If Sections is NULL, then all help text information
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync available will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Command Points to the NULL-terminated UEFI Shell command name.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Sections Points to the NULL-terminated comma-delimited
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync section names to return. If NULL, then all
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync sections will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param HelpText On return, points to a callee-allocated buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync containing all specified help text.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The help text was returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The necessary buffer could not be allocated to hold the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync returned help text.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER HelpText is NULL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND There is no help text available for Command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ManFileName = ShellCommandGetManFileNameHandler(Command);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return (ProcessManFile(ManFileName, Command, Sections, NULL, HelpText));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return (ProcessManFile(Command, Command, Sections, NULL, HelpText));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Gets the enable status of the page break output mode.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync User can use this function to determine current page break mode.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE The page break output mode is enabled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE The page break output mode is disabled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Judges whether the active shell is the root shell.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function makes the user to know that whether the active Shell is the root shell.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE The active Shell is the root Shell.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE The active Shell is NOT the root Shell.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync function to return a semi-colon delimeted list of all alias' in the current shell
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync up to caller to free the memory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL No alias' were found
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL An error ocurred getting alias'
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return !NULL a list of all alias'
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gRT->QueryVariableInfo(EFI_VARIABLE_NON_VOLATILE|EFI_VARIABLE_BOOTSERVICE_ACCESS, &MaxStorSize, &RemStorSize, &MaxVarSize);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync VariableName = AllocateZeroPool((UINTN)MaxVarSize);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gRT->GetNextVariableName(&NameSize, VariableName, &Guid);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Alias = GetVariable(VariableName, &gShellAliasGuid);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT((RetVal == NULL && RetSize == 0) || (RetVal != NULL));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RetVal = StrnCatGrow(&RetVal, &RetSize, VariableName, 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync } // compare guid
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns the command associated with a alias or a list of all
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Alias Points to the NULL-terminated shell alias.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If this parameter is NULL, then all
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync aliases will be returned in ReturnedData.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Volatile upon return of a single command if TRUE indicates
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this is stored in a volatile fashion. FALSE otherwise.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return If Alias is not NULL, it will return a pointer to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the NULL-terminated command for that alias.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Alias is NULL, ReturnedData points to a ';'
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync delimited list of alias (e.g.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ReturnedData = "dir;del;copy;mfp") that is NULL-terminated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL an error ocurred
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL Alias was not a valid Alias
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return (AddBufferToFreeList(GetVariable((CHAR16*)Alias, &gShellAliasGuid)));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gRT->GetVariable((CHAR16*)Alias, &gShellAliasGuid, &Attribs, &RetSize, RetVal);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gRT->GetVariable((CHAR16*)Alias, &gShellAliasGuid, &Attribs, &RetSize, RetVal);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((EFI_VARIABLE_NON_VOLATILE & Attribs) == EFI_VARIABLE_NON_VOLATILE) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return (AddBufferToFreeList(InternalEfiShellGetListAlias()));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Changes a shell command alias.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this function does not check for built in alias'.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Command Points to the NULL-terminated shell command or existing alias.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Command refers to an alias, that alias will be deleted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Alias being set will be stored in a non-volatile fashion.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Alias created or deleted successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // We must be trying to remove one if Alias is NULL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // remove an alias (but passed in COMMAND parameter)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return (gRT->SetVariable((CHAR16*)Command, &gShellAliasGuid, 0, 0, NULL));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Add and replace are the same
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // We dont check the error return on purpose since the variable may not exist.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync gRT->SetVariable((CHAR16*)Command, &gShellAliasGuid, 0, 0, NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return (gRT->SetVariable((CHAR16*)Alias, &gShellAliasGuid, EFI_VARIABLE_BOOTSERVICE_ACCESS|(Volatile?0:EFI_VARIABLE_NON_VOLATILE), StrSize(Command), (VOID*)Command));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Changes a shell command alias.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Command Points to the NULL-terminated shell command or existing alias.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Command refers to an alias, that alias will be deleted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Replace If TRUE and the alias already exists, then the existing alias will be replaced. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FALSE and the alias already exists, then the existing alias is unchanged and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_ACCESS_DENIED is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Alias being set will be stored in a non-volatile fashion.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Alias created or deleted successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The alias is a built-in alias or already existed and Replace was set to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // cant set over a built in alias
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (ShellCommandIsOnAliasList(Alias==NULL?Command:Alias)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (Command == NULL || *Command == CHAR_NULL || StrLen(Command) == 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (EfiShellGetAlias(Command, NULL) != NULL && !Replace) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return (InternalSetAlias(Command, Alias, Volatile));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Pure FILE_HANDLE operations are passed to FileHandleLib
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// these functions are indicated by the *
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (EFI_SHELL_GET_FILE_POSITION)FileHandleGetPosition, //*
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (EFI_SHELL_SET_FILE_POSITION)FileHandleSetPosition, //*
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Function to create and install on the current handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Will overwrite any existing ShellProtocols in the system to be sure that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the current shell is in control.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This must be removed via calling CleanUpShellProtocol().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] NewShell The pointer to the pointer to the structure
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to install.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The operation was successful.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return An error from LocateHandle, CreateEvent, or other core function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync InitializeListHead(&ShellInfoObject.OldShellList.Link);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Initialize EfiShellProtocol object...
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Get the size of the buffer we need.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Allocate and recall with buffer of correct size
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // now overwrite each of them, but save the info to restore when we end.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (HandleCounter = 0 ; HandleCounter < (BufferSize/sizeof(EFI_HANDLE)) ; HandleCounter++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OldProtocolNode = AllocateZeroPool(sizeof(SHELL_PROTOCOL_HANDLE_LIST));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // reinstall over the old one...
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // we reinstalled sucessfully. log this so we can reverse it later.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // add to the list for subsequent...
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync InsertTailList(&ShellInfoObject.OldShellList.Link, &OldProtocolNode->Link);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT(IsListEmpty(&ShellInfoObject.OldShellList.Link));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // no one else published yet. just publish it ourselves.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///@todo support ShellEnvironment2
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///@todo do we need to support ShellEnvironment (not ShellEnvironment2) also?
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Opposite of CreatePopulateInstallShellProtocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Free all memory and restore the system to the state it was in before calling
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CreatePopulateInstallShellProtocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] NewShell The pointer to the new shell protocol structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The operation was successful.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // if we need to restore old protocols...
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (!IsListEmpty(&ShellInfoObject.OldShellList.Link)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (Node2 = (SHELL_PROTOCOL_HANDLE_LIST *)GetFirstNode(&ShellInfoObject.OldShellList.Link)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ; !IsListEmpty (&ShellInfoObject.OldShellList.Link)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ; Node2 = (SHELL_PROTOCOL_HANDLE_LIST *)GetFirstNode(&ShellInfoObject.OldShellList.Link)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gBS->ReinstallProtocolInterface(Node2->Handle,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // no need to restore
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gBS->UninstallProtocolInterface(gImageHandle,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gBS->CloseEvent(NewShell->ExecutionBreak);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = SimpleEx->UnregisterKeyNotify(SimpleEx, ShellInfoObject.CtrlCNotifyHandle1);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = SimpleEx->UnregisterKeyNotify(SimpleEx, ShellInfoObject.CtrlCNotifyHandle2);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = SimpleEx->UnregisterKeyNotify(SimpleEx, ShellInfoObject.CtrlCNotifyHandle3);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = SimpleEx->UnregisterKeyNotify(SimpleEx, ShellInfoObject.CtrlCNotifyHandle4);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = SimpleEx->UnregisterKeyNotify(SimpleEx, ShellInfoObject.CtrlSNotifyHandle1);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = SimpleEx->UnregisterKeyNotify(SimpleEx, ShellInfoObject.CtrlSNotifyHandle2);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = SimpleEx->UnregisterKeyNotify(SimpleEx, ShellInfoObject.CtrlSNotifyHandle3);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = SimpleEx->UnregisterKeyNotify(SimpleEx, ShellInfoObject.CtrlSNotifyHandle4);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Notification function for keystrokes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] KeyData The key that was pressed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The operation was successful.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// ShellPrintEx(-1,-1,L" <Notify> ");
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((KeyData->Key.UnicodeChar == L'c' || KeyData->Key.UnicodeChar == 3) &&
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (KeyData->KeyState.KeyShiftState == (EFI_SHIFT_STATE_VALID|EFI_LEFT_CONTROL_PRESSED) || KeyData->KeyState.KeyShiftState == (EFI_SHIFT_STATE_VALID|EFI_RIGHT_CONTROL_PRESSED))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (ShellInfoObject.NewEfiShellProtocol->ExecutionBreak == NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return (gBS->SignalEvent(ShellInfoObject.NewEfiShellProtocol->ExecutionBreak));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (KeyData->KeyState.KeyShiftState == (EFI_SHIFT_STATE_VALID|EFI_LEFT_CONTROL_PRESSED) || KeyData->KeyState.KeyShiftState == (EFI_SHIFT_STATE_VALID|EFI_RIGHT_CONTROL_PRESSED))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Function to start monitoring for CTRL-C using SimpleTextInputEx. This
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync feature's enabled state was not known when the shell initially launched.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The feature is enabled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There is not enough mnemory available.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (ShellInfoObject.NewEfiShellProtocol->ExecutionBreak == NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync KeyData.KeyState.KeyShiftState = EFI_SHIFT_STATE_VALID|EFI_LEFT_CONTROL_PRESSED;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync KeyData.KeyState.KeyShiftState = EFI_SHIFT_STATE_VALID|EFI_RIGHT_CONTROL_PRESSED;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync KeyData.KeyState.KeyShiftState = EFI_SHIFT_STATE_VALID|EFI_LEFT_CONTROL_PRESSED;