tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Refine the functions headers. 

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9576 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
vanjeff 2009-12-17 08:05:03 +00:00
parent d64527e50d
commit 47c75f64ae
5 changed files with 56 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Driver.c
View File

@ -243,10 +243,10 @@ Udp4DriverBindingStop (
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 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.
@param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
@param[in] 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 protocol was added to ChildHandle.
@retval EFI_INVALID_PARAMETER ChildHandle is NULL.
@ -365,8 +365,8 @@ ON_ERROR:
that was installed by CreateChild() from ChildHandle. If the removed protocol is the
last protocol on ChildHandle, then ChildHandle is destroyed.
@param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
@param ChildHandle Handle of the child to destroy
@param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
@param[in] ChildHandle Handle of the child to destroy
@retval EFI_SUCCES The protocol was removed from ChildHandle.
@retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.

12
MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Driver.h
View File

@ -106,10 +106,10 @@ Udp4DriverBindingStop (
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 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.
@param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
@param[in] 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 protocol was added to ChildHandle.
@retval EFI_INVALID_PARAMETER ChildHandle is NULL.
@ -132,8 +132,8 @@ Udp4ServiceBindingCreateChild (
that was installed by CreateChild() from ChildHandle. If the removed protocol is the
last protocol on ChildHandle, then ChildHandle is destroyed.
@param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
@param ChildHandle Handle of the child to destroy
@param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
@param[in] ChildHandle Handle of the child to destroy
@retval EFI_SUCCES The protocol was removed from ChildHandle.
@retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.

34
MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Impl.c
View File

@ -253,14 +253,14 @@ Udp4SendPortUnreach (
/**
Create the Udp service context data.
@param Udp4Service Pointer to the UDP4_SERVICE_DATA.
@param ImageHandle The image handle of this udp4 driver.
@param ControllerHandle The controller handle this udp4 driver binds on.
@param[in, out] Udp4Service Pointer to the UDP4_SERVICE_DATA.
@param[in] ImageHandle The image handle of this udp4 driver.
@param[in] ControllerHandle The controller handle this udp4 driver binds on.
@retval EFI_SUCCESS The udp4 service context data is created and
initialized.
@retval EFI_OUT_OF_RESOURCES Cannot allocate memory.
@retval other Other error occurs.
@retval EFI_SUCCESS The udp4 service context data is created and
initialized.
@retval EFI_OUT_OF_RESOURCES Cannot allocate memory.
@retval other Other error occurs.
**/
EFI_STATUS
@ -444,8 +444,8 @@ Udp4CheckTimeout (
/**
This function intializes the new created udp instance.
@param Udp4Service Pointer to the UDP4_SERVICE_DATA.
@param Instance Pointer to the un-initialized UDP4_INSTANCE_DATA.
@param[in] Udp4Service Pointer to the UDP4_SERVICE_DATA.
@param[in, out] Instance Pointer to the un-initialized UDP4_INSTANCE_DATA.
**/
VOID
@ -560,9 +560,9 @@ Udp4FindInstanceByPort (
This function tries to bind the udp instance according to the configured port
allocation strategy.
@param InstanceList Pointer to the head of the list linking the udp
@param[in] InstanceList Pointer to the head of the list linking the udp
instances.
@param ConfigData Pointer to the ConfigData of the instance to be
@param[in, out] ConfigData Pointer to the ConfigData of the instance to be
bound. ConfigData->StationPort will be assigned
with an available port value on success.
@ -945,8 +945,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[in, out] TokenMap Pointer to the NET_MAP containing the tokens.
@param[in] 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.
@ -1063,9 +1063,9 @@ Udp4DgramRcvd (
/**
This function removes the multicast group specified by Arg from the Map.
@param Map Pointer to the NET_MAP.
@param Item Pointer to the NET_MAP_ITEM.
@param Arg Pointer to the Arg, it's the pointer to a
@param[in, out] Map Pointer to the NET_MAP.
@param[in] Item Pointer to the NET_MAP_ITEM.
@param[in] Arg Pointer to the Arg, it's the pointer to a
multicast IPv4 Address.
@retval EFI_SUCCESS The multicast address is removed.
@ -1900,7 +1900,7 @@ Udp4NetVectorExtFree (
/**
Set the Udp4 variable data.
@param Udp4Service Udp4 service data.
@param[in] Udp4Service Udp4 service data.
@retval EFI_OUT_OF_RESOURCES There are not enough resources to set the
variable.

44
MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Impl.h
View File

@ -127,11 +127,11 @@ typedef struct _UDP4_RXDATA_WRAP_ {
optionally to retrieve the operational mode data of underlying networks or
drivers.
@param This Pointer to the EFI_UDP4_PROTOCOL instance.
@param Udp4ConfigData Pointer to the buffer to receive the current configuration data.
@param Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure.
@param MnpConfigData Pointer to the managed network configuration data structure.
@param SnpModeData Pointer to the simple network mode data structure.
@param[in] This Pointer to the EFI_UDP4_PROTOCOL instance.
@param[out] Udp4ConfigData Pointer to the buffer to receive the current configuration data.
@param[out] Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure.
@param[out] MnpConfigData Pointer to the managed network configuration data structure.
@param[out] SnpModeData Pointer to the simple network mode data structure.
@retval EFI_SUCCESS The mode data was read.
@retval EFI_NOT_STARTED When Udp4ConfigData is queried, no configuration data is
@ -411,14 +411,14 @@ Udp4Poll (
/**
Create the Udp service context data.
@param Udp4Service Pointer to the UDP4_SERVICE_DATA.
@param ImageHandle The image handle of this udp4 driver.
@param ControllerHandle The controller handle this udp4 driver binds on.
@param[in, out] Udp4Service Pointer to the UDP4_SERVICE_DATA.
@param[in] ImageHandle The image handle of this udp4 driver.
@param[in] ControllerHandle The controller handle this udp4 driver binds on.
@retval EFI_SUCCESS The udp4 service context data is created and
initialized.
@retval EFI_OUT_OF_RESOURCES Cannot allocate memory.
@retval other Other error occurs.
@retval EFI_SUCCESS The udp4 service context data is created and
initialized.
@retval EFI_OUT_OF_RESOURCES Cannot allocate memory.
@retval other Other error occurs.
**/
EFI_STATUS
@ -442,8 +442,8 @@ Udp4CleanService (
/**
This function intializes the new created udp instance.
@param Udp4Service Pointer to the UDP4_SERVICE_DATA.
@param Instance Pointer to the un-initialized UDP4_INSTANCE_DATA.
@param[in] Udp4Service Pointer to the UDP4_SERVICE_DATA.
@param[in, out] Instance Pointer to the un-initialized UDP4_INSTANCE_DATA.
**/
VOID
@ -467,9 +467,9 @@ Udp4CleanInstance (
This function tries to bind the udp instance according to the configured port
allocation strategy.
@param InstanceList Pointer to the head of the list linking the udp
@param[in] InstanceList Pointer to the head of the list linking the udp
instances.
@param ConfigData Pointer to the ConfigData of the instance to be
@param[in, out] ConfigData Pointer to the ConfigData of the instance to be
bound. ConfigData->StationPort will be assigned
with an available port value on success.
@ -588,8 +588,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[in, out] TokenMap Pointer to the NET_MAP containing the tokens.
@param[in] 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.
@ -604,9 +604,9 @@ Udp4RemoveToken (
/**
This function removes the multicast group specified by Arg from the Map.
@param Map Pointer to the NET_MAP.
@param Item Pointer to the NET_MAP_ITEM.
@param Arg Pointer to the Arg, it's the pointer to a
@param[in, out] Map Pointer to the NET_MAP.
@param[in] Item Pointer to the NET_MAP_ITEM.
@param[in] Arg Pointer to the Arg, it's the pointer to a
multicast IPv4 Address.
@retval EFI_SUCCESS The multicast address is removed.
@ -686,7 +686,7 @@ Udp4NetVectorExtFree (
/**
Set the Udp4 variable data.
@param Udp4Service Udp4 service data.
@param[in] Udp4Service Udp4 service data.
@retval EFI_OUT_OF_RESOURCES There are not enough resources to set the
variable.

10
MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Main.c
View File

@ -33,11 +33,11 @@ EFI_UDP4_PROTOCOL mUdp4Protocol = {
optionally to retrieve the operational mode data of underlying networks or
drivers.
@param This Pointer to the EFI_UDP4_PROTOCOL instance.
@param Udp4ConfigData Pointer to the buffer to receive the current configuration data.
@param Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure.
@param MnpConfigData Pointer to the managed network configuration data structure.
@param SnpModeData Pointer to the simple network mode data structure.
@param[in] This Pointer to the EFI_UDP4_PROTOCOL instance.
@param[out] Udp4ConfigData Pointer to the buffer to receive the current configuration data.
@param[out] Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure.
@param[out] MnpConfigData Pointer to the managed network configuration data structure.
@param[out] SnpModeData Pointer to the simple network mode data structure.
@retval EFI_SUCCESS The mode data was read.
@retval EFI_NOT_STARTED When Udp4ConfigData is queried, no configuration data is