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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
|
/** @file
Header file for SMM Access Driver.
@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 an 'Intel Peripheral Driver' and uniquely
identified as "Intel Reference Module" and is
licensed for Intel CPUs and chipsets under the terms of your
license agreement with Intel or your vendor. This file may
be modified by the user, subject to additional terms of the
license agreement
**/
#ifndef _SMM_ACCESS_DRIVER_H_
#define _SMM_ACCESS_DRIVER_H_
#include "pci22.h"
#include "SaAccess.h"
///
/// Driver Consumed Protocol Prototypes
///
///
/// Driver Consumed GUID Prototypes
///
#include EFI_GUID_DEFINITION (SmramMemoryReserve)
///
/// Driver produced protocol
///
#include EFI_PPI_PRODUCER (SmmAccess)
#define SMM_ACCESS_PRIVATE_DATA_SIGNATURE EFI_SIGNATURE_32 ('4', '5', 's', 'a')
///
/// SMM configuration register
///
typedef UINT32 SMRAM; /// System Management RAM Control
///
/// Private data
///
typedef struct {
UINTN Signature;
EFI_HANDLE Handle;
PEI_SMM_ACCESS_PPI SmmAccess;
///
/// Local Data for SMM Access interface goes here
///
UINTN NumberRegions;
EFI_SMRAM_DESCRIPTOR *SmramDesc;
} SMM_ACCESS_PRIVATE_DATA;
#define SMM_ACCESS_PRIVATE_DATA_FROM_THIS(a) \
PEI_CR (a, \
SMM_ACCESS_PRIVATE_DATA, \
SmmAccess, \
SMM_ACCESS_PRIVATE_DATA_SIGNATURE \
)
///
/// Prototypes
/// Driver model protocol interface
///
/**
This is the standard PEIM entry point that
installs an SMM Access PPI
@param[in] FfsHeader - Pointer to an alleged FFS file.
@param[in] PeiServices - General purpose services available to every PEIM.
@retval EFI_STATUS - Protocol successfully started and installed
**/
EFI_STATUS
EFIAPI
SmmAccessPeimEntryPoint (
IN EFI_FFS_FILE_HEADER *FfsHeader,
IN EFI_PEI_SERVICES **PeiServices
)
;
/**
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 boot-service
and SMM agents.
@param[in] PeiServices - General purpose services available to every PEIM.
@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.
**/
EFI_STATUS
EFIAPI
Open (
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 BS or RT code.
@param[in] PeiServices - General purpose services available to every 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.
**/
EFI_STATUS
EFIAPI
Close (
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 BS state..
@param[in] PeiServices - General purpose services available to every 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.
**/
EFI_STATUS
EFIAPI
Lock (
IN EFI_PEI_SERVICES **PeiServices,
IN PEI_SMM_ACCESS_PPI *This,
IN UINTN DescriptorIndex
)
;
/**
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] PeiServices - General purpose services available to every PEIM.
@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.
**/
EFI_STATUS
EFIAPI
GetCapabilities (
IN EFI_PEI_SERVICES **PeiServices,
IN PEI_SMM_ACCESS_PPI *This,
IN OUT UINTN *SmramMapSize,
IN OUT EFI_SMRAM_DESCRIPTOR *SmramMap
)
;
#endif
|
