MdePkg/Include/Pi/PiSmmCis.h

   1 /** @file
   2   Common definitions in the Platform Initialization Specification version 1.4
   3   VOLUME 4 System Management Mode Core Interface version.
   4
   5   Copyright (c) 2009 - 2015, Intel Corporation. All rights reserved.<BR>
   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 _PI_SMMCIS_H_
  17 #define _PI_SMMCIS_H_
  18
  19 #include <Pi/PiMultiPhase.h>
  20 #include <Protocol/SmmCpuIo2.h>
  21
  22 typedef struct _EFI_SMM_SYSTEM_TABLE2  EFI_SMM_SYSTEM_TABLE2;
  23
  24 ///
  25 /// The System Management System Table (SMST) signature
  26 ///
  27 #define SMM_SMST_SIGNATURE            SIGNATURE_32 ('S', 'M', 'S', 'T')
  28 ///
  29 /// The System Management System Table (SMST) revision is 1.4
  30 ///
  31 #define SMM_SPECIFICATION_MAJOR_REVISION  1
  32 #define SMM_SPECIFICATION_MINOR_REVISION  40
  33 #define EFI_SMM_SYSTEM_TABLE2_REVISION    ((SMM_SPECIFICATION_MAJOR_REVISION<<16) | (SMM_SPECIFICATION_MINOR_REVISION))
  34
  35 /**
  36   Adds, updates, or removes a configuration table entry from the System Management System Table.
  37
  38   The SmmInstallConfigurationTable() function is used to maintain the list
  39   of configuration tables that are stored in the System Management System
  40   Table.  The list is stored as an array of (GUID, Pointer) pairs.  The list
  41   must be allocated from pool memory with PoolType set to EfiRuntimeServicesData.
  42
  43   @param[in] SystemTable         A pointer to the SMM System Table (SMST).
  44   @param[in] Guid                A pointer to the GUID for the entry to add, update, or remove.
  45   @param[in] Table               A pointer to the buffer of the table to add.
  46   @param[in] TableSize           The size of the table to install.
  47
  48   @retval EFI_SUCCESS            The (Guid, Table) pair was added, updated, or removed.
  49   @retval EFI_INVALID_PARAMETER  Guid is not valid.
  50   @retval EFI_NOT_FOUND          An attempt was made to delete a non-existent entry.
  51   @retval EFI_OUT_OF_RESOURCES   There is not enough memory available to complete the operation.
  52 **/
  53 typedef
  54 EFI_STATUS
  55 (EFIAPI *EFI_SMM_INSTALL_CONFIGURATION_TABLE2)(
  56   IN CONST EFI_SMM_SYSTEM_TABLE2  *SystemTable,
  57   IN CONST EFI_GUID               *Guid,
  58   IN VOID                         *Table,
  59   IN UINTN                        TableSize
  60   );
  61
  62 /**
  63   The SmmStartupThisAp() lets the caller to get one distinct application processor
  64   (AP) in the enabled processor pool to execute a caller-provided code stream
  65   while in SMM. It runs the given code on this processor and reports the status.
  66   It must be noted that the supplied code stream will be run only on an enabled
  67   processor which has also entered SMM.
  68
  69   @param[in]     Procedure       A pointer to the code stream to be run on the designated AP of the system.
  70   @param[in]     CpuNumber       The zero-based index of the processor number of the AP on which the code stream is supposed to run.
  71   @param[in,out] ProcArguments   Allow the caller to pass a list of parameters to the code that is run by the AP.
  72
  73   @retval EFI_SUCCESS            The call was successful and the return parameters are valid.
  74   @retval EFI_INVALID_PARAMETER  The input arguments are out of range.
  75   @retval EFI_INVALID_PARAMETER  The CPU requested is not available on this SMI invocation.
  76   @retval EFI_INVALID_PARAMETER  The CPU cannot support an additional service invocation.
  77 **/
  78 typedef
  79 EFI_STATUS
  80 (EFIAPI *EFI_SMM_STARTUP_THIS_AP)(
  81   IN EFI_AP_PROCEDURE  Procedure,
  82   IN UINTN             CpuNumber,
  83   IN OUT VOID          *ProcArguments OPTIONAL
  84   );
  85
  86 /**
  87   Function prototype for protocol install notification.
  88
  89   @param[in] Protocol   Points to the protocol's unique identifier.
  90   @param[in] Interface  Points to the interface instance.
  91   @param[in] Handle     The handle on which the interface was installed.
  92
  93   @return Status Code
  94 **/
  95 typedef
  96 EFI_STATUS
  97 (EFIAPI *EFI_SMM_NOTIFY_FN)(
  98   IN CONST EFI_GUID  *Protocol,
  99   IN VOID            *Interface,
 100   IN EFI_HANDLE      Handle
 101   );
 102
 103 /**
 104   Register a callback function be called when a particular protocol interface is installed.
 105
 106   The SmmRegisterProtocolNotify() function creates a registration Function that is to be
 107   called whenever a protocol interface is installed for Protocol by
 108   SmmInstallProtocolInterface().
 109   If Function == NULL and Registration is an existing registration, then the callback is unhooked.
 110
 111   @param[in]  Protocol          The unique ID of the protocol for which the event is to be registered.
 112   @param[in]  Function          Points to the notification function.
 113   @param[out] Registration      A pointer to a memory location to receive the registration value.
 114
 115   @retval EFI_SUCCESS           Successfully returned the registration record that has been added.
 116   @retval EFI_INVALID_PARAMETER One or more of Protocol, Function and Registration is NULL.
 117   @retval EFI_OUT_OF_RESOURCES  Not enough memory resource to finish the request.
 118   @retval EFI_NOT_FOUND         If the registration is not found when Function == NULL.
 119 **/
 120 typedef
 121 EFI_STATUS
 122 (EFIAPI *EFI_SMM_REGISTER_PROTOCOL_NOTIFY)(
 123   IN  CONST EFI_GUID     *Protocol,
 124   IN  EFI_SMM_NOTIFY_FN  Function,
 125   OUT VOID               **Registration
 126   );
 127
 128 /**
 129   Manage SMI of a particular type.
 130
 131   @param[in]     HandlerType     Points to the handler type or NULL for root SMI handlers.
 132   @param[in]     Context         Points to an optional context buffer.
 133   @param[in,out] CommBuffer      Points to the optional communication buffer.
 134   @param[in,out] CommBufferSize  Points to the size of the optional communication buffer.
 135
 136   @retval EFI_WARN_INTERRUPT_SOURCE_PENDING  Interrupt source was processed successfully but not quiesced.
 137   @retval EFI_INTERRUPT_PENDING              One or more SMI sources could not be quiesced.
 138   @retval EFI_NOT_FOUND                      Interrupt source was not handled or quiesced.
 139   @retval EFI_SUCCESS                        Interrupt source was handled and quiesced.
 140 **/
 141 typedef
 142 EFI_STATUS
 143 (EFIAPI *EFI_SMM_INTERRUPT_MANAGE)(
 144   IN CONST EFI_GUID  *HandlerType,
 145   IN CONST VOID      *Context         OPTIONAL,
 146   IN OUT VOID        *CommBuffer      OPTIONAL,
 147   IN OUT UINTN       *CommBufferSize  OPTIONAL
 148   );
 149
 150 /**
 151   Main entry point for an SMM handler dispatch or communicate-based callback.
 152
 153   @param[in]     DispatchHandle  The unique handle assigned to this handler by SmiHandlerRegister().
 154   @param[in]     Context         Points to an optional handler context which was specified when the
 155                                  handler was registered.
 156   @param[in,out] CommBuffer      A pointer to a collection of data in memory that will
 157                                  be conveyed from a non-SMM environment into an SMM environment.
 158   @param[in,out] CommBufferSize  The size of the CommBuffer.
 159
 160   @retval EFI_SUCCESS                         The interrupt was handled and quiesced. No other handlers
 161                                               should still be called.
 162   @retval EFI_WARN_INTERRUPT_SOURCE_QUIESCED  The interrupt has been quiesced but other handlers should
 163                                               still be called.
 164   @retval EFI_WARN_INTERRUPT_SOURCE_PENDING   The interrupt is still pending and other handlers should still
 165                                               be called.
 166   @retval EFI_INTERRUPT_PENDING               The interrupt could not be quiesced.
 167 **/
 168 typedef
 169 EFI_STATUS
 170 (EFIAPI *EFI_SMM_HANDLER_ENTRY_POINT2)(
 171   IN EFI_HANDLE  DispatchHandle,
 172   IN CONST VOID  *Context         OPTIONAL,
 173   IN OUT VOID    *CommBuffer      OPTIONAL,
 174   IN OUT UINTN   *CommBufferSize  OPTIONAL
 175   );
 176
 177 /**
 178   Registers a handler to execute within SMM.
 179
 180   @param[in]  Handler            Handler service funtion pointer.
 181   @param[in]  HandlerType        Points to the handler type or NULL for root SMI handlers.
 182   @param[out] DispatchHandle     On return, contains a unique handle which can be used to later
 183                                  unregister the handler function.
 184
 185   @retval EFI_SUCCESS            SMI handler added successfully.
 186   @retval EFI_INVALID_PARAMETER  Handler is NULL or DispatchHandle is NULL.
 187 **/
 188 typedef
 189 EFI_STATUS
 190 (EFIAPI *EFI_SMM_INTERRUPT_REGISTER)(
 191   IN  EFI_SMM_HANDLER_ENTRY_POINT2  Handler,
 192   IN  CONST EFI_GUID                *HandlerType OPTIONAL,
 193   OUT EFI_HANDLE                    *DispatchHandle
 194   );
 195
 196 /**
 197   Unregister a handler in SMM.
 198
 199   @param[in] DispatchHandle      The handle that was specified when the handler was registered.
 200
 201   @retval EFI_SUCCESS            Handler function was successfully unregistered.
 202   @retval EFI_INVALID_PARAMETER  DispatchHandle does not refer to a valid handle.
 203 **/
 204 typedef
 205 EFI_STATUS
 206 (EFIAPI *EFI_SMM_INTERRUPT_UNREGISTER)(
 207   IN EFI_HANDLE  DispatchHandle
 208   );
 209
 210 ///
 211 /// Processor information and functionality needed by SMM Foundation.
 212 ///
 213 typedef struct _EFI_SMM_ENTRY_CONTEXT {
 214   EFI_SMM_STARTUP_THIS_AP  SmmStartupThisAp;
 215   ///
 216   /// A number between zero and the NumberOfCpus field. This field designates which
 217   /// processor is executing the SMM Foundation.
 218   ///
 219   UINTN                    CurrentlyExecutingCpu;
 220   ///
 221   /// The number of possible processors in the platform.  This is a 1 based
 222   /// counter.  This does not indicate the number of processors that entered SMM.
 223   ///
 224   UINTN                    NumberOfCpus;
 225   ///
 226   /// Points to an array, where each element describes the number of bytes in the
 227   /// corresponding save state specified by CpuSaveState. There are always
 228   /// NumberOfCpus entries in the array.
 229   ///
 230   UINTN                    *CpuSaveStateSize;
 231   ///
 232   /// Points to an array, where each element is a pointer to a CPU save state. The
 233   /// corresponding element in CpuSaveStateSize specifies the number of bytes in the
 234   /// save state area. There are always NumberOfCpus entries in the array.
 235   ///
 236   VOID                     **CpuSaveState;
 237 } EFI_SMM_ENTRY_CONTEXT;
 238
 239 /**
 240   This function is the main entry point to the SMM Foundation.
 241
 242   @param[in] SmmEntryContext  Processor information and functionality needed by SMM Foundation.
 243 **/
 244 typedef
 245 VOID
 246 (EFIAPI *EFI_SMM_ENTRY_POINT)(
 247   IN CONST EFI_SMM_ENTRY_CONTEXT  *SmmEntryContext
 248   );
 249
 250 ///
 251 /// System Management System Table (SMST)
 252 ///
 253 /// The System Management System Table (SMST) is a table that contains a collection of common
 254 /// services for managing SMRAM allocation and providing basic I/O services. These services are
 255 /// intended for both preboot and runtime usage.
 256 ///
 257 struct _EFI_SMM_SYSTEM_TABLE2 {
 258   ///
 259   /// The table header for the SMST.
 260   ///
 261   EFI_TABLE_HEADER                     Hdr;
 262   ///
 263   /// A pointer to a NULL-terminated Unicode string containing the vendor name.
 264   /// It is permissible for this pointer to be NULL.
 265   ///
 266   CHAR16                               *SmmFirmwareVendor;
 267   ///
 268   /// The particular revision of the firmware.
 269   ///
 270   UINT32                               SmmFirmwareRevision;
 271
 272   EFI_SMM_INSTALL_CONFIGURATION_TABLE2 SmmInstallConfigurationTable;
 273
 274   ///
 275   /// I/O Service
 276   ///
 277   EFI_SMM_CPU_IO2_PROTOCOL             SmmIo;
 278
 279   ///
 280   /// Runtime memory services
 281   ///
 282   EFI_ALLOCATE_POOL                    SmmAllocatePool;
 283   EFI_FREE_POOL                        SmmFreePool;
 284   EFI_ALLOCATE_PAGES                   SmmAllocatePages;
 285   EFI_FREE_PAGES                       SmmFreePages;
 286
 287   ///
 288   /// MP service
 289   ///
 290   EFI_SMM_STARTUP_THIS_AP              SmmStartupThisAp;
 291
 292   ///
 293   /// CPU information records
 294   ///
 295
 296   ///
 297   /// A number between zero and and the NumberOfCpus field. This field designates
 298   /// which processor is executing the SMM infrastructure.
 299   ///
 300   UINTN                                CurrentlyExecutingCpu;
 301   ///
 302   /// The number of possible processors in the platform.  This is a 1 based counter.
 303   ///
 304   UINTN                                NumberOfCpus;
 305   ///
 306   /// Points to an array, where each element describes the number of bytes in the
 307   /// corresponding save state specified by CpuSaveState. There are always
 308   /// NumberOfCpus entries in the array.
 309   ///
 310   UINTN                                *CpuSaveStateSize;
 311   ///
 312   /// Points to an array, where each element is a pointer to a CPU save state. The
 313   /// corresponding element in CpuSaveStateSize specifies the number of bytes in the
 314   /// save state area. There are always NumberOfCpus entries in the array.
 315   ///
 316   VOID                                 **CpuSaveState;
 317
 318   ///
 319   /// Extensibility table
 320   ///
 321
 322   ///
 323   /// The number of UEFI Configuration Tables in the buffer SmmConfigurationTable.
 324   ///
 325   UINTN                                NumberOfTableEntries;
 326   ///
 327   /// A pointer to the UEFI Configuration Tables. The number of entries in the table is
 328   /// NumberOfTableEntries.
 329   ///
 330   EFI_CONFIGURATION_TABLE              *SmmConfigurationTable;
 331
 332   ///
 333   /// Protocol services
 334   ///
 335   EFI_INSTALL_PROTOCOL_INTERFACE       SmmInstallProtocolInterface;
 336   EFI_UNINSTALL_PROTOCOL_INTERFACE     SmmUninstallProtocolInterface;
 337   EFI_HANDLE_PROTOCOL                  SmmHandleProtocol;
 338   EFI_SMM_REGISTER_PROTOCOL_NOTIFY     SmmRegisterProtocolNotify;
 339   EFI_LOCATE_HANDLE                    SmmLocateHandle;
 340   EFI_LOCATE_PROTOCOL                  SmmLocateProtocol;
 341
 342   ///
 343   /// SMI Management functions
 344   ///
 345   EFI_SMM_INTERRUPT_MANAGE             SmiManage;
 346   EFI_SMM_INTERRUPT_REGISTER           SmiHandlerRegister;
 347   EFI_SMM_INTERRUPT_UNREGISTER         SmiHandlerUnRegister;
 348 };
 349
 350 #endif