summaryrefslogtreecommitdiff
path: root/UnixPkg/UnixSnpDxe/UnixSnp.c
blob: b91004191182d060d8697d647c6bd1966aaadc9c (plain)
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
/** @file

 Copyright (c) 2010, Apple, Inc. 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.

Module Name:

  UnixSnp.c

Abstract:

-**/

#include <Library/PrintLib.h>

#include "UnixSnp.h"

EFI_DRIVER_BINDING_PROTOCOL gUnixSnpDriverBinding =
{
  UnixSnpDriverBindingSupported,
  UnixSnpDriverBindingStart,
  UnixSnpDriverBindingStop,
  0xA,
  NULL,
  NULL
};

/**
  Changes the state of a network interface from "stopped" to "started".

  @param  This Protocol instance pointer.

  @retval EFI_SUCCESS           Always succeeds.

**/
EFI_STATUS
EFIAPI
UnixSnpStart(
  IN EFI_SIMPLE_NETWORK_PROTOCOL*    This
  );
  
/**
  Changes the state of a network interface from "started" to "stopped".

  @param  This Protocol instance pointer.

  @retval EFI_SUCCESS           Always succeeds.

**/
EFI_STATUS
EFIAPI
UnixSnpStop(
  IN EFI_SIMPLE_NETWORK_PROTOCOL*    This
  );
  
/**
  Resets a network adapter and allocates the transmit and receive buffers 
  required by the network interface; optionally, also requests allocation 
  of additional transmit and receive buffers.

  @param  This              Protocol instance pointer.
  @param  ExtraRxBufferSize The size, in bytes, of the extra receive buffer space
                            that the driver should allocate for the network interface.
                            Some network interfaces will not be able to use the extra
                            buffer, and the caller will not know if it is actually
                            being used.
  @param  ExtraTxBufferSize The size, in bytes, of the extra transmit buffer space
                            that the driver should allocate for the network interface.
                            Some network interfaces will not be able to use the extra
                            buffer, and the caller will not know if it is actually
                            being used.

  @retval EFI_SUCCESS           Always succeeds.

**/
EFI_STATUS
EFIAPI
UnixSnpInitialize(
  IN EFI_SIMPLE_NETWORK_PROTOCOL*    This,
  IN UINTN              ExtraRxBufferSize OPTIONAL,
  IN UINTN              ExtraTxBufferSize OPTIONAL
  );
  
/**
  Resets a network adapter and re-initializes it with the parameters that were 
  provided in the previous call to Initialize().  

  @param  This                 Protocol instance pointer.
  @param  ExtendedVerification Indicates that the driver may perform a more
                               exhaustive verification operation of the device
                               during reset.

  @retval EFI_SUCCESS           Always succeeds.

**/
EFI_STATUS
EFIAPI
UnixSnpReset(
  IN EFI_SIMPLE_NETWORK_PROTOCOL*    This,
  IN BOOLEAN              ExtendedVerification
  );

/**
  Resets a network adapter and leaves it in a state that is safe for 
  another driver to initialize.

  @param  This Protocol instance pointer.

  @retval EFI_SUCCESS           Always succeeds.

**/
EFI_STATUS
EFIAPI
UnixSnpShutdown(
  IN EFI_SIMPLE_NETWORK_PROTOCOL*    This
  );

/**
  Manages the multicast receive filters of a network interface.

  @param  This               Protocol instance pointer.
  @param  EnableBits         A bit mask of receive filters to enable on the network interface.
  @param  DisableBits        A bit mask of receive filters to disable on the network interface.
  @param  ResetMcastFilter   Set to TRUE to reset the contents of the multicast receive
                             filters on the network interface to their default values.
  @param  McastFilterCount   Number of multicast HW MAC addresses in the new
                             MCastFilter list. This value must be less than or equal to
                             the MCastFilterCnt field of EFI_SIMPLE_NETWORK_MODE. This
                             field is optional if ResetMCastFilter is TRUE.
  @param  McastFilter        A pointer to a list of new multicast receive filter HW MAC
                             addresses. This list will replace any existing multicast
                             HW MAC address list. This field is optional if
                             ResetMCastFilter is TRUE.

  @retval EFI_SUCCESS           The multicast receive filter list was updated.
  @retval EFI_DEVICE_ERROR      The command could not be sent to the network interface.

**/
EFI_STATUS
EFIAPI
UnixSnpReceiveFilters(
  IN EFI_SIMPLE_NETWORK_PROTOCOL*    This,
  IN UINT32              EnableBits,
  IN UINT32              DisableBits,
  IN BOOLEAN              ResetMcastFilter,
  IN UINTN              McastFilterCount OPTIONAL,
  IN EFI_MAC_ADDRESS*          McastFilter OPTIONAL
  );

/**
  Modifies or resets the current station address, if supported.

  @param  This         Protocol instance pointer.
  @param  Reset        Flag used to reset the station address to the network interfaces
                       permanent address.
  @param  NewMacAddr   New station address to be used for the network interface.

  @retval EFI_UNSUPPORTED       Not supported yet.

**/
EFI_STATUS
EFIAPI
UnixSnpStationAddress(
  IN EFI_SIMPLE_NETWORK_PROTOCOL*    This,
  IN BOOLEAN              Reset,
  IN EFI_MAC_ADDRESS*          NewMacAddr OPTIONAL
  );

/**
  Resets or collects the statistics on a network interface.

  @param  This            Protocol instance pointer.
  @param  Reset           Set to TRUE to reset the statistics for the network interface.
  @param  StatisticsSize  On input the size, in bytes, of StatisticsTable. On
                          output the size, in bytes, of the resulting table of
                          statistics.
  @param  StatisticsTable A pointer to the EFI_NETWORK_STATISTICS structure that
                          contains the statistics.

  @retval EFI_SUCCESS           The statistics were collected from the network interface.
  @retval EFI_NOT_STARTED       The network interface has not been started.
  @retval EFI_BUFFER_TOO_SMALL  The Statistics buffer was too small. The current buffer
                                size needed to hold the statistics is returned in
                                StatisticsSize.
  @retval EFI_UNSUPPORTED       Not supported yet.

**/
EFI_STATUS
EFIAPI
UnixSnpStatistics(
  IN EFI_SIMPLE_NETWORK_PROTOCOL*    This,
  IN BOOLEAN              Reset,
  IN OUT UINTN*            StatisticsSize OPTIONAL,
  OUT EFI_NETWORK_STATISTICS*      StatisticsTable OPTIONAL
  );
  
/**
  Converts a multicast IP address to a multicast HW MAC address.
  
  @param  This  Protocol instance pointer.
  @param  Ipv6  Set to TRUE if the multicast IP address is IPv6 [RFC 2460]. Set
                to FALSE if the multicast IP address is IPv4 [RFC 791].
  @param  Ip    The multicast IP address that is to be converted to a multicast
                HW MAC address.
  @param  Mac   The multicast HW MAC address that is to be generated from IP.

  @retval EFI_SUCCESS           The multicast IP address was mapped to the multicast
                                HW MAC address.
  @retval EFI_NOT_STARTED       The network interface has not been started.
  @retval EFI_BUFFER_TOO_SMALL  The Statistics buffer was too small. The current buffer
                                size needed to hold the statistics is returned in
                                StatisticsSize.
  @retval EFI_UNSUPPORTED       Not supported yet.

**/
EFI_STATUS
EFIAPI
UnixSnpMcastIptoMac(
  IN EFI_SIMPLE_NETWORK_PROTOCOL*    This,
  IN BOOLEAN              Ipv6,
  IN EFI_IP_ADDRESS*          Ip,
  OUT EFI_MAC_ADDRESS*        Mac
  );

/**
  Performs read and write operations on the NVRAM device attached to a 
  network interface.

  @param  This         Protocol instance pointer.
  @param  ReadOrWrite  TRUE for read operations, FALSE for write operations.
  @param  Offset       Byte offset in the NVRAM device at which to start the read or
                       write operation. This must be a multiple of NvRamAccessSize and
                       less than NvRamSize.
  @param  BufferSize   The number of bytes to read or write from the NVRAM device.
                       This must also be a multiple of NvramAccessSize.
  @param  Buffer       A pointer to the data buffer.

  @retval EFI_UNSUPPORTED       Not supported yet.

**/
EFI_STATUS
EFIAPI
UnixSnpNvdata(
  IN EFI_SIMPLE_NETWORK_PROTOCOL*    This,
  IN BOOLEAN              ReadOrWrite,
  IN UINTN              Offset,
  IN UINTN              BufferSize,
  IN OUT VOID*            Buffer
  );

/**
  Reads the current interrupt status and recycled transmit buffer status from 
  a network interface.

  @param  This            Protocol instance pointer.
  @param  InterruptStatus A pointer to the bit mask of the currently active interrupts
                          If this is NULL, the interrupt status will not be read from
                          the device. If this is not NULL, the interrupt status will
                          be read from the device. When the  interrupt status is read,
                          it will also be cleared. Clearing the transmit  interrupt
                          does not empty the recycled transmit buffer array.
  @param  TxBuffer        Recycled transmit buffer address. The network interface will
                          not transmit if its internal recycled transmit buffer array
                          is full. Reading the transmit buffer does not clear the
                          transmit interrupt. If this is NULL, then the transmit buffer
                          status will not be read. If there are no transmit buffers to
                          recycle and TxBuf is not NULL, * TxBuf will be set to NULL.

  @retval EFI_SUCCESS           Always succeeds.

**/
EFI_STATUS
EFIAPI
UnixSnpGetStatus(
  IN EFI_SIMPLE_NETWORK_PROTOCOL*    This,
  OUT UINT32*              InterruptStatus,
  OUT VOID**              TxBuffer
  );

/**
  Places a packet in the transmit queue of a network interface.

  @param  This       Protocol instance pointer.
  @param  HeaderSize The size, in bytes, of the media header to be filled in by
                     the Transmit() function. If HeaderSize is non-zero, then it
                     must be equal to This->Mode->MediaHeaderSize and the DestAddr
                     and Protocol parameters must not be NULL.
  @param  BufferSize The size, in bytes, of the entire packet (media header and
                     data) to be transmitted through the network interface.
  @param  Buffer     A pointer to the packet (media header followed by data) to be
                     transmitted. This parameter cannot be NULL. If HeaderSize is zero,
                     then the media header in Buffer must already be filled in by the
                     caller. If HeaderSize is non-zero, then the media header will be
                     filled in by the Transmit() function.
  @param  SrcAddr    The source HW MAC address. If HeaderSize is zero, then this parameter
                     is ignored. If HeaderSize is non-zero and SrcAddr is NULL, then
                     This->Mode->CurrentAddress is used for the source HW MAC address.
  @param  DestAddr   The destination HW MAC address. If HeaderSize is zero, then this
                     parameter is ignored.
  @param  Protocol   The type of header to build. If HeaderSize is zero, then this
                     parameter is ignored. See RFC 1700, section "Ether Types", for
                     examples.

  @retval EFI_SUCCESS           The packet was placed on the transmit queue.
  @retval EFI_DEVICE_ERROR      The command could not be sent to the network interface.
  @retval EFI_ACCESS_DENIED     Error acquire global lock for operation.

**/
EFI_STATUS
EFIAPI
UnixSnpTransmit(
  IN EFI_SIMPLE_NETWORK_PROTOCOL*    This,
  IN UINTN              HeaderSize,
  IN UINTN              BufferSize,
  IN VOID*              Buffer,
  IN EFI_MAC_ADDRESS*          SrcAddr OPTIONAL,
  IN EFI_MAC_ADDRESS*          DestAddr OPTIONAL,
  IN UINT16*              Protocol OPTIONAL
  );

/**
  Receives a packet from a network interface.

  @param  This             Protocol instance pointer.
  @param  HeaderSize       The size, in bytes, of the media header received on the network
                           interface. If this parameter is NULL, then the media header size
                           will not be returned.
  @param  BuffSize         On entry, the size, in bytes, of Buffer. On exit, the size, in
                           bytes, of the packet that was received on the network interface.
  @param  Buffer           A pointer to the data buffer to receive both the media header and
                           the data.
  @param  SourceAddr       The source HW MAC address. If this parameter is NULL, the
                           HW MAC source address will not be extracted from the media
                           header.
  @param  DestinationAddr  The destination HW MAC address. If this parameter is NULL,
                           the HW MAC destination address will not be extracted from the
                           media header.
  @param  Protocol         The media header type. If this parameter is NULL, then the
                           protocol will not be extracted from the media header. See
                           RFC 1700 section "Ether Types" for examples.

  @retval  EFI_SUCCESS           The received data was stored in Buffer, and BufferSize has
                                 been updated to the number of bytes received.
  @retval  EFI_NOT_READY         The network interface is too busy to accept this transmit
                                 request.
  @retval  EFI_BUFFER_TOO_SMALL  The BufferSize parameter is too small.
  @retval  EFI_DEVICE_ERROR      The command could not be sent to the network interface.
  @retval  EFI_ACCESS_DENIED     Error acquire global lock for operation.

**/
EFI_STATUS
EFIAPI
UnixSnpReceive(
  IN EFI_SIMPLE_NETWORK_PROTOCOL*    This,
  OUT UINTN*              HeaderSize OPTIONAL,
  IN OUT UINTN*            BuffSize,
  OUT VOID*              Buffer,
  OUT EFI_MAC_ADDRESS*        SourceAddr OPTIONAL,
  OUT EFI_MAC_ADDRESS*        DestinationAddr OPTIONAL,
  OUT UINT16*              Protocol OPTIONAL
  );

VOID
EFIAPI
UnixSnpWaitForPacketNotify(
  IN EFI_EVENT            Event,
  IN VOID*              Private
  );

//
// Strange, but there doesn't appear to be any structure for the Ethernet header in edk2...
//

typedef struct
{
  UINT8                DstAddr[ NET_ETHER_ADDR_LEN ];
  UINT8                SrcAddr[ NET_ETHER_ADDR_LEN ];
  UINT16                Type;
} EthernetHeader;

UNIX_SNP_PRIVATE_DATA gUnixSnpPrivateTemplate =
{
  UNIX_SNP_PRIVATE_DATA_SIGNATURE,      // Signature
  NULL,                    // UnixThunk
  NULL,                    // DeviceHandle
  NULL,                    // DevicePath
  { 0 },                    // MacAddress
  NULL,                    // InterfaceName
  0,                      // ReadBufferSize
  NULL,                    // ReadBuffer
  NULL,                    // CurrentReadPointer
  NULL,                    // EndReadPointer
  0,                      // BpfFd
  {                    // Snp
    EFI_SIMPLE_NETWORK_PROTOCOL_REVISION,  // Revision
    UnixSnpStart,              // Start
    UnixSnpStop,              // Stop
    UnixSnpInitialize,            // Initialize
    UnixSnpReset,              // Reset
    UnixSnpShutdown,            // Shutdown
    UnixSnpReceiveFilters,          // ReceiveFilters
    UnixSnpStationAddress,          // StationAddress
    UnixSnpStatistics,            // Statistics
    UnixSnpMcastIptoMac,          // MCastIpToMac
    UnixSnpNvdata,              // NvData
    UnixSnpGetStatus,            // GetStatus
    UnixSnpTransmit,            // Transmit
    UnixSnpReceive,              // Receive
    NULL,                  // WaitForPacket
    NULL                  // Mode
  },
  {                    // Mode
    EfiSimpleNetworkStopped,        //  State
    NET_ETHER_ADDR_LEN,            //  HwAddressSize
    NET_ETHER_HEADER_SIZE,          //  MediaHeaderSize
    1500,                  //  MaxPacketSize
    0,                    //  NvRamSize
    0,                    //  NvRamAccessSize
    0,                    //  ReceiveFilterMask
    0,                    //  ReceiveFilterSetting
    MAX_MCAST_FILTER_CNT,          //  MaxMCastFilterCount
    0,                    //  MCastFilterCount
    {
      0
    },                    //  MCastFilter
    {
      0
    },                    //  CurrentAddress
    {
      0
    },                    //  BroadcastAddress
    {
      0
    },                    //  PermanentAddress
    NET_IFTYPE_ETHERNET,          //  IfType
    FALSE,                  //  MacAddressChangeable
    FALSE,                  //  MultipleTxSupported
    FALSE,                  //  MediaPresentSupported
    TRUE                  //  MediaPresent
  }
};

STATIC EFI_STATUS
GetInterfaceMacAddr(
  IN UNIX_SNP_PRIVATE_DATA*      Private,
  IN EFI_UNIX_IO_PROTOCOL*      UnixIo
  )
{
  struct ifaddrs*            IfAddrs;
  struct ifaddrs*            If;
  struct sockaddr_dl*          IfSdl;
  EFI_STATUS              Status;
  INTN                Result;

  Result = UnixIo->UnixThunk->GetIfAddrs( &IfAddrs );
  if ( Result != 0 )
  {
    return( EFI_UNSUPPORTED );
  }

  //
  // Convert the interface name to ASCII so we can find it.
  //
  Private->InterfaceName = AllocateZeroPool( StrLen( UnixIo->EnvString ) );

  if ( !Private->InterfaceName )
  {
    Status = EFI_OUT_OF_RESOURCES;
    goto Exit;
  }

  UnicodeStrToAsciiStr( UnixIo->EnvString, Private->InterfaceName );

  If = IfAddrs;

  while ( If != NULL )
  {
    IfSdl = ( struct sockaddr_dl * ) If->ifa_addr;

    if ( IfSdl->sdl_family == AF_LINK )
    {
      if ( !AsciiStrCmp( Private->InterfaceName, If->ifa_name ) )
      {
        CopyMem( &Private->MacAddress, LLADDR( IfSdl ), NET_ETHER_ADDR_LEN );

        Status = EFI_SUCCESS;
        break;
      }
    }

    If = If->ifa_next;
  }

Exit:
  ( VOID ) UnixIo->UnixThunk->FreeIfAddrs( IfAddrs );

  return( Status );
}


STATIC EFI_STATUS
OpenBpfFileDescriptor(
  IN UNIX_SNP_PRIVATE_DATA*    Private,
  OUT INTN*            Fd
  )
{
  CHAR8              BfpDeviceName[ 256 ];
  INTN              Index;
  EFI_STATUS            Status = EFI_OUT_OF_RESOURCES;
  INTN              Result;

  //
  // Open a Berkeley Packet Filter device.  This must be done as root, so this is probably
  // the place which is most likely to fail...
  //
  for ( Index = 0; TRUE; Index++ )
  {
    AsciiSPrint( BfpDeviceName, sizeof( BfpDeviceName ), "/dev/bpf%d", Index );

    *Fd = Private->UnixThunk->Open( BfpDeviceName, O_RDWR, 0 );

    if ( *Fd >= 0 )
    {
      Status = EFI_SUCCESS;
      break;
    }

    Result = Private->UnixThunk->GetErrno();
    if ( Result == EACCES )
    {
      DEBUG( ( EFI_D_ERROR, "Permissions on '%a' are incorrect.  Fix with 'sudo chmod 666 %a'.\n",
          BfpDeviceName, BfpDeviceName ) );
    }
    if ( Result != EBUSY )
    {
      break;
    }
  }

  return( Status );
}


/**
  Test to see if this driver supports ControllerHandle. This service
  is called by the EFI boot service ConnectController(). In
  order to make drivers as small as possible, there are a few calling
  restrictions for this service. ConnectController() must
  follow these calling restrictions. If any other agent wishes to call
  Supported() it must also follow these calling restrictions.

  @param  This                Protocol instance pointer.
  @param  ControllerHandle    Handle of device to test
  @param  RemainingDevicePath Optional parameter use to pick a specific child
                              device to start.

  @retval EFI_SUCCESS         This driver supports this device
  @retval EFI_UNSUPPORTED     This driver does not support this device

**/
EFI_STATUS
EFIAPI
UnixSnpDriverBindingSupported(
  IN EFI_DRIVER_BINDING_PROTOCOL*    This,
  IN EFI_HANDLE            ControllerHandle,
  IN EFI_DEVICE_PATH_PROTOCOL*    RemainingDevicePath OPTIONAL
  )
{
  EFI_STATUS              Status;
  EFI_UNIX_IO_PROTOCOL*        UnixIo;

  //
  // Open the I/O abstraction needed to perform the supported test.
  //
  Status = gBS->OpenProtocol(
          ControllerHandle,
          &gEfiUnixIoProtocolGuid,
          ( VOID ** ) &UnixIo,
          This->DriverBindingHandle,
          ControllerHandle,
          EFI_OPEN_PROTOCOL_BY_DRIVER
          );

  if ( EFI_ERROR( Status ) )
  {
    return( Status );
  }

  //
  // Validate GUID
  //
  Status = EFI_UNSUPPORTED;
  if ( CompareGuid( UnixIo->TypeGuid, &gEfiUnixNetworkGuid ) )
  {
    Status = EFI_SUCCESS;
  }

  //
  // Close the I/O abstraction used to perform the supported test.
  //
  gBS->CloseProtocol(
          ControllerHandle,
          &gEfiUnixIoProtocolGuid,
          This->DriverBindingHandle,
          ControllerHandle
          );

  return( Status );
}


/**
  Start this driver on ControllerHandle. This service is called by the
  EFI boot service ConnectController(). In order to make
  drivers as small as possible, there are a few calling restrictions for
  this service. ConnectController() must follow these
  calling restrictions. If any other agent wishes to call Start() it
  must also follow these calling restrictions.

  @param  This                 Protocol instance pointer.
  @param  ControllerHandle     Handle of device to bind driver to
  @param  RemainingDevicePath  Optional parameter use to pick a specific child
                               device to start.

  @retval EFI_SUCCESS          Always succeeds.

**/
EFI_STATUS
EFIAPI
UnixSnpDriverBindingStart(
  IN EFI_DRIVER_BINDING_PROTOCOL*    This,
  IN EFI_HANDLE            ControllerHandle,
  IN EFI_DEVICE_PATH_PROTOCOL*    RemainingDevicePath OPTIONAL
  )
{
  MAC_ADDR_DEVICE_PATH      Node;
  EFI_DEVICE_PATH_PROTOCOL*    ParentDevicePath = NULL;
  EFI_UNIX_IO_PROTOCOL*      UnixIo;
  UNIX_SNP_PRIVATE_DATA*      Private = NULL;
  EFI_STATUS            Status;
  BOOLEAN              CreateDevice;

  //
  // Grab the protocols we need.
  //
  Status = gBS->OpenProtocol(
          ControllerHandle,
          &gEfiDevicePathProtocolGuid,
          ( VOID ** ) &ParentDevicePath,
          This->DriverBindingHandle,
          ControllerHandle,
          EFI_OPEN_PROTOCOL_BY_DRIVER
          );
  if ( EFI_ERROR( Status ) )
  {
    goto ErrorExit;
  }

  //
  // Open the I/O abstraction needed to perform the supported test.
  //
  Status = gBS->OpenProtocol(
          ControllerHandle,
          &gEfiUnixIoProtocolGuid,
          ( VOID ** ) &UnixIo,
          This->DriverBindingHandle,
          ControllerHandle,
          EFI_OPEN_PROTOCOL_BY_DRIVER
          );
  if ( EFI_ERROR( Status ) )
  {
    goto ErrorExit;
  }

  //
  // Validate GUID
  //
  if ( !CompareGuid( UnixIo->TypeGuid, &gEfiUnixNetworkGuid ) )
  {
    Status = EFI_UNSUPPORTED;
    goto ErrorExit;
  }

  CreateDevice = TRUE;
  if ( ( RemainingDevicePath != NULL ) && IsDevicePathEnd( RemainingDevicePath ) )
  {
    CreateDevice = FALSE;
  }

  if ( CreateDevice )
  {
    //
    //  Allocate the private data.
    //
    Private = AllocateCopyPool( sizeof( UNIX_SNP_PRIVATE_DATA ), &gUnixSnpPrivateTemplate );
    if ( Private == NULL )
    {
      Status = EFI_OUT_OF_RESOURCES;
      goto ErrorExit;
    }

    Status = GetInterfaceMacAddr( Private, UnixIo );
    if ( EFI_ERROR( Status ) )
    {
      goto ErrorExit;
    }

    Private->UnixThunk = UnixIo->UnixThunk;

    Private->Snp.Mode = &Private->Mode;

    //
    // Set the broadcast address.
    //
    SetMem( &Private->Mode.BroadcastAddress, sizeof( EFI_MAC_ADDRESS ), 0xFF );

    CopyMem( &Private->Mode.CurrentAddress, &Private->MacAddress, sizeof( EFI_MAC_ADDRESS ) );
    CopyMem( &Private->Mode.PermanentAddress, &Private->MacAddress, sizeof( EFI_MAC_ADDRESS ) );

    //
    // Since the fake SNP is based on a real NIC, to avoid conflict with the host NIC
    // network stack, we use a different MAC address.
    // So just change the last byte of the MAC address for the real NIC.
    //
    Private->Mode.CurrentAddress.Addr[ NET_ETHER_ADDR_LEN - 1 ]++;

    //
    // Build the device path by appending the MAC node to the ParentDevicePath
    // from the UnixIo handle.
    //
    ZeroMem( &Node, sizeof( MAC_ADDR_DEVICE_PATH ) );

    Node.Header.Type  = MESSAGING_DEVICE_PATH;
    Node.Header.SubType  = MSG_MAC_ADDR_DP;
    Node.IfType      = Private->Mode.IfType;

    SetDevicePathNodeLength( ( EFI_DEVICE_PATH_PROTOCOL * ) &Node, sizeof( MAC_ADDR_DEVICE_PATH ) );

    CopyMem( &Node.MacAddress, &Private->Mode.CurrentAddress, sizeof( EFI_MAC_ADDRESS ) );

    //
    // Build the device path by appending the MAC node to the ParentDevicePath from the UnixIo handle.
    //
    Private->DevicePath = AppendDevicePathNode( ParentDevicePath, ( EFI_DEVICE_PATH_PROTOCOL * ) &Node );
    if ( Private->DevicePath == NULL )
    {
      Status = EFI_OUT_OF_RESOURCES;
      goto ErrorExit;
    }

    Status = gBS->InstallMultipleProtocolInterfaces(
            &Private->DeviceHandle,
            &gEfiSimpleNetworkProtocolGuid,
            &Private->Snp,
            &gEfiDevicePathProtocolGuid,
            Private->DevicePath,
            NULL
            );
    if ( EFI_ERROR( Status ) )
    {
      goto ErrorExit;
    }

    Status = gBS->OpenProtocol(
            ControllerHandle,
            &gEfiUnixIoProtocolGuid,
            ( VOID ** ) &UnixIo,
            This->DriverBindingHandle,
            Private->DeviceHandle,
            EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
            );
    if ( EFI_ERROR( Status ) )
    {
      goto ErrorExit;
    }
  }
  return( Status );

ErrorExit:
  if ( Private->InterfaceName != NULL )
  {
    FreePool( Private->InterfaceName );
    Private->InterfaceName = NULL;
  }
  if ( Private != NULL )
  {
    FreePool( Private );
  }
  if ( ParentDevicePath != NULL )
  {
    gBS->CloseProtocol(
          ControllerHandle,
          &gEfiDevicePathProtocolGuid,
          This->DriverBindingHandle,
          ControllerHandle
          );
  }

  return( Status );
}

/**
  Stop this driver on ControllerHandle. This service is called by the
  EFI boot service DisconnectController(). In order to
  make drivers as small as possible, there are a few calling
  restrictions for this service. DisconnectController()
  must follow these calling restrictions. If any other agent wishes
  to call Stop() it must also follow these calling restrictions.
  
  @param  This              Protocol instance pointer.
  @param  ControllerHandle  Handle of device to stop driver on
  @param  NumberOfChildren  Number of Handles in ChildHandleBuffer. If number of
                            children is zero stop the entire bus driver.
  @param  ChildHandleBuffer List of Child Handles to Stop.

  @retval EFI_SUCCESS       Always succeeds.

**/
EFI_STATUS
EFIAPI
UnixSnpDriverBindingStop(
  IN EFI_DRIVER_BINDING_PROTOCOL*    This,
  IN EFI_HANDLE            ControllerHandle,
  IN UINTN              NumberOfChildren,
  IN EFI_HANDLE*            ChildHandleBuffer
  )
{
  UNIX_SNP_PRIVATE_DATA*        Private = NULL;
  EFI_SIMPLE_NETWORK_PROTOCOL*    Snp;
  EFI_STATUS              Status;

  //
  // Get our context back.
  //
  Status = gBS->OpenProtocol(
        ControllerHandle,
        &gEfiSimpleNetworkProtocolGuid,
        ( VOID ** ) &Snp,
        This->DriverBindingHandle,
        ControllerHandle,
        EFI_OPEN_PROTOCOL_GET_PROTOCOL
        );
  if ( EFI_ERROR( Status ) )
  {
    return( EFI_UNSUPPORTED );
  }

  Private = UNIX_SNP_PRIVATE_DATA_FROM_SNP_THIS( Snp );

  Status = gBS->CloseProtocol(
        ControllerHandle,
        &gEfiUnixIoProtocolGuid,
        This->DriverBindingHandle,
        Private->DeviceHandle
        );

  Status = gBS->UninstallMultipleProtocolInterfaces(
        Private->DeviceHandle,
        &gEfiSimpleNetworkProtocolGuid,
        &Private->Snp,
        &gEfiDevicePathProtocolGuid,
        Private->DevicePath,
        NULL
        );

  FreePool( Private->InterfaceName );
  FreePool( Private->DevicePath );
  FreePool( Private );

  return( EFI_SUCCESS );
}


/**
  Changes the state of a network interface from "stopped" to "started".

  @param  This Protocol instance pointer.

  @retval EFI_SUCCESS           Always succeeds.

**/
EFI_STATUS
EFIAPI
UnixSnpStart(
  IN EFI_SIMPLE_NETWORK_PROTOCOL*    This
  )
{
  STATIC struct bpf_insn        FilterInstructionTemplate[] =
  {
    // Load 4 bytes from the destination MAC address.
    BPF_STMT( BPF_LD + BPF_W + BPF_ABS, OFFSET_OF( EthernetHeader, DstAddr[ 0 ] ) ),

    // Compare to first 4 bytes of fake MAC address.
    BPF_JUMP( BPF_JMP + BPF_JEQ + BPF_K, 0x12345678, 0, 3 ),

    // Load remaining 2 bytes from the destination MAC address.
    BPF_STMT( BPF_LD + BPF_H + BPF_ABS, OFFSET_OF( EthernetHeader, DstAddr[ 4 ] ) ),

    // Compare to remaining 2 bytes of fake MAC address.
    BPF_JUMP( BPF_JMP + BPF_JEQ + BPF_K, 0x9ABC, 5, 0 ),

    // Load 4 bytes from the destination MAC address.
    BPF_STMT( BPF_LD + BPF_W + BPF_ABS, OFFSET_OF( EthernetHeader, DstAddr[ 0 ] ) ),

    // Compare to first 4 bytes of broadcast MAC address.
    BPF_JUMP( BPF_JMP + BPF_JEQ + BPF_K, 0xFFFFFFFF, 0, 2 ),

    // Load remaining 2 bytes from the destination MAC address.
    BPF_STMT( BPF_LD + BPF_H + BPF_ABS, OFFSET_OF( EthernetHeader, DstAddr[ 4 ] ) ),

    // Compare to remaining 2 bytes of broadcast MAC address.
    BPF_JUMP( BPF_JMP + BPF_JEQ + BPF_K, 0xFFFF, 1, 0 ),

    // Reject packet.
    BPF_STMT( BPF_RET + BPF_K, 0 ),

    // Receive entire packet.
    BPF_STMT( BPF_RET + BPF_K, -1 )
  };
  struct ifreq            BoundIf;
  struct bpf_program          BpfProgram;
  struct bpf_insn*          FilterProgram;
  UNIX_SNP_PRIVATE_DATA*        Private;
  EFI_STATUS              Status;
  UINT32                Temp32;
  INTN                Fd;
  INTN                Result;
  INTN                Value;
  UINT16                Temp16;

  Private = UNIX_SNP_PRIVATE_DATA_FROM_SNP_THIS( This );

  switch ( Private->Snp.Mode->State )
  {
    case EfiSimpleNetworkStopped:
      break;

    case EfiSimpleNetworkStarted:
    case EfiSimpleNetworkInitialized:
      return( EFI_ALREADY_STARTED );
      break;

    default:
      return( EFI_DEVICE_ERROR );
      break;
  }

  if ( Private->BpfFd == 0 )
  {
    Status = OpenBpfFileDescriptor( Private, &Fd );

    if ( EFI_ERROR( Status ) )
    {
      goto ErrorExit;
    }

    Private->BpfFd = Fd;

    //
    // Associate our interface with this BPF file descriptor.
    //
    AsciiStrCpy( BoundIf.ifr_name, Private->InterfaceName );
    Result = Private->UnixThunk->IoCtl( Private->BpfFd, BIOCSETIF, &BoundIf );

    if ( Result < 0 )
    {
      goto DeviceErrorExit;
    }

    //
    // Enable immediate mode and find out the buffer size.
    //
    Value = 1;
    Result = Private->UnixThunk->IoCtl( Private->BpfFd, BIOCIMMEDIATE, &Value );

    if ( Result < 0 )
    {
      goto DeviceErrorExit;
    }

    //
    // Enable non-blocking I/O.
    //

    Value = Private->UnixThunk->Fcntl( Private->BpfFd, F_GETFL, 0 );

    if ( Value == -1 )
    {
      goto DeviceErrorExit;
    }

    Value |= O_NONBLOCK;

    Result = Private->UnixThunk->Fcntl( Private->BpfFd, F_SETFL, (void *) Value );

    if ( Result == -1 )
    {
      goto DeviceErrorExit;
    }

    //
    // Disable "header complete" flag.  This means the supplied source MAC address is
    // what goes on the wire.
    //
    Value = 1;
    Result = Private->UnixThunk->IoCtl( Private->BpfFd, BIOCSHDRCMPLT, &Value );

    if ( Result < 0 )
    {
      goto DeviceErrorExit;
    }

    Result = Private->UnixThunk->IoCtl( Private->BpfFd, BIOCGBLEN, &Value );

    if ( Result < 0 )
    {
      goto DeviceErrorExit;
    }

    //
    // Allocate read buffer.
    //
    Private->ReadBufferSize = Value;
    Private->ReadBuffer = AllocateZeroPool( Private->ReadBufferSize );
    if ( Private->ReadBuffer == NULL )
    {
      Status = EFI_OUT_OF_RESOURCES;
      goto ErrorExit;
    }

    Private->CurrentReadPointer = Private->EndReadPointer = Private->ReadBuffer;

    //
    // Install our packet filter: successful reads should only produce broadcast or unitcast
    // packets directed to our fake MAC address.
    //
    FilterProgram = AllocateCopyPool( sizeof( FilterInstructionTemplate ), &FilterInstructionTemplate );
    if ( FilterProgram == NULL )
    {
      goto ErrorExit;
    }

    //
    // Insert out fake MAC address into the filter.  The data has to be host endian.
    //
    CopyMem( &Temp32, &Private->Mode.CurrentAddress.Addr[ 0 ], sizeof( UINT32 ) );
    FilterProgram[ 1 ].k = NTOHL( Temp32 );
    CopyMem( &Temp16, &Private->Mode.CurrentAddress.Addr[ 4 ], sizeof( UINT16 ) );
    FilterProgram[ 3 ].k = NTOHS( Temp16 );

    BpfProgram.bf_len = sizeof( FilterInstructionTemplate ) / sizeof( struct bpf_insn );
    BpfProgram.bf_insns = FilterProgram;

    Result = Private->UnixThunk->IoCtl( Private->BpfFd, BIOCSETF, &BpfProgram );

    if ( Result < 0 )
    {
      goto DeviceErrorExit;
    }

    FreePool( FilterProgram );

    //
    // Enable promiscuous mode.
    //

    Result = Private->UnixThunk->IoCtl( Private->BpfFd, BIOCPROMISC, 0 );

    if ( Result < 0 )
    {
      goto DeviceErrorExit;
    }


    Private->Snp.Mode->State = EfiSimpleNetworkStarted;      
  }

  return( Status );

DeviceErrorExit:
  Status = EFI_DEVICE_ERROR;
ErrorExit:
  if ( Private->ReadBuffer != NULL )
  {
    FreePool( Private->ReadBuffer );
    Private->ReadBuffer = NULL;
  }
  return( Status );
}


/**
  Changes the state of a network interface from "started" to "stopped".

  @param  This Protocol instance pointer.

  @retval EFI_SUCCESS           Always succeeds.

**/
EFI_STATUS
EFIAPI
UnixSnpStop(
  IN EFI_SIMPLE_NETWORK_PROTOCOL*    This
  )
{
  UNIX_SNP_PRIVATE_DATA*        Private = EFI_SUCCESS;
  EFI_STATUS              Status;

  Private = UNIX_SNP_PRIVATE_DATA_FROM_SNP_THIS( This );

  switch ( Private->Snp.Mode->State )
  {
    case EfiSimpleNetworkStarted:
      break;

    case EfiSimpleNetworkStopped:
      return( EFI_NOT_STARTED );
      break;

    default:
      return( EFI_DEVICE_ERROR );
      break;
  }

  if ( Private->BpfFd != 0 )
  {
    Private->UnixThunk->Close( Private->BpfFd );
    Private->BpfFd = 0;
  }

  if ( Private->ReadBuffer != NULL )
  {
    FreePool( Private->ReadBuffer );
    Private->CurrentReadPointer = Private->EndReadPointer = Private->ReadBuffer = NULL;
  }

  Private->Snp.Mode->State = EfiSimpleNetworkStopped;

  return( Status );
}


/**
  Resets a network adapter and allocates the transmit and receive buffers 
  required by the network interface; optionally, also requests allocation 
  of additional transmit and receive buffers.

  @param  This              Protocol instance pointer.
  @param  ExtraRxBufferSize The size, in bytes, of the extra receive buffer space
                            that the driver should allocate for the network interface.
                            Some network interfaces will not be able to use the extra
                            buffer, and the caller will not know if it is actually
                            being used.
  @param  ExtraTxBufferSize The size, in bytes, of the extra transmit buffer space
                            that the driver should allocate for the network interface.
                            Some network interfaces will not be able to use the extra
                            buffer, and the caller will not know if it is actually
                            being used.

  @retval EFI_SUCCESS           Always succeeds.

**/
EFI_STATUS
EFIAPI
UnixSnpInitialize(
  IN EFI_SIMPLE_NETWORK_PROTOCOL*    This,
  IN UINTN              ExtraRxBufferSize OPTIONAL,
  IN UINTN              ExtraTxBufferSize OPTIONAL
  )
{
  UNIX_SNP_PRIVATE_DATA*        Private = EFI_SUCCESS;
  EFI_STATUS              Status;

  Private = UNIX_SNP_PRIVATE_DATA_FROM_SNP_THIS( This );

  switch ( Private->Snp.Mode->State )
  {
    case EfiSimpleNetworkStarted:
      break;

    case EfiSimpleNetworkStopped:
      return( EFI_NOT_STARTED );
      break;

    default:
      return( EFI_DEVICE_ERROR );
      break;
  }

#if 0
  Status = gBS->CreateEvent(
          EVT_NOTIFY_WAIT,
          TPL_NOTIFY,
          UnixSnpWaitForPacketNotify,
          Private,
          &Private->Snp.WaitForPacket
          );
#endif

  if ( !EFI_ERROR( Status ) )
  {
    Private->Mode.MCastFilterCount = 0;
    Private->Mode.ReceiveFilterSetting = 0;
    ZeroMem( Private->Mode.MCastFilter, sizeof( Private->Mode.MCastFilter ) );

    Private->Snp.Mode->State = EfiSimpleNetworkInitialized;
  }

  return( Status );
}

/**
  Resets a network adapter and re-initializes it with the parameters that were 
  provided in the previous call to Initialize().  

  @param  This                 Protocol instance pointer.
  @param  ExtendedVerification Indicates that the driver may perform a more
                               exhaustive verification operation of the device
                               during reset.

  @retval EFI_SUCCESS           Always succeeds.

**/
EFI_STATUS
EFIAPI
UnixSnpReset(
  IN EFI_SIMPLE_NETWORK_PROTOCOL*    This,
  IN BOOLEAN              ExtendedVerification
  )
{
  UNIX_SNP_PRIVATE_DATA*        Private;
  EFI_STATUS              Success = EFI_SUCCESS;

  Private = UNIX_SNP_PRIVATE_DATA_FROM_SNP_THIS( This );

  switch ( Private->Snp.Mode->State )
  {
    case EfiSimpleNetworkInitialized:
      break;

    case EfiSimpleNetworkStopped:
      return( EFI_NOT_STARTED );
      break;

    default:
      return( EFI_DEVICE_ERROR );
      break;
  }

  return( Success );
}

/**
  Resets a network adapter and leaves it in a state that is safe for 
  another driver to initialize.

  @param  This Protocol instance pointer.

  @retval EFI_SUCCESS           Always succeeds.

**/
EFI_STATUS
EFIAPI
UnixSnpShutdown(
  IN EFI_SIMPLE_NETWORK_PROTOCOL*    This
  )
{
  UNIX_SNP_PRIVATE_DATA*        Private;
  EFI_STATUS              Success = EFI_SUCCESS;

  Private = UNIX_SNP_PRIVATE_DATA_FROM_SNP_THIS( This );

  switch ( Private->Snp.Mode->State )
  {
    case EfiSimpleNetworkInitialized:
      break;

    case EfiSimpleNetworkStopped:
      return( EFI_NOT_STARTED );
      break;

    default:
      return( EFI_DEVICE_ERROR );
      break;
  }

  Private->Snp.Mode->State = EfiSimpleNetworkStarted;

  Private->Mode.ReceiveFilterSetting = 0;
  Private->Mode.MCastFilterCount = 0;
  ZeroMem( Private->Mode.MCastFilter, sizeof( Private->Mode.MCastFilter ) );

  if ( Private->Snp.WaitForPacket != NULL )
  {
    gBS->CloseEvent( Private->Snp.WaitForPacket );
    Private->Snp.WaitForPacket = NULL;
  }

  if ( Private->BpfFd != 0 )
  {
    Private->UnixThunk->Close( Private->BpfFd );
    Private->BpfFd = 0;
  }

  if ( Private->ReadBuffer != NULL )
  {
    FreePool( Private->ReadBuffer );
    Private->CurrentReadPointer = Private->EndReadPointer = Private->ReadBuffer = NULL;
  }

  return( Success );
}

/**
  Manages the multicast receive filters of a network interface.

  @param  This               Protocol instance pointer.
  @param  EnableBits         A bit mask of receive filters to enable on the network interface.
  @param  DisableBits        A bit mask of receive filters to disable on the network interface.
  @param  ResetMcastFilter   Set to TRUE to reset the contents of the multicast receive
                             filters on the network interface to their default values.
  @param  McastFilterCount   Number of multicast HW MAC addresses in the new
                             MCastFilter list. This value must be less than or equal to
                             the MCastFilterCnt field of EFI_SIMPLE_NETWORK_MODE. This
                             field is optional if ResetMCastFilter is TRUE.
  @param  McastFilter        A pointer to a list of new multicast receive filter HW MAC
                             addresses. This list will replace any existing multicast
                             HW MAC address list. This field is optional if
                             ResetMCastFilter is TRUE.

  @retval EFI_SUCCESS           The multicast receive filter list was updated.
  @retval EFI_DEVICE_ERROR      The command could not be sent to the network interface.

**/
EFI_STATUS
EFIAPI
UnixSnpReceiveFilters(
  IN EFI_SIMPLE_NETWORK_PROTOCOL*    This,
  IN UINT32              EnableBits,
  IN UINT32              DisableBits,
  IN BOOLEAN              ResetMcastFilter,
  IN UINTN              McastFilterCount OPTIONAL,
  IN EFI_MAC_ADDRESS*          McastFilter OPTIONAL
  )
{
  UNIX_SNP_PRIVATE_DATA*        Private;

  Private = UNIX_SNP_PRIVATE_DATA_FROM_SNP_THIS( This );

//  ReturnValue = GlobalData->NtNetUtilityTable.SetReceiveFilter (
//                                                Instance->InterfaceInfo.InterfaceIndex,
//                                                EnableBits,
//                                                McastFilterCount,
//                                                McastFilter
//                                                );

  // For now, just succeed...
  return( EFI_SUCCESS );
}

/**
  Modifies or resets the current station address, if supported.

  @param  This         Protocol instance pointer.
  @param  Reset        Flag used to reset the station address to the network interfaces
                       permanent address.
  @param  NewMacAddr   New station address to be used for the network interface.

  @retval EFI_UNSUPPORTED       Not supported yet.

**/
EFI_STATUS
EFIAPI
UnixSnpStationAddress(
  IN EFI_SIMPLE_NETWORK_PROTOCOL*    This,
  IN BOOLEAN              Reset,
  IN EFI_MAC_ADDRESS*          NewMacAddr OPTIONAL
  )
{
  return( EFI_UNSUPPORTED );
}

/**
  Resets or collects the statistics on a network interface.

  @param  This            Protocol instance pointer.
  @param  Reset           Set to TRUE to reset the statistics for the network interface.
  @param  StatisticsSize  On input the size, in bytes, of StatisticsTable. On
                          output the size, in bytes, of the resulting table of
                          statistics.
  @param  StatisticsTable A pointer to the EFI_NETWORK_STATISTICS structure that
                          contains the statistics.

  @retval EFI_SUCCESS           The statistics were collected from the network interface.
  @retval EFI_NOT_STARTED       The network interface has not been started.
  @retval EFI_BUFFER_TOO_SMALL  The Statistics buffer was too small. The current buffer
                                size needed to hold the statistics is returned in
                                StatisticsSize.
  @retval EFI_UNSUPPORTED       Not supported yet.

**/
EFI_STATUS
EFIAPI
UnixSnpStatistics(
  IN EFI_SIMPLE_NETWORK_PROTOCOL*    This,
  IN BOOLEAN              Reset,
  IN OUT UINTN*            StatisticsSize OPTIONAL,
  OUT EFI_NETWORK_STATISTICS*      StatisticsTable OPTIONAL
  )
{
  return( EFI_UNSUPPORTED );
}

/**
  Converts a multicast IP address to a multicast HW MAC address.

  @param  This Protocol instance pointer.
  @param  Ipv6 Set to TRUE if the multicast IP address is IPv6 [RFC 2460]. Set
               to FALSE if the multicast IP address is IPv4 [RFC 791].
  @param  Ip   The multicast IP address that is to be converted to a multicast
               HW MAC address.
  @param  Mac  The multicast HW MAC address that is to be generated from IP.

  @retval EFI_SUCCESS           The multicast IP address was mapped to the multicast
                                HW MAC address.
  @retval EFI_NOT_STARTED       The network interface has not been started.
  @retval EFI_BUFFER_TOO_SMALL  The Statistics buffer was too small. The current buffer
                                size needed to hold the statistics is returned in
                                StatisticsSize.
  @retval EFI_UNSUPPORTED       Not supported yet.

**/
EFI_STATUS
EFIAPI
UnixSnpMcastIptoMac(
  IN EFI_SIMPLE_NETWORK_PROTOCOL*    This,
  IN BOOLEAN              Ipv6,
  IN EFI_IP_ADDRESS*          Ip,
  OUT EFI_MAC_ADDRESS*        Mac
  )
{
  return( EFI_UNSUPPORTED );
}


/**
  Performs read and write operations on the NVRAM device attached to a 
  network interface.

  @param  This         Protocol instance pointer.
  @param  ReadOrWrite  TRUE for read operations, FALSE for write operations.
  @param  Offset       Byte offset in the NVRAM device at which to start the read or
                       write operation. This must be a multiple of NvRamAccessSize and
                       less than NvRamSize.
  @param  BufferSize   The number of bytes to read or write from the NVRAM device.
                       This must also be a multiple of NvramAccessSize.
  @param  Buffer       A pointer to the data buffer.

  @retval EFI_UNSUPPORTED       Not supported yet.

**/
EFI_STATUS
EFIAPI
UnixSnpNvdata(
  IN EFI_SIMPLE_NETWORK_PROTOCOL*    This,
  IN BOOLEAN              ReadOrWrite,
  IN UINTN              Offset,
  IN UINTN              BufferSize,
  IN OUT VOID*            Buffer
  )
{
  return( EFI_UNSUPPORTED );
}


/**
  Reads the current interrupt status and recycled transmit buffer status from 
  a network interface.

  @param  This            Protocol instance pointer.
  @param  InterruptStatus A pointer to the bit mask of the currently active interrupts
                          If this is NULL, the interrupt status will not be read from
                          the device. If this is not NULL, the interrupt status will
                          be read from the device. When the  interrupt status is read,
                          it will also be cleared. Clearing the transmit  interrupt
                          does not empty the recycled transmit buffer array.
  @param  TxBuffer        Recycled transmit buffer address. The network interface will
                          not transmit if its internal recycled transmit buffer array
                          is full. Reading the transmit buffer does not clear the
                          transmit interrupt. If this is NULL, then the transmit buffer
                          status will not be read. If there are no transmit buffers to
                          recycle and TxBuf is not NULL, * TxBuf will be set to NULL.

  @retval EFI_SUCCESS           Always succeeds.

**/
EFI_STATUS
EFIAPI
UnixSnpGetStatus(
  IN EFI_SIMPLE_NETWORK_PROTOCOL*    This,
  OUT UINT32*              InterruptStatus,
  OUT VOID**              TxBuffer
  )
{
  if ( TxBuffer != NULL )
  {
    *( ( UINT8 ** ) TxBuffer ) = ( UINT8 * ) 1;
  }

  if ( InterruptStatus != NULL )
  {
    *InterruptStatus = EFI_SIMPLE_NETWORK_TRANSMIT_INTERRUPT;
  }

  return( EFI_SUCCESS );
}


/**
  Places a packet in the transmit queue of a network interface.

  @param  This       Protocol instance pointer.
  @param  HeaderSize The size, in bytes, of the media header to be filled in by
                     the Transmit() function. If HeaderSize is non-zero, then it
                     must be equal to This->Mode->MediaHeaderSize and the DestAddr
                     and Protocol parameters must not be NULL.
  @param  BufferSize The size, in bytes, of the entire packet (media header and
                     data) to be transmitted through the network interface.
  @param  Buffer     A pointer to the packet (media header followed by data) to be
                     transmitted. This parameter cannot be NULL. If HeaderSize is zero,
                     then the media header in Buffer must already be filled in by the
                     caller. If HeaderSize is non-zero, then the media header will be
                     filled in by the Transmit() function.
  @param  SrcAddr    The source HW MAC address. If HeaderSize is zero, then this parameter
                     is ignored. If HeaderSize is non-zero and SrcAddr is NULL, then
                     This->Mode->CurrentAddress is used for the source HW MAC address.
  @param  DestAddr   The destination HW MAC address. If HeaderSize is zero, then this
                     parameter is ignored.
  @param  Protocol   The type of header to build. If HeaderSize is zero, then this
                     parameter is ignored. See RFC 1700, section "Ether Types", for
                     examples.

  @retval EFI_SUCCESS           The packet was placed on the transmit queue.
  @retval EFI_DEVICE_ERROR      The command could not be sent to the network interface.
  @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.
  @retval EFI_NOT_STARTED       The network interface has not been started.

**/
EFI_STATUS
EFIAPI
UnixSnpTransmit(
  IN EFI_SIMPLE_NETWORK_PROTOCOL*    This,
  IN UINTN              HeaderSize,
  IN UINTN              BufferSize,
  IN VOID*              Buffer,
  IN EFI_MAC_ADDRESS*          SrcAddr OPTIONAL,
  IN EFI_MAC_ADDRESS*          DestAddr OPTIONAL,
  IN UINT16*              Protocol OPTIONAL
  )
{
  UNIX_SNP_PRIVATE_DATA*        Private;
  EthernetHeader*            EnetHeader;
  INTN                Result;

  Private = UNIX_SNP_PRIVATE_DATA_FROM_SNP_THIS( This );

  if ( This->Mode->State < EfiSimpleNetworkStarted )
  {
    return( EFI_NOT_STARTED );
  }

  if ( HeaderSize != 0 )
  {
    if ( ( DestAddr == NULL ) || ( Protocol == NULL ) || ( HeaderSize != This->Mode->MediaHeaderSize ) )
    {
      return( EFI_INVALID_PARAMETER );
    }

    if ( SrcAddr == NULL )
    {
      SrcAddr = &This->Mode->CurrentAddress;
    }

    EnetHeader = ( EthernetHeader * ) Buffer;

    CopyMem( EnetHeader->DstAddr, DestAddr, NET_ETHER_ADDR_LEN );
    CopyMem( EnetHeader->SrcAddr, SrcAddr, NET_ETHER_ADDR_LEN );

    EnetHeader->Type = HTONS( *Protocol );
  }

  Result = Private->UnixThunk->Write( Private->BpfFd, Buffer, BufferSize );

  if ( Result < 0 )
  {
    return( EFI_DEVICE_ERROR );
  }
  else
  {
    return( EFI_SUCCESS );
  }
}

/**
  Receives a packet from a network interface.

  @param  This             Protocol instance pointer.
  @param  HeaderSize       The size, in bytes, of the media header received on the network
                           interface. If this parameter is NULL, then the media header size
                           will not be returned.
  @param  BuffSize         On entry, the size, in bytes, of Buffer. On exit, the size, in
                           bytes, of the packet that was received on the network interface.
  @param  Buffer           A pointer to the data buffer to receive both the media header and
                           the data.
  @param  SourceAddr       The source HW MAC address. If this parameter is NULL, the
                           HW MAC source address will not be extracted from the media
                           header.
  @param  DestinationAddr  The destination HW MAC address. If this parameter is NULL,
                           the HW MAC destination address will not be extracted from the
                           media header.
  @param  Protocol         The media header type. If this parameter is NULL, then the
                           protocol will not be extracted from the media header. See
                           RFC 1700 section "Ether Types" for examples.

  @retval EFI_SUCCESS           The received data was stored in Buffer, and BufferSize has
                                been updated to the number of bytes received.
  @retval EFI_NOT_READY         The network interface is too busy to accept this transmit
                                request.
  @retval EFI_NOT_STARTED       The network interface has not been started.
  @retval EFI_BUFFER_TOO_SMALL  The BufferSize parameter is too small.
  @retval EFI_DEVICE_ERROR      The command could not be sent to the network interface.

**/
EFI_STATUS
EFIAPI
UnixSnpReceive(
  IN EFI_SIMPLE_NETWORK_PROTOCOL*    This,
  OUT UINTN*              HeaderSize OPTIONAL,
  IN OUT UINTN*            BuffSize,
  OUT VOID*              Buffer,
  OUT EFI_MAC_ADDRESS*        SourceAddr OPTIONAL,
  OUT EFI_MAC_ADDRESS*        DestinationAddr OPTIONAL,
  OUT UINT16*              Protocol OPTIONAL
  )
{
  UNIX_SNP_PRIVATE_DATA*        Private;
  struct bpf_hdr*            BpfHeader;
  EthernetHeader*            EnetHeader;
  EFI_STATUS              Status = EFI_SUCCESS;
  INTN                Result;

  if ( This->Mode->State < EfiSimpleNetworkStarted )
  {
    return( EFI_NOT_STARTED );
  }

  Private = UNIX_SNP_PRIVATE_DATA_FROM_SNP_THIS( This );

  //
  // Do we have any remaining packets from the previous read?
  //
  if ( Private->CurrentReadPointer >= Private->EndReadPointer )
  {
    Result = Private->UnixThunk->Read( Private->BpfFd, Private->ReadBuffer, Private->ReadBufferSize );

    if ( Result < 0 )
    {
      Result = Private->UnixThunk->GetErrno();

      //
      // EAGAIN means that there's no I/O outstanding against this file descriptor.
      //
      if ( Result == EAGAIN )
      {
        return( EFI_NOT_READY );
      }
      else
      {
        return( EFI_DEVICE_ERROR );
      }
    }

    if ( Result == 0 )
    {
      return( EFI_NOT_READY );
    }

    Private->CurrentReadPointer = Private->ReadBuffer;
    Private->EndReadPointer = Private->CurrentReadPointer + Result;
  }

  BpfHeader = Private->CurrentReadPointer;
  EnetHeader = Private->CurrentReadPointer + BpfHeader->bh_hdrlen;

  if ( BpfHeader->bh_caplen > *BuffSize )
  {
    *BuffSize = BpfHeader->bh_caplen;
    return( EFI_BUFFER_TOO_SMALL );
  }

  CopyMem( Buffer, EnetHeader, BpfHeader->bh_caplen );
  *BuffSize = BpfHeader->bh_caplen;

  if ( HeaderSize != NULL )
  {
    *HeaderSize = sizeof( EthernetHeader );
  }

  if ( DestinationAddr != NULL )
  {
    ZeroMem( DestinationAddr, sizeof( EFI_MAC_ADDRESS ) );
    CopyMem( DestinationAddr, EnetHeader->DstAddr, NET_ETHER_ADDR_LEN );
  }

  if ( SourceAddr != NULL )
  {
    ZeroMem( SourceAddr, sizeof( EFI_MAC_ADDRESS ) );
    CopyMem( SourceAddr, EnetHeader->SrcAddr, NET_ETHER_ADDR_LEN );
  }

  if ( Protocol != NULL )
  {
    *Protocol = NTOHS( EnetHeader->Type );
  }

  Private->CurrentReadPointer += BPF_WORDALIGN( BpfHeader->bh_hdrlen + BpfHeader->bh_caplen );

  return( Status );
}


VOID
EFIAPI
UnixSnpWaitForPacketNotify(
  IN EFI_EVENT            Event,
  IN VOID*              Context
  )
{
  UNIX_SNP_PRIVATE_DATA*        Private;

  Private = UNIX_SNP_PRIVATE_DATA_FROM_SNP_THIS( Context );

  if ( Private->Snp.Mode->State < EfiSimpleNetworkStarted )
  {
    return;
  }
}


/**
  This is the declaration of an EFI image entry point. This entry point is
  the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including
  both device drivers and bus drivers.

  @param  ImageHandle           The firmware allocated handle for the UEFI image.
  @param  SystemTable           A pointer to the EFI System Table.

  @retval EFI_SUCCESS           The operation completed successfully.
  @retval EFI_OUT_OF_RESOURCES  The request could not be completed due to a lack of resources.

**/
EFI_STATUS
InitializeUnixSnpDriver(
  IN EFI_HANDLE        ImageHandle,
  IN EFI_SYSTEM_TABLE*    SystemTable
  )
{
  EFI_STATUS            Status;

  //
  // Install the Driver Protocols
  //

  Status = EfiLibInstallDriverBindingComponentName2(
          ImageHandle,
          SystemTable,
          &gUnixSnpDriverBinding,
          ImageHandle,
          &gUnixSnpDriverComponentName,
          &gUnixSnpDriverComponentName2
          );

  return( Status );
}