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

/** @file\r
  Definition for IP4 pesudo interface structure.\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_IF_H__\r
#define __EFI_IP4_IF_H__\r
\r
#define IP4_FRAME_RX_SIGNATURE  SIGNATURE_32 ('I', 'P', 'F', 'R')\r
#define IP4_FRAME_TX_SIGNATURE  SIGNATURE_32 ('I', 'P', 'F', 'T')\r
#define IP4_FRAME_ARP_SIGNATURE SIGNATURE_32 ('I', 'P', 'F', 'A')\r
#define IP4_INTERFACE_SIGNATURE SIGNATURE_32 ('I', 'P', 'I', 'F')\r
\r
/**\r
  This prototype is used by both receive and transmission.\r
  When receiving Netbuf is allocated by IP4_INTERFACE, and\r
  released by IP4. Flag shows whether the frame is received\r
  as link broadcast/multicast...\r
\r
  When transmitting, the Netbuf is from IP4, and provided\r
  to the callback as a reference. Flag isn't used.\r
\r
  @param[in] IpInstance The instance that sent or received the packet.\r
                        IpInstance can be NULL which means that it is the IP4 driver\r
                        itself sending the packets. IP4 driver may send packets that\r
                        don't belong to any instance, such as ICMP errors, ICMP echo\r
                        responses, or IGMP packets. IpInstance is used as a tag in\r
                        this module.\r
  @param[in] Packet     The sent or received packet.\r
  @param[in] IoStatus   Status of sending or receiving.\r
  @param[in] LinkFlag   Indicate if the frame is received as link broadcast/multicast.\r
                        When transmitting, it is not used.\r
  @param[in] Context    Additional data for callback.\r
\r
  @retval None.\r
**/\r
typedef\r
VOID\r
(*IP4_FRAME_CALLBACK)(\r
  IN IP4_PROTOCOL              *IpInstance       OPTIONAL,\r
  IN NET_BUF                   *Packet,\r
  IN EFI_STATUS                IoStatus,\r
  IN UINT32                    LinkFlag,\r
  IN VOID                      *Context\r
  );\r
\r
///\r
/// Each receive request is wrapped in an IP4_LINK_RX_TOKEN.\r
/// Upon completion, the Callback will be called. Only one\r
/// receive request is send to MNP. IpInstance is always NULL.\r
/// Reference MNP's spec for information.\r
///\r
typedef struct {\r
  UINT32                                Signature;\r
  IP4_INTERFACE                         *Interface;\r
\r
  IP4_PROTOCOL                          *IpInstance;\r
  IP4_FRAME_CALLBACK                    CallBack;\r
  VOID                                  *Context;\r
\r
  EFI_MANAGED_NETWORK_COMPLETION_TOKEN  MnpToken;\r
} IP4_LINK_RX_TOKEN;\r
\r
///\r
/// Each transmit request is wrapped in an IP4_LINK_TX_TOKEN.\r
/// Upon completion, the Callback will be called.\r
///\r
typedef struct {\r
  UINT32                                Signature;\r
  LIST_ENTRY                            Link;\r
\r
  IP4_INTERFACE                         *Interface;\r
\r
  IP4_PROTOCOL                          *IpInstance;\r
  IP4_FRAME_CALLBACK                    CallBack;\r
  NET_BUF                               *Packet;\r
  VOID                                  *Context;\r
\r
  EFI_MAC_ADDRESS                       DstMac;\r
  EFI_MAC_ADDRESS                       SrcMac;\r
\r
  EFI_MANAGED_NETWORK_COMPLETION_TOKEN  MnpToken;\r
  EFI_MANAGED_NETWORK_TRANSMIT_DATA     MnpTxData;\r
} IP4_LINK_TX_TOKEN;\r
\r
///\r
/// Only one ARP request is requested for all the frames in\r
/// a time. It is started for the first frames to the Ip. Any\r
/// subsequent transmission frame will be linked to Frames, and\r
/// be sent all at once the ARP requests succeed.\r
///\r
typedef struct {\r
  UINT32                  Signature;\r
  LIST_ENTRY              Link;\r
\r
  LIST_ENTRY              Frames;\r
  IP4_INTERFACE           *Interface;\r
\r
  //\r
  // ARP requesting staffs\r
  //\r
  EFI_EVENT               OnResolved;\r
  IP4_ADDR                Ip;\r
  EFI_MAC_ADDRESS         Mac;\r
} IP4_ARP_QUE;\r
\r
/**\r
  Callback to select which frame to cancel. Caller can cancel a\r
  single frame, or all the frame from an IP instance.\r
\r
  @param Frame      The sending frame to check for cancellation.\r
  @param Context    Additional data for callback.\r
\r
  @retval TRUE      The sending of the frame should be cancelled.\r
  @retval FALSE     Do not cancel the frame sending.\r
**/\r
typedef\r
BOOLEAN\r
(*IP4_FRAME_TO_CANCEL)(\r
  IP4_LINK_TX_TOKEN       *Frame,\r
  VOID                    *Context\r
  );\r
\r
//\r
// Each IP4 instance has its own station address. All the instances\r
// with the same station address share a single interface structure.\r
// Each interface has its own ARP child, and shares one MNP child.\r
// Notice the special cases that DHCP can configure the interface\r
// with 0.0.0.0/0.0.0.0.\r
//\r
struct _IP4_INTERFACE {\r
  UINT32                        Signature;\r
  LIST_ENTRY                    Link;\r
  INTN                          RefCnt;\r
\r
  //\r
  // IP address and subnet mask of the interface. It also contains\r
  // the subnet/net broadcast address for quick access. The fileds\r
  // are invalid if (Configured == FALSE)\r
  //\r
  IP4_ADDR                      Ip;\r
  IP4_ADDR                      SubnetMask;\r
  IP4_ADDR                      SubnetBrdcast;\r
  IP4_ADDR                      NetBrdcast;\r
  BOOLEAN                       Configured;\r
\r
  //\r
  // Handle used to create/destroy ARP child. All the IP children\r
  // share one MNP which is owned by IP service binding.\r
  //\r
  EFI_HANDLE                    Controller;\r
  EFI_HANDLE                    Image;\r
\r
  EFI_MANAGED_NETWORK_PROTOCOL  *Mnp;\r
  EFI_ARP_PROTOCOL              *Arp;\r
  EFI_HANDLE                    ArpHandle;\r
\r
  //\r
  // Queues to keep the frames sent and waiting ARP request.\r
  //\r
  LIST_ENTRY                    ArpQues;\r
  LIST_ENTRY                    SentFrames;\r
  IP4_LINK_RX_TOKEN             *RecvRequest;\r
\r
  //\r
  // The interface's MAC and broadcast MAC address.\r
  //\r
  EFI_MAC_ADDRESS               Mac;\r
  EFI_MAC_ADDRESS               BroadcastMac;\r
  UINT32                        HwaddrLen;\r
\r
  //\r
  // All the IP instances that have the same IP/SubnetMask are linked\r
  // together through IpInstances. If any of the instance enables\r
  // promiscuous receive, PromiscRecv is true.\r
  //\r
  LIST_ENTRY                    IpInstances;\r
  BOOLEAN                       PromiscRecv;\r
};\r
\r
/**\r
  Create an IP4_INTERFACE. Delay the creation of ARP instance until\r
  the interface is configured.\r
\r
  @param[in]  Mnp               The shared MNP child of this IP4 service binding\r
                                instance.\r
  @param[in]  Controller        The controller this IP4 service binding instance\r
                                is installed. Most like the UNDI handle.\r
  @param[in]  ImageHandle       This driver's image handle.\r
\r
  @return Point to the created IP4_INTERFACE, otherwise NULL.\r
\r
**/\r
IP4_INTERFACE *\r
Ip4CreateInterface (\r
  IN  EFI_MANAGED_NETWORK_PROTOCOL  *Mnp,\r
  IN  EFI_HANDLE                    Controller,\r
  IN  EFI_HANDLE                    ImageHandle\r
  );\r
\r
/**\r
  Set the interface's address, create and configure\r
  the ARP child if necessary.\r
\r
  @param  Interface         The interface to set the address.\r
  @param  IpAddr            The interface's IP address.\r
  @param  SubnetMask        The interface's netmask.\r
\r
  @retval EFI_SUCCESS           The interface is configured with Ip/netmask pair,\r
                                and a ARP is created for it.\r
  @retval Others                Failed to set the interface's address.\r
\r
**/\r
EFI_STATUS\r
Ip4SetAddress (\r
  IN OUT IP4_INTERFACE      *Interface,\r
  IN     IP4_ADDR           IpAddr,\r
  IN     IP4_ADDR           SubnetMask\r
  );\r
\r
/**\r
  Free the interface used by IpInstance. All the IP instance with\r
  the same Ip/Netmask pair share the same interface. It is reference\r
  counted. All the frames haven't been sent will be cancelled.\r
  Because the IpInstance is optional, the caller must remove\r
  IpInstance from the interface's instance list itself.\r
\r
  @param[in]  Interface         The interface used by the IpInstance.\r
  @param[in]  IpInstance        The Ip instance that free the interface. NULL if\r
                                the Ip driver is releasing the default interface.\r
\r
  @retval EFI_SUCCESS           The interface use IpInstance is freed.\r
\r
**/\r
EFI_STATUS\r
Ip4FreeInterface (\r
  IN  IP4_INTERFACE         *Interface,\r
  IN  IP4_PROTOCOL          *IpInstance           OPTIONAL\r
  );\r
\r
/**\r
  Send a frame from the interface. If the next hop is broadcast or\r
  multicast address, it is transmitted immediately. If the next hop\r
  is a unicast, it will consult ARP to resolve the NextHop's MAC.\r
  If some error happened, the CallBack won't be called. So, the caller\r
  must test the return value, and take action when there is an error.\r
\r
  @param[in]  Interface         The interface to send the frame from\r
  @param[in]  IpInstance        The IP child that request the transmission.  NULL\r
                                if it is the IP4 driver itself.\r
  @param[in]  Packet            The packet to transmit.\r
  @param[in]  NextHop           The immediate destination to transmit the packet\r
                                to.\r
  @param[in]  CallBack          Function to call back when transmit finished.\r
  @param[in]  Context           Opaque parameter to the call back.\r
\r
  @retval EFI_OUT_OF_RESOURCES  Failed to allocate resource to send the frame\r
  @retval EFI_NO_MAPPING        Can't resolve the MAC for the nexthop\r
  @retval EFI_SUCCESS           The packet is successfully transmitted.\r
  @retval other                 Other error occurs.\r
\r
**/\r
EFI_STATUS\r
Ip4SendFrame (\r
  IN  IP4_INTERFACE         *Interface,\r
  IN  IP4_PROTOCOL          *IpInstance       OPTIONAL,\r
  IN  NET_BUF               *Packet,\r
  IN  IP4_ADDR              NextHop,\r
  IN  IP4_FRAME_CALLBACK    CallBack,\r
  IN  VOID                  *Context\r
  );\r
\r
/**\r
  Remove all the frames on the interface that pass the FrameToCancel,\r
  either queued on ARP queues or that have already been delivered to\r
  MNP and not yet recycled.\r
\r
  @param[in]  Interface         Interface to remove the frames from.\r
  @param[in]  IoStatus          The transmit status returned to the frames'\r
                                callback.\r
  @param[in]  FrameToCancel     Function to select the frame to cancel, NULL to\r
                                select all.\r
  @param[in]  Context           Opaque parameters passed to FrameToCancel.\r
\r
**/\r
VOID\r
Ip4CancelFrames (\r
  IN IP4_INTERFACE          *Interface,\r
  IN EFI_STATUS             IoStatus,\r
  IN IP4_FRAME_TO_CANCEL    FrameToCancel    OPTIONAL,\r
  IN VOID                   *Context\r
  );\r
\r
/**\r
  If there is a pending receive request, cancel it. Don't call\r
  the receive request's callback because this function can be only\r
  called if the instance or driver is tearing itself down. It\r
  doesn't make sense to call it back. But it is necessary to call\r
  the transmit token's callback to give it a chance to free the\r
  packet and update the upper layer's transmit request status, say\r
  that from the UDP.\r
\r
  @param[in]  Interface         The interface used by the IpInstance\r
\r
**/\r
VOID\r
Ip4CancelReceive (\r
  IN IP4_INTERFACE          *Interface\r
  );\r
\r
/**\r
  Request to receive the packet from the interface.\r
\r
  @param[in]  Interface         The interface to receive the frames from.\r
  @param[in]  IpInstance        The instance that requests the receive. NULL for\r
                                the driver itself.\r
  @param[in]  CallBack          Function to call when receive finished.\r
  @param[in]  Context           Opaque parameter to the callback.\r
\r
  @retval EFI_ALREADY_STARTED   There is already a pending receive request.\r
  @retval EFI_OUT_OF_RESOURCES  Failed to allocate resource to receive.\r
  @retval EFI_SUCCESS           The recieve request has been started.\r
  @retval other                 Other error occurs.\r
\r
**/\r
EFI_STATUS\r
Ip4ReceiveFrame (\r
  IN  IP4_INTERFACE         *Interface,\r
  IN  IP4_PROTOCOL          *IpInstance       OPTIONAL,\r
  IN  IP4_FRAME_CALLBACK    CallBack,\r
  IN  VOID                  *Context\r
  );\r
\r
#endif\r
Commit	Line	Data
	1	/** @file\r
	2	Definition for IP4 pesudo interface structure.\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_IF_H__\r
	16	#define __EFI_IP4_IF_H__\r
	17	\r
	18	#define IP4_FRAME_RX_SIGNATURE SIGNATURE_32 ('I', 'P', 'F', 'R')\r
	19	#define IP4_FRAME_TX_SIGNATURE SIGNATURE_32 ('I', 'P', 'F', 'T')\r
	20	#define IP4_FRAME_ARP_SIGNATURE SIGNATURE_32 ('I', 'P', 'F', 'A')\r
	21	#define IP4_INTERFACE_SIGNATURE SIGNATURE_32 ('I', 'P', 'I', 'F')\r
	22	\r
	23	/**\r
	24	This prototype is used by both receive and transmission.\r
	25	When receiving Netbuf is allocated by IP4_INTERFACE, and\r
	26	released by IP4. Flag shows whether the frame is received\r
	27	as link broadcast/multicast...\r
	28	\r
	29	When transmitting, the Netbuf is from IP4, and provided\r
	30	to the callback as a reference. Flag isn't used.\r
	31	\r
	32	@param[in] IpInstance The instance that sent or received the packet.\r
	33	IpInstance can be NULL which means that it is the IP4 driver\r
	34	itself sending the packets. IP4 driver may send packets that\r
	35	don't belong to any instance, such as ICMP errors, ICMP echo\r
	36	responses, or IGMP packets. IpInstance is used as a tag in\r
	37	this module.\r
	38	@param[in] Packet The sent or received packet.\r
	39	@param[in] IoStatus Status of sending or receiving.\r
	40	@param[in] LinkFlag Indicate if the frame is received as link broadcast/multicast.\r
	41	When transmitting, it is not used.\r
	42	@param[in] Context Additional data for callback.\r
	43	\r
	44	@retval None.\r
	45	**/\r
	46	typedef\r
	47	VOID\r
	48	(*IP4_FRAME_CALLBACK)(\r
	49	IN IP4_PROTOCOL *IpInstance OPTIONAL,\r
	50	IN NET_BUF *Packet,\r
	51	IN EFI_STATUS IoStatus,\r
	52	IN UINT32 LinkFlag,\r
	53	IN VOID *Context\r
	54	);\r
	55	\r
	56	///\r
	57	/// Each receive request is wrapped in an IP4_LINK_RX_TOKEN.\r
	58	/// Upon completion, the Callback will be called. Only one\r
	59	/// receive request is send to MNP. IpInstance is always NULL.\r
	60	/// Reference MNP's spec for information.\r
	61	///\r
	62	typedef struct {\r
	63	UINT32 Signature;\r
	64	IP4_INTERFACE *Interface;\r
	65	\r
	66	IP4_PROTOCOL *IpInstance;\r
	67	IP4_FRAME_CALLBACK CallBack;\r
	68	VOID *Context;\r
	69	\r
	70	EFI_MANAGED_NETWORK_COMPLETION_TOKEN MnpToken;\r
	71	} IP4_LINK_RX_TOKEN;\r
	72	\r
	73	///\r
	74	/// Each transmit request is wrapped in an IP4_LINK_TX_TOKEN.\r
	75	/// Upon completion, the Callback will be called.\r
	76	///\r
	77	typedef struct {\r
	78	UINT32 Signature;\r
	79	LIST_ENTRY Link;\r
	80	\r
	81	IP4_INTERFACE *Interface;\r
	82	\r
	83	IP4_PROTOCOL *IpInstance;\r
	84	IP4_FRAME_CALLBACK CallBack;\r
	85	NET_BUF *Packet;\r
	86	VOID *Context;\r
	87	\r
	88	EFI_MAC_ADDRESS DstMac;\r
	89	EFI_MAC_ADDRESS SrcMac;\r
	90	\r
	91	EFI_MANAGED_NETWORK_COMPLETION_TOKEN MnpToken;\r
	92	EFI_MANAGED_NETWORK_TRANSMIT_DATA MnpTxData;\r
	93	} IP4_LINK_TX_TOKEN;\r
	94	\r
	95	///\r
	96	/// Only one ARP request is requested for all the frames in\r
	97	/// a time. It is started for the first frames to the Ip. Any\r
	98	/// subsequent transmission frame will be linked to Frames, and\r
	99	/// be sent all at once the ARP requests succeed.\r
	100	///\r
	101	typedef struct {\r
	102	UINT32 Signature;\r
	103	LIST_ENTRY Link;\r
	104	\r
	105	LIST_ENTRY Frames;\r
	106	IP4_INTERFACE *Interface;\r
	107	\r
	108	//\r
	109	// ARP requesting staffs\r
	110	//\r
	111	EFI_EVENT OnResolved;\r
	112	IP4_ADDR Ip;\r
	113	EFI_MAC_ADDRESS Mac;\r
	114	} IP4_ARP_QUE;\r
	115	\r
	116	/**\r
	117	Callback to select which frame to cancel. Caller can cancel a\r
	118	single frame, or all the frame from an IP instance.\r
	119	\r
	120	@param Frame The sending frame to check for cancellation.\r
	121	@param Context Additional data for callback.\r
	122	\r
	123	@retval TRUE The sending of the frame should be cancelled.\r
	124	@retval FALSE Do not cancel the frame sending.\r
	125	**/\r
	126	typedef\r
	127	BOOLEAN\r
	128	(*IP4_FRAME_TO_CANCEL)(\r
	129	IP4_LINK_TX_TOKEN *Frame,\r
	130	VOID *Context\r
	131	);\r
	132	\r
	133	//\r
	134	// Each IP4 instance has its own station address. All the instances\r
	135	// with the same station address share a single interface structure.\r
	136	// Each interface has its own ARP child, and shares one MNP child.\r
	137	// Notice the special cases that DHCP can configure the interface\r
	138	// with 0.0.0.0/0.0.0.0.\r
	139	//\r
	140	struct _IP4_INTERFACE {\r
	141	UINT32 Signature;\r
	142	LIST_ENTRY Link;\r
	143	INTN RefCnt;\r
	144	\r
	145	//\r
	146	// IP address and subnet mask of the interface. It also contains\r
	147	// the subnet/net broadcast address for quick access. The fileds\r
	148	// are invalid if (Configured == FALSE)\r
	149	//\r
	150	IP4_ADDR Ip;\r
	151	IP4_ADDR SubnetMask;\r
	152	IP4_ADDR SubnetBrdcast;\r
	153	IP4_ADDR NetBrdcast;\r
	154	BOOLEAN Configured;\r
	155	\r
	156	//\r
	157	// Handle used to create/destroy ARP child. All the IP children\r
	158	// share one MNP which is owned by IP service binding.\r
	159	//\r
	160	EFI_HANDLE Controller;\r
	161	EFI_HANDLE Image;\r
	162	\r
	163	EFI_MANAGED_NETWORK_PROTOCOL *Mnp;\r
	164	EFI_ARP_PROTOCOL *Arp;\r
	165	EFI_HANDLE ArpHandle;\r
	166	\r
	167	//\r
	168	// Queues to keep the frames sent and waiting ARP request.\r
	169	//\r
	170	LIST_ENTRY ArpQues;\r
	171	LIST_ENTRY SentFrames;\r
	172	IP4_LINK_RX_TOKEN *RecvRequest;\r
	173	\r
	174	//\r
	175	// The interface's MAC and broadcast MAC address.\r
	176	//\r
	177	EFI_MAC_ADDRESS Mac;\r
	178	EFI_MAC_ADDRESS BroadcastMac;\r
	179	UINT32 HwaddrLen;\r
	180	\r
	181	//\r
	182	// All the IP instances that have the same IP/SubnetMask are linked\r
	183	// together through IpInstances. If any of the instance enables\r
	184	// promiscuous receive, PromiscRecv is true.\r
	185	//\r
	186	LIST_ENTRY IpInstances;\r
	187	BOOLEAN PromiscRecv;\r
	188	};\r
	189	\r
	190	/**\r
	191	Create an IP4_INTERFACE. Delay the creation of ARP instance until\r
	192	the interface is configured.\r
	193	\r
	194	@param[in] Mnp The shared MNP child of this IP4 service binding\r
	195	instance.\r
	196	@param[in] Controller The controller this IP4 service binding instance\r
	197	is installed. Most like the UNDI handle.\r
	198	@param[in] ImageHandle This driver's image handle.\r
	199	\r
	200	@return Point to the created IP4_INTERFACE, otherwise NULL.\r
	201	\r
	202	**/\r
	203	IP4_INTERFACE *\r
	204	Ip4CreateInterface (\r
	205	IN EFI_MANAGED_NETWORK_PROTOCOL *Mnp,\r
	206	IN EFI_HANDLE Controller,\r
	207	IN EFI_HANDLE ImageHandle\r
	208	);\r
	209	\r
	210	/**\r
	211	Set the interface's address, create and configure\r
	212	the ARP child if necessary.\r
	213	\r
	214	@param Interface The interface to set the address.\r
	215	@param IpAddr The interface's IP address.\r
	216	@param SubnetMask The interface's netmask.\r
	217	\r
	218	@retval EFI_SUCCESS The interface is configured with Ip/netmask pair,\r
	219	and a ARP is created for it.\r
	220	@retval Others Failed to set the interface's address.\r
	221	\r
	222	**/\r
	223	EFI_STATUS\r
	224	Ip4SetAddress (\r
	225	IN OUT IP4_INTERFACE *Interface,\r
	226	IN IP4_ADDR IpAddr,\r
	227	IN IP4_ADDR SubnetMask\r
	228	);\r
	229	\r
	230	/**\r
	231	Free the interface used by IpInstance. All the IP instance with\r
	232	the same Ip/Netmask pair share the same interface. It is reference\r
	233	counted. All the frames haven't been sent will be cancelled.\r
	234	Because the IpInstance is optional, the caller must remove\r
	235	IpInstance from the interface's instance list itself.\r
	236	\r
	237	@param[in] Interface The interface used by the IpInstance.\r
	238	@param[in] IpInstance The Ip instance that free the interface. NULL if\r
	239	the Ip driver is releasing the default interface.\r
	240	\r
	241	@retval EFI_SUCCESS The interface use IpInstance is freed.\r
	242	\r
	243	**/\r
	244	EFI_STATUS\r
	245	Ip4FreeInterface (\r
	246	IN IP4_INTERFACE *Interface,\r
	247	IN IP4_PROTOCOL *IpInstance OPTIONAL\r
	248	);\r
	249	\r
	250	/**\r
	251	Send a frame from the interface. If the next hop is broadcast or\r
	252	multicast address, it is transmitted immediately. If the next hop\r
	253	is a unicast, it will consult ARP to resolve the NextHop's MAC.\r
	254	If some error happened, the CallBack won't be called. So, the caller\r
	255	must test the return value, and take action when there is an error.\r
	256	\r
	257	@param[in] Interface The interface to send the frame from\r
	258	@param[in] IpInstance The IP child that request the transmission. NULL\r
	259	if it is the IP4 driver itself.\r
	260	@param[in] Packet The packet to transmit.\r
	261	@param[in] NextHop The immediate destination to transmit the packet\r
	262	to.\r
	263	@param[in] CallBack Function to call back when transmit finished.\r
	264	@param[in] Context Opaque parameter to the call back.\r
	265	\r
	266	@retval EFI_OUT_OF_RESOURCES Failed to allocate resource to send the frame\r
	267	@retval EFI_NO_MAPPING Can't resolve the MAC for the nexthop\r
	268	@retval EFI_SUCCESS The packet is successfully transmitted.\r
	269	@retval other Other error occurs.\r
	270	\r
	271	**/\r
	272	EFI_STATUS\r
	273	Ip4SendFrame (\r
	274	IN IP4_INTERFACE *Interface,\r
	275	IN IP4_PROTOCOL *IpInstance OPTIONAL,\r
	276	IN NET_BUF *Packet,\r
	277	IN IP4_ADDR NextHop,\r
	278	IN IP4_FRAME_CALLBACK CallBack,\r
	279	IN VOID *Context\r
	280	);\r
	281	\r
	282	/**\r
	283	Remove all the frames on the interface that pass the FrameToCancel,\r
	284	either queued on ARP queues or that have already been delivered to\r
	285	MNP and not yet recycled.\r
	286	\r
	287	@param[in] Interface Interface to remove the frames from.\r
	288	@param[in] IoStatus The transmit status returned to the frames'\r
	289	callback.\r
	290	@param[in] FrameToCancel Function to select the frame to cancel, NULL to\r
	291	select all.\r
	292	@param[in] Context Opaque parameters passed to FrameToCancel.\r
	293	\r
	294	**/\r
	295	VOID\r
	296	Ip4CancelFrames (\r
	297	IN IP4_INTERFACE *Interface,\r
	298	IN EFI_STATUS IoStatus,\r
	299	IN IP4_FRAME_TO_CANCEL FrameToCancel OPTIONAL,\r
	300	IN VOID *Context\r
	301	);\r
	302	\r
	303	/**\r
	304	If there is a pending receive request, cancel it. Don't call\r
	305	the receive request's callback because this function can be only\r
	306	called if the instance or driver is tearing itself down. It\r
	307	doesn't make sense to call it back. But it is necessary to call\r
	308	the transmit token's callback to give it a chance to free the\r
	309	packet and update the upper layer's transmit request status, say\r
	310	that from the UDP.\r
	311	\r
	312	@param[in] Interface The interface used by the IpInstance\r
	313	\r
	314	**/\r
	315	VOID\r
	316	Ip4CancelReceive (\r
	317	IN IP4_INTERFACE *Interface\r
	318	);\r
	319	\r
	320	/**\r
	321	Request to receive the packet from the interface.\r
	322	\r
	323	@param[in] Interface The interface to receive the frames from.\r
	324	@param[in] IpInstance The instance that requests the receive. NULL for\r
	325	the driver itself.\r
	326	@param[in] CallBack Function to call when receive finished.\r
	327	@param[in] Context Opaque parameter to the callback.\r
	328	\r
	329	@retval EFI_ALREADY_STARTED There is already a pending receive request.\r
	330	@retval EFI_OUT_OF_RESOURCES Failed to allocate resource to receive.\r
	331	@retval EFI_SUCCESS The recieve request has been started.\r
	332	@retval other Other error occurs.\r
	333	\r
	334	**/\r
	335	EFI_STATUS\r
	336	Ip4ReceiveFrame (\r
	337	IN IP4_INTERFACE *Interface,\r
	338	IN IP4_PROTOCOL *IpInstance OPTIONAL,\r
	339	IN IP4_FRAME_CALLBACK CallBack,\r
	340	IN VOID *Context\r
	341	);\r
	342	\r
	343	#endif\r