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