8d0fe26cbf
Memory map remapping is a platform specific feature only enabled by some platforms. Instead of keeping this function empty for most platforms, the function has been removed. This feature can easily fit in any other ArmPlatformLib function. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@12632 6f19259b-4bc3-4df7-8a09-765794883524
193 lines
5.0 KiB
C
193 lines
5.0 KiB
C
/** @file
|
|
*
|
|
* Copyright (c) 2011, ARM Limited. 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.
|
|
*
|
|
**/
|
|
|
|
#ifndef _ARMPLATFORMLIB_H_
|
|
#define _ARMPLATFORMLIB_H_
|
|
|
|
//
|
|
// The package level header files this module uses
|
|
//
|
|
#include <PiPei.h>
|
|
//
|
|
// The protocols, PPI and GUID defintions for this module
|
|
//
|
|
#include <Ppi/MasterBootMode.h>
|
|
#include <Ppi/BootInRecoveryMode.h>
|
|
#include <Guid/MemoryTypeInformation.h>
|
|
|
|
#include <Library/ArmLib.h>
|
|
|
|
/**
|
|
This structure is used by ArmVExpressGetEfiMemoryMap to describes a region of the EFI memory map
|
|
|
|
Every EFI regions of the system memory described by their physical start address and their size
|
|
can have different attributes. Some regions can be tested and other untested.
|
|
|
|
**/
|
|
typedef struct {
|
|
EFI_RESOURCE_ATTRIBUTE_TYPE ResourceAttribute;
|
|
EFI_PHYSICAL_ADDRESS PhysicalStart;
|
|
UINT64 NumberOfBytes;
|
|
} ARM_SYSTEM_MEMORY_REGION_DESCRIPTOR;
|
|
|
|
/**
|
|
Initialize the memory where the initial stacks will reside
|
|
|
|
This memory can contain the initial stacks (Secure and Secure Monitor stacks).
|
|
In some platform, this region is already initialized and the implementation of this function can
|
|
do nothing. This memory can also represent the Secure RAM.
|
|
This function is called before the satck has been set up. Its implementation must ensure the stack
|
|
pointer is not used (probably required to use assembly language)
|
|
|
|
**/
|
|
VOID
|
|
ArmPlatformInitializeBootMemory (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Return the current Boot Mode
|
|
|
|
This function returns the boot reason on the platform
|
|
|
|
@return Return the current Boot Mode of the platform
|
|
|
|
**/
|
|
EFI_BOOT_MODE
|
|
ArmPlatformGetBootMode (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Call at the beginning of the platform boot up
|
|
|
|
This function allows the firmware platform to do extra actions at the early
|
|
stage of the platform power up.
|
|
|
|
Note: This function must be implemented in assembler as there is no stack set up yet
|
|
|
|
**/
|
|
VOID
|
|
ArmPlatformSecBootAction (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Initialize controllers that must setup at the early stage
|
|
|
|
Some peripherals must be initialized in Secure World.
|
|
For example, some L2x0 requires to be initialized in Secure World
|
|
|
|
**/
|
|
VOID
|
|
ArmPlatformSecInitialize (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Call before jumping to Normal World
|
|
|
|
This function allows the firmware platform to do extra actions before
|
|
jumping to the Normal World
|
|
|
|
**/
|
|
VOID
|
|
ArmPlatformSecExtraAction (
|
|
IN UINTN MpId,
|
|
OUT UINTN* JumpAddress
|
|
);
|
|
|
|
/**
|
|
Initialize controllers that must setup in the normal world
|
|
|
|
This function is called by the ArmPlatformPkg/PrePi or ArmPlatformPkg/PlatformPei
|
|
in the PEI phase.
|
|
|
|
**/
|
|
VOID
|
|
ArmPlatformNormalInitialize (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Initialize the system (or sometimes called permanent) memory
|
|
|
|
This memory is generally represented by the DRAM.
|
|
|
|
**/
|
|
VOID
|
|
ArmPlatformInitializeSystemMemory (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Initialize the Secure peripherals and memory regions
|
|
|
|
If Trustzone is supported by your platform then this function makes the required initialization
|
|
of the secure peripherals and memory regions.
|
|
|
|
**/
|
|
VOID
|
|
ArmPlatformTrustzoneInit (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Return the Virtual Memory Map of your platform
|
|
|
|
This Virtual Memory Map is used by MemoryInitPei Module to initialize the MMU on your platform.
|
|
|
|
@param[out] VirtualMemoryMap Array of ARM_MEMORY_REGION_DESCRIPTOR describing a Physical-to-
|
|
Virtual Memory mapping. This array must be ended by a zero-filled
|
|
entry
|
|
|
|
**/
|
|
VOID
|
|
ArmPlatformGetVirtualMemoryMap (
|
|
OUT ARM_MEMORY_REGION_DESCRIPTOR** VirtualMemoryMap
|
|
);
|
|
|
|
/**
|
|
Return the EFI Memory Map of your platform
|
|
|
|
This EFI Memory Map of the System Memory is used by MemoryInitPei module to create the Resource
|
|
Descriptor HOBs used by DXE core.
|
|
|
|
@param[out] EfiMemoryMap Array of ARM_SYSTEM_MEMORY_REGION_DESCRIPTOR describing an
|
|
EFI Memory region. This array must be ended by a zero-filled entry
|
|
|
|
**/
|
|
EFI_STATUS
|
|
ArmPlatformGetAdditionalSystemMemory (
|
|
OUT ARM_SYSTEM_MEMORY_REGION_DESCRIPTOR** EfiMemoryMap
|
|
);
|
|
|
|
/**
|
|
Return the Platform specific PPIs
|
|
|
|
This function exposes the Platform Specific PPIs. They can be used by any PrePi modules or passed
|
|
to the PeiCore by PrePeiCore.
|
|
|
|
@param[out] PpiListSize Size in Bytes of the Platform PPI List
|
|
@param[out] PpiList Platform PPI List
|
|
|
|
**/
|
|
VOID
|
|
ArmPlatformGetPlatformPpiList (
|
|
OUT UINTN *PpiListSize,
|
|
OUT EFI_PEI_PPI_DESCRIPTOR **PpiList
|
|
);
|
|
|
|
#endif
|