]>
Commit | Line | Data |
---|---|---|
b263ee17 | 1 | /** @file\r |
2 | The header file for EFI iSCSI Initiator Name Protocol.\r | |
3 | \r | |
4 | Copyright (c) 2004 - 2008, Intel Corporation.<BR>\r | |
5 | All rights reserved. This program and the accompanying materials\r | |
6 | are licensed and made available under the terms and conditions of the BSD License\r | |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php\r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | \r | |
13 | **/\r | |
14 | \r | |
15 | #ifndef _ISCSI_INITIATOR_NAME_H_\r | |
16 | #define _ISCSI_INITIATOR_NAME_H_\r | |
17 | \r | |
18 | #include <Protocol/IScsiInitiatorName.h>\r | |
19 | \r | |
20 | extern EFI_ISCSI_INITIATOR_NAME_PROTOCOL gIScsiInitiatorName;\r | |
21 | \r | |
22 | //\r | |
55a64ae0 | 23 | // EFI iSCSI Initiator Name Protocol for IScsi driver.\r |
b263ee17 | 24 | //\r |
25 | \r | |
26 | /**\r | |
27 | Retrieves the current set value of iSCSI Initiator Name.\r | |
28 | \r | |
29 | @param[in] This Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.\r | |
30 | @param[in, out] BufferSize Size of the buffer in bytes pointed to by Buffer / Actual size of the\r | |
31 | variable data buffer.\r | |
32 | @param[out] Buffer Pointer to the buffer for data to be read.\r | |
33 | \r | |
34 | @retval EFI_SUCCESS Data was successfully retrieved into the provided buffer and the\r | |
55a64ae0 | 35 | BufferSize was sufficient to handle the iSCSI initiator name.\r |
b263ee17 | 36 | @retval EFI_BUFFER_TOO_SMALL BufferSize is too small for the result.\r |
37 | @retval EFI_INVALID_PARAMETER BufferSize or Buffer is NULL.\r | |
38 | @retval EFI_DEVICE_ERROR The iSCSI initiator name could not be retrieved due to a hardware error.\r | |
39 | @retval Others Other errors as indicated.\r | |
40 | **/\r | |
41 | EFI_STATUS\r | |
42 | EFIAPI\r | |
43 | IScsiGetInitiatorName (\r | |
44 | IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL *This,\r | |
45 | IN OUT UINTN *BufferSize,\r | |
46 | OUT VOID *Buffer\r | |
47 | );\r | |
48 | \r | |
49 | /**\r | |
50 | Sets the iSCSI Initiator Name.\r | |
51 | \r | |
52 | @param[in] This Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.\r | |
53 | @param[in, out] BufferSize Size of the buffer in bytes pointed to by Buffer.\r | |
54 | @param[in] Buffer Pointer to the buffer for data to be written.\r | |
55 | \r | |
56 | @retval EFI_SUCCESS Data was successfully stored by the protocol.\r | |
57 | @retval EFI_UNSUPPORTED Platform policies do not allow for data to be written.\r | |
58 | Currently not implemented.\r | |
59 | @retval EFI_INVALID_PARAMETER BufferSize or Buffer is NULL, or BufferSize exceeds the maximum allowed limit.\r | |
60 | @retval EFI_DEVICE_ERROR The data could not be stored due to a hardware error.\r | |
61 | @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the data.\r | |
62 | @retval EFI_PROTOCOL_ERROR Input iSCSI initiator name does not adhere to RFC 3720\r | |
55a64ae0 | 63 | (and other related protocols).\r |
b263ee17 | 64 | @retval Others Other errors as indicated.\r |
65 | **/\r | |
66 | EFI_STATUS\r | |
67 | EFIAPI\r | |
68 | IScsiSetInitiatorName (\r | |
69 | IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL *This,\r | |
70 | IN OUT UINTN *BufferSize,\r | |
71 | IN VOID *Buffer\r | |
72 | );\r | |
73 | \r | |
74 | #endif\r |