/** @file\r
\r
-Copyright (c) 2005 - 2006, Intel Corporation\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
-\r
-Module Name:\r
-\r
- Ip4Route.c\r
-\r
-Abstract:\r
-\r
-\r
**/\r
\r
#include "Ip4Impl.h"\r
Allocate a route entry then initialize it with the Dest/Netmaks\r
and Gateway.\r
\r
- @param Dest The destination network\r
- @param Netmask The destination network mask\r
- @param GateWay The nexthop address\r
+ @param[in] Dest The destination network\r
+ @param[in] Netmask The destination network mask\r
+ @param[in] GateWay The nexthop address\r
\r
@return NULL if failed to allocate memeory, otherwise the newly created\r
route entry.\r
\r
@param RtEntry The route entry to free.\r
\r
- @return NONE\r
-\r
**/\r
VOID\r
Ip4FreeRouteEntry (\r
/**\r
Allocate and initialize an IP4 route cache entry.\r
\r
- @param Dst The destination address\r
- @param Src The source address\r
- @param GateWay The next hop address\r
- @param Tag The tag from the caller. This marks all the cache\r
- entries spawned from one route table entry.\r
+ @param[in] Dst The destination address\r
+ @param[in] Src The source address\r
+ @param[in] GateWay The next hop address\r
+ @param[in] Tag The tag from the caller. This marks all the cache\r
+ entries spawned from one route table entry.\r
\r
@return NULL if failed to allocate memory for the cache, other point\r
to the created route cache entry.\r
\r
@param RtCacheEntry The route cache entry to free.\r
\r
- @return None\r
-\r
**/\r
VOID\r
Ip4FreeRouteCacheEntry (\r
/**\r
Initialize an empty route cache table.\r
\r
- @param RtCache The rotue cache table to initialize.\r
-\r
- @return NONE\r
+ @param[in, out] RtCache The rotue cache table to initialize.\r
\r
**/\r
VOID\r
Clean up a route cache, that is free all the route cache\r
entries enqueued in the cache.\r
\r
- @param RtCache The route cache table to clean up\r
-\r
- @return None\r
+ @param[in] RtCache The route cache table to clean up\r
\r
**/\r
VOID\r
Free the route table and its associated route cache. Route\r
table is reference counted.\r
\r
- @param RtTable The route table to free.\r
-\r
- @return None\r
+ @param[in] RtTable The route table to free.\r
\r
**/\r
VOID\r
@param RtCache Route cache to remove the entries from\r
@param Tag The Tag of the entries to remove\r
\r
- @return None\r
-\r
**/\r
VOID\r
Ip4PurgeRouteCache (\r
Add a route entry to the route table. All the IP4_ADDRs are in\r
host byte order.\r
\r
- @param RtTable Route table to add route to\r
- @param Dest The destination of the network\r
- @param Netmask The netmask of the destination\r
- @param Gateway The next hop address\r
+ @param[in, out] RtTable Route table to add route to\r
+ @param[in] Dest The destination of the network\r
+ @param[in] Netmask The netmask of the destination\r
+ @param[in] Gateway The next hop address\r
\r
@retval EFI_ACCESS_DENIED The same route already exists\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the entry\r
/**\r
Remove a route entry and all the route caches spawn from it.\r
\r
- @param RtTable The route table to remove the route from\r
- @param Dest The destination network\r
- @param Netmask The netmask of the Dest\r
- @param Gateway The next hop address\r
+ @param RtTable The route table to remove the route from\r
+ @param Dest The destination network\r
+ @param Netmask The netmask of the Dest\r
+ @param Gateway The next hop address\r
\r
@retval EFI_SUCCESS The route entry is successfully removed\r
@retval EFI_NOT_FOUND There is no route entry in the table with that\r
host redirect according to RFC1122. So, only route cache entries\r
are modified according to the ICMP redirect message.\r
\r
- @param RtTable The route table to search the cache for\r
- @param Dest The destination address\r
- @param Src The source address\r
+ @param[in] RtTable The route table to search the cache for\r
+ @param[in] Dest The destination address\r
+ @param[in] Src The source address\r
\r
@return NULL if no route entry to the (Dest, Src). Otherwise the point\r
to the correct route cache entry.\r
1. IP search the route table for a most specific match\r
2. The local route entries have precedence over the default route entry.\r
\r
- @param RtTable The route table to search from\r
- @param Dst The destionation address to search\r
+ @param[in] RtTable The route table to search from\r
+ @param[in] Dst The destionation address to search\r
\r
@return NULL if no route matches the Dst, otherwise the point to the\r
- @return most specific route to the Dst.\r
+ most specific route to the Dst.\r
\r
**/\r
IP4_ROUTE_ENTRY *\r
Search the route table to route the packet. Return/create a route\r
cache if there is a route to the destination.\r
\r
- @param RtTable The route table to search from\r
- @param Dest The destination address to search for\r
- @param Src The source address to search for\r
+ @param[in] RtTable The route table to search from\r
+ @param[in] Dest The destination address to search for\r
+ @param[in] Src The source address to search for\r
\r
@return NULL if failed to route packet, otherwise a route cache\r
entry that can be used to route packet.\r
GetModeData. The EFI_IP4_ROUTE_TABLE is clumsy to use in the\r
internal operation of the IP4 driver.\r
\r
- @param IpInstance The IP4 child that requests the route table.\r
+ @param[in] IpInstance The IP4 child that requests the route table.\r
\r
@retval EFI_SUCCESS The route table is successfully build\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the rotue table.\r
projects / mirror_edk2.git / blobdiff