MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Universal / FaultTolerantWriteDxe / FaultTolerantWriteSmmCommon.h

/** @file\r
\r
  The common header file for SMM FTW module and SMM FTW DXE Module.\r
\r
Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved. <BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __SMM_FTW_COMMON_H__\r
#define __SMM_FTW_COMMON_H__\r
\r
#include <Protocol/SmmFirmwareVolumeBlock.h>\r
#include <Protocol/SmmFaultTolerantWrite.h>\r
\r
#define FTW_FUNCTION_GET_MAX_BLOCK_SIZE       1\r
#define FTW_FUNCTION_ALLOCATE                 2\r
#define FTW_FUNCTION_WRITE                    3\r
#define FTW_FUNCTION_RESTART                  4\r
#define FTW_FUNCTION_ABORT                    5\r
#define FTW_FUNCTION_GET_LAST_WRITE           6\r
\r
typedef struct {\r
  UINTN       Function;\r
  EFI_STATUS  ReturnStatus;\r
  UINT8       Data[1];\r
} SMM_FTW_COMMUNICATE_FUNCTION_HEADER;\r
\r
///\r
/// Size of SMM communicate header, without including the payload.\r
///\r
#define SMM_COMMUNICATE_HEADER_SIZE  (OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data))\r
\r
///\r
/// Size of SMM FTW communicate function header, without including the payload.\r
///\r
#define SMM_FTW_COMMUNICATE_HEADER_SIZE  (OFFSET_OF (SMM_FTW_COMMUNICATE_FUNCTION_HEADER, Data))\r
\r
typedef struct {\r
  UINTN                                 BlockSize;\r
} SMM_FTW_GET_MAX_BLOCK_SIZE_HEADER;\r
\r
typedef struct {\r
  EFI_GUID                              CallerId;\r
  UINTN                                 PrivateDataSize;\r
  UINTN                                 NumberOfWrites;\r
} SMM_FTW_ALLOCATE_HEADER;\r
\r
typedef struct {\r
  EFI_LBA                               Lba;\r
  UINTN                                 Offset;\r
  UINTN                                 PrivateDataSize;\r
  EFI_PHYSICAL_ADDRESS                  FvbBaseAddress;\r
  EFI_FVB_ATTRIBUTES_2                  FvbAttributes;\r
  UINTN                                 Length;\r
  UINT8                                 Data[1];\r
} SMM_FTW_WRITE_HEADER;\r
\r
typedef struct {\r
  EFI_PHYSICAL_ADDRESS                  FvbBaseAddress;\r
  EFI_FVB_ATTRIBUTES_2                  FvbAttributes;\r
} SMM_FTW_RESTART_HEADER;\r
\r
typedef struct {\r
  EFI_GUID                              CallerId;\r
  EFI_LBA                               Lba;\r
  UINTN                                 Offset;\r
  UINTN                                 Length;\r
  UINTN                                 PrivateDataSize;\r
  BOOLEAN                               Complete;\r
  UINT8                                 Data[1];\r
} SMM_FTW_GET_LAST_WRITE_HEADER;\r
\r
/**\r
  Shared entry point of the module.\r
\r
  @retval EFI_SUCCESS           The initialization finished successfully.\r
  @retval EFI_OUT_OF_RESOURCES  Allocate memory error\r
  @retval EFI_INVALID_PARAMETER Workspace or Spare block does not exist\r
\r
**/\r
EFI_STATUS\r
MmFaultTolerantWriteInitialize (\r
  VOID\r
  );\r
\r
/**\r
  This function checks if the buffer is valid per processor architecture and\r
  does not overlap with SMRAM.\r
\r
  @param Buffer The buffer start address to be checked.\r
  @param Length The buffer length to be checked.\r
\r
  @retval TRUE  This buffer is valid per processor architecture and does not\r
                overlap with SMRAM.\r
  @retval FALSE This buffer is not valid per processor architecture or overlaps\r
                with SMRAM.\r
**/\r
BOOLEAN\r
FtwSmmIsBufferOutsideSmmValid (\r
  IN EFI_PHYSICAL_ADDRESS  Buffer,\r
  IN UINT64                Length\r
  );\r
\r
/**\r
  Notify the system that the SMM FTW driver is ready.\r
**/\r
VOID\r
FtwNotifySmmReady (\r
  VOID\r
  );\r
\r
#endif\r