#include "TcpMain.h"

Functions
EFI_STATUS	TcpCreateTimer (VOID)

VOID	TcpDestroyTimer (VOID)

EFI_STATUS EFIAPI	TcpDriverEntryPoint (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

EFI_STATUS	TcpCreateService (IN EFI_HANDLE Controller, IN EFI_HANDLE Image, IN UINT8 IpVersion)

EFI_STATUS EFIAPI	TcpDestroyChildEntryInHandleBuffer (IN LIST_ENTRY Entry, IN VOID Context)

EFI_STATUS	TcpDestroyService (IN EFI_HANDLE Controller, IN EFI_HANDLE ImageHandle, IN UINTN NumberOfChildren, IN EFI_HANDLE *ChildHandleBuffer OPTIONAL, IN UINT8 IpVersion)

EFI_STATUS EFIAPI	Tcp4DriverBindingSupported (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE ControllerHandle, IN EFI_DEVICE_PATH_PROTOCOL RemainingDevicePath OPTIONAL)

EFI_STATUS EFIAPI	Tcp4DriverBindingStart (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE ControllerHandle, IN EFI_DEVICE_PATH_PROTOCOL RemainingDevicePath OPTIONAL)

EFI_STATUS EFIAPI	Tcp4DriverBindingStop (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE ControllerHandle, IN UINTN NumberOfChildren, IN EFI_HANDLE ChildHandleBuffer OPTIONAL)

EFI_STATUS EFIAPI	Tcp6DriverBindingSupported (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE ControllerHandle, IN EFI_DEVICE_PATH_PROTOCOL RemainingDevicePath OPTIONAL)

EFI_STATUS EFIAPI	Tcp6DriverBindingStart (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE ControllerHandle, IN EFI_DEVICE_PATH_PROTOCOL RemainingDevicePath OPTIONAL)

EFI_STATUS EFIAPI	Tcp6DriverBindingStop (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE ControllerHandle, IN UINTN NumberOfChildren, IN EFI_HANDLE ChildHandleBuffer OPTIONAL)

EFI_STATUS	TcpCreateSocketCallback (IN SOCKET This, IN VOID Context)

VOID	TcpDestroySocketCallback (IN SOCKET This, IN VOID Context)

EFI_STATUS EFIAPI	TcpServiceBindingCreateChild (IN EFI_SERVICE_BINDING_PROTOCOL This, IN OUT EFI_HANDLE ChildHandle)

EFI_STATUS EFIAPI	TcpServiceBindingDestroyChild (IN EFI_SERVICE_BINDING_PROTOCOL *This, IN EFI_HANDLE ChildHandle)

Detailed Description

The driver binding and service binding protocol for the TCP driver.

Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.
Copyright (c) Microsoft Corporation SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file TcpDriver.c.

Function Documentation

◆ Tcp4DriverBindingStart()

EFI_STATUS EFIAPI Tcp4DriverBindingStart	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	ControllerHandle,
		IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath	OPTIONAL
	)

Start this driver on ControllerHandle.

Parameters

[in]	This	Protocol instance pointer.
[in]	ControllerHandle	Handle of device to bind driver to.
[in]	RemainingDevicePath	Optional parameter use to pick a specific child device to start.

Return values

EFI_SUCCESS	The driver is added to ControllerHandle.
EFI_OUT_OF_RESOURCES	There are not enough resources to start the driver.
other	The driver cannot be added to ControllerHandle.

Definition at line 646 of file TcpDriver.c.

◆ Tcp4DriverBindingStop()

EFI_STATUS EFIAPI Tcp4DriverBindingStop	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	ControllerHandle,
		IN UINTN	NumberOfChildren,
		IN EFI_HANDLE *ChildHandleBuffer	OPTIONAL
	)

Stop this driver on ControllerHandle.

Parameters

[in]	This	A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
[in]	ControllerHandle	A handle to the device being stopped. The handle must support a bus specific I/O protocol for the driver to use to stop the device.
[in]	NumberOfChildren	The number of child device handles in ChildHandleBuffer.
[in]	ChildHandleBuffer	An array of child handles to be freed. May be NULL if NumberOfChildren is 0.

Return values

EFI_SUCCESS	The device was stopped.
EFI_DEVICE_ERROR	The device could not be stopped due to a device error.

Definition at line 679 of file TcpDriver.c.

◆ Tcp4DriverBindingSupported()

EFI_STATUS EFIAPI Tcp4DriverBindingSupported	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	ControllerHandle,
		IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath	OPTIONAL
	)

Test to see if this driver supports ControllerHandle.

Parameters

[in]	This	Protocol instance pointer.
[in]	ControllerHandle	Handle of device to test.
[in]	RemainingDevicePath	Optional parameter use to pick a specific child device to start.

Return values

EFI_SUCCESS	This driver supports this device.
EFI_ALREADY_STARTED	This driver is already running on this device.
other	This driver does not support this device.

Definition at line 593 of file TcpDriver.c.

◆ Tcp6DriverBindingStart()

EFI_STATUS EFIAPI Tcp6DriverBindingStart	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	ControllerHandle,
		IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath	OPTIONAL
	)

Start this driver on ControllerHandle.

Parameters

[in]	This	Protocol instance pointer.
[in]	ControllerHandle	Handle of device to bind driver to.
[in]	RemainingDevicePath	Optional parameter use to pick a specific child device to start.

Return values

EFI_SUCCESS	The driver is added to ControllerHandle.
EFI_OUT_OF_RESOURCES	There are not enough resources to start the driver.
other	The driver cannot be added to ControllerHandle.

Definition at line 763 of file TcpDriver.c.

◆ Tcp6DriverBindingStop()

EFI_STATUS EFIAPI Tcp6DriverBindingStop	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	ControllerHandle,
		IN UINTN	NumberOfChildren,
		IN EFI_HANDLE *ChildHandleBuffer	OPTIONAL
	)

Stop this driver on ControllerHandle.

Parameters

[in]	This	A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
[in]	ControllerHandle	A handle to the device being stopped. The handle must support a bus specific I/O protocol for the driver to use to stop the device.
[in]	NumberOfChildren	The number of child device handles in ChildHandleBuffer.
[in]	ChildHandleBuffer	An array of child handles to be freed. May be NULL if NumberOfChildren is 0.

Return values

EFI_SUCCESS	The device was stopped.
EFI_DEVICE_ERROR	The device could not be stopped due to a device error.

Definition at line 796 of file TcpDriver.c.

◆ Tcp6DriverBindingSupported()

EFI_STATUS EFIAPI Tcp6DriverBindingSupported	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	ControllerHandle,
		IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath	OPTIONAL
	)

Test to see if this driver supports ControllerHandle.

Parameters

[in]	This	Protocol instance pointer.
[in]	ControllerHandle	Handle of device to test.
[in]	RemainingDevicePath	Optional parameter use to pick a specific child device to start.

Return values

EFI_SUCCESS	This driver supports this device.
EFI_ALREADY_STARTED	This driver is already running on this device.
other	This driver does not support this device.

Definition at line 710 of file TcpDriver.c.

◆ TcpCreateService()

EFI_STATUS TcpCreateService	(	IN EFI_HANDLE	Controller,
		IN EFI_HANDLE	Image,
		IN UINT8	IpVersion
	)

Create a new TCP4 or TCP6 driver service binding protocol

Parameters

[in]	Controller	Controller handle of device to bind driver to.
[in]	Image	The TCP driver's image handle.
[in]	IpVersion	IP_VERSION_4 or IP_VERSION_6.

Return values

EFI_OUT_OF_RESOURCES	Failed to allocate some resources.
EFI_UNSUPPORTED	Service Binding Protocols are unavailable.
EFI_ALREADY_STARTED	The TCP driver is already started on the controller.
EFI_SUCCESS	A new IP6 service binding private was created.

Definition at line 255 of file TcpDriver.c.

◆ TcpCreateSocketCallback()

EFI_STATUS TcpCreateSocketCallback	(	IN SOCKET *	This,
		IN VOID *	Context
	)

The Callback function called after the TCP socket was created.

Parameters

[in]	This	Pointer to the socket just created
[in]	Context	Context of the socket

Return values

EFI_SUCCESS	This protocol installed successfully.
other	An error occurred.

Definition at line 823 of file TcpDriver.c.

◆ TcpCreateTimer()

EFI_STATUS TcpCreateTimer ( VOID )

Create and start the heartbeat timer for the TCP driver.

Return values

EFI_SUCCESS	The timer was successfully created and started.
other	The timer was not created.

Definition at line 100 of file TcpDriver.c.

◆ TcpDestroyChildEntryInHandleBuffer()

EFI_STATUS EFIAPI TcpDestroyChildEntryInHandleBuffer	(	IN LIST_ENTRY *	Entry,
		IN VOID *	Context
	)

Callback function which provided by user to remove one node in NetDestroyLinkList process.

Parameters

[in]	Entry	The entry to be removed.
[in]	Context	Pointer to the callback context corresponds to the Context in NetDestroyLinkList.

Return values

EFI_SUCCESS	The entry has been removed successfully.
Others	Fail to remove the entry.

Definition at line 420 of file TcpDriver.c.

◆ TcpDestroyService()

EFI_STATUS TcpDestroyService	(	IN EFI_HANDLE	Controller,
		IN EFI_HANDLE	ImageHandle,
		IN UINTN	NumberOfChildren,
		IN EFI_HANDLE *ChildHandleBuffer	OPTIONAL,
		IN UINT8	IpVersion
	)

Destroy a TCP6 or TCP4 service binding instance. It will release all the resources allocated by the instance.

Parameters

[in]	Controller	Controller handle of device to bind driver to.
[in]	ImageHandle	The TCP driver's image handle.
[in]	NumberOfChildren	Number of Handles in ChildHandleBuffer. If number of children is zero stop the entire bus driver.
[in]	ChildHandleBuffer	An array of child handles to be freed. May be NULL if NumberOfChildren is 0.
[in]	IpVersion	IP_VERSION_4 or IP_VERSION_6

Return values

EFI_SUCCESS	The resources used by the instance were cleaned up.
Others	Failed to clean up some of the resources.

Definition at line 463 of file TcpDriver.c.

◆ TcpDestroySocketCallback()

VOID TcpDestroySocketCallback	(	IN SOCKET *	This,
		IN VOID *	Context
	)

The callback function called before the TCP socket was to be destroyed.

Parameters

[in]	This	The TCP socket to be destroyed.
[in]	Context	The context of the socket.

Definition at line 892 of file TcpDriver.c.

◆ TcpDestroyTimer()

VOID TcpDestroyTimer ( VOID )

Stop and destroy the heartbeat timer for TCP driver.

Definition at line 137 of file TcpDriver.c.

◆ TcpDriverEntryPoint()

EFI_STATUS EFIAPI TcpDriverEntryPoint	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

The entry point for Tcp driver, which is used to install Tcp driver on the ImageHandle.

Parameters

[in]	ImageHandle	The firmware allocated handle for this driver image.
[in]	SystemTable	Pointer to the EFI system table.

Return values

EFI_SUCCESS	The driver loaded.
other	The driver did not load.

Definition at line 166 of file TcpDriver.c.

◆ TcpServiceBindingCreateChild()

EFI_STATUS EFIAPI TcpServiceBindingCreateChild	(	IN EFI_SERVICE_BINDING_PROTOCOL *	This,
		IN OUT EFI_HANDLE *	ChildHandle
	)

Creates a child handle with a set of TCP services.

The CreateChild() function installs a protocol on ChildHandle. If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle. If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.

Parameters

[in]	This	Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
[in,out]	ChildHandle	Pointer to the handle of the child to create. If it is NULL, then a new handle is created. If it is a pointer to an existing UEFI handle, then the protocol is added to the existing UEFI handle.

Return values

EFI_SUCCESS	The protocol was added to ChildHandle.
EFI_INVALID_PARAMETER	ChildHandle is NULL.
EFI_OUT_OF_RESOURCES	There are not enough resources available to create the child.
other	The child handle was not created.

Definition at line 946 of file TcpDriver.c.

◆ TcpServiceBindingDestroyChild()

EFI_STATUS EFIAPI TcpServiceBindingDestroyChild	(	IN EFI_SERVICE_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	ChildHandle
	)

Destroys a child handle with a set of TCP services.

The DestroyChild() function does the opposite of CreateChild(). It removes a protocol that was installed by CreateChild() from ChildHandle. If the removed protocol is the last protocol on ChildHandle, then ChildHandle is destroyed.

Parameters

This	Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
ChildHandle	Handle of the child to be destroyed.

Return values

EFI_SUCCESS	The protocol was removed from ChildHandle.
EFI_UNSUPPORTED	ChildHandle does not support the protocol that is being removed.
EFI_INVALID_PARAMETER	Child handle is NULL.
EFI_ACCESS_DENIED	The protocol could not be removed from the ChildHandle because its services are being used.
other	The child handle was not destroyed.

Definition at line 1021 of file TcpDriver.c.

Variable Documentation

◆ gTcp4DriverBinding

EFI_DRIVER_BINDING_PROTOCOL gTcp4DriverBinding

Initial value:

= {
  Tcp4DriverBindingSupported,
  Tcp4DriverBindingStart,
  Tcp4DriverBindingStop,
  0xa,
  NULL,
  NULL
}

Definition at line 63 of file TcpDriver.c.

◆ gTcp4ProtocolTemplate

EFI_TCP4_PROTOCOL gTcp4ProtocolTemplate

Initial value:

= {
  Tcp4GetModeData,
  Tcp4Configure,
  Tcp4Routes,
  Tcp4Connect,
  Tcp4Accept,
  Tcp4Transmit,
  Tcp4Receive,
  Tcp4Close,
  Tcp4Cancel,
  Tcp4Poll
}

Definition at line 20 of file TcpDriver.c.

◆ gTcp6DriverBinding

EFI_DRIVER_BINDING_PROTOCOL gTcp6DriverBinding

Initial value:

= {
  Tcp6DriverBindingSupported,
  Tcp6DriverBindingStart,
  Tcp6DriverBindingStop,
  0xa,
  NULL,
  NULL
}

Definition at line 72 of file TcpDriver.c.

◆ gTcp6ProtocolTemplate

EFI_TCP6_PROTOCOL gTcp6ProtocolTemplate

Initial value:

= {
  Tcp6GetModeData,
  Tcp6Configure,
  Tcp6Connect,
  Tcp6Accept,
  Tcp6Transmit,
  Tcp6Receive,
  Tcp6Close,
  Tcp6Cancel,
  Tcp6Poll
}

Definition at line 33 of file TcpDriver.c.

◆ gTcpServiceBinding

EFI_SERVICE_BINDING_PROTOCOL gTcpServiceBinding

Initial value:

= {
  TcpServiceBindingCreateChild,
  TcpServiceBindingDestroyChild
}

Definition at line 81 of file TcpDriver.c.

◆ mHash2ServiceHandle

EFI_HANDLE mHash2ServiceHandle = NULL

Definition at line 90 of file TcpDriver.c.

◆ mTcp4RandomPort

UINT16 mTcp4RandomPort

Definition at line 12 of file TcpDriver.c.

◆ mTcp6RandomPort

UINT16 mTcp6RandomPort

Definition at line 13 of file TcpDriver.c.

◆ mTcpDefaultSockData

SOCK_INIT_DATA mTcpDefaultSockData

Initial value:

= {
  SockStream,
  SO_CLOSED,
  NULL,
  TCP_BACKLOG,
  TCP_SND_BUF_SIZE,
  TCP_RCV_BUF_SIZE,
  IP_VERSION_4,
  NULL,
  TcpCreateSocketCallback,
  TcpDestroySocketCallback,
  NULL,
  NULL,
  0,
  TcpDispatcher,
  NULL,
}

Definition at line 45 of file TcpDriver.c.

◆ mTcpTimer

TCP_HEARTBEAT_TIMER mTcpTimer

Initial value:

= {
  NULL,
  0
}

Definition at line 15 of file TcpDriver.c.

Variables
UINT16	mTcp4RandomPort

UINT16	mTcp6RandomPort

TCP_HEARTBEAT_TIMER	mTcpTimer

EFI_TCP4_PROTOCOL	gTcp4ProtocolTemplate

EFI_TCP6_PROTOCOL	gTcp6ProtocolTemplate

SOCK_INIT_DATA	mTcpDefaultSockData

EFI_DRIVER_BINDING_PROTOCOL	gTcp4DriverBinding

EFI_DRIVER_BINDING_PROTOCOL	gTcp6DriverBinding

EFI_SERVICE_BINDING_PROTOCOL	gTcpServiceBinding

EFI_HANDLE	mHash2ServiceHandle = NULL

Functions

Variables

Detailed Description

Function Documentation

◆ Tcp4DriverBindingStart()

◆ Tcp4DriverBindingStop()

◆ Tcp4DriverBindingSupported()

◆ Tcp6DriverBindingStart()

◆ Tcp6DriverBindingStop()

◆ Tcp6DriverBindingSupported()

◆ TcpCreateService()

◆ TcpCreateSocketCallback()

◆ TcpCreateTimer()

◆ TcpDestroyChildEntryInHandleBuffer()

◆ TcpDestroyService()

◆ TcpDestroySocketCallback()

◆ TcpDestroyTimer()

◆ TcpDriverEntryPoint()

◆ TcpServiceBindingCreateChild()

◆ TcpServiceBindingDestroyChild()

Variable Documentation

◆ gTcp4DriverBinding

◆ gTcp4ProtocolTemplate

◆ gTcp6DriverBinding

◆ gTcp6ProtocolTemplate

◆ gTcpServiceBinding

◆ mHash2ServiceHandle

◆ mTcp4RandomPort

◆ mTcp6RandomPort

◆ mTcpDefaultSockData

◆ mTcpTimer