Ip6Impl.h

Go to the documentation of this file.

 
#ifndef __EFI_IP6_IMPL_H__
#define __EFI_IP6_IMPL_H__
 
#include <Uefi.h>
 
#include <IndustryStandard/Dhcp.h>
 
#include <Protocol/ServiceBinding.h>
#include <Protocol/ManagedNetwork.h>
#include <Protocol/IpSec.h>
#include <Protocol/Ip6.h>
#include <Protocol/Ip6Config.h>
#include <Protocol/Dhcp6.h>
#include <Protocol/DevicePath.h>
#include <Protocol/HiiConfigRouting.h>
#include <Protocol/HiiConfigAccess.h>
 
#include <Library/DebugLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiRuntimeServicesTableLib.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/HiiLib.h>
#include <Library/UefiHiiServicesLib.h>
#include <Library/DevicePathLib.h>
#include <Library/PrintLib.h>
 
#include <Guid/MdeModuleHii.h>
 
#include "Ip6Common.h"
#include "Ip6Driver.h"
#include "Ip6Icmp.h"
#include "Ip6If.h"
#include "Ip6Input.h"
#include "Ip6Mld.h"
#include "Ip6Nd.h"
#include "Ip6Option.h"
#include "Ip6Output.h"
#include "Ip6Route.h"
#include "Ip6ConfigNv.h"
#include "Ip6ConfigImpl.h"
 
#define IP6_PROTOCOL_SIGNATURE  SIGNATURE_32 ('I', 'P', '6', 'P')
#define IP6_SERVICE_SIGNATURE   SIGNATURE_32 ('I', 'P', '6', 'S')
 
//
// The state of IP6 protocol. It starts from UNCONFIGED. if it is
// successfully configured, it goes to CONFIGED. if configure NULL
// is called, it becomes UNCONFIGED again. If (partly) destroyed, it
// becomes DESTROY.
//
#define IP6_STATE_UNCONFIGED  0
#define IP6_STATE_CONFIGED    1
 
//
// The state of IP6 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 IP6_SERVICE_UNSTARTED  0
#define IP6_SERVICE_STARTED    1
#define IP6_SERVICE_CONFIGED   2
#define IP6_SERVICE_DESTROY    3
 
#define IP6_INSTANCE_FROM_PROTOCOL(Ip6) \
          CR ((Ip6), IP6_PROTOCOL, Ip6Proto, IP6_PROTOCOL_SIGNATURE)
 
#define IP6_SERVICE_FROM_PROTOCOL(Sb)   \
          CR ((Sb), IP6_SERVICE, ServiceBinding, IP6_SERVICE_SIGNATURE)
 
#define IP6_NO_MAPPING(IpInstance)  (!(IpInstance)->Interface->Configured)
 
extern EFI_IPSEC2_PROTOCOL  *mIpSec;
extern BOOLEAN              mIpSec2Installed;
 
//
// IP6_TXTOKEN_WRAP wraps the upper layer's transmit token.
// The user's data is kept in the Packet. When fragment is
// needed, each fragment of the Packet has a reference to the
// Packet, no data is actually copied. The Packet will be
// released when all the fragments of it have been recycled by
// MNP. Upon then, the IP6_TXTOKEN_WRAP will be released, and
// user's event signalled.
//
typedef struct {
  IP6_PROTOCOL                *IpInstance;
  EFI_IP6_COMPLETION_TOKEN    *Token;
  EFI_EVENT                   IpSecRecycleSignal;
  NET_BUF                     *Packet;
  BOOLEAN                     Sent;
  INTN                        Life;
} IP6_TXTOKEN_WRAP;
 
typedef struct {
  EFI_EVENT    IpSecRecycleSignal;
  NET_BUF      *Packet;
} IP6_IPSEC_WRAP;
 
//
// IP6_RXDATA_WRAP wraps the data IP6 child delivers to the
// upper layers. The received packet is kept in the Packet.
// The Packet itself may be constructured from some fragments.
// All the fragments of the Packet is organized by a
// IP6_ASSEMBLE_ENTRY structure. If the Packet is recycled by
// the upper layer, the assemble entry and its associated
// fragments will be freed at last.
//
typedef struct {
  LIST_ENTRY              Link;
  IP6_PROTOCOL            *IpInstance;
  NET_BUF                 *Packet;
  EFI_IP6_RECEIVE_DATA    RxData;
} IP6_RXDATA_WRAP;
 
struct _IP6_PROTOCOL {
  UINT32                 Signature;
 
  EFI_IP6_PROTOCOL       Ip6Proto;
  EFI_HANDLE             Handle;
  INTN                   State;
 
  IP6_SERVICE            *Service;
  LIST_ENTRY             Link;    // Link to all the IP protocol from the service
 
  UINT8                  PrefixLength;    // PrefixLength of the configured station address.
  //
  // User's transmit/receive tokens, and received/delivered packets
  //
  NET_MAP                RxTokens;
  NET_MAP                TxTokens;      // map between (User's Token, IP6_TXTOKE_WRAP)
  LIST_ENTRY             Received;      // Received but not delivered packet
  LIST_ENTRY             Delivered;     // Delivered and to be recycled packets
  EFI_LOCK               RecycleLock;
 
  IP6_INTERFACE          *Interface;
  LIST_ENTRY             AddrLink;      // Ip instances with the same IP address.
 
  EFI_IPv6_ADDRESS       *GroupList;    // stored in network order.
  UINT32                 GroupCount;
 
  EFI_IP6_CONFIG_DATA    ConfigData;
  BOOLEAN                InDestroy;
};
 
struct _IP6_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;
 
  IP6_INTERFACE                      *DefaultInterface;
  IP6_ROUTE_TABLE                    *RouteTable;
 
  IP6_LINK_RX_TOKEN                  RecvRequest;
 
  //
  // Ip reassemble utilities and MLD data
  //
  IP6_ASSEMBLE_TABLE                 Assemble;
  IP6_MLD_SERVICE_DATA               MldCtrl;
 
  EFI_IPv6_ADDRESS                   LinkLocalAddr;
  BOOLEAN                            LinkLocalOk;
  BOOLEAN                            LinkLocalDadFail;
  BOOLEAN                            Dhcp6NeedStart;
  BOOLEAN                            Dhcp6NeedInfoRequest;
 
  //
  // ND data
  //
  UINT8                              CurHopLimit;
  UINT32                             LinkMTU;
  UINT32                             BaseReachableTime;
  UINT32                             ReachableTime;
  UINT32                             RetransTimer;
  LIST_ENTRY                         NeighborTable;
 
  LIST_ENTRY                         OnlinkPrefix;
  LIST_ENTRY                         AutonomousPrefix;
 
  LIST_ENTRY                         DefaultRouterList;
  UINT32                             RoundRobin;
 
  UINT8                              InterfaceIdLen;
  UINT8                              *InterfaceId;
 
  BOOLEAN                            RouterAdvertiseReceived;
  UINT8                              SolicitTimer;
  UINT32                             Ticks;
 
  //
  // 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                          FasterTimer;
 
  //
  // IPv6 Configuration Protocol instance
  //
  IP6_CONFIG_INSTANCE                Ip6ConfigInstance;
 
  //
  // The string representation of the current mac address of the
  // NIC this IP6_SERVICE works on.
  //
  CHAR16                             *MacString;
  UINT32                             MaxPacketSize;
  UINT32                             OldMaxPacketSize;
};
 
VOID
EFIAPI
Ip6FreeTxToken (
  IN VOID  *Context
  );
 
EFI_STATUS
Ip6ServiceConfigMnp (
  IN IP6_SERVICE  *IpSb,
  IN BOOLEAN      Force
  );
 
EFI_STATUS
Ip6Cancel (
  IN IP6_PROTOCOL              *IpInstance,
  IN EFI_IP6_COMPLETION_TOKEN  *Token          OPTIONAL
  );
 
VOID
Ip6InitProtocol (
  IN IP6_SERVICE       *IpSb,
  IN OUT IP6_PROTOCOL  *IpInstance
  );
 
EFI_STATUS
Ip6CleanProtocol (
  IN OUT IP6_PROTOCOL  *IpInstance
  );
 
//
// EFI_IP6_PROTOCOL interface prototypes
//
 
EFI_STATUS
EFIAPI
EfiIp6GetModeData (
  IN EFI_IP6_PROTOCOL                  *This,
  OUT EFI_IP6_MODE_DATA                *Ip6ModeData     OPTIONAL,
  OUT EFI_MANAGED_NETWORK_CONFIG_DATA  *MnpConfigData   OPTIONAL,
  OUT EFI_SIMPLE_NETWORK_MODE          *SnpModeData     OPTIONAL
  );
 
EFI_STATUS
EFIAPI
EfiIp6Configure (
  IN EFI_IP6_PROTOCOL     *This,
  IN EFI_IP6_CONFIG_DATA  *Ip6ConfigData OPTIONAL
  );
 
EFI_STATUS
EFIAPI
EfiIp6Groups (
  IN EFI_IP6_PROTOCOL  *This,
  IN BOOLEAN           JoinFlag,
  IN EFI_IPv6_ADDRESS  *GroupAddress  OPTIONAL
  );
 
EFI_STATUS
EFIAPI
EfiIp6Routes (
  IN EFI_IP6_PROTOCOL  *This,
  IN BOOLEAN           DeleteRoute,
  IN EFI_IPv6_ADDRESS  *Destination    OPTIONAL,
  IN UINT8             PrefixLength,
  IN EFI_IPv6_ADDRESS  *GatewayAddress OPTIONAL
  );
 
EFI_STATUS
EFIAPI
EfiIp6Neighbors (
  IN EFI_IP6_PROTOCOL  *This,
  IN BOOLEAN           DeleteFlag,
  IN EFI_IPv6_ADDRESS  *TargetIp6Address,
  IN EFI_MAC_ADDRESS   *TargetLinkAddress OPTIONAL,
  IN UINT32            Timeout,
  IN BOOLEAN           Override
  );
 
EFI_STATUS
EFIAPI
EfiIp6Transmit (
  IN EFI_IP6_PROTOCOL          *This,
  IN EFI_IP6_COMPLETION_TOKEN  *Token
  );
 
EFI_STATUS
EFIAPI
EfiIp6Receive (
  IN EFI_IP6_PROTOCOL          *This,
  IN EFI_IP6_COMPLETION_TOKEN  *Token
  );
 
EFI_STATUS
EFIAPI
EfiIp6Cancel (
  IN EFI_IP6_PROTOCOL          *This,
  IN EFI_IP6_COMPLETION_TOKEN  *Token    OPTIONAL
  );
 
EFI_STATUS
EFIAPI
EfiIp6Poll (
  IN EFI_IP6_PROTOCOL  *This
  );
 
#endif