]> git.proxmox.com Git - mirror_edk2.git/blame_incremental - StdLib/EfiSocketLib/Udp4.c
projects / mirror_edk2.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
NetworkPkg: Remove IpSecDxe and Ip4Config Protocol dependency.
[mirror_edk2.git] / StdLib / EfiSocketLib / Udp4.c
... / ...
CommitLineData
1/** @file\r
2 Implement the UDP4 driver support for the socket layer.\r
3\r
4 Copyright (c) 2011, Intel Corporation\r
5 All rights reserved. This program and the accompanying materials\r
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
13**/\r
14\r
15#include "Socket.h"\r
16\r
17\r
18/**\r
19 Get the local socket address\r
20\r
21 This routine returns the IPv4 address and UDP port number associated\r
22 with the local socket.\r
23\r
24 This routine is called by ::EslSocketGetLocalAddress to determine the\r
25 network address for the SOCK_DGRAM socket.\r
26\r
27 @param [in] pPort Address of an ::ESL_PORT structure.\r
28\r
29 @param [out] pSockAddr Network address to receive the local system address\r
30\r
31**/\r
32VOID\r
33EslUdp4LocalAddressGet (\r
34 IN ESL_PORT * pPort,\r
35 OUT struct sockaddr * pSockAddr\r
36 )\r
37{\r
38 struct sockaddr_in * pLocalAddress;\r
39 ESL_UDP4_CONTEXT * pUdp4;\r
40\r
41 DBG_ENTER ( );\r
42\r
43 //\r
44 // Return the local address\r
45 //\r
46 pUdp4 = &pPort->Context.Udp4;\r
47 pLocalAddress = (struct sockaddr_in *)pSockAddr;\r
48 pLocalAddress->sin_family = AF_INET;\r
49 pLocalAddress->sin_port = SwapBytes16 ( pUdp4->ConfigData.StationPort );\r
50 CopyMem ( &pLocalAddress->sin_addr,\r
51 &pUdp4->ConfigData.StationAddress.Addr[0],\r
52 sizeof ( pLocalAddress->sin_addr ));\r
53\r
54 DBG_EXIT ( );\r
55}\r
56\r
57\r
58/**\r
59 Set the local port address.\r
60\r
61 This routine sets the local port address.\r
62\r
63 This support routine is called by ::EslSocketPortAllocate.\r
64\r
65 @param [in] pPort Address of an ESL_PORT structure\r
66 @param [in] pSockAddr Address of a sockaddr structure that contains the\r
67 connection point on the local machine. An IPv4 address\r
68 of INADDR_ANY specifies that the connection is made to\r
69 all of the network stacks on the platform. Specifying a\r
70 specific IPv4 address restricts the connection to the\r
71 network stack supporting that address. Specifying zero\r
72 for the port causes the network layer to assign a port\r
73 number from the dynamic range. Specifying a specific\r
74 port number causes the network layer to use that port.\r
75\r
76 @param [in] bBindTest TRUE = run bind testing\r
77\r
78 @retval EFI_SUCCESS The operation was successful\r
79\r
80 **/\r
81EFI_STATUS\r
82EslUdp4LocalAddressSet (\r
83 IN ESL_PORT * pPort,\r
84 IN CONST struct sockaddr * pSockAddr,\r
85 IN BOOLEAN bBindTest\r
86 )\r
87{\r
88 EFI_UDP4_CONFIG_DATA * pConfig;\r
89 CONST struct sockaddr_in * pIpAddress;\r
90 CONST UINT8 * pIpv4Address;\r
91 EFI_STATUS Status;\r
92\r
93 DBG_ENTER ( );\r
94\r
95 //\r
96 // Validate the address\r
97 //\r
98 pIpAddress = (struct sockaddr_in *)pSockAddr;\r
99 if ( INADDR_BROADCAST == pIpAddress->sin_addr.s_addr ) {\r
100 //\r
101 // The local address must not be the broadcast address\r
102 //\r
103 Status = EFI_INVALID_PARAMETER;\r
104 pPort->pSocket->errno = EADDRNOTAVAIL;\r
105 }\r
106 else {\r
107 //\r
108 // Set the local address\r
109 //\r
110 pIpAddress = (struct sockaddr_in *)pSockAddr;\r
111 pIpv4Address = (UINT8 *)&pIpAddress->sin_addr.s_addr;\r
112 pConfig = &pPort->Context.Udp4.ConfigData;\r
113 pConfig->StationAddress.Addr[0] = pIpv4Address[0];\r
114 pConfig->StationAddress.Addr[1] = pIpv4Address[1];\r
115 pConfig->StationAddress.Addr[2] = pIpv4Address[2];\r
116 pConfig->StationAddress.Addr[3] = pIpv4Address[3];\r
117\r
118 //\r
119 // Determine if the default address is used\r
120 //\r
121 pConfig->UseDefaultAddress = (BOOLEAN)( 0 == pIpAddress->sin_addr.s_addr );\r
122 \r
123 //\r
124 // Set the subnet mask\r
125 //\r
126 if ( pConfig->UseDefaultAddress ) {\r
127 pConfig->SubnetMask.Addr[0] = 0;\r
128 pConfig->SubnetMask.Addr[1] = 0;\r
129 pConfig->SubnetMask.Addr[2] = 0;\r
130 pConfig->SubnetMask.Addr[3] = 0;\r
131 }\r
132 else {\r
133 pConfig->SubnetMask.Addr[0] = 0xff;\r
134 pConfig->SubnetMask.Addr[1] = ( 128 <= pConfig->StationAddress.Addr[0]) ? 0xff : 0;\r
135 pConfig->SubnetMask.Addr[2] = ( 192 <= pConfig->StationAddress.Addr[0]) ? 0xff : 0;\r
136 pConfig->SubnetMask.Addr[3] = ( 224 <= pConfig->StationAddress.Addr[0]) ? 0xff : 0;\r
137 }\r
138\r
139 //\r
140 // Validate the IP address\r
141 //\r
142 pConfig->StationPort = 0;\r
143 Status = bBindTest ? EslSocketBindTest ( pPort, EADDRNOTAVAIL )\r
144 : EFI_SUCCESS;\r
145 if ( !EFI_ERROR ( Status )) {\r
146 //\r
147 // Set the port number\r
148 //\r
149 pConfig->StationPort = SwapBytes16 ( pIpAddress->sin_port );\r
150\r
151 //\r
152 // Display the local address\r
153 //\r
154 DEBUG (( DEBUG_BIND,\r
155 "0x%08x: Port, Local UDP4 Address: %d.%d.%d.%d:%d\r\n",\r
156 pPort,\r
157 pConfig->StationAddress.Addr[0],\r
158 pConfig->StationAddress.Addr[1],\r
159 pConfig->StationAddress.Addr[2],\r
160 pConfig->StationAddress.Addr[3],\r
161 pConfig->StationPort ));\r
162 }\r
163 }\r
164\r
165 //\r
166 // Return the operation status\r
167 //\r
168 DBG_EXIT_STATUS ( Status );\r
169 return Status;\r
170}\r
171\r
172\r
173/**\r
174 Free a receive packet\r
175\r
176 This routine performs the network specific operations necessary\r
177 to free a receive packet.\r
178\r
179 This routine is called by ::EslSocketPortCloseTxDone to free a\r
180 receive packet.\r
181\r
182 @param [in] pPacket Address of an ::ESL_PACKET structure.\r
183 @param [in, out] pRxBytes Address of the count of RX bytes\r
184\r
185**/\r
186VOID\r
187EslUdp4PacketFree (\r
188 IN ESL_PACKET * pPacket,\r
189 IN OUT size_t * pRxBytes\r
190 )\r
191{\r
192 EFI_UDP4_RECEIVE_DATA * pRxData;\r
193\r
194 DBG_ENTER ( );\r
195\r
196 //\r
197 // Account for the receive bytes\r
198 //\r
199 pRxData = pPacket->Op.Udp4Rx.pRxData;\r
200 *pRxBytes -= pRxData->DataLength;\r
201\r
202 //\r
203 // Disconnect the buffer from the packet\r
204 //\r
205 pPacket->Op.Udp4Rx.pRxData = NULL;\r
206\r
207 //\r
208 // Return the buffer to the UDP4 driver\r
209 //\r
210 gBS->SignalEvent ( pRxData->RecycleSignal );\r
211 DBG_EXIT ( );\r
212}\r
213\r
214\r
215/**\r
216 Initialize the network specific portions of an ::ESL_PORT structure.\r
217\r
218 This routine initializes the network specific portions of an\r
219 ::ESL_PORT structure for use by the socket.\r
220\r
221 This support routine is called by ::EslSocketPortAllocate\r
222 to connect the socket with the underlying network adapter\r
223 running the UDPv4 protocol.\r
224\r
225 @param [in] pPort Address of an ESL_PORT structure\r
226 @param [in] DebugFlags Flags for debug messages\r
227\r
228 @retval EFI_SUCCESS - Socket successfully created\r
229\r
230 **/\r
231EFI_STATUS\r
232EslUdp4PortAllocate (\r
233 IN ESL_PORT * pPort,\r
234 IN UINTN DebugFlags\r
235 )\r
236{\r
237 EFI_UDP4_CONFIG_DATA * pConfig;\r
238 ESL_SOCKET * pSocket;\r
239 EFI_STATUS Status;\r
240\r
241 DBG_ENTER ( );\r
242\r
243 //\r
244 // Initialize the port\r
245 //\r
246 pSocket = pPort->pSocket;\r
247 pSocket->TxPacketOffset = OFFSET_OF ( ESL_PACKET, Op.Udp4Tx.TxData );\r
248 pSocket->TxTokenEventOffset = OFFSET_OF ( ESL_IO_MGMT, Token.Udp4Tx.Event );\r
249 pSocket->TxTokenOffset = OFFSET_OF ( EFI_UDP4_COMPLETION_TOKEN, Packet.TxData );\r
250\r
251 //\r
252 // Save the cancel, receive and transmit addresses\r
253 //\r
254 pPort->pfnConfigure = (PFN_NET_CONFIGURE)pPort->pProtocol.UDPv4->Configure;\r
255 pPort->pfnRxCancel = (PFN_NET_IO_START)pPort->pProtocol.UDPv4->Cancel;\r
256 pPort->pfnRxPoll = (PFN_NET_POLL)pPort->pProtocol.UDPv4->Poll;\r
257 pPort->pfnRxStart = (PFN_NET_IO_START)pPort->pProtocol.UDPv4->Receive;\r
258 pPort->pfnTxStart = (PFN_NET_IO_START)pPort->pProtocol.UDPv4->Transmit;\r
259\r
260 //\r
261 // Set the configuration flags\r
262 //\r
263 pConfig = &pPort->Context.Udp4.ConfigData;\r
264 pConfig->TimeToLive = 255;\r
265 pConfig->AcceptAnyPort = FALSE;\r
266 pConfig->AcceptBroadcast = FALSE;\r
267 pConfig->AcceptPromiscuous = FALSE;\r
268 pConfig->AllowDuplicatePort = TRUE;\r
269 pConfig->DoNotFragment = FALSE;\r
270 Status = EFI_SUCCESS;\r
271\r
272 //\r
273 // Return the operation status\r
274 //\r
275 DBG_EXIT_STATUS ( Status );\r
276 return Status;\r
277}\r
278\r
279\r
280/**\r
281 Receive data from a network connection.\r
282\r
283 This routine attempts to return buffered data to the caller. The\r
284 data is removed from the urgent queue if the message flag MSG_OOB\r
285 is specified, otherwise data is removed from the normal queue.\r
286 See the \ref ReceiveEngine section.\r
287\r
288 This routine is called by ::EslSocketReceive to handle the network\r
289 specific receive operation to support SOCK_DGRAM sockets.\r
290\r
291 @param [in] pPort Address of an ::ESL_PORT structure.\r
292\r
293 @param [in] pPacket Address of an ::ESL_PACKET structure.\r
294 \r
295 @param [in] pbConsumePacket Address of a BOOLEAN indicating if the packet is to be consumed\r
296 \r
297 @param [in] BufferLength Length of the the buffer\r
298 \r
299 @param [in] pBuffer Address of a buffer to receive the data.\r
300 \r
301 @param [in] pDataLength Number of received data bytes in the buffer.\r
302\r
303 @param [out] pAddress Network address to receive the remote system address\r
304\r
305 @param [out] pSkipBytes Address to receive the number of bytes skipped\r
306\r
307 @return Returns the address of the next free byte in the buffer.\r
308\r
309 **/\r
310UINT8 *\r
311EslUdp4Receive (\r
312 IN ESL_PORT * pPort,\r
313 IN ESL_PACKET * pPacket,\r
314 IN BOOLEAN * pbConsumePacket,\r
315 IN size_t BufferLength,\r
316 IN UINT8 * pBuffer,\r
317 OUT size_t * pDataLength,\r
318 OUT struct sockaddr * pAddress,\r
319 OUT size_t * pSkipBytes\r
320 )\r
321{\r
322 size_t DataBytes;\r
323 struct sockaddr_in * pRemoteAddress;\r
324 EFI_UDP4_RECEIVE_DATA * pRxData;\r
325\r
326 DBG_ENTER ( );\r
327\r
328 pRxData = pPacket->Op.Udp4Rx.pRxData;\r
329 //\r
330 // Return the remote system address if requested\r
331 //\r
332 if ( NULL != pAddress ) {\r
333 //\r
334 // Build the remote address\r
335 //\r
336 DEBUG (( DEBUG_RX,\r
337 "Getting packet remote address: %d.%d.%d.%d:%d\r\n",\r
338 pRxData->UdpSession.SourceAddress.Addr[0],\r
339 pRxData->UdpSession.SourceAddress.Addr[1],\r
340 pRxData->UdpSession.SourceAddress.Addr[2],\r
341 pRxData->UdpSession.SourceAddress.Addr[3],\r
342 pRxData->UdpSession.SourcePort ));\r
343 pRemoteAddress = (struct sockaddr_in *)pAddress;\r
344 CopyMem ( &pRemoteAddress->sin_addr,\r
345 &pRxData->UdpSession.SourceAddress.Addr[0],\r
346 sizeof ( pRemoteAddress->sin_addr ));\r
347 pRemoteAddress->sin_port = SwapBytes16 ( pRxData->UdpSession.SourcePort );\r
348 }\r
349\r
350 //\r
351 // Copy the received data\r
352 //\r
353 pBuffer = EslSocketCopyFragmentedBuffer ( pRxData->FragmentCount,\r
354 (EFI_IP4_FRAGMENT_DATA *)&pRxData->FragmentTable[0],\r
355 BufferLength,\r
356 pBuffer,\r
357 &DataBytes );\r
358\r
359 //\r
360 // Determine if the data is being read\r
361 //\r
362 if ( *pbConsumePacket ) {\r
363 //\r
364 // Display for the bytes consumed\r
365 //\r
366 DEBUG (( DEBUG_RX,\r
367 "0x%08x: Port account for 0x%08x bytes\r\n",\r
368 pPort,\r
369 DataBytes ));\r
370\r
371 //\r
372 // Account for any discarded data\r
373 //\r
374 *pSkipBytes = pRxData->DataLength - DataBytes;\r
375 }\r
376\r
377 //\r
378 // Return the data length and the buffer address\r
379 //\r
380 *pDataLength = DataBytes;\r
381 DBG_EXIT_HEX ( pBuffer );\r
382 return pBuffer;\r
383}\r
384\r
385\r
386/**\r
387 Get the remote socket address\r
388\r
389 This routine returns the address of the remote connection point\r
390 associated with the SOCK_DGRAM socket.\r
391\r
392 This routine is called by ::EslSocketGetPeerAddress to detemine\r
393 the UDPv4 address and port number associated with the network adapter.\r
394\r
395 @param [in] pPort Address of an ::ESL_PORT structure.\r
396\r
397 @param [out] pAddress Network address to receive the remote system address\r
398\r
399**/\r
400VOID\r
401EslUdp4RemoteAddressGet (\r
402 IN ESL_PORT * pPort,\r
403 OUT struct sockaddr * pAddress\r
404 )\r
405{\r
406 struct sockaddr_in * pRemoteAddress;\r
407 ESL_UDP4_CONTEXT * pUdp4;\r
408\r
409 DBG_ENTER ( );\r
410\r
411 //\r
412 // Return the remote address\r
413 //\r
414 pUdp4 = &pPort->Context.Udp4;\r
415 pRemoteAddress = (struct sockaddr_in *)pAddress;\r
416 pRemoteAddress->sin_family = AF_INET;\r
417 pRemoteAddress->sin_port = SwapBytes16 ( pUdp4->ConfigData.RemotePort );\r
418 CopyMem ( &pRemoteAddress->sin_addr,\r
419 &pUdp4->ConfigData.RemoteAddress.Addr[0],\r
420 sizeof ( pRemoteAddress->sin_addr ));\r
421\r
422 DBG_EXIT ( );\r
423}\r
424\r
425\r
426/**\r
427 Set the remote address\r
428\r
429 This routine sets the remote address in the port.\r
430\r
431 This routine is called by ::EslSocketConnect to specify the\r
432 remote network address.\r
433\r
434 @param [in] pPort Address of an ::ESL_PORT structure.\r
435\r
436 @param [in] pSockAddr Network address of the remote system.\r
437\r
438 @param [in] SockAddrLength Length in bytes of the network address.\r
439\r
440 @retval EFI_SUCCESS The operation was successful\r
441\r
442 **/\r
443EFI_STATUS\r
444EslUdp4RemoteAddressSet (\r
445 IN ESL_PORT * pPort,\r
446 IN CONST struct sockaddr * pSockAddr,\r
447 IN socklen_t SockAddrLength\r
448 )\r
449{\r
450 CONST struct sockaddr_in * pRemoteAddress;\r
451 ESL_UDP4_CONTEXT * pUdp4;\r
452 EFI_STATUS Status;\r
453\r
454 DBG_ENTER ( );\r
455\r
456 //\r
457 // Set the remote address\r
458 //\r
459 pUdp4 = &pPort->Context.Udp4;\r
460 pRemoteAddress = (struct sockaddr_in *)pSockAddr;\r
461 pUdp4->ConfigData.RemoteAddress.Addr[0] = (UINT8)( pRemoteAddress->sin_addr.s_addr );\r
462 pUdp4->ConfigData.RemoteAddress.Addr[1] = (UINT8)( pRemoteAddress->sin_addr.s_addr >> 8 );\r
463 pUdp4->ConfigData.RemoteAddress.Addr[2] = (UINT8)( pRemoteAddress->sin_addr.s_addr >> 16 );\r
464 pUdp4->ConfigData.RemoteAddress.Addr[3] = (UINT8)( pRemoteAddress->sin_addr.s_addr >> 24 );\r
465 pUdp4->ConfigData.RemotePort = SwapBytes16 ( pRemoteAddress->sin_port );\r
466 pPort->pSocket->bAddressSet = TRUE;\r
467 Status = EFI_SUCCESS;\r
468\r
469 //\r
470 // Return the operation status\r
471 //\r
472 DBG_EXIT_STATUS ( Status );\r
473 return Status;\r
474}\r
475\r
476\r
477/**\r
478 Process the receive completion\r
479\r
480 This routine keeps the UDPv4 driver's buffer and queues it in\r
481 in FIFO order to the data queue. The UDP4 driver's buffer will\r
482 be returned by either ::EslUdp4Receive or ::EslSocketPortCloseTxDone.\r
483 See the \ref ReceiveEngine section.\r
484\r
485 This routine is called by the UDPv4 driver when data is\r
486 received.\r
487\r
488 @param [in] Event The receive completion event\r
489\r
490 @param [in] pIo Address of an ::ESL_IO_MGMT structure\r
491\r
492**/\r
493VOID\r
494EslUdp4RxComplete (\r
495 IN EFI_EVENT Event,\r
496 IN ESL_IO_MGMT * pIo\r
497 )\r
498{\r
499 size_t LengthInBytes;\r
500 ESL_PACKET * pPacket;\r
501 EFI_UDP4_RECEIVE_DATA * pRxData;\r
502 EFI_STATUS Status;\r
503 \r
504 DBG_ENTER ( );\r
505\r
506 //\r
507 // Get the operation status.\r
508 //\r
509 Status = pIo->Token.Udp4Rx.Status;\r
510 \r
511 //\r
512 // Get the packet length\r
513 //\r
514 pRxData = pIo->Token.Udp4Rx.Packet.RxData;\r
515 LengthInBytes = pRxData->DataLength;\r
516\r
517 //\r
518 // +--------------------+ +-----------------------+\r
519 // | ESL_IO_MGMT | | Data Buffer |\r
520 // | | | (Driver owned) |\r
521 // | +---------------+ +-----------------------+\r
522 // | | Token | ^\r
523 // | | Rx Event | |\r
524 // | | | +-----------------------+\r
525 // | | RxData --> | EFI_UDP4_RECEIVE_DATA |\r
526 // +----+---------------+ | (Driver owned) |\r
527 // +-----------------------+\r
528 // +--------------------+ ^\r
529 // | ESL_PACKET | .\r
530 // | | .\r
531 // | +---------------+ .\r
532 // | | pRxData --> NULL .......\r
533 // +----+---------------+\r
534 //\r
535 //\r
536 // Save the data in the packet\r
537 //\r
538 pPacket = pIo->pPacket;\r
539 pPacket->Op.Udp4Rx.pRxData = pRxData;\r
540\r
541 //\r
542 // Complete this request\r
543 //\r
544 EslSocketRxComplete ( pIo, Status, LengthInBytes, FALSE );\r
545 DBG_EXIT ( );\r
546}\r
547\r
548\r
549/**\r
550 Determine if the socket is configured.\r
551\r
552 This routine uses the flag ESL_SOCKET::bConfigured to determine\r
553 if the network layer's configuration routine has been called.\r
554 This routine calls the bind and configuration routines if they\r
555 were not already called. After the port is configured, the\r
556 \ref ReceiveEngine is started.\r
557\r
558 This routine is called by EslSocketIsConfigured to verify\r
559 that the socket is configured.\r
560\r
561 @param [in] pSocket Address of an ::ESL_SOCKET structure\r
562\r
563 @retval EFI_SUCCESS - The port is connected\r
564 @retval EFI_NOT_STARTED - The port is not connected\r
565\r
566 **/\r
567 EFI_STATUS\r
568 EslUdp4SocketIsConfigured (\r
569 IN ESL_SOCKET * pSocket\r
570 )\r
571{\r
572 EFI_UDP4_CONFIG_DATA * pConfigData;\r
573 ESL_PORT * pPort;\r
574 ESL_PORT * pNextPort;\r
575 ESL_UDP4_CONTEXT * pUdp4;\r
576 EFI_UDP4_PROTOCOL * pUdp4Protocol;\r
577 EFI_STATUS Status;\r
578 struct sockaddr_in LocalAddress;\r
579\r
580 DBG_ENTER ( );\r
581\r
582 //\r
583 // Assume success\r
584 //\r
585 Status = EFI_SUCCESS;\r
586\r
587 //\r
588 // Configure the port if necessary\r
589 //\r
590 if ( !pSocket->bConfigured ) {\r
591 //\r
592 // Fill in the port list if necessary\r
593 //\r
594 pSocket->errno = ENETDOWN;\r
595 if ( NULL == pSocket->pPortList ) {\r
596 LocalAddress.sin_len = sizeof ( LocalAddress );\r
597 LocalAddress.sin_family = AF_INET;\r
598 LocalAddress.sin_addr.s_addr = 0;\r
599 LocalAddress.sin_port = 0;\r
600 Status = EslSocketBind ( &pSocket->SocketProtocol,\r
601 (struct sockaddr *)&LocalAddress,\r
602 LocalAddress.sin_len,\r
603 &pSocket->errno );\r
604 }\r
605\r
606 //\r
607 // Walk the port list\r
608 //\r
609 pPort = pSocket->pPortList;\r
610 while ( NULL != pPort ) {\r
611 //\r
612 // Attempt to configure the port\r
613 //\r
614 pNextPort = pPort->pLinkSocket;\r
615 pUdp4 = &pPort->Context.Udp4;\r
616 pUdp4Protocol = pPort->pProtocol.UDPv4;\r
617 pConfigData = &pUdp4->ConfigData;\r
618 DEBUG (( DEBUG_TX,\r
619 "0x%08x: pPort Configuring for %d.%d.%d.%d:%d --> %d.%d.%d.%d:%d\r\n",\r
620 pPort,\r
621 pConfigData->StationAddress.Addr[0],\r
622 pConfigData->StationAddress.Addr[1],\r
623 pConfigData->StationAddress.Addr[2],\r
624 pConfigData->StationAddress.Addr[3],\r
625 pConfigData->StationPort,\r
626 pConfigData->RemoteAddress.Addr[0],\r
627 pConfigData->RemoteAddress.Addr[1],\r
628 pConfigData->RemoteAddress.Addr[2],\r
629 pConfigData->RemoteAddress.Addr[3],\r
630 pConfigData->RemotePort ));\r
631 Status = pUdp4Protocol->Configure ( pUdp4Protocol,\r
632 pConfigData );\r
633 if ( !EFI_ERROR ( Status )) {\r
634 //\r
635 // Update the configuration data\r
636 //\r
637 Status = pUdp4Protocol->GetModeData ( pUdp4Protocol,\r
638 pConfigData,\r
639 NULL,\r
640 NULL,\r
641 NULL );\r
642 }\r
643 if ( EFI_ERROR ( Status )) {\r
644 if ( !pSocket->bConfigured ) {\r
645 DEBUG (( DEBUG_LISTEN,\r
646 "ERROR - Failed to configure the Udp4 port, Status: %r\r\n",\r
647 Status ));\r
648 switch ( Status ) {\r
649 case EFI_ACCESS_DENIED:\r
650 pSocket->errno = EACCES;\r
651 break;\r
652\r
653 default:\r
654 case EFI_DEVICE_ERROR:\r
655 pSocket->errno = EIO;\r
656 break;\r
657\r
658 case EFI_INVALID_PARAMETER:\r
659 pSocket->errno = EADDRNOTAVAIL;\r
660 break;\r
661\r
662 case EFI_NO_MAPPING:\r
663 pSocket->errno = EAFNOSUPPORT;\r
664 break;\r
665\r
666 case EFI_OUT_OF_RESOURCES:\r
667 pSocket->errno = ENOBUFS;\r
668 break;\r
669\r
670 case EFI_UNSUPPORTED:\r
671 pSocket->errno = EOPNOTSUPP;\r
672 break;\r
673 }\r
674 }\r
675 }\r
676 else {\r
677 DEBUG (( DEBUG_TX,\r
678 "0x%08x: pPort Configured for %d.%d.%d.%d:%d --> %d.%d.%d.%d:%d\r\n",\r
679 pPort,\r
680 pConfigData->StationAddress.Addr[0],\r
681 pConfigData->StationAddress.Addr[1],\r
682 pConfigData->StationAddress.Addr[2],\r
683 pConfigData->StationAddress.Addr[3],\r
684 pConfigData->StationPort,\r
685 pConfigData->RemoteAddress.Addr[0],\r
686 pConfigData->RemoteAddress.Addr[1],\r
687 pConfigData->RemoteAddress.Addr[2],\r
688 pConfigData->RemoteAddress.Addr[3],\r
689 pConfigData->RemotePort ));\r
690 pPort->bConfigured = TRUE;\r
691 pSocket->bConfigured = TRUE;\r
692\r
693 //\r
694 // Start the first read on the port\r
695 //\r
696 EslSocketRxStart ( pPort );\r
697\r
698 //\r
699 // The socket is connected\r
700 //\r
701 pSocket->State = SOCKET_STATE_CONNECTED;\r
702 pSocket->errno = 0;\r
703 }\r
704\r
705 //\r
706 // Set the next port\r
707 //\r
708 pPort = pNextPort;\r
709 }\r
710 }\r
711\r
712 //\r
713 // Determine the socket configuration status\r
714 //\r
715 Status = pSocket->bConfigured ? EFI_SUCCESS : EFI_NOT_STARTED;\r
716 \r
717 //\r
718 // Return the port connected state.\r
719 //\r
720 DBG_EXIT_STATUS ( Status );\r
721 return Status;\r
722}\r
723\r
724\r
725/**\r
726 Buffer data for transmission over a network connection.\r
727\r
728 This routine buffers data for the transmit engine in the normal\r
729 data queue. When the \ref TransmitEngine has resources, this\r
730 routine will start the transmission of the next buffer on the\r
731 network connection.\r
732\r
733 This routine is called by ::EslSocketTransmit to buffer\r
734 data for transmission. The data is copied into a local buffer\r
735 freeing the application buffer for reuse upon return. When\r
736 necessary, this routine starts the transmit engine that\r
737 performs the data transmission on the network connection. The\r
738 transmit engine transmits the data a packet at a time over the\r
739 network connection.\r
740\r
741 Transmission errors are returned during the next transmission or\r
742 during the close operation. Only buffering errors are returned\r
743 during the current transmission attempt.\r
744\r
745 @param [in] pSocket Address of an ::ESL_SOCKET structure\r
746\r
747 @param [in] Flags Message control flags\r
748\r
749 @param [in] BufferLength Length of the the buffer\r
750\r
751 @param [in] pBuffer Address of a buffer to receive the data.\r
752\r
753 @param [in] pDataLength Number of received data bytes in the buffer.\r
754\r
755 @param [in] pAddress Network address of the remote system address\r
756\r
757 @param [in] AddressLength Length of the remote network address structure\r
758\r
759 @retval EFI_SUCCESS - Socket data successfully buffered\r
760\r
761**/\r
762EFI_STATUS\r
763EslUdp4TxBuffer (\r
764 IN ESL_SOCKET * pSocket,\r
765 IN int Flags,\r
766 IN size_t BufferLength,\r
767 IN CONST UINT8 * pBuffer,\r
768 OUT size_t * pDataLength,\r
769 IN const struct sockaddr * pAddress,\r
770 IN socklen_t AddressLength\r
771 )\r
772{\r
773 ESL_PACKET * pPacket;\r
774 ESL_PACKET * pPreviousPacket;\r
775 ESL_PORT * pPort;\r
776 const struct sockaddr_in * pRemoteAddress;\r
777 ESL_UDP4_CONTEXT * pUdp4;\r
778 size_t * pTxBytes;\r
779 ESL_UDP4_TX_DATA * pTxData;\r
780 EFI_STATUS Status;\r
781 EFI_TPL TplPrevious;\r
782\r
783 DBG_ENTER ( );\r
784\r
785 //\r
786 // Assume failure\r
787 //\r
788 Status = EFI_UNSUPPORTED;\r
789 pSocket->errno = ENOTCONN;\r
790 *pDataLength = 0;\r
791\r
792 //\r
793 // Verify that the socket is connected\r
794 //\r
795 if ( SOCKET_STATE_CONNECTED == pSocket->State ) {\r
796 //\r
797 // Verify that there is enough room to buffer another\r
798 // transmit operation\r
799 //\r
800 pTxBytes = &pSocket->TxBytes;\r
801 if ( pSocket->MaxTxBuf > *pTxBytes ) {\r
802 //\r
803 // Locate the port\r
804 //\r
805 pPort = pSocket->pPortList;\r
806 while ( NULL != pPort ) {\r
807 //\r
808 // Determine the queue head\r
809 //\r
810 pUdp4 = &pPort->Context.Udp4;\r
811\r
812 //\r
813 // Attempt to allocate the packet\r
814 //\r
815 Status = EslSocketPacketAllocate ( &pPacket,\r
816 sizeof ( pPacket->Op.Udp4Tx )\r
817 - sizeof ( pPacket->Op.Udp4Tx.Buffer )\r
818 + BufferLength,\r
819 0,\r
820 DEBUG_TX );\r
821 if ( !EFI_ERROR ( Status )) {\r
822 //\r
823 // Initialize the transmit operation\r
824 //\r
825 pTxData = &pPacket->Op.Udp4Tx;\r
826 pTxData->TxData.GatewayAddress = NULL;\r
827 pTxData->TxData.UdpSessionData = NULL;\r
828 pTxData->TxData.DataLength = (UINT32) BufferLength;\r
829 pTxData->TxData.FragmentCount = 1;\r
830 pTxData->TxData.FragmentTable[0].FragmentLength = (UINT32) BufferLength;\r
831 pTxData->TxData.FragmentTable[0].FragmentBuffer = &pPacket->Op.Udp4Tx.Buffer[0];\r
832 pTxData->RetransmitCount = 0;\r
833\r
834 //\r
835 // Set the remote system address if necessary\r
836 //\r
837 pTxData->TxData.UdpSessionData = NULL;\r
838 if ( NULL != pAddress ) {\r
839 pRemoteAddress = (const struct sockaddr_in *)pAddress;\r
840 pTxData->Session.SourceAddress.Addr[0] = pUdp4->ConfigData.StationAddress.Addr[0];\r
841 pTxData->Session.SourceAddress.Addr[1] = pUdp4->ConfigData.StationAddress.Addr[1];\r
842 pTxData->Session.SourceAddress.Addr[2] = pUdp4->ConfigData.StationAddress.Addr[2];\r
843 pTxData->Session.SourceAddress.Addr[3] = pUdp4->ConfigData.StationAddress.Addr[3];\r
844 pTxData->Session.SourcePort = 0;\r
845 pTxData->Session.DestinationAddress.Addr[0] = (UINT8)pRemoteAddress->sin_addr.s_addr;\r
846 pTxData->Session.DestinationAddress.Addr[1] = (UINT8)( pRemoteAddress->sin_addr.s_addr >> 8 );\r
847 pTxData->Session.DestinationAddress.Addr[2] = (UINT8)( pRemoteAddress->sin_addr.s_addr >> 16 );\r
848 pTxData->Session.DestinationAddress.Addr[3] = (UINT8)( pRemoteAddress->sin_addr.s_addr >> 24 );\r
849 pTxData->Session.DestinationPort = SwapBytes16 ( pRemoteAddress->sin_port );\r
850\r
851 //\r
852 // Use the remote system address when sending this packet\r
853 //\r
854 pTxData->TxData.UdpSessionData = &pTxData->Session;\r
855 }\r
856\r
857 //\r
858 // Copy the data into the buffer\r
859 //\r
860 CopyMem ( &pPacket->Op.Udp4Tx.Buffer[0],\r
861 pBuffer,\r
862 BufferLength );\r
863\r
864 //\r
865 // Synchronize with the socket layer\r
866 //\r
867 RAISE_TPL ( TplPrevious, TPL_SOCKETS );\r
868\r
869 //\r
870 // Display the request\r
871 //\r
872 DEBUG (( DEBUG_TX,\r
873 "Send %d bytes from 0x%08x to %d.%d.%d.%d:%d\r\n",\r
874 BufferLength,\r
875 pBuffer,\r
876 pTxData->Session.DestinationAddress.Addr[0],\r
877 pTxData->Session.DestinationAddress.Addr[1],\r
878 pTxData->Session.DestinationAddress.Addr[2],\r
879 pTxData->Session.DestinationAddress.Addr[3],\r
880 pTxData->Session.DestinationPort ));\r
881\r
882 //\r
883 // Queue the data for transmission\r
884 //\r
885 pPacket->pNext = NULL;\r
886 pPreviousPacket = pSocket->pTxPacketListTail;\r
887 if ( NULL == pPreviousPacket ) {\r
888 pSocket->pTxPacketListHead = pPacket;\r
889 }\r
890 else {\r
891 pPreviousPacket->pNext = pPacket;\r
892 }\r
893 pSocket->pTxPacketListTail = pPacket;\r
894 DEBUG (( DEBUG_TX,\r
895 "0x%08x: Packet on transmit list\r\n",\r
896 pPacket ));\r
897\r
898 //\r
899 // Account for the buffered data\r
900 //\r
901 *pTxBytes += BufferLength;\r
902 *pDataLength = BufferLength;\r
903\r
904 //\r
905 // Start the transmit engine if it is idle\r
906 //\r
907 if ( NULL != pPort->pTxFree ) {\r
908 pPacket = pSocket->pTxPacketListHead;\r
909 EslSocketTxStart ( pPort,\r
910 &pSocket->pTxPacketListHead,\r
911 &pSocket->pTxPacketListTail,\r
912 &pPort->pTxActive,\r
913 &pPort->pTxFree );\r
914\r
915 //\r
916 // Ignore any transmit error\r
917 //\r
918 if ( EFI_ERROR ( pSocket->TxError )) {\r
919 DEBUG (( DEBUG_TX,\r
920 "0x%08x: Transmit error, Packet: 0x%08x, Status: %r\r\n",\r
921 pPort,\r
922 pPacket,\r
923 pSocket->TxError ));\r
924 }\r
925 pSocket->TxError = EFI_SUCCESS;\r
926 }\r
927\r
928 //\r
929 // Release the socket layer synchronization\r
930 //\r
931 RESTORE_TPL ( TplPrevious );\r
932 }\r
933 else {\r
934 //\r
935 // Packet allocation failed\r
936 //\r
937 pSocket->errno = ENOMEM;\r
938 break;\r
939 }\r
940\r
941 //\r
942 // Set the next port\r
943 //\r
944 pPort = pPort->pLinkSocket;\r
945 }\r
946 }\r
947 else {\r
948 //\r
949 // Not enough buffer space available\r
950 //\r
951 pSocket->errno = EAGAIN;\r
952 Status = EFI_NOT_READY;\r
953 }\r
954 }\r
955\r
956 //\r
957 // Return the operation status\r
958 //\r
959 DBG_EXIT_STATUS ( Status );\r
960 return Status;\r
961}\r
962\r
963\r
964/**\r
965 Process the transmit completion\r
966\r
967 This routine use ::EslSocketTxComplete to perform the transmit\r
968 completion processing for data packets.\r
969\r
970 This routine is called by the UDPv4 network layer when a data\r
971 transmit request completes.\r
972\r
973 @param [in] Event The normal transmit completion event\r
974\r
975 @param [in] pIo Address of an ::ESL_IO_MGMT structure\r
976\r
977**/\r
978VOID\r
979EslUdp4TxComplete (\r
980 IN EFI_EVENT Event,\r
981 IN ESL_IO_MGMT * pIo\r
982 )\r
983{\r
984 UINT32 LengthInBytes;\r
985 ESL_PORT * pPort;\r
986 ESL_PACKET * pPacket;\r
987 ESL_SOCKET * pSocket;\r
988 EFI_STATUS Status;\r
989 \r
990 DBG_ENTER ( );\r
991 \r
992 //\r
993 // Locate the active transmit packet\r
994 //\r
995 pPacket = pIo->pPacket;\r
996 pPort = pIo->pPort;\r
997 pSocket = pPort->pSocket;\r
998\r
999 //\r
1000 // Get the transmit length and status\r
1001 //\r
1002 LengthInBytes = pPacket->Op.Udp4Tx.TxData.DataLength;\r
1003 pSocket->TxBytes -= LengthInBytes;\r
1004 Status = pIo->Token.Udp4Tx.Status;\r
1005\r
1006 //\r
1007 // Ignore the transmit error\r
1008 //\r
1009 if ( EFI_ERROR ( Status )) {\r
1010 DEBUG (( DEBUG_TX,\r
1011 "0x%08x: Transmit completion error, Packet: 0x%08x, Status: %r\r\n",\r
1012 pPort,\r
1013 pPacket,\r
1014 Status ));\r
1015 Status = EFI_SUCCESS;\r
1016 }\r
1017\r
1018 //\r
1019 // Complete the transmit operation\r
1020 //\r
1021 EslSocketTxComplete ( pIo,\r
1022 LengthInBytes,\r
1023 Status,\r
1024 "UDP ",\r
1025 &pSocket->pTxPacketListHead,\r
1026 &pSocket->pTxPacketListTail,\r
1027 &pPort->pTxActive,\r
1028 &pPort->pTxFree );\r
1029 DBG_EXIT ( );\r
1030}\r
1031\r
1032\r
1033/**\r
1034 Verify the adapter's IP address\r
1035\r
1036 This support routine is called by EslSocketBindTest.\r
1037\r
1038 @param [in] pPort Address of an ::ESL_PORT structure.\r
1039 @param [in] pConfigData Address of the configuration data\r
1040\r
1041 @retval EFI_SUCCESS - The IP address is valid\r
1042 @retval EFI_NOT_STARTED - The IP address is invalid\r
1043\r
1044 **/\r
1045EFI_STATUS\r
1046EslUdp4VerifyLocalIpAddress (\r
1047 IN ESL_PORT * pPort,\r
1048 IN EFI_UDP4_CONFIG_DATA * pConfigData\r
1049 )\r
1050{\r
1051 UINTN DataSize;\r
1052 EFI_IP4_IPCONFIG_DATA * pIpConfigData;\r
1053 EFI_IP4_CONFIG_PROTOCOL * pIpConfigProtocol;\r
1054 ESL_SERVICE * pService;\r
1055 EFI_STATUS Status;\r
1056\r
1057 DBG_ENTER ( );\r
1058\r
1059 //\r
1060 // Use break instead of goto\r
1061 //\r
1062 pIpConfigData = NULL;\r
1063 for ( ; ; ) {\r
1064 //\r
1065 // Determine if the IP address is specified\r
1066 //\r
1067 DEBUG (( DEBUG_BIND,\r
1068 "UseDefaultAddress: %s\r\n",\r
1069 pConfigData->UseDefaultAddress ? L"TRUE" : L"FALSE" ));\r
1070 DEBUG (( DEBUG_BIND,\r
1071 "Requested IP address: %d.%d.%d.%d\r\n",\r
1072 pConfigData->StationAddress.Addr [ 0 ],\r
1073 pConfigData->StationAddress.Addr [ 1 ],\r
1074 pConfigData->StationAddress.Addr [ 2 ],\r
1075 pConfigData->StationAddress.Addr [ 3 ]));\r
1076 if ( pConfigData->UseDefaultAddress\r
1077 || (( 0 == pConfigData->StationAddress.Addr [ 0 ])\r
1078 && ( 0 == pConfigData->StationAddress.Addr [ 1 ])\r
1079 && ( 0 == pConfigData->StationAddress.Addr [ 2 ])\r
1080 && ( 0 == pConfigData->StationAddress.Addr [ 3 ])))\r
1081 {\r
1082 Status = EFI_SUCCESS;\r
1083 break;\r
1084 }\r
1085\r
1086 //\r
1087 // Open the configuration protocol\r
1088 //\r
1089 pService = pPort->pService;\r
1090 Status = gBS->OpenProtocol ( pService->Controller,\r
1091 &gEfiIp4ConfigProtocolGuid,\r
1092 (VOID **)&pIpConfigProtocol,\r
1093 NULL,\r
1094 NULL,\r
1095 EFI_OPEN_PROTOCOL_GET_PROTOCOL );\r
1096 if ( EFI_ERROR ( Status )) {\r
1097 DEBUG (( DEBUG_ERROR,\r
1098 "ERROR - IP Configuration Protocol not available, Status: %r\r\n",\r
1099 Status ));\r
1100 break;\r
1101 }\r
1102\r
1103 //\r
1104 // Get the IP configuration data size\r
1105 //\r
1106 DataSize = 0;\r
1107 Status = pIpConfigProtocol->GetData ( pIpConfigProtocol,\r
1108 &DataSize,\r
1109 NULL );\r
1110 if ( EFI_BUFFER_TOO_SMALL != Status ) {\r
1111 DEBUG (( DEBUG_ERROR,\r
1112 "ERROR - Failed to get IP Configuration data size, Status: %r\r\n",\r
1113 Status ));\r
1114 break;\r
1115 }\r
1116\r
1117 //\r
1118 // Allocate the configuration data buffer\r
1119 //\r
1120 pIpConfigData = AllocatePool ( DataSize );\r
1121 if ( NULL == pIpConfigData ) {\r
1122 DEBUG (( DEBUG_ERROR,\r
1123 "ERROR - Not enough memory to allocate IP Configuration data!\r\n" ));\r
1124 Status = EFI_OUT_OF_RESOURCES;\r
1125 break;\r
1126 }\r
1127\r
1128 //\r
1129 // Get the IP configuration\r
1130 //\r
1131 Status = pIpConfigProtocol->GetData ( pIpConfigProtocol,\r
1132 &DataSize,\r
1133 pIpConfigData );\r
1134 if ( EFI_ERROR ( Status )) {\r
1135 DEBUG (( DEBUG_ERROR,\r
1136 "ERROR - Failed to return IP Configuration data, Status: %r\r\n",\r
1137 Status ));\r
1138 break;\r
1139 }\r
1140\r
1141 //\r
1142 // Display the current configuration\r
1143 //\r
1144 DEBUG (( DEBUG_BIND,\r
1145 "Actual adapter IP address: %d.%d.%d.%d\r\n",\r
1146 pIpConfigData->StationAddress.Addr [ 0 ],\r
1147 pIpConfigData->StationAddress.Addr [ 1 ],\r
1148 pIpConfigData->StationAddress.Addr [ 2 ],\r
1149 pIpConfigData->StationAddress.Addr [ 3 ]));\r
1150\r
1151 //\r
1152 // Assume the port is not configured\r
1153 //\r
1154 Status = EFI_SUCCESS;\r
1155 if (( pConfigData->StationAddress.Addr [ 0 ] == pIpConfigData->StationAddress.Addr [ 0 ])\r
1156 && ( pConfigData->StationAddress.Addr [ 1 ] == pIpConfigData->StationAddress.Addr [ 1 ])\r
1157 && ( pConfigData->StationAddress.Addr [ 2 ] == pIpConfigData->StationAddress.Addr [ 2 ])\r
1158 && ( pConfigData->StationAddress.Addr [ 3 ] == pIpConfigData->StationAddress.Addr [ 3 ])) {\r
1159 break;\r
1160 }\r
1161\r
1162 //\r
1163 // The IP address did not match\r
1164 //\r
1165 Status = EFI_NOT_STARTED;\r
1166 break;\r
1167 }\r
1168\r
1169 //\r
1170 // Free the buffer if necessary\r
1171 //\r
1172 if ( NULL != pIpConfigData ) {\r
1173 FreePool ( pIpConfigData );\r
1174 }\r
1175\r
1176 //\r
1177 // Return the IP address status\r
1178 //\r
1179 DBG_EXIT_STATUS ( Status );\r
1180 return Status;\r
1181}\r
1182\r
1183\r
1184/**\r
1185 Interface between the socket layer and the network specific\r
1186 code that supports SOCK_DGRAM sockets over UDPv4.\r
1187**/\r
1188CONST ESL_PROTOCOL_API cEslUdp4Api = {\r
1189 "UDPv4",\r
1190 IPPROTO_UDP,\r
1191 OFFSET_OF ( ESL_PORT, Context.Udp4.ConfigData ),\r
1192 OFFSET_OF ( ESL_LAYER, pUdp4List ),\r
1193 OFFSET_OF ( struct sockaddr_in, sin_zero ),\r
1194 sizeof ( struct sockaddr_in ),\r
1195 AF_INET,\r
1196 sizeof (((ESL_PACKET *)0 )->Op.Udp4Rx ),\r
1197 sizeof (((ESL_PACKET *)0 )->Op.Udp4Rx ),\r
1198 OFFSET_OF ( ESL_IO_MGMT, Token.Udp4Rx.Packet.RxData ),\r
1199 FALSE,\r
1200 EADDRINUSE,\r
1201 NULL, // Accept\r
1202 NULL, // ConnectPoll\r
1203 NULL, // ConnectStart\r
1204 EslUdp4SocketIsConfigured,\r
1205 EslUdp4LocalAddressGet,\r
1206 EslUdp4LocalAddressSet,\r
1207 NULL, // Listen\r
1208 NULL, // OptionGet\r
1209 NULL, // OptionSet\r
1210 EslUdp4PacketFree,\r
1211 EslUdp4PortAllocate,\r
1212 NULL, // PortClose,\r
1213 NULL, // PortCloseOp\r
1214 TRUE,\r
1215 EslUdp4Receive,\r
1216 EslUdp4RemoteAddressGet,\r
1217 EslUdp4RemoteAddressSet,\r
1218 EslUdp4RxComplete,\r
1219 NULL, // RxStart\r
1220 EslUdp4TxBuffer,\r
1221 EslUdp4TxComplete,\r
1222 NULL, // TxOobComplete\r
1223 (PFN_API_VERIFY_LOCAL_IP_ADDRESS)EslUdp4VerifyLocalIpAddress\r
1224};\r
EFI Development Kit II mirror for PVE