]>
Commit | Line | Data |
---|---|---|
cbf316f2 | 1 | /** @file\r |
6aac5e5f | 2 | IpIo Library.\r |
cbf316f2 | 3 | \r |
35f910f0 | 4 | (C) Copyright 2014 Hewlett-Packard Development Company, L.P.<BR>\r |
1b31acb6 | 5 | Copyright (c) 2005 - 2016, Intel Corporation. All rights reserved.<BR>\r |
cd5ebaa0 | 6 | This program and the accompanying materials\r |
cbf316f2 | 7 | are licensed and made available under the terms and conditions of the BSD License\r |
8 | which accompanies this distribution. The full text of the license may be found at\r | |
9 | http://opensource.org/licenses/bsd-license.php\r | |
10 | \r | |
11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
cbf316f2 | 13 | **/\r |
14 | \r | |
6aac5e5f | 15 | #include <Uefi.h>\r |
cbf316f2 | 16 | \r |
17 | #include <Protocol/Udp4.h>\r | |
18 | \r | |
19 | #include <Library/IpIoLib.h>\r | |
20 | #include <Library/BaseLib.h>\r | |
21 | #include <Library/DebugLib.h>\r | |
752ef5d8 | 22 | #include <Library/BaseMemoryLib.h>\r |
cbf316f2 | 23 | #include <Library/UefiBootServicesTableLib.h>\r |
752ef5d8 | 24 | #include <Library/MemoryAllocationLib.h>\r |
d8d26fb2 | 25 | #include <Library/DpcLib.h>\r |
cbf316f2 | 26 | \r |
cbf316f2 | 27 | \r |
1204fe83 | 28 | GLOBAL_REMOVE_IF_UNREFERENCED LIST_ENTRY mActiveIpIoList = {\r |
cbf316f2 | 29 | &mActiveIpIoList,\r |
30 | &mActiveIpIoList\r | |
31 | };\r | |
32 | \r | |
1204fe83 | 33 | GLOBAL_REMOVE_IF_UNREFERENCED EFI_IP4_CONFIG_DATA mIp4IoDefaultIpConfigData = {\r |
cbf316f2 | 34 | EFI_IP_PROTO_UDP,\r |
35 | FALSE,\r | |
36 | TRUE,\r | |
37 | FALSE,\r | |
38 | FALSE,\r | |
39 | FALSE,\r | |
84b5c78e | 40 | {{0, 0, 0, 0}},\r |
41 | {{0, 0, 0, 0}},\r | |
cbf316f2 | 42 | 0,\r |
43 | 255,\r | |
44 | FALSE,\r | |
45 | FALSE,\r | |
46 | 0,\r | |
47 | 0\r | |
48 | };\r | |
49 | \r | |
1204fe83 | 50 | GLOBAL_REMOVE_IF_UNREFERENCED EFI_IP6_CONFIG_DATA mIp6IoDefaultIpConfigData = {\r |
fb115c61 | 51 | EFI_IP_PROTO_UDP,\r |
52 | FALSE,\r | |
53 | TRUE,\r | |
54 | FALSE,\r | |
55 | {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}},\r | |
56 | {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}},\r | |
57 | 0,\r | |
58 | 255,\r | |
59 | 0,\r | |
60 | 0,\r | |
61 | 0\r | |
62 | };\r | |
63 | \r | |
1204fe83 | 64 | GLOBAL_REMOVE_IF_UNREFERENCED ICMP_ERROR_INFO mIcmpErrMap[10] = {\r |
3cf888f5 | 65 | {FALSE, TRUE }, // ICMP_ERR_UNREACH_NET\r |
66 | {FALSE, TRUE }, // ICMP_ERR_UNREACH_HOST\r | |
67 | {TRUE, TRUE }, // ICMP_ERR_UNREACH_PROTOCOL\r | |
68 | {TRUE, TRUE }, // ICMP_ERR_UNREACH_PORT\r | |
69 | {TRUE, TRUE }, // ICMP_ERR_MSGSIZE\r | |
70 | {FALSE, TRUE }, // ICMP_ERR_UNREACH_SRCFAIL\r | |
71 | {FALSE, TRUE }, // ICMP_ERR_TIMXCEED_INTRANS\r | |
72 | {FALSE, TRUE }, // ICMP_ERR_TIMEXCEED_REASS\r | |
73 | {FALSE, FALSE}, // ICMP_ERR_QUENCH\r | |
74 | {FALSE, TRUE } // ICMP_ERR_PARAMPROB\r | |
fb115c61 | 75 | };\r |
76 | \r | |
1204fe83 | 77 | GLOBAL_REMOVE_IF_UNREFERENCED ICMP_ERROR_INFO mIcmp6ErrMap[10] = {\r |
3cf888f5 | 78 | {FALSE, TRUE}, // ICMP6_ERR_UNREACH_NET\r |
79 | {FALSE, TRUE}, // ICMP6_ERR_UNREACH_HOST\r | |
80 | {TRUE, TRUE}, // ICMP6_ERR_UNREACH_PROTOCOL\r | |
81 | {TRUE, TRUE}, // ICMP6_ERR_UNREACH_PORT \r | |
82 | {TRUE, TRUE}, // ICMP6_ERR_PACKAGE_TOOBIG\r | |
83 | {FALSE, TRUE}, // ICMP6_ERR_TIMXCEED_HOPLIMIT\r | |
84 | {FALSE, TRUE}, // ICMP6_ERR_TIMXCEED_REASS\r | |
85 | {FALSE, TRUE}, // ICMP6_ERR_PARAMPROB_HEADER \r | |
86 | {FALSE, TRUE}, // ICMP6_ERR_PARAMPROB_NEXHEADER\r | |
87 | {FALSE, TRUE} // ICMP6_ERR_PARAMPROB_IPV6OPTION\r | |
01750eb0 | 88 | };\r |
89 | \r | |
6aac5e5f | 90 | \r |
91 | /**\r | |
92 | Notify function for IP transmit token.\r | |
93 | \r | |
94 | @param[in] Context The context passed in by the event notifier.\r | |
95 | \r | |
96 | **/\r | |
36ee91ca | 97 | VOID\r |
98 | EFIAPI\r | |
99 | IpIoTransmitHandlerDpc (\r | |
100 | IN VOID *Context\r | |
101 | );\r | |
102 | \r | |
6aac5e5f | 103 | \r |
104 | /**\r | |
105 | Notify function for IP transmit token.\r | |
106 | \r | |
107 | @param[in] Event The event signaled.\r | |
108 | @param[in] Context The context passed in by the event notifier.\r | |
109 | \r | |
110 | **/\r | |
cbf316f2 | 111 | VOID\r |
112 | EFIAPI\r | |
113 | IpIoTransmitHandler (\r | |
114 | IN EFI_EVENT Event,\r | |
115 | IN VOID *Context\r | |
116 | );\r | |
117 | \r | |
118 | \r | |
119 | /**\r | |
6aac5e5f | 120 | This function create an IP child ,open the IP protocol, and return the opened\r |
e6ff63a5 | 121 | IP protocol as Interface.\r |
cbf316f2 | 122 | \r |
6aac5e5f | 123 | @param[in] ControllerHandle The controller handle.\r |
124 | @param[in] ImageHandle The image handle.\r | |
125 | @param[in] ChildHandle Pointer to the buffer to save the IP child handle.\r | |
fb115c61 | 126 | @param[in] IpVersion The version of the IP protocol to use, either\r |
127 | IPv4 or IPv6.\r | |
6aac5e5f | 128 | @param[out] Interface Pointer used to get the IP protocol interface.\r |
cbf316f2 | 129 | \r |
6aac5e5f | 130 | @retval EFI_SUCCESS The IP child is created and the IP protocol\r |
131 | interface is retrieved.\r | |
132 | @retval Others The required operation failed.\r | |
cbf316f2 | 133 | \r |
134 | **/\r | |
cbf316f2 | 135 | EFI_STATUS\r |
136 | IpIoCreateIpChildOpenProtocol (\r | |
137 | IN EFI_HANDLE ControllerHandle,\r | |
138 | IN EFI_HANDLE ImageHandle,\r | |
139 | IN EFI_HANDLE *ChildHandle,\r | |
b45b45b2 | 140 | IN UINT8 IpVersion,\r |
cbf316f2 | 141 | OUT VOID **Interface\r |
142 | )\r | |
143 | {\r | |
144 | EFI_STATUS Status;\r | |
fb115c61 | 145 | EFI_GUID *ServiceBindingGuid;\r |
146 | EFI_GUID *IpProtocolGuid;\r | |
147 | \r | |
148 | if (IpVersion == IP_VERSION_4) {\r | |
149 | ServiceBindingGuid = &gEfiIp4ServiceBindingProtocolGuid;\r | |
150 | IpProtocolGuid = &gEfiIp4ProtocolGuid;\r | |
151 | } else if (IpVersion == IP_VERSION_6){\r | |
152 | ServiceBindingGuid = &gEfiIp6ServiceBindingProtocolGuid;\r | |
153 | IpProtocolGuid = &gEfiIp6ProtocolGuid;\r | |
154 | } else {\r | |
155 | return EFI_UNSUPPORTED;\r | |
156 | }\r | |
cbf316f2 | 157 | \r |
158 | //\r | |
6aac5e5f | 159 | // Create an IP child.\r |
cbf316f2 | 160 | //\r |
161 | Status = NetLibCreateServiceChild (\r | |
162 | ControllerHandle,\r | |
163 | ImageHandle,\r | |
fb115c61 | 164 | ServiceBindingGuid,\r |
cbf316f2 | 165 | ChildHandle\r |
166 | );\r | |
167 | if (EFI_ERROR (Status)) {\r | |
168 | return Status;\r | |
169 | }\r | |
170 | \r | |
171 | //\r | |
6aac5e5f | 172 | // Open the IP protocol installed on the *ChildHandle.\r |
cbf316f2 | 173 | //\r |
174 | Status = gBS->OpenProtocol (\r | |
175 | *ChildHandle,\r | |
fb115c61 | 176 | IpProtocolGuid,\r |
cbf316f2 | 177 | Interface,\r |
178 | ImageHandle,\r | |
179 | ControllerHandle,\r | |
180 | EFI_OPEN_PROTOCOL_BY_DRIVER\r | |
181 | );\r | |
182 | if (EFI_ERROR (Status)) {\r | |
183 | //\r | |
6aac5e5f | 184 | // On failure, destroy the IP child.\r |
cbf316f2 | 185 | //\r |
186 | NetLibDestroyServiceChild (\r | |
187 | ControllerHandle,\r | |
188 | ImageHandle,\r | |
fb115c61 | 189 | ServiceBindingGuid,\r |
cbf316f2 | 190 | *ChildHandle\r |
191 | );\r | |
192 | }\r | |
193 | \r | |
194 | return Status;\r | |
195 | }\r | |
196 | \r | |
197 | \r | |
198 | /**\r | |
e6ff63a5 | 199 | This function close the previously openned IP protocol and destroy the IP child.\r |
cbf316f2 | 200 | \r |
6aac5e5f | 201 | @param[in] ControllerHandle The controller handle.\r |
202 | @param[in] ImageHandle The image handle.\r | |
203 | @param[in] ChildHandle The child handle of the IP child.\r | |
fb115c61 | 204 | @param[in] IpVersion The version of the IP protocol to use, either\r |
205 | IPv4 or IPv6.\r | |
cbf316f2 | 206 | \r |
6aac5e5f | 207 | @retval EFI_SUCCESS The IP protocol is closed and the relevant IP child\r |
208 | is destroyed.\r | |
209 | @retval Others The required operation failed.\r | |
cbf316f2 | 210 | \r |
211 | **/\r | |
cbf316f2 | 212 | EFI_STATUS\r |
213 | IpIoCloseProtocolDestroyIpChild (\r | |
214 | IN EFI_HANDLE ControllerHandle,\r | |
215 | IN EFI_HANDLE ImageHandle,\r | |
fb115c61 | 216 | IN EFI_HANDLE ChildHandle,\r |
b45b45b2 | 217 | IN UINT8 IpVersion\r |
cbf316f2 | 218 | )\r |
219 | {\r | |
220 | EFI_STATUS Status;\r | |
fb115c61 | 221 | EFI_GUID *ServiceBindingGuid;\r |
222 | EFI_GUID *IpProtocolGuid;\r | |
223 | \r | |
224 | if (IpVersion == IP_VERSION_4) {\r | |
225 | ServiceBindingGuid = &gEfiIp4ServiceBindingProtocolGuid;\r | |
226 | IpProtocolGuid = &gEfiIp4ProtocolGuid;\r | |
227 | } else if (IpVersion == IP_VERSION_6) {\r | |
228 | ServiceBindingGuid = &gEfiIp6ServiceBindingProtocolGuid;\r | |
229 | IpProtocolGuid = &gEfiIp6ProtocolGuid;\r | |
230 | } else {\r | |
231 | return EFI_UNSUPPORTED;\r | |
232 | }\r | |
cbf316f2 | 233 | \r |
234 | //\r | |
6aac5e5f | 235 | // Close the previously openned IP protocol.\r |
cbf316f2 | 236 | //\r |
237 | gBS->CloseProtocol (\r | |
238 | ChildHandle,\r | |
fb115c61 | 239 | IpProtocolGuid,\r |
cbf316f2 | 240 | ImageHandle,\r |
241 | ControllerHandle\r | |
242 | );\r | |
243 | \r | |
244 | //\r | |
6aac5e5f | 245 | // Destroy the IP child.\r |
cbf316f2 | 246 | //\r |
247 | Status = NetLibDestroyServiceChild (\r | |
248 | ControllerHandle,\r | |
249 | ImageHandle,\r | |
fb115c61 | 250 | ServiceBindingGuid,\r |
cbf316f2 | 251 | ChildHandle\r |
252 | );\r | |
253 | \r | |
254 | return Status;\r | |
255 | }\r | |
256 | \r | |
cbf316f2 | 257 | /**\r |
fb115c61 | 258 | This function handles ICMPv4 packets. It is the worker function of \r |
259 | IpIoIcmpHandler.\r | |
cbf316f2 | 260 | \r |
fb115c61 | 261 | @param[in] IpIo Pointer to the IP_IO instance.\r |
262 | @param[in, out] Pkt Pointer to the ICMPv4 packet.\r | |
263 | @param[in] Session Pointer to the net session of this ICMPv4 packet.\r | |
cbf316f2 | 264 | \r |
fb115c61 | 265 | @retval EFI_SUCCESS The ICMPv4 packet is handled successfully.\r |
266 | @retval EFI_ABORTED This type of ICMPv4 packet is not supported.\r | |
cbf316f2 | 267 | \r |
268 | **/\r | |
cbf316f2 | 269 | EFI_STATUS\r |
fb115c61 | 270 | IpIoIcmpv4Handler (\r |
6aac5e5f | 271 | IN IP_IO *IpIo,\r |
272 | IN OUT NET_BUF *Pkt,\r | |
273 | IN EFI_NET_SESSION_DATA *Session\r | |
cbf316f2 | 274 | )\r |
275 | {\r | |
276 | IP4_ICMP_ERROR_HEAD *IcmpHdr;\r | |
277 | EFI_IP4_HEADER *IpHdr;\r | |
b45b45b2 | 278 | UINT8 IcmpErr;\r |
cbf316f2 | 279 | UINT8 *PayLoadHdr;\r |
280 | UINT8 Type;\r | |
281 | UINT8 Code;\r | |
282 | UINT32 TrimBytes;\r | |
283 | \r | |
fb115c61 | 284 | ASSERT (IpIo->IpVersion == IP_VERSION_4);\r |
285 | \r | |
cbf316f2 | 286 | IcmpHdr = NET_PROTO_HDR (Pkt, IP4_ICMP_ERROR_HEAD);\r |
287 | IpHdr = (EFI_IP4_HEADER *) (&IcmpHdr->IpHead);\r | |
288 | \r | |
289 | //\r | |
290 | // Check the ICMP packet length.\r | |
291 | //\r | |
292 | if (Pkt->TotalSize < ICMP_ERRLEN (IpHdr)) {\r | |
293 | \r | |
294 | return EFI_ABORTED;\r | |
295 | }\r | |
296 | \r | |
297 | Type = IcmpHdr->Head.Type;\r | |
298 | Code = IcmpHdr->Head.Code;\r | |
299 | \r | |
300 | //\r | |
301 | // Analyze the ICMP Error in this ICMP pkt\r | |
302 | //\r | |
303 | switch (Type) {\r | |
304 | case ICMP_TYPE_UNREACH:\r | |
305 | switch (Code) {\r | |
306 | case ICMP_CODE_UNREACH_NET:\r | |
307 | case ICMP_CODE_UNREACH_HOST:\r | |
308 | case ICMP_CODE_UNREACH_PROTOCOL:\r | |
309 | case ICMP_CODE_UNREACH_PORT:\r | |
310 | case ICMP_CODE_UNREACH_SRCFAIL:\r | |
b45b45b2 | 311 | IcmpErr = (UINT8) (ICMP_ERR_UNREACH_NET + Code);\r |
cbf316f2 | 312 | \r |
313 | break;\r | |
314 | \r | |
315 | case ICMP_CODE_UNREACH_NEEDFRAG:\r | |
316 | IcmpErr = ICMP_ERR_MSGSIZE;\r | |
317 | \r | |
318 | break;\r | |
319 | \r | |
320 | case ICMP_CODE_UNREACH_NET_UNKNOWN:\r | |
321 | case ICMP_CODE_UNREACH_NET_PROHIB:\r | |
322 | case ICMP_CODE_UNREACH_TOSNET:\r | |
323 | IcmpErr = ICMP_ERR_UNREACH_NET;\r | |
324 | \r | |
325 | break;\r | |
326 | \r | |
327 | case ICMP_CODE_UNREACH_HOST_UNKNOWN:\r | |
328 | case ICMP_CODE_UNREACH_ISOLATED:\r | |
329 | case ICMP_CODE_UNREACH_HOST_PROHIB:\r | |
330 | case ICMP_CODE_UNREACH_TOSHOST:\r | |
331 | IcmpErr = ICMP_ERR_UNREACH_HOST;\r | |
332 | \r | |
333 | break;\r | |
334 | \r | |
335 | default:\r | |
336 | return EFI_ABORTED;\r | |
cbf316f2 | 337 | }\r |
338 | \r | |
339 | break;\r | |
340 | \r | |
341 | case ICMP_TYPE_TIMXCEED:\r | |
342 | if (Code > 1) {\r | |
343 | return EFI_ABORTED;\r | |
344 | }\r | |
345 | \r | |
b45b45b2 | 346 | IcmpErr = (UINT8) (Code + ICMP_ERR_TIMXCEED_INTRANS);\r |
cbf316f2 | 347 | \r |
348 | break;\r | |
349 | \r | |
350 | case ICMP_TYPE_PARAMPROB:\r | |
351 | if (Code > 1) {\r | |
352 | return EFI_ABORTED;\r | |
353 | }\r | |
354 | \r | |
355 | IcmpErr = ICMP_ERR_PARAMPROB;\r | |
356 | \r | |
357 | break;\r | |
358 | \r | |
359 | case ICMP_TYPE_SOURCEQUENCH:\r | |
360 | if (Code != 0) {\r | |
361 | return EFI_ABORTED;\r | |
362 | }\r | |
363 | \r | |
364 | IcmpErr = ICMP_ERR_QUENCH;\r | |
365 | \r | |
366 | break;\r | |
367 | \r | |
368 | default:\r | |
369 | return EFI_ABORTED;\r | |
cbf316f2 | 370 | }\r |
371 | \r | |
372 | //\r | |
373 | // Notify user the ICMP pkt only containing payload except\r | |
374 | // IP and ICMP header\r | |
375 | //\r | |
376 | PayLoadHdr = (UINT8 *) ((UINT8 *) IpHdr + EFI_IP4_HEADER_LEN (IpHdr));\r | |
377 | TrimBytes = (UINT32) (PayLoadHdr - (UINT8 *) IcmpHdr);\r | |
378 | \r | |
379 | NetbufTrim (Pkt, TrimBytes, TRUE);\r | |
380 | \r | |
381 | IpIo->PktRcvdNotify (EFI_ICMP_ERROR, IcmpErr, Session, Pkt, IpIo->RcvdContext);\r | |
382 | \r | |
fb115c61 | 383 | return EFI_SUCCESS; \r |
384 | }\r | |
385 | \r | |
386 | /**\r | |
387 | This function handles ICMPv6 packets. It is the worker function of \r | |
388 | IpIoIcmpHandler.\r | |
389 | \r | |
390 | @param[in] IpIo Pointer to the IP_IO instance.\r | |
391 | @param[in, out] Pkt Pointer to the ICMPv6 packet.\r | |
392 | @param[in] Session Pointer to the net session of this ICMPv6 packet.\r | |
393 | \r | |
394 | @retval EFI_SUCCESS The ICMPv6 packet is handled successfully.\r | |
395 | @retval EFI_ABORTED This type of ICMPv6 packet is not supported.\r | |
396 | \r | |
397 | **/\r | |
398 | EFI_STATUS\r | |
399 | IpIoIcmpv6Handler (\r | |
400 | IN IP_IO *IpIo,\r | |
401 | IN OUT NET_BUF *Pkt,\r | |
402 | IN EFI_NET_SESSION_DATA *Session\r | |
403 | )\r | |
404 | {\r | |
405 | IP6_ICMP_ERROR_HEAD *IcmpHdr;\r | |
406 | EFI_IP6_HEADER *IpHdr;\r | |
b45b45b2 | 407 | UINT8 IcmpErr;\r |
fb115c61 | 408 | UINT8 *PayLoadHdr;\r |
409 | UINT8 Type;\r | |
410 | UINT8 Code;\r | |
411 | UINT8 NextHeader;\r | |
412 | UINT32 TrimBytes;\r | |
413 | BOOLEAN Flag;\r | |
414 | \r | |
415 | ASSERT (IpIo->IpVersion == IP_VERSION_6);\r | |
416 | \r | |
417 | //\r | |
418 | // Check the ICMPv6 packet length.\r | |
419 | //\r | |
420 | if (Pkt->TotalSize < sizeof (IP6_ICMP_ERROR_HEAD)) {\r | |
421 | \r | |
422 | return EFI_ABORTED;\r | |
423 | }\r | |
424 | \r | |
425 | IcmpHdr = NET_PROTO_HDR (Pkt, IP6_ICMP_ERROR_HEAD);\r | |
426 | Type = IcmpHdr->Head.Type;\r | |
427 | Code = IcmpHdr->Head.Code;\r | |
428 | \r | |
429 | //\r | |
430 | // Analyze the ICMPv6 Error in this ICMPv6 packet\r | |
431 | // \r | |
432 | switch (Type) {\r | |
433 | case ICMP_V6_DEST_UNREACHABLE:\r | |
434 | switch (Code) {\r | |
435 | case ICMP_V6_NO_ROUTE_TO_DEST:\r | |
436 | case ICMP_V6_BEYOND_SCOPE:\r | |
437 | case ICMP_V6_ROUTE_REJECTED:\r | |
438 | IcmpErr = ICMP6_ERR_UNREACH_NET;\r | |
439 | \r | |
440 | break;\r | |
441 | \r | |
442 | case ICMP_V6_COMM_PROHIBITED:\r | |
443 | case ICMP_V6_ADDR_UNREACHABLE:\r | |
444 | case ICMP_V6_SOURCE_ADDR_FAILED:\r | |
445 | IcmpErr = ICMP6_ERR_UNREACH_HOST;\r | |
446 | \r | |
447 | break;\r | |
448 | \r | |
449 | case ICMP_V6_PORT_UNREACHABLE:\r | |
450 | IcmpErr = ICMP6_ERR_UNREACH_PORT;\r | |
451 | \r | |
452 | break;\r | |
453 | \r | |
454 | default:\r | |
455 | return EFI_ABORTED;\r | |
456 | }\r | |
457 | \r | |
458 | break;\r | |
459 | \r | |
460 | case ICMP_V6_PACKET_TOO_BIG:\r | |
461 | if (Code >= 1) {\r | |
462 | return EFI_ABORTED;\r | |
463 | }\r | |
464 | \r | |
465 | IcmpErr = ICMP6_ERR_PACKAGE_TOOBIG;\r | |
466 | \r | |
467 | break;\r | |
468 | \r | |
469 | case ICMP_V6_TIME_EXCEEDED:\r | |
470 | if (Code > 1) {\r | |
471 | return EFI_ABORTED;\r | |
472 | }\r | |
473 | \r | |
b45b45b2 | 474 | IcmpErr = (UINT8) (ICMP6_ERR_TIMXCEED_HOPLIMIT + Code);\r |
fb115c61 | 475 | \r |
476 | break;\r | |
477 | \r | |
478 | case ICMP_V6_PARAMETER_PROBLEM:\r | |
479 | if (Code > 3) {\r | |
480 | return EFI_ABORTED;\r | |
481 | }\r | |
482 | \r | |
b45b45b2 | 483 | IcmpErr = (UINT8) (ICMP6_ERR_PARAMPROB_HEADER + Code);\r |
fb115c61 | 484 | \r |
485 | break;\r | |
486 | \r | |
487 | default:\r | |
488 | \r | |
489 | return EFI_ABORTED;\r | |
490 | } \r | |
491 | \r | |
492 | //\r | |
493 | // Notify user the ICMPv6 packet only containing payload except\r | |
494 | // IPv6 basic header, extension header and ICMP header\r | |
495 | //\r | |
496 | \r | |
497 | IpHdr = (EFI_IP6_HEADER *) (&IcmpHdr->IpHead);\r | |
498 | NextHeader = IpHdr->NextHeader;\r | |
499 | PayLoadHdr = (UINT8 *) ((UINT8 *) IcmpHdr + sizeof (IP6_ICMP_ERROR_HEAD));\r | |
500 | Flag = TRUE;\r | |
501 | \r | |
502 | do {\r | |
503 | switch (NextHeader) {\r | |
504 | case EFI_IP_PROTO_UDP:\r | |
505 | case EFI_IP_PROTO_TCP:\r | |
506 | case EFI_IP_PROTO_ICMP:\r | |
507 | case IP6_NO_NEXT_HEADER:\r | |
508 | Flag = FALSE;\r | |
509 | \r | |
510 | break;\r | |
511 | \r | |
512 | case IP6_HOP_BY_HOP:\r | |
513 | case IP6_DESTINATION:\r | |
514 | //\r | |
515 | // The Hdr Ext Len is 8-bit unsigned integer in 8-octet units, not including\r | |
516 | // the first 8 octets.\r | |
517 | //\r | |
518 | NextHeader = *(PayLoadHdr);\r | |
519 | PayLoadHdr = (UINT8 *) (PayLoadHdr + (*(PayLoadHdr + 1) + 1) * 8);\r | |
520 | \r | |
521 | break;\r | |
522 | \r | |
523 | case IP6_FRAGMENT:\r | |
524 | //\r | |
525 | // The Fragment Header Length is 8 octets.\r | |
526 | //\r | |
527 | NextHeader = *(PayLoadHdr);\r | |
528 | PayLoadHdr = (UINT8 *) (PayLoadHdr + 8);\r | |
529 | \r | |
530 | break;\r | |
531 | \r | |
532 | default:\r | |
533 | \r | |
534 | return EFI_ABORTED;\r | |
535 | }\r | |
536 | } while (Flag);\r | |
537 | \r | |
538 | TrimBytes = (UINT32) (PayLoadHdr - (UINT8 *) IcmpHdr);\r | |
539 | \r | |
540 | NetbufTrim (Pkt, TrimBytes, TRUE);\r | |
541 | \r | |
b45b45b2 | 542 | IpIo->PktRcvdNotify (EFI_ICMP_ERROR, IcmpErr, Session, Pkt, IpIo->RcvdContext);\r |
fb115c61 | 543 | \r |
cbf316f2 | 544 | return EFI_SUCCESS;\r |
545 | }\r | |
546 | \r | |
fb115c61 | 547 | /**\r |
548 | This function handles ICMP packets.\r | |
549 | \r | |
550 | @param[in] IpIo Pointer to the IP_IO instance.\r | |
551 | @param[in, out] Pkt Pointer to the ICMP packet.\r | |
552 | @param[in] Session Pointer to the net session of this ICMP packet.\r | |
553 | \r | |
554 | @retval EFI_SUCCESS The ICMP packet is handled successfully.\r | |
555 | @retval EFI_ABORTED This type of ICMP packet is not supported.\r | |
556 | @retval EFI_UNSUPPORTED The IP protocol version in IP_IO is not supported.\r | |
557 | \r | |
558 | **/\r | |
559 | EFI_STATUS\r | |
560 | IpIoIcmpHandler (\r | |
561 | IN IP_IO *IpIo,\r | |
562 | IN OUT NET_BUF *Pkt,\r | |
563 | IN EFI_NET_SESSION_DATA *Session\r | |
564 | )\r | |
565 | {\r | |
566 | \r | |
567 | if (IpIo->IpVersion == IP_VERSION_4) {\r | |
568 | \r | |
569 | return IpIoIcmpv4Handler (IpIo, Pkt, Session);\r | |
570 | \r | |
571 | } else if (IpIo->IpVersion == IP_VERSION_6) {\r | |
572 | \r | |
573 | return IpIoIcmpv6Handler (IpIo, Pkt, Session);\r | |
574 | \r | |
575 | } else {\r | |
576 | \r | |
577 | return EFI_UNSUPPORTED;\r | |
578 | }\r | |
579 | }\r | |
580 | \r | |
cbf316f2 | 581 | \r |
582 | /**\r | |
e6ff63a5 | 583 | Free function for receive token of IP_IO. It is used to\r |
cbf316f2 | 584 | signal the recycle event to notify IP to recycle the\r |
585 | data buffer.\r | |
586 | \r | |
6aac5e5f | 587 | @param[in] Event The event to be signaled.\r |
cbf316f2 | 588 | \r |
cbf316f2 | 589 | **/\r |
cbf316f2 | 590 | VOID\r |
e798cd87 | 591 | EFIAPI\r |
cbf316f2 | 592 | IpIoExtFree (\r |
593 | IN VOID *Event\r | |
594 | )\r | |
595 | {\r | |
596 | gBS->SignalEvent ((EFI_EVENT) Event);\r | |
597 | }\r | |
598 | \r | |
599 | \r | |
600 | /**\r | |
601 | Create a send entry to wrap a packet before sending\r | |
602 | out it through IP.\r | |
603 | \r | |
6aac5e5f | 604 | @param[in, out] IpIo Pointer to the IP_IO instance.\r |
605 | @param[in, out] Pkt Pointer to the packet.\r | |
606 | @param[in] Sender Pointer to the IP sender.\r | |
607 | @param[in] Context Pointer to the context.\r | |
608 | @param[in] NotifyData Pointer to the notify data.\r | |
609 | @param[in] Dest Pointer to the destination IP address.\r | |
610 | @param[in] Override Pointer to the overriden IP_IO data.\r | |
cbf316f2 | 611 | \r |
612 | @return Pointer to the data structure created to wrap the packet. If NULL,\r | |
6aac5e5f | 613 | @return resource limit occurred.\r |
cbf316f2 | 614 | \r |
615 | **/\r | |
cbf316f2 | 616 | IP_IO_SEND_ENTRY *\r |
617 | IpIoCreateSndEntry (\r | |
6aac5e5f | 618 | IN OUT IP_IO *IpIo,\r |
619 | IN OUT NET_BUF *Pkt,\r | |
2a2e33b2 | 620 | IN IP_IO_IP_PROTOCOL Sender,\r |
6aac5e5f | 621 | IN VOID *Context OPTIONAL,\r |
622 | IN VOID *NotifyData OPTIONAL,\r | |
fb115c61 | 623 | IN EFI_IP_ADDRESS *Dest OPTIONAL,\r |
6aac5e5f | 624 | IN IP_IO_OVERRIDE *Override\r |
cbf316f2 | 625 | )\r |
626 | {\r | |
627 | IP_IO_SEND_ENTRY *SndEntry;\r | |
fb115c61 | 628 | EFI_EVENT Event; \r |
cbf316f2 | 629 | EFI_STATUS Status;\r |
fb115c61 | 630 | NET_FRAGMENT *ExtFragment;\r |
631 | UINT32 FragmentCount;\r | |
632 | IP_IO_OVERRIDE *OverrideData;\r | |
633 | IP_IO_IP_TX_DATA *TxData;\r | |
634 | EFI_IP4_TRANSMIT_DATA *Ip4TxData;\r | |
635 | EFI_IP6_TRANSMIT_DATA *Ip6TxData;\r | |
636 | \r | |
637 | if ((IpIo->IpVersion != IP_VERSION_4) && (IpIo->IpVersion != IP_VERSION_6)) {\r | |
638 | return NULL;\r | |
639 | }\r | |
640 | \r | |
641 | Event = NULL;\r | |
642 | TxData = NULL;\r | |
643 | OverrideData = NULL;\r | |
cbf316f2 | 644 | \r |
645 | //\r | |
646 | // Allocate resource for SndEntry\r | |
647 | //\r | |
e48e37fc | 648 | SndEntry = AllocatePool (sizeof (IP_IO_SEND_ENTRY));\r |
cbf316f2 | 649 | if (NULL == SndEntry) {\r |
650 | return NULL;\r | |
651 | }\r | |
652 | \r | |
cbf316f2 | 653 | Status = gBS->CreateEvent (\r |
654 | EVT_NOTIFY_SIGNAL,\r | |
e48e37fc | 655 | TPL_NOTIFY,\r |
cbf316f2 | 656 | IpIoTransmitHandler,\r |
657 | SndEntry,\r | |
fb115c61 | 658 | &Event\r |
cbf316f2 | 659 | );\r |
660 | if (EFI_ERROR (Status)) {\r | |
fb115c61 | 661 | goto ON_ERROR;\r |
cbf316f2 | 662 | }\r |
663 | \r | |
fb115c61 | 664 | FragmentCount = Pkt->BlockOpNum;\r |
665 | \r | |
cbf316f2 | 666 | //\r |
667 | // Allocate resource for TxData\r | |
668 | //\r | |
fb115c61 | 669 | TxData = (IP_IO_IP_TX_DATA *) AllocatePool (\r |
670 | sizeof (IP_IO_IP_TX_DATA) + sizeof (NET_FRAGMENT) * (FragmentCount - 1)\r | |
cbf316f2 | 671 | );\r |
672 | \r | |
673 | if (NULL == TxData) {\r | |
fb115c61 | 674 | goto ON_ERROR;\r |
675 | }\r | |
676 | \r | |
677 | //\r | |
678 | // Build a fragment table to contain the fragments in the packet. \r | |
679 | //\r | |
680 | if (IpIo->IpVersion == IP_VERSION_4) {\r | |
681 | ExtFragment = (NET_FRAGMENT *) TxData->Ip4TxData.FragmentTable;\r | |
682 | } else {\r | |
683 | ExtFragment = (NET_FRAGMENT *) TxData->Ip6TxData.FragmentTable;\r | |
cbf316f2 | 684 | }\r |
685 | \r | |
fb115c61 | 686 | NetbufBuildExt (Pkt, ExtFragment, &FragmentCount);\r |
687 | \r | |
688 | \r | |
cbf316f2 | 689 | //\r |
690 | // Allocate resource for OverrideData if needed\r | |
691 | //\r | |
cbf316f2 | 692 | if (NULL != Override) {\r |
693 | \r | |
fb115c61 | 694 | OverrideData = AllocateCopyPool (sizeof (IP_IO_OVERRIDE), Override);\r |
cbf316f2 | 695 | if (NULL == OverrideData) {\r |
fb115c61 | 696 | goto ON_ERROR;\r |
cbf316f2 | 697 | }\r |
cbf316f2 | 698 | }\r |
699 | \r | |
700 | //\r | |
fb115c61 | 701 | // Set other fields of TxData except the fragment table\r |
cbf316f2 | 702 | //\r |
fb115c61 | 703 | if (IpIo->IpVersion == IP_VERSION_4) {\r |
cbf316f2 | 704 | \r |
fb115c61 | 705 | Ip4TxData = &TxData->Ip4TxData;\r |
cbf316f2 | 706 | \r |
35f910f0 | 707 | IP4_COPY_ADDRESS (&Ip4TxData->DestinationAddress, Dest);\r |
cbf316f2 | 708 | \r |
fb115c61 | 709 | Ip4TxData->OverrideData = &OverrideData->Ip4OverrideData;\r |
710 | Ip4TxData->OptionsLength = 0;\r | |
711 | Ip4TxData->OptionsBuffer = NULL;\r | |
712 | Ip4TxData->TotalDataLength = Pkt->TotalSize;\r | |
713 | Ip4TxData->FragmentCount = FragmentCount;\r | |
714 | \r | |
715 | //\r | |
716 | // Set the fields of SndToken\r | |
717 | //\r | |
718 | SndEntry->SndToken.Ip4Token.Event = Event;\r | |
719 | SndEntry->SndToken.Ip4Token.Packet.TxData = Ip4TxData;\r | |
720 | } else {\r | |
721 | \r | |
722 | Ip6TxData = &TxData->Ip6TxData;\r | |
723 | \r | |
724 | if (Dest != NULL) {\r | |
725 | CopyMem (&Ip6TxData->DestinationAddress, Dest, sizeof (EFI_IPv6_ADDRESS));\r | |
726 | } else {\r | |
727 | ZeroMem (&Ip6TxData->DestinationAddress, sizeof (EFI_IPv6_ADDRESS));\r | |
728 | }\r | |
729 | \r | |
730 | Ip6TxData->OverrideData = &OverrideData->Ip6OverrideData;\r | |
731 | Ip6TxData->DataLength = Pkt->TotalSize;\r | |
732 | Ip6TxData->FragmentCount = FragmentCount;\r | |
733 | Ip6TxData->ExtHdrsLength = 0;\r | |
734 | Ip6TxData->ExtHdrs = NULL;\r | |
735 | \r | |
736 | //\r | |
737 | // Set the fields of SndToken\r | |
738 | //\r | |
739 | SndEntry->SndToken.Ip6Token.Event = Event;\r | |
740 | SndEntry->SndToken.Ip6Token.Packet.TxData = Ip6TxData;\r | |
741 | }\r | |
cbf316f2 | 742 | \r |
743 | //\r | |
744 | // Set the fields of SndEntry\r | |
745 | //\r | |
746 | SndEntry->IpIo = IpIo;\r | |
6aac5e5f | 747 | SndEntry->Ip = Sender;\r |
cbf316f2 | 748 | SndEntry->Context = Context;\r |
749 | SndEntry->NotifyData = NotifyData;\r | |
750 | \r | |
751 | SndEntry->Pkt = Pkt;\r | |
752 | NET_GET_REF (Pkt);\r | |
753 | \r | |
e48e37fc | 754 | InsertTailList (&IpIo->PendingSndList, &SndEntry->Entry);\r |
cbf316f2 | 755 | \r |
756 | return SndEntry;\r | |
757 | \r | |
fb115c61 | 758 | ON_ERROR:\r |
759 | \r | |
760 | if (OverrideData != NULL) {\r | |
761 | FreePool (OverrideData);\r | |
762 | }\r | |
cbf316f2 | 763 | \r |
fb115c61 | 764 | if (TxData != NULL) {\r |
765 | FreePool (TxData);\r | |
766 | }\r | |
cbf316f2 | 767 | \r |
fb115c61 | 768 | if (SndEntry != NULL) {\r |
769 | FreePool (SndEntry);\r | |
770 | }\r | |
cbf316f2 | 771 | \r |
fb115c61 | 772 | if (Event != NULL) {\r |
773 | gBS->CloseEvent (Event);\r | |
774 | }\r | |
cbf316f2 | 775 | \r |
776 | return NULL;\r | |
777 | }\r | |
778 | \r | |
779 | \r | |
780 | /**\r | |
781 | Destroy the SndEntry.\r | |
e6ff63a5 | 782 | \r |
783 | This function pairs with IpIoCreateSndEntry().\r | |
cbf316f2 | 784 | \r |
6aac5e5f | 785 | @param[in] SndEntry Pointer to the send entry to be destroyed.\r |
cbf316f2 | 786 | \r |
cbf316f2 | 787 | **/\r |
cbf316f2 | 788 | VOID\r |
789 | IpIoDestroySndEntry (\r | |
790 | IN IP_IO_SEND_ENTRY *SndEntry\r | |
791 | )\r | |
792 | {\r | |
fb115c61 | 793 | EFI_EVENT Event;\r |
794 | IP_IO_IP_TX_DATA *TxData;\r | |
795 | IP_IO_OVERRIDE *Override;\r | |
796 | \r | |
797 | if (SndEntry->IpIo->IpVersion == IP_VERSION_4) {\r | |
798 | Event = SndEntry->SndToken.Ip4Token.Event;\r | |
799 | TxData = (IP_IO_IP_TX_DATA *) SndEntry->SndToken.Ip4Token.Packet.TxData;\r | |
800 | Override = (IP_IO_OVERRIDE *) TxData->Ip4TxData.OverrideData;\r | |
801 | } else if (SndEntry->IpIo->IpVersion == IP_VERSION_6) {\r | |
802 | Event = SndEntry->SndToken.Ip6Token.Event;\r | |
803 | TxData = (IP_IO_IP_TX_DATA *) SndEntry->SndToken.Ip6Token.Packet.TxData;\r | |
804 | Override = (IP_IO_OVERRIDE *) TxData->Ip6TxData.OverrideData;\r | |
805 | } else {\r | |
806 | return ;\r | |
807 | }\r | |
cbf316f2 | 808 | \r |
fb115c61 | 809 | gBS->CloseEvent (Event);\r |
cbf316f2 | 810 | \r |
fb115c61 | 811 | FreePool (TxData);\r |
812 | \r | |
813 | if (NULL != Override) {\r | |
814 | FreePool (Override);\r | |
cbf316f2 | 815 | }\r |
816 | \r | |
cbf316f2 | 817 | NetbufFree (SndEntry->Pkt);\r |
cbf316f2 | 818 | \r |
e48e37fc | 819 | RemoveEntryList (&SndEntry->Entry);\r |
cbf316f2 | 820 | \r |
fb115c61 | 821 | FreePool (SndEntry);\r |
cbf316f2 | 822 | }\r |
823 | \r | |
824 | \r | |
825 | /**\r | |
826 | Notify function for IP transmit token.\r | |
827 | \r | |
6aac5e5f | 828 | @param[in] Context The context passed in by the event notifier.\r |
cbf316f2 | 829 | \r |
cbf316f2 | 830 | **/\r |
cbf316f2 | 831 | VOID\r |
832 | EFIAPI\r | |
36ee91ca | 833 | IpIoTransmitHandlerDpc (\r |
cbf316f2 | 834 | IN VOID *Context\r |
835 | )\r | |
836 | {\r | |
837 | IP_IO *IpIo;\r | |
838 | IP_IO_SEND_ENTRY *SndEntry;\r | |
fb115c61 | 839 | EFI_STATUS Status;\r |
cbf316f2 | 840 | \r |
841 | SndEntry = (IP_IO_SEND_ENTRY *) Context;\r | |
842 | \r | |
843 | IpIo = SndEntry->IpIo;\r | |
844 | \r | |
fb115c61 | 845 | if (IpIo->IpVersion == IP_VERSION_4) {\r |
846 | Status = SndEntry->SndToken.Ip4Token.Status;\r | |
847 | } else if (IpIo->IpVersion == IP_VERSION_6){\r | |
848 | Status = SndEntry->SndToken.Ip6Token.Status;\r | |
849 | } else {\r | |
850 | return ;\r | |
851 | }\r | |
852 | \r | |
8de75da2 | 853 | if ((IpIo->PktSentNotify != NULL) && (SndEntry->NotifyData != NULL)) {\r |
cbf316f2 | 854 | IpIo->PktSentNotify (\r |
fb115c61 | 855 | Status,\r |
cbf316f2 | 856 | SndEntry->Context,\r |
857 | SndEntry->Ip,\r | |
858 | SndEntry->NotifyData\r | |
859 | );\r | |
860 | }\r | |
861 | \r | |
862 | IpIoDestroySndEntry (SndEntry);\r | |
863 | }\r | |
864 | \r | |
6aac5e5f | 865 | \r |
36ee91ca | 866 | /**\r |
867 | Notify function for IP transmit token.\r | |
868 | \r | |
6aac5e5f | 869 | @param[in] Event The event signaled.\r |
870 | @param[in] Context The context passed in by the event notifier.\r | |
36ee91ca | 871 | \r |
36ee91ca | 872 | **/\r |
36ee91ca | 873 | VOID\r |
874 | EFIAPI\r | |
875 | IpIoTransmitHandler (\r | |
876 | IN EFI_EVENT Event,\r | |
877 | IN VOID *Context\r | |
878 | )\r | |
879 | {\r | |
880 | //\r | |
881 | // Request IpIoTransmitHandlerDpc as a DPC at TPL_CALLBACK\r | |
882 | //\r | |
d8d26fb2 | 883 | QueueDpc (TPL_CALLBACK, IpIoTransmitHandlerDpc, Context);\r |
36ee91ca | 884 | }\r |
885 | \r | |
cbf316f2 | 886 | \r |
887 | /**\r | |
888 | The dummy handler for the dummy IP receive token.\r | |
889 | \r | |
6aac5e5f | 890 | @param[in] Context The context passed in by the event notifier.\r |
cbf316f2 | 891 | \r |
cbf316f2 | 892 | **/\r |
cbf316f2 | 893 | VOID\r |
894 | EFIAPI\r | |
36ee91ca | 895 | IpIoDummyHandlerDpc (\r |
cbf316f2 | 896 | IN VOID *Context\r |
897 | )\r | |
898 | {\r | |
899 | IP_IO_IP_INFO *IpInfo;\r | |
fb115c61 | 900 | EFI_STATUS Status;\r |
901 | EFI_EVENT RecycleEvent;\r | |
cbf316f2 | 902 | \r |
cbf316f2 | 903 | IpInfo = (IP_IO_IP_INFO *) Context;\r |
cbf316f2 | 904 | \r |
fb115c61 | 905 | if ((IpInfo->IpVersion != IP_VERSION_4) && (IpInfo->IpVersion != IP_VERSION_6)) {\r |
906 | return ;\r | |
907 | }\r | |
908 | \r | |
909 | RecycleEvent = NULL;\r | |
910 | \r | |
911 | if (IpInfo->IpVersion == IP_VERSION_4) {\r | |
912 | Status = IpInfo->DummyRcvToken.Ip4Token.Status;\r | |
913 | \r | |
914 | if (IpInfo->DummyRcvToken.Ip4Token.Packet.RxData != NULL) {\r | |
915 | RecycleEvent = IpInfo->DummyRcvToken.Ip4Token.Packet.RxData->RecycleSignal;\r | |
916 | }\r | |
917 | } else {\r | |
918 | Status = IpInfo->DummyRcvToken.Ip6Token.Status;\r | |
919 | \r | |
920 | if (IpInfo->DummyRcvToken.Ip6Token.Packet.RxData != NULL) {\r | |
921 | RecycleEvent = IpInfo->DummyRcvToken.Ip6Token.Packet.RxData->RecycleSignal;\r | |
922 | }\r | |
923 | }\r | |
924 | \r | |
925 | \r | |
926 | \r | |
927 | if (EFI_ABORTED == Status) {\r | |
36ee91ca | 928 | //\r |
929 | // The reception is actively aborted by the consumer, directly return.\r | |
930 | //\r | |
931 | return;\r | |
fb115c61 | 932 | } else if (EFI_SUCCESS == Status) {\r |
933 | //\r | |
934 | // Recycle the RxData.\r | |
935 | //\r | |
936 | ASSERT (RecycleEvent != NULL);\r | |
cbf316f2 | 937 | \r |
fb115c61 | 938 | gBS->SignalEvent (RecycleEvent);\r |
cbf316f2 | 939 | }\r |
940 | \r | |
fb115c61 | 941 | //\r |
942 | // Continue the receive.\r | |
943 | //\r | |
944 | if (IpInfo->IpVersion == IP_VERSION_4) {\r | |
2a2e33b2 | 945 | IpInfo->Ip.Ip4->Receive (\r |
946 | IpInfo->Ip.Ip4,\r | |
947 | &IpInfo->DummyRcvToken.Ip4Token\r | |
948 | );\r | |
fb115c61 | 949 | } else {\r |
2a2e33b2 | 950 | IpInfo->Ip.Ip6->Receive (\r |
951 | IpInfo->Ip.Ip6,\r | |
952 | &IpInfo->DummyRcvToken.Ip6Token\r | |
953 | );\r | |
fb115c61 | 954 | }\r |
cbf316f2 | 955 | }\r |
956 | \r | |
957 | \r | |
958 | /**\r | |
6aac5e5f | 959 | This function add IpIoDummyHandlerDpc to the end of the DPC queue.\r |
cbf316f2 | 960 | \r |
6aac5e5f | 961 | @param[in] Event The event signaled.\r |
962 | @param[in] Context The context passed in by the event notifier.\r | |
cbf316f2 | 963 | \r |
cbf316f2 | 964 | **/\r |
cbf316f2 | 965 | VOID\r |
966 | EFIAPI\r | |
36ee91ca | 967 | IpIoDummyHandler (\r |
cbf316f2 | 968 | IN EFI_EVENT Event,\r |
969 | IN VOID *Context\r | |
970 | )\r | |
36ee91ca | 971 | {\r |
972 | //\r | |
973 | // Request IpIoDummyHandlerDpc as a DPC at TPL_CALLBACK\r | |
974 | //\r | |
d8d26fb2 | 975 | QueueDpc (TPL_CALLBACK, IpIoDummyHandlerDpc, Context);\r |
36ee91ca | 976 | }\r |
977 | \r | |
978 | \r | |
979 | /**\r | |
980 | Notify function for the IP receive token, used to process\r | |
981 | the received IP packets.\r | |
982 | \r | |
6aac5e5f | 983 | @param[in] Context The context passed in by the event notifier.\r |
36ee91ca | 984 | \r |
36ee91ca | 985 | **/\r |
36ee91ca | 986 | VOID\r |
987 | EFIAPI\r | |
988 | IpIoListenHandlerDpc (\r | |
989 | IN VOID *Context\r | |
990 | )\r | |
cbf316f2 | 991 | {\r |
992 | IP_IO *IpIo;\r | |
993 | EFI_STATUS Status;\r | |
fb115c61 | 994 | IP_IO_IP_RX_DATA *RxData;\r |
cbf316f2 | 995 | EFI_NET_SESSION_DATA Session;\r |
996 | NET_BUF *Pkt;\r | |
997 | \r | |
fb115c61 | 998 | IpIo = (IP_IO *) Context;\r |
cbf316f2 | 999 | \r |
fb115c61 | 1000 | if (IpIo->IpVersion == IP_VERSION_4) {\r |
1001 | Status = IpIo->RcvToken.Ip4Token.Status;\r | |
1002 | RxData = (IP_IO_IP_RX_DATA *) IpIo->RcvToken.Ip4Token.Packet.RxData;\r | |
1003 | } else if (IpIo->IpVersion == IP_VERSION_6) {\r | |
1004 | Status = IpIo->RcvToken.Ip6Token.Status;\r | |
1005 | RxData = (IP_IO_IP_RX_DATA *) IpIo->RcvToken.Ip6Token.Packet.RxData;\r | |
1006 | } else {\r | |
1007 | return;\r | |
1008 | }\r | |
cbf316f2 | 1009 | \r |
36ee91ca | 1010 | if (EFI_ABORTED == Status) {\r |
1011 | //\r | |
1012 | // The reception is actively aborted by the consumer, directly return.\r | |
1013 | //\r | |
1014 | return;\r | |
1015 | }\r | |
1016 | \r | |
cbf316f2 | 1017 | if (((EFI_SUCCESS != Status) && (EFI_ICMP_ERROR != Status)) || (NULL == RxData)) {\r |
1018 | //\r | |
6aac5e5f | 1019 | // @bug Only process the normal packets and the icmp error packets, if RxData is NULL\r |
1020 | // @bug with Status == EFI_SUCCESS or EFI_ICMP_ERROR, just resume the receive although\r | |
1021 | // @bug this should be a bug of the low layer (IP).\r | |
cbf316f2 | 1022 | //\r |
1023 | goto Resume;\r | |
1024 | }\r | |
1025 | \r | |
1026 | if (NULL == IpIo->PktRcvdNotify) {\r | |
1027 | goto CleanUp;\r | |
1028 | }\r | |
1029 | \r | |
fb115c61 | 1030 | if (IpIo->IpVersion == IP_VERSION_4) {\r |
1031 | if ((EFI_IP4 (RxData->Ip4RxData.Header->SourceAddress) != 0) &&\r | |
1b31acb6 FS |
1032 | !NetIp4IsUnicast (EFI_NTOHL (((EFI_IP4_RECEIVE_DATA *) RxData)->Header->SourceAddress), 0)) {\r |
1033 | //\r | |
1034 | // The source address is not zero and it's not a unicast IP address, discard it.\r | |
1035 | //\r | |
1036 | goto CleanUp;\r | |
1037 | }\r | |
1038 | \r | |
1039 | if (RxData->Ip4RxData.DataLength == 0) {\r | |
1040 | //\r | |
1041 | // Discard zero length data payload packet.\r | |
1042 | //\r | |
1043 | goto CleanUp;\r | |
1044 | }\r | |
1045 | \r | |
cbf316f2 | 1046 | //\r |
1b31acb6 | 1047 | // Create a netbuffer representing IPv4 packet\r |
cbf316f2 | 1048 | //\r |
1b31acb6 FS |
1049 | Pkt = NetbufFromExt (\r |
1050 | (NET_FRAGMENT *) RxData->Ip4RxData.FragmentTable,\r | |
1051 | RxData->Ip4RxData.FragmentCount,\r | |
1052 | 0,\r | |
1053 | 0,\r | |
1054 | IpIoExtFree,\r | |
1055 | RxData->Ip4RxData.RecycleSignal\r | |
1056 | );\r | |
1057 | if (NULL == Pkt) {\r | |
1058 | goto CleanUp;\r | |
1059 | }\r | |
cbf316f2 | 1060 | \r |
1b31acb6 FS |
1061 | //\r |
1062 | // Create a net session\r | |
1063 | //\r | |
1064 | Session.Source.Addr[0] = EFI_IP4 (RxData->Ip4RxData.Header->SourceAddress);\r | |
1065 | Session.Dest.Addr[0] = EFI_IP4 (RxData->Ip4RxData.Header->DestinationAddress);\r | |
1066 | Session.IpHdr.Ip4Hdr = RxData->Ip4RxData.Header;\r | |
1067 | Session.IpHdrLen = RxData->Ip4RxData.HeaderLength;\r | |
1068 | Session.IpVersion = IP_VERSION_4;\r | |
fb115c61 | 1069 | } else {\r |
1070 | \r | |
f6b7393c | 1071 | if (!NetIp6IsValidUnicast(&RxData->Ip6RxData.Header->SourceAddress)) {\r |
fb115c61 | 1072 | goto CleanUp;\r |
1073 | }\r | |
1074 | \r | |
1b31acb6 FS |
1075 | if (RxData->Ip6RxData.DataLength == 0) {\r |
1076 | //\r | |
1077 | // Discard zero length data payload packet.\r | |
1078 | //\r | |
1079 | goto CleanUp;\r | |
1080 | }\r | |
1081 | \r | |
fb115c61 | 1082 | //\r |
1083 | // Create a netbuffer representing IPv6 packet\r | |
1084 | //\r | |
1085 | Pkt = NetbufFromExt (\r | |
1086 | (NET_FRAGMENT *) RxData->Ip6RxData.FragmentTable,\r | |
1087 | RxData->Ip6RxData.FragmentCount,\r | |
1088 | 0,\r | |
1089 | 0,\r | |
1090 | IpIoExtFree,\r | |
1091 | RxData->Ip6RxData.RecycleSignal\r | |
1092 | );\r | |
1093 | if (NULL == Pkt) {\r | |
1094 | goto CleanUp;\r | |
1095 | }\r | |
1096 | \r | |
1097 | //\r | |
1098 | // Create a net session\r | |
1099 | //\r | |
1100 | CopyMem (\r | |
1101 | &Session.Source, \r | |
1102 | &RxData->Ip6RxData.Header->SourceAddress,\r | |
1103 | sizeof(EFI_IPv6_ADDRESS)\r | |
1104 | );\r | |
1105 | CopyMem (\r | |
1106 | &Session.Dest, \r | |
1107 | &RxData->Ip6RxData.Header->DestinationAddress, \r | |
1108 | sizeof(EFI_IPv6_ADDRESS)\r | |
1109 | );\r | |
1110 | Session.IpHdr.Ip6Hdr = RxData->Ip6RxData.Header;\r | |
a09ee46d | 1111 | Session.IpHdrLen = RxData->Ip6RxData.HeaderLength;\r |
fb115c61 | 1112 | Session.IpVersion = IP_VERSION_6;\r |
1113 | } \r | |
cbf316f2 | 1114 | \r |
1115 | if (EFI_SUCCESS == Status) {\r | |
1116 | \r | |
b45b45b2 | 1117 | IpIo->PktRcvdNotify (EFI_SUCCESS, 0, &Session, Pkt, IpIo->RcvdContext);\r |
cbf316f2 | 1118 | } else {\r |
1119 | //\r | |
1120 | // Status is EFI_ICMP_ERROR\r | |
1121 | //\r | |
1122 | Status = IpIoIcmpHandler (IpIo, Pkt, &Session);\r | |
1123 | if (EFI_ERROR (Status)) {\r | |
1124 | NetbufFree (Pkt);\r | |
1125 | }\r | |
1126 | }\r | |
1127 | \r | |
1128 | goto Resume;\r | |
1129 | \r | |
1130 | CleanUp:\r | |
fb115c61 | 1131 | \r |
1132 | if (IpIo->IpVersion == IP_VERSION_4){\r | |
1133 | gBS->SignalEvent (RxData->Ip4RxData.RecycleSignal);\r | |
1134 | } else {\r | |
1135 | gBS->SignalEvent (RxData->Ip6RxData.RecycleSignal); \r | |
1136 | }\r | |
cbf316f2 | 1137 | \r |
1138 | Resume:\r | |
cbf316f2 | 1139 | \r |
fb115c61 | 1140 | if (IpIo->IpVersion == IP_VERSION_4){\r |
2a2e33b2 | 1141 | IpIo->Ip.Ip4->Receive (IpIo->Ip.Ip4, &(IpIo->RcvToken.Ip4Token));\r |
fb115c61 | 1142 | } else {\r |
2a2e33b2 | 1143 | IpIo->Ip.Ip6->Receive (IpIo->Ip.Ip6, &(IpIo->RcvToken.Ip6Token));\r |
fb115c61 | 1144 | }\r |
1145 | }\r | |
cbf316f2 | 1146 | \r |
36ee91ca | 1147 | /**\r |
6aac5e5f | 1148 | This function add IpIoListenHandlerDpc to the end of the DPC queue.\r |
36ee91ca | 1149 | \r |
6aac5e5f | 1150 | @param[in] Event The event signaled.\r |
1151 | @param[in] Context The context passed in by the event notifier.\r | |
36ee91ca | 1152 | \r |
1153 | **/\r | |
36ee91ca | 1154 | VOID\r |
1155 | EFIAPI\r | |
1156 | IpIoListenHandler (\r | |
1157 | IN EFI_EVENT Event,\r | |
1158 | IN VOID *Context\r | |
1159 | )\r | |
1160 | {\r | |
1161 | //\r | |
1162 | // Request IpIoListenHandlerDpc as a DPC at TPL_CALLBACK\r | |
1163 | //\r | |
d8d26fb2 | 1164 | QueueDpc (TPL_CALLBACK, IpIoListenHandlerDpc, Context);\r |
36ee91ca | 1165 | }\r |
1166 | \r | |
1167 | \r | |
cbf316f2 | 1168 | /**\r |
1169 | Create a new IP_IO instance.\r | |
e6ff63a5 | 1170 | \r |
fb115c61 | 1171 | This function uses IP4/IP6 service binding protocol in Controller to create\r |
1172 | an IP4/IP6 child (aka IP4/IP6 instance).\r | |
cbf316f2 | 1173 | \r |
6aac5e5f | 1174 | @param[in] Image The image handle of the driver or application that\r |
e6ff63a5 | 1175 | consumes IP_IO.\r |
fb115c61 | 1176 | @param[in] Controller The controller handle that has IP4 or IP6 service\r |
1177 | binding protocol installed.\r | |
1178 | @param[in] IpVersion The version of the IP protocol to use, either\r | |
1179 | IPv4 or IPv6. \r | |
cbf316f2 | 1180 | \r |
e6ff63a5 | 1181 | @return Pointer to a newly created IP_IO instance, or NULL if failed.\r |
cbf316f2 | 1182 | \r |
1183 | **/\r | |
1184 | IP_IO *\r | |
7b414b4e | 1185 | EFIAPI\r |
cbf316f2 | 1186 | IpIoCreate (\r |
1187 | IN EFI_HANDLE Image,\r | |
fb115c61 | 1188 | IN EFI_HANDLE Controller,\r |
b45b45b2 | 1189 | IN UINT8 IpVersion\r |
cbf316f2 | 1190 | )\r |
1191 | {\r | |
1192 | EFI_STATUS Status;\r | |
1193 | IP_IO *IpIo;\r | |
fb115c61 | 1194 | EFI_EVENT Event;\r |
1195 | \r | |
1196 | ASSERT ((IpVersion == IP_VERSION_4) || (IpVersion == IP_VERSION_6));\r | |
cbf316f2 | 1197 | \r |
e48e37fc | 1198 | IpIo = AllocateZeroPool (sizeof (IP_IO));\r |
cbf316f2 | 1199 | if (NULL == IpIo) {\r |
1200 | return NULL;\r | |
1201 | }\r | |
1202 | \r | |
e48e37fc | 1203 | InitializeListHead (&(IpIo->PendingSndList));\r |
1204 | InitializeListHead (&(IpIo->IpList));\r | |
cbf316f2 | 1205 | IpIo->Controller = Controller;\r |
1206 | IpIo->Image = Image;\r | |
fb115c61 | 1207 | IpIo->IpVersion = IpVersion;\r |
1208 | Event = NULL;\r | |
cbf316f2 | 1209 | \r |
1210 | Status = gBS->CreateEvent (\r | |
1211 | EVT_NOTIFY_SIGNAL,\r | |
e48e37fc | 1212 | TPL_NOTIFY,\r |
cbf316f2 | 1213 | IpIoListenHandler,\r |
1214 | IpIo,\r | |
fb115c61 | 1215 | &Event\r |
cbf316f2 | 1216 | );\r |
1217 | if (EFI_ERROR (Status)) {\r | |
1218 | goto ReleaseIpIo;\r | |
1219 | }\r | |
1220 | \r | |
fb115c61 | 1221 | if (IpVersion == IP_VERSION_4) {\r |
1222 | IpIo->RcvToken.Ip4Token.Event = Event;\r | |
1223 | } else {\r | |
1224 | IpIo->RcvToken.Ip6Token.Event = Event;\r | |
1225 | }\r | |
1226 | \r | |
cbf316f2 | 1227 | //\r |
1228 | // Create an IP child and open IP protocol\r | |
1229 | //\r | |
1230 | Status = IpIoCreateIpChildOpenProtocol (\r | |
1231 | Controller,\r | |
1232 | Image,\r | |
1233 | &IpIo->ChildHandle,\r | |
fb115c61 | 1234 | IpVersion, \r |
cbf316f2 | 1235 | (VOID **)&(IpIo->Ip)\r |
1236 | );\r | |
1237 | if (EFI_ERROR (Status)) {\r | |
1238 | goto ReleaseIpIo;\r | |
1239 | }\r | |
1240 | \r | |
1241 | return IpIo;\r | |
1242 | \r | |
1243 | ReleaseIpIo:\r | |
1244 | \r | |
fb115c61 | 1245 | if (Event != NULL) {\r |
1246 | gBS->CloseEvent (Event);\r | |
cbf316f2 | 1247 | }\r |
1248 | \r | |
e48e37fc | 1249 | gBS->FreePool (IpIo);\r |
cbf316f2 | 1250 | \r |
1251 | return NULL;\r | |
1252 | }\r | |
1253 | \r | |
1254 | \r | |
1255 | /**\r | |
1256 | Open an IP_IO instance for use.\r | |
e6ff63a5 | 1257 | \r |
1258 | This function is called after IpIoCreate(). It is used for configuring the IP\r | |
1259 | instance and register the callbacks and their context data for sending and\r | |
1260 | receiving IP packets.\r | |
cbf316f2 | 1261 | \r |
6aac5e5f | 1262 | @param[in, out] IpIo Pointer to an IP_IO instance that needs\r |
1263 | to open.\r | |
1264 | @param[in] OpenData The configuration data and callbacks for\r | |
1265 | the IP_IO instance.\r | |
cbf316f2 | 1266 | \r |
6aac5e5f | 1267 | @retval EFI_SUCCESS The IP_IO instance opened with OpenData\r |
1268 | successfully.\r | |
1269 | @retval EFI_ACCESS_DENIED The IP_IO instance is configured, avoid to \r | |
1270 | reopen it.\r | |
1271 | @retval Others Error condition occurred.\r | |
cbf316f2 | 1272 | \r |
1273 | **/\r | |
1274 | EFI_STATUS\r | |
7b414b4e | 1275 | EFIAPI\r |
cbf316f2 | 1276 | IpIoOpen (\r |
6aac5e5f | 1277 | IN OUT IP_IO *IpIo,\r |
1278 | IN IP_IO_OPEN_DATA *OpenData\r | |
cbf316f2 | 1279 | )\r |
1280 | {\r | |
1281 | EFI_STATUS Status;\r | |
b45b45b2 | 1282 | UINT8 IpVersion;\r |
cbf316f2 | 1283 | \r |
1284 | if (IpIo->IsConfigured) {\r | |
1285 | return EFI_ACCESS_DENIED;\r | |
1286 | }\r | |
1287 | \r | |
fb115c61 | 1288 | IpVersion = IpIo->IpVersion;\r |
1289 | \r | |
1290 | ASSERT ((IpVersion == IP_VERSION_4) || (IpVersion == IP_VERSION_6));\r | |
1291 | \r | |
cbf316f2 | 1292 | //\r |
1293 | // configure ip\r | |
1294 | //\r | |
fb115c61 | 1295 | if (IpVersion == IP_VERSION_4){\r |
1b31acb6 FS |
1296 | //\r |
1297 | // RawData mode is no supported.\r | |
1298 | //\r | |
1299 | ASSERT (!OpenData->IpConfigData.Ip4CfgData.RawData);\r | |
1300 | if (OpenData->IpConfigData.Ip4CfgData.RawData) {\r | |
1301 | return EFI_UNSUPPORTED;\r | |
1302 | }\r | |
1303 | \r | |
2a2e33b2 | 1304 | Status = IpIo->Ip.Ip4->Configure (\r |
1305 | IpIo->Ip.Ip4,\r | |
1306 | &OpenData->IpConfigData.Ip4CfgData\r | |
1307 | );\r | |
fb115c61 | 1308 | } else {\r |
1309 | \r | |
2a2e33b2 | 1310 | Status = IpIo->Ip.Ip6->Configure (\r |
1311 | IpIo->Ip.Ip6, \r | |
1312 | &OpenData->IpConfigData.Ip6CfgData\r | |
1313 | );\r | |
fb115c61 | 1314 | }\r |
1315 | \r | |
cbf316f2 | 1316 | if (EFI_ERROR (Status)) {\r |
1317 | return Status;\r | |
1318 | }\r | |
1319 | \r | |
1320 | //\r | |
6aac5e5f | 1321 | // @bug To delete the default route entry in this Ip, if it is:\r |
1322 | // @bug (0.0.0.0, 0.0.0.0, 0.0.0.0). Delete this statement if Ip modified\r | |
1323 | // @bug its code\r | |
cbf316f2 | 1324 | //\r |
fb115c61 | 1325 | if (IpVersion == IP_VERSION_4){\r |
2a2e33b2 | 1326 | Status = IpIo->Ip.Ip4->Routes (\r |
1327 | IpIo->Ip.Ip4,\r | |
1328 | TRUE,\r | |
1329 | &mZeroIp4Addr,\r | |
1330 | &mZeroIp4Addr,\r | |
1331 | &mZeroIp4Addr\r | |
1332 | );\r | |
fb115c61 | 1333 | \r |
1334 | if (EFI_ERROR (Status) && (EFI_NOT_FOUND != Status)) {\r | |
1335 | return Status;\r | |
1336 | }\r | |
cbf316f2 | 1337 | }\r |
1338 | \r | |
1339 | IpIo->PktRcvdNotify = OpenData->PktRcvdNotify;\r | |
1340 | IpIo->PktSentNotify = OpenData->PktSentNotify;\r | |
1341 | \r | |
1342 | IpIo->RcvdContext = OpenData->RcvdContext;\r | |
1343 | IpIo->SndContext = OpenData->SndContext;\r | |
1344 | \r | |
fb115c61 | 1345 | if (IpVersion == IP_VERSION_4){\r |
1346 | IpIo->Protocol = OpenData->IpConfigData.Ip4CfgData.DefaultProtocol;\r | |
cbf316f2 | 1347 | \r |
fb115c61 | 1348 | //\r |
1349 | // start to listen incoming packet\r | |
1350 | //\r | |
2a2e33b2 | 1351 | Status = IpIo->Ip.Ip4->Receive (\r |
1352 | IpIo->Ip.Ip4,\r | |
1353 | &(IpIo->RcvToken.Ip4Token)\r | |
1354 | );\r | |
fb115c61 | 1355 | if (EFI_ERROR (Status)) {\r |
2a2e33b2 | 1356 | IpIo->Ip.Ip4->Configure (IpIo->Ip.Ip4, NULL);\r |
fb115c61 | 1357 | goto ErrorExit;\r |
1358 | }\r | |
1359 | \r | |
1360 | } else {\r | |
1361 | \r | |
1362 | IpIo->Protocol = OpenData->IpConfigData.Ip6CfgData.DefaultProtocol;\r | |
2a2e33b2 | 1363 | Status = IpIo->Ip.Ip6->Receive (\r |
1364 | IpIo->Ip.Ip6,\r | |
1365 | &(IpIo->RcvToken.Ip6Token)\r | |
1366 | );\r | |
fb115c61 | 1367 | if (EFI_ERROR (Status)) {\r |
2a2e33b2 | 1368 | IpIo->Ip.Ip6->Configure (IpIo->Ip.Ip6, NULL);\r |
fb115c61 | 1369 | goto ErrorExit;\r |
1370 | }\r | |
cbf316f2 | 1371 | }\r |
1372 | \r | |
1373 | IpIo->IsConfigured = TRUE;\r | |
e48e37fc | 1374 | InsertTailList (&mActiveIpIoList, &IpIo->Entry);\r |
cbf316f2 | 1375 | \r |
1376 | ErrorExit:\r | |
1377 | \r | |
1378 | return Status;\r | |
1379 | }\r | |
1380 | \r | |
1381 | \r | |
1382 | /**\r | |
1383 | Stop an IP_IO instance.\r | |
e6ff63a5 | 1384 | \r |
1385 | This function is paired with IpIoOpen(). The IP_IO will be unconfigured and all\r | |
1386 | the pending send/receive tokens will be canceled.\r | |
cbf316f2 | 1387 | \r |
6aac5e5f | 1388 | @param[in, out] IpIo Pointer to the IP_IO instance that needs to stop.\r |
cbf316f2 | 1389 | \r |
6aac5e5f | 1390 | @retval EFI_SUCCESS The IP_IO instance stopped successfully.\r |
1391 | @retval Others Error condition occurred.\r | |
cbf316f2 | 1392 | \r |
1393 | **/\r | |
1394 | EFI_STATUS\r | |
e6ff63a5 | 1395 | EFIAPI\r |
cbf316f2 | 1396 | IpIoStop (\r |
6aac5e5f | 1397 | IN OUT IP_IO *IpIo\r |
cbf316f2 | 1398 | )\r |
1399 | {\r | |
1400 | EFI_STATUS Status;\r | |
cbf316f2 | 1401 | IP_IO_IP_INFO *IpInfo;\r |
b45b45b2 | 1402 | UINT8 IpVersion;\r |
cbf316f2 | 1403 | \r |
1404 | if (!IpIo->IsConfigured) {\r | |
1405 | return EFI_SUCCESS;\r | |
1406 | }\r | |
1407 | \r | |
fb115c61 | 1408 | IpVersion = IpIo->IpVersion;\r |
1409 | \r | |
1410 | ASSERT ((IpVersion == IP_VERSION_4) || (IpVersion == IP_VERSION_6));\r | |
1411 | \r | |
cbf316f2 | 1412 | //\r |
1413 | // Remove the IpIo from the active IpIo list.\r | |
1414 | //\r | |
e48e37fc | 1415 | RemoveEntryList (&IpIo->Entry);\r |
cbf316f2 | 1416 | \r |
cbf316f2 | 1417 | //\r |
1418 | // Configure NULL Ip\r | |
1419 | //\r | |
fb115c61 | 1420 | if (IpVersion == IP_VERSION_4) {\r |
2a2e33b2 | 1421 | Status = IpIo->Ip.Ip4->Configure (IpIo->Ip.Ip4, NULL);\r |
fb115c61 | 1422 | } else {\r |
2a2e33b2 | 1423 | Status = IpIo->Ip.Ip6->Configure (IpIo->Ip.Ip6, NULL);\r |
fb115c61 | 1424 | }\r |
cbf316f2 | 1425 | if (EFI_ERROR (Status)) {\r |
1426 | return Status;\r | |
1427 | }\r | |
1428 | \r | |
1429 | IpIo->IsConfigured = FALSE;\r | |
1430 | \r | |
1431 | //\r | |
1432 | // Detroy the Ip List used by IpIo\r | |
1433 | //\r | |
34edf2ae | 1434 | \r |
e48e37fc | 1435 | while (!IsListEmpty (&(IpIo->IpList))) {\r |
cbf316f2 | 1436 | IpInfo = NET_LIST_HEAD (&(IpIo->IpList), IP_IO_IP_INFO, Entry);\r |
1437 | \r | |
1438 | IpIoRemoveIp (IpIo, IpInfo);\r | |
1439 | }\r | |
1440 | \r | |
1441 | //\r | |
6aac5e5f | 1442 | // All pending send tokens should be flushed by reseting the IP instances.\r |
cbf316f2 | 1443 | //\r |
e48e37fc | 1444 | ASSERT (IsListEmpty (&IpIo->PendingSndList));\r |
cbf316f2 | 1445 | \r |
1446 | //\r | |
1447 | // Close the receive event.\r | |
1448 | //\r | |
fb115c61 | 1449 | if (IpVersion == IP_VERSION_4){\r |
1450 | gBS->CloseEvent (IpIo->RcvToken.Ip4Token.Event);\r | |
1451 | } else {\r | |
1452 | gBS->CloseEvent (IpIo->RcvToken.Ip6Token.Event);\r | |
1453 | }\r | |
cbf316f2 | 1454 | \r |
1455 | return EFI_SUCCESS;\r | |
1456 | }\r | |
1457 | \r | |
1458 | \r | |
1459 | /**\r | |
1460 | Destroy an IP_IO instance.\r | |
e6ff63a5 | 1461 | \r |
1462 | This function is paired with IpIoCreate(). The IP_IO will be closed first.\r | |
8f5e6151 | 1463 | Resource will be freed afterwards. See IpIoCloseProtocolDestroyIpChild().\r |
cbf316f2 | 1464 | \r |
6aac5e5f | 1465 | @param[in, out] IpIo Pointer to the IP_IO instance that needs to be\r |
e6ff63a5 | 1466 | destroyed.\r |
cbf316f2 | 1467 | \r |
6aac5e5f | 1468 | @retval EFI_SUCCESS The IP_IO instance destroyed successfully.\r |
1469 | @retval Others Error condition occurred.\r | |
cbf316f2 | 1470 | \r |
1471 | **/\r | |
1472 | EFI_STATUS\r | |
7b414b4e | 1473 | EFIAPI\r |
cbf316f2 | 1474 | IpIoDestroy (\r |
6aac5e5f | 1475 | IN OUT IP_IO *IpIo\r |
cbf316f2 | 1476 | )\r |
1477 | {\r | |
1478 | //\r | |
1479 | // Stop the IpIo.\r | |
1480 | //\r | |
1481 | IpIoStop (IpIo);\r | |
1482 | \r | |
1483 | //\r | |
1484 | // Close the IP protocol and destroy the child.\r | |
1485 | //\r | |
fb115c61 | 1486 | IpIoCloseProtocolDestroyIpChild (\r |
1487 | IpIo->Controller,\r | |
1488 | IpIo->Image,\r | |
1489 | IpIo->ChildHandle,\r | |
1490 | IpIo->IpVersion\r | |
1491 | );\r | |
cbf316f2 | 1492 | \r |
e48e37fc | 1493 | gBS->FreePool (IpIo);\r |
cbf316f2 | 1494 | \r |
1495 | return EFI_SUCCESS;\r | |
1496 | }\r | |
1497 | \r | |
1498 | \r | |
1499 | /**\r | |
1500 | Send out an IP packet.\r | |
e6ff63a5 | 1501 | \r |
1502 | This function is called after IpIoOpen(). The data to be sent are wrapped in\r | |
1503 | Pkt. The IP instance wrapped in IpIo is used for sending by default but can be\r | |
1504 | overriden by Sender. Other sending configs, like source address and gateway\r | |
1505 | address etc., are specified in OverrideData.\r | |
cbf316f2 | 1506 | \r |
6aac5e5f | 1507 | @param[in, out] IpIo Pointer to an IP_IO instance used for sending IP\r |
1508 | packet.\r | |
1509 | @param[in, out] Pkt Pointer to the IP packet to be sent.\r | |
1510 | @param[in] Sender The IP protocol instance used for sending.\r | |
8f5e6151 | 1511 | @param[in] Context Optional context data.\r |
1512 | @param[in] NotifyData Optional notify data.\r | |
6aac5e5f | 1513 | @param[in] Dest The destination IP address to send this packet to.\r |
1514 | @param[in] OverrideData The data to override some configuration of the IP\r | |
1515 | instance used for sending.\r | |
cbf316f2 | 1516 | \r |
6aac5e5f | 1517 | @retval EFI_SUCCESS The operation is completed successfully.\r |
1518 | @retval EFI_NOT_STARTED The IpIo is not configured.\r | |
1519 | @retval EFI_OUT_OF_RESOURCES Failed due to resource limit.\r | |
cbf316f2 | 1520 | \r |
1521 | **/\r | |
1522 | EFI_STATUS\r | |
7b414b4e | 1523 | EFIAPI\r |
cbf316f2 | 1524 | IpIoSend (\r |
6aac5e5f | 1525 | IN OUT IP_IO *IpIo,\r |
1526 | IN OUT NET_BUF *Pkt,\r | |
1527 | IN IP_IO_IP_INFO *Sender OPTIONAL,\r | |
1528 | IN VOID *Context OPTIONAL,\r | |
1529 | IN VOID *NotifyData OPTIONAL,\r | |
fb115c61 | 1530 | IN EFI_IP_ADDRESS *Dest,\r |
6aac5e5f | 1531 | IN IP_IO_OVERRIDE *OverrideData OPTIONAL\r |
cbf316f2 | 1532 | )\r |
1533 | {\r | |
1534 | EFI_STATUS Status;\r | |
2a2e33b2 | 1535 | IP_IO_IP_PROTOCOL Ip;\r |
cbf316f2 | 1536 | IP_IO_SEND_ENTRY *SndEntry;\r |
1537 | \r | |
fb115c61 | 1538 | ASSERT ((IpIo->IpVersion != IP_VERSION_4) || (Dest != NULL));\r |
1539 | \r | |
cbf316f2 | 1540 | if (!IpIo->IsConfigured) {\r |
1541 | return EFI_NOT_STARTED;\r | |
1542 | }\r | |
1543 | \r | |
1544 | Ip = (NULL == Sender) ? IpIo->Ip : Sender->Ip;\r | |
1545 | \r | |
1546 | //\r | |
1547 | // create a new SndEntry\r | |
1548 | //\r | |
1549 | SndEntry = IpIoCreateSndEntry (IpIo, Pkt, Ip, Context, NotifyData, Dest, OverrideData);\r | |
1550 | if (NULL == SndEntry) {\r | |
1551 | return EFI_OUT_OF_RESOURCES;\r | |
1552 | }\r | |
1553 | \r | |
1554 | //\r | |
1555 | // Send this Packet\r | |
1556 | //\r | |
fb115c61 | 1557 | if (IpIo->IpVersion == IP_VERSION_4){\r |
2a2e33b2 | 1558 | Status = Ip.Ip4->Transmit (\r |
1559 | Ip.Ip4,\r | |
1560 | &SndEntry->SndToken.Ip4Token\r | |
1561 | );\r | |
fb115c61 | 1562 | } else {\r |
2a2e33b2 | 1563 | Status = Ip.Ip6->Transmit (\r |
1564 | Ip.Ip6,\r | |
1565 | &SndEntry->SndToken.Ip6Token\r | |
1566 | );\r | |
fb115c61 | 1567 | }\r |
1568 | \r | |
cbf316f2 | 1569 | if (EFI_ERROR (Status)) {\r |
1570 | IpIoDestroySndEntry (SndEntry);\r | |
1571 | }\r | |
1572 | \r | |
1573 | return Status;\r | |
1574 | }\r | |
1575 | \r | |
1576 | \r | |
1577 | /**\r | |
1578 | Cancel the IP transmit token which wraps this Packet.\r | |
1579 | \r | |
6aac5e5f | 1580 | @param[in] IpIo Pointer to the IP_IO instance.\r |
1581 | @param[in] Packet Pointer to the packet of NET_BUF to cancel.\r | |
cbf316f2 | 1582 | \r |
1583 | **/\r | |
1584 | VOID\r | |
7b414b4e | 1585 | EFIAPI\r |
cbf316f2 | 1586 | IpIoCancelTxToken (\r |
1587 | IN IP_IO *IpIo,\r | |
1588 | IN VOID *Packet\r | |
1589 | )\r | |
1590 | {\r | |
e48e37fc | 1591 | LIST_ENTRY *Node;\r |
cbf316f2 | 1592 | IP_IO_SEND_ENTRY *SndEntry;\r |
2a2e33b2 | 1593 | IP_IO_IP_PROTOCOL Ip;\r |
cbf316f2 | 1594 | \r |
fb115c61 | 1595 | ASSERT ((IpIo != NULL) && (Packet != NULL));\r |
cbf316f2 | 1596 | \r |
1597 | NET_LIST_FOR_EACH (Node, &IpIo->PendingSndList) {\r | |
1598 | \r | |
1599 | SndEntry = NET_LIST_USER_STRUCT (Node, IP_IO_SEND_ENTRY, Entry);\r | |
1600 | \r | |
1601 | if (SndEntry->Pkt == Packet) {\r | |
1602 | \r | |
1603 | Ip = SndEntry->Ip;\r | |
fb115c61 | 1604 | \r |
1605 | if (IpIo->IpVersion == IP_VERSION_4) {\r | |
2a2e33b2 | 1606 | Ip.Ip4->Cancel (\r |
1607 | Ip.Ip4,\r | |
1608 | &SndEntry->SndToken.Ip4Token\r | |
1609 | );\r | |
fb115c61 | 1610 | } else {\r |
2a2e33b2 | 1611 | Ip.Ip6->Cancel (\r |
1612 | Ip.Ip6,\r | |
1613 | &SndEntry->SndToken.Ip6Token\r | |
1614 | );\r | |
fb115c61 | 1615 | }\r |
cbf316f2 | 1616 | \r |
cbf316f2 | 1617 | break;\r |
1618 | }\r | |
1619 | }\r | |
1620 | \r | |
1621 | }\r | |
1622 | \r | |
1623 | \r | |
1624 | /**\r | |
1625 | Add a new IP instance for sending data.\r | |
e6ff63a5 | 1626 | \r |
1627 | The function is used to add the IP_IO to the IP_IO sending list. The caller\r | |
1628 | can later use IpIoFindSender() to get the IP_IO and call IpIoSend() to send\r | |
1629 | data.\r | |
cbf316f2 | 1630 | \r |
6aac5e5f | 1631 | @param[in, out] IpIo Pointer to a IP_IO instance to add a new IP\r |
1632 | instance for sending purpose.\r | |
cbf316f2 | 1633 | \r |
e6ff63a5 | 1634 | @return Pointer to the created IP_IO_IP_INFO structure, NULL if failed.\r |
cbf316f2 | 1635 | \r |
1636 | **/\r | |
1637 | IP_IO_IP_INFO *\r | |
7b414b4e | 1638 | EFIAPI\r |
cbf316f2 | 1639 | IpIoAddIp (\r |
6aac5e5f | 1640 | IN OUT IP_IO *IpIo\r |
cbf316f2 | 1641 | )\r |
1642 | {\r | |
1643 | EFI_STATUS Status;\r | |
1644 | IP_IO_IP_INFO *IpInfo;\r | |
fb115c61 | 1645 | EFI_EVENT Event;\r |
cbf316f2 | 1646 | \r |
6aac5e5f | 1647 | ASSERT (IpIo != NULL);\r |
cbf316f2 | 1648 | \r |
e48e37fc | 1649 | IpInfo = AllocatePool (sizeof (IP_IO_IP_INFO));\r |
cbf316f2 | 1650 | if (IpInfo == NULL) {\r |
fb115c61 | 1651 | return NULL;\r |
cbf316f2 | 1652 | }\r |
1653 | \r | |
1654 | //\r | |
1655 | // Init this IpInfo, set the Addr and SubnetMask to 0 before we configure the IP\r | |
1656 | // instance.\r | |
1657 | //\r | |
e48e37fc | 1658 | InitializeListHead (&IpInfo->Entry);\r |
cbf316f2 | 1659 | IpInfo->ChildHandle = NULL;\r |
fb115c61 | 1660 | ZeroMem (&IpInfo->Addr, sizeof (IpInfo->Addr));\r |
1661 | ZeroMem (&IpInfo->PreMask, sizeof (IpInfo->PreMask));\r | |
1662 | \r | |
1663 | IpInfo->RefCnt = 1;\r | |
1664 | IpInfo->IpVersion = IpIo->IpVersion;\r | |
cbf316f2 | 1665 | \r |
1666 | //\r | |
fb115c61 | 1667 | // Create the IP instance and open the IP protocol.\r |
cbf316f2 | 1668 | //\r |
1669 | Status = IpIoCreateIpChildOpenProtocol (\r | |
1670 | IpIo->Controller,\r | |
1671 | IpIo->Image,\r | |
1672 | &IpInfo->ChildHandle,\r | |
fb115c61 | 1673 | IpInfo->IpVersion,\r |
4eb65aff | 1674 | (VOID **) &IpInfo->Ip\r |
cbf316f2 | 1675 | );\r |
1676 | if (EFI_ERROR (Status)) {\r | |
1677 | goto ReleaseIpInfo;\r | |
1678 | }\r | |
1679 | \r | |
1680 | //\r | |
1681 | // Create the event for the DummyRcvToken.\r | |
1682 | //\r | |
1683 | Status = gBS->CreateEvent (\r | |
1684 | EVT_NOTIFY_SIGNAL,\r | |
e48e37fc | 1685 | TPL_NOTIFY,\r |
cbf316f2 | 1686 | IpIoDummyHandler,\r |
1687 | IpInfo,\r | |
fb115c61 | 1688 | &Event\r |
cbf316f2 | 1689 | );\r |
1690 | if (EFI_ERROR (Status)) {\r | |
1691 | goto ReleaseIpChild;\r | |
1692 | }\r | |
1693 | \r | |
fb115c61 | 1694 | if (IpInfo->IpVersion == IP_VERSION_4) {\r |
1695 | IpInfo->DummyRcvToken.Ip4Token.Event = Event;\r | |
1696 | } else {\r | |
1697 | IpInfo->DummyRcvToken.Ip6Token.Event = Event;\r | |
1698 | }\r | |
1699 | \r | |
cbf316f2 | 1700 | //\r |
1701 | // Link this IpInfo into the IpIo.\r | |
1702 | //\r | |
e48e37fc | 1703 | InsertTailList (&IpIo->IpList, &IpInfo->Entry);\r |
cbf316f2 | 1704 | \r |
1705 | return IpInfo;\r | |
1706 | \r | |
1707 | ReleaseIpChild:\r | |
1708 | \r | |
1709 | IpIoCloseProtocolDestroyIpChild (\r | |
1710 | IpIo->Controller,\r | |
1711 | IpIo->Image,\r | |
fb115c61 | 1712 | IpInfo->ChildHandle,\r |
1713 | IpInfo->IpVersion\r | |
cbf316f2 | 1714 | );\r |
1715 | \r | |
1716 | ReleaseIpInfo:\r | |
1717 | \r | |
e48e37fc | 1718 | gBS->FreePool (IpInfo);\r |
cbf316f2 | 1719 | \r |
1720 | return NULL;\r | |
1721 | }\r | |
1722 | \r | |
1723 | \r | |
1724 | /**\r | |
fb115c61 | 1725 | Configure the IP instance of this IpInfo and start the receiving if IpConfigData\r |
cbf316f2 | 1726 | is not NULL.\r |
1727 | \r | |
6aac5e5f | 1728 | @param[in, out] IpInfo Pointer to the IP_IO_IP_INFO instance.\r |
fb115c61 | 1729 | @param[in, out] IpConfigData The IP configure data used to configure the IP\r |
6aac5e5f | 1730 | instance, if NULL the IP instance is reset. If\r |
1731 | UseDefaultAddress is set to TRUE, and the configure\r | |
1732 | operation succeeds, the default address information\r | |
fb115c61 | 1733 | is written back in this IpConfigData.\r |
cbf316f2 | 1734 | \r |
6aac5e5f | 1735 | @retval EFI_SUCCESS The IP instance of this IpInfo is configured successfully\r |
1736 | or no need to reconfigure it.\r | |
1737 | @retval Others Configuration fails.\r | |
cbf316f2 | 1738 | \r |
1739 | **/\r | |
1740 | EFI_STATUS\r | |
7b414b4e | 1741 | EFIAPI\r |
cbf316f2 | 1742 | IpIoConfigIp (\r |
6aac5e5f | 1743 | IN OUT IP_IO_IP_INFO *IpInfo,\r |
fb115c61 | 1744 | IN OUT VOID *IpConfigData OPTIONAL\r |
cbf316f2 | 1745 | )\r |
1746 | {\r | |
1747 | EFI_STATUS Status;\r | |
2a2e33b2 | 1748 | IP_IO_IP_PROTOCOL Ip;\r |
b45b45b2 | 1749 | UINT8 IpVersion;\r |
cbf316f2 | 1750 | EFI_IP4_MODE_DATA Ip4ModeData;\r |
fb115c61 | 1751 | EFI_IP6_MODE_DATA Ip6ModeData;\r |
cbf316f2 | 1752 | \r |
6aac5e5f | 1753 | ASSERT (IpInfo != NULL);\r |
cbf316f2 | 1754 | \r |
1755 | if (IpInfo->RefCnt > 1) {\r | |
1756 | //\r | |
1757 | // This IP instance is shared, don't reconfigure it until it has only one\r | |
1758 | // consumer. Currently, only the tcp children cloned from their passive parent\r | |
fb115c61 | 1759 | // will share the same IP. So this cases only happens while IpConfigData is NULL,\r |
cbf316f2 | 1760 | // let the last consumer clean the IP instance.\r |
1761 | //\r | |
1762 | return EFI_SUCCESS;\r | |
1763 | }\r | |
1764 | \r | |
fb115c61 | 1765 | IpVersion = IpInfo->IpVersion;\r |
1766 | ASSERT ((IpVersion == IP_VERSION_4) || (IpVersion == IP_VERSION_6));\r | |
1767 | \r | |
cbf316f2 | 1768 | Ip = IpInfo->Ip;\r |
1769 | \r | |
fb115c61 | 1770 | if (IpInfo->IpVersion == IP_VERSION_4) {\r |
2a2e33b2 | 1771 | Status = Ip.Ip4->Configure (Ip.Ip4, IpConfigData);\r |
fb115c61 | 1772 | } else {\r |
2a2e33b2 | 1773 | Status = Ip.Ip6->Configure (Ip.Ip6, IpConfigData);\r |
fb115c61 | 1774 | }\r |
1775 | \r | |
cbf316f2 | 1776 | if (EFI_ERROR (Status)) {\r |
1777 | goto OnExit;\r | |
1778 | }\r | |
1779 | \r | |
fb115c61 | 1780 | if (IpConfigData != NULL) {\r |
1781 | if (IpInfo->IpVersion == IP_VERSION_4){\r | |
cbf316f2 | 1782 | \r |
fb115c61 | 1783 | if (((EFI_IP4_CONFIG_DATA *) IpConfigData)->UseDefaultAddress) {\r |
2a2e33b2 | 1784 | Ip.Ip4->GetModeData (\r |
1785 | Ip.Ip4, \r | |
1786 | &Ip4ModeData, \r | |
1787 | NULL, \r | |
1788 | NULL\r | |
1789 | );\r | |
cbf316f2 | 1790 | \r |
35f910f0 RP |
1791 | IP4_COPY_ADDRESS (&((EFI_IP4_CONFIG_DATA*) IpConfigData)->StationAddress, &Ip4ModeData.ConfigData.StationAddress);\r |
1792 | IP4_COPY_ADDRESS (&((EFI_IP4_CONFIG_DATA*) IpConfigData)->SubnetMask, &Ip4ModeData.ConfigData.SubnetMask);\r | |
cbf316f2 | 1793 | }\r |
1794 | \r | |
fb115c61 | 1795 | CopyMem (\r |
1796 | &IpInfo->Addr.Addr, \r | |
1797 | &((EFI_IP4_CONFIG_DATA *) IpConfigData)->StationAddress, \r | |
1798 | sizeof (IP4_ADDR)\r | |
1799 | );\r | |
1800 | CopyMem (\r | |
1801 | &IpInfo->PreMask.SubnetMask, \r | |
1802 | &((EFI_IP4_CONFIG_DATA *) IpConfigData)->SubnetMask,\r | |
1803 | sizeof (IP4_ADDR)\r | |
1804 | );\r | |
1805 | \r | |
2a2e33b2 | 1806 | Status = Ip.Ip4->Receive (\r |
1807 | Ip.Ip4,\r | |
1808 | &IpInfo->DummyRcvToken.Ip4Token\r | |
1809 | );\r | |
cbf316f2 | 1810 | if (EFI_ERROR (Status)) {\r |
2a2e33b2 | 1811 | Ip.Ip4->Configure (Ip.Ip4, NULL);\r |
cbf316f2 | 1812 | }\r |
1813 | } else {\r | |
2a2e33b2 | 1814 | Ip.Ip6->GetModeData (\r |
1815 | Ip.Ip6,\r | |
1816 | &Ip6ModeData,\r | |
1817 | NULL,\r | |
1818 | NULL\r | |
1819 | );\r | |
fb115c61 | 1820 | \r |
1821 | if (Ip6ModeData.IsConfigured) {\r | |
1822 | CopyMem (\r | |
1823 | &((EFI_IP6_CONFIG_DATA *) IpConfigData)->StationAddress,\r | |
1824 | &Ip6ModeData.ConfigData.StationAddress,\r | |
1825 | sizeof (EFI_IPv6_ADDRESS)\r | |
1826 | );\r | |
1827 | \r | |
1828 | if (Ip6ModeData.AddressList != NULL) {\r | |
1829 | FreePool (Ip6ModeData.AddressList);\r | |
1830 | }\r | |
1831 | \r | |
1832 | if (Ip6ModeData.GroupTable != NULL) {\r | |
1833 | FreePool (Ip6ModeData.GroupTable);\r | |
1834 | }\r | |
1835 | \r | |
1836 | if (Ip6ModeData.RouteTable != NULL) {\r | |
1837 | FreePool (Ip6ModeData.RouteTable);\r | |
1838 | }\r | |
1839 | \r | |
1840 | if (Ip6ModeData.NeighborCache != NULL) {\r | |
1841 | FreePool (Ip6ModeData.NeighborCache);\r | |
1842 | }\r | |
1843 | \r | |
1844 | if (Ip6ModeData.PrefixTable != NULL) {\r | |
1845 | FreePool (Ip6ModeData.PrefixTable);\r | |
1846 | }\r | |
1847 | \r | |
1848 | if (Ip6ModeData.IcmpTypeList != NULL) {\r | |
1849 | FreePool (Ip6ModeData.IcmpTypeList);\r | |
1850 | }\r | |
1851 | \r | |
1852 | } else {\r | |
1853 | Status = EFI_NO_MAPPING;\r | |
1854 | goto OnExit;\r | |
1855 | } \r | |
1856 | \r | |
1857 | CopyMem (\r | |
1858 | &IpInfo->Addr, \r | |
1859 | &Ip6ModeData.ConfigData.StationAddress, \r | |
1860 | sizeof (EFI_IPv6_ADDRESS)\r | |
1861 | );\r | |
1862 | \r | |
2a2e33b2 | 1863 | Status = Ip.Ip6->Receive (\r |
1864 | Ip.Ip6,\r | |
1865 | &IpInfo->DummyRcvToken.Ip6Token\r | |
1866 | );\r | |
fb115c61 | 1867 | if (EFI_ERROR (Status)) {\r |
2a2e33b2 | 1868 | Ip.Ip6->Configure (Ip.Ip6, NULL);\r |
fb115c61 | 1869 | }\r |
1870 | } \r | |
1871 | } else {\r | |
cbf316f2 | 1872 | //\r |
fb115c61 | 1873 | // The IP instance is reset, set the stored Addr and SubnetMask to zero.\r |
cbf316f2 | 1874 | //\r |
fb115c61 | 1875 | ZeroMem (&IpInfo->Addr, sizeof (IpInfo->Addr));\r |
1876 | ZeroMem (&IpInfo->PreMask, sizeof (IpInfo->PreMask));\r | |
cbf316f2 | 1877 | }\r |
1878 | \r | |
1879 | OnExit:\r | |
1880 | \r | |
1881 | return Status;\r | |
1882 | }\r | |
1883 | \r | |
1884 | \r | |
1885 | /**\r | |
1886 | Destroy an IP instance maintained in IpIo->IpList for\r | |
1887 | sending purpose.\r | |
e6ff63a5 | 1888 | \r |
1889 | This function pairs with IpIoAddIp(). The IpInfo is previously created by\r | |
1890 | IpIoAddIp(). The IP_IO_IP_INFO::RefCnt is decremented and the IP instance\r | |
1891 | will be dstroyed if the RefCnt is zero.\r | |
cbf316f2 | 1892 | \r |
6aac5e5f | 1893 | @param[in] IpIo Pointer to the IP_IO instance.\r |
1894 | @param[in] IpInfo Pointer to the IpInfo to be removed.\r | |
cbf316f2 | 1895 | \r |
cbf316f2 | 1896 | **/\r |
1897 | VOID\r | |
7b414b4e | 1898 | EFIAPI\r |
cbf316f2 | 1899 | IpIoRemoveIp (\r |
e6ff63a5 | 1900 | IN IP_IO *IpIo,\r |
1901 | IN IP_IO_IP_INFO *IpInfo\r | |
cbf316f2 | 1902 | )\r |
1903 | {\r | |
fb115c61 | 1904 | \r |
b45b45b2 | 1905 | UINT8 IpVersion;\r |
fb115c61 | 1906 | \r |
cbf316f2 | 1907 | ASSERT (IpInfo->RefCnt > 0);\r |
1908 | \r | |
1909 | NET_PUT_REF (IpInfo);\r | |
1910 | \r | |
1911 | if (IpInfo->RefCnt > 0) {\r | |
1912 | \r | |
1913 | return;\r | |
1914 | }\r | |
1915 | \r | |
fb115c61 | 1916 | IpVersion = IpIo->IpVersion;\r |
1917 | \r | |
1918 | ASSERT ((IpVersion == IP_VERSION_4) || (IpVersion == IP_VERSION_6));\r | |
1919 | \r | |
e48e37fc | 1920 | RemoveEntryList (&IpInfo->Entry);\r |
cbf316f2 | 1921 | \r |
fb115c61 | 1922 | if (IpVersion == IP_VERSION_4){\r |
2a2e33b2 | 1923 | IpInfo->Ip.Ip4->Configure (\r |
1924 | IpInfo->Ip.Ip4,\r | |
1925 | NULL\r | |
1926 | );\r | |
fb115c61 | 1927 | IpIoCloseProtocolDestroyIpChild (\r |
1928 | IpIo->Controller,\r | |
1929 | IpIo->Image,\r | |
1930 | IpInfo->ChildHandle,\r | |
1931 | IP_VERSION_4\r | |
1932 | );\r | |
1933 | \r | |
1934 | gBS->CloseEvent (IpInfo->DummyRcvToken.Ip4Token.Event);\r | |
cbf316f2 | 1935 | \r |
fb115c61 | 1936 | } else {\r |
cbf316f2 | 1937 | \r |
2a2e33b2 | 1938 | IpInfo->Ip.Ip6->Configure (\r |
1939 | IpInfo->Ip.Ip6,\r | |
1940 | NULL\r | |
1941 | );\r | |
cbf316f2 | 1942 | \r |
fb115c61 | 1943 | IpIoCloseProtocolDestroyIpChild (\r |
1944 | IpIo->Controller,\r | |
1945 | IpIo->Image,\r | |
1946 | IpInfo->ChildHandle,\r | |
1947 | IP_VERSION_6\r | |
1948 | );\r | |
1949 | \r | |
1950 | gBS->CloseEvent (IpInfo->DummyRcvToken.Ip6Token.Event);\r | |
1951 | }\r | |
1952 | \r | |
1953 | FreePool (IpInfo);\r | |
cbf316f2 | 1954 | }\r |
1955 | \r | |
1956 | \r | |
1957 | /**\r | |
1958 | Find the first IP protocol maintained in IpIo whose local\r | |
fb115c61 | 1959 | address is the same as Src.\r |
e6ff63a5 | 1960 | \r |
1961 | This function is called when the caller needs the IpIo to send data to the\r | |
1962 | specified Src. The IpIo was added previously by IpIoAddIp().\r | |
cbf316f2 | 1963 | \r |
6aac5e5f | 1964 | @param[in, out] IpIo Pointer to the pointer of the IP_IO instance.\r |
fb115c61 | 1965 | @param[in] IpVersion The version of the IP protocol to use, either\r |
1966 | IPv4 or IPv6.\r | |
6aac5e5f | 1967 | @param[in] Src The local IP address.\r |
cbf316f2 | 1968 | \r |
1969 | @return Pointer to the IP protocol can be used for sending purpose and its local\r | |
fb115c61 | 1970 | address is the same with Src.\r |
cbf316f2 | 1971 | \r |
1972 | **/\r | |
1973 | IP_IO_IP_INFO *\r | |
7b414b4e | 1974 | EFIAPI\r |
cbf316f2 | 1975 | IpIoFindSender (\r |
fb115c61 | 1976 | IN OUT IP_IO **IpIo,\r |
b45b45b2 | 1977 | IN UINT8 IpVersion,\r |
fb115c61 | 1978 | IN EFI_IP_ADDRESS *Src\r |
cbf316f2 | 1979 | )\r |
1980 | {\r | |
e48e37fc | 1981 | LIST_ENTRY *IpIoEntry;\r |
cbf316f2 | 1982 | IP_IO *IpIoPtr;\r |
e48e37fc | 1983 | LIST_ENTRY *IpInfoEntry;\r |
cbf316f2 | 1984 | IP_IO_IP_INFO *IpInfo;\r |
1985 | \r | |
fb115c61 | 1986 | ASSERT ((IpVersion == IP_VERSION_4) || (IpVersion == IP_VERSION_6)); \r |
1987 | \r | |
cbf316f2 | 1988 | NET_LIST_FOR_EACH (IpIoEntry, &mActiveIpIoList) {\r |
1989 | IpIoPtr = NET_LIST_USER_STRUCT (IpIoEntry, IP_IO, Entry);\r | |
1990 | \r | |
fb115c61 | 1991 | if (((*IpIo != NULL) && (*IpIo != IpIoPtr)) || (IpIoPtr->IpVersion != IpVersion)) {\r |
cbf316f2 | 1992 | continue;\r |
1993 | }\r | |
1994 | \r | |
1995 | NET_LIST_FOR_EACH (IpInfoEntry, &IpIoPtr->IpList) {\r | |
1996 | IpInfo = NET_LIST_USER_STRUCT (IpInfoEntry, IP_IO_IP_INFO, Entry);\r | |
fb115c61 | 1997 | if (IpInfo->IpVersion == IP_VERSION_4){\r |
1998 | \r | |
1999 | if (EFI_IP4_EQUAL (&IpInfo->Addr.v4, &Src->v4)) {\r | |
2000 | *IpIo = IpIoPtr;\r | |
2001 | return IpInfo;\r | |
2002 | }\r | |
2003 | \r | |
2004 | } else {\r | |
2005 | \r | |
2006 | if (EFI_IP6_EQUAL (&IpInfo->Addr.v6, &Src->v6)) {\r | |
2007 | *IpIo = IpIoPtr;\r | |
2008 | return IpInfo; \r | |
2009 | }\r | |
2010 | } \r | |
cbf316f2 | 2011 | \r |
cbf316f2 | 2012 | }\r |
2013 | }\r | |
2014 | \r | |
2015 | //\r | |
2016 | // No match.\r | |
2017 | //\r | |
2018 | return NULL;\r | |
2019 | }\r | |
2020 | \r | |
2021 | \r | |
2022 | /**\r | |
e6ff63a5 | 2023 | Get the ICMP error map information.\r |
2024 | \r | |
2025 | The ErrorStatus will be returned. The IsHard and Notify are optional. If they\r | |
2026 | are not NULL, this routine will fill them.\r | |
cbf316f2 | 2027 | \r |
8f5e6151 | 2028 | @param[in] IcmpError IcmpError Type.\r |
fb115c61 | 2029 | @param[in] IpVersion The version of the IP protocol to use,\r |
3b1464d5 | 2030 | either IPv4 or IPv6. \r |
2031 | @param[out] IsHard If TRUE, indicates that it is a hard error.\r | |
2032 | @param[out] Notify If TRUE, SockError needs to be notified.\r | |
cbf316f2 | 2033 | \r |
6aac5e5f | 2034 | @return ICMP Error Status, such as EFI_NETWORK_UNREACHABLE.\r |
cbf316f2 | 2035 | \r |
2036 | **/\r | |
2037 | EFI_STATUS\r | |
7b414b4e | 2038 | EFIAPI\r |
cbf316f2 | 2039 | IpIoGetIcmpErrStatus (\r |
b45b45b2 | 2040 | IN UINT8 IcmpError,\r |
2041 | IN UINT8 IpVersion,\r | |
e6ff63a5 | 2042 | OUT BOOLEAN *IsHard OPTIONAL,\r |
2043 | OUT BOOLEAN *Notify OPTIONAL\r | |
cbf316f2 | 2044 | )\r |
2045 | {\r | |
3cf888f5 | 2046 | if (IpVersion == IP_VERSION_4 ) {\r |
b45b45b2 | 2047 | ASSERT (IcmpError <= ICMP_ERR_PARAMPROB);\r |
687a2e5f | 2048 | \r |
3cf888f5 | 2049 | if (IsHard != NULL) {\r |
2050 | *IsHard = mIcmpErrMap[IcmpError].IsHard;\r | |
2051 | }\r | |
687a2e5f | 2052 | \r |
3cf888f5 | 2053 | if (Notify != NULL) {\r |
2054 | *Notify = mIcmpErrMap[IcmpError].Notify;\r | |
2055 | }\r | |
2056 | \r | |
2057 | switch (IcmpError) {\r | |
2058 | case ICMP_ERR_UNREACH_NET:\r | |
2059 | return EFI_NETWORK_UNREACHABLE;\r | |
2060 | \r | |
2061 | case ICMP_ERR_TIMXCEED_INTRANS:\r | |
2062 | case ICMP_ERR_TIMXCEED_REASS:\r | |
2063 | case ICMP_ERR_UNREACH_HOST:\r | |
2064 | return EFI_HOST_UNREACHABLE;\r | |
2065 | \r | |
2066 | case ICMP_ERR_UNREACH_PROTOCOL:\r | |
2067 | return EFI_PROTOCOL_UNREACHABLE;\r | |
2068 | \r | |
2069 | case ICMP_ERR_UNREACH_PORT:\r | |
2070 | return EFI_PORT_UNREACHABLE;\r | |
2071 | \r | |
2072 | case ICMP_ERR_MSGSIZE:\r | |
2073 | case ICMP_ERR_UNREACH_SRCFAIL:\r | |
2074 | case ICMP_ERR_QUENCH:\r | |
2075 | case ICMP_ERR_PARAMPROB:\r | |
2076 | return EFI_ICMP_ERROR;\r | |
2077 | \r | |
2078 | default:\r | |
2079 | ASSERT (FALSE);\r | |
2080 | return EFI_UNSUPPORTED;\r | |
2081 | }\r | |
687a2e5f | 2082 | \r |
fb115c61 | 2083 | } else if (IpVersion == IP_VERSION_6) {\r |
2084 | \r | |
b45b45b2 | 2085 | ASSERT (IcmpError <= ICMP6_ERR_PARAMPROB_IPV6OPTION);\r |
687a2e5f | 2086 | \r |
fb115c61 | 2087 | if (IsHard != NULL) {\r |
2088 | *IsHard = mIcmp6ErrMap[IcmpError].IsHard;\r | |
2089 | }\r | |
2090 | \r | |
2091 | if (Notify != NULL) {\r | |
2092 | *Notify = mIcmp6ErrMap[IcmpError].Notify;\r | |
2093 | }\r | |
3cf888f5 | 2094 | \r |
2095 | switch (IcmpError) {\r | |
2096 | case ICMP6_ERR_UNREACH_NET:\r | |
2097 | return EFI_NETWORK_UNREACHABLE;\r | |
2098 | \r | |
2099 | case ICMP6_ERR_UNREACH_HOST:\r | |
2100 | case ICMP6_ERR_TIMXCEED_HOPLIMIT:\r | |
2101 | case ICMP6_ERR_TIMXCEED_REASS: \r | |
2102 | return EFI_HOST_UNREACHABLE;\r | |
2103 | \r | |
2104 | case ICMP6_ERR_UNREACH_PROTOCOL:\r | |
2105 | return EFI_PROTOCOL_UNREACHABLE;\r | |
2106 | \r | |
2107 | case ICMP6_ERR_UNREACH_PORT:\r | |
2108 | return EFI_PORT_UNREACHABLE;\r | |
2109 | \r | |
2110 | case ICMP6_ERR_PACKAGE_TOOBIG:\r | |
2111 | case ICMP6_ERR_PARAMPROB_HEADER:\r | |
2112 | case ICMP6_ERR_PARAMPROB_NEXHEADER:\r | |
2113 | case ICMP6_ERR_PARAMPROB_IPV6OPTION:\r | |
2114 | return EFI_ICMP_ERROR;\r | |
2115 | \r | |
2116 | default:\r | |
2117 | ASSERT (FALSE);\r | |
2118 | return EFI_UNSUPPORTED;\r | |
2119 | }\r | |
fb115c61 | 2120 | \r |
2121 | } else {\r | |
2122 | //\r | |
2123 | // Should never be here\r | |
2124 | //\r | |
2125 | ASSERT (FALSE);\r | |
2126 | return EFI_UNSUPPORTED;\r | |
2127 | }\r | |
2128 | }\r | |
cbf316f2 | 2129 | \r |
cbf316f2 | 2130 | \r |
fb115c61 | 2131 | /**\r |
2132 | Refresh the remote peer's Neighbor Cache entries.\r | |
2133 | \r | |
2134 | This function is called when the caller needs the IpIo to refresh the existing\r | |
2135 | IPv6 neighbor cache entries since the neighbor is considered reachable by the \r | |
2136 | node has recently received a confirmation that packets sent recently to the \r | |
2137 | neighbor were received by its IP layer. \r | |
2138 | \r | |
2139 | @param[in] IpIo Pointer to an IP_IO instance\r | |
2140 | @param[in] Neighbor The IP address of the neighbor\r | |
2141 | @param[in] Timeout Time in 100-ns units that this entry will\r | |
2142 | remain in the neighbor cache. A value of \r | |
2143 | zero means that the entry is permanent. \r | |
2144 | A value of non-zero means that the entry is \r | |
2145 | dynamic and will be deleted after Timeout.\r | |
2146 | \r | |
2147 | @retval EFI_SUCCESS The operation is completed successfully.\r | |
2148 | @retval EFI_NOT_STARTED The IpIo is not configured.\r | |
2149 | @retval EFI_INVALID_PARAMETER Neighbor Address is invalid.\r | |
2150 | @retval EFI_NOT_FOUND The neighbor cache entry is not in the \r | |
2151 | neighbor table. \r | |
2152 | @retval EFI_OUT_OF_RESOURCES Failed due to resource limit.\r | |
cbf316f2 | 2153 | \r |
fb115c61 | 2154 | **/\r |
2155 | EFI_STATUS\r | |
2156 | IpIoRefreshNeighbor (\r | |
2157 | IN IP_IO *IpIo,\r | |
2158 | IN EFI_IP_ADDRESS *Neighbor,\r | |
2159 | IN UINT32 Timeout \r | |
2160 | )\r | |
2161 | {\r | |
2162 | EFI_IP6_PROTOCOL *Ip;\r | |
2163 | \r | |
2164 | if (!IpIo->IsConfigured || IpIo->IpVersion != IP_VERSION_6) {\r | |
2165 | return EFI_NOT_STARTED;\r | |
cbf316f2 | 2166 | }\r |
2167 | \r | |
2a2e33b2 | 2168 | Ip = IpIo->Ip.Ip6;\r |
fb115c61 | 2169 | \r |
2170 | return Ip->Neighbors (Ip, FALSE, &Neighbor->v6, NULL, Timeout, TRUE);\r | |
cbf316f2 | 2171 | }\r |
2172 | \r |