]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Pi/PiSmmCis.h
MdePkg/ProcessorBind: add defines for page allocation granularity
[mirror_edk2.git] / MdePkg / Include / Pi / PiSmmCis.h
index 3e9edffd9acbed2c449120a4a06bada6f1019544..6cb28b7fb2c9aee7e028b45bb03fa4c5dd81205c 100644 (file)
@@ -1,9 +1,9 @@
 /** @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 - 2010, 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
@@ -26,9 +26,11 @@ typedef struct _EFI_SMM_SYSTEM_TABLE2  EFI_SMM_SYSTEM_TABLE2;
 ///\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_TABLE2_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
@@ -58,15 +60,15 @@ EFI_STATUS
   );\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
+  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]     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
@@ -104,14 +106,17 @@ EFI_STATUS
   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
@@ -129,10 +134,10 @@ EFI_STATUS
   @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
@@ -173,7 +178,7 @@ EFI_STATUS
 /**\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
@@ -214,7 +219,7 @@ typedef struct _EFI_SMM_ENTRY_CONTEXT {
   ///\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
@@ -295,7 +300,7 @@ struct _EFI_SMM_SYSTEM_TABLE2 {
   ///\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
   ///\r