/** @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 - 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
-\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
+ Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+ SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\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 / 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
@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
IN OUT UINTN *BufferSize,\r
OUT VOID *Buffer\r
- )\r
-;\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
IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL *This,\r
IN OUT UINTN *BufferSize,\r
IN VOID *Buffer\r
- )\r
-; \r
-\r
-/** \r
- @par Protocol Description:\r
- iSCSI Initiator Name Protocol for setting and obtaining the iSCSI Initiator Name. \r
- \r
- @param Get Used to retrieve the iSCSI Initiator Name.\r
+ );\r
\r
- @param Set Used to set the iSCSI Initiator Name.\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
\r
#endif\r
\r
-\r
-\r
-\r
-\r
-\r
-\r