diff options
Diffstat (limited to 'MdeModulePkg/Include/Library/UdpIoLib.h')
| -rw-r--r-- | MdeModulePkg/Include/Library/UdpIoLib.h | 142 |
1 files changed, 71 insertions, 71 deletions
diff --git a/MdeModulePkg/Include/Library/UdpIoLib.h b/MdeModulePkg/Include/Library/UdpIoLib.h index bf9f7de346..05c1217a53 100644 --- a/MdeModulePkg/Include/Library/UdpIoLib.h +++ b/MdeModulePkg/Include/Library/UdpIoLib.h @@ -16,10 +16,10 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #ifndef _UDP4IO_H_ #define _UDP4IO_H_ -#include <PiDxe.h>
-
-#include <Protocol/Udp4.h>
-
+#include <PiDxe.h> + +#include <Protocol/Udp4.h> + #include <Library/UdpIoLib.h> #include <Library/NetLib.h> @@ -28,7 +28,7 @@ typedef struct _UDP_IO_PORT UDP_IO_PORT; enum { UDP_IO_RX_SIGNATURE = EFI_SIGNATURE_32 ('U', 'D', 'P', 'R'), UDP_IO_TX_SIGNATURE = EFI_SIGNATURE_32 ('U', 'D', 'P', 'T'), - UDP_IO_SIGNATURE = EFI_SIGNATURE_32 ('U', 'D', 'P', 'I'), + UDP_IO_SIGNATURE = EFI_SIGNATURE_32 ('U', 'D', 'P', 'I') }; typedef struct { @@ -124,18 +124,18 @@ BOOLEAN IN VOID *Context ); -/**
- Create a UDP IO port to access the UDP service. It will
- create and configure a UDP child.
-
- @param Controller The controller that has the UDP service binding
- protocol installed.
- @param Image The image handle for the driver.
- @param Configure The function to configure the created UDP child
- @param Context The opaque parameter for the Configure funtion.
-
- @return A point to just created UDP IO port or NULL if failed.
-
+/** + Create a UDP IO port to access the UDP service. It will + create and configure a UDP child. + + @param Controller The controller that has the UDP service binding + protocol installed. + @param Image The image handle for the driver. + @param Configure The function to configure the created UDP child + @param Context The opaque parameter for the Configure funtion. + + @return A point to just created UDP IO port or NULL if failed. + **/ UDP_IO_PORT * EFIAPI @@ -146,14 +146,14 @@ UdpIoCreatePort ( IN VOID *Context ); -/**
- Free the UDP IO port and all its related resources including
- all the transmitted packet.
-
- @param UdpIo The UDP IO port to free.
-
- @retval EFI_SUCCESS The UDP IO port is freed.
-
+/** + Free the UDP IO port and all its related resources including + all the transmitted packet. + + @param UdpIo The UDP IO port to free. + + @retval EFI_SUCCESS The UDP IO port is freed. + **/ EFI_STATUS EFIAPI @@ -161,15 +161,15 @@ UdpIoFreePort ( IN UDP_IO_PORT *UdpIo ); -/**
- Clean up the UDP IO port. It will release all the transmitted
- datagrams and receive request. It will also configure NULL the
- UDP child.
-
- @param UdpIo UDP IO port to clean up.
-
- @return None
-
+/** + Clean up the UDP IO port. It will release all the transmitted + datagrams and receive request. It will also configure NULL the + UDP child. + + @param UdpIo UDP IO port to clean up. + + @return None + **/ VOID EFIAPI @@ -177,21 +177,21 @@ UdpIoCleanPort ( IN UDP_IO_PORT *UdpIo ); -/**
- Send a packet through the UDP IO port.
-
- @param UdpIo The UDP IO Port to send the packet through
- @param Packet The packet to send
- @param EndPoint The local and remote access point
- @param Gateway The gateway to use
- @param CallBack The call back function to call when packet is
- transmitted or failed.
- @param Context The opque parameter to the CallBack
-
- @retval EFI_OUT_OF_RESOURCES Failed to allocate resource for the packet
- @retval EFI_SUCCESS The packet is successfully delivered to UDP for
- transmission.
-
+/** + Send a packet through the UDP IO port. + + @param UdpIo The UDP IO Port to send the packet through + @param Packet The packet to send + @param EndPoint The local and remote access point + @param Gateway The gateway to use + @param CallBack The call back function to call when packet is + transmitted or failed. + @param Context The opque parameter to the CallBack + + @retval EFI_OUT_OF_RESOURCES Failed to allocate resource for the packet + @retval EFI_SUCCESS The packet is successfully delivered to UDP for + transmission. + **/ EFI_STATUS EFIAPI @@ -204,14 +204,14 @@ UdpIoSendDatagram ( IN VOID *Context ); -/**
- The selection function to cancel a single sent datagram.
-
- @param Token The UDP TX token to test againist.
- @param Context The context
-
- @return TRUE if the packet is to be cancelled, otherwise FALSE.
-
+/** + The selection function to cancel a single sent datagram. + + @param Token The UDP TX token to test againist. + @param Context The context + + @return TRUE if the packet is to be cancelled, otherwise FALSE. + **/ VOID EFIAPI @@ -220,20 +220,20 @@ UdpIoCancelSentDatagram ( IN NET_BUF *Packet ); -/**
- Issue a receive request to the UDP IO port.
-
- @param UdpIo The UDP IO port to recieve the packet from.
- @param CallBack The call back function to execute when receive
- finished.
- @param Context The opque context to the call back
- @param HeadLen The lenght of the application's header
-
- @retval EFI_ALREADY_STARTED There is already a pending receive request. Only
- one receive request is supported.
- @retval EFI_OUT_OF_RESOURCES Failed to allocate some resource.
- @retval EFI_SUCCESS The receive request is issued successfully.
-
+/** + Issue a receive request to the UDP IO port. + + @param UdpIo The UDP IO port to recieve the packet from. + @param CallBack The call back function to execute when receive + finished. + @param Context The opque context to the call back + @param HeadLen The lenght of the application's header + + @retval EFI_ALREADY_STARTED There is already a pending receive request. Only + one receive request is supported. + @retval EFI_OUT_OF_RESOURCES Failed to allocate some resource. + @retval EFI_SUCCESS The receive request is issued successfully. + **/ EFI_STATUS EFIAPI |