/** @file\r
-\r
-Copyright (c) 2005 - 2006, Intel Corporation\r
+ Transmit the IP4 packet.\r
+ \r
+Copyright (c) 2005 - 2006, 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
- Ip4Output.c\r
-\r
-Abstract:\r
-\r
- Transmit the IP4 packet\r
-\r
-\r
**/\r
\r
#include "Ip4Impl.h"\r
Prepend an IP4 head to the Packet. It will copy the options and\r
build the IP4 header fields. Used for IP4 fragmentation.\r
\r
- @param Packet The packet to prepend IP4 header to\r
- @param Head The caller supplied header. The caller should set\r
- the following header fields: Tos, TotalLen, Id,\r
- Fragment, Ttl, Protocol, Src and Dst. All the fields\r
- are in host byte order. This function will fill in\r
- the Ver, HeadLen, and checksum.\r
- @param Option The orginal IP4 option to copy from\r
- @param OptLen The length of the IP4 option\r
+ @param Packet The packet to prepend IP4 header to\r
+ @param Head The caller supplied header. The caller should set\r
+ the following header fields: Tos, TotalLen, Id,\r
+ Fragment, Ttl, Protocol, Src and Dst. All the fields\r
+ are in host byte order. This function will fill in\r
+ the Ver, HeadLen, and checksum.\r
+ @param Option The orginal IP4 option to copy from\r
+ @param OptLen The length of the IP4 option\r
\r
@retval EFI_BAD_BUFFER_SIZE There is no enought room in the head space of\r
Packet.\r
itself, that is, not by the requests of IP4 child's consumer. Such\r
packets include the ICMP echo replies, and other ICMP error packets.\r
\r
- @param IpSb The IP4 service that wants to send the packets.\r
- @param Dst The destination of the packet\r
- @param Src The source of the packet\r
+ @param[in] IpSb The IP4 service that wants to send the packets.\r
+ @param[in] Dst The destination of the packet\r
+ @param[in] Src The source of the packet\r
\r
@return NULL if no proper interface is found, otherwise the interface that\r
can be used to send the system packet from.\r
for reference.\r
@param Context The context provided by us\r
\r
- @return None\r
-\r
**/\r
VOID\r
Ip4SysPacketSent (\r
(IpInstance == NULL). It will route the packet, fragment it,\r
then transmit all the fragments through some interface.\r
\r
- @param IpSb The IP4 service instance to transmit the packet\r
- @param IpInstance The IP4 child that issues the transmission. It is\r
+ @param[in] IpSb The IP4 service instance to transmit the packet\r
+ @param[in] IpInstance The IP4 child that issues the transmission. It is\r
NULL if the packet is from the system.\r
- @param Packet The user data to send, excluding the IP header.\r
- @param Head The caller supplied header. The caller should set\r
+ @param[in] Packet The user data to send, excluding the IP header.\r
+ @param[in] Head The caller supplied header. The caller should set\r
the following header fields: Tos, TotalLen, Id, tl,\r
Fragment, Protocol, Src and Dst. All the fields are\r
in host byte order. This function will fill in the\r
Ver, HeadLen, Fragment, and checksum. The Fragment\r
only need to include the DF flag. Ip4Output will\r
compute the MF and offset for you.\r
- @param Option The original option to append to the IP headers\r
- @param OptLen The length of the option\r
- @param GateWay The next hop address to transmit packet to.\r
+ @param[in] Option The original option to append to the IP headers\r
+ @param[in] OptLen The length of the option\r
+ @param[in] GateWay The next hop address to transmit packet to.\r
255.255.255.255 means broadcast.\r
- @param Callback The callback function to issue when transmission\r
+ @param[in] Callback The callback function to issue when transmission\r
completed.\r
- @param Context The opaque context for the callback\r
+ @param[in] Context The opaque context for the callback\r
\r
@retval EFI_NO_MAPPING There is no interface to the destination.\r
@retval EFI_NOT_FOUND There is no route to the destination\r
The filter function to find a packet and all its fragments.\r
The packet's fragments have their Context set to the packet.\r
\r
- @param Frame The frames hold by the low level interface\r
- @param Context Context to the function, which is the packet.\r
+ @param[in] Frame The frames hold by the low level interface\r
+ @param[in] Context Context to the function, which is the packet.\r
\r
@retval TRUE This is the packet to cancel or its fragments.\r
@retval FALSE This is unrelated packet.\r
@param Packet The Packet to cancel\r
@param IoStatus The status returns to the sender.\r
\r
- @return None\r
-\r
**/\r
VOID\r
Ip4CancelPacket (\r
projects / mirror_edk2.git / blobdiff