1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
|
/****************************************************************************
* arch/arm/src/sama5/sam_emacb.c
* 10/100 Base-T Ethernet driver for the SAMA5D4.
*
* The SAMA5D3 and SAMA5D4 EMAC implementations differ in register naming
* and in register layout but are functionally equivalent. Here they are
* distinguished as 'A' and 'B'. For now, the 'A' and 'B' drivers are kept
* separate (mostly because the 'B' driver needs to support two EMAC blocks.
* But the 'B' driver should replace the 'A' driver someday.
*
* Copyright (C) 2014 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* This logic derives from the SAM4E Ethernet driver which, in turn, derived
* from the SAMA5D3 Ethernet Type A driver.
*
* Copyright (C) 2013 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* Which used Atmel NoOS sample code for reference (only). That Atmel
* sample code has a BSD compatible license that requires this copyright
* notice:
*
* Copyright (c) 2012, Atmel Corporation
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the names NuttX nor Atmel nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
****************************************************************************/
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#if defined(CONFIG_DEBUG) && defined(CONFIG_SAMA5_EMACB_DEBUG)
/* Force debug output (from this file only) */
# undef CONFIG_DEBUG_NET
# define CONFIG_DEBUG_NET 1
#endif
#include <stdint.h>
#include <stdbool.h>
#include <time.h>
#include <string.h>
#include <debug.h>
#include <wdog.h>
#include <queue.h>
#include <errno.h>
#include <arpa/inet.h>
#include <nuttx/irq.h>
#include <nuttx/arch.h>
#include <nuttx/kmalloc.h>
#include <nuttx/net/mii.h>
#include <nuttx/net/arp.h>
#include <nuttx/net/netdev.h>
#include <nuttx/net/phy.h>
#include "up_arch.h"
#include "up_internal.h"
#include "cache.h"
#include "chip.h"
#include "chip/sam_pinmap.h"
#include "sam_pio.h"
#include "sam_periphclks.h"
#include "sam_memories.h"
#include "sam_ethernet.h"
#include <arch/board/board.h>
#if defined(CONFIG_NET) && defined(CONFIG_SAMA5_EMACB)
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
/* EMAC0 Configuration ******************************************************/
#ifdef CONFIG_SAMA5_EMAC0
/* Number of buffers for RX */
# ifndef CONFIG_SAMA5_EMAC0_NRXBUFFERS
# define CONFIG_SAMA5_EMAC0_NRXBUFFERS 16
# endif
/* Number of buffers for TX */
# ifndef CONFIG_SAMA5_EMAC0_NTXBUFFERS
# define CONFIG_SAMA5_EMAC0_NTXBUFFERS 8
# endif
# ifndef CONFIG_SAMA5_EMAC0_PHYADDR
# error "CONFIG_SAMA5_EMAC0_PHYADDR must be defined in the NuttX configuration"
# endif
# if !defined(CONFIG_SAMA5_EMAC0_MII) && !defined(CONFIG_SAMA5_EMAC0_RMII)
# warning "Neither CONFIG_SAMA5_EMAC0_MII nor CONFIG_SAMA5_EMAC0_RMII defined"
# endif
# if defined(CONFIG_SAMA5_EMAC0_MII) && defined(CONFIG_SAMA5_EMAC0_RMII)
# error "Both CONFIG_SAMA5_EMAC0_MII and CONFIG_SAMA5_EMAC0_RMII defined"
# endif
# ifndef CONFIG_SAMA5_EMAC0_PHYSR
# error "CONFIG_SAMA5_EMAC0_PHYSR must be defined in the NuttX configuration"
# endif
# ifdef CONFIG_SAMA5_EMAC0_AUTONEG
# ifdef CONFIG_SAMA5_EMAC0_PHYSR_ALTCONFIG
# ifndef CONFIG_SAMA5_EMAC0_PHYSR_ALTMODE
# error "CONFIG_SAMA5_EMAC0_PHYSR_ALTMODE must be defined in the NuttX configuration"
# endif
# ifndef CONFIG_SAMA5_EMAC0_PHYSR_10HD
# error "CONFIG_SAMA5_EMAC0_PHYSR_10HD must be defined in the NuttX configuration"
# endif
# ifndef CONFIG_SAMA5_EMAC0_PHYSR_100HD
# error "CONFIG_SAMA5_EMAC0_PHYSR_100HD must be defined in the NuttX configuration"
# endif
# ifndef CONFIG_SAMA5_EMAC0_PHYSR_10FD
# error "CONFIG_SAMA5_EMAC0_PHYSR_10FD must be defined in the NuttX configuration"
# endif
# ifndef CONFIG_SAMA5_EMAC0_PHYSR_100FD
# error "CONFIG_SAMA5_EMAC0_PHYSR_100FD must be defined in the NuttX configuration"
# endif
# else
# ifndef CONFIG_SAMA5_EMAC0_PHYSR_SPEED
# error "CONFIG_SAMA5_EMAC0_PHYSR_SPEED must be defined in the NuttX configuration"
# endif
# ifndef CONFIG_SAMA5_EMAC0_PHYSR_100MBPS
# error "CONFIG_SAMA5_EMAC0_PHYSR_100MBPS must be defined in the NuttX configuration"
# endif
# ifndef CONFIG_SAMA5_EMAC0_PHYSR_MODE
# error "CONFIG_SAMA5_EMAC0_PHYSR_MODE must be defined in the NuttX configuration"
# endif
# ifndef CONFIG_SAMA5_EMAC0_PHYSR_FULLDUPLEX
# error "CONFIG_SAMA5_EMAC0_PHYSR_FULLDUPLEX must be defined in the NuttX configuration"
# endif
# endif
# endif
/* PHY definitions */
# if defined(SAMA5_EMAC0_PHY_DM9161)
# define EMAC0_MII_OUI_MSB 0x0181
# define EMAC0_MII_OUI_LSB 0x2e
# elif defined(SAMA5_EMAC0_PHY_LAN8700)
# define EMAC0_MII_OUI_MSB 0x0007
# define EMAC0_MII_OUI_LSB 0x30
# elif defined(SAMA5_EMAC0_PHY_KSZ8051)
# define EMAC0_MII_OUI_MSB 0x0022
# define EMAC0_MII_OUI_LSB 0x05
# elif defined(SAMA5_EMAC0_PHY_KSZ8081)
# define EMAC0_MII_OUI_MSB 0x0022
# define EMAC0_MII_OUI_LSB 0x05
# else
# error EMAC PHY unrecognized
# endif
#endif /* CONFIG_SAMA5_EMAC0 */
/* EMAC1 Configuration ******************************************************/
#ifdef CONFIG_SAMA5_EMAC1
/* Number of buffers for RX */
# ifndef CONFIG_SAMA5_EMAC1_NRXBUFFERS
# define CONFIG_SAMA5_EMAC1_NRXBUFFERS 16
# endif
/* Number of buffers for TX */
# ifndef CONFIG_SAMA5_EMAC1_NTXBUFFERS
# define CONFIG_SAMA5_EMAC1_NTXBUFFERS 8
# endif
# ifndef CONFIG_SAMA5_EMAC1_PHYADDR
# error "CONFIG_SAMA5_EMAC1_PHYADDR must be defined in the NuttX configuration"
# endif
# if !defined(CONFIG_SAMA5_EMAC1_MII) && !defined(CONFIG_SAMA5_EMAC1_RMII)
# warning "Neither CONFIG_SAMA5_EMAC1_MII nor CONFIG_SAMA5_EMAC1_RMII defined"
# endif
# if defined(CONFIG_SAMA5_EMAC1_MII) && defined(CONFIG_SAMA5_EMAC1_RMII)
# error "Both CONFIG_SAMA5_EMAC1_MII and CONFIG_SAMA5_EMAC1_RMII defined"
# endif
# ifndef CONFIG_SAMA5_EMAC1_PHYSR
# error "CONFIG_SAMA5_EMAC1_PHYSR must be defined in the NuttX configuration"
# endif
# ifdef CONFIG_SAMA5_EMAC1_AUTONEG
# ifdef CONFIG_SAMA5_EMAC1_PHYSR_ALTCONFIG
# ifndef CONFIG_SAMA5_EMAC1_PHYSR_ALTMODE
# error "CONFIG_SAMA5_EMAC1_PHYSR_ALTMODE must be defined in the NuttX configuration"
# endif
# ifndef CONFIG_SAMA5_EMAC1_PHYSR_10HD
# error "CONFIG_SAMA5_EMAC1_PHYSR_10HD must be defined in the NuttX configuration"
# endif
# ifndef CONFIG_SAMA5_EMAC1_PHYSR_100HD
# error "CONFIG_SAMA5_EMAC1_PHYSR_100HD must be defined in the NuttX configuration"
# endif
# ifndef CONFIG_SAMA5_EMAC1_PHYSR_10FD
# error "CONFIG_SAMA5_EMAC1_PHYSR_10FD must be defined in the NuttX configuration"
# endif
# ifndef CONFIG_SAMA5_EMAC1_PHYSR_100FD
# error "CONFIG_SAMA5_EMAC1_PHYSR_100FD must be defined in the NuttX configuration"
# endif
# else
# ifndef CONFIG_SAMA5_EMAC1_PHYSR_SPEED
# error "CONFIG_SAMA5_EMAC1_PHYSR_SPEED must be defined in the NuttX configuration"
# endif
# ifndef CONFIG_SAMA5_EMAC1_PHYSR_100MBPS
# error "CONFIG_SAMA5_EMAC1_PHYSR_100MBPS must be defined in the NuttX configuration"
# endif
# ifndef CONFIG_SAMA5_EMAC1_PHYSR_MODE
# error "CONFIG_SAMA5_EMAC1_PHYSR_MODE must be defined in the NuttX configuration"
# endif
# ifndef CONFIG_SAMA5_EMAC1_PHYSR_FULLDUPLEX
# error "CONFIG_SAMA5_EMAC1_PHYSR_FULLDUPLEX must be defined in the NuttX configuration"
# endif
# endif
# endif
/* PHY definitions */
# if defined(SAMA5_EMAC1_PHY_DM9161)
# define EMAC1_MII_OUI_MSB 0x0181
# define EMAC1_MII_OUI_LSB 0x2e
# elif defined(SAMA5_EMAC1_PHY_LAN8700)
# define EMAC1_MII_OUI_MSB 0x0007
# define EMAC1_MII_OUI_LSB 0x30
# elif defined(SAMA5_EMAC1_PHY_KSZ8051)
# define EMAC1_MII_OUI_MSB 0x0022
# define EMAC1_MII_OUI_LSB 0x05
# elif defined(SAMA5_EMAC1_PHY_KSZ8081)
# define EMAC1_MII_OUI_MSB 0x0022
# define EMAC1_MII_OUI_LSB 0x05
# else
# error EMAC PHY unrecognized
# endif
#endif /* CONFIG_SAMA5_EMAC0 */
/* Device name */
#ifdef CONFIG_SAMA5_EMAC0_ISETH0
# define SAMA5_EMAC0_DEVNAME "eth0"
# define SAMA5_EMAC1_DEVNAME "eth1"
#else
# define SAMA5_EMAC0_DEVNAME "eth1"
# define SAMA5_EMAC1_DEVNAME "eth0"
#endif
/* Common Configuration *****************************************************/
#undef CONFIG_SAMA5_EMACB_NBC
/* Extremely detailed register debug that you would normally never want
* enabled.
*/
#ifndef CONFIG_DEBUG
# undef CONFIG_SAMA5_EMACB_REGDEBUG
#endif
#ifdef CONFIG_NET_DUMPPACKET
# define sam_dumppacket(m,a,n) lib_dumpbuffer(m,a,n)
#else
# define sam_dumppacket(m,a,n)
#endif
/* EMAC buffer sizes, number of buffers, and number of descriptors **********
*
* REVISIT: The CONFIG_NET_MULTIBUFFER might be useful. It might be possible
* to use this option to send and receive messages directly into the DMA
* buffers, saving a copy. There might be complications on the receiving
* side, however, where buffers may wrap and where the size of the received
* frame will typically be smaller than a full packet.
*/
#ifdef CONFIG_NET_MULTIBUFFER
# error CONFIG_NET_MULTIBUFFER must not be set
#endif
#define EMAC_RX_UNITSIZE 128 /* Fixed size for RX buffer */
#define EMAC_TX_UNITSIZE CONFIG_NET_BUFSIZE /* MAX size for Ethernet packet */
/* Timing *******************************************************************/
/* TX poll delay = 1 seconds. CLK_TCK is the number of clock ticks per
* second
*/
#define SAM_WDDELAY (1*CLK_TCK)
#define SAM_POLLHSEC (1*2)
/* TX timeout = 1 minute */
#define SAM_TXTIMEOUT (60*CLK_TCK)
/* PHY read/write delays in loop counts */
#define PHY_RETRY_MAX 1000000
/* Helpers ******************************************************************/
/* This is a helper pointer for accessing the contents of the EMAC
* header
*/
#define BUF ((struct eth_hdr_s *)priv->dev.d_buf)
/****************************************************************************
* Private Types
****************************************************************************/
/* This structure defines the constant an configured attributes of an EMAC */
struct sam_emacattr_s
{
/* Basic hardware information */
#ifdef CONFIG_NETDEV_PHY_IOCTL
FAR const char *intf; /* Network interface name, e.g., "eth0" */
#endif
uint32_t base; /* EMAC Register base address */
xcpt_t handler; /* EMAC interrupt handler */
uint8_t emac; /* EMACn, n=0 or 1 */
uint8_t irq; /* EMAC interrupt number */
/* PHY Configuration */
uint8_t phyaddr; /* PHY address */
uint8_t physr; /* PHY status register address */
uint16_t msoui; /* MS 16 bits of the 18-bit OUI */
uint8_t lsoui; /* LS 2 bits of the 18-bit OUI */
bool rmii; /* True: RMII vs. False: MII */
bool clause45; /* True: Clause 45 behavior */
//bool autoneg; /* True: Autonegotiate rate and *plex */
bool sralt; /* True: Alternate PHYSR bit access */
union
{
/* "Standard" form: Individual bits determine speed and half/full
* duplex.
*/
struct
{
uint16_t stdmask; /* Mask for speed and *plex mode bits */
uint16_t speed100; /* 100Base_t bit */
uint16_t fduplex; /* Full duplex bit */
} std;
/* Alternative form: Speed and duplex are encoded in a single,
* multi-bit field.
*/
struct
{
uint16_t altmask; /* Mask speed for mode bits */
uint16_t hdx10; /* 10Base_T Half Duplux bit pattern */
uint16_t hdx100; /* 100Base_T Half Duplux bit pattern */
uint16_t fdx10; /* 10Base_T Half Duplux bit pattern */
uint16_t fdx100; /* 100Base_T Half Duplux bit pattern */
} alt;
} u;
/* Buffer and descriptor configuration */
uint8_t ntxbuffers; /* Number of TX buffers */
uint8_t nrxbuffers; /* Number of RX buffers */
#ifdef CONFIG_SAMA5_EMACB_PREALLOCATE
/* Attributes and addresses of preallocated buffers */
struct emac_txdesc_s *txdesc; /* Preallocated TX descriptor list */
struct emac_rxdesc_s *rxdesc; /* Preallocated RX descriptor list */
uint8_t *txbuffer; /* Preallocated TX buffers */
uint8_t *rxbuffer; /* Preallocated RX buffers */
#endif
};
/* The sam_emac_s encapsulates all state information for the EMAC peripheral */
struct sam_emac_s
{
uint8_t ifup : 1; /* true:ifup false:ifdown */
WDOG_ID txpoll; /* TX poll timer */
WDOG_ID txtimeout; /* TX timeout timer */
/* This holds the information visible to uIP/NuttX */
struct net_driver_s dev; /* Interface understood by uIP */
/* Constant and configured attributes of the EMAC */
const struct sam_emacattr_s *attr;
/* Used to track transmit and receive descriptors */
uint8_t phyaddr; /* PHY address (pre-defined by pins on reset) */
uint16_t txhead; /* Circular buffer head index */
uint16_t txtail; /* Circular buffer tail index */
uint16_t rxndx; /* RX index for current processing RX descriptor */
uint8_t *rxbuffer; /* Allocated RX buffers */
uint8_t *txbuffer; /* Allocated TX buffers */
struct emac_rxdesc_s *rxdesc; /* Allocated RX descriptors */
struct emac_txdesc_s *txdesc; /* Allocated TX descriptors */
/* Debug stuff */
#ifdef CONFIG_SAMA5_EMACB_REGDEBUG
bool wrlast; /* Last was a write */
uintptr_t addrlast; /* Last address */
uint32_t vallast; /* Last value */
int ntimes; /* Number of times */
#endif
};
/****************************************************************************
* Private Function Prototypes
****************************************************************************/
/* Register operations ******************************************************/
#if defined(CONFIG_SAMA5_EMACB_REGDEBUG) && defined(CONFIG_DEBUG)
static bool sam_checkreg(struct sam_emac_s *priv, bool wr,
uint32_t regval, uintptr_t address);
#endif
static uint32_t sam_getreg(struct sam_emac_s *priv, uint16_t offset);
static void sam_putreg(struct sam_emac_s *priv, uint16_t offset, uint32_t val);
/* Buffer management */
static uint16_t sam_txinuse(struct sam_emac_s *priv);
static uint16_t sam_txfree(struct sam_emac_s *priv);
static int sam_buffer_initialize(struct sam_emac_s *priv);
static void sam_buffer_free(struct sam_emac_s *priv);
/* Common TX logic */
static int sam_transmit(struct sam_emac_s *priv);
static int sam_txpoll(struct net_driver_s *dev);
static void sam_dopoll(struct sam_emac_s *priv);
/* Interrupt handling */
static int sam_recvframe(struct sam_emac_s *priv);
static void sam_receive(struct sam_emac_s *priv);
static void sam_txdone(struct sam_emac_s *priv);
static int sam_emac_interrupt(struct sam_emac_s *priv);
#ifdef CONFIG_SAMA5_EMAC0
static int sam_emac0_interrupt(int irq, void *context);
#endif
#ifdef CONFIG_SAMA5_EMAC1
static int sam_emac1_interrupt(int irq, void *context);
#endif
/* Watchdog timer expirations */
static void sam_polltimer(int argc, uint32_t arg, ...);
static void sam_txtimeout(int argc, uint32_t arg, ...);
/* NuttX callback functions */
static int sam_ifup(struct net_driver_s *dev);
static int sam_ifdown(struct net_driver_s *dev);
static int sam_txavail(struct net_driver_s *dev);
#ifdef CONFIG_NET_IGMP
static int sam_addmac(struct net_driver_s *dev, const uint8_t *mac);
static int sam_rmmac(struct net_driver_s *dev, const uint8_t *mac);
#endif
#ifdef CONFIG_NETDEV_PHY_IOCTL
static int sam_ioctl(struct net_driver_s *dev, int cmd, void *arg);
#endif
/* PHY Initialization */
#if defined(CONFIG_DEBUG_NET) && defined(CONFIG_DEBUG_VERBOSE)
static void sam_phydump(struct sam_emac_s *priv);
#else
# define sam_phydump(priv)
#endif
#if 0 /* Not used */
static bool sam_is10hdx(struct sam_emac_s *priv, uint16_t physr);
#endif
static bool sam_is100hdx(struct sam_emac_s *priv, uint16_t physr);
static bool sam_is10fdx(struct sam_emac_s *priv, uint16_t physr);
static bool sam_is100fdx(struct sam_emac_s *priv, uint16_t physr);
static int sam_phywait(struct sam_emac_s *priv);
static int sam_phyreset(struct sam_emac_s *priv);
static int sam_phyfind(struct sam_emac_s *priv, uint8_t *phyaddr);
static int sam_phyread(struct sam_emac_s *priv, uint8_t phyaddr,
uint8_t regaddr, uint16_t *phyval);
static int sam_phywrite(struct sam_emac_s *priv, uint8_t phyaddr,
uint8_t regaddr, uint16_t phyval);
static int sam_autonegotiate(struct sam_emac_s *priv);
static bool sam_linkup(struct sam_emac_s *priv);
static int sam_phyinit(struct sam_emac_s *priv);
/* EMAC Initialization */
static void sam_txreset(struct sam_emac_s *priv);
static void sam_rxreset(struct sam_emac_s *priv);
static void sam_emac_enableclk(struct sam_emac_s *priv);
static void sam_emac_disableclk(struct sam_emac_s *priv);
static void sam_emac_reset(struct sam_emac_s *priv);
static void sam_macaddress(struct sam_emac_s *priv);
static int sam_emac_configure(struct sam_emac_s *priv);
/****************************************************************************
* Private Data
****************************************************************************/
#ifdef CONFIG_SAMA5_EMACB_PREALLOCATE
/* Preallocated data */
#ifdef CONFIG_SAMA5_EMAC0
/* EMAC0 TX descriptors list */
static struct emac_txdesc_s g_emac0_txdesc[CONFIG_SAMA5_EMAC0_NTXBUFFERS]
__attribute__((aligned(8)));
/* EMAC0 RX descriptors list */
static struct emac_rxdesc_s g_emac0_rxdesc[CONFIG_SAMA5_EMAC0_NRXBUFFERS]
__attribute__((aligned(8)));
/* EMAC0 Transmit Buffers
*
* Section 3.6 of AMBA 2.0 spec states that burst should not cross 1K Boundaries.
* Receive buffer manager writes are burst of 2 words => 3 lsb bits of the address
* shall be set to 0
*/
static uint8_t g_emac0_txbuffer[CONFIG_SAMA5_EMAC0_NTXBUFFERS * EMAC_TX_UNITSIZE];
__attribute__((aligned(8)))
/* EMAC0 Receive Buffers */
static uint8_t g_emac0_rxbuffer[CONFIG_SAMA5_EMAC0_NRXBUFFERS * EMAC_RX_UNITSIZE]
__attribute__((aligned(8)));
#endif
#ifdef CONFIG_SAMA5_EMAC1
/* EMAC1 TX descriptors list */
static struct emac_txdesc_s g_emac1_txdesc[CONFIG_SAMA5_EMAC1_NTXBUFFERS]
__attribute__((aligned(8)));
/* EMAC1 RX descriptors list */
static struct emac_rxdesc_s g_emac1_rxdesc[CONFIG_SAMA5_EMAC1_NRXBUFFERS]
__attribute__((aligned(8)));
/* EMAC1 Transmit Buffers
*
* Section 3.6 of AMBA 2.0 spec states that burst should not cross 1K Boundaries.
* Receive buffer manager writes are burst of 2 words => 3 lsb bits of the address
* shall be set to 0
*/
static uint8_t g_emac1_txbuffer[CONFIG_SAMA5_EMAC1_NTXBUFFERS * EMAC_TX_UNITSIZE];
__attribute__((aligned(8)))
/* EMAC0 Receive Buffers */
static uint8_t g_emac1_rxbuffer[CONFIG_SAMA5_EMAC1_NRXBUFFERS * EMAC_RX_UNITSIZE]
__attribute__((aligned(8)));
#endif
#endif
/* The driver state singletons */
#ifdef CONFIG_SAMA5_EMAC0
static const struct sam_emacattr_s g_emac0_attr =
{
/* Basic hardware information */
#ifdef CONFIG_NETDEV_PHY_IOCTL
.intf = SAMA5_EMAC0_DEVNAME;
#endif
.base = SAM_EMAC0_VBASE,
.handler = sam_emac0_interrupt,
.emac = 0,
.irq = SAM_IRQ_EMAC0,
/* PHY Configuration */
.phyaddr = CONFIG_SAMA5_EMAC0_PHYADDR,
.physr = CONFIG_SAMA5_EMAC0_PHYSR,
.msoui = EMAC0_MII_OUI_MSB,
.lsoui = EMAC0_MII_OUI_LSB,
#ifdef CONFIG_SAMA5_EMAC0_RMII
.rmii = true,
#endif
#ifdef CONFIG_SAMA5_EMAC0_CLAUSE45
.clause45 = true,
#endif
#ifdef CONFIG_SAMA5_EMAC0_AUTONEG
//.autoneg = true,
#endif
#ifdef CONFIG_SAMA5_EMAC0_PHYSR_ALTCONFIG
.sralt = true,
#endif
.u =
{
#ifdef CONFIG_SAMA5_EMAC0_PHYSR_ALTCONFIG
.alt =
{
.altmask = CONFIG_SAMA5_EMAC0_PHYSR_ALTMODE,
.hdx10 = CONFIG_SAMA5_EMAC0_PHYSR_10HD,
.hdx100 = CONFIG_SAMA5_EMAC0_PHYSR_100HD,
.fdx10 = CONFIG_SAMA5_EMAC0_PHYSR_10FD,
.fdx100 = CONFIG_SAMA5_EMAC0_PHYSR_100FD,
},
#else
.std =
{
.stdmask = (CONFIG_SAMA5_EMAC0_PHYSR_SPEED | CONFIG_SAMA5_EMAC0_PHYSR_MODE),
.speed100 = CONFIG_SAMA5_EMAC1_PHYSR_100MBPS,
.fduplex = CONFIG_SAMA5_EMAC1_PHYSR_FULLDUPLEX,
},
#endif
},
/* Buffer and descriptor configuration */
.ntxbuffers = CONFIG_SAMA5_EMAC0_NTXBUFFERS,
.nrxbuffers = CONFIG_SAMA5_EMAC0_NRXBUFFERS,
#ifdef CONFIG_SAMA5_EMACB_PREALLOCATE
/* Addresses of preallocated buffers */
.txdesc = g_emac0_txdesc,
.rxdesc = g_emac0_rxdesc,
.txbuffer = g_emac0_txbuffer,
.rxbuffer = g_emac0_rxbuffer,
#endif
};
static struct sam_emac_s g_emac0;
#endif
#ifdef CONFIG_SAMA5_EMAC1
static const struct sam_emacattr_s g_emac1_attr =
{
/* Basic hardware information */
#ifdef CONFIG_NETDEV_PHY_IOCTL
.intf = SAMA5_EMAC1_DEVNAME;
#endif
.base = SAM_EMAC1_VBASE,
.handler = sam_emac1_interrupt,
.emac = 0,
.irq = SAM_IRQ_EMAC1,
/* PHY Configuration */
.phyaddr = CONFIG_SAMA5_EMAC1_PHYADDR,
.physr = CONFIG_SAMA5_EMAC1_PHYSR,
.msoui = EMAC1_MII_OUI_MSB,
.lsoui = EMAC1_MII_OUI_LSB,
#ifdef CONFIG_SAMA5_EMAC1_RMII
.rmii = true,
#endif
#ifdef CONFIG_SAMA5_EMAC1_CLAUSE45
.clause45 = true,
#endif
#ifdef CONFIG_SAMA5_EMAC1_AUTONEG
//.autoneg = true,
#endif
#ifdef CONFIG_SAMA5_EMAC1_PHYSR_ALTCONFIG
.sralt = true,
#endif
.u =
{
#ifdef CONFIG_SAMA5_EMAC1_PHYSR_ALTCONFIG
.alt =
{
.altmask = CONFIG_SAMA5_EMAC1_PHYSR_ALTMODE,
.hdx10 = CONFIG_SAMA5_EMAC1_PHYSR_10HD,
.hdx100 = CONFIG_SAMA5_EMAC1_PHYSR_100HD,
.fdx10 = CONFIG_SAMA5_EMAC1_PHYSR_10FD,
.fdx100 = CONFIG_SAMA5_EMAC1_PHYSR_100FD,
},
#else
.std =
{
.stdmask = (CONFIG_SAMA5_EMAC1_PHYSR_SPEED | CONFIG_SAMA5_EMAC1_PHYSR_MODE),
.speed100 = CONFIG_SAMA5_EMAC1_PHYSR_100MBPS,
.fduplex = CONFIG_SAMA5_EMAC1_PHYSR_FULLDUPLEX,
},
#endif
},
/* Buffer and descriptor configuration */
.ntxbuffers = CONFIG_SAMA5_EMAC1_NTXBUFFERS,
.nrxbuffers = CONFIG_SAMA5_EMAC1_NRXBUFFERS,
#ifdef CONFIG_SAMA5_EMACB_PREALLOCATE
/* Attributes and addresses of preallocated buffers */
.txdesc = g_emac1_txdesc,
.rxdesc = g_emac1_rxdesc,
.txbuffer = g_emac1_txbuffer,
.rxbuffer = g_emac1_rxbuffer,
#endif
};
static struct sam_emac_s g_emac1;
#endif
/****************************************************************************
* Private Functions
****************************************************************************/
/****************************************************************************
* Name: sam_checkreg
*
* Description:
* Check if the current register access is a duplicate of the preceding.
*
* Input Parameters:
* regval - The value to be written
* address - The address of the register to write to
*
* Returned Value:
* true: This is the first register access of this type.
* flase: This is the same as the preceding register access.
*
****************************************************************************/
#ifdef CONFIG_SAMA5_EMACB_REGDEBUG
static bool sam_checkreg(struct sam_emac_s *priv, bool wr, uint32_t regval,
uintptr_t regaddr)
{
if (wr == priv->wrlast && /* Same kind of access? */
regval == priv->vallast && /* Same value? */
regaddr == priv->addrlast) /* Same address? */
{
/* Yes, then just keep a count of the number of times we did this. */
priv->ntimes++;
return false;
}
else
{
/* Did we do the previous operation more than once? */
if (priv->ntimes > 0)
{
/* Yes... show how many times we did it */
lldbg("...[Repeats %d times]...\n", priv->ntimes);
}
/* Save information about the new access */
priv->wrlast = wr;
priv->vallast = regval;
priv->addrlast = regaddr;
priv->ntimes = 0;
}
/* Return true if this is the first time that we have done this operation */
return true;
}
#endif
/****************************************************************************
* Name: sam_getreg
*
* Description:
* Read a 32-bit EMAC register using an offset from the EMAC base address
*
****************************************************************************/
static uint32_t sam_getreg(struct sam_emac_s *priv, uint16_t offset)
{
uintptr_t regaddr = priv->attr->base + (uintptr_t)offset;
uint32_t regval = getreg32(regaddr);
#ifdef CONFIG_SAMA5_EMACB_REGDEBUG
if (sam_checkreg(priv, false, regval, regaddr))
{
lldbg("%08x->%08x\n", regaddr, regval);
}
#endif
return regval;
}
/****************************************************************************
* Name: sam_putreg
*
* Description:
* Write to a 32-bit EMAC register using an offset from the EMAC base
* address
*
****************************************************************************/
static void sam_putreg(struct sam_emac_s *priv, uint16_t offset,
uint32_t regval)
{
uintptr_t regaddr = priv->attr->base + (uintptr_t)offset;
#ifdef CONFIG_SAMA5_EMACB_REGDEBUG
if (sam_checkreg(priv, true, regval, regaddr))
{
lldbg("%08x<-%08x\n", regaddr, regval);
}
#endif
putreg32(regval, regaddr);
}
/****************************************************************************
* Function: sam_txinuse
*
* Description:
* Return the number of TX buffers in-use
*
* Input Parameters:
* priv - The EMAC driver state
*
* Returned Value:
* The number of TX buffers in-use
*
****************************************************************************/
static uint16_t sam_txinuse(struct sam_emac_s *priv)
{
uint32_t txhead32 = (uint32_t)priv->txhead;
if ((uint32_t)priv->txtail > txhead32)
{
txhead32 += priv->attr->ntxbuffers;
}
return (uint16_t)(txhead32 - (uint32_t)priv->txtail);
}
/****************************************************************************
* Function: sam_txfree
*
* Description:
* Return the number of TX buffers available
*
* Input Parameters:
* priv - The EMAC driver state
*
* Returned Value:
* The number of TX buffers available
*
****************************************************************************/
static uint16_t sam_txfree(struct sam_emac_s *priv)
{
/* The number available is equal to the total number of buffers, minus the
* number of buffers in use. Notice that that actual number of buffers is
* the configured size minus 1.
*/
return (priv->attr->ntxbuffers-1) - sam_txinuse(priv);
}
/****************************************************************************
* Function: sam_buffer_initialize
*
* Description:
* Allocate aligned TX and RX descriptors and buffers. For the case of
* pre-allocated structures, the function degenerates to a few assignements.
*
* Input Parameters:
* priv - The EMAC driver state
*
* Returned Value:
* OK on success; Negated errno on failure.
*
* Assumptions:
* Called very early in the initialization sequence.
*
****************************************************************************/
static int sam_buffer_initialize(struct sam_emac_s *priv)
{
#ifdef CONFIG_SAMA5_EMACB_PREALLOCATE
/* Use pre-allocated buffers */
priv->txdesc = priv->attr->txdesc;
priv->rxdesc = priv->attr->rxdesc;
priv->txbuffer = priv->attr->txbuffer;
priv->rxbuffer = priv->attr->rxbuffer;
#else
size_t allocsize;
/* Allocate buffers */
allocsize = priv->attr->ntxbuffers * sizeof(struct emac_txdesc_s);
priv->txdesc = (struct emac_txdesc_s *)kmemalign(8, allocsize);
if (!priv->txdesc)
{
nlldbg("ERROR: Failed to allocate TX descriptors\n");
return -ENOMEM;
}
memset(priv->txdesc, 0, allocsize);
allocsize = priv->attr->nrxbuffers * sizeof(struct emac_rxdesc_s);
priv->rxdesc = (struct emac_rxdesc_s *)kmemalign(8, allocsize);
if (!priv->rxdesc)
{
nlldbg("ERROR: Failed to allocate RX descriptors\n");
sam_buffer_free(priv);
return -ENOMEM;
}
memset(priv->rxdesc, 0, allocsize);
allocsize = priv->attr->ntxbuffers * EMAC_TX_UNITSIZE;
priv->txbuffer = (uint8_t *)kmemalign(8, allocsize);
if (!priv->txbuffer)
{
nlldbg("ERROR: Failed to allocate TX buffer\n");
sam_buffer_free(priv);
return -ENOMEM;
}
allocsize = priv->attr->nrxbuffers * EMAC_RX_UNITSIZE;
priv->rxbuffer = (uint8_t *)kmemalign(8, allocsize);
if (!priv->rxbuffer)
{
nlldbg("ERROR: Failed to allocate RX buffer\n");
sam_buffer_free(priv);
return -ENOMEM;
}
#endif
DEBUGASSERT(((uintptr_t)priv->rxdesc & 7) == 0 &&
((uintptr_t)priv->rxbuffer & 7) == 0 &&
((uintptr_t)priv->txdesc & 7) == 0 &&
((uintptr_t)priv->txbuffer & 7) == 0);
return OK;
}
/****************************************************************************
* Function: sam_buffer_free
*
* Description:
* Free aligned TX and RX descriptors and buffers. For the case of
* pre-allocated structures, the function does nothing.
*
* Input Parameters:
* priv - The EMAC driver state
*
* Returned Value:
* None
*
****************************************************************************/
static void sam_buffer_free(struct sam_emac_s *priv)
{
#ifndef CONFIG_SAMA5_EMACB_PREALLOCATE
/* Free allocated buffers */
if (priv->txdesc)
{
kfree(priv->txdesc);
priv->txdesc = NULL;
}
if (priv->rxdesc)
{
kfree(priv->rxdesc);
priv->rxdesc = NULL;
}
if (priv->txbuffer)
{
kfree(priv->txbuffer);
priv->txbuffer = NULL;
}
if (priv->rxbuffer)
{
kfree(priv->rxbuffer);
priv->rxbuffer = NULL;
}
#endif
}
/****************************************************************************
* Function: sam_transmit
*
* Description:
* Start hardware transmission. Called either from the txdone interrupt
* handling or from watchdog based polling.
*
* Parameters:
* priv - Reference to the driver state structure
*
* Returned Value:
* OK on success; a negated errno on failure
*
* Assumptions:
* May or may not be called from an interrupt handler. In either case,
* global interrupts are disabled, either explicitly or indirectly through
* interrupt handling logic.
*
****************************************************************************/
static int sam_transmit(struct sam_emac_s *priv)
{
struct net_driver_s *dev = &priv->dev;
volatile struct emac_txdesc_s *txdesc;
uintptr_t virtaddr;
uint32_t regval;
uint32_t status;
nllvdbg("d_len: %d txhead: %d\n", dev->d_len, priv->txhead);
sam_dumppacket("Transmit packet", dev->d_buf, dev->d_len);
/* Check parameter */
if (dev->d_len > EMAC_TX_UNITSIZE)
{
nlldbg("ERROR: Packet too big: %d\n", dev->d_len);
return -EINVAL;
}
/* Pointer to the current TX descriptor */
txdesc = &priv->txdesc[priv->txhead];
/* If no free TX descriptor, buffer can't be sent */
if (sam_txfree(priv) < 1)
{
nlldbg("ERROR: No free TX descriptors\n");
return -EBUSY;
}
/* Setup/Copy data to transmission buffer */
if (dev->d_len > 0)
{
/* Driver managed the ring buffer */
virtaddr = sam_virtramaddr(txdesc->addr);
memcpy((void *)virtaddr, dev->d_buf, dev->d_len);
arch_clean_dcache((uint32_t)virtaddr, (uint32_t)virtaddr + dev->d_len);
}
/* Update TX descriptor status. */
status = dev->d_len | EMACTXD_STA_LAST;
if (priv->txhead == priv->attr->ntxbuffers-1)
{
status |= EMACTXD_STA_WRAP;
}
/* Update the descriptor status and flush the updated value to RAM */
txdesc->status = status;
arch_clean_dcache((uint32_t)txdesc,
(uint32_t)txdesc + sizeof(struct emac_txdesc_s));
/* Increment the head index */
if (++priv->txhead >= priv->attr->ntxbuffers)
{
priv->txhead = 0;
}
/* Now start transmission (if it is not already done) */
regval = sam_getreg(priv, SAM_EMAC_NCR_OFFSET);
regval |= EMAC_NCR_TSTART;
sam_putreg(priv, SAM_EMAC_NCR_OFFSET, regval);
/* Setup the TX timeout watchdog (perhaps restarting the timer) */
(void)wd_start(priv->txtimeout, SAM_TXTIMEOUT, sam_txtimeout, 1,
(uint32_t)priv);
/* Set d_len to zero meaning that the d_buf[] packet buffer is again
* available.
*/
dev->d_len = 0;
/* If we have no more available TX descriptors, then we must disable the
* RCOMP interrupt to stop further RX processing. Why? Because EACH RX
* packet that is dispatched is also an opportunity to replay with a TX
* packet. So, if we cannot handle an RX packet reply, then we disable
* all RX packet processing.
*/
if (sam_txfree(priv) < 1)
{
nllvdbg("Disabling RX interrupts\n");
sam_putreg(priv, SAM_EMAC_IDR_OFFSET, EMAC_INT_RCOMP);
}
return OK;
}
/****************************************************************************
* Function: sam_txpoll
*
* Description:
* The transmitter is available, check if uIP has any outgoing packets ready
* to send. This is a callback from devif_poll(). devif_poll() may be called:
*
* 1. When the preceding TX packet send is complete,
* 2. When the preceding TX packet send timesout and the interface is reset
* 3. During normal TX polling
*
* Parameters:
* dev - Reference to the NuttX driver state structure
*
* Returned Value:
* OK on success; a negated errno on failure
*
* Assumptions:
* May or may not be called from an interrupt handler. In either case,
* global interrupts are disabled, either explicitly or indirectly through
* interrupt handling logic.
*
****************************************************************************/
static int sam_txpoll(struct net_driver_s *dev)
{
struct sam_emac_s *priv = (struct sam_emac_s *)dev->d_private;
/* If the polling resulted in data that should be sent out on the network,
* the field d_len is set to a value > 0.
*/
if (priv->dev.d_len > 0)
{
/* Send the packet */
arp_out(&priv->dev);
sam_transmit(priv);
/* Check if the there are any free TX descriptors. We cannot perform
* the TX poll if we do not have buffering for another packet.
*/
if (sam_txfree(priv) == 0)
{
/* We have to terminate the poll if we have no more descriptors
* available for another transfer.
*/
return -EBUSY;
}
}
/* If zero is returned, the polling will continue until all connections have
* been examined.
*/
return 0;
}
/****************************************************************************
* Function: sam_dopoll
*
* Description:
* Perform the uIP poll.
*
* Parameters:
* priv - Reference to the driver state structure
*
* Returned Value:
* None
*
* Assumptions:
* Global interrupts are disabled by interrupt handling logic.
*
****************************************************************************/
static void sam_dopoll(struct sam_emac_s *priv)
{
struct net_driver_s *dev = &priv->dev;
/* Check if the there are any free TX descriptors. We cannot perform the
* TX poll if we do not have buffering for another packet.
*/
if (sam_txfree(priv) > 0)
{
/* If we have the descriptor, then poll uIP for new XMIT data. */
(void)devif_poll(dev, sam_txpoll);
}
}
/****************************************************************************
* Function: sam_recvframe
*
* Description:
* The function is called when a frame is received. It scans the RX
* descriptors of the received frame and assembles the full packet/
*
* NOTE: This function will silently discard any packets containing errors.
*
* Parameters:
* priv - Reference to the driver state structure
*
* Returned Value:
* OK if a packet was successfully returned; -EAGAIN if there are no
* further packets available
*
* Assumptions:
* - Global interrupts are disabled by interrupt handling logic.
* - The RX descriptor D-cache list has been invalided to force fetching
* from RAM.
*
****************************************************************************/
static int sam_recvframe(struct sam_emac_s *priv)
{
struct emac_rxdesc_s *rxdesc;
struct net_driver_s *dev;
const uint8_t *src;
uint8_t *dest;
uintptr_t physaddr;
uint32_t rxndx;
uint32_t pktlen;
uint16_t copylen;
bool isframe;
/* Process received RX descriptor. The ownership bit is set by the EMAC
* once it has successfully written a frame to memory.
*/
dev = &priv->dev;
dev->d_len = 0;
dest = dev->d_buf;
pktlen = 0;
rxndx = priv->rxndx;
rxdesc = &priv->rxdesc[rxndx];
isframe = false;
/* Invalidate the RX descriptor to force re-fetching from RAM */
arch_invalidate_dcache((uintptr_t)rxdesc,
(uintptr_t)rxdesc + sizeof(struct emac_rxdesc_s));
nllvdbg("rxndx: %d\n", rxndx);
while ((rxdesc->addr & EMACRXD_ADDR_OWNER) != 0)
{
/* The start of frame bit indicates the beginning of a frame. Discard
* any previous fragments.
*/
if ((rxdesc->status & EMACRXD_STA_SOF) != 0)
{
/* Skip previous fragments */
while (rxndx != priv->rxndx)
{
/* Give ownership back to the EMAC */
rxdesc = &priv->rxdesc[priv->rxndx];
rxdesc->addr &= ~(EMACRXD_ADDR_OWNER);
/* Flush the modified RX descriptor to RAM */
arch_clean_dcache((uintptr_t)rxdesc,
(uintptr_t)rxdesc +
sizeof(struct emac_rxdesc_s));
/* Increment the RX index */
if (++priv->rxndx >= priv->attr->nrxbuffers)
{
priv->rxndx = 0;
}
}
/* Reset the packet data pointer and packet length */
dest = dev->d_buf;
pktlen = 0;
/* Start to gather buffers into the packet buffer */
isframe = true;
}
/* Increment the working index */
if (++rxndx >= priv->attr->nrxbuffers)
{
rxndx = 0;
}
/* Copy data into the packet buffer */
if (isframe)
{
if (rxndx == priv->rxndx)
{
nllvdbg("ERROR: No EOF (Invalid of buffers too small)\n");
do
{
/* Give ownership back to the EMAC */
rxdesc = &priv->rxdesc[priv->rxndx];
rxdesc->addr &= ~(EMACRXD_ADDR_OWNER);
/* Flush the modified RX descriptor to RAM */
arch_clean_dcache((uintptr_t)rxdesc,
(uintptr_t)rxdesc +
sizeof(struct emac_rxdesc_s));
/* Increment the RX index */
if (++priv->rxndx >= priv->attr->nrxbuffers)
{
priv->rxndx = 0;
}
}
while (rxndx != priv->rxndx);
return -EIO;
}
/* Get the number of bytes to copy from the buffer */
copylen = EMAC_RX_UNITSIZE;
if ((pktlen + copylen) > CONFIG_NET_BUFSIZE)
{
copylen = CONFIG_NET_BUFSIZE - pktlen;
}
/* Get the data source. Invalidate the source memory region to
* force reload from RAM.
*/
physaddr = (uintptr_t)(rxdesc->addr & EMACRXD_ADDR_MASK);
src = (const uint8_t *)sam_virtramaddr(physaddr);
arch_invalidate_dcache((uintptr_t)src, (uintptr_t)src + copylen);
/* And do the copy */
memcpy(dest, src, copylen);
dest += copylen;
pktlen += copylen;
/* If the end of frame has been received, return the data */
if ((rxdesc->status & EMACRXD_STA_EOF) != 0)
{
/* Frame size from the EMAC */
dev->d_len = (rxdesc->status & EMACRXD_STA_FRLEN_MASK);
nllvdbg("packet %d-%d (%d)\n", priv->rxndx, rxndx, dev->d_len);
/* All data have been copied in the application frame buffer,
* release the RX descriptor
*/
while (priv->rxndx != rxndx)
{
/* Give ownership back to the EMAC */
rxdesc = &priv->rxdesc[priv->rxndx];
rxdesc->addr &= ~(EMACRXD_ADDR_OWNER);
/* Flush the modified RX descriptor to RAM */
arch_clean_dcache((uintptr_t)rxdesc,
(uintptr_t)rxdesc +
sizeof(struct emac_rxdesc_s));
/* Increment the RX index */
if (++priv->rxndx >= priv->attr->nrxbuffers)
{
priv->rxndx = 0;
}
}
/* Check if the device packet buffer was large enough to accept
* all of the data.
*/
nllvdbg("rxndx: %d d_len: %d\n", priv->rxndx, dev->d_len);
if (pktlen < dev->d_len)
{
nlldbg("ERROR: Buffer size %d; frame size %d\n",
dev->d_len, pktlen);
return -E2BIG;
}
return OK;
}
}
/* We have not encountered the SOF yet... discard this fragment and
* keep looking
*/
else
{
/* Give ownership back to the EMAC */
rxdesc->addr &= ~(EMACRXD_ADDR_OWNER);
/* Flush the modified RX descriptor to RAM */
arch_clean_dcache((uintptr_t)rxdesc,
(uintptr_t)rxdesc +
sizeof(struct emac_rxdesc_s));
priv->rxndx = rxndx;
}
/* Process the next buffer */
rxdesc = &priv->rxdesc[rxndx];
/* Invalidate the RX descriptor to force re-fetching from RAM */
arch_invalidate_dcache((uintptr_t)rxdesc,
(uintptr_t)rxdesc + sizeof(struct emac_rxdesc_s));
}
/* No packet was found */
priv->rxndx = rxndx;
nllvdbg("rxndx: %d\n", priv->rxndx);
return -EAGAIN;
}
/****************************************************************************
* Function: sam_receive
*
* Description:
* An interrupt was received indicating the availability of one or more
* new RX packets in FIFO memory.
*
* Parameters:
* priv - Reference to the driver state structure
*
* Returned Value:
* None
*
* Assumptions:
* Global interrupts are disabled by interrupt handling logic.
*
****************************************************************************/
static void sam_receive(struct sam_emac_s *priv)
{
struct net_driver_s *dev = &priv->dev;
/* Loop while while sam_recvframe() successfully retrieves valid
* EMAC frames.
*/
while (sam_recvframe(priv) == OK)
{
sam_dumppacket("Received packet", dev->d_buf, dev->d_len);
/* Check if the packet is a valid size for the uIP buffer configuration
* (this should not happen)
*/
if (dev->d_len > CONFIG_NET_BUFSIZE)
{
nlldbg("DROPPED: Too big: %d\n", dev->d_len);
}
/* We only accept IP packets of the configured type and ARP packets */
#ifdef CONFIG_NET_IPv6
else if (BUF->type == HTONS(ETHTYPE_IP6))
#else
else if (BUF->type == HTONS(ETHTYPE_IP))
#endif
{
nllvdbg("IP frame\n");
/* Handle ARP on input then give the IP packet to uIP */
arp_ipin(&priv->dev);
devif_input(&priv->dev);
/* If the above function invocation resulted in data that should be
* sent out on the network, the field d_len will set to a value > 0.
*/
if (priv->dev.d_len > 0)
{
arp_out(&priv->dev);
sam_transmit(priv);
}
}
else if (BUF->type == htons(ETHTYPE_ARP))
{
nllvdbg("ARP frame\n");
/* Handle ARP packet */
arp_arpin(&priv->dev);
/* If the above function invocation resulted in data that should be
* sent out on the network, the field d_len will set to a value > 0.
*/
if (priv->dev.d_len > 0)
{
sam_transmit(priv);
}
}
else
{
nlldbg("DROPPED: Unknown type: %04x\n", BUF->type);
}
}
}
/****************************************************************************
* Function: sam_txdone
*
* Description:
* An interrupt was received indicating that one or more frames have
* completed transmission.
*
* Parameters:
* priv - Reference to the driver state structure
*
* Returned Value:
* None
*
* Assumptions:
* Global interrupts are disabled by the watchdog logic.
*
****************************************************************************/
static void sam_txdone(struct sam_emac_s *priv)
{
struct emac_txdesc_s *txdesc;
#ifndef __NO_KLUDGES__
int ntxdone = 0;
#endif
/* Are there any outstanding transmissions? Loop until either (1) all of
* the TX descriptors have been examined, or (2) until we encounter the
* first descriptor that is still in use by the hardware.
*/
while (priv->txhead != priv->txtail)
{
/* Yes.. check the next buffer at the tail of the list */
txdesc = &priv->txdesc[priv->txtail];
arch_invalidate_dcache((uintptr_t)txdesc,
(uintptr_t)txdesc + sizeof(struct emac_txdesc_s));
/* Is this TX descriptor still in use? */
#ifndef __NO_KLUDGES__
# warning REVISIT
/* I have seen cases where we receive interrupts, but the USED
* bit is never set in the TX descriptor. This logic assumes
* that if we got the interrupt, then there most be at least
* one packet that completed. This is not necessarily a safe
* assumption.
*/
ntxdone++;
if ((txdesc->status & EMACTXD_STA_USED) == 0 && ntxdone > 1)
#else
if ((txdesc->status & EMACTXD_STA_USED) == 0)
#endif
{
/* Yes.. the descriptor is still in use. However, I have seen a
* case (only repeatable on start-up) where the USED bit is never
* set. Yikes! If we have encountered the first still busy
* descriptor, then we should also have TQBD equal to the descriptor
* address. If it is not, then treat is as used anyway.
*/
#if 0 /* The issue does not exist in the current configuration, but may return */
#warning REVISIT
if (priv->txtail == 0 &&
sam_physramaddr((uintptr_t)txdesc) != sam_getreg(priv, SAM_EMAC_TBQB_OFFSET))
{
txdesc->status = (uint32_t)EMACTXD_STA_USED;
arch_clean_dcache((uintptr_t)txdesc,
(uintptr_t)txdesc + sizeof(struct emac_txdesc_s));
}
else
#endif
{
/* Otherwise, the descriptor is truly in use. Break out of the
* loop now.
*/
break;
}
}
#ifndef __NO_KLUDGES__
/* Make sure that the USED bit is set */
txdesc->status = (uint32_t)EMACTXD_STA_USED;
arch_clean_dcache((uintptr_t)txdesc,
(uintptr_t)txdesc + sizeof(struct emac_txdesc_s));
#endif
/* Increment the tail index */
if (++priv->txtail >= priv->attr->ntxbuffers)
{
/* Wrap to the beginning of the TX descriptor list */
priv->txtail = 0;
}
/* At least one TX descriptor is available. Re-enable RX interrupts.
* RX interrupts may previously have been disabled when we ran out of
* TX descriptors (see comments in sam_transmit()).
*/
sam_putreg(priv, SAM_EMAC_IER_OFFSET, EMAC_INT_RCOMP);
}
/* Then poll uIP for new XMIT data */
sam_dopoll(priv);
}
/****************************************************************************
* Function: sam_emac_interrupt
*
* Description:
* Common hardware interrupt handler
*
* Parameters:
* priv - Reference to the EMAC private state structure
*
* Returned Value:
* OK on success
*
* Assumptions:
*
****************************************************************************/
static int sam_emac_interrupt(struct sam_emac_s *priv)
{
uint32_t isr;
uint32_t rsr;
uint32_t tsr;
uint32_t imr;
uint32_t regval;
uint32_t pending;
uint32_t clrbits;
isr = sam_getreg(priv, SAM_EMAC_ISR_OFFSET);
rsr = sam_getreg(priv, SAM_EMAC_RSR_OFFSET);
tsr = sam_getreg(priv, SAM_EMAC_TSR_OFFSET);
imr = sam_getreg(priv, SAM_EMAC_IMR_OFFSET);
pending = isr & ~(imr | EMAC_INT_UNUSED);
nllvdbg("isr: %08x pending: %08x\n", isr, pending);
/* Check for the completion of a transmission. This should be done before
* checking for received data (because receiving can cause another transmission
* before we had a chance to handle the last one).
*
* ISR:TCOMP is set when a frame has been transmitted. Cleared on read.
* TSR:TXCOMP is set when a frame has been transmitted. Cleared by writing a
* one to this bit.
*/
if ((pending & EMAC_INT_TCOMP) != 0 || (tsr & EMAC_TSR_TXCOMP) != 0)
{
/* A frame has been transmitted */
clrbits = EMAC_TSR_TXCOMP;
/* Check for Retry Limit Exceeded (RLE) */
if ((tsr & EMAC_TSR_RLE) != 0)
{
/* Status RLE & Number of discarded buffers */
clrbits = EMAC_TSR_RLE | sam_txinuse(priv);
sam_txreset(priv);
nlldbg("ERROR: Retry Limit Exceeded TSR: %08x\n", tsr);
regval = sam_getreg(priv, SAM_EMAC_NCR_OFFSET);
regval |= EMAC_NCR_TXEN;
sam_putreg(priv, SAM_EMAC_NCR_OFFSET, regval);
}
/* Check Collision Occurred (COL) */
if ((tsr & EMAC_TSR_COL) != 0)
{
nlldbg("ERROR: Collision occurred TSR: %08x\n", tsr);
clrbits |= EMAC_TSR_COL;
}
/* Check Transmit Frame Corruption due to AHB error (TFC) */
if ((tsr & EMAC_TSR_TFC) != 0)
{
nlldbg("ERROR: Transmit Frame Corruption due to AHB error: %08x\n", tsr);
clrbits |= EMAC_TSR_TFC;
}
/* Check for Transmit Underrun (UND)
*
* ISR:UND is set transmit DMA was not able to read data from memory,
* either because the bus was not granted in time, because a not
* OK hresp(bus error) was returned or because a used bit was read
* midway through frame transmission. If this occurs, the
* transmitter forces bad CRC. Cleared by writing a one to this bit.
*/
if ((tsr & EMAC_TSR_UND) != 0)
{
nlldbg("ERROR: Transmit Underrun TSR: %08x\n", tsr);
clrbits |= EMAC_TSR_UND;
}
/* Clear status */
sam_putreg(priv, SAM_EMAC_TSR_OFFSET, clrbits);
/* And handle the TX done event */
sam_txdone(priv);
}
/* Check for the receipt of an RX packet.
*
* RXCOMP indicates that a packet has been received and stored in memory.
* The RXCOMP bit is cleared when the interrupt status register was read.
* RSR:REC indicates that one or more frames have been received and placed
* in memory. This indication is cleared by writing a one to this bit.
*/
if ((pending & EMAC_INT_RCOMP) != 0 || (rsr & EMAC_RSR_REC) != 0)
{
clrbits = EMAC_RSR_REC;
/* Check for Receive Overrun.
*
* RSR:RXOVR will be set if the RX FIFO is not able to store the
* receive frame due to a FIFO overflow, or if the receive status
* was not taken at the end of the frame. This bit is also set in
* DMA packet buffer mode if the packet buffer overflows. For DMA
* operation, the buffer will be recovered if an overrun occurs. This
* bit is cleared when set to 1.
*/
if ((rsr & EMAC_RSR_RXOVR) != 0)
{
nlldbg("ERROR: Receiver overrun RSR: %08x\n", rsr);
clrbits |= EMAC_RSR_RXOVR;
}
/* Check for buffer not available (BNA)
*
* RSR:BNA means that an attempt was made to get a new buffer and the
* pointer indicated that it was owned by the processor. The DMA will
* reread the pointer each time an end of frame is received until a
* valid pointer is found. This bit is set following each descriptor
* read attempt that fails, even if consecutive pointers are
* unsuccessful and software has in the mean time cleared the status
* flag. Cleared by writing a one to this bit.
*/
if ((rsr & EMAC_RSR_BNA) != 0)
{
nlldbg("ERROR: Buffer not available RSR: %08x\n", rsr);
clrbits |= EMAC_RSR_BNA;
}
/* Clear status */
sam_putreg(priv, SAM_EMAC_RSR_OFFSET, clrbits);
/* Handle the received packet */
sam_receive(priv);
}
#ifdef CONFIG_DEBUG_NET
/* Check for PAUSE Frame received (PFRE).
*
* ISR:PFRE indicates that a pause frame has been received with non-zero
* pause quantum. Cleared on a read.
*/
if ((pending & EMAC_INT_PFNZ) != 0)
{
nlldbg("Pause frame received\n");
}
/* Check for Pause Time Zero (PTZ)
*
* ISR:PTZ is set Pause Time Zero
*/
if ((pending & EMAC_INT_PTZ) != 0)
{
nlldbg("Pause TO!\n");
}
#endif
return OK;
}
/****************************************************************************
* Function: sam_emac0/1_interrupt
*
* Description:
* EMAC hardware interrupt handler
*
* Parameters:
* irq - Number of the IRQ that generated the interrupt
* context - Interrupt register state save info (architecture-specific)
*
* Returned Value:
* OK on success
*
* Assumptions:
*
****************************************************************************/
#ifdef CONFIG_SAMA5_EMAC0
static int sam_emac0_interrupt(int irq, void *context)
{
return sam_emac_interrupt(&g_emac0);
}
#endif
#ifdef CONFIG_SAMA5_EMAC1
static int sam_emac1_interrupt(int irq, void *context)
{
return sam_emac_interrupt(&g_emac1);
}
#endif
/****************************************************************************
* Function: sam_txtimeout
*
* Description:
* Our TX watchdog timed out. Called from the timer interrupt handler.
* The last TX never completed. Reset the hardware and start again.
*
* Parameters:
* argc - The number of available arguments
* arg - The first argument
*
* Returned Value:
* None
*
* Assumptions:
* Global interrupts are disabled by the watchdog logic.
*
****************************************************************************/
static void sam_txtimeout(int argc, uint32_t arg, ...)
{
struct sam_emac_s *priv = (struct sam_emac_s *)arg;
nlldbg("Timeout!\n");
/* Then reset the hardware. Just take the interface down, then back
* up again.
*/
sam_ifdown(&priv->dev);
sam_ifup(&priv->dev);
/* Then poll uIP for new XMIT data */
sam_dopoll(priv);
}
/****************************************************************************
* Function: sam_polltimer
*
* Description:
* Periodic timer handler. Called from the timer interrupt handler.
*
* Parameters:
* argc - The number of available arguments
* arg - The first argument
*
* Returned Value:
* None
*
* Assumptions:
* Global interrupts are disabled by the watchdog logic.
*
****************************************************************************/
static void sam_polltimer(int argc, uint32_t arg, ...)
{
struct sam_emac_s *priv = (struct sam_emac_s *)arg;
struct net_driver_s *dev = &priv->dev;
/* Check if the there are any free TX descriptors. We cannot perform the
* TX poll if we do not have buffering for another packet.
*/
if (sam_txfree(priv) > 0)
{
/* Update TCP timing states and poll uIP for new XMIT data. */
(void)devif_timer(dev, sam_txpoll, SAM_POLLHSEC);
}
/* Setup the watchdog poll timer again */
(void)wd_start(priv->txpoll, SAM_WDDELAY, sam_polltimer, 1, arg);
}
/****************************************************************************
* Function: sam_ifup
*
* Description:
* NuttX Callback: Bring up the EMAC interface when an IP address is
* provided
*
* Parameters:
* dev - Reference to the NuttX driver state structure
*
* Returned Value:
* None
*
* Assumptions:
*
****************************************************************************/
static int sam_ifup(struct net_driver_s *dev)
{
struct sam_emac_s *priv = (struct sam_emac_s *)dev->d_private;
int ret;
nlldbg("Bringing up: %d.%d.%d.%d\n",
dev->d_ipaddr & 0xff, (dev->d_ipaddr >> 8) & 0xff,
(dev->d_ipaddr >> 16) & 0xff, dev->d_ipaddr >> 24);
/* Configure the EMAC interface for normal operation. */
nllvdbg("Initialize the EMAC\n");
sam_emac_configure(priv);
/* Set the MAC address (should have been configured while we were down) */
sam_macaddress(priv);
/* Initialize for PHY access */
ret = sam_phyinit(priv);
if (ret < 0)
{
nlldbg("ERROR: sam_phyinit failed: %d\n", ret);
return ret;
}
/* Auto Negotiate, working in RMII mode */
ret = sam_autonegotiate(priv);
if (ret < 0)
{
nlldbg("ERROR: sam_autonegotiate failed: %d\n", ret);
return ret;
}
while (sam_linkup(priv) == 0);
nllvdbg("Link detected \n");
/* Enable normal MAC operation */
nllvdbg("Enable normal operation\n");
/* Set and activate a timer process */
(void)wd_start(priv->txpoll, SAM_WDDELAY, sam_polltimer, 1, (uint32_t)priv);
/* Enable the EMAC interrupt */
priv->ifup = true;
up_enable_irq(priv->attr->irq);
return OK;
}
/****************************************************************************
* Function: sam_ifdown
*
* Description:
* NuttX Callback: Stop the interface.
*
* Parameters:
* dev - Reference to the NuttX driver state structure
*
* Returned Value:
* None
*
* Assumptions:
*
****************************************************************************/
static int sam_ifdown(struct net_driver_s *dev)
{
struct sam_emac_s *priv = (struct sam_emac_s *)dev->d_private;
irqstate_t flags;
nlldbg("Taking the network down\n");
/* Disable the EMAC interrupt */
flags = irqsave();
up_disable_irq(priv->attr->irq);
/* Cancel the TX poll timer and TX timeout timers */
wd_cancel(priv->txpoll);
wd_cancel(priv->txtimeout);
/* Put the EMAC in its reset, non-operational state. This should be
* a known configuration that will guarantee the sam_ifup() always
* successfully brings the interface back up.
*/
sam_emac_reset(priv);
/* Mark the device "down" */
priv->ifup = false;
irqrestore(flags);
return OK;
}
/****************************************************************************
* Function: sam_txavail
*
* Description:
* Driver callback invoked when new TX data is available. This is a
* stimulus perform an out-of-cycle poll and, thereby, reduce the TX
* latency.
*
* Parameters:
* dev - Reference to the NuttX driver state structure
*
* Returned Value:
* None
*
* Assumptions:
* Called in normal user mode
*
****************************************************************************/
static int sam_txavail(struct net_driver_s *dev)
{
struct sam_emac_s *priv = (struct sam_emac_s *)dev->d_private;
irqstate_t flags;
nllvdbg("ifup: %d\n", priv->ifup);
/* Disable interrupts because this function may be called from interrupt
* level processing.
*/
flags = irqsave();
/* Ignore the notification if the interface is not yet up */
if (priv->ifup)
{
/* Poll uIP for new XMIT data */
sam_dopoll(priv);
}
irqrestore(flags);
return OK;
}
/****************************************************************************
* Function: sam_addmac
*
* Description:
* NuttX Callback: Add the specified MAC address to the hardware multicast
* address filtering
*
* Parameters:
* dev - Reference to the NuttX driver state structure
* mac - The MAC address to be added
*
* Returned Value:
* None
*
* Assumptions:
*
****************************************************************************/
#ifdef CONFIG_NET_IGMP
static int sam_addmac(struct net_driver_s *dev, const uint8_t *mac)
{
struct sam_emac_s *priv = (struct sam_emac_s *)dev->d_private;
nllvdbg("MAC: %02x:%02x:%02x:%02x:%02x:%02x\n",
mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);
/* Add the MAC address to the hardware multicast routing table */
/* Add the MAC address to the hardware multicast routing table */
#error "Missing logic"
return OK;
}
#endif
/****************************************************************************
* Function: sam_rmmac
*
* Description:
* NuttX Callback: Remove the specified MAC address from the hardware multicast
* address filtering
*
* Parameters:
* dev - Reference to the NuttX driver state structure
* mac - The MAC address to be removed
*
* Returned Value:
* None
*
* Assumptions:
*
****************************************************************************/
#ifdef CONFIG_NET_IGMP
static int sam_rmmac(struct net_driver_s *dev, const uint8_t *mac)
{
struct sam_emac_s *priv = (struct sam_emac_s *)dev->d_private;
nllvdbg("MAC: %02x:%02x:%02x:%02x:%02x:%02x\n",
mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);
/* Add the MAC address to the hardware multicast routing table */
#error "Missing logic"
return OK;
}
#endif
/****************************************************************************
* Function: sam_ioctl
*
* Description:
* Handles driver ioctl calls:
*
* SIOCMIINOTIFY - Set up to received notifications from PHY interrupting
* events.
*
* SIOCGMIIPHY, SIOCGMIIREG, and SIOCSMIIREG:
* Executes the SIOCxMIIxxx command and responds using the request struct
* that must be provided as its 2nd parameter.
*
* When called with SIOCGMIIPHY it will get the PHY address for the device
* and write it to the req->phy_id field of the request struct.
*
* When called with SIOCGMIIREG it will read a register of the PHY that is
* specified using the req->reg_no struct field and then write its output
* to the req->val_out field.
*
* When called with SIOCSMIIREG it will write to a register of the PHY that
* is specified using the req->reg_no struct field and use req->val_in as
* its input.
*
* Parameters:
* dev - Ethernet device structure
* cmd - SIOCxMIIxxx command code
* arg - Request structure also used to return values
*
* Returned Value: Negated errno on failure.
*
* Assumptions:
*
****************************************************************************/
#ifdef CONFIG_NETDEV_PHY_IOCTL
static int sam_ioctl(struct net_driver_s *dev, int cmd, void *arg)
{
int ret;
switch (cmd)
{
#ifdef CONFIG_ARCH_PHY_INTERRUPT
case SIOCMIINOTIFY: /* Set up for PHY event notifications */
{
struct mii_iotcl_notify_s *req = (struct mii_iotcl_notify_s *)((uintptr_t)arg);
ret = phy_notify_subscribe(dev0->intf, req->pid, req->signo, req->arg);
}
break;
#endif
case SIOCGMIIPHY: /* Get MII PHY address */
{
struct mii_ioctl_data_s *req = (struct mii_ioctl_data_s *)((uintptr_t)arg);
req->phy_id = priv->phyaddr;
ret = OK;
}
break;
case SIOCGMIIREG: /* Get register from MII PHY */
{
struct mii_ioctl_data_s *req = (struct mii_ioctl_data_s *)((uintptr_t)arg);
ret = sam_phyread(priv, req->phy_id, req->reg_num, &req->val_out);
}
break;
case SIOCSMIIREG: /* Set register in MII PHY */
{
struct mii_ioctl_data_s *req = (struct mii_ioctl_data_s *)((uintptr_t)arg);
ret = sam_phywrite(priv, req->phy_id, req->reg_num, req->val_in);
}
break;
default:
ret = -ENOTTY;
break;
}
return ret;
}
#endif /* CONFIG_NETDEV_PHY_IOCTL */
/****************************************************************************
* Function: sam_phydump
*
* Description:
* Dump the contents of PHY registers
*
* Parameters:
* priv - A reference to the private driver state structure
*
* Returned Value:
* None
*
****************************************************************************/
#if defined(CONFIG_DEBUG_NET) && defined(CONFIG_DEBUG_VERBOSE)
static void sam_phydump(struct sam_emac_s *priv)
{
uint32_t regval;
uint16_t phyval;
/* Enable management port */
regval = sam_getreg(priv, SAM_EMAC_NCR_OFFSET);
regval |= EMAC_NCR_MPE;
sam_putreg(priv, SAM_EMAC_NCR_OFFSET, regval);
nllvdbg("%s Registers (Address %02x)\n",
priv->attr->rmii ? "RMII" : "MII", priv->phyaddr);
sam_phyread(priv, priv->phyaddr, MII_MCR, &phyval);
nllvdbg(" MCR: %04x\n", phyval);
sam_phyread(priv, priv->phyaddr, MII_MSR, &phyval);
nllvdbg(" MSR: %04x\n", phyval);
sam_phyread(priv, priv->phyaddr, MII_ADVERTISE, &phyval);
nllvdbg(" ADVERTISE: %04x\n", phyval);
sam_phyread(priv, priv->phyaddr, MII_LPA, &phyval);
nllvdbg(" LPR: %04x\n", phyval);
sam_phyread(priv, priv->phyaddr, priv->attr->physr, &phyval);
nllvdbg(" PHYSR: %04x\n", phyval);
/* Disable management port */
regval = sam_getreg(priv, SAM_EMAC_NCR_OFFSET);
regval &= ~EMAC_NCR_MPE;
sam_putreg(priv, SAM_EMAC_NCR_OFFSET, regval);
}
#endif
/****************************************************************************
* Function: sam_is*
*
* Description:
* Helpers to simplify decoding PHY status register bits
*
* Parameters:
* physr - The value of the PHY status register
*
* Returned Value:
* True: The PHY configuration is selected; False; some other PHY
* configuration is selected.
*
****************************************************************************/
#if 0 /* Not used */
static bool sam_is10hdx(struct sam_emac_s *priv, uint16_t physr)
{
uint16_t mask;
uint16_t match;
if (priv->attr->sralt)
{
mask = priv->attr->u.alt.altmask;
match = priv->attr->u.alt.hdx10;
}
else
{
mask = priv->attr->u.std.stdmask;
match = 0;
}
return (physr & mask) == match;
}
#endif
static bool sam_is100hdx(struct sam_emac_s *priv, uint16_t physr)
{
uint16_t mask;
uint16_t match;
if (priv->attr->sralt)
{
mask = priv->attr->u.alt.altmask;
match = priv->attr->u.alt.hdx100;
}
else
{
mask = priv->attr->u.std.stdmask;
match = priv->attr->u.std.speed100;
}
return (physr & mask) == match;
}
static bool sam_is10fdx(struct sam_emac_s *priv, uint16_t physr)
{
uint16_t mask;
uint16_t match;
if (priv->attr->sralt)
{
mask = priv->attr->u.alt.altmask;
match = priv->attr->u.alt.fdx10;
}
else
{
mask = priv->attr->u.std.stdmask;
match = priv->attr->u.std.fduplex;
}
return (physr & mask) == match;
}
static bool sam_is100fdx(struct sam_emac_s *priv, uint16_t physr)
{
uint16_t mask;
uint16_t match;
if (priv->attr->sralt)
{
mask = priv->attr->u.alt.altmask;
match = priv->attr->u.alt.fdx100;
}
else
{
mask = priv->attr->u.std.stdmask;
match = (priv->attr->u.std.fduplex | priv->attr->u.std.speed100);
}
return (physr & mask) == match;
}
/****************************************************************************
* Function: sam_phywait
*
* Description:
* Wait for the PHY to become IDLE
*
* Parameters:
* priv - A reference to the private driver state structure
*
* Returned Value:
* OK on success; Negated errno (-ETIMEDOUT) on failure.
*
****************************************************************************/
static int sam_phywait(struct sam_emac_s *priv)
{
volatile unsigned int retries;
/* Loop for the configured number of attempts */
for (retries = 0; retries < PHY_RETRY_MAX; retries++)
{
/* Is the PHY IDLE */
if ((sam_getreg(priv, SAM_EMAC_NSR_OFFSET) & EMAC_NSR_IDLE) != 0)
{
return OK;
}
}
return -ETIMEDOUT;
}
/****************************************************************************
* Function: sam_phyreset
*
* Description:
* Reset the PHY
*
* Parameters:
* priv - A reference to the private driver state structure
*
* Returned Value:
* OK on success; Negated errno on failure.
*
* Assumptions:
*
****************************************************************************/
static int sam_phyreset(struct sam_emac_s *priv)
{
uint32_t regval;
uint16_t mcr;
int timeout;
int ret;
nllvdbg(" sam_phyreset\n");
/* Enable management port */
regval = sam_getreg(priv, SAM_EMAC_NCR_OFFSET);
regval |= EMAC_NCR_MPE;
sam_putreg(priv, SAM_EMAC_NCR_OFFSET, regval);
/* Reset the PHY */
ret = sam_phywrite(priv, priv->phyaddr, MII_MCR, MII_MCR_RESET);
if (ret < 0)
{
nlldbg("ERROR: sam_phywrite failed: %d\n", ret);
}
/* Wait for the PHY reset to complete */
ret = -ETIMEDOUT;
for (timeout = 0; timeout < 10; timeout++)
{
mcr = MII_MCR_RESET;
int result = sam_phyread(priv, priv->phyaddr, MII_MCR, &mcr);
if (result < 0)
{
nlldbg("ERROR: Failed to read the MCR register: %d\n", ret);
ret = result;
}
else if ((mcr & MII_MCR_RESET) == 0)
{
ret = OK;
break;
}
}
/* Disable management port */
regval = sam_getreg(priv, SAM_EMAC_NCR_OFFSET);
regval &= ~EMAC_NCR_MPE;
sam_putreg(priv, SAM_EMAC_NCR_OFFSET, regval);
return ret;
}
/****************************************************************************
* Function: sam_phyfind
*
* Description:
* Verify the PHY address and, if it is bad, try to one that works.
*
* Parameters:
* priv - A reference to the private driver state structure
*
* Returned Value:
* OK on success; Negated errno on failure.
*
* Assumptions:
*
****************************************************************************/
static int sam_phyfind(struct sam_emac_s *priv, uint8_t *phyaddr)
{
uint32_t regval;
uint16_t phyval;
uint8_t candidate;
unsigned int offset;
int ret = -ESRCH;
nllvdbg("Find a valid PHY address\n");
/* Enable management port */
regval = sam_getreg(priv, SAM_EMAC_NCR_OFFSET);
regval |= EMAC_NCR_MPE;
sam_putreg(priv, SAM_EMAC_NCR_OFFSET, regval);
candidate = *phyaddr;
/* Check current candidate address */
ret = sam_phyread(priv, candidate, MII_PHYID1, &phyval);
if (ret == OK && phyval == priv->attr->msoui)
{
*phyaddr = candidate;
ret = OK;
}
/* The current address does not work... try another */
else
{
nlldbg("ERROR: sam_phyread failed for PHY address %02x: %d\n",
candidate, ret);
for (offset = 0; offset < 32; offset++)
{
/* Get the next candidate PHY address */
candidate = (candidate + 1) & 0x1f;
/* Try reading the PHY ID from the candidate PHY address */
ret = sam_phyread(priv, candidate, MII_PHYID1, &phyval);
if (ret == OK && phyval == priv->attr->msoui)
{
ret = OK;
break;
}
}
}
if (ret == OK)
{
nllvdbg(" PHYID1: %04x PHY addr: %d\n", phyval, candidate);
*phyaddr = candidate;
sam_phyread(priv, candidate, priv->attr->physr, &phyval);
nllvdbg(" PHYSR: %04x PHY addr: %d\n", phyval, candidate);
}
/* Disable management port */
regval = sam_getreg(priv, SAM_EMAC_NCR_OFFSET);
regval &= ~EMAC_NCR_MPE;
sam_putreg(priv, SAM_EMAC_NCR_OFFSET, regval);
return ret;
}
/****************************************************************************
* Function: sam_phyread
*
* Description:
* Read a PHY register.
*
* Parameters:
* priv - A reference to the private driver state structure
* phyaddr - The PHY device address
* regaddr - The PHY register address
* phyval - The location to return the 16-bit PHY register value.
*
* Returned Value:
* OK on success; Negated errno on failure.
*
* Assumptions:
*
****************************************************************************/
static int sam_phyread(struct sam_emac_s *priv, uint8_t phyaddr,
uint8_t regaddr, uint16_t *phyval)
{
uint32_t regval;
int ret;
/* Make sure that the PHY is idle */
ret = sam_phywait(priv);
if (ret < 0)
{
nlldbg("ERROR: sam_phywait failed: %d\n", ret);
return ret;
}
/* Write the PHY Maintenance register */
regval = EMAC_MAN_DATA(0) | EMAC_MAN_WTN | EMAC_MAN_REGA(regaddr) |
EMAC_MAN_PHYA(phyaddr) | EMAC_MAN_READ | EMAC_MAN_WZO;
if (!priv->attr->clause45)
{
/* CLTTO must be set for Clause 22 operation. To read clause 45 PHYs,
* bit 30 should be written with a 0 rather than a 1.
*/
regval |= EMAC_MAN_CLTTO;
}
sam_putreg(priv, SAM_EMAC_MAN_OFFSET, regval);
/* Wait until the PHY is again idle */
ret = sam_phywait(priv);
if (ret < 0)
{
nlldbg("ERROR: sam_phywait failed: %d\n", ret);
return ret;
}
/* Return data */
*phyval = (uint16_t)(sam_getreg(priv, SAM_EMAC_MAN_OFFSET) & EMAC_MAN_DATA_MASK);
return OK;
}
/****************************************************************************
* Function: sam_phywrite
*
* Description:
* Write to a PHY register.
*
* Parameters:
* priv - A reference to the private driver state structure
* phyaddr - The PHY device address
* regaddr - The PHY register address
* phyval - The 16-bit value to write to the PHY register.
*
* Returned Value:
* OK on success; Negated errno on failure.
*
* Assumptions:
*
****************************************************************************/
static int sam_phywrite(struct sam_emac_s *priv, uint8_t phyaddr,
uint8_t regaddr, uint16_t phyval)
{
uint32_t regval;
int ret;
/* Make sure that the PHY is idle */
ret = sam_phywait(priv);
if (ret < 0)
{
nlldbg("ERROR: sam_phywait failed: %d\n", ret);
return ret;
}
/* Write the PHY Maintenance register */
regval = EMAC_MAN_DATA(phyval) | EMAC_MAN_WTN | EMAC_MAN_REGA(regaddr) |
EMAC_MAN_PHYA(phyaddr) | EMAC_MAN_WRITE | EMAC_MAN_WZO;
if (!priv->attr->clause45)
{
/* CLTTO must be set for Clause 22 operation. To read clause 45 PHYs,
* bit 30 should be written with a 0 rather than a 1.
*/
regval |= EMAC_MAN_CLTTO;
}
sam_putreg(priv, SAM_EMAC_MAN_OFFSET, regval);
/* Wait until the PHY is again IDLE */
ret = sam_phywait(priv);
if (ret < 0)
{
nlldbg("ERROR: sam_phywait failed: %d\n", ret);
return ret;
}
return OK;
}
/****************************************************************************
* Function: sam_autonegotiate
*
* Description:
* Autonegotiate speed and duplex.
*
* Parameters:
* priv - A reference to the private driver state structure
*
* Returned Value:
* OK on success; Negated errno on failure.
*
****************************************************************************/
static int sam_autonegotiate(struct sam_emac_s *priv)
{
uint32_t regval;
uint16_t phyid1;
uint16_t phyid2;
uint16_t mcr;
uint16_t msr;
uint16_t advertise;
uint16_t lpa;
int timeout;
int ret;
/* Enable management port */
regval = sam_getreg(priv, SAM_EMAC_NCR_OFFSET);
regval |= EMAC_NCR_MPE;
sam_putreg(priv, SAM_EMAC_NCR_OFFSET, regval);
/* Verify tht we can read the PHYID register */
ret = sam_phyread(priv, priv->phyaddr, MII_PHYID1, &phyid1);
if (ret < 0)
{
nlldbg("ERROR: Failed to read PHYID1\n");
goto errout;
}
nllvdbg("PHYID1: %04x PHY address: %02x\n", phyid1, priv->phyaddr);
ret = sam_phyread(priv, priv->phyaddr, MII_PHYID2, &phyid2);
if (ret < 0)
{
nlldbg("ERROR: Failed to read PHYID2\n");
goto errout;
}
nllvdbg("PHYID2: %04x PHY address: %02x\n", phyid2, priv->phyaddr);
if (phyid1 == priv->attr->msoui &&
((phyid2 & MII_PHYID2_OUI_MASK) >> MII_PHYID2_OUI_SHIFT) ==
(uint16_t)priv->attr->lsoui)
{
nllvdbg(" Vendor Model Number: %04x\n",
(phyid2 & MII_PHYID2_MODEL_MASK) >> MII_PHYID2_MODEL_SHIFT);
nllvdbg(" Model Revision Number: %04x\n",
(phyid2 & MII_PHYID2_REV_MASK) >> MII_PHYID2_REV_SHIFT);
}
else
{
nlldbg("ERROR: PHY not recognized\n");
}
/* Setup control register */
ret = sam_phyread(priv, priv->phyaddr, MII_MCR, &mcr);
if (ret < 0)
{
nlldbg("ERROR: Failed to read MCR\n");
goto errout;
}
mcr &= ~MII_MCR_ANENABLE; /* Remove autonegotiation enable */
mcr &= ~(MII_MCR_LOOPBACK | MII_MCR_PDOWN);
mcr |= MII_MCR_ISOLATE; /* Electrically isolate PHY */
ret = sam_phywrite(priv, priv->phyaddr, MII_MCR, mcr);
if (ret < 0)
{
nlldbg("ERROR: Failed to write MCR\n");
goto errout;
}
/* Set the Auto_negotiation Advertisement Register MII advertising for
* Next page 100BaseTxFD and HD, 10BaseTFD and HD, IEEE 802.3
*/
advertise = MII_ADVERTISE_100BASETXFULL | MII_ADVERTISE_100BASETXHALF |
MII_ADVERTISE_10BASETXFULL | MII_ADVERTISE_10BASETXHALF |
MII_ADVERTISE_8023;
ret = sam_phywrite(priv, priv->phyaddr, MII_ADVERTISE, advertise);
if (ret < 0)
{
nlldbg("ERROR: Failed to write ANAR\n");
goto errout;
}
/* Read and modify control register */
ret = sam_phyread(priv, priv->phyaddr, MII_MCR, &mcr);
if (ret < 0)
{
nlldbg("ERROR: Failed to read MCR\n");
goto errout;
}
mcr |= (MII_MCR_SPEED100 | MII_MCR_ANENABLE | MII_MCR_FULLDPLX);
ret = sam_phywrite(priv, priv->phyaddr, MII_MCR, mcr);
if (ret < 0)
{
nlldbg("ERROR: Failed to write MCR\n");
goto errout;
}
/* Restart Auto_negotiation */
mcr |= MII_MCR_ANRESTART;
mcr &= ~MII_MCR_ISOLATE;
ret = sam_phywrite(priv, priv->phyaddr, MII_MCR, mcr);
if (ret < 0)
{
nlldbg("ERROR: Failed to write MCR\n");
goto errout;
}
nllvdbg(" MCR: %04x\n", mcr);
/* Check AutoNegotiate complete */
timeout = 0;
for (;;)
{
ret = sam_phyread(priv, priv->phyaddr, MII_MSR, &msr);
if (ret < 0)
{
nlldbg("ERROR: Failed to read MSR\n");
goto errout;
}
/* Completed successfully? */
if ((msr & MII_MSR_ANEGCOMPLETE) != 0)
{
/* Yes.. break out of the loop */
nllvdbg("AutoNegotiate complete\n");
break;
}
/* No.. check for a timeout */
if (++timeout >= PHY_RETRY_MAX)
{
nlldbg("ERROR: TimeOut\n");
sam_phydump(priv);
ret = -ETIMEDOUT;
goto errout;
}
}
/* Get the AutoNeg Link partner base page */
ret = sam_phyread(priv, priv->phyaddr, MII_LPA, &lpa);
if (ret < 0)
{
nlldbg("ERROR: Failed to read ANLPAR\n");
goto errout;
}
/* Setup the EMAC link speed */
regval = sam_getreg(priv, SAM_EMAC_NCFGR_OFFSET);
regval &= ~(EMAC_NCFGR_SPD | EMAC_NCFGR_FD);
if (((advertise & lpa) & MII_ADVERTISE_100BASETXFULL) != 0)
{
/* Set MII for 100BaseTX and Full Duplex */
regval |= (EMAC_NCFGR_SPD | EMAC_NCFGR_FD);
}
else if (((advertise & lpa) & MII_ADVERTISE_10BASETXFULL) != 0)
{
/* Set MII for 10BaseT and Full Duplex */
regval |= EMAC_NCFGR_FD;
}
else if (((advertise & lpa) & MII_ADVERTISE_100BASETXHALF) != 0)
{
/* Set MII for 100BaseTX and half Duplex */
regval |= EMAC_NCFGR_SPD;
}
#if 0
else if (((advertise & lpa) & MII_ADVERTISE_10BASETXHALF) != 0)
{
/* set MII for 10BaseT and half Duplex */
}
#endif
sam_putreg(priv, SAM_EMAC_NCFGR_OFFSET, regval);
/* Select RMII/MII */
regval = sam_getreg(priv, SAM_EMAC_UR_OFFSET);
regval &= ~EMAC_UR_RMII; /* Assume MII */
if (priv->attr->rmii)
{
/* Not MII, select RMII */
regval |= EMAC_UR_RMII;
}
sam_putreg(priv, SAM_EMAC_UR_OFFSET, regval);
errout:
/* Disable management port */
regval = sam_getreg(priv, SAM_EMAC_NCR_OFFSET);
regval &= ~EMAC_NCR_MPE;
sam_putreg(priv, SAM_EMAC_NCR_OFFSET, regval);
return ret;
}
/****************************************************************************
* Function: sam_linkup
*
* Description:
* Check if the link is up
*
* Parameters:
* priv - A reference to the private driver state structure
*
* Returned Value:
* true: The link is up
*
****************************************************************************/
static bool sam_linkup(struct sam_emac_s *priv)
{
uint32_t regval;
uint16_t msr;
uint16_t physr;
bool linkup = false;
int ret;
/* Enable management port */
regval = sam_getreg(priv, SAM_EMAC_NCR_OFFSET);
regval |= EMAC_NCR_MPE;
sam_putreg(priv, SAM_EMAC_NCR_OFFSET, regval);
ret = sam_phyread(priv, priv->phyaddr, MII_MSR, &msr);
if (ret < 0)
{
nlldbg("ERROR: Failed to read MSR: %d\n", ret);
goto errout;
}
if ((msr & MII_MSR_LINKSTATUS) == 0)
{
nlldbg("ERROR: MSR LinkStatus: %04x\n", msr);
goto errout;
}
/* Re-configure Link speed */
ret = sam_phyread(priv, priv->phyaddr, priv->attr->physr, &physr);
if (ret < 0)
{
nlldbg("ERROR: Failed to read PHYSR: %d\n", ret);
goto errout;
}
regval = sam_getreg(priv, SAM_EMAC_NCFGR_OFFSET);
regval &= ~(EMAC_NCFGR_SPD | EMAC_NCFGR_FD);
if ((msr & MII_MSR_100BASETXFULL) != 0 && sam_is100fdx(priv, physr))
{
/* Set EMAC for 100BaseTX and Full Duplex */
regval |= (EMAC_NCFGR_SPD | EMAC_NCFGR_FD);
}
else if ((msr & MII_MSR_10BASETXFULL) != 0 && sam_is10fdx(priv, physr))
{
/* Set MII for 10BaseT and Full Duplex */
regval |= EMAC_NCFGR_FD;
}
else if ((msr & MII_MSR_100BASETXHALF) != 0 && sam_is100hdx(priv, physr))
{
/* Set MII for 100BaseTX and Half Duplex */
regval |= EMAC_NCFGR_SPD;
}
#if 0
else if ((msr & MII_MSR_10BASETXHALF) != 0 && sam_is10hdx(priv, physr))
{
/* Set MII for 10BaseT and Half Duplex */
}
#endif
sam_putreg(priv, SAM_EMAC_NCFGR_OFFSET, regval);
/* Start the EMAC transfers */
nllvdbg("Link is up\n");
linkup = true;
errout:
/* Disable management port */
regval = sam_getreg(priv, SAM_EMAC_NCR_OFFSET);
regval &= ~EMAC_NCR_MPE;
sam_putreg(priv, SAM_EMAC_NCR_OFFSET, regval);
return linkup;
}
/****************************************************************************
* Function: sam_phyinit
*
* Description:
* Configure the PHY and determine the link speed/duplex.
*
* Parameters:
* priv - A reference to the private driver state structure
*
* Returned Value:
* OK on success; Negated errno on failure.
*
****************************************************************************/
static int sam_phyinit(struct sam_emac_s *priv)
{
uint32_t regval;
uint32_t mck;
int ret;
/* Configure PHY clocking */
regval = sam_getreg(priv, SAM_EMAC_NCFGR_OFFSET);
regval &= ~EMAC_NCFGR_CLK_MASK;
mck = BOARD_MCK_FREQUENCY;
if (mck > (160*1000*1000))
{
ndbg("ERROR: Cannot realize PHY clock\n");
return -EINVAL;
}
else if (mck > (80*1000*1000))
{
regval |= EMAC_NCFGR_CLK_DIV64; /* MCK divided by 64 (MCK up to 160 MHz) */
}
else if (mck > (40*1000*1000))
{
regval |= EMAC_NCFGR_CLK_DIV32; /* MCK divided by 32 (MCK up to 80 MHz) */
}
else if (mck > (20*1000*1000))
{
regval |= EMAC_NCFGR_CLK_DIV16; /* MCK divided by 16 (MCK up to 40 MHz) */
}
else
{
regval |= EMAC_NCFGR_CLK_DIV8; /* MCK divided by 8 (MCK up to 20 MHz) */
}
sam_putreg(priv, SAM_EMAC_NCFGR_OFFSET, regval);
/* Check the PHY Address */
priv->phyaddr = priv->attr->phyaddr;
ret = sam_phyfind(priv, &priv->phyaddr);
if (ret < 0)
{
nlldbg("ERROR: sam_phyfind failed: %d\n", ret);
return ret;
}
if (priv->phyaddr != priv->attr->phyaddr)
{
sam_phyreset(priv);
}
return OK;
}
/****************************************************************************
* Function: sam_ethgpioconfig
*
* Description:
* Configure PIOs for the EMAC0/1 RMII/MII interface.
*
* Signal Name Function MII RMII
* -------- --------------------------------- -------- -----------
* TXCK Transmit Clock or Reference Clock TXCK REFCK
* TXEN Transmit Enable TXEN TXEN
* TX[3..0] Transmit Data TXD[3:0] TXD[1:0]
* TXER Transmit Coding Error TXER Not Used
* RXCK Receive Clock RXCK Not Used
* RXDV Receive Data Valid RXDV CRSDV
* RX[3..0] Receive Data RXD[3:0] RXD[1:0]
* RXER Receive Error RXER RXER
* CRS Carrier Sense and Data Valid CRS Not Used
* COL Collision Detect COL Not Used
* MDC Management Data Clock MDC MDC
* MDIO Management Data Input/Output MDIO MDIO
*
* Parameters:
* priv - A reference to the private driver state structure
*
* Returned Value:
* None.
*
* Assumptions:
*
****************************************************************************/
static inline void sam_ethgpioconfig(struct sam_emac_s *priv)
{
#if defined(CONFIG_SAMA5_EMAC0)
/* Configure EMAC0 PIO pins */
if (priv->attr->emac == 0)
{
/* Configure PIO pins common to RMII and MII mode*/
sam_configpio(PIO_EMAC0_TXCK); /* Transmit Clock (or Reference Clock) */
sam_configpio(PIO_EMAC0_TXEN); /* Transmit Enable */
sam_configpio(PIO_EMAC0_TX0); /* Transmit data TXD0 */
sam_configpio(PIO_EMAC0_TX1); /* Transmit data TXD1 */
sam_configpio(PIO_EMAC0_RXDV); /* Receive Data Valid */
sam_configpio(PIO_EMAC0_RX0); /* Receive data RXD0 */
sam_configpio(PIO_EMAC0_RX1); /* Receive data RXD0 */
sam_configpio(PIO_EMAC0_RXER); /* Receive Error */
sam_configpio(PIO_EMAC0_MDC); /* Management Data Clock */
sam_configpio(PIO_EMAC0_MDIO); /* Management Data Input/Output */
/* Configure additional PIO pins to support EMAC in MII mode*/
if (!priv->attr->rmii)
{
sam_configpio(PIO_EMAC0_TX2); /* Transmit data TXD2 */
sam_configpio(PIO_EMAC0_TX3); /* Transmit data TXD3 */
sam_configpio(PIO_EMAC0_TXER); /* Transmit Coding Error */
sam_configpio(PIO_EMAC0_RXCK); /* Receive Clock */
sam_configpio(PIO_EMAC0_RX2); /* Receive data RXD0 */
sam_configpio(PIO_EMAC0_RX3); /* Receive data RXD0 */
sam_configpio(PIO_EMAC0_CRS); /* Carrier Sense and Data Valid */
sam_configpio(PIO_EMAC0_COL); /* Collision Detect */
}
}
#endif
#if defined(CONFIG_SAMA5_EMAC0)
/* Configure EMAC0 PIO pins */
if (priv->attr->emac == 1)
{
/* Configure PIO pins common to RMII and MII mode*/
sam_configpio(PIO_EMAC1_TXCK); /* Transmit Clock (or Reference Clock) */
sam_configpio(PIO_EMAC1_TXEN); /* Transmit Enable */
sam_configpio(PIO_EMAC1_TX0); /* Transmit data TXD0 */
sam_configpio(PIO_EMAC1_TX1); /* Transmit data TXD1 */
sam_configpio(PIO_EMAC1_RXDV); /* Receive Data Valid */
sam_configpio(PIO_EMAC1_RX0); /* Receive data RXD0 */
sam_configpio(PIO_EMAC1_RX1); /* Receive data RXD0 */
sam_configpio(PIO_EMAC1_RXER); /* Receive Error */
sam_configpio(PIO_EMAC1_MDC); /* Management Data Clock */
sam_configpio(PIO_EMAC1_MDIO); /* Management Data Input/Output */
/* Configure additional PIO pins to support EMAC in MII mode*/
if (!priv->attr->rmii)
{
sam_configpio(PIO_EMAC1_TX2); /* Transmit data TXD2 */
sam_configpio(PIO_EMAC1_TX3); /* Transmit data TXD3 */
sam_configpio(PIO_EMAC1_TXER); /* Transmit Coding Error */
sam_configpio(PIO_EMAC1_RXCK); /* Receive Clock */
sam_configpio(PIO_EMAC1_RX2); /* Receive data RXD0 */
sam_configpio(PIO_EMAC1_RX3); /* Receive data RXD0 */
sam_configpio(PIO_EMAC1_CRS); /* Carrier Sense and Data Valid */
sam_configpio(PIO_EMAC1_COL); /* Collision Detect */
}
}
#endif
}
/****************************************************************************
* Function: sam_txreset
*
* Description:
* Reset the transmit logic
*
* Parameters:
* priv - A reference to the private driver state structure
*
* Returned Value:
* None.
*
* Assumptions:
*
****************************************************************************/
static void sam_txreset(struct sam_emac_s *priv)
{
uint8_t *txbuffer = priv->txbuffer;
struct emac_txdesc_s *txdesc = priv->txdesc;
uintptr_t bufaddr;
uint32_t physaddr;
uint32_t regval;
int ndx;
/* Disable TX */
regval = sam_getreg(priv, SAM_EMAC_NCR_OFFSET);
regval &= ~EMAC_NCR_TXEN;
sam_putreg(priv, SAM_EMAC_NCR_OFFSET, regval);
/* Configure the TX descriptors. */
priv->txhead = 0;
priv->txtail = 0;
for (ndx = 0; ndx < priv->attr->ntxbuffers; ndx++)
{
bufaddr = (uint32_t)(&(txbuffer[ndx * EMAC_TX_UNITSIZE]));
/* Set the buffer address and mark the descriptor as in used by firmware */
physaddr = sam_physramaddr(bufaddr);
txdesc[ndx].addr = physaddr;
txdesc[ndx].status = EMACTXD_STA_USED;
}
/* Mark the final descriptor in the list */
txdesc[priv->attr->ntxbuffers - 1].status =
EMACTXD_STA_USED | EMACTXD_STA_WRAP;
/* Flush the entire TX descriptor table to RAM */
arch_clean_dcache((uintptr_t)txdesc,
(uintptr_t)txdesc +
priv->attr->ntxbuffers * sizeof(struct emac_txdesc_s));
/* Set the Transmit Buffer Queue Pointer Register */
physaddr = sam_physramaddr((uintptr_t)txdesc);
sam_putreg(priv, SAM_EMAC_TBQB_OFFSET, physaddr);
}
/****************************************************************************
* Function: sam_rxreset
*
* Description:
* Reset the receive logic
*
* Parameters:
* priv - A reference to the private driver state structure
*
* Returned Value:
* None.
*
* Assumptions:
*
****************************************************************************/
static void sam_rxreset(struct sam_emac_s *priv)
{
struct emac_rxdesc_s *rxdesc = priv->rxdesc;
uint8_t *rxbuffer = priv->rxbuffer;
uint32_t bufaddr;
uint32_t physaddr;
uint32_t regval;
int ndx;
/* Disable RX */
regval = sam_getreg(priv, SAM_EMAC_NCR_OFFSET);
regval &= ~EMAC_NCR_RXEN;
sam_putreg(priv, SAM_EMAC_NCR_OFFSET, regval);
/* Configure the RX descriptors. */
priv->rxndx = 0;
for (ndx = 0; ndx < priv->attr->nrxbuffers; ndx++)
{
bufaddr = (uintptr_t)(&(rxbuffer[ndx * EMAC_RX_UNITSIZE]));
DEBUGASSERT((bufaddr & ~EMACRXD_ADDR_MASK) == 0);
/* Set the buffer address and remove EMACRXD_ADDR_OWNER and
* EMACRXD_ADDR_WRAP.
*/
physaddr = sam_physramaddr(bufaddr);
rxdesc[ndx].addr = physaddr;
rxdesc[ndx].status = 0;
}
/* Mark the final descriptor in the list */
rxdesc[priv->attr->nrxbuffers - 1].addr |= EMACRXD_ADDR_WRAP;
/* Flush the entire RX descriptor table to RAM */
arch_clean_dcache((uintptr_t)rxdesc,
(uintptr_t)rxdesc +
priv->attr->nrxbuffers * sizeof(struct emac_rxdesc_s));
/* Set the Receive Buffer Queue Pointer Register */
physaddr = sam_physramaddr((uintptr_t)rxdesc);
sam_putreg(priv, SAM_EMAC_RBQB_OFFSET, physaddr);
}
/****************************************************************************
* Function: sam_emac_enableclk
*
* Description:
* Enable clocking to the EMAC block
*
* Parameters:
* priv - A reference to the private driver state structure
*
* Returned Value:
* None.
*
* Assumptions:
*
****************************************************************************/
static void sam_emac_enableclk(struct sam_emac_s *priv)
{
#if defined(CONFIG_SAMA5_EMAC0) && defined(CONFIG_SAMA5_EMAC1)
/* Both EMAC blocks are selected, which are we enabling? */
if (priv->attr->emac == 0)
{
sam_emac0_enableclk();
}
else
{
sam_emac1_enableclk();
}
#elif defined(CONFIG_SAMA5_EMAC0)
/* Only EMAC0 is selected */
sam_emac0_enableclk();
#else
/* Only EMAC1 is selected */
sam_emac1_enableclk();
#endif
}
/****************************************************************************
* Function: sam_emac_disableclk
*
* Description:
* Disable clocking to the EMAC block
*
* Parameters:
* priv - A reference to the private driver state structure
*
* Returned Value:
* None.
*
* Assumptions:
*
****************************************************************************/
static void sam_emac_disableclk(struct sam_emac_s *priv)
{
#if defined(CONFIG_SAMA5_EMAC0) && defined(CONFIG_SAMA5_EMAC1)
/* Both EMAC blocks are selected, which are we disabling? */
if (priv->attr->emac == 0)
{
sam_emac0_disableclk();
}
else
{
sam_emac1_disableclk();
}
#elif defined(CONFIG_SAMA5_EMAC0)
/* Only EMAC0 is selected */
sam_emac0_disableclk();
#else
/* Only EMAC1 is selected */
sam_emac1_disableclk();
#endif
}
/****************************************************************************
* Function: sam_emac_reset
*
* Description:
* Reset the EMAC block.
*
* Parameters:
* priv - A reference to the private driver state structure
*
* Returned Value:
* None.
*
* Assumptions:
*
****************************************************************************/
static void sam_emac_reset(struct sam_emac_s *priv)
{
/* Disable all EMAC interrupts */
sam_putreg(priv, SAM_EMAC_IDR_OFFSET, EMAC_INT_ALL);
/* Reset RX and TX logic */
sam_rxreset(priv);
sam_txreset(priv);
/* Make sure that RX and TX are disabled; clear statistics registers */
sam_putreg(priv, SAM_EMAC_NCR_OFFSET, EMAC_NCR_CLRSTAT);
/* Disable clocking to the EMAC peripheral */
sam_emac_disableclk(priv);
}
/****************************************************************************
* Function: sam_macaddress
*
* Description:
* Configure the selected MAC address.
*
* Parameters:
* priv - A reference to the private driver state structure
*
* Returned Value:
* OK on success; Negated errno on failure.
*
* Assumptions:
*
****************************************************************************/
static void sam_macaddress(struct sam_emac_s *priv)
{
struct net_driver_s *dev = &priv->dev;
uint32_t regval;
nllvdbg("%s MAC: %02x:%02x:%02x:%02x:%02x:%02x\n",
dev->d_ifname,
dev->d_mac.ether_addr_octet[0], dev->d_mac.ether_addr_octet[1],
dev->d_mac.ether_addr_octet[2], dev->d_mac.ether_addr_octet[3],
dev->d_mac.ether_addr_octet[4], dev->d_mac.ether_addr_octet[5]);
/* Set the MAC address */
regval = (uint32_t)dev->d_mac.ether_addr_octet[0] |
(uint32_t)dev->d_mac.ether_addr_octet[1] << 8 |
(uint32_t)dev->d_mac.ether_addr_octet[2] << 16 |
(uint32_t)dev->d_mac.ether_addr_octet[3] << 24;
sam_putreg(priv, SAM_EMAC_SAB1_OFFSET, regval);
regval = (uint32_t)dev->d_mac.ether_addr_octet[4] |
(uint32_t)dev->d_mac.ether_addr_octet[5] << 8;
sam_putreg(priv, SAM_EMAC_SAT1_OFFSET, regval);
}
/****************************************************************************
* Function: sam_emac_configure
*
* Description:
* Configure the EMAC interface for normal operation.
*
* Parameters:
* priv - A reference to the private driver state structure
*
* Returned Value:
* OK on success; Negated errno on failure.
*
* Assumptions:
*
****************************************************************************/
static int sam_emac_configure(struct sam_emac_s *priv)
{
uint32_t regval;
nllvdbg("Entry\n");
/* Enable clocking to the EMAC peripheral */
sam_emac_enableclk(priv);
/* Disable TX, RX, clear statistics. Disable all interrupts. */
sam_putreg(priv, SAM_EMAC_NCR_OFFSET, EMAC_NCR_CLRSTAT);
sam_putreg(priv, SAM_EMAC_IDR_OFFSET, EMAC_INT_ALL);
/* Clear all status bits in the receive status register. */
regval = (EMAC_RSR_RXOVR | EMAC_RSR_REC | EMAC_RSR_BNA);
sam_putreg(priv, SAM_EMAC_RSR_OFFSET, regval);
/* Clear all status bits in the transmit status register */
regval = (EMAC_TSR_UBR | EMAC_TSR_COL | EMAC_TSR_RLE | EMAC_TSR_TFC |
EMAC_TSR_TXCOMP | EMAC_TSR_UND);
sam_putreg(priv, SAM_EMAC_TSR_OFFSET, regval);
/* Clear any pending interrupts */
(void)sam_getreg(priv, SAM_EMAC_ISR_OFFSET);
/* Enable/disable the copy of data into the buffers, ignore broadcasts.
* Don't copy FCS.
*/
regval = sam_getreg(priv, SAM_EMAC_NCFGR_OFFSET);
regval |= (EMAC_NCFGR_RFCS | EMAC_NCFGR_PEN);
#ifdef CONFIG_NET_PROMISCUOUS
regval |= EMAC_NCFGR_CAF;
#else
regval &= ~EMAC_NCFGR_CAF;
#endif
#ifdef CONFIG_SAMA5_EMACB_NBC
regval |= EMAC_NCFGR_NBC;
#else
regval &= ~EMAC_NCFGR_NBC;
#endif
sam_putreg(priv, SAM_EMAC_NCFGR_OFFSET, regval);
/* Reset TX and RX */
sam_rxreset(priv);
sam_txreset(priv);
/* Enable Rx and Tx, plus the statistics registers. */
regval = sam_getreg(priv, SAM_EMAC_NCR_OFFSET);
regval |= (EMAC_NCR_RXEN | EMAC_NCR_TXEN | EMAC_NCR_WESTAT);
sam_putreg(priv, SAM_EMAC_NCR_OFFSET, regval);
/* Setup the interrupts for TX events, RX events, and error events */
regval = (EMAC_INT_RCOMP | EMAC_INT_RXUBR | EMAC_INT_TUR | EMAC_INT_RLEX |
EMAC_INT_TFC | EMAC_INT_TCOMP | EMAC_INT_ROVR | EMAC_INT_HRESP |
EMAC_INT_PFNZ | EMAC_INT_PTZ);
sam_putreg(priv, SAM_EMAC_IER_OFFSET, regval);
return OK;
}
/****************************************************************************
* Public Functions
****************************************************************************/
/****************************************************************************
* Function: sam_emac_initialize
*
* Description:
* Initialize the EMAC driver.
*
* Input Parameters:
* None
*
* Returned Value:
* OK on success; Negated errno on failure.
*
* Assumptions:
* Called very early in the initialization sequence.
*
****************************************************************************/
int sam_emac_initialize(int intf)
{
struct sam_emac_s *priv;
const struct sam_emacattr_s *attr;
int ret;
#if defined(CONFIG_SAMA5_EMAC0)
if (intf == EMAC0_INTF)
{
priv = &g_emac0;
attr = &g_emac0_attr;
}
else
#endif
#if defined(CONFIG_SAMA5_EMAC1)
if (intf == EMAC1_INTF)
{
priv = &g_emac1;
attr = &g_emac1_attr;
}
else
#endif
{
ndbg("ERROR: Interface %d not supported\n", intf);
return -EINVAL;
}
/* Initialize the driver structure */
memset(priv, 0, sizeof(struct sam_emac_s));
priv->attr = attr; /* Save the constant attributes */
priv->dev.d_ifup = sam_ifup; /* I/F up (new IP address) callback */
priv->dev.d_ifdown = sam_ifdown; /* I/F down callback */
priv->dev.d_txavail = sam_txavail; /* New TX data callback */
#ifdef CONFIG_NET_IGMP
priv->dev.d_addmac = sam_addmac; /* Add multicast MAC address */
priv->dev.d_rmmac = sam_rmmac; /* Remove multicast MAC address */
#endif
#ifdef CONFIG_NETDEV_PHY_IOCTL
priv->dev.d_ioctl = sam_ioctl; /* Support PHY ioctl() calls */
#endif
priv->dev.d_private = priv; /* Used to recover private state from dev */
/* Create a watchdog for timing polling for and timing of transmissions */
priv->txpoll = wd_create();
if (!priv->txpoll)
{
ndbg("ERROR: Failed to create periodic poll timer\n");
ret = -EAGAIN;
goto errout;
}
priv->txtimeout = wd_create(); /* Create TX timeout timer */
if (!priv->txpoll)
{
ndbg("ERROR: Failed to create periodic poll timer\n");
ret = -EAGAIN;
goto errout_with_txpoll;
}
/* Configure PIO pins to support EMAC */
sam_ethgpioconfig(priv);
/* Allocate buffers */
ret = sam_buffer_initialize(priv);
if (ret < 0)
{
ndbg("ERROR: sam_buffer_initialize failed: %d\n", ret);
goto errout_with_txtimeout;
}
/* Attach the IRQ to the driver. It will not be enabled at the AIC until
* the interface is in the 'up' state.
*/
ret = irq_attach(priv->attr->irq, priv->attr->handler);
if (ret < 0)
{
ndbg("ERROR: Failed to attach the handler to the IRQ%d\n", priv->attr->irq);
goto errout_with_buffers;
}
/* Enable clocking to the EMAC peripheral (just for sam_ifdown()) */
sam_emac_enableclk(priv);
/* Put the interface in the down state (disabling clocking again). */
ret = sam_ifdown(&priv->dev);
if (ret < 0)
{
ndbg("ERROR: Failed to put the interface in the down state: %d\n", ret);
goto errout_with_buffers;
}
/* Register the device with the OS so that socket IOCTLs can be performed */
ret = netdev_register(&priv->dev);
if (ret >= 0)
{
return ret;
}
ndbg("ERROR: netdev_register() failed: %d\n", ret);
errout_with_buffers:
sam_buffer_free(priv);
errout_with_txtimeout:
wd_delete(priv->txtimeout);
errout_with_txpoll:
wd_delete(priv->txpoll);
errout:
return ret;
}
#endif /* CONFIG_NET && CONFIG_SAMA5_EMACB */
|