Add SMM FTW wrapper driver since non-SMM FTW protocol can be used by some consumers...

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

diff --git a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmmCommon.h b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmmCommon.h
new file mode 100644 (file)
index 0000000..061673b
--- /dev/null
+++ b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmmCommon.h
@@ -0,0 +1,80 @@
+/** @file\r
+\r
+  The common header file for SMM FTW module and SMM FTW DXE Module. \r
+\r
+Copyright (c) 2011, Intel Corporation. All rights reserved. <BR>\r
+This program and the accompanying materials                          \r
+are licensed and made available under the terms and conditions of the BSD License         \r
+which accompanies this distribution.  The full text of the license may be found at        \r
+http://opensource.org/licenses/bsd-license.php                                            \r
+                                                                                          \r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \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
+#endif\r