blob: 73799d3256111d67ac11ad3b95bbf68dea1c4984 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
/** @file
The common header file for SMM FTW module and SMM FTW DXE Module.
Copyright (c) 2011 - 2024, Intel Corporation. All rights reserved. <BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#ifndef __SMM_FTW_COMMON_H__
#define __SMM_FTW_COMMON_H__
#include <Protocol/SmmFirmwareVolumeBlock.h>
#include <Protocol/SmmFaultTolerantWrite.h>
#define FTW_FUNCTION_GET_MAX_BLOCK_SIZE 1
#define FTW_FUNCTION_ALLOCATE 2
#define FTW_FUNCTION_WRITE 3
#define FTW_FUNCTION_RESTART 4
#define FTW_FUNCTION_ABORT 5
#define FTW_FUNCTION_GET_LAST_WRITE 6
typedef struct {
UINTN Function;
EFI_STATUS ReturnStatus;
UINT8 Data[1];
} SMM_FTW_COMMUNICATE_FUNCTION_HEADER;
///
/// Size of SMM communicate header, without including the payload.
///
#define SMM_COMMUNICATE_HEADER_SIZE (OFFSET_OF (EFI_MM_COMMUNICATE_HEADER, Data))
///
/// Size of SMM FTW communicate function header, without including the payload.
///
#define SMM_FTW_COMMUNICATE_HEADER_SIZE (OFFSET_OF (SMM_FTW_COMMUNICATE_FUNCTION_HEADER, Data))
typedef struct {
UINTN BlockSize;
} SMM_FTW_GET_MAX_BLOCK_SIZE_HEADER;
typedef struct {
EFI_GUID CallerId;
UINTN PrivateDataSize;
UINTN NumberOfWrites;
} SMM_FTW_ALLOCATE_HEADER;
typedef struct {
EFI_LBA Lba;
UINTN Offset;
UINTN PrivateDataSize;
EFI_PHYSICAL_ADDRESS FvbBaseAddress;
EFI_FVB_ATTRIBUTES_2 FvbAttributes;
UINTN Length;
UINT8 Data[1];
} SMM_FTW_WRITE_HEADER;
typedef struct {
EFI_PHYSICAL_ADDRESS FvbBaseAddress;
EFI_FVB_ATTRIBUTES_2 FvbAttributes;
} SMM_FTW_RESTART_HEADER;
typedef struct {
EFI_GUID CallerId;
EFI_LBA Lba;
UINTN Offset;
UINTN Length;
UINTN PrivateDataSize;
BOOLEAN Complete;
UINT8 Data[1];
} SMM_FTW_GET_LAST_WRITE_HEADER;
/**
Shared entry point of the module.
@retval EFI_SUCCESS The initialization finished successfully.
@retval EFI_OUT_OF_RESOURCES Allocate memory error
@retval EFI_INVALID_PARAMETER Workspace or Spare block does not exist
**/
EFI_STATUS
MmFaultTolerantWriteInitialize (
VOID
);
/**
This function checks if the Primary Buffer is valid.
@param Buffer The buffer start address to be checked.
@param Length The buffer length to be checked.
@retval TRUE This buffer is valid.
@retval FALSE This buffer is not valid.
**/
BOOLEAN
FtwSmmIsPrimaryBufferValid (
IN EFI_PHYSICAL_ADDRESS Buffer,
IN UINT64 Length
);
/**
Notify the system that the SMM FTW driver is ready.
**/
VOID
FtwNotifySmmReady (
VOID
);
#endif
|
