EdkCompatibilityPkg/Foundation/Efi/Protocol/PxeBaseCodeCallBack/PxeBaseCodeCallBack.h

   1 /*++
   2
   3 Copyright (c) 2004, Intel Corporation. All rights reserved.<BR>
   4 This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 Module Name:
  13   PxeBaseCodeCallBack.h
  14
  15 Abstract:
  16   EFI PXE Base Code CallBack Protocol
  17
  18 --*/
  19
  20 #ifndef _PXE_BASE_CODE_CALLBACK_H_
  21 #define _PXE_BASE_CODE_CALLBACK_H_
  22
  23 #include "Pxe.h"
  24
  25 //
  26 // Call Back Definitions
  27 //
  28 #define EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_GUID \
  29   { \
  30     0x245dca21, 0xfb7b, 0x11d3, {0x8f, 0x01, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b} \
  31   }
  32
  33 //
  34 // Revision Number
  35 //
  36 #define EFI_PXE_BASE_CODE_CALLBACK_INTERFACE_REVISION 0x00010000
  37
  38 //
  39 // Protocol definition
  40 //
  41 EFI_FORWARD_DECLARATION (EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL);
  42
  43 typedef enum {
  44   EFI_PXE_BASE_CODE_FUNCTION_FIRST,
  45   EFI_PXE_BASE_CODE_FUNCTION_DHCP,
  46   EFI_PXE_BASE_CODE_FUNCTION_DISCOVER,
  47   EFI_PXE_BASE_CODE_FUNCTION_MTFTP,
  48   EFI_PXE_BASE_CODE_FUNCTION_UDP_WRITE,
  49   EFI_PXE_BASE_CODE_FUNCTION_UDP_READ,
  50   EFI_PXE_BASE_CODE_FUNCTION_ARP,
  51   EFI_PXE_BASE_CODE_FUNCTION_IGMP,
  52   EFI_PXE_BASE_CODE_FUNCTION_TCP_WRITE,
  53   EFI_PXE_BASE_CODE_FUNCTION_TCP_READ,
  54   EFI_PXE_BASE_CODE_PXE_FUNCTION_LAST
  55 } EFI_PXE_BASE_CODE_FUNCTION;
  56
  57 typedef enum {
  58   EFI_PXE_BASE_CODE_CALLBACK_STATUS_FIRST,
  59   EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,
  60   EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT,
  61   EFI_PXE_BASE_CODE_CALLBACK_STATUS_LAST
  62 } EFI_PXE_BASE_CODE_CALLBACK_STATUS;
  63
  64 typedef EFI_PXE_BASE_CODE_CALLBACK_STATUS (EFIAPI *EFI_PXE_CALLBACK)
  65   (
  66     IN EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL * This,
  67     IN EFI_PXE_BASE_CODE_FUNCTION Function,
  68     IN BOOLEAN Received,
  69     IN UINT32 PacketLen,
  70     IN EFI_PXE_BASE_CODE_PACKET * Packet OPTIONAL
  71   );
  72
  73 struct _EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL {
  74   UINT64            Revision;
  75   EFI_PXE_CALLBACK  Callback;
  76 };
  77
  78 extern EFI_GUID gEfiPxeBaseCodeCallbackProtocolGuid;
  79
  80 #endif /* _EFIPXEBC_H */
  81
  82 /* EOF - PxeBaseCodeCallBack.h */