aboutsummaryrefslogtreecommitdiffstats
path: root/Drivers/Net/MarvellYukonDxe/Snp.c
blob: f2f173f4df45c9fc684ffd61663f6b62010e8a8c (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
/**  <at> file
Provides the Simple Network functions.

Copyright (c) 2004 - 2010, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2011 - 2016, ARM Limited. All rights reserved.

This program and the accompanying materials are licensed
and made available under the terms and conditions of the BSD License which
accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

**/

#include "MarvellYukon.h"
#include "if_msk.h"

EFI_STATUS
InitializeSNPProtocol (
    IN OUT  YUKON_DRIVER *YukonDriver
    )
{
  EFI_STATUS    Status;

  Status = RETURN_SUCCESS;

  YukonDriver->Snp.Revision       = EFI_SIMPLE_NETWORK_PROTOCOL_REVISION;
  YukonDriver->Snp.Start          = SnpStart;
  YukonDriver->Snp.Stop           = SnpStop;
  YukonDriver->Snp.Initialize     = SnpInitialize;
  YukonDriver->Snp.Reset          = SnpReset;
  YukonDriver->Snp.Shutdown       = SnpShutdown;
  YukonDriver->Snp.ReceiveFilters = SnpReceiveFilters;
  YukonDriver->Snp.StationAddress = SnpStationAddress;
  YukonDriver->Snp.Statistics     = SnpStatistics;
  YukonDriver->Snp.MCastIpToMac   = SnpMcastIpToMac;
  YukonDriver->Snp.NvData         = SnpNvData;
  YukonDriver->Snp.GetStatus      = SnpGetStatus;
  YukonDriver->Snp.Transmit       = SnpTransmit;
  YukonDriver->Snp.Receive        = SnpReceive;
  YukonDriver->Snp.WaitForPacket  = NULL;

  YukonDriver->Snp.Mode           = &YukonDriver->SnpMode;

  //
  //  Initialize simple network protocol mode structure
  //
  YukonDriver->SnpMode.State               = EfiSimpleNetworkStopped;
  YukonDriver->SnpMode.HwAddressSize       = NET_ETHER_ADDR_LEN;
  YukonDriver->SnpMode.MediaHeaderSize     = sizeof (ETHER_HEAD);
  YukonDriver->SnpMode.MaxPacketSize       = MAX_SUPPORTED_PACKET_SIZE;
  YukonDriver->SnpMode.NvRamAccessSize     = 0;
  YukonDriver->SnpMode.NvRamSize           = 0;
  YukonDriver->SnpMode.IfType              = NET_IFTYPE_ETHERNET;
  YukonDriver->SnpMode.MaxMCastFilterCount = MAX_MCAST_FILTER_CNT;
  YukonDriver->SnpMode.MCastFilterCount    = 0;
  gBS->SetMem (&YukonDriver->SnpMode.MCastFilter, MAX_MCAST_FILTER_CNT * sizeof(EFI_MAC_ADDRESS), 0);

  //
  //  Set broadcast address
  //
  gBS->SetMem (&YukonDriver->SnpMode.BroadcastAddress, sizeof (EFI_MAC_ADDRESS), 0xFF);

  YukonDriver->SnpMode.MediaPresentSupported = FALSE;
  YukonDriver->SnpMode.MacAddressChangeable = FALSE;
  YukonDriver->SnpMode.MultipleTxSupported = FALSE;
  YukonDriver->SnpMode.ReceiveFilterMask = EFI_SIMPLE_NETWORK_RECEIVE_UNICAST;
  YukonDriver->SnpMode.ReceiveFilterSetting = 0;

  YukonDriver->SnpMode.MediaPresent = TRUE;

  return Status;
}

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

  This function gets the current interrupt and recycled transmit buffer status
  from the network interface. The interrupt status is returned as a bit mask in
  InterruptStatus. If InterruptStatus is NULL, the interrupt status will not be
  read. If TxBuf is not NULL, a recycled transmit buffer address will be retrieved.
  If a recycled transmit buffer address is returned in TxBuf, then the buffer has
  been successfully transmitted, and the status for that buffer is cleared. If
  the status of the network interface is successfully collected, EFI_SUCCESS
  will be returned. If the driver has not been initialized, EFI_DEVICE_ERROR will
  be returned.

   <at> param This                    A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.
   <at> param InterruptStatus         A pointer to the bit mask of the currently active
                                      interrupts (see "Related Definitions"). 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.
   <at> param TxBuf                   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.

   <at> retval EFI_SUCCESS            The status of the network interface was retrieved.
   <at> retval EFI_NOT_STARTED        The network interface has not been started.
   <at> retval EFI_INVALID_PARAMETER  This parameter was NULL or did not point to a valid
                                      EFI_SIMPLE_NETWORK_PROTOCOL structure.
   <at> retval EFI_DEVICE_ERROR       The command could not be sent to the network
                                      interface.

**/
EFI_STATUS
EFIAPI
SnpGetStatus (
    IN EFI_SIMPLE_NETWORK_PROTOCOL *This,
    OUT UINT32                     *InterruptStatus, OPTIONAL
    OUT VOID                       **TxBuf           OPTIONAL
    )
{
  EFI_STATUS    Status;
  YUKON_DRIVER    *Snp;
  EFI_TPL       OldTpl;
  struct msk_softc *ScData;

  if (This == NULL) {
    return EFI_INVALID_PARAMETER;
  }

  Snp = YUKON_DEV_FROM_THIS_SNP (This);
  if (Snp == NULL) {
    return EFI_INVALID_PARAMETER;
  }

  Status = MarvellYukonGetControllerData (Snp->Controller, &ScData);
  if (EFI_ERROR (Status)) {
    return Status;
  }

  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);

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

    case EfiSimpleNetworkStopped:
      Status = EFI_NOT_STARTED;
      goto ON_EXIT;

    default:
      Status = EFI_DEVICE_ERROR;
      goto ON_EXIT;
  }

  mskc_getstatus (ScData->msk_if[Snp->Port], InterruptStatus, TxBuf);
  Status = EFI_SUCCESS;

ON_EXIT:
  gBS->RestoreTPL (OldTpl);

  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.

  This function allocates the transmit and receive buffers required by the network
  interface. If this allocation fails, then EFI_OUT_OF_RESOURCES is returned.
  If the allocation succeeds and the network interface is successfully initialized,
  then EFI_SUCCESS will be returned.

   <at> param This                    A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.

   <at> 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.
   <at> 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.

   <at> retval EFI_SUCCESS            The network interface was initialized.
   <at> retval EFI_NOT_STARTED        The network interface has not been started.
   <at> retval EFI_OUT_OF_RESOURCES   There was not enough memory for the transmit and
                                      receive buffers.
   <at> retval EFI_INVALID_PARAMETER  This parameter was NULL or did not point to a valid
                                                                   EFI_SIMPLE_NETWORK_PROTOCOL structure.
   <at> retval EFI_DEVICE_ERROR       The command could not be sent to the network interface.
   <at> retval EFI_UNSUPPORTED        The increased buffer size feature is not supported.

**/
EFI_STATUS
EFIAPI
SnpInitialize (
    IN EFI_SIMPLE_NETWORK_PROTOCOL *This,
    IN UINTN                       ExtraRxBufferSize OPTIONAL,
    IN UINTN                       ExtraTxBufferSize OPTIONAL
    )
{
  EFI_STATUS    Status;
  YUKON_DRIVER    *YukonDriver;
  EFI_TPL       OldTpl;
  struct msk_softc *ScData;

  DEBUG ((EFI_D_NET, "Marvell Yukon: SnpInitialize()\n"));
  if (This == NULL) {
    DEBUG ((EFI_D_ERROR, "Marvell Yukon: SnpInitialize() failed with Status = %r\n", EFI_INVALID_PARAMETER));
    return EFI_INVALID_PARAMETER;
  }

  YukonDriver = YUKON_DEV_FROM_THIS_SNP (This);

  Status = MarvellYukonGetControllerData (YukonDriver->Controller, &ScData);
  if (EFI_ERROR (Status)) {
    return Status;
  }

  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);

  switch (YukonDriver->SnpMode.State) {
    case EfiSimpleNetworkStarted:
      break;

    case EfiSimpleNetworkStopped:
      Status = EFI_NOT_STARTED;
      goto ON_ERROR_RESTORE_TPL;

    default:
      Status = EFI_DEVICE_ERROR;
      goto ON_ERROR_RESTORE_TPL;
  }

  YukonDriver->SnpMode.MCastFilterCount      = 0;
  YukonDriver->SnpMode.ReceiveFilterSetting  = 0;
  gBS->SetMem (YukonDriver->SnpMode.MCastFilter, sizeof YukonDriver->SnpMode.MCastFilter, 0);
  gBS->CopyMem (&YukonDriver->SnpMode.CurrentAddress, &YukonDriver->SnpMode.PermanentAddress, sizeof (EFI_MAC_ADDRESS));

  Status = mskc_init (ScData->msk_if[YukonDriver->Port]);

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

  YukonDriver->SnpMode.State = EfiSimpleNetworkInitialized;
  goto ON_EXIT;

ON_ERROR_RESTORE_TPL:
  DEBUG ((EFI_D_ERROR, "Marvell Yukon: SnpInitialize() failed with Status = %r\n", Status));

ON_EXIT:
  gBS->RestoreTPL (OldTpl);
  return Status;
}

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

  This function converts a multicast IP address to a multicast HW MAC address
  for all packet transactions. If the mapping is accepted, then EFI_SUCCESS will
  be returned.

   <at> param This                    A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.
   <at> 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].
   <at> param IP                      The multicast IP address that is to be converted to a multicast
                                      HW MAC address.
   <at> param MAC                     The multicast HW MAC address that is to be generated from IP.

   <at> retval EFI_SUCCESS            The multicast IP address was mapped to the
                                      multicast HW MAC address.
   <at> retval EFI_NOT_STARTED        The Simple Network Protocol interface has not
                                      been started by calling Start().
   <at> retval EFI_INVALID_PARAMETER  IP is NULL.
   <at> retval EFI_INVALID_PARAMETER  MAC is NULL.
   <at> retval EFI_INVALID_PARAMETER  IP does not point to a valid IPv4 or IPv6
                                      multicast address.
   <at> retval EFI_DEVICE_ERROR       The Simple Network Protocol interface has not
                                      been initialized by calling Initialize().
   <at> retval EFI_UNSUPPORTED        IPv6 is TRUE and the implementation does not
                                      support IPv6 multicast to MAC address conversion.

**/
EFI_STATUS
EFIAPI
SnpMcastIpToMac (
    IN EFI_SIMPLE_NETWORK_PROTOCOL *This,
    IN BOOLEAN                     IPv6,
    IN EFI_IP_ADDRESS              *IP,
    OUT EFI_MAC_ADDRESS            *MAC
    )
{
  EFI_STATUS    Status;
  YUKON_DRIVER    *YukonDriver;
  EFI_TPL       OldTpl;

  DEBUG ((EFI_D_NET, "Marvell Yukon: SnpMcastIpToMac()\n"));

  //
  // Get pointer to SNP driver instance for *this.
  //
  if (This == NULL) {
    return EFI_INVALID_PARAMETER;
  }

  if (IP == NULL || MAC == NULL) {
    return EFI_INVALID_PARAMETER;
  }

  YukonDriver = YUKON_DEV_FROM_THIS_SNP (This);

  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);

  switch (YukonDriver->SnpMode.State) {
    case EfiSimpleNetworkInitialized:
      break;

    case EfiSimpleNetworkStopped:
      Status = EFI_NOT_STARTED;
      goto ON_EXIT;

    default:
      Status = EFI_DEVICE_ERROR;
      goto ON_EXIT;
  }

  Status = EFI_UNSUPPORTED;

ON_EXIT:
  gBS->RestoreTPL (OldTpl);

  return Status;
}

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

  This function performs read and write operations on the NVRAM device attached
  to a network interface. If ReadWrite is TRUE, a read operation is performed.
  If ReadWrite is FALSE, a write operation is performed. Offset specifies the
  byte offset at which to start either operation. Offset must be a multiple of
  NvRamAccessSize , and it must have a value between zero and NvRamSize.
  BufferSize specifies the length of the read or write operation. BufferSize must
  also be a multiple of NvRamAccessSize, and Offset + BufferSize must not exceed
  NvRamSize.
  If any of the above conditions is not met, then EFI_INVALID_PARAMETER will be
  returned.
  If all the conditions are met and the operation is "read," the NVRAM device
  attached to the network interface will be read into Buffer and EFI_SUCCESS
  will be returned. If this is a write operation, the contents of Buffer will be
  used to update the contents of the NVRAM device attached to the network
  interface and EFI_SUCCESS will be returned.

  It does the basic checking on the input parameters and retrieves snp structure
  and then calls the read_nvdata() call which does the actual reading

   <at> param This                    A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.
   <at> param ReadWrite               TRUE for read operations, FALSE for write operations.
   <at> 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. (See EFI_SIMPLE_NETWORK_MODE)
   <at> param BufferSize              The number of bytes to read or write from the NVRAM device.
                                      This must also be a multiple of NvramAccessSize.
   <at> param Buffer                  A pointer to the data buffer.

   <at> retval EFI_SUCCESS            The NVRAM access was performed.
   <at> retval EFI_NOT_STARTED        The network interface has not been started.
   <at> retval EFI_INVALID_PARAMETER  One or more of the following conditions is TRUE:
                                      * The This parameter is NULL
                                      * The This parameter does not point to a valid
                                        EFI_SIMPLE_NETWORK_PROTOCOL  structure
                                      * The Offset parameter is not a multiple of
                                        EFI_SIMPLE_NETWORK_MODE.NvRamAccessSize
                                      * The Offset parameter is not less than
                                        EFI_SIMPLE_NETWORK_MODE.NvRamSize
                                      * The BufferSize parameter is not a multiple of
                                        EFI_SIMPLE_NETWORK_MODE.NvRamAccessSize
                                      * The Buffer parameter is NULL
   <at> retval EFI_DEVICE_ERROR       The command could not be sent to the network
                                      interface.
   <at> retval EFI_UNSUPPORTED        This function is not supported by the network
                                      interface.

**/
EFI_STATUS
EFIAPI
SnpNvData (
    IN EFI_SIMPLE_NETWORK_PROTOCOL *This,
    IN BOOLEAN                     ReadWrite,
    IN UINTN                       Offset,
    IN UINTN                       BufferSize,
    IN OUT VOID                    *Buffer
    )
{
  EFI_STATUS    Status;
  YUKON_DRIVER    *YukonDriver;
  EFI_TPL       OldTpl;

  DEBUG ((EFI_D_NET, "Marvell Yukon: SnpNvData()\n"));
  //
  // Get pointer to SNP driver instance for *this.
  //
  if (This == NULL) {
    return EFI_INVALID_PARAMETER;
  }

  YukonDriver = YUKON_DEV_FROM_THIS_SNP (This);

  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);

  //
  // Return error if the SNP is not initialized.
  //
  switch (YukonDriver->SnpMode.State) {
    case EfiSimpleNetworkInitialized:
      break;

    case EfiSimpleNetworkStopped:
      Status = EFI_NOT_STARTED;
      goto ON_EXIT;

    case EfiSimpleNetworkStarted:
    default:
      Status = EFI_DEVICE_ERROR;
      goto ON_EXIT;
  }
  //
  // Return error if non-volatile memory variables are not valid.
  //
  if (YukonDriver->SnpMode.NvRamSize == 0 || YukonDriver->SnpMode.NvRamAccessSize == 0) {
    Status = EFI_UNSUPPORTED;
    goto ON_EXIT;
  }
  //
  // Check for invalid parameter combinations.
  //
  if ((BufferSize == 0) ||
      (Buffer == NULL) ||
      (Offset >= YukonDriver->SnpMode.NvRamSize) ||
      (Offset + BufferSize > YukonDriver->SnpMode.NvRamSize) ||
      (BufferSize % YukonDriver->SnpMode.NvRamAccessSize != 0) ||
      (Offset % YukonDriver->SnpMode.NvRamAccessSize != 0)
      ) {
    Status = EFI_INVALID_PARAMETER;
    goto ON_EXIT;
  }

  Status = EFI_UNSUPPORTED;

ON_EXIT:
  gBS->RestoreTPL (OldTpl);

  return Status;
}

/**
  Receives a packet from a network interface.

  This function retrieves one packet from the receive queue of a network interface.
  If there are no packets on the receive queue, then EFI_NOT_READY will be
  returned. If there is a packet on the receive queue, and the size of the packet
  is smaller than BufferSize, then the contents of the packet will be placed in
  Buffer, and BufferSize will be updated with the actual size of the packet.
  In addition, if SrcAddr, DestAddr, and Protocol are not NULL, then these values
  will be extracted from the media header and returned. EFI_SUCCESS will be
  returned if a packet was successfully received.
  If BufferSize is smaller than the received packet, then the size of the receive
  packet will be placed in BufferSize and EFI_BUFFER_TOO_SMALL will be returned.
  If the driver has not been initialized, EFI_DEVICE_ERROR will be returned.

   <at> param This                    A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.
   <at> 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.
   <at> param BufferSize              On entry, the size, in bytes, of Buffer. On exit, the size, in
                                      bytes, of the packet that was received on the network interface.
   <at> param Buffer                  A pointer to the data buffer to receive both the media
                                      header and the data.
   <at> param SrcAddr                 The source HW MAC address. If this parameter is NULL, the HW
                                      MAC source address will not be extracted from the media header.
   <at> param DestAddr                The destination HW MAC address. If this parameter is NULL,
                                      the HW MAC destination address will not be extracted from
                                      the media header.
   <at> 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.

   <at> retval EFI_SUCCESS            The received data was stored in Buffer, and
                                      BufferSize has been updated to the number of
                                      bytes received.
   <at> retval EFI_NOT_STARTED        The network interface has not been started.
   <at> retval EFI_NOT_READY          No packets have been received on the network interface.
   <at> retval EFI_BUFFER_TOO_SMALL   BufferSize is too small for the received packets.
                                      BufferSize has been updated to the required size.
   <at> retval EFI_INVALID_PARAMETER  One or more of the following conditions is TRUE:
                                      * The This parameter is NULL
                                      * The This parameter does not point to a valid
                                        EFI_SIMPLE_NETWORK_PROTOCOL structure.
                                      * The BufferSize parameter is NULL
                                      * The Buffer parameter is NULL
   <at> retval EFI_DEVICE_ERROR       The command could not be sent to the network interface.

**/
EFI_STATUS
EFIAPI
SnpReceive (
    IN EFI_SIMPLE_NETWORK_PROTOCOL *This,
    OUT UINTN                      *HeaderSize OPTIONAL,
    IN OUT UINTN                   *BufferSize,
    OUT VOID                       *Buffer,
    OUT EFI_MAC_ADDRESS            *SrcAddr OPTIONAL,
    OUT EFI_MAC_ADDRESS            *DestAddr OPTIONAL,
    OUT UINT16                     *Protocol OPTIONAL
    )
{
  EFI_STATUS    Status;
  YUKON_DRIVER    *Snp;
  EFI_TPL       OldTpl;
  struct msk_softc *ScData;

  if (This == NULL) {
    return EFI_INVALID_PARAMETER;
  }

  Snp = YUKON_DEV_FROM_THIS_SNP (This);

  Status = MarvellYukonGetControllerData (Snp->Controller, &ScData);
  if (EFI_ERROR (Status)) {
    return Status;
  }

  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);

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

    case EfiSimpleNetworkStopped:
      Status = EFI_NOT_STARTED;
      goto ON_EXIT;

    default:
      Status = EFI_DEVICE_ERROR;
      goto ON_EXIT;
  }

  if ((BufferSize == NULL) || (Buffer == NULL)) {
    Status = EFI_INVALID_PARAMETER;
    goto ON_EXIT;
  }

  Status = mskc_receive (ScData->msk_if[Snp->Port], BufferSize, Buffer);
  if (EFI_ERROR (Status)) {
    if (Status == EFI_NOT_READY) {
      goto ON_EXIT_NO_DEBUG;
    }
  } else {
    // Extract header info
    if (HeaderSize != NULL) {
      *HeaderSize = sizeof (ETHER_HEAD);
    }

    if (SrcAddr != NULL) {
      gBS->SetMem (SrcAddr, NET_ETHER_ADDR_LEN, 0);
      gBS->CopyMem (SrcAddr, ((UINT8 *) Buffer) + NET_ETHER_ADDR_LEN, NET_ETHER_ADDR_LEN);
    }

    if (DestAddr != NULL) {
      gBS->SetMem (DestAddr, NET_ETHER_ADDR_LEN, 0);
      gBS->CopyMem (DestAddr, ((UINT8 *) Buffer), NET_ETHER_ADDR_LEN);
    }

    if (Protocol != NULL) {
      *Protocol = NTOHS (*((UINT16 *) (((UINT8 *) Buffer) + (2 * NET_ETHER_ADDR_LEN))));
    }
  }

ON_EXIT:
  DEBUG ((EFI_D_NET, "Marvell Yukon: SnpReceive() Status = %r\n", Status));

ON_EXIT_NO_DEBUG:
  gBS->RestoreTPL (OldTpl);
  return Status;
}

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

  This function is used enable and disable the hardware and software receive
  filters for the underlying network device.
  The receive filter change is broken down into three steps:
  * The filter mask bits that are set (ON) in the Enable parameter are added to
    the current receive filter settings.
  * The filter mask bits that are set (ON) in the Disable parameter are subtracted
    from the updated receive filter settings.
  * If the resulting receive filter setting is not supported by the hardware a
    more liberal setting is selected.
  If the same bits are set in the Enable and Disable parameters, then the bits
  in the Disable parameter takes precedence.
  If the ResetMCastFilter parameter is TRUE, then the multicast address list
  filter is disabled (irregardless of what other multicast bits are set in the
  Enable and Disable parameters). The SNP->Mode->MCastFilterCount field is set
  to zero. The Snp->Mode->MCastFilter contents are undefined.
  After enabling or disabling receive filter settings, software should verify
  the new settings by checking the Snp->Mode->ReceiveFilterSettings,
  Snp->Mode->MCastFilterCount and Snp->Mode->MCastFilter fields.
  Note: Some network drivers and/or devices will automatically promote receive
    filter settings if the requested setting can not be honored. For example, if
    a request for four multicast addresses is made and the underlying hardware
    only supports two multicast addresses the driver might set the promiscuous
    or promiscuous multicast receive filters instead. The receiving software is
    responsible for discarding any extra packets that get through the hardware
    receive filters.
    Note: Note: To disable all receive filter hardware, the network driver must
      be Shutdown() and Stopped(). Calling ReceiveFilters() with Disable set to
      Snp->Mode->ReceiveFilterSettings will make it so no more packets are
      returned by the Receive() function, but the receive hardware may still be
      moving packets into system memory before inspecting and discarding them.
      Unexpected system errors, reboots and hangs can occur if an OS is loaded
      and the network devices are not Shutdown() and Stopped().
  If ResetMCastFilter is TRUE, then the multicast receive filter list on the
  network interface will be reset to the default multicast receive filter list.
  If ResetMCastFilter is FALSE, and this network interface allows the multicast
  receive filter list to be modified, then the MCastFilterCnt and MCastFilter
  are used to update the current multicast receive filter list. The modified
  receive filter list settings can be found in the MCastFilter field of
  EFI_SIMPLE_NETWORK_MODE. If the network interface does not allow the multicast
  receive filter list to be modified, then EFI_INVALID_PARAMETER will be returned.
  If the driver has not been initialized, EFI_DEVICE_ERROR will be returned.
  If the receive filter mask and multicast receive filter list have been
  successfully updated on the network interface, EFI_SUCCESS will be returned.

   <at> param This                    A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.
   <at> param Enable                  A bit mask of receive filters to enable on the network
                                      interface.
   <at> param Disable                 A bit mask of receive filters to disable on the network
                                      interface. For backward compatibility with EFI 1.1
                                      platforms, the EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST bit
                                      must be set when the ResetMCastFilter parameter is TRUE.
   <at> param ResetMCastFilter        Set to TRUE to reset the contents of the multicast
                                      receive filters on the network interface to their
                                      default values.
   <at> param MCastFilterCnt          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.
   <at> 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.

   <at> retval EFI_SUCCESS            The multicast receive filter list was updated.
   <at> retval EFI_NOT_STARTED        The network interface has not been started.
   <at> retval EFI_INVALID_PARAMETER  One or more of the following conditions is TRUE:
                                      * This is NULL
                                      * There are bits set in Enable that are not set
                                        in Snp->Mode->ReceiveFilterMask
                                      * There are bits set in Disable that are not set
                                        in Snp->Mode->ReceiveFilterMask
                                      * Multicast is being enabled (the
                                        EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST bit is
                                        set in Enable, it is not set in Disable, and
                                        ResetMCastFilter is FALSE) and MCastFilterCount
                                        is zero
                                      * Multicast is being enabled and MCastFilterCount
                                        is greater than Snp->Mode->MaxMCastFilterCount
                                      * Multicast is being enabled and MCastFilter is NULL
                                      * Multicast is being enabled and one or more of
                                        the addresses in the MCastFilter list are not
                                        valid multicast MAC addresses
   <at> retval EFI_DEVICE_ERROR       One or more of the following conditions is TRUE:
                                      * The network interface has been started but has
                                        not been initialized
                                      * An unexpected error was returned by the
                                        underlying network driver or device
   <at> retval EFI_UNSUPPORTED        This function is not supported by the network
                                      interface.

**/
EFI_STATUS
EFIAPI
SnpReceiveFilters (
    IN EFI_SIMPLE_NETWORK_PROTOCOL *This,
    IN UINT32                      Enable,
    IN UINT32                      Disable,
    IN BOOLEAN                     ResetMCastFilter,
    IN UINTN                       MCastFilterCnt,  OPTIONAL
    IN EFI_MAC_ADDRESS             *MCastFilter     OPTIONAL
    )
{
  EFI_STATUS    Status;
  YUKON_DRIVER    *YukonDriver;
  EFI_TPL       OldTpl;
  UINT32        newReceiveFilter;
  struct msk_softc *ScData;

  DEBUG ((EFI_D_NET, "Marvell Yukon: SnpReceiveFilters()\n"));
  if (This == NULL) {
    DEBUG ((EFI_D_ERROR, "Marvell Yukon: SnpReceiveFilters() failed with Status = %r\n", EFI_INVALID_PARAMETER));
    return EFI_INVALID_PARAMETER;
  }

  YukonDriver = YUKON_DEV_FROM_THIS_SNP (This);

  Status = MarvellYukonGetControllerData (YukonDriver->Controller, &ScData);
  if (EFI_ERROR (Status)) {
    return Status;
  }

  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);

  switch (YukonDriver->SnpMode.State) {
    case EfiSimpleNetworkInitialized:
      break;

    case EfiSimpleNetworkStopped:
      Status = EFI_NOT_STARTED;
      goto ON_ERROR_RESTORE_TPL;

    default:
      Status = EFI_DEVICE_ERROR;
      goto ON_ERROR_RESTORE_TPL;
  }
  //
  // check if we are asked to enable or disable something that the NIC
  // does not even support!
  //
  newReceiveFilter = (YukonDriver->SnpMode.ReceiveFilterSetting | Enable) & ~Disable;
  if ((newReceiveFilter & ~YukonDriver->SnpMode.ReceiveFilterMask) != 0) {
    DEBUG ((DEBUG_NET,
           "Marvell Yukon: SnpReceiveFilters() NIC does not support Enable = 0x%x, Disable = 0x%x\n", Enable, Disable));
    Status = EFI_INVALID_PARAMETER;
    goto ON_ERROR_RESTORE_TPL;
  }

  if (ResetMCastFilter) {
    newReceiveFilter &= ~(EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST & YukonDriver->SnpMode.ReceiveFilterMask);
    MCastFilterCnt = 0;
    MCastFilter    = NULL;
  } else {
    if (MCastFilterCnt != 0) {
      if ((MCastFilterCnt > YukonDriver->SnpMode.MaxMCastFilterCount) ||
          (MCastFilter == NULL)) {

        DEBUG ((DEBUG_NET,
               "Marvell Yukon: SnpReceiveFilters() NIC does not support MCastFilterCnt = %d (Max = %d)\n",
               MCastFilterCnt, YukonDriver->SnpMode.MaxMCastFilterCount));
        Status = EFI_INVALID_PARAMETER;
        goto ON_ERROR_RESTORE_TPL;
      }
    }
  }

  if (newReceiveFilter == YukonDriver->SnpMode.ReceiveFilterSetting && !ResetMCastFilter && MCastFilterCnt == 0) {
    Status = EFI_SUCCESS;
    goto ON_EXIT;
  }

  if ((Enable & EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST) != 0 && MCastFilterCnt == 0) {
    Status = EFI_INVALID_PARAMETER;
    goto ON_ERROR_RESTORE_TPL;
  }

  YukonDriver->SnpMode.ReceiveFilterSetting = newReceiveFilter;
  mskc_rxfilter (ScData->msk_if[YukonDriver->Port], YukonDriver->SnpMode.ReceiveFilterSetting,
                 MCastFilterCnt, MCastFilter);

  Status = EFI_SUCCESS;
  goto ON_EXIT;

ON_ERROR_RESTORE_TPL:
  DEBUG ((EFI_D_ERROR, "Marvell Yukon: SnpReceiveFilters() failed with Status = %r\n", Status));

ON_EXIT:
  gBS->RestoreTPL (OldTpl);
  return Status;
}

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

  This function resets a network adapter and reinitializes it with the parameters
  that were provided in the previous call to Initialize(). The transmit and
  receive queues are emptied and all pending interrupts are cleared.
  Receive filters, the station address, the statistics, and the multicast-IP-to-HW
  MAC addresses are not reset by this call. If the network interface was
  successfully reset, then EFI_SUCCESS will be returned. If the driver has not
  been initialized, EFI_DEVICE_ERROR will be returned.

   <at> param This                    A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.
   <at> param ExtendedVerification    Indicates that the driver may perform a more
                                      exhaustive verification operation of the device
                                      during reset.

   <at> retval EFI_SUCCESS            The network interface was reset.
   <at> retval EFI_NOT_STARTED        The network interface has not been started.
   <at> retval EFI_INVALID_PARAMETER  One or more of the parameters has an unsupported value.
   <at> retval EFI_DEVICE_ERROR       The command could not be sent to the network interface.
   <at> retval EFI_UNSUPPORTED        This function is not supported by the network interface.

**/
EFI_STATUS
EFIAPI
SnpReset (
    IN EFI_SIMPLE_NETWORK_PROTOCOL *This,
    IN BOOLEAN                     ExtendedVerification
    )
{
  EFI_STATUS    Status;
  YUKON_DRIVER    *YukonDriver;
  EFI_TPL       OldTpl;

  DEBUG ((EFI_D_NET, "Marvell Yukon: SnpReset()\n"));
  //
  // Resolve Warning 4 unreferenced parameter problem
  //
  ExtendedVerification = 0;
  DEBUG ((EFI_D_WARN, "Marvell Yukon: ExtendedVerification = %d is not implemented!\n", ExtendedVerification));

  if (This == NULL) {
    DEBUG ((EFI_D_ERROR, "Marvell Yukon: SnpReset() failed with Status = %r\n", EFI_INVALID_PARAMETER));
    return EFI_INVALID_PARAMETER;
  }

  YukonDriver = YUKON_DEV_FROM_THIS_SNP (This);

  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);

  switch (YukonDriver->SnpMode.State) {
    case EfiSimpleNetworkInitialized:
      break;

    case EfiSimpleNetworkStopped:
      Status = EFI_NOT_STARTED;
      goto ON_ERROR_RESTORE_TPL;

    default:
      Status = EFI_DEVICE_ERROR;
      goto ON_ERROR_RESTORE_TPL;
  }

  // Always succeeds
  Status = EFI_SUCCESS;
  goto ON_EXIT;

ON_ERROR_RESTORE_TPL:
  DEBUG ((EFI_D_ERROR, "Marvell Yukon: SnpReset() failed with Status = %r\n", Status));

ON_EXIT:
  gBS->RestoreTPL (OldTpl);
  return Status;
}

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

  This function releases the memory buffers assigned in the Initialize() call.
  Pending transmits and receives are lost, and interrupts are cleared and disabled.
  After this call, only the Initialize() and Stop() calls may be used. If the
  network interface was successfully shutdown, then EFI_SUCCESS will be returned.
  If the driver has not been initialized, EFI_DEVICE_ERROR will be returned.

   <at> param  This                   A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.

   <at> retval EFI_SUCCESS            The network interface was shutdown.
   <at> retval EFI_NOT_STARTED        The network interface has not been started.
   <at> retval EFI_INVALID_PARAMETER  This parameter was NULL or did not point to a valid
                                      EFI_SIMPLE_NETWORK_PROTOCOL structure.
   <at> retval EFI_DEVICE_ERROR       The command could not be sent to the network interface.

**/
EFI_STATUS
EFIAPI
SnpShutdown (
    IN EFI_SIMPLE_NETWORK_PROTOCOL *This
    )
{
  EFI_STATUS    Status;
  YUKON_DRIVER    *YukonDriver;
  EFI_TPL       OldTpl;
  struct msk_softc *ScData;

  DEBUG ((EFI_D_NET, "Marvell Yukon: SnpShutdown()\n"));
  //
  // Get pointer to SNP driver instance for *This.
  //
  if (This == NULL) {
    DEBUG ((EFI_D_ERROR, "Marvell Yukon: SnpShutdown() failed with Status = %r\n", EFI_INVALID_PARAMETER));
    return EFI_INVALID_PARAMETER;
  }

  YukonDriver = YUKON_DEV_FROM_THIS_SNP (This);

  Status = MarvellYukonGetControllerData (YukonDriver->Controller, &ScData);
  if (EFI_ERROR (Status)) {
    return Status;
  }

  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);

  //
  // Return error if the SNP is not initialized.
  //
  switch (YukonDriver->SnpMode.State) {
    case EfiSimpleNetworkInitialized:
      break;

    case EfiSimpleNetworkStopped:
      Status = EFI_NOT_STARTED;
      goto ON_ERROR_RESTORE_TPL;

    default:
      Status = EFI_DEVICE_ERROR;
      goto ON_ERROR_RESTORE_TPL;
  }

  mskc_stop_if (ScData->msk_if[YukonDriver->Port]);
  YukonDriver->SnpMode.State = EfiSimpleNetworkStarted;
  Status = EFI_SUCCESS;

  YukonDriver->SnpMode.State                 = EfiSimpleNetworkStarted;
  YukonDriver->SnpMode.ReceiveFilterSetting  = 0;

  YukonDriver->SnpMode.MCastFilterCount      = 0;
  YukonDriver->SnpMode.ReceiveFilterSetting  = 0;
  gBS->SetMem (YukonDriver->SnpMode.MCastFilter, sizeof YukonDriver->SnpMode.MCastFilter, 0);
  gBS->CopyMem (
        &YukonDriver->SnpMode.CurrentAddress,
        &YukonDriver->SnpMode.PermanentAddress,
        sizeof (EFI_MAC_ADDRESS)
        );

  goto ON_EXIT;

ON_ERROR_RESTORE_TPL:
  DEBUG ((EFI_D_ERROR, "Marvell Yukon: SnpShutdown() failed with Status = %r\n", Status));

ON_EXIT:
  gBS->RestoreTPL (OldTpl);
  return Status;
}

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

  This function starts a network interface. If the network interface successfully
  starts, then EFI_SUCCESS will be returned.

   <at> param  This                   A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.

   <at> retval EFI_SUCCESS            The network interface was started.
   <at> retval EFI_ALREADY_STARTED    The network interface is already in the started state.
   <at> retval EFI_INVALID_PARAMETER  This parameter was NULL or did not point to a valid
                                      EFI_SIMPLE_NETWORK_PROTOCOL structure.
   <at> retval EFI_DEVICE_ERROR       The command could not be sent to the network interface.
   <at> retval EFI_UNSUPPORTED        This function is not supported by the network interface.

**/
EFI_STATUS
EFIAPI
SnpStart (
    IN EFI_SIMPLE_NETWORK_PROTOCOL *This
    )
{
  YUKON_DRIVER    *YukonDriver;
  EFI_TPL       OldTpl;
  EFI_STATUS    Status;
  struct msk_softc  *ScData;

  DEBUG ((EFI_D_NET, "Marvell Yukon: SnpStart()\n"));
  if (This == NULL) {
    DEBUG ((EFI_D_ERROR, "Marvell Yukon: SnpStart() failed with Status = %r\n", EFI_INVALID_PARAMETER));
    return EFI_INVALID_PARAMETER;
  }

  YukonDriver = YUKON_DEV_FROM_THIS_SNP (This);

  Status = MarvellYukonGetControllerData (YukonDriver->Controller, &ScData);
  if (EFI_ERROR (Status)) {
    return Status;
  }

  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);

  switch (YukonDriver->SnpMode.State) {
    case EfiSimpleNetworkStopped:
      break;

    case EfiSimpleNetworkStarted:
    case EfiSimpleNetworkInitialized:
      Status = EFI_ALREADY_STARTED;
      goto ON_EXIT;

    default:
      Status = EFI_DEVICE_ERROR;
      goto ON_ERROR_RESTORE_TPL;
  }

  Status = mskc_attach_if (ScData->msk_if[YukonDriver->Port], YukonDriver->Port);

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

  YukonDriver->SnpMode.State = EfiSimpleNetworkStarted;
  gBS->CopyMem (&YukonDriver->SnpMode.CurrentAddress, &YukonDriver->SnpMode.PermanentAddress, sizeof (EFI_MAC_ADDRESS));
  YukonDriver->SnpMode.MCastFilterCount = 0;
  goto ON_EXIT;

ON_ERROR_RESTORE_TPL:
  DEBUG ((EFI_D_ERROR, "Marvell Yukon: SnpStart() failed with Status = %r\n", Status));

ON_EXIT:
  gBS->RestoreTPL (OldTpl);
  return Status;
}

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

  This function modifies or resets the current station address of a network
  interface, if supported. If Reset is TRUE, then the current station address is
  set to the network interface's permanent address. If Reset is FALSE, and the
  network interface allows its station address to be modified, then the current
  station address is changed to the address specified by New. If the network
  interface does not allow its station address to be modified, then
  EFI_INVALID_PARAMETER will be returned. If the station address is successfully
  updated on the network interface, EFI_SUCCESS will be returned. If the driver
  has not been initialized, EFI_DEVICE_ERROR will be returned.

   <at> param This                    A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.
   <at> param Reset                   Flag used to reset the station address to the network interface's
                                      permanent address.
   <at> param New                     New station address to be used for the network interface.


   <at> retval EFI_SUCCESS            The network interface's station address was updated.
   <at> retval EFI_NOT_STARTED        The Simple Network Protocol interface has not been
                                                                 started by calling Start().
   <at> retval EFI_INVALID_PARAMETER  The New station address was not accepted by the NIC.
   <at> retval EFI_INVALID_PARAMETER  Reset is FALSE and New is NULL.
   <at> retval EFI_DEVICE_ERROR       The Simple Network Protocol interface has not
                                      been initialized by calling Initialize().
   <at> retval EFI_DEVICE_ERROR       An error occurred attempting to set the new
                                      station address.
   <at> retval EFI_UNSUPPORTED        The NIC does not support changing the network
                                      interface's station address.

**/
EFI_STATUS
EFIAPI
SnpStationAddress (
    IN EFI_SIMPLE_NETWORK_PROTOCOL *This,
    IN BOOLEAN                     Reset,
    IN EFI_MAC_ADDRESS             *New OPTIONAL
    )
{
  YUKON_DRIVER    *YukonDriver;
  EFI_TPL       OldTpl;
  EFI_STATUS    Status;

  DEBUG ((EFI_D_NET, "Marvell Yukon: SnpStationAddress()\n"));
  //
  // Check for invalid parameter combinations.
  //
  if ((This == NULL) || (!Reset && (New == NULL))) {
    return EFI_INVALID_PARAMETER;
  }

  YukonDriver = YUKON_DEV_FROM_THIS_SNP (This);

  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);

  //
  // Return error if the SNP is not initialized.
  //
  switch (YukonDriver->SnpMode.State) {
    case EfiSimpleNetworkInitialized:
      break;

    case EfiSimpleNetworkStopped:
      Status = EFI_NOT_STARTED;
      goto ON_EXIT;

    default:
      Status = EFI_DEVICE_ERROR;
      goto ON_EXIT;
  }

  Status = EFI_UNSUPPORTED;

ON_EXIT:
  gBS->RestoreTPL (OldTpl);

  return Status;
}

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

  This function resets or collects the statistics on a network interface. If the
  size of the statistics table specified by StatisticsSize is not big enough for
  all the statistics that are collected by the network interface, then a partial
  buffer of statistics is returned in StatisticsTable, StatisticsSize is set to
  the size required to collect all the available statistics, and
  EFI_BUFFER_TOO_SMALL is returned.
  If StatisticsSize is big enough for all the statistics, then StatisticsTable
  will be filled, StatisticsSize will be set to the size of the returned
  StatisticsTable structure, and EFI_SUCCESS is returned.
  If the driver has not been initialized, EFI_DEVICE_ERROR will be returned.
  If Reset is FALSE, and both StatisticsSize and StatisticsTable are NULL, then
  no operations will be performed, and EFI_SUCCESS will be returned.
  If Reset is TRUE, then all of the supported statistics counters on this network
  interface will be reset to zero.

   <at> param This                    A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.
   <at> param Reset                   Set to TRUE to reset the statistics for the network interface.
   <at> param StatisticsSize          On input the size, in bytes, of StatisticsTable. On output
                                      the size, in bytes, of the resulting table of statistics.
   <at> param StatisticsTable         A pointer to the EFI_NETWORK_STATISTICS structure that
                                      contains the statistics. Type EFI_NETWORK_STATISTICS is
                                      defined in "Related Definitions" below.

   <at> retval EFI_SUCCESS            The requested operation succeeded.
   <at> retval EFI_NOT_STARTED        The Simple Network Protocol interface has not been
                                      started by calling Start().
   <at> retval EFI_BUFFER_TOO_SMALL   StatisticsSize is not NULL and StatisticsTable is
                                      NULL. The current buffer size that is needed to
                                      hold all the statistics is returned in StatisticsSize.
   <at> retval EFI_BUFFER_TOO_SMALL   StatisticsSize is not NULL and StatisticsTable is
                                      not NULL. The current buffer size that is needed
                                      to hold all the statistics is returned in
                                      StatisticsSize. A partial set of statistics is
                                      returned in StatisticsTable.
   <at> retval EFI_INVALID_PARAMETER  StatisticsSize is NULL and StatisticsTable is not
                                      NULL.
   <at> retval EFI_DEVICE_ERROR       The Simple Network Protocol interface has not
                                      been initialized by calling Initialize().
   <at> retval EFI_DEVICE_ERROR       An error was encountered collecting statistics
                                      from the NIC.
   <at> retval EFI_UNSUPPORTED        The NIC does not support collecting statistics
                                      from the network interface.

**/
EFI_STATUS
EFIAPI
SnpStatistics (
    IN EFI_SIMPLE_NETWORK_PROTOCOL *This,
    IN BOOLEAN                     Reset,
    IN OUT UINTN                   *StatisticsSize, OPTIONAL
    IN OUT EFI_NETWORK_STATISTICS  *StatisticsTable OPTIONAL
    )
{
  EFI_STATUS        Status;
  YUKON_DRIVER        *YukonDriver;
  EFI_TPL           OldTpl;

  DEBUG ((EFI_D_NET, "Marvell Yukon: SnpStatistics()\n"));
  //
  // Get pointer to SNP driver instance for *This.
  //
  if (This == NULL) {
    return EFI_INVALID_PARAMETER;
  }

  Status = EFI_SUCCESS;
  YukonDriver = YUKON_DEV_FROM_THIS_SNP (This);

  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);

  //
  // Return error if the SNP is not initialized.
  //
  switch (YukonDriver->SnpMode.State) {
    case EfiSimpleNetworkInitialized:
      break;

    case EfiSimpleNetworkStopped:
      Status = EFI_NOT_STARTED;
      goto ON_EXIT;

    case EfiSimpleNetworkStarted:
    default:
      Status = EFI_DEVICE_ERROR;
      goto ON_EXIT;
  }

  //
  // Error Checking
  //

  if (!Reset && (StatisticsSize == NULL) && (StatisticsTable == NULL)) {
    Status = EFI_SUCCESS;
    goto ON_EXIT;
  }

  if ((StatisticsSize == NULL) && (StatisticsTable != NULL)) {
    Status = EFI_INVALID_PARAMETER;
    goto ON_EXIT;
  }

  if ((StatisticsSize != NULL) && (StatisticsTable == NULL)) {
    *StatisticsSize = sizeof (EFI_NETWORK_STATISTICS);
    Status = EFI_BUFFER_TOO_SMALL;
    goto ON_EXIT;
  }

  if ((StatisticsSize != NULL) && (StatisticsTable != NULL)) {
    if (*StatisticsSize < sizeof (EFI_NETWORK_STATISTICS)) {
      if (*StatisticsSize == 0) {
        Status = EFI_BUFFER_TOO_SMALL;
        // Note: From here on, the Status value must be preserved.
      } else {
        // FixMe: Return partial statistics for the available size and also set
        //        Status = EFI_BUFFER_TOO_SMALL;
        //        but for now it is unsupported.
        Status = EFI_UNSUPPORTED;
        // Note: From here on, the Status value must be preserved.
      }
      *StatisticsSize = sizeof (EFI_NETWORK_STATISTICS);
    } else {
      // FixMe: Return full statistics and also set
      //        Status = EFI_SUCCESS;
      //        but for now it is unsupported.
      Status = EFI_UNSUPPORTED;
    }
  }

  if (Reset == TRUE) {
    // FixMe: Reset all statistics;

    // Preserve any previous errors else return success.
    if (!EFI_ERROR (Status)) {
      // FixMe: Should return success
      //        Status = EFI_SUCCESS;
      //        but for now it is unsupported.
      Status = EFI_UNSUPPORTED;
    }
  }

ON_EXIT:
  gBS->RestoreTPL (OldTpl);

  return Status;
}

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

  This function stops a network interface. This call is only valid if the network
  interface is in the started state. If the network interface was successfully
  stopped, then EFI_SUCCESS will be returned.

   <at> param  This                   A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL
                                                                  instance.


   <at> retval EFI_SUCCESS            The network interface was stopped.
   <at> retval EFI_NOT_STARTED        The network interface has not been started.
   <at> retval EFI_INVALID_PARAMETER  This parameter was NULL or did not point to a
                                      valid EFI_SIMPLE_NETWORK_PROTOCOL structure.
   <at> retval EFI_DEVICE_ERROR       The command could not be sent to the network
                                      interface.
   <at> retval EFI_UNSUPPORTED        This function is not supported by the network
                                      interface.

**/
EFI_STATUS
EFIAPI
SnpStop (
    IN EFI_SIMPLE_NETWORK_PROTOCOL *This
    )
{
  EFI_STATUS    Status;
  YUKON_DRIVER    *YukonDriver;
  EFI_TPL       OldTpl;
  struct msk_softc *ScData;

  DEBUG ((EFI_D_NET, "Marvell Yukon: SnpStop()\n"));
  if (This == NULL) {
    DEBUG ((EFI_D_ERROR, "Marvell Yukon: SnpStop() failed with Status = %r\n", EFI_INVALID_PARAMETER));
    return EFI_INVALID_PARAMETER;
  }

  YukonDriver = YUKON_DEV_FROM_THIS_SNP (This);

  Status = MarvellYukonGetControllerData (YukonDriver->Controller, &ScData);
  if (EFI_ERROR (Status)) {
    return Status;
  }

  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);

  switch (YukonDriver->SnpMode.State) {
    case EfiSimpleNetworkStarted:
      break;

    case EfiSimpleNetworkStopped:
      Status = EFI_NOT_STARTED;
      goto ON_ERROR_RESTORE_TPL;

    case EfiSimpleNetworkInitialized:
    default:
      Status = EFI_DEVICE_ERROR;
      goto ON_ERROR_RESTORE_TPL;
  }

  mskc_detach_if (ScData->msk_if[YukonDriver->Port]);
  YukonDriver->SnpMode.State = EfiSimpleNetworkStopped;
  gBS->SetMem (&YukonDriver->SnpMode.CurrentAddress, sizeof (EFI_MAC_ADDRESS), 0);
  Status = EFI_SUCCESS;
  goto ON_EXIT;

ON_ERROR_RESTORE_TPL:
  DEBUG ((EFI_D_ERROR, "Marvell Yukon: SnpStop() failed with Status = %r\n", Status));

ON_EXIT:
  gBS->RestoreTPL (OldTpl);
  return Status;
}

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

  This function places the packet specified by Header and Buffer on the transmit
  queue. If HeaderSize is nonzero and HeaderSize is not equal to
  This->SnpMode->MediaHeaderSize, then EFI_INVALID_PARAMETER will be returned. If
  BufferSize is less than This->SnpMode->MediaHeaderSize, then EFI_BUFFER_TOO_SMALL
  will be returned. If Buffer is NULL, then EFI_INVALID_PARAMETER will be
  returned. If HeaderSize is nonzero and DestAddr or Protocol is NULL, then
  EFI_INVALID_PARAMETER will be returned. If the transmit engine of the network
  interface is busy, then EFI_NOT_READY will be returned. If this packet can be
  accepted by the transmit engine of the network interface, the packet contents
  specified by Buffer will be placed on the transmit queue of the network
  interface, and EFI_SUCCESS will be returned. GetStatus() can be used to
  determine when the packet has actually been transmitted. The contents of the
  Buffer must not be modified until the packet has actually been transmitted.
  The Transmit() function performs nonblocking I/O. A caller who wants to perform
  blocking I/O, should call Transmit(), and then GetStatus() until the
  transmitted buffer shows up in the recycled transmit buffer.
  If the driver has not been initialized, EFI_DEVICE_ERROR will be returned.

   <at> param This                    A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.
   <at> param HeaderSize              The size, in bytes, of the media header to be filled in by the
                                      Transmit() function. If HeaderSize is nonzero, then it must
                                      be equal to This->SnpMode->MediaHeaderSize and the DestAddr and
                                      Protocol parameters must not be NULL.
   <at> param BufferSize              The size, in bytes, of the entire packet (media header and
                                      data) to be transmitted through the network interface.
   <at> 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 nonzero, then the media
                                      header will be filled in by the Transmit() function.
   <at> param SrcAddr                 The source HW MAC address. If HeaderSize is zero, then this
                                      parameter is ignored. If HeaderSize is nonzero and SrcAddr
                                      is NULL, then This->SnpMode->CurrentAddress is used for the
                                      source HW MAC address.
   <at> param DestAddr                The destination HW MAC address. If HeaderSize is zero, then
                                      this parameter is ignored.
   <at> 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.

   <at> retval EFI_SUCCESS            The packet was placed on the transmit queue.
   <at> retval EFI_NOT_STARTED        The network interface has not been started.
   <at> retval EFI_NOT_READY          The network interface is too busy to accept this
                                      transmit request.
   <at> retval EFI_BUFFER_TOO_SMALL   The BufferSize parameter is too small.
   <at> retval EFI_INVALID_PARAMETER  One or more of the parameters has an unsupported
                                      value.
   <at> retval EFI_DEVICE_ERROR       The command could not be sent to the network interface.
   <at> retval EFI_UNSUPPORTED        This function is not supported by the network interface.

**/
EFI_STATUS
EFIAPI
SnpTransmit (
    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
    )
{
  EFI_STATUS    Status;
  YUKON_DRIVER    *YukonDriver;
  EFI_TPL       OldTpl;
  ETHER_HEAD    *Frame;
  UINT16        ProtocolNet;
  struct msk_softc  *ScData;

  DEBUG ((EFI_D_NET, "Marvell Yukon: SnpTransmit()\n"));
  if (This == NULL) {
    return EFI_INVALID_PARAMETER;
  }

  YukonDriver = YUKON_DEV_FROM_THIS_SNP (This);

  if (YukonDriver == NULL) {
    return EFI_DEVICE_ERROR;
  }

  Status = MarvellYukonGetControllerData (YukonDriver->Controller, &ScData);
  if (EFI_ERROR (Status)) {
    return Status;
  }

  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);

  switch (YukonDriver->SnpMode.State) {
    case EfiSimpleNetworkInitialized:
      break;

    case EfiSimpleNetworkStopped:
      Status = EFI_NOT_STARTED;
      goto ON_EXIT;

    default:
      Status = EFI_DEVICE_ERROR;
      goto ON_EXIT;
  }

  if (Buffer == NULL) {
    Status = EFI_INVALID_PARAMETER;
    goto ON_EXIT;
  }

  if (BufferSize < YukonDriver->SnpMode.MediaHeaderSize) {
    Status = EFI_BUFFER_TOO_SMALL;
    goto ON_EXIT;
  }

  //
  // Construct the frame header if not already presented
  //
  if (HeaderSize != 0) {
    if (HeaderSize != YukonDriver->SnpMode.MediaHeaderSize || DestAddr == 0 || Protocol == 0) {
      Status = EFI_INVALID_PARAMETER;
      goto ON_EXIT;
    }
    Frame       = (ETHER_HEAD*)Buffer;
    ProtocolNet = NTOHS (*Protocol);

    gBS->CopyMem (Frame->SrcMac,     SrcAddr,      NET_ETHER_ADDR_LEN);
    gBS->CopyMem (Frame->DstMac,     DestAddr,     NET_ETHER_ADDR_LEN);
    gBS->CopyMem (&Frame->EtherType, &ProtocolNet, sizeof (UINT16));
  }

  Status = mskc_transmit (ScData->msk_if[YukonDriver->Port], BufferSize, Buffer);

ON_EXIT:
  gBS->RestoreTPL (OldTpl);

  return Status;
}