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