update file header

correct one parameter IN Out mistake in IScsiSetInitiatorName ()

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6959 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiInitiatorName.c b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiInitiatorName.c
index 3a8bd3a2ffb8405a8b34a292132616c8db4c874a..c6b1bf3586348f02d67f508bbfad8547206309d2 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiInitiatorName.c
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiInitiatorName.c
@@ -1,7 +1,7 @@
 /** @file\r
   Implementation for EFI iSCSI Initiator Name Protocol.\r
 \r
-Copyright (c) 2004 - 2008, Intel Corporation\r
+Copyright (c) 2004 - 2008, Intel Corporation.<BR>\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
@@ -10,14 +10,6 @@ http://opensource.org/licenses/bsd-license.php
 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
-Module Name:\r
-\r
-  IScsiInitiatorName.c\r
-\r
-Abstract:\r
-\r
-  Implementation for EFI iSCSI Initiator Name Protocol.\r
-\r
 **/\r
 \r
 #include "IScsiImpl.h"\r
@@ -28,31 +20,19 @@ EFI_ISCSI_INITIATOR_NAME_PROTOCOL gIScsiInitiatorName = {
 };\r
 \r
 /**\r
-  Retrieves the current set value of iSCSI Initiator Name. \r
-\r
-  @param  This[in]              Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.\r
-\r
-  @param  BufferSize[in][out]   Size of the buffer in bytes pointed to by Buffer / Actual\r
-                                size of the variable data buffer.\r
-\r
-  @param  Buffer[out]           Pointer to the buffer for data to be read.\r
-\r
-  @retval EFI_SUCCESS           Data was successfully retrieved into the provided \r
-                                buffer and the BufferSize was sufficient to handle the\r
-                                iSCSI initiator name.\r
-  @retval EFI_BUFFER_TOO_SMALL  BufferSize is too small for the result. BufferSize will\r
-                                be updated with the size required to complete the request.\r
-                                Buffer will not be affected.\r
-\r
-  @retval EFI_INVALID_PARAMETER BufferSize is NULL. BufferSize and Buffer will not be\r
-                                affected.\r
-\r
-  @retval EFI_INVALID_PARAMETER Buffer is NULL. BufferSize and Buffer will not be\r
-                                affected.\r
-\r
-  @retval EFI_DEVICE_ERROR      The iSCSI initiator name could not be retrieved due to\r
-                                a hardware error.\r
-\r
+  Retrieves the current set value of iSCSI Initiator Name.\r
+\r
+  @param[in]       This       Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.\r
+  @param[in, out]  BufferSize Size of the buffer in bytes pointed to by Buffer / Actual size of the\r
+                              variable data buffer.\r
+  @param[out]      Buffer     Pointer to the buffer for data to be read.\r
+\r
+  @retval EFI_SUCCESS           Data was successfully retrieved into the provided buffer and the\r
+                                BufferSize was sufficient to handle the iSCSI initiator name\r
+  @retval EFI_BUFFER_TOO_SMALL  BufferSize is too small for the result.\r
+  @retval EFI_INVALID_PARAMETER BufferSize or Buffer is NULL.\r
+  @retval EFI_DEVICE_ERROR      The iSCSI initiator name could not be retrieved due to a hardware error.\r
+  @retval Others                Some unexpected error happened.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -80,40 +60,28 @@ IScsiGetInitiatorName (
 }\r
 \r
 /**\r
-  Sets the iSCSI Initiator Name. \r
-\r
-  @param  This[in]              Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.\r
+  Sets the iSCSI Initiator Name.\r
 \r
-  @param  BufferSize[in][out]   Size of the buffer in bytes pointed to by Buffer.\r
+  @param[in]       This       Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.\r
+  @param[in, out]  BufferSize Size of the buffer in bytes pointed to by Buffer.\r
+  @param[in]       Buffer     Pointer to the buffer for data to be written.\r
 \r
-  @param  Buffer[out]           Pointer to the buffer for data to be written.\r
-  \r
   @retval EFI_SUCCESS           Data was successfully stored by the protocol.\r
-\r
   @retval EFI_UNSUPPORTED       Platform policies do not allow for data to be written.\r
-\r
-  @retval EFI_INVALID_PARAMETER BufferSize exceeds the maximum allowed limit.\r
-                                BufferSize will be updated with the maximum size\r
-                                required to complete the request.\r
-\r
-  @retval EFI_INVALID_PARAMETER Buffersize is NULL. BufferSize and Buffer will not be\r
-                                affected.\r
-\r
-  @retval EFI_INVALID_PARAMETER Buffer is NULL. BufferSize and Buffer will not be affected.\r
-\r
+                                Currently not implemented.\r
+  @retval EFI_INVALID_PARAMETER BufferSize or Buffer is NULL, or BufferSize exceeds the maximum allowed limit.\r
   @retval EFI_DEVICE_ERROR      The data could not be stored due to a hardware error.\r
-\r
   @retval EFI_OUT_OF_RESOURCES  Not enough storage is available to hold the data.\r
-\r
-  @retval EFI_PROTOCOL_ERROR    Input iSCSI initiator name does not adhere to RFC 3720.\r
-\r
+  @retval EFI_PROTOCOL_ERROR    Input iSCSI initiator name does not adhere to RFC 3720\r
+                                (and other related protocols)\r
+  @retval Others                Some unexpected error happened.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
 IScsiSetInitiatorName (\r
   IN     EFI_ISCSI_INITIATOR_NAME_PROTOCOL  *This,\r
   IN OUT UINTN                              *BufferSize,\r
-  OUT    VOID                               *Buffer\r
+  IN     VOID                               *Buffer\r
   )\r
 {\r
   EFI_STATUS  Status;\r