MdeModulePkg/Universal/Network/IScsiDxe/IScsiDhcp.h

   1 /** @file
   2   The header file of IScsiDhcp.
   3
   4 Copyright (c) 2004 - 2008, Intel Corporation.<BR>
   5 All rights reserved. This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef _ISCSI_DHCP_H_
  16 #define _ISCSI_DHCP_H_
  17
  18 #include <Protocol/Dhcp4.h>
  19
  20 #define DHCP4_TAG_PARA_LIST             55
  21 #define DHCP4_TAG_NETMASK               1
  22 #define DHCP4_TAG_ROUTER                3
  23 #define DHCP4_TAG_DNS                   6
  24 #define DHCP4_TAG_SERVER_ID             54
  25 #define DHCP4_TAG_ROOT_PATH             17
  26 #define ISCSI_ROOT_PATH_ID              "iscsi:"
  27 #define ISCSI_ROOT_PATH_FIELD_DELIMITER ':'
  28
  29 typedef enum {
  30   RP_FIELD_IDX_SERVERNAME = 0,
  31   RP_FIELD_IDX_PROTOCOL,
  32   RP_FIELD_IDX_PORT,
  33   RP_FIELD_IDX_LUN,
  34   RP_FIELD_IDX_TARGETNAME,
  35   RP_FIELD_IDX_MAX
  36 } RP_FIELD_IDX;
  37
  38 typedef struct _ISCSI_ROOT_PATH_FIELD {
  39   CHAR8 *Str;
  40   UINT8 Len;
  41 } ISCSI_ROOT_PATH_FIELD;
  42
  43 /**
  44   Parse the DHCP ACK to get the address configuration and DNS information.
  45
  46   @param[in]   Image            The handle of the driver image.
  47   @param[in]   Controller       The handle of the controller;
  48   @param[in]   ConfigData       The session configuration data.
  49
  50   @retval EFI_SUCCESS           The DNS information is got from the DHCP ACK.
  51   @retval EFI_OUT_OF_RESOURCES  Failed to allocate memory.
  52   @retval Others                Some unexpected error happened.
  53 **/
  54 EFI_STATUS
  55 IScsiDoDhcp (
  56   IN EFI_HANDLE                 Image,
  57   IN EFI_HANDLE                 Controller,
  58   IN ISCSI_SESSION_CONFIG_DATA  *ConfigData
  59   );
  60
  61 #endif