/** @file\r
-\r
-Copyright (c) 2005 - 2007, Intel Corporation\r
+ IP4 input process.\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
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
-Module Name:\r
-\r
- Ip4Input.c\r
-\r
-Abstract:\r
-\r
- IP4 input process.\r
-\r
-\r
**/\r
\r
#include "Ip4Impl.h"\r
(Dst, Src, Id, Protocol). The default life for the packet is\r
120 seconds.\r
\r
- @param Dst The destination address\r
- @param Src The source address\r
- @param Id The ID field in IP header\r
- @param Protocol The protocol field in IP header\r
+ @param[in] Dst The destination address\r
+ @param[in] Src The source address\r
+ @param[in] Id The ID field in IP header\r
+ @param[in] Protocol The protocol field in IP header\r
\r
@return NULL if failed to allocate memory for the entry, otherwise\r
- @return the point to just created reassemble entry.\r
+ the point to just created reassemble entry.\r
\r
**/\r
IP4_ASSEMBLE_ENTRY *\r
/**\r
Release all the fragments of a packet, then free the assemble entry.\r
\r
- @param Assemble The assemble entry to free\r
-\r
- @return None\r
+ @param[in] Assemble The assemble entry to free\r
\r
**/\r
VOID\r
Initialize an already allocated assemble table. This is generally\r
the assemble table embedded in the IP4 service instance.\r
\r
- @param Table The assemble table to initialize.\r
-\r
- @return NONE\r
+ @param[in, out] Table The assemble table to initialize.\r
\r
**/\r
VOID\r
Clean up the assemble table: remove all the fragments\r
and assemble entries.\r
\r
- @param Table The assemble table to clean up\r
-\r
- @return None\r
+ @param[in] Table The assemble table to clean up\r
\r
**/\r
VOID\r
@param Start The sequence of the first byte to fit in\r
@param End One beyond the sequence of last byte to fit in.\r
\r
- @return None\r
-\r
**/\r
VOID\r
Ip4TrimPacket (\r
the assembled packet's OnFree. It will free the assemble entry,\r
which in turn will free all the fragments of the packet.\r
\r
- @param Arg The assemble entry to free\r
-\r
- @return None\r
+ @param[in] Arg The assemble entry to free\r
\r
**/\r
VOID\r
The IP4 input routine. It is called by the IP4_INTERFACE when a\r
IP4 fragment is received from MNP.\r
\r
- @param Ip4Instance The IP4 child that request the receive, most like\r
+ @param[in] Ip4Instance The IP4 child that request the receive, most like\r
it is NULL.\r
- @param Packet The IP4 packet received.\r
- @param IoStatus The return status of receive request.\r
- @param Flag The link layer flag for the packet received, such\r
+ @param[in] Packet The IP4 packet received.\r
+ @param[in] IoStatus The return status of receive request.\r
+ @param[in] Flag The link layer flag for the packet received, such\r
as multicast.\r
- @param Context The IP4 service instance that own the MNP.\r
-\r
- @return None\r
+ @param[in] Context The IP4 service instance that own the MNP.\r
\r
**/\r
VOID\r
/**\r
Check whether this IP child accepts the packet.\r
\r
- @param IpInstance The IP child to check\r
- @param Head The IP header of the packet\r
- @param Packet The data of the packet\r
+ @param[in] IpInstance The IP child to check\r
+ @param[in] Head The IP header of the packet\r
+ @param[in] Packet The data of the packet\r
\r
@retval TRUE If the child wants to receive the packet.\r
@retval FALSE Otherwise.\r
packet is acceptable to it. Here the data of the packet is\r
shared, but the net buffer isn't.\r
\r
- @param IpInstance The IP4 child to enqueue the packet to\r
- @param Head The IP header of the received packet\r
- @param Packet The data of the received packet\r
+ @param[in] IpInstance The IP4 child to enqueue the packet to\r
+ @param[in] Head The IP header of the received packet\r
+ @param[in] Packet The data of the received packet\r
\r
@retval EFI_NOT_STARTED The IP child hasn't been configured.\r
@retval EFI_INVALID_PARAMETER The child doesn't want to receive the packet\r
The signal handle of IP4's recycle event. It is called back\r
when the upper layer release the packet.\r
\r
- @param Event The IP4's recycle event.\r
- @param Context The context of the handle, which is a\r
- IP4_RXDATA_WRAP\r
-\r
- @return None\r
+ @param Event The IP4's recycle event.\r
+ @param Context The context of the handle, which is a\r
+ IP4_RXDATA_WRAP\r
\r
**/\r
VOID\r
to the upper layer. Upper layer will signal the recycle event in\r
it when it is done with the packet.\r
\r
- @param IpInstance The IP4 child to receive the packet\r
- @param Packet The packet to deliver up.\r
+ @param[in] IpInstance The IP4 child to receive the packet\r
+ @param[in] Packet The packet to deliver up.\r
\r
- @return NULL if failed to wrap the packet, otherwise the wrapper.\r
+ @retval Wrap if warp the packet succeed.\r
+ @retval NULL failed to wrap the packet .\r
\r
**/\r
IP4_RXDATA_WRAP *\r
duplicate it to a non-shared packet, release the shared packet, then\r
deliver the non-shared packet up.\r
\r
- @param IpInstance The IP child to deliver the packet up.\r
+ @param[in] IpInstance The IP child to deliver the packet up.\r
\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate resources to deliver the\r
packets.\r
Enqueue a received packet to all the IP children that share\r
the same interface.\r
\r
- @param IpSb The IP4 service instance that receive the packet\r
- @param Head The header of the received packet\r
- @param Packet The data of the received packet\r
- @param IpIf The interface to enqueue the packet to\r
+ @param[in] IpSb The IP4 service instance that receive the packet\r
+ @param[in] Head The header of the received packet\r
+ @param[in] Packet The data of the received packet\r
+ @param[in] IpIf The interface to enqueue the packet to\r
\r
@return The number of the IP4 children that accepts the packet\r
\r
/**\r
Deliver the packet for each IP4 child on the interface.\r
\r
- @param IpSb The IP4 service instance that received the packet\r
- @param IpIf The IP4 interface to deliver the packet.\r
+ @param[in] IpSb The IP4 service instance that received the packet\r
+ @param[in] IpIf The IP4 interface to deliver the packet.\r
\r
@retval EFI_SUCCESS It always returns EFI_SUCCESS now\r
\r
child wants to consume the packet because each IP child needs\r
its own copy of the packet to make changes.\r
\r
- @param IpSb The IP4 service instance that received the packet\r
- @param Head The header of the received packet\r
- @param Packet The data of the received packet\r
+ @param[in] IpSb The IP4 service instance that received the packet\r
+ @param[in] Head The header of the received packet\r
+ @param[in] Packet The data of the received packet\r
\r
@retval EFI_NOT_FOUND No IP child accepts the packet\r
@retval EFI_SUCCESS The packet is enqueued or delivered to some IP\r
/**\r
Timeout the fragment and enqueued packets.\r
\r
- @param IpSb The IP4 service instance to timeout\r
-\r
- @return None\r
+ @param[in] IpSb The IP4 service instance to timeout\r
\r
**/\r
VOID\r
projects / mirror_edk2.git / blobdiff