ArmPkg/Drivers/CpuDxe/CpuDxe.h

   1 /** @file
   2
   3   Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
   4   Copyright (c) 2011 - 2013, ARM Ltd. All rights reserved.<BR>
   5
   6   This program and the accompanying materials
   7   are licensed and made available under the terms and conditions of the BSD License
   8   which accompanies this distribution.  The full text of the license may be found at
   9   http://opensource.org/licenses/bsd-license.php
  10
  11   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef __CPU_DXE_ARM_EXCEPTION_H__
  17 #define __CPU_DXE_ARM_EXCEPTION_H__
  18
  19 #include <Uefi.h>
  20
  21 #include <Library/ArmLib.h>
  22 #include <Library/BaseMemoryLib.h>
  23 #include <Library/DebugLib.h>
  24 #include <Library/PcdLib.h>
  25 #include <Library/UefiBootServicesTableLib.h>
  26 #include <Library/DxeServicesTableLib.h>
  27 #include <Library/CacheMaintenanceLib.h>
  28 #include <Library/PeCoffGetEntryPointLib.h>
  29 #include <Library/UefiLib.h>
  30 #include <Library/CpuLib.h>
  31 #include <Library/DefaultExceptionHandlerLib.h>
  32 #include <Library/DebugLib.h>
  33
  34 #include <Guid/DebugImageInfoTable.h>
  35 #include <Protocol/Cpu.h>
  36 #include <Protocol/DebugSupport.h>
  37 #include <Protocol/DebugSupportPeriodicCallback.h>
  38 #include <Protocol/LoadedImage.h>
  39
  40 extern BOOLEAN mIsFlushingGCD;
  41
  42 /**
  43   This function registers and enables the handler specified by InterruptHandler for a processor
  44   interrupt or exception type specified by InterruptType. If InterruptHandler is NULL, then the
  45   handler for the processor interrupt or exception type specified by InterruptType is uninstalled.
  46   The installed handler is called once for each processor interrupt or exception.
  47
  48   @param  InterruptType    A pointer to the processor's current interrupt state. Set to TRUE if interrupts
  49                            are enabled and FALSE if interrupts are disabled.
  50   @param  InterruptHandler A pointer to a function of type EFI_CPU_INTERRUPT_HANDLER that is called
  51                            when a processor interrupt occurs. If this parameter is NULL, then the handler
  52                            will be uninstalled.
  53
  54   @retval EFI_SUCCESS           The handler for the processor interrupt was successfully installed or uninstalled.
  55   @retval EFI_ALREADY_STARTED   InterruptHandler is not NULL, and a handler for InterruptType was
  56                                 previously installed.
  57   @retval EFI_INVALID_PARAMETER InterruptHandler is NULL, and a handler for InterruptType was not
  58                                 previously installed.
  59   @retval EFI_UNSUPPORTED       The interrupt specified by InterruptType is not supported.
  60
  61 **/
  62 EFI_STATUS
  63 RegisterInterruptHandler (
  64   IN EFI_EXCEPTION_TYPE             InterruptType,
  65   IN EFI_CPU_INTERRUPT_HANDLER      InterruptHandler
  66   );
  67
  68
  69 /**
  70   This function registers and enables the handler specified by InterruptHandler for a processor
  71   interrupt or exception type specified by InterruptType. If InterruptHandler is NULL, then the
  72   handler for the processor interrupt or exception type specified by InterruptType is uninstalled.
  73   The installed handler is called once for each processor interrupt or exception.
  74
  75   @param  InterruptType    A pointer to the processor's current interrupt state. Set to TRUE if interrupts
  76                            are enabled and FALSE if interrupts are disabled.
  77   @param  InterruptHandler A pointer to a function of type EFI_CPU_INTERRUPT_HANDLER that is called
  78                            when a processor interrupt occurs. If this parameter is NULL, then the handler
  79                            will be uninstalled.
  80
  81   @retval EFI_SUCCESS           The handler for the processor interrupt was successfully installed or uninstalled.
  82   @retval EFI_ALREADY_STARTED   InterruptHandler is not NULL, and a handler for InterruptType was
  83                                 previously installed.
  84   @retval EFI_INVALID_PARAMETER InterruptHandler is NULL, and a handler for InterruptType was not
  85                                 previously installed.
  86   @retval EFI_UNSUPPORTED       The interrupt specified by InterruptType is not supported.
  87
  88 **/
  89 EFI_STATUS
  90 RegisterDebuggerInterruptHandler (
  91   IN EFI_EXCEPTION_TYPE             InterruptType,
  92   IN EFI_CPU_INTERRUPT_HANDLER      InterruptHandler
  93   );
  94
  95
  96 EFI_STATUS
  97 EFIAPI
  98 CpuSetMemoryAttributes (
  99   IN EFI_CPU_ARCH_PROTOCOL     *This,
 100   IN EFI_PHYSICAL_ADDRESS      BaseAddress,
 101   IN UINT64                    Length,
 102   IN UINT64                    Attributes
 103   );
 104
 105 EFI_STATUS
 106 InitializeExceptions (
 107   IN EFI_CPU_ARCH_PROTOCOL    *Cpu
 108   );
 109
 110 EFI_STATUS
 111 SyncCacheConfig (
 112   IN  EFI_CPU_ARCH_PROTOCOL *CpuProtocol
 113   );
 114
 115 EFI_STATUS
 116 ConvertSectionToPages (
 117   IN EFI_PHYSICAL_ADDRESS  BaseAddress
 118   );
 119
 120 /**
 121  * Publish ARM Processor Data table in UEFI SYSTEM Table.
 122  * @param  HobStart               Pointer to the beginning of the HOB List from PEI.
 123  *
 124  * Description : This function iterates through HOB list and finds ARM processor Table Entry HOB.
 125  *               If  the ARM processor Table Entry HOB is found, the HOB data is copied to run-time memory
 126  *               and a pointer is assigned to it in ARM processor table. Then the ARM processor table is
 127  *               installed in EFI configuration table.
 128 **/
 129 VOID
 130 EFIAPI
 131 PublishArmProcessorTable(
 132   VOID
 133   );
 134
 135 EFI_STATUS
 136 SetMemoryAttributes (
 137   IN EFI_PHYSICAL_ADDRESS      BaseAddress,
 138   IN UINT64                    Length,
 139   IN UINT64                    Attributes,
 140   IN EFI_PHYSICAL_ADDRESS      VirtualMask
 141   );
 142
 143 // The ARM Attributes might be defined on 64-bit (case of the long format description table)
 144 UINT64
 145 EfiAttributeToArmAttribute (
 146   IN UINT64                    EfiAttributes
 147   );
 148
 149 EFI_STATUS
 150 GetMemoryRegion (
 151   IN OUT UINTN                   *BaseAddress,
 152   OUT    UINTN                   *RegionLength,
 153   OUT    UINTN                   *RegionAttributes
 154   );
 155
 156 VOID
 157 GetRootTranslationTableInfo (
 158   IN  UINTN    T0SZ,
 159   OUT UINTN   *TableLevel,
 160   OUT UINTN   *TableEntryCount
 161   );
 162
 163 EFI_STATUS
 164 SetGcdMemorySpaceAttributes (
 165   IN EFI_GCD_MEMORY_SPACE_DESCRIPTOR    *MemorySpaceMap,
 166   IN UINTN                               NumberOfDescriptors,
 167   IN EFI_PHYSICAL_ADDRESS                BaseAddress,
 168   IN UINT64                              Length,
 169   IN UINT64                              Attributes
 170   );
 171
 172 #endif // __CPU_DXE_ARM_EXCEPTION_H__