#include "UefiShellLevel2CommandsLib.h"
#include <Protocol/SimpleFileSystem.h>
#include <Protocol/BlockIo.h>
#include <Library/DevicePathLib.h>
#include <Library/HandleParsingLib.h>
#include <Library/SortLib.h>

Functions
BOOLEAN	IsNumberLetterOnly (IN CONST CHAR16 *String, IN CONST UINTN Len)

BOOLEAN	SearchList (IN CONST CHAR16 List, IN CONST CHAR16 MetaTarget, OUT CHAR16 *FullName OPTIONAL, IN CONST BOOLEAN Meta, IN CONST BOOLEAN SkipTrailingNumbers, IN CONST CHAR16 Target)

CHAR16 *	GetDeviceMediaType (IN EFI_DEVICE_PATH_PROTOCOL *DevicePath)

BOOLEAN	IsRemoveableDevice (IN EFI_DEVICE_PATH_PROTOCOL *DevicePath)

BOOLEAN	MappingListHasType (IN CONST CHAR16 MapList, IN CONST CHAR16 Specific, IN CONST CHAR16 *TypeString, IN CONST BOOLEAN Normal, IN CONST BOOLEAN Consist)

EFI_STATUS	PerformSingleMappingDisplay (IN CONST BOOLEAN Verbose, IN CONST BOOLEAN Consist, IN CONST BOOLEAN Normal, IN CONST CHAR16 TypeString, IN CONST BOOLEAN SFO, IN CONST CHAR16 Specific OPTIONAL, IN CONST EFI_HANDLE Handle)

EFI_STATUS	PerformSingleMappingDelete (IN CONST CHAR16 *Specific, IN CONST EFI_HANDLE Handle)

SHELL_STATUS	PerformMappingDisplay (IN CONST BOOLEAN Verbose, IN CONST BOOLEAN Consist, IN CONST BOOLEAN Normal, IN CONST CHAR16 TypeString, IN CONST BOOLEAN SFO, IN CONST CHAR16 Specific OPTIONAL, IN CONST BOOLEAN Header)

SHELL_STATUS	PerformMappingDisplay2 (IN CONST BOOLEAN Verbose, IN CONST BOOLEAN Consist, IN CONST BOOLEAN Normal, IN CONST CHAR16 TypeString, IN CONST BOOLEAN SFO, IN CONST CHAR16 Specific OPTIONAL)

EFI_STATUS	PerformMappingDelete (IN CONST CHAR16 *Specific)

SHELL_STATUS	AddMappingFromMapping (IN CONST CHAR16 Map, IN CONST CHAR16 SName)

SHELL_STATUS	AddMappingFromHandle (IN CONST EFI_HANDLE Handle, IN CONST CHAR16 *SName)

VOID	ProbeForMediaChange (VOID)

SHELL_STATUS EFIAPI	ShellCommandRunMap (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

Variables
CONST CHAR16	Cd [] = L"cd*"

CONST CHAR16	Hd [] = L"hd*"

CONST CHAR16	Fp [] = L"fp*"

CONST CHAR16	AnyF [] = L"F*"

STATIC CONST SHELL_PARAM_ITEM	MapParamList []

Detailed Description

Main file for map shell level 2 command.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file Map.c.

Function Documentation

◆ AddMappingFromHandle()

SHELL_STATUS AddMappingFromHandle	(	IN CONST EFI_HANDLE	Handle,
		IN CONST CHAR16 *	SName
	)

function to add a mapping from an EFI_HANDLE.

This function will get the device path associated with the Handle and call SetMap.

Parameters

[in]	Handle	The handle to add a mapping for
[in]	SName	The name of the new mapping

Return values

SHELL_SUCCESS	the mapping was added
SHELL_INVALID_PARAMETER	SName was not valid for a map name.

Returns: Shell version of a return value from either gBS->OpenProtocol or EfiShellProtocol->SetMap

Definition at line 992 of file Map.c.

◆ AddMappingFromMapping()

SHELL_STATUS AddMappingFromMapping	(	IN CONST CHAR16 *	Map,
		IN CONST CHAR16 *	SName
	)

function to add a mapping from mapping.

This function will get the device path associated with the mapping and call SetMap.

Parameters

[in]	Map	The Map to add a mapping for
[in]	SName	The name of the new mapping

Return values

SHELL_SUCCESS	the mapping was added
SHELL_INVALID_PARAMETER	the device path for Map could not be retrieved.

Returns: Shell version of a return value from EfiShellProtocol->SetMap

Definition at line 934 of file Map.c.

◆ GetDeviceMediaType()

CHAR16 * GetDeviceMediaType ( IN EFI_DEVICE_PATH_PROTOCOL * DevicePath )

Determine what type of device is represented and return it's string. The string is in allocated memory and must be callee freed. The HII is is listed below. The actual string cannot be determined.

Parameters

[in] DevicePath The device to analyze.

Return values

STR_MAP_MEDIA_UNKNOWN	The media type is unknown.
STR_MAP_MEDIA_HARDDISK	The media is a hard drive.
STR_MAP_MEDIA_CDROM	The media is a CD ROM.
STR_MAP_MEDIA_FLOPPY	The media is a floppy drive.

Definition at line 140 of file Map.c.

◆ IsNumberLetterOnly()

BOOLEAN IsNumberLetterOnly	(	IN CONST CHAR16 *	String,
		IN CONST UINTN	Len
	)

Determine if a string has only numbers and letters.

This is useful for such things as Map names which can only be letters and numbers.

Parameters

[in]	String	pointer to the string to analyze,
[in]	Len	Number of characters to analyze.

Return values

TRUE	String has only numbers and letters
FALSE	String has at least one other character.

Definition at line 31 of file Map.c.

◆ IsRemoveableDevice()

BOOLEAN IsRemoveableDevice ( IN EFI_DEVICE_PATH_PROTOCOL * DevicePath )

Function to detemine if a handle has removable storage.

Parameters

[in] DevicePath DevicePath to test.

Return values

TRUE	The handle has removable storage.
FALSE	The handle does not have removable storage.

Definition at line 185 of file Map.c.

◆ MappingListHasType()

BOOLEAN MappingListHasType	(	IN CONST CHAR16 *	MapList,
		IN CONST CHAR16 *	Specific,
		IN CONST CHAR16 *	TypeString,
		IN CONST BOOLEAN	Normal,
		IN CONST BOOLEAN	Consist
	)

Function to detemine if a something on the map list matches.

Parameters

[in]	MapList	The pointer to the list to test.
[in]	Specific	The pointer to a specific name to test for.
[in]	TypeString	The pointer to the list of types.
[in]	Normal	Always show normal mappings.
[in]	Consist	Always show consistent mappings.

Return values

TRUE	The map should be displayed.
FALSE	The map should not be displayed.

Definition at line 223 of file Map.c.

◆ PerformMappingDelete()

EFI_STATUS PerformMappingDelete ( IN CONST CHAR16 * Specific )

Delete a specific map.

Parameters

[in] Specific The pointer to the name of the map to delete.

Return values

EFI_INVALID_PARAMETER	Specific was NULL.
EFI_SUCCESS	The operation was successful.
EFI_NOT_FOUND	Specific could not be found.

Definition at line 788 of file Map.c.

◆ PerformMappingDisplay()

SHELL_STATUS PerformMappingDisplay	(	IN CONST BOOLEAN	Verbose,
		IN CONST BOOLEAN	Consist,
		IN CONST BOOLEAN	Normal,
		IN CONST CHAR16 *	TypeString,
		IN CONST BOOLEAN	SFO,
		IN CONST CHAR16 *Specific	OPTIONAL,
		IN CONST BOOLEAN	Header
	)

Function to display mapping information to the user.

If Specific is specified then Consist and Normal will be ignored since information will be printed for the specific item only.

Parameters

[in]	Verbose	TRUE to display (extra) verbose information.
[in]	Consist	TRUE to display consistent mappings.
[in]	Normal	TRUE to display normal (not consist) mappings.
[in]	TypeString	Pointer to string of filter types.
[in]	SFO	TRUE to display output in Standard Output Format.
[in]	Specific	Pointer to string for specific map to display.
[in]	Header	TRUE to print the header block.

Return values

SHELL_SUCCESS	The display was printed.
SHELL_INVALID_PARAMETER	One of Consist or Normal must be TRUE if no Specific.

Definition at line 540 of file Map.c.

◆ PerformMappingDisplay2()

SHELL_STATUS PerformMappingDisplay2	(	IN CONST BOOLEAN	Verbose,
		IN CONST BOOLEAN	Consist,
		IN CONST BOOLEAN	Normal,
		IN CONST CHAR16 *	TypeString,
		IN CONST BOOLEAN	SFO,
		IN CONST CHAR16 *Specific	OPTIONAL
	)

Perform a mapping display and parse for multiple types in the TypeString.

Parameters

[in]	Verbose	TRUE to use verbose output.
[in]	Consist	TRUE to display consistent names.
[in]	Normal	TRUE to display normal names.
[in]	TypeString	An optional comma-delimited list of types.
[in]	SFO	TRUE to display in SFO format. See Spec.
[in]	Specific	An optional specific map name to display alone.

Return values

SHELL_INVALID_PARAMETER	A parameter was invalid.
SHELL_SUCCESS	The display was successful.

See also: PerformMappingDisplay

Definition at line 734 of file Map.c.

◆ PerformSingleMappingDelete()

EFI_STATUS PerformSingleMappingDelete	(	IN CONST CHAR16 *	Specific,
		IN CONST EFI_HANDLE	Handle
	)

Delete Specific from the list of maps for device Handle.

Parameters

[in]	Specific	The name to delete.
[in]	Handle	The device to look on.

Return values

EFI_SUCCESS	The delete was successful.
EFI_NOT_FOUND	Name was not a map on Handle.

Definition at line 487 of file Map.c.

◆ PerformSingleMappingDisplay()

EFI_STATUS PerformSingleMappingDisplay	(	IN CONST BOOLEAN	Verbose,
		IN CONST BOOLEAN	Consist,
		IN CONST BOOLEAN	Normal,
		IN CONST CHAR16 *	TypeString,
		IN CONST BOOLEAN	SFO,
		IN CONST CHAR16 *Specific	OPTIONAL,
		IN CONST EFI_HANDLE	Handle
	)

Display a single map line for device Handle if conditions are met.

Parameters

[in]	Verbose	TRUE to display (extra) verbose information.
[in]	Consist	TRUE to display consistent mappings.
[in]	Normal	TRUE to display normal (not consist) mappings.
[in]	TypeString	pointer to string of filter types.
[in]	SFO	TRUE to display output in Standard Output Format.
[in]	Specific	pointer to string for specific map to display.
[in]	Handle	The handle to display from.

Return values

EFI_SUCCESS The mapping was displayed.

Definition at line 304 of file Map.c.

◆ ProbeForMediaChange()

VOID ProbeForMediaChange ( VOID )

The routine issues dummy read for every physical block device to cause the BlockIo re-installed if media change happened.

Definition at line 1059 of file Map.c.

◆ SearchList()

BOOLEAN SearchList	(	IN CONST CHAR16 *	List,
		IN CONST CHAR16 *	MetaTarget,
		OUT CHAR16 **FullName	OPTIONAL,
		IN CONST BOOLEAN	Meta,
		IN CONST BOOLEAN	SkipTrailingNumbers,
		IN CONST CHAR16 *	Target
	)

Do a search in the Target delimited list.

Parameters

[in]	List	The list to seatch in.
[in]	MetaTarget	The item to search for. MetaMatching supported.
[out]	FullName	Optional pointer to an allocated buffer containing the match.
[in]	Meta	TRUE to use MetaMatching.
[in]	SkipTrailingNumbers	TRUE to allow for numbers after the MetaTarget.
[in]	Target	The single character that delimits list items (";" normally).

Definition at line 64 of file Map.c.

◆ ShellCommandRunMap()

SHELL_STATUS EFIAPI ShellCommandRunMap	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

Function for 'map' command.

Parameters

[in]	ImageHandle	Handle to the Image (NULL if Internal).
[in]	SystemTable	Pointer to the System Table (NULL if Internal).

Definition at line 1113 of file Map.c.

Variable Documentation

◆ AnyF

CONST CHAR16 AnyF[] = L"F*"

Definition at line 519 of file Map.c.

◆ Cd

CONST CHAR16 Cd[] = L"cd*"

Definition at line 516 of file Map.c.

◆ Fp

CONST CHAR16 Fp[] = L"fp*"

Definition at line 518 of file Map.c.

◆ Hd

CONST CHAR16 Hd[] = L"hd*"

Definition at line 517 of file Map.c.

◆ MapParamList

STATIC CONST SHELL_PARAM_ITEM MapParamList[]

Initial value:

= {
  { L"-d",   TypeValue },
  { L"-r",   TypeFlag  },
  { L"-v",   TypeFlag  },
  { L"-c",   TypeFlag  },
  { L"-f",   TypeFlag  },
  { L"-u",   TypeFlag  },
  { L"-t",   TypeValue },
  { L"-sfo", TypeValue },
  { NULL,    TypeMax   }
}

Definition at line 1042 of file Map.c.

Functions

Variables

Detailed Description

Function Documentation

◆ AddMappingFromHandle()

◆ AddMappingFromMapping()

◆ GetDeviceMediaType()

◆ IsNumberLetterOnly()

◆ IsRemoveableDevice()

◆ MappingListHasType()

◆ PerformMappingDelete()

◆ PerformMappingDisplay()

◆ PerformMappingDisplay2()

◆ PerformSingleMappingDelete()

◆ PerformSingleMappingDisplay()

◆ ProbeForMediaChange()

◆ SearchList()

◆ ShellCommandRunMap()

Variable Documentation

◆ AnyF

◆ Cd

◆ Fp

◆ Hd

◆ MapParamList