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 #define EFI_PXE_DHCP4_CALLBACK_PROTOCOL_GUID \
  21 { 0xc1544c01, 0x92a4, 0x4198, {0x8a, 0x84, 0x77, 0x85, 0x83, 0xc2, 0x36, 0x21 } }
  22
  23 #define EFI_PXE_DHCP4_CALLBACK_INTERFACE_REVISION   0x00010000
  24
  25 typedef struct _EFI_PXE_DHCP4_CALLBACK_PROTOCOL EFI_PXE_DHCP4_CALLBACK_PROTOCOL;
  26
  27 typedef enum {
  28   EFI_PXE_DHCP4_FUNCTION_FIRST,
  29   EFI_PXE_DHCP4_FUNCTION_INIT,
  30   EFI_PXE_DHCP4_FUNCTION_SELECT,
  31   EFI_PXE_DHCP4_FUNCTION_RENEW,
  32   EFI_PXE_DHCP4_FUNCTION_REBIND,
  33   EFI_PXE_DHCP4_FUNCTION_LAST
  34 } EFI_PXE_DHCP4_FUNCTION;
  35
  36 typedef enum {
  37   EFI_PXE_DHCP4_CALLBACK_STATUS_FIRST,
  38   EFI_PXE_DHCP4_CALLBACK_STATUS_ABORT,
  39   EFI_PXE_DHCP4_CALLBACK_STATUS_IGNORE_ABORT,
  40   EFI_PXE_DHCP4_CALLBACK_STATUS_KEEP_ABORT,
  41   EFI_PXE_DHCP4_CALLBACK_STATUS_CONTINUE,
  42   EFI_PXE_DHCP4_CALLBACK_STATUS_IGNORE_CONTINUE,
  43   EFI_PXE_DHCP4_CALLBACK_STATUS_KEEP_CONTINUE,
  44   EFI_PXE_DHCP4_CALLBACK_STATUS_LAST
  45 } EFI_PXE_DHCP4_CALLBACK_STATUS;
  46
  47 typedef
  48 EFI_PXE_DHCP4_CALLBACK_STATUS
  49 (EFIAPI *EFI_PXE_DHCP4_CALLBACK)(
  50   IN EFI_PXE_DHCP4_PROTOCOL *This,
  51   IN EFI_PXE_DHCP4_FUNCTION Function,
  52   IN UINT32                 PacketLen,
  53   IN DHCP4_PACKET           *Packet OPTIONAL
  54   );
  55
  56 struct _EFI_PXE_DHCP4_CALLBACK_PROTOCOL {
  57   UINT64                      Revision;
  58   EFI_PXE_DHCP4_CALLBACK      Callback;
  59 };
  60
  61 extern EFI_GUID gEfiPxeDhcp4CallbackProtocolGuid;
  62
  63 #endif
  64