Sync the latest version from R8.

[mirror_edk2.git] / MdeModulePkg / Universal / Network / Dhcp4Dxe / Dhcp4Io.h

/** @file\r
\r
Copyright (c) 2006, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
\r
Module Name:\r
\r
  Dhcp4Io.h\r
\r
Abstract:\r
\r
  The DHCP4 protocol implementation.\r
\r
\r
**/\r
\r
#ifndef __EFI_DHCP4_IO_H__\r
#define __EFI_DHCP4_IO_H__\r
\r
#include <PiDxe.h>\r
\r
#include <Protocol/ServiceBinding.h>\r
\r
#include <Library/NetLib.h>\r
#include <Library/UdpIoLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
\r
\r
enum {\r
  DHCP_WAIT_OFFER         = 3,              // Time to wait the offers\r
  DHCP_DEFAULT_LEASE      = 7 *24 *60 *60,  // Seven days as default.\r
  DHCP_SERVER_PORT        = 67,\r
  DHCP_CLIENT_PORT        = 68,\r
\r
  //\r
  // BOOTP header "op" field\r
  //\r
  BOOTP_REQUEST           = 1,\r
  BOOTP_REPLY             = 2,\r
\r
  //\r
  // DHCP message types\r
  //\r
  DHCP_MSG_DISCOVER       = 1,\r
  DHCP_MSG_OFFER          = 2,\r
  DHCP_MSG_REQUEST        = 3,\r
  DHCP_MSG_DECLINE        = 4,\r
  DHCP_MSG_ACK            = 5,\r
  DHCP_MSG_NAK            = 6,\r
  DHCP_MSG_RELEASE        = 7,\r
  DHCP_MSG_INFORM         = 8,\r
\r
  //\r
  // DHCP notify user type\r
  //\r
  DHCP_NOTIFY_COMPLETION  = 1,\r
  DHCP_NOTIFY_RENEWREBIND,\r
  DHCP_NOTIFY_ALL\r
};\r
\r
#define DHCP_IS_BOOTP(Parameter)  (((Parameter) == NULL) || ((Parameter)->DhcpType == 0))\r
\r
#define DHCP_CONNECTED(State)     \\r
  (((State) == Dhcp4Bound) || ((State) == (Dhcp4Renewing)) || ((State) == Dhcp4Rebinding))\r
\r
EFI_STATUS\r
DhcpSetState (\r
  IN DHCP_SERVICE           *DhcpSb,\r
  IN INTN                   State,\r
  IN BOOLEAN                CallUser\r
  );\r
\r
EFI_STATUS\r
DhcpSendMessage (\r
  IN DHCP_SERVICE           *DhcpSb,\r
  IN EFI_DHCP4_PACKET       *Seed,\r
  IN DHCP_PARAMETER         *Para,\r
  IN UINT8                  Type,\r
  IN UINT8                  *Msg\r
  );\r
\r
VOID\r
EFIAPI\r
DhcpOnTimerTick (\r
  IN EFI_EVENT              Event,\r
  IN VOID                   *Context\r
  );\r
\r
VOID\r
DhcpInput (\r
  NET_BUF                   *UdpPacket,\r
  UDP_POINTS                *Points,\r
  EFI_STATUS                IoStatus,\r
  VOID                      *Context\r
  );\r
\r
EFI_STATUS\r
DhcpInitRequest (\r
  IN DHCP_SERVICE           *DhcpSb\r
  );\r
\r
VOID\r
DhcpCleanLease (\r
  IN DHCP_SERVICE           *DhcpSb\r
  );\r
\r
VOID\r
DhcpOnPacketSent (\r
  NET_BUF                   *Packet,\r
  UDP_POINTS                *Points,\r
  EFI_STATUS                IoStatus,\r
  VOID                      *Context\r
  );\r
\r
#endif\r