Ip4Common.h

Go to the documentation of this file.

 
#ifndef __EFI_IP4_COMMON_H__
#define __EFI_IP4_COMMON_H__
 
typedef struct _IP4_INTERFACE  IP4_INTERFACE;
typedef struct _IP4_PROTOCOL   IP4_PROTOCOL;
typedef struct _IP4_SERVICE    IP4_SERVICE;
 
#define IP4_ETHER_PROTO  0x0800
 
//
// The packet is received as link level broadcast/multicast/promiscuous.
//
#define IP4_LINK_BROADCAST  0x00000001
#define IP4_LINK_MULTICAST  0x00000002
#define IP4_LINK_PROMISC    0x00000004
 
//
// IP4 address cast type classification. Keep it true that any
// type bigger than or equal to LOCAL_BROADCAST is broadcast.
//
#define IP4_PROMISCUOUS       1
#define IP4_LOCAL_HOST        2
#define IP4_MULTICAST         3
#define IP4_LOCAL_BROADCAST   4  // Destination is 255.255.255.255
#define IP4_SUBNET_BROADCAST  5
#define IP4_NET_BROADCAST     6
 
//
// IP4 header flags
//
#define IP4_HEAD_DF_MASK      0x4000
#define IP4_HEAD_MF_MASK      0x2000
#define IP4_HEAD_OFFSET_MASK  0x1fff
 
#define IP4_ALLZERO_ADDRESS    0x00000000u
#define IP4_ALLONE_ADDRESS     0xFFFFFFFFu
#define IP4_ALLSYSTEM_ADDRESS  0xE0000001u
#define IP4_ALLROUTER_ADDRESS  0xE0000002u
 
#define IP4_HEAD_FRAGMENT_FIELD(Df, Mf, Offset) \
    ((UINT16)(((Df) ? IP4_HEAD_DF_MASK : 0) | ((Mf) ? IP4_HEAD_MF_MASK : 0) | (((Offset) >> 3) & IP4_HEAD_OFFSET_MASK)))
 
#define IP4_LAST_FRAGMENT(FragmentField)  \
          (((FragmentField) & IP4_HEAD_MF_MASK) == 0)
 
#define IP4_FIRST_FRAGMENT(FragmentField) \
          ((BOOLEAN)(((FragmentField) & IP4_HEAD_OFFSET_MASK) == 0))
 
#define IP4_DO_NOT_FRAGMENT(FragmentField) \
          ((BOOLEAN)(((FragmentField) & IP4_HEAD_DF_MASK) == IP4_HEAD_DF_MASK))
 
#define IP4_IS_BROADCAST(CastType)  ((CastType) >= IP4_LOCAL_BROADCAST)
 
#define IP4_US_TO_SEC(Us)  (((Us) + 999999) / 1000000)
 
INTN
Ip4GetNetCast (
  IN  IP4_ADDR       IpAddr,
  IN  IP4_INTERFACE  *IpIf
  );
 
INTN
Ip4GetHostCast (
  IN  IP4_SERVICE  *IpSb,
  IN  IP4_ADDR     Dst,
  IN  IP4_ADDR     Src
  );
 
IP4_INTERFACE *
Ip4FindInterface (
  IN IP4_SERVICE  *IpSb,
  IN IP4_ADDR     Ip
  );
 
IP4_INTERFACE *
Ip4FindNet (
  IN IP4_SERVICE  *IpSb,
  IN IP4_ADDR     Ip
  );
 
IP4_INTERFACE *
Ip4FindStationAddress (
  IN IP4_SERVICE  *IpSb,
  IN IP4_ADDR     Ip,
  IN IP4_ADDR     Netmask
  );
 
EFI_STATUS
Ip4GetMulticastMac (
  IN  EFI_MANAGED_NETWORK_PROTOCOL  *Mnp,
  IN  IP4_ADDR                      Multicast,
  OUT EFI_MAC_ADDRESS               *Mac
  );
 
IP4_HEAD *
Ip4NtohHead (
  IN IP4_HEAD  *Head
  );
 
BOOLEAN
Ip4StationAddressValid (
  IN IP4_ADDR  Ip,
  IN IP4_ADDR  Netmask
  );
 
#endif