remedy the comment of EFI_CONSOLE_CONTROL_PROTOCOL_LOCK_STD_IN

[mirror_edk2.git] / MdeModulePkg / Include / Protocol / Tcp.h

/** @file\r
\r
    This file defines EFI Transmission Control Protocol.\r
\r
Copyright (c) 2004 - 2008, 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
**/\r
\r
\r
#ifndef __EFI_TCP_H__\r
#define __EFI_TCP_H__\r
\r
\r
#include <Protocol/PxeBaseCode.h>\r
\r
//\r
// PXE Base Code protocol\r
//\r
\r
#define EFI_TCP_PROTOCOL_GUID \\r
    { 0x02b3d5f2, 0xac28, 0x11d3, { 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d }}\r
\r
\r
typedef UINT16 EFI_PXE_BASE_CODE_TCP_PORT;\r
\r
//\r
// Port Receive Filter definitions\r
//\r
#define EFI_PXE_BASE_CODE_MAX_PORTCNT             8\r
typedef struct {\r
    UINT8                       Filters;\r
    UINT8                       IpCnt;\r
    UINT16                      reserved;\r
    EFI_IP_ADDRESS              IpList[EFI_PXE_BASE_CODE_MAX_PORTCNT];\r
} EFI_TCP_PORT_FILTER;\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_TCP_WRITE)(\r
    IN EFI_PXE_BASE_CODE_PROTOCOL        *This,\r
    IN UINT16                                    OpFlags,\r
    IN UINT16                                    *UrgentPointer,\r
    IN UINT32                                    *SequenceNumber,\r
    IN UINT32                                    *AckNumber,\r
    IN UINT16                                    *HlenResCode,\r
    IN UINT16                                    *Window,\r
    IN EFI_IP_ADDRESS                            *DestIp,\r
    IN UINT16                                    *DestPort,\r
    IN EFI_IP_ADDRESS                            *GatewayIp,  OPTIONAL\r
    IN EFI_IP_ADDRESS                            *SrcIp,      OPTIONAL\r
    IN UINT16                                    *SrcPort,    OPTIONAL\r
    IN UINTN                                     *HeaderSize, OPTIONAL\r
    IN VOID                                      *HeaderPtr,  OPTIONAL\r
    IN UINTN                                     *BufferSize,\r
    IN VOID                                      *BufferPtr\r
    );\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_TCP_READ)(\r
    IN EFI_PXE_BASE_CODE_PROTOCOL        *This,\r
    IN UINT16                                    OpFlags,\r
    IN OUT EFI_IP_ADDRESS                        *DestIp,      OPTIONAL\r
    IN OUT UINT16                                *DestPort,    OPTIONAL\r
    IN OUT EFI_IP_ADDRESS                        *SrcIp,       OPTIONAL\r
    IN OUT UINT16                                *SrcPort,     OPTIONAL\r
    IN UINTN                                     *HeaderSize,  OPTIONAL\r
    IN VOID                                      *HeaderPtr,   OPTIONAL\r
    IN OUT UINTN                                 *BufferSize,\r
    IN VOID                                      *BufferPtr\r
    );\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_TCP_SET_PORT_FILTER)(\r
    IN EFI_PXE_BASE_CODE_PROTOCOL    *This,\r
    IN EFI_TCP_PORT_FILTER                   *NewFilter\r
    );\r
\r
//\r
// TCP Protocol structure\r
//\r
typedef struct _EFI_TCP_PROTOCOL {\r
    EFI_TCP_WRITE             TcpWrite;\r
    EFI_TCP_READ              TcpRead;\r
    EFI_TCP_SET_PORT_FILTER   SetPortFilter;\r
} EFI_TCP_PROTOCOL;\r
\r
extern EFI_GUID gEfiTcpProtocolGuid;\r
\r
#endif /* _EFITCP_H */\r