]>
Commit | Line | Data |
---|---|---|
772db4bb | 1 | /** @file\r |
2 | \r | |
1f6729ff | 3 | Copyright (c) 2005 - 2015, Intel Corporation. All rights reserved.<BR>\r |
e5eed7d3 | 4 | This program and the accompanying materials\r |
772db4bb | 5 | are licensed and made available under the terms and conditions of the BSD License\r |
6 | which accompanies this distribution. The full text of the license may be found at\r | |
7 | http://opensource.org/licenses/bsd-license.php\r | |
8 | \r | |
9 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
10 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
11 | \r | |
772db4bb | 12 | **/\r |
13 | \r | |
14 | #include "Ip4Impl.h"\r | |
15 | \r | |
705f53a9 | 16 | EFI_IPSEC2_PROTOCOL *mIpSec = NULL;\r |
a1503a32 | 17 | \r |
5405e9a6 | 18 | /**\r |
19 | Gets the current operational settings for this instance of the EFI IPv4 Protocol driver.\r | |
e2851998 | 20 | \r |
5405e9a6 | 21 | The GetModeData() function returns the current operational mode data for this\r |
22 | driver instance. The data fields in EFI_IP4_MODE_DATA are read only. This\r | |
23 | function is used optionally to retrieve the operational mode data of underlying\r | |
24 | networks or drivers.\r | |
25 | \r | |
3e8c18da | 26 | @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r |
27 | @param[out] Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure.\r | |
28 | @param[out] MnpConfigData Pointer to the managed network configuration data structure.\r | |
29 | @param[out] SnpModeData Pointer to the simple network mode data structure.\r | |
5405e9a6 | 30 | \r |
31 | @retval EFI_SUCCESS The operation completed successfully.\r | |
32 | @retval EFI_INVALID_PARAMETER This is NULL.\r | |
33 | @retval EFI_OUT_OF_RESOURCES The required mode data could not be allocated.\r | |
772db4bb | 34 | \r |
5405e9a6 | 35 | **/\r |
36 | EFI_STATUS\r | |
37 | EFIAPI\r | |
38 | EfiIp4GetModeData (\r | |
39 | IN CONST EFI_IP4_PROTOCOL *This,\r | |
24af132f | 40 | OUT EFI_IP4_MODE_DATA *Ip4ModeData OPTIONAL,\r |
41 | OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL,\r | |
5405e9a6 | 42 | OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL\r |
43 | );\r | |
e2851998 | 44 | \r |
772db4bb | 45 | /**\r |
5405e9a6 | 46 | Assigns an IPv4 address and subnet mask to this EFI IPv4 Protocol driver instance.\r |
e2851998 | 47 | \r |
5405e9a6 | 48 | The Configure() function is used to set, change, or reset the operational\r |
49 | parameters and filter settings for this EFI IPv4 Protocol instance. Until these\r | |
50 | parameters have been set, no network traffic can be sent or received by this\r | |
51 | instance. Once the parameters have been reset (by calling this function with\r | |
52 | IpConfigData set to NULL), no more traffic can be sent or received until these\r | |
53 | parameters have been set again. Each EFI IPv4 Protocol instance can be started\r | |
54 | and stopped independently of each other by enabling or disabling their receive\r | |
55 | filter settings with the Configure() function.\r | |
e2851998 | 56 | \r |
5405e9a6 | 57 | When IpConfigData.UseDefaultAddress is set to FALSE, the new station address will\r |
58 | be appended as an alias address into the addresses list in the EFI IPv4 Protocol\r | |
59 | driver. While set to TRUE, Configure() will trigger the EFI_IP4_CONFIG_PROTOCOL\r | |
60 | to retrieve the default IPv4 address if it is not available yet. Clients could\r | |
61 | frequently call GetModeData() to check the status to ensure that the default IPv4\r | |
62 | address is ready.\r | |
e2851998 | 63 | \r |
5405e9a6 | 64 | If operational parameters are reset or changed, any pending transmit and receive\r |
65 | requests will be cancelled. Their completion token status will be set to EFI_ABORTED\r | |
66 | and their events will be signaled.\r | |
67 | \r | |
3e8c18da | 68 | @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r |
69 | @param[in] IpConfigData Pointer to the EFI IPv4 Protocol configuration data structure.\r | |
5405e9a6 | 70 | \r |
71 | @retval EFI_SUCCESS The driver instance was successfully opened.\r | |
72 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r | |
73 | RARP, etc.) is not finished yet.\r | |
74 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r | |
75 | @retval EFI_UNSUPPORTED One or more of the following conditions is TRUE:\r | |
76 | A configuration protocol (DHCP, BOOTP, RARP, etc.) could\r | |
77 | not be located when clients choose to use the default IPv4\r | |
78 | address. This EFI IPv4 Protocol implementation does not\r | |
79 | support this requested filter or timeout setting.\r | |
80 | @retval EFI_OUT_OF_RESOURCES The EFI IPv4 Protocol driver instance data could not be allocated.\r | |
81 | @retval EFI_ALREADY_STARTED The interface is already open and must be stopped before the\r | |
82 | IPv4 address or subnet mask can be changed. The interface must\r | |
83 | also be stopped when switching to/from raw packet mode.\r | |
84 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI IPv4\r | |
85 | Protocol driver instance is not opened.\r | |
772db4bb | 86 | \r |
5405e9a6 | 87 | **/\r |
88 | EFI_STATUS\r | |
89 | EFIAPI\r | |
90 | EfiIp4Configure (\r | |
91 | IN EFI_IP4_PROTOCOL *This,\r | |
92 | IN EFI_IP4_CONFIG_DATA *IpConfigData OPTIONAL\r | |
93 | );\r | |
e2851998 | 94 | \r |
5405e9a6 | 95 | /**\r |
96 | Joins and leaves multicast groups.\r | |
e2851998 | 97 | \r |
5405e9a6 | 98 | The Groups() function is used to join and leave multicast group sessions. Joining\r |
99 | a group will enable reception of matching multicast packets. Leaving a group will\r | |
100 | disable the multicast packet reception.\r | |
e2851998 | 101 | \r |
5405e9a6 | 102 | If JoinFlag is FALSE and GroupAddress is NULL, all joined groups will be left.\r |
103 | \r | |
3e8c18da | 104 | @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r |
105 | @param[in] JoinFlag Set to TRUE to join the multicast group session and FALSE to leave.\r | |
106 | @param[in] GroupAddress Pointer to the IPv4 multicast address.\r | |
5405e9a6 | 107 | \r |
108 | @retval EFI_SUCCESS The operation completed successfully.\r | |
109 | @retval EFI_INVALID_PARAMETER One or more of the following is TRUE:\r | |
110 | - This is NULL.\r | |
111 | - JoinFlag is TRUE and GroupAddress is NULL.\r | |
112 | - GroupAddress is not NULL and *GroupAddress is\r | |
113 | not a multicast IPv4 address.\r | |
114 | @retval EFI_NOT_STARTED This instance has not been started.\r | |
115 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r | |
116 | RARP, etc.) is not finished yet.\r | |
117 | @retval EFI_OUT_OF_RESOURCES System resources could not be allocated.\r | |
118 | @retval EFI_UNSUPPORTED This EFI IPv4 Protocol implementation does not support multicast groups.\r | |
119 | @retval EFI_ALREADY_STARTED The group address is already in the group table (when\r | |
120 | JoinFlag is TRUE).\r | |
121 | @retval EFI_NOT_FOUND The group address is not in the group table (when JoinFlag is FALSE).\r | |
122 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r | |
772db4bb | 123 | \r |
5405e9a6 | 124 | **/\r |
125 | EFI_STATUS\r | |
126 | EFIAPI\r | |
127 | EfiIp4Groups (\r | |
128 | IN EFI_IP4_PROTOCOL *This,\r | |
129 | IN BOOLEAN JoinFlag,\r | |
130 | IN EFI_IPv4_ADDRESS *GroupAddress OPTIONAL\r | |
131 | );\r | |
e2851998 | 132 | \r |
5405e9a6 | 133 | /**\r |
134 | Adds and deletes routing table entries.\r | |
135 | \r | |
136 | The Routes() function adds a route to or deletes a route from the routing table.\r | |
e2851998 | 137 | \r |
5405e9a6 | 138 | Routes are determined by comparing the SubnetAddress with the destination IPv4\r |
139 | address arithmetically AND-ed with the SubnetMask. The gateway address must be\r | |
140 | on the same subnet as the configured station address.\r | |
e2851998 | 141 | \r |
5405e9a6 | 142 | The default route is added with SubnetAddress and SubnetMask both set to 0.0.0.0.\r |
143 | The default route matches all destination IPv4 addresses that do not match any\r | |
144 | other routes.\r | |
e2851998 | 145 | \r |
5405e9a6 | 146 | A GatewayAddress that is zero is a nonroute. Packets are sent to the destination\r |
147 | IP address if it can be found in the ARP cache or on the local subnet. One automatic\r | |
148 | nonroute entry will be inserted into the routing table for outgoing packets that\r | |
149 | are addressed to a local subnet (gateway address of 0.0.0.0).\r | |
e2851998 | 150 | \r |
5405e9a6 | 151 | Each EFI IPv4 Protocol instance has its own independent routing table. Those EFI\r |
152 | IPv4 Protocol instances that use the default IPv4 address will also have copies\r | |
153 | of the routing table that was provided by the EFI_IP4_CONFIG_PROTOCOL, and these\r | |
154 | copies will be updated whenever the EIF IPv4 Protocol driver reconfigures its\r | |
155 | instances. As a result, client modification to the routing table will be lost.\r | |
156 | \r | |
3e8c18da | 157 | @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r |
158 | @param[in] DeleteRoute Set to TRUE to delete this route from the routing table. Set to\r | |
159 | FALSE to add this route to the routing table. SubnetAddress\r | |
160 | and SubnetMask are used as the key to each route entry.\r | |
161 | @param[in] SubnetAddress The address of the subnet that needs to be routed.\r | |
162 | @param[in] SubnetMask The subnet mask of SubnetAddress.\r | |
163 | @param[in] GatewayAddress The unicast gateway IPv4 address for this route.\r | |
5405e9a6 | 164 | \r |
165 | @retval EFI_SUCCESS The operation completed successfully.\r | |
166 | @retval EFI_NOT_STARTED The driver instance has not been started.\r | |
167 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r | |
168 | RARP, etc.) is not finished yet.\r | |
169 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r | |
170 | - This is NULL.\r | |
171 | - SubnetAddress is NULL.\r | |
172 | - SubnetMask is NULL.\r | |
173 | - GatewayAddress is NULL.\r | |
174 | - *SubnetAddress is not a valid subnet address.\r | |
175 | - *SubnetMask is not a valid subnet mask.\r | |
176 | - *GatewayAddress is not a valid unicast IPv4 address.\r | |
177 | @retval EFI_OUT_OF_RESOURCES Could not add the entry to the routing table.\r | |
178 | @retval EFI_NOT_FOUND This route is not in the routing table (when DeleteRoute is TRUE).\r | |
179 | @retval EFI_ACCESS_DENIED The route is already defined in the routing table (when\r | |
180 | DeleteRoute is FALSE).\r | |
e2851998 | 181 | \r |
5405e9a6 | 182 | **/\r |
183 | EFI_STATUS\r | |
184 | EFIAPI\r | |
185 | EfiIp4Routes (\r | |
186 | IN EFI_IP4_PROTOCOL *This,\r | |
187 | IN BOOLEAN DeleteRoute,\r | |
188 | IN EFI_IPv4_ADDRESS *SubnetAddress,\r | |
189 | IN EFI_IPv4_ADDRESS *SubnetMask,\r | |
190 | IN EFI_IPv4_ADDRESS *GatewayAddress\r | |
191 | );\r | |
e2851998 | 192 | \r |
5405e9a6 | 193 | /**\r |
194 | Places outgoing data packets into the transmit queue.\r | |
195 | \r | |
196 | The Transmit() function places a sending request in the transmit queue of this\r | |
197 | EFI IPv4 Protocol instance. Whenever the packet in the token is sent out or some\r | |
198 | errors occur, the event in the token will be signaled and the status is updated.\r | |
199 | \r | |
3e8c18da | 200 | @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r |
201 | @param[in] Token Pointer to the transmit token.\r | |
5405e9a6 | 202 | \r |
203 | @retval EFI_SUCCESS The data has been queued for transmission.\r | |
204 | @retval EFI_NOT_STARTED This instance has not been started.\r | |
205 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r | |
206 | RARP, etc.) is not finished yet.\r | |
207 | @retval EFI_INVALID_PARAMETER One or more pameters are invalid.\r | |
208 | @retval EFI_ACCESS_DENIED The transmit completion token with the same Token.Event\r | |
209 | was already in the transmit queue.\r | |
210 | @retval EFI_NOT_READY The completion token could not be queued because the transmit\r | |
e2851998 | 211 | queue is full.\r |
5405e9a6 | 212 | @retval EFI_NOT_FOUND Not route is found to destination address.\r |
213 | @retval EFI_OUT_OF_RESOURCES Could not queue the transmit data.\r | |
214 | @retval EFI_BUFFER_TOO_SMALL Token.Packet.TxData.TotalDataLength is too\r | |
215 | short to transmit.\r | |
216 | @retval EFI_BAD_BUFFER_SIZE The length of the IPv4 header + option length + total data length is\r | |
217 | greater than MTU (or greater than the maximum packet size if\r | |
218 | Token.Packet.TxData.OverrideData.\r | |
219 | DoNotFragment is TRUE.)\r | |
220 | \r | |
221 | **/\r | |
222 | EFI_STATUS\r | |
223 | EFIAPI\r | |
224 | EfiIp4Transmit (\r | |
225 | IN EFI_IP4_PROTOCOL *This,\r | |
226 | IN EFI_IP4_COMPLETION_TOKEN *Token\r | |
227 | );\r | |
e2851998 | 228 | \r |
5405e9a6 | 229 | /**\r |
230 | Places a receiving request into the receiving queue.\r | |
e2851998 | 231 | \r |
5405e9a6 | 232 | The Receive() function places a completion token into the receive packet queue.\r |
233 | This function is always asynchronous.\r | |
e2851998 | 234 | \r |
5405e9a6 | 235 | The Token.Event field in the completion token must be filled in by the caller\r |
236 | and cannot be NULL. When the receive operation completes, the EFI IPv4 Protocol\r | |
237 | driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event\r | |
238 | is signaled.\r | |
239 | \r | |
3e8c18da | 240 | @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r |
241 | @param[in] Token Pointer to a token that is associated with the receive data descriptor.\r | |
5405e9a6 | 242 | \r |
243 | @retval EFI_SUCCESS The receive completion token was cached.\r | |
244 | @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.\r | |
245 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, RARP, etc.)\r | |
246 | is not finished yet.\r | |
247 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r | |
248 | - This is NULL.\r | |
249 | - Token is NULL.\r | |
250 | - Token.Event is NULL.\r | |
251 | @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system\r | |
252 | resources (usually memory).\r | |
253 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r | |
254 | The EFI IPv4 Protocol instance has been reset to startup defaults.\r | |
255 | EFI_ACCESS_DENIED The receive completion token with the same Token.Event was already\r | |
256 | in the receive queue.\r | |
257 | @retval EFI_NOT_READY The receive request could not be queued because the receive queue is full.\r | |
258 | @retval EFI_ICMP_ERROR An ICMP error packet was received.\r | |
259 | \r | |
260 | **/\r | |
261 | EFI_STATUS\r | |
262 | EFIAPI\r | |
263 | EfiIp4Receive (\r | |
264 | IN EFI_IP4_PROTOCOL *This,\r | |
265 | IN EFI_IP4_COMPLETION_TOKEN *Token\r | |
266 | );\r | |
e2851998 | 267 | \r |
5405e9a6 | 268 | /**\r |
269 | Abort an asynchronous transmit or receive request.\r | |
e2851998 | 270 | \r |
5405e9a6 | 271 | The Cancel() function is used to abort a pending transmit or receive request.\r |
272 | If the token is in the transmit or receive request queues, after calling this\r | |
273 | function, Token->Status will be set to EFI_ABORTED and then Token->Event will\r | |
274 | be signaled. If the token is not in one of the queues, which usually means the\r | |
275 | asynchronous operation has completed, this function will not signal the token\r | |
276 | and EFI_NOT_FOUND is returned.\r | |
277 | \r | |
3e8c18da | 278 | @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r |
279 | @param[in] Token Pointer to a token that has been issued by\r | |
280 | EFI_IP4_PROTOCOL.Transmit() or\r | |
281 | EFI_IP4_PROTOCOL.Receive(). If NULL, all pending\r | |
282 | tokens are aborted. Type EFI_IP4_COMPLETION_TOKEN is\r | |
283 | defined in EFI_IP4_PROTOCOL.Transmit().\r | |
5405e9a6 | 284 | \r |
285 | @retval EFI_SUCCESS The asynchronous I/O request was aborted and\r | |
286 | Token.->Event was signaled. When Token is NULL, all\r | |
287 | pending requests were aborted and their events were signaled.\r | |
288 | @retval EFI_INVALID_PARAMETER This is NULL.\r | |
289 | @retval EFI_NOT_STARTED This instance has not been started.\r | |
290 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r | |
291 | RARP, etc.) is not finished yet.\r | |
292 | @retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O request was\r | |
293 | not found in the transmit or receive queue. It has either completed\r | |
294 | or was not issued by Transmit() and Receive().\r | |
295 | \r | |
296 | **/\r | |
297 | EFI_STATUS\r | |
298 | EFIAPI\r | |
299 | EfiIp4Cancel (\r | |
300 | IN EFI_IP4_PROTOCOL *This,\r | |
301 | IN EFI_IP4_COMPLETION_TOKEN *Token OPTIONAL\r | |
302 | );\r | |
e2851998 | 303 | \r |
5405e9a6 | 304 | /**\r |
305 | Polls for incoming data packets and processes outgoing data packets.\r | |
e2851998 | 306 | \r |
5405e9a6 | 307 | The Poll() function polls for incoming data packets and processes outgoing data\r |
308 | packets. Network drivers and applications can call the EFI_IP4_PROTOCOL.Poll()\r | |
309 | function to increase the rate that data packets are moved between the communications\r | |
310 | device and the transmit and receive queues.\r | |
e2851998 | 311 | \r |
5405e9a6 | 312 | In some systems the periodic timer event may not poll the underlying communications\r |
313 | device fast enough to transmit and/or receive all data packets without missing\r | |
314 | incoming packets or dropping outgoing packets. Drivers and applications that are\r | |
315 | experiencing packet loss should try calling the EFI_IP4_PROTOCOL.Poll() function\r | |
316 | more often.\r | |
317 | \r | |
3e8c18da | 318 | @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r |
5405e9a6 | 319 | \r |
320 | @retval EFI_SUCCESS Incoming or outgoing data was processed.\r | |
321 | @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.\r | |
322 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r | |
323 | RARP, etc.) is not finished yet.\r | |
324 | @retval EFI_INVALID_PARAMETER This is NULL.\r | |
325 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r | |
326 | @retval EFI_NOT_READY No incoming or outgoing data is processed.\r | |
327 | @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue.\r | |
328 | Consider increasing the polling rate.\r | |
329 | \r | |
330 | **/\r | |
331 | EFI_STATUS\r | |
332 | EFIAPI\r | |
333 | EfiIp4Poll (\r | |
334 | IN EFI_IP4_PROTOCOL *This\r | |
335 | );\r | |
336 | \r | |
337 | EFI_IP4_PROTOCOL\r | |
338 | mEfiIp4ProtocolTemplete = {\r | |
339 | EfiIp4GetModeData,\r | |
340 | EfiIp4Configure,\r | |
341 | EfiIp4Groups,\r | |
342 | EfiIp4Routes,\r | |
343 | EfiIp4Transmit,\r | |
344 | EfiIp4Receive,\r | |
345 | EfiIp4Cancel,\r | |
346 | EfiIp4Poll\r | |
347 | };\r | |
348 | \r | |
349 | /**\r | |
350 | Gets the current operational settings for this instance of the EFI IPv4 Protocol driver.\r | |
e2851998 | 351 | \r |
5405e9a6 | 352 | The GetModeData() function returns the current operational mode data for this\r |
353 | driver instance. The data fields in EFI_IP4_MODE_DATA are read only. This\r | |
354 | function is used optionally to retrieve the operational mode data of underlying\r | |
355 | networks or drivers.\r | |
356 | \r | |
3e8c18da | 357 | @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r |
358 | @param[out] Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure.\r | |
359 | @param[out] MnpConfigData Pointer to the managed network configuration data structure.\r | |
360 | @param[out] SnpModeData Pointer to the simple network mode data structure.\r | |
5405e9a6 | 361 | \r |
362 | @retval EFI_SUCCESS The operation completed successfully.\r | |
363 | @retval EFI_INVALID_PARAMETER This is NULL.\r | |
364 | @retval EFI_OUT_OF_RESOURCES The required mode data could not be allocated.\r | |
772db4bb | 365 | \r |
366 | **/\r | |
772db4bb | 367 | EFI_STATUS\r |
368 | EFIAPI\r | |
369 | EfiIp4GetModeData (\r | |
370 | IN CONST EFI_IP4_PROTOCOL *This,\r | |
24af132f | 371 | OUT EFI_IP4_MODE_DATA *Ip4ModeData OPTIONAL,\r |
372 | OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL,\r | |
772db4bb | 373 | OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL\r |
374 | )\r | |
375 | {\r | |
376 | IP4_PROTOCOL *IpInstance;\r | |
377 | IP4_SERVICE *IpSb;\r | |
378 | EFI_IP4_CONFIG_DATA *Config;\r | |
379 | EFI_STATUS Status;\r | |
380 | EFI_TPL OldTpl;\r | |
381 | IP4_ADDR Ip;\r | |
382 | \r | |
383 | if (This == NULL) {\r | |
384 | return EFI_INVALID_PARAMETER;\r | |
385 | }\r | |
386 | \r | |
e48e37fc | 387 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r |
772db4bb | 388 | IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This);\r |
389 | IpSb = IpInstance->Service;\r | |
390 | \r | |
391 | if (Ip4ModeData != NULL) {\r | |
392 | //\r | |
393 | // IsStarted is "whether the EfiIp4Configure has been called".\r | |
394 | // IsConfigured is "whether the station address has been configured"\r | |
395 | //\r | |
396 | Ip4ModeData->IsStarted = (BOOLEAN)(IpInstance->State == IP4_STATE_CONFIGED);\r | |
687a2e5f | 397 | CopyMem (&Ip4ModeData->ConfigData, &IpInstance->ConfigData, sizeof (Ip4ModeData->ConfigData));\r |
772db4bb | 398 | Ip4ModeData->IsConfigured = FALSE;\r |
399 | \r | |
400 | Ip4ModeData->GroupCount = IpInstance->GroupCount;\r | |
401 | Ip4ModeData->GroupTable = (EFI_IPv4_ADDRESS *) IpInstance->Groups;\r | |
402 | \r | |
403 | Ip4ModeData->IcmpTypeCount = 23;\r | |
404 | Ip4ModeData->IcmpTypeList = mIp4SupportedIcmp;\r | |
405 | \r | |
406 | Ip4ModeData->RouteTable = NULL;\r | |
407 | Ip4ModeData->RouteCount = 0;\r | |
408 | \r | |
a1503a32 | 409 | Ip4ModeData->MaxPacketSize = IpSb->MaxPacketSize;\r |
410 | \r | |
772db4bb | 411 | //\r |
412 | // return the current station address for this IP child. So,\r | |
413 | // the user can get the default address through this. Some\r | |
414 | // application wants to know it station address even it is\r | |
415 | // using the default one, such as a ftp server.\r | |
416 | //\r | |
417 | if (Ip4ModeData->IsStarted) {\r | |
418 | Config = &Ip4ModeData->ConfigData;\r | |
419 | \r | |
420 | Ip = HTONL (IpInstance->Interface->Ip);\r | |
e48e37fc | 421 | CopyMem (&Config->StationAddress, &Ip, sizeof (EFI_IPv4_ADDRESS));\r |
772db4bb | 422 | \r |
423 | Ip = HTONL (IpInstance->Interface->SubnetMask);\r | |
e48e37fc | 424 | CopyMem (&Config->SubnetMask, &Ip, sizeof (EFI_IPv4_ADDRESS));\r |
772db4bb | 425 | \r |
426 | Ip4ModeData->IsConfigured = IpInstance->Interface->Configured;\r | |
427 | \r | |
428 | //\r | |
429 | // Build a EFI route table for user from the internal route table.\r | |
430 | //\r | |
431 | Status = Ip4BuildEfiRouteTable (IpInstance);\r | |
432 | \r | |
433 | if (EFI_ERROR (Status)) {\r | |
e48e37fc | 434 | gBS->RestoreTPL (OldTpl);\r |
772db4bb | 435 | return Status;\r |
436 | }\r | |
437 | \r | |
438 | Ip4ModeData->RouteTable = IpInstance->EfiRouteTable;\r | |
439 | Ip4ModeData->RouteCount = IpInstance->EfiRouteCount;\r | |
440 | }\r | |
441 | }\r | |
442 | \r | |
dd29f3ed | 443 | //\r |
444 | // Get fresh mode data from MNP, since underlying media status may change\r | |
445 | //\r | |
446 | Status = IpSb->Mnp->GetModeData (IpSb->Mnp, MnpConfigData, SnpModeData);\r | |
772db4bb | 447 | \r |
e48e37fc | 448 | gBS->RestoreTPL (OldTpl);\r |
dd29f3ed | 449 | return Status;\r |
772db4bb | 450 | }\r |
451 | \r | |
452 | \r | |
453 | /**\r | |
454 | Config the MNP parameter used by IP. The IP driver use one MNP\r | |
455 | child to transmit/receive frames. By default, it configures MNP\r | |
456 | to receive unicast/multicast/broadcast. And it will enable/disable\r | |
457 | the promiscous receive according to whether there is IP child\r | |
5405e9a6 | 458 | enable that or not. If Force is FALSE, it will iterate through\r |
772db4bb | 459 | all the IP children to check whether the promiscuous receive\r |
460 | setting has been changed. If it hasn't been changed, it won't\r | |
5405e9a6 | 461 | reconfigure the MNP. If Force is TRUE, the MNP is configured no\r |
772db4bb | 462 | matter whether that is changed or not.\r |
463 | \r | |
3e8c18da | 464 | @param[in] IpSb The IP4 service instance that is to be changed.\r |
465 | @param[in] Force Force the configuration or not.\r | |
772db4bb | 466 | \r |
467 | @retval EFI_SUCCESS The MNP is successfully configured/reconfigured.\r | |
468 | @retval Others Configuration failed.\r | |
469 | \r | |
470 | **/\r | |
471 | EFI_STATUS\r | |
472 | Ip4ServiceConfigMnp (\r | |
473 | IN IP4_SERVICE *IpSb,\r | |
474 | IN BOOLEAN Force\r | |
475 | )\r | |
476 | {\r | |
e48e37fc | 477 | LIST_ENTRY *Entry;\r |
478 | LIST_ENTRY *ProtoEntry;\r | |
772db4bb | 479 | IP4_INTERFACE *IpIf;\r |
480 | IP4_PROTOCOL *IpInstance;\r | |
481 | BOOLEAN Reconfig;\r | |
482 | BOOLEAN PromiscReceive;\r | |
483 | EFI_STATUS Status;\r | |
484 | \r | |
485 | Reconfig = FALSE;\r | |
486 | PromiscReceive = FALSE;\r | |
487 | \r | |
488 | if (!Force) {\r | |
489 | //\r | |
490 | // Iterate through the IP children to check whether promiscuous\r | |
491 | // receive setting has been changed. Update the interface's receive\r | |
492 | // filter also.\r | |
493 | //\r | |
494 | NET_LIST_FOR_EACH (Entry, &IpSb->Interfaces) {\r | |
495 | \r | |
496 | IpIf = NET_LIST_USER_STRUCT (Entry, IP4_INTERFACE, Link);\r | |
497 | IpIf->PromiscRecv = FALSE;\r | |
498 | \r | |
499 | NET_LIST_FOR_EACH (ProtoEntry, &IpIf->IpInstances) {\r | |
500 | IpInstance = NET_LIST_USER_STRUCT (ProtoEntry, IP4_PROTOCOL, AddrLink);\r | |
501 | \r | |
502 | if (IpInstance->ConfigData.AcceptPromiscuous) {\r | |
503 | IpIf->PromiscRecv = TRUE;\r | |
504 | PromiscReceive = TRUE;\r | |
505 | }\r | |
506 | }\r | |
507 | }\r | |
508 | \r | |
509 | //\r | |
510 | // If promiscuous receive isn't changed, it isn't necessary to reconfigure.\r | |
511 | //\r | |
512 | if (PromiscReceive == IpSb->MnpConfigData.EnablePromiscuousReceive) {\r | |
513 | return EFI_SUCCESS;\r | |
514 | }\r | |
515 | \r | |
516 | Reconfig = TRUE;\r | |
517 | IpSb->MnpConfigData.EnablePromiscuousReceive = PromiscReceive;\r | |
518 | }\r | |
519 | \r | |
520 | Status = IpSb->Mnp->Configure (IpSb->Mnp, &IpSb->MnpConfigData);\r | |
521 | \r | |
522 | //\r | |
523 | // recover the original configuration if failed to set the configure.\r | |
524 | //\r | |
525 | if (EFI_ERROR (Status) && Reconfig) {\r | |
687a2e5f | 526 | IpSb->MnpConfigData.EnablePromiscuousReceive = (BOOLEAN) !PromiscReceive;\r |
772db4bb | 527 | }\r |
528 | \r | |
529 | return Status;\r | |
530 | }\r | |
531 | \r | |
532 | \r | |
772db4bb | 533 | /**\r |
534 | Intiialize the IP4_PROTOCOL structure to the unconfigured states.\r | |
535 | \r | |
536 | @param IpSb The IP4 service instance.\r | |
537 | @param IpInstance The IP4 child instance.\r | |
538 | \r | |
772db4bb | 539 | **/\r |
540 | VOID\r | |
541 | Ip4InitProtocol (\r | |
5405e9a6 | 542 | IN IP4_SERVICE *IpSb,\r |
543 | IN OUT IP4_PROTOCOL *IpInstance\r | |
772db4bb | 544 | )\r |
545 | {\r | |
546 | ASSERT ((IpSb != NULL) && (IpInstance != NULL));\r | |
547 | \r | |
e48e37fc | 548 | ZeroMem (IpInstance, sizeof (IP4_PROTOCOL));\r |
772db4bb | 549 | \r |
550 | IpInstance->Signature = IP4_PROTOCOL_SIGNATURE;\r | |
687a2e5f | 551 | CopyMem (&IpInstance->Ip4Proto, &mEfiIp4ProtocolTemplete, sizeof (IpInstance->Ip4Proto));\r |
772db4bb | 552 | IpInstance->State = IP4_STATE_UNCONFIGED;\r |
553 | IpInstance->Service = IpSb;\r | |
554 | \r | |
e48e37fc | 555 | InitializeListHead (&IpInstance->Link);\r |
772db4bb | 556 | NetMapInit (&IpInstance->RxTokens);\r |
557 | NetMapInit (&IpInstance->TxTokens);\r | |
e48e37fc | 558 | InitializeListHead (&IpInstance->Received);\r |
559 | InitializeListHead (&IpInstance->Delivered);\r | |
560 | InitializeListHead (&IpInstance->AddrLink);\r | |
772db4bb | 561 | \r |
e48e37fc | 562 | EfiInitializeLock (&IpInstance->RecycleLock, TPL_NOTIFY);\r |
772db4bb | 563 | }\r |
564 | \r | |
565 | \r | |
2c320007 JW |
566 | /**\r |
567 | The event handle for IP4 auto reconfiguration. The original default\r | |
568 | interface and route table will be removed as the default.\r | |
569 | \r | |
570 | @param[in] Context The IP4 service binding instance.\r | |
571 | \r | |
572 | **/\r | |
573 | VOID\r | |
574 | EFIAPI\r | |
575 | Ip4AutoReconfigCallBackDpc (\r | |
576 | IN VOID *Context\r | |
577 | )\r | |
578 | {\r | |
579 | IP4_SERVICE *IpSb;\r | |
580 | \r | |
581 | IpSb = (IP4_SERVICE *) Context;\r | |
582 | NET_CHECK_SIGNATURE (IpSb, IP4_SERVICE_SIGNATURE);\r | |
583 | \r | |
584 | if (IpSb->State > IP4_SERVICE_UNSTARTED) {\r | |
585 | IpSb->State = IP4_SERVICE_UNSTARTED;\r | |
586 | }\r | |
e371cc14 JW |
587 | \r |
588 | IpSb->Reconfig = TRUE;\r | |
2c320007 JW |
589 | \r |
590 | Ip4StartAutoConfig (&IpSb->Ip4Config2Instance);\r | |
591 | \r | |
592 | return ;\r | |
593 | }\r | |
594 | \r | |
595 | \r | |
596 | /**\r | |
597 | Request Ip4AutoReconfigCallBackDpc as a DPC at TPL_CALLBACK.\r | |
598 | \r | |
599 | @param Event The event that is signalled.\r | |
600 | @param Context The IP4 service binding instance.\r | |
601 | \r | |
602 | **/\r | |
603 | VOID\r | |
604 | EFIAPI\r | |
605 | Ip4AutoReconfigCallBack (\r | |
606 | IN EFI_EVENT Event,\r | |
607 | IN VOID *Context\r | |
608 | )\r | |
609 | {\r | |
610 | //\r | |
611 | // Request Ip4AutoReconfigCallBackDpc as a DPC at TPL_CALLBACK\r | |
612 | //\r | |
613 | QueueDpc (TPL_CALLBACK, Ip4AutoReconfigCallBackDpc, Context);\r | |
614 | }\r | |
615 | \r | |
1f6729ff | 616 | \r |
772db4bb | 617 | /**\r |
618 | Configure the IP4 child. If the child is already configured,\r | |
619 | change the configuration parameter. Otherwise configure it\r | |
620 | for the first time. The caller should validate the configuration\r | |
621 | before deliver them to it. It also don't do configure NULL.\r | |
622 | \r | |
3e8c18da | 623 | @param[in, out] IpInstance The IP4 child to configure.\r |
624 | @param[in] Config The configure data.\r | |
772db4bb | 625 | \r |
626 | @retval EFI_SUCCESS The IP4 child is successfully configured.\r | |
627 | @retval EFI_DEVICE_ERROR Failed to free the pending transive or to\r | |
628 | configure underlying MNP or other errors.\r | |
629 | @retval EFI_NO_MAPPING The IP4 child is configured to use default\r | |
630 | address, but the default address hasn't been\r | |
631 | configured. The IP4 child doesn't need to be\r | |
632 | reconfigured when default address is configured.\r | |
5405e9a6 | 633 | @retval EFI_OUT_OF_RESOURCES No more memory space is available.\r |
634 | @retval other Other error occurs.\r | |
772db4bb | 635 | \r |
636 | **/\r | |
637 | EFI_STATUS\r | |
638 | Ip4ConfigProtocol (\r | |
5405e9a6 | 639 | IN OUT IP4_PROTOCOL *IpInstance,\r |
640 | IN EFI_IP4_CONFIG_DATA *Config\r | |
772db4bb | 641 | )\r |
642 | {\r | |
643 | IP4_SERVICE *IpSb;\r | |
644 | IP4_INTERFACE *IpIf;\r | |
645 | EFI_STATUS Status;\r | |
646 | IP4_ADDR Ip;\r | |
647 | IP4_ADDR Netmask;\r | |
216f7970 | 648 | EFI_ARP_PROTOCOL *Arp;\r |
772db4bb | 649 | \r |
650 | IpSb = IpInstance->Service;\r | |
651 | \r | |
652 | //\r | |
653 | // User is changing packet filters. It must be stopped\r | |
654 | // before the station address can be changed.\r | |
655 | //\r | |
656 | if (IpInstance->State == IP4_STATE_CONFIGED) {\r | |
657 | //\r | |
658 | // Cancel all the pending transmit/receive from upper layer\r | |
659 | //\r | |
660 | Status = Ip4Cancel (IpInstance, NULL);\r | |
661 | \r | |
662 | if (EFI_ERROR (Status)) {\r | |
663 | return EFI_DEVICE_ERROR;\r | |
664 | }\r | |
665 | \r | |
687a2e5f | 666 | CopyMem (&IpInstance->ConfigData, Config, sizeof (IpInstance->ConfigData));\r |
772db4bb | 667 | return EFI_SUCCESS;\r |
668 | }\r | |
669 | \r | |
670 | //\r | |
671 | // Configure a fresh IP4 protocol instance. Create a route table.\r | |
672 | // Each IP child has its own route table, which may point to the\r | |
673 | // default table if it is using default address.\r | |
674 | //\r | |
675 | Status = EFI_OUT_OF_RESOURCES;\r | |
676 | IpInstance->RouteTable = Ip4CreateRouteTable ();\r | |
677 | \r | |
678 | if (IpInstance->RouteTable == NULL) {\r | |
679 | return Status;\r | |
680 | }\r | |
681 | \r | |
682 | //\r | |
683 | // Set up the interface.\r | |
684 | //\r | |
e48e37fc | 685 | CopyMem (&Ip, &Config->StationAddress, sizeof (IP4_ADDR));\r |
686 | CopyMem (&Netmask, &Config->SubnetMask, sizeof (IP4_ADDR));\r | |
772db4bb | 687 | \r |
688 | Ip = NTOHL (Ip);\r | |
689 | Netmask = NTOHL (Netmask);\r | |
690 | \r | |
691 | if (!Config->UseDefaultAddress) {\r | |
692 | //\r | |
693 | // Find whether there is already an interface with the same\r | |
694 | // station address. All the instances with the same station\r | |
695 | // address shares one interface.\r | |
696 | //\r | |
697 | IpIf = Ip4FindStationAddress (IpSb, Ip, Netmask);\r | |
698 | \r | |
699 | if (IpIf != NULL) {\r | |
700 | NET_GET_REF (IpIf);\r | |
701 | \r | |
702 | } else {\r | |
703 | IpIf = Ip4CreateInterface (IpSb->Mnp, IpSb->Controller, IpSb->Image);\r | |
704 | \r | |
705 | if (IpIf == NULL) {\r | |
706 | goto ON_ERROR;\r | |
707 | }\r | |
708 | \r | |
709 | Status = Ip4SetAddress (IpIf, Ip, Netmask);\r | |
710 | \r | |
711 | if (EFI_ERROR (Status)) {\r | |
712 | Status = EFI_DEVICE_ERROR;\r | |
713 | Ip4FreeInterface (IpIf, IpInstance);\r | |
714 | goto ON_ERROR;\r | |
715 | }\r | |
716 | \r | |
e48e37fc | 717 | InsertTailList (&IpSb->Interfaces, &IpIf->Link);\r |
772db4bb | 718 | }\r |
719 | \r | |
720 | //\r | |
721 | // Add a route to this connected network in the route table\r | |
722 | //\r | |
723 | Ip4AddRoute (IpInstance->RouteTable, Ip, Netmask, IP4_ALLZERO_ADDRESS);\r | |
724 | \r | |
725 | } else {\r | |
726 | //\r | |
727 | // Use the default address. If the default configuration hasn't\r | |
728 | // been started, start it.\r | |
729 | //\r | |
730 | if (IpSb->State == IP4_SERVICE_UNSTARTED) {\r | |
2c320007 JW |
731 | //\r |
732 | // Create the ReconfigEvent to start the new configuration.\r | |
733 | //\r | |
734 | if (IpSb->ReconfigEvent == NULL) {\r | |
735 | Status = gBS->CreateEvent (\r | |
736 | EVT_NOTIFY_SIGNAL,\r | |
737 | TPL_NOTIFY,\r | |
738 | Ip4AutoReconfigCallBack,\r | |
739 | IpSb,\r | |
740 | &IpSb->ReconfigEvent\r | |
741 | );\r | |
742 | \r | |
743 | if (EFI_ERROR (Status)) {\r | |
744 | goto ON_ERROR;\r | |
745 | }\r | |
746 | }\r | |
747 | \r | |
3d0a49ad JW |
748 | Status = Ip4StartAutoConfig (&IpSb->Ip4Config2Instance);\r |
749 | \r | |
750 | if (EFI_ERROR (Status)) {\r | |
2c320007 | 751 | goto CLOSE_RECONFIG_EVENT;\r |
3d0a49ad | 752 | }\r |
772db4bb | 753 | }\r |
754 | \r | |
755 | IpIf = IpSb->DefaultInterface;\r | |
756 | NET_GET_REF (IpSb->DefaultInterface);\r | |
757 | \r | |
758 | //\r | |
759 | // If default address is used, so is the default route table.\r | |
760 | // Any route set by the instance has the precedence over the\r | |
761 | // routes in the default route table. Link the default table\r | |
762 | // after the instance's table. Routing will search the local\r | |
763 | // table first.\r | |
764 | //\r | |
765 | NET_GET_REF (IpSb->DefaultRouteTable);\r | |
766 | IpInstance->RouteTable->Next = IpSb->DefaultRouteTable;\r | |
767 | }\r | |
768 | \r | |
769 | IpInstance->Interface = IpIf;\r | |
216f7970 | 770 | if (IpIf->Arp != NULL) {\r |
771 | Arp = NULL;\r | |
772 | Status = gBS->OpenProtocol (\r | |
773 | IpIf->ArpHandle,\r | |
774 | &gEfiArpProtocolGuid,\r | |
775 | (VOID **) &Arp,\r | |
776 | gIp4DriverBinding.DriverBindingHandle,\r | |
777 | IpInstance->Handle,\r | |
778 | EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r | |
779 | );\r | |
780 | if (EFI_ERROR (Status)) {\r | |
2c320007 | 781 | goto CLOSE_RECONFIG_EVENT;\r |
216f7970 | 782 | }\r |
783 | }\r | |
e48e37fc | 784 | InsertTailList (&IpIf->IpInstances, &IpInstance->AddrLink);\r |
772db4bb | 785 | \r |
687a2e5f | 786 | CopyMem (&IpInstance->ConfigData, Config, sizeof (IpInstance->ConfigData));\r |
772db4bb | 787 | IpInstance->State = IP4_STATE_CONFIGED;\r |
788 | \r | |
789 | //\r | |
790 | // Although EFI_NO_MAPPING is an error code, the IP child has been\r | |
791 | // successfully configured and doesn't need reconfiguration when\r | |
792 | // default address is acquired.\r | |
793 | //\r | |
794 | if (Config->UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) {\r | |
795 | return EFI_NO_MAPPING;\r | |
796 | }\r | |
797 | \r | |
798 | return EFI_SUCCESS;\r | |
799 | \r | |
2c320007 JW |
800 | CLOSE_RECONFIG_EVENT:\r |
801 | if (IpSb->ReconfigEvent != NULL) {\r | |
802 | gBS->CloseEvent (IpSb->ReconfigEvent);\r | |
803 | IpSb->ReconfigEvent = NULL;\r | |
804 | }\r | |
805 | \r | |
772db4bb | 806 | ON_ERROR:\r |
807 | Ip4FreeRouteTable (IpInstance->RouteTable);\r | |
808 | IpInstance->RouteTable = NULL;\r | |
809 | return Status;\r | |
810 | }\r | |
811 | \r | |
812 | \r | |
813 | /**\r | |
814 | Clean up the IP4 child, release all the resources used by it.\r | |
815 | \r | |
3e8c18da | 816 | @param[in] IpInstance The IP4 child to clean up.\r |
772db4bb | 817 | \r |
1f6729ff | 818 | @retval EFI_SUCCESS The IP4 child is cleaned up.\r |
819 | @retval EFI_DEVICE_ERROR Some resources failed to be released.\r | |
772db4bb | 820 | \r |
821 | **/\r | |
822 | EFI_STATUS\r | |
823 | Ip4CleanProtocol (\r | |
824 | IN IP4_PROTOCOL *IpInstance\r | |
825 | )\r | |
826 | {\r | |
827 | if (EFI_ERROR (Ip4Cancel (IpInstance, NULL))) {\r | |
828 | return EFI_DEVICE_ERROR;\r | |
829 | }\r | |
830 | \r | |
831 | if (EFI_ERROR (Ip4Groups (IpInstance, FALSE, NULL))) {\r | |
832 | return EFI_DEVICE_ERROR;\r | |
833 | }\r | |
834 | \r | |
835 | //\r | |
836 | // Some packets haven't been recycled. It is because either the\r | |
837 | // user forgets to recycle the packets, or because the callback\r | |
838 | // hasn't been called. Just leave it alone.\r | |
839 | //\r | |
e48e37fc | 840 | if (!IsListEmpty (&IpInstance->Delivered)) {\r |
772db4bb | 841 | ;\r |
842 | }\r | |
843 | \r | |
844 | if (IpInstance->Interface != NULL) {\r | |
e48e37fc | 845 | RemoveEntryList (&IpInstance->AddrLink);\r |
216f7970 | 846 | if (IpInstance->Interface->Arp != NULL) {\r |
847 | gBS->CloseProtocol (\r | |
848 | IpInstance->Interface->ArpHandle,\r | |
849 | &gEfiArpProtocolGuid,\r | |
850 | gIp4DriverBinding.DriverBindingHandle,\r | |
851 | IpInstance->Handle\r | |
852 | );\r | |
853 | }\r | |
772db4bb | 854 | Ip4FreeInterface (IpInstance->Interface, IpInstance);\r |
855 | IpInstance->Interface = NULL;\r | |
856 | }\r | |
857 | \r | |
858 | if (IpInstance->RouteTable != NULL) {\r | |
859 | if (IpInstance->RouteTable->Next != NULL) {\r | |
860 | Ip4FreeRouteTable (IpInstance->RouteTable->Next);\r | |
861 | }\r | |
862 | \r | |
863 | Ip4FreeRouteTable (IpInstance->RouteTable);\r | |
864 | IpInstance->RouteTable = NULL;\r | |
865 | }\r | |
866 | \r | |
867 | if (IpInstance->EfiRouteTable != NULL) {\r | |
766c7483 | 868 | FreePool (IpInstance->EfiRouteTable);\r |
772db4bb | 869 | IpInstance->EfiRouteTable = NULL;\r |
870 | IpInstance->EfiRouteCount = 0;\r | |
871 | }\r | |
872 | \r | |
873 | if (IpInstance->Groups != NULL) {\r | |
766c7483 | 874 | FreePool (IpInstance->Groups);\r |
772db4bb | 875 | IpInstance->Groups = NULL;\r |
876 | IpInstance->GroupCount = 0;\r | |
877 | }\r | |
878 | \r | |
879 | NetMapClean (&IpInstance->TxTokens);\r | |
880 | \r | |
881 | NetMapClean (&IpInstance->RxTokens);\r | |
882 | \r | |
883 | return EFI_SUCCESS;\r | |
884 | }\r | |
885 | \r | |
886 | \r | |
887 | /**\r | |
888 | Validate that Ip/Netmask pair is OK to be used as station\r | |
889 | address. Only continuous netmasks are supported. and check\r | |
890 | that StationAddress is a unicast address on the newtwork.\r | |
891 | \r | |
1f6729ff | 892 | @param[in] Ip The IP address to validate.\r |
893 | @param[in] Netmask The netmaks of the IP.\r | |
772db4bb | 894 | \r |
1f6729ff | 895 | @retval TRUE The Ip/Netmask pair is valid.\r |
896 | @retval FALSE The Ip/Netmask pair is invalid.\r | |
772db4bb | 897 | \r |
898 | **/\r | |
899 | BOOLEAN\r | |
900 | Ip4StationAddressValid (\r | |
901 | IN IP4_ADDR Ip,\r | |
902 | IN IP4_ADDR Netmask\r | |
903 | )\r | |
904 | {\r | |
905 | IP4_ADDR NetBrdcastMask;\r | |
906 | INTN Len;\r | |
907 | INTN Type;\r | |
908 | \r | |
909 | //\r | |
910 | // Only support the station address with 0.0.0.0/0 to enable DHCP client.\r | |
911 | //\r | |
912 | if (Netmask == IP4_ALLZERO_ADDRESS) {\r | |
913 | return (BOOLEAN) (Ip == IP4_ALLZERO_ADDRESS);\r | |
914 | }\r | |
915 | \r | |
916 | //\r | |
917 | // Only support the continuous net masks\r | |
918 | //\r | |
919 | if ((Len = NetGetMaskLength (Netmask)) == IP4_MASK_NUM) {\r | |
920 | return FALSE;\r | |
921 | }\r | |
922 | \r | |
923 | //\r | |
924 | // Station address can't be class D or class E address\r | |
925 | //\r | |
926 | if ((Type = NetGetIpClass (Ip)) > IP4_ADDR_CLASSC) {\r | |
927 | return FALSE;\r | |
928 | }\r | |
929 | \r | |
930 | //\r | |
931 | // Station address can't be subnet broadcast/net broadcast address\r | |
932 | //\r | |
933 | if ((Ip == (Ip & Netmask)) || (Ip == (Ip | ~Netmask))) {\r | |
934 | return FALSE;\r | |
935 | }\r | |
936 | \r | |
2a86ff1c | 937 | NetBrdcastMask = gIp4AllMasks[MIN (Len, Type << 3)];\r |
772db4bb | 938 | \r |
939 | if (Ip == (Ip | ~NetBrdcastMask)) {\r | |
940 | return FALSE;\r | |
941 | }\r | |
942 | \r | |
943 | return TRUE;\r | |
944 | }\r | |
945 | \r | |
946 | \r | |
947 | /**\r | |
5405e9a6 | 948 | Assigns an IPv4 address and subnet mask to this EFI IPv4 Protocol driver instance.\r |
e2851998 | 949 | \r |
5405e9a6 | 950 | The Configure() function is used to set, change, or reset the operational\r |
951 | parameters and filter settings for this EFI IPv4 Protocol instance. Until these\r | |
952 | parameters have been set, no network traffic can be sent or received by this\r | |
953 | instance. Once the parameters have been reset (by calling this function with\r | |
954 | IpConfigData set to NULL), no more traffic can be sent or received until these\r | |
955 | parameters have been set again. Each EFI IPv4 Protocol instance can be started\r | |
956 | and stopped independently of each other by enabling or disabling their receive\r | |
957 | filter settings with the Configure() function.\r | |
e2851998 | 958 | \r |
5405e9a6 | 959 | When IpConfigData.UseDefaultAddress is set to FALSE, the new station address will\r |
960 | be appended as an alias address into the addresses list in the EFI IPv4 Protocol\r | |
961 | driver. While set to TRUE, Configure() will trigger the EFI_IP4_CONFIG_PROTOCOL\r | |
962 | to retrieve the default IPv4 address if it is not available yet. Clients could\r | |
963 | frequently call GetModeData() to check the status to ensure that the default IPv4\r | |
964 | address is ready.\r | |
e2851998 | 965 | \r |
5405e9a6 | 966 | If operational parameters are reset or changed, any pending transmit and receive\r |
967 | requests will be cancelled. Their completion token status will be set to EFI_ABORTED\r | |
968 | and their events will be signaled.\r | |
969 | \r | |
3e8c18da | 970 | @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r |
971 | @param[in] IpConfigData Pointer to the EFI IPv4 Protocol configuration data structure.\r | |
5405e9a6 | 972 | \r |
973 | @retval EFI_SUCCESS The driver instance was successfully opened.\r | |
974 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r | |
975 | RARP, etc.) is not finished yet.\r | |
976 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r | |
977 | @retval EFI_UNSUPPORTED One or more of the following conditions is TRUE:\r | |
978 | A configuration protocol (DHCP, BOOTP, RARP, etc.) could\r | |
979 | not be located when clients choose to use the default IPv4\r | |
980 | address. This EFI IPv4 Protocol implementation does not\r | |
981 | support this requested filter or timeout setting.\r | |
982 | @retval EFI_OUT_OF_RESOURCES The EFI IPv4 Protocol driver instance data could not be allocated.\r | |
983 | @retval EFI_ALREADY_STARTED The interface is already open and must be stopped before the\r | |
984 | IPv4 address or subnet mask can be changed. The interface must\r | |
985 | also be stopped when switching to/from raw packet mode.\r | |
986 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI IPv4\r | |
987 | Protocol driver instance is not opened.\r | |
772db4bb | 988 | \r |
989 | **/\r | |
772db4bb | 990 | EFI_STATUS\r |
991 | EFIAPI\r | |
992 | EfiIp4Configure (\r | |
993 | IN EFI_IP4_PROTOCOL *This,\r | |
994 | IN EFI_IP4_CONFIG_DATA *IpConfigData OPTIONAL\r | |
995 | )\r | |
996 | {\r | |
997 | IP4_PROTOCOL *IpInstance;\r | |
998 | EFI_IP4_CONFIG_DATA *Current;\r | |
999 | EFI_TPL OldTpl;\r | |
1000 | EFI_STATUS Status;\r | |
1001 | BOOLEAN AddrOk;\r | |
1002 | IP4_ADDR IpAddress;\r | |
1003 | IP4_ADDR SubnetMask;\r | |
1004 | \r | |
1005 | //\r | |
1006 | // First, validate the parameters\r | |
1007 | //\r | |
1008 | if (This == NULL) {\r | |
1009 | return EFI_INVALID_PARAMETER;\r | |
1010 | }\r | |
1011 | \r | |
1012 | IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This);\r | |
e48e37fc | 1013 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r |
772db4bb | 1014 | \r |
1015 | //\r | |
1016 | // Validate the configuration first.\r | |
1017 | //\r | |
1018 | if (IpConfigData != NULL) {\r | |
772db4bb | 1019 | \r |
e48e37fc | 1020 | CopyMem (&IpAddress, &IpConfigData->StationAddress, sizeof (IP4_ADDR));\r |
1021 | CopyMem (&SubnetMask, &IpConfigData->SubnetMask, sizeof (IP4_ADDR));\r | |
772db4bb | 1022 | \r |
1023 | IpAddress = NTOHL (IpAddress);\r | |
1024 | SubnetMask = NTOHL (SubnetMask);\r | |
1025 | \r | |
1026 | //\r | |
1027 | // Check whether the station address is a valid unicast address\r | |
1028 | //\r | |
1029 | if (!IpConfigData->UseDefaultAddress) {\r | |
1030 | AddrOk = Ip4StationAddressValid (IpAddress, SubnetMask);\r | |
1031 | \r | |
1032 | if (!AddrOk) {\r | |
1033 | Status = EFI_INVALID_PARAMETER;\r | |
1034 | goto ON_EXIT;\r | |
1035 | }\r | |
1036 | }\r | |
1037 | \r | |
1038 | //\r | |
1039 | // User can only update packet filters when already configured.\r | |
1040 | // If it wants to change the station address, it must configure(NULL)\r | |
1041 | // the instance first.\r | |
1042 | //\r | |
1043 | if (IpInstance->State == IP4_STATE_CONFIGED) {\r | |
1044 | Current = &IpInstance->ConfigData;\r | |
1045 | \r | |
1046 | if (Current->UseDefaultAddress != IpConfigData->UseDefaultAddress) {\r | |
1047 | Status = EFI_ALREADY_STARTED;\r | |
1048 | goto ON_EXIT;\r | |
1049 | }\r | |
1050 | \r | |
1051 | if (!Current->UseDefaultAddress &&\r | |
84b5c78e | 1052 | (!EFI_IP4_EQUAL (&Current->StationAddress, &IpConfigData->StationAddress) ||\r |
1053 | !EFI_IP4_EQUAL (&Current->SubnetMask, &IpConfigData->SubnetMask))) {\r | |
772db4bb | 1054 | Status = EFI_ALREADY_STARTED;\r |
1055 | goto ON_EXIT;\r | |
1056 | }\r | |
1057 | \r | |
1058 | if (Current->UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) {\r | |
ae0a0b06 | 1059 | Status = EFI_NO_MAPPING;\r |
1060 | goto ON_EXIT;\r | |
772db4bb | 1061 | }\r |
1062 | }\r | |
1063 | }\r | |
1064 | \r | |
1065 | //\r | |
1066 | // Configure the instance or clean it up.\r | |
1067 | //\r | |
1068 | if (IpConfigData != NULL) {\r | |
1069 | Status = Ip4ConfigProtocol (IpInstance, IpConfigData);\r | |
1070 | } else {\r | |
1071 | Status = Ip4CleanProtocol (IpInstance);\r | |
1072 | \r | |
1073 | //\r | |
75dce340 | 1074 | // Don't change the state if it is DESTROY, consider the following\r |
772db4bb | 1075 | // valid sequence: Mnp is unloaded-->Ip Stopped-->Udp Stopped,\r |
1076 | // Configure (ThisIp, NULL). If the state is changed to UNCONFIGED,\r | |
1077 | // the unload fails miserably.\r | |
1078 | //\r | |
1079 | if (IpInstance->State == IP4_STATE_CONFIGED) {\r | |
1080 | IpInstance->State = IP4_STATE_UNCONFIGED;\r | |
1081 | }\r | |
1082 | }\r | |
1083 | \r | |
1084 | //\r | |
1085 | // Update the MNP's configure data. Ip4ServiceConfigMnp will check\r | |
1086 | // whether it is necessary to reconfigure the MNP.\r | |
1087 | //\r | |
1088 | Ip4ServiceConfigMnp (IpInstance->Service, FALSE);\r | |
1089 | \r | |
772db4bb | 1090 | ON_EXIT:\r |
e48e37fc | 1091 | gBS->RestoreTPL (OldTpl);\r |
772db4bb | 1092 | return Status;\r |
1093 | \r | |
1094 | }\r | |
1095 | \r | |
1096 | \r | |
1097 | /**\r | |
1098 | Change the IP4 child's multicast setting. The caller\r | |
1099 | should make sure that the parameters is valid.\r | |
1100 | \r | |
3e8c18da | 1101 | @param[in] IpInstance The IP4 child to change the setting.\r |
1f6729ff | 1102 | @param[in] JoinFlag TRUE to join the group, otherwise leave it.\r |
1103 | @param[in] GroupAddress The target group address.\r | |
772db4bb | 1104 | \r |
1f6729ff | 1105 | @retval EFI_ALREADY_STARTED Want to join the group, but already a member of it.\r |
772db4bb | 1106 | @retval EFI_OUT_OF_RESOURCES Failed to allocate some resources.\r |
1f6729ff | 1107 | @retval EFI_DEVICE_ERROR Failed to set the group configuraton.\r |
772db4bb | 1108 | @retval EFI_SUCCESS Successfully updated the group setting.\r |
1109 | @retval EFI_NOT_FOUND Try to leave the group which it isn't a member.\r | |
1110 | \r | |
1111 | **/\r | |
1112 | EFI_STATUS\r | |
1113 | Ip4Groups (\r | |
1114 | IN IP4_PROTOCOL *IpInstance,\r | |
1115 | IN BOOLEAN JoinFlag,\r | |
1116 | IN EFI_IPv4_ADDRESS *GroupAddress OPTIONAL\r | |
1117 | )\r | |
1118 | {\r | |
1119 | IP4_ADDR *Members;\r | |
1120 | IP4_ADDR Group;\r | |
1121 | UINT32 Index;\r | |
1122 | \r | |
1123 | //\r | |
1124 | // Add it to the instance's Groups, and join the group by IGMP.\r | |
1125 | // IpInstance->Groups is in network byte order. IGMP operates in\r | |
1126 | // host byte order\r | |
1127 | //\r | |
1128 | if (JoinFlag) {\r | |
e2851998 | 1129 | //\r |
894d038a | 1130 | // When JoinFlag is TRUE, GroupAddress shouldn't be NULL.\r |
1131 | //\r | |
1132 | ASSERT (GroupAddress != NULL);\r | |
e48e37fc | 1133 | CopyMem (&Group, GroupAddress, sizeof (IP4_ADDR));\r |
772db4bb | 1134 | \r |
1135 | for (Index = 0; Index < IpInstance->GroupCount; Index++) {\r | |
1136 | if (IpInstance->Groups[Index] == Group) {\r | |
1137 | return EFI_ALREADY_STARTED;\r | |
1138 | }\r | |
1139 | }\r | |
1140 | \r | |
1141 | Members = Ip4CombineGroups (IpInstance->Groups, IpInstance->GroupCount, Group);\r | |
1142 | \r | |
1143 | if (Members == NULL) {\r | |
1144 | return EFI_OUT_OF_RESOURCES;\r | |
1145 | }\r | |
1146 | \r | |
1147 | if (EFI_ERROR (Ip4JoinGroup (IpInstance, NTOHL (Group)))) {\r | |
766c7483 | 1148 | FreePool (Members);\r |
772db4bb | 1149 | return EFI_DEVICE_ERROR;\r |
1150 | }\r | |
1151 | \r | |
1152 | if (IpInstance->Groups != NULL) {\r | |
766c7483 | 1153 | FreePool (IpInstance->Groups);\r |
772db4bb | 1154 | }\r |
1155 | \r | |
1156 | IpInstance->Groups = Members;\r | |
1157 | IpInstance->GroupCount++;\r | |
1158 | \r | |
1159 | return EFI_SUCCESS;\r | |
1160 | }\r | |
1161 | \r | |
1162 | //\r | |
1163 | // Leave the group. Leave all the groups if GroupAddress is NULL.\r | |
1164 | // Must iterate from the end to the beginning because the GroupCount\r | |
1165 | // is decreamented each time an address is removed..\r | |
1166 | //\r | |
1167 | for (Index = IpInstance->GroupCount; Index > 0 ; Index--) {\r | |
1168 | Group = IpInstance->Groups[Index - 1];\r | |
1169 | \r | |
84b5c78e | 1170 | if ((GroupAddress == NULL) || EFI_IP4_EQUAL (&Group, GroupAddress)) {\r |
772db4bb | 1171 | if (EFI_ERROR (Ip4LeaveGroup (IpInstance, NTOHL (Group)))) {\r |
1172 | return EFI_DEVICE_ERROR;\r | |
1173 | }\r | |
1174 | \r | |
1175 | Ip4RemoveGroupAddr (IpInstance->Groups, IpInstance->GroupCount, Group);\r | |
1176 | IpInstance->GroupCount--;\r | |
1177 | \r | |
1178 | if (IpInstance->GroupCount == 0) {\r | |
1179 | ASSERT (Index == 1);\r | |
1180 | \r | |
766c7483 | 1181 | FreePool (IpInstance->Groups);\r |
772db4bb | 1182 | IpInstance->Groups = NULL;\r |
1183 | }\r | |
1184 | \r | |
1185 | if (GroupAddress != NULL) {\r | |
1186 | return EFI_SUCCESS;\r | |
1187 | }\r | |
1188 | }\r | |
1189 | }\r | |
1190 | \r | |
1191 | return ((GroupAddress != NULL) ? EFI_NOT_FOUND : EFI_SUCCESS);\r | |
1192 | }\r | |
1193 | \r | |
1194 | \r | |
1195 | /**\r | |
5405e9a6 | 1196 | Joins and leaves multicast groups.\r |
e2851998 | 1197 | \r |
5405e9a6 | 1198 | The Groups() function is used to join and leave multicast group sessions. Joining\r |
1199 | a group will enable reception of matching multicast packets. Leaving a group will\r | |
1200 | disable the multicast packet reception.\r | |
e2851998 | 1201 | \r |
5405e9a6 | 1202 | If JoinFlag is FALSE and GroupAddress is NULL, all joined groups will be left.\r |
1203 | \r | |
3e8c18da | 1204 | @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r |
1205 | @param[in] JoinFlag Set to TRUE to join the multicast group session and FALSE to leave.\r | |
1206 | @param[in] GroupAddress Pointer to the IPv4 multicast address.\r | |
5405e9a6 | 1207 | \r |
1208 | @retval EFI_SUCCESS The operation completed successfully.\r | |
1209 | @retval EFI_INVALID_PARAMETER One or more of the following is TRUE:\r | |
1210 | - This is NULL.\r | |
1211 | - JoinFlag is TRUE and GroupAddress is NULL.\r | |
1212 | - GroupAddress is not NULL and *GroupAddress is\r | |
1213 | not a multicast IPv4 address.\r | |
1214 | @retval EFI_NOT_STARTED This instance has not been started.\r | |
1215 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r | |
1216 | RARP, etc.) is not finished yet.\r | |
1217 | @retval EFI_OUT_OF_RESOURCES System resources could not be allocated.\r | |
1218 | @retval EFI_UNSUPPORTED This EFI IPv4 Protocol implementation does not support multicast groups.\r | |
1219 | @retval EFI_ALREADY_STARTED The group address is already in the group table (when\r | |
1220 | JoinFlag is TRUE).\r | |
1221 | @retval EFI_NOT_FOUND The group address is not in the group table (when JoinFlag is FALSE).\r | |
1222 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r | |
772db4bb | 1223 | \r |
1224 | **/\r | |
772db4bb | 1225 | EFI_STATUS\r |
1226 | EFIAPI\r | |
1227 | EfiIp4Groups (\r | |
1228 | IN EFI_IP4_PROTOCOL *This,\r | |
1229 | IN BOOLEAN JoinFlag,\r | |
1230 | IN EFI_IPv4_ADDRESS *GroupAddress OPTIONAL\r | |
1231 | )\r | |
1232 | {\r | |
1233 | IP4_PROTOCOL *IpInstance;\r | |
1234 | EFI_STATUS Status;\r | |
1235 | EFI_TPL OldTpl;\r | |
1236 | IP4_ADDR McastIp;\r | |
1237 | \r | |
1238 | if ((This == NULL) || (JoinFlag && (GroupAddress == NULL))) {\r | |
1239 | return EFI_INVALID_PARAMETER;\r | |
1240 | }\r | |
1241 | \r | |
1242 | if (GroupAddress != NULL) {\r | |
e48e37fc | 1243 | CopyMem (&McastIp, GroupAddress, sizeof (IP4_ADDR));\r |
772db4bb | 1244 | \r |
1245 | if (!IP4_IS_MULTICAST (NTOHL (McastIp))) {\r | |
1246 | return EFI_INVALID_PARAMETER;\r | |
1247 | }\r | |
1248 | }\r | |
1249 | \r | |
1250 | IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This);\r | |
e48e37fc | 1251 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r |
772db4bb | 1252 | \r |
1253 | if (IpInstance->State != IP4_STATE_CONFIGED) {\r | |
1254 | Status = EFI_NOT_STARTED;\r | |
1255 | goto ON_EXIT;\r | |
1256 | }\r | |
1257 | \r | |
1258 | if (IpInstance->ConfigData.UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) {\r | |
1259 | Status = EFI_NO_MAPPING;\r | |
1260 | goto ON_EXIT;\r | |
1261 | }\r | |
1262 | \r | |
1263 | Status = Ip4Groups (IpInstance, JoinFlag, GroupAddress);\r | |
1264 | \r | |
1265 | ON_EXIT:\r | |
e48e37fc | 1266 | gBS->RestoreTPL (OldTpl);\r |
772db4bb | 1267 | return Status;\r |
1268 | }\r | |
1269 | \r | |
1270 | \r | |
1271 | /**\r | |
5405e9a6 | 1272 | Adds and deletes routing table entries.\r |
1273 | \r | |
1274 | The Routes() function adds a route to or deletes a route from the routing table.\r | |
e2851998 | 1275 | \r |
5405e9a6 | 1276 | Routes are determined by comparing the SubnetAddress with the destination IPv4\r |
1277 | address arithmetically AND-ed with the SubnetMask. The gateway address must be\r | |
1278 | on the same subnet as the configured station address.\r | |
e2851998 | 1279 | \r |
5405e9a6 | 1280 | The default route is added with SubnetAddress and SubnetMask both set to 0.0.0.0.\r |
1281 | The default route matches all destination IPv4 addresses that do not match any\r | |
1282 | other routes.\r | |
e2851998 | 1283 | \r |
5405e9a6 | 1284 | A GatewayAddress that is zero is a nonroute. Packets are sent to the destination\r |
1285 | IP address if it can be found in the ARP cache or on the local subnet. One automatic\r | |
1286 | nonroute entry will be inserted into the routing table for outgoing packets that\r | |
1287 | are addressed to a local subnet (gateway address of 0.0.0.0).\r | |
e2851998 | 1288 | \r |
5405e9a6 | 1289 | Each EFI IPv4 Protocol instance has its own independent routing table. Those EFI\r |
1290 | IPv4 Protocol instances that use the default IPv4 address will also have copies\r | |
1291 | of the routing table that was provided by the EFI_IP4_CONFIG_PROTOCOL, and these\r | |
1292 | copies will be updated whenever the EIF IPv4 Protocol driver reconfigures its\r | |
1293 | instances. As a result, client modification to the routing table will be lost.\r | |
1294 | \r | |
3e8c18da | 1295 | @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r |
1296 | @param[in] DeleteRoute Set to TRUE to delete this route from the routing table. Set to\r | |
1297 | FALSE to add this route to the routing table. SubnetAddress\r | |
1298 | and SubnetMask are used as the key to each route entry.\r | |
1299 | @param[in] SubnetAddress The address of the subnet that needs to be routed.\r | |
1300 | @param[in] SubnetMask The subnet mask of SubnetAddress.\r | |
1301 | @param[in] GatewayAddress The unicast gateway IPv4 address for this route.\r | |
5405e9a6 | 1302 | \r |
1303 | @retval EFI_SUCCESS The operation completed successfully.\r | |
1304 | @retval EFI_NOT_STARTED The driver instance has not been started.\r | |
1305 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r | |
1306 | RARP, etc.) is not finished yet.\r | |
1307 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r | |
1308 | - This is NULL.\r | |
1309 | - SubnetAddress is NULL.\r | |
1310 | - SubnetMask is NULL.\r | |
1311 | - GatewayAddress is NULL.\r | |
1312 | - *SubnetAddress is not a valid subnet address.\r | |
1313 | - *SubnetMask is not a valid subnet mask.\r | |
1314 | - *GatewayAddress is not a valid unicast IPv4 address.\r | |
1315 | @retval EFI_OUT_OF_RESOURCES Could not add the entry to the routing table.\r | |
1316 | @retval EFI_NOT_FOUND This route is not in the routing table (when DeleteRoute is TRUE).\r | |
1317 | @retval EFI_ACCESS_DENIED The route is already defined in the routing table (when\r | |
1318 | DeleteRoute is FALSE).\r | |
e2851998 | 1319 | \r |
772db4bb | 1320 | **/\r |
772db4bb | 1321 | EFI_STATUS\r |
1322 | EFIAPI\r | |
1323 | EfiIp4Routes (\r | |
1324 | IN EFI_IP4_PROTOCOL *This,\r | |
1325 | IN BOOLEAN DeleteRoute,\r | |
1326 | IN EFI_IPv4_ADDRESS *SubnetAddress,\r | |
1327 | IN EFI_IPv4_ADDRESS *SubnetMask,\r | |
1328 | IN EFI_IPv4_ADDRESS *GatewayAddress\r | |
1329 | )\r | |
1330 | {\r | |
1331 | IP4_PROTOCOL *IpInstance;\r | |
1332 | IP4_INTERFACE *IpIf;\r | |
1333 | IP4_ADDR Dest;\r | |
1334 | IP4_ADDR Netmask;\r | |
1335 | IP4_ADDR Nexthop;\r | |
1336 | EFI_STATUS Status;\r | |
1337 | EFI_TPL OldTpl;\r | |
1338 | \r | |
1339 | //\r | |
1340 | // First, validate the parameters\r | |
1341 | //\r | |
1342 | if ((This == NULL) || (SubnetAddress == NULL) ||\r | |
1343 | (SubnetMask == NULL) || (GatewayAddress == NULL)) {\r | |
1344 | return EFI_INVALID_PARAMETER;\r | |
1345 | }\r | |
1346 | \r | |
1347 | IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This);\r | |
e48e37fc | 1348 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r |
772db4bb | 1349 | \r |
1350 | if (IpInstance->State != IP4_STATE_CONFIGED) {\r | |
1351 | Status = EFI_NOT_STARTED;\r | |
1352 | goto ON_EXIT;\r | |
1353 | }\r | |
1354 | \r | |
1355 | if (IpInstance->ConfigData.UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) {\r | |
1356 | Status = EFI_NO_MAPPING;\r | |
1357 | goto ON_EXIT;\r | |
1358 | }\r | |
1359 | \r | |
e48e37fc | 1360 | CopyMem (&Dest, SubnetAddress, sizeof (IP4_ADDR));\r |
1361 | CopyMem (&Netmask, SubnetMask, sizeof (IP4_ADDR));\r | |
1362 | CopyMem (&Nexthop, GatewayAddress, sizeof (IP4_ADDR));\r | |
772db4bb | 1363 | \r |
1364 | Dest = NTOHL (Dest);\r | |
1365 | Netmask = NTOHL (Netmask);\r | |
1366 | Nexthop = NTOHL (Nexthop);\r | |
1367 | \r | |
1368 | IpIf = IpInstance->Interface;\r | |
1369 | \r | |
1370 | if (!IP4_IS_VALID_NETMASK (Netmask)) {\r | |
1371 | Status = EFI_INVALID_PARAMETER;\r | |
1372 | goto ON_EXIT;\r | |
1373 | }\r | |
1374 | \r | |
1375 | //\r | |
1376 | // the gateway address must be a unicast on the connected network if not zero.\r | |
1377 | //\r | |
1378 | if ((Nexthop != IP4_ALLZERO_ADDRESS) &&\r | |
1379 | (!IP4_NET_EQUAL (Nexthop, IpIf->Ip, IpIf->SubnetMask) ||\r | |
1380 | IP4_IS_BROADCAST (Ip4GetNetCast (Nexthop, IpIf)))) {\r | |
1381 | \r | |
1382 | Status = EFI_INVALID_PARAMETER;\r | |
1383 | goto ON_EXIT;\r | |
1384 | }\r | |
1385 | \r | |
1386 | if (DeleteRoute) {\r | |
1387 | Status = Ip4DelRoute (IpInstance->RouteTable, Dest, Netmask, Nexthop);\r | |
1388 | } else {\r | |
1389 | Status = Ip4AddRoute (IpInstance->RouteTable, Dest, Netmask, Nexthop);\r | |
1390 | }\r | |
1391 | \r | |
1392 | ON_EXIT:\r | |
e48e37fc | 1393 | gBS->RestoreTPL (OldTpl);\r |
772db4bb | 1394 | return Status;\r |
1395 | }\r | |
1396 | \r | |
1397 | \r | |
1398 | /**\r | |
1399 | Check whether the user's token or event has already\r | |
5405e9a6 | 1400 | been enqueued on IP4's list.\r |
772db4bb | 1401 | \r |
3e8c18da | 1402 | @param[in] Map The container of either user's transmit or receive\r |
1403 | token.\r | |
1f6729ff | 1404 | @param[in] Item Current item to check against.\r |
3e8c18da | 1405 | @param[in] Context The Token to check againist.\r |
772db4bb | 1406 | \r |
1f6729ff | 1407 | @retval EFI_ACCESS_DENIED The token or event has already been enqueued in IP.\r |
772db4bb | 1408 | @retval EFI_SUCCESS The current item isn't the same token/event as the\r |
1409 | context.\r | |
1410 | \r | |
1411 | **/\r | |
772db4bb | 1412 | EFI_STATUS\r |
e798cd87 | 1413 | EFIAPI\r |
772db4bb | 1414 | Ip4TokenExist (\r |
1415 | IN NET_MAP *Map,\r | |
1416 | IN NET_MAP_ITEM *Item,\r | |
1417 | IN VOID *Context\r | |
1418 | )\r | |
1419 | {\r | |
1420 | EFI_IP4_COMPLETION_TOKEN *Token;\r | |
1421 | EFI_IP4_COMPLETION_TOKEN *TokenInItem;\r | |
1422 | \r | |
1423 | Token = (EFI_IP4_COMPLETION_TOKEN *) Context;\r | |
1424 | TokenInItem = (EFI_IP4_COMPLETION_TOKEN *) Item->Key;\r | |
1425 | \r | |
1426 | if ((Token == TokenInItem) || (Token->Event == TokenInItem->Event)) {\r | |
1427 | return EFI_ACCESS_DENIED;\r | |
1428 | }\r | |
1429 | \r | |
1430 | return EFI_SUCCESS;\r | |
1431 | }\r | |
1432 | \r | |
772db4bb | 1433 | /**\r |
1434 | Validate the user's token against current station address.\r | |
1435 | \r | |
216f7970 | 1436 | @param[in] Token User's token to validate.\r |
1437 | @param[in] IpIf The IP4 child's interface.\r | |
1438 | @param[in] RawData Set to TRUE to send unformatted packets.\r | |
772db4bb | 1439 | \r |
216f7970 | 1440 | @retval EFI_INVALID_PARAMETER Some parameters are invalid.\r |
772db4bb | 1441 | @retval EFI_BAD_BUFFER_SIZE The user's option/data is too long.\r |
216f7970 | 1442 | @retval EFI_SUCCESS The token is valid.\r |
772db4bb | 1443 | \r |
1444 | **/\r | |
772db4bb | 1445 | EFI_STATUS\r |
1446 | Ip4TxTokenValid (\r | |
1447 | IN EFI_IP4_COMPLETION_TOKEN *Token,\r | |
216f7970 | 1448 | IN IP4_INTERFACE *IpIf,\r |
1449 | IN BOOLEAN RawData\r | |
772db4bb | 1450 | )\r |
1451 | {\r | |
1452 | EFI_IP4_TRANSMIT_DATA *TxData;\r | |
1453 | EFI_IP4_OVERRIDE_DATA *Override;\r | |
1454 | IP4_ADDR Src;\r | |
1455 | IP4_ADDR Gateway;\r | |
1456 | UINT32 Offset;\r | |
1457 | UINT32 Index;\r | |
1458 | UINT32 HeadLen;\r | |
1459 | \r | |
1460 | if ((Token == NULL) || (Token->Event == NULL) || (Token->Packet.TxData == NULL)) {\r | |
1461 | return EFI_INVALID_PARAMETER;\r | |
1462 | }\r | |
1463 | \r | |
1464 | TxData = Token->Packet.TxData;\r | |
1465 | \r | |
1466 | //\r | |
216f7970 | 1467 | // Check the fragment table: no empty fragment, and length isn't bogus.\r |
772db4bb | 1468 | //\r |
1469 | if ((TxData->TotalDataLength == 0) || (TxData->FragmentCount == 0)) {\r | |
1470 | return EFI_INVALID_PARAMETER;\r | |
1471 | }\r | |
1472 | \r | |
1473 | Offset = TxData->TotalDataLength;\r | |
1474 | \r | |
216f7970 | 1475 | if (Offset > IP4_MAX_PACKET_SIZE) {\r |
1476 | return EFI_BAD_BUFFER_SIZE;\r | |
1477 | }\r | |
1478 | \r | |
772db4bb | 1479 | for (Index = 0; Index < TxData->FragmentCount; Index++) {\r |
1480 | if ((TxData->FragmentTable[Index].FragmentBuffer == NULL) ||\r | |
1481 | (TxData->FragmentTable[Index].FragmentLength == 0)) {\r | |
1482 | \r | |
1483 | return EFI_INVALID_PARAMETER;\r | |
1484 | }\r | |
1485 | \r | |
1486 | Offset -= TxData->FragmentTable[Index].FragmentLength;\r | |
1487 | }\r | |
1488 | \r | |
1489 | if (Offset != 0) {\r | |
1490 | return EFI_INVALID_PARAMETER;\r | |
1491 | }\r | |
1492 | \r | |
216f7970 | 1493 | //\r |
1494 | // NOTE that OptionsLength/OptionsBuffer/OverrideData are ignored if RawData\r | |
1495 | // is TRUE.\r | |
1496 | //\r | |
1497 | if (RawData) {\r | |
1498 | return EFI_SUCCESS;\r | |
1499 | }\r | |
1500 | \r | |
1501 | //\r | |
1502 | // Check the IP options: no more than 40 bytes and format is OK\r | |
1503 | //\r | |
1504 | if (TxData->OptionsLength != 0) {\r | |
1505 | if ((TxData->OptionsLength > 40) || (TxData->OptionsBuffer == NULL)) {\r | |
1506 | return EFI_INVALID_PARAMETER;\r | |
1507 | }\r | |
1508 | \r | |
1509 | if (!Ip4OptionIsValid (TxData->OptionsBuffer, TxData->OptionsLength, FALSE)) {\r | |
1510 | return EFI_INVALID_PARAMETER;\r | |
1511 | }\r | |
1512 | }\r | |
1513 | \r | |
772db4bb | 1514 | //\r |
1515 | // Check the source and gateway: they must be a valid unicast.\r | |
1516 | // Gateway must also be on the connected network.\r | |
1517 | //\r | |
e2851998 | 1518 | if (TxData->OverrideData != NULL) {\r |
772db4bb | 1519 | Override = TxData->OverrideData;\r |
1520 | \r | |
e48e37fc | 1521 | CopyMem (&Src, &Override->SourceAddress, sizeof (IP4_ADDR));\r |
1522 | CopyMem (&Gateway, &Override->GatewayAddress, sizeof (IP4_ADDR));\r | |
772db4bb | 1523 | \r |
1524 | Src = NTOHL (Src);\r | |
1525 | Gateway = NTOHL (Gateway);\r | |
1526 | \r | |
1527 | if ((NetGetIpClass (Src) > IP4_ADDR_CLASSC) ||\r | |
1528 | (Src == IP4_ALLONE_ADDRESS) ||\r | |
1529 | IP4_IS_BROADCAST (Ip4GetNetCast (Src, IpIf))) {\r | |
1530 | \r | |
1531 | return EFI_INVALID_PARAMETER;\r | |
1532 | }\r | |
1533 | \r | |
1534 | //\r | |
1535 | // If gateway isn't zero, it must be a unicast address, and\r | |
1536 | // on the connected network.\r | |
1537 | //\r | |
1538 | if ((Gateway != IP4_ALLZERO_ADDRESS) &&\r | |
1539 | ((NetGetIpClass (Gateway) > IP4_ADDR_CLASSC) ||\r | |
1540 | !IP4_NET_EQUAL (Gateway, IpIf->Ip, IpIf->SubnetMask) ||\r | |
1541 | IP4_IS_BROADCAST (Ip4GetNetCast (Gateway, IpIf)))) {\r | |
1542 | \r | |
1543 | return EFI_INVALID_PARAMETER;\r | |
1544 | }\r | |
1545 | }\r | |
1546 | \r | |
1547 | //\r | |
1548 | // Check the packet length: Head length and packet length all has a limit\r | |
1549 | //\r | |
1550 | HeadLen = sizeof (IP4_HEAD) + ((TxData->OptionsLength + 3) &~0x03);\r | |
1551 | \r | |
1552 | if ((HeadLen > IP4_MAX_HEADLEN) ||\r | |
1553 | (TxData->TotalDataLength + HeadLen > IP4_MAX_PACKET_SIZE)) {\r | |
1554 | \r | |
1555 | return EFI_BAD_BUFFER_SIZE;\r | |
1556 | }\r | |
1557 | \r | |
1558 | return EFI_SUCCESS;\r | |
1559 | }\r | |
1560 | \r | |
1561 | \r | |
1562 | /**\r | |
1563 | The callback function for the net buffer which wraps the user's\r | |
1564 | transmit token. Although it seems this function is pretty simple,\r | |
1565 | there are some subtle things.\r | |
1566 | When user requests the IP to transmit a packet by passing it a\r | |
1567 | token, the token is wrapped in an IP4_TXTOKEN_WRAP and the data\r | |
1568 | is wrapped in an net buffer. the net buffer's Free function is\r | |
1569 | set to Ip4FreeTxToken. The Token and token wrap are added to the\r | |
1570 | IP child's TxToken map. Then the buffer is passed to Ip4Output for\r | |
1571 | transmission. If something error happened before that, the buffer\r | |
1572 | is freed, which in turn will free the token wrap. The wrap may\r | |
1573 | have been added to the TxToken map or not, and the user's event\r | |
1574 | shouldn't be fired because we are still in the EfiIp4Transmit. If\r | |
1575 | the buffer has been sent by Ip4Output, it should be removed from\r | |
1576 | the TxToken map and user's event signaled. The token wrap and buffer\r | |
1577 | are bound together. Check the comments in Ip4Output for information\r | |
1578 | about IP fragmentation.\r | |
1579 | \r | |
1f6729ff | 1580 | @param[in] Context The token's wrap.\r |
772db4bb | 1581 | \r |
1582 | **/\r | |
772db4bb | 1583 | VOID\r |
e798cd87 | 1584 | EFIAPI\r |
772db4bb | 1585 | Ip4FreeTxToken (\r |
1586 | IN VOID *Context\r | |
1587 | )\r | |
1588 | {\r | |
1589 | IP4_TXTOKEN_WRAP *Wrap;\r | |
1590 | NET_MAP_ITEM *Item;\r | |
1591 | \r | |
1592 | Wrap = (IP4_TXTOKEN_WRAP *) Context;\r | |
1593 | \r | |
a1503a32 | 1594 | //\r |
1595 | // Signal IpSecRecycleEvent to inform IPsec free the memory\r | |
1596 | //\r | |
1597 | if (Wrap->IpSecRecycleSignal != NULL) {\r | |
1598 | gBS->SignalEvent (Wrap->IpSecRecycleSignal);\r | |
1599 | }\r | |
1600 | \r | |
772db4bb | 1601 | //\r |
1602 | // Find the token in the instance's map. EfiIp4Transmit put the\r | |
1603 | // token to the map. If that failed, NetMapFindKey will return NULL.\r | |
1604 | //\r | |
1605 | Item = NetMapFindKey (&Wrap->IpInstance->TxTokens, Wrap->Token);\r | |
1606 | \r | |
1607 | if (Item != NULL) {\r | |
1608 | NetMapRemoveItem (&Wrap->IpInstance->TxTokens, Item, NULL);\r | |
1609 | }\r | |
1610 | \r | |
1611 | if (Wrap->Sent) {\r | |
1612 | gBS->SignalEvent (Wrap->Token->Event);\r | |
36ee91ca | 1613 | \r |
1614 | //\r | |
1615 | // Dispatch the DPC queued by the NotifyFunction of Token->Event.\r | |
1616 | //\r | |
d8d26fb2 | 1617 | DispatchDpc ();\r |
772db4bb | 1618 | }\r |
1619 | \r | |
766c7483 | 1620 | FreePool (Wrap);\r |
772db4bb | 1621 | }\r |
1622 | \r | |
1623 | \r | |
1624 | /**\r | |
1625 | The callback function to Ip4Output to update the transmit status.\r | |
1626 | \r | |
1627 | @param Ip4Instance The Ip4Instance that request the transmit.\r | |
1f6729ff | 1628 | @param Packet The user's transmit request.\r |
1629 | @param IoStatus The result of the transmission.\r | |
1630 | @param Flag Not used during transmission.\r | |
772db4bb | 1631 | @param Context The token's wrap.\r |
1632 | \r | |
772db4bb | 1633 | **/\r |
772db4bb | 1634 | VOID\r |
1635 | Ip4OnPacketSent (\r | |
1636 | IP4_PROTOCOL *Ip4Instance,\r | |
1637 | NET_BUF *Packet,\r | |
1638 | EFI_STATUS IoStatus,\r | |
1639 | UINT32 Flag,\r | |
1640 | VOID *Context\r | |
1641 | )\r | |
1642 | {\r | |
1643 | IP4_TXTOKEN_WRAP *Wrap;\r | |
1644 | \r | |
1645 | //\r | |
1646 | // This is the transmission request from upper layer,\r | |
1647 | // not the IP4 driver itself.\r | |
1648 | //\r | |
1649 | ASSERT (Ip4Instance != NULL);\r | |
1650 | \r | |
1651 | //\r | |
1652 | // The first fragment of the packet has been sent. Update\r | |
1653 | // the token's status. That is, if fragmented, the transmit's\r | |
1654 | // status is the first fragment's status. The Wrap will be\r | |
1655 | // release when all the fragments are release. Check the comments\r | |
1656 | // in Ip4FreeTxToken and Ip4Output for information.\r | |
1657 | //\r | |
1658 | Wrap = (IP4_TXTOKEN_WRAP *) Context;\r | |
1659 | Wrap->Token->Status = IoStatus;\r | |
1660 | \r | |
1661 | NetbufFree (Wrap->Packet);\r | |
1662 | }\r | |
1663 | \r | |
1664 | \r | |
1665 | /**\r | |
5405e9a6 | 1666 | Places outgoing data packets into the transmit queue.\r |
1667 | \r | |
1668 | The Transmit() function places a sending request in the transmit queue of this\r | |
1669 | EFI IPv4 Protocol instance. Whenever the packet in the token is sent out or some\r | |
1670 | errors occur, the event in the token will be signaled and the status is updated.\r | |
1671 | \r | |
3e8c18da | 1672 | @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r |
1673 | @param[in] Token Pointer to the transmit token.\r | |
5405e9a6 | 1674 | \r |
1675 | @retval EFI_SUCCESS The data has been queued for transmission.\r | |
1676 | @retval EFI_NOT_STARTED This instance has not been started.\r | |
1677 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r | |
1678 | RARP, etc.) is not finished yet.\r | |
1679 | @retval EFI_INVALID_PARAMETER One or more pameters are invalid.\r | |
1680 | @retval EFI_ACCESS_DENIED The transmit completion token with the same Token.Event\r | |
1681 | was already in the transmit queue.\r | |
1682 | @retval EFI_NOT_READY The completion token could not be queued because the transmit\r | |
e2851998 | 1683 | queue is full.\r |
5405e9a6 | 1684 | @retval EFI_NOT_FOUND Not route is found to destination address.\r |
1685 | @retval EFI_OUT_OF_RESOURCES Could not queue the transmit data.\r | |
1686 | @retval EFI_BUFFER_TOO_SMALL Token.Packet.TxData.TotalDataLength is too\r | |
1687 | short to transmit.\r | |
1688 | @retval EFI_BAD_BUFFER_SIZE The length of the IPv4 header + option length + total data length is\r | |
1689 | greater than MTU (or greater than the maximum packet size if\r | |
1690 | Token.Packet.TxData.OverrideData.\r | |
1f6729ff | 1691 | DoNotFragment is TRUE).\r |
772db4bb | 1692 | \r |
1693 | **/\r | |
772db4bb | 1694 | EFI_STATUS\r |
1695 | EFIAPI\r | |
1696 | EfiIp4Transmit (\r | |
1697 | IN EFI_IP4_PROTOCOL *This,\r | |
1698 | IN EFI_IP4_COMPLETION_TOKEN *Token\r | |
1699 | )\r | |
1700 | {\r | |
1701 | IP4_SERVICE *IpSb;\r | |
1702 | IP4_PROTOCOL *IpInstance;\r | |
1703 | IP4_INTERFACE *IpIf;\r | |
1704 | IP4_TXTOKEN_WRAP *Wrap;\r | |
1705 | EFI_IP4_TRANSMIT_DATA *TxData;\r | |
1706 | EFI_IP4_CONFIG_DATA *Config;\r | |
1707 | EFI_IP4_OVERRIDE_DATA *Override;\r | |
1708 | IP4_HEAD Head;\r | |
1709 | IP4_ADDR GateWay;\r | |
1710 | EFI_STATUS Status;\r | |
1711 | EFI_TPL OldTpl;\r | |
1712 | BOOLEAN DontFragment;\r | |
1713 | UINT32 HeadLen;\r | |
216f7970 | 1714 | UINT8 RawHdrLen;\r |
1715 | UINT32 OptionsLength;\r | |
1716 | UINT8 *OptionsBuffer;\r | |
1717 | VOID *FirstFragment;\r | |
772db4bb | 1718 | \r |
1719 | if (This == NULL) {\r | |
1720 | return EFI_INVALID_PARAMETER;\r | |
1721 | }\r | |
1722 | \r | |
1723 | IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This);\r | |
1724 | \r | |
1725 | if (IpInstance->State != IP4_STATE_CONFIGED) {\r | |
1726 | return EFI_NOT_STARTED;\r | |
1727 | }\r | |
1728 | \r | |
e48e37fc | 1729 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r |
772db4bb | 1730 | \r |
1731 | IpSb = IpInstance->Service;\r | |
1732 | IpIf = IpInstance->Interface;\r | |
1733 | Config = &IpInstance->ConfigData;\r | |
1734 | \r | |
1735 | if (Config->UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) {\r | |
1736 | Status = EFI_NO_MAPPING;\r | |
1737 | goto ON_EXIT;\r | |
1738 | }\r | |
1739 | \r | |
1740 | //\r | |
1741 | // make sure that token is properly formated\r | |
1742 | //\r | |
216f7970 | 1743 | Status = Ip4TxTokenValid (Token, IpIf, Config->RawData);\r |
772db4bb | 1744 | \r |
1745 | if (EFI_ERROR (Status)) {\r | |
1746 | goto ON_EXIT;\r | |
1747 | }\r | |
1748 | \r | |
1749 | //\r | |
1750 | // Check whether the token or signal already existed.\r | |
1751 | //\r | |
1752 | if (EFI_ERROR (NetMapIterate (&IpInstance->TxTokens, Ip4TokenExist, Token))) {\r | |
1753 | Status = EFI_ACCESS_DENIED;\r | |
1754 | goto ON_EXIT;\r | |
1755 | }\r | |
1756 | \r | |
1757 | //\r | |
1758 | // Build the IP header, need to fill in the Tos, TotalLen, Id,\r | |
1759 | // fragment, Ttl, protocol, Src, and Dst.\r | |
1760 | //\r | |
1761 | TxData = Token->Packet.TxData;\r | |
1762 | \r | |
216f7970 | 1763 | FirstFragment = NULL;\r |
772db4bb | 1764 | \r |
216f7970 | 1765 | if (Config->RawData) {\r |
1766 | //\r | |
1767 | // When RawData is TRUE, first buffer in FragmentTable points to a raw\r | |
1768 | // IPv4 fragment including IPv4 header and options.\r | |
1769 | //\r | |
1770 | FirstFragment = TxData->FragmentTable[0].FragmentBuffer;\r | |
1771 | CopyMem (&RawHdrLen, FirstFragment, sizeof (UINT8));\r | |
772db4bb | 1772 | \r |
216f7970 | 1773 | RawHdrLen = (UINT8) (RawHdrLen & 0x0f);\r |
1774 | if (RawHdrLen < 5) {\r | |
098e9f49 FS |
1775 | Status = EFI_INVALID_PARAMETER;\r |
1776 | goto ON_EXIT;\r | |
216f7970 | 1777 | }\r |
1778 | \r | |
1779 | RawHdrLen = (UINT8) (RawHdrLen << 2);\r | |
1780 | \r | |
1781 | CopyMem (&Head, FirstFragment, IP4_MIN_HEADLEN);\r | |
1782 | \r | |
1783 | Ip4NtohHead (&Head);\r | |
1784 | HeadLen = 0;\r | |
1785 | DontFragment = IP4_DO_NOT_FRAGMENT (Head.Fragment);\r | |
772db4bb | 1786 | \r |
216f7970 | 1787 | if (!DontFragment) {\r |
098e9f49 FS |
1788 | Status = EFI_INVALID_PARAMETER;\r |
1789 | goto ON_EXIT;\r | |
216f7970 | 1790 | }\r |
1791 | \r | |
1792 | GateWay = IP4_ALLZERO_ADDRESS;\r | |
1793 | \r | |
1794 | //\r | |
1795 | // Get IPv4 options from first fragment.\r | |
1796 | //\r | |
1797 | if (RawHdrLen == IP4_MIN_HEADLEN) {\r | |
1798 | OptionsLength = 0;\r | |
1799 | OptionsBuffer = NULL;\r | |
1800 | } else {\r | |
1801 | OptionsLength = RawHdrLen - IP4_MIN_HEADLEN;\r | |
1802 | OptionsBuffer = (UINT8 *) FirstFragment + IP4_MIN_HEADLEN;\r | |
1803 | }\r | |
1804 | \r | |
1805 | //\r | |
1806 | // Trim off IPv4 header and options from first fragment.\r | |
1807 | //\r | |
1808 | TxData->FragmentTable[0].FragmentBuffer = (UINT8 *) FirstFragment + RawHdrLen;\r | |
1809 | TxData->FragmentTable[0].FragmentLength = TxData->FragmentTable[0].FragmentLength - RawHdrLen;\r | |
772db4bb | 1810 | } else {\r |
216f7970 | 1811 | CopyMem (&Head.Dst, &TxData->DestinationAddress, sizeof (IP4_ADDR));\r |
1812 | Head.Dst = NTOHL (Head.Dst);\r | |
772db4bb | 1813 | \r |
216f7970 | 1814 | if (TxData->OverrideData != NULL) {\r |
1815 | Override = TxData->OverrideData;\r | |
1816 | Head.Protocol = Override->Protocol;\r | |
1817 | Head.Tos = Override->TypeOfService;\r | |
1818 | Head.Ttl = Override->TimeToLive;\r | |
1819 | DontFragment = Override->DoNotFragment;\r | |
1820 | \r | |
1821 | CopyMem (&Head.Src, &Override->SourceAddress, sizeof (IP4_ADDR));\r | |
1822 | CopyMem (&GateWay, &Override->GatewayAddress, sizeof (IP4_ADDR));\r | |
1823 | \r | |
1824 | Head.Src = NTOHL (Head.Src);\r | |
1825 | GateWay = NTOHL (GateWay);\r | |
1826 | } else {\r | |
1827 | Head.Src = IpIf->Ip;\r | |
1828 | GateWay = IP4_ALLZERO_ADDRESS;\r | |
1829 | Head.Protocol = Config->DefaultProtocol;\r | |
1830 | Head.Tos = Config->TypeOfService;\r | |
1831 | Head.Ttl = Config->TimeToLive;\r | |
1832 | DontFragment = Config->DoNotFragment;\r | |
1833 | }\r | |
1834 | \r | |
1835 | Head.Fragment = IP4_HEAD_FRAGMENT_FIELD (DontFragment, FALSE, 0);\r | |
1836 | HeadLen = (TxData->OptionsLength + 3) & (~0x03);\r | |
1837 | \r | |
1838 | OptionsLength = TxData->OptionsLength;\r | |
1839 | OptionsBuffer = (UINT8 *) (TxData->OptionsBuffer);\r | |
1840 | }\r | |
772db4bb | 1841 | \r |
1842 | //\r | |
1843 | // If don't fragment and fragment needed, return error\r | |
1844 | //\r | |
a1503a32 | 1845 | if (DontFragment && (TxData->TotalDataLength + HeadLen > IpSb->MaxPacketSize)) {\r |
772db4bb | 1846 | Status = EFI_BAD_BUFFER_SIZE;\r |
1847 | goto ON_EXIT;\r | |
1848 | }\r | |
1849 | \r | |
1850 | //\r | |
1851 | // OK, it survives all the validation check. Wrap the token in\r | |
1852 | // a IP4_TXTOKEN_WRAP and the data in a netbuf\r | |
1853 | //\r | |
1854 | Status = EFI_OUT_OF_RESOURCES;\r | |
f6b7393c | 1855 | Wrap = AllocateZeroPool (sizeof (IP4_TXTOKEN_WRAP));\r |
772db4bb | 1856 | if (Wrap == NULL) {\r |
1857 | goto ON_EXIT;\r | |
1858 | }\r | |
1859 | \r | |
1860 | Wrap->IpInstance = IpInstance;\r | |
1861 | Wrap->Token = Token;\r | |
1862 | Wrap->Sent = FALSE;\r | |
1863 | Wrap->Life = IP4_US_TO_SEC (Config->TransmitTimeout);\r | |
1864 | Wrap->Packet = NetbufFromExt (\r | |
1865 | (NET_FRAGMENT *) TxData->FragmentTable,\r | |
1866 | TxData->FragmentCount,\r | |
1867 | IP4_MAX_HEADLEN,\r | |
1868 | 0,\r | |
1869 | Ip4FreeTxToken,\r | |
1870 | Wrap\r | |
1871 | );\r | |
1872 | \r | |
1873 | if (Wrap->Packet == NULL) {\r | |
766c7483 | 1874 | FreePool (Wrap);\r |
772db4bb | 1875 | goto ON_EXIT;\r |
1876 | }\r | |
1877 | \r | |
1878 | Token->Status = EFI_NOT_READY;\r | |
1879 | \r | |
1880 | if (EFI_ERROR (NetMapInsertTail (&IpInstance->TxTokens, Token, Wrap))) {\r | |
1881 | //\r | |
1882 | // NetbufFree will call Ip4FreeTxToken, which in turn will\r | |
1883 | // free the IP4_TXTOKEN_WRAP. Now, the token wrap hasn't been\r | |
1884 | // enqueued.\r | |
1885 | //\r | |
216f7970 | 1886 | if (Config->RawData) {\r |
1887 | //\r | |
1888 | // Restore pointer of first fragment in RawData mode.\r | |
1889 | //\r | |
1890 | TxData->FragmentTable[0].FragmentBuffer = (UINT8 *) FirstFragment;\r | |
1891 | }\r | |
1892 | \r | |
772db4bb | 1893 | NetbufFree (Wrap->Packet);\r |
1894 | goto ON_EXIT;\r | |
1895 | }\r | |
1896 | \r | |
36ee91ca | 1897 | //\r |
1898 | // Mark the packet sent before output it. Mark it not sent again if the\r | |
1899 | // returned status is not EFI_SUCCESS;\r | |
1900 | //\r | |
1901 | Wrap->Sent = TRUE;\r | |
1902 | \r | |
772db4bb | 1903 | Status = Ip4Output (\r |
1904 | IpSb,\r | |
1905 | IpInstance,\r | |
1906 | Wrap->Packet,\r | |
1907 | &Head,\r | |
216f7970 | 1908 | OptionsBuffer,\r |
1909 | OptionsLength,\r | |
772db4bb | 1910 | GateWay,\r |
1911 | Ip4OnPacketSent,\r | |
1912 | Wrap\r | |
1913 | );\r | |
1914 | \r | |
1915 | if (EFI_ERROR (Status)) {\r | |
36ee91ca | 1916 | Wrap->Sent = FALSE;\r |
216f7970 | 1917 | \r |
1918 | if (Config->RawData) {\r | |
1919 | //\r | |
1920 | // Restore pointer of first fragment in RawData mode.\r | |
1921 | //\r | |
1922 | TxData->FragmentTable[0].FragmentBuffer = (UINT8 *) FirstFragment;\r | |
1923 | }\r | |
1924 | \r | |
772db4bb | 1925 | NetbufFree (Wrap->Packet);\r |
772db4bb | 1926 | }\r |
1927 | \r | |
216f7970 | 1928 | if (Config->RawData) {\r |
1929 | //\r | |
1930 | // Restore pointer of first fragment in RawData mode.\r | |
1931 | //\r | |
1932 | TxData->FragmentTable[0].FragmentBuffer = (UINT8 *) FirstFragment;\r | |
1933 | }\r | |
1934 | \r | |
772db4bb | 1935 | ON_EXIT:\r |
e48e37fc | 1936 | gBS->RestoreTPL (OldTpl);\r |
772db4bb | 1937 | return Status;\r |
1938 | }\r | |
1939 | \r | |
1940 | \r | |
1941 | /**\r | |
5405e9a6 | 1942 | Places a receiving request into the receiving queue.\r |
e2851998 | 1943 | \r |
5405e9a6 | 1944 | The Receive() function places a completion token into the receive packet queue.\r |
1945 | This function is always asynchronous.\r | |
e2851998 | 1946 | \r |
5405e9a6 | 1947 | The Token.Event field in the completion token must be filled in by the caller\r |
1948 | and cannot be NULL. When the receive operation completes, the EFI IPv4 Protocol\r | |
1949 | driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event\r | |
1950 | is signaled.\r | |
1951 | \r | |
3e8c18da | 1952 | @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r |
1953 | @param[in] Token Pointer to a token that is associated with the receive data descriptor.\r | |
5405e9a6 | 1954 | \r |
1955 | @retval EFI_SUCCESS The receive completion token was cached.\r | |
1956 | @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.\r | |
1957 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, RARP, etc.)\r | |
1958 | is not finished yet.\r | |
1959 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r | |
1960 | - This is NULL.\r | |
1961 | - Token is NULL.\r | |
1962 | - Token.Event is NULL.\r | |
1963 | @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system\r | |
1964 | resources (usually memory).\r | |
1965 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r | |
1966 | The EFI IPv4 Protocol instance has been reset to startup defaults.\r | |
1967 | EFI_ACCESS_DENIED The receive completion token with the same Token.Event was already\r | |
1968 | in the receive queue.\r | |
1969 | @retval EFI_NOT_READY The receive request could not be queued because the receive queue is full.\r | |
1970 | @retval EFI_ICMP_ERROR An ICMP error packet was received.\r | |
772db4bb | 1971 | \r |
1972 | **/\r | |
772db4bb | 1973 | EFI_STATUS\r |
1974 | EFIAPI\r | |
1975 | EfiIp4Receive (\r | |
1976 | IN EFI_IP4_PROTOCOL *This,\r | |
1977 | IN EFI_IP4_COMPLETION_TOKEN *Token\r | |
1978 | )\r | |
1979 | {\r | |
1980 | IP4_PROTOCOL *IpInstance;\r | |
772db4bb | 1981 | EFI_STATUS Status;\r |
1982 | EFI_TPL OldTpl;\r | |
1983 | \r | |
1984 | //\r | |
1985 | // First validate the parameters\r | |
1986 | //\r | |
1987 | if ((This == NULL) || (Token == NULL) || (Token->Event == NULL)) {\r | |
1988 | return EFI_INVALID_PARAMETER;\r | |
1989 | }\r | |
1990 | \r | |
1991 | IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This);\r | |
1992 | \r | |
e48e37fc | 1993 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r |
772db4bb | 1994 | \r |
1995 | if (IpInstance->State != IP4_STATE_CONFIGED) {\r | |
1996 | Status = EFI_NOT_STARTED;\r | |
1997 | goto ON_EXIT;\r | |
1998 | }\r | |
1999 | \r | |
772db4bb | 2000 | //\r |
2001 | // Check whether the toke is already on the receive queue.\r | |
2002 | //\r | |
2003 | Status = NetMapIterate (&IpInstance->RxTokens, Ip4TokenExist, Token);\r | |
2004 | \r | |
2005 | if (EFI_ERROR (Status)) {\r | |
2006 | Status = EFI_ACCESS_DENIED;\r | |
2007 | goto ON_EXIT;\r | |
2008 | }\r | |
2009 | \r | |
2010 | //\r | |
2011 | // Queue the token then check whether there is pending received packet.\r | |
2012 | //\r | |
2013 | Status = NetMapInsertTail (&IpInstance->RxTokens, Token, NULL);\r | |
2014 | \r | |
2015 | if (EFI_ERROR (Status)) {\r | |
2016 | goto ON_EXIT;\r | |
2017 | }\r | |
2018 | \r | |
2019 | Status = Ip4InstanceDeliverPacket (IpInstance);\r | |
2020 | \r | |
36ee91ca | 2021 | //\r |
2022 | // Dispatch the DPC queued by the NotifyFunction of this instane's receive\r | |
2023 | // event.\r | |
2024 | //\r | |
d8d26fb2 | 2025 | DispatchDpc ();\r |
36ee91ca | 2026 | \r |
772db4bb | 2027 | ON_EXIT:\r |
e48e37fc | 2028 | gBS->RestoreTPL (OldTpl);\r |
772db4bb | 2029 | return Status;\r |
2030 | }\r | |
2031 | \r | |
2032 | \r | |
2033 | /**\r | |
2034 | Cancel the transmitted but not recycled packet. If a matching\r | |
2035 | token is found, it will call Ip4CancelPacket to cancel the\r | |
2036 | packet. Ip4CancelPacket will cancel all the fragments of the\r | |
2037 | packet. When all the fragments are freed, the IP4_TXTOKEN_WRAP\r | |
2038 | will be deleted from the Map, and user's event signalled.\r | |
2039 | Because Ip4CancelPacket and other functions are all called in\r | |
2040 | line, so, after Ip4CancelPacket returns, the Item has been freed.\r | |
2041 | \r | |
1f6729ff | 2042 | @param[in] Map The IP4 child's transmit queue.\r |
2043 | @param[in] Item The current transmitted packet to test.\r | |
2044 | @param[in] Context The user's token to cancel.\r | |
772db4bb | 2045 | \r |
2046 | @retval EFI_SUCCESS Continue to check the next Item.\r | |
2047 | @retval EFI_ABORTED The user's Token (Token != NULL) is cancelled.\r | |
2048 | \r | |
2049 | **/\r | |
772db4bb | 2050 | EFI_STATUS\r |
e798cd87 | 2051 | EFIAPI\r |
772db4bb | 2052 | Ip4CancelTxTokens (\r |
2053 | IN NET_MAP *Map,\r | |
2054 | IN NET_MAP_ITEM *Item,\r | |
2055 | IN VOID *Context\r | |
2056 | )\r | |
2057 | {\r | |
2058 | EFI_IP4_COMPLETION_TOKEN *Token;\r | |
2059 | IP4_TXTOKEN_WRAP *Wrap;\r | |
2060 | \r | |
2061 | Token = (EFI_IP4_COMPLETION_TOKEN *) Context;\r | |
2062 | \r | |
2063 | //\r | |
2064 | // Return EFI_SUCCESS to check the next item in the map if\r | |
2065 | // this one doesn't match.\r | |
2066 | //\r | |
2067 | if ((Token != NULL) && (Token != Item->Key)) {\r | |
2068 | return EFI_SUCCESS;\r | |
2069 | }\r | |
2070 | \r | |
2071 | Wrap = (IP4_TXTOKEN_WRAP *) Item->Value;\r | |
2072 | ASSERT (Wrap != NULL);\r | |
2073 | \r | |
2074 | //\r | |
2075 | // Don't access the Item, Wrap and Token's members after this point.\r | |
2076 | // Item and wrap has been freed. And we no longer own the Token.\r | |
2077 | //\r | |
2078 | Ip4CancelPacket (Wrap->IpInstance->Interface, Wrap->Packet, EFI_ABORTED);\r | |
2079 | \r | |
2080 | //\r | |
2081 | // If only one item is to be cancel, return EFI_ABORTED to stop\r | |
2082 | // iterating the map any more.\r | |
2083 | //\r | |
2084 | if (Token != NULL) {\r | |
2085 | return EFI_ABORTED;\r | |
2086 | }\r | |
2087 | \r | |
2088 | return EFI_SUCCESS;\r | |
2089 | }\r | |
2090 | \r | |
2091 | \r | |
2092 | /**\r | |
2093 | Cancel the receive request. This is quiet simple, because\r | |
2094 | it is only enqueued in our local receive map.\r | |
2095 | \r | |
1f6729ff | 2096 | @param[in] Map The IP4 child's receive queue.\r |
2097 | @param[in] Item Current receive request to cancel.\r | |
2098 | @param[in] Context The user's token to cancel.\r | |
772db4bb | 2099 | \r |
2100 | @retval EFI_SUCCESS Continue to check the next receive request on the\r | |
2101 | queue.\r | |
2102 | @retval EFI_ABORTED The user's token (token != NULL) has been\r | |
2103 | cancelled.\r | |
2104 | \r | |
2105 | **/\r | |
772db4bb | 2106 | EFI_STATUS\r |
e798cd87 | 2107 | EFIAPI\r |
772db4bb | 2108 | Ip4CancelRxTokens (\r |
2109 | IN NET_MAP *Map,\r | |
2110 | IN NET_MAP_ITEM *Item,\r | |
2111 | IN VOID *Context\r | |
2112 | )\r | |
2113 | {\r | |
2114 | EFI_IP4_COMPLETION_TOKEN *Token;\r | |
2115 | EFI_IP4_COMPLETION_TOKEN *This;\r | |
2116 | \r | |
2117 | Token = (EFI_IP4_COMPLETION_TOKEN *) Context;\r | |
2118 | This = Item->Key;\r | |
2119 | \r | |
2120 | if ((Token != NULL) && (Token != This)) {\r | |
2121 | return EFI_SUCCESS;\r | |
2122 | }\r | |
2123 | \r | |
2124 | NetMapRemoveItem (Map, Item, NULL);\r | |
2125 | \r | |
2126 | This->Status = EFI_ABORTED;\r | |
2127 | This->Packet.RxData = NULL;\r | |
2128 | gBS->SignalEvent (This->Event);\r | |
2129 | \r | |
2130 | if (Token != NULL) {\r | |
2131 | return EFI_ABORTED;\r | |
2132 | }\r | |
2133 | \r | |
2134 | return EFI_SUCCESS;\r | |
2135 | }\r | |
2136 | \r | |
2137 | \r | |
2138 | /**\r | |
2139 | Cancel the user's receive/transmit request.\r | |
2140 | \r | |
1f6729ff | 2141 | @param[in] IpInstance The IP4 child.\r |
3e8c18da | 2142 | @param[in] Token The token to cancel. If NULL, all token will be\r |
772db4bb | 2143 | cancelled.\r |
2144 | \r | |
1f6729ff | 2145 | @retval EFI_SUCCESS The token is cancelled.\r |
772db4bb | 2146 | @retval EFI_NOT_FOUND The token isn't found on either the\r |
1f6729ff | 2147 | transmit/receive queue.\r |
772db4bb | 2148 | @retval EFI_DEVICE_ERROR Not all token is cancelled when Token is NULL.\r |
2149 | \r | |
2150 | **/\r | |
2151 | EFI_STATUS\r | |
2152 | Ip4Cancel (\r | |
2153 | IN IP4_PROTOCOL *IpInstance,\r | |
2154 | IN EFI_IP4_COMPLETION_TOKEN *Token OPTIONAL\r | |
2155 | )\r | |
2156 | {\r | |
2157 | EFI_STATUS Status;\r | |
2158 | \r | |
2159 | //\r | |
2160 | // First check the transmitted packet. Ip4CancelTxTokens returns\r | |
2161 | // EFI_ABORTED to mean that the token has been cancelled when\r | |
2162 | // token != NULL. So, return EFI_SUCCESS for this condition.\r | |
2163 | //\r | |
2164 | Status = NetMapIterate (&IpInstance->TxTokens, Ip4CancelTxTokens, Token);\r | |
2165 | \r | |
2166 | if (EFI_ERROR (Status)) {\r | |
2167 | if ((Token != NULL) && (Status == EFI_ABORTED)) {\r | |
2168 | return EFI_SUCCESS;\r | |
2169 | }\r | |
2170 | \r | |
2171 | return Status;\r | |
2172 | }\r | |
2173 | \r | |
2174 | //\r | |
2175 | // Check the receive queue. Ip4CancelRxTokens also returns EFI_ABORT\r | |
2176 | // for Token!=NULL and it is cancelled.\r | |
2177 | //\r | |
2178 | Status = NetMapIterate (&IpInstance->RxTokens, Ip4CancelRxTokens, Token);\r | |
36ee91ca | 2179 | //\r |
2180 | // Dispatch the DPCs queued by the NotifyFunction of the canceled rx token's\r | |
2181 | // events.\r | |
2182 | //\r | |
d8d26fb2 | 2183 | DispatchDpc ();\r |
772db4bb | 2184 | if (EFI_ERROR (Status)) {\r |
2185 | if ((Token != NULL) && (Status == EFI_ABORTED)) {\r | |
2186 | return EFI_SUCCESS;\r | |
2187 | }\r | |
2188 | \r | |
2189 | return Status;\r | |
2190 | }\r | |
2191 | \r | |
2192 | //\r | |
2193 | // OK, if the Token is found when Token != NULL, the NetMapIterate\r | |
2194 | // will return EFI_ABORTED, which has been interrupted as EFI_SUCCESS.\r | |
2195 | //\r | |
2196 | if (Token != NULL) {\r | |
2197 | return EFI_NOT_FOUND;\r | |
2198 | }\r | |
2199 | \r | |
2200 | //\r | |
2201 | // If Token == NULL, cancel all the tokens. return error if no\r | |
2202 | // all of them are cancelled.\r | |
2203 | //\r | |
2204 | if (!NetMapIsEmpty (&IpInstance->TxTokens) ||\r | |
2205 | !NetMapIsEmpty (&IpInstance->RxTokens)) {\r | |
2206 | \r | |
2207 | return EFI_DEVICE_ERROR;\r | |
2208 | }\r | |
2209 | \r | |
2210 | return EFI_SUCCESS;\r | |
2211 | }\r | |
2212 | \r | |
2213 | \r | |
2214 | /**\r | |
5405e9a6 | 2215 | Abort an asynchronous transmit or receive request.\r |
e2851998 | 2216 | \r |
5405e9a6 | 2217 | The Cancel() function is used to abort a pending transmit or receive request.\r |
2218 | If the token is in the transmit or receive request queues, after calling this\r | |
2219 | function, Token->Status will be set to EFI_ABORTED and then Token->Event will\r | |
2220 | be signaled. If the token is not in one of the queues, which usually means the\r | |
2221 | asynchronous operation has completed, this function will not signal the token\r | |
2222 | and EFI_NOT_FOUND is returned.\r | |
2223 | \r | |
3e8c18da | 2224 | @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r |
2225 | @param[in] Token Pointer to a token that has been issued by\r | |
2226 | EFI_IP4_PROTOCOL.Transmit() or\r | |
2227 | EFI_IP4_PROTOCOL.Receive(). If NULL, all pending\r | |
2228 | tokens are aborted. Type EFI_IP4_COMPLETION_TOKEN is\r | |
2229 | defined in EFI_IP4_PROTOCOL.Transmit().\r | |
5405e9a6 | 2230 | \r |
2231 | @retval EFI_SUCCESS The asynchronous I/O request was aborted and\r | |
2232 | Token.->Event was signaled. When Token is NULL, all\r | |
2233 | pending requests were aborted and their events were signaled.\r | |
2234 | @retval EFI_INVALID_PARAMETER This is NULL.\r | |
2235 | @retval EFI_NOT_STARTED This instance has not been started.\r | |
2236 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r | |
2237 | RARP, etc.) is not finished yet.\r | |
2238 | @retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O request was\r | |
2239 | not found in the transmit or receive queue. It has either completed\r | |
2240 | or was not issued by Transmit() and Receive().\r | |
772db4bb | 2241 | \r |
2242 | **/\r | |
772db4bb | 2243 | EFI_STATUS\r |
2244 | EFIAPI\r | |
2245 | EfiIp4Cancel (\r | |
2246 | IN EFI_IP4_PROTOCOL *This,\r | |
2247 | IN EFI_IP4_COMPLETION_TOKEN *Token OPTIONAL\r | |
2248 | )\r | |
2249 | {\r | |
2250 | IP4_PROTOCOL *IpInstance;\r | |
2251 | EFI_STATUS Status;\r | |
2252 | EFI_TPL OldTpl;\r | |
2253 | \r | |
2254 | if (This == NULL) {\r | |
2255 | return EFI_INVALID_PARAMETER;\r | |
2256 | }\r | |
2257 | \r | |
2258 | IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This);\r | |
2259 | \r | |
e48e37fc | 2260 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r |
772db4bb | 2261 | \r |
2262 | if (IpInstance->State != IP4_STATE_CONFIGED) {\r | |
2263 | Status = EFI_NOT_STARTED;\r | |
2264 | goto ON_EXIT;\r | |
2265 | }\r | |
2266 | \r | |
2267 | if (IpInstance->ConfigData.UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) {\r | |
2268 | Status = EFI_NO_MAPPING;\r | |
2269 | goto ON_EXIT;\r | |
2270 | }\r | |
2271 | \r | |
2272 | Status = Ip4Cancel (IpInstance, Token);\r | |
2273 | \r | |
2274 | ON_EXIT:\r | |
e48e37fc | 2275 | gBS->RestoreTPL (OldTpl);\r |
772db4bb | 2276 | return Status;\r |
2277 | }\r | |
2278 | \r | |
2279 | \r | |
2280 | /**\r | |
5405e9a6 | 2281 | Polls for incoming data packets and processes outgoing data packets.\r |
e2851998 | 2282 | \r |
5405e9a6 | 2283 | The Poll() function polls for incoming data packets and processes outgoing data\r |
2284 | packets. Network drivers and applications can call the EFI_IP4_PROTOCOL.Poll()\r | |
2285 | function to increase the rate that data packets are moved between the communications\r | |
2286 | device and the transmit and receive queues.\r | |
e2851998 | 2287 | \r |
5405e9a6 | 2288 | In some systems the periodic timer event may not poll the underlying communications\r |
2289 | device fast enough to transmit and/or receive all data packets without missing\r | |
2290 | incoming packets or dropping outgoing packets. Drivers and applications that are\r | |
2291 | experiencing packet loss should try calling the EFI_IP4_PROTOCOL.Poll() function\r | |
2292 | more often.\r | |
2293 | \r | |
3e8c18da | 2294 | @param[in] This Pointer to the EFI_IP4_PROTOCOL instance.\r |
5405e9a6 | 2295 | \r |
2296 | @retval EFI_SUCCESS Incoming or outgoing data was processed.\r | |
2297 | @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.\r | |
2298 | @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r | |
2299 | RARP, etc.) is not finished yet.\r | |
2300 | @retval EFI_INVALID_PARAMETER This is NULL.\r | |
2301 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r | |
2302 | @retval EFI_NOT_READY No incoming or outgoing data is processed.\r | |
2303 | @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue.\r | |
2304 | Consider increasing the polling rate.\r | |
772db4bb | 2305 | \r |
2306 | **/\r | |
772db4bb | 2307 | EFI_STATUS\r |
2308 | EFIAPI\r | |
2309 | EfiIp4Poll (\r | |
2310 | IN EFI_IP4_PROTOCOL *This\r | |
2311 | )\r | |
2312 | {\r | |
2313 | IP4_PROTOCOL *IpInstance;\r | |
2314 | EFI_MANAGED_NETWORK_PROTOCOL *Mnp;\r | |
2315 | \r | |
2316 | if (This == NULL) {\r | |
2317 | return EFI_INVALID_PARAMETER;\r | |
2318 | }\r | |
2319 | \r | |
2320 | IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This);\r | |
2321 | \r | |
2322 | if (IpInstance->State == IP4_STATE_UNCONFIGED) {\r | |
2323 | return EFI_NOT_STARTED;\r | |
2324 | }\r | |
2325 | \r | |
2326 | Mnp = IpInstance->Service->Mnp;\r | |
2327 | \r | |
2328 | //\r | |
2329 | // Don't lock the Poll function to enable the deliver of\r | |
2330 | // the packet polled up.\r | |
2331 | //\r | |
2332 | return Mnp->Poll (Mnp);\r | |
2333 | }\r | |
2334 | \r | |
772db4bb | 2335 | /**\r |
2336 | Decrease the life of the transmitted packets. If it is\r | |
2337 | decreased to zero, cancel the packet. This function is\r | |
96e1079f | 2338 | called by Ip4PacketTimerTicking which time out both the\r |
772db4bb | 2339 | received-but-not-delivered and transmitted-but-not-recycle\r |
2340 | packets.\r | |
2341 | \r | |
3e8c18da | 2342 | @param[in] Map The IP4 child's transmit map.\r |
1f6729ff | 2343 | @param[in] Item Current transmitted packet.\r |
3e8c18da | 2344 | @param[in] Context Not used.\r |
772db4bb | 2345 | \r |
1f6729ff | 2346 | @retval EFI_SUCCESS Always returns EFI_SUCCESS.\r |
772db4bb | 2347 | \r |
2348 | **/\r | |
2349 | EFI_STATUS\r | |
e798cd87 | 2350 | EFIAPI\r |
772db4bb | 2351 | Ip4SentPacketTicking (\r |
2352 | IN NET_MAP *Map,\r | |
2353 | IN NET_MAP_ITEM *Item,\r | |
2354 | IN VOID *Context\r | |
2355 | )\r | |
2356 | {\r | |
2357 | IP4_TXTOKEN_WRAP *Wrap;\r | |
2358 | \r | |
2359 | Wrap = (IP4_TXTOKEN_WRAP *) Item->Value;\r | |
2360 | ASSERT (Wrap != NULL);\r | |
2361 | \r | |
2362 | if ((Wrap->Life > 0) && (--Wrap->Life == 0)) {\r | |
2363 | Ip4CancelPacket (Wrap->IpInstance->Interface, Wrap->Packet, EFI_ABORTED);\r | |
2364 | }\r | |
2365 | \r | |
2366 | return EFI_SUCCESS;\r | |
2367 | }\r | |
2368 | \r | |
2369 | \r | |
2370 | /**\r | |
2c320007 JW |
2371 | There are two steps for this the heart beat timer of IP4 service instance. \r |
2372 | First, it times out all of its IP4 children's received-but-not-delivered \r | |
2373 | and transmitted-but-not-recycle packets, and provides time input for its \r | |
2374 | IGMP protocol.\r | |
2375 | Second, a dedicated timer is used to poll underlying media status. In case \r | |
2376 | of cable swap, a new round auto configuration will be initiated. The timer \r | |
2377 | will signal the IP4 to run DHCP configuration again. IP4 driver will free\r | |
2378 | old IP address related resource, such as route table and Interface, then\r | |
2379 | initiate a DHCP process to acquire new IP, eventually create route table \r | |
2380 | for new IP address.\r | |
772db4bb | 2381 | \r |
3e8c18da | 2382 | @param[in] Event The IP4 service instance's heart beat timer.\r |
2383 | @param[in] Context The IP4 service instance.\r | |
772db4bb | 2384 | \r |
2385 | **/\r | |
2386 | VOID\r | |
2387 | EFIAPI\r | |
2388 | Ip4TimerTicking (\r | |
2389 | IN EFI_EVENT Event,\r | |
2390 | IN VOID *Context\r | |
2391 | )\r | |
2392 | {\r | |
2393 | IP4_SERVICE *IpSb;\r | |
2c320007 JW |
2394 | BOOLEAN OldMediaPresent;\r |
2395 | EFI_STATUS Status;\r | |
2396 | EFI_SIMPLE_NETWORK_MODE SnpModeData;\r | |
772db4bb | 2397 | \r |
2398 | IpSb = (IP4_SERVICE *) Context;\r | |
2399 | NET_CHECK_SIGNATURE (IpSb, IP4_SERVICE_SIGNATURE);\r | |
2c320007 JW |
2400 | \r |
2401 | OldMediaPresent = IpSb->MediaPresent;\r | |
772db4bb | 2402 | \r |
2403 | Ip4PacketTimerTicking (IpSb);\r | |
2404 | Ip4IgmpTicking (IpSb);\r | |
2c320007 JW |
2405 | \r |
2406 | //\r | |
2407 | // Get fresh mode data from MNP, since underlying media status may change. \r | |
2408 | // Here, it needs to mention that the MediaPresent can also be checked even if \r | |
2409 | // EFI_NOT_STARTED returned while this MNP child driver instance isn't configured.\r | |
2410 | //\r | |
2411 | Status = IpSb->Mnp->GetModeData (IpSb->Mnp, NULL, &SnpModeData);\r | |
2412 | if (EFI_ERROR (Status) && (Status != EFI_NOT_STARTED)) {\r | |
2413 | return;\r | |
2414 | }\r | |
2415 | \r | |
2416 | IpSb->MediaPresent = SnpModeData.MediaPresent;\r | |
2417 | //\r | |
2418 | // Media transimit Unpresent to Present means new link movement is detected.\r | |
2419 | //\r | |
2420 | if (!OldMediaPresent && IpSb->MediaPresent) {\r | |
2421 | //\r | |
2422 | // Signal the IP4 to run the dhcp configuration again. IP4 driver will free\r | |
2423 | // old IP address related resource, such as route table and Interface, then \r | |
2424 | // initiate a DHCP round to acquire new IP, eventually \r | |
2425 | // create route table for new IP address.\r | |
2426 | //\r | |
2427 | if (IpSb->ReconfigEvent != NULL) {\r | |
2428 | Status = gBS->SignalEvent (IpSb->ReconfigEvent);\r | |
2429 | DispatchDpc ();\r | |
2430 | }\r | |
2431 | }\r | |
772db4bb | 2432 | }\r |