HttpBootDhcp4.h 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253
  1. /** @file
  2. Functions declaration related with DHCPv4 for HTTP boot driver.
  3. Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>
  4. Copyright (c) 2020, Hewlett Packard Enterprise Development LP. All rights reserved.<BR>
  5. SPDX-License-Identifier: BSD-2-Clause-Patent
  6. **/
  7. #ifndef __EFI_UEFI_HTTP_BOOT_DHCP4_H__
  8. #define __EFI_UEFI_HTTP_BOOT_DHCP4_H__
  9. #define HTTP_BOOT_DHCP4_OPTION_MAX_NUM 16
  10. #define HTTP_BOOT_DHCP4_OPTION_MAX_SIZE 312
  11. #define HTTP_BOOT_DHCP4_PACKET_MAX_SIZE 1472
  12. #define HTTP_BOOT_DHCP4_OPCODE_REQUEST 1
  13. #define HTTP_BOOT_DHCP4_OPCODE_REPLY 2
  14. #define HTTP_BOOT_DHCP4_MSG_TYPE_REQUEST 3
  15. #define HTTP_BOOT_DHCP4_MAGIC 0x63538263 // network byte order
  16. #define HTTP_BOOT_DHCP4_OVERLOAD_FILE 1
  17. #define HTTP_BOOT_DHCP4_OVERLOAD_SERVER_NAME 2
  18. ///
  19. /// HTTP Tag definition that identifies the processor
  20. /// and programming environment of the client system.
  21. /// These identifiers are defined by IETF:
  22. /// http://www.ietf.org/assignments/dhcpv6-parameters/dhcpv6-parameters.xml
  23. ///
  24. #if defined (MDE_CPU_IA32)
  25. #define EFI_HTTP_BOOT_CLIENT_SYSTEM_ARCHITECTURE HTTP_CLIENT_ARCH_IA32
  26. #elif defined (MDE_CPU_X64)
  27. #define EFI_HTTP_BOOT_CLIENT_SYSTEM_ARCHITECTURE HTTP_CLIENT_ARCH_X64
  28. #elif defined (MDE_CPU_ARM)
  29. #define EFI_HTTP_BOOT_CLIENT_SYSTEM_ARCHITECTURE HTTP_CLIENT_ARCH_ARM
  30. #elif defined (MDE_CPU_AARCH64)
  31. #define EFI_HTTP_BOOT_CLIENT_SYSTEM_ARCHITECTURE HTTP_CLIENT_ARCH_AARCH64
  32. #elif defined (MDE_CPU_RISCV64)
  33. #define EFI_HTTP_BOOT_CLIENT_SYSTEM_ARCHITECTURE HTTP_CLIENT_ARCH_RISCV64
  34. #elif defined (MDE_CPU_EBC)
  35. #define EFI_HTTP_BOOT_CLIENT_SYSTEM_ARCHITECTURE HTTP_CLIENT_ARCH_EBC
  36. #endif
  37. /// DHCP offer types among HTTP boot.
  38. /// Dhcp4 and Dhcp6 share this definition, and corresponding
  39. /// relationship is as follows:
  40. /// Dhcp4Discover <> Dhcp6Solicit
  41. /// Dhcp4Offer <> Dhcp6Advertise
  42. /// Dhcp4Request <> Dhcp6Request
  43. /// Dhcp4Ack <> DHcp6Reply
  44. ///
  45. typedef enum {
  46. //
  47. // <IP address, IP expressed URI>
  48. //
  49. HttpOfferTypeDhcpIpUri,
  50. //
  51. // <IP address, IP expressed URI, Name-server>
  52. //
  53. HttpOfferTypeDhcpIpUriDns,
  54. //
  55. // <IP address, Domain-name expressed URI, Name-server>
  56. //
  57. HttpOfferTypeDhcpNameUriDns,
  58. //
  59. // <IP address, Name-server>
  60. //
  61. HttpOfferTypeDhcpDns,
  62. //
  63. // <IP address>
  64. //
  65. HttpOfferTypeDhcpOnly,
  66. //
  67. // <Domain-name expressed URI> or
  68. // <Domain-name expressed URI, Name-server (will be ignored)>
  69. //
  70. HttpOfferTypeProxyNameUri,
  71. //
  72. // <IP expressed URI> or
  73. // <IP expressed URI, Name-server (will be ignored)>
  74. //
  75. HttpOfferTypeProxyIpUri,
  76. //
  77. // <IP address, Domain-name expressed URI>
  78. //
  79. HttpOfferTypeDhcpNameUri,
  80. HttpOfferTypeMax
  81. } HTTP_BOOT_OFFER_TYPE;
  82. #define HTTP_BOOT_DHCP_RETRIES 4
  83. #define HTTP_BOOT_OFFER_MAX_NUM 16
  84. // The array index of the DHCP4 option tag interested
  85. //
  86. #define HTTP_BOOT_DHCP4_TAG_INDEX_BOOTFILE_LEN 0
  87. #define HTTP_BOOT_DHCP4_TAG_INDEX_OVERLOAD 1
  88. #define HTTP_BOOT_DHCP4_TAG_INDEX_MSG_TYPE 2
  89. #define HTTP_BOOT_DHCP4_TAG_INDEX_SERVER_ID 3
  90. #define HTTP_BOOT_DHCP4_TAG_INDEX_CLASS_ID 4
  91. #define HTTP_BOOT_DHCP4_TAG_INDEX_BOOTFILE 5
  92. #define HTTP_BOOT_DHCP4_TAG_INDEX_DNS_SERVER 6
  93. #define HTTP_BOOT_DHCP4_TAG_INDEX_MAX 7
  94. #pragma pack(1)
  95. typedef struct {
  96. UINT8 ParaList[135];
  97. } HTTP_BOOT_DHCP4_OPTION_PARA;
  98. typedef struct {
  99. UINT16 Size;
  100. } HTTP_BOOT_DHCP4_OPTION_MAX_MESG_SIZE;
  101. typedef struct {
  102. UINT8 Type;
  103. UINT8 MajorVer;
  104. UINT8 MinorVer;
  105. } HTTP_BOOT_DHCP4_OPTION_UNDI;
  106. typedef struct {
  107. UINT8 Type;
  108. } HTTP_BOOT_DHCP4_OPTION_MESG;
  109. typedef struct {
  110. UINT16 Type;
  111. } HTTP_BOOT_DHCP4_OPTION_ARCH;
  112. typedef struct {
  113. UINT8 ClassIdentifier[11];
  114. UINT8 ArchitecturePrefix[5];
  115. UINT8 ArchitectureType[5];
  116. UINT8 Lit3[1];
  117. UINT8 InterfaceName[4];
  118. UINT8 Lit4[1];
  119. UINT8 UndiMajor[3];
  120. UINT8 UndiMinor[3];
  121. } HTTP_BOOT_DHCP4_OPTION_CLID;
  122. typedef struct {
  123. UINT8 Type;
  124. UINT8 Guid[16];
  125. } HTTP_BOOT_DHCP4_OPTION_UUID;
  126. typedef struct {
  127. UINT16 Type;
  128. UINT16 Layer;
  129. } HTTP_BOOT_OPTION_BOOT_ITEM;
  130. #pragma pack()
  131. typedef union {
  132. HTTP_BOOT_DHCP4_OPTION_PARA *Para;
  133. HTTP_BOOT_DHCP4_OPTION_UNDI *Undi;
  134. HTTP_BOOT_DHCP4_OPTION_ARCH *Arch;
  135. HTTP_BOOT_DHCP4_OPTION_CLID *Clid;
  136. HTTP_BOOT_DHCP4_OPTION_UUID *Uuid;
  137. HTTP_BOOT_DHCP4_OPTION_MESG *Mesg;
  138. HTTP_BOOT_DHCP4_OPTION_MAX_MESG_SIZE *MaxMesgSize;
  139. } HTTP_BOOT_DHCP4_OPTION_ENTRY;
  140. #define GET_NEXT_DHCP_OPTION(Opt) \
  141. (EFI_DHCP4_PACKET_OPTION *) ((UINT8 *) (Opt) + \
  142. sizeof (EFI_DHCP4_PACKET_OPTION) + (Opt)->Length - 1)
  143. #define GET_OPTION_BUFFER_LEN(Pkt) \
  144. ((Pkt)->Length - sizeof (EFI_DHCP4_HEADER) - 4)
  145. #define DEFAULT_CLASS_ID_DATA "HTTPClient:Arch:xxxxx:UNDI:003000"
  146. #define DEFAULT_UNDI_TYPE 1
  147. #define DEFAULT_UNDI_MAJOR 3
  148. #define DEFAULT_UNDI_MINOR 0
  149. typedef struct {
  150. UINT32 Reserved;
  151. } HTTP_BOOT_VENDOR_OPTION;
  152. #define HTTP_CACHED_DHCP4_PACKET_MAX_SIZE (OFFSET_OF (EFI_DHCP4_PACKET, Dhcp4) + HTTP_BOOT_DHCP4_PACKET_MAX_SIZE)
  153. typedef union {
  154. EFI_DHCP4_PACKET Offer;
  155. EFI_DHCP4_PACKET Ack;
  156. UINT8 Buffer[HTTP_CACHED_DHCP4_PACKET_MAX_SIZE];
  157. } HTTP_BOOT_DHCP4_PACKET;
  158. typedef struct {
  159. //
  160. // URI component
  161. //
  162. CHAR8 *Scheme;
  163. CHAR8 *Authority;
  164. CHAR8 *Path;
  165. CHAR8 *Query;
  166. CHAR8 *Fragment; /// TODO: may not required in HTTP URL
  167. CHAR8 *RegName; /// Point to somewhere in Authority
  168. BOOLEAN AddrIsOk;
  169. EFI_IP_ADDRESS Address;
  170. UINT16 Port;
  171. } HTTP_BOOT_URI_CONTENT;
  172. typedef struct {
  173. HTTP_BOOT_DHCP4_PACKET Packet;
  174. HTTP_BOOT_OFFER_TYPE OfferType;
  175. VOID *UriParser;
  176. EFI_DHCP4_PACKET_OPTION *OptList[HTTP_BOOT_DHCP4_TAG_INDEX_MAX];
  177. } HTTP_BOOT_DHCP4_PACKET_CACHE;
  178. /**
  179. Select an DHCPv4 or DHCP6 offer, and record SelectIndex and SelectProxyType.
  180. @param[in] Private Pointer to HTTP boot driver private data.
  181. **/
  182. VOID
  183. HttpBootSelectDhcpOffer (
  184. IN HTTP_BOOT_PRIVATE_DATA *Private
  185. );
  186. /**
  187. Start the D.O.R.A DHCPv4 process to acquire the IPv4 address and other Http boot information.
  188. @param[in] Private Pointer to HTTP_BOOT private data.
  189. @retval EFI_SUCCESS The D.O.R.A process successfully finished.
  190. @retval Others Failed to finish the D.O.R.A process.
  191. **/
  192. EFI_STATUS
  193. HttpBootDhcp4Dora (
  194. IN HTTP_BOOT_PRIVATE_DATA *Private
  195. );
  196. /**
  197. This function will register the default DNS addresses to the network device.
  198. @param[in] Private The pointer to HTTP_BOOT_PRIVATE_DATA.
  199. @param[in] DataLength Size of the buffer pointed to by DnsServerData in bytes.
  200. @param[in] DnsServerData Point a list of DNS server address in an array
  201. of EFI_IPv4_ADDRESS instances.
  202. @retval EFI_SUCCESS The DNS configuration has been configured successfully.
  203. @retval Others Failed to configure the address.
  204. **/
  205. EFI_STATUS
  206. HttpBootRegisterIp4Dns (
  207. IN HTTP_BOOT_PRIVATE_DATA *Private,
  208. IN UINTN DataLength,
  209. IN VOID *DnsServerData
  210. );
  211. #endif