/**\r
Free a UDP_TX_TOKEN. The TX event is closed.\r
\r
- @param Token The UDP_TX_TOKEN to release.\r
+ @param[in] Token The UDP_TX_TOKEN to release.\r
\r
**/\r
VOID\r
/**\r
Free a UDP_RX_TOKEN. The RX event is closed.\r
\r
- @param Token The UDP_RX_TOKEN to release.\r
+ @param[in] Token The UDP_RX_TOKEN to release.\r
\r
**/\r
VOID\r
It will remove the packet from the local list then call\r
the packet owner's callback function set by UdpIoSendDatagram.\r
\r
- @param Context The UDP TX Token.\r
+ @param[in] Context The UDP TX Token.\r
\r
**/\r
VOID\r
/**\r
Request UdpIoOnDgramSentDpc as a DPC at TPL_CALLBACK.\r
\r
- @param Event The event signaled.\r
- @param Context The UDP TX Token.\r
+ @param[in] Event The event signaled.\r
+ @param[in] Context The UDP TX Token.\r
\r
**/\r
VOID\r
/**\r
Recycle the received UDP data.\r
\r
- @param Context The UDP_RX_TOKEN\r
+ @param[in] Context The UDP_RX_TOKEN.\r
\r
**/\r
VOID\r
It will build a NET_BUF from the recieved UDP data, then deliver it\r
to the receiver.\r
\r
- @param Context The UDP RX token.\r
+ @param[in] Context The UDP RX token.\r
\r
**/\r
VOID\r
/**\r
Request UdpIoOnDgramRcvdDpc() as a DPC at TPL_CALLBACK.\r
\r
- @param Event The UDP receive request event.\r
- @param Context The UDP RX token.\r
+ @param[in] Event The UDP receive request event.\r
+ @param[in] Context The UDP RX token.\r
\r
**/\r
VOID\r
/**\r
Create a UDP_RX_TOKEN to wrap the request.\r
\r
- @param UdpIo The UdpIo to receive packets from\r
- @param CallBack The function to call when receive finished.\r
- @param Context The opaque parameter to the CallBack\r
- @param HeadLen The head length to reserver for the packet.\r
+ @param[in] UdpIo The UdpIo to receive packets from.\r
+ @param[in] CallBack The function to call when receive finished.\r
+ @param[in] Context The opaque parameter to the CallBack.\r
+ @param[in] HeadLen The head length to reserver for the packet.\r
\r
@return The Wrapped request or NULL if failed to allocate resources or some errors happened.\r
\r
/**\r
Wrap a transmit request into a UDP_TX_TOKEN.\r
\r
- @param UdpIo The UdpIo port to send packet to\r
- @param Packet The user's packet\r
- @param EndPoint The local and remote access point\r
- @param Gateway The overrided next hop\r
- @param CallBack The function to call when transmission completed.\r
- @param Context The opaque parameter to the call back\r
+ @param[in] UdpIo The UdpIo port to send packet to.\r
+ @param[in] Packet The user's packet.\r
+ @param[in] EndPoint The local and remote access point.\r
+ @param[in] Gateway The overrided next hop.\r
+ @param[in] CallBack The function to call when transmission completed.\r
+ @param[in] Context The opaque parameter to the call back.\r
\r
@return The wrapped transmission request or NULL if failed to allocate resources \r
or for some errors.\r
in creating or configure the UDP child will lead to the failure of UDP_IO_PORT\r
creation.\r
\r
- @param Controller The controller that has the UDP service binding\r
- protocol installed.\r
- @param Image The image handle for the driver.\r
- @param Configure The function to configure the created UDP child\r
- @param Context The opaque parameter for the Configure funtion.\r
+ @param[in] Controller The controller that has the UDP service binding.\r
+ protocol installed.\r
+ @param[in] Image The image handle for the driver.\r
+ @param[in] Configure The function to configure the created UDP child.\r
+ @param[in] Context The opaque parameter for the Configure funtion.\r
\r
@return Newly-created UDP_IO_PORT or NULL if failed.\r
\r
Cancel all the sent datagram that pass the selection criteria of ToCancel.\r
If ToCancel is NULL, all the datagrams are cancelled.\r
\r
- @param UdpIo The UDP_IO_PORT to cancel packet\r
- @param IoStatus The IoStatus to return to the packet owners.\r
- @param ToCancel The select funtion to test whether to cancel this\r
- packet or not.\r
- @param Context The opaque parameter to the ToCancel.\r
+ @param[in] UdpIo The UDP_IO_PORT to cancel packet.\r
+ @param[in] IoStatus The IoStatus to return to the packet owners.\r
+ @param[in] ToCancel The select funtion to test whether to cancel this\r
+ packet or not.\r
+ @param[in] Context The opaque parameter to the ToCancel.\r
\r
**/\r
VOID\r
\r
The function will cancel all sent datagram and receive request.\r
\r
- @param UdpIo The UDP_IO_PORT to free.\r
+ @param[in] UdpIo The UDP_IO_PORT to free.\r
\r
@retval EFI_SUCCESS The UDP_IO_PORT is freed.\r
\r
It will release all the transmitted datagrams and receive request. It will\r
also configure NULL for the UDP instance.\r
\r
- @param UdpIo The UDP_IO_PORT to clean up.\r
+ @param[in] UdpIo The UDP_IO_PORT to clean up.\r
\r
**/\r
VOID\r
when the packet is sent. The optional parameter EndPoint overrides the default\r
address pair if specified.\r
\r
- @param UdpIo The UDP_IO_PORT to send the packet through\r
- @param Packet The packet to send\r
- @param EndPoint The local and remote access point. Override the\r
- default address pair set during configuration.\r
- @param Gateway The gateway to use\r
- @param CallBack The function being called when packet is\r
- transmitted or failed.\r
- @param Context The opaque parameter passed to CallBack\r
+ @param[in] UdpIo The UDP_IO_PORT to send the packet through.\r
+ @param[in] Packet The packet to send.\r
+ @param[in] EndPoint The local and remote access point. Override the\r
+ default address pair set during configuration.\r
+ @param[in] Gateway The gateway to use.\r
+ @param[in] CallBack The function being called when packet is\r
+ transmitted or failed.\r
+ @param[in] Context The opaque parameter passed to CallBack.\r
\r
- @retval EFI_OUT_OF_RESOURCES Failed to allocate resource for the packet\r
+ @retval EFI_OUT_OF_RESOURCES Failed to allocate resource for the packet.\r
@retval EFI_SUCCESS The packet is successfully delivered to UDP for\r
transmission.\r
\r
/**\r
The select function to cancel a single sent datagram.\r
\r
- @param Token The UDP_TX_TOKEN to test against\r
- @param Context The NET_BUF of the sent datagram\r
+ @param[in] Token The UDP_TX_TOKEN to test against\r
+ @param[in] Context The NET_BUF of the sent datagram\r
\r
@retval TRUE The packet is to be cancelled.\r
@retval FALSE The packet is not to be cancelled.\r
/**\r
Cancel a single sent datagram.\r
\r
- @param UdpIo The UDP_IO_PORT to cancel the packet from\r
- @param Packet The packet to cancel\r
+ @param[in] UdpIo The UDP_IO_PORT to cancel the packet from\r
+ @param[in] Packet The packet to cancel\r
\r
**/\r
VOID\r
to invoke this function inside its Callback function when the former packet\r
is processed.\r
\r
- @param UdpIo The UDP_IO_PORT to receive the packet from.\r
- @param CallBack The call back function to execute when the packet\r
- is received.\r
- @param Context The opaque context passed to Callback\r
- @param HeadLen The length of the upper-layer's protocol header\r
+ @param[in] UdpIo The UDP_IO_PORT to receive the packet from.\r
+ @param[in] CallBack The call back function to execute when the packet\r
+ is received.\r
+ @param[in] Context The opaque context passed to Callback.\r
+ @param[in] HeadLen The length of the upper-layer's protocol header.\r
\r
@retval EFI_ALREADY_STARTED There is already a pending receive request. Only\r
one receive request is supported at a time.\r
projects / mirror_edk2.git / blobdiff