]>
Commit | Line | Data |
---|---|---|
cbf316f2 | 1 | /** @file\r |
2 | \r | |
3 | Copyright (c) 2006 - 2007, Intel Corporation\r | |
4 | All rights reserved. This program and the accompanying materials\r | |
5 | are licensed and made available under the terms and conditions of the BSD License\r | |
6 | which accompanies this distribution. The full text of the license may be found at\r | |
7 | http://opensource.org/licenses/bsd-license.php\r | |
8 | \r | |
9 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
10 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
11 | \r | |
12 | \r | |
13 | Module Name:\r | |
14 | \r | |
15 | Udp4Io.c\r | |
16 | \r | |
17 | Abstract:\r | |
18 | \r | |
19 | Help functions to access UDP service, it is used by both the DHCP and MTFTP.\r | |
20 | \r | |
21 | \r | |
22 | **/\r | |
23 | \r | |
24 | #include <PiDxe.h>\r | |
25 | \r | |
26 | #include <Protocol/Udp4.h>\r | |
27 | \r | |
28 | #include <Library/UdpIoLib.h>\r | |
29 | #include <Library/BaseLib.h>\r | |
30 | #include <Library/DebugLib.h>\r | |
31 | #include <Library/UefiBootServicesTableLib.h>\r | |
32 | #include <Library/MemoryAllocationLib.h>\r | |
33 | \r | |
34 | STATIC\r | |
35 | VOID\r | |
36 | EFIAPI\r | |
37 | UdpIoOnDgramSent (\r | |
38 | IN EFI_EVENT Event,\r | |
39 | IN VOID *Context\r | |
40 | );\r | |
41 | \r | |
42 | STATIC\r | |
43 | VOID\r | |
44 | EFIAPI\r | |
45 | UdpIoOnDgramRcvd (\r | |
46 | IN EFI_EVENT Event,\r | |
47 | IN VOID *Context\r | |
48 | );\r | |
49 | \r | |
50 | \r | |
51 | /**\r | |
52 | Wrap a transmit request into a UDP_TX_TOKEN.\r | |
53 | \r | |
54 | @param UdpIo The UdpIo port to send packet to\r | |
55 | @param Packet The user's packet\r | |
56 | @param EndPoint The local and remote access point\r | |
57 | @param Gateway The overrided next hop\r | |
58 | @param CallBack The function to call when transmission completed.\r | |
59 | @param Context The opaque parameter to the call back\r | |
60 | \r | |
61 | @return The wrapped transmission request or NULL if failed to allocate resources.\r | |
62 | \r | |
63 | **/\r | |
64 | STATIC\r | |
65 | UDP_TX_TOKEN *\r | |
66 | UdpIoWrapTx (\r | |
67 | IN UDP_IO_PORT *UdpIo,\r | |
68 | IN NET_BUF *Packet,\r | |
69 | IN UDP_POINTS *EndPoint, OPTIONAL\r | |
70 | IN IP4_ADDR Gateway,\r | |
71 | IN UDP_IO_CALLBACK CallBack,\r | |
72 | IN VOID *Context\r | |
73 | )\r | |
74 | {\r | |
75 | UDP_TX_TOKEN *Token;\r | |
76 | EFI_UDP4_COMPLETION_TOKEN *UdpToken;\r | |
77 | EFI_UDP4_TRANSMIT_DATA *UdpTxData;\r | |
78 | EFI_STATUS Status;\r | |
79 | UINT32 Count;\r | |
80 | \r | |
81 | Token = NetAllocatePool (sizeof (UDP_TX_TOKEN) +\r | |
82 | sizeof (EFI_UDP4_FRAGMENT_DATA) * (Packet->BlockOpNum - 1));\r | |
83 | \r | |
84 | if (Token == NULL) {\r | |
85 | return NULL;\r | |
86 | }\r | |
87 | \r | |
88 | Token->Signature = UDP_IO_TX_SIGNATURE;\r | |
89 | NetListInit (&Token->Link);\r | |
90 | \r | |
91 | Token->UdpIo = UdpIo;\r | |
92 | Token->CallBack = CallBack;\r | |
93 | Token->Packet = Packet;\r | |
94 | Token->Context = Context;\r | |
95 | \r | |
96 | UdpToken = &(Token->UdpToken);\r | |
97 | UdpToken->Status = EFI_NOT_READY;\r | |
98 | \r | |
99 | Status = gBS->CreateEvent (\r | |
100 | EVT_NOTIFY_SIGNAL,\r | |
101 | TPL_CALLBACK,\r | |
102 | UdpIoOnDgramSent,\r | |
103 | Token,\r | |
104 | &UdpToken->Event\r | |
105 | );\r | |
106 | \r | |
107 | if (EFI_ERROR (Status)) {\r | |
108 | NetFreePool (Token);\r | |
109 | return NULL;\r | |
110 | }\r | |
111 | \r | |
112 | UdpTxData = &Token->UdpTxData;\r | |
113 | UdpToken->Packet.TxData = UdpTxData;\r | |
114 | \r | |
115 | UdpTxData->UdpSessionData = NULL;\r | |
116 | UdpTxData->GatewayAddress = NULL;\r | |
117 | \r | |
118 | if (EndPoint != NULL) {\r | |
119 | EFI_IP4 (Token->UdpSession.SourceAddress) = HTONL (EndPoint->LocalAddr);\r | |
120 | EFI_IP4 (Token->UdpSession.DestinationAddress) = HTONL (EndPoint->RemoteAddr);\r | |
121 | Token->UdpSession.SourcePort = EndPoint->LocalPort;\r | |
122 | Token->UdpSession.DestinationPort = EndPoint->RemotePort;\r | |
123 | UdpTxData->UdpSessionData = &Token->UdpSession;\r | |
124 | }\r | |
125 | \r | |
126 | if (Gateway != 0) {\r | |
127 | EFI_IP4 (Token->Gateway) = HTONL (Gateway);\r | |
128 | UdpTxData->GatewayAddress = &Token->Gateway;\r | |
129 | }\r | |
130 | \r | |
131 | UdpTxData->DataLength = Packet->TotalSize;\r | |
132 | Count = Packet->BlockOpNum;\r | |
133 | NetbufBuildExt (Packet, (NET_FRAGMENT *) UdpTxData->FragmentTable, &Count);\r | |
134 | UdpTxData->FragmentCount = Count;\r | |
135 | \r | |
136 | return Token;\r | |
137 | }\r | |
138 | \r | |
139 | \r | |
140 | /**\r | |
141 | Free a UDP_TX_TOKEN. The event is closed and memory released.\r | |
142 | \r | |
143 | @param Token The UDP_TX_TOKEN to release.\r | |
144 | \r | |
145 | @return None\r | |
146 | \r | |
147 | **/\r | |
148 | VOID\r | |
149 | UdpIoFreeTxToken (\r | |
150 | IN UDP_TX_TOKEN *Token\r | |
151 | )\r | |
152 | {\r | |
153 | gBS->CloseEvent (Token->UdpToken.Event);\r | |
154 | NetFreePool (Token);\r | |
155 | }\r | |
156 | \r | |
157 | \r | |
158 | /**\r | |
159 | Create a UDP_RX_TOKEN to wrap the request.\r | |
160 | \r | |
161 | @param UdpIo The UdpIo to receive packets from\r | |
162 | @param CallBack The function to call when receive finished.\r | |
163 | @param Context The opaque parameter to the CallBack\r | |
164 | @param HeadLen The head length to reserver for the packet.\r | |
165 | \r | |
166 | @return The Wrapped request or NULL if failed to allocate resources.\r | |
167 | \r | |
168 | **/\r | |
169 | UDP_RX_TOKEN *\r | |
170 | UdpIoCreateRxToken (\r | |
171 | IN UDP_IO_PORT *UdpIo,\r | |
172 | IN UDP_IO_CALLBACK CallBack,\r | |
173 | IN VOID *Context,\r | |
174 | IN UINT32 HeadLen\r | |
175 | )\r | |
176 | {\r | |
177 | UDP_RX_TOKEN *Token;\r | |
178 | EFI_STATUS Status;\r | |
179 | \r | |
180 | Token = NetAllocatePool (sizeof (UDP_RX_TOKEN));\r | |
181 | \r | |
182 | if (Token == NULL) {\r | |
183 | return NULL;\r | |
184 | }\r | |
185 | \r | |
186 | Token->Signature = UDP_IO_RX_SIGNATURE;\r | |
187 | Token->UdpIo = UdpIo;\r | |
188 | Token->CallBack = CallBack;\r | |
189 | Token->Context = Context;\r | |
190 | Token->HeadLen = HeadLen;\r | |
191 | \r | |
192 | Token->UdpToken.Status = EFI_NOT_READY;\r | |
193 | Token->UdpToken.Packet.RxData = NULL;\r | |
194 | \r | |
195 | Status = gBS->CreateEvent (\r | |
196 | EVT_NOTIFY_SIGNAL,\r | |
197 | TPL_CALLBACK,\r | |
198 | UdpIoOnDgramRcvd,\r | |
199 | Token,\r | |
200 | &Token->UdpToken.Event\r | |
201 | );\r | |
202 | \r | |
203 | if (EFI_ERROR (Status)) {\r | |
204 | NetFreePool (Token);\r | |
205 | return NULL;\r | |
206 | }\r | |
207 | \r | |
208 | return Token;\r | |
209 | }\r | |
210 | \r | |
211 | \r | |
212 | /**\r | |
213 | Free a receive request wrap.\r | |
214 | \r | |
215 | @param Token The receive request to release.\r | |
216 | \r | |
217 | @return None\r | |
218 | \r | |
219 | **/\r | |
220 | VOID\r | |
221 | UdpIoFreeRxToken (\r | |
222 | IN UDP_RX_TOKEN *Token\r | |
223 | )\r | |
224 | {\r | |
225 | gBS->CloseEvent (Token->UdpToken.Event);\r | |
226 | NetFreePool (Token);\r | |
227 | }\r | |
228 | \r | |
229 | \r | |
230 | /**\r | |
231 | Create a UDP IO port to access the UDP service. It will\r | |
232 | create and configure a UDP child.\r | |
233 | \r | |
234 | @param Controller The controller that has the UDP service binding\r | |
235 | protocol installed.\r | |
236 | @param Image The image handle for the driver.\r | |
237 | @param Configure The function to configure the created UDP child\r | |
238 | @param Context The opaque parameter for the Configure funtion.\r | |
239 | \r | |
240 | @return A point to just created UDP IO port or NULL if failed.\r | |
241 | \r | |
242 | **/\r | |
243 | UDP_IO_PORT *\r | |
244 | UdpIoCreatePort (\r | |
245 | IN EFI_HANDLE Controller,\r | |
246 | IN EFI_HANDLE Image,\r | |
247 | IN UDP_IO_CONFIG Configure,\r | |
248 | IN VOID *Context\r | |
249 | )\r | |
250 | {\r | |
251 | UDP_IO_PORT *UdpIo;\r | |
252 | EFI_STATUS Status;\r | |
253 | \r | |
254 | ASSERT (Configure != NULL);\r | |
255 | \r | |
256 | UdpIo = NetAllocatePool (sizeof (UDP_IO_PORT));\r | |
257 | \r | |
258 | if (UdpIo == NULL) {\r | |
259 | return NULL;\r | |
260 | }\r | |
261 | \r | |
262 | UdpIo->Signature = UDP_IO_SIGNATURE;\r | |
263 | NetListInit (&UdpIo->Link);\r | |
264 | UdpIo->RefCnt = 1;\r | |
265 | \r | |
266 | UdpIo->Controller = Controller;\r | |
267 | UdpIo->Image = Image;\r | |
268 | \r | |
269 | NetListInit (&UdpIo->SentDatagram);\r | |
270 | UdpIo->RecvRequest = NULL;\r | |
271 | UdpIo->UdpHandle = NULL;\r | |
272 | \r | |
273 | //\r | |
274 | // Create a UDP child then open and configure it\r | |
275 | //\r | |
276 | Status = NetLibCreateServiceChild (\r | |
277 | Controller,\r | |
278 | Image,\r | |
279 | &gEfiUdp4ServiceBindingProtocolGuid,\r | |
280 | &UdpIo->UdpHandle\r | |
281 | );\r | |
282 | \r | |
283 | if (EFI_ERROR (Status)) {\r | |
284 | goto FREE_MEM;\r | |
285 | }\r | |
286 | \r | |
287 | Status = gBS->OpenProtocol (\r | |
288 | UdpIo->UdpHandle,\r | |
289 | &gEfiUdp4ProtocolGuid,\r | |
290 | &UdpIo->Udp,\r | |
291 | Image,\r | |
292 | Controller,\r | |
293 | EFI_OPEN_PROTOCOL_BY_DRIVER\r | |
294 | );\r | |
295 | \r | |
296 | if (EFI_ERROR (Status)) {\r | |
297 | goto FREE_CHILD;\r | |
298 | }\r | |
299 | \r | |
300 | if (EFI_ERROR (Configure (UdpIo, Context))) {\r | |
301 | goto CLOSE_PROTOCOL;\r | |
302 | }\r | |
303 | \r | |
304 | Status = UdpIo->Udp->GetModeData (UdpIo->Udp, NULL, NULL, NULL, &UdpIo->SnpMode);\r | |
305 | \r | |
306 | if (EFI_ERROR (Status)) {\r | |
307 | goto CLOSE_PROTOCOL;\r | |
308 | }\r | |
309 | \r | |
310 | return UdpIo;\r | |
311 | \r | |
312 | CLOSE_PROTOCOL:\r | |
313 | gBS->CloseProtocol (UdpIo->UdpHandle, &gEfiUdp4ProtocolGuid, Image, Controller);\r | |
314 | \r | |
315 | FREE_CHILD:\r | |
316 | NetLibDestroyServiceChild (\r | |
317 | Controller,\r | |
318 | Image,\r | |
319 | &gEfiUdp4ServiceBindingProtocolGuid,\r | |
320 | UdpIo->UdpHandle\r | |
321 | );\r | |
322 | \r | |
323 | FREE_MEM:\r | |
324 | NetFreePool (UdpIo);\r | |
325 | return NULL;\r | |
326 | }\r | |
327 | \r | |
328 | \r | |
329 | /**\r | |
330 | Cancel all the sent datagram that pass the selection of ToCancel.\r | |
331 | If ToCancel is NULL, all the datagrams are cancelled.\r | |
332 | \r | |
333 | @param UdpIo The UDP IO port to cancel packet\r | |
334 | @param IoStatus The IoStatus to return to the packet owners.\r | |
335 | @param ToCancel The select funtion to test whether to cancel this\r | |
336 | packet or not.\r | |
337 | @param Context The opaque parameter to the ToCancel.\r | |
338 | \r | |
339 | @return None\r | |
340 | \r | |
341 | **/\r | |
342 | STATIC\r | |
343 | VOID\r | |
344 | UdpIoCancelDgrams (\r | |
345 | IN UDP_IO_PORT *UdpIo,\r | |
346 | IN EFI_STATUS IoStatus,\r | |
347 | IN UDP_IO_TO_CANCEL ToCancel, OPTIONAL\r | |
348 | IN VOID *Context\r | |
349 | )\r | |
350 | {\r | |
351 | NET_LIST_ENTRY *Entry;\r | |
352 | NET_LIST_ENTRY *Next;\r | |
353 | UDP_TX_TOKEN *Token;\r | |
354 | \r | |
355 | NET_LIST_FOR_EACH_SAFE (Entry, Next, &UdpIo->SentDatagram) {\r | |
356 | Token = NET_LIST_USER_STRUCT (Entry, UDP_TX_TOKEN, Link);\r | |
357 | \r | |
358 | if ((ToCancel == NULL) || (ToCancel (Token, Context))) {\r | |
359 | NetListRemoveEntry (Entry);\r | |
360 | UdpIo->Udp->Cancel (UdpIo->Udp, &Token->UdpToken);\r | |
361 | Token->CallBack (Token->Packet, NULL, IoStatus, Token->Context);\r | |
362 | UdpIoFreeTxToken (Token);\r | |
363 | }\r | |
364 | }\r | |
365 | }\r | |
366 | \r | |
367 | \r | |
368 | /**\r | |
369 | Free the UDP IO port and all its related resources including\r | |
370 | all the transmitted packet.\r | |
371 | \r | |
372 | @param UdpIo The UDP IO port to free.\r | |
373 | \r | |
374 | @retval EFI_SUCCESS The UDP IO port is freed.\r | |
375 | \r | |
376 | **/\r | |
377 | EFI_STATUS\r | |
378 | UdpIoFreePort (\r | |
379 | IN UDP_IO_PORT *UdpIo\r | |
380 | )\r | |
381 | {\r | |
382 | UDP_RX_TOKEN *RxToken;\r | |
383 | \r | |
384 | //\r | |
385 | // Cancel all the sent datagram and receive requests. The\r | |
386 | // callbacks of transmit requests are executed to allow the\r | |
387 | // caller to release the resource. The callback of receive\r | |
388 | // request are NOT executed. This is because it is most\r | |
389 | // likely that the current user of the UDP IO port is closing\r | |
390 | // itself.\r | |
391 | //\r | |
392 | UdpIoCancelDgrams (UdpIo, EFI_ABORTED, NULL, NULL);\r | |
393 | \r | |
394 | if ((RxToken = UdpIo->RecvRequest) != NULL) {\r | |
395 | UdpIo->RecvRequest = NULL;\r | |
396 | UdpIo->Udp->Cancel (UdpIo->Udp, &RxToken->UdpToken);\r | |
397 | UdpIoFreeRxToken (RxToken);\r | |
398 | }\r | |
399 | \r | |
400 | //\r | |
401 | // Close then destory the UDP child\r | |
402 | //\r | |
403 | gBS->CloseProtocol (\r | |
404 | UdpIo->UdpHandle,\r | |
405 | &gEfiUdp4ProtocolGuid,\r | |
406 | UdpIo->Image,\r | |
407 | UdpIo->Controller\r | |
408 | );\r | |
409 | \r | |
410 | NetLibDestroyServiceChild (\r | |
411 | UdpIo->Controller,\r | |
412 | UdpIo->Image,\r | |
413 | &gEfiUdp4ServiceBindingProtocolGuid,\r | |
414 | UdpIo->UdpHandle\r | |
415 | );\r | |
416 | \r | |
417 | NetListRemoveEntry (&UdpIo->Link);\r | |
418 | NetFreePool (UdpIo);\r | |
419 | return EFI_SUCCESS;\r | |
420 | }\r | |
421 | \r | |
422 | \r | |
423 | /**\r | |
424 | Clean up the UDP IO port. It will release all the transmitted\r | |
425 | datagrams and receive request. It will also configure NULL the\r | |
426 | UDP child.\r | |
427 | \r | |
428 | @param UdpIo UDP IO port to clean up.\r | |
429 | \r | |
430 | @return None\r | |
431 | \r | |
432 | **/\r | |
433 | VOID\r | |
434 | UdpIoCleanPort (\r | |
435 | IN UDP_IO_PORT *UdpIo\r | |
436 | )\r | |
437 | {\r | |
438 | UDP_RX_TOKEN *RxToken;\r | |
439 | \r | |
440 | //\r | |
441 | // Cancel all the sent datagram and receive requests.\r | |
442 | //\r | |
443 | UdpIoCancelDgrams (UdpIo, EFI_ABORTED, NULL, NULL);\r | |
444 | \r | |
445 | if ((RxToken = UdpIo->RecvRequest) != NULL) {\r | |
446 | UdpIo->RecvRequest = NULL;\r | |
447 | UdpIo->Udp->Cancel (UdpIo->Udp, &RxToken->UdpToken);\r | |
448 | UdpIoFreeRxToken (RxToken);\r | |
449 | }\r | |
450 | \r | |
451 | UdpIo->Udp->Configure (UdpIo->Udp, NULL);\r | |
452 | }\r | |
453 | \r | |
454 | \r | |
455 | /**\r | |
456 | The callback function when the packet is sent by UDP.\r | |
457 | It will remove the packet from the local list then call\r | |
458 | the packet owner's callback function.\r | |
459 | \r | |
460 | @param Event The event signalled.\r | |
461 | @param Context The UDP TX Token.\r | |
462 | \r | |
463 | @return None\r | |
464 | \r | |
465 | **/\r | |
466 | STATIC\r | |
467 | VOID\r | |
468 | EFIAPI\r | |
469 | UdpIoOnDgramSent (\r | |
470 | IN EFI_EVENT Event,\r | |
471 | IN VOID *Context\r | |
472 | )\r | |
473 | {\r | |
474 | UDP_TX_TOKEN *Token;\r | |
475 | \r | |
476 | Token = (UDP_TX_TOKEN *) Context;\r | |
477 | ASSERT (Token->Signature == UDP_IO_TX_SIGNATURE);\r | |
478 | \r | |
479 | NetListRemoveEntry (&Token->Link);\r | |
480 | Token->CallBack (Token->Packet, NULL, Token->UdpToken.Status, Token->Context);\r | |
481 | \r | |
482 | UdpIoFreeTxToken (Token);\r | |
483 | }\r | |
484 | \r | |
485 | \r | |
486 | /**\r | |
487 | Send a packet through the UDP IO port.\r | |
488 | \r | |
489 | @param UdpIo The UDP IO Port to send the packet through\r | |
490 | @param Packet The packet to send\r | |
491 | @param EndPoint The local and remote access point\r | |
492 | @param Gateway The gateway to use\r | |
493 | @param CallBack The call back function to call when packet is\r | |
494 | transmitted or failed.\r | |
495 | @param Context The opque parameter to the CallBack\r | |
496 | \r | |
497 | @retval EFI_OUT_OF_RESOURCES Failed to allocate resource for the packet\r | |
498 | @retval EFI_SUCCESS The packet is successfully delivered to UDP for\r | |
499 | transmission.\r | |
500 | \r | |
501 | **/\r | |
502 | EFI_STATUS\r | |
503 | UdpIoSendDatagram (\r | |
504 | IN UDP_IO_PORT *UdpIo,\r | |
505 | IN NET_BUF *Packet,\r | |
506 | IN UDP_POINTS *EndPoint, OPTIONAL\r | |
507 | IN IP4_ADDR Gateway,\r | |
508 | IN UDP_IO_CALLBACK CallBack,\r | |
509 | IN VOID *Context\r | |
510 | )\r | |
511 | {\r | |
512 | UDP_TX_TOKEN *Token;\r | |
513 | EFI_STATUS Status;\r | |
514 | \r | |
515 | Token = UdpIoWrapTx (UdpIo, Packet, EndPoint, Gateway, CallBack, Context);\r | |
516 | \r | |
517 | if (Token == NULL) {\r | |
518 | return EFI_OUT_OF_RESOURCES;\r | |
519 | }\r | |
520 | \r | |
521 | Status = UdpIo->Udp->Transmit (UdpIo->Udp, &Token->UdpToken);\r | |
522 | \r | |
523 | if (EFI_ERROR (Status)) {\r | |
524 | UdpIoFreeTxToken (Token);\r | |
525 | return Status;\r | |
526 | }\r | |
527 | \r | |
528 | NetListInsertHead (&UdpIo->SentDatagram, &Token->Link);\r | |
529 | return EFI_SUCCESS;\r | |
530 | }\r | |
531 | \r | |
532 | \r | |
533 | /**\r | |
534 | The selection function to cancel a single sent datagram.\r | |
535 | \r | |
536 | @param Token The UDP TX token to test againist.\r | |
537 | @param Context The context\r | |
538 | \r | |
539 | @return TRUE if the packet is to be cancelled, otherwise FALSE.\r | |
540 | \r | |
541 | **/\r | |
542 | STATIC\r | |
543 | BOOLEAN\r | |
544 | UdpIoCancelSingleDgram (\r | |
545 | IN UDP_TX_TOKEN *Token,\r | |
546 | IN VOID *Context\r | |
547 | )\r | |
548 | {\r | |
549 | NET_BUF *Packet;\r | |
550 | \r | |
551 | Packet = (NET_BUF *) Context;\r | |
552 | \r | |
553 | if (Token->Packet == Packet) {\r | |
554 | return TRUE;\r | |
555 | }\r | |
556 | \r | |
557 | return FALSE;\r | |
558 | }\r | |
559 | \r | |
560 | \r | |
561 | /**\r | |
562 | Cancel a single sent datagram.\r | |
563 | \r | |
564 | @param UdpIo The UDP IO port to cancel the packet from\r | |
565 | @param Packet The packet to cancel\r | |
566 | \r | |
567 | @return None\r | |
568 | \r | |
569 | **/\r | |
570 | VOID\r | |
571 | UdpIoCancelSentDatagram (\r | |
572 | IN UDP_IO_PORT *UdpIo,\r | |
573 | IN NET_BUF *Packet\r | |
574 | )\r | |
575 | {\r | |
576 | UdpIoCancelDgrams (UdpIo, EFI_ABORTED, UdpIoCancelSingleDgram, Packet);\r | |
577 | }\r | |
578 | \r | |
579 | \r | |
580 | /**\r | |
581 | Recycle the received UDP data.\r | |
582 | \r | |
583 | @param Context The UDP_RX_TOKEN\r | |
584 | \r | |
585 | @return None\r | |
586 | \r | |
587 | **/\r | |
588 | STATIC\r | |
589 | VOID\r | |
590 | UdpIoRecycleDgram (\r | |
591 | IN VOID *Context\r | |
592 | )\r | |
593 | {\r | |
594 | UDP_RX_TOKEN *Token;\r | |
595 | \r | |
596 | Token = (UDP_RX_TOKEN *) Context;\r | |
597 | gBS->SignalEvent (Token->UdpToken.Packet.RxData->RecycleSignal);\r | |
598 | UdpIoFreeRxToken (Token);\r | |
599 | }\r | |
600 | \r | |
601 | \r | |
602 | /**\r | |
603 | The event handle for UDP receive request. It will build\r | |
604 | a NET_BUF from the recieved UDP data, then deliver it\r | |
605 | to the receiver.\r | |
606 | \r | |
607 | @param Event The UDP receive request event\r | |
608 | @param Context The UDP RX token.\r | |
609 | \r | |
610 | @return None\r | |
611 | \r | |
612 | **/\r | |
613 | STATIC\r | |
614 | VOID\r | |
615 | EFIAPI\r | |
616 | UdpIoOnDgramRcvd (\r | |
617 | IN EFI_EVENT Event,\r | |
618 | IN VOID *Context\r | |
619 | )\r | |
620 | {\r | |
621 | EFI_UDP4_COMPLETION_TOKEN *UdpToken;\r | |
622 | EFI_UDP4_RECEIVE_DATA *UdpRxData;\r | |
623 | EFI_UDP4_SESSION_DATA *UdpSession;\r | |
624 | UDP_RX_TOKEN *Token;\r | |
625 | UDP_POINTS Points;\r | |
626 | NET_BUF *Netbuf;\r | |
627 | \r | |
628 | Token = (UDP_RX_TOKEN *) Context;\r | |
629 | \r | |
630 | ASSERT ((Token->Signature == UDP_IO_RX_SIGNATURE) &&\r | |
631 | (Token == Token->UdpIo->RecvRequest));\r | |
632 | \r | |
633 | //\r | |
634 | // Clear the receive request first in case that the caller\r | |
635 | // wants to restart the receive in the callback.\r | |
636 | //\r | |
637 | Token->UdpIo->RecvRequest = NULL;\r | |
638 | \r | |
639 | UdpToken = &Token->UdpToken;\r | |
640 | UdpRxData = UdpToken->Packet.RxData;\r | |
641 | \r | |
642 | if (EFI_ERROR (UdpToken->Status) || (UdpRxData == NULL)) {\r | |
643 | Token->CallBack (NULL, NULL, UdpToken->Status, Token->Context);\r | |
644 | UdpIoFreeRxToken (Token);\r | |
645 | \r | |
646 | goto ON_EXIT;\r | |
647 | }\r | |
648 | \r | |
649 | //\r | |
650 | // Build a NET_BUF from the UDP receive data, then deliver it up.\r | |
651 | //\r | |
652 | Netbuf = NetbufFromExt (\r | |
653 | (NET_FRAGMENT *) UdpRxData->FragmentTable,\r | |
654 | UdpRxData->FragmentCount,\r | |
655 | 0,\r | |
656 | (UINT32) Token->HeadLen,\r | |
657 | UdpIoRecycleDgram,\r | |
658 | Token\r | |
659 | );\r | |
660 | \r | |
661 | if (Netbuf == NULL) {\r | |
662 | gBS->SignalEvent (UdpRxData->RecycleSignal);\r | |
663 | Token->CallBack (NULL, NULL, EFI_OUT_OF_RESOURCES, Token->Context);\r | |
664 | \r | |
665 | UdpIoFreeRxToken (Token);\r | |
666 | goto ON_EXIT;\r | |
667 | }\r | |
668 | \r | |
669 | UdpSession = &UdpRxData->UdpSession;\r | |
670 | Points.LocalAddr = EFI_NTOHL (UdpSession->DestinationAddress);\r | |
671 | Points.LocalPort = UdpSession->DestinationPort;\r | |
672 | Points.RemoteAddr = EFI_NTOHL (UdpSession->SourceAddress);\r | |
673 | Points.RemotePort = UdpSession->SourcePort;\r | |
674 | \r | |
675 | Token->CallBack (Netbuf, &Points, EFI_SUCCESS, Token->Context);\r | |
676 | \r | |
677 | ON_EXIT:\r | |
678 | return;\r | |
679 | }\r | |
680 | \r | |
681 | \r | |
682 | /**\r | |
683 | Issue a receive request to the UDP IO port.\r | |
684 | \r | |
685 | @param UdpIo The UDP IO port to recieve the packet from.\r | |
686 | @param CallBack The call back function to execute when receive\r | |
687 | finished.\r | |
688 | @param Context The opque context to the call back\r | |
689 | @param HeadLen The lenght of the application's header\r | |
690 | \r | |
691 | @retval EFI_ALREADY_STARTED There is already a pending receive request. Only\r | |
692 | one receive request is supported.\r | |
693 | @retval EFI_OUT_OF_RESOURCES Failed to allocate some resource.\r | |
694 | @retval EFI_SUCCESS The receive request is issued successfully.\r | |
695 | \r | |
696 | **/\r | |
697 | EFI_STATUS\r | |
698 | UdpIoRecvDatagram (\r | |
699 | IN UDP_IO_PORT *UdpIo,\r | |
700 | IN UDP_IO_CALLBACK CallBack,\r | |
701 | IN VOID *Context,\r | |
702 | IN UINT32 HeadLen\r | |
703 | )\r | |
704 | {\r | |
705 | UDP_RX_TOKEN *Token;\r | |
706 | EFI_STATUS Status;\r | |
707 | \r | |
708 | if (UdpIo->RecvRequest != NULL) {\r | |
709 | return EFI_ALREADY_STARTED;\r | |
710 | }\r | |
711 | \r | |
712 | Token = UdpIoCreateRxToken (UdpIo, CallBack, Context, HeadLen);\r | |
713 | \r | |
714 | if (Token == NULL) {\r | |
715 | return EFI_OUT_OF_RESOURCES;\r | |
716 | }\r | |
717 | \r | |
718 | Status = UdpIo->Udp->Receive (UdpIo->Udp, &Token->UdpToken);\r | |
719 | \r | |
720 | if (EFI_ERROR (Status)) {\r | |
721 | UdpIoFreeRxToken (Token);\r | |
722 | return Status;\r | |
723 | }\r | |
724 | \r | |
725 | UdpIo->RecvRequest = Token;\r | |
726 | return EFI_SUCCESS;\r | |
727 | }\r |