]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/Tcp6.h
MdePkg: Apply uncrustify changes
[mirror_edk2.git] / MdePkg / Include / Protocol / Tcp6.h
index 7f22c421c74ba9bcc56f39198d645e4a3a574103..a8787dd3af1a1659d34cfdf0bc57b6e4b2802980 100644 (file)
@@ -28,7 +28,6 @@
     0x46e44855, 0xbd60, 0x4ab7, {0xab, 0x0d, 0xa6, 0x79, 0xb9, 0x44, 0x7d, 0x77 } \\r
   }\r
 \r
-\r
 typedef struct _EFI_TCP6_PROTOCOL EFI_TCP6_PROTOCOL;\r
 \r
 ///\r
@@ -40,27 +39,27 @@ typedef struct {
   /// The EFI TCPv6 Protocol instance handle that is using this\r
   /// address/port pair.\r
   ///\r
-  EFI_HANDLE        InstanceHandle;\r
+  EFI_HANDLE          InstanceHandle;\r
   ///\r
   /// The local IPv6 address to which this TCP instance is bound. Set\r
   /// to 0::/128, if this TCP instance is configured to listen on all\r
   /// available source addresses.\r
   ///\r
-  EFI_IPv6_ADDRESS  LocalAddress;\r
+  EFI_IPv6_ADDRESS    LocalAddress;\r
   ///\r
   /// The local port number in host byte order.\r
   ///\r
-  UINT16            LocalPort;\r
+  UINT16              LocalPort;\r
   ///\r
   /// The remote IPv6 address. It may be 0::/128 if this TCP instance is\r
   /// not connected to any remote host.\r
   ///\r
-  EFI_IPv6_ADDRESS  RemoteAddress;\r
+  EFI_IPv6_ADDRESS    RemoteAddress;\r
   ///\r
   /// The remote port number in host byte order. It may be zero if this\r
   /// TCP instance is not connected to any remote host.\r
   ///\r
-  UINT16            RemotePort;\r
+  UINT16              RemotePort;\r
 } EFI_TCP6_SERVICE_POINT;\r
 \r
 ///\r
@@ -68,9 +67,9 @@ typedef struct {
 /// The definition in here is only present to provide backwards compatability.\r
 ///\r
 typedef struct {\r
-  EFI_HANDLE             DriverHandle; ///< The handle of the driver that creates this entry.\r
-  UINT32                 ServiceCount; ///< The number of address/port pairs following this data structure.\r
-  EFI_TCP6_SERVICE_POINT Services[1];  ///< List of address/port pairs that are currently in use.\r
+  EFI_HANDLE                DriverHandle; ///< The handle of the driver that creates this entry.\r
+  UINT32                    ServiceCount; ///< The number of address/port pairs following this data structure.\r
+  EFI_TCP6_SERVICE_POINT    Services[1];  ///< List of address/port pairs that are currently in use.\r
 } EFI_TCP6_VARIABLE_DATA;\r
 \r
 ///\r
@@ -85,13 +84,13 @@ typedef struct {
   /// it must be one of the configured IP addresses in the underlying\r
   /// IPv6 driver.\r
   ///\r
-  EFI_IPv6_ADDRESS  StationAddress;\r
+  EFI_IPv6_ADDRESS    StationAddress;\r
   ///\r
   /// The local port number to which this EFI TCPv6 Protocol instance\r
   /// is bound. If the instance doesn't care the local port number, set\r
   /// StationPort to zero to use an ephemeral port.\r
   ///\r
-  UINT16            StationPort;\r
+  UINT16              StationPort;\r
   ///\r
   /// The remote IP address to which this EFI TCPv6 Protocol instance\r
   /// is connected. If ActiveFlag is FALSE (i.e. a passive TCPv6\r
@@ -103,7 +102,7 @@ typedef struct {
   /// can be set to zero and means that incoming connection requests\r
   /// from any address will be accepted.\r
   ///\r
-  EFI_IPv6_ADDRESS  RemoteAddress;\r
+  EFI_IPv6_ADDRESS    RemoteAddress;\r
   ///\r
   /// The remote port to which this EFI TCPv6 Protocol instance\r
   /// connects or from which connection request will be accepted by\r
@@ -112,12 +111,12 @@ typedef struct {
   /// any port will be accepted. Its value can not be zero when\r
   /// ActiveFlag is TRUE.\r
   ///\r
-  UINT16            RemotePort;\r
+  UINT16     RemotePort;\r
   ///\r
   /// Set it to TRUE to initiate an active open. Set it to FALSE to\r
   /// initiate a passive open to act as a server.\r
   ///\r
-  BOOLEAN           ActiveFlag;\r
+  BOOLEAN    ActiveFlag;\r
 } EFI_TCP6_ACCESS_POINT;\r
 \r
 ///\r
@@ -127,28 +126,28 @@ typedef struct {
   ///\r
   /// The size of the TCP receive buffer.\r
   ///\r
-  UINT32   ReceiveBufferSize;\r
+  UINT32    ReceiveBufferSize;\r
   ///\r
   /// The size of the TCP send buffer.\r
   ///\r
-  UINT32   SendBufferSize;\r
+  UINT32    SendBufferSize;\r
   ///\r
   /// The length of incoming connect request queue for a passive\r
   /// instance. When set to zero, the value is implementation specific.\r
   ///\r
-  UINT32   MaxSynBackLog;\r
+  UINT32    MaxSynBackLog;\r
   ///\r
   /// The maximum seconds a TCP instance will wait for before a TCP\r
   /// connection established. When set to zero, the value is\r
   /// implementation specific.\r
   ///\r
-  UINT32   ConnectionTimeout;\r
+  UINT32    ConnectionTimeout;\r
   ///\r
-  ///The number of times TCP will attempt to retransmit a packet on\r
-  ///an established connection. When set to zero, the value is\r
-  ///implementation specific.\r
+  /// The number of times TCP will attempt to retransmit a packet on\r
+  /// an established connection. When set to zero, the value is\r
+  /// implementation specific.\r
   ///\r
-  UINT32   DataRetries;\r
+  UINT32    DataRetries;\r
   ///\r
   /// How many seconds to wait in the FIN_WAIT_2 states for a final\r
   /// FIN flag before the TCP instance is closed. This timeout is in\r
@@ -158,61 +157,61 @@ typedef struct {
   /// it should be disabled because the FIN_WAIT_2 timer itself is\r
   /// against the standard. The default value is 60.\r
   ///\r
-  UINT32   FinTimeout;\r
+  UINT32     FinTimeout;\r
   ///\r
   /// How many seconds to wait in TIME_WAIT state before the TCP\r
   /// instance is closed. The timer is disabled completely to provide a\r
   /// method to close the TCP connection quickly if it is set to zero. It\r
   /// is against the related RFC documents.\r
   ///\r
-  UINT32   TimeWaitTimeout;\r
+  UINT32     TimeWaitTimeout;\r
   ///\r
   /// The maximum number of TCP keep-alive probes to send before\r
   /// giving up and resetting the connection if no response from the\r
   /// other end. Set to zero to disable keep-alive probe.\r
   ///\r
-  UINT32   KeepAliveProbes;\r
+  UINT32     KeepAliveProbes;\r
   ///\r
   /// The number of seconds a connection needs to be idle before TCP\r
   /// sends out periodical keep-alive probes. When set to zero, the\r
   /// value is implementation specific. It should be ignored if keep-\r
   /// alive probe is disabled.\r
   ///\r
-  UINT32   KeepAliveTime;\r
+  UINT32     KeepAliveTime;\r
   ///\r
   /// The number of seconds between TCP keep-alive probes after the\r
   /// periodical keep-alive probe if no response. When set to zero, the\r
   /// value is implementation specific. It should be ignored if keep-\r
   /// alive probe is disabled.\r
   ///\r
-  UINT32   KeepAliveInterval;\r
+  UINT32     KeepAliveInterval;\r
   ///\r
   /// Set it to TRUE to enable the Nagle algorithm as defined in\r
   /// RFC896. Set it to FALSE to disable it.\r
   ///\r
-  BOOLEAN  EnableNagle;\r
+  BOOLEAN    EnableNagle;\r
   ///\r
   /// Set it to TRUE to enable TCP timestamps option as defined in\r
   /// RFC1323. Set to FALSE to disable it.\r
   ///\r
-  BOOLEAN  EnableTimeStamp;\r
+  BOOLEAN    EnableTimeStamp;\r
   ///\r
   /// Set it to TRUE to enable TCP window scale option as defined in\r
   /// RFC1323. Set it to FALSE to disable it.\r
   ///\r
-  BOOLEAN  EnableWindowScaling;\r
+  BOOLEAN    EnableWindowScaling;\r
   ///\r
   /// Set it to TRUE to enable selective acknowledge mechanism\r
   /// described in RFC 2018. Set it to FALSE to disable it.\r
   /// Implementation that supports SACK can optionally support\r
   /// DSAK as defined in RFC 2883.\r
   ///\r
-  BOOLEAN  EnableSelectiveAck;\r
+  BOOLEAN    EnableSelectiveAck;\r
   ///\r
   /// Set it to TRUE to enable path MTU discovery as defined in\r
   /// RFC 1191. Set to FALSE to disable it.\r
   ///\r
-  BOOLEAN  EnablePathMtuDiscovery;\r
+  BOOLEAN    EnablePathMtuDiscovery;\r
 } EFI_TCP6_OPTION;\r
 \r
 ///\r
@@ -222,20 +221,20 @@ typedef struct {
   ///\r
   /// TrafficClass field in transmitted IPv6 packets.\r
   ///\r
-  UINT8                 TrafficClass;\r
+  UINT8                    TrafficClass;\r
   ///\r
   /// HopLimit field in transmitted IPv6 packets.\r
   ///\r
-  UINT8                 HopLimit;\r
+  UINT8                    HopLimit;\r
   ///\r
   /// Used to specify TCP communication end settings for a TCP instance.\r
   ///\r
-  EFI_TCP6_ACCESS_POINT AccessPoint;\r
+  EFI_TCP6_ACCESS_POINT    AccessPoint;\r
   ///\r
   /// Used to configure the advance TCP option for a connection. If set\r
   /// to NULL, implementation specific options for TCP connection will be used.\r
   ///\r
-  EFI_TCP6_OPTION       *ControlOption;\r
+  EFI_TCP6_OPTION          *ControlOption;\r
 } EFI_TCP6_CONFIG_DATA;\r
 \r
 ///\r
@@ -264,11 +263,11 @@ typedef struct {
   /// The Event to signal after request is finished and Status field is\r
   /// updated by the EFI TCPv6 Protocol driver.\r
   ///\r
-  EFI_EVENT   Event;\r
+  EFI_EVENT     Event;\r
   ///\r
   /// The result of the completed operation.\r
   ///\r
-  EFI_STATUS  Status;\r
+  EFI_STATUS    Status;\r
 } EFI_TCP6_COMPLETION_TOKEN;\r
 \r
 ///\r
@@ -304,7 +303,7 @@ typedef struct {
   /// EFI_SECURITY_VIOLATION:   The active open was failed because of IPSec policy check.\r
   /// EFI_NO_MEDIA:             There was a media error.\r
   ///\r
-  EFI_TCP6_COMPLETION_TOKEN CompletionToken;\r
+  EFI_TCP6_COMPLETION_TOKEN    CompletionToken;\r
 } EFI_TCP6_CONNECTION_TOKEN;\r
 \r
 ///\r
@@ -323,8 +322,8 @@ typedef struct {
   /// EFI_ABORTED:            The accept request has been aborted.\r
   /// EFI_SECURITY_VIOLATION: The accept operation was failed because of IPSec policy check.\r
   ///\r
-  EFI_TCP6_COMPLETION_TOKEN CompletionToken;\r
-  EFI_HANDLE                NewChildHandle;\r
+  EFI_TCP6_COMPLETION_TOKEN    CompletionToken;\r
+  EFI_HANDLE                   NewChildHandle;\r
 } EFI_TCP6_LISTEN_TOKEN;\r
 \r
 ///\r
@@ -333,8 +332,8 @@ typedef struct {
 /// purpose of this structure is to provide scattered read and write.\r
 ///\r
 typedef struct {\r
-  UINT32 FragmentLength;   ///< Length of data buffer in the fragment.\r
-  VOID   *FragmentBuffer;  ///< Pointer to the data buffer in the fragment.\r
+  UINT32    FragmentLength;  ///< Length of data buffer in the fragment.\r
+  VOID      *FragmentBuffer; ///< Pointer to the data buffer in the fragment.\r
 } EFI_TCP6_FRAGMENT_DATA;\r
 \r
 ///\r
@@ -348,22 +347,22 @@ typedef struct {
   /// Whether the data is urgent. When this flag is set, the instance is in\r
   /// urgent mode.\r
   ///\r
-  BOOLEAN                 UrgentFlag;\r
+  BOOLEAN                   UrgentFlag;\r
   ///\r
   /// When calling Receive() function, it is the byte counts of all\r
   /// Fragmentbuffer in FragmentTable allocated by user.\r
   /// When the token is signaled by TCPv6 driver it is the length of\r
   /// received data in the fragments.\r
   ///\r
-  UINT32                  DataLength;\r
+  UINT32                    DataLength;\r
   ///\r
   /// Number of fragments.\r
   ///\r
-  UINT32                  FragmentCount;\r
+  UINT32                    FragmentCount;\r
   ///\r
   /// An array of fragment descriptors.\r
   ///\r
-  EFI_TCP6_FRAGMENT_DATA  FragmentTable[1];\r
+  EFI_TCP6_FRAGMENT_DATA    FragmentTable[1];\r
 } EFI_TCP6_RECEIVE_DATA;\r
 \r
 ///\r
@@ -378,24 +377,24 @@ typedef struct {
   /// transmission may be delayed to combine with data from\r
   /// subsequent Transmit()s for efficiency.\r
   ///\r
-  BOOLEAN                 Push;\r
+  BOOLEAN                   Push;\r
   ///\r
   /// The data in the fragment table are urgent and urgent point is in\r
   /// effect if TRUE. Otherwise those data are NOT considered urgent.\r
   ///\r
-  BOOLEAN                 Urgent;\r
+  BOOLEAN                   Urgent;\r
   ///\r
   /// Length of the data in the fragments.\r
   ///\r
-  UINT32                  DataLength;\r
+  UINT32                    DataLength;\r
   ///\r
   /// Number of fragments.\r
   ///\r
-  UINT32                  FragmentCount;\r
+  UINT32                    FragmentCount;\r
   ///\r
   /// An array of fragment descriptors.\r
   ///\r
-  EFI_TCP6_FRAGMENT_DATA  FragmentTable[1];\r
+  EFI_TCP6_FRAGMENT_DATA    FragmentTable[1];\r
 } EFI_TCP6_TRANSMIT_DATA;\r
 \r
 ///\r
@@ -432,18 +431,18 @@ typedef struct {
   ///                           operation was failed because of IPSec policy check\r
   /// EFI_NO_MEDIA:             There was a media error.\r
   ///\r
-  EFI_TCP6_COMPLETION_TOKEN CompletionToken;\r
+  EFI_TCP6_COMPLETION_TOKEN    CompletionToken;\r
   union {\r
     ///\r
     /// When this token is used for receiving, RxData is a pointer to\r
     /// EFI_TCP6_RECEIVE_DATA.\r
     ///\r
-    EFI_TCP6_RECEIVE_DATA   *RxData;\r
+    EFI_TCP6_RECEIVE_DATA     *RxData;\r
     ///\r
     /// When this token is used for transmitting, TxData is a pointer to\r
     /// EFI_TCP6_TRANSMIT_DATA.\r
     ///\r
-    EFI_TCP6_TRANSMIT_DATA  *TxData;\r
+    EFI_TCP6_TRANSMIT_DATA    *TxData;\r
   } Packet;\r
 } EFI_TCP6_IO_TOKEN;\r
 \r
@@ -459,13 +458,13 @@ typedef struct {
   /// EFI_ABORTED:            User called configure with NULL without close stopping.\r
   /// EFI_SECURITY_VIOLATION: The close operation was failed because of IPSec policy check.\r
   ///\r
-  EFI_TCP6_COMPLETION_TOKEN CompletionToken;\r
+  EFI_TCP6_COMPLETION_TOKEN    CompletionToken;\r
   ///\r
   /// Abort the TCP connection on close instead of the standard TCP\r
   /// close process when it is set to TRUE. This option can be used to\r
   /// satisfy a fast disconnect.\r
   ///\r
-  BOOLEAN                   AbortOnClose;\r
+  BOOLEAN                      AbortOnClose;\r
 } EFI_TCP6_CLOSE_TOKEN;\r
 \r
 /**\r
@@ -840,19 +839,18 @@ EFI_STATUS
 /// Each instance has its own independent settings.\r
 ///\r
 struct _EFI_TCP6_PROTOCOL {\r
-  EFI_TCP6_GET_MODE_DATA  GetModeData;\r
-  EFI_TCP6_CONFIGURE      Configure;\r
-  EFI_TCP6_CONNECT        Connect;\r
-  EFI_TCP6_ACCEPT         Accept;\r
-  EFI_TCP6_TRANSMIT       Transmit;\r
-  EFI_TCP6_RECEIVE        Receive;\r
-  EFI_TCP6_CLOSE          Close;\r
-  EFI_TCP6_CANCEL         Cancel;\r
-  EFI_TCP6_POLL           Poll;\r
+  EFI_TCP6_GET_MODE_DATA    GetModeData;\r
+  EFI_TCP6_CONFIGURE        Configure;\r
+  EFI_TCP6_CONNECT          Connect;\r
+  EFI_TCP6_ACCEPT           Accept;\r
+  EFI_TCP6_TRANSMIT         Transmit;\r
+  EFI_TCP6_RECEIVE          Receive;\r
+  EFI_TCP6_CLOSE            Close;\r
+  EFI_TCP6_CANCEL           Cancel;\r
+  EFI_TCP6_POLL             Poll;\r
 };\r
 \r
-extern EFI_GUID gEfiTcp6ServiceBindingProtocolGuid;\r
-extern EFI_GUID gEfiTcp6ProtocolGuid;\r
+extern EFI_GUID  gEfiTcp6ServiceBindingProtocolGuid;\r
+extern EFI_GUID  gEfiTcp6ProtocolGuid;\r
 \r
 #endif\r
-\r