EsrtDxe.c File Reference

#include "EsrtImpl.h"

Go to the source code of this file.

Functions
EFI_STATUS EFIAPI	EsrtDxeGetEsrtEntry (IN EFI_GUID *FwClass, IN OUT EFI_SYSTEM_RESOURCE_ENTRY *Entry)
EFI_STATUS EFIAPI	EsrtDxeUpdateEsrtEntry (IN EFI_SYSTEM_RESOURCE_ENTRY *Entry)
EFI_STATUS EFIAPI	EsrtDxeUnRegisterEsrtEntry (IN EFI_GUID *FwClass)
EFI_STATUS EFIAPI	EsrtDxeRegisterEsrtEntry (IN EFI_SYSTEM_RESOURCE_ENTRY *Entry)
EFI_STATUS EFIAPI	EsrtDxeSyncFmp (VOID)
EFI_STATUS EFIAPI	EsrtDxeLockEsrtRepository (VOID)
VOID EFIAPI	EsrtReadyToBootEventNotify (IN EFI_EVENT Event, IN VOID *Context)
EFI_STATUS EFIAPI	EsrtDxeEntryPoint (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

Variables
ESRT_PRIVATE_DATA	mPrivate
ESRT_MANAGEMENT_PROTOCOL	mEsrtManagementProtocolTemplate

Detailed Description

Esrt management module.

Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file EsrtDxe.c.

Function Documentation

EsrtDxeEntryPoint()

EFI_STATUS EFIAPI EsrtDxeEntryPoint	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

The module Entry Point of the Esrt DXE driver that manages cached ESRT repository & publishes ESRT table

Parameters

[in]	ImageHandle	The firmware allocated handle for the EFI image.
[in]	SystemTable	A pointer to the EFI System Table.

Return values

EFI_SUCCESS	The entry point is executed successfully.
Other	Some error occurs when executing this entry point.

Definition at line 628 of file EsrtDxe.c.

EsrtDxeGetEsrtEntry()

EFI_STATUS EFIAPI EsrtDxeGetEsrtEntry	(	IN EFI_GUID *	FwClass,
		IN OUT EFI_SYSTEM_RESOURCE_ENTRY *	Entry
	)

Get ESRT entry from ESRT Cache by FwClass Guid

Parameters

[in]	FwClass	FwClass of Esrt entry to get
[in,out]	Entry	Esrt entry returned

Return values

EFI_SUCCESS	The variable saving this Esrt Entry exists.
EF_NOT_FOUND	No correct variable found.
EFI_WRITE_PROTECTED	ESRT Cache repository is locked

Definition at line 38 of file EsrtDxe.c.

EsrtDxeLockEsrtRepository()

EFI_STATUS EFIAPI EsrtDxeLockEsrtRepository

(

VOID

)

This function locks up Esrt repository to be readonly. It should be called before gEfiEndOfDxeEventGroupGuid event signaled

Return values

EFI_SUCCESS

Locks up FMP Non-FMP repository successfully

Definition at line 478 of file EsrtDxe.c.

EsrtDxeRegisterEsrtEntry()

EFI_STATUS EFIAPI EsrtDxeRegisterEsrtEntry

(

IN EFI_SYSTEM_RESOURCE_ENTRY *

Entry

)

Non-FMP instance to register one ESRT entry into ESRT Cache.

Parameters

[in]

Entry

Esrt entry to be set

Return values

EFI_SUCCESS	Successfully set a variable.
EFI_INVALID_PARAMETER	ESRT Entry is already exist
EFI_OUT_OF_RESOURCES	Non-FMP ESRT repository is full

Definition at line 179 of file EsrtDxe.c.

EsrtDxeSyncFmp()

EFI_STATUS EFIAPI EsrtDxeSyncFmp

(

VOID

)

This function syn up Cached ESRT with data from FMP instances Function should be called after Connect All in order to locate all FMP protocols installed.

Return values

EFI_SUCCESS	Successfully sync cache repository from FMP instances
EFI_NOT_FOUND	No FMP Instance are found
EFI_OUT_OF_RESOURCES	Resource allocaton fail

Definition at line 222 of file EsrtDxe.c.

EsrtDxeUnRegisterEsrtEntry()

EFI_STATUS EFIAPI EsrtDxeUnRegisterEsrtEntry

(

IN EFI_GUID *

FwClass

)

Non-FMP instance to unregister Esrt Entry from ESRT Cache.

Parameters

[in]

FwClass

FwClass of Esrt entry to Unregister

Return values

EFI_SUCCESS	Insert all entries Successfully
EFI_NOT_FOUND	Entry of FwClass does not exsit

Definition at line 145 of file EsrtDxe.c.

EsrtDxeUpdateEsrtEntry()

EFI_STATUS EFIAPI EsrtDxeUpdateEsrtEntry

(

IN EFI_SYSTEM_RESOURCE_ENTRY *

Entry

)

Update one ESRT entry in ESRT Cache.

Parameters

[in]

Entry

Esrt entry to be updated

Return values

EFI_SUCCESS	Successfully update an ESRT entry in cache.
EFI_INVALID_PARAMETER	Entry does't exist in ESRT Cache
EFI_WRITE_PROTECTED	ESRT Cache repositoy is locked

Definition at line 98 of file EsrtDxe.c.

EsrtReadyToBootEventNotify()

VOID EFIAPI EsrtReadyToBootEventNotify	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

Notify function for event group EFI_EVENT_GROUP_READY_TO_BOOT. This is used to install the Esrt Table into system configuration table

Parameters

[in]	Event	The Event that is being processed.
[in]	Context	The Event Context.

Definition at line 510 of file EsrtDxe.c.

Variable Documentation

mEsrtManagementProtocolTemplate

ESRT_MANAGEMENT_PROTOCOL mEsrtManagementProtocolTemplate

Initial value:

= {
  EsrtDxeGetEsrtEntry,
  EsrtDxeUpdateEsrtEntry,
  EsrtDxeRegisterEsrtEntry,
  EsrtDxeUnRegisterEsrtEntry,
  EsrtDxeSyncFmp,
  EsrtDxeLockEsrtRepository
}

Definition at line 16 of file EsrtDxe.c.

mPrivate

ESRT_PRIVATE_DATA mPrivate

Definition at line 14 of file EsrtDxe.c.