1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
|
/** @file
Interface routines for PxeBc.
Copyright (c) 2007 - 2017, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include "PxeBcImpl.h"
UINT32 mPxeDhcpTimeout[4] = { 4, 8, 16, 32 };
/**
Get and record the arp cache.
@param This Pointer to EFI_PXE_BC_PROTOCOL
@retval EFI_SUCCESS Arp cache updated successfully
@retval others If error occurs when getting arp cache
**/
EFI_STATUS
UpdateArpCache (
IN EFI_PXE_BASE_CODE_PROTOCOL * This
)
{
PXEBC_PRIVATE_DATA *Private;
EFI_PXE_BASE_CODE_MODE *Mode;
EFI_STATUS Status;
UINT32 EntryLength;
UINT32 EntryCount;
EFI_ARP_FIND_DATA *Entries;
UINT32 Index;
Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);
Mode = Private->PxeBc.Mode;
Status = Private->Arp->Find (
Private->Arp,
TRUE,
NULL,
&EntryLength,
&EntryCount,
&Entries,
TRUE
);
if (EFI_ERROR (Status)) {
return Status;
}
Mode->ArpCacheEntries = MIN (
EntryCount,
EFI_PXE_BASE_CODE_MAX_ARP_ENTRIES
);
for (Index = 0; Index < Mode->ArpCacheEntries; Index ++) {
CopyMem (
&Mode->ArpCache[Index].IpAddr,
Entries + 1,
Entries->SwAddressLength
);
CopyMem (
&Mode->ArpCache[Index].MacAddr,
(UINT8 *) (Entries + 1) + Entries->SwAddressLength,
Entries->HwAddressLength
);
//
// Slip to the next FindData.
//
Entries = (EFI_ARP_FIND_DATA *) ((UINT8 *) Entries + EntryLength);
}
return EFI_SUCCESS;
}
/**
Timeout routine to update arp cache.
@param Event Pointer to EFI_PXE_BC_PROTOCOL
@param Context Context of the timer event
**/
VOID
EFIAPI
ArpCacheUpdateTimeout (
IN EFI_EVENT Event,
IN VOID *Context
)
{
UpdateArpCache ((EFI_PXE_BASE_CODE_PROTOCOL *) Context);
}
/**
Do arp resolution from arp cache in PxeBcMode.
@param PxeBcMode The PXE BC mode to look into.
@param Ip4Addr The Ip4 address for resolution.
@param MacAddress The resoluted MAC address if the resolution is successful.
The value is undefined if resolution fails.
@retval TRUE The resolution is successful.
@retval FALSE Otherwise.
**/
BOOLEAN
FindInArpCache (
IN EFI_PXE_BASE_CODE_MODE *PxeBcMode,
IN EFI_IPv4_ADDRESS *Ip4Addr,
OUT EFI_MAC_ADDRESS *MacAddress
)
{
UINT32 Index;
for (Index = 0; Index < PxeBcMode->ArpCacheEntries; Index ++) {
if (EFI_IP4_EQUAL (&PxeBcMode->ArpCache[Index].IpAddr.v4, Ip4Addr)) {
CopyMem (
MacAddress,
&PxeBcMode->ArpCache[Index].MacAddr,
sizeof (EFI_MAC_ADDRESS)
);
return TRUE;
}
}
return FALSE;
}
/**
Notify function for the ICMP receive token, used to process
the received ICMP packets.
@param Context The PXEBC private data.
**/
VOID
EFIAPI
IcmpErrorListenHandlerDpc (
IN VOID *Context
)
{
EFI_STATUS Status;
EFI_IP4_RECEIVE_DATA *RxData;
EFI_IP4_PROTOCOL *Ip4;
PXEBC_PRIVATE_DATA *Private;
EFI_PXE_BASE_CODE_MODE *Mode;
UINTN Index;
UINT32 CopiedLen;
UINT8 *CopiedPointer;
Private = (PXEBC_PRIVATE_DATA *) Context;
Mode = &Private->Mode;
Status = Private->IcmpErrorRcvToken.Status;
RxData = Private->IcmpErrorRcvToken.Packet.RxData;
Ip4 = Private->Ip4;
if (Status == EFI_ABORTED) {
//
// The reception is actively aborted by the consumer, directly return.
//
return;
}
if (RxData == NULL) {
goto Resume;
}
if (Status != EFI_ICMP_ERROR) {
//
// The return status should be recognized as EFI_ICMP_ERROR.
//
goto CleanUp;
}
if (EFI_IP4 (RxData->Header->SourceAddress) != 0 &&
(NTOHL (Mode->SubnetMask.Addr[0]) != 0) &&
IP4_NET_EQUAL (NTOHL(Mode->StationIp.Addr[0]), EFI_NTOHL (RxData->Header->SourceAddress), NTOHL (Mode->SubnetMask.Addr[0])) &&
!NetIp4IsUnicast (EFI_NTOHL (RxData->Header->SourceAddress), NTOHL (Mode->SubnetMask.Addr[0]))) {
//
// The source address is not zero and it's not a unicast IP address, discard it.
//
goto CleanUp;
}
if (!EFI_IP4_EQUAL (&RxData->Header->DestinationAddress, &Mode->StationIp.v4)) {
//
// The dest address is not equal to Station Ip address, discard it.
//
goto CleanUp;
}
//
// Constructor ICMP error packet
//
CopiedLen = 0;
CopiedPointer = (UINT8 *) &Mode->IcmpError;
for (Index = 0; Index < RxData->FragmentCount; Index ++) {
CopiedLen += RxData->FragmentTable[Index].FragmentLength;
if (CopiedLen <= sizeof (EFI_PXE_BASE_CODE_ICMP_ERROR)) {
CopyMem (
CopiedPointer,
RxData->FragmentTable[Index].FragmentBuffer,
RxData->FragmentTable[Index].FragmentLength
);
} else {
CopyMem (
CopiedPointer,
RxData->FragmentTable[Index].FragmentBuffer,
CopiedLen - sizeof (EFI_PXE_BASE_CODE_ICMP_ERROR)
);
}
CopiedPointer += CopiedLen;
}
CleanUp:
gBS->SignalEvent (RxData->RecycleSignal);
Resume:
Ip4->Receive (Ip4, &(Private->IcmpErrorRcvToken));
}
/**
Request IcmpErrorListenHandlerDpc as a DPC at TPL_CALLBACK
@param Event The event signaled.
@param Context The context passed in by the event notifier.
**/
VOID
EFIAPI
IcmpErrorListenHandler (
IN EFI_EVENT Event,
IN VOID *Context
)
{
//
// Request IpIoListenHandlerDpc as a DPC at TPL_CALLBACK
//
QueueDpc (TPL_CALLBACK, IcmpErrorListenHandlerDpc, Context);
}
/**
Enables the use of the PXE Base Code Protocol functions.
This function enables the use of the PXE Base Code Protocol functions. If the
Started field of the EFI_PXE_BASE_CODE_MODE structure is already TRUE, then
EFI_ALREADY_STARTED will be returned. If UseIpv6 is TRUE, then IPv6 formatted
addresses will be used in this session. If UseIpv6 is FALSE, then IPv4 formatted
addresses will be used in this session. If UseIpv6 is TRUE, and the Ipv6Supported
field of the EFI_PXE_BASE_CODE_MODE structure is FALSE, then EFI_UNSUPPORTED will
be returned. If there is not enough memory or other resources to start the PXE
Base Code Protocol, then EFI_OUT_OF_RESOURCES will be returned. Otherwise, the
PXE Base Code Protocol will be started, and all of the fields of the EFI_PXE_BASE_CODE_MODE
structure will be initialized as follows:
StartedSet to TRUE.
Ipv6SupportedUnchanged.
Ipv6AvailableUnchanged.
UsingIpv6Set to UseIpv6.
BisSupportedUnchanged.
BisDetectedUnchanged.
AutoArpSet to TRUE.
SendGUIDSet to FALSE.
TTLSet to DEFAULT_TTL.
ToSSet to DEFAULT_ToS.
DhcpCompletedSet to FALSE.
ProxyOfferReceivedSet to FALSE.
StationIpSet to an address of all zeros.
SubnetMaskSet to a subnet mask of all zeros.
DhcpDiscoverZero-filled.
DhcpAckZero-filled.
ProxyOfferZero-filled.
PxeDiscoverValidSet to FALSE.
PxeDiscoverZero-filled.
PxeReplyValidSet to FALSE.
PxeReplyZero-filled.
PxeBisReplyValidSet to FALSE.
PxeBisReplyZero-filled.
IpFilterSet the Filters field to 0 and the IpCnt field to 0.
ArpCacheEntriesSet to 0.
ArpCacheZero-filled.
RouteTableEntriesSet to 0.
RouteTableZero-filled.
IcmpErrorReceivedSet to FALSE.
IcmpErrorZero-filled.
TftpErroReceivedSet to FALSE.
TftpErrorZero-filled.
MakeCallbacksSet to TRUE if the PXE Base Code Callback Protocol is available.
Set to FALSE if the PXE Base Code Callback Protocol is not available.
@param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param UseIpv6 Specifies the type of IP addresses that are to be used during the session
that is being started. Set to TRUE for IPv6 addresses, and FALSE for
IPv4 addresses.
@retval EFI_SUCCESS The PXE Base Code Protocol was started.
@retval EFI_DEVICE_ERROR The network device encountered an error during this oper
@retval EFI_UNSUPPORTED UseIpv6 is TRUE, but the Ipv6Supported field of the
EFI_PXE_BASE_CODE_MODE structure is FALSE.
@retval EFI_ALREADY_STARTED The PXE Base Code Protocol is already in the started state.
@retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid
EFI_PXE_BASE_CODE_PROTOCOL structure.
@retval EFI_OUT_OF_RESOURCES Could not allocate enough memory or other resources to start the
PXE Base Code Protocol.
**/
EFI_STATUS
EFIAPI
EfiPxeBcStart (
IN EFI_PXE_BASE_CODE_PROTOCOL *This,
IN BOOLEAN UseIpv6
)
{
PXEBC_PRIVATE_DATA *Private;
EFI_PXE_BASE_CODE_MODE *Mode;
EFI_STATUS Status;
if (This == NULL) {
return EFI_INVALID_PARAMETER;
}
Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);
Mode = Private->PxeBc.Mode;
if (Mode->Started) {
return EFI_ALREADY_STARTED;
}
if (UseIpv6) {
//
// IPv6 is not supported now.
//
return EFI_UNSUPPORTED;
}
AsciiPrint ("\n>>Start PXE over IPv4");
//
// Configure the udp4 instance to let it receive data
//
Status = Private->Udp4Read->Configure (
Private->Udp4Read,
&Private->Udp4CfgData
);
if (EFI_ERROR (Status)) {
return Status;
}
//
// Configure block size for TFTP as a default value to handle all link layers.
//
Private->BlockSize = MIN (Private->Ip4MaxPacketSize, PXEBC_DEFAULT_PACKET_SIZE) -
PXEBC_DEFAULT_UDP_OVERHEAD_SIZE - PXEBC_DEFAULT_TFTP_OVERHEAD_SIZE;
//
// If PcdTftpBlockSize is set to non-zero, override the default value.
//
if (PcdGet64 (PcdTftpBlockSize) != 0) {
Private->BlockSize = (UINTN) PcdGet64 (PcdTftpBlockSize);
}
Private->AddressIsOk = FALSE;
ZeroMem (Mode, sizeof (EFI_PXE_BASE_CODE_MODE));
Mode->Started = TRUE;
Mode->TTL = DEFAULT_TTL;
Mode->ToS = DEFAULT_ToS;
Mode->AutoArp = TRUE;
//
// Create the event for Arp Cache checking.
//
Status = gBS->CreateEvent (
EVT_TIMER | EVT_NOTIFY_SIGNAL,
TPL_CALLBACK,
ArpCacheUpdateTimeout,
This,
&Private->GetArpCacheEvent
);
if (EFI_ERROR (Status)) {
goto ON_EXIT;
}
//
// Start the timeout timer event.
//
Status = gBS->SetTimer (
Private->GetArpCacheEvent,
TimerPeriodic,
TICKS_PER_SECOND
);
if (EFI_ERROR (Status)) {
goto ON_EXIT;
}
//
// Create ICMP error receiving event
//
Status = gBS->CreateEvent (
EVT_NOTIFY_SIGNAL,
TPL_NOTIFY,
IcmpErrorListenHandler,
Private,
&(Private->IcmpErrorRcvToken.Event)
);
if (EFI_ERROR (Status)) {
goto ON_EXIT;
}
//
//DHCP4 service allows only one of its children to be configured in
//the active state, If the DHCP4 D.O.R.A started by IP4 auto
//configuration and has not been completed, the Dhcp4 state machine
//will not be in the right state for the PXE to start a new round D.O.R.A.
//so we need to switch it's policy to static.
//
Status = PxeBcSetIp4Policy (Private);
if (EFI_ERROR (Status)) {
goto ON_EXIT;
}
Status = Private->Ip4->Configure (Private->Ip4, &Private->Ip4ConfigData);
if (EFI_ERROR (Status)) {
goto ON_EXIT;
}
//
// start to listen incoming packet
//
Status = Private->Ip4->Receive (Private->Ip4, &Private->IcmpErrorRcvToken);
if (!EFI_ERROR (Status)) {
return Status;
}
ON_EXIT:
Private->Ip4->Configure (Private->Ip4, NULL);
if (Private->IcmpErrorRcvToken.Event != NULL) {
gBS->CloseEvent (Private->IcmpErrorRcvToken.Event);
}
if (Private->GetArpCacheEvent != NULL) {
gBS->SetTimer (Private->GetArpCacheEvent, TimerCancel, 0);
gBS->CloseEvent (Private->GetArpCacheEvent);
}
Mode->Started = FALSE;
Mode->TTL = 0;
Mode->ToS = 0;
Mode->AutoArp = FALSE;
return Status;
}
/**
Disables the use of the PXE Base Code Protocol functions.
This function stops all activity on the network device. All the resources allocated
in Start() are released, the Started field of the EFI_PXE_BASE_CODE_MODE structure is
set to FALSE and EFI_SUCCESS is returned. If the Started field of the EFI_PXE_BASE_CODE_MODE
structure is already FALSE, then EFI_NOT_STARTED will be returned.
@param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@retval EFI_SUCCESS The PXE Base Code Protocol was stopped.
@retval EFI_NOT_STARTED The PXE Base Code Protocol is already in the stopped state.
@retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid
EFI_PXE_BASE_CODE_PROTOCOL structure.
@retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
**/
EFI_STATUS
EFIAPI
EfiPxeBcStop (
IN EFI_PXE_BASE_CODE_PROTOCOL *This
)
{
PXEBC_PRIVATE_DATA *Private;
EFI_PXE_BASE_CODE_MODE *Mode;
if (This == NULL) {
return EFI_INVALID_PARAMETER;
}
Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);
Mode = Private->PxeBc.Mode;
if (!Mode->Started) {
return EFI_NOT_STARTED;
}
Private->Ip4->Cancel (Private->Ip4, NULL);
//
// Dispatch the DPCs queued by the NotifyFunction of the canceled rx token's
// events.
//
DispatchDpc ();
Private->Ip4->Configure (Private->Ip4, NULL);
//
// Close the ICMP error receiving event.
//
gBS->CloseEvent (Private->IcmpErrorRcvToken.Event);
//
// Cancel the TimeoutEvent timer.
//
gBS->SetTimer (Private->GetArpCacheEvent, TimerCancel, 0);
//
// Close the TimeoutEvent event.
//
gBS->CloseEvent (Private->GetArpCacheEvent);
Mode->Started = FALSE;
Private->CurrentUdpSrcPort = 0;
Private->Udp4Write->Configure (Private->Udp4Write, NULL);
Private->Udp4Read->Groups (Private->Udp4Read, FALSE, NULL);
Private->Udp4Read->Configure (Private->Udp4Read, NULL);
Private->Dhcp4->Stop (Private->Dhcp4);
Private->Dhcp4->Configure (Private->Dhcp4, NULL);
Private->FileSize = 0;
return EFI_SUCCESS;
}
/**
Attempts to complete a DHCPv4 D.O.R.A. (discover / offer / request / acknowledge) or DHCPv6
S.A.R.R (solicit / advertise / request / reply) sequence.
This function attempts to complete the DHCP sequence. If this sequence is completed,
then EFI_SUCCESS is returned, and the DhcpCompleted, ProxyOfferReceived, StationIp,
SubnetMask, DhcpDiscover, DhcpAck, and ProxyOffer fields of the EFI_PXE_BASE_CODE_MODE
structure are filled in.
If SortOffers is TRUE, then the cached DHCP offer packets will be sorted before
they are tried. If SortOffers is FALSE, then the cached DHCP offer packets will
be tried in the order in which they are received. Please see the Preboot Execution
Environment (PXE) Specification for additional details on the implementation of DHCP.
This function can take at least 31 seconds to timeout and return control to the
caller. If the DHCP sequence does not complete, then EFI_TIMEOUT will be returned.
If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,
then the DHCP sequence will be stopped and EFI_ABORTED will be returned.
@param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param SortOffers TRUE if the offers received should be sorted. Set to FALSE to try the
offers in the order that they are received.
@retval EFI_SUCCESS Valid DHCP has completed.
@retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
@retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid
EFI_PXE_BASE_CODE_PROTOCOL structure.
@retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
@retval EFI_OUT_OF_RESOURCES Could not allocate enough memory to complete the DHCP Protocol.
@retval EFI_ABORTED The callback function aborted the DHCP Protocol.
@retval EFI_TIMEOUT The DHCP Protocol timed out.
@retval EFI_ICMP_ERROR An ICMP error packet was received during the DHCP session.
@retval EFI_NO_RESPONSE Valid PXE offer was not received.
**/
EFI_STATUS
EFIAPI
EfiPxeBcDhcp (
IN EFI_PXE_BASE_CODE_PROTOCOL *This,
IN BOOLEAN SortOffers
)
{
PXEBC_PRIVATE_DATA *Private;
EFI_PXE_BASE_CODE_MODE *Mode;
EFI_DHCP4_PROTOCOL *Dhcp4;
EFI_DHCP4_CONFIG_DATA Dhcp4CfgData;
EFI_DHCP4_MODE_DATA Dhcp4Mode;
EFI_DHCP4_PACKET_OPTION *OptList[PXEBC_DHCP4_MAX_OPTION_NUM];
UINT32 OptCount;
EFI_STATUS Status;
EFI_ARP_CONFIG_DATA ArpConfigData;
EFI_PXE_BASE_CODE_IP_FILTER IpFilter;
if (This == NULL) {
return EFI_INVALID_PARAMETER;
}
Status = EFI_SUCCESS;
Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);
Mode = Private->PxeBc.Mode;
Dhcp4 = Private->Dhcp4;
Private->Function = EFI_PXE_BASE_CODE_FUNCTION_DHCP;
Private->SortOffers = SortOffers;
if (!Mode->Started) {
return EFI_NOT_STARTED;
}
Mode->IcmpErrorReceived = FALSE;
//
// Stop Udp4Read instance
//
Private->Udp4Read->Configure (Private->Udp4Read, NULL);
//
// Initialize the DHCP options and build the option list
//
OptCount = PxeBcBuildDhcpOptions (Private, OptList, TRUE);
//
// Set the DHCP4 config data.
// The four discovery timeouts are 4, 8, 16, 32 seconds respectively.
//
ZeroMem (&Dhcp4CfgData, sizeof (EFI_DHCP4_CONFIG_DATA));
Dhcp4CfgData.OptionCount = OptCount;
Dhcp4CfgData.OptionList = OptList;
Dhcp4CfgData.Dhcp4Callback = PxeBcDhcpCallBack;
Dhcp4CfgData.CallbackContext = Private;
Dhcp4CfgData.DiscoverTryCount = 4;
Dhcp4CfgData.DiscoverTimeout = mPxeDhcpTimeout;
Status = Dhcp4->Configure (Dhcp4, &Dhcp4CfgData);
if (EFI_ERROR (Status)) {
goto ON_EXIT;
}
//
// Zero those arrays to record the varies numbers of DHCP OFFERS.
//
Private->GotProxyOffer = FALSE;
Private->NumOffers = 0;
Private->BootpIndex = 0;
ZeroMem (Private->ServerCount, sizeof (Private->ServerCount));
ZeroMem (Private->ProxyIndex, sizeof (Private->ProxyIndex));
Status = Dhcp4->Start (Dhcp4, NULL);
if (EFI_ERROR (Status) && Status != EFI_ALREADY_STARTED) {
if (Status == EFI_ICMP_ERROR) {
Mode->IcmpErrorReceived = TRUE;
}
goto ON_EXIT;
}
Status = Dhcp4->GetModeData (Dhcp4, &Dhcp4Mode);
if (EFI_ERROR (Status)) {
goto ON_EXIT;
}
ASSERT (Dhcp4Mode.State == Dhcp4Bound);
CopyMem (&Private->StationIp, &Dhcp4Mode.ClientAddress, sizeof (EFI_IPv4_ADDRESS));
CopyMem (&Private->SubnetMask, &Dhcp4Mode.SubnetMask, sizeof (EFI_IPv4_ADDRESS));
CopyMem (&Private->GatewayIp, &Dhcp4Mode.RouterAddress, sizeof (EFI_IPv4_ADDRESS));
CopyMem (&Mode->StationIp, &Private->StationIp, sizeof (EFI_IPv4_ADDRESS));
CopyMem (&Mode->SubnetMask, &Private->SubnetMask, sizeof (EFI_IPv4_ADDRESS));
//
// Check the selected offer to see whether BINL is required, if no or BINL is
// finished, set the various Mode members.
//
Status = PxeBcCheckSelectedOffer (Private);
AsciiPrint ("\n Station IP address is ");
PxeBcShowIp4Addr (&Private->StationIp.v4);
AsciiPrint ("\n");
ON_EXIT:
if (EFI_ERROR (Status)) {
Dhcp4->Stop (Dhcp4);
Dhcp4->Configure (Dhcp4, NULL);
} else {
//
// Remove the previously configured option list and callback function
//
ZeroMem (&Dhcp4CfgData, sizeof (EFI_DHCP4_CONFIG_DATA));
Dhcp4->Configure (Dhcp4, &Dhcp4CfgData);
Private->AddressIsOk = TRUE;
if (!Mode->UsingIpv6) {
//
// If in IPv4 mode, configure the corresponding ARP with this new
// station IP address.
//
ZeroMem (&ArpConfigData, sizeof (EFI_ARP_CONFIG_DATA));
ArpConfigData.SwAddressType = 0x0800;
ArpConfigData.SwAddressLength = (UINT8) sizeof (EFI_IPv4_ADDRESS);
ArpConfigData.StationAddress = &Private->StationIp.v4;
Private->Arp->Configure (Private->Arp, NULL);
Private->Arp->Configure (Private->Arp, &ArpConfigData);
//
// Updated the route table. Fill the first entry.
//
Mode->RouteTableEntries = 1;
Mode->RouteTable[0].IpAddr.Addr[0] = Private->StationIp.Addr[0] & Private->SubnetMask.Addr[0];
Mode->RouteTable[0].SubnetMask.Addr[0] = Private->SubnetMask.Addr[0];
Mode->RouteTable[0].GwAddr.Addr[0] = 0;
//
// Create the default route entry if there is a default router.
//
if (Private->GatewayIp.Addr[0] != 0) {
Mode->RouteTableEntries = 2;
Mode->RouteTable[1].IpAddr.Addr[0] = 0;
Mode->RouteTable[1].SubnetMask.Addr[0] = 0;
Mode->RouteTable[1].GwAddr.Addr[0] = Private->GatewayIp.Addr[0];
}
//
// Flush new station IP address into Udp4CfgData and Ip4ConfigData
//
CopyMem (&Private->Udp4CfgData.StationAddress, &Private->StationIp, sizeof (EFI_IPv4_ADDRESS));
CopyMem (&Private->Udp4CfgData.SubnetMask, &Private->SubnetMask, sizeof (EFI_IPv4_ADDRESS));
CopyMem (&Private->Ip4ConfigData.StationAddress, &Private->StationIp, sizeof (EFI_IPv4_ADDRESS));
CopyMem (&Private->Ip4ConfigData.SubnetMask, &Private->SubnetMask, sizeof (EFI_IPv4_ADDRESS));
//
// Reconfigure the Ip4 instance to capture background ICMP packets with new station Ip address.
//
Private->Ip4->Cancel (Private->Ip4, &Private->IcmpErrorRcvToken);
Private->Ip4->Configure (Private->Ip4, NULL);
Status = Private->Ip4->Configure (Private->Ip4, &Private->Ip4ConfigData);
if (EFI_ERROR (Status)) {
goto ON_EXIT;
}
Status = Private->Ip4->Receive (Private->Ip4, &Private->IcmpErrorRcvToken);
if (EFI_ERROR (Status)) {
goto ON_EXIT;
}
}
}
Private->Udp4Read->Configure (Private->Udp4Read, &Private->Udp4CfgData);
//
// Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP
// receive filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.
//
ZeroMem(&IpFilter, sizeof (EFI_PXE_BASE_CODE_IP_FILTER));
IpFilter.Filters = EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP;
This->SetIpFilter (This, &IpFilter);
return Status;
}
/**
Attempts to complete the PXE Boot Server and/or boot image discovery sequence.
This function attempts to complete the PXE Boot Server and/or boot image discovery
sequence. If this sequence is completed, then EFI_SUCCESS is returned, and the
PxeDiscoverValid, PxeDiscover, PxeReplyReceived, and PxeReply fields of the
EFI_PXE_BASE_CODE_MODE structure are filled in. If UseBis is TRUE, then the
PxeBisReplyReceived and PxeBisReply fields of the EFI_PXE_BASE_CODE_MODE structure
will also be filled in. If UseBis is FALSE, then PxeBisReplyValid will be set to FALSE.
In the structure referenced by parameter Info, the PXE Boot Server list, SrvList[],
has two uses: It is the Boot Server IP address list used for unicast discovery
(if the UseUCast field is TRUE), and it is the list used for Boot Server verification
(if the MustUseList field is TRUE). Also, if the MustUseList field in that structure
is TRUE and the AcceptAnyResponse field in the SrvList[] array is TRUE, any Boot
Server reply of that type will be accepted. If the AcceptAnyResponse field is
FALSE, only responses from Boot Servers with matching IP addresses will be accepted.
This function can take at least 10 seconds to timeout and return control to the
caller. If the Discovery sequence does not complete, then EFI_TIMEOUT will be
returned. Please see the Preboot Execution Environment (PXE) Specification for
additional details on the implementation of the Discovery sequence.
If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,
then the Discovery sequence is stopped and EFI_ABORTED will be returned.
@param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param Type The type of bootstrap to perform.
@param Layer Pointer to the boot server layer number to discover, which must be
PXE_BOOT_LAYER_INITIAL when a new server type is being
discovered.
@param UseBis TRUE if Boot Integrity Services are to be used. FALSE otherwise.
@param Info Pointer to a data structure that contains additional information on the
type of discovery operation that is to be performed.
@retval EFI_SUCCESS The Discovery sequence has been completed.
@retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.
@retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
@retval EFI_OUT_OF_RESOURCES Could not allocate enough memory to complete Discovery.
@retval EFI_ABORTED The callback function aborted the Discovery sequence.
@retval EFI_TIMEOUT The Discovery sequence timed out.
@retval EFI_ICMP_ERROR An ICMP error packet was received during the PXE discovery
session.
**/
EFI_STATUS
EFIAPI
EfiPxeBcDiscover (
IN EFI_PXE_BASE_CODE_PROTOCOL *This,
IN UINT16 Type,
IN UINT16 *Layer,
IN BOOLEAN UseBis,
IN EFI_PXE_BASE_CODE_DISCOVER_INFO *Info OPTIONAL
)
{
PXEBC_PRIVATE_DATA *Private;
EFI_PXE_BASE_CODE_MODE *Mode;
EFI_PXE_BASE_CODE_DISCOVER_INFO DefaultInfo;
EFI_PXE_BASE_CODE_DISCOVER_INFO *CreatedInfo;
EFI_PXE_BASE_CODE_SRVLIST *SrvList;
EFI_PXE_BASE_CODE_SRVLIST DefaultSrvList;
PXEBC_CACHED_DHCP4_PACKET *Packet;
PXEBC_VENDOR_OPTION *VendorOpt;
UINT16 Index;
EFI_STATUS Status;
PXEBC_BOOT_SVR_ENTRY *BootSvrEntry;
EFI_PXE_BASE_CODE_IP_FILTER IpFilter;
if (This == NULL) {
return EFI_INVALID_PARAMETER;
}
Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);
Mode = Private->PxeBc.Mode;
BootSvrEntry = NULL;
SrvList = NULL;
CreatedInfo = NULL;
Status = EFI_DEVICE_ERROR;
Private->Function = EFI_PXE_BASE_CODE_FUNCTION_DISCOVER;
if (!Private->AddressIsOk) {
return EFI_INVALID_PARAMETER;
}
if (!Mode->Started) {
return EFI_NOT_STARTED;
}
//
// Stop Udp4Read instance
//
Private->Udp4Read->Configure (Private->Udp4Read, NULL);
Mode->IcmpErrorReceived = FALSE;
//
// If layer isn't EFI_PXE_BASE_CODE_BOOT_LAYER_INITIAL,
// use the previous setting;
// If info isn't offered,
// use the cached DhcpAck and ProxyOffer packets.
//
ZeroMem (&DefaultInfo, sizeof (EFI_PXE_BASE_CODE_DISCOVER_INFO));
if (*Layer != EFI_PXE_BASE_CODE_BOOT_LAYER_INITIAL) {
if (!Mode->PxeDiscoverValid || !Mode->PxeReplyReceived || (!Mode->PxeBisReplyReceived && UseBis)) {
Status = EFI_INVALID_PARAMETER;
goto ON_EXIT;
}
DefaultInfo.IpCnt = 1;
DefaultInfo.UseUCast = TRUE;
DefaultSrvList.Type = Type;
DefaultSrvList.AcceptAnyResponse = FALSE;
DefaultSrvList.IpAddr.Addr[0] = Private->ServerIp.Addr[0];
SrvList = &DefaultSrvList;
Info = &DefaultInfo;
} else if (Info == NULL) {
//
// Create info by the cached packet before
//
Packet = (Mode->ProxyOfferReceived) ? &Private->ProxyOffer : &Private->Dhcp4Ack;
VendorOpt = &Packet->PxeVendorOption;
if (!Mode->DhcpAckReceived || !IS_VALID_DISCOVER_VENDOR_OPTION (VendorOpt->BitMap)) {
//
// Address is not acquired or no discovery options.
//
Status = EFI_INVALID_PARAMETER;
goto ON_EXIT;
}
DefaultInfo.UseMCast = (BOOLEAN)!IS_DISABLE_MCAST_DISCOVER (VendorOpt->DiscoverCtrl);
DefaultInfo.UseBCast = (BOOLEAN)!IS_DISABLE_BCAST_DISCOVER (VendorOpt->DiscoverCtrl);
DefaultInfo.MustUseList = (BOOLEAN) IS_ENABLE_USE_SERVER_LIST (VendorOpt->DiscoverCtrl);
DefaultInfo.UseUCast = DefaultInfo.MustUseList;
if (DefaultInfo.UseMCast) {
//
// Get the multicast discover ip address from vendor option.
//
CopyMem (
&DefaultInfo.ServerMCastIp.Addr,
&VendorOpt->DiscoverMcastIp,
sizeof (EFI_IPv4_ADDRESS)
);
}
DefaultInfo.IpCnt = 0;
Info = &DefaultInfo;
SrvList = Info->SrvList;
if (DefaultInfo.MustUseList) {
BootSvrEntry = VendorOpt->BootSvr;
Status = EFI_INVALID_PARAMETER;
while (((UINT8) (BootSvrEntry - VendorOpt->BootSvr)) < VendorOpt->BootSvrLen) {
if (BootSvrEntry->Type == HTONS (Type)) {
Status = EFI_SUCCESS;
break;
}
BootSvrEntry = GET_NEXT_BOOT_SVR_ENTRY (BootSvrEntry);
}
if (EFI_ERROR (Status)) {
goto ON_EXIT;
}
DefaultInfo.IpCnt = BootSvrEntry->IpCnt;
if (DefaultInfo.IpCnt >= 1) {
CreatedInfo = AllocatePool (sizeof (DefaultInfo) + (DefaultInfo.IpCnt - 1) * sizeof (*SrvList));
if (CreatedInfo == NULL) {
Status = EFI_OUT_OF_RESOURCES;
goto ON_EXIT;
}
CopyMem (CreatedInfo, &DefaultInfo, sizeof (DefaultInfo));
Info = CreatedInfo;
SrvList = Info->SrvList;
}
for (Index = 0; Index < DefaultInfo.IpCnt; Index++) {
CopyMem (&SrvList[Index].IpAddr, &BootSvrEntry->IpAddr[Index], sizeof (EFI_IPv4_ADDRESS));
SrvList[Index].AcceptAnyResponse = FALSE;
SrvList[Index].Type = BootSvrEntry->Type;
}
}
} else {
SrvList = Info->SrvList;
if (!SrvList[0].AcceptAnyResponse) {
for (Index = 1; Index < Info->IpCnt; Index++) {
if (SrvList[Index].AcceptAnyResponse) {
break;
}
}
if (Index != Info->IpCnt) {
Status = EFI_INVALID_PARAMETER;
goto ON_EXIT;
}
}
}
if ((!Info->UseUCast && !Info->UseBCast && !Info->UseMCast) || (Info->MustUseList && Info->IpCnt == 0)) {
Status = EFI_INVALID_PARAMETER;
goto ON_EXIT;
}
//
// Execute discover by UniCast/BroadCast/MultiCast
//
if (Info->UseUCast) {
for (Index = 0; Index < Info->IpCnt; Index++) {
if (BootSvrEntry == NULL) {
Private->ServerIp.Addr[0] = SrvList[Index].IpAddr.Addr[0];
} else {
CopyMem (
&Private->ServerIp,
&BootSvrEntry->IpAddr[Index],
sizeof (EFI_IPv4_ADDRESS)
);
}
Status = PxeBcDiscvBootService (
Private,
Type,
Layer,
UseBis,
&SrvList[Index].IpAddr,
0,
NULL,
TRUE,
&Private->PxeReply.Packet.Ack
);
if (!EFI_ERROR (Status)) {
break;
}
}
} else if (Info->UseMCast) {
Status = PxeBcDiscvBootService (
Private,
Type,
Layer,
UseBis,
&Info->ServerMCastIp,
0,
NULL,
TRUE,
&Private->PxeReply.Packet.Ack
);
} else if (Info->UseBCast) {
Status = PxeBcDiscvBootService (
Private,
Type,
Layer,
UseBis,
NULL,
Info->IpCnt,
SrvList,
TRUE,
&Private->PxeReply.Packet.Ack
);
}
if (EFI_ERROR (Status) || !Mode->PxeReplyReceived || (!Mode->PxeBisReplyReceived && UseBis)) {
if (Status == EFI_ICMP_ERROR) {
Mode->IcmpErrorReceived = TRUE;
} else {
Status = EFI_DEVICE_ERROR;
}
goto ON_EXIT;
} else {
PxeBcParseCachedDhcpPacket (&Private->PxeReply);
}
if (Mode->PxeBisReplyReceived) {
CopyMem (
&Private->ServerIp,
&Mode->PxeReply.Dhcpv4.BootpSiAddr,
sizeof (EFI_IPv4_ADDRESS)
);
}
if (CreatedInfo != NULL) {
FreePool (CreatedInfo);
}
ON_EXIT:
Private->Udp4Read->Configure (Private->Udp4Read, &Private->Udp4CfgData);
//
// Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP
// receive filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.
//
ZeroMem(&IpFilter, sizeof (EFI_PXE_BASE_CODE_IP_FILTER));
IpFilter.Filters = EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP;
This->SetIpFilter (This, &IpFilter);
return Status;
}
/**
Used to perform TFTP and MTFTP services.
This function is used to perform TFTP and MTFTP services. This includes the
TFTP operations to get the size of a file, read a directory, read a file, and
write a file. It also includes the MTFTP operations to get the size of a file,
read a directory, and read a file. The type of operation is specified by Operation.
If the callback function that is invoked during the TFTP/MTFTP operation does
not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED will
be returned.
For read operations, the return data will be placed in the buffer specified by
BufferPtr. If BufferSize is too small to contain the entire downloaded file,
then EFI_BUFFER_TOO_SMALL will be returned and BufferSize will be set to zero
or the size of the requested file (the size of the requested file is only returned
if the TFTP server supports TFTP options). If BufferSize is large enough for the
read operation, then BufferSize will be set to the size of the downloaded file,
and EFI_SUCCESS will be returned. Applications using the PxeBc.Mtftp() services
should use the get-file-size operations to determine the size of the downloaded
file prior to using the read-file operations-especially when downloading large
(greater than 64 MB) files-instead of making two calls to the read-file operation.
Following this recommendation will save time if the file is larger than expected
and the TFTP server does not support TFTP option extensions. Without TFTP option
extension support, the client has to download the entire file, counting and discarding
the received packets, to determine the file size.
For write operations, the data to be sent is in the buffer specified by BufferPtr.
BufferSize specifies the number of bytes to send. If the write operation completes
successfully, then EFI_SUCCESS will be returned.
For TFTP "get file size" operations, the size of the requested file or directory
is returned in BufferSize, and EFI_SUCCESS will be returned. If the TFTP server
does not support options, the file will be downloaded into a bit bucket and the
length of the downloaded file will be returned. For MTFTP "get file size" operations,
if the MTFTP server does not support the "get file size" option, EFI_UNSUPPORTED
will be returned.
This function can take up to 10 seconds to timeout and return control to the caller.
If the TFTP sequence does not complete, EFI_TIMEOUT will be returned.
If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,
then the TFTP sequence is stopped and EFI_ABORTED will be returned.
The format of the data returned from a TFTP read directory operation is a null-terminated
filename followed by a null-terminated information string, of the form
"size year-month-day hour:minute:second" (i.e. %d %d-%d-%d %d:%d:%f - note that
the seconds field can be a decimal number), where the date and time are UTC. For
an MTFTP read directory command, there is additionally a null-terminated multicast
IP address preceding the filename of the form %d.%d.%d.%d for IP v4. The final
entry is itself null-terminated, so that the final information string is terminated
with two null octets.
@param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param Operation The type of operation to perform.
@param BufferPtr A pointer to the data buffer.
@param Overwrite Only used on write file operations. TRUE if a file on a remote server can
be overwritten.
@param BufferSize For get-file-size operations, *BufferSize returns the size of the
requested file.
@param BlockSize The requested block size to be used during a TFTP transfer.
@param ServerIp The TFTP / MTFTP server IP address.
@param Filename A Null-terminated ASCII string that specifies a directory name or a file
name.
@param Info Pointer to the MTFTP information.
@param DontUseBuffer Set to FALSE for normal TFTP and MTFTP read file operation.
@retval EFI_SUCCESS The TFTP/MTFTP operation was completed.
@retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.
@retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
@retval EFI_BUFFER_TOO_SMALL The buffer is not large enough to complete the read operation.
@retval EFI_ABORTED The callback function aborted the TFTP/MTFTP operation.
@retval EFI_TIMEOUT The TFTP/MTFTP operation timed out.
@retval EFI_ICMP_ERROR An ICMP error packet was received during the MTFTP session.
@retval EFI_TFTP_ERROR A TFTP error packet was received during the MTFTP session.
**/
EFI_STATUS
EFIAPI
EfiPxeBcMtftp (
IN EFI_PXE_BASE_CODE_PROTOCOL *This,
IN EFI_PXE_BASE_CODE_TFTP_OPCODE Operation,
IN OUT VOID *BufferPtr,
IN BOOLEAN Overwrite,
IN OUT UINT64 *BufferSize,
IN UINTN *BlockSize OPTIONAL,
IN EFI_IP_ADDRESS *ServerIp,
IN UINT8 *Filename,
IN EFI_PXE_BASE_CODE_MTFTP_INFO *Info OPTIONAL,
IN BOOLEAN DontUseBuffer
)
{
PXEBC_PRIVATE_DATA *Private;
EFI_MTFTP4_CONFIG_DATA Mtftp4Config;
EFI_STATUS Status;
EFI_PXE_BASE_CODE_MODE *Mode;
EFI_MAC_ADDRESS TempMacAddr;
EFI_PXE_BASE_CODE_IP_FILTER IpFilter;
if ((This == NULL) ||
(Filename == NULL) ||
(BufferSize == NULL) ||
((ServerIp == NULL) ||
(IP4_IS_UNSPECIFIED (NTOHL (ServerIp->Addr[0])) ||
IP4_IS_LOCAL_BROADCAST (NTOHL (ServerIp->Addr[0])))) ||
((BufferPtr == NULL) && DontUseBuffer) ||
((BlockSize != NULL) && (*BlockSize < 512))) {
return EFI_INVALID_PARAMETER;
}
Status = EFI_DEVICE_ERROR;
Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);
Mode = &Private->Mode;
if (!Mode->AutoArp) {
//
// If AutoArp is set false, check arp cache
//
UpdateArpCache (This);
if (!FindInArpCache (Mode, &ServerIp->v4, &TempMacAddr)) {
return EFI_DEVICE_ERROR;
}
}
//
// Stop Udp4Read instance
//
Private->Udp4Read->Configure (Private->Udp4Read, NULL);
Mode->TftpErrorReceived = FALSE;
Mode->IcmpErrorReceived = FALSE;
Mtftp4Config.UseDefaultSetting = FALSE;
Mtftp4Config.TimeoutValue = PXEBC_MTFTP_TIMEOUT;
Mtftp4Config.TryCount = PXEBC_MTFTP_RETRIES;
CopyMem (
&Mtftp4Config.StationIp,
&Private->StationIp,
sizeof (EFI_IPv4_ADDRESS)
);
CopyMem (
&Mtftp4Config.SubnetMask,
&Private->SubnetMask,
sizeof (EFI_IPv4_ADDRESS)
);
CopyMem (
&Mtftp4Config.GatewayIp,
&Private->GatewayIp,
sizeof (EFI_IPv4_ADDRESS)
);
CopyMem (
&Mtftp4Config.ServerIp,
ServerIp,
sizeof (EFI_IPv4_ADDRESS)
);
switch (Operation) {
case EFI_PXE_BASE_CODE_TFTP_GET_FILE_SIZE:
Status = PxeBcTftpGetFileSize (
Private,
&Mtftp4Config,
Filename,
BlockSize,
BufferSize
);
break;
case EFI_PXE_BASE_CODE_TFTP_READ_FILE:
Status = PxeBcTftpReadFile (
Private,
&Mtftp4Config,
Filename,
BlockSize,
BufferPtr,
BufferSize,
DontUseBuffer
);
break;
case EFI_PXE_BASE_CODE_TFTP_WRITE_FILE:
Status = PxeBcTftpWriteFile (
Private,
&Mtftp4Config,
Filename,
Overwrite,
BlockSize,
BufferPtr,
BufferSize
);
break;
case EFI_PXE_BASE_CODE_TFTP_READ_DIRECTORY:
Status = PxeBcTftpReadDirectory (
Private,
&Mtftp4Config,
Filename,
BlockSize,
BufferPtr,
BufferSize,
DontUseBuffer
);
break;
case EFI_PXE_BASE_CODE_MTFTP_GET_FILE_SIZE:
case EFI_PXE_BASE_CODE_MTFTP_READ_FILE:
case EFI_PXE_BASE_CODE_MTFTP_READ_DIRECTORY:
Status = EFI_UNSUPPORTED;
break;
default:
Status = EFI_INVALID_PARAMETER;
break;
}
if (Status == EFI_ICMP_ERROR) {
Mode->IcmpErrorReceived = TRUE;
}
if (EFI_ERROR (Status)) {
goto ON_EXIT;
}
ON_EXIT:
Private->Udp4Read->Configure (Private->Udp4Read, &Private->Udp4CfgData);
//
// Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP
// receive filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.
//
ZeroMem(&IpFilter, sizeof (EFI_PXE_BASE_CODE_IP_FILTER));
IpFilter.Filters = EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP;
This->SetIpFilter (This, &IpFilter);
return Status;
}
/**
Writes a UDP packet to the network interface.
This function writes a UDP packet specified by the (optional HeaderPtr and)
BufferPtr parameters to the network interface. The UDP header is automatically
built by this routine. It uses the parameters OpFlags, DestIp, DestPort, GatewayIp,
SrcIp, and SrcPort to build this header. If the packet is successfully built and
transmitted through the network interface, then EFI_SUCCESS will be returned.
If a timeout occurs during the transmission of the packet, then EFI_TIMEOUT will
be returned. If an ICMP error occurs during the transmission of the packet, then
the IcmpErrorReceived field is set to TRUE, the IcmpError field is filled in and
EFI_ICMP_ERROR will be returned. If the Callback Protocol does not return
EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED will be returned.
@param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param OpFlags The UDP operation flags.
@param DestIp The destination IP address.
@param DestPort The destination UDP port number.
@param GatewayIp The gateway IP address.
@param SrcIp The source IP address.
@param SrcPort The source UDP port number.
@param HeaderSize An optional field which may be set to the length of a header at
HeaderPtr to be prefixed to the data at BufferPtr.
@param HeaderPtr If HeaderSize is not NULL, a pointer to a header to be prefixed to the
data at BufferPtr.
@param BufferSize A pointer to the size of the data at BufferPtr.
@param BufferPtr A pointer to the data to be written.
@retval EFI_SUCCESS The UDP Write operation was completed.
@retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.
@retval EFI_BAD_BUFFER_SIZE The buffer is too long to be transmitted.
@retval EFI_ABORTED The callback function aborted the UDP Write operation.
@retval EFI_TIMEOUT The UDP Write operation timed out.
@retval EFI_ICMP_ERROR An ICMP error packet was received during the UDP write session.
**/
EFI_STATUS
EFIAPI
EfiPxeBcUdpWrite (
IN EFI_PXE_BASE_CODE_PROTOCOL *This,
IN UINT16 OpFlags,
IN EFI_IP_ADDRESS *DestIp,
IN EFI_PXE_BASE_CODE_UDP_PORT *DestPort,
IN EFI_IP_ADDRESS *GatewayIp OPTIONAL,
IN EFI_IP_ADDRESS *SrcIp OPTIONAL,
IN OUT EFI_PXE_BASE_CODE_UDP_PORT *SrcPort OPTIONAL,
IN UINTN *HeaderSize OPTIONAL,
IN VOID *HeaderPtr OPTIONAL,
IN UINTN *BufferSize,
IN VOID *BufferPtr
)
{
PXEBC_PRIVATE_DATA *Private;
EFI_UDP4_PROTOCOL *Udp4;
EFI_UDP4_COMPLETION_TOKEN Token;
EFI_UDP4_TRANSMIT_DATA *Udp4TxData;
UINT32 FragCount;
UINT32 DataLength;
EFI_UDP4_SESSION_DATA Udp4Session;
EFI_STATUS Status;
BOOLEAN IsDone;
EFI_PXE_BASE_CODE_MODE *Mode;
EFI_MAC_ADDRESS TempMacAddr;
IsDone = FALSE;
if ((This == NULL) || (DestIp == NULL) || (DestPort == NULL)) {
return EFI_INVALID_PARAMETER;
}
if ((GatewayIp != NULL) && (IP4_IS_UNSPECIFIED (NTOHL (GatewayIp->Addr[0])) || IP4_IS_LOCAL_BROADCAST (NTOHL (GatewayIp->Addr[0])))) {
//
// Gateway is provided but it's not a unicast IP address.
//
return EFI_INVALID_PARAMETER;
}
if ((HeaderSize != NULL) && ((*HeaderSize == 0) || (HeaderPtr == NULL))) {
//
// The HeaderSize ptr isn't NULL and: 1. the value is zero; or 2. the HeaderPtr
// is NULL.
//
return EFI_INVALID_PARAMETER;
}
if ((BufferSize == NULL) || ((*BufferSize != 0) && (BufferPtr == NULL))) {
return EFI_INVALID_PARAMETER;
}
Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);
Udp4 = Private->Udp4Write;
Mode = &Private->Mode;
if (!Mode->Started) {
return EFI_NOT_STARTED;
}
if (!Private->AddressIsOk && (SrcIp == NULL)) {
return EFI_INVALID_PARAMETER;
}
if (!Mode->AutoArp) {
//
// If AutoArp is set false, check arp cache
//
UpdateArpCache (This);
if (!FindInArpCache (Mode, &DestIp->v4, &TempMacAddr)) {
return EFI_DEVICE_ERROR;
}
}
Mode->IcmpErrorReceived = FALSE;
if ((Private->CurrentUdpSrcPort == 0) ||
((SrcPort != NULL) && (*SrcPort != Private->CurrentUdpSrcPort))) {
//
// Port is changed, (re)configure the Udp4Write instance
//
if (SrcPort != NULL) {
Private->CurrentUdpSrcPort = *SrcPort;
}
}
Status = PxeBcConfigureUdpWriteInstance (
Udp4,
&Private->StationIp.v4,
&Private->SubnetMask.v4,
&Private->GatewayIp.v4,
&Private->CurrentUdpSrcPort,
Private->Mode.TTL,
Private->Mode.ToS
);
if (EFI_ERROR (Status)) {
Private->CurrentUdpSrcPort = 0;
return EFI_INVALID_PARAMETER;
}
ZeroMem (&Token, sizeof (EFI_UDP4_COMPLETION_TOKEN));
ZeroMem (&Udp4Session, sizeof (EFI_UDP4_SESSION_DATA));
CopyMem (&Udp4Session.DestinationAddress, DestIp, sizeof (EFI_IPv4_ADDRESS));
Udp4Session.DestinationPort = *DestPort;
if (SrcIp != NULL) {
CopyMem (&Udp4Session.SourceAddress, SrcIp, sizeof (EFI_IPv4_ADDRESS));
}
if (SrcPort != NULL) {
Udp4Session.SourcePort = *SrcPort;
}
FragCount = (HeaderSize != NULL) ? 2 : 1;
Udp4TxData = (EFI_UDP4_TRANSMIT_DATA *) AllocateZeroPool (sizeof (EFI_UDP4_TRANSMIT_DATA) + (FragCount - 1) * sizeof (EFI_UDP4_FRAGMENT_DATA));
if (Udp4TxData == NULL) {
return EFI_OUT_OF_RESOURCES;
}
Udp4TxData->FragmentCount = FragCount;
Udp4TxData->FragmentTable[FragCount - 1].FragmentLength = (UINT32) *BufferSize;
Udp4TxData->FragmentTable[FragCount - 1].FragmentBuffer = BufferPtr;
DataLength = (UINT32) *BufferSize;
if (FragCount == 2) {
Udp4TxData->FragmentTable[0].FragmentLength = (UINT32) *HeaderSize;
Udp4TxData->FragmentTable[0].FragmentBuffer = HeaderPtr;
DataLength += (UINT32) *HeaderSize;
}
if (GatewayIp != NULL) {
Udp4TxData->GatewayAddress = (EFI_IPv4_ADDRESS *) GatewayIp;
}
Udp4TxData->UdpSessionData = &Udp4Session;
Udp4TxData->DataLength = DataLength;
Token.Packet.TxData = Udp4TxData;
Status = gBS->CreateEvent (
EVT_NOTIFY_SIGNAL,
TPL_NOTIFY,
PxeBcCommonNotify,
&IsDone,
&Token.Event
);
if (EFI_ERROR (Status)) {
goto ON_EXIT;
}
Status = Udp4->Transmit (Udp4, &Token);
if (EFI_ERROR (Status)) {
if (Status == EFI_ICMP_ERROR) {
Mode->IcmpErrorReceived = TRUE;
}
goto ON_EXIT;
}
while (!IsDone) {
Udp4->Poll (Udp4);
}
Status = Token.Status;
ON_EXIT:
if (Token.Event != NULL) {
gBS->CloseEvent (Token.Event);
}
FreePool (Udp4TxData);
//
// Reset the instance.
//
Udp4->Configure (Udp4, NULL);
return Status;
}
/**
Decide whether the incoming UDP packet is acceptable per IP filter settings
in provided PxeBcMode.
@param PxeBcMode Pointer to EFI_PXE_BASE_CODE_MODE.
@param Session Received UDP session.
@retval TRUE The UDP package matches IP filters.
@retval FALSE The UDP package doesn't matches IP filters.
**/
BOOLEAN
CheckIpByFilter (
IN EFI_PXE_BASE_CODE_MODE *PxeBcMode,
IN EFI_UDP4_SESSION_DATA *Session
)
{
UINTN Index;
EFI_IPv4_ADDRESS Ip4Address;
EFI_IPv4_ADDRESS DestIp4Address;
if ((PxeBcMode->IpFilter.Filters & EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS) != 0) {
return TRUE;
}
CopyMem (&DestIp4Address, &Session->DestinationAddress, sizeof (DestIp4Address));
if (((PxeBcMode->IpFilter.Filters & EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS_MULTICAST) != 0) &&
IP4_IS_MULTICAST (EFI_NTOHL (DestIp4Address))
) {
return TRUE;
}
if (((PxeBcMode->IpFilter.Filters & EFI_PXE_BASE_CODE_IP_FILTER_BROADCAST) != 0) &&
IP4_IS_LOCAL_BROADCAST (EFI_NTOHL (DestIp4Address))
) {
return TRUE;
}
CopyMem (&Ip4Address, &PxeBcMode->StationIp.v4, sizeof (Ip4Address));
if (((PxeBcMode->IpFilter.Filters & EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP) != 0) &&
EFI_IP4_EQUAL (&Ip4Address, &DestIp4Address)
) {
return TRUE;
}
ASSERT (PxeBcMode->IpFilter.IpCnt < EFI_PXE_BASE_CODE_MAX_IPCNT);
for (Index = 0; Index < PxeBcMode->IpFilter.IpCnt; Index++) {
CopyMem (
&Ip4Address,
&PxeBcMode->IpFilter.IpList[Index].v4,
sizeof (Ip4Address)
);
if (EFI_IP4_EQUAL (&Ip4Address, &DestIp4Address)) {
return TRUE;
}
}
return FALSE;
}
/**
Reads a UDP packet from the network interface.
This function reads a UDP packet from a network interface. The data contents
are returned in (the optional HeaderPtr and) BufferPtr, and the size of the
buffer received is returned in BufferSize . If the input BufferSize is smaller
than the UDP packet received (less optional HeaderSize), it will be set to the
required size, and EFI_BUFFER_TOO_SMALL will be returned. In this case, the
contents of BufferPtr are undefined, and the packet is lost. If a UDP packet is
successfully received, then EFI_SUCCESS will be returned, and the information
from the UDP header will be returned in DestIp, DestPort, SrcIp, and SrcPort if
they are not NULL. Depending on the values of OpFlags and the DestIp, DestPort,
SrcIp, and SrcPort input values, different types of UDP packet receive filtering
will be performed. The following tables summarize these receive filter operations.
@param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param OpFlags The UDP operation flags.
@param DestIp The destination IP address.
@param DestPort The destination UDP port number.
@param SrcIp The source IP address.
@param SrcPort The source UDP port number.
@param HeaderSize An optional field which may be set to the length of a header at
HeaderPtr to be prefixed to the data at BufferPtr.
@param HeaderPtr If HeaderSize is not NULL, a pointer to a header to be prefixed to the
data at BufferPtr.
@param BufferSize A pointer to the size of the data at BufferPtr.
@param BufferPtr A pointer to the data to be read.
@retval EFI_SUCCESS The UDP Read operation was completed.
@retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.
@retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
@retval EFI_BUFFER_TOO_SMALL The packet is larger than Buffer can hold.
@retval EFI_ABORTED The callback function aborted the UDP Read operation.
@retval EFI_TIMEOUT The UDP Read operation timed out.
**/
EFI_STATUS
EFIAPI
EfiPxeBcUdpRead (
IN EFI_PXE_BASE_CODE_PROTOCOL *This,
IN UINT16 OpFlags,
IN OUT EFI_IP_ADDRESS *DestIp OPTIONAL,
IN OUT EFI_PXE_BASE_CODE_UDP_PORT *DestPort OPTIONAL,
IN OUT EFI_IP_ADDRESS *SrcIp OPTIONAL,
IN OUT EFI_PXE_BASE_CODE_UDP_PORT *SrcPort OPTIONAL,
IN UINTN *HeaderSize OPTIONAL,
IN VOID *HeaderPtr OPTIONAL,
IN OUT UINTN *BufferSize,
IN VOID *BufferPtr
)
{
PXEBC_PRIVATE_DATA *Private;
EFI_PXE_BASE_CODE_MODE *Mode;
EFI_UDP4_PROTOCOL *Udp4;
EFI_UDP4_COMPLETION_TOKEN Token;
EFI_UDP4_RECEIVE_DATA *RxData;
EFI_UDP4_SESSION_DATA *Session;
EFI_STATUS Status;
BOOLEAN IsDone;
BOOLEAN Matched;
UINTN CopiedLen;
UINTN HeaderLen;
UINTN HeaderCopiedLen;
UINTN BufferCopiedLen;
UINT32 FragmentLength;
UINTN FragmentIndex;
UINT8 *FragmentBuffer;
if (This == NULL || DestIp == NULL || DestPort == NULL) {
return EFI_INVALID_PARAMETER;
}
if (((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_PORT) == 0 && (DestPort == NULL)) ||
((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_PORT) == 0 && (SrcIp == NULL)) ||
((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_PORT) == 0 && (SrcPort == NULL))) {
return EFI_INVALID_PARAMETER;
}
if (((HeaderSize != NULL) && (*HeaderSize == 0)) || ((HeaderSize != NULL) && (HeaderPtr == NULL))) {
return EFI_INVALID_PARAMETER;
}
if ((BufferSize == NULL) || (BufferPtr == NULL)) {
return EFI_INVALID_PARAMETER;
}
Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);
Mode = Private->PxeBc.Mode;
Udp4 = Private->Udp4Read;
if (!Mode->Started) {
return EFI_NOT_STARTED;
}
Mode->IcmpErrorReceived = FALSE;
Status = gBS->CreateEvent (
EVT_NOTIFY_SIGNAL,
TPL_NOTIFY,
PxeBcCommonNotify,
&IsDone,
&Token.Event
);
if (EFI_ERROR (Status)) {
return EFI_OUT_OF_RESOURCES;
}
TRY_AGAIN:
IsDone = FALSE;
Status = Udp4->Receive (Udp4, &Token);
if (EFI_ERROR (Status)) {
if (Status == EFI_ICMP_ERROR) {
Mode->IcmpErrorReceived = TRUE;
}
goto ON_EXIT;
}
Udp4->Poll (Udp4);
if (!IsDone) {
Status = EFI_TIMEOUT;
} else {
//
// check whether this packet matches the filters
//
if (EFI_ERROR (Token.Status)){
goto ON_EXIT;
}
RxData = Token.Packet.RxData;
Session = &RxData->UdpSession;
Matched = TRUE;
if ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_USE_FILTER) != 0) {
Matched = FALSE;
//
// Check UDP package by IP filter settings
//
if (CheckIpByFilter (Mode, Session)) {
Matched = TRUE;
}
}
if (Matched) {
Matched = FALSE;
//
// Match the destination ip of the received udp dgram
//
if ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_IP) != 0) {
Matched = TRUE;
if (DestIp != NULL) {
CopyMem (DestIp, &Session->DestinationAddress, sizeof (EFI_IPv4_ADDRESS));
}
} else {
if (DestIp != NULL) {
if (EFI_IP4_EQUAL (DestIp, &Session->DestinationAddress)) {
Matched = TRUE;
}
} else {
if (EFI_IP4_EQUAL (&Private->StationIp, &Session->DestinationAddress)) {
Matched = TRUE;
}
}
}
}
if (Matched) {
//
// Match the destination port of the received udp dgram
//
if ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_PORT) != 0) {
if (DestPort != NULL) {
*DestPort = Session->DestinationPort;
}
} else {
if (*DestPort != Session->DestinationPort) {
Matched = FALSE;
}
}
}
if (Matched) {
//
// Match the source ip of the received udp dgram
//
if ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_IP) != 0) {
if (SrcIp != NULL) {
CopyMem (SrcIp, &Session->SourceAddress, sizeof (EFI_IPv4_ADDRESS));
}
} else {
if (!EFI_IP4_EQUAL (SrcIp, &Session->SourceAddress)) {
Matched = FALSE;
}
}
}
if (Matched) {
//
// Match the source port of the received udp dgram
//
if ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_PORT) != 0) {
if (SrcPort != NULL) {
*SrcPort = Session->SourcePort;
}
} else {
if (*SrcPort != Session->SourcePort) {
Matched = FALSE;
}
}
}
if (Matched) {
ASSERT (RxData != NULL);
HeaderLen = 0;
if (HeaderSize != NULL) {
HeaderLen = MIN (*HeaderSize, RxData->DataLength);
}
if (RxData->DataLength - HeaderLen > *BufferSize) {
Status = EFI_BUFFER_TOO_SMALL;
} else {
*HeaderSize = HeaderLen;
*BufferSize = RxData->DataLength - HeaderLen;
HeaderCopiedLen = 0;
BufferCopiedLen = 0;
for (FragmentIndex = 0; FragmentIndex < RxData->FragmentCount; FragmentIndex++) {
FragmentLength = RxData->FragmentTable[FragmentIndex].FragmentLength;
FragmentBuffer = RxData->FragmentTable[FragmentIndex].FragmentBuffer;
if (HeaderCopiedLen + FragmentLength < HeaderLen) {
//
// Copy the header part of received data.
//
CopyMem ((UINT8 *) HeaderPtr + HeaderCopiedLen, FragmentBuffer, FragmentLength);
HeaderCopiedLen += FragmentLength;
} else if (HeaderCopiedLen < HeaderLen) {
//
// Copy the header part of received data.
//
CopiedLen = HeaderLen - HeaderCopiedLen;
CopyMem ((UINT8 *) HeaderPtr + HeaderCopiedLen, FragmentBuffer, CopiedLen);
HeaderCopiedLen += CopiedLen;
//
// Copy the other part of received data.
//
CopyMem ((UINT8 *) BufferPtr + BufferCopiedLen, FragmentBuffer + CopiedLen, FragmentLength - CopiedLen);
BufferCopiedLen += (FragmentLength - CopiedLen);
} else {
//
// Copy the other part of received data.
//
CopyMem ((UINT8 *) BufferPtr + BufferCopiedLen, FragmentBuffer, FragmentLength);
BufferCopiedLen += FragmentLength;
}
}
}
} else {
Status = EFI_TIMEOUT;
}
//
// Recycle the RxData
//
gBS->SignalEvent (RxData->RecycleSignal);
if (!Matched) {
goto TRY_AGAIN;
}
}
ON_EXIT:
Udp4->Cancel (Udp4, &Token);
gBS->CloseEvent (Token.Event);
return Status;
}
/**
Updates the IP receive filters of a network device and enables software filtering.
The NewFilter field is used to modify the network device's current IP receive
filter settings and to enable a software filter. This function updates the IpFilter
field of the EFI_PXE_BASE_CODE_MODE structure with the contents of NewIpFilter.
The software filter is used when the USE_FILTER in OpFlags is set to UdpRead().
The current hardware filter remains in effect no matter what the settings of OpFlags
are, so that the meaning of ANY_DEST_IP set in OpFlags to UdpRead() is from those
packets whose reception is enabled in hardware-physical NIC address (unicast),
broadcast address, logical address or addresses (multicast), or all (promiscuous).
UdpRead() does not modify the IP filter settings.
Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP receive
filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.
If an application or driver wishes to preserve the IP receive filter settings,
it will have to preserve the IP receive filter settings before these calls, and
use SetIpFilter() to restore them after the calls. If incompatible filtering is
requested (for example, PROMISCUOUS with anything else) or if the device does not
support a requested filter setting and it cannot be accommodated in software
(for example, PROMISCUOUS not supported), EFI_INVALID_PARAMETER will be returned.
The IPlist field is used to enable IPs other than the StationIP. They may be
multicast or unicast. If IPcnt is set as well as EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP,
then both the StationIP and the IPs from the IPlist will be used.
@param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param NewFilter Pointer to the new set of IP receive filters.
@retval EFI_SUCCESS The IP receive filter settings were updated.
@retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.
**/
EFI_STATUS
EFIAPI
EfiPxeBcSetIpFilter (
IN EFI_PXE_BASE_CODE_PROTOCOL *This,
IN EFI_PXE_BASE_CODE_IP_FILTER *NewFilter
)
{
EFI_STATUS Status;
PXEBC_PRIVATE_DATA *Private;
EFI_PXE_BASE_CODE_MODE *Mode;
UINTN Index;
EFI_UDP4_CONFIG_DATA *Udp4Cfg;
BOOLEAN PromiscuousNeed;
BOOLEAN AcceptPromiscuous;
BOOLEAN AcceptBroadcast;
BOOLEAN MultiCastUpdate;
if (This == NULL) {
DEBUG ((EFI_D_ERROR, "This == NULL.\n"));
return EFI_INVALID_PARAMETER;
}
Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);
Mode = Private->PxeBc.Mode;
if (NewFilter == NULL) {
DEBUG ((EFI_D_ERROR, "NewFilter == NULL.\n"));
return EFI_INVALID_PARAMETER;
}
if (NewFilter->IpCnt > EFI_PXE_BASE_CODE_MAX_IPCNT) {
DEBUG ((EFI_D_ERROR, "NewFilter->IpCnt > %d.\n", EFI_PXE_BASE_CODE_MAX_IPCNT));
return EFI_INVALID_PARAMETER;
}
if (!Mode->Started) {
DEBUG ((EFI_D_ERROR, "BC was not started.\n"));
return EFI_NOT_STARTED;
}
if (Mode->UsingIpv6) {
DEBUG ((EFI_D_ERROR, "This driver is PXE for IPv4 Only.\n"));
return EFI_INVALID_PARAMETER;
}
PromiscuousNeed = FALSE;
for (Index = 0; Index < NewFilter->IpCnt; ++Index) {
if (IP4_IS_LOCAL_BROADCAST (EFI_IP4 (NewFilter->IpList[Index].v4))) {
//
// The IP is a broadcast address.
//
DEBUG ((EFI_D_ERROR, "There is broadcast address in NewFilter.\n"));
return EFI_INVALID_PARAMETER;
}
if ((EFI_NTOHL(Mode->StationIp) != 0) &&
(EFI_NTOHL(Mode->SubnetMask) != 0) &&
IP4_NET_EQUAL(EFI_NTOHL(Mode->StationIp), EFI_NTOHL(NewFilter->IpList[Index].v4), EFI_NTOHL(Mode->SubnetMask)) &&
NetIp4IsUnicast (EFI_IP4 (NewFilter->IpList[Index].v4), EFI_NTOHL(Mode->SubnetMask)) &&
((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP) != 0)) {
//
// If EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP is set and IP4 address is in IpList,
// promiscuous mode is needed.
//
PromiscuousNeed = TRUE;
}
}
AcceptPromiscuous = FALSE;
AcceptBroadcast = FALSE;
MultiCastUpdate = FALSE;
if (PromiscuousNeed ||
((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS) != 0) ||
((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS_MULTICAST) != 0)
) {
//
// Configure the udp4 filter to receive all packages.
//
AcceptPromiscuous = TRUE;
} else if ((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_BROADCAST) != 0) {
//
// Configure the udp4 filter to receive all broadcast packages.
//
AcceptBroadcast = TRUE;
}
//
// In multicast condition when Promiscuous FALSE and IpCnt no-zero.
// Here check if there is any update of the multicast ip address. If yes,
// we need leave the old multicast group (by Config UDP instance to NULL),
// and join the new multicast group.
//
if (!AcceptPromiscuous) {
if ((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP) != 0) {
if (Mode->IpFilter.IpCnt != NewFilter->IpCnt) {
MultiCastUpdate = TRUE;
} else if (CompareMem (Mode->IpFilter.IpList, NewFilter->IpList, NewFilter->IpCnt * sizeof (EFI_IP_ADDRESS)) != 0 ) {
MultiCastUpdate = TRUE;
}
}
}
//
// Check whether we need reconfigure the UDP instance.
//
Udp4Cfg = &Private->Udp4CfgData;
if ((AcceptPromiscuous != Udp4Cfg->AcceptPromiscuous) ||
(AcceptBroadcast != Udp4Cfg->AcceptBroadcast) || MultiCastUpdate) {
//
// Clear the UDP instance configuration, all joined groups will be left
// during the operation.
//
Private->Udp4Read->Configure (Private->Udp4Read, NULL);
//
// Configure the UDP instance with the new configuration.
//
Udp4Cfg->AcceptPromiscuous = AcceptPromiscuous;
Udp4Cfg->AcceptBroadcast = AcceptBroadcast;
Status = Private->Udp4Read->Configure (Private->Udp4Read, Udp4Cfg);
if (EFI_ERROR (Status)) {
return Status;
}
//
// In not Promiscuous mode, need to join the new multicast group.
//
if (!AcceptPromiscuous) {
for (Index = 0; Index < NewFilter->IpCnt; ++Index) {
if (IP4_IS_MULTICAST (EFI_NTOHL (NewFilter->IpList[Index].v4))) {
//
// Join the mutilcast group.
//
Status = Private->Udp4Read->Groups (Private->Udp4Read, TRUE, &NewFilter->IpList[Index].v4);
if (EFI_ERROR (Status)) {
return Status;
}
}
}
}
}
//
// Save the new filter.
//
CopyMem (&Mode->IpFilter, NewFilter, sizeof (Mode->IpFilter));
return EFI_SUCCESS;
}
/**
Uses the ARP protocol to resolve a MAC address.
This function uses the ARP protocol to resolve a MAC address. The UsingIpv6 field
of the EFI_PXE_BASE_CODE_MODE structure is used to determine if IPv4 or IPv6
addresses are being used. The IP address specified by IpAddr is used to resolve
a MAC address. If the ARP protocol succeeds in resolving the specified address,
then the ArpCacheEntries and ArpCache fields of the EFI_PXE_BASE_CODE_MODE structure
are updated, and EFI_SUCCESS is returned. If MacAddr is not NULL, the resolved
MAC address is placed there as well. If the PXE Base Code protocol is in the
stopped state, then EFI_NOT_STARTED is returned. If the ARP protocol encounters
a timeout condition while attempting to resolve an address, then EFI_TIMEOUT is
returned. If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,
then EFI_ABORTED is returned.
@param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param IpAddr Pointer to the IP address that is used to resolve a MAC address.
@param MacAddr If not NULL, a pointer to the MAC address that was resolved with the
ARP protocol.
@retval EFI_SUCCESS The IP or MAC address was resolved.
@retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.
@retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
@retval EFI_ICMP_ERROR Something error occur with the ICMP packet message.
**/
EFI_STATUS
EFIAPI
EfiPxeBcArp (
IN EFI_PXE_BASE_CODE_PROTOCOL * This,
IN EFI_IP_ADDRESS * IpAddr,
IN EFI_MAC_ADDRESS * MacAddr OPTIONAL
)
{
PXEBC_PRIVATE_DATA *Private;
EFI_PXE_BASE_CODE_MODE *Mode;
EFI_STATUS Status;
EFI_MAC_ADDRESS TempMacAddr;
if (This == NULL || IpAddr == NULL) {
return EFI_INVALID_PARAMETER;
}
Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);
Mode = Private->PxeBc.Mode;
if (!Mode->Started) {
return EFI_NOT_STARTED;
}
if (!Private->AddressIsOk || Mode->UsingIpv6) {
//
// We can't resolve the IP address if we don't have a local address now.
// Don't have ARP for IPv6.
//
return EFI_INVALID_PARAMETER;
}
Mode->IcmpErrorReceived = FALSE;
if (!Mode->AutoArp) {
//
// If AutoArp is set false, check arp cache
//
UpdateArpCache (This);
if (!FindInArpCache (Mode, &IpAddr->v4, &TempMacAddr)) {
return EFI_DEVICE_ERROR;
}
} else {
Status = Private->Arp->Request (Private->Arp, &IpAddr->v4, NULL, &TempMacAddr);
if (EFI_ERROR (Status)) {
if (Status == EFI_ICMP_ERROR) {
Mode->IcmpErrorReceived = TRUE;
}
return Status;
}
}
if (MacAddr != NULL) {
CopyMem (MacAddr, &TempMacAddr, sizeof (EFI_MAC_ADDRESS));
}
return EFI_SUCCESS;
}
/**
Updates the parameters that affect the operation of the PXE Base Code Protocol.
This function sets parameters that affect the operation of the PXE Base Code Protocol.
The parameter specified by NewAutoArp is used to control the generation of ARP
protocol packets. If NewAutoArp is TRUE, then ARP Protocol packets will be generated
as required by the PXE Base Code Protocol. If NewAutoArp is FALSE, then no ARP
Protocol packets will be generated. In this case, the only mappings that are
available are those stored in the ArpCache of the EFI_PXE_BASE_CODE_MODE structure.
If there are not enough mappings in the ArpCache to perform a PXE Base Code Protocol
service, then the service will fail. This function updates the AutoArp field of
the EFI_PXE_BASE_CODE_MODE structure to NewAutoArp.
The SetParameters() call must be invoked after a Callback Protocol is installed
to enable the use of callbacks.
@param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param NewAutoArp If not NULL, a pointer to a value that specifies whether to replace the
current value of AutoARP.
@param NewSendGUID If not NULL, a pointer to a value that specifies whether to replace the
current value of SendGUID.
@param NewTTL If not NULL, a pointer to be used in place of the current value of TTL,
the "time to live" field of the IP header.
@param NewToS If not NULL, a pointer to be used in place of the current value of ToS,
the "type of service" field of the IP header.
@param NewMakeCallback If not NULL, a pointer to a value that specifies whether to replace the
current value of the MakeCallback field of the Mode structure.
@retval EFI_SUCCESS The new parameters values were updated.
@retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.
**/
EFI_STATUS
EFIAPI
EfiPxeBcSetParameters (
IN EFI_PXE_BASE_CODE_PROTOCOL *This,
IN BOOLEAN *NewAutoArp OPTIONAL,
IN BOOLEAN *NewSendGUID OPTIONAL,
IN UINT8 *NewTTL OPTIONAL,
IN UINT8 *NewToS OPTIONAL,
IN BOOLEAN *NewMakeCallback // OPTIONAL
)
{
PXEBC_PRIVATE_DATA *Private;
EFI_PXE_BASE_CODE_MODE *Mode;
EFI_STATUS Status;
Status = EFI_SUCCESS;
if (This == NULL) {
Status = EFI_INVALID_PARAMETER;
goto ON_EXIT;
}
Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);
Mode = Private->PxeBc.Mode;
if (NewSendGUID != NULL && *NewSendGUID) {
//
// FixMe, cann't locate SendGuid
//
}
if (NewMakeCallback != NULL && *NewMakeCallback) {
Status = gBS->HandleProtocol (
Private->Controller,
&gEfiPxeBaseCodeCallbackProtocolGuid,
(VOID **) &Private->PxeBcCallback
);
if (EFI_ERROR (Status) || (Private->PxeBcCallback->Callback == NULL)) {
Status = EFI_INVALID_PARAMETER;
goto ON_EXIT;
}
}
if (!Mode->Started) {
Status = EFI_NOT_STARTED;
goto ON_EXIT;
}
if (NewMakeCallback != NULL) {
if (*NewMakeCallback) {
//
// Update the Callback protocol.
//
Status = gBS->HandleProtocol (
Private->Controller,
&gEfiPxeBaseCodeCallbackProtocolGuid,
(VOID **) &Private->PxeBcCallback
);
if (EFI_ERROR (Status) || (Private->PxeBcCallback->Callback == NULL)) {
Status = EFI_INVALID_PARAMETER;
goto ON_EXIT;
}
} else {
Private->PxeBcCallback = NULL;
}
Mode->MakeCallbacks = *NewMakeCallback;
}
if (NewAutoArp != NULL) {
Mode->AutoArp = *NewAutoArp;
}
if (NewSendGUID != NULL) {
Mode->SendGUID = *NewSendGUID;
}
if (NewTTL != NULL) {
Mode->TTL = *NewTTL;
}
if (NewToS != NULL) {
Mode->ToS = *NewToS;
}
ON_EXIT:
return Status;
}
/**
Updates the station IP address and/or subnet mask values of a network device.
This function updates the station IP address and/or subnet mask values of a network
device. The NewStationIp field is used to modify the network device's current IP address.
If NewStationIP is NULL, then the current IP address will not be modified. Otherwise,
this function updates the StationIp field of the EFI_PXE_BASE_CODE_MODE structure
with NewStationIp. The NewSubnetMask field is used to modify the network device's current subnet
mask. If NewSubnetMask is NULL, then the current subnet mask will not be modified.
Otherwise, this function updates the SubnetMask field of the EFI_PXE_BASE_CODE_MODE
structure with NewSubnetMask.
@param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param NewStationIp Pointer to the new IP address to be used by the network device.
@param NewSubnetMask Pointer to the new subnet mask to be used by the network device.
@retval EFI_SUCCESS The new station IP address and/or subnet mask were updated.
@retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.
**/
EFI_STATUS
EFIAPI
EfiPxeBcSetStationIP (
IN EFI_PXE_BASE_CODE_PROTOCOL * This,
IN EFI_IP_ADDRESS * NewStationIp OPTIONAL,
IN EFI_IP_ADDRESS * NewSubnetMask OPTIONAL
)
{
PXEBC_PRIVATE_DATA *Private;
EFI_PXE_BASE_CODE_MODE *Mode;
EFI_ARP_CONFIG_DATA ArpConfigData;
if (This == NULL) {
return EFI_INVALID_PARAMETER;
}
if (NewSubnetMask != NULL && !IP4_IS_VALID_NETMASK (NTOHL (NewSubnetMask->Addr[0]))) {
return EFI_INVALID_PARAMETER;
}
if (NewStationIp != NULL) {
if (IP4_IS_UNSPECIFIED(NTOHL (NewStationIp->Addr[0])) ||
IP4_IS_LOCAL_BROADCAST(NTOHL (NewStationIp->Addr[0])) ||
(NewSubnetMask != NULL && NewSubnetMask->Addr[0] != 0 && !NetIp4IsUnicast (NTOHL (NewStationIp->Addr[0]), NTOHL (NewSubnetMask->Addr[0])))) {
return EFI_INVALID_PARAMETER;
}
}
Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);
Mode = Private->PxeBc.Mode;
if (!Mode->Started) {
return EFI_NOT_STARTED;
}
if (NewStationIp != NULL) {
CopyMem (&Mode->StationIp, NewStationIp, sizeof (EFI_IP_ADDRESS));
CopyMem (&Private->StationIp, NewStationIp, sizeof (EFI_IP_ADDRESS));
}
if (NewSubnetMask != NULL) {
CopyMem (&Mode->SubnetMask, NewSubnetMask, sizeof (EFI_IP_ADDRESS));
CopyMem (&Private->SubnetMask ,NewSubnetMask, sizeof (EFI_IP_ADDRESS));
}
Private->AddressIsOk = TRUE;
if (!Mode->UsingIpv6) {
//
// If in IPv4 mode, configure the corresponding ARP with this new
// station IP address.
//
ZeroMem (&ArpConfigData, sizeof (EFI_ARP_CONFIG_DATA));
ArpConfigData.SwAddressType = 0x0800;
ArpConfigData.SwAddressLength = (UINT8) sizeof (EFI_IPv4_ADDRESS);
ArpConfigData.StationAddress = &Private->StationIp.v4;
Private->Arp->Configure (Private->Arp, NULL);
Private->Arp->Configure (Private->Arp, &ArpConfigData);
//
// Update the route table.
//
Mode->RouteTableEntries = 1;
Mode->RouteTable[0].IpAddr.Addr[0] = Private->StationIp.Addr[0] & Private->SubnetMask.Addr[0];
Mode->RouteTable[0].SubnetMask.Addr[0] = Private->SubnetMask.Addr[0];
Mode->RouteTable[0].GwAddr.Addr[0] = 0;
}
return EFI_SUCCESS;
}
/**
Updates the contents of the cached DHCP and Discover packets.
The pointers to the new packets are used to update the contents of the cached
packets in the EFI_PXE_BASE_CODE_MODE structure.
@param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
@param NewDhcpDiscoverValid Pointer to a value that will replace the current
DhcpDiscoverValid field.
@param NewDhcpAckReceived Pointer to a value that will replace the current
DhcpAckReceived field.
@param NewProxyOfferReceived Pointer to a value that will replace the current
ProxyOfferReceived field.
@param NewPxeDiscoverValid Pointer to a value that will replace the current
ProxyOfferReceived field.
@param NewPxeReplyReceived Pointer to a value that will replace the current
PxeReplyReceived field.
@param NewPxeBisReplyReceived Pointer to a value that will replace the current
PxeBisReplyReceived field.
@param NewDhcpDiscover Pointer to the new cached DHCP Discover packet contents.
@param NewDhcpAck Pointer to the new cached DHCP Ack packet contents.
@param NewProxyOffer Pointer to the new cached Proxy Offer packet contents.
@param NewPxeDiscover Pointer to the new cached PXE Discover packet contents.
@param NewPxeReply Pointer to the new cached PXE Reply packet contents.
@param NewPxeBisReply Pointer to the new cached PXE BIS Reply packet contents.
@retval EFI_SUCCESS The cached packet contents were updated.
@retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
@retval EFI_INVALID_PARAMETER This is NULL or not point to a valid EFI_PXE_BASE_CODE_PROTOCOL structure.
**/
EFI_STATUS
EFIAPI
EfiPxeBcSetPackets (
IN EFI_PXE_BASE_CODE_PROTOCOL * This,
IN BOOLEAN * NewDhcpDiscoverValid OPTIONAL,
IN BOOLEAN * NewDhcpAckReceived OPTIONAL,
IN BOOLEAN * NewProxyOfferReceived OPTIONAL,
IN BOOLEAN * NewPxeDiscoverValid OPTIONAL,
IN BOOLEAN * NewPxeReplyReceived OPTIONAL,
IN BOOLEAN * NewPxeBisReplyReceived OPTIONAL,
IN EFI_PXE_BASE_CODE_PACKET * NewDhcpDiscover OPTIONAL,
IN EFI_PXE_BASE_CODE_PACKET * NewDhcpAck OPTIONAL,
IN EFI_PXE_BASE_CODE_PACKET * NewProxyOffer OPTIONAL,
IN EFI_PXE_BASE_CODE_PACKET * NewPxeDiscover OPTIONAL,
IN EFI_PXE_BASE_CODE_PACKET * NewPxeReply OPTIONAL,
IN EFI_PXE_BASE_CODE_PACKET * NewPxeBisReply OPTIONAL
)
{
PXEBC_PRIVATE_DATA *Private;
EFI_PXE_BASE_CODE_MODE *Mode;
if (This == NULL) {
return EFI_INVALID_PARAMETER;
}
Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);
Mode = Private->PxeBc.Mode;
if (!Mode->Started) {
return EFI_NOT_STARTED;
}
if (NewDhcpDiscoverValid != NULL) {
Mode->DhcpDiscoverValid = *NewDhcpDiscoverValid;
}
if (NewDhcpAckReceived != NULL) {
Mode->DhcpAckReceived = *NewDhcpAckReceived;
}
if (NewProxyOfferReceived != NULL) {
Mode->ProxyOfferReceived = *NewProxyOfferReceived;
}
if (NewPxeDiscoverValid != NULL) {
Mode->PxeDiscoverValid = *NewPxeDiscoverValid;
}
if (NewPxeReplyReceived != NULL) {
Mode->PxeReplyReceived = *NewPxeReplyReceived;
}
if (NewPxeBisReplyReceived != NULL) {
Mode->PxeBisReplyReceived = *NewPxeBisReplyReceived;
}
if (NewDhcpDiscover != NULL) {
CopyMem (&Mode->DhcpDiscover, NewDhcpDiscover, sizeof (EFI_PXE_BASE_CODE_PACKET));
}
if (NewDhcpAck != NULL) {
CopyMem (&Mode->DhcpAck, NewDhcpAck, sizeof (EFI_PXE_BASE_CODE_PACKET));
}
if (NewProxyOffer != NULL) {
CopyMem (&Mode->ProxyOffer, NewProxyOffer, sizeof (EFI_PXE_BASE_CODE_PACKET));
}
if (NewPxeDiscover != NULL) {
CopyMem (&Mode->PxeDiscover, NewPxeDiscover, sizeof (EFI_PXE_BASE_CODE_PACKET));
}
if (NewPxeReply != NULL) {
CopyMem (&Mode->PxeReply, NewPxeReply, sizeof (EFI_PXE_BASE_CODE_PACKET));
}
if (NewPxeBisReply != NULL) {
CopyMem (&Mode->PxeBisReply, NewPxeBisReply, sizeof (EFI_PXE_BASE_CODE_PACKET));
}
return EFI_SUCCESS;
}
EFI_PXE_BASE_CODE_PROTOCOL mPxeBcProtocolTemplate = {
EFI_PXE_BASE_CODE_PROTOCOL_REVISION,
EfiPxeBcStart,
EfiPxeBcStop,
EfiPxeBcDhcp,
EfiPxeBcDiscover,
EfiPxeBcMtftp,
EfiPxeBcUdpWrite,
EfiPxeBcUdpRead,
EfiPxeBcSetIpFilter,
EfiPxeBcArp,
EfiPxeBcSetParameters,
EfiPxeBcSetStationIP,
EfiPxeBcSetPackets,
NULL
};
/**
Callback function that is invoked when the PXE Base Code Protocol is about to transmit, has
received, or is waiting to receive a packet.
This function is invoked when the PXE Base Code Protocol is about to transmit, has received,
or is waiting to receive a packet. Parameters Function and Received specify the type of event.
Parameters PacketLen and Packet specify the packet that generated the event. If these fields
are zero and NULL respectively, then this is a status update callback. If the operation specified
by Function is to continue, then CALLBACK_STATUS_CONTINUE should be returned. If the operation
specified by Function should be aborted, then CALLBACK_STATUS_ABORT should be returned. Due to
the polling nature of UEFI device drivers, a callback function should not execute for more than 5 ms.
The SetParameters() function must be called after a Callback Protocol is installed to enable the
use of callbacks.
@param This Pointer to the EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL instance.
@param Function The PXE Base Code Protocol function that is waiting for an event.
@param Received TRUE if the callback is being invoked due to a receive event. FALSE if
the callback is being invoked due to a transmit event.
@param PacketLength The length, in bytes, of Packet. This field will have a value of zero if
this is a wait for receive event.
@param PacketPtr If Received is TRUE, a pointer to the packet that was just received;
otherwise a pointer to the packet that is about to be transmitted.
@retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE if Function specifies a continue operation
@retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT if Function specifies an abort operation
**/
EFI_PXE_BASE_CODE_CALLBACK_STATUS
EFIAPI
EfiPxeLoadFileCallback (
IN EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL * This,
IN EFI_PXE_BASE_CODE_FUNCTION Function,
IN BOOLEAN Received,
IN UINT32 PacketLength,
IN EFI_PXE_BASE_CODE_PACKET * PacketPtr OPTIONAL
)
{
EFI_INPUT_KEY Key;
EFI_STATUS Status;
//
// Catch Ctrl-C or ESC to abort.
//
Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);
if (!EFI_ERROR (Status)) {
if (Key.ScanCode == SCAN_ESC || Key.UnicodeChar == (0x1F & 'c')) {
return EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT;
}
}
//
// No print if receive packet
//
if (Received) {
return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE;
}
//
// Print only for three functions
//
switch (Function) {
case EFI_PXE_BASE_CODE_FUNCTION_MTFTP:
//
// Print only for open MTFTP packets, not every MTFTP packets
//
if (PacketLength != 0 && PacketPtr != NULL) {
if (PacketPtr->Raw[0x1C] != 0x00 || PacketPtr->Raw[0x1D] != 0x01) {
return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE;
}
}
break;
case EFI_PXE_BASE_CODE_FUNCTION_DHCP:
case EFI_PXE_BASE_CODE_FUNCTION_DISCOVER:
break;
default:
return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE;
}
if (PacketLength != 0 && PacketPtr != NULL) {
//
// Print '.' when transmit a packet
//
AsciiPrint (".");
}
return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE;
}
EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL mPxeBcCallBackTemplate = {
EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION,
EfiPxeLoadFileCallback
};
/**
Find the boot file.
@param Private Pointer to PxeBc private data.
@param BufferSize Pointer to buffer size.
@param Buffer Pointer to buffer.
@retval EFI_SUCCESS Discover the boot file successfully.
@retval EFI_TIMEOUT The TFTP/MTFTP operation timed out.
@retval EFI_ABORTED PXE bootstrap server, so local boot need abort.
@retval EFI_BUFFER_TOO_SMALL The buffer is too small to load the boot file.
**/
EFI_STATUS
DiscoverBootFile (
IN PXEBC_PRIVATE_DATA *Private,
IN OUT UINT64 *BufferSize,
IN VOID *Buffer
)
{
EFI_PXE_BASE_CODE_PROTOCOL *PxeBc;
EFI_PXE_BASE_CODE_MODE *Mode;
EFI_STATUS Status;
UINT16 Type;
UINT16 Layer;
BOOLEAN UseBis;
PXEBC_CACHED_DHCP4_PACKET *Packet;
UINT16 Value;
PxeBc = &Private->PxeBc;
Mode = PxeBc->Mode;
Type = EFI_PXE_BASE_CODE_BOOT_TYPE_BOOTSTRAP;
Layer = EFI_PXE_BASE_CODE_BOOT_LAYER_INITIAL;
//
// do DHCP.
//
Status = PxeBc->Dhcp (PxeBc, TRUE);
if (EFI_ERROR (Status)) {
return Status;
}
//
// Select a boot server
//
Status = PxeBcSelectBootPrompt (Private);
if (Status == EFI_SUCCESS) {
Status = PxeBcSelectBootMenu (Private, &Type, TRUE);
} else if (Status == EFI_TIMEOUT) {
Status = PxeBcSelectBootMenu (Private, &Type, FALSE);
}
if (!EFI_ERROR (Status)) {
if (Type == EFI_PXE_BASE_CODE_BOOT_TYPE_BOOTSTRAP) {
//
// Local boot(PXE bootstrap server) need abort
//
return EFI_ABORTED;
}
UseBis = (BOOLEAN) (Mode->BisSupported && Mode->BisDetected);
Status = PxeBc->Discover (PxeBc, Type, &Layer, UseBis, NULL);
if (EFI_ERROR (Status)) {
return Status;
}
}
*BufferSize = 0;
//
// Get bootfile name and (m)tftp server ip addresss
//
if (Mode->PxeReplyReceived) {
Packet = &Private->PxeReply;
} else if (Mode->ProxyOfferReceived) {
Packet = &Private->ProxyOffer;
} else {
Packet = &Private->Dhcp4Ack;
}
//
// Use siaddr(next server) in DHCPOFFER packet header, if zero, use option 54(server identifier)
// in DHCPOFFER packet.
// (It does not comply with PXE Spec, Ver2.1)
//
if (EFI_IP4_EQUAL (&Packet->Packet.Offer.Dhcp4.Header.ServerAddr, &mZeroIp4Addr)) {
CopyMem (
&Private->ServerIp,
Packet->Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_SERVER_ID]->Data,
sizeof (EFI_IPv4_ADDRESS)
);
} else {
CopyMem (
&Private->ServerIp,
&Packet->Packet.Offer.Dhcp4.Header.ServerAddr,
sizeof (EFI_IPv4_ADDRESS)
);
}
if (Private->ServerIp.Addr[0] == 0) {
return EFI_DEVICE_ERROR;
}
ASSERT (Packet->Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_BOOTFILE] != NULL);
//
// bootlfile name
//
Private->BootFileName = (CHAR8 *) (Packet->Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_BOOTFILE]->Data);
if (Packet->Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_BOOTFILE_LEN] != NULL) {
//
// Already have the bootfile length option, compute the file size
//
CopyMem (&Value, Packet->Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_BOOTFILE_LEN]->Data, sizeof (Value));
Value = NTOHS (Value);
*BufferSize = 512 * Value;
Status = EFI_BUFFER_TOO_SMALL;
} else {
//
// Get the bootfile size from tftp
//
Status = PxeBc->Mtftp (
PxeBc,
EFI_PXE_BASE_CODE_TFTP_GET_FILE_SIZE,
Buffer,
FALSE,
BufferSize,
&Private->BlockSize,
&Private->ServerIp,
(UINT8 *) Private->BootFileName,
NULL,
FALSE
);
}
Private->FileSize = (UINTN) *BufferSize;
//
// Display all the information: boot server address, boot file name and boot file size.
//
AsciiPrint ("\n Server IP address is ");
PxeBcShowIp4Addr (&Private->ServerIp.v4);
AsciiPrint ("\n NBP filename is %a", Private->BootFileName);
AsciiPrint ("\n NBP filesize is %d Bytes", Private->FileSize);
return Status;
}
/**
Causes the driver to load a specified file.
@param This Protocol instance pointer.
@param FilePath The device specific path of the file to load.
@param BootPolicy If TRUE, indicates that the request originates from the
boot manager is attempting to load FilePath as a boot
selection. If FALSE, then FilePath must match as exact file
to be loaded.
@param BufferSize On input the size of Buffer in bytes. On output with a return
code of EFI_SUCCESS, the amount of data transferred to
Buffer. On output with a return code of EFI_BUFFER_TOO_SMALL,
the size of Buffer required to retrieve the requested file.
@param Buffer The memory buffer to transfer the file to. IF Buffer is NULL,
then no the size of the requested file is returned in
BufferSize.
@retval EFI_SUCCESS The file was loaded.
@retval EFI_UNSUPPORTED The device does not support the provided BootPolicy
@retval EFI_INVALID_PARAMETER FilePath is not a valid device path, or
BufferSize is NULL.
@retval EFI_NO_MEDIA No medium was present to load the file.
@retval EFI_DEVICE_ERROR The file was not loaded due to a device error.
@retval EFI_NO_RESPONSE The remote system did not respond.
@retval EFI_NOT_FOUND The file was not found.
@retval EFI_ABORTED The file load process was manually cancelled.
**/
EFI_STATUS
EFIAPI
EfiPxeLoadFile (
IN EFI_LOAD_FILE_PROTOCOL * This,
IN EFI_DEVICE_PATH_PROTOCOL * FilePath,
IN BOOLEAN BootPolicy,
IN OUT UINTN *BufferSize,
IN VOID *Buffer OPTIONAL
)
{
PXEBC_PRIVATE_DATA *Private;
EFI_PXE_BASE_CODE_PROTOCOL *PxeBc;
BOOLEAN NewMakeCallback;
EFI_STATUS Status;
UINT64 TmpBufSize;
EFI_STATUS MediaStatus;
if (FilePath == NULL || !IsDevicePathEnd (FilePath)) {
return EFI_INVALID_PARAMETER;
}
Private = PXEBC_PRIVATE_DATA_FROM_LOADFILE (This);
PxeBc = &Private->PxeBc;
NewMakeCallback = FALSE;
Status = EFI_DEVICE_ERROR;
if (This == NULL || BufferSize == NULL) {
return EFI_INVALID_PARAMETER;
}
//
// Only support BootPolicy
//
if (!BootPolicy) {
return EFI_UNSUPPORTED;
}
//
// Check media status before PXE start
//
MediaStatus = EFI_SUCCESS;
NetLibDetectMediaWaitTimeout (Private->Controller, PXEBC_CHECK_MEDIA_WAITING_TIME, &MediaStatus);
if (MediaStatus != EFI_SUCCESS) {
return EFI_NO_MEDIA;
}
Status = PxeBc->Start (PxeBc, FALSE);
if (EFI_ERROR (Status) && (Status != EFI_ALREADY_STARTED)) {
return Status;
}
Status = gBS->HandleProtocol (
Private->Controller,
&gEfiPxeBaseCodeCallbackProtocolGuid,
(VOID **) &Private->PxeBcCallback
);
if (Status == EFI_UNSUPPORTED) {
CopyMem (&Private->LoadFileCallback, &mPxeBcCallBackTemplate, sizeof (Private->LoadFileCallback));
Status = gBS->InstallProtocolInterface (
&Private->Controller,
&gEfiPxeBaseCodeCallbackProtocolGuid,
EFI_NATIVE_INTERFACE,
&Private->LoadFileCallback
);
NewMakeCallback = (BOOLEAN) (Status == EFI_SUCCESS);
Status = PxeBc->SetParameters (PxeBc, NULL, NULL, NULL, NULL, &NewMakeCallback);
if (EFI_ERROR (Status)) {
PxeBc->Stop (PxeBc);
return Status;
}
}
if (Private->FileSize == 0) {
TmpBufSize = 0;
Status = DiscoverBootFile (Private, &TmpBufSize, Buffer);
if (sizeof (UINTN) < sizeof (UINT64) && (TmpBufSize > 0xFFFFFFFF)) {
Status = EFI_DEVICE_ERROR;
} else if (TmpBufSize > 0 && *BufferSize >= (UINTN) TmpBufSize && Buffer != NULL) {
AsciiPrint ("\n Downloading NBP file...\n");
*BufferSize = (UINTN) TmpBufSize;
Status = PxeBc->Mtftp (
PxeBc,
EFI_PXE_BASE_CODE_TFTP_READ_FILE,
Buffer,
FALSE,
&TmpBufSize,
&Private->BlockSize,
&Private->ServerIp,
(UINT8 *) Private->BootFileName,
NULL,
FALSE
);
} else if (TmpBufSize > 0) {
*BufferSize = (UINTN) TmpBufSize;
Status = EFI_BUFFER_TOO_SMALL;
}
} else if (Buffer == NULL || Private->FileSize > *BufferSize) {
*BufferSize = Private->FileSize;
Status = EFI_BUFFER_TOO_SMALL;
} else {
//
// Download the file.
//
AsciiPrint ("\n Downloading NBP file...\n");
TmpBufSize = (UINT64) (*BufferSize);
Status = PxeBc->Mtftp (
PxeBc,
EFI_PXE_BASE_CODE_TFTP_READ_FILE,
Buffer,
FALSE,
&TmpBufSize,
&Private->BlockSize,
&Private->ServerIp,
(UINT8 *) Private->BootFileName,
NULL,
FALSE
);
}
//
// If we added a callback protocol, now is the time to remove it.
//
if (NewMakeCallback) {
NewMakeCallback = FALSE;
PxeBc->SetParameters (PxeBc, NULL, NULL, NULL, NULL, &NewMakeCallback);
gBS->UninstallProtocolInterface (
Private->Controller,
&gEfiPxeBaseCodeCallbackProtocolGuid,
&Private->LoadFileCallback
);
}
//
// Check download status
//
if (Status == EFI_SUCCESS) {
AsciiPrint ("\n NBP file downloaded successfully.\n");
//
// The DHCP4 can have only one configured child instance so we need to stop
// reset the DHCP4 child before we return. Otherwise the other programs which
// also need to use DHCP4 will be impacted.
// The functionality of PXE Base Code protocol will not be stopped,
// when downloading is successfully.
//
Private->Dhcp4->Stop (Private->Dhcp4);
Private->Dhcp4->Configure (Private->Dhcp4, NULL);
return EFI_SUCCESS;
} else if (Status == EFI_BUFFER_TOO_SMALL) {
if (Buffer != NULL) {
AsciiPrint ("PXE-E05: Download buffer is smaller than requested file.\n");
} else {
//
// The functionality of PXE Base Code protocol will not be stopped.
//
return Status;
}
} else if (Status == EFI_DEVICE_ERROR) {
AsciiPrint ("PXE-E07: Network device error.\n");
} else if (Status == EFI_OUT_OF_RESOURCES) {
AsciiPrint ("PXE-E09: Could not allocate I/O buffers.\n");
} else if (Status == EFI_NO_MEDIA) {
AsciiPrint ("PXE-E12: Could not detect network connection.\n");
} else if (Status == EFI_NO_RESPONSE) {
AsciiPrint ("PXE-E16: No offer received.\n");
} else if (Status == EFI_TIMEOUT) {
AsciiPrint ("PXE-E18: Server response timeout.\n");
} else if (Status == EFI_ABORTED) {
AsciiPrint ("PXE-E21: Remote boot cancelled.\n");
} else if (Status == EFI_ICMP_ERROR) {
AsciiPrint ("PXE-E22: Client received ICMP error from server.\n");
} else if (Status == EFI_TFTP_ERROR) {
AsciiPrint ("PXE-E23: Client received TFTP error from server.\n");
} else {
AsciiPrint ("PXE-E99: Unexpected network error.\n");
}
PxeBc->Stop (PxeBc);
return Status;
}
EFI_LOAD_FILE_PROTOCOL mLoadFileProtocolTemplate = { EfiPxeLoadFile };
|