mirror of https://github.com/acidanthera/audk.git
328 lines
9.9 KiB
C
328 lines
9.9 KiB
C
/*++
|
|
|
|
Copyright (c) 2006, Intel Corporation
|
|
All rights reserved. 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.
|
|
|
|
Module Name:
|
|
|
|
FlashMap.c
|
|
|
|
Abstract:
|
|
|
|
PEIM to build GUIDed HOBs for platform specific flash map
|
|
|
|
--*/
|
|
|
|
|
|
//
|
|
// The package level header files this module uses
|
|
//
|
|
#include <PiPei.h>
|
|
#include <WinNtPeim.h>
|
|
//
|
|
// The protocols, PPI and GUID defintions for this module
|
|
//
|
|
#include <Ppi/NtFwh.h>
|
|
#include <Guid/FirmwareFileSystem2.h>
|
|
#include <Ppi/FlashMap.h>
|
|
#include <Guid/FlashMapHob.h>
|
|
#include <Guid/SystemNvDataGuid.h>
|
|
#include <Protocol/FirmwareVolumeBlock.h>
|
|
//
|
|
// The Library classes this module consumes
|
|
//
|
|
#include <Library/DebugLib.h>
|
|
#include <Library/PeimEntryPoint.h>
|
|
#include <Library/HobLib.h>
|
|
#include <Library/PeiServicesLib.h>
|
|
#include <Library/BaseMemoryLib.h>
|
|
#include <Library/PcdLib.h>
|
|
|
|
|
|
#include <FlashLayout.h>
|
|
|
|
EFI_STATUS
|
|
EFIAPI
|
|
GetAreaInfo (
|
|
IN EFI_PEI_SERVICES **PeiServices,
|
|
IN PEI_FLASH_MAP_PPI *This,
|
|
IN EFI_FLASH_AREA_TYPE AreaType,
|
|
IN EFI_GUID *AreaTypeGuid,
|
|
OUT UINT32 *NumEntries,
|
|
OUT EFI_FLASH_SUBAREA_ENTRY **Entries
|
|
);
|
|
|
|
EFI_STATUS
|
|
EFIAPI
|
|
MemoryDiscoveredPpiNotifyCallback (
|
|
IN EFI_PEI_SERVICES **PeiServices,
|
|
IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDescriptor,
|
|
IN VOID *Ppi
|
|
);
|
|
|
|
//
|
|
// Module globals
|
|
//
|
|
static PEI_FLASH_MAP_PPI mFlashMapPpi = { GetAreaInfo };
|
|
|
|
static EFI_PEI_PPI_DESCRIPTOR mPpiListFlashMap = {
|
|
(EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),
|
|
&gPeiFlashMapPpiGuid,
|
|
&mFlashMapPpi
|
|
};
|
|
|
|
static EFI_FLASH_AREA_DATA mFlashAreaData[] = {
|
|
//
|
|
// Variable area
|
|
//
|
|
{
|
|
EFI_VARIABLE_STORE_OFFSET,
|
|
EFI_VARIABLE_STORE_LENGTH,
|
|
EFI_FLASH_AREA_SUBFV | EFI_FLASH_AREA_MEMMAPPED_FV,
|
|
EFI_FLASH_AREA_EFI_VARIABLES,
|
|
0, 0, 0,
|
|
{ 0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }
|
|
},
|
|
//
|
|
// FTW spare (backup) block
|
|
//
|
|
{
|
|
EFI_WINNT_FTW_SPARE_BLOCK_OFFSET,
|
|
EFI_WINNT_FTW_SPARE_BLOCK_LENGTH,
|
|
EFI_FLASH_AREA_SUBFV | EFI_FLASH_AREA_MEMMAPPED_FV,
|
|
EFI_FLASH_AREA_FTW_BACKUP,
|
|
0, 0, 0,
|
|
{ 0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }
|
|
},
|
|
//
|
|
// FTW private working (state) area
|
|
//
|
|
{
|
|
EFI_FTW_WORKING_OFFSET,
|
|
EFI_FTW_WORKING_LENGTH,
|
|
EFI_FLASH_AREA_SUBFV | EFI_FLASH_AREA_MEMMAPPED_FV,
|
|
EFI_FLASH_AREA_FTW_STATE,
|
|
0, 0, 0,
|
|
{ 0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }
|
|
},
|
|
//
|
|
// Recovery FV
|
|
//
|
|
{
|
|
EFI_WINNT_FIRMWARE_OFFSET,
|
|
EFI_WINNT_FIRMWARE_LENGTH,
|
|
EFI_FLASH_AREA_FV | EFI_FLASH_AREA_MEMMAPPED_FV,
|
|
EFI_FLASH_AREA_RECOVERY_BIOS,
|
|
0, 0, 0,
|
|
{ 0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }
|
|
},
|
|
//
|
|
// System Non-Volatile Storage FV
|
|
//
|
|
{
|
|
EFI_WINNT_RUNTIME_UPDATABLE_OFFSET,
|
|
EFI_WINNT_RUNTIME_UPDATABLE_LENGTH + EFI_WINNT_FTW_SPARE_BLOCK_LENGTH,
|
|
EFI_FLASH_AREA_FV | EFI_FLASH_AREA_MEMMAPPED_FV,
|
|
EFI_FLASH_AREA_GUID_DEFINED,
|
|
0, 0, 0,
|
|
EFI_SYSTEM_NV_DATA_HOB_GUID
|
|
},
|
|
};
|
|
|
|
|
|
EFI_STATUS
|
|
EFIAPI
|
|
PeimInitializeFlashMap (
|
|
IN EFI_FFS_FILE_HEADER *FfsHeader,
|
|
IN EFI_PEI_SERVICES **PeiServices
|
|
)
|
|
/*++
|
|
|
|
Routine Description:
|
|
Build GUIDed HOBs for platform specific flash map
|
|
|
|
Arguments:
|
|
FfsHeader - A pointer to the EFI_FFS_FILE_HEADER structure.
|
|
PeiServices - General purpose services available to every PEIM.
|
|
|
|
Returns:
|
|
EFI_STATUS
|
|
|
|
--*/
|
|
// TODO: EFI_SUCCESS - add return value to function comment
|
|
{
|
|
EFI_STATUS Status;
|
|
NT_FWH_PPI *NtFwhPpi;
|
|
EFI_PEI_PPI_DESCRIPTOR *PpiDescriptor;
|
|
EFI_PHYSICAL_ADDRESS FdBase;
|
|
UINT64 FdSize;
|
|
UINTN NumOfHobData;
|
|
UINTN Index;
|
|
EFI_FLASH_AREA_HOB_DATA FlashHobData;
|
|
|
|
DEBUG ((EFI_D_ERROR, "NT 32 Flash Map PEIM Loaded\n"));
|
|
|
|
//
|
|
// Install FlashMap PPI
|
|
//
|
|
Status = PeiServicesInstallPpi (&mPpiListFlashMap);
|
|
ASSERT_EFI_ERROR (Status);
|
|
|
|
|
|
//
|
|
// Get the Fwh Information PPI
|
|
//
|
|
Status = PeiServicesLocatePpi (
|
|
&gNtFwhPpiGuid, // GUID
|
|
0, // INSTANCE
|
|
&PpiDescriptor, // EFI_PEI_PPI_DESCRIPTOR
|
|
&NtFwhPpi // PPI
|
|
);
|
|
ASSERT_EFI_ERROR (Status);
|
|
|
|
//
|
|
// Assume that FD0 contains the Flash map.
|
|
//
|
|
Status = NtFwhPpi->NtFwh (0, &FdBase, &FdSize);
|
|
if (EFI_ERROR (Status)) {
|
|
return Status;
|
|
}
|
|
|
|
//
|
|
// Get number of types
|
|
//
|
|
NumOfHobData = sizeof (mFlashAreaData) / sizeof (EFI_FLASH_AREA_DATA);
|
|
|
|
//
|
|
// Build flash area entries as GUIDed HOBs.
|
|
//
|
|
for (Index = 0; Index < NumOfHobData; Index++) {
|
|
(*PeiServices)->SetMem (&FlashHobData, sizeof (EFI_FLASH_AREA_HOB_DATA), 0);
|
|
|
|
FlashHobData.AreaType = mFlashAreaData[Index].AreaType;
|
|
FlashHobData.NumberOfEntries = 1;
|
|
FlashHobData.SubAreaData.Attributes = mFlashAreaData[Index].Attributes;
|
|
FlashHobData.SubAreaData.Base = FdBase + (EFI_PHYSICAL_ADDRESS) (UINTN) mFlashAreaData[Index].Base;
|
|
FlashHobData.SubAreaData.Length = (EFI_PHYSICAL_ADDRESS) (UINTN) mFlashAreaData[Index].Length;
|
|
|
|
//
|
|
// We also update a PCD entry so that any driver that depend on
|
|
// PCD entry will get the information.
|
|
//
|
|
if (FlashHobData.AreaType == EFI_FLASH_AREA_EFI_VARIABLES) {
|
|
PcdSet32 (PcdFlashNvStorageVariableBase, (UINT32) FlashHobData.SubAreaData.Base);
|
|
PcdSet32 (PcdFlashNvStorageVariableSize, (UINT32) FlashHobData.SubAreaData.Length);
|
|
}
|
|
|
|
if (FlashHobData.AreaType == EFI_FLASH_AREA_FTW_STATE) {
|
|
PcdSet32 (PcdFlashNvStorageFtwWorkingBase, (UINT32) FlashHobData.SubAreaData.Base);
|
|
PcdSet32 (PcdFlashNvStorageFtwWorkingSize, (UINT32) FlashHobData.SubAreaData.Length);
|
|
}
|
|
|
|
if (FlashHobData.AreaType == EFI_FLASH_AREA_FTW_BACKUP) {
|
|
PcdSet32 (PcdFlashNvStorageFtwSpareBase, (UINT32) FlashHobData.SubAreaData.Base);
|
|
PcdSet32 (PcdFlashNvStorageFtwSpareSize, (UINT32) FlashHobData.SubAreaData.Length);
|
|
}
|
|
|
|
switch (FlashHobData.AreaType) {
|
|
case EFI_FLASH_AREA_RECOVERY_BIOS:
|
|
case EFI_FLASH_AREA_MAIN_BIOS:
|
|
(*PeiServices)->CopyMem (
|
|
&FlashHobData.AreaTypeGuid,
|
|
&gEfiFirmwareFileSystem2Guid,
|
|
sizeof (EFI_GUID)
|
|
);
|
|
(*PeiServices)->CopyMem (
|
|
&FlashHobData.SubAreaData.FileSystem,
|
|
&gEfiFirmwareVolumeBlockProtocolGuid,
|
|
sizeof (EFI_GUID)
|
|
);
|
|
break;
|
|
|
|
case EFI_FLASH_AREA_GUID_DEFINED:
|
|
(*PeiServices)->CopyMem (
|
|
&FlashHobData.AreaTypeGuid,
|
|
&mFlashAreaData[Index].AreaTypeGuid,
|
|
sizeof (EFI_GUID)
|
|
);
|
|
(*PeiServices)->CopyMem (
|
|
&FlashHobData.SubAreaData.FileSystem,
|
|
&gEfiFirmwareVolumeBlockProtocolGuid,
|
|
sizeof (EFI_GUID)
|
|
);
|
|
break;
|
|
|
|
default:
|
|
break;
|
|
}
|
|
|
|
//BuildGuidDataHob (
|
|
// &gEfiFlashMapHobGuid,
|
|
// &FlashHobData,
|
|
// sizeof (EFI_FLASH_AREA_HOB_DATA)
|
|
// );
|
|
}
|
|
|
|
return EFI_SUCCESS;
|
|
}
|
|
|
|
EFI_STATUS
|
|
EFIAPI
|
|
GetAreaInfo (
|
|
IN EFI_PEI_SERVICES **PeiServices,
|
|
IN PEI_FLASH_MAP_PPI *This,
|
|
IN EFI_FLASH_AREA_TYPE AreaType,
|
|
IN EFI_GUID *AreaTypeGuid,
|
|
OUT UINT32 *NumEntries,
|
|
OUT EFI_FLASH_SUBAREA_ENTRY **Entries
|
|
)
|
|
/*++
|
|
|
|
Routine Description:
|
|
Implementation of Flash Map PPI
|
|
|
|
--*/
|
|
// TODO: function comment is missing 'Arguments:'
|
|
// TODO: function comment is missing 'Returns:'
|
|
// TODO: PeiServices - add argument and description to function comment
|
|
// TODO: This - add argument and description to function comment
|
|
// TODO: AreaType - add argument and description to function comment
|
|
// TODO: AreaTypeGuid - add argument and description to function comment
|
|
// TODO: NumEntries - add argument and description to function comment
|
|
// TODO: Entries - add argument and description to function comment
|
|
// TODO: EFI_SUCCESS - add return value to function comment
|
|
// TODO: EFI_NOT_FOUND - add return value to function comment
|
|
{
|
|
EFI_STATUS Status;
|
|
EFI_PEI_HOB_POINTERS Hob;
|
|
EFI_HOB_FLASH_MAP_ENTRY_TYPE *FlashMapEntry;
|
|
|
|
Status = PeiServicesGetHobList (&Hob.Raw);
|
|
while (!END_OF_HOB_LIST (Hob)) {
|
|
if (Hob.Header->HobType == EFI_HOB_TYPE_GUID_EXTENSION && CompareGuid (&Hob.Guid->Name, &gEfiFlashMapHobGuid)) {
|
|
FlashMapEntry = (EFI_HOB_FLASH_MAP_ENTRY_TYPE *) Hob.Raw;
|
|
if (AreaType == FlashMapEntry->AreaType) {
|
|
if (AreaType == EFI_FLASH_AREA_GUID_DEFINED) {
|
|
if (!CompareGuid (AreaTypeGuid, &FlashMapEntry->AreaTypeGuid)) {
|
|
goto NextHob;
|
|
}
|
|
}
|
|
|
|
*NumEntries = FlashMapEntry->NumEntries;
|
|
*Entries = FlashMapEntry->Entries;
|
|
return EFI_SUCCESS;
|
|
}
|
|
}
|
|
NextHob:
|
|
Hob.Raw = GET_NEXT_HOB (Hob);
|
|
}
|
|
|
|
return EFI_NOT_FOUND;
|
|
}
|