diff options
| author | jgong5 <jgong5@6f19259b-4bc3-4df7-8a09-765794883524> | 2009-01-16 00:09:52 +0000 |
|---|---|---|
| committer | jgong5 <jgong5@6f19259b-4bc3-4df7-8a09-765794883524> | 2009-01-16 00:09:52 +0000 |
| commit | 3e8c18da0441069591e5aa218f378001b29512dd (patch) | |
| tree | 84c54ffaf1dd6f1c02f6294504d73431c5f1e5e0 /MdeModulePkg/Universal/Network/Udp4Dxe | |
| parent | be973ff7f3a7c8b87cac0da9ba416cd9baca3e44 (diff) | |
| download | edk2-platforms-3e8c18da0441069591e5aa218f378001b29512dd.tar.xz | |
code scrub fix
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7290 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdeModulePkg/Universal/Network/Udp4Dxe')
| -rw-r--r-- | MdeModulePkg/Universal/Network/Udp4Dxe/ComponentName.c | 41 | ||||
| -rw-r--r-- | MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Driver.c | 74 | ||||
| -rw-r--r-- | MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Driver.h | 70 | ||||
| -rw-r--r-- | MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Impl.c | 302 | ||||
| -rw-r--r-- | MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Impl.h | 126 | ||||
| -rw-r--r-- | MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Main.c | 57 |
6 files changed, 286 insertions, 384 deletions
diff --git a/MdeModulePkg/Universal/Network/Udp4Dxe/ComponentName.c b/MdeModulePkg/Universal/Network/Udp4Dxe/ComponentName.c index b5176559b0..27c3d0b299 100644 --- a/MdeModulePkg/Universal/Network/Udp4Dxe/ComponentName.c +++ b/MdeModulePkg/Universal/Network/Udp4Dxe/ComponentName.c @@ -1,6 +1,6 @@ /** @file
-Copyright (c) 2006 - 2007, Intel Corporation
+Copyright (c) 2006 - 2007, Intel Corporation.<BR>
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -9,13 +9,6 @@ http://opensource.org/licenses/bsd-license.php THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-Module Name:
-
- ComponentName.c
-
-Abstract:
-
-
**/
@@ -34,10 +27,10 @@ Abstract: by This does not support the language specified by Language,
then EFI_UNSUPPORTED is returned.
- @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
+ @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
EFI_COMPONENT_NAME_PROTOCOL instance.
- @param Language[in] A pointer to a Null-terminated ASCII string
+ @param[in] Language A pointer to a Null-terminated ASCII string
array indicating the language. This is the
language of the driver name that the caller is
requesting, and it must match one of the
@@ -46,7 +39,7 @@ Abstract: to the driver writer. Language is specified
in RFC 3066 or ISO 639-2 language code format.
- @param DriverName[out] A pointer to the Unicode string to return.
+ @param[out] DriverName A pointer to the Unicode string to return.
This Unicode string is the name of the
driver specified by This in the language
specified by Language.
@@ -85,15 +78,15 @@ UdpComponentNameGetDriverName ( then EFI_UNSUPPORTED is returned. If the driver specified by This does not
support the language specified by Language, then EFI_UNSUPPORTED is returned.
- @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
+ @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
EFI_COMPONENT_NAME_PROTOCOL instance.
- @param ControllerHandle[in] The handle of a controller that the driver
+ @param[in] ControllerHandle The handle of a controller that the driver
specified by This is managing. This handle
specifies the controller whose name is to be
returned.
- @param ChildHandle[in] The handle of the child controller to retrieve
+ @param[in] ChildHandle The handle of the child controller to retrieve
the name of. This is an optional parameter that
may be NULL. It will be NULL for device
drivers. It will also be NULL for a bus drivers
@@ -102,7 +95,7 @@ UdpComponentNameGetDriverName ( driver that wishes to retrieve the name of a
child controller.
- @param Language[in] A pointer to a Null-terminated ASCII string
+ @param[in] Language A pointer to a Null-terminated ASCII string
array indicating the language. This is the
language of the driver name that the caller is
requesting, and it must match one of the
@@ -111,7 +104,7 @@ UdpComponentNameGetDriverName ( to the driver writer. Language is specified in
RFC 3066 or ISO 639-2 language code format.
- @param ControllerName[out] A pointer to the Unicode string to return.
+ @param[out] ControllerName A pointer to the Unicode string to return.
This Unicode string is the name of the
controller specified by ControllerHandle and
ChildHandle in the language specified by
@@ -191,10 +184,10 @@ GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mUdpDriverNameTable[] = { by This does not support the language specified by Language,
then EFI_UNSUPPORTED is returned.
- @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
+ @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
EFI_COMPONENT_NAME_PROTOCOL instance.
- @param Language[in] A pointer to a Null-terminated ASCII string
+ @param[in] Language A pointer to a Null-terminated ASCII string
array indicating the language. This is the
language of the driver name that the caller is
requesting, and it must match one of the
@@ -203,7 +196,7 @@ GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mUdpDriverNameTable[] = { to the driver writer. Language is specified
in RFC 3066 or ISO 639-2 language code format.
- @param DriverName[out] A pointer to the Unicode string to return.
+ @param[out] DriverName A pointer to the Unicode string to return.
This Unicode string is the name of the
driver specified by This in the language
specified by Language.
@@ -250,15 +243,15 @@ UdpComponentNameGetDriverName ( then EFI_UNSUPPORTED is returned. If the driver specified by This does not
support the language specified by Language, then EFI_UNSUPPORTED is returned.
- @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
+ @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
EFI_COMPONENT_NAME_PROTOCOL instance.
- @param ControllerHandle[in] The handle of a controller that the driver
+ @param[in] ControllerHandle The handle of a controller that the driver
specified by This is managing. This handle
specifies the controller whose name is to be
returned.
- @param ChildHandle[in] The handle of the child controller to retrieve
+ @param[in] ChildHandle The handle of the child controller to retrieve
the name of. This is an optional parameter that
may be NULL. It will be NULL for device
drivers. It will also be NULL for a bus drivers
@@ -267,7 +260,7 @@ UdpComponentNameGetDriverName ( driver that wishes to retrieve the name of a
child controller.
- @param Language[in] A pointer to a Null-terminated ASCII string
+ @param[in] Language A pointer to a Null-terminated ASCII string
array indicating the language. This is the
language of the driver name that the caller is
requesting, and it must match one of the
@@ -276,7 +269,7 @@ UdpComponentNameGetDriverName ( to the driver writer. Language is specified in
RFC 3066 or ISO 639-2 language code format.
- @param ControllerName[out] A pointer to the Unicode string to return.
+ @param[out] ControllerName A pointer to the Unicode string to return.
This Unicode string is the name of the
controller specified by ControllerHandle and
ChildHandle in the language specified by
diff --git a/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Driver.c b/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Driver.c index 50959671e8..c063d41b42 100644 --- a/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Driver.c +++ b/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Driver.c @@ -1,6 +1,6 @@ /** @file
-Copyright (c) 2006, Intel Corporation
+Copyright (c) 2006, Intel Corporation.<BR>
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -9,13 +9,6 @@ http://opensource.org/licenses/bsd-license.php THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-Module Name:
-
- Udp4Driver.c
-
-Abstract:
-
-
**/
@@ -44,10 +37,10 @@ EFI_SERVICE_BINDING_PROTOCOL mUdp4ServiceBinding = { follow these calling restrictions. If any other agent wishes to call
Supported() it must also follow these calling restrictions.
- @param This Protocol instance pointer.
- @param ControllerHandle Handle of device to test
- @param RemainingDevicePath Optional parameter use to pick a specific child
- device to start.
+ @param[in] This Protocol instance pointer.
+ @param[in] ControllerHandle Handle of device to test
+ @param[in] RemainingDevicePath Optional parameter use to pick a specific child
+ device to start.
@retval EFI_SUCCESS This driver supports this device
@retval EFI_ALREADY_STARTED This driver is already running on this device
@@ -103,10 +96,10 @@ Udp4DriverBindingSupported ( calling restrictions. If any other agent wishes to call Start() it
must also follow these calling restrictions.
- @param This Protocol instance pointer.
- @param ControllerHandle Handle of device to bind driver to
- @param RemainingDevicePath Optional parameter use to pick a specific child
- device to start.
+ @param[in] This Protocol instance pointer.
+ @param[in] ControllerHandle Handle of device to bind driver to
+ @param[in] RemainingDevicePath Optional parameter use to pick a specific child
+ device to start.
@retval EFI_SUCCESS This driver is added to ControllerHandle
@retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle
@@ -166,11 +159,11 @@ Udp4DriverBindingStart ( must follow these calling restrictions. If any other agent wishes
to call Stop() it must also follow these calling restrictions.
- @param This Protocol instance pointer.
- @param ControllerHandle Handle of device to stop driver on
- @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
- children is zero stop the entire bus driver.
- @param ChildHandleBuffer List of Child Handles to Stop.
+ @param[in] This Protocol instance pointer.
+ @param[in] ControllerHandle Handle of device to stop driver on
+ @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
+ children is zero stop the entire bus driver.
+ @param[in] ChildHandleBuffer List of Child Handles to Stop.
@retval EFI_SUCCESS This driver is removed ControllerHandle
@retval other This driver was not removed from this device
@@ -244,14 +237,18 @@ Udp4DriverBindingStop ( /**
- Creates a child handle with a set of I/O services.
+ Creates a child handle and installs a protocol.
+
+ The CreateChild() function installs a protocol on ChildHandle.
+ If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle.
+ If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.
- @param This Protocol instance pointer.
- @param ChildHandle Pointer to the handle of the child to create. If it is NULL,
- then a new handle is created. If it is not NULL, then the
- I/O services are added to the existing child handle.
+ @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
+ @param ChildHandle Pointer to the handle of the child to create. If it is NULL,
+ then a new handle is created. If it is a pointer to an existing UEFI handle,
+ then the protocol is added to the existing UEFI handle.
- @retval EFI_SUCCES The child handle was created with the I/O services
+ @retval EFI_SUCCES The protocol was added to ChildHandle.
@retval EFI_INVALID_PARAMETER ChildHandle is NULL.
@retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create
the child
@@ -362,17 +359,20 @@ ON_ERROR: /**
- Destroys a child handle with a set of I/O services.
+ Destroys a child handle with a protocol installed on it.
+
+ The DestroyChild() function does the opposite of CreateChild(). It removes a protocol
+ that was installed by CreateChild() from ChildHandle. If the removed protocol is the
+ last protocol on ChildHandle, then ChildHandle is destroyed.
- @param This Protocol instance pointer.
+ @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
@param ChildHandle Handle of the child to destroy
- @retval EFI_SUCCES The I/O services were removed from the child handle
- @retval EFI_UNSUPPORTED The child handle does not support the I/O services
- that are being removed.
- @retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle.
- @retval EFI_ACCESS_DENIED The child handle could not be destroyed because its
- I/O services are being used.
+ @retval EFI_SUCCES The protocol was removed from ChildHandle.
+ @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.
+ @retval EFI_INVALID_PARAMETER Child handle is not a valid UEFI Handle.
+ @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle
+ because its services are being used.
@retval other The child handle was not destroyed
**/
@@ -483,8 +483,8 @@ Udp4ServiceBindingDestroyChild ( The entry point for Udp4 driver which installs the driver binding
and component name protocol on its ImageHandle.
- @param ImageHandle The firmware allocated handle for the UEFI image.
- @param SystemTable A pointer to the EFI System Table.
+ @param[in] ImageHandle The firmware allocated handle for the UEFI image.
+ @param[in] SystemTable A pointer to the EFI System Table.
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
diff --git a/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Driver.h b/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Driver.h index 371216574a..94b3b9c165 100644 --- a/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Driver.h +++ b/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Driver.h @@ -1,6 +1,6 @@ /** @file
-Copyright (c) 2006, Intel Corporation
+Copyright (c) 2006, Intel Corporation.<BR>
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -9,13 +9,6 @@ http://opensource.org/licenses/bsd-license.php THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-Module Name:
-
- Udp4Driver.h
-
-Abstract:
-
-
**/
#ifndef _UDP4_DRIVER_H_
@@ -35,10 +28,10 @@ Abstract: follow these calling restrictions. If any other agent wishes to call
Supported() it must also follow these calling restrictions.
- @param This Protocol instance pointer.
- @param ControllerHandle Handle of device to test
- @param RemainingDevicePath Optional parameter use to pick a specific child
- device to start.
+ @param[in] This Protocol instance pointer.
+ @param[in] ControllerHandle Handle of device to test
+ @param[in] RemainingDevicePath Optional parameter use to pick a specific child
+ device to start.
@retval EFI_SUCCESS This driver supports this device
@retval EFI_ALREADY_STARTED This driver is already running on this device
@@ -61,10 +54,10 @@ Udp4DriverBindingSupported ( calling restrictions. If any other agent wishes to call Start() it
must also follow these calling restrictions.
- @param This Protocol instance pointer.
- @param ControllerHandle Handle of device to bind driver to
- @param RemainingDevicePath Optional parameter use to pick a specific child
- device to start.
+ @param[in] This Protocol instance pointer.
+ @param[in] ControllerHandle Handle of device to bind driver to
+ @param[in] RemainingDevicePath Optional parameter use to pick a specific child
+ device to start.
@retval EFI_SUCCESS This driver is added to ControllerHandle
@retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle
@@ -87,11 +80,11 @@ Udp4DriverBindingStart ( must follow these calling restrictions. If any other agent wishes
to call Stop() it must also follow these calling restrictions.
- @param This Protocol instance pointer.
- @param ControllerHandle Handle of device to stop driver on
- @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
- children is zero stop the entire bus driver.
- @param ChildHandleBuffer List of Child Handles to Stop.
+ @param[in] This Protocol instance pointer.
+ @param[in] ControllerHandle Handle of device to stop driver on
+ @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
+ children is zero stop the entire bus driver.
+ @param[in] ChildHandleBuffer List of Child Handles to Stop.
@retval EFI_SUCCESS This driver is removed ControllerHandle
@retval other This driver was not removed from this device
@@ -107,14 +100,18 @@ Udp4DriverBindingStop ( );
/**
- Creates a child handle with a set of I/O services.
+ Creates a child handle and installs a protocol.
+
+ The CreateChild() function installs a protocol on ChildHandle.
+ If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle.
+ If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.
- @param This Protocol instance pointer.
- @param ChildHandle Pointer to the handle of the child to create. If it is NULL,
- then a new handle is created. If it is not NULL, then the
- I/O services are added to the existing child handle.
+ @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
+ @param ChildHandle Pointer to the handle of the child to create. If it is NULL,
+ then a new handle is created. If it is a pointer to an existing UEFI handle,
+ then the protocol is added to the existing UEFI handle.
- @retval EFI_SUCCES The child handle was created with the I/O services
+ @retval EFI_SUCCES The protocol was added to ChildHandle.
@retval EFI_INVALID_PARAMETER ChildHandle is NULL.
@retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create
the child
@@ -129,17 +126,20 @@ Udp4ServiceBindingCreateChild ( );
/**
- Destroys a child handle with a set of I/O services.
+ Destroys a child handle with a protocol installed on it.
+
+ The DestroyChild() function does the opposite of CreateChild(). It removes a protocol
+ that was installed by CreateChild() from ChildHandle. If the removed protocol is the
+ last protocol on ChildHandle, then ChildHandle is destroyed.
- @param This Protocol instance pointer.
+ @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
@param ChildHandle Handle of the child to destroy
- @retval EFI_SUCCES The I/O services were removed from the child handle
- @retval EFI_UNSUPPORTED The child handle does not support the I/O services
- that are being removed.
- @retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle.
- @retval EFI_ACCESS_DENIED The child handle could not be destroyed because its
- I/O services are being used.
+ @retval EFI_SUCCES The protocol was removed from ChildHandle.
+ @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.
+ @retval EFI_INVALID_PARAMETER Child handle is not a valid UEFI Handle.
+ @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle
+ because its services are being used.
@retval other The child handle was not destroyed
**/
diff --git a/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Impl.c b/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Impl.c index bda2b36c31..0440f1558d 100644 --- a/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Impl.c +++ b/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Impl.c @@ -1,6 +1,7 @@ /** @file
-
-Copyright (c) 2006 - 2008, Intel Corporation
+ The implementation of the Udp4 protocol.
+
+Copyright (c) 2006 - 2008, Intel Corporation.<BR>
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -9,15 +10,6 @@ http://opensource.org/licenses/bsd-license.php THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-Module Name:
-
- Udp4Impl.c
-
-Abstract:
-
- The implementation of the Udp4 protocol.
-
-
**/
@@ -29,11 +21,9 @@ UINT16 mUdp4RandomPort; This function checks and timeouts the I/O datagrams holding by the corresponding
service context.
- @param Event The event this function registered to.
- @param Context The context data registered during the creation of
- the Event.
-
- @return None.
+ @param[in] Event The event this function registered to.
+ @param[in] Context The context data registered during the creation of
+ the Event.
**/
VOID
@@ -46,10 +36,10 @@ Udp4CheckTimeout ( /**
This function finds the udp instance by the specified <Address, Port> pair.
- @param InstanceList Pointer to the head of the list linking the udp
- instances.
- @param Address Pointer to the specified IPv4 address.
- @param Port The udp port number.
+ @param[in] InstanceList Pointer to the head of the list linking the udp
+ instances.
+ @param[in] Address Pointer to the specified IPv4 address.
+ @param[in] Port The udp port number.
@retval TRUE The specified <Address, Port> pair is found.
@retval FALSE Otherwise.
@@ -67,12 +57,10 @@ Udp4FindInstanceByPort ( interface. It's called to signal the udp TxToken when IpIo layer completes the
transmitting of the udp datagram.
- @param Status The completion status of the output udp datagram.
- @param Context Pointer to the context data.
- @param Sender Pointer to the Ip sender of the udp datagram.
- @param NotifyData Pointer to the notify data.
-
- @return None.
+ @param[in] Status The completion status of the output udp datagram.
+ @param[in] Context Pointer to the context data.
+ @param[in] Sender Pointer to the Ip sender of the udp datagram.
+ @param[in] NotifyData Pointer to the notify data.
**/
VOID
@@ -86,15 +74,13 @@ Udp4DgramSent ( /**
This function processes the received datagram passed up by the IpIo layer.
- @param Status The status of this udp datagram.
- @param IcmpError The IcmpError code, only available when Status is
+ @param[in] Status The status of this udp datagram.
+ @param[in] IcmpError The IcmpError code, only available when Status is
EFI_ICMP_ERROR.
- @param NetSession Pointer to the EFI_NET_SESSION_DATA.
- @param Packet Pointer to the NET_BUF containing the received udp
+ @param[in] NetSession Pointer to the EFI_NET_SESSION_DATA.
+ @param[in] Packet Pointer to the NET_BUF containing the received udp
datagram.
- @param Context Pointer to the context data.
-
- @return None.
+ @param[in] Context Pointer to the context data.
**/
VOID
@@ -110,9 +96,9 @@ Udp4DgramRcvd ( This function cancels the token specified by Arg in the Map. This is a callback
used by Udp4InstanceCancelToken().
- @param Map Pointer to the NET_MAP.
- @param Item Pointer to the NET_MAP_ITEM.
- @param Arg Pointer to the token to be cancelled, if NULL,
+ @param[in] Map Pointer to the NET_MAP.
+ @param[in] Item Pointer to the NET_MAP_ITEM.
+ @param[in] Arg Pointer to the token to be cancelled, if NULL,
the token specified by Item is cancelled.
@retval EFI_SUCCESS The token is cancelled if Arg is NULL or the token
@@ -132,8 +118,8 @@ Udp4CancelTokens ( /**
This function matches the received udp datagram with the Instance.
- @param Instance Pointer to the udp instance context data.
- @param Udp4Session Pointer to the EFI_UDP4_SESSION_DATA abstracted
+ @param[in] Instance Pointer to the udp instance context data.
+ @param[in] Udp4Session Pointer to the EFI_UDP4_SESSION_DATA abstracted
from the received udp datagram.
@retval TRUE The udp datagram matches the receiving requirments of the
@@ -150,10 +136,8 @@ Udp4MatchDgram ( /**
This function removes the Wrap specified by Context and release relevant resources.
- @param Event The Event this notify function registered to.
- @param Context Pointer to the context data.
-
- @return None.
+ @param[in] Event The Event this notify function registered to.
+ @param[in] Context Pointer to the context data.
**/
VOID
@@ -166,11 +150,11 @@ Udp4RecycleRxDataWrap ( /**
This function wraps the Packet and the RxData.
- @param Instance Pointer to the instance context data.
- @param Packet Pointer to the buffer containing the received
- datagram.
- @param RxData Pointer to the EFI_UDP4_RECEIVE_DATA of this
- datagram.
+ @param[in] Instance Pointer to the instance context data.
+ @param[in] Packet Pointer to the buffer containing the received
+ datagram.
+ @param[in] RxData Pointer to the EFI_UDP4_RECEIVE_DATA of this
+ datagram.
@return Pointer to the structure wrapping the RxData and the Packet.
@@ -185,11 +169,11 @@ Udp4WrapRxData ( /**
This function enqueues the received datagram into the instances' receiving queues.
- @param Udp4Service Pointer to the udp service context data.
- @param Packet Pointer to the buffer containing the received
- datagram.
- @param RxData Pointer to the EFI_UDP4_RECEIVE_DATA of this
- datagram.
+ @param[in] Udp4Service Pointer to the udp service context data.
+ @param[in] Packet Pointer to the buffer containing the received
+ datagram.
+ @param[in] RxData Pointer to the EFI_UDP4_RECEIVE_DATA of this
+ datagram.
@return The times this datagram is enqueued.
@@ -204,9 +188,7 @@ Udp4EnqueueDgram ( /**
This function delivers the datagrams enqueued in the instances.
- @param Udp4Service Pointer to the udp service context data.
-
- @return None.
+ @param[in] Udp4Service Pointer to the udp service context data.
**/
VOID
@@ -217,13 +199,11 @@ Udp4DeliverDgram ( /**
This function demultiplexes the received udp datagram to the apropriate instances.
- @param Udp4Service Pointer to the udp service context data.
- @param NetSession Pointer to the EFI_NET_SESSION_DATA abstrated from
- the received datagram.
- @param Packet Pointer to the buffer containing the received udp
- datagram.
-
- @return None.
+ @param[in] Udp4Service Pointer to the udp service context data.
+ @param[in] NetSession Pointer to the EFI_NET_SESSION_DATA abstrated from
+ the received datagram.
+ @param[in] Packet Pointer to the buffer containing the received udp
+ datagram.
**/
VOID
@@ -237,13 +217,11 @@ Udp4Demultiplex ( This function handles the received Icmp Error message and demultiplexes it to the
instance.
- @param Udp4Service Pointer to the udp service context data.
- @param IcmpError The icmp error code.
- @param NetSession Pointer to the EFI_NET_SESSION_DATA abstracted
+ @param[in] Udp4Service Pointer to the udp service context data.
+ @param[in] IcmpError The icmp error code.
+ @param[in] NetSession Pointer to the EFI_NET_SESSION_DATA abstracted
from the received Icmp Error packet.
- @param Packet Pointer to the Icmp Error packet.
-
- @return None.
+ @param[in] Packet Pointer to the Icmp Error packet.
**/
VOID
@@ -257,13 +235,11 @@ Udp4IcmpHandler ( /**
This function builds and sends out a icmp port unreachable message.
- @param IpIo Pointer to the IP_IO instance.
- @param NetSession Pointer to the EFI_NET_SESSION_DATA of the packet
- causes this icmp error message.
- @param Udp4Header Pointer to the udp header of the datagram causes
- this icmp error message.
-
- @return None.
+ @param[in] IpIo Pointer to the IP_IO instance.
+ @param[in] NetSession Pointer to the EFI_NET_SESSION_DATA of the packet
+ causes this icmp error message.
+ @param[in] Udp4Header Pointer to the udp header of the datagram causes
+ this icmp error message.
**/
VOID
@@ -376,9 +352,7 @@ ON_ERROR: /**
Clean the Udp service context data.
- @param Udp4Service Pointer to the UDP4_SERVICE_DATA.
-
- @return None.
+ @param[in] Udp4Service Pointer to the UDP4_SERVICE_DATA.
**/
VOID
@@ -407,11 +381,9 @@ Udp4CleanService ( This function checks and timeouts the I/O datagrams holding by the corresponding
service context.
- @param Event The event this function registered to.
- @param Context The context data registered during the creation of
- the Event.
-
- @return None.
+ @param[in] Event The event this function registered to.
+ @param[in] Context The context data registered during the creation of
+ the Event.
**/
VOID
@@ -473,8 +445,6 @@ Udp4CheckTimeout ( @param Udp4Service Pointer to the UDP4_SERVICE_DATA.
@param Instance Pointer to the un-initialized UDP4_INSTANCE_DATA.
- @return None.
-
**/
VOID
Udp4InitInstance (
@@ -516,9 +486,7 @@ Udp4InitInstance ( /**
This function cleans the udp instance.
- @param Instance Pointer to the UDP4_INSTANCE_DATA to clean.
-
- @return None.
+ @param[in] Instance Pointer to the UDP4_INSTANCE_DATA to clean.
**/
VOID
@@ -535,10 +503,10 @@ Udp4CleanInstance ( /**
This function finds the udp instance by the specified <Address, Port> pair.
- @param InstanceList Pointer to the head of the list linking the udp
- instances.
- @param Address Pointer to the specified IPv4 address.
- @param Port The udp port number.
+ @param[in] InstanceList Pointer to the head of the list linking the udp
+ instances.
+ @param[in] Address Pointer to the specified IPv4 address.
+ @param[in] Port The udp port number.
@retval TRUE The specified <Address, Port> pair is found.
@retval FALSE Otherwise.
@@ -672,9 +640,9 @@ Udp4Bind ( This function is used to check whether the NewConfigData has any un-reconfigurable
parameters changed compared to the OldConfigData.
- @param OldConfigData Pointer to the current ConfigData the udp instance
+ @param[in] OldConfigData Pointer to the current ConfigData the udp instance
uses.
- @param NewConfigData Pointer to the new ConfigData.
+ @param[in] NewConfigData Pointer to the new ConfigData.
@retval TRUE The instance is reconfigurable.
@retval FALSE Otherwise.
@@ -753,10 +721,8 @@ Udp4IsReconfigurable ( /**
This function builds the Ip4 configdata from the Udp4ConfigData.
- @param Udp4ConfigData Pointer to the EFI_UDP4_CONFIG_DATA.
- @param Ip4ConfigData Pointer to the EFI_IP4_CONFIG_DATA.
-
- @return None.
+ @param[in] Udp4ConfigData Pointer to the EFI_UDP4_CONFIG_DATA.
+ @param[in, out] Ip4ConfigData Pointer to the EFI_IP4_CONFIG_DATA.
**/
VOID
@@ -784,8 +750,8 @@ Udp4BuildIp4ConfigData ( /**
This function validates the TxToken, it returns the error code according to the spec.
- @param Instance Pointer to the udp instance context data.
- @param TxToken Pointer to the token to be checked.
+ @param[in] Instance Pointer to the udp instance context data.
+ @param[in] TxToken Pointer to the token to be checked.
@retval EFI_SUCCESS The TxToken is valid.
@retval EFI_INVALID_PARAMETER One or more of the following are TRUE: This is
@@ -911,10 +877,10 @@ Udp4ValidateTxToken ( /**
This function checks whether the specified Token duplicates with the one in the Map.
- @param Map Pointer to the NET_MAP.
- @param Item Pointer to the NET_MAP_ITEM contain the pointer to
+ @param[in] Map Pointer to the NET_MAP.
+ @param[in] Item Pointer to the NET_MAP_ITEM contain the pointer to
the Token.
- @param Context Pointer to the Token to be checked.
+ @param[in] Context Pointer to the Token to be checked.
@retval EFI_SUCCESS The Token specified by Context differs from the
one in the Item.
@@ -950,11 +916,11 @@ Udp4TokenExist ( This function calculates the checksum for the Packet, utilizing the pre-calculated
pseudo HeadSum to reduce some overhead.
- @param Packet Pointer to the NET_BUF contains the udp datagram.
- @param HeadSum Checksum of the pseudo header execpt the length
+ @param[in] Packet Pointer to the NET_BUF contains the udp datagram.
+ @param[in] HeadSum Checksum of the pseudo header execpt the length
field.
- @return The 16-bit checksum of this udp datagram.
+ @retval The 16-bit checksum of this udp datagram.
**/
UINT16
@@ -977,8 +943,8 @@ Udp4Checksum ( /**
This function removes the specified Token from the TokenMap.
- @param TokenMap Pointer to the NET_MAP containing the tokens.
- @param Token Pointer to the Token to be removed.
+ @param TokenMap Pointer to the NET_MAP containing the tokens.
+ @param Token Pointer to the Token to be removed.
@retval EFI_SUCCESS The specified Token is removed from the TokenMap.
@retval EFI_NOT_FOUND The specified Token is not found in the TokenMap.
@@ -1015,12 +981,10 @@ Udp4RemoveToken ( interface. It's called to signal the udp TxToken when IpIo layer completes the
transmitting of the udp datagram.
- @param Status The completion status of the output udp datagram.
- @param Context Pointer to the context data.
- @param Sender Pointer to the Ip sender of the udp datagram.
- @param NotifyData Pointer to the notify data.
-
- @return None.
+ @param[in] Status The completion status of the output udp datagram.
+ @param[in] Context Pointer to the context data.
+ @param[in] Sender Pointer to the Ip sender of the udp datagram.
+ @param[in] NotifyData Pointer to the notify data.
**/
VOID
@@ -1051,15 +1015,13 @@ Udp4DgramSent ( /**
This function processes the received datagram passed up by the IpIo layer.
- @param Status The status of this udp datagram.
- @param IcmpError The IcmpError code, only available when Status is
+ @param[in] Status The status of this udp datagram.
+ @param[in] IcmpError The IcmpError code, only available when Status is
EFI_ICMP_ERROR.
- @param NetSession Pointer to the EFI_NET_SESSION_DATA.
- @param Packet Pointer to the NET_BUF containing the received udp
+ @param[in] NetSession Pointer to the EFI_NET_SESSION_DATA.
+ @param[in] Packet Pointer to the NET_BUF containing the received udp
datagram.
- @param Context Pointer to the context data.
-
- @return None.
+ @param[in] Context Pointer to the context data.
**/
VOID
@@ -1148,9 +1110,9 @@ Udp4LeaveGroup ( This function cancels the token specified by Arg in the Map. This is a callback
used by Udp4InstanceCancelToken().
- @param Map Pointer to the NET_MAP.
- @param Item Pointer to the NET_MAP_ITEM.
- @param Arg Pointer to the token to be cancelled, if NULL,
+ @param[in] Map Pointer to the NET_MAP.
+ @param[in] Item Pointer to the NET_MAP_ITEM.
+ @param[in] Arg Pointer to the token to be cancelled, if NULL,
the token specified by Item is cancelled.
@retval EFI_SUCCESS The token is cancelled if Arg is NULL or the token
@@ -1208,9 +1170,7 @@ Udp4CancelTokens ( /**
This function removes all the Wrap datas in the RcvdDgramQue.
- @param Instance Pointer to the udp instance context data.
-
- @return None.
+ @param[in] Instance Pointer to the udp instance context data.
**/
VOID
@@ -1238,8 +1198,8 @@ Udp4FlushRcvdDgram ( /**
Cancel Udp4 tokens from the Udp4 instance.
- @param Instance Pointer to the udp instance context data.
- @param Token Pointer to the token to be canceled, if NULL, all
+ @param[in] Instance Pointer to the udp instance context data.
+ @param[in] Token Pointer to the token to be canceled, if NULL, all
tokens in this instance will be cancelled.
@retval EFI_SUCCESS The Token is cancelled.
@@ -1291,8 +1251,8 @@ Udp4InstanceCancelToken ( /**
This function matches the received udp datagram with the Instance.
- @param Instance Pointer to the udp instance context data.
- @param Udp4Session Pointer to the EFI_UDP4_SESSION_DATA abstracted
+ @param[in] Instance Pointer to the udp instance context data.
+ @param[in] Udp4Session Pointer to the EFI_UDP4_SESSION_DATA abstracted
from the received udp datagram.
@retval TRUE The udp datagram matches the receiving requirments of the
@@ -1371,10 +1331,8 @@ Udp4MatchDgram ( /**
This function removes the Wrap specified by Context and release relevant resources.
- @param Event The Event this notify function registered to.
- @param Context Pointer to the context data.
-
- @return None.
+ @param[in] Event The Event this notify function registered to.
+ @param[in] Context Pointer to the context data.
**/
VOID
@@ -1410,11 +1368,11 @@ Udp4RecycleRxDataWrap ( /**
This function wraps the Packet and the RxData.
- @param Instance Pointer to the instance context data.
- @param Packet Pointer to the buffer containing the received
- datagram.
- @param RxData Pointer to the EFI_UDP4_RECEIVE_DATA of this
- datagram.
+ @param[in] Instance Pointer to the instance context data.
+ @param[in] Packet Pointer to the buffer containing the received
+ datagram.
+ @param[in] RxData Pointer to the EFI_UDP4_RECEIVE_DATA of this
+ datagram.
@return Pointer to the structure wrapping the RxData and the Packet.
@@ -1467,11 +1425,11 @@ Udp4WrapRxData ( /**
This function enqueues the received datagram into the instances' receiving queues.
- @param Udp4Service Pointer to the udp service context data.
- @param Packet Pointer to the buffer containing the received
- datagram.
- @param RxData Pointer to the EFI_UDP4_RECEIVE_DATA of this
- datagram.
+ @param[in] Udp4Service Pointer to the udp service context data.
+ @param[in] Packet Pointer to the buffer containing the received
+ datagram.
+ @param[in] RxData Pointer to the EFI_UDP4_RECEIVE_DATA of this
+ datagram.
@return The times this datagram is enqueued.
@@ -1524,9 +1482,7 @@ Udp4EnqueueDgram ( /**
This function delivers the received datagrams for the specified instance.
- @param Instance Pointer to the instance context data.
-
- @return None.
+ @param[in] Instance Pointer to the instance context data.
**/
VOID
@@ -1590,9 +1546,7 @@ Udp4InstanceDeliverDgram ( /**
This function delivers the datagrams enqueued in the instances.
- @param Udp4Service Pointer to the udp service context data.
-
- @return None.
+ @param[in] Udp4Service Pointer to the udp service context data.
**/
VOID
@@ -1624,13 +1578,11 @@ Udp4DeliverDgram ( /**
This function demultiplexes the received udp datagram to the apropriate instances.
- @param Udp4Service Pointer to the udp service context data.
- @param NetSession Pointer to the EFI_NET_SESSION_DATA abstrated from
- the received datagram.
- @param Packet Pointer to the buffer containing the received udp
- datagram.
-
- @return None.
+ @param[in] Udp4Service Pointer to the udp service context data.
+ @param[in] NetSession Pointer to the EFI_NET_SESSION_DATA abstrated from
+ the received datagram.
+ @param[in] Packet Pointer to the buffer containing the received udp
+ datagram.
**/
VOID
@@ -1715,13 +1667,11 @@ Udp4Demultiplex ( /**
This function builds and sends out a icmp port unreachable message.
- @param IpIo Pointer to the IP_IO instance.
- @param NetSession Pointer to the EFI_NET_SESSION_DATA of the packet
- causes this icmp error message.
- @param Udp4Header Pointer to the udp header of the datagram causes
- this icmp error message.
-
- @return None.
+ @param[in] IpIo Pointer to the IP_IO instance.
+ @param[in] NetSession Pointer to the EFI_NET_SESSION_DATA of the packet
+ causes this icmp error message.
+ @param[in] Udp4Header Pointer to the udp header of the datagram causes
+ this icmp error message.
**/
VOID
@@ -1817,13 +1767,11 @@ Udp4SendPortUnreach ( This function handles the received Icmp Error message and demultiplexes it to the
instance.
- @param Udp4Service Pointer to the udp service context data.
- @param IcmpError The icmp error code.
- @param NetSession Pointer to the EFI_NET_SESSION_DATA abstracted
+ @param[in] Udp4Service Pointer to the udp service context data.
+ @param[in] IcmpError The icmp error code.
+ @param[in] NetSession Pointer to the EFI_NET_SESSION_DATA abstracted
from the received Icmp Error packet.
- @param Packet Pointer to the Icmp Error packet.
-
- @return None.
+ @param[in] Packet Pointer to the Icmp Error packet.
**/
VOID
@@ -1892,9 +1840,7 @@ Udp4IcmpHandler ( /**
This function reports the received ICMP error.
- @param Instance Pointer to the udp instance context data.
-
- @return None.
+ @param[in] Instance Pointer to the udp instance context data.
**/
VOID
@@ -1937,9 +1883,7 @@ Udp4ReportIcmpError ( This function is a dummy ext-free function for the NET_BUF created for the output
udp datagram.
- @param Context Pointer to the context data.
-
- @return None.
+ @param[in] Context Pointer to the context data.
**/
VOID
@@ -2089,9 +2033,7 @@ ON_ERROR: /**
Clear the variable and free the resource.
- @param Udp4Service Udp4 service data.
-
- @return None.
+ @param[[in] Udp4Service Udp4 service data.
**/
VOID
diff --git a/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Impl.h b/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Impl.h index 23b07a6d35..986768344c 100644 --- a/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Impl.h +++ b/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Impl.h @@ -1,6 +1,7 @@ /** @file
-
-Copyright (c) 2006 - 2007, Intel Corporation
+ EFI UDPv4 protocol implementation.
+
+Copyright (c) 2006 - 2007, Intel Corporation.<BR>
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -9,15 +10,6 @@ http://opensource.org/licenses/bsd-license.php THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-Module Name:
-
- Udp4Impl.h
-
-Abstract:
-
- EFI UDPv4 protocol implementation
-
-
**/
#ifndef _UDP4_IMPL_H_
@@ -171,8 +163,8 @@ Udp4GetModeData ( With different parameters in UdpConfigData, Configure() can be used to bind
this instance to specified port.
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.
- @param UdpConfigData Pointer to the buffer to receive the current configuration data.
+ @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance.
+ @param[in] UdpConfigData Pointer to the buffer to receive the current configuration data.
@retval EFI_SUCCESS The configuration settings were set, changed, or reset successfully.
@retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,
@@ -203,10 +195,10 @@ Udp4Configure ( filtering. If the JoinFlag is FALSE and the MulticastAddress is NULL, then all
currently joined groups are left.
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.
- @param JoinFlag Set to TRUE to join a multicast group. Set to FALSE to leave one
- or all multicast groups.
- @param MulticastAddress Pointer to multicast group address to join or leave.
+ @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance.
+ @param[in] JoinFlag Set to TRUE to join a multicast group. Set to FALSE to leave one
+ or all multicast groups.
+ @param[in] MulticastAddress Pointer to multicast group address to join or leave.
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_NOT_STARTED The EFI UDPv4 Protocol instance has not been started.
@@ -254,12 +246,12 @@ Udp4Groups ( copies will be updated automatically whenever the IP driver reconfigures its
instances; as a result, the previous modification to these copies will be lost.
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.
- @param DeleteRoute Set to TRUE to delete this route from the routing table.
- Set to FALSE to add this route to the routing table.
- @param SubnetAddress The destination network address that needs to be routed.
- @param SubnetMask The subnet mask of SubnetAddress.
- @param GatewayAddress The gateway IP address for this route.
+ @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance.
+ @param[in] DeleteRoute Set to TRUE to delete this route from the routing table.
+ Set to FALSE to add this route to the routing table.
+ @param[in] SubnetAddress The destination network address that needs to be routed.
+ @param[in] SubnetMask The subnet mask of SubnetAddress.
+ @param[in] GatewayAddress The gateway IP address for this route.
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_NOT_STARTED The EFI UDPv4 Protocol instance has not been started.
@@ -291,9 +283,9 @@ Udp4Routes ( and context for the event will enable the user to receive the notification and
transmitting status.
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.
- @param Token Pointer to the completion token that will be placed into the
- transmit queue.
+ @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance.
+ @param[in] Token Pointer to the completion token that will be placed into the
+ transmit queue.
@retval EFI_SUCCESS The data has been queued for transmission.
@retval EFI_NOT_STARTED This EFI UDPv4 Protocol instance has not been started.
@@ -330,9 +322,9 @@ Udp4Transmit ( will enable the user to receive the notification and receiving status. That
notification function is guaranteed to not be re-entered.
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.
- @param Token Pointer to a token that is associated with the receive data
- descriptor.
+ @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance.
+ @param[in] Token Pointer to a token that is associated with
+ the receive data descriptor.
@retval EFI_SUCCESS The receive completion token was cached.
@retval EFI_NOT_STARTED This EFI UDPv4 Protocol instance has not been started.
@@ -364,11 +356,11 @@ Udp4Receive ( the asynchronous operation has completed, this function will not signal the
token and EFI_NOT_FOUND is returned.
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.
- @param Token Pointer to a token that has been issued by
- EFI_UDP4_PROTOCOL.Transmit() or
- EFI_UDP4_PROTOCOL.Receive().If NULL, all pending
- tokens are aborted.
+ @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance.
+ @param[in] Token Pointer to a token that has been issued by
+ EFI_UDP4_PROTOCOL.Transmit() or
+ EFI_UDP4_PROTOCOL.Receive().If NULL, all pending
+ tokens are aborted.
@retval EFI_SUCCESS The asynchronous I/O request was aborted and Token.Event
was signaled. When Token is NULL, all pending requests are
@@ -401,7 +393,7 @@ Udp4Cancel ( Drivers and applications that are experiencing packet loss should try calling
the Poll() function more often.
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.
+ @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance.
@retval EFI_SUCCESS Incoming or outgoing data was processed.
@retval EFI_INVALID_PARAMETER This is NULL.
@@ -438,9 +430,7 @@ Udp4CreateService ( /**
Clean the Udp service context data.
- @param Udp4Service Pointer to the UDP4_SERVICE_DATA.
-
- @return None.
+ @param[in] Udp4Service Pointer to the UDP4_SERVICE_DATA.
**/
VOID
@@ -454,8 +444,6 @@ Udp4CleanService ( @param Udp4Service Pointer to the UDP4_SERVICE_DATA.
@param Instance Pointer to the un-initialized UDP4_INSTANCE_DATA.
- @return None.
-
**/
VOID
Udp4InitInstance (
@@ -466,9 +454,7 @@ Udp4InitInstance ( /**
This function cleans the udp instance.
- @param Instance Pointer to the UDP4_INSTANCE_DATA to clean.
-
- @return None.
+ @param[in] Instance Pointer to the UDP4_INSTANCE_DATA to clean.
**/
VOID
@@ -502,9 +488,9 @@ Udp4Bind ( This function is used to check whether the NewConfigData has any un-reconfigurable
parameters changed compared to the OldConfigData.
- @param OldConfigData Pointer to the current ConfigData the udp instance
+ @param[in] OldConfigData Pointer to the current ConfigData the udp instance
uses.
- @param NewConfigData Pointer to the new ConfigData.
+ @param[in] NewConfigData Pointer to the new ConfigData.
@retval TRUE The instance is reconfigurable.
@retval FALSE Otherwise.
@@ -519,10 +505,8 @@ Udp4IsReconfigurable ( /**
This function builds the Ip4 configdata from the Udp4ConfigData.
- @param Udp4ConfigData Pointer to the EFI_UDP4_CONFIG_DATA.
- @param Ip4ConfigData Pointer to the EFI_IP4_CONFIG_DATA.
-
- @return None.
+ @param[in] Udp4ConfigData Pointer to the EFI_UDP4_CONFIG_DATA.
+ @param[in, out] Ip4ConfigData Pointer to the EFI_IP4_CONFIG_DATA.
**/
VOID
@@ -534,8 +518,8 @@ Udp4BuildIp4ConfigData ( /**
This function validates the TxToken, it returns the error code according to the spec.
- @param Instance Pointer to the udp instance context data.
- @param TxToken Pointer to the token to be checked.
+ @param[in] Instance Pointer to the udp instance context data.
+ @param[in] TxToken Pointer to the token to be checked.
@retval EFI_SUCCESS The TxToken is valid.
@retval EFI_INVALID_PARAMETER One or more of the following are TRUE: This is
@@ -566,10 +550,10 @@ Udp4ValidateTxToken ( /**
This function checks whether the specified Token duplicates with the one in the Map.
- @param Map Pointer to the NET_MAP.
- @param Item Pointer to the NET_MAP_ITEM contain the pointer to
+ @param[in] Map Pointer to the NET_MAP.
+ @param[in] Item Pointer to the NET_MAP_ITEM contain the pointer to
the Token.
- @param Context Pointer to the Token to be checked.
+ @param[in] Context Pointer to the Token to be checked.
@retval EFI_SUCCESS The Token specified by Context differs from the
one in the Item.
@@ -587,11 +571,11 @@ Udp4TokenExist ( This function calculates the checksum for the Packet, utilizing the pre-calculated
pseudo HeadSum to reduce some overhead.
- @param Packet Pointer to the NET_BUF contains the udp datagram.
- @param HeadSum Checksum of the pseudo header execpt the length
+ @param[in] Packet Pointer to the NET_BUF contains the udp datagram.
+ @param[in] HeadSum Checksum of the pseudo header execpt the length
field.
- @return The 16-bit checksum of this udp datagram.
+ @retval The 16-bit checksum of this udp datagram.
**/
UINT16
@@ -603,8 +587,8 @@ Udp4Checksum ( /**
This function removes the specified Token from the TokenMap.
- @param TokenMap Pointer to the NET_MAP containing the tokens.
- @param Token Pointer to the Token to be removed.
+ @param TokenMap Pointer to the NET_MAP containing the tokens.
+ @param Token Pointer to the Token to be removed.
@retval EFI_SUCCESS The specified Token is removed from the TokenMap.
@retval EFI_NOT_FOUND The specified Token is not found in the TokenMap.
@@ -639,9 +623,7 @@ Udp4LeaveGroup ( /**
This function removes all the Wrap datas in the RcvdDgramQue.
- @param Instance Pointer to the udp instance context data.
-
- @return None.
+ @param[in] Instance Pointer to the udp instance context data.
**/
VOID
@@ -652,8 +634,8 @@ Udp4FlushRcvdDgram ( /**
Cancel Udp4 tokens from the Udp4 instance.
- @param Instance Pointer to the udp instance context data.
- @param Token Pointer to the token to be canceled, if NULL, all
+ @param[in] Instance Pointer to the udp instance context data.
+ @param[in] Token Pointer to the token to be canceled, if NULL, all
tokens in this instance will be cancelled.
@retval EFI_SUCCESS The Token is cancelled.
@@ -669,9 +651,7 @@ Udp4InstanceCancelToken ( /**
This function delivers the received datagrams for the specified instance.
- @param Instance Pointer to the instance context data.
-
- @return None.
+ @param[in] Instance Pointer to the instance context data.
**/
VOID
@@ -682,9 +662,7 @@ Udp4InstanceDeliverDgram ( /**
This function reports the received ICMP error.
- @param Instance Pointer to the udp instance context data.
-
- @return None.
+ @param[in] Instance Pointer to the udp instance context data.
**/
VOID
@@ -696,9 +674,7 @@ Udp4ReportIcmpError ( This function is a dummy ext-free function for the NET_BUF created for the output
udp datagram.
- @param Context Pointer to the context data.
-
- @return None.
+ @param[in] Context Pointer to the context data.
**/
VOID
@@ -725,9 +701,7 @@ Udp4SetVariableData ( /**
Clear the variable and free the resource.
- @param Udp4Service Udp4 service data.
-
- @return None.
+ @param[[in] Udp4Service Udp4 service data.
**/
VOID
diff --git a/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Main.c b/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Main.c index d46a0de20e..a787ec440f 100644 --- a/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Main.c +++ b/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Main.c @@ -1,6 +1,6 @@ /** @file
-Copyright (c) 2006 - 2007, Intel Corporation
+Copyright (c) 2006 - 2007, Intel Corporation.<BR>
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -9,13 +9,6 @@ http://opensource.org/licenses/bsd-license.php THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-Module Name:
-
- Udp4Main.c
-
-Abstract:
-
-
**/
#include "Udp4Impl.h"
@@ -114,8 +107,8 @@ Udp4GetModeData ( With different parameters in UdpConfigData, Configure() can be used to bind
this instance to specified port.
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.
- @param UdpConfigData Pointer to the buffer to receive the current configuration data.
+ @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance.
+ @param[in] UdpConfigData Pointer to the buffer to receive the current configuration data.
@retval EFI_SUCCESS The configuration settings were set, changed, or reset successfully.
@retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,
@@ -305,10 +298,10 @@ ON_EXIT: filtering. If the JoinFlag is FALSE and the MulticastAddress is NULL, then all
currently joined groups are left.
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.
- @param JoinFlag Set to TRUE to join a multicast group. Set to FALSE to leave one
- or all multicast groups.
- @param MulticastAddress Pointer to multicast group address to join or leave.
+ @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance.
+ @param[in] JoinFlag Set to TRUE to join a multicast group. Set to FALSE to leave one
+ or all multicast groups.
+ @param[in] MulticastAddress Pointer to multicast group address to join or leave.
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_NOT_STARTED The EFI UDPv4 Protocol instance has not been started.
@@ -420,12 +413,12 @@ ON_EXIT: copies will be updated automatically whenever the IP driver reconfigures its
instances; as a result, the previous modification to these copies will be lost.
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.
- @param DeleteRoute Set to TRUE to delete this route from the routing table.
- Set to FALSE to add this route to the routing table.
- @param SubnetAddress The destination network address that needs to be routed.
- @param SubnetMask The subnet mask of SubnetAddress.
- @param GatewayAddress The gateway IP address for this route.
+ @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance.
+ @param[in] DeleteRoute Set to TRUE to delete this route from the routing table.
+ Set to FALSE to add this route to the routing table.
+ @param[in] SubnetAddress The destination network address that needs to be routed.
+ @param[in] SubnetMask The subnet mask of SubnetAddress.
+ @param[in] GatewayAddress The gateway IP address for this route.
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_NOT_STARTED The EFI UDPv4 Protocol instance has not been started.
@@ -483,9 +476,9 @@ Udp4Routes ( and context for the event will enable the user to receive the notification and
transmitting status.
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.
- @param Token Pointer to the completion token that will be placed into the
- transmit queue.
+ @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance.
+ @param[in] Token Pointer to the completion token that will be placed into the
+ transmit queue.
@retval EFI_SUCCESS The data has been queued for transmission.
@retval EFI_NOT_STARTED This EFI UDPv4 Protocol instance has not been started.
@@ -710,9 +703,9 @@ ON_EXIT: will enable the user to receive the notification and receiving status. That
notification function is guaranteed to not be re-entered.
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.
- @param Token Pointer to a token that is associated with the receive data
- descriptor.
+ @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance.
+ @param[in] Token Pointer to a token that is associated with
+ the receive data descriptor.
@retval EFI_SUCCESS The receive completion token was cached.
@retval EFI_NOT_STARTED This EFI UDPv4 Protocol instance has not been started.
@@ -808,11 +801,11 @@ ON_EXIT: the asynchronous operation has completed, this function will not signal the
token and EFI_NOT_FOUND is returned.
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.
- @param Token Pointer to a token that has been issued by
- EFI_UDP4_PROTOCOL.Transmit() or
- EFI_UDP4_PROTOCOL.Receive().If NULL, all pending
- tokens are aborted.
+ @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance.
+ @param[in] Token Pointer to a token that has been issued by
+ EFI_UDP4_PROTOCOL.Transmit() or
+ EFI_UDP4_PROTOCOL.Receive().If NULL, all pending
+ tokens are aborted.
@retval EFI_SUCCESS The asynchronous I/O request was aborted and Token.Event
was signaled. When Token is NULL, all pending requests are
@@ -881,7 +874,7 @@ Udp4Cancel ( Drivers and applications that are experiencing packet loss should try calling
the Poll() function more often.
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.
+ @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance.
@retval EFI_SUCCESS Incoming or outgoing data was processed.
@retval EFI_INVALID_PARAMETER This is NULL.
|