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

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