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 One or more following conditions are TRUE:
 172   @retval EFI_ALREADY_STARTED   The EFI UDPv4 Protocol instance is already started/configured
 173                                 and must be stopped/reset before it can be reconfigured.
 174   @retval EFI_ACCESS_DENIED     UdpConfigData. AllowDuplicatePort is FALSE
 175                                 and UdpConfigData.StationPort is already used by
 176                                 other instance.
 177   @retval EFI_OUT_OF_RESOURCES  The EFI UDPv4 Protocol driver cannot allocate memory for this
 178                                 EFI UDPv4 Protocol instance.
 179   @retval EFI_DEVICE_ERROR      An unexpected network or system error occurred and this instance
 180                                  was not opened.
 181
 182 **/
 183 typedef
 184 EFI_STATUS
 185 (EFIAPI *EFI_UDP4_CONFIGURE)(
 186   IN EFI_UDP4_PROTOCOL      *This,
 187   IN EFI_UDP4_CONFIG_DATA   *UdpConfigData OPTIONAL
 188   );
 189
 190 /**
 191   Joins and leaves multicast groups.
 192
 193   The Groups() function is used to enable and disable the multicast group
 194   filtering. If the JoinFlag is FALSE and the MulticastAddress is NULL, then all
 195   currently joined groups are left.
 196
 197   @param  This             The pointer to the EFI_UDP4_PROTOCOL instance.
 198   @param  JoinFlag         Set to TRUE to join a multicast group. Set to FALSE to leave one
 199                            or all multicast groups.
 200   @param  MulticastAddress The pointer to multicast group address to join or leave.
 201
 202   @retval EFI_SUCCESS           The operation completed successfully.
 203   @retval EFI_NOT_STARTED       The EFI UDPv4 Protocol instance has not been started.
 204   @retval EFI_NO_MAPPING        When using a default address, configuration (DHCP, BOOTP,
 205                                 RARP, etc.) is not finished yet.
 206   @retval EFI_OUT_OF_RESOURCES  Could not allocate resources to join the group.
 207   @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
 208                                 - This is NULL.
 209                                 - JoinFlag is TRUE and MulticastAddress is NULL.
 210                                 - JoinFlag is TRUE and *MulticastAddress is not
 211                                   a valid multicast address.
 212   @retval EFI_ALREADY_STARTED   The group address is already in the group table (when
 213                                 JoinFlag is TRUE).
 214   @retval EFI_NOT_FOUND         The group address is not in the group table (when JoinFlag is
 215                                 FALSE).
 216   @retval EFI_DEVICE_ERROR      An unexpected system or network error occurred.
 217
 218 **/
 219 typedef
 220 EFI_STATUS
 221 (EFIAPI *EFI_UDP4_GROUPS)(
 222   IN EFI_UDP4_PROTOCOL      *This,
 223   IN BOOLEAN                JoinFlag,
 224   IN EFI_IPv4_ADDRESS       *MulticastAddress    OPTIONAL
 225   );
 226
 227 /**
 228   Adds and deletes routing table entries.
 229
 230   The Routes() function adds a route to or deletes a route from the routing table.
 231   Routes are determined by comparing the SubnetAddress with the destination IP
 232   address and arithmetically AND-ing it with the SubnetMask. The gateway address
 233   must be on the same subnet as the configured station address.
 234   The default route is added with SubnetAddress and SubnetMask both set to 0.0.0.0.
 235   The default route matches all destination IP addresses that do not match any
 236   other routes.
 237   A zero GatewayAddress is a nonroute. Packets are sent to the destination IP
 238   address if it can be found in the Address Resolution Protocol (ARP) cache or
 239   on the local subnet. One automatic nonroute entry will be inserted into the
 240   routing table for outgoing packets that are addressed to a local subnet
 241   (gateway address of 0.0.0.0).
 242   Each instance of the EFI UDPv4 Protocol has its own independent routing table.
 243   Instances of the EFI UDPv4 Protocol that use the default IP address will also
 244   have copies of the routing table provided by the EFI_IP4_CONFIG_PROTOCOL. These
 245   copies will be updated automatically whenever the IP driver reconfigures its
 246   instances; as a result, the previous modification to these copies will be lost.
 247
 248   @param  This           The pointer to the EFI_UDP4_PROTOCOL instance.
 249   @param  DeleteRoute    Set to TRUE to delete this route from the routing table.
 250                          Set to FALSE to add this route to the routing table.
 251   @param  SubnetAddress  The destination network address that needs to be routed.
 252   @param  SubnetMask     The subnet mask of SubnetAddress.
 253   @param  GatewayAddress The gateway IP address for this route.
 254
 255   @retval EFI_SUCCESS           The operation completed successfully.
 256   @retval EFI_NOT_STARTED       The EFI UDPv4 Protocol instance has not been started.
 257   @retval EFI_NO_MAPPING        When using a default address, configuration (DHCP, BOOTP,
 258                                 - RARP, etc.) is not finished yet.
 259   @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
 260   @retval EFI_OUT_OF_RESOURCES  Could not add the entry to the routing table.
 261   @retval EFI_NOT_FOUND         This route is not in the routing table.
 262   @retval EFI_ACCESS_DENIED     The route is already defined in the routing table.
 263
 264 **/
 265 typedef
 266 EFI_STATUS
 267 (EFIAPI *EFI_UDP4_ROUTES)(
 268   IN EFI_UDP4_PROTOCOL      *This,
 269   IN BOOLEAN                DeleteRoute,
 270   IN EFI_IPv4_ADDRESS       *SubnetAddress,
 271   IN EFI_IPv4_ADDRESS       *SubnetMask,
 272   IN EFI_IPv4_ADDRESS       *GatewayAddress
 273   );
 274
 275 /**
 276   Polls for incoming data packets and processes outgoing data packets.
 277
 278   The Poll() function can be used by network drivers and applications to increase
 279   the rate that data packets are moved between the communications device and the
 280   transmit and receive queues.
 281   In some systems, the periodic timer event in the managed network driver may not
 282   poll the underlying communications device fast enough to transmit and/or receive
 283   all data packets without missing incoming packets or dropping outgoing packets.
 284   Drivers and applications that are experiencing packet loss should try calling
 285   the Poll() function more often.
 286
 287   @param  This The pointer to the EFI_UDP4_PROTOCOL instance.
 288
 289   @retval EFI_SUCCESS           Incoming or outgoing data was processed.
 290   @retval EFI_INVALID_PARAMETER This is NULL.
 291   @retval EFI_DEVICE_ERROR      An unexpected system or network error occurred.
 292   @retval EFI_TIMEOUT           Data was dropped out of the transmit and/or receive queue.
 293
 294 **/
 295 typedef
 296 EFI_STATUS
 297 (EFIAPI *EFI_UDP4_POLL)(
 298   IN EFI_UDP4_PROTOCOL      *This
 299   );
 300
 301 /**
 302   Places an asynchronous receive request into the receiving queue.
 303
 304   The Receive() function places a completion token into the receive packet queue.
 305   This function is always asynchronous.
 306   The caller must fill in the Token.Event field in the completion token, and this
 307   field cannot be NULL. When the receive operation completes, the EFI UDPv4 Protocol
 308   driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event
 309   is signaled. Providing a proper notification function and context for the event
 310   will enable the user to receive the notification and receiving status. That
 311   notification function is guaranteed to not be re-entered.
 312
 313   @param  This  The pointer to the EFI_UDP4_PROTOCOL instance.
 314   @param  Token The pointer to a token that is associated with the receive data
 315                 descriptor.
 316
 317   @retval EFI_SUCCESS           The receive completion token was cached.
 318   @retval EFI_NOT_STARTED       This EFI UDPv4 Protocol instance has not been started.
 319   @retval EFI_NO_MAPPING        When using a default address, configuration (DHCP, BOOTP, RARP, etc.)
 320                                 is not finished yet.
 321   @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
 322   @retval EFI_OUT_OF_RESOURCES  The receive completion token could not be queued due to a lack of system
 323                                 resources (usually memory).
 324   @retval EFI_DEVICE_ERROR      An unexpected system or network error occurred.
 325   @retval EFI_ACCESS_DENIED     A receive completion token with the same Token.Event was already in
 326                                 the receive queue.
 327   @retval EFI_NOT_READY         The receive request could not be queued because the receive queue is full.
 328
 329 **/
 330 typedef
 331 EFI_STATUS
 332 (EFIAPI *EFI_UDP4_RECEIVE)(
 333   IN EFI_UDP4_PROTOCOL          *This,
 334   IN EFI_UDP4_COMPLETION_TOKEN  *Token
 335   );
 336
 337 /**
 338   Queues outgoing data packets into the transmit queue.
 339
 340   The Transmit() function places a sending request to this instance of the EFI
 341   UDPv4 Protocol, alongside the transmit data that was filled by the user. Whenever
 342   the packet in the token is sent out or some errors occur, the Token.Event will
 343   be signaled and Token.Status is updated. Providing a proper notification function
 344   and context for the event will enable the user to receive the notification and
 345   transmitting status.
 346
 347   @param  This  The pointer to the EFI_UDP4_PROTOCOL instance.
 348   @param  Token The pointer to the completion token that will be placed into the
 349                 transmit queue.
 350
 351   @retval EFI_SUCCESS           The data has been queued for transmission.
 352   @retval EFI_NOT_STARTED       This EFI UDPv4 Protocol instance has not been started.
 353   @retval EFI_NO_MAPPING        When using a default address, configuration (DHCP, BOOTP,
 354                                 RARP, etc.) is not finished yet.
 355   @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
 356   @retval EFI_ACCESS_DENIED     The transmit completion token with the same
 357                                 Token.Event was already in the transmit queue.
 358   @retval EFI_NOT_READY         The completion token could not be queued because the
 359                                 transmit queue is full.
 360   @retval EFI_OUT_OF_RESOURCES  Could not queue the transmit data.
 361   @retval EFI_NOT_FOUND         There is no route to the destination network or address.
 362   @retval EFI_BAD_BUFFER_SIZE   The data length is greater than the maximum UDP packet
 363                                 size. Or the length of the IP header + UDP header + data
 364                                 length is greater than MTU if DoNotFragment is TRUE.
 365
 366 **/
 367 typedef
 368 EFI_STATUS
 369 (EFIAPI *EFI_UDP4_TRANSMIT)(
 370   IN EFI_UDP4_PROTOCOL           *This,
 371   IN EFI_UDP4_COMPLETION_TOKEN   *Token
 372   );
 373
 374 /**
 375   Aborts an asynchronous transmit or receive request.
 376
 377   The Cancel() function is used to abort a pending transmit or receive request.
 378   If the token is in the transmit or receive request queues, after calling this
 379   function, Token.Status will be set to EFI_ABORTED and then Token.Event will be
 380   signaled. If the token is not in one of the queues, which usually means that
 381   the asynchronous operation has completed, this function will not signal the
 382   token and EFI_NOT_FOUND is returned.
 383
 384   @param  This  The pointer to the EFI_UDP4_PROTOCOL instance.
 385   @param  Token The pointer to a token that has been issued by
 386                 EFI_UDP4_PROTOCOL.Transmit() or
 387                 EFI_UDP4_PROTOCOL.Receive().If NULL, all pending
 388                 tokens are aborted.
 389
 390   @retval  EFI_SUCCESS           The asynchronous I/O request was aborted and Token.Event
 391                                  was signaled. When Token is NULL, all pending requests are
 392                                  aborted and their events are signaled.
 393   @retval  EFI_INVALID_PARAMETER This is NULL.
 394   @retval  EFI_NOT_STARTED       This instance has not been started.
 395   @retval  EFI_NO_MAPPING        When using the default address, configuration (DHCP, BOOTP,
 396                                  RARP, etc.) is not finished yet.
 397   @retval  EFI_NOT_FOUND         When Token is not NULL, the asynchronous I/O request was
 398                                  not found in the transmit or receive queue. It has either completed
 399                                  or was not issued by Transmit() and Receive().
 400
 401 **/
 402 typedef
 403 EFI_STATUS
 404 (EFIAPI *EFI_UDP4_CANCEL)(
 405   IN EFI_UDP4_PROTOCOL          *This,
 406   IN EFI_UDP4_COMPLETION_TOKEN  *Token  OPTIONAL
 407   );
 408
 409 ///
 410 /// The EFI_UDP4_PROTOCOL defines an EFI UDPv4 Protocol session that can be used
 411 /// by any network drivers, applications, or daemons to transmit or receive UDP packets.
 412 /// This protocol instance can either be bound to a specified port as a service or
 413 /// connected to some remote peer as an active client. Each instance has its own settings,
 414 /// such as the routing table and group table, which are independent from each other.
 415 ///
 416 struct _EFI_UDP4_PROTOCOL {
 417   EFI_UDP4_GET_MODE_DATA        GetModeData;
 418   EFI_UDP4_CONFIGURE            Configure;
 419   EFI_UDP4_GROUPS               Groups;
 420   EFI_UDP4_ROUTES               Routes;
 421   EFI_UDP4_TRANSMIT             Transmit;
 422   EFI_UDP4_RECEIVE              Receive;
 423   EFI_UDP4_CANCEL               Cancel;
 424   EFI_UDP4_POLL                 Poll;
 425 };
 426
 427 extern EFI_GUID gEfiUdp4ServiceBindingProtocolGuid;
 428 extern EFI_GUID gEfiUdp4ProtocolGuid;
 429
 430 #endif