/** @file\r
Tcp driver function header.\r
\r
-Copyright (c) 2005 - 2016, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
Tcp4ServiceBinding, \\r
TCP4_DRIVER_SIGNATURE \\r
)\r
- \r
+\r
///\r
/// TCP heartbeat tick timer.\r
///\r
\r
/**\r
Tests to see if this driver supports a given controller.\r
- \r
- If a child device is provided, it further tests to see if this driver supports \r
+\r
+ If a child device is provided, it further tests to see if this driver supports\r
creating a handle for the specified child device.\r
\r
@param This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
- @param ControllerHandle The handle of the controller to test. This handle \r
- must support a protocol interface that supplies \r
+ @param ControllerHandle The handle of the controller to test. This handle\r
+ must support a protocol interface that supplies\r
an I/O abstraction to the driver.\r
- @param RemainingDevicePath A pointer to the remaining portion of a device path. \r
+ @param RemainingDevicePath A pointer to the remaining portion of a device path.\r
This parameter is ignored by device drivers, and is optional for bus drivers.\r
\r
\r
@retval EFI_SUCCESS The device specified by ControllerHandle and\r
- RemainingDevicePath is supported by the driver \r
+ RemainingDevicePath is supported by the driver\r
specified by This.\r
@retval EFI_ALREADY_STARTED The device specified by ControllerHandle and\r
- RemainingDevicePath is already being managed by \r
+ RemainingDevicePath is already being managed by\r
the driver specified by This.\r
@retval EFI_ACCESS_DENIED The device specified by ControllerHandle and\r
- RemainingDevicePath is already being managed by a \r
- different driver or an application that requires \r
+ RemainingDevicePath is already being managed by a\r
+ different driver or an application that requires\r
exclusive access.\r
@retval EFI_UNSUPPORTED The device specified by ControllerHandle and\r
- RemainingDevicePath is not supported by the driver \r
+ RemainingDevicePath is not supported by the driver\r
specified by This.\r
- \r
+\r
**/\r
EFI_STATUS\r
EFIAPI\r
);\r
\r
/**\r
- Start this driver on ControllerHandle. \r
- \r
- The Start() function is designed to be invoked from the EFI boot service \r
- ConnectController(). As a result, much of the error checking on the parameters \r
- to Start() has been moved into this common boot service. It is legal to call \r
- Start() from other locations, but the following calling restrictions must be \r
+ Start this driver on ControllerHandle.\r
+\r
+ The Start() function is designed to be invoked from the EFI boot service\r
+ ConnectController(). As a result, much of the error checking on the parameters\r
+ to Start() has been moved into this common boot service. It is legal to call\r
+ Start() from other locations, but the following calling restrictions must be\r
followed or the system behavior will not be deterministic.\r
1. ControllerHandle must be a valid EFI_HANDLE.\r
- 2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally \r
+ 2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally\r
aligned EFI_DEVICE_PATH_PROTOCOL.\r
- 3. Prior to calling Start(), the Supported() function for the driver specified \r
- by This must have been called with the same calling parameters, and Supported() \r
+ 3. Prior to calling Start(), the Supported() function for the driver specified\r
+ by This must have been called with the same calling parameters, and Supported()\r
must have returned EFI_SUCCESS.\r
\r
@param This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
- @param ControllerHandle The handle of the controller to start. This handle \r
- must support a protocol interface that supplies \r
+ @param ControllerHandle The handle of the controller to start. This handle\r
+ must support a protocol interface that supplies\r
an I/O abstraction to the driver.\r
- @param RemainingDevicePath A pointer to the remaining portion of a device path. \r
- This parameter is ignored by device drivers, and is \r
+ @param RemainingDevicePath A pointer to the remaining portion of a device path.\r
+ This parameter is ignored by device drivers, and is\r
optional for bus drivers.\r
\r
@retval EFI_SUCCESS The device was started.\r
@retval EFI_ALREADY_STARTED The device could not be started due to a device error.\r
- @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack \r
+ @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack\r
of resources.\r
\r
**/\r
\r
/**\r
Stop this driver on ControllerHandle.\r
- \r
- The Stop() function is designed to be invoked from the EFI boot service \r
- DisconnectController(). As a result, much of the error checking on the parameters \r
- to Stop() has been moved into this common boot service. It is legal to call Stop() \r
- from other locations, but the following calling restrictions must be followed \r
+\r
+ The Stop() function is designed to be invoked from the EFI boot service\r
+ DisconnectController(). As a result, much of the error checking on the parameters\r
+ to Stop() has been moved into this common boot service. It is legal to call Stop()\r
+ from other locations, but the following calling restrictions must be followed\r
or the system behavior will not be deterministic.\r
- 1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call \r
+ 1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call\r
to this same driver's Start() function.\r
2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid\r
- EFI_HANDLE. In addition, all of these handles must have been created in this \r
- driver's Start() function, and the Start() function must have called OpenProtocol() \r
+ EFI_HANDLE. In addition, all of these handles must have been created in this\r
+ driver's Start() function, and the Start() function must have called OpenProtocol()\r
on ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.\r
- \r
+\r
@param This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
- @param ControllerHandle A handle to the device being stopped. The handle must \r
- support a bus specific I/O protocol for the driver \r
+ @param ControllerHandle A handle to the device being stopped. The handle must\r
+ support a bus specific I/O protocol for the driver\r
to use to stop the device.\r
@param NumberOfChildren The number of child device handles in ChildHandleBuffer.\r
- @param ChildHandleBuffer An array of child handles to be freed. May be NULL if \r
+ @param ChildHandleBuffer An array of child handles to be freed. May be NULL if\r
NumberOfChildren is 0.\r
\r
@retval EFI_SUCCESS The device was stopped.\r
);\r
\r
/**\r
- Open Ip4 and device path protocols for a created socket, and insert it in \r
+ Open Ip4 and device path protocols for a created socket, and insert it in\r
socket list.\r
- \r
+\r
@param This Pointer to the socket just created\r
@param Context Context of the socket\r
- \r
+\r
@retval EFI_SUCCESS This protocol is installed successfully.\r
@retval other Some error occured.\r
- \r
+\r
**/\r
EFI_STATUS\r
Tcp4CreateSocketCallback (\r
);\r
\r
/**\r
- Close Ip4 and device path protocols for a socket, and remove it from socket list. \r
- \r
+ Close Ip4 and device path protocols for a socket, and remove it from socket list.\r
+\r
@param This Pointer to the socket to be removed\r
@param Context Context of the socket\r
- \r
+\r
**/\r
VOID\r
Tcp4DestroySocketCallback (\r
\r
/**\r
Creates a child handle and installs a protocol.\r
- \r
- The CreateChild() function installs a protocol on ChildHandle. If ChildHandle \r
- is a pointer to NULL, then a new handle is created and returned in ChildHandle. \r
- If ChildHandle is not a pointer to NULL, then the protocol installs on the existing \r
+\r
+ The CreateChild() function installs a protocol on ChildHandle. If ChildHandle\r
+ is a pointer to NULL, then a new handle is created and returned in ChildHandle.\r
+ If ChildHandle is not a pointer to NULL, then the protocol installs on the existing\r
ChildHandle.\r
\r
@param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
- @param ChildHandle Pointer to the handle of the child to create. If it is NULL, then \r
- a new handle is created. If it is a pointer to an existing UEFI \r
+ @param ChildHandle Pointer to the handle of the child to create. If it is NULL, then\r
+ a new handle is created. If it is a pointer to an existing UEFI\r
handle, then the protocol is added to the existing UEFI handle.\r
\r
@retval EFI_SUCCES The protocol was added to ChildHandle.\r
\r
/**\r
Destroys a child handle with a protocol installed on it.\r
- \r
- The DestroyChild() function does the opposite of CreateChild(). It removes a protocol \r
- that was installed by CreateChild() from ChildHandle. If the removed protocol is the \r
+\r
+ The DestroyChild() function does the opposite of CreateChild(). It removes a protocol\r
+ that was installed by CreateChild() from ChildHandle. If the removed protocol is the\r
last protocol on ChildHandle, then ChildHandle is destroyed.\r
\r
@param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
@param ChildHandle Handle of the child to destroy\r
\r
@retval EFI_SUCCES The protocol was removed from ChildHandle.\r
- @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is \r
+ @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is\r
being removed.\r
@retval EFI_INVALID_PARAMETER Child handle is NULL.\r
@retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle\r
because its services are being used.\r
@retval other The child handle was not destroyed.\r
- \r
+\r
**/\r
EFI_STATUS\r
EFIAPI\r
projects / mirror_edk2.git / blobdiff