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
|
/** @file
Implement the TCP4 driver support for the socket layer.
Copyright (c) 2011 - 2015, 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.
\section ConnectionManagement Connection Management
The ::EslTcp4Listen routine initially places the SOCK_STREAM or
SOCK_SEQPACKET socket into a listen state. When a remote machine
makes a connection to the socket, the TCPv4 network layer calls
::EslTcp4ListenComplete to complete the connection processing.
EslTcp4ListenComplete manages the connections by placing them in
FIFO order in a queue to be serviced by the application. When the
number of connections exceeds the backlog (ESL_SOCKET::MaxFifoDepth),
the new connection is closed. Eventually, the application indirectly
calls ::EslTcp4Accept to remove the next connection from the queue
and get the associated socket.
**/
#include "Socket.h"
/**
Attempt to connect to a remote TCP port
This routine starts the connection processing for a SOCK_STREAM
or SOCK_SEQPAKCET socket using the TCPv4 network layer. It
configures the local TCPv4 connection point and then attempts to
connect to a remote system. Upon completion, the
::EslTcp4ConnectComplete routine gets called with the connection
status.
This routine is called by ::EslSocketConnect to initiate the TCPv4
network specific connect operations. The connection processing is
initiated by this routine and finished by ::EslTcp4ConnectComplete.
This pair of routines walks through the list of local TCPv4
connection points until a connection to the remote system is
made.
@param [in] pSocket Address of an ::ESL_SOCKET structure.
@retval EFI_SUCCESS The connection was successfully established.
@retval EFI_NOT_READY The connection is in progress, call this routine again.
@retval Others The connection attempt failed.
**/
EFI_STATUS
EslTcp4ConnectStart (
IN ESL_SOCKET * pSocket
);
/**
Process the connection attempt
A system has initiated a connection attempt with a socket in the
listen state. Attempt to complete the connection.
The TCPv4 layer calls this routine when a connection is made to
the socket in the listen state. See the
\ref ConnectionManagement section.
@param [in] Event The listen completion event
@param [in] pPort Address of an ::ESL_PORT structure.
**/
VOID
EslTcp4ListenComplete (
IN EFI_EVENT Event,
IN ESL_PORT * pPort
);
/**
Accept a network connection.
This routine waits for a network connection to the socket and
returns the remote network address to the caller if requested.
This routine is called by ::EslSocketAccept to handle the TCPv4 protocol
specific accept operations for SOCK_STREAM and SOCK_SEQPACKET sockets.
See the \ref ConnectionManagement section.
@param [in] pSocket Address of an ::ESL_SOCKET structure.
@param [in] pSockAddr Address of a buffer to receive the remote
network address.
@param [in, out] pSockAddrLength Length in bytes of the address buffer.
On output specifies the length of the
remote network address.
@retval EFI_SUCCESS Remote address is available
@retval Others Remote address not available
**/
EFI_STATUS
EslTcp4Accept (
IN ESL_SOCKET * pSocket,
IN struct sockaddr * pSockAddr,
IN OUT socklen_t * pSockAddrLength
)
{
ESL_PORT * pPort;
struct sockaddr_in * pRemoteAddress;
ESL_TCP4_CONTEXT * pTcp4;
UINT32 RemoteAddress;
EFI_STATUS Status;
DBG_ENTER ( );
//
// Validate the socket length
//
pRemoteAddress = (struct sockaddr_in *) pSockAddr;
if (( NULL == pSockAddrLength )
|| ( sizeof ( *pRemoteAddress ) > *pSockAddrLength )) {
//
// Invalid socket address
//
Status = EFI_INVALID_PARAMETER;
pSocket->errno = EINVAL;
DEBUG (( DEBUG_ACCEPT,
"ERROR - Invalid address length\r\n" ));
}
else {
//
// Assume success
//
Status = EFI_SUCCESS;
//
// Locate the address context
//
pPort = pSocket->pPortList;
pTcp4 = &pPort->Context.Tcp4;
//
// Fill-in the remote address structure
//
ZeroMem ( pRemoteAddress, sizeof ( *pRemoteAddress ));
pRemoteAddress->sin_len = sizeof ( *pRemoteAddress );
pRemoteAddress->sin_family = AF_INET;
pRemoteAddress->sin_port = SwapBytes16 ( pTcp4->ConfigData.AccessPoint.RemotePort );
RemoteAddress = pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[3];
RemoteAddress <<= 8;
RemoteAddress |= pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[2];
RemoteAddress <<= 8;
RemoteAddress |= pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[1];
RemoteAddress <<= 8;
RemoteAddress |= pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[0];
pRemoteAddress->sin_addr.s_addr = RemoteAddress;
}
//
// Return the operation status
//
DBG_EXIT_STATUS ( Status );
return Status;
}
/**
Process the remote connection completion event.
This routine handles the completion of a connection attempt. It
releases the port (TCPv4 adapter connection) in the case of an
error and start a connection attempt on the next port. If the
connection attempt was successful then this routine releases all
of the other ports.
This routine is called by the TCPv4 layer when a connect request
completes. It sets the ESL_SOCKET::bConnected flag to notify the
::EslTcp4ConnectComplete routine that the connection is available.
The flag is set when the connection is established or no more ports
exist in the list. The connection status is passed via
ESL_SOCKET::ConnectStatus.
@param [in] Event The connect completion event
@param [in] pPort Address of an ::ESL_PORT structure.
**/
VOID
EslTcp4ConnectComplete (
IN EFI_EVENT Event,
IN ESL_PORT * pPort
)
{
BOOLEAN bRemoveFirstPort;
BOOLEAN bRemovePorts;
ESL_PORT * pNextPort;
ESL_SOCKET * pSocket;
ESL_TCP4_CONTEXT * pTcp4;
EFI_STATUS Status;
DBG_ENTER ( );
//
// Locate the TCP context
//
pSocket = pPort->pSocket;
pTcp4 = &pPort->Context.Tcp4;
//
// Get the connection status
//
bRemoveFirstPort = FALSE;
bRemovePorts = FALSE;
Status = pTcp4->ConnectToken.CompletionToken.Status;
pSocket->ConnectStatus = Status;
if ( !EFI_ERROR ( Status )) {
//
// The connection was successful
//
DEBUG (( DEBUG_CONNECT,
"0x%08x: Port connected to %d.%d.%d.%d:%d\r\n",
pPort,
pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[0],
pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[1],
pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[2],
pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[3],
pTcp4->ConfigData.AccessPoint.RemotePort ));
//
// Start the receive operations
//
pSocket->bConfigured = TRUE;
pSocket->State = SOCKET_STATE_CONNECTED;
EslSocketRxStart ( pPort );
//
// Remove the rest of the ports
//
bRemovePorts = TRUE;
}
else {
//
// The connection failed
//
if ( pPort->bConfigured ) {
DEBUG (( DEBUG_CONNECT,
"0x%08x: Port connection to %d.%d.%d.%d:%d failed, Status: %r\r\n",
pPort,
pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[0],
pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[1],
pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[2],
pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[3],
pTcp4->ConfigData.AccessPoint.RemotePort,
Status ));
}
//
// Close the current port
//
Status = EslSocketPortClose ( pPort );
if ( !EFI_ERROR ( Status )) {
DEBUG (( DEBUG_CONNECT,
"0x%08x: Port closed\r\n",
pPort ));
}
else {
DEBUG (( DEBUG_CONNECT,
"ERROR - Failed to close port 0x%08x, Status: %r\r\n",
pPort,
Status ));
}
//
// Try to connect using the next port
//
Status = EslTcp4ConnectStart ( pSocket );
if ( EFI_NOT_READY != Status ) {
bRemoveFirstPort = TRUE;
}
}
//
// Remove the ports if necessary
//
if ( bRemoveFirstPort || bRemovePorts ) {
//
// Remove the first port if necessary
//
pPort = pSocket->pPortList;
if (( !bRemoveFirstPort ) && ( NULL != pPort )) {
pPort = pPort->pLinkSocket;
}
//
// Remove the rest of the list
//
while ( NULL != pPort ) {
pNextPort = pPort->pLinkSocket;
EslSocketPortClose ( pPort );
if ( !EFI_ERROR ( Status )) {
DEBUG (( DEBUG_CONNECT,
"0x%08x: Port closed\r\n",
pPort ));
}
else {
DEBUG (( DEBUG_CONNECT,
"ERROR - Failed to close port 0x%08x, Status: %r\r\n",
pPort,
Status ));
}
pPort = pNextPort;
}
//
// Notify the poll routine
//
pSocket->bConnected = TRUE;
}
DBG_EXIT ( );
}
/**
Poll for completion of the connection attempt.
This routine polls the ESL_SOCKET::bConnected flag to determine
when the connection attempt is complete.
This routine is called from ::EslSocketConnect to determine when
the connection is complete. The ESL_SOCKET::bConnected flag is
set by ::EslTcp4ConnectComplete when the TCPv4 layer establishes
a connection or runs out of local network adapters. This routine
gets the connection status from ESL_SOCKET::ConnectStatus.
@param [in] pSocket Address of an ::ESL_SOCKET structure.
@retval EFI_SUCCESS The connection was successfully established.
@retval EFI_NOT_READY The connection is in progress, call this routine again.
@retval Others The connection attempt failed.
**/
EFI_STATUS
EslTcp4ConnectPoll (
IN ESL_SOCKET * pSocket
)
{
EFI_STATUS Status;
DBG_ENTER ( );
//
// Determine if the connection is complete
//
if ( !pSocket->bConnected ) {
//
// Not connected
//
pSocket->errno = EAGAIN;
Status = EFI_NOT_READY;
}
else {
//
// The connection processing is complete
//
pSocket->bConnected = FALSE;
//
// Translate the connection status
//
Status = pSocket->ConnectStatus;
switch ( Status ) {
default:
case EFI_DEVICE_ERROR:
pSocket->errno = EIO;
break;
case EFI_ABORTED:
pSocket->errno = ECONNABORTED;
break;
case EFI_ACCESS_DENIED:
pSocket->errno = EACCES;
break;
case EFI_CONNECTION_RESET:
pSocket->errno = ECONNRESET;
break;
case EFI_INVALID_PARAMETER:
pSocket->errno = EADDRNOTAVAIL;
break;
case EFI_HOST_UNREACHABLE:
case EFI_NO_RESPONSE:
pSocket->errno = EHOSTUNREACH;
break;
case EFI_NO_MAPPING:
pSocket->errno = EAFNOSUPPORT;
break;
case EFI_NO_MEDIA:
case EFI_NETWORK_UNREACHABLE:
pSocket->errno = ENETDOWN;
break;
case EFI_OUT_OF_RESOURCES:
pSocket->errno = ENOBUFS;
break;
case EFI_PORT_UNREACHABLE:
case EFI_PROTOCOL_UNREACHABLE:
case EFI_CONNECTION_REFUSED:
pSocket->errno = ECONNREFUSED;
break;
case EFI_SUCCESS:
pSocket->errno = 0;
break;
case EFI_TIMEOUT:
pSocket->errno = ETIMEDOUT;
break;
case EFI_UNSUPPORTED:
pSocket->errno = EOPNOTSUPP;
break;
}
//
// Display the translation
//
DEBUG (( DEBUG_CONNECT,
"ERROR - errno: %d, Status: %r\r\n",
pSocket->errno,
Status ));
}
//
// Return the initialization status
//
DBG_EXIT_STATUS ( Status );
return Status;
}
/**
Attempt to connect to a remote TCP port
This routine starts the connection processing for a SOCK_STREAM
or SOCK_SEQPAKCET socket using the TCPv4 network layer. It
configures the local TCPv4 connection point and then attempts to
connect to a remote system. Upon completion, the
::EslTcp4ConnectComplete routine gets called with the connection
status.
This routine is called by ::EslSocketConnect to initiate the TCPv4
network specific connect operations. The connection processing is
initiated by this routine and finished by ::EslTcp4ConnectComplete.
This pair of routines walks through the list of local TCPv4
connection points until a connection to the remote system is
made.
@param [in] pSocket Address of an ::ESL_SOCKET structure.
@retval EFI_SUCCESS The connection was successfully established.
@retval EFI_NOT_READY The connection is in progress, call this routine again.
@retval Others The connection attempt failed.
**/
EFI_STATUS
EslTcp4ConnectStart (
IN ESL_SOCKET * pSocket
)
{
ESL_PORT * pPort;
ESL_TCP4_CONTEXT * pTcp4;
EFI_TCP4_PROTOCOL * pTcp4Protocol;
EFI_SIMPLE_NETWORK_MODE SnpModeData;
EFI_STATUS Status;
DBG_ENTER ( );
//
// Determine if any more local adapters are available
//
pPort = pSocket->pPortList;
if ( NULL != pPort ) {
//
// Configure the port
//
pTcp4 = &pPort->Context.Tcp4;
pTcp4->ConfigData.AccessPoint.ActiveFlag = TRUE;
pTcp4->ConfigData.TimeToLive = 255;
pTcp4Protocol = pPort->pProtocol.TCPv4;
Status = pTcp4Protocol->Configure ( pTcp4Protocol,
&pTcp4->ConfigData );
if ( EFI_ERROR ( Status )) {
DEBUG (( DEBUG_CONNECT,
"ERROR - Failed to configure the Tcp4 port, Status: %r\r\n",
Status ));
}
else {
DEBUG (( DEBUG_CONNECT,
"0x%08x: Port configured\r\n",
pPort ));
pPort->bConfigured = TRUE;
//
// Verify the port connection
//
Status = pTcp4Protocol->GetModeData ( pTcp4Protocol,
NULL,
NULL,
NULL,
NULL,
&SnpModeData );
if ( !EFI_ERROR ( Status )) {
if ( SnpModeData.MediaPresentSupported
&& ( !SnpModeData.MediaPresent )) {
//
// Port is not connected to the network
//
Status = EFI_NO_MEDIA;
}
else {
//
// Attempt the connection to the remote system
//
Status = pTcp4Protocol->Connect ( pTcp4Protocol,
&pTcp4->ConnectToken );
}
}
if ( EFI_ERROR ( Status )) {
//
// Connection error
//
DEBUG (( DEBUG_CONNECT,
"ERROR - Port 0x%08x not connected, Status: %r\r\n",
pPort,
Status ));
}
}
if ( !EFI_ERROR ( Status )) {
//
// Connection in progress
//
pSocket->errno = EINPROGRESS;
DEBUG (( DEBUG_CONNECT,
"0x%08x: Port attempting connection to %d.%d.%d.%d:%d\r\n",
pPort,
pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[0],
pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[1],
pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[2],
pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[3],
pTcp4->ConfigData.AccessPoint.RemotePort ));
}
else {
//
// Error return path is through EslTcp4ConnectComplete to
// enable retry on other ports
//
// Status to errno translation gets done in EslTcp4ConnectPoll
//
pTcp4->ConnectToken.CompletionToken.Status = Status;
//
// Continue with the next port
//
gBS->CheckEvent ( pTcp4->ConnectToken.CompletionToken.Event );
gBS->SignalEvent ( pTcp4->ConnectToken.CompletionToken.Event );
}
Status = EFI_NOT_READY;
}
else {
//
// No more local adapters available
//
pSocket->errno = ENETUNREACH;
Status = EFI_NO_RESPONSE;
}
//
// Return the operation status
//
DBG_EXIT_STATUS ( Status );
return Status;
}
/**
Establish the known port to listen for network connections.
This routine places the port into a state that enables connection
attempts.
This routine is called by ::EslSocketListen to handle the network
specifics of the listen operation for SOCK_STREAM and SOCK_SEQPACKET
sockets. See the \ref ConnectionManagement section.
@param [in] pSocket Address of an ::ESL_SOCKET structure.
@retval EFI_SUCCESS - Socket successfully created
@retval Other - Failed to enable the socket for listen
**/
EFI_STATUS
EslTcp4Listen (
IN ESL_SOCKET * pSocket
)
{
ESL_PORT * pNextPort;
ESL_PORT * pPort;
ESL_TCP4_CONTEXT * pTcp4;
EFI_TCP4_PROTOCOL * pTcp4Protocol;
EFI_STATUS Status;
DBG_ENTER ( );
//
// Verify the socket layer synchronization
//
VERIFY_TPL ( TPL_SOCKETS );
//
// Use for/break instead of goto
//
for ( ; ; ) {
//
// Assume no ports are available
//
pSocket->errno = EOPNOTSUPP;
Status = EFI_NOT_READY;
//
// Walk the list of ports
//
pPort = pSocket->pPortList;
while ( NULL != pPort ) {
//
// Assume success
//
pSocket->errno = 0;
//
// Use for/break insteak of goto
//
for ( ; ; ) {
//
// Create the listen completion event
//
pTcp4 = &pPort->Context.Tcp4;
Status = gBS->CreateEvent ( EVT_NOTIFY_SIGNAL,
TPL_SOCKETS,
(EFI_EVENT_NOTIFY)EslTcp4ListenComplete,
pPort,
&pTcp4->ListenToken.CompletionToken.Event );
if ( EFI_ERROR ( Status )) {
DEBUG (( DEBUG_ERROR | DEBUG_LISTEN,
"ERROR - Failed to create the listen completion event, Status: %r\r\n",
Status ));
pSocket->errno = ENOMEM;
break;
}
DEBUG (( DEBUG_POOL,
"0x%08x: Created listen completion event\r\n",
pTcp4->ListenToken.CompletionToken.Event ));
//
// Configure the port
//
pTcp4Protocol = pPort->pProtocol.TCPv4;
Status = pTcp4Protocol->Configure ( pTcp4Protocol,
&pTcp4->ConfigData );
if ( EFI_ERROR ( Status )) {
DEBUG (( DEBUG_LISTEN,
"ERROR - Failed to configure the Tcp4 port, Status: %r\r\n",
Status ));
switch ( Status ) {
case EFI_ACCESS_DENIED:
pSocket->errno = EACCES;
break;
default:
case EFI_DEVICE_ERROR:
pSocket->errno = EIO;
break;
case EFI_INVALID_PARAMETER:
pSocket->errno = EADDRNOTAVAIL;
break;
case EFI_NO_MAPPING:
pSocket->errno = EAFNOSUPPORT;
break;
case EFI_OUT_OF_RESOURCES:
pSocket->errno = ENOBUFS;
break;
case EFI_UNSUPPORTED:
pSocket->errno = EOPNOTSUPP;
break;
}
break;
}
DEBUG (( DEBUG_LISTEN,
"0x%08x: Port configured\r\n",
pPort ));
pPort->bConfigured = TRUE;
//
// Start the listen operation on the port
//
Status = pTcp4Protocol->Accept ( pTcp4Protocol,
&pTcp4->ListenToken );
if ( EFI_ERROR ( Status )) {
DEBUG (( DEBUG_LISTEN,
"ERROR - Failed Tcp4 accept, Status: %r\r\n",
Status ));
switch ( Status ) {
case EFI_ACCESS_DENIED:
pSocket->errno = EACCES;
break;
default:
case EFI_DEVICE_ERROR:
pSocket->errno = EIO;
break;
case EFI_INVALID_PARAMETER:
pSocket->errno = EADDRNOTAVAIL;
break;
case EFI_NOT_STARTED:
pSocket->errno = ENETDOWN;
break;
case EFI_OUT_OF_RESOURCES:
pSocket->errno = ENOBUFS;
break;
}
break;
}
DEBUG (( DEBUG_LISTEN,
"0x%08x: Listen pending on Port\r\n",
pPort ));
//
// Listen is pending on this port
//
break;
}
//
// Get the next port
//
pNextPort = pPort->pLinkSocket;
//
// Close the port upon error
//
if ( EFI_ERROR ( Status )) {
EslSocketPortCloseStart ( pPort, TRUE, DEBUG_LISTEN );
}
//
// Set the next port
//
pPort = pNextPort;
}
//
// Determine if any ports are in the listen state
//
if ( NULL == pSocket->pPortList ) {
//
// No ports in the listen state
//
pSocket->MaxFifoDepth = 0;
//
// Return the last error detected
//
break;
}
//
// Mark the socket as configured
//
pSocket->bConfigured = TRUE;
Status = EFI_SUCCESS;
pSocket->errno = 0;
//
// All done
//
DEBUG (( DEBUG_LISTEN,
"0x%08x: pSocket - Listen pending on socket\r\n",
pSocket ));
break;
}
//
// Return the operation status
//
DBG_EXIT_STATUS ( Status );
return Status;
}
/**
Process the connection attempt
A system has initiated a connection attempt with a socket in the
listen state. Attempt to complete the connection.
The TCPv4 layer calls this routine when a connection is made to
the socket in the listen state. See the
\ref ConnectionManagement section.
@param [in] Event The listen completion event
@param [in] pPort Address of an ::ESL_PORT structure.
**/
VOID
EslTcp4ListenComplete (
IN EFI_EVENT Event,
IN ESL_PORT * pPort
)
{
EFI_HANDLE ChildHandle;
struct sockaddr_in LocalAddress;
EFI_TCP4_CONFIG_DATA * pConfigData;
ESL_PORT * pNewPort;
ESL_SOCKET * pNewSocket;
ESL_SOCKET * pSocket;
ESL_TCP4_CONTEXT * pTcp4;
EFI_TCP4_PROTOCOL * pTcp4Protocol;
EFI_STATUS Status;
EFI_HANDLE TcpPortHandle;
EFI_STATUS TempStatus;
DBG_ENTER ( );
VERIFY_AT_TPL ( TPL_SOCKETS );
//
// Assume success
//
Status = EFI_SUCCESS;
//
// Determine if this connection fits into the connection FIFO
//
pSocket = pPort->pSocket;
TcpPortHandle = pPort->Context.Tcp4.ListenToken.NewChildHandle;
if (( SOCKET_STATE_LISTENING == pSocket->State )
&& ( pSocket->MaxFifoDepth > pSocket->FifoDepth )) {
//
// Allocate a socket for this connection
//
ChildHandle = NULL;
Status = EslSocketAllocate ( &ChildHandle,
DEBUG_CONNECTION,
&pNewSocket );
if ( !EFI_ERROR ( Status )) {
//
// Clone the socket parameters
//
pNewSocket->pApi = pSocket->pApi;
pNewSocket->Domain = pSocket->Domain;
pNewSocket->Protocol = pSocket->Protocol;
pNewSocket->Type = pSocket->Type;
//
// Build the local address
//
pTcp4 = &pPort->Context.Tcp4;
LocalAddress.sin_len = (uint8_t)pNewSocket->pApi->MinimumAddressLength;
LocalAddress.sin_family = AF_INET;
LocalAddress.sin_port = 0;
LocalAddress.sin_addr.s_addr = *(UINT32 *)&pTcp4->ConfigData.AccessPoint.StationAddress.Addr[0];
//
// Allocate a port for this connection
// Note in this instance Configure may not be called with NULL!
//
Status = EslSocketPortAllocate ( pNewSocket,
pPort->pService,
TcpPortHandle,
(struct sockaddr *)&LocalAddress,
FALSE,
DEBUG_CONNECTION,
&pNewPort );
if ( !EFI_ERROR ( Status )) {
//
// Restart the listen operation on the port
//
pTcp4Protocol = pPort->pProtocol.TCPv4;
Status = pTcp4Protocol->Accept ( pTcp4Protocol,
&pTcp4->ListenToken );
//
// Close the TCP port using SocketClose
//
TcpPortHandle = NULL;
pTcp4 = &pNewPort->Context.Tcp4;
//
// Check for an accept call error
//
if ( !EFI_ERROR ( Status )) {
//
// Get the port configuration
//
pNewPort->bConfigured = TRUE;
pConfigData = &pTcp4->ConfigData;
pConfigData->ControlOption = &pTcp4->Option;
pTcp4Protocol = pNewPort->pProtocol.TCPv4;
Status = pTcp4Protocol->GetModeData ( pTcp4Protocol,
NULL,
pConfigData,
NULL,
NULL,
NULL );
if ( !EFI_ERROR ( Status )) {
//
// Add the new socket to the connection FIFO
//
if ( NULL == pSocket->pFifoTail ) {
//
// First connection
//
pSocket->pFifoHead = pNewSocket;
}
else {
//
// Add to end of list.
//
pSocket->pFifoTail->pNextConnection = pNewSocket;
}
pSocket->pFifoTail = pNewSocket;
pSocket->FifoDepth += 1;
//
// Update the socket state
//
pNewSocket->State = SOCKET_STATE_IN_FIFO;
//
// Log the connection
//
DEBUG (( DEBUG_CONNECTION | DEBUG_INFO,
"0x%08x: Socket on port %d.%d.%d.%d:%d connected to %d.%d.%d.%d:%d\r\n",
pNewSocket,
pConfigData->AccessPoint.StationAddress.Addr[0],
pConfigData->AccessPoint.StationAddress.Addr[1],
pConfigData->AccessPoint.StationAddress.Addr[2],
pConfigData->AccessPoint.StationAddress.Addr[3],
pConfigData->AccessPoint.StationPort,
pConfigData->AccessPoint.RemoteAddress.Addr[0],
pConfigData->AccessPoint.RemoteAddress.Addr[1],
pConfigData->AccessPoint.RemoteAddress.Addr[2],
pConfigData->AccessPoint.RemoteAddress.Addr[3],
pConfigData->AccessPoint.RemotePort ));
DEBUG (( DEBUG_CONNECTION | DEBUG_INFO,
"0x%08x: Listen socket adding socket 0x%08x to FIFO, depth: %d\r\n",
pSocket,
pNewSocket,
pSocket->FifoDepth ));
//
// Start the receive operation
//
EslSocketRxStart ( pNewPort );
}
else {
DEBUG (( DEBUG_ERROR | DEBUG_CONNECTION | DEBUG_INFO,
"ERROR - GetModeData failed on port 0x%08x, Status: %r\r\n",
pNewPort,
Status ));
}
}
else {
//
// The listen failed on this port
//
DEBUG (( DEBUG_LISTEN | DEBUG_INFO,
"ERROR - Listen failed on port 0x%08x, Status: %r\r\n",
pPort,
Status ));
//
// Close the listening port
//
EslSocketPortCloseStart ( pPort, TRUE, DEBUG_LISTEN );
}
}
//
// Done with the socket if necessary
//
if ( EFI_ERROR ( Status )) {
TempStatus = EslSocketCloseStart ( &pNewSocket->SocketProtocol,
TRUE,
&pSocket->errno );
ASSERT ( EFI_SUCCESS == TempStatus );
}
}
}
else {
DEBUG (( DEBUG_CONNECTION,
"0x%08x: Socket FIFO full, connection refused\r\n",
pSocket ));
//
// The FIFO is full or the socket is in the wrong state
//
Status = EFI_BUFFER_TOO_SMALL;
}
//
// Close the connection if necessary
//
if (( EFI_ERROR ( Status ))
&& ( NULL == TcpPortHandle )) {
//
// TODO: Finish this code path
// The new connection does not fit into the connection FIFO
//
// Process:
// Call close
// Release the resources
}
DBG_EXIT ( );
}
/**
Get the local socket address.
This routine returns the IPv4 address and TCP port number associated
with the local socket.
This routine is called by ::EslSocketGetLocalAddress to determine the
network address for the SOCK_STREAM or SOCK_SEQPACKET socket.
@param [in] pPort Address of an ::ESL_PORT structure.
@param [out] pSockAddr Network address to receive the local system address
**/
VOID
EslTcp4LocalAddressGet (
IN ESL_PORT * pPort,
OUT struct sockaddr * pSockAddr
)
{
struct sockaddr_in * pLocalAddress;
ESL_TCP4_CONTEXT * pTcp4;
DBG_ENTER ( );
//
// Return the local address
//
pTcp4 = &pPort->Context.Tcp4;
pLocalAddress = (struct sockaddr_in *)pSockAddr;
pLocalAddress->sin_family = AF_INET;
pLocalAddress->sin_port = SwapBytes16 ( pTcp4->ConfigData.AccessPoint.StationPort );
CopyMem ( &pLocalAddress->sin_addr,
&pTcp4->ConfigData.AccessPoint.StationAddress.Addr[0],
sizeof ( pLocalAddress->sin_addr ));
DBG_EXIT ( );
}
/**
Set the local port address.
This routine sets the local port address.
This support routine is called by ::EslSocketPortAllocate.
@param [in] pPort Address of an ESL_PORT structure
@param [in] pSockAddr Address of a sockaddr structure that contains the
connection point on the local machine. An IPv4 address
of INADDR_ANY specifies that the connection is made to
all of the network stacks on the platform. Specifying a
specific IPv4 address restricts the connection to the
network stack supporting that address. Specifying zero
for the port causes the network layer to assign a port
number from the dynamic range. Specifying a specific
port number causes the network layer to use that port.
@param [in] bBindTest TRUE = run bind testing
@retval EFI_SUCCESS The operation was successful
**/
EFI_STATUS
EslTcp4LocalAddressSet (
IN ESL_PORT * pPort,
IN CONST struct sockaddr * pSockAddr,
IN BOOLEAN bBindTest
)
{
EFI_TCP4_ACCESS_POINT * pAccessPoint;
CONST struct sockaddr_in * pIpAddress;
CONST UINT8 * pIpv4Address;
EFI_STATUS Status;
DBG_ENTER ( );
//
// Validate the address
//
pIpAddress = (struct sockaddr_in *)pSockAddr;
if ( INADDR_BROADCAST == pIpAddress->sin_addr.s_addr ) {
//
// The local address must not be the broadcast address
//
Status = EFI_INVALID_PARAMETER;
pPort->pSocket->errno = EADDRNOTAVAIL;
}
else {
//
// Set the local address
//
pIpv4Address = (UINT8 *)&pIpAddress->sin_addr.s_addr;
pAccessPoint = &pPort->Context.Tcp4.ConfigData.AccessPoint;
pAccessPoint->StationAddress.Addr[0] = pIpv4Address[0];
pAccessPoint->StationAddress.Addr[1] = pIpv4Address[1];
pAccessPoint->StationAddress.Addr[2] = pIpv4Address[2];
pAccessPoint->StationAddress.Addr[3] = pIpv4Address[3];
//
// Determine if the default address is used
//
pAccessPoint->UseDefaultAddress = (BOOLEAN)( 0 == pIpAddress->sin_addr.s_addr );
//
// Set the subnet mask
//
if ( pAccessPoint->UseDefaultAddress ) {
pAccessPoint->SubnetMask.Addr[0] = 0;
pAccessPoint->SubnetMask.Addr[1] = 0;
pAccessPoint->SubnetMask.Addr[2] = 0;
pAccessPoint->SubnetMask.Addr[3] = 0;
}
else {
pAccessPoint->SubnetMask.Addr[0] = 0xff;
pAccessPoint->SubnetMask.Addr[1] = ( 128 <= pAccessPoint->StationAddress.Addr[0]) ? 0xff : 0;
pAccessPoint->SubnetMask.Addr[2] = ( 192 <= pAccessPoint->StationAddress.Addr[0]) ? 0xff : 0;
pAccessPoint->SubnetMask.Addr[3] = ( 224 <= pAccessPoint->StationAddress.Addr[0]) ? 0xff : 0;
}
//
// Validate the IP address
//
pAccessPoint->StationPort = 0;
Status = bBindTest ? EslSocketBindTest ( pPort, EADDRNOTAVAIL )
: EFI_SUCCESS;
if ( !EFI_ERROR ( Status )) {
//
// Set the port number
//
pAccessPoint->StationPort = SwapBytes16 ( pIpAddress->sin_port );
pPort->pSocket->bAddressSet = TRUE;
//
// Display the local address
//
DEBUG (( DEBUG_BIND,
"0x%08x: Port, Local TCP4 Address: %d.%d.%d.%d:%d\r\n",
pPort,
pAccessPoint->StationAddress.Addr[0],
pAccessPoint->StationAddress.Addr[1],
pAccessPoint->StationAddress.Addr[2],
pAccessPoint->StationAddress.Addr[3],
pAccessPoint->StationPort ));
}
}
//
// Return the operation status
//
DBG_EXIT_STATUS ( Status );
return Status;
}
/**
Free a receive packet
This routine performs the network specific operations necessary
to free a receive packet.
This routine is called by ::EslSocketPortCloseTxDone to free a
receive packet.
@param [in] pPacket Address of an ::ESL_PACKET structure.
@param [in, out] pRxBytes Address of the count of RX bytes
**/
VOID
EslTcp4PacketFree (
IN ESL_PACKET * pPacket,
IN OUT size_t * pRxBytes
)
{
DBG_ENTER ( );
//
// Account for the receive bytes
//
*pRxBytes -= pPacket->Op.Tcp4Rx.RxData.DataLength;
DBG_EXIT ( );
}
/**
Initialize the network specific portions of an ::ESL_PORT structure.
This routine initializes the network specific portions of an
::ESL_PORT structure for use by the socket.
This support routine is called by ::EslSocketPortAllocate
to connect the socket with the underlying network adapter
running the TCPv4 protocol.
@param [in] pPort Address of an ESL_PORT structure
@param [in] DebugFlags Flags for debug messages
@retval EFI_SUCCESS - Socket successfully created
**/
EFI_STATUS
EslTcp4PortAllocate (
IN ESL_PORT * pPort,
IN UINTN DebugFlags
)
{
EFI_TCP4_ACCESS_POINT * pAccessPoint;
ESL_SOCKET * pSocket;
ESL_TCP4_CONTEXT * pTcp4;
EFI_STATUS Status;
DBG_ENTER ( );
//
// Use for/break instead of goto
for ( ; ; ) {
//
// Allocate the close event
//
pSocket = pPort->pSocket;
pTcp4 = &pPort->Context.Tcp4;
Status = gBS->CreateEvent ( EVT_NOTIFY_SIGNAL,
TPL_SOCKETS,
(EFI_EVENT_NOTIFY)EslSocketPortCloseComplete,
pPort,
&pTcp4->CloseToken.CompletionToken.Event);
if ( EFI_ERROR ( Status )) {
DEBUG (( DEBUG_ERROR | DebugFlags,
"ERROR - Failed to create the close event, Status: %r\r\n",
Status ));
pSocket->errno = ENOMEM;
break;
}
DEBUG (( DEBUG_CLOSE | DEBUG_POOL,
"0x%08x: Created close event\r\n",
pTcp4->CloseToken.CompletionToken.Event ));
//
// Allocate the connection event
//
Status = gBS->CreateEvent ( EVT_NOTIFY_SIGNAL,
TPL_SOCKETS,
(EFI_EVENT_NOTIFY)EslTcp4ConnectComplete,
pPort,
&pTcp4->ConnectToken.CompletionToken.Event);
if ( EFI_ERROR ( Status )) {
DEBUG (( DEBUG_ERROR | DebugFlags,
"ERROR - Failed to create the connect event, Status: %r\r\n",
Status ));
pSocket->errno = ENOMEM;
break;
}
DEBUG (( DEBUG_CLOSE | DEBUG_POOL,
"0x%08x: Created connect event\r\n",
pTcp4->ConnectToken.CompletionToken.Event ));
//
// Initialize the port
//
pSocket->TxPacketOffset = OFFSET_OF ( ESL_PACKET, Op.Tcp4Tx.TxData );
pSocket->TxTokenEventOffset = OFFSET_OF ( ESL_IO_MGMT, Token.Tcp4Tx.CompletionToken.Event );
pSocket->TxTokenOffset = OFFSET_OF ( EFI_TCP4_IO_TOKEN, Packet.TxData );
//
// Save the cancel, receive and transmit addresses
// pPort->pfnRxCancel = NULL; since the UEFI implementation returns EFI_UNSUPPORTED
//
pPort->pfnConfigure = (PFN_NET_CONFIGURE)pPort->pProtocol.TCPv4->Configure;
pPort->pfnRxPoll = (PFN_NET_POLL)pPort->pProtocol.TCPv4->Poll;
pPort->pfnRxStart = (PFN_NET_IO_START)pPort->pProtocol.TCPv4->Receive;
pPort->pfnTxStart = (PFN_NET_IO_START)pPort->pProtocol.TCPv4->Transmit;
//
// Set the configuration flags
//
pAccessPoint = &pPort->Context.Tcp4.ConfigData.AccessPoint;
pAccessPoint->ActiveFlag = FALSE;
pTcp4->ConfigData.TimeToLive = 255;
break;
}
//
// Return the operation status
//
DBG_EXIT_STATUS ( Status );
return Status;
}
/**
Close a TCP4 port.
This routine releases the network specific resources allocated by
::EslTcp4PortAllocate.
This routine is called by ::EslSocketPortClose.
See the \ref PortCloseStateMachine section.
@param [in] pPort Address of an ::ESL_PORT structure.
@retval EFI_SUCCESS The port is closed
@retval other Port close error
**/
EFI_STATUS
EslTcp4PortClose (
IN ESL_PORT * pPort
)
{
UINTN DebugFlags;
ESL_TCP4_CONTEXT * pTcp4;
EFI_STATUS Status;
DBG_ENTER ( );
//
// Locate the port in the socket list
//
Status = EFI_SUCCESS;
DebugFlags = pPort->DebugFlags;
pTcp4 = &pPort->Context.Tcp4;
//
// Done with the connect event
//
if ( NULL != pTcp4->ConnectToken.CompletionToken.Event ) {
Status = gBS->CloseEvent ( pTcp4->ConnectToken.CompletionToken.Event );
if ( !EFI_ERROR ( Status )) {
DEBUG (( DebugFlags | DEBUG_POOL,
"0x%08x: Closed connect event\r\n",
pTcp4->ConnectToken.CompletionToken.Event ));
}
else {
DEBUG (( DEBUG_ERROR | DebugFlags,
"ERROR - Failed to close the connect event, Status: %r\r\n",
Status ));
ASSERT ( EFI_SUCCESS == Status );
}
}
//
// Done with the close event
//
if ( NULL != pTcp4->CloseToken.CompletionToken.Event ) {
Status = gBS->CloseEvent ( pTcp4->CloseToken.CompletionToken.Event );
if ( !EFI_ERROR ( Status )) {
DEBUG (( DebugFlags | DEBUG_POOL,
"0x%08x: Closed close event\r\n",
pTcp4->CloseToken.CompletionToken.Event ));
}
else {
DEBUG (( DEBUG_ERROR | DebugFlags,
"ERROR - Failed to close the close event, Status: %r\r\n",
Status ));
ASSERT ( EFI_SUCCESS == Status );
}
}
//
// Done with the listen completion event
//
if ( NULL != pTcp4->ListenToken.CompletionToken.Event ) {
Status = gBS->CloseEvent ( pTcp4->ListenToken.CompletionToken.Event );
if ( !EFI_ERROR ( Status )) {
DEBUG (( DebugFlags | DEBUG_POOL,
"0x%08x: Closed listen completion event\r\n",
pTcp4->ListenToken.CompletionToken.Event ));
}
else {
DEBUG (( DEBUG_ERROR | DebugFlags,
"ERROR - Failed to close the listen completion event, Status: %r\r\n",
Status ));
ASSERT ( EFI_SUCCESS == Status );
}
}
//
// Return the operation status
//
DBG_EXIT_STATUS ( Status );
return Status;
}
/**
Perform the network specific close operation on the port.
This routine performs a cancel operations on the TCPv4 port to
shutdown the receive operations on the port.
This routine is called by the ::EslSocketPortCloseTxDone
routine after the port completes all of the transmission.
@param [in] pPort Address of an ::ESL_PORT structure.
@retval EFI_SUCCESS The port is closed, not normally returned
@retval EFI_NOT_READY The port is still closing
@retval EFI_ALREADY_STARTED Error, the port is in the wrong state,
most likely the routine was called already.
**/
EFI_STATUS
EslTcp4PortCloseOp (
IN ESL_PORT * pPort
)
{
ESL_TCP4_CONTEXT * pTcp4;
EFI_TCP4_PROTOCOL * pTcp4Protocol;
EFI_STATUS Status;
DBG_ENTER ( );
//
// Close the configured port
//
Status = EFI_SUCCESS;
pTcp4 = &pPort->Context.Tcp4;
pTcp4Protocol = pPort->pProtocol.TCPv4;
pTcp4->CloseToken.AbortOnClose = pPort->bCloseNow;
Status = pTcp4Protocol->Close ( pTcp4Protocol,
&pTcp4->CloseToken );
if ( !EFI_ERROR ( Status )) {
DEBUG (( pPort->DebugFlags | DEBUG_CLOSE | DEBUG_INFO,
"0x%08x: Port close started\r\n",
pPort ));
}
else {
DEBUG (( DEBUG_ERROR | pPort->DebugFlags | DEBUG_CLOSE | DEBUG_INFO,
"ERROR - Close failed on port 0x%08x, Status: %r\r\n",
pPort,
Status ));
}
//
// Return the operation status
//
DBG_EXIT_STATUS ( Status );
return Status;
}
/**
Receive data from a network connection.
This routine attempts to return buffered data to the caller. The
data is removed from the urgent queue if the message flag MSG_OOB
is specified, otherwise data is removed from the normal queue.
See the \ref ReceiveEngine section.
This routine is called by ::EslSocketReceive to handle the network
specific receive operation to support SOCK_STREAM and SOCK_SEQPACKET
sockets.
@param [in] pPort Address of an ::ESL_PORT structure.
@param [in] pPacket Address of an ::ESL_PACKET structure.
@param [in] pbConsumePacket Address of a BOOLEAN indicating if the packet is to be consumed
@param [in] BufferLength Length of the the buffer
@param [in] pBuffer Address of a buffer to receive the data.
@param [in] pDataLength Number of received data bytes in the buffer.
@param [out] pAddress Network address to receive the remote system address
@param [out] pSkipBytes Address to receive the number of bytes skipped
@return Returns the address of the next free byte in the buffer.
**/
UINT8 *
EslTcp4Receive (
IN ESL_PORT * pPort,
IN ESL_PACKET * pPacket,
IN BOOLEAN * pbConsumePacket,
IN size_t BufferLength,
IN UINT8 * pBuffer,
OUT size_t * pDataLength,
OUT struct sockaddr * pAddress,
OUT size_t * pSkipBytes
)
{
size_t DataLength;
struct sockaddr_in * pRemoteAddress;
ESL_TCP4_CONTEXT * pTcp4;
DBG_ENTER ( );
//
// Return the remote system address if requested
//
if ( NULL != pAddress ) {
//
// Build the remote address
//
pTcp4 = &pPort->Context.Tcp4;
DEBUG (( DEBUG_RX,
"Getting packet remote address: %d.%d.%d.%d:%d\r\n",
pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[0],
pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[1],
pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[2],
pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[3],
pTcp4->ConfigData.AccessPoint.RemotePort ));
pRemoteAddress = (struct sockaddr_in *)pAddress;
CopyMem ( &pRemoteAddress->sin_addr,
&pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[0],
sizeof ( pRemoteAddress->sin_addr ));
pRemoteAddress->sin_port = SwapBytes16 ( pTcp4->ConfigData.AccessPoint.RemotePort );
}
//
// Determine the amount of received data
//
DataLength = pPacket->ValidBytes;
if ( BufferLength < DataLength ) {
DataLength = BufferLength;
}
//
// Move the data into the buffer
//
DEBUG (( DEBUG_RX,
"0x%08x: Port copy packet 0x%08x data into 0x%08x, 0x%08x bytes\r\n",
pPort,
pPacket,
pBuffer,
DataLength ));
CopyMem ( pBuffer, pPacket->pBuffer, DataLength );
//
// Set the next buffer address
//
pBuffer += DataLength;
//
// Determine if the data is being read
//
if ( *pbConsumePacket ) {
//
// Account for the bytes consumed
//
pPacket->pBuffer += DataLength;
pPacket->ValidBytes -= DataLength;
DEBUG (( DEBUG_RX,
"0x%08x: Port account for 0x%08x bytes\r\n",
pPort,
DataLength ));
//
// Determine if the entire packet was consumed
//
if (( 0 == pPacket->ValidBytes )
|| ( SOCK_STREAM != pPort->pSocket->Type )) {
//
// All done with this packet
// Account for any discarded data
//
*pSkipBytes = pPacket->ValidBytes;
}
else
{
//
// More data to consume later
//
*pbConsumePacket = FALSE;
}
}
//
// Return the data length and the buffer address
//
*pDataLength = DataLength;
DBG_EXIT_HEX ( pBuffer );
return pBuffer;
}
/**
Get the remote socket address.
This routine returns the address of the remote connection point
associated with the SOCK_STREAM or SOCK_SEQPACKET socket.
This routine is called by ::EslSocketGetPeerAddress to detemine
the TCPv4 address and por number associated with the network adapter.
@param [in] pPort Address of an ::ESL_PORT structure.
@param [out] pAddress Network address to receive the remote system address
**/
VOID
EslTcp4RemoteAddressGet (
IN ESL_PORT * pPort,
OUT struct sockaddr * pAddress
)
{
struct sockaddr_in * pRemoteAddress;
ESL_TCP4_CONTEXT * pTcp4;
DBG_ENTER ( );
//
// Return the remote address
//
pTcp4 = &pPort->Context.Tcp4;
pRemoteAddress = (struct sockaddr_in *)pAddress;
pRemoteAddress->sin_family = AF_INET;
pRemoteAddress->sin_port = SwapBytes16 ( pTcp4->ConfigData.AccessPoint.RemotePort );
CopyMem ( &pRemoteAddress->sin_addr,
&pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[0],
sizeof ( pRemoteAddress->sin_addr ));
DBG_EXIT ( );
}
/**
Set the remote address
This routine sets the remote address in the port.
This routine is called by ::EslSocketConnect to specify the
remote network address.
@param [in] pPort Address of an ::ESL_PORT structure.
@param [in] pSockAddr Network address of the remote system.
@param [in] SockAddrLength Length in bytes of the network address.
@retval EFI_SUCCESS The operation was successful
**/
EFI_STATUS
EslTcp4RemoteAddressSet (
IN ESL_PORT * pPort,
IN CONST struct sockaddr * pSockAddr,
IN socklen_t SockAddrLength
)
{
CONST struct sockaddr_in * pRemoteAddress;
ESL_TCP4_CONTEXT * pTcp4;
EFI_STATUS Status;
DBG_ENTER ( );
//
// Set the remote address
//
pTcp4 = &pPort->Context.Tcp4;
pRemoteAddress = (struct sockaddr_in *)pSockAddr;
pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[0] = (UINT8)( pRemoteAddress->sin_addr.s_addr );
pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[1] = (UINT8)( pRemoteAddress->sin_addr.s_addr >> 8 );
pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[2] = (UINT8)( pRemoteAddress->sin_addr.s_addr >> 16 );
pTcp4->ConfigData.AccessPoint.RemoteAddress.Addr[3] = (UINT8)( pRemoteAddress->sin_addr.s_addr >> 24 );
pTcp4->ConfigData.AccessPoint.RemotePort = SwapBytes16 ( pRemoteAddress->sin_port );
Status = EFI_SUCCESS;
if ( INADDR_BROADCAST == pRemoteAddress->sin_addr.s_addr ) {
DEBUG (( DEBUG_CONNECT,
"ERROR - Invalid remote address\r\n" ));
Status = EFI_INVALID_PARAMETER;
pPort->pSocket->errno = EAFNOSUPPORT;
}
//
// Return the operation status
//
DBG_EXIT_STATUS ( Status );
return Status;
}
/**
Process the receive completion
This routine queues the data in FIFO order in either the urgent
or normal data queues depending upon the type of data received.
See the \ref ReceiveEngine section.
This routine is called by the TCPv4 driver when some data is
received.
Buffer the data that was just received.
@param [in] Event The receive completion event
@param [in] pIo Address of an ::ESL_IO_MGMT structure
**/
VOID
EslTcp4RxComplete (
IN EFI_EVENT Event,
IN ESL_IO_MGMT * pIo
)
{
BOOLEAN bUrgent;
size_t LengthInBytes;
ESL_PACKET * pPacket;
EFI_STATUS Status;
DBG_ENTER ( );
//
// Get the operation status.
//
Status = pIo->Token.Tcp4Rx.CompletionToken.Status;
//
// +--------------------+ +---------------------------+
// | ESL_IO_MGMT | | ESL_PACKET |
// | | | |
// | +---------------+ +-----------------------+ |
// | | Token | | EFI_TCP4_RECEIVE_DATA | |
// | | RxData --> | | |
// | | | +-----------------------+---+
// | | Event | | Data Buffer |
// +----+---------------+ | |
// | |
// +---------------------------+
//
//
// Duplicate the buffer address and length for use by the
// buffer handling code in EslTcp4Receive. These fields are
// used when a partial read is done of the data from the
// packet.
//
pPacket = pIo->pPacket;
pPacket->pBuffer = pPacket->Op.Tcp4Rx.RxData.FragmentTable[0].FragmentBuffer;
LengthInBytes = pPacket->Op.Tcp4Rx.RxData.DataLength;
pPacket->ValidBytes = LengthInBytes;
//
// Get the data type so that it may be linked to the
// correct receive buffer list on the ESL_SOCKET structure
//
bUrgent = pPacket->Op.Tcp4Rx.RxData.UrgentFlag;
//
// Complete this request
//
EslSocketRxComplete ( pIo, Status, LengthInBytes, bUrgent );
DBG_EXIT ( );
}
/**
Start a receive operation
This routine posts a receive buffer to the TCPv4 driver.
See the \ref ReceiveEngine section.
This support routine is called by EslSocketRxStart.
@param [in] pPort Address of an ::ESL_PORT structure.
@param [in] pIo Address of an ::ESL_IO_MGMT structure.
**/
VOID
EslTcp4RxStart (
IN ESL_PORT * pPort,
IN ESL_IO_MGMT * pIo
)
{
ESL_PACKET * pPacket;
DBG_ENTER ( );
//
// Initialize the buffer for receive
//
pPacket = pIo->pPacket;
pIo->Token.Tcp4Rx.Packet.RxData = &pPacket->Op.Tcp4Rx.RxData;
pPacket->Op.Tcp4Rx.RxData.DataLength = sizeof ( pPacket->Op.Tcp4Rx.Buffer );
pPacket->Op.Tcp4Rx.RxData.FragmentCount = 1;
pPacket->Op.Tcp4Rx.RxData.FragmentTable[0].FragmentLength = pPacket->Op.Tcp4Rx.RxData.DataLength;
pPacket->Op.Tcp4Rx.RxData.FragmentTable[0].FragmentBuffer = &pPacket->Op.Tcp4Rx.Buffer[0];
DBG_EXIT ( );
}
/**
Determine if the socket is configured.
This routine uses the flag ESL_SOCKET::bConfigured to determine
if the network layer's configuration routine has been called.
This routine is called by EslSocketIsConfigured to verify
that the socket has been configured.
@param [in] pSocket Address of an ::ESL_SOCKET structure.
@retval EFI_SUCCESS - The port is connected
@retval EFI_NOT_STARTED - The port is not connected
**/
EFI_STATUS
EslTcp4SocketIsConfigured (
IN ESL_SOCKET * pSocket
)
{
EFI_STATUS Status;
DBG_ENTER ( );
//
// Determine the socket configuration status
//
Status = pSocket->bConfigured ? EFI_SUCCESS : EFI_NOT_STARTED;
//
// Return the port connected state.
//
DBG_EXIT_STATUS ( Status );
return Status;
}
/**
Buffer data for transmission over a network connection.
This routine buffers data for the transmit engine in one of two
queues, one for urgent (out-of-band) data and the other for normal
data. The urgent data is provided to TCP as soon as it is available,
allowing the TCP layer to schedule transmission of the urgent data
between packets of normal data.
This routine is called by ::EslSocketTransmit to buffer
data for transmission. When the \ref TransmitEngine has resources,
this routine will start the transmission of the next buffer on
the network connection.
Transmission errors are returned during the next transmission or
during the close operation. Only buffering errors are returned
during the current transmission attempt.
@param [in] pSocket Address of an ::ESL_SOCKET structure
@param [in] Flags Message control flags
@param [in] BufferLength Length of the the buffer
@param [in] pBuffer Address of a buffer to receive the data.
@param [in] pDataLength Number of received data bytes in the buffer.
@param [in] pAddress Network address of the remote system address
@param [in] AddressLength Length of the remote network address structure
@retval EFI_SUCCESS - Socket data successfully buffered
**/
EFI_STATUS
EslTcp4TxBuffer (
IN ESL_SOCKET * pSocket,
IN int Flags,
IN size_t BufferLength,
IN CONST UINT8 * pBuffer,
OUT size_t * pDataLength,
IN const struct sockaddr * pAddress,
IN socklen_t AddressLength
)
{
BOOLEAN bUrgent;
BOOLEAN bUrgentQueue;
ESL_PACKET * pPacket;
ESL_IO_MGMT ** ppActive;
ESL_IO_MGMT ** ppFree;
ESL_PORT * pPort;
ESL_PACKET ** ppQueueHead;
ESL_PACKET ** ppQueueTail;
ESL_PACKET * pPreviousPacket;
size_t * pTxBytes;
EFI_TCP4_TRANSMIT_DATA * pTxData;
EFI_STATUS Status;
EFI_TPL TplPrevious;
DBG_ENTER ( );
//
// Assume failure
//
Status = EFI_UNSUPPORTED;
pSocket->errno = ENOTCONN;
*pDataLength = 0;
//
// Verify that the socket is connected
//
if ( SOCKET_STATE_CONNECTED == pSocket->State ) {
//
// Locate the port
//
pPort = pSocket->pPortList;
if ( NULL != pPort ) {
//
// Determine the queue head
//
bUrgent = (BOOLEAN)( 0 != ( Flags & MSG_OOB ));
bUrgentQueue = bUrgent
&& ( !pSocket->bOobInLine )
&& pSocket->pApi->bOobSupported;
if ( bUrgentQueue ) {
ppQueueHead = &pSocket->pTxOobPacketListHead;
ppQueueTail = &pSocket->pTxOobPacketListTail;
ppActive = &pPort->pTxOobActive;
ppFree = &pPort->pTxOobFree;
pTxBytes = &pSocket->TxOobBytes;
}
else {
ppQueueHead = &pSocket->pTxPacketListHead;
ppQueueTail = &pSocket->pTxPacketListTail;
ppActive = &pPort->pTxActive;
ppFree = &pPort->pTxFree;
pTxBytes = &pSocket->TxBytes;
}
//
// Verify that there is enough room to buffer another
// transmit operation
//
if ( pSocket->MaxTxBuf > *pTxBytes ) {
if ( pPort->bTxFlowControl ) {
DEBUG (( DEBUG_TX,
"TTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTT\r\n0x%08x: pPort, TX flow control released, Max bytes: %d > %d bufferred bytes\r\n",
pPort,
pSocket->MaxTxBuf,
*pTxBytes ));
pPort->bTxFlowControl = FALSE;
}
//
// Attempt to allocate the packet
//
Status = EslSocketPacketAllocate ( &pPacket,
sizeof ( pPacket->Op.Tcp4Tx )
- sizeof ( pPacket->Op.Tcp4Tx.Buffer )
+ BufferLength,
0,
DEBUG_TX );
if ( !EFI_ERROR ( Status )) {
//
// Initialize the transmit operation
//
pTxData = &pPacket->Op.Tcp4Tx.TxData;
pTxData->Push = TRUE || bUrgent;
pTxData->Urgent = bUrgent;
pTxData->DataLength = (UINT32) BufferLength;
pTxData->FragmentCount = 1;
pTxData->FragmentTable[0].FragmentLength = (UINT32) BufferLength;
pTxData->FragmentTable[0].FragmentBuffer = &pPacket->Op.Tcp4Tx.Buffer[0];
//
// Copy the data into the buffer
//
CopyMem ( &pPacket->Op.Tcp4Tx.Buffer[0],
pBuffer,
BufferLength );
//
// Synchronize with the socket layer
//
RAISE_TPL ( TplPrevious, TPL_SOCKETS );
//
// Stop transmission after an error
//
if ( !EFI_ERROR ( pSocket->TxError )) {
//
// Display the request
//
DEBUG (( DEBUG_TX,
"Send %d %s bytes from 0x%08x\r\n",
BufferLength,
bUrgent ? L"urgent" : L"normal",
pBuffer ));
//
// Queue the data for transmission
//
pPacket->pNext = NULL;
pPreviousPacket = *ppQueueTail;
if ( NULL == pPreviousPacket ) {
*ppQueueHead = pPacket;
}
else {
pPreviousPacket->pNext = pPacket;
}
*ppQueueTail = pPacket;
DEBUG (( DEBUG_TX,
"0x%08x: Packet on %s transmit list\r\n",
pPacket,
bUrgentQueue ? L"urgent" : L"normal" ));
//
// Account for the buffered data
//
*pTxBytes += BufferLength;
*pDataLength = BufferLength;
//
// Start the transmit engine if it is idle
//
if ( NULL != *ppFree ) {
EslSocketTxStart ( pPort,
ppQueueHead,
ppQueueTail,
ppActive,
ppFree );
}
}
else {
//
// Previous transmit error
// Stop transmission
//
Status = pSocket->TxError;
pSocket->errno = EIO;
//
// Free the packet
//
EslSocketPacketFree ( pPacket, DEBUG_TX );
}
//
// Release the socket layer synchronization
//
RESTORE_TPL ( TplPrevious );
}
else {
//
// Packet allocation failed
//
pSocket->errno = ENOMEM;
}
}
else {
if ( !pPort->bTxFlowControl ) {
DEBUG (( DEBUG_TX,
"0x%08x: pPort, TX flow control applied, Max bytes %d <= %d bufferred bytes\r\nTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTT\r\n",
pPort,
pSocket->MaxTxBuf,
*pTxBytes ));
pPort->bTxFlowControl = TRUE;
}
//
// Not enough buffer space available
//
pSocket->errno = EAGAIN;
Status = EFI_NOT_READY;
}
}
}
//
// Return the operation status
//
DBG_EXIT_STATUS ( Status );
return Status;
}
/**
Process the normal data transmit completion
This routine use ::EslSocketTxComplete to perform the transmit
completion processing for normal data.
This routine is called by the TCPv4 network layer when a
normal data transmit request completes.
@param [in] Event The normal transmit completion event
@param [in] pIo The ESL_IO_MGMT structure address
**/
VOID
EslTcp4TxComplete (
IN EFI_EVENT Event,
IN ESL_IO_MGMT * pIo
)
{
UINT32 LengthInBytes;
ESL_PACKET * pPacket;
ESL_PORT * pPort;
ESL_SOCKET * pSocket;
EFI_STATUS Status;
DBG_ENTER ( );
//
// Locate the active transmit packet
//
pPacket = pIo->pPacket;
pPort = pIo->pPort;
pSocket = pPort->pSocket;
//
// Get the transmit length and status
//
LengthInBytes = pPacket->Op.Tcp4Tx.TxData.DataLength;
pSocket->TxBytes -= LengthInBytes;
Status = pIo->Token.Tcp4Tx.CompletionToken.Status;
//
// Complete the transmit operation
//
EslSocketTxComplete ( pIo,
LengthInBytes,
Status,
"Normal ",
&pSocket->pTxPacketListHead,
&pSocket->pTxPacketListTail,
&pPort->pTxActive,
&pPort->pTxFree );
DBG_EXIT ( );
}
/**
Process the urgent data transmit completion
This routine use ::EslSocketTxComplete to perform the transmit
completion processing for urgent data.
This routine is called by the TCPv4 network layer when a
urgent data transmit request completes.
@param [in] Event The urgent transmit completion event
@param [in] pIo The ESL_IO_MGMT structure address
**/
VOID
EslTcp4TxOobComplete (
IN EFI_EVENT Event,
IN ESL_IO_MGMT * pIo
)
{
UINT32 LengthInBytes;
ESL_PACKET * pPacket;
ESL_PORT * pPort;
ESL_SOCKET * pSocket;
EFI_STATUS Status;
DBG_ENTER ( );
//
// Locate the active transmit packet
//
pPacket = pIo->pPacket;
pPort = pIo->pPort;
pSocket = pPort->pSocket;
//
// Get the transmit length and status
//
LengthInBytes = pPacket->Op.Tcp4Tx.TxData.DataLength;
pSocket->TxOobBytes -= LengthInBytes;
Status = pIo->Token.Tcp4Tx.CompletionToken.Status;
//
// Complete the transmit operation
//
EslSocketTxComplete ( pIo,
LengthInBytes,
Status,
"Urgent ",
&pSocket->pTxOobPacketListHead,
&pSocket->pTxOobPacketListTail,
&pPort->pTxOobActive,
&pPort->pTxOobFree );
DBG_EXIT ( );
}
/**
Verify the adapter's IP address
This support routine is called by EslSocketBindTest.
@param [in] pPort Address of an ::ESL_PORT structure.
@param [in] pConfigData Address of the configuration data
@retval EFI_SUCCESS - The IP address is valid
@retval EFI_NOT_STARTED - The IP address is invalid
**/
EFI_STATUS
EslTcp4VerifyLocalIpAddress (
IN ESL_PORT * pPort,
IN EFI_TCP4_CONFIG_DATA * pConfigData
)
{
UINTN DataSize;
EFI_TCP4_ACCESS_POINT * pAccess;
EFI_IP4_CONFIG2_INTERFACE_INFO * pIfInfo;
EFI_IP4_CONFIG2_PROTOCOL * pIpConfig2Protocol;
ESL_SERVICE * pService;
EFI_STATUS Status;
DBG_ENTER ( );
//
// Use break instead of goto
//
pIfInfo = NULL;
for ( ; ; ) {
//
// Determine if the IP address is specified
//
pAccess = &pConfigData->AccessPoint;
DEBUG (( DEBUG_BIND,
"UseDefaultAddress: %s\r\n",
pAccess->UseDefaultAddress ? L"TRUE" : L"FALSE" ));
DEBUG (( DEBUG_BIND,
"Requested IP address: %d.%d.%d.%d\r\n",
pAccess->StationAddress.Addr [ 0 ],
pAccess->StationAddress.Addr [ 1 ],
pAccess->StationAddress.Addr [ 2 ],
pAccess->StationAddress.Addr [ 3 ]));
if ( pAccess->UseDefaultAddress
|| (( 0 == pAccess->StationAddress.Addr [ 0 ])
&& ( 0 == pAccess->StationAddress.Addr [ 1 ])
&& ( 0 == pAccess->StationAddress.Addr [ 2 ])
&& ( 0 == pAccess->StationAddress.Addr [ 3 ])))
{
Status = EFI_SUCCESS;
break;
}
//
// Open the configuration protocol
//
pService = pPort->pService;
Status = gBS->OpenProtocol (
pService->Controller,
&gEfiIp4Config2ProtocolGuid,
(VOID **)&pIpConfig2Protocol,
NULL,
NULL,
EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
if ( EFI_ERROR ( Status )) {
DEBUG (( DEBUG_ERROR,
"ERROR - IP Configuration Protocol not available, Status: %r\r\n",
Status ));
break;
}
//
// Get the interface information size.
//
DataSize = 0;
Status = pIpConfig2Protocol->GetData (
pIpConfig2Protocol,
Ip4Config2DataTypeInterfaceInfo,
&DataSize,
NULL
);
if ( EFI_BUFFER_TOO_SMALL != Status ) {
DEBUG (( DEBUG_ERROR,
"ERROR - Failed to get the interface information size, Status: %r\r\n",
Status ));
break;
}
//
// Allocate the interface information buffer
//
pIfInfo = AllocatePool ( DataSize );
if ( NULL == pIfInfo ) {
DEBUG (( DEBUG_ERROR,
"ERROR - Not enough memory to allocate the interface information buffer!\r\n" ));
Status = EFI_OUT_OF_RESOURCES;
break;
}
//
// Get the interface info.
//
Status = pIpConfig2Protocol->GetData (
pIpConfig2Protocol,
Ip4Config2DataTypeInterfaceInfo,
&DataSize,
pIfInfo
);
if ( EFI_ERROR ( Status )) {
DEBUG (( DEBUG_ERROR,
"ERROR - Failed to return the interface info, Status: %r\r\n",
Status ));
break;
}
//
// Display the current configuration
//
DEBUG (( DEBUG_BIND,
"Actual adapter IP address: %d.%d.%d.%d\r\n",
pIfInfo->StationAddress.Addr [ 0 ],
pIfInfo->StationAddress.Addr [ 1 ],
pIfInfo->StationAddress.Addr [ 2 ],
pIfInfo->StationAddress.Addr [ 3 ]));
//
// Assume the port is not configured
//
Status = EFI_SUCCESS;
if (( pAccess->StationAddress.Addr [ 0 ] == pIfInfo->StationAddress.Addr [ 0 ])
&& ( pAccess->StationAddress.Addr [ 1 ] == pIfInfo->StationAddress.Addr [ 1 ])
&& ( pAccess->StationAddress.Addr [ 2 ] == pIfInfo->StationAddress.Addr [ 2 ])
&& ( pAccess->StationAddress.Addr [ 3 ] == pIfInfo->StationAddress.Addr [ 3 ])) {
break;
}
//
// The IP address did not match
//
Status = EFI_NOT_STARTED;
break;
}
//
// Free the buffer if necessary
//
if ( NULL != pIfInfo ) {
FreePool ( pIfInfo );
}
//
// Return the IP address status
//
DBG_EXIT_STATUS ( Status );
return Status;
}
/**
Interface between the socket layer and the network specific
code that supports SOCK_STREAM and SOCK_SEQPACKET sockets
over TCPv4.
**/
CONST ESL_PROTOCOL_API cEslTcp4Api = {
"TCPv4",
IPPROTO_TCP,
OFFSET_OF ( ESL_PORT, Context.Tcp4.ConfigData ),
OFFSET_OF ( ESL_LAYER, pTcp4List ),
OFFSET_OF ( struct sockaddr_in, sin_zero ),
sizeof ( struct sockaddr_in ),
AF_INET,
sizeof (((ESL_PACKET *)0 )->Op.Tcp4Rx ),
OFFSET_OF ( ESL_PACKET, Op.Tcp4Rx.Buffer ) - OFFSET_OF ( ESL_PACKET, Op ),
OFFSET_OF ( ESL_IO_MGMT, Token.Tcp4Rx.Packet.RxData ),
TRUE,
EADDRINUSE,
EslTcp4Accept,
EslTcp4ConnectPoll,
EslTcp4ConnectStart,
EslTcp4SocketIsConfigured,
EslTcp4LocalAddressGet,
EslTcp4LocalAddressSet,
EslTcp4Listen,
NULL, // OptionGet
NULL, // OptionSet
EslTcp4PacketFree,
EslTcp4PortAllocate,
EslTcp4PortClose,
EslTcp4PortCloseOp,
FALSE,
EslTcp4Receive,
EslTcp4RemoteAddressGet,
EslTcp4RemoteAddressSet,
EslTcp4RxComplete,
EslTcp4RxStart,
EslTcp4TxBuffer,
EslTcp4TxComplete,
EslTcp4TxOobComplete,
(PFN_API_VERIFY_LOCAL_IP_ADDRESS)EslTcp4VerifyLocalIpAddress
};
|