]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Main.h
sync comments, fix function header, rename variable name to follow coding style.
[mirror_edk2.git] / MdeModulePkg / Universal / Network / Tcp4Dxe / Tcp4Main.h
index dba46aa80adc190ccb241ee77f6f6bab0bc816d0..0f5d17a93fb8784581b42904995768ba85e453dd 100644 (file)
-/** @file
-
-Copyright (c) 2005 - 2006, Intel Corporation
-All rights reserved. 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
-http://opensource.org/licenses/bsd-license.php
-
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-
-Module Name:
-
-  Tcp4Main.h
-
-Abstract:
-
-
-**/
-
-#ifndef _TCP4_MAIN_H_
-#define _TCP4_MAIN_H_
-
-#include "Socket.h"
-
-#include "Tcp4Proto.h"
-#include "Tcp4Driver.h"
-
-
-extern UINT16  mTcp4RandomPort;
-
-//
-// Driver Produced Protocol Prototypes
-//
-//@MT:#include EFI_PROTOCOL_PRODUCER (Tcp4)
-
-#define TCP4_DEBUG_ERROR(PrintArg) NET_DEBUG_ERROR   ("Tcp", PrintArg)
-#define TCP4_DEBUG_WARN(PrintArg)  NET_DEBUG_WARNING ("Tcp", PrintArg)
-#define TCP4_DEBUG_TRACE(PrintArg) NET_DEBUG_TRACE   ("Tcp", PrintArg)
-
-//
-// Function prototype for the Tcp4 socket request handler
-//
-EFI_STATUS
-Tcp4Dispatcher (
-  IN SOCKET                  *Sock,
-  IN SOCK_REQUEST            Request,
-  IN VOID                    *Data    OPTIONAL
-  );
-
-typedef struct _TCP4_MODE_DATA {
-  EFI_TCP4_CONNECTION_STATE       *Tcp4State;
-  EFI_TCP4_CONFIG_DATA            *Tcp4ConfigData;
-  EFI_IP4_MODE_DATA               *Ip4ModeData;
-  EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData;
-  EFI_SIMPLE_NETWORK_MODE         *SnpModeData;
-} TCP4_MODE_DATA;
-
-typedef struct _TCP4_ROUTE_INFO {
-  BOOLEAN           DeleteRoute;
-  EFI_IPv4_ADDRESS  *SubnetAddress;
-  EFI_IPv4_ADDRESS  *SubnetMask;
-  EFI_IPv4_ADDRESS  *GatewayAddress;
-} TCP4_ROUTE_INFO;
-
-//
-// Get the mode data of a TCP instance
-//
-EFI_STATUS
-EFIAPI
-Tcp4GetModeData (
-  IN  CONST EFI_TCP4_PROTOCOL                  * This,
-  OUT       EFI_TCP4_CONNECTION_STATE          * Tcp4State OPTIONAL,
-  OUT       EFI_TCP4_CONFIG_DATA               * Tcp4ConfigData OPTIONAL,
-  OUT       EFI_IP4_MODE_DATA                  * Ip4ModeData OPTIONAL,
-  OUT       EFI_MANAGED_NETWORK_CONFIG_DATA    * MnpConfigData OPTIONAL,
-  OUT       EFI_SIMPLE_NETWORK_MODE            * SnpModeData OPTIONAL
-  );
-
-//
-// Initialize or reset a TCP instance
-//
-EFI_STATUS
-EFIAPI
-Tcp4Configure (
-  IN EFI_TCP4_PROTOCOL        * This,
-  IN EFI_TCP4_CONFIG_DATA     * TcpConfigData OPTIONAL
-  );
-
-//
-// Add a route entry to the route table
-//
-EFI_STATUS
-EFIAPI
-Tcp4Routes (
-  IN EFI_TCP4_PROTOCOL           *This,
-  IN BOOLEAN                     DeleteRoute,
-  IN EFI_IPv4_ADDRESS            *SubnetAddress,
-  IN EFI_IPv4_ADDRESS            *SubnetMask,
-  IN EFI_IPv4_ADDRESS            *GatewayAddress
-  );
-
-//
-// Issue an asynchronous connection establishment
-// request to the peer
-//
-EFI_STATUS
-EFIAPI
-Tcp4Connect (
-  IN EFI_TCP4_PROTOCOL           *This,
-  IN EFI_TCP4_CONNECTION_TOKEN   *ConnectionToken
-  );
-
-//
-// Issue an asynchronous listent token to accept an
-// incoming connection reques
-//
-EFI_STATUS
-EFIAPI
-Tcp4Accept (
-  IN EFI_TCP4_PROTOCOL             *This,
-  IN EFI_TCP4_LISTEN_TOKEN         *ListenToken
-  );
-
-//
-// Issue an asynchronous IO token to transmit some data
-// through this TCP instance
-//
-EFI_STATUS
-EFIAPI
-Tcp4Transmit (
-  IN EFI_TCP4_PROTOCOL            *This,
-  IN EFI_TCP4_IO_TOKEN            *Token
-  );
-
-//
-// Issue an asynchronous IO token to receive some data
-// through this TCP instance
-//
-EFI_STATUS
-Tcp4Receive (
-  IN EFI_TCP4_PROTOCOL           *This,
-  IN EFI_TCP4_IO_TOKEN           *Token
-  );
-
-//
-// Issue an asynchronous CloseToken to close a TCP
-// connection represented by instance
-//
-EFI_STATUS
-EFIAPI
-Tcp4Close (
-  IN EFI_TCP4_PROTOCOL           *This,
-  IN EFI_TCP4_CLOSE_TOKEN        *CloseToken
-  );
-
-//
-// cancle an connect, listent or IO token
-//
-EFI_STATUS
-EFIAPI
-Tcp4Cancel (
-  IN EFI_TCP4_PROTOCOL           * This,
-  IN EFI_TCP4_COMPLETION_TOKEN   * Token OPTIONAL
-  );
-
-//
-// poll data from NIC for receive
-//
-EFI_STATUS
-EFIAPI
-Tcp4Poll (
-  IN EFI_TCP4_PROTOCOL        *This
-  );
-
-#endif
+/** @file\r
+\r
+Copyright (c) 2005 - 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:\r
+\r
+  Tcp4Main.h\r
+\r
+Abstract:\r
+\r
+\r
+**/\r
+\r
+#ifndef _TCP4_MAIN_H_\r
+#define _TCP4_MAIN_H_\r
+\r
+#include "Socket.h"\r
+\r
+#include "Tcp4Proto.h"\r
+#include "Tcp4Driver.h"\r
+\r
+\r
+extern UINT16  mTcp4RandomPort;\r
+\r
+//\r
+// Driver Produced Protocol Prototypes\r
+//\r
+\r
+//\r
+// Function prototype for the Tcp4 socket request handler\r
+//\r
+EFI_STATUS\r
+Tcp4Dispatcher (\r
+  IN SOCKET                  *Sock,\r
+  IN SOCK_REQUEST            Request,\r
+  IN VOID                    *Data    OPTIONAL\r
+  );\r
+\r
+typedef struct _TCP4_MODE_DATA {\r
+  EFI_TCP4_CONNECTION_STATE       *Tcp4State;\r
+  EFI_TCP4_CONFIG_DATA            *Tcp4ConfigData;\r
+  EFI_IP4_MODE_DATA               *Ip4ModeData;\r
+  EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData;\r
+  EFI_SIMPLE_NETWORK_MODE         *SnpModeData;\r
+} TCP4_MODE_DATA;\r
+\r
+typedef struct _TCP4_ROUTE_INFO {\r
+  BOOLEAN           DeleteRoute;\r
+  EFI_IPv4_ADDRESS  *SubnetAddress;\r
+  EFI_IPv4_ADDRESS  *SubnetMask;\r
+  EFI_IPv4_ADDRESS  *GatewayAddress;\r
+} TCP4_ROUTE_INFO;\r
+\r
+//\r
+// Get the mode data of a TCP instance\r
+//\r
+EFI_STATUS\r
+EFIAPI\r
+Tcp4GetModeData (\r
+  IN  CONST EFI_TCP4_PROTOCOL                  * This,\r
+  OUT       EFI_TCP4_CONNECTION_STATE          * Tcp4State OPTIONAL,\r
+  OUT       EFI_TCP4_CONFIG_DATA               * Tcp4ConfigData OPTIONAL,\r
+  OUT       EFI_IP4_MODE_DATA                  * Ip4ModeData OPTIONAL,\r
+  OUT       EFI_MANAGED_NETWORK_CONFIG_DATA    * MnpConfigData OPTIONAL,\r
+  OUT       EFI_SIMPLE_NETWORK_MODE            * SnpModeData OPTIONAL\r
+  );\r
+\r
+//\r
+// Initialize or reset a TCP instance\r
+//\r
+EFI_STATUS\r
+EFIAPI\r
+Tcp4Configure (\r
+  IN EFI_TCP4_PROTOCOL        * This,\r
+  IN EFI_TCP4_CONFIG_DATA     * TcpConfigData OPTIONAL\r
+  );\r
+\r
+//\r
+// Add a route entry to the route table\r
+//\r
+EFI_STATUS\r
+EFIAPI\r
+Tcp4Routes (\r
+  IN EFI_TCP4_PROTOCOL           *This,\r
+  IN BOOLEAN                     DeleteRoute,\r
+  IN EFI_IPv4_ADDRESS            *SubnetAddress,\r
+  IN EFI_IPv4_ADDRESS            *SubnetMask,\r
+  IN EFI_IPv4_ADDRESS            *GatewayAddress\r
+  );\r
+\r
+//\r
+// Issue an asynchronous connection establishment\r
+// request to the peer\r
+//\r
+EFI_STATUS\r
+EFIAPI\r
+Tcp4Connect (\r
+  IN EFI_TCP4_PROTOCOL           *This,\r
+  IN EFI_TCP4_CONNECTION_TOKEN   *ConnectionToken\r
+  );\r
+\r
+//\r
+// Issue an asynchronous listent token to accept an\r
+// incoming connection reques\r
+//\r
+EFI_STATUS\r
+EFIAPI\r
+Tcp4Accept (\r
+  IN EFI_TCP4_PROTOCOL             *This,\r
+  IN EFI_TCP4_LISTEN_TOKEN         *ListenToken\r
+  );\r
+\r
+//\r
+// Issue an asynchronous IO token to transmit some data\r
+// through this TCP instance\r
+//\r
+EFI_STATUS\r
+EFIAPI\r
+Tcp4Transmit (\r
+  IN EFI_TCP4_PROTOCOL            *This,\r
+  IN EFI_TCP4_IO_TOKEN            *Token\r
+  );\r
+\r
+//\r
+// Issue an asynchronous IO token to receive some data\r
+// through this TCP instance\r
+//\r
+EFI_STATUS\r
+Tcp4Receive (\r
+  IN EFI_TCP4_PROTOCOL           *This,\r
+  IN EFI_TCP4_IO_TOKEN           *Token\r
+  );\r
+\r
+//\r
+// Issue an asynchronous CloseToken to close a TCP\r
+// connection represented by instance\r
+//\r
+EFI_STATUS\r
+EFIAPI\r
+Tcp4Close (\r
+  IN EFI_TCP4_PROTOCOL           *This,\r
+  IN EFI_TCP4_CLOSE_TOKEN        *CloseToken\r
+  );\r
+\r
+//\r
+// cancle an connect, listent or IO token\r
+//\r
+EFI_STATUS\r
+EFIAPI\r
+Tcp4Cancel (\r
+  IN EFI_TCP4_PROTOCOL           * This,\r
+  IN EFI_TCP4_COMPLETION_TOKEN   * Token OPTIONAL\r
+  );\r
+\r
+//\r
+// poll data from NIC for receive\r
+//\r
+EFI_STATUS\r
+EFIAPI\r
+Tcp4Poll (\r
+  IN EFI_TCP4_PROTOCOL        *This\r
+  );\r
+\r
+#endif\r