#ifndef _UDP4IO_H_
#define _UDP4IO_H_
-#include <PiDxe.h>\r
-\r
-#include <Protocol/Udp4.h>\r
-\r
+#include <PiDxe.h>
+
+#include <Protocol/Udp4.h>
+
#include <Library/UdpIoLib.h>
#include <Library/NetLib.h>
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 {
IN VOID *Context
);
-/**\r
- Create a UDP IO port to access the UDP service. It will\r
- create and configure a UDP child.\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
-\r
- @return A point to just created UDP IO port or NULL if failed.\r
-\r
+/**
+ 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
IN VOID *Context
);
-/**\r
- Free the UDP IO port and all its related resources including\r
- all the transmitted packet.\r
-\r
- @param UdpIo The UDP IO port to free.\r
-\r
- @retval EFI_SUCCESS The UDP IO port is freed.\r
-\r
+/**
+ 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
IN UDP_IO_PORT *UdpIo
);
-/**\r
- Clean up the UDP IO port. It will release all the transmitted\r
- datagrams and receive request. It will also configure NULL the\r
- UDP child.\r
-\r
- @param UdpIo UDP IO port to clean up.\r
-\r
- @return None\r
-\r
+/**
+ 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
IN UDP_IO_PORT *UdpIo
);
-/**\r
- Send a packet through the UDP IO port.\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\r
- @param Gateway The gateway to use\r
- @param CallBack The call back function to call when packet is\r
- transmitted or failed.\r
- @param Context The opque parameter to the 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
- transmission.\r
-\r
+/**
+ 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
IN VOID *Context
);
-/**\r
- The selection function to cancel a single sent datagram.\r
-\r
- @param Token The UDP TX token to test againist.\r
- @param Context The context\r
-\r
- @return TRUE if the packet is to be cancelled, otherwise FALSE.\r
-\r
+/**
+ 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
IN NET_BUF *Packet
);
-/**\r
- Issue a receive request to the UDP IO port.\r
-\r
- @param UdpIo The UDP IO port to recieve the packet from.\r
- @param CallBack The call back function to execute when receive\r
- finished.\r
- @param Context The opque context to the call back\r
- @param HeadLen The lenght of the application's header\r
-\r
- @retval EFI_ALREADY_STARTED There is already a pending receive request. Only\r
- one receive request is supported.\r
- @retval EFI_OUT_OF_RESOURCES Failed to allocate some resource.\r
- @retval EFI_SUCCESS The receive request is issued successfully.\r
-\r
+/**
+ 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
projects / mirror_edk2.git / blobdiff