772db4bb |
1 | /** @file\r |
2 | \r |
75dce340 |
3 | Copyright (c) 2005 - 2012, Intel Corporation. All rights reserved.<BR>\r |
e5eed7d3 |
4 | This program and the accompanying materials\r |
772db4bb |
5 | are licensed and made available under the terms and conditions of the BSD License\r |
6 | which accompanies this distribution. The full text of the license may be found at\r |
7 | http://opensource.org/licenses/bsd-license.php\r |
8 | \r |
9 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r |
10 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r |
11 | \r |
772db4bb |
12 | **/\r |
13 | \r |
14 | #include "Ip4Impl.h"\r |
15 | \r |
705f53a9 |
16 | EFI_IPSEC2_PROTOCOL *mIpSec = NULL;\r |
a1503a32 |
17 | \r |
5405e9a6 |
18 | /**\r |
19 | Gets the current operational settings for this instance of the EFI IPv4 Protocol driver.\r |
e2851998 |
20 | \r |
5405e9a6 |
21 | The GetModeData() function returns the current operational mode data for this\r |
22 | driver instance. The data fields in EFI_IP4_MODE_DATA are read only. This\r |
23 | function is used optionally to retrieve the operational mode data of underlying\r |
24 | networks or drivers.\r |
25 | \r |
3e8c18da |
26 | @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r |
27 | @param[out] Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure.\r |
28 | @param[out] MnpConfigData Pointer to the managed network configuration data structure.\r |
29 | @param[out] SnpModeData Pointer to the simple network mode data structure.\r |
5405e9a6 |
30 | \r |
31 | @retval EFI_SUCCESS The operation completed successfully.\r |
32 | @retval EFI_INVALID_PARAMETER This is NULL.\r |
33 | @retval EFI_OUT_OF_RESOURCES The required mode data could not be allocated.\r |
772db4bb |
34 | \r |
5405e9a6 |
35 | **/\r |
36 | EFI_STATUS\r |
37 | EFIAPI\r |
38 | EfiIp4GetModeData (\r |
39 | IN CONST EFI_IP4_PROTOCOL *This,\r |
24af132f |
40 | OUT EFI_IP4_MODE_DATA *Ip4ModeData OPTIONAL,\r |
41 | OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL,\r |
5405e9a6 |
42 | OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL\r |
43 | );\r |
e2851998 |
44 | \r |
772db4bb |
45 | /**\r |
5405e9a6 |
46 | Assigns an IPv4 address and subnet mask to this EFI IPv4 Protocol driver instance.\r |
e2851998 |
47 | \r |
5405e9a6 |
48 | The Configure() function is used to set, change, or reset the operational\r |
49 | parameters and filter settings for this EFI IPv4 Protocol instance. Until these\r |
50 | parameters have been set, no network traffic can be sent or received by this\r |
51 | instance. Once the parameters have been reset (by calling this function with\r |
52 | IpConfigData set to NULL), no more traffic can be sent or received until these\r |
53 | parameters have been set again. Each EFI IPv4 Protocol instance can be started\r |
54 | and stopped independently of each other by enabling or disabling their receive\r |
55 | filter settings with the Configure() function.\r |
e2851998 |
56 | \r |
5405e9a6 |
57 | When IpConfigData.UseDefaultAddress is set to FALSE, the new station address will\r |
58 | be appended as an alias address into the addresses list in the EFI IPv4 Protocol\r |
59 | driver. While set to TRUE, Configure() will trigger the EFI_IP4_CONFIG_PROTOCOL\r |
60 | to retrieve the default IPv4 address if it is not available yet. Clients could\r |
61 | frequently call GetModeData() to check the status to ensure that the default IPv4\r |
62 | address is ready.\r |
e2851998 |
63 | \r |
5405e9a6 |
64 | If operational parameters are reset or changed, any pending transmit and receive\r |
65 | requests will be cancelled. Their completion token status will be set to EFI_ABORTED\r |
66 | and their events will be signaled.\r |
67 | \r |
3e8c18da |
68 | @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r |
69 | @param[in] IpConfigData Pointer to the EFI IPv4 Protocol configuration data structure.\r |
5405e9a6 |
70 | \r |
71 | @retval EFI_SUCCESS The driver instance was successfully opened.\r |
72 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r |
73 | RARP, etc.) is not finished yet.\r |
74 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r |
75 | @retval EFI_UNSUPPORTED One or more of the following conditions is TRUE:\r |
76 | A configuration protocol (DHCP, BOOTP, RARP, etc.) could\r |
77 | not be located when clients choose to use the default IPv4\r |
78 | address. This EFI IPv4 Protocol implementation does not\r |
79 | support this requested filter or timeout setting.\r |
80 | @retval EFI_OUT_OF_RESOURCES The EFI IPv4 Protocol driver instance data could not be allocated.\r |
81 | @retval EFI_ALREADY_STARTED The interface is already open and must be stopped before the\r |
82 | IPv4 address or subnet mask can be changed. The interface must\r |
83 | also be stopped when switching to/from raw packet mode.\r |
84 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI IPv4\r |
85 | Protocol driver instance is not opened.\r |
772db4bb |
86 | \r |
5405e9a6 |
87 | **/\r |
88 | EFI_STATUS\r |
89 | EFIAPI\r |
90 | EfiIp4Configure (\r |
91 | IN EFI_IP4_PROTOCOL *This,\r |
92 | IN EFI_IP4_CONFIG_DATA *IpConfigData OPTIONAL\r |
93 | );\r |
e2851998 |
94 | \r |
5405e9a6 |
95 | /**\r |
96 | Joins and leaves multicast groups.\r |
e2851998 |
97 | \r |
5405e9a6 |
98 | The Groups() function is used to join and leave multicast group sessions. Joining\r |
99 | a group will enable reception of matching multicast packets. Leaving a group will\r |
100 | disable the multicast packet reception.\r |
e2851998 |
101 | \r |
5405e9a6 |
102 | If JoinFlag is FALSE and GroupAddress is NULL, all joined groups will be left.\r |
103 | \r |
3e8c18da |
104 | @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r |
105 | @param[in] JoinFlag Set to TRUE to join the multicast group session and FALSE to leave.\r |
106 | @param[in] GroupAddress Pointer to the IPv4 multicast address.\r |
5405e9a6 |
107 | \r |
108 | @retval EFI_SUCCESS The operation completed successfully.\r |
109 | @retval EFI_INVALID_PARAMETER One or more of the following is TRUE:\r |
110 | - This is NULL.\r |
111 | - JoinFlag is TRUE and GroupAddress is NULL.\r |
112 | - GroupAddress is not NULL and *GroupAddress is\r |
113 | not a multicast IPv4 address.\r |
114 | @retval EFI_NOT_STARTED This instance has not been started.\r |
115 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r |
116 | RARP, etc.) is not finished yet.\r |
117 | @retval EFI_OUT_OF_RESOURCES System resources could not be allocated.\r |
118 | @retval EFI_UNSUPPORTED This EFI IPv4 Protocol implementation does not support multicast groups.\r |
119 | @retval EFI_ALREADY_STARTED The group address is already in the group table (when\r |
120 | JoinFlag is TRUE).\r |
121 | @retval EFI_NOT_FOUND The group address is not in the group table (when JoinFlag is FALSE).\r |
122 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r |
772db4bb |
123 | \r |
5405e9a6 |
124 | **/\r |
125 | EFI_STATUS\r |
126 | EFIAPI\r |
127 | EfiIp4Groups (\r |
128 | IN EFI_IP4_PROTOCOL *This,\r |
129 | IN BOOLEAN JoinFlag,\r |
130 | IN EFI_IPv4_ADDRESS *GroupAddress OPTIONAL\r |
131 | );\r |
e2851998 |
132 | \r |
5405e9a6 |
133 | /**\r |
134 | Adds and deletes routing table entries.\r |
135 | \r |
136 | The Routes() function adds a route to or deletes a route from the routing table.\r |
e2851998 |
137 | \r |
5405e9a6 |
138 | Routes are determined by comparing the SubnetAddress with the destination IPv4\r |
139 | address arithmetically AND-ed with the SubnetMask. The gateway address must be\r |
140 | on the same subnet as the configured station address.\r |
e2851998 |
141 | \r |
5405e9a6 |
142 | The default route is added with SubnetAddress and SubnetMask both set to 0.0.0.0.\r |
143 | The default route matches all destination IPv4 addresses that do not match any\r |
144 | other routes.\r |
e2851998 |
145 | \r |
5405e9a6 |
146 | A GatewayAddress that is zero is a nonroute. Packets are sent to the destination\r |
147 | IP address if it can be found in the ARP cache or on the local subnet. One automatic\r |
148 | nonroute entry will be inserted into the routing table for outgoing packets that\r |
149 | are addressed to a local subnet (gateway address of 0.0.0.0).\r |
e2851998 |
150 | \r |
5405e9a6 |
151 | Each EFI IPv4 Protocol instance has its own independent routing table. Those EFI\r |
152 | IPv4 Protocol instances that use the default IPv4 address will also have copies\r |
153 | of the routing table that was provided by the EFI_IP4_CONFIG_PROTOCOL, and these\r |
154 | copies will be updated whenever the EIF IPv4 Protocol driver reconfigures its\r |
155 | instances. As a result, client modification to the routing table will be lost.\r |
156 | \r |
3e8c18da |
157 | @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r |
158 | @param[in] DeleteRoute Set to TRUE to delete this route from the routing table. Set to\r |
159 | FALSE to add this route to the routing table. SubnetAddress\r |
160 | and SubnetMask are used as the key to each route entry.\r |
161 | @param[in] SubnetAddress The address of the subnet that needs to be routed.\r |
162 | @param[in] SubnetMask The subnet mask of SubnetAddress.\r |
163 | @param[in] GatewayAddress The unicast gateway IPv4 address for this route.\r |
5405e9a6 |
164 | \r |
165 | @retval EFI_SUCCESS The operation completed successfully.\r |
166 | @retval EFI_NOT_STARTED The driver instance has not been started.\r |
167 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r |
168 | RARP, etc.) is not finished yet.\r |
169 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r |
170 | - This is NULL.\r |
171 | - SubnetAddress is NULL.\r |
172 | - SubnetMask is NULL.\r |
173 | - GatewayAddress is NULL.\r |
174 | - *SubnetAddress is not a valid subnet address.\r |
175 | - *SubnetMask is not a valid subnet mask.\r |
176 | - *GatewayAddress is not a valid unicast IPv4 address.\r |
177 | @retval EFI_OUT_OF_RESOURCES Could not add the entry to the routing table.\r |
178 | @retval EFI_NOT_FOUND This route is not in the routing table (when DeleteRoute is TRUE).\r |
179 | @retval EFI_ACCESS_DENIED The route is already defined in the routing table (when\r |
180 | DeleteRoute is FALSE).\r |
e2851998 |
181 | \r |
5405e9a6 |
182 | **/\r |
183 | EFI_STATUS\r |
184 | EFIAPI\r |
185 | EfiIp4Routes (\r |
186 | IN EFI_IP4_PROTOCOL *This,\r |
187 | IN BOOLEAN DeleteRoute,\r |
188 | IN EFI_IPv4_ADDRESS *SubnetAddress,\r |
189 | IN EFI_IPv4_ADDRESS *SubnetMask,\r |
190 | IN EFI_IPv4_ADDRESS *GatewayAddress\r |
191 | );\r |
e2851998 |
192 | \r |
5405e9a6 |
193 | /**\r |
194 | Places outgoing data packets into the transmit queue.\r |
195 | \r |
196 | The Transmit() function places a sending request in the transmit queue of this\r |
197 | EFI IPv4 Protocol instance. Whenever the packet in the token is sent out or some\r |
198 | errors occur, the event in the token will be signaled and the status is updated.\r |
199 | \r |
3e8c18da |
200 | @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r |
201 | @param[in] Token Pointer to the transmit token.\r |
5405e9a6 |
202 | \r |
203 | @retval EFI_SUCCESS The data has been queued for transmission.\r |
204 | @retval EFI_NOT_STARTED This instance has not been started.\r |
205 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r |
206 | RARP, etc.) is not finished yet.\r |
207 | @retval EFI_INVALID_PARAMETER One or more pameters are invalid.\r |
208 | @retval EFI_ACCESS_DENIED The transmit completion token with the same Token.Event\r |
209 | was already in the transmit queue.\r |
210 | @retval EFI_NOT_READY The completion token could not be queued because the transmit\r |
e2851998 |
211 | queue is full.\r |
5405e9a6 |
212 | @retval EFI_NOT_FOUND Not route is found to destination address.\r |
213 | @retval EFI_OUT_OF_RESOURCES Could not queue the transmit data.\r |
214 | @retval EFI_BUFFER_TOO_SMALL Token.Packet.TxData.TotalDataLength is too\r |
215 | short to transmit.\r |
216 | @retval EFI_BAD_BUFFER_SIZE The length of the IPv4 header + option length + total data length is\r |
217 | greater than MTU (or greater than the maximum packet size if\r |
218 | Token.Packet.TxData.OverrideData.\r |
219 | DoNotFragment is TRUE.)\r |
220 | \r |
221 | **/\r |
222 | EFI_STATUS\r |
223 | EFIAPI\r |
224 | EfiIp4Transmit (\r |
225 | IN EFI_IP4_PROTOCOL *This,\r |
226 | IN EFI_IP4_COMPLETION_TOKEN *Token\r |
227 | );\r |
e2851998 |
228 | \r |
5405e9a6 |
229 | /**\r |
230 | Places a receiving request into the receiving queue.\r |
e2851998 |
231 | \r |
5405e9a6 |
232 | The Receive() function places a completion token into the receive packet queue.\r |
233 | This function is always asynchronous.\r |
e2851998 |
234 | \r |
5405e9a6 |
235 | The Token.Event field in the completion token must be filled in by the caller\r |
236 | and cannot be NULL. When the receive operation completes, the EFI IPv4 Protocol\r |
237 | driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event\r |
238 | is signaled.\r |
239 | \r |
3e8c18da |
240 | @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r |
241 | @param[in] Token Pointer to a token that is associated with the receive data descriptor.\r |
5405e9a6 |
242 | \r |
243 | @retval EFI_SUCCESS The receive completion token was cached.\r |
244 | @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.\r |
245 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, RARP, etc.)\r |
246 | is not finished yet.\r |
247 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r |
248 | - This is NULL.\r |
249 | - Token is NULL.\r |
250 | - Token.Event is NULL.\r |
251 | @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system\r |
252 | resources (usually memory).\r |
253 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r |
254 | The EFI IPv4 Protocol instance has been reset to startup defaults.\r |
255 | EFI_ACCESS_DENIED The receive completion token with the same Token.Event was already\r |
256 | in the receive queue.\r |
257 | @retval EFI_NOT_READY The receive request could not be queued because the receive queue is full.\r |
258 | @retval EFI_ICMP_ERROR An ICMP error packet was received.\r |
259 | \r |
260 | **/\r |
261 | EFI_STATUS\r |
262 | EFIAPI\r |
263 | EfiIp4Receive (\r |
264 | IN EFI_IP4_PROTOCOL *This,\r |
265 | IN EFI_IP4_COMPLETION_TOKEN *Token\r |
266 | );\r |
e2851998 |
267 | \r |
5405e9a6 |
268 | /**\r |
269 | Abort an asynchronous transmit or receive request.\r |
e2851998 |
270 | \r |
5405e9a6 |
271 | The Cancel() function is used to abort a pending transmit or receive request.\r |
272 | If the token is in the transmit or receive request queues, after calling this\r |
273 | function, Token->Status will be set to EFI_ABORTED and then Token->Event will\r |
274 | be signaled. If the token is not in one of the queues, which usually means the\r |
275 | asynchronous operation has completed, this function will not signal the token\r |
276 | and EFI_NOT_FOUND is returned.\r |
277 | \r |
3e8c18da |
278 | @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r |
279 | @param[in] Token Pointer to a token that has been issued by\r |
280 | EFI_IP4_PROTOCOL.Transmit() or\r |
281 | EFI_IP4_PROTOCOL.Receive(). If NULL, all pending\r |
282 | tokens are aborted. Type EFI_IP4_COMPLETION_TOKEN is\r |
283 | defined in EFI_IP4_PROTOCOL.Transmit().\r |
5405e9a6 |
284 | \r |
285 | @retval EFI_SUCCESS The asynchronous I/O request was aborted and\r |
286 | Token.->Event was signaled. When Token is NULL, all\r |
287 | pending requests were aborted and their events were signaled.\r |
288 | @retval EFI_INVALID_PARAMETER This is NULL.\r |
289 | @retval EFI_NOT_STARTED This instance has not been started.\r |
290 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r |
291 | RARP, etc.) is not finished yet.\r |
292 | @retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O request was\r |
293 | not found in the transmit or receive queue. It has either completed\r |
294 | or was not issued by Transmit() and Receive().\r |
295 | \r |
296 | **/\r |
297 | EFI_STATUS\r |
298 | EFIAPI\r |
299 | EfiIp4Cancel (\r |
300 | IN EFI_IP4_PROTOCOL *This,\r |
301 | IN EFI_IP4_COMPLETION_TOKEN *Token OPTIONAL\r |
302 | );\r |
e2851998 |
303 | \r |
5405e9a6 |
304 | /**\r |
305 | Polls for incoming data packets and processes outgoing data packets.\r |
e2851998 |
306 | \r |
5405e9a6 |
307 | The Poll() function polls for incoming data packets and processes outgoing data\r |
308 | packets. Network drivers and applications can call the EFI_IP4_PROTOCOL.Poll()\r |
309 | function to increase the rate that data packets are moved between the communications\r |
310 | device and the transmit and receive queues.\r |
e2851998 |
311 | \r |
5405e9a6 |
312 | In some systems the periodic timer event may not poll the underlying communications\r |
313 | device fast enough to transmit and/or receive all data packets without missing\r |
314 | incoming packets or dropping outgoing packets. Drivers and applications that are\r |
315 | experiencing packet loss should try calling the EFI_IP4_PROTOCOL.Poll() function\r |
316 | more often.\r |
317 | \r |
3e8c18da |
318 | @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r |
5405e9a6 |
319 | \r |
320 | @retval EFI_SUCCESS Incoming or outgoing data was processed.\r |
321 | @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.\r |
322 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r |
323 | RARP, etc.) is not finished yet.\r |
324 | @retval EFI_INVALID_PARAMETER This is NULL.\r |
325 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r |
326 | @retval EFI_NOT_READY No incoming or outgoing data is processed.\r |
327 | @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue.\r |
328 | Consider increasing the polling rate.\r |
329 | \r |
330 | **/\r |
331 | EFI_STATUS\r |
332 | EFIAPI\r |
333 | EfiIp4Poll (\r |
334 | IN EFI_IP4_PROTOCOL *This\r |
335 | );\r |
336 | \r |
337 | EFI_IP4_PROTOCOL\r |
338 | mEfiIp4ProtocolTemplete = {\r |
339 | EfiIp4GetModeData,\r |
340 | EfiIp4Configure,\r |
341 | EfiIp4Groups,\r |
342 | EfiIp4Routes,\r |
343 | EfiIp4Transmit,\r |
344 | EfiIp4Receive,\r |
345 | EfiIp4Cancel,\r |
346 | EfiIp4Poll\r |
347 | };\r |
348 | \r |
349 | /**\r |
350 | Gets the current operational settings for this instance of the EFI IPv4 Protocol driver.\r |
e2851998 |
351 | \r |
5405e9a6 |
352 | The GetModeData() function returns the current operational mode data for this\r |
353 | driver instance. The data fields in EFI_IP4_MODE_DATA are read only. This\r |
354 | function is used optionally to retrieve the operational mode data of underlying\r |
355 | networks or drivers.\r |
356 | \r |
3e8c18da |
357 | @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r |
358 | @param[out] Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure.\r |
359 | @param[out] MnpConfigData Pointer to the managed network configuration data structure.\r |
360 | @param[out] SnpModeData Pointer to the simple network mode data structure.\r |
5405e9a6 |
361 | \r |
362 | @retval EFI_SUCCESS The operation completed successfully.\r |
363 | @retval EFI_INVALID_PARAMETER This is NULL.\r |
364 | @retval EFI_OUT_OF_RESOURCES The required mode data could not be allocated.\r |
772db4bb |
365 | \r |
366 | **/\r |
772db4bb |
367 | EFI_STATUS\r |
368 | EFIAPI\r |
369 | EfiIp4GetModeData (\r |
370 | IN CONST EFI_IP4_PROTOCOL *This,\r |
24af132f |
371 | OUT EFI_IP4_MODE_DATA *Ip4ModeData OPTIONAL,\r |
372 | OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL,\r |
772db4bb |
373 | OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL\r |
374 | )\r |
375 | {\r |
376 | IP4_PROTOCOL *IpInstance;\r |
377 | IP4_SERVICE *IpSb;\r |
378 | EFI_IP4_CONFIG_DATA *Config;\r |
379 | EFI_STATUS Status;\r |
380 | EFI_TPL OldTpl;\r |
381 | IP4_ADDR Ip;\r |
382 | \r |
383 | if (This == NULL) {\r |
384 | return EFI_INVALID_PARAMETER;\r |
385 | }\r |
386 | \r |
e48e37fc |
387 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r |
772db4bb |
388 | IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This);\r |
389 | IpSb = IpInstance->Service;\r |
390 | \r |
391 | if (Ip4ModeData != NULL) {\r |
392 | //\r |
393 | // IsStarted is "whether the EfiIp4Configure has been called".\r |
394 | // IsConfigured is "whether the station address has been configured"\r |
395 | //\r |
396 | Ip4ModeData->IsStarted = (BOOLEAN)(IpInstance->State == IP4_STATE_CONFIGED);\r |
687a2e5f |
397 | CopyMem (&Ip4ModeData->ConfigData, &IpInstance->ConfigData, sizeof (Ip4ModeData->ConfigData));\r |
772db4bb |
398 | Ip4ModeData->IsConfigured = FALSE;\r |
399 | \r |
400 | Ip4ModeData->GroupCount = IpInstance->GroupCount;\r |
401 | Ip4ModeData->GroupTable = (EFI_IPv4_ADDRESS *) IpInstance->Groups;\r |
402 | \r |
403 | Ip4ModeData->IcmpTypeCount = 23;\r |
404 | Ip4ModeData->IcmpTypeList = mIp4SupportedIcmp;\r |
405 | \r |
406 | Ip4ModeData->RouteTable = NULL;\r |
407 | Ip4ModeData->RouteCount = 0;\r |
408 | \r |
a1503a32 |
409 | Ip4ModeData->MaxPacketSize = IpSb->MaxPacketSize;\r |
410 | \r |
772db4bb |
411 | //\r |
412 | // return the current station address for this IP child. So,\r |
413 | // the user can get the default address through this. Some\r |
414 | // application wants to know it station address even it is\r |
415 | // using the default one, such as a ftp server.\r |
416 | //\r |
417 | if (Ip4ModeData->IsStarted) {\r |
418 | Config = &Ip4ModeData->ConfigData;\r |
419 | \r |
420 | Ip = HTONL (IpInstance->Interface->Ip);\r |
e48e37fc |
421 | CopyMem (&Config->StationAddress, &Ip, sizeof (EFI_IPv4_ADDRESS));\r |
772db4bb |
422 | \r |
423 | Ip = HTONL (IpInstance->Interface->SubnetMask);\r |
e48e37fc |
424 | CopyMem (&Config->SubnetMask, &Ip, sizeof (EFI_IPv4_ADDRESS));\r |
772db4bb |
425 | \r |
426 | Ip4ModeData->IsConfigured = IpInstance->Interface->Configured;\r |
427 | \r |
428 | //\r |
429 | // Build a EFI route table for user from the internal route table.\r |
430 | //\r |
431 | Status = Ip4BuildEfiRouteTable (IpInstance);\r |
432 | \r |
433 | if (EFI_ERROR (Status)) {\r |
e48e37fc |
434 | gBS->RestoreTPL (OldTpl);\r |
772db4bb |
435 | return Status;\r |
436 | }\r |
437 | \r |
438 | Ip4ModeData->RouteTable = IpInstance->EfiRouteTable;\r |
439 | Ip4ModeData->RouteCount = IpInstance->EfiRouteCount;\r |
440 | }\r |
441 | }\r |
442 | \r |
dd29f3ed |
443 | //\r |
444 | // Get fresh mode data from MNP, since underlying media status may change\r |
445 | //\r |
446 | Status = IpSb->Mnp->GetModeData (IpSb->Mnp, MnpConfigData, SnpModeData);\r |
772db4bb |
447 | \r |
e48e37fc |
448 | gBS->RestoreTPL (OldTpl);\r |
dd29f3ed |
449 | return Status;\r |
772db4bb |
450 | }\r |
451 | \r |
452 | \r |
453 | /**\r |
454 | Config the MNP parameter used by IP. The IP driver use one MNP\r |
455 | child to transmit/receive frames. By default, it configures MNP\r |
456 | to receive unicast/multicast/broadcast. And it will enable/disable\r |
457 | the promiscous receive according to whether there is IP child\r |
5405e9a6 |
458 | enable that or not. If Force is FALSE, it will iterate through\r |
772db4bb |
459 | all the IP children to check whether the promiscuous receive\r |
460 | setting has been changed. If it hasn't been changed, it won't\r |
5405e9a6 |
461 | reconfigure the MNP. If Force is TRUE, the MNP is configured no\r |
772db4bb |
462 | matter whether that is changed or not.\r |
463 | \r |
3e8c18da |
464 | @param[in] IpSb The IP4 service instance that is to be changed.\r |
465 | @param[in] Force Force the configuration or not.\r |
772db4bb |
466 | \r |
467 | @retval EFI_SUCCESS The MNP is successfully configured/reconfigured.\r |
468 | @retval Others Configuration failed.\r |
469 | \r |
470 | **/\r |
471 | EFI_STATUS\r |
472 | Ip4ServiceConfigMnp (\r |
473 | IN IP4_SERVICE *IpSb,\r |
474 | IN BOOLEAN Force\r |
475 | )\r |
476 | {\r |
e48e37fc |
477 | LIST_ENTRY *Entry;\r |
478 | LIST_ENTRY *ProtoEntry;\r |
772db4bb |
479 | IP4_INTERFACE *IpIf;\r |
480 | IP4_PROTOCOL *IpInstance;\r |
481 | BOOLEAN Reconfig;\r |
482 | BOOLEAN PromiscReceive;\r |
483 | EFI_STATUS Status;\r |
484 | \r |
485 | Reconfig = FALSE;\r |
486 | PromiscReceive = FALSE;\r |
487 | \r |
488 | if (!Force) {\r |
489 | //\r |
490 | // Iterate through the IP children to check whether promiscuous\r |
491 | // receive setting has been changed. Update the interface's receive\r |
492 | // filter also.\r |
493 | //\r |
494 | NET_LIST_FOR_EACH (Entry, &IpSb->Interfaces) {\r |
495 | \r |
496 | IpIf = NET_LIST_USER_STRUCT (Entry, IP4_INTERFACE, Link);\r |
497 | IpIf->PromiscRecv = FALSE;\r |
498 | \r |
499 | NET_LIST_FOR_EACH (ProtoEntry, &IpIf->IpInstances) {\r |
500 | IpInstance = NET_LIST_USER_STRUCT (ProtoEntry, IP4_PROTOCOL, AddrLink);\r |
501 | \r |
502 | if (IpInstance->ConfigData.AcceptPromiscuous) {\r |
503 | IpIf->PromiscRecv = TRUE;\r |
504 | PromiscReceive = TRUE;\r |
505 | }\r |
506 | }\r |
507 | }\r |
508 | \r |
509 | //\r |
510 | // If promiscuous receive isn't changed, it isn't necessary to reconfigure.\r |
511 | //\r |
512 | if (PromiscReceive == IpSb->MnpConfigData.EnablePromiscuousReceive) {\r |
513 | return EFI_SUCCESS;\r |
514 | }\r |
515 | \r |
516 | Reconfig = TRUE;\r |
517 | IpSb->MnpConfigData.EnablePromiscuousReceive = PromiscReceive;\r |
518 | }\r |
519 | \r |
520 | Status = IpSb->Mnp->Configure (IpSb->Mnp, &IpSb->MnpConfigData);\r |
521 | \r |
522 | //\r |
523 | // recover the original configuration if failed to set the configure.\r |
524 | //\r |
525 | if (EFI_ERROR (Status) && Reconfig) {\r |
687a2e5f |
526 | IpSb->MnpConfigData.EnablePromiscuousReceive = (BOOLEAN) !PromiscReceive;\r |
772db4bb |
527 | }\r |
528 | \r |
529 | return Status;\r |
530 | }\r |
531 | \r |
532 | \r |
533 | /**\r |
534 | The event handle for IP4 auto configuration. If IP is asked\r |
535 | to reconfigure the default address. The original default\r |
536 | interface and route table are removed as the default. If there\r |
537 | is active IP children using the default address, the interface\r |
538 | will remain valid until all the children have freed their\r |
539 | references. If IP is signalled when auto configuration is done,\r |
540 | it will configure the default interface and default route table\r |
541 | with the configuration information retrieved by IP4_CONFIGURE.\r |
542 | \r |
3e8c18da |
543 | @param[in] Context The IP4 service binding instance.\r |
772db4bb |
544 | \r |
545 | **/\r |
546 | VOID\r |
547 | EFIAPI\r |
36ee91ca |
548 | Ip4AutoConfigCallBackDpc (\r |
772db4bb |
549 | IN VOID *Context\r |
550 | )\r |
551 | {\r |
552 | EFI_IP4_CONFIG_PROTOCOL *Ip4Config;\r |
553 | EFI_IP4_IPCONFIG_DATA *Data;\r |
554 | EFI_IP4_ROUTE_TABLE *RouteEntry;\r |
555 | IP4_SERVICE *IpSb;\r |
556 | IP4_ROUTE_TABLE *RouteTable;\r |
557 | IP4_INTERFACE *IpIf;\r |
558 | EFI_STATUS Status;\r |
559 | UINTN Len;\r |
560 | UINT32 Index;\r |
1204fe83 |
561 | IP4_ADDR StationAddress;\r |
562 | IP4_ADDR SubnetMask;\r |
563 | IP4_ADDR SubnetAddress;\r |
564 | IP4_ADDR GatewayAddress;\r |
772db4bb |
565 | \r |
566 | IpSb = (IP4_SERVICE *) Context;\r |
567 | NET_CHECK_SIGNATURE (IpSb, IP4_SERVICE_SIGNATURE);\r |
568 | \r |
569 | Ip4Config = IpSb->Ip4Config;\r |
570 | \r |
571 | //\r |
572 | // IP is asked to do the reconfiguration. If the default interface\r |
573 | // has been configured, release the default interface and route\r |
574 | // table, then create a new one. If there are some IP children\r |
575 | // using it, the interface won't be physically freed until all the\r |
576 | // children have released their reference to it. Also remember to\r |
577 | // restart the receive on the default address. IP4 driver only receive\r |
578 | // frames on the default address, and when the default interface is\r |
579 | // freed, Ip4AcceptFrame won't be informed.\r |
580 | //\r |
36ee91ca |
581 | if (IpSb->ActiveEvent == IpSb->ReconfigEvent) {\r |
772db4bb |
582 | \r |
583 | if (IpSb->DefaultInterface->Configured) {\r |
584 | IpIf = Ip4CreateInterface (IpSb->Mnp, IpSb->Controller, IpSb->Image);\r |
585 | \r |
586 | if (IpIf == NULL) {\r |
587 | return;\r |
588 | }\r |
589 | \r |
590 | RouteTable = Ip4CreateRouteTable ();\r |
591 | \r |
592 | if (RouteTable == NULL) {\r |
593 | Ip4FreeInterface (IpIf, NULL);\r |
594 | return;\r |
595 | }\r |
596 | \r |
597 | Ip4CancelReceive (IpSb->DefaultInterface);\r |
598 | Ip4FreeInterface (IpSb->DefaultInterface, NULL);\r |
599 | Ip4FreeRouteTable (IpSb->DefaultRouteTable);\r |
600 | \r |
601 | IpSb->DefaultInterface = IpIf;\r |
e48e37fc |
602 | InsertHeadList (&IpSb->Interfaces, &IpIf->Link);\r |
772db4bb |
603 | \r |
604 | IpSb->DefaultRouteTable = RouteTable;\r |
605 | Ip4ReceiveFrame (IpIf, NULL, Ip4AccpetFrame, IpSb);\r |
606 | }\r |
607 | \r |
608 | Ip4Config->Stop (Ip4Config);\r |
609 | Ip4Config->Start (Ip4Config, IpSb->DoneEvent, IpSb->ReconfigEvent);\r |
610 | return ;\r |
611 | }\r |
612 | \r |
613 | //\r |
614 | // Get the configure data in two steps: get the length then the data.\r |
615 | //\r |
616 | Len = 0;\r |
617 | \r |
618 | if (Ip4Config->GetData (Ip4Config, &Len, NULL) != EFI_BUFFER_TOO_SMALL) {\r |
619 | return ;\r |
620 | }\r |
621 | \r |
e48e37fc |
622 | Data = AllocatePool (Len);\r |
772db4bb |
623 | \r |
624 | if (Data == NULL) {\r |
625 | return ;\r |
626 | }\r |
627 | \r |
628 | Status = Ip4Config->GetData (Ip4Config, &Len, Data);\r |
629 | \r |
630 | if (EFI_ERROR (Status)) {\r |
631 | goto ON_EXIT;\r |
632 | }\r |
633 | \r |
634 | IpIf = IpSb->DefaultInterface;\r |
635 | \r |
636 | //\r |
637 | // If the default address has been configured don't change it.\r |
638 | // This is unlikely to happen if EFI_IP4_CONFIG protocol has\r |
639 | // informed us to reconfigure each time it wants to change the\r |
640 | // configuration parameters.\r |
641 | //\r |
642 | if (IpIf->Configured) {\r |
643 | goto ON_EXIT;\r |
644 | }\r |
645 | \r |
646 | //\r |
647 | // Set the default interface's address, then add a directed\r |
648 | // route for it, that is, the route whose nexthop is zero.\r |
649 | //\r |
1204fe83 |
650 | StationAddress = EFI_NTOHL (Data->StationAddress);\r |
651 | SubnetMask = EFI_NTOHL (Data->SubnetMask);\r |
652 | Status = Ip4SetAddress (IpIf, StationAddress, SubnetMask);\r |
772db4bb |
653 | \r |
654 | if (EFI_ERROR (Status)) {\r |
655 | goto ON_EXIT;\r |
656 | }\r |
657 | \r |
658 | Ip4AddRoute (\r |
659 | IpSb->DefaultRouteTable,\r |
1204fe83 |
660 | StationAddress,\r |
661 | SubnetMask,\r |
772db4bb |
662 | IP4_ALLZERO_ADDRESS\r |
663 | );\r |
664 | \r |
665 | //\r |
666 | // Add routes returned by EFI_IP4_CONFIG protocol.\r |
667 | //\r |
668 | for (Index = 0; Index < Data->RouteTableSize; Index++) {\r |
669 | RouteEntry = &Data->RouteTable[Index];\r |
670 | \r |
1204fe83 |
671 | SubnetAddress = EFI_NTOHL (RouteEntry->SubnetAddress);\r |
672 | SubnetMask = EFI_NTOHL (RouteEntry->SubnetMask);\r |
673 | GatewayAddress = EFI_NTOHL (RouteEntry->GatewayAddress);\r |
674 | Ip4AddRoute (IpSb->DefaultRouteTable, SubnetAddress, SubnetMask, GatewayAddress);\r |
772db4bb |
675 | }\r |
676 | \r |
677 | IpSb->State = IP4_SERVICE_CONFIGED;\r |
678 | \r |
679 | Ip4SetVariableData (IpSb);\r |
680 | \r |
681 | ON_EXIT:\r |
766c7483 |
682 | FreePool (Data);\r |
772db4bb |
683 | }\r |
684 | \r |
2ff29212 |
685 | /**\r |
5405e9a6 |
686 | Request Ip4AutoConfigCallBackDpc as a DPC at TPL_CALLBACK.\r |
e2851998 |
687 | \r |
5405e9a6 |
688 | @param Event The event that is signalled.\r |
689 | @param Context The IP4 service binding instance.\r |
5405e9a6 |
690 | \r |
2ff29212 |
691 | **/\r |
36ee91ca |
692 | VOID\r |
693 | EFIAPI\r |
694 | Ip4AutoConfigCallBack (\r |
695 | IN EFI_EVENT Event,\r |
696 | IN VOID *Context\r |
697 | )\r |
36ee91ca |
698 | {\r |
699 | IP4_SERVICE *IpSb;\r |
700 | \r |
701 | IpSb = (IP4_SERVICE *) Context;\r |
702 | IpSb->ActiveEvent = Event;\r |
703 | \r |
704 | //\r |
705 | // Request Ip4AutoConfigCallBackDpc as a DPC at TPL_CALLBACK\r |
706 | //\r |
d8d26fb2 |
707 | QueueDpc (TPL_CALLBACK, Ip4AutoConfigCallBackDpc, Context);\r |
36ee91ca |
708 | }\r |
709 | \r |
772db4bb |
710 | \r |
711 | /**\r |
712 | Start the auto configuration for this IP service instance.\r |
713 | It will locates the EFI_IP4_CONFIG_PROTOCOL, then start the\r |
714 | auto configuration.\r |
715 | \r |
3e8c18da |
716 | @param[in] IpSb The IP4 service instance to configure\r |
772db4bb |
717 | \r |
718 | @retval EFI_SUCCESS The auto configuration is successfull started\r |
719 | @retval Others Failed to start auto configuration.\r |
720 | \r |
721 | **/\r |
722 | EFI_STATUS\r |
723 | Ip4StartAutoConfig (\r |
724 | IN IP4_SERVICE *IpSb\r |
725 | )\r |
726 | {\r |
727 | EFI_IP4_CONFIG_PROTOCOL *Ip4Config;\r |
728 | EFI_STATUS Status;\r |
729 | \r |
730 | if (IpSb->State > IP4_SERVICE_UNSTARTED) {\r |
731 | return EFI_SUCCESS;\r |
732 | }\r |
733 | \r |
734 | //\r |
735 | // Create the DoneEvent and ReconfigEvent to call EFI_IP4_CONFIG\r |
736 | //\r |
737 | Status = gBS->CreateEvent (\r |
738 | EVT_NOTIFY_SIGNAL,\r |
e48e37fc |
739 | TPL_CALLBACK,\r |
772db4bb |
740 | Ip4AutoConfigCallBack,\r |
741 | IpSb,\r |
742 | &IpSb->DoneEvent\r |
743 | );\r |
744 | \r |
745 | if (EFI_ERROR (Status)) {\r |
746 | return Status;\r |
747 | }\r |
748 | \r |
749 | Status = gBS->CreateEvent (\r |
750 | EVT_NOTIFY_SIGNAL,\r |
e48e37fc |
751 | TPL_NOTIFY,\r |
772db4bb |
752 | Ip4AutoConfigCallBack,\r |
753 | IpSb,\r |
754 | &IpSb->ReconfigEvent\r |
755 | );\r |
756 | \r |
757 | if (EFI_ERROR (Status)) {\r |
758 | goto CLOSE_DONE_EVENT;\r |
759 | }\r |
760 | \r |
761 | //\r |
762 | // Open the EFI_IP4_CONFIG protocol then start auto configure\r |
763 | //\r |
764 | Status = gBS->OpenProtocol (\r |
765 | IpSb->Controller,\r |
766 | &gEfiIp4ConfigProtocolGuid,\r |
767 | (VOID **) &Ip4Config,\r |
768 | IpSb->Image,\r |
769 | IpSb->Controller,\r |
770 | EFI_OPEN_PROTOCOL_BY_DRIVER | EFI_OPEN_PROTOCOL_EXCLUSIVE\r |
771 | );\r |
772 | \r |
773 | if (EFI_ERROR (Status)) {\r |
774 | Status = EFI_UNSUPPORTED;\r |
775 | goto CLOSE_RECONFIG_EVENT;\r |
776 | }\r |
777 | \r |
778 | Status = Ip4Config->Start (Ip4Config, IpSb->DoneEvent, IpSb->ReconfigEvent);\r |
779 | \r |
780 | if (EFI_ERROR (Status)) {\r |
781 | gBS->CloseProtocol (\r |
782 | IpSb->Controller,\r |
783 | &gEfiIp4ConfigProtocolGuid,\r |
784 | IpSb->Image,\r |
785 | IpSb->Controller\r |
786 | );\r |
787 | \r |
788 | goto CLOSE_RECONFIG_EVENT;\r |
789 | }\r |
790 | \r |
791 | IpSb->Ip4Config = Ip4Config;\r |
792 | IpSb->State = IP4_SERVICE_STARTED;\r |
793 | return Status;\r |
794 | \r |
795 | CLOSE_RECONFIG_EVENT:\r |
796 | gBS->CloseEvent (IpSb->ReconfigEvent);\r |
797 | IpSb->ReconfigEvent = NULL;\r |
798 | \r |
799 | CLOSE_DONE_EVENT:\r |
800 | gBS->CloseEvent (IpSb->DoneEvent);\r |
801 | IpSb->DoneEvent = NULL;\r |
802 | \r |
803 | return Status;\r |
804 | }\r |
805 | \r |
806 | \r |
807 | /**\r |
808 | Intiialize the IP4_PROTOCOL structure to the unconfigured states.\r |
809 | \r |
810 | @param IpSb The IP4 service instance.\r |
811 | @param IpInstance The IP4 child instance.\r |
812 | \r |
772db4bb |
813 | **/\r |
814 | VOID\r |
815 | Ip4InitProtocol (\r |
5405e9a6 |
816 | IN IP4_SERVICE *IpSb,\r |
817 | IN OUT IP4_PROTOCOL *IpInstance\r |
772db4bb |
818 | )\r |
819 | {\r |
820 | ASSERT ((IpSb != NULL) && (IpInstance != NULL));\r |
821 | \r |
e48e37fc |
822 | ZeroMem (IpInstance, sizeof (IP4_PROTOCOL));\r |
772db4bb |
823 | \r |
824 | IpInstance->Signature = IP4_PROTOCOL_SIGNATURE;\r |
687a2e5f |
825 | CopyMem (&IpInstance->Ip4Proto, &mEfiIp4ProtocolTemplete, sizeof (IpInstance->Ip4Proto));\r |
772db4bb |
826 | IpInstance->State = IP4_STATE_UNCONFIGED;\r |
827 | IpInstance->Service = IpSb;\r |
828 | \r |
e48e37fc |
829 | InitializeListHead (&IpInstance->Link);\r |
772db4bb |
830 | NetMapInit (&IpInstance->RxTokens);\r |
831 | NetMapInit (&IpInstance->TxTokens);\r |
e48e37fc |
832 | InitializeListHead (&IpInstance->Received);\r |
833 | InitializeListHead (&IpInstance->Delivered);\r |
834 | InitializeListHead (&IpInstance->AddrLink);\r |
772db4bb |
835 | \r |
e48e37fc |
836 | EfiInitializeLock (&IpInstance->RecycleLock, TPL_NOTIFY);\r |
772db4bb |
837 | }\r |
838 | \r |
839 | \r |
840 | /**\r |
841 | Configure the IP4 child. If the child is already configured,\r |
842 | change the configuration parameter. Otherwise configure it\r |
843 | for the first time. The caller should validate the configuration\r |
844 | before deliver them to it. It also don't do configure NULL.\r |
845 | \r |
3e8c18da |
846 | @param[in, out] IpInstance The IP4 child to configure.\r |
847 | @param[in] Config The configure data.\r |
772db4bb |
848 | \r |
849 | @retval EFI_SUCCESS The IP4 child is successfully configured.\r |
850 | @retval EFI_DEVICE_ERROR Failed to free the pending transive or to\r |
851 | configure underlying MNP or other errors.\r |
852 | @retval EFI_NO_MAPPING The IP4 child is configured to use default\r |
853 | address, but the default address hasn't been\r |
854 | configured. The IP4 child doesn't need to be\r |
855 | reconfigured when default address is configured.\r |
5405e9a6 |
856 | @retval EFI_OUT_OF_RESOURCES No more memory space is available.\r |
857 | @retval other Other error occurs.\r |
772db4bb |
858 | \r |
859 | **/\r |
860 | EFI_STATUS\r |
861 | Ip4ConfigProtocol (\r |
5405e9a6 |
862 | IN OUT IP4_PROTOCOL *IpInstance,\r |
863 | IN EFI_IP4_CONFIG_DATA *Config\r |
772db4bb |
864 | )\r |
865 | {\r |
866 | IP4_SERVICE *IpSb;\r |
867 | IP4_INTERFACE *IpIf;\r |
868 | EFI_STATUS Status;\r |
869 | IP4_ADDR Ip;\r |
870 | IP4_ADDR Netmask;\r |
871 | \r |
872 | IpSb = IpInstance->Service;\r |
873 | \r |
874 | //\r |
875 | // User is changing packet filters. It must be stopped\r |
876 | // before the station address can be changed.\r |
877 | //\r |
878 | if (IpInstance->State == IP4_STATE_CONFIGED) {\r |
879 | //\r |
880 | // Cancel all the pending transmit/receive from upper layer\r |
881 | //\r |
882 | Status = Ip4Cancel (IpInstance, NULL);\r |
883 | \r |
884 | if (EFI_ERROR (Status)) {\r |
885 | return EFI_DEVICE_ERROR;\r |
886 | }\r |
887 | \r |
687a2e5f |
888 | CopyMem (&IpInstance->ConfigData, Config, sizeof (IpInstance->ConfigData));\r |
772db4bb |
889 | return EFI_SUCCESS;\r |
890 | }\r |
891 | \r |
892 | //\r |
893 | // Configure a fresh IP4 protocol instance. Create a route table.\r |
894 | // Each IP child has its own route table, which may point to the\r |
895 | // default table if it is using default address.\r |
896 | //\r |
897 | Status = EFI_OUT_OF_RESOURCES;\r |
898 | IpInstance->RouteTable = Ip4CreateRouteTable ();\r |
899 | \r |
900 | if (IpInstance->RouteTable == NULL) {\r |
901 | return Status;\r |
902 | }\r |
903 | \r |
904 | //\r |
905 | // Set up the interface.\r |
906 | //\r |
e48e37fc |
907 | CopyMem (&Ip, &Config->StationAddress, sizeof (IP4_ADDR));\r |
908 | CopyMem (&Netmask, &Config->SubnetMask, sizeof (IP4_ADDR));\r |
772db4bb |
909 | \r |
910 | Ip = NTOHL (Ip);\r |
911 | Netmask = NTOHL (Netmask);\r |
912 | \r |
913 | if (!Config->UseDefaultAddress) {\r |
914 | //\r |
915 | // Find whether there is already an interface with the same\r |
916 | // station address. All the instances with the same station\r |
917 | // address shares one interface.\r |
918 | //\r |
919 | IpIf = Ip4FindStationAddress (IpSb, Ip, Netmask);\r |
920 | \r |
921 | if (IpIf != NULL) {\r |
922 | NET_GET_REF (IpIf);\r |
923 | \r |
924 | } else {\r |
925 | IpIf = Ip4CreateInterface (IpSb->Mnp, IpSb->Controller, IpSb->Image);\r |
926 | \r |
927 | if (IpIf == NULL) {\r |
928 | goto ON_ERROR;\r |
929 | }\r |
930 | \r |
931 | Status = Ip4SetAddress (IpIf, Ip, Netmask);\r |
932 | \r |
933 | if (EFI_ERROR (Status)) {\r |
934 | Status = EFI_DEVICE_ERROR;\r |
935 | Ip4FreeInterface (IpIf, IpInstance);\r |
936 | goto ON_ERROR;\r |
937 | }\r |
938 | \r |
e48e37fc |
939 | InsertTailList (&IpSb->Interfaces, &IpIf->Link);\r |
772db4bb |
940 | }\r |
941 | \r |
942 | //\r |
943 | // Add a route to this connected network in the route table\r |
944 | //\r |
945 | Ip4AddRoute (IpInstance->RouteTable, Ip, Netmask, IP4_ALLZERO_ADDRESS);\r |
946 | \r |
947 | } else {\r |
948 | //\r |
949 | // Use the default address. If the default configuration hasn't\r |
950 | // been started, start it.\r |
951 | //\r |
952 | if (IpSb->State == IP4_SERVICE_UNSTARTED) {\r |
953 | Status = Ip4StartAutoConfig (IpSb);\r |
954 | \r |
955 | if (EFI_ERROR (Status)) {\r |
956 | goto ON_ERROR;\r |
957 | }\r |
958 | }\r |
959 | \r |
960 | IpIf = IpSb->DefaultInterface;\r |
961 | NET_GET_REF (IpSb->DefaultInterface);\r |
962 | \r |
963 | //\r |
964 | // If default address is used, so is the default route table.\r |
965 | // Any route set by the instance has the precedence over the\r |
966 | // routes in the default route table. Link the default table\r |
967 | // after the instance's table. Routing will search the local\r |
968 | // table first.\r |
969 | //\r |
970 | NET_GET_REF (IpSb->DefaultRouteTable);\r |
971 | IpInstance->RouteTable->Next = IpSb->DefaultRouteTable;\r |
972 | }\r |
973 | \r |
974 | IpInstance->Interface = IpIf;\r |
e48e37fc |
975 | InsertTailList (&IpIf->IpInstances, &IpInstance->AddrLink);\r |
772db4bb |
976 | \r |
687a2e5f |
977 | CopyMem (&IpInstance->ConfigData, Config, sizeof (IpInstance->ConfigData));\r |
772db4bb |
978 | IpInstance->State = IP4_STATE_CONFIGED;\r |
979 | \r |
980 | //\r |
981 | // Although EFI_NO_MAPPING is an error code, the IP child has been\r |
982 | // successfully configured and doesn't need reconfiguration when\r |
983 | // default address is acquired.\r |
984 | //\r |
985 | if (Config->UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) {\r |
986 | return EFI_NO_MAPPING;\r |
987 | }\r |
988 | \r |
989 | return EFI_SUCCESS;\r |
990 | \r |
991 | ON_ERROR:\r |
992 | Ip4FreeRouteTable (IpInstance->RouteTable);\r |
993 | IpInstance->RouteTable = NULL;\r |
994 | return Status;\r |
995 | }\r |
996 | \r |
997 | \r |
998 | /**\r |
999 | Clean up the IP4 child, release all the resources used by it.\r |
1000 | \r |
3e8c18da |
1001 | @param[in] IpInstance The IP4 child to clean up.\r |
772db4bb |
1002 | \r |
1003 | @retval EFI_SUCCESS The IP4 child is cleaned up\r |
1004 | @retval EFI_DEVICE_ERROR Some resources failed to be released\r |
1005 | \r |
1006 | **/\r |
1007 | EFI_STATUS\r |
1008 | Ip4CleanProtocol (\r |
1009 | IN IP4_PROTOCOL *IpInstance\r |
1010 | )\r |
1011 | {\r |
1012 | if (EFI_ERROR (Ip4Cancel (IpInstance, NULL))) {\r |
1013 | return EFI_DEVICE_ERROR;\r |
1014 | }\r |
1015 | \r |
1016 | if (EFI_ERROR (Ip4Groups (IpInstance, FALSE, NULL))) {\r |
1017 | return EFI_DEVICE_ERROR;\r |
1018 | }\r |
1019 | \r |
1020 | //\r |
1021 | // Some packets haven't been recycled. It is because either the\r |
1022 | // user forgets to recycle the packets, or because the callback\r |
1023 | // hasn't been called. Just leave it alone.\r |
1024 | //\r |
e48e37fc |
1025 | if (!IsListEmpty (&IpInstance->Delivered)) {\r |
772db4bb |
1026 | ;\r |
1027 | }\r |
1028 | \r |
1029 | if (IpInstance->Interface != NULL) {\r |
e48e37fc |
1030 | RemoveEntryList (&IpInstance->AddrLink);\r |
772db4bb |
1031 | Ip4FreeInterface (IpInstance->Interface, IpInstance);\r |
1032 | IpInstance->Interface = NULL;\r |
1033 | }\r |
1034 | \r |
1035 | if (IpInstance->RouteTable != NULL) {\r |
1036 | if (IpInstance->RouteTable->Next != NULL) {\r |
1037 | Ip4FreeRouteTable (IpInstance->RouteTable->Next);\r |
1038 | }\r |
1039 | \r |
1040 | Ip4FreeRouteTable (IpInstance->RouteTable);\r |
1041 | IpInstance->RouteTable = NULL;\r |
1042 | }\r |
1043 | \r |
1044 | if (IpInstance->EfiRouteTable != NULL) {\r |
766c7483 |
1045 | FreePool (IpInstance->EfiRouteTable);\r |
772db4bb |
1046 | IpInstance->EfiRouteTable = NULL;\r |
1047 | IpInstance->EfiRouteCount = 0;\r |
1048 | }\r |
1049 | \r |
1050 | if (IpInstance->Groups != NULL) {\r |
766c7483 |
1051 | FreePool (IpInstance->Groups);\r |
772db4bb |
1052 | IpInstance->Groups = NULL;\r |
1053 | IpInstance->GroupCount = 0;\r |
1054 | }\r |
1055 | \r |
1056 | NetMapClean (&IpInstance->TxTokens);\r |
1057 | \r |
1058 | NetMapClean (&IpInstance->RxTokens);\r |
1059 | \r |
1060 | return EFI_SUCCESS;\r |
1061 | }\r |
1062 | \r |
1063 | \r |
1064 | /**\r |
1065 | Validate that Ip/Netmask pair is OK to be used as station\r |
1066 | address. Only continuous netmasks are supported. and check\r |
1067 | that StationAddress is a unicast address on the newtwork.\r |
1068 | \r |
3e8c18da |
1069 | @param[in] Ip The IP address to validate\r |
1070 | @param[in] Netmask The netmaks of the IP\r |
772db4bb |
1071 | \r |
1072 | @retval TRUE The Ip/Netmask pair is valid\r |
5405e9a6 |
1073 | @retval FALSE The Ip/Netmask pair is invalid\r |
772db4bb |
1074 | \r |
1075 | **/\r |
1076 | BOOLEAN\r |
1077 | Ip4StationAddressValid (\r |
1078 | IN IP4_ADDR Ip,\r |
1079 | IN IP4_ADDR Netmask\r |
1080 | )\r |
1081 | {\r |
1082 | IP4_ADDR NetBrdcastMask;\r |
1083 | INTN Len;\r |
1084 | INTN Type;\r |
1085 | \r |
1086 | //\r |
1087 | // Only support the station address with 0.0.0.0/0 to enable DHCP client.\r |
1088 | //\r |
1089 | if (Netmask == IP4_ALLZERO_ADDRESS) {\r |
1090 | return (BOOLEAN) (Ip == IP4_ALLZERO_ADDRESS);\r |
1091 | }\r |
1092 | \r |
1093 | //\r |
1094 | // Only support the continuous net masks\r |
1095 | //\r |
1096 | if ((Len = NetGetMaskLength (Netmask)) == IP4_MASK_NUM) {\r |
1097 | return FALSE;\r |
1098 | }\r |
1099 | \r |
1100 | //\r |
1101 | // Station address can't be class D or class E address\r |
1102 | //\r |
1103 | if ((Type = NetGetIpClass (Ip)) > IP4_ADDR_CLASSC) {\r |
1104 | return FALSE;\r |
1105 | }\r |
1106 | \r |
1107 | //\r |
1108 | // Station address can't be subnet broadcast/net broadcast address\r |
1109 | //\r |
1110 | if ((Ip == (Ip & Netmask)) || (Ip == (Ip | ~Netmask))) {\r |
1111 | return FALSE;\r |
1112 | }\r |
1113 | \r |
2a86ff1c |
1114 | NetBrdcastMask = gIp4AllMasks[MIN (Len, Type << 3)];\r |
772db4bb |
1115 | \r |
1116 | if (Ip == (Ip | ~NetBrdcastMask)) {\r |
1117 | return FALSE;\r |
1118 | }\r |
1119 | \r |
1120 | return TRUE;\r |
1121 | }\r |
1122 | \r |
1123 | \r |
1124 | /**\r |
5405e9a6 |
1125 | Assigns an IPv4 address and subnet mask to this EFI IPv4 Protocol driver instance.\r |
e2851998 |
1126 | \r |
5405e9a6 |
1127 | The Configure() function is used to set, change, or reset the operational\r |
1128 | parameters and filter settings for this EFI IPv4 Protocol instance. Until these\r |
1129 | parameters have been set, no network traffic can be sent or received by this\r |
1130 | instance. Once the parameters have been reset (by calling this function with\r |
1131 | IpConfigData set to NULL), no more traffic can be sent or received until these\r |
1132 | parameters have been set again. Each EFI IPv4 Protocol instance can be started\r |
1133 | and stopped independently of each other by enabling or disabling their receive\r |
1134 | filter settings with the Configure() function.\r |
e2851998 |
1135 | \r |
5405e9a6 |
1136 | When IpConfigData.UseDefaultAddress is set to FALSE, the new station address will\r |
1137 | be appended as an alias address into the addresses list in the EFI IPv4 Protocol\r |
1138 | driver. While set to TRUE, Configure() will trigger the EFI_IP4_CONFIG_PROTOCOL\r |
1139 | to retrieve the default IPv4 address if it is not available yet. Clients could\r |
1140 | frequently call GetModeData() to check the status to ensure that the default IPv4\r |
1141 | address is ready.\r |
e2851998 |
1142 | \r |
5405e9a6 |
1143 | If operational parameters are reset or changed, any pending transmit and receive\r |
1144 | requests will be cancelled. Their completion token status will be set to EFI_ABORTED\r |
1145 | and their events will be signaled.\r |
1146 | \r |
3e8c18da |
1147 | @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r |
1148 | @param[in] IpConfigData Pointer to the EFI IPv4 Protocol configuration data structure.\r |
5405e9a6 |
1149 | \r |
1150 | @retval EFI_SUCCESS The driver instance was successfully opened.\r |
1151 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r |
1152 | RARP, etc.) is not finished yet.\r |
1153 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r |
1154 | @retval EFI_UNSUPPORTED One or more of the following conditions is TRUE:\r |
1155 | A configuration protocol (DHCP, BOOTP, RARP, etc.) could\r |
1156 | not be located when clients choose to use the default IPv4\r |
1157 | address. This EFI IPv4 Protocol implementation does not\r |
1158 | support this requested filter or timeout setting.\r |
1159 | @retval EFI_OUT_OF_RESOURCES The EFI IPv4 Protocol driver instance data could not be allocated.\r |
1160 | @retval EFI_ALREADY_STARTED The interface is already open and must be stopped before the\r |
1161 | IPv4 address or subnet mask can be changed. The interface must\r |
1162 | also be stopped when switching to/from raw packet mode.\r |
1163 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI IPv4\r |
1164 | Protocol driver instance is not opened.\r |
772db4bb |
1165 | \r |
1166 | **/\r |
772db4bb |
1167 | EFI_STATUS\r |
1168 | EFIAPI\r |
1169 | EfiIp4Configure (\r |
1170 | IN EFI_IP4_PROTOCOL *This,\r |
1171 | IN EFI_IP4_CONFIG_DATA *IpConfigData OPTIONAL\r |
1172 | )\r |
1173 | {\r |
1174 | IP4_PROTOCOL *IpInstance;\r |
1175 | EFI_IP4_CONFIG_DATA *Current;\r |
1176 | EFI_TPL OldTpl;\r |
1177 | EFI_STATUS Status;\r |
1178 | BOOLEAN AddrOk;\r |
1179 | IP4_ADDR IpAddress;\r |
1180 | IP4_ADDR SubnetMask;\r |
1181 | \r |
1182 | //\r |
1183 | // First, validate the parameters\r |
1184 | //\r |
1185 | if (This == NULL) {\r |
1186 | return EFI_INVALID_PARAMETER;\r |
1187 | }\r |
1188 | \r |
1189 | IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This);\r |
e48e37fc |
1190 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r |
772db4bb |
1191 | \r |
1192 | //\r |
1193 | // Validate the configuration first.\r |
1194 | //\r |
1195 | if (IpConfigData != NULL) {\r |
1196 | //\r |
1197 | // This implementation doesn't support RawData\r |
1198 | //\r |
1199 | if (IpConfigData->RawData) {\r |
1200 | Status = EFI_UNSUPPORTED;\r |
1201 | goto ON_EXIT;\r |
1202 | }\r |
1203 | \r |
1204 | \r |
e48e37fc |
1205 | CopyMem (&IpAddress, &IpConfigData->StationAddress, sizeof (IP4_ADDR));\r |
1206 | CopyMem (&SubnetMask, &IpConfigData->SubnetMask, sizeof (IP4_ADDR));\r |
772db4bb |
1207 | \r |
1208 | IpAddress = NTOHL (IpAddress);\r |
1209 | SubnetMask = NTOHL (SubnetMask);\r |
1210 | \r |
1211 | //\r |
1212 | // Check whether the station address is a valid unicast address\r |
1213 | //\r |
1214 | if (!IpConfigData->UseDefaultAddress) {\r |
1215 | AddrOk = Ip4StationAddressValid (IpAddress, SubnetMask);\r |
1216 | \r |
1217 | if (!AddrOk) {\r |
1218 | Status = EFI_INVALID_PARAMETER;\r |
1219 | goto ON_EXIT;\r |
1220 | }\r |
1221 | }\r |
1222 | \r |
1223 | //\r |
1224 | // User can only update packet filters when already configured.\r |
1225 | // If it wants to change the station address, it must configure(NULL)\r |
1226 | // the instance first.\r |
1227 | //\r |
1228 | if (IpInstance->State == IP4_STATE_CONFIGED) {\r |
1229 | Current = &IpInstance->ConfigData;\r |
1230 | \r |
1231 | if (Current->UseDefaultAddress != IpConfigData->UseDefaultAddress) {\r |
1232 | Status = EFI_ALREADY_STARTED;\r |
1233 | goto ON_EXIT;\r |
1234 | }\r |
1235 | \r |
1236 | if (!Current->UseDefaultAddress &&\r |
84b5c78e |
1237 | (!EFI_IP4_EQUAL (&Current->StationAddress, &IpConfigData->StationAddress) ||\r |
1238 | !EFI_IP4_EQUAL (&Current->SubnetMask, &IpConfigData->SubnetMask))) {\r |
772db4bb |
1239 | Status = EFI_ALREADY_STARTED;\r |
1240 | goto ON_EXIT;\r |
1241 | }\r |
1242 | \r |
1243 | if (Current->UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) {\r |
ae0a0b06 |
1244 | Status = EFI_NO_MAPPING;\r |
1245 | goto ON_EXIT;\r |
772db4bb |
1246 | }\r |
1247 | }\r |
1248 | }\r |
1249 | \r |
1250 | //\r |
1251 | // Configure the instance or clean it up.\r |
1252 | //\r |
1253 | if (IpConfigData != NULL) {\r |
1254 | Status = Ip4ConfigProtocol (IpInstance, IpConfigData);\r |
1255 | } else {\r |
1256 | Status = Ip4CleanProtocol (IpInstance);\r |
1257 | \r |
1258 | //\r |
75dce340 |
1259 | // Don't change the state if it is DESTROY, consider the following\r |
772db4bb |
1260 | // valid sequence: Mnp is unloaded-->Ip Stopped-->Udp Stopped,\r |
1261 | // Configure (ThisIp, NULL). If the state is changed to UNCONFIGED,\r |
1262 | // the unload fails miserably.\r |
1263 | //\r |
1264 | if (IpInstance->State == IP4_STATE_CONFIGED) {\r |
1265 | IpInstance->State = IP4_STATE_UNCONFIGED;\r |
1266 | }\r |
1267 | }\r |
1268 | \r |
1269 | //\r |
1270 | // Update the MNP's configure data. Ip4ServiceConfigMnp will check\r |
1271 | // whether it is necessary to reconfigure the MNP.\r |
1272 | //\r |
1273 | Ip4ServiceConfigMnp (IpInstance->Service, FALSE);\r |
1274 | \r |
1275 | //\r |
1276 | // Update the variable data.\r |
1277 | //\r |
1278 | Ip4SetVariableData (IpInstance->Service);\r |
1279 | \r |
1280 | ON_EXIT:\r |
e48e37fc |
1281 | gBS->RestoreTPL (OldTpl);\r |
772db4bb |
1282 | return Status;\r |
1283 | \r |
1284 | }\r |
1285 | \r |
1286 | \r |
1287 | /**\r |
1288 | Change the IP4 child's multicast setting. The caller\r |
1289 | should make sure that the parameters is valid.\r |
1290 | \r |
3e8c18da |
1291 | @param[in] IpInstance The IP4 child to change the setting.\r |
1292 | @param[in] JoinFlag TRUE to join the group, otherwise leave it\r |
1293 | @param[in] GroupAddress The target group address\r |
772db4bb |
1294 | \r |
1295 | @retval EFI_ALREADY_STARTED Want to join the group, but already a member of it\r |
1296 | @retval EFI_OUT_OF_RESOURCES Failed to allocate some resources.\r |
1297 | @retval EFI_DEVICE_ERROR Failed to set the group configuraton\r |
1298 | @retval EFI_SUCCESS Successfully updated the group setting.\r |
1299 | @retval EFI_NOT_FOUND Try to leave the group which it isn't a member.\r |
1300 | \r |
1301 | **/\r |
1302 | EFI_STATUS\r |
1303 | Ip4Groups (\r |
1304 | IN IP4_PROTOCOL *IpInstance,\r |
1305 | IN BOOLEAN JoinFlag,\r |
1306 | IN EFI_IPv4_ADDRESS *GroupAddress OPTIONAL\r |
1307 | )\r |
1308 | {\r |
1309 | IP4_ADDR *Members;\r |
1310 | IP4_ADDR Group;\r |
1311 | UINT32 Index;\r |
1312 | \r |
1313 | //\r |
1314 | // Add it to the instance's Groups, and join the group by IGMP.\r |
1315 | // IpInstance->Groups is in network byte order. IGMP operates in\r |
1316 | // host byte order\r |
1317 | //\r |
1318 | if (JoinFlag) {\r |
e2851998 |
1319 | //\r |
894d038a |
1320 | // When JoinFlag is TRUE, GroupAddress shouldn't be NULL.\r |
1321 | //\r |
1322 | ASSERT (GroupAddress != NULL);\r |
e48e37fc |
1323 | CopyMem (&Group, GroupAddress, sizeof (IP4_ADDR));\r |
772db4bb |
1324 | \r |
1325 | for (Index = 0; Index < IpInstance->GroupCount; Index++) {\r |
1326 | if (IpInstance->Groups[Index] == Group) {\r |
1327 | return EFI_ALREADY_STARTED;\r |
1328 | }\r |
1329 | }\r |
1330 | \r |
1331 | Members = Ip4CombineGroups (IpInstance->Groups, IpInstance->GroupCount, Group);\r |
1332 | \r |
1333 | if (Members == NULL) {\r |
1334 | return EFI_OUT_OF_RESOURCES;\r |
1335 | }\r |
1336 | \r |
1337 | if (EFI_ERROR (Ip4JoinGroup (IpInstance, NTOHL (Group)))) {\r |
766c7483 |
1338 | FreePool (Members);\r |
772db4bb |
1339 | return EFI_DEVICE_ERROR;\r |
1340 | }\r |
1341 | \r |
1342 | if (IpInstance->Groups != NULL) {\r |
766c7483 |
1343 | FreePool (IpInstance->Groups);\r |
772db4bb |
1344 | }\r |
1345 | \r |
1346 | IpInstance->Groups = Members;\r |
1347 | IpInstance->GroupCount++;\r |
1348 | \r |
1349 | return EFI_SUCCESS;\r |
1350 | }\r |
1351 | \r |
1352 | //\r |
1353 | // Leave the group. Leave all the groups if GroupAddress is NULL.\r |
1354 | // Must iterate from the end to the beginning because the GroupCount\r |
1355 | // is decreamented each time an address is removed..\r |
1356 | //\r |
1357 | for (Index = IpInstance->GroupCount; Index > 0 ; Index--) {\r |
1358 | Group = IpInstance->Groups[Index - 1];\r |
1359 | \r |
84b5c78e |
1360 | if ((GroupAddress == NULL) || EFI_IP4_EQUAL (&Group, GroupAddress)) {\r |
772db4bb |
1361 | if (EFI_ERROR (Ip4LeaveGroup (IpInstance, NTOHL (Group)))) {\r |
1362 | return EFI_DEVICE_ERROR;\r |
1363 | }\r |
1364 | \r |
1365 | Ip4RemoveGroupAddr (IpInstance->Groups, IpInstance->GroupCount, Group);\r |
1366 | IpInstance->GroupCount--;\r |
1367 | \r |
1368 | if (IpInstance->GroupCount == 0) {\r |
1369 | ASSERT (Index == 1);\r |
1370 | \r |
766c7483 |
1371 | FreePool (IpInstance->Groups);\r |
772db4bb |
1372 | IpInstance->Groups = NULL;\r |
1373 | }\r |
1374 | \r |
1375 | if (GroupAddress != NULL) {\r |
1376 | return EFI_SUCCESS;\r |
1377 | }\r |
1378 | }\r |
1379 | }\r |
1380 | \r |
1381 | return ((GroupAddress != NULL) ? EFI_NOT_FOUND : EFI_SUCCESS);\r |
1382 | }\r |
1383 | \r |
1384 | \r |
1385 | /**\r |
5405e9a6 |
1386 | Joins and leaves multicast groups.\r |
e2851998 |
1387 | \r |
5405e9a6 |
1388 | The Groups() function is used to join and leave multicast group sessions. Joining\r |
1389 | a group will enable reception of matching multicast packets. Leaving a group will\r |
1390 | disable the multicast packet reception.\r |
e2851998 |
1391 | \r |
5405e9a6 |
1392 | If JoinFlag is FALSE and GroupAddress is NULL, all joined groups will be left.\r |
1393 | \r |
3e8c18da |
1394 | @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r |
1395 | @param[in] JoinFlag Set to TRUE to join the multicast group session and FALSE to leave.\r |
1396 | @param[in] GroupAddress Pointer to the IPv4 multicast address.\r |
5405e9a6 |
1397 | \r |
1398 | @retval EFI_SUCCESS The operation completed successfully.\r |
1399 | @retval EFI_INVALID_PARAMETER One or more of the following is TRUE:\r |
1400 | - This is NULL.\r |
1401 | - JoinFlag is TRUE and GroupAddress is NULL.\r |
1402 | - GroupAddress is not NULL and *GroupAddress is\r |
1403 | not a multicast IPv4 address.\r |
1404 | @retval EFI_NOT_STARTED This instance has not been started.\r |
1405 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r |
1406 | RARP, etc.) is not finished yet.\r |
1407 | @retval EFI_OUT_OF_RESOURCES System resources could not be allocated.\r |
1408 | @retval EFI_UNSUPPORTED This EFI IPv4 Protocol implementation does not support multicast groups.\r |
1409 | @retval EFI_ALREADY_STARTED The group address is already in the group table (when\r |
1410 | JoinFlag is TRUE).\r |
1411 | @retval EFI_NOT_FOUND The group address is not in the group table (when JoinFlag is FALSE).\r |
1412 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r |
772db4bb |
1413 | \r |
1414 | **/\r |
772db4bb |
1415 | EFI_STATUS\r |
1416 | EFIAPI\r |
1417 | EfiIp4Groups (\r |
1418 | IN EFI_IP4_PROTOCOL *This,\r |
1419 | IN BOOLEAN JoinFlag,\r |
1420 | IN EFI_IPv4_ADDRESS *GroupAddress OPTIONAL\r |
1421 | )\r |
1422 | {\r |
1423 | IP4_PROTOCOL *IpInstance;\r |
1424 | EFI_STATUS Status;\r |
1425 | EFI_TPL OldTpl;\r |
1426 | IP4_ADDR McastIp;\r |
1427 | \r |
1428 | if ((This == NULL) || (JoinFlag && (GroupAddress == NULL))) {\r |
1429 | return EFI_INVALID_PARAMETER;\r |
1430 | }\r |
1431 | \r |
1432 | if (GroupAddress != NULL) {\r |
e48e37fc |
1433 | CopyMem (&McastIp, GroupAddress, sizeof (IP4_ADDR));\r |
772db4bb |
1434 | \r |
1435 | if (!IP4_IS_MULTICAST (NTOHL (McastIp))) {\r |
1436 | return EFI_INVALID_PARAMETER;\r |
1437 | }\r |
1438 | }\r |
1439 | \r |
1440 | IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This);\r |
e48e37fc |
1441 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r |
772db4bb |
1442 | \r |
1443 | if (IpInstance->State != IP4_STATE_CONFIGED) {\r |
1444 | Status = EFI_NOT_STARTED;\r |
1445 | goto ON_EXIT;\r |
1446 | }\r |
1447 | \r |
1448 | if (IpInstance->ConfigData.UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) {\r |
1449 | Status = EFI_NO_MAPPING;\r |
1450 | goto ON_EXIT;\r |
1451 | }\r |
1452 | \r |
1453 | Status = Ip4Groups (IpInstance, JoinFlag, GroupAddress);\r |
1454 | \r |
1455 | ON_EXIT:\r |
e48e37fc |
1456 | gBS->RestoreTPL (OldTpl);\r |
772db4bb |
1457 | return Status;\r |
1458 | }\r |
1459 | \r |
1460 | \r |
1461 | /**\r |
5405e9a6 |
1462 | Adds and deletes routing table entries.\r |
1463 | \r |
1464 | The Routes() function adds a route to or deletes a route from the routing table.\r |
e2851998 |
1465 | \r |
5405e9a6 |
1466 | Routes are determined by comparing the SubnetAddress with the destination IPv4\r |
1467 | address arithmetically AND-ed with the SubnetMask. The gateway address must be\r |
1468 | on the same subnet as the configured station address.\r |
e2851998 |
1469 | \r |
5405e9a6 |
1470 | The default route is added with SubnetAddress and SubnetMask both set to 0.0.0.0.\r |
1471 | The default route matches all destination IPv4 addresses that do not match any\r |
1472 | other routes.\r |
e2851998 |
1473 | \r |
5405e9a6 |
1474 | A GatewayAddress that is zero is a nonroute. Packets are sent to the destination\r |
1475 | IP address if it can be found in the ARP cache or on the local subnet. One automatic\r |
1476 | nonroute entry will be inserted into the routing table for outgoing packets that\r |
1477 | are addressed to a local subnet (gateway address of 0.0.0.0).\r |
e2851998 |
1478 | \r |
5405e9a6 |
1479 | Each EFI IPv4 Protocol instance has its own independent routing table. Those EFI\r |
1480 | IPv4 Protocol instances that use the default IPv4 address will also have copies\r |
1481 | of the routing table that was provided by the EFI_IP4_CONFIG_PROTOCOL, and these\r |
1482 | copies will be updated whenever the EIF IPv4 Protocol driver reconfigures its\r |
1483 | instances. As a result, client modification to the routing table will be lost.\r |
1484 | \r |
3e8c18da |
1485 | @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r |
1486 | @param[in] DeleteRoute Set to TRUE to delete this route from the routing table. Set to\r |
1487 | FALSE to add this route to the routing table. SubnetAddress\r |
1488 | and SubnetMask are used as the key to each route entry.\r |
1489 | @param[in] SubnetAddress The address of the subnet that needs to be routed.\r |
1490 | @param[in] SubnetMask The subnet mask of SubnetAddress.\r |
1491 | @param[in] GatewayAddress The unicast gateway IPv4 address for this route.\r |
5405e9a6 |
1492 | \r |
1493 | @retval EFI_SUCCESS The operation completed successfully.\r |
1494 | @retval EFI_NOT_STARTED The driver instance has not been started.\r |
1495 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r |
1496 | RARP, etc.) is not finished yet.\r |
1497 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r |
1498 | - This is NULL.\r |
1499 | - SubnetAddress is NULL.\r |
1500 | - SubnetMask is NULL.\r |
1501 | - GatewayAddress is NULL.\r |
1502 | - *SubnetAddress is not a valid subnet address.\r |
1503 | - *SubnetMask is not a valid subnet mask.\r |
1504 | - *GatewayAddress is not a valid unicast IPv4 address.\r |
1505 | @retval EFI_OUT_OF_RESOURCES Could not add the entry to the routing table.\r |
1506 | @retval EFI_NOT_FOUND This route is not in the routing table (when DeleteRoute is TRUE).\r |
1507 | @retval EFI_ACCESS_DENIED The route is already defined in the routing table (when\r |
1508 | DeleteRoute is FALSE).\r |
e2851998 |
1509 | \r |
772db4bb |
1510 | **/\r |
772db4bb |
1511 | EFI_STATUS\r |
1512 | EFIAPI\r |
1513 | EfiIp4Routes (\r |
1514 | IN EFI_IP4_PROTOCOL *This,\r |
1515 | IN BOOLEAN DeleteRoute,\r |
1516 | IN EFI_IPv4_ADDRESS *SubnetAddress,\r |
1517 | IN EFI_IPv4_ADDRESS *SubnetMask,\r |
1518 | IN EFI_IPv4_ADDRESS *GatewayAddress\r |
1519 | )\r |
1520 | {\r |
1521 | IP4_PROTOCOL *IpInstance;\r |
1522 | IP4_INTERFACE *IpIf;\r |
1523 | IP4_ADDR Dest;\r |
1524 | IP4_ADDR Netmask;\r |
1525 | IP4_ADDR Nexthop;\r |
1526 | EFI_STATUS Status;\r |
1527 | EFI_TPL OldTpl;\r |
1528 | \r |
1529 | //\r |
1530 | // First, validate the parameters\r |
1531 | //\r |
1532 | if ((This == NULL) || (SubnetAddress == NULL) ||\r |
1533 | (SubnetMask == NULL) || (GatewayAddress == NULL)) {\r |
1534 | return EFI_INVALID_PARAMETER;\r |
1535 | }\r |
1536 | \r |
1537 | IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This);\r |
e48e37fc |
1538 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r |
772db4bb |
1539 | \r |
1540 | if (IpInstance->State != IP4_STATE_CONFIGED) {\r |
1541 | Status = EFI_NOT_STARTED;\r |
1542 | goto ON_EXIT;\r |
1543 | }\r |
1544 | \r |
1545 | if (IpInstance->ConfigData.UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) {\r |
1546 | Status = EFI_NO_MAPPING;\r |
1547 | goto ON_EXIT;\r |
1548 | }\r |
1549 | \r |
e48e37fc |
1550 | CopyMem (&Dest, SubnetAddress, sizeof (IP4_ADDR));\r |
1551 | CopyMem (&Netmask, SubnetMask, sizeof (IP4_ADDR));\r |
1552 | CopyMem (&Nexthop, GatewayAddress, sizeof (IP4_ADDR));\r |
772db4bb |
1553 | \r |
1554 | Dest = NTOHL (Dest);\r |
1555 | Netmask = NTOHL (Netmask);\r |
1556 | Nexthop = NTOHL (Nexthop);\r |
1557 | \r |
1558 | IpIf = IpInstance->Interface;\r |
1559 | \r |
1560 | if (!IP4_IS_VALID_NETMASK (Netmask)) {\r |
1561 | Status = EFI_INVALID_PARAMETER;\r |
1562 | goto ON_EXIT;\r |
1563 | }\r |
1564 | \r |
1565 | //\r |
1566 | // the gateway address must be a unicast on the connected network if not zero.\r |
1567 | //\r |
1568 | if ((Nexthop != IP4_ALLZERO_ADDRESS) &&\r |
1569 | (!IP4_NET_EQUAL (Nexthop, IpIf->Ip, IpIf->SubnetMask) ||\r |
1570 | IP4_IS_BROADCAST (Ip4GetNetCast (Nexthop, IpIf)))) {\r |
1571 | \r |
1572 | Status = EFI_INVALID_PARAMETER;\r |
1573 | goto ON_EXIT;\r |
1574 | }\r |
1575 | \r |
1576 | if (DeleteRoute) {\r |
1577 | Status = Ip4DelRoute (IpInstance->RouteTable, Dest, Netmask, Nexthop);\r |
1578 | } else {\r |
1579 | Status = Ip4AddRoute (IpInstance->RouteTable, Dest, Netmask, Nexthop);\r |
1580 | }\r |
1581 | \r |
1582 | ON_EXIT:\r |
e48e37fc |
1583 | gBS->RestoreTPL (OldTpl);\r |
772db4bb |
1584 | return Status;\r |
1585 | }\r |
1586 | \r |
1587 | \r |
1588 | /**\r |
1589 | Check whether the user's token or event has already\r |
5405e9a6 |
1590 | been enqueued on IP4's list.\r |
772db4bb |
1591 | \r |
3e8c18da |
1592 | @param[in] Map The container of either user's transmit or receive\r |
1593 | token.\r |
1594 | @param[in] Item Current item to check against\r |
1595 | @param[in] Context The Token to check againist.\r |
772db4bb |
1596 | \r |
1597 | @retval EFI_ACCESS_DENIED The token or event has already been enqueued in IP\r |
1598 | @retval EFI_SUCCESS The current item isn't the same token/event as the\r |
1599 | context.\r |
1600 | \r |
1601 | **/\r |
772db4bb |
1602 | EFI_STATUS\r |
e798cd87 |
1603 | EFIAPI\r |
772db4bb |
1604 | Ip4TokenExist (\r |
1605 | IN NET_MAP *Map,\r |
1606 | IN NET_MAP_ITEM *Item,\r |
1607 | IN VOID *Context\r |
1608 | )\r |
1609 | {\r |
1610 | EFI_IP4_COMPLETION_TOKEN *Token;\r |
1611 | EFI_IP4_COMPLETION_TOKEN *TokenInItem;\r |
1612 | \r |
1613 | Token = (EFI_IP4_COMPLETION_TOKEN *) Context;\r |
1614 | TokenInItem = (EFI_IP4_COMPLETION_TOKEN *) Item->Key;\r |
1615 | \r |
1616 | if ((Token == TokenInItem) || (Token->Event == TokenInItem->Event)) {\r |
1617 | return EFI_ACCESS_DENIED;\r |
1618 | }\r |
1619 | \r |
1620 | return EFI_SUCCESS;\r |
1621 | }\r |
1622 | \r |
1623 | \r |
1624 | /**\r |
1625 | Validate the user's token against current station address.\r |
1626 | \r |
3e8c18da |
1627 | @param[in] Token User's token to validate\r |
1628 | @param[in] IpIf The IP4 child's interface.\r |
772db4bb |
1629 | \r |
1630 | @retval EFI_INVALID_PARAMETER Some parameters are invalid\r |
1631 | @retval EFI_BAD_BUFFER_SIZE The user's option/data is too long.\r |
1632 | @retval EFI_SUCCESS The token is OK\r |
1633 | \r |
1634 | **/\r |
772db4bb |
1635 | EFI_STATUS\r |
1636 | Ip4TxTokenValid (\r |
1637 | IN EFI_IP4_COMPLETION_TOKEN *Token,\r |
1638 | IN IP4_INTERFACE *IpIf\r |
1639 | )\r |
1640 | {\r |
1641 | EFI_IP4_TRANSMIT_DATA *TxData;\r |
1642 | EFI_IP4_OVERRIDE_DATA *Override;\r |
1643 | IP4_ADDR Src;\r |
1644 | IP4_ADDR Gateway;\r |
1645 | UINT32 Offset;\r |
1646 | UINT32 Index;\r |
1647 | UINT32 HeadLen;\r |
1648 | \r |
1649 | if ((Token == NULL) || (Token->Event == NULL) || (Token->Packet.TxData == NULL)) {\r |
1650 | return EFI_INVALID_PARAMETER;\r |
1651 | }\r |
1652 | \r |
1653 | TxData = Token->Packet.TxData;\r |
1654 | \r |
1655 | //\r |
1656 | // Check the IP options: no more than 40 bytes and format is OK\r |
1657 | //\r |
1658 | if (TxData->OptionsLength != 0) {\r |
1659 | if ((TxData->OptionsLength > 40) || (TxData->OptionsBuffer == NULL)) {\r |
1660 | return EFI_INVALID_PARAMETER;\r |
1661 | }\r |
1662 | \r |
1663 | if (!Ip4OptionIsValid (TxData->OptionsBuffer, TxData->OptionsLength, FALSE)) {\r |
1664 | return EFI_INVALID_PARAMETER;\r |
1665 | }\r |
1666 | }\r |
1667 | \r |
1668 | //\r |
1669 | // Check the fragment table: no empty fragment, and length isn't bogus\r |
1670 | //\r |
1671 | if ((TxData->TotalDataLength == 0) || (TxData->FragmentCount == 0)) {\r |
1672 | return EFI_INVALID_PARAMETER;\r |
1673 | }\r |
1674 | \r |
1675 | Offset = TxData->TotalDataLength;\r |
1676 | \r |
1677 | for (Index = 0; Index < TxData->FragmentCount; Index++) {\r |
1678 | if ((TxData->FragmentTable[Index].FragmentBuffer == NULL) ||\r |
1679 | (TxData->FragmentTable[Index].FragmentLength == 0)) {\r |
1680 | \r |
1681 | return EFI_INVALID_PARAMETER;\r |
1682 | }\r |
1683 | \r |
1684 | Offset -= TxData->FragmentTable[Index].FragmentLength;\r |
1685 | }\r |
1686 | \r |
1687 | if (Offset != 0) {\r |
1688 | return EFI_INVALID_PARAMETER;\r |
1689 | }\r |
1690 | \r |
1691 | //\r |
1692 | // Check the source and gateway: they must be a valid unicast.\r |
1693 | // Gateway must also be on the connected network.\r |
1694 | //\r |
e2851998 |
1695 | if (TxData->OverrideData != NULL) {\r |
772db4bb |
1696 | Override = TxData->OverrideData;\r |
1697 | \r |
e48e37fc |
1698 | CopyMem (&Src, &Override->SourceAddress, sizeof (IP4_ADDR));\r |
1699 | CopyMem (&Gateway, &Override->GatewayAddress, sizeof (IP4_ADDR));\r |
772db4bb |
1700 | \r |
1701 | Src = NTOHL (Src);\r |
1702 | Gateway = NTOHL (Gateway);\r |
1703 | \r |
1704 | if ((NetGetIpClass (Src) > IP4_ADDR_CLASSC) ||\r |
1705 | (Src == IP4_ALLONE_ADDRESS) ||\r |
1706 | IP4_IS_BROADCAST (Ip4GetNetCast (Src, IpIf))) {\r |
1707 | \r |
1708 | return EFI_INVALID_PARAMETER;\r |
1709 | }\r |
1710 | \r |
1711 | //\r |
1712 | // If gateway isn't zero, it must be a unicast address, and\r |
1713 | // on the connected network.\r |
1714 | //\r |
1715 | if ((Gateway != IP4_ALLZERO_ADDRESS) &&\r |
1716 | ((NetGetIpClass (Gateway) > IP4_ADDR_CLASSC) ||\r |
1717 | !IP4_NET_EQUAL (Gateway, IpIf->Ip, IpIf->SubnetMask) ||\r |
1718 | IP4_IS_BROADCAST (Ip4GetNetCast (Gateway, IpIf)))) {\r |
1719 | \r |
1720 | return EFI_INVALID_PARAMETER;\r |
1721 | }\r |
1722 | }\r |
1723 | \r |
1724 | //\r |
1725 | // Check the packet length: Head length and packet length all has a limit\r |
1726 | //\r |
1727 | HeadLen = sizeof (IP4_HEAD) + ((TxData->OptionsLength + 3) &~0x03);\r |
1728 | \r |
1729 | if ((HeadLen > IP4_MAX_HEADLEN) ||\r |
1730 | (TxData->TotalDataLength + HeadLen > IP4_MAX_PACKET_SIZE)) {\r |
1731 | \r |
1732 | return EFI_BAD_BUFFER_SIZE;\r |
1733 | }\r |
1734 | \r |
1735 | return EFI_SUCCESS;\r |
1736 | }\r |
1737 | \r |
1738 | \r |
1739 | /**\r |
1740 | The callback function for the net buffer which wraps the user's\r |
1741 | transmit token. Although it seems this function is pretty simple,\r |
1742 | there are some subtle things.\r |
1743 | When user requests the IP to transmit a packet by passing it a\r |
1744 | token, the token is wrapped in an IP4_TXTOKEN_WRAP and the data\r |
1745 | is wrapped in an net buffer. the net buffer's Free function is\r |
1746 | set to Ip4FreeTxToken. The Token and token wrap are added to the\r |
1747 | IP child's TxToken map. Then the buffer is passed to Ip4Output for\r |
1748 | transmission. If something error happened before that, the buffer\r |
1749 | is freed, which in turn will free the token wrap. The wrap may\r |
1750 | have been added to the TxToken map or not, and the user's event\r |
1751 | shouldn't be fired because we are still in the EfiIp4Transmit. If\r |
1752 | the buffer has been sent by Ip4Output, it should be removed from\r |
1753 | the TxToken map and user's event signaled. The token wrap and buffer\r |
1754 | are bound together. Check the comments in Ip4Output for information\r |
1755 | about IP fragmentation.\r |
1756 | \r |
3e8c18da |
1757 | @param[in] Context The token's wrap\r |
772db4bb |
1758 | \r |
1759 | **/\r |
772db4bb |
1760 | VOID\r |
e798cd87 |
1761 | EFIAPI\r |
772db4bb |
1762 | Ip4FreeTxToken (\r |
1763 | IN VOID *Context\r |
1764 | )\r |
1765 | {\r |
1766 | IP4_TXTOKEN_WRAP *Wrap;\r |
1767 | NET_MAP_ITEM *Item;\r |
1768 | \r |
1769 | Wrap = (IP4_TXTOKEN_WRAP *) Context;\r |
1770 | \r |
a1503a32 |
1771 | //\r |
1772 | // Signal IpSecRecycleEvent to inform IPsec free the memory\r |
1773 | //\r |
1774 | if (Wrap->IpSecRecycleSignal != NULL) {\r |
1775 | gBS->SignalEvent (Wrap->IpSecRecycleSignal);\r |
1776 | }\r |
1777 | \r |
772db4bb |
1778 | //\r |
1779 | // Find the token in the instance's map. EfiIp4Transmit put the\r |
1780 | // token to the map. If that failed, NetMapFindKey will return NULL.\r |
1781 | //\r |
1782 | Item = NetMapFindKey (&Wrap->IpInstance->TxTokens, Wrap->Token);\r |
1783 | \r |
1784 | if (Item != NULL) {\r |
1785 | NetMapRemoveItem (&Wrap->IpInstance->TxTokens, Item, NULL);\r |
1786 | }\r |
1787 | \r |
1788 | if (Wrap->Sent) {\r |
1789 | gBS->SignalEvent (Wrap->Token->Event);\r |
36ee91ca |
1790 | \r |
1791 | //\r |
1792 | // Dispatch the DPC queued by the NotifyFunction of Token->Event.\r |
1793 | //\r |
d8d26fb2 |
1794 | DispatchDpc ();\r |
772db4bb |
1795 | }\r |
1796 | \r |
766c7483 |
1797 | FreePool (Wrap);\r |
772db4bb |
1798 | }\r |
1799 | \r |
1800 | \r |
1801 | /**\r |
1802 | The callback function to Ip4Output to update the transmit status.\r |
1803 | \r |
1804 | @param Ip4Instance The Ip4Instance that request the transmit.\r |
1805 | @param Packet The user's transmit request\r |
1806 | @param IoStatus The result of the transmission\r |
1807 | @param Flag Not used during transmission\r |
1808 | @param Context The token's wrap.\r |
1809 | \r |
772db4bb |
1810 | **/\r |
772db4bb |
1811 | VOID\r |
1812 | Ip4OnPacketSent (\r |
1813 | IP4_PROTOCOL *Ip4Instance,\r |
1814 | NET_BUF *Packet,\r |
1815 | EFI_STATUS IoStatus,\r |
1816 | UINT32 Flag,\r |
1817 | VOID *Context\r |
1818 | )\r |
1819 | {\r |
1820 | IP4_TXTOKEN_WRAP *Wrap;\r |
1821 | \r |
1822 | //\r |
1823 | // This is the transmission request from upper layer,\r |
1824 | // not the IP4 driver itself.\r |
1825 | //\r |
1826 | ASSERT (Ip4Instance != NULL);\r |
1827 | \r |
1828 | //\r |
1829 | // The first fragment of the packet has been sent. Update\r |
1830 | // the token's status. That is, if fragmented, the transmit's\r |
1831 | // status is the first fragment's status. The Wrap will be\r |
1832 | // release when all the fragments are release. Check the comments\r |
1833 | // in Ip4FreeTxToken and Ip4Output for information.\r |
1834 | //\r |
1835 | Wrap = (IP4_TXTOKEN_WRAP *) Context;\r |
1836 | Wrap->Token->Status = IoStatus;\r |
1837 | \r |
1838 | NetbufFree (Wrap->Packet);\r |
1839 | }\r |
1840 | \r |
1841 | \r |
1842 | /**\r |
5405e9a6 |
1843 | Places outgoing data packets into the transmit queue.\r |
1844 | \r |
1845 | The Transmit() function places a sending request in the transmit queue of this\r |
1846 | EFI IPv4 Protocol instance. Whenever the packet in the token is sent out or some\r |
1847 | errors occur, the event in the token will be signaled and the status is updated.\r |
1848 | \r |
3e8c18da |
1849 | @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r |
1850 | @param[in] Token Pointer to the transmit token.\r |
5405e9a6 |
1851 | \r |
1852 | @retval EFI_SUCCESS The data has been queued for transmission.\r |
1853 | @retval EFI_NOT_STARTED This instance has not been started.\r |
1854 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r |
1855 | RARP, etc.) is not finished yet.\r |
1856 | @retval EFI_INVALID_PARAMETER One or more pameters are invalid.\r |
1857 | @retval EFI_ACCESS_DENIED The transmit completion token with the same Token.Event\r |
1858 | was already in the transmit queue.\r |
1859 | @retval EFI_NOT_READY The completion token could not be queued because the transmit\r |
e2851998 |
1860 | queue is full.\r |
5405e9a6 |
1861 | @retval EFI_NOT_FOUND Not route is found to destination address.\r |
1862 | @retval EFI_OUT_OF_RESOURCES Could not queue the transmit data.\r |
1863 | @retval EFI_BUFFER_TOO_SMALL Token.Packet.TxData.TotalDataLength is too\r |
1864 | short to transmit.\r |
1865 | @retval EFI_BAD_BUFFER_SIZE The length of the IPv4 header + option length + total data length is\r |
1866 | greater than MTU (or greater than the maximum packet size if\r |
1867 | Token.Packet.TxData.OverrideData.\r |
1868 | DoNotFragment is TRUE.)\r |
772db4bb |
1869 | \r |
1870 | **/\r |
772db4bb |
1871 | EFI_STATUS\r |
1872 | EFIAPI\r |
1873 | EfiIp4Transmit (\r |
1874 | IN EFI_IP4_PROTOCOL *This,\r |
1875 | IN EFI_IP4_COMPLETION_TOKEN *Token\r |
1876 | )\r |
1877 | {\r |
1878 | IP4_SERVICE *IpSb;\r |
1879 | IP4_PROTOCOL *IpInstance;\r |
1880 | IP4_INTERFACE *IpIf;\r |
1881 | IP4_TXTOKEN_WRAP *Wrap;\r |
1882 | EFI_IP4_TRANSMIT_DATA *TxData;\r |
1883 | EFI_IP4_CONFIG_DATA *Config;\r |
1884 | EFI_IP4_OVERRIDE_DATA *Override;\r |
1885 | IP4_HEAD Head;\r |
1886 | IP4_ADDR GateWay;\r |
1887 | EFI_STATUS Status;\r |
1888 | EFI_TPL OldTpl;\r |
1889 | BOOLEAN DontFragment;\r |
1890 | UINT32 HeadLen;\r |
1891 | \r |
1892 | if (This == NULL) {\r |
1893 | return EFI_INVALID_PARAMETER;\r |
1894 | }\r |
1895 | \r |
1896 | IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This);\r |
1897 | \r |
1898 | if (IpInstance->State != IP4_STATE_CONFIGED) {\r |
1899 | return EFI_NOT_STARTED;\r |
1900 | }\r |
1901 | \r |
e48e37fc |
1902 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r |
772db4bb |
1903 | \r |
1904 | IpSb = IpInstance->Service;\r |
1905 | IpIf = IpInstance->Interface;\r |
1906 | Config = &IpInstance->ConfigData;\r |
1907 | \r |
1908 | if (Config->UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) {\r |
1909 | Status = EFI_NO_MAPPING;\r |
1910 | goto ON_EXIT;\r |
1911 | }\r |
1912 | \r |
1913 | //\r |
1914 | // make sure that token is properly formated\r |
1915 | //\r |
1916 | Status = Ip4TxTokenValid (Token, IpIf);\r |
1917 | \r |
1918 | if (EFI_ERROR (Status)) {\r |
1919 | goto ON_EXIT;\r |
1920 | }\r |
1921 | \r |
1922 | //\r |
1923 | // Check whether the token or signal already existed.\r |
1924 | //\r |
1925 | if (EFI_ERROR (NetMapIterate (&IpInstance->TxTokens, Ip4TokenExist, Token))) {\r |
1926 | Status = EFI_ACCESS_DENIED;\r |
1927 | goto ON_EXIT;\r |
1928 | }\r |
1929 | \r |
1930 | //\r |
1931 | // Build the IP header, need to fill in the Tos, TotalLen, Id,\r |
1932 | // fragment, Ttl, protocol, Src, and Dst.\r |
1933 | //\r |
1934 | TxData = Token->Packet.TxData;\r |
1935 | \r |
e48e37fc |
1936 | CopyMem (&Head.Dst, &TxData->DestinationAddress, sizeof (IP4_ADDR));\r |
772db4bb |
1937 | Head.Dst = NTOHL (Head.Dst);\r |
1938 | \r |
e2851998 |
1939 | if (TxData->OverrideData != NULL) {\r |
772db4bb |
1940 | Override = TxData->OverrideData;\r |
1941 | Head.Protocol = Override->Protocol;\r |
1942 | Head.Tos = Override->TypeOfService;\r |
1943 | Head.Ttl = Override->TimeToLive;\r |
1944 | DontFragment = Override->DoNotFragment;\r |
1945 | \r |
e48e37fc |
1946 | CopyMem (&Head.Src, &Override->SourceAddress, sizeof (IP4_ADDR));\r |
1947 | CopyMem (&GateWay, &Override->GatewayAddress, sizeof (IP4_ADDR));\r |
772db4bb |
1948 | \r |
1949 | Head.Src = NTOHL (Head.Src);\r |
1950 | GateWay = NTOHL (GateWay);\r |
1951 | } else {\r |
1952 | Head.Src = IpIf->Ip;\r |
1953 | GateWay = IP4_ALLZERO_ADDRESS;\r |
1954 | Head.Protocol = Config->DefaultProtocol;\r |
1955 | Head.Tos = Config->TypeOfService;\r |
1956 | Head.Ttl = Config->TimeToLive;\r |
1957 | DontFragment = Config->DoNotFragment;\r |
1958 | }\r |
1959 | \r |
1960 | Head.Fragment = IP4_HEAD_FRAGMENT_FIELD (DontFragment, FALSE, 0);\r |
a1503a32 |
1961 | HeadLen = (TxData->OptionsLength + 3) & (~0x03);\r |
772db4bb |
1962 | \r |
1963 | //\r |
1964 | // If don't fragment and fragment needed, return error\r |
1965 | //\r |
a1503a32 |
1966 | if (DontFragment && (TxData->TotalDataLength + HeadLen > IpSb->MaxPacketSize)) {\r |
772db4bb |
1967 | Status = EFI_BAD_BUFFER_SIZE;\r |
1968 | goto ON_EXIT;\r |
1969 | }\r |
1970 | \r |
1971 | //\r |
1972 | // OK, it survives all the validation check. Wrap the token in\r |
1973 | // a IP4_TXTOKEN_WRAP and the data in a netbuf\r |
1974 | //\r |
1975 | Status = EFI_OUT_OF_RESOURCES;\r |
f6b7393c |
1976 | Wrap = AllocateZeroPool (sizeof (IP4_TXTOKEN_WRAP));\r |
772db4bb |
1977 | if (Wrap == NULL) {\r |
1978 | goto ON_EXIT;\r |
1979 | }\r |
1980 | \r |
1981 | Wrap->IpInstance = IpInstance;\r |
1982 | Wrap->Token = Token;\r |
1983 | Wrap->Sent = FALSE;\r |
1984 | Wrap->Life = IP4_US_TO_SEC (Config->TransmitTimeout);\r |
1985 | Wrap->Packet = NetbufFromExt (\r |
1986 | (NET_FRAGMENT *) TxData->FragmentTable,\r |
1987 | TxData->FragmentCount,\r |
1988 | IP4_MAX_HEADLEN,\r |
1989 | 0,\r |
1990 | Ip4FreeTxToken,\r |
1991 | Wrap\r |
1992 | );\r |
1993 | \r |
1994 | if (Wrap->Packet == NULL) {\r |
766c7483 |
1995 | FreePool (Wrap);\r |
772db4bb |
1996 | goto ON_EXIT;\r |
1997 | }\r |
1998 | \r |
1999 | Token->Status = EFI_NOT_READY;\r |
2000 | \r |
2001 | if (EFI_ERROR (NetMapInsertTail (&IpInstance->TxTokens, Token, Wrap))) {\r |
2002 | //\r |
2003 | // NetbufFree will call Ip4FreeTxToken, which in turn will\r |
2004 | // free the IP4_TXTOKEN_WRAP. Now, the token wrap hasn't been\r |
2005 | // enqueued.\r |
2006 | //\r |
2007 | NetbufFree (Wrap->Packet);\r |
2008 | goto ON_EXIT;\r |
2009 | }\r |
2010 | \r |
36ee91ca |
2011 | //\r |
2012 | // Mark the packet sent before output it. Mark it not sent again if the\r |
2013 | // returned status is not EFI_SUCCESS;\r |
2014 | //\r |
2015 | Wrap->Sent = TRUE;\r |
2016 | \r |
772db4bb |
2017 | Status = Ip4Output (\r |
2018 | IpSb,\r |
2019 | IpInstance,\r |
2020 | Wrap->Packet,\r |
2021 | &Head,\r |
2022 | TxData->OptionsBuffer,\r |
2023 | TxData->OptionsLength,\r |
2024 | GateWay,\r |
2025 | Ip4OnPacketSent,\r |
2026 | Wrap\r |
2027 | );\r |
2028 | \r |
2029 | if (EFI_ERROR (Status)) {\r |
36ee91ca |
2030 | Wrap->Sent = FALSE;\r |
772db4bb |
2031 | NetbufFree (Wrap->Packet);\r |
772db4bb |
2032 | }\r |
2033 | \r |
772db4bb |
2034 | ON_EXIT:\r |
e48e37fc |
2035 | gBS->RestoreTPL (OldTpl);\r |
772db4bb |
2036 | return Status;\r |
2037 | }\r |
2038 | \r |
2039 | \r |
2040 | /**\r |
5405e9a6 |
2041 | Places a receiving request into the receiving queue.\r |
e2851998 |
2042 | \r |
5405e9a6 |
2043 | The Receive() function places a completion token into the receive packet queue.\r |
2044 | This function is always asynchronous.\r |
e2851998 |
2045 | \r |
5405e9a6 |
2046 | The Token.Event field in the completion token must be filled in by the caller\r |
2047 | and cannot be NULL. When the receive operation completes, the EFI IPv4 Protocol\r |
2048 | driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event\r |
2049 | is signaled.\r |
2050 | \r |
3e8c18da |
2051 | @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r |
2052 | @param[in] Token Pointer to a token that is associated with the receive data descriptor.\r |
5405e9a6 |
2053 | \r |
2054 | @retval EFI_SUCCESS The receive completion token was cached.\r |
2055 | @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.\r |
2056 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, RARP, etc.)\r |
2057 | is not finished yet.\r |
2058 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r |
2059 | - This is NULL.\r |
2060 | - Token is NULL.\r |
2061 | - Token.Event is NULL.\r |
2062 | @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system\r |
2063 | resources (usually memory).\r |
2064 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r |
2065 | The EFI IPv4 Protocol instance has been reset to startup defaults.\r |
2066 | EFI_ACCESS_DENIED The receive completion token with the same Token.Event was already\r |
2067 | in the receive queue.\r |
2068 | @retval EFI_NOT_READY The receive request could not be queued because the receive queue is full.\r |
2069 | @retval EFI_ICMP_ERROR An ICMP error packet was received.\r |
772db4bb |
2070 | \r |
2071 | **/\r |
772db4bb |
2072 | EFI_STATUS\r |
2073 | EFIAPI\r |
2074 | EfiIp4Receive (\r |
2075 | IN EFI_IP4_PROTOCOL *This,\r |
2076 | IN EFI_IP4_COMPLETION_TOKEN *Token\r |
2077 | )\r |
2078 | {\r |
2079 | IP4_PROTOCOL *IpInstance;\r |
772db4bb |
2080 | EFI_STATUS Status;\r |
2081 | EFI_TPL OldTpl;\r |
2082 | \r |
2083 | //\r |
2084 | // First validate the parameters\r |
2085 | //\r |
2086 | if ((This == NULL) || (Token == NULL) || (Token->Event == NULL)) {\r |
2087 | return EFI_INVALID_PARAMETER;\r |
2088 | }\r |
2089 | \r |
2090 | IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This);\r |
2091 | \r |
e48e37fc |
2092 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r |
772db4bb |
2093 | \r |
2094 | if (IpInstance->State != IP4_STATE_CONFIGED) {\r |
2095 | Status = EFI_NOT_STARTED;\r |
2096 | goto ON_EXIT;\r |
2097 | }\r |
2098 | \r |
772db4bb |
2099 | //\r |
2100 | // Check whether the toke is already on the receive queue.\r |
2101 | //\r |
2102 | Status = NetMapIterate (&IpInstance->RxTokens, Ip4TokenExist, Token);\r |
2103 | \r |
2104 | if (EFI_ERROR (Status)) {\r |
2105 | Status = EFI_ACCESS_DENIED;\r |
2106 | goto ON_EXIT;\r |
2107 | }\r |
2108 | \r |
2109 | //\r |
2110 | // Queue the token then check whether there is pending received packet.\r |
2111 | //\r |
2112 | Status = NetMapInsertTail (&IpInstance->RxTokens, Token, NULL);\r |
2113 | \r |
2114 | if (EFI_ERROR (Status)) {\r |
2115 | goto ON_EXIT;\r |
2116 | }\r |
2117 | \r |
2118 | Status = Ip4InstanceDeliverPacket (IpInstance);\r |
2119 | \r |
36ee91ca |
2120 | //\r |
2121 | // Dispatch the DPC queued by the NotifyFunction of this instane's receive\r |
2122 | // event.\r |
2123 | //\r |
d8d26fb2 |
2124 | DispatchDpc ();\r |
36ee91ca |
2125 | \r |
772db4bb |
2126 | ON_EXIT:\r |
e48e37fc |
2127 | gBS->RestoreTPL (OldTpl);\r |
772db4bb |
2128 | return Status;\r |
2129 | }\r |
2130 | \r |
2131 | \r |
2132 | /**\r |
2133 | Cancel the transmitted but not recycled packet. If a matching\r |
2134 | token is found, it will call Ip4CancelPacket to cancel the\r |
2135 | packet. Ip4CancelPacket will cancel all the fragments of the\r |
2136 | packet. When all the fragments are freed, the IP4_TXTOKEN_WRAP\r |
2137 | will be deleted from the Map, and user's event signalled.\r |
2138 | Because Ip4CancelPacket and other functions are all called in\r |
2139 | line, so, after Ip4CancelPacket returns, the Item has been freed.\r |
2140 | \r |
3e8c18da |
2141 | @param[in] Map The IP4 child's transmit queue\r |
2142 | @param[in] Item The current transmitted packet to test.\r |
2143 | @param[in] Context The user's token to cancel.\r |
772db4bb |
2144 | \r |
2145 | @retval EFI_SUCCESS Continue to check the next Item.\r |
2146 | @retval EFI_ABORTED The user's Token (Token != NULL) is cancelled.\r |
2147 | \r |
2148 | **/\r |
772db4bb |
2149 | EFI_STATUS\r |
e798cd87 |
2150 | EFIAPI\r |
772db4bb |
2151 | Ip4CancelTxTokens (\r |
2152 | IN NET_MAP *Map,\r |
2153 | IN NET_MAP_ITEM *Item,\r |
2154 | IN VOID *Context\r |
2155 | )\r |
2156 | {\r |
2157 | EFI_IP4_COMPLETION_TOKEN *Token;\r |
2158 | IP4_TXTOKEN_WRAP *Wrap;\r |
2159 | \r |
2160 | Token = (EFI_IP4_COMPLETION_TOKEN *) Context;\r |
2161 | \r |
2162 | //\r |
2163 | // Return EFI_SUCCESS to check the next item in the map if\r |
2164 | // this one doesn't match.\r |
2165 | //\r |
2166 | if ((Token != NULL) && (Token != Item->Key)) {\r |
2167 | return EFI_SUCCESS;\r |
2168 | }\r |
2169 | \r |
2170 | Wrap = (IP4_TXTOKEN_WRAP *) Item->Value;\r |
2171 | ASSERT (Wrap != NULL);\r |
2172 | \r |
2173 | //\r |
2174 | // Don't access the Item, Wrap and Token's members after this point.\r |
2175 | // Item and wrap has been freed. And we no longer own the Token.\r |
2176 | //\r |
2177 | Ip4CancelPacket (Wrap->IpInstance->Interface, Wrap->Packet, EFI_ABORTED);\r |
2178 | \r |
2179 | //\r |
2180 | // If only one item is to be cancel, return EFI_ABORTED to stop\r |
2181 | // iterating the map any more.\r |
2182 | //\r |
2183 | if (Token != NULL) {\r |
2184 | return EFI_ABORTED;\r |
2185 | }\r |
2186 | \r |
2187 | return EFI_SUCCESS;\r |
2188 | }\r |
2189 | \r |
2190 | \r |
2191 | /**\r |
2192 | Cancel the receive request. This is quiet simple, because\r |
2193 | it is only enqueued in our local receive map.\r |
2194 | \r |
3e8c18da |
2195 | @param[in] Map The IP4 child's receive queue\r |
2196 | @param[in] Item Current receive request to cancel.\r |
2197 | @param[in] Context The user's token to cancel\r |
772db4bb |
2198 | \r |
2199 | @retval EFI_SUCCESS Continue to check the next receive request on the\r |
2200 | queue.\r |
2201 | @retval EFI_ABORTED The user's token (token != NULL) has been\r |
2202 | cancelled.\r |
2203 | \r |
2204 | **/\r |
772db4bb |
2205 | EFI_STATUS\r |
e798cd87 |
2206 | EFIAPI\r |
772db4bb |
2207 | Ip4CancelRxTokens (\r |
2208 | IN NET_MAP *Map,\r |
2209 | IN NET_MAP_ITEM *Item,\r |
2210 | IN VOID *Context\r |
2211 | )\r |
2212 | {\r |
2213 | EFI_IP4_COMPLETION_TOKEN *Token;\r |
2214 | EFI_IP4_COMPLETION_TOKEN *This;\r |
2215 | \r |
2216 | Token = (EFI_IP4_COMPLETION_TOKEN *) Context;\r |
2217 | This = Item->Key;\r |
2218 | \r |
2219 | if ((Token != NULL) && (Token != This)) {\r |
2220 | return EFI_SUCCESS;\r |
2221 | }\r |
2222 | \r |
2223 | NetMapRemoveItem (Map, Item, NULL);\r |
2224 | \r |
2225 | This->Status = EFI_ABORTED;\r |
2226 | This->Packet.RxData = NULL;\r |
2227 | gBS->SignalEvent (This->Event);\r |
2228 | \r |
2229 | if (Token != NULL) {\r |
2230 | return EFI_ABORTED;\r |
2231 | }\r |
2232 | \r |
2233 | return EFI_SUCCESS;\r |
2234 | }\r |
2235 | \r |
2236 | \r |
2237 | /**\r |
2238 | Cancel the user's receive/transmit request.\r |
2239 | \r |
3e8c18da |
2240 | @param[in] IpInstance The IP4 child\r |
2241 | @param[in] Token The token to cancel. If NULL, all token will be\r |
772db4bb |
2242 | cancelled.\r |
2243 | \r |
2244 | @retval EFI_SUCCESS The token is cancelled\r |
2245 | @retval EFI_NOT_FOUND The token isn't found on either the\r |
2246 | transmit/receive queue\r |
2247 | @retval EFI_DEVICE_ERROR Not all token is cancelled when Token is NULL.\r |
2248 | \r |
2249 | **/\r |
2250 | EFI_STATUS\r |
2251 | Ip4Cancel (\r |
2252 | IN IP4_PROTOCOL *IpInstance,\r |
2253 | IN EFI_IP4_COMPLETION_TOKEN *Token OPTIONAL\r |
2254 | )\r |
2255 | {\r |
2256 | EFI_STATUS Status;\r |
2257 | \r |
2258 | //\r |
2259 | // First check the transmitted packet. Ip4CancelTxTokens returns\r |
2260 | // EFI_ABORTED to mean that the token has been cancelled when\r |
2261 | // token != NULL. So, return EFI_SUCCESS for this condition.\r |
2262 | //\r |
2263 | Status = NetMapIterate (&IpInstance->TxTokens, Ip4CancelTxTokens, Token);\r |
2264 | \r |
2265 | if (EFI_ERROR (Status)) {\r |
2266 | if ((Token != NULL) && (Status == EFI_ABORTED)) {\r |
2267 | return EFI_SUCCESS;\r |
2268 | }\r |
2269 | \r |
2270 | return Status;\r |
2271 | }\r |
2272 | \r |
2273 | //\r |
2274 | // Check the receive queue. Ip4CancelRxTokens also returns EFI_ABORT\r |
2275 | // for Token!=NULL and it is cancelled.\r |
2276 | //\r |
2277 | Status = NetMapIterate (&IpInstance->RxTokens, Ip4CancelRxTokens, Token);\r |
36ee91ca |
2278 | //\r |
2279 | // Dispatch the DPCs queued by the NotifyFunction of the canceled rx token's\r |
2280 | // events.\r |
2281 | //\r |
d8d26fb2 |
2282 | DispatchDpc ();\r |
772db4bb |
2283 | if (EFI_ERROR (Status)) {\r |
2284 | if ((Token != NULL) && (Status == EFI_ABORTED)) {\r |
2285 | return EFI_SUCCESS;\r |
2286 | }\r |
2287 | \r |
2288 | return Status;\r |
2289 | }\r |
2290 | \r |
2291 | //\r |
2292 | // OK, if the Token is found when Token != NULL, the NetMapIterate\r |
2293 | // will return EFI_ABORTED, which has been interrupted as EFI_SUCCESS.\r |
2294 | //\r |
2295 | if (Token != NULL) {\r |
2296 | return EFI_NOT_FOUND;\r |
2297 | }\r |
2298 | \r |
2299 | //\r |
2300 | // If Token == NULL, cancel all the tokens. return error if no\r |
2301 | // all of them are cancelled.\r |
2302 | //\r |
2303 | if (!NetMapIsEmpty (&IpInstance->TxTokens) ||\r |
2304 | !NetMapIsEmpty (&IpInstance->RxTokens)) {\r |
2305 | \r |
2306 | return EFI_DEVICE_ERROR;\r |
2307 | }\r |
2308 | \r |
2309 | return EFI_SUCCESS;\r |
2310 | }\r |
2311 | \r |
2312 | \r |
2313 | /**\r |
5405e9a6 |
2314 | Abort an asynchronous transmit or receive request.\r |
e2851998 |
2315 | \r |
5405e9a6 |
2316 | The Cancel() function is used to abort a pending transmit or receive request.\r |
2317 | If the token is in the transmit or receive request queues, after calling this\r |
2318 | function, Token->Status will be set to EFI_ABORTED and then Token->Event will\r |
2319 | be signaled. If the token is not in one of the queues, which usually means the\r |
2320 | asynchronous operation has completed, this function will not signal the token\r |
2321 | and EFI_NOT_FOUND is returned.\r |
2322 | \r |
3e8c18da |
2323 | @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r |
2324 | @param[in] Token Pointer to a token that has been issued by\r |
2325 | EFI_IP4_PROTOCOL.Transmit() or\r |
2326 | EFI_IP4_PROTOCOL.Receive(). If NULL, all pending\r |
2327 | tokens are aborted. Type EFI_IP4_COMPLETION_TOKEN is\r |
2328 | defined in EFI_IP4_PROTOCOL.Transmit().\r |
5405e9a6 |
2329 | \r |
2330 | @retval EFI_SUCCESS The asynchronous I/O request was aborted and\r |
2331 | Token.->Event was signaled. When Token is NULL, all\r |
2332 | pending requests were aborted and their events were signaled.\r |
2333 | @retval EFI_INVALID_PARAMETER This is NULL.\r |
2334 | @retval EFI_NOT_STARTED This instance has not been started.\r |
2335 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r |
2336 | RARP, etc.) is not finished yet.\r |
2337 | @retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O request was\r |
2338 | not found in the transmit or receive queue. It has either completed\r |
2339 | or was not issued by Transmit() and Receive().\r |
772db4bb |
2340 | \r |
2341 | **/\r |
772db4bb |
2342 | EFI_STATUS\r |
2343 | EFIAPI\r |
2344 | EfiIp4Cancel (\r |
2345 | IN EFI_IP4_PROTOCOL *This,\r |
2346 | IN EFI_IP4_COMPLETION_TOKEN *Token OPTIONAL\r |
2347 | )\r |
2348 | {\r |
2349 | IP4_PROTOCOL *IpInstance;\r |
2350 | EFI_STATUS Status;\r |
2351 | EFI_TPL OldTpl;\r |
2352 | \r |
2353 | if (This == NULL) {\r |
2354 | return EFI_INVALID_PARAMETER;\r |
2355 | }\r |
2356 | \r |
2357 | IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This);\r |
2358 | \r |
e48e37fc |
2359 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r |
772db4bb |
2360 | \r |
2361 | if (IpInstance->State != IP4_STATE_CONFIGED) {\r |
2362 | Status = EFI_NOT_STARTED;\r |
2363 | goto ON_EXIT;\r |
2364 | }\r |
2365 | \r |
2366 | if (IpInstance->ConfigData.UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) {\r |
2367 | Status = EFI_NO_MAPPING;\r |
2368 | goto ON_EXIT;\r |
2369 | }\r |
2370 | \r |
2371 | Status = Ip4Cancel (IpInstance, Token);\r |
2372 | \r |
2373 | ON_EXIT:\r |
e48e37fc |
2374 | gBS->RestoreTPL (OldTpl);\r |
772db4bb |
2375 | return Status;\r |
2376 | }\r |
2377 | \r |
2378 | \r |
2379 | /**\r |
5405e9a6 |
2380 | Polls for incoming data packets and processes outgoing data packets.\r |
e2851998 |
2381 | \r |
5405e9a6 |
2382 | The Poll() function polls for incoming data packets and processes outgoing data\r |
2383 | packets. Network drivers and applications can call the EFI_IP4_PROTOCOL.Poll()\r |
2384 | function to increase the rate that data packets are moved between the communications\r |
2385 | device and the transmit and receive queues.\r |
e2851998 |
2386 | \r |
5405e9a6 |
2387 | In some systems the periodic timer event may not poll the underlying communications\r |
2388 | device fast enough to transmit and/or receive all data packets without missing\r |
2389 | incoming packets or dropping outgoing packets. Drivers and applications that are\r |
2390 | experiencing packet loss should try calling the EFI_IP4_PROTOCOL.Poll() function\r |
2391 | more often.\r |
2392 | \r |
3e8c18da |
2393 | @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r |
5405e9a6 |
2394 | \r |
2395 | @retval EFI_SUCCESS Incoming or outgoing data was processed.\r |
2396 | @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.\r |
2397 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r |
2398 | RARP, etc.) is not finished yet.\r |
2399 | @retval EFI_INVALID_PARAMETER This is NULL.\r |
2400 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r |
2401 | @retval EFI_NOT_READY No incoming or outgoing data is processed.\r |
2402 | @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue.\r |
2403 | Consider increasing the polling rate.\r |
772db4bb |
2404 | \r |
2405 | **/\r |
772db4bb |
2406 | EFI_STATUS\r |
2407 | EFIAPI\r |
2408 | EfiIp4Poll (\r |
2409 | IN EFI_IP4_PROTOCOL *This\r |
2410 | )\r |
2411 | {\r |
2412 | IP4_PROTOCOL *IpInstance;\r |
2413 | EFI_MANAGED_NETWORK_PROTOCOL *Mnp;\r |
2414 | \r |
2415 | if (This == NULL) {\r |
2416 | return EFI_INVALID_PARAMETER;\r |
2417 | }\r |
2418 | \r |
2419 | IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This);\r |
2420 | \r |
2421 | if (IpInstance->State == IP4_STATE_UNCONFIGED) {\r |
2422 | return EFI_NOT_STARTED;\r |
2423 | }\r |
2424 | \r |
2425 | Mnp = IpInstance->Service->Mnp;\r |
2426 | \r |
2427 | //\r |
2428 | // Don't lock the Poll function to enable the deliver of\r |
2429 | // the packet polled up.\r |
2430 | //\r |
2431 | return Mnp->Poll (Mnp);\r |
2432 | }\r |
2433 | \r |
772db4bb |
2434 | /**\r |
2435 | Decrease the life of the transmitted packets. If it is\r |
2436 | decreased to zero, cancel the packet. This function is\r |
96e1079f |
2437 | called by Ip4PacketTimerTicking which time out both the\r |
772db4bb |
2438 | received-but-not-delivered and transmitted-but-not-recycle\r |
2439 | packets.\r |
2440 | \r |
3e8c18da |
2441 | @param[in] Map The IP4 child's transmit map.\r |
2442 | @param[in] Item Current transmitted packet\r |
2443 | @param[in] Context Not used.\r |
772db4bb |
2444 | \r |
2445 | @retval EFI_SUCCESS Always returns EFI_SUCCESS\r |
2446 | \r |
2447 | **/\r |
2448 | EFI_STATUS\r |
e798cd87 |
2449 | EFIAPI\r |
772db4bb |
2450 | Ip4SentPacketTicking (\r |
2451 | IN NET_MAP *Map,\r |
2452 | IN NET_MAP_ITEM *Item,\r |
2453 | IN VOID *Context\r |
2454 | )\r |
2455 | {\r |
2456 | IP4_TXTOKEN_WRAP *Wrap;\r |
2457 | \r |
2458 | Wrap = (IP4_TXTOKEN_WRAP *) Item->Value;\r |
2459 | ASSERT (Wrap != NULL);\r |
2460 | \r |
2461 | if ((Wrap->Life > 0) && (--Wrap->Life == 0)) {\r |
2462 | Ip4CancelPacket (Wrap->IpInstance->Interface, Wrap->Packet, EFI_ABORTED);\r |
2463 | }\r |
2464 | \r |
2465 | return EFI_SUCCESS;\r |
2466 | }\r |
2467 | \r |
2468 | \r |
2469 | /**\r |
2470 | The heart beat timer of IP4 service instance. It times out\r |
2471 | all of its IP4 children's received-but-not-delivered and\r |
2472 | transmitted-but-not-recycle packets, and provides time input\r |
2473 | for its IGMP protocol.\r |
2474 | \r |
3e8c18da |
2475 | @param[in] Event The IP4 service instance's heart beat timer.\r |
2476 | @param[in] Context The IP4 service instance.\r |
772db4bb |
2477 | \r |
2478 | **/\r |
2479 | VOID\r |
2480 | EFIAPI\r |
2481 | Ip4TimerTicking (\r |
2482 | IN EFI_EVENT Event,\r |
2483 | IN VOID *Context\r |
2484 | )\r |
2485 | {\r |
2486 | IP4_SERVICE *IpSb;\r |
2487 | \r |
2488 | IpSb = (IP4_SERVICE *) Context;\r |
2489 | NET_CHECK_SIGNATURE (IpSb, IP4_SERVICE_SIGNATURE);\r |
2490 | \r |
2491 | Ip4PacketTimerTicking (IpSb);\r |
2492 | Ip4IgmpTicking (IpSb);\r |
2493 | }\r |