IntelFrameworkPkg/Include/Protocol/SmmBase.h

   1 /** @file
   2   This file declares SMM Base abstraction protocol.
   3   This protocol is used to install SMM handlers for support of subsequent SMI/PMI activations. This
   4   protocol is available on both IA-32 and Itanium based systems.
   5
   6   The EFI_SMM_BASE_PROTOCOL is a set of services that is exported by a processor device. It is
   7   a required protocol for the platform processor. This protocol can be used in both boot services and
   8   runtime mode. However, only the following member functions need to exist into runtime:
   9   - InSmm()
  10   - Communicate()
  11   This protocol is responsible for registering the handler services. The order in which the handlers are
  12   executed is prescribed only with respect to the MakeLast flag in the RegisterCallback()
  13   service. The driver exports these registration and unregistration services in boot services mode, but
  14   the registered handlers will execute through the preboot and runtime. The only way to change the
  15   behavior of a registered driver after ExitBootServices() has been invoked is to use some
  16   private communication mechanism with the driver to order it to quiesce. This model permits typical
  17   use cases, such as invoking the handler to enter ACPI mode, where the OS loader would make this
  18   call before boot services are terminated. On the other hand, handlers for services such as chipset
  19   workarounds for the century rollover in CMOS should provide commensurate services throughout
  20   preboot and OS runtime.
  21
  22   Copyright (c) 2007, Intel Corporation
  23   All rights reserved. This program and the accompanying materials
  24   are licensed and made available under the terms and conditions of the BSD License
  25   which accompanies this distribution.  The full text of the license may be found at
  26   http://opensource.org/licenses/bsd-license.php
  27
  28   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  29   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  30
  31   @par Revision Reference:
  32   This Protocol is defined in Framework of EFI SMM Core Interface Spec
  33   Version 0.9.
  34
  35 **/
  36
  37 #ifndef _SMM_BASE_H_
  38 #define _SMM_BASE_H_
  39
  40 #include <FrameworkSmm.h>
  41
  42 #define EFI_SMM_BASE_PROTOCOL_GUID \
  43   { \
  44     0x1390954D, 0xda95, 0x4227, {0x93, 0x28, 0x72, 0x82, 0xc2, 0x17, 0xda, 0xa8 } \
  45   }
  46
  47 typedef struct _EFI_SMM_BASE_PROTOCOL             EFI_SMM_BASE_PROTOCOL;
  48
  49 //
  50 // SMM Handler Definition
  51 //
  52 #define EFI_HANDLER_SUCCESS         0x0000
  53 #define EFI_HANDLER_CRITICAL_EXIT   0x0001
  54 #define EFI_HANDLER_SOURCE_QUIESCED 0x0002
  55 #define EFI_HANDLER_SOURCE_PENDING  0x0003
  56
  57 /**
  58   Entry Point to Callback service
  59
  60   @param  SmmImageHandle        A handle allocated by the SMM infrastructure code
  61                                 to uniquely designate a specific DXE SMM driver.
  62   @param  CommunicationBuffer   A pointer to a collection of data in memory
  63                                 that will be conveyed from a non-SMM environment into an SMM environment.
  64                                 The buffer must be contiguous, physically mapped, and be a physical address.
  65   @param  SourceSize            The size of the CommunicationBuffer.
  66
  67   @return Status code
  68
  69 **/
  70 typedef
  71 EFI_STATUS
  72 (EFIAPI *EFI_SMM_CALLBACK_ENTRY_POINT)(
  73   IN EFI_HANDLE             SmmImageHandle,
  74   IN OUT VOID               *CommunicationBuffer OPTIONAL,
  75   IN OUT UINTN              *SourceSize OPTIONAL
  76   );
  77
  78 //
  79 // SMM Base Protocol Definition
  80 //
  81 /**
  82   Register a given driver into SMRAM.This is the equivalent of performing
  83   the LoadImage/StartImage into System Management Mode.
  84
  85   @param  This                  Protocol instance pointer.
  86   @param  FilePath              Location of the image to be installed as the handler.
  87   @param  SourceBuffer          Optional source buffer in case of the image file
  88                                 being in memory.
  89   @param  SourceSize            Size of the source image file, if in memory.
  90   @param  ImageHandle           The handle that the base driver uses to decode
  91                                 the handler. Unique among SMM handlers only,
  92                                 not unique across DXE/EFI.
  93   @param  LegacyIA32Binary      An optional parameter that details that the associated
  94                                 file is a real-mode IA-32 binary.
  95
  96   @retval EFI_SUCCESS           The operation was successful.
  97   @retval EFI_OUT_OF_RESOURCES  There were no additional SMRAM resources to load the handler
  98   @retval EFI_UNSUPPORTED       This platform does not support 16-bit handlers.
  99   @retval EFI_UNSUPPORTED       In runtime.
 100   @retval EFI_INVALID_PARAMETER The handlers was not the correct image type
 101
 102 **/
 103 typedef
 104 EFI_STATUS
 105 (EFIAPI *EFI_SMM_REGISTER_HANDLER)(
 106   IN EFI_SMM_BASE_PROTOCOL                           *This,
 107   IN  EFI_DEVICE_PATH_PROTOCOL                       *FilePath,
 108   IN  VOID                                           *SourceBuffer OPTIONAL,
 109   IN  UINTN                                          SourceSize,
 110   OUT EFI_HANDLE                                     *ImageHandle,
 111   IN  BOOLEAN                                        LegacyIA32Binary OPTIONAL
 112   );
 113
 114 /**
 115   Removes a handler from execution within SMRAM.  This is the equivalent of performing
 116   the UnloadImage in System Management Mode.
 117
 118   @param  This                  Protocol instance pointer.
 119   @param  ImageHandle           The handler to be removed.
 120
 121   @retval EFI_SUCCESS           The operation was successful
 122   @retval EFI_INVALID_PARAMETER The handler did not exist
 123   @retval EFI_UNSUPPORTED       In runtime.
 124
 125 **/
 126 typedef
 127 EFI_STATUS
 128 (EFIAPI *EFI_SMM_UNREGISTER_HANDLER)(
 129   IN EFI_SMM_BASE_PROTOCOL          *This,
 130   IN EFI_HANDLE                     ImageHandle
 131   );
 132
 133 /**
 134   The SMM Inter-module Communicate Service Communicate() function
 135   provides a services to send/received messages from a registered
 136   EFI service.  The BASE protocol driver is responsible for doing
 137   any of the copies such that the data lives in boot-service-accessible RAM.
 138
 139   @param  This                  Protocol instance pointer.
 140   @param  ImageHandle           The handle of the registered driver.
 141   @param  CommunicationBuffer   Pointer to the buffer to convey into SMRAM.
 142   @param  SourceSize            The size of the data buffer being passed in.
 143
 144   @retval EFI_SUCCESS           The message was successfully posted
 145   @retval EFI_INVALID_PARAMETER The buffer was NULL
 146
 147 **/
 148 typedef
 149 EFI_STATUS
 150 (EFIAPI *EFI_SMM_COMMUNICATE)(
 151   IN EFI_SMM_BASE_PROTOCOL          *This,
 152   IN EFI_HANDLE                     ImageHandle,
 153   IN OUT VOID                       *CommunicationBuffer,
 154   IN OUT UINTN                      *SourceSize
 155   );
 156
 157 /**
 158   Register a callback to execute within SMM.
 159   This allows receipt of messages created with EFI_SMM_BASE_PROTOCOL.Communicate().
 160
 161   @param  This                  Protocol instance pointer.
 162   @param  SmmImageHandle        Handle of the callback service.
 163   @param  CallbackAddress       Address of the callback service.
 164   @param  MakeLast              If present, will stipulate that the handler is posted to
 165                                 be executed last in the dispatch table.
 166   @param  FloatingPointSave     This is an optional parameter which informs the
 167                                 EFI_SMM_ACCESS_PROTOCOL Driver core if it needs to save
 168                                 the floating point register state. If any of the handlers
 169                                 require this, then the state will be saved for all of the handlers.
 170
 171   @retval EFI_SUCCESS           The operation was successful
 172   @retval EFI_OUT_OF_RESOURCES  Not enough space in the dispatch queue
 173   @retval EFI_UNSUPPORTED       In runtime.
 174   @retval EFI_UNSUPPORTED       The caller is not in SMM.
 175
 176 **/
 177 typedef
 178 EFI_STATUS
 179 (EFIAPI *EFI_SMM_CALLBACK_SERVICE)(
 180   IN EFI_SMM_BASE_PROTOCOL                            *This,
 181   IN EFI_HANDLE                                       SmmImageHandle,
 182   IN EFI_SMM_CALLBACK_ENTRY_POINT                     CallbackAddress,
 183   IN BOOLEAN                                          MakeLast OPTIONAL,
 184   IN BOOLEAN                                          FloatingPointSave OPTIONAL
 185   );
 186
 187 /**
 188   The SmmAllocatePool() function allocates a memory region of Size bytes from memory of
 189   type PoolType and returns the address of the allocated memory in the location referenced
 190   by Buffer.  This function allocates pages from EFI SMRAM Memory as needed to grow the
 191   requested pool type.  All allocations are eight-byte aligned.
 192
 193   @param  This                  Protocol instance pointer.
 194   @param  PoolType              The type of pool to allocate.
 195                                 The only supported type is EfiRuntimeServicesData;
 196                                 the interface will internally map this runtime request to
 197                                 SMRAM for IA-32 and leave as this type for the Itanium
 198                                 processor family. Other types can be ignored.
 199   @param  Size                  The number of bytes to allocate from the pool.
 200   @param  Buffer                A pointer to a pointer to the allocated buffer if the call
 201                                 succeeds; undefined otherwise.
 202
 203   @retval EFI_SUCCESS           The requested number of bytes was allocated.
 204   @retval EFI_OUT_OF_RESOURCES  The pool requested could not be allocated.
 205   @retval EFI_INVALID_PARAMETER PoolType was invalid.
 206   @retval EFI_UNSUPPORTED       In runtime.
 207
 208 **/
 209 typedef
 210 EFI_STATUS
 211 (EFIAPI *EFI_SMM_ALLOCATE_POOL)(
 212   IN EFI_SMM_BASE_PROTOCOL          *This,
 213   IN EFI_MEMORY_TYPE                PoolType,
 214   IN UINTN                          Size,
 215   OUT VOID                          **Buffer
 216   );
 217
 218 /**
 219   The SmmFreePool() function returns the memory specified by Buffer to the system.
 220   On return, the memory's type is EFI SMRAM Memory.  The Buffer that is freed must
 221   have been allocated by SmmAllocatePool().
 222
 223   @param  This                  Protocol instance pointer.
 224   @param  Buffer                Pointer to the buffer allocation.
 225
 226   @retval EFI_SUCCESS           The memory was returned to the system.
 227   @retval EFI_INVALID_PARAMETER Buffer was invalid.
 228   @retval EFI_UNSUPPORTED       In runtime.
 229
 230 **/
 231 typedef
 232 EFI_STATUS
 233 (EFIAPI *EFI_SMM_FREE_POOL)(
 234   IN EFI_SMM_BASE_PROTOCOL          *This,
 235   IN VOID                           *Buffer
 236   );
 237
 238 /**
 239   This routine tells caller if execution context is SMM or not.
 240
 241   @param  This                  Protocol instance pointer.
 242   @param  InSmm                 Whether the caller is inside SMM for IA-32 or servicing a PMI for the Itanium processor family.
 243
 244   @retval EFI_SUCCESS           The operation was successful
 245
 246 **/
 247 typedef
 248 EFI_STATUS
 249 (EFIAPI *EFI_SMM_INSIDE_OUT)(
 250   IN EFI_SMM_BASE_PROTOCOL          *This,
 251   OUT BOOLEAN                       *InSmm
 252   );
 253
 254 /**
 255   The GetSmstLocation() function returns the locatin of the System Management
 256   Service Table.  The use of the API is such that a driver can discover the
 257   location of the SMST in its entry point and then cache it in some driver
 258   global variable so that the SMST can be invoked in subsequent callbacks.
 259
 260   @param  This                  Protocol instance pointer.
 261   @param  Smst                  Pointer to the SMST.
 262
 263   @retval EFI_SUCCESS           The operation was successful
 264   @retval EFI_INVALID_PARAMETER Smst was invalid.
 265   @retval EFI_UNSUPPORTED       Not in SMM.
 266
 267 **/
 268 typedef
 269 EFI_STATUS
 270 (EFIAPI *EFI_SMM_GET_SMST_LOCATION)(
 271   IN EFI_SMM_BASE_PROTOCOL          *This,
 272   IN OUT EFI_SMM_SYSTEM_TABLE       **Smst
 273   );
 274
 275 /**
 276   @par Protocol Description:
 277   This protocol is used to install SMM handlers for support of subsequent SMI/PMI
 278   activations. This protocol is available on both IA-32 and Itanium-based systems.
 279
 280   @param Register
 281   Registers a handler to run in System Management RAM (SMRAM).
 282
 283   @param UnRegister
 284   Removes a handler from execution in SMRAM.
 285
 286   @param Communicate
 287   Sends/receives a message for a registered handler.
 288
 289   @param RegisterCallback
 290   Registers a callback from the constructor.
 291
 292   @param InSmm
 293   Detects whether the caller is inside or outside of SMM. SName
 294
 295   @param SmmAllocatePool
 296   Allocates SMRAM.
 297
 298   @param SmmFreePool
 299   Deallocates SMRAM.
 300
 301   @param GetSmstLocation
 302   Retrieves the location of the System Management System Table (SMST).
 303
 304 **/
 305 struct _EFI_SMM_BASE_PROTOCOL {
 306   EFI_SMM_REGISTER_HANDLER    Register;
 307   EFI_SMM_UNREGISTER_HANDLER  UnRegister;
 308   EFI_SMM_COMMUNICATE         Communicate;
 309   EFI_SMM_CALLBACK_SERVICE    RegisterCallback;
 310   EFI_SMM_INSIDE_OUT          InSmm;
 311   EFI_SMM_ALLOCATE_POOL       SmmAllocatePool;
 312   EFI_SMM_FREE_POOL           SmmFreePool;
 313   EFI_SMM_GET_SMST_LOCATION   GetSmstLocation;
 314 };
 315
 316 extern EFI_GUID gEfiSmmBaseProtocolGuid;
 317
 318 #endif