2 Implement the TCP4 driver support for the socket layer.
4 Copyright (c) 2011, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
14 \section ConnectionManagement Connection Management
16 The ::EslTcp4Listen routine initially places the SOCK_STREAM or
17 SOCK_SEQPACKET socket into a listen state. When a remote machine
18 makes a connection to the socket, the TCPv4 network layer calls
19 ::EslTcp4ListenComplete to complete the connection processing.
20 EslTcp4ListenComplete manages the connections by placing them in
21 FIFO order in a queue to be serviced by the application. When the
22 number of connections exceeds the backlog (ESL_SOCKET::MaxFifoDepth),
23 the new connection is closed. Eventually, the application indirectly
24 calls ::EslTcp4Accept to remove the next connection from the queue
25 and get the associated socket.
33 Attempt to connect to a remote TCP port
35 This routine starts the connection processing for a SOCK_STREAM
36 or SOCK_SEQPAKCET socket using the TCPv4 network layer. It
37 configures the local TCPv4 connection point and then attempts to
38 connect to a remote system. Upon completion, the
39 ::EslTcp4ConnectComplete routine gets called with the connection
42 This routine is called by ::EslSocketConnect to initiate the TCPv4
43 network specific connect operations. The connection processing is
44 initiated by this routine and finished by ::EslTcp4ConnectComplete.
45 This pair of routines walks through the list of local TCPv4
46 connection points until a connection to the remote system is
49 @param [in] pSocket Address of an ::ESL_SOCKET structure.
51 @retval EFI_SUCCESS The connection was successfully established.
52 @retval EFI_NOT_READY The connection is in progress, call this routine again.
53 @retval Others The connection attempt failed.
58 IN ESL_SOCKET
* pSocket
63 Process the connection attempt
65 A system has initiated a connection attempt with a socket in the
66 listen state. Attempt to complete the connection.
68 The TCPv4 layer calls this routine when a connection is made to
69 the socket in the listen state. See the
70 \ref ConnectionManagement section.
72 @param [in] Event The listen completion event
74 @param [in] pPort Address of an ::ESL_PORT structure.
78 EslTcp4ListenComplete (
85 Accept a network connection.
87 This routine waits for a network connection to the socket and
88 returns the remote network address to the caller if requested.
90 This routine is called by ::EslSocketAccept to handle the TCPv4 protocol
91 specific accept operations for SOCK_STREAM and SOCK_SEQPACKET sockets.
92 See the \ref ConnectionManagement section.
94 @param [in] pSocket Address of an ::ESL_SOCKET structure.
96 @param [in] pSockAddr Address of a buffer to receive the remote
99 @param [in, out] pSockAddrLength Length in bytes of the address buffer.
100 On output specifies the length of the
101 remote network address.
103 @retval EFI_SUCCESS Remote address is available
104 @retval Others Remote address not available
109 IN ESL_SOCKET
* pSocket
,
110 IN
struct sockaddr
* pSockAddr
,
111 IN OUT socklen_t
* pSockAddrLength
115 struct sockaddr_in
* pRemoteAddress
;
116 ESL_TCP4_CONTEXT
* pTcp4
;
117 UINT32 RemoteAddress
;
123 // Validate the socket length
125 pRemoteAddress
= (struct sockaddr_in
*) pSockAddr
;
126 if (( NULL
== pSockAddrLength
)
127 || ( sizeof ( *pRemoteAddress
) > *pSockAddrLength
)) {
129 // Invalid socket address
131 Status
= EFI_INVALID_PARAMETER
;
132 pSocket
->errno
= EINVAL
;
133 DEBUG (( DEBUG_ACCEPT
,
134 "ERROR - Invalid address length\r\n" ));
140 Status
= EFI_SUCCESS
;
143 // Locate the address context
145 pPort
= pSocket
->pPortList
;
146 pTcp4
= &pPort
->Context
.Tcp4
;
149 // Fill-in the remote address structure
151 ZeroMem ( pRemoteAddress
, sizeof ( *pRemoteAddress
));
152 pRemoteAddress
->sin_len
= sizeof ( *pRemoteAddress
);
153 pRemoteAddress
->sin_family
= AF_INET
;
154 pRemoteAddress
->sin_port
= SwapBytes16 ( pTcp4
->ConfigData
.AccessPoint
.RemotePort
);
155 RemoteAddress
= pTcp4
->ConfigData
.AccessPoint
.RemoteAddress
.Addr
[3];
157 RemoteAddress
|= pTcp4
->ConfigData
.AccessPoint
.RemoteAddress
.Addr
[2];
159 RemoteAddress
|= pTcp4
->ConfigData
.AccessPoint
.RemoteAddress
.Addr
[1];
161 RemoteAddress
|= pTcp4
->ConfigData
.AccessPoint
.RemoteAddress
.Addr
[0];
162 pRemoteAddress
->sin_addr
.s_addr
= RemoteAddress
;
166 // Return the operation status
168 DBG_EXIT_STATUS ( Status
);
174 Process the remote connection completion event.
176 This routine handles the completion of a connection attempt. It
177 releases the port (TCPv4 adapter connection) in the case of an
178 error and start a connection attempt on the next port. If the
179 connection attempt was successful then this routine releases all
182 This routine is called by the TCPv4 layer when a connect request
183 completes. It sets the ESL_SOCKET::bConnected flag to notify the
184 ::EslTcp4ConnectComplete routine that the connection is available.
185 The flag is set when the connection is established or no more ports
186 exist in the list. The connection status is passed via
187 ESL_SOCKET::ConnectStatus.
189 @param [in] Event The connect completion event
191 @param [in] pPort Address of an ::ESL_PORT structure.
195 EslTcp4ConnectComplete (
200 BOOLEAN bRemoveFirstPort
;
201 BOOLEAN bRemovePorts
;
202 ESL_PORT
* pNextPort
;
203 ESL_SOCKET
* pSocket
;
204 ESL_TCP4_CONTEXT
* pTcp4
;
210 // Locate the TCP context
212 pSocket
= pPort
->pSocket
;
213 pTcp4
= &pPort
->Context
.Tcp4
;
216 // Get the connection status
218 bRemoveFirstPort
= FALSE
;
219 bRemovePorts
= FALSE
;
220 Status
= pTcp4
->ConnectToken
.CompletionToken
.Status
;
221 pSocket
->ConnectStatus
= Status
;
222 if ( !EFI_ERROR ( Status
)) {
224 // The connection was successful
226 DEBUG (( DEBUG_CONNECT
,
227 "0x%08x: Port connected to %d.%d.%d.%d:%d\r\n",
229 pTcp4
->ConfigData
.AccessPoint
.RemoteAddress
.Addr
[0],
230 pTcp4
->ConfigData
.AccessPoint
.RemoteAddress
.Addr
[1],
231 pTcp4
->ConfigData
.AccessPoint
.RemoteAddress
.Addr
[2],
232 pTcp4
->ConfigData
.AccessPoint
.RemoteAddress
.Addr
[3],
233 pTcp4
->ConfigData
.AccessPoint
.RemotePort
));
236 // Remove the rest of the ports
242 // The connection failed
244 if ( pPort
->bConfigured
) {
245 DEBUG (( DEBUG_CONNECT
,
246 "0x%08x: Port connection to %d.%d.%d.%d:%d failed, Status: %r\r\n",
248 pTcp4
->ConfigData
.AccessPoint
.RemoteAddress
.Addr
[0],
249 pTcp4
->ConfigData
.AccessPoint
.RemoteAddress
.Addr
[1],
250 pTcp4
->ConfigData
.AccessPoint
.RemoteAddress
.Addr
[2],
251 pTcp4
->ConfigData
.AccessPoint
.RemoteAddress
.Addr
[3],
252 pTcp4
->ConfigData
.AccessPoint
.RemotePort
,
257 // Close the current port
259 Status
= EslSocketPortClose ( pPort
);
260 if ( !EFI_ERROR ( Status
)) {
261 DEBUG (( DEBUG_CONNECT
,
262 "0x%08x: Port closed\r\n",
266 DEBUG (( DEBUG_CONNECT
,
267 "ERROR - Failed to close port 0x%08x, Status: %r\r\n",
273 // Try to connect using the next port
275 Status
= EslTcp4ConnectStart ( pSocket
);
276 if ( EFI_NOT_READY
!= Status
) {
277 bRemoveFirstPort
= TRUE
;
282 // Remove the ports if necessary
284 if ( bRemoveFirstPort
|| bRemovePorts
) {
286 // Remove the first port if necessary
288 pPort
= pSocket
->pPortList
;
289 if (( !bRemoveFirstPort
) && ( NULL
!= pPort
)) {
290 pPort
= pPort
->pLinkSocket
;
294 // Remove the rest of the list
296 while ( NULL
!= pPort
) {
297 pNextPort
= pPort
->pLinkSocket
;
298 EslSocketPortClose ( pPort
);
299 if ( !EFI_ERROR ( Status
)) {
300 DEBUG (( DEBUG_CONNECT
,
301 "0x%08x: Port closed\r\n",
305 DEBUG (( DEBUG_CONNECT
,
306 "ERROR - Failed to close port 0x%08x, Status: %r\r\n",
314 // Notify the poll routine
316 pSocket
->bConnected
= TRUE
;
324 Poll for completion of the connection attempt.
326 This routine polls the ESL_SOCKET::bConnected flag to determine
327 when the connection attempt is complete.
329 This routine is called from ::EslSocketConnect to determine when
330 the connection is complete. The ESL_SOCKET::bConnected flag is
331 set by ::EslTcp4ConnectComplete when the TCPv4 layer establishes
332 a connection or runs out of local network adapters. This routine
333 gets the connection status from ESL_SOCKET::ConnectStatus.
335 @param [in] pSocket Address of an ::ESL_SOCKET structure.
337 @retval EFI_SUCCESS The connection was successfully established.
338 @retval EFI_NOT_READY The connection is in progress, call this routine again.
339 @retval Others The connection attempt failed.
344 IN ESL_SOCKET
* pSocket
352 // Determine if the connection is complete
354 if ( !pSocket
->bConnected
) {
358 pSocket
->errno
= EAGAIN
;
359 Status
= EFI_NOT_READY
;
363 // The connection processing is complete
365 pSocket
->bConnected
= FALSE
;
368 // Translate the connection status
370 Status
= pSocket
->ConnectStatus
;
373 case EFI_DEVICE_ERROR
:
374 pSocket
->errno
= EIO
;
378 pSocket
->errno
= ECONNABORTED
;
381 case EFI_ACCESS_DENIED
:
382 pSocket
->errno
= EACCES
;
385 case EFI_CONNECTION_RESET
:
386 pSocket
->errno
= ECONNRESET
;
389 case EFI_INVALID_PARAMETER
:
390 pSocket
->errno
= EADDRNOTAVAIL
;
393 case EFI_HOST_UNREACHABLE
:
394 case EFI_NO_RESPONSE
:
395 pSocket
->errno
= EHOSTUNREACH
;
399 pSocket
->errno
= EAFNOSUPPORT
;
403 case EFI_NETWORK_UNREACHABLE
:
404 pSocket
->errno
= ENETDOWN
;
407 case EFI_OUT_OF_RESOURCES
:
408 pSocket
->errno
= ENOBUFS
;
411 case EFI_PORT_UNREACHABLE
:
412 case EFI_PROTOCOL_UNREACHABLE
:
413 case EFI_CONNECTION_REFUSED
:
414 pSocket
->errno
= ECONNREFUSED
;
419 pSocket
->bConfigured
= TRUE
;
423 pSocket
->errno
= ETIMEDOUT
;
426 case EFI_UNSUPPORTED
:
427 pSocket
->errno
= EOPNOTSUPP
;
432 // Display the translation
434 DEBUG (( DEBUG_CONNECT
,
435 "ERROR - errno: %d, Status: %r\r\n",
441 // Return the initialization status
443 DBG_EXIT_STATUS ( Status
);
449 Attempt to connect to a remote TCP port
451 This routine starts the connection processing for a SOCK_STREAM
452 or SOCK_SEQPAKCET socket using the TCPv4 network layer. It
453 configures the local TCPv4 connection point and then attempts to
454 connect to a remote system. Upon completion, the
455 ::EslTcp4ConnectComplete routine gets called with the connection
458 This routine is called by ::EslSocketConnect to initiate the TCPv4
459 network specific connect operations. The connection processing is
460 initiated by this routine and finished by ::EslTcp4ConnectComplete.
461 This pair of routines walks through the list of local TCPv4
462 connection points until a connection to the remote system is
465 @param [in] pSocket Address of an ::ESL_SOCKET structure.
467 @retval EFI_SUCCESS The connection was successfully established.
468 @retval EFI_NOT_READY The connection is in progress, call this routine again.
469 @retval Others The connection attempt failed.
473 EslTcp4ConnectStart (
474 IN ESL_SOCKET
* pSocket
478 ESL_TCP4_CONTEXT
* pTcp4
;
479 EFI_TCP4_PROTOCOL
* pTcp4Protocol
;
480 EFI_SIMPLE_NETWORK_MODE SnpModeData
;
486 // Determine if any more local adapters are available
488 pPort
= pSocket
->pPortList
;
489 if ( NULL
!= pPort
) {
491 // Configure the port
493 pTcp4
= &pPort
->Context
.Tcp4
;
494 pTcp4
->ConfigData
.AccessPoint
.ActiveFlag
= TRUE
;
495 pTcp4
->ConfigData
.TimeToLive
= 255;
496 pTcp4Protocol
= pPort
->pProtocol
.TCPv4
;
497 Status
= pTcp4Protocol
->Configure ( pTcp4Protocol
,
498 &pTcp4
->ConfigData
);
499 if ( EFI_ERROR ( Status
)) {
500 DEBUG (( DEBUG_CONNECT
,
501 "ERROR - Failed to configure the Tcp4 port, Status: %r\r\n",
505 DEBUG (( DEBUG_CONNECT
,
506 "0x%08x: Port configured\r\n",
508 pPort
->bConfigured
= TRUE
;
511 // Verify the port connection
513 Status
= pTcp4Protocol
->GetModeData ( pTcp4Protocol
,
519 if ( !EFI_ERROR ( Status
)) {
520 if ( SnpModeData
.MediaPresentSupported
521 && ( !SnpModeData
.MediaPresent
)) {
523 // Port is not connected to the network
525 Status
= EFI_NO_MEDIA
;
529 // Attempt the connection to the remote system
531 Status
= pTcp4Protocol
->Connect ( pTcp4Protocol
,
532 &pTcp4
->ConnectToken
);
535 if ( EFI_ERROR ( Status
)) {
539 DEBUG (( DEBUG_CONNECT
,
540 "ERROR - Port 0x%08x not connected, Status: %r\r\n",
545 if ( !EFI_ERROR ( Status
)) {
547 // Connection in progress
549 pSocket
->errno
= EINPROGRESS
;
550 DEBUG (( DEBUG_CONNECT
,
551 "0x%08x: Port attempting connection to %d.%d.%d.%d:%d\r\n",
553 pTcp4
->ConfigData
.AccessPoint
.RemoteAddress
.Addr
[0],
554 pTcp4
->ConfigData
.AccessPoint
.RemoteAddress
.Addr
[1],
555 pTcp4
->ConfigData
.AccessPoint
.RemoteAddress
.Addr
[2],
556 pTcp4
->ConfigData
.AccessPoint
.RemoteAddress
.Addr
[3],
557 pTcp4
->ConfigData
.AccessPoint
.RemotePort
));
561 // Error return path is through EslTcp4ConnectComplete to
562 // enable retry on other ports
564 // Status to errno translation gets done in EslTcp4ConnectPoll
566 pTcp4
->ConnectToken
.CompletionToken
.Status
= Status
;
569 // Continue with the next port
571 gBS
->CheckEvent ( pTcp4
->ConnectToken
.CompletionToken
.Event
);
572 gBS
->SignalEvent ( pTcp4
->ConnectToken
.CompletionToken
.Event
);
574 Status
= EFI_NOT_READY
;
578 // No more local adapters available
580 pSocket
->errno
= ENETUNREACH
;
581 Status
= EFI_NO_RESPONSE
;
585 // Return the operation status
587 DBG_EXIT_STATUS ( Status
);
593 Establish the known port to listen for network connections.
595 This routine places the port into a state that enables connection
598 This routine is called by ::EslSocketListen to handle the network
599 specifics of the listen operation for SOCK_STREAM and SOCK_SEQPACKET
600 sockets. See the \ref ConnectionManagement section.
602 @param [in] pSocket Address of an ::ESL_SOCKET structure.
604 @retval EFI_SUCCESS - Socket successfully created
605 @retval Other - Failed to enable the socket for listen
610 IN ESL_SOCKET
* pSocket
613 ESL_PORT
* pNextPort
;
615 ESL_TCP4_CONTEXT
* pTcp4
;
616 EFI_TCP4_PROTOCOL
* pTcp4Protocol
;
622 // Verify the socket layer synchronization
624 VERIFY_TPL ( TPL_SOCKETS
);
627 // Use for/break instead of goto
631 // Assume no ports are available
633 pSocket
->errno
= EOPNOTSUPP
;
634 Status
= EFI_NOT_READY
;
637 // Walk the list of ports
639 pPort
= pSocket
->pPortList
;
640 while ( NULL
!= pPort
) {
647 // Use for/break insteak of goto
651 // Create the listen completion event
653 pTcp4
= &pPort
->Context
.Tcp4
;
654 Status
= gBS
->CreateEvent ( EVT_NOTIFY_SIGNAL
,
656 (EFI_EVENT_NOTIFY
)EslTcp4ListenComplete
,
658 &pTcp4
->ListenToken
.CompletionToken
.Event
);
659 if ( EFI_ERROR ( Status
)) {
660 DEBUG (( DEBUG_ERROR
| DEBUG_LISTEN
,
661 "ERROR - Failed to create the listen completion event, Status: %r\r\n",
663 pSocket
->errno
= ENOMEM
;
667 "0x%08x: Created listen completion event\r\n",
668 pTcp4
->ListenToken
.CompletionToken
.Event
));
671 // Configure the port
673 pTcp4Protocol
= pPort
->pProtocol
.TCPv4
;
674 Status
= pTcp4Protocol
->Configure ( pTcp4Protocol
,
675 &pTcp4
->ConfigData
);
676 if ( EFI_ERROR ( Status
)) {
677 DEBUG (( DEBUG_LISTEN
,
678 "ERROR - Failed to configure the Tcp4 port, Status: %r\r\n",
681 case EFI_ACCESS_DENIED
:
682 pSocket
->errno
= EACCES
;
686 case EFI_DEVICE_ERROR
:
687 pSocket
->errno
= EIO
;
690 case EFI_INVALID_PARAMETER
:
691 pSocket
->errno
= EADDRNOTAVAIL
;
695 pSocket
->errno
= EAFNOSUPPORT
;
698 case EFI_OUT_OF_RESOURCES
:
699 pSocket
->errno
= ENOBUFS
;
702 case EFI_UNSUPPORTED
:
703 pSocket
->errno
= EOPNOTSUPP
;
708 DEBUG (( DEBUG_LISTEN
,
709 "0x%08x: Port configured\r\n",
711 pPort
->bConfigured
= TRUE
;
714 // Start the listen operation on the port
716 Status
= pTcp4Protocol
->Accept ( pTcp4Protocol
,
717 &pTcp4
->ListenToken
);
718 if ( EFI_ERROR ( Status
)) {
719 DEBUG (( DEBUG_LISTEN
,
720 "ERROR - Failed Tcp4 accept, Status: %r\r\n",
723 case EFI_ACCESS_DENIED
:
724 pSocket
->errno
= EACCES
;
728 case EFI_DEVICE_ERROR
:
729 pSocket
->errno
= EIO
;
732 case EFI_INVALID_PARAMETER
:
733 pSocket
->errno
= EADDRNOTAVAIL
;
736 case EFI_NOT_STARTED
:
737 pSocket
->errno
= ENETDOWN
;
740 case EFI_OUT_OF_RESOURCES
:
741 pSocket
->errno
= ENOBUFS
;
746 DEBUG (( DEBUG_LISTEN
,
747 "0x%08x: Listen pending on Port\r\n",
751 // Listen is pending on this port
759 pNextPort
= pPort
->pLinkSocket
;
762 // Close the port upon error
764 if ( EFI_ERROR ( Status
)) {
765 EslSocketPortCloseStart ( pPort
, TRUE
, DEBUG_LISTEN
);
775 // Determine if any ports are in the listen state
777 if ( NULL
== pSocket
->pPortList
) {
779 // No ports in the listen state
781 pSocket
->MaxFifoDepth
= 0;
784 // Return the last error detected
790 // Mark the socket as configured
792 pSocket
->bConfigured
= TRUE
;
797 DEBUG (( DEBUG_LISTEN
,
798 "0x%08x: pSocket - Listen pending on socket\r\n",
804 // Return the operation status
806 DBG_EXIT_STATUS ( Status
);
812 Process the connection attempt
814 A system has initiated a connection attempt with a socket in the
815 listen state. Attempt to complete the connection.
817 The TCPv4 layer calls this routine when a connection is made to
818 the socket in the listen state. See the
819 \ref ConnectionManagement section.
821 @param [in] Event The listen completion event
823 @param [in] pPort Address of an ::ESL_PORT structure.
827 EslTcp4ListenComplete (
832 EFI_HANDLE ChildHandle
;
833 struct sockaddr_in LocalAddress
;
834 EFI_TCP4_CONFIG_DATA
* pConfigData
;
837 ESL_SOCKET
* pNewSocket
;
838 ESL_SOCKET
* pSocket
;
839 ESL_TCP4_CONTEXT
* pTcp4
;
840 EFI_TCP4_PROTOCOL
* pTcp4Protocol
;
842 EFI_HANDLE TcpPortHandle
;
843 EFI_STATUS TempStatus
;
846 VERIFY_AT_TPL ( TPL_SOCKETS
);
851 Status
= EFI_SUCCESS
;
854 // Determine if this connection fits into the connection FIFO
856 pSocket
= pPort
->pSocket
;
857 TcpPortHandle
= pPort
->Context
.Tcp4
.ListenToken
.NewChildHandle
;
858 if (( SOCKET_STATE_LISTENING
== pSocket
->State
)
859 && ( pSocket
->MaxFifoDepth
> pSocket
->FifoDepth
)) {
861 // Allocate a socket for this connection
865 Status
= EslSocketAllocate ( &ChildHandle
,
868 if ( !EFI_ERROR ( Status
)) {
870 // Clone the socket parameters
872 pNewSocket
->pApi
= pSocket
->pApi
;
873 pNewSocket
->Domain
= pSocket
->Domain
;
874 pNewSocket
->Protocol
= pSocket
->Protocol
;
875 pNewSocket
->Type
= pSocket
->Type
;
878 // Build the local address
880 pTcp4
= &pPort
->Context
.Tcp4
;
881 LocalAddress
.sin_len
= (uint8_t)pNewSocket
->pApi
->MinimumAddressLength
;
882 LocalAddress
.sin_family
= AF_INET
;
883 LocalAddress
.sin_port
= 0;
884 LocalAddress
.sin_addr
.s_addr
= *(UINT32
*)&pTcp4
->ConfigData
.AccessPoint
.StationAddress
.Addr
[0];
887 // Allocate a port for this connection
888 // Note in this instance Configure may not be called with NULL!
890 Status
= EslSocketPortAllocate ( pNewSocket
,
893 (struct sockaddr
*)&LocalAddress
,
897 if ( !EFI_ERROR ( Status
)) {
899 // Restart the listen operation on the port
901 pTcp4Protocol
= pPort
->pProtocol
.TCPv4
;
902 Status
= pTcp4Protocol
->Accept ( pTcp4Protocol
,
903 &pTcp4
->ListenToken
);
906 // Close the TCP port using SocketClose
908 TcpPortHandle
= NULL
;
909 pTcp4
= &pNewPort
->Context
.Tcp4
;
912 // Check for an accept call error
914 if ( !EFI_ERROR ( Status
)) {
916 // Get the port configuration
918 pNewPort
->bConfigured
= TRUE
;
919 pConfigData
= &pTcp4
->ConfigData
;
920 pConfigData
->ControlOption
= &pTcp4
->Option
;
921 pTcp4Protocol
= pNewPort
->pProtocol
.TCPv4
;
922 Status
= pTcp4Protocol
->GetModeData ( pTcp4Protocol
,
928 if ( !EFI_ERROR ( Status
)) {
930 // Add the new socket to the connection FIFO
932 if ( NULL
== pSocket
->pFifoTail
) {
936 pSocket
->pFifoHead
= pNewSocket
;
940 // Add to end of list.
942 pSocket
->pFifoTail
->pNextConnection
= pNewSocket
;
944 pSocket
->pFifoTail
= pNewSocket
;
945 pSocket
->FifoDepth
+= 1;
948 // Update the socket state
950 pNewSocket
->State
= SOCKET_STATE_IN_FIFO
;
953 // Log the connection
955 DEBUG (( DEBUG_CONNECTION
| DEBUG_INFO
,
956 "0x%08x: Socket on port %d.%d.%d.%d:%d connected to %d.%d.%d.%d:%d\r\n",
958 pConfigData
->AccessPoint
.StationAddress
.Addr
[0],
959 pConfigData
->AccessPoint
.StationAddress
.Addr
[1],
960 pConfigData
->AccessPoint
.StationAddress
.Addr
[2],
961 pConfigData
->AccessPoint
.StationAddress
.Addr
[3],
962 pConfigData
->AccessPoint
.StationPort
,
963 pConfigData
->AccessPoint
.RemoteAddress
.Addr
[0],
964 pConfigData
->AccessPoint
.RemoteAddress
.Addr
[1],
965 pConfigData
->AccessPoint
.RemoteAddress
.Addr
[2],
966 pConfigData
->AccessPoint
.RemoteAddress
.Addr
[3],
967 pConfigData
->AccessPoint
.RemotePort
));
968 DEBUG (( DEBUG_CONNECTION
| DEBUG_INFO
,
969 "0x%08x: Listen socket adding socket 0x%08x to FIFO, depth: %d\r\n",
972 pSocket
->FifoDepth
));
975 // Start the receive operation
977 EslSocketRxStart ( pNewPort
);
980 DEBUG (( DEBUG_ERROR
| DEBUG_CONNECTION
| DEBUG_INFO
,
981 "ERROR - GetModeData failed on port 0x%08x, Status: %r\r\n",
988 // The listen failed on this port
990 DEBUG (( DEBUG_LISTEN
| DEBUG_INFO
,
991 "ERROR - Listen failed on port 0x%08x, Status: %r\r\n",
996 // Close the listening port
998 EslSocketPortCloseStart ( pPort
, TRUE
, DEBUG_LISTEN
);
1003 // Done with the socket if necessary
1005 if ( EFI_ERROR ( Status
)) {
1006 TempStatus
= EslSocketCloseStart ( &pNewSocket
->SocketProtocol
,
1009 ASSERT ( EFI_SUCCESS
== TempStatus
);
1014 DEBUG (( DEBUG_CONNECTION
,
1015 "0x%08x: Socket FIFO full, connection refused\r\n",
1019 // The FIFO is full or the socket is in the wrong state
1021 Status
= EFI_BUFFER_TOO_SMALL
;
1025 // Close the connection if necessary
1027 if (( EFI_ERROR ( Status
))
1028 && ( NULL
== TcpPortHandle
)) {
1030 // TODO: Finish this code path
1031 // The new connection does not fit into the connection FIFO
1035 // Release the resources
1044 Get the local socket address.
1046 This routine returns the IPv4 address and TCP port number associated
1047 with the local socket.
1049 This routine is called by ::EslSocketGetLocalAddress to determine the
1050 network address for the SOCK_STREAM or SOCK_SEQPACKET socket.
1052 @param [in] pPort Address of an ::ESL_PORT structure.
1054 @param [out] pSockAddr Network address to receive the local system address
1058 EslTcp4LocalAddressGet (
1059 IN ESL_PORT
* pPort
,
1060 OUT
struct sockaddr
* pSockAddr
1063 struct sockaddr_in
* pLocalAddress
;
1064 ESL_TCP4_CONTEXT
* pTcp4
;
1069 // Return the local address
1071 pTcp4
= &pPort
->Context
.Tcp4
;
1072 pLocalAddress
= (struct sockaddr_in
*)pSockAddr
;
1073 pLocalAddress
->sin_family
= AF_INET
;
1074 pLocalAddress
->sin_port
= SwapBytes16 ( pTcp4
->ConfigData
.AccessPoint
.StationPort
);
1075 CopyMem ( &pLocalAddress
->sin_addr
,
1076 &pTcp4
->ConfigData
.AccessPoint
.StationAddress
.Addr
[0],
1077 sizeof ( pLocalAddress
->sin_addr
));
1084 Set the local port address.
1086 This routine sets the local port address.
1088 This support routine is called by ::EslSocketPortAllocate.
1090 @param [in] pPort Address of an ESL_PORT structure
1091 @param [in] pSockAddr Address of a sockaddr structure that contains the
1092 connection point on the local machine. An IPv4 address
1093 of INADDR_ANY specifies that the connection is made to
1094 all of the network stacks on the platform. Specifying a
1095 specific IPv4 address restricts the connection to the
1096 network stack supporting that address. Specifying zero
1097 for the port causes the network layer to assign a port
1098 number from the dynamic range. Specifying a specific
1099 port number causes the network layer to use that port.
1101 @param [in] bBindTest TRUE = run bind testing
1103 @retval EFI_SUCCESS The operation was successful
1107 EslTcp4LocalAddressSet (
1108 IN ESL_PORT
* pPort
,
1109 IN CONST
struct sockaddr
* pSockAddr
,
1110 IN BOOLEAN bBindTest
1113 EFI_TCP4_ACCESS_POINT
* pAccessPoint
;
1114 CONST
struct sockaddr_in
* pIpAddress
;
1115 CONST UINT8
* pIpv4Address
;
1121 // Validate the address
1123 pIpAddress
= (struct sockaddr_in
*)pSockAddr
;
1124 if ( INADDR_BROADCAST
== pIpAddress
->sin_addr
.s_addr
) {
1126 // The local address must not be the broadcast address
1128 Status
= EFI_INVALID_PARAMETER
;
1129 pPort
->pSocket
->errno
= EADDRNOTAVAIL
;
1133 // Set the local address
1135 pIpv4Address
= (UINT8
*)&pIpAddress
->sin_addr
.s_addr
;
1136 pAccessPoint
= &pPort
->Context
.Tcp4
.ConfigData
.AccessPoint
;
1137 pAccessPoint
->StationAddress
.Addr
[0] = pIpv4Address
[0];
1138 pAccessPoint
->StationAddress
.Addr
[1] = pIpv4Address
[1];
1139 pAccessPoint
->StationAddress
.Addr
[2] = pIpv4Address
[2];
1140 pAccessPoint
->StationAddress
.Addr
[3] = pIpv4Address
[3];
1143 // Determine if the default address is used
1145 pAccessPoint
->UseDefaultAddress
= (BOOLEAN
)( 0 == pIpAddress
->sin_addr
.s_addr
);
1148 // Set the subnet mask
1150 if ( pAccessPoint
->UseDefaultAddress
) {
1151 pAccessPoint
->SubnetMask
.Addr
[0] = 0;
1152 pAccessPoint
->SubnetMask
.Addr
[1] = 0;
1153 pAccessPoint
->SubnetMask
.Addr
[2] = 0;
1154 pAccessPoint
->SubnetMask
.Addr
[3] = 0;
1157 pAccessPoint
->SubnetMask
.Addr
[0] = 0xff;
1158 pAccessPoint
->SubnetMask
.Addr
[1] = 0xff;
1159 pAccessPoint
->SubnetMask
.Addr
[2] = 0xff;
1160 pAccessPoint
->SubnetMask
.Addr
[3] = 0xff;
1164 // Validate the IP address
1166 pAccessPoint
->StationPort
= 0;
1167 Status
= bBindTest
? EslSocketBindTest ( pPort
, EADDRNOTAVAIL
)
1169 if ( !EFI_ERROR ( Status
)) {
1171 // Set the port number
1173 pAccessPoint
->StationPort
= SwapBytes16 ( pIpAddress
->sin_port
);
1174 pPort
->pSocket
->bAddressSet
= TRUE
;
1177 // Display the local address
1179 DEBUG (( DEBUG_BIND
,
1180 "0x%08x: Port, Local TCP4 Address: %d.%d.%d.%d:%d\r\n",
1182 pAccessPoint
->StationAddress
.Addr
[0],
1183 pAccessPoint
->StationAddress
.Addr
[1],
1184 pAccessPoint
->StationAddress
.Addr
[2],
1185 pAccessPoint
->StationAddress
.Addr
[3],
1186 pAccessPoint
->StationPort
));
1191 // Return the operation status
1193 DBG_EXIT_STATUS ( Status
);
1199 Free a receive packet
1201 This routine performs the network specific operations necessary
1202 to free a receive packet.
1204 This routine is called by ::EslSocketPortCloseTxDone to free a
1207 @param [in] pPacket Address of an ::ESL_PACKET structure.
1208 @param [in, out] pRxBytes Address of the count of RX bytes
1213 IN ESL_PACKET
* pPacket
,
1214 IN OUT
size_t * pRxBytes
1220 // Account for the receive bytes
1222 *pRxBytes
-= pPacket
->Op
.Tcp4Rx
.RxData
.DataLength
;
1228 Initialize the network specific portions of an ::ESL_PORT structure.
1230 This routine initializes the network specific portions of an
1231 ::ESL_PORT structure for use by the socket.
1233 This support routine is called by ::EslSocketPortAllocate
1234 to connect the socket with the underlying network adapter
1235 running the TCPv4 protocol.
1237 @param [in] pPort Address of an ESL_PORT structure
1238 @param [in] DebugFlags Flags for debug messages
1240 @retval EFI_SUCCESS - Socket successfully created
1244 EslTcp4PortAllocate (
1245 IN ESL_PORT
* pPort
,
1249 EFI_TCP4_ACCESS_POINT
* pAccessPoint
;
1250 ESL_SOCKET
* pSocket
;
1251 ESL_TCP4_CONTEXT
* pTcp4
;
1257 // Use for/break instead of goto
1260 // Allocate the close event
1262 pSocket
= pPort
->pSocket
;
1263 pTcp4
= &pPort
->Context
.Tcp4
;
1264 Status
= gBS
->CreateEvent ( EVT_NOTIFY_SIGNAL
,
1266 (EFI_EVENT_NOTIFY
)EslSocketPortCloseComplete
,
1268 &pTcp4
->CloseToken
.CompletionToken
.Event
);
1269 if ( EFI_ERROR ( Status
)) {
1270 DEBUG (( DEBUG_ERROR
| DebugFlags
,
1271 "ERROR - Failed to create the close event, Status: %r\r\n",
1273 pSocket
->errno
= ENOMEM
;
1276 DEBUG (( DEBUG_CLOSE
| DEBUG_POOL
,
1277 "0x%08x: Created close event\r\n",
1278 pTcp4
->CloseToken
.CompletionToken
.Event
));
1281 // Allocate the connection event
1283 Status
= gBS
->CreateEvent ( EVT_NOTIFY_SIGNAL
,
1285 (EFI_EVENT_NOTIFY
)EslTcp4ConnectComplete
,
1287 &pTcp4
->ConnectToken
.CompletionToken
.Event
);
1288 if ( EFI_ERROR ( Status
)) {
1289 DEBUG (( DEBUG_ERROR
| DebugFlags
,
1290 "ERROR - Failed to create the connect event, Status: %r\r\n",
1292 pSocket
->errno
= ENOMEM
;
1295 DEBUG (( DEBUG_CLOSE
| DEBUG_POOL
,
1296 "0x%08x: Created connect event\r\n",
1297 pTcp4
->ConnectToken
.CompletionToken
.Event
));
1300 // Initialize the port
1302 pSocket
->TxPacketOffset
= OFFSET_OF ( ESL_PACKET
, Op
.Tcp4Tx
.TxData
);
1303 pSocket
->TxTokenEventOffset
= OFFSET_OF ( ESL_IO_MGMT
, Token
.Tcp4Tx
.CompletionToken
.Event
);
1304 pSocket
->TxTokenOffset
= OFFSET_OF ( EFI_TCP4_IO_TOKEN
, Packet
.TxData
);
1307 // Save the cancel, receive and transmit addresses
1308 // pPort->pfnRxCancel = NULL; since the UEFI implementation returns EFI_UNSUPPORTED
1310 pPort
->pfnConfigure
= (PFN_NET_CONFIGURE
)pPort
->pProtocol
.TCPv4
->Configure
;
1311 pPort
->pfnRxPoll
= (PFN_NET_POLL
)pPort
->pProtocol
.TCPv4
->Poll
;
1312 pPort
->pfnRxStart
= (PFN_NET_IO_START
)pPort
->pProtocol
.TCPv4
->Receive
;
1313 pPort
->pfnTxStart
= (PFN_NET_IO_START
)pPort
->pProtocol
.TCPv4
->Transmit
;
1316 // Set the configuration flags
1318 pAccessPoint
= &pPort
->Context
.Tcp4
.ConfigData
.AccessPoint
;
1319 pAccessPoint
->ActiveFlag
= FALSE
;
1320 pTcp4
->ConfigData
.TimeToLive
= 255;
1325 // Return the operation status
1327 DBG_EXIT_STATUS ( Status
);
1335 This routine releases the network specific resources allocated by
1336 ::EslTcp4PortAllocate.
1338 This routine is called by ::EslSocketPortClose.
1339 See the \ref PortCloseStateMachine section.
1341 @param [in] pPort Address of an ::ESL_PORT structure.
1343 @retval EFI_SUCCESS The port is closed
1344 @retval other Port close error
1353 ESL_TCP4_CONTEXT
* pTcp4
;
1359 // Locate the port in the socket list
1361 Status
= EFI_SUCCESS
;
1362 DebugFlags
= pPort
->DebugFlags
;
1363 pTcp4
= &pPort
->Context
.Tcp4
;
1366 // Done with the connect event
1368 if ( NULL
!= pTcp4
->ConnectToken
.CompletionToken
.Event
) {
1369 Status
= gBS
->CloseEvent ( pTcp4
->ConnectToken
.CompletionToken
.Event
);
1370 if ( !EFI_ERROR ( Status
)) {
1371 DEBUG (( DebugFlags
| DEBUG_POOL
,
1372 "0x%08x: Closed connect event\r\n",
1373 pTcp4
->ConnectToken
.CompletionToken
.Event
));
1376 DEBUG (( DEBUG_ERROR
| DebugFlags
,
1377 "ERROR - Failed to close the connect event, Status: %r\r\n",
1379 ASSERT ( EFI_SUCCESS
== Status
);
1384 // Done with the close event
1386 if ( NULL
!= pTcp4
->CloseToken
.CompletionToken
.Event
) {
1387 Status
= gBS
->CloseEvent ( pTcp4
->CloseToken
.CompletionToken
.Event
);
1388 if ( !EFI_ERROR ( Status
)) {
1389 DEBUG (( DebugFlags
| DEBUG_POOL
,
1390 "0x%08x: Closed close event\r\n",
1391 pTcp4
->CloseToken
.CompletionToken
.Event
));
1394 DEBUG (( DEBUG_ERROR
| DebugFlags
,
1395 "ERROR - Failed to close the close event, Status: %r\r\n",
1397 ASSERT ( EFI_SUCCESS
== Status
);
1402 // Done with the listen completion event
1404 if ( NULL
!= pTcp4
->ListenToken
.CompletionToken
.Event
) {
1405 Status
= gBS
->CloseEvent ( pTcp4
->ListenToken
.CompletionToken
.Event
);
1406 if ( !EFI_ERROR ( Status
)) {
1407 DEBUG (( DebugFlags
| DEBUG_POOL
,
1408 "0x%08x: Closed listen completion event\r\n",
1409 pTcp4
->ListenToken
.CompletionToken
.Event
));
1412 DEBUG (( DEBUG_ERROR
| DebugFlags
,
1413 "ERROR - Failed to close the listen completion event, Status: %r\r\n",
1415 ASSERT ( EFI_SUCCESS
== Status
);
1420 // Return the operation status
1422 DBG_EXIT_STATUS ( Status
);
1428 Perform the network specific close operation on the port.
1430 This routine performs a cancel operations on the TCPv4 port to
1431 shutdown the receive operations on the port.
1433 This routine is called by the ::EslSocketPortCloseTxDone
1434 routine after the port completes all of the transmission.
1436 @param [in] pPort Address of an ::ESL_PORT structure.
1438 @retval EFI_SUCCESS The port is closed, not normally returned
1439 @retval EFI_NOT_READY The port is still closing
1440 @retval EFI_ALREADY_STARTED Error, the port is in the wrong state,
1441 most likely the routine was called already.
1445 EslTcp4PortCloseOp (
1449 ESL_TCP4_CONTEXT
* pTcp4
;
1450 EFI_TCP4_PROTOCOL
* pTcp4Protocol
;
1456 // Close the configured port
1458 Status
= EFI_SUCCESS
;
1459 pTcp4
= &pPort
->Context
.Tcp4
;
1460 pTcp4Protocol
= pPort
->pProtocol
.TCPv4
;
1461 pTcp4
->CloseToken
.AbortOnClose
= pPort
->bCloseNow
;
1462 Status
= pTcp4Protocol
->Close ( pTcp4Protocol
,
1463 &pTcp4
->CloseToken
);
1464 if ( !EFI_ERROR ( Status
)) {
1465 DEBUG (( pPort
->DebugFlags
| DEBUG_CLOSE
| DEBUG_INFO
,
1466 "0x%08x: Port close started\r\n",
1470 DEBUG (( DEBUG_ERROR
| pPort
->DebugFlags
| DEBUG_CLOSE
| DEBUG_INFO
,
1471 "ERROR - Close failed on port 0x%08x, Status: %r\r\n",
1477 // Return the operation status
1479 DBG_EXIT_STATUS ( Status
);
1485 Receive data from a network connection.
1487 This routine attempts to return buffered data to the caller. The
1488 data is removed from the urgent queue if the message flag MSG_OOB
1489 is specified, otherwise data is removed from the normal queue.
1490 See the \ref ReceiveEngine section.
1492 This routine is called by ::EslSocketReceive to handle the network
1493 specific receive operation to support SOCK_STREAM and SOCK_SEQPACKET
1496 @param [in] pPort Address of an ::ESL_PORT structure.
1498 @param [in] pPacket Address of an ::ESL_PACKET structure.
1500 @param [in] pbConsumePacket Address of a BOOLEAN indicating if the packet is to be consumed
1502 @param [in] BufferLength Length of the the buffer
1504 @param [in] pBuffer Address of a buffer to receive the data.
1506 @param [in] pDataLength Number of received data bytes in the buffer.
1508 @param [out] pAddress Network address to receive the remote system address
1510 @param [out] pSkipBytes Address to receive the number of bytes skipped
1512 @return Returns the address of the next free byte in the buffer.
1517 IN ESL_PORT
* pPort
,
1518 IN ESL_PACKET
* pPacket
,
1519 IN BOOLEAN
* pbConsumePacket
,
1520 IN
size_t BufferLength
,
1522 OUT
size_t * pDataLength
,
1523 OUT
struct sockaddr
* pAddress
,
1524 OUT
size_t * pSkipBytes
1528 struct sockaddr_in
* pRemoteAddress
;
1529 ESL_TCP4_CONTEXT
* pTcp4
;
1534 // Return the remote system address if requested
1536 if ( NULL
!= pAddress
) {
1538 // Build the remote address
1540 pTcp4
= &pPort
->Context
.Tcp4
;
1542 "Getting packet remote address: %d.%d.%d.%d:%d\r\n",
1543 pTcp4
->ConfigData
.AccessPoint
.RemoteAddress
.Addr
[0],
1544 pTcp4
->ConfigData
.AccessPoint
.RemoteAddress
.Addr
[1],
1545 pTcp4
->ConfigData
.AccessPoint
.RemoteAddress
.Addr
[2],
1546 pTcp4
->ConfigData
.AccessPoint
.RemoteAddress
.Addr
[3],
1547 pTcp4
->ConfigData
.AccessPoint
.RemotePort
));
1548 pRemoteAddress
= (struct sockaddr_in
*)pAddress
;
1549 CopyMem ( &pRemoteAddress
->sin_addr
,
1550 &pTcp4
->ConfigData
.AccessPoint
.RemoteAddress
.Addr
[0],
1551 sizeof ( pRemoteAddress
->sin_addr
));
1552 pRemoteAddress
->sin_port
= SwapBytes16 ( pTcp4
->ConfigData
.AccessPoint
.RemotePort
);
1556 // Determine the amount of received data
1558 DataLength
= pPacket
->ValidBytes
;
1559 if ( BufferLength
< DataLength
) {
1560 DataLength
= BufferLength
;
1564 // Move the data into the buffer
1567 "0x%08x: Port copy packet 0x%08x data into 0x%08x, 0x%08x bytes\r\n",
1572 CopyMem ( pBuffer
, pPacket
->pBuffer
, DataLength
);
1575 // Set the next buffer address
1577 pBuffer
+= DataLength
;
1580 // Determine if the data is being read
1582 if ( *pbConsumePacket
) {
1584 // Account for the bytes consumed
1586 pPacket
->pBuffer
+= DataLength
;
1587 pPacket
->ValidBytes
-= DataLength
;
1589 "0x%08x: Port account for 0x%08x bytes\r\n",
1594 // Determine if the entire packet was consumed
1596 if (( 0 == pPacket
->ValidBytes
)
1597 || ( SOCK_STREAM
!= pPort
->pSocket
->Type
)) {
1599 // All done with this packet
1600 // Account for any discarded data
1602 *pSkipBytes
= pPacket
->ValidBytes
;
1607 // More data to consume later
1609 *pbConsumePacket
= FALSE
;
1614 // Return the data length and the buffer address
1616 *pDataLength
= DataLength
;
1617 DBG_EXIT_HEX ( pBuffer
);
1623 Get the remote socket address.
1625 This routine returns the address of the remote connection point
1626 associated with the SOCK_STREAM or SOCK_SEQPACKET socket.
1628 This routine is called by ::EslSocketGetPeerAddress to detemine
1629 the TCPv4 address and por number associated with the network adapter.
1631 @param [in] pPort Address of an ::ESL_PORT structure.
1633 @param [out] pAddress Network address to receive the remote system address
1637 EslTcp4RemoteAddressGet (
1638 IN ESL_PORT
* pPort
,
1639 OUT
struct sockaddr
* pAddress
1642 struct sockaddr_in
* pRemoteAddress
;
1643 ESL_TCP4_CONTEXT
* pTcp4
;
1648 // Return the remote address
1650 pTcp4
= &pPort
->Context
.Tcp4
;
1651 pRemoteAddress
= (struct sockaddr_in
*)pAddress
;
1652 pRemoteAddress
->sin_family
= AF_INET
;
1653 pRemoteAddress
->sin_port
= SwapBytes16 ( pTcp4
->ConfigData
.AccessPoint
.RemotePort
);
1654 CopyMem ( &pRemoteAddress
->sin_addr
,
1655 &pTcp4
->ConfigData
.AccessPoint
.RemoteAddress
.Addr
[0],
1656 sizeof ( pRemoteAddress
->sin_addr
));
1663 Set the remote address
1665 This routine sets the remote address in the port.
1667 This routine is called by ::EslSocketConnect to specify the
1668 remote network address.
1670 @param [in] pPort Address of an ::ESL_PORT structure.
1672 @param [in] pSockAddr Network address of the remote system.
1674 @param [in] SockAddrLength Length in bytes of the network address.
1676 @retval EFI_SUCCESS The operation was successful
1680 EslTcp4RemoteAddressSet (
1681 IN ESL_PORT
* pPort
,
1682 IN CONST
struct sockaddr
* pSockAddr
,
1683 IN socklen_t SockAddrLength
1686 CONST
struct sockaddr_in
* pRemoteAddress
;
1687 ESL_TCP4_CONTEXT
* pTcp4
;
1693 // Set the remote address
1695 pTcp4
= &pPort
->Context
.Tcp4
;
1696 pRemoteAddress
= (struct sockaddr_in
*)pSockAddr
;
1697 pTcp4
->ConfigData
.AccessPoint
.RemoteAddress
.Addr
[0] = (UINT8
)( pRemoteAddress
->sin_addr
.s_addr
);
1698 pTcp4
->ConfigData
.AccessPoint
.RemoteAddress
.Addr
[1] = (UINT8
)( pRemoteAddress
->sin_addr
.s_addr
>> 8 );
1699 pTcp4
->ConfigData
.AccessPoint
.RemoteAddress
.Addr
[2] = (UINT8
)( pRemoteAddress
->sin_addr
.s_addr
>> 16 );
1700 pTcp4
->ConfigData
.AccessPoint
.RemoteAddress
.Addr
[3] = (UINT8
)( pRemoteAddress
->sin_addr
.s_addr
>> 24 );
1701 pTcp4
->ConfigData
.AccessPoint
.RemotePort
= SwapBytes16 ( pRemoteAddress
->sin_port
);
1702 Status
= EFI_SUCCESS
;
1703 if ( INADDR_BROADCAST
== pRemoteAddress
->sin_addr
.s_addr
) {
1704 DEBUG (( DEBUG_CONNECT
,
1705 "ERROR - Invalid remote address\r\n" ));
1706 Status
= EFI_INVALID_PARAMETER
;
1707 pPort
->pSocket
->errno
= EAFNOSUPPORT
;
1711 // Return the operation status
1713 DBG_EXIT_STATUS ( Status
);
1719 Process the receive completion
1721 This routine queues the data in FIFO order in either the urgent
1722 or normal data queues depending upon the type of data received.
1723 See the \ref ReceiveEngine section.
1725 This routine is called by the TCPv4 driver when some data is
1728 Buffer the data that was just received.
1730 @param [in] Event The receive completion event
1732 @param [in] pIo Address of an ::ESL_IO_MGMT structure
1738 IN ESL_IO_MGMT
* pIo
1742 size_t LengthInBytes
;
1743 ESL_PACKET
* pPacket
;
1749 // Get the operation status.
1751 Status
= pIo
->Token
.Tcp4Rx
.CompletionToken
.Status
;
1754 // +--------------------+ +---------------------------+
1755 // | ESL_IO_MGMT | | ESL_PACKET |
1757 // | +---------------+ +-----------------------+ |
1758 // | | Token | | EFI_TCP4_RECEIVE_DATA | |
1759 // | | RxData --> | | |
1760 // | | | +-----------------------+---+
1761 // | | Event | | Data Buffer |
1762 // +----+---------------+ | |
1764 // +---------------------------+
1767 // Duplicate the buffer address and length for use by the
1768 // buffer handling code in EslTcp4Receive. These fields are
1769 // used when a partial read is done of the data from the
1772 pPacket
= pIo
->pPacket
;
1773 pPacket
->pBuffer
= pPacket
->Op
.Tcp4Rx
.RxData
.FragmentTable
[0].FragmentBuffer
;
1774 LengthInBytes
= pPacket
->Op
.Tcp4Rx
.RxData
.DataLength
;
1775 pPacket
->ValidBytes
= LengthInBytes
;
1778 // Get the data type so that it may be linked to the
1779 // correct receive buffer list on the ESL_SOCKET structure
1781 bUrgent
= pPacket
->Op
.Tcp4Rx
.RxData
.UrgentFlag
;
1784 // Complete this request
1786 EslSocketRxComplete ( pIo
, Status
, LengthInBytes
, bUrgent
);
1792 Start a receive operation
1794 This routine posts a receive buffer to the TCPv4 driver.
1795 See the \ref ReceiveEngine section.
1797 This support routine is called by EslSocketRxStart.
1799 @param [in] pPort Address of an ::ESL_PORT structure.
1800 @param [in] pIo Address of an ::ESL_IO_MGMT structure.
1805 IN ESL_PORT
* pPort
,
1806 IN ESL_IO_MGMT
* pIo
1809 ESL_PACKET
* pPacket
;
1814 // Initialize the buffer for receive
1816 pPacket
= pIo
->pPacket
;
1817 pIo
->Token
.Tcp4Rx
.Packet
.RxData
= &pPacket
->Op
.Tcp4Rx
.RxData
;
1818 pPacket
->Op
.Tcp4Rx
.RxData
.DataLength
= sizeof ( pPacket
->Op
.Tcp4Rx
.Buffer
);
1819 pPacket
->Op
.Tcp4Rx
.RxData
.FragmentCount
= 1;
1820 pPacket
->Op
.Tcp4Rx
.RxData
.FragmentTable
[0].FragmentLength
= pPacket
->Op
.Tcp4Rx
.RxData
.DataLength
;
1821 pPacket
->Op
.Tcp4Rx
.RxData
.FragmentTable
[0].FragmentBuffer
= &pPacket
->Op
.Tcp4Rx
.Buffer
[0];
1828 Determine if the socket is configured.
1830 This routine uses the flag ESL_SOCKET::bConfigured to determine
1831 if the network layer's configuration routine has been called.
1833 This routine is called by EslSocketIsConfigured to verify
1834 that the socket has been configured.
1836 @param [in] pSocket Address of an ::ESL_SOCKET structure.
1838 @retval EFI_SUCCESS - The port is connected
1839 @retval EFI_NOT_STARTED - The port is not connected
1843 EslTcp4SocketIsConfigured (
1844 IN ESL_SOCKET
* pSocket
1852 // Determine the socket configuration status
1854 Status
= pSocket
->bConfigured
? EFI_SUCCESS
: EFI_NOT_STARTED
;
1857 // Return the port connected state.
1859 DBG_EXIT_STATUS ( Status
);
1865 Buffer data for transmission over a network connection.
1867 This routine buffers data for the transmit engine in one of two
1868 queues, one for urgent (out-of-band) data and the other for normal
1869 data. The urgent data is provided to TCP as soon as it is available,
1870 allowing the TCP layer to schedule transmission of the urgent data
1871 between packets of normal data.
1873 This routine is called by ::EslSocketTransmit to buffer
1874 data for transmission. When the \ref TransmitEngine has resources,
1875 this routine will start the transmission of the next buffer on
1876 the network connection.
1878 Transmission errors are returned during the next transmission or
1879 during the close operation. Only buffering errors are returned
1880 during the current transmission attempt.
1882 @param [in] pSocket Address of an ::ESL_SOCKET structure
1884 @param [in] Flags Message control flags
1886 @param [in] BufferLength Length of the the buffer
1888 @param [in] pBuffer Address of a buffer to receive the data.
1890 @param [in] pDataLength Number of received data bytes in the buffer.
1892 @param [in] pAddress Network address of the remote system address
1894 @param [in] AddressLength Length of the remote network address structure
1896 @retval EFI_SUCCESS - Socket data successfully buffered
1901 IN ESL_SOCKET
* pSocket
,
1903 IN
size_t BufferLength
,
1904 IN CONST UINT8
* pBuffer
,
1905 OUT
size_t * pDataLength
,
1906 IN
const struct sockaddr
* pAddress
,
1907 IN socklen_t AddressLength
1911 BOOLEAN bUrgentQueue
;
1912 ESL_PACKET
* pPacket
;
1913 ESL_IO_MGMT
** ppActive
;
1914 ESL_IO_MGMT
** ppFree
;
1916 ESL_PACKET
** ppQueueHead
;
1917 ESL_PACKET
** ppQueueTail
;
1918 ESL_PACKET
* pPreviousPacket
;
1919 ESL_TCP4_CONTEXT
* pTcp4
;
1921 EFI_TCP4_TRANSMIT_DATA
* pTxData
;
1923 EFI_TPL TplPrevious
;
1930 Status
= EFI_UNSUPPORTED
;
1931 pSocket
->errno
= ENOTCONN
;
1935 // Verify that the socket is connected
1937 if ( SOCKET_STATE_CONNECTED
== pSocket
->State
) {
1941 pPort
= pSocket
->pPortList
;
1942 if ( NULL
!= pPort
) {
1944 // Determine the queue head
1946 pTcp4
= &pPort
->Context
.Tcp4
;
1947 bUrgent
= (BOOLEAN
)( 0 != ( Flags
& MSG_OOB
));
1948 bUrgentQueue
= bUrgent
1949 && ( !pSocket
->bOobInLine
)
1950 && pSocket
->pApi
->bOobSupported
;
1951 if ( bUrgentQueue
) {
1952 ppQueueHead
= &pSocket
->pTxOobPacketListHead
;
1953 ppQueueTail
= &pSocket
->pTxOobPacketListTail
;
1954 ppActive
= &pPort
->pTxOobActive
;
1955 ppFree
= &pPort
->pTxOobFree
;
1956 pTxBytes
= &pSocket
->TxOobBytes
;
1959 ppQueueHead
= &pSocket
->pTxPacketListHead
;
1960 ppQueueTail
= &pSocket
->pTxPacketListTail
;
1961 ppActive
= &pPort
->pTxActive
;
1962 ppFree
= &pPort
->pTxFree
;
1963 pTxBytes
= &pSocket
->TxBytes
;
1967 // Verify that there is enough room to buffer another
1968 // transmit operation
1970 if ( pSocket
->MaxTxBuf
> *pTxBytes
) {
1971 if ( pPort
->bTxFlowControl
) {
1973 "TTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTT\r\n0x%08x: pPort, TX flow control released, Max bytes: %d > %d bufferred bytes\r\n",
1977 pPort
->bTxFlowControl
= FALSE
;
1981 // Attempt to allocate the packet
1983 Status
= EslSocketPacketAllocate ( &pPacket
,
1984 sizeof ( pPacket
->Op
.Tcp4Tx
)
1985 - sizeof ( pPacket
->Op
.Tcp4Tx
.Buffer
)
1989 if ( !EFI_ERROR ( Status
)) {
1991 // Initialize the transmit operation
1993 pTxData
= &pPacket
->Op
.Tcp4Tx
.TxData
;
1994 pTxData
->Push
= TRUE
|| bUrgent
;
1995 pTxData
->Urgent
= bUrgent
;
1996 pTxData
->DataLength
= (UINT32
) BufferLength
;
1997 pTxData
->FragmentCount
= 1;
1998 pTxData
->FragmentTable
[0].FragmentLength
= (UINT32
) BufferLength
;
1999 pTxData
->FragmentTable
[0].FragmentBuffer
= &pPacket
->Op
.Tcp4Tx
.Buffer
[0];
2002 // Copy the data into the buffer
2004 CopyMem ( &pPacket
->Op
.Tcp4Tx
.Buffer
[0],
2009 // Synchronize with the socket layer
2011 RAISE_TPL ( TplPrevious
, TPL_SOCKETS
);
2014 // Stop transmission after an error
2016 if ( !EFI_ERROR ( pSocket
->TxError
)) {
2018 // Display the request
2021 "Send %d %s bytes from 0x%08x\r\n",
2023 bUrgent
? L
"urgent" : L
"normal",
2027 // Queue the data for transmission
2029 pPacket
->pNext
= NULL
;
2030 pPreviousPacket
= *ppQueueTail
;
2031 if ( NULL
== pPreviousPacket
) {
2032 *ppQueueHead
= pPacket
;
2035 pPreviousPacket
->pNext
= pPacket
;
2037 *ppQueueTail
= pPacket
;
2039 "0x%08x: Packet on %s transmit list\r\n",
2041 bUrgentQueue
? L
"urgent" : L
"normal" ));
2044 // Account for the buffered data
2046 *pTxBytes
+= BufferLength
;
2047 *pDataLength
= BufferLength
;
2050 // Start the transmit engine if it is idle
2052 if ( NULL
!= *ppFree
) {
2053 EslSocketTxStart ( pPort
,
2062 // Previous transmit error
2063 // Stop transmission
2065 Status
= pSocket
->TxError
;
2066 pSocket
->errno
= EIO
;
2071 EslSocketPacketFree ( pPacket
, DEBUG_TX
);
2075 // Release the socket layer synchronization
2077 RESTORE_TPL ( TplPrevious
);
2081 // Packet allocation failed
2083 pSocket
->errno
= ENOMEM
;
2087 if ( !pPort
->bTxFlowControl
) {
2089 "0x%08x: pPort, TX flow control applied, Max bytes %d <= %d bufferred bytes\r\nTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTT\r\n",
2093 pPort
->bTxFlowControl
= TRUE
;
2096 // Not enough buffer space available
2098 pSocket
->errno
= EAGAIN
;
2099 Status
= EFI_NOT_READY
;
2105 // Return the operation status
2107 DBG_EXIT_STATUS ( Status
);
2113 Process the normal data transmit completion
2115 This routine use ::EslSocketTxComplete to perform the transmit
2116 completion processing for normal data.
2118 This routine is called by the TCPv4 network layer when a
2119 normal data transmit request completes.
2121 @param [in] Event The normal transmit completion event
2123 @param [in] pIo The ESL_IO_MGMT structure address
2129 IN ESL_IO_MGMT
* pIo
2132 UINT32 LengthInBytes
;
2133 ESL_PACKET
* pPacket
;
2135 ESL_SOCKET
* pSocket
;
2141 // Locate the active transmit packet
2143 pPacket
= pIo
->pPacket
;
2145 pSocket
= pPort
->pSocket
;
2148 // Get the transmit length and status
2150 LengthInBytes
= pPacket
->Op
.Tcp4Tx
.TxData
.DataLength
;
2151 pSocket
->TxBytes
-= LengthInBytes
;
2152 Status
= pIo
->Token
.Tcp4Tx
.CompletionToken
.Status
;
2155 // Complete the transmit operation
2157 EslSocketTxComplete ( pIo
,
2161 &pSocket
->pTxPacketListHead
,
2162 &pSocket
->pTxPacketListTail
,
2170 Process the urgent data transmit completion
2172 This routine use ::EslSocketTxComplete to perform the transmit
2173 completion processing for urgent data.
2175 This routine is called by the TCPv4 network layer when a
2176 urgent data transmit request completes.
2178 @param [in] Event The urgent transmit completion event
2180 @param [in] pIo The ESL_IO_MGMT structure address
2184 EslTcp4TxOobComplete (
2186 IN ESL_IO_MGMT
* pIo
2189 UINT32 LengthInBytes
;
2190 ESL_PACKET
* pPacket
;
2192 ESL_SOCKET
* pSocket
;
2198 // Locate the active transmit packet
2200 pPacket
= pIo
->pPacket
;
2202 pSocket
= pPort
->pSocket
;
2205 // Get the transmit length and status
2207 LengthInBytes
= pPacket
->Op
.Tcp4Tx
.TxData
.DataLength
;
2208 pSocket
->TxOobBytes
-= LengthInBytes
;
2209 Status
= pIo
->Token
.Tcp4Tx
.CompletionToken
.Status
;
2212 // Complete the transmit operation
2214 EslSocketTxComplete ( pIo
,
2218 &pSocket
->pTxOobPacketListHead
,
2219 &pSocket
->pTxOobPacketListTail
,
2220 &pPort
->pTxOobActive
,
2221 &pPort
->pTxOobFree
);
2227 Interface between the socket layer and the network specific
2228 code that supports SOCK_STREAM and SOCK_SEQPACKET sockets
2231 CONST ESL_PROTOCOL_API cEslTcp4Api
= {
2234 OFFSET_OF ( ESL_PORT
, Context
.Tcp4
.ConfigData
),
2235 OFFSET_OF ( ESL_LAYER
, pTcp4List
),
2236 OFFSET_OF ( struct sockaddr_in
, sin_zero
),
2237 sizeof ( struct sockaddr_in
),
2239 sizeof (((ESL_PACKET
*)0 )->Op
.Tcp4Rx
),
2240 OFFSET_OF ( ESL_PACKET
, Op
.Tcp4Rx
.Buffer
) - OFFSET_OF ( ESL_PACKET
, Op
),
2241 OFFSET_OF ( ESL_IO_MGMT
, Token
.Tcp4Rx
.Packet
.RxData
),
2246 EslTcp4ConnectStart
,
2247 EslTcp4SocketIsConfigured
,
2248 EslTcp4LocalAddressGet
,
2249 EslTcp4LocalAddressSet
,
2254 EslTcp4PortAllocate
,
2259 EslTcp4RemoteAddressGet
,
2260 EslTcp4RemoteAddressSet
,
2265 EslTcp4TxOobComplete