summaryrefslogtreecommitdiff
path: root/ReferenceCode/ME/Library/AMT/Pei/AmtPolicyLibPei.c
blob: 472ebbcf4b1742832c16512b5776206888e81f10 (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
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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
/** @file
  Implementation file for AMT Policy functionality for PEIM

@copyright
  Copyright (c) 2006 - 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
**/

//
// External include files do NOT need to be explicitly specified in real EDKII
// environment
//
#if !defined(EDK_RELEASE_VERSION) || (EDK_RELEASE_VERSION < 0x00020000)
#include "EdkIIGluePeim.h"
#include "AmtPolicyLibPei.h"
#endif

EFI_GUID  mPeiAmtStatusCodePpiGuid = PEI_AMT_STATUS_CODE_PPI_GUID;

/**
  Check if Amt is enabled in setup options.

  @param[in] PeiServices          General purpose services available to every PEIM.
  @param[in] PeiAmtPlatformPolicy The AMT Platform Policy protocol instance

  @retval EFI_SUCCESS             AMT platform policy Ppi located
  @retval All other error conditions encountered result in an ASSERT.
**/
EFI_STATUS
PeiAmtPolicyLibInit (
  EFI_PEI_SERVICES                **PeiServices,
  PEI_AMT_PLATFORM_POLICY_PPI     **PeiAmtPlatformPolicy
  )
{
  EFI_STATUS  Status;

  ///
  /// Locate system configuration variable
  ///
  Status = PeiServicesLocatePpi (
            &gPeiAmtPlatformPolicyPpiGuid,  // GUID
            0,                              // INSTANCE
            NULL,                           // EFI_PEI_PPI_DESCRIPTOR
            (VOID **) PeiAmtPlatformPolicy  // PPI
            );
  ASSERT_EFI_ERROR (Status);
  return Status;
}

/**
  Check if AMT WatchDog is enabled in setup options.

  @param[in] PeiServices          Point to Pei Services structure

  @retval FALSE                   AMT WatchDog is disabled.
  @retval TRUE                    AMT WatchDog is enabled.
**/
BOOLEAN
PeiAmtWatchDog (
  IN  EFI_PEI_SERVICES            **PeiServices
  )
{
  EFI_STATUS                      Status;
  BOOLEAN                         Supported;
  PEI_AMT_PLATFORM_POLICY_PPI     *PeiAmtPlatformPolicy;

  Supported = FALSE;
  if (ManageabilityModeSetting (PeiServices) != 0) {
    Status = PeiAmtPolicyLibInit (PeiServices, &PeiAmtPlatformPolicy);
    ASSERT_EFI_ERROR (Status);
    //
    // First check if AMT WatchDog is enabled in Setup.
    //
    if (PeiAmtPlatformPolicy->WatchDog == 1) {
      Supported = TRUE;
    }
  }

  return Supported;
}

/**
  Get WatchDog BIOS Timmer.

  @param[in] PeiServices          Point to Pei Services structure

  @retval UINT16                  WatchDog BIOS Timer
**/
UINT16
PeiAmtWatchTimerBiosGet (
  IN  EFI_PEI_SERVICES            **PeiServices
  )
{
  EFI_STATUS                  Status;
  PEI_AMT_PLATFORM_POLICY_PPI *PeiAmtPlatformPolicy;

  Status = PeiAmtPolicyLibInit (PeiServices, &PeiAmtPlatformPolicy);
  ASSERT_EFI_ERROR (Status);

  return PeiAmtPlatformPolicy->WatchDogTimerBios;
}

/**
  Check if AMT is enabled in setup options.

  @param[in] PeiServices          Point to Pei Services structure

  @retval FALSE                   ActiveManagement is disabled.
  @retval TRUE                    ActiveManagement is enabled.
**/
BOOLEAN
PeiAmtSupported (
  IN  EFI_PEI_SERVICES            **PeiServices
  )
{
  EFI_STATUS                      Status;
  BOOLEAN                         Supported;
  PEI_AMT_PLATFORM_POLICY_PPI     *PeiAmtPlatformPolicy;

  Status = PeiAmtPolicyLibInit (PeiServices, &PeiAmtPlatformPolicy);
  ASSERT_EFI_ERROR (Status);

  //
  // First check if AMT support is enabled in Setup.
  //
  if (PeiAmtPlatformPolicy->iAmtEnabled == 1) {
    Supported = TRUE;
  } else {
    Supported = FALSE;
  }

  return Supported;
}

/**
  Check if ASF is enabled in setup options.

  @param[in] PeiServices          Point to Pei Services structure

  @retval FALSE                   ASF is disabled.
  @retval TRUE                    ASF is enabled.
**/
BOOLEAN
PeiAsfSupported (
  IN  EFI_PEI_SERVICES            **PeiServices
  )
{
  EFI_STATUS                      Status;
  BOOLEAN                         Supported;
  PEI_AMT_PLATFORM_POLICY_PPI     *PeiAmtPlatformPolicy;

  Status = PeiAmtPolicyLibInit (PeiServices, &PeiAmtPlatformPolicy);
  ASSERT_EFI_ERROR (Status);

  if (PeiAmtPlatformPolicy->Revision < PEI_AMT_PLATFORM_POLICY_PPI_REVISION_2) {
    return FALSE;
  }
  //
  // First check if ASF support is enabled in Setup.
  //
  if (PeiAmtPlatformPolicy->AsfEnabled == 1) {
    Supported = TRUE;
  } else {
    Supported = FALSE;
  }

  return Supported;
}

/**
  Provide Manageability Mode setting from MEBx BIOS Sync Data

  @param[in] PeiServices          Point to Pei Services structure

  @retval UINT8                   Manageability Mode = MNT_AMT or MNT_ASF
**/
UINT8
ManageabilityModeSetting (
  IN  EFI_PEI_SERVICES            **PeiServices
  )
{
  EFI_STATUS                      Status;
  PEI_AMT_PLATFORM_POLICY_PPI     *PeiAmtPlatformPolicy;

  Status = PeiAmtPolicyLibInit (PeiServices, &PeiAmtPlatformPolicy);
  ASSERT_EFI_ERROR (Status);

  if (PeiAmtPlatformPolicy->Revision < PEI_AMT_PLATFORM_POLICY_PPI_REVISION_2) {
    return 0;
  }

  return (UINT8) (PeiAmtPlatformPolicy->ManageabilityMode);
}

/**
  This will return progress event Option.
  True if the option is enabled.

  @param[in] PeiServices          Point to Pei Services structure

  @retval True                    progress event is enabled.
  @retval False                   progress event is disabled.
**/
BOOLEAN
PeiFwProgressSupport (
  IN  EFI_PEI_SERVICES            **PeiServices
  )
{
  EFI_STATUS                      Status;
  BOOLEAN                         Supported;
  PEI_AMT_PLATFORM_POLICY_PPI     *PeiAmtPlatformPolicy;

  Status = PeiAmtPolicyLibInit (PeiServices, &PeiAmtPlatformPolicy);
  ASSERT_EFI_ERROR (Status);

  Supported = FALSE;

  if (PeiAmtPlatformPolicy->Revision >= PEI_AMT_PLATFORM_POLICY_PPI_REVISION_3) {
    //
    // Check if progress event is enabled in Setup.
    //
    if (PeiAmtPlatformPolicy->FWProgress == 1) {
      Supported = TRUE;
    }
  }

  return Supported;
}