2 This library is only intended to be used by UEFI network stack modules.
3 It provides the combined IpIo layer on the EFI IP4 Protocol and EFI IP6 protocol.
5 Copyright (c) 2005 - 2009, Intel Corporation.<BR>
6 All rights reserved. This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 #include <Protocol/Ip4.h>
20 #include <Protocol/Ip6.h>
22 #include <Library/NetLib.h>
25 // type and code define for ICMP protocol error
28 #define ICMP_TYPE_UNREACH 3
29 #define ICMP_TYPE_TIMXCEED 11
30 #define ICMP_TYPE_PARAMPROB 12
31 #define ICMP_TYPE_SOURCEQUENCH 4
33 #define ICMP_CODE_UNREACH_NET 0
34 #define ICMP_CODE_UNREACH_HOST 1
35 #define ICMP_CODE_UNREACH_PROTOCOL 2
36 #define ICMP_CODE_UNREACH_PORT 3
37 #define ICMP_CODE_UNREACH_NEEDFRAG 4
38 #define ICMP_CODE_UNREACH_SRCFAIL 5
39 #define ICMP_CODE_UNREACH_NET_UNKNOWN 6
40 #define ICMP_CODE_UNREACH_HOST_UNKNOWN 7
41 #define ICMP_CODE_UNREACH_ISOLATED 8
42 #define ICMP_CODE_UNREACH_NET_PROHIB 9
43 #define ICMP_CODE_UNREACH_HOST_PROHIB 10
44 #define ICMP_CODE_UNREACH_TOSNET 11
45 #define ICMP_CODE_UNREACH_TOSHOST 12
48 Get the IP header length from the struct EFI_IP4_HEADER. HeaderLength is
49 Internet header length in 32-bit words, so HeaderLength<<2 is the real
52 @param[out] HdrPtr A pointer to EFI_IP4_HEADER
54 @return The IP header length
56 #define EFI_IP4_HEADER_LEN(HdrPtr) ((HdrPtr)->HeaderLength << 2)
59 To types of ICMP error which consist of ICMP header, IP header and original
60 datagram's data, get length from sum of ICMP header length, IP header length
61 and first 64 bits of datagram's data length.
63 @param[in] IpHdr A pointer to EFI_IP4_HEADER
65 @return The ICMP error length
67 #define ICMP_ERRLEN(IpHdr) \
68 (sizeof(IP4_ICMP_HEAD) + EFI_IP4_HEADER_LEN(IpHdr) + 8)
71 Get the packet header from NET_BUF.
73 @param[out] Buf A pointer to NET_BUF
74 @param[in] Type Header type
76 @return The pointer to packet header
78 #define NET_PROTO_HDR(Buf, Type) ((Type *) ((Buf)->BlockOp[0].Head))
81 extern EFI_IP4_CONFIG_DATA mIp4IoDefaultIpConfigData
;
82 extern EFI_IP6_CONFIG_DATA mIp6IoDefaultIpConfigData
;
86 /// This error will be delivered to the
87 /// listening transportation layer protocol
88 /// that consumes IpIO.
91 #define ICMP_ERR_UNREACH_NET 0
92 #define ICMP_ERR_UNREACH_HOST 1
93 #define ICMP_ERR_UNREACH_PROTOCOL 2
94 #define ICMP_ERR_UNREACH_PORT 3
95 #define ICMP_ERR_MSGSIZE 4
96 #define ICMP_ERR_UNREACH_SRCFAIL 5
97 #define ICMP_ERR_TIMXCEED_INTRANS 6
98 #define ICMP_ERR_TIMXCEED_REASS 7
99 #define ICMP_ERR_QUENCH 8
100 #define ICMP_ERR_PARAMPROB 9
102 #define ICMP6_ERR_UNREACH_NET 0
103 #define ICMP6_ERR_UNREACH_HOST 1
104 #define ICMP6_ERR_UNREACH_PROTOCOL 2
105 #define ICMP6_ERR_UNREACH_PORT 3
106 #define ICMP6_ERR_PACKAGE_TOOBIG 4
107 #define ICMP6_ERR_TIMXCEED_HOPLIMIT 5
108 #define ICMP6_ERR_TIMXCEED_REASS 6
109 #define ICMP6_ERR_PARAMPROB_HEADER 7
110 #define ICMP6_ERR_PARAMPROB_NEXHEADER 8
111 #define ICMP6_ERR_PARAMPROB_IPV6OPTION 9
114 /// The helper struct for IpIoGetIcmpErrStatus(). It is for internal use only.
122 EFI_IP4_COMPLETION_TOKEN Ip4Token
;
123 EFI_IP6_COMPLETION_TOKEN Ip6Token
;
124 } IP_IO_IP_COMPLETION_TOKEN
;
127 EFI_IP4_TRANSMIT_DATA Ip4TxData
;
128 EFI_IP6_TRANSMIT_DATA Ip6TxData
;
132 EFI_IP4_RECEIVE_DATA Ip4RxData
;
133 EFI_IP6_RECEIVE_DATA Ip6RxData
;
137 EFI_IP4_OVERRIDE_DATA Ip4OverrideData
;
138 EFI_IP6_OVERRIDE_DATA Ip6OverrideData
;
142 EFI_IP4_CONFIG_DATA Ip4CfgData
;
143 EFI_IP6_CONFIG_DATA Ip6CfgData
;
144 } IP_IO_IP_CONFIG_DATA
;
147 EFI_IP4_HEADER
*Ip4Hdr
;
148 EFI_IP6_HEADER
*Ip6Hdr
;
157 /// The IP session for an IP receive packet.
159 typedef struct _EFI_NET_SESSION_DATA
{
160 EFI_IP_ADDRESS Source
; ///< Source IP of the received packet
161 EFI_IP_ADDRESS Dest
; ///< Destination IP of the received packet
162 IP_IO_IP_HEADER IpHdr
; ///< IP header of the received packet
163 UINT32 IpHdrLen
; ///< IP header length of the received packet.
164 ///< For IPv6, it includes the IP6 header
165 ///< length and extension header length. For
166 ///< IPv4, it includes the IP4 header length
167 ///< and options length.
168 UINT8 IpVersion
; ///< The IP version of the received packet
169 } EFI_NET_SESSION_DATA
;
172 The prototype is called back when an IP packet is received.
174 @param[in] Status Result of the receive request
175 @param[in] IcmpErr Valid when Status is EFI_ICMP_ERROR
176 @param[in] NetSession The IP session for the received packet
177 @param[in] Pkt Packet received
178 @param[in] Context The data provided by the user for the received packet when
179 the callback is registered in IP_IO_OPEN_DATA::RcvdContext.
185 IN EFI_STATUS Status
,
187 IN EFI_NET_SESSION_DATA
*NetSession
,
193 The prototype is called back when an IP packet is sent.
195 @param[in] Status Result of the sending
196 @param[in] Context The data provided by user for the received packet when
197 the callback is registered in IP_IO_OPEN_DATA::SndContext.
198 @param[in] Sender A pointer to EFI_IP4_PROTOCOL or EFI_IP6_PROTOCOL
199 @param[in] NotifyData Context data specified when calling IpIoSend()
205 IN EFI_STATUS Status
,
212 /// This data structure wraps Ip4/Ip6 instances. The IpIo Library uses it for all
213 /// Ip4/Ip6 operations.
215 typedef struct _IP_IO
{
217 /// The node used to link this IpIo to the active IpIo list.
222 /// The list used to maintain the IP instance for different sending purpose.
226 EFI_HANDLE Controller
;
228 EFI_HANDLE ChildHandle
;
230 // The IP instance consumed by this IP_IO
233 BOOLEAN IsConfigured
;
236 /// Some ip config data can be changed
241 /// Token and event used to get data from IP
243 IP_IO_IP_COMPLETION_TOKEN RcvToken
;
246 /// List entry used to link the token passed to IP_IO
248 LIST_ENTRY PendingSndList
;
251 // User interface used to get notify from IP_IO
253 VOID
*RcvdContext
; ///< See IP_IO_OPEN_DATA::RcvdContext
254 VOID
*SndContext
; ///< See IP_IO_OPEN_DATA::SndContext
255 PKT_RCVD_NOTIFY PktRcvdNotify
; ///< See IP_IO_OPEN_DATA::PktRcvdNotify
256 PKT_SENT_NOTIFY PktSentNotify
; ///< See IP_IO_OPEN_DATA::PktSentNotify
261 /// The struct is for the user to pass IP configuration and callbacks to IP_IO.
262 /// It is used by IpIoOpen().
264 typedef struct _IP_IO_OPEN_DATA
{
265 IP_IO_IP_CONFIG_DATA IpConfigData
; ///< Configuration of the IP instance
266 VOID
*RcvdContext
; ///< Context data used by receive callback
267 VOID
*SndContext
; ///< Context data used by send callback
268 PKT_RCVD_NOTIFY PktRcvdNotify
; ///< Receive callback
269 PKT_SENT_NOTIFY PktSentNotify
; ///< Send callback
273 /// Internal struct book-keeping send request of IP_IO.
275 /// An IP_IO_SEND_ENTRY will be created each time a send request is issued to
276 /// IP_IO via IpIoSend().
278 typedef struct _IP_IO_SEND_ENTRY
{
285 IP_IO_IP_COMPLETION_TOKEN SndToken
;
289 /// The IP_IO_IP_INFO is used in IpIoSend() to override the default IP instance
292 typedef struct _IP_IO_IP_INFO
{
294 IP_IO_IP_MASK PreMask
;
296 EFI_HANDLE ChildHandle
;
298 IP_IO_IP_COMPLETION_TOKEN DummyRcvToken
;
304 Create a new IP_IO instance.
306 This function uses IP4/IP6 service binding protocol in Controller to create
307 an IP4/IP6 child (aka IP4/IP6 instance).
309 @param[in] Image The image handle of the driver or application that
311 @param[in] Controller The controller handle that has IP4 or IP6 service
312 binding protocol installed.
313 @param[in] IpVersion The version of the IP protocol to use, either
316 @return Pointer to a newly created IP_IO instance, or NULL if failed.
323 IN EFI_HANDLE Controller
,
328 Destroy an IP_IO instance.
330 This function is paired with IpIoCreate(). The IP_IO will be closed first.
331 Resource will be freed afterwards. See IpIoClose().
333 @param[in, out] IpIo Pointer to the IP_IO instance that needs to be
336 @retval EFI_SUCCESS The IP_IO instance destroyed successfully.
337 @retval Others Error condition occurred.
347 Stop an IP_IO instance.
349 This function is paired with IpIoOpen(). The IP_IO will be unconfigured, and all
350 pending send/receive tokens will be canceled.
352 @param[in, out] IpIo Pointer to the IP_IO instance that needs to stop.
354 @retval EFI_SUCCESS The IP_IO instance stopped successfully.
355 @retval Others Error condition occurred.
365 Open an IP_IO instance for use.
367 This function is called after IpIoCreate(). It is used for configuring the IP
368 instance and register the callbacks and their context data for sending and
369 receiving IP packets.
371 @param[in, out] IpIo Pointer to an IP_IO instance that needs
373 @param[in] OpenData The configuration data and callbacks for
376 @retval EFI_SUCCESS The IP_IO instance opened with OpenData
378 @retval EFI_ACCESS_DENIED The IP_IO instance is configured, avoid to
380 @retval Others Error condition occurred.
387 IN IP_IO_OPEN_DATA
*OpenData
391 Send out an IP packet.
393 This function is called after IpIoOpen(). The data to be sent are wrapped in
394 Pkt. The IP instance wrapped in IpIo is used for sending by default, but can be
395 overriden by Sender. Other sending configurations, such as source address and gateway
396 address, are specified in OverrideData.
398 @param[in, out] IpIo Pointer to an IP_IO instance used for sending IP
400 @param[in, out] Pkt Pointer to the IP packet to be sent.
401 @param[in] Sender Optional. The IP protocol instance used for sending.
402 @param[in] Context Optional context data.
403 @param[in] NotifyData Optional notify data.
404 @param[in] Dest The destination IP address to send this packet to.
405 @param[in] OverrideData The data to override some configuration of the IP
406 instance used for sending.
408 @retval EFI_SUCCESS The operation is completed successfully.
409 @retval EFI_NOT_STARTED The IpIo is not configured.
410 @retval EFI_OUT_OF_RESOURCES Failed due to resource limit.
418 IN IP_IO_IP_INFO
*Sender OPTIONAL
,
419 IN VOID
*Context OPTIONAL
,
420 IN VOID
*NotifyData OPTIONAL
,
421 IN EFI_IP_ADDRESS
*Dest
,
422 IN IP_IO_OVERRIDE
*OverrideData OPTIONAL
426 Cancel the IP transmit token which wraps this Packet.
428 @param[in] IpIo Pointer to the IP_IO instance.
429 @param[in] Packet Pointer to the packet of NET_BUF to cancel.
440 Add a new IP instance for sending data.
442 The function is used to add the IP_IO to the IP_IO sending list. The caller
443 can later use IpIoFindSender() to get the IP_IO and call IpIoSend() to send
446 @param[in, out] IpIo Pointer to an IP_IO instance to add a new IP
447 instance for sending purposes.
449 @return Pointer to the created IP_IO_IP_INFO structure, NULL if failed.
459 Configure the IP instance of this IpInfo and start the receiving if IpConfigData
462 @param[in, out] IpInfo Pointer to the IP_IO_IP_INFO instance.
463 @param[in, out] IpConfigData The IP4 or IP6 configure data used to configure
464 the IP instance. If NULL, the IP instance is reset.
465 If UseDefaultAddress is set to TRUE, and the configure
466 operation succeeds, the default address information
467 is written back in this IpConfigData.
469 @retval EFI_SUCCESS The IP instance of this IpInfo is configured successfully,
470 or there is no need to reconfigure it.
471 @retval Others Configuration failed.
477 IN OUT IP_IO_IP_INFO
*IpInfo
,
478 IN OUT VOID
*IpConfigData OPTIONAL
482 Destroy an IP instance maintained in IpIo->IpList for
485 This function pairs with IpIoAddIp(). The IpInfo is previously created by
486 IpIoAddIp(). The IP_IO_IP_INFO::RefCnt is decremented and the IP instance
487 will be dstroyed if the RefCnt is zero.
489 @param[in] IpIo Pointer to the IP_IO instance.
490 @param[in] IpInfo Pointer to the IpInfo to be removed.
497 IN IP_IO_IP_INFO
*IpInfo
501 Find the first IP protocol maintained in IpIo whose local
502 address is the same as Src.
504 This function is called when the caller needs the IpIo to send data to the
505 specified Src. The IpIo was added previously by IpIoAddIp().
507 @param[in, out] IpIo Pointer to the pointer of the IP_IO instance.
508 @param[in] IpVersion The version of the IP protocol to use, either
510 @param[in] Src The local IP address.
512 @return Pointer to the IP protocol can be used for sending purpose and its local
513 address is the same with Src.
521 IN EFI_IP_ADDRESS
*Src
525 Get the ICMP error map information.
527 The ErrorStatus will be returned. The IsHard and Notify are optional. If they
528 are not NULL, this routine will fill them.
530 @param[in] IcmpError IcmpError Type.
531 @param[in] IpVersion The version of the IP protocol to use,
534 @param[out] IsHard Whether it is a hard error.
535 @param[out] Notify Whether it need to notify SockError.
537 @return ICMP Error Status, such as EFI_NETWORK_UNREACHABLE.
542 IpIoGetIcmpErrStatus (
545 OUT BOOLEAN
*IsHard OPTIONAL
,
546 OUT BOOLEAN
*Notify OPTIONAL
550 Refresh the remote peer's Neighbor Cache entries.
552 This function is called when the caller needs the IpIo to refresh the existing
553 IPv6 neighbor cache entries since the neighbor is considered reachable by the
554 node has recently received a confirmation that packets sent recently to the
555 neighbor were received by its IP layer.
557 @param[in] IpIo Pointer to an IP_IO instance
558 @param[in] Neighbor The IP address of the neighbor
559 @param[in] Timeout Time in 100-ns units that this entry will
560 remain in the neighbor cache. A value of
561 zero means that the entry is permanent.
562 A value of non-zero means that the entry is
563 dynamic and will be deleted after Timeout.
565 @retval EFI_SUCCESS The operation is completed successfully.
566 @retval EFI_NOT_STARTED The IpIo is not configured.
567 @retval EFI_INVALID_PARAMETER Neighbor Address is invalid.
568 @retval EFI_NOT_FOUND The neighbor cache entry is not in the
570 @retval EFI_OUT_OF_RESOURCES Failed due to resource limit.
574 IpIoRefreshNeighbor (
576 IN EFI_IP_ADDRESS
*Neighbor
,