EdkModulePkg/Include/Protocol/PxeDhcp4CallBack.h

   1 /*++
   2
   3 Copyright (c) 2006, Intel Corporation
   4 All rights reserved. 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   PxeDhcp4Callback.h
  14
  15 Abstract:
  16   EFI PXE DHCP4 Callback protocol definition.
  17
  18 --*/
  19
  20 #ifndef _PXE_DHCP4CALLBACK_H
  21 #define _PXE_DHCP4CALLBACK_H
  22
  23 #include <Protocol/PxeDhcp4.h>
  24 //
  25 // GUID definition
  26 //
  27
  28 #define EFI_PXE_DHCP4_CALLBACK_PROTOCOL_GUID \
  29 { 0xc1544c01, 0x92a4, 0x4198, {0x8a, 0x84, 0x77, 0x85, 0x83, 0xc2, 0x36, 0x21 } }
  30
  31
  32 //
  33 // Revision number
  34 //
  35
  36 #define EFI_PXE_DHCP4_CALLBACK_INTERFACE_REVISION   0x00010000
  37
  38 //
  39 // Interface definition
  40 //
  41
  42 typedef struct _EFI_PXE_DHCP4_CALLBACK_PROTOCOL EFI_PXE_DHCP4_CALLBACK_PROTOCOL;
  43
  44 typedef enum {
  45   EFI_PXE_DHCP4_FUNCTION_FIRST,
  46   EFI_PXE_DHCP4_FUNCTION_INIT,
  47   EFI_PXE_DHCP4_FUNCTION_SELECT,
  48   EFI_PXE_DHCP4_FUNCTION_RENEW,
  49   EFI_PXE_DHCP4_FUNCTION_REBIND,
  50   EFI_PXE_DHCP4_FUNCTION_LAST
  51 } EFI_PXE_DHCP4_FUNCTION;
  52
  53 typedef enum {
  54   EFI_PXE_DHCP4_CALLBACK_STATUS_FIRST,
  55   EFI_PXE_DHCP4_CALLBACK_STATUS_ABORT,
  56   EFI_PXE_DHCP4_CALLBACK_STATUS_IGNORE_ABORT,
  57   EFI_PXE_DHCP4_CALLBACK_STATUS_KEEP_ABORT,
  58   EFI_PXE_DHCP4_CALLBACK_STATUS_CONTINUE,
  59   EFI_PXE_DHCP4_CALLBACK_STATUS_IGNORE_CONTINUE,
  60   EFI_PXE_DHCP4_CALLBACK_STATUS_KEEP_CONTINUE,
  61   EFI_PXE_DHCP4_CALLBACK_STATUS_LAST
  62 } EFI_PXE_DHCP4_CALLBACK_STATUS;
  63
  64 typedef
  65 EFI_PXE_DHCP4_CALLBACK_STATUS
  66 (EFIAPI *EFI_PXE_DHCP4_CALLBACK) (
  67   IN EFI_PXE_DHCP4_PROTOCOL *This,
  68   IN EFI_PXE_DHCP4_FUNCTION Function,
  69   IN UINT32                 PacketLen,
  70   IN DHCP4_PACKET           *Packet OPTIONAL
  71   );
  72
  73 struct _EFI_PXE_DHCP4_CALLBACK_PROTOCOL {
  74   UINT64                      Revision;
  75   EFI_PXE_DHCP4_CALLBACK      Callback;
  76 };
  77
  78 //
  79 // GUID declaration
  80 //
  81
  82 extern EFI_GUID gEfiPxeDhcp4CallbackProtocolGuid;
  83
  84 #endif /* _PXE_DHCP4CALLBACK_H */
  85 /* EOF - PxeDhcp4Callback.h */