diff options
| author | ywu21 <ywu21@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-12-05 11:52:54 +0000 |
|---|---|---|
| committer | ywu21 <ywu21@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-12-05 11:52:54 +0000 |
| commit | fb89ee51af64b81716691231abcedb5e5b24c437 (patch) | |
| tree | d9b1eaca5bcf6cf492037f59b0be7612ce528ddb | |
| parent | 93173f0e3b9d70b7268d770cd03ef1cbf4075d4c (diff) | |
| download | edk2-platforms-fb89ee51af64b81716691231abcedb5e5b24c437.tar.xz | |
for 202033
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6879 6f19259b-4bc3-4df7-8a09-765794883524
| -rw-r--r-- | MdeModulePkg/Universal/Network/IScsiDxe/IScsiInitiatorName.h | 97 |
1 files changed, 97 insertions, 0 deletions
diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiInitiatorName.h b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiInitiatorName.h new file mode 100644 index 0000000000..6e0eda2158 --- /dev/null +++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiInitiatorName.h @@ -0,0 +1,97 @@ +/** @file
+ The header file of IScsi initiator name protocol.
+
+Copyright (c) 2004 - 2008, Intel Corporation.<BR>
+All rights reserved. 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
+http://opensource.org/licenses/bsd-license.php
+
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+
+**/
+
+#ifndef _ISCSI_INITIATORNAME_H_
+#define _ISCSI_INITIATORNAME_H_
+
+#include <Protocol/IScsiInitiatorName.h>
+
+extern EFI_ISCSI_INITIATOR_NAME_PROTOCOL gIScsiInitiatorName;
+
+//
+// EFI IScsi Initiator Name Protocol for IScsi driver.
+//
+/**
+ Retrieves the current set value of iSCSI Initiator Name.
+
+ @param This[in] Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.
+
+ @param BufferSize[in][out] Size of the buffer in bytes pointed to by Buffer / Actual
+ size of the variable data buffer.
+
+ @param Buffer[out] Pointer to the buffer for data to be read.
+
+ @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.
+
+**/
+EFI_STATUS
+EFIAPI
+IScsiGetInitiatorName (
+ IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL *This,
+ IN OUT UINTN *BufferSize,
+ OUT VOID *Buffer
+ );
+
+/**
+ Sets the iSCSI Initiator Name.
+
+ @param This[in] Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.
+
+ @param BufferSize[in][out] Size of the buffer in bytes pointed to by Buffer.
+
+ @param Buffer[out] Pointer to the buffer for data to be written.
+
+ @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.
+
+**/
+EFI_STATUS
+EFIAPI
+IScsiSetInitiatorName (
+ IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL *This,
+ IN OUT UINTN *BufferSize,
+ OUT VOID *Buffer
+ );
+
+#endif
\ No newline at end of file |