-/** @file\r
- Include file for SMM Base Protocol on SMM Base2 Protocol Thunk driver.\r
- \r
- Copyright (c) 2009 - 2010, 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_ON_SMM_BASE2_THUNK_H_\r
-#define _SMM_BASE_ON_SMM_BASE2_THUNK_H_\r
-\r
-#include <PiDxe.h>\r
-#include <FrameworkSmm.h>\r
-#include <Library/DebugLib.h>\r
-#include <Library/UefiBootServicesTableLib.h>\r
-#include <Library/UefiDriverEntryPoint.h>\r
-#include <Library/UefiLib.h>\r
-#include <Library/UefiRuntimeLib.h>\r
-#include <Guid/SmmBaseThunkCommunication.h>\r
-#include <Guid/EventGroup.h>\r
-#include <Protocol/SmmBase2.h>\r
-#include <Protocol/SmmCommunication.h>\r
-#include <Protocol/SmmBaseHelperReady.h>\r
-\r
-/**\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 the image file\r
- is 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
- not unique across DXE/EFI.\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 Platform is in runtime.\r
- @retval EFI_INVALID_PARAMETER The handlers was not the correct image type\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-SmmBaseRegister (\r
- IN EFI_SMM_BASE_PROTOCOL *This,\r
- IN EFI_DEVICE_PATH_PROTOCOL *FilePath,\r
- IN VOID *SourceBuffer,\r
- IN UINTN SourceSize,\r
- OUT EFI_HANDLE *ImageHandle,\r
- IN BOOLEAN LegacyIA32Binary\r
- );\r
-\r
-/**\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] 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 Platform is in runtime.\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-SmmBaseUnregister (\r
- IN EFI_SMM_BASE_PROTOCOL *This,\r
- IN EFI_HANDLE ImageHandle\r
- );\r
-\r
-/**\r
- The SMM Inter-module Communicate Service Communicate() function\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] ImageHandle The handle of the registered driver.\r
- @param[in,out] CommunicationBuffer Pointer to the buffer to convey into SMRAM.\r
- @param[in,out] BufferSize 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
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-SmmBaseCommunicate (\r
- IN EFI_SMM_BASE_PROTOCOL *This,\r
- IN EFI_HANDLE ImageHandle,\r
- IN OUT VOID *CommunicationBuffer,\r
- IN OUT UINTN *BufferSize\r
- );\r
-\r
-/**\r
- Register a callback to execute within SMM.\r
- This allows receipt of messages created with EFI_SMM_BASE_PROTOCOL.Communicate().\r
-\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
- be executed last in the dispatch table.\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 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 Platform is in runtime.\r
- @retval EFI_UNSUPPORTED The caller is not in SMM.\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-SmmBaseRegisterCallback (\r
- IN EFI_SMM_BASE_PROTOCOL *This,\r
- IN EFI_HANDLE SmmImageHandle,\r
- IN EFI_SMM_CALLBACK_ENTRY_POINT CallbackAddress,\r
- IN BOOLEAN MakeLast,\r
- IN BOOLEAN FloatingPointSave\r
- );\r
-\r
-/**\r
- This routine tells caller if execution context is SMM or not.\r
-\r
- @param[in] This 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_INVALID_PARAMETER InSmm was NULL.\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-SmmBaseInSmm (\r
- IN EFI_SMM_BASE_PROTOCOL *This,\r
- OUT BOOLEAN *InSmm\r
- );\r
-\r
-/**\r
- The SmmAllocatePool() function allocates a memory region of Size bytes from memory of\r
- type PoolType and returns the address of the allocated memory in the location referenced\r
- by Buffer. This function allocates pages from EFI SMRAM Memory as needed to grow the\r
- requested pool type. All allocations are eight-byte aligned.\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
- 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
- succeeds; undefined otherwise.\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 Platform is in runtime.\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-SmmBaseSmmAllocatePool (\r
- IN EFI_SMM_BASE_PROTOCOL *This,\r
- IN EFI_MEMORY_TYPE PoolType,\r
- IN UINTN Size,\r
- OUT VOID **Buffer\r
- );\r
-\r
-/**\r
- The SmmFreePool() function returns the memory specified by Buffer to the system.\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
-\r
- @retval EFI_SUCCESS The memory was returned to the system.\r
- @retval EFI_INVALID_PARAMETER Buffer was invalid.\r
- @retval EFI_UNSUPPORTED Platform is in runtime.\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-SmmBaseSmmFreePool (\r
- IN EFI_SMM_BASE_PROTOCOL *This,\r
- IN VOID *Buffer\r
- );\r
-\r
-/**\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
-\r
- @retval EFI_SUCCESS The operation was successful\r
- @retval EFI_INVALID_PARAMETER Smst was invalid.\r
- @retval EFI_UNSUPPORTED Not in SMM.\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-SmmBaseGetSmstLocation (\r
- IN EFI_SMM_BASE_PROTOCOL *This,\r
- OUT EFI_SMM_SYSTEM_TABLE **Smst\r
- );\r
-\r
-#endif \r