summaryrefslogtreecommitdiff
path: root/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4If.c
diff options
context:
space:
mode:
authorjgong5 <jgong5@6f19259b-4bc3-4df7-8a09-765794883524>2008-11-18 09:29:44 +0000
committerjgong5 <jgong5@6f19259b-4bc3-4df7-8a09-765794883524>2008-11-18 09:29:44 +0000
commit2ff2921247ab4cf5eaa6a0b0358a531e6bfacbcb (patch)
tree002aedad428646a70122252e810c86b42a54f779 /MdeModulePkg/Universal/Network/Ip4Dxe/Ip4If.c
parentd9ef3b7dc43a48bf563689ed9fc107c19928048f (diff)
downloadedk2-2ff2921247ab4cf5eaa6a0b0358a531e6bfacbcb.zip
edk2-2ff2921247ab4cf5eaa6a0b0358a531e6bfacbcb.tar.gz
edk2-2ff2921247ab4cf5eaa6a0b0358a531e6bfacbcb.tar.bz2
synced function header
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6595 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdeModulePkg/Universal/Network/Ip4Dxe/Ip4If.c')
-rw-r--r--MdeModulePkg/Universal/Network/Ip4Dxe/Ip4If.c113
1 files changed, 91 insertions, 22 deletions
diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4If.c b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4If.c
index dfd5840..1a47fa9 100644
--- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4If.c
+++ b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4If.c
@@ -29,25 +29,64 @@ Abstract:
//
EFI_MAC_ADDRESS mZeroMacAddress;
+/**
+ Callback funtion when frame transmission is finished. It will
+ call the frame owner's callback function to tell it the result.
+
+ @param Context Context which is point to the token.
+
+ @return None.
+
+**/
VOID
EFIAPI
Ip4OnFrameSentDpc (
- IN VOID *Context
+ IN VOID *Context
);
+/**
+ Request Ip4OnFrameSentDpc as a DPC at TPL_CALLBACK.
+
+ @param Event The transmit token's event.
+ @param Context Context which is point to the token.
+
+ @return None
+
+**/
VOID
EFIAPI
Ip4OnFrameSent (
- IN EFI_EVENT Event,
- IN VOID *Context
+ IN EFI_EVENT Event,
+ IN VOID *Context
);
+/**
+ Callback function when ARP request are finished. It will cancelled
+ all the queued frame if the ARP requests failed. Or transmit them
+ if the request succeed.
+
+ @param Context The context of the callback, a point to the ARP
+ queue
+
+ @return None
+
+**/
VOID
EFIAPI
Ip4OnArpResolvedDpc (
IN VOID *Context
);
+/**
+ Request Ip4OnArpResolvedDpc as a DPC at TPL_CALLBACK.
+
+ @param Event The Arp request event.
+ @param Context The context of the callback, a point to the ARP
+ queue.
+
+ @return None
+
+**/
VOID
EFIAPI
Ip4OnArpResolved (
@@ -55,19 +94,55 @@ Ip4OnArpResolved (
IN VOID *Context
);
+/**
+ Received a frame from MNP, wrap it in net buffer then deliver
+ it to IP's input function. The ownship of the packet also
+ transferred to IP. When Ip is finished with this packet, it
+ will call NetbufFree to release the packet, NetbufFree will
+ again call the Ip4RecycleFrame to signal MNP's event and free
+ the token used.
+
+ @param Context Context for the callback.
+
+ @return None.
+
+**/
VOID
EFIAPI
Ip4OnFrameReceivedDpc (
- IN VOID *Context
+ IN VOID *Context
);
+/**
+
+ Request Ip4OnFrameReceivedDpc as a DPC at TPL_CALLBACK.
+
+ @param Event The receive event delivered to MNP for receive.
+ @param Context Context for the callback.
+
+ @return None.
+
+**/
VOID
EFIAPI
Ip4OnFrameReceived (
- IN EFI_EVENT Event,
- IN VOID *Context
+ IN EFI_EVENT Event,
+ IN VOID *Context
);
+/**
+ Remove all the frames on the ARP queue that pass the FrameToCancel,
+ that is, either FrameToCancel is NULL or it returns true for the frame.
+
+ @param ArpQue ARP frame to remove the frames from.
+ @param IoStatus The status returned to the cancelled frames'
+ callback function.
+ @param FrameToCancel Function to select which frame to cancel.
+ @param Context Opaque parameter to the FrameToCancel.
+
+ @return NONE
+
+**/
VOID
Ip4CancelFrameArp (
IN IP4_ARP_QUE *ArpQue,
@@ -1142,28 +1217,22 @@ Ip4OnFrameReceivedDpc (
Token->CallBack (Token->IpInstance, Packet, EFI_SUCCESS, Flag, Token->Context);
}
+/**
+
+ Request Ip4OnFrameReceivedDpc as a DPC at TPL_CALLBACK.
+
+ @param Event The receive event delivered to MNP for receive.
+ @param Context Context for the callback.
+
+ @return None.
+
+**/
VOID
EFIAPI
Ip4OnFrameReceived (
IN EFI_EVENT Event,
IN VOID *Context
)
-/*++
-
-Routine Description:
-
- Request Ip4OnFrameReceivedDpc as a DPC at TPL_CALLBACK
-
-Arguments:
-
- Event - The receive event delivered to MNP for receive.
- Context - Context for the callback.
-
-Returns:
-
- None.
-
---*/
{
//
// Request Ip4OnFrameReceivedDpc as a DPC at TPL_CALLBACK