MdePkg: Replace BSD License with BSD+Patent License

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

/** @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
\r
  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __ISCSI_INITIATOR_NAME_H__\r
#define __ISCSI_INITIATOR_NAME_H__\r
\r
#define EFI_ISCSI_INITIATOR_NAME_PROTOCOL_GUID \\r
{ \\r
  0x59324945, 0xec44, 0x4c0d, {0xb1, 0xcd, 0x9d, 0xb1, 0x39, 0xdf, 0x7, 0xc } \\r
}\r
\r
typedef struct _EFI_ISCSI_INITIATOR_NAME_PROTOCOL EFI_ISCSI_INITIATOR_NAME_PROTOCOL;\r
\r
/**\r
  Retrieves the current set value of 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 / Actual size of the\r
                     variable data buffer.\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_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
\r
**/\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
  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. 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
  @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
  @retval EFI_OUT_OF_RESOURCES  Not enough storage is available to hold the data.\r
  @retval EFI_PROTOCOL_ERROR    Input iSCSI initiator name does not adhere to RFC 3720\r
                                (and other related protocols)\r
\r
**/\r
typedef EFI_STATUS\r
(EFIAPI *EFI_ISCSI_INITIATOR_NAME_SET)(\r
  IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL *This,\r
  IN OUT UINTN                         *BufferSize,\r
  IN VOID                              *Buffer\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
\r
extern EFI_GUID gEfiIScsiInitiatorNameProtocolGuid;\r
\r
#endif\r
\r