Home | History | Annotate | Download | only in IScsiDxe
      1 /** @file
      2   The header file of IScsiDhcp.
      3 
      4 Copyright (c) 2004 - 2010, Intel Corporation. All rights reserved.<BR>
      5 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 #define RP_FIELD_IDX_SERVERNAME         0
     30 #define RP_FIELD_IDX_PROTOCOL           1
     31 #define RP_FIELD_IDX_PORT               2
     32 #define RP_FIELD_IDX_LUN                3
     33 #define RP_FIELD_IDX_TARGETNAME         4
     34 #define RP_FIELD_IDX_MAX                5
     35 
     36 typedef struct _ISCSI_ROOT_PATH_FIELD {
     37   CHAR8 *Str;
     38   UINT8 Len;
     39 } ISCSI_ROOT_PATH_FIELD;
     40 
     41 /**
     42   Parse the DHCP ACK to get the address configuration and DNS information.
     43 
     44   @param[in]       Image            The handle of the driver image.
     45   @param[in]       Controller       The handle of the controller;
     46   @param[in, out]  ConfigData       The session configuration data.
     47 
     48   @retval EFI_SUCCESS           The DNS information is got from the DHCP ACK.
     49   @retval EFI_OUT_OF_RESOURCES  Failed to allocate memory.
     50   @retval EFI_NO_MEDIA          There was a media error.
     51   @retval Others                Other errors as indicated.
     52 
     53 **/
     54 EFI_STATUS
     55 IScsiDoDhcp (
     56   IN     EFI_HANDLE                 Image,
     57   IN     EFI_HANDLE                 Controller,
     58   IN OUT ISCSI_SESSION_CONFIG_DATA  *ConfigData
     59   );
     60 
     61 #endif
     62