UdpIoLib.h

Go to the documentation of this file.

 
#ifndef _UDP_IO_H_
#define _UDP_IO_H_
 
#include <Protocol/Udp4.h>
#include <Protocol/Udp6.h>
 
#include <Library/NetLib.h>
 
typedef struct _UDP_IO UDP_IO;
 
 
#define UDP_IO_RX_SIGNATURE  SIGNATURE_32 ('U', 'D', 'P', 'R')
#define UDP_IO_TX_SIGNATURE  SIGNATURE_32 ('U', 'D', 'P', 'T')
#define UDP_IO_SIGNATURE     SIGNATURE_32 ('U', 'D', 'P', 'I')
 
#define UDP_IO_UDP4_VERSION  4
#define UDP_IO_UDP6_VERSION  6
 
typedef struct {
  EFI_IP_ADDRESS    LocalAddr;
  UINT16            LocalPort;
  EFI_IP_ADDRESS    RemoteAddr;
  UINT16            RemotePort;
} UDP_END_POINT;
 
typedef
VOID
(EFIAPI *UDP_IO_CALLBACK)(
  IN NET_BUF                *Packet,
  IN UDP_END_POINT          *EndPoint,
  IN EFI_STATUS             IoStatus,
  IN VOID                   *Context
  );
 
typedef union {
  EFI_UDP4_COMPLETION_TOKEN    Udp4;
  EFI_UDP6_COMPLETION_TOKEN    Udp6;
} UDP_COMPLETION_TOKEN;
 
typedef struct {
  UINT32                  Signature;
  UDP_IO                  *UdpIo;
 
  UDP_IO_CALLBACK         CallBack;
  VOID                    *Context;
  UINT32                  HeadLen;
 
  UDP_COMPLETION_TOKEN    Token;
} UDP_RX_TOKEN;
 
 
typedef union {
  EFI_UDP4_SESSION_DATA    Udp4;
  EFI_UDP6_SESSION_DATA    Udp6;
} UDP_SESSION_DATA;
 
typedef union {
  EFI_UDP4_TRANSMIT_DATA    Udp4;
  EFI_UDP6_TRANSMIT_DATA    Udp6;
} UDP_TRANSMIT_DATA;
 
typedef struct {
  UINT32                  Signature;
  LIST_ENTRY              Link;
  UDP_IO                  *UdpIo;
  UDP_IO_CALLBACK         CallBack;
  NET_BUF                 *Packet;
  VOID                    *Context;
  EFI_IPv4_ADDRESS        Gateway;
  UDP_SESSION_DATA        Session;
  UDP_COMPLETION_TOKEN    Token;
  UDP_TRANSMIT_DATA       Data;
} UDP_TX_TOKEN;
 
struct _UDP_IO {
  UINT32                     Signature;
  LIST_ENTRY                 Link;
  INTN                       RefCnt;
  UINT8                      UdpVersion;
 
  //
  // Handle used to create/destroy UDP child
  //
  EFI_HANDLE                 Controller;
  EFI_HANDLE                 Image;
  EFI_HANDLE                 UdpHandle;
 
  EFI_SIMPLE_NETWORK_MODE    SnpMode;
 
  LIST_ENTRY                 SentDatagram;  
  UDP_RX_TOKEN               *RecvRequest;
 
  union {
    EFI_UDP4_PROTOCOL    *Udp4;
    EFI_UDP6_PROTOCOL    *Udp6;
  } Protocol;
 
  union {
    EFI_UDP4_CONFIG_DATA    Udp4;
    EFI_UDP6_CONFIG_DATA    Udp6;
  } Config;
};
 
typedef
EFI_STATUS
(EFIAPI *UDP_IO_CONFIG)(
  IN UDP_IO                 *UdpIo,
  IN VOID                   *Context
  );
 
typedef
BOOLEAN
(EFIAPI *UDP_IO_TO_CANCEL)(
  IN UDP_TX_TOKEN           *Token,
  IN VOID                   *Context
  );
 
VOID
EFIAPI
UdpIoCancelDgrams (
  IN UDP_IO            *UdpIo,
  IN EFI_STATUS        IoStatus,
  IN UDP_IO_TO_CANCEL  ToCancel         OPTIONAL,
  IN VOID              *Context         OPTIONAL
  );
 
UDP_IO *
EFIAPI
UdpIoCreateIo (
  IN  EFI_HANDLE     Controller,
  IN  EFI_HANDLE     ImageHandle,
  IN  UDP_IO_CONFIG  Configure,
  IN  UINT8          UdpVersion,
  IN  VOID           *Context
  );
 
EFI_STATUS
EFIAPI
UdpIoFreeIo (
  IN  UDP_IO  *UdpIo
  );
 
VOID
EFIAPI
UdpIoCleanIo (
  IN  UDP_IO  *UdpIo
  );
 
EFI_STATUS
EFIAPI
UdpIoSendDatagram (
  IN  UDP_IO           *UdpIo,
  IN  NET_BUF          *Packet,
  IN  UDP_END_POINT    *EndPoint OPTIONAL,
  IN  EFI_IP_ADDRESS   *Gateway  OPTIONAL,
  IN  UDP_IO_CALLBACK  CallBack,
  IN  VOID             *Context
  );
 
VOID
EFIAPI
UdpIoCancelSentDatagram (
  IN  UDP_IO   *UdpIo,
  IN  NET_BUF  *Packet
  );
 
EFI_STATUS
EFIAPI
UdpIoRecvDatagram (
  IN  UDP_IO           *UdpIo,
  IN  UDP_IO_CALLBACK  CallBack,
  IN  VOID             *Context,
  IN  UINT32           HeadLen
  );
 
#endif