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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
/** @file
This code abstracts the PEI core to provide SmmAccess services.
@copyright
Copyright (c) 1999 - 2012 Intel Corporation. All rights reserved
This software and associated documentation (if any) is furnished
under a license and may only be used or copied in accordance
with the terms of the license. Except as permitted by such
license, no part of this software or documentation may be
reproduced, stored in a retrieval system, or transmitted in any
form or by any means without the express written consent of
Intel Corporation.
This file contains 'Framework Code' and is licensed as such
under the terms of your license agreement with Intel or your
vendor. This file may not be modified, except as allowed by
additional terms of your license agreement.
**/
#ifndef _PEI_SMM_ACCESS_PPI_H_
#define _PEI_SMM_ACCESS_PPI_H_
#include EFI_GUID_DEFINITION (SmramMemoryReserve)
#define PEI_SMM_ACCESS_PPI_GUID \
{ \
0x268f33a9, 0xcccd, 0x48be, 0x88, 0x17, 0x86, 0x5, 0x3a, 0xc3, 0x2e, 0xd6 \
}
EFI_FORWARD_DECLARATION (PEI_SMM_ACCESS_PPI);
typedef
EFI_STATUS
(EFIAPI *PEI_SMM_OPEN) (
IN EFI_PEI_SERVICES **PeiServices,
IN PEI_SMM_ACCESS_PPI * This,
IN UINTN DescriptorIndex
)
/**
This routine accepts a request to "open" a region of SMRAM. The
region could be legacy ABSEG, HSEG, or TSEG near top of physical memory.
The use of "open" means that the memory is visible from all PEIM
and SMM agents.
@param[in] This - Pointer to the SMM Access Interface.
@param[in] DescriptorIndex - Region of SMRAM to Open.
@retval EFI_SUCCESS - The region was successfully opened.
@retval EFI_DEVICE_ERROR - The region could not be opened because locked by
chipset.
@retval EFI_INVALID_PARAMETER - The descriptor index was out of bounds.
**/
;
typedef
EFI_STATUS
(EFIAPI *PEI_SMM_CLOSE) (
IN EFI_PEI_SERVICES **PeiServices,
IN PEI_SMM_ACCESS_PPI * This,
IN UINTN DescriptorIndex
)
/**
This routine accepts a request to "close" a region of SMRAM. The
region could be legacy AB or TSEG near top of physical memory.
The use of "close" means that the memory is only visible from SMM agents,
not from PEIM.
@param[in] This - Pointer to the SMM Access Interface.
@param[in] DescriptorIndex - Region of SMRAM to Close.
@retval EFI_SUCCESS - The region was successfully closed.
@retval EFI_DEVICE_ERROR - The region could not be closed because locked by
chipset.
@retval EFI_INVALID_PARAMETER - The descriptor index was out of bounds.
**/
;
typedef
EFI_STATUS
(EFIAPI *PEI_SMM_LOCK) (
IN EFI_PEI_SERVICES **PeiServices,
IN PEI_SMM_ACCESS_PPI * This,
IN UINTN DescriptorIndex
)
/**
This routine accepts a request to "lock" SMRAM. The
region could be legacy AB or TSEG near top of physical memory.
The use of "lock" means that the memory can no longer be opened
to PEIM.
@param[in] This - Pointer to the SMM Access Interface.
@param[in] DescriptorIndex - Region of SMRAM to Lock.
@retval EFI_SUCCESS - The region was successfully locked.
@retval EFI_DEVICE_ERROR - The region could not be locked because at least
one range is still open.
@retval EFI_INVALID_PARAMETER - The descriptor index was out of bounds.
**/
;
typedef
EFI_STATUS
(EFIAPI *PEI_SMM_CAPABILITIES) (
IN EFI_PEI_SERVICES **PeiServices,
IN PEI_SMM_ACCESS_PPI * This,
IN OUT UINTN *SmramMapSize,
IN OUT EFI_SMRAM_DESCRIPTOR * SmramMap
)
/**
This routine services a user request to discover the SMRAM
capabilities of this platform. This will report the possible
ranges that are possible for SMRAM access, based upon the
memory controller capabilities.
@param[in] This - Pointer to the SMRAM Access Interface.
@param[in] SmramMapSize - Pointer to the variable containing size of the
buffer to contain the description information.
@param[in] SmramMap - Buffer containing the data describing the Smram
region descriptors.
@retval EFI_BUFFER_TOO_SMALL - The user did not provide a sufficient buffer.
@retval EFI_SUCCESS - The user provided a sufficiently-sized buffer.
**/
;
struct _PEI_SMM_ACCESS_PPI {
PEI_SMM_OPEN Open;
PEI_SMM_CLOSE Close;
PEI_SMM_LOCK Lock;
PEI_SMM_CAPABILITIES GetCapabilities;
BOOLEAN LockState;
BOOLEAN OpenState;
};
extern EFI_GUID gPeiSmmAccessPpiGuid;
#endif
|
