]>
Commit | Line | Data |
---|---|---|
1 | /** @file\r | |
2 | Functions declaration related with DHCPv6 for HTTP boot driver.\r | |
3 | \r | |
4 | Copyright (c) 2015 - 2016, 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 | #define HTTP_BOOT_DHCP6_ENTERPRISE_NUM 343 // TODO: IANA TBD: temporarily using Intel's\r | |
28 | #define HTTP_BOOT_DHCP6_MAX_BOOT_FILE_SIZE 65535 // It's a limitation of bit length, 65535*512 bytes.\r | |
29 | \r | |
30 | #define HTTP_BOOT_DHCP6_IDX_IA_NA 0\r | |
31 | #define HTTP_BOOT_DHCP6_IDX_BOOT_FILE_URL 1\r | |
32 | #define HTTP_BOOT_DHCP6_IDX_BOOT_FILE_PARAM 2\r | |
33 | #define HTTP_BOOT_DHCP6_IDX_VENDOR_CLASS 3\r | |
34 | #define HTTP_BOOT_DHCP6_IDX_DNS_SERVER 4\r | |
35 | #define HTTP_BOOT_DHCP6_IDX_MAX 5\r | |
36 | \r | |
37 | #pragma pack(1)\r | |
38 | typedef struct {\r | |
39 | UINT16 OpCode[256];\r | |
40 | } HTTP_BOOT_DHCP6_OPTION_ORO;\r | |
41 | \r | |
42 | typedef struct {\r | |
43 | UINT8 Type;\r | |
44 | UINT8 MajorVer;\r | |
45 | UINT8 MinorVer;\r | |
46 | } HTTP_BOOT_DHCP6_OPTION_UNDI;\r | |
47 | \r | |
48 | typedef struct {\r | |
49 | UINT16 Type;\r | |
50 | } HTTP_BOOT_DHCP6_OPTION_ARCH;\r | |
51 | \r | |
52 | typedef struct {\r | |
53 | UINT8 ClassIdentifier[11];\r | |
54 | UINT8 ArchitecturePrefix[5];\r | |
55 | UINT8 ArchitectureType[5];\r | |
56 | UINT8 Lit3[1];\r | |
57 | UINT8 InterfaceName[4];\r | |
58 | UINT8 Lit4[1];\r | |
59 | UINT8 UndiMajor[3];\r | |
60 | UINT8 UndiMinor[3];\r | |
61 | } HTTP_BOOT_CLASS_ID;\r | |
62 | \r | |
63 | typedef struct {\r | |
64 | UINT32 Vendor;\r | |
65 | UINT16 ClassLen;\r | |
66 | HTTP_BOOT_CLASS_ID ClassId;\r | |
67 | } HTTP_BOOT_DHCP6_OPTION_VENDOR_CLASS;\r | |
68 | \r | |
69 | #pragma pack()\r | |
70 | \r | |
71 | typedef union {\r | |
72 | HTTP_BOOT_DHCP6_OPTION_ORO *Oro;\r | |
73 | HTTP_BOOT_DHCP6_OPTION_UNDI *Undi;\r | |
74 | HTTP_BOOT_DHCP6_OPTION_ARCH *Arch;\r | |
75 | HTTP_BOOT_DHCP6_OPTION_VENDOR_CLASS *VendorClass;\r | |
76 | } HTTP_BOOT_DHCP6_OPTION_ENTRY;\r | |
77 | \r | |
78 | typedef union {\r | |
79 | EFI_DHCP6_PACKET Offer;\r | |
80 | EFI_DHCP6_PACKET Ack;\r | |
81 | UINT8 Buffer[HTTP_BOOT_DHCP6_PACKET_MAX_SIZE];\r | |
82 | } HTTP_BOOT_DHCP6_PACKET;\r | |
83 | \r | |
84 | typedef struct {\r | |
85 | HTTP_BOOT_DHCP6_PACKET Packet;\r | |
86 | HTTP_BOOT_OFFER_TYPE OfferType;\r | |
87 | EFI_DHCP6_PACKET_OPTION *OptList[HTTP_BOOT_DHCP6_IDX_MAX];\r | |
88 | VOID *UriParser;\r | |
89 | } HTTP_BOOT_DHCP6_PACKET_CACHE;\r | |
90 | \r | |
91 | #define GET_NEXT_DHCP6_OPTION(Opt) \\r | |
92 | (EFI_DHCP6_PACKET_OPTION *) ((UINT8 *) (Opt) + \\r | |
93 | sizeof (EFI_DHCP6_PACKET_OPTION) + (NTOHS ((Opt)->OpLen)) - 1)\r | |
94 | \r | |
95 | #define GET_DHCP6_OPTION_SIZE(Pkt) \\r | |
96 | ((Pkt)->Length - sizeof (EFI_DHCP6_HEADER))\r | |
97 | \r | |
98 | /**\r | |
99 | Start the S.A.R.R DHCPv6 process to acquire the IPv6 address and other Http boot information.\r | |
100 | \r | |
101 | @param[in] Private Pointer to HTTP_BOOT private data.\r | |
102 | \r | |
103 | @retval EFI_SUCCESS The S.A.R.R process successfully finished.\r | |
104 | @retval Others Failed to finish the S.A.R.R process.\r | |
105 | \r | |
106 | **/\r | |
107 | EFI_STATUS\r | |
108 | HttpBootDhcp6Sarr (\r | |
109 | IN HTTP_BOOT_PRIVATE_DATA *Private\r | |
110 | );\r | |
111 | \r | |
112 | /**\r | |
113 | Set the IP6 policy to Automatic.\r | |
114 | \r | |
115 | @param[in] Private The pointer to HTTP_BOOT_PRIVATE_DATA.\r | |
116 | \r | |
117 | @retval EFI_SUCCESS Switch the IP policy succesfully.\r | |
118 | @retval Others Unexpect error happened.\r | |
119 | \r | |
120 | **/\r | |
121 | EFI_STATUS\r | |
122 | HttpBootSetIp6Policy (\r | |
123 | IN HTTP_BOOT_PRIVATE_DATA *Private\r | |
124 | );\r | |
125 | \r | |
126 | /**\r | |
127 | This function will register the default DNS addresses to the network device.\r | |
128 | \r | |
129 | @param[in] Private The pointer to HTTP_BOOT_PRIVATE_DATA.\r | |
130 | @param[in] DataLength Size of the buffer pointed to by DnsServerData in bytes.\r | |
131 | @param[in] DnsServerData Point a list of DNS server address in an array\r | |
132 | of EFI_IPv6_ADDRESS instances.\r | |
133 | \r | |
134 | @retval EFI_SUCCESS The DNS configuration has been configured successfully.\r | |
135 | @retval Others Failed to configure the address.\r | |
136 | \r | |
137 | **/\r | |
138 | EFI_STATUS\r | |
139 | HttpBootSetIp6Dns (\r | |
140 | IN HTTP_BOOT_PRIVATE_DATA *Private,\r | |
141 | IN UINTN DataLength,\r | |
142 | IN VOID *DnsServerData\r | |
143 | );\r | |
144 | \r | |
145 | /**\r | |
146 | This function will register the IPv6 gateway address to the network device.\r | |
147 | \r | |
148 | @param[in] Private The pointer to HTTP_BOOT_PRIVATE_DATA.\r | |
149 | \r | |
150 | @retval EFI_SUCCESS The new IP configuration has been configured successfully.\r | |
151 | @retval Others Failed to configure the address.\r | |
152 | \r | |
153 | **/\r | |
154 | EFI_STATUS\r | |
155 | HttpBootSetIp6Gateway (\r | |
156 | IN HTTP_BOOT_PRIVATE_DATA *Private\r | |
157 | );\r | |
158 | \r | |
159 | /**\r | |
160 | This function will register the station IP address.\r | |
161 | \r | |
162 | @param[in] Private The pointer to HTTP_BOOT_PRIVATE_DATA.\r | |
163 | \r | |
164 | @retval EFI_SUCCESS The new IP address has been configured successfully.\r | |
165 | @retval Others Failed to configure the address.\r | |
166 | \r | |
167 | **/\r | |
168 | EFI_STATUS\r | |
169 | HttpBootSetIp6Address (\r | |
170 | IN HTTP_BOOT_PRIVATE_DATA *Private\r | |
171 | );\r | |
172 | \r | |
173 | #endif\r |