Ip4Impl.h

Go to the documentation of this file.

 
#ifndef __EFI_IP4_IMPL_H__
#define __EFI_IP4_IMPL_H__
 
#include <Uefi.h>
 
#include <Protocol/IpSec.h>
#include <Protocol/Ip4.h>
#include <Protocol/Ip4Config2.h>
#include <Protocol/Arp.h>
#include <Protocol/ManagedNetwork.h>
#include <Protocol/Dhcp4.h>
#include <Protocol/HiiConfigRouting.h>
#include <Protocol/HiiConfigAccess.h>
 
#include <IndustryStandard/Dhcp.h>
 
#include <Library/DebugLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>
#include <Library/UefiDriverEntryPoint.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/BaseLib.h>
#include <Library/UefiLib.h>
#include <Library/NetLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/DpcLib.h>
#include <Library/PrintLib.h>
#include <Library/DevicePathLib.h>
#include <Library/HiiLib.h>
#include <Library/UefiHiiServicesLib.h>
 
#include "Ip4Common.h"
#include "Ip4Driver.h"
#include "Ip4If.h"
#include "Ip4Icmp.h"
#include "Ip4Option.h"
#include "Ip4Igmp.h"
#include "Ip4Route.h"
#include "Ip4Input.h"
#include "Ip4Output.h"
#include "Ip4Config2Impl.h"
#include "Ip4Config2Nv.h"
#include "Ip4NvData.h"
 
#define IP4_PROTOCOL_SIGNATURE  SIGNATURE_32 ('I', 'P', '4', 'P')
#define IP4_SERVICE_SIGNATURE   SIGNATURE_32 ('I', 'P', '4', 'S')
 
//
// The state of IP4 protocol. It starts from UNCONFIGED. if it is
// successfully configured, it goes to CONFIGED. if configure NULL
// is called, it becomes UNCONFIGED again.
//
#define IP4_STATE_UNCONFIGED  0
#define IP4_STATE_CONFIGED    1
 
//
// The state of IP4 service. It starts from UNSTARTED. It transits
// to STARTED if autoconfigure is started. If default address is
// configured, it becomes CONFIGED. and if partly destroyed, it goes
// to DESTROY.
//
#define IP4_SERVICE_UNSTARTED  0
#define IP4_SERVICE_STARTED    1
#define IP4_SERVICE_CONFIGED   2
#define IP4_SERVICE_DESTROY    3
 
typedef struct {
  IP4_PROTOCOL                *IpInstance;
  EFI_IP4_COMPLETION_TOKEN    *Token;
  EFI_EVENT                   IpSecRecycleSignal;
  NET_BUF                     *Packet;
  BOOLEAN                     Sent;
  INTN                        Life;
} IP4_TXTOKEN_WRAP;
 
typedef struct {
  EFI_EVENT    IpSecRecycleSignal;
  NET_BUF      *Packet;
} IP4_IPSEC_WRAP;
 
typedef struct {
  LIST_ENTRY              Link;
  IP4_PROTOCOL            *IpInstance;
  NET_BUF                 *Packet;
  EFI_IP4_RECEIVE_DATA    RxData;
} IP4_RXDATA_WRAP;
 
struct _IP4_PROTOCOL {
  UINT32                 Signature;
 
  EFI_IP4_PROTOCOL       Ip4Proto;
  EFI_HANDLE             Handle;
  INTN                   State;
 
  BOOLEAN                InDestroy;
 
  IP4_SERVICE            *Service;
  LIST_ENTRY             Link;          // Link to all the IP protocol from the service
 
  //
  // User's transmit/receive tokens, and received/delivered packets
  //
  NET_MAP                RxTokens;
  NET_MAP                TxTokens;      // map between (User's Token, IP4_TXTOKE_WRAP)
  LIST_ENTRY             Received;      // Received but not delivered packet
  LIST_ENTRY             Delivered;     // Delivered and to be recycled packets
  EFI_LOCK               RecycleLock;
 
  //
  // Instance's address and route tables. There are two route tables.
  // RouteTable is used by the IP4 driver to route packet. EfiRouteTable
  // is used to communicate the current route info to the upper layer.
  //
  IP4_INTERFACE          *Interface;
  LIST_ENTRY             AddrLink;      // Ip instances with the same IP address.
  IP4_ROUTE_TABLE        *RouteTable;
 
  EFI_IP4_ROUTE_TABLE    *EfiRouteTable;
  UINT32                 EfiRouteCount;
 
  //
  // IGMP data for this instance
  //
  IP4_ADDR               *Groups;       // stored in network byte order
  UINT32                 GroupCount;
 
  EFI_IP4_CONFIG_DATA    ConfigData;
};
 
struct _IP4_SERVICE {
  UINT32                             Signature;
  EFI_SERVICE_BINDING_PROTOCOL       ServiceBinding;
  INTN                               State;
 
  //
  // List of all the IP instances and interfaces, and default
  // interface and route table and caches.
  //
  UINTN                              NumChildren;
  LIST_ENTRY                         Children;
 
  LIST_ENTRY                         Interfaces;
 
  IP4_INTERFACE                      *DefaultInterface;
  IP4_ROUTE_TABLE                    *DefaultRouteTable;
 
  //
  // Ip reassemble utilities, and IGMP data
  //
  IP4_ASSEMBLE_TABLE                 Assemble;
  IGMP_SERVICE_DATA                  IgmpCtrl;
 
  //
  // Low level protocol used by this service instance
  //
  EFI_HANDLE                         Image;
  EFI_HANDLE                         Controller;
 
  EFI_HANDLE                         MnpChildHandle;
  EFI_MANAGED_NETWORK_PROTOCOL       *Mnp;
 
  EFI_MANAGED_NETWORK_CONFIG_DATA    MnpConfigData;
  EFI_SIMPLE_NETWORK_MODE            SnpMode;
 
  EFI_EVENT                          Timer;
  EFI_EVENT                          ReconfigCheckTimer;
  EFI_EVENT                          ReconfigEvent;
 
  BOOLEAN                            Reconfig;
 
  //
  // Underlying media present status.
  //
  BOOLEAN                            MediaPresent;
 
  //
  // IPv4 Configuration II Protocol instance
  //
  IP4_CONFIG2_INSTANCE               Ip4Config2Instance;
 
  CHAR16                             *MacString;
 
  UINT32                             MaxPacketSize;
  UINT32                             OldMaxPacketSize; 
};
 
#define IP4_INSTANCE_FROM_PROTOCOL(Ip4) \
          CR ((Ip4), IP4_PROTOCOL, Ip4Proto, IP4_PROTOCOL_SIGNATURE)
 
#define IP4_SERVICE_FROM_PROTOCOL(Sb)   \
          CR ((Sb), IP4_SERVICE, ServiceBinding, IP4_SERVICE_SIGNATURE)
 
#define IP4_SERVICE_FROM_CONFIG2_INSTANCE(This) \
  CR (This, IP4_SERVICE, Ip4Config2Instance, IP4_SERVICE_SIGNATURE)
 
#define IP4_NO_MAPPING(IpInstance)  (!(IpInstance)->Interface->Configured)
 
extern EFI_IP4_PROTOCOL  mEfiIp4ProtocolTemplete;
 
EFI_STATUS
Ip4ServiceConfigMnp (
  IN IP4_SERVICE  *IpSb,
  IN BOOLEAN      Force
  );
 
VOID
Ip4InitProtocol (
  IN     IP4_SERVICE   *IpSb,
  IN OUT IP4_PROTOCOL  *IpInstance
  );
 
EFI_STATUS
Ip4CleanProtocol (
  IN  IP4_PROTOCOL  *IpInstance
  );
 
EFI_STATUS
Ip4Cancel (
  IN IP4_PROTOCOL              *IpInstance,
  IN EFI_IP4_COMPLETION_TOKEN  *Token          OPTIONAL
  );
 
EFI_STATUS
Ip4Groups (
  IN IP4_PROTOCOL      *IpInstance,
  IN BOOLEAN           JoinFlag,
  IN EFI_IPv4_ADDRESS  *GroupAddress       OPTIONAL
  );
 
VOID
EFIAPI
Ip4TimerTicking (
  IN EFI_EVENT  Event,
  IN VOID       *Context
  );
 
VOID
EFIAPI
Ip4TimerReconfigChecking (
  IN EFI_EVENT  Event,
  IN VOID       *Context
  );
 
EFI_STATUS
EFIAPI
Ip4SentPacketTicking (
  IN NET_MAP       *Map,
  IN NET_MAP_ITEM  *Item,
  IN VOID          *Context
  );
 
VOID
EFIAPI
Ip4FreeTxToken (
  IN VOID  *Context
  );
 
extern EFI_IPSEC2_PROTOCOL  *mIpSec;
extern BOOLEAN              mIpSec2Installed;
 
#endif