MdePkg/Include/Protocol/Udp4.h

   1 /** @file
   2   UDP4 Service Binding Protocol as defined in UEFI specification.
   3
   4   The EFI UDPv4 Protocol provides simple packet-oriented services
   5   to transmit and receive UDP packets.
   6
   7 Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>
   8 This program and the accompanying materials are licensed and made available under
   9 the terms and conditions of the BSD License that accompanies this distribution.
  10 The full text of the license may be found at
  11 http://opensource.org/licenses/bsd-license.php.
  12
  13 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  14 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  15
  16   @par Revision Reference:
  17   This Protocol is introduced in UEFI Specification 2.0.
  18
  19 **/
  20
  21 #ifndef __EFI_UDP4_PROTOCOL_H__
  22 #define __EFI_UDP4_PROTOCOL_H__
  23
  24 #include <Protocol/Ip4.h>
  25 //
  26 //GUID definitions
  27 //
  28 #define EFI_UDP4_SERVICE_BINDING_PROTOCOL_GUID \
  29   { \
  30     0x83f01464, 0x99bd, 0x45e5, {0xb3, 0x83, 0xaf, 0x63, 0x05, 0xd8, 0xe9, 0xe6 } \
  31   }
  32
  33 #define EFI_UDP4_PROTOCOL_GUID \
  34   { \
  35     0x3ad9df29, 0x4501, 0x478d, {0xb1, 0xf8, 0x7f, 0x7f, 0xe7, 0x0e, 0x50, 0xf3 } \
  36   }
  37
  38 typedef struct _EFI_UDP4_PROTOCOL EFI_UDP4_PROTOCOL;
  39
  40 typedef struct {
  41   EFI_HANDLE              InstanceHandle;
  42   EFI_IPv4_ADDRESS        LocalAddress;
  43   UINT16                  LocalPort;
  44   EFI_IPv4_ADDRESS        RemoteAddress;
  45   UINT16                  RemotePort;
  46 } EFI_UDP4_SERVICE_POINT;
  47
  48 typedef struct {
  49   EFI_HANDLE              DriverHandle;
  50   UINT32                  ServiceCount;
  51   EFI_UDP4_SERVICE_POINT  Services[1];
  52 } EFI_UDP4_VARIABLE_DATA;
  53
  54 typedef struct {
  55   UINT32             FragmentLength;
  56   VOID               *FragmentBuffer;
  57 } EFI_UDP4_FRAGMENT_DATA;
  58
  59 typedef struct {
  60   EFI_IPv4_ADDRESS   SourceAddress;
  61   UINT16             SourcePort;
  62   EFI_IPv4_ADDRESS   DestinationAddress;
  63   UINT16             DestinationPort;
  64 } EFI_UDP4_SESSION_DATA;
  65 typedef struct {
  66   //
  67   // Receiving Filters
  68   //
  69   BOOLEAN            AcceptBroadcast;
  70   BOOLEAN            AcceptPromiscuous;
  71   BOOLEAN            AcceptAnyPort;
  72   BOOLEAN            AllowDuplicatePort;
  73   //
  74   // I/O parameters
  75   //
  76   UINT8              TypeOfService;
  77   UINT8              TimeToLive;
  78   BOOLEAN            DoNotFragment;
  79   UINT32             ReceiveTimeout;
  80   UINT32             TransmitTimeout;
  81   //
  82   // Access Point
  83   //
  84   BOOLEAN            UseDefaultAddress;
  85   EFI_IPv4_ADDRESS   StationAddress;
  86   EFI_IPv4_ADDRESS   SubnetMask;
  87   UINT16             StationPort;
  88   EFI_IPv4_ADDRESS   RemoteAddress;
  89   UINT16             RemotePort;
  90 } EFI_UDP4_CONFIG_DATA;
  91
  92 typedef struct {
  93   EFI_UDP4_SESSION_DATA     *UdpSessionData;       //OPTIONAL
  94   EFI_IPv4_ADDRESS          *GatewayAddress;       //OPTIONAL
  95   UINT32                    DataLength;
  96   UINT32                    FragmentCount;
  97   EFI_UDP4_FRAGMENT_DATA    FragmentTable[1];
  98 } EFI_UDP4_TRANSMIT_DATA;
  99
 100 typedef struct {
 101   EFI_TIME                  TimeStamp;
 102   EFI_EVENT                 RecycleSignal;
 103   EFI_UDP4_SESSION_DATA     UdpSession;
 104   UINT32                    DataLength;
 105   UINT32                    FragmentCount;
 106   EFI_UDP4_FRAGMENT_DATA    FragmentTable[1];
 107 } EFI_UDP4_RECEIVE_DATA;
 108
 109
 110 typedef struct {
 111   EFI_EVENT                 Event;
 112   EFI_STATUS                Status;
 113   union {
 114     EFI_UDP4_RECEIVE_DATA   *RxData;
 115     EFI_UDP4_TRANSMIT_DATA  *TxData;
 116   } Packet;
 117 } EFI_UDP4_COMPLETION_TOKEN;
 118
 119 /**
 120   Reads the current operational settings.
 121
 122   The GetModeData() function copies the current operational settings of this EFI
 123   UDPv4 Protocol instance into user-supplied buffers. This function is used
 124   optionally to retrieve the operational mode data of underlying networks or
 125   drivers.
 126
 127   @param  This           The pointer to the EFI_UDP4_PROTOCOL instance.
 128   @param  Udp4ConfigData The pointer to the buffer to receive the current configuration data.
 129   @param  Ip4ModeData    The pointer to the EFI IPv4 Protocol mode data structure.
 130   @param  MnpConfigData  The pointer to the managed network configuration data structure.
 131   @param  SnpModeData    The pointer to the simple network mode data structure.
 132
 133   @retval EFI_SUCCESS           The mode data was read.
 134   @retval EFI_NOT_STARTED       When Udp4ConfigData is queried, no configuration data is
 135                                 available because this instance has not been started.
 136   @retval EFI_INVALID_PARAMETER This is NULL.
 137
 138 **/
 139 typedef
 140 EFI_STATUS
 141 (EFIAPI *EFI_UDP4_GET_MODE_DATA)(
 142   IN  EFI_UDP4_PROTOCOL                *This,
 143   OUT EFI_UDP4_CONFIG_DATA             *Udp4ConfigData OPTIONAL,
 144   OUT EFI_IP4_MODE_DATA                *Ip4ModeData    OPTIONAL,
 145   OUT EFI_MANAGED_NETWORK_CONFIG_DATA  *MnpConfigData  OPTIONAL,
 146   OUT EFI_SIMPLE_NETWORK_MODE          *SnpModeData    OPTIONAL
 147   );
 148
 149
 150 /**
 151   Initializes, changes, or resets the operational parameters for this instance of the EFI UDPv4
 152   Protocol.
 153
 154   The Configure() function is used to do the following:
 155   * Initialize and start this instance of the EFI UDPv4 Protocol.
 156   * Change the filtering rules and operational parameters.
 157   * Reset this instance of the EFI UDPv4 Protocol.
 158   Until these parameters are initialized, no network traffic can be sent or
 159   received by this instance. This instance can be also reset by calling Configure()
 160   with UdpConfigData set to NULL. Once reset, the receiving queue and transmitting
 161   queue are flushed and no traffic is allowed through this instance.
 162   With different parameters in UdpConfigData, Configure() can be used to bind
 163   this instance to specified port.
 164
 165   @param  This           The pointer to the EFI_UDP4_PROTOCOL instance.
 166   @param  Udp4ConfigData The pointer to the buffer to receive the current configuration data.
 167
 168   @retval EFI_SUCCESS           The configuration settings were set, changed, or reset successfully.
 169   @retval EFI_NO_MAPPING        When using a default address, configuration (DHCP, BOOTP,
 170                                 RARP, etc.) is not finished yet.
 171   @retval EFI_INVALID_PARAMETER This is NULL.
 172   @retval EFI_INVALID_PARAMETER UdpConfigData.StationAddress is not a valid unicast IPv4 address.
 173   @retval EFI_ALREADY_STARTED   The EFI UDPv4 Protocol instance is already started/configured
 174                                 and must be stopped/reset before it can be reconfigured.
 175   @retval EFI_ACCESS_DENIED     UdpConfigData. AllowDuplicatePort is FALSE
 176                                 and UdpConfigData.StationPort is already used by
 177                                 other instance.
 178   @retval EFI_OUT_OF_RESOURCES  The EFI UDPv4 Protocol driver cannot allocate memory for this
 179                                 EFI UDPv4 Protocol instance.
 180   @retval EFI_DEVICE_ERROR      An unexpected network or system error occurred and this instance
 181                                  was not opened.
 182
 183 **/
 184 typedef
 185 EFI_STATUS
 186 (EFIAPI *EFI_UDP4_CONFIGURE)(
 187   IN EFI_UDP4_PROTOCOL      *This,
 188   IN EFI_UDP4_CONFIG_DATA   *UdpConfigData OPTIONAL
 189   );
 190
 191 /**
 192   Joins and leaves multicast groups.
 193
 194   The Groups() function is used to enable and disable the multicast group
 195   filtering. If the JoinFlag is FALSE and the MulticastAddress is NULL, then all
 196   currently joined groups are left.
 197
 198   @param  This             The pointer to the EFI_UDP4_PROTOCOL instance.
 199   @param  JoinFlag         Set to TRUE to join a multicast group. Set to FALSE to leave one
 200                            or all multicast groups.
 201   @param  MulticastAddress The pointer to multicast group address to join or leave.
 202
 203   @retval EFI_SUCCESS           The operation completed successfully.
 204   @retval EFI_NOT_STARTED       The EFI UDPv4 Protocol instance has not been started.
 205   @retval EFI_NO_MAPPING        When using a default address, configuration (DHCP, BOOTP,
 206                                 RARP, etc.) is not finished yet.
 207   @retval EFI_OUT_OF_RESOURCES  Could not allocate resources to join the group.
 208   @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
 209                                 - This is NULL.
 210                                 - JoinFlag is TRUE and MulticastAddress is NULL.
 211                                 - JoinFlag is TRUE and *MulticastAddress is not
 212                                   a valid multicast address.
 213   @retval EFI_ALREADY_STARTED   The group address is already in the group table (when
 214                                 JoinFlag is TRUE).
 215   @retval EFI_NOT_FOUND         The group address is not in the group table (when JoinFlag is
 216                                 FALSE).
 217   @retval EFI_DEVICE_ERROR      An unexpected system or network error occurred.
 218
 219 **/
 220 typedef
 221 EFI_STATUS
 222 (EFIAPI *EFI_UDP4_GROUPS)(
 223   IN EFI_UDP4_PROTOCOL      *This,
 224   IN BOOLEAN                JoinFlag,
 225   IN EFI_IPv4_ADDRESS       *MulticastAddress    OPTIONAL
 226   );
 227
 228 /**
 229   Adds and deletes routing table entries.
 230
 231   The Routes() function adds a route to or deletes a route from the routing table.
 232   Routes are determined by comparing the SubnetAddress with the destination IP
 233   address and arithmetically AND-ing it with the SubnetMask. The gateway address
 234   must be on the same subnet as the configured station address.
 235   The default route is added with SubnetAddress and SubnetMask both set to 0.0.0.0.
 236   The default route matches all destination IP addresses that do not match any
 237   other routes.
 238   A zero GatewayAddress is a nonroute. Packets are sent to the destination IP
 239   address if it can be found in the Address Resolution Protocol (ARP) cache or
 240   on the local subnet. One automatic nonroute entry will be inserted into the
 241   routing table for outgoing packets that are addressed to a local subnet
 242   (gateway address of 0.0.0.0).
 243   Each instance of the EFI UDPv4 Protocol has its own independent routing table.
 244   Instances of the EFI UDPv4 Protocol that use the default IP address will also
 245   have copies of the routing table provided by the EFI_IP4_CONFIG_PROTOCOL. These
 246   copies will be updated automatically whenever the IP driver reconfigures its
 247   instances; as a result, the previous modification to these copies will be lost.
 248
 249   @param  This           The pointer to the EFI_UDP4_PROTOCOL instance.
 250   @param  DeleteRoute    Set to TRUE to delete this route from the routing table.
 251                          Set to FALSE to add this route to the routing table.
 252   @param  SubnetAddress  The destination network address that needs to be routed.
 253   @param  SubnetMask     The subnet mask of SubnetAddress.
 254   @param  GatewayAddress The gateway IP address for this route.
 255
 256   @retval EFI_SUCCESS           The operation completed successfully.
 257   @retval EFI_NOT_STARTED       The EFI UDPv4 Protocol instance has not been started.
 258   @retval EFI_NO_MAPPING        When using a default address, configuration (DHCP, BOOTP,
 259                                 - RARP, etc.) is not finished yet.
 260   @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
 261   @retval EFI_OUT_OF_RESOURCES  Could not add the entry to the routing table.
 262   @retval EFI_NOT_FOUND         This route is not in the routing table.
 263   @retval EFI_ACCESS_DENIED     The route is already defined in the routing table.
 264
 265 **/
 266 typedef
 267 EFI_STATUS
 268 (EFIAPI *EFI_UDP4_ROUTES)(
 269   IN EFI_UDP4_PROTOCOL      *This,
 270   IN BOOLEAN                DeleteRoute,
 271   IN EFI_IPv4_ADDRESS       *SubnetAddress,
 272   IN EFI_IPv4_ADDRESS       *SubnetMask,
 273   IN EFI_IPv4_ADDRESS       *GatewayAddress
 274   );
 275
 276 /**
 277   Polls for incoming data packets and processes outgoing data packets.
 278
 279   The Poll() function can be used by network drivers and applications to increase
 280   the rate that data packets are moved between the communications device and the
 281   transmit and receive queues.
 282   In some systems, the periodic timer event in the managed network driver may not
 283   poll the underlying communications device fast enough to transmit and/or receive
 284   all data packets without missing incoming packets or dropping outgoing packets.
 285   Drivers and applications that are experiencing packet loss should try calling
 286   the Poll() function more often.
 287
 288   @param  This The pointer to the EFI_UDP4_PROTOCOL instance.
 289
 290   @retval EFI_SUCCESS           Incoming or outgoing data was processed.
 291   @retval EFI_INVALID_PARAMETER This is NULL.
 292   @retval EFI_DEVICE_ERROR      An unexpected system or network error occurred.
 293   @retval EFI_TIMEOUT           Data was dropped out of the transmit and/or receive queue.
 294
 295 **/
 296 typedef
 297 EFI_STATUS
 298 (EFIAPI *EFI_UDP4_POLL)(
 299   IN EFI_UDP4_PROTOCOL      *This
 300   );
 301
 302 /**
 303   Places an asynchronous receive request into the receiving queue.
 304
 305   The Receive() function places a completion token into the receive packet queue.
 306   This function is always asynchronous.
 307   The caller must fill in the Token.Event field in the completion token, and this
 308   field cannot be NULL. When the receive operation completes, the EFI UDPv4 Protocol
 309   driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event
 310   is signaled. Providing a proper notification function and context for the event
 311   will enable the user to receive the notification and receiving status. That
 312   notification function is guaranteed to not be re-entered.
 313
 314   @param  This  The pointer to the EFI_UDP4_PROTOCOL instance.
 315   @param  Token The pointer to a token that is associated with the receive data
 316                 descriptor.
 317
 318   @retval EFI_SUCCESS           The receive completion token was cached.
 319   @retval EFI_NOT_STARTED       This EFI UDPv4 Protocol instance has not been started.
 320   @retval EFI_NO_MAPPING        When using a default address, configuration (DHCP, BOOTP, RARP, etc.)
 321                                 is not finished yet.
 322   @retval EFI_INVALID_PARAMETER This is NULL.
 323   @retval EFI_INVALID_PARAMETER UdpConfigData.StationAddress is not a valid unicast IPv4 address.
 324   @retval EFI_OUT_OF_RESOURCES  The receive completion token could not be queued due to a lack of system
 325                                 resources (usually memory).
 326   @retval EFI_DEVICE_ERROR      An unexpected system or network error occurred.
 327   @retval EFI_ACCESS_DENIED     A receive completion token with the same Token.Event was already in
 328                                 the receive queue.
 329   @retval EFI_NOT_READY         The receive request could not be queued because the receive queue is full.
 330
 331 **/
 332 typedef
 333 EFI_STATUS
 334 (EFIAPI *EFI_UDP4_RECEIVE)(
 335   IN EFI_UDP4_PROTOCOL          *This,
 336   IN EFI_UDP4_COMPLETION_TOKEN  *Token
 337   );
 338
 339 /**
 340   Queues outgoing data packets into the transmit queue.
 341
 342   The Transmit() function places a sending request to this instance of the EFI
 343   UDPv4 Protocol, alongside the transmit data that was filled by the user. Whenever
 344   the packet in the token is sent out or some errors occur, the Token.Event will
 345   be signaled and Token.Status is updated. Providing a proper notification function
 346   and context for the event will enable the user to receive the notification and
 347   transmitting status.
 348
 349   @param  This  The pointer to the EFI_UDP4_PROTOCOL instance.
 350   @param  Token The pointer to the completion token that will be placed into the
 351                 transmit queue.
 352
 353   @retval EFI_SUCCESS           The data has been queued for transmission.
 354   @retval EFI_NOT_STARTED       This EFI UDPv4 Protocol instance has not been started.
 355   @retval EFI_NO_MAPPING        When using a default address, configuration (DHCP, BOOTP,
 356                                 RARP, etc.) is not finished yet.
 357   @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
 358   @retval EFI_ACCESS_DENIED     The transmit completion token with the same
 359                                 Token.Event was already in the transmit queue.
 360   @retval EFI_NOT_READY         The completion token could not be queued because the
 361                                 transmit queue is full.
 362   @retval EFI_OUT_OF_RESOURCES  Could not queue the transmit data.
 363   @retval EFI_NOT_FOUND         There is no route to the destination network or address.
 364   @retval EFI_BAD_BUFFER_SIZE   The data length is greater than the maximum UDP packet
 365                                 size. Or the length of the IP header + UDP header + data
 366                                 length is greater than MTU if DoNotFragment is TRUE.
 367
 368 **/
 369 typedef
 370 EFI_STATUS
 371 (EFIAPI *EFI_UDP4_TRANSMIT)(
 372   IN EFI_UDP4_PROTOCOL           *This,
 373   IN EFI_UDP4_COMPLETION_TOKEN   *Token
 374   );
 375
 376 /**
 377   Aborts an asynchronous transmit or receive request.
 378
 379   The Cancel() function is used to abort a pending transmit or receive request.
 380   If the token is in the transmit or receive request queues, after calling this
 381   function, Token.Status will be set to EFI_ABORTED and then Token.Event will be
 382   signaled. If the token is not in one of the queues, which usually means that
 383   the asynchronous operation has completed, this function will not signal the
 384   token and EFI_NOT_FOUND is returned.
 385
 386   @param  This  The pointer to the EFI_UDP4_PROTOCOL instance.
 387   @param  Token The pointer to a token that has been issued by
 388                 EFI_UDP4_PROTOCOL.Transmit() or
 389                 EFI_UDP4_PROTOCOL.Receive().If NULL, all pending
 390                 tokens are aborted.
 391
 392   @retval  EFI_SUCCESS           The asynchronous I/O request was aborted and Token.Event
 393                                  was signaled. When Token is NULL, all pending requests are
 394                                  aborted and their events are signaled.
 395   @retval  EFI_INVALID_PARAMETER This is NULL.
 396   @retval  EFI_NOT_STARTED       This instance has not been started.
 397   @retval  EFI_NO_MAPPING        When using the default address, configuration (DHCP, BOOTP,
 398                                  RARP, etc.) is not finished yet.
 399   @retval  EFI_NOT_FOUND         When Token is not NULL, the asynchronous I/O request was
 400                                  not found in the transmit or receive queue. It has either completed
 401                                  or was not issued by Transmit() and Receive().
 402
 403 **/
 404 typedef
 405 EFI_STATUS
 406 (EFIAPI *EFI_UDP4_CANCEL)(
 407   IN EFI_UDP4_PROTOCOL          *This,
 408   IN EFI_UDP4_COMPLETION_TOKEN  *Token  OPTIONAL
 409   );
 410
 411 ///
 412 /// The EFI_UDP4_PROTOCOL defines an EFI UDPv4 Protocol session that can be used
 413 /// by any network drivers, applications, or daemons to transmit or receive UDP packets.
 414 /// This protocol instance can either be bound to a specified port as a service or
 415 /// connected to some remote peer as an active client. Each instance has its own settings,
 416 /// such as the routing table and group table, which are independent from each other.
 417 ///
 418 struct _EFI_UDP4_PROTOCOL {
 419   EFI_UDP4_GET_MODE_DATA        GetModeData;
 420   EFI_UDP4_CONFIGURE            Configure;
 421   EFI_UDP4_GROUPS               Groups;
 422   EFI_UDP4_ROUTES               Routes;
 423   EFI_UDP4_TRANSMIT             Transmit;
 424   EFI_UDP4_RECEIVE              Receive;
 425   EFI_UDP4_CANCEL               Cancel;
 426   EFI_UDP4_POLL                 Poll;
 427 };
 428
 429 extern EFI_GUID gEfiUdp4ServiceBindingProtocolGuid;
 430 extern EFI_GUID gEfiUdp4ProtocolGuid;
 431
 432 #endif