]>
Commit | Line | Data |
---|---|---|
bdb140d7 | 1 | /** @file\r |
bdb140d7 | 2 | This file defines the EFI IPv6 (Internet Protocol version 6)\r |
3 | Protocol interface. It is split into the following three main\r | |
4 | sections:\r | |
5 | - EFI IPv6 Service Binding Protocol\r | |
d551cc64 | 6 | - EFI IPv6 Variable (deprecated in UEFI 2.4B)\r |
bdb140d7 | 7 | - EFI IPv6 Protocol\r |
8 | The EFI IPv6 Protocol provides basic network IPv6 packet I/O services,\r | |
9 | which includes support for Neighbor Discovery Protocol (ND), Multicast\r | |
10 | Listener Discovery Protocol (MLD), and a subset of the Internet Control\r | |
11 | Message Protocol (ICMPv6).\r | |
bdb140d7 | 12 | \r |
d551cc64 | 13 | Copyright (c) 2008 - 2014, Intel Corporation. All rights reserved.<BR>\r |
9344f092 | 14 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
bce46f7e | 15 | \r |
16 | @par Revision Reference:\r | |
17 | This Protocol is introduced in UEFI Specification 2.2\r | |
bdb140d7 | 18 | \r |
19 | **/\r | |
20 | \r | |
21 | #ifndef __EFI_IP6_PROTOCOL_H__\r | |
22 | #define __EFI_IP6_PROTOCOL_H__\r | |
23 | \r | |
24 | #include <Protocol/ManagedNetwork.h>\r | |
25 | \r | |
26 | \r | |
27 | #define EFI_IP6_SERVICE_BINDING_PROTOCOL_GUID \\r | |
28 | { \\r | |
29 | 0xec835dd3, 0xfe0f, 0x617b, {0xa6, 0x21, 0xb3, 0x50, 0xc3, 0xe1, 0x33, 0x88 } \\r | |
30 | }\r | |
31 | \r | |
32 | #define EFI_IP6_PROTOCOL_GUID \\r | |
33 | { \\r | |
34 | 0x2c8759d5, 0x5c2d, 0x66ef, {0x92, 0x5f, 0xb6, 0x6c, 0x10, 0x19, 0x57, 0xe2 } \\r | |
35 | }\r | |
36 | \r | |
37 | typedef struct _EFI_IP6_PROTOCOL EFI_IP6_PROTOCOL;\r | |
38 | \r | |
abbfadd7 | 39 | ///\r |
d551cc64 FS |
40 | /// EFI_IP6_ADDRESS_PAIR is deprecated in the UEFI 2.4B and should not be used any more.\r |
41 | /// The definition in here is only present to provide backwards compatability.\r | |
abbfadd7 | 42 | ///\r |
bce46f7e | 43 | typedef struct{\r |
abbfadd7 | 44 | ///\r |
45 | /// The EFI IPv6 Protocol instance handle that is using this address/prefix pair.\r | |
46 | ///\r | |
47 | EFI_HANDLE InstanceHandle;\r | |
48 | ///\r | |
49 | /// IPv6 address in network byte order.\r | |
50 | ///\r | |
51 | EFI_IPv6_ADDRESS Ip6Address;\r | |
52 | ///\r | |
53 | /// The length of the prefix associated with the Ip6Address.\r | |
54 | ///\r | |
55 | UINT8 PrefixLength;\r | |
bce46f7e | 56 | } EFI_IP6_ADDRESS_PAIR;\r |
abbfadd7 | 57 | \r |
58 | ///\r | |
d551cc64 FS |
59 | /// EFI_IP6_VARIABLE_DATA is deprecated in the UEFI 2.4B and should not be used any more.\r |
60 | /// The definition in here is only present to provide backwards compatability.\r | |
abbfadd7 | 61 | ///\r |
62 | typedef struct {\r | |
63 | ///\r | |
64 | /// The handle of the driver that creates this entry.\r | |
65 | ///\r | |
66 | EFI_HANDLE DriverHandle;\r | |
67 | ///\r | |
68 | /// The number of IPv6 address pairs that follow this data structure.\r | |
69 | ///\r | |
70 | UINT32 AddressCount;\r | |
71 | ///\r | |
72 | /// List of IPv6 address pairs that are currently in use.\r | |
73 | ///\r | |
74 | EFI_IP6_ADDRESS_PAIR AddressPairs[1];\r | |
75 | } EFI_IP6_VARIABLE_DATA;\r | |
76 | \r | |
bdb140d7 | 77 | ///\r |
78 | /// ICMPv6 type definitions for error messages\r | |
79 | ///\r | |
80 | ///@{\r | |
81 | #define ICMP_V6_DEST_UNREACHABLE 0x1\r | |
82 | #define ICMP_V6_PACKET_TOO_BIG 0x2\r | |
83 | #define ICMP_V6_TIME_EXCEEDED 0x3\r | |
84 | #define ICMP_V6_PARAMETER_PROBLEM 0x4\r | |
85 | ///@}\r | |
86 | \r | |
87 | ///\r | |
88 | /// ICMPv6 type definition for informational messages\r | |
89 | ///\r | |
90 | ///@{\r | |
91 | #define ICMP_V6_ECHO_REQUEST 0x80\r | |
92 | #define ICMP_V6_ECHO_REPLY 0x81\r | |
93 | #define ICMP_V6_LISTENER_QUERY 0x82\r | |
94 | #define ICMP_V6_LISTENER_REPORT 0x83\r | |
95 | #define ICMP_V6_LISTENER_DONE 0x84\r | |
96 | #define ICMP_V6_ROUTER_SOLICIT 0x85\r | |
97 | #define ICMP_V6_ROUTER_ADVERTISE 0x86\r | |
98 | #define ICMP_V6_NEIGHBOR_SOLICIT 0x87\r | |
99 | #define ICMP_V6_NEIGHBOR_ADVERTISE 0x88\r | |
100 | #define ICMP_V6_REDIRECT 0x89\r | |
101 | #define ICMP_V6_LISTENER_REPORT_2 0x8F\r | |
102 | ///@}\r | |
103 | \r | |
104 | ///\r | |
105 | /// ICMPv6 code definitions for ICMP_V6_DEST_UNREACHABLE\r | |
106 | ///\r | |
107 | ///@{\r | |
108 | #define ICMP_V6_NO_ROUTE_TO_DEST 0x0\r | |
109 | #define ICMP_V6_COMM_PROHIBITED 0x1\r | |
110 | #define ICMP_V6_BEYOND_SCOPE 0x2\r | |
bce46f7e | 111 | #define ICMP_V6_ADDR_UNREACHABLE 0x3\r |
bdb140d7 | 112 | #define ICMP_V6_PORT_UNREACHABLE 0x4\r |
113 | #define ICMP_V6_SOURCE_ADDR_FAILED 0x5\r | |
114 | #define ICMP_V6_ROUTE_REJECTED 0x6\r | |
115 | ///@}\r | |
bce46f7e | 116 | \r |
bdb140d7 | 117 | ///\r |
118 | /// ICMPv6 code definitions for ICMP_V6_TIME_EXCEEDED\r | |
119 | ///\r | |
120 | ///@{\r | |
121 | #define ICMP_V6_TIMEOUT_HOP_LIMIT 0x0\r | |
122 | #define ICMP_V6_TIMEOUT_REASSEMBLE 0x1\r | |
123 | ///@}\r | |
bce46f7e | 124 | \r |
bdb140d7 | 125 | ///\r |
126 | /// ICMPv6 code definitions for ICMP_V6_PARAMETER_PROBLEM\r | |
127 | ///\r | |
128 | ///@{\r | |
129 | #define ICMP_V6_ERRONEOUS_HEADER 0x0\r | |
130 | #define ICMP_V6_UNRECOGNIZE_NEXT_HDR 0x1\r | |
131 | #define ICMP_V6_UNRECOGNIZE_OPTION 0x2\r | |
132 | ///@}\r | |
133 | \r | |
134 | ///\r | |
135 | /// EFI_IP6_CONFIG_DATA\r | |
136 | /// is used to report and change IPv6 session parameters.\r | |
137 | ///\r | |
138 | typedef struct {\r | |
bce46f7e | 139 | ///\r |
140 | /// For the IPv6 packet to send and receive, this is the default value\r | |
141 | /// of the 'Next Header' field in the last IPv6 extension header or in\r | |
142 | /// the IPv6 header if there are no extension headers. Ignored when\r | |
bdb140d7 | 143 | /// AcceptPromiscuous is TRUE.\r |
bce46f7e | 144 | ///\r |
bdb140d7 | 145 | UINT8 DefaultProtocol;\r |
bce46f7e | 146 | ///\r |
147 | /// Set to TRUE to receive all IPv6 packets that get through the\r | |
148 | /// receive filters.\r | |
149 | /// Set to FALSE to receive only the DefaultProtocol IPv6\r | |
150 | /// packets that get through the receive filters. Ignored when\r | |
bdb140d7 | 151 | /// AcceptPromiscuous is TRUE.\r |
bce46f7e | 152 | ///\r |
bdb140d7 | 153 | BOOLEAN AcceptAnyProtocol;\r |
bce46f7e | 154 | ///\r |
155 | /// Set to TRUE to receive ICMP error report packets. Ignored when\r | |
bdb140d7 | 156 | /// AcceptPromiscuous or AcceptAnyProtocol is TRUE.\r |
bce46f7e | 157 | ///\r |
bdb140d7 | 158 | BOOLEAN AcceptIcmpErrors;\r |
bce46f7e | 159 | ///\r |
160 | /// Set to TRUE to receive all IPv6 packets that are sent to any\r | |
161 | /// hardware address or any protocol address. Set to FALSE to stop\r | |
bdb140d7 | 162 | /// receiving all promiscuous IPv6 packets.\r |
bce46f7e | 163 | ///\r |
bdb140d7 | 164 | BOOLEAN AcceptPromiscuous;\r |
bce46f7e | 165 | ///\r |
166 | /// The destination address of the packets that will be transmitted.\r | |
bdb140d7 | 167 | /// Ignored if it is unspecified.\r |
bce46f7e | 168 | ///\r |
bdb140d7 | 169 | EFI_IPv6_ADDRESS DestinationAddress;\r |
bce46f7e | 170 | ///\r |
171 | /// The station IPv6 address that will be assigned to this EFI IPv6\r | |
172 | /// Protocol instance. This field can be set and changed only when\r | |
173 | /// the EFI IPv6 driver is transitioning from the stopped to the started\r | |
174 | /// states. If the StationAddress is specified, the EFI IPv6 Protocol\r | |
175 | /// driver will deliver only incoming IPv6 packets whose destination\r | |
176 | /// matches this IPv6 address exactly. The StationAddress is required\r | |
177 | /// to be one of currently configured IPv6 addresses. An address\r | |
178 | /// containing all zeroes is also accepted as a special case. Under this\r | |
179 | /// situation, the IPv6 driver is responsible for binding a source\r | |
180 | /// address to this EFI IPv6 protocol instance according to the source\r | |
181 | /// address selection algorithm. Only incoming packets destined to\r | |
182 | /// the selected address will be delivered to the user. And the\r | |
183 | /// selected station address can be retrieved through later\r | |
184 | /// GetModeData() call. If no address is available for selecting,\r | |
185 | /// EFI_NO_MAPPING will be returned, and the station address will\r | |
186 | /// only be successfully bound to this EFI IPv6 protocol instance\r | |
bdb140d7 | 187 | /// after IP6ModeData.IsConfigured changed to TRUE.\r |
bce46f7e | 188 | ///\r |
189 | EFI_IPv6_ADDRESS StationAddress;\r | |
190 | ///\r | |
191 | /// TrafficClass field in transmitted IPv6 packets. Default value\r | |
bdb140d7 | 192 | /// is zero.\r |
bce46f7e | 193 | ///\r |
bdb140d7 | 194 | UINT8 TrafficClass;\r |
bce46f7e | 195 | ///\r |
196 | /// HopLimit field in transmitted IPv6 packets.\r | |
197 | ///\r | |
bdb140d7 | 198 | UINT8 HopLimit;\r |
bce46f7e | 199 | ///\r |
200 | /// FlowLabel field in transmitted IPv6 packets. Default value is\r | |
bdb140d7 | 201 | /// zero.\r |
bce46f7e | 202 | ///\r |
bdb140d7 | 203 | UINT32 FlowLabel;\r |
bce46f7e | 204 | ///\r |
205 | /// The timer timeout value (number of microseconds) for the\r | |
206 | /// receive timeout event to be associated with each assembled\r | |
bdb140d7 | 207 | /// packet. Zero means do not drop assembled packets.\r |
bce46f7e | 208 | ///\r |
bdb140d7 | 209 | UINT32 ReceiveTimeout;\r |
bce46f7e | 210 | ///\r |
211 | /// The timer timeout value (number of microseconds) for the\r | |
212 | /// transmit timeout event to be associated with each outgoing\r | |
bdb140d7 | 213 | /// packet. Zero means do not drop outgoing packets.\r |
bce46f7e | 214 | ///\r |
bdb140d7 | 215 | UINT32 TransmitTimeout;\r |
216 | } EFI_IP6_CONFIG_DATA;\r | |
217 | \r | |
218 | ///\r | |
219 | /// EFI_IP6_ADDRESS_INFO\r | |
220 | ///\r | |
221 | typedef struct {\r | |
222 | EFI_IPv6_ADDRESS Address; ///< The IPv6 address.\r | |
bce46f7e | 223 | UINT8 PrefixLength; ///< The length of the prefix associated with the Address.\r |
bdb140d7 | 224 | } EFI_IP6_ADDRESS_INFO;\r |
225 | \r | |
226 | ///\r | |
227 | /// EFI_IP6_ROUTE_TABLE\r | |
228 | /// is the entry structure that is used in routing tables\r | |
bce46f7e | 229 | ///\r |
bdb140d7 | 230 | typedef struct {\r |
231 | ///\r | |
bce46f7e | 232 | /// The IPv6 address of the gateway to be used as the next hop for\r |
233 | /// packets to this prefix. If the IPv6 address is all zeros, then the\r | |
bdb140d7 | 234 | /// prefix is on-link.\r |
235 | ///\r | |
bce46f7e | 236 | EFI_IPv6_ADDRESS Gateway;\r |
bdb140d7 | 237 | ///\r |
238 | /// The destination prefix to be routed.\r | |
239 | ///\r | |
bce46f7e | 240 | EFI_IPv6_ADDRESS Destination;\r |
bdb140d7 | 241 | ///\r |
242 | /// The length of the prefix associated with the Destination.\r | |
243 | ///\r | |
244 | UINT8 PrefixLength;\r | |
245 | } EFI_IP6_ROUTE_TABLE;\r | |
246 | \r | |
247 | ///\r | |
248 | /// EFI_IP6_NEIGHBOR_STATE\r | |
249 | ///\r | |
250 | typedef enum {\r | |
251 | ///\r | |
bce46f7e | 252 | /// Address resolution is being performed on this entry. Specially,\r |
253 | /// Neighbor Solicitation has been sent to the solicited-node\r | |
254 | /// multicast address of the target, but corresponding Neighbor\r | |
bdb140d7 | 255 | /// Advertisement has not been received.\r |
256 | ///\r | |
bce46f7e | 257 | EfiNeighborInComplete,\r |
bdb140d7 | 258 | ///\r |
bce46f7e | 259 | /// Positive confirmation was received that the forward path to the\r |
bdb140d7 | 260 | /// neighbor was functioning properly.\r |
261 | ///\r | |
262 | EfiNeighborReachable,\r | |
263 | ///\r | |
bce46f7e | 264 | ///Reachable Time has elapsed since the last positive confirmation\r |
265 | ///was received. In this state, the forward path to the neighbor was\r | |
bdb140d7 | 266 | ///functioning properly.\r |
267 | ///\r | |
268 | EfiNeighborStale,\r | |
269 | ///\r | |
bce46f7e | 270 | /// This state is an optimization that gives upper-layer protocols\r |
bdb140d7 | 271 | /// additional time to provide reachability confirmation.\r |
272 | ///\r | |
273 | EfiNeighborDelay,\r | |
274 | ///\r | |
bce46f7e | 275 | /// A reachability confirmation is actively sought by retransmitting\r |
276 | /// Neighbor Solicitations every RetransTimer milliseconds until a\r | |
bdb140d7 | 277 | /// reachability confirmation is received.\r |
278 | ///\r | |
279 | EfiNeighborProbe\r | |
280 | } EFI_IP6_NEIGHBOR_STATE;\r | |
281 | \r | |
282 | ///\r | |
283 | /// EFI_IP6_NEIGHBOR_CACHE\r | |
bce46f7e | 284 | /// is the entry structure that is used in neighbor cache. It records a set\r |
285 | /// of entries about individual neighbors to which traffic has been sent recently.\r | |
bdb140d7 | 286 | ///\r |
287 | typedef struct {\r | |
288 | EFI_IPv6_ADDRESS Neighbor; ///< The on-link unicast/anycast IP address of the neighbor.\r | |
bce46f7e | 289 | EFI_MAC_ADDRESS LinkAddress; ///< Link-layer address of the neighbor.\r |
290 | EFI_IP6_NEIGHBOR_STATE State; ///< State of this neighbor cache entry.\r | |
bdb140d7 | 291 | } EFI_IP6_NEIGHBOR_CACHE;\r |
292 | \r | |
293 | ///\r | |
294 | /// EFI_IP6_ICMP_TYPE\r | |
bce46f7e | 295 | /// is used to describe those ICMP messages that are supported by this EFI\r |
bdb140d7 | 296 | /// IPv6 Protocol driver.\r |
297 | ///\r | |
298 | typedef struct {\r | |
299 | UINT8 Type; ///< The type of ICMP message.\r | |
300 | UINT8 Code; ///< The code of the ICMP message.\r | |
bce46f7e | 301 | } EFI_IP6_ICMP_TYPE;\r |
bdb140d7 | 302 | \r |
303 | ///\r | |
304 | /// EFI_IP6_MODE_DATA\r | |
305 | ///\r | |
bce46f7e | 306 | typedef struct {\r |
bdb140d7 | 307 | ///\r |
bce46f7e | 308 | /// Set to TRUE after this EFI IPv6 Protocol instance is started.\r |
309 | /// All other fields in this structure are undefined until this field is TRUE.\r | |
bdb140d7 | 310 | /// Set to FALSE when the EFI IPv6 Protocol instance is stopped.\r |
bce46f7e | 311 | ///\r |
bdb140d7 | 312 | BOOLEAN IsStarted;\r |
313 | ///\r | |
314 | /// The maximum packet size, in bytes, of the packet which the upper layer driver could feed.\r | |
315 | ///\r | |
316 | UINT32 MaxPacketSize;\r | |
bce46f7e | 317 | ///\r |
bdb140d7 | 318 | /// Current configuration settings. Undefined until IsStarted is TRUE.\r |
319 | ///\r | |
320 | EFI_IP6_CONFIG_DATA ConfigData;\r | |
bce46f7e | 321 | ///\r |
322 | /// Set to TRUE when the EFI IPv6 Protocol instance is configured.\r | |
323 | /// The instance is configured when it has a station address and\r | |
324 | /// corresponding prefix length.\r | |
bdb140d7 | 325 | /// Set to FALSE when the EFI IPv6 Protocol instance is not configured.\r |
326 | ///\r | |
327 | BOOLEAN IsConfigured;\r | |
bce46f7e | 328 | ///\r |
329 | /// Number of configured IPv6 addresses on this interface.\r | |
bdb140d7 | 330 | ///\r |
331 | UINT32 AddressCount;\r | |
bce46f7e | 332 | ///\r |
333 | /// List of currently configured IPv6 addresses and corresponding\r | |
334 | /// prefix lengths assigned to this interface. It is caller's\r | |
bdb140d7 | 335 | /// responsibility to free this buffer.\r |
bce46f7e | 336 | ///\r |
bdb140d7 | 337 | EFI_IP6_ADDRESS_INFO *AddressList;\r |
bce46f7e | 338 | ///\r |
339 | /// Number of joined multicast groups. Undefined until\r | |
bdb140d7 | 340 | /// IsConfigured is TRUE.\r |
341 | ///\r | |
342 | UINT32 GroupCount;\r | |
bce46f7e | 343 | ///\r |
344 | /// List of joined multicast group addresses. It is caller's\r | |
345 | /// responsibility to free this buffer. Undefined until\r | |
bdb140d7 | 346 | /// IsConfigured is TRUE.\r |
347 | ///\r | |
348 | EFI_IPv6_ADDRESS *GroupTable;\r | |
bce46f7e | 349 | ///\r |
350 | /// Number of entries in the routing table. Undefined until\r | |
bdb140d7 | 351 | /// IsConfigured is TRUE.\r |
352 | ///\r | |
353 | UINT32 RouteCount;\r | |
bce46f7e | 354 | ///\r |
bdb140d7 | 355 | /// Routing table entries. It is caller's responsibility to free this buffer.\r |
356 | ///\r | |
357 | EFI_IP6_ROUTE_TABLE *RouteTable;\r | |
358 | ///\r | |
bce46f7e | 359 | /// Number of entries in the neighbor cache. Undefined until\r |
bdb140d7 | 360 | /// IsConfigured is TRUE.\r |
361 | ///\r | |
362 | UINT32 NeighborCount;\r | |
bdb140d7 | 363 | ///\r |
bce46f7e | 364 | /// Neighbor cache entries. It is caller's responsibility to free this\r |
365 | /// buffer. Undefined until IsConfigured is TRUE.\r | |
366 | ///\r | |
367 | EFI_IP6_NEIGHBOR_CACHE *NeighborCache;\r | |
368 | ///\r | |
369 | /// Number of entries in the prefix table. Undefined until\r | |
bdb140d7 | 370 | /// IsConfigured is TRUE.\r |
371 | ///\r | |
372 | UINT32 PrefixCount;\r | |
bce46f7e | 373 | ///\r |
374 | /// On-link Prefix table entries. It is caller's responsibility to free this\r | |
375 | /// buffer. Undefined until IsConfigured is TRUE.\r | |
bdb140d7 | 376 | ///\r |
377 | EFI_IP6_ADDRESS_INFO *PrefixTable;\r | |
bce46f7e | 378 | ///\r |
bdb140d7 | 379 | /// Number of entries in the supported ICMP types list.\r |
380 | ///\r | |
381 | UINT32 IcmpTypeCount;\r | |
bce46f7e | 382 | ///\r |
383 | /// Array of ICMP types and codes that are supported by this EFI\r | |
384 | /// IPv6 Protocol driver. It is caller's responsibility to free this\r | |
bdb140d7 | 385 | /// buffer.\r |
386 | ///\r | |
387 | EFI_IP6_ICMP_TYPE *IcmpTypeList;\r | |
388 | } EFI_IP6_MODE_DATA;\r | |
389 | \r | |
390 | ///\r | |
391 | /// EFI_IP6_HEADER\r | |
392 | /// The fields in the IPv6 header structure are defined in the Internet\r | |
393 | /// Protocol version6 specification.\r | |
394 | ///\r | |
395 | #pragma pack(1)\r | |
396 | typedef struct _EFI_IP6_HEADER {\r | |
397 | UINT8 TrafficClassH:4;\r | |
398 | UINT8 Version:4;\r | |
399 | UINT8 FlowLabelH:4;\r | |
bce46f7e | 400 | UINT8 TrafficClassL:4;\r |
bdb140d7 | 401 | UINT16 FlowLabelL;\r |
402 | UINT16 PayloadLength;\r | |
403 | UINT8 NextHeader;\r | |
404 | UINT8 HopLimit;\r | |
405 | EFI_IPv6_ADDRESS SourceAddress;\r | |
406 | EFI_IPv6_ADDRESS DestinationAddress;\r | |
407 | } EFI_IP6_HEADER;\r | |
9591f383 | 408 | #pragma pack()\r |
bdb140d7 | 409 | \r |
410 | ///\r | |
411 | /// EFI_IP6_FRAGMENT_DATA\r | |
bce46f7e | 412 | /// describes the location and length of the IPv6 packet\r |
bdb140d7 | 413 | /// fragment to transmit or that has been received.\r |
414 | ///\r | |
415 | typedef struct _EFI_IP6_FRAGMENT_DATA {\r | |
416 | UINT32 FragmentLength; ///< Length of fragment data. This field may not be set to zero.\r | |
417 | VOID *FragmentBuffer; ///< Pointer to fragment data. This field may not be set to NULL.\r | |
418 | } EFI_IP6_FRAGMENT_DATA;\r | |
419 | \r | |
420 | ///\r | |
421 | /// EFI_IP6_RECEIVE_DATA\r | |
422 | ///\r | |
423 | typedef struct _EFI_IP6_RECEIVE_DATA {\r | |
bce46f7e | 424 | ///\r |
425 | /// Time when the EFI IPv6 Protocol driver accepted the packet.\r | |
bdb140d7 | 426 | /// Ignored if it is zero.\r |
bce46f7e | 427 | ///\r |
bdb140d7 | 428 | EFI_TIME TimeStamp;\r |
bce46f7e | 429 | ///\r |
430 | /// After this event is signaled, the receive data structure is released\r | |
bdb140d7 | 431 | /// and must not be referenced.\r |
bce46f7e | 432 | ///\r |
bdb140d7 | 433 | EFI_EVENT RecycleSignal;\r |
434 | ///\r | |
bce46f7e | 435 | ///Length of the IPv6 packet headers, including both the IPv6\r |
436 | ///header and any extension headers.\r | |
bdb140d7 | 437 | ///\r |
438 | UINT32 HeaderLength;\r | |
bce46f7e | 439 | ///\r |
440 | /// Pointer to the IPv6 packet header. If the IPv6 packet was\r | |
441 | /// fragmented, this argument is a pointer to the header in the first\r | |
442 | /// fragment.\r | |
443 | ///\r | |
bdb140d7 | 444 | EFI_IP6_HEADER *Header;\r |
bce46f7e | 445 | ///\r |
446 | /// Sum of the lengths of IPv6 packet buffers in FragmentTable. May\r | |
bdb140d7 | 447 | /// be zero.\r |
bce46f7e | 448 | ///\r |
bdb140d7 | 449 | UINT32 DataLength;\r |
bce46f7e | 450 | ///\r |
bdb140d7 | 451 | /// Number of IPv6 payload fragments. May be zero.\r |
bce46f7e | 452 | ///\r |
bdb140d7 | 453 | UINT32 FragmentCount;\r |
bce46f7e | 454 | ///\r |
bdb140d7 | 455 | /// Array of payload fragment lengths and buffer pointers.\r |
bce46f7e | 456 | ///\r |
bdb140d7 | 457 | EFI_IP6_FRAGMENT_DATA FragmentTable[1];\r |
458 | } EFI_IP6_RECEIVE_DATA;\r | |
459 | \r | |
460 | ///\r | |
461 | /// EFI_IP6_OVERRIDE_DATA\r | |
bce46f7e | 462 | /// The information and flags in the override data structure will override\r |
463 | /// default parameters or settings for one Transmit() function call.\r | |
bdb140d7 | 464 | ///\r |
465 | typedef struct _EFI_IP6_OVERRIDE_DATA {\r | |
466 | UINT8 Protocol; ///< Protocol type override.\r | |
467 | UINT8 HopLimit; ///< Hop-Limit override.\r | |
468 | UINT32 FlowLabel; ///< Flow-Label override.\r | |
469 | } EFI_IP6_OVERRIDE_DATA;\r | |
bce46f7e | 470 | \r |
bdb140d7 | 471 | ///\r |
bce46f7e | 472 | /// EFI_IP6_TRANSMIT_DATA\r |
bdb140d7 | 473 | ///\r |
bce46f7e | 474 | typedef struct _EFI_IP6_TRANSMIT_DATA {\r |
475 | ///\r | |
476 | /// The destination IPv6 address. If it is unspecified,\r | |
bdb140d7 | 477 | /// ConfigData.DestinationAddress will be used instead.\r |
bce46f7e | 478 | ///\r |
bdb140d7 | 479 | EFI_IPv6_ADDRESS DestinationAddress;\r |
bce46f7e | 480 | ///\r |
bdb140d7 | 481 | /// If not NULL, the IPv6 transmission control override data.\r |
bce46f7e | 482 | ///\r |
bdb140d7 | 483 | EFI_IP6_OVERRIDE_DATA *OverrideData;\r |
bce46f7e | 484 | ///\r |
485 | /// Total length in byte of the IPv6 extension headers specified in\r | |
bdb140d7 | 486 | /// ExtHdrs.\r |
bce46f7e | 487 | ///\r |
bdb140d7 | 488 | UINT32 ExtHdrsLength;\r |
bce46f7e | 489 | ///\r |
490 | /// Pointer to the IPv6 extension headers. The IP layer will append\r | |
491 | /// the required extension headers if they are not specified by\r | |
bdb140d7 | 492 | /// ExtHdrs. Ignored if ExtHdrsLength is zero.\r |
bce46f7e | 493 | ///\r |
bdb140d7 | 494 | VOID *ExtHdrs;\r |
bce46f7e | 495 | ///\r |
496 | /// The protocol of first extension header in ExtHdrs. Ignored if\r | |
bdb140d7 | 497 | /// ExtHdrsLength is zero.\r |
bce46f7e | 498 | ///\r |
bdb140d7 | 499 | UINT8 NextHeader;\r |
bce46f7e | 500 | ///\r |
bdb140d7 | 501 | /// Total length in bytes of the FragmentTable data to transmit.\r |
bce46f7e | 502 | ///\r |
bdb140d7 | 503 | UINT32 DataLength;\r |
bce46f7e | 504 | ///\r |
bdb140d7 | 505 | /// Number of entries in the fragment data table.\r |
bce46f7e | 506 | ///\r |
bdb140d7 | 507 | UINT32 FragmentCount;\r |
bce46f7e | 508 | ///\r |
bdb140d7 | 509 | /// Start of the fragment data table.\r |
bce46f7e | 510 | ///\r |
bdb140d7 | 511 | EFI_IP6_FRAGMENT_DATA FragmentTable[1];\r |
512 | } EFI_IP6_TRANSMIT_DATA;\r | |
513 | \r | |
514 | ///\r | |
515 | /// EFI_IP6_COMPLETION_TOKEN\r | |
516 | /// structures are used for both transmit and receive operations.\r | |
517 | ///\r | |
518 | typedef struct {\r | |
519 | ///\r | |
bce46f7e | 520 | /// This Event will be signaled after the Status field is updated by\r |
bdb140d7 | 521 | /// the EFI IPv6 Protocol driver. The type of Event must be EFI_NOTIFY_SIGNAL.\r |
522 | ///\r | |
523 | EFI_EVENT Event;\r | |
524 | ///\r | |
525 | /// Will be set to one of the following values:\r | |
bce46f7e | 526 | /// - EFI_SUCCESS: The receive or transmit completed\r |
bdb140d7 | 527 | /// successfully.\r |
528 | /// - EFI_ABORTED: The receive or transmit was aborted\r | |
529 | /// - EFI_TIMEOUT: The transmit timeout expired.\r | |
530 | /// - EFI_ICMP_ERROR: An ICMP error packet was received.\r | |
bce46f7e | 531 | /// - EFI_DEVICE_ERROR: An unexpected system or network\r |
bdb140d7 | 532 | /// error occurred.\r |
bce46f7e | 533 | /// - EFI_SECURITY_VIOLATION: The transmit or receive was\r |
bdb140d7 | 534 | /// failed because of an IPsec policy check.\r |
c5c3e7e2 | 535 | /// - EFI_NO_MEDIA: There was a media error.\r |
bdb140d7 | 536 | ///\r |
537 | EFI_STATUS Status;\r | |
538 | union {\r | |
539 | ///\r | |
540 | /// When the Token is used for receiving, RxData is a pointer to the EFI_IP6_RECEIVE_DATA.\r | |
541 | ///\r | |
542 | EFI_IP6_RECEIVE_DATA *RxData;\r | |
543 | ///\r | |
544 | /// When the Token is used for transmitting, TxData is a pointer to the EFI_IP6_TRANSMIT_DATA.\r | |
545 | ///\r | |
546 | EFI_IP6_TRANSMIT_DATA *TxData;\r | |
547 | } Packet;\r | |
548 | } EFI_IP6_COMPLETION_TOKEN;\r | |
549 | \r | |
550 | /**\r | |
551 | Gets the current operational settings for this instance of the EFI IPv6 Protocol driver.\r | |
bce46f7e | 552 | \r |
553 | The GetModeData() function returns the current operational mode data for this driver instance.\r | |
554 | The data fields in EFI_IP6_MODE_DATA are read only. This function is used optionally to\r | |
bdb140d7 | 555 | retrieve the operational mode data of underlying networks or drivers..\r |
556 | \r | |
557 | @param[in] This Pointer to the EFI_IP6_PROTOCOL instance.\r | |
558 | @param[out] Ip6ModeData Pointer to the EFI IPv6 Protocol mode data structure.\r | |
559 | @param[out] MnpConfigData Pointer to the managed network configuration data structure.\r | |
560 | @param[out] SnpModeData Pointer to the simple network mode data structure.\r | |
bce46f7e | 561 | \r |
bdb140d7 | 562 | @retval EFI_SUCCESS The operation completed successfully.\r |
563 | @retval EFI_INVALID_PARAMETER This is NULL.\r | |
564 | @retval EFI_OUT_OF_RESOURCES The required mode data could not be allocated.\r | |
565 | \r | |
566 | **/\r | |
bce46f7e | 567 | typedef\r |
bdb140d7 | 568 | EFI_STATUS\r |
5e6f3ee2 | 569 | (EFIAPI *EFI_IP6_GET_MODE_DATA)(\r |
bdb140d7 | 570 | IN EFI_IP6_PROTOCOL *This,\r |
571 | OUT EFI_IP6_MODE_DATA *Ip6ModeData OPTIONAL,\r | |
572 | OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL,\r | |
573 | OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL\r | |
574 | );\r | |
575 | \r | |
576 | /**\r | |
577 | Assigns an IPv6 address and subnet mask to this EFI IPv6 Protocol driver instance.\r | |
bce46f7e | 578 | \r |
579 | The Configure() function is used to set, change, or reset the operational parameters and filter\r | |
580 | settings for this EFI IPv6 Protocol instance. Until these parameters have been set, no network traffic\r | |
581 | can be sent or received by this instance. Once the parameters have been reset (by calling this\r | |
582 | function with Ip6ConfigData set to NULL), no more traffic can be sent or received until these\r | |
583 | parameters have been set again. Each EFI IPv6 Protocol instance can be started and stopped\r | |
584 | independently of each other by enabling or disabling their receive filter settings with the\r | |
bdb140d7 | 585 | Configure() function.\r |
bce46f7e | 586 | \r |
587 | If Ip6ConfigData.StationAddress is a valid non-zero IPv6 unicast address, it is required\r | |
588 | to be one of the currently configured IPv6 addresses list in the EFI IPv6 drivers, or else\r | |
589 | EFI_INVALID_PARAMETER will be returned. If Ip6ConfigData.StationAddress is\r | |
590 | unspecified, the IPv6 driver will bind a source address according to the source address selection\r | |
591 | algorithm. Clients could frequently call GetModeData() to check get currently configured IPv6\r | |
592 | address list in the EFI IPv6 driver. If both Ip6ConfigData.StationAddress and\r | |
593 | Ip6ConfigData.Destination are unspecified, when transmitting the packet afterwards, the\r | |
bdb140d7 | 594 | source address filled in each outgoing IPv6 packet is decided based on the destination of this packet. .\r |
bce46f7e | 595 | \r |
596 | If operational parameters are reset or changed, any pending transmit and receive requests will be\r | |
597 | cancelled. Their completion token status will be set to EFI_ABORTED and their events will be\r | |
bdb140d7 | 598 | signaled.\r |
599 | \r | |
600 | @param[in] This Pointer to the EFI_IP6_PROTOCOL instance.\r | |
601 | @param[in] Ip6ConfigData Pointer to the EFI IPv6 Protocol configuration data structure.\r | |
bce46f7e | 602 | \r |
bdb140d7 | 603 | @retval EFI_SUCCESS The driver instance was successfully opened.\r |
604 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r | |
605 | - This is NULL.\r | |
bce46f7e | 606 | - Ip6ConfigData.StationAddress is neither zero nor\r |
bdb140d7 | 607 | a unicast IPv6 address.\r |
bce46f7e | 608 | - Ip6ConfigData.StationAddress is neither zero nor\r |
bdb140d7 | 609 | one of the configured IP addresses in the EFI IPv6 driver.\r |
bce46f7e | 610 | - Ip6ConfigData.DefaultProtocol is illegal.\r |
bdb140d7 | 611 | @retval EFI_OUT_OF_RESOURCES The EFI IPv6 Protocol driver instance data could not be allocated.\r |
bce46f7e | 612 | @retval EFI_NO_MAPPING The IPv6 driver was responsible for choosing a source address for\r |
613 | this instance, but no source address was available for use.\r | |
614 | @retval EFI_ALREADY_STARTED The interface is already open and must be stopped before the IPv6\r | |
bdb140d7 | 615 | address or prefix length can be changed.\r |
bce46f7e | 616 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI IPv6\r |
bdb140d7 | 617 | Protocol driver instance is not opened.\r |
bce46f7e | 618 | @retval EFI_UNSUPPORTED Default protocol specified through\r |
bdb140d7 | 619 | Ip6ConfigData.DefaulProtocol isn't supported.\r |
620 | \r | |
621 | **/\r | |
bce46f7e | 622 | typedef\r |
bdb140d7 | 623 | EFI_STATUS\r |
5e6f3ee2 | 624 | (EFIAPI *EFI_IP6_CONFIGURE)(\r |
bdb140d7 | 625 | IN EFI_IP6_PROTOCOL *This,\r |
626 | IN EFI_IP6_CONFIG_DATA *Ip6ConfigData OPTIONAL\r | |
627 | );\r | |
628 | \r | |
629 | /**\r | |
630 | Joins and leaves multicast groups.\r | |
bce46f7e | 631 | \r |
632 | The Groups() function is used to join and leave multicast group sessions. Joining a group will\r | |
633 | enable reception of matching multicast packets. Leaving a group will disable reception of matching\r | |
bdb140d7 | 634 | multicast packets. Source-Specific Multicast isn't required to be supported.\r |
bce46f7e | 635 | \r |
bdb140d7 | 636 | If JoinFlag is FALSE and GroupAddress is NULL, all joined groups will be left.\r |
637 | \r | |
638 | @param[in] This Pointer to the EFI_IP6_PROTOCOL instance.\r | |
639 | @param[in] JoinFlag Set to TRUE to join the multicast group session and FALSE to leave.\r | |
640 | @param[in] GroupAddress Pointer to the IPv6 multicast address.\r | |
bce46f7e | 641 | \r |
bdb140d7 | 642 | @retval EFI_SUCCESS The operation completed successfully.\r |
643 | @retval EFI_INVALID_PARAMETER One or more of the following is TRUE:\r | |
644 | - This is NULL.\r | |
645 | - JoinFlag is TRUE and GroupAddress is NULL.\r | |
646 | - GroupAddress is not NULL and *GroupAddress is\r | |
bce46f7e | 647 | not a multicast IPv6 address.\r |
648 | - GroupAddress is not NULL and *GroupAddress is in the\r | |
bdb140d7 | 649 | range of SSM destination address.\r |
650 | @retval EFI_NOT_STARTED This instance has not been started.\r | |
651 | @retval EFI_OUT_OF_RESOURCES System resources could not be allocated.\r | |
652 | @retval EFI_UNSUPPORTED This EFI IPv6 Protocol implementation does not support multicast groups.\r | |
653 | @retval EFI_ALREADY_STARTED The group address is already in the group table (when\r | |
654 | JoinFlag is TRUE).\r | |
655 | @retval EFI_NOT_FOUND The group address is not in the group table (when JoinFlag is FALSE).\r | |
656 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r | |
657 | \r | |
658 | **/\r | |
bce46f7e | 659 | typedef\r |
bdb140d7 | 660 | EFI_STATUS\r |
5e6f3ee2 | 661 | (EFIAPI *EFI_IP6_GROUPS)(\r |
bdb140d7 | 662 | IN EFI_IP6_PROTOCOL *This,\r |
663 | IN BOOLEAN JoinFlag,\r | |
664 | IN EFI_IPv6_ADDRESS *GroupAddress OPTIONAL\r | |
665 | );\r | |
666 | \r | |
667 | /**\r | |
668 | Adds and deletes routing table entries.\r | |
669 | \r | |
670 | The Routes() function adds a route to or deletes a route from the routing table.\r | |
bce46f7e | 671 | \r |
672 | Routes are determined by comparing the leftmost PrefixLength bits of Destination with\r | |
bdb140d7 | 673 | the destination IPv6 address arithmetically. The gateway address must be on the same subnet as the\r |
674 | configured station address.\r | |
bce46f7e | 675 | \r |
676 | The default route is added with Destination and PrefixLegth both set to all zeros. The\r | |
bdb140d7 | 677 | default route matches all destination IPv6 addresses that do not match any other routes.\r |
678 | \r | |
679 | All EFI IPv6 Protocol instances share a routing table.\r | |
bce46f7e | 680 | \r |
bdb140d7 | 681 | @param[in] This Pointer to the EFI_IP6_PROTOCOL instance.\r |
bce46f7e | 682 | @param[in] DeleteRoute Set to TRUE to delete this route from the routing table. Set to\r |
683 | FALSE to add this route to the routing table. Destination,\r | |
684 | PrefixLength and Gateway are used as the key to each\r | |
bdb140d7 | 685 | route entry.\r |
686 | @param[in] Destination The address prefix of the subnet that needs to be routed.\r | |
bce46f7e | 687 | @param[in] PrefixLength The prefix length of Destination. Ignored if Destination\r |
bdb140d7 | 688 | is NULL.\r |
689 | @param[in] GatewayAddress The unicast gateway IPv6 address for this route.\r | |
690 | \r | |
691 | @retval EFI_SUCCESS The operation completed successfully.\r | |
692 | @retval EFI_NOT_STARTED The driver instance has not been started.\r | |
693 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r | |
694 | - This is NULL.\r | |
bce46f7e | 695 | - When DeleteRoute is TRUE, both Destination and\r |
bdb140d7 | 696 | GatewayAddress are NULL.\r |
bce46f7e | 697 | - When DeleteRoute is FALSE, either Destination or\r |
bdb140d7 | 698 | GatewayAddress is NULL.\r |
699 | - *GatewayAddress is not a valid unicast IPv6 address.\r | |
bce46f7e | 700 | - *GatewayAddress is one of the local configured IPv6\r |
bdb140d7 | 701 | addresses.\r |
702 | @retval EFI_OUT_OF_RESOURCES Could not add the entry to the routing table.\r | |
703 | @retval EFI_NOT_FOUND This route is not in the routing table (when DeleteRoute is TRUE).\r | |
704 | @retval EFI_ACCESS_DENIED The route is already defined in the routing table (when\r | |
705 | DeleteRoute is FALSE).\r | |
bce46f7e | 706 | \r |
bdb140d7 | 707 | **/\r |
bce46f7e | 708 | typedef\r |
bdb140d7 | 709 | EFI_STATUS\r |
5e6f3ee2 | 710 | (EFIAPI *EFI_IP6_ROUTES)(\r |
bdb140d7 | 711 | IN EFI_IP6_PROTOCOL *This,\r |
712 | IN BOOLEAN DeleteRoute,\r | |
5e6f3ee2 | 713 | IN EFI_IPv6_ADDRESS *Destination OPTIONAL,\r |
bdb140d7 | 714 | IN UINT8 PrefixLength,\r |
bce46f7e | 715 | IN EFI_IPv6_ADDRESS *GatewayAddress OPTIONAL\r |
bdb140d7 | 716 | );\r |
717 | \r | |
718 | /**\r | |
719 | Add or delete Neighbor cache entries.\r | |
720 | \r | |
bce46f7e | 721 | The Neighbors() function is used to add, update, or delete an entry from neighbor cache.\r |
722 | IPv6 neighbor cache entries are typically inserted and updated by the network protocol driver as\r | |
723 | network traffic is processed. Most neighbor cache entries will time out and be deleted if the network\r | |
724 | traffic stops. Neighbor cache entries that were inserted by Neighbors() may be static (will not\r | |
bdb140d7 | 725 | timeout) or dynamic (will time out).\r |
bce46f7e | 726 | \r |
727 | The implementation should follow the neighbor cache timeout mechanism which is defined in\r | |
728 | RFC4861. The default neighbor cache timeout value should be tuned for the expected network\r | |
bdb140d7 | 729 | environment\r |
730 | \r | |
731 | @param[in] This Pointer to the EFI_IP6_PROTOCOL instance.\r | |
bce46f7e | 732 | @param[in] DeleteFlag Set to TRUE to delete the specified cache entry, set to FALSE to\r |
733 | add (or update, if it already exists and Override is TRUE) the\r | |
734 | specified cache entry. TargetIp6Address is used as the key\r | |
bdb140d7 | 735 | to find the requested cache entry.\r |
736 | @param[in] TargetIp6Address Pointer to Target IPv6 address.\r | |
bce46f7e | 737 | @param[in] TargetLinkAddress Pointer to link-layer address of the target. Ignored if NULL.\r |
738 | @param[in] Timeout Time in 100-ns units that this entry will remain in the neighbor\r | |
739 | cache, it will be deleted after Timeout. A value of zero means that\r | |
740 | the entry is permanent. A non-zero value means that the entry is\r | |
741 | dynamic.\r | |
742 | @param[in] Override If TRUE, the cached link-layer address of the matching entry will\r | |
743 | be overridden and updated; if FALSE, EFI_ACCESS_DENIED\r | |
bdb140d7 | 744 | will be returned if a corresponding cache entry already existed.\r |
745 | \r | |
746 | @retval EFI_SUCCESS The data has been queued for transmission.\r | |
747 | @retval EFI_NOT_STARTED This instance has not been started.\r | |
748 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r | |
749 | - This is NULL.\r | |
750 | - TargetIpAddress is NULL.\r | |
751 | - *TargetLinkAddress is invalid when not NULL.\r | |
752 | - *TargetIpAddress is not a valid unicast IPv6 address.\r | |
bce46f7e | 753 | - *TargetIpAddress is one of the local configured IPv6\r |
bdb140d7 | 754 | addresses.\r |
755 | @retval EFI_OUT_OF_RESOURCES Could not add the entry to the neighbor cache.\r | |
bce46f7e | 756 | @retval EFI_NOT_FOUND This entry is not in the neighbor cache (when DeleteFlag is\r |
757 | TRUE or when DeleteFlag is FALSE while\r | |
bdb140d7 | 758 | TargetLinkAddress is NULL.).\r |
bce46f7e | 759 | @retval EFI_ACCESS_DENIED The to-be-added entry is already defined in the neighbor cache,\r |
760 | and that entry is tagged as un-overridden (when DeleteFlag\r | |
bdb140d7 | 761 | is FALSE).\r |
762 | \r | |
763 | **/\r | |
bce46f7e | 764 | typedef\r |
bdb140d7 | 765 | EFI_STATUS\r |
5e6f3ee2 | 766 | (EFIAPI *EFI_IP6_NEIGHBORS)(\r |
bdb140d7 | 767 | IN EFI_IP6_PROTOCOL *This,\r |
768 | IN BOOLEAN DeleteFlag,\r | |
769 | IN EFI_IPv6_ADDRESS *TargetIp6Address,\r | |
770 | IN EFI_MAC_ADDRESS *TargetLinkAddress,\r | |
771 | IN UINT32 Timeout,\r | |
772 | IN BOOLEAN Override\r | |
773 | );\r | |
774 | \r | |
775 | /**\r | |
776 | Places outgoing data packets into the transmit queue.\r | |
777 | \r | |
778 | The Transmit() function places a sending request in the transmit queue of this\r | |
779 | EFI IPv6 Protocol instance. Whenever the packet in the token is sent out or some\r | |
780 | errors occur, the event in the token will be signaled and the status is updated.\r | |
781 | \r | |
782 | @param[in] This Pointer to the EFI_IP6_PROTOCOL instance.\r | |
783 | @param[in] Token Pointer to the transmit token.\r | |
784 | \r | |
785 | @retval EFI_SUCCESS The data has been queued for transmission.\r | |
786 | @retval EFI_NOT_STARTED This instance has not been started.\r | |
bce46f7e | 787 | @retval EFI_NO_MAPPING The IPv6 driver was responsible for choosing a source address for\r |
bdb140d7 | 788 | this transmission, but no source address was available for use.\r |
789 | @retval EFI_INVALID_PARAMETER One or more of the following is TRUE:\r | |
790 | - This is NULL.\r | |
791 | - Token is NULL.\r | |
792 | - Token.Event is NULL.\r | |
793 | - Token.Packet.TxData is NULL.\r | |
794 | - Token.Packet.ExtHdrsLength is not zero and Token.Packet.ExtHdrs is NULL.\r | |
795 | - Token.Packet.FragmentCount is zero.\r | |
796 | - One or more of the Token.Packet.TxData.FragmentTable[].FragmentLength fields is zero.\r | |
797 | - One or more of the Token.Packet.TxData.FragmentTable[].FragmentBuffer fields is NULL.\r | |
798 | - Token.Packet.TxData.DataLength is zero or not equal to the sum of fragment lengths.\r | |
bce46f7e | 799 | - Token.Packet.TxData.DestinationAddress is non-zero when DestinationAddress is configured as\r |
bdb140d7 | 800 | non-zero when doing Configure() for this EFI IPv6 protocol instance.\r |
bce46f7e | 801 | - Token.Packet.TxData.DestinationAddress is unspecified when DestinationAddress is unspecified\r |
bdb140d7 | 802 | when doing Configure() for this EFI IPv6 protocol instance.\r |
803 | @retval EFI_ACCESS_DENIED The transmit completion token with the same Token.Event\r | |
804 | was already in the transmit queue.\r | |
805 | @retval EFI_NOT_READY The completion token could not be queued because the transmit\r | |
bce46f7e | 806 | queue is full.\r |
bdb140d7 | 807 | @retval EFI_NOT_FOUND Not route is found to destination address.\r |
808 | @retval EFI_OUT_OF_RESOURCES Could not queue the transmit data.\r | |
809 | @retval EFI_BUFFER_TOO_SMALL Token.Packet.TxData.TotalDataLength is too\r | |
810 | short to transmit.\r | |
bce46f7e | 811 | @retval EFI_BAD_BUFFER_SIZE If Token.Packet.TxData.DataLength is beyond the\r |
bdb140d7 | 812 | maximum that which can be described through the Fragment Offset\r |
813 | field in Fragment header when performing fragmentation.\r | |
814 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r | |
815 | \r | |
816 | **/\r | |
bce46f7e | 817 | typedef\r |
bdb140d7 | 818 | EFI_STATUS\r |
5e6f3ee2 | 819 | (EFIAPI *EFI_IP6_TRANSMIT)(\r |
bdb140d7 | 820 | IN EFI_IP6_PROTOCOL *This,\r |
821 | IN EFI_IP6_COMPLETION_TOKEN *Token\r | |
822 | );\r | |
823 | \r | |
824 | /**\r | |
825 | Places a receiving request into the receiving queue.\r | |
bce46f7e | 826 | \r |
bdb140d7 | 827 | The Receive() function places a completion token into the receive packet queue.\r |
828 | This function is always asynchronous.\r | |
bce46f7e | 829 | \r |
bdb140d7 | 830 | The Token.Event field in the completion token must be filled in by the caller\r |
831 | and cannot be NULL. When the receive operation completes, the EFI IPv6 Protocol\r | |
832 | driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event\r | |
833 | is signaled.\r | |
834 | \r | |
835 | @param[in] This Pointer to the EFI_IP6_PROTOCOL instance.\r | |
ea6898b9 | 836 | @param[in] Token Pointer to a token that is associated with the receive data descriptor.\r |
bce46f7e | 837 | \r |
bdb140d7 | 838 | @retval EFI_SUCCESS The receive completion token was cached.\r |
839 | @retval EFI_NOT_STARTED This EFI IPv6 Protocol instance has not been started.\r | |
bce46f7e | 840 | @retval EFI_NO_MAPPING When IP6 driver responsible for binding source address to this instance,\r |
bdb140d7 | 841 | while no source address is available for use.\r |
842 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r | |
843 | - This is NULL.\r | |
844 | - Token is NULL.\r | |
845 | - Token.Event is NULL.\r | |
846 | @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system\r | |
847 | resources (usually memory).\r | |
848 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r | |
849 | The EFI IPv6 Protocol instance has been reset to startup defaults.\r | |
850 | @retval EFI_ACCESS_DENIED The receive completion token with the same Token.Event was already\r | |
851 | in the receive queue.\r | |
852 | @retval EFI_NOT_READY The receive request could not be queued because the receive queue is full.\r | |
bce46f7e | 853 | \r |
854 | **/\r | |
855 | typedef\r | |
856 | EFI_STATUS\r | |
857 | (EFIAPI *EFI_IP6_RECEIVE)(\r | |
bdb140d7 | 858 | IN EFI_IP6_PROTOCOL *This,\r |
859 | IN EFI_IP6_COMPLETION_TOKEN *Token\r | |
860 | );\r | |
861 | \r | |
862 | /**\r | |
863 | Abort an asynchronous transmit or receive request.\r | |
bce46f7e | 864 | \r |
bdb140d7 | 865 | The Cancel() function is used to abort a pending transmit or receive request.\r |
866 | If the token is in the transmit or receive request queues, after calling this\r | |
867 | function, Token->Status will be set to EFI_ABORTED and then Token->Event will\r | |
868 | be signaled. If the token is not in one of the queues, which usually means the\r | |
869 | asynchronous operation has completed, this function will not signal the token\r | |
870 | and EFI_NOT_FOUND is returned.\r | |
871 | \r | |
872 | @param[in] This Pointer to the EFI_IP6_PROTOCOL instance.\r | |
873 | @param[in] Token Pointer to a token that has been issued by\r | |
874 | EFI_IP6_PROTOCOL.Transmit() or\r | |
875 | EFI_IP6_PROTOCOL.Receive(). If NULL, all pending\r | |
876 | tokens are aborted. Type EFI_IP6_COMPLETION_TOKEN is\r | |
877 | defined in EFI_IP6_PROTOCOL.Transmit().\r | |
bce46f7e | 878 | \r |
bdb140d7 | 879 | @retval EFI_SUCCESS The asynchronous I/O request was aborted and\r |
880 | Token->Event was signaled. When Token is NULL, all\r | |
881 | pending requests were aborted and their events were signaled.\r | |
882 | @retval EFI_INVALID_PARAMETER This is NULL.\r | |
883 | @retval EFI_NOT_STARTED This instance has not been started.\r | |
884 | @retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O request was\r | |
885 | not found in the transmit or receive queue. It has either completed\r | |
886 | or was not issued by Transmit() and Receive().\r | |
887 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r | |
bce46f7e | 888 | \r |
889 | **/\r | |
890 | typedef\r | |
891 | EFI_STATUS\r | |
892 | (EFIAPI *EFI_IP6_CANCEL)(\r | |
bdb140d7 | 893 | IN EFI_IP6_PROTOCOL *This,\r |
894 | IN EFI_IP6_COMPLETION_TOKEN *Token OPTIONAL\r | |
895 | );\r | |
896 | \r | |
897 | /**\r | |
898 | Polls for incoming data packets and processes outgoing data packets.\r | |
bce46f7e | 899 | \r |
bdb140d7 | 900 | The Poll() function polls for incoming data packets and processes outgoing data\r |
901 | packets. Network drivers and applications can call the EFI_IP6_PROTOCOL.Poll()\r | |
902 | function to increase the rate that data packets are moved between the communications\r | |
903 | device and the transmit and receive queues.\r | |
bce46f7e | 904 | \r |
bdb140d7 | 905 | In some systems the periodic timer event may not poll the underlying communications\r |
906 | device fast enough to transmit and/or receive all data packets without missing\r | |
907 | incoming packets or dropping outgoing packets. Drivers and applications that are\r | |
908 | experiencing packet loss should try calling the EFI_IP6_PROTOCOL.Poll() function\r | |
909 | more often.\r | |
910 | \r | |
911 | @param[in] This Pointer to the EFI_IP6_PROTOCOL instance.\r | |
912 | \r | |
913 | @retval EFI_SUCCESS Incoming or outgoing data was processed.\r | |
914 | @retval EFI_NOT_STARTED This EFI IPv6 Protocol instance has not been started.\r | |
915 | @retval EFI_INVALID_PARAMETER This is NULL.\r | |
916 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r | |
917 | @retval EFI_NOT_READY No incoming or outgoing data is processed.\r | |
918 | @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue.\r | |
919 | Consider increasing the polling rate.\r | |
920 | \r | |
921 | **/\r | |
bce46f7e | 922 | typedef\r |
bdb140d7 | 923 | EFI_STATUS\r |
5e6f3ee2 | 924 | (EFIAPI *EFI_IP6_POLL)(\r |
bdb140d7 | 925 | IN EFI_IP6_PROTOCOL *This\r |
926 | );\r | |
927 | \r | |
928 | ///\r | |
929 | /// The EFI IPv6 Protocol implements a simple packet-oriented interface that can be\r | |
930 | /// used by drivers, daemons, and applications to transmit and receive network packets.\r | |
931 | ///\r | |
5e6f3ee2 | 932 | struct _EFI_IP6_PROTOCOL {\r |
bdb140d7 | 933 | EFI_IP6_GET_MODE_DATA GetModeData;\r |
934 | EFI_IP6_CONFIGURE Configure;\r | |
935 | EFI_IP6_GROUPS Groups;\r | |
936 | EFI_IP6_ROUTES Routes;\r | |
937 | EFI_IP6_NEIGHBORS Neighbors;\r | |
938 | EFI_IP6_TRANSMIT Transmit;\r | |
939 | EFI_IP6_RECEIVE Receive;\r | |
940 | EFI_IP6_CANCEL Cancel;\r | |
941 | EFI_IP6_POLL Poll;\r | |
5e6f3ee2 | 942 | };\r |
bdb140d7 | 943 | \r |
944 | extern EFI_GUID gEfiIp6ServiceBindingProtocolGuid;\r | |
945 | extern EFI_GUID gEfiIp6ProtocolGuid;\r | |
946 | \r | |
947 | #endif\r |