4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/** @file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This library is used to share code between UEFI network stack modules.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync It provides the helper routines to access UDP service. It is used by both DHCP and MTFTP.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncare licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncwhich accompanies this distribution. The full text of the license may be found at<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynchttp://opensource.org/licenses/bsd-license.php
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#ifndef _UDP_IO_H_
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define _UDP_IO_H_
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Protocol/Udp4.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Protocol/Udp6.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Library/NetLib.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _UDP_IO UDP_IO;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Signatures used by UdpIo Library.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define UDP_IO_RX_SIGNATURE SIGNATURE_32 ('U', 'D', 'P', 'R')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define UDP_IO_TX_SIGNATURE SIGNATURE_32 ('U', 'D', 'P', 'T')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define UDP_IO_SIGNATURE SIGNATURE_32 ('U', 'D', 'P', 'I')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define UDP_IO_UDP4_VERSION 4
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define UDP_IO_UDP6_VERSION 6
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The UDP address pair.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IP_ADDRESS LocalAddr;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT16 LocalPort;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IP_ADDRESS RemoteAddr;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT16 RemotePort;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} UDP_END_POINT;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Prototype called when receiving or sending packets to or from a UDP point.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This prototype is used by both receive and sending when calling
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UdpIoRecvDatagram() or UdpIoSendDatagram(). When receiving, Netbuf is allocated by the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UDP access point and released by the user. When sending, the user allocates the the NetBuf,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which is then provided to the callback as a reference.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Packet The packet received or sent.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] EndPoint The UDP address pair corresponds to the UDP IO.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] IoStatus The packet receiving or sending status.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Context The user-defined data when calling UdpIoRecvDatagram() or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UdpIoSendDatagram().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncVOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync(EFIAPI *UDP_IO_CALLBACK) (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN NET_BUF *Packet,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UDP_END_POINT *EndPoint,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_STATUS IoStatus,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN VOID *Context
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// This structure is used internally by the UdpIo Library.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Each receive request is wrapped in an UDP_RX_TOKEN. Upon completion,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// the CallBack will be called. Only one receive request is sent to UDP at a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// time. HeadLen gives the length of the application's header. UDP_IO will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// make the application's header continuous before delivering up.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef union {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_UDP4_COMPLETION_TOKEN Udp4;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_UDP6_COMPLETION_TOKEN Udp6;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} UDP_COMPLETION_TOKEN;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 Signature;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UDP_IO *UdpIo;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UDP_IO_CALLBACK CallBack;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync VOID *Context;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 HeadLen;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UDP_COMPLETION_TOKEN Token;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} UDP_RX_TOKEN;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// This structure is used internally by UdpIo Library.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Each transmit request is wrapped in an UDP_TX_TOKEN. Upon completion,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// the CallBack will be called. There can be several transmit requests. All transmit
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// requests are linked in a list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef union {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_UDP4_SESSION_DATA Udp4;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_UDP6_SESSION_DATA Udp6;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} UDP_SESSION_DATA;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef union {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_UDP4_TRANSMIT_DATA Udp4;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_UDP6_TRANSMIT_DATA Udp6;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} UDP_TRANSMIT_DATA;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 Signature;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync LIST_ENTRY Link;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UDP_IO *UdpIo;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UDP_IO_CALLBACK CallBack;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NET_BUF *Packet;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync VOID *Context;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPv4_ADDRESS Gateway;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UDP_SESSION_DATA Session;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UDP_COMPLETION_TOKEN Token;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UDP_TRANSMIT_DATA Data;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} UDP_TX_TOKEN;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Type defined as UDP_IO.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// This data structure wraps the UDP instance and configuration.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// UdpIo Library uses this structure for all Udp4 or Udp6 operations.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncstruct _UDP_IO {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 Signature;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync LIST_ENTRY Link;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync INTN RefCnt;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 UdpVersion;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Handle used to create/destory UDP child
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_HANDLE Controller;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_HANDLE Image;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_HANDLE UdpHandle;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_SIMPLE_NETWORK_MODE SnpMode;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync LIST_ENTRY SentDatagram; ///< A list of UDP_TX_TOKEN.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UDP_RX_TOKEN *RecvRequest;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync union {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_UDP4_PROTOCOL *Udp4;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_UDP6_PROTOCOL *Udp6;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync } Protocol;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync union {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_UDP4_CONFIG_DATA Udp4;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_UDP6_CONFIG_DATA Udp6;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync } Config;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync};
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The prototype called when UdpIo Library configures a UDP instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The prototype is set and called when creating a UDP_IO in UdpIoCreatePort().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] UdpIo The UDP_IO to configure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Context The user-defined data when calling UdpIoCreatePort().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The configuration succeeded.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval Others The UDP_IO fails to configure indicating
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UdpIoCreatePort() should fail.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync(EFIAPI *UDP_IO_CONFIG) (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UDP_IO *UdpIo,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN VOID *Context
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The select function to decide whether to cancel the UDP_TX_TOKEN.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Token The UDP_TX_TOKEN to decide whether to cancel.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Context User-defined data in UdpIoCancelDgrams().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE Cancel the UDP_TX_TOKEN.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE Do not cancel this UDP_TX_TOKEN.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncBOOLEAN
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync(EFIAPI *UDP_IO_TO_CANCEL) (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UDP_TX_TOKEN *Token,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN VOID *Context
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Cancel all the sent datagram that pass the selection criteria of ToCancel.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If ToCancel is NULL, all the datagrams are cancelled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] UdpIo The UDP_IO to cancel packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] IoStatus The IoStatus to return to the packet owners.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ToCancel The select funtion to test whether to cancel this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync packet or not.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Context The opaque parameter to the ToCancel.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncVOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncUdpIoCancelDgrams (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UDP_IO *UdpIo,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_STATUS IoStatus,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UDP_IO_TO_CANCEL ToCancel, OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN VOID *Context
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Creates a UDP_IO to access the UDP service. It creates and configures
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync a UDP child.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync It locates the UDP service binding prototype on the Controller parameter
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync uses the UDP service binding prototype to create a UDP child (also known as
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync a UDP instance) configures the UDP child by calling Configure function prototype.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Any failures in creating or configuring the UDP child return NULL for failure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Controller The controller that has the UDP service binding.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync protocol installed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ImageHandle The image handle for the driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Configure The function to configure the created UDP child.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] UdpVersion The UDP protocol version, UDP4 or UDP6.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Context The opaque parameter for the Configure funtion.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The newly-created UDP_IO, or NULL if failed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncUDP_IO *
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncUdpIoCreateIo (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_HANDLE Controller,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_HANDLE ImageHandle,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UDP_IO_CONFIG Configure,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT8 UdpVersion,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN VOID *Context
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Free the UDP_IO and all its related resources.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The function cancels all sent datagrams and receive requests.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] UdpIo The UDP_IO to free.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The UDP_IO is freed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncUdpIoFreeIo (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UDP_IO *UdpIo
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Cleans up the UDP_IO without freeing it. Call this function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if you intend to later re-use the UDP_IO.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function releases all transmitted datagrams and receive requests and configures NULL for the UDP instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] UdpIo The UDP_IO to clean up.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncVOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncUdpIoCleanIo (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UDP_IO *UdpIo
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Send a packet through the UDP_IO.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The packet will be wrapped in UDP_TX_TOKEN. Function Callback will be called
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync when the packet is sent. The optional parameter EndPoint overrides the default
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync address pair if specified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] UdpIo The UDP_IO to send the packet through.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Packet The packet to send.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] EndPoint The local and remote access point. Override the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync default address pair set during configuration.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Gateway The gateway to use.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] CallBack The function being called when packet is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync transmitted or failed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Context The opaque parameter passed to CallBack.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Failed to allocate resource for the packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The packet is successfully delivered to UDP for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync transmission.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncUdpIoSendDatagram (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UDP_IO *UdpIo,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN NET_BUF *Packet,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UDP_END_POINT *EndPoint OPTIONAL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_IP_ADDRESS *Gateway OPTIONAL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UDP_IO_CALLBACK CallBack,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN VOID *Context
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Cancel a single sent datagram.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] UdpIo The UDP_IO from which to cancel the packet
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Packet The packet to cancel
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncVOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncUdpIoCancelSentDatagram (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UDP_IO *UdpIo,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN NET_BUF *Packet
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Issue a receive request to the UDP_IO.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is called when upper-layer needs packet from UDP for processing.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Only one receive request is acceptable at a time. Therefore, one common usage model is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to invoke this function inside its Callback function when the former packet
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is processed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] UdpIo The UDP_IO to receive the packet from.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] CallBack The call back function to execute when the packet
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Context The opaque context passed to Callback.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] HeadLen The length of the upper-layer's protocol header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ALREADY_STARTED There is already a pending receive request. Only
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync one receive request is supported at a time.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The receive request was issued successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The UDP version in UDP_IO is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncUdpIoRecvDatagram (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UDP_IO *UdpIo,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UDP_IO_CALLBACK CallBack,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN VOID *Context,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT32 HeadLen
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#endif
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync