#include "UefiShellDriver1CommandsLib.h"

Functions
BOOLEAN	IsValidGuidString (IN CONST CHAR16 *String)

UINTN	HexCharToDecimal (IN CHAR16 Char)

EFI_STATUS	ConvertStrToGuid (IN CONST CHAR16 String, OUT GUID Guid)

EFI_STATUS	GetDriverName (IN EFI_HANDLE TheHandle, IN CONST CHAR8 Language, IN CHAR16 *NameFound)

BOOLEAN	IsDriverProt (IN CONST EFI_GUID *Guid)

CHAR16 *	GetProtocolInfoString (IN CONST EFI_HANDLE TheHandle, IN CONST CHAR8 Language, IN CONST CHAR16 Separator, IN CONST BOOLEAN Verbose, IN CONST BOOLEAN ExtraInfo)

EFI_STATUS	GetDriverImageName (IN EFI_HANDLE TheHandle, OUT CHAR16 **Name)

EFI_STATUS	DisplayDriverModelHandle (IN EFI_HANDLE Handle, IN BOOLEAN BestName, IN CONST CHAR8 *Language OPTIONAL)

VOID	DoDhByHandle (IN CONST EFI_HANDLE TheHandle, IN CONST BOOLEAN Verbose, IN CONST BOOLEAN Sfo, IN CONST CHAR8 *Language, IN CONST BOOLEAN DriverInfo, IN CONST BOOLEAN Multiple)

SHELL_STATUS	DoDhForHandleList (IN CONST EFI_HANDLE HandleList, IN CONST BOOLEAN Verbose, IN CONST BOOLEAN Sfo, IN CONST CHAR8 Language, IN CONST BOOLEAN DriverInfo)

SHELL_STATUS	DoDhByProtocolGuid (IN CONST GUID Guid, IN CONST BOOLEAN Verbose, IN CONST BOOLEAN Sfo, IN CONST CHAR8 Language, IN CONST BOOLEAN DriverInfo)

SHELL_STATUS	DoDhByProtocol (IN CONST CHAR16 Protocol, IN CONST BOOLEAN Verbose, IN CONST BOOLEAN Sfo, IN CONST CHAR8 Language, IN CONST BOOLEAN DriverInfo)

SHELL_STATUS	DoDecodeByProtocol (IN CONST CHAR16 Protocol, IN CONST CHAR8 Language)

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

Variables
STATIC CONST SHELL_PARAM_ITEM	ParamList []

STATIC CONST EFI_GUID *	UefiDriverModelProtocolsGuidArray []

UINTN	mGuidDataLen [] = { 8, 4, 4, 4, 12 }

Detailed Description

Main file for Dh shell Driver1 function.

(C) Copyright 2014-2015 Hewlett-Packard Development Company, L.P.
Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.
(C) Copyright 2017 Hewlett Packard Enterprise Development LP
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file Dh.c.

Function Documentation

◆ ConvertStrToGuid()

EFI_STATUS ConvertStrToGuid	(	IN CONST CHAR16 *	String,
		OUT GUID *	Guid
	)

Function try to convert a string to GUID format.

Parameters

[in]	String	The string will be converted.
[out]	Guid	Save the result convert from string.

Return values

EFI_SUCCESS	The string was successfully converted to a GUID.
EFI_UNSUPPORTED	The input string is not in registry format.

Definition at line 128 of file Dh.c.

◆ DisplayDriverModelHandle()

EFI_STATUS DisplayDriverModelHandle	(	IN EFI_HANDLE	Handle,
		IN BOOLEAN	BestName,
		IN CONST CHAR8 *Language	OPTIONAL
	)

Display driver model information for a given handle.

Parameters

[in]	Handle	The handle to display info on.
[in]	BestName	Use the best name?
[in]	Language	The language to output in.

Definition at line 416 of file Dh.c.

◆ DoDecodeByProtocol()

SHELL_STATUS DoDecodeByProtocol	(	IN CONST CHAR16 *	Protocol,
		IN CONST CHAR8 *	Language
	)

Function to display decode information by Protocol. The parameter Protocol is either a GUID or the name of protocol. If the parameter Protocol is NULL, the function will print all decode information.

Parameters

[in]	Protocol	The pointer to the name or GUID of protocol.
[in]	Language	Language string per UEFI specification.

Return values

SHELL_SUCCESS	The operation was successful.
SHELL_OUT_OT_RESOURCES	A memory allocation failed.

Definition at line 1026 of file Dh.c.

◆ DoDhByHandle()

VOID DoDhByHandle	(	IN CONST EFI_HANDLE	TheHandle,
		IN CONST BOOLEAN	Verbose,
		IN CONST BOOLEAN	Sfo,
		IN CONST CHAR8 *	Language,
		IN CONST BOOLEAN	DriverInfo,
		IN CONST BOOLEAN	Multiple
	)

Display information for a handle.

Parameters

[in]	TheHandle	The handles to show info on.
[in]	Verbose	TRUE for extra info, FALSE otherwise.
[in]	Sfo	TRUE to output in standard format output (spec).
[in]	Language	Language string per UEFI specification.
[in]	DriverInfo	TRUE to show all info about the handle.
[in]	Multiple	TRUE indicates more than will be output, FALSE for a single one.

Definition at line 807 of file Dh.c.

◆ DoDhByProtocol()

SHELL_STATUS DoDhByProtocol	(	IN CONST CHAR16 *	Protocol,
		IN CONST BOOLEAN	Verbose,
		IN CONST BOOLEAN	Sfo,
		IN CONST CHAR8 *	Language,
		IN CONST BOOLEAN	DriverInfo
	)

Function to determine use which method to print information. If Protocol is NULL, The function will print all information.

Parameters

[in]	Protocol	The pointer to the name or GUID of protocol or NULL.
[in]	Verbose	TRUE for extra info, FALSE otherwise.
[in]	Sfo	TRUE to output in standard format output (spec).
[in]	Language	Language string per UEFI specification.
[in]	DriverInfo	TRUE to show all info about the handle.

Return values

SHELL_SUCCESS	The operation was successful.
SHELL_NOT_FOUND	The protocol was not found.
SHELL_INVALID_PARAMETER	Protocol is invalid parameter.

Definition at line 980 of file Dh.c.

◆ DoDhByProtocolGuid()

SHELL_STATUS DoDhByProtocolGuid	(	IN CONST GUID *	Guid,
		IN CONST BOOLEAN	Verbose,
		IN CONST BOOLEAN	Sfo,
		IN CONST CHAR8 *	Language,
		IN CONST BOOLEAN	DriverInfo
	)

Display information for a GUID of protocol.

Parameters

[in]	Guid	The pointer to the name of the protocol.
[in]	Verbose	TRUE for extra info, FALSE otherwise.
[in]	Sfo	TRUE to output in standard format output (spec).
[in]	Language	Language string per UEFI specification.
[in]	DriverInfo	TRUE to show all info about the handle.

Return values

SHELL_SUCCESS	The operation was successful.
SHELL_NOT_FOUND	The GUID was not found.
SHELL_INVALID_PARAMETER	ProtocolName was NULL or invalid.

Definition at line 933 of file Dh.c.

◆ DoDhForHandleList()

SHELL_STATUS DoDhForHandleList	(	IN CONST EFI_HANDLE *	HandleList,
		IN CONST BOOLEAN	Verbose,
		IN CONST BOOLEAN	Sfo,
		IN CONST CHAR8 *	Language,
		IN CONST BOOLEAN	DriverInfo
	)

Display information for all handles on a list.

Parameters

[in]	HandleList	The NULL-terminated list of handles.
[in]	Verbose	TRUE for extra info, FALSE otherwise.
[in]	Sfo	TRUE to output in standard format output (spec).
[in]	Language	Language string per UEFI specification.
[in]	DriverInfo	TRUE to show all info about the handle.

Return values

SHELL_SUCCESS	The operation was successful.
SHELL_ABORTED	The operation was aborted.

Definition at line 896 of file Dh.c.

◆ GetDriverImageName()

EFI_STATUS GetDriverImageName	(	IN EFI_HANDLE	TheHandle,
		OUT CHAR16 **	Name
	)

Gets the name of the loaded image.

Parameters

[in]	TheHandle	The handle of the driver to get info on.
[out]	Name	The pointer to the pointer. Valid upon a successful return.

Return values

EFI_SUCCESS The operation was successful.

Definition at line 377 of file Dh.c.

◆ GetDriverName()

EFI_STATUS GetDriverName	(	IN EFI_HANDLE	TheHandle,
		IN CONST CHAR8 *	Language,
		IN CHAR16 **	NameFound
	)

Get the name of a driver by it's handle.

If a name is found the memory must be callee freed.

Parameters

[in]	TheHandle	The driver's handle.
[in]	Language	The language to use.
[in]	NameFound	Upon a successful return the name found.

Return values

EFI_SUCCESS The name was found.

Definition at line 184 of file Dh.c.

◆ GetProtocolInfoString()

CHAR16 * GetProtocolInfoString	(	IN CONST EFI_HANDLE	TheHandle,
		IN CONST CHAR8 *	Language,
		IN CONST CHAR16 *	Separator,
		IN CONST BOOLEAN	Verbose,
		IN CONST BOOLEAN	ExtraInfo
	)

Get information for a handle.

Parameters

[in]	TheHandle	The handles to show info on.
[in]	Language	Language string per UEFI specification.
[in]	Separator	Separator string between information blocks.
[in]	Verbose	TRUE for extra info, FALSE otherwise.
[in]	ExtraInfo	TRUE for extra info, FALSE otherwise.

Return values

SHELL_SUCCESS	The operation was successful.
SHELL_INVALID_PARAMETER	ProtocolName was NULL or invalid.

Definition at line 281 of file Dh.c.

◆ HexCharToDecimal()

UINTN HexCharToDecimal ( IN CHAR16 Char )

Convert a hex-character to decimal value.

This internal function only deal with Unicode character which maps to a valid hexadecimal ASII character, i.e. L'0' to L'9', L'a' to L'f' or L'A' to L'F'. For other Unicode character, the value returned does not make sense.

Parameters

[in] Char The character to convert.

Return values

The	numerical value converted.

Definition at line 105 of file Dh.c.

◆ IsDriverProt()

BOOLEAN IsDriverProt ( IN CONST EFI_GUID * Guid )

Discover if a protocol guid is one of the UEFI Driver Model Protocols.

Parameters

[in] Guid The guid to test.

Return values

TRUE	The guid does represent a driver model protocol.
FALSE	The guid does not represent a driver model protocol.

Definition at line 246 of file Dh.c.

◆ IsValidGuidString()

BOOLEAN IsValidGuidString ( IN CONST CHAR16 * String )

Function to determine if the string can convert to a GUID. The string must be restricted as "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" format.

Parameters

[in] String The string to test.

Return values

TRUE	The string can convert to a GUID.
FALSE	The string can't convert to a GUID.

Definition at line 51 of file Dh.c.

◆ ShellCommandRunDh()

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

Function for 'dh' command.

Parameters

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

Definition at line 1094 of file Dh.c.

Variable Documentation

◆ mGuidDataLen

UINTN mGuidDataLen[] = { 8, 4, 4, 4, 12 }

Definition at line 39 of file Dh.c.

◆ ParamList

STATIC CONST SHELL_PARAM_ITEM ParamList[]

Initial value:

= {
  { L"-p",       TypeValue },
  { L"-d",       TypeFlag  },
  { L"-v",       TypeFlag  },
  { L"-verbose", TypeFlag  },
  { L"-sfo",     TypeFlag  },
  { L"-l",       TypeValue },
  { NULL,        TypeMax   }
}

Definition at line 13 of file Dh.c.

◆ UefiDriverModelProtocolsGuidArray

STATIC CONST EFI_GUID* UefiDriverModelProtocolsGuidArray[]

Initial value:

= {
  &gEfiDriverBindingProtocolGuid,
  &gEfiPlatformDriverOverrideProtocolGuid,
  &gEfiBusSpecificDriverOverrideProtocolGuid,
  &gEfiDriverDiagnosticsProtocolGuid,
  &gEfiDriverDiagnostics2ProtocolGuid,
  &gEfiComponentNameProtocolGuid,
  &gEfiComponentName2ProtocolGuid,
  &gEfiPlatformToDriverConfigurationProtocolGuid,
  &gEfiDriverSupportedEfiVersionProtocolGuid,
  &gEfiDriverFamilyOverrideProtocolGuid,
  &gEfiDriverHealthProtocolGuid,
  &gEfiLoadedImageProtocolGuid,
  NULL
}

Definition at line 23 of file Dh.c.

Functions

Variables

Detailed Description

Function Documentation

◆ ConvertStrToGuid()

◆ DisplayDriverModelHandle()

◆ DoDecodeByProtocol()

◆ DoDhByHandle()

◆ DoDhByProtocol()

◆ DoDhByProtocolGuid()

◆ DoDhForHandleList()

◆ GetDriverImageName()

◆ GetDriverName()

◆ GetProtocolInfoString()

◆ HexCharToDecimal()

◆ IsDriverProt()

◆ IsValidGuidString()

◆ ShellCommandRunDh()

Variable Documentation

◆ mGuidDataLen

◆ ParamList

◆ UefiDriverModelProtocolsGuidArray