Data Structures | |
struct | UDP_END_POINT |
union | UDP_COMPLETION_TOKEN |
struct | UDP_RX_TOKEN |
union | UDP_SESSION_DATA |
union | UDP_TRANSMIT_DATA |
struct | UDP_TX_TOKEN |
struct | _UDP_IO |
Defines | |
#define | UDP_IO_RX_SIGNATURE SIGNATURE_32 ('U', 'D', 'P', 'R') |
#define | UDP_IO_TX_SIGNATURE SIGNATURE_32 ('U', 'D', 'P', 'T') |
#define | UDP_IO_SIGNATURE SIGNATURE_32 ('U', 'D', 'P', 'I') |
#define | UDP_IO_UDP4_VERSION 4 |
#define | UDP_IO_UDP6_VERSION 6 |
Typedefs | |
typedef struct _UDP_IO | UDP_IO |
typedef IN UDP_END_POINT * | EndPoint |
typedef IN UDP_END_POINT IN EFI_STATUS | IoStatus |
typedef IN UDP_END_POINT IN EFI_STATUS IN VOID * | Context |
Functions | |
typedef | VOID (EFIAPI *UDP_IO_CALLBACK)(IN NET_BUF *Packet |
typedef | EFI_STATUS (EFIAPI *UDP_IO_CONFIG)(IN UDP_IO *UdpIo |
typedef | BOOLEAN (EFIAPI *UDP_IO_TO_CANCEL)(IN UDP_TX_TOKEN *Token |
VOID EFIAPI | UdpIoCancelDgrams (IN UDP_IO *UdpIo, IN EFI_STATUS IoStatus, IN UDP_IO_TO_CANCEL ToCancel, IN VOID *Context) |
UDP_IO *EFIAPI | UdpIoCreateIo (IN EFI_HANDLE Controller, IN EFI_HANDLE ImageHandle, IN UDP_IO_CONFIG Configure, IN UINT8 UdpVersion, IN VOID *Context) |
EFI_STATUS EFIAPI | UdpIoFreeIo (IN UDP_IO *UdpIo) |
VOID EFIAPI | UdpIoCleanIo (IN UDP_IO *UdpIo) |
EFI_STATUS EFIAPI | UdpIoSendDatagram (IN UDP_IO *UdpIo, IN NET_BUF *Packet, IN UDP_END_POINT *EndPoint, IN EFI_IP_ADDRESS *Gateway, IN UDP_IO_CALLBACK CallBack, IN VOID *Context) |
VOID EFIAPI | UdpIoCancelSentDatagram (IN UDP_IO *UdpIo, IN NET_BUF *Packet) |
EFI_STATUS EFIAPI | UdpIoRecvDatagram (IN UDP_IO *UdpIo, IN UDP_IO_CALLBACK CallBack, IN VOID *Context, IN UINT32 HeadLen) |
Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#define UDP_IO_RX_SIGNATURE SIGNATURE_32 ('U', 'D', 'P', 'R') |
Signatures used by UdpIo Library.
#define UDP_IO_SIGNATURE SIGNATURE_32 ('U', 'D', 'P', 'I') |
#define UDP_IO_TX_SIGNATURE SIGNATURE_32 ('U', 'D', 'P', 'T') |
#define UDP_IO_UDP4_VERSION 4 |
#define UDP_IO_UDP6_VERSION 6 |
typedef IN VOID* Context |
typedef IN UDP_END_POINT* EndPoint |
typedef IN UDP_END_POINT IN EFI_STATUS IoStatus |
typedef BOOLEAN | ( | EFIAPI * | UDP_IO_TO_CANCEL | ) |
The select function to decide whether to cancel the UDP_TX_TOKEN.
[in] | Token | The UDP_TX_TOKEN to decide whether to cancel. |
[in] | Context | User-defined data in UdpIoCancelDgrams(). |
TRUE | Cancel the UDP_TX_TOKEN. | |
FALSE | Do not cancel this UDP_TX_TOKEN. |
typedef EFI_STATUS | ( | EFIAPI * | UDP_IO_CONFIG | ) |
The prototype called when UdpIo Library configures a UDP instance.
The prototype is set and called when creating a UDP_IO in UdpIoCreatePort().
[in] | UdpIo | The UDP_IO to configure. |
[in] | Context | The user-defined data when calling UdpIoCreatePort(). |
EFI_SUCCESS | The configuration succeeded. | |
Others | The UDP_IO fails to configure indicating UdpIoCreatePort() should fail. |
VOID EFIAPI UdpIoCancelDgrams | ( | IN UDP_IO * | UdpIo, | |
IN EFI_STATUS | IoStatus, | |||
IN UDP_IO_TO_CANCEL | ToCancel, | |||
IN VOID * | Context | |||
) |
Cancel all the sent datagram that pass the selection criteria of ToCancel. If ToCancel is NULL, all the datagrams are cancelled.
[in] | UdpIo | The UDP_IO to cancel packet. |
[in] | IoStatus | The IoStatus to return to the packet owners. |
[in] | ToCancel | The select funtion to test whether to cancel this packet or not. |
[in] | Context | The opaque parameter to the ToCancel. |
Cancel a single sent datagram.
[in] | UdpIo | The UDP_IO from which to cancel the packet |
[in] | Packet | The packet to cancel |
VOID EFIAPI UdpIoCleanIo | ( | IN UDP_IO * | UdpIo | ) |
Cleans up the UDP_IO without freeing it. Call this function if you intend to later re-use the UDP_IO.
This function releases all transmitted datagrams and receive requests and configures NULL for the UDP instance.
[in] | UdpIo | The UDP_IO to clean up. |
UDP_IO* EFIAPI UdpIoCreateIo | ( | IN EFI_HANDLE | Controller, | |
IN EFI_HANDLE | ImageHandle, | |||
IN UDP_IO_CONFIG | Configure, | |||
IN UINT8 | UdpVersion, | |||
IN VOID * | Context | |||
) |
Creates a UDP_IO to access the UDP service. It creates and configures a UDP child.
It locates the UDP service binding prototype on the Controller parameter uses the UDP service binding prototype to create a UDP child (also known as a UDP instance) configures the UDP child by calling Configure function prototype. Any failures in creating or configuring the UDP child return NULL for failure.
[in] | Controller | The controller that has the UDP service binding. protocol installed. |
[in] | ImageHandle | The image handle for the driver. |
[in] | Configure | The function to configure the created UDP child. |
[in] | UdpVersion | The UDP protocol version, UDP4 or UDP6. |
[in] | Context | The opaque parameter for the Configure funtion. |
EFI_STATUS EFIAPI UdpIoFreeIo | ( | IN UDP_IO * | UdpIo | ) |
Free the UDP_IO and all its related resources.
The function cancels all sent datagrams and receive requests.
[in] | UdpIo | The UDP_IO to free. |
EFI_SUCCESS | The UDP_IO is freed. |
EFI_STATUS EFIAPI UdpIoRecvDatagram | ( | IN UDP_IO * | UdpIo, | |
IN UDP_IO_CALLBACK | CallBack, | |||
IN VOID * | Context, | |||
IN UINT32 | HeadLen | |||
) |
Issue a receive request to the UDP_IO.
This function is called when upper-layer needs packet from UDP for processing. Only one receive request is acceptable at a time. Therefore, one common usage model is to invoke this function inside its Callback function when the former packet is processed.
[in] | UdpIo | The UDP_IO to receive the packet from. |
[in] | CallBack | The call back function to execute when the packet is received. |
[in] | Context | The opaque context passed to Callback. |
[in] | HeadLen | The length of the upper-layer's protocol header. |
EFI_ALREADY_STARTED | There is already a pending receive request. Only one receive request is supported at a time. | |
EFI_OUT_OF_RESOURCES | Failed to allocate needed resources. | |
EFI_SUCCESS | The receive request was issued successfully. | |
EFI_UNSUPPORTED | The UDP version in UDP_IO is not supported. |
EFI_STATUS EFIAPI UdpIoSendDatagram | ( | IN UDP_IO * | UdpIo, | |
IN NET_BUF * | Packet, | |||
IN UDP_END_POINT * | EndPoint, | |||
IN EFI_IP_ADDRESS * | Gateway, | |||
IN UDP_IO_CALLBACK | CallBack, | |||
IN VOID * | Context | |||
) |
Send a packet through the UDP_IO.
The packet will be wrapped in UDP_TX_TOKEN. Function Callback will be called when the packet is sent. The optional parameter EndPoint overrides the default address pair if specified.
[in] | UdpIo | The UDP_IO to send the packet through. |
[in] | Packet | The packet to send. |
[in] | EndPoint | The local and remote access point. Override the default address pair set during configuration. |
[in] | Gateway | The gateway to use. |
[in] | CallBack | The function being called when packet is transmitted or failed. |
[in] | Context | The opaque parameter passed to CallBack. |
EFI_OUT_OF_RESOURCES | Failed to allocate resource for the packet. | |
EFI_SUCCESS | The packet is successfully delivered to UDP for transmission. |
typedef VOID | ( | EFIAPI * | UDP_IO_CALLBACK | ) |
Prototype called when receiving or sending packets to or from a UDP point.
This prototype is used by both receive and sending when calling UdpIoRecvDatagram() or UdpIoSendDatagram(). When receiving, Netbuf is allocated by the UDP access point and released by the user. When sending, the user allocates the the NetBuf, which is then provided to the callback as a reference.
[in] | Packet | The packet received or sent. |
[in] | EndPoint | The UDP address pair corresponds to the UDP IO. |
[in] | IoStatus | The packet receiving or sending status. |
[in] | Context | The user-defined data when calling UdpIoRecvDatagram() or UdpIoSendDatagram(). |