/** @file\r
\r
-Copyright (c) 2005 - 2007, Intel Corporation\r
+Copyright (c) 2005 - 2009, 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
- Ip4Impl.c\r
-\r
-Abstract:\r
-\r
-\r
**/\r
\r
#include "Ip4Impl.h"\r
function is used optionally to retrieve the operational mode data of underlying\r
networks or drivers.\r
\r
- @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
- @param Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure.\r
- @param MnpConfigData Pointer to the managed network configuration data structure.\r
- @param SnpModeData Pointer to the simple network mode data structure.\r
+ @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param[out] Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure.\r
+ @param[out] MnpConfigData Pointer to the managed network configuration data structure.\r
+ @param[out] SnpModeData Pointer to the simple network mode data structure.\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_INVALID_PARAMETER This is NULL.\r
EFIAPI\r
EfiIp4GetModeData (\r
IN CONST EFI_IP4_PROTOCOL *This,\r
- OUT EFI_IP4_MODE_DATA *Ip4ModeData, OPTIONAL\r
- OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData, OPTIONAL\r
+ OUT EFI_IP4_MODE_DATA *Ip4ModeData OPTIONAL,\r
+ OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL,\r
OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL\r
);\r
\r
requests will be cancelled. Their completion token status will be set to EFI_ABORTED\r
and their events will be signaled.\r
\r
- @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
- @param IpConfigData Pointer to the EFI IPv4 Protocol configuration data structure.\r
+ @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param[in] IpConfigData Pointer to the EFI IPv4 Protocol configuration data structure.\r
\r
@retval EFI_SUCCESS The driver instance was successfully opened.\r
@retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
\r
If JoinFlag is FALSE and GroupAddress is NULL, all joined groups will be left.\r
\r
- @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
- @param JoinFlag Set to TRUE to join the multicast group session and FALSE to leave.\r
- @param GroupAddress Pointer to the IPv4 multicast address.\r
+ @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param[in] JoinFlag Set to TRUE to join the multicast group session and FALSE to leave.\r
+ @param[in] GroupAddress Pointer to the IPv4 multicast address.\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_INVALID_PARAMETER One or more of the following is TRUE:\r
copies will be updated whenever the EIF IPv4 Protocol driver reconfigures its\r
instances. As a result, client modification to the routing table will be lost.\r
\r
- @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
- @param DeleteRoute Set to TRUE to delete this route from the routing table. Set to\r
- FALSE to add this route to the routing table. SubnetAddress\r
- and SubnetMask are used as the key to each route entry.\r
- @param SubnetAddress The address of the subnet that needs to be routed.\r
- @param SubnetMask The subnet mask of SubnetAddress.\r
- @param GatewayAddress The unicast gateway IPv4 address for this route.\r
+ @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param[in] DeleteRoute Set to TRUE to delete this route from the routing table. Set to\r
+ FALSE to add this route to the routing table. SubnetAddress\r
+ and SubnetMask are used as the key to each route entry.\r
+ @param[in] SubnetAddress The address of the subnet that needs to be routed.\r
+ @param[in] SubnetMask The subnet mask of SubnetAddress.\r
+ @param[in] GatewayAddress The unicast gateway IPv4 address for this route.\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_NOT_STARTED The driver instance has not been started.\r
EFI IPv4 Protocol instance. Whenever the packet in the token is sent out or some\r
errors occur, the event in the token will be signaled and the status is updated.\r
\r
- @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
- @param Token Pointer to the transmit token.\r
+ @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param[in] Token Pointer to the transmit token.\r
\r
@retval EFI_SUCCESS The data has been queued for transmission.\r
@retval EFI_NOT_STARTED This instance has not been started.\r
driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event\r
is signaled.\r
\r
- @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
- @param Token Pointer to a token that is associated with the receive data descriptor.\r
+ @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param[in] Token Pointer to a token that is associated with the receive data descriptor.\r
\r
@retval EFI_SUCCESS The receive completion token was cached.\r
@retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.\r
asynchronous operation has completed, this function will not signal the token\r
and EFI_NOT_FOUND is returned.\r
\r
- @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
- @param Token Pointer to a token that has been issued by\r
- EFI_IP4_PROTOCOL.Transmit() or\r
- EFI_IP4_PROTOCOL.Receive(). If NULL, all pending\r
- tokens are aborted. Type EFI_IP4_COMPLETION_TOKEN is\r
- defined in EFI_IP4_PROTOCOL.Transmit().\r
+ @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param[in] Token Pointer to a token that has been issued by\r
+ EFI_IP4_PROTOCOL.Transmit() or\r
+ EFI_IP4_PROTOCOL.Receive(). If NULL, all pending\r
+ tokens are aborted. Type EFI_IP4_COMPLETION_TOKEN is\r
+ defined in EFI_IP4_PROTOCOL.Transmit().\r
\r
@retval EFI_SUCCESS The asynchronous I/O request was aborted and\r
Token.->Event was signaled. When Token is NULL, all\r
experiencing packet loss should try calling the EFI_IP4_PROTOCOL.Poll() function\r
more often.\r
\r
- @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
\r
@retval EFI_SUCCESS Incoming or outgoing data was processed.\r
@retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.\r
function is used optionally to retrieve the operational mode data of underlying\r
networks or drivers.\r
\r
- @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
- @param Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure.\r
- @param MnpConfigData Pointer to the managed network configuration data structure.\r
- @param SnpModeData Pointer to the simple network mode data structure.\r
+ @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param[out] Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure.\r
+ @param[out] MnpConfigData Pointer to the managed network configuration data structure.\r
+ @param[out] SnpModeData Pointer to the simple network mode data structure.\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_INVALID_PARAMETER This is NULL.\r
EFIAPI\r
EfiIp4GetModeData (\r
IN CONST EFI_IP4_PROTOCOL *This,\r
- OUT EFI_IP4_MODE_DATA *Ip4ModeData, OPTIONAL\r
- OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData, OPTIONAL\r
+ OUT EFI_IP4_MODE_DATA *Ip4ModeData OPTIONAL,\r
+ OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL,\r
OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL\r
)\r
{\r
reconfigure the MNP. If Force is TRUE, the MNP is configured no\r
matter whether that is changed or not.\r
\r
- @param IpSb The IP4 service instance that is to be changed.\r
- @param Force Force the configuration or not.\r
+ @param[in] IpSb The IP4 service instance that is to be changed.\r
+ @param[in] Force Force the configuration or not.\r
\r
@retval EFI_SUCCESS The MNP is successfully configured/reconfigured.\r
@retval Others Configuration failed.\r
it will configure the default interface and default route table\r
with the configuration information retrieved by IP4_CONFIGURE.\r
\r
- @param Context The IP4 service binding instance.\r
-\r
- @return None\r
+ @param[in] Context The IP4 service binding instance.\r
\r
**/\r
VOID\r
gBS->FreePool (Data);\r
}\r
\r
-/*++\r
+/**\r
Request Ip4AutoConfigCallBackDpc as a DPC at TPL_CALLBACK.\r
\r
@param Event The event that is signalled.\r
@param Context The IP4 service binding instance.\r
- \r
- @return None.\r
\r
-++*/\r
+**/\r
VOID\r
EFIAPI\r
Ip4AutoConfigCallBack (\r
//\r
// Request Ip4AutoConfigCallBackDpc as a DPC at TPL_CALLBACK\r
//\r
- NetLibQueueDpc (TPL_CALLBACK, Ip4AutoConfigCallBackDpc, Context);\r
+ QueueDpc (TPL_CALLBACK, Ip4AutoConfigCallBackDpc, Context);\r
}\r
\r
\r
It will locates the EFI_IP4_CONFIG_PROTOCOL, then start the\r
auto configuration.\r
\r
- @param IpSb The IP4 service instance to configure\r
+ @param[in] IpSb The IP4 service instance to configure\r
\r
@retval EFI_SUCCESS The auto configuration is successfull started\r
@retval Others Failed to start auto configuration.\r
@param IpSb The IP4 service instance.\r
@param IpInstance The IP4 child instance.\r
\r
- @return None\r
-\r
**/\r
VOID\r
Ip4InitProtocol (\r
for the first time. The caller should validate the configuration\r
before deliver them to it. It also don't do configure NULL.\r
\r
- @param IpInstance The IP4 child to configure.\r
- @param Config The configure data.\r
+ @param[in, out] IpInstance The IP4 child to configure.\r
+ @param[in] Config The configure data.\r
\r
@retval EFI_SUCCESS The IP4 child is successfully configured.\r
@retval EFI_DEVICE_ERROR Failed to free the pending transive or to\r
/**\r
Clean up the IP4 child, release all the resources used by it.\r
\r
- @param IpInstance The IP4 child to clean up.\r
+ @param[in] IpInstance The IP4 child to clean up.\r
\r
@retval EFI_SUCCESS The IP4 child is cleaned up\r
@retval EFI_DEVICE_ERROR Some resources failed to be released\r
address. Only continuous netmasks are supported. and check\r
that StationAddress is a unicast address on the newtwork.\r
\r
- @param Ip The IP address to validate\r
- @param Netmask The netmaks of the IP\r
+ @param[in] Ip The IP address to validate\r
+ @param[in] Netmask The netmaks of the IP\r
\r
@retval TRUE The Ip/Netmask pair is valid\r
@retval FALSE The Ip/Netmask pair is invalid\r
requests will be cancelled. Their completion token status will be set to EFI_ABORTED\r
and their events will be signaled.\r
\r
- @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
- @param IpConfigData Pointer to the EFI IPv4 Protocol configuration data structure.\r
+ @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param[in] IpConfigData Pointer to the EFI IPv4 Protocol configuration data structure.\r
\r
@retval EFI_SUCCESS The driver instance was successfully opened.\r
@retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
Change the IP4 child's multicast setting. The caller\r
should make sure that the parameters is valid.\r
\r
- @param IpInstance The IP4 child to change the setting.\r
- @param JoinFlag TRUE to join the group, otherwise leave it\r
- @param GroupAddress The target group address\r
+ @param[in] IpInstance The IP4 child to change the setting.\r
+ @param[in] JoinFlag TRUE to join the group, otherwise leave it\r
+ @param[in] GroupAddress The target group address\r
\r
@retval EFI_ALREADY_STARTED Want to join the group, but already a member of it\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate some resources.\r
// host byte order\r
//\r
if (JoinFlag) {\r
+ // \r
+ // When JoinFlag is TRUE, GroupAddress shouldn't be NULL.\r
+ //\r
+ ASSERT (GroupAddress != NULL);\r
CopyMem (&Group, GroupAddress, sizeof (IP4_ADDR));\r
\r
for (Index = 0; Index < IpInstance->GroupCount; Index++) {\r
\r
If JoinFlag is FALSE and GroupAddress is NULL, all joined groups will be left.\r
\r
- @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
- @param JoinFlag Set to TRUE to join the multicast group session and FALSE to leave.\r
- @param GroupAddress Pointer to the IPv4 multicast address.\r
+ @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param[in] JoinFlag Set to TRUE to join the multicast group session and FALSE to leave.\r
+ @param[in] GroupAddress Pointer to the IPv4 multicast address.\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_INVALID_PARAMETER One or more of the following is TRUE:\r
copies will be updated whenever the EIF IPv4 Protocol driver reconfigures its\r
instances. As a result, client modification to the routing table will be lost.\r
\r
- @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
- @param DeleteRoute Set to TRUE to delete this route from the routing table. Set to\r
- FALSE to add this route to the routing table. SubnetAddress\r
- and SubnetMask are used as the key to each route entry.\r
- @param SubnetAddress The address of the subnet that needs to be routed.\r
- @param SubnetMask The subnet mask of SubnetAddress.\r
- @param GatewayAddress The unicast gateway IPv4 address for this route.\r
+ @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param[in] DeleteRoute Set to TRUE to delete this route from the routing table. Set to\r
+ FALSE to add this route to the routing table. SubnetAddress\r
+ and SubnetMask are used as the key to each route entry.\r
+ @param[in] SubnetAddress The address of the subnet that needs to be routed.\r
+ @param[in] SubnetMask The subnet mask of SubnetAddress.\r
+ @param[in] GatewayAddress The unicast gateway IPv4 address for this route.\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_NOT_STARTED The driver instance has not been started.\r
Check whether the user's token or event has already\r
been enqueued on IP4's list.\r
\r
- @param Map The container of either user's transmit or receive\r
- token.\r
- @param Item Current item to check against\r
- @param Context The Token to check againist.\r
+ @param[in] Map The container of either user's transmit or receive\r
+ token.\r
+ @param[in] Item Current item to check against\r
+ @param[in] Context The Token to check againist.\r
\r
@retval EFI_ACCESS_DENIED The token or event has already been enqueued in IP\r
@retval EFI_SUCCESS The current item isn't the same token/event as the\r
/**\r
Validate the user's token against current station address.\r
\r
- @param Token User's token to validate\r
- @param IpIf The IP4 child's interface.\r
+ @param[in] Token User's token to validate\r
+ @param[in] IpIf The IP4 child's interface.\r
\r
@retval EFI_INVALID_PARAMETER Some parameters are invalid\r
@retval EFI_BAD_BUFFER_SIZE The user's option/data is too long.\r
are bound together. Check the comments in Ip4Output for information\r
about IP fragmentation.\r
\r
- @param Context The token's wrap\r
-\r
- @return None\r
+ @param[in] Context The token's wrap\r
\r
**/\r
VOID\r
//\r
// Dispatch the DPC queued by the NotifyFunction of Token->Event.\r
//\r
- NetLibDispatchDpc ();\r
+ DispatchDpc ();\r
}\r
\r
gBS->FreePool (Wrap);\r
@param Flag Not used during transmission\r
@param Context The token's wrap.\r
\r
- @return None\r
-\r
**/\r
VOID\r
Ip4OnPacketSent (\r
EFI IPv4 Protocol instance. Whenever the packet in the token is sent out or some\r
errors occur, the event in the token will be signaled and the status is updated.\r
\r
- @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
- @param Token Pointer to the transmit token.\r
+ @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param[in] Token Pointer to the transmit token.\r
\r
@retval EFI_SUCCESS The data has been queued for transmission.\r
@retval EFI_NOT_STARTED This instance has not been started.\r
driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event\r
is signaled.\r
\r
- @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
- @param Token Pointer to a token that is associated with the receive data descriptor.\r
+ @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param[in] Token Pointer to a token that is associated with the receive data descriptor.\r
\r
@retval EFI_SUCCESS The receive completion token was cached.\r
@retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.\r
// Dispatch the DPC queued by the NotifyFunction of this instane's receive\r
// event.\r
//\r
- NetLibDispatchDpc ();\r
+ DispatchDpc ();\r
\r
ON_EXIT:\r
gBS->RestoreTPL (OldTpl);\r
Because Ip4CancelPacket and other functions are all called in\r
line, so, after Ip4CancelPacket returns, the Item has been freed.\r
\r
- @param Map The IP4 child's transmit queue\r
- @param Item The current transmitted packet to test.\r
- @param Context The user's token to cancel.\r
+ @param[in] Map The IP4 child's transmit queue\r
+ @param[in] Item The current transmitted packet to test.\r
+ @param[in] Context The user's token to cancel.\r
\r
@retval EFI_SUCCESS Continue to check the next Item.\r
@retval EFI_ABORTED The user's Token (Token != NULL) is cancelled.\r
Cancel the receive request. This is quiet simple, because\r
it is only enqueued in our local receive map.\r
\r
- @param Map The IP4 child's receive queue\r
- @param Item Current receive request to cancel.\r
- @param Context The user's token to cancel\r
+ @param[in] Map The IP4 child's receive queue\r
+ @param[in] Item Current receive request to cancel.\r
+ @param[in] Context The user's token to cancel\r
\r
@retval EFI_SUCCESS Continue to check the next receive request on the\r
queue.\r
/**\r
Cancel the user's receive/transmit request.\r
\r
- @param IpInstance The IP4 child\r
- @param Token The token to cancel. If NULL, all token will be\r
+ @param[in] IpInstance The IP4 child\r
+ @param[in] Token The token to cancel. If NULL, all token will be\r
cancelled.\r
\r
@retval EFI_SUCCESS The token is cancelled\r
// Dispatch the DPCs queued by the NotifyFunction of the canceled rx token's\r
// events.\r
//\r
- NetLibDispatchDpc ();\r
+ DispatchDpc ();\r
if (EFI_ERROR (Status)) {\r
if ((Token != NULL) && (Status == EFI_ABORTED)) {\r
return EFI_SUCCESS;\r
asynchronous operation has completed, this function will not signal the token\r
and EFI_NOT_FOUND is returned.\r
\r
- @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
- @param Token Pointer to a token that has been issued by\r
- EFI_IP4_PROTOCOL.Transmit() or\r
- EFI_IP4_PROTOCOL.Receive(). If NULL, all pending\r
- tokens are aborted. Type EFI_IP4_COMPLETION_TOKEN is\r
- defined in EFI_IP4_PROTOCOL.Transmit().\r
+ @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param[in] Token Pointer to a token that has been issued by\r
+ EFI_IP4_PROTOCOL.Transmit() or\r
+ EFI_IP4_PROTOCOL.Receive(). If NULL, all pending\r
+ tokens are aborted. Type EFI_IP4_COMPLETION_TOKEN is\r
+ defined in EFI_IP4_PROTOCOL.Transmit().\r
\r
@retval EFI_SUCCESS The asynchronous I/O request was aborted and\r
Token.->Event was signaled. When Token is NULL, all\r
experiencing packet loss should try calling the EFI_IP4_PROTOCOL.Poll() function\r
more often.\r
\r
- @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r
\r
@retval EFI_SUCCESS Incoming or outgoing data was processed.\r
@retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.\r
received-but-not-delivered and transmitted-but-not-recycle\r
packets.\r
\r
- @param Map The IP4 child's transmit map.\r
- @param Item Current transmitted packet\r
- @param Context Not used.\r
+ @param[in] Map The IP4 child's transmit map.\r
+ @param[in] Item Current transmitted packet\r
+ @param[in] Context Not used.\r
\r
@retval EFI_SUCCESS Always returns EFI_SUCCESS\r
\r
transmitted-but-not-recycle packets, and provides time input\r
for its IGMP protocol.\r
\r
- @param Event The IP4 service instance's heart beat timer.\r
- @param Context The IP4 service instance.\r
-\r
- @return None\r
+ @param[in] Event The IP4 service instance's heart beat timer.\r
+ @param[in] Context The IP4 service instance.\r
\r
**/\r
VOID\r
projects / mirror_edk2.git / blobdiff