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 during 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 - 2009, 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 //
  41 // Share some common definitions with PI SMM
  42 //
  43 #include <Framework/SmmCis.h>
  44 #include <Protocol/SmmCommunication.h>
  45
  46 ///
  47 /// Global ID for the EFI_SMM_BASE_PROTOCOL
  48 ///
  49 #define EFI_SMM_BASE_PROTOCOL_GUID \
  50   { \
  51     0x1390954D, 0xda95, 0x4227, {0x93, 0x28, 0x72, 0x82, 0xc2, 0x17, 0xda, 0xa8 } \
  52   }
  53
  54 ///
  55 /// Forward declaration for EFI_SMM_BASE_PROTOCOL
  56 ///
  57 typedef struct _EFI_SMM_BASE_PROTOCOL  EFI_SMM_BASE_PROTOCOL;
  58
  59 ///
  60 /// EFI SMM Handler return codes
  61 ///
  62 ///@{
  63 #define EFI_HANDLER_SUCCESS         0x0000
  64 #define EFI_HANDLER_CRITICAL_EXIT   0x0001
  65 #define EFI_HANDLER_SOURCE_QUIESCED 0x0002
  66 #define EFI_HANDLER_SOURCE_PENDING  0x0003
  67 ///@}
  68
  69 /**
  70   Entry Point to Callback service
  71
  72   @param[in]  SmmImageHandle        A handle allocated by the SMM infrastructure code
  73                                     to uniquely designate a specific DXE SMM driver.
  74   @param[in]  CommunicationBuffer   A pointer to a collection of data in memory
  75                                     that will be conveyed from a non-SMM environment into an SMM environment.
  76                                     The buffer must be contiguous and physically mapped, and must be a physical address.
  77   @param[in]  SourceSize            The size of the CommunicationBuffer.
  78
  79   @return     Status code
  80
  81 **/
  82 typedef
  83 EFI_STATUS
  84 (EFIAPI *EFI_SMM_CALLBACK_ENTRY_POINT)(
  85   IN EFI_HANDLE             SmmImageHandle,
  86   IN OUT VOID               *CommunicationBuffer OPTIONAL,
  87   IN OUT UINTN              *SourceSize OPTIONAL
  88   );
  89
  90 //
  91 // SMM Base Protocol Definition
  92 //
  93 /**
  94   Register a given driver into SMRAM. This is the equivalent of performing
  95   the LoadImage/StartImage into System Management Mode.
  96
  97   @param[in]   This                  Protocol instance pointer.
  98   @param[in]   FilePath              Location of the image to be installed as the handler.
  99   @param[in]   SourceBuffer          Optional source buffer in case the image file
 100                                      is in memory.
 101   @param[in]   SourceSize            Size of the source image file, if in memory.
 102   @param[out]  ImageHandle           The handle that the base driver uses to decode
 103                                      the handler. Unique among SMM handlers only,
 104                                      not unique across DXE/EFI.
 105   @param[in]   LegacyIA32Binary      An optional parameter specifying that the associated
 106                                      file is a real-mode IA-32 binary.
 107
 108   @retval      EFI_SUCCESS           The operation was successful.
 109   @retval      EFI_OUT_OF_RESOURCES  There were no additional SMRAM resources to load the handler
 110   @retval      EFI_UNSUPPORTED       This platform does not support 16-bit handlers.
 111   @retval      EFI_UNSUPPORTED       Platform is in runtime.
 112   @retval      EFI_INVALID_PARAMETER The handlers was not the correct image type
 113
 114 **/
 115 typedef
 116 EFI_STATUS
 117 (EFIAPI *EFI_SMM_REGISTER_HANDLER)(
 118   IN  EFI_SMM_BASE_PROTOCOL                          *This,
 119   IN  EFI_DEVICE_PATH_PROTOCOL                       *FilePath,
 120   IN  VOID                                           *SourceBuffer OPTIONAL,
 121   IN  UINTN                                          SourceSize,
 122   OUT EFI_HANDLE                                     *ImageHandle,
 123   IN  BOOLEAN                                        LegacyIA32Binary OPTIONAL
 124   );
 125
 126 /**
 127   Removes a handler from execution within SMRAM.  This is the equivalent of performing
 128   the UnloadImage in System Management Mode.
 129
 130   @param[in]  This                  Protocol instance pointer.
 131   @param[in]  ImageHandle           The handler to be removed.
 132
 133   @retval     EFI_SUCCESS           The operation was successful
 134   @retval     EFI_INVALID_PARAMETER The handler did not exist
 135   @retval     EFI_UNSUPPORTED       Platform is in runtime.
 136
 137 **/
 138 typedef
 139 EFI_STATUS
 140 (EFIAPI *EFI_SMM_UNREGISTER_HANDLER)(
 141   IN EFI_SMM_BASE_PROTOCOL          *This,
 142   IN EFI_HANDLE                     ImageHandle
 143   );
 144
 145 /**
 146   The SMM Inter-module Communicate Service Communicate() function
 147   provides a service to send/receive messages from a registered
 148   EFI service.  The BASE protocol driver is responsible for doing
 149   any of the copies such that the data lives in boot-service-accessible RAM.
 150
 151   @param[in]      This                  Protocol instance pointer.
 152   @param[in]      ImageHandle           The handle of the registered driver.
 153   @param[in,out]  CommunicationBuffer   Pointer to the buffer to convey into SMRAM.
 154   @param[in,out]  SourceSize            The size of the data buffer being passed in.
 155                                         On exit, the size of data being returned.
 156                                         Zero if the handler does not wish to reply with any data.
 157
 158   @retval         EFI_SUCCESS           The message was successfully posted
 159   @retval         EFI_INVALID_PARAMETER The buffer was NULL
 160
 161 **/
 162 typedef
 163 EFI_STATUS
 164 (EFIAPI *EFI_SMM_COMMUNICATE)(
 165   IN EFI_SMM_BASE_PROTOCOL          *This,
 166   IN EFI_HANDLE                     ImageHandle,
 167   IN OUT VOID                       *CommunicationBuffer,
 168   IN OUT UINTN                      *SourceSize
 169   );
 170
 171 /**
 172   Register a callback to execute within SMM.
 173   This allows receipt of messages created with EFI_SMM_BASE_PROTOCOL.Communicate().
 174
 175   @param[in]  This                  Protocol instance pointer.
 176   @param[in]  SmmImageHandle        Handle of the callback service.
 177   @param[in]  CallbackAddress       Address of the callback service.
 178   @param[in]  MakeLast              If present, will stipulate that the handler is posted to
 179                                     be executed last in the dispatch table.
 180   @param[in]  FloatingPointSave     An optional parameter that informs the
 181                                     EFI_SMM_ACCESS_PROTOCOL Driver core if it needs to save
 182                                     the floating point register state. If any handler
 183                                     require this, the state will be saved for all handlers.
 184
 185   @retval     EFI_SUCCESS           The operation was successful
 186   @retval     EFI_OUT_OF_RESOURCES  Not enough space in the dispatch queue
 187   @retval     EFI_UNSUPPORTED       Platform is in runtime.
 188   @retval     EFI_UNSUPPORTED       The caller is not in SMM.
 189
 190 **/
 191 typedef
 192 EFI_STATUS
 193 (EFIAPI *EFI_SMM_CALLBACK_SERVICE)(
 194   IN EFI_SMM_BASE_PROTOCOL                            *This,
 195   IN EFI_HANDLE                                       SmmImageHandle,
 196   IN EFI_SMM_CALLBACK_ENTRY_POINT                     CallbackAddress,
 197   IN BOOLEAN                                          MakeLast OPTIONAL,
 198   IN BOOLEAN                                          FloatingPointSave OPTIONAL
 199   );
 200
 201 /**
 202   The SmmAllocatePool() function allocates a memory region of Size bytes from memory of
 203   type PoolType and returns the address of the allocated memory in the location referenced
 204   by Buffer.  This function allocates pages from EFI SMRAM Memory as needed to grow the
 205   requested pool type.  All allocations are eight-byte aligned.
 206
 207   @param[in]   This                  Protocol instance pointer.
 208   @param[in]   PoolType              The type of pool to allocate.
 209                                      The only supported type is EfiRuntimeServicesData;
 210                                      the interface will internally map this runtime request to
 211                                      SMRAM for IA-32 and leave as this type for the Itanium
 212                                      processor family. Other types can be ignored.
 213   @param[in]   Size                  The number of bytes to allocate from the pool.
 214   @param[out]  Buffer                A pointer to a pointer to the allocated buffer if the call
 215                                      succeeds; undefined otherwise.
 216
 217   @retval      EFI_SUCCESS           The requested number of bytes was allocated.
 218   @retval      EFI_OUT_OF_RESOURCES  The pool requested could not be allocated.
 219   @retval      EFI_UNSUPPORTED       Platform is in runtime.
 220
 221 **/
 222 typedef
 223 EFI_STATUS
 224 (EFIAPI *EFI_SMM_ALLOCATE_POOL)(
 225   IN EFI_SMM_BASE_PROTOCOL          *This,
 226   IN EFI_MEMORY_TYPE                PoolType,
 227   IN UINTN                          Size,
 228   OUT VOID                          **Buffer
 229   );
 230
 231 /**
 232   The SmmFreePool() function returns the memory specified by Buffer to the system.
 233   On return, the memory's type is EFI SMRAM Memory.  The Buffer that is freed must
 234   have been allocated by SmmAllocatePool().
 235
 236   @param[in]  This                  Protocol instance pointer.
 237   @param[in]  Buffer                Pointer to the buffer allocation.
 238
 239   @retval     EFI_SUCCESS           The memory was returned to the system.
 240   @retval     EFI_INVALID_PARAMETER Buffer was invalid.
 241   @retval     EFI_UNSUPPORTED       Platform is in runtime.
 242
 243 **/
 244 typedef
 245 EFI_STATUS
 246 (EFIAPI *EFI_SMM_FREE_POOL)(
 247   IN EFI_SMM_BASE_PROTOCOL          *This,
 248   IN VOID                           *Buffer
 249   );
 250
 251 /**
 252   This routine tells caller if execution context is SMM or not.
 253
 254   @param[in]   This                   Protocol instance pointer.
 255   @param[out]  InSmm                  Whether the caller is inside SMM for IA-32
 256                                       or servicing a PMI for the Itanium processor
 257                                       family.
 258
 259   @retval      EFI_SUCCESS            The operation was successful
 260   @retval      EFI_INVALID_PARAMETER  InSmm was NULL.
 261
 262 **/
 263 typedef
 264 EFI_STATUS
 265 (EFIAPI *EFI_SMM_INSIDE_OUT)(
 266   IN EFI_SMM_BASE_PROTOCOL          *This,
 267   OUT BOOLEAN                       *InSmm
 268   );
 269
 270 /**
 271   The GetSmstLocation() function returns the location of the System Management
 272   Service Table.  The use of the API is such that a driver can discover the
 273   location of the SMST in its entry point and then cache it in some driver
 274   global variable so that the SMST can be invoked in subsequent callbacks.
 275
 276   @param[in]  This                  Protocol instance pointer.
 277   @param[in]  Smst                  Pointer to the SMST.
 278
 279   @retval     EFI_SUCCESS           The operation was successful
 280   @retval     EFI_INVALID_PARAMETER Smst was invalid.
 281   @retval     EFI_UNSUPPORTED       Not in SMM.
 282
 283 **/
 284 typedef
 285 EFI_STATUS
 286 (EFIAPI *EFI_SMM_GET_SMST_LOCATION)(
 287   IN EFI_SMM_BASE_PROTOCOL          *This,
 288   IN OUT EFI_SMM_SYSTEM_TABLE       **Smst
 289   );
 290
 291 ///
 292 /// This protocol is used to install SMM handlers for support of subsequent SMI/PMI
 293 /// activations. This protocol is available on both IA-32 and Itanium-based systems.
 294 ///
 295 struct _EFI_SMM_BASE_PROTOCOL {
 296   EFI_SMM_REGISTER_HANDLER    Register;
 297   EFI_SMM_UNREGISTER_HANDLER  UnRegister;
 298   EFI_SMM_COMMUNICATE         Communicate;
 299   EFI_SMM_CALLBACK_SERVICE    RegisterCallback;
 300   EFI_SMM_INSIDE_OUT          InSmm;
 301   EFI_SMM_ALLOCATE_POOL       SmmAllocatePool;
 302   EFI_SMM_FREE_POOL           SmmFreePool;
 303   EFI_SMM_GET_SMST_LOCATION   GetSmstLocation;
 304 };
 305
 306 extern EFI_GUID gEfiSmmBaseProtocolGuid;
 307
 308 #endif