Dhcp4.h

Go to the documentation of this file.

 
#ifndef __EFI_DHCP4_PROTOCOL_H__
#define __EFI_DHCP4_PROTOCOL_H__
 
#define EFI_DHCP4_PROTOCOL_GUID \
  { \
    0x8a219718, 0x4ef5, 0x4761, {0x91, 0xc8, 0xc0, 0xf0, 0x4b, 0xda, 0x9e, 0x56 } \
  }
 
#define EFI_DHCP4_SERVICE_BINDING_PROTOCOL_GUID \
  { \
    0x9d9a39d8, 0xbd42, 0x4a73, {0xa4, 0xd5, 0x8e, 0xe9, 0x4b, 0xe1, 0x13, 0x80 } \
  }
 
typedef struct _EFI_DHCP4_PROTOCOL EFI_DHCP4_PROTOCOL;
 
#pragma pack(1)
typedef struct {
  UINT8    OpCode;
  UINT8    Length;
  UINT8    Data[1];
} EFI_DHCP4_PACKET_OPTION;
#pragma pack()
 
#pragma pack(1)
typedef struct {
  UINT8               OpCode;
  UINT8               HwType;
  UINT8               HwAddrLen;
  UINT8               Hops;
  UINT32              Xid;
  UINT16              Seconds;
  UINT16              Reserved;
  EFI_IPv4_ADDRESS    ClientAddr;       
  EFI_IPv4_ADDRESS    YourAddr;         
  EFI_IPv4_ADDRESS    ServerAddr;       
  EFI_IPv4_ADDRESS    GatewayAddr;      
  UINT8               ClientHwAddr[16]; 
  CHAR8               ServerName[64];
  CHAR8               BootFileName[128];
} EFI_DHCP4_HEADER;
#pragma pack()
 
#pragma pack(1)
typedef struct {
  UINT32    Size;
  UINT32    Length;
 
  struct {
    EFI_DHCP4_HEADER    Header;
    UINT32              Magik;
    UINT8               Option[1];
  } Dhcp4;
} EFI_DHCP4_PACKET;
#pragma pack()
 
typedef enum {
  Dhcp4Stopped = 0x0,
  Dhcp4Init = 0x1,
  Dhcp4Selecting = 0x2,
  Dhcp4Requesting = 0x3,
  Dhcp4Bound = 0x4,
  Dhcp4Renewing = 0x5,
  Dhcp4Rebinding = 0x6,
  Dhcp4InitReboot = 0x7,
  Dhcp4Rebooting = 0x8
} EFI_DHCP4_STATE;
 
typedef enum {
  Dhcp4SendDiscover = 0x01,
  Dhcp4RcvdOffer = 0x02,
  Dhcp4SelectOffer = 0x03,
  Dhcp4SendRequest = 0x04,
  Dhcp4RcvdAck = 0x05,
  Dhcp4RcvdNak = 0x06,
  Dhcp4SendDecline = 0x07,
  Dhcp4BoundCompleted = 0x08,
  Dhcp4EnterRenewing = 0x09,
  Dhcp4EnterRebinding = 0x0a,
  Dhcp4AddressLost = 0x0b,
  Dhcp4Fail = 0x0c
} EFI_DHCP4_EVENT;
 
typedef
EFI_STATUS
(EFIAPI *EFI_DHCP4_CALLBACK)(
  IN  EFI_DHCP4_PROTOCOL         *This,
  IN  VOID                       *Context,
  IN  EFI_DHCP4_STATE            CurrentState,
  IN  EFI_DHCP4_EVENT            Dhcp4Event,
  IN  EFI_DHCP4_PACKET           *Packet     OPTIONAL,
  OUT EFI_DHCP4_PACKET           **NewPacket OPTIONAL
  );
 
typedef struct {
  UINT32                     DiscoverTryCount;
  UINT32                     *DiscoverTimeout;
  UINT32                     RequestTryCount;
  UINT32                     *RequestTimeout;
  EFI_IPv4_ADDRESS           ClientAddress;
  EFI_DHCP4_CALLBACK         Dhcp4Callback;
  VOID                       *CallbackContext;
  UINT32                     OptionCount;
  EFI_DHCP4_PACKET_OPTION    **OptionList;
} EFI_DHCP4_CONFIG_DATA;
 
typedef struct {
  EFI_DHCP4_STATE          State;
  EFI_DHCP4_CONFIG_DATA    ConfigData;
  EFI_IPv4_ADDRESS         ClientAddress;
  EFI_MAC_ADDRESS          ClientMacAddress;
  EFI_IPv4_ADDRESS         ServerAddress;
  EFI_IPv4_ADDRESS         RouterAddress;
  EFI_IPv4_ADDRESS         SubnetMask;
  UINT32                   LeaseTime;
  EFI_DHCP4_PACKET         *ReplyPacket;
} EFI_DHCP4_MODE_DATA;
 
typedef struct {
  EFI_IPv4_ADDRESS    ListenAddress;
  EFI_IPv4_ADDRESS    SubnetMask;
  UINT16              ListenPort;
} EFI_DHCP4_LISTEN_POINT;
 
typedef struct {
  EFI_STATUS                Status;
  EFI_EVENT                 CompletionEvent;
  EFI_IPv4_ADDRESS          RemoteAddress;
  UINT16                    RemotePort;
  EFI_IPv4_ADDRESS          GatewayAddress;
  UINT32                    ListenPointCount;
  EFI_DHCP4_LISTEN_POINT    *ListenPoints;
  UINT32                    TimeoutValue;
  EFI_DHCP4_PACKET          *Packet;
  UINT32                    ResponseCount;
  EFI_DHCP4_PACKET          *ResponseList;
} EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN;
 
typedef
EFI_STATUS
(EFIAPI *EFI_DHCP4_GET_MODE_DATA)(
  IN  EFI_DHCP4_PROTOCOL      *This,
  OUT EFI_DHCP4_MODE_DATA     *Dhcp4ModeData
  );
 
typedef
EFI_STATUS
(EFIAPI *EFI_DHCP4_CONFIGURE)(
  IN EFI_DHCP4_PROTOCOL       *This,
  IN EFI_DHCP4_CONFIG_DATA    *Dhcp4CfgData  OPTIONAL
  );
 
typedef
EFI_STATUS
(EFIAPI *EFI_DHCP4_START)(
  IN EFI_DHCP4_PROTOCOL       *This,
  IN EFI_EVENT                CompletionEvent   OPTIONAL
  );
 
typedef
EFI_STATUS
(EFIAPI *EFI_DHCP4_RENEW_REBIND)(
  IN EFI_DHCP4_PROTOCOL       *This,
  IN BOOLEAN                  RebindRequest,
  IN EFI_EVENT                CompletionEvent  OPTIONAL
  );
 
typedef
EFI_STATUS
(EFIAPI *EFI_DHCP4_RELEASE)(
  IN EFI_DHCP4_PROTOCOL       *This
  );
 
typedef
EFI_STATUS
(EFIAPI *EFI_DHCP4_STOP)(
  IN EFI_DHCP4_PROTOCOL       *This
  );
 
typedef
EFI_STATUS
(EFIAPI *EFI_DHCP4_BUILD)(
  IN  EFI_DHCP4_PROTOCOL      *This,
  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
  );
 
typedef
EFI_STATUS
(EFIAPI *EFI_DHCP4_TRANSMIT_RECEIVE)(
  IN EFI_DHCP4_PROTOCOL                *This,
  IN EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN  *Token
  );
 
typedef
EFI_STATUS
(EFIAPI *EFI_DHCP4_PARSE)(
  IN EFI_DHCP4_PROTOCOL        *This,
  IN EFI_DHCP4_PACKET          *Packet,
  IN OUT UINT32                *OptionCount,
  OUT EFI_DHCP4_PACKET_OPTION  *PacketOptionList[]  OPTIONAL
  );
 
struct _EFI_DHCP4_PROTOCOL {
  EFI_DHCP4_GET_MODE_DATA       GetModeData;
  EFI_DHCP4_CONFIGURE           Configure;
  EFI_DHCP4_START               Start;
  EFI_DHCP4_RENEW_REBIND        RenewRebind;
  EFI_DHCP4_RELEASE             Release;
  EFI_DHCP4_STOP                Stop;
  EFI_DHCP4_BUILD               Build;
  EFI_DHCP4_TRANSMIT_RECEIVE    TransmitReceive;
  EFI_DHCP4_PARSE               Parse;
};
 
extern EFI_GUID  gEfiDhcp4ProtocolGuid;
extern EFI_GUID  gEfiDhcp4ServiceBindingProtocolGuid;
 
#endif