PrmModuleDiscoveryLib.h File Reference

#include <Base.h>
#include <PrmContextBuffer.h>
#include <PrmModuleImageContext.h>
#include <Uefi.h>

Go to the source code of this file.

Functions
EFI_STATUS EFIAPI	GetNextPrmModuleEntry (IN OUT PRM_MODULE_IMAGE_CONTEXT **ModuleImageContext)
EFI_STATUS EFIAPI	DiscoverPrmModules (OUT UINTN *ModuleCount OPTIONAL, OUT UINTN *HandlerCount OPTIONAL)

Detailed Description

The PRM Module Discovery library provides functionality to discover PRM modules installed by platform firmware.

Copyright (c) Microsoft Corporation SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file PrmModuleDiscoveryLib.h.

Function Documentation

DiscoverPrmModules()

EFI_STATUS EFIAPI DiscoverPrmModules	(	OUT UINTN *ModuleCount	OPTIONAL,
		OUT UINTN *HandlerCount	OPTIONAL
	)

Discovers all PRM Modules loaded during boot.

Each PRM Module discovered is placed into a linked list so the list can br processsed in the future.

Parameters

[out]	ModuleCount	An optional pointer parameter that, if provided, is set to the number of PRM modules discovered.
[out]	HandlerCount	An optional pointer parameter that, if provided, is set to the number of PRM handlers discovered.

Return values

EFI_SUCCESS	All PRM Modules were discovered successfully.
EFI_INVALID_PARAMETER	An actual pointer parameter was passed as NULL.
EFI_NOT_FOUND	The gEfiLoadedImageProtocolGuid protocol could not be found.
EFI_OUT_OF_RESOURCES	Insufficient memory resources to allocate the new PRM Context linked list nodes.
EFI_ALREADY_STARTED	The function was called previously and already discovered the PRM modules loaded on this boot.

Definition at line 170 of file DxePrmModuleDiscoveryLib.c.

GetNextPrmModuleEntry()

EFI_STATUS EFIAPI GetNextPrmModuleEntry

(

IN OUT PRM_MODULE_IMAGE_CONTEXT **

ModuleImageContext

)

Gets the next PRM module discovered after the given PRM module.

Parameters

[in,out]

ModuleImageContext

A pointer to a pointer to a PRM module image context structure.

Return values

EFI_SUCCESS	The next PRM module was found successfully.
EFI_INVALID_PARAMETER	The given ModuleImageContext structure is invalid or the pointer is NULL.
EFI_NOT_FOUND	The next PRM module was not found.

Gets the next PRM module discovered after the given PRM module.

Parameters

[in,out]

ModuleImageContext

A pointer to a pointer to a PRM module image context structure. ModuleImageContext should point to a pointer that points to NULL to get the first PRM module discovered.

Return values

EFI_SUCCESS	The next PRM module was found successfully.
EFI_INVALID_PARAMETER	The given ModuleImageContext structure is invalid or the pointer is NULL.
EFI_NOT_FOUND	The next PRM module was not found.

Definition at line 42 of file DxePrmModuleDiscoveryLib.c.