[mirror_edk2.git] / MdeModulePkg / Universal / Network / UefiPxeBcDxe / PxeBcDhcp.h

/** @file\r
  Dhcp and Discover routines for PxeBc.\r
\r
Copyright (c) 2007 - 2011, Intel Corporation. All rights reserved.<BR>\r
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
\r
#ifndef __EFI_PXEBC_DHCP_H__\r
#define __EFI_PXEBC_DHCP_H__\r
\r
#define PXEBC_DHCP4_MAX_OPTION_NUM         16\r
#define PXEBC_DHCP4_MAX_OPTION_SIZE        312\r
#define PXEBC_DHCP4_MAX_PACKET_SIZE        1472\r
\r
#define PXEBC_DHCP4_S_PORT                 67\r
#define PXEBC_DHCP4_C_PORT                 68\r
#define PXEBC_BS_DOWNLOAD_PORT             69\r
#define PXEBC_BS_DISCOVER_PORT             4011\r
\r
#define PXEBC_DHCP4_OPCODE_REQUEST         1\r
#define PXEBC_DHCP4_OPCODE_REPLY           2\r
#define PXEBC_DHCP4_MSG_TYPE_REQUEST       3\r
#define PXEBC_DHCP4_MAGIC                  0x63538263 // network byte order\r
//\r
// Dhcp Options\r
//\r
#define PXEBC_DHCP4_TAG_PAD                0    // Pad Option\r
#define PXEBC_DHCP4_TAG_EOP                255  // End Option\r
#define PXEBC_DHCP4_TAG_NETMASK            1    // Subnet Mask\r
#define PXEBC_DHCP4_TAG_TIME_OFFSET        2    // Time Offset from UTC\r
#define PXEBC_DHCP4_TAG_ROUTER             3    // Router option,\r
#define PXEBC_DHCP4_TAG_TIME_SERVER        4    // Time Server\r
#define PXEBC_DHCP4_TAG_NAME_SERVER        5    // Name Server\r
#define PXEBC_DHCP4_TAG_DNS_SERVER         6    // Domain Name Server\r
#define PXEBC_DHCP4_TAG_HOSTNAME           12   // Host Name\r
#define PXEBC_DHCP4_TAG_BOOTFILE_LEN       13   // Boot File Size\r
#define PXEBC_DHCP4_TAG_DUMP               14   // Merit Dump File\r
#define PXEBC_DHCP4_TAG_DOMAINNAME         15   // Domain Name\r
#define PXEBC_DHCP4_TAG_ROOTPATH           17   // Root path\r
#define PXEBC_DHCP4_TAG_EXTEND_PATH        18   // Extensions Path\r
#define PXEBC_DHCP4_TAG_EMTU               22   // Maximum Datagram Reassembly Size\r
#define PXEBC_DHCP4_TAG_TTL                23   // Default IP Time-to-live\r
#define PXEBC_DHCP4_TAG_BROADCAST          28   // Broadcast Address\r
#define PXEBC_DHCP4_TAG_NIS_DOMAIN         40   // Network Information Service Domain\r
#define PXEBC_DHCP4_TAG_NIS_SERVER         41   // Network Information Servers\r
#define PXEBC_DHCP4_TAG_NTP_SERVER         42   // Network Time Protocol Servers\r
#define PXEBC_DHCP4_TAG_VENDOR             43   // Vendor Specific Information\r
#define PXEBC_DHCP4_TAG_REQUEST_IP         50   // Requested IP Address\r
#define PXEBC_DHCP4_TAG_LEASE              51   // IP Address Lease Time\r
#define PXEBC_DHCP4_TAG_OVERLOAD           52   // Option Overload\r
#define PXEBC_DHCP4_TAG_MSG_TYPE           53   // DHCP Message Type\r
#define PXEBC_DHCP4_TAG_SERVER_ID          54   // Server Identifier\r
#define PXEBC_DHCP4_TAG_PARA_LIST          55   // Parameter Request List\r
#define PXEBC_DHCP4_TAG_MAXMSG             57   // Maximum DHCP Message Size\r
#define PXEBC_DHCP4_TAG_T1                 58   // Renewal (T1) Time Value\r
#define PXEBC_DHCP4_TAG_T2                 59   // Rebinding (T2) Time Value\r
#define PXEBC_DHCP4_TAG_CLASS_ID           60   // Vendor class identifier\r
#define PXEBC_DHCP4_TAG_CLIENT_ID          61   // Client-identifier\r
#define PXEBC_DHCP4_TAG_TFTP               66   // TFTP server name\r
#define PXEBC_DHCP4_TAG_BOOTFILE           67   // Bootfile name\r
#define PXEBC_PXE_DHCP4_TAG_ARCH           93\r
#define PXEBC_PXE_DHCP4_TAG_UNDI           94\r
#define PXEBC_PXE_DHCP4_TAG_UUID           97\r
//\r
// Sub-Options in Dhcp Vendor Option\r
//\r
#define PXEBC_VENDOR_TAG_MTFTP_IP          1\r
#define PXEBC_VENDOR_TAG_MTFTP_CPORT       2\r
#define PXEBC_VENDOR_TAG_MTFTP_SPORT       3\r
#define PXEBC_VENDOR_TAG_MTFTP_TIMEOUT     4\r
#define PXEBC_VENDOR_TAG_MTFTP_DELAY       5\r
#define PXEBC_VENDOR_TAG_DISCOVER_CTRL     6\r
#define PXEBC_VENDOR_TAG_DISCOVER_MCAST    7\r
#define PXEBC_VENDOR_TAG_BOOT_SERVERS      8\r
#define PXEBC_VENDOR_TAG_BOOT_MENU         9\r
#define PXEBC_VENDOR_TAG_MENU_PROMPT       10\r
#define PXEBC_VENDOR_TAG_MCAST_ALLOC       11\r
#define PXEBC_VENDOR_TAG_CREDENTIAL_TYPES  12\r
#define PXEBC_VENDOR_TAG_BOOT_ITEM         71\r
\r
#define PXEBC_DHCP4_DISCOVER_INIT_TIMEOUT  4\r
#define PXEBC_DHCP4_DISCOVER_RETRIES       4\r
\r
#define PXEBC_MAX_MENU_NUM                 24\r
#define PXEBC_MAX_OFFER_NUM                16\r
\r
#define PXEBC_BOOT_REQUEST_TIMEOUT         1\r
#define PXEBC_BOOT_REQUEST_RETRIES         4\r
\r
#define PXEBC_DHCP4_OVERLOAD_FILE          1\r
#define PXEBC_DHCP4_OVERLOAD_SERVER_NAME   2\r
\r
//\r
// The array index of the DHCP4 option tag interested\r
//\r
#define PXEBC_DHCP4_TAG_INDEX_BOOTFILE_LEN 0\r
#define PXEBC_DHCP4_TAG_INDEX_VENDOR       1\r
#define PXEBC_DHCP4_TAG_INDEX_OVERLOAD     2\r
#define PXEBC_DHCP4_TAG_INDEX_MSG_TYPE     3\r
#define PXEBC_DHCP4_TAG_INDEX_SERVER_ID    4\r
#define PXEBC_DHCP4_TAG_INDEX_CLASS_ID     5\r
#define PXEBC_DHCP4_TAG_INDEX_BOOTFILE     6\r
#define PXEBC_DHCP4_TAG_INDEX_MAX          7\r
\r
//\r
// The type of DHCP OFFER, arranged by priority, PXE10 has the highest priority.\r
//\r
#define DHCP4_PACKET_TYPE_PXE10            0\r
#define DHCP4_PACKET_TYPE_WFM11A           1\r
#define DHCP4_PACKET_TYPE_BINL             2\r
#define DHCP4_PACKET_TYPE_DHCP_ONLY        3\r
#define DHCP4_PACKET_TYPE_BOOTP            4\r
#define DHCP4_PACKET_TYPE_MAX              5\r
\r
#define BIT(x)  (1 << x)\r
#define CTRL(x) (0x1F & (x))\r
\r
//\r
// WfM11a options\r
//\r
#define MTFTP_VENDOR_OPTION_BIT_MAP (BIT (PXEBC_VENDOR_TAG_MTFTP_IP) | \\r
                                     BIT (PXEBC_VENDOR_TAG_MTFTP_CPORT) | \\r
                                     BIT (PXEBC_VENDOR_TAG_MTFTP_SPORT) | \\r
                                     BIT (PXEBC_VENDOR_TAG_MTFTP_TIMEOUT) | \\r
                                     BIT (PXEBC_VENDOR_TAG_MTFTP_DELAY))\r
//\r
// Discoverty options\r
//\r
#define DISCOVER_VENDOR_OPTION_BIT_MAP  (BIT (PXEBC_VENDOR_TAG_DISCOVER_CTRL) | \\r
                                         BIT (PXEBC_VENDOR_TAG_DISCOVER_MCAST) | \\r
                                         BIT (PXEBC_VENDOR_TAG_BOOT_SERVERS) | \\r
                                         BIT (PXEBC_VENDOR_TAG_BOOT_MENU) | \\r
                                         BIT (PXEBC_VENDOR_TAG_MENU_PROMPT))\r
\r
#define IS_VALID_BOOT_PROMPT(x) \\r
  ((((x)[0]) & BIT (PXEBC_VENDOR_TAG_MENU_PROMPT)) == BIT (PXEBC_VENDOR_TAG_MENU_PROMPT))\r
\r
#define IS_VALID_BOOT_MENU(x) \\r
  ((((x)[0]) & BIT (PXEBC_VENDOR_TAG_BOOT_MENU)) == BIT (PXEBC_VENDOR_TAG_BOOT_MENU))\r
\r
#define IS_VALID_MTFTP_VENDOR_OPTION(x) \\r
    (((UINT32) ((x)[0]) & MTFTP_VENDOR_OPTION_BIT_MAP) == MTFTP_VENDOR_OPTION_BIT_MAP)\r
\r
#define IS_VALID_DISCOVER_VENDOR_OPTION(x)  (((UINT32) ((x)[0]) & DISCOVER_VENDOR_OPTION_BIT_MAP) != 0)\r
\r
#define IS_VALID_CREDENTIAL_VENDOR_OPTION(x) \\r
    (((UINT32) ((x)[0]) & BIT (PXEBC_VENDOR_TAG_CREDENTIAL_TYPES)) == BIT (PXEBC_VENDOR_TAG_CREDENTIAL_TYPES))\r
\r
#define IS_VALID_BOOTITEM_VENDOR_OPTION(x) \\r
    (((UINT32) ((x)[PXEBC_VENDOR_TAG_BOOT_ITEM / 32]) & BIT (PXEBC_VENDOR_TAG_BOOT_ITEM % 32)) \\r
      == BIT (PXEBC_VENDOR_TAG_BOOT_ITEM % 32))\r
\r
#define IS_DISABLE_BCAST_DISCOVER(x)    (((x) & BIT (0)) == BIT (0))\r
#define IS_DISABLE_MCAST_DISCOVER(x)    (((x) & BIT (1)) == BIT (1))\r
#define IS_ENABLE_USE_SERVER_LIST(x)    (((x) & BIT (2)) == BIT (2))\r
#define IS_ENABLE_BOOT_FILE_NAME(x)     (((x) & BIT (3)) == BIT (3))\r
\r
#define SET_VENDOR_OPTION_BIT_MAP(x, y) (((x)[(y) / 32]) = (UINT32) ((x)[(y) / 32]) | BIT ((y) % 32))\r
\r
#pragma pack(1)\r
typedef struct {\r
  UINT8 ParaList[135];\r
} PXEBC_DHCP4_OPTION_PARA;\r
\r
typedef struct {\r
  UINT16  Size;\r
} PXEBC_DHCP4_OPTION_MAX_MESG_SIZE;\r
\r
typedef struct {\r
  UINT8 Type;\r
  UINT8 MajorVer;\r
  UINT8 MinorVer;\r
} PXEBC_DHCP4_OPTION_UNDI;\r
\r
typedef struct {\r
  UINT8 Type;\r
} PXEBC_DHCP4_OPTION_MESG;\r
\r
typedef struct {\r
  UINT16  Type;\r
} PXEBC_DHCP4_OPTION_ARCH;\r
\r
#define DEFAULT_CLASS_ID_DATA "PXEClient:Arch:xxxxx:UNDI:003000"\r
#define DEFAULT_UNDI_TYPE     1\r
#define DEFAULT_UNDI_MAJOR    3\r
#define DEFAULT_UNDI_MINOR    0\r
\r
typedef struct {\r
  UINT8 ClassIdentifier[10];\r
  UINT8 ArchitecturePrefix[5];\r
  UINT8 ArchitectureType[5];\r
  UINT8 Lit3[1];\r
  UINT8 InterfaceName[4];\r
  UINT8 Lit4[1];\r
  UINT8 UndiMajor[3];\r
  UINT8 UndiMinor[3];\r
} PXEBC_DHCP4_OPTION_CLID;\r
\r
typedef struct {\r
  UINT8 Type;\r
  UINT8 Guid[16];\r
} PXEBC_DHCP4_OPTION_UUID;\r
\r
typedef struct {\r
  UINT16  Type;\r
  UINT16  Layer;\r
} PXEBC_OPTION_BOOT_ITEM;\r
\r
#pragma pack()\r
\r
typedef union {\r
  PXEBC_DHCP4_OPTION_PARA           *Para;\r
  PXEBC_DHCP4_OPTION_UNDI           *Undi;\r
  PXEBC_DHCP4_OPTION_ARCH           *Arch;\r
  PXEBC_DHCP4_OPTION_CLID           *Clid;\r
  PXEBC_DHCP4_OPTION_UUID           *Uuid;\r
  PXEBC_DHCP4_OPTION_MESG           *Mesg;\r
  PXEBC_DHCP4_OPTION_MAX_MESG_SIZE  *MaxMesgSize;\r
} PXEBC_DHCP4_OPTION_ENTRY;\r
\r
typedef struct {\r
  UINT16            Type;\r
  UINT8             IpCnt;\r
  EFI_IPv4_ADDRESS  IpAddr[1];\r
} PXEBC_BOOT_SVR_ENTRY;\r
\r
typedef struct {\r
  UINT16  Type;\r
  UINT8   DescLen;\r
  UINT8   DescStr[1];\r
} PXEBC_BOOT_MENU_ENTRY;\r
\r
typedef struct {\r
  UINT8 Timeout;\r
  UINT8 Prompt[1];\r
} PXEBC_MENU_PROMPT;\r
\r
typedef struct {\r
  UINT32                BitMap[8];\r
  EFI_IPv4_ADDRESS      MtftpIp;\r
  UINT16                MtftpCPort;\r
  UINT16                MtftpSPort;\r
  UINT8                 MtftpTimeout;\r
  UINT8                 MtftpDelay;\r
  UINT8                 DiscoverCtrl;\r
  EFI_IPv4_ADDRESS      DiscoverMcastIp;\r
  EFI_IPv4_ADDRESS      McastIpBase;\r
  UINT16                McastIpBlock;\r
  UINT16                McastIpRange;\r
  UINT16                BootSrvType;\r
  UINT16                BootSrvLayer;\r
  PXEBC_BOOT_SVR_ENTRY  *BootSvr;\r
  UINT8                 BootSvrLen;\r
  PXEBC_BOOT_MENU_ENTRY *BootMenu;\r
  UINT8                 BootMenuLen;\r
  PXEBC_MENU_PROMPT     *MenuPrompt;\r
  UINT8                 MenuPromptLen;\r
  UINT32                *CredType;\r
  UINT8                 CredTypeLen;\r
} PXEBC_VENDOR_OPTION;\r
\r
#define PXEBC_CACHED_DHCP4_PACKET_MAX_SIZE  (OFFSET_OF (EFI_DHCP4_PACKET, Dhcp4) + PXEBC_DHCP4_MAX_PACKET_SIZE)\r
\r
typedef union {\r
  EFI_DHCP4_PACKET  Offer;\r
  EFI_DHCP4_PACKET  Ack;\r
  UINT8             Buffer[PXEBC_CACHED_DHCP4_PACKET_MAX_SIZE];\r
} PXEBC_DHCP4_PACKET;\r
\r
typedef struct {\r
  PXEBC_DHCP4_PACKET      Packet;\r
  BOOLEAN                 IsPxeOffer;\r
  UINT8                   OfferType;\r
  EFI_DHCP4_PACKET_OPTION *Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_MAX];\r
  PXEBC_VENDOR_OPTION    PxeVendorOption;\r
} PXEBC_CACHED_DHCP4_PACKET;\r
\r
#define GET_NEXT_DHCP_OPTION(Opt) \\r
  (EFI_DHCP4_PACKET_OPTION *) ((UINT8 *) (Opt) + sizeof (EFI_DHCP4_PACKET_OPTION) + (Opt)->Length - 1)\r
\r
#define GET_OPTION_BUFFER_LEN(Pkt)  ((Pkt)->Length - sizeof (EFI_DHCP4_HEADER) - 4)\r
#define IS_PROXY_DHCP_OFFER(Offer)  EFI_IP4_EQUAL (&((Offer)->Dhcp4.Header.YourAddr), &mZeroIp4Addr)\r
\r
#define GET_NEXT_BOOT_SVR_ENTRY(Ent) \\r
  (PXEBC_BOOT_SVR_ENTRY *) ((UINT8 *) Ent + sizeof (*(Ent)) + ((Ent)->IpCnt - 1) * sizeof (EFI_IPv4_ADDRESS))\r
\r
\r
/**\r
  This function initialize the DHCP4 message instance.\r
\r
  This function will pad each item of dhcp4 message packet.\r
  \r
  @param  Seed    Pointer to the message instance of the DHCP4 packet.\r
  @param  Udp4    Pointer to the EFI_UDP4_PROTOCOL instance.\r
\r
**/\r
VOID\r
PxeBcInitSeedPacket (\r
  IN EFI_DHCP4_PACKET  *Seed,\r
  IN EFI_UDP4_PROTOCOL *Udp4\r
  );\r
\r
\r
/**\r
  Parse the cached dhcp packet.\r
\r
  @param  CachedPacket  Pointer to cached dhcp packet.\r
\r
  @retval TRUE          Succeed to parse and validation.\r
  @retval FALSE         Fail to parse or validation.\r
\r
**/\r
BOOLEAN\r
PxeBcParseCachedDhcpPacket (\r
  IN PXEBC_CACHED_DHCP4_PACKET  *CachedPacket\r
  );\r
\r
/**\r
  This function is to check the selected proxy offer (include BINL dhcp offer and\r
  DHCP_ONLY offer ) and set the flag and copy the DHCP packets to the Pxe base code\r
  mode structure.\r
\r
  @param  Private          Pointer to PxeBc private data.\r
\r
  @retval EFI_SUCCESS      Operational successful.\r
  @retval EFI_NO_RESPONSE  Offer dhcp service failed.\r
\r
**/\r
EFI_STATUS\r
PxeBcCheckSelectedOffer (\r
  IN PXEBC_PRIVATE_DATA  *Private\r
  );\r
\r
\r
/**\r
  Callback routine.\r
  \r
  EFI_DHCP4_CALLBACK is provided by the consumer of the EFI DHCPv4 Protocol driver\r
  to intercept events that occurred in the configuration process. This structure\r
  provides advanced control of each state transition of the DHCP process. The\r
  returned status code determines the behavior of the EFI DHCPv4 Protocol driver.\r
  There are three possible returned values, which are described in the following\r
  table.\r
\r
  @param  This                  Pointer to the EFI DHCPv4 Protocol instance that is used to\r
                                configure this callback function.\r
  @param  Context               Pointer to the context that is initialized by\r
                                EFI_DHCP4_PROTOCOL.Configure().\r
  @param  CurrentState          The current operational state of the EFI DHCPv4 Protocol\r
                                driver.\r
  @param  Dhcp4Event            The event that occurs in the current state, which usually means a\r
                                state transition.\r
  @param  Packet                The DHCP packet that is going to be sent or already received.\r
  @param  NewPacket             The packet that is used to replace the above Packet.\r
\r
  @retval EFI_SUCCESS           Tells the EFI DHCPv4 Protocol driver to continue the DHCP process.\r
  @retval EFI_NOT_READY         Only used in the Dhcp4Selecting state. The EFI DHCPv4 Protocol\r
                                driver will continue to wait for more DHCPOFFER packets until the retry\r
                                timeout expires.\r
  @retval EFI_ABORTED           Tells the EFI DHCPv4 Protocol driver to abort the current process and\r
                                return to the Dhcp4Init or Dhcp4InitReboot state.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PxeBcDhcpCallBack (\r
  IN EFI_DHCP4_PROTOCOL                * This,\r
  IN VOID                              *Context,\r
  IN EFI_DHCP4_STATE                   CurrentState,\r
  IN EFI_DHCP4_EVENT                   Dhcp4Event,\r
  IN EFI_DHCP4_PACKET                  * Packet OPTIONAL,\r
  OUT EFI_DHCP4_PACKET                 **NewPacket OPTIONAL\r
  );\r
\r
\r
/**\r
  Discover the boot of service and initialize the vendor option if exists.\r
\r
  @param  Private               Pointer to PxeBc private data.\r
  @param  Type                  PxeBc option boot item type\r
  @param  Layer                 PxeBc option boot item layer\r
  @param  UseBis                Use BIS or not\r
  @param  DestIp                Ip address for server      \r
  @param  IpCount               The total count of the server ip address    \r
  @param  SrvList               Server list\r
  @param  IsDiscv               Discover the vendor or not\r
  @param  Reply                 The dhcp4 packet of Pxe reply\r
\r
  @retval EFI_SUCCESS           Operation succeeds.\r
  @retval EFI_OUT_OF_RESOURCES  Allocate memory pool failed.\r
  @retval EFI_NOT_FOUND         There is no vendor option exists.\r
  @retval EFI_TIMEOUT           Send Pxe Discover time out. \r
  \r
**/\r
EFI_STATUS\r
PxeBcDiscvBootService (\r
  IN PXEBC_PRIVATE_DATA                * Private,\r
  IN UINT16                            Type,\r
  IN UINT16                            *Layer,\r
  IN BOOLEAN                           UseBis,\r
  IN EFI_IP_ADDRESS                    * DestIp,\r
  IN UINT16                            IpCount,\r
  IN EFI_PXE_BASE_CODE_SRVLIST         * SrvList,\r
  IN BOOLEAN                           IsDiscv,\r
  OUT EFI_DHCP4_PACKET                 * Reply OPTIONAL\r
  );\r
\r
\r
/**\r
  Initialize the DHCP options and build the option list.\r
\r
  @param  Private          Pointer to PxeBc private data.\r
  @param  OptList          Pointer to a DHCP option list.\r
                           \r
  @param  IsDhcpDiscover   Discover dhcp option or not.     \r
\r
  @return The index item number of the option list.\r
\r
**/\r
UINT32\r
PxeBcBuildDhcpOptions (\r
  IN PXEBC_PRIVATE_DATA            *Private,\r
  IN EFI_DHCP4_PACKET_OPTION       **OptList,\r
  IN BOOLEAN                       IsDhcpDiscover\r
  );\r
\r
\r
/**\r
  Create the boot options.\r
\r
  @param  OptList    Pointer to the list of the options\r
  @param  Type       the type of option\r
  @param  Layer      the layer of the boot options \r
  @param  OptLen     length of opotion\r
\r
**/\r
VOID\r
PxeBcCreateBootOptions (\r
  IN  EFI_DHCP4_PACKET_OPTION          *OptList,\r
  IN  UINT16                           Type,\r
  IN  UINT16                           *Layer,\r
  OUT UINT32                           *OptLen\r
  );\r
\r
\r
/**\r
  Parse interested dhcp options.\r
\r
  @param  Buffer     Pointer to the dhcp options packet.\r
  @param  Length     The length of the dhcp options.\r
  @param  OptTag     The option OpCode.\r
\r
  @return NULL if the buffer length is 0 and OpCode is not \r
          PXEBC_DHCP4_TAG_EOP, or the pointer to the buffer.\r
\r
**/\r
EFI_DHCP4_PACKET_OPTION *\r
PxeBcParseExtendOptions (\r
  IN UINT8                         *Buffer,\r
  IN UINT32                        Length,\r
  IN UINT8                         OptTag\r
  );\r
\r
\r
/**\r
  This function is to parse and check vendor options.\r
\r
  @param  Dhcp4Option           Pointer to dhcp options\r
  @param  VendorOption          Pointer to vendor options\r
\r
  @return TRUE if valid for vendor options, or FALSE.\r
\r
**/\r
BOOLEAN\r
PxeBcParseVendorOptions (\r
  IN EFI_DHCP4_PACKET_OPTION       *Dhcp4Option,\r
  IN PXEBC_VENDOR_OPTION           *VendorOption\r
  );\r
\r
\r
/**\r
  Choose the boot prompt.\r
\r
  @param  Private              Pointer to PxeBc private data.\r
\r
  @retval EFI_SUCCESS          Select boot prompt done.\r
  @retval EFI_TIMEOUT          Select boot prompt time out. \r
  @retval EFI_NOT_FOUND        The proxy offer is not Pxe10.\r
  @retval EFI_ABORTED          User cancel the operation.\r
  @retval EFI_NOT_READY        Read the input key from the keybroad has not finish.\r
  \r
**/\r
EFI_STATUS\r
PxeBcSelectBootPrompt (\r
  IN PXEBC_PRIVATE_DATA              *Private\r
  );\r
\r
\r
/**\r
  Select the boot menu.\r
\r
  @param  Private         Pointer to PxeBc private data.\r
  @param  Type            The type of the menu.\r
  @param  UseDefaultItem  Use default item or not.\r
  \r
  @retval EFI_ABORTED     User cancel operation.\r
  @retval EFI_SUCCESS     Select the boot menu success.\r
  @retval EFI_NOT_READY   Read the input key from the keybroad has not finish.    \r
\r
**/\r
EFI_STATUS\r
PxeBcSelectBootMenu (\r
  IN  PXEBC_PRIVATE_DATA              *Private,\r
  OUT UINT16                          *Type,\r
  IN  BOOLEAN                         UseDefaultItem\r
  );\r
\r
#endif\r
\r
Commit	Line	Data
30368135	1	/** @file\r
f737cfb9	2	Dhcp and Discover routines for PxeBc.\r
30368135	3	\r
379db4ac	4	Copyright (c) 2007 - 2011, Intel Corporation. All rights reserved.<BR>\r
e5eed7d3	5	This program and the accompanying materials\r
30368135	6	are licensed and made available under the terms and conditions of the BSD License\r
	7	which accompanies this distribution. The full text of the license may be found at\r
	8	http://opensource.org/licenses/bsd-license.php\r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	12	\r
30368135	13	**/\r
	14	\r
	15	#ifndef __EFI_PXEBC_DHCP_H__\r
	16	#define __EFI_PXEBC_DHCP_H__\r
	17	\r
f6b7393c	18	#define PXEBC_DHCP4_MAX_OPTION_NUM 16\r
	19	#define PXEBC_DHCP4_MAX_OPTION_SIZE 312\r
	20	#define PXEBC_DHCP4_MAX_PACKET_SIZE 1472\r
	21	\r
	22	#define PXEBC_DHCP4_S_PORT 67\r
	23	#define PXEBC_DHCP4_C_PORT 68\r
	24	#define PXEBC_BS_DOWNLOAD_PORT 69\r
	25	#define PXEBC_BS_DISCOVER_PORT 4011\r
	26	\r
	27	#define PXEBC_DHCP4_OPCODE_REQUEST 1\r
	28	#define PXEBC_DHCP4_OPCODE_REPLY 2\r
	29	#define PXEBC_DHCP4_MSG_TYPE_REQUEST 3\r
	30	#define PXEBC_DHCP4_MAGIC 0x63538263 // network byte order\r
	31	//\r
	32	// Dhcp Options\r
	33	//\r
	34	#define PXEBC_DHCP4_TAG_PAD 0 // Pad Option\r
	35	#define PXEBC_DHCP4_TAG_EOP 255 // End Option\r
	36	#define PXEBC_DHCP4_TAG_NETMASK 1 // Subnet Mask\r
	37	#define PXEBC_DHCP4_TAG_TIME_OFFSET 2 // Time Offset from UTC\r
	38	#define PXEBC_DHCP4_TAG_ROUTER 3 // Router option,\r
	39	#define PXEBC_DHCP4_TAG_TIME_SERVER 4 // Time Server\r
	40	#define PXEBC_DHCP4_TAG_NAME_SERVER 5 // Name Server\r
	41	#define PXEBC_DHCP4_TAG_DNS_SERVER 6 // Domain Name Server\r
	42	#define PXEBC_DHCP4_TAG_HOSTNAME 12 // Host Name\r
	43	#define PXEBC_DHCP4_TAG_BOOTFILE_LEN 13 // Boot File Size\r
	44	#define PXEBC_DHCP4_TAG_DUMP 14 // Merit Dump File\r
	45	#define PXEBC_DHCP4_TAG_DOMAINNAME 15 // Domain Name\r
	46	#define PXEBC_DHCP4_TAG_ROOTPATH 17 // Root path\r
	47	#define PXEBC_DHCP4_TAG_EXTEND_PATH 18 // Extensions Path\r
	48	#define PXEBC_DHCP4_TAG_EMTU 22 // Maximum Datagram Reassembly Size\r
	49	#define PXEBC_DHCP4_TAG_TTL 23 // Default IP Time-to-live\r
	50	#define PXEBC_DHCP4_TAG_BROADCAST 28 // Broadcast Address\r
	51	#define PXEBC_DHCP4_TAG_NIS_DOMAIN 40 // Network Information Service Domain\r
	52	#define PXEBC_DHCP4_TAG_NIS_SERVER 41 // Network Information Servers\r
	53	#define PXEBC_DHCP4_TAG_NTP_SERVER 42 // Network Time Protocol Servers\r
	54	#define PXEBC_DHCP4_TAG_VENDOR 43 // Vendor Specific Information\r
	55	#define PXEBC_DHCP4_TAG_REQUEST_IP 50 // Requested IP Address\r
	56	#define PXEBC_DHCP4_TAG_LEASE 51 // IP Address Lease Time\r
	57	#define PXEBC_DHCP4_TAG_OVERLOAD 52 // Option Overload\r
	58	#define PXEBC_DHCP4_TAG_MSG_TYPE 53 // DHCP Message Type\r
	59	#define PXEBC_DHCP4_TAG_SERVER_ID 54 // Server Identifier\r
	60	#define PXEBC_DHCP4_TAG_PARA_LIST 55 // Parameter Request List\r
	61	#define PXEBC_DHCP4_TAG_MAXMSG 57 // Maximum DHCP Message Size\r
	62	#define PXEBC_DHCP4_TAG_T1 58 // Renewal (T1) Time Value\r
	63	#define PXEBC_DHCP4_TAG_T2 59 // Rebinding (T2) Time Value\r
	64	#define PXEBC_DHCP4_TAG_CLASS_ID 60 // Vendor class identifier\r
	65	#define PXEBC_DHCP4_TAG_CLIENT_ID 61 // Client-identifier\r
	66	#define PXEBC_DHCP4_TAG_TFTP 66 // TFTP server name\r
	67	#define PXEBC_DHCP4_TAG_BOOTFILE 67 // Bootfile name\r
	68	#define PXEBC_PXE_DHCP4_TAG_ARCH 93\r
	69	#define PXEBC_PXE_DHCP4_TAG_UNDI 94\r
	70	#define PXEBC_PXE_DHCP4_TAG_UUID 97\r
	71	//\r
	72	// Sub-Options in Dhcp Vendor Option\r
	73	//\r
	74	#define PXEBC_VENDOR_TAG_MTFTP_IP 1\r
	75	#define PXEBC_VENDOR_TAG_MTFTP_CPORT 2\r
	76	#define PXEBC_VENDOR_TAG_MTFTP_SPORT 3\r
	77	#define PXEBC_VENDOR_TAG_MTFTP_TIMEOUT 4\r
	78	#define PXEBC_VENDOR_TAG_MTFTP_DELAY 5\r
	79	#define PXEBC_VENDOR_TAG_DISCOVER_CTRL 6\r
	80	#define PXEBC_VENDOR_TAG_DISCOVER_MCAST 7\r
	81	#define PXEBC_VENDOR_TAG_BOOT_SERVERS 8\r
82	#define PXEBC_VENDOR_TAG_BOOT_MENU 9\r
83	#define PXEBC_VENDOR_TAG_MENU_PROMPT 10\r
84	#define PXEBC_VENDOR_TAG_MCAST_ALLOC 11\r
85	#define PXEBC_VENDOR_TAG_CREDENTIAL_TYPES 12\r
86	#define PXEBC_VENDOR_TAG_BOOT_ITEM 71\r
87	\r
88	#define PXEBC_DHCP4_DISCOVER_INIT_TIMEOUT 4\r
89	#define PXEBC_DHCP4_DISCOVER_RETRIES 4\r
90	\r
91	#define PXEBC_MAX_MENU_NUM 24\r
92	#define PXEBC_MAX_OFFER_NUM 16\r
93	\r
94	#define PXEBC_BOOT_REQUEST_TIMEOUT 1\r
95	#define PXEBC_BOOT_REQUEST_RETRIES 4\r
96	\r
97	#define PXEBC_DHCP4_OVERLOAD_FILE 1\r
98	#define PXEBC_DHCP4_OVERLOAD_SERVER_NAME 2\r
30368135	99	\r
	100	//\r
	101	// The array index of the DHCP4 option tag interested\r
	102	//\r
f6b7393c	103	#define PXEBC_DHCP4_TAG_INDEX_BOOTFILE_LEN 0\r
	104	#define PXEBC_DHCP4_TAG_INDEX_VENDOR 1\r
	105	#define PXEBC_DHCP4_TAG_INDEX_OVERLOAD 2\r
	106	#define PXEBC_DHCP4_TAG_INDEX_MSG_TYPE 3\r
	107	#define PXEBC_DHCP4_TAG_INDEX_SERVER_ID 4\r
	108	#define PXEBC_DHCP4_TAG_INDEX_CLASS_ID 5\r
	109	#define PXEBC_DHCP4_TAG_INDEX_BOOTFILE 6\r
	110	#define PXEBC_DHCP4_TAG_INDEX_MAX 7\r
30368135	111	\r
	112	//\r
	113	// The type of DHCP OFFER, arranged by priority, PXE10 has the highest priority.\r
	114	//\r
f6b7393c	115	#define DHCP4_PACKET_TYPE_PXE10 0\r
	116	#define DHCP4_PACKET_TYPE_WFM11A 1\r
	117	#define DHCP4_PACKET_TYPE_BINL 2\r
	118	#define DHCP4_PACKET_TYPE_DHCP_ONLY 3\r
379db4ac	119	#define DHCP4_PACKET_TYPE_BOOTP 4\r
379db4ac	120	#define DHCP4_PACKET_TYPE_MAX 5\r
30368135	121	\r
	122	#define BIT(x) (1 << x)\r
	123	#define CTRL(x) (0x1F & (x))\r
	124	\r
	125	//\r
	126	// WfM11a options\r
	127	//\r
	128	#define MTFTP_VENDOR_OPTION_BIT_MAP (BIT (PXEBC_VENDOR_TAG_MTFTP_IP) \| \\r
	129	BIT (PXEBC_VENDOR_TAG_MTFTP_CPORT) \| \\r
	130	BIT (PXEBC_VENDOR_TAG_MTFTP_SPORT) \| \\r
	131	BIT (PXEBC_VENDOR_TAG_MTFTP_TIMEOUT) \| \\r
	132	BIT (PXEBC_VENDOR_TAG_MTFTP_DELAY))\r
	133	//\r
	134	// Discoverty options\r
	135	//\r
	136	#define DISCOVER_VENDOR_OPTION_BIT_MAP (BIT (PXEBC_VENDOR_TAG_DISCOVER_CTRL) \| \\r
	137	BIT (PXEBC_VENDOR_TAG_DISCOVER_MCAST) \| \\r
	138	BIT (PXEBC_VENDOR_TAG_BOOT_SERVERS) \| \\r
	139	BIT (PXEBC_VENDOR_TAG_BOOT_MENU) \| \\r
	140	BIT (PXEBC_VENDOR_TAG_MENU_PROMPT))\r
	141	\r
	142	#define IS_VALID_BOOT_PROMPT(x) \\r
	143	((((x)[0]) & BIT (PXEBC_VENDOR_TAG_MENU_PROMPT)) == BIT (PXEBC_VENDOR_TAG_MENU_PROMPT))\r
	144	\r
	145	#define IS_VALID_BOOT_MENU(x) \\r
	146	((((x)[0]) & BIT (PXEBC_VENDOR_TAG_BOOT_MENU)) == BIT (PXEBC_VENDOR_TAG_BOOT_MENU))\r
	147	\r
	148	#define IS_VALID_MTFTP_VENDOR_OPTION(x) \\r
	149	(((UINT32) ((x)[0]) & MTFTP_VENDOR_OPTION_BIT_MAP) == MTFTP_VENDOR_OPTION_BIT_MAP)\r
	150	\r
	151	#define IS_VALID_DISCOVER_VENDOR_OPTION(x) (((UINT32) ((x)[0]) & DISCOVER_VENDOR_OPTION_BIT_MAP) != 0)\r
	152	\r
	153	#define IS_VALID_CREDENTIAL_VENDOR_OPTION(x) \\r
	154	(((UINT32) ((x)[0]) & BIT (PXEBC_VENDOR_TAG_CREDENTIAL_TYPES)) == BIT (PXEBC_VENDOR_TAG_CREDENTIAL_TYPES))\r
	155	\r
	156	#define IS_VALID_BOOTITEM_VENDOR_OPTION(x) \\r
	157	(((UINT32) ((x)[PXEBC_VENDOR_TAG_BOOT_ITEM / 32]) & BIT (PXEBC_VENDOR_TAG_BOOT_ITEM % 32)) \\r
	158	== BIT (PXEBC_VENDOR_TAG_BOOT_ITEM % 32))\r
	159	\r
	160	#define IS_DISABLE_BCAST_DISCOVER(x) (((x) & BIT (0)) == BIT (0))\r
	161	#define IS_DISABLE_MCAST_DISCOVER(x) (((x) & BIT (1)) == BIT (1))\r
	162	#define IS_ENABLE_USE_SERVER_LIST(x) (((x) & BIT (2)) == BIT (2))\r
	163	#define IS_ENABLE_BOOT_FILE_NAME(x) (((x) & BIT (3)) == BIT (3))\r
	164	\r
	165	#define SET_VENDOR_OPTION_BIT_MAP(x, y) (((x)[(y) / 32]) = (UINT32) ((x)[(y) / 32]) \| BIT ((y) % 32))\r
	166	\r
	167	#pragma pack(1)\r
	168	typedef struct {\r
	169	UINT8 ParaList[135];\r
	170	} PXEBC_DHCP4_OPTION_PARA;\r
	171	\r
	172	typedef struct {\r
	173	UINT16 Size;\r
	174	} PXEBC_DHCP4_OPTION_MAX_MESG_SIZE;\r
	175	\r
	176	typedef struct {\r
	177	UINT8 Type;\r
	178	UINT8 MajorVer;\r
	179	UINT8 MinorVer;\r
	180	} PXEBC_DHCP4_OPTION_UNDI;\r
	181	\r
	182	typedef struct {\r
	183	UINT8 Type;\r
	184	} PXEBC_DHCP4_OPTION_MESG;\r
185	\r
186	typedef struct {\r
187	UINT16 Type;\r
188	} PXEBC_DHCP4_OPTION_ARCH;\r
189	\r
169a3461	190	#define DEFAULT_CLASS_ID_DATA "PXEClient:Arch:xxxxx:UNDI:003000"\r
	191	#define DEFAULT_UNDI_TYPE 1\r
	192	#define DEFAULT_UNDI_MAJOR 3\r
	193	#define DEFAULT_UNDI_MINOR 0\r
30368135	194	\r
	195	typedef struct {\r
	196	UINT8 ClassIdentifier[10];\r
	197	UINT8 ArchitecturePrefix[5];\r
	198	UINT8 ArchitectureType[5];\r
	199	UINT8 Lit3[1];\r
	200	UINT8 InterfaceName[4];\r
	201	UINT8 Lit4[1];\r
	202	UINT8 UndiMajor[3];\r
	203	UINT8 UndiMinor[3];\r
	204	} PXEBC_DHCP4_OPTION_CLID;\r
	205	\r
	206	typedef struct {\r
	207	UINT8 Type;\r
	208	UINT8 Guid[16];\r
	209	} PXEBC_DHCP4_OPTION_UUID;\r
	210	\r
	211	typedef struct {\r
	212	UINT16 Type;\r
	213	UINT16 Layer;\r
	214	} PXEBC_OPTION_BOOT_ITEM;\r
	215	\r
	216	#pragma pack()\r
	217	\r
	218	typedef union {\r
	219	PXEBC_DHCP4_OPTION_PARA *Para;\r
	220	PXEBC_DHCP4_OPTION_UNDI *Undi;\r
	221	PXEBC_DHCP4_OPTION_ARCH *Arch;\r
	222	PXEBC_DHCP4_OPTION_CLID *Clid;\r
	223	PXEBC_DHCP4_OPTION_UUID *Uuid;\r
	224	PXEBC_DHCP4_OPTION_MESG *Mesg;\r
	225	PXEBC_DHCP4_OPTION_MAX_MESG_SIZE *MaxMesgSize;\r
	226	} PXEBC_DHCP4_OPTION_ENTRY;\r
	227	\r
	228	typedef struct {\r
	229	UINT16 Type;\r
	230	UINT8 IpCnt;\r
	231	EFI_IPv4_ADDRESS IpAddr[1];\r
	232	} PXEBC_BOOT_SVR_ENTRY;\r
	233	\r
	234	typedef struct {\r
	235	UINT16 Type;\r
	236	UINT8 DescLen;\r
	237	UINT8 DescStr[1];\r
	238	} PXEBC_BOOT_MENU_ENTRY;\r
	239	\r
	240	typedef struct {\r
	241	UINT8 Timeout;\r
	242	UINT8 Prompt[1];\r
	243	} PXEBC_MENU_PROMPT;\r
	244	\r
	245	typedef struct {\r
	246	UINT32 BitMap[8];\r
	247	EFI_IPv4_ADDRESS MtftpIp;\r
	248	UINT16 MtftpCPort;\r
	249	UINT16 MtftpSPort;\r
	250	UINT8 MtftpTimeout;\r
	251	UINT8 MtftpDelay;\r
	252	UINT8 DiscoverCtrl;\r
	253	EFI_IPv4_ADDRESS DiscoverMcastIp;\r
	254	EFI_IPv4_ADDRESS McastIpBase;\r
	255	UINT16 McastIpBlock;\r
	256	UINT16 McastIpRange;\r
	257	UINT16 BootSrvType;\r
258	UINT16 BootSrvLayer;\r
259	PXEBC_BOOT_SVR_ENTRY *BootSvr;\r
260	UINT8 BootSvrLen;\r
261	PXEBC_BOOT_MENU_ENTRY *BootMenu;\r
262	UINT8 BootMenuLen;\r
263	PXEBC_MENU_PROMPT *MenuPrompt;\r
264	UINT8 MenuPromptLen;\r
265	UINT32 *CredType;\r
266	UINT8 CredTypeLen;\r
267	} PXEBC_VENDOR_OPTION;\r
268	\r
f3f2e05d	269	#define PXEBC_CACHED_DHCP4_PACKET_MAX_SIZE (OFFSET_OF (EFI_DHCP4_PACKET, Dhcp4) + PXEBC_DHCP4_MAX_PACKET_SIZE)\r
30368135	270	\r
f6b7393c	271	typedef union {\r
	272	EFI_DHCP4_PACKET Offer;\r
	273	EFI_DHCP4_PACKET Ack;\r
	274	UINT8 Buffer[PXEBC_CACHED_DHCP4_PACKET_MAX_SIZE];\r
	275	} PXEBC_DHCP4_PACKET;\r
30368135	276	\r
f6b7393c	277	typedef struct {\r
f6b7393c	278	PXEBC_DHCP4_PACKET Packet;\r
30368135	279	BOOLEAN IsPxeOffer;\r
	280	UINT8 OfferType;\r
	281	EFI_DHCP4_PACKET_OPTION *Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_MAX];\r
	282	PXEBC_VENDOR_OPTION PxeVendorOption;\r
	283	} PXEBC_CACHED_DHCP4_PACKET;\r
	284	\r
	285	#define GET_NEXT_DHCP_OPTION(Opt) \\r
	286	(EFI_DHCP4_PACKET_OPTION ) ((UINT8 ) (Opt) + sizeof (EFI_DHCP4_PACKET_OPTION) + (Opt)->Length - 1)\r
	287	\r
	288	#define GET_OPTION_BUFFER_LEN(Pkt) ((Pkt)->Length - sizeof (EFI_DHCP4_HEADER) - 4)\r
	289	#define IS_PROXY_DHCP_OFFER(Offer) EFI_IP4_EQUAL (&((Offer)->Dhcp4.Header.YourAddr), &mZeroIp4Addr)\r
	290	\r
	291	#define GET_NEXT_BOOT_SVR_ENTRY(Ent) \\r
	292	(PXEBC_BOOT_SVR_ENTRY ) ((UINT8 ) Ent + sizeof ((Ent)) + ((Ent)->IpCnt - 1) sizeof (EFI_IPv4_ADDRESS))\r
	293	\r
f737cfb9	294	\r
	295	/**\r
	296	This function initialize the DHCP4 message instance.\r
	297	\r
	298	This function will pad each item of dhcp4 message packet.\r
	299	\r
	300	@param Seed Pointer to the message instance of the DHCP4 packet.\r
	301	@param Udp4 Pointer to the EFI_UDP4_PROTOCOL instance.\r
	302	\r
f737cfb9	303	**/\r
30368135	304	VOID\r
	305	PxeBcInitSeedPacket (\r
	306	IN EFI_DHCP4_PACKET *Seed,\r
	307	IN EFI_UDP4_PROTOCOL *Udp4\r
d59b8b55	308	);\r
30368135	309	\r
	310	\r
	311	/**\r
f737cfb9	312	Parse the cached dhcp packet.\r
30368135	313	\r
f737cfb9	314	@param CachedPacket Pointer to cached dhcp packet.\r
30368135	315	\r
d59b8b55	316	@retval TRUE Succeed to parse and validation.\r
f737cfb9	317	@retval FALSE Fail to parse or validation.\r
30368135	318	\r
	319	**/\r
	320	BOOLEAN\r
	321	PxeBcParseCachedDhcpPacket (\r
	322	IN PXEBC_CACHED_DHCP4_PACKET *CachedPacket\r
d59b8b55	323	);\r
30368135	324	\r
30368135	325	/**\r
d59b8b55	326	This function is to check the selected proxy offer (include BINL dhcp offer and\r
f737cfb9	327	DHCP_ONLY offer ) and set the flag and copy the DHCP packets to the Pxe base code\r
f737cfb9	328	mode structure.\r
30368135	329	\r
f737cfb9	330	@param Private Pointer to PxeBc private data.\r
30368135	331	\r
f737cfb9	332	@retval EFI_SUCCESS Operational successful.\r
f737cfb9	333	@retval EFI_NO_RESPONSE Offer dhcp service failed.\r
30368135	334	\r
	335	**/\r
	336	EFI_STATUS\r
	337	PxeBcCheckSelectedOffer (\r
	338	IN PXEBC_PRIVATE_DATA *Private\r
d59b8b55	339	);\r
30368135	340	\r
	341	\r
	342	/**\r
f737cfb9	343	Callback routine.\r
	344	\r
	345	EFI_DHCP4_CALLBACK is provided by the consumer of the EFI DHCPv4 Protocol driver\r
	346	to intercept events that occurred in the configuration process. This structure\r
	347	provides advanced control of each state transition of the DHCP process. The\r
	348	returned status code determines the behavior of the EFI DHCPv4 Protocol driver.\r
	349	There are three possible returned values, which are described in the following\r
	350	table.\r
	351	\r
	352	@param This Pointer to the EFI DHCPv4 Protocol instance that is used to\r
	353	configure this callback function.\r
	354	@param Context Pointer to the context that is initialized by\r
	355	EFI_DHCP4_PROTOCOL.Configure().\r
	356	@param CurrentState The current operational state of the EFI DHCPv4 Protocol\r
	357	driver.\r
	358	@param Dhcp4Event The event that occurs in the current state, which usually means a\r
	359	state transition.\r
	360	@param Packet The DHCP packet that is going to be sent or already received.\r
	361	@param NewPacket The packet that is used to replace the above Packet.\r
	362	\r
	363	@retval EFI_SUCCESS Tells the EFI DHCPv4 Protocol driver to continue the DHCP process.\r
	364	@retval EFI_NOT_READY Only used in the Dhcp4Selecting state. The EFI DHCPv4 Protocol\r
	365	driver will continue to wait for more DHCPOFFER packets until the retry\r
	366	timeout expires.\r
	367	@retval EFI_ABORTED Tells the EFI DHCPv4 Protocol driver to abort the current process and\r
	368	return to the Dhcp4Init or Dhcp4InitReboot state.\r
30368135	369	\r
	370	**/\r
	371	EFI_STATUS\r
6d3ea23f	372	EFIAPI\r
30368135	373	PxeBcDhcpCallBack (\r
	374	IN EFI_DHCP4_PROTOCOL * This,\r
	375	IN VOID *Context,\r
	376	IN EFI_DHCP4_STATE CurrentState,\r
	377	IN EFI_DHCP4_EVENT Dhcp4Event,\r
	378	IN EFI_DHCP4_PACKET * Packet OPTIONAL,\r
	379	OUT EFI_DHCP4_PACKET **NewPacket OPTIONAL\r
d59b8b55	380	);\r
30368135	381	\r
	382	\r
	383	/**\r
f737cfb9	384	Discover the boot of service and initialize the vendor option if exists.\r
	385	\r
	386	@param Private Pointer to PxeBc private data.\r
	387	@param Type PxeBc option boot item type\r
	388	@param Layer PxeBc option boot item layer\r
d59b8b55	389	@param UseBis Use BIS or not\r
	390	@param DestIp Ip address for server \r
	391	@param IpCount The total count of the server ip address \r
	392	@param SrvList Server list\r
	393	@param IsDiscv Discover the vendor or not\r
	394	@param Reply The dhcp4 packet of Pxe reply\r
	395	\r
	396	@retval EFI_SUCCESS Operation succeeds.\r
f737cfb9	397	@retval EFI_OUT_OF_RESOURCES Allocate memory pool failed.\r
	398	@retval EFI_NOT_FOUND There is no vendor option exists.\r
	399	@retval EFI_TIMEOUT Send Pxe Discover time out. \r
	400	\r
30368135	401	**/\r
	402	EFI_STATUS\r
	403	PxeBcDiscvBootService (\r
	404	IN PXEBC_PRIVATE_DATA * Private,\r
	405	IN UINT16 Type,\r
	406	IN UINT16 *Layer,\r
	407	IN BOOLEAN UseBis,\r
	408	IN EFI_IP_ADDRESS * DestIp,\r
	409	IN UINT16 IpCount,\r
	410	IN EFI_PXE_BASE_CODE_SRVLIST * SrvList,\r
	411	IN BOOLEAN IsDiscv,\r
	412	OUT EFI_DHCP4_PACKET * Reply OPTIONAL\r
d59b8b55	413	);\r
30368135	414	\r
	415	\r
	416	/**\r
f737cfb9	417	Initialize the DHCP options and build the option list.\r
30368135	418	\r
f737cfb9	419	@param Private Pointer to PxeBc private data.\r
	420	@param OptList Pointer to a DHCP option list.\r
	421	\r
	422	@param IsDhcpDiscover Discover dhcp option or not. \r
30368135	423	\r
f737cfb9	424	@return The index item number of the option list.\r
30368135	425	\r
	426	**/\r
	427	UINT32\r
	428	PxeBcBuildDhcpOptions (\r
	429	IN PXEBC_PRIVATE_DATA *Private,\r
	430	IN EFI_DHCP4_PACKET_OPTION **OptList,\r
	431	IN BOOLEAN IsDhcpDiscover\r
d59b8b55	432	);\r
30368135	433	\r
	434	\r
	435	/**\r
f6b7393c	436	Create the boot options.\r
30368135	437	\r
f737cfb9	438	@param OptList Pointer to the list of the options\r
	439	@param Type the type of option\r
	440	@param Layer the layer of the boot options \r
	441	@param OptLen length of opotion\r
30368135	442	\r
30368135	443	**/\r
	444	VOID\r
	445	PxeBcCreateBootOptions (\r
	446	IN EFI_DHCP4_PACKET_OPTION *OptList,\r
	447	IN UINT16 Type,\r
	448	IN UINT16 *Layer,\r
	449	OUT UINT32 *OptLen\r
d59b8b55	450	);\r
30368135	451	\r
	452	\r
	453	/**\r
f737cfb9	454	Parse interested dhcp options.\r
30368135	455	\r
f737cfb9	456	@param Buffer Pointer to the dhcp options packet.\r
d59b8b55	457	@param Length The length of the dhcp options.\r
d59b8b55	458	@param OptTag The option OpCode.\r
30368135	459	\r
d59b8b55	460	@return NULL if the buffer length is 0 and OpCode is not \r
f737cfb9	461	PXEBC_DHCP4_TAG_EOP, or the pointer to the buffer.\r
30368135	462	\r
	463	**/\r
	464	EFI_DHCP4_PACKET_OPTION *\r
	465	PxeBcParseExtendOptions (\r
	466	IN UINT8 *Buffer,\r
	467	IN UINT32 Length,\r
	468	IN UINT8 OptTag\r
d59b8b55	469	);\r
30368135	470	\r
	471	\r
	472	/**\r
f737cfb9	473	This function is to parse and check vendor options.\r
30368135	474	\r
f737cfb9	475	@param Dhcp4Option Pointer to dhcp options\r
f737cfb9	476	@param VendorOption Pointer to vendor options\r
30368135	477	\r
d59b8b55	478	@return TRUE if valid for vendor options, or FALSE.\r
30368135	479	\r
	480	**/\r
	481	BOOLEAN\r
	482	PxeBcParseVendorOptions (\r
	483	IN EFI_DHCP4_PACKET_OPTION *Dhcp4Option,\r
d59b8b55	484	IN PXEBC_VENDOR_OPTION *VendorOption\r
d59b8b55	485	);\r
30368135	486	\r
	487	\r
	488	/**\r
f737cfb9	489	Choose the boot prompt.\r
30368135	490	\r
f737cfb9	491	@param Private Pointer to PxeBc private data.\r
30368135	492	\r
f737cfb9	493	@retval EFI_SUCCESS Select boot prompt done.\r
	494	@retval EFI_TIMEOUT Select boot prompt time out. \r
	495	@retval EFI_NOT_FOUND The proxy offer is not Pxe10.\r
	496	@retval EFI_ABORTED User cancel the operation.\r
	497	@retval EFI_NOT_READY Read the input key from the keybroad has not finish.\r
	498	\r
30368135	499	**/\r
	500	EFI_STATUS\r
	501	PxeBcSelectBootPrompt (\r
	502	IN PXEBC_PRIVATE_DATA *Private\r
d59b8b55	503	);\r
30368135	504	\r
	505	\r
	506	/**\r
f737cfb9	507	Select the boot menu.\r
	508	\r
	509	@param Private Pointer to PxeBc private data.\r
	510	@param Type The type of the menu.\r
	511	@param UseDefaultItem Use default item or not.\r
	512	\r
	513	@retval EFI_ABORTED User cancel operation.\r
	514	@retval EFI_SUCCESS Select the boot menu success.\r
	515	@retval EFI_NOT_READY Read the input key from the keybroad has not finish. \r
30368135	516	\r
	517	**/\r
	518	EFI_STATUS\r
	519	PxeBcSelectBootMenu (\r
	520	IN PXEBC_PRIVATE_DATA *Private,\r
	521	OUT UINT16 *Type,\r
	522	IN BOOLEAN UseDefaultItem\r
d59b8b55	523	);\r
30368135	524	\r
	525	#endif\r
	526	\r