]>
Commit | Line | Data |
---|---|---|
a3bcde70 HT |
1 | /** @file\r |
2 | Definitions for EFI IPv6 Configuartion Protocol implementation.\r | |
3 | \r | |
f75a7f56 | 4 | Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r |
a3bcde70 HT |
5 | \r |
6 | This program and the accompanying materials\r | |
7 | are licensed and made available under the terms and conditions of the BSD License\r | |
8 | which accompanies this distribution. The full text of the license may be found at\r | |
9 | http://opensource.org/licenses/bsd-license.php.\r | |
10 | \r | |
11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
13 | \r | |
14 | **/\r | |
15 | \r | |
16 | #ifndef __IP6_CONFIG_IMPL_H__\r | |
17 | #define __IP6_CONFIG_IMPL_H__\r | |
18 | \r | |
19 | #define IP6_CONFIG_INSTANCE_SIGNATURE SIGNATURE_32 ('I', 'P', '6', 'C')\r | |
20 | #define IP6_FORM_CALLBACK_INFO_SIGNATURE SIGNATURE_32 ('I', 'F', 'C', 'I')\r | |
21 | #define IP6_CONFIG_VARIABLE_ATTRIBUTE (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS)\r | |
22 | \r | |
23 | #define IP6_CONFIG_DEFAULT_DAD_XMITS 1\r | |
a3bcde70 HT |
24 | \r |
25 | #define DATA_ATTRIB_SIZE_FIXED 0x1\r | |
26 | #define DATA_ATTRIB_VOLATILE 0x2\r | |
27 | \r | |
28 | #define DATA_ATTRIB_SET(Attrib, Bits) (BOOLEAN)((Attrib) & (Bits))\r | |
29 | #define SET_DATA_ATTRIB(Attrib, Bits) ((Attrib) |= (Bits))\r | |
30 | \r | |
31 | typedef struct _IP6_CONFIG_INSTANCE IP6_CONFIG_INSTANCE;\r | |
32 | \r | |
33 | #define IP6_CONFIG_INSTANCE_FROM_PROTOCOL(Proto) \\r | |
34 | CR ((Proto), \\r | |
35 | IP6_CONFIG_INSTANCE, \\r | |
36 | Ip6Config, \\r | |
37 | IP6_CONFIG_INSTANCE_SIGNATURE \\r | |
38 | )\r | |
39 | \r | |
40 | \r | |
41 | #define IP6_CONFIG_INSTANCE_FROM_FORM_CALLBACK(Callback) \\r | |
42 | CR ((Callback), \\r | |
43 | IP6_CONFIG_INSTANCE, \\r | |
44 | CallbackInfo, \\r | |
45 | IP6_CONFIG_INSTANCE_SIGNATURE \\r | |
46 | )\r | |
47 | \r | |
48 | #define IP6_SERVICE_FROM_IP6_CONFIG_INSTANCE(Instance) \\r | |
49 | CR ((Instance), \\r | |
50 | IP6_SERVICE, \\r | |
51 | Ip6ConfigInstance, \\r | |
52 | IP6_SERVICE_SIGNATURE \\r | |
53 | )\r | |
54 | \r | |
55 | #define IP6_FORM_CALLBACK_INFO_FROM_CONFIG_ACCESS(ConfigAccess) \\r | |
56 | CR ((ConfigAccess), \\r | |
57 | IP6_FORM_CALLBACK_INFO, \\r | |
58 | HiiConfigAccess, \\r | |
59 | IP6_FORM_CALLBACK_INFO_SIGNATURE \\r | |
60 | )\r | |
61 | \r | |
62 | /**\r | |
63 | The prototype of work function for EfiIp6ConfigSetData().\r | |
64 | \r | |
65 | @param[in] Instance The pointer to the IP6 config instance data.\r | |
66 | @param[in] DataSize In bytes, the size of the buffer pointed to by Data.\r | |
67 | @param[in] Data The data buffer to set.\r | |
68 | \r | |
69 | @retval EFI_BAD_BUFFER_SIZE The DataSize does not match the size of the type,\r | |
70 | 8 bytes.\r | |
71 | @retval EFI_SUCCESS The specified configuration data for the EFI IPv6\r | |
72 | network stack was set successfully.\r | |
f75a7f56 | 73 | \r |
a3bcde70 HT |
74 | **/\r |
75 | typedef\r | |
76 | EFI_STATUS\r | |
77 | (*IP6_CONFIG_SET_DATA) (\r | |
78 | IN IP6_CONFIG_INSTANCE *Instance,\r | |
79 | IN UINTN DataSize,\r | |
80 | IN VOID *Data\r | |
81 | );\r | |
82 | \r | |
83 | /**\r | |
84 | The prototype of work function for EfiIp6ConfigGetData().\r | |
85 | \r | |
86 | @param[in] Instance The pointer to the IP6 config instance data.\r | |
87 | @param[in, out] DataSize On input, in bytes, the size of Data. On output, in\r | |
88 | bytes, the size of buffer required to store the specified\r | |
89 | configuration data.\r | |
f75a7f56 | 90 | @param[in] Data The data buffer in which the configuration data is returned.\r |
a3bcde70 HT |
91 | Ignored if DataSize is ZERO.\r |
92 | \r | |
93 | @retval EFI_BUFFER_TOO_SMALL The size of Data is too small for the specified\r | |
f75a7f56 | 94 | configuration data, and the required size is\r |
a3bcde70 | 95 | returned in DataSize.\r |
f75a7f56 LG |
96 | @retval EFI_SUCCESS The specified configuration data was obtained successfully.\r |
97 | \r | |
a3bcde70 HT |
98 | **/\r |
99 | typedef\r | |
100 | EFI_STATUS\r | |
101 | (*IP6_CONFIG_GET_DATA) (\r | |
102 | IN IP6_CONFIG_INSTANCE *Instance,\r | |
103 | IN OUT UINTN *DataSize,\r | |
104 | IN VOID *Data OPTIONAL\r | |
105 | );\r | |
106 | \r | |
107 | typedef union {\r | |
108 | VOID *Ptr;\r | |
109 | EFI_IP6_CONFIG_INTERFACE_INFO *IfInfo;\r | |
110 | EFI_IP6_CONFIG_INTERFACE_ID *AltIfId;\r | |
111 | EFI_IP6_CONFIG_POLICY *Policy;\r | |
112 | EFI_IP6_CONFIG_DUP_ADDR_DETECT_TRANSMITS *DadXmits;\r | |
113 | EFI_IP6_CONFIG_MANUAL_ADDRESS *ManualAddress;\r | |
114 | EFI_IPv6_ADDRESS *Gateway;\r | |
115 | EFI_IPv6_ADDRESS *DnsServers;\r | |
116 | } IP6_CONFIG_DATA;\r | |
117 | \r | |
118 | typedef struct {\r | |
119 | IP6_CONFIG_SET_DATA SetData;\r | |
120 | IP6_CONFIG_GET_DATA GetData;\r | |
121 | EFI_STATUS Status;\r | |
122 | UINT8 Attribute;\r | |
123 | NET_MAP EventMap;\r | |
124 | IP6_CONFIG_DATA Data;\r | |
125 | UINTN DataSize;\r | |
126 | } IP6_CONFIG_DATA_ITEM;\r | |
127 | \r | |
128 | typedef struct {\r | |
129 | UINT16 Offset;\r | |
fdc4b0b1 | 130 | UINT32 DataSize;\r |
a3bcde70 HT |
131 | EFI_IP6_CONFIG_DATA_TYPE DataType;\r |
132 | } IP6_CONFIG_DATA_RECORD;\r | |
133 | \r | |
134 | #pragma pack(1)\r | |
135 | \r | |
136 | //\r | |
137 | // heap data that contains the data for each data record.\r | |
138 | //\r | |
139 | // BOOLEAN IsAltIfIdSet;\r | |
140 | // EFI_IP6_CONFIG_POLICY Policy;\r | |
141 | // EFI_IP6_CONFIG_DUP_ADDR_DETECT_TRANSMITS DadXmits;\r | |
142 | // UINT32 ManualaddressCount;\r | |
143 | // UINT32 GatewayCount;\r | |
144 | // UINT32 DnsServersCount;\r | |
145 | // EFI_IP6_CONFIG_INTERFACE_ID AltIfId;\r | |
146 | // EFI_IP6_CONFIG_MANUAL_ADDRESS ManualAddress[];\r | |
147 | // EFI_IPv6_ADDRESS Gateway[];\r | |
148 | // EFI_IPv6_ADDRESS DnsServers[];\r | |
149 | //\r | |
150 | typedef struct {\r | |
151 | UINT32 IaId;\r | |
152 | UINT16 Checksum;\r | |
153 | UINT16 DataRecordCount;\r | |
154 | IP6_CONFIG_DATA_RECORD DataRecord[1];\r | |
155 | } IP6_CONFIG_VARIABLE;\r | |
156 | \r | |
157 | #pragma pack()\r | |
158 | \r | |
159 | typedef struct {\r | |
160 | LIST_ENTRY Link;\r | |
161 | EFI_IP6_ADDRESS_INFO AddrInfo;\r | |
162 | } IP6_ADDRESS_INFO_ENTRY;\r | |
163 | \r | |
164 | typedef struct {\r | |
f75a7f56 | 165 | EFI_IP6_CONFIG_POLICY Policy; ///< manual or automatic\r |
a3bcde70 | 166 | EFI_IP6_CONFIG_DUP_ADDR_DETECT_TRANSMITS DadTransmitCount; ///< dad transmits count\r |
f75a7f56 | 167 | EFI_IP6_CONFIG_INTERFACE_ID InterfaceId; ///< alternative interface id\r |
a3bcde70 HT |
168 | LIST_ENTRY ManualAddress; ///< IP addresses\r |
169 | UINT32 ManualAddressCount; ///< IP addresses count\r | |
170 | LIST_ENTRY GatewayAddress; ///< Gateway address\r | |
171 | UINT32 GatewayAddressCount; ///< Gateway address count\r | |
172 | LIST_ENTRY DnsAddress; ///< DNS server address\r | |
173 | UINT32 DnsAddressCount; ///< DNS server address count\r | |
174 | } IP6_CONFIG_NVDATA;\r | |
175 | \r | |
176 | typedef struct _IP6_FORM_CALLBACK_INFO {\r | |
177 | UINT32 Signature;\r | |
178 | EFI_HANDLE ChildHandle;\r | |
179 | EFI_HII_CONFIG_ACCESS_PROTOCOL HiiConfigAccess;\r | |
180 | EFI_DEVICE_PATH_PROTOCOL *HiiVendorDevicePath;\r | |
181 | EFI_HII_HANDLE RegisteredHandle;\r | |
182 | } IP6_FORM_CALLBACK_INFO;\r | |
183 | \r | |
184 | struct _IP6_CONFIG_INSTANCE {\r | |
185 | UINT32 Signature;\r | |
186 | BOOLEAN Configured;\r | |
187 | LIST_ENTRY Link;\r | |
188 | UINT16 IfIndex;\r | |
189 | \r | |
190 | EFI_IP6_CONFIG_INTERFACE_INFO InterfaceInfo;\r | |
191 | EFI_IP6_CONFIG_INTERFACE_ID AltIfId;\r | |
192 | EFI_IP6_CONFIG_POLICY Policy;\r | |
193 | EFI_IP6_CONFIG_DUP_ADDR_DETECT_TRANSMITS DadXmits;\r | |
194 | \r | |
195 | IP6_CONFIG_DATA_ITEM DataItem[Ip6ConfigDataTypeMaximum];\r | |
196 | NET_MAP DadFailedMap;\r | |
197 | NET_MAP DadPassedMap;\r | |
198 | \r | |
199 | EFI_IP6_CONFIG_PROTOCOL Ip6Config;\r | |
200 | \r | |
201 | EFI_EVENT Dhcp6SbNotifyEvent;\r | |
202 | VOID *Registration;\r | |
203 | EFI_HANDLE Dhcp6Handle;\r | |
204 | EFI_DHCP6_PROTOCOL *Dhcp6;\r | |
205 | BOOLEAN OtherInfoOnly;\r | |
206 | UINT32 IaId;\r | |
207 | EFI_EVENT Dhcp6Event;\r | |
208 | UINT32 FailedIaAddressCount;\r | |
209 | EFI_IPv6_ADDRESS *DeclineAddress;\r | |
210 | UINT32 DeclineAddressCount;\r | |
211 | \r | |
212 | IP6_FORM_CALLBACK_INFO CallbackInfo;\r | |
213 | IP6_CONFIG_NVDATA Ip6NvData;\r | |
214 | };\r | |
215 | \r | |
4720106b JW |
216 | /**\r |
217 | Read the configuration data from variable storage according to the VarName and\r | |
218 | gEfiIp6ConfigProtocolGuid. It checks the integrity of variable data. If the\r | |
219 | data is corrupted, it clears the variable data to ZERO. Othewise, it outputs the\r | |
220 | configuration data to IP6_CONFIG_INSTANCE.\r | |
221 | \r | |
222 | @param[in] VarName The pointer to the variable name\r | |
223 | @param[in, out] Instance The pointer to the IP6 config instance data.\r | |
224 | \r | |
225 | @retval EFI_NOT_FOUND The variable can not be found or already corrupted.\r | |
226 | @retval EFI_OUT_OF_RESOURCES Fail to allocate resource to complete the operation.\r | |
227 | @retval EFI_SUCCESS The configuration data was retrieved successfully.\r | |
228 | \r | |
229 | **/\r | |
230 | EFI_STATUS\r | |
231 | Ip6ConfigReadConfigData (\r | |
232 | IN CHAR16 *VarName,\r | |
233 | IN OUT IP6_CONFIG_INSTANCE *Instance\r | |
234 | );\r | |
235 | \r | |
a3bcde70 HT |
236 | /**\r |
237 | The event process routine when the DHCPv6 server is answered with a reply packet\r | |
238 | for an information request.\r | |
f75a7f56 | 239 | \r |
a3bcde70 HT |
240 | @param[in] This Points to the EFI_DHCP6_PROTOCOL.\r |
241 | @param[in] Context The pointer to the IP6 configuration instance data.\r | |
242 | @param[in] Packet The DHCPv6 reply packet.\r | |
243 | \r | |
244 | @retval EFI_SUCCESS The DNS server address was retrieved from the reply packet.\r | |
f75a7f56 | 245 | @retval EFI_NOT_READY The reply packet does not contain the DNS server option, or\r |
a3bcde70 HT |
246 | the DNS server address is not valid.\r |
247 | \r | |
248 | **/\r | |
249 | EFI_STATUS\r | |
250 | EFIAPI\r | |
251 | Ip6ConfigOnDhcp6Reply (\r | |
252 | IN EFI_DHCP6_PROTOCOL *This,\r | |
253 | IN VOID *Context,\r | |
254 | IN EFI_DHCP6_PACKET *Packet\r | |
255 | );\r | |
256 | \r | |
257 | /**\r | |
258 | The work function to trigger the DHCPv6 process to perform a stateful autoconfiguration.\r | |
f75a7f56 | 259 | \r |
a3bcde70 HT |
260 | @param[in] Instance Pointer to the IP6 config instance data.\r |
261 | @param[in] OtherInfoOnly If FALSE, get stateful address and other information\r | |
262 | via DHCPv6. Otherwise, only get the other information.\r | |
263 | \r | |
264 | @retval EFI_SUCCESS The operation finished successfully.\r | |
265 | @retval EFI_UNSUPPORTED The DHCP6 driver is not available.\r | |
266 | \r | |
267 | **/\r | |
268 | EFI_STATUS\r | |
269 | Ip6ConfigStartStatefulAutoConfig (\r | |
270 | IN IP6_CONFIG_INSTANCE *Instance,\r | |
271 | IN BOOLEAN OtherInfoOnly\r | |
272 | );\r | |
273 | \r | |
274 | /**\r | |
275 | Initialize an IP6_CONFIG_INSTANCE.\r | |
276 | \r | |
277 | @param[out] Instance The buffer of IP6_CONFIG_INSTANCE to be initialized.\r | |
f75a7f56 | 278 | \r |
a3bcde70 HT |
279 | @retval EFI_OUT_OF_RESOURCES Failed to allocate resources to complete the operation.\r |
280 | @retval EFI_SUCCESS The IP6_CONFIG_INSTANCE initialized successfully.\r | |
f75a7f56 | 281 | \r |
a3bcde70 HT |
282 | **/\r |
283 | EFI_STATUS\r | |
284 | Ip6ConfigInitInstance (\r | |
285 | OUT IP6_CONFIG_INSTANCE *Instance\r | |
286 | );\r | |
287 | \r | |
288 | /**\r | |
289 | Release an IP6_CONFIG_INSTANCE.\r | |
290 | \r | |
291 | @param[in, out] Instance The buffer of IP6_CONFIG_INSTANCE to be freed.\r | |
f75a7f56 | 292 | \r |
a3bcde70 HT |
293 | **/\r |
294 | VOID\r | |
295 | Ip6ConfigCleanInstance (\r | |
296 | IN OUT IP6_CONFIG_INSTANCE *Instance\r | |
297 | );\r | |
298 | \r | |
299 | /**\r | |
75dce340 | 300 | Destroy the Dhcp6 child in IP6_CONFIG_INSTANCE and release the resources.\r |
a3bcde70 HT |
301 | \r |
302 | @param[in, out] Instance The buffer of IP6_CONFIG_INSTANCE to be freed.\r | |
303 | \r | |
304 | @retval EFI_SUCCESS The child was successfully destroyed.\r | |
75dce340 | 305 | @retval Others Failed to destroy the child.\r |
f75a7f56 | 306 | \r |
a3bcde70 HT |
307 | **/\r |
308 | EFI_STATUS\r | |
309 | Ip6ConfigDestroyDhcp6 (\r | |
310 | IN OUT IP6_CONFIG_INSTANCE *Instance\r | |
311 | );\r | |
312 | \r | |
313 | #endif\r |