2 ACPI CPU Data initialization module
4 This module initializes the ACPI_CPU_DATA structure and registers the address
5 of this structure in the PcdCpuS3DataAddress PCD. This is a generic/simple
6 version of this module. It does not provide a machine check handler or CPU
7 register initialization tables for ACPI S3 resume. It also only supports the
8 number of CPUs reported by the MP Services Protocol, so this module does not
9 support hot plug CPUs. This module can be copied into a CPU specific package
10 and customized if these additional features are required.
12 Copyright (c) 2013 - 2015, Intel Corporation. All rights reserved.<BR>
13 Copyright (c) 2015, Red Hat, Inc.
15 This program and the accompanying materials
16 are licensed and made available under the terms and conditions of the BSD License
17 which accompanies this distribution. The full text of the license may be found at
18 http://opensource.org/licenses/bsd-license.php
20 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
21 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
27 #include <AcpiCpuData.h>
29 #include <Library/BaseLib.h>
30 #include <Library/BaseMemoryLib.h>
31 #include <Library/UefiBootServicesTableLib.h>
32 #include <Library/DebugLib.h>
33 #include <Library/MtrrLib.h>
35 #include <Protocol/MpService.h>
36 #include <Guid/EventGroup.h>
39 // Data structure used to allocate ACPI_CPU_DATA and its supporting structures
42 ACPI_CPU_DATA AcpiCpuData
;
43 MTRR_SETTINGS MtrrTable
;
44 IA32_DESCRIPTOR GdtrProfile
;
45 IA32_DESCRIPTOR IdtrProfile
;
49 Allocate EfiACPIMemoryNVS below 4G memory address.
51 This function allocates EfiACPIMemoryNVS below 4G memory address.
53 @param[in] Size Size of memory to allocate.
55 @return Allocated address for output.
59 AllocateAcpiNvsMemoryBelow4G (
63 EFI_PHYSICAL_ADDRESS Address
;
67 Address
= BASE_4GB
- 1;
68 Status
= gBS
->AllocatePages (
71 EFI_SIZE_TO_PAGES (Size
),
74 if (EFI_ERROR (Status
)) {
78 Buffer
= (VOID
*)(UINTN
)Address
;
79 ZeroMem (Buffer
, Size
);
85 Callback function executed when the EndOfDxe event group is signaled.
87 We delay saving the MTRR settings until BDS signals EndOfDxe.
89 @param[in] Event Event whose notification function is being invoked.
90 @param[out] Context Pointer to the MTRR_SETTINGS buffer to fill in.
99 DEBUG ((EFI_D_VERBOSE
, "%a\n", __FUNCTION__
));
100 MtrrGetAllMtrrs (Context
);
103 // Close event, so it will not be invoked again.
105 gBS
->CloseEvent (Event
);
109 The entry function of the CpuS3Data driver.
111 Allocate and initialize all fields of the ACPI_CPU_DATA structure except the
112 MTRR settings. Register an event notification on gEfiEndOfDxeEventGroupGuid
113 to capture the ACPI_CPU_DATA MTRR settings. The PcdCpuS3DataAddress is set
114 to the address that ACPI_CPU_DATA is allocated at.
116 @param[in] ImageHandle The firmware allocated handle for the EFI image.
117 @param[in] SystemTable A pointer to the EFI System Table.
119 @retval EFI_SUCCESS The entry point is executed successfully.
120 @retval other Some error occurs when executing this entry point.
125 CpuS3DataInitialize (
126 IN EFI_HANDLE ImageHandle
,
127 IN EFI_SYSTEM_TABLE
*SystemTable
131 ACPI_CPU_DATA_EX
*AcpiCpuDataEx
;
132 ACPI_CPU_DATA
*AcpiCpuData
;
133 EFI_MP_SERVICES_PROTOCOL
*MpServices
;
135 UINTN NumberOfEnabledProcessors
;
138 CPU_REGISTER_TABLE
*RegisterTable
;
140 EFI_PROCESSOR_INFORMATION ProcessorInfoBuffer
;
148 // Allocate ACPI NVS memory below 4G memory for use on ACPI S3 resume.
150 AcpiCpuDataEx
= AllocateAcpiNvsMemoryBelow4G (sizeof (ACPI_CPU_DATA_EX
));
151 ASSERT (AcpiCpuDataEx
!= NULL
);
152 AcpiCpuData
= &AcpiCpuDataEx
->AcpiCpuData
;
155 // Get MP Services Protocol
157 Status
= gBS
->LocateProtocol (
158 &gEfiMpServiceProtocolGuid
,
162 ASSERT_EFI_ERROR (Status
);
165 // Allocate a 4KB reserved page below 1MB
167 AcpiCpuData
->StartupVector
= BASE_1MB
- 1;
168 Status
= gBS
->AllocatePages (
170 EfiReservedMemoryType
,
172 &AcpiCpuData
->StartupVector
174 ASSERT_EFI_ERROR (Status
);
177 // Get the number of CPUs
179 Status
= MpServices
->GetNumberOfProcessors (
182 &NumberOfEnabledProcessors
184 ASSERT_EFI_ERROR (Status
);
185 AcpiCpuData
->NumberOfCpus
= (UINT32
)NumberOfCpus
;
188 // Initialize ACPI_CPU_DATA fields
190 AcpiCpuData
->StackSize
= PcdGet32 (PcdCpuApStackSize
);
191 AcpiCpuData
->ApMachineCheckHandlerBase
= 0;
192 AcpiCpuData
->ApMachineCheckHandlerSize
= 0;
193 AcpiCpuData
->GdtrProfile
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)&AcpiCpuDataEx
->GdtrProfile
;
194 AcpiCpuData
->IdtrProfile
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)&AcpiCpuDataEx
->IdtrProfile
;
195 AcpiCpuData
->MtrrTable
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)&AcpiCpuDataEx
->MtrrTable
;
198 // Allocate stack space for all CPUs
200 Stack
= AllocateAcpiNvsMemoryBelow4G (NumberOfCpus
* AcpiCpuData
->StackSize
);
201 ASSERT (Stack
!= NULL
);
202 AcpiCpuData
->StackAddress
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)Stack
;
205 // Get the boot processor's GDT and IDT
207 AsmReadGdtr (&AcpiCpuDataEx
->GdtrProfile
);
208 AsmReadIdtr (&AcpiCpuDataEx
->IdtrProfile
);
211 // Allocate GDT and IDT in ACPI NVS and copy current GDT and IDT contents
213 GdtSize
= AcpiCpuDataEx
->GdtrProfile
.Limit
+ 1;
214 IdtSize
= AcpiCpuDataEx
->IdtrProfile
.Limit
+ 1;
215 Gdt
= AllocateAcpiNvsMemoryBelow4G (GdtSize
+ IdtSize
);
216 ASSERT (Gdt
!= NULL
);
217 Idt
= (VOID
*)((UINTN
)Gdt
+ GdtSize
);
218 CopyMem (Gdt
, (VOID
*)AcpiCpuDataEx
->GdtrProfile
.Base
, GdtSize
);
219 CopyMem (Idt
, (VOID
*)AcpiCpuDataEx
->IdtrProfile
.Base
, IdtSize
);
220 AcpiCpuDataEx
->GdtrProfile
.Base
= (UINTN
)Gdt
;
221 AcpiCpuDataEx
->IdtrProfile
.Base
= (UINTN
)Idt
;
224 // Allocate buffer for empty RegisterTable and PreSmmInitRegisterTable for all CPUs
226 TableSize
= 2 * NumberOfCpus
* sizeof (CPU_REGISTER_TABLE
);
227 RegisterTable
= (CPU_REGISTER_TABLE
*)AllocateAcpiNvsMemoryBelow4G (TableSize
);
228 ASSERT (RegisterTable
!= NULL
);
229 for (Index
= 0; Index
< NumberOfCpus
; Index
++) {
230 Status
= MpServices
->GetProcessorInfo (
235 ASSERT_EFI_ERROR (Status
);
237 RegisterTable
[Index
].InitialApicId
= (UINT32
)ProcessorInfoBuffer
.ProcessorId
;
238 RegisterTable
[Index
].TableLength
= 0;
239 RegisterTable
[Index
].AllocatedSize
= 0;
240 RegisterTable
[Index
].RegisterTableEntry
= NULL
;
242 RegisterTable
[NumberOfCpus
+ Index
].InitialApicId
= (UINT32
)ProcessorInfoBuffer
.ProcessorId
;
243 RegisterTable
[NumberOfCpus
+ Index
].TableLength
= 0;
244 RegisterTable
[NumberOfCpus
+ Index
].AllocatedSize
= 0;
245 RegisterTable
[NumberOfCpus
+ Index
].RegisterTableEntry
= NULL
;
247 AcpiCpuData
->RegisterTable
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)RegisterTable
;
248 AcpiCpuData
->PreSmmInitRegisterTable
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)(RegisterTable
+ NumberOfCpus
);
251 // Set PcdCpuS3DataAddress to the base address of the ACPI_CPU_DATA structure
253 Status
= PcdSet64S (PcdCpuS3DataAddress
, (UINT64
)(UINTN
)AcpiCpuData
);
254 ASSERT_EFI_ERROR (Status
);
257 // Register EFI_END_OF_DXE_EVENT_GROUP_GUID event.
258 // The notification function saves MTRRs for ACPI_CPU_DATA
260 Status
= gBS
->CreateEventEx (
264 &AcpiCpuDataEx
->MtrrTable
,
265 &gEfiEndOfDxeEventGroupGuid
,
268 ASSERT_EFI_ERROR (Status
);