for 202033

[mirror_edk2.git] / MdeModulePkg / Universal / Network / IScsiDxe / IScsiDhcp.h

/** @file\r
  Data structure for DHCP support\r
\r
Copyright (c) 2004 - 2008, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
Module Name:\r
\r
  IScsiDhcp.h\r
\r
Abstract:\r
  The header file of IScsiDhcp.c\r
\r
**/\r
\r
#ifndef _ISCSI_DHCP_H_\r
#define _ISCSI_DHCP_H_\r
\r
#include <Protocol/Dhcp4.h>\r
\r
#define DHCP4_TAG_PARA_LIST             55\r
#define DHCP4_TAG_NETMASK               1\r
#define DHCP4_TAG_ROUTER                3\r
#define DHCP4_TAG_DNS                   6\r
#define DHCP4_TAG_SERVER_ID             54\r
#define DHCP4_TAG_ROOT_PATH             17\r
#define ISCSI_ROOT_PATH_ID              "iscsi:"\r
#define ISCSI_ROOT_PATH_FIELD_DELIMITER ':'\r
\r
enum {\r
  RP_FIELD_IDX_SERVERNAME = 0,\r
  RP_FIELD_IDX_PROTOCOL,\r
  RP_FIELD_IDX_PORT,\r
  RP_FIELD_IDX_LUN,\r
  RP_FIELD_IDX_TARGETNAME,\r
  RP_FIELD_IDX_MAX\r
};\r
\r
typedef struct _ISCSI_ROOT_PATH_FIELD {\r
  CHAR8 *Str;\r
  UINT8 Len;\r
} ISCSI_ROOT_PATH_FIELD;\r
\r
/**\r
  Parse the DHCP ACK to get the address configuration and DNS information.\r
  \r
  @param  Image[in]             The handle of the driver image.\r
\r
  @param  Controller[in]        The handle of the controller;\r
\r
  @param  ConfigData[in]        The session configuration data.\r
\r
  @retval EFI_SUCCESS           The DNS information is got from the DHCP ACK.\r
\r
  @retval EFI_NO_MAPPING        DHCP failed to acquire address and other information.\r
\r
  @retval EFI_INVALID_PARAMETER The DHCP ACK's DNS option is mal-formatted.\r
\r
  @retval EFI_DEVICE_ERROR      Some unexpected error happened.\r
\r
**/\r
EFI_STATUS\r
IScsiDoDhcp (\r
  IN EFI_HANDLE                 Image,\r
  IN EFI_HANDLE                 Controller,\r
  IN ISCSI_SESSION_CONFIG_DATA  *ConfigData\r
  );\r
\r
#endif\r