MdeModulePkg PiSmmIpl: Add missing update to the prototype
authorStar Zeng <star.zeng@intel.com>
Tue, 12 Dec 2017 08:13:39 +0000 (16:13 +0800)
committerStar Zeng <star.zeng@intel.com>
Tue, 12 Dec 2017 10:20:03 +0000 (18:20 +0800)
It is missing to update the prototype of SmmCommunicationCommunicate()
in d1632f694be027dee87dd18fa8172d674221face.

This patch is to add it.

Cc: Dandan Bi <dandan.bi@intel.com>
Cc: Jiewen Yao <jiewen.yao@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Star Zeng <star.zeng@intel.com>
Reviewed-by: Dandan Bi <dandan.bi@intel.com>
MdeModulePkg/Core/PiSmmCore/PiSmmIpl.c

index 31d2c9e45e1f56e7483892ab5e246a3f3e9b03cb..a7663ca291c488504223ed22fc13a055245cc961 100644 (file)
@@ -90,20 +90,30 @@ SmmBase2GetSmstLocation (
   be called in physical mode prior to SetVirtualAddressMap() and in virtual mode \r
   after SetVirtualAddressMap().\r
 \r
-  @param[in]     This                The EFI_SMM_COMMUNICATION_PROTOCOL instance.\r
-  @param[in, out] CommBuffer          A pointer to the buffer to convey into SMRAM.\r
-  @param[in, out] CommSize            The size of the data buffer being passed in.On exit, the size of data\r
-                                     being returned. Zero if the handler does not wish to reply with any data.\r
+  @param[in] This                The EFI_SMM_COMMUNICATION_PROTOCOL instance.\r
+  @param[in, out] CommBuffer     A pointer to the buffer to convey into SMRAM.\r
+  @param[in, out] CommSize       The size of the data buffer being passed in. On exit, the size of data\r
+                                 being returned. Zero if the handler does not wish to reply with any data.\r
+                                 This parameter is optional and may be NULL.\r
+\r
+  @retval EFI_SUCCESS            The message was successfully posted.\r
+  @retval EFI_INVALID_PARAMETER  The CommBuffer was NULL.\r
+  @retval EFI_BAD_BUFFER_SIZE    The buffer is too large for the MM implementation.\r
+                                 If this error is returned, the MessageLength field\r
+                                 in the CommBuffer header or the integer pointed by\r
+                                 CommSize, are updated to reflect the maximum payload\r
+                                 size the implementation can accommodate.\r
+  @retval EFI_ACCESS_DENIED      The CommunicateBuffer parameter or CommSize parameter,\r
+                                 if not omitted, are in address range that cannot be\r
+                                 accessed by the MM environment.\r
 \r
-  @retval EFI_SUCCESS                The message was successfully posted.\r
-  @retval EFI_INVALID_PARAMETER      The CommBuffer was NULL.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
 SmmCommunicationCommunicate (\r
   IN CONST EFI_SMM_COMMUNICATION_PROTOCOL  *This,\r
   IN OUT VOID                              *CommBuffer,\r
-  IN OUT UINTN                             *CommSize\r
+  IN OUT UINTN                             *CommSize OPTIONAL\r
   );\r
 \r
 /**\r