MdePkg: Add UEFI2.5 Ramdisk device path definition

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

diff --git a/MdePkg/Include/Protocol/IScsiInitiatorName.h b/MdePkg/Include/Protocol/IScsiInitiatorName.h
index 28c92edf2614ce75dc96fd747e754755826e7618..e55c51b7c62ea336741bba6040058a633d418cde 100644 (file)
--- a/MdePkg/Include/Protocol/IScsiInitiatorName.h
+++ b/MdePkg/Include/Protocol/IScsiInitiatorName.h
@@ -1,9 +1,9 @@
 /** @file\r
   EFI_ISCSI_INITIATOR_NAME_PROTOCOL as defined in UEFI 2.0.\r
-  It rovides the ability to get and set the iSCSI Initiator Name.                                                  \r
+  It provides the ability to get and set the iSCSI Initiator Name.                                                  \r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
-  All rights reserved. This program and the accompanying materials                          \r
+  Copyright (c) 2006 - 2011, 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
@@ -29,7 +29,8 @@ typedef struct _EFI_ISCSI_INITIATOR_NAME_PROTOCOL EFI_ISCSI_INITIATOR_NAME_PROTO
   @param  This       Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.\r
   @param  BufferSize Size of the buffer in bytes pointed to by Buffer / Actual size of the\r
                      variable data buffer.\r
-  @param  Buffer     Pointer to the buffer for data to be read.\r
+  @param  Buffer     Pointer to the buffer for data to be read. The data is a null-terminated UTF-8 encoded string.\r
+                     The maximum length is 223 characters, including the null-terminator.\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
@@ -44,8 +45,7 @@ EFI_STATUS
   IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL *This,\r
   IN OUT UINTN                         *BufferSize,\r
   OUT VOID                             *Buffer\r
-  )\r
-;\r
+  );\r
 \r
   \r
 \r
@@ -54,7 +54,8 @@ EFI_STATUS
 \r
   @param  This       Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.\r
   @param  BufferSize Size of the buffer in bytes pointed to by Buffer.\r
-  @param  Buffer     Pointer to the buffer for data to be written.\r
+  @param  Buffer     Pointer to the buffer for data to be written. The data is a null-terminated UTF-8 encoded string.\r
+                     The maximum length is 223 characters, including the null-terminator.\r
 \r
   @retval EFI_SUCCESS           Data was successfully stored by the protocol.\r
   @retval EFI_UNSUPPORTED       Platform policies do not allow for data to be written.\r
@@ -70,9 +71,11 @@ typedef EFI_STATUS
   IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL *This,\r
   IN OUT UINTN                         *BufferSize,\r
   IN VOID                              *Buffer\r
-  )\r
-;  \r
+  );  \r
 \r
+///\r
+/// iSCSI Initiator Name Protocol for setting and obtaining the iSCSI Initiator Name. \r
+///\r
 struct _EFI_ISCSI_INITIATOR_NAME_PROTOCOL {\r
   EFI_ISCSI_INITIATOR_NAME_GET         Get;\r
   EFI_ISCSI_INITIATOR_NAME_SET         Set;\r
@@ -82,9 +85,3 @@ extern EFI_GUID gEfiIScsiInitiatorNameProtocolGuid;
 \r
 #endif\r
 \r
-\r
-\r
-\r
-\r
-\r
-\r