remove member context from _EFI_MTFTP4_TOKEN structure.
[mirror_edk2.git] / MdeModulePkg / Universal / Network / Mtftp4Dxe / Mtftp4Impl.h
index 22ba7dd..c12b1dd 100644 (file)
@@ -1,33 +1,33 @@
-/** @file
-
-Copyright (c) 2006 - 2007, 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:
-
-  Mtftp4Impl.h
-
-Abstract:
-
- Mtftp4 Implementation, it supports the following RFCs:
-   RFC1350 - THE TFTP PROTOCOL (REVISION 2)
-   RFC2090 - TFTP Multicast Option
-   RFC2347 - TFTP Option Extension
-   RFC2348 - TFTP Blocksize Option
-   RFC2349 - TFTP Timeout Interval and Transfer Size Options
-
-
-**/
-
-#ifndef __EFI_MTFTP4_IMPL_H__
-#define __EFI_MTFTP4_IMPL_H__
-
+/** @file\r
+\r
+Copyright (c) 2006 - 2007, 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
+  Mtftp4Impl.h\r
+\r
+Abstract:\r
+\r
+ Mtftp4 Implementation, it supports the following RFCs:\r
+   RFC1350 - THE TFTP PROTOCOL (REVISION 2)\r
+   RFC2090 - TFTP Multicast Option\r
+   RFC2347 - TFTP Option Extension\r
+   RFC2348 - TFTP Blocksize Option\r
+   RFC2349 - TFTP Timeout Interval and Transfer Size Options\r
+\r
+\r
+**/\r
+\r
+#ifndef __EFI_MTFTP4_IMPL_H__\r
+#define __EFI_MTFTP4_IMPL_H__\r
+\r
 #include <PiDxe.h>\r
 \r
 #include <Protocol/Udp4.h>\r
@@ -37,142 +37,142 @@ Abstract:
 #include <Library/UefiDriverEntryPoint.h>\r
 #include <Library/UefiBootServicesTableLib.h>\r
 #include <Library/UefiLib.h>\r
-#include <Library/BaseLib.h>
-#include <Library/UdpIoLib.h>
-#include <Library/MemoryAllocationLib.h>
-#include <Library/BaseMemoryLib.h>
-
-typedef struct _MTFTP4_SERVICE  MTFTP4_SERVICE;
-typedef struct _MTFTP4_PROTOCOL MTFTP4_PROTOCOL;
-
-#include "Mtftp4Driver.h"
-#include "Mtftp4Option.h"
-#include "Mtftp4Support.h"
-
-enum {
-  MTFTP4_SERVICE_SIGNATURE   = EFI_SIGNATURE_32 ('T', 'F', 'T', 'P'),
-  MTFTP4_PROTOCOL_SIGNATURE  = EFI_SIGNATURE_32 ('t', 'f', 't', 'p'),
-
-  MTFTP4_DEFAULT_SERVER_PORT = 69,
-  MTFTP4_DEFAULT_TIMEOUT     = 3,
-  MTFTP4_DEFAULT_RETRY       = 5,
-  MTFTP4_DEFAULT_BLKSIZE     = 512,
-  MTFTP4_TIME_TO_GETMAP      = 5,
-
-  MTFTP4_STATE_UNCONFIGED    = 0,
-  MTFTP4_STATE_CONFIGED,
-  MTFTP4_STATE_DESTORY
-};
-
-struct _MTFTP4_SERVICE {
-  UINT32                        Signature;
-  EFI_SERVICE_BINDING_PROTOCOL  ServiceBinding;
-
-  BOOLEAN                       InDestory;
-
-  UINT16                        ChildrenNum;
-  NET_LIST_ENTRY                Children;
-
-  EFI_EVENT                     Timer;  // Ticking timer for all the MTFTP clients
-  EFI_EVENT                     TimerToGetMap;
-
-  EFI_HANDLE                    Controller;
-  EFI_HANDLE                    Image;
-
-  //
-  // This UDP child is used to keep the connection between the UDP
-  // and MTFTP, so MTFTP will be notified when UDP is uninstalled.
-  //
-  UDP_IO_PORT                   *ConnectUdp;
-};
-
-typedef struct {
-  EFI_MTFTP4_PACKET             **Packet;
-  UINT32                        *PacketLen;
-  EFI_STATUS                    Status;
-} MTFTP4_GETINFO_STATE;
-
-struct _MTFTP4_PROTOCOL {
-  UINT32                        Signature;
-  NET_LIST_ENTRY                Link;
-  EFI_MTFTP4_PROTOCOL           Mtftp4;
-
-  INTN                          State;
-  BOOLEAN                       Indestory;
-
-  MTFTP4_SERVICE                *Service;
-  EFI_HANDLE                    Handle;
-
-  EFI_MTFTP4_CONFIG_DATA        Config;
-
-  //
-  // Operation parameters: token and requested options.
-  //
-  EFI_MTFTP4_TOKEN              *Token;
-  MTFTP4_OPTION                 RequestOption;
-  UINT16                        Operation;
-
-  //
-  // Blocks is a list of MTFTP4_BLOCK_RANGE which contains
-  // holes in the file
-  //
-  UINT16                        BlkSize;
-  UINT16                        LastBlock;
-  NET_LIST_ENTRY                Blocks;
-
-  //
-  // The server's communication end point: IP and two ports. one for
-  // initial request, one for its selected port.
-  //
-  IP4_ADDR                      ServerIp;
-  UINT16                        ListeningPort;
-  UINT16                        ConnectedPort;
-  IP4_ADDR                      Gateway;
-  UDP_IO_PORT                   *UnicastPort;
-
-  //
-  // Timeout and retransmit status
-  //
-  NET_BUF                       *LastPacket;
-  UINT32                        PacketToLive;
-  UINT32                        CurRetry;
-  UINT32                        MaxRetry;
-  UINT32                        Timeout;
-
-  //
-  // Parameter used by RRQ's multicast download.
-  //
-  IP4_ADDR                      McastIp;
-  UINT16                        McastPort;
-  BOOLEAN                       Master;
-  UDP_IO_PORT                   *McastUdpPort;
-
-  MTFTP4_GETINFO_STATE          GetInfoState;
-};
-
-VOID
-Mtftp4CleanOperation (
-  IN MTFTP4_PROTOCOL            *Instance,
-  IN EFI_STATUS                 Result
-  );
-
-EFI_STATUS
-Mtftp4WrqStart (
-  IN MTFTP4_PROTOCOL            *Instance,
-  IN UINT16                     Operation
-  );
-
-EFI_STATUS
-Mtftp4RrqStart (
-  IN MTFTP4_PROTOCOL            *Instance,
-  IN UINT16                     Operation
-  );
-
-#define MTFTP4_SERVICE_FROM_THIS(a)   \
-  CR (a, MTFTP4_SERVICE, ServiceBinding, MTFTP4_SERVICE_SIGNATURE)
-
-#define MTFTP4_PROTOCOL_FROM_THIS(a)  \
-  CR (a, MTFTP4_PROTOCOL, Mtftp4, MTFTP4_PROTOCOL_SIGNATURE)
-
-extern EFI_MTFTP4_PROTOCOL  gMtftp4ProtocolTemplate;
-#endif
+#include <Library/BaseLib.h>\r
+#include <Library/UdpIoLib.h>\r
+#include <Library/MemoryAllocationLib.h>\r
+#include <Library/BaseMemoryLib.h>\r
+\r
+typedef struct _MTFTP4_SERVICE  MTFTP4_SERVICE;\r
+typedef struct _MTFTP4_PROTOCOL MTFTP4_PROTOCOL;\r
+\r
+#include "Mtftp4Driver.h"\r
+#include "Mtftp4Option.h"\r
+#include "Mtftp4Support.h"\r
+\r
+enum {\r
+  MTFTP4_SERVICE_SIGNATURE   = EFI_SIGNATURE_32 ('T', 'F', 'T', 'P'),\r
+  MTFTP4_PROTOCOL_SIGNATURE  = EFI_SIGNATURE_32 ('t', 'f', 't', 'p'),\r
+\r
+  MTFTP4_DEFAULT_SERVER_PORT = 69,\r
+  MTFTP4_DEFAULT_TIMEOUT     = 3,\r
+  MTFTP4_DEFAULT_RETRY       = 5,\r
+  MTFTP4_DEFAULT_BLKSIZE     = 512,\r
+  MTFTP4_TIME_TO_GETMAP      = 5,\r
+\r
+  MTFTP4_STATE_UNCONFIGED    = 0,\r
+  MTFTP4_STATE_CONFIGED,\r
+  MTFTP4_STATE_DESTORY\r
+};\r
+\r
+struct _MTFTP4_SERVICE {\r
+  UINT32                        Signature;\r
+  EFI_SERVICE_BINDING_PROTOCOL  ServiceBinding;\r
+\r
+  BOOLEAN                       InDestory;\r
+\r
+  UINT16                        ChildrenNum;\r
+  NET_LIST_ENTRY                Children;\r
+\r
+  EFI_EVENT                     Timer;  // Ticking timer for all the MTFTP clients\r
+  EFI_EVENT                     TimerToGetMap;\r
+\r
+  EFI_HANDLE                    Controller;\r
+  EFI_HANDLE                    Image;\r
+\r
+  //\r
+  // This UDP child is used to keep the connection between the UDP\r
+  // and MTFTP, so MTFTP will be notified when UDP is uninstalled.\r
+  //\r
+  UDP_IO_PORT                   *ConnectUdp;\r
+};\r
+\r
+typedef struct {\r
+  EFI_MTFTP4_PACKET             **Packet;\r
+  UINT32                        *PacketLen;\r
+  EFI_STATUS                    Status;\r
+} MTFTP4_GETINFO_STATE;\r
+\r
+struct _MTFTP4_PROTOCOL {\r
+  UINT32                        Signature;\r
+  NET_LIST_ENTRY                Link;\r
+  EFI_MTFTP4_PROTOCOL           Mtftp4;\r
+\r
+  INTN                          State;\r
+  BOOLEAN                       Indestory;\r
+\r
+  MTFTP4_SERVICE                *Service;\r
+  EFI_HANDLE                    Handle;\r
+\r
+  EFI_MTFTP4_CONFIG_DATA        Config;\r
+\r
+  //\r
+  // Operation parameters: token and requested options.\r
+  //\r
+  EFI_MTFTP4_TOKEN              *Token;\r
+  MTFTP4_OPTION                 RequestOption;\r
+  UINT16                        Operation;\r
+\r
+  //\r
+  // Blocks is a list of MTFTP4_BLOCK_RANGE which contains\r
+  // holes in the file\r
+  //\r
+  UINT16                        BlkSize;\r
+  UINT16                        LastBlock;\r
+  NET_LIST_ENTRY                Blocks;\r
+\r
+  //\r
+  // The server's communication end point: IP and two ports. one for\r
+  // initial request, one for its selected port.\r
+  //\r
+  IP4_ADDR                      ServerIp;\r
+  UINT16                        ListeningPort;\r
+  UINT16                        ConnectedPort;\r
+  IP4_ADDR                      Gateway;\r
+  UDP_IO_PORT                   *UnicastPort;\r
+\r
+  //\r
+  // Timeout and retransmit status\r
+  //\r
+  NET_BUF                       *LastPacket;\r
+  UINT32                        PacketToLive;\r
+  UINT32                        CurRetry;\r
+  UINT32                        MaxRetry;\r
+  UINT32                        Timeout;\r
+\r
+  //\r
+  // Parameter used by RRQ's multicast download.\r
+  //\r
+  IP4_ADDR                      McastIp;\r
+  UINT16                        McastPort;\r
+  BOOLEAN                       Master;\r
+  UDP_IO_PORT                   *McastUdpPort;\r
+\r
+  MTFTP4_GETINFO_STATE          GetInfoState;\r
+};\r
+\r
+VOID\r
+Mtftp4CleanOperation (\r
+  IN MTFTP4_PROTOCOL            *Instance,\r
+  IN EFI_STATUS                 Result\r
+  );\r
+\r
+EFI_STATUS\r
+Mtftp4WrqStart (\r
+  IN MTFTP4_PROTOCOL            *Instance,\r
+  IN UINT16                     Operation\r
+  );\r
+\r
+EFI_STATUS\r
+Mtftp4RrqStart (\r
+  IN MTFTP4_PROTOCOL            *Instance,\r
+  IN UINT16                     Operation\r
+  );\r
+\r
+#define MTFTP4_SERVICE_FROM_THIS(a)   \\r
+  CR (a, MTFTP4_SERVICE, ServiceBinding, MTFTP4_SERVICE_SIGNATURE)\r
+\r
+#define MTFTP4_PROTOCOL_FROM_THIS(a)  \\r
+  CR (a, MTFTP4_PROTOCOL, Mtftp4, MTFTP4_PROTOCOL_SIGNATURE)\r
+\r
+extern EFI_MTFTP4_PROTOCOL  gMtftp4ProtocolTemplate;\r
+#endif\r