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