2 Define NVData structures used by the iSCSI configuration component.
4 Copyright (c) 2004 - 2017, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #ifndef _ISCSI_NVDATASTRUC_H_
16 #define _ISCSI_NVDATASTRUC_H_
18 #include <Guid/IScsiConfigHii.h>
20 #define VAR_EQ_TEST_NAME 0x100
21 #define CONFIGURATION_VARSTORE_ID 0x6666
23 #define FORMID_MAIN_FORM 1
24 #define FORMID_MAC_FORM 2
25 #define FORMID_ATTEMPT_FORM 3
26 #define FORMID_ORDER_FORM 4
27 #define FORMID_DELETE_FORM 5
29 #define ISCSI_MAX_ATTEMPTS_NUM FixedPcdGet8 (PcdMaxIScsiAttemptNumber)
31 #define ISCSI_NAME_IFR_MIN_SIZE 4
32 #define ISCSI_NAME_IFR_MAX_SIZE 223
33 #define ISCSI_NAME_MAX_SIZE 224
35 #define ATTEMPT_NAME_LIST_SIZE 96
36 #define ATTEMPT_NAME_SIZE 12
38 #define CONNECT_MIN_RETRY 0
39 #define CONNECT_MAX_RETRY 16
41 #define CONNECT_MIN_TIMEOUT 100
42 #define CONNECT_MAX_TIMEOUT 20000
43 #define CONNECT_DEFAULT_TIMEOUT 1000
45 #define ISCSI_ACTIVE_DISABLED 0
46 #define ISCSI_ACTIVE_ENABLED 1
48 #define ISCSI_DISABLED 0
49 #define ISCSI_ENABLED 1
50 #define ISCSI_ENABLED_FOR_MPIO 2
54 #define IP_MODE_AUTOCONFIG 2
56 #define ISCSI_AUTH_TYPE_NONE 0
57 #define ISCSI_AUTH_TYPE_CHAP 1
58 #define ISCSI_AUTH_TYPE_KRB 2
60 #define IP4_MIN_SIZE 7
61 #define IP4_MAX_SIZE 15
62 #define IP4_STR_MAX_SIZE 16
65 // Macros used for an IPv4 or an IPv6 address.
68 #define IP_MAX_SIZE 39
69 #define IP_STR_MAX_SIZE 40
71 #define LUN_MIN_SIZE 1
72 #define LUN_MAX_SIZE 20
73 #define ISCSI_LUN_STR_MAX_LEN 21
75 #define ISCSI_CHAP_UNI 0
76 #define ISCSI_CHAP_MUTUAL 1
78 #define TARGET_PORT_MIN_NUM 0
79 #define TARGET_PORT_MAX_NUM 65535
80 #define LABEL_END 0xffff
82 #define KEY_INITIATOR_NAME 0x101
83 #define KEY_DHCP_ENABLE 0x102
84 #define KEY_LOCAL_IP 0x103
85 #define KEY_SUBNET_MASK 0x104
86 #define KEY_GATE_WAY 0x105
87 #define KEY_TARGET_IP 0x106
88 #define KEY_CHAP_NAME 0x107
89 #define KEY_CHAP_SECRET 0x108
90 #define KEY_REVERSE_CHAP_NAME 0x109
91 #define KEY_REVERSE_CHAP_SECRET 0x10a
92 #define KEY_SAVE_CHANGES 0x10b
93 #define KEY_TARGET_NAME 0x10c
94 #define KEY_BOOT_LUN 0x10d
96 #define KEY_ADD_ATTEMPT 0x10e
97 #define KEY_SAVE_ATTEMPT_CONFIG 0x10f
98 #define KEY_ORDER_ATTEMPT_CONFIG 0x110
99 #define KEY_SAVE_ORDER_CHANGES 0x111
100 #define KEY_IGNORE_ORDER_CHANGES 0x112
101 #define KEY_ATTEMPT_NAME 0x113
102 #define KEY_SAVE_DELETE_ATTEMPT 0x114
103 #define KEY_IGNORE_DELETE_ATTEMPT 0x115
104 #define KEY_DELETE_ATTEMPT 0x116
106 #define KEY_IP_MODE 0x11c
107 #define KEY_AUTH_TYPE 0x11d
108 #define KEY_CONFIG_ISID 0x11e
110 #define ATTEMPT_ENTRY_LABEL 0x9000
111 #define KEY_ATTEMPT_ENTRY_BASE 0xa000
112 #define KEY_DE_ATTEMPT_ENTRY_BASE 0xb000
114 #define KEY_DEVICE_ENTRY_BASE 0x1000
115 #define KEY_MAC_ENTRY_BASE 0x2000
116 #define MAC_ENTRY_LABEL 0x3000
117 #define ORDER_ENTRY_LABEL 0x4000
118 #define DELETE_ENTRY_LABEL 0x5000
119 #define KEYWORD_ENTRY_LABEL 0x6000
120 #define CONFIG_OPTION_OFFSET 0x9000
122 #define ISCSI_CHAP_SECRET_MIN_LEN 12
123 #define ISCSI_CHAP_SECRET_MAX_LEN 16
125 // ISCSI_CHAP_SECRET_STORAGE = ISCSI_CHAP_SECRET_MAX_LEN + sizeof (NULL-Terminator)
127 #define ISCSI_CHAP_SECRET_STORAGE 17
129 #define ISCSI_CHAP_NAME_MAX_LEN 126
130 #define ISCSI_CHAP_NAME_STORAGE 127
132 #define KERBEROS_SECRET_MIN_LEN 12
133 #define KERBEROS_SECRET_MAX_LEN 16
134 #define KERBEROS_SECRET_STORAGE 17
135 #define KERBEROS_NAME_MAX_LEN 96
136 #define KERBEROS_KDC_PORT_MIN_NUM 0
137 #define KERBEROS_KDC_PORT_MAX_NUM 65535
139 #define ISID_CONFIGURABLE_MIN_LEN 6
140 #define ISID_CONFIGURABLE_MAX_LEN 12
141 #define ISID_CONFIGURABLE_STORAGE 13
144 // sizeof (EFI_MAC_ADDRESS) * 3
146 #define ISCSI_MAX_MAC_STRING_LEN 96
149 /// Macro used for target Url.
151 #define ISCSI_TARGET_URI_MIN_SIZE 0
152 #define ISCSI_TARGET_URI_MAX_SIZE 255
160 CHAR16 ISCSIIsId
[ISID_CONFIGURABLE_STORAGE
];
161 CHAR16 ISCSIInitiatorIpAddress
[IP4_STR_MAX_SIZE
];
162 CHAR16 ISCSIInitiatorNetmask
[IP4_STR_MAX_SIZE
];
163 CHAR16 ISCSIInitiatorGateway
[IP4_STR_MAX_SIZE
];
164 CHAR16 ISCSITargetName
[ISCSI_NAME_MAX_SIZE
];
165 CHAR16 ISCSITargetIpAddress
[ISCSI_TARGET_URI_MAX_SIZE
];
166 CHAR16 ISCSILun
[ISCSI_LUN_STR_MAX_LEN
];
167 CHAR16 ISCSIChapUsername
[ISCSI_CHAP_NAME_STORAGE
];
168 CHAR16 ISCSIChapSecret
[ISCSI_CHAP_SECRET_STORAGE
];
169 CHAR16 ISCSIReverseChapUsername
[ISCSI_CHAP_NAME_STORAGE
];
170 CHAR16 ISCSIReverseChapSecret
[ISCSI_CHAP_SECRET_STORAGE
];
173 typedef struct _ISCSI_CONFIG_IFR_NVDATA
{
174 CHAR16 InitiatorName
[ISCSI_NAME_MAX_SIZE
];
175 CHAR16 AttemptName
[ATTEMPT_NAME_SIZE
];
179 UINT8 ConnectRetryCount
;
181 UINT16 ConnectTimeout
; // Timeout value in milliseconds.
183 UINT8 InitiatorInfoFromDhcp
;
184 UINT8 TargetInfoFromDhcp
;
185 CHAR16 LocalIp
[IP4_STR_MAX_SIZE
];
186 CHAR16 SubnetMask
[IP4_STR_MAX_SIZE
];
187 CHAR16 Gateway
[IP4_STR_MAX_SIZE
];
189 CHAR16 TargetName
[ISCSI_NAME_MAX_SIZE
];
190 CHAR16 TargetIp
[ISCSI_TARGET_URI_MAX_SIZE
];
192 CHAR16 BootLun
[ISCSI_LUN_STR_MAX_LEN
];
194 UINT8 AuthenticationType
;
197 CHAR16 CHAPName
[ISCSI_CHAP_NAME_STORAGE
];
198 CHAR16 CHAPSecret
[ISCSI_CHAP_SECRET_STORAGE
];
199 CHAR16 ReverseCHAPName
[ISCSI_CHAP_NAME_STORAGE
];
200 CHAR16 ReverseCHAPSecret
[ISCSI_CHAP_SECRET_STORAGE
];
202 BOOLEAN MutualRequired
;
204 CHAR16 KerberosUserName
[KERBEROS_NAME_MAX_LEN
];
205 CHAR16 KerberosUserSecret
[KERBEROS_SECRET_STORAGE
];
206 CHAR16 KerberosKDCName
[KERBEROS_NAME_MAX_LEN
];
207 CHAR16 KerberosKDCRealm
[KERBEROS_NAME_MAX_LEN
];
208 CHAR16 KerberosKDCIp
[IP_STR_MAX_SIZE
];
209 UINT16 KerberosKDCPort
;
211 UINT8 DynamicOrderedList
[ISCSI_MAX_ATTEMPTS_NUM
];
212 UINT8 DeleteAttemptList
[ISCSI_MAX_ATTEMPTS_NUM
];
213 UINT8 AddAttemptList
[ISCSI_MAX_ATTEMPTS_NUM
];
214 CHAR16 IsId
[ISID_CONFIGURABLE_STORAGE
];
217 // This will be used by keywords.
219 CHAR16 ISCSIMacAddr
[ISCSI_MAX_MAC_STRING_LEN
];
220 CHAR16 ISCSIAttemptOrder
[ATTEMPT_NAME_LIST_SIZE
];
221 CHAR16 ISCSIAddAttemptList
[ATTEMPT_NAME_LIST_SIZE
];
222 CHAR16 ISCSIDeleteAttemptList
[ATTEMPT_NAME_LIST_SIZE
];
223 CHAR16 ISCSIDisplayAttemptList
[ATTEMPT_NAME_LIST_SIZE
];
224 CHAR16 ISCSIAttemptName
[ATTEMPT_NAME_LIST_SIZE
];
225 UINT8 ISCSIBootEnableList
[ISCSI_MAX_ATTEMPTS_NUM
];
226 UINT8 ISCSIIpAddressTypeList
[ISCSI_MAX_ATTEMPTS_NUM
];
227 UINT8 ISCSIConnectRetry
[ISCSI_MAX_ATTEMPTS_NUM
];
228 UINT16 ISCSIConnectTimeout
[ISCSI_MAX_ATTEMPTS_NUM
];
229 UINT8 ISCSIInitiatorInfoViaDHCP
[ISCSI_MAX_ATTEMPTS_NUM
];
230 UINT8 ISCSITargetInfoViaDHCP
[ISCSI_MAX_ATTEMPTS_NUM
];
231 UINT16 ISCSITargetTcpPort
[ISCSI_MAX_ATTEMPTS_NUM
];
232 UINT8 ISCSIAuthenticationMethod
[ISCSI_MAX_ATTEMPTS_NUM
];
233 UINT8 ISCSIChapType
[ISCSI_MAX_ATTEMPTS_NUM
];
234 KEYWORD_STR Keyword
[ISCSI_MAX_ATTEMPTS_NUM
];
235 } ISCSI_CONFIG_IFR_NVDATA
;