summaryrefslogtreecommitdiff
path: root/Platform/BroxtonPlatformPkg/Common/Features/S3/SmramSaveInfoHandlerSmm/SmramSaveInfoHandlerSmm.c
blob: 82efcfe366605d79e30b9cafad8d503ff7331a1f (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
/** @file
  A helper driver to save information to SMRAM after SMRR is enabled.

  Copyright (c) 2011 - 2016, 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.

**/

#include "SmramSaveInfoHandlerSmm.h"

#define SMM_FROM_CPU_DRIVER_SAVE_INFO 0x81

#define EFI_SMRAM_CPU_NVS_HEADER_GUID \
  { \
    0x429501d9, 0xe447, 0x40f4, 0x86, 0x7b, 0x75, 0xc9, 0x3a, 0x1d, 0xb5, 0x4e \
  }

GLOBAL_REMOVE_IF_UNREFERENCED UINT8   mSmiDataRegister;
GLOBAL_REMOVE_IF_UNREFERENCED BOOLEAN mLocked = FALSE;
EFI_GUID mSmramCpuNvsHeaderGuid = EFI_SMRAM_CPU_NVS_HEADER_GUID;

CPU_INFO_PROTOCOL *mCpuInfoProtocol;


/**
  Dispatch function for a Software SMI handler.

  Save CPU data to SMRAM.
  To be fixed: Need to negotiate a base address for the saved data in SMRAM.

  @param[in]  DispatchHandle        The handle of this dispatch function.
  @param[in]  DispatchContext       The pointer to the dispatch function's context.
                                    The SwSmiInputValue field is filled in
                                    by the software dispatch driver prior to
                                    invoking this dispatch function.
                                    The dispatch function will only be called
                                    for input values for which it is registered.

**/
EFI_STATUS
SmramSaveInfoHandler (
  IN  EFI_HANDLE                    DispatchHandle,
  IN  EFI_SMM_SW_REGISTER_CONTEXT   *DispatchContext
  )
{
  EFI_STATUS                Status;
  UINT64                    VarData[3];
  EFI_PHYSICAL_ADDRESS      SmramDataAddress;

  ASSERT (DispatchContext != NULL);
  ASSERT (DispatchContext->SwSmiInputValue == mCpuInfoProtocol->CpuInfo->SmmbaseSwSmiNumber);
  DEBUG ((EFI_D_INFO, "SmramSaveInfoHandler() Enter\n"));
  DEBUG ((EFI_D_INFO, "mLocked = %x\n",mLocked));
  DEBUG ((EFI_D_INFO, "mSmiDataRegister = 0x%02x\n",mSmiDataRegister));
  DEBUG ((EFI_D_INFO, "IoRead8 (mSmiDataRegister) = 0x%02x\n",IoRead8 (mSmiDataRegister)));

  if (!mLocked && IoRead8 (mSmiDataRegister) == SMM_FROM_CPU_DRIVER_SAVE_INFO) {
    VarData[2] = mCpuInfoProtocol->SmramCpuInfo->LockBoxSize;
    VarData[1] = mCpuInfoProtocol->SmramCpuInfo->SmramCpuData;

    Status = gSmst->SmmAllocatePages (
                      AllocateAnyPages,
                      EfiRuntimeServicesData,
                      EFI_SIZE_TO_PAGES ((UINTN) VarData[2]),
                      &SmramDataAddress
                      );
    ASSERT_EFI_ERROR (Status);
    DEBUG ((DEBUG_INFO, "CPU SMRAM NVS Data - %x\n", SmramDataAddress));
    DEBUG ((DEBUG_INFO, "CPU SMRAM NVS Data size - %x\n", VarData[2]));
    VarData[0] = (UINT64) SmramDataAddress;
    CopyMem (
      (VOID *) (UINTN) (VarData[0]),
      (VOID *) (UINTN) (VarData[1]),
      (UINTN) (VarData[2])
      );
  }

  return EFI_SUCCESS;
}


/**
  Smm Ready To Lock event notification handler.
  It sets a flag indicating that SMRAM has been locked.

  @param[in] Protocol      Points to the protocol's unique identifier.
  @param[in] Interface     Points to the interface instance.
  @param[in] Handle        The handle on which the interface was installed.

  @retval    EFI_SUCCESS   Notification handler runs successfully.

 **/
EFI_STATUS
EFIAPI
SmmReadyToLockEventNotify (
  IN CONST EFI_GUID  *Protocol,
  IN VOID            *Interface,
  IN EFI_HANDLE      Handle
  )
{
  mLocked = TRUE;
  return EFI_SUCCESS;
}


/**
  Entry point function of this driver.

  @param[in] ImageHandle     The firmware allocated handle for the EFI image.
  @param[in] SystemTable     A pointer to the EFI System Table.

  @retval    EFI_SUCCESS     The entry point is executed successfully.
  @retval    other           Some error occurs when executing this entry point.

**/
EFI_STATUS
EFIAPI
SmramSaveInfoHandlerSmmMain (
  IN EFI_HANDLE       ImageHandle,
  IN EFI_SYSTEM_TABLE *SystemTable
  )
{
  EFI_STATUS                    Status;
  VOID                          *Registration;
  EFI_SMM_SW_DISPATCH2_PROTOCOL *SmmSwDispatch;
  EFI_SMM_SW_REGISTER_CONTEXT   SmmSwDispatchContext;
  EFI_HANDLE                    DispatchHandle;

  DEBUG ((EFI_D_INFO, "SmramSaveInfoHandlerSmmMain() Enter\n"));
  //
  // Get SMI data register
  //
  mSmiDataRegister = R_APM_STS;

  //
  // Register software SMI handler
  //
  Status = gSmst->SmmLocateProtocol (
                    &gEfiSmmSwDispatch2ProtocolGuid,
                    NULL,
                    (VOID **) &SmmSwDispatch
                    );
  ASSERT_EFI_ERROR (Status);

  //
  // Locate CPU Info Protocol
  //
  Status = gBS->LocateProtocol (
                  &gCpuInfoProtocolGuid,
                  NULL,
                  (VOID **) &mCpuInfoProtocol
                  );
  ASSERT_EFI_ERROR (Status);

  SmmSwDispatchContext.SwSmiInputValue = mCpuInfoProtocol->CpuInfo->SmmbaseSwSmiNumber;

  Status = SmmSwDispatch->Register (
                            SmmSwDispatch,
                            (EFI_SMM_HANDLER_ENTRY_POINT2) &SmramSaveInfoHandler,
                            &SmmSwDispatchContext,
                            &DispatchHandle
                            );
  ASSERT_EFI_ERROR (Status);

  //
  // Register SMM Ready To Lock Protocol notification
  //
  Status = gSmst->SmmRegisterProtocolNotify (
                    &gEfiSmmReadyToLockProtocolGuid,
                    SmmReadyToLockEventNotify,
                    &Registration
                    );
  ASSERT_EFI_ERROR (Status);
  DEBUG ((EFI_D_INFO, "SmramSaveInfoHandlerSmmMain() Exit\n"));

  return Status;
}