MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Include / Protocol / EsrtManagement.h

/** @file\r
  The Esrt Management Protocol used to register/set/update an updatable firmware resource .\r
\r
Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _ESRT_MANAGEMENT_H_\r
#define _ESRT_MANAGEMENT_H_\r
\r
#include <Guid/SystemResourceTable.h>\r
\r
///\r
/// Global ID for the ESRT_MANAGEMENT_PROTOCOL.\r
///\r
#define ESRT_MANAGEMENT_PROTOCOL_GUID \\r
  { \\r
    0xa340c064, 0x723c, 0x4a9c, { 0xa4, 0xdd, 0xd5, 0xb4, 0x7a, 0x26, 0xfb, 0xb0 } \\r
  }\r
\r
///\r
/// Forward declaration for the _ESRT_MANAGEMENT_PROTOCOL.\r
///\r
typedef struct _ESRT_MANAGEMENT_PROTOCOL  ESRT_MANAGEMENT_PROTOCOL;\r
\r
/**\r
  Get Variable name and data by Esrt Entry FwClass\r
\r
  @param[in]       FwClass                FwClass of Esrt entry to get\r
  @param[in out]  Entry                   Esrt entry returned\r
\r
  @retval EFI_SUCCESS                  The variable saving this Esrt Entry exists.\r
  @retval EF_NOT_FOUND                   No correct variable found.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *GET_ESRT_ENTRY)(\r
  IN     EFI_GUID                  *FwClass,\r
  IN OUT EFI_SYSTEM_RESOURCE_ENTRY *Entry\r
  );\r
\r
\r
/**\r
  Update one ESRT entry in ESRT Cache.\r
\r
  @param[in]  Entry                         Esrt entry to be updated\r
\r
  @retval EFI_SUCCESS                   Successfully update an ESRT entry in cache.\r
  @retval EFI_INVALID_PARAMETER  Entry does't exist in ESRT Cache\r
  @retval EFI_WRITE_PROTECTED     ESRT Cache repositoy is locked\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *UPDATE_ESRT_ENTRY)(\r
  IN EFI_SYSTEM_RESOURCE_ENTRY *Entry\r
  );\r
\r
\r
/**\r
  Non-FMP instance to unregister Esrt Entry from ESRT Cache.\r
\r
  @param[in]    FwClass                FwClass of Esrt entry to Unregister\r
\r
  @retval EFI_SUCCESS         Insert all entries Successfully\r
  @retval EFI_NOT_FOUND     FwClass does not exsit\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *UNREGISTER_ESRT_ENTRY)(\r
  IN  EFI_GUID        *FwClass\r
  );\r
\r
\r
/**\r
  Non-FMP instance to register one ESRT entry into ESRT Cache.\r
\r
  @param[in]  Entry                Esrt entry to be set\r
\r
  @retval EFI_SUCCESS                   Successfully set a variable.\r
  @retval EFI_INVALID_PARAMETER  ESRT Entry is already exist\r
  @retval EFI_OUT_OF_RESOURCES  Non-FMP ESRT repository is full\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *REGISTER_ESRT_ENTRY)(\r
  IN EFI_SYSTEM_RESOURCE_ENTRY *Entry\r
  );\r
\r
\r
/**\r
  This function syn up Cached ESRT with data from FMP instances\r
  Function should be called after Connect All in order to locate all FMP protocols\r
  installed\r
\r
  @retval EFI_SUCCESS                      Successfully sync cache repository from FMP instances\r
  @retval EFI_NOT_FOUND                   No FMP Instance are found\r
  @retval EFI_OUT_OF_RESOURCES     Resource allocaton fail\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *SYNC_ESRT_FMP)(\r
  VOID\r
  );\r
\r
\r
/**\r
  This function locks up Esrt repository to be readonly. It should be called\r
  before gEfiEndOfDxeEventGroupGuid event signaled\r
\r
  @retval EFI_SUCCESS              Locks up FMP Non-FMP repository successfully\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *LOCK_ESRT_REPOSITORY)(\r
  VOID\r
  );\r
\r
\r
struct _ESRT_MANAGEMENT_PROTOCOL {\r
  GET_ESRT_ENTRY        GetEsrtEntry;\r
  UPDATE_ESRT_ENTRY     UpdateEsrtEntry;\r
  REGISTER_ESRT_ENTRY   RegisterEsrtEntry;\r
  UNREGISTER_ESRT_ENTRY UnRegisterEsrtEntry;\r
  SYNC_ESRT_FMP         SyncEsrtFmp;\r
  LOCK_ESRT_REPOSITORY  LockEsrtRepository;\r
};\r
\r
extern EFI_GUID gEsrtManagementProtocolGuid;\r
\r
#endif // #ifndef _ESRT_MANAGEMENT_H_\r
\r