[mirror_edk2.git] / NetworkPkg / HttpBootDxe / HttpBootDhcp6.h

/** @file\r
  Functions declaration related with DHCPv6 for HTTP boot driver.\r
\r
Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials are licensed and made available under \r
the terms and conditions of the BSD License that accompanies this distribution.  \r
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
\r
#ifndef __EFI_HTTP_BOOT_DHCP6_H__\r
#define __EFI_HTTP_BOOT_DHCP6_H__\r
\r
#define HTTP_BOOT_OFFER_MAX_NUM                16\r
#define HTTP_BOOT_DHCP6_OPTION_MAX_NUM         16\r
#define HTTP_BOOT_DHCP6_OPTION_MAX_SIZE        312\r
#define HTTP_BOOT_DHCP6_PACKET_MAX_SIZE        1472\r
#define HTTP_BOOT_IP6_ROUTE_TABLE_TIMEOUT      10\r
#define HTTP_BOOT_DEFAULT_HOPLIMIT             64\r
#define HTTP_BOOT_DEFAULT_LIFETIME             50000\r
\r
\r
#define HTTP_BOOT_DHCP6_OPT_CLIENT_ID         1\r
#define HTTP_BOOT_DHCP6_OPT_SERVER_ID         2\r
#define HTTP_BOOT_DHCP6_OPT_IA_NA             3\r
#define HTTP_BOOT_DHCP6_OPT_IA_TA             4\r
#define HTTP_BOOT_DHCP6_OPT_IAADDR            5\r
#define HTTP_BOOT_DHCP6_OPT_ORO               6\r
#define HTTP_BOOT_DHCP6_OPT_PREFERENCE        7\r
#define HTTP_BOOT_DHCP6_OPT_ELAPSED_TIME      8\r
#define HTTP_BOOT_DHCP6_OPT_REPLAY_MSG        9\r
#define HTTP_BOOT_DHCP6_OPT_AUTH              11\r
#define HTTP_BOOT_DHCP6_OPT_UNICAST           12\r
#define HTTP_BOOT_DHCP6_OPT_STATUS_CODE       13\r
#define HTTP_BOOT_DHCP6_OPT_RAPID_COMMIT      14\r
#define HTTP_BOOT_DHCP6_OPT_USER_CLASS        15\r
#define HTTP_BOOT_DHCP6_OPT_VENDOR_CLASS      16\r
#define HTTP_BOOT_DHCP6_OPT_VENDOR_OPTS       17\r
#define HTTP_BOOT_DHCP6_OPT_INTERFACE_ID      18\r
#define HTTP_BOOT_DHCP6_OPT_RECONFIG_MSG      19\r
#define HTTP_BOOT_DHCP6_OPT_RECONFIG_ACCEPT   20\r
#define HTTP_BOOT_DHCP6_OPT_DNS_SERVERS       23\r
#define HTTP_BOOT_DHCP6_OPT_BOOT_FILE_URL     59    // Assigned by IANA, RFC 5970\r
#define HTTP_BOOT_DHCP6_OPT_BOOT_FILE_PARAM   60    // Assigned by IANA, RFC 5970\r
#define HTTP_BOOT_DHCP6_OPT_ARCH              61    // Assigned by IANA, RFC 5970\r
#define HTTP_BOOT_DHCP6_OPT_UNDI              62    // Assigned by IANA, RFC 5970\r
#define HTTP_BOOT_DHCP6_ENTERPRISE_NUM        343   // TODO: IANA TBD: temporarily using Intel's\r
#define HTTP_BOOT_DHCP6_MAX_BOOT_FILE_SIZE    65535 //   It's a limitation of bit length, 65535*512 bytes.\r
\r
#define HTTP_BOOT_DHCP6_IDX_IA_NA             0\r
#define HTTP_BOOT_DHCP6_IDX_BOOT_FILE_URL     1\r
#define HTTP_BOOT_DHCP6_IDX_BOOT_FILE_PARAM   2\r
#define HTTP_BOOT_DHCP6_IDX_VENDOR_CLASS      3\r
#define HTTP_BOOT_DHCP6_IDX_DNS_SERVER        4\r
#define HTTP_BOOT_DHCP6_IDX_MAX               5\r
\r
#pragma pack(1)\r
typedef struct {\r
  UINT16 OpCode[256];\r
} HTTP_BOOT_DHCP6_OPTION_ORO;\r
\r
typedef struct {\r
  UINT8 Type;\r
  UINT8 MajorVer;\r
  UINT8 MinorVer;\r
} HTTP_BOOT_DHCP6_OPTION_UNDI;\r
\r
typedef struct {\r
  UINT16 Type;\r
} HTTP_BOOT_DHCP6_OPTION_ARCH;\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
} HTTP_BOOT_CLASS_ID;\r
\r
typedef struct {\r
  UINT32             Vendor;\r
  UINT16             ClassLen;\r
  HTTP_BOOT_CLASS_ID ClassId;\r
} HTTP_BOOT_DHCP6_OPTION_VENDOR_CLASS;\r
\r
#pragma pack()\r
\r
typedef union {\r
  HTTP_BOOT_DHCP6_OPTION_ORO            *Oro;\r
  HTTP_BOOT_DHCP6_OPTION_UNDI           *Undi;\r
  HTTP_BOOT_DHCP6_OPTION_ARCH           *Arch;\r
  HTTP_BOOT_DHCP6_OPTION_VENDOR_CLASS   *VendorClass;\r
} HTTP_BOOT_DHCP6_OPTION_ENTRY;\r
\r
typedef union {\r
  EFI_DHCP6_PACKET        Offer;\r
  EFI_DHCP6_PACKET        Ack;\r
  UINT8                   Buffer[HTTP_BOOT_DHCP6_PACKET_MAX_SIZE];\r
} HTTP_BOOT_DHCP6_PACKET;\r
\r
typedef struct {\r
  HTTP_BOOT_DHCP6_PACKET      Packet;\r
  HTTP_BOOT_OFFER_TYPE        OfferType;\r
  EFI_DHCP6_PACKET_OPTION     *OptList[HTTP_BOOT_DHCP6_IDX_MAX];\r
  VOID                        *UriParser;\r
} HTTP_BOOT_DHCP6_PACKET_CACHE;\r
\r
#define GET_NEXT_DHCP6_OPTION(Opt) \\r
  (EFI_DHCP6_PACKET_OPTION *) ((UINT8 *) (Opt) + \\r
  sizeof (EFI_DHCP6_PACKET_OPTION) + (NTOHS ((Opt)->OpLen)) - 1)\r
\r
#define GET_DHCP6_OPTION_SIZE(Pkt)  \\r
  ((Pkt)->Length - sizeof (EFI_DHCP6_HEADER))\r
\r
/**\r
  Start the S.A.R.R DHCPv6 process to acquire the IPv6 address and other Http boot information.\r
\r
  @param[in]  Private           Pointer to HTTP_BOOT private data.\r
\r
  @retval EFI_SUCCESS           The S.A.R.R process successfully finished.\r
  @retval Others                Failed to finish the S.A.R.R process.\r
\r
**/\r
EFI_STATUS\r
HttpBootDhcp6Sarr (\r
  IN HTTP_BOOT_PRIVATE_DATA         *Private\r
  );\r
\r
/**\r
  Set the IP6 policy to Automatic.\r
\r
  @param[in]  Private             The pointer to HTTP_BOOT_PRIVATE_DATA.\r
\r
  @retval     EFI_SUCCESS         Switch the IP policy succesfully.\r
  @retval     Others              Unexpect error happened.\r
\r
**/\r
EFI_STATUS\r
HttpBootSetIp6Policy (\r
  IN HTTP_BOOT_PRIVATE_DATA        *Private\r
  );\r
\r
/**\r
  This function will register the default DNS addresses to the network device.\r
  \r
  @param[in]  Private             The pointer to HTTP_BOOT_PRIVATE_DATA.\r
  @param[in]  DataLength          Size of the buffer pointed to by DnsServerData in bytes.\r
  @param[in]  DnsServerData       Point a list of DNS server address in an array\r
                                  of EFI_IPv6_ADDRESS instances.\r
\r
  @retval     EFI_SUCCESS         The DNS configuration has been configured successfully.\r
  @retval     Others              Failed to configure the address.\r
\r
**/\r
EFI_STATUS\r
HttpBootSetIp6Dns (\r
  IN HTTP_BOOT_PRIVATE_DATA         *Private,\r
  IN UINTN                          DataLength,\r
  IN VOID                           *DnsServerData\r
  );\r
\r
/**\r
  This function will register the IPv6 gateway address to the network device.\r
  \r
  @param[in]  Private             The pointer to HTTP_BOOT_PRIVATE_DATA.\r
\r
  @retval     EFI_SUCCESS         The new IP configuration has been configured successfully.\r
  @retval     Others              Failed to configure the address.\r
\r
**/\r
EFI_STATUS\r
HttpBootSetIp6Gateway (\r
  IN HTTP_BOOT_PRIVATE_DATA         *Private\r
  );\r
\r
/**\r
  This function will register the station IP address.\r
  \r
  @param[in]  Private             The pointer to HTTP_BOOT_PRIVATE_DATA.\r
\r
  @retval     EFI_SUCCESS         The new IP address has been configured successfully.\r
  @retval     Others              Failed to configure the address.\r
\r
**/\r
EFI_STATUS\r
HttpBootSetIp6Address (\r
  IN HTTP_BOOT_PRIVATE_DATA         *Private\r
  );\r
\r
#endif\r
Commit	Line	Data
b659408b ZL	1	/** @file\r
	2	Functions declaration related with DHCPv6 for HTTP boot driver.\r
	3	\r
	4	Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r
	5	This program and the accompanying materials are licensed and made available under \r
	6	the terms and conditions of the BSD License that accompanies this distribution. \r
	7	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
	13	**/\r
	14	\r
	15	\r
	16	#ifndef __EFI_HTTP_BOOT_DHCP6_H__\r
	17	#define __EFI_HTTP_BOOT_DHCP6_H__\r
	18	\r
	19	#define HTTP_BOOT_OFFER_MAX_NUM 16\r
	20	#define HTTP_BOOT_DHCP6_OPTION_MAX_NUM 16\r
	21	#define HTTP_BOOT_DHCP6_OPTION_MAX_SIZE 312\r
	22	#define HTTP_BOOT_DHCP6_PACKET_MAX_SIZE 1472\r
	23	#define HTTP_BOOT_IP6_ROUTE_TABLE_TIMEOUT 10\r
	24	#define HTTP_BOOT_DEFAULT_HOPLIMIT 64\r
	25	#define HTTP_BOOT_DEFAULT_LIFETIME 50000\r
	26	\r
	27	\r
	28	#define HTTP_BOOT_DHCP6_OPT_CLIENT_ID 1\r
	29	#define HTTP_BOOT_DHCP6_OPT_SERVER_ID 2\r
	30	#define HTTP_BOOT_DHCP6_OPT_IA_NA 3\r
	31	#define HTTP_BOOT_DHCP6_OPT_IA_TA 4\r
	32	#define HTTP_BOOT_DHCP6_OPT_IAADDR 5\r
	33	#define HTTP_BOOT_DHCP6_OPT_ORO 6\r
	34	#define HTTP_BOOT_DHCP6_OPT_PREFERENCE 7\r
	35	#define HTTP_BOOT_DHCP6_OPT_ELAPSED_TIME 8\r
	36	#define HTTP_BOOT_DHCP6_OPT_REPLAY_MSG 9\r
	37	#define HTTP_BOOT_DHCP6_OPT_AUTH 11\r
	38	#define HTTP_BOOT_DHCP6_OPT_UNICAST 12\r
	39	#define HTTP_BOOT_DHCP6_OPT_STATUS_CODE 13\r
	40	#define HTTP_BOOT_DHCP6_OPT_RAPID_COMMIT 14\r
	41	#define HTTP_BOOT_DHCP6_OPT_USER_CLASS 15\r
	42	#define HTTP_BOOT_DHCP6_OPT_VENDOR_CLASS 16\r
	43	#define HTTP_BOOT_DHCP6_OPT_VENDOR_OPTS 17\r
	44	#define HTTP_BOOT_DHCP6_OPT_INTERFACE_ID 18\r
	45	#define HTTP_BOOT_DHCP6_OPT_RECONFIG_MSG 19\r
	46	#define HTTP_BOOT_DHCP6_OPT_RECONFIG_ACCEPT 20\r
	47	#define HTTP_BOOT_DHCP6_OPT_DNS_SERVERS 23\r
	48	#define HTTP_BOOT_DHCP6_OPT_BOOT_FILE_URL 59 // Assigned by IANA, RFC 5970\r
	49	#define HTTP_BOOT_DHCP6_OPT_BOOT_FILE_PARAM 60 // Assigned by IANA, RFC 5970\r
	50	#define HTTP_BOOT_DHCP6_OPT_ARCH 61 // Assigned by IANA, RFC 5970\r
	51	#define HTTP_BOOT_DHCP6_OPT_UNDI 62 // Assigned by IANA, RFC 5970\r
	52	#define HTTP_BOOT_DHCP6_ENTERPRISE_NUM 343 // TODO: IANA TBD: temporarily using Intel's\r
	53	#define HTTP_BOOT_DHCP6_MAX_BOOT_FILE_SIZE 65535 // It's a limitation of bit length, 65535*512 bytes.\r
	54	\r
	55	#define HTTP_BOOT_DHCP6_IDX_IA_NA 0\r
	56	#define HTTP_BOOT_DHCP6_IDX_BOOT_FILE_URL 1\r
	57	#define HTTP_BOOT_DHCP6_IDX_BOOT_FILE_PARAM 2\r
	58	#define HTTP_BOOT_DHCP6_IDX_VENDOR_CLASS 3\r
	59	#define HTTP_BOOT_DHCP6_IDX_DNS_SERVER 4\r
	60	#define HTTP_BOOT_DHCP6_IDX_MAX 5\r
	61	\r
	62	#pragma pack(1)\r
	63	typedef struct {\r
	64	UINT16 OpCode[256];\r
65	} HTTP_BOOT_DHCP6_OPTION_ORO;\r
66	\r
67	typedef struct {\r
68	UINT8 Type;\r
69	UINT8 MajorVer;\r
70	UINT8 MinorVer;\r
71	} HTTP_BOOT_DHCP6_OPTION_UNDI;\r
72	\r
73	typedef struct {\r
74	UINT16 Type;\r
75	} HTTP_BOOT_DHCP6_OPTION_ARCH;\r
76	\r
77	typedef struct {\r
78	UINT8 ClassIdentifier[10];\r
79	UINT8 ArchitecturePrefix[5];\r
80	UINT8 ArchitectureType[5];\r
81	UINT8 Lit3[1];\r
82	UINT8 InterfaceName[4];\r
83	UINT8 Lit4[1];\r
84	UINT8 UndiMajor[3];\r
85	UINT8 UndiMinor[3];\r
86	} HTTP_BOOT_CLASS_ID;\r
87	\r
88	typedef struct {\r
89	UINT32 Vendor;\r
90	UINT16 ClassLen;\r
91	HTTP_BOOT_CLASS_ID ClassId;\r
92	} HTTP_BOOT_DHCP6_OPTION_VENDOR_CLASS;\r
93	\r
94	#pragma pack()\r
95	\r
96	typedef union {\r
97	HTTP_BOOT_DHCP6_OPTION_ORO *Oro;\r
98	HTTP_BOOT_DHCP6_OPTION_UNDI *Undi;\r
99	HTTP_BOOT_DHCP6_OPTION_ARCH *Arch;\r
100	HTTP_BOOT_DHCP6_OPTION_VENDOR_CLASS *VendorClass;\r
101	} HTTP_BOOT_DHCP6_OPTION_ENTRY;\r
102	\r
103	typedef union {\r
104	EFI_DHCP6_PACKET Offer;\r
105	EFI_DHCP6_PACKET Ack;\r
106	UINT8 Buffer[HTTP_BOOT_DHCP6_PACKET_MAX_SIZE];\r
107	} HTTP_BOOT_DHCP6_PACKET;\r
108	\r
109	typedef struct {\r
110	HTTP_BOOT_DHCP6_PACKET Packet;\r
111	HTTP_BOOT_OFFER_TYPE OfferType;\r
112	EFI_DHCP6_PACKET_OPTION *OptList[HTTP_BOOT_DHCP6_IDX_MAX];\r
113	VOID *UriParser;\r
114	} HTTP_BOOT_DHCP6_PACKET_CACHE;\r
115	\r
116	#define GET_NEXT_DHCP6_OPTION(Opt) \\r
117	(EFI_DHCP6_PACKET_OPTION ) ((UINT8 ) (Opt) + \\r
118	sizeof (EFI_DHCP6_PACKET_OPTION) + (NTOHS ((Opt)->OpLen)) - 1)\r
119	\r
120	#define GET_DHCP6_OPTION_SIZE(Pkt) \\r
121	((Pkt)->Length - sizeof (EFI_DHCP6_HEADER))\r
122	\r
123	/**\r
124	Start the S.A.R.R DHCPv6 process to acquire the IPv6 address and other Http boot information.\r
125	\r
126	@param[in] Private Pointer to HTTP_BOOT private data.\r
127	\r
128	@retval EFI_SUCCESS The S.A.R.R process successfully finished.\r
129	@retval Others Failed to finish the S.A.R.R process.\r
130	\r
131	**/\r
132	EFI_STATUS\r
133	HttpBootDhcp6Sarr (\r
134	IN HTTP_BOOT_PRIVATE_DATA *Private\r
135	);\r
136	\r
137	/**\r
138	Set the IP6 policy to Automatic.\r
139	\r
140	@param[in] Private The pointer to HTTP_BOOT_PRIVATE_DATA.\r
141	\r
142	@retval EFI_SUCCESS Switch the IP policy succesfully.\r
143	@retval Others Unexpect error happened.\r
144	\r
145	**/\r
146	EFI_STATUS\r
147	HttpBootSetIp6Policy (\r
148	IN HTTP_BOOT_PRIVATE_DATA *Private\r
149	);\r
150	\r
151	/**\r
152	This function will register the default DNS addresses to the network device.\r
153	\r
154	@param[in] Private The pointer to HTTP_BOOT_PRIVATE_DATA.\r
155	@param[in] DataLength Size of the buffer pointed to by DnsServerData in bytes.\r
156	@param[in] DnsServerData Point a list of DNS server address in an array\r
157	of EFI_IPv6_ADDRESS instances.\r
158	\r
159	@retval EFI_SUCCESS The DNS configuration has been configured successfully.\r
160	@retval Others Failed to configure the address.\r
161	\r
162	**/\r
163	EFI_STATUS\r
164	HttpBootSetIp6Dns (\r
165	IN HTTP_BOOT_PRIVATE_DATA *Private,\r
166	IN UINTN DataLength,\r
167	IN VOID *DnsServerData\r
168	);\r
169	\r
170	/**\r
171	This function will register the IPv6 gateway address to the network device.\r
172	\r
173	@param[in] Private The pointer to HTTP_BOOT_PRIVATE_DATA.\r
174	\r
175	@retval EFI_SUCCESS The new IP configuration has been configured successfully.\r
176	@retval Others Failed to configure the address.\r
177	\r
178	**/\r
179	EFI_STATUS\r
180	HttpBootSetIp6Gateway (\r
181	IN HTTP_BOOT_PRIVATE_DATA *Private\r
182	);\r
183	\r
184	/**\r
185	This function will register the station IP address.\r
186	\r
187	@param[in] Private The pointer to HTTP_BOOT_PRIVATE_DATA.\r
188	\r
189	@retval EFI_SUCCESS The new IP address has been configured successfully.\r
190	@retval Others Failed to configure the address.\r
191	\r
192	**/\r
193	EFI_STATUS\r
194	HttpBootSetIp6Address (\r
195	IN HTTP_BOOT_PRIVATE_DATA *Private\r
196	);\r
197	\r
198	#endif\r