This library is used to share code between UEFI network stack modules.\r
It provides the helper routines to access UDP service. It is used by both DHCP and MTFTP.\r
\r
-Copyright (c) 2006 - 2009, Intel Corporation.<BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+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<BR>\r
http://opensource.org/licenses/bsd-license.php\r
\r
This prototype is used by both receive and sending when calling\r
UdpIoRecvDatagram() or UdpIoSendDatagram(). When receiving, Netbuf is allocated by the\r
- UDP access point and released by the user. When sending, the user allocates the the NetBuf, which is then\r
- provided to the callback as a reference.\r
- \r
- @param[in] Packet Packet received or sent\r
- @param[in] EndPoint The UDP address pair corresponds to the UDP IO\r
- @param[in] IoStatus Packet receiving or sending status\r
- @param[in] Context User-defined data when calling UdpIoRecvDatagram() or\r
- UdpIoSendDatagram()\r
+ UDP access point and released by the user. When sending, the user allocates the the NetBuf,\r
+ which is then provided to the callback as a reference.\r
+\r
+ @param[in] Packet The packet received or sent.\r
+ @param[in] EndPoint The UDP address pair corresponds to the UDP IO.\r
+ @param[in] IoStatus The packet receiving or sending status.\r
+ @param[in] Context The user-defined data when calling UdpIoRecvDatagram() or\r
+ UdpIoSendDatagram().\r
**/\r
typedef\r
VOID\r
-(*UDP_IO_CALLBACK) (\r
+(EFIAPI *UDP_IO_CALLBACK) (\r
IN NET_BUF *Packet,\r
IN UDP_END_POINT *EndPoint,\r
IN EFI_STATUS IoStatus,\r
/// This structure is used internally by UdpIo Library.\r
///\r
/// Each transmit request is wrapped in an UDP_TX_TOKEN. Upon completion,\r
-/// the CallBack will be called. There can be several transmit requests. All transmit requests\r
-/// are linked in a list.\r
+/// the CallBack will be called. There can be several transmit requests. All transmit\r
+/// requests are linked in a list.\r
///\r
\r
typedef union {\r
///\r
/// Type defined as UDP_IO.\r
///\r
-/// This data structure wraps the UDP instance and configuration. \r
+/// This data structure wraps the UDP instance and configuration.\r
/// UdpIo Library uses this structure for all Udp4 or Udp6 operations.\r
///\r
struct _UDP_IO {\r
UINT8 UdpVersion;\r
\r
//\r
- // Handle used to create/destory UDP child\r
+ // Handle used to create/destroy UDP child\r
//\r
EFI_HANDLE Controller;\r
EFI_HANDLE Image;\r
union {\r
EFI_UDP4_PROTOCOL *Udp4;\r
EFI_UDP6_PROTOCOL *Udp6;\r
- } Protocol; \r
+ } Protocol;\r
\r
union {\r
EFI_UDP4_CONFIG_DATA Udp4;\r
};\r
\r
/**\r
- Prototype called when UdpIo Library configures a UDP instance.\r
- \r
+ The prototype called when UdpIo Library configures a UDP instance.\r
+\r
The prototype is set and called when creating a UDP_IO in UdpIoCreatePort().\r
- \r
- @param[in] UdpIo The UDP_IO to configure\r
- @param[in] Context User-defined data when calling UdpIoCreatePort()\r
- \r
- @retval EFI_SUCCESS The configuration succeeded\r
+\r
+ @param[in] UdpIo The UDP_IO to configure.\r
+ @param[in] Context The user-defined data when calling UdpIoCreatePort().\r
+\r
+ @retval EFI_SUCCESS The configuration succeeded.\r
@retval Others The UDP_IO fails to configure indicating\r
- UdpIoCreatePort() should fail\r
+ UdpIoCreatePort() should fail.\r
**/\r
typedef\r
EFI_STATUS\r
-(*UDP_IO_CONFIG) (\r
+(EFIAPI *UDP_IO_CONFIG) (\r
IN UDP_IO *UdpIo,\r
IN VOID *Context\r
);\r
\r
/**\r
- The select function to decide whether to cancel the UDP_TX_TOKEN. \r
- \r
- @param[in] Token The UDP_TX_TOKEN to decide whether to cancel\r
- @param[in] Context User-defined data in UdpIoCancelDgrams()\r
- \r
- @retval TRUE Cancel the UDP_TX_TOKEN\r
- @retval FALSE Do not cancel this UDP_TX_TOKEN\r
+ The select function to decide whether to cancel the UDP_TX_TOKEN.\r
+\r
+ @param[in] Token The UDP_TX_TOKEN to decide whether to cancel.\r
+ @param[in] Context User-defined data in UdpIoCancelDgrams().\r
+\r
+ @retval TRUE Cancel the UDP_TX_TOKEN.\r
+ @retval FALSE Do not cancel this UDP_TX_TOKEN.\r
\r
**/\r
typedef\r
BOOLEAN\r
-(*UDP_IO_TO_CANCEL) (\r
+(EFIAPI *UDP_IO_TO_CANCEL) (\r
IN UDP_TX_TOKEN *Token,\r
IN VOID *Context\r
);\r
\r
/**\r
- Cancel all sent datagrams selected by the parameter ToCancel.\r
+ Cancel all the sent datagram that pass the selection criteria of ToCancel.\r
+\r
If ToCancel is NULL, all the datagrams are cancelled.\r
+ If Udp version is not UDP_IO_UDP4_VERSION or UDP_IO_UDP6_VERSION, then ASSERT().\r
\r
@param[in] UdpIo The UDP_IO to cancel packet.\r
@param[in] IoStatus The IoStatus to return to the packet owners.\r
- @param[in] ToCancel Sets the criteria for canceling a packet. \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
UdpIoCancelDgrams (\r
IN UDP_IO *UdpIo,\r
IN EFI_STATUS IoStatus,\r
- IN UDP_IO_TO_CANCEL ToCancel OPTIONAL,\r
- IN VOID *Context\r
+ IN UDP_IO_TO_CANCEL ToCancel, OPTIONAL\r
+ IN VOID *Context OPTIONAL\r
);\r
\r
/**\r
Creates a UDP_IO to access the UDP service. It creates and configures\r
a UDP child.\r
- \r
- This function:\r
- # locates the UDP service binding prototype on the Controller parameter\r
- # uses the UDP service binding prototype to create a UDP child (also known as a UDP instance)\r
- # configures the UDP child by calling Configure function prototype. \r
- Any failures in creating or configuring the UDP child return NULL for failure. \r
+\r
+ If Configure is NULL, then ASSERT().\r
+ If Udp version is not UDP_IO_UDP4_VERSION or UDP_IO_UDP6_VERSION, then ASSERT().\r
+\r
+ It locates the UDP service binding prototype on the Controller parameter\r
+ uses the UDP service binding prototype to create a UDP child (also known as\r
+ a UDP instance) configures the UDP child by calling Configure function prototype.\r
+ Any failures in creating or configuring the UDP child return NULL for failure.\r
\r
@param[in] Controller The controller that has the UDP service binding.\r
protocol installed.\r
@param[in] UdpVersion The UDP protocol version, UDP4 or UDP6.\r
@param[in] Context The opaque parameter for the Configure funtion.\r
\r
- @return Newly-created UDP_IO or NULL if failed.\r
+ @return The newly-created UDP_IO, or NULL if failed.\r
\r
**/\r
UDP_IO *\r
\r
/**\r
Free the UDP_IO and all its related resources.\r
- \r
+\r
+ If Udp version is not UDP_IO_UDP4_VERSION or UDP_IO_UDP6_VERSION, then ASSERT().\r
+\r
The function cancels all sent datagrams and receive requests.\r
\r
@param[in] UdpIo The UDP_IO to free.\r
\r
@retval EFI_SUCCESS The UDP_IO is freed.\r
+ @retval Others Failed to free UDP_IO.\r
\r
**/\r
EFI_STATUS\r
);\r
\r
/**\r
- Cleans up the UDP_IO without freeing it. Call this function \r
+ Cleans up the UDP_IO without freeing it. Call this function\r
if you intend to later re-use the UDP_IO.\r
- \r
+\r
+ If Udp version is not UDP_IO_UDP4_VERSION or UDP_IO_UDP6_VERSION, then ASSERT().\r
+\r
This function releases all transmitted datagrams and receive requests and configures NULL for the UDP instance.\r
\r
@param[in] UdpIo The UDP_IO to clean up.\r
\r
/**\r
Send a packet through the UDP_IO.\r
- \r
+\r
+ If Udp version is not UDP_IO_UDP4_VERSION or UDP_IO_UDP6_VERSION, then ASSERT().\r
+\r
The packet will be wrapped in UDP_TX_TOKEN. Function Callback will be called\r
when the packet is sent. The optional parameter EndPoint overrides the default\r
address pair if specified.\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] 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_SUCCESS The packet is successfully delivered to UDP for\r
+ @retval EFI_SUCCESS The packet is successfully delivered to UDP for\r
transmission.\r
\r
**/\r
/**\r
Cancel a single sent datagram.\r
\r
- @param[in] UdpIo The UDP_IO from which to cancel the packet \r
+ @param[in] UdpIo The UDP_IO from which to cancel the packet\r
@param[in] Packet The packet to cancel\r
\r
**/\r
\r
/**\r
Issue a receive request to the UDP_IO.\r
- \r
+\r
+ If Udp version is not UDP_IO_UDP4_VERSION or UDP_IO_UDP6_VERSION, then ASSERT().\r
+\r
This function is called when upper-layer needs packet from UDP for processing.\r
Only one receive request is acceptable at a time. Therefore, one common usage model is\r
to invoke this function inside its Callback function when the former packet\r
@retval EFI_ALREADY_STARTED There is already a pending receive request. Only\r
one receive request is supported at a time.\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources.\r
- @retval EFI_SUCCESS The receive request is issued successfully.\r
+ @retval EFI_SUCCESS The receive request was issued successfully.\r
@retval EFI_UNSUPPORTED The UDP version in UDP_IO is not supported.\r
\r
**/\r
projects / mirror_edk2.git / blobdiff