iPXE
Data Structures | Defines | Typedefs | Enumerations | Functions | Variables
Dhcp4.h File Reference

EFI_DHCP4_PROTOCOL as defined in UEFI 2.0. More...

Go to the source code of this file.

Data Structures

struct  EFI_DHCP4_PACKET_OPTION
struct  EFI_DHCP4_HEADER
 EFI_DHCP4_PACKET defines the format of DHCPv4 packets. More...
struct  EFI_DHCP4_PACKET
struct  EFI_DHCP4_CONFIG_DATA
struct  EFI_DHCP4_MODE_DATA
struct  EFI_DHCP4_LISTEN_POINT
struct  EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN
struct  _EFI_DHCP4_PROTOCOL
 This protocol is used to collect configuration information for the EFI IPv4 Protocol drivers and to provide DHCPv4 server and PXE boot server discovery services. More...

Defines

#define EFI_DHCP4_PROTOCOL_GUID
#define EFI_DHCP4_SERVICE_BINDING_PROTOCOL_GUID

Typedefs

typedef struct _EFI_DHCP4_PROTOCOL EFI_DHCP4_PROTOCOL
typedef EFI_STATUS(EFIAPIEFI_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)
 Callback routine.
typedef EFI_STATUS(EFIAPIEFI_DHCP4_GET_MODE_DATA )(IN EFI_DHCP4_PROTOCOL *This, OUT EFI_DHCP4_MODE_DATA *Dhcp4ModeData)
 Returns the current operating mode and cached data packet for the EFI DHCPv4 Protocol driver.
typedef EFI_STATUS(EFIAPIEFI_DHCP4_CONFIGURE )(IN EFI_DHCP4_PROTOCOL *This, IN EFI_DHCP4_CONFIG_DATA *Dhcp4CfgData OPTIONAL)
 Initializes, changes, or resets the operational settings for the EFI DHCPv4 Protocol driver.
typedef EFI_STATUS(EFIAPIEFI_DHCP4_START )(IN EFI_DHCP4_PROTOCOL *This, IN EFI_EVENT CompletionEvent OPTIONAL)
 Starts the DHCP configuration process.
typedef EFI_STATUS(EFIAPIEFI_DHCP4_RENEW_REBIND )(IN EFI_DHCP4_PROTOCOL *This, IN BOOLEAN RebindRequest, IN EFI_EVENT CompletionEvent OPTIONAL)
 Extends the lease time by sending a request packet.
typedef EFI_STATUS(EFIAPIEFI_DHCP4_RELEASE )(IN EFI_DHCP4_PROTOCOL *This)
 Releases the current address configuration.
typedef EFI_STATUS(EFIAPIEFI_DHCP4_STOP )(IN EFI_DHCP4_PROTOCOL *This)
 Stops the current address configuration.
typedef EFI_STATUS(EFIAPIEFI_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)
 Builds a DHCP packet, given the options to be appended or deleted or replaced.
typedef EFI_STATUS(EFIAPIEFI_DHCP4_TRANSMIT_RECEIVE )(IN EFI_DHCP4_PROTOCOL *This, IN EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN *Token)
 Transmits a DHCP formatted packet and optionally waits for responses.
typedef EFI_STATUS(EFIAPIEFI_DHCP4_PARSE )(IN EFI_DHCP4_PROTOCOL *This, IN EFI_DHCP4_PACKET *Packet, IN OUT UINT32 *OptionCount, OUT EFI_DHCP4_PACKET_OPTION *PacketOptionList[] OPTIONAL)
 Parses the packed DHCP option data.

Enumerations

enum  EFI_DHCP4_STATE {
  Dhcp4Stopped = 0x0, Dhcp4Init = 0x1, Dhcp4Selecting = 0x2, Dhcp4Requesting = 0x3,
  Dhcp4Bound = 0x4, Dhcp4Renewing = 0x5, Dhcp4Rebinding = 0x6, Dhcp4InitReboot = 0x7,
  Dhcp4Rebooting = 0x8
}
enum  EFI_DHCP4_EVENT {
  Dhcp4SendDiscover = 0x01, Dhcp4RcvdOffer = 0x02, Dhcp4SelectOffer = 0x03, Dhcp4SendRequest = 0x04,
  Dhcp4RcvdAck = 0x05, Dhcp4RcvdNak = 0x06, Dhcp4SendDecline = 0x07, Dhcp4BoundCompleted = 0x08,
  Dhcp4EnterRenewing = 0x09, Dhcp4EnterRebinding = 0x0a, Dhcp4AddressLost = 0x0b, Dhcp4Fail = 0x0c
}

Functions

 FILE_LICENCE (BSD3)

Variables

EFI_GUID gEfiDhcp4ProtocolGuid
EFI_GUID gEfiDhcp4ServiceBindingProtocolGuid

Detailed Description

EFI_DHCP4_PROTOCOL as defined in UEFI 2.0.

EFI_DHCP4_SERVICE_BINDING_PROTOCOL as defined in UEFI 2.0. These protocols are used to collect configuration information for the EFI IPv4 Protocol drivers and to provide DHCPv4 server and PXE boot server discovery services.

Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Revision Reference:
This Protocol was introduced in UEFI Specification 2.0.

Definition in file Dhcp4.h.


Define Documentation

Value:
{ \
    0x8a219718, 0x4ef5, 0x4761, {0x91, 0xc8, 0xc0, 0xf0, 0x4b, 0xda, 0x9e, 0x56 } \
  }

Definition at line 26 of file Dhcp4.h.

Value:
{ \
    0x9d9a39d8, 0xbd42, 0x4a73, {0xa4, 0xd5, 0x8e, 0xe9, 0x4b, 0xe1, 0x13, 0x80 } \
  }

Definition at line 31 of file Dhcp4.h.


Typedef Documentation

Definition at line 36 of file Dhcp4.h.

Callback routine.

EFI_DHCP4_CALLBACK is provided by the consumer of the EFI DHCPv4 Protocol driver to intercept events that occurred in the configuration process. This structure provides advanced control of each state transition of the DHCP process. The returned status code determines the behavior of the EFI DHCPv4 Protocol driver. There are three possible returned values, which are described in the following table.

Parameters:
ThisThe pointer to the EFI DHCPv4 Protocol instance that is used to configure this callback function.
ContextThe pointer to the context that is initialized by EFI_DHCP4_PROTOCOL.Configure().
CurrentStateThe current operational state of the EFI DHCPv4 Protocol driver.
Dhcp4EventThe event that occurs in the current state, which usually means a state transition.
PacketThe DHCP packet that is going to be sent or already received.
NewPacketThe packet that is used to replace the above Packet.
Return values:
EFI_SUCCESSTells the EFI DHCPv4 Protocol driver to continue the DHCP process. When it is in the Dhcp4Selecting state, it tells the EFI DHCPv4 Protocol driver to stop collecting additional packets. The driver will exit the Dhcp4Selecting state and enter the Dhcp4Requesting state.
EFI_NOT_READYOnly used in the Dhcp4Selecting state. The EFI DHCPv4 Protocol driver will continue to wait for more packets until the retry timeout expires.
EFI_ABORTEDTells the EFI DHCPv4 Protocol driver to abort the current process and return to the Dhcp4Init or Dhcp4InitReboot state.

Definition at line 245 of file Dhcp4.h.

Returns the current operating mode and cached data packet for the EFI DHCPv4 Protocol driver.

The GetModeData() function returns the current operating mode and cached data packet for the EFI DHCPv4 Protocol driver.

Parameters:
ThisThe pointer to the EFI_DHCP4_PROTOCOL instance.
Dhcp4ModeDataThe pointer to storage for the EFI_DHCP4_MODE_DATA structure.
Return values:
EFI_SUCCESSThe mode data was returned.
EFI_INVALID_PARAMETERThis is NULL.

Definition at line 438 of file Dhcp4.h.

Initializes, changes, or resets the operational settings for the EFI DHCPv4 Protocol driver.

The Configure() function is used to initialize, change, or reset the operational settings of the EFI DHCPv4 Protocol driver for the communication device on which the EFI DHCPv4 Service Binding Protocol is installed. This function can be successfully called only if both of the following are true: This instance of the EFI DHCPv4 Protocol driver is in the Dhcp4Stopped, Dhcp4Init, Dhcp4InitReboot, or Dhcp4Bound states. No other EFI DHCPv4 Protocol driver instance that is controlled by this EFI DHCPv4 Service Binding Protocol driver instance has configured this EFI DHCPv4 Protocol driver. When this driver is in the Dhcp4Stopped state, it can transfer into one of the following two possible initial states: Dhcp4Init Dhcp4InitReboot. The driver can transfer into these states by calling Configure() with a non-NULL Dhcp4CfgData. The driver will transfer into the appropriate state based on the supplied client network address in the ClientAddress parameter and DHCP options in the OptionList parameter as described in RFC 2131. When Configure() is called successfully while Dhcp4CfgData is set to NULL, the default configuring data will be reset in the EFI DHCPv4 Protocol driver and the state of the EFI DHCPv4 Protocol driver will not be changed. If one instance wants to make it possible for another instance to configure the EFI DHCPv4 Protocol driver, it must call this function with Dhcp4CfgData set to NULL.

Parameters:
ThisThe pointer to the EFI_DHCP4_PROTOCOL instance.
Dhcp4CfgDataThe pointer to the EFI_DHCP4_CONFIG_DATA.
Return values:
EFI_SUCCESSThe EFI DHCPv4 Protocol driver is now in the Dhcp4Init or Dhcp4InitReboot state, if the original state of this driver was Dhcp4Stopped, Dhcp4Init,Dhcp4InitReboot, or Dhcp4Bound and the value of Dhcp4CfgData was not NULL. Otherwise, the state was left unchanged.
EFI_ACCESS_DENIEDThis instance of the EFI DHCPv4 Protocol driver was not in the Dhcp4Stopped, Dhcp4Init, Dhcp4InitReboot, or Dhcp4Bound state; Or onother instance of this EFI DHCPv4 Protocol driver is already in a valid configured state.
EFI_INVALID_PARAMETEROne or more following conditions are TRUE: This is NULL. DiscoverTryCount > 0 and DiscoverTimeout is NULL RequestTryCount > 0 and RequestTimeout is NULL. OptionCount >0 and OptionList is NULL. ClientAddress is not a valid unicast address.
EFI_OUT_OF_RESOURCESRequired system resources could not be allocated.
EFI_DEVICE_ERRORAn unexpected system or network error occurred.

Definition at line 493 of file Dhcp4.h.

Starts the DHCP configuration process.

The Start() function starts the DHCP configuration process. This function can be called only when the EFI DHCPv4 Protocol driver is in the Dhcp4Init or Dhcp4InitReboot state. If the DHCP process completes successfully, the state of the EFI DHCPv4 Protocol driver will be transferred through Dhcp4Selecting and Dhcp4Requesting to the Dhcp4Bound state. The CompletionEvent will then be signaled if it is not NULL. If the process aborts, either by the user or by some unexpected network error, the state is restored to the Dhcp4Init state. The Start() function can be called again to restart the process. Refer to RFC 2131 for precise state transitions during this process. At the time when each event occurs in this process, the callback function that was set by EFI_DHCP4_PROTOCOL.Configure() will be called and the user can take this opportunity to control the process.

Parameters:
ThisThe pointer to the EFI_DHCP4_PROTOCOL instance.
CompletionEventIf not NULL, it indicates the event that will be signaled when the EFI DHCPv4 Protocol driver is transferred into the Dhcp4Bound state or when the DHCP process is aborted. EFI_DHCP4_PROTOCOL.GetModeData() can be called to check the completion status. If NULL, EFI_DHCP4_PROTOCOL.Start() will wait until the driver is transferred into the Dhcp4Bound state or the process fails.
Return values:
EFI_SUCCESSThe DHCP configuration process has started, or it has completed when CompletionEvent is NULL.
EFI_NOT_STARTEDThe EFI DHCPv4 Protocol driver is in the Dhcp4Stopped state. EFI_DHCP4_PROTOCOL. Configure() needs to be called.
EFI_INVALID_PARAMETERThis is NULL.
EFI_OUT_OF_RESOURCESRequired system resources could not be allocated.
EFI_TIMEOUTThe DHCP configuration process failed because no response was received from the server within the specified timeout value.
EFI_ABORTEDThe user aborted the DHCP process.
EFI_ALREADY_STARTEDSome other EFI DHCPv4 Protocol instance already started the DHCP process.
EFI_DEVICE_ERRORAn unexpected system or network error occurred.
EFI_NO_MEDIAThere was a media error.

Definition at line 542 of file Dhcp4.h.

typedef EFI_STATUS(EFIAPI * EFI_DHCP4_RENEW_REBIND)(IN EFI_DHCP4_PROTOCOL *This, IN BOOLEAN RebindRequest, IN EFI_EVENT CompletionEvent OPTIONAL)

Extends the lease time by sending a request packet.

The RenewRebind() function is used to manually extend the lease time when the EFI DHCPv4 Protocol driver is in the Dhcp4Bound state, and the lease time has not expired yet. This function will send a request packet to the previously found server (or to any server when RebindRequest is TRUE) and transfer the state into the Dhcp4Renewing state (or Dhcp4Rebinding when RebindingRequest is TRUE). When a response is received, the state is returned to Dhcp4Bound. If no response is received before the try count is exceeded (the RequestTryCount field that is specified in EFI_DHCP4_CONFIG_DATA) but before the lease time that was issued by the previous server expires, the driver will return to the Dhcp4Bound state, and the previous configuration is restored. The outgoing and incoming packets can be captured by the EFI_DHCP4_CALLBACK function.

Parameters:
ThisThe pointer to the EFI_DHCP4_PROTOCOL instance.
RebindRequestIf TRUE, this function broadcasts the request packets and enters the Dhcp4Rebinding state. Otherwise, it sends a unicast request packet and enters the Dhcp4Renewing state.
CompletionEventIf not NULL, this event is signaled when the renew/rebind phase completes or some error occurs. EFI_DHCP4_PROTOCOL.GetModeData() can be called to check the completion status. If NULL, EFI_DHCP4_PROTOCOL.RenewRebind() will busy-wait until the DHCP process finishes.
Return values:
EFI_SUCCESSThe EFI DHCPv4 Protocol driver is now in the Dhcp4Renewing state or is back to the Dhcp4Bound state.
EFI_NOT_STARTEDThe EFI DHCPv4 Protocol driver is in the Dhcp4Stopped state. EFI_DHCP4_PROTOCOL.Configure() needs to be called.
EFI_INVALID_PARAMETERThis is NULL.
EFI_TIMEOUTThere was no response from the server when the try count was exceeded.
EFI_ACCESS_DENIEDThe driver is not in the Dhcp4Bound state.
EFI_DEVICE_ERRORAn unexpected system or network error occurred.

Definition at line 587 of file Dhcp4.h.

Releases the current address configuration.

The Release() function releases the current configured IP address by doing either of the following: Sending a DHCPRELEASE packet when the EFI DHCPv4 Protocol driver is in the Dhcp4Bound state Setting the previously assigned IP address that was provided with the EFI_DHCP4_PROTOCOL.Configure() function to 0.0.0.0 when the driver is in Dhcp4InitReboot state After a successful call to this function, the EFI DHCPv4 Protocol driver returns to the Dhcp4Init state, and any subsequent incoming packets will be discarded silently.

Parameters:
ThisThe pointer to the EFI_DHCP4_PROTOCOL instance.
Return values:
EFI_SUCCESSThe EFI DHCPv4 Protocol driver is now in the Dhcp4Init phase.
EFI_INVALID_PARAMETERThis is NULL.
EFI_ACCESS_DENIEDThe EFI DHCPv4 Protocol driver is not Dhcp4InitReboot state.
EFI_DEVICE_ERRORAn unexpected system or network error occurred.

Definition at line 616 of file Dhcp4.h.

Stops the current address configuration.

The Stop() function is used to stop the DHCP configuration process. After this function is called successfully, the EFI DHCPv4 Protocol driver is transferred into the Dhcp4Stopped state. EFI_DHCP4_PROTOCOL.Configure() needs to be called before DHCP configuration process can be started again. This function can be called when the EFI DHCPv4 Protocol driver is in any state.

Parameters:
ThisThe pointer to the EFI_DHCP4_PROTOCOL instance.
Return values:
EFI_SUCCESSThe EFI DHCPv4 Protocol driver is now in the Dhcp4Stopped phase.
EFI_INVALID_PARAMETERThis is NULL.

Definition at line 637 of file Dhcp4.h.

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)

Builds a DHCP packet, given the options to be appended or deleted or replaced.

The Build() function is used to assemble a new packet from the original packet by replacing or deleting existing options or appending new options. This function does not change any state of the EFI DHCPv4 Protocol driver and can be used at any time.

Parameters:
ThisThe pointer to the EFI_DHCP4_PROTOCOL instance.
SeedPacketInitial packet to be used as a base for building new packet.
DeleteCountNumber of opcodes in the DeleteList.
DeleteListList of opcodes to be deleted from the seed packet. Ignored if DeleteCount is zero.
AppendCountNumber of entries in the OptionList.
AppendListThe pointer to a DHCP option list to be appended to SeedPacket. If SeedPacket also contains options in this list, they are replaced by new options (except pad option). Ignored if AppendCount is zero. Type EFI_DHCP4_PACKET_OPTION
NewPacketThe pointer to storage for the pointer to the new allocated packet. Use the EFI Boot Service FreePool() on the resulting pointer when done with the packet.
Return values:
EFI_SUCCESSThe new packet was built.
EFI_OUT_OF_RESOURCESStorage for the new packet could not be allocated.
EFI_INVALID_PARAMETEROne or more of the following conditions is TRUE: This is NULL. SeedPacket is NULL. SeedPacket is not a well-formed DHCP packet. AppendCount is not zero and AppendList is NULL. DeleteCount is not zero and DeleteList is NULL. NewPacket is NULL Both DeleteCount and AppendCount are zero and NewPacket is not NULL.

Definition at line 678 of file Dhcp4.h.

Transmits a DHCP formatted packet and optionally waits for responses.

The TransmitReceive() function is used to transmit a DHCP packet and optionally wait for the response from servers. This function does not change the state of the EFI DHCPv4 Protocol driver. It can be used at any time because of this.

Parameters:
ThisThe pointer to the EFI_DHCP4_PROTOCOL instance.
TokenThe pointer to the EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN structure.
Return values:
EFI_SUCCESSThe packet was successfully queued for transmission.
EFI_INVALID_PARAMETEROne or more of the following conditions is TRUE: This is NULL. Token.RemoteAddress is zero. Token.Packet is NULL. Token.Packet is not a well-formed DHCP packet. The transaction ID in Token.Packet is in use by another DHCP process.
EFI_NOT_READYThe previous call to this function has not finished yet. Try to call this function after collection process completes.
EFI_NO_MAPPINGThe default station address is not available yet.
EFI_OUT_OF_RESOURCESRequired system resources could not be allocated.
EFI_UNSUPPORTEDThe implementation doesn't support this function
OthersSome other unexpected error occurred.

Definition at line 716 of file Dhcp4.h.

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)

Parses the packed DHCP option data.

The Parse() function is used to retrieve the option list from a DHCP packet. If *OptionCount isn't zero, and there is enough space for all the DHCP options in the Packet, each element of PacketOptionList is set to point to somewhere in the Packet->Dhcp4.Option where a new DHCP option begins. If RFC3396 is supported, the caller should reassemble the parsed DHCP options to get the final result. If *OptionCount is zero or there isn't enough space for all of them, the number of DHCP options in the Packet is returned in OptionCount.

Parameters:
ThisThe pointer to the EFI_DHCP4_PROTOCOL instance.
PacketThe pointer to packet to be parsed.
OptionCountOn input, the number of entries in the PacketOptionList. On output, the number of entries that were written into the PacketOptionList.
PacketOptionListA list of packet option entries to be filled in. End option or pad options are not included.
Return values:
EFI_SUCCESSThe packet was successfully parsed.
EFI_INVALID_PARAMETEROne or more of the following conditions is TRUE: This is NULL. The packet is NULL. The packet is not a well-formed DHCP packet. OptionCount is NULL.
EFI_BUFFER_TOO_SMALLOne or more of the following conditions is TRUE: 1) *OptionCount is smaller than the number of options that were found in the Packet. 2) PacketOptionList is NULL.
EFI_OUT_OF_RESOURCEThe packet failed to parse because of a resource shortage.

Definition at line 756 of file Dhcp4.h.


Enumeration Type Documentation

Enumerator:
Dhcp4Stopped 

The EFI DHCPv4 Protocol driver is stopped.

Dhcp4Init 

The EFI DHCPv4 Protocol driver is inactive.

Dhcp4Selecting 

The EFI DHCPv4 Protocol driver is collecting DHCP offer packets from DHCP servers.

Dhcp4Requesting 

The EFI DHCPv4 Protocol driver has sent the request to the DHCP server and is waiting for a response.

Dhcp4Bound 

The DHCP configuration has completed.

Dhcp4Renewing 

The DHCP configuration is being renewed and another request has been sent out, but it has not received a response from the server yet.

Dhcp4Rebinding 

The DHCP configuration has timed out and the EFI DHCPv4 Protocol driver is trying to extend the lease time.

Dhcp4InitReboot 

The EFI DHCPv4 Protocol driver was initialized with a previously allocated or known IP address.

Dhcp4Rebooting 

The EFI DHCPv4 Protocol driver is seeking to reuse the previously allocated IP address by sending a request to the DHCP server.

Definition at line 110 of file Dhcp4.h.

             {
  ///
  /// The EFI DHCPv4 Protocol driver is stopped.
  ///
  Dhcp4Stopped        = 0x0,
  ///
  /// The EFI DHCPv4 Protocol driver is inactive.
  ///
  Dhcp4Init           = 0x1,
  ///
  /// The EFI DHCPv4 Protocol driver is collecting DHCP offer packets from DHCP servers.
  ///
  Dhcp4Selecting      = 0x2,
  ///
  /// The EFI DHCPv4 Protocol driver has sent the request to the DHCP server and is waiting for a response.
  ///
  Dhcp4Requesting     = 0x3,
  ///
  /// The DHCP configuration has completed.
  ///
  Dhcp4Bound          = 0x4,
  ///
  /// The DHCP configuration is being renewed and another request has
  /// been sent out, but it has not received a response from the server yet.
  ///
  Dhcp4Renewing       = 0x5,
  ///
  /// The DHCP configuration has timed out and the EFI DHCPv4
  /// Protocol driver is trying to extend the lease time.
  ///
  Dhcp4Rebinding      = 0x6,
  ///
  /// The EFI DHCPv4 Protocol driver was initialized with a previously
  /// allocated or known IP address.
  ///
  Dhcp4InitReboot     = 0x7,
  ///
  /// The EFI DHCPv4 Protocol driver is seeking to reuse the previously
  /// allocated IP address by sending a request to the DHCP server.
  ///
  Dhcp4Rebooting      = 0x8
} EFI_DHCP4_STATE;
Enumerator:
Dhcp4SendDiscover 

The packet to start the configuration sequence is about to be sent.

Dhcp4RcvdOffer 

A reply packet was just received.

Dhcp4SelectOffer 

It is time for Dhcp4Callback to select an offer.

Dhcp4SendRequest 

A request packet is about to be sent.

Dhcp4RcvdAck 

A DHCPACK packet was received and will be passed to Dhcp4Callback.

Dhcp4RcvdNak 

A DHCPNAK packet was received and will be passed to Dhcp4Callback.

Dhcp4SendDecline 

A decline packet is about to be sent.

Dhcp4BoundCompleted 

The DHCP configuration process has completed.

No packet is associated with this event.

Dhcp4EnterRenewing 

It is time to enter the Dhcp4Renewing state and to contact the server that originally issued the network address.

No packet is associated with this event.

Dhcp4EnterRebinding 

It is time to enter the Dhcp4Rebinding state and to contact any server.

No packet is associated with this event.

Dhcp4AddressLost 

The configured IP address was lost either because the lease has expired, the user released the configuration, or a DHCPNAK packet was received in the Dhcp4Renewing or Dhcp4Rebinding state.

No packet is associated with this event.

Dhcp4Fail 

The DHCP process failed because a DHCPNAK packet was received or the user aborted the DHCP process at a time when the configuration was not available yet.

No packet is associated with this event.

Definition at line 154 of file Dhcp4.h.

            {
  ///
  /// The packet to start the configuration sequence is about to be sent.
  ///
  Dhcp4SendDiscover   = 0x01,
  ///
  /// A reply packet was just received.
  ///
  Dhcp4RcvdOffer      = 0x02,
  ///
  /// It is time for Dhcp4Callback to select an offer.
  ///
  Dhcp4SelectOffer    = 0x03,
  ///
  /// A request packet is about to be sent.
  ///
  Dhcp4SendRequest    = 0x04,
  ///
  /// A DHCPACK packet was received and will be passed to Dhcp4Callback.
  ///
  Dhcp4RcvdAck        = 0x05,
  ///
  /// A DHCPNAK packet was received and will be passed to Dhcp4Callback.
  ///
  Dhcp4RcvdNak        = 0x06,
  ///
  /// A decline packet is about to be sent.
  ///
  Dhcp4SendDecline    = 0x07,
  ///
  /// The DHCP configuration process has completed. No packet is associated with this event.
  ///
  Dhcp4BoundCompleted = 0x08,
  ///
  /// It is time to enter the Dhcp4Renewing state and to contact the server
  /// that originally issued the network address. No packet is associated with this event.
  ///
  Dhcp4EnterRenewing  = 0x09,
  ///
  /// It is time to enter the Dhcp4Rebinding state and to contact any server.
  /// No packet is associated with this event.
  ///
  Dhcp4EnterRebinding = 0x0a,
  ///
  /// The configured IP address was lost either because the lease has expired,
  /// the user released the configuration, or a DHCPNAK packet was received in
  /// the Dhcp4Renewing or Dhcp4Rebinding state. No packet is associated with this event.
  ///
  Dhcp4AddressLost    = 0x0b,
  ///
  /// The DHCP process failed because a DHCPNAK packet was received or the user
  /// aborted the DHCP process at a time when the configuration was not available yet.
  /// No packet is associated with this event.
  ///
  Dhcp4Fail           = 0x0c
} EFI_DHCP4_EVENT;

Function Documentation

FILE_LICENCE ( BSD3  )

Variable Documentation