EdkCompatibilityPkg/Foundation/Efi/Protocol/IScsiInitiatorName/IScsiInitiatorName.h

   1 /*++
   2   Copyright (c) 2006, Intel Corporation. All rights reserved.<BR>
   3   This program and the accompanying materials
   4   are licensed and made available under the terms and conditions of the BSD License
   5   which accompanies this distribution.  The full text of the license may be found at
   6   http://opensource.org/licenses/bsd-license.php
   7
   8   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
   9   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  10
  11 Module Name:
  12
  13     IScsiInitatorName.h
  14
  15 Abstract:
  16   EFI_ISCSI_INITIATOR_NAME_PROTOCOL as defined in UEFI 2.0.
  17   It rovides the ability to get and set the iSCSI Initiator Name.
  18
  19 Revision History
  20
  21 --*/
  22
  23 #ifndef __ISCSI_INITIATOR_NAME_H__
  24 #define __ISCSI_INITIATOR_NAME_H__
  25
  26 #define EFI_ISCSI_INITIATOR_NAME_PROTOCOL_GUID \
  27 { \
  28   0x59324945, 0xec44, 0x4c0d, {0xb1, 0xcd, 0x9d, 0xb1, 0x39, 0xdf, 0x7, 0xc } \
  29 }
  30
  31 typedef struct _EFI_ISCSI_INITIATOR_NAME_PROTOCOL EFI_ISCSI_INITIATOR_NAME_PROTOCOL;
  32
  33 typedef
  34 EFI_STATUS
  35 (EFIAPI *EFI_ISCSI_INITIATOR_NAME_GET) (
  36   IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL *This,
  37   IN OUT UINTN                         *BufferSize,
  38   OUT VOID                             *Buffer
  39   )
  40 /*++
  41
  42   Routine Description:
  43     Retrieves the current set value of iSCSI Initiator Name.
  44
  45   Arguments:
  46     This         - Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.
  47     BufferSize   - Size of the buffer in bytes pointed to by Buffer / Actual size of the
  48                    variable data buffer.
  49     Buffer       - Pointer to the buffer for data to be read.
  50
  51   Returns:
  52     EFI_SUCCESS           - Data was successfully retrieved into the provided buffer and the
  53                             BufferSize was sufficient to handle the iSCSI initiator name
  54     EFI_BUFFER_TOO_SMALL  - BufferSize is too small for the result.
  55     EFI_INVALID_PARAMETER - BufferSize or Buffer is NULL.
  56     EFI_DEVICE_ERROR      - The iSCSI initiator name could not be retrieved due to a hardware error.
  57
  58 --*/
  59 ;
  60
  61
  62
  63 typedef EFI_STATUS
  64 (EFIAPI *EFI_ISCSI_INITIATOR_NAME_SET) (
  65   IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL *This,
  66   IN OUT UINTN                         *BufferSize,
  67   IN VOID                              *Buffer
  68   )
  69 /*++
  70
  71   Routine Description:
  72     Sets the iSCSI Initiator Name.
  73
  74   Arguments:
  75     This       - Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.
  76     BufferSize - Size of the buffer in bytes pointed to by Buffer.
  77     Buffer     - Pointer to the buffer for data to be written.
  78
  79   Returns:
  80     EFI_SUCCESS           - Data was successfully stored by the protocol.
  81     EFI_UNSUPPORTED       - Platform policies do not allow for data to be written.
  82     EFI_INVALID_PARAMETER - BufferSize or Buffer is NULL, or BufferSize exceeds the maximum allowed limit.
  83     EFI_DEVICE_ERROR      - The data could not be stored due to a hardware error.
  84     EFI_OUT_OF_RESOURCES  - Not enough storage is available to hold the data.
  85     EFI_PROTOCOL_ERROR    - Input iSCSI initiator name does not adhere to RFC 3720
  86                             (and other related protocols)
  87
  88 --*/
  89 ;
  90
  91 struct _EFI_ISCSI_INITIATOR_NAME_PROTOCOL {
  92   EFI_ISCSI_INITIATOR_NAME_GET         Get;
  93   EFI_ISCSI_INITIATOR_NAME_SET         Set;
  94 };
  95
  96 extern EFI_GUID gEfiIScsiInitiatorNameProtocolGuid;
  97
  98 #endif