NetworkPkg: Replace BSD License with BSD+Patent License

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

/** @file\r
  The header file of functions for configuring or getting the parameters\r
  relating to iSCSI.\r
\r
Copyright (c) 2004 - 2017, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _ISCSI_CONFIG_H_\r
#define _ISCSI_CONFIG_H_\r
\r
#include "IScsiConfigNVDataStruc.h"\r
\r
typedef struct _ISCSI_FORM_CALLBACK_INFO ISCSI_FORM_CALLBACK_INFO;\r
\r
extern UINT8                       IScsiConfigVfrBin[];\r
extern UINT8                       IScsiDxeStrings[];\r
extern ISCSI_FORM_CALLBACK_INFO    *mCallbackInfo;\r
\r
\r
#define VAR_OFFSET(Field)    \\r
  ((UINT16) ((UINTN) &(((ISCSI_CONFIG_IFR_NVDATA *) 0)->Field)))\r
\r
#define QUESTION_ID(Field)   \\r
  ((UINT16) (VAR_OFFSET (Field) + CONFIG_OPTION_OFFSET))\r
\r
#define DYNAMIC_ONE_OF_VAR_OFFSET           VAR_OFFSET  (Enabled)\r
#define DYNAMIC_ORDERED_LIST_QUESTION_ID    QUESTION_ID (DynamicOrderedList)\r
#define DYNAMIC_ORDERED_LIST_VAR_OFFSET     VAR_OFFSET  (DynamicOrderedList)\r
#define ATTEMPT_DEL_QUESTION_ID             QUESTION_ID (DeleteAttemptList)\r
#define ATTEMPT_DEL_VAR_OFFSET              VAR_OFFSET  (DeleteAttemptList)\r
#define ATTEMPT_ADD_QUESTION_ID             QUESTION_ID (AddAttemptList)\r
#define ATTEMPT_ADD_VAR_OFFSET              VAR_OFFSET  (AddAttemptList)\r
\r
//\r
// Define QuestionId and OffSet for Keywords.\r
//\r
#define ATTEMPT_MAC_ADDR_VAR_OFFSET                  VAR_OFFSET  (ISCSIMacAddr)\r
#define ATTEMPT_ATTEMPT_NAME_QUESTION_ID             QUESTION_ID (ISCSIAttemptName)\r
#define ATTEMPT_ATTEMPT_NAME_VAR_OFFSET              VAR_OFFSET  (ISCSIAttemptName)\r
#define ATTEMPT_BOOTENABLE_QUESTION_ID               QUESTION_ID (ISCSIBootEnableList)\r
#define ATTEMPT_BOOTENABLE_VAR_OFFSET                VAR_OFFSET  (ISCSIBootEnableList)\r
#define ATTEMPT_ADDRESS_TYPE_QUESTION_ID             QUESTION_ID (ISCSIIpAddressTypeList)\r
#define ATTEMPT_ADDRESS_TYPE_VAR_OFFSET              VAR_OFFSET  (ISCSIIpAddressTypeList)\r
#define ATTEMPT_CONNECT_RETRY_QUESTION_ID            QUESTION_ID (ISCSIConnectRetry)\r
#define ATTEMPT_CONNECT_RETRY_VAR_OFFSET             VAR_OFFSET  (ISCSIConnectRetry)\r
#define ATTEMPT_CONNECT_TIMEOUT_QUESTION_ID          QUESTION_ID (ISCSIConnectTimeout)\r
#define ATTEMPT_CONNECT_TIMEOUT_VAR_OFFSET           VAR_OFFSET  (ISCSIConnectTimeout)\r
#define ATTEMPT_ISID_QUESTION_ID                     QUESTION_ID (Keyword->ISCSIIsId)\r
#define ATTEMPT_ISID_VAR_OFFSET                      VAR_OFFSET  (Keyword->ISCSIIsId)\r
#define ATTEMPT_INITIATOR_VIA_DHCP_QUESTION_ID       QUESTION_ID (ISCSIInitiatorInfoViaDHCP)\r
#define ATTEMPT_INITIATOR_VIA_DHCP_VAR_OFFSET        VAR_OFFSET  (ISCSIInitiatorInfoViaDHCP)\r
#define ATTEMPT_INITIATOR_IP_ADDRESS_QUESTION_ID     QUESTION_ID (Keyword->ISCSIInitiatorIpAddress)\r
#define ATTEMPT_INITIATOR_IP_ADDRESS_VAR_OFFSET      VAR_OFFSET  (Keyword->ISCSIInitiatorIpAddress)\r
#define ATTEMPT_INITIATOR_NET_MASK_QUESTION_ID       QUESTION_ID (Keyword->ISCSIInitiatorNetmask)\r
#define ATTEMPT_INITIATOR_NET_MASK_VAR_OFFSET        VAR_OFFSET  (Keyword->ISCSIInitiatorNetmask)\r
#define ATTEMPT_INITIATOR_GATE_WAY_QUESTION_ID       QUESTION_ID (Keyword->ISCSIInitiatorGateway)\r
#define ATTEMPT_INITIATOR_GATE_WAY_VAR_OFFSET        VAR_OFFSET  (Keyword->ISCSIInitiatorGateway)\r
#define ATTEMPT_TARGET_VIA_DHCP_QUESTION_ID          QUESTION_ID (ISCSITargetInfoViaDHCP)\r
#define ATTEMPT_TARGET_VIA_DHCP_VAR_OFFSET           VAR_OFFSET  (ISCSITargetInfoViaDHCP)\r
#define ATTEMPT_TARGET_NAME_QUESTION_ID              QUESTION_ID (Keyword->ISCSITargetName)\r
#define ATTEMPT_TARGET_NAME_VAR_OFFSET               VAR_OFFSET  (Keyword->ISCSITargetName)\r
#define ATTEMPT_TARGET_IP_ADDRESS_QUESTION_ID        QUESTION_ID (Keyword->ISCSITargetIpAddress)\r
#define ATTEMPT_TARGET_IP_ADDRESS_VAR_OFFSET         VAR_OFFSET  (Keyword->ISCSITargetIpAddress)\r
#define ATTEMPT_TARGET_TCP_PORT_QUESTION_ID          QUESTION_ID (ISCSITargetTcpPort)\r
#define ATTEMPT_TARGET_TCP_PORT_VAR_OFFSET           VAR_OFFSET  (ISCSITargetTcpPort)\r
#define ATTEMPT_LUN_QUESTION_ID                      QUESTION_ID (Keyword->ISCSILun)\r
#define ATTEMPT_LUN_VAR_OFFSET                       VAR_OFFSET  (Keyword->ISCSILun)\r
#define ATTEMPT_AUTHENTICATION_METHOD_QUESTION_ID    QUESTION_ID (ISCSIAuthenticationMethod)\r
#define ATTEMPT_AUTHENTICATION_METHOD_VAR_OFFSET     VAR_OFFSET  (ISCSIAuthenticationMethod)\r
#define ATTEMPT_CHARTYPE_QUESTION_ID                 QUESTION_ID (ISCSIChapType)\r
#define ATTEMPT_CHARTYPE_VAR_OFFSET                  VAR_OFFSET  (ISCSIChapType)\r
#define ATTEMPT_CHAR_USER_NAME_QUESTION_ID           QUESTION_ID (Keyword->ISCSIChapUsername)\r
#define ATTEMPT_CHAR_USER_NAME_VAR_OFFSET            VAR_OFFSET  (Keyword->ISCSIChapUsername)\r
#define ATTEMPT_CHAR_SECRET_QUESTION_ID              QUESTION_ID (Keyword->ISCSIChapSecret)\r
#define ATTEMPT_CHAR_SECRET_VAR_OFFSET               VAR_OFFSET  (Keyword->ISCSIChapSecret)\r
#define ATTEMPT_CHAR_REVERSE_USER_NAME_QUESTION_ID   QUESTION_ID (Keyword->ISCSIReverseChapUsername)\r
#define ATTEMPT_CHAR_REVERSE_USER_NAME_VAR_OFFSET    VAR_OFFSET  (Keyword->ISCSIReverseChapUsername)\r
#define ATTEMPT_CHAR_REVERSE_SECRET_QUESTION_ID      QUESTION_ID (Keyword->ISCSIReverseChapSecret)\r
#define ATTEMPT_CHAR_REVERSE_SECRET_VAR_OFFSET       VAR_OFFSET  (Keyword->ISCSIReverseChapSecret)\r
\r
\r
#define ISCSI_INITATOR_NAME_VAR_NAME        L"I_NAME"\r
\r
#define ISCSI_CONFIG_VAR_ATTR               (EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_NON_VOLATILE)\r
\r
#define ISCSI_FORM_CALLBACK_INFO_SIGNATURE  SIGNATURE_32 ('I', 'f', 'c', 'i')\r
\r
#define ISCSI_FORM_CALLBACK_INFO_FROM_FORM_CALLBACK(Callback) \\r
  CR ( \\r
  Callback, \\r
  ISCSI_FORM_CALLBACK_INFO, \\r
  ConfigAccess, \\r
  ISCSI_FORM_CALLBACK_INFO_SIGNATURE \\r
  )\r
\r
#pragma pack(1)\r
struct _ISCSI_ATTEMPT_CONFIG_NVDATA {\r
  LIST_ENTRY                       Link;\r
  UINT8                            NicIndex;\r
  UINT8                            AttemptConfigIndex;\r
  BOOLEAN                          DhcpSuccess;\r
  BOOLEAN                          ValidiBFTPath;\r
  BOOLEAN                          ValidPath;\r
  UINT8                            AutoConfigureMode;\r
  EFI_STRING_ID                    AttemptTitleToken;\r
  EFI_STRING_ID                    AttemptTitleHelpToken;\r
  CHAR8                            AttemptName[ATTEMPT_NAME_SIZE];\r
  CHAR8                            MacString[ISCSI_MAX_MAC_STRING_LEN];\r
  EFI_IP_ADDRESS                   PrimaryDns;\r
  EFI_IP_ADDRESS                   SecondaryDns;\r
  EFI_IP_ADDRESS                   DhcpServer;\r
  ISCSI_SESSION_CONFIG_NVDATA      SessionConfigData;\r
  UINT8                            AuthenticationType;\r
  union {\r
    ISCSI_CHAP_AUTH_CONFIG_NVDATA  CHAP;\r
  } AuthConfigData;\r
  BOOLEAN                          AutoConfigureSuccess;\r
  UINT8                            Actived;\r
};\r
\r
///\r
/// HII specific Vendor Device Path definition.\r
///\r
typedef struct {\r
  VENDOR_DEVICE_PATH               VendorDevicePath;\r
  EFI_DEVICE_PATH_PROTOCOL         End;\r
} HII_VENDOR_DEVICE_PATH;\r
\r
#pragma pack()\r
\r
struct _ISCSI_FORM_CALLBACK_INFO {\r
  UINT32                           Signature;\r
  EFI_HANDLE                       DriverHandle;\r
  EFI_HII_CONFIG_ACCESS_PROTOCOL   ConfigAccess;\r
  UINT16                           *KeyList;\r
  VOID                             *FormBuffer;\r
  EFI_HII_HANDLE                   RegisteredHandle;\r
  ISCSI_ATTEMPT_CONFIG_NVDATA      *Current;\r
};\r
\r
/**\r
  Create Hii Extend Label OpCode as the start opcode and end opcode. It is\r
  a help function.\r
\r
  @param[in]  StartLabelNumber   The number of start label.\r
  @param[out] StartOpCodeHandle  Points to the start opcode handle.\r
  @param[out] StartLabel         Points to the created start opcode.\r
  @param[out] EndOpCodeHandle    Points to the end opcode handle.\r
  @param[out] EndLabel           Points to the created end opcode.\r
\r
  @retval EFI_OUT_OF_RESOURCES   Do not have sufficient resource to finish this\r
                                 operation.\r
  @retval EFI_INVALID_PARAMETER  Any input parameter is invalid.\r
  @retval EFI_SUCCESS            The operation is completed successfully.\r
\r
**/\r
EFI_STATUS\r
IScsiCreateOpCode (\r
  IN  UINT16                        StartLabelNumber,\r
  OUT VOID                          **StartOpCodeHandle,\r
  OUT EFI_IFR_GUID_LABEL            **StartLabel,\r
  OUT VOID                          **EndOpCodeHandle,\r
  OUT EFI_IFR_GUID_LABEL            **EndLabel\r
  );\r
\r
/**\r
  Initialize the iSCSI configuration form.\r
\r
  @param[in]  DriverBindingHandle The iSCSI driverbinding handle.\r
\r
  @retval EFI_SUCCESS             The iSCSI configuration form is initialized.\r
  @retval EFI_OUT_OF_RESOURCES    Failed to allocate memory.\r
\r
**/\r
EFI_STATUS\r
IScsiConfigFormInit (\r
  IN EFI_HANDLE  DriverBindingHandle\r
  );\r
\r
/**\r
  Unload the iSCSI configuration form, this includes: delete all the iSCSI\r
  configuration entries, uninstall the form callback protocol, and\r
  free the resources used.\r
\r
  @param[in]  DriverBindingHandle The iSCSI driverbinding handle.\r
\r
  @retval EFI_SUCCESS             The iSCSI configuration form is unloaded.\r
  @retval Others                  Failed to unload the form.\r
\r
**/\r
EFI_STATUS\r
IScsiConfigFormUnload (\r
  IN EFI_HANDLE  DriverBindingHandle\r
  );\r
\r
/**\r
  Update the MAIN form to display the configured attempts.\r
\r
**/\r
VOID\r
IScsiConfigUpdateAttempt (\r
  VOID\r
  );\r
\r
/**\r
  Get the attempt config data from global structure by the ConfigIndex.\r
\r
  @param[in]  AttemptConfigIndex     The unique index indicates the attempt.\r
\r
  @return       Pointer to the attempt config data.\r
  @retval NULL  The attempt configuration data can not be found.\r
\r
**/\r
ISCSI_ATTEMPT_CONFIG_NVDATA *\r
IScsiConfigGetAttemptByConfigIndex (\r
  IN UINT8                     AttemptConfigIndex\r
  );\r
\r
#endif\r