/** @file
Implementation for EFI iSCSI Initiator Name Protocol.
Copyright (c) 2004 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include "IScsiImpl.h"
};
/**
Retrieves the current set value of iSCSI Initiator Name.
@param[in] This Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL
instance.
@param[in, out] BufferSize Size of the buffer in bytes pointed to by Buffer /
Actual size of the variable data buffer.
@param[out] Buffer Pointer to the buffer for data to be read.
The data is a null-terminated UTF-8 encoded string.
The maximum length is 223 characters, including the null-terminator.
@retval EFI_SUCCESS Data was successfully retrieved into the provided
buffer and the BufferSize was sufficient to handle
the iSCSI initiator name.
@retval EFI_BUFFER_TOO_SMALL BufferSize is too small for the result. BufferSize
will be updated with the size required to complete
the request. Buffer will not be affected.
@retval EFI_INVALID_PARAMETER BufferSize is NULL. BufferSize and Buffer will not
be affected.
@retval EFI_INVALID_PARAMETER Buffer is NULL. BufferSize and Buffer will not be
affected.
@retval EFI_DEVICE_ERROR The iSCSI initiator name could not be retrieved
due to a hardware error.
**/
)
{
return EFI_INVALID_PARAMETER;
}
NULL,
);
return Status;
}
/**
Sets the iSSI Initiator Name.
@param[in] This Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL
instance.
@param[in, out] BufferSize Size of the buffer in bytes pointed to by Buffer.
@param[in] Buffer Pointer to the buffer for data to be written.
The data is a null-terminated UTF-8 encoded string.
The maximum length is 223 characters, including the null-terminator.
@retval EFI_SUCCESS Data was successfully stored by the protocol.
@retval EFI_UNSUPPORTED Platform policies do not allow for data to be
written.
@retval EFI_INVALID_PARAMETER BufferSize exceeds the maximum allowed limit.
BufferSize will be updated with the maximum size
required to complete the request.
@retval EFI_INVALID_PARAMETER Buffersize is NULL. BufferSize and Buffer will not
be affected.
@retval EFI_INVALID_PARAMETER Buffer is NULL. BufferSize and Buffer will not be
affected.
@retval EFI_DEVICE_ERROR The data could not be stored due to a hardware
error.
@retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the data
@retval EFI_PROTOCOL_ERROR Input iSCSI initiator name does not adhere to RFC
3720
**/
)
{
return EFI_INVALID_PARAMETER;
}
if (*BufferSize > ISCSI_NAME_MAX_SIZE) {
return EFI_INVALID_PARAMETER;
}
//
// Only support iqn iSCSI names.
//
return Status;
}
);
return Status;
}