MdeModulePkg/Include/Protocol/PxeDhcp4CallBack.h

   1 /** @file
   2   EFI PXE DHCP4 Callback protocol definition.
   3
   4 Copyright (c) 2006 - 2008, Intel Corporation
   5 All rights reserved. This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef __PXE_DHCP4CALLBACK_H__
  16 #define __PXE_DHCP4CALLBACK_H__
  17
  18 #include <Protocol/PxeDhcp4.h>
  19 //
  20 // GUID definition
  21 //
  22
  23 #define EFI_PXE_DHCP4_CALLBACK_PROTOCOL_GUID \
  24 { 0xc1544c01, 0x92a4, 0x4198, {0x8a, 0x84, 0x77, 0x85, 0x83, 0xc2, 0x36, 0x21 } }
  25
  26
  27 //
  28 // Revision number
  29 //
  30
  31 #define EFI_PXE_DHCP4_CALLBACK_INTERFACE_REVISION   0x00010000
  32
  33 //
  34 // Interface definition
  35 //
  36
  37 typedef struct _EFI_PXE_DHCP4_CALLBACK_PROTOCOL EFI_PXE_DHCP4_CALLBACK_PROTOCOL;
  38
  39 typedef enum {
  40   EFI_PXE_DHCP4_FUNCTION_FIRST,
  41   EFI_PXE_DHCP4_FUNCTION_INIT,
  42   EFI_PXE_DHCP4_FUNCTION_SELECT,
  43   EFI_PXE_DHCP4_FUNCTION_RENEW,
  44   EFI_PXE_DHCP4_FUNCTION_REBIND,
  45   EFI_PXE_DHCP4_FUNCTION_LAST
  46 } EFI_PXE_DHCP4_FUNCTION;
  47
  48 typedef enum {
  49   EFI_PXE_DHCP4_CALLBACK_STATUS_FIRST,
  50   EFI_PXE_DHCP4_CALLBACK_STATUS_ABORT,
  51   EFI_PXE_DHCP4_CALLBACK_STATUS_IGNORE_ABORT,
  52   EFI_PXE_DHCP4_CALLBACK_STATUS_KEEP_ABORT,
  53   EFI_PXE_DHCP4_CALLBACK_STATUS_CONTINUE,
  54   EFI_PXE_DHCP4_CALLBACK_STATUS_IGNORE_CONTINUE,
  55   EFI_PXE_DHCP4_CALLBACK_STATUS_KEEP_CONTINUE,
  56   EFI_PXE_DHCP4_CALLBACK_STATUS_LAST
  57 } EFI_PXE_DHCP4_CALLBACK_STATUS;
  58
  59 typedef
  60 EFI_PXE_DHCP4_CALLBACK_STATUS
  61 (EFIAPI *EFI_PXE_DHCP4_CALLBACK) (
  62   IN EFI_PXE_DHCP4_PROTOCOL *This,
  63   IN EFI_PXE_DHCP4_FUNCTION Function,
  64   IN UINT32                 PacketLen,
  65   IN DHCP4_PACKET           *Packet OPTIONAL
  66   );
  67
  68 struct _EFI_PXE_DHCP4_CALLBACK_PROTOCOL {
  69   UINT64                      Revision;
  70   EFI_PXE_DHCP4_CALLBACK      Callback;
  71 };
  72
  73 //
  74 // GUID declaration
  75 //
  76
  77 extern EFI_GUID gEfiPxeDhcp4CallbackProtocolGuid;
  78
  79 #endif /* _PXE_DHCP4CALLBACK_H */
  80 /* EOF - PxeDhcp4Callback.h */