TianoCore EDK2 master
|
#include <Uefi.h>
Go to the source code of this file.
Macros | |
#define | HR_UNKNOWN 0 |
#define | HR_IMAGE_HANDLE BIT1 |
#define | HR_DRIVER_BINDING_HANDLE BIT2 |
#define | HR_DEVICE_DRIVER BIT3 |
#define | HR_BUS_DRIVER BIT4 |
#define | HR_DRIVER_CONFIGURATION_HANDLE BIT5 |
#define | HR_DRIVER_DIAGNOSTICS_HANDLE BIT6 |
#define | HR_COMPONENT_NAME_HANDLE BIT7 |
#define | HR_DEVICE_HANDLE BIT8 |
#define | HR_PARENT_HANDLE BIT9 |
#define | HR_CONTROLLER_HANDLE BIT10 |
#define | HR_CHILD_HANDLE BIT11 |
#define | HR_VALID_MASK (BIT1|BIT2|BIT3|BIT4|BIT5|BIT6|BIT7|BIT8|BIT9|BIT10|BIT11) |
#define | PARSE_HANDLE_DATABASE_PARENTS(ControllerHandle, Count, Buffer) ParseHandleDatabaseByRelationship(NULL, ControllerHandle, HR_PARENT_HANDLE, Count, Buffer) |
#define | PARSE_HANDLE_DATABASE_UEFI_DRIVERS(ControllerHandle, Count, Buffer) ParseHandleDatabaseByRelationship(NULL, ControllerHandle, HR_DRIVER_BINDING_HANDLE|HR_DEVICE_DRIVER, Count, Buffer) |
#define | PARSE_HANDLE_DATABASE_MANAGED_CHILDREN(DriverHandle, ControllerHandle, Count, Buffer) ParseHandleDatabaseByRelationship(DriverHandle, ControllerHandle, HR_CHILD_HANDLE|HR_DEVICE_HANDLE, Count, Buffer) |
#define | PARSE_HANDLE_DATABASE_DEVICES(DriverHandle, Count, Buffer) ParseHandleDatabaseByRelationship(DriverHandle, NULL, HR_CONTROLLER_HANDLE|HR_DEVICE_HANDLE, Count, Buffer) |
Provides interface to advanced shell functionality for parsing both handle and protocol database.
Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
Definition in file HandleParsingLib.h.
#define HR_BUS_DRIVER BIT4 |
Definition at line 140 of file HandleParsingLib.h.
#define HR_CHILD_HANDLE BIT11 |
Definition at line 147 of file HandleParsingLib.h.
#define HR_COMPONENT_NAME_HANDLE BIT7 |
Definition at line 143 of file HandleParsingLib.h.
#define HR_CONTROLLER_HANDLE BIT10 |
Definition at line 146 of file HandleParsingLib.h.
#define HR_DEVICE_DRIVER BIT3 |
Definition at line 139 of file HandleParsingLib.h.
#define HR_DEVICE_HANDLE BIT8 |
Definition at line 144 of file HandleParsingLib.h.
#define HR_DRIVER_BINDING_HANDLE BIT2 |
Definition at line 138 of file HandleParsingLib.h.
#define HR_DRIVER_CONFIGURATION_HANDLE BIT5 |
Definition at line 141 of file HandleParsingLib.h.
#define HR_DRIVER_DIAGNOSTICS_HANDLE BIT6 |
Definition at line 142 of file HandleParsingLib.h.
#define HR_IMAGE_HANDLE BIT1 |
Definition at line 137 of file HandleParsingLib.h.
#define HR_PARENT_HANDLE BIT9 |
Definition at line 145 of file HandleParsingLib.h.
#define HR_UNKNOWN 0 |
Definition at line 136 of file HandleParsingLib.h.
#define HR_VALID_MASK (BIT1|BIT2|BIT3|BIT4|BIT5|BIT6|BIT7|BIT8|BIT9|BIT10|BIT11) |
Definition at line 148 of file HandleParsingLib.h.
#define PARSE_HANDLE_DATABASE_DEVICES | ( | DriverHandle, | |
Count, | |||
Buffer | |||
) | ParseHandleDatabaseByRelationship(DriverHandle, NULL, HR_CONTROLLER_HANDLE|HR_DEVICE_HANDLE, Count, Buffer) |
Gets handles for any devices managed by the passed in driver.
[in] | DriverHandle | The handle of the driver. |
[in] | Count | The pointer to the number of handles in MatchingHandleBuffer on return. |
[out] | Buffer | The buffer containing handles on a successful return. |
EFI_SUCCESS | The operation was successful. |
Definition at line 277 of file HandleParsingLib.h.
#define PARSE_HANDLE_DATABASE_MANAGED_CHILDREN | ( | DriverHandle, | |
ControllerHandle, | |||
Count, | |||
Buffer | |||
) | ParseHandleDatabaseByRelationship(DriverHandle, ControllerHandle, HR_CHILD_HANDLE|HR_DEVICE_HANDLE, Count, Buffer) |
Gets handles for any children of the passed in controller by the passed in driver handle.
[in] | DriverHandle | The handle of the driver. |
[in] | ControllerHandle | The handle of the controller. |
[in] | Count | The pointer to the number of handles in MatchingHandleBuffer on return. |
[out] | Buffer | The buffer containing handles on a successful return. |
EFI_SUCCESS | The operation was successful. |
Definition at line 263 of file HandleParsingLib.h.
#define PARSE_HANDLE_DATABASE_PARENTS | ( | ControllerHandle, | |
Count, | |||
Buffer | |||
) | ParseHandleDatabaseByRelationship(NULL, ControllerHandle, HR_PARENT_HANDLE, Count, Buffer) |
Gets handles for any parents of the passed in controller.
[in] | ControllerHandle | The handle of the controller. |
[in] | Count | The pointer to the number of handles in MatchingHandleBuffer on return. |
[out] | Buffer | The buffer containing handles on a successful return. |
EFI_SUCCESS | The operation was successful. |
Definition at line 234 of file HandleParsingLib.h.
#define PARSE_HANDLE_DATABASE_UEFI_DRIVERS | ( | ControllerHandle, | |
Count, | |||
Buffer | |||
) | ParseHandleDatabaseByRelationship(NULL, ControllerHandle, HR_DRIVER_BINDING_HANDLE|HR_DEVICE_DRIVER, Count, Buffer) |
Gets handles for any UEFI drivers of the passed in controller.
[in] | ControllerHandle | The handle of the controller. |
[in] | Count | The pointer to the number of handles in MatchingHandleBuffer on return. |
[out] | Buffer | The buffer containing handles on a successful return. |
EFI_SUCCESS | The operation was successful. |
Definition at line 248 of file HandleParsingLib.h.
EFI_STATUS EFIAPI AddNewGuidNameMapping | ( | IN CONST EFI_GUID * | Guid, |
IN CONST CHAR16 * | TheName, | ||
IN CONST CHAR8 *Lang | OPTIONAL | ||
) |
Function to add a new GUID/Name mapping.
This cannot overwrite an existing mapping.
[in] | Guid | The Guid |
[in] | TheName | The Guid's name |
[in] | Lang | RFC4646 language code list or NULL |
EFI_SUCCESS | The operation was successful |
EFI_ACCESS_DENIED | There was a duplicate |
EFI_OUT_OF_RESOURCES | A memory allocation failed |
Function to add a new GUID/Name mapping.
This cannot overwrite an existing mapping.
[in] | Guid | The Guid |
[in] | TheName | The Guid's name |
[in] | Lang | RFC4646 language code list or NULL |
EFI_SUCCESS | The operation was successful |
EFI_ACCESS_DENIED | There was a duplicate |
EFI_OUT_OF_RESOURCES | A memory allocation failed |
EFI_INVALID_PARAMETER | Guid or TheName was NULL |
Definition at line 2675 of file UefiHandleParsingLib.c.
EFI_HANDLE EFIAPI ConvertHandleIndexToHandle | ( | IN CONST UINTN | TheIndex | ) |
Function to retrieve the EFI_HANDLE from the human-friendly index.
[in] | TheIndex | The index to retrieve the EFI_HANDLE for. |
NULL | The index was invalid. |
Definition at line 3096 of file UefiHandleParsingLib.c.
UINTN EFIAPI ConvertHandleToHandleIndex | ( | IN CONST EFI_HANDLE | TheHandle | ) |
Function to retrieve the human-friendly index of a given handle. If the handle does not have a index one will be automatically assigned. The index value is valid until the termination of the shell application.
[in] | TheHandle | The handle to retrieve an index for. |
0 | A memory allocation failed. |
Definition at line 3023 of file UefiHandleParsingLib.c.
Return all supported GUIDs.
[out] | Guids | The buffer to return all supported GUIDs. |
[in,out] | Count | On input, the count of GUIDs the buffer can hold, On output, the count of GUIDs to return. |
EFI_INVALID_PARAMETER | Count is NULL. |
EFI_BUFFER_TOO_SMALL | Buffer is not enough to hold all GUIDs. |
EFI_SUCCESS | GUIDs are returned successfully. |
Definition at line 3913 of file UefiHandleParsingLib.c.
CHAR8 *EFIAPI GetBestLanguageForDriver | ( | IN CONST CHAR8 * | SupportedLanguages, |
IN CONST CHAR8 * | InputLanguage, | ||
IN BOOLEAN | Iso639Language | ||
) |
Get best support language for this driver.
First base on the user input language to search, second base on the current platform used language to search, third get the first language from the support language list. The caller need to free the buffer of the best language.
[in] | SupportedLanguages | The support languages for this driver. |
[in] | InputLanguage | The user input language. |
[in] | Iso639Language | Whether get language for ISO639. |
Definition at line 2860 of file UefiHandleParsingLib.c.
EFI_STATUS EFIAPI GetGuidFromStringName | ( | IN CONST CHAR16 * | Name, |
IN CONST CHAR8 *Lang | OPTIONAL, | ||
OUT EFI_GUID ** | Guid | ||
) |
Function to get the Guid for a protocol or struct based on it's string name.
Do not free or modify the returned GUID.
[in] | Name | The pointer to the string name. |
[in] | Lang | The pointer to the language code (string). |
[out] | Guid | The pointer to the pointer to the Guid. |
EFI_SUCCESS | The operation was successful. |
Function to get the Guid for a protocol or struct based on it's string name.
do not modify the returned Guid.
[in] | Name | The pointer to the string name. |
[in] | Lang | The pointer to the language code. |
[out] | Guid | The pointer to the Guid. |
EFI_SUCCESS | The operation was successful. |
Definition at line 2785 of file UefiHandleParsingLib.c.
EFI_HANDLE *EFIAPI GetHandleListByProtocol | ( | IN CONST EFI_GUID *ProtocolGuid | OPTIONAL | ) |
Function to get all handles that support a given protocol or all handles.
The caller is responsible to free this memory.
[in] | ProtocolGuid | The guid of the protocol to get handles for. If NULL then the function will return all handles. |
NULL | A memory allocation failed. |
Function to get all handles that support a given protocol or all handles.
[in] | ProtocolGuid | The guid of the protocol to get handles for. If NULL then the function will return all handles. |
NULL | A memory allocation failed. |
Definition at line 3775 of file UefiHandleParsingLib.c.
EFI_HANDLE *EFIAPI GetHandleListByProtocolList | ( | IN CONST EFI_GUID ** | ProtocolGuids | ) |
Function to get all handles that support some protocols.
The caller is responsible to free this memory.
[in] | ProtocolGuids | A NULL terminated list of protocol GUIDs. |
NULL | A memory allocation failed. |
NULL | ProtocolGuids was NULL. |
Function to get all handles that support some protocols.
[in] | ProtocolGuids | A NULL terminated list of protocol GUIDs. |
NULL | A memory allocation failed. |
NULL | ProtocolGuids was NULL. |
Definition at line 3835 of file UefiHandleParsingLib.c.
CHAR16 *EFIAPI GetProtocolInformationDump | ( | IN CONST EFI_HANDLE | TheHandle, |
IN CONST EFI_GUID * | Guid, | ||
IN CONST BOOLEAN | Verbose | ||
) |
Function to dump protocol information from a handle.
This function will return a allocated string buffer containing the information. The caller is responsible for freeing the memory.
If Guid is NULL, ASSERT(). If TheHandle is NULL, ASSERT().
[in] | TheHandle | The handle to dump information from. |
[in] | Guid | The GUID of the protocol to dump. |
[in] | Verbose | TRUE for extra info. FALSE otherwise. |
NULL | An error was encountered. |
Definition at line 2749 of file UefiHandleParsingLib.c.
Function to get the name of a protocol or struct from it's GUID.
If Guid is NULL, then ASSERT.
[in] | Guid | The GUID to look for the name of. |
[in] | Lang | The language to use. |
Function to get the name of a protocol or struct from it's GUID.
if Guid is NULL, then ASSERT.
[in] | Guid | The GUID to look for the name of. |
[in] | Lang | The language to use. |
Definition at line 2714 of file UefiHandleParsingLib.c.
CONST CHAR16 *EFIAPI GetStringNameFromHandle | ( | IN CONST EFI_HANDLE | TheHandle, |
IN CONST CHAR8 * | Language | ||
) |
Function to retrieve the driver name (if possible) from the ComponentName or ComponentName2 protocol.
The string returned must be callee freed.
[in] | TheHandle | The driver handle to get the name of. |
[in] | Language | The language to use. |
NULL | The name could not be found. |
Function to retrieve the driver name (if possible) from the ComponentName or ComponentName2 protocol
[in] | TheHandle | The driver handle to get the name of. |
[in] | Language | The language to use. |
NULL | The name could not be found. |
Definition at line 2899 of file UefiHandleParsingLib.c.
EFI_STATUS EFIAPI ParseHandleDatabaseByRelationship | ( | IN CONST EFI_HANDLE DriverBindingHandle | OPTIONAL, |
IN CONST EFI_HANDLE ControllerHandle | OPTIONAL, | ||
IN CONST UINTN | Mask, | ||
IN UINTN * | MatchingHandleCount, | ||
OUT EFI_HANDLE **MatchingHandleBuffer | OPTIONAL | ||
) |
Gets all the related EFI_HANDLEs based on the mask supplied.
This function will scan all EFI_HANDLES in the UEFI environment's handle database and return all the ones with the specified relationship (Mask) to the specified controller handle.
If both DriverBindingHandle and ControllerHandle are NULL, then ASSERT. If MatchingHandleCount is NULL, then ASSERT.
If MatchingHandleBuffer is not NULL upon a successful return, the memory must be caller freed.
[in] | DriverBindingHandle | The handle with Driver Binding protocol on it. |
[in] | ControllerHandle | The handle with Device Path protocol on it. |
[in] | Mask | The mask of what relationship(s) is desired. |
[in] | MatchingHandleCount | The pointer to UINTN specifying number of HANDLES in MatchingHandleBuffer. |
[out] | MatchingHandleBuffer | On a successful return, a buffer of MatchingHandleCount EFI_HANDLEs with a terminating NULL EFI_HANDLE. |
EFI_SUCCESS | The operation was successful, and any related handles are in MatchingHandleBuffer. |
EFI_NOT_FOUND | No matching handles were found. |
EFI_INVALID_PARAMETER | A parameter was invalid or out of range. |
Gets all the related EFI_HANDLEs based on the single EFI_HANDLE and the mask supplied.
This function will scan all EFI_HANDLES in the UEFI environment's handle database and return all the ones with the specified relationship (Mask) to the specified controller handle.
If both DriverBindingHandle and ControllerHandle are NULL, then ASSERT. If MatchingHandleCount is NULL, then ASSERT.
If MatchingHandleBuffer is not NULL upon a successful return the memory must be caller freed.
[in] | DriverBindingHandle | Handle to a object with Driver Binding protocol on it. |
[in] | ControllerHandle | Handle to a device with Device Path protocol on it. |
[in] | Mask | Mask of what relationship(s) is desired. |
[in] | MatchingHandleCount | Poitner to UINTN specifying number of HANDLES in MatchingHandleBuffer. |
[out] | MatchingHandleBuffer | On a successful return a buffer of MatchingHandleCount EFI_HANDLEs and a terminating NULL EFI_HANDLE. |
EFI_SUCCESS | The operation was successful and any related handles are in MatchingHandleBuffer; |
EFI_NOT_FOUND | No matching handles were found. |
EFI_INVALID_PARAMETER | A parameter was invalid or out of range. |
Definition at line 3412 of file UefiHandleParsingLib.c.
EFI_STATUS EFIAPI ParseHandleDatabaseByRelationshipWithType | ( | IN CONST EFI_HANDLE DriverBindingHandle | OPTIONAL, |
IN CONST EFI_HANDLE ControllerHandle | OPTIONAL, | ||
IN UINTN * | HandleCount, | ||
OUT EFI_HANDLE ** | HandleBuffer, | ||
OUT UINTN ** | HandleType | ||
) |
Gets all the related EFI_HANDLEs based on the mask supplied.
This function scans all EFI_HANDLES in the UEFI environment's handle database and returns the ones with the specified relationship (Mask) to the specified controller handle.
If both DriverBindingHandle and ControllerHandle are NULL, then ASSERT. If MatchingHandleCount is NULL, then ASSERT.
If MatchingHandleBuffer is not NULL upon a successful return the memory must be caller freed.
[in] | DriverBindingHandle | The handle with Driver Binding protocol on it. |
[in] | ControllerHandle | The handle with Device Path protocol on it. |
[in] | MatchingHandleCount | The pointer to UINTN that specifies the number of HANDLES in MatchingHandleBuffer. |
[out] | MatchingHandleBuffer | On a successful return, a buffer of MatchingHandleCount EFI_HANDLEs with a terminating NULL EFI_HANDLE. |
[out] | HandleType | An array of type information. |
EFI_SUCCESS | The operation was successful, and any related handles are in MatchingHandleBuffer. |
EFI_NOT_FOUND | No matching handles were found. |
EFI_INVALID_PARAMETER | A parameter was invalid or out of range. |
Definition at line 3165 of file UefiHandleParsingLib.c.
EFI_STATUS EFIAPI ParseHandleDatabaseForChildControllers | ( | IN CONST EFI_HANDLE | ControllerHandle, |
OUT UINTN * | MatchingHandleCount, | ||
OUT EFI_HANDLE **MatchingHandleBuffer | OPTIONAL | ||
) |
Gets handles for any child controllers of the passed in controller.
[in] | ControllerHandle | The handle of the "parent controller". |
[out] | MatchingHandleCount | The pointer to the number of handles in MatchingHandleBuffer on return. |
[out] | MatchingHandleBuffer | The buffer containing handles on a successful return. |
EFI_SUCCESS | The operation was successful. |
Gets handles for any child controllers of the passed in controller.
[in] | ControllerHandle | The handle of the "parent controller" |
[out] | MatchingHandleCount | Pointer to the number of handles in MatchingHandleBuffer on return. |
[out] | MatchingHandleBuffer | Buffer containing handles on a successful return. |
EFI_SUCCESS | The operation was successful. |
Definition at line 3535 of file UefiHandleParsingLib.c.
EFI_STATUS EFIAPI ParseHandleDatabaseForChildDevices | ( | IN CONST EFI_HANDLE | DriverHandle, |
IN UINTN * | MatchingHandleCount, | ||
OUT EFI_HANDLE **MatchingHandleBuffer | OPTIONAL | ||
) |
Gets handles for any child devices produced by the passed in driver.
[in] | DriverHandle | The handle of the driver. |
[in] | MatchingHandleCount | The pointer to the number of handles in MatchingHandleBuffer on return. |
[out] | MatchingHandleBuffer | The buffer containing handles on a successful return. |
EFI_SUCCESS | The operation was successful. |
Gets handles for any child devices produced by the passed in driver.
[in] | DriverHandle | The handle of the driver. |
[in] | MatchingHandleCount | Pointer to the number of handles in MatchingHandleBuffer on return. |
[out] | MatchingHandleBuffer | Buffer containing handles on a successful return. |
EFI_SUCCESS | The operation was successful. |
Definition at line 3699 of file UefiHandleParsingLib.c.