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

/** @file\r
  Ip4 internal functions and type defintions.\r
  \r
Copyright (c) 2005 - 2007, Intel Corporation.<BR>                                                         \r
All rights reserved. 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/Ip4.h>\r
#include <Protocol/Ip4Config.h>\r
#include <Protocol/Arp.h>\r
#include <Protocol/ManagedNetwork.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
\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
\r
\r
\r
typedef enum {\r
  IP4_PROTOCOL_SIGNATURE = SIGNATURE_32 ('I', 'P', '4', 'P'),\r
  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) destoried, it\r
  // becomes DESTORY.\r
  //\r
  IP4_STATE_UNCONFIGED   = 0,\r
  IP4_STATE_CONFIGED,\r
  IP4_STATE_DESTORY,\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 destoried, it goes\r
  // to DESTORY.\r
  //\r
  IP4_SERVICE_UNSTARTED  = 0,\r
  IP4_SERVICE_STARTED,\r
  IP4_SERVICE_CONFIGED,\r
  IP4_SERVICE_DESTORY\r
} IP4_IMPL_ENUM_TYPES;\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
  NET_BUF                   *Packet;\r
  BOOLEAN                   Sent;\r
  INTN                      Life;\r
} IP4_TXTOKEN_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
  BOOLEAN                         InDestory;\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
  // Auto configure staff\r
  //\r
  EFI_IP4_CONFIG_PROTOCOL         *Ip4Config;\r
  EFI_EVENT                       DoneEvent;\r
  EFI_EVENT                       ReconfigEvent;\r
  EFI_EVENT                       ActiveEvent;\r
\r
  //\r
  // The string representation of the current mac address of the\r
  // NIC this IP4_SERVICE works on.\r
  //\r
  CHAR16                          *MacString;\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_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
Ip4SentPacketTicking (\r
  IN NET_MAP                *Map,\r
  IN NET_MAP_ITEM           *Item,\r
  IN VOID                   *Context\r
  );\r
#endif\r
Commit	Line	Data
	1	/** @file\r
	2	Ip4 internal functions and type defintions.\r
	3	\r
	4	Copyright (c) 2005 - 2007, Intel Corporation.<BR> \r
	5	All rights reserved. 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/Ip4.h>\r
	21	#include <Protocol/Ip4Config.h>\r
	22	#include <Protocol/Arp.h>\r
	23	#include <Protocol/ManagedNetwork.h>\r
	24	\r
	25	#include <Library/DebugLib.h>\r
	26	#include <Library/UefiRuntimeServicesTableLib.h>\r
	27	#include <Library/UefiDriverEntryPoint.h>\r
	28	#include <Library/UefiBootServicesTableLib.h>\r
	29	#include <Library/BaseLib.h>\r
	30	#include <Library/UefiLib.h>\r
	31	#include <Library/NetLib.h>\r
	32	#include <Library/BaseMemoryLib.h>\r
	33	#include <Library/MemoryAllocationLib.h>\r
	34	#include <Library/DpcLib.h>\r
	35	\r
	36	#include "Ip4Common.h"\r
	37	#include "Ip4Driver.h"\r
	38	#include "Ip4If.h"\r
	39	#include "Ip4Icmp.h"\r
	40	#include "Ip4Option.h"\r
	41	#include "Ip4Igmp.h"\r
	42	#include "Ip4Route.h"\r
	43	#include "Ip4Input.h"\r
	44	#include "Ip4Output.h"\r
	45	\r
	46	\r
	47	\r
	48	typedef enum {\r
	49	IP4_PROTOCOL_SIGNATURE = SIGNATURE_32 ('I', 'P', '4', 'P'),\r
	50	IP4_SERVICE_SIGNATURE = SIGNATURE_32 ('I', 'P', '4', 'S'),\r
	51	\r
	52	//\r
	53	// The state of IP4 protocol. It starts from UNCONFIGED. if it is\r
	54	// successfully configured, it goes to CONFIGED. if configure NULL\r
	55	// is called, it becomes UNCONFIGED again. If (partly) destoried, it\r
	56	// becomes DESTORY.\r
	57	//\r
	58	IP4_STATE_UNCONFIGED = 0,\r
	59	IP4_STATE_CONFIGED,\r
	60	IP4_STATE_DESTORY,\r
	61	\r
	62	//\r
	63	// The state of IP4 service. It starts from UNSTARTED. It transits\r
	64	// to STARTED if autoconfigure is started. If default address is\r
	65	// configured, it becomes CONFIGED. and if partly destoried, it goes\r
	66	// to DESTORY.\r
	67	//\r
	68	IP4_SERVICE_UNSTARTED = 0,\r
	69	IP4_SERVICE_STARTED,\r
	70	IP4_SERVICE_CONFIGED,\r
	71	IP4_SERVICE_DESTORY\r
	72	} IP4_IMPL_ENUM_TYPES;\r
	73	\r
	74	///\r
	75	/// IP4_TXTOKEN_WRAP wraps the upper layer's transmit token.\r
	76	/// The user's data is kept in the Packet. When fragment is\r
	77	/// needed, each fragment of the Packet has a reference to the\r
	78	/// Packet, no data is actually copied. The Packet will be\r
	79	/// released when all the fragments of it have been recycled by\r
	80	/// MNP. Upon then, the IP4_TXTOKEN_WRAP will be released, and\r
	81	/// user's event signalled.\r
	82	///\r
	83	typedef struct {\r
	84	IP4_PROTOCOL *IpInstance;\r
	85	EFI_IP4_COMPLETION_TOKEN *Token;\r
	86	NET_BUF *Packet;\r
	87	BOOLEAN Sent;\r
	88	INTN Life;\r
	89	} IP4_TXTOKEN_WRAP;\r
	90	\r
	91	///\r
	92	/// IP4_RXDATA_WRAP wraps the data IP4 child delivers to the\r
	93	/// upper layers. The received packet is kept in the Packet.\r
	94	/// The Packet itself may be constructured from some fragments.\r
	95	/// All the fragments of the Packet is organized by a\r
	96	/// IP4_ASSEMBLE_ENTRY structure. If the Packet is recycled by\r
	97	/// the upper layer, the assemble entry and its associated\r
	98	/// fragments will be freed at last.\r
	99	///\r
	100	typedef struct {\r
	101	LIST_ENTRY Link;\r
	102	IP4_PROTOCOL *IpInstance;\r
	103	NET_BUF *Packet;\r
	104	EFI_IP4_RECEIVE_DATA RxData;\r
	105	} IP4_RXDATA_WRAP;\r
	106	\r
	107	\r
	108	struct _IP4_PROTOCOL {\r
	109	UINT32 Signature;\r
	110	\r
	111	EFI_IP4_PROTOCOL Ip4Proto;\r
	112	EFI_HANDLE Handle;\r
	113	INTN State;\r
	114	\r
	115	IP4_SERVICE *Service;\r
	116	LIST_ENTRY Link; // Link to all the IP protocol from the service\r
	117	\r
	118	//\r
	119	// User's transmit/receive tokens, and received/deliverd packets\r
	120	//\r
	121	NET_MAP RxTokens;\r
	122	NET_MAP TxTokens; // map between (User's Token, IP4_TXTOKE_WRAP)\r
	123	LIST_ENTRY Received; // Received but not delivered packet\r
	124	LIST_ENTRY Delivered; // Delivered and to be recycled packets\r
	125	EFI_LOCK RecycleLock;\r
	126	\r
	127	//\r
	128	// Instance's address and route tables. There are two route tables.\r
	129	// RouteTable is used by the IP4 driver to route packet. EfiRouteTable\r
	130	// is used to communicate the current route info to the upper layer.\r
	131	//\r
	132	IP4_INTERFACE *Interface;\r
	133	LIST_ENTRY AddrLink; // Ip instances with the same IP address.\r
	134	IP4_ROUTE_TABLE *RouteTable;\r
	135	\r
	136	EFI_IP4_ROUTE_TABLE *EfiRouteTable;\r
	137	UINT32 EfiRouteCount;\r
	138	\r
	139	//\r
	140	// IGMP data for this instance\r
	141	//\r
	142	IP4_ADDR *Groups; // stored in network byte order\r
	143	UINT32 GroupCount;\r
	144	\r
	145	EFI_IP4_CONFIG_DATA ConfigData;\r
	146	\r
	147	};\r
	148	\r
	149	struct _IP4_SERVICE {\r
	150	UINT32 Signature;\r
	151	EFI_SERVICE_BINDING_PROTOCOL ServiceBinding;\r
	152	INTN State;\r
	153	BOOLEAN InDestory;\r
	154	\r
	155	//\r
	156	// List of all the IP instances and interfaces, and default\r
	157	// interface and route table and caches.\r
	158	//\r
	159	UINTN NumChildren;\r
	160	LIST_ENTRY Children;\r
	161	\r
	162	LIST_ENTRY Interfaces;\r
	163	\r
	164	IP4_INTERFACE *DefaultInterface;\r
	165	IP4_ROUTE_TABLE *DefaultRouteTable;\r
	166	\r
	167	//\r
	168	// Ip reassemble utilities, and IGMP data\r
	169	//\r
	170	IP4_ASSEMBLE_TABLE Assemble;\r
	171	IGMP_SERVICE_DATA IgmpCtrl;\r
	172	\r
	173	//\r
	174	// Low level protocol used by this service instance\r
	175	//\r
	176	EFI_HANDLE Image;\r
	177	EFI_HANDLE Controller;\r
	178	\r
	179	EFI_HANDLE MnpChildHandle;\r
	180	EFI_MANAGED_NETWORK_PROTOCOL *Mnp;\r
	181	\r
	182	EFI_MANAGED_NETWORK_CONFIG_DATA MnpConfigData;\r
	183	EFI_SIMPLE_NETWORK_MODE SnpMode;\r
	184	\r
	185	EFI_EVENT Timer;\r
	186	\r
	187	//\r
	188	// Auto configure staff\r
	189	//\r
	190	EFI_IP4_CONFIG_PROTOCOL *Ip4Config;\r
	191	EFI_EVENT DoneEvent;\r
	192	EFI_EVENT ReconfigEvent;\r
	193	EFI_EVENT ActiveEvent;\r
	194	\r
	195	//\r
	196	// The string representation of the current mac address of the\r
	197	// NIC this IP4_SERVICE works on.\r
	198	//\r
	199	CHAR16 *MacString;\r
	200	};\r
	201	\r
	202	#define IP4_INSTANCE_FROM_PROTOCOL(Ip4) \\r
	203	CR ((Ip4), IP4_PROTOCOL, Ip4Proto, IP4_PROTOCOL_SIGNATURE)\r
	204	\r
	205	#define IP4_SERVICE_FROM_PROTOCOL(Sb) \\r
	206	CR ((Sb), IP4_SERVICE, ServiceBinding, IP4_SERVICE_SIGNATURE)\r
	207	\r
	208	#define IP4_NO_MAPPING(IpInstance) (!(IpInstance)->Interface->Configured)\r
	209	\r
	210	extern EFI_IP4_PROTOCOL mEfiIp4ProtocolTemplete;\r
	211	\r
	212	/**\r
	213	Config the MNP parameter used by IP. The IP driver use one MNP\r
	214	child to transmit/receive frames. By default, it configures MNP\r
	215	to receive unicast/multicast/broadcast. And it will enable/disable\r
	216	the promiscous receive according to whether there is IP child\r
	217	enable that or not. If Force is FALSE, it will iterate through\r
	218	all the IP children to check whether the promiscuous receive\r
	219	setting has been changed. If it hasn't been changed, it won't\r
	220	reconfigure the MNP. If Force is TRUE, the MNP is configured no\r
	221	matter whether that is changed or not.\r
	222	\r
	223	@param[in] IpSb The IP4 service instance that is to be changed.\r
	224	@param[in] Force Force the configuration or not.\r
	225	\r
	226	@retval EFI_SUCCESS The MNP is successfully configured/reconfigured.\r
	227	@retval Others Configuration failed.\r
	228	\r
	229	**/\r
	230	EFI_STATUS\r
	231	Ip4ServiceConfigMnp (\r
	232	IN IP4_SERVICE *IpSb,\r
	233	IN BOOLEAN Force\r
	234	);\r
	235	\r
	236	/**\r
	237	Intiialize the IP4_PROTOCOL structure to the unconfigured states.\r
	238	\r
	239	@param IpSb The IP4 service instance.\r
	240	@param IpInstance The IP4 child instance.\r
	241	\r
	242	**/\r
	243	VOID\r
	244	Ip4InitProtocol (\r
	245	IN IP4_SERVICE *IpSb,\r
	246	IN OUT IP4_PROTOCOL *IpInstance\r
	247	);\r
	248	\r
	249	/**\r
	250	Clean up the IP4 child, release all the resources used by it.\r
	251	\r
	252	@param[in] IpInstance The IP4 child to clean up.\r
	253	\r
	254	@retval EFI_SUCCESS The IP4 child is cleaned up\r
	255	@retval EFI_DEVICE_ERROR Some resources failed to be released\r
	256	\r
	257	**/\r
	258	EFI_STATUS\r
	259	Ip4CleanProtocol (\r
	260	IN IP4_PROTOCOL *IpInstance\r
	261	);\r
	262	\r
	263	/**\r
	264	Cancel the user's receive/transmit request.\r
	265	\r
	266	@param[in] IpInstance The IP4 child\r
	267	@param[in] Token The token to cancel. If NULL, all token will be\r
	268	cancelled.\r
	269	\r
	270	@retval EFI_SUCCESS The token is cancelled\r
	271	@retval EFI_NOT_FOUND The token isn't found on either the\r
	272	transmit/receive queue\r
	273	@retval EFI_DEVICE_ERROR Not all token is cancelled when Token is NULL.\r
	274	\r
	275	**/\r
	276	EFI_STATUS\r
	277	Ip4Cancel (\r
	278	IN IP4_PROTOCOL *IpInstance,\r
	279	IN EFI_IP4_COMPLETION_TOKEN *Token OPTIONAL\r
	280	);\r
	281	\r
	282	/**\r
	283	Change the IP4 child's multicast setting. The caller\r
	284	should make sure that the parameters is valid.\r
	285	\r
	286	@param[in] IpInstance The IP4 child to change the setting.\r
	287	@param[in] JoinFlag TRUE to join the group, otherwise leave it\r
	288	@param[in] GroupAddress The target group address\r
	289	\r
	290	@retval EFI_ALREADY_STARTED Want to join the group, but already a member of it\r
	291	@retval EFI_OUT_OF_RESOURCES Failed to allocate some resources.\r
	292	@retval EFI_DEVICE_ERROR Failed to set the group configuraton\r
	293	@retval EFI_SUCCESS Successfully updated the group setting.\r
	294	@retval EFI_NOT_FOUND Try to leave the group which it isn't a member.\r
	295	\r
	296	**/\r
	297	EFI_STATUS\r
	298	Ip4Groups (\r
	299	IN IP4_PROTOCOL *IpInstance,\r
	300	IN BOOLEAN JoinFlag,\r
	301	IN EFI_IPv4_ADDRESS *GroupAddress OPTIONAL\r
	302	);\r
	303	\r
	304	/**\r
	305	The heart beat timer of IP4 service instance. It times out\r
	306	all of its IP4 children's received-but-not-delivered and\r
	307	transmitted-but-not-recycle packets, and provides time input\r
	308	for its IGMP protocol.\r
	309	\r
	310	@param[in] Event The IP4 service instance's heart beat timer.\r
	311	@param[in] Context The IP4 service instance.\r
	312	\r
	313	**/\r
	314	VOID\r
	315	EFIAPI\r
	316	Ip4TimerTicking (\r
	317	IN EFI_EVENT Event,\r
	318	IN VOID *Context\r
	319	);\r
	320	\r
	321	/**\r
	322	Decrease the life of the transmitted packets. If it is\r
	323	decreased to zero, cancel the packet. This function is\r
	324	called by Ip4PacketTimerTicking which time out both the\r
	325	received-but-not-delivered and transmitted-but-not-recycle\r
	326	packets.\r
	327	\r
	328	@param[in] Map The IP4 child's transmit map.\r
	329	@param[in] Item Current transmitted packet\r
	330	@param[in] Context Not used.\r
	331	\r
	332	@retval EFI_SUCCESS Always returns EFI_SUCCESS\r
	333	\r
	334	**/\r
	335	EFI_STATUS\r
	336	Ip4SentPacketTicking (\r
	337	IN NET_MAP *Map,\r
	338	IN NET_MAP_ITEM *Item,\r
	339	IN VOID *Context\r
	340	);\r
	341	#endif\r