TianoCore EDK2 master
Loading...
Searching...
No Matches
IScsiConfigNVDataStruc.h File Reference

Go to the source code of this file.

Data Structures

struct  KEYWORD_STR
 
struct  _ISCSI_CONFIG_IFR_NVDATA
 

Macros

#define VAR_EQ_TEST_NAME   0x100
 
#define CONFIGURATION_VARSTORE_ID   0x6666
 
#define FORMID_MAIN_FORM   1
 
#define FORMID_MAC_FORM   2
 
#define FORMID_ATTEMPT_FORM   3
 
#define FORMID_ORDER_FORM   4
 
#define FORMID_DELETE_FORM   5
 
#define ISCSI_MAX_ATTEMPTS_NUM   FixedPcdGet8 (PcdMaxIScsiAttemptNumber)
 
#define ISCSI_NAME_IFR_MIN_SIZE   4
 
#define ISCSI_NAME_IFR_MAX_SIZE   223
 
#define ISCSI_NAME_MAX_SIZE   224
 
#define ATTEMPT_NAME_LIST_SIZE   96
 
#define ATTEMPT_NAME_SIZE   12
 
#define CONNECT_MIN_RETRY   0
 
#define CONNECT_MAX_RETRY   16
 
#define CONNECT_MIN_TIMEOUT   100
 
#define CONNECT_MAX_TIMEOUT   20000
 
#define CONNECT_DEFAULT_TIMEOUT   1000
 
#define ISCSI_ACTIVE_DISABLED   0
 
#define ISCSI_ACTIVE_ENABLED   1
 
#define ISCSI_DISABLED   0
 
#define ISCSI_ENABLED   1
 
#define ISCSI_ENABLED_FOR_MPIO   2
 
#define IP_MODE_IP4   0
 
#define IP_MODE_IP6   1
 
#define IP_MODE_AUTOCONFIG   2
 
#define ISCSI_AUTH_TYPE_NONE   0
 
#define ISCSI_AUTH_TYPE_CHAP   1
 
#define ISCSI_AUTH_TYPE_KRB   2
 
#define IP4_MIN_SIZE   7
 
#define IP4_MAX_SIZE   15
 
#define IP4_STR_MAX_SIZE   16
 
#define IP_MIN_SIZE   2
 
#define IP_MAX_SIZE   39
 
#define IP_STR_MAX_SIZE   40
 
#define LUN_MIN_SIZE   1
 
#define LUN_MAX_SIZE   20
 
#define ISCSI_LUN_STR_MAX_LEN   21
 
#define ISCSI_CHAP_UNI   0
 
#define ISCSI_CHAP_MUTUAL   1
 
#define TARGET_PORT_MIN_NUM   0
 
#define TARGET_PORT_MAX_NUM   65535
 
#define LABEL_END   0xffff
 
#define KEY_INITIATOR_NAME   0x101
 
#define KEY_DHCP_ENABLE   0x102
 
#define KEY_LOCAL_IP   0x103
 
#define KEY_SUBNET_MASK   0x104
 
#define KEY_GATE_WAY   0x105
 
#define KEY_TARGET_IP   0x106
 
#define KEY_CHAP_NAME   0x107
 
#define KEY_CHAP_SECRET   0x108
 
#define KEY_REVERSE_CHAP_NAME   0x109
 
#define KEY_REVERSE_CHAP_SECRET   0x10a
 
#define KEY_SAVE_CHANGES   0x10b
 
#define KEY_TARGET_NAME   0x10c
 
#define KEY_BOOT_LUN   0x10d
 
#define KEY_ADD_ATTEMPT   0x10e
 
#define KEY_SAVE_ATTEMPT_CONFIG   0x10f
 
#define KEY_ORDER_ATTEMPT_CONFIG   0x110
 
#define KEY_SAVE_ORDER_CHANGES   0x111
 
#define KEY_IGNORE_ORDER_CHANGES   0x112
 
#define KEY_ATTEMPT_NAME   0x113
 
#define KEY_SAVE_DELETE_ATTEMPT   0x114
 
#define KEY_IGNORE_DELETE_ATTEMPT   0x115
 
#define KEY_DELETE_ATTEMPT   0x116
 
#define KEY_IP_MODE   0x11c
 
#define KEY_AUTH_TYPE   0x11d
 
#define KEY_CONFIG_ISID   0x11e
 
#define ATTEMPT_ENTRY_LABEL   0x9000
 
#define KEY_ATTEMPT_ENTRY_BASE   0xa000
 
#define KEY_DE_ATTEMPT_ENTRY_BASE   0xb000
 
#define KEY_DEVICE_ENTRY_BASE   0x1000
 
#define KEY_MAC_ENTRY_BASE   0x2000
 
#define MAC_ENTRY_LABEL   0x3000
 
#define ORDER_ENTRY_LABEL   0x4000
 
#define DELETE_ENTRY_LABEL   0x5000
 
#define KEYWORD_ENTRY_LABEL   0x6000
 
#define CONFIG_OPTION_OFFSET   0x9000
 
#define ISCSI_CHAP_SECRET_MIN_LEN   12
 
#define ISCSI_CHAP_SECRET_MAX_LEN   16
 
#define ISCSI_CHAP_SECRET_STORAGE   17
 
#define ISCSI_CHAP_NAME_MAX_LEN   126
 
#define ISCSI_CHAP_NAME_STORAGE   127
 
#define KERBEROS_SECRET_MIN_LEN   12
 
#define KERBEROS_SECRET_MAX_LEN   16
 
#define KERBEROS_SECRET_STORAGE   17
 
#define KERBEROS_NAME_MAX_LEN   96
 
#define KERBEROS_KDC_PORT_MIN_NUM   0
 
#define KERBEROS_KDC_PORT_MAX_NUM   65535
 
#define ISID_CONFIGURABLE_MIN_LEN   6
 
#define ISID_CONFIGURABLE_MAX_LEN   12
 
#define ISID_CONFIGURABLE_STORAGE   13
 
#define ISCSI_MAX_MAC_STRING_LEN   96
 
#define ISCSI_TARGET_URI_MIN_SIZE   0
 
#define ISCSI_TARGET_URI_MAX_SIZE   255
 

Typedefs

typedef struct _ISCSI_CONFIG_IFR_NVDATA ISCSI_CONFIG_IFR_NVDATA
 

Detailed Description

Define NVData structures used by the iSCSI configuration component.

Copyright (c) 2004 - 2017, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file IScsiConfigNVDataStruc.h.

Macro Definition Documentation

◆ ATTEMPT_ENTRY_LABEL

#define ATTEMPT_ENTRY_LABEL   0x9000

Definition at line 104 of file IScsiConfigNVDataStruc.h.

◆ ATTEMPT_NAME_LIST_SIZE

#define ATTEMPT_NAME_LIST_SIZE   96

Definition at line 29 of file IScsiConfigNVDataStruc.h.

◆ ATTEMPT_NAME_SIZE

#define ATTEMPT_NAME_SIZE   12

Definition at line 30 of file IScsiConfigNVDataStruc.h.

◆ CONFIG_OPTION_OFFSET

#define CONFIG_OPTION_OFFSET   0x9000

Definition at line 114 of file IScsiConfigNVDataStruc.h.

◆ CONFIGURATION_VARSTORE_ID

#define CONFIGURATION_VARSTORE_ID   0x6666

Definition at line 15 of file IScsiConfigNVDataStruc.h.

◆ CONNECT_DEFAULT_TIMEOUT

#define CONNECT_DEFAULT_TIMEOUT   1000

Definition at line 37 of file IScsiConfigNVDataStruc.h.

◆ CONNECT_MAX_RETRY

#define CONNECT_MAX_RETRY   16

Definition at line 33 of file IScsiConfigNVDataStruc.h.

◆ CONNECT_MAX_TIMEOUT

#define CONNECT_MAX_TIMEOUT   20000

Definition at line 36 of file IScsiConfigNVDataStruc.h.

◆ CONNECT_MIN_RETRY

#define CONNECT_MIN_RETRY   0

Definition at line 32 of file IScsiConfigNVDataStruc.h.

◆ CONNECT_MIN_TIMEOUT

#define CONNECT_MIN_TIMEOUT   100

Definition at line 35 of file IScsiConfigNVDataStruc.h.

◆ DELETE_ENTRY_LABEL

#define DELETE_ENTRY_LABEL   0x5000

Definition at line 112 of file IScsiConfigNVDataStruc.h.

◆ FORMID_ATTEMPT_FORM

#define FORMID_ATTEMPT_FORM   3

Definition at line 19 of file IScsiConfigNVDataStruc.h.

◆ FORMID_DELETE_FORM

#define FORMID_DELETE_FORM   5

Definition at line 21 of file IScsiConfigNVDataStruc.h.

◆ FORMID_MAC_FORM

#define FORMID_MAC_FORM   2

Definition at line 18 of file IScsiConfigNVDataStruc.h.

◆ FORMID_MAIN_FORM

#define FORMID_MAIN_FORM   1

Definition at line 17 of file IScsiConfigNVDataStruc.h.

◆ FORMID_ORDER_FORM

#define FORMID_ORDER_FORM   4

Definition at line 20 of file IScsiConfigNVDataStruc.h.

◆ IP4_MAX_SIZE

#define IP4_MAX_SIZE   15

Definition at line 55 of file IScsiConfigNVDataStruc.h.

◆ IP4_MIN_SIZE

#define IP4_MIN_SIZE   7

Definition at line 54 of file IScsiConfigNVDataStruc.h.

◆ IP4_STR_MAX_SIZE

#define IP4_STR_MAX_SIZE   16

Definition at line 56 of file IScsiConfigNVDataStruc.h.

◆ IP_MAX_SIZE

#define IP_MAX_SIZE   39

Definition at line 62 of file IScsiConfigNVDataStruc.h.

◆ IP_MIN_SIZE

#define IP_MIN_SIZE   2

Definition at line 61 of file IScsiConfigNVDataStruc.h.

◆ IP_MODE_AUTOCONFIG

#define IP_MODE_AUTOCONFIG   2

Definition at line 48 of file IScsiConfigNVDataStruc.h.

◆ IP_MODE_IP4

#define IP_MODE_IP4   0

Definition at line 46 of file IScsiConfigNVDataStruc.h.

◆ IP_MODE_IP6

#define IP_MODE_IP6   1

Definition at line 47 of file IScsiConfigNVDataStruc.h.

◆ IP_STR_MAX_SIZE

#define IP_STR_MAX_SIZE   40

Definition at line 63 of file IScsiConfigNVDataStruc.h.

◆ ISCSI_ACTIVE_DISABLED

#define ISCSI_ACTIVE_DISABLED   0

Definition at line 39 of file IScsiConfigNVDataStruc.h.

◆ ISCSI_ACTIVE_ENABLED

#define ISCSI_ACTIVE_ENABLED   1

Definition at line 40 of file IScsiConfigNVDataStruc.h.

◆ ISCSI_AUTH_TYPE_CHAP

#define ISCSI_AUTH_TYPE_CHAP   1

Definition at line 51 of file IScsiConfigNVDataStruc.h.

◆ ISCSI_AUTH_TYPE_KRB

#define ISCSI_AUTH_TYPE_KRB   2

Definition at line 52 of file IScsiConfigNVDataStruc.h.

◆ ISCSI_AUTH_TYPE_NONE

#define ISCSI_AUTH_TYPE_NONE   0

Definition at line 50 of file IScsiConfigNVDataStruc.h.

◆ ISCSI_CHAP_MUTUAL

#define ISCSI_CHAP_MUTUAL   1

Definition at line 70 of file IScsiConfigNVDataStruc.h.

◆ ISCSI_CHAP_NAME_MAX_LEN

#define ISCSI_CHAP_NAME_MAX_LEN   126

Definition at line 123 of file IScsiConfigNVDataStruc.h.

◆ ISCSI_CHAP_NAME_STORAGE

#define ISCSI_CHAP_NAME_STORAGE   127

Definition at line 124 of file IScsiConfigNVDataStruc.h.

◆ ISCSI_CHAP_SECRET_MAX_LEN

#define ISCSI_CHAP_SECRET_MAX_LEN   16

Definition at line 117 of file IScsiConfigNVDataStruc.h.

◆ ISCSI_CHAP_SECRET_MIN_LEN

#define ISCSI_CHAP_SECRET_MIN_LEN   12

Definition at line 116 of file IScsiConfigNVDataStruc.h.

◆ ISCSI_CHAP_SECRET_STORAGE

#define ISCSI_CHAP_SECRET_STORAGE   17

Definition at line 121 of file IScsiConfigNVDataStruc.h.

◆ ISCSI_CHAP_UNI

#define ISCSI_CHAP_UNI   0

Definition at line 69 of file IScsiConfigNVDataStruc.h.

◆ ISCSI_DISABLED

#define ISCSI_DISABLED   0

Definition at line 42 of file IScsiConfigNVDataStruc.h.

◆ ISCSI_ENABLED

#define ISCSI_ENABLED   1

Definition at line 43 of file IScsiConfigNVDataStruc.h.

◆ ISCSI_ENABLED_FOR_MPIO

#define ISCSI_ENABLED_FOR_MPIO   2

Definition at line 44 of file IScsiConfigNVDataStruc.h.

◆ ISCSI_LUN_STR_MAX_LEN

#define ISCSI_LUN_STR_MAX_LEN   21

Definition at line 67 of file IScsiConfigNVDataStruc.h.

◆ ISCSI_MAX_ATTEMPTS_NUM

#define ISCSI_MAX_ATTEMPTS_NUM   FixedPcdGet8 (PcdMaxIScsiAttemptNumber)

Definition at line 23 of file IScsiConfigNVDataStruc.h.

◆ ISCSI_MAX_MAC_STRING_LEN

#define ISCSI_MAX_MAC_STRING_LEN   96

Definition at line 140 of file IScsiConfigNVDataStruc.h.

◆ ISCSI_NAME_IFR_MAX_SIZE

#define ISCSI_NAME_IFR_MAX_SIZE   223

Definition at line 26 of file IScsiConfigNVDataStruc.h.

◆ ISCSI_NAME_IFR_MIN_SIZE

#define ISCSI_NAME_IFR_MIN_SIZE   4

Definition at line 25 of file IScsiConfigNVDataStruc.h.

◆ ISCSI_NAME_MAX_SIZE

#define ISCSI_NAME_MAX_SIZE   224

Definition at line 27 of file IScsiConfigNVDataStruc.h.

◆ ISCSI_TARGET_URI_MAX_SIZE

#define ISCSI_TARGET_URI_MAX_SIZE   255

Definition at line 146 of file IScsiConfigNVDataStruc.h.

◆ ISCSI_TARGET_URI_MIN_SIZE

#define ISCSI_TARGET_URI_MIN_SIZE   0

Macro used for target Url.

Definition at line 145 of file IScsiConfigNVDataStruc.h.

◆ ISID_CONFIGURABLE_MAX_LEN

#define ISID_CONFIGURABLE_MAX_LEN   12

Definition at line 134 of file IScsiConfigNVDataStruc.h.

◆ ISID_CONFIGURABLE_MIN_LEN

#define ISID_CONFIGURABLE_MIN_LEN   6

Definition at line 133 of file IScsiConfigNVDataStruc.h.

◆ ISID_CONFIGURABLE_STORAGE

#define ISID_CONFIGURABLE_STORAGE   13

Definition at line 135 of file IScsiConfigNVDataStruc.h.

◆ KERBEROS_KDC_PORT_MAX_NUM

#define KERBEROS_KDC_PORT_MAX_NUM   65535

Definition at line 131 of file IScsiConfigNVDataStruc.h.

◆ KERBEROS_KDC_PORT_MIN_NUM

#define KERBEROS_KDC_PORT_MIN_NUM   0

Definition at line 130 of file IScsiConfigNVDataStruc.h.

◆ KERBEROS_NAME_MAX_LEN

#define KERBEROS_NAME_MAX_LEN   96

Definition at line 129 of file IScsiConfigNVDataStruc.h.

◆ KERBEROS_SECRET_MAX_LEN

#define KERBEROS_SECRET_MAX_LEN   16

Definition at line 127 of file IScsiConfigNVDataStruc.h.

◆ KERBEROS_SECRET_MIN_LEN

#define KERBEROS_SECRET_MIN_LEN   12

Definition at line 126 of file IScsiConfigNVDataStruc.h.

◆ KERBEROS_SECRET_STORAGE

#define KERBEROS_SECRET_STORAGE   17

Definition at line 128 of file IScsiConfigNVDataStruc.h.

◆ KEY_ADD_ATTEMPT

#define KEY_ADD_ATTEMPT   0x10e

Definition at line 90 of file IScsiConfigNVDataStruc.h.

◆ KEY_ATTEMPT_ENTRY_BASE

#define KEY_ATTEMPT_ENTRY_BASE   0xa000

Definition at line 105 of file IScsiConfigNVDataStruc.h.

◆ KEY_ATTEMPT_NAME

#define KEY_ATTEMPT_NAME   0x113

Definition at line 95 of file IScsiConfigNVDataStruc.h.

◆ KEY_AUTH_TYPE

#define KEY_AUTH_TYPE   0x11d

Definition at line 101 of file IScsiConfigNVDataStruc.h.

◆ KEY_BOOT_LUN

#define KEY_BOOT_LUN   0x10d

Definition at line 88 of file IScsiConfigNVDataStruc.h.

◆ KEY_CHAP_NAME

#define KEY_CHAP_NAME   0x107

Definition at line 82 of file IScsiConfigNVDataStruc.h.

◆ KEY_CHAP_SECRET

#define KEY_CHAP_SECRET   0x108

Definition at line 83 of file IScsiConfigNVDataStruc.h.

◆ KEY_CONFIG_ISID

#define KEY_CONFIG_ISID   0x11e

Definition at line 102 of file IScsiConfigNVDataStruc.h.

◆ KEY_DE_ATTEMPT_ENTRY_BASE

#define KEY_DE_ATTEMPT_ENTRY_BASE   0xb000

Definition at line 106 of file IScsiConfigNVDataStruc.h.

◆ KEY_DELETE_ATTEMPT

#define KEY_DELETE_ATTEMPT   0x116

Definition at line 98 of file IScsiConfigNVDataStruc.h.

◆ KEY_DEVICE_ENTRY_BASE

#define KEY_DEVICE_ENTRY_BASE   0x1000

Definition at line 108 of file IScsiConfigNVDataStruc.h.

◆ KEY_DHCP_ENABLE

#define KEY_DHCP_ENABLE   0x102

Definition at line 77 of file IScsiConfigNVDataStruc.h.

◆ KEY_GATE_WAY

#define KEY_GATE_WAY   0x105

Definition at line 80 of file IScsiConfigNVDataStruc.h.

◆ KEY_IGNORE_DELETE_ATTEMPT

#define KEY_IGNORE_DELETE_ATTEMPT   0x115

Definition at line 97 of file IScsiConfigNVDataStruc.h.

◆ KEY_IGNORE_ORDER_CHANGES

#define KEY_IGNORE_ORDER_CHANGES   0x112

Definition at line 94 of file IScsiConfigNVDataStruc.h.

◆ KEY_INITIATOR_NAME

#define KEY_INITIATOR_NAME   0x101

Definition at line 76 of file IScsiConfigNVDataStruc.h.

◆ KEY_IP_MODE

#define KEY_IP_MODE   0x11c

Definition at line 100 of file IScsiConfigNVDataStruc.h.

◆ KEY_LOCAL_IP

#define KEY_LOCAL_IP   0x103

Definition at line 78 of file IScsiConfigNVDataStruc.h.

◆ KEY_MAC_ENTRY_BASE

#define KEY_MAC_ENTRY_BASE   0x2000

Definition at line 109 of file IScsiConfigNVDataStruc.h.

◆ KEY_ORDER_ATTEMPT_CONFIG

#define KEY_ORDER_ATTEMPT_CONFIG   0x110

Definition at line 92 of file IScsiConfigNVDataStruc.h.

◆ KEY_REVERSE_CHAP_NAME

#define KEY_REVERSE_CHAP_NAME   0x109

Definition at line 84 of file IScsiConfigNVDataStruc.h.

◆ KEY_REVERSE_CHAP_SECRET

#define KEY_REVERSE_CHAP_SECRET   0x10a

Definition at line 85 of file IScsiConfigNVDataStruc.h.

◆ KEY_SAVE_ATTEMPT_CONFIG

#define KEY_SAVE_ATTEMPT_CONFIG   0x10f

Definition at line 91 of file IScsiConfigNVDataStruc.h.

◆ KEY_SAVE_CHANGES

#define KEY_SAVE_CHANGES   0x10b

Definition at line 86 of file IScsiConfigNVDataStruc.h.

◆ KEY_SAVE_DELETE_ATTEMPT

#define KEY_SAVE_DELETE_ATTEMPT   0x114

Definition at line 96 of file IScsiConfigNVDataStruc.h.

◆ KEY_SAVE_ORDER_CHANGES

#define KEY_SAVE_ORDER_CHANGES   0x111

Definition at line 93 of file IScsiConfigNVDataStruc.h.

◆ KEY_SUBNET_MASK

#define KEY_SUBNET_MASK   0x104

Definition at line 79 of file IScsiConfigNVDataStruc.h.

◆ KEY_TARGET_IP

#define KEY_TARGET_IP   0x106

Definition at line 81 of file IScsiConfigNVDataStruc.h.

◆ KEY_TARGET_NAME

#define KEY_TARGET_NAME   0x10c

Definition at line 87 of file IScsiConfigNVDataStruc.h.

◆ KEYWORD_ENTRY_LABEL

#define KEYWORD_ENTRY_LABEL   0x6000

Definition at line 113 of file IScsiConfigNVDataStruc.h.

◆ LABEL_END

#define LABEL_END   0xffff

Definition at line 74 of file IScsiConfigNVDataStruc.h.

◆ LUN_MAX_SIZE

#define LUN_MAX_SIZE   20

Definition at line 66 of file IScsiConfigNVDataStruc.h.

◆ LUN_MIN_SIZE

#define LUN_MIN_SIZE   1

Definition at line 65 of file IScsiConfigNVDataStruc.h.

◆ MAC_ENTRY_LABEL

#define MAC_ENTRY_LABEL   0x3000

Definition at line 110 of file IScsiConfigNVDataStruc.h.

◆ ORDER_ENTRY_LABEL

#define ORDER_ENTRY_LABEL   0x4000

Definition at line 111 of file IScsiConfigNVDataStruc.h.

◆ TARGET_PORT_MAX_NUM

#define TARGET_PORT_MAX_NUM   65535

Definition at line 73 of file IScsiConfigNVDataStruc.h.

◆ TARGET_PORT_MIN_NUM

#define TARGET_PORT_MIN_NUM   0

Definition at line 72 of file IScsiConfigNVDataStruc.h.

◆ VAR_EQ_TEST_NAME

#define VAR_EQ_TEST_NAME   0x100

Definition at line 14 of file IScsiConfigNVDataStruc.h.