MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Impl.h

   1 /** @file
   2
   3   Mtftp4 Implementation.
   4
   5   Mtftp4 Implementation, it supports the following RFCs:
   6   RFC1350 - THE TFTP PROTOCOL (REVISION 2)
   7   RFC2090 - TFTP Multicast Option
   8   RFC2347 - TFTP Option Extension
   9   RFC2348 - TFTP Blocksize Option
  10   RFC2349 - TFTP Timeout Interval and Transfer Size Options
  11   RFC7440 - TFTP Windowsize Option
  12
  13 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
  14 This program and the accompanying materials
  15 are licensed and made available under the terms and conditions of the BSD License
  16 which accompanies this distribution.  The full text of the license may be found at
  17 http://opensource.org/licenses/bsd-license.php<BR>
  18
  19 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  20 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  21
  22 **/
  23
  24
  25 #ifndef __EFI_MTFTP4_IMPL_H__
  26 #define __EFI_MTFTP4_IMPL_H__
  27
  28 #include <Uefi.h>
  29
  30 #include <Protocol/Udp4.h>
  31 #include <Protocol/Mtftp4.h>
  32
  33 #include <Library/DebugLib.h>
  34 #include <Library/BaseMemoryLib.h>
  35 #include <Library/MemoryAllocationLib.h>
  36 #include <Library/UefiBootServicesTableLib.h>
  37 #include <Library/UdpIoLib.h>
  38 #include <Library/PrintLib.h>
  39
  40 extern EFI_MTFTP4_PROTOCOL  gMtftp4ProtocolTemplate;
  41
  42 typedef struct _MTFTP4_SERVICE  MTFTP4_SERVICE;
  43 typedef struct _MTFTP4_PROTOCOL MTFTP4_PROTOCOL;
  44
  45 #include "Mtftp4Driver.h"
  46 #include "Mtftp4Option.h"
  47 #include "Mtftp4Support.h"
  48
  49
  50 ///
  51 /// Some constant value of Mtftp service.
  52 ///
  53 #define MTFTP4_SERVICE_SIGNATURE    SIGNATURE_32 ('T', 'F', 'T', 'P')
  54 #define MTFTP4_PROTOCOL_SIGNATURE   SIGNATURE_32 ('t', 'f', 't', 'p')
  55
  56 #define MTFTP4_DEFAULT_SERVER_PORT  69
  57 #define MTFTP4_DEFAULT_TIMEOUT      3
  58 #define MTFTP4_DEFAULT_RETRY        5
  59 #define MTFTP4_DEFAULT_BLKSIZE      512
  60 #define MTFTP4_DEFAULT_WINDOWSIZE   1
  61 #define MTFTP4_TIME_TO_GETMAP       5
  62
  63 #define MTFTP4_STATE_UNCONFIGED     0
  64 #define MTFTP4_STATE_CONFIGED       1
  65 #define MTFTP4_STATE_DESTROY        2
  66
  67 ///
  68 /// Mtftp service block
  69 ///
  70 struct _MTFTP4_SERVICE {
  71   UINT32                        Signature;
  72   EFI_SERVICE_BINDING_PROTOCOL  ServiceBinding;
  73
  74   UINT16                        ChildrenNum;
  75   LIST_ENTRY                    Children;
  76
  77   EFI_EVENT                     Timer;  ///< Ticking timer for all the MTFTP clients to handle the packet timeout case.
  78   EFI_EVENT                     TimerNotifyLevel; ///< Ticking timer for all the MTFTP clients to calculate the packet live time.
  79   EFI_EVENT                     TimerToGetMap;
  80
  81   EFI_HANDLE                    Controller;
  82   EFI_HANDLE                    Image;
  83
  84   //
  85   // This UDP child is used to keep the connection between the UDP
  86   // and MTFTP, so MTFTP will be notified when UDP is uninstalled.
  87   //
  88   UDP_IO                        *ConnectUdp;
  89 };
  90
  91
  92 typedef struct {
  93   EFI_MTFTP4_PACKET             **Packet;
  94   UINT32                        *PacketLen;
  95   EFI_STATUS                    Status;
  96 } MTFTP4_GETINFO_STATE;
  97
  98 struct _MTFTP4_PROTOCOL {
  99   UINT32                        Signature;
 100   LIST_ENTRY                    Link;
 101   EFI_MTFTP4_PROTOCOL           Mtftp4;
 102
 103   INTN                          State;
 104   BOOLEAN                       InDestroy;
 105
 106   MTFTP4_SERVICE                *Service;
 107   EFI_HANDLE                    Handle;
 108
 109   EFI_MTFTP4_CONFIG_DATA        Config;
 110
 111   //
 112   // Operation parameters: token and requested options.
 113   //
 114   EFI_MTFTP4_TOKEN              *Token;
 115   MTFTP4_OPTION                 RequestOption;
 116   UINT16                        Operation;
 117
 118   //
 119   // Blocks is a list of MTFTP4_BLOCK_RANGE which contains
 120   // holes in the file
 121   //
 122   UINT16                        BlkSize;
 123   UINT16                        LastBlock;
 124   LIST_ENTRY                    Blocks;
 125
 126   UINT16                        WindowSize;
 127
 128   //
 129   // Record the total received and saved block number.
 130   //
 131   UINT64                        TotalBlock;
 132
 133   //
 134   // Record the acked block number.
 135   //
 136   UINT64                        AckedBlock;
 137
 138   //
 139   // The server's communication end point: IP and two ports. one for
 140   // initial request, one for its selected port.
 141   //
 142   IP4_ADDR                      ServerIp;
 143   UINT16                        ListeningPort;
 144   UINT16                        ConnectedPort;
 145   IP4_ADDR                      Gateway;
 146   UDP_IO                        *UnicastPort;
 147
 148   //
 149   // Timeout and retransmit status
 150   //
 151   NET_BUF                       *LastPacket;
 152   UINT32                        PacketToLive;
 153   BOOLEAN                       HasTimeout;
 154   UINT32                        CurRetry;
 155   UINT32                        MaxRetry;
 156   UINT32                        Timeout;
 157
 158   //
 159   // Parameter used by RRQ's multicast download.
 160   //
 161   IP4_ADDR                      McastIp;
 162   UINT16                        McastPort;
 163   BOOLEAN                       Master;
 164   UDP_IO                        *McastUdpPort;
 165 };
 166
 167 typedef struct {
 168   EFI_SERVICE_BINDING_PROTOCOL  *ServiceBinding;
 169   UINTN                         NumberOfChildren;
 170   EFI_HANDLE                    *ChildHandleBuffer;
 171 } MTFTP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT;
 172
 173 /**
 174   Clean up the MTFTP session to get ready for new operation.
 175
 176   @param  Instance               The MTFTP session to clean up
 177   @param  Result                 The result to return to the caller who initiated
 178                                  the operation.
 179 **/
 180 VOID
 181 Mtftp4CleanOperation (
 182   IN OUT MTFTP4_PROTOCOL        *Instance,
 183   IN     EFI_STATUS             Result
 184   );
 185
 186 /**
 187   Start the MTFTP session for upload.
 188
 189   It will first init some states, then send the WRQ request packet,
 190   and start receiving the packet.
 191
 192   @param  Instance              The MTFTP session
 193   @param  Operation             Redundant parameter, which is always
 194                                 EFI_MTFTP4_OPCODE_WRQ here.
 195
 196   @retval EFI_SUCCESS           The upload process has been started.
 197   @retval Others                Failed to start the upload.
 198
 199 **/
 200 EFI_STATUS
 201 Mtftp4WrqStart (
 202   IN MTFTP4_PROTOCOL        *Instance,
 203   IN UINT16                 Operation
 204   );
 205
 206 /**
 207   Start the MTFTP session to download.
 208
 209   It will first initialize some of the internal states then build and send a RRQ
 210   reqeuest packet, at last, it will start receive for the downloading.
 211
 212   @param  Instance              The Mtftp session
 213   @param  Operation             The MTFTP opcode, it may be a EFI_MTFTP4_OPCODE_RRQ
 214                                 or EFI_MTFTP4_OPCODE_DIR.
 215
 216   @retval EFI_SUCCESS           The mtftp download session is started.
 217   @retval Others                Failed to start downloading.
 218
 219 **/
 220 EFI_STATUS
 221 Mtftp4RrqStart (
 222   IN MTFTP4_PROTOCOL        *Instance,
 223   IN UINT16                 Operation
 224   );
 225
 226 #define MTFTP4_SERVICE_FROM_THIS(a)   \
 227   CR (a, MTFTP4_SERVICE, ServiceBinding, MTFTP4_SERVICE_SIGNATURE)
 228
 229 #define MTFTP4_PROTOCOL_FROM_THIS(a)  \
 230   CR (a, MTFTP4_PROTOCOL, Mtftp4, MTFTP4_PROTOCOL_SIGNATURE)
 231
 232 #endif