NetworkPkg/IScsiDxe/IScsiConfig.h File Reference


Data Structures

struct  _ISCSI_ATTEMPT_CONFIG_NVDATA
struct  HII_VENDOR_DEVICE_PATH
struct  _ISCSI_FORM_CALLBACK_INFO

Defines

#define VAR_OFFSET(Field)   ((UINT16) ((UINTN) &(((ISCSI_CONFIG_IFR_NVDATA *) 0)->Field)))
#define QUESTION_ID(Field)   ((UINT16) (VAR_OFFSET (Field) + CONFIG_OPTION_OFFSET))
#define DYNAMIC_ONE_OF_VAR_OFFSET   VAR_OFFSET (Enabled)
#define DYNAMIC_ORDERED_LIST_QUESTION_ID   QUESTION_ID (DynamicOrderedList)
#define DYNAMIC_ORDERED_LIST_VAR_OFFSET   VAR_OFFSET (DynamicOrderedList)
#define ATTEMPT_DEL_QUESTION_ID   QUESTION_ID (DeleteAttemptList)
#define ATTEMPT_DEL_VAR_OFFSET   VAR_OFFSET (DeleteAttemptList)
#define ISCSI_MAX_MAC_STRING_LEN   96
#define ISCSI_INITATOR_NAME_VAR_NAME   L"I_NAME"
#define ISCSI_CONFIG_VAR_ATTR   (EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_NON_VOLATILE)
#define ISCSI_FORM_CALLBACK_INFO_SIGNATURE   SIGNATURE_32 ('I', 'f', 'c', 'i')
#define ISCSI_FORM_CALLBACK_INFO_FROM_FORM_CALLBACK(Callback)

Typedefs

typedef struct
_ISCSI_FORM_CALLBACK_INFO 
ISCSI_FORM_CALLBACK_INFO

Functions

EFI_STATUS IScsiConfigFormInit (IN EFI_HANDLE DriverBindingHandle)
EFI_STATUS IScsiConfigFormUnload (IN EFI_HANDLE DriverBindingHandle)
VOID IScsiConfigUpdateAttempt (VOID)
ISCSI_ATTEMPT_CONFIG_NVDATAIScsiConfigGetAttemptByConfigIndex (IN UINT8 AttemptConfigIndex)

Variables

UINT8 IScsiConfigVfrBin []
UINT8 IScsiDxeStrings []
ISCSI_FORM_CALLBACK_INFOmCallbackInfo

Detailed Description

The header file of functions for configuring or getting the parameters relating to iSCSI.

Copyright (c) 2004 - 2015, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.


Define Documentation

#define ATTEMPT_DEL_QUESTION_ID   QUESTION_ID (DeleteAttemptList)

#define ATTEMPT_DEL_VAR_OFFSET   VAR_OFFSET (DeleteAttemptList)

#define DYNAMIC_ONE_OF_VAR_OFFSET   VAR_OFFSET (Enabled)

#define DYNAMIC_ORDERED_LIST_QUESTION_ID   QUESTION_ID (DynamicOrderedList)

#define DYNAMIC_ORDERED_LIST_VAR_OFFSET   VAR_OFFSET (DynamicOrderedList)

#define ISCSI_CONFIG_VAR_ATTR   (EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_NON_VOLATILE)

#define ISCSI_FORM_CALLBACK_INFO_FROM_FORM_CALLBACK ( Callback   ) 

Value:

CR ( \
  Callback, \
  ISCSI_FORM_CALLBACK_INFO, \
  ConfigAccess, \
  ISCSI_FORM_CALLBACK_INFO_SIGNATURE \
  )

Referenced by IScsiFormCallback(), and IScsiFormExtractConfig().

#define ISCSI_FORM_CALLBACK_INFO_SIGNATURE   SIGNATURE_32 ('I', 'f', 'c', 'i')

Referenced by IScsiConfigFormInit().

#define ISCSI_INITATOR_NAME_VAR_NAME   L"I_NAME"

#define ISCSI_MAX_MAC_STRING_LEN   96

#define QUESTION_ID ( Field   )     ((UINT16) (VAR_OFFSET (Field) + CONFIG_OPTION_OFFSET))

#define VAR_OFFSET ( Field   )     ((UINT16) ((UINTN) &(((ISCSI_CONFIG_IFR_NVDATA *) 0)->Field)))


Typedef Documentation


Function Documentation

EFI_STATUS IScsiConfigFormInit ( IN EFI_HANDLE  DriverBindingHandle  ) 

Initialize the iSCSI configuration form.

Parameters:
[in] DriverBindingHandle The iSCSI driverbinding handle.
Return values:
EFI_SUCCESS The iSCSI configuration form is initialized.
EFI_OUT_OF_RESOURCES Failed to allocate memory.

References _ISCSI_FORM_CALLBACK_INFO::ConfigAccess, _ISCSI_FORM_CALLBACK_INFO::Current, _ISCSI_FORM_CALLBACK_INFO::DriverHandle, gIScsiConfigGuid, ISCSI_FORM_CALLBACK_INFO_SIGNATURE, IScsiConfigVfrBin, IScsiDxeStrings, IScsiFormCallback(), IScsiFormExtractConfig(), IScsiFormRouteConfig(), _ISCSI_FORM_CALLBACK_INFO::RegisteredHandle, and _ISCSI_FORM_CALLBACK_INFO::Signature.

Referenced by IScsiDriverEntryPoint().

EFI_STATUS IScsiConfigFormUnload ( IN EFI_HANDLE  DriverBindingHandle  ) 

Unload the iSCSI configuration form, this includes: delete all the iSCSI configuration entries, uninstall the form callback protocol, and free the resources used.

Parameters:
[in] DriverBindingHandle The iSCSI driverbinding handle.
Return values:
EFI_SUCCESS The iSCSI configuration form is unloaded.
Others Failed to unload the form.

References ISCSI_PRIVATE_DATA::AttemptConfigs, ISCSI_PRIVATE_DATA::AttemptCount, _ISCSI_FORM_CALLBACK_INFO::ConfigAccess, _ISCSI_FORM_CALLBACK_INFO::DriverHandle, mPrivate, ISCSI_PRIVATE_DATA::NewAttempt, ISCSI_PRIVATE_DATA::NicCount, ISCSI_PRIVATE_DATA::NicInfoList, and _ISCSI_FORM_CALLBACK_INFO::RegisteredHandle.

Referenced by IScsiDriverEntryPoint(), and IScsiUnload().

ISCSI_ATTEMPT_CONFIG_NVDATA* IScsiConfigGetAttemptByConfigIndex ( IN UINT8  AttemptConfigIndex  ) 

Get the attempt config data from global structure by the ConfigIndex.

Parameters:
[in] AttemptConfigIndex The unique index indicates the attempt.
Returns:
Pointer to the attempt config data.
Return values:
NULL The attempt configuration data can not be found.
Get the attempt config data from global structure by the ConfigIndex.

Parameters:
[in] AttemptConfigIndex The unique index indicates the attempt.
Returns:
Pointer to the attempt config data.
Return values:
NULL The attempt configuration data cannot be found.

References _ISCSI_ATTEMPT_CONFIG_NVDATA::AttemptConfigIndex, ISCSI_PRIVATE_DATA::AttemptConfigs, and mPrivate.

Referenced by IScsiConfigOrderAttempts(), IScsiConfigProcessDefault(), IScsiConvertIfrNvDataToAttemptConfigData(), IScsiFillNICAndTargetSections(), and IScsiGetConfigData().

VOID IScsiConfigUpdateAttempt ( VOID   ) 


Variable Documentation

Referenced by IScsiConfigFormInit().

UINT8 IScsiDxeStrings[]

Referenced by IScsiConfigFormInit().

Referenced by IScsiGetConfigData().


Generated on Mon Sep 28 08:49:06 2015 for NetworkPkg[ALL] by  doxygen 1.5.7.1