/** @file\r
This file declares SMM Base abstraction protocol.\r
This protocol is used to install SMM handlers for support of subsequent SMI/PMI activations. This\r
- protocol is available on both IA-32 and Itanium based systems.\r
- \r
+ protocol is available on both IA-32 and Itanium-based systems.\r
+\r
The EFI_SMM_BASE_PROTOCOL is a set of services that is exported by a processor device. It is\r
a required protocol for the platform processor. This protocol can be used in both boot services and\r
- runtime mode. However, only the following member functions need to exist into runtime:\r
+ runtime mode. However, only the following member functions need to exist during runtime:\r
- InSmm()\r
- Communicate()\r
This protocol is responsible for registering the handler services. The order in which the handlers are\r
workarounds for the century rollover in CMOS should provide commensurate services throughout\r
preboot and OS runtime.\r
\r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
+\r
@par Revision Reference:\r
This Protocol is defined in Framework of EFI SMM Core Interface Spec\r
Version 0.9.\r
\r
-Copyright (c) 2007 - 2009, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution. The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
-\r
**/\r
\r
#ifndef _SMM_BASE_H_\r
#define _SMM_BASE_H_\r
\r
+//\r
+// Share some common definitions with PI SMM\r
+//\r
+#include <Framework/SmmCis.h>\r
+#include <Protocol/SmmCommunication.h>\r
+\r
///\r
-/// Global ID for the EFI_SMM_BASE_PROTOCOL\r
+/// Global ID for the EFI_SMM_BASE_PROTOCOL.\r
///\r
#define EFI_SMM_BASE_PROTOCOL_GUID \\r
{ \\r
}\r
\r
///\r
-/// Forward declaration for EFI_SMM_BASE_PROTOCOL\r
+/// Forward declaration for EFI_SMM_BASE_PROTOCOL.\r
///\r
typedef struct _EFI_SMM_BASE_PROTOCOL EFI_SMM_BASE_PROTOCOL;\r
\r
#define EFI_HANDLER_SOURCE_PENDING 0x0003\r
///@}\r
\r
-///\r
-/// The header data is mandatory for messages sent into the SMM agent.\r
-///\r
-typedef struct {\r
- ///\r
- /// Allows for disambiguation of the message format.\r
- ///\r
- EFI_GUID HeaderGuid;\r
- ///\r
- /// Describes the size of the message, not including the header.\r
- ///\r
- UINTN MessageLength;\r
- ///\r
- /// Designates an array of bytes that is MessageLength in size.\r
- ///\r
- UINT8 Data[1];\r
-} EFI_SMM_COMMUNICATE_HEADER;\r
-\r
/**\r
Entry Point to Callback service\r
\r
@param[in] SmmImageHandle A handle allocated by the SMM infrastructure code\r
to uniquely designate a specific DXE SMM driver.\r
@param[in] CommunicationBuffer A pointer to a collection of data in memory\r
- that will be conveyed from a non-SMM environment into an SMM environment.\r
- The buffer must be contiguous, physically mapped, and be a physical address.\r
+ that will be conveyed from a non-SMM environment\r
+ into an SMM environment. The buffer must be\r
+ contiguous and physically mapped, and must be\r
+ a physical address.\r
@param[in] SourceSize The size of the CommunicationBuffer.\r
\r
@return Status code\r
// SMM Base Protocol Definition\r
//\r
/**\r
- Register a given driver into SMRAM.This is the equivalent of performing\r
+ Register a given driver into SMRAM. This is the equivalent of performing\r
the LoadImage/StartImage into System Management Mode.\r
\r
- @param[in] This Protocol instance pointer.\r
- @param[in] FilePath Location of the image to be installed as the handler.\r
- @param[in] SourceBuffer Optional source buffer in case of the image file\r
- being in memory.\r
- @param[in] SourceSize Size of the source image file, if in memory.\r
- @param[out] ImageHandle The handle that the base driver uses to decode \r
- the handler. Unique among SMM handlers only, \r
+ @param[in] This The protocol instance pointer.\r
+ @param[in] FilePath The location of the image to be installed as the handler.\r
+ @param[in] SourceBuffer An optional source buffer in case the image file\r
+ is in memory.\r
+ @param[in] SourceSize The size of the source image file, if in memory.\r
+ @param[out] ImageHandle The handle that the base driver uses to decode\r
+ the handler. Unique among SMM handlers only;\r
not unique across DXE/EFI.\r
- @param[in] LegacyIA32Binary An optional parameter that details that the associated \r
+ @param[in] LegacyIA32Binary An optional parameter specifying that the associated\r
file is a real-mode IA-32 binary.\r
\r
@retval EFI_SUCCESS The operation was successful.\r
@retval EFI_OUT_OF_RESOURCES There were no additional SMRAM resources to load the handler\r
@retval EFI_UNSUPPORTED This platform does not support 16-bit handlers.\r
- @retval EFI_UNSUPPORTED In runtime.\r
- @retval EFI_INVALID_PARAMETER The handlers was not the correct image type\r
+ @retval EFI_UNSUPPORTED The platform is in runtime.\r
+ @retval EFI_INVALID_PARAMETER The handlers were not the correct image type.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_SMM_REGISTER_HANDLER)(\r
- IN EFI_SMM_BASE_PROTOCOL *This,\r
+ IN EFI_SMM_BASE_PROTOCOL *This,\r
IN EFI_DEVICE_PATH_PROTOCOL *FilePath,\r
IN VOID *SourceBuffer OPTIONAL,\r
IN UINTN SourceSize,\r
Removes a handler from execution within SMRAM. This is the equivalent of performing\r
the UnloadImage in System Management Mode.\r
\r
- @param[in] This Protocol instance pointer.\r
+ @param[in] This The protocol instance pointer.\r
@param[in] ImageHandle The handler to be removed.\r
\r
- @retval EFI_SUCCESS The operation was successful\r
- @retval EFI_INVALID_PARAMETER The handler did not exist\r
- @retval EFI_UNSUPPORTED In runtime.\r
+ @retval EFI_SUCCESS The operation was successful.\r
+ @retval EFI_INVALID_PARAMETER The handler did not exist.\r
+ @retval EFI_UNSUPPORTED The platform is in runtime.\r
\r
**/\r
typedef\r
\r
/**\r
The SMM Inter-module Communicate Service Communicate() function\r
- provides a services to send/received messages from a registered\r
+ provides a service to send/receive messages from a registered\r
EFI service. The BASE protocol driver is responsible for doing\r
any of the copies such that the data lives in boot-service-accessible RAM.\r
\r
- @param[in] This Protocol instance pointer.\r
+ @param[in] This The protocol instance pointer.\r
@param[in] ImageHandle The handle of the registered driver.\r
- @param[in,out] CommunicationBuffer Pointer to the buffer to convey into SMRAM.\r
+ @param[in,out] CommunicationBuffer The pointer to the buffer to convey into SMRAM.\r
@param[in,out] SourceSize The size of the data buffer being passed in.\r
On exit, the size of data being returned.\r
Zero if the handler does not wish to reply with any data.\r
\r
- @retval EFI_SUCCESS The message was successfully posted\r
- @retval EFI_INVALID_PARAMETER The buffer was NULL\r
+ @retval EFI_SUCCESS The message was successfully posted.\r
+ @retval EFI_INVALID_PARAMETER The buffer was NULL.\r
\r
**/\r
typedef\r
@param[in] This Protocol instance pointer.\r
@param[in] SmmImageHandle Handle of the callback service.\r
@param[in] CallbackAddress Address of the callback service.\r
- @param[in] MakeLast If present, will stipulate that the handler is posted to \r
+ @param[in] MakeLast If present, will stipulate that the handler is posted to\r
be executed last in the dispatch table.\r
- @param[in] FloatingPointSave This is an optional parameter which informs the\r
+ @param[in] FloatingPointSave An optional parameter that informs the\r
EFI_SMM_ACCESS_PROTOCOL Driver core if it needs to save\r
- the floating point register state. If any of the handlers\r
- require this, then the state will be saved for all of the handlers.\r
+ the floating point register state. If any handler\r
+ require this, the state will be saved for all handlers.\r
\r
- @retval EFI_SUCCESS The operation was successful\r
- @retval EFI_OUT_OF_RESOURCES Not enough space in the dispatch queue\r
- @retval EFI_UNSUPPORTED In runtime.\r
+ @retval EFI_SUCCESS The operation was successful.\r
+ @retval EFI_OUT_OF_RESOURCES Not enough space in the dispatch queue.\r
+ @retval EFI_UNSUPPORTED The platform is in runtime.\r
@retval EFI_UNSUPPORTED The caller is not in SMM.\r
\r
**/\r
@param[in] This Protocol instance pointer.\r
@param[in] PoolType The type of pool to allocate.\r
The only supported type is EfiRuntimeServicesData;\r
- the interface will internally map this runtime request to \r
- SMRAM for IA-32 and leave as this type for the Itanium \r
+ the interface will internally map this runtime request to\r
+ SMRAM for IA-32 and leave as this type for the Itanium\r
processor family. Other types can be ignored.\r
@param[in] Size The number of bytes to allocate from the pool.\r
@param[out] Buffer A pointer to a pointer to the allocated buffer if the call\r
\r
@retval EFI_SUCCESS The requested number of bytes was allocated.\r
@retval EFI_OUT_OF_RESOURCES The pool requested could not be allocated.\r
- @retval EFI_UNSUPPORTED In runtime.\r
+ @retval EFI_UNSUPPORTED The platform is in runtime.\r
\r
**/\r
typedef\r
On return, the memory's type is EFI SMRAM Memory. The Buffer that is freed must\r
have been allocated by SmmAllocatePool().\r
\r
- @param[in] This Protocol instance pointer.\r
- @param[in] Buffer Pointer to the buffer allocation.\r
+ @param[in] This The protocol instance pointer.\r
+ @param[in] Buffer The pointer to the buffer allocation.\r
\r
@retval EFI_SUCCESS The memory was returned to the system.\r
- @retval EFI_INVALID_PARAMETER Buffer was invalid.\r
- @retval EFI_UNSUPPORTED In runtime.\r
+ @retval EFI_INVALID_PARAMETER The buffer was invalid.\r
+ @retval EFI_UNSUPPORTED The platform is in runtime.\r
\r
**/\r
typedef\r
/**\r
This routine tells caller if execution context is SMM or not.\r
\r
- @param[in] This Protocol instance pointer.\r
+ @param[in] This The protocol instance pointer.\r
@param[out] InSmm Whether the caller is inside SMM for IA-32\r
or servicing a PMI for the Itanium processor\r
family.\r
\r
- @retval EFI_SUCCESS The operation was successful\r
+ @retval EFI_SUCCESS The operation was successful.\r
@retval EFI_INVALID_PARAMETER InSmm was NULL.\r
\r
**/\r
);\r
\r
/**\r
- The GetSmstLocation() function returns the locatin of the System Management\r
+ The GetSmstLocation() function returns the location of the System Management\r
Service Table. The use of the API is such that a driver can discover the\r
location of the SMST in its entry point and then cache it in some driver\r
global variable so that the SMST can be invoked in subsequent callbacks.\r
\r
- @param[in] This Protocol instance pointer.\r
- @param[in] Smst Pointer to the SMST.\r
+ @param[in] This The protocol instance pointer.\r
+ @param[in] Smst The pointer to the SMST.\r
\r
@retval EFI_SUCCESS The operation was successful\r
@retval EFI_INVALID_PARAMETER Smst was invalid.\r
projects / mirror_edk2.git / blobdiff