MdeModulePkg/Include/Protocol/EsrtManagement.h File Reference


Data Structures

struct  _ESRT_MANAGEMENT_PROTOCOL

Defines

#define ESRT_MANAGEMENT_PROTOCOL_GUID

Typedefs

typedef struct
_ESRT_MANAGEMENT_PROTOCOL 
ESRT_MANAGEMENT_PROTOCOL
typedef EFI_STATUS(EFIAPI * GET_ESRT_ENTRY )(IN EFI_GUID *FwClass, IN OUT EFI_SYSTEM_RESOURCE_ENTRY *Entry)
typedef EFI_STATUS(EFIAPI * UPDATE_ESRT_ENTRY )(IN EFI_SYSTEM_RESOURCE_ENTRY *Entry)
typedef EFI_STATUS(EFIAPI * UNREGISTER_ESRT_ENTRY )(IN EFI_GUID *FwClass)
typedef EFI_STATUS(EFIAPI * REGISTER_ESRT_ENTRY )(IN EFI_SYSTEM_RESOURCE_ENTRY *Entry)
typedef EFI_STATUS(EFIAPI * SYNC_ESRT_FMP )(VOID)
typedef EFI_STATUS(EFIAPI * LOCK_ESRT_REPOSITORY )(VOID)

Variables

EFI_GUID gEsrtManagementProtocolGuid

Detailed Description

The Esrt Management Protocol used to register/set/update an updatable firmware resource .

Copyright (c) 2015, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.


Define Documentation

#define ESRT_MANAGEMENT_PROTOCOL_GUID

Value:

{ \
    0xa340c064, 0x723c, 0x4a9c, { 0xa4, 0xdd, 0xd5, 0xb4, 0x7a, 0x26, 0xfb, 0xb0 } \
  }
Global ID for the ESRT_MANAGEMENT_PROTOCOL.


Typedef Documentation

Forward declaration for the _ESRT_MANAGEMENT_PROTOCOL.

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

Get Variable name and data by Esrt Entry FwClass

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.

typedef EFI_STATUS(EFIAPI * LOCK_ESRT_REPOSITORY)(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

typedef EFI_STATUS(EFIAPI * REGISTER_ESRT_ENTRY)(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

typedef EFI_STATUS(EFIAPI * SYNC_ESRT_FMP)(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

typedef EFI_STATUS(EFIAPI * UNREGISTER_ESRT_ENTRY)(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 FwClass does not exsit

typedef EFI_STATUS(EFIAPI * UPDATE_ESRT_ENTRY)(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


Variable Documentation


Generated on Thu Sep 24 23:30:15 2015 for MdeModulePkg[ALL] by  doxygen 1.5.7.1