/** @file\r
- Common definitions in the Platform Initialization Specification version 1.2\r
+ Common definitions in the Platform Initialization Specification version 1.4a\r
VOLUME 4 System Management Mode Core Interface version.\r
\r
- Copyright (c) 2009, Intel Corporation\r
- All rights reserved. This program and the accompanying materials\r
+ Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved.<BR>\r
+ 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
#define _PI_SMMCIS_H_\r
\r
#include <Pi/PiMultiPhase.h>\r
-#include <Protocol/SmmCpuIo.h>\r
+#include <Protocol/SmmCpuIo2.h>\r
\r
-typedef struct _EFI_SMM_SYSTEM_TABLE EFI_SMM_SYSTEM_TABLE;\r
+typedef struct _EFI_SMM_SYSTEM_TABLE2 EFI_SMM_SYSTEM_TABLE2;\r
\r
///\r
/// The System Management System Table (SMST) signature\r
///\r
#define SMM_SMST_SIGNATURE SIGNATURE_32 ('S', 'M', 'S', 'T')\r
///\r
-/// The System Management System Table (SMST) revision is 1.0\r
+/// The System Management System Table (SMST) revision is 1.4\r
///\r
-#define EFI_SMM_SYSTEM_TABLE_REVISION ((1 << 16) | (0x00))\r
+#define SMM_SPECIFICATION_MAJOR_REVISION 1\r
+#define SMM_SPECIFICATION_MINOR_REVISION 40\r
+#define EFI_SMM_SYSTEM_TABLE2_REVISION ((SMM_SPECIFICATION_MAJOR_REVISION<<16) | (SMM_SPECIFICATION_MINOR_REVISION))\r
\r
/**\r
Adds, updates, or removes a configuration table entry from the System Management System Table.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SMM_INSTALL_CONFIGURATION_TABLE)(\r
- IN CONST EFI_SMM_SYSTEM_TABLE *SystemTable,\r
- IN CONST EFI_GUID *Guid,\r
- IN VOID *Table,\r
- IN UINTN TableSize\r
+(EFIAPI *EFI_SMM_INSTALL_CONFIGURATION_TABLE2)(\r
+ IN CONST EFI_SMM_SYSTEM_TABLE2 *SystemTable,\r
+ IN CONST EFI_GUID *Guid,\r
+ IN VOID *Table,\r
+ IN UINTN TableSize\r
);\r
\r
/**\r
- Function prototype for invoking a function on an Application Processor.\r
+ This service lets the caller to get one distinct application processor (AP) to execute\r
+ a caller-provided code stream while in SMM.\r
\r
- @param[in,out] Buffer Pointer to private data buffer.\r
-**/\r
-typedef\r
-VOID\r
-(EFIAPI *EFI_AP_PROCEDURE)(\r
- IN OUT VOID *Buffer\r
- );\r
-\r
-/**\r
- The SmmStartupThisAp() lets the caller to get one distinct application processor\r
- (AP) in the enabled processor pool to execute a caller-provided code stream\r
- while in SMM. It runs the given code on this processor and reports the status.\r
- It must be noted that the supplied code stream will be run only on an enabled \r
- processor which has also entered SMM. \r
-\r
- @param[in] Procedure A pointer to the code stream to be run on the designated AP of the system.\r
- @param[in] CpuNumber The zero-based index of the processor number of the AP on which the code stream is supposed to run.\r
- @param[in,out] ProcArguments Allow the caller to pass a list of parameters to the code that is run by the AP.\r
+ @param[in] Procedure A pointer to the code stream to be run on the designated\r
+ AP of the system.\r
+ @param[in] CpuNumber The zero-based index of the processor number of the AP\r
+ on which the code stream is supposed to run.\r
+ @param[in,out] ProcArguments Allows the caller to pass a list of parameters to the code\r
+ that is run by the AP.\r
\r
@retval EFI_SUCCESS The call was successful and the return parameters are valid.\r
@retval EFI_INVALID_PARAMETER The input arguments are out of range.\r
The SmmRegisterProtocolNotify() function creates a registration Function that is to be \r
called whenever a protocol interface is installed for Protocol by \r
SmmInstallProtocolInterface().\r
+ If Function == NULL and Registration is an existing registration, then the callback is unhooked.\r
\r
@param[in] Protocol The unique ID of the protocol for which the event is to be registered.\r
@param[in] Function Points to the notification function.\r
@param[out] Registration A pointer to a memory location to receive the registration value.\r
\r
- @retval EFI_SUCCESS Successfully returned the registration record that has been added.\r
- @retval EFI_INVALID_PARAMETER One or more of Protocol, Function and Registration is NULL.\r
+ @retval EFI_SUCCESS Successfully returned the registration record\r
+ that has been added or unhooked.\r
+ @retval EFI_INVALID_PARAMETER Protocol is NULL or Registration is NULL.\r
@retval EFI_OUT_OF_RESOURCES Not enough memory resource to finish the request.\r
+ @retval EFI_NOT_FOUND If the registration is not found when Function == NULL.\r
**/\r
typedef\r
EFI_STATUS\r
@param[in,out] CommBuffer Points to the optional communication buffer.\r
@param[in,out] CommBufferSize Points to the size of the optional communication buffer.\r
\r
- @retval EFI_SUCCESS Interrupt source was processed successfully but not quiesced.\r
+ @retval EFI_WARN_INTERRUPT_SOURCE_PENDING Interrupt source was processed successfully but not quiesced.\r
@retval EFI_INTERRUPT_PENDING One or more SMI sources could not be quiesced.\r
- @retval EFI_WARN_INTERRUPT_SOURCE_PENDING Interrupt source was not handled or quiesced.\r
- @retval EFI_WARN_INTERRUPT_SOURCE_QUIESCED Interrupt source was handled and quiesced.\r
+ @retval EFI_NOT_FOUND Interrupt source was not handled or quiesced.\r
+ @retval EFI_SUCCESS Interrupt source was handled and quiesced.\r
**/\r
typedef\r
EFI_STATUS\r
/**\r
Registers a handler to execute within SMM.\r
\r
- @param[in] Handler Handler service funtion pointer.\r
+ @param[in] Handler Handler service function pointer.\r
@param[in] HandlerType Points to the handler type or NULL for root SMI handlers.\r
@param[out] DispatchHandle On return, contains a unique handle which can be used to later\r
unregister the handler function.\r
///\r
UINTN CurrentlyExecutingCpu;\r
///\r
- /// The number of current operational processors in the platform. This is a 1 based \r
+ /// The number of possible processors in the platform. This is a 1 based \r
/// counter. This does not indicate the number of processors that entered SMM.\r
///\r
UINTN NumberOfCpus;\r
/// services for managing SMRAM allocation and providing basic I/O services. These services are \r
/// intended for both preboot and runtime usage.\r
///\r
-struct _EFI_SMM_SYSTEM_TABLE {\r
+struct _EFI_SMM_SYSTEM_TABLE2 {\r
///\r
/// The table header for the SMST.\r
///\r
- EFI_TABLE_HEADER Hdr;\r
+ EFI_TABLE_HEADER Hdr;\r
///\r
/// A pointer to a NULL-terminated Unicode string containing the vendor name.\r
/// It is permissible for this pointer to be NULL.\r
///\r
- CHAR16 *SmmFirmwareVendor;\r
+ CHAR16 *SmmFirmwareVendor;\r
///\r
/// The particular revision of the firmware.\r
///\r
- UINT32 SmmFirmwareRevision;\r
+ UINT32 SmmFirmwareRevision;\r
\r
- EFI_SMM_INSTALL_CONFIGURATION_TABLE SmmInstallConfigurationTable;\r
+ EFI_SMM_INSTALL_CONFIGURATION_TABLE2 SmmInstallConfigurationTable;\r
\r
///\r
/// I/O Service\r
///\r
- EFI_SMM_CPU_IO_PROTOCOL SmmIo;\r
+ EFI_SMM_CPU_IO2_PROTOCOL SmmIo;\r
\r
///\r
/// Runtime memory services\r
///\r
- EFI_ALLOCATE_POOL SmmAllocatePool;\r
- EFI_FREE_POOL SmmFreePool;\r
- EFI_ALLOCATE_PAGES SmmAllocatePages;\r
- EFI_FREE_PAGES SmmFreePages;\r
+ EFI_ALLOCATE_POOL SmmAllocatePool;\r
+ EFI_FREE_POOL SmmFreePool;\r
+ EFI_ALLOCATE_PAGES SmmAllocatePages;\r
+ EFI_FREE_PAGES SmmFreePages;\r
\r
///\r
/// MP service\r
///\r
- EFI_SMM_STARTUP_THIS_AP SmmStartupThisAp;\r
+ EFI_SMM_STARTUP_THIS_AP SmmStartupThisAp;\r
\r
///\r
/// CPU information records\r
/// A number between zero and and the NumberOfCpus field. This field designates \r
/// which processor is executing the SMM infrastructure.\r
///\r
- UINTN CurrentlyExecutingCpu;\r
+ UINTN CurrentlyExecutingCpu;\r
///\r
- /// The number of current operational processors in the platform. This is a 1 based counter.\r
+ /// The number of possible processors in the platform. This is a 1 based counter.\r
///\r
- UINTN NumberOfCpus;\r
+ UINTN NumberOfCpus;\r
///\r
/// Points to an array, where each element describes the number of bytes in the \r
/// corresponding save state specified by CpuSaveState. There are always \r
/// NumberOfCpus entries in the array. \r
///\r
- UINTN *CpuSaveStateSize;\r
+ UINTN *CpuSaveStateSize;\r
///\r
/// Points to an array, where each element is a pointer to a CPU save state. The \r
/// corresponding element in CpuSaveStateSize specifies the number of bytes in the \r
/// save state area. There are always NumberOfCpus entries in the array.\r
///\r
- VOID **CpuSaveState;\r
+ VOID **CpuSaveState;\r
\r
///\r
/// Extensibility table\r
///\r
/// The number of UEFI Configuration Tables in the buffer SmmConfigurationTable.\r
///\r
- UINTN NumberOfTableEntries;\r
+ UINTN NumberOfTableEntries;\r
///\r
/// A pointer to the UEFI Configuration Tables. The number of entries in the table is \r
/// NumberOfTableEntries. \r
///\r
- EFI_CONFIGURATION_TABLE *SmmConfigurationTable;\r
+ EFI_CONFIGURATION_TABLE *SmmConfigurationTable;\r
\r
///\r
/// Protocol services\r
///\r
- EFI_INSTALL_PROTOCOL_INTERFACE SmmInstallProtocolInterface;\r
- EFI_UNINSTALL_PROTOCOL_INTERFACE SmmUninstallProtocolInterface;\r
- EFI_HANDLE_PROTOCOL SmmHandleProtocol;\r
- EFI_SMM_REGISTER_PROTOCOL_NOTIFY SmmRegisterProtocolNotify;\r
- EFI_LOCATE_HANDLE SmmLocateHandle;\r
- EFI_LOCATE_PROTOCOL SmmLocateProtocol;\r
+ EFI_INSTALL_PROTOCOL_INTERFACE SmmInstallProtocolInterface;\r
+ EFI_UNINSTALL_PROTOCOL_INTERFACE SmmUninstallProtocolInterface;\r
+ EFI_HANDLE_PROTOCOL SmmHandleProtocol;\r
+ EFI_SMM_REGISTER_PROTOCOL_NOTIFY SmmRegisterProtocolNotify;\r
+ EFI_LOCATE_HANDLE SmmLocateHandle;\r
+ EFI_LOCATE_PROTOCOL SmmLocateProtocol;\r
\r
///\r
/// SMI Management functions\r
///\r
- EFI_SMM_INTERRUPT_MANAGE SmiManage;\r
- EFI_SMM_INTERRUPT_REGISTER SmiHandlerRegister;\r
- EFI_SMM_INTERRUPT_UNREGISTER SmiHandlerUnRegister;\r
+ EFI_SMM_INTERRUPT_MANAGE SmiManage;\r
+ EFI_SMM_INTERRUPT_REGISTER SmiHandlerRegister;\r
+ EFI_SMM_INTERRUPT_UNREGISTER SmiHandlerUnRegister;\r
};\r
\r
#endif\r
projects / mirror_edk2.git / blobdiff