2 Ip4 internal functions and type defintions.
4 Copyright (c) 2005 - 2007, Intel Corporation.<BR>
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #ifndef __EFI_IP4_IMPL_H__
16 #define __EFI_IP4_IMPL_H__
20 #include <Protocol/Ip4.h>
21 #include <Protocol/Ip4Config.h>
22 #include <Protocol/Arp.h>
23 #include <Protocol/ManagedNetwork.h>
25 #include <Library/DebugLib.h>
26 #include <Library/UefiRuntimeServicesTableLib.h>
27 #include <Library/UefiDriverEntryPoint.h>
28 #include <Library/UefiBootServicesTableLib.h>
29 #include <Library/BaseLib.h>
30 #include <Library/UefiLib.h>
31 #include <Library/NetLib.h>
32 #include <Library/BaseMemoryLib.h>
33 #include <Library/MemoryAllocationLib.h>
35 #include "Ip4Common.h"
36 #include "Ip4Driver.h"
39 #include "Ip4Option.h"
43 #include "Ip4Output.h"
48 IP4_PROTOCOL_SIGNATURE
= SIGNATURE_32 ('I', 'P', '4', 'P'),
49 IP4_SERVICE_SIGNATURE
= SIGNATURE_32 ('I', 'P', '4', 'S'),
52 // The state of IP4 protocol. It starts from UNCONFIGED. if it is
53 // successfully configured, it goes to CONFIGED. if configure NULL
54 // is called, it becomes UNCONFIGED again. If (partly) destoried, it
57 IP4_STATE_UNCONFIGED
= 0,
62 // The state of IP4 service. It starts from UNSTARTED. It transits
63 // to STARTED if autoconfigure is started. If default address is
64 // configured, it becomes CONFIGED. and if partly destoried, it goes
67 IP4_SERVICE_UNSTARTED
= 0,
71 } IP4_IMPL_ENUM_TYPES
;
74 /// IP4_TXTOKEN_WRAP wraps the upper layer's transmit token.
75 /// The user's data is kept in the Packet. When fragment is
76 /// needed, each fragment of the Packet has a reference to the
77 /// Packet, no data is actually copied. The Packet will be
78 /// released when all the fragments of it have been recycled by
79 /// MNP. Upon then, the IP4_TXTOKEN_WRAP will be released, and
80 /// user's event signalled.
83 IP4_PROTOCOL
*IpInstance
;
84 EFI_IP4_COMPLETION_TOKEN
*Token
;
91 /// IP4_RXDATA_WRAP wraps the data IP4 child delivers to the
92 /// upper layers. The received packet is kept in the Packet.
93 /// The Packet itself may be constructured from some fragments.
94 /// All the fragments of the Packet is organized by a
95 /// IP4_ASSEMBLE_ENTRY structure. If the Packet is recycled by
96 /// the upper layer, the assemble entry and its associated
97 /// fragments will be freed at last.
101 IP4_PROTOCOL
*IpInstance
;
103 EFI_IP4_RECEIVE_DATA RxData
;
107 struct _IP4_PROTOCOL
{
110 EFI_IP4_PROTOCOL Ip4Proto
;
114 IP4_SERVICE
*Service
;
115 LIST_ENTRY Link
; // Link to all the IP protocol from the service
118 // User's transmit/receive tokens, and received/deliverd packets
121 NET_MAP TxTokens
; // map between (User's Token, IP4_TXTOKE_WRAP)
122 LIST_ENTRY Received
; // Received but not delivered packet
123 LIST_ENTRY Delivered
; // Delivered and to be recycled packets
124 EFI_LOCK RecycleLock
;
127 // Instance's address and route tables. There are two route tables.
128 // RouteTable is used by the IP4 driver to route packet. EfiRouteTable
129 // is used to communicate the current route info to the upper layer.
131 IP4_INTERFACE
*Interface
;
132 LIST_ENTRY AddrLink
; // Ip instances with the same IP address.
133 IP4_ROUTE_TABLE
*RouteTable
;
135 EFI_IP4_ROUTE_TABLE
*EfiRouteTable
;
136 UINT32 EfiRouteCount
;
139 // IGMP data for this instance
141 IP4_ADDR
*Groups
; // stored in network byte order
144 EFI_IP4_CONFIG_DATA ConfigData
;
148 struct _IP4_SERVICE
{
150 EFI_SERVICE_BINDING_PROTOCOL ServiceBinding
;
155 // List of all the IP instances and interfaces, and default
156 // interface and route table and caches.
161 LIST_ENTRY Interfaces
;
163 IP4_INTERFACE
*DefaultInterface
;
164 IP4_ROUTE_TABLE
*DefaultRouteTable
;
167 // Ip reassemble utilities, and IGMP data
169 IP4_ASSEMBLE_TABLE Assemble
;
170 IGMP_SERVICE_DATA IgmpCtrl
;
173 // Low level protocol used by this service instance
176 EFI_HANDLE Controller
;
178 EFI_HANDLE MnpChildHandle
;
179 EFI_MANAGED_NETWORK_PROTOCOL
*Mnp
;
181 EFI_MANAGED_NETWORK_CONFIG_DATA MnpConfigData
;
182 EFI_SIMPLE_NETWORK_MODE SnpMode
;
187 // Auto configure staff
189 EFI_IP4_CONFIG_PROTOCOL
*Ip4Config
;
191 EFI_EVENT ReconfigEvent
;
192 EFI_EVENT ActiveEvent
;
195 // The string representation of the current mac address of the
196 // NIC this IP4_SERVICE works on.
201 #define IP4_INSTANCE_FROM_PROTOCOL(Ip4) \
202 CR ((Ip4), IP4_PROTOCOL, Ip4Proto, IP4_PROTOCOL_SIGNATURE)
204 #define IP4_SERVICE_FROM_PROTOCOL(Sb) \
205 CR ((Sb), IP4_SERVICE, ServiceBinding, IP4_SERVICE_SIGNATURE)
207 #define IP4_NO_MAPPING(IpInstance) (!(IpInstance)->Interface->Configured)
209 extern EFI_IP4_PROTOCOL mEfiIp4ProtocolTemplete
;
212 Config the MNP parameter used by IP. The IP driver use one MNP
213 child to transmit/receive frames. By default, it configures MNP
214 to receive unicast/multicast/broadcast. And it will enable/disable
215 the promiscous receive according to whether there is IP child
216 enable that or not. If Force is FALSE, it will iterate through
217 all the IP children to check whether the promiscuous receive
218 setting has been changed. If it hasn't been changed, it won't
219 reconfigure the MNP. If Force is TRUE, the MNP is configured no
220 matter whether that is changed or not.
222 @param[in] IpSb The IP4 service instance that is to be changed.
223 @param[in] Force Force the configuration or not.
225 @retval EFI_SUCCESS The MNP is successfully configured/reconfigured.
226 @retval Others Configuration failed.
230 Ip4ServiceConfigMnp (
231 IN IP4_SERVICE
*IpSb
,
236 Intiialize the IP4_PROTOCOL structure to the unconfigured states.
238 @param IpSb The IP4 service instance.
239 @param IpInstance The IP4 child instance.
244 IN IP4_SERVICE
*IpSb
,
245 IN OUT IP4_PROTOCOL
*IpInstance
249 Clean up the IP4 child, release all the resources used by it.
251 @param[in] IpInstance The IP4 child to clean up.
253 @retval EFI_SUCCESS The IP4 child is cleaned up
254 @retval EFI_DEVICE_ERROR Some resources failed to be released
259 IN IP4_PROTOCOL
*IpInstance
263 Cancel the user's receive/transmit request.
265 @param[in] IpInstance The IP4 child
266 @param[in] Token The token to cancel. If NULL, all token will be
269 @retval EFI_SUCCESS The token is cancelled
270 @retval EFI_NOT_FOUND The token isn't found on either the
271 transmit/receive queue
272 @retval EFI_DEVICE_ERROR Not all token is cancelled when Token is NULL.
277 IN IP4_PROTOCOL
*IpInstance
,
278 IN EFI_IP4_COMPLETION_TOKEN
*Token OPTIONAL
282 Change the IP4 child's multicast setting. The caller
283 should make sure that the parameters is valid.
285 @param[in] IpInstance The IP4 child to change the setting.
286 @param[in] JoinFlag TRUE to join the group, otherwise leave it
287 @param[in] GroupAddress The target group address
289 @retval EFI_ALREADY_STARTED Want to join the group, but already a member of it
290 @retval EFI_OUT_OF_RESOURCES Failed to allocate some resources.
291 @retval EFI_DEVICE_ERROR Failed to set the group configuraton
292 @retval EFI_SUCCESS Successfully updated the group setting.
293 @retval EFI_NOT_FOUND Try to leave the group which it isn't a member.
298 IN IP4_PROTOCOL
*IpInstance
,
300 IN EFI_IPv4_ADDRESS
*GroupAddress OPTIONAL
304 The heart beat timer of IP4 service instance. It times out
305 all of its IP4 children's received-but-not-delivered and
306 transmitted-but-not-recycle packets, and provides time input
307 for its IGMP protocol.
309 @param[in] Event The IP4 service instance's heart beat timer.
310 @param[in] Context The IP4 service instance.
321 Decrease the life of the transmitted packets. If it is
322 decreased to zero, cancel the packet. This function is
323 called by Ip4PacketTimerTicking which time out both the
324 received-but-not-delivered and transmitted-but-not-recycle
327 @param[in] Map The IP4 child's transmit map.
328 @param[in] Item Current transmitted packet
329 @param[in] Context Not used.
331 @retval EFI_SUCCESS Always returns EFI_SUCCESS
335 Ip4SentPacketTicking (
337 IN NET_MAP_ITEM
*Item
,