StdLib/EfiSocketLib/Tcp4.c

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