MdePkg/Include/Protocol/PxeBaseCodeCallBack.h

   1 /** @file
   2   EFI PXE Base Code CallBack Protocol is as defined in UEFI specification.
   3   It is invoked when the PXE Base Code Protocol is about to transmit, has received,
   4   or is waiting to receive a packet.
   5
   6   Copyright (c) 2006 - 2008, Intel Corporation
   7   All rights reserved. This program and the accompanying materials
   8   are licensed and made available under the terms and conditions of the BSD License
   9   which accompanies this distribution.  The full text of the license may be found at
  10   http://opensource.org/licenses/bsd-license.php
  11
  12   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  13   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  14
  15 **/
  16
  17 #ifndef _PXE_BASE_CODE_CALLBACK_H_
  18 #define _PXE_BASE_CODE_CALLBACK_H_
  19
  20 ///
  21 /// Call Back Definitions
  22 ///
  23 #define EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_GUID \
  24   { \
  25     0x245dca21, 0xfb7b, 0x11d3, {0x8f, 0x01, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
  26   }
  27
  28 //
  29 // UEFI Revision Number Definition
  30 //
  31 #define EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION 0x00010000
  32
  33 //
  34 // EFI 1.1 Revision Number defintion
  35 //
  36 #define EFI_PXE_BASE_CODE_CALLBACK_INTERFACE_REVISION  \
  37         EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION
  38
  39 ///
  40 /// Protocol definition
  41 ///
  42 typedef struct _EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL  EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL;
  43
  44 ///
  45 /// Protocol defined in EFI1.1.
  46 ///
  47 typedef EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL   EFI_PXE_BASE_CODE_CALLBACK;
  48
  49 typedef enum {
  50   EFI_PXE_BASE_CODE_FUNCTION_FIRST,
  51   EFI_PXE_BASE_CODE_FUNCTION_DHCP,
  52   EFI_PXE_BASE_CODE_FUNCTION_DISCOVER,
  53   EFI_PXE_BASE_CODE_FUNCTION_MTFTP,
  54   EFI_PXE_BASE_CODE_FUNCTION_UDP_WRITE,
  55   EFI_PXE_BASE_CODE_FUNCTION_UDP_READ,
  56   EFI_PXE_BASE_CODE_FUNCTION_ARP,
  57   EFI_PXE_BASE_CODE_FUNCTION_IGMP,
  58   EFI_PXE_BASE_CODE_PXE_FUNCTION_LAST
  59 } EFI_PXE_BASE_CODE_FUNCTION;
  60
  61 typedef enum {
  62   EFI_PXE_BASE_CODE_CALLBACK_STATUS_FIRST,
  63   EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,
  64   EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT,
  65   EFI_PXE_BASE_CODE_CALLBACK_STATUS_LAST
  66 } EFI_PXE_BASE_CODE_CALLBACK_STATUS;
  67
  68 /**
  69   Callback function that is invoked when the PXE Base Code Protocol is about to transmit, has
  70   received, or is waiting to receive a packet.
  71
  72   @param  This                  Pointer to the EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL instance.
  73   @param  Function              The PXE Base Code Protocol function that is waiting for an event.
  74   @param  Received              TRUE if the callback is being invoked due to a receive event. FALSE if
  75                                 the callback is being invoked due to a transmit event.
  76   @param  PacketLen             The length, in bytes, of Packet. This field will have a value of zero if
  77                                 this is a wait for receive event.
  78   @param  Packet                If Received is TRUE, a pointer to the packet that was just received;
  79                                 otherwise a pointer to the packet that is about to be transmitted.
  80
  81   @retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE if Function specifies a continue operation
  82   @retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT    if Function specifies an abort operation
  83
  84 **/
  85 typedef
  86 EFI_PXE_BASE_CODE_CALLBACK_STATUS
  87 (EFIAPI *EFI_PXE_CALLBACK)(
  88   IN EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL  *This,
  89   IN EFI_PXE_BASE_CODE_FUNCTION           Function,
  90   IN BOOLEAN                              Received,
  91   IN UINT32                               PacketLen,
  92   IN EFI_PXE_BASE_CODE_PACKET             *Packet     OPTIONAL
  93   );
  94
  95 ///
  96 /// Protocol that is invoked when the PXE Base Code Protocol is about
  97 /// to transmit, has received, or is waiting to receive a packet.
  98 ///
  99 struct _EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL {
 100   ///
 101   ///  The revision of the EFI_PXE_BASE_CODE_PROTOCOL. All future revisions must
 102   ///  be backwards compatible. If a future version is not backwards compatible
 103   ///  it is not the same GUID.
 104   ///
 105   UINT64            Revision;
 106   EFI_PXE_CALLBACK  Callback;
 107 };
 108
 109 extern EFI_GUID gEfiPxeBaseCodeCallbackProtocolGuid;
 110
 111 #endif
 112