IpIoLib.h

Go to the documentation of this file.

 
#ifndef _IP_IO_H_
#define _IP_IO_H_
 
#include <Protocol/Ip4.h>
#include <Protocol/Ip6.h>
 
#include <Library/NetLib.h>
 
//
// type and code define for ICMP protocol error
// from IP
//
#define ICMP_TYPE_UNREACH       3
#define ICMP_TYPE_TIMXCEED      11
#define ICMP_TYPE_PARAMPROB     12
#define ICMP_TYPE_SOURCEQUENCH  4
 
#define ICMP_CODE_UNREACH_NET           0
#define ICMP_CODE_UNREACH_HOST          1
#define ICMP_CODE_UNREACH_PROTOCOL      2
#define ICMP_CODE_UNREACH_PORT          3
#define ICMP_CODE_UNREACH_NEEDFRAG      4
#define ICMP_CODE_UNREACH_SRCFAIL       5
#define ICMP_CODE_UNREACH_NET_UNKNOWN   6
#define ICMP_CODE_UNREACH_HOST_UNKNOWN  7
#define ICMP_CODE_UNREACH_ISOLATED      8
#define ICMP_CODE_UNREACH_NET_PROHIB    9
#define ICMP_CODE_UNREACH_HOST_PROHIB   10
#define ICMP_CODE_UNREACH_TOSNET        11
#define ICMP_CODE_UNREACH_TOSHOST       12
 
#define EFI_IP4_HEADER_LEN(HdrPtr)  ((HdrPtr)->HeaderLength << 2)
 
#define ICMP_ERRLEN(IpHdr) \
  (sizeof(IP4_ICMP_HEAD) + EFI_IP4_HEADER_LEN(IpHdr) + 8)
 
#define NET_PROTO_HDR(Buf, Type)  ((Type *) ((Buf)->BlockOp[0].Head))
 
extern EFI_IP4_CONFIG_DATA  mIp4IoDefaultIpConfigData;
extern EFI_IP6_CONFIG_DATA  mIp6IoDefaultIpConfigData;
 
 
#define  ICMP_ERR_UNREACH_NET       0
#define  ICMP_ERR_UNREACH_HOST      1
#define  ICMP_ERR_UNREACH_PROTOCOL  2
#define  ICMP_ERR_UNREACH_PORT      3
#define  ICMP_ERR_MSGSIZE           4
#define  ICMP_ERR_UNREACH_SRCFAIL   5
#define  ICMP_ERR_TIMXCEED_INTRANS  6
#define  ICMP_ERR_TIMXCEED_REASS    7
#define  ICMP_ERR_QUENCH            8
#define  ICMP_ERR_PARAMPROB         9
 
#define  ICMP6_ERR_UNREACH_NET           0
#define  ICMP6_ERR_UNREACH_HOST          1
#define  ICMP6_ERR_UNREACH_PROTOCOL      2
#define  ICMP6_ERR_UNREACH_PORT          3
#define  ICMP6_ERR_PACKAGE_TOOBIG        4
#define  ICMP6_ERR_TIMXCEED_HOPLIMIT     5
#define  ICMP6_ERR_TIMXCEED_REASS        6
#define  ICMP6_ERR_PARAMPROB_HEADER      7
#define  ICMP6_ERR_PARAMPROB_NEXHEADER   8
#define  ICMP6_ERR_PARAMPROB_IPV6OPTION  9
 
typedef struct {
  BOOLEAN    IsHard;
  BOOLEAN    Notify;
} ICMP_ERROR_INFO;
 
typedef union {
  EFI_IP4_COMPLETION_TOKEN    Ip4Token;
  EFI_IP6_COMPLETION_TOKEN    Ip6Token;
} IP_IO_IP_COMPLETION_TOKEN;
 
typedef union {
  EFI_IP4_TRANSMIT_DATA    Ip4TxData;
  EFI_IP6_TRANSMIT_DATA    Ip6TxData;
} IP_IO_IP_TX_DATA;
 
typedef union {
  EFI_IP4_RECEIVE_DATA    Ip4RxData;
  EFI_IP6_RECEIVE_DATA    Ip6RxData;
} IP_IO_IP_RX_DATA;
 
typedef union {
  EFI_IP4_OVERRIDE_DATA    Ip4OverrideData;
  EFI_IP6_OVERRIDE_DATA    Ip6OverrideData;
} IP_IO_OVERRIDE;
 
typedef union {
  EFI_IP4_CONFIG_DATA    Ip4CfgData;
  EFI_IP6_CONFIG_DATA    Ip6CfgData;
} IP_IO_IP_CONFIG_DATA;
 
typedef union {
  EFI_IP4_HEADER    *Ip4Hdr;
  EFI_IP6_HEADER    *Ip6Hdr;
} IP_IO_IP_HEADER;
 
typedef union {
  IP4_ADDR    SubnetMask;
  UINT8       PrefixLength;
} IP_IO_IP_MASK;
 
typedef union {
  EFI_IP4_PROTOCOL    *Ip4;
  EFI_IP6_PROTOCOL    *Ip6;
} IP_IO_IP_PROTOCOL;
 
typedef struct _EFI_NET_SESSION_DATA {
  EFI_IP_ADDRESS     Source;        
  EFI_IP_ADDRESS     Dest;          
  IP_IO_IP_HEADER    IpHdr;         
  UINT32             IpHdrLen;      
  UINT8              IpVersion;     
} EFI_NET_SESSION_DATA;
 
typedef
VOID
(EFIAPI *PKT_RCVD_NOTIFY)(
  IN EFI_STATUS           Status,
  IN UINT8                IcmpErr,
  IN EFI_NET_SESSION_DATA *NetSession,
  IN NET_BUF              *Pkt,
  IN VOID                 *Context
  );
 
typedef
VOID
(EFIAPI *PKT_SENT_NOTIFY)(
  IN EFI_STATUS        Status,
  IN VOID              *Context,
  IN IP_IO_IP_PROTOCOL Sender,
  IN VOID              *NotifyData
  );
 
typedef struct _IP_IO {
  LIST_ENTRY                   Entry;
 
  LIST_ENTRY                   IpList;
 
  EFI_HANDLE                   Controller;
  EFI_HANDLE                   Image;
  EFI_HANDLE                   ChildHandle;
  //
  // The IP instance consumed by this IP_IO
  //
  IP_IO_IP_PROTOCOL            Ip;
  BOOLEAN                      IsConfigured;
 
  UINT8                        Protocol;
 
  IP_IO_IP_COMPLETION_TOKEN    RcvToken;
 
  LIST_ENTRY                   PendingSndList;
 
  //
  // User interface used to get notify from IP_IO
  //
  VOID                         *RcvdContext;     
  VOID                         *SndContext;      
  PKT_RCVD_NOTIFY              PktRcvdNotify;    
  PKT_SENT_NOTIFY              PktSentNotify;    
  UINT8                        IpVersion;
  IP4_ADDR                     StationIp;
  IP4_ADDR                     SubnetMask;
} IP_IO;
 
typedef struct _IP_IO_OPEN_DATA {
  IP_IO_IP_CONFIG_DATA    IpConfigData;  
  VOID                    *RcvdContext;  
  VOID                    *SndContext;   
  PKT_RCVD_NOTIFY         PktRcvdNotify; 
  PKT_SENT_NOTIFY         PktSentNotify; 
} IP_IO_OPEN_DATA;
 
typedef struct _IP_IO_SEND_ENTRY {
  LIST_ENTRY                   Entry;
  IP_IO                        *IpIo;
  VOID                         *Context;
  VOID                         *NotifyData;
  IP_IO_IP_PROTOCOL            Ip;
  NET_BUF                      *Pkt;
  IP_IO_IP_COMPLETION_TOKEN    SndToken;
} IP_IO_SEND_ENTRY;
 
typedef struct _IP_IO_IP_INFO {
  EFI_IP_ADDRESS               Addr;
  IP_IO_IP_MASK                PreMask;
  LIST_ENTRY                   Entry;
  EFI_HANDLE                   ChildHandle;
  IP_IO_IP_PROTOCOL            Ip;
  IP_IO_IP_COMPLETION_TOKEN    DummyRcvToken;
  INTN                         RefCnt;
  UINT8                        IpVersion;
} IP_IO_IP_INFO;
 
IP_IO *
EFIAPI
IpIoCreate (
  IN EFI_HANDLE  Image,
  IN EFI_HANDLE  Controller,
  IN UINT8       IpVersion
  );
 
EFI_STATUS
EFIAPI
IpIoDestroy (
  IN OUT IP_IO  *IpIo
  );
 
EFI_STATUS
EFIAPI
IpIoStop (
  IN OUT IP_IO  *IpIo
  );
 
EFI_STATUS
EFIAPI
IpIoOpen (
  IN OUT IP_IO            *IpIo,
  IN     IP_IO_OPEN_DATA  *OpenData
  );
 
EFI_STATUS
EFIAPI
IpIoSend (
  IN OUT IP_IO           *IpIo,
  IN OUT NET_BUF         *Pkt,
  IN     IP_IO_IP_INFO   *Sender        OPTIONAL,
  IN     VOID            *Context       OPTIONAL,
  IN     VOID            *NotifyData    OPTIONAL,
  IN     EFI_IP_ADDRESS  *Dest          OPTIONAL,
  IN     IP_IO_OVERRIDE  *OverrideData  OPTIONAL
  );
 
VOID
EFIAPI
IpIoCancelTxToken (
  IN IP_IO  *IpIo,
  IN VOID   *Packet
  );
 
IP_IO_IP_INFO *
EFIAPI
IpIoAddIp (
  IN OUT IP_IO  *IpIo
  );
 
EFI_STATUS
EFIAPI
IpIoConfigIp (
  IN OUT IP_IO_IP_INFO  *IpInfo,
  IN OUT VOID           *IpConfigData OPTIONAL
  );
 
VOID
EFIAPI
IpIoRemoveIp (
  IN IP_IO          *IpIo,
  IN IP_IO_IP_INFO  *IpInfo
  );
 
IP_IO_IP_INFO *
EFIAPI
IpIoFindSender (
  IN OUT IP_IO           **IpIo,
  IN     UINT8           IpVersion,
  IN     EFI_IP_ADDRESS  *Src
  );
 
EFI_STATUS
EFIAPI
IpIoGetIcmpErrStatus (
  IN  UINT8    IcmpError,
  IN  UINT8    IpVersion,
  OUT BOOLEAN  *IsHard  OPTIONAL,
  OUT BOOLEAN  *Notify  OPTIONAL
  );
 
EFI_STATUS
EFIAPI
IpIoRefreshNeighbor (
  IN IP_IO           *IpIo,
  IN EFI_IP_ADDRESS  *Neighbor,
  IN UINT32          Timeout
  );
 
#endif