]>
Commit | Line | Data |
---|---|---|
97b38d4e | 1 | /** @file\r |
fb115c61 | 2 | This library is only intended to be used by UEFI network stack modules.\r |
3 | It provides the combined IpIo layer on the EFI IP4 Protocol and EFI IP6 protocol.\r | |
97b38d4e | 4 | \r |
d1102dba | 5 | Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.<BR>\r |
9d510e61 | 6 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
97b38d4e | 7 | \r |
8 | **/\r | |
9 | \r | |
10 | #ifndef _IP_IO_H_\r | |
11 | #define _IP_IO_H_\r | |
12 | \r | |
13 | #include <Protocol/Ip4.h>\r | |
fb115c61 | 14 | #include <Protocol/Ip6.h>\r |
cdfdbb97 | 15 | \r |
97b38d4e | 16 | #include <Library/NetLib.h>\r |
17 | \r | |
18 | //\r | |
d1102dba | 19 | // type and code define for ICMP protocol error\r |
97b38d4e | 20 | // from IP\r |
21 | //\r | |
d1050b9d MK |
22 | #define ICMP_TYPE_UNREACH 3\r |
23 | #define ICMP_TYPE_TIMXCEED 11\r | |
24 | #define ICMP_TYPE_PARAMPROB 12\r | |
25 | #define ICMP_TYPE_SOURCEQUENCH 4\r | |
26 | \r | |
27 | #define ICMP_CODE_UNREACH_NET 0\r | |
28 | #define ICMP_CODE_UNREACH_HOST 1\r | |
29 | #define ICMP_CODE_UNREACH_PROTOCOL 2\r | |
30 | #define ICMP_CODE_UNREACH_PORT 3\r | |
31 | #define ICMP_CODE_UNREACH_NEEDFRAG 4\r | |
32 | #define ICMP_CODE_UNREACH_SRCFAIL 5\r | |
33 | #define ICMP_CODE_UNREACH_NET_UNKNOWN 6\r | |
34 | #define ICMP_CODE_UNREACH_HOST_UNKNOWN 7\r | |
35 | #define ICMP_CODE_UNREACH_ISOLATED 8\r | |
36 | #define ICMP_CODE_UNREACH_NET_PROHIB 9\r | |
37 | #define ICMP_CODE_UNREACH_HOST_PROHIB 10\r | |
38 | #define ICMP_CODE_UNREACH_TOSNET 11\r | |
39 | #define ICMP_CODE_UNREACH_TOSHOST 12\r | |
97b38d4e | 40 | \r |
cdfdbb97 | 41 | /**\r |
e9b67286 | 42 | Get the IP header length from the struct EFI_IP4_HEADER. HeaderLength is\r |
cdfdbb97 | 43 | Internet header length in 32-bit words, so HeaderLength<<2 is the real\r |
44 | length of IP header.\r | |
d1102dba | 45 | \r |
64a80549 | 46 | @param[out] HdrPtr A pointer to EFI_IP4_HEADER.\r |
d1102dba | 47 | \r |
64a80549 | 48 | @return The IP header length.\r |
cdfdbb97 | 49 | **/\r |
d1050b9d | 50 | #define EFI_IP4_HEADER_LEN(HdrPtr) ((HdrPtr)->HeaderLength << 2)\r |
cdfdbb97 | 51 | \r |
52 | /**\r | |
d1102dba LG |
53 | To types of ICMP error which consist of ICMP header, IP header and original\r |
54 | datagram's data, get length from sum of ICMP header length, IP header length\r | |
cdfdbb97 | 55 | and first 64 bits of datagram's data length.\r |
d1102dba | 56 | \r |
64a80549 | 57 | @param[in] IpHdr A pointer to EFI_IP4_HEADER.\r |
d1102dba | 58 | \r |
64a80549 | 59 | @return The ICMP error length.\r |
cdfdbb97 | 60 | **/\r |
61 | #define ICMP_ERRLEN(IpHdr) \\r | |
62 | (sizeof(IP4_ICMP_HEAD) + EFI_IP4_HEADER_LEN(IpHdr) + 8)\r | |
63 | \r | |
64 | /**\r | |
65 | Get the packet header from NET_BUF.\r | |
d1102dba | 66 | \r |
64a80549 | 67 | @param[out] Buf A pointer to NET_BUF.\r |
68 | @param[in] Type Header type.\r | |
d1102dba | 69 | \r |
64a80549 | 70 | @return The pointer to packet header.\r |
cdfdbb97 | 71 | **/\r |
72 | #define NET_PROTO_HDR(Buf, Type) ((Type *) ((Buf)->BlockOp[0].Head))\r | |
73 | \r | |
fb115c61 | 74 | extern EFI_IP4_CONFIG_DATA mIp4IoDefaultIpConfigData;\r |
75 | extern EFI_IP6_CONFIG_DATA mIp6IoDefaultIpConfigData;\r | |
76 | \r | |
e29a2e7e | 77 | ///\r |
78 | /// This error will be delivered to the\r | |
79 | /// listening transportation layer protocol\r | |
80 | /// that consumes IpIO.\r | |
81 | ///\r | |
b45b45b2 | 82 | \r |
d1050b9d MK |
83 | #define ICMP_ERR_UNREACH_NET 0\r |
84 | #define ICMP_ERR_UNREACH_HOST 1\r | |
85 | #define ICMP_ERR_UNREACH_PROTOCOL 2\r | |
86 | #define ICMP_ERR_UNREACH_PORT 3\r | |
87 | #define ICMP_ERR_MSGSIZE 4\r | |
88 | #define ICMP_ERR_UNREACH_SRCFAIL 5\r | |
89 | #define ICMP_ERR_TIMXCEED_INTRANS 6\r | |
90 | #define ICMP_ERR_TIMXCEED_REASS 7\r | |
91 | #define ICMP_ERR_QUENCH 8\r | |
92 | #define ICMP_ERR_PARAMPROB 9\r | |
93 | \r | |
94 | #define ICMP6_ERR_UNREACH_NET 0\r | |
95 | #define ICMP6_ERR_UNREACH_HOST 1\r | |
96 | #define ICMP6_ERR_UNREACH_PROTOCOL 2\r | |
97 | #define ICMP6_ERR_UNREACH_PORT 3\r | |
98 | #define ICMP6_ERR_PACKAGE_TOOBIG 4\r | |
99 | #define ICMP6_ERR_TIMXCEED_HOPLIMIT 5\r | |
100 | #define ICMP6_ERR_TIMXCEED_REASS 6\r | |
101 | #define ICMP6_ERR_PARAMPROB_HEADER 7\r | |
102 | #define ICMP6_ERR_PARAMPROB_NEXHEADER 8\r | |
103 | #define ICMP6_ERR_PARAMPROB_IPV6OPTION 9\r | |
fb115c61 | 104 | \r |
e29a2e7e | 105 | ///\r |
e9b67286 | 106 | /// The helper struct for IpIoGetIcmpErrStatus(). It is for internal use only.\r |
e29a2e7e | 107 | ///\r |
cdfdbb97 | 108 | typedef struct {\r |
d1050b9d MK |
109 | BOOLEAN IsHard;\r |
110 | BOOLEAN Notify;\r | |
97b38d4e | 111 | } ICMP_ERROR_INFO;\r |
112 | \r | |
fb115c61 | 113 | typedef union {\r |
d1050b9d MK |
114 | EFI_IP4_COMPLETION_TOKEN Ip4Token;\r |
115 | EFI_IP6_COMPLETION_TOKEN Ip6Token;\r | |
fb115c61 | 116 | } IP_IO_IP_COMPLETION_TOKEN;\r |
117 | \r | |
118 | typedef union {\r | |
d1050b9d MK |
119 | EFI_IP4_TRANSMIT_DATA Ip4TxData;\r |
120 | EFI_IP6_TRANSMIT_DATA Ip6TxData;\r | |
fb115c61 | 121 | } IP_IO_IP_TX_DATA;\r |
122 | \r | |
123 | typedef union {\r | |
d1050b9d MK |
124 | EFI_IP4_RECEIVE_DATA Ip4RxData;\r |
125 | EFI_IP6_RECEIVE_DATA Ip6RxData;\r | |
fb115c61 | 126 | } IP_IO_IP_RX_DATA;\r |
127 | \r | |
128 | typedef union {\r | |
d1050b9d MK |
129 | EFI_IP4_OVERRIDE_DATA Ip4OverrideData;\r |
130 | EFI_IP6_OVERRIDE_DATA Ip6OverrideData;\r | |
fb115c61 | 131 | } IP_IO_OVERRIDE;\r |
132 | \r | |
133 | typedef union {\r | |
d1050b9d MK |
134 | EFI_IP4_CONFIG_DATA Ip4CfgData;\r |
135 | EFI_IP6_CONFIG_DATA Ip6CfgData;\r | |
fb115c61 | 136 | } IP_IO_IP_CONFIG_DATA;\r |
137 | \r | |
b45b45b2 | 138 | typedef union {\r |
d1050b9d MK |
139 | EFI_IP4_HEADER *Ip4Hdr;\r |
140 | EFI_IP6_HEADER *Ip6Hdr;\r | |
b45b45b2 | 141 | } IP_IO_IP_HEADER;\r |
142 | \r | |
143 | typedef union {\r | |
d1050b9d MK |
144 | IP4_ADDR SubnetMask;\r |
145 | UINT8 PrefixLength;\r | |
b45b45b2 | 146 | } IP_IO_IP_MASK;\r |
147 | \r | |
2a2e33b2 | 148 | typedef union {\r |
d1050b9d MK |
149 | EFI_IP4_PROTOCOL *Ip4;\r |
150 | EFI_IP6_PROTOCOL *Ip6;\r | |
2a2e33b2 | 151 | } IP_IO_IP_PROTOCOL;\r |
152 | \r | |
e29a2e7e | 153 | ///\r |
154 | /// The IP session for an IP receive packet.\r | |
155 | ///\r | |
97b38d4e | 156 | typedef struct _EFI_NET_SESSION_DATA {\r |
d1050b9d MK |
157 | EFI_IP_ADDRESS Source; ///< Source IP of the received packet.\r |
158 | EFI_IP_ADDRESS Dest; ///< Destination IP of the received packet.\r | |
159 | IP_IO_IP_HEADER IpHdr; ///< IP header of the received packet.\r | |
160 | UINT32 IpHdrLen; ///< IP header length of the received packet.\r | |
d1102dba | 161 | ///< For IPv6, it includes the IP6 header\r |
a09ee46d | 162 | ///< length and extension header length. For\r |
163 | ///< IPv4, it includes the IP4 header length\r | |
164 | ///< and options length.\r | |
d1050b9d | 165 | UINT8 IpVersion; ///< The IP version of the received packet.\r |
97b38d4e | 166 | } EFI_NET_SESSION_DATA;\r |
167 | \r | |
e29a2e7e | 168 | /**\r |
169 | The prototype is called back when an IP packet is received.\r | |
d1102dba | 170 | \r |
64a80549 | 171 | @param[in] Status The result of the receive request.\r |
172 | @param[in] IcmpErr Valid when Status is EFI_ICMP_ERROR.\r | |
173 | @param[in] NetSession The IP session for the received packet.\r | |
174 | @param[in] Pkt The packet received.\r | |
e9b67286 | 175 | @param[in] Context The data provided by the user for the received packet when\r |
cdfdbb97 | 176 | the callback is registered in IP_IO_OPEN_DATA::RcvdContext.\r |
d1102dba | 177 | \r |
e29a2e7e | 178 | **/\r |
97b38d4e | 179 | typedef\r |
180 | VOID\r | |
d1050b9d | 181 | (EFIAPI *PKT_RCVD_NOTIFY)(\r |
d1102dba | 182 | IN EFI_STATUS Status,\r |
b45b45b2 | 183 | IN UINT8 IcmpErr,\r |
e29a2e7e | 184 | IN EFI_NET_SESSION_DATA *NetSession,\r |
185 | IN NET_BUF *Pkt,\r | |
186 | IN VOID *Context\r | |
97b38d4e | 187 | );\r |
188 | \r | |
e29a2e7e | 189 | /**\r |
190 | The prototype is called back when an IP packet is sent.\r | |
d1102dba | 191 | \r |
64a80549 | 192 | @param[in] Status Result of the IP packet being sent.\r |
cdfdbb97 | 193 | @param[in] Context The data provided by user for the received packet when\r |
194 | the callback is registered in IP_IO_OPEN_DATA::SndContext.\r | |
d1102dba | 195 | @param[in] Sender A Union type to specify a pointer of EFI_IP4_PROTOCOL\r |
2a2e33b2 | 196 | or EFI_IP6_PROTOCOL.\r |
64a80549 | 197 | @param[in] NotifyData The Context data specified when calling IpIoSend()\r |
d1102dba | 198 | \r |
e29a2e7e | 199 | **/\r |
97b38d4e | 200 | typedef\r |
201 | VOID\r | |
d1050b9d | 202 | (EFIAPI *PKT_SENT_NOTIFY)(\r |
2a2e33b2 | 203 | IN EFI_STATUS Status,\r |
204 | IN VOID *Context,\r | |
205 | IN IP_IO_IP_PROTOCOL Sender,\r | |
206 | IN VOID *NotifyData\r | |
97b38d4e | 207 | );\r |
208 | \r | |
e29a2e7e | 209 | ///\r |
fb115c61 | 210 | /// This data structure wraps Ip4/Ip6 instances. The IpIo Library uses it for all\r |
211 | /// Ip4/Ip6 operations.\r | |
e29a2e7e | 212 | ///\r |
97b38d4e | 213 | typedef struct _IP_IO {\r |
e29a2e7e | 214 | ///\r |
215 | /// The node used to link this IpIo to the active IpIo list.\r | |
216 | ///\r | |
d1050b9d | 217 | LIST_ENTRY Entry;\r |
97b38d4e | 218 | \r |
e29a2e7e | 219 | ///\r |
220 | /// The list used to maintain the IP instance for different sending purpose.\r | |
221 | ///\r | |
d1050b9d | 222 | LIST_ENTRY IpList;\r |
d1102dba | 223 | \r |
d1050b9d MK |
224 | EFI_HANDLE Controller;\r |
225 | EFI_HANDLE Image;\r | |
226 | EFI_HANDLE ChildHandle;\r | |
e29a2e7e | 227 | //\r |
228 | // The IP instance consumed by this IP_IO\r | |
229 | //\r | |
d1050b9d MK |
230 | IP_IO_IP_PROTOCOL Ip;\r |
231 | BOOLEAN IsConfigured;\r | |
97b38d4e | 232 | \r |
e29a2e7e | 233 | ///\r |
64a80549 | 234 | /// Some ip configuration data can be changed.\r |
e29a2e7e | 235 | ///\r |
d1050b9d | 236 | UINT8 Protocol;\r |
97b38d4e | 237 | \r |
e29a2e7e | 238 | ///\r |
64a80549 | 239 | /// Token and event used to get data from IP.\r |
e29a2e7e | 240 | ///\r |
d1050b9d | 241 | IP_IO_IP_COMPLETION_TOKEN RcvToken;\r |
97b38d4e | 242 | \r |
e29a2e7e | 243 | ///\r |
64a80549 | 244 | /// List entry used to link the token passed to IP_IO.\r |
e29a2e7e | 245 | ///\r |
d1050b9d | 246 | LIST_ENTRY PendingSndList;\r |
97b38d4e | 247 | \r |
248 | //\r | |
249 | // User interface used to get notify from IP_IO\r | |
250 | //\r | |
d1050b9d MK |
251 | VOID *RcvdContext; ///< See IP_IO_OPEN_DATA::RcvdContext.\r |
252 | VOID *SndContext; ///< See IP_IO_OPEN_DATA::SndContext.\r | |
253 | PKT_RCVD_NOTIFY PktRcvdNotify; ///< See IP_IO_OPEN_DATA::PktRcvdNotify.\r | |
254 | PKT_SENT_NOTIFY PktSentNotify; ///< See IP_IO_OPEN_DATA::PktSentNotify.\r | |
255 | UINT8 IpVersion;\r | |
256 | IP4_ADDR StationIp;\r | |
257 | IP4_ADDR SubnetMask;\r | |
97b38d4e | 258 | } IP_IO;\r |
259 | \r | |
e29a2e7e | 260 | ///\r |
e9b67286 | 261 | /// The struct is for the user to pass IP configuration and callbacks to IP_IO.\r |
e29a2e7e | 262 | /// It is used by IpIoOpen().\r |
263 | ///\r | |
97b38d4e | 264 | typedef struct _IP_IO_OPEN_DATA {\r |
d1050b9d MK |
265 | IP_IO_IP_CONFIG_DATA IpConfigData; ///< Configuration of the IP instance.\r |
266 | VOID *RcvdContext; ///< Context data used by receive callback.\r | |
267 | VOID *SndContext; ///< Context data used by send callback.\r | |
268 | PKT_RCVD_NOTIFY PktRcvdNotify; ///< Receive callback.\r | |
269 | PKT_SENT_NOTIFY PktSentNotify; ///< Send callback.\r | |
97b38d4e | 270 | } IP_IO_OPEN_DATA;\r |
271 | \r | |
e29a2e7e | 272 | ///\r |
273 | /// Internal struct book-keeping send request of IP_IO.\r | |
274 | ///\r | |
275 | /// An IP_IO_SEND_ENTRY will be created each time a send request is issued to\r | |
276 | /// IP_IO via IpIoSend().\r | |
277 | ///\r | |
97b38d4e | 278 | typedef struct _IP_IO_SEND_ENTRY {\r |
d1050b9d MK |
279 | LIST_ENTRY Entry;\r |
280 | IP_IO *IpIo;\r | |
281 | VOID *Context;\r | |
282 | VOID *NotifyData;\r | |
283 | IP_IO_IP_PROTOCOL Ip;\r | |
284 | NET_BUF *Pkt;\r | |
285 | IP_IO_IP_COMPLETION_TOKEN SndToken;\r | |
97b38d4e | 286 | } IP_IO_SEND_ENTRY;\r |
287 | \r | |
e29a2e7e | 288 | ///\r |
289 | /// The IP_IO_IP_INFO is used in IpIoSend() to override the default IP instance\r | |
290 | /// in IP_IO.\r | |
291 | ///\r | |
97b38d4e | 292 | typedef struct _IP_IO_IP_INFO {\r |
d1050b9d MK |
293 | EFI_IP_ADDRESS Addr;\r |
294 | IP_IO_IP_MASK PreMask;\r | |
295 | LIST_ENTRY Entry;\r | |
296 | EFI_HANDLE ChildHandle;\r | |
297 | IP_IO_IP_PROTOCOL Ip;\r | |
298 | IP_IO_IP_COMPLETION_TOKEN DummyRcvToken;\r | |
299 | INTN RefCnt;\r | |
300 | UINT8 IpVersion;\r | |
97b38d4e | 301 | } IP_IO_IP_INFO;\r |
302 | \r | |
303 | /**\r | |
304 | Create a new IP_IO instance.\r | |
2b208747 WF |
305 | \r |
306 | If IpVersion is not IP_VERSION_4 or IP_VERSION_6, then ASSERT().\r | |
d1102dba | 307 | \r |
fb115c61 | 308 | This function uses IP4/IP6 service binding protocol in Controller to create\r |
309 | an IP4/IP6 child (aka IP4/IP6 instance).\r | |
97b38d4e | 310 | \r |
cdfdbb97 | 311 | @param[in] Image The image handle of the driver or application that\r |
e29a2e7e | 312 | consumes IP_IO.\r |
fb115c61 | 313 | @param[in] Controller The controller handle that has IP4 or IP6 service\r |
314 | binding protocol installed.\r | |
315 | @param[in] IpVersion The version of the IP protocol to use, either\r | |
d1102dba | 316 | IPv4 or IPv6.\r |
97b38d4e | 317 | \r |
64a80549 | 318 | @return The pointer to a newly created IP_IO instance, or NULL if failed.\r |
97b38d4e | 319 | \r |
320 | **/\r | |
321 | IP_IO *\r | |
322 | EFIAPI\r | |
323 | IpIoCreate (\r | |
d1050b9d MK |
324 | IN EFI_HANDLE Image,\r |
325 | IN EFI_HANDLE Controller,\r | |
326 | IN UINT8 IpVersion\r | |
97b38d4e | 327 | );\r |
328 | \r | |
329 | /**\r | |
330 | Destroy an IP_IO instance.\r | |
d1102dba | 331 | \r |
e29a2e7e | 332 | This function is paired with IpIoCreate(). The IP_IO will be closed first.\r |
333 | Resource will be freed afterwards. See IpIoClose().\r | |
97b38d4e | 334 | \r |
64a80549 | 335 | @param[in, out] IpIo The pointer to the IP_IO instance that needs to be\r |
e29a2e7e | 336 | destroyed.\r |
97b38d4e | 337 | \r |
64a80549 | 338 | @retval EFI_SUCCESS The IP_IO instance was destroyed successfully.\r |
339 | @retval Others An error condition occurred.\r | |
97b38d4e | 340 | \r |
341 | **/\r | |
342 | EFI_STATUS\r | |
343 | EFIAPI\r | |
344 | IpIoDestroy (\r | |
d1050b9d | 345 | IN OUT IP_IO *IpIo\r |
97b38d4e | 346 | );\r |
347 | \r | |
348 | /**\r | |
349 | Stop an IP_IO instance.\r | |
2b208747 WF |
350 | \r |
351 | If Ip version is not IP_VERSION_4 or IP_VERSION_6, then ASSERT().\r | |
d1102dba | 352 | \r |
e9b67286 | 353 | This function is paired with IpIoOpen(). The IP_IO will be unconfigured, and all\r |
354 | pending send/receive tokens will be canceled.\r | |
97b38d4e | 355 | \r |
64a80549 | 356 | @param[in, out] IpIo The pointer to the IP_IO instance that needs to stop.\r |
97b38d4e | 357 | \r |
6ccfeec2 FS |
358 | @retval EFI_SUCCESS The IP_IO instance stopped successfully.\r |
359 | @retval EFI_INVALID_PARAMETER Invalid input parameter.\r | |
360 | @retval Others Anrror condition occurred.\r | |
97b38d4e | 361 | \r |
362 | **/\r | |
363 | EFI_STATUS\r | |
364 | EFIAPI\r | |
365 | IpIoStop (\r | |
d1050b9d | 366 | IN OUT IP_IO *IpIo\r |
97b38d4e | 367 | );\r |
368 | \r | |
369 | /**\r | |
370 | Open an IP_IO instance for use.\r | |
2b208747 WF |
371 | \r |
372 | If Ip version is not IP_VERSION_4 or IP_VERSION_6, then ASSERT().\r | |
373 | \r | |
e29a2e7e | 374 | This function is called after IpIoCreate(). It is used for configuring the IP\r |
375 | instance and register the callbacks and their context data for sending and\r | |
376 | receiving IP packets.\r | |
97b38d4e | 377 | \r |
64a80549 | 378 | @param[in, out] IpIo The pointer to an IP_IO instance that needs\r |
cdfdbb97 | 379 | to open.\r |
380 | @param[in] OpenData The configuration data and callbacks for\r | |
381 | the IP_IO instance.\r | |
97b38d4e | 382 | \r |
6ccfeec2 FS |
383 | @retval EFI_SUCCESS The IP_IO instance opened with OpenData\r |
384 | successfully.\r | |
d1102dba | 385 | @retval EFI_ACCESS_DENIED The IP_IO instance is configured, avoid to\r |
6ccfeec2 FS |
386 | reopen it.\r |
387 | @retval EFI_UNSUPPORTED IPv4 RawData mode is no supported.\r | |
388 | @retval EFI_INVALID_PARAMETER Invalid input parameter.\r | |
389 | @retval Others Error condition occurred.\r | |
97b38d4e | 390 | \r |
391 | **/\r | |
392 | EFI_STATUS\r | |
e29a2e7e | 393 | EFIAPI\r |
97b38d4e | 394 | IpIoOpen (\r |
d1050b9d MK |
395 | IN OUT IP_IO *IpIo,\r |
396 | IN IP_IO_OPEN_DATA *OpenData\r | |
97b38d4e | 397 | );\r |
398 | \r | |
399 | /**\r | |
400 | Send out an IP packet.\r | |
d1102dba | 401 | \r |
2b208747 | 402 | This function is called after IpIoOpen(). The data to be sent is wrapped in\r |
8569a87e | 403 | Pkt. The IP instance wrapped in IpIo is used for sending by default but can be\r |
6deb4baa | 404 | overridden by Sender. Other sending configs, like source address and gateway\r |
8569a87e | 405 | address etc., are specified in OverrideData.\r |
97b38d4e | 406 | \r |
8569a87e | 407 | @param[in, out] IpIo Pointer to an IP_IO instance used for sending IP\r |
cdfdbb97 | 408 | packet.\r |
8569a87e FS |
409 | @param[in, out] Pkt Pointer to the IP packet to be sent.\r |
410 | @param[in] Sender The IP protocol instance used for sending.\r | |
411 | @param[in] Context Optional context data.\r | |
412 | @param[in] NotifyData Optional notify data.\r | |
cdfdbb97 | 413 | @param[in] Dest The destination IP address to send this packet to.\r |
8569a87e | 414 | This parameter is optional when using IPv6.\r |
cdfdbb97 | 415 | @param[in] OverrideData The data to override some configuration of the IP\r |
416 | instance used for sending.\r | |
97b38d4e | 417 | \r |
8569a87e FS |
418 | @retval EFI_SUCCESS The operation is completed successfully.\r |
419 | @retval EFI_INVALID_PARAMETER The input parameter is not correct.\r | |
cdfdbb97 | 420 | @retval EFI_NOT_STARTED The IpIo is not configured.\r |
8569a87e | 421 | @retval EFI_OUT_OF_RESOURCES Failed due to resource limit.\r |
6dbfed92 | 422 | @retval Others Error condition occurred.\r |
97b38d4e | 423 | \r |
424 | **/\r | |
425 | EFI_STATUS\r | |
426 | EFIAPI\r | |
427 | IpIoSend (\r | |
d1050b9d MK |
428 | IN OUT IP_IO *IpIo,\r |
429 | IN OUT NET_BUF *Pkt,\r | |
430 | IN IP_IO_IP_INFO *Sender OPTIONAL,\r | |
431 | IN VOID *Context OPTIONAL,\r | |
432 | IN VOID *NotifyData OPTIONAL,\r | |
433 | IN EFI_IP_ADDRESS *Dest OPTIONAL,\r | |
434 | IN IP_IO_OVERRIDE *OverrideData OPTIONAL\r | |
97b38d4e | 435 | );\r |
436 | \r | |
437 | /**\r | |
64a80549 | 438 | Cancel the IP transmit token that wraps this Packet.\r |
97b38d4e | 439 | \r |
2b208747 WF |
440 | If IpIo is NULL, then ASSERT().\r |
441 | If Packet is NULL, then ASSERT().\r | |
442 | \r | |
64a80549 | 443 | @param[in] IpIo The pointer to the IP_IO instance.\r |
444 | @param[in] Packet The pointer to the packet of NET_BUF to cancel.\r | |
97b38d4e | 445 | \r |
446 | **/\r | |
447 | VOID\r | |
448 | EFIAPI\r | |
449 | IpIoCancelTxToken (\r | |
450 | IN IP_IO *IpIo,\r | |
451 | IN VOID *Packet\r | |
452 | );\r | |
453 | \r | |
454 | /**\r | |
455 | Add a new IP instance for sending data.\r | |
2b208747 WF |
456 | \r |
457 | If IpIo is NULL, then ASSERT().\r | |
458 | If Ip version is not IP_VERSION_4 or IP_VERSION_6, then ASSERT().\r | |
d1102dba | 459 | \r |
e29a2e7e | 460 | The function is used to add the IP_IO to the IP_IO sending list. The caller\r |
461 | can later use IpIoFindSender() to get the IP_IO and call IpIoSend() to send\r | |
462 | data.\r | |
97b38d4e | 463 | \r |
64a80549 | 464 | @param[in, out] IpIo The pointer to an IP_IO instance to add a new IP\r |
e9b67286 | 465 | instance for sending purposes.\r |
97b38d4e | 466 | \r |
64a80549 | 467 | @return The pointer to the created IP_IO_IP_INFO structure; NULL if failed.\r |
97b38d4e | 468 | \r |
469 | **/\r | |
470 | IP_IO_IP_INFO *\r | |
471 | EFIAPI\r | |
472 | IpIoAddIp (\r | |
cdfdbb97 | 473 | IN OUT IP_IO *IpIo\r |
97b38d4e | 474 | );\r |
475 | \r | |
476 | /**\r | |
fb115c61 | 477 | Configure the IP instance of this IpInfo and start the receiving if IpConfigData\r |
97b38d4e | 478 | is not NULL.\r |
479 | \r | |
2b208747 WF |
480 | If Ip version is not IP_VERSION_4 or IP_VERSION_6, then ASSERT().\r |
481 | \r | |
64a80549 | 482 | @param[in, out] IpInfo The pointer to the IP_IO_IP_INFO instance.\r |
d1102dba | 483 | @param[in, out] IpConfigData The IP4 or IP6 configure data used to configure\r |
fb115c61 | 484 | the IP instance. If NULL, the IP instance is reset.\r |
485 | If UseDefaultAddress is set to TRUE, and the configure\r | |
cdfdbb97 | 486 | operation succeeds, the default address information\r |
fb115c61 | 487 | is written back in this IpConfigData.\r |
97b38d4e | 488 | \r |
64a80549 | 489 | @retval EFI_SUCCESS The IP instance of this IpInfo was configured successfully,\r |
e9b67286 | 490 | or there is no need to reconfigure it.\r |
64a80549 | 491 | @retval Others The configuration failed.\r |
97b38d4e | 492 | \r |
493 | **/\r | |
494 | EFI_STATUS\r | |
495 | EFIAPI\r | |
496 | IpIoConfigIp (\r | |
d1050b9d MK |
497 | IN OUT IP_IO_IP_INFO *IpInfo,\r |
498 | IN OUT VOID *IpConfigData OPTIONAL\r | |
97b38d4e | 499 | );\r |
500 | \r | |
501 | /**\r | |
502 | Destroy an IP instance maintained in IpIo->IpList for\r | |
503 | sending purpose.\r | |
2b208747 | 504 | \r |
d1102dba LG |
505 | If Ip version is not IP_VERSION_4 or IP_VERSION_6, then ASSERT().\r |
506 | \r | |
e29a2e7e | 507 | This function pairs with IpIoAddIp(). The IpInfo is previously created by\r |
508 | IpIoAddIp(). The IP_IO_IP_INFO::RefCnt is decremented and the IP instance\r | |
6deb4baa | 509 | will be destroyed if the RefCnt is zero.\r |
97b38d4e | 510 | \r |
64a80549 | 511 | @param[in] IpIo The pointer to the IP_IO instance.\r |
512 | @param[in] IpInfo The pointer to the IpInfo to be removed.\r | |
97b38d4e | 513 | \r |
97b38d4e | 514 | **/\r |
515 | VOID\r | |
516 | EFIAPI\r | |
517 | IpIoRemoveIp (\r | |
d1050b9d MK |
518 | IN IP_IO *IpIo,\r |
519 | IN IP_IO_IP_INFO *IpInfo\r | |
97b38d4e | 520 | );\r |
521 | \r | |
522 | /**\r | |
523 | Find the first IP protocol maintained in IpIo whose local\r | |
e9b67286 | 524 | address is the same as Src.\r |
d1102dba | 525 | \r |
e29a2e7e | 526 | This function is called when the caller needs the IpIo to send data to the\r |
527 | specified Src. The IpIo was added previously by IpIoAddIp().\r | |
97b38d4e | 528 | \r |
64a80549 | 529 | @param[in, out] IpIo The pointer to the pointer of the IP_IO instance.\r |
fb115c61 | 530 | @param[in] IpVersion The version of the IP protocol to use, either\r |
531 | IPv4 or IPv6.\r | |
cdfdbb97 | 532 | @param[in] Src The local IP address.\r |
97b38d4e | 533 | \r |
64a80549 | 534 | @return The pointer to the IP protocol can be used for sending purpose and its local\r |
6ccfeec2 | 535 | address is the same with Src. NULL if failed.\r |
97b38d4e | 536 | \r |
537 | **/\r | |
538 | IP_IO_IP_INFO *\r | |
539 | EFIAPI\r | |
540 | IpIoFindSender (\r | |
fb115c61 | 541 | IN OUT IP_IO **IpIo,\r |
b45b45b2 | 542 | IN UINT8 IpVersion,\r |
fb115c61 | 543 | IN EFI_IP_ADDRESS *Src\r |
97b38d4e | 544 | );\r |
545 | \r | |
546 | /**\r | |
e29a2e7e | 547 | Get the ICMP error map information.\r |
d1102dba | 548 | \r |
e29a2e7e | 549 | The ErrorStatus will be returned. The IsHard and Notify are optional. If they\r |
550 | are not NULL, this routine will fill them.\r | |
97b38d4e | 551 | \r |
3a1ab4bc | 552 | @param[in] IcmpError IcmpError Type.\r |
fb115c61 | 553 | @param[in] IpVersion The version of the IP protocol to use,\r |
d1102dba | 554 | either IPv4 or IPv6.\r |
3b1464d5 | 555 | @param[out] IsHard If TRUE, indicates that it is a hard error.\r |
556 | @param[out] Notify If TRUE, SockError needs to be notified.\r | |
97b38d4e | 557 | \r |
6dbfed92 | 558 | @retval EFI_UNSUPPORTED Unrecognizable ICMP error code\r |
64a80549 | 559 | @return The ICMP Error Status, such as EFI_NETWORK_UNREACHABLE.\r |
97b38d4e | 560 | \r |
561 | **/\r | |
562 | EFI_STATUS\r | |
563 | EFIAPI\r | |
564 | IpIoGetIcmpErrStatus (\r | |
d1050b9d MK |
565 | IN UINT8 IcmpError,\r |
566 | IN UINT8 IpVersion,\r | |
567 | OUT BOOLEAN *IsHard OPTIONAL,\r | |
568 | OUT BOOLEAN *Notify OPTIONAL\r | |
97b38d4e | 569 | );\r |
570 | \r | |
fb115c61 | 571 | /**\r |
572 | Refresh the remote peer's Neighbor Cache entries.\r | |
573 | \r | |
574 | This function is called when the caller needs the IpIo to refresh the existing\r | |
d1102dba LG |
575 | IPv6 neighbor cache entries since the neighbor is considered reachable by the\r |
576 | node has recently received a confirmation that packets sent recently to the\r | |
577 | neighbor were received by its IP layer.\r | |
fb115c61 | 578 | \r |
64a80549 | 579 | @param[in] IpIo The pointer to an IP_IO instance\r |
fb115c61 | 580 | @param[in] Neighbor The IP address of the neighbor\r |
64a80549 | 581 | @param[in] Timeout The time in 100-ns units that this entry will\r |
d1102dba LG |
582 | remain in the neighbor cache. A value of\r |
583 | zero means that the entry is permanent.\r | |
584 | A value of non-zero means that the entry is\r | |
fb115c61 | 585 | dynamic and will be deleted after Timeout.\r |
586 | \r | |
64a80549 | 587 | @retval EFI_SUCCESS The operation completed successfully.\r |
fb115c61 | 588 | @retval EFI_NOT_STARTED The IpIo is not configured.\r |
64a80549 | 589 | @retval EFI_INVALID_PARAMETER The Neighbor Address is invalid.\r |
d1102dba LG |
590 | @retval EFI_NOT_FOUND The neighbor cache entry is not in the\r |
591 | neighbor table.\r | |
6dbfed92 | 592 | @retval EFI_UNSUPPORTED IP version is IPv4, which doesn't support neighbor cache refresh.\r |
64a80549 | 593 | @retval EFI_OUT_OF_RESOURCES Failed due to resource limitations.\r |
fb115c61 | 594 | \r |
595 | **/\r | |
596 | EFI_STATUS\r | |
2b208747 | 597 | EFIAPI\r |
fb115c61 | 598 | IpIoRefreshNeighbor (\r |
599 | IN IP_IO *IpIo,\r | |
600 | IN EFI_IP_ADDRESS *Neighbor,\r | |
d1102dba | 601 | IN UINT32 Timeout\r |
fb115c61 | 602 | );\r |
603 | \r | |
97b38d4e | 604 | #endif\r |