/** @file\r
\r
-Copyright (c) 2006 - 2007, Intel Corporation\r
+Copyright (c) 2006 - 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
- ComponentName.c\r
-\r
-Abstract:\r
-\r
-\r
**/\r
\r
\r
by This does not support the language specified by Language,\r
then EFI_UNSUPPORTED is returned.\r
\r
- @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
+ @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
EFI_COMPONENT_NAME_PROTOCOL instance.\r
\r
- @param Language[in] A pointer to a Null-terminated ASCII string\r
+ @param[in] Language A pointer to a Null-terminated ASCII string\r
array indicating the language. This is the\r
language of the driver name that the caller is\r
requesting, and it must match one of the\r
to the driver writer. Language is specified\r
in RFC 3066 or ISO 639-2 language code format.\r
\r
- @param DriverName[out] A pointer to the Unicode string to return.\r
+ @param[out] DriverName A pointer to the Unicode string to return.\r
This Unicode string is the name of the\r
driver specified by This in the language\r
specified by Language.\r
then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r
support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
\r
- @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
+ @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
EFI_COMPONENT_NAME_PROTOCOL instance.\r
\r
- @param ControllerHandle[in] The handle of a controller that the driver\r
+ @param[in] ControllerHandle The handle of a controller that the driver\r
specified by This is managing. This handle\r
specifies the controller whose name is to be\r
returned.\r
\r
- @param ChildHandle[in] The handle of the child controller to retrieve\r
+ @param[in] ChildHandle The handle of the child controller to retrieve\r
the name of. This is an optional parameter that\r
may be NULL. It will be NULL for device\r
drivers. It will also be NULL for a bus drivers\r
driver that wishes to retrieve the name of a\r
child controller.\r
\r
- @param Language[in] A pointer to a Null-terminated ASCII string\r
+ @param[in] Language A pointer to a Null-terminated ASCII string\r
array indicating the language. This is the\r
language of the driver name that the caller is\r
requesting, and it must match one of the\r
to the driver writer. Language is specified in\r
RFC 3066 or ISO 639-2 language code format.\r
\r
- @param ControllerName[out] A pointer to the Unicode string to return.\r
+ @param[out] ControllerName A pointer to the Unicode string to return.\r
This Unicode string is the name of the\r
controller specified by ControllerHandle and\r
ChildHandle in the language specified by\r
by This does not support the language specified by Language,\r
then EFI_UNSUPPORTED is returned.\r
\r
- @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
+ @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
EFI_COMPONENT_NAME_PROTOCOL instance.\r
\r
- @param Language[in] A pointer to a Null-terminated ASCII string\r
+ @param[in] Language A pointer to a Null-terminated ASCII string\r
array indicating the language. This is the\r
language of the driver name that the caller is\r
requesting, and it must match one of the\r
to the driver writer. Language is specified\r
in RFC 3066 or ISO 639-2 language code format.\r
\r
- @param DriverName[out] A pointer to the Unicode string to return.\r
+ @param[out] DriverName A pointer to the Unicode string to return.\r
This Unicode string is the name of the\r
driver specified by This in the language\r
specified by Language.\r
then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r
support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
\r
- @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
+ @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
EFI_COMPONENT_NAME_PROTOCOL instance.\r
\r
- @param ControllerHandle[in] The handle of a controller that the driver\r
+ @param[in] ControllerHandle The handle of a controller that the driver\r
specified by This is managing. This handle\r
specifies the controller whose name is to be\r
returned.\r
\r
- @param ChildHandle[in] The handle of the child controller to retrieve\r
+ @param[in] ChildHandle The handle of the child controller to retrieve\r
the name of. This is an optional parameter that\r
may be NULL. It will be NULL for device\r
drivers. It will also be NULL for a bus drivers\r
driver that wishes to retrieve the name of a\r
child controller.\r
\r
- @param Language[in] A pointer to a Null-terminated ASCII string\r
+ @param[in] Language A pointer to a Null-terminated ASCII string\r
array indicating the language. This is the\r
language of the driver name that the caller is\r
requesting, and it must match one of the\r
to the driver writer. Language is specified in\r
RFC 3066 or ISO 639-2 language code format.\r
\r
- @param ControllerName[out] A pointer to the Unicode string to return.\r
+ @param[out] ControllerName A pointer to the Unicode string to return.\r
This Unicode string is the name of the\r
controller specified by ControllerHandle and\r
ChildHandle in the language specified by\r
/** @file\r
\r
-Copyright (c) 2006 - 2008, Intel Corporation\r
+Copyright (c) 2006 - 2008, 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
- Dhcp4Driver.c\r
-\r
-Abstract:\r
-\r
-\r
**/\r
\r
#include "Dhcp4Impl.h"\r
\r
Entry point of the DHCP driver to install various protocols.\r
\r
- @param ImageHandle The firmware allocated handle for the UEFI image.\r
- @param SystemTable A pointer to the EFI System Table.\r
+ @param[in] ImageHandle The firmware allocated handle for the UEFI image.\r
+ @param[in] SystemTable A pointer to the EFI System Table.\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.\r
follow these calling restrictions. If any other agent wishes to call\r
Supported() it must also follow these calling restrictions.\r
\r
- @param This Protocol instance pointer.\r
- @param ControllerHandle Handle of device to test\r
- @param RemainingDevicePath Optional parameter use to pick a specific child\r
- device to start.\r
+ @param[in] This Protocol instance pointer.\r
+ @param[in] ControllerHandle Handle of device to test\r
+ @param[in] RemainingDevicePath Optional parameter use to pick a specific child\r
+ device to start.\r
\r
@retval EFI_SUCCESS This driver supports this device\r
@retval EFI_ALREADY_STARTED This driver is already running on this device\r
Configure the default UDP child to receive all the DHCP traffics\r
on this network interface.\r
\r
- @param UdpIo The UDP IO port to configure\r
- @param Context The context to the function\r
+ @param[in] UdpIo The UDP IO port to configure\r
+ @param[in] Context The context to the function\r
\r
@retval EFI_SUCCESS The UDP IO port is successfully configured.\r
@retval Others Failed to configure the UDP child.\r
or partly destroyed. If a resource is destroyed, it is marked as so in\r
case the destroy failed and being called again later.\r
\r
- @param DhcpSb The DHCP service instance to destory.\r
+ @param[in] DhcpSb The DHCP service instance to destory.\r
\r
@retval EFI_SUCCESS Always return success.\r
\r
/**\r
Create a new DHCP service binding instance for the controller.\r
\r
- @param Controller The controller to install DHCP service binding\r
- protocol onto\r
- @param ImageHandle The driver's image handle\r
- @param Service The variable to receive the created DHCP service\r
- instance.\r
+ @param[in] Controller The controller to install DHCP service binding\r
+ protocol onto\r
+ @param[in] ImageHandle The driver's image handle\r
+ @param[out] Service The variable to receive the created DHCP service\r
+ instance.\r
\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate resource .\r
@retval EFI_SUCCESS The DHCP service instance is created.\r
calling restrictions. If any other agent wishes to call Start() it\r
must also follow these calling restrictions.\r
\r
- @param This Protocol instance pointer.\r
- @param ControllerHandle Handle of device to bind driver to\r
- @param RemainingDevicePath Optional parameter use to pick a specific child\r
- device to start.\r
+ @param[in] This Protocol instance pointer.\r
+ @param[in] ControllerHandle Handle of device to bind driver to\r
+ @param[in] RemainingDevicePath Optional parameter use to pick a specific child\r
+ device to start.\r
\r
@retval EFI_SUCCESS This driver is added to ControllerHandle\r
@retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle\r
must follow these calling restrictions. If any other agent wishes\r
to call Stop() it must also follow these calling restrictions.\r
\r
- @param This Protocol instance pointer.\r
- @param ControllerHandle Handle of device to stop driver on\r
- @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r
- children is zero stop the entire bus driver.\r
- @param ChildHandleBuffer List of Child Handles to Stop.\r
+ @param[in] This Protocol instance pointer.\r
+ @param[in] ControllerHandle Handle of device to stop driver on\r
+ @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r
+ children is zero stop the entire bus driver.\r
+ @param[in] ChildHandleBuffer List of Child Handles to Stop.\r
\r
@retval EFI_SUCCESS This driver is removed ControllerHandle\r
@retval other This driver was not removed from this device\r
@param DhcpSb The dhcp service instance\r
@param Instance The dhcp instance to initialize\r
\r
- @return None\r
-\r
**/\r
VOID\r
DhcpInitProtocol (\r
\r
\r
/**\r
- Creates a child handle with a set of I/O services.\r
+ Creates a child handle and installs a protocol.\r
+ \r
+ The CreateChild() function installs a protocol on ChildHandle. \r
+ If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle. \r
+ If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.\r
\r
- @param This Protocol instance pointer.\r
- @param ChildHandle Pointer to the handle of the child to create. If it is NULL,\r
- then a new handle is created. If it is not NULL, then the\r
- I/O services are added to the existing child handle.\r
+ @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
+ @param ChildHandle Pointer to the handle of the child to create. If it is NULL,\r
+ then a new handle is created. If it is a pointer to an existing UEFI handle, \r
+ then the protocol is added to the existing UEFI handle.\r
\r
- @retval EFI_SUCCES The child handle was created with the I/O services\r
+ @retval EFI_SUCCES The protocol was added to ChildHandle.\r
@retval EFI_INVALID_PARAMETER ChildHandle is NULL.\r
@retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create\r
the child\r
\r
\r
/**\r
- Destroys a child handle with a set of I/O services.\r
+ Destroys a child handle with a protocol installed on it.\r
+ \r
+ The DestroyChild() function does the opposite of CreateChild(). It removes a protocol \r
+ that was installed by CreateChild() from ChildHandle. If the removed protocol is the \r
+ last protocol on ChildHandle, then ChildHandle is destroyed.\r
\r
- @param This Protocol instance pointer.\r
+ @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
@param ChildHandle Handle of the child to destroy\r
\r
- @retval EFI_SUCCES The I/O services were removed from the child handle\r
- @retval EFI_UNSUPPORTED The child handle does not support the I/O services\r
- that are being removed.\r
- @retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle.\r
- @retval EFI_ACCESS_DENIED The child handle could not be destroyed because its\r
- I/O services are being used.\r
+ @retval EFI_SUCCES The protocol was removed from ChildHandle.\r
+ @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.\r
+ @retval EFI_INVALID_PARAMETER Child handle is not a valid UEFI Handle.\r
+ @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle\r
+ because its services are being used.\r
@retval other The child handle was not destroyed\r
\r
**/\r
/** @file\r
-\r
-Copyright (c) 2006 - 2008, Intel Corporation\r
+ Header for the DHCP4 driver.\r
+ \r
+Copyright (c) 2006 - 2008, 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
- Dhcp4Driver.h\r
-\r
-Abstract:\r
-\r
- Header for the DHCP4 driver\r
-\r
-\r
**/\r
\r
#ifndef __EFI_DHCP4_DRIVER_H__\r
follow these calling restrictions. If any other agent wishes to call\r
Supported() it must also follow these calling restrictions.\r
\r
- @param This Protocol instance pointer.\r
- @param ControllerHandle Handle of device to test\r
- @param RemainingDevicePath Optional parameter use to pick a specific child\r
- device to start.\r
+ @param[in] This Protocol instance pointer.\r
+ @param[in] ControllerHandle Handle of device to test\r
+ @param[in] RemainingDevicePath Optional parameter use to pick a specific child\r
+ device to start.\r
\r
@retval EFI_SUCCESS This driver supports this device\r
@retval EFI_ALREADY_STARTED This driver is already running on this device\r
calling restrictions. If any other agent wishes to call Start() it\r
must also follow these calling restrictions.\r
\r
- @param This Protocol instance pointer.\r
- @param ControllerHandle Handle of device to bind driver to\r
- @param RemainingDevicePath Optional parameter use to pick a specific child\r
- device to start.\r
+ @param[in] This Protocol instance pointer.\r
+ @param[in] ControllerHandle Handle of device to bind driver to\r
+ @param[in] RemainingDevicePath Optional parameter use to pick a specific child\r
+ device to start.\r
\r
@retval EFI_SUCCESS This driver is added to ControllerHandle\r
@retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle\r
must follow these calling restrictions. If any other agent wishes\r
to call Stop() it must also follow these calling restrictions.\r
\r
- @param This Protocol instance pointer.\r
- @param ControllerHandle Handle of device to stop driver on\r
- @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r
- children is zero stop the entire bus driver.\r
- @param ChildHandleBuffer List of Child Handles to Stop.\r
+ @param[in] This Protocol instance pointer.\r
+ @param[in] ControllerHandle Handle of device to stop driver on\r
+ @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r
+ children is zero stop the entire bus driver.\r
+ @param[in] ChildHandleBuffer List of Child Handles to Stop.\r
\r
@retval EFI_SUCCESS This driver is removed ControllerHandle\r
@retval other This driver was not removed from this device\r
);\r
\r
/**\r
- Creates a child handle with a set of I/O services.\r
+ Creates a child handle and installs a protocol.\r
+ \r
+ The CreateChild() function installs a protocol on ChildHandle. \r
+ If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle. \r
+ If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.\r
\r
- @param This Protocol instance pointer.\r
- @param ChildHandle Pointer to the handle of the child to create. If it is NULL,\r
- then a new handle is created. If it is not NULL, then the\r
- I/O services are added to the existing child handle.\r
+ @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
+ @param ChildHandle Pointer to the handle of the child to create. If it is NULL,\r
+ then a new handle is created. If it is a pointer to an existing UEFI handle, \r
+ then the protocol is added to the existing UEFI handle.\r
\r
- @retval EFI_SUCCES The child handle was created with the I/O services\r
+ @retval EFI_SUCCES The protocol was added to ChildHandle.\r
@retval EFI_INVALID_PARAMETER ChildHandle is NULL.\r
@retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create\r
the child\r
);\r
\r
/**\r
- Destroys a child handle with a set of I/O services.\r
+ Destroys a child handle with a protocol installed on it.\r
+ \r
+ The DestroyChild() function does the opposite of CreateChild(). It removes a protocol \r
+ that was installed by CreateChild() from ChildHandle. If the removed protocol is the \r
+ last protocol on ChildHandle, then ChildHandle is destroyed.\r
\r
- @param This Protocol instance pointer.\r
+ @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
@param ChildHandle Handle of the child to destroy\r
\r
- @retval EFI_SUCCES The I/O services were removed from the child handle\r
- @retval EFI_UNSUPPORTED The child handle does not support the I/O services\r
- that are being removed.\r
- @retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle.\r
- @retval EFI_ACCESS_DENIED The child handle could not be destroyed because its\r
- I/O services are being used.\r
+ @retval EFI_SUCCES The protocol was removed from ChildHandle.\r
+ @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.\r
+ @retval EFI_INVALID_PARAMETER Child handle is not a valid UEFI Handle.\r
+ @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle\r
+ because its services are being used.\r
@retval other The child handle was not destroyed\r
\r
**/\r
/** @file\r
-\r
-Copyright (c) 2006 - 2008, Intel Corporation\r
+ This file implement the EFI_DHCP4_PROTOCOL interface.\r
+ \r
+Copyright (c) 2006 - 2008, 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
- Dhcp4Impl.c\r
-\r
-Abstract:\r
-\r
- This file implement the EFI_DHCP4_PROTOCOL interface.\r
-\r
-\r
**/\r
\r
\r
The GetModeData() function returns the current operating mode and cached data\r
packet for the EFI DHCPv4 Protocol driver.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
- @param Dhcp4ModeData Pointer to storage for the EFI_DHCP4_MODE_DATA structure.\r
+ @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
+ @param[out] Dhcp4ModeData Pointer to storage for the EFI_DHCP4_MODE_DATA structure.\r
\r
@retval EFI_SUCCESS The mode data was returned.\r
@retval EFI_INVALID_PARAMETER This is NULL.\r
wants to make it possible for another instance to configure the EFI DHCPv4 Protocol\r
driver, it must call this function with Dhcp4CfgData set to NULL.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
- @param Dhcp4CfgData Pointer to the EFI_DHCP4_CONFIG_DATA.\r
+ @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
+ @param[in] Dhcp4CfgData Pointer to the EFI_DHCP4_CONFIG_DATA.\r
\r
@retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Init or\r
Dhcp4InitReboot state, if the original state of this driver\r
by EFI_DHCP4_PROTOCOL.Configure() will be called and the user can take this\r
opportunity to control the process.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
- @param CompletionEvent If not NULL, indicates the event that will be signaled when the\r
- EFI DHCPv4 Protocol driver is transferred into the\r
- Dhcp4Bound state or when the DHCP process is aborted.\r
- EFI_DHCP4_PROTOCOL.GetModeData() can be called to\r
- check the completion status. If NULL,\r
- EFI_DHCP4_PROTOCOL.Start() will wait until the driver\r
- is transferred into the Dhcp4Bound state or the process fails.\r
+ @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
+ @param[in] CompletionEvent If not NULL, indicates the event that will be signaled when the\r
+ EFI DHCPv4 Protocol driver is transferred into the\r
+ Dhcp4Bound state or when the DHCP process is aborted.\r
+ EFI_DHCP4_PROTOCOL.GetModeData() can be called to\r
+ check the completion status. If NULL,\r
+ EFI_DHCP4_PROTOCOL.Start() will wait until the driver\r
+ is transferred into the Dhcp4Bound state or the process fails.\r
\r
@retval EFI_SUCCESS The DHCP configuration process has started, or it has completed\r
when CompletionEvent is NULL.\r
state and the previous configuration is restored. The outgoing and incoming packets\r
can be captured by the EFI_DHCP4_CALLBACK function.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
- @param RebindRequest If TRUE, this function broadcasts the request packets and enters\r
- the Dhcp4Rebinding state. Otherwise, it sends a unicast\r
- request packet and enters the Dhcp4Renewing state.\r
- @param CompletionEvent If not NULL, this event is signaled when the renew/rebind phase\r
- completes or some error occurs.\r
- EFI_DHCP4_PROTOCOL.GetModeData() can be called to\r
- check the completion status. If NULL,\r
- EFI_DHCP4_PROTOCOL.RenewRebind() will busy-wait\r
- until the DHCP process finishes.\r
+ @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
+ @param[in] RebindRequest If TRUE, this function broadcasts the request packets and enters\r
+ the Dhcp4Rebinding state. Otherwise, it sends a unicast\r
+ request packet and enters the Dhcp4Renewing state.\r
+ @param[in] CompletionEvent If not NULL, this event is signaled when the renew/rebind phase\r
+ completes or some error occurs.\r
+ EFI_DHCP4_PROTOCOL.GetModeData() can be called to\r
+ check the completion status. If NULL,\r
+ EFI_DHCP4_PROTOCOL.RenewRebind() will busy-wait\r
+ until the DHCP process finishes.\r
\r
@retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the\r
Dhcp4Renewing state or is back to the Dhcp4Bound state.\r
After a successful call to this function, the EFI DHCPv4 Protocol driver returns\r
to the Dhcp4Init state and any subsequent incoming packets will be discarded silently.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
+ @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
\r
@retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Init phase.\r
@retval EFI_INVALID_PARAMETER This is NULL.\r
before DHCP configuration process can be started again. This function can be\r
called when the EFI DHCPv4 Protocol driver is in any state.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
+ @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
\r
@retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Stopped phase.\r
@retval EFI_INVALID_PARAMETER This is NULL.\r
does not change any state of the EFI DHCPv4 Protocol driver and can be used at\r
any time.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
- @param SeedPacket Initial packet to be used as a base for building new packet.\r
- @param DeleteCount Number of opcodes in the DeleteList.\r
- @param DeleteList List of opcodes to be deleted from the seed packet.\r
- Ignored if DeleteCount is zero.\r
- @param AppendCount Number of entries in the OptionList.\r
- @param AppendList Pointer to a DHCP option list to be appended to SeedPacket.\r
- If SeedPacket also contains options in this list, they are\r
- replaced by new options (except pad option). Ignored if\r
- AppendCount is zero. Type EFI_DHCP4_PACKET_OPTION\r
- @param NewPacket Pointer to storage for the pointer to the new allocated packet.\r
- Use the EFI Boot Service FreePool() on the resulting pointer\r
- when done with the packet.\r
+ @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
+ @param[in] SeedPacket Initial packet to be used as a base for building new packet.\r
+ @param[in] DeleteCount Number of opcodes in the DeleteList.\r
+ @param[in] DeleteList List of opcodes to be deleted from the seed packet.\r
+ Ignored if DeleteCount is zero.\r
+ @param[in] AppendCount Number of entries in the OptionList.\r
+ @param[in] AppendList Pointer to a DHCP option list to be appended to SeedPacket.\r
+ If SeedPacket also contains options in this list, they are\r
+ replaced by new options (except pad option). Ignored if\r
+ AppendCount is zero. Type EFI_DHCP4_PACKET_OPTION\r
+ @param[out] NewPacket Pointer to storage for the pointer to the new allocated packet.\r
+ Use the EFI Boot Service FreePool() on the resulting pointer\r
+ when done with the packet.\r
\r
@retval EFI_SUCCESS The new packet was built.\r
@retval EFI_OUT_OF_RESOURCES Storage for the new packet could not be allocated.\r
OUT EFI_DHCP4_PACKET **NewPacket\r
);\r
\r
- /**\r
+/**\r
Transmits a DHCP formatted packet and optionally waits for responses.\r
\r
The TransmitReceive() function is used to transmit a DHCP packet and optionally\r
wait for the response from servers. This function does not change the state of\r
the EFI DHCPv4 Protocol driver and thus can be used at any time.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
- @param Token Pointer to the EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN structure.\r
+ @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
+ @param[in] Token Pointer to the EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN structure.\r
\r
@retval EFI_SUCCESS The packet was successfully queued for transmission.\r
@retval EFI_INVALID_PARAMETER Some parameter is NULL.\r
The GetModeData() function returns the current operating mode and cached data\r
packet for the EFI DHCPv4 Protocol driver.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
- @param Dhcp4ModeData Pointer to storage for the EFI_DHCP4_MODE_DATA structure.\r
+ @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
+ @param[out] Dhcp4ModeData Pointer to storage for the EFI_DHCP4_MODE_DATA structure.\r
\r
@retval EFI_SUCCESS The mode data was returned.\r
@retval EFI_INVALID_PARAMETER This is NULL.\r
\r
@param Config The DHCP configure data\r
\r
- @return None\r
-\r
**/\r
VOID\r
DhcpCleanConfigure (\r
Allocate memory for configure parameter such as timeout value for Dst,\r
then copy the configure parameter from Src to Dst.\r
\r
- @param Dst The destination DHCP configure data.\r
- @param Src The source DHCP configure data.\r
+ @param[out] Dst The destination DHCP configure data.\r
+ @param[in] Src The source DHCP configure data.\r
\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
@retval EFI_SUCCESS The configure is copied.\r
\r
@param DhcpSb The DHCP service instance.\r
\r
- @return None\r
-\r
**/\r
VOID\r
DhcpYieldControl (\r
wants to make it possible for another instance to configure the EFI DHCPv4 Protocol\r
driver, it must call this function with Dhcp4CfgData set to NULL.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
- @param Dhcp4CfgData Pointer to the EFI_DHCP4_CONFIG_DATA.\r
+ @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
+ @param[in] Dhcp4CfgData Pointer to the EFI_DHCP4_CONFIG_DATA.\r
\r
@retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Init or\r
Dhcp4InitReboot state, if the original state of this driver\r
by EFI_DHCP4_PROTOCOL.Configure() will be called and the user can take this\r
opportunity to control the process.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
- @param CompletionEvent If not NULL, indicates the event that will be signaled when the\r
- EFI DHCPv4 Protocol driver is transferred into the\r
- Dhcp4Bound state or when the DHCP process is aborted.\r
- EFI_DHCP4_PROTOCOL.GetModeData() can be called to\r
- check the completion status. If NULL,\r
- EFI_DHCP4_PROTOCOL.Start() will wait until the driver\r
- is transferred into the Dhcp4Bound state or the process fails.\r
+ @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
+ @param[in] CompletionEvent If not NULL, indicates the event that will be signaled when the\r
+ EFI DHCPv4 Protocol driver is transferred into the\r
+ Dhcp4Bound state or when the DHCP process is aborted.\r
+ EFI_DHCP4_PROTOCOL.GetModeData() can be called to\r
+ check the completion status. If NULL,\r
+ EFI_DHCP4_PROTOCOL.Start() will wait until the driver\r
+ is transferred into the Dhcp4Bound state or the process fails.\r
\r
@retval EFI_SUCCESS The DHCP configuration process has started, or it has completed\r
when CompletionEvent is NULL.\r
state and the previous configuration is restored. The outgoing and incoming packets\r
can be captured by the EFI_DHCP4_CALLBACK function.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
- @param RebindRequest If TRUE, this function broadcasts the request packets and enters\r
- the Dhcp4Rebinding state. Otherwise, it sends a unicast\r
- request packet and enters the Dhcp4Renewing state.\r
- @param CompletionEvent If not NULL, this event is signaled when the renew/rebind phase\r
- completes or some error occurs.\r
- EFI_DHCP4_PROTOCOL.GetModeData() can be called to\r
- check the completion status. If NULL,\r
- EFI_DHCP4_PROTOCOL.RenewRebind() will busy-wait\r
- until the DHCP process finishes.\r
+ @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
+ @param[in] RebindRequest If TRUE, this function broadcasts the request packets and enters\r
+ the Dhcp4Rebinding state. Otherwise, it sends a unicast\r
+ request packet and enters the Dhcp4Renewing state.\r
+ @param[in] CompletionEvent If not NULL, this event is signaled when the renew/rebind phase\r
+ completes or some error occurs.\r
+ EFI_DHCP4_PROTOCOL.GetModeData() can be called to\r
+ check the completion status. If NULL,\r
+ EFI_DHCP4_PROTOCOL.RenewRebind() will busy-wait\r
+ until the DHCP process finishes.\r
\r
@retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the\r
Dhcp4Renewing state or is back to the Dhcp4Bound state.\r
After a successful call to this function, the EFI DHCPv4 Protocol driver returns\r
to the Dhcp4Init state and any subsequent incoming packets will be discarded silently.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
+ @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
\r
@retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Init phase.\r
@retval EFI_INVALID_PARAMETER This is NULL.\r
before DHCP configuration process can be started again. This function can be\r
called when the EFI DHCPv4 Protocol driver is in any state.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
+ @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
\r
@retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Stopped phase.\r
@retval EFI_INVALID_PARAMETER This is NULL.\r
does not change any state of the EFI DHCPv4 Protocol driver and can be used at\r
any time.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
- @param SeedPacket Initial packet to be used as a base for building new packet.\r
- @param DeleteCount Number of opcodes in the DeleteList.\r
- @param DeleteList List of opcodes to be deleted from the seed packet.\r
- Ignored if DeleteCount is zero.\r
- @param AppendCount Number of entries in the OptionList.\r
- @param AppendList Pointer to a DHCP option list to be appended to SeedPacket.\r
- If SeedPacket also contains options in this list, they are\r
- replaced by new options (except pad option). Ignored if\r
- AppendCount is zero. Type EFI_DHCP4_PACKET_OPTION\r
- @param NewPacket Pointer to storage for the pointer to the new allocated packet.\r
- Use the EFI Boot Service FreePool() on the resulting pointer\r
- when done with the packet.\r
+ @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
+ @param[in] SeedPacket Initial packet to be used as a base for building new packet.\r
+ @param[in] DeleteCount Number of opcodes in the DeleteList.\r
+ @param[in] DeleteList List of opcodes to be deleted from the seed packet.\r
+ Ignored if DeleteCount is zero.\r
+ @param[in] AppendCount Number of entries in the OptionList.\r
+ @param[in] AppendList Pointer to a DHCP option list to be appended to SeedPacket.\r
+ If SeedPacket also contains options in this list, they are\r
+ replaced by new options (except pad option). Ignored if\r
+ AppendCount is zero. Type EFI_DHCP4_PACKET_OPTION\r
+ @param[out] NewPacket Pointer to storage for the pointer to the new allocated packet.\r
+ Use the EFI Boot Service FreePool() on the resulting pointer\r
+ when done with the packet.\r
\r
@retval EFI_SUCCESS The new packet was built.\r
@retval EFI_OUT_OF_RESOURCES Storage for the new packet could not be allocated.\r
/**\r
Callback by UdpIoCreatePort() when creating UdpIo for this Dhcp4 instance.\r
\r
- @param UdpIo The UdpIo being created.\r
- @param Context Dhcp4 instance.\r
+ @param[in] UdpIo The UdpIo being created.\r
+ @param[in] Context Dhcp4 instance.\r
\r
@retval EFI_SUCCESS UdpIo is configured successfully.\r
@retval other Other error occurs.\r
Callback of Dhcp packet. Does nothing.\r
\r
@param Arg The context.\r
- \r
- @return None.\r
+\r
**/\r
VOID\r
DhcpDummyExtFree (\r
@param IoStatus Status of the input.\r
@param Context Extra info for the input.\r
\r
- @return None.\r
- \r
**/\r
VOID\r
PxeDhcpInput (\r
Complete a Dhcp4 transaction and signal the upper layer.\r
\r
@param Instance Dhcp4 instance.\r
- \r
- @return None.\r
\r
**/\r
VOID\r
wait for the response from servers. This function does not change the state of\r
the EFI DHCPv4 Protocol driver and thus can be used at any time.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
- @param Token Pointer to the EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN structure.\r
+ @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
+ @param[in] Token Pointer to the EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN structure.\r
\r
@retval EFI_SUCCESS The packet was successfully queued for transmission.\r
@retval EFI_INVALID_PARAMETER Some parameter is NULL.\r
EFI_DHCP4_PACKET_OPTION array in the DHCP_PARSE_CONTEXT to point\r
the individual DHCP option in the packet.\r
\r
- @param Tag The DHCP option type\r
- @param Len Length of the DHCP option data\r
- @param Data The DHCP option data\r
- @param Context The context, to pass several parameters in.\r
+ @param[in] Tag The DHCP option type\r
+ @param[in] Len Length of the DHCP option data\r
+ @param[in] Data The DHCP option data\r
+ @param[in] Context The context, to pass several parameters in.\r
\r
@retval EFI_SUCCESS It always returns EFI_SUCCESS\r
\r
/** @file\r
-\r
-Copyright (c) 2006 - 2008, Intel Corporation\r
+ EFI DHCP protocol implementation.\r
+ RFCs supported are:\r
+ RFC 2131: Dynamic Host Configuration Protocol\r
+ RFC 2132: DHCP Options and BOOTP Vendor Extensions\r
+ RFC 1534: Interoperation Between DHCP and BOOTP\r
+ RFC 3396: Encoding Long Options in DHCP.\r
+ \r
+Copyright (c) 2006 - 2008, 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
- Dhcp4Impl.h\r
-\r
-Abstract:\r
-\r
- EFI DHCP protocol implementation\r
- RFCs supported are:\r
- RFC 2131: Dynamic Host Configuration Protocol\r
- RFC 2132: DHCP Options and BOOTP Vendor Extensions\r
- RFC 1534: Interoperation Between DHCP and BOOTP\r
- RFC 3396: Encoding Long Options in DHCP\r
-\r
-\r
**/\r
\r
#ifndef __EFI_DHCP4_IMPL_H__\r
\r
@param DhcpSb The DHCP service instance.\r
\r
- @return None\r
-\r
**/\r
VOID\r
DhcpYieldControl (\r
Complete a Dhcp4 transaction and signal the upper layer.\r
\r
@param Instance Dhcp4 instance.\r
- \r
- @return None.\r
\r
**/\r
VOID\r
/** @file\r
-\r
-Copyright (c) 2006 - 2008, Intel Corporation\r
+ EFI DHCP protocol implementation.\r
+ \r
+Copyright (c) 2006 - 2008, 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
- Dhcp4Io.c\r
-\r
-Abstract:\r
-\r
- EFI DHCP protocol implementation\r
-\r
-\r
**/\r
\r
\r
Send an initial DISCOVER or REQUEST message according to the\r
DHCP service's current state.\r
\r
- @param DhcpSb The DHCP service instance\r
+ @param[in] DhcpSb The DHCP service instance\r
\r
@retval EFI_SUCCESS The request has been sent\r
@retval other Some error occurs when sending the request.\r
proper return value is selected to let the caller continue the\r
normal process.\r
\r
- @param DhcpSb The DHCP service instance\r
- @param Event The event as defined in the spec\r
- @param Packet The current packet trigger the event\r
- @param NewPacket The user's return new packet\r
+ @param[in] DhcpSb The DHCP service instance\r
+ @param[in] Event The event as defined in the spec\r
+ @param[in] Packet The current packet trigger the event\r
+ @param[out] NewPacket The user's return new packet\r
\r
@retval EFI_NOT_READY Direct the caller to continue collecting the offer.\r
@retval EFI_SUCCESS The user function returns success.\r
@param DhcpSb DHCP service instance\r
@param Which Which notify function to signal\r
\r
- @return None\r
-\r
**/\r
VOID\r
DhcpNotifyUser (\r
\r
@param DhcpSb The DHCP service instance.\r
\r
- @return None\r
-\r
**/\r
VOID\r
DhcpSetTransmitTimer (\r
\r
@param DhcpSb The DHCP service instance\r
@param Para The DHCP parameter extracted from the server's\r
- response.\r
-\r
- @return None\r
-\r
+ response. \r
**/\r
VOID\r
DhcpComputeLease (\r
DHCP driver needs this port to unicast packet to the server\r
such as DHCP release.\r
\r
- @param UdpIo The UDP IO port to configure\r
- @param Context Dhcp service instance.\r
+ @param[in] UdpIo The UDP IO port to configure\r
+ @param[in] Context Dhcp service instance.\r
\r
@retval EFI_SUCCESS The UDP IO port is successfully configured.\r
@retval Others It failed to configure the port.\r
\r
@param DhcpSb The DHCP instance service.\r
\r
- @return None\r
-\r
**/\r
VOID\r
DhcpCleanLease (\r
of BOOTP, the lease is recorded and user notified. If the offer is of\r
DHCP, it will request the offer from the server.\r
\r
- @param DhcpSb The DHCP service instance.\r
+ @param[in] DhcpSb The DHCP service instance.\r
\r
@retval EFI_SUCCESS One of the offer is selected.\r
\r
to this is: only call DhcpEndSession at the highest level, such as\r
DhcpInput, DhcpOnTimerTick...At the other level, just return error.\r
\r
- @param DhcpSb The DHCP service instance\r
- @param Status The result of the DHCP process.\r
-\r
- @return None\r
+ @param[in] DhcpSb The DHCP service instance\r
+ @param[in] Status The result of the DHCP process.\r
\r
**/\r
VOID\r
/**\r
Handle packets in DHCP select state.\r
\r
- @param DhcpSb The DHCP service instance\r
- @param Packet The DHCP packet received\r
- @param Para The DHCP parameter extracted from the packet. That\r
- is, all the option value that we care.\r
+ @param[in] DhcpSb The DHCP service instance\r
+ @param[in] Packet The DHCP packet received\r
+ @param[in] Para The DHCP parameter extracted from the packet. That\r
+ is, all the option value that we care.\r
\r
@retval EFI_SUCCESS The packet is successfully processed.\r
@retval Others Some error occured.\r
/**\r
Handle packets in DHCP request state.\r
\r
- @param DhcpSb The DHCP service instance\r
- @param Packet The DHCP packet received\r
- @param Para The DHCP parameter extracted from the packet. That\r
- is, all the option value that we care.\r
+ @param[in] DhcpSb The DHCP service instance\r
+ @param[in] Packet The DHCP packet received\r
+ @param[in] Para The DHCP parameter extracted from the packet. That\r
+ is, all the option value that we care.\r
\r
@retval EFI_SUCCESS The packet is successfully processed.\r
@retval Others Some error occured.\r
/**\r
Handle packets in DHCP renew/rebound state.\r
\r
- @param DhcpSb The DHCP service instance\r
- @param Packet The DHCP packet received\r
- @param Para The DHCP parameter extracted from the packet. That\r
- is, all the option value that we care.\r
+ @param[in] DhcpSb The DHCP service instance\r
+ @param[in] Packet The DHCP packet received\r
+ @param[in] Para The DHCP parameter extracted from the packet. That\r
+ is, all the option value that we care.\r
\r
@retval EFI_SUCCESS The packet is successfully processed.\r
@retval Others Some error occured.\r
/**\r
Handle packets in DHCP reboot state.\r
\r
- @param DhcpSb The DHCP service instance\r
- @param Packet The DHCP packet received\r
- @param Para The DHCP parameter extracted from the packet. That\r
- is, all the option value that we care.\r
+ @param[in] DhcpSb The DHCP service instance\r
+ @param[in] Packet The DHCP packet received\r
+ @param[in] Para The DHCP parameter extracted from the packet. That\r
+ is, all the option value that we care.\r
\r
@retval EFI_SUCCESS The packet is successfully processed.\r
@retval Others Some error occured.\r
@param IoStatus The status of the UDP receive\r
@param Context The opaque parameter to the function.\r
\r
- @return None\r
-\r
**/\r
VOID\r
DhcpInput (\r
/**\r
Release the packet.\r
\r
- @param Arg The packet to release\r
-\r
- @return None\r
+ @param[in] Arg The packet to release\r
\r
**/\r
VOID\r
@param IoStatus The status of the UDP receive\r
@param Context The opaque parameter to the function.\r
\r
- @return None\r
-\r
**/\r
VOID\r
DhcpOnPacketSent (\r
the state (as defined in Figure 5. of the same RFC) before sending\r
a DHCP message. The table is adjusted accordingly.\r
\r
- @param DhcpSb The DHCP service instance\r
- @param Seed The seed packet which the new packet is based on\r
- @param Para The DHCP parameter of the Seed packet\r
- @param Type The message type to send\r
- @param Msg The human readable message to include in the packet\r
- sent.\r
+ @param[in] DhcpSb The DHCP service instance\r
+ @param[in] Seed The seed packet which the new packet is based on\r
+ @param[in] Para The DHCP parameter of the Seed packet\r
+ @param[in] Type The message type to send\r
+ @param[in] Msg The human readable message to include in the packet\r
+ sent.\r
\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate resources for the packet\r
@retval EFI_ACCESS_DENIED Failed to transmit the packet through UDP\r
Retransmit a saved packet. Only DISCOVER and REQUEST messages\r
will be retransmitted.\r
\r
- @param DhcpSb The DHCP service instance\r
+ @param[in] DhcpSb The DHCP service instance\r
\r
@retval EFI_ACCESS_DENIED Failed to transmit packet through UDP port\r
@retval EFI_SUCCESS The packet is retransmitted.\r
and lease to determine the time to renew and rebind the lease.\r
DhcpOnTimerTick will be called once every second.\r
\r
- @param Event The timer event\r
- @param Context The context, which is the DHCP service instance.\r
-\r
- @return None\r
+ @param[in] Event The timer event\r
+ @param[in] Context The context, which is the DHCP service instance.\r
\r
**/\r
VOID\r
/** @file\r
-\r
-Copyright (c) 2006 - 2008, Intel Corporation\r
+ The DHCP4 protocol implementation.\r
+ \r
+Copyright (c) 2006 - 2008, 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
- Dhcp4Io.h\r
-\r
-Abstract:\r
-\r
- The DHCP4 protocol implementation.\r
-\r
-\r
**/\r
\r
#ifndef __EFI_DHCP4_IO_H__\r
the state (as defined in Figure 5. of the same RFC) before sending\r
a DHCP message. The table is adjusted accordingly.\r
\r
- @param DhcpSb The DHCP service instance\r
- @param Seed The seed packet which the new packet is based on\r
- @param Para The DHCP parameter of the Seed packet\r
- @param Type The message type to send\r
- @param Msg The human readable message to include in the packet\r
- sent.\r
+ @param[in] DhcpSb The DHCP service instance\r
+ @param[in] Seed The seed packet which the new packet is based on\r
+ @param[in] Para The DHCP parameter of the Seed packet\r
+ @param[in] Type The message type to send\r
+ @param[in] Msg The human readable message to include in the packet\r
+ sent.\r
\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate resources for the packet\r
@retval EFI_ACCESS_DENIED Failed to transmit the packet through UDP\r
and lease to determine the time to renew and rebind the lease.\r
DhcpOnTimerTick will be called once every second.\r
\r
- @param Event The timer event\r
- @param Context The context, which is the DHCP service instance.\r
-\r
- @return None\r
+ @param[in] Event The timer event\r
+ @param[in] Context The context, which is the DHCP service instance.\r
\r
**/\r
VOID\r
@param IoStatus The status of the UDP receive\r
@param Context The opaque parameter to the function.\r
\r
- @return None\r
-\r
**/\r
VOID\r
DhcpInput (\r
Send an initial DISCOVER or REQUEST message according to the\r
DHCP service's current state.\r
\r
- @param DhcpSb The DHCP service instance\r
+ @param[in] DhcpSb The DHCP service instance\r
\r
@retval EFI_SUCCESS The request has been sent\r
@retval other Some error occurs when sending the request.\r
\r
@param DhcpSb The DHCP instance service.\r
\r
- @return None\r
-\r
**/\r
VOID\r
DhcpCleanLease (\r
@param IoStatus The status of the UDP receive\r
@param Context The opaque parameter to the function.\r
\r
- @return None\r
-\r
**/\r
VOID\r
DhcpOnPacketSent (\r
/** @file\r
-\r
-Copyright (c) 2006 - 2008, Intel Corporation\r
+ Function to validate, parse, process the DHCP options.\r
+ \r
+Copyright (c) 2006 - 2008, 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
- Dhcp4Option.c\r
-\r
-Abstract:\r
-\r
- Function to validate, parse, process the DHCP options\r
-\r
-\r
**/\r
\r
#include "Dhcp4Impl.h"\r
Binary search the DhcpOptionFormats array to find the format\r
information about a specific option.\r
\r
- @param Tag The option's tag.\r
+ @param[in] Tag The option's tag.\r
\r
@return The point to the option's format, NULL if not found.\r
\r
/**\r
Validate whether a single DHCP option is valid according to its format.\r
\r
- @param Format The option's format\r
- @param OptValue The value of the option\r
- @param Len The length of the option value\r
+ @param[in] Format The option's format\r
+ @param[in] OptValue The value of the option\r
+ @param[in] Len The length of the option value\r
\r
@retval TRUE The option is valid.\r
@retval FALSE Otherwise.\r
Extract the client interested options, all the parameters are\r
converted to host byte order.\r
\r
- @param Tag The DHCP option tag\r
- @param Len The length of the option\r
- @param Data The value of the DHCP option\r
- @param Para The variable to save the interested parameter\r
+ @param[in] Tag The DHCP option tag\r
+ @param[in] Len The length of the option\r
+ @param[in] Data The value of the DHCP option\r
+ @param[out] Para The variable to save the interested parameter\r
\r
@retval EFI_SUCCESS The DHCP option is successfully extracted.\r
@retval EFI_INVALID_PARAMETER The DHCP option is mal-formated\r
in several buffers, such as the BOOTP options filed, boot file or server\r
name. Each option buffer is required to end with DHCP_TAG_EOP.\r
\r
- @param Buffer The buffer which contains DHCP options\r
- @param BufLen The length of the buffer\r
- @param Check The callback function for each option found\r
- @param Context The opaque parameter for the Check\r
- @param Overload Variable to save the value of DHCP_TAG_OVERLOAD\r
- option.\r
+ @param[in] Buffer The buffer which contains DHCP options\r
+ @param[in] BufLen The length of the buffer\r
+ @param[in] Check The callback function for each option found\r
+ @param[in] Context The opaque parameter for the Check\r
+ @param[out] Overload Variable to save the value of DHCP_TAG_OVERLOAD\r
+ option.\r
\r
@retval EFI_SUCCESS All the options are valid\r
@retval EFI_INVALID_PARAMETER The options are mal-formated.\r
DhcpIterateBufferOptions (\r
IN UINT8 *Buffer,\r
IN INTN BufLen,\r
- IN DHCP_CHECK_OPTION Check, OPTIONAL\r
+ IN DHCP_CHECK_OPTION Check OPTIONAL,\r
IN VOID *Context,\r
OUT UINT8 *Overload OPTIONAL\r
)\r
the options in FILENAME and SERVERNAME fields. One option may be\r
encoded in several places. See RFC 3396 Encoding Long Options in DHCP\r
\r
- @param Packet The DHCP packet to check the options for\r
- @param Check The callback function to be called for each option\r
- found\r
- @param Context The opaque parameter for Check\r
+ @param[in] Packet The DHCP packet to check the options for\r
+ @param[in] Check The callback function to be called for each option\r
+ found\r
+ @param[in] Context The opaque parameter for Check\r
\r
@retval EFI_SUCCESS The DHCP packet's options are well formated\r
@retval EFI_INVALID_PARAMETER The DHCP packet's options are not well formated\r
length. It just adds the data length of all the occurances of this\r
Tag. Context is an array of 256 DHCP_OPTION_COUNT.\r
\r
- @param Tag The current option to check\r
- @param Len The length of the option data\r
- @param Data The option data\r
- @param Context The context, which is a array of 256\r
- DHCP_OPTION_COUNT.\r
+ @param[in] Tag The current option to check\r
+ @param[in] Len The length of the option data\r
+ @param[in] Data The option data\r
+ @param[in] Context The context, which is a array of 256\r
+ DHCP_OPTION_COUNT.\r
\r
@retval EFI_SUCCESS It always returns EFI_SUCCESS.\r
\r
Call back function to DhcpIterateOptions to consolidate each option's\r
data. There are maybe several occurrence of the same option.\r
\r
- @param Tag The option to consolidate its data\r
- @param Len The length of option data\r
- @param Data The data of the option's current occurance\r
- @param Context The context, which is DHCP_OPTION_CONTEXT. This\r
- array is just a wrap to pass THREE parameters.\r
+ @param[in] Tag The option to consolidate its data\r
+ @param[in] Len The length of option data\r
+ @param[in] Data The data of the option's current occurance\r
+ @param[in] Context The context, which is DHCP_OPTION_CONTEXT. This\r
+ array is just a wrap to pass THREE parameters.\r
\r
@retval EFI_SUCCESS It always returns EFI_SUCCESS\r
\r
with DhcpFillOption to fill each option's data to its position in the\r
buffer.\r
\r
- @param Packet The DHCP packet to parse the options\r
- @param Count The number of valid dhcp options present in the\r
- packet\r
- @param OptionPoint The array that contains the DHCP options. Caller\r
- should free it.\r
+ @param[in] Packet The DHCP packet to parse the options\r
+ @param[out] Count The number of valid dhcp options present in the\r
+ packet\r
+ @param[out] OptionPoint The array that contains the DHCP options. Caller\r
+ should free it.\r
\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory to parse the packet.\r
@retval EFI_INVALID_PARAMETER The options are mal-formated\r
Validate the packet's options. If necessary, allocate\r
and fill in the interested parameters.\r
\r
- @param Packet The packet to validate the options\r
- @param Para The variable to save the DHCP parameters.\r
+ @param[in] Packet The packet to validate the options\r
+ @param[out] Para The variable to save the DHCP parameters.\r
\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory to validate the packet.\r
@retval EFI_INVALID_PARAMETER The options are mal-formated\r
Append an option to the memory, if the option is longer than\r
255 bytes, splits it into several options.\r
\r
- @param Buf The buffer to append the option to\r
- @param Tag The option's tag\r
- @param DataLen The length of the option's data\r
- @param Data The option's data\r
+ @param[out] Buf The buffer to append the option to\r
+ @param[in] Tag The option's tag\r
+ @param[in] DataLen The length of the option's data\r
+ @param[in] Data The option's data\r
\r
@return The position to append the next option\r
\r
Build a new DHCP packet from a seed packet. Options may be deleted or\r
appended. The caller should free the NewPacket when finished using it.\r
\r
- @param SeedPacket The seed packet to start with\r
- @param DeleteCount The number of options to delete\r
- @param DeleteList The options to delete from the packet\r
- @param AppendCount The number of options to append\r
- @param AppendList The options to append to the packet\r
- @param NewPacket The new packet, allocated and built by this\r
- function.\r
+ @param[in] SeedPacket The seed packet to start with\r
+ @param[in] DeleteCount The number of options to delete\r
+ @param[in] DeleteList The options to delete from the packet\r
+ @param[in] AppendCount The number of options to append\r
+ @param[in] AppendList The options to append to the packet\r
+ @param[out] NewPacket The new packet, allocated and built by this\r
+ function.\r
\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory\r
@retval EFI_INVALID_PARAMETER The options in SeekPacket are mal-formated\r
/** @file\r
-\r
-Copyright (c) 2006, Intel Corporation\r
+ To validate, parse and process the DHCP options.\r
+ \r
+Copyright (c) 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
- Dhcp4Option.h\r
-\r
-Abstract:\r
-\r
- To validate, parse and process the DHCP options\r
-\r
-\r
**/\r
\r
#ifndef __EFI_DHCP4_OPTION_H__\r
the options in FILENAME and SERVERNAME fields. One option may be\r
encoded in several places. See RFC 3396 Encoding Long Options in DHCP\r
\r
- @param Packet The DHCP packet to check the options for\r
- @param Check The callback function to be called for each option\r
- found\r
- @param Context The opaque parameter for Check\r
+ @param[in] Packet The DHCP packet to check the options for\r
+ @param[in] Check The callback function to be called for each option\r
+ found\r
+ @param[in] Context The opaque parameter for Check\r
\r
@retval EFI_SUCCESS The DHCP packet's options are well formated\r
@retval EFI_INVALID_PARAMETER The DHCP packet's options are not well formated\r
Validate the packet's options. If necessary, allocate\r
and fill in the interested parameters.\r
\r
- @param Packet The packet to validate the options\r
- @param Para The variable to save the DHCP parameters.\r
+ @param[in] Packet The packet to validate the options\r
+ @param[out] Para The variable to save the DHCP parameters.\r
\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory to validate the packet.\r
@retval EFI_INVALID_PARAMETER The options are mal-formated\r
with DhcpFillOption to fill each option's data to its position in the\r
buffer.\r
\r
- @param Packet The DHCP packet to parse the options\r
- @param Count The number of valid dhcp options present in the\r
- packet\r
- @param OptionPoint The array that contains the DHCP options. Caller\r
- should free it.\r
+ @param[in] Packet The DHCP packet to parse the options\r
+ @param[out] Count The number of valid dhcp options present in the\r
+ packet\r
+ @param[out] OptionPoint The array that contains the DHCP options. Caller\r
+ should free it.\r
\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory to parse the packet.\r
@retval EFI_INVALID_PARAMETER The options are mal-formated\r
Append an option to the memory, if the option is longer than\r
255 bytes, splits it into several options.\r
\r
- @param Buf The buffer to append the option to\r
- @param Tag The option's tag\r
- @param DataLen The length of the option's data\r
- @param Data The option's data\r
+ @param[out] Buf The buffer to append the option to\r
+ @param[in] Tag The option's tag\r
+ @param[in] DataLen The length of the option's data\r
+ @param[in] Data The option's data\r
\r
@return The position to append the next option\r
\r
Build a new DHCP packet from a seed packet. Options may be deleted or\r
appended. The caller should free the NewPacket when finished using it.\r
\r
- @param SeedPacket The seed packet to start with\r
- @param DeleteCount The number of options to delete\r
- @param DeleteList The options to delete from the packet\r
- @param AppendCount The number of options to append\r
- @param AppendList The options to append to the packet\r
- @param NewPacket The new packet, allocated and built by this\r
- function.\r
+ @param[in] SeedPacket The seed packet to start with\r
+ @param[in] DeleteCount The number of options to delete\r
+ @param[in] DeleteList The options to delete from the packet\r
+ @param[in] AppendCount The number of options to append\r
+ @param[in] AppendList The options to append to the packet\r
+ @param[out] NewPacket The new packet, allocated and built by this\r
+ function.\r
\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory\r
@retval EFI_INVALID_PARAMETER The options in SeekPacket are mal-formated\r
EFIAPI\r
EfiNicIp4ConfigSetInfo (\r
IN EFI_NIC_IP4_CONFIG_PROTOCOL *This,\r
- IN NIC_IP4_CONFIG_INFO *NicConfig, OPTIONAL\r
+ IN NIC_IP4_CONFIG_INFO *NicConfig OPTIONAL,\r
IN BOOLEAN Reconfig\r
)\r
{\r
/** @file\r
- Routines used to operate the Ip4 configure variable\r
+ Routines used to operate the Ip4 configure variable.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation.<BR> \r
All rights reserved. This program and the accompanying materials\r
**/\r
IP4_CONFIG_VARIABLE *\r
Ip4ConfigModifyVariable (\r
- IN IP4_CONFIG_VARIABLE *Variable, OPTIONAL\r
+ IN IP4_CONFIG_VARIABLE *Variable OPTIONAL,\r
IN NIC_ADDR *NicAddr,\r
IN NIC_IP4_CONFIG_INFO *Config OPTIONAL\r
)\r
/** @file\r
- Routines used to operate the Ip4 configure variable\r
+ Routines used to operate the Ip4 configure variable.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation.<BR> \r
All rights reserved. This program and the accompanying materials\r
**/\r
IP4_CONFIG_VARIABLE *\r
Ip4ConfigModifyVariable (\r
- IN IP4_CONFIG_VARIABLE *Variable, OPTIONAL\r
+ IN IP4_CONFIG_VARIABLE *Variable OPTIONAL,\r
IN NIC_ADDR *NicAddr,\r
IN NIC_IP4_CONFIG_INFO *Config OPTIONAL\r
);\r
/** @file\r
-\r
-Copyright (c) 2005 - 2007, Intel Corporation\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
+which accompanies this distribution. The full text of the license may be found at<BR>\r
http://opensource.org/licenses/bsd-license.php\r
\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
- ComponentName.c\r
-\r
-Abstract:\r
-\r
-\r
**/\r
\r
#include "Ip4Impl.h"\r
by This does not support the language specified by Language,\r
then EFI_UNSUPPORTED is returned.\r
\r
- @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
+ @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
EFI_COMPONENT_NAME_PROTOCOL instance.\r
\r
- @param Language[in] A pointer to a Null-terminated ASCII string\r
+ @param[in] Language A pointer to a Null-terminated ASCII string\r
array indicating the language. This is the\r
language of the driver name that the caller is\r
requesting, and it must match one of the\r
to the driver writer. Language is specified\r
in RFC 3066 or ISO 639-2 language code format.\r
\r
- @param DriverName[out] A pointer to the Unicode string to return.\r
+ @param[out] DriverName A pointer to the Unicode string to return.\r
This Unicode string is the name of the\r
driver specified by This in the language\r
specified by Language.\r
then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r
support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
\r
- @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
+ @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
EFI_COMPONENT_NAME_PROTOCOL instance.\r
\r
- @param ControllerHandle[in] The handle of a controller that the driver\r
+ @param[in] ControllerHandle The handle of a controller that the driver\r
specified by This is managing. This handle\r
specifies the controller whose name is to be\r
returned.\r
\r
- @param ChildHandle[in] The handle of the child controller to retrieve\r
+ @param[in] ChildHandle The handle of the child controller to retrieve\r
the name of. This is an optional parameter that\r
may be NULL. It will be NULL for device\r
drivers. It will also be NULL for a bus drivers\r
driver that wishes to retrieve the name of a\r
child controller.\r
\r
- @param Language[in] A pointer to a Null-terminated ASCII string\r
+ @param[in] Language A pointer to a Null-terminated ASCII string\r
array indicating the language. This is the\r
language of the driver name that the caller is\r
requesting, and it must match one of the\r
to the driver writer. Language is specified in\r
RFC 3066 or ISO 639-2 language code format.\r
\r
- @param ControllerName[out] A pointer to the Unicode string to return.\r
+ @param[out] ControllerName A pointer to the Unicode string to return.\r
This Unicode string is the name of the\r
controller specified by ControllerHandle and\r
ChildHandle in the language specified by\r
by This does not support the language specified by Language,\r
then EFI_UNSUPPORTED is returned.\r
\r
- @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
+ @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
EFI_COMPONENT_NAME_PROTOCOL instance.\r
\r
- @param Language[in] A pointer to a Null-terminated ASCII string\r
+ @param[in] Language A pointer to a Null-terminated ASCII string\r
array indicating the language. This is the\r
language of the driver name that the caller is\r
requesting, and it must match one of the\r
to the driver writer. Language is specified\r
in RFC 3066 or ISO 639-2 language code format.\r
\r
- @param DriverName[out] A pointer to the Unicode string to return.\r
+ @param[out] DriverName A pointer to the Unicode string to return.\r
This Unicode string is the name of the\r
driver specified by This in the language\r
specified by Language.\r
then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r
support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
\r
- @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
+ @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
EFI_COMPONENT_NAME_PROTOCOL instance.\r
\r
- @param ControllerHandle[in] The handle of a controller that the driver\r
+ @param[in] ControllerHandle The handle of a controller that the driver\r
specified by This is managing. This handle\r
specifies the controller whose name is to be\r
returned.\r
\r
- @param ChildHandle[in] The handle of the child controller to retrieve\r
+ @param[in] ChildHandle The handle of the child controller to retrieve\r
the name of. This is an optional parameter that\r
may be NULL. It will be NULL for device\r
drivers. It will also be NULL for a bus drivers\r
driver that wishes to retrieve the name of a\r
child controller.\r
\r
- @param Language[in] A pointer to a Null-terminated ASCII string\r
+ @param[in] Language A pointer to a Null-terminated ASCII string\r
array indicating the language. This is the\r
language of the driver name that the caller is\r
requesting, and it must match one of the\r
to the driver writer. Language is specified in\r
RFC 3066 or ISO 639-2 language code format.\r
\r
- @param ControllerName[out] A pointer to the Unicode string to return.\r
+ @param[out] ControllerName A pointer to the Unicode string to return.\r
This Unicode string is the name of the\r
controller specified by ControllerHandle and\r
ChildHandle in the language specified by\r
/** @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
- Ip4Common.c\r
-\r
-Abstract:\r
-\r
-\r
**/\r
\r
#include "Ip4Impl.h"\r
Return the cast type (Unicast/Boradcast) specific to an\r
interface. All the addresses are host byte ordered.\r
\r
- @param IpAddr The IP address to classify in host byte order\r
- @param IpIf The interface that IpAddr received from\r
+ @param[in] IpAddr The IP address to classify in host byte order\r
+ @param[in] IpIf The interface that IpAddr received from\r
\r
@return The cast type of this IP address specific to the interface.\r
@retval IP4_LOCAL_HOST The IpAddr equals to the interface's address\r
This isn't the same as link layer cast type. For example, DHCP\r
server may send local broadcast to the local unicast MAC.\r
\r
- @param IpSb The IP4 service binding instance that received the\r
- packet\r
- @param Dst The destination address in the packet (host byte\r
- order)\r
- @param Src The source address in the packet (host byte order)\r
+ @param[in] IpSb The IP4 service binding instance that received the\r
+ packet\r
+ @param[in] Dst The destination address in the packet (host byte\r
+ order)\r
+ @param[in] Src The source address in the packet (host byte order)\r
\r
@return The cast type for the Dst, it will return on the first non-promiscuous\r
cast type to a configured interface. If the packet doesn't match any of\r
/**\r
Find an interface whose configured IP address is Ip.\r
\r
- @param IpSb The IP4 service binding instance\r
- @param Ip The Ip address (host byte order) to find\r
+ @param[in] IpSb The IP4 service binding instance\r
+ @param[in] Ip The Ip address (host byte order) to find\r
\r
@return The IP4_INTERFACE point if found, otherwise NULL\r
\r
/**\r
Find an interface that Ip is on that connected network.\r
\r
- @param IpSb The IP4 service binding instance\r
- @param Ip The Ip address (host byte order) to find\r
+ @param[in] IpSb The IP4 service binding instance\r
+ @param[in] Ip The Ip address (host byte order) to find\r
\r
@return The IP4_INTERFACE point if found, otherwise NULL\r
\r
/**\r
Find an interface of the service with the same Ip/Netmask pair.\r
\r
- @param IpSb Ip4 service binding instance\r
- @param Ip The Ip adress to find (host byte order)\r
- @param Netmask The network to find (host byte order)\r
+ @param[in] IpSb Ip4 service binding instance\r
+ @param[in] Ip The Ip adress to find (host byte order)\r
+ @param[in] Netmask The network to find (host byte order)\r
\r
@return The IP4_INTERFACE point if found, otherwise NULL\r
\r
Mnp's McastIpToMac to find the MAC address in stead of\r
hard code the NIC to be Ethernet.\r
\r
- @param Mnp The Mnp instance to get the MAC address.\r
- @param Multicast The multicast IP address to translate.\r
- @param Mac The buffer to hold the translated address.\r
+ @param[in] Mnp The Mnp instance to get the MAC address.\r
+ @param[in] Multicast The multicast IP address to translate.\r
+ @param[out] Mac The buffer to hold the translated address.\r
\r
@retval EFI_SUCCESS if the multicast IP is successfully translated to a\r
multicast MAC address.\r
In spite of its name, it can also be used to convert from\r
host to network byte order.\r
\r
- @param Head The IP head to convert\r
+ @param[in] Head The IP head to convert\r
\r
@return Point to the converted IP head\r
\r
Save the list of all of the IPv4 addresses and subnet masks that are currently\r
being used to volatile variable storage.\r
\r
- @param IpSb Ip4 service binding instance\r
+ @param[in] IpSb Ip4 service binding instance\r
\r
@retval EFI_SUCCESS Successfully set variable.\r
@retval EFI_OUT_OF_RESOURCES There are not enough resources to set the variable.\r
/**\r
Clear the variable and free the resource.\r
\r
- @param IpSb Ip4 service binding instance\r
-\r
- @return None.\r
+ @param[in] IpSb Ip4 service binding instance\r
\r
**/\r
VOID\r
/** @file\r
-\r
-Copyright (c) 2005 - 2006, Intel Corporation\r
+ Common definition for IP4.\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
-\r
-Module Name:\r
-\r
- Ip4Common.h\r
-\r
-Abstract:\r
-\r
- Common definition for IP4.\r
-\r
-\r
**/\r
\r
#ifndef __EFI_IP4_COMMON_H__\r
Return the cast type (Unicast/Boradcast) specific to an\r
interface. All the addresses are host byte ordered.\r
\r
- @param IpAddr The IP address to classify in host byte order\r
- @param IpIf The interface that IpAddr received from\r
+ @param[in] IpAddr The IP address to classify in host byte order\r
+ @param[in] IpIf The interface that IpAddr received from\r
\r
@return The cast type of this IP address specific to the interface.\r
@retval IP4_LOCAL_HOST The IpAddr equals to the interface's address\r
This isn't the same as link layer cast type. For example, DHCP\r
server may send local broadcast to the local unicast MAC.\r
\r
- @param IpSb The IP4 service binding instance that received the\r
- packet\r
- @param Dst The destination address in the packet (host byte\r
- order)\r
- @param Src The source address in the packet (host byte order)\r
+ @param[in] IpSb The IP4 service binding instance that received the\r
+ packet\r
+ @param[in] Dst The destination address in the packet (host byte\r
+ order)\r
+ @param[in] Src The source address in the packet (host byte order)\r
\r
@return The cast type for the Dst, it will return on the first non-promiscuous\r
cast type to a configured interface. If the packet doesn't match any of\r
/**\r
Find an interface whose configured IP address is Ip.\r
\r
- @param IpSb The IP4 service binding instance\r
- @param Ip The Ip address (host byte order) to find\r
+ @param[in] IpSb The IP4 service binding instance\r
+ @param[in] Ip The Ip address (host byte order) to find\r
\r
@return The IP4_INTERFACE point if found, otherwise NULL\r
\r
/**\r
Find an interface that Ip is on that connected network.\r
\r
- @param IpSb The IP4 service binding instance\r
- @param Ip The Ip address (host byte order) to find\r
+ @param[in] IpSb The IP4 service binding instance\r
+ @param[in] Ip The Ip address (host byte order) to find\r
\r
@return The IP4_INTERFACE point if found, otherwise NULL\r
\r
/**\r
Find an interface of the service with the same Ip/Netmask pair.\r
\r
- @param IpSb Ip4 service binding instance\r
- @param Ip The Ip adress to find (host byte order)\r
- @param Netmask The network to find (host byte order)\r
+ @param[in] IpSb Ip4 service binding instance\r
+ @param[in] Ip The Ip adress to find (host byte order)\r
+ @param[in] Netmask The network to find (host byte order)\r
\r
@return The IP4_INTERFACE point if found, otherwise NULL\r
\r
Mnp's McastIpToMac to find the MAC address in stead of\r
hard code the NIC to be Ethernet.\r
\r
- @param Mnp The Mnp instance to get the MAC address.\r
- @param Multicast The multicast IP address to translate.\r
- @param Mac The buffer to hold the translated address.\r
+ @param[in] Mnp The Mnp instance to get the MAC address.\r
+ @param[in] Multicast The multicast IP address to translate.\r
+ @param[out] Mac The buffer to hold the translated address.\r
\r
@retval EFI_SUCCESS if the multicast IP is successfully translated to a\r
multicast MAC address.\r
In spite of its name, it can also be used to convert from\r
host to network byte order.\r
\r
- @param Head The IP head to convert\r
+ @param[in] Head The IP head to convert\r
\r
@return Point to the converted IP head\r
\r
Save the list of all of the IPv4 addresses and subnet masks that are currently\r
being used to volatile variable storage.\r
\r
- @param IpSb Ip4 service binding instance\r
+ @param[in] IpSb Ip4 service binding instance\r
\r
@retval EFI_SUCCESS Successfully set variable.\r
@retval EFI_OUT_OF_RESOURCES There are not enough resources to set the variable.\r
/**\r
Clear the variable and free the resource.\r
\r
- @param IpSb Ip4 service binding instance\r
-\r
- @return None.\r
+ @param[in] IpSb Ip4 service binding instance\r
\r
**/\r
VOID\r
/** @file\r
-\r
-Copyright (c) 2005 - 2006, Intel Corporation\r
+ The driver binding and service binding protocol for IP4 driver.\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
- Ip4Driver.c\r
-\r
-Abstract:\r
-\r
- The driver binding and service binding protocol for IP4 driver.\r
-\r
-\r
**/\r
\r
#include "Ip4Impl.h"\r
The entry point for IP4 driver which install the driver\r
binding and component name protocol on its image.\r
\r
- @param ImageHandle The firmware allocated handle for the UEFI image.\r
- @param SystemTable A pointer to the EFI System Table.\r
+ @param[in] ImageHandle The firmware allocated handle for the UEFI image.\r
+ @param[in] SystemTable A pointer to the EFI System Table.\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.\r
follow these calling restrictions. If any other agent wishes to call\r
Supported() it must also follow these calling restrictions.\r
\r
- @param This Protocol instance pointer.\r
- @param ControllerHandle Handle of device to test\r
- @param RemainingDevicePath Optional parameter use to pick a specific child\r
- device to start.\r
+ @param[in] This Protocol instance pointer.\r
+ @param[in] ControllerHandle Handle of device to test\r
+ @param[in] RemainingDevicePath Optional parameter use to pick a specific child\r
+ device to start.\r
\r
@retval EFI_SUCCESS This driver supports this device\r
@retval EFI_ALREADY_STARTED This driver is already running on this device\r
destroyed, it is marked as that in case the destory failed and\r
being called again later.\r
\r
- @param IpSb The IP4 serviceing binding instance to clean up\r
+ @param[in] IpSb The IP4 serviceing binding instance to clean up\r
\r
@retval EFI_SUCCESS The resource used by the instance are cleaned up\r
@retval other Failed to clean up some of the resources.\r
/**\r
Create a new IP4 driver service binding private instance.\r
\r
- @param Controller The controller that has MNP service binding\r
- installed\r
- @param ImageHandle The IP4 driver's image handle\r
- @param Service The variable to receive the newly created IP4\r
- service.\r
+ @param Controller The controller that has MNP service binding\r
+ installed\r
+ @param ImageHandle The IP4 driver's image handle\r
+ @param Service The variable to receive the newly created IP4\r
+ service.\r
\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate some resource\r
@retval EFI_SUCCESS A new IP4 service binding private is created.\r
destroyed, it is marked as that in case the destory failed and\r
being called again later.\r
\r
- @param IpSb The IP4 serviceing binding instance to clean up\r
+ @param[in] IpSb The IP4 serviceing binding instance to clean up\r
\r
@retval EFI_SUCCESS The resource used by the instance are cleaned up\r
@retval other Failed to clean up some of the resources.\r
calling restrictions. If any other agent wishes to call Start() it\r
must also follow these calling restrictions.\r
\r
- @param This Protocol instance pointer.\r
- @param ControllerHandle Handle of device to bind driver to\r
- @param RemainingDevicePath Optional parameter use to pick a specific child\r
- device to start.\r
+ @param[in] This Protocol instance pointer.\r
+ @param[in] ControllerHandle Handle of device to bind driver to\r
+ @param[in] RemainingDevicePath Optional parameter use to pick a specific child\r
+ device to start.\r
\r
@retval EFI_SUCCESS This driver is added to ControllerHandle\r
@retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle\r
must follow these calling restrictions. If any other agent wishes\r
to call Stop() it must also follow these calling restrictions.\r
\r
- @param This Protocol instance pointer.\r
- @param ControllerHandle Handle of device to stop driver on\r
- @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r
- children is zero stop the entire bus driver.\r
- @param ChildHandleBuffer List of Child Handles to Stop.\r
+ @param[in] This Protocol instance pointer.\r
+ @param[in] ControllerHandle Handle of device to stop driver on\r
+ @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number\r
+ of children is zero stop the entire bus driver.\r
+ @param[in] ChildHandleBuffer List of Child Handles to Stop.\r
\r
- @retval EFI_SUCCESS This driver is removed ControllerHandle\r
- @retval other This driver was not removed from this device\r
+ @retval EFI_SUCCESS This driver is removed ControllerHandle\r
+ @retval other This driver was not removed from this device\r
\r
**/\r
EFI_STATUS\r
\r
\r
/**\r
- Creates a child handle with a set of I/O services.\r
+ Creates a child handle and installs a protocol.\r
+ \r
+ The CreateChild() function installs a protocol on ChildHandle. \r
+ If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle. \r
+ If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.\r
\r
- @param This Protocol instance pointer.\r
- @param ChildHandle Pointer to the handle of the child to create. If it is NULL,\r
- then a new handle is created. If it is not NULL, then the\r
- I/O services are added to the existing child handle.\r
+ @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
+ @param ChildHandle Pointer to the handle of the child to create. If it is NULL,\r
+ then a new handle is created. If it is a pointer to an existing UEFI handle, \r
+ then the protocol is added to the existing UEFI handle.\r
\r
- @retval EFI_SUCCES The child handle was created with the I/O services\r
+ @retval EFI_SUCCES The protocol was added to ChildHandle.\r
@retval EFI_INVALID_PARAMETER ChildHandle is NULL.\r
@retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create\r
the child\r
\r
\r
/**\r
- Destroys a child handle with a set of I/O services.\r
+ Destroys a child handle with a protocol installed on it.\r
+ \r
+ The DestroyChild() function does the opposite of CreateChild(). It removes a protocol \r
+ that was installed by CreateChild() from ChildHandle. If the removed protocol is the \r
+ last protocol on ChildHandle, then ChildHandle is destroyed.\r
\r
- @param This Protocol instance pointer.\r
+ @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
@param ChildHandle Handle of the child to destroy\r
\r
- @retval EFI_SUCCES The I/O services were removed from the child handle\r
- @retval EFI_UNSUPPORTED The child handle does not support the I/O services\r
- that are being removed.\r
- @retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle.\r
- @retval EFI_ACCESS_DENIED The child handle could not be destroyed because its\r
- I/O services are being used.\r
+ @retval EFI_SUCCES The protocol was removed from ChildHandle.\r
+ @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.\r
+ @retval EFI_INVALID_PARAMETER Child handle is not a valid UEFI Handle.\r
+ @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle\r
+ because its services are being used.\r
@retval other The child handle was not destroyed\r
\r
**/\r
/** @file\r
\r
-Copyright (c) 2005 - 2007, Intel Corporation\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
-\r
-Module Name:\r
-\r
- Ip4Driver.h\r
-\r
-Abstract:\r
-\r
-\r
**/\r
\r
#ifndef __EFI_IP4_DRIVER_H__\r
The entry point for IP4 driver which install the driver\r
binding and component name protocol on its image.\r
\r
- @param ImageHandle The firmware allocated handle for the UEFI image.\r
- @param SystemTable A pointer to the EFI System Table.\r
+ @param[in] ImageHandle The firmware allocated handle for the UEFI image.\r
+ @param[in] SystemTable A pointer to the EFI System Table.\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.\r
follow these calling restrictions. If any other agent wishes to call\r
Supported() it must also follow these calling restrictions.\r
\r
- @param This Protocol instance pointer.\r
- @param ControllerHandle Handle of device to test\r
- @param RemainingDevicePath Optional parameter use to pick a specific child\r
- device to start.\r
+ @param[in] This Protocol instance pointer.\r
+ @param[in] ControllerHandle Handle of device to test\r
+ @param[in] RemainingDevicePath Optional parameter use to pick a specific child\r
+ device to start.\r
\r
@retval EFI_SUCCESS This driver supports this device\r
@retval EFI_ALREADY_STARTED This driver is already running on this device\r
calling restrictions. If any other agent wishes to call Start() it\r
must also follow these calling restrictions.\r
\r
- @param This Protocol instance pointer.\r
- @param ControllerHandle Handle of device to bind driver to\r
- @param RemainingDevicePath Optional parameter use to pick a specific child\r
- device to start.\r
+ @param[in] This Protocol instance pointer.\r
+ @param[in] ControllerHandle Handle of device to bind driver to\r
+ @param[in] RemainingDevicePath Optional parameter use to pick a specific child\r
+ device to start.\r
\r
@retval EFI_SUCCESS This driver is added to ControllerHandle\r
@retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle\r
must follow these calling restrictions. If any other agent wishes\r
to call Stop() it must also follow these calling restrictions.\r
\r
- @param This Protocol instance pointer.\r
- @param ControllerHandle Handle of device to stop driver on\r
- @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r
- children is zero stop the entire bus driver.\r
- @param ChildHandleBuffer List of Child Handles to Stop.\r
+ @param[in] This Protocol instance pointer.\r
+ @param[in] ControllerHandle Handle of device to stop driver on\r
+ @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number\r
+ of children is zero stop the entire bus driver.\r
+ @param[in] ChildHandleBuffer List of Child Handles to Stop.\r
\r
- @retval EFI_SUCCESS This driver is removed ControllerHandle\r
- @retval other This driver was not removed from this device\r
+ @retval EFI_SUCCESS This driver is removed ControllerHandle\r
+ @retval other This driver was not removed from this device\r
\r
**/\r
EFI_STATUS\r
// Function ptototypes for the ServiceBinding Prococol\r
//\r
/**\r
- Creates a child handle with a set of I/O services.\r
+ Creates a child handle and installs a protocol.\r
+ \r
+ The CreateChild() function installs a protocol on ChildHandle. \r
+ If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle. \r
+ If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.\r
\r
- @param This Protocol instance pointer.\r
- @param ChildHandle Pointer to the handle of the child to create. If it is NULL,\r
- then a new handle is created. If it is not NULL, then the\r
- I/O services are added to the existing child handle.\r
+ @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
+ @param ChildHandle Pointer to the handle of the child to create. If it is NULL,\r
+ then a new handle is created. If it is a pointer to an existing UEFI handle, \r
+ then the protocol is added to the existing UEFI handle.\r
\r
- @retval EFI_SUCCES The child handle was created with the I/O services\r
+ @retval EFI_SUCCES The protocol was added to ChildHandle.\r
@retval EFI_INVALID_PARAMETER ChildHandle is NULL.\r
@retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create\r
the child\r
);\r
\r
/**\r
- Destroys a child handle with a set of I/O services.\r
+ Destroys a child handle with a protocol installed on it.\r
+ \r
+ The DestroyChild() function does the opposite of CreateChild(). It removes a protocol \r
+ that was installed by CreateChild() from ChildHandle. If the removed protocol is the \r
+ last protocol on ChildHandle, then ChildHandle is destroyed.\r
\r
- @param This Protocol instance pointer.\r
+ @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
@param ChildHandle Handle of the child to destroy\r
\r
- @retval EFI_SUCCES The I/O services were removed from the child handle\r
- @retval EFI_UNSUPPORTED The child handle does not support the I/O services\r
- that are being removed.\r
- @retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle.\r
- @retval EFI_ACCESS_DENIED The child handle could not be destroyed because its\r
- I/O services are being used.\r
+ @retval EFI_SUCCES The protocol was removed from ChildHandle.\r
+ @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.\r
+ @retval EFI_INVALID_PARAMETER Child handle is not a valid UEFI Handle.\r
+ @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle\r
+ because its services are being used.\r
@retval other The child handle was not destroyed\r
\r
**/\r
/** @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
- Ip4Icmp.c\r
-\r
-Abstract:\r
-\r
-\r
**/\r
\r
#include "Ip4Impl.h"\r
message SHOULD be treated identically to a Host Redirect\r
message;"\r
\r
- @param IpSb The IP4 service binding instance that received the\r
- packet\r
- @param Head The IP head of the received ICMPpacket.\r
- @param Packet The content of the ICMP redirect packet with IP\r
+ @param[in] IpSb The IP4 service binding instance that received \r
+ the packet.\r
+ @param[in] Head The IP head of the received ICMPpacket.\r
+ @param[in] Packet The content of the ICMP redirect packet with IP\r
head removed.\r
- @param Icmp The buffer to store the ICMP error message if\r
+ @param[in] Icmp The buffer to store the ICMP error message if\r
something is wrong.\r
\r
@retval EFI_INVALID_PARAMETER The parameter is invalid\r
update call Ip4ProcessIcmpRedirect to update the IP instance's\r
route cache, otherwise, deliver the packet to upper layer.\r
\r
- @param IpSb The IP service that received the packet.\r
- @param Head The IP head of the ICMP error packet\r
- @param Packet The content of the ICMP error with IP head\r
+ @param[in] IpSb The IP service that received the packet.\r
+ @param[in] Head The IP head of the ICMP error packet\r
+ @param[in] Packet The content of the ICMP error with IP head\r
removed.\r
\r
@retval EFI_SUCCESS The ICMP error is processed successfully.\r
/**\r
Replay an ICMP echo request.\r
\r
- @param IpSb The IP service that receivd the packet\r
- @param Head The IP head of the ICMP error packet\r
- @param Packet The content of the ICMP error with IP head\r
+ @param[in] IpSb The IP service that receivd the packet\r
+ @param[in] Head The IP head of the ICMP error packet\r
+ @param[in] Packet The content of the ICMP error with IP head\r
removed.\r
\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate resource.\r
Process the ICMP query message. If it is an ICMP echo\r
request, answer it. Otherwise deliver it to upper layer.\r
\r
- @param IpSb The IP service that receivd the packet\r
- @param Head The IP head of the ICMP query packet\r
- @param Packet The content of the ICMP query with IP head\r
+ @param[in] IpSb The IP service that receivd the packet\r
+ @param[in] Head The IP head of the ICMP query packet\r
+ @param[in] Packet The content of the ICMP query with IP head\r
removed.\r
\r
@retval EFI_INVALID_PARAMETER The packet is invalid\r
then according to the message types, process it as query or\r
error packet.\r
\r
- @param IpSb The IP service that receivd the packet\r
- @param Head The IP head of the ICMP query packet\r
- @param Packet The content of the ICMP query with IP head\r
+ @param[in] IpSb The IP service that receivd the packet\r
+ @param[in] Head The IP head of the ICMP query packet\r
+ @param[in] Packet The content of the ICMP query with IP head\r
removed.\r
\r
@retval EFI_INVALID_PARAMETER The packet is malformated.\r
/** @file\r
-\r
-Copyright (c) 2005 - 2006, Intel Corporation\r
+ Header file for ICMP protocol.\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
-\r
-Module Name:\r
-\r
- Ip4Icmp.h\r
-\r
-Abstract:\r
-\r
- Header file for ICMP protocol.\r
-\r
-\r
**/\r
\r
#ifndef __EFI_IP4_ICMP_H__\r
then according to the message types, process it as query or\r
error packet.\r
\r
- @param IpSb The IP service that receivd the packet\r
- @param Head The IP head of the ICMP query packet\r
- @param Packet The content of the ICMP query with IP head\r
+ @param[in] IpSb The IP service that receivd the packet\r
+ @param[in] Head The IP head of the ICMP query packet\r
+ @param[in] Packet The content of the ICMP query with IP head\r
removed.\r
\r
@retval EFI_INVALID_PARAMETER The packet is malformated.\r
/** @file\r
-\r
-Copyright (c) 2005 - 2007, Intel Corporation\r
+ Implement IP4 pesudo interface.\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
-\r
-Module Name:\r
-\r
- Ip4If.c\r
-\r
-Abstract:\r
-\r
- Implement IP4 pesudo interface.\r
-\r
-\r
**/\r
\r
#include "Ip4Impl.h"\r
Callback funtion when frame transmission is finished. It will\r
call the frame owner's callback function to tell it the result.\r
\r
- @param Context Context which is point to the token.\r
-\r
- @return None.\r
+ @param[in] Context Context which is point to the token.\r
\r
**/\r
VOID\r
/**\r
Request Ip4OnFrameSentDpc as a DPC at TPL_CALLBACK.\r
\r
- @param Event The transmit token's event.\r
- @param Context Context which is point to the token.\r
-\r
- @return None\r
+ @param[in] Event The transmit token's event.\r
+ @param[in] Context Context which is point to the token.\r
\r
**/\r
VOID\r
all the queued frame if the ARP requests failed. Or transmit them\r
if the request succeed.\r
\r
- @param Context The context of the callback, a point to the ARP\r
+ @param[in] Context The context of the callback, a point to the ARP\r
queue\r
\r
- @return None\r
-\r
**/\r
VOID\r
EFIAPI\r
/**\r
Request Ip4OnArpResolvedDpc as a DPC at TPL_CALLBACK.\r
\r
- @param Event The Arp request event.\r
- @param Context The context of the callback, a point to the ARP\r
- queue.\r
-\r
- @return None\r
-\r
+ @param Event The Arp request event.\r
+ @param Context The context of the callback, a point to the ARP\r
+ queue.\r
+ \r
**/\r
VOID\r
EFIAPI\r
\r
@param Context Context for the callback.\r
\r
- @return None.\r
-\r
**/\r
VOID\r
EFIAPI\r
);\r
\r
/**\r
-\r
Request Ip4OnFrameReceivedDpc as a DPC at TPL_CALLBACK.\r
\r
@param Event The receive event delivered to MNP for receive.\r
@param Context Context for the callback.\r
- \r
- @return None.\r
\r
**/\r
VOID\r
Remove all the frames on the ARP queue that pass the FrameToCancel,\r
that is, either FrameToCancel is NULL or it returns true for the frame.\r
\r
- @param ArpQue ARP frame to remove the frames from.\r
- @param IoStatus The status returned to the cancelled frames'\r
+ @param[in] ArpQue ARP frame to remove the frames from.\r
+ @param[in] IoStatus The status returned to the cancelled frames'\r
callback function.\r
- @param FrameToCancel Function to select which frame to cancel.\r
- @param Context Opaque parameter to the FrameToCancel.\r
-\r
- @return NONE\r
+ @param[in] FrameToCancel Function to select which frame to cancel.\r
+ @param[in] Context Opaque parameter to the FrameToCancel.\r
\r
**/\r
VOID\r
/**\r
Wrap a transmit request into a newly allocated IP4_LINK_TX_TOKEN.\r
\r
- @param Interface The interface to send out to.\r
- @param IpInstance The IpInstance that transmit the packet. NULL if\r
+ @param[in] Interface The interface to send out to.\r
+ @param[in] IpInstance The IpInstance that transmit the packet. NULL if\r
the packet is sent by the IP4 driver itself.\r
- @param Packet The packet to transmit\r
- @param CallBack Call back function to execute if transmission\r
+ @param[in] Packet The packet to transmit\r
+ @param[in] CallBack Call back function to execute if transmission\r
finished.\r
- @param Context Opaque parameter to the call back.\r
+ @param[in] Context Opaque parameter to the call back.\r
\r
- @return The wrapped token if succeed or NULL\r
+ @retval Token The wrapped token if succeed \r
+ @retval NULL The wrapped token if NULL\r
\r
**/\r
IP4_LINK_TX_TOKEN *\r
Free the link layer transmit token. It will close the event\r
then free the memory used.\r
\r
- @param Token Token to free\r
-\r
- @return NONE\r
+ @param[in] Token Token to free\r
\r
**/\r
VOID\r
/**\r
Create an IP_ARP_QUE structure to request ARP service.\r
\r
- @param Interface The interface to send ARP from.\r
- @param DestIp The destination IP (host byte order) to request MAC\r
+ @param[in] Interface The interface to send ARP from.\r
+ @param[in] DestIp The destination IP (host byte order) to request MAC\r
for\r
\r
@return Point to newly created IP4_ARP_QUE if succeed, otherwise NULL.\r
/**\r
Remove all the transmit requests queued on the ARP queue, then free it.\r
\r
- @param ArpQue Arp queue to free\r
- @param IoStatus The transmit status returned to transmit requests'\r
+ @param[in] ArpQue Arp queue to free\r
+ @param[in] IoStatus The transmit status returned to transmit requests'\r
callback.\r
\r
- @return NONE\r
-\r
**/\r
VOID\r
Ip4FreeArpQue (\r
/**\r
Create a link layer receive token to wrap the receive request\r
\r
- @param Interface The interface to receive from\r
- @param IpInstance The instance that request the receive (NULL for IP4\r
+ @param[in] Interface The interface to receive from\r
+ @param[in] IpInstance The instance that request the receive (NULL for IP4\r
driver itself)\r
- @param CallBack Call back function to execute when finished.\r
- @param Context Opaque parameters to the callback\r
+ @param[in] CallBack Call back function to execute when finished.\r
+ @param[in] Context Opaque parameters to the callback\r
\r
@return Point to created IP4_LINK_RX_TOKEN if succeed, otherwise NULL.\r
\r
Free the link layer request token. It will close the event\r
then free the memory used.\r
\r
- @param Token Request token to free\r
-\r
- @return NONE\r
+ @param[in] Token Request token to free.\r
\r
**/\r
VOID\r
Remove all the frames on the ARP queue that pass the FrameToCancel,\r
that is, either FrameToCancel is NULL or it returns true for the frame.\r
\r
- @param ArpQue ARP frame to remove the frames from.\r
- @param IoStatus The status returned to the cancelled frames'\r
+ @param[in] ArpQue ARP frame to remove the frames from.\r
+ @param[in] IoStatus The status returned to the cancelled frames'\r
callback function.\r
- @param FrameToCancel Function to select which frame to cancel.\r
- @param Context Opaque parameter to the FrameToCancel.\r
-\r
- @return NONE\r
+ @param[in] FrameToCancel Function to select which frame to cancel.\r
+ @param[in] Context Opaque parameter to the FrameToCancel.\r
\r
**/\r
VOID\r
either queued on ARP queues or that have already been delivered to\r
MNP and not yet recycled.\r
\r
- @param Interface Interface to remove the frames from\r
- @param IoStatus The transmit status returned to the frames'\r
+ @param[in] Interface Interface to remove the frames from\r
+ @param[in] IoStatus The transmit status returned to the frames'\r
callback\r
- @param FrameToCancel Function to select the frame to cancel, NULL to\r
+ @param[in] FrameToCancel Function to select the frame to cancel, NULL to\r
select all\r
- @param Context Opaque parameters passed to FrameToCancel\r
-\r
- @return NONE\r
+ @param[in] Context Opaque parameters passed to FrameToCancel\r
\r
**/\r
VOID\r
Create an IP4_INTERFACE. Delay the creation of ARP instance until\r
the interface is configured.\r
\r
- @param Mnp The shared MNP child of this IP4 service binding\r
+ @param[in] Mnp The shared MNP child of this IP4 service binding\r
instance\r
- @param Controller The controller this IP4 service binding instance\r
+ @param[in] Controller The controller this IP4 service binding instance\r
is installed. Most like the UNDI handle.\r
- @param ImageHandle This driver's image handle\r
+ @param[in] ImageHandle This driver's image handle\r
\r
@return Point to the created IP4_INTERFACE, otherwise NULL.\r
\r
Set the interface's address, create and configure\r
the ARP child if necessary.\r
\r
- @param Interface The interface to set the address\r
- @param IpAddr The interface's IP address\r
- @param SubnetMask The interface's netmask\r
+ @param Interface The interface to set the address\r
+ @param IpAddr The interface's IP address\r
+ @param SubnetMask The interface's netmask\r
\r
@retval EFI_SUCCESS The interface is configured with Ip/netmask pair,\r
and a ARP is created for it.\r
/**\r
Filter function to cancel all the frame related to an IP instance.\r
\r
- @param Frame The transmit request to test whether to cancel\r
- @param Context The context which is the Ip instance that issued\r
+ @param[in] Frame The transmit request to test whether to cancel\r
+ @param[in] Context The context which is the Ip instance that issued\r
the transmit.\r
\r
@retval TRUE The frame belongs to this instance and is to be\r
packet and update the upper layer's transmit request status, say\r
that from the UDP.\r
\r
- @param Interface The interface used by the IpInstance\r
-\r
- @return None\r
+ @param[in] Interface The interface used by the IpInstance\r
\r
**/\r
VOID\r
Because the IpInstance is optional, the caller must remove\r
IpInstance from the interface's instance list itself.\r
\r
- @param Interface The interface used by the IpInstance\r
- @param IpInstance The Ip instance that free the interface. NULL if\r
+ @param[in] Interface The interface used by the IpInstance\r
+ @param[in] IpInstance The Ip instance that free the interface. NULL if\r
the Ip driver is releasing the default interface.\r
\r
@retval EFI_SUCCESS The interface use IpInstance is freed.\r
all the queued frame if the ARP requests failed. Or transmit them\r
if the request succeed.\r
\r
- @param Context The context of the callback, a point to the ARP\r
+ @param[in] Context The context of the callback, a point to the ARP\r
queue\r
\r
- @return None\r
-\r
**/\r
VOID\r
EFIAPI\r
/**\r
Request Ip4OnArpResolvedDpc as a DPC at TPL_CALLBACK.\r
\r
- @param Event The Arp request event.\r
- @param Context The context of the callback, a point to the ARP\r
- queue.\r
-\r
- @return None\r
-\r
+ @param Event The Arp request event.\r
+ @param Context The context of the callback, a point to the ARP\r
+ queue.\r
+ \r
**/\r
VOID\r
EFIAPI\r
Callback funtion when frame transmission is finished. It will\r
call the frame owner's callback function to tell it the result.\r
\r
- @param Context Context which is point to the token.\r
-\r
- @return None.\r
+ @param[in] Context Context which is point to the token.\r
\r
**/\r
VOID\r
/**\r
Request Ip4OnFrameSentDpc as a DPC at TPL_CALLBACK.\r
\r
- @param Event The transmit token's event.\r
- @param Context Context which is point to the token.\r
-\r
- @return None\r
+ @param[in] Event The transmit token's event.\r
+ @param[in] Context Context which is point to the token.\r
\r
**/\r
VOID\r
If some error happened, the CallBack won't be called. So, the caller\r
must test the return value, and take action when there is an error.\r
\r
- @param Interface The interface to send the frame from\r
- @param IpInstance The IP child that request the transmission. NULL\r
+ @param[in] Interface The interface to send the frame from\r
+ @param[in] IpInstance The IP child that request the transmission. NULL\r
if it is the IP4 driver itself.\r
- @param Packet The packet to transmit.\r
- @param NextHop The immediate destination to transmit the packet\r
+ @param[in] Packet The packet to transmit.\r
+ @param[in] NextHop The immediate destination to transmit the packet\r
to.\r
- @param CallBack Function to call back when transmit finished.\r
- @param Context Opaque parameter to the call back.\r
+ @param[in] CallBack Function to call back when transmit finished.\r
+ @param[in] Context Opaque parameter to the call back.\r
\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate resource to send the frame\r
@retval EFI_NO_MAPPING Can't resolve the MAC for the nexthop\r
Call back function when the received packet is freed.\r
Check Ip4OnFrameReceived for information.\r
\r
- @param Context Context, which is the IP4_LINK_RX_TOKEN.\r
-\r
- @return None.\r
+ @param Context Context, which is the IP4_LINK_RX_TOKEN.\r
\r
**/\r
VOID\r
\r
@param Context Context for the callback.\r
\r
- @return None.\r
-\r
**/\r
VOID\r
EFIAPI\r
}\r
\r
/**\r
-\r
Request Ip4OnFrameReceivedDpc as a DPC at TPL_CALLBACK.\r
\r
@param Event The receive event delivered to MNP for receive.\r
@param Context Context for the callback.\r
- \r
- @return None.\r
\r
**/\r
VOID\r
/**\r
Request to receive the packet from the interface.\r
\r
- @param Interface The interface to receive the frames from\r
- @param IpInstance The instance that requests the receive. NULL for\r
+ @param[in] Interface The interface to receive the frames from\r
+ @param[in] IpInstance The instance that requests the receive. NULL for\r
the driver itself.\r
- @param CallBack Function to call when receive finished.\r
- @param Context Opaque parameter to the callback\r
+ @param[in] CallBack Function to call when receive finished.\r
+ @param[in] Context Opaque parameter to the callback\r
\r
@retval EFI_ALREADY_STARTED There is already a pending receive request.\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate resource to receive\r
/** @file\r
-\r
-Copyright (c) 2005 - 2006, Intel Corporation\r
+ Definition for IP4 pesudo interface structure.\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
-\r
-Module Name:\r
-\r
- Ip4If.h\r
-\r
-Abstract:\r
-\r
- Definition for IP4 pesudo interface structure.\r
-\r
-\r
**/\r
\r
#ifndef __EFI_IP4_IF_H__\r
When transmitting, the Netbuf is from IP4, and provided\r
to the callback as a reference. Flag isn't used.\r
\r
- @param IpInstance The instance that sent or received the packet.\r
- IpInstance can be NULL which means that it is the IP4 driver\r
- itself sending the packets. IP4 driver may send packets that\r
- don't belong to any instance, such as ICMP errors, ICMP echo\r
- responses, or IGMP packets. IpInstance is used as a tag in\r
- this module.\r
- @param Packet The sent or received packet.\r
- @param IoStatus Status of sending or receiving.\r
- @param LinkFlag Indicate if the frame is received as link broadcast/multicast.\r
- When transmitting, it is not used.\r
- @param Context Additional data for callback.\r
-\r
- @return None.\r
+ @param[in] IpInstance The instance that sent or received the packet.\r
+ IpInstance can be NULL which means that it is the IP4 driver\r
+ itself sending the packets. IP4 driver may send packets that\r
+ don't belong to any instance, such as ICMP errors, ICMP echo\r
+ responses, or IGMP packets. IpInstance is used as a tag in\r
+ this module.\r
+ @param[in] Packet The sent or received packet.\r
+ @param[in] IoStatus Status of sending or receiving.\r
+ @param[in] LinkFlag Indicate if the frame is received as link broadcast/multicast.\r
+ When transmitting, it is not used.\r
+ @param[in] Context Additional data for callback.\r
+\r
+ @retval None.\r
**/\r
typedef\r
VOID\r
(*IP4_FRAME_CALLBACK)(\r
- IN IP4_PROTOCOL *IpInstance, OPTIONAL\r
+ IN IP4_PROTOCOL *IpInstance OPTIONAL,\r
IN NET_BUF *Packet,\r
IN EFI_STATUS IoStatus,\r
IN UINT32 LinkFlag,\r
Create an IP4_INTERFACE. Delay the creation of ARP instance until\r
the interface is configured.\r
\r
- @param Mnp The shared MNP child of this IP4 service binding\r
+ @param[in] Mnp The shared MNP child of this IP4 service binding\r
instance\r
- @param Controller The controller this IP4 service binding instance\r
+ @param[in] Controller The controller this IP4 service binding instance\r
is installed. Most like the UNDI handle.\r
- @param ImageHandle This driver's image handle\r
+ @param[in] ImageHandle This driver's image handle\r
\r
@return Point to the created IP4_INTERFACE, otherwise NULL.\r
\r
Set the interface's address, create and configure\r
the ARP child if necessary.\r
\r
- @param Interface The interface to set the address\r
- @param IpAddr The interface's IP address\r
- @param SubnetMask The interface's netmask\r
+ @param Interface The interface to set the address\r
+ @param IpAddr The interface's IP address\r
+ @param SubnetMask The interface's netmask\r
\r
@retval EFI_SUCCESS The interface is configured with Ip/netmask pair,\r
and a ARP is created for it.\r
Because the IpInstance is optional, the caller must remove\r
IpInstance from the interface's instance list itself.\r
\r
- @param Interface The interface used by the IpInstance\r
- @param IpInstance The Ip instance that free the interface. NULL if\r
+ @param[in] Interface The interface used by the IpInstance\r
+ @param[in] IpInstance The Ip instance that free the interface. NULL if\r
the Ip driver is releasing the default interface.\r
\r
@retval EFI_SUCCESS The interface use IpInstance is freed.\r
If some error happened, the CallBack won't be called. So, the caller\r
must test the return value, and take action when there is an error.\r
\r
- @param Interface The interface to send the frame from\r
- @param IpInstance The IP child that request the transmission. NULL\r
+ @param[in] Interface The interface to send the frame from\r
+ @param[in] IpInstance The IP child that request the transmission. NULL\r
if it is the IP4 driver itself.\r
- @param Packet The packet to transmit.\r
- @param NextHop The immediate destination to transmit the packet\r
+ @param[in] Packet The packet to transmit.\r
+ @param[in] NextHop The immediate destination to transmit the packet\r
to.\r
- @param CallBack Function to call back when transmit finished.\r
- @param Context Opaque parameter to the call back.\r
+ @param[in] CallBack Function to call back when transmit finished.\r
+ @param[in] Context Opaque parameter to the call back.\r
\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate resource to send the frame\r
@retval EFI_NO_MAPPING Can't resolve the MAC for the nexthop\r
either queued on ARP queues or that have already been delivered to\r
MNP and not yet recycled.\r
\r
- @param Interface Interface to remove the frames from\r
- @param IoStatus The transmit status returned to the frames'\r
+ @param[in] Interface Interface to remove the frames from\r
+ @param[in] IoStatus The transmit status returned to the frames'\r
callback\r
- @param FrameToCancel Function to select the frame to cancel, NULL to\r
+ @param[in] FrameToCancel Function to select the frame to cancel, NULL to\r
select all\r
- @param Context Opaque parameters passed to FrameToCancel\r
-\r
- @return NONE\r
+ @param[in] Context Opaque parameters passed to FrameToCancel\r
\r
**/\r
VOID\r
packet and update the upper layer's transmit request status, say\r
that from the UDP.\r
\r
- @param Interface The interface used by the IpInstance\r
-\r
- @return None\r
+ @param[in] Interface The interface used by the IpInstance\r
\r
**/\r
VOID\r
/**\r
Request to receive the packet from the interface.\r
\r
- @param Interface The interface to receive the frames from\r
- @param IpInstance The instance that requests the receive. NULL for\r
+ @param[in] Interface The interface to receive the frames from\r
+ @param[in] IpInstance The instance that requests the receive. NULL for\r
the driver itself.\r
- @param CallBack Function to call when receive finished.\r
- @param Context Opaque parameter to the callback\r
+ @param[in] CallBack Function to call when receive finished.\r
+ @param[in] Context Opaque parameter to the callback\r
\r
@retval EFI_ALREADY_STARTED There is already a pending receive request.\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate resource to receive\r
/** @file\r
-\r
-Copyright (c) 2005 - 2006, Intel Corporation\r
+ This file implements the RFC2236: IGMP v2.\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
-\r
-Module Name:\r
-\r
- Ip4Igmp.c\r
-\r
-Abstract:\r
-\r
- This file implements the RFC2236: IGMP v2\r
-\r
-\r
**/\r
\r
#include "Ip4Impl.h"\r
Init the IGMP control data of the IP4 service instance, configure\r
MNP to receive ALL SYSTEM multicast.\r
\r
- @param IpSb The IP4 service whose IGMP is to be initialized.\r
+ @param[in, out] IpSb The IP4 service whose IGMP is to be initialized.\r
\r
@retval EFI_SUCCESS IGMP of the IpSb is successfully initialized.\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate resource to initialize IGMP.\r
Find the IGMP_GROUP structure which contains the status of multicast\r
group Address in this IGMP control block\r
\r
- @param IgmpCtrl The IGMP control block to search from\r
- @param Address The multicast address to search\r
+ @param[in] IgmpCtrl The IGMP control block to search from\r
+ @param[in] Address The multicast address to search\r
\r
@return NULL if the multicast address isn't in the IGMP control block. Otherwise\r
the point to the IGMP_GROUP which contains the status of multicast group\r
same MAC address. Several IP4 multicast address may be mapped to\r
the same MAC address.\r
\r
- @param IgmpCtrl The IGMP control block to search in\r
- @param Mac The MAC address to search\r
+ @param[in] IgmpCtrl The IGMP control block to search in\r
+ @param[in] Mac The MAC address to search\r
\r
@return The number of the IP4 multicast group that mapped to the same\r
multicast group Mac.\r
/**\r
Send an IGMP protocol message to the Dst, such as IGMP v1 membership report.\r
\r
- @param IpSb The IP4 service instance that requests the\r
+ @param[in] IpSb The IP4 service instance that requests the\r
transmission\r
- @param Dst The destinaton to send to\r
- @param Type The IGMP message type, such as IGMP v1 membership\r
+ @param[in] Dst The destinaton to send to\r
+ @param[in] Type The IGMP message type, such as IGMP v1 membership\r
report\r
- @param Group The group address in the IGMP message head.\r
+ @param[in] Group The group address in the IGMP message head.\r
\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory to build the message\r
@retval EFI_SUCCESS The IGMP message is successfully send\r
Send an IGMP membership report. Depends on whether the server is\r
v1 or v2, it will send either a V1 or V2 membership report.\r
\r
- @param IpSb The IP4 service instance that requests the\r
+ @param[in] IpSb The IP4 service instance that requests the\r
transmission.\r
- @param Group The group address to report\r
+ @param[in] Group The group address to report\r
\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory to build the message\r
@retval EFI_SUCCESS The IGMP report message is successfully send\r
/**\r
Join the multicast group on behalf of this IP4 child\r
\r
- @param IpInstance The IP4 child that wants to join the group\r
- @param Address The group to join\r
+ @param[in] IpInstance The IP4 child that wants to join the group\r
+ @param[in] Address The group to join\r
\r
@retval EFI_SUCCESS Successfully join the multicast group\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate resources\r
/**\r
Leave the IP4 multicast group on behalf of IpInstance.\r
\r
- @param IpInstance The IP4 child that wants to leave the group\r
+ @param[in] IpInstance The IP4 child that wants to leave the group\r
address\r
- @param Address The group address to leave\r
+ @param[in] Address The group address to leave\r
\r
@retval EFI_NOT_FOUND The IP4 service instance isn't in the group\r
@retval EFI_SUCCESS Successfully leave the multicast group.\r
/**\r
Handle the received IGMP message for the IP4 service instance.\r
\r
- @param IpSb The IP4 service instance that received the message\r
- @param Head The IP4 header of the received message\r
- @param Packet The IGMP message, without IP4 header\r
+ @param[in] IpSb The IP4 service instance that received the message\r
+ @param[in] Head The IP4 header of the received message\r
+ @param[in] Packet The IGMP message, without IP4 header\r
\r
@retval EFI_INVALID_PARAMETER The IGMP message is malformated.\r
@retval EFI_SUCCESS The IGMP message is successfully processed.\r
2. Decrease the report timer for each IGMP group in "delaying\r
member" state.\r
\r
- @param IpSb The IP4 service instance that is ticking\r
-\r
- @return None\r
+ @param[in] IpSb The IP4 service instance that is ticking\r
\r
**/\r
VOID\r
assume the byte order of the both Source and Addr, the\r
network byte order is used by the caller.\r
\r
- @param Source The array of group addresses to add to\r
- @param Count The number of group addresses in the Source\r
- @param Addr The IP4 multicast address to add\r
+ @param[in] Source The array of group addresses to add to\r
+ @param[in] Count The number of group addresses in the Source\r
+ @param[in] Addr The IP4 multicast address to add\r
\r
@return NULL if failed to allocate memory for the new groups,\r
otherwise the new combined group addresses.\r
both Groups and Addr, the network byte order is used by\r
the caller.\r
\r
- @param Groups The array of group addresses to remove from\r
- @param Count The number of group addresses in the Groups\r
- @param Addr The IP4 multicast address to remove\r
+ @param Groups The array of group addresses to remove from\r
+ @param Count The number of group addresses in the Groups\r
+ @param Addr The IP4 multicast address to remove\r
\r
@return The nubmer of group addresses in the Groups after remove.\r
It is Count if the Addr isn't in the Groups.\r
/** @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
- Ip4Igmp.h\r
-\r
-Abstract:\r
-\r
-\r
**/\r
\r
#ifndef __EFI_IP4_IGMP_H__\r
Init the IGMP control data of the IP4 service instance, configure\r
MNP to receive ALL SYSTEM multicast.\r
\r
- @param IpSb The IP4 service whose IGMP is to be initialized.\r
+ @param[in, out] IpSb The IP4 service whose IGMP is to be initialized.\r
\r
@retval EFI_SUCCESS IGMP of the IpSb is successfully initialized.\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate resource to initialize IGMP.\r
/**\r
Join the multicast group on behalf of this IP4 child\r
\r
- @param IpInstance The IP4 child that wants to join the group\r
- @param Address The group to join\r
+ @param[in] IpInstance The IP4 child that wants to join the group\r
+ @param[in] Address The group to join\r
\r
@retval EFI_SUCCESS Successfully join the multicast group\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate resources\r
/**\r
Leave the IP4 multicast group on behalf of IpInstance.\r
\r
- @param IpInstance The IP4 child that wants to leave the group\r
+ @param[in] IpInstance The IP4 child that wants to leave the group\r
address\r
- @param Address The group address to leave\r
+ @param[in] Address The group address to leave\r
\r
@retval EFI_NOT_FOUND The IP4 service instance isn't in the group\r
@retval EFI_SUCCESS Successfully leave the multicast group.\r
/**\r
Handle the received IGMP message for the IP4 service instance.\r
\r
- @param IpSb The IP4 service instance that received the message\r
- @param Head The IP4 header of the received message\r
- @param Packet The IGMP message, without IP4 header\r
+ @param[in] IpSb The IP4 service instance that received the message\r
+ @param[in] Head The IP4 header of the received message\r
+ @param[in] Packet The IGMP message, without IP4 header\r
\r
@retval EFI_INVALID_PARAMETER The IGMP message is malformated.\r
@retval EFI_SUCCESS The IGMP message is successfully processed.\r
2. Decrease the report timer for each IGMP group in "delaying\r
member" state.\r
\r
- @param IpSb The IP4 service instance that is ticking\r
-\r
- @return None\r
+ @param[in] IpSb The IP4 service instance that is ticking\r
\r
**/\r
VOID\r
assume the byte order of the both Source and Addr, the\r
network byte order is used by the caller.\r
\r
- @param Source The array of group addresses to add to\r
- @param Count The number of group addresses in the Source\r
- @param Addr The IP4 multicast address to add\r
+ @param[in] Source The array of group addresses to add to\r
+ @param[in] Count The number of group addresses in the Source\r
+ @param[in] Addr The IP4 multicast address to add\r
\r
@return NULL if failed to allocate memory for the new groups,\r
otherwise the new combined group addresses.\r
both Groups and Addr, the network byte order is used by\r
the caller.\r
\r
- @param Groups The array of group addresses to remove from\r
- @param Count The number of group addresses in the Groups\r
- @param Addr The IP4 multicast address to remove\r
+ @param Groups The array of group addresses to remove from\r
+ @param Count The number of group addresses in the Groups\r
+ @param Addr The IP4 multicast address to remove\r
\r
@return The nubmer of group addresses in the Groups after remove.\r
It is Count if the Addr isn't in the Groups.\r
Find the IGMP_GROUP structure which contains the status of multicast\r
group Address in this IGMP control block\r
\r
- @param IgmpCtrl The IGMP control block to search from\r
- @param Address The multicast address to search\r
+ @param[in] IgmpCtrl The IGMP control block to search from\r
+ @param[in] Address The multicast address to search\r
\r
@return NULL if the multicast address isn't in the IGMP control block. Otherwise\r
the point to the IGMP_GROUP which contains the status of multicast group\r
/** @file\r
\r
-Copyright (c) 2005 - 2007, Intel Corporation\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
-\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
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
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
}\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
VOID\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
\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
@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
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
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
/** @file\r
-\r
-Copyright (c) 2005 - 2007, Intel Corporation \r
+ Ip4 internal functions and type defintions.\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
- Ip4Impl.h\r
-\r
-Abstract:\r
-\r
- Ip4 internal functions and type defintions.\r
-\r
-\r
**/\r
\r
#ifndef __EFI_IP4_IMPL_H__\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
@param IpSb The IP4 service instance.\r
@param IpInstance The IP4 child instance.\r
\r
- @return None\r
-\r
**/\r
VOID\r
Ip4InitProtocol (\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
/**\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
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
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
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
/** @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
/** @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
-Module Name:\r
-\r
- Ip4Input.h\r
-\r
-Abstract:\r
-\r
-\r
**/\r
\r
#ifndef __EFI_IP4_INPUT_H__\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
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
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
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
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
/**\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
/** @file\r
-\r
-Copyright (c) 2005 - 2006, Intel Corporation\r
+ IP4 option support functions.\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
- Ip4Option.c\r
-\r
-Abstract:\r
-\r
- IP4 option support functions\r
-\r
-\r
**/\r
\r
#include "Ip4Impl.h"\r
and will transmit. It will compute the ICMP error message fields\r
if the option is mal-formated. But this information isn't used.\r
\r
- @param Option The first byte of the option\r
- @param OptionLen The length of the whole option\r
- @param Rcvd The option is from the packet we received if TRUE,\r
+ @param[in] Option The first byte of the option\r
+ @param[in] OptionLen The length of the whole option\r
+ @param[in] Rcvd The option is from the packet we received if TRUE,\r
otherwise the option we wants to transmit.\r
\r
@retval TRUE The option is properly formatted\r
fragments.\r
2. Pad the options copied over to aligned to 4 bytes.\r
\r
- @param Option The original option to copy from\r
- @param OptionLen The length of the original option\r
- @param FirstFragment Whether it is the first fragment\r
- @param Buf The buffer to copy options to. NULL \r
- @param BufLen The length of the buffer\r
+ @param[in] Option The original option to copy from\r
+ @param[in] OptionLen The length of the original option\r
+ @param[in] FirstFragment Whether it is the first fragment\r
+ @param[in, out] Buf The buffer to copy options to. NULL \r
+ @param[in, out] BufLen The length of the buffer\r
\r
@retval EFI_SUCCESS The options are copied over\r
@retval EFI_BUFFER_TOO_SMALL Buf is NULL or BufLen provided is too small.\r
/** @file\r
-\r
-Copyright (c) 2005 - 2006, Intel Corporation\r
+ IP4 option support routines.\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
-\r
-Module Name:\r
-\r
- Ip4Option.h\r
-\r
-Abstract:\r
-\r
- IP4 option support routines.\r
-\r
-\r
**/\r
\r
#ifndef __EFI_IP4_OPTION_H__\r
and will transmit. It will compute the ICMP error message fields\r
if the option is mal-formated. But this information isn't used.\r
\r
- @param Option The first byte of the option\r
- @param OptionLen The length of the whole option\r
- @param Rcvd The option is from the packet we received if TRUE,\r
+ @param[in] Option The first byte of the option\r
+ @param[in] OptionLen The length of the whole option\r
+ @param[in] Rcvd The option is from the packet we received if TRUE,\r
otherwise the option we wants to transmit.\r
\r
@retval TRUE The option is properly formatted\r
fragments.\r
2. Pad the options copied over to aligned to 4 bytes.\r
\r
- @param Option The original option to copy from\r
- @param OptionLen The length of the original option\r
- @param FirstFragment Whether it is the first fragment\r
- @param Buf The buffer to copy options to. NULL \r
- @param BufLen The length of the buffer\r
+ @param[in] Option The original option to copy from\r
+ @param[in] OptionLen The length of the original option\r
+ @param[in] FirstFragment Whether it is the first fragment\r
+ @param[in, out] Buf The buffer to copy options to. NULL \r
+ @param[in, out] BufLen The length of the buffer\r
\r
@retval EFI_SUCCESS The options are copied over\r
@retval EFI_BUFFER_TOO_SMALL Buf is NULL or BufLen provided is too small.\r
/** @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
/** @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
-Module Name:\r
-\r
- Ip4Output.h\r
-\r
-Abstract:\r
-\r
-\r
**/\r
\r
#ifndef __EFI_IP4_OUTPUT_H__\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
@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
/** @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
/** @file\r
-\r
-Copyright (c) 2005 - 2006, Intel Corporation\r
+ EFI IP4 route table and route cache table defintions.\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
-\r
-Module Name:\r
-\r
- Ip4Route.h\r
-\r
-Abstract:\r
-\r
- EFI IP4 route table and route cache table defintions.\r
-\r
-\r
**/\r
\r
#ifndef __EFI_IP4_ROUTE_H__\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
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
\r
@param RtCacheEntry The route cache entry to free.\r
\r
- @return None\r
-\r
**/\r
VOID\r
Ip4FreeRouteCacheEntry (\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
/** @file\r
UEFI Component Name(2) protocol implementation for MnpDxe driver.\r
\r
-Copyright (c) 2005 - 2007, Intel Corporation. <BR> \r
-All rights reserved. This program and the accompanying materials are licensed \r
-and made available under the terms and conditions of the BSD License which \r
-accompanies this distribution. The full text of the license may be found at \r
-http://opensource.org/licenses/bsd-license.php \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
+http://opensource.org/licenses/bsd-license.php\r
\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
by This does not support the language specified by Language,\r
then EFI_UNSUPPORTED is returned.\r
\r
- @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
+ @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
EFI_COMPONENT_NAME_PROTOCOL instance.\r
\r
- @param Language[in] A pointer to a Null-terminated ASCII string\r
+ @param[in] Language A pointer to a Null-terminated ASCII string\r
array indicating the language. This is the\r
language of the driver name that the caller is\r
requesting, and it must match one of the\r
to the driver writer. Language is specified\r
in RFC 3066 or ISO 639-2 language code format.\r
\r
- @param DriverName[out] A pointer to the Unicode string to return.\r
+ @param[out] DriverName A pointer to the Unicode string to return.\r
This Unicode string is the name of the\r
driver specified by This in the language\r
specified by Language.\r
then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r
support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
\r
- @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
+ @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
EFI_COMPONENT_NAME_PROTOCOL instance.\r
\r
- @param ControllerHandle[in] The handle of a controller that the driver\r
+ @param[in] ControllerHandle The handle of a controller that the driver\r
specified by This is managing. This handle\r
specifies the controller whose name is to be\r
returned.\r
\r
- @param ChildHandle[in] The handle of the child controller to retrieve\r
+ @param[in] ChildHandle The handle of the child controller to retrieve\r
the name of. This is an optional parameter that\r
may be NULL. It will be NULL for device\r
drivers. It will also be NULL for a bus drivers\r
driver that wishes to retrieve the name of a\r
child controller.\r
\r
- @param Language[in] A pointer to a Null-terminated ASCII string\r
+ @param[in] Language A pointer to a Null-terminated ASCII string\r
array indicating the language. This is the\r
language of the driver name that the caller is\r
requesting, and it must match one of the\r
to the driver writer. Language is specified in\r
RFC 3066 or ISO 639-2 language code format.\r
\r
- @param ControllerName[out] A pointer to the Unicode string to return.\r
+ @param[out] ControllerName A pointer to the Unicode string to return.\r
This Unicode string is the name of the\r
controller specified by ControllerHandle and\r
ChildHandle in the language specified by\r
by This does not support the language specified by Language,\r
then EFI_UNSUPPORTED is returned.\r
\r
- @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
+ @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
EFI_COMPONENT_NAME_PROTOCOL instance.\r
\r
- @param Language[in] A pointer to a Null-terminated ASCII string\r
+ @param[in] Language A pointer to a Null-terminated ASCII string\r
array indicating the language. This is the\r
language of the driver name that the caller is\r
requesting, and it must match one of the\r
to the driver writer. Language is specified\r
in RFC 3066 or ISO 639-2 language code format.\r
\r
- @param DriverName[out] A pointer to the Unicode string to return.\r
+ @param[out] DriverName A pointer to the Unicode string to return.\r
This Unicode string is the name of the\r
driver specified by This in the language\r
specified by Language.\r
then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r
support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
\r
- @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
+ @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
EFI_COMPONENT_NAME_PROTOCOL instance.\r
\r
- @param ControllerHandle[in] The handle of a controller that the driver\r
+ @param[in] ControllerHandle The handle of a controller that the driver\r
specified by This is managing. This handle\r
specifies the controller whose name is to be\r
returned.\r
\r
- @param ChildHandle[in] The handle of the child controller to retrieve\r
+ @param[in] ChildHandle The handle of the child controller to retrieve\r
the name of. This is an optional parameter that\r
may be NULL. It will be NULL for device\r
drivers. It will also be NULL for a bus drivers\r
driver that wishes to retrieve the name of a\r
child controller.\r
\r
- @param Language[in] A pointer to a Null-terminated ASCII string\r
+ @param[in] Language A pointer to a Null-terminated ASCII string\r
array indicating the language. This is the\r
language of the driver name that the caller is\r
requesting, and it must match one of the\r
to the driver writer. Language is specified in\r
RFC 3066 or ISO 639-2 language code format.\r
\r
- @param ControllerName[out] A pointer to the Unicode string to return.\r
+ @param[out] ControllerName A pointer to the Unicode string to return.\r
This Unicode string is the name of the\r
controller specified by ControllerHandle and\r
ChildHandle in the language specified by\r
/** @file\r
Implementation of Managed Network Protocol private services.\r
-\r
-Copyright (c) 2005 - 2008, Intel Corporation. <BR> \r
-All rights reserved. This program and the accompanying materials are licensed \r
-and made available under the terms and conditions of the BSD License which \r
-accompanies this distribution. The full text of the license may be found at \r
-http://opensource.org/licenses/bsd-license.php \r
+ \r
+Copyright (c) 2005 - 2008, 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
+http://opensource.org/licenses/bsd-license.php\r
\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
Configure the Snp receive filters according to the instances' receive filter\r
settings.\r
\r
- @param MnpServiceData Pointer to the mnp service context data.\r
+ @param[in] MnpServiceData Pointer to the mnp service context data.\r
\r
@retval EFI_SUCCESS The receive filters is configured.\r
@retval EFI_OUT_OF_RESOURCES The receive filters can't be configured due to \r
Add Count of net buffers to MnpServiceData->FreeNbufQue. The length of the net\r
buffer is specified by MnpServiceData->BufferLength. \r
\r
- @param MnpServiceData Pointer to the MNP_SERVICE_DATA.\r
- @param Count Number of NET_BUFFERs to add.\r
+ @param[in] MnpServiceData Pointer to the MNP_SERVICE_DATA.\r
+ @param[in] Count Number of NET_BUFFERs to add.\r
\r
@retval EFI_SUCCESS The specified amount of NET_BUFs are allocated \r
and added to MnpServiceData->FreeNbufQue.\r
in the queue, first try to allocate some and add them into the queue, then\r
fetch the NET_BUF from the updated FreeNbufQue.\r
\r
- @param MnpServiceData Pointer to the MNP_SERVICE_DATA.\r
+ @param[in] MnpServiceData Pointer to the MNP_SERVICE_DATA.\r
\r
@return Pointer to the allocated free NET_BUF structure, if NULL the \r
operation is failed.\r
\r
@param MnpServiceData Pointer to the mnp service context data.\r
@param Nbuf Pointer to the NET_BUF to free.\r
-\r
+ \r
**/\r
VOID\r
MnpFreeNbuf (\r
/**\r
Initialize the mnp service context data.\r
\r
- @param MnpServiceData Pointer to the mnp service context data.\r
- @param ImageHandle The driver image handle.\r
- @param ControllerHandle Handle of device to bind driver to.\r
+ @param[in] MnpServiceData Pointer to the mnp service context data.\r
+ @param[in] ImageHandle The driver image handle.\r
+ @param[in] ControllerHandle Handle of device to bind driver to.\r
\r
@retval EFI_SUCCESS The mnp service context is initialized.\r
@retval Other Some error occurs.\r
\r
@param MnpServiceData Pointer to the mnp service context data.\r
@param ImageHandle The driver image handle.\r
-\r
+ \r
**/\r
VOID\r
MnpFlushServiceData (\r
/**\r
Initialize the mnp instance context data.\r
\r
- @param MnpServiceData Pointer to the mnp service context data.\r
- @param Instance Pointer to the mnp instance context data to\r
+ @param[in] MnpServiceData Pointer to the mnp service context data.\r
+ @param[in] Instance Pointer to the mnp instance context data to\r
initialize.\r
\r
**/\r
/**\r
Check whether the token specified by Arg maches the token in Item.\r
\r
- @param Map Pointer to the NET_MAP.\r
- @param Item Pointer to the NET_MAP_ITEM\r
- @param Arg Pointer to the Arg, it's a pointer to the token to\r
+ @param[in] Map Pointer to the NET_MAP.\r
+ @param[in] Item Pointer to the NET_MAP_ITEM\r
+ @param[in] Arg Pointer to the Arg, it's a pointer to the token to\r
check.\r
\r
@retval EFI_SUCCESS The token specified by Arg is different from the\r
/**\r
Cancel the token specified by Arg if it matches the token in Item.\r
\r
- @param Map Pointer to the NET_MAP.\r
- @param Item Pointer to the NET_MAP_ITEM\r
- @param Arg Pointer to the Arg, it's a pointer to the token to \r
- cancel.\r
+ @param[in, out] Map Pointer to the NET_MAP.\r
+ @param[in] Item Pointer to the NET_MAP_ITEM\r
+ @param[in] Arg Pointer to the Arg, it's a pointer to the token to\r
+ cancel.\r
\r
@retval EFI_SUCCESS The Arg is NULL, and the token in Item is cancelled, \r
or the Arg isn't NULL, and the token in Item is\r
/**\r
Start and initialize the simple network.\r
\r
- @param Snp Pointer to the simple network protocol.\r
+ @param[in] Snp Pointer to the simple network protocol.\r
\r
@retval EFI_SUCCESS The simple network protocol is started.\r
@retval Other Some error occurs.\r
/**\r
Stop the simple network.\r
\r
- @param Snp Pointer to the simple network protocol.\r
+ @param[in] Snp Pointer to the simple network protocol.\r
\r
@retval EFI_SUCCESS The simple network is stopped.\r
@retval Other Some error occurs.\r
Start the managed network, this function is called when one instance is configured\r
or reconfigured.\r
\r
- @param MnpServiceData Pointer to the mnp service context data.\r
- @param IsConfigUpdate The instance is reconfigured or it's the first time\r
+ @param[in] MnpServiceData Pointer to the mnp service context data.\r
+ @param[in] IsConfigUpdate The instance is reconfigured or it's the first time\r
the instanced is configured.\r
- @param EnableSystemPoll Enable the system polling or not.\r
+ @param[in] EnableSystemPoll Enable the system polling or not.\r
\r
@retval EFI_SUCCESS The managed network is started and some\r
configuration is updated.\r
/**\r
Stop the managed network.\r
\r
- @param MnpServiceData Pointer to the mnp service context data.\r
+ @param[in] MnpServiceData Pointer to the mnp service context data.\r
\r
@retval EFI_SUCCESS The managed network is stopped.\r
@retval Other Some error occurs.\r
/**\r
Configure the Instance using ConfigData.\r
\r
- @param Instance Pointer to the mnp instance context data.\r
- @param ConfigData Pointer to the configuration data used to configure\r
+ @param[in] Instance Pointer to the mnp instance context data.\r
+ @param[in] ConfigData Pointer to the configuration data used to configure\r
the isntance.\r
\r
@retval EFI_SUCCESS The Instance is configured.\r
Add a group address control block which controls the MacAddress for\r
this instance.\r
\r
- @param Instance Pointer to the mnp instance context data.\r
- @param CtrlBlk Pointer to the group address control block.\r
- @param GroupAddress Pointer to the group adress.\r
- @param MacAddress Pointer to the mac address.\r
- @param HwAddressSize The hardware address size.\r
+ @param[in] Instance Pointer to the mnp instance context data.\r
+ @param[in] CtrlBlk Pointer to the group address control block.\r
+ @param[in] GroupAddress Pointer to the group adress.\r
+ @param[in] MacAddress Pointer to the mac address.\r
+ @param[in] HwAddressSize The hardware address size.\r
\r
@retval EFI_SUCCESS The group address control block is added.\r
@retval EFI_OUT_OF_RESOURCE Failed due to lack of memory resources.\r
Delete a group control block from the instance. If the controlled group address's\r
reference count reaches zero, the group address is removed too.\r
\r
- @param Instance Pointer to the instance context data.\r
- @param CtrlBlk Pointer to the group control block to delete.\r
+ @param[in] Instance Pointer to the instance context data.\r
+ @param[in] CtrlBlk Pointer to the group control block to delete.\r
\r
@return The group address controlled by the control block is no longer used or not.\r
\r
/**\r
Do the group operations for this instance.\r
\r
- @param Instance Pointer to the instance context data.\r
- @param JoinFlag Set to TRUE to join a group. Set to TRUE to leave a\r
+ @param[in] Instance Pointer to the instance context data.\r
+ @param[in] JoinFlag Set to TRUE to join a group. Set to TRUE to leave a\r
group/groups.\r
- @param MacAddress Pointer to the group address to join or leave.\r
- @param CtrlBlk Pointer to the group control block if JoinFlag if\r
+ @param[in] MacAddress Pointer to the group address to join or leave.\r
+ @param[in] CtrlBlk Pointer to the group control block if JoinFlag if\r
FALSE.\r
\r
@retval EFI_SUCCESS The group operation finished.\r
/** @file\r
Implementation of driver entry point and driver binding protocol.\r
\r
-Copyright (c) 2005 - 2008, Intel Corporation. <BR> \r
-All rights reserved. This program and the accompanying materials are licensed \r
-and made available under the terms and conditions of the BSD License which \r
-accompanies this distribution. The full text of the license may be found at \r
-http://opensource.org/licenses/bsd-license.php \r
+Copyright (c) 2005 - 2008, 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
+http://opensource.org/licenses/bsd-license.php\r
\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
follow these calling restrictions. If any other agent wishes to call\r
Supported() it must also follow these calling restrictions.\r
\r
- @param This Protocol instance pointer.\r
- @param ControllerHandle Handle of device to test\r
- @param RemainingDevicePath Optional parameter use to pick a specific child\r
- device to start.\r
+ @param[in] This Protocol instance pointer.\r
+ @param[in] ControllerHandle Handle of device to test\r
+ @param[in] RemainingDevicePath Optional parameter use to pick a specific child\r
+ device to start.\r
\r
@retval EFI_SUCCESS This driver supports this device\r
@retval EFI_ALREADY_STARTED This driver is already running on this device\r
calling restrictions. If any other agent wishes to call Start() it\r
must also follow these calling restrictions.\r
\r
- @param This Protocol instance pointer.\r
- @param ControllerHandle Handle of device to bind driver to.\r
- @param RemainingDevicePath Optional parameter use to pick a specific child\r
- device to start.\r
+ @param[in] This Protocol instance pointer.\r
+ @param[in] ControllerHandle Handle of device to bind driver to.\r
+ @param[in] RemainingDevicePath Optional parameter use to pick a specific child\r
+ device to start.\r
\r
@retval EFI_SUCCESS This driver is added to ControllerHandle\r
@retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle\r
must follow these calling restrictions. If any other agent wishes\r
to call Stop() it must also follow these calling restrictions.\r
\r
- @param This Protocol instance pointer.\r
- @param ControllerHandle Handle of device to stop driver on\r
- @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r
- children is zero stop the entire bus driver.\r
- @param ChildHandleBuffer List of Child Handles to Stop.\r
+ @param[in] This Protocol instance pointer.\r
+ @param[in] ControllerHandle Handle of device to stop driver on\r
+ @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r
+ children is zero stop the entire bus driver.\r
+ @param[in] ChildHandleBuffer List of Child Handles to Stop.\r
\r
@retval EFI_SUCCESS This driver is removed ControllerHandle\r
@retval other This driver was not removed from this device\r
\r
\r
/**\r
- Creates a child handle with a set of I/O services.\r
+ Creates a child handle and installs a protocol.\r
+ \r
+ The CreateChild() function installs a protocol on ChildHandle. \r
+ If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle. \r
+ If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.\r
\r
- @param This Protocol instance pointer.\r
- @param ChildHandle Pointer to the handle of the child to create. If\r
- it is NULL, then a new handle is created. If it is\r
- not NULL, then the I/O services are added to the\r
- existing child handle.\r
+ @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
+ @param ChildHandle Pointer to the handle of the child to create. If it is NULL,\r
+ then a new handle is created. If it is a pointer to an existing UEFI handle, \r
+ then the protocol is added to the existing UEFI handle.\r
\r
- @retval EFI_SUCCES The protocol was added to ChildHandle. \r
- @retval EFI_INVALID_PARAMETER ChildHandle is NULL. \r
- @retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to \r
- create the child.\r
- @retval other The child handle was not created.\r
+ @retval EFI_SUCCES The protocol was added to ChildHandle.\r
+ @retval EFI_INVALID_PARAMETER ChildHandle is NULL.\r
+ @retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create\r
+ the child\r
+ @retval other The child handle was not created\r
\r
**/\r
EFI_STATUS\r
\r
\r
/**\r
- Destroys a child handle with a set of I/O services.\r
- \r
- The DestroyChild() function does the opposite of CreateChild(). It removes a \r
- protocol that was installed by CreateChild() from ChildHandle. If the removed \r
- protocol is the last protocol on ChildHandle, then ChildHandle is destroyed. \r
- \r
- @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL \r
- instance.\r
- @param ChildHandle Handle of the child to destroy.\r
-\r
- @retval EFI_SUCCES The protocol was removed from ChildHandle. \r
- @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that\r
- is being removed.\r
- @retval EFI_INVALID_PARAMETER ChildHandle is not a valid UEFI handle.\r
- @retval EFI_ACCESS_DENIED The protocol could not be removed from the\r
- ChildHandle because its services are being\r
- used.\r
- @retval other The child handle was not destroyed.\r
+ Destroys a child handle with a protocol installed on it.\r
+ \r
+ The DestroyChild() function does the opposite of CreateChild(). It removes a protocol \r
+ that was installed by CreateChild() from ChildHandle. If the removed protocol is the \r
+ last protocol on ChildHandle, then ChildHandle is destroyed.\r
+\r
+ @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
+ @param ChildHandle Handle of the child to destroy\r
+\r
+ @retval EFI_SUCCES The protocol was removed from ChildHandle.\r
+ @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.\r
+ @retval EFI_INVALID_PARAMETER Child handle is not a valid UEFI Handle.\r
+ @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle\r
+ because its services are being used.\r
+ @retval other The child handle was not destroyed\r
\r
**/\r
EFI_STATUS\r
The entry point for Mnp driver which installs the driver binding and component\r
name protocol on its ImageHandle.\r
\r
- @param ImageHandle The image handle of the driver.\r
- @param SystemTable The system table.\r
+ @param[in] ImageHandle The image handle of the driver.\r
+ @param[in] SystemTable The system table.\r
\r
@retval EFI_SUCCES The driver binding and component name protocols are \r
successfully installed.\r
/** @file\r
Declaration of strctures and functions for MnpDxe driver.\r
\r
-Copyright (c) 2005 - 2007, Intel Corporation. <BR> \r
-All rights reserved. This program and the accompanying materials are licensed \r
-and made available under the terms and conditions of the BSD License which \r
-accompanies this distribution. The full text of the license may be found at \r
-http://opensource.org/licenses/bsd-license.php \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
+http://opensource.org/licenses/bsd-license.php\r
\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
follow these calling restrictions. If any other agent wishes to call\r
Supported() it must also follow these calling restrictions.\r
\r
- @param This Protocol instance pointer.\r
- @param ControllerHandle Handle of device to test\r
- @param RemainingDevicePath Optional parameter use to pick a specific child\r
- device to start.\r
+ @param[in] This Protocol instance pointer.\r
+ @param[in] ControllerHandle Handle of device to test\r
+ @param[in] RemainingDevicePath Optional parameter use to pick a specific child\r
+ device to start.\r
\r
@retval EFI_SUCCESS This driver supports this device\r
@retval EFI_ALREADY_STARTED This driver is already running on this device\r
calling restrictions. If any other agent wishes to call Start() it\r
must also follow these calling restrictions.\r
\r
- @param This Protocol instance pointer.\r
- @param ControllerHandle Handle of device to bind driver to.\r
- @param RemainingDevicePath Optional parameter use to pick a specific child\r
- device to start.\r
+ @param[in] This Protocol instance pointer.\r
+ @param[in] ControllerHandle Handle of device to bind driver to.\r
+ @param[in] RemainingDevicePath Optional parameter use to pick a specific child\r
+ device to start.\r
\r
@retval EFI_SUCCESS This driver is added to ControllerHandle\r
@retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle\r
must follow these calling restrictions. If any other agent wishes\r
to call Stop() it must also follow these calling restrictions.\r
\r
- @param This Protocol instance pointer.\r
- @param ControllerHandle Handle of device to stop driver on\r
- @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r
- children is zero stop the entire bus driver.\r
- @param ChildHandleBuffer List of Child Handles to Stop.\r
+ @param[in] This Protocol instance pointer.\r
+ @param[in] ControllerHandle Handle of device to stop driver on\r
+ @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r
+ children is zero stop the entire bus driver.\r
+ @param[in] ChildHandleBuffer List of Child Handles to Stop.\r
\r
@retval EFI_SUCCESS This driver is removed ControllerHandle\r
@retval other This driver was not removed from this device\r
);\r
\r
/**\r
- Creates a child handle with a set of I/O services.\r
+ Creates a child handle and installs a protocol.\r
+ \r
+ The CreateChild() function installs a protocol on ChildHandle. \r
+ If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle. \r
+ If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.\r
\r
- @param This Protocol instance pointer.\r
- @param ChildHandle Pointer to the handle of the child to create. If\r
- it is NULL, then a new handle is created. If it is\r
- not NULL, then the I/O services are added to the\r
- existing child handle.\r
+ @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
+ @param ChildHandle Pointer to the handle of the child to create. If it is NULL,\r
+ then a new handle is created. If it is a pointer to an existing UEFI handle, \r
+ then the protocol is added to the existing UEFI handle.\r
\r
- @retval EFI_SUCCES The child handle was created with the I/O\r
- services.\r
- @retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create\r
- the child.\r
- @retval other The child handle was not created.\r
+ @retval EFI_SUCCES The protocol was added to ChildHandle.\r
+ @retval EFI_INVALID_PARAMETER ChildHandle is NULL.\r
+ @retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create\r
+ the child\r
+ @retval other The child handle was not created\r
\r
**/\r
EFI_STATUS\r
);\r
\r
/**\r
- Destroys a child handle with a set of I/O services.\r
-\r
- @param This Protocol instance pointer.\r
- @param ChildHandle Handle of the child to destroy.\r
-\r
- @retval EFI_SUCCES The I/O services were removed from the child\r
- handle.\r
- @retval EFI_UNSUPPORTED The child handle does not support the I/O services\r
- that are being removed.\r
- @retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle.\r
- @retval EFI_ACCESS_DENIED The child handle could not be destroyed because\r
- its I/O services are being used.\r
- @retval other The child handle was not destroyed.\r
+ Destroys a child handle with a protocol installed on it.\r
+ \r
+ The DestroyChild() function does the opposite of CreateChild(). It removes a protocol \r
+ that was installed by CreateChild() from ChildHandle. If the removed protocol is the \r
+ last protocol on ChildHandle, then ChildHandle is destroyed.\r
+\r
+ @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
+ @param ChildHandle Handle of the child to destroy\r
+\r
+ @retval EFI_SUCCES The protocol was removed from ChildHandle.\r
+ @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.\r
+ @retval EFI_INVALID_PARAMETER Child handle is not a valid UEFI Handle.\r
+ @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle\r
+ because its services are being used.\r
+ @retval other The child handle was not destroyed\r
\r
**/\r
EFI_STATUS\r
/** @file\r
Declaration of structures and functions of MnpDxe driver.\r
\r
-Copyright (c) 2005 - 2008, Intel Corporation. <BR>\r
+Copyright (c) 2005 - 2008, 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
/**\r
Initialize the mnp service context data.\r
\r
- @param MnpServiceData Pointer to the mnp service context data.\r
- @param ImageHandle The driver image handle.\r
- @param ControllerHandle Handle of device to bind driver to.\r
+ @param[in] MnpServiceData Pointer to the mnp service context data.\r
+ @param[in] ImageHandle The driver image handle.\r
+ @param[in] ControllerHandle Handle of device to bind driver to.\r
\r
@retval EFI_SUCCESS The mnp service context is initialized.\r
@retval Other Some error occurs.\r
\r
@param MnpServiceData Pointer to the mnp service context data.\r
@param ImageHandle The driver image handle.\r
-\r
+ \r
**/\r
VOID\r
MnpFlushServiceData (\r
/**\r
Initialize the mnp instance context data.\r
\r
- @param MnpServiceData Pointer to the mnp service context data.\r
- @param Instance Pointer to the mnp instance context data to\r
+ @param[in] MnpServiceData Pointer to the mnp service context data.\r
+ @param[in] Instance Pointer to the mnp instance context data to\r
initialize.\r
\r
**/\r
/**\r
Check whether the token specified by Arg maches the token in Item.\r
\r
- @param Map Pointer to the NET_MAP.\r
- @param Item Pointer to the NET_MAP_ITEM\r
- @param Arg Pointer to the Arg, it's a pointer to the token to\r
+ @param[in] Map Pointer to the NET_MAP.\r
+ @param[in] Item Pointer to the NET_MAP_ITEM\r
+ @param[in] Arg Pointer to the Arg, it's a pointer to the token to\r
check.\r
\r
@retval EFI_SUCCESS The token specified by Arg is different from the\r
/**\r
Cancel the token specified by Arg if it matches the token in Item.\r
\r
- @param Map Pointer to the NET_MAP.\r
- @param Item Pointer to the NET_MAP_ITEM\r
- @param Arg Pointer to the Arg, it's a pointer to the token to\r
+ @param[in, out] Map Pointer to the NET_MAP.\r
+ @param[in] Item Pointer to the NET_MAP_ITEM\r
+ @param[in] Arg Pointer to the Arg, it's a pointer to the token to\r
cancel.\r
\r
- @retval EFI_SUCCESS The Arg is NULL, and the token in Item is\r
- cancelled, or the Arg isn't NULL, and the token in\r
- Item is different from the Arg.\r
- @retval EFI_ABORTED The Arg isn't NULL, the token in Item mathces the\r
- Arg, and the token is cancelled.\r
+ @retval EFI_SUCCESS The Arg is NULL, and the token in Item is cancelled, \r
+ or the Arg isn't NULL, and the token in Item is\r
+ different from the Arg.\r
+ @retval EFI_ABORTED The Arg isn't NULL, the token in Item mathces the\r
+ Arg, and the token is cancelled.\r
\r
**/\r
EFI_STATUS\r
/**\r
Configure the Instance using ConfigData.\r
\r
- @param Instance Pointer to the mnp instance context data.\r
- @param ConfigData Pointer to the configuration data used to configure\r
+ @param[in] Instance Pointer to the mnp instance context data.\r
+ @param[in] ConfigData Pointer to the configuration data used to configure\r
the isntance.\r
\r
@retval EFI_SUCCESS The Instance is configured.\r
/**\r
Do the group operations for this instance.\r
\r
- @param Instance Pointer to the instance context data.\r
- @param JoinFlag Set to TRUE to join a group. Set to TRUE to leave a\r
+ @param[in] Instance Pointer to the instance context data.\r
+ @param[in] JoinFlag Set to TRUE to join a group. Set to TRUE to leave a\r
group/groups.\r
- @param MacAddress Pointer to the group address to join or leave.\r
- @param CtrlBlk Pointer to the group control block if JoinFlag if\r
+ @param[in] MacAddress Pointer to the group address to join or leave.\r
+ @param[in] CtrlBlk Pointer to the group control block if JoinFlag if\r
FALSE.\r
\r
@retval EFI_SUCCESS The group operation finished.\r
MnpGroupOp (\r
IN MNP_INSTANCE_DATA *Instance,\r
IN BOOLEAN JoinFlag,\r
- IN EFI_MAC_ADDRESS *MacAddr OPTIONAL,\r
+ IN EFI_MAC_ADDRESS *MacAddress OPTIONAL,\r
IN MNP_GROUP_CONTROL_BLOCK *CtrlBlk OPTIONAL\r
);\r
\r
/**\r
Validates the Mnp transmit token.\r
\r
- @param Instance Pointer to the Mnp instance context data.\r
- @param Token Pointer to the transmit token to check.\r
+ @param[in] Instance Pointer to the Mnp instance context data.\r
+ @param[in] Token Pointer to the transmit token to check.\r
\r
@return The Token is valid or not.\r
\r
@param PktBuf Pointer to record the address of the packet.\r
@param PktLen Pointer to a UINT32 variable used to record the\r
packet's length.\r
-\r
+ \r
**/\r
VOID\r
MnpBuildTxPacket (\r
/**\r
Synchronously send out the packet.\r
\r
- @param MnpServiceData Pointer to the mnp service context data.\r
- @param Packet Pointer to the pakcet buffer.\r
- @param Length The length of the packet.\r
- @param Token Pointer to the token the packet generated from.\r
+ @param[in] MnpServiceData Pointer to the mnp service context data.\r
+ @param[in] Packet Pointer to the pakcet buffer.\r
+ @param[in] Length The length of the packet.\r
+ @param[in] Token Pointer to the token the packet generated from.\r
\r
@retval EFI_SUCCESS The packet is sent out.\r
@retval EFI_TIMEOUT Time out occurs, the packet isn't sent.\r
/**\r
Try to deliver the received packet to the instance.\r
\r
- @param Instance Pointer to the mnp instance context data.\r
+ @param[in] Instance Pointer to the mnp instance context data.\r
\r
@retval EFI_SUCCESS The received packet is delivered, or there is no\r
packet to deliver, or there is no available receive\r
Recycle the RxData and other resources used to hold and deliver the received\r
packet.\r
\r
- @param Event The event this notify function registered to.\r
- @param Context Pointer to the context data registerd to the Event.\r
-\r
+ @param Event The event this notify function registered to.\r
+ @param Context Pointer to the context data registerd to the Event.\r
+ \r
**/\r
VOID\r
EFIAPI\r
/**\r
Try to receive a packet and deliver it.\r
\r
- @param MnpServiceData Pointer to the mnp service context data.\r
+ @param[in] MnpServiceData Pointer to the mnp service context data.\r
\r
@retval EFI_SUCCESS add return value to function comment\r
@retval EFI_NOT_STARTED The simple network protocol is not started.\r
in the queue, first try to allocate some and add them into the queue, then\r
fetch the NET_BUF from the updated FreeNbufQue.\r
\r
- @param MnpServiceData Pointer to the MNP_SERVICE_DATA.\r
+ @param[in] MnpServiceData Pointer to the MNP_SERVICE_DATA.\r
\r
- @return Pointer to the allocated free NET_BUF structure, if NULL the operation is failed.\r
+ @return Pointer to the allocated free NET_BUF structure, if NULL the \r
+ operation is failed.\r
\r
**/\r
NET_BUF *\r
\r
@param MnpServiceData Pointer to the mnp service context data.\r
@param Nbuf Pointer to the NET_BUF to free.\r
-\r
+ \r
**/\r
VOID\r
MnpFreeNbuf (\r
/**\r
Remove the received packets if timeout occurs.\r
\r
- @param Event The event this notify function registered to.\r
- @param Context Pointer to the context data registered to the\r
- event.\r
- \r
+ @param Event The event this notify function registered to.\r
+ @param Context Pointer to the context data registered to the\r
+ event.\r
+ \r
**/\r
VOID\r
EFIAPI\r
Poll to receive the packets from Snp. This function is either called by upperlayer\r
protocols/applications or the system poll timer notify mechanism.\r
\r
- @param Event The event this notify function registered to.\r
- @param Context Pointer to the context data registered to the\r
- event.\r
+ @param Event The event this notify function registered to.\r
+ @param Context Pointer to the context data registered to the\r
+ event.\r
\r
**/\r
VOID\r
The GetModeData() function is used to read the current mode data (operational\r
parameters) from the MNP or the underlying SNP. \r
\r
- @param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
- @param MnpConfigData Pointer to storage for MNP operational parameters. Type\r
- EFI_MANAGED_NETWORK_CONFIG_DATA is defined in "Related\r
- Definitions" below.\r
- @param SnpModeData Pointer to storage for SNP operational parameters. This\r
- feature may be unsupported. Type EFI_SIMPLE_NETWORK_MODE\r
- is defined in the EFI_SIMPLE_NETWORK_PROTOCOL.\r
+ @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
+ @param[out] MnpConfigData Pointer to storage for MNP operational parameters. Type\r
+ EFI_MANAGED_NETWORK_CONFIG_DATA is defined in "Related\r
+ Definitions" below.\r
+ @param[out] SnpModeData Pointer to storage for SNP operational parameters. This\r
+ feature may be unsupported. Type EFI_SIMPLE_NETWORK_MODE\r
+ is defined in the EFI_SIMPLE_NETWORK_PROTOCOL.\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_INVALID_PARAMETER This is NULL.\r
Note: Warning: Receive filter settings that overlap will consume extra\r
processor and/or DMA resources and degrade system and network performance.\r
\r
- @param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
- @param MnpConfigData Pointer to configuration data that will be assigned\r
- to the MNP child driver instance. If NULL, the MNP\r
- child driver instance is reset to startup defaults\r
- and all pending transmit and receive requests are\r
- flushed. Type EFI_MANAGED_NETWORK_CONFIG_DATA is\r
- defined in\r
- EFI_MANAGED_NETWORK_PROTOCOL.GetModeData().\r
+ @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
+ @param[in] MnpConfigData Pointer to configuration data that will be assigned\r
+ to the MNP child driver instance. If NULL, the MNP\r
+ child driver instance is reset to startup defaults\r
+ and all pending transmit and receive requests are\r
+ flushed. Type EFI_MANAGED_NETWORK_CONFIG_DATA is\r
+ defined in EFI_MANAGED_NETWORK_PROTOCOL.GetModeData().\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_INVALID_PARAMETER One or more of the following conditions is\r
underlying EFI_SIMPLE_NETWORK.MCastIpToMac() function, which may also be\r
unsupported in some MNP implementations.\r
\r
- @param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
- @param Ipv6Flag Set to TRUE to if IpAddress is an IPv6 multicast address.\r
- Set to FALSE if IpAddress is an IPv4 multicast address.\r
- @param IpAddress Pointer to the multicast IP address (in network byte order)\r
- to convert.\r
- @param MacAddress Pointer to the resulting multicast MAC address. \r
+ @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
+ @param[in] Ipv6Flag Set to TRUE to if IpAddress is an IPv6 multicast address.\r
+ Set to FALSE if IpAddress is an IPv4 multicast address.\r
+ @param[in] IpAddress Pointer to the multicast IP address (in network byte order)\r
+ to convert.\r
+ @param[out] MacAddress Pointer to the resulting multicast MAC address. \r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_INVALID_PARAMETER One of the following conditions is TRUE:\r
Management Protocol (IGMP) packets. If JoinFlag is FALSE and MacAddress is\r
NULL, then all joined groups are left.\r
\r
- @param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
- @param JoinFlag Set to TRUE to join this multicast group.\r
- Set to FALSE to leave this multicast group.\r
- @param MacAddress Pointer to the multicast MAC group (address) to join or\r
- leave.\r
+ @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
+ @param[in] JoinFlag Set to TRUE to join this multicast group.\r
+ Set to FALSE to leave this multicast group.\r
+ @param[in] MacAddress Pointer to the multicast MAC group (address) to join or\r
+ leave.\r
\r
@retval EFI_SUCCESS The requested operation completed successfully.\r
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
the underlying communications device and drivers.\r
\r
\r
- @param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
- @param Token Pointer to a token associated with the transmit data\r
- descriptor. Type EFI_MANAGED_NETWORK_COMPLETION_TOKEN is\r
- defined in "Related Definitions" below.\r
+ @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
+ @param[in] Token Pointer to a token associated with the transmit data\r
+ descriptor. Type EFI_MANAGED_NETWORK_COMPLETION_TOKEN is\r
+ defined in "Related Definitions" below.\r
\r
@retval EFI_SUCCESS The transmit completion token was cached.\r
@retval EFI_NOT_STARTED This MNP child driver instance has not been\r
the asynchronous operation has completed, this function will not signal the\r
token and EFI_NOT_FOUND is returned.\r
\r
- @param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
- @param Token Pointer to a token that has been issued by\r
- EFI_MANAGED_NETWORK_PROTOCOL.Transmit() or\r
- EFI_MANAGED_NETWORK_PROTOCOL.Receive(). If NULL, all pending\r
- tokens are aborted.\r
+ @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
+ @param[in] Token Pointer to a token that has been issued by\r
+ EFI_MANAGED_NETWORK_PROTOCOL.Transmit() or\r
+ EFI_MANAGED_NETWORK_PROTOCOL.Receive(). If NULL, all pending\r
+ tokens are aborted.\r
\r
@retval EFI_SUCCESS The asynchronous I/O request was aborted and\r
Token.Event was signaled. When Token is NULL,\r
updates the Token.Status and Token.RxData fields and the Token.Event is\r
signaled.\r
\r
- @param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
- @param Token Pointer to a token associated with the receive\r
- data descriptor. Type\r
- EFI_MANAGED_NETWORK_COMPLETION_TOKEN is defined in\r
- EFI_MANAGED_NETWORK_PROTOCOL.Transmit().\r
+ @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
+ @param[in] Token Pointer to a token associated with the receive\r
+ data descriptor. Type\r
+ EFI_MANAGED_NETWORK_COMPLETION_TOKEN is defined in\r
+ EFI_MANAGED_NETWORK_PROTOCOL.Transmit().\r
\r
@retval EFI_SUCCESS The receive completion token was cached.\r
@retval EFI_NOT_STARTED This MNP child driver instance has not been\r
applications that are experiencing packet loss should try calling the Poll()\r
function more often.\r
\r
- @param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
+ @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
\r
@retval EFI_SUCCESS Incoming or outgoing data was processed.\r
@retval EFI_NOT_STARTED This MNP child driver instance has not been\r
/** @file\r
- Implementation of Managed Network Protocol I/O functions.\r
- \r
-Copyright (c) 2005 - 2007, Intel Corporation. <BR>\r
+ Implementation of Managed Network Protocol I/O functions.\r
+ \r
+Copyright (c) 2005 - 2007, Intel Corporation.<BR>\r
+\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
/**\r
Validates the Mnp transmit token.\r
\r
- @param Instance Pointer to the Mnp instance context data.\r
- @param Token Pointer to the transmit token to check.\r
+ @param[in] Instance Pointer to the Mnp instance context data.\r
+ @param[in] Token Pointer to the transmit token to check.\r
\r
@return The Token is valid or not.\r
\r
@param PktBuf Pointer to record the address of the packet.\r
@param PktLen Pointer to a UINT32 variable used to record the\r
packet's length.\r
-\r
+ \r
**/\r
VOID\r
MnpBuildTxPacket (\r
/**\r
Synchronously send out the packet.\r
\r
- @param MnpServiceData Pointer to the mnp service context data.\r
- @param Packet Pointer to the pakcet buffer.\r
- @param Length The length of the packet.\r
- @param Token Pointer to the token the packet generated from.\r
+ @param[in] MnpServiceData Pointer to the mnp service context data.\r
+ @param[in] Packet Pointer to the pakcet buffer.\r
+ @param[in] Length The length of the packet.\r
+ @param[in] Token Pointer to the token the packet generated from.\r
\r
@retval EFI_SUCCESS The packet is sent out.\r
@retval EFI_TIMEOUT Time out occurs, the packet isn't sent.\r
/**\r
Try to deliver the received packet to the instance.\r
\r
- @param Instance Pointer to the mnp instance context data.\r
+ @param[in] Instance Pointer to the mnp instance context data.\r
\r
@retval EFI_SUCCESS The received packet is delivered, or there is no\r
packet to deliver, or there is no available receive\r
\r
@param MnpServiceData Pointer to the mnp service context data.\r
\r
- @return None.\r
-\r
**/\r
VOID\r
MnpDeliverPacket (\r
Recycle the RxData and other resources used to hold and deliver the received\r
packet.\r
\r
- @param Event The event this notify function registered to.\r
- @param Context Pointer to the context data registerd to the Event.\r
-\r
+ @param Event The event this notify function registered to.\r
+ @param Context Pointer to the context data registerd to the Event.\r
+ \r
**/\r
VOID\r
EFIAPI\r
/**\r
Queue the received packet into instance's receive queue.\r
\r
- @param Instance Pointer to the mnp instance context data.\r
- @param RxDataWrap Pointer to the Wrap structure containing the\r
+ @param Instance Pointer to the mnp instance context data.\r
+ @param RxDataWrap Pointer to the Wrap structure containing the\r
received data and other information.\r
\r
- @return None.\r
-\r
**/\r
VOID\r
MnpQueueRcvdPacket (\r
/**\r
Match the received packet with the instance receive filters.\r
\r
- @param Instance Pointer to the mnp instance context data.\r
- @param RxData Pointer to the EFI_MANAGED_NETWORK_RECEIVE_DATA.\r
- @param GroupAddress Pointer to the GroupAddress, the GroupAddress is\r
+ @param[in] Instance Pointer to the mnp instance context data.\r
+ @param[in] RxData Pointer to the EFI_MANAGED_NETWORK_RECEIVE_DATA.\r
+ @param[in] GroupAddress Pointer to the GroupAddress, the GroupAddress is\r
non-NULL and it contains the destination multicast\r
mac address of the received packet if the packet\r
destinated to a multicast mac address.\r
- @param PktAttr The received packets attribute.\r
+ @param[in] PktAttr The received packets attribute.\r
\r
@return The received packet matches the instance's receive filters or not.\r
\r
/**\r
Analyse the received packets.\r
\r
- @param MnpServiceData Pointer to the mnp service context data.\r
- @param Nbuf Pointer to the net buffer holding the received\r
- packet.\r
- @param RxData Pointer to the buffer used to save the analysed\r
- result in EFI_MANAGED_NETWORK_RECEIVE_DATA.\r
- @param GroupAddress Pointer to pointer to a MNP_GROUP_ADDRESS used to\r
- pass out the address of the multicast address the\r
- received packet destinated to.\r
- @param PktAttr Pointer to the buffer used to save the analysed\r
- packet attribute.\r
-\r
- @return None.\r
+ @param MnpServiceData Pointer to the mnp service context data.\r
+ @param Nbuf Pointer to the net buffer holding the received\r
+ packet.\r
+ @param RxData Pointer to the buffer used to save the analysed\r
+ result in EFI_MANAGED_NETWORK_RECEIVE_DATA.\r
+ @param GroupAddress Pointer to pointer to a MNP_GROUP_ADDRESS used to\r
+ pass out the address of the multicast address the\r
+ received packet destinated to.\r
+ @param PktAttr Pointer to the buffer used to save the analysed\r
+ packet attribute.\r
\r
**/\r
VOID\r
/**\r
Wrap the RxData.\r
\r
- @param Instance Pointer to the mnp instance context data.\r
- @param RxData Pointer to the receive data to wrap.\r
+ @param[in] Instance Pointer to the mnp instance context data.\r
+ @param[in] RxData Pointer to the receive data to wrap.\r
\r
@return Pointer to a MNP_RXDATA_WRAP which wraps the RxData.\r
\r
Enqueue the received the packets to the instances belonging to the\r
MnpServiceData.\r
\r
- @param MnpServiceData Pointer to the mnp service context data.\r
- @param Nbuf Pointer to the net buffer representing the received\r
- packet.\r
-\r
- @return None.\r
+ @param MnpServiceData Pointer to the mnp service context data.\r
+ @param Nbuf Pointer to the net buffer representing the received\r
+ packet.\r
\r
**/\r
VOID\r
/**\r
Try to receive a packet and deliver it.\r
\r
- @param MnpServiceData Pointer to the mnp service context data.\r
+ @param[in] MnpServiceData Pointer to the mnp service context data.\r
\r
@retval EFI_SUCCESS add return value to function comment\r
@retval EFI_NOT_STARTED The simple network protocol is not started.\r
/**\r
Remove the received packets if timeout occurs.\r
\r
- @param Event The event this notify function registered to.\r
- @param Context Pointer to the context data registered to the\r
- event.\r
- \r
+ @param Event The event this notify function registered to.\r
+ @param Context Pointer to the context data registered to the\r
+ event.\r
+ \r
**/\r
VOID\r
EFIAPI\r
Poll to receive the packets from Snp. This function is either called by upperlayer\r
protocols/applications or the system poll timer notify mechanism.\r
\r
- @param Event The event this notify function registered to.\r
- @param Context Pointer to the context data registered to the\r
- event.\r
+ @param Event The event this notify function registered to.\r
+ @param Context Pointer to the context data registered to the\r
+ event.\r
\r
**/\r
VOID\r
/** @file\r
- Implementation of Managed Network Protocol public services.\r
+ Implementation of Managed Network Protocol public services.\r
+ \r
+Copyright (c) 2005 - 2007, Intel Corporation.<BR>\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 GetModeData() function is used to read the current mode data (operational\r
parameters) from the MNP or the underlying SNP. \r
\r
- @param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
- @param MnpConfigData Pointer to storage for MNP operational parameters. Type\r
- EFI_MANAGED_NETWORK_CONFIG_DATA is defined in "Related\r
- Definitions" below.\r
- @param SnpModeData Pointer to storage for SNP operational parameters. This\r
- feature may be unsupported. Type EFI_SIMPLE_NETWORK_MODE\r
- is defined in the EFI_SIMPLE_NETWORK_PROTOCOL.\r
+ @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
+ @param[out] MnpConfigData Pointer to storage for MNP operational parameters. Type\r
+ EFI_MANAGED_NETWORK_CONFIG_DATA is defined in "Related\r
+ Definitions" below.\r
+ @param[out] SnpModeData Pointer to storage for SNP operational parameters. This\r
+ feature may be unsupported. Type EFI_SIMPLE_NETWORK_MODE\r
+ is defined in the EFI_SIMPLE_NETWORK_PROTOCOL.\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_INVALID_PARAMETER This is NULL.\r
Note: Warning: Receive filter settings that overlap will consume extra\r
processor and/or DMA resources and degrade system and network performance.\r
\r
- @param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
- @param MnpConfigData Pointer to configuration data that will be assigned\r
- to the MNP child driver instance. If NULL, the MNP\r
- child driver instance is reset to startup defaults\r
- and all pending transmit and receive requests are\r
- flushed. Type EFI_MANAGED_NETWORK_CONFIG_DATA is\r
- defined in\r
- EFI_MANAGED_NETWORK_PROTOCOL.GetModeData().\r
+ @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
+ @param[in] MnpConfigData Pointer to configuration data that will be assigned\r
+ to the MNP child driver instance. If NULL, the MNP\r
+ child driver instance is reset to startup defaults\r
+ and all pending transmit and receive requests are\r
+ flushed. Type EFI_MANAGED_NETWORK_CONFIG_DATA is\r
+ defined in EFI_MANAGED_NETWORK_PROTOCOL.GetModeData().\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_INVALID_PARAMETER One or more of the following conditions is\r
underlying EFI_SIMPLE_NETWORK.MCastIpToMac() function, which may also be\r
unsupported in some MNP implementations.\r
\r
- @param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
- @param Ipv6Flag Set to TRUE to if IpAddress is an IPv6 multicast address.\r
- Set to FALSE if IpAddress is an IPv4 multicast address.\r
- @param IpAddress Pointer to the multicast IP address (in network byte order)\r
- to convert.\r
- @param MacAddress Pointer to the resulting multicast MAC address. \r
+ @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
+ @param[in] Ipv6Flag Set to TRUE to if IpAddress is an IPv6 multicast address.\r
+ Set to FALSE if IpAddress is an IPv4 multicast address.\r
+ @param[in] IpAddress Pointer to the multicast IP address (in network byte order)\r
+ to convert.\r
+ @param[out] MacAddress Pointer to the resulting multicast MAC address. \r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_INVALID_PARAMETER One of the following conditions is TRUE:\r
Management Protocol (IGMP) packets. If JoinFlag is FALSE and MacAddress is\r
NULL, then all joined groups are left.\r
\r
- @param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
- @param JoinFlag Set to TRUE to join this multicast group.\r
- Set to FALSE to leave this multicast group.\r
- @param MacAddress Pointer to the multicast MAC group (address) to join or\r
- leave.\r
+ @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
+ @param[in] JoinFlag Set to TRUE to join this multicast group.\r
+ Set to FALSE to leave this multicast group.\r
+ @param[in] MacAddress Pointer to the multicast MAC group (address) to join or\r
+ leave.\r
\r
@retval EFI_SUCCESS The requested operation completed successfully.\r
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
the underlying communications device and drivers.\r
\r
\r
- @param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
- @param Token Pointer to a token associated with the transmit data\r
- descriptor. Type EFI_MANAGED_NETWORK_COMPLETION_TOKEN is\r
- defined in "Related Definitions" below.\r
+ @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
+ @param[in] Token Pointer to a token associated with the transmit data\r
+ descriptor. Type EFI_MANAGED_NETWORK_COMPLETION_TOKEN is\r
+ defined in "Related Definitions" below.\r
\r
@retval EFI_SUCCESS The transmit completion token was cached.\r
@retval EFI_NOT_STARTED This MNP child driver instance has not been\r
updates the Token.Status and Token.RxData fields and the Token.Event is\r
signaled.\r
\r
- @param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
- @param Token Pointer to a token associated with the receive\r
- data descriptor. Type\r
- EFI_MANAGED_NETWORK_COMPLETION_TOKEN is defined in\r
- EFI_MANAGED_NETWORK_PROTOCOL.Transmit().\r
+ @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
+ @param[in] Token Pointer to a token associated with the receive\r
+ data descriptor. Type\r
+ EFI_MANAGED_NETWORK_COMPLETION_TOKEN is defined in\r
+ EFI_MANAGED_NETWORK_PROTOCOL.Transmit().\r
\r
@retval EFI_SUCCESS The receive completion token was cached.\r
@retval EFI_NOT_STARTED This MNP child driver instance has not been\r
the asynchronous operation has completed, this function will not signal the\r
token and EFI_NOT_FOUND is returned.\r
\r
- @param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
- @param Token Pointer to a token that has been issued by\r
- EFI_MANAGED_NETWORK_PROTOCOL.Transmit() or\r
- EFI_MANAGED_NETWORK_PROTOCOL.Receive(). If NULL, all pending\r
- tokens are aborted.\r
+ @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
+ @param[in] Token Pointer to a token that has been issued by\r
+ EFI_MANAGED_NETWORK_PROTOCOL.Transmit() or\r
+ EFI_MANAGED_NETWORK_PROTOCOL.Receive(). If NULL, all pending\r
+ tokens are aborted.\r
\r
@retval EFI_SUCCESS The asynchronous I/O request was aborted and\r
Token.Event was signaled. When Token is NULL,\r
applications that are experiencing packet loss should try calling the Poll()\r
function more often.\r
\r
- @param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
+ @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
\r
@retval EFI_SUCCESS Incoming or outgoing data was processed.\r
@retval EFI_NOT_STARTED This MNP child driver instance has not been\r
/** @file\r
\r
-Copyright (c) 2006 - 2007, Intel Corporation\r
+Copyright (c) 2006 - 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
- ComponentName.c\r
-\r
-Abstract:\r
-\r
-\r
**/\r
\r
\r
by This does not support the language specified by Language,\r
then EFI_UNSUPPORTED is returned.\r
\r
- @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
+ @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
EFI_COMPONENT_NAME_PROTOCOL instance.\r
\r
- @param Language[in] A pointer to a Null-terminated ASCII string\r
+ @param[in] Language A pointer to a Null-terminated ASCII string\r
array indicating the language. This is the\r
language of the driver name that the caller is\r
requesting, and it must match one of the\r
to the driver writer. Language is specified\r
in RFC 3066 or ISO 639-2 language code format.\r
\r
- @param DriverName[out] A pointer to the Unicode string to return.\r
+ @param[out] DriverName A pointer to the Unicode string to return.\r
This Unicode string is the name of the\r
driver specified by This in the language\r
specified by Language.\r
then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r
support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
\r
- @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
+ @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
EFI_COMPONENT_NAME_PROTOCOL instance.\r
\r
- @param ControllerHandle[in] The handle of a controller that the driver\r
+ @param[in] ControllerHandle The handle of a controller that the driver\r
specified by This is managing. This handle\r
specifies the controller whose name is to be\r
returned.\r
\r
- @param ChildHandle[in] The handle of the child controller to retrieve\r
+ @param[in] ChildHandle The handle of the child controller to retrieve\r
the name of. This is an optional parameter that\r
may be NULL. It will be NULL for device\r
drivers. It will also be NULL for a bus drivers\r
driver that wishes to retrieve the name of a\r
child controller.\r
\r
- @param Language[in] A pointer to a Null-terminated ASCII string\r
+ @param[in] Language A pointer to a Null-terminated ASCII string\r
array indicating the language. This is the\r
language of the driver name that the caller is\r
requesting, and it must match one of the\r
to the driver writer. Language is specified in\r
RFC 3066 or ISO 639-2 language code format.\r
\r
- @param ControllerName[out] A pointer to the Unicode string to return.\r
+ @param[out] ControllerName A pointer to the Unicode string to return.\r
This Unicode string is the name of the\r
controller specified by ControllerHandle and\r
ChildHandle in the language specified by\r
by This does not support the language specified by Language,\r
then EFI_UNSUPPORTED is returned.\r
\r
- @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
+ @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
EFI_COMPONENT_NAME_PROTOCOL instance.\r
\r
- @param Language[in] A pointer to a Null-terminated ASCII string\r
+ @param[in] Language A pointer to a Null-terminated ASCII string\r
array indicating the language. This is the\r
language of the driver name that the caller is\r
requesting, and it must match one of the\r
to the driver writer. Language is specified\r
in RFC 3066 or ISO 639-2 language code format.\r
\r
- @param DriverName[out] A pointer to the Unicode string to return.\r
+ @param[out] DriverName A pointer to the Unicode string to return.\r
This Unicode string is the name of the\r
driver specified by This in the language\r
specified by Language.\r
then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r
support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
\r
- @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
+ @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
EFI_COMPONENT_NAME_PROTOCOL instance.\r
\r
- @param ControllerHandle[in] The handle of a controller that the driver\r
+ @param[in] ControllerHandle The handle of a controller that the driver\r
specified by This is managing. This handle\r
specifies the controller whose name is to be\r
returned.\r
\r
- @param ChildHandle[in] The handle of the child controller to retrieve\r
+ @param[in] ChildHandle The handle of the child controller to retrieve\r
the name of. This is an optional parameter that\r
may be NULL. It will be NULL for device\r
drivers. It will also be NULL for a bus drivers\r
driver that wishes to retrieve the name of a\r
child controller.\r
\r
- @param Language[in] A pointer to a Null-terminated ASCII string\r
+ @param[in] Language A pointer to a Null-terminated ASCII string\r
array indicating the language. This is the\r
language of the driver name that the caller is\r
requesting, and it must match one of the\r
to the driver writer. Language is specified in\r
RFC 3066 or ISO 639-2 language code format.\r
\r
- @param ControllerName[out] A pointer to the Unicode string to return.\r
+ @param[out] ControllerName A pointer to the Unicode string to return.\r
This Unicode string is the name of the\r
controller specified by ControllerHandle and\r
ChildHandle in the language specified by\r
/** @file\r
\r
-Copyright (c) 2006, Intel Corporation\r
+Copyright (c) 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
- Udp4Driver.c\r
-\r
-Abstract:\r
-\r
-\r
**/\r
\r
\r
follow these calling restrictions. If any other agent wishes to call\r
Supported() it must also follow these calling restrictions.\r
\r
- @param This Protocol instance pointer.\r
- @param ControllerHandle Handle of device to test\r
- @param RemainingDevicePath Optional parameter use to pick a specific child\r
- device to start.\r
+ @param[in] This Protocol instance pointer.\r
+ @param[in] ControllerHandle Handle of device to test\r
+ @param[in] RemainingDevicePath Optional parameter use to pick a specific child\r
+ device to start.\r
\r
@retval EFI_SUCCESS This driver supports this device\r
@retval EFI_ALREADY_STARTED This driver is already running on this device\r
calling restrictions. If any other agent wishes to call Start() it\r
must also follow these calling restrictions.\r
\r
- @param This Protocol instance pointer.\r
- @param ControllerHandle Handle of device to bind driver to\r
- @param RemainingDevicePath Optional parameter use to pick a specific child\r
- device to start.\r
+ @param[in] This Protocol instance pointer.\r
+ @param[in] ControllerHandle Handle of device to bind driver to\r
+ @param[in] RemainingDevicePath Optional parameter use to pick a specific child\r
+ device to start.\r
\r
@retval EFI_SUCCESS This driver is added to ControllerHandle\r
@retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle\r
must follow these calling restrictions. If any other agent wishes\r
to call Stop() it must also follow these calling restrictions.\r
\r
- @param This Protocol instance pointer.\r
- @param ControllerHandle Handle of device to stop driver on\r
- @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r
- children is zero stop the entire bus driver.\r
- @param ChildHandleBuffer List of Child Handles to Stop.\r
+ @param[in] This Protocol instance pointer.\r
+ @param[in] ControllerHandle Handle of device to stop driver on\r
+ @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r
+ children is zero stop the entire bus driver.\r
+ @param[in] ChildHandleBuffer List of Child Handles to Stop.\r
\r
@retval EFI_SUCCESS This driver is removed ControllerHandle\r
@retval other This driver was not removed from this device\r
\r
\r
/**\r
- Creates a child handle with a set of I/O services.\r
+ Creates a child handle and installs a protocol.\r
+ \r
+ The CreateChild() function installs a protocol on ChildHandle. \r
+ If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle. \r
+ If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.\r
\r
- @param This Protocol instance pointer.\r
- @param ChildHandle Pointer to the handle of the child to create. If it is NULL,\r
- then a new handle is created. If it is not NULL, then the\r
- I/O services are added to the existing child handle.\r
+ @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
+ @param ChildHandle Pointer to the handle of the child to create. If it is NULL,\r
+ then a new handle is created. If it is a pointer to an existing UEFI handle, \r
+ then the protocol is added to the existing UEFI handle.\r
\r
- @retval EFI_SUCCES The child handle was created with the I/O services\r
+ @retval EFI_SUCCES The protocol was added to ChildHandle.\r
@retval EFI_INVALID_PARAMETER ChildHandle is NULL.\r
@retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create\r
the child\r
\r
\r
/**\r
- Destroys a child handle with a set of I/O services.\r
+ Destroys a child handle with a protocol installed on it.\r
+ \r
+ The DestroyChild() function does the opposite of CreateChild(). It removes a protocol \r
+ that was installed by CreateChild() from ChildHandle. If the removed protocol is the \r
+ last protocol on ChildHandle, then ChildHandle is destroyed.\r
\r
- @param This Protocol instance pointer.\r
+ @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
@param ChildHandle Handle of the child to destroy\r
\r
- @retval EFI_SUCCES The I/O services were removed from the child handle\r
- @retval EFI_UNSUPPORTED The child handle does not support the I/O services\r
- that are being removed.\r
- @retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle.\r
- @retval EFI_ACCESS_DENIED The child handle could not be destroyed because its\r
- I/O services are being used.\r
+ @retval EFI_SUCCES The protocol was removed from ChildHandle.\r
+ @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.\r
+ @retval EFI_INVALID_PARAMETER Child handle is not a valid UEFI Handle.\r
+ @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle\r
+ because its services are being used.\r
@retval other The child handle was not destroyed\r
\r
**/\r
The entry point for Udp4 driver which installs the driver binding\r
and component name protocol on its ImageHandle.\r
\r
- @param ImageHandle The firmware allocated handle for the UEFI image.\r
- @param SystemTable A pointer to the EFI System Table.\r
+ @param[in] ImageHandle The firmware allocated handle for the UEFI image.\r
+ @param[in] SystemTable A pointer to the EFI System Table.\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.\r
/** @file\r
\r
-Copyright (c) 2006, Intel Corporation\r
+Copyright (c) 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
- Udp4Driver.h\r
-\r
-Abstract:\r
-\r
-\r
**/\r
\r
#ifndef _UDP4_DRIVER_H_\r
follow these calling restrictions. If any other agent wishes to call\r
Supported() it must also follow these calling restrictions.\r
\r
- @param This Protocol instance pointer.\r
- @param ControllerHandle Handle of device to test\r
- @param RemainingDevicePath Optional parameter use to pick a specific child\r
- device to start.\r
+ @param[in] This Protocol instance pointer.\r
+ @param[in] ControllerHandle Handle of device to test\r
+ @param[in] RemainingDevicePath Optional parameter use to pick a specific child\r
+ device to start.\r
\r
@retval EFI_SUCCESS This driver supports this device\r
@retval EFI_ALREADY_STARTED This driver is already running on this device\r
calling restrictions. If any other agent wishes to call Start() it\r
must also follow these calling restrictions.\r
\r
- @param This Protocol instance pointer.\r
- @param ControllerHandle Handle of device to bind driver to\r
- @param RemainingDevicePath Optional parameter use to pick a specific child\r
- device to start.\r
+ @param[in] This Protocol instance pointer.\r
+ @param[in] ControllerHandle Handle of device to bind driver to\r
+ @param[in] RemainingDevicePath Optional parameter use to pick a specific child\r
+ device to start.\r
\r
@retval EFI_SUCCESS This driver is added to ControllerHandle\r
@retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle\r
must follow these calling restrictions. If any other agent wishes\r
to call Stop() it must also follow these calling restrictions.\r
\r
- @param This Protocol instance pointer.\r
- @param ControllerHandle Handle of device to stop driver on\r
- @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r
- children is zero stop the entire bus driver.\r
- @param ChildHandleBuffer List of Child Handles to Stop.\r
+ @param[in] This Protocol instance pointer.\r
+ @param[in] ControllerHandle Handle of device to stop driver on\r
+ @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r
+ children is zero stop the entire bus driver.\r
+ @param[in] ChildHandleBuffer List of Child Handles to Stop.\r
\r
@retval EFI_SUCCESS This driver is removed ControllerHandle\r
@retval other This driver was not removed from this device\r
);\r
\r
/**\r
- Creates a child handle with a set of I/O services.\r
+ Creates a child handle and installs a protocol.\r
+ \r
+ The CreateChild() function installs a protocol on ChildHandle. \r
+ If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle. \r
+ If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.\r
\r
- @param This Protocol instance pointer.\r
- @param ChildHandle Pointer to the handle of the child to create. If it is NULL,\r
- then a new handle is created. If it is not NULL, then the\r
- I/O services are added to the existing child handle.\r
+ @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
+ @param ChildHandle Pointer to the handle of the child to create. If it is NULL,\r
+ then a new handle is created. If it is a pointer to an existing UEFI handle, \r
+ then the protocol is added to the existing UEFI handle.\r
\r
- @retval EFI_SUCCES The child handle was created with the I/O services\r
+ @retval EFI_SUCCES The protocol was added to ChildHandle.\r
@retval EFI_INVALID_PARAMETER ChildHandle is NULL.\r
@retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create\r
the child\r
);\r
\r
/**\r
- Destroys a child handle with a set of I/O services.\r
+ Destroys a child handle with a protocol installed on it.\r
+ \r
+ The DestroyChild() function does the opposite of CreateChild(). It removes a protocol \r
+ that was installed by CreateChild() from ChildHandle. If the removed protocol is the \r
+ last protocol on ChildHandle, then ChildHandle is destroyed.\r
\r
- @param This Protocol instance pointer.\r
+ @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
@param ChildHandle Handle of the child to destroy\r
\r
- @retval EFI_SUCCES The I/O services were removed from the child handle\r
- @retval EFI_UNSUPPORTED The child handle does not support the I/O services\r
- that are being removed.\r
- @retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle.\r
- @retval EFI_ACCESS_DENIED The child handle could not be destroyed because its\r
- I/O services are being used.\r
+ @retval EFI_SUCCES The protocol was removed from ChildHandle.\r
+ @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.\r
+ @retval EFI_INVALID_PARAMETER Child handle is not a valid UEFI Handle.\r
+ @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle\r
+ because its services are being used.\r
@retval other The child handle was not destroyed\r
\r
**/\r
/** @file\r
-\r
-Copyright (c) 2006 - 2008, Intel Corporation \r
+ The implementation of the Udp4 protocol.\r
+ \r
+Copyright (c) 2006 - 2008, 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
- Udp4Impl.c\r
-\r
-Abstract:\r
-\r
- The implementation of the Udp4 protocol.\r
-\r
-\r
**/\r
\r
\r
This function checks and timeouts the I/O datagrams holding by the corresponding\r
service context.\r
\r
- @param Event The event this function registered to.\r
- @param Context The context data registered during the creation of\r
- the Event.\r
-\r
- @return None.\r
+ @param[in] Event The event this function registered to.\r
+ @param[in] Context The context data registered during the creation of\r
+ the Event.\r
\r
**/\r
VOID\r
/**\r
This function finds the udp instance by the specified <Address, Port> pair.\r
\r
- @param InstanceList Pointer to the head of the list linking the udp\r
- instances.\r
- @param Address Pointer to the specified IPv4 address.\r
- @param Port The udp port number.\r
+ @param[in] InstanceList Pointer to the head of the list linking the udp\r
+ instances.\r
+ @param[in] Address Pointer to the specified IPv4 address.\r
+ @param[in] Port The udp port number.\r
\r
@retval TRUE The specified <Address, Port> pair is found.\r
@retval FALSE Otherwise.\r
interface. It's called to signal the udp TxToken when IpIo layer completes the\r
transmitting of the udp datagram.\r
\r
- @param Status The completion status of the output udp datagram.\r
- @param Context Pointer to the context data.\r
- @param Sender Pointer to the Ip sender of the udp datagram.\r
- @param NotifyData Pointer to the notify data.\r
-\r
- @return None.\r
+ @param[in] Status The completion status of the output udp datagram.\r
+ @param[in] Context Pointer to the context data.\r
+ @param[in] Sender Pointer to the Ip sender of the udp datagram.\r
+ @param[in] NotifyData Pointer to the notify data.\r
\r
**/\r
VOID\r
/**\r
This function processes the received datagram passed up by the IpIo layer.\r
\r
- @param Status The status of this udp datagram.\r
- @param IcmpError The IcmpError code, only available when Status is\r
+ @param[in] Status The status of this udp datagram.\r
+ @param[in] IcmpError The IcmpError code, only available when Status is\r
EFI_ICMP_ERROR.\r
- @param NetSession Pointer to the EFI_NET_SESSION_DATA.\r
- @param Packet Pointer to the NET_BUF containing the received udp\r
+ @param[in] NetSession Pointer to the EFI_NET_SESSION_DATA.\r
+ @param[in] Packet Pointer to the NET_BUF containing the received udp\r
datagram.\r
- @param Context Pointer to the context data.\r
-\r
- @return None.\r
+ @param[in] Context Pointer to the context data.\r
\r
**/\r
VOID\r
This function cancels the token specified by Arg in the Map. This is a callback\r
used by Udp4InstanceCancelToken().\r
\r
- @param Map Pointer to the NET_MAP.\r
- @param Item Pointer to the NET_MAP_ITEM.\r
- @param Arg Pointer to the token to be cancelled, if NULL,\r
+ @param[in] Map Pointer to the NET_MAP.\r
+ @param[in] Item Pointer to the NET_MAP_ITEM.\r
+ @param[in] Arg Pointer to the token to be cancelled, if NULL,\r
the token specified by Item is cancelled.\r
\r
@retval EFI_SUCCESS The token is cancelled if Arg is NULL or the token\r
/**\r
This function matches the received udp datagram with the Instance.\r
\r
- @param Instance Pointer to the udp instance context data.\r
- @param Udp4Session Pointer to the EFI_UDP4_SESSION_DATA abstracted\r
+ @param[in] Instance Pointer to the udp instance context data.\r
+ @param[in] Udp4Session Pointer to the EFI_UDP4_SESSION_DATA abstracted\r
from the received udp datagram.\r
\r
@retval TRUE The udp datagram matches the receiving requirments of the\r
/**\r
This function removes the Wrap specified by Context and release relevant resources.\r
\r
- @param Event The Event this notify function registered to.\r
- @param Context Pointer to the context data.\r
-\r
- @return None.\r
+ @param[in] Event The Event this notify function registered to.\r
+ @param[in] Context Pointer to the context data.\r
\r
**/\r
VOID\r
/**\r
This function wraps the Packet and the RxData.\r
\r
- @param Instance Pointer to the instance context data.\r
- @param Packet Pointer to the buffer containing the received\r
- datagram.\r
- @param RxData Pointer to the EFI_UDP4_RECEIVE_DATA of this\r
- datagram.\r
+ @param[in] Instance Pointer to the instance context data.\r
+ @param[in] Packet Pointer to the buffer containing the received\r
+ datagram.\r
+ @param[in] RxData Pointer to the EFI_UDP4_RECEIVE_DATA of this\r
+ datagram.\r
\r
@return Pointer to the structure wrapping the RxData and the Packet.\r
\r
/**\r
This function enqueues the received datagram into the instances' receiving queues.\r
\r
- @param Udp4Service Pointer to the udp service context data.\r
- @param Packet Pointer to the buffer containing the received\r
- datagram.\r
- @param RxData Pointer to the EFI_UDP4_RECEIVE_DATA of this\r
- datagram.\r
+ @param[in] Udp4Service Pointer to the udp service context data.\r
+ @param[in] Packet Pointer to the buffer containing the received\r
+ datagram.\r
+ @param[in] RxData Pointer to the EFI_UDP4_RECEIVE_DATA of this\r
+ datagram.\r
\r
@return The times this datagram is enqueued.\r
\r
/**\r
This function delivers the datagrams enqueued in the instances.\r
\r
- @param Udp4Service Pointer to the udp service context data.\r
-\r
- @return None.\r
+ @param[in] Udp4Service Pointer to the udp service context data.\r
\r
**/\r
VOID\r
/**\r
This function demultiplexes the received udp datagram to the apropriate instances.\r
\r
- @param Udp4Service Pointer to the udp service context data.\r
- @param NetSession Pointer to the EFI_NET_SESSION_DATA abstrated from\r
- the received datagram.\r
- @param Packet Pointer to the buffer containing the received udp\r
- datagram.\r
-\r
- @return None.\r
+ @param[in] Udp4Service Pointer to the udp service context data.\r
+ @param[in] NetSession Pointer to the EFI_NET_SESSION_DATA abstrated from\r
+ the received datagram.\r
+ @param[in] Packet Pointer to the buffer containing the received udp\r
+ datagram.\r
\r
**/\r
VOID\r
This function handles the received Icmp Error message and demultiplexes it to the\r
instance.\r
\r
- @param Udp4Service Pointer to the udp service context data.\r
- @param IcmpError The icmp error code.\r
- @param NetSession Pointer to the EFI_NET_SESSION_DATA abstracted\r
+ @param[in] Udp4Service Pointer to the udp service context data.\r
+ @param[in] IcmpError The icmp error code.\r
+ @param[in] NetSession Pointer to the EFI_NET_SESSION_DATA abstracted\r
from the received Icmp Error packet.\r
- @param Packet Pointer to the Icmp Error packet.\r
-\r
- @return None.\r
+ @param[in] Packet Pointer to the Icmp Error packet.\r
\r
**/\r
VOID\r
/**\r
This function builds and sends out a icmp port unreachable message.\r
\r
- @param IpIo Pointer to the IP_IO instance.\r
- @param NetSession Pointer to the EFI_NET_SESSION_DATA of the packet\r
- causes this icmp error message.\r
- @param Udp4Header Pointer to the udp header of the datagram causes\r
- this icmp error message.\r
-\r
- @return None.\r
+ @param[in] IpIo Pointer to the IP_IO instance.\r
+ @param[in] NetSession Pointer to the EFI_NET_SESSION_DATA of the packet\r
+ causes this icmp error message.\r
+ @param[in] Udp4Header Pointer to the udp header of the datagram causes\r
+ this icmp error message.\r
\r
**/\r
VOID\r
/**\r
Clean the Udp service context data.\r
\r
- @param Udp4Service Pointer to the UDP4_SERVICE_DATA.\r
-\r
- @return None.\r
+ @param[in] Udp4Service Pointer to the UDP4_SERVICE_DATA.\r
\r
**/\r
VOID\r
This function checks and timeouts the I/O datagrams holding by the corresponding\r
service context.\r
\r
- @param Event The event this function registered to.\r
- @param Context The context data registered during the creation of\r
- the Event.\r
-\r
- @return None.\r
+ @param[in] Event The event this function registered to.\r
+ @param[in] Context The context data registered during the creation of\r
+ the Event.\r
\r
**/\r
VOID\r
@param Udp4Service Pointer to the UDP4_SERVICE_DATA.\r
@param Instance Pointer to the un-initialized UDP4_INSTANCE_DATA.\r
\r
- @return None.\r
-\r
**/\r
VOID\r
Udp4InitInstance (\r
/**\r
This function cleans the udp instance.\r
\r
- @param Instance Pointer to the UDP4_INSTANCE_DATA to clean.\r
-\r
- @return None.\r
+ @param[in] Instance Pointer to the UDP4_INSTANCE_DATA to clean.\r
\r
**/\r
VOID\r
/**\r
This function finds the udp instance by the specified <Address, Port> pair.\r
\r
- @param InstanceList Pointer to the head of the list linking the udp\r
- instances.\r
- @param Address Pointer to the specified IPv4 address.\r
- @param Port The udp port number.\r
+ @param[in] InstanceList Pointer to the head of the list linking the udp\r
+ instances.\r
+ @param[in] Address Pointer to the specified IPv4 address.\r
+ @param[in] Port The udp port number.\r
\r
@retval TRUE The specified <Address, Port> pair is found.\r
@retval FALSE Otherwise.\r
This function is used to check whether the NewConfigData has any un-reconfigurable\r
parameters changed compared to the OldConfigData.\r
\r
- @param OldConfigData Pointer to the current ConfigData the udp instance\r
+ @param[in] OldConfigData Pointer to the current ConfigData the udp instance\r
uses.\r
- @param NewConfigData Pointer to the new ConfigData.\r
+ @param[in] NewConfigData Pointer to the new ConfigData.\r
\r
@retval TRUE The instance is reconfigurable.\r
@retval FALSE Otherwise.\r
/**\r
This function builds the Ip4 configdata from the Udp4ConfigData.\r
\r
- @param Udp4ConfigData Pointer to the EFI_UDP4_CONFIG_DATA.\r
- @param Ip4ConfigData Pointer to the EFI_IP4_CONFIG_DATA.\r
-\r
- @return None.\r
+ @param[in] Udp4ConfigData Pointer to the EFI_UDP4_CONFIG_DATA.\r
+ @param[in, out] Ip4ConfigData Pointer to the EFI_IP4_CONFIG_DATA.\r
\r
**/\r
VOID\r
/**\r
This function validates the TxToken, it returns the error code according to the spec.\r
\r
- @param Instance Pointer to the udp instance context data.\r
- @param TxToken Pointer to the token to be checked.\r
+ @param[in] Instance Pointer to the udp instance context data.\r
+ @param[in] TxToken Pointer to the token to be checked.\r
\r
@retval EFI_SUCCESS The TxToken is valid.\r
@retval EFI_INVALID_PARAMETER One or more of the following are TRUE: This is\r
/**\r
This function checks whether the specified Token duplicates with the one in the Map.\r
\r
- @param Map Pointer to the NET_MAP.\r
- @param Item Pointer to the NET_MAP_ITEM contain the pointer to\r
+ @param[in] Map Pointer to the NET_MAP.\r
+ @param[in] Item Pointer to the NET_MAP_ITEM contain the pointer to\r
the Token.\r
- @param Context Pointer to the Token to be checked.\r
+ @param[in] Context Pointer to the Token to be checked.\r
\r
@retval EFI_SUCCESS The Token specified by Context differs from the\r
one in the Item.\r
This function calculates the checksum for the Packet, utilizing the pre-calculated\r
pseudo HeadSum to reduce some overhead.\r
\r
- @param Packet Pointer to the NET_BUF contains the udp datagram.\r
- @param HeadSum Checksum of the pseudo header execpt the length\r
+ @param[in] Packet Pointer to the NET_BUF contains the udp datagram.\r
+ @param[in] HeadSum Checksum of the pseudo header execpt the length\r
field.\r
\r
- @return The 16-bit checksum of this udp datagram.\r
+ @retval The 16-bit checksum of this udp datagram.\r
\r
**/\r
UINT16\r
/**\r
This function removes the specified Token from the TokenMap.\r
\r
- @param TokenMap Pointer to the NET_MAP containing the tokens.\r
- @param Token Pointer to the Token to be removed.\r
+ @param TokenMap Pointer to the NET_MAP containing the tokens.\r
+ @param Token Pointer to the Token to be removed.\r
\r
@retval EFI_SUCCESS The specified Token is removed from the TokenMap.\r
@retval EFI_NOT_FOUND The specified Token is not found in the TokenMap.\r
interface. It's called to signal the udp TxToken when IpIo layer completes the\r
transmitting of the udp datagram.\r
\r
- @param Status The completion status of the output udp datagram.\r
- @param Context Pointer to the context data.\r
- @param Sender Pointer to the Ip sender of the udp datagram.\r
- @param NotifyData Pointer to the notify data.\r
-\r
- @return None.\r
+ @param[in] Status The completion status of the output udp datagram.\r
+ @param[in] Context Pointer to the context data.\r
+ @param[in] Sender Pointer to the Ip sender of the udp datagram.\r
+ @param[in] NotifyData Pointer to the notify data.\r
\r
**/\r
VOID\r
/**\r
This function processes the received datagram passed up by the IpIo layer.\r
\r
- @param Status The status of this udp datagram.\r
- @param IcmpError The IcmpError code, only available when Status is\r
+ @param[in] Status The status of this udp datagram.\r
+ @param[in] IcmpError The IcmpError code, only available when Status is\r
EFI_ICMP_ERROR.\r
- @param NetSession Pointer to the EFI_NET_SESSION_DATA.\r
- @param Packet Pointer to the NET_BUF containing the received udp\r
+ @param[in] NetSession Pointer to the EFI_NET_SESSION_DATA.\r
+ @param[in] Packet Pointer to the NET_BUF containing the received udp\r
datagram.\r
- @param Context Pointer to the context data.\r
-\r
- @return None.\r
+ @param[in] Context Pointer to the context data.\r
\r
**/\r
VOID\r
This function cancels the token specified by Arg in the Map. This is a callback\r
used by Udp4InstanceCancelToken().\r
\r
- @param Map Pointer to the NET_MAP.\r
- @param Item Pointer to the NET_MAP_ITEM.\r
- @param Arg Pointer to the token to be cancelled, if NULL,\r
+ @param[in] Map Pointer to the NET_MAP.\r
+ @param[in] Item Pointer to the NET_MAP_ITEM.\r
+ @param[in] Arg Pointer to the token to be cancelled, if NULL,\r
the token specified by Item is cancelled.\r
\r
@retval EFI_SUCCESS The token is cancelled if Arg is NULL or the token\r
/**\r
This function removes all the Wrap datas in the RcvdDgramQue.\r
\r
- @param Instance Pointer to the udp instance context data.\r
-\r
- @return None.\r
+ @param[in] Instance Pointer to the udp instance context data.\r
\r
**/\r
VOID\r
/**\r
Cancel Udp4 tokens from the Udp4 instance.\r
\r
- @param Instance Pointer to the udp instance context data.\r
- @param Token Pointer to the token to be canceled, if NULL, all\r
+ @param[in] Instance Pointer to the udp instance context data.\r
+ @param[in] Token Pointer to the token to be canceled, if NULL, all\r
tokens in this instance will be cancelled.\r
\r
@retval EFI_SUCCESS The Token is cancelled.\r
/**\r
This function matches the received udp datagram with the Instance.\r
\r
- @param Instance Pointer to the udp instance context data.\r
- @param Udp4Session Pointer to the EFI_UDP4_SESSION_DATA abstracted\r
+ @param[in] Instance Pointer to the udp instance context data.\r
+ @param[in] Udp4Session Pointer to the EFI_UDP4_SESSION_DATA abstracted\r
from the received udp datagram.\r
\r
@retval TRUE The udp datagram matches the receiving requirments of the\r
/**\r
This function removes the Wrap specified by Context and release relevant resources.\r
\r
- @param Event The Event this notify function registered to.\r
- @param Context Pointer to the context data.\r
-\r
- @return None.\r
+ @param[in] Event The Event this notify function registered to.\r
+ @param[in] Context Pointer to the context data.\r
\r
**/\r
VOID\r
/**\r
This function wraps the Packet and the RxData.\r
\r
- @param Instance Pointer to the instance context data.\r
- @param Packet Pointer to the buffer containing the received\r
- datagram.\r
- @param RxData Pointer to the EFI_UDP4_RECEIVE_DATA of this\r
- datagram.\r
+ @param[in] Instance Pointer to the instance context data.\r
+ @param[in] Packet Pointer to the buffer containing the received\r
+ datagram.\r
+ @param[in] RxData Pointer to the EFI_UDP4_RECEIVE_DATA of this\r
+ datagram.\r
\r
@return Pointer to the structure wrapping the RxData and the Packet.\r
\r
/**\r
This function enqueues the received datagram into the instances' receiving queues.\r
\r
- @param Udp4Service Pointer to the udp service context data.\r
- @param Packet Pointer to the buffer containing the received\r
- datagram.\r
- @param RxData Pointer to the EFI_UDP4_RECEIVE_DATA of this\r
- datagram.\r
+ @param[in] Udp4Service Pointer to the udp service context data.\r
+ @param[in] Packet Pointer to the buffer containing the received\r
+ datagram.\r
+ @param[in] RxData Pointer to the EFI_UDP4_RECEIVE_DATA of this\r
+ datagram.\r
\r
@return The times this datagram is enqueued.\r
\r
/**\r
This function delivers the received datagrams for the specified instance.\r
\r
- @param Instance Pointer to the instance context data.\r
-\r
- @return None.\r
+ @param[in] Instance Pointer to the instance context data.\r
\r
**/\r
VOID\r
/**\r
This function delivers the datagrams enqueued in the instances.\r
\r
- @param Udp4Service Pointer to the udp service context data.\r
-\r
- @return None.\r
+ @param[in] Udp4Service Pointer to the udp service context data.\r
\r
**/\r
VOID\r
/**\r
This function demultiplexes the received udp datagram to the apropriate instances.\r
\r
- @param Udp4Service Pointer to the udp service context data.\r
- @param NetSession Pointer to the EFI_NET_SESSION_DATA abstrated from\r
- the received datagram.\r
- @param Packet Pointer to the buffer containing the received udp\r
- datagram.\r
-\r
- @return None.\r
+ @param[in] Udp4Service Pointer to the udp service context data.\r
+ @param[in] NetSession Pointer to the EFI_NET_SESSION_DATA abstrated from\r
+ the received datagram.\r
+ @param[in] Packet Pointer to the buffer containing the received udp\r
+ datagram.\r
\r
**/\r
VOID\r
/**\r
This function builds and sends out a icmp port unreachable message.\r
\r
- @param IpIo Pointer to the IP_IO instance.\r
- @param NetSession Pointer to the EFI_NET_SESSION_DATA of the packet\r
- causes this icmp error message.\r
- @param Udp4Header Pointer to the udp header of the datagram causes\r
- this icmp error message.\r
-\r
- @return None.\r
+ @param[in] IpIo Pointer to the IP_IO instance.\r
+ @param[in] NetSession Pointer to the EFI_NET_SESSION_DATA of the packet\r
+ causes this icmp error message.\r
+ @param[in] Udp4Header Pointer to the udp header of the datagram causes\r
+ this icmp error message.\r
\r
**/\r
VOID\r
This function handles the received Icmp Error message and demultiplexes it to the\r
instance.\r
\r
- @param Udp4Service Pointer to the udp service context data.\r
- @param IcmpError The icmp error code.\r
- @param NetSession Pointer to the EFI_NET_SESSION_DATA abstracted\r
+ @param[in] Udp4Service Pointer to the udp service context data.\r
+ @param[in] IcmpError The icmp error code.\r
+ @param[in] NetSession Pointer to the EFI_NET_SESSION_DATA abstracted\r
from the received Icmp Error packet.\r
- @param Packet Pointer to the Icmp Error packet.\r
-\r
- @return None.\r
+ @param[in] Packet Pointer to the Icmp Error packet.\r
\r
**/\r
VOID\r
/**\r
This function reports the received ICMP error.\r
\r
- @param Instance Pointer to the udp instance context data.\r
-\r
- @return None.\r
+ @param[in] Instance Pointer to the udp instance context data.\r
\r
**/\r
VOID\r
This function is a dummy ext-free function for the NET_BUF created for the output\r
udp datagram.\r
\r
- @param Context Pointer to the context data.\r
-\r
- @return None.\r
+ @param[in] Context Pointer to the context data.\r
\r
**/\r
VOID\r
/**\r
Clear the variable and free the resource.\r
\r
- @param Udp4Service Udp4 service data.\r
-\r
- @return None.\r
+ @param[[in] Udp4Service Udp4 service data.\r
\r
**/\r
VOID\r
/** @file\r
-\r
-Copyright (c) 2006 - 2007, Intel Corporation\r
+ EFI UDPv4 protocol implementation.\r
+ \r
+Copyright (c) 2006 - 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
- Udp4Impl.h\r
-\r
-Abstract:\r
-\r
- EFI UDPv4 protocol implementation\r
-\r
-\r
**/\r
\r
#ifndef _UDP4_IMPL_H_\r
With different parameters in UdpConfigData, Configure() can be used to bind\r
this instance to specified port.\r
\r
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
- @param UdpConfigData Pointer to the buffer to receive the current configuration data.\r
+ @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance.\r
+ @param[in] UdpConfigData Pointer to the buffer to receive the current configuration data.\r
\r
@retval EFI_SUCCESS The configuration settings were set, changed, or reset successfully.\r
@retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,\r
filtering. If the JoinFlag is FALSE and the MulticastAddress is NULL, then all\r
currently joined groups are left.\r
\r
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
- @param JoinFlag Set to TRUE to join a multicast group. Set to FALSE to leave one\r
- or all multicast groups.\r
- @param MulticastAddress Pointer to multicast group address to join or leave.\r
+ @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance.\r
+ @param[in] JoinFlag Set to TRUE to join a multicast group. Set to FALSE to leave one\r
+ or all multicast groups.\r
+ @param[in] MulticastAddress Pointer to multicast group address to join or leave.\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_NOT_STARTED The EFI UDPv4 Protocol instance has not been started.\r
copies will be updated automatically whenever the IP driver reconfigures its\r
instances; as a result, the previous modification to these copies will be lost.\r
\r
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
- @param DeleteRoute Set to TRUE to delete this route from the routing table.\r
- Set to FALSE to add this route to the routing table.\r
- @param SubnetAddress The destination network address that needs to be routed.\r
- @param SubnetMask The subnet mask of SubnetAddress.\r
- @param GatewayAddress The gateway IP address for this route.\r
+ @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance.\r
+ @param[in] DeleteRoute Set to TRUE to delete this route from the routing table.\r
+ Set to FALSE to add this route to the routing table.\r
+ @param[in] SubnetAddress The destination network address that needs to be routed.\r
+ @param[in] SubnetMask The subnet mask of SubnetAddress.\r
+ @param[in] GatewayAddress The gateway IP address for this route.\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_NOT_STARTED The EFI UDPv4 Protocol instance has not been started.\r
and context for the event will enable the user to receive the notification and\r
transmitting status.\r
\r
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
- @param Token Pointer to the completion token that will be placed into the\r
- transmit queue.\r
+ @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance.\r
+ @param[in] Token Pointer to the completion token that will be placed into the\r
+ transmit queue.\r
\r
@retval EFI_SUCCESS The data has been queued for transmission.\r
@retval EFI_NOT_STARTED This EFI UDPv4 Protocol instance has not been started.\r
will enable the user to receive the notification and receiving status. That\r
notification function is guaranteed to not be re-entered.\r
\r
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
- @param Token Pointer to a token that is associated with the receive data\r
- descriptor.\r
+ @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance.\r
+ @param[in] Token Pointer to a token that is associated with\r
+ the receive data descriptor.\r
\r
@retval EFI_SUCCESS The receive completion token was cached.\r
@retval EFI_NOT_STARTED This EFI UDPv4 Protocol instance has not been started.\r
the asynchronous operation has completed, this function will not signal the\r
token and EFI_NOT_FOUND is returned.\r
\r
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
- @param Token Pointer to a token that has been issued by\r
- EFI_UDP4_PROTOCOL.Transmit() or\r
- EFI_UDP4_PROTOCOL.Receive().If NULL, all pending\r
- tokens are aborted.\r
+ @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance.\r
+ @param[in] Token Pointer to a token that has been issued by\r
+ EFI_UDP4_PROTOCOL.Transmit() or\r
+ EFI_UDP4_PROTOCOL.Receive().If NULL, all pending\r
+ tokens are aborted.\r
\r
@retval EFI_SUCCESS The asynchronous I/O request was aborted and Token.Event\r
was signaled. When Token is NULL, all pending requests are\r
Drivers and applications that are experiencing packet loss should try calling\r
the Poll() function more often.\r
\r
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
+ @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance.\r
\r
@retval EFI_SUCCESS Incoming or outgoing data was processed.\r
@retval EFI_INVALID_PARAMETER This is NULL.\r
/**\r
Clean the Udp service context data.\r
\r
- @param Udp4Service Pointer to the UDP4_SERVICE_DATA.\r
-\r
- @return None.\r
+ @param[in] Udp4Service Pointer to the UDP4_SERVICE_DATA.\r
\r
**/\r
VOID\r
@param Udp4Service Pointer to the UDP4_SERVICE_DATA.\r
@param Instance Pointer to the un-initialized UDP4_INSTANCE_DATA.\r
\r
- @return None.\r
-\r
**/\r
VOID\r
Udp4InitInstance (\r
/**\r
This function cleans the udp instance.\r
\r
- @param Instance Pointer to the UDP4_INSTANCE_DATA to clean.\r
-\r
- @return None.\r
+ @param[in] Instance Pointer to the UDP4_INSTANCE_DATA to clean.\r
\r
**/\r
VOID\r
This function is used to check whether the NewConfigData has any un-reconfigurable\r
parameters changed compared to the OldConfigData.\r
\r
- @param OldConfigData Pointer to the current ConfigData the udp instance\r
+ @param[in] OldConfigData Pointer to the current ConfigData the udp instance\r
uses.\r
- @param NewConfigData Pointer to the new ConfigData.\r
+ @param[in] NewConfigData Pointer to the new ConfigData.\r
\r
@retval TRUE The instance is reconfigurable.\r
@retval FALSE Otherwise.\r
/**\r
This function builds the Ip4 configdata from the Udp4ConfigData.\r
\r
- @param Udp4ConfigData Pointer to the EFI_UDP4_CONFIG_DATA.\r
- @param Ip4ConfigData Pointer to the EFI_IP4_CONFIG_DATA.\r
-\r
- @return None.\r
+ @param[in] Udp4ConfigData Pointer to the EFI_UDP4_CONFIG_DATA.\r
+ @param[in, out] Ip4ConfigData Pointer to the EFI_IP4_CONFIG_DATA.\r
\r
**/\r
VOID\r
/**\r
This function validates the TxToken, it returns the error code according to the spec.\r
\r
- @param Instance Pointer to the udp instance context data.\r
- @param TxToken Pointer to the token to be checked.\r
+ @param[in] Instance Pointer to the udp instance context data.\r
+ @param[in] TxToken Pointer to the token to be checked.\r
\r
@retval EFI_SUCCESS The TxToken is valid.\r
@retval EFI_INVALID_PARAMETER One or more of the following are TRUE: This is\r
/**\r
This function checks whether the specified Token duplicates with the one in the Map.\r
\r
- @param Map Pointer to the NET_MAP.\r
- @param Item Pointer to the NET_MAP_ITEM contain the pointer to\r
+ @param[in] Map Pointer to the NET_MAP.\r
+ @param[in] Item Pointer to the NET_MAP_ITEM contain the pointer to\r
the Token.\r
- @param Context Pointer to the Token to be checked.\r
+ @param[in] Context Pointer to the Token to be checked.\r
\r
@retval EFI_SUCCESS The Token specified by Context differs from the\r
one in the Item.\r
This function calculates the checksum for the Packet, utilizing the pre-calculated\r
pseudo HeadSum to reduce some overhead.\r
\r
- @param Packet Pointer to the NET_BUF contains the udp datagram.\r
- @param HeadSum Checksum of the pseudo header execpt the length\r
+ @param[in] Packet Pointer to the NET_BUF contains the udp datagram.\r
+ @param[in] HeadSum Checksum of the pseudo header execpt the length\r
field.\r
\r
- @return The 16-bit checksum of this udp datagram.\r
+ @retval The 16-bit checksum of this udp datagram.\r
\r
**/\r
UINT16\r
/**\r
This function removes the specified Token from the TokenMap.\r
\r
- @param TokenMap Pointer to the NET_MAP containing the tokens.\r
- @param Token Pointer to the Token to be removed.\r
+ @param TokenMap Pointer to the NET_MAP containing the tokens.\r
+ @param Token Pointer to the Token to be removed.\r
\r
@retval EFI_SUCCESS The specified Token is removed from the TokenMap.\r
@retval EFI_NOT_FOUND The specified Token is not found in the TokenMap.\r
/**\r
This function removes all the Wrap datas in the RcvdDgramQue.\r
\r
- @param Instance Pointer to the udp instance context data.\r
-\r
- @return None.\r
+ @param[in] Instance Pointer to the udp instance context data.\r
\r
**/\r
VOID\r
/**\r
Cancel Udp4 tokens from the Udp4 instance.\r
\r
- @param Instance Pointer to the udp instance context data.\r
- @param Token Pointer to the token to be canceled, if NULL, all\r
+ @param[in] Instance Pointer to the udp instance context data.\r
+ @param[in] Token Pointer to the token to be canceled, if NULL, all\r
tokens in this instance will be cancelled.\r
\r
@retval EFI_SUCCESS The Token is cancelled.\r
/**\r
This function delivers the received datagrams for the specified instance.\r
\r
- @param Instance Pointer to the instance context data.\r
-\r
- @return None.\r
+ @param[in] Instance Pointer to the instance context data.\r
\r
**/\r
VOID\r
/**\r
This function reports the received ICMP error.\r
\r
- @param Instance Pointer to the udp instance context data.\r
-\r
- @return None.\r
+ @param[in] Instance Pointer to the udp instance context data.\r
\r
**/\r
VOID\r
This function is a dummy ext-free function for the NET_BUF created for the output\r
udp datagram.\r
\r
- @param Context Pointer to the context data.\r
-\r
- @return None.\r
+ @param[in] Context Pointer to the context data.\r
\r
**/\r
VOID\r
/**\r
Clear the variable and free the resource.\r
\r
- @param Udp4Service Udp4 service data.\r
-\r
- @return None.\r
+ @param[[in] Udp4Service Udp4 service data.\r
\r
**/\r
VOID\r
/** @file\r
\r
-Copyright (c) 2006 - 2007, Intel Corporation\r
+Copyright (c) 2006 - 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
- Udp4Main.c\r
-\r
-Abstract:\r
-\r
-\r
**/\r
\r
#include "Udp4Impl.h"\r
With different parameters in UdpConfigData, Configure() can be used to bind\r
this instance to specified port.\r
\r
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
- @param UdpConfigData Pointer to the buffer to receive the current configuration data.\r
+ @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance.\r
+ @param[in] UdpConfigData Pointer to the buffer to receive the current configuration data.\r
\r
@retval EFI_SUCCESS The configuration settings were set, changed, or reset successfully.\r
@retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,\r
filtering. If the JoinFlag is FALSE and the MulticastAddress is NULL, then all\r
currently joined groups are left.\r
\r
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
- @param JoinFlag Set to TRUE to join a multicast group. Set to FALSE to leave one\r
- or all multicast groups.\r
- @param MulticastAddress Pointer to multicast group address to join or leave.\r
+ @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance.\r
+ @param[in] JoinFlag Set to TRUE to join a multicast group. Set to FALSE to leave one\r
+ or all multicast groups.\r
+ @param[in] MulticastAddress Pointer to multicast group address to join or leave.\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_NOT_STARTED The EFI UDPv4 Protocol instance has not been started.\r
copies will be updated automatically whenever the IP driver reconfigures its\r
instances; as a result, the previous modification to these copies will be lost.\r
\r
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
- @param DeleteRoute Set to TRUE to delete this route from the routing table.\r
- Set to FALSE to add this route to the routing table.\r
- @param SubnetAddress The destination network address that needs to be routed.\r
- @param SubnetMask The subnet mask of SubnetAddress.\r
- @param GatewayAddress The gateway IP address for this route.\r
+ @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance.\r
+ @param[in] DeleteRoute Set to TRUE to delete this route from the routing table.\r
+ Set to FALSE to add this route to the routing table.\r
+ @param[in] SubnetAddress The destination network address that needs to be routed.\r
+ @param[in] SubnetMask The subnet mask of SubnetAddress.\r
+ @param[in] GatewayAddress The gateway IP address for this route.\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_NOT_STARTED The EFI UDPv4 Protocol instance has not been started.\r
and context for the event will enable the user to receive the notification and\r
transmitting status.\r
\r
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
- @param Token Pointer to the completion token that will be placed into the\r
- transmit queue.\r
+ @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance.\r
+ @param[in] Token Pointer to the completion token that will be placed into the\r
+ transmit queue.\r
\r
@retval EFI_SUCCESS The data has been queued for transmission.\r
@retval EFI_NOT_STARTED This EFI UDPv4 Protocol instance has not been started.\r
will enable the user to receive the notification and receiving status. That\r
notification function is guaranteed to not be re-entered.\r
\r
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
- @param Token Pointer to a token that is associated with the receive data\r
- descriptor.\r
+ @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance.\r
+ @param[in] Token Pointer to a token that is associated with\r
+ the receive data descriptor.\r
\r
@retval EFI_SUCCESS The receive completion token was cached.\r
@retval EFI_NOT_STARTED This EFI UDPv4 Protocol instance has not been started.\r
the asynchronous operation has completed, this function will not signal the\r
token and EFI_NOT_FOUND is returned.\r
\r
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
- @param Token Pointer to a token that has been issued by\r
- EFI_UDP4_PROTOCOL.Transmit() or\r
- EFI_UDP4_PROTOCOL.Receive().If NULL, all pending\r
- tokens are aborted.\r
+ @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance.\r
+ @param[in] Token Pointer to a token that has been issued by\r
+ EFI_UDP4_PROTOCOL.Transmit() or\r
+ EFI_UDP4_PROTOCOL.Receive().If NULL, all pending\r
+ tokens are aborted.\r
\r
@retval EFI_SUCCESS The asynchronous I/O request was aborted and Token.Event\r
was signaled. When Token is NULL, all pending requests are\r
Drivers and applications that are experiencing packet loss should try calling\r
the Poll() function more often.\r
\r
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
+ @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance.\r
\r
@retval EFI_SUCCESS Incoming or outgoing data was processed.\r
@retval EFI_INVALID_PARAMETER This is NULL.\r
projects / mirror_edk2.git / commitdiff