MdePkg/Include/Protocol/SimpleNetwork.h

   1 /** @file
   2   Simple Network protocol as defined in the UEFI 2.0 specification.
   3
   4   Basic network device abstraction.
   5
   6   Rx    - Received
   7   Tx    - Transmit
   8   MCast - MultiCast
   9   ...
  10
  11   Copyright (c) 2006 - 2008, Intel Corporation
  12   All rights reserved. This program and the accompanying materials
  13   are licensed and made available under the terms and conditions of the BSD License
  14   which accompanies this distribution.  The full text of the license may be found at
  15   http://opensource.org/licenses/bsd-license.php
  16
  17   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  18   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  19
  20 **/
  21
  22 #ifndef __SIMPLE_NETWORK_H__
  23 #define __SIMPLE_NETWORK_H__
  24
  25 #define EFI_SIMPLE_NETWORK_PROTOCOL_GUID \
  26   { \
  27     0xA19832B9, 0xAC25, 0x11D3, {0x9A, 0x2D, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D } \
  28   }
  29
  30 typedef struct _EFI_SIMPLE_NETWORK_PROTOCOL  EFI_SIMPLE_NETWORK_PROTOCOL;
  31
  32
  33 ///
  34 /// Protocol defined in EFI1.1.
  35 ///
  36 typedef EFI_SIMPLE_NETWORK_PROTOCOL   EFI_SIMPLE_NETWORK;
  37
  38 ///
  39 /// Simple Network Protocol data structures
  40 ///
  41 typedef struct {
  42   ///
  43   /// Total number of frames received.  Includes frames with errors and
  44   /// dropped frames.
  45   ///
  46   UINT64  RxTotalFrames;
  47
  48   ///
  49   /// Number of valid frames received and copied into receive buffers.
  50   ///
  51   UINT64  RxGoodFrames;
  52
  53   ///
  54   /// Number of frames below the minimum length for the media.
  55   /// This would be <64 for ethernet.
  56   ///
  57   UINT64  RxUndersizeFrames;
  58
  59   ///
  60   /// Number of frames longer than the maxminum length for the
  61   /// media.  This would be >1500 for ethernet.
  62   ///
  63   UINT64  RxOversizeFrames;
  64
  65   ///
  66   /// Valid frames that were dropped because receive buffers were full.
  67   ///
  68   UINT64  RxDroppedFrames;
  69
  70   ///
  71   /// Number of valid unicast frames received and not dropped.
  72   ///
  73   UINT64  RxUnicastFrames;
  74
  75   ///
  76   /// Number of valid broadcast frames received and not dropped.
  77   ///
  78   UINT64  RxBroadcastFrames;
  79
  80   ///
  81   /// Number of valid mutlicast frames received and not dropped.
  82   ///
  83   UINT64  RxMulticastFrames;
  84
  85   ///
  86   /// Number of frames w/ CRC or alignment errors.
  87   ///
  88   UINT64  RxCrcErrorFrames;
  89
  90   ///
  91   /// Total number of bytes received.  Includes frames with errors
  92   /// and dropped frames.
  93   //
  94   UINT64  RxTotalBytes;
  95
  96   ///
  97   /// Transmit statistics.
  98   ///
  99   UINT64  TxTotalFrames;
 100   UINT64  TxGoodFrames;
 101   UINT64  TxUndersizeFrames;
 102   UINT64  TxOversizeFrames;
 103   UINT64  TxDroppedFrames;
 104   UINT64  TxUnicastFrames;
 105   UINT64  TxBroadcastFrames;
 106   UINT64  TxMulticastFrames;
 107   UINT64  TxCrcErrorFrames;
 108   UINT64  TxTotalBytes;
 109
 110   ///
 111   /// Number of collisions detection on this subnet.
 112   ///
 113   UINT64  Collisions;
 114
 115   ///
 116   /// Number of frames destined for unsupported protocol.
 117   ///
 118   UINT64  UnsupportedProtocol;
 119
 120 } EFI_NETWORK_STATISTICS;
 121
 122 ///
 123 /// State of the network interface
 124 /// When an EFI_SIMPLE_NETWORK_PROTOCOL driver initializes a
 125 /// network interface, the network interface is left in the EfiSimpleNetworkStopped state.
 126 ///
 127 typedef enum {
 128   EfiSimpleNetworkStopped,
 129   EfiSimpleNetworkStarted,
 130   EfiSimpleNetworkInitialized,
 131   EfiSimpleNetworkMaxState
 132 } EFI_SIMPLE_NETWORK_STATE;
 133
 134 #define EFI_SIMPLE_NETWORK_RECEIVE_UNICAST                0x01
 135 #define EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST              0x02
 136 #define EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST              0x04
 137 #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS            0x08
 138 #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST  0x10
 139
 140 #define EFI_SIMPLE_NETWORK_RECEIVE_INTERRUPT              0x01
 141 #define EFI_SIMPLE_NETWORK_TRANSMIT_INTERRUPT             0x02
 142 #define EFI_SIMPLE_NETWORK_COMMAND_INTERRUPT              0x04
 143 #define EFI_SIMPLE_NETWORK_SOFTWARE_INTERRUPT             0x08
 144
 145 #define MAX_MCAST_FILTER_CNT                              16
 146 typedef struct {
 147   UINT32          State;
 148   UINT32          HwAddressSize;
 149   UINT32          MediaHeaderSize;
 150   UINT32          MaxPacketSize;
 151   UINT32          NvRamSize;
 152   UINT32          NvRamAccessSize;
 153   UINT32          ReceiveFilterMask;
 154   UINT32          ReceiveFilterSetting;
 155   UINT32          MaxMCastFilterCount;
 156   UINT32          MCastFilterCount;
 157   EFI_MAC_ADDRESS MCastFilter[MAX_MCAST_FILTER_CNT];
 158   EFI_MAC_ADDRESS CurrentAddress;
 159   EFI_MAC_ADDRESS BroadcastAddress;
 160   EFI_MAC_ADDRESS PermanentAddress;
 161   UINT8           IfType;
 162   BOOLEAN         MacAddressChangeable;
 163   BOOLEAN         MultipleTxSupported;
 164   BOOLEAN         MediaPresentSupported;
 165   BOOLEAN         MediaPresent;
 166 } EFI_SIMPLE_NETWORK_MODE;
 167
 168 //
 169 // Protocol Member Functions
 170 //
 171 /**
 172   Changes the state of a network interface from "stopped" to "started".
 173
 174   @param  This Protocol instance pointer.
 175
 176   @retval EFI_SUCCESS           The network interface was started.
 177   @retval EFI_ALREADY_STARTED   The network interface is already in the started state.
 178   @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.
 179   @retval EFI_DEVICE_ERROR      The command could not be sent to the network interface.
 180   @retval EFI_UNSUPPORTED       This function is not supported by the network interface.
 181
 182 **/
 183 typedef
 184 EFI_STATUS
 185 (EFIAPI *EFI_SIMPLE_NETWORK_START)(
 186   IN EFI_SIMPLE_NETWORK_PROTOCOL  *This
 187   );
 188
 189 /**
 190   Changes the state of a network interface from "started" to "stopped".
 191
 192   @param  This Protocol instance pointer.
 193
 194   @retval EFI_SUCCESS           The network interface was stopped.
 195   @retval EFI_ALREADY_STARTED   The network interface is already in the stopped state.
 196   @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.
 197   @retval EFI_DEVICE_ERROR      The command could not be sent to the network interface.
 198   @retval EFI_UNSUPPORTED       This function is not supported by the network interface.
 199
 200 **/
 201 typedef
 202 EFI_STATUS
 203 (EFIAPI *EFI_SIMPLE_NETWORK_STOP)(
 204   IN EFI_SIMPLE_NETWORK_PROTOCOL  *This
 205   );
 206
 207 /**
 208   Resets a network adapter and allocates the transmit and receive buffers
 209   required by the network interface; optionally, also requests allocation
 210   of additional transmit and receive buffers.
 211
 212   @param  This              Protocol instance pointer.
 213   @param  ExtraRxBufferSize The size, in bytes, of the extra receive buffer space
 214                             that the driver should allocate for the network interface.
 215                             Some network interfaces will not be able to use the extra
 216                             buffer, and the caller will not know if it is actually
 217                             being used.
 218   @param  ExtraTxBufferSize The size, in bytes, of the extra transmit buffer space
 219                             that the driver should allocate for the network interface.
 220                             Some network interfaces will not be able to use the extra
 221                             buffer, and the caller will not know if it is actually
 222                             being used.
 223
 224   @retval EFI_SUCCESS           The network interface was initialized.
 225   @retval EFI_NOT_STARTED       The network interface has not been started
 226   @retval EFI_OUT_OF_RESOURCES  There was not enough memory for the transmit and
 227                                 receive buffers.   .
 228   @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.
 229   @retval EFI_DEVICE_ERROR      The command could not be sent to the network interface.
 230   @retval EFI_UNSUPPORTED       This function is not supported by the network interface.
 231
 232 **/
 233 typedef
 234 EFI_STATUS
 235 (EFIAPI *EFI_SIMPLE_NETWORK_INITIALIZE)(
 236   IN EFI_SIMPLE_NETWORK_PROTOCOL                    *This,
 237   IN UINTN                                          ExtraRxBufferSize  OPTIONAL,
 238   IN UINTN                                          ExtraTxBufferSize  OPTIONAL
 239   );
 240
 241 /**
 242   Resets a network adapter and re-initializes it with the parameters that were
 243   provided in the previous call to Initialize().
 244
 245   @param  This                 Protocol instance pointer.
 246   @param  ExtendedVerification Indicates that the driver may perform a more
 247                                exhaustive verification operation of the device
 248                                during reset.
 249
 250   @retval EFI_SUCCESS           The network interface was reset.
 251   @retval EFI_NOT_STARTED       The network interface has not been started
 252   @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.
 253   @retval EFI_DEVICE_ERROR      The command could not be sent to the network interface.
 254   @retval EFI_UNSUPPORTED       This function is not supported by the network interface.
 255
 256 **/
 257 typedef
 258 EFI_STATUS
 259 (EFIAPI *EFI_SIMPLE_NETWORK_RESET)(
 260   IN EFI_SIMPLE_NETWORK_PROTOCOL   *This,
 261   IN BOOLEAN                       ExtendedVerification
 262   );
 263
 264 /**
 265   Resets a network adapter and leaves it in a state that is safe for
 266   another driver to initialize.
 267
 268   @param  This Protocol instance pointer.
 269
 270   @retval EFI_SUCCESS           The network interface was shutdown.
 271   @retval EFI_NOT_STARTED       The network interface has not been started
 272   @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.
 273   @retval EFI_DEVICE_ERROR      The command could not be sent to the network interface.
 274   @retval EFI_UNSUPPORTED       This function is not supported by the network interface.
 275
 276 **/
 277 typedef
 278 EFI_STATUS
 279 (EFIAPI *EFI_SIMPLE_NETWORK_SHUTDOWN)(
 280   IN EFI_SIMPLE_NETWORK_PROTOCOL  *This
 281   );
 282
 283 /**
 284   Manages the multicast receive filters of a network interface.
 285
 286   @param  This             Protocol instance pointer.
 287   @param  Enable           A bit mask of receive filters to enable on the network interface.
 288   @param  Disable          A bit mask of receive filters to disable on the network interface.
 289   @param  ResetMCastFilter Set to TRUE to reset the contents of the multicast receive
 290                            filters on the network interface to their default values.
 291   @param  McastFilterCnt   Number of multicast HW MAC addresses in the new
 292                            MCastFilter list. This value must be less than or equal to
 293                            the MCastFilterCnt field of EFI_SIMPLE_NETWORK_MODE. This
 294                            field is optional if ResetMCastFilter is TRUE.
 295   @param  MCastFilter      A pointer to a list of new multicast receive filter HW MAC
 296                            addresses. This list will replace any existing multicast
 297                            HW MAC address list. This field is optional if
 298                            ResetMCastFilter is TRUE.
 299
 300   @retval EFI_SUCCESS           The multicast receive filter list was updated.
 301   @retval EFI_NOT_STARTED       The network interface has not been started
 302   @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.
 303   @retval EFI_DEVICE_ERROR      The command could not be sent to the network interface.
 304   @retval EFI_UNSUPPORTED       This function is not supported by the network interface.
 305
 306 **/
 307 typedef
 308 EFI_STATUS
 309 (EFIAPI *EFI_SIMPLE_NETWORK_RECEIVE_FILTERS)(
 310   IN EFI_SIMPLE_NETWORK_PROTOCOL                             *This,
 311   IN UINT32                                                  Enable,
 312   IN UINT32                                                  Disable,
 313   IN BOOLEAN                                                 ResetMCastFilter,
 314   IN UINTN                                                   MCastFilterCnt     OPTIONAL,
 315   IN EFI_MAC_ADDRESS                                         *MCastFilter OPTIONAL
 316   );
 317
 318 /**
 319   Modifies or resets the current station address, if supported.
 320
 321   @param  This  Protocol instance pointer.
 322   @param  Reset Flag used to reset the station address to the network interfaces
 323                 permanent address.
 324   @param  New   New station address to be used for the network interface.
 325
 326   @retval EFI_SUCCESS           The network interfaces station address was updated.
 327   @retval EFI_NOT_STARTED       The network interface has not been started
 328   @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.
 329   @retval EFI_DEVICE_ERROR      The command could not be sent to the network interface.
 330   @retval EFI_UNSUPPORTED       This function is not supported by the network interface.
 331
 332 **/
 333 typedef
 334 EFI_STATUS
 335 (EFIAPI *EFI_SIMPLE_NETWORK_STATION_ADDRESS)(
 336   IN EFI_SIMPLE_NETWORK_PROTOCOL            *This,
 337   IN BOOLEAN                                Reset,
 338   IN EFI_MAC_ADDRESS                        *New OPTIONAL
 339   );
 340
 341 /**
 342   Resets or collects the statistics on a network interface.
 343
 344   @param  This            Protocol instance pointer.
 345   @param  Reset           Set to TRUE to reset the statistics for the network interface.
 346   @param  StatisticsSize  On input the size, in bytes, of StatisticsTable. On
 347                           output the size, in bytes, of the resulting table of
 348                           statistics.
 349   @param  StatisticsTable A pointer to the EFI_NETWORK_STATISTICS structure that
 350                           contains the statistics.
 351
 352   @retval EFI_SUCCESS           The statistics were collected from the network interface.
 353   @retval EFI_NOT_STARTED       The network interface has not been started.
 354   @retval EFI_BUFFER_TOO_SMALL  The Statistics buffer was too small. The current buffer
 355                                 size needed to hold the statistics is returned in
 356                                 StatisticsSize.
 357   @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.
 358   @retval EFI_DEVICE_ERROR      The command could not be sent to the network interface.
 359   @retval EFI_UNSUPPORTED       This function is not supported by the network interface.
 360
 361 **/
 362 typedef
 363 EFI_STATUS
 364 (EFIAPI *EFI_SIMPLE_NETWORK_STATISTICS)(
 365   IN EFI_SIMPLE_NETWORK_PROTOCOL          *This,
 366   IN BOOLEAN                              Reset,
 367   IN OUT UINTN                            *StatisticsSize   OPTIONAL,
 368   OUT EFI_NETWORK_STATISTICS              *StatisticsTable  OPTIONAL
 369   );
 370
 371 /**
 372   Converts a multicast IP address to a multicast HW MAC address.
 373
 374   @param  This Protocol instance pointer.
 375   @param  IPv6 Set to TRUE if the multicast IP address is IPv6 [RFC 2460]. Set
 376                to FALSE if the multicast IP address is IPv4 [RFC 791].
 377   @param  IP   The multicast IP address that is to be converted to a multicast
 378                HW MAC address.
 379   @param  MAC  The multicast HW MAC address that is to be generated from IP.
 380
 381   @retval EFI_SUCCESS           The multicast IP address was mapped to the multicast
 382                                 HW MAC address.
 383   @retval EFI_NOT_STARTED       The network interface has not been started.
 384   @retval EFI_BUFFER_TOO_SMALL  The Statistics buffer was too small. The current buffer
 385                                 size needed to hold the statistics is returned in
 386                                 StatisticsSize.
 387   @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.
 388   @retval EFI_DEVICE_ERROR      The command could not be sent to the network interface.
 389   @retval EFI_UNSUPPORTED       This function is not supported by the network interface.
 390
 391 **/
 392 typedef
 393 EFI_STATUS
 394 (EFIAPI *EFI_SIMPLE_NETWORK_MCAST_IP_TO_MAC)(
 395   IN EFI_SIMPLE_NETWORK_PROTOCOL          *This,
 396   IN BOOLEAN                              IPv6,
 397   IN EFI_IP_ADDRESS                       *IP,
 398   OUT EFI_MAC_ADDRESS                     *MAC
 399   );
 400
 401 /**
 402   Performs read and write operations on the NVRAM device attached to a
 403   network interface.
 404
 405   @param  This       Protocol instance pointer.
 406   @param  ReadWrite  TRUE for read operations, FALSE for write operations.
 407   @param  Offset     Byte offset in the NVRAM device at which to start the read or
 408                      write operation. This must be a multiple of NvRamAccessSize and
 409                      less than NvRamSize.
 410   @param  BufferSize The number of bytes to read or write from the NVRAM device.
 411                      This must also be a multiple of NvramAccessSize.
 412   @param  Buffer     A pointer to the data buffer.
 413
 414   @retval EFI_SUCCESS           The NVRAM access was performed.
 415   @retval EFI_NOT_STARTED       The network interface has not been started.
 416   @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.
 417   @retval EFI_DEVICE_ERROR      The command could not be sent to the network interface.
 418   @retval EFI_UNSUPPORTED       This function is not supported by the network interface.
 419
 420 **/
 421 typedef
 422 EFI_STATUS
 423 (EFIAPI *EFI_SIMPLE_NETWORK_NVDATA)(
 424   IN EFI_SIMPLE_NETWORK_PROTOCOL          *This,
 425   IN BOOLEAN                              ReadWrite,
 426   IN UINTN                                Offset,
 427   IN UINTN                                BufferSize,
 428   IN OUT VOID                             *Buffer
 429   );
 430
 431 /**
 432   Reads the current interrupt status and recycled transmit buffer status from
 433   a network interface.
 434
 435   @param  This            Protocol instance pointer.
 436   @param  InterruptStatus A pointer to the bit mask of the currently active interrupts
 437                           If this is NULL, the interrupt status will not be read from
 438                           the device. If this is not NULL, the interrupt status will
 439                           be read from the device. When the  interrupt status is read,
 440                           it will also be cleared. Clearing the transmit  interrupt
 441                           does not empty the recycled transmit buffer array.
 442   @param  TxBuf           Recycled transmit buffer address. The network interface will
 443                           not transmit if its internal recycled transmit buffer array
 444                           is full. Reading the transmit buffer does not clear the
 445                           transmit interrupt. If this is NULL, then the transmit buffer
 446                           status will not be read. If there are no transmit buffers to
 447                           recycle and TxBuf is not NULL, * TxBuf will be set to NULL.
 448
 449   @retval EFI_SUCCESS           The status of the network interface was retrieved.
 450   @retval EFI_NOT_STARTED       The network interface has not been started.
 451   @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.
 452   @retval EFI_DEVICE_ERROR      The command could not be sent to the network interface.
 453   @retval EFI_UNSUPPORTED       This function is not supported by the network interface.
 454
 455 **/
 456 typedef
 457 EFI_STATUS
 458 (EFIAPI *EFI_SIMPLE_NETWORK_GET_STATUS)(
 459   IN EFI_SIMPLE_NETWORK_PROTOCOL          *This,
 460   OUT UINT32                              *InterruptStatus OPTIONAL,
 461   OUT VOID                                **TxBuf OPTIONAL
 462   );
 463
 464 /**
 465   Places a packet in the transmit queue of a network interface.
 466
 467   @param  This       Protocol instance pointer.
 468   @param  HeaderSize The size, in bytes, of the media header to be filled in by
 469                      the Transmit() function. If HeaderSize is non-zero, then it
 470                      must be equal to This->Mode->MediaHeaderSize and the DestAddr
 471                      and Protocol parameters must not be NULL.
 472   @param  BufferSize The size, in bytes, of the entire packet (media header and
 473                      data) to be transmitted through the network interface.
 474   @param  Buffer     A pointer to the packet (media header followed by data) to be
 475                      transmitted. This parameter cannot be NULL. If HeaderSize is zero,
 476                      then the media header in Buffer must already be filled in by the
 477                      caller. If HeaderSize is non-zero, then the media header will be
 478                      filled in by the Transmit() function.
 479   @param  SrcAddr    The source HW MAC address. If HeaderSize is zero, then this parameter
 480                      is ignored. If HeaderSize is non-zero and SrcAddr is NULL, then
 481                      This->Mode->CurrentAddress is used for the source HW MAC address.
 482   @param  DsetAddr   The destination HW MAC address. If HeaderSize is zero, then this
 483                      parameter is ignored.
 484   @param  Protocol   The type of header to build. If HeaderSize is zero, then this
 485                      parameter is ignored. See RFC 1700, section "Ether Types", for
 486                      examples.
 487
 488   @retval EFI_SUCCESS           The packet was placed on the transmit queue.
 489   @retval EFI_NOT_STARTED       The network interface has not been started.
 490   @retval EFI_NOT_READY         The network interface is too busy to accept this transmit request.
 491   @retval EFI_BUFFER_TOO_SMALL  The BufferSize parameter is too small.
 492   @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.
 493   @retval EFI_DEVICE_ERROR      The command could not be sent to the network interface.
 494   @retval EFI_UNSUPPORTED       This function is not supported by the network interface.
 495
 496 **/
 497 typedef
 498 EFI_STATUS
 499 (EFIAPI *EFI_SIMPLE_NETWORK_TRANSMIT)(
 500   IN EFI_SIMPLE_NETWORK_PROTOCOL          *This,
 501   IN UINTN                                HeaderSize,
 502   IN UINTN                                BufferSize,
 503   IN VOID                                 *Buffer,
 504   IN EFI_MAC_ADDRESS                      *SrcAddr  OPTIONAL,
 505   IN EFI_MAC_ADDRESS                      *DestAddr OPTIONAL,
 506   IN UINT16                               *Protocol OPTIONAL
 507   );
 508
 509 /**
 510   Receives a packet from a network interface.
 511
 512   @param  This       Protocol instance pointer.
 513   @param  HeaderSize The size, in bytes, of the media header received on the network
 514                      interface. If this parameter is NULL, then the media header size
 515                      will not be returned.
 516   @param  BufferSize On entry, the size, in bytes, of Buffer. On exit, the size, in
 517                      bytes, of the packet that was received on the network interface.
 518   @param  Buffer     A pointer to the data buffer to receive both the media header and
 519                      the data.
 520   @param  SrcAddr    The source HW MAC address. If this parameter is NULL, the
 521                      HW MAC source address will not be extracted from the media
 522                      header.
 523   @param  DsetAddr   The destination HW MAC address. If this parameter is NULL,
 524                      the HW MAC destination address will not be extracted from the
 525                      media header.
 526   @param  Protocol   The media header type. If this parameter is NULL, then the
 527                      protocol will not be extracted from the media header. See
 528                      RFC 1700 section "Ether Types" for examples.
 529
 530   @retval  EFI_SUCCESS           The received data was stored in Buffer, and BufferSize has
 531                                  been updated to the number of bytes received.
 532   @retval  EFI_NOT_STARTED       The network interface has not been started.
 533   @retval  EFI_NOT_READY         The network interface is too busy to accept this transmit
 534                                  request.
 535   @retval  EFI_BUFFER_TOO_SMALL  The BufferSize parameter is too small.
 536   @retval  EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.
 537   @retval  EFI_DEVICE_ERROR      The command could not be sent to the network interface.
 538   @retval  EFI_UNSUPPORTED       This function is not supported by the network interface.
 539
 540 **/
 541 typedef
 542 EFI_STATUS
 543 (EFIAPI *EFI_SIMPLE_NETWORK_RECEIVE)(
 544   IN EFI_SIMPLE_NETWORK_PROTOCOL          *This,
 545   OUT UINTN                               *HeaderSize OPTIONAL,
 546   IN OUT UINTN                            *BufferSize,
 547   OUT VOID                                *Buffer,
 548   OUT EFI_MAC_ADDRESS                     *SrcAddr    OPTIONAL,
 549   OUT EFI_MAC_ADDRESS                     *DestAddr   OPTIONAL,
 550   OUT UINT16                              *Protocol   OPTIONAL
 551   );
 552
 553 #define EFI_SIMPLE_NETWORK_PROTOCOL_REVISION  0x00010000
 554
 555 //
 556 // Revision defined in EFI1.1
 557 //
 558 #define EFI_SIMPLE_NETWORK_INTERFACE_REVISION   EFI_SIMPLE_NETWORK_PROTOCOL_REVISION
 559
 560 ///
 561 /// The EFI_SIMPLE_NETWORK_PROTOCOL protocol is used to initialize access
 562 /// to a network adapter. Once the network adapter initializes,
 563 /// the EFI_SIMPLE_NETWORK_PROTOCOL protocol provides services that
 564 /// allow packets to be transmitted and received.
 565 ///
 566 struct _EFI_SIMPLE_NETWORK_PROTOCOL {
 567   ///
 568   /// Revision of the EFI_SIMPLE_NETWORK_PROTOCOL. All future revisions must
 569   /// be backwards compatible. If a future version is not backwards compatible
 570   /// it is not the same GUID.
 571   ///
 572   UINT64                              Revision;
 573   EFI_SIMPLE_NETWORK_START            Start;
 574   EFI_SIMPLE_NETWORK_STOP             Stop;
 575   EFI_SIMPLE_NETWORK_INITIALIZE       Initialize;
 576   EFI_SIMPLE_NETWORK_RESET            Reset;
 577   EFI_SIMPLE_NETWORK_SHUTDOWN         Shutdown;
 578   EFI_SIMPLE_NETWORK_RECEIVE_FILTERS  ReceiveFilters;
 579   EFI_SIMPLE_NETWORK_STATION_ADDRESS  StationAddress;
 580   EFI_SIMPLE_NETWORK_STATISTICS       Statistics;
 581   EFI_SIMPLE_NETWORK_MCAST_IP_TO_MAC  MCastIpToMac;
 582   EFI_SIMPLE_NETWORK_NVDATA           NvData;
 583   EFI_SIMPLE_NETWORK_GET_STATUS       GetStatus;
 584   EFI_SIMPLE_NETWORK_TRANSMIT         Transmit;
 585   EFI_SIMPLE_NETWORK_RECEIVE          Receive;
 586   ///
 587   /// Event used with WaitForEvent() to wait for a packet to be received.
 588   ///
 589   EFI_EVENT                           WaitForPacket;
 590   ///
 591   /// Pointer to the EFI_SIMPLE_NETWORK_MODE data for the device.
 592   ///
 593   EFI_SIMPLE_NETWORK_MODE             *Mode;
 594 };
 595
 596 extern EFI_GUID gEfiSimpleNetworkProtocolGuid;
 597
 598 #endif