Data Structures
struct	_TCP_HEARTBEAT_TIMER

struct	_TCP_SERVICE_DATA

struct	_TCP_PROTO_DATA

Macros
#define	TCP_DRIVER_SIGNATURE SIGNATURE_32 ('T', 'C', 'P', 'D')

#define	TCP_PORT_KNOWN 1024

#define	TCP_PORT_USER_RESERVED 65535

#define	TCP_SERVICE_FROM_THIS(a)

Typedefs
typedef struct _TCP_HEARTBEAT_TIMER	TCP_HEARTBEAT_TIMER

typedef struct _TCP_SERVICE_DATA	TCP_SERVICE_DATA

typedef struct _TCP_PROTO_DATA	TCP_PROTO_DATA

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

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 prototype of driver binding and service binding protocol for TCP driver.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file TcpDriver.h.

Macro Definition Documentation

◆ TCP_DRIVER_SIGNATURE

#define TCP_DRIVER_SIGNATURE SIGNATURE_32 ('T', 'C', 'P', 'D')

Definition at line 13 of file TcpDriver.h.

◆ TCP_PORT_KNOWN

#define TCP_PORT_KNOWN 1024

Definition at line 15 of file TcpDriver.h.

◆ TCP_PORT_USER_RESERVED

#define TCP_PORT_USER_RESERVED 65535

Definition at line 16 of file TcpDriver.h.

◆ TCP_SERVICE_FROM_THIS

#define TCP_SERVICE_FROM_THIS ( a )

Value:

  CR ( \
  (a), \
  TCP_SERVICE_DATA, \
  ServiceBinding, \
  TCP_DRIVER_SIGNATURE \
  )

Definition at line 38 of file TcpDriver.h.

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 was added to ControllerHandle.
EFI_OUT_OF_RESOURCES	There are not enough resources to start the driver.
other	The driver cannot be added to ControllerHandle.

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 the 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.

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 was added to ControllerHandle.
EFI_OUT_OF_RESOURCES	There are not enough resources to start the driver.
other	The driver cannot be added to ControllerHandle.

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 the 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.

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.

◆ TcpCreateSocketCallback()

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

The Callback function called after the TCP socket is created.

Parameters

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

Return values

EFI_SUCCESS	This protocol is installed successfully.
other	An error occurred.

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.

◆ TcpDestroySocketCallback()

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

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

Parameters

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

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.

◆ TcpDriverEntryPoint()

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

The entry point for Tcp driver, 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.

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 destroy.

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	The 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.

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.

Data Structures

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

◆ TCP_DRIVER_SIGNATURE

◆ TCP_PORT_KNOWN

◆ TCP_PORT_USER_RESERVED

◆ TCP_SERVICE_FROM_THIS

Function Documentation

◆ Tcp4DriverBindingStart()

◆ Tcp4DriverBindingStop()

◆ Tcp4DriverBindingSupported()

◆ Tcp6DriverBindingStart()

◆ Tcp6DriverBindingStop()

◆ Tcp6DriverBindingSupported()

◆ TcpCreateSocketCallback()

◆ TcpDestroySocketCallback()

◆ TcpDriverEntryPoint()

◆ TcpServiceBindingCreateChild()

◆ TcpServiceBindingDestroyChild()