NetworkPkg/IScsiDxe/IScsiConfig.h

   1 /** @file
   2   The header file of functions for configuring or getting the parameters
   3   relating to iSCSI.
   4
   5 Copyright (c) 2004 - 2017, Intel Corporation. All rights reserved.<BR>
   6 This program and the accompanying materials
   7 are licensed and made available under the terms and conditions of the BSD License
   8 which accompanies this distribution.  The full text of the license may be found at
   9 http://opensource.org/licenses/bsd-license.php
  10
  11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef _ISCSI_CONFIG_H_
  17 #define _ISCSI_CONFIG_H_
  18
  19 #include "IScsiConfigNVDataStruc.h"
  20
  21 typedef struct _ISCSI_FORM_CALLBACK_INFO ISCSI_FORM_CALLBACK_INFO;
  22
  23 extern UINT8                       IScsiConfigVfrBin[];
  24 extern UINT8                       IScsiDxeStrings[];
  25 extern ISCSI_FORM_CALLBACK_INFO    *mCallbackInfo;
  26
  27
  28 #define VAR_OFFSET(Field)    \
  29   ((UINT16) ((UINTN) &(((ISCSI_CONFIG_IFR_NVDATA *) 0)->Field)))
  30
  31 #define QUESTION_ID(Field)   \
  32   ((UINT16) (VAR_OFFSET (Field) + CONFIG_OPTION_OFFSET))
  33
  34 #define DYNAMIC_ONE_OF_VAR_OFFSET           VAR_OFFSET  (Enabled)
  35 #define DYNAMIC_ORDERED_LIST_QUESTION_ID    QUESTION_ID (DynamicOrderedList)
  36 #define DYNAMIC_ORDERED_LIST_VAR_OFFSET     VAR_OFFSET  (DynamicOrderedList)
  37 #define ATTEMPT_DEL_QUESTION_ID             QUESTION_ID (DeleteAttemptList)
  38 #define ATTEMPT_DEL_VAR_OFFSET              VAR_OFFSET  (DeleteAttemptList)
  39 #define ATTEMPT_ADD_QUESTION_ID             QUESTION_ID (AddAttemptList)
  40 #define ATTEMPT_ADD_VAR_OFFSET              VAR_OFFSET  (AddAttemptList)
  41
  42 //
  43 // Define QuestionId and OffSet for Keywords.
  44 //
  45 #define ATTEMPT_MAC_ADDR_VAR_OFFSET                  VAR_OFFSET  (ISCSIMacAddr)
  46 #define ATTEMPT_ATTEMPT_NAME_QUESTION_ID             QUESTION_ID (ISCSIAttemptName)
  47 #define ATTEMPT_ATTEMPT_NAME_VAR_OFFSET              VAR_OFFSET  (ISCSIAttemptName)
  48 #define ATTEMPT_BOOTENABLE_QUESTION_ID               QUESTION_ID (ISCSIBootEnableList)
  49 #define ATTEMPT_BOOTENABLE_VAR_OFFSET                VAR_OFFSET  (ISCSIBootEnableList)
  50 #define ATTEMPT_ADDRESS_TYPE_QUESTION_ID             QUESTION_ID (ISCSIIpAddressTypeList)
  51 #define ATTEMPT_ADDRESS_TYPE_VAR_OFFSET              VAR_OFFSET  (ISCSIIpAddressTypeList)
  52 #define ATTEMPT_CONNECT_RETRY_QUESTION_ID            QUESTION_ID (ISCSIConnectRetry)
  53 #define ATTEMPT_CONNECT_RETRY_VAR_OFFSET             VAR_OFFSET  (ISCSIConnectRetry)
  54 #define ATTEMPT_CONNECT_TIMEOUT_QUESTION_ID          QUESTION_ID (ISCSIConnectTimeout)
  55 #define ATTEMPT_CONNECT_TIMEOUT_VAR_OFFSET           VAR_OFFSET  (ISCSIConnectTimeout)
  56 #define ATTEMPT_ISID_QUESTION_ID                     QUESTION_ID (Keyword->ISCSIIsId)
  57 #define ATTEMPT_ISID_VAR_OFFSET                      VAR_OFFSET  (Keyword->ISCSIIsId)
  58 #define ATTEMPT_INITIATOR_VIA_DHCP_QUESTION_ID       QUESTION_ID (ISCSIInitiatorInfoViaDHCP)
  59 #define ATTEMPT_INITIATOR_VIA_DHCP_VAR_OFFSET        VAR_OFFSET  (ISCSIInitiatorInfoViaDHCP)
  60 #define ATTEMPT_INITIATOR_IP_ADDRESS_QUESTION_ID     QUESTION_ID (Keyword->ISCSIInitiatorIpAddress)
  61 #define ATTEMPT_INITIATOR_IP_ADDRESS_VAR_OFFSET      VAR_OFFSET  (Keyword->ISCSIInitiatorIpAddress)
  62 #define ATTEMPT_INITIATOR_NET_MASK_QUESTION_ID       QUESTION_ID (Keyword->ISCSIInitiatorNetmask)
  63 #define ATTEMPT_INITIATOR_NET_MASK_VAR_OFFSET        VAR_OFFSET  (Keyword->ISCSIInitiatorNetmask)
  64 #define ATTEMPT_INITIATOR_GATE_WAY_QUESTION_ID       QUESTION_ID (Keyword->ISCSIInitiatorGateway)
  65 #define ATTEMPT_INITIATOR_GATE_WAY_VAR_OFFSET        VAR_OFFSET  (Keyword->ISCSIInitiatorGateway)
  66 #define ATTEMPT_TARGET_VIA_DHCP_QUESTION_ID          QUESTION_ID (ISCSITargetInfoViaDHCP)
  67 #define ATTEMPT_TARGET_VIA_DHCP_VAR_OFFSET           VAR_OFFSET  (ISCSITargetInfoViaDHCP)
  68 #define ATTEMPT_TARGET_NAME_QUESTION_ID              QUESTION_ID (Keyword->ISCSITargetName)
  69 #define ATTEMPT_TARGET_NAME_VAR_OFFSET               VAR_OFFSET  (Keyword->ISCSITargetName)
  70 #define ATTEMPT_TARGET_IP_ADDRESS_QUESTION_ID        QUESTION_ID (Keyword->ISCSITargetIpAddress)
  71 #define ATTEMPT_TARGET_IP_ADDRESS_VAR_OFFSET         VAR_OFFSET  (Keyword->ISCSITargetIpAddress)
  72 #define ATTEMPT_TARGET_TCP_PORT_QUESTION_ID          QUESTION_ID (ISCSITargetTcpPort)
  73 #define ATTEMPT_TARGET_TCP_PORT_VAR_OFFSET           VAR_OFFSET  (ISCSITargetTcpPort)
  74 #define ATTEMPT_LUN_QUESTION_ID                      QUESTION_ID (Keyword->ISCSILun)
  75 #define ATTEMPT_LUN_VAR_OFFSET                       VAR_OFFSET  (Keyword->ISCSILun)
  76 #define ATTEMPT_AUTHENTICATION_METHOD_QUESTION_ID    QUESTION_ID (ISCSIAuthenticationMethod)
  77 #define ATTEMPT_AUTHENTICATION_METHOD_VAR_OFFSET     VAR_OFFSET  (ISCSIAuthenticationMethod)
  78 #define ATTEMPT_CHARTYPE_QUESTION_ID                 QUESTION_ID (ISCSIChapType)
  79 #define ATTEMPT_CHARTYPE_VAR_OFFSET                  VAR_OFFSET  (ISCSIChapType)
  80 #define ATTEMPT_CHAR_USER_NAME_QUESTION_ID           QUESTION_ID (Keyword->ISCSIChapUsername)
  81 #define ATTEMPT_CHAR_USER_NAME_VAR_OFFSET            VAR_OFFSET  (Keyword->ISCSIChapUsername)
  82 #define ATTEMPT_CHAR_SECRET_QUESTION_ID              QUESTION_ID (Keyword->ISCSIChapSecret)
  83 #define ATTEMPT_CHAR_SECRET_VAR_OFFSET               VAR_OFFSET  (Keyword->ISCSIChapSecret)
  84 #define ATTEMPT_CHAR_REVERSE_USER_NAME_QUESTION_ID   QUESTION_ID (Keyword->ISCSIReverseChapUsername)
  85 #define ATTEMPT_CHAR_REVERSE_USER_NAME_VAR_OFFSET    VAR_OFFSET  (Keyword->ISCSIReverseChapUsername)
  86 #define ATTEMPT_CHAR_REVERSE_SECRET_QUESTION_ID      QUESTION_ID (Keyword->ISCSIReverseChapSecret)
  87 #define ATTEMPT_CHAR_REVERSE_SECRET_VAR_OFFSET       VAR_OFFSET  (Keyword->ISCSIReverseChapSecret)
  88
  89
  90 #define ISCSI_INITATOR_NAME_VAR_NAME        L"I_NAME"
  91
  92 #define ISCSI_CONFIG_VAR_ATTR               (EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_NON_VOLATILE)
  93
  94 #define ISCSI_FORM_CALLBACK_INFO_SIGNATURE  SIGNATURE_32 ('I', 'f', 'c', 'i')
  95
  96 #define ISCSI_FORM_CALLBACK_INFO_FROM_FORM_CALLBACK(Callback) \
  97   CR ( \
  98   Callback, \
  99   ISCSI_FORM_CALLBACK_INFO, \
 100   ConfigAccess, \
 101   ISCSI_FORM_CALLBACK_INFO_SIGNATURE \
 102   )
 103
 104 #pragma pack(1)
 105 struct _ISCSI_ATTEMPT_CONFIG_NVDATA {
 106   LIST_ENTRY                       Link;
 107   UINT8                            NicIndex;
 108   UINT8                            AttemptConfigIndex;
 109   BOOLEAN                          DhcpSuccess;
 110   BOOLEAN                          ValidiBFTPath;
 111   BOOLEAN                          ValidPath;
 112   UINT8                            AutoConfigureMode;
 113   EFI_STRING_ID                    AttemptTitleToken;
 114   EFI_STRING_ID                    AttemptTitleHelpToken;
 115   CHAR8                            AttemptName[ATTEMPT_NAME_SIZE];
 116   CHAR8                            MacString[ISCSI_MAX_MAC_STRING_LEN];
 117   EFI_IP_ADDRESS                   PrimaryDns;
 118   EFI_IP_ADDRESS                   SecondaryDns;
 119   EFI_IP_ADDRESS                   DhcpServer;
 120   ISCSI_SESSION_CONFIG_NVDATA      SessionConfigData;
 121   UINT8                            AuthenticationType;
 122   union {
 123     ISCSI_CHAP_AUTH_CONFIG_NVDATA  CHAP;
 124   } AuthConfigData;
 125   BOOLEAN                          AutoConfigureSuccess;
 126   UINT8                            Actived;
 127 };
 128
 129 ///
 130 /// HII specific Vendor Device Path definition.
 131 ///
 132 typedef struct {
 133   VENDOR_DEVICE_PATH               VendorDevicePath;
 134   EFI_DEVICE_PATH_PROTOCOL         End;
 135 } HII_VENDOR_DEVICE_PATH;
 136
 137 #pragma pack()
 138
 139 struct _ISCSI_FORM_CALLBACK_INFO {
 140   UINT32                           Signature;
 141   EFI_HANDLE                       DriverHandle;
 142   EFI_HII_CONFIG_ACCESS_PROTOCOL   ConfigAccess;
 143   UINT16                           *KeyList;
 144   VOID                             *FormBuffer;
 145   EFI_HII_HANDLE                   RegisteredHandle;
 146   ISCSI_ATTEMPT_CONFIG_NVDATA      *Current;
 147 };
 148
 149 /**
 150   Create Hii Extend Label OpCode as the start opcode and end opcode. It is
 151   a help function.
 152
 153   @param[in]  StartLabelNumber   The number of start label.
 154   @param[out] StartOpCodeHandle  Points to the start opcode handle.
 155   @param[out] StartLabel         Points to the created start opcode.
 156   @param[out] EndOpCodeHandle    Points to the end opcode handle.
 157   @param[out] EndLabel           Points to the created end opcode.
 158
 159   @retval EFI_OUT_OF_RESOURCES   Do not have sufficient resource to finish this
 160                                  operation.
 161   @retval EFI_INVALID_PARAMETER  Any input parameter is invalid.
 162   @retval EFI_SUCCESS            The operation is completed successfully.
 163
 164 **/
 165 EFI_STATUS
 166 IScsiCreateOpCode (
 167   IN  UINT16                        StartLabelNumber,
 168   OUT VOID                          **StartOpCodeHandle,
 169   OUT EFI_IFR_GUID_LABEL            **StartLabel,
 170   OUT VOID                          **EndOpCodeHandle,
 171   OUT EFI_IFR_GUID_LABEL            **EndLabel
 172   );
 173
 174 /**
 175   Initialize the iSCSI configuration form.
 176
 177   @param[in]  DriverBindingHandle The iSCSI driverbinding handle.
 178
 179   @retval EFI_SUCCESS             The iSCSI configuration form is initialized.
 180   @retval EFI_OUT_OF_RESOURCES    Failed to allocate memory.
 181
 182 **/
 183 EFI_STATUS
 184 IScsiConfigFormInit (
 185   IN EFI_HANDLE  DriverBindingHandle
 186   );
 187
 188 /**
 189   Unload the iSCSI configuration form, this includes: delete all the iSCSI
 190   configuration entries, uninstall the form callback protocol, and
 191   free the resources used.
 192
 193   @param[in]  DriverBindingHandle The iSCSI driverbinding handle.
 194
 195   @retval EFI_SUCCESS             The iSCSI configuration form is unloaded.
 196   @retval Others                  Failed to unload the form.
 197
 198 **/
 199 EFI_STATUS
 200 IScsiConfigFormUnload (
 201   IN EFI_HANDLE  DriverBindingHandle
 202   );
 203
 204 /**
 205   Update the MAIN form to display the configured attempts.
 206
 207 **/
 208 VOID
 209 IScsiConfigUpdateAttempt (
 210   VOID
 211   );
 212
 213 /**
 214   Get the attempt config data from global structure by the ConfigIndex.
 215
 216   @param[in]  AttemptConfigIndex     The unique index indicates the attempt.
 217
 218   @return       Pointer to the attempt config data.
 219   @retval NULL  The attempt configuration data can not be found.
 220
 221 **/
 222 ISCSI_ATTEMPT_CONFIG_NVDATA *
 223 IScsiConfigGetAttemptByConfigIndex (
 224   IN UINT8                     AttemptConfigIndex
 225   );
 226
 227 #endif