|
MdePkg[all]
1.08
|
|
MdePkg[all]
1.08
|
Data Structures | |
| struct | EFI_DHCP4_PACKET_OPTION |
| struct | EFI_DHCP4_HEADER |
| 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 |
Macros | |
| #define | EFI_DHCP4_PROTOCOL_GUID |
| #define | EFI_DHCP4_SERVICE_BINDING_PROTOCOL_GUID |
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 } |
Variables | |
| EFI_GUID | gEfiDhcp4ProtocolGuid |
| EFI_GUID | gEfiDhcp4ServiceBindingProtocolGuid |
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 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
| #define EFI_DHCP4_PROTOCOL_GUID |
| #define EFI_DHCP4_SERVICE_BINDING_PROTOCOL_GUID |
| typedef EFI_STATUS(EFIAPI * EFI_DHCP4_BUILD)(IN EFI_DHCP4_PROTOCOL *This, IN EFI_DHCP4_PACKET *SeedPacket, IN UINT32 DeleteCount, IN UINT8 *DeleteList, IN UINT32 AppendCount, IN EFI_DHCP4_PACKET_OPTION *AppendList[], 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.
| This | The pointer to the EFI_DHCP4_PROTOCOL instance. |
| SeedPacket | Initial packet to be used as a base for building new packet. |
| DeleteCount | Number of opcodes in the DeleteList. |
| DeleteList | List of opcodes to be deleted from the seed packet. Ignored if DeleteCount is zero. |
| AppendCount | Number of entries in the OptionList. |
| AppendList | The 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 |
| NewPacket | The 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. |
| EFI_SUCCESS | The new packet was built. |
| EFI_OUT_OF_RESOURCES | Storage for the new packet could not be allocated. |
| EFI_INVALID_PARAMETER | One 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. |
| 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, OUT EFI_DHCP4_PACKET **NewPacket) |
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.
| This | The pointer to the EFI DHCPv4 Protocol instance that is used to configure this callback function. |
| Context | The pointer to the context that is initialized by EFI_DHCP4_PROTOCOL.Configure(). |
| CurrentState | The current operational state of the EFI DHCPv4 Protocol driver. |
| Dhcp4Event | The event that occurs in the current state, which usually means a state transition. |
| Packet | The DHCP packet that is going to be sent or already received. |
| NewPacket | The packet that is used to replace the above Packet. |
| EFI_SUCCESS | Tells 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_READY | Only used in the Dhcp4Selecting state. The EFI DHCPv4 Protocol driver will continue to wait for more packets until the retry timeout expires. |
| EFI_ABORTED | Tells the EFI DHCPv4 Protocol driver to abort the current process and return to the Dhcp4Init or Dhcp4InitReboot state. |
| typedef EFI_STATUS(EFIAPI * EFI_DHCP4_CONFIGURE)(IN EFI_DHCP4_PROTOCOL *This, IN EFI_DHCP4_CONFIG_DATA *Dhcp4CfgData) |
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.
| This | The pointer to the EFI_DHCP4_PROTOCOL instance. |
| Dhcp4CfgData | The pointer to the EFI_DHCP4_CONFIG_DATA. |
| EFI_SUCCESS | The 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_DENIED | This 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_PARAMETER | One 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_RESOURCES | Required system resources could not be allocated. |
| EFI_DEVICE_ERROR | An unexpected system or network error occurred. |
| typedef EFI_STATUS(EFIAPI * EFI_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.
The GetModeData() function returns the current operating mode and cached data packet for the EFI DHCPv4 Protocol driver.
| This | The pointer to the EFI_DHCP4_PROTOCOL instance. |
| Dhcp4ModeData | The pointer to storage for the EFI_DHCP4_MODE_DATA structure. |
| EFI_SUCCESS | The mode data was returned. |
| EFI_INVALID_PARAMETER | This is NULL. |
| 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[]) |
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.
| This | The pointer to the EFI_DHCP4_PROTOCOL instance. |
| Packet | The pointer to packet to be parsed. |
| OptionCount | On input, the number of entries in the PacketOptionList. On output, the number of entries that were written into the PacketOptionList. |
| PacketOptionList | A list of packet option entries to be filled in. End option or pad options are not included. |
| EFI_SUCCESS | The packet was successfully parsed. |
| EFI_INVALID_PARAMETER | One 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_SMALL | One 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_RESOURCE | The packet failed to parse because of a resource shortage. |
| typedef struct _EFI_DHCP4_PROTOCOL EFI_DHCP4_PROTOCOL |
| typedef EFI_STATUS(EFIAPI * EFI_DHCP4_RELEASE)(IN EFI_DHCP4_PROTOCOL *This) |
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.
| This | The pointer to the EFI_DHCP4_PROTOCOL instance. |
| EFI_SUCCESS | The EFI DHCPv4 Protocol driver is now in the Dhcp4Init phase. |
| EFI_INVALID_PARAMETER | This is NULL. |
| EFI_ACCESS_DENIED | The EFI DHCPv4 Protocol driver is not Dhcp4InitReboot state. |
| EFI_DEVICE_ERROR | An unexpected system or network error occurred. |
| typedef EFI_STATUS(EFIAPI * EFI_DHCP4_RENEW_REBIND)(IN EFI_DHCP4_PROTOCOL *This, IN BOOLEAN RebindRequest, IN EFI_EVENT CompletionEvent) |
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.
| This | The pointer to the EFI_DHCP4_PROTOCOL instance. |
| RebindRequest | If TRUE, this function broadcasts the request packets and enters the Dhcp4Rebinding state. Otherwise, it sends a unicast request packet and enters the Dhcp4Renewing state. |
| CompletionEvent | If 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. |
| EFI_SUCCESS | The EFI DHCPv4 Protocol driver is now in the Dhcp4Renewing state or is back to the Dhcp4Bound state. |
| EFI_NOT_STARTED | The EFI DHCPv4 Protocol driver is in the Dhcp4Stopped state. EFI_DHCP4_PROTOCOL.Configure() needs to be called. |
| EFI_INVALID_PARAMETER | This is NULL. |
| EFI_TIMEOUT | There was no response from the server when the try count was exceeded. |
| EFI_ACCESS_DENIED | The driver is not in the Dhcp4Bound state. |
| EFI_DEVICE_ERROR | An unexpected system or network error occurred. |
| typedef EFI_STATUS(EFIAPI * EFI_DHCP4_START)(IN EFI_DHCP4_PROTOCOL *This, IN EFI_EVENT CompletionEvent) |
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.
| This | The pointer to the EFI_DHCP4_PROTOCOL instance. |
| CompletionEvent | If 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. |
| EFI_SUCCESS | The DHCP configuration process has started, or it has completed when CompletionEvent is NULL. |
| EFI_NOT_STARTED | The EFI DHCPv4 Protocol driver is in the Dhcp4Stopped state. EFI_DHCP4_PROTOCOL. Configure() needs to be called. |
| EFI_INVALID_PARAMETER | This is NULL. |
| EFI_OUT_OF_RESOURCES | Required system resources could not be allocated. |
| EFI_TIMEOUT | The DHCP configuration process failed because no response was received from the server within the specified timeout value. |
| EFI_ABORTED | The user aborted the DHCP process. |
| EFI_ALREADY_STARTED | Some other EFI DHCPv4 Protocol instance already started the DHCP process. |
| EFI_DEVICE_ERROR | An unexpected system or network error occurred. |
| EFI_NO_MEDIA | There was a media error. |
| typedef EFI_STATUS(EFIAPI * EFI_DHCP4_STOP)(IN EFI_DHCP4_PROTOCOL *This) |
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.
| This | The pointer to the EFI_DHCP4_PROTOCOL instance. |
| EFI_SUCCESS | The EFI DHCPv4 Protocol driver is now in the Dhcp4Stopped phase. |
| EFI_INVALID_PARAMETER | This is NULL. |
| typedef EFI_STATUS(EFIAPI * EFI_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.
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.
| This | The pointer to the EFI_DHCP4_PROTOCOL instance. |
| Token | The pointer to the EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN structure. |
| EFI_SUCCESS | The packet was successfully queued for transmission. |
| EFI_INVALID_PARAMETER | One 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_READY | The previous call to this function has not finished yet. Try to call this function after collection process completes. |
| EFI_NO_MAPPING | The default station address is not available yet. |
| EFI_OUT_OF_RESOURCES | Required system resources could not be allocated. |
| EFI_UNSUPPORTED | The implementation doesn't support this function |
| Others | Some other unexpected error occurred. |
| enum EFI_DHCP4_EVENT |
| enum EFI_DHCP4_STATE |
| EFI_GUID gEfiDhcp4ProtocolGuid |
| EFI_GUID gEfiDhcp4ServiceBindingProtocolGuid |
1.8.6 
