/** @file
The driver binding and service binding protocol for the TCP driver.
Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include "TcpMain.h"
NULL,
0
};
};
};
NULL,
NULL,
NULL,
NULL,
0,
NULL,
};
0xa,
NULL,
};
};
/**
Create and start the heartbeat timer for the TCP driver.
@retval EFI_SUCCESS The timer was successfully created and started.
@retval other The timer was not created.
**/
)
{
NULL,
);
);
}
}
}
return Status;
}
/**
Stop and destroy the heartbeat timer for TCP driver.
**/
)
{
return;
}
}
/**
The entry point for Tcp driver, which is used to install Tcp driver on the ImageHandle.
@param[in] ImageHandle The firmware allocated handle for this driver image.
@param[in] SystemTable Pointer to the EFI system table.
@retval EFI_SUCCESS The driver loaded.
@retval other The driver did not load.
**/
)
{
//
// Install the TCP Driver Binding Protocol
//
);
return Status;
}
//
// Initialize ISS and random port.
//
Seed = NetRandomInitSeed ();
return EFI_SUCCESS;
}
/**
Create a new TCP4 or TCP6 driver service binding protocol
@param[in] Controller Controller handle of device to bind driver to.
@param[in] Image The TCP driver's image handle.
@param[in] IpVersion IP_VERSION_4 or IP_VERSION_6.
@retval EFI_OUT_OF_RESOURCES Failed to allocate some resources.
@retval EFI_SUCCESS A new IP6 service binding private was created.
**/
)
{
if (IpVersion == IP_VERSION_4) {
} else {
}
NULL,
);
return EFI_ALREADY_STARTED;
}
NULL,
);
return EFI_UNSUPPORTED;
}
//
// Create the TCP service data.
//
if (TcpServiceData == NULL) {
return EFI_OUT_OF_RESOURCES;
}
CopyMem (
sizeof (EFI_SERVICE_BINDING_PROTOCOL)
);
goto ON_ERROR;
}
if (IpVersion == IP_VERSION_4) {
CopyMem (
sizeof (EFI_IP4_CONFIG_DATA)
);
} else {
CopyMem (
sizeof (EFI_IP6_CONFIG_DATA)
);
}
goto ON_ERROR;
}
Status = TcpCreateTimer ();
goto ON_ERROR;
}
);
TcpDestroyTimer ();
goto ON_ERROR;
}
return EFI_SUCCESS;
}
return Status;
}
/**
Destroy a TCP6 or TCP4 service binding instance. It will release all
the resources allocated by the instance.
@param[in] Controller Controller handle of device to bind driver to.
@param[in] ImageHandle The TCP driver's image handle.
@param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number
of children is zero stop the entire bus driver.
@param[in] IpVersion IP_VERSION_4 or IP_VERSION_6
@retval EFI_SUCCESS The resources used by the instance were cleaned up.
@retval Others Failed to clean up some of the resources.
**/
)
{
if (IpVersion == IP_VERSION_4) {
} else {
}
return EFI_NOT_FOUND;
}
(VOID **) &ServiceBinding,
);
return EFI_DEVICE_ERROR;
}
if (NumberOfChildren == 0) {
//
// Uninstall TCP servicebinding protocol
//
);
//
// Destroy the IpIO consumed by TCP driver
//
//
// Destroy the heartbeat timer.
//
TcpDestroyTimer ();
//
// Clear the variable.
//
//
// Release the TCP service data
//
} else {
}
}
return EFI_SUCCESS;
}
/**
Test to see if this driver supports ControllerHandle.
@param[in] This Protocol instance pointer.
@param[in] ControllerHandle Handle of device to test.
@param[in] RemainingDevicePath Optional parameter use to pick a specific
child device to start.
@retval EFI_SUCCESS This driver supports this device.
@retval EFI_ALREADY_STARTED This driver is already running on this device.
@retval other This driver does not support this device.
**/
)
{
//
// Test for the Tcp4ServiceBinding Protocol
//
NULL,
);
//
// Test for the Ip4ServiceBinding Protocol
//
NULL,
);
return EFI_SUCCESS;
}
} else {
}
//
// Check the Tcp6ServiceBinding Protocol
//
NULL,
);
//
// Test for the Ip6ServiceBinding Protocol
//
NULL,
);
return EFI_SUCCESS;
}
} else if (IsTcp4Started) {
return EFI_ALREADY_STARTED;
}
return EFI_UNSUPPORTED;
}
/**
Start this driver on ControllerHandle.
@param[in] This Protocol instance pointer.
@param[in] ControllerHandle Handle of device to bind driver to.
@param[in] RemainingDevicePath Optional parameter use to pick a specific child
device to start.
@retval EFI_SUCCESS The driver is added to ControllerHandle.
@retval EFI_OUT_OF_RESOURCES There are not enough resources to start the
driver.
@retval other The driver cannot be added to ControllerHandle.
**/
)
{
}
}
return EFI_SUCCESS;
} else if (EFI_ERROR (Tcp4Status)) {
return Tcp4Status;
} else {
return Tcp6Status;
}
}
/**
Stop this driver on ControllerHandle.
@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
@param[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.
@param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer.
@param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL
if NumberOfChildren is 0.
@retval EFI_SUCCESS The device was stopped.
@retval EFI_DEVICE_ERROR The device could not be stopped due to a device error.
**/
)
{
);
);
return EFI_DEVICE_ERROR;
} else {
return EFI_SUCCESS;
}
}
/**
The Callback funtion called after the TCP socket was created.
@param[in] This Pointer to the socket just created
@param[in] Context Context of the socket
@retval EFI_SUCCESS This protocol installed successfully.
@retval other An error occured.
**/
)
{
} else {
}
//
// Open the default IP protocol of IP_IO BY_DRIVER.
//
&Ip,
);
return Status;
}
//
// Open the device path on the handle where service binding resides on.
//
);
gBS->CloseProtocol (
);
} else {
//
// Insert this socket into the SocketList.
//
}
return Status;
}
/**
The callback function called before the TCP socket was to be destroyed.
@param[in] This The TCP socket to be destroyed.
@param[in] Context The context of the socket.
**/
)
{
} else {
}
//
// Remove this node from the list.
//
//
// Close the device path protocol
//
gBS->CloseProtocol (
);
//
// Close the IP protocol.
//
gBS->CloseProtocol (
);
}
/**
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.
@param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
@param[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.
@retval EFI_SUCCES The protocol was added to ChildHandle.
@retval EFI_INVALID_PARAMETER ChildHandle is NULL.
@retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create
the child.
@retval other The child handle was not created.
**/
)
{
return EFI_INVALID_PARAMETER;
}
//
// Create a tcp instance with defualt Tcp default
// sock init data and TcpProto
//
} else {
}
DEBUG (
"TcpDriverBindingCreateChild: No resource to create a Tcp Child\n")
);
} else {
}
return Status;
}
/**
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.
@param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
@param ChildHandle Handle of the child to be destroyed.
@retval EFI_SUCCES The protocol was removed from ChildHandle.
@retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.
@retval EFI_INVALID_PARAMETER Child handle is NULL.
@retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle
because its services are being used.
@retval other The child handle was not destroyed.
**/
)
{
return EFI_INVALID_PARAMETER;
}
//
// retrieve the Tcp4 protocol from ChildHandle
//
&Tcp,
);
//
// No Tcp4, try the Tcp6 protocol
//
&Tcp,
);
}
}
//
// destroy this sock and related Tcp protocol control
// block
//
}
return Status;
}