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

enhanced function header 

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7157 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
jgong5 2008-12-30 12:26:40 +00:00
parent e29a2e7e80
commit e6ff63a514
1 changed files with 77 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

137
MdeModulePkg/Library/DxeIpIoLib/DxeIpIoLib.c
View File

@ -86,17 +86,17 @@ IpIoTransmitHandler (
/** /**
This function create an ip child ,open the IP protocol, return the opened This function create an IP child, open the IP protocol and return the opened
Ip protocol to Interface. IP protocol as Interface.
@param ControllerHandle The controller handle. @param ControllerHandle The controller handle.
@param ImageHandle The image handle. @param ImageHandle The image handle.
@param ChildHandle Pointer to the buffer to save the ip child handle. @param ChildHandle Pointer to the buffer to save the IP child handle.
@param Interface Pointer used to get the ip protocol interface. @param Interface Pointer used to get the IP protocol interface.
@retval EFI_SUCCESS The ip child is created and the ip protocol @retval EFI_SUCCESS The IP child is created and the IP protocol
interface is retrieved. interface is retrieved.
@retval other The required operation failed. @retval Other The required operation failed.
**/ **/
EFI_STATUS EFI_STATUS
@ -150,15 +150,15 @@ IpIoCreateIpChildOpenProtocol (
/** /**
This function close the previously openned ip protocol and destroy the ip child. This function close the previously openned IP protocol and destroy the IP child.
@param ControllerHandle The controller handle. @param ControllerHandle The controller handle.
@param ImageHandle the image handle. @param ImageHandle the image handle.
@param ChildHandle The child handle of the ip child. @param ChildHandle The child handle of the IP child.
@retval EFI_SUCCESS The ip protocol is closed and the relevant ip child @retval EFI_SUCCESS The IP protocol is closed and the relevant IP child
is destroyed. is destroyed.
@retval other The required operation failed. @retval Other The required operation failed.
**/ **/
EFI_STATUS EFI_STATUS
@ -195,7 +195,7 @@ IpIoCloseProtocolDestroyIpChild (
/** /**
Handle ICMP packets. This function handles ICMP packets.
@param IpIo Pointer to the IP_IO instance. @param IpIo Pointer to the IP_IO instance.
@param Pkt Pointer to the ICMP packet. @param Pkt Pointer to the ICMP packet.
@ -326,15 +326,12 @@ IpIoIcmpHandler (
/** /**
Ext free function for net buffer. This function is Free function for receive token of IP_IO. It is used to
called when the net buffer is freed. It is used to
signal the recycle event to notify IP to recycle the signal the recycle event to notify IP to recycle the
data buffer. data buffer.
@param Event The event to be signaled. @param Event The event to be signaled.
@return None.
**/ **/
VOID VOID
IpIoExtFree ( IpIoExtFree (
@ -357,7 +354,7 @@ IpIoExtFree (
@param Override Pointer to the overriden IP_IO data. @param Override Pointer to the overriden IP_IO data.
@return Pointer to the data structure created to wrap the packet. If NULL, @return Pointer to the data structure created to wrap the packet. If NULL,
@return resource limit occurred. resource limit occurred.
**/ **/
IP_IO_SEND_ENTRY * IP_IO_SEND_ENTRY *
@ -490,9 +487,9 @@ ReleaseSndEntry:
/** /**
Destroy the SndEntry. Destroy the SndEntry.
@param SndEntry Pointer to the send entry to be destroyed. This function pairs with IpIoCreateSndEntry().
@return None. @param SndEntry Pointer to the send entry to be destroyed.
**/ **/
VOID VOID
@ -524,8 +521,6 @@ IpIoDestroySndEntry (
@param Context The context passed in by the event notifier. @param Context The context passed in by the event notifier.
@return None.
**/ **/
VOID VOID
EFIAPI EFIAPI
@ -558,8 +553,6 @@ IpIoTransmitHandlerDpc (
@param Event The event signaled. @param Event The event signaled.
@param Context The context passed in by the event notifier. @param Context The context passed in by the event notifier.
@return None.
**/ **/
VOID VOID
@ -581,8 +574,6 @@ IpIoTransmitHandler (
@param Context The context passed in by the event notifier. @param Context The context passed in by the event notifier.
@return None.
**/ **/
VOID VOID
EFIAPI EFIAPI
@ -617,8 +608,6 @@ IpIoDummyHandlerDpc (
@param Event The event signaled. @param Event The event signaled.
@param Context The context passed in by the event notifier. @param Context The context passed in by the event notifier.
@return None.
**/ **/
VOID VOID
EFIAPI EFIAPI
@ -640,8 +629,6 @@ IpIoDummyHandler (
@param Context The context passed in by the event notifier. @param Context The context passed in by the event notifier.
@return None.
**/ **/
VOID VOID
EFIAPI EFIAPI
@ -761,11 +748,15 @@ IpIoListenHandler (
/** /**
Create a new IP_IO instance. Create a new IP_IO instance.
@param Image The image handle of an IP_IO consumer protocol. This function uses IP4 service binding protocol in Controller to create an IP4
@param Controller The controller handle of an IP_IO consumer protocol child (aka IP4 instance).
installed on.
@return Pointer to a newly created IP_IO instance. @param Image The image handle of the driver or application that
consumes IP_IO.
@param Controller The controller handle that has IP4 service binding
protocol installed.
@return Pointer to a newly created IP_IO instance, or NULL if failed.
**/ **/
IP_IO * IP_IO *
@ -829,12 +820,17 @@ ReleaseIpIo:
/** /**
Open an IP_IO instance for use. Open an IP_IO instance for use.
This function is called after IpIoCreate(). It is used for configuring the IP
instance and register the callbacks and their context data for sending and
receiving IP packets.
@param IpIo Pointer to an IP_IO instance that needs to open. @param IpIo Pointer to an IP_IO instance that needs to open.
@param OpenData The configuration data for the IP_IO instance. @param OpenData The configuration data and callbacks for the IP_IO
instance.
@retval EFI_SUCCESS The IP_IO instance opened with OpenData @retval EFI_SUCCESS The IP_IO instance opened with OpenData
successfully. successfully.
@retval other Error condition occurred. @retval Other Error condition occurred.
**/ **/
EFI_STATUS EFI_STATUS
@ -901,13 +897,17 @@ ErrorExit:
/** /**
Stop an IP_IO instance. Stop an IP_IO instance.
This function is paired with IpIoOpen(). The IP_IO will be unconfigured and all
the pending send/receive tokens will be canceled.
@param IpIo Pointer to the IP_IO instance that needs to stop. @param IpIo Pointer to the IP_IO instance that needs to stop.
@retval EFI_SUCCESS The IP_IO instance stopped successfully. @retval EFI_SUCCESS The IP_IO instance stopped successfully.
@retval other Error condition occurred. @retval Other Error condition occurred.
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI
IpIoStop ( IpIoStop (
IN IP_IO *IpIo IN IP_IO *IpIo
) )
@ -964,11 +964,14 @@ IpIoStop (
/** /**
Destroy an IP_IO instance. Destroy an IP_IO instance.
@param IpIo Pointer to the IP_IO instance that needs to This function is paired with IpIoCreate(). The IP_IO will be closed first.
destroy. Resource will be freed afterwards. See IpIoClose().
@param IpIo Pointer to the IP_IO instance that needs to be
destroyed.
@retval EFI_SUCCESS The IP_IO instance destroyed successfully. @retval EFI_SUCCESS The IP_IO instance destroyed successfully.
@retval other Error condition occurred. @retval Other Error condition occurred.
**/ **/
EFI_STATUS EFI_STATUS
@ -996,11 +999,17 @@ IpIoDestroy (
/** /**
Send out an IP packet. Send out an IP packet.
This function is called after IpIoOpen(). The data to be sent are wrapped in
Pkt. The IP instance wrapped in IpIo is used for sending by default but can be
overriden by Sender. Other sending configs, like source address and gateway
address etc., are specified in OverrideData.
@param IpIo Pointer to an IP_IO instance used for sending IP @param IpIo Pointer to an IP_IO instance used for sending IP
packet. packet.
@param Pkt Pointer to the IP packet to be sent. @param Pkt Pointer to the IP packet to be sent.
@param Sender The IP protocol instance used for sending. @param Sender The IP protocol instance used for sending.
@param NotifyData @param Context Optional context data
@param NotifyData Optional notify data
@param Dest The destination IP address to send this packet to. @param Dest The destination IP address to send this packet to.
@param OverrideData The data to override some configuration of the IP @param OverrideData The data to override some configuration of the IP
instance used for sending. instance used for sending.
@ -1015,11 +1024,11 @@ EFIAPI
IpIoSend ( IpIoSend (
IN IP_IO *IpIo, IN IP_IO *IpIo,
IN NET_BUF *Pkt, IN NET_BUF *Pkt,
IN IP_IO_IP_INFO *Sender, IN IP_IO_IP_INFO *Sender OPTIONAL,
IN VOID *Context OPTIONAL, IN VOID *Context OPTIONAL,
IN VOID *NotifyData OPTIONAL, IN VOID *NotifyData OPTIONAL,
IN IP4_ADDR Dest, IN IP4_ADDR Dest,
IN IP_IO_OVERRIDE *OverrideData IN IP_IO_OVERRIDE *OverrideData OPTIONAL
) )
{ {
EFI_STATUS Status; EFI_STATUS Status;
@ -1056,9 +1065,7 @@ IpIoSend (
Cancel the IP transmit token which wraps this Packet. Cancel the IP transmit token which wraps this Packet.
@param IpIo Pointer to the IP_IO instance. @param IpIo Pointer to the IP_IO instance.
@param Packet Pointer to the packet to cancel. @param Packet Pointer to the packet of NET_BUF to cancel.
@return N/A.
**/ **/
VOID VOID
@ -1093,10 +1100,14 @@ IpIoCancelTxToken (
/** /**
Add a new IP instance for sending data. Add a new IP instance for sending data.
The function is used to add the IP_IO to the IP_IO sending list. The caller
can later use IpIoFindSender() to get the IP_IO and call IpIoSend() to send
data.
@param IpIo Pointer to a IP_IO instance to add a new IP @param IpIo Pointer to a IP_IO instance to add a new IP
instance for sending purpose. instance for sending purpose.
@return Pointer to the created IP_IO_IP_INFO structure, NULL is failed. @return Pointer to the created IP_IO_IP_INFO structure, NULL if failed.
**/ **/
IP_IO_IP_INFO * IP_IO_IP_INFO *
@ -1180,14 +1191,15 @@ ReleaseIpInfo:
is not NULL. is not NULL.
@param IpInfo Pointer to the IP_IO_IP_INFO instance. @param IpInfo Pointer to the IP_IO_IP_INFO instance.
@param Ip4ConfigData The IP4 configure data used to configure the ip @param Ip4ConfigData The IP4 configure data used to configure the IP
instance, if NULL the ip instance is reseted. If instance, if NULL the IP instance is reset. If
UseDefaultAddress is set to TRUE, and the configure UseDefaultAddress is set to TRUE, and the configure
operation succeeds, the default address information operation succeeds, the default address information
is written back in this Ip4ConfigData. is written back in this Ip4ConfigData.
@retval EFI_STATUS The status returned by IP4->Configure or @retval EFI_STATUS The status returned by IP4->Configure or
IP4->Receive. IP4->Receive.
@retval Other Configuration fails.
**/ **/
EFI_STATUS EFI_STATUS
@ -1255,17 +1267,19 @@ OnExit:
Destroy an IP instance maintained in IpIo->IpList for Destroy an IP instance maintained in IpIo->IpList for
sending purpose. sending purpose.
This function pairs with IpIoAddIp(). The IpInfo is previously created by
IpIoAddIp(). The IP_IO_IP_INFO::RefCnt is decremented and the IP instance
will be dstroyed if the RefCnt is zero.
@param IpIo Pointer to the IP_IO instance. @param IpIo Pointer to the IP_IO instance.
@param IpInfo Pointer to the IpInfo to be removed. @param IpInfo Pointer to the IpInfo to be removed.
@return None.
**/ **/
VOID VOID
EFIAPI EFIAPI
IpIoRemoveIp ( IpIoRemoveIp (
IN IP_IO *IpIo, IN IP_IO *IpIo,
IN IP_IO_IP_INFO *IpInfo IN IP_IO_IP_INFO *IpInfo
) )
{ {
ASSERT (IpInfo->RefCnt > 0); ASSERT (IpInfo->RefCnt > 0);
@ -1293,11 +1307,14 @@ IpIoRemoveIp (
Find the first IP protocol maintained in IpIo whose local Find the first IP protocol maintained in IpIo whose local
address is the same with Src. address is the same with Src.
This function is called when the caller needs the IpIo to send data to the
specified Src. The IpIo was added previously by IpIoAddIp().
@param IpIo Pointer to the pointer of the IP_IO instance. @param IpIo Pointer to the pointer of the IP_IO instance.
@param Src The local IP address. @param Src The local IP address.
@return Pointer to the IP protocol can be used for sending purpose and its local @return Pointer to the IP protocol can be used for sending purpose and its local
@return address is the same with Src. address is the same with Src.
**/ **/
IP_IO_IP_INFO * IP_IO_IP_INFO *
@ -1337,10 +1354,10 @@ IpIoFindSender (
/** /**
Get the ICMP error map information, the ErrorStatus will be returned. Get the ICMP error map information.
The IsHard and Notify are optional. If they are not NULL, this rouine will
fill them. The ErrorStatus will be returned. The IsHard and Notify are optional. If they
We move IcmpErrMap[] to local variable to enable EBC build. are not NULL, this routine will fill them.
@param IcmpError IcmpError Type @param IcmpError IcmpError Type
@param IsHard Whether it is a hard error @param IsHard Whether it is a hard error
@ -1353,8 +1370,8 @@ EFI_STATUS
EFIAPI EFIAPI
IpIoGetIcmpErrStatus ( IpIoGetIcmpErrStatus (
IN ICMP_ERROR IcmpError, IN ICMP_ERROR IcmpError,
OUT BOOLEAN *IsHard, OPTIONAL OUT BOOLEAN *IsHard OPTIONAL,
OUT BOOLEAN *Notify OPTIONAL OUT BOOLEAN *Notify OPTIONAL
) )
{ {
ASSERT ((IcmpError >= ICMP_ERR_UNREACH_NET) && (IcmpError <= ICMP_ERR_PARAMPROB)); ASSERT ((IcmpError >= ICMP_ERR_UNREACH_NET) && (IcmpError <= ICMP_ERR_PARAMPROB));