Mtftp6Impl.h

Go to the documentation of this file.

 
#ifndef __EFI_MTFTP6_IMPL_H__
#define __EFI_MTFTP6_IMPL_H__
 
#include <Uefi.h>
 
#include <Protocol/Udp6.h>
#include <Protocol/Mtftp6.h>
#include <Protocol/ServiceBinding.h>
#include <Protocol/DriverBinding.h>
 
#include <Library/DebugLib.h>
#include <Library/UefiDriverEntryPoint.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiLib.h>
#include <Library/BaseLib.h>
#include <Library/NetLib.h>
#include <Library/PrintLib.h>
 
typedef struct _MTFTP6_SERVICE   MTFTP6_SERVICE;
typedef struct _MTFTP6_INSTANCE  MTFTP6_INSTANCE;
 
#include "Mtftp6Driver.h"
#include "Mtftp6Option.h"
#include "Mtftp6Support.h"
 
#define MTFTP6_SERVICE_SIGNATURE   SIGNATURE_32 ('M', 'F', '6', 'S')
#define MTFTP6_INSTANCE_SIGNATURE  SIGNATURE_32 ('M', 'F', '6', 'I')
 
#define MTFTP6_DEFAULT_SERVER_CMD_PORT  69
#define MTFTP6_DEFAULT_TIMEOUT          3
#define MTFTP6_GET_MAPPING_TIMEOUT      3
#define MTFTP6_DEFAULT_MAX_RETRY        5
#define MTFTP6_DEFAULT_BLK_SIZE         512
#define MTFTP6_DEFAULT_WINDOWSIZE       1
#define MTFTP6_TICK_PER_SECOND          10000000U
 
#define MTFTP6_SERVICE_FROM_THIS(a)   CR (a, MTFTP6_SERVICE, ServiceBinding, MTFTP6_SERVICE_SIGNATURE)
#define MTFTP6_INSTANCE_FROM_THIS(a)  CR (a, MTFTP6_INSTANCE, Mtftp6, MTFTP6_INSTANCE_SIGNATURE)
 
extern EFI_MTFTP6_PROTOCOL  gMtftp6ProtocolTemplate;
 
typedef struct _MTFTP6_GETINFO_CONTEXT {
  EFI_MTFTP6_PACKET    **Packet;
  UINT32               *PacketLen;
  EFI_STATUS           Status;
} MTFTP6_GETINFO_CONTEXT;
 
//
// Control block for MTFTP6 instance, it's per configuration data.
//
struct _MTFTP6_INSTANCE {
  UINT32                    Signature;
  EFI_HANDLE                Handle;
  LIST_ENTRY                Link;
  EFI_MTFTP6_PROTOCOL       Mtftp6;
  MTFTP6_SERVICE            *Service;
  EFI_MTFTP6_CONFIG_DATA    *Config;
 
  EFI_MTFTP6_TOKEN          *Token;
  MTFTP6_EXT_OPTION_INFO    ExtInfo;
 
  UINT16                    BlkSize;
  UINT16                    LastBlk;
  LIST_ENTRY                BlkList;
 
  UINT16                    Operation;
 
  UINT16                    WindowSize;
 
  //
  // Record the total received and saved block number.
  //
  UINT64                    TotalBlock;
 
  //
  // Record the acked block number.
  //
  UINT64                    AckedBlock;
 
  EFI_IPv6_ADDRESS          ServerIp;
  UINT16                    ServerCmdPort;
  UINT16                    ServerDataPort;
  UDP_IO                    *UdpIo;
 
  EFI_IPv6_ADDRESS          McastIp;
  UINT16                    McastPort;
  UDP_IO                    *McastUdpIo;
 
  NET_BUF                   *LastPacket;
  UINT32                    CurRetry;
  UINT32                    MaxRetry;
  UINT32                    PacketToLive;
  UINT32                    Timeout;
 
  EFI_TPL                   OldTpl;
  BOOLEAN                   IsTransmitted;
  BOOLEAN                   IsMaster;
  BOOLEAN                   InDestroy;
};
 
//
// Control block for MTFTP6 service, it's per Nic handle.
//
struct _MTFTP6_SERVICE {
  UINT32                          Signature;
  EFI_SERVICE_BINDING_PROTOCOL    ServiceBinding;
  EFI_HANDLE                      Controller;
  EFI_HANDLE                      Image;
 
  UINT16                          ChildrenNum;
  LIST_ENTRY                      Children;
  //
  // It is used to be as internal calculagraph for all instances.
  //
  EFI_EVENT                       Timer;
  //
  // It is used to maintain the parent-child relationship between
  // mtftp driver and udp driver.
  //
  UDP_IO                          *DummyUdpIo;
};
 
typedef struct {
  EFI_SERVICE_BINDING_PROTOCOL    *ServiceBinding;
  UINTN                           NumberOfChildren;
  EFI_HANDLE                      *ChildHandleBuffer;
} MTFTP6_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT;
 
EFI_STATUS
EFIAPI
EfiMtftp6GetModeData (
  IN  EFI_MTFTP6_PROTOCOL   *This,
  OUT EFI_MTFTP6_MODE_DATA  *ModeData
  );
 
EFI_STATUS
EFIAPI
EfiMtftp6Configure (
  IN EFI_MTFTP6_PROTOCOL     *This,
  IN EFI_MTFTP6_CONFIG_DATA  *MtftpConfigData     OPTIONAL
  );
 
EFI_STATUS
EFIAPI
EfiMtftp6GetInfo (
  IN  EFI_MTFTP6_PROTOCOL       *This,
  IN  EFI_MTFTP6_OVERRIDE_DATA  *OverrideData         OPTIONAL,
  IN  UINT8                     *Filename,
  IN  UINT8                     *ModeStr              OPTIONAL,
  IN  UINT8                     OptionCount,
  IN  EFI_MTFTP6_OPTION         *OptionList           OPTIONAL,
  OUT UINT32                    *PacketLength,
  OUT EFI_MTFTP6_PACKET         **Packet              OPTIONAL
  );
 
EFI_STATUS
EFIAPI
EfiMtftp6ParseOptions (
  IN     EFI_MTFTP6_PROTOCOL  *This,
  IN     UINT32               PacketLen,
  IN     EFI_MTFTP6_PACKET    *Packet,
  OUT    UINT32               *OptionCount,
  OUT    EFI_MTFTP6_OPTION    **OptionList          OPTIONAL
  );
 
EFI_STATUS
EFIAPI
EfiMtftp6ReadFile (
  IN EFI_MTFTP6_PROTOCOL  *This,
  IN EFI_MTFTP6_TOKEN     *Token
  );
 
EFI_STATUS
EFIAPI
EfiMtftp6WriteFile (
  IN EFI_MTFTP6_PROTOCOL  *This,
  IN EFI_MTFTP6_TOKEN     *Token
  );
 
EFI_STATUS
EFIAPI
EfiMtftp6ReadDirectory (
  IN EFI_MTFTP6_PROTOCOL  *This,
  IN EFI_MTFTP6_TOKEN     *Token
  );
 
EFI_STATUS
EFIAPI
EfiMtftp6Poll (
  IN EFI_MTFTP6_PROTOCOL  *This
  );
 
#endif