[mirror_edk2.git] / MdeModulePkg / Universal / Network / Ip4Dxe / Ip4Impl.h

/** @file\r
  Ip4 internal functions and type defintions.\r
  \r
Copyright (c) 2005 - 2015, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef __EFI_IP4_IMPL_H__\r
#define __EFI_IP4_IMPL_H__\r
\r
#include <Uefi.h>\r
\r
#include <Protocol/IpSec.h>\r
#include <Protocol/Ip4.h>\r
#include <Protocol/Ip4Config2.h>\r
#include <Protocol/Arp.h>\r
#include <Protocol/ManagedNetwork.h>\r
#include <Protocol/Dhcp4.h>\r
#include <Protocol/HiiConfigRouting.h>\r
#include <Protocol/HiiConfigAccess.h>\r
\r
#include <Library/DebugLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/NetLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/DpcLib.h>\r
#include <Library/PrintLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/HiiLib.h>\r
#include <Library/UefiHiiServicesLib.h>\r
\r
#include "Ip4Common.h"\r
#include "Ip4Driver.h"\r
#include "Ip4If.h"\r
#include "Ip4Icmp.h"\r
#include "Ip4Option.h"\r
#include "Ip4Igmp.h"\r
#include "Ip4Route.h"\r
#include "Ip4Input.h"\r
#include "Ip4Output.h"\r
#include "Ip4Config2Impl.h"\r
#include "Ip4Config2Nv.h"\r
#include "Ip4NvData.h"\r
\r
#define IP4_PROTOCOL_SIGNATURE  SIGNATURE_32 ('I', 'P', '4', 'P')\r
#define IP4_SERVICE_SIGNATURE   SIGNATURE_32 ('I', 'P', '4', 'S')\r
\r
//\r
// The state of IP4 protocol. It starts from UNCONFIGED. if it is\r
// successfully configured, it goes to CONFIGED. if configure NULL\r
// is called, it becomes UNCONFIGED again. If (partly) destroyed, it\r
// becomes DESTROY.\r
//\r
#define IP4_STATE_UNCONFIGED    0\r
#define IP4_STATE_CONFIGED      1\r
#define IP4_STATE_DESTROY       2\r
\r
//\r
// The state of IP4 service. It starts from UNSTARTED. It transits\r
// to STARTED if autoconfigure is started. If default address is\r
// configured, it becomes CONFIGED. and if partly destroyed, it goes\r
// to DESTROY.\r
//\r
#define IP4_SERVICE_UNSTARTED   0\r
#define IP4_SERVICE_STARTED     1\r
#define IP4_SERVICE_CONFIGED    2\r
#define IP4_SERVICE_DESTROY     3\r
\r
\r
///\r
/// IP4_TXTOKEN_WRAP wraps the upper layer's transmit token.\r
/// The user's data is kept in the Packet. When fragment is\r
/// needed, each fragment of the Packet has a reference to the\r
/// Packet, no data is actually copied. The Packet will be\r
/// released when all the fragments of it have been recycled by\r
/// MNP. Upon then, the IP4_TXTOKEN_WRAP will be released, and\r
/// user's event signalled.\r
///\r
typedef struct {\r
  IP4_PROTOCOL              *IpInstance;\r
  EFI_IP4_COMPLETION_TOKEN  *Token;\r
  EFI_EVENT                 IpSecRecycleSignal;\r
  NET_BUF                   *Packet;\r
  BOOLEAN                   Sent;\r
  INTN                      Life;\r
} IP4_TXTOKEN_WRAP;\r
\r
///\r
/// IP4_IPSEC_WRAP wraps the packet received from MNP layer. The packet\r
/// will be released after it has been processed by the receiver. Upon then,\r
/// the IP4_IPSEC_WRAP will be released, and the IpSecRecycleSignal will be signaled\r
/// to notice IPsec to free the resources.\r
///\r
typedef struct {\r
  EFI_EVENT                 IpSecRecycleSignal;\r
  NET_BUF                   *Packet;\r
} IP4_IPSEC_WRAP;\r
\r
///\r
/// IP4_RXDATA_WRAP wraps the data IP4 child delivers to the\r
/// upper layers. The received packet is kept in the Packet.\r
/// The Packet itself may be constructured from some fragments.\r
/// All the fragments of the Packet is organized by a\r
/// IP4_ASSEMBLE_ENTRY structure. If the Packet is recycled by\r
/// the upper layer, the assemble entry and its associated\r
/// fragments will be freed at last.\r
///\r
typedef struct {\r
  LIST_ENTRY                Link;\r
  IP4_PROTOCOL              *IpInstance;\r
  NET_BUF                   *Packet;\r
  EFI_IP4_RECEIVE_DATA      RxData;\r
} IP4_RXDATA_WRAP;\r
\r
\r
struct _IP4_PROTOCOL {\r
  UINT32                    Signature;\r
\r
  EFI_IP4_PROTOCOL          Ip4Proto;\r
  EFI_HANDLE                Handle;\r
  INTN                      State;\r
\r
  IP4_SERVICE               *Service;\r
  LIST_ENTRY                Link;       // Link to all the IP protocol from the service\r
\r
  //\r
  // User's transmit/receive tokens, and received/deliverd packets\r
  //\r
  NET_MAP                   RxTokens;\r
  NET_MAP                   TxTokens;   // map between (User's Token, IP4_TXTOKE_WRAP)\r
  LIST_ENTRY                Received;   // Received but not delivered packet\r
  LIST_ENTRY                Delivered;  // Delivered and to be recycled packets\r
  EFI_LOCK                  RecycleLock;\r
\r
  //\r
  // Instance's address and route tables. There are two route tables.\r
  // RouteTable is used by the IP4 driver to route packet. EfiRouteTable\r
  // is used to communicate the current route info to the upper layer.\r
  //\r
  IP4_INTERFACE             *Interface;\r
  LIST_ENTRY                AddrLink;   // Ip instances with the same IP address.\r
  IP4_ROUTE_TABLE           *RouteTable;\r
\r
  EFI_IP4_ROUTE_TABLE       *EfiRouteTable;\r
  UINT32                    EfiRouteCount;\r
\r
  //\r
  // IGMP data for this instance\r
  //\r
  IP4_ADDR                  *Groups;    // stored in network byte order\r
  UINT32                    GroupCount;\r
\r
  EFI_IP4_CONFIG_DATA       ConfigData;\r
\r
};\r
\r
struct _IP4_SERVICE {\r
  UINT32                          Signature;\r
  EFI_SERVICE_BINDING_PROTOCOL    ServiceBinding;\r
  INTN                            State;\r
\r
  //\r
  // List of all the IP instances and interfaces, and default\r
  // interface and route table and caches.\r
  //\r
  UINTN                           NumChildren;\r
  LIST_ENTRY                      Children;\r
\r
  LIST_ENTRY                      Interfaces;\r
\r
  IP4_INTERFACE                   *DefaultInterface;\r
  IP4_ROUTE_TABLE                 *DefaultRouteTable;\r
\r
  //\r
  // Ip reassemble utilities, and IGMP data\r
  //\r
  IP4_ASSEMBLE_TABLE              Assemble;\r
  IGMP_SERVICE_DATA               IgmpCtrl;\r
\r
  //\r
  // Low level protocol used by this service instance\r
  //\r
  EFI_HANDLE                      Image;\r
  EFI_HANDLE                      Controller;\r
\r
  EFI_HANDLE                      MnpChildHandle;\r
  EFI_MANAGED_NETWORK_PROTOCOL    *Mnp;\r
\r
  EFI_MANAGED_NETWORK_CONFIG_DATA MnpConfigData;\r
  EFI_SIMPLE_NETWORK_MODE         SnpMode;\r
\r
  EFI_EVENT                       Timer;\r
\r
  //\r
  // IPv4 Configuration II Protocol instance\r
  //\r
  IP4_CONFIG2_INSTANCE            Ip4Config2Instance;\r
\r
  CHAR16                          *MacString;\r
\r
  UINT32                          MaxPacketSize;\r
  UINT32                          OldMaxPacketSize; ///< The MTU before IPsec enable.\r
};\r
\r
#define IP4_INSTANCE_FROM_PROTOCOL(Ip4) \\r
          CR ((Ip4), IP4_PROTOCOL, Ip4Proto, IP4_PROTOCOL_SIGNATURE)\r
\r
#define IP4_SERVICE_FROM_PROTOCOL(Sb)   \\r
          CR ((Sb), IP4_SERVICE, ServiceBinding, IP4_SERVICE_SIGNATURE)\r
\r
#define IP4_SERVICE_FROM_CONFIG2_INSTANCE(This) \\r
  CR (This, IP4_SERVICE, Ip4Config2Instance, IP4_SERVICE_SIGNATURE)\r
\r
\r
#define IP4_NO_MAPPING(IpInstance) (!(IpInstance)->Interface->Configured)\r
\r
extern EFI_IP4_PROTOCOL mEfiIp4ProtocolTemplete;\r
\r
/**\r
  Config the MNP parameter used by IP. The IP driver use one MNP\r
  child to transmit/receive frames. By default, it configures MNP\r
  to receive unicast/multicast/broadcast. And it will enable/disable\r
  the promiscous receive according to whether there is IP child\r
  enable that or not. If Force is FALSE, it will iterate through\r
  all the IP children to check whether the promiscuous receive\r
  setting has been changed. If it hasn't been changed, it won't\r
  reconfigure the MNP. If Force is TRUE, the MNP is configured no\r
  matter whether that is changed or not.\r
\r
  @param[in]  IpSb               The IP4 service instance that is to be changed.\r
  @param[in]  Force              Force the configuration or not.\r
\r
  @retval EFI_SUCCESS            The MNP is successfully configured/reconfigured.\r
  @retval Others                 Configuration failed.\r
\r
**/\r
EFI_STATUS\r
Ip4ServiceConfigMnp (\r
  IN IP4_SERVICE            *IpSb,\r
  IN BOOLEAN                Force\r
  );\r
\r
/**\r
  Intiialize the IP4_PROTOCOL structure to the unconfigured states.\r
\r
  @param  IpSb                   The IP4 service instance.\r
  @param  IpInstance             The IP4 child instance.\r
\r
**/\r
VOID\r
Ip4InitProtocol (\r
  IN     IP4_SERVICE            *IpSb,\r
  IN OUT IP4_PROTOCOL           *IpInstance\r
  );\r
\r
/**\r
  Clean up the IP4 child, release all the resources used by it.\r
\r
  @param[in]  IpInstance         The IP4 child to clean up.\r
\r
  @retval EFI_SUCCESS            The IP4 child is cleaned up.\r
  @retval EFI_DEVICE_ERROR       Some resources failed to be released.\r
\r
**/\r
EFI_STATUS\r
Ip4CleanProtocol (\r
  IN  IP4_PROTOCOL          *IpInstance\r
  );\r
\r
/**\r
  Cancel the user's receive/transmit request.\r
\r
  @param[in]  IpInstance         The IP4 child.\r
  @param[in]  Token              The token to cancel. If NULL, all token will be\r
                                 cancelled.\r
\r
  @retval EFI_SUCCESS            The token is cancelled.\r
  @retval EFI_NOT_FOUND          The token isn't found on either the\r
                                 transmit/receive queue.\r
  @retval EFI_DEVICE_ERROR       Not all token is cancelled when Token is NULL.\r
\r
**/\r
EFI_STATUS\r
Ip4Cancel (\r
  IN IP4_PROTOCOL             *IpInstance,\r
  IN EFI_IP4_COMPLETION_TOKEN *Token          OPTIONAL\r
  );\r
\r
/**\r
  Change the IP4 child's multicast setting. The caller\r
  should make sure that the parameters is valid.\r
\r
  @param[in]  IpInstance             The IP4 child to change the setting.\r
  @param[in]  JoinFlag               TRUE to join the group, otherwise leave it\r
  @param[in]  GroupAddress           The target group address\r
\r
  @retval EFI_ALREADY_STARTED    Want to join the group, but already a member of it\r
  @retval EFI_OUT_OF_RESOURCES   Failed to allocate some resources.\r
  @retval EFI_DEVICE_ERROR       Failed to set the group configuraton\r
  @retval EFI_SUCCESS            Successfully updated the group setting.\r
  @retval EFI_NOT_FOUND          Try to leave the group which it isn't a member.\r
\r
**/\r
EFI_STATUS\r
Ip4Groups (\r
  IN IP4_PROTOCOL           *IpInstance,\r
  IN BOOLEAN                JoinFlag,\r
  IN EFI_IPv4_ADDRESS       *GroupAddress       OPTIONAL\r
  );\r
\r
/**\r
  The heart beat timer of IP4 service instance. It times out\r
  all of its IP4 children's received-but-not-delivered and\r
  transmitted-but-not-recycle packets, and provides time input\r
  for its IGMP protocol.\r
\r
  @param[in]  Event                  The IP4 service instance's heart beat timer.\r
  @param[in]  Context                The IP4 service instance.\r
\r
**/\r
VOID\r
EFIAPI\r
Ip4TimerTicking (\r
  IN EFI_EVENT              Event,\r
  IN VOID                   *Context\r
  );\r
\r
/**\r
  Decrease the life of the transmitted packets. If it is\r
  decreased to zero, cancel the packet. This function is\r
  called by Ip4PacketTimerTicking which time out both the\r
  received-but-not-delivered and transmitted-but-not-recycle\r
  packets.\r
\r
  @param[in]  Map                    The IP4 child's transmit map.\r
  @param[in]  Item                   Current transmitted packet.\r
  @param[in]  Context                Not used.\r
\r
  @retval EFI_SUCCESS            Always returns EFI_SUCCESS.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Ip4SentPacketTicking (\r
  IN NET_MAP                *Map,\r
  IN NET_MAP_ITEM           *Item,\r
  IN VOID                   *Context\r
  );\r
\r
/**\r
  The callback function for the net buffer which wraps the user's\r
  transmit token. Although it seems this function is pretty simple,\r
  there are some subtle things.\r
  When user requests the IP to transmit a packet by passing it a\r
  token, the token is wrapped in an IP4_TXTOKEN_WRAP and the data\r
  is wrapped in an net buffer. the net buffer's Free function is\r
  set to Ip4FreeTxToken. The Token and token wrap are added to the\r
  IP child's TxToken map. Then the buffer is passed to Ip4Output for\r
  transmission. If something error happened before that, the buffer\r
  is freed, which in turn will free the token wrap. The wrap may\r
  have been added to the TxToken map or not, and the user's event\r
  shouldn't be fired because we are still in the EfiIp4Transmit. If\r
  the buffer has been sent by Ip4Output, it should be removed from\r
  the TxToken map and user's event signaled. The token wrap and buffer\r
  are bound together. Check the comments in Ip4Output for information\r
  about IP fragmentation.\r
\r
  @param[in]  Context                The token's wrap.\r
\r
**/\r
VOID\r
EFIAPI\r
Ip4FreeTxToken (\r
  IN VOID                   *Context\r
  );\r
\r
extern EFI_IPSEC2_PROTOCOL   *mIpSec;\r
\r
#endif\r
Commit	Line	Data
	1	/** @file\r
	2	Ip4 internal functions and type defintions.\r
	3	\r
	4	Copyright (c) 2005 - 2015, Intel Corporation. All rights reserved.<BR>\r
	5	This program and the accompanying materials\r
	6	are licensed and made available under the terms and conditions of the BSD License\r
	7	which accompanies this distribution. The full text of the license may be found at\r
	8	http://opensource.org/licenses/bsd-license.php\r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	12	\r
	13	**/\r
	14	\r
	15	#ifndef __EFI_IP4_IMPL_H__\r
	16	#define __EFI_IP4_IMPL_H__\r
	17	\r
	18	#include <Uefi.h>\r
	19	\r
	20	#include <Protocol/IpSec.h>\r
	21	#include <Protocol/Ip4.h>\r
	22	#include <Protocol/Ip4Config2.h>\r
	23	#include <Protocol/Arp.h>\r
	24	#include <Protocol/ManagedNetwork.h>\r
	25	#include <Protocol/Dhcp4.h>\r
	26	#include <Protocol/HiiConfigRouting.h>\r
	27	#include <Protocol/HiiConfigAccess.h>\r
	28	\r
	29	#include <Library/DebugLib.h>\r
	30	#include <Library/UefiRuntimeServicesTableLib.h>\r
	31	#include <Library/UefiDriverEntryPoint.h>\r
	32	#include <Library/UefiBootServicesTableLib.h>\r
	33	#include <Library/BaseLib.h>\r
	34	#include <Library/UefiLib.h>\r
	35	#include <Library/NetLib.h>\r
	36	#include <Library/BaseMemoryLib.h>\r
	37	#include <Library/MemoryAllocationLib.h>\r
	38	#include <Library/DpcLib.h>\r
	39	#include <Library/PrintLib.h>\r
	40	#include <Library/DevicePathLib.h>\r
	41	#include <Library/HiiLib.h>\r
	42	#include <Library/UefiHiiServicesLib.h>\r
	43	\r
	44	#include "Ip4Common.h"\r
	45	#include "Ip4Driver.h"\r
	46	#include "Ip4If.h"\r
	47	#include "Ip4Icmp.h"\r
	48	#include "Ip4Option.h"\r
	49	#include "Ip4Igmp.h"\r
	50	#include "Ip4Route.h"\r
	51	#include "Ip4Input.h"\r
	52	#include "Ip4Output.h"\r
	53	#include "Ip4Config2Impl.h"\r
	54	#include "Ip4Config2Nv.h"\r
	55	#include "Ip4NvData.h"\r
	56	\r
	57	#define IP4_PROTOCOL_SIGNATURE SIGNATURE_32 ('I', 'P', '4', 'P')\r
	58	#define IP4_SERVICE_SIGNATURE SIGNATURE_32 ('I', 'P', '4', 'S')\r
	59	\r
	60	//\r
	61	// The state of IP4 protocol. It starts from UNCONFIGED. if it is\r
	62	// successfully configured, it goes to CONFIGED. if configure NULL\r
	63	// is called, it becomes UNCONFIGED again. If (partly) destroyed, it\r
	64	// becomes DESTROY.\r
	65	//\r
	66	#define IP4_STATE_UNCONFIGED 0\r
	67	#define IP4_STATE_CONFIGED 1\r
	68	#define IP4_STATE_DESTROY 2\r
	69	\r
	70	//\r
	71	// The state of IP4 service. It starts from UNSTARTED. It transits\r
	72	// to STARTED if autoconfigure is started. If default address is\r
	73	// configured, it becomes CONFIGED. and if partly destroyed, it goes\r
	74	// to DESTROY.\r
	75	//\r
	76	#define IP4_SERVICE_UNSTARTED 0\r
	77	#define IP4_SERVICE_STARTED 1\r
	78	#define IP4_SERVICE_CONFIGED 2\r
	79	#define IP4_SERVICE_DESTROY 3\r
	80	\r
	81	\r
	82	///\r
	83	/// IP4_TXTOKEN_WRAP wraps the upper layer's transmit token.\r
	84	/// The user's data is kept in the Packet. When fragment is\r
	85	/// needed, each fragment of the Packet has a reference to the\r
	86	/// Packet, no data is actually copied. The Packet will be\r
	87	/// released when all the fragments of it have been recycled by\r
	88	/// MNP. Upon then, the IP4_TXTOKEN_WRAP will be released, and\r
	89	/// user's event signalled.\r
	90	///\r
	91	typedef struct {\r
	92	IP4_PROTOCOL *IpInstance;\r
	93	EFI_IP4_COMPLETION_TOKEN *Token;\r
	94	EFI_EVENT IpSecRecycleSignal;\r
	95	NET_BUF *Packet;\r
	96	BOOLEAN Sent;\r
	97	INTN Life;\r
	98	} IP4_TXTOKEN_WRAP;\r
	99	\r
	100	///\r
	101	/// IP4_IPSEC_WRAP wraps the packet received from MNP layer. The packet\r
	102	/// will be released after it has been processed by the receiver. Upon then,\r
	103	/// the IP4_IPSEC_WRAP will be released, and the IpSecRecycleSignal will be signaled\r
	104	/// to notice IPsec to free the resources.\r
	105	///\r
	106	typedef struct {\r
	107	EFI_EVENT IpSecRecycleSignal;\r
	108	NET_BUF *Packet;\r
	109	} IP4_IPSEC_WRAP;\r
	110	\r
	111	///\r
	112	/// IP4_RXDATA_WRAP wraps the data IP4 child delivers to the\r
	113	/// upper layers. The received packet is kept in the Packet.\r
	114	/// The Packet itself may be constructured from some fragments.\r
	115	/// All the fragments of the Packet is organized by a\r
	116	/// IP4_ASSEMBLE_ENTRY structure. If the Packet is recycled by\r
	117	/// the upper layer, the assemble entry and its associated\r
	118	/// fragments will be freed at last.\r
	119	///\r
	120	typedef struct {\r
	121	LIST_ENTRY Link;\r
	122	IP4_PROTOCOL *IpInstance;\r
	123	NET_BUF *Packet;\r
	124	EFI_IP4_RECEIVE_DATA RxData;\r
	125	} IP4_RXDATA_WRAP;\r
	126	\r
	127	\r
	128	struct _IP4_PROTOCOL {\r
	129	UINT32 Signature;\r
	130	\r
	131	EFI_IP4_PROTOCOL Ip4Proto;\r
	132	EFI_HANDLE Handle;\r
	133	INTN State;\r
	134	\r
	135	IP4_SERVICE *Service;\r
	136	LIST_ENTRY Link; // Link to all the IP protocol from the service\r
	137	\r
	138	//\r
	139	// User's transmit/receive tokens, and received/deliverd packets\r
	140	//\r
	141	NET_MAP RxTokens;\r
	142	NET_MAP TxTokens; // map between (User's Token, IP4_TXTOKE_WRAP)\r
	143	LIST_ENTRY Received; // Received but not delivered packet\r
	144	LIST_ENTRY Delivered; // Delivered and to be recycled packets\r
	145	EFI_LOCK RecycleLock;\r
	146	\r
	147	//\r
	148	// Instance's address and route tables. There are two route tables.\r
	149	// RouteTable is used by the IP4 driver to route packet. EfiRouteTable\r
	150	// is used to communicate the current route info to the upper layer.\r
	151	//\r
	152	IP4_INTERFACE *Interface;\r
	153	LIST_ENTRY AddrLink; // Ip instances with the same IP address.\r
	154	IP4_ROUTE_TABLE *RouteTable;\r
	155	\r
	156	EFI_IP4_ROUTE_TABLE *EfiRouteTable;\r
	157	UINT32 EfiRouteCount;\r
	158	\r
	159	//\r
	160	// IGMP data for this instance\r
	161	//\r
	162	IP4_ADDR *Groups; // stored in network byte order\r
	163	UINT32 GroupCount;\r
	164	\r
	165	EFI_IP4_CONFIG_DATA ConfigData;\r
	166	\r
	167	};\r
	168	\r
	169	struct _IP4_SERVICE {\r
	170	UINT32 Signature;\r
	171	EFI_SERVICE_BINDING_PROTOCOL ServiceBinding;\r
	172	INTN State;\r
	173	\r
	174	//\r
	175	// List of all the IP instances and interfaces, and default\r
	176	// interface and route table and caches.\r
	177	//\r
	178	UINTN NumChildren;\r
	179	LIST_ENTRY Children;\r
	180	\r
	181	LIST_ENTRY Interfaces;\r
	182	\r
	183	IP4_INTERFACE *DefaultInterface;\r
	184	IP4_ROUTE_TABLE *DefaultRouteTable;\r
	185	\r
	186	//\r
	187	// Ip reassemble utilities, and IGMP data\r
	188	//\r
	189	IP4_ASSEMBLE_TABLE Assemble;\r
	190	IGMP_SERVICE_DATA IgmpCtrl;\r
	191	\r
	192	//\r
	193	// Low level protocol used by this service instance\r
	194	//\r
	195	EFI_HANDLE Image;\r
	196	EFI_HANDLE Controller;\r
	197	\r
	198	EFI_HANDLE MnpChildHandle;\r
	199	EFI_MANAGED_NETWORK_PROTOCOL *Mnp;\r
	200	\r
	201	EFI_MANAGED_NETWORK_CONFIG_DATA MnpConfigData;\r
	202	EFI_SIMPLE_NETWORK_MODE SnpMode;\r
	203	\r
	204	EFI_EVENT Timer;\r
	205	\r
	206	//\r
	207	// IPv4 Configuration II Protocol instance\r
	208	//\r
	209	IP4_CONFIG2_INSTANCE Ip4Config2Instance;\r
	210	\r
	211	CHAR16 *MacString;\r
	212	\r
	213	UINT32 MaxPacketSize;\r
	214	UINT32 OldMaxPacketSize; ///< The MTU before IPsec enable.\r
	215	};\r
	216	\r
	217	#define IP4_INSTANCE_FROM_PROTOCOL(Ip4) \\r
	218	CR ((Ip4), IP4_PROTOCOL, Ip4Proto, IP4_PROTOCOL_SIGNATURE)\r
	219	\r
	220	#define IP4_SERVICE_FROM_PROTOCOL(Sb) \\r
	221	CR ((Sb), IP4_SERVICE, ServiceBinding, IP4_SERVICE_SIGNATURE)\r
	222	\r
	223	#define IP4_SERVICE_FROM_CONFIG2_INSTANCE(This) \\r
	224	CR (This, IP4_SERVICE, Ip4Config2Instance, IP4_SERVICE_SIGNATURE)\r
	225	\r
	226	\r
	227	#define IP4_NO_MAPPING(IpInstance) (!(IpInstance)->Interface->Configured)\r
	228	\r
	229	extern EFI_IP4_PROTOCOL mEfiIp4ProtocolTemplete;\r
	230	\r
	231	/**\r
	232	Config the MNP parameter used by IP. The IP driver use one MNP\r
	233	child to transmit/receive frames. By default, it configures MNP\r
	234	to receive unicast/multicast/broadcast. And it will enable/disable\r
	235	the promiscous receive according to whether there is IP child\r
	236	enable that or not. If Force is FALSE, it will iterate through\r
	237	all the IP children to check whether the promiscuous receive\r
	238	setting has been changed. If it hasn't been changed, it won't\r
	239	reconfigure the MNP. If Force is TRUE, the MNP is configured no\r
	240	matter whether that is changed or not.\r
	241	\r
	242	@param[in] IpSb The IP4 service instance that is to be changed.\r
	243	@param[in] Force Force the configuration or not.\r
	244	\r
	245	@retval EFI_SUCCESS The MNP is successfully configured/reconfigured.\r
	246	@retval Others Configuration failed.\r
	247	\r
	248	**/\r
	249	EFI_STATUS\r
	250	Ip4ServiceConfigMnp (\r
	251	IN IP4_SERVICE *IpSb,\r
	252	IN BOOLEAN Force\r
	253	);\r
	254	\r
	255	/**\r
	256	Intiialize the IP4_PROTOCOL structure to the unconfigured states.\r
	257	\r
	258	@param IpSb The IP4 service instance.\r
	259	@param IpInstance The IP4 child instance.\r
	260	\r
	261	**/\r
	262	VOID\r
	263	Ip4InitProtocol (\r
	264	IN IP4_SERVICE *IpSb,\r
	265	IN OUT IP4_PROTOCOL *IpInstance\r
	266	);\r
	267	\r
	268	/**\r
	269	Clean up the IP4 child, release all the resources used by it.\r
	270	\r
	271	@param[in] IpInstance The IP4 child to clean up.\r
	272	\r
	273	@retval EFI_SUCCESS The IP4 child is cleaned up.\r
	274	@retval EFI_DEVICE_ERROR Some resources failed to be released.\r
	275	\r
	276	**/\r
	277	EFI_STATUS\r
	278	Ip4CleanProtocol (\r
	279	IN IP4_PROTOCOL *IpInstance\r
	280	);\r
	281	\r
	282	/**\r
	283	Cancel the user's receive/transmit request.\r
	284	\r
	285	@param[in] IpInstance The IP4 child.\r
	286	@param[in] Token The token to cancel. If NULL, all token will be\r
	287	cancelled.\r
	288	\r
	289	@retval EFI_SUCCESS The token is cancelled.\r
	290	@retval EFI_NOT_FOUND The token isn't found on either the\r
	291	transmit/receive queue.\r
	292	@retval EFI_DEVICE_ERROR Not all token is cancelled when Token is NULL.\r
	293	\r
	294	**/\r
	295	EFI_STATUS\r
	296	Ip4Cancel (\r
	297	IN IP4_PROTOCOL *IpInstance,\r
	298	IN EFI_IP4_COMPLETION_TOKEN *Token OPTIONAL\r
	299	);\r
	300	\r
	301	/**\r
	302	Change the IP4 child's multicast setting. The caller\r
	303	should make sure that the parameters is valid.\r
	304	\r
	305	@param[in] IpInstance The IP4 child to change the setting.\r
	306	@param[in] JoinFlag TRUE to join the group, otherwise leave it\r
	307	@param[in] GroupAddress The target group address\r
	308	\r
	309	@retval EFI_ALREADY_STARTED Want to join the group, but already a member of it\r
	310	@retval EFI_OUT_OF_RESOURCES Failed to allocate some resources.\r
	311	@retval EFI_DEVICE_ERROR Failed to set the group configuraton\r
	312	@retval EFI_SUCCESS Successfully updated the group setting.\r
	313	@retval EFI_NOT_FOUND Try to leave the group which it isn't a member.\r
	314	\r
	315	**/\r
	316	EFI_STATUS\r
	317	Ip4Groups (\r
	318	IN IP4_PROTOCOL *IpInstance,\r
	319	IN BOOLEAN JoinFlag,\r
	320	IN EFI_IPv4_ADDRESS *GroupAddress OPTIONAL\r
	321	);\r
	322	\r
	323	/**\r
	324	The heart beat timer of IP4 service instance. It times out\r
	325	all of its IP4 children's received-but-not-delivered and\r
	326	transmitted-but-not-recycle packets, and provides time input\r
	327	for its IGMP protocol.\r
	328	\r
	329	@param[in] Event The IP4 service instance's heart beat timer.\r
	330	@param[in] Context The IP4 service instance.\r
	331	\r
	332	**/\r
	333	VOID\r
	334	EFIAPI\r
	335	Ip4TimerTicking (\r
	336	IN EFI_EVENT Event,\r
	337	IN VOID *Context\r
	338	);\r
	339	\r
	340	/**\r
	341	Decrease the life of the transmitted packets. If it is\r
	342	decreased to zero, cancel the packet. This function is\r
	343	called by Ip4PacketTimerTicking which time out both the\r
	344	received-but-not-delivered and transmitted-but-not-recycle\r
	345	packets.\r
	346	\r
	347	@param[in] Map The IP4 child's transmit map.\r
	348	@param[in] Item Current transmitted packet.\r
	349	@param[in] Context Not used.\r
	350	\r
	351	@retval EFI_SUCCESS Always returns EFI_SUCCESS.\r
	352	\r
	353	**/\r
	354	EFI_STATUS\r
	355	EFIAPI\r
	356	Ip4SentPacketTicking (\r
	357	IN NET_MAP *Map,\r
	358	IN NET_MAP_ITEM *Item,\r
	359	IN VOID *Context\r
	360	);\r
	361	\r
	362	/**\r
	363	The callback function for the net buffer which wraps the user's\r
	364	transmit token. Although it seems this function is pretty simple,\r
	365	there are some subtle things.\r
	366	When user requests the IP to transmit a packet by passing it a\r
	367	token, the token is wrapped in an IP4_TXTOKEN_WRAP and the data\r
	368	is wrapped in an net buffer. the net buffer's Free function is\r
	369	set to Ip4FreeTxToken. The Token and token wrap are added to the\r
	370	IP child's TxToken map. Then the buffer is passed to Ip4Output for\r
	371	transmission. If something error happened before that, the buffer\r
	372	is freed, which in turn will free the token wrap. The wrap may\r
	373	have been added to the TxToken map or not, and the user's event\r
	374	shouldn't be fired because we are still in the EfiIp4Transmit. If\r
	375	the buffer has been sent by Ip4Output, it should be removed from\r
	376	the TxToken map and user's event signaled. The token wrap and buffer\r
	377	are bound together. Check the comments in Ip4Output for information\r
	378	about IP fragmentation.\r
	379	\r
	380	@param[in] Context The token's wrap.\r
	381	\r
	382	**/\r
	383	VOID\r
	384	EFIAPI\r
	385	Ip4FreeTxToken (\r
	386	IN VOID *Context\r
	387	);\r
	388	\r
	389	extern EFI_IPSEC2_PROTOCOL *mIpSec;\r
	390	\r
	391	#endif\r