+++ /dev/null
-/*++\r
-\r
-Copyright (c) 2006, Intel Corporation \r
-All rights reserved. This program and the accompanying materials \r
-are licensed and made available under the terms and conditions of the BSD License \r
-which accompanies this distribution. The full text of the license may be found at \r
-http://opensource.org/licenses/bsd-license.php \r
- \r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
-\r
-Module Name:\r
-\r
- FlashMap.c\r
- \r
-Abstract:\r
-\r
- PEIM to build GUIDed HOBs for platform specific flash map\r
-\r
---*/\r
-\r
-\r
-#include <FlashLayout.h>\r
-\r
-EFI_STATUS\r
-EFIAPI\r
-GetAreaInfo (\r
- IN EFI_PEI_SERVICES **PeiServices,\r
- IN PEI_FLASH_MAP_PPI *This,\r
- IN EFI_FLASH_AREA_TYPE AreaType,\r
- IN EFI_GUID *AreaTypeGuid,\r
- OUT UINT32 *NumEntries,\r
- OUT EFI_FLASH_SUBAREA_ENTRY **Entries\r
- );\r
-\r
-EFI_STATUS\r
-EFIAPI\r
-MemoryDiscoveredPpiNotifyCallback (\r
- IN EFI_PEI_SERVICES **PeiServices,\r
- IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDescriptor,\r
- IN VOID *Ppi\r
- );\r
-\r
-//\r
-// Module globals\r
-//\r
-static PEI_FLASH_MAP_PPI mFlashMapPpi = { GetAreaInfo };\r
-\r
-static EFI_PEI_PPI_DESCRIPTOR mPpiListFlashMap = {\r
- (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
- &gPeiFlashMapPpiGuid,\r
- &mFlashMapPpi\r
-};\r
-\r
-static EFI_FLASH_AREA_DATA mFlashAreaData[] = {\r
- //\r
- // Variable area\r
- //\r
- {\r
- EFI_VARIABLE_STORE_OFFSET,\r
- EFI_VARIABLE_STORE_LENGTH,\r
- EFI_FLASH_AREA_SUBFV | EFI_FLASH_AREA_MEMMAPPED_FV,\r
- EFI_FLASH_AREA_EFI_VARIABLES,\r
- 0, 0, 0,\r
- { 0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }\r
- },\r
- //\r
- // FTW spare (backup) block\r
- //\r
- {\r
- EFI_WINNT_FTW_SPARE_BLOCK_OFFSET,\r
- EFI_WINNT_FTW_SPARE_BLOCK_LENGTH,\r
- EFI_FLASH_AREA_SUBFV | EFI_FLASH_AREA_MEMMAPPED_FV,\r
- EFI_FLASH_AREA_FTW_BACKUP,\r
- 0, 0, 0,\r
- { 0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }\r
- },\r
- //\r
- // FTW private working (state) area\r
- //\r
- {\r
- EFI_FTW_WORKING_OFFSET,\r
- EFI_FTW_WORKING_LENGTH,\r
- EFI_FLASH_AREA_SUBFV | EFI_FLASH_AREA_MEMMAPPED_FV,\r
- EFI_FLASH_AREA_FTW_STATE,\r
- 0, 0, 0,\r
- { 0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }\r
- },\r
- //\r
- // Recovery FV\r
- //\r
- {\r
- EFI_WINNT_FIRMWARE_OFFSET,\r
- EFI_WINNT_FIRMWARE_LENGTH,\r
- EFI_FLASH_AREA_FV | EFI_FLASH_AREA_MEMMAPPED_FV,\r
- EFI_FLASH_AREA_RECOVERY_BIOS,\r
- 0, 0, 0,\r
- { 0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }\r
- },\r
- //\r
- // System Non-Volatile Storage FV\r
- //\r
- {\r
- EFI_WINNT_RUNTIME_UPDATABLE_OFFSET,\r
- EFI_WINNT_RUNTIME_UPDATABLE_LENGTH + EFI_WINNT_FTW_SPARE_BLOCK_LENGTH,\r
- EFI_FLASH_AREA_FV | EFI_FLASH_AREA_MEMMAPPED_FV,\r
- EFI_FLASH_AREA_GUID_DEFINED,\r
- 0, 0, 0,\r
- EFI_SYSTEM_NV_DATA_HOB_GUID\r
- },\r
-};\r
-\r
-\r
-EFI_STATUS\r
-EFIAPI\r
-PeimInitializeFlashMap (\r
- IN EFI_FFS_FILE_HEADER *FfsHeader,\r
- IN EFI_PEI_SERVICES **PeiServices\r
- )\r
-/*++\r
-\r
-Routine Description:\r
- Build GUIDed HOBs for platform specific flash map\r
- \r
-Arguments:\r
- FfsHeader - A pointer to the EFI_FFS_FILE_HEADER structure.\r
- PeiServices - General purpose services available to every PEIM.\r
- \r
-Returns:\r
- EFI_STATUS\r
-\r
---*/\r
-// TODO: EFI_SUCCESS - add return value to function comment\r
-{\r
- EFI_STATUS Status;\r
- NT_FWH_PPI *NtFwhPpi;\r
- EFI_PEI_PPI_DESCRIPTOR *PpiDescriptor;\r
- EFI_PHYSICAL_ADDRESS FdBase;\r
- UINT64 FdSize;\r
- UINTN NumOfHobData;\r
- UINTN Index;\r
- EFI_FLASH_AREA_HOB_DATA FlashHobData;\r
-\r
- DEBUG ((EFI_D_ERROR, "NT 32 Flash Map PEIM Loaded\n"));\r
-\r
- //\r
- // Install FlashMap PPI\r
- //\r
- Status = PeiServicesInstallPpi (&mPpiListFlashMap);\r
- ASSERT_EFI_ERROR (Status);\r
-\r
-\r
- //\r
- // Get the Fwh Information PPI\r
- //\r
- Status = PeiServicesLocatePpi (\r
- &gNtFwhPpiGuid, // GUID\r
- 0, // INSTANCE\r
- &PpiDescriptor, // EFI_PEI_PPI_DESCRIPTOR\r
- &NtFwhPpi // PPI\r
- );\r
- ASSERT_EFI_ERROR (Status);\r
-\r
- //\r
- // Assume that FD0 contains the Flash map.\r
- //\r
- Status = NtFwhPpi->NtFwh (0, &FdBase, &FdSize);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- //\r
- // Get number of types\r
- //\r
- NumOfHobData = sizeof (mFlashAreaData) / sizeof (EFI_FLASH_AREA_DATA);\r
-\r
- //\r
- // Build flash area entries as GUIDed HOBs.\r
- //\r
- for (Index = 0; Index < NumOfHobData; Index++) {\r
- (*PeiServices)->SetMem (&FlashHobData, sizeof (EFI_FLASH_AREA_HOB_DATA), 0);\r
-\r
- FlashHobData.AreaType = mFlashAreaData[Index].AreaType;\r
- FlashHobData.NumberOfEntries = 1;\r
- FlashHobData.SubAreaData.Attributes = mFlashAreaData[Index].Attributes;\r
- FlashHobData.SubAreaData.Base = FdBase + (EFI_PHYSICAL_ADDRESS) (UINTN) mFlashAreaData[Index].Base;\r
- FlashHobData.SubAreaData.Length = (EFI_PHYSICAL_ADDRESS) (UINTN) mFlashAreaData[Index].Length;\r
-\r
- //\r
- // We also update a PCD entry so that any driver that depend on\r
- // PCD entry will get the information.\r
- //\r
- if (FlashHobData.AreaType == EFI_FLASH_AREA_EFI_VARIABLES) {\r
- PcdSet32 (PcdFlashNvStorageVariableBase, (UINT32) FlashHobData.SubAreaData.Base);\r
- PcdSet32 (PcdFlashNvStorageVariableSize, (UINT32) FlashHobData.SubAreaData.Length);\r
- }\r
-\r
- if (FlashHobData.AreaType == EFI_FLASH_AREA_FTW_STATE) {\r
- PcdSet32 (PcdFlashNvStorageFtwWorkingBase, (UINT32) FlashHobData.SubAreaData.Base);\r
- PcdSet32 (PcdFlashNvStorageFtwWorkingSize, (UINT32) FlashHobData.SubAreaData.Length);\r
- }\r
-\r
- if (FlashHobData.AreaType == EFI_FLASH_AREA_FTW_BACKUP) {\r
- PcdSet32 (PcdFlashNvStorageFtwSpareBase, (UINT32) FlashHobData.SubAreaData.Base);\r
- PcdSet32 (PcdFlashNvStorageFtwSpareSize, (UINT32) FlashHobData.SubAreaData.Length);\r
- }\r
-\r
- switch (FlashHobData.AreaType) {\r
- case EFI_FLASH_AREA_RECOVERY_BIOS:\r
- case EFI_FLASH_AREA_MAIN_BIOS:\r
- (*PeiServices)->CopyMem (\r
- &FlashHobData.AreaTypeGuid,\r
- &gEfiFirmwareFileSystemGuid,\r
- sizeof (EFI_GUID)\r
- );\r
- (*PeiServices)->CopyMem (\r
- &FlashHobData.SubAreaData.FileSystem,\r
- &gEfiFirmwareVolumeBlockProtocolGuid,\r
- sizeof (EFI_GUID)\r
- );\r
- break;\r
-\r
- case EFI_FLASH_AREA_GUID_DEFINED:\r
- (*PeiServices)->CopyMem (\r
- &FlashHobData.AreaTypeGuid,\r
- &mFlashAreaData[Index].AreaTypeGuid,\r
- sizeof (EFI_GUID)\r
- );\r
- (*PeiServices)->CopyMem (\r
- &FlashHobData.SubAreaData.FileSystem,\r
- &gEfiFirmwareVolumeBlockProtocolGuid,\r
- sizeof (EFI_GUID)\r
- );\r
- break;\r
-\r
- default:\r
- break;\r
- }\r
-\r
- BuildGuidDataHob (\r
- &gEfiFlashMapHobGuid,\r
- &FlashHobData,\r
- sizeof (EFI_FLASH_AREA_HOB_DATA)\r
- );\r
- }\r
-\r
- return EFI_SUCCESS;\r
-}\r
-\r
-EFI_STATUS\r
-EFIAPI\r
-GetAreaInfo (\r
- IN EFI_PEI_SERVICES **PeiServices,\r
- IN PEI_FLASH_MAP_PPI *This,\r
- IN EFI_FLASH_AREA_TYPE AreaType,\r
- IN EFI_GUID *AreaTypeGuid,\r
- OUT UINT32 *NumEntries,\r
- OUT EFI_FLASH_SUBAREA_ENTRY **Entries\r
- )\r
-/*++\r
-\r
- Routine Description: \r
- Implementation of Flash Map PPI\r
- \r
---*/\r
-// TODO: function comment is missing 'Arguments:'\r
-// TODO: function comment is missing 'Returns:'\r
-// TODO: PeiServices - add argument and description to function comment\r
-// TODO: This - add argument and description to function comment\r
-// TODO: AreaType - add argument and description to function comment\r
-// TODO: AreaTypeGuid - add argument and description to function comment\r
-// TODO: NumEntries - add argument and description to function comment\r
-// TODO: Entries - add argument and description to function comment\r
-// TODO: EFI_SUCCESS - add return value to function comment\r
-// TODO: EFI_NOT_FOUND - add return value to function comment\r
-{\r
- EFI_STATUS Status;\r
- EFI_PEI_HOB_POINTERS Hob;\r
- EFI_HOB_FLASH_MAP_ENTRY_TYPE *FlashMapEntry;\r
-\r
- Status = PeiServicesGetHobList (&Hob.Raw);\r
- while (!END_OF_HOB_LIST (Hob)) {\r
- if (Hob.Header->HobType == EFI_HOB_TYPE_GUID_EXTENSION && CompareGuid (&Hob.Guid->Name, &gEfiFlashMapHobGuid)) {\r
- FlashMapEntry = (EFI_HOB_FLASH_MAP_ENTRY_TYPE *) Hob.Raw;\r
- if (AreaType == FlashMapEntry->AreaType) {\r
- if (AreaType == EFI_FLASH_AREA_GUID_DEFINED) {\r
- if (!CompareGuid (AreaTypeGuid, &FlashMapEntry->AreaTypeGuid)) {\r
- goto NextHob;\r
- }\r
- }\r
-\r
- *NumEntries = FlashMapEntry->NumEntries;\r
- *Entries = FlashMapEntry->Entries;\r
- return EFI_SUCCESS;\r
- }\r
- }\r
- NextHob:\r
- Hob.Raw = GET_NEXT_HOB (Hob);\r
- }\r
-\r
- return EFI_NOT_FOUND;\r
-}\r