3 Copyright (c) 2005 - 2006, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 Ip4 internal functions and type defintions.
23 #ifndef __EFI_IP4_IMPL_H__
24 #define __EFI_IP4_IMPL_H__
28 #include <Protocol/IP4.h>
29 #include <Protocol/IP4Config.h>
30 #include <Protocol/Arp.h>
31 #include <Protocol/ManagedNetwork.h>
33 #include <Library/DebugLib.h>
34 #include <Library/UefiRuntimeServicesTableLib.h>
35 #include <Library/UefiDriverEntryPoint.h>
36 #include <Library/UefiBootServicesTableLib.h>
37 #include <Library/BaseLib.h>
38 #include <Library/UefiLib.h>
39 #include <Library/NetLib.h>
40 #include <Library/BaseMemoryLib.h>
41 #include <Library/MemoryAllocationLib.h>
43 #include "Ip4Common.h"
44 #include "Ip4Driver.h"
47 #include "Ip4Option.h"
51 #include "Ip4Output.h"
54 IP4_PROTOCOL_SIGNATURE
= EFI_SIGNATURE_32 ('I', 'P', '4', 'P'),
55 IP4_SERVICE_SIGNATURE
= EFI_SIGNATURE_32 ('I', 'P', '4', 'S'),
58 // The state of IP4 protocol. It starts from UNCONFIGED. if it is
59 // successfully configured, it goes to CONFIGED. if configure NULL
60 // is called, it becomes UNCONFIGED again. If (partly) destoried, it
63 IP4_STATE_UNCONFIGED
= 0,
68 // The state of IP4 service. It starts from UNSTARTED. It transits
69 // to STARTED if autoconfigure is started. If default address is
70 // configured, it becomes CONFIGED. and if partly destoried, it goes
73 IP4_SERVICE_UNSTARTED
= 0,
80 // IP4_TXTOKEN_WRAP wraps the upper layer's transmit token.
81 // The user's data is kept in the Packet. When fragment is
82 // needed, each fragment of the Packet has a reference to the
83 // Packet, no data is actually copied. The Packet will be
84 // released when all the fragments of it have been recycled by
85 // MNP. Upon then, the IP4_TXTOKEN_WRAP will be released, and
86 // user's event signalled.
89 IP4_PROTOCOL
*IpInstance
;
90 EFI_IP4_COMPLETION_TOKEN
*Token
;
97 // IP4_RXDATA_WRAP wraps the data IP4 child delivers to the
98 // upper layers. The received packet is kept in the Packet.
99 // The Packet itself may be constructured from some fragments.
100 // All the fragments of the Packet is organized by a
101 // IP4_ASSEMBLE_ENTRY structure. If the Packet is recycled by
102 // the upper layer, the assemble entry and its associated
103 // fragments will be freed at last.
107 IP4_PROTOCOL
*IpInstance
;
109 EFI_IP4_RECEIVE_DATA RxData
;
112 struct _IP4_PROTOCOL
{
115 EFI_IP4_PROTOCOL Ip4Proto
;
119 IP4_SERVICE
*Service
;
120 NET_LIST_ENTRY Link
; // Link to all the IP protocol from the service
123 // User's transmit/receive tokens, and received/deliverd packets
126 NET_MAP TxTokens
; // map between (User's Token, IP4_TXTOKE_WRAP)
127 NET_LIST_ENTRY Received
; // Received but not delivered packet
128 NET_LIST_ENTRY Delivered
; // Delivered and to be recycled packets
129 EFI_LOCK RecycleLock
;
132 // Instance's address and route tables. There are two route tables.
133 // RouteTable is used by the IP4 driver to route packet. EfiRouteTable
134 // is used to communicate the current route info to the upper layer.
136 IP4_INTERFACE
*Interface
;
137 NET_LIST_ENTRY AddrLink
; // Ip instances with the same IP address.
138 IP4_ROUTE_TABLE
*RouteTable
;
140 EFI_IP4_ROUTE_TABLE
*EfiRouteTable
;
141 UINT32 EfiRouteCount
;
144 // IGMP data for this instance
146 IP4_ADDR
*Groups
; // stored in network byte order
149 EFI_IP4_CONFIG_DATA ConfigData
;
153 struct _IP4_SERVICE
{
155 EFI_SERVICE_BINDING_PROTOCOL ServiceBinding
;
160 // List of all the IP instances and interfaces, and default
161 // interface and route table and caches.
164 NET_LIST_ENTRY Children
;
166 NET_LIST_ENTRY Interfaces
;
168 IP4_INTERFACE
*DefaultInterface
;
169 IP4_ROUTE_TABLE
*DefaultRouteTable
;
172 // Ip reassemble utilities, and IGMP data
174 IP4_ASSEMBLE_TABLE Assemble
;
175 IGMP_SERVICE_DATA IgmpCtrl
;
178 // Low level protocol used by this service instance
181 EFI_HANDLE Controller
;
183 EFI_HANDLE MnpChildHandle
;
184 EFI_MANAGED_NETWORK_PROTOCOL
*Mnp
;
186 EFI_MANAGED_NETWORK_CONFIG_DATA MnpConfigData
;
187 EFI_SIMPLE_NETWORK_MODE SnpMode
;
192 // Auto configure staff
194 EFI_IP4_CONFIG_PROTOCOL
*Ip4Config
;
196 EFI_EVENT ReconfigEvent
;
197 EFI_EVENT ActiveEvent
;
200 // The string representation of the current mac address of the
201 // NIC this IP4_SERVICE works on.
206 #define IP4_INSTANCE_FROM_PROTOCOL(Ip4) \
207 CR ((Ip4), IP4_PROTOCOL, Ip4Proto, IP4_PROTOCOL_SIGNATURE)
209 #define IP4_SERVICE_FROM_PROTOCOL(Sb) \
210 CR ((Sb), IP4_SERVICE, ServiceBinding, IP4_SERVICE_SIGNATURE)
212 #define IP4_NO_MAPPING(IpInstance) (!(IpInstance)->Interface->Configured)
214 extern EFI_IP4_PROTOCOL mEfiIp4ProtocolTemplete
;
217 Ip4ServiceConfigMnp (
218 IN IP4_SERVICE
*IpSb
,
224 IN IP4_SERVICE
*IpSb
,
225 IN IP4_PROTOCOL
*IpInstance
230 IN IP4_PROTOCOL
*IpInstance
235 IN IP4_PROTOCOL
*IpInstance
,
236 IN EFI_IP4_COMPLETION_TOKEN
*Token
241 IN IP4_PROTOCOL
*IpInstance
,
243 IN EFI_IPv4_ADDRESS
*GroupAddress
254 Ip4SentPacketTicking (
256 IN NET_MAP_ITEM
*Item
,