3 Copyright (c) 2005 - 2009, Intel Corporation.<BR>
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.
14 #ifndef __EFI_IP4_INPUT_H__
15 #define __EFI_IP4_INPUT_H__
17 #define IP4_MIN_HEADLEN 20
18 #define IP4_MAX_HEADLEN 60
20 #define IP4_ASSEMLE_HASH_SIZE 31
21 #define IP4_FRAGMENT_LIFE 120
22 #define IP4_MAX_PACKET_SIZE 65535
25 /// Per packet information for input process. LinkFlag specifies whether
26 /// the packet is received as Link layer unicast, multicast or broadcast.
27 /// The CastType is the IP layer cast type, such as IP multicast or unicast.
28 /// Start, End and Length are staffs used to assemble the packets. Start
29 /// is the sequence number of the first byte of data in the packet. Length
30 /// is the number of bytes of data. End = Start + Length, that is, the
31 /// sequence number of last byte + 1. Each assembled packet has a count down
32 /// life. If it isn't consumed before Life reaches zero, the packet is released.
45 /// Structure used to assemble IP packets.
51 // Identity of one IP4 packet. Each fragment of a packet has
52 // the same (Dst, Src, Id, Protocol).
61 LIST_ENTRY Fragments
; // List of all the fragments of this packet
63 IP4_HEAD
*Head
; // IP head of the first fragment
64 IP4_CLIP_INFO
*Info
; // Per packet info of the first fragment
65 INTN Life
; // Count down life for the packet.
69 /// Each Ip service instance has an assemble table to reassemble
70 /// the packets before delivery to its children. It is organized
74 LIST_ENTRY Bucket
[IP4_ASSEMLE_HASH_SIZE
];
77 #define IP4_GET_CLIP_INFO(Packet) ((IP4_CLIP_INFO *) ((Packet)->ProtoData))
79 #define IP4_ASSEMBLE_HASH(Dst, Src, Id, Proto) \
80 (((Dst) + (Src) + ((Id) << 16) + (Proto)) % IP4_ASSEMLE_HASH_SIZE)
82 #define IP4_RXDATA_WRAP_SIZE(NumFrag) \
83 (sizeof (IP4_RXDATA_WRAP) + sizeof (EFI_IP4_FRAGMENT_DATA) * ((NumFrag) - 1))
86 Initialize an already allocated assemble table. This is generally
87 the assemble table embedded in the IP4 service instance.
89 @param[in, out] Table The assemble table to initialize.
93 Ip4InitAssembleTable (
94 IN OUT IP4_ASSEMBLE_TABLE
*Table
98 Clean up the assemble table: remove all the fragments
101 @param[in] Table The assemble table to clean up
105 Ip4CleanAssembleTable (
106 IN IP4_ASSEMBLE_TABLE
*Table
110 The IP4 input routine. It is called by the IP4_INTERFACE when a
111 IP4 fragment is received from MNP.
113 @param[in] Ip4Instance The IP4 child that request the receive, most like
115 @param[in] Packet The IP4 packet received.
116 @param[in] IoStatus The return status of receive request.
117 @param[in] Flag The link layer flag for the packet received, such
119 @param[in] Context The IP4 service instance that own the MNP.
124 IN IP4_PROTOCOL
*Ip4Instance
,
126 IN EFI_STATUS IoStatus
,
132 Demultiple the packet. the packet delivery is processed in two
133 passes. The first pass will enque a shared copy of the packet
134 to each IP4 child that accepts the packet. The second pass will
135 deliver a non-shared copy of the packet to each IP4 child that
136 has pending receive requests. Data is copied if more than one
137 child wants to consume the packet because each IP child needs
138 its own copy of the packet to make changes.
140 @param[in] IpSb The IP4 service instance that received the packet
141 @param[in] Head The header of the received packet
142 @param[in] Packet The data of the received packet
144 @retval EFI_NOT_FOUND No IP child accepts the packet
145 @retval EFI_SUCCESS The packet is enqueued or delivered to some IP
151 IN IP4_SERVICE
*IpSb
,
157 Enqueue a received packet to all the IP children that share
160 @param[in] IpSb The IP4 service instance that receive the packet
161 @param[in] Head The header of the received packet
162 @param[in] Packet The data of the received packet
163 @param[in] IpIf The interface to enqueue the packet to
165 @return The number of the IP4 children that accepts the packet
169 Ip4InterfaceEnquePacket (
170 IN IP4_SERVICE
*IpSb
,
173 IN IP4_INTERFACE
*IpIf
177 Deliver the received packets to upper layer if there are both received
178 requests and enqueued packets. If the enqueued packet is shared, it will
179 duplicate it to a non-shared packet, release the shared packet, then
180 deliver the non-shared packet up.
182 @param[in] IpInstance The IP child to deliver the packet up.
184 @retval EFI_OUT_OF_RESOURCES Failed to allocate resources to deliver the
186 @retval EFI_SUCCESS All the enqueued packets that can be delivered
191 Ip4InstanceDeliverPacket (
192 IN IP4_PROTOCOL
*IpInstance
196 Timeout the fragment and enqueued packets.
198 @param[in] IpSb The IP4 service instance to timeout
202 Ip4PacketTimerTicking (