UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm

[mirror_edk2.git] / NetworkPkg / TcpDxe / TcpDriver.h

/** @file\r
  The prototype of driver binding and service binding protocol for TCP driver.\r
\r
  Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _TCP_DRIVER_H_\r
#define _TCP_DRIVER_H_\r
\r
#define TCP_DRIVER_SIGNATURE  SIGNATURE_32 ('T', 'C', 'P', 'D')\r
\r
#define TCP_PORT_KNOWN          1024\r
#define TCP_PORT_USER_RESERVED  65535\r
\r
typedef struct _TCP_HEARTBEAT_TIMER {\r
  EFI_EVENT    TimerEvent;\r
  INTN         RefCnt;\r
} TCP_HEARTBEAT_TIMER;\r
\r
typedef struct _TCP_SERVICE_DATA {\r
  UINT32                          Signature;\r
  EFI_HANDLE                      ControllerHandle;\r
  EFI_HANDLE                      DriverBindingHandle;\r
  UINT8                           IpVersion;\r
  IP_IO                           *IpIo;\r
  EFI_SERVICE_BINDING_PROTOCOL    ServiceBinding;\r
  LIST_ENTRY                      SocketList;\r
} TCP_SERVICE_DATA;\r
\r
typedef struct _TCP_PROTO_DATA {\r
  TCP_SERVICE_DATA    *TcpService;\r
  TCP_CB              *TcpPcb;\r
} TCP_PROTO_DATA;\r
\r
#define TCP_SERVICE_FROM_THIS(a) \\r
  CR ( \\r
  (a), \\r
  TCP_SERVICE_DATA, \\r
  ServiceBinding, \\r
  TCP_DRIVER_SIGNATURE \\r
  )\r
\r
//\r
// Function prototype for the driver's entry point\r
//\r
\r
/**\r
  The entry point for Tcp driver, used to install Tcp driver on the ImageHandle.\r
\r
  @param[in]  ImageHandle   The firmware allocated handle for this driver image.\r
  @param[in]  SystemTable   Pointer to the EFI system table.\r
\r
  @retval EFI_SUCCESS   The driver loaded.\r
  @retval other         The driver did not load.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
TcpDriverEntryPoint (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
//\r
// Function prototypes for the Driver Binding Protocol\r
//\r
\r
/**\r
  Test to see if this driver supports ControllerHandle.\r
\r
  @param[in]  This                Protocol instance pointer.\r
  @param[in]  ControllerHandle    Handle of the device to test.\r
  @param[in]  RemainingDevicePath Optional parameter use to pick a specific\r
                                  child device to start.\r
\r
  @retval EFI_SUCCESS             This driver supports this device.\r
  @retval EFI_ALREADY_STARTED     This driver is already running on this device.\r
  @retval other                   This driver does not support this device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tcp4DriverBindingSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL\r
  );\r
\r
/**\r
  Start this driver on ControllerHandle.\r
\r
  @param[in]  This                   Protocol instance pointer.\r
  @param[in]  ControllerHandle       Handle of device to bind driver to.\r
  @param[in]  RemainingDevicePath    Optional parameter use to pick a specific child\r
                                     device to start.\r
\r
  @retval EFI_SUCCESS            The driver was added to ControllerHandle.\r
  @retval EFI_OUT_OF_RESOURCES   There are not enough resources to start the\r
                                 driver.\r
  @retval other                  The driver cannot be added to ControllerHandle.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tcp4DriverBindingStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL\r
  );\r
\r
/**\r
  Stop this driver on ControllerHandle.\r
\r
  @param[in]  This              A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
  @param[in]  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[in]  NumberOfChildren  The number of child device handles in ChildHandleBuffer.\r
  @param[in]  ChildHandleBuffer An array of child handles to be freed. May be NULL\r
                                if NumberOfChildren is 0.\r
\r
  @retval EFI_SUCCESS           The device was stopped.\r
  @retval EFI_DEVICE_ERROR      The device could not be stopped due to a device error.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tcp4DriverBindingStop (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN  EFI_HANDLE                   ControllerHandle,\r
  IN  UINTN                        NumberOfChildren,\r
  IN  EFI_HANDLE                   *ChildHandleBuffer OPTIONAL\r
  );\r
\r
/**\r
  Test to see if this driver supports ControllerHandle.\r
\r
  @param[in]  This                Protocol instance pointer.\r
  @param[in]  ControllerHandle    Handle of the device to test.\r
  @param[in]  RemainingDevicePath Optional parameter use to pick a specific\r
                                  child device to start.\r
\r
  @retval EFI_SUCCESS             This driver supports this device.\r
  @retval EFI_ALREADY_STARTED     This driver is already running on this device.\r
  @retval other                   This driver does not support this device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tcp6DriverBindingSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL\r
  );\r
\r
/**\r
  Start this driver on ControllerHandle.\r
\r
  @param[in]  This                   Protocol instance pointer.\r
  @param[in]  ControllerHandle       Handle of device to bind driver to.\r
  @param[in]  RemainingDevicePath    Optional parameter use to pick a specific child\r
                                     device to start.\r
\r
  @retval EFI_SUCCESS            The driver was added to ControllerHandle.\r
  @retval EFI_OUT_OF_RESOURCES   There are not enough resources to start the\r
                                 driver.\r
  @retval other                  The driver cannot be added to ControllerHandle.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tcp6DriverBindingStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL\r
  );\r
\r
/**\r
  Stop this driver on ControllerHandle.\r
\r
  @param[in]  This              A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
  @param[in]  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[in]  NumberOfChildren  The number of child device handles in ChildHandleBuffer.\r
  @param[in]  ChildHandleBuffer An array of child handles to be freed. May be NULL\r
                                if NumberOfChildren is 0.\r
\r
  @retval EFI_SUCCESS           The device was stopped.\r
  @retval EFI_DEVICE_ERROR      The device could not be stopped due to a device error.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tcp6DriverBindingStop (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN  EFI_HANDLE                   ControllerHandle,\r
  IN  UINTN                        NumberOfChildren,\r
  IN  EFI_HANDLE                   *ChildHandleBuffer OPTIONAL\r
  );\r
\r
/**\r
  The Callback function called after the TCP socket is created.\r
\r
  @param[in]  This            Pointer to the socket just created.\r
  @param[in]  Context         The context of the socket.\r
\r
  @retval EFI_SUCCESS         This protocol is installed successfully.\r
  @retval other               An error occurred.\r
\r
**/\r
EFI_STATUS\r
TcpCreateSocketCallback (\r
  IN SOCKET  *This,\r
  IN VOID    *Context\r
  );\r
\r
/**\r
  The callback function called before the TCP socket is to be destroyed.\r
\r
  @param[in]  This                   The TCP socket to be destroyed.\r
  @param[in]  Context                The context of the socket.\r
\r
**/\r
VOID\r
TcpDestroySocketCallback (\r
  IN SOCKET  *This,\r
  IN VOID    *Context\r
  );\r
\r
//\r
// Function prototypes for the ServiceBinding Protocol\r
//\r
\r
/**\r
  Creates a child handle with a set of TCP services.\r
\r
  The CreateChild() function installs a protocol on ChildHandle.\r
  If ChildHandle 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 ChildHandle.\r
\r
  @param[in]      This          Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
  @param[in, out] ChildHandle   Pointer to the handle of the child to create.\r
                                If it is NULL, then a new handle is created.\r
                                If it is a pointer to an existing UEFI handle,\r
                                then the protocol is added to the existing UEFI handle.\r
\r
  @retval EFI_SUCCESS           The protocol was added to ChildHandle.\r
  @retval EFI_INVALID_PARAMETER ChildHandle is NULL.\r
  @retval EFI_OUT_OF_RESOURCES  There are not enough resources available to create\r
                                the child.\r
  @retval other                 The child handle was not created.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
TcpServiceBindingCreateChild (\r
  IN     EFI_SERVICE_BINDING_PROTOCOL  *This,\r
  IN OUT EFI_HANDLE                    *ChildHandle\r
  );\r
\r
/**\r
  Destroys a child handle with a set of TCP services.\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_SUCCESS           The protocol was removed from ChildHandle.\r
  @retval EFI_UNSUPPORTED       ChildHandle does not support the protocol that is being removed.\r
  @retval EFI_INVALID_PARAMETER The 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
EFI_STATUS\r
EFIAPI\r
TcpServiceBindingDestroyChild (\r
  IN EFI_SERVICE_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                    ChildHandle\r
  );\r
\r
#endif\r