]>
Commit | Line | Data |
---|---|---|
1 | /** @file\r | |
2 | This file provides a definition of the EFI IPv6 Configuration\r | |
3 | Protocol.\r | |
4 | \r | |
5 | Copyright (c) 2008 - 2018, Intel Corporation. All rights reserved.<BR>\r | |
6 | SPDX-License-Identifier: BSD-2-Clause-Patent\r | |
7 | \r | |
8 | **/\r | |
9 | #ifndef __EFI_IP6CONFIG_PROTOCOL_H__\r | |
10 | #define __EFI_IP6CONFIG_PROTOCOL_H__\r | |
11 | \r | |
12 | #include <Protocol/Ip6.h>\r | |
13 | \r | |
14 | #define EFI_IP6_CONFIG_PROTOCOL_GUID \\r | |
15 | { \\r | |
16 | 0x937fe521, 0x95ae, 0x4d1a, {0x89, 0x29, 0x48, 0xbc, 0xd9, 0x0a, 0xd3, 0x1a } \\r | |
17 | }\r | |
18 | \r | |
19 | typedef struct _EFI_IP6_CONFIG_PROTOCOL EFI_IP6_CONFIG_PROTOCOL;\r | |
20 | \r | |
21 | ///\r | |
22 | /// EFI_IP6_CONFIG_DATA_TYPE\r | |
23 | ///\r | |
24 | typedef enum {\r | |
25 | ///\r | |
26 | /// The interface information of the communication\r | |
27 | /// device this EFI IPv6 Configuration Protocol instance manages.\r | |
28 | /// This type of data is read only.The corresponding Data is of type\r | |
29 | /// EFI_IP6_CONFIG_INTERFACE_INFO.\r | |
30 | ///\r | |
31 | Ip6ConfigDataTypeInterfaceInfo,\r | |
32 | ///\r | |
33 | /// The alternative interface ID for the\r | |
34 | /// communication device this EFI IPv6 Configuration Protocol\r | |
35 | /// instance manages if the link local IPv6 address generated from\r | |
36 | /// the interfaced ID based on the default source the EFI IPv6\r | |
37 | /// Protocol uses is a duplicate address. The length of the interface\r | |
38 | /// ID is 64 bit. The corresponding Data is of type\r | |
39 | /// EFI_IP6_CONFIG_INTERFACE_ID.\r | |
40 | ///\r | |
41 | Ip6ConfigDataTypeAltInterfaceId,\r | |
42 | ///\r | |
43 | /// The general configuration policy for the EFI IPv6 network\r | |
44 | /// stack running on the communication device this EFI IPv6\r | |
45 | /// Configuration Protocol instance manages. The policy will affect\r | |
46 | /// other configuration settings. The corresponding Data is of type\r | |
47 | /// EFI_IP6_CONFIG_POLICY.\r | |
48 | ///\r | |
49 | Ip6ConfigDataTypePolicy,\r | |
50 | ///\r | |
51 | /// The number of consecutive\r | |
52 | /// Neighbor Solicitation messages sent while performing Duplicate\r | |
53 | /// Address Detection on a tentative address. A value of zero\r | |
54 | /// indicates that Duplicate Address Detection will not be performed\r | |
55 | /// on tentative addresses. The corresponding Data is of type\r | |
56 | /// EFI_IP6_CONFIG_DUP_ADDR_DETECT_TRANSMITS.\r | |
57 | ///\r | |
58 | Ip6ConfigDataTypeDupAddrDetectTransmits,\r | |
59 | ///\r | |
60 | /// The station addresses set manually for the EFI\r | |
61 | /// IPv6 network stack. It is only configurable when the policy is\r | |
62 | /// Ip6ConfigPolicyManual. The corresponding Data is a\r | |
63 | /// pointer to an array of EFI_IPv6_ADDRESS instances. When\r | |
64 | /// DataSize is 0 and Data is NULL, the existing configuration\r | |
65 | /// is cleared from the EFI IPv6 Configuration Protocol instance.\r | |
66 | ///\r | |
67 | Ip6ConfigDataTypeManualAddress,\r | |
68 | ///\r | |
69 | /// The gateway addresses set manually for the EFI IPv6\r | |
70 | /// network stack running on the communication device this EFI\r | |
71 | /// IPv6 Configuration Protocol manages. It is not configurable when\r | |
72 | /// the policy is Ip6ConfigPolicyAutomatic. The gateway\r | |
73 | /// addresses must be unicast IPv6 addresses. The corresponding\r | |
74 | /// Data is a pointer to an array of EFI_IPv6_ADDRESS instances.\r | |
75 | /// When DataSize is 0 and Data is NULL, the existing configuration\r | |
76 | /// is cleared from the EFI IPv6 Configuration Protocol instance.\r | |
77 | ///\r | |
78 | Ip6ConfigDataTypeGateway,\r | |
79 | ///\r | |
80 | /// The DNS server list for the EFI IPv6 network stack\r | |
81 | /// running on the communication device this EFI IPv6\r | |
82 | /// Configuration Protocol manages. It is not configurable when the\r | |
83 | /// policy is Ip6ConfigPolicyAutomatic.The DNS server\r | |
84 | /// addresses must be unicast IPv6 addresses. The corresponding\r | |
85 | /// Data is a pointer to an array of EFI_IPv6_ADDRESS instances.\r | |
86 | /// When DataSize is 0 and Data is NULL, the existing configuration\r | |
87 | /// is cleared from the EFI IPv6 Configuration Protocol instance.\r | |
88 | ///\r | |
89 | Ip6ConfigDataTypeDnsServer,\r | |
90 | ///\r | |
91 | /// The number of this enumeration memebers.\r | |
92 | ///\r | |
93 | Ip6ConfigDataTypeMaximum\r | |
94 | } EFI_IP6_CONFIG_DATA_TYPE;\r | |
95 | \r | |
96 | ///\r | |
97 | /// EFI_IP6_CONFIG_INTERFACE_INFO\r | |
98 | /// describes the operational state of the interface this\r | |
99 | /// EFI IPv6 Configuration Protocol instance manages.\r | |
100 | ///\r | |
101 | typedef struct {\r | |
102 | ///\r | |
103 | /// The name of the interface. It is a NULL-terminated string.\r | |
104 | ///\r | |
105 | CHAR16 Name[32];\r | |
106 | ///\r | |
107 | /// The interface type of the network interface.\r | |
108 | ///\r | |
109 | UINT8 IfType;\r | |
110 | ///\r | |
111 | /// The size, in bytes, of the network interface's hardware address.\r | |
112 | ///\r | |
113 | UINT32 HwAddressSize;\r | |
114 | ///\r | |
115 | /// The hardware address for the network interface.\r | |
116 | ///\r | |
117 | EFI_MAC_ADDRESS HwAddress;\r | |
118 | ///\r | |
119 | /// Number of EFI_IP6_ADDRESS_INFO structures pointed to by AddressInfo.\r | |
120 | ///\r | |
121 | UINT32 AddressInfoCount;\r | |
122 | ///\r | |
123 | /// Pointer to an array of EFI_IP6_ADDRESS_INFO instances\r | |
124 | /// which contain the local IPv6 addresses and the corresponding\r | |
125 | /// prefix length information. Set to NULL if AddressInfoCount\r | |
126 | /// is zero.\r | |
127 | ///\r | |
128 | EFI_IP6_ADDRESS_INFO *AddressInfo;\r | |
129 | ///\r | |
130 | /// Number of route table entries in the following RouteTable.\r | |
131 | ///\r | |
132 | UINT32 RouteCount;\r | |
133 | ///\r | |
134 | /// The route table of the IPv6 network stack runs on this interface.\r | |
135 | /// Set to NULL if RouteCount is zero.\r | |
136 | ///\r | |
137 | EFI_IP6_ROUTE_TABLE *RouteTable;\r | |
138 | } EFI_IP6_CONFIG_INTERFACE_INFO;\r | |
139 | \r | |
140 | ///\r | |
141 | /// EFI_IP6_CONFIG_INTERFACE_ID\r | |
142 | /// describes the 64-bit interface ID.\r | |
143 | ///\r | |
144 | typedef struct {\r | |
145 | UINT8 Id[8];\r | |
146 | } EFI_IP6_CONFIG_INTERFACE_ID;\r | |
147 | \r | |
148 | ///\r | |
149 | /// EFI_IP6_CONFIG_POLICY\r | |
150 | /// defines the general configuration policy the EFI IPv6\r | |
151 | /// Configuration Protocol supports.\r | |
152 | ///\r | |
153 | typedef enum {\r | |
154 | ///\r | |
155 | /// Under this policy, the IpI6ConfigDataTypeManualAddress,\r | |
156 | /// Ip6ConfigDataTypeGateway and Ip6ConfigDataTypeDnsServer\r | |
157 | /// configuration data are required to be set manually.\r | |
158 | /// The EFI IPv6 Protocol will get all required configuration\r | |
159 | /// such as address, prefix and gateway settings from the EFI\r | |
160 | /// IPv6 Configuration protocol.\r | |
161 | ///\r | |
162 | Ip6ConfigPolicyManual,\r | |
163 | ///\r | |
164 | /// Under this policy, the IpI6ConfigDataTypeManualAddress,\r | |
165 | /// Ip6ConfigDataTypeGateway and Ip6ConfigDataTypeDnsServer\r | |
166 | /// configuration data are not allowed to set via SetData().\r | |
167 | /// All of these configurations are retrieved from some auto\r | |
168 | /// configuration mechanism.\r | |
169 | /// The EFI IPv6 Protocol will use the IPv6 stateless address\r | |
170 | /// autoconfiguration mechanism and/or the IPv6 stateful address\r | |
171 | /// autoconfiguration mechanism described in the related RFCs to\r | |
172 | /// get address and other configuration information\r | |
173 | ///\r | |
174 | Ip6ConfigPolicyAutomatic\r | |
175 | } EFI_IP6_CONFIG_POLICY;\r | |
176 | \r | |
177 | ///\r | |
178 | /// EFI_IP6_CONFIG_DUP_ADDR_DETECT_TRANSMITS\r | |
179 | /// describes the number of consecutive Neighbor Solicitation messages sent\r | |
180 | /// while performing Duplicate Address Detection on a tentative address.\r | |
181 | /// The default value for a newly detected communication device is 1.\r | |
182 | ///\r | |
183 | typedef struct {\r | |
184 | UINT32 DupAddrDetectTransmits; ///< The number of consecutive Neighbor Solicitation messages sent.\r | |
185 | } EFI_IP6_CONFIG_DUP_ADDR_DETECT_TRANSMITS;\r | |
186 | \r | |
187 | ///\r | |
188 | /// EFI_IP6_CONFIG_MANUAL_ADDRESS\r | |
189 | /// is used to set the station address information for the EFI IPv6 network\r | |
190 | /// stack manually when the policy is Ip6ConfigPolicyManual.\r | |
191 | ///\r | |
192 | typedef struct {\r | |
193 | EFI_IPv6_ADDRESS Address; ///< The IPv6 unicast address.\r | |
194 | BOOLEAN IsAnycast; ///< Set to TRUE if Address is anycast.\r | |
195 | UINT8 PrefixLength; ///< The length, in bits, of the prefix associated with this Address.\r | |
196 | } EFI_IP6_CONFIG_MANUAL_ADDRESS;\r | |
197 | \r | |
198 | \r | |
199 | /**\r | |
200 | Set the configuration for the EFI IPv6 network stack running on the communication\r | |
201 | device this EFI IPv6 Configuration Protocol instance manages.\r | |
202 | \r | |
203 | This function is used to set the configuration data of type DataType for the EFI\r | |
204 | IPv6 network stack running on the communication device this EFI IPv6 Configuration\r | |
205 | Protocol instance manages.\r | |
206 | \r | |
207 | The DataSize is used to calculate the count of structure instances in the Data for\r | |
208 | some DataType that multiple structure instances are allowed.\r | |
209 | \r | |
210 | This function is always non-blocking. When setting some type of configuration data,\r | |
211 | an asynchronous process is invoked to check the correctness of the data, such as\r | |
212 | doing Duplicate Address Detection on the manually set local IPv6 addresses.\r | |
213 | EFI_NOT_READY is returned immediately to indicate that such an asynchronous process\r | |
214 | is invoked and the process is not finished yet. The caller willing to get the result\r | |
215 | of the asynchronous process is required to call RegisterDataNotify() to register an\r | |
216 | event on the specified configuration data. Once the event is signaled, the caller\r | |
217 | can call GetData() to get back the configuration data in order to know the result.\r | |
218 | For other types of configuration data that do not require an asynchronous configuration\r | |
219 | process, the result of the operation is immediately returned.\r | |
220 | \r | |
221 | @param[in] This Pointer to the EFI_IP6_CONFIG_PROTOCOL instance.\r | |
222 | @param[in] DataType The type of data to set.\r | |
223 | @param[in] DataSize Size of the buffer pointed to by Data in bytes.\r | |
224 | @param[in] Data The data buffer to set. The type of the data buffer is\r | |
225 | associated with the DataType.\r | |
226 | \r | |
227 | @retval EFI_SUCCESS The specified configuration data for the EFI IPv6\r | |
228 | network stack is set successfully.\r | |
229 | @retval EFI_INVALID_PARAMETER One or more of the following are TRUE:\r | |
230 | - This is NULL.\r | |
231 | - One or more fields in Data and DataSize do not match the\r | |
232 | requirement of the data type indicated by DataType.\r | |
233 | @retval EFI_WRITE_PROTECTED The specified configuration data is read-only or the specified\r | |
234 | configuration data can not be set under the current policy\r | |
235 | @retval EFI_ACCESS_DENIED Another set operation on the specified configuration\r | |
236 | data is already in process.\r | |
237 | @retval EFI_NOT_READY An asynchronous process is invoked to set the specified\r | |
238 | configuration data and the process is not finished yet.\r | |
239 | @retval EFI_BAD_BUFFER_SIZE The DataSize does not match the size of the type\r | |
240 | indicated by DataType.\r | |
241 | @retval EFI_UNSUPPORTED This DataType is not supported.\r | |
242 | @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.\r | |
243 | @retval EFI_DEVICE_ERROR An unexpected system error or network error occurred.\r | |
244 | \r | |
245 | **/\r | |
246 | typedef\r | |
247 | EFI_STATUS\r | |
248 | (EFIAPI *EFI_IP6_CONFIG_SET_DATA)(\r | |
249 | IN EFI_IP6_CONFIG_PROTOCOL *This,\r | |
250 | IN EFI_IP6_CONFIG_DATA_TYPE DataType,\r | |
251 | IN UINTN DataSize,\r | |
252 | IN VOID *Data\r | |
253 | );\r | |
254 | \r | |
255 | /**\r | |
256 | Get the configuration data for the EFI IPv6 network stack running on the communication\r | |
257 | device this EFI IPv6 Configuration Protocol instance manages.\r | |
258 | \r | |
259 | This function returns the configuration data of type DataType for the EFI IPv6 network\r | |
260 | stack running on the communication device this EFI IPv6 Configuration Protocol instance\r | |
261 | manages.\r | |
262 | \r | |
263 | The caller is responsible for allocating the buffer used to return the specified\r | |
264 | configuration data and the required size will be returned to the caller if the size of\r | |
265 | the buffer is too small.\r | |
266 | \r | |
267 | EFI_NOT_READY is returned if the specified configuration data is not ready due to an\r | |
268 | already in progress asynchronous configuration process. The caller can call RegisterDataNotify()\r | |
269 | to register an event on the specified configuration data. Once the asynchronous configuration\r | |
270 | process is finished, the event will be signaled and a subsequent GetData() call will return\r | |
271 | the specified configuration data.\r | |
272 | \r | |
273 | @param[in] This Pointer to the EFI_IP6_CONFIG_PROTOCOL instance.\r | |
274 | @param[in] DataType The type of data to get.\r | |
275 | @param[in,out] DataSize On input, in bytes, the size of Data. On output, in bytes, the\r | |
276 | size of buffer required to store the specified configuration data.\r | |
277 | @param[in] Data The data buffer in which the configuration data is returned. The\r | |
278 | type of the data buffer is associated with the DataType.\r | |
279 | \r | |
280 | @retval EFI_SUCCESS The specified configuration data is got successfully.\r | |
281 | @retval EFI_INVALID_PARAMETER One or more of the followings are TRUE:\r | |
282 | - This is NULL.\r | |
283 | - DataSize is NULL.\r | |
284 | - Data is NULL if *DataSize is not zero.\r | |
285 | @retval EFI_BUFFER_TOO_SMALL The size of Data is too small for the specified configuration data\r | |
286 | and the required size is returned in DataSize.\r | |
287 | @retval EFI_NOT_READY The specified configuration data is not ready due to an already in\r | |
288 | progress asynchronous configuration process.\r | |
289 | @retval EFI_NOT_FOUND The specified configuration data is not found.\r | |
290 | \r | |
291 | **/\r | |
292 | typedef\r | |
293 | EFI_STATUS\r | |
294 | (EFIAPI *EFI_IP6_CONFIG_GET_DATA)(\r | |
295 | IN EFI_IP6_CONFIG_PROTOCOL *This,\r | |
296 | IN EFI_IP6_CONFIG_DATA_TYPE DataType,\r | |
297 | IN OUT UINTN *DataSize,\r | |
298 | IN VOID *Data OPTIONAL\r | |
299 | );\r | |
300 | \r | |
301 | /**\r | |
302 | Register an event that is to be signaled whenever a configuration process on the specified\r | |
303 | configuration data is done.\r | |
304 | \r | |
305 | This function registers an event that is to be signaled whenever a configuration process\r | |
306 | on the specified configuration data is done. An event can be registered for different DataType\r | |
307 | simultaneously and the caller is responsible for determining which type of configuration data\r | |
308 | causes the signaling of the event in such case.\r | |
309 | \r | |
310 | @param[in] This Pointer to the EFI_IP6_CONFIG_PROTOCOL instance.\r | |
311 | @param[in] DataType The type of data to unregister the event for.\r | |
312 | @param[in] Event The event to register.\r | |
313 | \r | |
314 | @retval EFI_SUCCESS The notification event for the specified configuration data is\r | |
315 | registered.\r | |
316 | @retval EFI_INVALID_PARAMETER This is NULL or Event is NULL.\r | |
317 | @retval EFI_UNSUPPORTED The configuration data type specified by DataType is not\r | |
318 | supported.\r | |
319 | @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.\r | |
320 | @retval EFI_ACCESS_DENIED The Event is already registered for the DataType.\r | |
321 | \r | |
322 | **/\r | |
323 | typedef\r | |
324 | EFI_STATUS\r | |
325 | (EFIAPI *EFI_IP6_CONFIG_REGISTER_NOTIFY)(\r | |
326 | IN EFI_IP6_CONFIG_PROTOCOL *This,\r | |
327 | IN EFI_IP6_CONFIG_DATA_TYPE DataType,\r | |
328 | IN EFI_EVENT Event\r | |
329 | );\r | |
330 | \r | |
331 | /**\r | |
332 | Remove a previously registered event for the specified configuration data.\r | |
333 | \r | |
334 | This function removes a previously registered event for the specified configuration data.\r | |
335 | \r | |
336 | @param[in] This Pointer to the EFI_IP6_CONFIG_PROTOCOL instance.\r | |
337 | @param[in] DataType The type of data to remove the previously registered event for.\r | |
338 | @param[in] Event The event to unregister.\r | |
339 | \r | |
340 | @retval EFI_SUCCESS The event registered for the specified configuration data is removed.\r | |
341 | @retval EFI_INVALID_PARAMETER This is NULL or Event is NULL.\r | |
342 | @retval EFI_NOT_FOUND The Event has not been registered for the specified\r | |
343 | DataType.\r | |
344 | \r | |
345 | **/\r | |
346 | typedef\r | |
347 | EFI_STATUS\r | |
348 | (EFIAPI *EFI_IP6_CONFIG_UNREGISTER_NOTIFY)(\r | |
349 | IN EFI_IP6_CONFIG_PROTOCOL *This,\r | |
350 | IN EFI_IP6_CONFIG_DATA_TYPE DataType,\r | |
351 | IN EFI_EVENT Event\r | |
352 | );\r | |
353 | \r | |
354 | ///\r | |
355 | /// The EFI_IP6_CONFIG_PROTOCOL provides the mechanism to set and get various\r | |
356 | /// types of configurations for the EFI IPv6 network stack.\r | |
357 | ///\r | |
358 | struct _EFI_IP6_CONFIG_PROTOCOL {\r | |
359 | EFI_IP6_CONFIG_SET_DATA SetData;\r | |
360 | EFI_IP6_CONFIG_GET_DATA GetData;\r | |
361 | EFI_IP6_CONFIG_REGISTER_NOTIFY RegisterDataNotify;\r | |
362 | EFI_IP6_CONFIG_UNREGISTER_NOTIFY UnregisterDataNotify;\r | |
363 | };\r | |
364 | \r | |
365 | extern EFI_GUID gEfiIp6ConfigProtocolGuid;\r | |
366 | \r | |
367 | #endif\r | |
368 | \r |