MdePkg FirmwareManagement.h: Fix code style issue

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

diff --git a/MdePkg/Include/Protocol/IScsiInitiatorName.h b/MdePkg/Include/Protocol/IScsiInitiatorName.h
index 1b947d850604eb14f2a8ae8a6c7d705d1f9f0f05..a172f54269c3e2051a20406e45e3a2c16a466012 100644 (file)
--- a/MdePkg/Include/Protocol/IScsiInitiatorName.h
+++ b/MdePkg/Include/Protocol/IScsiInitiatorName.h
@@ -1,15 +1,15 @@
 /** @file\r
   EFI_ISCSI_INITIATOR_NAME_PROTOCOL as defined in UEFI 2.0.\r
-  It provides 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 - 2008, Intel Corporation                                                         \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
-  http://opensource.org/licenses/bsd-license.php                                            \r
+  Copyright (c) 2006 - 2018, 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
 \r
-  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
+  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
 **/\r
 \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
@@ -38,7 +39,7 @@ typedef struct _EFI_ISCSI_INITIATOR_NAME_PROTOCOL EFI_ISCSI_INITIATOR_NAME_PROTO
   @retval EFI_DEVICE_ERROR      The iSCSI initiator name could not be retrieved due to a hardware error.\r
 \r
 **/\r
-typedef \r
+typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_ISCSI_INITIATOR_NAME_GET)(\r
   IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL *This,\r
@@ -46,14 +47,15 @@ EFI_STATUS
   OUT VOID                             *Buffer\r
   );\r
 \r
-  \r
+\r
 \r
 /**\r
   Sets the iSCSI Initiator Name.\r
 \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
@@ -69,10 +71,10 @@ typedef EFI_STATUS
   IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL *This,\r
   IN OUT UINTN                         *BufferSize,\r
   IN VOID                              *Buffer\r
-  );  \r
+  );\r
 \r
 ///\r
-/// iSCSI Initiator Name Protocol for setting and obtaining the iSCSI Initiator Name. \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
@@ -83,9 +85,3 @@ extern EFI_GUID gEfiIScsiInitiatorNameProtocolGuid;
 \r
 #endif\r
 \r
-\r
-\r
-\r
-\r
-\r
-\r