3 Copyright (c) 2005 - 2006, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
23 #define TCP_COMP_VAL(Min, Max, Default, Val) \
24 ((((Val) <= (Max)) && ((Val) >= (Min))) ? (Val) : (Default))
30 IN TCP4_ROUTE_INFO
*RouteInfo
36 Add or remove a route entry in the IP route table associated
37 with this TCP instance.
41 Tcb - Pointer to the TCP_CB of this TCP instance.
42 RouteInfo - Pointer to the route info to be processed.
46 EFI_SUCCESS - The operation completed successfully.
47 EFI_NOT_STARTED - The driver instance has not been started.
48 EFI_NO_MAPPING - When using the default address, configuration(DHCP,
49 BOOTP, RARP, etc.) is not finished yet.
50 EFI_OUT_OF_RESOURCES - Could not add the entry to the routing table.
51 EFI_NOT_FOUND - This route is not in the routing table
52 (when RouteInfo->DeleteRoute is TRUE).
53 EFI_ACCESS_DENIED - The route is already defined in the routing table
54 (when RouteInfo->DeleteRoute is FALSE).
66 RouteInfo
->DeleteRoute
,
67 RouteInfo
->SubnetAddress
,
68 RouteInfo
->SubnetMask
,
69 RouteInfo
->GatewayAddress
76 Get the operational settings of this TCP instance.
78 @param Tcb Pointer to the TCP_CB of this TCP instance.
79 @param Mode Pointer to the buffer to store the operational
82 @retval EFI_SUCCESS The mode data is read.
83 @retval EFI_NOT_STARTED No configuration data is available because this
84 instance hasn't been started.
91 IN TCP4_MODE_DATA
*Mode
95 EFI_TCP4_CONFIG_DATA
*ConfigData
;
96 EFI_TCP4_ACCESS_POINT
*AccessPoint
;
97 EFI_TCP4_OPTION
*Option
;
102 if (!SOCK_IS_CONFIGURED (Sock
) && (Mode
->Tcp4ConfigData
!= NULL
)) {
103 return EFI_NOT_STARTED
;
106 if (Mode
->Tcp4State
) {
107 *(Mode
->Tcp4State
) = (EFI_TCP4_CONNECTION_STATE
) Tcb
->State
;
110 if (Mode
->Tcp4ConfigData
) {
112 ConfigData
= Mode
->Tcp4ConfigData
;
113 AccessPoint
= &(ConfigData
->AccessPoint
);
114 Option
= ConfigData
->ControlOption
;
116 ConfigData
->TypeOfService
= Tcb
->TOS
;
117 ConfigData
->TimeToLive
= Tcb
->TTL
;
119 AccessPoint
->UseDefaultAddress
= Tcb
->UseDefaultAddr
;
121 CopyMem (&AccessPoint
->StationAddress
, &Tcb
->LocalEnd
.Ip
, sizeof (EFI_IPv4_ADDRESS
));
122 AccessPoint
->SubnetMask
= Tcb
->SubnetMask
;
123 AccessPoint
->StationPort
= NTOHS (Tcb
->LocalEnd
.Port
);
125 CopyMem (&AccessPoint
->RemoteAddress
, &Tcb
->RemoteEnd
.Ip
, sizeof (EFI_IPv4_ADDRESS
));
126 AccessPoint
->RemotePort
= NTOHS (Tcb
->RemoteEnd
.Port
);
127 AccessPoint
->ActiveFlag
= (BOOLEAN
) (Tcb
->State
!= TCP_LISTEN
);
129 if (Option
!= NULL
) {
130 Option
->ReceiveBufferSize
= GET_RCV_BUFFSIZE (Tcb
->Sk
);
131 Option
->SendBufferSize
= GET_SND_BUFFSIZE (Tcb
->Sk
);
132 Option
->MaxSynBackLog
= GET_BACKLOG (Tcb
->Sk
);
134 Option
->ConnectionTimeout
= Tcb
->ConnectTimeout
/ TCP_TICK_HZ
;
135 Option
->DataRetries
= Tcb
->MaxRexmit
;
136 Option
->FinTimeout
= Tcb
->FinWait2Timeout
/ TCP_TICK_HZ
;
137 Option
->TimeWaitTimeout
= Tcb
->TimeWaitTimeout
/ TCP_TICK_HZ
;
138 Option
->KeepAliveProbes
= Tcb
->MaxKeepAlive
;
139 Option
->KeepAliveTime
= Tcb
->KeepAliveIdle
/ TCP_TICK_HZ
;
140 Option
->KeepAliveInterval
= Tcb
->KeepAlivePeriod
/ TCP_TICK_HZ
;
142 Option
->EnableNagle
= (BOOLEAN
) (!TCP_FLG_ON (Tcb
->CtrlFlag
, TCP_CTRL_NO_NAGLE
));
143 Option
->EnableTimeStamp
= (BOOLEAN
) (!TCP_FLG_ON (Tcb
->CtrlFlag
, TCP_CTRL_NO_TS
));
144 Option
->EnableWindowScaling
= (BOOLEAN
) (!TCP_FLG_ON (Tcb
->CtrlFlag
, TCP_CTRL_NO_WS
));
146 Option
->EnableSelectiveAck
= FALSE
;
147 Option
->EnablePathMtuDiscovery
= FALSE
;
151 Ip
= Tcb
->IpInfo
->Ip
;
154 return Ip
->GetModeData (Ip
, Mode
->Ip4ModeData
, Mode
->MnpConfigData
, Mode
->SnpModeData
);
159 If AP->StationPort isn't zero, check whether the access point
160 is registered, else generate a random station port for this
163 @param AP Pointer to the access point.
165 @retval EFI_SUCCESS The check is passed or the port is assigned.
166 @retval EFI_INVALID_PARAMETER The non-zero station port is already used.
167 @retval EFI_OUT_OF_RESOURCES No port can be allocated.
173 IN EFI_TCP4_ACCESS_POINT
*AP
178 if (0 != AP
->StationPort
) {
180 // check if a same endpoint is bound
182 if (TcpFindTcbByPeer (&AP
->StationAddress
, AP
->StationPort
)) {
184 return EFI_INVALID_PARAMETER
;
188 // generate a random port
192 if (TCP4_PORT_USER_RESERVED
== mTcp4RandomPort
) {
193 mTcp4RandomPort
= TCP4_PORT_KNOWN
;
198 while (TcpFindTcbByPeer (&AP
->StationAddress
, mTcp4RandomPort
)) {
202 if (mTcp4RandomPort
<= TCP4_PORT_KNOWN
) {
205 DEBUG ((EFI_D_ERROR
, "Tcp4Bind: no port can be allocated "
208 return EFI_OUT_OF_RESOURCES
;
211 mTcp4RandomPort
= TCP4_PORT_KNOWN
+ 1;
218 AP
->StationPort
= mTcp4RandomPort
;
226 Flush the Tcb add its associated protocols..
228 @param Tcb Pointer to the TCP_CB to be flushed.
230 @retval EFI_SUCCESS The operation is completed successfully.
240 TCP4_PROTO_DATA
*TcpProto
;
242 IpIoConfigIp (Tcb
->IpInfo
, NULL
);
245 TcpProto
= (TCP4_PROTO_DATA
*) Sock
->ProtoReserved
;
247 if (SOCK_IS_CONFIGURED (Sock
)) {
248 RemoveEntryList (&Tcb
->List
);
251 // Uninstall the device path protocl.
253 gBS
->UninstallProtocolInterface (
255 &gEfiDevicePathProtocolGuid
,
258 gBS
->FreePool (Sock
->DevicePath
);
260 TcpSetVariableData (TcpProto
->TcpService
);
263 NetbufFreeList (&Tcb
->SndQue
);
264 NetbufFreeList (&Tcb
->RcvQue
);
274 TCP4_PROTO_DATA
*ProtoData
;
277 Tcb
= AllocateZeroPool (sizeof (TCP_CB
));
281 DEBUG ((EFI_D_ERROR
, "Tcp4ConfigurePcb: failed to allocate a TCB\n"));
283 return EFI_OUT_OF_RESOURCES
;
286 ProtoData
= (TCP4_PROTO_DATA
*) Sk
->ProtoReserved
;
287 IpIo
= ProtoData
->TcpService
->IpIo
;
290 // Create an IpInfo for this Tcb.
292 Tcb
->IpInfo
= IpIoAddIp (IpIo
);
293 if (Tcb
->IpInfo
== NULL
) {
296 return EFI_OUT_OF_RESOURCES
;
299 InitializeListHead (&Tcb
->List
);
300 InitializeListHead (&Tcb
->SndQue
);
301 InitializeListHead (&Tcb
->RcvQue
);
303 Tcb
->State
= TCP_CLOSED
;
305 ProtoData
->TcpPcb
= Tcb
;
316 TCP4_PROTO_DATA
*ProtoData
;
319 ProtoData
= (TCP4_PROTO_DATA
*) Sk
->ProtoReserved
;
320 Tcb
= ProtoData
->TcpPcb
;
322 ASSERT (Tcb
!= NULL
);
326 IpIoRemoveIp (ProtoData
->TcpService
->IpIo
, Tcb
->IpInfo
);
330 ProtoData
->TcpPcb
= NULL
;
335 Configure the Tcb using CfgData.
337 @param Sk Pointer to the socket of this TCP instance.
338 @param SkTcb Pointer to the TCP_CB of this TCP instance.
339 @param CfgData Pointer to the TCP configuration data.
341 @retval EFI_SUCCESS The operation is completed successfully.
342 @retval EFI_INVALID_PARAMETER A same access point has been configured in
343 another TCP instance.
344 @retval EFI_OUT_OF_RESOURCES Failed due to resource limit.
351 IN EFI_TCP4_CONFIG_DATA
*CfgData
354 EFI_IP4_CONFIG_DATA IpCfgData
;
356 EFI_TCP4_OPTION
*Option
;
357 TCP4_PROTO_DATA
*TcpProto
;
360 ASSERT (CfgData
&& Sk
&& Sk
->SockHandle
);
362 TcpProto
= (TCP4_PROTO_DATA
*) Sk
->ProtoReserved
;
363 Tcb
= TcpProto
->TcpPcb
;
365 ASSERT (Tcb
!= NULL
);
368 // Add Ip for send pkt to the peer
370 CopyMem (&IpCfgData
, &mIpIoDefaultIpConfigData
, sizeof (IpCfgData
));
371 IpCfgData
.DefaultProtocol
= EFI_IP_PROTO_TCP
;
372 IpCfgData
.UseDefaultAddress
= CfgData
->AccessPoint
.UseDefaultAddress
;
373 IpCfgData
.StationAddress
= CfgData
->AccessPoint
.StationAddress
;
374 IpCfgData
.SubnetMask
= CfgData
->AccessPoint
.SubnetMask
;
375 IpCfgData
.ReceiveTimeout
= (UINT32
) (-1);
378 // Configure the IP instance this Tcb consumes.
380 Status
= IpIoConfigIp (Tcb
->IpInfo
, &IpCfgData
);
381 if (EFI_ERROR (Status
)) {
386 // Get the default address info if the instance is configured to use default address.
388 if (CfgData
->AccessPoint
.UseDefaultAddress
) {
389 CfgData
->AccessPoint
.StationAddress
= IpCfgData
.StationAddress
;
390 CfgData
->AccessPoint
.SubnetMask
= IpCfgData
.SubnetMask
;
394 // check if we can bind this endpoint in CfgData
396 Status
= Tcp4Bind (&(CfgData
->AccessPoint
));
398 if (EFI_ERROR (Status
)) {
399 DEBUG ((EFI_D_ERROR
, "Tcp4ConfigurePcb: Bind endpoint failed "
400 "with %r\n", Status
));
406 // Initalize the operating information in this Tcb
408 ASSERT (Tcb
->State
== TCP_CLOSED
&&
409 IsListEmpty (&Tcb
->SndQue
) &&
410 IsListEmpty (&Tcb
->RcvQue
));
412 TCP_SET_FLG (Tcb
->CtrlFlag
, TCP_CTRL_NO_KEEPALIVE
);
413 Tcb
->State
= TCP_CLOSED
;
416 Tcb
->RcvMss
= TcpGetRcvMss (Sk
);
419 Tcb
->Rto
= 3 * TCP_TICK_HZ
;
421 Tcb
->CWnd
= Tcb
->SndMss
;
422 Tcb
->Ssthresh
= 0xffffffff;
424 Tcb
->CongestState
= TCP_CONGEST_OPEN
;
426 Tcb
->KeepAliveIdle
= TCP_KEEPALIVE_IDLE_MIN
;
427 Tcb
->KeepAlivePeriod
= TCP_KEEPALIVE_PERIOD
;
428 Tcb
->MaxKeepAlive
= TCP_MAX_KEEPALIVE
;
429 Tcb
->MaxRexmit
= TCP_MAX_LOSS
;
430 Tcb
->FinWait2Timeout
= TCP_FIN_WAIT2_TIME
;
431 Tcb
->TimeWaitTimeout
= TCP_TIME_WAIT_TIME
;
432 Tcb
->ConnectTimeout
= TCP_CONNECT_TIME
;
435 // initialize Tcb in the light of CfgData
437 Tcb
->TTL
= CfgData
->TimeToLive
;
438 Tcb
->TOS
= CfgData
->TypeOfService
;
440 Tcb
->UseDefaultAddr
= CfgData
->AccessPoint
.UseDefaultAddress
;
442 CopyMem (&Tcb
->LocalEnd
.Ip
, &CfgData
->AccessPoint
.StationAddress
, sizeof (IP4_ADDR
));
443 Tcb
->LocalEnd
.Port
= HTONS (CfgData
->AccessPoint
.StationPort
);
444 Tcb
->SubnetMask
= CfgData
->AccessPoint
.SubnetMask
;
446 if (CfgData
->AccessPoint
.ActiveFlag
) {
447 CopyMem (&Tcb
->RemoteEnd
.Ip
, &CfgData
->AccessPoint
.RemoteAddress
, sizeof (IP4_ADDR
));
448 Tcb
->RemoteEnd
.Port
= HTONS (CfgData
->AccessPoint
.RemotePort
);
450 Tcb
->RemoteEnd
.Ip
= 0;
451 Tcb
->RemoteEnd
.Port
= 0;
454 Option
= CfgData
->ControlOption
;
456 if (Option
!= NULL
) {
459 (UINT32
) (TCP_COMP_VAL (
460 TCP_RCV_BUF_SIZE_MIN
,
463 Option
->ReceiveBufferSize
469 (UINT32
) (TCP_COMP_VAL (
470 TCP_SND_BUF_SIZE_MIN
,
473 Option
->SendBufferSize
480 (UINT32
) (TCP_COMP_VAL (
484 Option
->MaxSynBackLog
489 Tcb
->MaxRexmit
= (UINT16
) TCP_COMP_VAL (
495 Tcb
->FinWait2Timeout
= TCP_COMP_VAL (
497 TCP_FIN_WAIT2_TIME_MAX
,
499 (UINT32
) (Option
->FinTimeout
* TCP_TICK_HZ
)
502 if (Option
->TimeWaitTimeout
!= 0) {
503 Tcb
->TimeWaitTimeout
= TCP_COMP_VAL (
505 TCP_TIME_WAIT_TIME_MAX
,
507 (UINT32
) (Option
->TimeWaitTimeout
* TCP_TICK_HZ
)
510 Tcb
->TimeWaitTimeout
= 0;
513 if (Option
->KeepAliveProbes
!= 0) {
514 TCP_CLEAR_FLG (Tcb
->CtrlFlag
, TCP_CTRL_NO_KEEPALIVE
);
516 Tcb
->MaxKeepAlive
= (UINT8
) TCP_COMP_VAL (
517 TCP_MAX_KEEPALIVE_MIN
,
520 Option
->KeepAliveProbes
522 Tcb
->KeepAliveIdle
= TCP_COMP_VAL (
523 TCP_KEEPALIVE_IDLE_MIN
,
524 TCP_KEEPALIVE_IDLE_MAX
,
525 TCP_KEEPALIVE_IDLE_MIN
,
526 (UINT32
) (Option
->KeepAliveTime
* TCP_TICK_HZ
)
528 Tcb
->KeepAlivePeriod
= TCP_COMP_VAL (
529 TCP_KEEPALIVE_PERIOD_MIN
,
530 TCP_KEEPALIVE_PERIOD
,
531 TCP_KEEPALIVE_PERIOD
,
532 (UINT32
) (Option
->KeepAliveInterval
* TCP_TICK_HZ
)
536 Tcb
->ConnectTimeout
= TCP_COMP_VAL (
537 TCP_CONNECT_TIME_MIN
,
540 (UINT32
) (Option
->ConnectionTimeout
* TCP_TICK_HZ
)
543 if (Option
->EnableNagle
== FALSE
) {
544 TCP_SET_FLG (Tcb
->CtrlFlag
, TCP_CTRL_NO_NAGLE
);
547 if (Option
->EnableTimeStamp
== FALSE
) {
548 TCP_SET_FLG (Tcb
->CtrlFlag
, TCP_CTRL_NO_TS
);
551 if (Option
->EnableWindowScaling
== FALSE
) {
552 TCP_SET_FLG (Tcb
->CtrlFlag
, TCP_CTRL_NO_WS
);
557 // The socket is bound, the <SrcIp, SrcPort, DstIp, DstPort> is
558 // determined, construct the IP device path and install it.
560 Status
= TcpInstallDevicePath (Sk
);
561 if (EFI_ERROR (Status
)) {
566 // update state of Tcb and socket
568 if (CfgData
->AccessPoint
.ActiveFlag
== FALSE
) {
570 TcpSetState (Tcb
, TCP_LISTEN
);
571 SockSetState (Sk
, SO_LISTENING
);
573 Sk
->ConfigureState
= SO_CONFIGURED_PASSIVE
;
576 Sk
->ConfigureState
= SO_CONFIGURED_ACTIVE
;
588 The procotol handler provided to the socket layer, used to
589 dispatch the socket level requests by calling the corresponding
592 @param Sock Pointer to the socket of this TCP instance.
593 @param Request The code of this operation request.
594 @param Data Pointer to the operation specific data passed in
595 together with the operation request.
597 @retval EFI_SUCCESS The socket request is completed successfully.
598 @retval other The error status returned by the corresponding TCP
605 IN SOCK_REQUEST Request
,
606 IN VOID
*Data OPTIONAL
610 TCP4_PROTO_DATA
*ProtoData
;
611 EFI_IP4_PROTOCOL
*Ip
;
613 ProtoData
= (TCP4_PROTO_DATA
*) Sock
->ProtoReserved
;
614 Tcb
= ProtoData
->TcpPcb
;
618 Ip
= ProtoData
->TcpService
->IpIo
->Ip
;
624 // After user received data from socket buffer, socket will
625 // notify TCP using this message to give it a chance to send out
626 // window update information
629 TcpOnAppConsume (Tcb
);
651 Tcb
->SndPsh
= TcpGetMaxSndNxt (Tcb
) + GET_SND_DATASIZE (Tcb
->Sk
);
652 TCP_SET_FLG (Tcb
->CtrlFlag
, TCP_CTRL_SND_PSH
);
657 Tcb
->SndUp
= TcpGetMaxSndNxt (Tcb
) + GET_SND_DATASIZE (Tcb
->Sk
) - 1;
658 TCP_SET_FLG (Tcb
->CtrlFlag
, TCP_CTRL_SND_URG
);
664 TcpOnAppConnect (Tcb
);
670 return Tcp4AttachPcb (Sock
);
682 Tcp4DetachPcb (Sock
);
688 return Tcp4ConfigurePcb (
690 (EFI_TCP4_CONFIG_DATA
*) Data
697 ASSERT (Data
&& Tcb
);
699 return Tcp4GetMode (Tcb
, (TCP4_MODE_DATA
*) Data
);
705 ASSERT (Data
&& Tcb
);
707 return Tcp4Route (Tcb
, (TCP4_ROUTE_INFO
*) Data
);
710 return EFI_UNSUPPORTED
;