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
187
|
/** @file
Smm CPU Sync2 protocol definition.
Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#ifndef _SMM_CPU_SYNC2_PROTOCOL_H_
#define _SMM_CPU_SYNC2_PROTOCOL_H_
#include "SmmCpuSync.h"
#define SMM_CPU_SYNC2_PROTOCOL_GUID \
{ \
0x9db72e22, 0x9262, 0x4a18, { 0x8f, 0xe0, 0x85, 0xe0, 0x3d, 0xfa, 0x96, 0x73 } \
}
typedef struct _SMM_CPU_SYNC2_PROTOCOL SMM_CPU_SYNC2_PROTOCOL;
typedef enum {
SmmCpuSync2StateNormal,
SmmCpuSync2StateDelayed,
SmmCpuSync2StateBlocked,
SmmCpuSync2StateDisabled,
SmmCpuSync2StateMax
} SMM_CPU_SYNC2_CPU_STATE;
//
// Protocol functions
//
/**
Given timeout constraint, wait for all APs to arrive, and insure if this function returns EFI_SUCCESS, then
no AP will execute normal mode code before entering SMM, so it is safe to access shared hardware resource
between SMM and normal mode. Note if there are SMI disabled APs, this function will return EFI_NOT_READY.
@param[in] This A pointer to the SMM_CPU_SYNC_PROTOCOL instance.
@retval EFI_SUCCESS No AP will execute normal mode code before entering SMM, so it is safe to access
shared hardware resource between SMM and normal mode
@retval EFI_NOT_READY One or more CPUs may still execute normal mode code
@retval EFI_DEVICE_ERROR Error occured in obtaining CPU status.
**/
typedef
EFI_STATUS
(EFIAPI *SMM_CPU_SYNC2_CHECK_AP_ARRIVAL) (
IN SMM_CPU_SYNC2_PROTOCOL *This
);
/**
Set SMM synchronization mode starting from the next SMI run.
@param[in] This A pointer to the SMM_CPU_SYNC_PROTOCOL instance.
@param[in] SyncMode The SMM synchronization mode to be set and effective from the next SMI run.
@retval EFI_SUCCESS The function completes successfully.
@retval EFI_INVALID_PARAMETER SynMode is not valid.
**/
typedef
EFI_STATUS
(EFIAPI *SMM_CPU_SYNC2_SET_MODE) (
IN SMM_CPU_SYNC2_PROTOCOL *This,
IN SMM_CPU_SYNC_MODE SyncMode
);
/**
Get current effective SMM synchronization mode.
@param This A pointer to the SMM_CPU_SYNC_PROTOCOL instance.
@param SyncMode Output parameter. The current effective SMM synchronization mode.
@retval EFI_SUCCESS The SMM synchronization mode has been retrieved successfully.
@retval EFI_INVALID_PARAMETER SyncMode is NULL.
**/
typedef
EFI_STATUS
(EFIAPI *SMM_CPU_SYNC2_GET_MODE) (
IN SMM_CPU_SYNC2_PROTOCOL *This,
OUT SMM_CPU_SYNC_MODE *SyncMode
);
/**
Checks CPU SMM synchronization state
@param[in] This A pointer to the SMM_CPU_SYNC_PROTOCOL instance.
@param[in] CpuIndex Index of the CPU for which the state is to be retrieved.
@param[out] CpuState The state of the CPU
@retval EFI_SUCCESS Returns EFI_SUCCESS if the CPU's state is retrieved.
@retval EFI_INVALID_PARAMETER Returns EFI_INVALID_PARAMETER if CpuIndex is invalid or CpuState is NULL
@retval EFI_DEVICE_ERROR Error occured in obtaining CPU status.
**/
typedef
EFI_STATUS
(EFIAPI *SMM_CPU_SYNC2_CHECK_CPU_STATE) (
IN SMM_CPU_SYNC2_PROTOCOL *This,
IN UINTN CpuIndex,
OUT SMM_CPU_SYNC2_CPU_STATE *CpuState
);
/**
Change CPU's SMM enabling state.
@param[in] This A pointer to the SMM_CPU_SYNC_PROTOCOL instance.
@param[in] CpuIndex Index of the CPU to enable / disable SMM
@param[in] Enable If TRUE, enable SMM; if FALSE disable SMM
@retval EFI_SUCCESS The CPU's SMM enabling state is changed.
@retval EFI_INVALID_PARAMETER Returns EFI_INVALID_PARAMETER if CpuIndex is invalid
@retval EFI_UNSUPPORTED Returns EFI_UNSUPPORTED the CPU does not support dynamically enabling / disabling SMI
@retval EFI_DEVICE_ERROR Error occured in changing SMM enabling state.
**/
typedef
EFI_STATUS
(EFIAPI *SMM_CPU_SYNC2_CHANGE_SMM_ENABLING) (
IN SMM_CPU_SYNC2_PROTOCOL *This,
IN UINTN CpuIndex,
IN BOOLEAN Enable
);
/**
Send SMI IPI to a specific CPU
@param[in] This A pointer to the SMM_CPU_SYNC_PROTOCOL instance.
@param[in] CpuIndex Index of the CPU to send SMI to. "-1" means all-exclude-self.
@retval EFI_SUCCESS The SMI IPI is sent successfully.
@retval EFI_INVALID_PARAMETER Returns EFI_INVALID_PARAMETER if CpuIndex is invalid
@retval EFI_DEVICE_ERROR Error occured in sending SMI IPI.
**/
typedef
EFI_STATUS
(EFIAPI *SMM_CPU_SYNC2_SEND_SMI) (
IN SMM_CPU_SYNC2_PROTOCOL *This,
IN UINTN CpuIndex
);
/**
Send SMI IPI to all CPUs excluding self
@param[in] This A pointer to the SMM_CPU_SYNC_PROTOCOL instance.
@retval EFI_SUCCESS The SMI IPI is sent successfully.
@retval EFI_INVALID_PARAMETER Returns EFI_INVALID_PARAMETER if CpuIndex is invalid
@retval EFI_DEVICE_ERROR Error occured in sending SMI IPI.
**/
typedef
EFI_STATUS
(EFIAPI *SMM_CPU_SYNC2_SEND_SMI_ALL_EXCLUDING_SELF) (
IN SMM_CPU_SYNC2_PROTOCOL *This
);
/**
This protocol provides services on SMM CPU syncrhonization related status and controls
**/
struct _SMM_CPU_SYNC2_PROTOCOL {
SMM_CPU_SYNC2_CHECK_AP_ARRIVAL CheckApArrival;
SMM_CPU_SYNC2_SET_MODE SetMode;
SMM_CPU_SYNC2_GET_MODE GetMode;
SMM_CPU_SYNC2_CHECK_CPU_STATE CheckCpuState;
SMM_CPU_SYNC2_CHANGE_SMM_ENABLING ChangeSmmEnabling;
SMM_CPU_SYNC2_SEND_SMI SendSmi;
SMM_CPU_SYNC2_SEND_SMI_ALL_EXCLUDING_SELF SendSmiAllExcludingSelf;
};
//
// Extern the GUID for protocol users.
//
extern EFI_GUID gSmmCpuSync2ProtocolGuid;
#endif
|
