NetworkPkg/UefiPxeBcDxe/PxeBcDhcp4.h

   1 /** @file
   2   Functions declaration related with DHCPv4 for UefiPxeBc Driver.
   3
   4   Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>
   5
   6   SPDX-License-Identifier: BSD-2-Clause-Patent
   7
   8 **/
   9
  10 #ifndef __EFI_PXEBC_DHCP4_H__
  11 #define __EFI_PXEBC_DHCP4_H__
  12
  13 #define PXEBC_DHCP4_OPTION_MAX_NUM    16
  14 #define PXEBC_DHCP4_OPTION_MAX_SIZE   312
  15 #define PXEBC_DHCP4_PACKET_MAX_SIZE   (sizeof (EFI_PXE_BASE_CODE_PACKET))
  16 #define PXEBC_DHCP4_S_PORT            67
  17 #define PXEBC_DHCP4_C_PORT            68
  18 #define PXEBC_BS_DOWNLOAD_PORT        69
  19 #define PXEBC_BS_DISCOVER_PORT        4011
  20 #define PXEBC_DHCP4_OPCODE_REQUEST    1
  21 #define PXEBC_DHCP4_OPCODE_REPLY      2
  22 #define PXEBC_DHCP4_MSG_TYPE_REQUEST  3
  23 #define PXEBC_DHCP4_MAGIC             0x63538263      // network byte order
  24
  25 //
  26 // Sub-Options in Dhcp Vendor Option
  27 //
  28 #define PXEBC_VENDOR_TAG_MTFTP_IP          1
  29 #define PXEBC_VENDOR_TAG_MTFTP_CPORT       2
  30 #define PXEBC_VENDOR_TAG_MTFTP_SPORT       3
  31 #define PXEBC_VENDOR_TAG_MTFTP_TIMEOUT     4
  32 #define PXEBC_VENDOR_TAG_MTFTP_DELAY       5
  33 #define PXEBC_VENDOR_TAG_DISCOVER_CTRL     6
  34 #define PXEBC_VENDOR_TAG_DISCOVER_MCAST    7
  35 #define PXEBC_VENDOR_TAG_BOOT_SERVERS      8
  36 #define PXEBC_VENDOR_TAG_BOOT_MENU         9
  37 #define PXEBC_VENDOR_TAG_MENU_PROMPT       10
  38 #define PXEBC_VENDOR_TAG_MCAST_ALLOC       11
  39 #define PXEBC_VENDOR_TAG_CREDENTIAL_TYPES  12
  40 #define PXEBC_VENDOR_TAG_BOOT_ITEM         71
  41
  42 #define PXEBC_BOOT_REQUEST_TIMEOUT  1
  43 #define PXEBC_BOOT_REQUEST_RETRIES  4
  44
  45 #define PXEBC_DHCP4_OVERLOAD_FILE         1
  46 #define PXEBC_DHCP4_OVERLOAD_SERVER_NAME  2
  47
  48 //
  49 // The array index of the DHCP4 option tag interested
  50 //
  51 #define PXEBC_DHCP4_TAG_INDEX_BOOTFILE_LEN  0
  52 #define PXEBC_DHCP4_TAG_INDEX_VENDOR        1
  53 #define PXEBC_DHCP4_TAG_INDEX_OVERLOAD      2
  54 #define PXEBC_DHCP4_TAG_INDEX_MSG_TYPE      3
  55 #define PXEBC_DHCP4_TAG_INDEX_SERVER_ID     4
  56 #define PXEBC_DHCP4_TAG_INDEX_CLASS_ID      5
  57 #define PXEBC_DHCP4_TAG_INDEX_BOOTFILE      6
  58 #define PXEBC_DHCP4_TAG_INDEX_MAX           7
  59
  60 //
  61 // Dhcp4 and Dhcp6 share this definition, and corresponding
  62 // relationship is as follows:
  63 //
  64 //   Dhcp4Discover <> Dhcp6Solicit
  65 //   Dhcp4Offer    <> Dhcp6Advertise
  66 //   Dhcp4Request  <> Dhcp6Request
  67 //   Dhcp4Ack      <> DHcp6Reply
  68 //
  69 typedef enum {
  70   PxeOfferTypeDhcpOnly,
  71   PxeOfferTypeDhcpPxe10,
  72   PxeOfferTypeDhcpWfm11a,
  73   PxeOfferTypeDhcpBinl,
  74   PxeOfferTypeProxyPxe10,
  75   PxeOfferTypeProxyWfm11a,
  76   PxeOfferTypeProxyBinl,
  77   PxeOfferTypeBootp,
  78   PxeOfferTypeMax
  79 } PXEBC_OFFER_TYPE;
  80
  81 #define BIT(x)   (1 << x)
  82 #define CTRL(x)  (0x1F & (x))
  83 #define DEFAULT_CLASS_ID_DATA  "PXEClient:Arch:xxxxx:UNDI:003000"
  84 #define DEFAULT_UNDI_TYPE      1
  85 #define DEFAULT_UNDI_MAJOR     3
  86 #define DEFAULT_UNDI_MINOR     0
  87
  88 #define MTFTP_VENDOR_OPTION_BIT_MAP \
  89   (BIT (PXEBC_VENDOR_TAG_MTFTP_IP) | \
  90    BIT (PXEBC_VENDOR_TAG_MTFTP_CPORT) | \
  91    BIT (PXEBC_VENDOR_TAG_MTFTP_SPORT) | \
  92    BIT (PXEBC_VENDOR_TAG_MTFTP_TIMEOUT) | \
  93    BIT (PXEBC_VENDOR_TAG_MTFTP_DELAY))
  94
  95 #define DISCOVER_VENDOR_OPTION_BIT_MAP \
  96   (BIT (PXEBC_VENDOR_TAG_DISCOVER_CTRL) | \
  97    BIT (PXEBC_VENDOR_TAG_DISCOVER_MCAST) | \
  98    BIT (PXEBC_VENDOR_TAG_BOOT_SERVERS) | \
  99    BIT (PXEBC_VENDOR_TAG_BOOT_MENU) | \
 100    BIT (PXEBC_VENDOR_TAG_MENU_PROMPT))
 101
 102 #define IS_VALID_BOOT_SERVERS(x) \
 103   ((((x)[0]) & BIT (PXEBC_VENDOR_TAG_BOOT_SERVERS)) \
 104    == BIT (PXEBC_VENDOR_TAG_BOOT_SERVERS))
 105
 106 #define IS_VALID_BOOT_PROMPT(x) \
 107   ((((x)[0]) & BIT (PXEBC_VENDOR_TAG_MENU_PROMPT)) \
 108    == BIT (PXEBC_VENDOR_TAG_MENU_PROMPT))
 109
 110 #define IS_VALID_BOOT_MENU(x) \
 111   ((((x)[0]) & BIT (PXEBC_VENDOR_TAG_BOOT_MENU)) \
 112    == BIT (PXEBC_VENDOR_TAG_BOOT_MENU))
 113
 114 #define IS_VALID_MTFTP_VENDOR_OPTION(x) \
 115   (((UINT32) ((x)[0]) & MTFTP_VENDOR_OPTION_BIT_MAP) \
 116    == MTFTP_VENDOR_OPTION_BIT_MAP)
 117
 118 #define IS_VALID_DISCOVER_VENDOR_OPTION(x) \
 119   (((UINT32) ((x)[0]) & DISCOVER_VENDOR_OPTION_BIT_MAP) != 0)
 120
 121 #define IS_VALID_CREDENTIAL_VENDOR_OPTION(x) \
 122   (((UINT32) ((x)[0]) & BIT (PXEBC_VENDOR_TAG_CREDENTIAL_TYPES)) \
 123    == BIT (PXEBC_VENDOR_TAG_CREDENTIAL_TYPES))
 124
 125 #define IS_VALID_BOOTITEM_VENDOR_OPTION(x) \
 126   (((UINT32) ((x)[PXEBC_VENDOR_TAG_BOOT_ITEM / 32]) & \
 127      BIT (PXEBC_VENDOR_TAG_BOOT_ITEM % 32)) \
 128     == BIT (PXEBC_VENDOR_TAG_BOOT_ITEM % 32))
 129
 130 #define SET_VENDOR_OPTION_BIT_MAP(x, y) \
 131   (*(x + ((y) / 32)) = (UINT32) ((UINT32) ((x)[(y) / 32]) | BIT ((y) % 32)))
 132
 133 #define GET_NEXT_DHCP_OPTION(Opt) \
 134   (EFI_DHCP4_PACKET_OPTION *) ((UINT8 *) (Opt) + \
 135    sizeof (EFI_DHCP4_PACKET_OPTION) + (Opt)->Length - 1)
 136
 137 #define GET_OPTION_BUFFER_LEN(Pkt) \
 138   ((Pkt)->Length - sizeof (EFI_DHCP4_HEADER) - 4)
 139
 140 #define GET_NEXT_BOOT_SVR_ENTRY(Ent) \
 141   (PXEBC_BOOT_SVR_ENTRY *) ((UINT8 *) Ent + sizeof (*(Ent)) + \
 142    ((Ent)->IpCnt - 1) * sizeof (EFI_IPv4_ADDRESS))
 143
 144 #define IS_PROXY_DHCP_OFFER(Offer) \
 145   EFI_IP4_EQUAL (&(Offer)->Dhcp4.Header.YourAddr, &mZeroIp4Addr)
 146
 147 #define IS_DISABLE_BCAST_DISCOVER(x) \
 148   (((x) & BIT (0)) == BIT (0))
 149
 150 #define IS_DISABLE_MCAST_DISCOVER(x) \
 151   (((x) & BIT (1)) == BIT (1))
 152
 153 #define IS_ENABLE_USE_SERVER_LIST(x) \
 154   (((x) & BIT (2)) == BIT (2))
 155
 156 #define IS_DISABLE_PROMPT_MENU(x) \
 157   (((x) & BIT (3)) == BIT (3))
 158
 159 #pragma pack(1)
 160 typedef struct {
 161   UINT8    ParaList[135];
 162 } PXEBC_DHCP4_OPTION_PARA;
 163
 164 typedef struct {
 165   UINT16    Size;
 166 } PXEBC_DHCP4_OPTION_MAX_MESG_SIZE;
 167
 168 typedef struct {
 169   UINT8    Type;
 170   UINT8    MajorVer;
 171   UINT8    MinorVer;
 172 } PXEBC_DHCP4_OPTION_UNDI;
 173
 174 typedef struct {
 175   UINT8    Type;
 176 } PXEBC_DHCP4_OPTION_MESG;
 177
 178 typedef struct {
 179   UINT16    Type;
 180 } PXEBC_DHCP4_OPTION_ARCH;
 181
 182 typedef struct {
 183   UINT8    ClassIdentifier[10];
 184   UINT8    ArchitecturePrefix[5];
 185   UINT8    ArchitectureType[5];
 186   UINT8    Lit3[1];
 187   UINT8    InterfaceName[4];
 188   UINT8    Lit4[1];
 189   UINT8    UndiMajor[3];
 190   UINT8    UndiMinor[3];
 191 } PXEBC_DHCP4_OPTION_CLID;
 192
 193 typedef struct {
 194   UINT8    Type;
 195   UINT8    Guid[16];
 196 } PXEBC_DHCP4_OPTION_UUID;
 197
 198 typedef struct {
 199   UINT16    Type;
 200   UINT16    Layer;
 201 } PXEBC_OPTION_BOOT_ITEM;
 202
 203 #pragma pack()
 204
 205 typedef union {
 206   PXEBC_DHCP4_OPTION_PARA             *Para;
 207   PXEBC_DHCP4_OPTION_UNDI             *Undi;
 208   PXEBC_DHCP4_OPTION_ARCH             *Arch;
 209   PXEBC_DHCP4_OPTION_CLID             *Clid;
 210   PXEBC_DHCP4_OPTION_UUID             *Uuid;
 211   PXEBC_DHCP4_OPTION_MESG             *Mesg;
 212   PXEBC_DHCP4_OPTION_MAX_MESG_SIZE    *MaxMesgSize;
 213 } PXEBC_DHCP4_OPTION_ENTRY;
 214
 215 #pragma pack(1)
 216 typedef struct {
 217   UINT16              Type;
 218   UINT8               IpCnt;
 219   EFI_IPv4_ADDRESS    IpAddr[1];
 220 } PXEBC_BOOT_SVR_ENTRY;
 221
 222 typedef struct {
 223   UINT16    Type;
 224   UINT8     DescLen;
 225   UINT8     DescStr[1];
 226 } PXEBC_BOOT_MENU_ENTRY;
 227
 228 typedef struct {
 229   UINT8    Timeout;
 230   UINT8    Prompt[1];
 231 } PXEBC_MENU_PROMPT;
 232 #pragma pack()
 233
 234 typedef struct {
 235   UINT32                   BitMap[8];
 236   EFI_IPv4_ADDRESS         MtftpIp;
 237   UINT16                   MtftpCPort;
 238   UINT16                   MtftpSPort;
 239   UINT8                    MtftpTimeout;
 240   UINT8                    MtftpDelay;
 241   UINT8                    DiscoverCtrl;
 242   EFI_IPv4_ADDRESS         DiscoverMcastIp;
 243   EFI_IPv4_ADDRESS         McastIpBase;
 244   UINT16                   McastIpBlock;
 245   UINT16                   McastIpRange;
 246   UINT16                   BootSrvType;
 247   UINT16                   BootSrvLayer;
 248   PXEBC_BOOT_SVR_ENTRY     *BootSvr;
 249   UINT8                    BootSvrLen;
 250   PXEBC_BOOT_MENU_ENTRY    *BootMenu;
 251   UINT8                    BootMenuLen;
 252   PXEBC_MENU_PROMPT        *MenuPrompt;
 253   UINT8                    MenuPromptLen;
 254   UINT32                   *CredType;
 255   UINT8                    CredTypeLen;
 256 } PXEBC_VENDOR_OPTION;
 257
 258 #define PXEBC_CACHED_DHCP4_PACKET_MAX_SIZE  (OFFSET_OF (EFI_DHCP4_PACKET, Dhcp4) + PXEBC_DHCP4_PACKET_MAX_SIZE)
 259
 260 typedef union {
 261   EFI_DHCP4_PACKET    Offer;
 262   EFI_DHCP4_PACKET    Ack;
 263   UINT8               Buffer[PXEBC_CACHED_DHCP4_PACKET_MAX_SIZE];
 264 } PXEBC_DHCP4_PACKET;
 265
 266 typedef struct {
 267   PXEBC_DHCP4_PACKET         Packet;
 268   PXEBC_OFFER_TYPE           OfferType;
 269   EFI_DHCP4_PACKET_OPTION    *OptList[PXEBC_DHCP4_TAG_INDEX_MAX];
 270   PXEBC_VENDOR_OPTION        VendorOpt;
 271 } PXEBC_DHCP4_PACKET_CACHE;
 272
 273 /**
 274   Create a template DHCPv4 packet as a seed.
 275
 276   @param[out] Seed           Pointer to the seed packet.
 277   @param[in]  Udp4           Pointer to EFI_UDP4_PROTOCOL.
 278
 279 **/
 280 VOID
 281 PxeBcSeedDhcp4Packet (
 282   OUT EFI_DHCP4_PACKET   *Seed,
 283   IN  EFI_UDP4_PROTOCOL  *Udp4
 284   );
 285
 286 /**
 287   Parse the cached DHCPv4 packet, including all the options.
 288
 289   @param[in]  Cache4             Pointer to cached DHCPv4 packet.
 290
 291   @retval     EFI_SUCCESS        Parsed the DHCPv4 packet successfully.
 292   @retval     EFI_DEVICE_ERROR   Failed to parse and invalid packet.
 293
 294 **/
 295 EFI_STATUS
 296 PxeBcParseDhcp4Packet (
 297   IN PXEBC_DHCP4_PACKET_CACHE  *Cache4
 298   );
 299
 300 /**
 301   Build and send out the request packet for the bootfile, and parse the reply.
 302
 303   @param[in]  Private               Pointer to PxeBc private data.
 304   @param[in]  Type                  PxeBc option boot item type.
 305   @param[in]  Layer                 Pointer to option boot item layer.
 306   @param[in]  UseBis                Use BIS or not.
 307   @param[in]  DestIp                Pointer to the server address.
 308   @param[in]  IpCount               The total count of the server address.
 309   @param[in]  SrvList               Pointer to EFI_PXE_BASE_CODE_SRVLIST.
 310
 311   @retval     EFI_SUCCESS           Successfully discovered boot file.
 312   @retval     EFI_OUT_OF_RESOURCES  Failed to allocate resource.
 313   @retval     EFI_NOT_FOUND         Can't get the PXE reply packet.
 314   @retval     Others                Failed to discover boot file.
 315
 316 **/
 317 EFI_STATUS
 318 PxeBcDhcp4Discover (
 319   IN  PXEBC_PRIVATE_DATA         *Private,
 320   IN  UINT16                     Type,
 321   IN  UINT16                     *Layer,
 322   IN  BOOLEAN                    UseBis,
 323   IN  EFI_IP_ADDRESS             *DestIp,
 324   IN  UINT16                     IpCount,
 325   IN  EFI_PXE_BASE_CODE_SRVLIST  *SrvList
 326   );
 327
 328 /**
 329   Switch the Ip4 policy to static.
 330
 331   @param[in]  Private             The pointer to PXEBC_PRIVATE_DATA.
 332
 333   @retval     EFI_SUCCESS         The policy is already configured to static.
 334   @retval     Others              Other error as indicated..
 335
 336 **/
 337 EFI_STATUS
 338 PxeBcSetIp4Policy (
 339   IN PXEBC_PRIVATE_DATA  *Private
 340   );
 341
 342 /**
 343   Start the D.O.R.A DHCPv4 process to acquire the IPv4 address and other PXE boot information.
 344
 345   @param[in]  Private           Pointer to PxeBc private data.
 346   @param[in]  Dhcp4             Pointer to the EFI_DHCP4_PROTOCOL
 347
 348   @retval EFI_SUCCESS           The D.O.R.A process successfully finished.
 349   @retval Others                Failed to finish the D.O.R.A process.
 350
 351 **/
 352 EFI_STATUS
 353 PxeBcDhcp4Dora (
 354   IN PXEBC_PRIVATE_DATA  *Private,
 355   IN EFI_DHCP4_PROTOCOL  *Dhcp4
 356   );
 357
 358 #endif