Update HiiConfigAccess.ExtractConfig interface to support NULL request string and...

[mirror_edk2.git] / MdeModulePkg / Universal / Network / IScsiDxe / IScsiInitiatorName.h

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiInitiatorName.h b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiInitiatorName.h
index 6e0eda2158ef31d3f889e1628d057f66003eeaf0..eccbabd2943e3c02ecfe31ff9982ec6e70581733 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiInitiatorName.h
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiInitiatorName.h
@@ -1,5 +1,5 @@
 /** @file\r
-  The header file of IScsi initiator name protocol.\r
+  The header file for EFI iSCSI Initiator Name Protocol.\r
 \r
 Copyright (c) 2004 - 2008, Intel Corporation.<BR>\r
 All rights reserved. This program and the accompanying materials\r
@@ -12,42 +12,31 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 **/\r
 \r
-#ifndef _ISCSI_INITIATORNAME_H_\r
-#define _ISCSI_INITIATORNAME_H_\r
+#ifndef _ISCSI_INITIATOR_NAME_H_\r
+#define _ISCSI_INITIATOR_NAME_H_\r
 \r
 #include <Protocol/IScsiInitiatorName.h>\r
 \r
 extern EFI_ISCSI_INITIATOR_NAME_PROTOCOL  gIScsiInitiatorName;\r
 \r
 //\r
-// EFI IScsi Initiator Name Protocol for IScsi driver.\r
+// EFI iSCSI Initiator Name Protocol for IScsi driver.\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
+/**\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                Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -58,40 +47,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                Other errors as indicated.\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
-#endif
\ No newline at end of file
+\r
+#endif\r