]>
Commit | Line | Data |
---|---|---|
772db4bb | 1 | /** @file\r |
3e8c18da | 2 | Implement IP4 pesudo interface.\r |
3 | \r | |
f1222593 | 4 | Copyright (c) 2005 - 2017, Intel Corporation. All rights reserved.<BR>\r |
e5eed7d3 | 5 | This program and the accompanying materials\r |
772db4bb | 6 | are licensed and made available under the terms and conditions of the BSD License\r |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php\r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | \r | |
772db4bb | 13 | **/\r |
14 | \r | |
15 | #include "Ip4Impl.h"\r | |
16 | \r | |
17 | //\r | |
18 | // Mac address with all zero, used to determine whethter the ARP\r | |
19 | // resolve succeeded. Failed ARP requests zero the MAC address buffer.\r | |
20 | //\r | |
fe1e36e5 | 21 | EFI_MAC_ADDRESS mZeroMacAddress;\r |
772db4bb | 22 | \r |
2ff29212 | 23 | /**\r |
24 | Callback funtion when frame transmission is finished. It will\r | |
25 | call the frame owner's callback function to tell it the result.\r | |
26 | \r | |
3e8c18da | 27 | @param[in] Context Context which is point to the token.\r |
2ff29212 | 28 | \r |
29 | **/\r | |
36ee91ca | 30 | VOID\r |
31 | EFIAPI\r | |
32 | Ip4OnFrameSentDpc (\r | |
2ff29212 | 33 | IN VOID *Context\r |
36ee91ca | 34 | );\r |
35 | \r | |
2ff29212 | 36 | /**\r |
37 | Request Ip4OnFrameSentDpc as a DPC at TPL_CALLBACK.\r | |
38 | \r | |
3e8c18da | 39 | @param[in] Event The transmit token's event.\r |
40 | @param[in] Context Context which is point to the token.\r | |
2ff29212 | 41 | \r |
42 | **/\r | |
772db4bb | 43 | VOID\r |
44 | EFIAPI\r | |
45 | Ip4OnFrameSent (\r | |
2ff29212 | 46 | IN EFI_EVENT Event,\r |
47 | IN VOID *Context\r | |
772db4bb | 48 | );\r |
49 | \r | |
2ff29212 | 50 | /**\r |
51 | Callback function when ARP request are finished. It will cancelled\r | |
52 | all the queued frame if the ARP requests failed. Or transmit them\r | |
53 | if the request succeed.\r | |
54 | \r | |
3e8c18da | 55 | @param[in] Context The context of the callback, a point to the ARP\r |
2ff29212 | 56 | queue\r |
57 | \r | |
2ff29212 | 58 | **/\r |
36ee91ca | 59 | VOID\r |
60 | EFIAPI\r | |
61 | Ip4OnArpResolvedDpc (\r | |
62 | IN VOID *Context\r | |
63 | );\r | |
64 | \r | |
2ff29212 | 65 | /**\r |
66 | Request Ip4OnArpResolvedDpc as a DPC at TPL_CALLBACK.\r | |
67 | \r | |
3e8c18da | 68 | @param Event The Arp request event.\r |
69 | @param Context The context of the callback, a point to the ARP\r | |
70 | queue.\r | |
71 | \r | |
2ff29212 | 72 | **/\r |
772db4bb | 73 | VOID\r |
74 | EFIAPI\r | |
75 | Ip4OnArpResolved (\r | |
76 | IN EFI_EVENT Event,\r | |
77 | IN VOID *Context\r | |
78 | );\r | |
79 | \r | |
2ff29212 | 80 | /**\r |
81 | Received a frame from MNP, wrap it in net buffer then deliver\r | |
82 | it to IP's input function. The ownship of the packet also\r | |
83 | transferred to IP. When Ip is finished with this packet, it\r | |
84 | will call NetbufFree to release the packet, NetbufFree will\r | |
85 | again call the Ip4RecycleFrame to signal MNP's event and free\r | |
86 | the token used.\r | |
87 | \r | |
88 | @param Context Context for the callback.\r | |
89 | \r | |
2ff29212 | 90 | **/\r |
36ee91ca | 91 | VOID\r |
92 | EFIAPI\r | |
93 | Ip4OnFrameReceivedDpc (\r | |
2ff29212 | 94 | IN VOID *Context\r |
36ee91ca | 95 | );\r |
96 | \r | |
2ff29212 | 97 | /**\r |
2ff29212 | 98 | Request Ip4OnFrameReceivedDpc as a DPC at TPL_CALLBACK.\r |
99 | \r | |
100 | @param Event The receive event delivered to MNP for receive.\r | |
101 | @param Context Context for the callback.\r | |
2ff29212 | 102 | \r |
103 | **/\r | |
772db4bb | 104 | VOID\r |
105 | EFIAPI\r | |
106 | Ip4OnFrameReceived (\r | |
2ff29212 | 107 | IN EFI_EVENT Event,\r |
108 | IN VOID *Context\r | |
772db4bb | 109 | );\r |
110 | \r | |
2ff29212 | 111 | /**\r |
112 | Remove all the frames on the ARP queue that pass the FrameToCancel,\r | |
113 | that is, either FrameToCancel is NULL or it returns true for the frame.\r | |
114 | \r | |
3e8c18da | 115 | @param[in] ArpQue ARP frame to remove the frames from.\r |
116 | @param[in] IoStatus The status returned to the cancelled frames'\r | |
2ff29212 | 117 | callback function.\r |
3e8c18da | 118 | @param[in] FrameToCancel Function to select which frame to cancel.\r |
119 | @param[in] Context Opaque parameter to the FrameToCancel.\r | |
2ff29212 | 120 | \r |
121 | **/\r | |
772db4bb | 122 | VOID\r |
123 | Ip4CancelFrameArp (\r | |
124 | IN IP4_ARP_QUE *ArpQue,\r | |
125 | IN EFI_STATUS IoStatus,\r | |
24af132f | 126 | IN IP4_FRAME_TO_CANCEL FrameToCancel OPTIONAL,\r |
772db4bb | 127 | IN VOID *Context\r |
128 | );\r | |
129 | \r | |
130 | \r | |
131 | /**\r | |
132 | Wrap a transmit request into a newly allocated IP4_LINK_TX_TOKEN.\r | |
133 | \r | |
3e8c18da | 134 | @param[in] Interface The interface to send out to.\r |
135 | @param[in] IpInstance The IpInstance that transmit the packet. NULL if\r | |
772db4bb | 136 | the packet is sent by the IP4 driver itself.\r |
3e8c18da | 137 | @param[in] Packet The packet to transmit\r |
138 | @param[in] CallBack Call back function to execute if transmission\r | |
772db4bb | 139 | finished.\r |
3e8c18da | 140 | @param[in] Context Opaque parameter to the call back.\r |
772db4bb | 141 | \r |
3e8c18da | 142 | @retval Token The wrapped token if succeed \r |
143 | @retval NULL The wrapped token if NULL\r | |
772db4bb | 144 | \r |
145 | **/\r | |
772db4bb | 146 | IP4_LINK_TX_TOKEN *\r |
147 | Ip4WrapLinkTxToken (\r | |
148 | IN IP4_INTERFACE *Interface,\r | |
24af132f | 149 | IN IP4_PROTOCOL *IpInstance OPTIONAL,\r |
772db4bb | 150 | IN NET_BUF *Packet,\r |
151 | IN IP4_FRAME_CALLBACK CallBack,\r | |
152 | IN VOID *Context\r | |
153 | )\r | |
154 | {\r | |
155 | EFI_MANAGED_NETWORK_COMPLETION_TOKEN *MnpToken;\r | |
156 | EFI_MANAGED_NETWORK_TRANSMIT_DATA *MnpTxData;\r | |
157 | IP4_LINK_TX_TOKEN *Token;\r | |
158 | EFI_STATUS Status;\r | |
159 | UINT32 Count;\r | |
160 | \r | |
e48e37fc | 161 | Token = AllocatePool (sizeof (IP4_LINK_TX_TOKEN) + \\r |
772db4bb | 162 | (Packet->BlockOpNum - 1) * sizeof (EFI_MANAGED_NETWORK_FRAGMENT_DATA));\r |
163 | \r | |
164 | if (Token == NULL) {\r | |
165 | return NULL;\r | |
166 | }\r | |
167 | \r | |
168 | Token->Signature = IP4_FRAME_TX_SIGNATURE;\r | |
e48e37fc | 169 | InitializeListHead (&Token->Link);\r |
772db4bb | 170 | \r |
171 | Token->Interface = Interface;\r | |
172 | Token->IpInstance = IpInstance;\r | |
173 | Token->CallBack = CallBack;\r | |
174 | Token->Packet = Packet;\r | |
175 | Token->Context = Context;\r | |
687a2e5f | 176 | CopyMem (&Token->DstMac, &mZeroMacAddress, sizeof (Token->DstMac));\r |
177 | CopyMem (&Token->SrcMac, &Interface->Mac, sizeof (Token->SrcMac));\r | |
772db4bb | 178 | \r |
179 | MnpToken = &(Token->MnpToken);\r | |
180 | MnpToken->Status = EFI_NOT_READY;\r | |
181 | \r | |
182 | Status = gBS->CreateEvent (\r | |
183 | EVT_NOTIFY_SIGNAL,\r | |
e48e37fc | 184 | TPL_NOTIFY,\r |
772db4bb | 185 | Ip4OnFrameSent,\r |
186 | Token,\r | |
187 | &MnpToken->Event\r | |
188 | );\r | |
189 | \r | |
190 | if (EFI_ERROR (Status)) {\r | |
766c7483 | 191 | FreePool (Token);\r |
772db4bb | 192 | return NULL;\r |
193 | }\r | |
194 | \r | |
195 | MnpTxData = &Token->MnpTxData;\r | |
196 | MnpToken->Packet.TxData = MnpTxData;\r | |
197 | \r | |
198 | MnpTxData->DestinationAddress = &Token->DstMac;\r | |
199 | MnpTxData->SourceAddress = &Token->SrcMac;\r | |
200 | MnpTxData->ProtocolType = IP4_ETHER_PROTO;\r | |
201 | MnpTxData->DataLength = Packet->TotalSize;\r | |
202 | MnpTxData->HeaderLength = 0;\r | |
203 | \r | |
204 | Count = Packet->BlockOpNum;\r | |
205 | \r | |
206 | NetbufBuildExt (Packet, (NET_FRAGMENT *) MnpTxData->FragmentTable, &Count);\r | |
207 | MnpTxData->FragmentCount = (UINT16)Count;\r | |
208 | \r | |
209 | return Token;\r | |
210 | }\r | |
211 | \r | |
212 | \r | |
213 | /**\r | |
214 | Free the link layer transmit token. It will close the event\r | |
215 | then free the memory used.\r | |
216 | \r | |
3e8c18da | 217 | @param[in] Token Token to free\r |
772db4bb | 218 | \r |
219 | **/\r | |
772db4bb | 220 | VOID\r |
221 | Ip4FreeLinkTxToken (\r | |
222 | IN IP4_LINK_TX_TOKEN *Token\r | |
223 | )\r | |
224 | {\r | |
225 | NET_CHECK_SIGNATURE (Token, IP4_FRAME_TX_SIGNATURE);\r | |
226 | \r | |
227 | gBS->CloseEvent (Token->MnpToken.Event);\r | |
766c7483 | 228 | FreePool (Token);\r |
772db4bb | 229 | }\r |
230 | \r | |
231 | \r | |
232 | /**\r | |
233 | Create an IP_ARP_QUE structure to request ARP service.\r | |
234 | \r | |
3e8c18da | 235 | @param[in] Interface The interface to send ARP from.\r |
236 | @param[in] DestIp The destination IP (host byte order) to request MAC\r | |
772db4bb | 237 | for\r |
238 | \r | |
239 | @return Point to newly created IP4_ARP_QUE if succeed, otherwise NULL.\r | |
240 | \r | |
241 | **/\r | |
772db4bb | 242 | IP4_ARP_QUE *\r |
243 | Ip4CreateArpQue (\r | |
244 | IN IP4_INTERFACE *Interface,\r | |
245 | IN IP4_ADDR DestIp\r | |
246 | )\r | |
247 | {\r | |
248 | IP4_ARP_QUE *ArpQue;\r | |
249 | EFI_STATUS Status;\r | |
250 | \r | |
e48e37fc | 251 | ArpQue = AllocatePool (sizeof (IP4_ARP_QUE));\r |
772db4bb | 252 | \r |
253 | if (ArpQue == NULL) {\r | |
254 | return NULL;\r | |
255 | }\r | |
256 | \r | |
257 | ArpQue->Signature = IP4_FRAME_ARP_SIGNATURE;\r | |
e48e37fc | 258 | InitializeListHead (&ArpQue->Link);\r |
772db4bb | 259 | \r |
e48e37fc | 260 | InitializeListHead (&ArpQue->Frames);\r |
772db4bb | 261 | ArpQue->Interface = Interface;\r |
262 | \r | |
263 | Status = gBS->CreateEvent (\r | |
264 | EVT_NOTIFY_SIGNAL,\r | |
e48e37fc | 265 | TPL_NOTIFY,\r |
772db4bb | 266 | Ip4OnArpResolved,\r |
267 | ArpQue,\r | |
268 | &ArpQue->OnResolved\r | |
269 | );\r | |
270 | \r | |
271 | if (EFI_ERROR (Status)) {\r | |
766c7483 | 272 | FreePool (ArpQue);\r |
772db4bb | 273 | return NULL;\r |
274 | }\r | |
275 | \r | |
276 | ArpQue->Ip = DestIp;\r | |
687a2e5f | 277 | CopyMem (&ArpQue->Mac, &mZeroMacAddress, sizeof (ArpQue->Mac));\r |
772db4bb | 278 | \r |
279 | return ArpQue;\r | |
280 | }\r | |
281 | \r | |
282 | \r | |
283 | /**\r | |
284 | Remove all the transmit requests queued on the ARP queue, then free it.\r | |
285 | \r | |
3e8c18da | 286 | @param[in] ArpQue Arp queue to free\r |
287 | @param[in] IoStatus The transmit status returned to transmit requests'\r | |
772db4bb | 288 | callback.\r |
289 | \r | |
772db4bb | 290 | **/\r |
772db4bb | 291 | VOID\r |
292 | Ip4FreeArpQue (\r | |
293 | IN IP4_ARP_QUE *ArpQue,\r | |
294 | IN EFI_STATUS IoStatus\r | |
295 | )\r | |
296 | {\r | |
297 | NET_CHECK_SIGNATURE (ArpQue, IP4_FRAME_ARP_SIGNATURE);\r | |
298 | \r | |
299 | //\r | |
300 | // Remove all the frame waiting the ARP response\r | |
301 | //\r | |
302 | Ip4CancelFrameArp (ArpQue, IoStatus, NULL, NULL);\r | |
303 | \r | |
304 | gBS->CloseEvent (ArpQue->OnResolved);\r | |
766c7483 | 305 | FreePool (ArpQue);\r |
772db4bb | 306 | }\r |
307 | \r | |
308 | \r | |
309 | /**\r | |
310 | Create a link layer receive token to wrap the receive request\r | |
311 | \r | |
3e8c18da | 312 | @param[in] Interface The interface to receive from\r |
313 | @param[in] IpInstance The instance that request the receive (NULL for IP4\r | |
772db4bb | 314 | driver itself)\r |
3e8c18da | 315 | @param[in] CallBack Call back function to execute when finished.\r |
316 | @param[in] Context Opaque parameters to the callback\r | |
772db4bb | 317 | \r |
318 | @return Point to created IP4_LINK_RX_TOKEN if succeed, otherwise NULL.\r | |
319 | \r | |
320 | **/\r | |
772db4bb | 321 | IP4_LINK_RX_TOKEN *\r |
322 | Ip4CreateLinkRxToken (\r | |
323 | IN IP4_INTERFACE *Interface,\r | |
324 | IN IP4_PROTOCOL *IpInstance,\r | |
325 | IN IP4_FRAME_CALLBACK CallBack,\r | |
326 | IN VOID *Context\r | |
327 | )\r | |
328 | {\r | |
329 | EFI_MANAGED_NETWORK_COMPLETION_TOKEN *MnpToken;\r | |
330 | IP4_LINK_RX_TOKEN *Token;\r | |
331 | EFI_STATUS Status;\r | |
332 | \r | |
e48e37fc | 333 | Token = AllocatePool (sizeof (IP4_LINK_RX_TOKEN));\r |
772db4bb | 334 | if (Token == NULL) {\r |
335 | return NULL;\r | |
336 | }\r | |
337 | \r | |
338 | Token->Signature = IP4_FRAME_RX_SIGNATURE;\r | |
339 | Token->Interface = Interface;\r | |
340 | Token->IpInstance = IpInstance;\r | |
341 | Token->CallBack = CallBack;\r | |
342 | Token->Context = Context;\r | |
343 | \r | |
344 | MnpToken = &Token->MnpToken;\r | |
345 | MnpToken->Status = EFI_NOT_READY;\r | |
346 | \r | |
347 | Status = gBS->CreateEvent (\r | |
348 | EVT_NOTIFY_SIGNAL,\r | |
e48e37fc | 349 | TPL_NOTIFY,\r |
772db4bb | 350 | Ip4OnFrameReceived,\r |
351 | Token,\r | |
352 | &MnpToken->Event\r | |
353 | );\r | |
354 | \r | |
355 | if (EFI_ERROR (Status)) {\r | |
766c7483 | 356 | FreePool (Token);\r |
772db4bb | 357 | return NULL;\r |
358 | }\r | |
359 | \r | |
360 | MnpToken->Packet.RxData = NULL;\r | |
361 | return Token;\r | |
362 | }\r | |
363 | \r | |
364 | \r | |
365 | /**\r | |
366 | Free the link layer request token. It will close the event\r | |
367 | then free the memory used.\r | |
368 | \r | |
3e8c18da | 369 | @param[in] Token Request token to free.\r |
772db4bb | 370 | \r |
371 | **/\r | |
772db4bb | 372 | VOID\r |
373 | Ip4FreeFrameRxToken (\r | |
374 | IN IP4_LINK_RX_TOKEN *Token\r | |
375 | )\r | |
376 | {\r | |
377 | \r | |
378 | NET_CHECK_SIGNATURE (Token, IP4_FRAME_RX_SIGNATURE);\r | |
379 | \r | |
380 | gBS->CloseEvent (Token->MnpToken.Event);\r | |
766c7483 | 381 | FreePool (Token);\r |
772db4bb | 382 | }\r |
383 | \r | |
384 | \r | |
385 | /**\r | |
386 | Remove all the frames on the ARP queue that pass the FrameToCancel,\r | |
387 | that is, either FrameToCancel is NULL or it returns true for the frame.\r | |
388 | \r | |
3e8c18da | 389 | @param[in] ArpQue ARP frame to remove the frames from.\r |
390 | @param[in] IoStatus The status returned to the cancelled frames'\r | |
772db4bb | 391 | callback function.\r |
3e8c18da | 392 | @param[in] FrameToCancel Function to select which frame to cancel.\r |
393 | @param[in] Context Opaque parameter to the FrameToCancel.\r | |
772db4bb | 394 | \r |
395 | **/\r | |
772db4bb | 396 | VOID\r |
397 | Ip4CancelFrameArp (\r | |
398 | IN IP4_ARP_QUE *ArpQue,\r | |
399 | IN EFI_STATUS IoStatus,\r | |
24af132f | 400 | IN IP4_FRAME_TO_CANCEL FrameToCancel OPTIONAL,\r |
772db4bb | 401 | IN VOID *Context\r |
402 | )\r | |
403 | {\r | |
e48e37fc | 404 | LIST_ENTRY *Entry;\r |
405 | LIST_ENTRY *Next;\r | |
772db4bb | 406 | IP4_LINK_TX_TOKEN *Token;\r |
407 | \r | |
408 | NET_LIST_FOR_EACH_SAFE (Entry, Next, &ArpQue->Frames) {\r | |
409 | Token = NET_LIST_USER_STRUCT (Entry, IP4_LINK_TX_TOKEN, Link);\r | |
410 | \r | |
411 | if ((FrameToCancel == NULL) || FrameToCancel (Token, Context)) {\r | |
e48e37fc | 412 | RemoveEntryList (Entry);\r |
772db4bb | 413 | \r |
414 | Token->CallBack (Token->IpInstance, Token->Packet, IoStatus, 0, Token->Context);\r | |
415 | Ip4FreeLinkTxToken (Token);\r | |
416 | }\r | |
417 | }\r | |
418 | }\r | |
419 | \r | |
420 | \r | |
421 | /**\r | |
422 | Remove all the frames on the interface that pass the FrameToCancel,\r | |
423 | either queued on ARP queues or that have already been delivered to\r | |
424 | MNP and not yet recycled.\r | |
425 | \r | |
1f6729ff | 426 | @param[in] Interface Interface to remove the frames from.\r |
3e8c18da | 427 | @param[in] IoStatus The transmit status returned to the frames'\r |
1f6729ff | 428 | callback.\r |
3e8c18da | 429 | @param[in] FrameToCancel Function to select the frame to cancel, NULL to\r |
1f6729ff | 430 | select all.\r |
431 | @param[in] Context Opaque parameters passed to FrameToCancel.\r | |
772db4bb | 432 | \r |
433 | **/\r | |
434 | VOID\r | |
435 | Ip4CancelFrames (\r | |
436 | IN IP4_INTERFACE *Interface,\r | |
437 | IN EFI_STATUS IoStatus,\r | |
24af132f | 438 | IN IP4_FRAME_TO_CANCEL FrameToCancel OPTIONAL,\r |
772db4bb | 439 | IN VOID *Context\r |
440 | )\r | |
441 | {\r | |
e48e37fc | 442 | LIST_ENTRY *Entry;\r |
443 | LIST_ENTRY *Next;\r | |
772db4bb | 444 | IP4_ARP_QUE *ArpQue;\r |
445 | IP4_LINK_TX_TOKEN *Token;\r | |
446 | \r | |
447 | //\r | |
448 | // Cancel all the pending frames on ARP requests\r | |
449 | //\r | |
450 | NET_LIST_FOR_EACH_SAFE (Entry, Next, &Interface->ArpQues) {\r | |
451 | ArpQue = NET_LIST_USER_STRUCT (Entry, IP4_ARP_QUE, Link);\r | |
452 | \r | |
453 | Ip4CancelFrameArp (ArpQue, IoStatus, FrameToCancel, Context);\r | |
454 | \r | |
e48e37fc | 455 | if (IsListEmpty (&ArpQue->Frames)) {\r |
772db4bb | 456 | Interface->Arp->Cancel (Interface->Arp, &ArpQue->Ip, ArpQue->OnResolved);\r |
772db4bb | 457 | }\r |
458 | }\r | |
459 | \r | |
460 | //\r | |
461 | // Cancel all the frames that have been delivered to MNP\r | |
462 | // but not yet recycled.\r | |
463 | //\r | |
464 | NET_LIST_FOR_EACH_SAFE (Entry, Next, &Interface->SentFrames) {\r | |
465 | Token = NET_LIST_USER_STRUCT (Entry, IP4_LINK_TX_TOKEN, Link);\r | |
466 | \r | |
467 | if ((FrameToCancel == NULL) || FrameToCancel (Token, Context)) {\r | |
772db4bb | 468 | Interface->Mnp->Cancel (Interface->Mnp, &Token->MnpToken);\r |
772db4bb | 469 | }\r |
470 | }\r | |
471 | }\r | |
472 | \r | |
473 | \r | |
474 | /**\r | |
475 | Create an IP4_INTERFACE. Delay the creation of ARP instance until\r | |
476 | the interface is configured.\r | |
477 | \r | |
3e8c18da | 478 | @param[in] Mnp The shared MNP child of this IP4 service binding\r |
1f6729ff | 479 | instance.\r |
3e8c18da | 480 | @param[in] Controller The controller this IP4 service binding instance\r |
772db4bb | 481 | is installed. Most like the UNDI handle.\r |
1f6729ff | 482 | @param[in] ImageHandle This driver's image handle.\r |
772db4bb | 483 | \r |
484 | @return Point to the created IP4_INTERFACE, otherwise NULL.\r | |
485 | \r | |
486 | **/\r | |
487 | IP4_INTERFACE *\r | |
488 | Ip4CreateInterface (\r | |
489 | IN EFI_MANAGED_NETWORK_PROTOCOL *Mnp,\r | |
490 | IN EFI_HANDLE Controller,\r | |
491 | IN EFI_HANDLE ImageHandle\r | |
492 | )\r | |
493 | {\r | |
494 | IP4_INTERFACE *Interface;\r | |
495 | EFI_SIMPLE_NETWORK_MODE SnpMode;\r | |
496 | \r | |
e48e37fc | 497 | Interface = AllocatePool (sizeof (IP4_INTERFACE));\r |
772db4bb | 498 | \r |
499 | if ((Interface == NULL) || (Mnp == NULL)) {\r | |
500 | return NULL;\r | |
501 | }\r | |
502 | \r | |
503 | Interface->Signature = IP4_INTERFACE_SIGNATURE;\r | |
e48e37fc | 504 | InitializeListHead (&Interface->Link);\r |
772db4bb | 505 | Interface->RefCnt = 1;\r |
506 | \r | |
507 | Interface->Ip = IP4_ALLZERO_ADDRESS;\r | |
508 | Interface->SubnetMask = IP4_ALLZERO_ADDRESS;\r | |
509 | Interface->Configured = FALSE;\r | |
510 | \r | |
511 | Interface->Controller = Controller;\r | |
512 | Interface->Image = ImageHandle;\r | |
513 | Interface->Mnp = Mnp;\r | |
514 | Interface->Arp = NULL;\r | |
515 | Interface->ArpHandle = NULL;\r | |
516 | \r | |
e48e37fc | 517 | InitializeListHead (&Interface->ArpQues);\r |
518 | InitializeListHead (&Interface->SentFrames);\r | |
772db4bb | 519 | \r |
520 | Interface->RecvRequest = NULL;\r | |
521 | \r | |
522 | //\r | |
523 | // Get the interface's Mac address and broadcast mac address from SNP\r | |
524 | //\r | |
525 | if (EFI_ERROR (Mnp->GetModeData (Mnp, NULL, &SnpMode))) {\r | |
766c7483 | 526 | FreePool (Interface);\r |
772db4bb | 527 | return NULL;\r |
528 | }\r | |
529 | \r | |
687a2e5f | 530 | CopyMem (&Interface->Mac, &SnpMode.CurrentAddress, sizeof (Interface->Mac));\r |
531 | CopyMem (&Interface->BroadcastMac, &SnpMode.BroadcastAddress, sizeof (Interface->BroadcastMac));\r | |
772db4bb | 532 | Interface->HwaddrLen = SnpMode.HwAddressSize;\r |
533 | \r | |
e48e37fc | 534 | InitializeListHead (&Interface->IpInstances);\r |
772db4bb | 535 | Interface->PromiscRecv = FALSE;\r |
536 | \r | |
537 | return Interface;\r | |
538 | }\r | |
539 | \r | |
540 | \r | |
541 | /**\r | |
542 | Set the interface's address, create and configure\r | |
543 | the ARP child if necessary.\r | |
544 | \r | |
1f6729ff | 545 | @param Interface The interface to set the address.\r |
546 | @param IpAddr The interface's IP address.\r | |
547 | @param SubnetMask The interface's netmask.\r | |
772db4bb | 548 | \r |
549 | @retval EFI_SUCCESS The interface is configured with Ip/netmask pair,\r | |
550 | and a ARP is created for it.\r | |
551 | @retval Others Failed to set the interface's address.\r | |
552 | \r | |
553 | **/\r | |
554 | EFI_STATUS\r | |
555 | Ip4SetAddress (\r | |
5405e9a6 | 556 | IN OUT IP4_INTERFACE *Interface,\r |
557 | IN IP4_ADDR IpAddr,\r | |
558 | IN IP4_ADDR SubnetMask\r | |
772db4bb | 559 | )\r |
560 | {\r | |
561 | EFI_ARP_CONFIG_DATA ArpConfig;\r | |
562 | EFI_STATUS Status;\r | |
772db4bb | 563 | \r |
564 | NET_CHECK_SIGNATURE (Interface, IP4_INTERFACE_SIGNATURE);\r | |
565 | \r | |
772db4bb | 566 | //\r |
567 | // Set the ip/netmask, then compute the subnet broadcast\r | |
568 | // and network broadcast for easy access. When computing\r | |
569 | // nework broadcast, the subnet mask is most like longer\r | |
570 | // than the default netmask (not subneted) as defined in\r | |
571 | // RFC793. If that isn't the case, we are aggregating the\r | |
572 | // networks, use the subnet's mask instead.\r | |
573 | //\r | |
574 | Interface->Ip = IpAddr;\r | |
575 | Interface->SubnetMask = SubnetMask;\r | |
576 | Interface->SubnetBrdcast = (IpAddr | ~SubnetMask);\r | |
01b5ac88 | 577 | Interface->NetBrdcast = (IpAddr | ~SubnetMask);\r |
772db4bb | 578 | \r |
1f6729ff | 579 | //\r |
580 | // Do clean up for Arp child\r | |
581 | //\r | |
582 | if (Interface->ArpHandle != NULL) {\r | |
583 | if (Interface->Arp != NULL) {\r | |
584 | gBS->CloseProtocol (\r | |
585 | Interface->ArpHandle,\r | |
586 | &gEfiArpProtocolGuid,\r | |
587 | Interface->Image,\r | |
588 | Interface->Controller\r | |
589 | );\r | |
590 | \r | |
591 | Interface->Arp = NULL;\r | |
592 | }\r | |
593 | \r | |
594 | NetLibDestroyServiceChild (\r | |
595 | Interface->Controller,\r | |
596 | Interface->Image,\r | |
597 | &gEfiArpServiceBindingProtocolGuid,\r | |
598 | &Interface->ArpHandle\r | |
599 | );\r | |
600 | \r | |
601 | Interface->ArpHandle = NULL;\r | |
602 | }\r | |
603 | \r | |
772db4bb | 604 | //\r |
605 | // If the address is NOT all zero, create then configure an ARP child.\r | |
606 | // Pay attention: DHCP configures its station address as 0.0.0.0/0\r | |
607 | //\r | |
772db4bb | 608 | if (IpAddr != IP4_ALLZERO_ADDRESS) {\r |
609 | Status = NetLibCreateServiceChild (\r | |
610 | Interface->Controller,\r | |
611 | Interface->Image,\r | |
612 | &gEfiArpServiceBindingProtocolGuid,\r | |
613 | &Interface->ArpHandle\r | |
614 | );\r | |
615 | \r | |
616 | if (EFI_ERROR (Status)) {\r | |
1f6729ff | 617 | return Status;\r |
772db4bb | 618 | }\r |
619 | \r | |
620 | Status = gBS->OpenProtocol (\r | |
621 | Interface->ArpHandle,\r | |
622 | &gEfiArpProtocolGuid,\r | |
623 | (VOID **) &Interface->Arp,\r | |
624 | Interface->Image,\r | |
625 | Interface->Controller,\r | |
626 | EFI_OPEN_PROTOCOL_BY_DRIVER\r | |
627 | );\r | |
628 | \r | |
629 | if (EFI_ERROR (Status)) {\r | |
630 | goto ON_ERROR;\r | |
631 | }\r | |
632 | \r | |
633 | IpAddr = HTONL (IpAddr);\r | |
634 | ArpConfig.SwAddressType = IP4_ETHER_PROTO;\r | |
635 | ArpConfig.SwAddressLength = 4;\r | |
636 | ArpConfig.StationAddress = &IpAddr;\r | |
637 | ArpConfig.EntryTimeOut = 0;\r | |
638 | ArpConfig.RetryCount = 0;\r | |
639 | ArpConfig.RetryTimeOut = 0;\r | |
640 | \r | |
641 | Status = Interface->Arp->Configure (Interface->Arp, &ArpConfig);\r | |
642 | \r | |
643 | if (EFI_ERROR (Status)) {\r | |
644 | gBS->CloseProtocol (\r | |
1f6729ff | 645 | Interface->ArpHandle,\r |
646 | &gEfiArpProtocolGuid,\r | |
647 | Interface->Image,\r | |
648 | Interface->Controller\r | |
649 | );\r | |
772db4bb | 650 | \r |
651 | goto ON_ERROR;\r | |
652 | }\r | |
653 | }\r | |
654 | \r | |
655 | Interface->Configured = TRUE;\r | |
656 | return EFI_SUCCESS;\r | |
657 | \r | |
658 | ON_ERROR:\r | |
659 | NetLibDestroyServiceChild (\r | |
660 | Interface->Controller,\r | |
661 | Interface->Image,\r | |
662 | &gEfiArpServiceBindingProtocolGuid,\r | |
663 | &Interface->ArpHandle\r | |
664 | );\r | |
665 | \r | |
666 | return Status;\r | |
667 | }\r | |
668 | \r | |
669 | \r | |
670 | /**\r | |
5405e9a6 | 671 | Filter function to cancel all the frame related to an IP instance.\r |
772db4bb | 672 | \r |
3e8c18da | 673 | @param[in] Frame The transmit request to test whether to cancel\r |
674 | @param[in] Context The context which is the Ip instance that issued\r | |
772db4bb | 675 | the transmit.\r |
676 | \r | |
677 | @retval TRUE The frame belongs to this instance and is to be\r | |
678 | removed\r | |
679 | @retval FALSE The frame doesn't belong to this instance.\r | |
680 | \r | |
681 | **/\r | |
772db4bb | 682 | BOOLEAN\r |
683 | Ip4CancelInstanceFrame (\r | |
684 | IN IP4_LINK_TX_TOKEN *Frame,\r | |
685 | IN VOID *Context\r | |
686 | )\r | |
687 | {\r | |
688 | if (Frame->IpInstance == (IP4_PROTOCOL *) Context) {\r | |
689 | return TRUE;\r | |
690 | }\r | |
691 | \r | |
692 | return FALSE;\r | |
693 | }\r | |
694 | \r | |
695 | \r | |
696 | \r | |
697 | /**\r | |
698 | If there is a pending receive request, cancel it. Don't call\r | |
699 | the receive request's callback because this function can be only\r | |
700 | called if the instance or driver is tearing itself down. It\r | |
701 | doesn't make sense to call it back. But it is necessary to call\r | |
702 | the transmit token's callback to give it a chance to free the\r | |
703 | packet and update the upper layer's transmit request status, say\r | |
704 | that from the UDP.\r | |
705 | \r | |
3e8c18da | 706 | @param[in] Interface The interface used by the IpInstance\r |
772db4bb | 707 | \r |
708 | **/\r | |
709 | VOID\r | |
710 | Ip4CancelReceive (\r | |
711 | IN IP4_INTERFACE *Interface\r | |
712 | )\r | |
713 | {\r | |
714 | EFI_TPL OldTpl;\r | |
715 | IP4_LINK_RX_TOKEN *Token;\r | |
716 | \r | |
717 | if ((Token = Interface->RecvRequest) != NULL) {\r | |
e48e37fc | 718 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r |
772db4bb | 719 | \r |
720 | Interface->RecvRequest = NULL;\r | |
721 | Interface->Mnp->Cancel (Interface->Mnp, &Token->MnpToken);\r | |
772db4bb | 722 | \r |
e48e37fc | 723 | gBS->RestoreTPL (OldTpl);\r |
772db4bb | 724 | }\r |
725 | }\r | |
726 | \r | |
727 | \r | |
728 | /**\r | |
729 | Free the interface used by IpInstance. All the IP instance with\r | |
730 | the same Ip/Netmask pair share the same interface. It is reference\r | |
731 | counted. All the frames haven't been sent will be cancelled.\r | |
732 | Because the IpInstance is optional, the caller must remove\r | |
733 | IpInstance from the interface's instance list itself.\r | |
734 | \r | |
1f6729ff | 735 | @param[in] Interface The interface used by the IpInstance.\r |
3e8c18da | 736 | @param[in] IpInstance The Ip instance that free the interface. NULL if\r |
5405e9a6 | 737 | the Ip driver is releasing the default interface.\r |
772db4bb | 738 | \r |
739 | @retval EFI_SUCCESS The interface use IpInstance is freed.\r | |
740 | \r | |
741 | **/\r | |
742 | EFI_STATUS\r | |
743 | Ip4FreeInterface (\r | |
744 | IN IP4_INTERFACE *Interface,\r | |
745 | IN IP4_PROTOCOL *IpInstance OPTIONAL\r | |
746 | )\r | |
747 | {\r | |
748 | NET_CHECK_SIGNATURE (Interface, IP4_INTERFACE_SIGNATURE);\r | |
749 | ASSERT (Interface->RefCnt > 0);\r | |
750 | \r | |
751 | //\r | |
752 | // Remove all the pending transmit token related to this IP instance.\r | |
753 | //\r | |
754 | Ip4CancelFrames (Interface, EFI_ABORTED, Ip4CancelInstanceFrame, IpInstance);\r | |
755 | \r | |
d0ccf55e | 756 | if (--Interface->RefCnt > 0) {\r |
757 | return EFI_SUCCESS;\r | |
758 | }\r | |
759 | \r | |
772db4bb | 760 | //\r |
d0ccf55e | 761 | // Destroy the interface if this is the last IP instance that\r |
762 | // has the address. Remove all the system transmitted packets\r | |
763 | // from this interface, cancel the receive request if there is\r | |
764 | // one, and destroy the ARP requests.\r | |
772db4bb | 765 | //\r |
d0ccf55e | 766 | Ip4CancelFrames (Interface, EFI_ABORTED, Ip4CancelInstanceFrame, NULL);\r |
767 | Ip4CancelReceive (Interface);\r | |
768 | \r | |
769 | ASSERT (IsListEmpty (&Interface->IpInstances));\r | |
770 | ASSERT (IsListEmpty (&Interface->ArpQues));\r | |
771 | ASSERT (IsListEmpty (&Interface->SentFrames));\r | |
772 | \r | |
773 | if (Interface->Arp != NULL) {\r | |
772db4bb | 774 | gBS->CloseProtocol (\r |
775 | Interface->ArpHandle,\r | |
776 | &gEfiArpProtocolGuid,\r | |
777 | Interface->Image,\r | |
778 | Interface->Controller\r | |
779 | );\r | |
780 | \r | |
781 | NetLibDestroyServiceChild (\r | |
782 | Interface->Controller,\r | |
783 | Interface->Image,\r | |
784 | &gEfiArpServiceBindingProtocolGuid,\r | |
785 | Interface->ArpHandle\r | |
786 | );\r | |
787 | }\r | |
788 | \r | |
e48e37fc | 789 | RemoveEntryList (&Interface->Link);\r |
766c7483 | 790 | FreePool (Interface);\r |
772db4bb | 791 | \r |
792 | return EFI_SUCCESS;\r | |
793 | }\r | |
794 | \r | |
795 | \r | |
796 | /**\r | |
797 | Callback function when ARP request are finished. It will cancelled\r | |
798 | all the queued frame if the ARP requests failed. Or transmit them\r | |
799 | if the request succeed.\r | |
800 | \r | |
3e8c18da | 801 | @param[in] Context The context of the callback, a point to the ARP\r |
772db4bb | 802 | queue\r |
803 | \r | |
772db4bb | 804 | **/\r |
772db4bb | 805 | VOID\r |
806 | EFIAPI\r | |
36ee91ca | 807 | Ip4OnArpResolvedDpc (\r |
772db4bb | 808 | IN VOID *Context\r |
809 | )\r | |
810 | {\r | |
e48e37fc | 811 | LIST_ENTRY *Entry;\r |
812 | LIST_ENTRY *Next;\r | |
772db4bb | 813 | IP4_ARP_QUE *ArpQue;\r |
814 | IP4_INTERFACE *Interface;\r | |
815 | IP4_LINK_TX_TOKEN *Token;\r | |
816 | EFI_STATUS Status;\r | |
817 | \r | |
818 | ArpQue = (IP4_ARP_QUE *) Context;\r | |
819 | NET_CHECK_SIGNATURE (ArpQue, IP4_FRAME_ARP_SIGNATURE);\r | |
820 | \r | |
e48e37fc | 821 | RemoveEntryList (&ArpQue->Link);\r |
772db4bb | 822 | \r |
823 | //\r | |
824 | // ARP resolve failed for some reason. Release all the frame\r | |
825 | // and ARP queue itself. Ip4FreeArpQue will call the frame's\r | |
826 | // owner back.\r | |
827 | //\r | |
828 | if (NET_MAC_EQUAL (&ArpQue->Mac, &mZeroMacAddress, ArpQue->Interface->HwaddrLen)) {\r | |
829 | Ip4FreeArpQue (ArpQue, EFI_NO_MAPPING);\r | |
830 | \r | |
831 | return ;\r | |
832 | }\r | |
833 | \r | |
834 | //\r | |
835 | // ARP resolve succeeded, Transmit all the frame. Release the ARP\r | |
836 | // queue. It isn't necessary for us to cache the ARP binding because\r | |
837 | // we always check the ARP cache first before transmit.\r | |
838 | //\r | |
839 | Interface = ArpQue->Interface;\r | |
840 | \r | |
841 | NET_LIST_FOR_EACH_SAFE (Entry, Next, &ArpQue->Frames) {\r | |
e48e37fc | 842 | RemoveEntryList (Entry);\r |
772db4bb | 843 | \r |
844 | Token = NET_LIST_USER_STRUCT (Entry, IP4_LINK_TX_TOKEN, Link);\r | |
687a2e5f | 845 | CopyMem (&Token->DstMac, &ArpQue->Mac, sizeof (Token->DstMac));\r |
772db4bb | 846 | \r |
36ee91ca | 847 | //\r |
848 | // Insert the tx token before transmitting it via MNP as the FrameSentDpc\r | |
849 | // may be called before Mnp->Transmit returns which will remove this tx\r | |
850 | // token from the SentFrames list. Remove it from the list if the returned\r | |
851 | // Status of Mnp->Transmit is not EFI_SUCCESS as in this case the\r | |
852 | // FrameSentDpc won't be queued.\r | |
853 | //\r | |
e48e37fc | 854 | InsertTailList (&Interface->SentFrames, &Token->Link);\r |
772db4bb | 855 | \r |
36ee91ca | 856 | Status = Interface->Mnp->Transmit (Interface->Mnp, &Token->MnpToken);\r |
772db4bb | 857 | if (EFI_ERROR (Status)) {\r |
ad18ec95 | 858 | RemoveEntryList (&Token->Link);\r |
772db4bb | 859 | Token->CallBack (Token->IpInstance, Token->Packet, Status, 0, Token->Context);\r |
860 | \r | |
861 | Ip4FreeLinkTxToken (Token);\r | |
862 | continue;\r | |
863 | }\r | |
772db4bb | 864 | }\r |
865 | \r | |
866 | Ip4FreeArpQue (ArpQue, EFI_SUCCESS);\r | |
867 | }\r | |
868 | \r | |
5405e9a6 | 869 | /**\r |
870 | Request Ip4OnArpResolvedDpc as a DPC at TPL_CALLBACK.\r | |
871 | \r | |
3e8c18da | 872 | @param Event The Arp request event.\r |
873 | @param Context The context of the callback, a point to the ARP\r | |
874 | queue.\r | |
875 | \r | |
5405e9a6 | 876 | **/\r |
36ee91ca | 877 | VOID\r |
878 | EFIAPI\r | |
879 | Ip4OnArpResolved (\r | |
880 | IN EFI_EVENT Event,\r | |
881 | IN VOID *Context\r | |
882 | )\r | |
36ee91ca | 883 | {\r |
884 | //\r | |
885 | // Request Ip4OnArpResolvedDpc as a DPC at TPL_CALLBACK\r | |
886 | //\r | |
d8d26fb2 | 887 | QueueDpc (TPL_CALLBACK, Ip4OnArpResolvedDpc, Context);\r |
36ee91ca | 888 | }\r |
889 | \r | |
890 | \r | |
772db4bb | 891 | \r |
892 | /**\r | |
893 | Callback funtion when frame transmission is finished. It will\r | |
894 | call the frame owner's callback function to tell it the result.\r | |
895 | \r | |
3e8c18da | 896 | @param[in] Context Context which is point to the token.\r |
772db4bb | 897 | \r |
898 | **/\r | |
772db4bb | 899 | VOID\r |
900 | EFIAPI\r | |
36ee91ca | 901 | Ip4OnFrameSentDpc (\r |
772db4bb | 902 | IN VOID *Context\r |
903 | )\r | |
904 | {\r | |
905 | IP4_LINK_TX_TOKEN *Token;\r | |
906 | \r | |
907 | Token = (IP4_LINK_TX_TOKEN *) Context;\r | |
908 | NET_CHECK_SIGNATURE (Token, IP4_FRAME_TX_SIGNATURE);\r | |
909 | \r | |
e48e37fc | 910 | RemoveEntryList (&Token->Link);\r |
772db4bb | 911 | \r |
912 | Token->CallBack (\r | |
913 | Token->IpInstance,\r | |
914 | Token->Packet,\r | |
915 | Token->MnpToken.Status,\r | |
916 | 0,\r | |
917 | Token->Context\r | |
918 | );\r | |
919 | \r | |
920 | Ip4FreeLinkTxToken (Token);\r | |
921 | }\r | |
922 | \r | |
5405e9a6 | 923 | /**\r |
924 | Request Ip4OnFrameSentDpc as a DPC at TPL_CALLBACK.\r | |
925 | \r | |
3e8c18da | 926 | @param[in] Event The transmit token's event.\r |
927 | @param[in] Context Context which is point to the token.\r | |
5405e9a6 | 928 | \r |
929 | **/\r | |
36ee91ca | 930 | VOID\r |
931 | EFIAPI\r | |
932 | Ip4OnFrameSent (\r | |
933 | IN EFI_EVENT Event,\r | |
934 | IN VOID *Context\r | |
935 | )\r | |
36ee91ca | 936 | {\r |
937 | //\r | |
938 | // Request Ip4OnFrameSentDpc as a DPC at TPL_CALLBACK\r | |
939 | //\r | |
d8d26fb2 | 940 | QueueDpc (TPL_CALLBACK, Ip4OnFrameSentDpc, Context);\r |
36ee91ca | 941 | }\r |
942 | \r | |
772db4bb | 943 | \r |
944 | \r | |
945 | /**\r | |
946 | Send a frame from the interface. If the next hop is broadcast or\r | |
947 | multicast address, it is transmitted immediately. If the next hop\r | |
948 | is a unicast, it will consult ARP to resolve the NextHop's MAC.\r | |
949 | If some error happened, the CallBack won't be called. So, the caller\r | |
950 | must test the return value, and take action when there is an error.\r | |
951 | \r | |
3e8c18da | 952 | @param[in] Interface The interface to send the frame from\r |
953 | @param[in] IpInstance The IP child that request the transmission. NULL\r | |
772db4bb | 954 | if it is the IP4 driver itself.\r |
3e8c18da | 955 | @param[in] Packet The packet to transmit.\r |
956 | @param[in] NextHop The immediate destination to transmit the packet\r | |
772db4bb | 957 | to.\r |
3e8c18da | 958 | @param[in] CallBack Function to call back when transmit finished.\r |
959 | @param[in] Context Opaque parameter to the call back.\r | |
772db4bb | 960 | \r |
961 | @retval EFI_OUT_OF_RESOURCES Failed to allocate resource to send the frame\r | |
962 | @retval EFI_NO_MAPPING Can't resolve the MAC for the nexthop\r | |
963 | @retval EFI_SUCCESS The packet is successfully transmitted.\r | |
5405e9a6 | 964 | @retval other Other error occurs.\r |
772db4bb | 965 | \r |
966 | **/\r | |
967 | EFI_STATUS\r | |
968 | Ip4SendFrame (\r | |
969 | IN IP4_INTERFACE *Interface,\r | |
24af132f | 970 | IN IP4_PROTOCOL *IpInstance OPTIONAL,\r |
772db4bb | 971 | IN NET_BUF *Packet,\r |
972 | IN IP4_ADDR NextHop,\r | |
973 | IN IP4_FRAME_CALLBACK CallBack,\r | |
974 | IN VOID *Context\r | |
975 | )\r | |
976 | {\r | |
977 | IP4_LINK_TX_TOKEN *Token;\r | |
e48e37fc | 978 | LIST_ENTRY *Entry;\r |
772db4bb | 979 | IP4_ARP_QUE *ArpQue;\r |
980 | EFI_ARP_PROTOCOL *Arp;\r | |
981 | EFI_STATUS Status;\r | |
982 | \r | |
983 | ASSERT (Interface->Configured);\r | |
984 | \r | |
985 | Token = Ip4WrapLinkTxToken (Interface, IpInstance, Packet, CallBack, Context);\r | |
986 | \r | |
987 | if (Token == NULL) {\r | |
988 | return EFI_OUT_OF_RESOURCES;\r | |
989 | }\r | |
990 | \r | |
991 | //\r | |
992 | // Get the destination MAC address for multicast and broadcasts.\r | |
993 | // Don't depend on ARP to solve the address since there maybe no\r | |
994 | // ARP at all. Ip4Output has set NextHop to 255.255.255.255 for\r | |
995 | // all the broadcasts.\r | |
996 | //\r | |
997 | if (NextHop == IP4_ALLONE_ADDRESS) {\r | |
687a2e5f | 998 | CopyMem (&Token->DstMac, &Interface->BroadcastMac, sizeof (Token->DstMac));\r |
772db4bb | 999 | goto SEND_NOW;\r |
1000 | \r | |
1001 | } else if (IP4_IS_MULTICAST (NextHop)) {\r | |
1002 | \r | |
1003 | Status = Ip4GetMulticastMac (Interface->Mnp, NextHop, &Token->DstMac);\r | |
1004 | \r | |
1005 | if (EFI_ERROR (Status)) {\r | |
1006 | goto ON_ERROR;\r | |
1007 | }\r | |
1008 | \r | |
1009 | goto SEND_NOW;\r | |
1010 | }\r | |
1011 | \r | |
1012 | //\r | |
1013 | // Can only send out multicast/broadcast if the IP address is zero\r | |
1014 | //\r | |
1015 | if ((Arp = Interface->Arp) == NULL) {\r | |
1016 | Status = EFI_NO_MAPPING;\r | |
1017 | goto ON_ERROR;\r | |
1018 | }\r | |
1019 | \r | |
1020 | //\r | |
1021 | // First check whether this binding is in the ARP cache.\r | |
1022 | //\r | |
1023 | NextHop = HTONL (NextHop);\r | |
1024 | Status = Arp->Request (Arp, &NextHop, NULL, &Token->DstMac);\r | |
1025 | \r | |
1026 | if (Status == EFI_SUCCESS) {\r | |
1027 | goto SEND_NOW;\r | |
1028 | \r | |
1029 | } else if (Status != EFI_NOT_READY) {\r | |
1030 | goto ON_ERROR;\r | |
1031 | }\r | |
1032 | \r | |
1033 | //\r | |
1034 | // Have to do asynchronous ARP resolution. First check\r | |
1035 | // whether there is already a pending request.\r | |
1036 | //\r | |
1037 | ArpQue = NULL;\r | |
1038 | \r | |
1039 | NET_LIST_FOR_EACH (Entry, &Interface->ArpQues) {\r | |
1040 | ArpQue = NET_LIST_USER_STRUCT (Entry, IP4_ARP_QUE, Link);\r | |
1041 | \r | |
1042 | if (ArpQue->Ip == NextHop) {\r | |
1043 | break;\r | |
1044 | }\r | |
1045 | }\r | |
1046 | \r | |
1047 | //\r | |
1048 | // Found a pending ARP request, enqueue the frame then return\r | |
1049 | //\r | |
1050 | if (Entry != &Interface->ArpQues) {\r | |
e48e37fc | 1051 | InsertTailList (&ArpQue->Frames, &Token->Link);\r |
772db4bb | 1052 | return EFI_SUCCESS;\r |
1053 | }\r | |
1054 | \r | |
1055 | //\r | |
1056 | // First frame to NextHop, issue an asynchronous ARP requests\r | |
1057 | //\r | |
1058 | ArpQue = Ip4CreateArpQue (Interface, NextHop);\r | |
1059 | \r | |
1060 | if (ArpQue == NULL) {\r | |
1061 | Status = EFI_OUT_OF_RESOURCES;\r | |
1062 | goto ON_ERROR;\r | |
1063 | }\r | |
1064 | \r | |
1065 | Status = Arp->Request (Arp, &ArpQue->Ip, ArpQue->OnResolved, ArpQue->Mac.Addr);\r | |
1066 | \r | |
1067 | if (EFI_ERROR (Status) && (Status != EFI_NOT_READY)) {\r | |
1068 | Ip4FreeArpQue (ArpQue, EFI_NO_MAPPING);\r | |
1069 | goto ON_ERROR;\r | |
1070 | }\r | |
1071 | \r | |
e48e37fc | 1072 | InsertHeadList (&ArpQue->Frames, &Token->Link);\r |
1073 | InsertHeadList (&Interface->ArpQues, &ArpQue->Link);\r | |
772db4bb | 1074 | return EFI_SUCCESS;\r |
1075 | \r | |
1076 | SEND_NOW:\r | |
36ee91ca | 1077 | //\r |
1078 | // Insert the tx token into the SentFrames list before calling Mnp->Transmit.\r | |
1079 | // Remove it if the returned status is not EFI_SUCCESS.\r | |
1080 | //\r | |
e48e37fc | 1081 | InsertTailList (&Interface->SentFrames, &Token->Link);\r |
772db4bb | 1082 | Status = Interface->Mnp->Transmit (Interface->Mnp, &Token->MnpToken);\r |
772db4bb | 1083 | if (EFI_ERROR (Status)) {\r |
ad18ec95 | 1084 | RemoveEntryList (&Token->Link);\r |
772db4bb | 1085 | goto ON_ERROR;\r |
1086 | }\r | |
1087 | \r | |
772db4bb | 1088 | return EFI_SUCCESS;\r |
1089 | \r | |
1090 | ON_ERROR:\r | |
1091 | Ip4FreeLinkTxToken (Token);\r | |
1092 | return Status;\r | |
1093 | }\r | |
1094 | \r | |
1095 | \r | |
1096 | /**\r | |
1097 | Call back function when the received packet is freed.\r | |
1098 | Check Ip4OnFrameReceived for information.\r | |
1099 | \r | |
3e8c18da | 1100 | @param Context Context, which is the IP4_LINK_RX_TOKEN.\r |
772db4bb | 1101 | \r |
1102 | **/\r | |
772db4bb | 1103 | VOID\r |
e798cd87 | 1104 | EFIAPI\r |
772db4bb | 1105 | Ip4RecycleFrame (\r |
1106 | IN VOID *Context\r | |
1107 | )\r | |
1108 | {\r | |
1109 | IP4_LINK_RX_TOKEN *Frame;\r | |
1110 | \r | |
1111 | Frame = (IP4_LINK_RX_TOKEN *) Context;\r | |
1112 | NET_CHECK_SIGNATURE (Frame, IP4_FRAME_RX_SIGNATURE);\r | |
1113 | \r | |
1114 | gBS->SignalEvent (Frame->MnpToken.Packet.RxData->RecycleEvent);\r | |
1115 | Ip4FreeFrameRxToken (Frame);\r | |
1116 | }\r | |
1117 | \r | |
1118 | \r | |
1119 | /**\r | |
1120 | Received a frame from MNP, wrap it in net buffer then deliver\r | |
1121 | it to IP's input function. The ownship of the packet also\r | |
1122 | transferred to IP. When Ip is finished with this packet, it\r | |
1123 | will call NetbufFree to release the packet, NetbufFree will\r | |
1124 | again call the Ip4RecycleFrame to signal MNP's event and free\r | |
1125 | the token used.\r | |
1126 | \r | |
772db4bb | 1127 | @param Context Context for the callback.\r |
1128 | \r | |
772db4bb | 1129 | **/\r |
772db4bb | 1130 | VOID\r |
1131 | EFIAPI\r | |
36ee91ca | 1132 | Ip4OnFrameReceivedDpc (\r |
772db4bb | 1133 | IN VOID *Context\r |
1134 | )\r | |
1135 | {\r | |
1136 | EFI_MANAGED_NETWORK_COMPLETION_TOKEN *MnpToken;\r | |
1137 | EFI_MANAGED_NETWORK_RECEIVE_DATA *MnpRxData;\r | |
1138 | IP4_LINK_RX_TOKEN *Token;\r | |
1139 | NET_FRAGMENT Netfrag;\r | |
1140 | NET_BUF *Packet;\r | |
1141 | UINT32 Flag;\r | |
1142 | \r | |
1143 | Token = (IP4_LINK_RX_TOKEN *) Context;\r | |
1144 | NET_CHECK_SIGNATURE (Token, IP4_FRAME_RX_SIGNATURE);\r | |
1145 | \r | |
1146 | //\r | |
1147 | // First clear the interface's receive request in case the\r | |
1148 | // caller wants to call Ip4ReceiveFrame in the callback.\r | |
1149 | //\r | |
1150 | Token->Interface->RecvRequest = NULL;\r | |
1151 | \r | |
1152 | MnpToken = &Token->MnpToken;\r | |
1153 | MnpRxData = MnpToken->Packet.RxData;\r | |
1154 | \r | |
1155 | if (EFI_ERROR (MnpToken->Status) || (MnpRxData == NULL)) {\r | |
1156 | Token->CallBack (Token->IpInstance, NULL, MnpToken->Status, 0, Token->Context);\r | |
1157 | Ip4FreeFrameRxToken (Token);\r | |
1158 | \r | |
1159 | return ;\r | |
1160 | }\r | |
1161 | \r | |
1162 | //\r | |
1163 | // Wrap the frame in a net buffer then deliever it to IP input.\r | |
1164 | // IP will reassemble the packet, and deliver it to upper layer\r | |
1165 | //\r | |
1166 | Netfrag.Len = MnpRxData->DataLength;\r | |
1167 | Netfrag.Bulk = MnpRxData->PacketData;\r | |
1168 | \r | |
1169 | Packet = NetbufFromExt (&Netfrag, 1, 0, IP4_MAX_HEADLEN, Ip4RecycleFrame, Token);\r | |
1170 | \r | |
1171 | if (Packet == NULL) {\r | |
1172 | gBS->SignalEvent (MnpRxData->RecycleEvent);\r | |
1173 | \r | |
1174 | Token->CallBack (Token->IpInstance, NULL, EFI_OUT_OF_RESOURCES, 0, Token->Context);\r | |
1175 | Ip4FreeFrameRxToken (Token);\r | |
1176 | \r | |
1177 | return ;\r | |
1178 | }\r | |
1179 | \r | |
1180 | Flag = (MnpRxData->BroadcastFlag ? IP4_LINK_BROADCAST : 0);\r | |
1181 | Flag |= (MnpRxData->MulticastFlag ? IP4_LINK_MULTICAST : 0);\r | |
1182 | Flag |= (MnpRxData->PromiscuousFlag ? IP4_LINK_PROMISC : 0);\r | |
1183 | \r | |
1184 | Token->CallBack (Token->IpInstance, Packet, EFI_SUCCESS, Flag, Token->Context);\r | |
1185 | }\r | |
1186 | \r | |
2ff29212 | 1187 | /**\r |
2ff29212 | 1188 | Request Ip4OnFrameReceivedDpc as a DPC at TPL_CALLBACK.\r |
1189 | \r | |
1190 | @param Event The receive event delivered to MNP for receive.\r | |
1191 | @param Context Context for the callback.\r | |
2ff29212 | 1192 | \r |
1193 | **/\r | |
36ee91ca | 1194 | VOID\r |
1195 | EFIAPI\r | |
1196 | Ip4OnFrameReceived (\r | |
1197 | IN EFI_EVENT Event,\r | |
1198 | IN VOID *Context\r | |
1199 | )\r | |
36ee91ca | 1200 | {\r |
1201 | //\r | |
1202 | // Request Ip4OnFrameReceivedDpc as a DPC at TPL_CALLBACK\r | |
1203 | //\r | |
d8d26fb2 | 1204 | QueueDpc (TPL_CALLBACK, Ip4OnFrameReceivedDpc, Context);\r |
36ee91ca | 1205 | }\r |
1206 | \r | |
772db4bb | 1207 | \r |
1208 | /**\r | |
1209 | Request to receive the packet from the interface.\r | |
1210 | \r | |
1f6729ff | 1211 | @param[in] Interface The interface to receive the frames from.\r |
3e8c18da | 1212 | @param[in] IpInstance The instance that requests the receive. NULL for\r |
772db4bb | 1213 | the driver itself.\r |
3e8c18da | 1214 | @param[in] CallBack Function to call when receive finished.\r |
1f6729ff | 1215 | @param[in] Context Opaque parameter to the callback.\r |
772db4bb | 1216 | \r |
1217 | @retval EFI_ALREADY_STARTED There is already a pending receive request.\r | |
1f6729ff | 1218 | @retval EFI_OUT_OF_RESOURCES Failed to allocate resource to receive.\r |
772db4bb | 1219 | @retval EFI_SUCCESS The recieve request has been started.\r |
5405e9a6 | 1220 | @retval other Other error occurs.\r |
772db4bb | 1221 | \r |
1222 | **/\r | |
1223 | EFI_STATUS\r | |
1224 | Ip4ReceiveFrame (\r | |
1225 | IN IP4_INTERFACE *Interface,\r | |
24af132f | 1226 | IN IP4_PROTOCOL *IpInstance OPTIONAL,\r |
772db4bb | 1227 | IN IP4_FRAME_CALLBACK CallBack,\r |
1228 | IN VOID *Context\r | |
1229 | )\r | |
1230 | {\r | |
1231 | IP4_LINK_RX_TOKEN *Token;\r | |
1232 | EFI_STATUS Status;\r | |
1233 | \r | |
1234 | NET_CHECK_SIGNATURE (Interface, IP4_INTERFACE_SIGNATURE);\r | |
1235 | \r | |
1236 | if (Interface->RecvRequest != NULL) {\r | |
1237 | return EFI_ALREADY_STARTED;\r | |
1238 | }\r | |
1239 | \r | |
1240 | Token = Ip4CreateLinkRxToken (Interface, IpInstance, CallBack, Context);\r | |
1241 | \r | |
1242 | if (Token == NULL) {\r | |
1243 | return EFI_OUT_OF_RESOURCES;\r | |
1244 | }\r | |
1245 | \r | |
36ee91ca | 1246 | Interface->RecvRequest = Token;\r |
772db4bb | 1247 | Status = Interface->Mnp->Receive (Interface->Mnp, &Token->MnpToken);\r |
772db4bb | 1248 | if (EFI_ERROR (Status)) {\r |
36ee91ca | 1249 | Interface->RecvRequest = NULL;\r |
772db4bb | 1250 | Ip4FreeFrameRxToken (Token);\r |
1251 | return Status;\r | |
1252 | }\r | |
772db4bb | 1253 | return EFI_SUCCESS;\r |
1254 | }\r |