[mirror_edk2.git] / NetworkPkg / IScsiDxe / IScsiConfigNVDataStruc.h

/** @file\r
  Define NVData structures used by the iSCSI configuration component.\r
\r
Copyright (c) 2004 - 2011, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef _ISCSI_NVDATASTRUC_H_\r
#define _ISCSI_NVDATASTRUC_H_\r
\r
#include <Guid/IScsiConfigHii.h>\r
\r
#define VAR_EQ_TEST_NAME          0x100\r
#define CONFIGURATION_VARSTORE_ID 0x6666\r
\r
#define FORMID_MAIN_FORM          1\r
#define FORMID_MAC_FORM           2\r
#define FORMID_ATTEMPT_FORM       3\r
#define FORMID_ORDER_FORM         4\r
#define FORMID_DELETE_FORM        5\r
\r
#define ISCSI_NAME_IFR_MIN_SIZE   4\r
#define ISCSI_NAME_IFR_MAX_SIZE   223\r
#define ISCSI_NAME_MAX_SIZE       224\r
\r
#define ATTEMPT_NAME_MAX_SIZE     96\r
#define ATTEMPT_NAME_SIZE         10\r
\r
#define CONNECT_MIN_RETRY         0\r
#define CONNECT_MAX_RETRY         16\r
\r
#define CONNECT_MIN_TIMEOUT       100\r
#define CONNECT_MAX_TIMEOUT       20000\r
#define CONNECT_DEFAULT_TIMEOUT   1000\r
\r
#define ISCSI_MAX_ATTEMPTS_NUM    255\r
\r
#define ISCSI_DISABLED            0\r
#define ISCSI_ENABLED             1\r
#define ISCSI_ENABLED_FOR_MPIO    2\r
\r
#define IP_MODE_IP4               0\r
#define IP_MODE_IP6               1\r
#define IP_MODE_AUTOCONFIG        2\r
\r
#define ISCSI_AUTH_TYPE_NONE      0\r
#define ISCSI_AUTH_TYPE_CHAP      1\r
#define ISCSI_AUTH_TYPE_KRB       2\r
\r
#define IP4_MIN_SIZE              7\r
#define IP4_MAX_SIZE              15\r
#define IP4_STR_MAX_SIZE          16\r
\r
//\r
// Macros used for an IPv4 or an IPv6 address.\r
//\r
#define IP_MIN_SIZE               2\r
#define IP_MAX_SIZE               39\r
#define IP_STR_MAX_SIZE           40\r
\r
#define LUN_MIN_SIZE              1\r
#define LUN_MAX_SIZE              20\r
\r
#define ISCSI_CHAP_UNI            1\r
#define ISCSI_CHAP_MUTUAL         2\r
\r
#define TARGET_PORT_MIN_NUM       0\r
#define TARGET_PORT_MAX_NUM       65535\r
#define LABEL_END                 0xffff\r
\r
#define KEY_INITIATOR_NAME        0x101\r
#define KEY_DHCP_ENABLE           0x102\r
#define KEY_LOCAL_IP              0x103\r
#define KEY_SUBNET_MASK           0x104\r
#define KEY_GATE_WAY              0x105\r
#define KEY_TARGET_IP             0x106\r
#define KEY_CHAP_NAME             0x107\r
#define KEY_CHAP_SECRET           0x108\r
#define KEY_REVERSE_CHAP_NAME     0x109\r
#define KEY_REVERSE_CHAP_SECRET   0x10a\r
#define KEY_SAVE_CHANGES          0x10b\r
#define KEY_TARGET_NAME           0x10c\r
#define KEY_BOOT_LUN              0x10d\r
\r
#define KEY_ADD_ATTEMPT           0x10e\r
#define KEY_SAVE_ATTEMPT_CONFIG   0x10f\r
#define KEY_ORDER_ATTEMPT_CONFIG  0x110\r
#define KEY_SAVE_ORDER_CHANGES    0x111\r
#define KEY_IGNORE_ORDER_CHANGES  0x112\r
#define KEY_ATTEMPT_NAME          0x113\r
#define KEY_SAVE_DELETE_ATTEMPT   0x114\r
#define KEY_IGNORE_DELETE_ATTEMPT 0x115\r
#define KEY_DELETE_ATTEMPT        0x116\r
\r
#define KEY_IP_MODE               0x11c\r
#define KEY_AUTH_TYPE             0x11d\r
#define KEY_CONFIG_ISID           0x11e\r
\r
#define ATTEMPT_ENTRY_LABEL       0x9000\r
#define KEY_ATTEMPT_ENTRY_BASE    0xa000\r
#define KEY_DE_ATTEMPT_ENTRY_BASE 0xb000\r
\r
#define KEY_DEVICE_ENTRY_BASE     0x1000\r
#define KEY_MAC_ENTRY_BASE        0x2000\r
#define MAC_ENTRY_LABEL           0x3000\r
#define ORDER_ENTRY_LABEL         0x4000\r
#define DELETE_ENTRY_LABEL        0x5000\r
#define CONFIG_OPTION_OFFSET      0x9000\r
\r
#define ISCSI_LUN_STR_MAX_LEN     21\r
#define ISCSI_CHAP_SECRET_MIN_LEN 12\r
#define ISCSI_CHAP_SECRET_MAX_LEN 16\r
//\r
// ISCSI_CHAP_SECRET_STORAGE = ISCSI_CHAP_SECRET_MAX_LEN + sizeof (NULL-Terminator)\r
//\r
#define ISCSI_CHAP_SECRET_STORAGE 17\r
#define ISCSI_CHAP_NAME_MAX_LEN   126\r
#define ISCSI_CHAP_NAME_STORAGE   127\r
\r
#define KERBEROS_SECRET_MIN_LEN   12\r
#define KERBEROS_SECRET_MAX_LEN   16\r
#define KERBEROS_SECRET_STORAGE   17\r
#define KERBEROS_NAME_MAX_LEN     96\r
#define KERBEROS_KDC_PORT_MIN_NUM 0\r
#define KERBEROS_KDC_PORT_MAX_NUM 65535\r
\r
#define ISID_CONFIGURABLE_MIN_LEN 6\r
#define ISID_CONFIGURABLE_MAX_LEN 12\r
#define ISID_CONFIGURABLE_STORAGE 13\r
\r
#pragma pack(1)\r
typedef struct _ISCSI_CONFIG_IFR_NVDATA {\r
  CHAR16  InitiatorName[ISCSI_NAME_MAX_SIZE];\r
  CHAR16  AttemptName[ATTEMPT_NAME_MAX_SIZE];\r
\r
  UINT8   Enabled;\r
  UINT8   IpMode;\r
\r
  UINT8   ConnectRetryCount;\r
  UINT8   Padding1;\r
  UINT16  ConnectTimeout; // Timeout value in milliseconds.\r
\r
  UINT8   InitiatorInfoFromDhcp;\r
  UINT8   TargetInfoFromDhcp;\r
  CHAR16  LocalIp[IP4_STR_MAX_SIZE];\r
  CHAR16  SubnetMask[IP4_STR_MAX_SIZE];\r
  CHAR16  Gateway[IP4_STR_MAX_SIZE];\r
\r
  CHAR16  TargetName[ISCSI_NAME_MAX_SIZE];\r
  CHAR16  TargetIp[IP_STR_MAX_SIZE];\r
  UINT16  TargetPort;\r
  CHAR16  BootLun[ISCSI_LUN_STR_MAX_LEN];\r
\r
  UINT8   AuthenticationType;\r
\r
  UINT8   CHAPType;\r
  CHAR16  CHAPName[ISCSI_CHAP_NAME_STORAGE];\r
  CHAR16  CHAPSecret[ISCSI_CHAP_SECRET_STORAGE];\r
  CHAR16  ReverseCHAPName[ISCSI_CHAP_NAME_STORAGE];\r
  CHAR16  ReverseCHAPSecret[ISCSI_CHAP_SECRET_STORAGE];\r
\r
  BOOLEAN MutualRequired;\r
  UINT8   Padding2;\r
  CHAR16  KerberosUserName[KERBEROS_NAME_MAX_LEN];\r
  CHAR16  KerberosUserSecret[KERBEROS_SECRET_STORAGE];\r
  CHAR16  KerberosKDCName[KERBEROS_NAME_MAX_LEN];\r
  CHAR16  KerberosKDCRealm[KERBEROS_NAME_MAX_LEN];\r
  CHAR16  KerberosKDCIp[IP_STR_MAX_SIZE];\r
  UINT16  KerberosKDCPort;\r
\r
  UINT8   DynamicOrderedList[ISCSI_MAX_ATTEMPTS_NUM];\r
  UINT8   DeleteAttemptList[ISCSI_MAX_ATTEMPTS_NUM];\r
\r
  CHAR16  IsId[ISID_CONFIGURABLE_STORAGE];\r
} ISCSI_CONFIG_IFR_NVDATA;\r
#pragma pack()\r
\r
#endif\r
Commit	Line	Data
4c5a5e0c	1	/** @file\r
	2	Define NVData structures used by the iSCSI configuration component.\r
	3	\r
	4	Copyright (c) 2004 - 2011, Intel Corporation. All rights reserved.<BR>\r
	5	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_NVDATASTRUC_H_\r
	16	#define _ISCSI_NVDATASTRUC_H_\r
	17	\r
9bdc6592	18	#include <Guid/IScsiConfigHii.h>\r
4c5a5e0c	19	\r
	20	#define VAR_EQ_TEST_NAME 0x100\r
	21	#define CONFIGURATION_VARSTORE_ID 0x6666\r
	22	\r
	23	#define FORMID_MAIN_FORM 1\r
	24	#define FORMID_MAC_FORM 2\r
	25	#define FORMID_ATTEMPT_FORM 3\r
	26	#define FORMID_ORDER_FORM 4\r
	27	#define FORMID_DELETE_FORM 5\r
	28	\r
	29	#define ISCSI_NAME_IFR_MIN_SIZE 4\r
	30	#define ISCSI_NAME_IFR_MAX_SIZE 223\r
	31	#define ISCSI_NAME_MAX_SIZE 224\r
	32	\r
	33	#define ATTEMPT_NAME_MAX_SIZE 96\r
	34	#define ATTEMPT_NAME_SIZE 10\r
	35	\r
	36	#define CONNECT_MIN_RETRY 0\r
	37	#define CONNECT_MAX_RETRY 16\r
	38	\r
	39	#define CONNECT_MIN_TIMEOUT 100\r
	40	#define CONNECT_MAX_TIMEOUT 20000\r
	41	#define CONNECT_DEFAULT_TIMEOUT 1000\r
	42	\r
	43	#define ISCSI_MAX_ATTEMPTS_NUM 255\r
	44	\r
	45	#define ISCSI_DISABLED 0\r
	46	#define ISCSI_ENABLED 1\r
	47	#define ISCSI_ENABLED_FOR_MPIO 2\r
	48	\r
	49	#define IP_MODE_IP4 0\r
	50	#define IP_MODE_IP6 1\r
	51	#define IP_MODE_AUTOCONFIG 2\r
	52	\r
	53	#define ISCSI_AUTH_TYPE_NONE 0\r
	54	#define ISCSI_AUTH_TYPE_CHAP 1\r
	55	#define ISCSI_AUTH_TYPE_KRB 2\r
	56	\r
	57	#define IP4_MIN_SIZE 7\r
	58	#define IP4_MAX_SIZE 15\r
	59	#define IP4_STR_MAX_SIZE 16\r
	60	\r
	61	//\r
	62	// Macros used for an IPv4 or an IPv6 address.\r
	63	//\r
	64	#define IP_MIN_SIZE 2\r
	65	#define IP_MAX_SIZE 39\r
	66	#define IP_STR_MAX_SIZE 40\r
	67	\r
	68	#define LUN_MIN_SIZE 1\r
	69	#define LUN_MAX_SIZE 20\r
	70	\r
	71	#define ISCSI_CHAP_UNI 1\r
	72	#define ISCSI_CHAP_MUTUAL 2\r
	73	\r
	74	#define TARGET_PORT_MIN_NUM 0\r
	75	#define TARGET_PORT_MAX_NUM 65535\r
	76	#define LABEL_END 0xffff\r
	77	\r
	78	#define KEY_INITIATOR_NAME 0x101\r
	79	#define KEY_DHCP_ENABLE 0x102\r
	80	#define KEY_LOCAL_IP 0x103\r
	81	#define KEY_SUBNET_MASK 0x104\r
	82	#define KEY_GATE_WAY 0x105\r
83	#define KEY_TARGET_IP 0x106\r
84	#define KEY_CHAP_NAME 0x107\r
85	#define KEY_CHAP_SECRET 0x108\r
86	#define KEY_REVERSE_CHAP_NAME 0x109\r
87	#define KEY_REVERSE_CHAP_SECRET 0x10a\r
88	#define KEY_SAVE_CHANGES 0x10b\r
89	#define KEY_TARGET_NAME 0x10c\r
90	#define KEY_BOOT_LUN 0x10d\r
91	\r
92	#define KEY_ADD_ATTEMPT 0x10e\r
93	#define KEY_SAVE_ATTEMPT_CONFIG 0x10f\r
94	#define KEY_ORDER_ATTEMPT_CONFIG 0x110\r
95	#define KEY_SAVE_ORDER_CHANGES 0x111\r
96	#define KEY_IGNORE_ORDER_CHANGES 0x112\r
97	#define KEY_ATTEMPT_NAME 0x113\r
98	#define KEY_SAVE_DELETE_ATTEMPT 0x114\r
99	#define KEY_IGNORE_DELETE_ATTEMPT 0x115\r
100	#define KEY_DELETE_ATTEMPT 0x116\r
101	\r
4c5a5e0c	102	#define KEY_IP_MODE 0x11c\r
	103	#define KEY_AUTH_TYPE 0x11d\r
	104	#define KEY_CONFIG_ISID 0x11e\r
	105	\r
	106	#define ATTEMPT_ENTRY_LABEL 0x9000\r
	107	#define KEY_ATTEMPT_ENTRY_BASE 0xa000\r
	108	#define KEY_DE_ATTEMPT_ENTRY_BASE 0xb000\r
	109	\r
	110	#define KEY_DEVICE_ENTRY_BASE 0x1000\r
	111	#define KEY_MAC_ENTRY_BASE 0x2000\r
	112	#define MAC_ENTRY_LABEL 0x3000\r
	113	#define ORDER_ENTRY_LABEL 0x4000\r
	114	#define DELETE_ENTRY_LABEL 0x5000\r
	115	#define CONFIG_OPTION_OFFSET 0x9000\r
	116	\r
	117	#define ISCSI_LUN_STR_MAX_LEN 21\r
	118	#define ISCSI_CHAP_SECRET_MIN_LEN 12\r
	119	#define ISCSI_CHAP_SECRET_MAX_LEN 16\r
	120	//\r
	121	// ISCSI_CHAP_SECRET_STORAGE = ISCSI_CHAP_SECRET_MAX_LEN + sizeof (NULL-Terminator)\r
	122	//\r
	123	#define ISCSI_CHAP_SECRET_STORAGE 17\r
	124	#define ISCSI_CHAP_NAME_MAX_LEN 126\r
	125	#define ISCSI_CHAP_NAME_STORAGE 127\r
	126	\r
	127	#define KERBEROS_SECRET_MIN_LEN 12\r
	128	#define KERBEROS_SECRET_MAX_LEN 16\r
	129	#define KERBEROS_SECRET_STORAGE 17\r
	130	#define KERBEROS_NAME_MAX_LEN 96\r
	131	#define KERBEROS_KDC_PORT_MIN_NUM 0\r
	132	#define KERBEROS_KDC_PORT_MAX_NUM 65535\r
	133	\r
	134	#define ISID_CONFIGURABLE_MIN_LEN 6\r
	135	#define ISID_CONFIGURABLE_MAX_LEN 12\r
	136	#define ISID_CONFIGURABLE_STORAGE 13\r
	137	\r
	138	#pragma pack(1)\r
	139	typedef struct _ISCSI_CONFIG_IFR_NVDATA {\r
	140	CHAR16 InitiatorName[ISCSI_NAME_MAX_SIZE];\r
	141	CHAR16 AttemptName[ATTEMPT_NAME_MAX_SIZE];\r
	142	\r
	143	UINT8 Enabled;\r
	144	UINT8 IpMode;\r
	145	\r
	146	UINT8 ConnectRetryCount;\r
	147	UINT8 Padding1;\r
	148	UINT16 ConnectTimeout; // Timeout value in milliseconds.\r
	149	\r
	150	UINT8 InitiatorInfoFromDhcp;\r
	151	UINT8 TargetInfoFromDhcp;\r
	152	CHAR16 LocalIp[IP4_STR_MAX_SIZE];\r
	153	CHAR16 SubnetMask[IP4_STR_MAX_SIZE];\r
	154	CHAR16 Gateway[IP4_STR_MAX_SIZE];\r
	155	\r
	156	CHAR16 TargetName[ISCSI_NAME_MAX_SIZE];\r
	157	CHAR16 TargetIp[IP_STR_MAX_SIZE];\r
	158	UINT16 TargetPort;\r
	159	CHAR16 BootLun[ISCSI_LUN_STR_MAX_LEN];\r
	160	\r
	161	UINT8 AuthenticationType;\r
	162	\r
	163	UINT8 CHAPType;\r
	164	CHAR16 CHAPName[ISCSI_CHAP_NAME_STORAGE];\r
	165	CHAR16 CHAPSecret[ISCSI_CHAP_SECRET_STORAGE];\r
166	CHAR16 ReverseCHAPName[ISCSI_CHAP_NAME_STORAGE];\r
167	CHAR16 ReverseCHAPSecret[ISCSI_CHAP_SECRET_STORAGE];\r
168	\r
169	BOOLEAN MutualRequired;\r
170	UINT8 Padding2;\r
171	CHAR16 KerberosUserName[KERBEROS_NAME_MAX_LEN];\r
172	CHAR16 KerberosUserSecret[KERBEROS_SECRET_STORAGE];\r
173	CHAR16 KerberosKDCName[KERBEROS_NAME_MAX_LEN];\r
174	CHAR16 KerberosKDCRealm[KERBEROS_NAME_MAX_LEN];\r
175	CHAR16 KerberosKDCIp[IP_STR_MAX_SIZE];\r
176	UINT16 KerberosKDCPort;\r
177	\r
178	UINT8 DynamicOrderedList[ISCSI_MAX_ATTEMPTS_NUM];\r
179	UINT8 DeleteAttemptList[ISCSI_MAX_ATTEMPTS_NUM];\r
180	\r
181	CHAR16 IsId[ISID_CONFIGURABLE_STORAGE];\r
182	} ISCSI_CONFIG_IFR_NVDATA;\r
183	#pragma pack()\r
184	\r
185	#endif\r