2 This file implement the EFI_DHCP4_PROTOCOL interface.
4 Copyright (c) 2006 - 2015, 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
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.
16 #include "Dhcp4Impl.h"
19 Returns the current operating mode and cached data packet for the EFI DHCPv4 Protocol driver.
21 The GetModeData() function returns the current operating mode and cached data
22 packet for the EFI DHCPv4 Protocol driver.
24 @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.
25 @param[out] Dhcp4ModeData Pointer to storage for the EFI_DHCP4_MODE_DATA structure.
27 @retval EFI_SUCCESS The mode data was returned.
28 @retval EFI_INVALID_PARAMETER This is NULL.
34 IN EFI_DHCP4_PROTOCOL
*This
,
35 OUT EFI_DHCP4_MODE_DATA
*Dhcp4ModeData
39 Initializes, changes, or resets the operational settings for the EFI DHCPv4 Protocol driver.
41 The Configure() function is used to initialize, change, or reset the operational
42 settings of the EFI DHCPv4 Protocol driver for the communication device on which
43 the EFI DHCPv4 Service Binding Protocol is installed. This function can be
44 successfully called only if both of the following are true:
45 * This instance of the EFI DHCPv4 Protocol driver is in the Dhcp4Stopped, Dhcp4Init,
46 Dhcp4InitReboot, or Dhcp4Bound states.
47 * No other EFI DHCPv4 Protocol driver instance that is controlled by this EFI
48 DHCPv4 Service Binding Protocol driver instance has configured this EFI DHCPv4
50 When this driver is in the Dhcp4Stopped state, it can transfer into one of the
51 following two possible initial states:
54 The driver can transfer into these states by calling Configure() with a non-NULL
55 Dhcp4CfgData. The driver will transfer into the appropriate state based on the
56 supplied client network address in the ClientAddress parameter and DHCP options
57 in the OptionList parameter as described in RFC 2131.
58 When Configure() is called successfully while Dhcp4CfgData is set to NULL, the
59 default configuring data will be reset in the EFI DHCPv4 Protocol driver and
60 the state of the EFI DHCPv4 Protocol driver will not be changed. If one instance
61 wants to make it possible for another instance to configure the EFI DHCPv4 Protocol
62 driver, it must call this function with Dhcp4CfgData set to NULL.
64 @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.
65 @param[in] Dhcp4CfgData Pointer to the EFI_DHCP4_CONFIG_DATA.
67 @retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Init or
68 Dhcp4InitReboot state, if the original state of this driver
69 was Dhcp4Stopped and the value of Dhcp4CfgData was
70 not NULL. Otherwise, the state was left unchanged.
71 @retval EFI_ACCESS_DENIED This instance of the EFI DHCPv4 Protocol driver was not in the
72 Dhcp4Stopped, Dhcp4Init, Dhcp4InitReboot, or Dhcp4Bound state;
73 Or onother instance of this EFI DHCPv4 Protocol driver is already
74 in a valid configured state.
75 @retval EFI_INVALID_PARAMETER Some parameter is NULL.
76 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
77 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
83 IN EFI_DHCP4_PROTOCOL
*This
,
84 IN EFI_DHCP4_CONFIG_DATA
*Dhcp4CfgData OPTIONAL
88 Starts the DHCP configuration process.
90 The Start() function starts the DHCP configuration process. This function can
91 be called only when the EFI DHCPv4 Protocol driver is in the Dhcp4Init or
92 Dhcp4InitReboot state.
93 If the DHCP process completes successfully, the state of the EFI DHCPv4 Protocol
94 driver will be transferred through Dhcp4Selecting and Dhcp4Requesting to the
95 Dhcp4Bound state. The CompletionEvent will then be signaled if it is not NULL.
96 If the process aborts, either by the user or by some unexpected network error,
97 the state is restored to the Dhcp4Init state. The Start() function can be called
98 again to restart the process.
99 Refer to RFC 2131 for precise state transitions during this process. At the
100 time when each event occurs in this process, the callback function that was set
101 by EFI_DHCP4_PROTOCOL.Configure() will be called and the user can take this
102 opportunity to control the process.
104 @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.
105 @param[in] CompletionEvent If not NULL, indicates the event that will be signaled when the
106 EFI DHCPv4 Protocol driver is transferred into the
107 Dhcp4Bound state or when the DHCP process is aborted.
108 EFI_DHCP4_PROTOCOL.GetModeData() can be called to
109 check the completion status. If NULL,
110 EFI_DHCP4_PROTOCOL.Start() will wait until the driver
111 is transferred into the Dhcp4Bound state or the process fails.
113 @retval EFI_SUCCESS The DHCP configuration process has started, or it has completed
114 when CompletionEvent is NULL.
115 @retval EFI_NOT_STARTED The EFI DHCPv4 Protocol driver is in the Dhcp4Stopped
116 state. EFI_DHCP4_PROTOCOL. Configure() needs to be called.
117 @retval EFI_INVALID_PARAMETER This is NULL.
118 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
119 @retval EFI_TIMEOUT The DHCP configuration process failed because no response was
120 received from the server within the specified timeout value.
121 @retval EFI_ABORTED The user aborted the DHCP process.
122 @retval EFI_ALREADY_STARTED Some other EFI DHCPv4 Protocol instance already started the
124 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
130 IN EFI_DHCP4_PROTOCOL
*This
,
131 IN EFI_EVENT CompletionEvent OPTIONAL
135 Extends the lease time by sending a request packet.
137 The RenewRebind() function is used to manually extend the lease time when the
138 EFI DHCPv4 Protocol driver is in the Dhcp4Bound state and the lease time has
139 not expired yet. This function will send a request packet to the previously
140 found server (or to any server when RebindRequest is TRUE) and transfer the
141 state into the Dhcp4Renewing state (or Dhcp4Rebinding when RebindingRequest is
142 TRUE). When a response is received, the state is returned to Dhcp4Bound.
143 If no response is received before the try count is exceeded (the RequestTryCount
144 field that is specified in EFI_DHCP4_CONFIG_DATA) but before the lease time that
145 was issued by the previous server expires, the driver will return to the Dhcp4Bound
146 state and the previous configuration is restored. The outgoing and incoming packets
147 can be captured by the EFI_DHCP4_CALLBACK function.
149 @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.
150 @param[in] RebindRequest If TRUE, this function broadcasts the request packets and enters
151 the Dhcp4Rebinding state. Otherwise, it sends a unicast
152 request packet and enters the Dhcp4Renewing state.
153 @param[in] CompletionEvent If not NULL, this event is signaled when the renew/rebind phase
154 completes or some error occurs.
155 EFI_DHCP4_PROTOCOL.GetModeData() can be called to
156 check the completion status. If NULL,
157 EFI_DHCP4_PROTOCOL.RenewRebind() will busy-wait
158 until the DHCP process finishes.
160 @retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the
161 Dhcp4Renewing state or is back to the Dhcp4Bound state.
162 @retval EFI_NOT_STARTED The EFI DHCPv4 Protocol driver is in the Dhcp4Stopped
163 state. EFI_DHCP4_PROTOCOL.Configure() needs to
165 @retval EFI_INVALID_PARAMETER This is NULL.
166 @retval EFI_TIMEOUT There was no response from the server when the try count was
168 @retval EFI_ACCESS_DENIED The driver is not in the Dhcp4Bound state.
169 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
174 EfiDhcp4RenewRebind (
175 IN EFI_DHCP4_PROTOCOL
*This
,
176 IN BOOLEAN RebindRequest
,
177 IN EFI_EVENT CompletionEvent OPTIONAL
181 Releases the current address configuration.
183 The Release() function releases the current configured IP address by doing either
185 * Sending a DHCPRELEASE packet when the EFI DHCPv4 Protocol driver is in the
187 * Setting the previously assigned IP address that was provided with the
188 EFI_DHCP4_PROTOCOL.Configure() function to 0.0.0.0 when the driver is in
189 Dhcp4InitReboot state
190 After a successful call to this function, the EFI DHCPv4 Protocol driver returns
191 to the Dhcp4Init state and any subsequent incoming packets will be discarded silently.
193 @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.
195 @retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Init phase.
196 @retval EFI_INVALID_PARAMETER This is NULL.
197 @retval EFI_ACCESS_DENIED The EFI DHCPv4 Protocol driver is not Dhcp4InitReboot state.
198 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
204 IN EFI_DHCP4_PROTOCOL
*This
208 Stops the current address configuration.
210 The Stop() function is used to stop the DHCP configuration process. After this
211 function is called successfully, the EFI DHCPv4 Protocol driver is transferred
212 into the Dhcp4Stopped state. EFI_DHCP4_PROTOCOL.Configure() needs to be called
213 before DHCP configuration process can be started again. This function can be
214 called when the EFI DHCPv4 Protocol driver is in any state.
216 @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.
218 @retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Stopped phase.
219 @retval EFI_INVALID_PARAMETER This is NULL.
225 IN EFI_DHCP4_PROTOCOL
*This
229 Builds a DHCP packet, given the options to be appended or deleted or replaced.
231 The Build() function is used to assemble a new packet from the original packet
232 by replacing or deleting existing options or appending new options. This function
233 does not change any state of the EFI DHCPv4 Protocol driver and can be used at
236 @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.
237 @param[in] SeedPacket Initial packet to be used as a base for building new packet.
238 @param[in] DeleteCount Number of opcodes in the DeleteList.
239 @param[in] DeleteList List of opcodes to be deleted from the seed packet.
240 Ignored if DeleteCount is zero.
241 @param[in] AppendCount Number of entries in the OptionList.
242 @param[in] AppendList Pointer to a DHCP option list to be appended to SeedPacket.
243 If SeedPacket also contains options in this list, they are
244 replaced by new options (except pad option). Ignored if
245 AppendCount is zero. Type EFI_DHCP4_PACKET_OPTION
246 @param[out] NewPacket Pointer to storage for the pointer to the new allocated packet.
247 Use the EFI Boot Service FreePool() on the resulting pointer
248 when done with the packet.
250 @retval EFI_SUCCESS The new packet was built.
251 @retval EFI_OUT_OF_RESOURCES Storage for the new packet could not be allocated.
252 @retval EFI_INVALID_PARAMETER Some parameter is NULL.
258 IN EFI_DHCP4_PROTOCOL
*This
,
259 IN EFI_DHCP4_PACKET
*SeedPacket
,
260 IN UINT32 DeleteCount
,
261 IN UINT8
*DeleteList OPTIONAL
,
262 IN UINT32 AppendCount
,
263 IN EFI_DHCP4_PACKET_OPTION
*AppendList
[] OPTIONAL
,
264 OUT EFI_DHCP4_PACKET
**NewPacket
268 Transmits a DHCP formatted packet and optionally waits for responses.
270 The TransmitReceive() function is used to transmit a DHCP packet and optionally
271 wait for the response from servers. This function does not change the state of
272 the EFI DHCPv4 Protocol driver and thus can be used at any time.
274 @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.
275 @param[in] Token Pointer to the EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN structure.
277 @retval EFI_SUCCESS The packet was successfully queued for transmission.
278 @retval EFI_INVALID_PARAMETER Some parameter is NULL.
279 @retval EFI_NOT_READY The previous call to this function has not finished yet. Try to call
280 this function after collection process completes.
281 @retval EFI_NO_MAPPING The default station address is not available yet.
282 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
283 @retval Others Some other unexpected error occurred.
288 EfiDhcp4TransmitReceive (
289 IN EFI_DHCP4_PROTOCOL
*This
,
290 IN EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN
*Token
294 Parses the packed DHCP option data.
296 The Parse() function is used to retrieve the option list from a DHCP packet.
297 If *OptionCount isn't zero, and there is enough space for all the DHCP options
298 in the Packet, each element of PacketOptionList is set to point to somewhere in
299 the Packet->Dhcp4.Option where a new DHCP option begins. If RFC3396 is supported,
300 the caller should reassemble the parsed DHCP options to get the finial result.
301 If *OptionCount is zero or there isn't enough space for all of them, the number
302 of DHCP options in the Packet is returned in OptionCount.
304 @param This Pointer to the EFI_DHCP4_PROTOCOL instance.
305 @param Packet Pointer to packet to be parsed.
306 @param OptionCount On input, the number of entries in the PacketOptionList.
307 On output, the number of entries that were written into the
309 @param PacketOptionList List of packet option entries to be filled in. End option or pad
310 options are not included.
312 @retval EFI_SUCCESS The packet was successfully parsed.
313 @retval EFI_INVALID_PARAMETER Some parameter is NULL.
314 @retval EFI_BUFFER_TOO_SMALL One or more of the following conditions is TRUE:
315 1) *OptionCount is smaller than the number of options that
316 were found in the Packet.
317 2) PacketOptionList is NULL.
323 IN EFI_DHCP4_PROTOCOL
*This
,
324 IN EFI_DHCP4_PACKET
*Packet
,
325 IN OUT UINT32
*OptionCount
,
326 OUT EFI_DHCP4_PACKET_OPTION
*PacketOptionList
[] OPTIONAL
329 EFI_DHCP4_PROTOCOL mDhcp4ProtocolTemplate
= {
337 EfiDhcp4TransmitReceive
,
342 Returns the current operating mode and cached data packet for the EFI DHCPv4 Protocol driver.
344 The GetModeData() function returns the current operating mode and cached data
345 packet for the EFI DHCPv4 Protocol driver.
347 @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.
348 @param[out] Dhcp4ModeData Pointer to storage for the EFI_DHCP4_MODE_DATA structure.
350 @retval EFI_SUCCESS The mode data was returned.
351 @retval EFI_INVALID_PARAMETER This is NULL.
356 EfiDhcp4GetModeData (
357 IN EFI_DHCP4_PROTOCOL
*This
,
358 OUT EFI_DHCP4_MODE_DATA
*Dhcp4ModeData
361 DHCP_PROTOCOL
*Instance
;
362 DHCP_SERVICE
*DhcpSb
;
363 DHCP_PARAMETER
*Para
;
368 // First validate the parameters.
370 if ((This
== NULL
) || (Dhcp4ModeData
== NULL
)) {
371 return EFI_INVALID_PARAMETER
;
374 Instance
= DHCP_INSTANCE_FROM_THIS (This
);
376 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
377 DhcpSb
= Instance
->Service
;
380 // Caller can use GetModeData to retrieve current DHCP states
381 // no matter whether it is the active child or not.
383 Dhcp4ModeData
->State
= (EFI_DHCP4_STATE
) DhcpSb
->DhcpState
;
384 CopyMem (&Dhcp4ModeData
->ConfigData
, &DhcpSb
->ActiveConfig
, sizeof (Dhcp4ModeData
->ConfigData
));
385 CopyMem (&Dhcp4ModeData
->ClientMacAddress
, &DhcpSb
->Mac
, sizeof (Dhcp4ModeData
->ClientMacAddress
));
387 Ip
= HTONL (DhcpSb
->ClientAddr
);
388 CopyMem (&Dhcp4ModeData
->ClientAddress
, &Ip
, sizeof (EFI_IPv4_ADDRESS
));
390 Ip
= HTONL (DhcpSb
->Netmask
);
391 CopyMem (&Dhcp4ModeData
->SubnetMask
, &Ip
, sizeof (EFI_IPv4_ADDRESS
));
393 Ip
= HTONL (DhcpSb
->ServerAddr
);
394 CopyMem (&Dhcp4ModeData
->ServerAddress
, &Ip
, sizeof (EFI_IPv4_ADDRESS
));
399 Ip
= HTONL (Para
->Router
);
400 CopyMem (&Dhcp4ModeData
->RouterAddress
, &Ip
, sizeof (EFI_IPv4_ADDRESS
));
401 Dhcp4ModeData
->LeaseTime
= Para
->Lease
;
403 ZeroMem (&Dhcp4ModeData
->RouterAddress
, sizeof (EFI_IPv4_ADDRESS
));
404 Dhcp4ModeData
->LeaseTime
= 0xffffffff;
407 Dhcp4ModeData
->ReplyPacket
= DhcpSb
->Selected
;
409 gBS
->RestoreTPL (OldTpl
);
415 Free the resource related to the configure parameters.
416 DHCP driver will make a copy of the user's configure
417 such as the time out value.
419 @param Config The DHCP configure data
424 IN OUT EFI_DHCP4_CONFIG_DATA
*Config
429 if (Config
->DiscoverTimeout
!= NULL
) {
430 FreePool (Config
->DiscoverTimeout
);
433 if (Config
->RequestTimeout
!= NULL
) {
434 FreePool (Config
->RequestTimeout
);
437 if (Config
->OptionList
!= NULL
) {
438 for (Index
= 0; Index
< Config
->OptionCount
; Index
++) {
439 if (Config
->OptionList
[Index
] != NULL
) {
440 FreePool (Config
->OptionList
[Index
]);
444 FreePool (Config
->OptionList
);
447 ZeroMem (Config
, sizeof (EFI_DHCP4_CONFIG_DATA
));
452 Allocate memory for configure parameter such as timeout value for Dst,
453 then copy the configure parameter from Src to Dst.
455 @param[out] Dst The destination DHCP configure data.
456 @param[in] Src The source DHCP configure data.
458 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
459 @retval EFI_SUCCESS The configure is copied.
464 OUT EFI_DHCP4_CONFIG_DATA
*Dst
,
465 IN EFI_DHCP4_CONFIG_DATA
*Src
468 EFI_DHCP4_PACKET_OPTION
**DstOptions
;
469 EFI_DHCP4_PACKET_OPTION
**SrcOptions
;
473 CopyMem (Dst
, Src
, sizeof (*Dst
));
474 Dst
->DiscoverTimeout
= NULL
;
475 Dst
->RequestTimeout
= NULL
;
476 Dst
->OptionList
= NULL
;
479 // Allocate a memory then copy DiscoverTimeout to it
481 if (Src
->DiscoverTimeout
!= NULL
) {
482 Len
= Src
->DiscoverTryCount
* sizeof (UINT32
);
483 Dst
->DiscoverTimeout
= AllocatePool (Len
);
485 if (Dst
->DiscoverTimeout
== NULL
) {
486 return EFI_OUT_OF_RESOURCES
;
489 for (Index
= 0; Index
< Src
->DiscoverTryCount
; Index
++) {
490 Dst
->DiscoverTimeout
[Index
] = MAX (Src
->DiscoverTimeout
[Index
], 1);
495 // Allocate a memory then copy RequestTimeout to it
497 if (Src
->RequestTimeout
!= NULL
) {
498 Len
= Src
->RequestTryCount
* sizeof (UINT32
);
499 Dst
->RequestTimeout
= AllocatePool (Len
);
501 if (Dst
->RequestTimeout
== NULL
) {
505 for (Index
= 0; Index
< Src
->RequestTryCount
; Index
++) {
506 Dst
->RequestTimeout
[Index
] = MAX (Src
->RequestTimeout
[Index
], 1);
511 // Allocate an array of dhcp option point, then allocate memory
512 // for each option and copy the source option to it
514 if (Src
->OptionList
!= NULL
) {
515 Len
= Src
->OptionCount
* sizeof (EFI_DHCP4_PACKET_OPTION
*);
516 Dst
->OptionList
= AllocateZeroPool (Len
);
518 if (Dst
->OptionList
== NULL
) {
522 DstOptions
= Dst
->OptionList
;
523 SrcOptions
= Src
->OptionList
;
525 for (Index
= 0; Index
< Src
->OptionCount
; Index
++) {
526 Len
= sizeof (EFI_DHCP4_PACKET_OPTION
) + MAX (SrcOptions
[Index
]->Length
- 1, 0);
528 DstOptions
[Index
] = AllocatePool (Len
);
530 if (DstOptions
[Index
] == NULL
) {
534 CopyMem (DstOptions
[Index
], SrcOptions
[Index
], Len
);
541 DhcpCleanConfigure (Dst
);
542 return EFI_OUT_OF_RESOURCES
;
547 Give up the control of the DHCP service to let other child
548 resume. Don't change the service's DHCP state and the Client
549 address and option list configure as required by RFC2131.
551 @param DhcpSb The DHCP service instance.
556 IN DHCP_SERVICE
*DhcpSb
559 EFI_DHCP4_CONFIG_DATA
*Config
;
561 Config
= &DhcpSb
->ActiveConfig
;
563 DhcpSb
->ServiceState
= DHCP_UNCONFIGED
;
564 DhcpSb
->ActiveChild
= NULL
;
566 if (Config
->DiscoverTimeout
!= NULL
) {
567 FreePool (Config
->DiscoverTimeout
);
569 Config
->DiscoverTryCount
= 0;
570 Config
->DiscoverTimeout
= NULL
;
573 if (Config
->RequestTimeout
!= NULL
) {
574 FreePool (Config
->RequestTimeout
);
576 Config
->RequestTryCount
= 0;
577 Config
->RequestTimeout
= NULL
;
580 Config
->Dhcp4Callback
= NULL
;
581 Config
->CallbackContext
= NULL
;
586 Initializes, changes, or resets the operational settings for the EFI DHCPv4 Protocol driver.
588 The Configure() function is used to initialize, change, or reset the operational
589 settings of the EFI DHCPv4 Protocol driver for the communication device on which
590 the EFI DHCPv4 Service Binding Protocol is installed. This function can be
591 successfully called only if both of the following are true:
592 * This instance of the EFI DHCPv4 Protocol driver is in the Dhcp4Stopped, Dhcp4Init,
593 Dhcp4InitReboot, or Dhcp4Bound states.
594 * No other EFI DHCPv4 Protocol driver instance that is controlled by this EFI
595 DHCPv4 Service Binding Protocol driver instance has configured this EFI DHCPv4
597 When this driver is in the Dhcp4Stopped state, it can transfer into one of the
598 following two possible initial states:
601 The driver can transfer into these states by calling Configure() with a non-NULL
602 Dhcp4CfgData. The driver will transfer into the appropriate state based on the
603 supplied client network address in the ClientAddress parameter and DHCP options
604 in the OptionList parameter as described in RFC 2131.
605 When Configure() is called successfully while Dhcp4CfgData is set to NULL, the
606 default configuring data will be reset in the EFI DHCPv4 Protocol driver and
607 the state of the EFI DHCPv4 Protocol driver will not be changed. If one instance
608 wants to make it possible for another instance to configure the EFI DHCPv4 Protocol
609 driver, it must call this function with Dhcp4CfgData set to NULL.
611 @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.
612 @param[in] Dhcp4CfgData Pointer to the EFI_DHCP4_CONFIG_DATA.
614 @retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Init or
615 Dhcp4InitReboot state, if the original state of this driver
616 was Dhcp4Stopped and the value of Dhcp4CfgData was
617 not NULL. Otherwise, the state was left unchanged.
618 @retval EFI_ACCESS_DENIED This instance of the EFI DHCPv4 Protocol driver was not in the
619 Dhcp4Stopped, Dhcp4Init, Dhcp4InitReboot, or Dhcp4Bound state;
620 Or onother instance of this EFI DHCPv4 Protocol driver is already
621 in a valid configured state.
622 @retval EFI_INVALID_PARAMETER Some parameter is NULL.
623 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
624 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
630 IN EFI_DHCP4_PROTOCOL
*This
,
631 IN EFI_DHCP4_CONFIG_DATA
*Dhcp4CfgData OPTIONAL
634 EFI_DHCP4_CONFIG_DATA
*Config
;
635 DHCP_PROTOCOL
*Instance
;
636 DHCP_SERVICE
*DhcpSb
;
643 // First validate the parameters
646 return EFI_INVALID_PARAMETER
;
649 if (Dhcp4CfgData
!= NULL
) {
650 if ((Dhcp4CfgData
->DiscoverTryCount
!= 0) && (Dhcp4CfgData
->DiscoverTimeout
== NULL
)) {
651 return EFI_INVALID_PARAMETER
;
654 if ((Dhcp4CfgData
->RequestTryCount
!= 0) && (Dhcp4CfgData
->RequestTimeout
== NULL
)) {
655 return EFI_INVALID_PARAMETER
;
658 if ((Dhcp4CfgData
->OptionCount
!= 0) && (Dhcp4CfgData
->OptionList
== NULL
)) {
659 return EFI_INVALID_PARAMETER
;
662 CopyMem (&Ip
, &Dhcp4CfgData
->ClientAddress
, sizeof (IP4_ADDR
));
664 if ((Ip
!= 0) && !NetIp4IsUnicast (NTOHL (Ip
), 0)) {
666 return EFI_INVALID_PARAMETER
;
670 Instance
= DHCP_INSTANCE_FROM_THIS (This
);
672 if (Instance
->Signature
!= DHCP_PROTOCOL_SIGNATURE
) {
673 return EFI_INVALID_PARAMETER
;
676 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
678 DhcpSb
= Instance
->Service
;
679 Config
= &DhcpSb
->ActiveConfig
;
681 Status
= EFI_ACCESS_DENIED
;
683 if ((DhcpSb
->DhcpState
!= Dhcp4Stopped
) &&
684 (DhcpSb
->DhcpState
!= Dhcp4Init
) &&
685 (DhcpSb
->DhcpState
!= Dhcp4InitReboot
) &&
686 (DhcpSb
->DhcpState
!= Dhcp4Bound
)) {
691 if ((DhcpSb
->ActiveChild
!= NULL
) && (DhcpSb
->ActiveChild
!= Instance
)) {
695 if (Dhcp4CfgData
!= NULL
) {
696 Status
= EFI_OUT_OF_RESOURCES
;
697 DhcpCleanConfigure (Config
);
699 if (EFI_ERROR (DhcpCopyConfigure (Config
, Dhcp4CfgData
))) {
703 DhcpSb
->UserOptionLen
= 0;
705 for (Index
= 0; Index
< Dhcp4CfgData
->OptionCount
; Index
++) {
706 DhcpSb
->UserOptionLen
+= Dhcp4CfgData
->OptionList
[Index
]->Length
+ 2;
709 DhcpSb
->ActiveChild
= Instance
;
711 if (DhcpSb
->DhcpState
== Dhcp4Stopped
) {
712 DhcpSb
->ClientAddr
= EFI_NTOHL (Dhcp4CfgData
->ClientAddress
);
714 if (DhcpSb
->ClientAddr
!= 0) {
715 DhcpSb
->DhcpState
= Dhcp4InitReboot
;
717 DhcpSb
->DhcpState
= Dhcp4Init
;
721 DhcpSb
->ServiceState
= DHCP_CONFIGED
;
722 Status
= EFI_SUCCESS
;
724 } else if (DhcpSb
->ActiveChild
== Instance
) {
725 Status
= EFI_SUCCESS
;
726 DhcpYieldControl (DhcpSb
);
730 gBS
->RestoreTPL (OldTpl
);
736 Starts the DHCP configuration process.
738 The Start() function starts the DHCP configuration process. This function can
739 be called only when the EFI DHCPv4 Protocol driver is in the Dhcp4Init or
740 Dhcp4InitReboot state.
741 If the DHCP process completes successfully, the state of the EFI DHCPv4 Protocol
742 driver will be transferred through Dhcp4Selecting and Dhcp4Requesting to the
743 Dhcp4Bound state. The CompletionEvent will then be signaled if it is not NULL.
744 If the process aborts, either by the user or by some unexpected network error,
745 the state is restored to the Dhcp4Init state. The Start() function can be called
746 again to restart the process.
747 Refer to RFC 2131 for precise state transitions during this process. At the
748 time when each event occurs in this process, the callback function that was set
749 by EFI_DHCP4_PROTOCOL.Configure() will be called and the user can take this
750 opportunity to control the process.
752 @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.
753 @param[in] CompletionEvent If not NULL, indicates the event that will be signaled when the
754 EFI DHCPv4 Protocol driver is transferred into the
755 Dhcp4Bound state or when the DHCP process is aborted.
756 EFI_DHCP4_PROTOCOL.GetModeData() can be called to
757 check the completion status. If NULL,
758 EFI_DHCP4_PROTOCOL.Start() will wait until the driver
759 is transferred into the Dhcp4Bound state or the process fails.
761 @retval EFI_SUCCESS The DHCP configuration process has started, or it has completed
762 when CompletionEvent is NULL.
763 @retval EFI_NOT_STARTED The EFI DHCPv4 Protocol driver is in the Dhcp4Stopped
764 state. EFI_DHCP4_PROTOCOL. Configure() needs to be called.
765 @retval EFI_INVALID_PARAMETER This is NULL.
766 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
767 @retval EFI_TIMEOUT The DHCP configuration process failed because no response was
768 received from the server within the specified timeout value.
769 @retval EFI_ABORTED The user aborted the DHCP process.
770 @retval EFI_ALREADY_STARTED Some other EFI DHCPv4 Protocol instance already started the
772 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
773 @retval EFI_NO_MEDIA There was a media error.
779 IN EFI_DHCP4_PROTOCOL
*This
,
780 IN EFI_EVENT CompletionEvent OPTIONAL
783 DHCP_PROTOCOL
*Instance
;
784 DHCP_SERVICE
*DhcpSb
;
789 // First validate the parameters
792 return EFI_INVALID_PARAMETER
;
795 Instance
= DHCP_INSTANCE_FROM_THIS (This
);
797 if (Instance
->Signature
!= DHCP_PROTOCOL_SIGNATURE
) {
798 return EFI_INVALID_PARAMETER
;
801 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
802 DhcpSb
= Instance
->Service
;
804 if (DhcpSb
->DhcpState
== Dhcp4Stopped
) {
805 Status
= EFI_NOT_STARTED
;
809 if ((DhcpSb
->DhcpState
!= Dhcp4Init
) && (DhcpSb
->DhcpState
!= Dhcp4InitReboot
)) {
810 Status
= EFI_ALREADY_STARTED
;
814 DhcpSb
->IoStatus
= EFI_ALREADY_STARTED
;
816 if (EFI_ERROR (Status
= DhcpInitRequest (DhcpSb
))) {
821 Instance
->CompletionEvent
= CompletionEvent
;
824 // Restore the TPL now, don't call poll function at TPL_CALLBACK.
826 gBS
->RestoreTPL (OldTpl
);
828 if (CompletionEvent
== NULL
) {
829 while (DhcpSb
->IoStatus
== EFI_ALREADY_STARTED
) {
830 DhcpSb
->UdpIo
->Protocol
.Udp4
->Poll (DhcpSb
->UdpIo
->Protocol
.Udp4
);
833 return DhcpSb
->IoStatus
;
839 gBS
->RestoreTPL (OldTpl
);
845 Extends the lease time by sending a request packet.
847 The RenewRebind() function is used to manually extend the lease time when the
848 EFI DHCPv4 Protocol driver is in the Dhcp4Bound state and the lease time has
849 not expired yet. This function will send a request packet to the previously
850 found server (or to any server when RebindRequest is TRUE) and transfer the
851 state into the Dhcp4Renewing state (or Dhcp4Rebinding when RebindingRequest is
852 TRUE). When a response is received, the state is returned to Dhcp4Bound.
853 If no response is received before the try count is exceeded (the RequestTryCount
854 field that is specified in EFI_DHCP4_CONFIG_DATA) but before the lease time that
855 was issued by the previous server expires, the driver will return to the Dhcp4Bound
856 state and the previous configuration is restored. The outgoing and incoming packets
857 can be captured by the EFI_DHCP4_CALLBACK function.
859 @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.
860 @param[in] RebindRequest If TRUE, this function broadcasts the request packets and enters
861 the Dhcp4Rebinding state. Otherwise, it sends a unicast
862 request packet and enters the Dhcp4Renewing state.
863 @param[in] CompletionEvent If not NULL, this event is signaled when the renew/rebind phase
864 completes or some error occurs.
865 EFI_DHCP4_PROTOCOL.GetModeData() can be called to
866 check the completion status. If NULL,
867 EFI_DHCP4_PROTOCOL.RenewRebind() will busy-wait
868 until the DHCP process finishes.
870 @retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the
871 Dhcp4Renewing state or is back to the Dhcp4Bound state.
872 @retval EFI_NOT_STARTED The EFI DHCPv4 Protocol driver is in the Dhcp4Stopped
873 state. EFI_DHCP4_PROTOCOL.Configure() needs to
875 @retval EFI_INVALID_PARAMETER This is NULL.
876 @retval EFI_TIMEOUT There was no response from the server when the try count was
878 @retval EFI_ACCESS_DENIED The driver is not in the Dhcp4Bound state.
879 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
884 EfiDhcp4RenewRebind (
885 IN EFI_DHCP4_PROTOCOL
*This
,
886 IN BOOLEAN RebindRequest
,
887 IN EFI_EVENT CompletionEvent OPTIONAL
890 DHCP_PROTOCOL
*Instance
;
891 DHCP_SERVICE
*DhcpSb
;
896 // First validate the parameters
899 return EFI_INVALID_PARAMETER
;
902 Instance
= DHCP_INSTANCE_FROM_THIS (This
);
904 if (Instance
->Signature
!= DHCP_PROTOCOL_SIGNATURE
) {
905 return EFI_INVALID_PARAMETER
;
908 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
909 DhcpSb
= Instance
->Service
;
911 if (DhcpSb
->DhcpState
== Dhcp4Stopped
) {
912 Status
= EFI_NOT_STARTED
;
916 if (DhcpSb
->DhcpState
!= Dhcp4Bound
) {
917 Status
= EFI_ACCESS_DENIED
;
921 if (DHCP_IS_BOOTP (DhcpSb
->Para
)) {
922 Status
= EFI_SUCCESS
;
927 // Transit the states then send a extra DHCP request
929 if (!RebindRequest
) {
930 DhcpSetState (DhcpSb
, Dhcp4Renewing
, FALSE
);
932 DhcpSetState (DhcpSb
, Dhcp4Rebinding
, FALSE
);
936 // Clear initial time to make sure that elapsed-time
937 // is set to 0 for first REQUEST in renewal process.
939 Instance
->ElaspedTime
= 0;
941 Status
= DhcpSendMessage (
946 (UINT8
*) "Extra renew/rebind by the application"
949 if (EFI_ERROR (Status
)) {
950 DhcpSetState (DhcpSb
, Dhcp4Bound
, FALSE
);
954 DhcpSb
->ExtraRefresh
= TRUE
;
955 DhcpSb
->IoStatus
= EFI_ALREADY_STARTED
;
956 Instance
->RenewRebindEvent
= CompletionEvent
;
958 gBS
->RestoreTPL (OldTpl
);
960 if (CompletionEvent
== NULL
) {
961 while (DhcpSb
->IoStatus
== EFI_ALREADY_STARTED
) {
962 DhcpSb
->UdpIo
->Protocol
.Udp4
->Poll (DhcpSb
->UdpIo
->Protocol
.Udp4
);
966 return DhcpSb
->IoStatus
;
972 gBS
->RestoreTPL (OldTpl
);
978 Releases the current address configuration.
980 The Release() function releases the current configured IP address by doing either
982 * Sending a DHCPRELEASE packet when the EFI DHCPv4 Protocol driver is in the
984 * Setting the previously assigned IP address that was provided with the
985 EFI_DHCP4_PROTOCOL.Configure() function to 0.0.0.0 when the driver is in
986 Dhcp4InitReboot state
987 After a successful call to this function, the EFI DHCPv4 Protocol driver returns
988 to the Dhcp4Init state and any subsequent incoming packets will be discarded silently.
990 @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.
992 @retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Init phase.
993 @retval EFI_INVALID_PARAMETER This is NULL.
994 @retval EFI_ACCESS_DENIED The EFI DHCPv4 Protocol driver is not Dhcp4InitReboot state.
995 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
1001 IN EFI_DHCP4_PROTOCOL
*This
1004 DHCP_PROTOCOL
*Instance
;
1005 DHCP_SERVICE
*DhcpSb
;
1010 // First validate the parameters
1013 return EFI_INVALID_PARAMETER
;
1016 Instance
= DHCP_INSTANCE_FROM_THIS (This
);
1018 if (Instance
->Signature
!= DHCP_PROTOCOL_SIGNATURE
) {
1019 return EFI_INVALID_PARAMETER
;
1022 Status
= EFI_SUCCESS
;
1023 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
1024 DhcpSb
= Instance
->Service
;
1026 if ((DhcpSb
->DhcpState
!= Dhcp4InitReboot
) && (DhcpSb
->DhcpState
!= Dhcp4Bound
)) {
1027 Status
= EFI_ACCESS_DENIED
;
1031 if (!DHCP_IS_BOOTP (DhcpSb
->Para
) && (DhcpSb
->DhcpState
== Dhcp4Bound
)) {
1032 Status
= DhcpSendMessage (
1040 if (EFI_ERROR (Status
)) {
1041 Status
= EFI_DEVICE_ERROR
;
1046 DhcpCleanLease (DhcpSb
);
1049 gBS
->RestoreTPL (OldTpl
);
1055 Stops the current address configuration.
1057 The Stop() function is used to stop the DHCP configuration process. After this
1058 function is called successfully, the EFI DHCPv4 Protocol driver is transferred
1059 into the Dhcp4Stopped state. EFI_DHCP4_PROTOCOL.Configure() needs to be called
1060 before DHCP configuration process can be started again. This function can be
1061 called when the EFI DHCPv4 Protocol driver is in any state.
1063 @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.
1065 @retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Stopped phase.
1066 @retval EFI_INVALID_PARAMETER This is NULL.
1072 IN EFI_DHCP4_PROTOCOL
*This
1075 DHCP_PROTOCOL
*Instance
;
1076 DHCP_SERVICE
*DhcpSb
;
1080 // First validate the parameters
1083 return EFI_INVALID_PARAMETER
;
1086 Instance
= DHCP_INSTANCE_FROM_THIS (This
);
1088 if (Instance
->Signature
!= DHCP_PROTOCOL_SIGNATURE
) {
1089 return EFI_INVALID_PARAMETER
;
1092 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
1093 DhcpSb
= Instance
->Service
;
1095 DhcpCleanLease (DhcpSb
);
1097 DhcpSb
->DhcpState
= Dhcp4Stopped
;
1098 DhcpSb
->ServiceState
= DHCP_UNCONFIGED
;
1100 gBS
->RestoreTPL (OldTpl
);
1106 Builds a DHCP packet, given the options to be appended or deleted or replaced.
1108 The Build() function is used to assemble a new packet from the original packet
1109 by replacing or deleting existing options or appending new options. This function
1110 does not change any state of the EFI DHCPv4 Protocol driver and can be used at
1113 @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.
1114 @param[in] SeedPacket Initial packet to be used as a base for building new packet.
1115 @param[in] DeleteCount Number of opcodes in the DeleteList.
1116 @param[in] DeleteList List of opcodes to be deleted from the seed packet.
1117 Ignored if DeleteCount is zero.
1118 @param[in] AppendCount Number of entries in the OptionList.
1119 @param[in] AppendList Pointer to a DHCP option list to be appended to SeedPacket.
1120 If SeedPacket also contains options in this list, they are
1121 replaced by new options (except pad option). Ignored if
1122 AppendCount is zero. Type EFI_DHCP4_PACKET_OPTION
1123 @param[out] NewPacket Pointer to storage for the pointer to the new allocated packet.
1124 Use the EFI Boot Service FreePool() on the resulting pointer
1125 when done with the packet.
1127 @retval EFI_SUCCESS The new packet was built.
1128 @retval EFI_OUT_OF_RESOURCES Storage for the new packet could not be allocated.
1129 @retval EFI_INVALID_PARAMETER Some parameter is NULL.
1135 IN EFI_DHCP4_PROTOCOL
*This
,
1136 IN EFI_DHCP4_PACKET
*SeedPacket
,
1137 IN UINT32 DeleteCount
,
1138 IN UINT8
*DeleteList OPTIONAL
,
1139 IN UINT32 AppendCount
,
1140 IN EFI_DHCP4_PACKET_OPTION
*AppendList
[] OPTIONAL
,
1141 OUT EFI_DHCP4_PACKET
**NewPacket
1145 // First validate the parameters
1147 if ((This
== NULL
) || (NewPacket
== NULL
)) {
1148 return EFI_INVALID_PARAMETER
;
1151 if ((SeedPacket
== NULL
) || (SeedPacket
->Dhcp4
.Magik
!= DHCP_OPTION_MAGIC
) ||
1152 EFI_ERROR (DhcpValidateOptions (SeedPacket
, NULL
))) {
1154 return EFI_INVALID_PARAMETER
;
1157 if (((DeleteCount
== 0) && (AppendCount
== 0)) ||
1158 ((DeleteCount
!= 0) && (DeleteList
== NULL
)) ||
1159 ((AppendCount
!= 0) && (AppendList
== NULL
))) {
1161 return EFI_INVALID_PARAMETER
;
1175 Callback by UdpIoCreatePort() when creating UdpIo for this Dhcp4 instance.
1177 @param[in] UdpIo The UdpIo being created.
1178 @param[in] Context Dhcp4 instance.
1180 @retval EFI_SUCCESS UdpIo is configured successfully.
1181 @retval other Other error occurs.
1185 Dhcp4InstanceConfigUdpIo (
1190 DHCP_PROTOCOL
*Instance
;
1191 DHCP_SERVICE
*DhcpSb
;
1192 EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN
*Token
;
1193 EFI_UDP4_CONFIG_DATA UdpConfigData
;
1194 IP4_ADDR ClientAddr
;
1197 IP4_ADDR SubnetMask
;
1199 Instance
= (DHCP_PROTOCOL
*) Context
;
1200 DhcpSb
= Instance
->Service
;
1201 Token
= Instance
->Token
;
1203 ZeroMem (&UdpConfigData
, sizeof (EFI_UDP4_CONFIG_DATA
));
1205 UdpConfigData
.AcceptBroadcast
= TRUE
;
1206 UdpConfigData
.AllowDuplicatePort
= TRUE
;
1207 UdpConfigData
.TimeToLive
= 64;
1208 UdpConfigData
.DoNotFragment
= TRUE
;
1210 ClientAddr
= EFI_NTOHL (Token
->Packet
->Dhcp4
.Header
.ClientAddr
);
1211 Ip
= HTONL (ClientAddr
);
1212 CopyMem (&UdpConfigData
.StationAddress
, &Ip
, sizeof (EFI_IPv4_ADDRESS
));
1214 Class
= NetGetIpClass (ClientAddr
);
1215 ASSERT (Class
< IP4_ADDR_CLASSE
);
1216 SubnetMask
= gIp4AllMasks
[Class
<< 3];
1217 Ip
= HTONL (SubnetMask
);
1218 CopyMem (&UdpConfigData
.SubnetMask
, &Ip
, sizeof (EFI_IPv4_ADDRESS
));
1220 if ((Token
->ListenPointCount
== 0) || (Token
->ListenPoints
[0].ListenPort
== 0)) {
1221 UdpConfigData
.StationPort
= DHCP_CLIENT_PORT
;
1223 UdpConfigData
.StationPort
= Token
->ListenPoints
[0].ListenPort
;
1226 return UdpIo
->Protocol
.Udp4
->Configure (UdpIo
->Protocol
.Udp4
, &UdpConfigData
);
1230 Create UdpIo for this Dhcp4 instance.
1232 @param Instance The Dhcp4 instance.
1234 @retval EFI_SUCCESS UdpIo is created successfully.
1235 @retval EFI_OUT_OF_RESOURCES Fails to create UdpIo because of limited
1236 resources or configuration failure.
1239 Dhcp4InstanceCreateUdpIo (
1240 IN OUT DHCP_PROTOCOL
*Instance
1243 DHCP_SERVICE
*DhcpSb
;
1247 ASSERT (Instance
->Token
!= NULL
);
1249 DhcpSb
= Instance
->Service
;
1250 Instance
->UdpIo
= UdpIoCreateIo (
1253 Dhcp4InstanceConfigUdpIo
,
1254 UDP_IO_UDP4_VERSION
,
1257 if (Instance
->UdpIo
== NULL
) {
1258 return EFI_OUT_OF_RESOURCES
;
1260 Status
= gBS
->OpenProtocol (
1261 Instance
->UdpIo
->UdpHandle
,
1262 &gEfiUdp4ProtocolGuid
,
1264 Instance
->Service
->Image
,
1266 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
1268 if (EFI_ERROR (Status
)) {
1269 UdpIoFreeIo (Instance
->UdpIo
);
1270 Instance
->UdpIo
= NULL
;
1277 Callback of Dhcp packet. Does nothing.
1279 @param Arg The context.
1291 Callback of UdpIoRecvDatagram() that handles a Dhcp4 packet.
1293 Only BOOTP responses will be handled that correspond to the Xid of the request
1294 sent out. The packet will be queued to the response queue.
1296 @param UdpPacket The Dhcp4 packet.
1297 @param EndPoint Udp4 address pair.
1298 @param IoStatus Status of the input.
1299 @param Context Extra info for the input.
1306 UDP_END_POINT
*EndPoint
,
1307 EFI_STATUS IoStatus
,
1311 DHCP_PROTOCOL
*Instance
;
1312 DHCP_SERVICE
*DhcpSb
;
1313 EFI_DHCP4_HEADER
*Head
;
1315 EFI_DHCP4_PACKET
*Packet
;
1316 EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN
*Token
;
1321 Instance
= (DHCP_PROTOCOL
*) Context
;
1322 Token
= Instance
->Token
;
1323 DhcpSb
= Instance
->Service
;
1326 // Don't restart receive if error occurs or DHCP is destroyed.
1328 if (EFI_ERROR (IoStatus
)) {
1332 ASSERT (UdpPacket
!= NULL
);
1335 // Validate the packet received
1337 if (UdpPacket
->TotalSize
< sizeof (EFI_DHCP4_HEADER
)) {
1342 // Copy the DHCP message to a continuous memory block, make the buffer size
1343 // of the EFI_DHCP4_PACKET a multiple of 4-byte.
1345 Len
= NET_ROUNDUP (sizeof (EFI_DHCP4_PACKET
) + UdpPacket
->TotalSize
- sizeof (EFI_DHCP4_HEADER
), 4);
1346 Wrap
= NetbufAlloc (Len
);
1351 Packet
= (EFI_DHCP4_PACKET
*) NetbufAllocSpace (Wrap
, Len
, NET_BUF_TAIL
);
1352 ASSERT (Packet
!= NULL
);
1355 Head
= &Packet
->Dhcp4
.Header
;
1356 Packet
->Length
= NetbufCopy (UdpPacket
, 0, UdpPacket
->TotalSize
, (UINT8
*) Head
);
1358 if (Packet
->Length
!= UdpPacket
->TotalSize
) {
1363 // Is this packet the answer to our packet?
1365 if ((Head
->OpCode
!= BOOTP_REPLY
) ||
1366 (Head
->Xid
!= Token
->Packet
->Dhcp4
.Header
.Xid
) ||
1367 (CompareMem (&Token
->Packet
->Dhcp4
.Header
.ClientHwAddr
[0], Head
->ClientHwAddr
, Head
->HwAddrLen
) != 0)) {
1372 // Validate the options and retrieve the interested options
1374 if ((Packet
->Length
> sizeof (EFI_DHCP4_HEADER
) + sizeof (UINT32
)) &&
1375 (Packet
->Dhcp4
.Magik
== DHCP_OPTION_MAGIC
) &&
1376 EFI_ERROR (DhcpValidateOptions (Packet
, NULL
))) {
1382 // Keep this packet in the ResponseQueue.
1385 NetbufQueAppend (&Instance
->ResponseQueue
, Wrap
);
1389 NetbufFree (UdpPacket
);
1395 Status
= UdpIoRecvDatagram (Instance
->UdpIo
, PxeDhcpInput
, Instance
, 0);
1396 if (EFI_ERROR (Status
)) {
1397 PxeDhcpDone (Instance
);
1402 Complete a Dhcp4 transaction and signal the upper layer.
1404 @param Instance Dhcp4 instance.
1409 IN DHCP_PROTOCOL
*Instance
1412 EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN
*Token
;
1414 Token
= Instance
->Token
;
1416 Token
->ResponseCount
= Instance
->ResponseQueue
.BufNum
;
1417 if (Token
->ResponseCount
!= 0) {
1418 Token
->ResponseList
= (EFI_DHCP4_PACKET
*) AllocatePool (Instance
->ResponseQueue
.BufSize
);
1419 if (Token
->ResponseList
== NULL
) {
1420 Token
->Status
= EFI_OUT_OF_RESOURCES
;
1425 // Copy the received DHCP responses.
1427 NetbufQueCopy (&Instance
->ResponseQueue
, 0, Instance
->ResponseQueue
.BufSize
, (UINT8
*) Token
->ResponseList
);
1428 Token
->Status
= EFI_SUCCESS
;
1430 Token
->ResponseList
= NULL
;
1431 Token
->Status
= EFI_TIMEOUT
;
1436 // Clean up the resources dedicated for this transmit receive transaction.
1438 NetbufQueFlush (&Instance
->ResponseQueue
);
1439 UdpIoCleanIo (Instance
->UdpIo
);
1440 gBS
->CloseProtocol (
1441 Instance
->UdpIo
->UdpHandle
,
1442 &gEfiUdp4ProtocolGuid
,
1443 Instance
->Service
->Image
,
1446 UdpIoFreeIo (Instance
->UdpIo
);
1447 Instance
->UdpIo
= NULL
;
1448 Instance
->Token
= NULL
;
1450 if (Token
->CompletionEvent
!= NULL
) {
1451 gBS
->SignalEvent (Token
->CompletionEvent
);
1457 Transmits a DHCP formatted packet and optionally waits for responses.
1459 The TransmitReceive() function is used to transmit a DHCP packet and optionally
1460 wait for the response from servers. This function does not change the state of
1461 the EFI DHCPv4 Protocol driver and thus can be used at any time.
1463 @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.
1464 @param[in] Token Pointer to the EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN structure.
1466 @retval EFI_SUCCESS The packet was successfully queued for transmission.
1467 @retval EFI_INVALID_PARAMETER Some parameter is NULL.
1468 @retval EFI_NOT_READY The previous call to this function has not finished yet. Try to call
1469 this function after collection process completes.
1470 @retval EFI_NO_MAPPING The default station address is not available yet.
1471 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
1472 @retval Others Some other unexpected error occurred.
1477 EfiDhcp4TransmitReceive (
1478 IN EFI_DHCP4_PROTOCOL
*This
,
1479 IN EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN
*Token
1482 DHCP_PROTOCOL
*Instance
;
1487 UDP_END_POINT EndPoint
;
1489 DHCP_SERVICE
*DhcpSb
;
1490 EFI_IP_ADDRESS Gateway
;
1491 IP4_ADDR ClientAddr
;
1493 IP4_ADDR SubnetMask
;
1495 if ((This
== NULL
) || (Token
== NULL
) || (Token
->Packet
== NULL
)) {
1496 return EFI_INVALID_PARAMETER
;
1499 Instance
= DHCP_INSTANCE_FROM_THIS (This
);
1500 DhcpSb
= Instance
->Service
;
1501 DhcpSb
->ActiveChild
= Instance
;
1503 if (Instance
->Token
!= NULL
) {
1505 // The previous call to TransmitReceive is not finished.
1507 return EFI_NOT_READY
;
1510 if ((Token
->Packet
->Dhcp4
.Magik
!= DHCP_OPTION_MAGIC
) ||
1511 (NTOHL (Token
->Packet
->Dhcp4
.Header
.Xid
) == Instance
->Service
->Xid
) ||
1512 (Token
->TimeoutValue
== 0) ||
1513 ((Token
->ListenPointCount
!= 0) && (Token
->ListenPoints
== NULL
)) ||
1514 EFI_ERROR (DhcpValidateOptions (Token
->Packet
, NULL
)) ||
1515 EFI_IP4_EQUAL (&Token
->RemoteAddress
, &mZeroIp4Addr
)
1518 // The DHCP packet isn't well-formed, the Transaction ID is already used,
1519 // the timeout value is zero, the ListenPoint is invalid, or the
1520 // RemoteAddress is zero.
1522 return EFI_INVALID_PARAMETER
;
1525 ClientAddr
= EFI_NTOHL (Token
->Packet
->Dhcp4
.Header
.ClientAddr
);
1527 if (ClientAddr
== 0) {
1528 return EFI_NO_MAPPING
;
1531 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
1534 // Save the token and the timeout value.
1536 Instance
->Token
= Token
;
1537 Instance
->Timeout
= Token
->TimeoutValue
;
1540 // Create a UDP IO for this transmit receive transaction.
1542 Status
= Dhcp4InstanceCreateUdpIo (Instance
);
1543 if (EFI_ERROR (Status
)) {
1548 // Save the Client Address is sent out
1551 &DhcpSb
->ClientAddressSendOut
[0],
1552 &Token
->Packet
->Dhcp4
.Header
.ClientHwAddr
[0],
1553 Token
->Packet
->Dhcp4
.Header
.HwAddrLen
1557 // Wrap the DHCP packet into a net buffer.
1559 Frag
.Bulk
= (UINT8
*) &Token
->Packet
->Dhcp4
;
1560 Frag
.Len
= Token
->Packet
->Length
;
1561 Wrap
= NetbufFromExt (&Frag
, 1, 0, 0, DhcpDummyExtFree
, NULL
);
1563 Status
= EFI_OUT_OF_RESOURCES
;
1568 // Set the local address and local port to ZERO.
1570 ZeroMem (&EndPoint
, sizeof (UDP_END_POINT
));
1573 // Set the destination address and destination port.
1575 CopyMem (&Ip
, &Token
->RemoteAddress
, sizeof (EFI_IPv4_ADDRESS
));
1576 EndPoint
.RemoteAddr
.Addr
[0] = NTOHL (Ip
);
1578 if (Token
->RemotePort
== 0) {
1579 EndPoint
.RemotePort
= DHCP_SERVER_PORT
;
1581 EndPoint
.RemotePort
= Token
->RemotePort
;
1587 Class
= NetGetIpClass (ClientAddr
);
1588 ASSERT (Class
< IP4_ADDR_CLASSE
);
1589 SubnetMask
= gIp4AllMasks
[Class
<< 3];
1590 ZeroMem (&Gateway
, sizeof (Gateway
));
1591 if (!IP4_NET_EQUAL (ClientAddr
, EndPoint
.RemoteAddr
.Addr
[0], SubnetMask
)) {
1592 CopyMem (&Gateway
.v4
, &Token
->GatewayAddress
, sizeof (EFI_IPv4_ADDRESS
));
1593 Gateway
.Addr
[0] = NTOHL (Gateway
.Addr
[0]);
1597 // Transmit the DHCP packet.
1599 Status
= UdpIoSendDatagram (Instance
->UdpIo
, Wrap
, &EndPoint
, &Gateway
, DhcpOnPacketSent
, NULL
);
1600 if (EFI_ERROR (Status
)) {
1606 // Start to receive the DHCP response.
1608 Status
= UdpIoRecvDatagram (Instance
->UdpIo
, PxeDhcpInput
, Instance
, 0);
1609 if (EFI_ERROR (Status
)) {
1615 if (EFI_ERROR (Status
) && (Instance
->UdpIo
!= NULL
)) {
1616 UdpIoCleanIo (Instance
->UdpIo
);
1617 gBS
->CloseProtocol (
1618 Instance
->UdpIo
->UdpHandle
,
1619 &gEfiUdp4ProtocolGuid
,
1620 Instance
->Service
->Image
,
1623 UdpIoFreeIo (Instance
->UdpIo
);
1624 Instance
->UdpIo
= NULL
;
1625 Instance
->Token
= NULL
;
1628 gBS
->RestoreTPL (OldTpl
);
1630 if (!EFI_ERROR (Status
) && (Token
->CompletionEvent
== NULL
)) {
1632 // Keep polling until timeout if no error happens and the CompletionEvent
1636 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
1638 // Raise TPL to protect the UDPIO in instance, in case that DhcpOnTimerTick
1639 // free it when timeout.
1641 if (Instance
->Timeout
> 0) {
1642 Instance
->UdpIo
->Protocol
.Udp4
->Poll (Instance
->UdpIo
->Protocol
.Udp4
);
1643 gBS
->RestoreTPL (OldTpl
);
1645 gBS
->RestoreTPL (OldTpl
);
1656 Callback function for DhcpIterateOptions. This callback sets the
1657 EFI_DHCP4_PACKET_OPTION array in the DHCP_PARSE_CONTEXT to point
1658 the individual DHCP option in the packet.
1660 @param[in] Tag The DHCP option type
1661 @param[in] Len Length of the DHCP option data
1662 @param[in] Data The DHCP option data
1663 @param[in] Context The context, to pass several parameters in.
1665 @retval EFI_SUCCESS It always returns EFI_SUCCESS
1669 Dhcp4ParseCheckOption (
1676 DHCP_PARSE_CONTEXT
*Parse
;
1678 Parse
= (DHCP_PARSE_CONTEXT
*) Context
;
1681 if (Parse
->Index
<= Parse
->OptionCount
) {
1683 // Use BASE_CR to get the memory position of EFI_DHCP4_PACKET_OPTION for
1684 // the EFI_DHCP4_PACKET_OPTION->Data because DhcpIterateOptions only
1685 // pass in the point to option data.
1687 Parse
->Option
[Parse
->Index
- 1] = BASE_CR (Data
, EFI_DHCP4_PACKET_OPTION
, Data
);
1695 Parses the packed DHCP option data.
1697 The Parse() function is used to retrieve the option list from a DHCP packet.
1698 If *OptionCount isn't zero, and there is enough space for all the DHCP options
1699 in the Packet, each element of PacketOptionList is set to point to somewhere in
1700 the Packet->Dhcp4.Option where a new DHCP option begins. If RFC3396 is supported,
1701 the caller should reassemble the parsed DHCP options to get the finial result.
1702 If *OptionCount is zero or there isn't enough space for all of them, the number
1703 of DHCP options in the Packet is returned in OptionCount.
1705 @param This Pointer to the EFI_DHCP4_PROTOCOL instance.
1706 @param Packet Pointer to packet to be parsed.
1707 @param OptionCount On input, the number of entries in the PacketOptionList.
1708 On output, the number of entries that were written into the
1710 @param PacketOptionList List of packet option entries to be filled in. End option or pad
1711 options are not included.
1713 @retval EFI_SUCCESS The packet was successfully parsed.
1714 @retval EFI_INVALID_PARAMETER Some parameter is NULL.
1715 @retval EFI_BUFFER_TOO_SMALL One or more of the following conditions is TRUE:
1716 1) *OptionCount is smaller than the number of options that
1717 were found in the Packet.
1718 2) PacketOptionList is NULL.
1724 IN EFI_DHCP4_PROTOCOL
*This
,
1725 IN EFI_DHCP4_PACKET
*Packet
,
1726 IN OUT UINT32
*OptionCount
,
1727 OUT EFI_DHCP4_PACKET_OPTION
*PacketOptionList
[] OPTIONAL
1730 DHCP_PARSE_CONTEXT Context
;
1734 // First validate the parameters
1736 if ((This
== NULL
) || (Packet
== NULL
) || (OptionCount
== NULL
)) {
1737 return EFI_INVALID_PARAMETER
;
1740 if ((Packet
->Size
< Packet
->Length
+ 2 * sizeof (UINT32
)) ||
1741 (Packet
->Dhcp4
.Magik
!= DHCP_OPTION_MAGIC
) ||
1742 EFI_ERROR (DhcpValidateOptions (Packet
, NULL
))) {
1744 return EFI_INVALID_PARAMETER
;
1747 if ((*OptionCount
!= 0) && (PacketOptionList
== NULL
)) {
1748 return EFI_BUFFER_TOO_SMALL
;
1751 ZeroMem (PacketOptionList
, *OptionCount
* sizeof (EFI_DHCP4_PACKET_OPTION
*));
1753 Context
.Option
= PacketOptionList
;
1754 Context
.OptionCount
= *OptionCount
;
1757 Status
= DhcpIterateOptions (Packet
, Dhcp4ParseCheckOption
, &Context
);
1759 if (EFI_ERROR (Status
)) {
1763 *OptionCount
= Context
.Index
;
1765 if (Context
.Index
> Context
.OptionCount
) {
1766 return EFI_BUFFER_TOO_SMALL
;
1773 Set the elapsed time based on the given instance and the pointer to the
1774 elapsed time option.
1776 @param[in] Elapsed The pointer to the position to append.
1777 @param[in] Instance The pointer to the Dhcp4 instance.
1782 IN DHCP_PROTOCOL
*Instance
1785 WriteUnaligned16 (Elapsed
, HTONS(Instance
->ElaspedTime
));