]>
Commit | Line | Data |
---|---|---|
772db4bb | 1 | /** @file\r |
3e8c18da | 2 | This file implement the EFI_DHCP4_PROTOCOL interface.\r |
3 | \r | |
894d038a | 4 | Copyright (c) 2006 - 2009, Intel Corporation.<BR>\r |
772db4bb | 5 | All rights reserved. This program and the accompanying materials\r |
6 | are licensed and made available under the terms and conditions of the BSD License\r | |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php\r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | \r | |
772db4bb | 13 | **/\r |
14 | \r | |
15 | \r | |
16 | #include "Dhcp4Impl.h"\r | |
17 | \r | |
f9204641 | 18 | /**\r |
19 | Returns the current operating mode and cached data packet for the EFI DHCPv4 Protocol driver.\r | |
20 | \r | |
21 | The GetModeData() function returns the current operating mode and cached data\r | |
22 | packet for the EFI DHCPv4 Protocol driver.\r | |
23 | \r | |
3e8c18da | 24 | @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r |
25 | @param[out] Dhcp4ModeData Pointer to storage for the EFI_DHCP4_MODE_DATA structure.\r | |
f9204641 | 26 | \r |
27 | @retval EFI_SUCCESS The mode data was returned.\r | |
28 | @retval EFI_INVALID_PARAMETER This is NULL.\r | |
29 | \r | |
30 | **/\r | |
31 | EFI_STATUS\r | |
32 | EFIAPI\r | |
33 | EfiDhcp4GetModeData (\r | |
34 | IN EFI_DHCP4_PROTOCOL *This,\r | |
35 | OUT EFI_DHCP4_MODE_DATA *Dhcp4ModeData\r | |
36 | );\r | |
37 | \r | |
38 | /**\r | |
39 | Initializes, changes, or resets the operational settings for the EFI DHCPv4 Protocol driver.\r | |
40 | \r | |
41 | The Configure() function is used to initialize, change, or reset the operational\r | |
42 | settings of the EFI DHCPv4 Protocol driver for the communication device on which\r | |
43 | the EFI DHCPv4 Service Binding Protocol is installed. This function can be\r | |
44 | successfully called only if both of the following are true:\r | |
45 | * This instance of the EFI DHCPv4 Protocol driver is in the Dhcp4Stopped, Dhcp4Init,\r | |
46 | Dhcp4InitReboot, or Dhcp4Bound states.\r | |
47 | * No other EFI DHCPv4 Protocol driver instance that is controlled by this EFI\r | |
48 | DHCPv4 Service Binding Protocol driver instance has configured this EFI DHCPv4\r | |
49 | Protocol driver.\r | |
50 | When this driver is in the Dhcp4Stopped state, it can transfer into one of the\r | |
51 | following two possible initial states:\r | |
52 | * Dhcp4Init\r | |
53 | * Dhcp4InitReboot\r | |
54 | The driver can transfer into these states by calling Configure() with a non-NULL\r | |
55 | Dhcp4CfgData. The driver will transfer into the appropriate state based on the\r | |
56 | supplied client network address in the ClientAddress parameter and DHCP options\r | |
57 | in the OptionList parameter as described in RFC 2131.\r | |
58 | When Configure() is called successfully while Dhcp4CfgData is set to NULL, the\r | |
59 | default configuring data will be reset in the EFI DHCPv4 Protocol driver and\r | |
60 | the state of the EFI DHCPv4 Protocol driver will not be changed. If one instance\r | |
61 | wants to make it possible for another instance to configure the EFI DHCPv4 Protocol\r | |
62 | driver, it must call this function with Dhcp4CfgData set to NULL.\r | |
63 | \r | |
3e8c18da | 64 | @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r |
65 | @param[in] Dhcp4CfgData Pointer to the EFI_DHCP4_CONFIG_DATA.\r | |
f9204641 | 66 | \r |
67 | @retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Init or\r | |
68 | Dhcp4InitReboot state, if the original state of this driver\r | |
69 | was Dhcp4Stopped and the value of Dhcp4CfgData was\r | |
70 | not NULL. Otherwise, the state was left unchanged.\r | |
71 | @retval EFI_ACCESS_DENIED This instance of the EFI DHCPv4 Protocol driver was not in the\r | |
72 | Dhcp4Stopped, Dhcp4Init, Dhcp4InitReboot, or Dhcp4Bound state;\r | |
73 | Or onother instance of this EFI DHCPv4 Protocol driver is already\r | |
74 | in a valid configured state.\r | |
75 | @retval EFI_INVALID_PARAMETER Some parameter is NULL.\r | |
76 | @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.\r | |
77 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r | |
78 | \r | |
79 | **/\r | |
80 | EFI_STATUS\r | |
81 | EFIAPI\r | |
82 | EfiDhcp4Configure (\r | |
83 | IN EFI_DHCP4_PROTOCOL *This,\r | |
84 | IN EFI_DHCP4_CONFIG_DATA *Dhcp4CfgData OPTIONAL\r | |
85 | ); \r | |
86 | \r | |
87 | /**\r | |
88 | Starts the DHCP configuration process.\r | |
89 | \r | |
90 | The Start() function starts the DHCP configuration process. This function can\r | |
91 | be called only when the EFI DHCPv4 Protocol driver is in the Dhcp4Init or\r | |
92 | Dhcp4InitReboot state.\r | |
93 | If the DHCP process completes successfully, the state of the EFI DHCPv4 Protocol\r | |
94 | driver will be transferred through Dhcp4Selecting and Dhcp4Requesting to the\r | |
95 | Dhcp4Bound state. The CompletionEvent will then be signaled if it is not NULL.\r | |
96 | If the process aborts, either by the user or by some unexpected network error,\r | |
97 | the state is restored to the Dhcp4Init state. The Start() function can be called\r | |
98 | again to restart the process.\r | |
99 | Refer to RFC 2131 for precise state transitions during this process. At the\r | |
100 | time when each event occurs in this process, the callback function that was set\r | |
101 | by EFI_DHCP4_PROTOCOL.Configure() will be called and the user can take this\r | |
102 | opportunity to control the process.\r | |
103 | \r | |
3e8c18da | 104 | @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r |
105 | @param[in] CompletionEvent If not NULL, indicates the event that will be signaled when the\r | |
106 | EFI DHCPv4 Protocol driver is transferred into the\r | |
107 | Dhcp4Bound state or when the DHCP process is aborted.\r | |
108 | EFI_DHCP4_PROTOCOL.GetModeData() can be called to\r | |
109 | check the completion status. If NULL,\r | |
110 | EFI_DHCP4_PROTOCOL.Start() will wait until the driver\r | |
111 | is transferred into the Dhcp4Bound state or the process fails.\r | |
f9204641 | 112 | \r |
113 | @retval EFI_SUCCESS The DHCP configuration process has started, or it has completed\r | |
114 | when CompletionEvent is NULL.\r | |
115 | @retval EFI_NOT_STARTED The EFI DHCPv4 Protocol driver is in the Dhcp4Stopped\r | |
116 | state. EFI_DHCP4_PROTOCOL. Configure() needs to be called.\r | |
117 | @retval EFI_INVALID_PARAMETER This is NULL.\r | |
118 | @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.\r | |
119 | @retval EFI_TIMEOUT The DHCP configuration process failed because no response was\r | |
120 | received from the server within the specified timeout value.\r | |
121 | @retval EFI_ABORTED The user aborted the DHCP process.\r | |
122 | @retval EFI_ALREADY_STARTED Some other EFI DHCPv4 Protocol instance already started the\r | |
123 | DHCP process.\r | |
124 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r | |
125 | \r | |
126 | **/\r | |
127 | EFI_STATUS\r | |
128 | EFIAPI\r | |
129 | EfiDhcp4Start (\r | |
130 | IN EFI_DHCP4_PROTOCOL *This,\r | |
131 | IN EFI_EVENT CompletionEvent OPTIONAL\r | |
132 | );\r | |
133 | \r | |
134 | /**\r | |
135 | Extends the lease time by sending a request packet.\r | |
136 | \r | |
137 | The RenewRebind() function is used to manually extend the lease time when the\r | |
138 | EFI DHCPv4 Protocol driver is in the Dhcp4Bound state and the lease time has\r | |
139 | not expired yet. This function will send a request packet to the previously\r | |
140 | found server (or to any server when RebindRequest is TRUE) and transfer the\r | |
141 | state into the Dhcp4Renewing state (or Dhcp4Rebinding when RebindingRequest is\r | |
142 | TRUE). When a response is received, the state is returned to Dhcp4Bound.\r | |
143 | If no response is received before the try count is exceeded (the RequestTryCount\r | |
144 | field that is specified in EFI_DHCP4_CONFIG_DATA) but before the lease time that\r | |
145 | was issued by the previous server expires, the driver will return to the Dhcp4Bound\r | |
146 | state and the previous configuration is restored. The outgoing and incoming packets\r | |
147 | can be captured by the EFI_DHCP4_CALLBACK function.\r | |
148 | \r | |
3e8c18da | 149 | @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r |
150 | @param[in] RebindRequest If TRUE, this function broadcasts the request packets and enters\r | |
151 | the Dhcp4Rebinding state. Otherwise, it sends a unicast\r | |
152 | request packet and enters the Dhcp4Renewing state.\r | |
153 | @param[in] CompletionEvent If not NULL, this event is signaled when the renew/rebind phase\r | |
154 | completes or some error occurs.\r | |
155 | EFI_DHCP4_PROTOCOL.GetModeData() can be called to\r | |
156 | check the completion status. If NULL,\r | |
157 | EFI_DHCP4_PROTOCOL.RenewRebind() will busy-wait\r | |
158 | until the DHCP process finishes.\r | |
f9204641 | 159 | \r |
160 | @retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the\r | |
161 | Dhcp4Renewing state or is back to the Dhcp4Bound state.\r | |
162 | @retval EFI_NOT_STARTED The EFI DHCPv4 Protocol driver is in the Dhcp4Stopped\r | |
163 | state. EFI_DHCP4_PROTOCOL.Configure() needs to\r | |
164 | be called.\r | |
165 | @retval EFI_INVALID_PARAMETER This is NULL.\r | |
166 | @retval EFI_TIMEOUT There was no response from the server when the try count was\r | |
167 | exceeded.\r | |
168 | @retval EFI_ACCESS_DENIED The driver is not in the Dhcp4Bound state.\r | |
169 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r | |
170 | \r | |
171 | **/\r | |
172 | EFI_STATUS\r | |
173 | EFIAPI\r | |
174 | EfiDhcp4RenewRebind (\r | |
175 | IN EFI_DHCP4_PROTOCOL *This,\r | |
176 | IN BOOLEAN RebindRequest,\r | |
177 | IN EFI_EVENT CompletionEvent OPTIONAL\r | |
178 | );\r | |
179 | \r | |
180 | /**\r | |
181 | Releases the current address configuration.\r | |
182 | \r | |
183 | The Release() function releases the current configured IP address by doing either\r | |
184 | of the following:\r | |
185 | * Sending a DHCPRELEASE packet when the EFI DHCPv4 Protocol driver is in the\r | |
186 | Dhcp4Bound state\r | |
187 | * Setting the previously assigned IP address that was provided with the\r | |
188 | EFI_DHCP4_PROTOCOL.Configure() function to 0.0.0.0 when the driver is in\r | |
189 | Dhcp4InitReboot state\r | |
190 | After a successful call to this function, the EFI DHCPv4 Protocol driver returns\r | |
191 | to the Dhcp4Init state and any subsequent incoming packets will be discarded silently.\r | |
192 | \r | |
3e8c18da | 193 | @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r |
f9204641 | 194 | \r |
195 | @retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Init phase.\r | |
196 | @retval EFI_INVALID_PARAMETER This is NULL.\r | |
197 | @retval EFI_ACCESS_DENIED The EFI DHCPv4 Protocol driver is not Dhcp4InitReboot state.\r | |
198 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r | |
199 | \r | |
200 | **/\r | |
201 | EFI_STATUS\r | |
202 | EFIAPI\r | |
203 | EfiDhcp4Release (\r | |
204 | IN EFI_DHCP4_PROTOCOL *This\r | |
205 | );\r | |
206 | \r | |
207 | /**\r | |
208 | Stops the current address configuration.\r | |
209 | \r | |
210 | The Stop() function is used to stop the DHCP configuration process. After this\r | |
211 | function is called successfully, the EFI DHCPv4 Protocol driver is transferred\r | |
212 | into the Dhcp4Stopped state. EFI_DHCP4_PROTOCOL.Configure() needs to be called\r | |
213 | before DHCP configuration process can be started again. This function can be\r | |
214 | called when the EFI DHCPv4 Protocol driver is in any state.\r | |
215 | \r | |
3e8c18da | 216 | @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r |
f9204641 | 217 | \r |
218 | @retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Stopped phase.\r | |
219 | @retval EFI_INVALID_PARAMETER This is NULL.\r | |
220 | \r | |
221 | **/\r | |
222 | EFI_STATUS\r | |
223 | EFIAPI\r | |
224 | EfiDhcp4Stop (\r | |
225 | IN EFI_DHCP4_PROTOCOL *This\r | |
226 | );\r | |
227 | \r | |
228 | /**\r | |
229 | Builds a DHCP packet, given the options to be appended or deleted or replaced.\r | |
230 | \r | |
231 | The Build() function is used to assemble a new packet from the original packet\r | |
232 | by replacing or deleting existing options or appending new options. This function\r | |
233 | does not change any state of the EFI DHCPv4 Protocol driver and can be used at\r | |
234 | any time.\r | |
235 | \r | |
3e8c18da | 236 | @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r |
237 | @param[in] SeedPacket Initial packet to be used as a base for building new packet.\r | |
238 | @param[in] DeleteCount Number of opcodes in the DeleteList.\r | |
239 | @param[in] DeleteList List of opcodes to be deleted from the seed packet.\r | |
240 | Ignored if DeleteCount is zero.\r | |
241 | @param[in] AppendCount Number of entries in the OptionList.\r | |
242 | @param[in] AppendList Pointer to a DHCP option list to be appended to SeedPacket.\r | |
243 | If SeedPacket also contains options in this list, they are\r | |
244 | replaced by new options (except pad option). Ignored if\r | |
245 | AppendCount is zero. Type EFI_DHCP4_PACKET_OPTION\r | |
246 | @param[out] NewPacket Pointer to storage for the pointer to the new allocated packet.\r | |
247 | Use the EFI Boot Service FreePool() on the resulting pointer\r | |
248 | when done with the packet.\r | |
f9204641 | 249 | \r |
250 | @retval EFI_SUCCESS The new packet was built.\r | |
251 | @retval EFI_OUT_OF_RESOURCES Storage for the new packet could not be allocated.\r | |
252 | @retval EFI_INVALID_PARAMETER Some parameter is NULL.\r | |
253 | \r | |
254 | **/\r | |
255 | EFI_STATUS\r | |
256 | EFIAPI\r | |
257 | EfiDhcp4Build (\r | |
258 | IN EFI_DHCP4_PROTOCOL *This,\r | |
259 | IN EFI_DHCP4_PACKET *SeedPacket,\r | |
260 | IN UINT32 DeleteCount,\r | |
261 | IN UINT8 *DeleteList OPTIONAL,\r | |
262 | IN UINT32 AppendCount,\r | |
263 | IN EFI_DHCP4_PACKET_OPTION *AppendList[] OPTIONAL,\r | |
264 | OUT EFI_DHCP4_PACKET **NewPacket\r | |
265 | );\r | |
266 | \r | |
3e8c18da | 267 | /**\r |
f9204641 | 268 | Transmits a DHCP formatted packet and optionally waits for responses.\r |
269 | \r | |
270 | The TransmitReceive() function is used to transmit a DHCP packet and optionally\r | |
271 | wait for the response from servers. This function does not change the state of\r | |
272 | the EFI DHCPv4 Protocol driver and thus can be used at any time.\r | |
273 | \r | |
3e8c18da | 274 | @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r |
275 | @param[in] Token Pointer to the EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN structure.\r | |
f9204641 | 276 | \r |
277 | @retval EFI_SUCCESS The packet was successfully queued for transmission.\r | |
278 | @retval EFI_INVALID_PARAMETER Some parameter is NULL.\r | |
279 | @retval EFI_NOT_READY The previous call to this function has not finished yet. Try to call\r | |
280 | this function after collection process completes.\r | |
281 | @retval EFI_NO_MAPPING The default station address is not available yet.\r | |
282 | @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.\r | |
283 | @retval Others Some other unexpected error occurred.\r | |
284 | \r | |
285 | **/\r | |
286 | EFI_STATUS\r | |
287 | EFIAPI\r | |
288 | EfiDhcp4TransmitReceive (\r | |
289 | IN EFI_DHCP4_PROTOCOL *This,\r | |
290 | IN EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN *Token\r | |
291 | );\r | |
292 | \r | |
293 | /**\r | |
294 | Parses the packed DHCP option data.\r | |
295 | \r | |
296 | The Parse() function is used to retrieve the option list from a DHCP packet.\r | |
51195fbe | 297 | If *OptionCount isn't zero, and there is enough space for all the DHCP options\r |
f9204641 | 298 | in the Packet, each element of PacketOptionList is set to point to somewhere in\r |
299 | the Packet->Dhcp4.Option where a new DHCP option begins. If RFC3396 is supported,\r | |
300 | the caller should reassemble the parsed DHCP options to get the finial result.\r | |
51195fbe | 301 | If *OptionCount is zero or there isn't enough space for all of them, the number\r |
f9204641 | 302 | of DHCP options in the Packet is returned in OptionCount.\r |
303 | \r | |
304 | @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r | |
305 | @param Packet Pointer to packet to be parsed.\r | |
306 | @param OptionCount On input, the number of entries in the PacketOptionList.\r | |
307 | On output, the number of entries that were written into the\r | |
308 | PacketOptionList.\r | |
309 | @param PacketOptionList List of packet option entries to be filled in. End option or pad\r | |
310 | options are not included.\r | |
311 | \r | |
312 | @retval EFI_SUCCESS The packet was successfully parsed.\r | |
313 | @retval EFI_INVALID_PARAMETER Some parameter is NULL.\r | |
314 | @retval EFI_BUFFER_TOO_SMALL One or more of the following conditions is TRUE:\r | |
315 | 1) *OptionCount is smaller than the number of options that\r | |
316 | were found in the Packet.\r | |
317 | 2) PacketOptionList is NULL.\r | |
318 | \r | |
319 | **/\r | |
320 | EFI_STATUS\r | |
321 | EFIAPI\r | |
322 | EfiDhcp4Parse (\r | |
323 | IN EFI_DHCP4_PROTOCOL *This,\r | |
324 | IN EFI_DHCP4_PACKET *Packet,\r | |
325 | IN OUT UINT32 *OptionCount,\r | |
326 | OUT EFI_DHCP4_PACKET_OPTION *PacketOptionList[] OPTIONAL\r | |
327 | );\r | |
328 | \r | |
329 | EFI_DHCP4_PROTOCOL mDhcp4ProtocolTemplate = {\r | |
330 | EfiDhcp4GetModeData,\r | |
331 | EfiDhcp4Configure,\r | |
332 | EfiDhcp4Start,\r | |
333 | EfiDhcp4RenewRebind,\r | |
334 | EfiDhcp4Release,\r | |
335 | EfiDhcp4Stop,\r | |
336 | EfiDhcp4Build,\r | |
337 | EfiDhcp4TransmitReceive,\r | |
338 | EfiDhcp4Parse\r | |
339 | };\r | |
772db4bb | 340 | \r |
341 | /**\r | |
f9204641 | 342 | Returns the current operating mode and cached data packet for the EFI DHCPv4 Protocol driver.\r |
343 | \r | |
344 | The GetModeData() function returns the current operating mode and cached data\r | |
345 | packet for the EFI DHCPv4 Protocol driver.\r | |
772db4bb | 346 | \r |
3e8c18da | 347 | @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r |
348 | @param[out] Dhcp4ModeData Pointer to storage for the EFI_DHCP4_MODE_DATA structure.\r | |
772db4bb | 349 | \r |
f9204641 | 350 | @retval EFI_SUCCESS The mode data was returned.\r |
351 | @retval EFI_INVALID_PARAMETER This is NULL.\r | |
772db4bb | 352 | \r |
353 | **/\r | |
772db4bb | 354 | EFI_STATUS\r |
355 | EFIAPI\r | |
356 | EfiDhcp4GetModeData (\r | |
357 | IN EFI_DHCP4_PROTOCOL *This,\r | |
358 | OUT EFI_DHCP4_MODE_DATA *Dhcp4ModeData\r | |
359 | )\r | |
360 | {\r | |
361 | DHCP_PROTOCOL *Instance;\r | |
362 | DHCP_SERVICE *DhcpSb;\r | |
363 | DHCP_PARAMETER *Para;\r | |
364 | EFI_TPL OldTpl;\r | |
365 | IP4_ADDR Ip;\r | |
366 | \r | |
367 | //\r | |
368 | // First validate the parameters.\r | |
369 | //\r | |
370 | if ((This == NULL) || (Dhcp4ModeData == NULL)) {\r | |
371 | return EFI_INVALID_PARAMETER;\r | |
372 | }\r | |
373 | \r | |
374 | Instance = DHCP_INSTANCE_FROM_THIS (This);\r | |
982a9eae | 375 | \r |
e48e37fc | 376 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r |
772db4bb | 377 | DhcpSb = Instance->Service;\r |
378 | \r | |
379 | //\r | |
380 | // Caller can use GetModeData to retrieve current DHCP states\r | |
381 | // no matter whether it is the active child or not.\r | |
382 | //\r | |
f9204641 | 383 | Dhcp4ModeData->State = (EFI_DHCP4_STATE) DhcpSb->DhcpState;\r |
687a2e5f | 384 | CopyMem (&Dhcp4ModeData->ConfigData, &DhcpSb->ActiveConfig, sizeof (Dhcp4ModeData->ConfigData));\r |
385 | CopyMem (&Dhcp4ModeData->ClientMacAddress, &DhcpSb->Mac, sizeof (Dhcp4ModeData->ClientMacAddress));\r | |
772db4bb | 386 | \r |
387 | Ip = HTONL (DhcpSb->ClientAddr);\r | |
e48e37fc | 388 | CopyMem (&Dhcp4ModeData->ClientAddress, &Ip, sizeof (EFI_IPv4_ADDRESS));\r |
772db4bb | 389 | \r |
390 | Ip = HTONL (DhcpSb->Netmask);\r | |
e48e37fc | 391 | CopyMem (&Dhcp4ModeData->SubnetMask, &Ip, sizeof (EFI_IPv4_ADDRESS));\r |
772db4bb | 392 | \r |
393 | Ip = HTONL (DhcpSb->ServerAddr);\r | |
e48e37fc | 394 | CopyMem (&Dhcp4ModeData->ServerAddress, &Ip, sizeof (EFI_IPv4_ADDRESS));\r |
772db4bb | 395 | \r |
396 | Para = DhcpSb->Para;\r | |
397 | \r | |
398 | if (Para != NULL) {\r | |
399 | Ip = HTONL (Para->Router);\r | |
e48e37fc | 400 | CopyMem (&Dhcp4ModeData->RouterAddress, &Ip, sizeof (EFI_IPv4_ADDRESS));\r |
f9204641 | 401 | Dhcp4ModeData->LeaseTime = Para->Lease;\r |
772db4bb | 402 | } else {\r |
e48e37fc | 403 | ZeroMem (&Dhcp4ModeData->RouterAddress, sizeof (EFI_IPv4_ADDRESS));\r |
f9204641 | 404 | Dhcp4ModeData->LeaseTime = 0xffffffff;\r |
772db4bb | 405 | }\r |
406 | \r | |
407 | Dhcp4ModeData->ReplyPacket = DhcpSb->Selected;\r | |
408 | \r | |
e48e37fc | 409 | gBS->RestoreTPL (OldTpl);\r |
772db4bb | 410 | return EFI_SUCCESS;\r |
411 | }\r | |
412 | \r | |
413 | \r | |
414 | /**\r | |
415 | Free the resource related to the configure parameters.\r | |
416 | DHCP driver will make a copy of the user's configure\r | |
417 | such as the time out value.\r | |
418 | \r | |
419 | @param Config The DHCP configure data\r | |
420 | \r | |
772db4bb | 421 | **/\r |
422 | VOID\r | |
423 | DhcpCleanConfigure (\r | |
f9204641 | 424 | IN OUT EFI_DHCP4_CONFIG_DATA *Config\r |
772db4bb | 425 | )\r |
426 | {\r | |
427 | UINT32 Index;\r | |
428 | \r | |
429 | if (Config->DiscoverTimeout != NULL) {\r | |
e48e37fc | 430 | gBS->FreePool (Config->DiscoverTimeout);\r |
772db4bb | 431 | }\r |
432 | \r | |
433 | if (Config->RequestTimeout != NULL) {\r | |
e48e37fc | 434 | gBS->FreePool (Config->RequestTimeout);\r |
772db4bb | 435 | }\r |
436 | \r | |
437 | if (Config->OptionList != NULL) {\r | |
438 | for (Index = 0; Index < Config->OptionCount; Index++) {\r | |
439 | if (Config->OptionList[Index] != NULL) {\r | |
e48e37fc | 440 | gBS->FreePool (Config->OptionList[Index]);\r |
772db4bb | 441 | }\r |
442 | }\r | |
443 | \r | |
e48e37fc | 444 | gBS->FreePool (Config->OptionList);\r |
772db4bb | 445 | }\r |
446 | \r | |
e48e37fc | 447 | ZeroMem (Config, sizeof (EFI_DHCP4_CONFIG_DATA));\r |
772db4bb | 448 | }\r |
449 | \r | |
450 | \r | |
451 | /**\r | |
452 | Allocate memory for configure parameter such as timeout value for Dst,\r | |
453 | then copy the configure parameter from Src to Dst.\r | |
454 | \r | |
3e8c18da | 455 | @param[out] Dst The destination DHCP configure data.\r |
456 | @param[in] Src The source DHCP configure data.\r | |
772db4bb | 457 | \r |
458 | @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r | |
459 | @retval EFI_SUCCESS The configure is copied.\r | |
460 | \r | |
461 | **/\r | |
462 | EFI_STATUS\r | |
463 | DhcpCopyConfigure (\r | |
f9204641 | 464 | OUT EFI_DHCP4_CONFIG_DATA *Dst,\r |
465 | IN EFI_DHCP4_CONFIG_DATA *Src\r | |
772db4bb | 466 | )\r |
467 | {\r | |
468 | EFI_DHCP4_PACKET_OPTION **DstOptions;\r | |
469 | EFI_DHCP4_PACKET_OPTION **SrcOptions;\r | |
470 | INTN Len;\r | |
471 | UINT32 Index;\r | |
472 | \r | |
72030458 | 473 | CopyMem (Dst, Src, sizeof (*Dst));\r |
772db4bb | 474 | Dst->DiscoverTimeout = NULL;\r |
475 | Dst->RequestTimeout = NULL;\r | |
476 | Dst->OptionList = NULL;\r | |
477 | \r | |
478 | //\r | |
479 | // Allocate a memory then copy DiscoverTimeout to it\r | |
480 | //\r | |
481 | if (Src->DiscoverTimeout != NULL) {\r | |
482 | Len = Src->DiscoverTryCount * sizeof (UINT32);\r | |
e48e37fc | 483 | Dst->DiscoverTimeout = AllocatePool (Len);\r |
772db4bb | 484 | \r |
485 | if (Dst->DiscoverTimeout == NULL) {\r | |
486 | return EFI_OUT_OF_RESOURCES;\r | |
487 | }\r | |
488 | \r | |
489 | for (Index = 0; Index < Src->DiscoverTryCount; Index++) {\r | |
36ee91ca | 490 | Dst->DiscoverTimeout[Index] = MAX (Src->DiscoverTimeout[Index], 1);\r |
772db4bb | 491 | }\r |
492 | }\r | |
493 | \r | |
494 | //\r | |
495 | // Allocate a memory then copy RequestTimeout to it\r | |
496 | //\r | |
497 | if (Src->RequestTimeout != NULL) {\r | |
498 | Len = Src->RequestTryCount * sizeof (UINT32);\r | |
e48e37fc | 499 | Dst->RequestTimeout = AllocatePool (Len);\r |
772db4bb | 500 | \r |
501 | if (Dst->RequestTimeout == NULL) {\r | |
502 | goto ON_ERROR;\r | |
503 | }\r | |
504 | \r | |
505 | for (Index = 0; Index < Src->RequestTryCount; Index++) {\r | |
36ee91ca | 506 | Dst->RequestTimeout[Index] = MAX (Src->RequestTimeout[Index], 1);\r |
772db4bb | 507 | }\r |
508 | }\r | |
509 | \r | |
510 | //\r | |
511 | // Allocate an array of dhcp option point, then allocate memory\r | |
512 | // for each option and copy the source option to it\r | |
513 | //\r | |
514 | if (Src->OptionList != NULL) {\r | |
515 | Len = Src->OptionCount * sizeof (EFI_DHCP4_PACKET_OPTION *);\r | |
e48e37fc | 516 | Dst->OptionList = AllocateZeroPool (Len);\r |
772db4bb | 517 | \r |
518 | if (Dst->OptionList == NULL) {\r | |
519 | goto ON_ERROR;\r | |
520 | }\r | |
521 | \r | |
522 | DstOptions = Dst->OptionList;\r | |
523 | SrcOptions = Src->OptionList;\r | |
524 | \r | |
525 | for (Index = 0; Index < Src->OptionCount; Index++) {\r | |
36ee91ca | 526 | Len = sizeof (EFI_DHCP4_PACKET_OPTION) + MAX (SrcOptions[Index]->Length - 1, 0);\r |
772db4bb | 527 | \r |
e48e37fc | 528 | DstOptions[Index] = AllocatePool (Len);\r |
772db4bb | 529 | \r |
530 | if (DstOptions[Index] == NULL) {\r | |
531 | goto ON_ERROR;\r | |
532 | }\r | |
533 | \r | |
e48e37fc | 534 | CopyMem (DstOptions[Index], SrcOptions[Index], Len);\r |
772db4bb | 535 | }\r |
536 | }\r | |
537 | \r | |
538 | return EFI_SUCCESS;\r | |
539 | \r | |
540 | ON_ERROR:\r | |
541 | DhcpCleanConfigure (Dst);\r | |
542 | return EFI_OUT_OF_RESOURCES;\r | |
543 | }\r | |
544 | \r | |
545 | \r | |
546 | /**\r | |
547 | Give up the control of the DHCP service to let other child\r | |
548 | resume. Don't change the service's DHCP state and the Client\r | |
549 | address and option list configure as required by RFC2131.\r | |
550 | \r | |
551 | @param DhcpSb The DHCP service instance.\r | |
552 | \r | |
772db4bb | 553 | **/\r |
554 | VOID\r | |
555 | DhcpYieldControl (\r | |
556 | IN DHCP_SERVICE *DhcpSb\r | |
557 | )\r | |
558 | {\r | |
559 | EFI_DHCP4_CONFIG_DATA *Config;\r | |
772db4bb | 560 | \r |
772db4bb | 561 | Config = &DhcpSb->ActiveConfig;\r |
562 | \r | |
563 | DhcpSb->ServiceState = DHCP_UNCONFIGED;\r | |
564 | DhcpSb->ActiveChild = NULL;\r | |
565 | \r | |
566 | if (Config->DiscoverTimeout != NULL) {\r | |
e48e37fc | 567 | gBS->FreePool (Config->DiscoverTimeout);\r |
772db4bb | 568 | \r |
569 | Config->DiscoverTryCount = 0;\r | |
570 | Config->DiscoverTimeout = NULL;\r | |
571 | }\r | |
572 | \r | |
573 | if (Config->RequestTimeout != NULL) {\r | |
e48e37fc | 574 | gBS->FreePool (Config->RequestTimeout);\r |
772db4bb | 575 | \r |
576 | Config->RequestTryCount = 0;\r | |
577 | Config->RequestTimeout = NULL;\r | |
578 | }\r | |
579 | \r | |
580 | Config->Dhcp4Callback = NULL;\r | |
581 | Config->CallbackContext = NULL;\r | |
582 | }\r | |
583 | \r | |
584 | \r | |
585 | /**\r | |
f9204641 | 586 | Initializes, changes, or resets the operational settings for the EFI DHCPv4 Protocol driver.\r |
587 | \r | |
588 | The Configure() function is used to initialize, change, or reset the operational\r | |
589 | settings of the EFI DHCPv4 Protocol driver for the communication device on which\r | |
590 | the EFI DHCPv4 Service Binding Protocol is installed. This function can be\r | |
591 | successfully called only if both of the following are true:\r | |
592 | * This instance of the EFI DHCPv4 Protocol driver is in the Dhcp4Stopped, Dhcp4Init,\r | |
593 | Dhcp4InitReboot, or Dhcp4Bound states.\r | |
594 | * No other EFI DHCPv4 Protocol driver instance that is controlled by this EFI\r | |
595 | DHCPv4 Service Binding Protocol driver instance has configured this EFI DHCPv4\r | |
596 | Protocol driver.\r | |
597 | When this driver is in the Dhcp4Stopped state, it can transfer into one of the\r | |
598 | following two possible initial states:\r | |
599 | * Dhcp4Init\r | |
600 | * Dhcp4InitReboot\r | |
601 | The driver can transfer into these states by calling Configure() with a non-NULL\r | |
602 | Dhcp4CfgData. The driver will transfer into the appropriate state based on the\r | |
603 | supplied client network address in the ClientAddress parameter and DHCP options\r | |
604 | in the OptionList parameter as described in RFC 2131.\r | |
605 | When Configure() is called successfully while Dhcp4CfgData is set to NULL, the\r | |
606 | default configuring data will be reset in the EFI DHCPv4 Protocol driver and\r | |
607 | the state of the EFI DHCPv4 Protocol driver will not be changed. If one instance\r | |
608 | wants to make it possible for another instance to configure the EFI DHCPv4 Protocol\r | |
609 | driver, it must call this function with Dhcp4CfgData set to NULL.\r | |
610 | \r | |
3e8c18da | 611 | @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r |
612 | @param[in] Dhcp4CfgData Pointer to the EFI_DHCP4_CONFIG_DATA.\r | |
f9204641 | 613 | \r |
614 | @retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Init or\r | |
615 | Dhcp4InitReboot state, if the original state of this driver\r | |
616 | was Dhcp4Stopped and the value of Dhcp4CfgData was\r | |
617 | not NULL. Otherwise, the state was left unchanged.\r | |
618 | @retval EFI_ACCESS_DENIED This instance of the EFI DHCPv4 Protocol driver was not in the\r | |
619 | Dhcp4Stopped, Dhcp4Init, Dhcp4InitReboot, or Dhcp4Bound state;\r | |
620 | Or onother instance of this EFI DHCPv4 Protocol driver is already\r | |
621 | in a valid configured state.\r | |
622 | @retval EFI_INVALID_PARAMETER Some parameter is NULL.\r | |
623 | @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.\r | |
624 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r | |
772db4bb | 625 | \r |
626 | **/\r | |
772db4bb | 627 | EFI_STATUS\r |
628 | EFIAPI\r | |
629 | EfiDhcp4Configure (\r | |
630 | IN EFI_DHCP4_PROTOCOL *This,\r | |
631 | IN EFI_DHCP4_CONFIG_DATA *Dhcp4CfgData OPTIONAL\r | |
632 | )\r | |
633 | {\r | |
634 | EFI_DHCP4_CONFIG_DATA *Config;\r | |
635 | DHCP_PROTOCOL *Instance;\r | |
636 | DHCP_SERVICE *DhcpSb;\r | |
637 | EFI_STATUS Status;\r | |
638 | EFI_TPL OldTpl;\r | |
639 | UINT32 Index;\r | |
640 | IP4_ADDR Ip;\r | |
641 | \r | |
642 | //\r | |
643 | // First validate the parameters\r | |
644 | //\r | |
645 | if (This == NULL) {\r | |
646 | return EFI_INVALID_PARAMETER;\r | |
647 | }\r | |
648 | \r | |
649 | if (Dhcp4CfgData != NULL) {\r | |
650 | if (Dhcp4CfgData->DiscoverTryCount && (Dhcp4CfgData->DiscoverTimeout == NULL)) {\r | |
651 | return EFI_INVALID_PARAMETER;\r | |
652 | }\r | |
653 | \r | |
654 | if (Dhcp4CfgData->RequestTryCount && (Dhcp4CfgData->RequestTimeout == NULL)) {\r | |
655 | return EFI_INVALID_PARAMETER;\r | |
656 | }\r | |
657 | \r | |
658 | if (Dhcp4CfgData->OptionCount && (Dhcp4CfgData->OptionList == NULL)) {\r | |
659 | return EFI_INVALID_PARAMETER;\r | |
660 | }\r | |
661 | \r | |
e48e37fc | 662 | CopyMem (&Ip, &Dhcp4CfgData->ClientAddress, sizeof (IP4_ADDR));\r |
772db4bb | 663 | \r |
664 | if ((Ip != 0) && !Ip4IsUnicast (NTOHL (Ip), 0)) {\r | |
665 | \r | |
666 | return EFI_INVALID_PARAMETER;\r | |
667 | }\r | |
668 | }\r | |
669 | \r | |
670 | Instance = DHCP_INSTANCE_FROM_THIS (This);\r | |
671 | \r | |
672 | if (Instance->Signature != DHCP_PROTOCOL_SIGNATURE) {\r | |
673 | return EFI_INVALID_PARAMETER;\r | |
674 | }\r | |
675 | \r | |
e48e37fc | 676 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r |
772db4bb | 677 | \r |
678 | DhcpSb = Instance->Service;\r | |
679 | Config = &DhcpSb->ActiveConfig;\r | |
680 | \r | |
681 | Status = EFI_ACCESS_DENIED;\r | |
682 | \r | |
683 | if ((DhcpSb->DhcpState != Dhcp4Stopped) &&\r | |
684 | (DhcpSb->DhcpState != Dhcp4Init) &&\r | |
685 | (DhcpSb->DhcpState != Dhcp4InitReboot) &&\r | |
686 | (DhcpSb->DhcpState != Dhcp4Bound)) {\r | |
687 | \r | |
688 | goto ON_EXIT;\r | |
689 | }\r | |
690 | \r | |
691 | if ((DhcpSb->ActiveChild != NULL) && (DhcpSb->ActiveChild != Instance)) {\r | |
692 | goto ON_EXIT;\r | |
693 | }\r | |
694 | \r | |
695 | if (Dhcp4CfgData != NULL) {\r | |
696 | Status = EFI_OUT_OF_RESOURCES;\r | |
697 | DhcpCleanConfigure (Config);\r | |
698 | \r | |
699 | if (EFI_ERROR (DhcpCopyConfigure (Config, Dhcp4CfgData))) {\r | |
700 | goto ON_EXIT;\r | |
701 | }\r | |
702 | \r | |
703 | DhcpSb->UserOptionLen = 0;\r | |
704 | \r | |
705 | for (Index = 0; Index < Dhcp4CfgData->OptionCount; Index++) {\r | |
706 | DhcpSb->UserOptionLen += Dhcp4CfgData->OptionList[Index]->Length + 2;\r | |
707 | }\r | |
708 | \r | |
709 | DhcpSb->ActiveChild = Instance;\r | |
710 | \r | |
711 | if (DhcpSb->DhcpState == Dhcp4Stopped) {\r | |
712 | DhcpSb->ClientAddr = EFI_NTOHL (Dhcp4CfgData->ClientAddress);\r | |
713 | \r | |
714 | if (DhcpSb->ClientAddr != 0) {\r | |
715 | DhcpSb->DhcpState = Dhcp4InitReboot;\r | |
716 | } else {\r | |
717 | DhcpSb->DhcpState = Dhcp4Init;\r | |
718 | }\r | |
719 | }\r | |
720 | \r | |
721 | DhcpSb->ServiceState = DHCP_CONFIGED;\r | |
722 | Status = EFI_SUCCESS;\r | |
723 | \r | |
724 | } else if (DhcpSb->ActiveChild == Instance) {\r | |
725 | Status = EFI_SUCCESS;\r | |
726 | DhcpYieldControl (DhcpSb);\r | |
727 | }\r | |
728 | \r | |
729 | ON_EXIT:\r | |
e48e37fc | 730 | gBS->RestoreTPL (OldTpl);\r |
772db4bb | 731 | return Status;\r |
732 | }\r | |
733 | \r | |
734 | \r | |
735 | /**\r | |
f9204641 | 736 | Starts the DHCP configuration process.\r |
737 | \r | |
738 | The Start() function starts the DHCP configuration process. This function can\r | |
739 | be called only when the EFI DHCPv4 Protocol driver is in the Dhcp4Init or\r | |
740 | Dhcp4InitReboot state.\r | |
741 | If the DHCP process completes successfully, the state of the EFI DHCPv4 Protocol\r | |
742 | driver will be transferred through Dhcp4Selecting and Dhcp4Requesting to the\r | |
743 | Dhcp4Bound state. The CompletionEvent will then be signaled if it is not NULL.\r | |
744 | If the process aborts, either by the user or by some unexpected network error,\r | |
745 | the state is restored to the Dhcp4Init state. The Start() function can be called\r | |
746 | again to restart the process.\r | |
747 | Refer to RFC 2131 for precise state transitions during this process. At the\r | |
748 | time when each event occurs in this process, the callback function that was set\r | |
749 | by EFI_DHCP4_PROTOCOL.Configure() will be called and the user can take this\r | |
750 | opportunity to control the process.\r | |
751 | \r | |
3e8c18da | 752 | @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r |
753 | @param[in] CompletionEvent If not NULL, indicates the event that will be signaled when the\r | |
754 | EFI DHCPv4 Protocol driver is transferred into the\r | |
755 | Dhcp4Bound state or when the DHCP process is aborted.\r | |
756 | EFI_DHCP4_PROTOCOL.GetModeData() can be called to\r | |
757 | check the completion status. If NULL,\r | |
758 | EFI_DHCP4_PROTOCOL.Start() will wait until the driver\r | |
759 | is transferred into the Dhcp4Bound state or the process fails.\r | |
f9204641 | 760 | \r |
761 | @retval EFI_SUCCESS The DHCP configuration process has started, or it has completed\r | |
762 | when CompletionEvent is NULL.\r | |
763 | @retval EFI_NOT_STARTED The EFI DHCPv4 Protocol driver is in the Dhcp4Stopped\r | |
764 | state. EFI_DHCP4_PROTOCOL. Configure() needs to be called.\r | |
765 | @retval EFI_INVALID_PARAMETER This is NULL.\r | |
766 | @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.\r | |
767 | @retval EFI_TIMEOUT The DHCP configuration process failed because no response was\r | |
768 | received from the server within the specified timeout value.\r | |
769 | @retval EFI_ABORTED The user aborted the DHCP process.\r | |
770 | @retval EFI_ALREADY_STARTED Some other EFI DHCPv4 Protocol instance already started the\r | |
771 | DHCP process.\r | |
772 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r | |
772db4bb | 773 | \r |
774 | **/\r | |
772db4bb | 775 | EFI_STATUS\r |
776 | EFIAPI\r | |
777 | EfiDhcp4Start (\r | |
778 | IN EFI_DHCP4_PROTOCOL *This,\r | |
779 | IN EFI_EVENT CompletionEvent OPTIONAL\r | |
780 | )\r | |
781 | {\r | |
782 | DHCP_PROTOCOL *Instance;\r | |
783 | DHCP_SERVICE *DhcpSb;\r | |
784 | EFI_STATUS Status;\r | |
785 | EFI_TPL OldTpl;\r | |
786 | \r | |
787 | //\r | |
788 | // First validate the parameters\r | |
789 | //\r | |
790 | if (This == NULL) {\r | |
791 | return EFI_INVALID_PARAMETER;\r | |
792 | }\r | |
793 | \r | |
794 | Instance = DHCP_INSTANCE_FROM_THIS (This);\r | |
795 | \r | |
796 | if (Instance->Signature != DHCP_PROTOCOL_SIGNATURE) {\r | |
797 | return EFI_INVALID_PARAMETER;\r | |
798 | }\r | |
799 | \r | |
e48e37fc | 800 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r |
772db4bb | 801 | DhcpSb = Instance->Service;\r |
802 | \r | |
803 | if (DhcpSb->DhcpState == Dhcp4Stopped) {\r | |
804 | Status = EFI_NOT_STARTED;\r | |
805 | goto ON_ERROR;\r | |
806 | }\r | |
807 | \r | |
808 | if ((DhcpSb->DhcpState != Dhcp4Init) && (DhcpSb->DhcpState != Dhcp4InitReboot)) {\r | |
809 | Status = EFI_ALREADY_STARTED;\r | |
810 | goto ON_ERROR;\r | |
811 | }\r | |
812 | \r | |
813 | DhcpSb->IoStatus = EFI_ALREADY_STARTED;\r | |
814 | \r | |
815 | if (EFI_ERROR (Status = DhcpInitRequest (DhcpSb))) {\r | |
816 | goto ON_ERROR;\r | |
817 | }\r | |
818 | \r | |
819 | //\r | |
820 | // Start/Restart the receiving.\r | |
821 | //\r | |
822 | Status = UdpIoRecvDatagram (DhcpSb->UdpIo, DhcpInput, DhcpSb, 0);\r | |
823 | \r | |
824 | if (EFI_ERROR (Status) && (Status != EFI_ALREADY_STARTED)) {\r | |
825 | goto ON_ERROR;\r | |
826 | }\r | |
827 | \r | |
828 | Instance->CompletionEvent = CompletionEvent;\r | |
829 | \r | |
830 | //\r | |
e48e37fc | 831 | // Restore the TPL now, don't call poll function at TPL_CALLBACK.\r |
772db4bb | 832 | //\r |
e48e37fc | 833 | gBS->RestoreTPL (OldTpl);\r |
772db4bb | 834 | \r |
835 | if (CompletionEvent == NULL) {\r | |
836 | while (DhcpSb->IoStatus == EFI_ALREADY_STARTED) {\r | |
837 | DhcpSb->UdpIo->Udp->Poll (DhcpSb->UdpIo->Udp);\r | |
838 | }\r | |
839 | \r | |
840 | return DhcpSb->IoStatus;\r | |
841 | }\r | |
842 | \r | |
843 | return EFI_SUCCESS;\r | |
844 | \r | |
845 | ON_ERROR:\r | |
e48e37fc | 846 | gBS->RestoreTPL (OldTpl);\r |
772db4bb | 847 | return Status;\r |
848 | }\r | |
849 | \r | |
850 | \r | |
851 | /**\r | |
f9204641 | 852 | Extends the lease time by sending a request packet.\r |
853 | \r | |
854 | The RenewRebind() function is used to manually extend the lease time when the\r | |
855 | EFI DHCPv4 Protocol driver is in the Dhcp4Bound state and the lease time has\r | |
856 | not expired yet. This function will send a request packet to the previously\r | |
857 | found server (or to any server when RebindRequest is TRUE) and transfer the\r | |
858 | state into the Dhcp4Renewing state (or Dhcp4Rebinding when RebindingRequest is\r | |
859 | TRUE). When a response is received, the state is returned to Dhcp4Bound.\r | |
860 | If no response is received before the try count is exceeded (the RequestTryCount\r | |
861 | field that is specified in EFI_DHCP4_CONFIG_DATA) but before the lease time that\r | |
862 | was issued by the previous server expires, the driver will return to the Dhcp4Bound\r | |
863 | state and the previous configuration is restored. The outgoing and incoming packets\r | |
864 | can be captured by the EFI_DHCP4_CALLBACK function.\r | |
865 | \r | |
3e8c18da | 866 | @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r |
867 | @param[in] RebindRequest If TRUE, this function broadcasts the request packets and enters\r | |
868 | the Dhcp4Rebinding state. Otherwise, it sends a unicast\r | |
869 | request packet and enters the Dhcp4Renewing state.\r | |
870 | @param[in] CompletionEvent If not NULL, this event is signaled when the renew/rebind phase\r | |
871 | completes or some error occurs.\r | |
872 | EFI_DHCP4_PROTOCOL.GetModeData() can be called to\r | |
873 | check the completion status. If NULL,\r | |
874 | EFI_DHCP4_PROTOCOL.RenewRebind() will busy-wait\r | |
875 | until the DHCP process finishes.\r | |
f9204641 | 876 | \r |
877 | @retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the\r | |
878 | Dhcp4Renewing state or is back to the Dhcp4Bound state.\r | |
879 | @retval EFI_NOT_STARTED The EFI DHCPv4 Protocol driver is in the Dhcp4Stopped\r | |
880 | state. EFI_DHCP4_PROTOCOL.Configure() needs to\r | |
881 | be called.\r | |
882 | @retval EFI_INVALID_PARAMETER This is NULL.\r | |
883 | @retval EFI_TIMEOUT There was no response from the server when the try count was\r | |
884 | exceeded.\r | |
885 | @retval EFI_ACCESS_DENIED The driver is not in the Dhcp4Bound state.\r | |
886 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r | |
772db4bb | 887 | \r |
888 | **/\r | |
772db4bb | 889 | EFI_STATUS\r |
890 | EFIAPI\r | |
891 | EfiDhcp4RenewRebind (\r | |
892 | IN EFI_DHCP4_PROTOCOL *This,\r | |
893 | IN BOOLEAN RebindRequest,\r | |
894 | IN EFI_EVENT CompletionEvent OPTIONAL\r | |
895 | )\r | |
896 | {\r | |
897 | DHCP_PROTOCOL *Instance;\r | |
898 | DHCP_SERVICE *DhcpSb;\r | |
899 | EFI_STATUS Status;\r | |
900 | EFI_TPL OldTpl;\r | |
901 | \r | |
902 | //\r | |
903 | // First validate the parameters\r | |
904 | //\r | |
905 | if (This == NULL) {\r | |
906 | return EFI_INVALID_PARAMETER;\r | |
907 | }\r | |
908 | \r | |
909 | Instance = DHCP_INSTANCE_FROM_THIS (This);\r | |
910 | \r | |
911 | if (Instance->Signature != DHCP_PROTOCOL_SIGNATURE) {\r | |
912 | return EFI_INVALID_PARAMETER;\r | |
913 | }\r | |
914 | \r | |
e48e37fc | 915 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r |
772db4bb | 916 | DhcpSb = Instance->Service;\r |
917 | \r | |
918 | if (DhcpSb->DhcpState == Dhcp4Stopped) {\r | |
919 | Status = EFI_NOT_STARTED;\r | |
920 | goto ON_ERROR;\r | |
921 | }\r | |
922 | \r | |
923 | if (DhcpSb->DhcpState != Dhcp4Bound) {\r | |
924 | Status = EFI_ACCESS_DENIED;\r | |
925 | goto ON_ERROR;\r | |
926 | }\r | |
927 | \r | |
928 | if (DHCP_IS_BOOTP (DhcpSb->Para)) {\r | |
929 | return EFI_SUCCESS;\r | |
930 | }\r | |
931 | \r | |
932 | //\r | |
933 | // Transit the states then send a extra DHCP request\r | |
934 | //\r | |
935 | if (!RebindRequest) {\r | |
936 | DhcpSetState (DhcpSb, Dhcp4Renewing, FALSE);\r | |
937 | } else {\r | |
938 | DhcpSetState (DhcpSb, Dhcp4Rebinding, FALSE);\r | |
939 | }\r | |
940 | \r | |
941 | Status = DhcpSendMessage (\r | |
942 | DhcpSb,\r | |
943 | DhcpSb->Selected,\r | |
944 | DhcpSb->Para,\r | |
945 | DHCP_MSG_REQUEST,\r | |
67a58d0f | 946 | (UINT8 *) "Extra renew/rebind by the application"\r |
772db4bb | 947 | );\r |
948 | \r | |
949 | if (EFI_ERROR (Status)) {\r | |
950 | DhcpSetState (DhcpSb, Dhcp4Bound, FALSE);\r | |
951 | goto ON_ERROR;\r | |
952 | }\r | |
953 | \r | |
954 | DhcpSb->ExtraRefresh = TRUE;\r | |
955 | DhcpSb->IoStatus = EFI_ALREADY_STARTED;\r | |
956 | Instance->RenewRebindEvent = CompletionEvent;\r | |
957 | \r | |
e48e37fc | 958 | gBS->RestoreTPL (OldTpl);\r |
772db4bb | 959 | \r |
960 | if (CompletionEvent == NULL) {\r | |
961 | while (DhcpSb->IoStatus == EFI_ALREADY_STARTED) {\r | |
962 | DhcpSb->UdpIo->Udp->Poll (DhcpSb->UdpIo->Udp);\r | |
963 | }\r | |
964 | \r | |
965 | return DhcpSb->IoStatus;\r | |
966 | }\r | |
967 | \r | |
968 | return EFI_SUCCESS;\r | |
969 | \r | |
970 | ON_ERROR:\r | |
e48e37fc | 971 | gBS->RestoreTPL (OldTpl);\r |
772db4bb | 972 | return Status;\r |
973 | }\r | |
974 | \r | |
975 | \r | |
976 | /**\r | |
f9204641 | 977 | Releases the current address configuration.\r |
978 | \r | |
979 | The Release() function releases the current configured IP address by doing either\r | |
980 | of the following:\r | |
981 | * Sending a DHCPRELEASE packet when the EFI DHCPv4 Protocol driver is in the\r | |
982 | Dhcp4Bound state\r | |
983 | * Setting the previously assigned IP address that was provided with the\r | |
984 | EFI_DHCP4_PROTOCOL.Configure() function to 0.0.0.0 when the driver is in\r | |
985 | Dhcp4InitReboot state\r | |
986 | After a successful call to this function, the EFI DHCPv4 Protocol driver returns\r | |
987 | to the Dhcp4Init state and any subsequent incoming packets will be discarded silently.\r | |
772db4bb | 988 | \r |
3e8c18da | 989 | @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r |
772db4bb | 990 | \r |
f9204641 | 991 | @retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Init phase.\r |
992 | @retval EFI_INVALID_PARAMETER This is NULL.\r | |
993 | @retval EFI_ACCESS_DENIED The EFI DHCPv4 Protocol driver is not Dhcp4InitReboot state.\r | |
994 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r | |
772db4bb | 995 | \r |
996 | **/\r | |
772db4bb | 997 | EFI_STATUS\r |
998 | EFIAPI\r | |
999 | EfiDhcp4Release (\r | |
1000 | IN EFI_DHCP4_PROTOCOL *This\r | |
1001 | )\r | |
1002 | {\r | |
1003 | DHCP_PROTOCOL *Instance;\r | |
1004 | DHCP_SERVICE *DhcpSb;\r | |
1005 | EFI_STATUS Status;\r | |
1006 | EFI_TPL OldTpl;\r | |
1007 | \r | |
1008 | //\r | |
1009 | // First validate the parameters\r | |
1010 | //\r | |
1011 | if (This == NULL) {\r | |
1012 | return EFI_INVALID_PARAMETER;\r | |
1013 | }\r | |
1014 | \r | |
1015 | Instance = DHCP_INSTANCE_FROM_THIS (This);\r | |
1016 | \r | |
1017 | if (Instance->Signature != DHCP_PROTOCOL_SIGNATURE) {\r | |
1018 | return EFI_INVALID_PARAMETER;\r | |
1019 | }\r | |
1020 | \r | |
1021 | Status = EFI_SUCCESS;\r | |
e48e37fc | 1022 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r |
772db4bb | 1023 | DhcpSb = Instance->Service;\r |
1024 | \r | |
1025 | if ((DhcpSb->DhcpState != Dhcp4InitReboot) && (DhcpSb->DhcpState != Dhcp4Bound)) {\r | |
1026 | Status = EFI_ACCESS_DENIED;\r | |
1027 | goto ON_EXIT;\r | |
1028 | }\r | |
1029 | \r | |
1030 | if (!DHCP_IS_BOOTP (DhcpSb->Para) && (DhcpSb->DhcpState == Dhcp4Bound)) {\r | |
1031 | Status = DhcpSendMessage (\r | |
1032 | DhcpSb,\r | |
1033 | DhcpSb->Selected,\r | |
1034 | DhcpSb->Para,\r | |
1035 | DHCP_MSG_RELEASE,\r | |
1036 | NULL\r | |
1037 | );\r | |
1038 | \r | |
1039 | if (EFI_ERROR (Status)) {\r | |
1040 | Status = EFI_DEVICE_ERROR;\r | |
1041 | goto ON_EXIT;\r | |
1042 | }\r | |
1043 | }\r | |
1044 | \r | |
1045 | DhcpCleanLease (DhcpSb);\r | |
1046 | \r | |
1047 | ON_EXIT:\r | |
e48e37fc | 1048 | gBS->RestoreTPL (OldTpl);\r |
772db4bb | 1049 | return Status;\r |
1050 | }\r | |
1051 | \r | |
1052 | \r | |
1053 | /**\r | |
f9204641 | 1054 | Stops the current address configuration.\r |
1055 | \r | |
1056 | The Stop() function is used to stop the DHCP configuration process. After this\r | |
1057 | function is called successfully, the EFI DHCPv4 Protocol driver is transferred\r | |
1058 | into the Dhcp4Stopped state. EFI_DHCP4_PROTOCOL.Configure() needs to be called\r | |
1059 | before DHCP configuration process can be started again. This function can be\r | |
1060 | called when the EFI DHCPv4 Protocol driver is in any state.\r | |
772db4bb | 1061 | \r |
3e8c18da | 1062 | @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r |
772db4bb | 1063 | \r |
f9204641 | 1064 | @retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Stopped phase.\r |
1065 | @retval EFI_INVALID_PARAMETER This is NULL.\r | |
772db4bb | 1066 | \r |
1067 | **/\r | |
772db4bb | 1068 | EFI_STATUS\r |
1069 | EFIAPI\r | |
1070 | EfiDhcp4Stop (\r | |
1071 | IN EFI_DHCP4_PROTOCOL *This\r | |
1072 | )\r | |
1073 | {\r | |
1074 | DHCP_PROTOCOL *Instance;\r | |
1075 | DHCP_SERVICE *DhcpSb;\r | |
1076 | EFI_TPL OldTpl;\r | |
1077 | \r | |
1078 | //\r | |
1079 | // First validate the parameters\r | |
1080 | //\r | |
1081 | if (This == NULL) {\r | |
1082 | return EFI_INVALID_PARAMETER;\r | |
1083 | }\r | |
1084 | \r | |
1085 | Instance = DHCP_INSTANCE_FROM_THIS (This);\r | |
1086 | \r | |
1087 | if (Instance->Signature != DHCP_PROTOCOL_SIGNATURE) {\r | |
1088 | return EFI_INVALID_PARAMETER;\r | |
1089 | }\r | |
1090 | \r | |
e48e37fc | 1091 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r |
772db4bb | 1092 | DhcpSb = Instance->Service;\r |
1093 | \r | |
1094 | DhcpCleanLease (DhcpSb);\r | |
1095 | \r | |
1096 | DhcpSb->DhcpState = Dhcp4Stopped;\r | |
1097 | DhcpSb->ServiceState = DHCP_UNCONFIGED;\r | |
1098 | \r | |
e48e37fc | 1099 | gBS->RestoreTPL (OldTpl);\r |
772db4bb | 1100 | return EFI_SUCCESS;\r |
1101 | }\r | |
1102 | \r | |
1103 | \r | |
1104 | /**\r | |
f9204641 | 1105 | Builds a DHCP packet, given the options to be appended or deleted or replaced.\r |
1106 | \r | |
1107 | The Build() function is used to assemble a new packet from the original packet\r | |
1108 | by replacing or deleting existing options or appending new options. This function\r | |
1109 | does not change any state of the EFI DHCPv4 Protocol driver and can be used at\r | |
1110 | any time.\r | |
1111 | \r | |
3e8c18da | 1112 | @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r |
1113 | @param[in] SeedPacket Initial packet to be used as a base for building new packet.\r | |
1114 | @param[in] DeleteCount Number of opcodes in the DeleteList.\r | |
1115 | @param[in] DeleteList List of opcodes to be deleted from the seed packet.\r | |
1116 | Ignored if DeleteCount is zero.\r | |
1117 | @param[in] AppendCount Number of entries in the OptionList.\r | |
1118 | @param[in] AppendList Pointer to a DHCP option list to be appended to SeedPacket.\r | |
1119 | If SeedPacket also contains options in this list, they are\r | |
1120 | replaced by new options (except pad option). Ignored if\r | |
1121 | AppendCount is zero. Type EFI_DHCP4_PACKET_OPTION\r | |
1122 | @param[out] NewPacket Pointer to storage for the pointer to the new allocated packet.\r | |
1123 | Use the EFI Boot Service FreePool() on the resulting pointer\r | |
1124 | when done with the packet.\r | |
f9204641 | 1125 | \r |
1126 | @retval EFI_SUCCESS The new packet was built.\r | |
1127 | @retval EFI_OUT_OF_RESOURCES Storage for the new packet could not be allocated.\r | |
1128 | @retval EFI_INVALID_PARAMETER Some parameter is NULL.\r | |
772db4bb | 1129 | \r |
1130 | **/\r | |
772db4bb | 1131 | EFI_STATUS\r |
1132 | EFIAPI\r | |
1133 | EfiDhcp4Build (\r | |
1134 | IN EFI_DHCP4_PROTOCOL *This,\r | |
1135 | IN EFI_DHCP4_PACKET *SeedPacket,\r | |
1136 | IN UINT32 DeleteCount,\r | |
1137 | IN UINT8 *DeleteList OPTIONAL,\r | |
1138 | IN UINT32 AppendCount,\r | |
1139 | IN EFI_DHCP4_PACKET_OPTION *AppendList[] OPTIONAL,\r | |
1140 | OUT EFI_DHCP4_PACKET **NewPacket\r | |
1141 | )\r | |
1142 | {\r | |
1143 | //\r | |
1144 | // First validate the parameters\r | |
1145 | //\r | |
1146 | if ((This == NULL) || (NewPacket == NULL)) {\r | |
1147 | return EFI_INVALID_PARAMETER;\r | |
1148 | }\r | |
1149 | \r | |
1150 | if ((SeedPacket == NULL) || (SeedPacket->Dhcp4.Magik != DHCP_OPTION_MAGIC) ||\r | |
1151 | EFI_ERROR (DhcpValidateOptions (SeedPacket, NULL))) {\r | |
1152 | \r | |
1153 | return EFI_INVALID_PARAMETER;\r | |
1154 | }\r | |
1155 | \r | |
1156 | if (((DeleteCount == 0) && (AppendCount == 0)) ||\r | |
1157 | ((DeleteCount != 0) && (DeleteList == NULL)) ||\r | |
1158 | ((AppendCount != 0) && (AppendList == NULL))) {\r | |
1159 | \r | |
1160 | return EFI_INVALID_PARAMETER;\r | |
1161 | }\r | |
1162 | \r | |
1163 | return DhcpBuild (\r | |
1164 | SeedPacket,\r | |
1165 | DeleteCount,\r | |
1166 | DeleteList,\r | |
1167 | AppendCount,\r | |
1168 | AppendList,\r | |
1169 | NewPacket\r | |
1170 | );\r | |
1171 | }\r | |
1172 | \r | |
f9204641 | 1173 | /**\r |
1174 | Callback by UdpIoCreatePort() when creating UdpIo for this Dhcp4 instance.\r | |
1175 | \r | |
3e8c18da | 1176 | @param[in] UdpIo The UdpIo being created.\r |
1177 | @param[in] Context Dhcp4 instance.\r | |
f9204641 | 1178 | \r |
1179 | @retval EFI_SUCCESS UdpIo is configured successfully.\r | |
1180 | @retval other Other error occurs.\r | |
1181 | **/\r | |
c4a62a12 | 1182 | EFI_STATUS\r |
1183 | Dhcp4InstanceConfigUdpIo (\r | |
1184 | IN UDP_IO_PORT *UdpIo,\r | |
1185 | IN VOID *Context\r | |
1186 | )\r | |
1187 | {\r | |
1188 | DHCP_PROTOCOL *Instance;\r | |
1189 | DHCP_SERVICE *DhcpSb;\r | |
1190 | EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN *Token;\r | |
1191 | EFI_UDP4_CONFIG_DATA UdpConfigData;\r | |
1192 | IP4_ADDR Ip;\r | |
1193 | \r | |
1194 | Instance = (DHCP_PROTOCOL *) Context;\r | |
1195 | DhcpSb = Instance->Service;\r | |
1196 | Token = Instance->Token;\r | |
1197 | \r | |
e48e37fc | 1198 | ZeroMem (&UdpConfigData, sizeof (EFI_UDP4_CONFIG_DATA));\r |
c4a62a12 | 1199 | \r |
1200 | UdpConfigData.AcceptBroadcast = TRUE;\r | |
1201 | UdpConfigData.AllowDuplicatePort = TRUE;\r | |
1202 | UdpConfigData.TimeToLive = 64;\r | |
1203 | UdpConfigData.DoNotFragment = TRUE;\r | |
1204 | \r | |
1205 | Ip = HTONL (DhcpSb->ClientAddr);\r | |
e48e37fc | 1206 | CopyMem (&UdpConfigData.StationAddress, &Ip, sizeof (EFI_IPv4_ADDRESS));\r |
c4a62a12 | 1207 | \r |
1208 | Ip = HTONL (DhcpSb->Netmask);\r | |
e48e37fc | 1209 | CopyMem (&UdpConfigData.SubnetMask, &Ip, sizeof (EFI_IPv4_ADDRESS));\r |
c4a62a12 | 1210 | \r |
1211 | if ((Token->ListenPointCount == 0) || (Token->ListenPoints[0].ListenPort == 0)) {\r | |
1212 | UdpConfigData.StationPort = DHCP_CLIENT_PORT;\r | |
1213 | } else {\r | |
1214 | UdpConfigData.StationPort = Token->ListenPoints[0].ListenPort;\r | |
1215 | }\r | |
1216 | \r | |
1217 | return UdpIo->Udp->Configure (UdpIo->Udp, &UdpConfigData);\r | |
1218 | }\r | |
1219 | \r | |
f9204641 | 1220 | /**\r |
1221 | Create UdpIo for this Dhcp4 instance.\r | |
1222 | \r | |
1223 | @param Instance The Dhcp4 instance.\r | |
1224 | \r | |
1225 | @retval EFI_SUCCESS UdpIo is created successfully.\r | |
1226 | @retval EFI_OUT_OF_RESOURCES Fails to create UdpIo because of limited\r | |
1227 | resources or configuration failure.\r | |
1228 | **/\r | |
c4a62a12 | 1229 | EFI_STATUS\r |
1230 | Dhcp4InstanceCreateUdpIo (\r | |
f9204641 | 1231 | IN OUT DHCP_PROTOCOL *Instance\r |
c4a62a12 | 1232 | )\r |
1233 | {\r | |
1234 | DHCP_SERVICE *DhcpSb;\r | |
1235 | \r | |
1236 | ASSERT (Instance->Token != NULL);\r | |
1237 | \r | |
1238 | DhcpSb = Instance->Service;\r | |
1239 | Instance->UdpIo = UdpIoCreatePort (DhcpSb->Controller, DhcpSb->Image, Dhcp4InstanceConfigUdpIo, Instance);\r | |
1240 | if (Instance->UdpIo == NULL) {\r | |
1241 | return EFI_OUT_OF_RESOURCES;\r | |
1242 | } else {\r | |
1243 | return EFI_SUCCESS;\r | |
1244 | }\r | |
1245 | }\r | |
1246 | \r | |
f9204641 | 1247 | /**\r |
1248 | Callback of Dhcp packet. Does nothing.\r | |
1249 | \r | |
1250 | @param Arg The context.\r | |
3e8c18da | 1251 | \r |
f9204641 | 1252 | **/\r |
c4a62a12 | 1253 | VOID\r |
1254 | DhcpDummyExtFree (\r | |
1255 | IN VOID *Arg\r | |
1256 | )\r | |
982a9eae | 1257 | {\r |
c4a62a12 | 1258 | }\r |
1259 | \r | |
f9204641 | 1260 | /**\r |
1261 | Callback of UdpIoRecvDatagram() that handles a Dhcp4 packet.\r | |
1262 | \r | |
1263 | Only BOOTP responses will be handled that correspond to the Xid of the request\r | |
1264 | sent out. The packet will be queued to the response queue.\r | |
1265 | \r | |
1266 | @param UdpPacket The Dhcp4 packet.\r | |
1267 | @param Points Udp4 address pair.\r | |
1268 | @param IoStatus Status of the input.\r | |
1269 | @param Context Extra info for the input.\r | |
1270 | \r | |
f9204641 | 1271 | **/\r |
c4a62a12 | 1272 | VOID\r |
1273 | PxeDhcpInput (\r | |
1274 | NET_BUF *UdpPacket,\r | |
1275 | UDP_POINTS *Points,\r | |
1276 | EFI_STATUS IoStatus,\r | |
1277 | VOID *Context\r | |
1278 | )\r | |
1279 | {\r | |
1280 | DHCP_PROTOCOL *Instance;\r | |
1281 | DHCP_SERVICE *DhcpSb;\r | |
1282 | EFI_DHCP4_HEADER *Head;\r | |
1283 | NET_BUF *Wrap;\r | |
1284 | EFI_DHCP4_PACKET *Packet;\r | |
1285 | EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN *Token;\r | |
1286 | UINT32 Len;\r | |
1287 | EFI_STATUS Status;\r | |
1288 | \r | |
1289 | Wrap = NULL;\r | |
1290 | Instance = (DHCP_PROTOCOL *) Context;\r | |
1291 | Token = Instance->Token;\r | |
1292 | DhcpSb = Instance->Service;\r | |
1293 | \r | |
1294 | //\r | |
f9204641 | 1295 | // Don't restart receive if error occurs or DHCP is destroyed.\r |
c4a62a12 | 1296 | //\r |
1297 | if (EFI_ERROR (IoStatus)) {\r | |
1298 | return ;\r | |
1299 | }\r | |
1300 | \r | |
1301 | ASSERT (UdpPacket != NULL);\r | |
982a9eae | 1302 | \r |
c4a62a12 | 1303 | //\r |
1304 | // Validate the packet received\r | |
1305 | //\r | |
1306 | if (UdpPacket->TotalSize < sizeof (EFI_DHCP4_HEADER)) {\r | |
1307 | goto RESTART;\r | |
1308 | }\r | |
982a9eae | 1309 | \r |
c4a62a12 | 1310 | //\r |
1311 | // Copy the DHCP message to a continuous memory block, make the buffer size\r | |
1312 | // of the EFI_DHCP4_PACKET a multiple of 4-byte.\r | |
1313 | //\r | |
1314 | Len = NET_ROUNDUP (sizeof (EFI_DHCP4_PACKET) + UdpPacket->TotalSize - sizeof (EFI_DHCP4_HEADER), 4);\r | |
1315 | Wrap = NetbufAlloc (Len);\r | |
c4a62a12 | 1316 | if (Wrap == NULL) {\r |
1317 | goto RESTART;\r | |
1318 | }\r | |
1319 | \r | |
1320 | Packet = (EFI_DHCP4_PACKET *) NetbufAllocSpace (Wrap, Len, NET_BUF_TAIL);\r | |
894d038a | 1321 | ASSERT (Packet != NULL);\r |
1322 | \r | |
c4a62a12 | 1323 | Packet->Size = Len;\r |
1324 | Head = &Packet->Dhcp4.Header;\r | |
1325 | Packet->Length = NetbufCopy (UdpPacket, 0, UdpPacket->TotalSize, (UINT8 *) Head);\r | |
1326 | \r | |
1327 | if (Packet->Length != UdpPacket->TotalSize) {\r | |
1328 | goto RESTART;\r | |
1329 | }\r | |
982a9eae | 1330 | \r |
c4a62a12 | 1331 | //\r |
1332 | // Is this packet the answer to our packet?\r | |
1333 | //\r | |
1334 | if ((Head->OpCode != BOOTP_REPLY) ||\r | |
1335 | (Head->Xid != Token->Packet->Dhcp4.Header.Xid) ||\r | |
982a9eae | 1336 | (CompareMem (DhcpSb->ClientAddressSendOut, Head->ClientHwAddr, Head->HwAddrLen) != 0)) {\r |
c4a62a12 | 1337 | goto RESTART;\r |
1338 | }\r | |
982a9eae | 1339 | \r |
c4a62a12 | 1340 | //\r |
1341 | // Validate the options and retrieve the interested options\r | |
1342 | //\r | |
1343 | if ((Packet->Length > sizeof (EFI_DHCP4_HEADER) + sizeof (UINT32)) &&\r | |
1344 | (Packet->Dhcp4.Magik == DHCP_OPTION_MAGIC) &&\r | |
1345 | EFI_ERROR (DhcpValidateOptions (Packet, NULL))) {\r | |
1346 | \r | |
1347 | goto RESTART;\r | |
1348 | }\r | |
1349 | \r | |
1350 | //\r | |
1351 | // Keep this packet in the ResponseQueue.\r | |
1352 | //\r | |
1353 | NET_GET_REF (Wrap);\r | |
1354 | NetbufQueAppend (&Instance->ResponseQueue, Wrap);\r | |
1355 | \r | |
1356 | RESTART:\r | |
1357 | \r | |
1358 | NetbufFree (UdpPacket);\r | |
1359 | \r | |
1360 | if (Wrap != NULL) {\r | |
1361 | NetbufFree (Wrap);\r | |
1362 | }\r | |
1363 | \r | |
1364 | Status = UdpIoRecvDatagram (Instance->UdpIo, PxeDhcpInput, Instance, 0);\r | |
1365 | if (EFI_ERROR (Status)) {\r | |
1366 | PxeDhcpDone (Instance);\r | |
1367 | }\r | |
1368 | }\r | |
1369 | \r | |
f9204641 | 1370 | /**\r |
1371 | Complete a Dhcp4 transaction and signal the upper layer.\r | |
1372 | \r | |
1373 | @param Instance Dhcp4 instance.\r | |
f9204641 | 1374 | \r |
1375 | **/\r | |
c4a62a12 | 1376 | VOID\r |
1377 | PxeDhcpDone (\r | |
1378 | IN DHCP_PROTOCOL *Instance\r | |
1379 | )\r | |
1380 | {\r | |
1381 | EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN *Token;\r | |
1382 | \r | |
1383 | Token = Instance->Token;\r | |
1384 | \r | |
1385 | Token->ResponseCount = Instance->ResponseQueue.BufNum;\r | |
1386 | if (Token->ResponseCount != 0) {\r | |
e48e37fc | 1387 | Token->ResponseList = (EFI_DHCP4_PACKET *) AllocatePool (Instance->ResponseQueue.BufSize);\r |
c4a62a12 | 1388 | if (Token->ResponseList == NULL) {\r |
1389 | Token->Status = EFI_OUT_OF_RESOURCES;\r | |
1390 | goto SIGNAL_USER;\r | |
1391 | }\r | |
1392 | \r | |
1393 | //\r | |
f9204641 | 1394 | // Copy the received DHCP responses.\r |
c4a62a12 | 1395 | //\r |
1396 | NetbufQueCopy (&Instance->ResponseQueue, 0, Instance->ResponseQueue.BufSize, (UINT8 *) Token->ResponseList);\r | |
1397 | Token->Status = EFI_SUCCESS;\r | |
1398 | } else {\r | |
1399 | Token->ResponseList = NULL;\r | |
1400 | Token->Status = EFI_TIMEOUT;\r | |
1401 | }\r | |
1402 | \r | |
1403 | SIGNAL_USER:\r | |
1404 | //\r | |
f9204641 | 1405 | // Clean up the resources dedicated for this transmit receive transaction.\r |
c4a62a12 | 1406 | //\r |
1407 | NetbufQueFlush (&Instance->ResponseQueue);\r | |
1408 | UdpIoCleanPort (Instance->UdpIo);\r | |
1409 | UdpIoFreePort (Instance->UdpIo);\r | |
1410 | Instance->UdpIo = NULL;\r | |
1411 | Instance->Token = NULL;\r | |
1412 | \r | |
1413 | if (Token->CompletionEvent != NULL) {\r | |
1414 | gBS->SignalEvent (Token->CompletionEvent);\r | |
982a9eae | 1415 | }\r |
c4a62a12 | 1416 | }\r |
1417 | \r | |
772db4bb | 1418 | \r |
1419 | /**\r | |
ba39e316 | 1420 | Transmits a DHCP formatted packet and optionally waits for responses.\r |
f9204641 | 1421 | \r |
1422 | The TransmitReceive() function is used to transmit a DHCP packet and optionally\r | |
1423 | wait for the response from servers. This function does not change the state of\r | |
1424 | the EFI DHCPv4 Protocol driver and thus can be used at any time.\r | |
ba39e316 | 1425 | \r |
3e8c18da | 1426 | @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r |
1427 | @param[in] Token Pointer to the EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN structure.\r | |
ba39e316 | 1428 | \r |
1429 | @retval EFI_SUCCESS The packet was successfully queued for transmission.\r | |
1430 | @retval EFI_INVALID_PARAMETER Some parameter is NULL.\r | |
1431 | @retval EFI_NOT_READY The previous call to this function has not finished yet. Try to call\r | |
1432 | this function after collection process completes.\r | |
1433 | @retval EFI_NO_MAPPING The default station address is not available yet.\r | |
1434 | @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.\r | |
1435 | @retval Others Some other unexpected error occurred.\r | |
772db4bb | 1436 | \r |
1437 | **/\r | |
772db4bb | 1438 | EFI_STATUS\r |
1439 | EFIAPI\r | |
1440 | EfiDhcp4TransmitReceive (\r | |
1441 | IN EFI_DHCP4_PROTOCOL *This,\r | |
1442 | IN EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN *Token\r | |
1443 | )\r | |
1444 | {\r | |
c4a62a12 | 1445 | DHCP_PROTOCOL *Instance;\r |
1446 | EFI_TPL OldTpl;\r | |
1447 | EFI_STATUS Status;\r | |
1448 | NET_FRAGMENT Frag;\r | |
1449 | NET_BUF *Wrap;\r | |
1450 | UDP_POINTS EndPoint;\r | |
1451 | IP4_ADDR Ip;\r | |
1452 | DHCP_SERVICE *DhcpSb;\r | |
1453 | IP4_ADDR Gateway;\r | |
1454 | IP4_ADDR SubnetMask;\r | |
1455 | \r | |
1456 | if ((This == NULL) || (Token == NULL) || (Token->Packet == NULL)) {\r | |
1457 | return EFI_INVALID_PARAMETER;\r | |
1458 | }\r | |
1459 | \r | |
1460 | Instance = DHCP_INSTANCE_FROM_THIS (This);\r | |
1461 | DhcpSb = Instance->Service;\r | |
1462 | \r | |
1463 | if (Instance->Token != NULL) {\r | |
1464 | //\r | |
1465 | // The previous call to TransmitReceive is not finished.\r | |
1466 | //\r | |
1467 | return EFI_NOT_READY;\r | |
1468 | }\r | |
1469 | \r | |
f9204641 | 1470 | if ((Token->Packet->Dhcp4.Magik != DHCP_OPTION_MAGIC) ||\r |
1471 | (NTOHL (Token->Packet->Dhcp4.Header.Xid) == Instance->Service->Xid) ||\r | |
1472 | (Token->TimeoutValue == 0) ||\r | |
1473 | ((Token->ListenPointCount != 0) && (Token->ListenPoints == NULL)) ||\r | |
1474 | EFI_ERROR (DhcpValidateOptions (Token->Packet, NULL)) ||\r | |
1475 | EFI_IP4_EQUAL (&Token->RemoteAddress, &mZeroIp4Addr)\r | |
1476 | ) {\r | |
c4a62a12 | 1477 | //\r |
f9204641 | 1478 | // The DHCP packet isn't well-formed, the Transaction ID is already used,\r |
1479 | // the timeout value is zero, the ListenPoint is invalid, or the\r | |
1480 | // RemoteAddress is zero.\r | |
c4a62a12 | 1481 | //\r |
1482 | return EFI_INVALID_PARAMETER;\r | |
1483 | }\r | |
1484 | \r | |
1485 | if (DhcpSb->ClientAddr == 0) {\r | |
1486 | \r | |
1487 | return EFI_NO_MAPPING;\r | |
1488 | }\r | |
1489 | \r | |
e48e37fc | 1490 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r |
c4a62a12 | 1491 | \r |
1492 | //\r | |
1493 | // Save the token and the timeout value.\r | |
1494 | //\r | |
1495 | Instance->Token = Token;\r | |
1496 | Instance->Timeout = Token->TimeoutValue;\r | |
1497 | \r | |
1498 | //\r | |
1499 | // Create a UDP IO for this transmit receive transaction.\r | |
1500 | //\r | |
1501 | Status = Dhcp4InstanceCreateUdpIo (Instance);\r | |
1502 | if (EFI_ERROR (Status)) {\r | |
1503 | goto ON_ERROR;\r | |
1504 | }\r | |
1505 | \r | |
982a9eae | 1506 | //\r |
1507 | // Save the Client Address is sent out\r | |
1508 | //\r | |
f9204641 | 1509 | CopyMem (\r |
1510 | &DhcpSb->ClientAddressSendOut[0],\r | |
1511 | &Token->Packet->Dhcp4.Header.ClientHwAddr[0],\r | |
1512 | Token->Packet->Dhcp4.Header.HwAddrLen\r | |
1513 | );\r | |
982a9eae | 1514 | \r |
772db4bb | 1515 | //\r |
c4a62a12 | 1516 | // Wrap the DHCP packet into a net buffer.\r |
772db4bb | 1517 | //\r |
c4a62a12 | 1518 | Frag.Bulk = (UINT8 *) &Token->Packet->Dhcp4;\r |
1519 | Frag.Len = Token->Packet->Length;\r | |
1520 | Wrap = NetbufFromExt (&Frag, 1, 0, 0, DhcpDummyExtFree, NULL);\r | |
1521 | if (Wrap == NULL) {\r | |
1522 | Status = EFI_OUT_OF_RESOURCES;\r | |
1523 | goto ON_ERROR;\r | |
1524 | }\r | |
1525 | \r | |
1526 | //\r | |
1527 | // Set the local address and local port.\r | |
1528 | //\r | |
1529 | EndPoint.LocalAddr = 0;\r | |
1530 | EndPoint.LocalPort = 0;\r | |
1531 | \r | |
1532 | //\r | |
1533 | // Set the destination address and destination port.\r | |
1534 | //\r | |
e48e37fc | 1535 | CopyMem (&Ip, &Token->RemoteAddress, sizeof (EFI_IPv4_ADDRESS));\r |
c4a62a12 | 1536 | EndPoint.RemoteAddr = NTOHL (Ip);\r |
1537 | \r | |
1538 | if (Token->RemotePort == 0) {\r | |
1539 | EndPoint.RemotePort = DHCP_SERVER_PORT;\r | |
1540 | } else {\r | |
1541 | EndPoint.RemotePort = Token->RemotePort;\r | |
1542 | }\r | |
1543 | \r | |
1544 | //\r | |
1545 | // Get the gateway.\r | |
1546 | //\r | |
1547 | SubnetMask = DhcpSb->Netmask;\r | |
1548 | Gateway = 0;\r | |
1549 | if (!IP4_NET_EQUAL (DhcpSb->ClientAddr, EndPoint.RemoteAddr, SubnetMask)) {\r | |
e48e37fc | 1550 | CopyMem (&Gateway, &Token->GatewayAddress, sizeof (EFI_IPv4_ADDRESS));\r |
c4a62a12 | 1551 | Gateway = NTOHL (Gateway);\r |
1552 | }\r | |
1553 | \r | |
1554 | //\r | |
1555 | // Transmit the DHCP packet.\r | |
1556 | //\r | |
1557 | Status = UdpIoSendDatagram (Instance->UdpIo, Wrap, &EndPoint, Gateway, DhcpOnPacketSent, NULL);\r | |
1558 | if (EFI_ERROR (Status)) {\r | |
1559 | NetbufFree (Wrap);\r | |
1560 | goto ON_ERROR;\r | |
1561 | }\r | |
1562 | \r | |
1563 | //\r | |
1564 | // Start to receive the DHCP response.\r | |
1565 | //\r | |
1566 | Status = UdpIoRecvDatagram (Instance->UdpIo, PxeDhcpInput, Instance, 0);\r | |
1567 | if (EFI_ERROR (Status)) {\r | |
1568 | goto ON_ERROR;\r | |
1569 | }\r | |
1570 | \r | |
1571 | ON_ERROR:\r | |
1572 | \r | |
1573 | if (EFI_ERROR (Status) && (Instance->UdpIo != NULL)) {\r | |
1574 | UdpIoCleanPort (Instance->UdpIo);\r | |
1575 | UdpIoFreePort (Instance->UdpIo);\r | |
1576 | Instance->UdpIo = NULL;\r | |
1577 | Instance->Token = NULL;\r | |
1578 | }\r | |
1579 | \r | |
e48e37fc | 1580 | gBS->RestoreTPL (OldTpl);\r |
c4a62a12 | 1581 | \r |
1582 | if (!EFI_ERROR (Status) && (Token->CompletionEvent == NULL)) {\r | |
1583 | //\r | |
1584 | // Keep polling until timeout if no error happens and the CompletionEvent\r | |
1585 | // is NULL.\r | |
1586 | //\r | |
1587 | while (Instance->Timeout != 0) {\r | |
1588 | Instance->UdpIo->Udp->Poll (Instance->UdpIo->Udp);\r | |
1589 | }\r | |
1590 | }\r | |
1591 | \r | |
1592 | return Status;\r | |
772db4bb | 1593 | }\r |
1594 | \r | |
1595 | \r | |
1596 | /**\r | |
1597 | Callback function for DhcpIterateOptions. This callback sets the\r | |
1598 | EFI_DHCP4_PACKET_OPTION array in the DHCP_PARSE_CONTEXT to point\r | |
1599 | the individual DHCP option in the packet.\r | |
1600 | \r | |
3e8c18da | 1601 | @param[in] Tag The DHCP option type\r |
1602 | @param[in] Len Length of the DHCP option data\r | |
1603 | @param[in] Data The DHCP option data\r | |
1604 | @param[in] Context The context, to pass several parameters in.\r | |
772db4bb | 1605 | \r |
1606 | @retval EFI_SUCCESS It always returns EFI_SUCCESS\r | |
1607 | \r | |
1608 | **/\r | |
772db4bb | 1609 | EFI_STATUS\r |
1610 | Dhcp4ParseCheckOption (\r | |
1611 | IN UINT8 Tag,\r | |
1612 | IN UINT8 Len,\r | |
1613 | IN UINT8 *Data,\r | |
1614 | IN VOID *Context\r | |
1615 | )\r | |
1616 | {\r | |
1617 | DHCP_PARSE_CONTEXT *Parse;\r | |
1618 | \r | |
1619 | Parse = (DHCP_PARSE_CONTEXT *) Context;\r | |
1620 | Parse->Index++;\r | |
1621 | \r | |
36ee91ca | 1622 | if (Parse->Index <= Parse->OptionCount) {\r |
772db4bb | 1623 | //\r |
50d7ebad | 1624 | // Use BASE_CR to get the memory position of EFI_DHCP4_PACKET_OPTION for\r |
772db4bb | 1625 | // the EFI_DHCP4_PACKET_OPTION->Data because DhcpIterateOptions only\r |
1626 | // pass in the point to option data.\r | |
1627 | //\r | |
50d7ebad | 1628 | Parse->Option[Parse->Index - 1] = BASE_CR (Data, EFI_DHCP4_PACKET_OPTION, Data);\r |
772db4bb | 1629 | }\r |
1630 | \r | |
1631 | return EFI_SUCCESS;\r | |
1632 | }\r | |
1633 | \r | |
1634 | \r | |
1635 | /**\r | |
f9204641 | 1636 | Parses the packed DHCP option data.\r |
1637 | \r | |
1638 | The Parse() function is used to retrieve the option list from a DHCP packet.\r | |
51195fbe | 1639 | If *OptionCount isn't zero, and there is enough space for all the DHCP options\r |
f9204641 | 1640 | in the Packet, each element of PacketOptionList is set to point to somewhere in\r |
1641 | the Packet->Dhcp4.Option where a new DHCP option begins. If RFC3396 is supported,\r | |
1642 | the caller should reassemble the parsed DHCP options to get the finial result.\r | |
51195fbe | 1643 | If *OptionCount is zero or there isn't enough space for all of them, the number\r |
f9204641 | 1644 | of DHCP options in the Packet is returned in OptionCount.\r |
1645 | \r | |
1646 | @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r | |
1647 | @param Packet Pointer to packet to be parsed.\r | |
1648 | @param OptionCount On input, the number of entries in the PacketOptionList.\r | |
1649 | On output, the number of entries that were written into the\r | |
1650 | PacketOptionList.\r | |
1651 | @param PacketOptionList List of packet option entries to be filled in. End option or pad\r | |
1652 | options are not included.\r | |
1653 | \r | |
1654 | @retval EFI_SUCCESS The packet was successfully parsed.\r | |
1655 | @retval EFI_INVALID_PARAMETER Some parameter is NULL.\r | |
1656 | @retval EFI_BUFFER_TOO_SMALL One or more of the following conditions is TRUE:\r | |
1657 | 1) *OptionCount is smaller than the number of options that\r | |
1658 | were found in the Packet.\r | |
1659 | 2) PacketOptionList is NULL.\r | |
772db4bb | 1660 | \r |
1661 | **/\r | |
772db4bb | 1662 | EFI_STATUS\r |
1663 | EFIAPI\r | |
1664 | EfiDhcp4Parse (\r | |
1665 | IN EFI_DHCP4_PROTOCOL *This,\r | |
1666 | IN EFI_DHCP4_PACKET *Packet,\r | |
1667 | IN OUT UINT32 *OptionCount,\r | |
1668 | OUT EFI_DHCP4_PACKET_OPTION *PacketOptionList[] OPTIONAL\r | |
1669 | )\r | |
1670 | {\r | |
1671 | DHCP_PARSE_CONTEXT Context;\r | |
1672 | EFI_STATUS Status;\r | |
1673 | \r | |
1674 | //\r | |
1675 | // First validate the parameters\r | |
1676 | //\r | |
1677 | if ((This == NULL) || (Packet == NULL) || (OptionCount == NULL)) {\r | |
1678 | return EFI_INVALID_PARAMETER;\r | |
1679 | }\r | |
1680 | \r | |
1681 | if ((Packet->Size < Packet->Length + 2 * sizeof (UINT32)) ||\r | |
1682 | (Packet->Dhcp4.Magik != DHCP_OPTION_MAGIC) ||\r | |
1683 | EFI_ERROR (DhcpValidateOptions (Packet, NULL))) {\r | |
1684 | \r | |
1685 | return EFI_INVALID_PARAMETER;\r | |
1686 | }\r | |
1687 | \r | |
1688 | if ((*OptionCount != 0) && (PacketOptionList == NULL)) {\r | |
1689 | return EFI_BUFFER_TOO_SMALL;\r | |
1690 | }\r | |
1691 | \r | |
e48e37fc | 1692 | ZeroMem (PacketOptionList, *OptionCount * sizeof (EFI_DHCP4_PACKET_OPTION *));\r |
772db4bb | 1693 | \r |
1694 | Context.Option = PacketOptionList;\r | |
1695 | Context.OptionCount = *OptionCount;\r | |
1696 | Context.Index = 0;\r | |
1697 | \r | |
1698 | Status = DhcpIterateOptions (Packet, Dhcp4ParseCheckOption, &Context);\r | |
1699 | \r | |
1700 | if (EFI_ERROR (Status)) {\r | |
1701 | return Status;\r | |
1702 | }\r | |
1703 | \r | |
1704 | *OptionCount = Context.Index;\r | |
1705 | \r | |
1706 | if (Context.Index > Context.OptionCount) {\r | |
1707 | return EFI_BUFFER_TOO_SMALL;\r | |
1708 | }\r | |
1709 | \r | |
1710 | return EFI_SUCCESS;\r | |
1711 | }\r |