]>
Commit | Line | Data |
---|---|---|
772db4bb | 1 | /** @file\r |
3e8c18da | 2 | Implement IP4 pesudo interface.\r |
3 | \r | |
1f6729ff | 4 | Copyright (c) 2005 - 2015, 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 | |
563 | INTN Type;\r | |
564 | INTN Len;\r | |
565 | IP4_ADDR Netmask;\r | |
566 | \r | |
567 | NET_CHECK_SIGNATURE (Interface, IP4_INTERFACE_SIGNATURE);\r | |
568 | \r | |
772db4bb | 569 | //\r |
570 | // Set the ip/netmask, then compute the subnet broadcast\r | |
571 | // and network broadcast for easy access. When computing\r | |
572 | // nework broadcast, the subnet mask is most like longer\r | |
573 | // than the default netmask (not subneted) as defined in\r | |
574 | // RFC793. If that isn't the case, we are aggregating the\r | |
575 | // networks, use the subnet's mask instead.\r | |
576 | //\r | |
577 | Interface->Ip = IpAddr;\r | |
578 | Interface->SubnetMask = SubnetMask;\r | |
579 | Interface->SubnetBrdcast = (IpAddr | ~SubnetMask);\r | |
580 | \r | |
581 | Type = NetGetIpClass (IpAddr);\r | |
48178d7a | 582 | ASSERT (Type <= IP4_ADDR_CLASSC);\r |
772db4bb | 583 | Len = NetGetMaskLength (SubnetMask);\r |
48178d7a FS |
584 | ASSERT (Len < IP4_MASK_NUM);\r |
585 | Netmask = gIp4AllMasks[MIN (Len, Type << 3)];\r | |
772db4bb | 586 | Interface->NetBrdcast = (IpAddr | ~Netmask);\r |
587 | \r | |
1f6729ff | 588 | //\r |
589 | // Do clean up for Arp child\r | |
590 | //\r | |
591 | if (Interface->ArpHandle != NULL) {\r | |
592 | if (Interface->Arp != NULL) {\r | |
593 | gBS->CloseProtocol (\r | |
594 | Interface->ArpHandle,\r | |
595 | &gEfiArpProtocolGuid,\r | |
596 | Interface->Image,\r | |
597 | Interface->Controller\r | |
598 | );\r | |
599 | \r | |
600 | Interface->Arp = NULL;\r | |
601 | }\r | |
602 | \r | |
603 | NetLibDestroyServiceChild (\r | |
604 | Interface->Controller,\r | |
605 | Interface->Image,\r | |
606 | &gEfiArpServiceBindingProtocolGuid,\r | |
607 | &Interface->ArpHandle\r | |
608 | );\r | |
609 | \r | |
610 | Interface->ArpHandle = NULL;\r | |
611 | }\r | |
612 | \r | |
772db4bb | 613 | //\r |
614 | // If the address is NOT all zero, create then configure an ARP child.\r | |
615 | // Pay attention: DHCP configures its station address as 0.0.0.0/0\r | |
616 | //\r | |
772db4bb | 617 | if (IpAddr != IP4_ALLZERO_ADDRESS) {\r |
618 | Status = NetLibCreateServiceChild (\r | |
619 | Interface->Controller,\r | |
620 | Interface->Image,\r | |
621 | &gEfiArpServiceBindingProtocolGuid,\r | |
622 | &Interface->ArpHandle\r | |
623 | );\r | |
624 | \r | |
625 | if (EFI_ERROR (Status)) {\r | |
1f6729ff | 626 | return Status;\r |
772db4bb | 627 | }\r |
628 | \r | |
629 | Status = gBS->OpenProtocol (\r | |
630 | Interface->ArpHandle,\r | |
631 | &gEfiArpProtocolGuid,\r | |
632 | (VOID **) &Interface->Arp,\r | |
633 | Interface->Image,\r | |
634 | Interface->Controller,\r | |
635 | EFI_OPEN_PROTOCOL_BY_DRIVER\r | |
636 | );\r | |
637 | \r | |
638 | if (EFI_ERROR (Status)) {\r | |
639 | goto ON_ERROR;\r | |
640 | }\r | |
641 | \r | |
642 | IpAddr = HTONL (IpAddr);\r | |
643 | ArpConfig.SwAddressType = IP4_ETHER_PROTO;\r | |
644 | ArpConfig.SwAddressLength = 4;\r | |
645 | ArpConfig.StationAddress = &IpAddr;\r | |
646 | ArpConfig.EntryTimeOut = 0;\r | |
647 | ArpConfig.RetryCount = 0;\r | |
648 | ArpConfig.RetryTimeOut = 0;\r | |
649 | \r | |
650 | Status = Interface->Arp->Configure (Interface->Arp, &ArpConfig);\r | |
651 | \r | |
652 | if (EFI_ERROR (Status)) {\r | |
653 | gBS->CloseProtocol (\r | |
1f6729ff | 654 | Interface->ArpHandle,\r |
655 | &gEfiArpProtocolGuid,\r | |
656 | Interface->Image,\r | |
657 | Interface->Controller\r | |
658 | );\r | |
772db4bb | 659 | \r |
660 | goto ON_ERROR;\r | |
661 | }\r | |
662 | }\r | |
663 | \r | |
664 | Interface->Configured = TRUE;\r | |
665 | return EFI_SUCCESS;\r | |
666 | \r | |
667 | ON_ERROR:\r | |
668 | NetLibDestroyServiceChild (\r | |
669 | Interface->Controller,\r | |
670 | Interface->Image,\r | |
671 | &gEfiArpServiceBindingProtocolGuid,\r | |
672 | &Interface->ArpHandle\r | |
673 | );\r | |
674 | \r | |
675 | return Status;\r | |
676 | }\r | |
677 | \r | |
678 | \r | |
679 | /**\r | |
5405e9a6 | 680 | Filter function to cancel all the frame related to an IP instance.\r |
772db4bb | 681 | \r |
3e8c18da | 682 | @param[in] Frame The transmit request to test whether to cancel\r |
683 | @param[in] Context The context which is the Ip instance that issued\r | |
772db4bb | 684 | the transmit.\r |
685 | \r | |
686 | @retval TRUE The frame belongs to this instance and is to be\r | |
687 | removed\r | |
688 | @retval FALSE The frame doesn't belong to this instance.\r | |
689 | \r | |
690 | **/\r | |
772db4bb | 691 | BOOLEAN\r |
692 | Ip4CancelInstanceFrame (\r | |
693 | IN IP4_LINK_TX_TOKEN *Frame,\r | |
694 | IN VOID *Context\r | |
695 | )\r | |
696 | {\r | |
697 | if (Frame->IpInstance == (IP4_PROTOCOL *) Context) {\r | |
698 | return TRUE;\r | |
699 | }\r | |
700 | \r | |
701 | return FALSE;\r | |
702 | }\r | |
703 | \r | |
704 | \r | |
705 | \r | |
706 | /**\r | |
707 | If there is a pending receive request, cancel it. Don't call\r | |
708 | the receive request's callback because this function can be only\r | |
709 | called if the instance or driver is tearing itself down. It\r | |
710 | doesn't make sense to call it back. But it is necessary to call\r | |
711 | the transmit token's callback to give it a chance to free the\r | |
712 | packet and update the upper layer's transmit request status, say\r | |
713 | that from the UDP.\r | |
714 | \r | |
3e8c18da | 715 | @param[in] Interface The interface used by the IpInstance\r |
772db4bb | 716 | \r |
717 | **/\r | |
718 | VOID\r | |
719 | Ip4CancelReceive (\r | |
720 | IN IP4_INTERFACE *Interface\r | |
721 | )\r | |
722 | {\r | |
723 | EFI_TPL OldTpl;\r | |
724 | IP4_LINK_RX_TOKEN *Token;\r | |
725 | \r | |
726 | if ((Token = Interface->RecvRequest) != NULL) {\r | |
e48e37fc | 727 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r |
772db4bb | 728 | \r |
729 | Interface->RecvRequest = NULL;\r | |
730 | Interface->Mnp->Cancel (Interface->Mnp, &Token->MnpToken);\r | |
772db4bb | 731 | \r |
e48e37fc | 732 | gBS->RestoreTPL (OldTpl);\r |
772db4bb | 733 | }\r |
734 | }\r | |
735 | \r | |
736 | \r | |
737 | /**\r | |
738 | Free the interface used by IpInstance. All the IP instance with\r | |
739 | the same Ip/Netmask pair share the same interface. It is reference\r | |
740 | counted. All the frames haven't been sent will be cancelled.\r | |
741 | Because the IpInstance is optional, the caller must remove\r | |
742 | IpInstance from the interface's instance list itself.\r | |
743 | \r | |
1f6729ff | 744 | @param[in] Interface The interface used by the IpInstance.\r |
3e8c18da | 745 | @param[in] IpInstance The Ip instance that free the interface. NULL if\r |
5405e9a6 | 746 | the Ip driver is releasing the default interface.\r |
772db4bb | 747 | \r |
748 | @retval EFI_SUCCESS The interface use IpInstance is freed.\r | |
749 | \r | |
750 | **/\r | |
751 | EFI_STATUS\r | |
752 | Ip4FreeInterface (\r | |
753 | IN IP4_INTERFACE *Interface,\r | |
754 | IN IP4_PROTOCOL *IpInstance OPTIONAL\r | |
755 | )\r | |
756 | {\r | |
757 | NET_CHECK_SIGNATURE (Interface, IP4_INTERFACE_SIGNATURE);\r | |
758 | ASSERT (Interface->RefCnt > 0);\r | |
759 | \r | |
760 | //\r | |
761 | // Remove all the pending transmit token related to this IP instance.\r | |
762 | //\r | |
763 | Ip4CancelFrames (Interface, EFI_ABORTED, Ip4CancelInstanceFrame, IpInstance);\r | |
764 | \r | |
d0ccf55e | 765 | if (--Interface->RefCnt > 0) {\r |
766 | return EFI_SUCCESS;\r | |
767 | }\r | |
768 | \r | |
772db4bb | 769 | //\r |
d0ccf55e | 770 | // Destroy the interface if this is the last IP instance that\r |
771 | // has the address. Remove all the system transmitted packets\r | |
772 | // from this interface, cancel the receive request if there is\r | |
773 | // one, and destroy the ARP requests.\r | |
772db4bb | 774 | //\r |
d0ccf55e | 775 | Ip4CancelFrames (Interface, EFI_ABORTED, Ip4CancelInstanceFrame, NULL);\r |
776 | Ip4CancelReceive (Interface);\r | |
777 | \r | |
778 | ASSERT (IsListEmpty (&Interface->IpInstances));\r | |
779 | ASSERT (IsListEmpty (&Interface->ArpQues));\r | |
780 | ASSERT (IsListEmpty (&Interface->SentFrames));\r | |
781 | \r | |
782 | if (Interface->Arp != NULL) {\r | |
772db4bb | 783 | gBS->CloseProtocol (\r |
784 | Interface->ArpHandle,\r | |
785 | &gEfiArpProtocolGuid,\r | |
786 | Interface->Image,\r | |
787 | Interface->Controller\r | |
788 | );\r | |
789 | \r | |
790 | NetLibDestroyServiceChild (\r | |
791 | Interface->Controller,\r | |
792 | Interface->Image,\r | |
793 | &gEfiArpServiceBindingProtocolGuid,\r | |
794 | Interface->ArpHandle\r | |
795 | );\r | |
796 | }\r | |
797 | \r | |
e48e37fc | 798 | RemoveEntryList (&Interface->Link);\r |
766c7483 | 799 | FreePool (Interface);\r |
772db4bb | 800 | \r |
801 | return EFI_SUCCESS;\r | |
802 | }\r | |
803 | \r | |
804 | \r | |
805 | /**\r | |
806 | Callback function when ARP request are finished. It will cancelled\r | |
807 | all the queued frame if the ARP requests failed. Or transmit them\r | |
808 | if the request succeed.\r | |
809 | \r | |
3e8c18da | 810 | @param[in] Context The context of the callback, a point to the ARP\r |
772db4bb | 811 | queue\r |
812 | \r | |
772db4bb | 813 | **/\r |
772db4bb | 814 | VOID\r |
815 | EFIAPI\r | |
36ee91ca | 816 | Ip4OnArpResolvedDpc (\r |
772db4bb | 817 | IN VOID *Context\r |
818 | )\r | |
819 | {\r | |
e48e37fc | 820 | LIST_ENTRY *Entry;\r |
821 | LIST_ENTRY *Next;\r | |
772db4bb | 822 | IP4_ARP_QUE *ArpQue;\r |
823 | IP4_INTERFACE *Interface;\r | |
824 | IP4_LINK_TX_TOKEN *Token;\r | |
825 | EFI_STATUS Status;\r | |
826 | \r | |
827 | ArpQue = (IP4_ARP_QUE *) Context;\r | |
828 | NET_CHECK_SIGNATURE (ArpQue, IP4_FRAME_ARP_SIGNATURE);\r | |
829 | \r | |
e48e37fc | 830 | RemoveEntryList (&ArpQue->Link);\r |
772db4bb | 831 | \r |
832 | //\r | |
833 | // ARP resolve failed for some reason. Release all the frame\r | |
834 | // and ARP queue itself. Ip4FreeArpQue will call the frame's\r | |
835 | // owner back.\r | |
836 | //\r | |
837 | if (NET_MAC_EQUAL (&ArpQue->Mac, &mZeroMacAddress, ArpQue->Interface->HwaddrLen)) {\r | |
838 | Ip4FreeArpQue (ArpQue, EFI_NO_MAPPING);\r | |
839 | \r | |
840 | return ;\r | |
841 | }\r | |
842 | \r | |
843 | //\r | |
844 | // ARP resolve succeeded, Transmit all the frame. Release the ARP\r | |
845 | // queue. It isn't necessary for us to cache the ARP binding because\r | |
846 | // we always check the ARP cache first before transmit.\r | |
847 | //\r | |
848 | Interface = ArpQue->Interface;\r | |
849 | \r | |
850 | NET_LIST_FOR_EACH_SAFE (Entry, Next, &ArpQue->Frames) {\r | |
e48e37fc | 851 | RemoveEntryList (Entry);\r |
772db4bb | 852 | \r |
853 | Token = NET_LIST_USER_STRUCT (Entry, IP4_LINK_TX_TOKEN, Link);\r | |
687a2e5f | 854 | CopyMem (&Token->DstMac, &ArpQue->Mac, sizeof (Token->DstMac));\r |
772db4bb | 855 | \r |
36ee91ca | 856 | //\r |
857 | // Insert the tx token before transmitting it via MNP as the FrameSentDpc\r | |
858 | // may be called before Mnp->Transmit returns which will remove this tx\r | |
859 | // token from the SentFrames list. Remove it from the list if the returned\r | |
860 | // Status of Mnp->Transmit is not EFI_SUCCESS as in this case the\r | |
861 | // FrameSentDpc won't be queued.\r | |
862 | //\r | |
e48e37fc | 863 | InsertTailList (&Interface->SentFrames, &Token->Link);\r |
772db4bb | 864 | \r |
36ee91ca | 865 | Status = Interface->Mnp->Transmit (Interface->Mnp, &Token->MnpToken);\r |
772db4bb | 866 | if (EFI_ERROR (Status)) {\r |
e48e37fc | 867 | RemoveEntryList (Entry);\r |
772db4bb | 868 | Token->CallBack (Token->IpInstance, Token->Packet, Status, 0, Token->Context);\r |
869 | \r | |
870 | Ip4FreeLinkTxToken (Token);\r | |
871 | continue;\r | |
872 | }\r | |
772db4bb | 873 | }\r |
874 | \r | |
875 | Ip4FreeArpQue (ArpQue, EFI_SUCCESS);\r | |
876 | }\r | |
877 | \r | |
5405e9a6 | 878 | /**\r |
879 | Request Ip4OnArpResolvedDpc as a DPC at TPL_CALLBACK.\r | |
880 | \r | |
3e8c18da | 881 | @param Event The Arp request event.\r |
882 | @param Context The context of the callback, a point to the ARP\r | |
883 | queue.\r | |
884 | \r | |
5405e9a6 | 885 | **/\r |
36ee91ca | 886 | VOID\r |
887 | EFIAPI\r | |
888 | Ip4OnArpResolved (\r | |
889 | IN EFI_EVENT Event,\r | |
890 | IN VOID *Context\r | |
891 | )\r | |
36ee91ca | 892 | {\r |
893 | //\r | |
894 | // Request Ip4OnArpResolvedDpc as a DPC at TPL_CALLBACK\r | |
895 | //\r | |
d8d26fb2 | 896 | QueueDpc (TPL_CALLBACK, Ip4OnArpResolvedDpc, Context);\r |
36ee91ca | 897 | }\r |
898 | \r | |
899 | \r | |
772db4bb | 900 | \r |
901 | /**\r | |
902 | Callback funtion when frame transmission is finished. It will\r | |
903 | call the frame owner's callback function to tell it the result.\r | |
904 | \r | |
3e8c18da | 905 | @param[in] Context Context which is point to the token.\r |
772db4bb | 906 | \r |
907 | **/\r | |
772db4bb | 908 | VOID\r |
909 | EFIAPI\r | |
36ee91ca | 910 | Ip4OnFrameSentDpc (\r |
772db4bb | 911 | IN VOID *Context\r |
912 | )\r | |
913 | {\r | |
914 | IP4_LINK_TX_TOKEN *Token;\r | |
915 | \r | |
916 | Token = (IP4_LINK_TX_TOKEN *) Context;\r | |
917 | NET_CHECK_SIGNATURE (Token, IP4_FRAME_TX_SIGNATURE);\r | |
918 | \r | |
e48e37fc | 919 | RemoveEntryList (&Token->Link);\r |
772db4bb | 920 | \r |
921 | Token->CallBack (\r | |
922 | Token->IpInstance,\r | |
923 | Token->Packet,\r | |
924 | Token->MnpToken.Status,\r | |
925 | 0,\r | |
926 | Token->Context\r | |
927 | );\r | |
928 | \r | |
929 | Ip4FreeLinkTxToken (Token);\r | |
930 | }\r | |
931 | \r | |
5405e9a6 | 932 | /**\r |
933 | Request Ip4OnFrameSentDpc as a DPC at TPL_CALLBACK.\r | |
934 | \r | |
3e8c18da | 935 | @param[in] Event The transmit token's event.\r |
936 | @param[in] Context Context which is point to the token.\r | |
5405e9a6 | 937 | \r |
938 | **/\r | |
36ee91ca | 939 | VOID\r |
940 | EFIAPI\r | |
941 | Ip4OnFrameSent (\r | |
942 | IN EFI_EVENT Event,\r | |
943 | IN VOID *Context\r | |
944 | )\r | |
36ee91ca | 945 | {\r |
946 | //\r | |
947 | // Request Ip4OnFrameSentDpc as a DPC at TPL_CALLBACK\r | |
948 | //\r | |
d8d26fb2 | 949 | QueueDpc (TPL_CALLBACK, Ip4OnFrameSentDpc, Context);\r |
36ee91ca | 950 | }\r |
951 | \r | |
772db4bb | 952 | \r |
953 | \r | |
954 | /**\r | |
955 | Send a frame from the interface. If the next hop is broadcast or\r | |
956 | multicast address, it is transmitted immediately. If the next hop\r | |
957 | is a unicast, it will consult ARP to resolve the NextHop's MAC.\r | |
958 | If some error happened, the CallBack won't be called. So, the caller\r | |
959 | must test the return value, and take action when there is an error.\r | |
960 | \r | |
3e8c18da | 961 | @param[in] Interface The interface to send the frame from\r |
962 | @param[in] IpInstance The IP child that request the transmission. NULL\r | |
772db4bb | 963 | if it is the IP4 driver itself.\r |
3e8c18da | 964 | @param[in] Packet The packet to transmit.\r |
965 | @param[in] NextHop The immediate destination to transmit the packet\r | |
772db4bb | 966 | to.\r |
3e8c18da | 967 | @param[in] CallBack Function to call back when transmit finished.\r |
968 | @param[in] Context Opaque parameter to the call back.\r | |
772db4bb | 969 | \r |
970 | @retval EFI_OUT_OF_RESOURCES Failed to allocate resource to send the frame\r | |
971 | @retval EFI_NO_MAPPING Can't resolve the MAC for the nexthop\r | |
972 | @retval EFI_SUCCESS The packet is successfully transmitted.\r | |
5405e9a6 | 973 | @retval other Other error occurs.\r |
772db4bb | 974 | \r |
975 | **/\r | |
976 | EFI_STATUS\r | |
977 | Ip4SendFrame (\r | |
978 | IN IP4_INTERFACE *Interface,\r | |
24af132f | 979 | IN IP4_PROTOCOL *IpInstance OPTIONAL,\r |
772db4bb | 980 | IN NET_BUF *Packet,\r |
981 | IN IP4_ADDR NextHop,\r | |
982 | IN IP4_FRAME_CALLBACK CallBack,\r | |
983 | IN VOID *Context\r | |
984 | )\r | |
985 | {\r | |
986 | IP4_LINK_TX_TOKEN *Token;\r | |
e48e37fc | 987 | LIST_ENTRY *Entry;\r |
772db4bb | 988 | IP4_ARP_QUE *ArpQue;\r |
989 | EFI_ARP_PROTOCOL *Arp;\r | |
990 | EFI_STATUS Status;\r | |
991 | \r | |
992 | ASSERT (Interface->Configured);\r | |
993 | \r | |
994 | Token = Ip4WrapLinkTxToken (Interface, IpInstance, Packet, CallBack, Context);\r | |
995 | \r | |
996 | if (Token == NULL) {\r | |
997 | return EFI_OUT_OF_RESOURCES;\r | |
998 | }\r | |
999 | \r | |
1000 | //\r | |
1001 | // Get the destination MAC address for multicast and broadcasts.\r | |
1002 | // Don't depend on ARP to solve the address since there maybe no\r | |
1003 | // ARP at all. Ip4Output has set NextHop to 255.255.255.255 for\r | |
1004 | // all the broadcasts.\r | |
1005 | //\r | |
1006 | if (NextHop == IP4_ALLONE_ADDRESS) {\r | |
687a2e5f | 1007 | CopyMem (&Token->DstMac, &Interface->BroadcastMac, sizeof (Token->DstMac));\r |
772db4bb | 1008 | goto SEND_NOW;\r |
1009 | \r | |
1010 | } else if (IP4_IS_MULTICAST (NextHop)) {\r | |
1011 | \r | |
1012 | Status = Ip4GetMulticastMac (Interface->Mnp, NextHop, &Token->DstMac);\r | |
1013 | \r | |
1014 | if (EFI_ERROR (Status)) {\r | |
1015 | goto ON_ERROR;\r | |
1016 | }\r | |
1017 | \r | |
1018 | goto SEND_NOW;\r | |
1019 | }\r | |
1020 | \r | |
1021 | //\r | |
1022 | // Can only send out multicast/broadcast if the IP address is zero\r | |
1023 | //\r | |
1024 | if ((Arp = Interface->Arp) == NULL) {\r | |
1025 | Status = EFI_NO_MAPPING;\r | |
1026 | goto ON_ERROR;\r | |
1027 | }\r | |
1028 | \r | |
1029 | //\r | |
1030 | // First check whether this binding is in the ARP cache.\r | |
1031 | //\r | |
1032 | NextHop = HTONL (NextHop);\r | |
1033 | Status = Arp->Request (Arp, &NextHop, NULL, &Token->DstMac);\r | |
1034 | \r | |
1035 | if (Status == EFI_SUCCESS) {\r | |
1036 | goto SEND_NOW;\r | |
1037 | \r | |
1038 | } else if (Status != EFI_NOT_READY) {\r | |
1039 | goto ON_ERROR;\r | |
1040 | }\r | |
1041 | \r | |
1042 | //\r | |
1043 | // Have to do asynchronous ARP resolution. First check\r | |
1044 | // whether there is already a pending request.\r | |
1045 | //\r | |
1046 | ArpQue = NULL;\r | |
1047 | \r | |
1048 | NET_LIST_FOR_EACH (Entry, &Interface->ArpQues) {\r | |
1049 | ArpQue = NET_LIST_USER_STRUCT (Entry, IP4_ARP_QUE, Link);\r | |
1050 | \r | |
1051 | if (ArpQue->Ip == NextHop) {\r | |
1052 | break;\r | |
1053 | }\r | |
1054 | }\r | |
1055 | \r | |
1056 | //\r | |
1057 | // Found a pending ARP request, enqueue the frame then return\r | |
1058 | //\r | |
1059 | if (Entry != &Interface->ArpQues) {\r | |
e48e37fc | 1060 | InsertTailList (&ArpQue->Frames, &Token->Link);\r |
772db4bb | 1061 | return EFI_SUCCESS;\r |
1062 | }\r | |
1063 | \r | |
1064 | //\r | |
1065 | // First frame to NextHop, issue an asynchronous ARP requests\r | |
1066 | //\r | |
1067 | ArpQue = Ip4CreateArpQue (Interface, NextHop);\r | |
1068 | \r | |
1069 | if (ArpQue == NULL) {\r | |
1070 | Status = EFI_OUT_OF_RESOURCES;\r | |
1071 | goto ON_ERROR;\r | |
1072 | }\r | |
1073 | \r | |
1074 | Status = Arp->Request (Arp, &ArpQue->Ip, ArpQue->OnResolved, ArpQue->Mac.Addr);\r | |
1075 | \r | |
1076 | if (EFI_ERROR (Status) && (Status != EFI_NOT_READY)) {\r | |
1077 | Ip4FreeArpQue (ArpQue, EFI_NO_MAPPING);\r | |
1078 | goto ON_ERROR;\r | |
1079 | }\r | |
1080 | \r | |
e48e37fc | 1081 | InsertHeadList (&ArpQue->Frames, &Token->Link);\r |
1082 | InsertHeadList (&Interface->ArpQues, &ArpQue->Link);\r | |
772db4bb | 1083 | return EFI_SUCCESS;\r |
1084 | \r | |
1085 | SEND_NOW:\r | |
36ee91ca | 1086 | //\r |
1087 | // Insert the tx token into the SentFrames list before calling Mnp->Transmit.\r | |
1088 | // Remove it if the returned status is not EFI_SUCCESS.\r | |
1089 | //\r | |
e48e37fc | 1090 | InsertTailList (&Interface->SentFrames, &Token->Link);\r |
772db4bb | 1091 | Status = Interface->Mnp->Transmit (Interface->Mnp, &Token->MnpToken);\r |
772db4bb | 1092 | if (EFI_ERROR (Status)) {\r |
e48e37fc | 1093 | RemoveEntryList (&Interface->SentFrames);\r |
772db4bb | 1094 | goto ON_ERROR;\r |
1095 | }\r | |
1096 | \r | |
772db4bb | 1097 | return EFI_SUCCESS;\r |
1098 | \r | |
1099 | ON_ERROR:\r | |
1100 | Ip4FreeLinkTxToken (Token);\r | |
1101 | return Status;\r | |
1102 | }\r | |
1103 | \r | |
1104 | \r | |
1105 | /**\r | |
1106 | Call back function when the received packet is freed.\r | |
1107 | Check Ip4OnFrameReceived for information.\r | |
1108 | \r | |
3e8c18da | 1109 | @param Context Context, which is the IP4_LINK_RX_TOKEN.\r |
772db4bb | 1110 | \r |
1111 | **/\r | |
772db4bb | 1112 | VOID\r |
e798cd87 | 1113 | EFIAPI\r |
772db4bb | 1114 | Ip4RecycleFrame (\r |
1115 | IN VOID *Context\r | |
1116 | )\r | |
1117 | {\r | |
1118 | IP4_LINK_RX_TOKEN *Frame;\r | |
1119 | \r | |
1120 | Frame = (IP4_LINK_RX_TOKEN *) Context;\r | |
1121 | NET_CHECK_SIGNATURE (Frame, IP4_FRAME_RX_SIGNATURE);\r | |
1122 | \r | |
1123 | gBS->SignalEvent (Frame->MnpToken.Packet.RxData->RecycleEvent);\r | |
1124 | Ip4FreeFrameRxToken (Frame);\r | |
1125 | }\r | |
1126 | \r | |
1127 | \r | |
1128 | /**\r | |
1129 | Received a frame from MNP, wrap it in net buffer then deliver\r | |
1130 | it to IP's input function. The ownship of the packet also\r | |
1131 | transferred to IP. When Ip is finished with this packet, it\r | |
1132 | will call NetbufFree to release the packet, NetbufFree will\r | |
1133 | again call the Ip4RecycleFrame to signal MNP's event and free\r | |
1134 | the token used.\r | |
1135 | \r | |
772db4bb | 1136 | @param Context Context for the callback.\r |
1137 | \r | |
772db4bb | 1138 | **/\r |
772db4bb | 1139 | VOID\r |
1140 | EFIAPI\r | |
36ee91ca | 1141 | Ip4OnFrameReceivedDpc (\r |
772db4bb | 1142 | IN VOID *Context\r |
1143 | )\r | |
1144 | {\r | |
1145 | EFI_MANAGED_NETWORK_COMPLETION_TOKEN *MnpToken;\r | |
1146 | EFI_MANAGED_NETWORK_RECEIVE_DATA *MnpRxData;\r | |
1147 | IP4_LINK_RX_TOKEN *Token;\r | |
1148 | NET_FRAGMENT Netfrag;\r | |
1149 | NET_BUF *Packet;\r | |
1150 | UINT32 Flag;\r | |
1151 | \r | |
1152 | Token = (IP4_LINK_RX_TOKEN *) Context;\r | |
1153 | NET_CHECK_SIGNATURE (Token, IP4_FRAME_RX_SIGNATURE);\r | |
1154 | \r | |
1155 | //\r | |
1156 | // First clear the interface's receive request in case the\r | |
1157 | // caller wants to call Ip4ReceiveFrame in the callback.\r | |
1158 | //\r | |
1159 | Token->Interface->RecvRequest = NULL;\r | |
1160 | \r | |
1161 | MnpToken = &Token->MnpToken;\r | |
1162 | MnpRxData = MnpToken->Packet.RxData;\r | |
1163 | \r | |
1164 | if (EFI_ERROR (MnpToken->Status) || (MnpRxData == NULL)) {\r | |
1165 | Token->CallBack (Token->IpInstance, NULL, MnpToken->Status, 0, Token->Context);\r | |
1166 | Ip4FreeFrameRxToken (Token);\r | |
1167 | \r | |
1168 | return ;\r | |
1169 | }\r | |
1170 | \r | |
1171 | //\r | |
1172 | // Wrap the frame in a net buffer then deliever it to IP input.\r | |
1173 | // IP will reassemble the packet, and deliver it to upper layer\r | |
1174 | //\r | |
1175 | Netfrag.Len = MnpRxData->DataLength;\r | |
1176 | Netfrag.Bulk = MnpRxData->PacketData;\r | |
1177 | \r | |
1178 | Packet = NetbufFromExt (&Netfrag, 1, 0, IP4_MAX_HEADLEN, Ip4RecycleFrame, Token);\r | |
1179 | \r | |
1180 | if (Packet == NULL) {\r | |
1181 | gBS->SignalEvent (MnpRxData->RecycleEvent);\r | |
1182 | \r | |
1183 | Token->CallBack (Token->IpInstance, NULL, EFI_OUT_OF_RESOURCES, 0, Token->Context);\r | |
1184 | Ip4FreeFrameRxToken (Token);\r | |
1185 | \r | |
1186 | return ;\r | |
1187 | }\r | |
1188 | \r | |
1189 | Flag = (MnpRxData->BroadcastFlag ? IP4_LINK_BROADCAST : 0);\r | |
1190 | Flag |= (MnpRxData->MulticastFlag ? IP4_LINK_MULTICAST : 0);\r | |
1191 | Flag |= (MnpRxData->PromiscuousFlag ? IP4_LINK_PROMISC : 0);\r | |
1192 | \r | |
1193 | Token->CallBack (Token->IpInstance, Packet, EFI_SUCCESS, Flag, Token->Context);\r | |
1194 | }\r | |
1195 | \r | |
2ff29212 | 1196 | /**\r |
2ff29212 | 1197 | Request Ip4OnFrameReceivedDpc as a DPC at TPL_CALLBACK.\r |
1198 | \r | |
1199 | @param Event The receive event delivered to MNP for receive.\r | |
1200 | @param Context Context for the callback.\r | |
2ff29212 | 1201 | \r |
1202 | **/\r | |
36ee91ca | 1203 | VOID\r |
1204 | EFIAPI\r | |
1205 | Ip4OnFrameReceived (\r | |
1206 | IN EFI_EVENT Event,\r | |
1207 | IN VOID *Context\r | |
1208 | )\r | |
36ee91ca | 1209 | {\r |
1210 | //\r | |
1211 | // Request Ip4OnFrameReceivedDpc as a DPC at TPL_CALLBACK\r | |
1212 | //\r | |
d8d26fb2 | 1213 | QueueDpc (TPL_CALLBACK, Ip4OnFrameReceivedDpc, Context);\r |
36ee91ca | 1214 | }\r |
1215 | \r | |
772db4bb | 1216 | \r |
1217 | /**\r | |
1218 | Request to receive the packet from the interface.\r | |
1219 | \r | |
1f6729ff | 1220 | @param[in] Interface The interface to receive the frames from.\r |
3e8c18da | 1221 | @param[in] IpInstance The instance that requests the receive. NULL for\r |
772db4bb | 1222 | the driver itself.\r |
3e8c18da | 1223 | @param[in] CallBack Function to call when receive finished.\r |
1f6729ff | 1224 | @param[in] Context Opaque parameter to the callback.\r |
772db4bb | 1225 | \r |
1226 | @retval EFI_ALREADY_STARTED There is already a pending receive request.\r | |
1f6729ff | 1227 | @retval EFI_OUT_OF_RESOURCES Failed to allocate resource to receive.\r |
772db4bb | 1228 | @retval EFI_SUCCESS The recieve request has been started.\r |
5405e9a6 | 1229 | @retval other Other error occurs.\r |
772db4bb | 1230 | \r |
1231 | **/\r | |
1232 | EFI_STATUS\r | |
1233 | Ip4ReceiveFrame (\r | |
1234 | IN IP4_INTERFACE *Interface,\r | |
24af132f | 1235 | IN IP4_PROTOCOL *IpInstance OPTIONAL,\r |
772db4bb | 1236 | IN IP4_FRAME_CALLBACK CallBack,\r |
1237 | IN VOID *Context\r | |
1238 | )\r | |
1239 | {\r | |
1240 | IP4_LINK_RX_TOKEN *Token;\r | |
1241 | EFI_STATUS Status;\r | |
1242 | \r | |
1243 | NET_CHECK_SIGNATURE (Interface, IP4_INTERFACE_SIGNATURE);\r | |
1244 | \r | |
1245 | if (Interface->RecvRequest != NULL) {\r | |
1246 | return EFI_ALREADY_STARTED;\r | |
1247 | }\r | |
1248 | \r | |
1249 | Token = Ip4CreateLinkRxToken (Interface, IpInstance, CallBack, Context);\r | |
1250 | \r | |
1251 | if (Token == NULL) {\r | |
1252 | return EFI_OUT_OF_RESOURCES;\r | |
1253 | }\r | |
1254 | \r | |
36ee91ca | 1255 | Interface->RecvRequest = Token;\r |
772db4bb | 1256 | Status = Interface->Mnp->Receive (Interface->Mnp, &Token->MnpToken);\r |
772db4bb | 1257 | if (EFI_ERROR (Status)) {\r |
36ee91ca | 1258 | Interface->RecvRequest = NULL;\r |
772db4bb | 1259 | Ip4FreeFrameRxToken (Token);\r |
1260 | return Status;\r | |
1261 | }\r | |
772db4bb | 1262 | return EFI_SUCCESS;\r |
1263 | }\r |