Dhcp4Option.h

Go to the documentation of this file.

 
#ifndef __EFI_DHCP4_OPTION_H__
#define __EFI_DHCP4_OPTION_H__
 
 
#define DHCP_OPTION_MAGIC  0x63538263        // Network byte order
#define DHCP_MAX_OPTIONS   256
 
//
// DHCP option types, this is used to validate the DHCP options.
//
#define DHCP_OPTION_SWITCH  1
#define DHCP_OPTION_INT8    2
#define DHCP_OPTION_INT16   3
#define DHCP_OPTION_INT32   4
#define DHCP_OPTION_IP      5
#define DHCP_OPTION_IPPAIR  6
 
//
// Value of DHCP overload option
//
#define DHCP_OVERLOAD_FILENAME  1
#define DHCP_OVERLOAD_SVRNAME   2
#define DHCP_OVERLOAD_BOTH      3
 
typedef struct {
  UINT8     Tag;
  UINT16    Len;
  UINT8     *Data;
} DHCP_OPTION;
 
typedef struct {
  UINT8     Index;
  UINT16    Offset;
} DHCP_OPTION_COUNT;
 
typedef struct {
  DHCP_OPTION_COUNT    *OpCount;
  DHCP_OPTION          *Options;
  UINT8                *Buf;
} DHCP_OPTION_CONTEXT;
 
typedef struct {
  IP4_ADDR    NetMask;                // DHCP4_TAG_NETMASK
  IP4_ADDR    Router;                 // DHCP4_TAG_ROUTER, only the first router is used
 
  //
  // DHCP specific options
  //
  UINT8       DhcpType;               // DHCP4_TAG_MSG_TYPE
  UINT8       Overload;               // DHCP4_TAG_OVERLOAD
  IP4_ADDR    ServerId;               // DHCP4_TAG_SERVER_ID
  UINT32      Lease;                  // DHCP4_TAG_LEASE
  UINT32      T1;                     // DHCP4_TAG_T1
  UINT32      T2;                     // DHCP4_TAG_T2
} DHCP_PARAMETER;
 
typedef struct {
  UINT8      Tag;
  INTN       Type;
  INTN       MinOccur;
  INTN       MaxOccur;
  BOOLEAN    Alert;
} DHCP_OPTION_FORMAT;
 
typedef
EFI_STATUS
(*DHCP_CHECK_OPTION) (
  IN UINT8  Tag,
  IN UINT8  Len,
  IN UINT8  *Data,
  IN VOID   *Context
  );
 
EFI_STATUS
DhcpIterateOptions (
  IN  EFI_DHCP4_PACKET   *Packet,
  IN  DHCP_CHECK_OPTION  Check         OPTIONAL,
  IN  VOID               *Context
  );
 
EFI_STATUS
DhcpValidateOptions (
  IN  EFI_DHCP4_PACKET  *Packet,
  OUT DHCP_PARAMETER    **Para       OPTIONAL
  );
 
EFI_STATUS
DhcpParseOption (
  IN  EFI_DHCP4_PACKET  *Packet,
  OUT INTN              *Count,
  OUT DHCP_OPTION       **OptionPoint
  );
 
UINT8 *
DhcpAppendOption (
  OUT UINT8   *Buf,
  IN  UINT8   Tag,
  IN  UINT16  DataLen,
  IN  UINT8   *Data
  );
 
EFI_STATUS
DhcpBuild (
  IN  EFI_DHCP4_PACKET         *SeedPacket,
  IN  UINT32                   DeleteCount,
  IN  UINT8                    *DeleteList     OPTIONAL,
  IN  UINT32                   AppendCount,
  IN  EFI_DHCP4_PACKET_OPTION  *AppendList[]   OPTIONAL,
  OUT EFI_DHCP4_PACKET         **NewPacket
  );
 
#endif