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 NetCopyMem (&AccessPoint
->StationAddress
, &Tcb
->LocalEnd
.Ip
, sizeof (EFI_IPv4_ADDRESS
));
122 AccessPoint
->SubnetMask
= Tcb
->SubnetMask
;
123 AccessPoint
->StationPort
= NTOHS (Tcb
->LocalEnd
.Port
);
125 NetCopyMem (&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
))
147 Option
->EnableSelectiveAck
= FALSE
;
148 Option
->EnablePathMtuDiscovery
= FALSE
;
152 Ip
= Tcb
->IpInfo
->Ip
;
155 return Ip
->GetModeData (Ip
, Mode
->Ip4ModeData
, Mode
->MnpConfigData
, Mode
->SnpModeData
);
160 If AP->StationPort isn't zero, check whether the access point
161 is registered, else generate a random station port for this
164 @param AP Pointer to the access point.
166 @retval EFI_SUCCESS The check is passed or the port is assigned.
167 @retval EFI_INVALID_PARAMETER The non-zero station port is already used.
168 @retval EFI_OUT_OF_RESOURCES No port can be allocated.
174 IN EFI_TCP4_ACCESS_POINT
*AP
179 if (0 != AP
->StationPort
) {
181 // check if a same endpoint is bound
183 if (TcpFindTcbByPeer (&AP
->StationAddress
, AP
->StationPort
)) {
185 return EFI_INVALID_PARAMETER
;
189 // generate a random port
193 if (TCP4_PORT_USER_RESERVED
== mTcp4RandomPort
) {
194 mTcp4RandomPort
= TCP4_PORT_KNOWN
;
199 while (TcpFindTcbByPeer (&AP
->StationAddress
, mTcp4RandomPort
)) {
203 if (mTcp4RandomPort
<= TCP4_PORT_KNOWN
) {
206 TCP4_DEBUG_ERROR (("Tcp4Bind: no port can be allocated "
209 return EFI_OUT_OF_RESOURCES
;
212 mTcp4RandomPort
= TCP4_PORT_KNOWN
+ 1;
219 AP
->StationPort
= mTcp4RandomPort
;
227 Flush the Tcb add its associated protocols..
229 @param Tcb Pointer to the TCP_CB to be flushed.
231 @retval EFI_SUCCESS The operation is completed successfully.
241 TCP4_PROTO_DATA
*TcpProto
;
243 IpIoConfigIp (Tcb
->IpInfo
, NULL
);
246 TcpProto
= (TCP4_PROTO_DATA
*) Sock
->ProtoReserved
;
248 if (SOCK_IS_CONFIGURED (Sock
)) {
249 NetListRemoveEntry (&Tcb
->List
);
252 // Uninstall the device path protocl.
254 gBS
->UninstallProtocolInterface (
256 &gEfiDevicePathProtocolGuid
,
259 NetFreePool (Sock
->DevicePath
);
261 TcpSetVariableData (TcpProto
->TcpService
);
264 NetbufFreeList (&Tcb
->SndQue
);
265 NetbufFreeList (&Tcb
->RcvQue
);
275 TCP4_PROTO_DATA
*ProtoData
;
278 Tcb
= NetAllocateZeroPool (sizeof (TCP_CB
));
282 TCP4_DEBUG_ERROR (("Tcp4ConfigurePcb: failed to allocate a TCB\n"));
284 return EFI_OUT_OF_RESOURCES
;
287 ProtoData
= (TCP4_PROTO_DATA
*) Sk
->ProtoReserved
;
288 IpIo
= ProtoData
->TcpService
->IpIo
;
291 // Create an IpInfo for this Tcb.
293 Tcb
->IpInfo
= IpIoAddIp (IpIo
);
294 if (Tcb
->IpInfo
== NULL
) {
297 return EFI_OUT_OF_RESOURCES
;
300 NetListInit (&Tcb
->List
);
301 NetListInit (&Tcb
->SndQue
);
302 NetListInit (&Tcb
->RcvQue
);
304 Tcb
->State
= TCP_CLOSED
;
306 ProtoData
->TcpPcb
= Tcb
;
317 TCP4_PROTO_DATA
*ProtoData
;
320 ProtoData
= (TCP4_PROTO_DATA
*) Sk
->ProtoReserved
;
321 Tcb
= ProtoData
->TcpPcb
;
323 ASSERT (Tcb
!= NULL
);
327 IpIoRemoveIp (ProtoData
->TcpService
->IpIo
, Tcb
->IpInfo
);
331 ProtoData
->TcpPcb
= NULL
;
336 Configure the Tcb using CfgData.
338 @param Sk Pointer to the socket of this TCP instance.
339 @param SkTcb Pointer to the TCP_CB of this TCP instance.
340 @param CfgData Pointer to the TCP configuration data.
342 @retval EFI_SUCCESS The operation is completed successfully.
343 @retval EFI_INVALID_PARAMETER A same access point has been configured in
344 another TCP instance.
345 @retval EFI_OUT_OF_RESOURCES Failed due to resource limit.
352 IN EFI_TCP4_CONFIG_DATA
*CfgData
355 EFI_IP4_CONFIG_DATA IpCfgData
;
357 EFI_TCP4_OPTION
*Option
;
358 TCP4_PROTO_DATA
*TcpProto
;
361 ASSERT (CfgData
&& Sk
&& Sk
->SockHandle
);
363 TcpProto
= (TCP4_PROTO_DATA
*) Sk
->ProtoReserved
;
364 Tcb
= TcpProto
->TcpPcb
;
366 ASSERT (Tcb
!= NULL
);
369 // Add Ip for send pkt to the peer
371 CopyMem (&IpCfgData
, &mIpIoDefaultIpConfigData
, sizeof (IpCfgData
));
372 IpCfgData
.DefaultProtocol
= EFI_IP_PROTO_TCP
;
373 IpCfgData
.UseDefaultAddress
= CfgData
->AccessPoint
.UseDefaultAddress
;
374 IpCfgData
.StationAddress
= CfgData
->AccessPoint
.StationAddress
;
375 IpCfgData
.SubnetMask
= CfgData
->AccessPoint
.SubnetMask
;
376 IpCfgData
.ReceiveTimeout
= (UINT32
) (-1);
379 // Configure the IP instance this Tcb consumes.
381 Status
= IpIoConfigIp (Tcb
->IpInfo
, &IpCfgData
);
382 if (EFI_ERROR (Status
)) {
387 // Get the default address info if the instance is configured to use default address.
389 if (CfgData
->AccessPoint
.UseDefaultAddress
) {
390 CfgData
->AccessPoint
.StationAddress
= IpCfgData
.StationAddress
;
391 CfgData
->AccessPoint
.SubnetMask
= IpCfgData
.SubnetMask
;
395 // check if we can bind this endpoint in CfgData
397 Status
= Tcp4Bind (&(CfgData
->AccessPoint
));
399 if (EFI_ERROR (Status
)) {
400 TCP4_DEBUG_ERROR (("Tcp4ConfigurePcb: Bind endpoint failed "
401 "with %r\n", Status
));
407 // Initalize the operating information in this Tcb
409 ASSERT (Tcb
->State
== TCP_CLOSED
&&
410 NetListIsEmpty (&Tcb
->SndQue
) &&
411 NetListIsEmpty (&Tcb
->RcvQue
));
413 TCP_SET_FLG (Tcb
->CtrlFlag
, TCP_CTRL_NO_KEEPALIVE
);
414 Tcb
->State
= TCP_CLOSED
;
417 Tcb
->RcvMss
= TcpGetRcvMss (Sk
);
420 Tcb
->Rto
= 3 * TCP_TICK_HZ
;
422 Tcb
->CWnd
= Tcb
->SndMss
;
423 Tcb
->Ssthresh
= 0xffffffff;
425 Tcb
->CongestState
= TCP_CONGEST_OPEN
;
427 Tcb
->KeepAliveIdle
= TCP_KEEPALIVE_IDLE_MIN
;
428 Tcb
->KeepAlivePeriod
= TCP_KEEPALIVE_PERIOD
;
429 Tcb
->MaxKeepAlive
= TCP_MAX_KEEPALIVE
;
430 Tcb
->MaxRexmit
= TCP_MAX_LOSS
;
431 Tcb
->FinWait2Timeout
= TCP_FIN_WAIT2_TIME
;
432 Tcb
->TimeWaitTimeout
= TCP_TIME_WAIT_TIME
;
433 Tcb
->ConnectTimeout
= TCP_CONNECT_TIME
;
436 // initialize Tcb in the light of CfgData
438 Tcb
->TTL
= CfgData
->TimeToLive
;
439 Tcb
->TOS
= CfgData
->TypeOfService
;
441 Tcb
->UseDefaultAddr
= CfgData
->AccessPoint
.UseDefaultAddress
;
443 NetCopyMem (&Tcb
->LocalEnd
.Ip
, &CfgData
->AccessPoint
.StationAddress
, sizeof (IP4_ADDR
));
444 Tcb
->LocalEnd
.Port
= HTONS (CfgData
->AccessPoint
.StationPort
);
445 Tcb
->SubnetMask
= CfgData
->AccessPoint
.SubnetMask
;
447 if (CfgData
->AccessPoint
.ActiveFlag
) {
448 NetCopyMem (&Tcb
->RemoteEnd
.Ip
, &CfgData
->AccessPoint
.RemoteAddress
, sizeof (IP4_ADDR
));
449 Tcb
->RemoteEnd
.Port
= HTONS (CfgData
->AccessPoint
.RemotePort
);
451 Tcb
->RemoteEnd
.Ip
= 0;
452 Tcb
->RemoteEnd
.Port
= 0;
455 Option
= CfgData
->ControlOption
;
457 if (Option
!= NULL
) {
460 (UINT32
) (TCP_COMP_VAL (
461 TCP_RCV_BUF_SIZE_MIN
,
464 Option
->ReceiveBufferSize
470 (UINT32
) (TCP_COMP_VAL (
471 TCP_SND_BUF_SIZE_MIN
,
474 Option
->SendBufferSize
481 (UINT32
) (TCP_COMP_VAL (
485 Option
->MaxSynBackLog
490 Tcb
->MaxRexmit
= (UINT16
) TCP_COMP_VAL (
496 Tcb
->FinWait2Timeout
= TCP_COMP_VAL (
498 TCP_FIN_WAIT2_TIME_MAX
,
500 (UINT32
) (Option
->FinTimeout
* TCP_TICK_HZ
)
503 if (Option
->TimeWaitTimeout
!= 0) {
504 Tcb
->TimeWaitTimeout
= TCP_COMP_VAL (
506 TCP_TIME_WAIT_TIME_MAX
,
508 (UINT32
) (Option
->TimeWaitTimeout
* TCP_TICK_HZ
)
511 Tcb
->TimeWaitTimeout
= 0;
514 if (Option
->KeepAliveProbes
!= 0) {
515 TCP_CLEAR_FLG (Tcb
->CtrlFlag
, TCP_CTRL_NO_KEEPALIVE
);
517 Tcb
->MaxKeepAlive
= (UINT8
) TCP_COMP_VAL (
518 TCP_MAX_KEEPALIVE_MIN
,
521 Option
->KeepAliveProbes
523 Tcb
->KeepAliveIdle
= TCP_COMP_VAL (
524 TCP_KEEPALIVE_IDLE_MIN
,
525 TCP_KEEPALIVE_IDLE_MAX
,
526 TCP_KEEPALIVE_IDLE_MIN
,
527 (UINT32
) (Option
->KeepAliveTime
* TCP_TICK_HZ
)
529 Tcb
->KeepAlivePeriod
= TCP_COMP_VAL (
530 TCP_KEEPALIVE_PERIOD_MIN
,
531 TCP_KEEPALIVE_PERIOD
,
532 TCP_KEEPALIVE_PERIOD
,
533 (UINT32
) (Option
->KeepAliveInterval
* TCP_TICK_HZ
)
537 Tcb
->ConnectTimeout
= TCP_COMP_VAL (
538 TCP_CONNECT_TIME_MIN
,
541 (UINT32
) (Option
->ConnectionTimeout
* TCP_TICK_HZ
)
544 if (Option
->EnableNagle
== FALSE
) {
545 TCP_SET_FLG (Tcb
->CtrlFlag
, TCP_CTRL_NO_NAGLE
);
548 if (Option
->EnableTimeStamp
== FALSE
) {
549 TCP_SET_FLG (Tcb
->CtrlFlag
, TCP_CTRL_NO_TS
);
552 if (Option
->EnableWindowScaling
== FALSE
) {
553 TCP_SET_FLG (Tcb
->CtrlFlag
, TCP_CTRL_NO_WS
);
558 // The socket is bound, the <SrcIp, SrcPort, DstIp, DstPort> is
559 // determined, construct the IP device path and install it.
561 Status
= TcpInstallDevicePath (Sk
);
562 if (EFI_ERROR (Status
)) {
567 // update state of Tcb and socket
569 if (CfgData
->AccessPoint
.ActiveFlag
== FALSE
) {
571 TcpSetState (Tcb
, TCP_LISTEN
);
572 SockSetState (Sk
, SO_LISTENING
);
574 Sk
->ConfigureState
= SO_CONFIGURED_PASSIVE
;
577 Sk
->ConfigureState
= SO_CONFIGURED_ACTIVE
;
589 The procotol handler provided to the socket layer, used to
590 dispatch the socket level requests by calling the corresponding
593 @param Sock Pointer to the socket of this TCP instance.
594 @param Request The code of this operation request.
595 @param Data Pointer to the operation specific data passed in
596 together with the operation request.
598 @retval EFI_SUCCESS The socket request is completed successfully.
599 @retval other The error status returned by the corresponding TCP
606 IN SOCK_REQUEST Request
,
607 IN VOID
*Data OPTIONAL
611 TCP4_PROTO_DATA
*ProtoData
;
612 EFI_IP4_PROTOCOL
*Ip
;
614 ProtoData
= (TCP4_PROTO_DATA
*) Sock
->ProtoReserved
;
615 Tcb
= ProtoData
->TcpPcb
;
619 Ip
= ProtoData
->TcpService
->IpIo
->Ip
;
625 // After user received data from socket buffer, socket will
626 // notify TCP using this message to give it a chance to send out
627 // window update information
630 TcpOnAppConsume (Tcb
);
652 Tcb
->SndPsh
= TcpGetMaxSndNxt (Tcb
) + GET_SND_DATASIZE (Tcb
->Sk
);
653 TCP_SET_FLG (Tcb
->CtrlFlag
, TCP_CTRL_SND_PSH
);
658 Tcb
->SndUp
= TcpGetMaxSndNxt (Tcb
) + GET_SND_DATASIZE (Tcb
->Sk
) - 1;
659 TCP_SET_FLG (Tcb
->CtrlFlag
, TCP_CTRL_SND_URG
);
665 TcpOnAppConnect (Tcb
);
671 return Tcp4AttachPcb (Sock
);
683 Tcp4DetachPcb (Sock
);
689 return Tcp4ConfigurePcb (
691 (EFI_TCP4_CONFIG_DATA
*) Data
698 ASSERT (Data
&& Tcb
);
700 return Tcp4GetMode (Tcb
, (TCP4_MODE_DATA
*) Data
);
706 ASSERT (Data
&& Tcb
);
708 return Tcp4Route (Tcb
, (TCP4_ROUTE_INFO
*) Data
);