Remove BugBug in comments and adjust function header according to code style doc.

[mirror_edk2.git] / MdePkg / Include / Protocol / SmmBase.h

diff --git a/MdePkg/Include/Protocol/SmmBase.h b/MdePkg/Include/Protocol/SmmBase.h
index 6dd3a5dd5768831b35d4c9fdb62ef3e88434a465..664e34c9e6b4feb6392687a7f2d9bb93d936b8e4 100644 (file)
--- a/MdePkg/Include/Protocol/SmmBase.h
+++ b/MdePkg/Include/Protocol/SmmBase.h
@@ -40,14 +40,12 @@ typedef struct _EFI_SMM_BASE_PROTOCOL             EFI_SMM_BASE_PROTOCOL;
 /**\r
   Entry Point to Callback service\r
 \r
 /**\r
   Entry Point to Callback service\r
 \r

-  @param  SmmImageHandle A handle allocated by the SMM infrastructure code \r
-  to uniquely designate a specific DXE SMM driver. \r
-  \r
-  @param  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
-  \r
-  @param  SourceSize The size of the CommunicationBuffer.\r
+  @param  SmmImageHandle        A handle allocated by the SMM infrastructure code\r
+                                to uniquely designate a specific DXE SMM driver.\r
+  @param  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
+  @param  SourceSize            The size of the CommunicationBuffer.\r

 \r
   @return Status code\r
 \r
 \r
   @return Status code\r
 \r


@@ -67,20 +65,20 @@ EFI_STATUS
   Register a given driver into SMRAM.This is the equivalent of performing\r
   the LoadImage/StartImage into System Management Mode.\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  This Protocol instance pointer.\r
-  @param  FilePath Location of the image to be installed as the handler.\r
-  @param  SourceBuffer Optional source buffer in case of the image file\r
-  being in memory.\r
-  @param  SourceSize Size of the source image file, if in memory.\r
-  @param  ImageHandle Pointer to the handle that reflects the driver\r
-  loaded into SMM.\r
-  @param  LegacyIA32Binary The binary image to load is legacy 16 bit code.\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
+  @param  This                  Protocol instance pointer.\r
+  @param  FilePath              Location of the image to be installed as the handler.\r
+  @param  SourceBuffer          Optional source buffer in case of the image file\r
+                                being in memory.\r
+  @param  SourceSize            Size of the source image file, if in memory.\r
+  @param  ImageHandle           Pointer to the handle that reflects the driver\r
+                                loaded into SMM.\r
+  @param  LegacyIA32Binary      The binary image to load is legacy 16 bit code.\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

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r


@@ -99,13 +97,13 @@ EFI_STATUS
   Remove a given driver SMRAM.  This is the equivalent of performing\r
   the UnloadImage System Management Mode.\r
 \r
   Remove a given driver SMRAM.  This is the equivalent of performing\r
   the UnloadImage System Management Mode.\r
 \r

-  @param  This Protocol instance pointer.\r
-  @param  ImageHandle Pointer to the handle that reflects the driver\r
-  loaded into SMM.\r
+  @param  This                  Protocol instance pointer.\r
+  @param  ImageHandle           Pointer to the handle that reflects the driver\r
+                                loaded into SMM.\r

 \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       In runtime.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r


@@ -122,14 +120,14 @@ EFI_STATUS
   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
   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  This Protocol instance pointer.\r
-  @param  ImageHandle Pointer to the handle that reflects the driver\r
-  loaded into SMM.\r
-  @param  CommunicationBuffer Pointer to the buffer to convey into SMRAM.\r
-  @param  SourceSize Size of the contents of buffer..\r
+  @param  This                  Protocol instance pointer.\r
+  @param  ImageHandle           Pointer to the handle that reflects the driver\r
+                                loaded into SMM.\r
+  @param  CommunicationBuffer   Pointer to the buffer to convey into SMRAM.\r
+  @param  SourceSize            Size of the contents of buffer..\r

 \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
 \r
 **/\r
 typedef\r


@@ -146,21 +144,21 @@ EFI_STATUS
   Register a callback to execute within SMM.   \r
   This allows receipt of messages created with the Boot Service COMMUNICATE.\r
 \r
   Register a callback to execute within SMM.   \r
   This allows receipt of messages created with the Boot Service COMMUNICATE.\r
 \r

-  @param  This Protocol instance pointer.\r
-  @param  CallbackAddress Address of the callback service\r
-  @param  MakeFirst If present, will stipulate that the handler is posted\r
-  to be the first module executed in the dispatch table.\r
-  @param  MakeLast If present, will stipulate that the handler is posted\r
-  to be last executed in the dispatch table.\r
-  @param  FloatingPointSave This is an optional parameter which 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
-\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_UNSUPPORTED Not in SMM.\r
+  @param  This                  Protocol instance pointer.\r
+  @param  CallbackAddress       Address of the callback service\r
+  @param  MakeFirst             If present, will stipulate that the handler is posted\r
+                                to be the first module executed in the dispatch table.\r
+  @param  MakeLast              If present, will stipulate that the handler is posted\r
+                                to be last executed in the dispatch table.\r
+  @param  FloatingPointSave     This is an optional parameter which 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
+\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_UNSUPPORTED       Not in SMM.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r


@@ -180,18 +178,18 @@ EFI_STATUS
   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
   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  This Protocol instance pointer.\r
-  @param  PoolType The type of pool to allocate.\r
-  The only supported type is EfiRuntimeServicesData;\r
-  the interface will internally map this runtime request to SMRAM.\r
-  @param  Size The number of bytes to allocate from the pool.\r
-  @param  Buffer A pointer to a pointer to the allocated buffer if the call\r
-  succeeds; undefined otherwise.\r
+  @param  This                  Protocol instance pointer.\r
+  @param  PoolType              The type of pool to allocate.\r
+                                The only supported type is EfiRuntimeServicesData;\r
+                                the interface will internally map this runtime request to SMRAM.\r
+  @param  Size                  The number of bytes to allocate from the pool.\r
+  @param  Buffer                A pointer to a pointer to the allocated buffer if the call\r
+                                succeeds; undefined otherwise.\r

 \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_INVALID_PARAMETER PoolType was invalid.\r
-  @retval  EFI_UNSUPPORTED In runtime.\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_INVALID_PARAMETER PoolType was invalid.\r
+  @retval EFI_UNSUPPORTED       In runtime.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r


@@ -209,12 +207,12 @@ EFI_STATUS
   On return, the memory's type is EFI SMRAM Memory.  The Buffer that is freed must \r
   have been allocated by SmmAllocatePool().\r
 \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  This Protocol instance pointer.\r
-  @param  Buffer Pointer to the buffer allocation.\r
+  @param  This                  Protocol instance pointer.\r
+  @param  Buffer                Pointer to the buffer allocation.\r

 \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_SUCCESS           The memory was returned to the system.\r
+  @retval EFI_INVALID_PARAMETER Buffer was invalid.\r
+  @retval EFI_UNSUPPORTED       In runtime.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r


@@ -228,10 +226,10 @@ EFI_STATUS
 /**\r
   This routine tells caller if execution context is SMM or not.\r
 \r
 /**\r
   This routine tells caller if execution context is SMM or not.\r
 \r

-  @param  This Protocol instance pointer.\r
-  @param  InSmm Whether the caller is inside SMM for IA-32 or servicing a PMI for the Itanium processor family.\r
+  @param  This                  Protocol instance pointer.\r
+  @param  InSmm                 Whether the caller is inside SMM for IA-32 or servicing a PMI for the Itanium processor family.\r

 \r
 \r

-  @retval  EFI_SUCCESS The operation was successful\r
+  @retval EFI_SUCCESS           The operation was successful\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r


@@ -248,12 +246,12 @@ EFI_STATUS
   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
   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  This Protocol instance pointer.\r
-  @param  Smst Pointer to the SMST.\r
+  @param  This                  Protocol instance pointer.\r
+  @param  Smst                  Pointer to the SMST.\r

 \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
+  @retval EFI_SUCCESS           The operation was successful\r
+  @retval EFI_INVALID_PARAMETER Smst was invalid.\r
+  @retval EFI_UNSUPPORTED       Not in SMM.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r