]> git.proxmox.com Git - mirror_edk2.git/blame_incremental - StdLib/EfiSocketLib/Tcp4.c
projects / mirror_edk2.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
EdkShellPkg/ShellR33.patch: Fixed '32'2' folder names
[mirror_edk2.git] / StdLib / EfiSocketLib / Tcp4.c
... / ...
CommitLineData
1/** @file\r
2 Implement the TCP4 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 \section ConnectionManagement Connection Management\r
15 \r
16 The ::EslTcp4Listen routine initially places the SOCK_STREAM or\r
17 SOCK_SEQPACKET socket into a listen state. When a remote machine\r
18 makes a connection to the socket, the TCPv4 network layer calls\r
19 ::EslTcp4ListenComplete to complete the connection processing.\r
20 EslTcp4ListenComplete manages the connections by placing them in\r
21 FIFO order in a queue to be serviced by the application. When the\r
22 number of connections exceeds the backlog (ESL_SOCKET::MaxFifoDepth),\r
23 the new connection is closed. Eventually, the application indirectly\r
24 calls ::EslTcp4Accept to remove the next connection from the queue\r
25 and get the associated socket.\r
26\r
27**/\r
28\r
29#include "Socket.h"\r
30\r
31\r
32/**\r
33 Attempt to connect to a remote TCP port\r
34\r
35 This routine starts the connection processing for a SOCK_STREAM\r
36 or SOCK_SEQPAKCET socket using the TCPv4 network layer. It\r
37 configures the local TCPv4 connection point and then attempts to\r
38 connect to a remote system. Upon completion, the\r
39 ::EslTcp4ConnectComplete routine gets called with the connection\r
40 status.\r
41\r
42 This routine is called by ::EslSocketConnect to initiate the TCPv4\r
43 network specific connect operations. The connection processing is\r
44 initiated by this routine and finished by ::EslTcp4ConnectComplete.\r
45 This pair of routines walks through the list of local TCPv4\r
46 connection points until a connection to the remote system is\r
47 made.\r
48\r
49 @param [in] pSocket Address of an ::ESL_SOCKET structure.\r
50\r
51 @retval EFI_SUCCESS The connection was successfully established.\r
52 @retval EFI_NOT_READY The connection is in progress, call this routine again.\r
53 @retval Others The connection attempt failed.\r
54\r
55 **/\r
56EFI_STATUS\r
57EslTcp4ConnectStart (\r
58 IN ESL_SOCKET * pSocket\r
59 );\r
60\r
61\r
62/**\r
63 Process the connection attempt\r
64\r
65 A system has initiated a connection attempt with a socket in the\r
66 listen state. Attempt to complete the connection.\r
67\r
68 The TCPv4 layer calls this routine when a connection is made to\r
69 the socket in the listen state. See the\r
70 \ref ConnectionManagement section.\r
71\r
72 @param [in] Event The listen completion event\r
73\r
74 @param [in] pPort Address of an ::ESL_PORT structure.\r
75\r
76**/\r
77VOID\r
78EslTcp4ListenComplete (\r
79 IN EFI_EVENT Event,\r
80 IN ESL_PORT * pPort\r
81 );\r
82\r
83\r
84/**\r
85 Accept a network connection.\r
86\r
87 This routine waits for a network connection to the socket and\r
88 returns the remote network address to the caller if requested.\r
89\r
90 This routine is called by ::EslSocketAccept to handle the TCPv4 protocol\r
91 specific accept operations for SOCK_STREAM and SOCK_SEQPACKET sockets.\r
92 See the \ref ConnectionManagement section.\r
93\r
94 @param [in] pSocket Address of an ::ESL_SOCKET structure.\r
95\r
96 @param [in] pSockAddr Address of a buffer to receive the remote\r
97 network address.\r
98\r
99 @param [in, out] pSockAddrLength Length in bytes of the address buffer.\r
100 On output specifies the length of the\r
101 remote network address.\r
102\r
103 @retval EFI_SUCCESS Remote address is available\r
104 @retval Others Remote address not available\r
105\r
106 **/\r
107EFI_STATUS\r
108EslTcp4Accept (\r
109 IN ESL_SOCKET * pSocket,\r
110 IN struct sockaddr * pSockAddr,\r
111 IN OUT socklen_t * pSockAddrLength\r
112 )\r
113{\r
114 ESL_PORT * pPort;\r
115 struct sockaddr_in * pRemoteAddress;\r
116 ESL_TCP4_CONTEXT * pTcp4;\r
117 UINT32 RemoteAddress;\r
118 EFI_STATUS Status;\r
119\r
120 DBG_ENTER ( );\r
121\r
122 //\r
123 // Validate the socket length\r
124 //\r
125 pRemoteAddress = (struct sockaddr_in *) pSockAddr;\r
126 if (( NULL == pSockAddrLength )\r
127 || ( sizeof ( *pRemoteAddress ) > *pSockAddrLength )) {\r
128 //\r
129 // Invalid socket address\r
130 //\r
131 Status = EFI_INVALID_PARAMETER;\r
132 pSocket->errno = EINVAL;\r
133 DEBUG (( DEBUG_ACCEPT,\r
134 "ERROR - Invalid address length\r\n" ));\r
135 }\r
136 else {\r
137 //\r
138 // Assume success\r
139 //\r
140 Status = EFI_SUCCESS;\r
141\r
142 //\r
143 // Locate the address context\r
144 //\r
145 pPort = pSocket->pPortList;\r
146 pTcp4 = &pPort->Context.Tcp4;\r
147\r
148 //\r
149 // Fill-in the remote address structure\r
150 //\r
151 ZeroMem ( pRemoteAddress, sizeof ( *pRemoteAddress ));\r
152 pRemoteAddress->sin_len = sizeof ( *pRemoteAddress );\r
153 pRemoteAddress->sin_family = AF_INET;\r
154 pRemoteAddress->sin_port = SwapBytes16 ( pTcp4->ConfigData.AccessPoint.RemotePort );\r
155 RemoteAddress = pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[3];\r
156 RemoteAddress <<= 8;\r
157 RemoteAddress |= pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[2];\r
158 RemoteAddress <<= 8;\r
159 RemoteAddress |= pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[1];\r
160 RemoteAddress <<= 8;\r
161 RemoteAddress |= pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[0];\r
162 pRemoteAddress->sin_addr.s_addr = RemoteAddress;\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 Process the remote connection completion event.\r
175\r
176 This routine handles the completion of a connection attempt. It\r
177 releases the port (TCPv4 adapter connection) in the case of an\r
178 error and start a connection attempt on the next port. If the\r
179 connection attempt was successful then this routine releases all\r
180 of the other ports.\r
181\r
182 This routine is called by the TCPv4 layer when a connect request\r
183 completes. It sets the ESL_SOCKET::bConnected flag to notify the\r
184 ::EslTcp4ConnectComplete routine that the connection is available.\r
185 The flag is set when the connection is established or no more ports\r
186 exist in the list. The connection status is passed via\r
187 ESL_SOCKET::ConnectStatus.\r
188\r
189 @param [in] Event The connect completion event\r
190\r
191 @param [in] pPort Address of an ::ESL_PORT structure.\r
192\r
193**/\r
194VOID\r
195EslTcp4ConnectComplete (\r
196 IN EFI_EVENT Event,\r
197 IN ESL_PORT * pPort\r
198 )\r
199{\r
200 BOOLEAN bRemoveFirstPort;\r
201 BOOLEAN bRemovePorts;\r
202 ESL_PORT * pNextPort;\r
203 ESL_SOCKET * pSocket;\r
204 ESL_TCP4_CONTEXT * pTcp4;\r
205 EFI_STATUS Status;\r
206\r
207 DBG_ENTER ( );\r
208\r
209 //\r
210 // Locate the TCP context\r
211 //\r
212 pSocket = pPort->pSocket;\r
213 pTcp4 = &pPort->Context.Tcp4;\r
214\r
215 //\r
216 // Get the connection status\r
217 //\r
218 bRemoveFirstPort = FALSE;\r
219 bRemovePorts = FALSE;\r
220 Status = pTcp4->ConnectToken.CompletionToken.Status;\r
221 pSocket->ConnectStatus = Status;\r
222 if ( !EFI_ERROR ( Status )) {\r
223 //\r
224 // The connection was successful\r
225 //\r
226 DEBUG (( DEBUG_CONNECT,\r
227 "0x%08x: Port connected to %d.%d.%d.%d:%d\r\n",\r
228 pPort,\r
229 pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[0],\r
230 pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[1],\r
231 pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[2],\r
232 pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[3],\r
233 pTcp4->ConfigData.AccessPoint.RemotePort ));\r
234\r
235 //\r
236 // Remove the rest of the ports\r
237 //\r
238 bRemovePorts = TRUE;\r
239 }\r
240 else {\r
241 //\r
242 // The connection failed\r
243 //\r
244 if ( pPort->bConfigured ) {\r
245 DEBUG (( DEBUG_CONNECT,\r
246 "0x%08x: Port connection to %d.%d.%d.%d:%d failed, Status: %r\r\n",\r
247 pPort,\r
248 pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[0],\r
249 pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[1],\r
250 pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[2],\r
251 pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[3],\r
252 pTcp4->ConfigData.AccessPoint.RemotePort,\r
253 Status ));\r
254 }\r
255\r
256 //\r
257 // Close the current port\r
258 //\r
259 Status = EslSocketPortClose ( pPort );\r
260 if ( !EFI_ERROR ( Status )) {\r
261 DEBUG (( DEBUG_CONNECT,\r
262 "0x%08x: Port closed\r\n",\r
263 pPort ));\r
264 }\r
265 else {\r
266 DEBUG (( DEBUG_CONNECT,\r
267 "ERROR - Failed to close port 0x%08x, Status: %r\r\n",\r
268 pPort,\r
269 Status ));\r
270 }\r
271\r
272 //\r
273 // Try to connect using the next port\r
274 //\r
275 Status = EslTcp4ConnectStart ( pSocket );\r
276 if ( EFI_NOT_READY != Status ) {\r
277 bRemoveFirstPort = TRUE;\r
278 }\r
279 }\r
280\r
281 //\r
282 // Remove the ports if necessary\r
283 //\r
284 if ( bRemoveFirstPort || bRemovePorts ) {\r
285 //\r
286 // Remove the first port if necessary\r
287 //\r
288 pPort = pSocket->pPortList;\r
289 if (( !bRemoveFirstPort ) && ( NULL != pPort )) {\r
290 pPort = pPort->pLinkSocket;\r
291 }\r
292\r
293 //\r
294 // Remove the rest of the list\r
295 //\r
296 while ( NULL != pPort ) {\r
297 pNextPort = pPort->pLinkSocket;\r
298 EslSocketPortClose ( pPort );\r
299 if ( !EFI_ERROR ( Status )) {\r
300 DEBUG (( DEBUG_CONNECT,\r
301 "0x%08x: Port closed\r\n",\r
302 pPort ));\r
303 }\r
304 else {\r
305 DEBUG (( DEBUG_CONNECT,\r
306 "ERROR - Failed to close port 0x%08x, Status: %r\r\n",\r
307 pPort,\r
308 Status ));\r
309 }\r
310 pPort = pNextPort;\r
311 }\r
312\r
313 //\r
314 // Notify the poll routine\r
315 //\r
316 pSocket->bConnected = TRUE;\r
317 }\r
318\r
319 DBG_EXIT ( );\r
320}\r
321\r
322\r
323/**\r
324 Poll for completion of the connection attempt.\r
325\r
326 This routine polls the ESL_SOCKET::bConnected flag to determine\r
327 when the connection attempt is complete.\r
328\r
329 This routine is called from ::EslSocketConnect to determine when\r
330 the connection is complete. The ESL_SOCKET::bConnected flag is\r
331 set by ::EslTcp4ConnectComplete when the TCPv4 layer establishes\r
332 a connection or runs out of local network adapters. This routine\r
333 gets the connection status from ESL_SOCKET::ConnectStatus.\r
334\r
335 @param [in] pSocket Address of an ::ESL_SOCKET structure.\r
336\r
337 @retval EFI_SUCCESS The connection was successfully established.\r
338 @retval EFI_NOT_READY The connection is in progress, call this routine again.\r
339 @retval Others The connection attempt failed.\r
340\r
341 **/\r
342EFI_STATUS\r
343EslTcp4ConnectPoll (\r
344 IN ESL_SOCKET * pSocket\r
345 )\r
346{\r
347 EFI_STATUS Status;\r
348\r
349 DBG_ENTER ( );\r
350\r
351 //\r
352 // Determine if the connection is complete\r
353 //\r
354 if ( !pSocket->bConnected ) {\r
355 //\r
356 // Not connected\r
357 //\r
358 pSocket->errno = EAGAIN;\r
359 Status = EFI_NOT_READY;\r
360 }\r
361 else {\r
362 //\r
363 // The connection processing is complete\r
364 //\r
365 pSocket->bConnected = FALSE;\r
366\r
367 //\r
368 // Translate the connection status\r
369 //\r
370 Status = pSocket->ConnectStatus;\r
371 switch ( Status ) {\r
372 default:\r
373 case EFI_DEVICE_ERROR:\r
374 pSocket->errno = EIO;\r
375 break;\r
376\r
377 case EFI_ABORTED:\r
378 pSocket->errno = ECONNABORTED;\r
379 break;\r
380\r
381 case EFI_ACCESS_DENIED:\r
382 pSocket->errno = EACCES;\r
383 break;\r
384\r
385 case EFI_CONNECTION_RESET:\r
386 pSocket->errno = ECONNRESET;\r
387 break;\r
388\r
389 case EFI_INVALID_PARAMETER:\r
390 pSocket->errno = EADDRNOTAVAIL;\r
391 break;\r
392\r
393 case EFI_HOST_UNREACHABLE:\r
394 case EFI_NO_RESPONSE:\r
395 pSocket->errno = EHOSTUNREACH;\r
396 break;\r
397\r
398 case EFI_NO_MAPPING:\r
399 pSocket->errno = EAFNOSUPPORT;\r
400 break;\r
401\r
402 case EFI_NO_MEDIA:\r
403 case EFI_NETWORK_UNREACHABLE:\r
404 pSocket->errno = ENETDOWN;\r
405 break;\r
406\r
407 case EFI_OUT_OF_RESOURCES:\r
408 pSocket->errno = ENOBUFS;\r
409 break;\r
410\r
411 case EFI_PORT_UNREACHABLE:\r
412 case EFI_PROTOCOL_UNREACHABLE:\r
413 case EFI_CONNECTION_REFUSED:\r
414 pSocket->errno = ECONNREFUSED;\r
415 break;\r
416\r
417 case EFI_SUCCESS:\r
418 pSocket->errno = 0;\r
419 pSocket->bConfigured = TRUE;\r
420 break;\r
421\r
422 case EFI_TIMEOUT:\r
423 pSocket->errno = ETIMEDOUT;\r
424 break;\r
425\r
426 case EFI_UNSUPPORTED:\r
427 pSocket->errno = EOPNOTSUPP;\r
428 break;\r
429 }\r
430\r
431 //\r
432 // Display the translation\r
433 //\r
434 DEBUG (( DEBUG_CONNECT,\r
435 "ERROR - errno: %d, Status: %r\r\n",\r
436 pSocket->errno,\r
437 Status ));\r
438 }\r
439\r
440 //\r
441 // Return the initialization status\r
442 //\r
443 DBG_EXIT_STATUS ( Status );\r
444 return Status;\r
445}\r
446\r
447\r
448/**\r
449 Attempt to connect to a remote TCP port\r
450\r
451 This routine starts the connection processing for a SOCK_STREAM\r
452 or SOCK_SEQPAKCET socket using the TCPv4 network layer. It\r
453 configures the local TCPv4 connection point and then attempts to\r
454 connect to a remote system. Upon completion, the\r
455 ::EslTcp4ConnectComplete routine gets called with the connection\r
456 status.\r
457\r
458 This routine is called by ::EslSocketConnect to initiate the TCPv4\r
459 network specific connect operations. The connection processing is\r
460 initiated by this routine and finished by ::EslTcp4ConnectComplete.\r
461 This pair of routines walks through the list of local TCPv4\r
462 connection points until a connection to the remote system is\r
463 made.\r
464\r
465 @param [in] pSocket Address of an ::ESL_SOCKET structure.\r
466\r
467 @retval EFI_SUCCESS The connection was successfully established.\r
468 @retval EFI_NOT_READY The connection is in progress, call this routine again.\r
469 @retval Others The connection attempt failed.\r
470\r
471 **/\r
472EFI_STATUS\r
473EslTcp4ConnectStart (\r
474 IN ESL_SOCKET * pSocket\r
475 )\r
476{\r
477 ESL_PORT * pPort;\r
478 ESL_TCP4_CONTEXT * pTcp4;\r
479 EFI_TCP4_PROTOCOL * pTcp4Protocol;\r
480 EFI_SIMPLE_NETWORK_MODE SnpModeData;\r
481 EFI_STATUS Status;\r
482\r
483 DBG_ENTER ( );\r
484 \r
485 //\r
486 // Determine if any more local adapters are available\r
487 //\r
488 pPort = pSocket->pPortList;\r
489 if ( NULL != pPort ) {\r
490 //\r
491 // Configure the port\r
492 //\r
493 pTcp4 = &pPort->Context.Tcp4;\r
494 pTcp4->ConfigData.AccessPoint.ActiveFlag = TRUE;\r
495 pTcp4->ConfigData.TimeToLive = 255;\r
496 pTcp4Protocol = pPort->pProtocol.TCPv4;\r
497 Status = pTcp4Protocol->Configure ( pTcp4Protocol,\r
498 &pTcp4->ConfigData );\r
499 if ( EFI_ERROR ( Status )) {\r
500 DEBUG (( DEBUG_CONNECT,\r
501 "ERROR - Failed to configure the Tcp4 port, Status: %r\r\n",\r
502 Status ));\r
503 }\r
504 else {\r
505 DEBUG (( DEBUG_CONNECT,\r
506 "0x%08x: Port configured\r\n",\r
507 pPort ));\r
508 pPort->bConfigured = TRUE;\r
509\r
510 //\r
511 // Verify the port connection\r
512 //\r
513 Status = pTcp4Protocol->GetModeData ( pTcp4Protocol,\r
514 NULL,\r
515 NULL,\r
516 NULL,\r
517 NULL,\r
518 &SnpModeData );\r
519 if ( !EFI_ERROR ( Status )) {\r
520 if ( SnpModeData.MediaPresentSupported\r
521 && ( !SnpModeData.MediaPresent )) {\r
522 //\r
523 // Port is not connected to the network\r
524 //\r
525 Status = EFI_NO_MEDIA;\r
526 }\r
527 else {\r
528 //\r
529 // Attempt the connection to the remote system\r
530 //\r
531 Status = pTcp4Protocol->Connect ( pTcp4Protocol,\r
532 &pTcp4->ConnectToken );\r
533 }\r
534 }\r
535 if ( EFI_ERROR ( Status )) {\r
536 //\r
537 // Connection error\r
538 //\r
539 DEBUG (( DEBUG_CONNECT,\r
540 "ERROR - Port 0x%08x not connected, Status: %r\r\n",\r
541 pPort,\r
542 Status ));\r
543 }\r
544 }\r
545 if ( !EFI_ERROR ( Status )) {\r
546 //\r
547 // Connection in progress\r
548 //\r
549 pSocket->errno = EINPROGRESS;\r
550 DEBUG (( DEBUG_CONNECT,\r
551 "0x%08x: Port attempting connection to %d.%d.%d.%d:%d\r\n",\r
552 pPort,\r
553 pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[0],\r
554 pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[1],\r
555 pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[2],\r
556 pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[3],\r
557 pTcp4->ConfigData.AccessPoint.RemotePort ));\r
558 }\r
559 else {\r
560 //\r
561 // Error return path is through EslTcp4ConnectComplete to\r
562 // enable retry on other ports\r
563 //\r
564 // Status to errno translation gets done in EslTcp4ConnectPoll\r
565 //\r
566 pTcp4->ConnectToken.CompletionToken.Status = Status;\r
567\r
568 //\r
569 // Continue with the next port\r
570 //\r
571 gBS->CheckEvent ( pTcp4->ConnectToken.CompletionToken.Event );\r
572 gBS->SignalEvent ( pTcp4->ConnectToken.CompletionToken.Event );\r
573 }\r
574 Status = EFI_NOT_READY;\r
575 }\r
576 else {\r
577 //\r
578 // No more local adapters available\r
579 //\r
580 pSocket->errno = ENETUNREACH;\r
581 Status = EFI_NO_RESPONSE;\r
582 }\r
583\r
584 //\r
585 // Return the operation status\r
586 //\r
587 DBG_EXIT_STATUS ( Status );\r
588 return Status;\r
589}\r
590\r
591\r
592/**\r
593 Establish the known port to listen for network connections.\r
594\r
595 This routine places the port into a state that enables connection\r
596 attempts.\r
597\r
598 This routine is called by ::EslSocketListen to handle the network\r
599 specifics of the listen operation for SOCK_STREAM and SOCK_SEQPACKET\r
600 sockets. See the \ref ConnectionManagement section.\r
601\r
602 @param [in] pSocket Address of an ::ESL_SOCKET structure.\r
603\r
604 @retval EFI_SUCCESS - Socket successfully created\r
605 @retval Other - Failed to enable the socket for listen\r
606\r
607**/\r
608EFI_STATUS\r
609EslTcp4Listen (\r
610 IN ESL_SOCKET * pSocket\r
611 )\r
612{\r
613 ESL_PORT * pNextPort;\r
614 ESL_PORT * pPort;\r
615 ESL_TCP4_CONTEXT * pTcp4;\r
616 EFI_TCP4_PROTOCOL * pTcp4Protocol;\r
617 EFI_STATUS Status;\r
618\r
619 DBG_ENTER ( );\r
620\r
621 //\r
622 // Verify the socket layer synchronization\r
623 //\r
624 VERIFY_TPL ( TPL_SOCKETS );\r
625\r
626 //\r
627 // Use for/break instead of goto\r
628 //\r
629 for ( ; ; ) {\r
630 //\r
631 // Assume no ports are available\r
632 //\r
633 pSocket->errno = EOPNOTSUPP;\r
634 Status = EFI_NOT_READY;\r
635\r
636 //\r
637 // Walk the list of ports\r
638 //\r
639 pPort = pSocket->pPortList;\r
640 while ( NULL != pPort ) {\r
641 //\r
642 // Assume success\r
643 //\r
644 pSocket->errno = 0;\r
645\r
646 //\r
647 // Use for/break insteak of goto\r
648 //\r
649 for ( ; ; ) {\r
650 //\r
651 // Create the listen completion event\r
652 //\r
653 pTcp4 = &pPort->Context.Tcp4;\r
654 Status = gBS->CreateEvent ( EVT_NOTIFY_SIGNAL,\r
655 TPL_SOCKETS,\r
656 (EFI_EVENT_NOTIFY)EslTcp4ListenComplete,\r
657 pPort,\r
658 &pTcp4->ListenToken.CompletionToken.Event );\r
659 if ( EFI_ERROR ( Status )) {\r
660 DEBUG (( DEBUG_ERROR | DEBUG_LISTEN,\r
661 "ERROR - Failed to create the listen completion event, Status: %r\r\n",\r
662 Status ));\r
663 pSocket->errno = ENOMEM;\r
664 break;\r
665 }\r
666 DEBUG (( DEBUG_POOL,\r
667 "0x%08x: Created listen completion event\r\n",\r
668 pTcp4->ListenToken.CompletionToken.Event ));\r
669\r
670 //\r
671 // Configure the port\r
672 //\r
673 pTcp4Protocol = pPort->pProtocol.TCPv4;\r
674 Status = pTcp4Protocol->Configure ( pTcp4Protocol,\r
675 &pTcp4->ConfigData );\r
676 if ( EFI_ERROR ( Status )) {\r
677 DEBUG (( DEBUG_LISTEN,\r
678 "ERROR - Failed to configure the Tcp4 port, Status: %r\r\n",\r
679 Status ));\r
680 switch ( Status ) {\r
681 case EFI_ACCESS_DENIED:\r
682 pSocket->errno = EACCES;\r
683 break;\r
684\r
685 default:\r
686 case EFI_DEVICE_ERROR:\r
687 pSocket->errno = EIO;\r
688 break;\r
689\r
690 case EFI_INVALID_PARAMETER:\r
691 pSocket->errno = EADDRNOTAVAIL;\r
692 break;\r
693\r
694 case EFI_NO_MAPPING:\r
695 pSocket->errno = EAFNOSUPPORT;\r
696 break;\r
697\r
698 case EFI_OUT_OF_RESOURCES:\r
699 pSocket->errno = ENOBUFS;\r
700 break;\r
701\r
702 case EFI_UNSUPPORTED:\r
703 pSocket->errno = EOPNOTSUPP;\r
704 break;\r
705 }\r
706 break;\r
707 }\r
708 DEBUG (( DEBUG_LISTEN,\r
709 "0x%08x: Port configured\r\n",\r
710 pPort ));\r
711 pPort->bConfigured = TRUE;\r
712\r
713 //\r
714 // Start the listen operation on the port\r
715 //\r
716 Status = pTcp4Protocol->Accept ( pTcp4Protocol,\r
717 &pTcp4->ListenToken );\r
718 if ( EFI_ERROR ( Status )) {\r
719 DEBUG (( DEBUG_LISTEN,\r
720 "ERROR - Failed Tcp4 accept, Status: %r\r\n",\r
721 Status ));\r
722 switch ( Status ) {\r
723 case EFI_ACCESS_DENIED:\r
724 pSocket->errno = EACCES;\r
725 break;\r
726\r
727 default:\r
728 case EFI_DEVICE_ERROR:\r
729 pSocket->errno = EIO;\r
730 break;\r
731\r
732 case EFI_INVALID_PARAMETER:\r
733 pSocket->errno = EADDRNOTAVAIL;\r
734 break;\r
735\r
736 case EFI_NOT_STARTED:\r
737 pSocket->errno = ENETDOWN;\r
738 break;\r
739\r
740 case EFI_OUT_OF_RESOURCES:\r
741 pSocket->errno = ENOBUFS;\r
742 break;\r
743 }\r
744 break;\r
745 }\r
746 DEBUG (( DEBUG_LISTEN,\r
747 "0x%08x: Listen pending on Port\r\n",\r
748 pPort ));\r
749\r
750 //\r
751 // Listen is pending on this port\r
752 //\r
753 break;\r
754 }\r
755\r
756 //\r
757 // Get the next port\r
758 //\r
759 pNextPort = pPort->pLinkSocket;\r
760\r
761 //\r
762 // Close the port upon error\r
763 //\r
764 if ( EFI_ERROR ( Status )) {\r
765 EslSocketPortCloseStart ( pPort, TRUE, DEBUG_LISTEN );\r
766 }\r
767\r
768 //\r
769 // Set the next port\r
770 //\r
771 pPort = pNextPort;\r
772 }\r
773 \r
774 //\r
775 // Determine if any ports are in the listen state\r
776 //\r
777 if ( NULL == pSocket->pPortList ) {\r
778 //\r
779 // No ports in the listen state\r
780 //\r
781 pSocket->MaxFifoDepth = 0;\r
782\r
783 //\r
784 // Return the last error detected\r
785 //\r
786 break;\r
787 }\r
788\r
789 //\r
790 // Mark the socket as configured\r
791 //\r
792 pSocket->bConfigured = TRUE;\r
793\r
794 //\r
795 // All done\r
796 //\r
797 DEBUG (( DEBUG_LISTEN,\r
798 "0x%08x: pSocket - Listen pending on socket\r\n",\r
799 pSocket ));\r
800 break;\r
801 }\r
802\r
803 //\r
804 // Return the operation status\r
805 //\r
806 DBG_EXIT_STATUS ( Status );\r
807 return Status;\r
808}\r
809\r
810\r
811/**\r
812 Process the connection attempt\r
813\r
814 A system has initiated a connection attempt with a socket in the\r
815 listen state. Attempt to complete the connection.\r
816\r
817 The TCPv4 layer calls this routine when a connection is made to\r
818 the socket in the listen state. See the\r
819 \ref ConnectionManagement section.\r
820\r
821 @param [in] Event The listen completion event\r
822\r
823 @param [in] pPort Address of an ::ESL_PORT structure.\r
824\r
825**/\r
826VOID\r
827EslTcp4ListenComplete (\r
828 IN EFI_EVENT Event,\r
829 IN ESL_PORT * pPort\r
830 )\r
831{\r
832 EFI_HANDLE ChildHandle;\r
833 struct sockaddr_in LocalAddress;\r
834 EFI_TCP4_CONFIG_DATA * pConfigData;\r
835 ESL_LAYER * pLayer;\r
836 ESL_PORT * pNewPort;\r
837 ESL_SOCKET * pNewSocket;\r
838 ESL_SOCKET * pSocket;\r
839 ESL_TCP4_CONTEXT * pTcp4;\r
840 EFI_TCP4_PROTOCOL * pTcp4Protocol;\r
841 EFI_STATUS Status;\r
842 EFI_HANDLE TcpPortHandle;\r
843 EFI_STATUS TempStatus;\r
844\r
845 DBG_ENTER ( );\r
846 VERIFY_AT_TPL ( TPL_SOCKETS );\r
847\r
848 //\r
849 // Assume success\r
850 //\r
851 Status = EFI_SUCCESS;\r
852\r
853 //\r
854 // Determine if this connection fits into the connection FIFO\r
855 //\r
856 pSocket = pPort->pSocket;\r
857 TcpPortHandle = pPort->Context.Tcp4.ListenToken.NewChildHandle;\r
858 if (( SOCKET_STATE_LISTENING == pSocket->State )\r
859 && ( pSocket->MaxFifoDepth > pSocket->FifoDepth )) {\r
860 //\r
861 // Allocate a socket for this connection\r
862 //\r
863 ChildHandle = NULL;\r
864 pLayer = &mEslLayer;\r
865 Status = EslSocketAllocate ( &ChildHandle,\r
866 DEBUG_CONNECTION,\r
867 &pNewSocket );\r
868 if ( !EFI_ERROR ( Status )) {\r
869 //\r
870 // Clone the socket parameters\r
871 //\r
872 pNewSocket->pApi = pSocket->pApi;\r
873 pNewSocket->Domain = pSocket->Domain;\r
874 pNewSocket->Protocol = pSocket->Protocol;\r
875 pNewSocket->Type = pSocket->Type;\r
876\r
877 //\r
878 // Build the local address\r
879 //\r
880 pTcp4 = &pPort->Context.Tcp4;\r
881 LocalAddress.sin_len = (uint8_t)pNewSocket->pApi->MinimumAddressLength;\r
882 LocalAddress.sin_family = AF_INET;\r
883 LocalAddress.sin_port = 0;\r
884 LocalAddress.sin_addr.s_addr = *(UINT32 *)&pTcp4->ConfigData.AccessPoint.StationAddress.Addr[0];\r
885\r
886 //\r
887 // Allocate a port for this connection\r
888 // Note in this instance Configure may not be called with NULL!\r
889 //\r
890 Status = EslSocketPortAllocate ( pNewSocket,\r
891 pPort->pService,\r
892 TcpPortHandle,\r
893 (struct sockaddr *)&LocalAddress,\r
894 FALSE,\r
895 DEBUG_CONNECTION,\r
896 &pNewPort );\r
897 if ( !EFI_ERROR ( Status )) {\r
898 //\r
899 // Restart the listen operation on the port\r
900 //\r
901 pTcp4Protocol = pPort->pProtocol.TCPv4;\r
902 Status = pTcp4Protocol->Accept ( pTcp4Protocol,\r
903 &pTcp4->ListenToken );\r
904\r
905 //\r
906 // Close the TCP port using SocketClose\r
907 //\r
908 TcpPortHandle = NULL;\r
909 pTcp4 = &pNewPort->Context.Tcp4;\r
910\r
911 //\r
912 // Check for an accept call error\r
913 //\r
914 if ( !EFI_ERROR ( Status )) {\r
915 //\r
916 // Get the port configuration\r
917 //\r
918 pNewPort->bConfigured = TRUE;\r
919 pConfigData = &pTcp4->ConfigData;\r
920 pConfigData->ControlOption = &pTcp4->Option;\r
921 pTcp4Protocol = pNewPort->pProtocol.TCPv4;\r
922 Status = pTcp4Protocol->GetModeData ( pTcp4Protocol,\r
923 NULL,\r
924 pConfigData,\r
925 NULL,\r
926 NULL,\r
927 NULL );\r
928 if ( !EFI_ERROR ( Status )) {\r
929 //\r
930 // Add the new socket to the connection FIFO\r
931 //\r
932 if ( NULL == pSocket->pFifoTail ) {\r
933 //\r
934 // First connection\r
935 //\r
936 pSocket->pFifoHead = pNewSocket;\r
937 }\r
938 else {\r
939 //\r
940 // Add to end of list.\r
941 //\r
942 pSocket->pFifoTail->pNextConnection = pNewSocket;\r
943 }\r
944 pSocket->pFifoTail = pNewSocket;\r
945 pSocket->FifoDepth += 1;\r
946\r
947 //\r
948 // Update the socket state\r
949 //\r
950 pNewSocket->State = SOCKET_STATE_IN_FIFO;\r
951\r
952 //\r
953 // Log the connection\r
954 //\r
955 DEBUG (( DEBUG_CONNECTION | DEBUG_INFO,\r
956 "0x%08x: Socket on port %d.%d.%d.%d:%d connected to %d.%d.%d.%d:%d\r\n",\r
957 pNewSocket,\r
958 pConfigData->AccessPoint.StationAddress.Addr[0],\r
959 pConfigData->AccessPoint.StationAddress.Addr[1],\r
960 pConfigData->AccessPoint.StationAddress.Addr[2],\r
961 pConfigData->AccessPoint.StationAddress.Addr[3],\r
962 pConfigData->AccessPoint.StationPort,\r
963 pConfigData->AccessPoint.RemoteAddress.Addr[0],\r
964 pConfigData->AccessPoint.RemoteAddress.Addr[1],\r
965 pConfigData->AccessPoint.RemoteAddress.Addr[2],\r
966 pConfigData->AccessPoint.RemoteAddress.Addr[3],\r
967 pConfigData->AccessPoint.RemotePort ));\r
968 DEBUG (( DEBUG_CONNECTION | DEBUG_INFO,\r
969 "0x%08x: Listen socket adding socket 0x%08x to FIFO, depth: %d\r\n",\r
970 pSocket,\r
971 pNewSocket,\r
972 pSocket->FifoDepth ));\r
973\r
974 //\r
975 // Start the receive operation\r
976 //\r
977 EslSocketRxStart ( pNewPort );\r
978 }\r
979 else {\r
980 DEBUG (( DEBUG_ERROR | DEBUG_CONNECTION | DEBUG_INFO,\r
981 "ERROR - GetModeData failed on port 0x%08x, Status: %r\r\n",\r
982 pNewPort,\r
983 Status ));\r
984 }\r
985 }\r
986 else {\r
987 //\r
988 // The listen failed on this port\r
989 //\r
990 DEBUG (( DEBUG_LISTEN | DEBUG_INFO,\r
991 "ERROR - Listen failed on port 0x%08x, Status: %r\r\n",\r
992 pPort,\r
993 Status ));\r
994\r
995 //\r
996 // Close the listening port\r
997 //\r
998 EslSocketPortCloseStart ( pPort, TRUE, DEBUG_LISTEN );\r
999 }\r
1000 }\r
1001\r
1002 //\r
1003 // Done with the socket if necessary\r
1004 //\r
1005 if ( EFI_ERROR ( Status )) {\r
1006 TempStatus = EslSocketCloseStart ( &pNewSocket->SocketProtocol,\r
1007 TRUE,\r
1008 &pSocket->errno );\r
1009 ASSERT ( EFI_SUCCESS == TempStatus );\r
1010 }\r
1011 }\r
1012 }\r
1013 else {\r
1014 DEBUG (( DEBUG_CONNECTION,\r
1015 "0x%08x: Socket FIFO full, connection refused\r\n",\r
1016 pSocket ));\r
1017\r
1018 //\r
1019 // The FIFO is full or the socket is in the wrong state\r
1020 //\r
1021 Status = EFI_BUFFER_TOO_SMALL;\r
1022 }\r
1023\r
1024 //\r
1025 // Close the connection if necessary\r
1026 //\r
1027 if (( EFI_ERROR ( Status ))\r
1028 && ( NULL == TcpPortHandle )) {\r
1029 //\r
1030 // TODO: Finish this code path\r
1031 // The new connection does not fit into the connection FIFO\r
1032 //\r
1033 // Process:\r
1034 // Call close\r
1035 // Release the resources\r
1036 \r
1037 }\r
1038\r
1039 DBG_EXIT ( );\r
1040}\r
1041\r
1042\r
1043/**\r
1044 Get the local socket address.\r
1045\r
1046 This routine returns the IPv4 address and TCP port number associated\r
1047 with the local socket.\r
1048\r
1049 This routine is called by ::EslSocketGetLocalAddress to determine the\r
1050 network address for the SOCK_STREAM or SOCK_SEQPACKET socket.\r
1051\r
1052 @param [in] pPort Address of an ::ESL_PORT structure.\r
1053\r
1054 @param [out] pSockAddr Network address to receive the local system address\r
1055\r
1056**/\r
1057VOID\r
1058EslTcp4LocalAddressGet (\r
1059 IN ESL_PORT * pPort,\r
1060 OUT struct sockaddr * pSockAddr\r
1061 )\r
1062{\r
1063 struct sockaddr_in * pLocalAddress;\r
1064 ESL_TCP4_CONTEXT * pTcp4;\r
1065\r
1066 DBG_ENTER ( );\r
1067\r
1068 //\r
1069 // Return the local address\r
1070 //\r
1071 pTcp4 = &pPort->Context.Tcp4;\r
1072 pLocalAddress = (struct sockaddr_in *)pSockAddr;\r
1073 pLocalAddress->sin_family = AF_INET;\r
1074 pLocalAddress->sin_port = SwapBytes16 ( pTcp4->ConfigData.AccessPoint.StationPort );\r
1075 CopyMem ( &pLocalAddress->sin_addr,\r
1076 &pTcp4->ConfigData.AccessPoint.StationAddress.Addr[0],\r
1077 sizeof ( pLocalAddress->sin_addr ));\r
1078\r
1079 DBG_EXIT ( );\r
1080}\r
1081\r
1082\r
1083/**\r
1084 Set the local port address.\r
1085\r
1086 This routine sets the local port address.\r
1087\r
1088 This support routine is called by ::EslSocketPortAllocate.\r
1089\r
1090 @param [in] pPort Address of an ESL_PORT structure\r
1091 @param [in] pSockAddr Address of a sockaddr structure that contains the\r
1092 connection point on the local machine. An IPv4 address\r
1093 of INADDR_ANY specifies that the connection is made to\r
1094 all of the network stacks on the platform. Specifying a\r
1095 specific IPv4 address restricts the connection to the\r
1096 network stack supporting that address. Specifying zero\r
1097 for the port causes the network layer to assign a port\r
1098 number from the dynamic range. Specifying a specific\r
1099 port number causes the network layer to use that port.\r
1100\r
1101 @param [in] bBindTest TRUE = run bind testing\r
1102\r
1103 @retval EFI_SUCCESS The operation was successful\r
1104\r
1105 **/\r
1106EFI_STATUS\r
1107EslTcp4LocalAddressSet (\r
1108 IN ESL_PORT * pPort,\r
1109 IN CONST struct sockaddr * pSockAddr,\r
1110 IN BOOLEAN bBindTest\r
1111 )\r
1112{\r
1113 EFI_TCP4_ACCESS_POINT * pAccessPoint;\r
1114 CONST struct sockaddr_in * pIpAddress;\r
1115 CONST UINT8 * pIpv4Address;\r
1116 EFI_STATUS Status;\r
1117\r
1118 DBG_ENTER ( );\r
1119\r
1120 //\r
1121 // Validate the address\r
1122 //\r
1123 pIpAddress = (struct sockaddr_in *)pSockAddr;\r
1124 if ( INADDR_BROADCAST == pIpAddress->sin_addr.s_addr ) {\r
1125 //\r
1126 // The local address must not be the broadcast address\r
1127 //\r
1128 Status = EFI_INVALID_PARAMETER;\r
1129 pPort->pSocket->errno = EADDRNOTAVAIL;\r
1130 }\r
1131 else {\r
1132 //\r
1133 // Set the local address\r
1134 //\r
1135 pIpv4Address = (UINT8 *)&pIpAddress->sin_addr.s_addr;\r
1136 pAccessPoint = &pPort->Context.Tcp4.ConfigData.AccessPoint;\r
1137 pAccessPoint->StationAddress.Addr[0] = pIpv4Address[0];\r
1138 pAccessPoint->StationAddress.Addr[1] = pIpv4Address[1];\r
1139 pAccessPoint->StationAddress.Addr[2] = pIpv4Address[2];\r
1140 pAccessPoint->StationAddress.Addr[3] = pIpv4Address[3];\r
1141\r
1142 //\r
1143 // Determine if the default address is used\r
1144 //\r
1145 pAccessPoint->UseDefaultAddress = (BOOLEAN)( 0 == pIpAddress->sin_addr.s_addr );\r
1146 \r
1147 //\r
1148 // Set the subnet mask\r
1149 //\r
1150 if ( pAccessPoint->UseDefaultAddress ) {\r
1151 pAccessPoint->SubnetMask.Addr[0] = 0;\r
1152 pAccessPoint->SubnetMask.Addr[1] = 0;\r
1153 pAccessPoint->SubnetMask.Addr[2] = 0;\r
1154 pAccessPoint->SubnetMask.Addr[3] = 0;\r
1155 }\r
1156 else {\r
1157 pAccessPoint->SubnetMask.Addr[0] = 0xff;\r
1158 pAccessPoint->SubnetMask.Addr[1] = 0xff;\r
1159 pAccessPoint->SubnetMask.Addr[2] = 0xff;\r
1160 pAccessPoint->SubnetMask.Addr[3] = 0xff;\r
1161 }\r
1162\r
1163 //\r
1164 // Validate the IP address\r
1165 //\r
1166 pAccessPoint->StationPort = 0;\r
1167 Status = bBindTest ? EslSocketBindTest ( pPort, EADDRNOTAVAIL )\r
1168 : EFI_SUCCESS;\r
1169 if ( !EFI_ERROR ( Status )) {\r
1170 //\r
1171 // Set the port number\r
1172 //\r
1173 pAccessPoint->StationPort = SwapBytes16 ( pIpAddress->sin_port );\r
1174 pPort->pSocket->bAddressSet = TRUE;\r
1175\r
1176 //\r
1177 // Display the local address\r
1178 //\r
1179 DEBUG (( DEBUG_BIND,\r
1180 "0x%08x: Port, Local TCP4 Address: %d.%d.%d.%d:%d\r\n",\r
1181 pPort,\r
1182 pAccessPoint->StationAddress.Addr[0],\r
1183 pAccessPoint->StationAddress.Addr[1],\r
1184 pAccessPoint->StationAddress.Addr[2],\r
1185 pAccessPoint->StationAddress.Addr[3],\r
1186 pAccessPoint->StationPort ));\r
1187 }\r
1188 }\r
1189\r
1190 //\r
1191 // Return the operation status\r
1192 //\r
1193 DBG_EXIT_STATUS ( Status );\r
1194 return Status;\r
1195}\r
1196\r
1197\r
1198/**\r
1199 Free a receive packet\r
1200\r
1201 This routine performs the network specific operations necessary\r
1202 to free a receive packet.\r
1203\r
1204 This routine is called by ::EslSocketPortCloseTxDone to free a\r
1205 receive packet.\r
1206\r
1207 @param [in] pPacket Address of an ::ESL_PACKET structure.\r
1208 @param [in, out] pRxBytes Address of the count of RX bytes\r
1209\r
1210**/\r
1211VOID\r
1212EslTcp4PacketFree (\r
1213 IN ESL_PACKET * pPacket,\r
1214 IN OUT size_t * pRxBytes\r
1215 )\r
1216{\r
1217 DBG_ENTER ( );\r
1218\r
1219 //\r
1220 // Account for the receive bytes\r
1221 //\r
1222 *pRxBytes -= pPacket->Op.Tcp4Rx.RxData.DataLength;\r
1223 DBG_EXIT ( );\r
1224}\r
1225\r
1226\r
1227/**\r
1228 Initialize the network specific portions of an ::ESL_PORT structure.\r
1229\r
1230 This routine initializes the network specific portions of an\r
1231 ::ESL_PORT structure for use by the socket.\r
1232\r
1233 This support routine is called by ::EslSocketPortAllocate\r
1234 to connect the socket with the underlying network adapter\r
1235 running the TCPv4 protocol.\r
1236\r
1237 @param [in] pPort Address of an ESL_PORT structure\r
1238 @param [in] DebugFlags Flags for debug messages\r
1239\r
1240 @retval EFI_SUCCESS - Socket successfully created\r
1241\r
1242 **/\r
1243EFI_STATUS\r
1244EslTcp4PortAllocate (\r
1245 IN ESL_PORT * pPort,\r
1246 IN UINTN DebugFlags\r
1247 )\r
1248{\r
1249 EFI_TCP4_ACCESS_POINT * pAccessPoint;\r
1250 ESL_SOCKET * pSocket;\r
1251 ESL_TCP4_CONTEXT * pTcp4;\r
1252 EFI_STATUS Status;\r
1253\r
1254 DBG_ENTER ( );\r
1255\r
1256 //\r
1257 // Use for/break instead of goto\r
1258 for ( ; ; ) {\r
1259 //\r
1260 // Allocate the close event\r
1261 //\r
1262 pSocket = pPort->pSocket;\r
1263 pTcp4 = &pPort->Context.Tcp4;\r
1264 Status = gBS->CreateEvent ( EVT_NOTIFY_SIGNAL,\r
1265 TPL_SOCKETS,\r
1266 (EFI_EVENT_NOTIFY)EslSocketPortCloseComplete,\r
1267 pPort,\r
1268 &pTcp4->CloseToken.CompletionToken.Event);\r
1269 if ( EFI_ERROR ( Status )) {\r
1270 DEBUG (( DEBUG_ERROR | DebugFlags,\r
1271 "ERROR - Failed to create the close event, Status: %r\r\n",\r
1272 Status ));\r
1273 pSocket->errno = ENOMEM;\r
1274 break;\r
1275 }\r
1276 DEBUG (( DEBUG_CLOSE | DEBUG_POOL,\r
1277 "0x%08x: Created close event\r\n",\r
1278 pTcp4->CloseToken.CompletionToken.Event ));\r
1279\r
1280 //\r
1281 // Allocate the connection event\r
1282 //\r
1283 Status = gBS->CreateEvent ( EVT_NOTIFY_SIGNAL,\r
1284 TPL_SOCKETS,\r
1285 (EFI_EVENT_NOTIFY)EslTcp4ConnectComplete,\r
1286 pPort,\r
1287 &pTcp4->ConnectToken.CompletionToken.Event);\r
1288 if ( EFI_ERROR ( Status )) {\r
1289 DEBUG (( DEBUG_ERROR | DebugFlags,\r
1290 "ERROR - Failed to create the connect event, Status: %r\r\n",\r
1291 Status ));\r
1292 pSocket->errno = ENOMEM;\r
1293 break;\r
1294 }\r
1295 DEBUG (( DEBUG_CLOSE | DEBUG_POOL,\r
1296 "0x%08x: Created connect event\r\n",\r
1297 pTcp4->ConnectToken.CompletionToken.Event ));\r
1298\r
1299 //\r
1300 // Initialize the port\r
1301 //\r
1302 pSocket->TxPacketOffset = OFFSET_OF ( ESL_PACKET, Op.Tcp4Tx.TxData );\r
1303 pSocket->TxTokenEventOffset = OFFSET_OF ( ESL_IO_MGMT, Token.Tcp4Tx.CompletionToken.Event );\r
1304 pSocket->TxTokenOffset = OFFSET_OF ( EFI_TCP4_IO_TOKEN, Packet.TxData );\r
1305\r
1306 //\r
1307 // Save the cancel, receive and transmit addresses\r
1308 // pPort->pfnRxCancel = NULL; since the UEFI implementation returns EFI_UNSUPPORTED\r
1309 //\r
1310 pPort->pfnConfigure = (PFN_NET_CONFIGURE)pPort->pProtocol.TCPv4->Configure;\r
1311 pPort->pfnRxPoll = (PFN_NET_POLL)pPort->pProtocol.TCPv4->Poll;\r
1312 pPort->pfnRxStart = (PFN_NET_IO_START)pPort->pProtocol.TCPv4->Receive;\r
1313 pPort->pfnTxStart = (PFN_NET_IO_START)pPort->pProtocol.TCPv4->Transmit;\r
1314\r
1315 //\r
1316 // Set the configuration flags\r
1317 //\r
1318 pAccessPoint = &pPort->Context.Tcp4.ConfigData.AccessPoint;\r
1319 pAccessPoint->ActiveFlag = FALSE;\r
1320 pTcp4->ConfigData.TimeToLive = 255;\r
1321 break;\r
1322 }\r
1323\r
1324 //\r
1325 // Return the operation status\r
1326 //\r
1327 DBG_EXIT_STATUS ( Status );\r
1328 return Status;\r
1329}\r
1330\r
1331\r
1332/**\r
1333 Close a TCP4 port.\r
1334\r
1335 This routine releases the network specific resources allocated by\r
1336 ::EslTcp4PortAllocate.\r
1337\r
1338 This routine is called by ::EslSocketPortClose.\r
1339 See the \ref PortCloseStateMachine section.\r
1340 \r
1341 @param [in] pPort Address of an ::ESL_PORT structure.\r
1342\r
1343 @retval EFI_SUCCESS The port is closed\r
1344 @retval other Port close error\r
1345\r
1346**/\r
1347EFI_STATUS\r
1348EslTcp4PortClose (\r
1349 IN ESL_PORT * pPort\r
1350 )\r
1351{\r
1352 UINTN DebugFlags;\r
1353 ESL_TCP4_CONTEXT * pTcp4;\r
1354 EFI_STATUS Status;\r
1355 \r
1356 DBG_ENTER ( );\r
1357\r
1358 //\r
1359 // Locate the port in the socket list\r
1360 //\r
1361 Status = EFI_SUCCESS;\r
1362 DebugFlags = pPort->DebugFlags;\r
1363 pTcp4 = &pPort->Context.Tcp4;\r
1364\r
1365 //\r
1366 // Done with the connect event\r
1367 //\r
1368 if ( NULL != pTcp4->ConnectToken.CompletionToken.Event ) {\r
1369 Status = gBS->CloseEvent ( pTcp4->ConnectToken.CompletionToken.Event );\r
1370 if ( !EFI_ERROR ( Status )) {\r
1371 DEBUG (( DebugFlags | DEBUG_POOL,\r
1372 "0x%08x: Closed connect event\r\n",\r
1373 pTcp4->ConnectToken.CompletionToken.Event ));\r
1374 }\r
1375 else {\r
1376 DEBUG (( DEBUG_ERROR | DebugFlags,\r
1377 "ERROR - Failed to close the connect event, Status: %r\r\n",\r
1378 Status ));\r
1379 ASSERT ( EFI_SUCCESS == Status );\r
1380 }\r
1381 }\r
1382\r
1383 //\r
1384 // Done with the close event\r
1385 //\r
1386 if ( NULL != pTcp4->CloseToken.CompletionToken.Event ) {\r
1387 Status = gBS->CloseEvent ( pTcp4->CloseToken.CompletionToken.Event );\r
1388 if ( !EFI_ERROR ( Status )) {\r
1389 DEBUG (( DebugFlags | DEBUG_POOL,\r
1390 "0x%08x: Closed close event\r\n",\r
1391 pTcp4->CloseToken.CompletionToken.Event ));\r
1392 }\r
1393 else {\r
1394 DEBUG (( DEBUG_ERROR | DebugFlags,\r
1395 "ERROR - Failed to close the close event, Status: %r\r\n",\r
1396 Status ));\r
1397 ASSERT ( EFI_SUCCESS == Status );\r
1398 }\r
1399 }\r
1400\r
1401 //\r
1402 // Done with the listen completion event\r
1403 //\r
1404 if ( NULL != pTcp4->ListenToken.CompletionToken.Event ) {\r
1405 Status = gBS->CloseEvent ( pTcp4->ListenToken.CompletionToken.Event );\r
1406 if ( !EFI_ERROR ( Status )) {\r
1407 DEBUG (( DebugFlags | DEBUG_POOL,\r
1408 "0x%08x: Closed listen completion event\r\n",\r
1409 pTcp4->ListenToken.CompletionToken.Event ));\r
1410 }\r
1411 else {\r
1412 DEBUG (( DEBUG_ERROR | DebugFlags,\r
1413 "ERROR - Failed to close the listen completion event, Status: %r\r\n",\r
1414 Status ));\r
1415 ASSERT ( EFI_SUCCESS == Status );\r
1416 }\r
1417 }\r
1418\r
1419 //\r
1420 // Return the operation status\r
1421 //\r
1422 DBG_EXIT_STATUS ( Status );\r
1423 return Status;\r
1424}\r
1425\r
1426\r
1427/**\r
1428 Perform the network specific close operation on the port.\r
1429\r
1430 This routine performs a cancel operations on the TCPv4 port to\r
1431 shutdown the receive operations on the port.\r
1432\r
1433 This routine is called by the ::EslSocketPortCloseTxDone\r
1434 routine after the port completes all of the transmission.\r
1435\r
1436 @param [in] pPort Address of an ::ESL_PORT structure.\r
1437\r
1438 @retval EFI_SUCCESS The port is closed, not normally returned\r
1439 @retval EFI_NOT_READY The port is still closing\r
1440 @retval EFI_ALREADY_STARTED Error, the port is in the wrong state,\r
1441 most likely the routine was called already.\r
1442\r
1443**/\r
1444EFI_STATUS\r
1445EslTcp4PortCloseOp (\r
1446 IN ESL_PORT * pPort\r
1447 )\r
1448{\r
1449 ESL_TCP4_CONTEXT * pTcp4;\r
1450 EFI_TCP4_PROTOCOL * pTcp4Protocol;\r
1451 EFI_STATUS Status;\r
1452\r
1453 DBG_ENTER ( );\r
1454\r
1455 //\r
1456 // Close the configured port\r
1457 //\r
1458 Status = EFI_SUCCESS;\r
1459 pTcp4 = &pPort->Context.Tcp4;\r
1460 pTcp4Protocol = pPort->pProtocol.TCPv4;\r
1461 pTcp4->CloseToken.AbortOnClose = pPort->bCloseNow;\r
1462 Status = pTcp4Protocol->Close ( pTcp4Protocol,\r
1463 &pTcp4->CloseToken );\r
1464 if ( !EFI_ERROR ( Status )) {\r
1465 DEBUG (( pPort->DebugFlags | DEBUG_CLOSE | DEBUG_INFO,\r
1466 "0x%08x: Port close started\r\n",\r
1467 pPort ));\r
1468 }\r
1469 else {\r
1470 DEBUG (( DEBUG_ERROR | pPort->DebugFlags | DEBUG_CLOSE | DEBUG_INFO,\r
1471 "ERROR - Close failed on port 0x%08x, Status: %r\r\n",\r
1472 pPort,\r
1473 Status ));\r
1474 }\r
1475\r
1476 //\r
1477 // Return the operation status\r
1478 //\r
1479 DBG_EXIT_STATUS ( Status );\r
1480 return Status;\r
1481}\r
1482\r
1483\r
1484/**\r
1485 Receive data from a network connection.\r
1486\r
1487 This routine attempts to return buffered data to the caller. The\r
1488 data is removed from the urgent queue if the message flag MSG_OOB\r
1489 is specified, otherwise data is removed from the normal queue.\r
1490 See the \ref ReceiveEngine section.\r
1491\r
1492 This routine is called by ::EslSocketReceive to handle the network\r
1493 specific receive operation to support SOCK_STREAM and SOCK_SEQPACKET\r
1494 sockets.\r
1495\r
1496 @param [in] pPort Address of an ::ESL_PORT structure.\r
1497\r
1498 @param [in] pPacket Address of an ::ESL_PACKET structure.\r
1499 \r
1500 @param [in] pbConsumePacket Address of a BOOLEAN indicating if the packet is to be consumed\r
1501 \r
1502 @param [in] BufferLength Length of the the buffer\r
1503 \r
1504 @param [in] pBuffer Address of a buffer to receive the data.\r
1505 \r
1506 @param [in] pDataLength Number of received data bytes in the buffer.\r
1507\r
1508 @param [out] pAddress Network address to receive the remote system address\r
1509\r
1510 @param [out] pSkipBytes Address to receive the number of bytes skipped\r
1511\r
1512 @return Returns the address of the next free byte in the buffer.\r
1513\r
1514 **/\r
1515UINT8 *\r
1516EslTcp4Receive (\r
1517 IN ESL_PORT * pPort,\r
1518 IN ESL_PACKET * pPacket,\r
1519 IN BOOLEAN * pbConsumePacket,\r
1520 IN size_t BufferLength,\r
1521 IN UINT8 * pBuffer,\r
1522 OUT size_t * pDataLength,\r
1523 OUT struct sockaddr * pAddress,\r
1524 OUT size_t * pSkipBytes\r
1525 )\r
1526{\r
1527 size_t DataLength;\r
1528 struct sockaddr_in * pRemoteAddress;\r
1529 ESL_TCP4_CONTEXT * pTcp4;\r
1530\r
1531 DBG_ENTER ( );\r
1532\r
1533 //\r
1534 // Return the remote system address if requested\r
1535 //\r
1536 if ( NULL != pAddress ) {\r
1537 //\r
1538 // Build the remote address\r
1539 //\r
1540 pTcp4 = &pPort->Context.Tcp4;\r
1541 DEBUG (( DEBUG_RX,\r
1542 "Getting packet remote address: %d.%d.%d.%d:%d\r\n",\r
1543 pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[0],\r
1544 pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[1],\r
1545 pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[2],\r
1546 pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[3],\r
1547 pTcp4->ConfigData.AccessPoint.RemotePort ));\r
1548 pRemoteAddress = (struct sockaddr_in *)pAddress;\r
1549 CopyMem ( &pRemoteAddress->sin_addr,\r
1550 &pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[0],\r
1551 sizeof ( pRemoteAddress->sin_addr ));\r
1552 pRemoteAddress->sin_port = SwapBytes16 ( pTcp4->ConfigData.AccessPoint.RemotePort );\r
1553 }\r
1554\r
1555 //\r
1556 // Determine the amount of received data\r
1557 //\r
1558 DataLength = pPacket->ValidBytes;\r
1559 if ( BufferLength < DataLength ) {\r
1560 DataLength = BufferLength;\r
1561 }\r
1562\r
1563 //\r
1564 // Move the data into the buffer\r
1565 //\r
1566 DEBUG (( DEBUG_RX,\r
1567 "0x%08x: Port copy packet 0x%08x data into 0x%08x, 0x%08x bytes\r\n",\r
1568 pPort,\r
1569 pPacket,\r
1570 pBuffer,\r
1571 DataLength ));\r
1572 CopyMem ( pBuffer, pPacket->pBuffer, DataLength );\r
1573\r
1574 //\r
1575 // Set the next buffer address\r
1576 //\r
1577 pBuffer += DataLength;\r
1578\r
1579 //\r
1580 // Determine if the data is being read\r
1581 //\r
1582 if ( *pbConsumePacket ) {\r
1583 //\r
1584 // Account for the bytes consumed\r
1585 //\r
1586 pPacket->pBuffer += DataLength;\r
1587 pPacket->ValidBytes -= DataLength;\r
1588 DEBUG (( DEBUG_RX,\r
1589 "0x%08x: Port account for 0x%08x bytes\r\n",\r
1590 pPort,\r
1591 DataLength ));\r
1592\r
1593 //\r
1594 // Determine if the entire packet was consumed\r
1595 //\r
1596 if (( 0 == pPacket->ValidBytes )\r
1597 || ( SOCK_STREAM != pPort->pSocket->Type )) {\r
1598 //\r
1599 // All done with this packet\r
1600 // Account for any discarded data\r
1601 //\r
1602 *pSkipBytes = pPacket->ValidBytes;\r
1603 }\r
1604 else\r
1605 {\r
1606 //\r
1607 // More data to consume later\r
1608 //\r
1609 *pbConsumePacket = FALSE;\r
1610 }\r
1611 }\r
1612\r
1613 //\r
1614 // Return the data length and the buffer address\r
1615 //\r
1616 *pDataLength = DataLength;\r
1617 DBG_EXIT_HEX ( pBuffer );\r
1618 return pBuffer;\r
1619}\r
1620\r
1621\r
1622/**\r
1623 Get the remote socket address.\r
1624\r
1625 This routine returns the address of the remote connection point\r
1626 associated with the SOCK_STREAM or SOCK_SEQPACKET socket.\r
1627\r
1628 This routine is called by ::EslSocketGetPeerAddress to detemine\r
1629 the TCPv4 address and por number associated with the network adapter.\r
1630\r
1631 @param [in] pPort Address of an ::ESL_PORT structure.\r
1632\r
1633 @param [out] pAddress Network address to receive the remote system address\r
1634\r
1635**/\r
1636VOID\r
1637EslTcp4RemoteAddressGet (\r
1638 IN ESL_PORT * pPort,\r
1639 OUT struct sockaddr * pAddress\r
1640 )\r
1641{\r
1642 struct sockaddr_in * pRemoteAddress;\r
1643 ESL_TCP4_CONTEXT * pTcp4;\r
1644\r
1645 DBG_ENTER ( );\r
1646\r
1647 //\r
1648 // Return the remote address\r
1649 //\r
1650 pTcp4 = &pPort->Context.Tcp4;\r
1651 pRemoteAddress = (struct sockaddr_in *)pAddress;\r
1652 pRemoteAddress->sin_family = AF_INET;\r
1653 pRemoteAddress->sin_port = SwapBytes16 ( pTcp4->ConfigData.AccessPoint.RemotePort );\r
1654 CopyMem ( &pRemoteAddress->sin_addr,\r
1655 &pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[0],\r
1656 sizeof ( pRemoteAddress->sin_addr ));\r
1657\r
1658 DBG_EXIT ( );\r
1659}\r
1660\r
1661\r
1662/**\r
1663 Set the remote address\r
1664\r
1665 This routine sets the remote address in the port.\r
1666\r
1667 This routine is called by ::EslSocketConnect to specify the\r
1668 remote network address.\r
1669\r
1670 @param [in] pPort Address of an ::ESL_PORT structure.\r
1671\r
1672 @param [in] pSockAddr Network address of the remote system.\r
1673\r
1674 @param [in] SockAddrLength Length in bytes of the network address.\r
1675\r
1676 @retval EFI_SUCCESS The operation was successful\r
1677\r
1678 **/\r
1679EFI_STATUS\r
1680EslTcp4RemoteAddressSet (\r
1681 IN ESL_PORT * pPort,\r
1682 IN CONST struct sockaddr * pSockAddr,\r
1683 IN socklen_t SockAddrLength\r
1684 )\r
1685{\r
1686 CONST struct sockaddr_in * pRemoteAddress;\r
1687 ESL_TCP4_CONTEXT * pTcp4;\r
1688 EFI_STATUS Status;\r
1689\r
1690 DBG_ENTER ( );\r
1691\r
1692 //\r
1693 // Set the remote address\r
1694 //\r
1695 pTcp4 = &pPort->Context.Tcp4;\r
1696 pRemoteAddress = (struct sockaddr_in *)pSockAddr;\r
1697 pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[0] = (UINT8)( pRemoteAddress->sin_addr.s_addr );\r
1698 pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[1] = (UINT8)( pRemoteAddress->sin_addr.s_addr >> 8 );\r
1699 pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[2] = (UINT8)( pRemoteAddress->sin_addr.s_addr >> 16 );\r
1700 pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[3] = (UINT8)( pRemoteAddress->sin_addr.s_addr >> 24 );\r
1701 pTcp4->ConfigData.AccessPoint.RemotePort = SwapBytes16 ( pRemoteAddress->sin_port );\r
1702 Status = EFI_SUCCESS;\r
1703 if ( INADDR_BROADCAST == pRemoteAddress->sin_addr.s_addr ) {\r
1704 DEBUG (( DEBUG_CONNECT,\r
1705 "ERROR - Invalid remote address\r\n" ));\r
1706 Status = EFI_INVALID_PARAMETER;\r
1707 pPort->pSocket->errno = EAFNOSUPPORT;\r
1708 }\r
1709\r
1710 //\r
1711 // Return the operation status\r
1712 //\r
1713 DBG_EXIT_STATUS ( Status );\r
1714 return Status;\r
1715}\r
1716\r
1717\r
1718/**\r
1719 Process the receive completion\r
1720\r
1721 This routine queues the data in FIFO order in either the urgent\r
1722 or normal data queues depending upon the type of data received.\r
1723 See the \ref ReceiveEngine section.\r
1724\r
1725 This routine is called by the TCPv4 driver when some data is\r
1726 received.\r
1727\r
1728 Buffer the data that was just received.\r
1729\r
1730 @param [in] Event The receive completion event\r
1731\r
1732 @param [in] pIo Address of an ::ESL_IO_MGMT structure\r
1733\r
1734**/\r
1735VOID\r
1736EslTcp4RxComplete (\r
1737 IN EFI_EVENT Event,\r
1738 IN ESL_IO_MGMT * pIo\r
1739 )\r
1740{\r
1741 BOOLEAN bUrgent;\r
1742 size_t LengthInBytes;\r
1743 ESL_PACKET * pPacket;\r
1744 EFI_STATUS Status;\r
1745\r
1746 DBG_ENTER ( );\r
1747\r
1748 //\r
1749 // Get the operation status.\r
1750 //\r
1751 Status = pIo->Token.Tcp4Rx.CompletionToken.Status;\r
1752\r
1753 //\r
1754 // +--------------------+ +---------------------------+\r
1755 // | ESL_IO_MGMT | | ESL_PACKET |\r
1756 // | | | |\r
1757 // | +---------------+ +-----------------------+ |\r
1758 // | | Token | | EFI_TCP4_RECEIVE_DATA | |\r
1759 // | | RxData --> | | |\r
1760 // | | | +-----------------------+---+\r
1761 // | | Event | | Data Buffer |\r
1762 // +----+---------------+ | |\r
1763 // | |\r
1764 // +---------------------------+\r
1765 //\r
1766 //\r
1767 // Duplicate the buffer address and length for use by the\r
1768 // buffer handling code in EslTcp4Receive. These fields are\r
1769 // used when a partial read is done of the data from the\r
1770 // packet.\r
1771 //\r
1772 pPacket = pIo->pPacket;\r
1773 pPacket->pBuffer = pPacket->Op.Tcp4Rx.RxData.FragmentTable[0].FragmentBuffer;\r
1774 LengthInBytes = pPacket->Op.Tcp4Rx.RxData.DataLength;\r
1775 pPacket->ValidBytes = LengthInBytes;\r
1776\r
1777 //\r
1778 // Get the data type so that it may be linked to the\r
1779 // correct receive buffer list on the ESL_SOCKET structure\r
1780 //\r
1781 bUrgent = pPacket->Op.Tcp4Rx.RxData.UrgentFlag;\r
1782\r
1783 //\r
1784 // Complete this request\r
1785 //\r
1786 EslSocketRxComplete ( pIo, Status, LengthInBytes, bUrgent );\r
1787 DBG_EXIT ( );\r
1788}\r
1789\r
1790\r
1791/**\r
1792 Start a receive operation\r
1793\r
1794 This routine posts a receive buffer to the TCPv4 driver.\r
1795 See the \ref ReceiveEngine section.\r
1796\r
1797 This support routine is called by EslSocketRxStart.\r
1798\r
1799 @param [in] pPort Address of an ::ESL_PORT structure.\r
1800 @param [in] pIo Address of an ::ESL_IO_MGMT structure.\r
1801\r
1802 **/\r
1803VOID\r
1804EslTcp4RxStart (\r
1805 IN ESL_PORT * pPort,\r
1806 IN ESL_IO_MGMT * pIo\r
1807 )\r
1808{\r
1809 ESL_PACKET * pPacket;\r
1810\r
1811 DBG_ENTER ( );\r
1812\r
1813 //\r
1814 // Initialize the buffer for receive\r
1815 //\r
1816 pPacket = pIo->pPacket;\r
1817 pIo->Token.Tcp4Rx.Packet.RxData = &pPacket->Op.Tcp4Rx.RxData;\r
1818 pPacket->Op.Tcp4Rx.RxData.DataLength = sizeof ( pPacket->Op.Tcp4Rx.Buffer );\r
1819 pPacket->Op.Tcp4Rx.RxData.FragmentCount = 1;\r
1820 pPacket->Op.Tcp4Rx.RxData.FragmentTable[0].FragmentLength = pPacket->Op.Tcp4Rx.RxData.DataLength;\r
1821 pPacket->Op.Tcp4Rx.RxData.FragmentTable[0].FragmentBuffer = &pPacket->Op.Tcp4Rx.Buffer[0];\r
1822\r
1823 DBG_EXIT ( );\r
1824}\r
1825\r
1826\r
1827/**\r
1828 Determine if the socket is configured.\r
1829\r
1830 This routine uses the flag ESL_SOCKET::bConfigured to determine\r
1831 if the network layer's configuration routine has been called.\r
1832\r
1833 This routine is called by EslSocketIsConfigured to verify\r
1834 that the socket has been configured.\r
1835\r
1836 @param [in] pSocket Address of an ::ESL_SOCKET structure.\r
1837\r
1838 @retval EFI_SUCCESS - The port is connected\r
1839 @retval EFI_NOT_STARTED - The port is not connected\r
1840\r
1841 **/\r
1842 EFI_STATUS\r
1843 EslTcp4SocketIsConfigured (\r
1844 IN ESL_SOCKET * pSocket\r
1845 )\r
1846{\r
1847 EFI_STATUS Status;\r
1848\r
1849 DBG_ENTER ( );\r
1850\r
1851 //\r
1852 // Determine the socket configuration status\r
1853 //\r
1854 Status = pSocket->bConfigured ? EFI_SUCCESS : EFI_NOT_STARTED;\r
1855\r
1856 //\r
1857 // Return the port connected state.\r
1858 //\r
1859 DBG_EXIT_STATUS ( Status );\r
1860 return Status;\r
1861}\r
1862\r
1863\r
1864/**\r
1865 Buffer data for transmission over a network connection.\r
1866\r
1867 This routine buffers data for the transmit engine in one of two\r
1868 queues, one for urgent (out-of-band) data and the other for normal\r
1869 data. The urgent data is provided to TCP as soon as it is available,\r
1870 allowing the TCP layer to schedule transmission of the urgent data\r
1871 between packets of normal data.\r
1872\r
1873 This routine is called by ::EslSocketTransmit to buffer\r
1874 data for transmission. When the \ref TransmitEngine has resources,\r
1875 this routine will start the transmission of the next buffer on\r
1876 the network connection.\r
1877\r
1878 Transmission errors are returned during the next transmission or\r
1879 during the close operation. Only buffering errors are returned\r
1880 during the current transmission attempt.\r
1881\r
1882 @param [in] pSocket Address of an ::ESL_SOCKET structure\r
1883 \r
1884 @param [in] Flags Message control flags\r
1885 \r
1886 @param [in] BufferLength Length of the the buffer\r
1887 \r
1888 @param [in] pBuffer Address of a buffer to receive the data.\r
1889 \r
1890 @param [in] pDataLength Number of received data bytes in the buffer.\r
1891\r
1892 @param [in] pAddress Network address of the remote system address\r
1893\r
1894 @param [in] AddressLength Length of the remote network address structure\r
1895\r
1896 @retval EFI_SUCCESS - Socket data successfully buffered\r
1897\r
1898 **/\r
1899EFI_STATUS\r
1900EslTcp4TxBuffer (\r
1901 IN ESL_SOCKET * pSocket,\r
1902 IN int Flags,\r
1903 IN size_t BufferLength,\r
1904 IN CONST UINT8 * pBuffer,\r
1905 OUT size_t * pDataLength,\r
1906 IN const struct sockaddr * pAddress,\r
1907 IN socklen_t AddressLength\r
1908 )\r
1909{\r
1910 BOOLEAN bUrgent;\r
1911 BOOLEAN bUrgentQueue;\r
1912 ESL_PACKET * pPacket;\r
1913 ESL_IO_MGMT ** ppActive;\r
1914 ESL_IO_MGMT ** ppFree;\r
1915 ESL_PORT * pPort;\r
1916 ESL_PACKET ** ppQueueHead;\r
1917 ESL_PACKET ** ppQueueTail;\r
1918 ESL_PACKET * pPreviousPacket;\r
1919 ESL_TCP4_CONTEXT * pTcp4;\r
1920 size_t * pTxBytes;\r
1921 EFI_TCP4_TRANSMIT_DATA * pTxData;\r
1922 EFI_STATUS Status;\r
1923 EFI_TPL TplPrevious;\r
1924\r
1925 DBG_ENTER ( );\r
1926\r
1927 //\r
1928 // Assume failure\r
1929 //\r
1930 Status = EFI_UNSUPPORTED;\r
1931 pSocket->errno = ENOTCONN;\r
1932 *pDataLength = 0;\r
1933\r
1934 //\r
1935 // Verify that the socket is connected\r
1936 //\r
1937 if ( SOCKET_STATE_CONNECTED == pSocket->State ) {\r
1938 //\r
1939 // Locate the port\r
1940 //\r
1941 pPort = pSocket->pPortList;\r
1942 if ( NULL != pPort ) {\r
1943 //\r
1944 // Determine the queue head\r
1945 //\r
1946 pTcp4 = &pPort->Context.Tcp4;\r
1947 bUrgent = (BOOLEAN)( 0 != ( Flags & MSG_OOB ));\r
1948 bUrgentQueue = bUrgent\r
1949 && ( !pSocket->bOobInLine )\r
1950 && pSocket->pApi->bOobSupported;\r
1951 if ( bUrgentQueue ) {\r
1952 ppQueueHead = &pSocket->pTxOobPacketListHead;\r
1953 ppQueueTail = &pSocket->pTxOobPacketListTail;\r
1954 ppActive = &pPort->pTxOobActive;\r
1955 ppFree = &pPort->pTxOobFree;\r
1956 pTxBytes = &pSocket->TxOobBytes;\r
1957 }\r
1958 else {\r
1959 ppQueueHead = &pSocket->pTxPacketListHead;\r
1960 ppQueueTail = &pSocket->pTxPacketListTail;\r
1961 ppActive = &pPort->pTxActive;\r
1962 ppFree = &pPort->pTxFree;\r
1963 pTxBytes = &pSocket->TxBytes;\r
1964 }\r
1965\r
1966 //\r
1967 // Verify that there is enough room to buffer another\r
1968 // transmit operation\r
1969 //\r
1970 if ( pSocket->MaxTxBuf > *pTxBytes ) {\r
1971 if ( pPort->bTxFlowControl ) {\r
1972 DEBUG (( DEBUG_TX,\r
1973 "TTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTT\r\n0x%08x: pPort, TX flow control released, Max bytes: %d > %d bufferred bytes\r\n",\r
1974 pPort,\r
1975 pSocket->MaxTxBuf,\r
1976 *pTxBytes ));\r
1977 pPort->bTxFlowControl = FALSE;\r
1978 }\r
1979\r
1980 //\r
1981 // Attempt to allocate the packet\r
1982 //\r
1983 Status = EslSocketPacketAllocate ( &pPacket,\r
1984 sizeof ( pPacket->Op.Tcp4Tx )\r
1985 - sizeof ( pPacket->Op.Tcp4Tx.Buffer )\r
1986 + BufferLength,\r
1987 0,\r
1988 DEBUG_TX );\r
1989 if ( !EFI_ERROR ( Status )) {\r
1990 //\r
1991 // Initialize the transmit operation\r
1992 //\r
1993 pTxData = &pPacket->Op.Tcp4Tx.TxData;\r
1994 pTxData->Push = TRUE || bUrgent;\r
1995 pTxData->Urgent = bUrgent;\r
1996 pTxData->DataLength = (UINT32) BufferLength;\r
1997 pTxData->FragmentCount = 1;\r
1998 pTxData->FragmentTable[0].FragmentLength = (UINT32) BufferLength;\r
1999 pTxData->FragmentTable[0].FragmentBuffer = &pPacket->Op.Tcp4Tx.Buffer[0];\r
2000\r
2001 //\r
2002 // Copy the data into the buffer\r
2003 //\r
2004 CopyMem ( &pPacket->Op.Tcp4Tx.Buffer[0],\r
2005 pBuffer,\r
2006 BufferLength );\r
2007\r
2008 //\r
2009 // Synchronize with the socket layer\r
2010 //\r
2011 RAISE_TPL ( TplPrevious, TPL_SOCKETS );\r
2012\r
2013 //\r
2014 // Stop transmission after an error\r
2015 //\r
2016 if ( !EFI_ERROR ( pSocket->TxError )) {\r
2017 //\r
2018 // Display the request\r
2019 //\r
2020 DEBUG (( DEBUG_TX,\r
2021 "Send %d %s bytes from 0x%08x\r\n",\r
2022 BufferLength,\r
2023 bUrgent ? L"urgent" : L"normal",\r
2024 pBuffer ));\r
2025\r
2026 //\r
2027 // Queue the data for transmission\r
2028 //\r
2029 pPacket->pNext = NULL;\r
2030 pPreviousPacket = *ppQueueTail;\r
2031 if ( NULL == pPreviousPacket ) {\r
2032 *ppQueueHead = pPacket;\r
2033 }\r
2034 else {\r
2035 pPreviousPacket->pNext = pPacket;\r
2036 }\r
2037 *ppQueueTail = pPacket;\r
2038 DEBUG (( DEBUG_TX,\r
2039 "0x%08x: Packet on %s transmit list\r\n",\r
2040 pPacket,\r
2041 bUrgentQueue ? L"urgent" : L"normal" ));\r
2042\r
2043 //\r
2044 // Account for the buffered data\r
2045 //\r
2046 *pTxBytes += BufferLength;\r
2047 *pDataLength = BufferLength;\r
2048\r
2049 //\r
2050 // Start the transmit engine if it is idle\r
2051 //\r
2052 if ( NULL != *ppFree ) {\r
2053 EslSocketTxStart ( pPort,\r
2054 ppQueueHead,\r
2055 ppQueueTail,\r
2056 ppActive,\r
2057 ppFree );\r
2058 }\r
2059 }\r
2060 else {\r
2061 //\r
2062 // Previous transmit error\r
2063 // Stop transmission\r
2064 //\r
2065 Status = pSocket->TxError;\r
2066 pSocket->errno = EIO;\r
2067\r
2068 //\r
2069 // Free the packet\r
2070 //\r
2071 EslSocketPacketFree ( pPacket, DEBUG_TX );\r
2072 }\r
2073\r
2074 //\r
2075 // Release the socket layer synchronization\r
2076 //\r
2077 RESTORE_TPL ( TplPrevious );\r
2078 }\r
2079 else {\r
2080 //\r
2081 // Packet allocation failed\r
2082 //\r
2083 pSocket->errno = ENOMEM;\r
2084 }\r
2085 }\r
2086 else {\r
2087 if ( !pPort->bTxFlowControl ) {\r
2088 DEBUG (( DEBUG_TX,\r
2089 "0x%08x: pPort, TX flow control applied, Max bytes %d <= %d bufferred bytes\r\nTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTT\r\n",\r
2090 pPort,\r
2091 pSocket->MaxTxBuf,\r
2092 *pTxBytes ));\r
2093 pPort->bTxFlowControl = TRUE;\r
2094 }\r
2095 //\r
2096 // Not enough buffer space available\r
2097 //\r
2098 pSocket->errno = EAGAIN;\r
2099 Status = EFI_NOT_READY;\r
2100 }\r
2101 }\r
2102 }\r
2103\r
2104 //\r
2105 // Return the operation status\r
2106 //\r
2107 DBG_EXIT_STATUS ( Status );\r
2108 return Status;\r
2109}\r
2110\r
2111\r
2112/**\r
2113 Process the normal data transmit completion\r
2114\r
2115 This routine use ::EslSocketTxComplete to perform the transmit\r
2116 completion processing for normal data.\r
2117\r
2118 This routine is called by the TCPv4 network layer when a\r
2119 normal data transmit request completes.\r
2120\r
2121 @param [in] Event The normal transmit completion event\r
2122\r
2123 @param [in] pIo The ESL_IO_MGMT structure address\r
2124\r
2125**/\r
2126VOID\r
2127EslTcp4TxComplete (\r
2128 IN EFI_EVENT Event,\r
2129 IN ESL_IO_MGMT * pIo\r
2130 )\r
2131{\r
2132 UINT32 LengthInBytes;\r
2133 ESL_PACKET * pPacket;\r
2134 ESL_PORT * pPort;\r
2135 ESL_SOCKET * pSocket;\r
2136 EFI_STATUS Status;\r
2137 \r
2138 DBG_ENTER ( );\r
2139\r
2140 //\r
2141 // Locate the active transmit packet\r
2142 //\r
2143 pPacket = pIo->pPacket;\r
2144 pPort = pIo->pPort;\r
2145 pSocket = pPort->pSocket;\r
2146\r
2147 //\r
2148 // Get the transmit length and status\r
2149 //\r
2150 LengthInBytes = pPacket->Op.Tcp4Tx.TxData.DataLength;\r
2151 pSocket->TxBytes -= LengthInBytes;\r
2152 Status = pIo->Token.Tcp4Tx.CompletionToken.Status;\r
2153\r
2154 //\r
2155 // Complete the transmit operation\r
2156 //\r
2157 EslSocketTxComplete ( pIo,\r
2158 LengthInBytes,\r
2159 Status,\r
2160 "Normal ",\r
2161 &pSocket->pTxPacketListHead,\r
2162 &pSocket->pTxPacketListTail,\r
2163 &pPort->pTxActive,\r
2164 &pPort->pTxFree );\r
2165 DBG_EXIT ( );\r
2166}\r
2167\r
2168\r
2169/**\r
2170 Process the urgent data transmit completion\r
2171\r
2172 This routine use ::EslSocketTxComplete to perform the transmit\r
2173 completion processing for urgent data.\r
2174\r
2175 This routine is called by the TCPv4 network layer when a\r
2176 urgent data transmit request completes.\r
2177\r
2178 @param [in] Event The urgent transmit completion event\r
2179\r
2180 @param [in] pIo The ESL_IO_MGMT structure address\r
2181\r
2182**/\r
2183VOID\r
2184EslTcp4TxOobComplete (\r
2185 IN EFI_EVENT Event,\r
2186 IN ESL_IO_MGMT * pIo\r
2187 )\r
2188{\r
2189 UINT32 LengthInBytes;\r
2190 ESL_PACKET * pPacket;\r
2191 ESL_PORT * pPort;\r
2192 ESL_SOCKET * pSocket;\r
2193 EFI_STATUS Status;\r
2194\r
2195 DBG_ENTER ( );\r
2196\r
2197 //\r
2198 // Locate the active transmit packet\r
2199 //\r
2200 pPacket = pIo->pPacket;\r
2201 pPort = pIo->pPort;\r
2202 pSocket = pPort->pSocket;\r
2203\r
2204 //\r
2205 // Get the transmit length and status\r
2206 //\r
2207 LengthInBytes = pPacket->Op.Tcp4Tx.TxData.DataLength;\r
2208 pSocket->TxOobBytes -= LengthInBytes;\r
2209 Status = pIo->Token.Tcp4Tx.CompletionToken.Status;\r
2210\r
2211 //\r
2212 // Complete the transmit operation\r
2213 //\r
2214 EslSocketTxComplete ( pIo,\r
2215 LengthInBytes,\r
2216 Status,\r
2217 "Urgent ",\r
2218 &pSocket->pTxOobPacketListHead,\r
2219 &pSocket->pTxOobPacketListTail,\r
2220 &pPort->pTxOobActive,\r
2221 &pPort->pTxOobFree );\r
2222 DBG_EXIT ( );\r
2223}\r
2224\r
2225\r
2226/**\r
2227 Interface between the socket layer and the network specific\r
2228 code that supports SOCK_STREAM and SOCK_SEQPACKET sockets\r
2229 over TCPv4.\r
2230**/\r
2231CONST ESL_PROTOCOL_API cEslTcp4Api = {\r
2232 "TCPv4",\r
2233 IPPROTO_TCP,\r
2234 OFFSET_OF ( ESL_PORT, Context.Tcp4.ConfigData ),\r
2235 OFFSET_OF ( ESL_LAYER, pTcp4List ),\r
2236 OFFSET_OF ( struct sockaddr_in, sin_zero ),\r
2237 sizeof ( struct sockaddr_in ),\r
2238 AF_INET,\r
2239 sizeof (((ESL_PACKET *)0 )->Op.Tcp4Rx ),\r
2240 OFFSET_OF ( ESL_PACKET, Op.Tcp4Rx.Buffer ) - OFFSET_OF ( ESL_PACKET, Op ),\r
2241 OFFSET_OF ( ESL_IO_MGMT, Token.Tcp4Rx.Packet.RxData ),\r
2242 TRUE,\r
2243 EADDRINUSE,\r
2244 EslTcp4Accept,\r
2245 EslTcp4ConnectPoll,\r
2246 EslTcp4ConnectStart,\r
2247 EslTcp4SocketIsConfigured,\r
2248 EslTcp4LocalAddressGet,\r
2249 EslTcp4LocalAddressSet,\r
2250 EslTcp4Listen,\r
2251 NULL, // OptionGet\r
2252 NULL, // OptionSet\r
2253 EslTcp4PacketFree,\r
2254 EslTcp4PortAllocate,\r
2255 EslTcp4PortClose,\r
2256 EslTcp4PortCloseOp,\r
2257 FALSE,\r
2258 EslTcp4Receive,\r
2259 EslTcp4RemoteAddressGet,\r
2260 EslTcp4RemoteAddressSet,\r
2261 EslTcp4RxComplete,\r
2262 EslTcp4RxStart,\r
2263 EslTcp4TxBuffer,\r
2264 EslTcp4TxComplete,\r
2265 EslTcp4TxOobComplete\r
2266};\r
EFI Development Kit II mirror for PVE