/** @file
The header file of IScsiConfig.c.
Copyright (c) 2004 - 2009, Intel Corporation. All rights reserved.<BR>
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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#ifndef _ISCSI_CONFIG_H_
#define _ISCSI_CONFIG_H_
#include <Guid/MdeModuleHii.h>
#include <Protocol/HiiConfigRouting.h>
#include <Library/DevicePathLib.h>
#include <Library/DebugLib.h>
extern UINT8 IScsiConfigDxeBin[];
extern UINT8 IScsiDxeStrings[];
/**
If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear,
then this macro return a pointer to a data structure ISCSI_FORM_CALLBACK_INFO.
If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set,
The Signature field of the data structure ISCSI_FORM_CALLBACK_INFO
is compared to TestSignature. If the signatures match, then a pointer
to the pointer to a data structure ISCSI_FORM_CALLBACK_INFO is returned.
If the signatures do not match, then DebugAssert() is called with a description
of "CR has a bad signature" and Callback is returned.
If the data type ISCSI_FORM_CALLBACK_INFO_SIGNATURE does not contain the field
specified by Callback, then the module will not compile.
If ISCSI_FORM_CALLBACK_INFO_SIGNATURE does not contain a field called Signature,
then the module will not compile.
@param Callback Pointer to the specified field within the data
structure ISCSI_FORM_CALLBACK_INFO.
@return A pointer to the pointer to a data structure ISCSI_FORM_CALLBACK_INFO.
@retval Others Some unexpected error happened.
**/
CR ( \
Callback, \
ConfigAccess, \
)
#pragma pack(1)
typedef struct _ISCSI_MAC_INFO {
typedef struct _ISCSI_DEVICE_LIST {
#pragma pack()
typedef struct _ISCSI_CONFIG_FORM_ENTRY {
typedef struct _ISCSI_FORM_CALLBACK_INFO {
#pragma pack(1)
///
/// HII specific Vendor Device Path definition.
///
typedef struct {
#pragma pack()
/**
device specified by the Controller.
@param[in] DriverBindingHandle The driverbinding handle.
@param[in] Controller The controller handle of the iSCSI device.
@param[in] AddForm Whether to add or delete a form entry.
@retval EFI_SUCCESS The iSCSI configuration form is updated.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
@retval Others Other errors as indicated.
**/
);
/**
Initialize the iSCSI configuration form.
@param[in] DriverBindingHandle The iSCSI driverbinding handle.
@retval EFI_SUCCESS The iSCSI configuration form is initialized.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
@retval Others Other errors as indicated.
**/
);
/**
Unload the iSCSI configuration form, this includes: delete all the iSCSI
device configuration entries, uninstall the form callback protocol and
free the resources used.
@param[in] DriverBindingHandle The iSCSI driverbinding handle.
@retval EFI_SUCCESS The iSCSI configuration form is unloaded.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
);
#endif