Make variable names for protocol GUIDs consistent

[mirror_edk2.git] / MdePkg / Include / Protocol / Tcp4.h

/** @file\r
  EFI TCPv4 Protocol Definition\r
  The EFI TCPv4 Service Binding Protocol is used to locate EFI TCPv4 Protocol drivers to create\r
  and destroy child of the driver to communicate with other host using TCP protocol.      \r
  The EFI TCPv4 Protocol provides services to send and receive data stream.     \r
\r
  Copyright (c) 2006, Intel Corporation                                                         \r
  All rights reserved. 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
  http://opensource.org/licenses/bsd-license.php                                            \r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
  Module Name:  Tcp4.h\r
\r
**/\r
\r
#ifndef __EFI_TCP4_PROTOCOL_H__\r
#define __EFI_TCP4_PROTOCOL_H__\r
\r
#define EFI_TCP4_SERVICE_BINDING_PROTOCOL_GUID \\r
  { \\r
    0x00720665, 0x67EB, 0x4a99, {0xBA, 0xF7, 0xD3, 0xC3, 0x3A, 0x1C, 0x7C, 0xC9 } \\r
  }\r
\r
#define EFI_TCP4_PROTOCOL_GUID \\r
  { \\r
    0x65530BC7, 0xA359, 0x410f, {0xB0, 0x10, 0x5A, 0xAD, 0xC7, 0xEC, 0x2B, 0x62 } \\r
  }\r
\r
typedef struct _EFI_TCP4_PROTOCOL EFI_TCP4_PROTOCOL;\r
\r
typedef struct {\r
  EFI_IPv4_ADDRESS        LocalAddress;\r
  UINT16                  LocalPort;\r
  EFI_IPv4_ADDRESS        RemoteAddress;\r
  UINT16                  RemotePort;\r
} EFI_TCP4_SERVICE_POINT;\r
\r
typedef struct {\r
  EFI_HANDLE              DriverHandle;\r
  UINTN                   ServiceCount;\r
  EFI_TCP4_SERVICE_POINT  Services[1];\r
} EFI_TCP4_VARIABLE_DATA;\r
\r
typedef struct {\r
  BOOLEAN                 UseDefaultAddress;\r
  EFI_IPv4_ADDRESS        StationAddress;\r
  EFI_IPv4_ADDRESS        SubnetMask;\r
  UINT16                  StationPort;\r
  EFI_IPv4_ADDRESS        RemoteAddress;\r
  UINT16                  RemotePort;\r
  BOOLEAN                 ActiveFlag;\r
} EFI_TCP4_ACCESS_POINT;\r
\r
typedef struct {\r
  UINTN                   ReceiveBufferSize;\r
  UINTN                   SendBufferSize;\r
  UINTN                   MaxSynBackLog;\r
  UINTN                   ConnectionTimeout;\r
  UINTN                   DataRetries;\r
  UINTN                   FinTimeout;\r
  UINTN                   TimeWaitTimeout;\r
  UINTN                   KeepAliveProbes;\r
  UINTN                   KeepAliveTime;\r
  UINTN                   KeepAliveInterval;\r
  BOOLEAN                 EnableNagle;\r
  BOOLEAN                 EnableTimeStamp;\r
  BOOLEAN                 EnableWindowScaling;\r
  BOOLEAN                 EnableSelectiveAck;\r
  BOOLEAN                 EnablePathMtuDiscovery;\r
} EFI_TCP4_OPTION;\r
\r
typedef struct {\r
  //\r
  // I/O parameters\r
  //\r
  UINT8                   TypeOfService;\r
  UINT8                   TimeToLive;\r
\r
  //\r
  // Access Point\r
  //\r
  EFI_TCP4_ACCESS_POINT   AccessPoint;\r
                          \r
  //                      \r
  // TCP Control Options  \r
  //                      \r
  EFI_TCP4_OPTION         *ControlOption;\r
} EFI_TCP4_CONFIG_DATA;\r
\r
typedef enum {\r
  Tcp4StateClosed         = 0,\r
  Tcp4StateListen         = 1,\r
  Tcp4StateSynSent        = 2,\r
  Tcp4StateSynReceived    = 3,\r
  Tcp4StateEstablished    = 4,\r
  Tcp4StateFinWait1       = 5,\r
  Tcp4StateFinWait2       = 6,\r
  Tcp4StateClosing        = 7,\r
  Tcp4StateTimeWait       = 8,\r
  Tcp4StateCloseWait      = 9,\r
  Tcp4StateLastAck        = 10\r
} EFI_TCP4_CONNECTION_STATE;\r
\r
typedef struct {\r
  EFI_EVENT   Event;\r
  EFI_STATUS  Status;\r
} EFI_TCP4_COMPLETION_TOKEN;\r
\r
typedef struct {\r
  EFI_TCP4_COMPLETION_TOKEN CompletionToken;\r
} EFI_TCP4_CONNECTION_TOKEN;\r
\r
typedef struct {\r
  EFI_TCP4_COMPLETION_TOKEN CompletionToken;\r
  EFI_HANDLE                NewChildHandle;\r
} EFI_TCP4_LISTEN_TOKEN;\r
\r
typedef struct {\r
  UINTN FragmentLength;\r
  VOID  *FragmentBuffer;\r
} EFI_TCP4_FRAGMENT_DATA;\r
\r
typedef struct {\r
  BOOLEAN                   UrgentFlag;\r
  IN OUT UINTN              DataLength;\r
  UINTN                     FragmentCount;\r
  EFI_TCP4_FRAGMENT_DATA    FragmentTable[1];\r
} EFI_TCP4_RECEIVE_DATA;    \r
\r
typedef struct {            \r
  BOOLEAN                   Push;\r
  BOOLEAN                   Urgent;\r
  UINTN                     DataLength;\r
  UINTN                     FragmentCount;\r
  EFI_TCP4_FRAGMENT_DATA    FragmentTable[1];\r
} EFI_TCP4_TRANSMIT_DATA;\r
\r
typedef struct {\r
  EFI_TCP4_COMPLETION_TOKEN CompletionToken;\r
  union {\r
    EFI_TCP4_RECEIVE_DATA   *RxData;\r
    EFI_TCP4_TRANSMIT_DATA  *TxData;\r
  } Packet;\r
} EFI_TCP4_IO_TOKEN;\r
\r
typedef struct {\r
  EFI_TCP4_COMPLETION_TOKEN CompletionToken;\r
  BOOLEAN                   AbortOnClose;\r
} EFI_TCP4_CLOSE_TOKEN;\r
\r
//\r
// Interface definition for TCP4 protocol\r
//\r
\r
/**\r
  Get the current operational status.\r
\r
  @param  This           Pointer to the EFI_TCP4_PROTOCOL instance.\r
  @param  Tcp4State      Pointer to the buffer to receive the current TCP state.\r
  @param  Tcp4ConfigData Pointer to the buffer to receive the current TCP configuration.\r
  @param  Ip4ModeData    Pointer to the buffer to receive the current IPv4 configuration\r
                         data used by the TCPv4 instance.\r
  @param  MnpConfigData  Pointer to the buffer to receive the current MNP configuration\r
                         data used indirectly by the TCPv4 instance.\r
  @param  SnpModeData    Pointer to the buffer to receive the current SNP configuration\r
                         data used indirectly by the TCPv4 instance.\r
\r
  @retval EFI_SUCCESS           The mode data was read.\r
  @retval EFI_INVALID_PARAMETER This is NULL.\r