MdePkg/Include/Protocol/Cpu.h

   1 /** @file
   2   CPU Architectural Protocol as defined in PI spec Volume 2 DXE
   3
   4   This code abstracts the DXE core from processor implementation details.
   5
   6   Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
   7   SPDX-License-Identifier: BSD-2-Clause-Patent
   8
   9 **/
  10
  11 #ifndef __ARCH_PROTOCOL_CPU_H__
  12 #define __ARCH_PROTOCOL_CPU_H__
  13
  14 #include <Protocol/DebugSupport.h>
  15
  16 #define EFI_CPU_ARCH_PROTOCOL_GUID \
  17   { 0x26baccb1, 0x6f42, 0x11d4, {0xbc, 0xe7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } }
  18
  19 typedef struct _EFI_CPU_ARCH_PROTOCOL   EFI_CPU_ARCH_PROTOCOL;
  20
  21 ///
  22 /// The type of flush operation
  23 ///
  24 typedef enum {
  25   EfiCpuFlushTypeWriteBackInvalidate,
  26   EfiCpuFlushTypeWriteBack,
  27   EfiCpuFlushTypeInvalidate,
  28   EfiCpuMaxFlushType
  29 } EFI_CPU_FLUSH_TYPE;
  30
  31 ///
  32 /// The type of processor INIT.
  33 ///
  34 typedef enum {
  35   EfiCpuInit,
  36   EfiCpuMaxInitType
  37 } EFI_CPU_INIT_TYPE;
  38
  39 /**
  40   EFI_CPU_INTERRUPT_HANDLER that is called when a processor interrupt occurs.
  41
  42   @param  InterruptType    Defines the type of interrupt or exception that
  43                            occurred on the processor.This parameter is processor architecture specific.
  44   @param  SystemContext    A pointer to the processor context when
  45                            the interrupt occurred on the processor.
  46
  47   @return None
  48
  49 **/
  50 typedef
  51 VOID
  52 (EFIAPI *EFI_CPU_INTERRUPT_HANDLER)(
  53   IN CONST  EFI_EXCEPTION_TYPE  InterruptType,
  54   IN CONST  EFI_SYSTEM_CONTEXT  SystemContext
  55   );
  56
  57 /**
  58   This function flushes the range of addresses from Start to Start+Length
  59   from the processor's data cache. If Start is not aligned to a cache line
  60   boundary, then the bytes before Start to the preceding cache line boundary
  61   are also flushed. If Start+Length is not aligned to a cache line boundary,
  62   then the bytes past Start+Length to the end of the next cache line boundary
  63   are also flushed. The FlushType of EfiCpuFlushTypeWriteBackInvalidate must be
  64   supported. If the data cache is fully coherent with all DMA operations, then
  65   this function can just return EFI_SUCCESS. If the processor does not support
  66   flushing a range of the data cache, then the entire data cache can be flushed.
  67
  68   @param  This             The EFI_CPU_ARCH_PROTOCOL instance.
  69   @param  Start            The beginning physical address to flush from the processor's data
  70                            cache.
  71   @param  Length           The number of bytes to flush from the processor's data cache. This
  72                            function may flush more bytes than Length specifies depending upon
  73                            the granularity of the flush operation that the processor supports.
  74   @param  FlushType        Specifies the type of flush operation to perform.
  75
  76   @retval EFI_SUCCESS           The address range from Start to Start+Length was flushed from
  77                                 the processor's data cache.
  78   @retval EFI_UNSUPPORTED       The processor does not support the cache flush type specified
  79                                 by FlushType.
  80   @retval EFI_DEVICE_ERROR      The address range from Start to Start+Length could not be flushed
  81                                 from the processor's data cache.
  82
  83 **/
  84 typedef
  85 EFI_STATUS
  86 (EFIAPI *EFI_CPU_FLUSH_DATA_CACHE)(
  87   IN EFI_CPU_ARCH_PROTOCOL              *This,
  88   IN EFI_PHYSICAL_ADDRESS               Start,
  89   IN UINT64                             Length,
  90   IN EFI_CPU_FLUSH_TYPE                 FlushType
  91   );
  92
  93
  94 /**
  95   This function enables interrupt processing by the processor.
  96
  97   @param  This             The EFI_CPU_ARCH_PROTOCOL instance.
  98
  99   @retval EFI_SUCCESS           Interrupts are enabled on the processor.
 100   @retval EFI_DEVICE_ERROR      Interrupts could not be enabled on the processor.
 101
 102 **/
 103 typedef
 104 EFI_STATUS
 105 (EFIAPI *EFI_CPU_ENABLE_INTERRUPT)(
 106   IN EFI_CPU_ARCH_PROTOCOL              *This
 107   );
 108
 109
 110 /**
 111   This function disables interrupt processing by the processor.
 112
 113   @param  This             The EFI_CPU_ARCH_PROTOCOL instance.
 114
 115   @retval EFI_SUCCESS           Interrupts are disabled on the processor.
 116   @retval EFI_DEVICE_ERROR      Interrupts could not be disabled on the processor.
 117
 118 **/
 119 typedef
 120 EFI_STATUS
 121 (EFIAPI *EFI_CPU_DISABLE_INTERRUPT)(
 122   IN EFI_CPU_ARCH_PROTOCOL              *This
 123   );
 124
 125
 126 /**
 127   This function retrieves the processor's current interrupt state a returns it in
 128   State. If interrupts are currently enabled, then TRUE is returned. If interrupts
 129   are currently disabled, then FALSE is returned.
 130
 131   @param  This             The EFI_CPU_ARCH_PROTOCOL instance.
 132   @param  State            A pointer to the processor's current interrupt state. Set to TRUE if
 133                            interrupts are enabled and FALSE if interrupts are disabled.
 134
 135   @retval EFI_SUCCESS           The processor's current interrupt state was returned in State.
 136   @retval EFI_INVALID_PARAMETER State is NULL.
 137
 138 **/
 139 typedef
 140 EFI_STATUS
 141 (EFIAPI *EFI_CPU_GET_INTERRUPT_STATE)(
 142   IN EFI_CPU_ARCH_PROTOCOL              *This,
 143   OUT BOOLEAN                           *State
 144   );
 145
 146
 147 /**
 148   This function generates an INIT on the processor. If this function succeeds, then the
 149   processor will be reset, and control will not be returned to the caller. If InitType is
 150   not supported by this processor, or the processor cannot programmatically generate an
 151   INIT without help from external hardware, then EFI_UNSUPPORTED is returned. If an error
 152   occurs attempting to generate an INIT, then EFI_DEVICE_ERROR is returned.
 153
 154   @param  This             The EFI_CPU_ARCH_PROTOCOL instance.
 155   @param  InitType         The type of processor INIT to perform.
 156
 157   @retval EFI_SUCCESS           The processor INIT was performed. This return code should never be seen.
 158   @retval EFI_UNSUPPORTED       The processor INIT operation specified by InitType is not supported
 159                                 by this processor.
 160   @retval EFI_DEVICE_ERROR      The processor INIT failed.
 161
 162 **/
 163 typedef
 164 EFI_STATUS
 165 (EFIAPI *EFI_CPU_INIT)(
 166   IN EFI_CPU_ARCH_PROTOCOL              *This,
 167   IN EFI_CPU_INIT_TYPE                  InitType
 168   );
 169
 170
 171 /**
 172   This function registers and enables the handler specified by InterruptHandler for a processor
 173   interrupt or exception type specified by InterruptType. If InterruptHandler is NULL, then the
 174   handler for the processor interrupt or exception type specified by InterruptType is uninstalled.
 175   The installed handler is called once for each processor interrupt or exception.
 176
 177   @param  This             The EFI_CPU_ARCH_PROTOCOL instance.
 178   @param  InterruptType    A pointer to the processor's current interrupt state. Set to TRUE if interrupts
 179                            are enabled and FALSE if interrupts are disabled.
 180   @param  InterruptHandler A pointer to a function of type EFI_CPU_INTERRUPT_HANDLER that is called
 181                            when a processor interrupt occurs. If this parameter is NULL, then the handler
 182                            will be uninstalled.
 183
 184   @retval EFI_SUCCESS           The handler for the processor interrupt was successfully installed or uninstalled.
 185   @retval EFI_ALREADY_STARTED   InterruptHandler is not NULL, and a handler for InterruptType was
 186                                 previously installed.
 187   @retval EFI_INVALID_PARAMETER InterruptHandler is NULL, and a handler for InterruptType was not
 188                                 previously installed.
 189   @retval EFI_UNSUPPORTED       The interrupt specified by InterruptType is not supported.
 190
 191 **/
 192 typedef
 193 EFI_STATUS
 194 (EFIAPI *EFI_CPU_REGISTER_INTERRUPT_HANDLER)(
 195   IN EFI_CPU_ARCH_PROTOCOL              *This,
 196   IN EFI_EXCEPTION_TYPE                 InterruptType,
 197   IN EFI_CPU_INTERRUPT_HANDLER          InterruptHandler
 198   );
 199
 200
 201 /**
 202   This function reads the processor timer specified by TimerIndex and returns it in TimerValue.
 203
 204   @param  This             The EFI_CPU_ARCH_PROTOCOL instance.
 205   @param  TimerIndex       Specifies which processor timer is to be returned in TimerValue. This parameter
 206                            must be between 0 and NumberOfTimers-1.
 207   @param  TimerValue       Pointer to the returned timer value.
 208   @param  TimerPeriod      A pointer to the amount of time that passes in femtoseconds for each increment
 209                            of TimerValue. If TimerValue does not increment at a predictable rate, then 0 is
 210                            returned. This parameter is optional and may be NULL.
 211
 212   @retval EFI_SUCCESS           The processor timer value specified by TimerIndex was returned in TimerValue.
 213   @retval EFI_DEVICE_ERROR      An error occurred attempting to read one of the processor's timers.
 214   @retval EFI_INVALID_PARAMETER TimerValue is NULL or TimerIndex is not valid.
 215   @retval EFI_UNSUPPORTED       The processor does not have any readable timers.
 216
 217 **/
 218 typedef
 219 EFI_STATUS
 220 (EFIAPI *EFI_CPU_GET_TIMER_VALUE)(
 221   IN EFI_CPU_ARCH_PROTOCOL              *This,
 222   IN UINT32                             TimerIndex,
 223   OUT UINT64                            *TimerValue,
 224   OUT UINT64                            *TimerPeriod OPTIONAL
 225   );
 226
 227
 228 /**
 229   This function modifies the attributes for the memory region specified by BaseAddress and
 230   Length from their current attributes to the attributes specified by Attributes.
 231
 232   @param  This             The EFI_CPU_ARCH_PROTOCOL instance.
 233   @param  BaseAddress      The physical address that is the start address of a memory region.
 234   @param  Length           The size in bytes of the memory region.
 235   @param  Attributes       The bit mask of attributes to set for the memory region.
 236
 237   @retval EFI_SUCCESS           The attributes were set for the memory region.
 238   @retval EFI_ACCESS_DENIED     The attributes for the memory resource range specified by
 239                                 BaseAddress and Length cannot be modified.
 240   @retval EFI_INVALID_PARAMETER Length is zero.
 241                                 Attributes specified an illegal combination of attributes that
 242                                 cannot be set together.
 243   @retval EFI_OUT_OF_RESOURCES  There are not enough system resources to modify the attributes of
 244                                 the memory resource range.
 245   @retval EFI_UNSUPPORTED       The processor does not support one or more bytes of the memory
 246                                 resource range specified by BaseAddress and Length.
 247                                 The bit mask of attributes is not support for the memory resource
 248                                 range specified by BaseAddress and Length.
 249
 250 **/
 251 typedef
 252 EFI_STATUS
 253 (EFIAPI *EFI_CPU_SET_MEMORY_ATTRIBUTES)(
 254   IN EFI_CPU_ARCH_PROTOCOL              *This,
 255   IN  EFI_PHYSICAL_ADDRESS              BaseAddress,
 256   IN  UINT64                            Length,
 257   IN  UINT64                            Attributes
 258   );
 259
 260
 261 ///
 262 /// The EFI_CPU_ARCH_PROTOCOL is used to abstract processor-specific functions from the DXE
 263 /// Foundation. This includes flushing caches, enabling and disabling interrupts, hooking interrupt
 264 /// vectors and exception vectors, reading internal processor timers, resetting the processor, and
 265 /// determining the processor frequency.
 266 ///
 267 struct _EFI_CPU_ARCH_PROTOCOL {
 268   EFI_CPU_FLUSH_DATA_CACHE            FlushDataCache;
 269   EFI_CPU_ENABLE_INTERRUPT            EnableInterrupt;
 270   EFI_CPU_DISABLE_INTERRUPT           DisableInterrupt;
 271   EFI_CPU_GET_INTERRUPT_STATE         GetInterruptState;
 272   EFI_CPU_INIT                        Init;
 273   EFI_CPU_REGISTER_INTERRUPT_HANDLER  RegisterInterruptHandler;
 274   EFI_CPU_GET_TIMER_VALUE             GetTimerValue;
 275   EFI_CPU_SET_MEMORY_ATTRIBUTES       SetMemoryAttributes;
 276   ///
 277   /// The number of timers that are available in a processor. The value in this
 278   /// field is a constant that must not be modified after the CPU Architectural
 279   /// Protocol is installed. All consumers must treat this as a read-only field.
 280   ///
 281   UINT32                              NumberOfTimers;
 282   ///
 283   /// The size, in bytes, of the alignment required for DMA buffer allocations.
 284   /// This is typically the size of the largest data cache line in the platform.
 285   /// The value in this field is a constant that must not be modified after the
 286   /// CPU Architectural Protocol is installed. All consumers must treat this as
 287   /// a read-only field.
 288   ///
 289   UINT32                              DmaBufferAlignment;
 290 };
 291
 292 extern EFI_GUID gEfiCpuArchProtocolGuid;
 293
 294 #endif