X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdePkg%2FInclude%2FProtocol%2FUdp4.h;h=5541f5e692ae716b7323ad09f55efce6dc4bcc61;hp=7ac3c80f6c67be8b426673bda79ce9defd7d8344;hb=a89fa50ccf7a29405e3d24c49625dbd70cdba9fa;hpb=878ddf1fc3540a715f63594ed22b6929e881afb4 diff --git a/MdePkg/Include/Protocol/Udp4.h b/MdePkg/Include/Protocol/Udp4.h index 7ac3c80f6c..5541f5e692 100644 --- a/MdePkg/Include/Protocol/Udp4.h +++ b/MdePkg/Include/Protocol/Udp4.h @@ -1,20 +1,27 @@ /** @file - Copyright (c) 2006, 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 + UDP4 Service Binding Protocol as defined in UEFI specification. - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + The EFI UDPv4 Protocol provides simple packet-oriented services + to transmit and receive UDP packets. - Module Name: Udp4.h +Copyright (c) 2006 - 2010, 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 that 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. + + @par Revision Reference: + This Protocol is introduced in UEFI Specification 2.0. **/ #ifndef __EFI_UDP4_PROTOCOL_H__ #define __EFI_UDP4_PROTOCOL_H__ +#include // //GUID definitions // @@ -44,15 +51,6 @@ typedef struct { EFI_UDP4_SERVICE_POINT Services[1]; } EFI_UDP4_VARIABLE_DATA; -// -//ICMP error definitions -// -#define EFI_NETWORK_UNREACHABLE EFIERR(100) -#define EFI_HOST_UNREACHABLE EFIERR(101) -#define EFI_PROTOCOL_UNREACHABLE EFIERR(102) -#define EFI_PORT_UNREACHABLE EFIERR(103) - - typedef struct { UINT32 FragmentLength; VOID *FragmentBuffer; @@ -121,11 +119,16 @@ typedef struct { /** Reads the current operational settings. - @param This Pointer to the EFI_UDP4_PROTOCOL instance. - @param Udp4ConfigData Pointer to the buffer to receive the current configuration data. - @param Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure. - @param MnpConfigData Pointer to the managed network configuration data structure. - @param SnpModeData Pointer to the simple network mode data structure. + The GetModeData() function copies the current operational settings of this EFI + UDPv4 Protocol instance into user-supplied buffers. This function is used + optionally to retrieve the operational mode data of underlying networks or + drivers. + + @param This The pointer to the EFI_UDP4_PROTOCOL instance. + @param Udp4ConfigData The pointer to the buffer to receive the current configuration data. + @param Ip4ModeData The pointer to the EFI IPv4 Protocol mode data structure. + @param MnpConfigData The pointer to the managed network configuration data structure. + @param SnpModeData The pointer to the simple network mode data structure. @retval EFI_SUCCESS The mode data was read. @retval EFI_NOT_STARTED When Udp4ConfigData is queried, no configuration data is @@ -135,27 +138,38 @@ typedef struct { **/ typedef EFI_STATUS -(EFIAPI *EFI_UDP4_GET_MODE_DATA) ( +(EFIAPI *EFI_UDP4_GET_MODE_DATA)( IN EFI_UDP4_PROTOCOL *This, OUT EFI_UDP4_CONFIG_DATA *Udp4ConfigData OPTIONAL, OUT EFI_IP4_MODE_DATA *Ip4ModeData OPTIONAL, OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL, OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL - ) -; + ); /** Initializes, changes, or resets the operational parameters for this instance of the EFI UDPv4 Protocol. - - @param This Pointer to the EFI_UDP4_PROTOCOL instance. - @param Udp4ConfigData Pointer to the buffer to receive the current configuration data. + + The Configure() function is used to do the following: + * Initialize and start this instance of the EFI UDPv4 Protocol. + * Change the filtering rules and operational parameters. + * Reset this instance of the EFI UDPv4 Protocol. + Until these parameters are initialized, no network traffic can be sent or + received by this instance. This instance can be also reset by calling Configure() + with UdpConfigData set to NULL. Once reset, the receiving queue and transmitting + queue are flushed and no traffic is allowed through this instance. + With different parameters in UdpConfigData, Configure() can be used to bind + this instance to specified port. + + @param This The pointer to the EFI_UDP4_PROTOCOL instance. + @param Udp4ConfigData The pointer to the buffer to receive the current configuration data. @retval EFI_SUCCESS The configuration settings were set, changed, or reset successfully. @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, RARP, etc.) is not finished yet. - @retval EFI_INVALID_PARAMETER One or more following conditions are TRUE: + @retval EFI_INVALID_PARAMETER This is NULL. + @retval EFI_INVALID_PARAMETER UdpConfigData.StationAddress is not a valid unicast IPv4 address. @retval EFI_ALREADY_STARTED The EFI UDPv4 Protocol instance is already started/configured and must be stopped/reset before it can be reconfigured. @retval EFI_ACCESS_DENIED UdpConfigData. AllowDuplicatePort is FALSE @@ -169,19 +183,22 @@ EFI_STATUS **/ typedef EFI_STATUS -(EFIAPI *EFI_UDP4_CONFIGURE) ( +(EFIAPI *EFI_UDP4_CONFIGURE)( IN EFI_UDP4_PROTOCOL *This, IN EFI_UDP4_CONFIG_DATA *UdpConfigData OPTIONAL - ) -; + ); /** Joins and leaves multicast groups. + + The Groups() function is used to enable and disable the multicast group + filtering. If the JoinFlag is FALSE and the MulticastAddress is NULL, then all + currently joined groups are left. - @param This Pointer to the EFI_UDP4_PROTOCOL instance. + @param This The pointer to the EFI_UDP4_PROTOCOL instance. @param JoinFlag Set to TRUE to join a multicast group. Set to FALSE to leave one or all multicast groups. - @param MulticastAddress Pointer to multicast group address to join or leave. + @param MulticastAddress The pointer to multicast group address to join or leave. @retval EFI_SUCCESS The operation completed successfully. @retval EFI_NOT_STARTED The EFI UDPv4 Protocol instance has not been started. @@ -202,17 +219,34 @@ EFI_STATUS **/ typedef EFI_STATUS -(EFIAPI *EFI_UDP4_GROUPS) ( +(EFIAPI *EFI_UDP4_GROUPS)( IN EFI_UDP4_PROTOCOL *This, IN BOOLEAN JoinFlag, IN EFI_IPv4_ADDRESS *MulticastAddress OPTIONAL - ) -; + ); /** Adds and deletes routing table entries. - - @param This Pointer to the EFI_UDP4_PROTOCOL instance. + + The Routes() function adds a route to or deletes a route from the routing table. + Routes are determined by comparing the SubnetAddress with the destination IP + address and arithmetically AND-ing it with the SubnetMask. The gateway address + must be on the same subnet as the configured station address. + The default route is added with SubnetAddress and SubnetMask both set to 0.0.0.0. + The default route matches all destination IP addresses that do not match any + other routes. + A zero GatewayAddress is a nonroute. Packets are sent to the destination IP + address if it can be found in the Address Resolution Protocol (ARP) cache or + on the local subnet. One automatic nonroute entry will be inserted into the + routing table for outgoing packets that are addressed to a local subnet + (gateway address of 0.0.0.0). + Each instance of the EFI UDPv4 Protocol has its own independent routing table. + Instances of the EFI UDPv4 Protocol that use the default IP address will also + have copies of the routing table provided by the EFI_IP4_CONFIG_PROTOCOL. These + copies will be updated automatically whenever the IP driver reconfigures its + instances; as a result, the previous modification to these copies will be lost. + + @param This The pointer to the EFI_UDP4_PROTOCOL instance. @param DeleteRoute Set to TRUE to delete this route from the routing table. Set to FALSE to add this route to the routing table. @param SubnetAddress The destination network address that needs to be routed. @@ -231,19 +265,27 @@ EFI_STATUS **/ typedef EFI_STATUS -(EFIAPI *EFI_UDP4_ROUTES) ( +(EFIAPI *EFI_UDP4_ROUTES)( IN EFI_UDP4_PROTOCOL *This, IN BOOLEAN DeleteRoute, IN EFI_IPv4_ADDRESS *SubnetAddress, IN EFI_IPv4_ADDRESS *SubnetMask, IN EFI_IPv4_ADDRESS *GatewayAddress - ) -; + ); /** Polls for incoming data packets and processes outgoing data packets. + + The Poll() function can be used by network drivers and applications to increase + the rate that data packets are moved between the communications device and the + transmit and receive queues. + In some systems, the periodic timer event in the managed network driver may not + poll the underlying communications device fast enough to transmit and/or receive + all data packets without missing incoming packets or dropping outgoing packets. + Drivers and applications that are experiencing packet loss should try calling + the Poll() function more often. - @param This Pointer to the EFI_UDP4_PROTOCOL instance. + @param This The pointer to the EFI_UDP4_PROTOCOL instance. @retval EFI_SUCCESS Incoming or outgoing data was processed. @retval EFI_INVALID_PARAMETER This is NULL. @@ -253,23 +295,32 @@ EFI_STATUS **/ typedef EFI_STATUS -(EFIAPI *EFI_UDP4_POLL) ( +(EFIAPI *EFI_UDP4_POLL)( IN EFI_UDP4_PROTOCOL *This - ) -; + ); /** Places an asynchronous receive request into the receiving queue. - - @param This Pointer to the EFI_UDP4_PROTOCOL instance. - @param Token Pointer to a token that is associated with the receive data + + The Receive() function places a completion token into the receive packet queue. + This function is always asynchronous. + The caller must fill in the Token.Event field in the completion token, and this + field cannot be NULL. When the receive operation completes, the EFI UDPv4 Protocol + driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event + is signaled. Providing a proper notification function and context for the event + will enable the user to receive the notification and receiving status. That + notification function is guaranteed to not be re-entered. + + @param This The pointer to the EFI_UDP4_PROTOCOL instance. + @param Token The pointer to a token that is associated with the receive data descriptor. @retval EFI_SUCCESS The receive completion token was cached. @retval EFI_NOT_STARTED This EFI UDPv4 Protocol instance has not been started. @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, RARP, etc.) is not finished yet. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: + @retval EFI_INVALID_PARAMETER This is NULL. + @retval EFI_INVALID_PARAMETER UdpConfigData.StationAddress is not a valid unicast IPv4 address. @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system resources (usually memory). @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. @@ -280,17 +331,23 @@ EFI_STATUS **/ typedef EFI_STATUS -(EFIAPI *EFI_UDP4_RECEIVE) ( +(EFIAPI *EFI_UDP4_RECEIVE)( IN EFI_UDP4_PROTOCOL *This, IN EFI_UDP4_COMPLETION_TOKEN *Token - ) -; + ); /** Queues outgoing data packets into the transmit queue. - - @param This Pointer to the EFI_UDP4_PROTOCOL instance. - @param Token Pointer to the completion token that will be placed into the + + The Transmit() function places a sending request to this instance of the EFI + UDPv4 Protocol, alongside the transmit data that was filled by the user. Whenever + the packet in the token is sent out or some errors occur, the Token.Event will + be signaled and Token.Status is updated. Providing a proper notification function + and context for the event will enable the user to receive the notification and + transmitting status. + + @param This The pointer to the EFI_UDP4_PROTOCOL instance. + @param Token The pointer to the completion token that will be placed into the transmit queue. @retval EFI_SUCCESS The data has been queued for transmission. @@ -311,17 +368,23 @@ EFI_STATUS **/ typedef EFI_STATUS -(EFIAPI *EFI_UDP4_TRANSMIT) ( +(EFIAPI *EFI_UDP4_TRANSMIT)( IN EFI_UDP4_PROTOCOL *This, IN EFI_UDP4_COMPLETION_TOKEN *Token - ) -; + ); /** Aborts an asynchronous transmit or receive request. - - @param This Pointer to the EFI_UDP4_PROTOCOL instance. - @param Token Pointer to a token that has been issued by + + The Cancel() function is used to abort a pending transmit or receive request. + If the token is in the transmit or receive request queues, after calling this + function, Token.Status will be set to EFI_ABORTED and then Token.Event will be + signaled. If the token is not in one of the queues, which usually means that + the asynchronous operation has completed, this function will not signal the + token and EFI_NOT_FOUND is returned. + + @param This The pointer to the EFI_UDP4_PROTOCOL instance. + @param Token The pointer to a token that has been issued by EFI_UDP4_PROTOCOL.Transmit() or EFI_UDP4_PROTOCOL.Receive().If NULL, all pending tokens are aborted. @@ -343,9 +406,15 @@ EFI_STATUS (EFIAPI *EFI_UDP4_CANCEL)( IN EFI_UDP4_PROTOCOL *This, IN EFI_UDP4_COMPLETION_TOKEN *Token OPTIONAL - ) -; - + ); + +/// +/// The EFI_UDP4_PROTOCOL defines an EFI UDPv4 Protocol session that can be used +/// by any network drivers, applications, or daemons to transmit or receive UDP packets. +/// This protocol instance can either be bound to a specified port as a service or +/// connected to some remote peer as an active client. Each instance has its own settings, +/// such as the routing table and group table, which are independent from each other. +/// struct _EFI_UDP4_PROTOCOL { EFI_UDP4_GET_MODE_DATA GetModeData; EFI_UDP4_CONFIGURE Configure;