]> git.proxmox.com Git - mirror_edk2.git/blame - NetworkPkg/IScsiDxe/IScsiConfigNVDataStruc.h
NetworkPkg: Apply uncrustify changes
[mirror_edk2.git] / NetworkPkg / IScsiDxe / IScsiConfigNVDataStruc.h
CommitLineData
4c5a5e0c 1/** @file\r
2 Define NVData structures used by the iSCSI configuration component.\r
3\r
eabc6e59 4Copyright (c) 2004 - 2017, Intel Corporation. All rights reserved.<BR>\r
ecf98fbc 5SPDX-License-Identifier: BSD-2-Clause-Patent\r
4c5a5e0c 6\r
7**/\r
8\r
9#ifndef _ISCSI_NVDATASTRUC_H_\r
10#define _ISCSI_NVDATASTRUC_H_\r
11\r
9bdc6592 12#include <Guid/IScsiConfigHii.h>\r
4c5a5e0c 13\r
d1050b9d
MK
14#define VAR_EQ_TEST_NAME 0x100\r
15#define CONFIGURATION_VARSTORE_ID 0x6666\r
4c5a5e0c 16\r
d1050b9d
MK
17#define FORMID_MAIN_FORM 1\r
18#define FORMID_MAC_FORM 2\r
19#define FORMID_ATTEMPT_FORM 3\r
20#define FORMID_ORDER_FORM 4\r
21#define FORMID_DELETE_FORM 5\r
4c5a5e0c 22\r
d1050b9d 23#define ISCSI_MAX_ATTEMPTS_NUM FixedPcdGet8 (PcdMaxIScsiAttemptNumber)\r
8d1f5e04 24\r
d1050b9d
MK
25#define ISCSI_NAME_IFR_MIN_SIZE 4\r
26#define ISCSI_NAME_IFR_MAX_SIZE 223\r
27#define ISCSI_NAME_MAX_SIZE 224\r
4c5a5e0c 28\r
d1050b9d
MK
29#define ATTEMPT_NAME_LIST_SIZE 96\r
30#define ATTEMPT_NAME_SIZE 12\r
4c5a5e0c 31\r
d1050b9d
MK
32#define CONNECT_MIN_RETRY 0\r
33#define CONNECT_MAX_RETRY 16\r
4c5a5e0c 34\r
d1050b9d
MK
35#define CONNECT_MIN_TIMEOUT 100\r
36#define CONNECT_MAX_TIMEOUT 20000\r
37#define CONNECT_DEFAULT_TIMEOUT 1000\r
4c5a5e0c 38\r
d1050b9d
MK
39#define ISCSI_ACTIVE_DISABLED 0\r
40#define ISCSI_ACTIVE_ENABLED 1\r
4c5a5e0c 41\r
d1050b9d
MK
42#define ISCSI_DISABLED 0\r
43#define ISCSI_ENABLED 1\r
44#define ISCSI_ENABLED_FOR_MPIO 2\r
4c5a5e0c 45\r
d1050b9d
MK
46#define IP_MODE_IP4 0\r
47#define IP_MODE_IP6 1\r
48#define IP_MODE_AUTOCONFIG 2\r
4c5a5e0c 49\r
d1050b9d
MK
50#define ISCSI_AUTH_TYPE_NONE 0\r
51#define ISCSI_AUTH_TYPE_CHAP 1\r
52#define ISCSI_AUTH_TYPE_KRB 2\r
4c5a5e0c 53\r
d1050b9d
MK
54#define IP4_MIN_SIZE 7\r
55#define IP4_MAX_SIZE 15\r
56#define IP4_STR_MAX_SIZE 16\r
4c5a5e0c 57\r
58//\r
59// Macros used for an IPv4 or an IPv6 address.\r
60//\r
d1050b9d
MK
61#define IP_MIN_SIZE 2\r
62#define IP_MAX_SIZE 39\r
63#define IP_STR_MAX_SIZE 40\r
64\r
65#define LUN_MIN_SIZE 1\r
66#define LUN_MAX_SIZE 20\r
67#define ISCSI_LUN_STR_MAX_LEN 21\r
68\r
69#define ISCSI_CHAP_UNI 0\r
70#define ISCSI_CHAP_MUTUAL 1\r
71\r
72#define TARGET_PORT_MIN_NUM 0\r
73#define TARGET_PORT_MAX_NUM 65535\r
74#define LABEL_END 0xffff\r
75\r
76#define KEY_INITIATOR_NAME 0x101\r
77#define KEY_DHCP_ENABLE 0x102\r
78#define KEY_LOCAL_IP 0x103\r
79#define KEY_SUBNET_MASK 0x104\r
80#define KEY_GATE_WAY 0x105\r
81#define KEY_TARGET_IP 0x106\r
82#define KEY_CHAP_NAME 0x107\r
83#define KEY_CHAP_SECRET 0x108\r
84#define KEY_REVERSE_CHAP_NAME 0x109\r
85#define KEY_REVERSE_CHAP_SECRET 0x10a\r
86#define KEY_SAVE_CHANGES 0x10b\r
87#define KEY_TARGET_NAME 0x10c\r
88#define KEY_BOOT_LUN 0x10d\r
89\r
90#define KEY_ADD_ATTEMPT 0x10e\r
91#define KEY_SAVE_ATTEMPT_CONFIG 0x10f\r
92#define KEY_ORDER_ATTEMPT_CONFIG 0x110\r
93#define KEY_SAVE_ORDER_CHANGES 0x111\r
94#define KEY_IGNORE_ORDER_CHANGES 0x112\r
95#define KEY_ATTEMPT_NAME 0x113\r
96#define KEY_SAVE_DELETE_ATTEMPT 0x114\r
97#define KEY_IGNORE_DELETE_ATTEMPT 0x115\r
98#define KEY_DELETE_ATTEMPT 0x116\r
99\r
100#define KEY_IP_MODE 0x11c\r
101#define KEY_AUTH_TYPE 0x11d\r
102#define KEY_CONFIG_ISID 0x11e\r
103\r
104#define ATTEMPT_ENTRY_LABEL 0x9000\r
105#define KEY_ATTEMPT_ENTRY_BASE 0xa000\r
106#define KEY_DE_ATTEMPT_ENTRY_BASE 0xb000\r
107\r
108#define KEY_DEVICE_ENTRY_BASE 0x1000\r
109#define KEY_MAC_ENTRY_BASE 0x2000\r
110#define MAC_ENTRY_LABEL 0x3000\r
111#define ORDER_ENTRY_LABEL 0x4000\r
112#define DELETE_ENTRY_LABEL 0x5000\r
113#define KEYWORD_ENTRY_LABEL 0x6000\r
114#define CONFIG_OPTION_OFFSET 0x9000\r
115\r
116#define ISCSI_CHAP_SECRET_MIN_LEN 12\r
117#define ISCSI_CHAP_SECRET_MAX_LEN 16\r
4c5a5e0c 118//\r
119// ISCSI_CHAP_SECRET_STORAGE = ISCSI_CHAP_SECRET_MAX_LEN + sizeof (NULL-Terminator)\r
120//\r
8d1f5e04
ZL
121#define ISCSI_CHAP_SECRET_STORAGE 17\r
122\r
d1050b9d
MK
123#define ISCSI_CHAP_NAME_MAX_LEN 126\r
124#define ISCSI_CHAP_NAME_STORAGE 127\r
4c5a5e0c 125\r
d1050b9d
MK
126#define KERBEROS_SECRET_MIN_LEN 12\r
127#define KERBEROS_SECRET_MAX_LEN 16\r
128#define KERBEROS_SECRET_STORAGE 17\r
129#define KERBEROS_NAME_MAX_LEN 96\r
130#define KERBEROS_KDC_PORT_MIN_NUM 0\r
131#define KERBEROS_KDC_PORT_MAX_NUM 65535\r
4c5a5e0c 132\r
d1050b9d
MK
133#define ISID_CONFIGURABLE_MIN_LEN 6\r
134#define ISID_CONFIGURABLE_MAX_LEN 12\r
135#define ISID_CONFIGURABLE_STORAGE 13\r
4c5a5e0c 136\r
8d1f5e04
ZL
137//\r
138// sizeof (EFI_MAC_ADDRESS) * 3\r
139//\r
d1050b9d 140#define ISCSI_MAX_MAC_STRING_LEN 96\r
8d1f5e04 141\r
eabc6e59
ZL
142///\r
143/// Macro used for target Url.\r
144///\r
d1050b9d
MK
145#define ISCSI_TARGET_URI_MIN_SIZE 0\r
146#define ISCSI_TARGET_URI_MAX_SIZE 255\r
eabc6e59 147\r
4c5a5e0c 148#pragma pack(1)\r
8d1f5e04
ZL
149\r
150//\r
151// Used by keyword.\r
152//\r
153typedef struct {\r
d1050b9d
MK
154 CHAR16 ISCSIIsId[ISID_CONFIGURABLE_STORAGE];\r
155 CHAR16 ISCSIInitiatorIpAddress[IP4_STR_MAX_SIZE];\r
156 CHAR16 ISCSIInitiatorNetmask[IP4_STR_MAX_SIZE];\r
157 CHAR16 ISCSIInitiatorGateway[IP4_STR_MAX_SIZE];\r
158 CHAR16 ISCSITargetName[ISCSI_NAME_MAX_SIZE];\r
159 CHAR16 ISCSITargetIpAddress[ISCSI_TARGET_URI_MAX_SIZE];\r
160 CHAR16 ISCSILun[ISCSI_LUN_STR_MAX_LEN];\r
161 CHAR16 ISCSIChapUsername[ISCSI_CHAP_NAME_STORAGE];\r
162 CHAR16 ISCSIChapSecret[ISCSI_CHAP_SECRET_STORAGE];\r
163 CHAR16 ISCSIReverseChapUsername[ISCSI_CHAP_NAME_STORAGE];\r
164 CHAR16 ISCSIReverseChapSecret[ISCSI_CHAP_SECRET_STORAGE];\r
8d1f5e04
ZL
165} KEYWORD_STR;\r
166\r
4c5a5e0c 167typedef struct _ISCSI_CONFIG_IFR_NVDATA {\r
d1050b9d
MK
168 CHAR16 InitiatorName[ISCSI_NAME_MAX_SIZE];\r
169 CHAR16 AttemptName[ATTEMPT_NAME_SIZE];\r
170 UINT8 Enabled;\r
171 UINT8 IpMode;\r
172\r
173 UINT8 ConnectRetryCount;\r
174 UINT8 Padding1;\r
175 UINT16 ConnectTimeout; // Timeout value in milliseconds.\r
176\r
177 UINT8 InitiatorInfoFromDhcp;\r
178 UINT8 TargetInfoFromDhcp;\r
179 CHAR16 LocalIp[IP4_STR_MAX_SIZE];\r
180 CHAR16 SubnetMask[IP4_STR_MAX_SIZE];\r
181 CHAR16 Gateway[IP4_STR_MAX_SIZE];\r
182\r
183 CHAR16 TargetName[ISCSI_NAME_MAX_SIZE];\r
184 CHAR16 TargetIp[ISCSI_TARGET_URI_MAX_SIZE];\r
185 UINT16 TargetPort;\r
186 CHAR16 BootLun[ISCSI_LUN_STR_MAX_LEN];\r
187\r
188 UINT8 AuthenticationType;\r
189\r
190 UINT8 CHAPType;\r
191 CHAR16 CHAPName[ISCSI_CHAP_NAME_STORAGE];\r
192 CHAR16 CHAPSecret[ISCSI_CHAP_SECRET_STORAGE];\r
193 CHAR16 ReverseCHAPName[ISCSI_CHAP_NAME_STORAGE];\r
194 CHAR16 ReverseCHAPSecret[ISCSI_CHAP_SECRET_STORAGE];\r
195\r
196 BOOLEAN MutualRequired;\r
197 UINT8 Padding2;\r
198 CHAR16 KerberosUserName[KERBEROS_NAME_MAX_LEN];\r
199 CHAR16 KerberosUserSecret[KERBEROS_SECRET_STORAGE];\r
200 CHAR16 KerberosKDCName[KERBEROS_NAME_MAX_LEN];\r
201 CHAR16 KerberosKDCRealm[KERBEROS_NAME_MAX_LEN];\r
202 CHAR16 KerberosKDCIp[IP_STR_MAX_SIZE];\r
203 UINT16 KerberosKDCPort;\r
204\r
205 UINT8 DynamicOrderedList[ISCSI_MAX_ATTEMPTS_NUM];\r
206 UINT8 DeleteAttemptList[ISCSI_MAX_ATTEMPTS_NUM];\r
207 UINT8 AddAttemptList[ISCSI_MAX_ATTEMPTS_NUM];\r
208 CHAR16 IsId[ISID_CONFIGURABLE_STORAGE];\r
8d1f5e04
ZL
209\r
210 //\r
211 // This will be used by keywords.\r
212 //\r
d1050b9d
MK
213 CHAR16 ISCSIMacAddr[ISCSI_MAX_MAC_STRING_LEN];\r
214 CHAR16 ISCSIAttemptOrder[ATTEMPT_NAME_LIST_SIZE];\r
215 CHAR16 ISCSIAddAttemptList[ATTEMPT_NAME_LIST_SIZE];\r
216 CHAR16 ISCSIDeleteAttemptList[ATTEMPT_NAME_LIST_SIZE];\r
217 CHAR16 ISCSIDisplayAttemptList[ATTEMPT_NAME_LIST_SIZE];\r
218 CHAR16 ISCSIAttemptName[ATTEMPT_NAME_LIST_SIZE];\r
219 UINT8 ISCSIBootEnableList[ISCSI_MAX_ATTEMPTS_NUM];\r
220 UINT8 ISCSIIpAddressTypeList[ISCSI_MAX_ATTEMPTS_NUM];\r
221 UINT8 ISCSIConnectRetry[ISCSI_MAX_ATTEMPTS_NUM];\r
222 UINT16 ISCSIConnectTimeout[ISCSI_MAX_ATTEMPTS_NUM];\r
223 UINT8 ISCSIInitiatorInfoViaDHCP[ISCSI_MAX_ATTEMPTS_NUM];\r
224 UINT8 ISCSITargetInfoViaDHCP[ISCSI_MAX_ATTEMPTS_NUM];\r
225 UINT16 ISCSITargetTcpPort[ISCSI_MAX_ATTEMPTS_NUM];\r
226 UINT8 ISCSIAuthenticationMethod[ISCSI_MAX_ATTEMPTS_NUM];\r
227 UINT8 ISCSIChapType[ISCSI_MAX_ATTEMPTS_NUM];\r
228 KEYWORD_STR Keyword[ISCSI_MAX_ATTEMPTS_NUM];\r
4c5a5e0c 229} ISCSI_CONFIG_IFR_NVDATA;\r
230#pragma pack()\r
231\r
232#endif\r