1. Update iSCSI UI to be more user-friendly.

[mirror_edk2.git] / NetworkPkg / IScsiDxe / IScsiInitiatorName.c

/** @file\r
  Implementation for EFI iSCSI Initiator Name Protocol.\r
\r
Copyright (c) 2004 - 2011, 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
\r
**/\r
\r
#include "IScsiImpl.h"\r
\r
EFI_ISCSI_INITIATOR_NAME_PROTOCOL gIScsiInitiatorName = {\r
  IScsiGetInitiatorName,\r
  IScsiSetInitiatorName\r
};\r
\r
\r
/**\r
  Retrieves the current set value of iSCSI Initiator Name.\r
\r
  @param[in]       This          Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL\r
                                 instance.\r
  @param[in, out]  BufferSize    Size of the buffer in bytes pointed to by Buffer /\r
                                 Actual size of the variable data buffer.\r
  @param[out]      Buffer        Pointer to the buffer for data to be read.\r
                                 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\r
                                 buffer and the BufferSize was sufficient to handle\r
                                 the iSCSI initiator name.\r
  @retval EFI_BUFFER_TOO_SMALL   BufferSize is too small for the result. BufferSize\r
                                 will be updated with the size required to complete\r
                                 the request. Buffer will not be affected.\r
  @retval EFI_INVALID_PARAMETER  BufferSize is NULL. BufferSize and Buffer will not\r
                                 be affected.\r
  @retval EFI_INVALID_PARAMETER  Buffer is NULL. BufferSize and Buffer will not be\r
                                 affected.\r
  @retval EFI_DEVICE_ERROR       The iSCSI initiator name could not be retrieved\r
                                 due to a hardware error.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
IScsiGetInitiatorName (\r
  IN     EFI_ISCSI_INITIATOR_NAME_PROTOCOL  *This,\r
  IN OUT UINTN                              *BufferSize,\r
  OUT    VOID                               *Buffer\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  if ((BufferSize == NULL) || (Buffer == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Status = gRT->GetVariable (\r
                  ISCSI_INITIATOR_NAME_VAR_NAME,\r
                  &gEfiIScsiInitiatorNameProtocolGuid,\r
                  NULL,\r
                  BufferSize,\r
                  Buffer\r
                  );\r
\r
  return Status;\r
}\r
\r
\r
/**\r
  Sets the iSSI Initiator Name.\r
\r
  @param[in]       This          Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL\r
                                 instance.\r
  @param[in, out]  BufferSize    Size of the buffer in bytes pointed to by Buffer.\r
  @param[in]       Buffer        Pointer to the buffer for data to be written.\r
                                 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\r
                                 written.\r
  @retval EFI_INVALID_PARAMETER  BufferSize exceeds the maximum allowed limit.\r
                                 BufferSize will be updated with the maximum size\r
                                 required to complete the request.\r
  @retval EFI_INVALID_PARAMETER  Buffersize is NULL. BufferSize and Buffer will not\r
                                 be affected.\r
  @retval EFI_INVALID_PARAMETER  Buffer is NULL. BufferSize and Buffer will not be\r
                                 affected.\r
  @retval EFI_DEVICE_ERROR       The data could not be stored due to a hardware\r
                                 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\r
                                 3720\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
IScsiSetInitiatorName (\r
  IN     EFI_ISCSI_INITIATOR_NAME_PROTOCOL  *This,\r
  IN OUT UINTN                              *BufferSize,\r
  IN     VOID                               *Buffer\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  if ((BufferSize == NULL) || (Buffer == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (*BufferSize > ISCSI_NAME_MAX_SIZE) {\r
    *BufferSize = ISCSI_NAME_MAX_SIZE;\r
    return EFI_INVALID_PARAMETER;\r
  }\r
  //\r
  // Only support iqn iSCSI names.\r
  //\r
  Status = IScsiNormalizeName ((CHAR8 *) Buffer, *BufferSize - 1);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = gRT->SetVariable (\r
                  ISCSI_INITIATOR_NAME_VAR_NAME,\r
                  &gEfiIScsiInitiatorNameProtocolGuid,\r
                  EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
                  *BufferSize,\r
                  Buffer\r
                  );\r
\r
  return Status;\r
}\r