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
|
/* Copyright (c) 2008-2012 Freescale Semiconductor, Inc
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * 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.
* * Neither the name of Freescale Semiconductor nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
*
* ALTERNATIVELY, this software may be distributed under the terms of the
* GNU General Public License ("GPL") as published by the Free Software
* Foundation, either version 2 of that License or (at your option) any
* later version.
*
* THIS SOFTWARE IS PROVIDED BY Freescale Semiconductor ``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 Freescale Semiconductor 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.
*/
/**************************************************************************//**
@File fm_pcd_ext.h
@Description FM PCD API definitions
*//***************************************************************************/
#ifndef __FM_PCD_EXT
#define __FM_PCD_EXT
#include "std_ext.h"
#include "net_ext.h"
#include "list_ext.h"
#include "fm_ext.h"
#include "fsl_fman_kg.h"
/**************************************************************************//**
@Group FM_grp Frame Manager API
@Description Frame Manager Application Programming Interface
@{
*//***************************************************************************/
/**************************************************************************//**
@Group FM_PCD_grp FM PCD
@Description Frame Manager PCD (Parse-Classify-Distribute) API.
The FM PCD module is responsible for the initialization of all
global classifying FM modules. This includes the parser general and
common registers, the key generator global and common registers,
and the policer global and common registers.
In addition, the FM PCD SW module will initialize all required
key generator schemes, coarse classification flows, and policer
profiles. When FM module is configured to work with one of these
entities, it will register to it using the FM PORT API. The PCD
module will manage the PCD resources - i.e. resource management of
KeyGen schemes, etc.
@{
*//***************************************************************************/
/**************************************************************************//**
@Collection General PCD defines
*//***************************************************************************/
#define FM_PCD_MAX_NUM_OF_PRIVATE_HDRS 2 /**< Number of units/headers saved for user */
#define FM_PCD_PRS_NUM_OF_HDRS 16 /**< Number of headers supported by HW parser */
#define FM_PCD_MAX_NUM_OF_DISTINCTION_UNITS (32 - FM_PCD_MAX_NUM_OF_PRIVATE_HDRS)
/**< Number of distinction units is limited by
register size (32 bits) minus reserved bits
for private headers. */
#define FM_PCD_MAX_NUM_OF_INTERCHANGEABLE_HDRS 4 /**< Maximum number of interchangeable headers
in a distinction unit */
#define FM_PCD_KG_NUM_OF_GENERIC_REGS FM_KG_NUM_OF_GENERIC_REGS /**< Total number of generic KeyGen registers */
#define FM_PCD_KG_MAX_NUM_OF_EXTRACTS_PER_KEY 35 /**< Max number allowed on any configuration;
For HW implementation reasons, in most
cases less than this will be allowed; The
driver will return an initialization error
if resource is unavailable. */
#define FM_PCD_KG_NUM_OF_EXTRACT_MASKS 4 /**< Total number of masks allowed on KeyGen extractions. */
#define FM_PCD_KG_NUM_OF_DEFAULT_GROUPS 16 /**< Number of default value logical groups */
#define FM_PCD_PRS_NUM_OF_LABELS 32 /**< Maximum number of SW parser labels */
#define FM_PCD_SW_PRS_SIZE 0x00000800 /**< Total size of SW parser area */
#define FM_PCD_PRS_SW_OFFSET 0x00000040 /**< Size of illegal addresses at the beginning
of the SW parser area */
#define FM_PCD_MAX_MANIP_INSRT_TEMPLATE_SIZE 128 /**< Maximum size of insertion template for
insert manipulation */
#if (DPAA_VERSION >= 11)
#define FM_PCD_FRM_REPLIC_MAX_NUM_OF_ENTRIES 64 /**< Maximum possible entries for frame replicator group */
#endif /* (DPAA_VERSION >= 11) */
/* @} */
/**************************************************************************//**
@Group FM_PCD_init_grp FM PCD Initialization Unit
@Description Frame Manager PCD Initialization Unit API
@{
*//***************************************************************************/
/**************************************************************************//**
@Description PCD counters
*//***************************************************************************/
typedef enum e_FmPcdCounters {
e_FM_PCD_KG_COUNTERS_TOTAL, /**< KeyGen counter */
e_FM_PCD_PLCR_COUNTERS_RED, /**< Policer counter - counts the total number of RED packets that exit the Policer. */
e_FM_PCD_PLCR_COUNTERS_YELLOW, /**< Policer counter - counts the total number of YELLOW packets that exit the Policer. */
e_FM_PCD_PLCR_COUNTERS_RECOLORED_TO_RED, /**< Policer counter - counts the number of packets that changed color to RED by the Policer;
This is a subset of e_FM_PCD_PLCR_COUNTERS_RED packet count, indicating active color changes. */
e_FM_PCD_PLCR_COUNTERS_RECOLORED_TO_YELLOW, /**< Policer counter - counts the number of packets that changed color to YELLOW by the Policer;
This is a subset of e_FM_PCD_PLCR_COUNTERS_YELLOW packet count, indicating active color changes. */
e_FM_PCD_PLCR_COUNTERS_TOTAL, /**< Policer counter - counts the total number of packets passed in the Policer. */
e_FM_PCD_PLCR_COUNTERS_LENGTH_MISMATCH, /**< Policer counter - counts the number of packets with length mismatch. */
e_FM_PCD_PRS_COUNTERS_PARSE_DISPATCH, /**< Parser counter - counts the number of times the parser block is dispatched. */
e_FM_PCD_PRS_COUNTERS_L2_PARSE_RESULT_RETURNED, /**< Parser counter - counts the number of times L2 parse result is returned (including errors). */
e_FM_PCD_PRS_COUNTERS_L3_PARSE_RESULT_RETURNED, /**< Parser counter - counts the number of times L3 parse result is returned (including errors). */
e_FM_PCD_PRS_COUNTERS_L4_PARSE_RESULT_RETURNED, /**< Parser counter - counts the number of times L4 parse result is returned (including errors). */
e_FM_PCD_PRS_COUNTERS_SHIM_PARSE_RESULT_RETURNED, /**< Parser counter - counts the number of times SHIM parse result is returned (including errors). */
e_FM_PCD_PRS_COUNTERS_L2_PARSE_RESULT_RETURNED_WITH_ERR, /**< Parser counter - counts the number of times L2 parse result is returned with errors. */
e_FM_PCD_PRS_COUNTERS_L3_PARSE_RESULT_RETURNED_WITH_ERR, /**< Parser counter - counts the number of times L3 parse result is returned with errors. */
e_FM_PCD_PRS_COUNTERS_L4_PARSE_RESULT_RETURNED_WITH_ERR, /**< Parser counter - counts the number of times L4 parse result is returned with errors. */
e_FM_PCD_PRS_COUNTERS_SHIM_PARSE_RESULT_RETURNED_WITH_ERR, /**< Parser counter - counts the number of times SHIM parse result is returned with errors. */
e_FM_PCD_PRS_COUNTERS_SOFT_PRS_CYCLES, /**< Parser counter - counts the number of cycles spent executing soft parser instruction (including stall cycles). */
e_FM_PCD_PRS_COUNTERS_SOFT_PRS_STALL_CYCLES, /**< Parser counter - counts the number of cycles stalled waiting for parser internal memory reads while executing soft parser instruction. */
e_FM_PCD_PRS_COUNTERS_HARD_PRS_CYCLE_INCL_STALL_CYCLES, /**< Parser counter - counts the number of cycles spent executing hard parser (including stall cycles). */
e_FM_PCD_PRS_COUNTERS_MURAM_READ_CYCLES, /**< MURAM counter - counts the number of cycles while performing FMan Memory read. */
e_FM_PCD_PRS_COUNTERS_MURAM_READ_STALL_CYCLES, /**< MURAM counter - counts the number of cycles stalled while performing FMan Memory read. */
e_FM_PCD_PRS_COUNTERS_MURAM_WRITE_CYCLES, /**< MURAM counter - counts the number of cycles while performing FMan Memory write. */
e_FM_PCD_PRS_COUNTERS_MURAM_WRITE_STALL_CYCLES, /**< MURAM counter - counts the number of cycles stalled while performing FMan Memory write. */
e_FM_PCD_PRS_COUNTERS_FPM_COMMAND_STALL_CYCLES /**< FPM counter - counts the number of cycles stalled while performing a FPM Command. */
} e_FmPcdCounters;
/**************************************************************************//**
@Description PCD interrupts
*//***************************************************************************/
typedef enum e_FmPcdExceptions {
e_FM_PCD_KG_EXCEPTION_DOUBLE_ECC, /**< KeyGen double-bit ECC error is detected on internal memory read access. */
e_FM_PCD_KG_EXCEPTION_KEYSIZE_OVERFLOW, /**< KeyGen scheme configuration error indicating a key size larger than 56 bytes. */
e_FM_PCD_PLCR_EXCEPTION_DOUBLE_ECC, /**< Policer double-bit ECC error has been detected on PRAM read access. */
e_FM_PCD_PLCR_EXCEPTION_INIT_ENTRY_ERROR, /**< Policer access to a non-initialized profile has been detected. */
e_FM_PCD_PLCR_EXCEPTION_PRAM_SELF_INIT_COMPLETE, /**< Policer RAM self-initialization complete */
e_FM_PCD_PLCR_EXCEPTION_ATOMIC_ACTION_COMPLETE, /**< Policer atomic action complete */
e_FM_PCD_PRS_EXCEPTION_DOUBLE_ECC, /**< Parser double-bit ECC error */
e_FM_PCD_PRS_EXCEPTION_SINGLE_ECC /**< Parser single-bit ECC error */
} e_FmPcdExceptions;
/**************************************************************************//**
@Description Exceptions user callback routine, will be called upon an
exception passing the exception identification.
@Param[in] h_App - User's application descriptor.
@Param[in] exception - The exception.
*//***************************************************************************/
typedef void (t_FmPcdExceptionCallback) (t_Handle h_App, e_FmPcdExceptions exception);
/**************************************************************************//**
@Description Exceptions user callback routine, will be called upon an exception
passing the exception identification.
@Param[in] h_App - User's application descriptor.
@Param[in] exception - The exception.
@Param[in] index - id of the relevant source (may be scheme or profile id).
*//***************************************************************************/
typedef void (t_FmPcdIdExceptionCallback) ( t_Handle h_App,
e_FmPcdExceptions exception,
uint16_t index);
/**************************************************************************//**
@Description A callback for enqueuing frame onto a QM queue.
@Param[in] h_QmArg - Application's handle passed to QM module on enqueue.
@Param[in] p_Fd - Frame descriptor for the frame.
@Return E_OK on success; Error code otherwise.
*//***************************************************************************/
typedef t_Error (t_FmPcdQmEnqueueCallback) (t_Handle h_QmArg, void *p_Fd);
/**************************************************************************//**
@Description Host-Command parameters structure.
When using Host command for PCD functionalities, a dedicated port
must be used. If this routine is called for a PCD in a single partition
environment, or it is the Master partition in a Multi-partition
environment, The port will be initialized by the PCD driver
initialization routine.
*//***************************************************************************/
typedef struct t_FmPcdHcParams {
uintptr_t portBaseAddr; /**< Virtual Address of Host-Command Port memory mapped registers.*/
uint8_t portId; /**< Port Id (0-6 relative to Host-Command/Offline-Parsing ports);
NOTE: When configuring Host Command port for
FMANv3 devices (DPAA_VERSION 11 and higher),
portId=0 MUST be used. */
uint16_t liodnBase; /**< LIODN base for this port, to be used together with LIODN offset
(irrelevant for P4080 revision 1.0) */
uint32_t errFqid; /**< Host-Command Port error queue Id. */
uint32_t confFqid; /**< Host-Command Port confirmation queue Id. */
uint32_t qmChannel; /**< QM channel dedicated to this Host-Command port;
will be used by the FM for dequeue. */
t_FmPcdQmEnqueueCallback *f_QmEnqueue; /**< Callback routine for enqueuing a frame to the QM */
t_Handle h_QmArg; /**< Application's handle passed to QM module on enqueue */
} t_FmPcdHcParams;
/**************************************************************************//**
@Description The main structure for PCD initialization
*//***************************************************************************/
typedef struct t_FmPcdParams {
bool prsSupport; /**< TRUE if Parser will be used for any of the FM ports. */
bool ccSupport; /**< TRUE if Coarse Classification will be used for any
of the FM ports. */
bool kgSupport; /**< TRUE if KeyGen will be used for any of the FM ports. */
bool plcrSupport; /**< TRUE if Policer will be used for any of the FM ports. */
t_Handle h_Fm; /**< A handle to the FM module. */
uint8_t numOfSchemes; /**< Number of schemes dedicated to this partition.
this parameter is relevant if 'kgSupport'=TRUE. */
bool useHostCommand; /**< Optional for single partition, Mandatory for Multi partition */
t_FmPcdHcParams hc; /**< Host Command parameters, relevant only if 'useHostCommand'=TRUE;
Relevant when FM not runs in "guest-mode". */
t_FmPcdExceptionCallback *f_Exception; /**< Callback routine for general PCD exceptions;
Relevant when FM not runs in "guest-mode". */
t_FmPcdIdExceptionCallback *f_ExceptionId; /**< Callback routine for specific KeyGen scheme or
Policer profile exceptions;
Relevant when FM not runs in "guest-mode". */
t_Handle h_App; /**< A handle to an application layer object; This handle will
be passed by the driver upon calling the above callbacks;
Relevant when FM not runs in "guest-mode". */
uint8_t partPlcrProfilesBase; /**< The first policer-profile-id dedicated to this partition.
this parameter is relevant if 'plcrSupport'=TRUE.
NOTE: this parameter relevant only when working with multiple partitions. */
uint16_t partNumOfPlcrProfiles; /**< Number of policer-profiles dedicated to this partition.
this parameter is relevant if 'plcrSupport'=TRUE.
NOTE: this parameter relevant only when working with multiple partitions. */
} t_FmPcdParams;
/**************************************************************************//**
@Function FM_PCD_Config
@Description Basic configuration of the PCD module.
Creates descriptor for the FM PCD module.
@Param[in] p_FmPcdParams A structure of parameters for the initialization of PCD.
@Return A handle to the initialized module.
*//***************************************************************************/
t_Handle FM_PCD_Config(t_FmPcdParams *p_FmPcdParams);
/**************************************************************************//**
@Function FM_PCD_Init
@Description Initialization of the PCD module.
@Param[in] h_FmPcd - FM PCD module descriptor.
@Return E_OK on success; Error code otherwise.
*//***************************************************************************/
t_Error FM_PCD_Init(t_Handle h_FmPcd);
/**************************************************************************//**
@Function FM_PCD_Free
@Description Frees all resources that were assigned to FM module.
Calling this routine invalidates the descriptor.
@Param[in] h_FmPcd - FM PCD module descriptor.
@Return E_OK on success; Error code otherwise.
*//***************************************************************************/
t_Error FM_PCD_Free(t_Handle h_FmPcd);
/**************************************************************************//**
@Group FM_PCD_advanced_cfg_grp FM PCD Advanced Configuration Unit
@Description Frame Manager PCD Advanced Configuration API.
@{
*//***************************************************************************/
/**************************************************************************//**
@Function FM_PCD_ConfigException
@Description Calling this routine changes the internal driver data base
from its default selection of exceptions enabling.
[DEFAULT_numOfSharedPlcrProfiles].
@Param[in] h_FmPcd FM PCD module descriptor.
@Param[in] exception The exception to be selected.
@Param[in] enable TRUE to enable interrupt, FALSE to mask it.
@Return E_OK on success; Error code otherwise.
@Cautions This routine should NOT be called from guest-partition
(i.e. guestId != NCSW_MASTER_ID)
*//***************************************************************************/
t_Error FM_PCD_ConfigException(t_Handle h_FmPcd, e_FmPcdExceptions exception, bool enable);
/**************************************************************************//**
@Function FM_PCD_ConfigHcFramesDataMemory
@Description Configures memory-partition-id for FMan-Controller Host-Command
frames. Calling this routine changes the internal driver data
base from its default configuration [0].
@Param[in] h_FmPcd FM PCD module descriptor.
@Param[in] memId Memory partition ID.
@Return E_OK on success; Error code otherwise.
@Cautions This routine may be called only if 'useHostCommand' was TRUE
when FM_PCD_Config() routine was called.
*//***************************************************************************/
t_Error FM_PCD_ConfigHcFramesDataMemory(t_Handle h_FmPcd, uint8_t memId);
/**************************************************************************//**
@Function FM_PCD_ConfigPlcrNumOfSharedProfiles
@Description Calling this routine changes the internal driver data base
from its default selection of exceptions enablement.
[DEFAULT_numOfSharedPlcrProfiles].
@Param[in] h_FmPcd FM PCD module descriptor.
@Param[in] numOfSharedPlcrProfiles Number of profiles to
be shared between ports on this partition
@Return E_OK on success; Error code otherwise.
*//***************************************************************************/
t_Error FM_PCD_ConfigPlcrNumOfSharedProfiles(t_Handle h_FmPcd, uint16_t numOfSharedPlcrProfiles);
/**************************************************************************//**
@Function FM_PCD_ConfigPlcrAutoRefreshMode
@Description Calling this routine changes the internal driver data base
from its default selection of exceptions enablement.
By default auto-refresh is [DEFAULT_plcrAutoRefresh].
@Param[in] h_FmPcd FM PCD module descriptor.
@Param[in] enable TRUE to enable, FALSE to disable
@Return E_OK on success; Error code otherwise.
@Cautions This routine should NOT be called from guest-partition
(i.e. guestId != NCSW_MASTER_ID)
*//***************************************************************************/
t_Error FM_PCD_ConfigPlcrAutoRefreshMode(t_Handle h_FmPcd, bool enable);
/**************************************************************************//**
@Function FM_PCD_ConfigPrsMaxCycleLimit
@Description Calling this routine changes the internal data structure for
the maximum parsing time from its default value
[DEFAULT_MAX_PRS_CYC_LIM].
@Param[in] h_FmPcd FM PCD module descriptor.
@Param[in] value 0 to disable the mechanism, or new
maximum parsing time.
@Return E_OK on success; Error code otherwise.
@Cautions This routine should NOT be called from guest-partition
(i.e. guestId != NCSW_MASTER_ID)
*//***************************************************************************/
t_Error FM_PCD_ConfigPrsMaxCycleLimit(t_Handle h_FmPcd,uint16_t value);
/** @} */ /* end of FM_PCD_advanced_cfg_grp group */
/** @} */ /* end of FM_PCD_init_grp group */
/**************************************************************************//**
@Group FM_PCD_Runtime_grp FM PCD Runtime Unit
@Description Frame Manager PCD Runtime Unit API
The runtime control allows creation of PCD infrastructure modules
such as Network Environment Characteristics, Classification Plan
Groups and Coarse Classification Trees.
It also allows on-the-fly initialization, modification and removal
of PCD modules such as KeyGen schemes, coarse classification nodes
and Policer profiles.
In order to explain the programming model of the PCD driver interface
a few terms should be explained, and will be used below.
- Distinction Header - One of the 16 protocols supported by the FM parser,
or one of the SHIM headers (1 or 2). May be a header with a special
option (see below).
- Interchangeable Headers Group - This is a group of Headers recognized
by either one of them. For example, if in a specific context the user
chooses to treat IPv4 and IPV6 in the same way, they may create an
interchangeable Headers Unit consisting of these 2 headers.
- A Distinction Unit - a Distinction Header or an Interchangeable Headers
Group.
- Header with special option - applies to Ethernet, MPLS, VLAN, IPv4 and
IPv6, includes multicast, broadcast and other protocol specific options.
In terms of hardware it relates to the options available in the classification
plan.
- Network Environment Characteristics - a set of Distinction Units that define
the total recognizable header selection for a certain environment. This is
NOT the list of all headers that will ever appear in a flow, but rather
everything that needs distinction in a flow, where distinction is made by KeyGen
schemes and coarse classification action descriptors.
The PCD runtime modules initialization is done in stages. The first stage after
initializing the PCD module itself is to establish a Network Flows Environment
Definition. The application may choose to establish one or more such environments.
Later, when needed, the application will have to state, for some of its modules,
to which single environment it belongs.
@{
*//***************************************************************************/
/**************************************************************************//**
@Description A structure for SW parser labels
*//***************************************************************************/
typedef struct t_FmPcdPrsLabelParams {
uint32_t instructionOffset; /**< SW parser label instruction offset (2 bytes
resolution), relative to Parser RAM. */
e_NetHeaderType hdr; /**< The existence of this header will invoke
the SW parser code. */
uint8_t indexPerHdr; /**< Normally 0, if more than one SW parser
attachments for the same header, use this
index to distinguish between them. */
} t_FmPcdPrsLabelParams;
/**************************************************************************//**
@Description A structure for SW parser
*//***************************************************************************/
typedef struct t_FmPcdPrsSwParams {
bool override; /**< FALSE to invoke a check that nothing else
was loaded to this address, including
internal patches.
TRUE to override any existing code.*/
uint32_t size; /**< SW parser code size */
uint16_t base; /**< SW parser base (in instruction counts!
must be larger than 0x20)*/
uint8_t *p_Code; /**< SW parser code */
uint32_t swPrsDataParams[FM_PCD_PRS_NUM_OF_HDRS];
/**< SW parser data (parameters) */
uint8_t numOfLabels; /**< Number of labels for SW parser. */
t_FmPcdPrsLabelParams labelsTable[FM_PCD_PRS_NUM_OF_LABELS];
/**< SW parser labels table, containing
numOfLabels entries */
} t_FmPcdPrsSwParams;
/**************************************************************************//**
@Function FM_PCD_Enable
@Description This routine should be called after PCD is initialized for enabling all
PCD engines according to their existing configuration.
@Param[in] h_FmPcd FM PCD module descriptor.
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_Init() and when PCD is disabled.
*//***************************************************************************/
t_Error FM_PCD_Enable(t_Handle h_FmPcd);
/**************************************************************************//**
@Function FM_PCD_Disable
@Description This routine may be called when PCD is enabled in order to
disable all PCD engines. It may be called
only when none of the ports in the system are using the PCD.
@Param[in] h_FmPcd FM PCD module descriptor.
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_Init() and when PCD is enabled.
*//***************************************************************************/
t_Error FM_PCD_Disable(t_Handle h_FmPcd);
/**************************************************************************//**
@Function FM_PCD_GetCounter
@Description Reads one of the FM PCD counters.
@Param[in] h_FmPcd FM PCD module descriptor.
@Param[in] counter The requested counter.
@Return Counter's current value.
@Cautions Allowed only following FM_PCD_Init().
Note that it is user's responsibility to call this routine only
for enabled counters, and there will be no indication if a
disabled counter is accessed.
*//***************************************************************************/
uint32_t FM_PCD_GetCounter(t_Handle h_FmPcd, e_FmPcdCounters counter);
/**************************************************************************//**
@Function FM_PCD_PrsLoadSw
@Description This routine may be called in order to load software parsing code.
@Param[in] h_FmPcd FM PCD module descriptor.
@Param[in] p_SwPrs A pointer to a structure of software
parser parameters, including the software
parser image.
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_Init() and when PCD is disabled.
This routine should NOT be called from guest-partition
(i.e. guestId != NCSW_MASTER_ID)
*//***************************************************************************/
t_Error FM_PCD_PrsLoadSw(t_Handle h_FmPcd, t_FmPcdPrsSwParams *p_SwPrs);
/**************************************************************************//**
@Function FM_PCD_SetAdvancedOffloadSupport
@Description This routine must be called in order to support the following features:
IP-fragmentation, IP-reassembly, IPsec, Header-manipulation, frame-replicator.
@Param[in] h_FmPcd FM PCD module descriptor.
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_Init() and when PCD is disabled.
This routine should NOT be called from guest-partition
(i.e. guestId != NCSW_MASTER_ID)
*//***************************************************************************/
t_Error FM_PCD_SetAdvancedOffloadSupport(t_Handle h_FmPcd);
/**************************************************************************//**
@Function FM_PCD_KgSetDfltValue
@Description Calling this routine sets a global default value to be used
by the KeyGen when parser does not recognize a required
field/header.
By default default values are 0.
@Param[in] h_FmPcd FM PCD module descriptor.
@Param[in] valueId 0,1 - one of 2 global default values.
@Param[in] value The requested default value.
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_Init() and when PCD is disabled.
This routine should NOT be called from guest-partition
(i.e. guestId != NCSW_MASTER_ID)
*//***************************************************************************/
t_Error FM_PCD_KgSetDfltValue(t_Handle h_FmPcd, uint8_t valueId, uint32_t value);
/**************************************************************************//**
@Function FM_PCD_KgSetAdditionalDataAfterParsing
@Description Calling this routine allows the KeyGen to access data past
the parser finishing point.
@Param[in] h_FmPcd FM PCD module descriptor.
@Param[in] payloadOffset the number of bytes beyond the parser location.
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_Init() and when PCD is disabled.
This routine should NOT be called from guest-partition
(i.e. guestId != NCSW_MASTER_ID)
*//***************************************************************************/
t_Error FM_PCD_KgSetAdditionalDataAfterParsing(t_Handle h_FmPcd, uint8_t payloadOffset);
/**************************************************************************//**
@Function FM_PCD_SetException
@Description Calling this routine enables/disables PCD interrupts.
@Param[in] h_FmPcd FM PCD module descriptor.
@Param[in] exception The exception to be selected.
@Param[in] enable TRUE to enable interrupt, FALSE to mask it.
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_Init().
This routine should NOT be called from guest-partition
(i.e. guestId != NCSW_MASTER_ID)
*//***************************************************************************/
t_Error FM_PCD_SetException(t_Handle h_FmPcd, e_FmPcdExceptions exception, bool enable);
/**************************************************************************//**
@Function FM_PCD_ModifyCounter
@Description Sets a value to an enabled counter. Use "0" to reset the counter.
@Param[in] h_FmPcd FM PCD module descriptor.
@Param[in] counter The requested counter.
@Param[in] value The requested value to be written into the counter.
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_Init().
This routine should NOT be called from guest-partition
(i.e. guestId != NCSW_MASTER_ID)
*//***************************************************************************/
t_Error FM_PCD_ModifyCounter(t_Handle h_FmPcd, e_FmPcdCounters counter, uint32_t value);
/**************************************************************************//**
@Function FM_PCD_SetPlcrStatistics
@Description This routine may be used to enable/disable policer statistics
counter. By default the statistics is enabled.
@Param[in] h_FmPcd FM PCD module descriptor
@Param[in] enable TRUE to enable, FALSE to disable.
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_Init().
This routine should NOT be called from guest-partition
(i.e. guestId != NCSW_MASTER_ID)
*//***************************************************************************/
t_Error FM_PCD_SetPlcrStatistics(t_Handle h_FmPcd, bool enable);
/**************************************************************************//**
@Function FM_PCD_SetPrsStatistics
@Description Defines whether to gather parser statistics including all ports.
@Param[in] h_FmPcd FM PCD module descriptor.
@Param[in] enable TRUE to enable, FALSE to disable.
@Return None
@Cautions Allowed only following FM_PCD_Init().
This routine should NOT be called from guest-partition
(i.e. guestId != NCSW_MASTER_ID)
*//***************************************************************************/
void FM_PCD_SetPrsStatistics(t_Handle h_FmPcd, bool enable);
/**************************************************************************//**
@Function FM_PCD_HcTxConf
@Description This routine should be called to confirm frames that were
received on the HC confirmation queue.
@Param[in] h_FmPcd A handle to an FM PCD Module.
@Param[in] p_Fd Frame descriptor of the received frame.
@Cautions Allowed only following FM_PCD_Init(). Allowed only if 'useHostCommand'
option was selected in the initialization.
*//***************************************************************************/
void FM_PCD_HcTxConf(t_Handle h_FmPcd, t_DpaaFD *p_Fd);
/**************************************************************************//*
@Function FM_PCD_ForceIntr
@Description Causes an interrupt event on the requested source.
@Param[in] h_FmPcd FM PCD module descriptor.
@Param[in] exception An exception to be forced.
@Return E_OK on success; Error code if the exception is not enabled,
or is not able to create interrupt.
@Cautions Allowed only following FM_PCD_Init().
This routine should NOT be called from guest-partition
(i.e. guestId != NCSW_MASTER_ID)
*//***************************************************************************/
t_Error FM_PCD_ForceIntr (t_Handle h_FmPcd, e_FmPcdExceptions exception);
#if (defined(DEBUG_ERRORS) && (DEBUG_ERRORS > 0))
/**************************************************************************//**
@Function FM_PCD_DumpRegs
@Description Dumps all PCD registers
@Param[in] h_FmPcd A handle to an FM PCD Module.
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_Init().
NOTE: this routine may be called only for FM in master mode
(i.e. 'guestId'=NCSW_MASTER_ID) or in a case that the registers
are mapped.
*//***************************************************************************/
t_Error FM_PCD_DumpRegs(t_Handle h_FmPcd);
/**************************************************************************//**
@Function FM_PCD_KgDumpRegs
@Description Dumps all PCD KG registers
@Param[in] h_FmPcd A handle to an FM PCD Module.
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_Init().
NOTE: this routine may be called only for FM in master mode
(i.e. 'guestId'=NCSW_MASTER_ID) or in a case that the registers
are mapped.
*//***************************************************************************/
t_Error FM_PCD_KgDumpRegs(t_Handle h_FmPcd);
/**************************************************************************//**
@Function FM_PCD_PlcrDumpRegs
@Description Dumps all PCD Policer registers
@Param[in] h_FmPcd A handle to an FM PCD Module.
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_Init().
NOTE: this routine may be called only for FM in master mode
(i.e. 'guestId'=NCSW_MASTER_ID) or in a case that the registers
are mapped.
*//***************************************************************************/
t_Error FM_PCD_PlcrDumpRegs(t_Handle h_FmPcd);
/**************************************************************************//**
@Function FM_PCD_PlcrProfileDumpRegs
@Description Dumps all PCD Policer profile registers
@Param[in] h_Profile A handle to a Policer profile.
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_Init().
NOTE: this routine may be called only for FM in master mode
(i.e. 'guestId'=NCSW_MASTER_ID) or in a case that the registers
are mapped.
*//***************************************************************************/
t_Error FM_PCD_PlcrProfileDumpRegs(t_Handle h_Profile);
/**************************************************************************//**
@Function FM_PCD_PrsDumpRegs
@Description Dumps all PCD Parser registers
@Param[in] h_FmPcd A handle to an FM PCD Module.
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_Init().
NOTE: this routine may be called only for FM in master mode
(i.e. 'guestId'=NCSW_MASTER_ID) or in a case that the registers
are mapped.
*//***************************************************************************/
t_Error FM_PCD_PrsDumpRegs(t_Handle h_FmPcd);
/**************************************************************************//**
@Function FM_PCD_HcDumpRegs
@Description Dumps HC Port registers
@Param[in] h_FmPcd A handle to an FM PCD Module.
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_Init().
NOTE: this routine may be called only for FM in master mode
(i.e. 'guestId'=NCSW_MASTER_ID).
*//***************************************************************************/
t_Error FM_PCD_HcDumpRegs(t_Handle h_FmPcd);
#endif /* (defined(DEBUG_ERRORS) && ... */
/**************************************************************************//**
KeyGen FM_PCD_Runtime_build_grp FM PCD Runtime Building Unit
@Description Frame Manager PCD Runtime Building API
This group contains routines for setting, deleting and modifying
PCD resources, for defining the total PCD tree.
@{
*//***************************************************************************/
/**************************************************************************//**
@Collection Definitions of coarse classification
parameters as required by KeyGen (when coarse classification
is the next engine after this scheme).
*//***************************************************************************/
#define FM_PCD_MAX_NUM_OF_CC_TREES 8
#define FM_PCD_MAX_NUM_OF_CC_GROUPS 16
#define FM_PCD_MAX_NUM_OF_CC_UNITS 4
#define FM_PCD_MAX_NUM_OF_KEYS 256
#define FM_PCD_MAX_NUM_OF_FLOWS (4*KILOBYTE)
#define FM_PCD_MAX_SIZE_OF_KEY 56
#define FM_PCD_MAX_NUM_OF_CC_ENTRIES_IN_GRP 16
#define FM_PCD_LAST_KEY_INDEX 0xffff
#define FM_PCD_MAX_NUM_OF_CC_NODES 255 /* Obsolete, not used - will be removed in the future */
/* @} */
/**************************************************************************//**
@Collection A set of definitions to allow protocol
special option description.
*//***************************************************************************/
typedef uint32_t protocolOpt_t; /**< A general type to define a protocol option. */
typedef protocolOpt_t ethProtocolOpt_t; /**< Ethernet protocol options. */
#define ETH_BROADCAST 0x80000000 /**< Ethernet Broadcast. */
#define ETH_MULTICAST 0x40000000 /**< Ethernet Multicast. */
typedef protocolOpt_t vlanProtocolOpt_t; /**< VLAN protocol options. */
#define VLAN_STACKED 0x20000000 /**< Stacked VLAN. */
typedef protocolOpt_t mplsProtocolOpt_t; /**< MPLS protocol options. */
#define MPLS_STACKED 0x10000000 /**< Stacked MPLS. */
typedef protocolOpt_t ipv4ProtocolOpt_t; /**< IPv4 protocol options. */
#define IPV4_BROADCAST_1 0x08000000 /**< IPv4 Broadcast. */
#define IPV4_MULTICAST_1 0x04000000 /**< IPv4 Multicast. */
#define IPV4_UNICAST_2 0x02000000 /**< Tunneled IPv4 - Unicast. */
#define IPV4_MULTICAST_BROADCAST_2 0x01000000 /**< Tunneled IPv4 - Broadcast/Multicast. */
#define IPV4_FRAG_1 0x00000008 /**< IPV4 reassembly option.
IPV4 Reassembly manipulation requires network
environment with IPV4 header and IPV4_FRAG_1 option */
typedef protocolOpt_t ipv6ProtocolOpt_t; /**< IPv6 protocol options. */
#define IPV6_MULTICAST_1 0x00800000 /**< IPv6 Multicast. */
#define IPV6_UNICAST_2 0x00400000 /**< Tunneled IPv6 - Unicast. */
#define IPV6_MULTICAST_2 0x00200000 /**< Tunneled IPv6 - Multicast. */
#define IPV6_FRAG_1 0x00000004 /**< IPV6 reassembly option.
IPV6 Reassembly manipulation requires network
environment with IPV6 header and IPV6_FRAG_1 option;
in case where fragment found, the fragment-extension offset
may be found at 'shim2' (in parser-result). */
/* @} */
#define FM_PCD_MANIP_MAX_HDR_SIZE 256
#define FM_PCD_MANIP_DSCP_TO_VLAN_TRANS 64
/**************************************************************************//**
@Collection A set of definitions to support Header Manipulation selection.
*//***************************************************************************/
typedef uint32_t hdrManipFlags_t; /**< A general type to define a HMan update command flags. */
typedef hdrManipFlags_t ipv4HdrManipUpdateFlags_t; /**< IPv4 protocol HMan update command flags. */
#define HDR_MANIP_IPV4_TOS 0x80000000 /**< update TOS with the given value ('tos' field
of t_FmPcdManipHdrFieldUpdateIpv4) */
#define HDR_MANIP_IPV4_ID 0x40000000 /**< update IP ID with the given value ('id' field
of t_FmPcdManipHdrFieldUpdateIpv4) */
#define HDR_MANIP_IPV4_TTL 0x20000000 /**< Decrement TTL by 1 */
#define HDR_MANIP_IPV4_SRC 0x10000000 /**< update IP source address with the given value
('src' field of t_FmPcdManipHdrFieldUpdateIpv4) */
#define HDR_MANIP_IPV4_DST 0x08000000 /**< update IP destination address with the given value
('dst' field of t_FmPcdManipHdrFieldUpdateIpv4) */
typedef hdrManipFlags_t ipv6HdrManipUpdateFlags_t; /**< IPv6 protocol HMan update command flags. */
#define HDR_MANIP_IPV6_TC 0x80000000 /**< update Traffic Class address with the given value
('trafficClass' field of t_FmPcdManipHdrFieldUpdateIpv6) */
#define HDR_MANIP_IPV6_HL 0x40000000 /**< Decrement Hop Limit by 1 */
#define HDR_MANIP_IPV6_SRC 0x20000000 /**< update IP source address with the given value
('src' field of t_FmPcdManipHdrFieldUpdateIpv6) */
#define HDR_MANIP_IPV6_DST 0x10000000 /**< update IP destination address with the given value
('dst' field of t_FmPcdManipHdrFieldUpdateIpv6) */
typedef hdrManipFlags_t tcpUdpHdrManipUpdateFlags_t;/**< TCP/UDP protocol HMan update command flags. */
#define HDR_MANIP_TCP_UDP_SRC 0x80000000 /**< update TCP/UDP source address with the given value
('src' field of t_FmPcdManipHdrFieldUpdateTcpUdp) */
#define HDR_MANIP_TCP_UDP_DST 0x40000000 /**< update TCP/UDP destination address with the given value
('dst' field of t_FmPcdManipHdrFieldUpdateTcpUdp) */
#define HDR_MANIP_TCP_UDP_CHECKSUM 0x20000000 /**< update TCP/UDP checksum */
/* @} */
/**************************************************************************//**
@Description A type used for returning the order of the key extraction.
each value in this array represents the index of the extraction
command as defined by the user in the initialization extraction array.
The valid size of this array is the user define number of extractions
required (also marked by the second '0' in this array).
*//***************************************************************************/
typedef uint8_t t_FmPcdKgKeyOrder [FM_PCD_KG_MAX_NUM_OF_EXTRACTS_PER_KEY];
/**************************************************************************//**
@Description All PCD engines
*//***************************************************************************/
typedef enum e_FmPcdEngine {
e_FM_PCD_INVALID = 0, /**< Invalid PCD engine */
e_FM_PCD_DONE, /**< No PCD Engine indicated */
e_FM_PCD_KG, /**< KeyGen */
e_FM_PCD_CC, /**< Coarse classifier */
e_FM_PCD_PLCR, /**< Policer */
e_FM_PCD_PRS, /**< Parser */
#if (DPAA_VERSION >= 11)
e_FM_PCD_FR, /**< Frame-Replicator */
#endif /* (DPAA_VERSION >= 11) */
e_FM_PCD_HASH /**< Hash table */
} e_FmPcdEngine;
/**************************************************************************//**
@Description Enumeration type for selecting extraction by header types
*//***************************************************************************/
typedef enum e_FmPcdExtractByHdrType {
e_FM_PCD_EXTRACT_FROM_HDR, /**< Extract bytes from header */
e_FM_PCD_EXTRACT_FROM_FIELD, /**< Extract bytes from header field */
e_FM_PCD_EXTRACT_FULL_FIELD /**< Extract a full field */
} e_FmPcdExtractByHdrType;
/**************************************************************************//**
@Description Enumeration type for selecting extraction source
(when it is not the header)
*//***************************************************************************/
typedef enum e_FmPcdExtractFrom {
e_FM_PCD_EXTRACT_FROM_FRAME_START, /**< KG & CC: Extract from beginning of frame */
e_FM_PCD_EXTRACT_FROM_DFLT_VALUE, /**< KG only: Extract from a default value */
e_FM_PCD_EXTRACT_FROM_CURR_END_OF_PARSE, /**< KG & CC: Extract from the point where parsing had finished */
e_FM_PCD_EXTRACT_FROM_KEY, /**< CC only: Field where saved KEY */
e_FM_PCD_EXTRACT_FROM_HASH, /**< CC only: Field where saved HASH */
e_FM_PCD_EXTRACT_FROM_PARSE_RESULT, /**< KG only: Extract from the parser result */
e_FM_PCD_EXTRACT_FROM_ENQ_FQID, /**< KG & CC: Extract from enqueue FQID */
e_FM_PCD_EXTRACT_FROM_FLOW_ID /**< CC only: Field where saved Dequeue FQID */
} e_FmPcdExtractFrom;
/**************************************************************************//**
@Description Enumeration type for selecting extraction type
*//***************************************************************************/
typedef enum e_FmPcdExtractType {
e_FM_PCD_EXTRACT_BY_HDR, /**< Extract according to header */
e_FM_PCD_EXTRACT_NON_HDR, /**< Extract from data that is not the header */
e_FM_PCD_KG_EXTRACT_PORT_PRIVATE_INFO /**< Extract private info as specified by user */
} e_FmPcdExtractType;
/**************************************************************************//**
@Description Enumeration type for selecting default extraction value
*//***************************************************************************/
typedef enum e_FmPcdKgExtractDfltSelect {
e_FM_PCD_KG_DFLT_GBL_0, /**< Default selection is KG register 0 */
e_FM_PCD_KG_DFLT_GBL_1, /**< Default selection is KG register 1 */
e_FM_PCD_KG_DFLT_PRIVATE_0, /**< Default selection is a per scheme register 0 */
e_FM_PCD_KG_DFLT_PRIVATE_1, /**< Default selection is a per scheme register 1 */
e_FM_PCD_KG_DFLT_ILLEGAL /**< Illegal selection */
} e_FmPcdKgExtractDfltSelect;
/**************************************************************************//**
@Description Enumeration type defining all default groups - each group shares
a default value, one of four user-initialized values.
*//***************************************************************************/
typedef enum e_FmPcdKgKnownFieldsDfltTypes {
e_FM_PCD_KG_MAC_ADDR, /**< MAC Address */
e_FM_PCD_KG_TCI, /**< TCI field */
e_FM_PCD_KG_ENET_TYPE, /**< ENET Type */
e_FM_PCD_KG_PPP_SESSION_ID, /**< PPP Session id */
e_FM_PCD_KG_PPP_PROTOCOL_ID, /**< PPP Protocol id */
e_FM_PCD_KG_MPLS_LABEL, /**< MPLS label */
e_FM_PCD_KG_IP_ADDR, /**< IP address */
e_FM_PCD_KG_PROTOCOL_TYPE, /**< Protocol type */
e_FM_PCD_KG_IP_TOS_TC, /**< TOS or TC */
e_FM_PCD_KG_IPV6_FLOW_LABEL, /**< IPV6 flow label */
e_FM_PCD_KG_IPSEC_SPI, /**< IPSEC SPI */
e_FM_PCD_KG_L4_PORT, /**< L4 Port */
e_FM_PCD_KG_TCP_FLAG, /**< TCP Flag */
e_FM_PCD_KG_GENERIC_FROM_DATA, /**< grouping implemented by SW,
any data extraction that is not the full
field described above */
e_FM_PCD_KG_GENERIC_FROM_DATA_NO_V, /**< grouping implemented by SW,
any data extraction without validation */
e_FM_PCD_KG_GENERIC_NOT_FROM_DATA /**< grouping implemented by SW,
extraction from parser result or
direct use of default value */
} e_FmPcdKgKnownFieldsDfltTypes;
/**************************************************************************//**
@Description Enumeration type for defining header index for scenarios with
multiple (tunneled) headers
*//***************************************************************************/
typedef enum e_FmPcdHdrIndex {
e_FM_PCD_HDR_INDEX_NONE = 0, /**< used when multiple headers not used, also
to specify regular IP (not tunneled). */
e_FM_PCD_HDR_INDEX_1, /**< may be used for VLAN, MPLS, tunneled IP */
e_FM_PCD_HDR_INDEX_2, /**< may be used for MPLS, tunneled IP */
e_FM_PCD_HDR_INDEX_3, /**< may be used for MPLS */
e_FM_PCD_HDR_INDEX_LAST = 0xFF /**< may be used for VLAN, MPLS */
} e_FmPcdHdrIndex;
/**************************************************************************//**
@Description Enumeration type for selecting the policer profile functional type
*//***************************************************************************/
typedef enum e_FmPcdProfileTypeSelection {
e_FM_PCD_PLCR_PORT_PRIVATE, /**< Port dedicated profile */
e_FM_PCD_PLCR_SHARED /**< Shared profile (shared within partition) */
} e_FmPcdProfileTypeSelection;
/**************************************************************************//**
@Description Enumeration type for selecting the policer profile algorithm
*//***************************************************************************/
typedef enum e_FmPcdPlcrAlgorithmSelection {
e_FM_PCD_PLCR_PASS_THROUGH, /**< Policer pass through */
e_FM_PCD_PLCR_RFC_2698, /**< Policer algorithm RFC 2698 */
e_FM_PCD_PLCR_RFC_4115 /**< Policer algorithm RFC 4115 */
} e_FmPcdPlcrAlgorithmSelection;
/**************************************************************************//**
@Description Enumeration type for selecting a policer profile color mode
*//***************************************************************************/
typedef enum e_FmPcdPlcrColorMode {
e_FM_PCD_PLCR_COLOR_BLIND, /**< Color blind */
e_FM_PCD_PLCR_COLOR_AWARE /**< Color aware */
} e_FmPcdPlcrColorMode;
/**************************************************************************//**
@Description Enumeration type for selecting a policer profile color
*//***************************************************************************/
typedef enum e_FmPcdPlcrColor {
e_FM_PCD_PLCR_GREEN, /**< Green color code */
e_FM_PCD_PLCR_YELLOW, /**< Yellow color code */
e_FM_PCD_PLCR_RED, /**< Red color code */
e_FM_PCD_PLCR_OVERRIDE /**< Color override code */
} e_FmPcdPlcrColor;
/**************************************************************************//**
@Description Enumeration type for selecting the policer profile packet frame length selector
*//***************************************************************************/
typedef enum e_FmPcdPlcrFrameLengthSelect {
e_FM_PCD_PLCR_L2_FRM_LEN, /**< L2 frame length */
e_FM_PCD_PLCR_L3_FRM_LEN, /**< L3 frame length */
e_FM_PCD_PLCR_L4_FRM_LEN, /**< L4 frame length */
e_FM_PCD_PLCR_FULL_FRM_LEN /**< Full frame length */
} e_FmPcdPlcrFrameLengthSelect;
/**************************************************************************//**
@Description Enumeration type for selecting roll-back frame
*//***************************************************************************/
typedef enum e_FmPcdPlcrRollBackFrameSelect {
e_FM_PCD_PLCR_ROLLBACK_L2_FRM_LEN, /**< Roll-back L2 frame length */
e_FM_PCD_PLCR_ROLLBACK_FULL_FRM_LEN /**< Roll-back Full frame length */
} e_FmPcdPlcrRollBackFrameSelect;
/**************************************************************************//**
@Description Enumeration type for selecting the policer profile packet or byte mode
*//***************************************************************************/
typedef enum e_FmPcdPlcrRateMode {
e_FM_PCD_PLCR_BYTE_MODE, /**< Byte mode */
e_FM_PCD_PLCR_PACKET_MODE /**< Packet mode */
} e_FmPcdPlcrRateMode;
/**************************************************************************//**
@Description Enumeration type for defining action of frame
*//***************************************************************************/
typedef enum e_FmPcdDoneAction {
e_FM_PCD_ENQ_FRAME = 0, /**< Enqueue frame */
e_FM_PCD_DROP_FRAME /**< Drop frame */
} e_FmPcdDoneAction;
/**************************************************************************//**
@Description Enumeration type for selecting the policer counter
*//***************************************************************************/
typedef enum e_FmPcdPlcrProfileCounters {
e_FM_PCD_PLCR_PROFILE_GREEN_PACKET_TOTAL_COUNTER, /**< Green packets counter */
e_FM_PCD_PLCR_PROFILE_YELLOW_PACKET_TOTAL_COUNTER, /**< Yellow packets counter */
e_FM_PCD_PLCR_PROFILE_RED_PACKET_TOTAL_COUNTER, /**< Red packets counter */
e_FM_PCD_PLCR_PROFILE_RECOLOURED_YELLOW_PACKET_TOTAL_COUNTER, /**< Recolored yellow packets counter */
e_FM_PCD_PLCR_PROFILE_RECOLOURED_RED_PACKET_TOTAL_COUNTER /**< Recolored red packets counter */
} e_FmPcdPlcrProfileCounters;
/**************************************************************************//**
@Description Enumeration type for selecting the PCD action after extraction
*//***************************************************************************/
typedef enum e_FmPcdAction {
e_FM_PCD_ACTION_NONE, /**< NONE */
e_FM_PCD_ACTION_EXACT_MATCH, /**< Exact match on the selected extraction */
e_FM_PCD_ACTION_INDEXED_LOOKUP /**< Indexed lookup on the selected extraction */
} e_FmPcdAction;
/**************************************************************************//**
@Description Enumeration type for selecting type of insert manipulation
*//***************************************************************************/
typedef enum e_FmPcdManipHdrInsrtType {
e_FM_PCD_MANIP_INSRT_GENERIC, /**< Insert according to offset & size */
e_FM_PCD_MANIP_INSRT_BY_HDR, /**< Insert according to protocol */
#ifdef FM_CAPWAP_SUPPORT
e_FM_PCD_MANIP_INSRT_BY_TEMPLATE /**< Insert template to start of frame */
#endif /* FM_CAPWAP_SUPPORT */
} e_FmPcdManipHdrInsrtType;
/**************************************************************************//**
@Description Enumeration type for selecting type of remove manipulation
*//***************************************************************************/
typedef enum e_FmPcdManipHdrRmvType {
e_FM_PCD_MANIP_RMV_GENERIC, /**< Remove according to offset & size */
e_FM_PCD_MANIP_RMV_BY_HDR /**< Remove according to offset & size */
} e_FmPcdManipHdrRmvType;
/**************************************************************************//**
@Description Enumeration type for selecting specific L2 fields removal
*//***************************************************************************/
typedef enum e_FmPcdManipHdrRmvSpecificL2 {
e_FM_PCD_MANIP_HDR_RMV_ETHERNET, /**< Ethernet/802.3 MAC */
e_FM_PCD_MANIP_HDR_RMV_STACKED_QTAGS, /**< stacked QTags */
e_FM_PCD_MANIP_HDR_RMV_ETHERNET_AND_MPLS, /**< MPLS and Ethernet/802.3 MAC header until
the header which follows the MPLS header */
e_FM_PCD_MANIP_HDR_RMV_MPLS /**< Remove MPLS header (Unlimited MPLS labels) */
} e_FmPcdManipHdrRmvSpecificL2;
/**************************************************************************//**
@Description Enumeration type for selecting specific fields updates
*//***************************************************************************/
typedef enum e_FmPcdManipHdrFieldUpdateType {
e_FM_PCD_MANIP_HDR_FIELD_UPDATE_VLAN, /**< VLAN updates */
e_FM_PCD_MANIP_HDR_FIELD_UPDATE_IPV4, /**< IPV4 updates */
e_FM_PCD_MANIP_HDR_FIELD_UPDATE_IPV6, /**< IPV6 updates */
e_FM_PCD_MANIP_HDR_FIELD_UPDATE_TCP_UDP, /**< TCP_UDP updates */
} e_FmPcdManipHdrFieldUpdateType;
/**************************************************************************//**
@Description Enumeration type for selecting VLAN updates
*//***************************************************************************/
typedef enum e_FmPcdManipHdrFieldUpdateVlan {
e_FM_PCD_MANIP_HDR_FIELD_UPDATE_VLAN_VPRI, /**< Replace VPri of outer most VLAN tag. */
e_FM_PCD_MANIP_HDR_FIELD_UPDATE_DSCP_TO_VLAN /**< DSCP to VLAN priority bits translation */
} e_FmPcdManipHdrFieldUpdateVlan;
/**************************************************************************//**
@Description Enumeration type for selecting specific L2 fields removal
*//***************************************************************************/
typedef enum e_FmPcdManipHdrInsrtSpecificL2 {
e_FM_PCD_MANIP_HDR_INSRT_MPLS /**< Insert MPLS header (Unlimited MPLS labels) */
} e_FmPcdManipHdrInsrtSpecificL2;
/**************************************************************************//**
@Description Enumeration type for selecting type of header insertion
*//***************************************************************************/
typedef enum e_FmPcdManipHdrInsrtByHdrType {
e_FM_PCD_MANIP_INSRT_BY_HDR_SPECIFIC_L2 /**< Specific L2 fields insertion */
} e_FmPcdManipHdrInsrtByHdrType;
/**************************************************************************//**
@Description Enumeration type for selecting specific customCommand
*//***************************************************************************/
typedef enum e_FmPcdManipHdrCustomType {
e_FM_PCD_MANIP_HDR_CUSTOM_IP_REPLACE, /**< Replace IPv4/IPv6 */
} e_FmPcdManipHdrCustomType;
/**************************************************************************//**
@Description Enumeration type for selecting specific customCommand
*//***************************************************************************/
typedef enum e_FmPcdManipHdrCustomIpReplace {
e_FM_PCD_MANIP_HDR_CUSTOM_REPLACE_IPV4_BY_IPV6, /**< Replace IPv4 by IPv6 */
e_FM_PCD_MANIP_HDR_CUSTOM_REPLACE_IPV6_BY_IPV4 /**< Replace IPv6 by IPv4 */
} e_FmPcdManipHdrCustomIpReplace;
/**************************************************************************//**
@Description Enumeration type for selecting type of header removal
*//***************************************************************************/
typedef enum e_FmPcdManipHdrRmvByHdrType {
e_FM_PCD_MANIP_RMV_BY_HDR_SPECIFIC_L2 = 0, /**< Specific L2 fields removal */
#ifdef FM_CAPWAP_SUPPORT
e_FM_PCD_MANIP_RMV_BY_HDR_FROM_START, /**< Locate from data that is not the header */
#endif /* FM_CAPWAP_SUPPORT */
} e_FmPcdManipHdrRmvByHdrType;
/**************************************************************************//**
@Description Enumeration type for selecting type of timeout mode
*//***************************************************************************/
typedef enum e_FmPcdManipReassemTimeOutMode {
e_FM_PCD_MANIP_TIME_OUT_BETWEEN_FRAMES, /**< Limits the time of the reassembly process
from the first fragment to the last */
e_FM_PCD_MANIP_TIME_OUT_BETWEEN_FRAG /**< Limits the time of receiving the fragment */
} e_FmPcdManipReassemTimeOutMode;
/**************************************************************************//**
@Description Enumeration type for selecting type of WaysNumber mode
*//***************************************************************************/
typedef enum e_FmPcdManipReassemWaysNumber {
e_FM_PCD_MANIP_ONE_WAY_HASH = 1, /**< One way hash */
e_FM_PCD_MANIP_TWO_WAYS_HASH, /**< Two ways hash */
e_FM_PCD_MANIP_THREE_WAYS_HASH, /**< Three ways hash */
e_FM_PCD_MANIP_FOUR_WAYS_HASH, /**< Four ways hash */
e_FM_PCD_MANIP_FIVE_WAYS_HASH, /**< Five ways hash */
e_FM_PCD_MANIP_SIX_WAYS_HASH, /**< Six ways hash */
e_FM_PCD_MANIP_SEVEN_WAYS_HASH, /**< Seven ways hash */
e_FM_PCD_MANIP_EIGHT_WAYS_HASH /**< Eight ways hash */
} e_FmPcdManipReassemWaysNumber;
#ifdef FM_CAPWAP_SUPPORT
/**************************************************************************//**
@Description Enumeration type for selecting type of statistics mode
*//***************************************************************************/
typedef enum e_FmPcdStatsType {
e_FM_PCD_STATS_PER_FLOWID = 0 /**< Flow ID is used as index for getting statistics */
} e_FmPcdStatsType;
#endif /* FM_CAPWAP_SUPPORT */
/**************************************************************************//**
@Description Enumeration type for selecting manipulation type
*//***************************************************************************/
typedef enum e_FmPcdManipType {
e_FM_PCD_MANIP_HDR = 0, /**< Header manipulation */
e_FM_PCD_MANIP_REASSEM, /**< Reassembly */
e_FM_PCD_MANIP_FRAG, /**< Fragmentation */
e_FM_PCD_MANIP_SPECIAL_OFFLOAD /**< Special Offloading */
} e_FmPcdManipType;
/**************************************************************************//**
@Description Enumeration type for selecting type of statistics mode
*//***************************************************************************/
typedef enum e_FmPcdCcStatsMode {
e_FM_PCD_CC_STATS_MODE_NONE = 0, /**< No statistics support */
e_FM_PCD_CC_STATS_MODE_FRAME, /**< Frame count statistics */
e_FM_PCD_CC_STATS_MODE_BYTE_AND_FRAME, /**< Byte and frame count statistics */
#if (DPAA_VERSION >= 11)
e_FM_PCD_CC_STATS_MODE_RMON, /**< Byte and frame length range count statistics;
This mode is supported only on B4860 device */
#endif /* (DPAA_VERSION >= 11) */
} e_FmPcdCcStatsMode;
/**************************************************************************//**
@Description Enumeration type for determining the action in case an IP packet
is larger than MTU but its DF (Don't Fragment) bit is set.
*//***************************************************************************/
typedef enum e_FmPcdManipDontFragAction {
e_FM_PCD_MANIP_DISCARD_PACKET = 0, /**< Discard packet */
e_FM_PCD_MANIP_ENQ_TO_ERR_Q_OR_DISCARD_PACKET = e_FM_PCD_MANIP_DISCARD_PACKET,
/**< Obsolete, cannot enqueue to error queue;
In practice, selects to discard packets;
Will be removed in the future */
e_FM_PCD_MANIP_FRAGMENT_PACKET, /**< Fragment packet and continue normal processing */
e_FM_PCD_MANIP_CONTINUE_WITHOUT_FRAG /**< Continue normal processing without fragmenting the packet */
} e_FmPcdManipDontFragAction;
/**************************************************************************//**
@Description Enumeration type for selecting type of special offload manipulation
*//***************************************************************************/
typedef enum e_FmPcdManipSpecialOffloadType {
e_FM_PCD_MANIP_SPECIAL_OFFLOAD_IPSEC /**< IPSec offload manipulation */
} e_FmPcdManipSpecialOffloadType;
/**************************************************************************//**
@Description A Union of protocol dependent special options
*//***************************************************************************/
typedef union u_FmPcdHdrProtocolOpt {
ethProtocolOpt_t ethOpt; /**< Ethernet options */
vlanProtocolOpt_t vlanOpt; /**< VLAN options */
mplsProtocolOpt_t mplsOpt; /**< MPLS options */
ipv4ProtocolOpt_t ipv4Opt; /**< IPv4 options */
ipv6ProtocolOpt_t ipv6Opt; /**< IPv6 options */
} u_FmPcdHdrProtocolOpt;
/**************************************************************************//**
@Description A union holding protocol fields
Fields supported as "full fields":
HEADER_TYPE_ETH:
NET_HEADER_FIELD_ETH_DA
NET_HEADER_FIELD_ETH_SA
NET_HEADER_FIELD_ETH_TYPE
HEADER_TYPE_LLC_SNAP:
NET_HEADER_FIELD_LLC_SNAP_TYPE
HEADER_TYPE_VLAN:
NET_HEADER_FIELD_VLAN_TCI
(index may apply:
e_FM_PCD_HDR_INDEX_NONE/e_FM_PCD_HDR_INDEX_1,
e_FM_PCD_HDR_INDEX_LAST)
HEADER_TYPE_MPLS:
NET_HEADER_FIELD_MPLS_LABEL_STACK
(index may apply:
e_FM_PCD_HDR_INDEX_NONE/e_FM_PCD_HDR_INDEX_1,
e_FM_PCD_HDR_INDEX_2,
e_FM_PCD_HDR_INDEX_LAST)
HEADER_TYPE_IPv4:
NET_HEADER_FIELD_IPv4_SRC_IP
NET_HEADER_FIELD_IPv4_DST_IP
NET_HEADER_FIELD_IPv4_PROTO
NET_HEADER_FIELD_IPv4_TOS
(index may apply:
e_FM_PCD_HDR_INDEX_NONE/e_FM_PCD_HDR_INDEX_1,
e_FM_PCD_HDR_INDEX_2/e_FM_PCD_HDR_INDEX_LAST)
HEADER_TYPE_IPv6:
NET_HEADER_FIELD_IPv6_SRC_IP
NET_HEADER_FIELD_IPv6_DST_IP
NET_HEADER_FIELD_IPv6_NEXT_HDR
NET_HEADER_FIELD_IPv6_VER | NET_HEADER_FIELD_IPv6_FL | NET_HEADER_FIELD_IPv6_TC (must come together!)
(index may apply:
e_FM_PCD_HDR_INDEX_NONE/e_FM_PCD_HDR_INDEX_1,
e_FM_PCD_HDR_INDEX_2/e_FM_PCD_HDR_INDEX_LAST)
(Note that starting from DPAA 1-1, NET_HEADER_FIELD_IPv6_NEXT_HDR applies to
the last next header indication, meaning the next L4, which may be
present at the Ipv6 last extension. On earlier revisions this field
applies to the Next-Header field of the main IPv6 header)
HEADER_TYPE_IP:
NET_HEADER_FIELD_IP_PROTO
(index may apply:
e_FM_PCD_HDR_INDEX_LAST)
NET_HEADER_FIELD_IP_DSCP
(index may apply:
e_FM_PCD_HDR_INDEX_NONE/e_FM_PCD_HDR_INDEX_1)
HEADER_TYPE_GRE:
NET_HEADER_FIELD_GRE_TYPE
HEADER_TYPE_MINENCAP
NET_HEADER_FIELD_MINENCAP_SRC_IP
NET_HEADER_FIELD_MINENCAP_DST_IP
NET_HEADER_FIELD_MINENCAP_TYPE
HEADER_TYPE_TCP:
NET_HEADER_FIELD_TCP_PORT_SRC
NET_HEADER_FIELD_TCP_PORT_DST
NET_HEADER_FIELD_TCP_FLAGS
HEADER_TYPE_UDP:
NET_HEADER_FIELD_UDP_PORT_SRC
NET_HEADER_FIELD_UDP_PORT_DST
HEADER_TYPE_UDP_LITE: - relevant only if FM_CAPWAP_SUPPORT define
NET_HEADER_FIELD_UDP_LITE_PORT_SRC
NET_HEADER_FIELD_UDP_LITE_PORT_DST
HEADER_TYPE_IPSEC_AH:
NET_HEADER_FIELD_IPSEC_AH_SPI
NET_HEADER_FIELD_IPSEC_AH_NH
HEADER_TYPE_IPSEC_ESP:
NET_HEADER_FIELD_IPSEC_ESP_SPI
HEADER_TYPE_SCTP:
NET_HEADER_FIELD_SCTP_PORT_SRC
NET_HEADER_FIELD_SCTP_PORT_DST
HEADER_TYPE_DCCP:
NET_HEADER_FIELD_DCCP_PORT_SRC
NET_HEADER_FIELD_DCCP_PORT_DST
HEADER_TYPE_PPPoE:
NET_HEADER_FIELD_PPPoE_PID
NET_HEADER_FIELD_PPPoE_SID
*****************************************************************
Fields supported as "from fields":
HEADER_TYPE_ETH (with or without validation):
NET_HEADER_FIELD_ETH_TYPE
HEADER_TYPE_VLAN (with or without validation):
NET_HEADER_FIELD_VLAN_TCI
(index may apply:
e_FM_PCD_HDR_INDEX_NONE/e_FM_PCD_HDR_INDEX_1,
e_FM_PCD_HDR_INDEX_LAST)
HEADER_TYPE_IPv4 (without validation):
NET_HEADER_FIELD_IPv4_PROTO
(index may apply:
e_FM_PCD_HDR_INDEX_NONE/e_FM_PCD_HDR_INDEX_1,
e_FM_PCD_HDR_INDEX_2/e_FM_PCD_HDR_INDEX_LAST)
HEADER_TYPE_IPv6 (without validation):
NET_HEADER_FIELD_IPv6_NEXT_HDR
(index may apply:
e_FM_PCD_HDR_INDEX_NONE/e_FM_PCD_HDR_INDEX_1,
e_FM_PCD_HDR_INDEX_2/e_FM_PCD_HDR_INDEX_LAST)
*//***************************************************************************/
typedef union t_FmPcdFields {
headerFieldEth_t eth; /**< Ethernet */
headerFieldVlan_t vlan; /**< VLAN */
headerFieldLlcSnap_t llcSnap; /**< LLC SNAP */
headerFieldPppoe_t pppoe; /**< PPPoE */
headerFieldMpls_t mpls; /**< MPLS */
headerFieldIp_t ip; /**< IP */
headerFieldIpv4_t ipv4; /**< IPv4 */
headerFieldIpv6_t ipv6; /**< IPv6 */
headerFieldUdp_t udp; /**< UDP */
headerFieldUdpLite_t udpLite; /**< UDP Lite */
headerFieldTcp_t tcp; /**< TCP */
headerFieldSctp_t sctp; /**< SCTP */
headerFieldDccp_t dccp; /**< DCCP */
headerFieldGre_t gre; /**< GRE */
headerFieldMinencap_t minencap; /**< Minimal Encapsulation */
headerFieldIpsecAh_t ipsecAh; /**< IPSec AH */
headerFieldIpsecEsp_t ipsecEsp; /**< IPSec ESP */
headerFieldUdpEncapEsp_t udpEncapEsp; /**< UDP Encapsulation ESP */
} t_FmPcdFields;
/**************************************************************************//**
@Description Parameters for defining header extraction for key generation
*//***************************************************************************/
typedef struct t_FmPcdFromHdr {
uint8_t size; /**< Size in byte */
uint8_t offset; /**< Byte offset */
} t_FmPcdFromHdr;
/**************************************************************************//**
@Description Parameters for defining field extraction for key generation
*//***************************************************************************/
typedef struct t_FmPcdFromField {
t_FmPcdFields field; /**< Field selection */
uint8_t size; /**< Size in byte */
uint8_t offset; /**< Byte offset */
} t_FmPcdFromField;
/**************************************************************************//**
@Description Parameters for defining a single network environment unit
A distinction unit should be defined if it will later be used
by one or more PCD engines to distinguish between flows.
*//***************************************************************************/
typedef struct t_FmPcdDistinctionUnit {
struct {
e_NetHeaderType hdr; /**< One of the headers supported by the FM */
u_FmPcdHdrProtocolOpt opt; /**< Select only one option ! */
} hdrs[FM_PCD_MAX_NUM_OF_INTERCHANGEABLE_HDRS];
} t_FmPcdDistinctionUnit;
/**************************************************************************//**
@Description Parameters for defining all different distinction units supported
by a specific PCD Network Environment Characteristics module.
Each unit represent a protocol or a group of protocols that may
be used later by the different PCD engines to distinguish
between flows.
*//***************************************************************************/
typedef struct t_FmPcdNetEnvParams {
uint8_t numOfDistinctionUnits; /**< Number of different units to be identified */
t_FmPcdDistinctionUnit units[FM_PCD_MAX_NUM_OF_DISTINCTION_UNITS]; /**< An array of numOfDistinctionUnits of the
different units to be identified */
} t_FmPcdNetEnvParams;
/**************************************************************************//**
@Description Parameters for defining a single extraction action when
creating a key
*//***************************************************************************/
typedef struct t_FmPcdExtractEntry {
e_FmPcdExtractType type; /**< Extraction type select */
union {
struct {
e_NetHeaderType hdr; /**< Header selection */
bool ignoreProtocolValidation;
/**< Ignore protocol validation */
e_FmPcdHdrIndex hdrIndex; /**< Relevant only for MPLS, VLAN and tunneled
IP. Otherwise should be cleared. */
e_FmPcdExtractByHdrType type; /**< Header extraction type select */
union {
t_FmPcdFromHdr fromHdr; /**< Extract bytes from header parameters */
t_FmPcdFromField fromField; /**< Extract bytes from field parameters */
t_FmPcdFields fullField; /**< Extract full filed parameters */
} extractByHdrType;
} extractByHdr; /**< used when type = e_FM_PCD_KG_EXTRACT_BY_HDR */
struct {
e_FmPcdExtractFrom src; /**< Non-header extraction source */
e_FmPcdAction action; /**< Relevant for CC Only */
uint16_t icIndxMask; /**< Relevant only for CC when
action = e_FM_PCD_ACTION_INDEXED_LOOKUP;
Note that the number of bits that are set within
this mask must be log2 of the CC-node 'numOfKeys'.
Note that the mask cannot be set on the lower bits. */
uint8_t offset; /**< Byte offset */
uint8_t size; /**< Size in byte */
} extractNonHdr; /**< used when type = e_FM_PCD_KG_EXTRACT_NON_HDR */
};
} t_FmPcdExtractEntry;
/**************************************************************************//**
@Description Parameters for defining masks for each extracted field in the key.
*//***************************************************************************/
typedef struct t_FmPcdKgExtractMask {
uint8_t extractArrayIndex; /**< Index in the extraction array, as initialized by user */
uint8_t offset; /**< Byte offset */
uint8_t mask; /**< A byte mask (selected bits will be used) */
} t_FmPcdKgExtractMask;
/**************************************************************************//**
@Description Parameters for defining default selection per groups of fields
*//***************************************************************************/
typedef struct t_FmPcdKgExtractDflt {
e_FmPcdKgKnownFieldsDfltTypes type; /**< Default type select */
e_FmPcdKgExtractDfltSelect dfltSelect; /**< Default register select */
} t_FmPcdKgExtractDflt;
/**************************************************************************//**
@Description Parameters for defining key extraction and hashing
*//***************************************************************************/
typedef struct t_FmPcdKgKeyExtractAndHashParams {
uint32_t privateDflt0; /**< Scheme default register 0 */
uint32_t privateDflt1; /**< Scheme default register 1 */
uint8_t numOfUsedExtracts; /**< defines the valid size of the following array */
t_FmPcdExtractEntry extractArray [FM_PCD_KG_MAX_NUM_OF_EXTRACTS_PER_KEY]; /**< An array of extractions definition. */
uint8_t numOfUsedDflts; /**< defines the valid size of the following array */
t_FmPcdKgExtractDflt dflts[FM_PCD_KG_NUM_OF_DEFAULT_GROUPS];
/**< For each extraction used in this scheme, specify the required
default register to be used when header is not found.
types not specified in this array will get undefined value. */
uint8_t numOfUsedMasks; /**< defines the valid size of the following array */
t_FmPcdKgExtractMask masks[FM_PCD_KG_NUM_OF_EXTRACT_MASKS];
uint8_t hashShift; /**< hash result right shift. Select the 24 bits out of the 64 hash
result. 0 means using the 24 LSB's, otherwise use the
24 LSB's after shifting right.*/
uint32_t hashDistributionNumOfFqids; /**< must be > 1 and a power of 2. Represents the range
of queues for the key and hash functionality */
uint8_t hashDistributionFqidsShift; /**< selects the FQID bits that will be effected by the hash */
bool symmetricHash; /**< TRUE to generate the same hash for frames with swapped source and
destination fields on all layers; If TRUE, driver will check that for
all layers, if SRC extraction is selected, DST extraction must also be
selected, and vice versa. */
} t_FmPcdKgKeyExtractAndHashParams;
/**************************************************************************//**
@Description Parameters for defining a single FQID mask (extracted OR).
*//***************************************************************************/
typedef struct t_FmPcdKgExtractedOrParams {
e_FmPcdExtractType type; /**< Extraction type select */
union {
struct { /**< used when type = e_FM_PCD_KG_EXTRACT_BY_HDR */
e_NetHeaderType hdr;
e_FmPcdHdrIndex hdrIndex; /**< Relevant only for MPLS, VLAN and tunneled
IP. Otherwise should be cleared.*/
bool ignoreProtocolValidation;
/**< continue extraction even if protocol is not recognized */
} extractByHdr; /**< Header to extract by */
e_FmPcdExtractFrom src; /**< used when type = e_FM_PCD_KG_EXTRACT_NON_HDR */
};
uint8_t extractionOffset; /**< Offset for extraction (in bytes). */
e_FmPcdKgExtractDfltSelect dfltValue; /**< Select register from which extraction is taken if
field not found */
uint8_t mask; /**< Extraction mask (specified bits are used) */
uint8_t bitOffsetInFqid; /**< 0-31, Selects which bits of the 24 FQID bits to effect using
the extracted byte; Assume byte is placed as the 8 MSB's in
a 32 bit word where the lower bits
are the FQID; i.e if bitOffsetInFqid=1 than its LSB
will effect the FQID MSB, if bitOffsetInFqid=24 than the
extracted byte will effect the 8 LSB's of the FQID,
if bitOffsetInFqid=31 than the byte's MSB will effect
the FQID's LSB; 0 means - no effect on FQID;
Note that one, and only one of
bitOffsetInFqid or bitOffsetInPlcrProfile must be set (i.e,
extracted byte must effect either FQID or Policer profile).*/
uint8_t bitOffsetInPlcrProfile;
/**< 0-15, Selects which bits of the 8 policer profile id bits to
effect using the extracted byte; Assume byte is placed
as the 8 MSB's in a 16 bit word where the lower bits
are the policer profile id; i.e if bitOffsetInPlcrProfile=1
than its LSB will effect the profile MSB, if bitOffsetInFqid=8
than the extracted byte will effect the whole policer profile id,
if bitOffsetInFqid=15 than the byte's MSB will effect
the Policer Profile id's LSB;
0 means - no effect on policer profile; Note that one, and only one of
bitOffsetInFqid or bitOffsetInPlcrProfile must be set (i.e,
extracted byte must effect either FQID or Policer profile).*/
} t_FmPcdKgExtractedOrParams;
/**************************************************************************//**
@Description Parameters for configuring a scheme counter
*//***************************************************************************/
typedef struct t_FmPcdKgSchemeCounter {
bool update; /**< FALSE to keep the current counter state
and continue from that point, TRUE to update/reset
the counter when the scheme is written. */
uint32_t value; /**< If update=TRUE, this value will be written into the
counter. clear this field to reset the counter. */
} t_FmPcdKgSchemeCounter;
/**************************************************************************//**
@Description Parameters for configuring a policer profile for a KeyGen scheme
(when policer is the next engine after this scheme).
*//***************************************************************************/
typedef struct t_FmPcdKgPlcrProfile {
bool sharedProfile; /**< TRUE if this profile is shared between ports
(managed by master partition); Must not be TRUE
if profile is after Coarse Classification*/
bool direct; /**< if TRUE, directRelativeProfileId only selects the profile
id, if FALSE fqidOffsetRelativeProfileIdBase is used
together with fqidOffsetShift and numOfProfiles
parameters, to define a range of profiles from
which the KeyGen result will determine the
destination policer profile. */
union {
uint16_t directRelativeProfileId; /**< Used if 'direct' is TRUE, to select policer profile.
should indicate the policer profile offset within the
port's policer profiles or shared window. */
struct {
uint8_t fqidOffsetShift; /**< Shift on the KeyGen create FQID offset (i.e. not the
final FQID - without the FQID base). */
uint8_t fqidOffsetRelativeProfileIdBase;
/**< The base of the FMan Port's relative Storage-Profile ID;
this value will be "OR'ed" with the KeyGen create FQID
offset (i.e. not the final FQID - without the FQID base);
the final result should indicate the Storage-Profile offset
within the FMan Port's relative Storage-Profiles window/
(or the SHARED window depends on 'sharedProfile'). */
uint8_t numOfProfiles; /**< Range of profiles starting at base */
} indirectProfile; /**< Indirect profile parameters */
} profileSelect; /**< Direct/indirect profile selection and parameters */
} t_FmPcdKgPlcrProfile;
#if (DPAA_VERSION >= 11)
/**************************************************************************//**
@Description Parameters for configuring a storage profile for a KeyGen scheme.
*//***************************************************************************/
typedef struct t_FmPcdKgStorageProfile {
bool direct; /**< If TRUE, directRelativeProfileId only selects the
profile id;
If FALSE, fqidOffsetRelativeProfileIdBase is used
together with fqidOffsetShift and numOfProfiles
parameters to define a range of profiles from which
the KeyGen result will determine the destination
storage profile. */
union {
uint16_t directRelativeProfileId; /**< Used when 'direct' is TRUE, to select a storage profile;
should indicate the storage profile offset within the
port's storage profiles window. */
struct {
uint8_t fqidOffsetShift; /**< Shift on the KeyGen create FQID offset (i.e. not the
final FQID - without the FQID base). */
uint8_t fqidOffsetRelativeProfileIdBase;
/**< The base of the FMan Port's relative Storage-Profile ID;
this value will be "OR'ed" with the KeyGen create FQID
offset (i.e. not the final FQID - without the FQID base);
the final result should indicate the Storage-Profile offset
within the FMan Port's relative Storage-Profiles window. */
uint8_t numOfProfiles; /**< Range of profiles starting at base. */
} indirectProfile; /**< Indirect profile parameters. */
} profileSelect; /**< Direct/indirect profile selection and parameters. */
} t_FmPcdKgStorageProfile;
#endif /* (DPAA_VERSION >= 11) */
/**************************************************************************//**
@Description Parameters for defining CC as the next engine after KeyGen
*//***************************************************************************/
typedef struct t_FmPcdKgCc {
t_Handle h_CcTree; /**< A handle to a CC Tree */
uint8_t grpId; /**< CC group id within the CC tree */
bool plcrNext; /**< TRUE if after CC, in case of data frame,
policing is required. */
bool bypassPlcrProfileGeneration; /**< TRUE to bypass KeyGen policer profile generation;
selected profile is the one set at port initialization. */
t_FmPcdKgPlcrProfile plcrProfile; /**< Valid only if plcrNext = TRUE and
bypassPlcrProfileGeneration = FALSE */
} t_FmPcdKgCc;
/**************************************************************************//**
@Description Parameters for defining initializing a KeyGen scheme
*//***************************************************************************/
typedef struct t_FmPcdKgSchemeParams {
bool modify; /**< TRUE to change an existing scheme */
union
{
uint8_t relativeSchemeId; /**< if modify=FALSE:Partition relative scheme id */
t_Handle h_Scheme; /**< if modify=TRUE: a handle of the existing scheme */
} id;
bool alwaysDirect; /**< This scheme is reached only directly, i.e. no need
for match vector; KeyGen will ignore it when matching */
struct { /**< HL Relevant only if alwaysDirect = FALSE */
t_Handle h_NetEnv; /**< A handle to the Network environment as returned
by FM_PCD_NetEnvCharacteristicsSet() */
uint8_t numOfDistinctionUnits; /**< Number of NetEnv units listed in unitIds array */
uint8_t unitIds[FM_PCD_MAX_NUM_OF_DISTINCTION_UNITS];
/**< Indexes as passed to SetNetEnvCharacteristics array*/
} netEnvParams;
bool useHash; /**< use the KeyGen Hash functionality */
t_FmPcdKgKeyExtractAndHashParams keyExtractAndHashParams;
/**< used only if useHash = TRUE */
bool bypassFqidGeneration; /**< Normally - FALSE, TRUE to avoid FQID update in the IC;
In such a case FQID after KeyGen will be the default FQID
defined for the relevant port, or the FQID defined by CC
in cases where CC was the previous engine. */
uint32_t baseFqid; /**< Base FQID; Relevant only if bypassFqidGeneration = FALSE;
If hash is used and an even distribution is expected
according to hashDistributionNumOfFqids, baseFqid must be aligned to
hashDistributionNumOfFqids. */
uint8_t numOfUsedExtractedOrs; /**< Number of FQID masks listed in extractedOrs array */
t_FmPcdKgExtractedOrParams extractedOrs[FM_PCD_KG_NUM_OF_GENERIC_REGS];
/**< FM_PCD_KG_NUM_OF_GENERIC_REGS
registers are shared between qidMasks
functionality and some of the extraction
actions; Normally only some will be used
for qidMask. Driver will return error if
resource is full at initialization time. */
#if (DPAA_VERSION >= 11)
bool overrideStorageProfile; /**< TRUE if KeyGen override previously decided storage profile */
t_FmPcdKgStorageProfile storageProfile; /**< Used when overrideStorageProfile TRUE */
#endif /* (DPAA_VERSION >= 11) */
e_FmPcdEngine nextEngine; /**< may be BMI, PLCR or CC */
union { /**< depends on nextEngine */
e_FmPcdDoneAction doneAction; /**< Used when next engine is BMI (done) */
t_FmPcdKgPlcrProfile plcrProfile; /**< Used when next engine is PLCR */
t_FmPcdKgCc cc; /**< Used when next engine is CC */
} kgNextEngineParams;
t_FmPcdKgSchemeCounter schemeCounter; /**< A structure of parameters for updating
the scheme counter */
} t_FmPcdKgSchemeParams;
/**************************************************************************//**
@Collection Definitions for CC statistics
*//***************************************************************************/
#if (DPAA_VERSION >= 11)
#define FM_PCD_CC_STATS_MAX_NUM_OF_FLR 10 /* Maximal supported number of frame length ranges */
#define FM_PCD_CC_STATS_FLR_SIZE 2 /* Size in bytes of a frame length range limit */
#endif /* (DPAA_VERSION >= 11) */
#define FM_PCD_CC_STATS_COUNTER_SIZE 4 /* Size in bytes of a frame length range counter */
/* @} */
/**************************************************************************//**
@Description Parameters for defining CC as the next engine after a CC node.
*//***************************************************************************/
typedef struct t_FmPcdCcNextCcParams {
t_Handle h_CcNode; /**< A handle of the next CC node */
} t_FmPcdCcNextCcParams;
#if (DPAA_VERSION >= 11)
/**************************************************************************//**
@Description Parameters for defining Frame replicator as the next engine after a CC node.
*//***************************************************************************/
typedef struct t_FmPcdCcNextFrParams {
t_Handle h_FrmReplic; /**< A handle of the next frame replicator group */
} t_FmPcdCcNextFrParams;
#endif /* (DPAA_VERSION >= 11) */
/**************************************************************************//**
@Description Parameters for defining Policer as the next engine after a CC node.
*//***************************************************************************/
typedef struct t_FmPcdCcNextPlcrParams {
bool overrideParams; /**< TRUE if CC override previously decided parameters*/
bool sharedProfile; /**< Relevant only if overrideParams=TRUE:
TRUE if this profile is shared between ports */
uint16_t newRelativeProfileId; /**< Relevant only if overrideParams=TRUE:
(otherwise profile id is taken from KeyGen);
This parameter should indicate the policer
profile offset within the port's
policer profiles or from SHARED window.*/
uint32_t newFqid; /**< Relevant only if overrideParams=TRUE:
FQID for enqueuing the frame;
In earlier chips if policer next engine is KEYGEN,
this parameter can be 0, because the KEYGEN
always decides the enqueue FQID.*/
#if (DPAA_VERSION >= 11)
uint8_t newRelativeStorageProfileId;
/**< Indicates the relative storage profile offset within
the port's storage profiles window;
Relevant only if the port was configured with VSP. */
#endif /* (DPAA_VERSION >= 11) */
} t_FmPcdCcNextPlcrParams;
/**************************************************************************//**
@Description Parameters for defining enqueue as the next action after a CC node.
*//***************************************************************************/
typedef struct t_FmPcdCcNextEnqueueParams {
e_FmPcdDoneAction action; /**< Action - when next engine is BMI (done) */
bool overrideFqid; /**< TRUE if CC override previously decided fqid and vspid,
relevant if action = e_FM_PCD_ENQ_FRAME */
uint32_t newFqid; /**< Valid if overrideFqid=TRUE, FQID for enqueuing the frame
(otherwise FQID is taken from KeyGen),
relevant if action = e_FM_PCD_ENQ_FRAME */
#if (DPAA_VERSION >= 11)
uint8_t newRelativeStorageProfileId;
/**< Valid if overrideFqid=TRUE, Indicates the relative virtual
storage profile offset within the port's storage profiles
window; Relevant only if the port was configured with VSP. */
#endif /* (DPAA_VERSION >= 11) */
} t_FmPcdCcNextEnqueueParams;
/**************************************************************************//**
@Description Parameters for defining KeyGen as the next engine after a CC node.
*//***************************************************************************/
typedef struct t_FmPcdCcNextKgParams {
bool overrideFqid; /**< TRUE if CC override previously decided fqid and vspid,
Note - this parameters irrelevant for earlier chips */
uint32_t newFqid; /**< Valid if overrideFqid=TRUE, FQID for enqueuing the frame
(otherwise FQID is taken from KeyGen),
Note - this parameters irrelevant for earlier chips */
#if (DPAA_VERSION >= 11)
uint8_t newRelativeStorageProfileId;
/**< Valid if overrideFqid=TRUE, Indicates the relative virtual
storage profile offset within the port's storage profiles
window; Relevant only if the port was configured with VSP. */
#endif /* (DPAA_VERSION >= 11) */
t_Handle h_DirectScheme; /**< Direct scheme handle to go to. */
} t_FmPcdCcNextKgParams;
/**************************************************************************//**
@Description Parameters for defining the next engine after a CC node.
*//***************************************************************************/
typedef struct t_FmPcdCcNextEngineParams {
e_FmPcdEngine nextEngine; /**< User has to initialize parameters
according to nextEngine definition */
union {
t_FmPcdCcNextCcParams ccParams; /**< Parameters in case next engine is CC */
t_FmPcdCcNextPlcrParams plcrParams; /**< Parameters in case next engine is PLCR */
t_FmPcdCcNextEnqueueParams enqueueParams; /**< Parameters in case next engine is BMI */
t_FmPcdCcNextKgParams kgParams; /**< Parameters in case next engine is KG */
#if (DPAA_VERSION >= 11)
t_FmPcdCcNextFrParams frParams; /**< Parameters in case next engine is FR */
#endif /* (DPAA_VERSION >= 11) */
} params; /**< union used for all the next-engine parameters options */
t_Handle h_Manip; /**< Handle to Manipulation object.
Relevant if next engine is of type result
(e_FM_PCD_PLCR, e_FM_PCD_KG, e_FM_PCD_DONE) */
bool statisticsEn; /**< If TRUE, statistics counters are incremented
for each frame passing through this
Coarse Classification entry. */
} t_FmPcdCcNextEngineParams;
/**************************************************************************//**
@Description Parameters for defining a single CC key
*//***************************************************************************/
typedef struct t_FmPcdCcKeyParams {
uint8_t *p_Key; /**< Relevant only if 'action' = e_FM_PCD_ACTION_EXACT_MATCH;
pointer to the key of the size defined in keySize */
uint8_t *p_Mask; /**< Relevant only if 'action' = e_FM_PCD_ACTION_EXACT_MATCH;
pointer to the Mask per key of the size defined
in keySize. p_Key and p_Mask (if defined) has to be
of the same size defined in the keySize;
NOTE that if this value is equal for all entries whithin
this table, the driver will automatically use global-mask
(i.e. one common mask for all entries) instead of private
one; that is done in order to spare some memory and for
better performance. */
t_FmPcdCcNextEngineParams ccNextEngineParams;
/**< parameters for the next for the defined Key in
the p_Key */
} t_FmPcdCcKeyParams;
/**************************************************************************//**
@Description Parameters for defining CC keys parameters
The driver supports two methods for CC node allocation: dynamic and static.
Static mode was created in order to prevent runtime alloc/free
of FMan memory (MURAM), which may cause fragmentation; in this mode,
the driver automatically allocates the memory according to
'maxNumOfKeys' parameter. The driver calculates the maximal memory
size that may be used for this CC-Node taking into consideration
'maskSupport' and 'statisticsMode' parameters.
When 'action' = e_FM_PCD_ACTION_INDEXED_LOOKUP in the extraction
parameters of this node, 'maxNumOfKeys' must be equal to 'numOfKeys'.
In dynamic mode, 'maxNumOfKeys' must be zero. At initialization,
all required structures are allocated according to 'numOfKeys'
parameter. During runtime modification, these structures are
re-allocated according to the updated number of keys.
Please note that 'action' and 'icIndxMask' mentioned in the
specific parameter explanations are passed in the extraction
parameters of the node (fields of extractCcParams.extractNonHdr).
*//***************************************************************************/
typedef struct t_KeysParams {
uint16_t maxNumOfKeys; /**< Maximum number of keys that will (ever) be used in this CC-Node;
A value of zero may be used for dynamic memory allocation. */
bool maskSupport; /**< This parameter is relevant only if a node is initialized with
'action' = e_FM_PCD_ACTION_EXACT_MATCH and maxNumOfKeys > 0;
Should be TRUE to reserve table memory for key masks, even if
initial keys do not contain masks, or if the node was initialized
as 'empty' (without keys); this will allow user to add keys with
masks at runtime.
NOTE that if user want to use only global-masks (i.e. one common mask
for all the entries within this table, this parameter should set to 'FALSE'. */
e_FmPcdCcStatsMode statisticsMode; /**< Determines the supported statistics mode for all node's keys.
To enable statistics gathering, statistics should be enabled per
every key, using 'statisticsEn' in next engine parameters structure
of that key;
If 'maxNumOfKeys' is set, all required structures will be
preallocated for all keys. */
#if (DPAA_VERSION >= 11)
uint16_t frameLengthRanges[FM_PCD_CC_STATS_MAX_NUM_OF_FLR];
/**< Relevant only for 'RMON' statistics mode
(this feature is supported only on B4860 device);
Holds a list of programmable thresholds - for each received frame,
its length in bytes is examined against these range thresholds and
the appropriate counter is incremented by 1 - for example, to belong
to range i, the following should hold:
range i-1 threshold < frame length <= range i threshold
Each range threshold must be larger then its preceding range
threshold, and last range threshold must be 0xFFFF. */
#endif /* (DPAA_VERSION >= 11) */
uint16_t numOfKeys; /**< Number of initial keys;
Note that in case of 'action' = e_FM_PCD_ACTION_INDEXED_LOOKUP,
this field should be power-of-2 of the number of bits that are
set in 'icIndxMask'. */
uint8_t keySize; /**< Size of key - for extraction of type FULL_FIELD, 'keySize' has
to be the standard size of the selected key; For other extraction
types, 'keySize' has to be as size of extraction; When 'action' =
e_FM_PCD_ACTION_INDEXED_LOOKUP, 'keySize' must be 2. */
t_FmPcdCcKeyParams keyParams[FM_PCD_MAX_NUM_OF_KEYS];
/**< An array with 'numOfKeys' entries, each entry specifies the
corresponding key parameters;
When 'action' = e_FM_PCD_ACTION_EXACT_MATCH, this value must not
exceed 255 (FM_PCD_MAX_NUM_OF_KEYS-1) as the last entry is saved
for the 'miss' entry. */
t_FmPcdCcNextEngineParams ccNextEngineParamsForMiss;
/**< Parameters for defining the next engine when a key is not matched;
Not relevant if action = e_FM_PCD_ACTION_INDEXED_LOOKUP. */
} t_KeysParams;
/**************************************************************************//**
@Description Parameters for defining a CC node
*//***************************************************************************/
typedef struct t_FmPcdCcNodeParams {
t_FmPcdExtractEntry extractCcParams; /**< Extraction parameters */
t_KeysParams keysParams; /**< Keys definition matching the selected extraction */
} t_FmPcdCcNodeParams;
/**************************************************************************//**
@Description Parameters for defining a hash table
*//***************************************************************************/
typedef struct t_FmPcdHashTableParams {
uint16_t maxNumOfKeys; /**< Maximum Number Of Keys that will (ever) be used in this Hash-table */
e_FmPcdCcStatsMode statisticsMode; /**< If not e_FM_PCD_CC_STATS_MODE_NONE, the required structures for the
requested statistics mode will be allocated according to maxNumOfKeys. */
uint8_t kgHashShift; /**< KG-Hash-shift as it was configured in the KG-scheme
that leads to this hash-table. */
uint16_t hashResMask; /**< Mask that will be used on the hash-result;
The number-of-sets for this hash will be calculated
as (2^(number of bits set in 'hashResMask'));
The 4 lower bits must be cleared. */
uint8_t hashShift; /**< Byte offset from the beginning of the KeyGen hash result to the
2-bytes to be used as hash index. */
uint8_t matchKeySize; /**< Size of the exact match keys held by the hash buckets */
t_FmPcdCcNextEngineParams ccNextEngineParamsForMiss; /**< Parameters for defining the next engine when a key is not matched */
} t_FmPcdHashTableParams;
/**************************************************************************//**
@Description Parameters for defining a CC tree group.
This structure defines a CC group in terms of NetEnv units
and the action to be taken in each case. The unitIds list must
be given in order from low to high indices.
t_FmPcdCcNextEngineParams is a list of 2^numOfDistinctionUnits
structures where each defines the next action to be taken for
each units combination. for example:
numOfDistinctionUnits = 2
unitIds = {1,3}
p_NextEnginePerEntriesInGrp[0] = t_FmPcdCcNextEngineParams for the case that
unit 1 - not found; unit 3 - not found;
p_NextEnginePerEntriesInGrp[1] = t_FmPcdCcNextEngineParams for the case that
unit 1 - not found; unit 3 - found;
p_NextEnginePerEntriesInGrp[2] = t_FmPcdCcNextEngineParams for the case that
unit 1 - found; unit 3 - not found;
p_NextEnginePerEntriesInGrp[3] = t_FmPcdCcNextEngineParams for the case that
unit 1 - found; unit 3 - found;
*//***************************************************************************/
typedef struct t_FmPcdCcGrpParams {
uint8_t numOfDistinctionUnits; /**< Up to 4 */
uint8_t unitIds[FM_PCD_MAX_NUM_OF_CC_UNITS];
/**< Indices of the units as defined in
FM_PCD_NetEnvCharacteristicsSet() */
t_FmPcdCcNextEngineParams nextEnginePerEntriesInGrp[FM_PCD_MAX_NUM_OF_CC_ENTRIES_IN_GRP];
/**< Maximum entries per group is 16 */
} t_FmPcdCcGrpParams;
/**************************************************************************//**
@Description Parameters for defining CC tree groups
*//***************************************************************************/
typedef struct t_FmPcdCcTreeParams {
t_Handle h_NetEnv; /**< A handle to the Network environment as returned
by FM_PCD_NetEnvCharacteristicsSet() */
uint8_t numOfGrps; /**< Number of CC groups within the CC tree */
t_FmPcdCcGrpParams ccGrpParams[FM_PCD_MAX_NUM_OF_CC_GROUPS];
/**< Parameters for each group. */
} t_FmPcdCcTreeParams;
/**************************************************************************//**
@Description CC key statistics structure
*//***************************************************************************/
typedef struct t_FmPcdCcKeyStatistics {
uint32_t byteCount; /**< This counter reflects byte count of frames that
were matched by this key. */
uint32_t frameCount; /**< This counter reflects count of frames that
were matched by this key. */
#if (DPAA_VERSION >= 11)
uint32_t frameLengthRangeCount[FM_PCD_CC_STATS_MAX_NUM_OF_FLR];
/**< These counters reflect how many frames matched
this key in 'RMON' statistics mode:
Each counter holds the number of frames of a
specific frames length range, according to the
ranges provided at initialization. */
#endif /* (DPAA_VERSION >= 11) */
} t_FmPcdCcKeyStatistics;
/**************************************************************************//**
@Description Parameters for defining policer byte rate
*//***************************************************************************/
typedef struct t_FmPcdPlcrByteRateModeParams {
e_FmPcdPlcrFrameLengthSelect frameLengthSelection; /**< Frame length selection */
e_FmPcdPlcrRollBackFrameSelect rollBackFrameSelection; /**< relevant option only e_FM_PCD_PLCR_L2_FRM_LEN,
e_FM_PCD_PLCR_FULL_FRM_LEN */
} t_FmPcdPlcrByteRateModeParams;
/**************************************************************************//**
@Description Parameters for defining the policer profile (based on
RFC-2698 or RFC-4115 attributes).
*//***************************************************************************/
typedef struct t_FmPcdPlcrNonPassthroughAlgParams {
e_FmPcdPlcrRateMode rateMode; /**< Byte mode or Packet mode */
t_FmPcdPlcrByteRateModeParams byteModeParams; /**< Valid for Byte NULL for Packet */
uint32_t comittedInfoRate; /**< KBits/Second or Packets/Second */
uint32_t comittedBurstSize; /**< Bytes/Packets */
uint32_t peakOrAccessiveInfoRate; /**< KBits/Second or Packets/Second */
uint32_t peakOrAccessiveBurstSize; /**< Bytes/Packets */
} t_FmPcdPlcrNonPassthroughAlgParams;
/**************************************************************************//**
@Description Parameters for defining the next engine after policer
*//***************************************************************************/
typedef union u_FmPcdPlcrNextEngineParams {
e_FmPcdDoneAction action; /**< Action - when next engine is BMI (done) */
t_Handle h_Profile; /**< Policer profile handle - used when next engine
is Policer, must be a SHARED profile */
t_Handle h_DirectScheme; /**< Direct scheme select - when next engine is KeyGen */
} u_FmPcdPlcrNextEngineParams;
/**************************************************************************//**
@Description Parameters for defining the policer profile entry
*//***************************************************************************/
typedef struct t_FmPcdPlcrProfileParams {
bool modify; /**< TRUE to change an existing profile */
union {
struct {
e_FmPcdProfileTypeSelection profileType; /**< Type of policer profile */
t_Handle h_FmPort; /**< Relevant for per-port profiles only */
uint16_t relativeProfileId; /**< Profile id - relative to shared group or to port */
} newParams; /**< use it when modify = FALSE */
t_Handle h_Profile; /**< A handle to a profile - use it when modify=TRUE */
} id;
e_FmPcdPlcrAlgorithmSelection algSelection; /**< Profile Algorithm PASS_THROUGH, RFC_2698, RFC_4115 */
e_FmPcdPlcrColorMode colorMode; /**< COLOR_BLIND, COLOR_AWARE */
union {
e_FmPcdPlcrColor dfltColor; /**< For Color-Blind Pass-Through mode; the policer will re-color
any incoming packet with the default value. */
e_FmPcdPlcrColor override; /**< For Color-Aware modes; the profile response to a
pre-color value of 2'b11. */
} color;
t_FmPcdPlcrNonPassthroughAlgParams nonPassthroughAlgParams; /**< RFC2698 or RFC4115 parameters */
e_FmPcdEngine nextEngineOnGreen; /**< Next engine for green-colored frames */
u_FmPcdPlcrNextEngineParams paramsOnGreen; /**< Next engine parameters for green-colored frames */
e_FmPcdEngine nextEngineOnYellow; /**< Next engine for yellow-colored frames */
u_FmPcdPlcrNextEngineParams paramsOnYellow; /**< Next engine parameters for yellow-colored frames */
e_FmPcdEngine nextEngineOnRed; /**< Next engine for red-colored frames */
u_FmPcdPlcrNextEngineParams paramsOnRed; /**< Next engine parameters for red-colored frames */
bool trapProfileOnFlowA; /**< Obsolete - do not use */
bool trapProfileOnFlowB; /**< Obsolete - do not use */
bool trapProfileOnFlowC; /**< Obsolete - do not use */
} t_FmPcdPlcrProfileParams;
/**************************************************************************//**
@Description Parameters for selecting a location for requested manipulation
*//***************************************************************************/
typedef struct t_FmManipHdrInfo
{
e_NetHeaderType hdr; /**< Header selection */
e_FmPcdHdrIndex hdrIndex; /**< Relevant only for MPLS, VLAN and tunneled IP. Otherwise should be cleared. */
bool byField; /**< TRUE if the location of manipulation is according to some field in the specific header*/
t_FmPcdFields fullField; /**< Relevant only when byField = TRUE: Extract field */
} t_FmManipHdrInfo;
#ifdef FM_CAPWAP_SUPPORT
/**************************************************************************//**
@Description Parameters for defining an insertion manipulation
of type e_FM_PCD_MANIP_INSRT_TO_START_OF_FRAME_TEMPLATE
*//***************************************************************************/
typedef struct t_FmPcdManipHdrInsrtByTemplateParams {
uint8_t size; /**< Size of insert template to the start of the frame. */
uint8_t hdrTemplate[FM_PCD_MAX_MANIP_INSRT_TEMPLATE_SIZE];
/**< Array of the insertion template. */
bool modifyOuterIp; /**< TRUE if user want to modify some fields in outer IP. */
struct {
uint16_t ipOuterOffset; /**< Offset of outer IP in the insert template, relevant if modifyOuterIp = TRUE.*/
uint16_t dscpEcn; /**< value of dscpEcn in IP outer, relevant if modifyOuterIp = TRUE.
in IPV4 dscpEcn only byte - it has to be adjusted to the right*/
bool udpPresent; /**< TRUE if UDP is present in the insert template, relevant if modifyOuterIp = TRUE.*/
uint8_t udpOffset; /**< Offset in the insert template of UDP, relevant if modifyOuterIp = TRUE and udpPresent=TRUE.*/
uint8_t ipIdentGenId; /**< Used by FMan-CTRL to calculate IP-identification field,relevant if modifyOuterIp = TRUE.*/
bool recalculateLength; /**< TRUE if recalculate length has to be performed due to the engines in the path which can change the frame later, relevant if modifyOuterIp = TRUE.*/
struct {
uint8_t blockSize; /**< The CAAM block-size; Used by FMan-CTRL to calculate the IP Total Length field.*/
uint8_t extraBytesAddedAlignedToBlockSize; /**< Used by FMan-CTRL to calculate the IP Total Length field and UDP length*/
uint8_t extraBytesAddedNotAlignedToBlockSize;/**< Used by FMan-CTRL to calculate the IP Total Length field and UDP length.*/
} recalculateLengthParams; /**< Recalculate length parameters - relevant if modifyOuterIp = TRUE and recalculateLength = TRUE */
} modifyOuterIpParams; /**< Outer IP modification parameters - ignored if modifyOuterIp is FALSE */
bool modifyOuterVlan; /**< TRUE if user wants to modify VPri field in the outer VLAN header*/
struct {
uint8_t vpri; /**< Value of VPri, relevant if modifyOuterVlan = TRUE
VPri only 3 bits, it has to be adjusted to the right*/
} modifyOuterVlanParams;
} t_FmPcdManipHdrInsrtByTemplateParams;
/**************************************************************************//**
@Description Parameters for defining CAPWAP fragmentation
*//***************************************************************************/
typedef struct t_CapwapFragmentationParams {
uint16_t sizeForFragmentation; /**< if length of the frame is greater than this value, CAPWAP fragmentation will be executed.*/
bool headerOptionsCompr; /**< TRUE - first fragment include the CAPWAP header options field,
and all other fragments exclude the CAPWAP options field,
FALSE - all fragments include CAPWAP header options field. */
} t_CapwapFragmentationParams;
/**************************************************************************//**
@Description Parameters for defining CAPWAP reassembly
*//***************************************************************************/
typedef struct t_CapwapReassemblyParams {
uint16_t maxNumFramesInProcess; /**< Number of frames which can be reassembled concurrently; must be power of 2.
In case numOfFramesPerHashEntry == e_FM_PCD_MANIP_FOUR_WAYS_HASH,
maxNumFramesInProcess has to be in the range of 4 - 512,
In case numOfFramesPerHashEntry == e_FM_PCD_MANIP_EIGHT_WAYS_HASH,
maxNumFramesInProcess has to be in the range of 8 - 2048 */
bool haltOnDuplicationFrag; /**< If TRUE, reassembly process will be halted due to duplicated fragment,
and all processed fragments will be enqueued with error indication;
If FALSE, only duplicated fragments will be enqueued with error indication. */
e_FmPcdManipReassemTimeOutMode timeOutMode; /**< Expiration delay initialized by the reassembly process */
uint32_t fqidForTimeOutFrames; /**< FQID in which time out frames will enqueue during Time Out Process */
uint32_t timeoutRoutineRequestTime;
/**< Represents the time interval in microseconds between consecutive
timeout routine requests It has to be power of 2. */
uint32_t timeoutThresholdForReassmProcess;
/**< Time interval (microseconds) for marking frames in process as too old;
Frames in process are those for which at least one fragment was received
but not all fragments. */
e_FmPcdManipReassemWaysNumber numOfFramesPerHashEntry;/**< Number of frames per hash entry (needed for the reassembly process) */
} t_CapwapReassemblyParams;
/**************************************************************************//**
@Description Parameters for defining fragmentation/reassembly manipulation
*//***************************************************************************/
typedef struct t_FmPcdManipFragOrReasmParams {
bool frag; /**< TRUE if using the structure for fragmentation,
otherwise this structure is used for reassembly */
uint8_t sgBpid; /**< Scatter/Gather buffer pool id;
Same LIODN number is used for these buffers as for
the received frames buffers, so buffers of this pool
need to be allocated in the same memory area as the
received buffers. If the received buffers arrive
from different sources, the Scatter/Gather BP id
should be mutual to all these sources. */
e_NetHeaderType hdr; /**< Header selection */
union {
t_CapwapFragmentationParams capwapFragParams; /**< Structure for CAPWAP fragmentation,
relevant if 'frag' = TRUE, 'hdr' = HEADER_TYPE_CAPWAP */
t_CapwapReassemblyParams capwapReasmParams; /**< Structure for CAPWAP reassembly,
relevant if 'frag' = FALSE, 'hdr' = HEADER_TYPE_CAPWAP */
} u;
} t_FmPcdManipFragOrReasmParams;
#endif /* FM_CAPWAP_SUPPORT */
/**************************************************************************//**
@Description Parameters for defining header removal by header type
*//***************************************************************************/
typedef struct t_FmPcdManipHdrRmvByHdrParams {
e_FmPcdManipHdrRmvByHdrType type; /**< Selection of header removal location */
union {
#ifdef FM_CAPWAP_SUPPORT
struct {
bool include; /**< If FALSE, remove until the specified header (not including the header);
If TRUE, remove also the specified header. */
t_FmManipHdrInfo hdrInfo;
} fromStartByHdr; /**< Relevant when type = e_FM_PCD_MANIP_RMV_BY_HDR_FROM_START */
#endif /* FM_CAPWAP_SUPPORT */
e_FmPcdManipHdrRmvSpecificL2 specificL2; /**< Relevant when type = e_FM_PCD_MANIP_BY_HDR_SPECIFIC_L2;
Defines which L2 headers to remove. */
} u;
} t_FmPcdManipHdrRmvByHdrParams;
/**************************************************************************//**
@Description Parameters for configuring IP fragmentation manipulation
Restrictions:
- IP Fragmentation output fragments must not be forwarded to application directly.
- Maximum number of fragments per frame is 16.
- Fragmentation of IP fragments is not supported.
- IPv4 packets containing header Option fields are fragmented by copying all option
fields to each fragment, regardless of the copy bit value.
- Transmit confirmation is not supported.
- Fragmentation after SEC can't handle S/G frames.
- Fragmentation nodes must be set as the last PCD action (i.e. the
corresponding CC node key must have next engine set to e_FM_PCD_DONE).
- Only BMan buffers shall be used for frames to be fragmented.
- IPF does not support VSP. Therefore, on the same port where we have IPF
we cannot support VSP.
- NOTE: The following comment is relevant only for FMAN v3 devices: IPF
does not support VSP. Therefore, on the same port where we have IPF we
cannot support VSP.
*//***************************************************************************/
typedef struct t_FmPcdManipFragIpParams {
uint16_t sizeForFragmentation; /**< If length of the frame is greater than this value,
IP fragmentation will be executed.*/
#if (DPAA_VERSION == 10)
uint8_t scratchBpid; /**< Absolute buffer pool id according to BM configuration.*/
#endif /* (DPAA_VERSION == 10) */
bool sgBpidEn; /**< Enable a dedicated buffer pool id for the Scatter/Gather buffer allocation;
If disabled, the Scatter/Gather buffer will be allocated from the same pool as the
received frame's buffer. */
uint8_t sgBpid; /**< Scatter/Gather buffer pool id;
This parameters is relevant when 'sgBpidEn=TRUE';
Same LIODN number is used for these buffers as for the received frames buffers, so buffers
of this pool need to be allocated in the same memory area as the received buffers.
If the received buffers arrive from different sources, the Scatter/Gather BP id should be
mutual to all these sources. */
e_FmPcdManipDontFragAction dontFragAction; /**< Don't Fragment Action - If an IP packet is larger
than MTU and its DF bit is set, then this field will
determine the action to be taken.*/
} t_FmPcdManipFragIpParams;
/**************************************************************************//**
@Description Parameters for configuring IP reassembly manipulation.
This is a common structure for both IPv4 and IPv6 reassembly
manipulation. For reassembly of both IPv4 and IPv6, make sure to
set the 'hdr' field in t_FmPcdManipReassemParams to HEADER_TYPE_IPv6.
Restrictions:
- Application must define at least one scheme to catch the reassembled frames.
- Maximum number of fragments per frame is 16.
- Reassembly of IPv4 fragments containing Option fields is supported.
*//***************************************************************************/
typedef struct t_FmPcdManipReassemIpParams {
uint8_t relativeSchemeId[2]; /**< Partition relative scheme id:
relativeSchemeId[0] - Relative scheme ID for IPV4 Reassembly manipulation;
relativeSchemeId[1] - Relative scheme ID for IPV6 Reassembly manipulation;
NOTE: The following comment is relevant only for FMAN v2 devices:
Relative scheme ID for IPv4/IPv6 Reassembly manipulation must be smaller than
the user schemes id to ensure that the reassembly schemes will be first match;
Rest schemes, if defined, should have higher relative scheme ID. */
#if (DPAA_VERSION >= 11)
uint32_t nonConsistentSpFqid; /**< In case that other fragments of the frame corresponds to different storage
profile than the opening fragment (Non-Consistent-SP state)
then one of two possible scenarios occurs:
if 'nonConsistentSpFqid != 0', the reassembled frame will be enqueued to
this fqid, otherwise a 'Non Consistent SP' bit will be set in the FD[status].*/
#else
uint8_t sgBpid; /**< Buffer pool id for the S/G frame created by the reassembly process */
#endif /* (DPAA_VERSION >= 11) */
uint8_t dataMemId; /**< Memory partition ID for the IPR's external tables structure */
uint16_t dataLiodnOffset; /**< LIODN offset for access the IPR's external tables structure. */
uint16_t minFragSize[2]; /**< Minimum fragment size:
minFragSize[0] - for ipv4, minFragSize[1] - for ipv6 */
e_FmPcdManipReassemWaysNumber numOfFramesPerHashEntry[2];
/**< Number of frames per hash entry needed for reassembly process:
numOfFramesPerHashEntry[0] - for ipv4 (max value is e_FM_PCD_MANIP_EIGHT_WAYS_HASH);
numOfFramesPerHashEntry[1] - for ipv6 (max value is e_FM_PCD_MANIP_SIX_WAYS_HASH). */
uint16_t maxNumFramesInProcess; /**< Number of frames which can be processed by Reassembly in the same time;
Must be power of 2;
In the case numOfFramesPerHashEntry == e_FM_PCD_MANIP_FOUR_WAYS_HASH,
maxNumFramesInProcess has to be in the range of 4 - 512;
In the case numOfFramesPerHashEntry == e_FM_PCD_MANIP_EIGHT_WAYS_HASH,
maxNumFramesInProcess has to be in the range of 8 - 2048. */
e_FmPcdManipReassemTimeOutMode timeOutMode; /**< Expiration delay initialized by Reassembly process */
uint32_t fqidForTimeOutFrames; /**< FQID in which time out frames will enqueue during Time Out Process;
Recommended value for this field is 0; in this way timed-out frames will be discarded */
uint32_t timeoutThresholdForReassmProcess;
/**< Represents the time interval in microseconds which defines
if opened frame (at least one fragment was processed but not all the fragments)is found as too old*/
} t_FmPcdManipReassemIpParams;
/**************************************************************************//**
@Description structure for defining IPSEC manipulation
*//***************************************************************************/
typedef struct t_FmPcdManipSpecialOffloadIPSecParams {
bool decryption; /**< TRUE if being used in decryption direction;
FALSE if being used in encryption direction. */
bool ecnCopy; /**< TRUE to copy the ECN bits from inner/outer to outer/inner
(direction depends on the 'decryption' field). */
bool dscpCopy; /**< TRUE to copy the DSCP bits from inner/outer to outer/inner
(direction depends on the 'decryption' field). */
bool variableIpHdrLen; /**< TRUE for supporting variable IP header length in decryption. */
bool variableIpVersion; /**< TRUE for supporting both IP version on the same SA in encryption */
uint8_t outerIPHdrLen; /**< if 'variableIpVersion == TRUE' than this field must be set to non-zero value;
It is specifies the length of the outer IP header that was configured in the
corresponding SA. */
} t_FmPcdManipSpecialOffloadIPSecParams;
/**************************************************************************//**
@Description Parameters for defining special offload manipulation
*//***************************************************************************/
typedef struct t_FmPcdManipSpecialOffloadParams {
e_FmPcdManipSpecialOffloadType type; /**< Type of special offload manipulation */
union
{
t_FmPcdManipSpecialOffloadIPSecParams ipsec; /**< Parameters for IPSec; Relevant when
type = e_FM_PCD_MANIP_SPECIAL_OFFLOAD_IPSEC */
} u;
} t_FmPcdManipSpecialOffloadParams;
/**************************************************************************//**
@Description Parameters for defining generic removal manipulation
*//***************************************************************************/
typedef struct t_FmPcdManipHdrRmvGenericParams {
uint8_t offset; /**< Offset from beginning of header to the start
location of the removal */
uint8_t size; /**< Size of removed section */
} t_FmPcdManipHdrRmvGenericParams;
/**************************************************************************//**
@Description Parameters for defining generic insertion manipulation
*//***************************************************************************/
typedef struct t_FmPcdManipHdrInsrtGenericParams {
uint8_t offset; /**< Offset from beginning of header to the start
location of the insertion */
uint8_t size; /**< Size of inserted section */
bool replace; /**< TRUE to override (replace) existing data at
'offset', FALSE to insert */
uint8_t *p_Data; /**< Pointer to data to be inserted */
} t_FmPcdManipHdrInsrtGenericParams;
/**************************************************************************//**
@Description Parameters for defining header manipulation VLAN DSCP To Vpri translation
*//***************************************************************************/
typedef struct t_FmPcdManipHdrFieldUpdateVlanDscpToVpri {
uint8_t dscpToVpriTable[FM_PCD_MANIP_DSCP_TO_VLAN_TRANS];
/**< A table of VPri values for each DSCP value;
The index is the DSCP value (0-0x3F) and the
value is the corresponding VPRI (0-15). */
uint8_t vpriDefVal; /**< 0-7, Relevant only if if updateType =
e_FM_PCD_MANIP_HDR_FIELD_UPDATE_DSCP_TO_VLAN,
this field is the Q Tag default value if the
IP header is not found. */
} t_FmPcdManipHdrFieldUpdateVlanDscpToVpri;
/**************************************************************************//**
@Description Parameters for defining header manipulation VLAN fields updates
*//***************************************************************************/
typedef struct t_FmPcdManipHdrFieldUpdateVlan {
e_FmPcdManipHdrFieldUpdateVlan updateType; /**< Selects VLAN update type */
union {
uint8_t vpri; /**< 0-7, Relevant only if If updateType =
e_FM_PCD_MANIP_HDR_FIELD_UPDATE_VLAN_PRI, this
is the new VLAN pri. */
t_FmPcdManipHdrFieldUpdateVlanDscpToVpri dscpToVpri; /**< Parameters structure, Relevant only if updateType
= e_FM_PCD_MANIP_HDR_FIELD_UPDATE_DSCP_TO_VLAN. */
} u;
} t_FmPcdManipHdrFieldUpdateVlan;
/**************************************************************************//**
@Description Parameters for defining header manipulation IPV4 fields updates
*//***************************************************************************/
typedef struct t_FmPcdManipHdrFieldUpdateIpv4 {
ipv4HdrManipUpdateFlags_t validUpdates; /**< ORed flag, selecting the required updates */
uint8_t tos; /**< 8 bit New TOS; Relevant if validUpdates contains
HDR_MANIP_IPV4_TOS */
uint16_t id; /**< 16 bit New IP ID; Relevant only if validUpdates
contains HDR_MANIP_IPV4_ID */
uint32_t src; /**< 32 bit New IP SRC; Relevant only if validUpdates
contains HDR_MANIP_IPV4_SRC */
uint32_t dst; /**< 32 bit New IP DST; Relevant only if validUpdates
contains HDR_MANIP_IPV4_DST */
} t_FmPcdManipHdrFieldUpdateIpv4;
/**************************************************************************//**
@Description Parameters for defining header manipulation IPV6 fields updates
*//***************************************************************************/
typedef struct t_FmPcdManipHdrFieldUpdateIpv6 {
ipv6HdrManipUpdateFlags_t validUpdates; /**< ORed flag, selecting the required updates */
uint8_t trafficClass; /**< 8 bit New Traffic Class; Relevant if validUpdates contains
HDR_MANIP_IPV6_TC */
uint8_t src[NET_HEADER_FIELD_IPv6_ADDR_SIZE];
/**< 16 byte new IP SRC; Relevant only if validUpdates
contains HDR_MANIP_IPV6_SRC */
uint8_t dst[NET_HEADER_FIELD_IPv6_ADDR_SIZE];
/**< 16 byte new IP DST; Relevant only if validUpdates
contains HDR_MANIP_IPV6_DST */
} t_FmPcdManipHdrFieldUpdateIpv6;
/**************************************************************************//**
@Description Parameters for defining header manipulation TCP/UDP fields updates
*//***************************************************************************/
typedef struct t_FmPcdManipHdrFieldUpdateTcpUdp {
tcpUdpHdrManipUpdateFlags_t validUpdates; /**< ORed flag, selecting the required updates */
uint16_t src; /**< 16 bit New TCP/UDP SRC; Relevant only if validUpdates
contains HDR_MANIP_TCP_UDP_SRC */
uint16_t dst; /**< 16 bit New TCP/UDP DST; Relevant only if validUpdates
contains HDR_MANIP_TCP_UDP_DST */
} t_FmPcdManipHdrFieldUpdateTcpUdp;
/**************************************************************************//**
@Description Parameters for defining header manipulation fields updates
*//***************************************************************************/
typedef struct t_FmPcdManipHdrFieldUpdateParams {
e_FmPcdManipHdrFieldUpdateType type; /**< Type of header field update manipulation */
union {
t_FmPcdManipHdrFieldUpdateVlan vlan; /**< Parameters for VLAN update. Relevant when
type = e_FM_PCD_MANIP_HDR_FIELD_UPDATE_VLAN */
t_FmPcdManipHdrFieldUpdateIpv4 ipv4; /**< Parameters for IPv4 update. Relevant when
type = e_FM_PCD_MANIP_HDR_FIELD_UPDATE_IPV4 */
t_FmPcdManipHdrFieldUpdateIpv6 ipv6; /**< Parameters for IPv6 update. Relevant when
type = e_FM_PCD_MANIP_HDR_FIELD_UPDATE_IPV6 */
t_FmPcdManipHdrFieldUpdateTcpUdp tcpUdp; /**< Parameters for TCP/UDP update. Relevant when
type = e_FM_PCD_MANIP_HDR_FIELD_UPDATE_TCP_UDP */
} u;
} t_FmPcdManipHdrFieldUpdateParams;
/**************************************************************************//**
@Description Parameters for defining custom header manipulation for IP replacement
*//***************************************************************************/
typedef struct t_FmPcdManipHdrCustomIpHdrReplace {
e_FmPcdManipHdrCustomIpReplace replaceType; /**< Selects replace update type */
bool decTtlHl; /**< Decrement TTL (IPV4) or Hop limit (IPV6) by 1 */
bool updateIpv4Id; /**< Relevant when replaceType =
e_FM_PCD_MANIP_HDR_CUSTOM_REPLACE_IPV6_BY_IPV4 */
uint16_t id; /**< 16 bit New IP ID; Relevant only if
updateIpv4Id = TRUE */
uint8_t hdrSize; /**< The size of the new IP header */
uint8_t hdr[FM_PCD_MANIP_MAX_HDR_SIZE];
/**< The new IP header */
} t_FmPcdManipHdrCustomIpHdrReplace;
/**************************************************************************//**
@Description Parameters for defining custom header manipulation
*//***************************************************************************/
typedef struct t_FmPcdManipHdrCustomParams {
e_FmPcdManipHdrCustomType type; /**< Type of header field update manipulation */
union {
t_FmPcdManipHdrCustomIpHdrReplace ipHdrReplace; /**< Parameters IP header replacement */
} u;
} t_FmPcdManipHdrCustomParams;
/**************************************************************************//**
@Description Parameters for defining specific L2 insertion manipulation
*//***************************************************************************/
typedef struct t_FmPcdManipHdrInsrtSpecificL2Params {
e_FmPcdManipHdrInsrtSpecificL2 specificL2; /**< Selects which L2 headers to insert */
bool update; /**< TRUE to update MPLS header */
uint8_t size; /**< size of inserted section */
uint8_t *p_Data; /**< data to be inserted */
} t_FmPcdManipHdrInsrtSpecificL2Params;
/**************************************************************************//**
@Description Parameters for defining header insertion manipulation by header type
*//***************************************************************************/
typedef struct t_FmPcdManipHdrInsrtByHdrParams {
e_FmPcdManipHdrInsrtByHdrType type; /**< Selects manipulation type */
union {
t_FmPcdManipHdrInsrtSpecificL2Params specificL2Params;
/**< Used when type = e_FM_PCD_MANIP_INSRT_BY_HDR_SPECIFIC_L2:
Selects which L2 headers to remove */
} u;
} t_FmPcdManipHdrInsrtByHdrParams;
/**************************************************************************//**
@Description Parameters for defining header insertion manipulation
*//***************************************************************************/
typedef struct t_FmPcdManipHdrInsrtParams {
e_FmPcdManipHdrInsrtType type; /**< Type of insertion manipulation */
union {
t_FmPcdManipHdrInsrtByHdrParams byHdr; /**< Parameters for defining header insertion manipulation by header type,
relevant if 'type' = e_FM_PCD_MANIP_INSRT_BY_HDR */
t_FmPcdManipHdrInsrtGenericParams generic; /**< Parameters for defining generic header insertion manipulation,
relevant if 'type' = e_FM_PCD_MANIP_INSRT_GENERIC */
#ifdef FM_CAPWAP_SUPPORT
t_FmPcdManipHdrInsrtByTemplateParams byTemplate; /**< Parameters for defining header insertion manipulation by template,
relevant if 'type' = e_FM_PCD_MANIP_INSRT_BY_TEMPLATE */
#endif /* FM_CAPWAP_SUPPORT */
} u;
} t_FmPcdManipHdrInsrtParams;
/**************************************************************************//**
@Description Parameters for defining header removal manipulation
*//***************************************************************************/
typedef struct t_FmPcdManipHdrRmvParams {
e_FmPcdManipHdrRmvType type; /**< Type of header removal manipulation */
union {
t_FmPcdManipHdrRmvByHdrParams byHdr; /**< Parameters for defining header removal manipulation by header type,
relevant if type = e_FM_PCD_MANIP_RMV_BY_HDR */
t_FmPcdManipHdrRmvGenericParams generic; /**< Parameters for defining generic header removal manipulation,
relevant if type = e_FM_PCD_MANIP_RMV_GENERIC */
} u;
} t_FmPcdManipHdrRmvParams;
/**************************************************************************//**
@Description Parameters for defining header manipulation node
*//***************************************************************************/
typedef struct t_FmPcdManipHdrParams {
bool rmv; /**< TRUE, to define removal manipulation */
t_FmPcdManipHdrRmvParams rmvParams; /**< Parameters for removal manipulation, relevant if 'rmv' = TRUE */
bool insrt; /**< TRUE, to define insertion manipulation */
t_FmPcdManipHdrInsrtParams insrtParams; /**< Parameters for insertion manipulation, relevant if 'insrt' = TRUE */
bool fieldUpdate; /**< TRUE, to define field update manipulation */
t_FmPcdManipHdrFieldUpdateParams fieldUpdateParams; /**< Parameters for field update manipulation, relevant if 'fieldUpdate' = TRUE */
bool custom; /**< TRUE, to define custom manipulation */
t_FmPcdManipHdrCustomParams customParams; /**< Parameters for custom manipulation, relevant if 'custom' = TRUE */
bool dontParseAfterManip;/**< FALSE to activate the parser a second time after
completing the manipulation on the frame */
} t_FmPcdManipHdrParams;
/**************************************************************************//**
@Description Parameters for defining fragmentation manipulation
*//***************************************************************************/
typedef struct t_FmPcdManipFragParams {
e_NetHeaderType hdr; /**< Header selection */
union {
t_FmPcdManipFragIpParams ipFrag; /**< Parameters for defining IP fragmentation,
relevant if 'hdr' = HEADER_TYPE_Ipv4 or HEADER_TYPE_Ipv6 */
} u;
} t_FmPcdManipFragParams;
/**************************************************************************//**
@Description Parameters for defining reassembly manipulation
*//***************************************************************************/
typedef struct t_FmPcdManipReassemParams {
e_NetHeaderType hdr; /**< Header selection */
union {
t_FmPcdManipReassemIpParams ipReassem; /**< Parameters for defining IP reassembly,
relevant if 'hdr' = HEADER_TYPE_Ipv4 or HEADER_TYPE_Ipv6 */
} u;
} t_FmPcdManipReassemParams;
/**************************************************************************//**
@Description Parameters for defining a manipulation node
*//***************************************************************************/
typedef struct t_FmPcdManipParams {
e_FmPcdManipType type; /**< Selects type of manipulation node */
union{
t_FmPcdManipHdrParams hdr; /**< Parameters for defining header manipulation node */
t_FmPcdManipReassemParams reassem; /**< Parameters for defining reassembly manipulation node */
t_FmPcdManipFragParams frag; /**< Parameters for defining fragmentation manipulation node */
t_FmPcdManipSpecialOffloadParams specialOffload; /**< Parameters for defining special offload manipulation node */
} u;
t_Handle h_NextManip; /**< Supported for Header Manipulation only;
Handle to another (previously defined) manipulation node;
Allows concatenation of manipulation actions;
This parameter is optional and may be NULL. */
#ifdef FM_CAPWAP_SUPPORT
bool fragOrReasm; /**< TRUE, if defined fragmentation/reassembly manipulation */
t_FmPcdManipFragOrReasmParams fragOrReasmParams; /**< Parameters for fragmentation/reassembly manipulation,
relevant if fragOrReasm = TRUE */
#endif /* FM_CAPWAP_SUPPORT */
} t_FmPcdManipParams;
/**************************************************************************//**
@Description Structure for retrieving IP reassembly statistics
*//***************************************************************************/
typedef struct t_FmPcdManipReassemIpStats {
/* common counters for both IPv4 and IPv6 */
uint32_t timeout; /**< Counts the number of TimeOut occurrences */
uint32_t rfdPoolBusy; /**< Counts the number of failed attempts to allocate
a Reassembly Frame Descriptor */
uint32_t internalBufferBusy; /**< Counts the number of times an internal buffer busy occurred */
uint32_t externalBufferBusy; /**< Counts the number of times external buffer busy occurred */
uint32_t sgFragments; /**< Counts the number of Scatter/Gather fragments */
uint32_t dmaSemaphoreDepletion; /**< Counts the number of failed attempts to allocate a DMA semaphore */
#if (DPAA_VERSION >= 11)
uint32_t nonConsistentSp; /**< Counts the number of Non Consistent Storage Profile events for
successfully reassembled frames */
#endif /* (DPAA_VERSION >= 11) */
struct {
uint32_t successfullyReassembled; /**< Counts the number of successfully reassembled frames */
uint32_t validFragments; /**< Counts the total number of valid fragments that
have been processed for all frames */
uint32_t processedFragments; /**< Counts the number of processed fragments
(valid and error fragments) for all frames */
uint32_t malformedFragments; /**< Counts the number of malformed fragments processed for all frames */
uint32_t discardedFragments; /**< Counts the number of fragments discarded by the reassembly process */
uint32_t autoLearnBusy; /**< Counts the number of times a busy condition occurs when attempting
to access an IP-Reassembly Automatic Learning Hash set */
uint32_t moreThan16Fragments; /**< Counts the fragment occurrences in which the number of fragments-per-frame
exceeds 16 */
} specificHdrStatistics[2]; /**< slot '0' is for IPv4, slot '1' is for IPv6 */
} t_FmPcdManipReassemIpStats;
/**************************************************************************//**
@Description Structure for retrieving IP fragmentation statistics
*//***************************************************************************/
typedef struct t_FmPcdManipFragIpStats {
uint32_t totalFrames; /**< Number of frames that passed through the manipulation node */
uint32_t fragmentedFrames; /**< Number of frames that were fragmented */
uint32_t generatedFragments; /**< Number of fragments that were generated */
} t_FmPcdManipFragIpStats;
/**************************************************************************//**
@Description Structure for retrieving reassembly statistics
*//***************************************************************************/
typedef struct t_FmPcdManipReassemStats {
union {
t_FmPcdManipReassemIpStats ipReassem; /**< Structure for IP reassembly statistics */
} u;
} t_FmPcdManipReassemStats;
/**************************************************************************//**
@Description Structure for retrieving fragmentation statistics
*//***************************************************************************/
typedef struct t_FmPcdManipFragStats {
union {
t_FmPcdManipFragIpStats ipFrag; /**< Structure for IP fragmentation statistics */
} u;
} t_FmPcdManipFragStats;
/**************************************************************************//**
@Description Structure for selecting manipulation statistics
*//***************************************************************************/
typedef struct t_FmPcdManipStats {
union {
t_FmPcdManipReassemStats reassem; /**< Structure for reassembly statistics */
t_FmPcdManipFragStats frag; /**< Structure for fragmentation statistics */
} u;
} t_FmPcdManipStats;
#if (DPAA_VERSION >= 11)
/**************************************************************************//**
@Description Parameters for defining frame replicator group and its members
*//***************************************************************************/
typedef struct t_FmPcdFrmReplicGroupParams {
uint8_t maxNumOfEntries; /**< Maximal number of members in the group;
Must be at least 2. */
uint8_t numOfEntries; /**< Number of members in the group;
Must be at least 1. */
t_FmPcdCcNextEngineParams nextEngineParams[FM_PCD_FRM_REPLIC_MAX_NUM_OF_ENTRIES];
/**< Array of members' parameters */
} t_FmPcdFrmReplicGroupParams;
#endif /* (DPAA_VERSION >= 11) */
#ifdef FM_CAPWAP_SUPPORT
/**************************************************************************//**
@Description structure for defining statistics node
*//***************************************************************************/
typedef struct t_FmPcdStatsParams {
e_FmPcdStatsType type; /**< type of statistics node */
} t_FmPcdStatsParams;
#endif /* FM_CAPWAP_SUPPORT */
/**************************************************************************//**
@Function FM_PCD_NetEnvCharacteristicsSet
@Description Define a set of Network Environment Characteristics.
When setting an environment it is important to understand its
application. It is not meant to describe the flows that will run
on the ports using this environment, but what the user means TO DO
with the PCD mechanisms in order to parse-classify-distribute those
frames.
By specifying a distinction unit, the user means it would use that option
for distinction between frames at either a KeyGen scheme or a coarse
classification action descriptor. Using interchangeable headers to define a
unit means that the user is indifferent to which of the interchangeable
headers is present in the frame, and wants the distinction to be based
on the presence of either one of them.
Depending on context, there are limitations to the use of environments. A
port using the PCD functionality is bound to an environment. Some or even
all ports may share an environment but also an environment per port is
possible. When initializing a scheme, a classification plan group (see below),
or a coarse classification tree, one of the initialized environments must be
stated and related to. When a port is bound to a scheme, a classification
plan group, or a coarse classification tree, it MUST be bound to the same
environment.
The different PCD modules, may relate (for flows definition) ONLY on
distinction units as defined by their environment. When initializing a
scheme for example, it may not choose to select IPV4 as a match for
recognizing flows unless it was defined in the relating environment. In
fact, to guide the user through the configuration of the PCD, each module's
characterization in terms of flows is not done using protocol names, but using
environment indexes.
In terms of HW implementation, the list of distinction units sets the LCV vectors
and later used for match vector, classification plan vectors and coarse classification
indexing.
@Param[in] h_FmPcd FM PCD module descriptor.
@Param[in] p_NetEnvParams A structure of parameters for the initialization of
the network environment.
@Return A handle to the initialized object on success; NULL code otherwise.
@Cautions Allowed only following FM_PCD_Init().
*//***************************************************************************/
t_Handle FM_PCD_NetEnvCharacteristicsSet(t_Handle h_FmPcd, t_FmPcdNetEnvParams *p_NetEnvParams);
/**************************************************************************//**
@Function FM_PCD_NetEnvCharacteristicsDelete
@Description Deletes a set of Network Environment Characteristics.
@Param[in] h_NetEnv A handle to the Network environment.
@Return E_OK on success; Error code otherwise.
*//***************************************************************************/
t_Error FM_PCD_NetEnvCharacteristicsDelete(t_Handle h_NetEnv);
/**************************************************************************//**
@Function FM_PCD_KgSchemeSet
@Description Initializing or modifying and enabling a scheme for the KeyGen.
This routine should be called for adding or modifying a scheme.
When a scheme needs modifying, the API requires that it will be
rewritten. In such a case 'modify' should be TRUE. If the
routine is called for a valid scheme and 'modify' is FALSE,
it will return error.
@Param[in] h_FmPcd If this is a new scheme - A handle to an FM PCD Module.
Otherwise NULL (ignored by driver).
@Param[in,out] p_SchemeParams A structure of parameters for defining the scheme
@Return A handle to the initialized scheme on success; NULL code otherwise.
When used as "modify" (rather than for setting a new scheme),
p_SchemeParams->id.h_Scheme will return NULL if action fails due to scheme
BUSY state.
@Cautions Allowed only following FM_PCD_Init().
*//***************************************************************************/
t_Handle FM_PCD_KgSchemeSet(t_Handle h_FmPcd,
t_FmPcdKgSchemeParams *p_SchemeParams);
/**************************************************************************//**
@Function FM_PCD_KgSchemeDelete
@Description Deleting an initialized scheme.
@Param[in] h_Scheme scheme handle as returned by FM_PCD_KgSchemeSet()
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_Init() & FM_PCD_KgSchemeSet().
*//***************************************************************************/
t_Error FM_PCD_KgSchemeDelete(t_Handle h_Scheme);
/**************************************************************************//**
@Function FM_PCD_KgSchemeGetCounter
@Description Reads scheme packet counter.
@Param[in] h_Scheme scheme handle as returned by FM_PCD_KgSchemeSet().
@Return Counter's current value.
@Cautions Allowed only following FM_PCD_Init() & FM_PCD_KgSchemeSet().
*//***************************************************************************/
uint32_t FM_PCD_KgSchemeGetCounter(t_Handle h_Scheme);
/**************************************************************************//**
@Function FM_PCD_KgSchemeSetCounter
@Description Writes scheme packet counter.
@Param[in] h_Scheme scheme handle as returned by FM_PCD_KgSchemeSet().
@Param[in] value New scheme counter value - typically '0' for
resetting the counter.
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_Init() & FM_PCD_KgSchemeSet().
*//***************************************************************************/
t_Error FM_PCD_KgSchemeSetCounter(t_Handle h_Scheme, uint32_t value);
/**************************************************************************//**
@Function FM_PCD_PlcrProfileSet
@Description Sets a profile entry in the policer profile table.
The routine overrides any existing value.
@Param[in] h_FmPcd A handle to an FM PCD Module.
@Param[in] p_Profile A structure of parameters for defining a
policer profile entry.
@Return A handle to the initialized object on success; NULL code otherwise.
When used as "modify" (rather than for setting a new profile),
p_Profile->id.h_Profile will return NULL if action fails due to profile
BUSY state.
@Cautions Allowed only following FM_PCD_Init().
*//***************************************************************************/
t_Handle FM_PCD_PlcrProfileSet(t_Handle h_FmPcd,
t_FmPcdPlcrProfileParams *p_Profile);
/**************************************************************************//**
@Function FM_PCD_PlcrProfileDelete
@Description Delete a profile entry in the policer profile table.
The routine set entry to invalid.
@Param[in] h_Profile A handle to the profile.
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_Init().
*//***************************************************************************/
t_Error FM_PCD_PlcrProfileDelete(t_Handle h_Profile);
/**************************************************************************//**
@Function FM_PCD_PlcrProfileGetCounter
@Description Sets an entry in the classification plan.
The routine overrides any existing value.
@Param[in] h_Profile A handle to the profile.
@Param[in] counter Counter selector.
@Return specific counter value.
@Cautions Allowed only following FM_PCD_Init().
*//***************************************************************************/
uint32_t FM_PCD_PlcrProfileGetCounter(t_Handle h_Profile,
e_FmPcdPlcrProfileCounters counter);
/**************************************************************************//**
@Function FM_PCD_PlcrProfileSetCounter
@Description Sets an entry in the classification plan.
The routine overrides any existing value.
@Param[in] h_Profile A handle to the profile.
@Param[in] counter Counter selector.
@Param[in] value value to set counter with.
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_Init().
*//***************************************************************************/
t_Error FM_PCD_PlcrProfileSetCounter(t_Handle h_Profile,
e_FmPcdPlcrProfileCounters counter,
uint32_t value);
/**************************************************************************//**
@Function FM_PCD_CcRootBuild
@Description This routine must be called to define a complete coarse
classification tree. This is the way to define coarse
classification to a certain flow - the KeyGen schemes
may point only to trees defined in this way.
@Param[in] h_FmPcd FM PCD module descriptor.
@Param[in] p_Params A structure of parameters to define the tree.
@Return A handle to the initialized object on success; NULL code otherwise.
@Cautions Allowed only following FM_PCD_Init().
*//***************************************************************************/
t_Handle FM_PCD_CcRootBuild (t_Handle h_FmPcd,
t_FmPcdCcTreeParams *p_Params);
/**************************************************************************//**
@Function FM_PCD_CcRootDelete
@Description Deleting an built tree.
@Param[in] h_CcTree A handle to a CC tree.
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_Init().
*//***************************************************************************/
t_Error FM_PCD_CcRootDelete(t_Handle h_CcTree);
/**************************************************************************//**
@Function FM_PCD_CcRootModifyNextEngine
@Description Modify the Next Engine Parameters in the entry of the tree.
@Param[in] h_CcTree A handle to the tree
@Param[in] grpId A Group index in the tree
@Param[in] index Entry index in the group defined by grpId
@Param[in] p_FmPcdCcNextEngineParams Pointer to new next engine parameters
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_CcBuildTree().
*//***************************************************************************/
t_Error FM_PCD_CcRootModifyNextEngine(t_Handle h_CcTree,
uint8_t grpId,
uint8_t index,
t_FmPcdCcNextEngineParams *p_FmPcdCcNextEngineParams);
/**************************************************************************//**
@Function FM_PCD_MatchTableSet
@Description This routine should be called for each CC (coarse classification)
node. The whole CC tree should be built bottom up so that each
node points to already defined nodes.
@Param[in] h_FmPcd FM PCD module descriptor.
@Param[in] p_Param A structure of parameters defining the CC node
@Return A handle to the initialized object on success; NULL code otherwise.
@Cautions Allowed only following FM_PCD_Init().
*//***************************************************************************/
t_Handle FM_PCD_MatchTableSet(t_Handle h_FmPcd, t_FmPcdCcNodeParams *p_Param);
/**************************************************************************//**
@Function FM_PCD_MatchTableDelete
@Description Deleting an built node.
@Param[in] h_CcNode A handle to a CC node.
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_Init().
*//***************************************************************************/
t_Error FM_PCD_MatchTableDelete(t_Handle h_CcNode);
/**************************************************************************//**
@Function FM_PCD_MatchTableModifyMissNextEngine
@Description Modify the Next Engine Parameters of the Miss key case of the node.
@Param[in] h_CcNode A handle to the node
@Param[in] p_FmPcdCcNextEngineParams Parameters for defining next engine
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_MatchTableSet().
*//***************************************************************************/
t_Error FM_PCD_MatchTableModifyMissNextEngine(t_Handle h_CcNode,
t_FmPcdCcNextEngineParams *p_FmPcdCcNextEngineParams);
/**************************************************************************//**
@Function FM_PCD_MatchTableRemoveKey
@Description Remove the key (including next engine parameters of this key)
defined by the index of the relevant node.
@Param[in] h_CcNode A handle to the node
@Param[in] keyIndex Key index for removing
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_MatchTableSet() was called for this
node and the nodes that lead to it.
*//***************************************************************************/
t_Error FM_PCD_MatchTableRemoveKey(t_Handle h_CcNode, uint16_t keyIndex);
/**************************************************************************//**
@Function FM_PCD_MatchTableAddKey
@Description Add the key (including next engine parameters of this key in the
index defined by the keyIndex. Note that 'FM_PCD_LAST_KEY_INDEX'
may be used by user that don't care about the position of the
key in the table - in that case, the key will be automatically
added by the driver in the last available entry.
@Param[in] h_CcNode A handle to the node
@Param[in] keyIndex Key index for adding.
@Param[in] keySize Key size of added key
@Param[in] p_KeyParams A pointer to the parameters includes
new key with Next Engine Parameters
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_MatchTableSet() was called for this
node and the nodes that lead to it.
*//***************************************************************************/
t_Error FM_PCD_MatchTableAddKey(t_Handle h_CcNode,
uint16_t keyIndex,
uint8_t keySize,
t_FmPcdCcKeyParams *p_KeyParams);
/**************************************************************************//**
@Function FM_PCD_MatchTableModifyNextEngine
@Description Modify the Next Engine Parameters in the relevant key entry of the node.
@Param[in] h_CcNode A handle to the node
@Param[in] keyIndex Key index for Next Engine modifications
@Param[in] p_FmPcdCcNextEngineParams Parameters for defining next engine
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_MatchTableSet().
*//***************************************************************************/
t_Error FM_PCD_MatchTableModifyNextEngine(t_Handle h_CcNode,
uint16_t keyIndex,
t_FmPcdCcNextEngineParams *p_FmPcdCcNextEngineParams);
/**************************************************************************//**
@Function FM_PCD_MatchTableModifyKeyAndNextEngine
@Description Modify the key and Next Engine Parameters of this key in the
index defined by the keyIndex.
@Param[in] h_CcNode A handle to the node
@Param[in] keyIndex Key index for adding
@Param[in] keySize Key size of added key
@Param[in] p_KeyParams A pointer to the parameters includes
modified key and modified Next Engine Parameters
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_MatchTableSet() was called for this
node and the nodes that lead to it.
*//***************************************************************************/
t_Error FM_PCD_MatchTableModifyKeyAndNextEngine(t_Handle h_CcNode,
uint16_t keyIndex,
uint8_t keySize,
t_FmPcdCcKeyParams *p_KeyParams);
/**************************************************************************//**
@Function FM_PCD_MatchTableModifyKey
@Description Modify the key in the index defined by the keyIndex.
@Param[in] h_CcNode A handle to the node
@Param[in] keyIndex Key index for adding
@Param[in] keySize Key size of added key
@Param[in] p_Key A pointer to the new key
@Param[in] p_Mask A pointer to the new mask if relevant,
otherwise pointer to NULL
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_MatchTableSet() was called for this
node and the nodes that lead to it.
*//***************************************************************************/
t_Error FM_PCD_MatchTableModifyKey(t_Handle h_CcNode,
uint16_t keyIndex,
uint8_t keySize,
uint8_t *p_Key,
uint8_t *p_Mask);
/**************************************************************************//**
@Function FM_PCD_MatchTableFindNRemoveKey
@Description Remove the key (including next engine parameters of this key)
defined by the key and mask. Note that this routine will search
the node to locate the index of the required key (& mask) to remove.
@Param[in] h_CcNode A handle to the node
@Param[in] keySize Key size of the one to remove.
@Param[in] p_Key A pointer to the requested key to remove.
@Param[in] p_Mask A pointer to the mask if relevant,
otherwise pointer to NULL
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_MatchTableSet() was called for this
node and the nodes that lead to it.
*//***************************************************************************/
t_Error FM_PCD_MatchTableFindNRemoveKey(t_Handle h_CcNode,
uint8_t keySize,
uint8_t *p_Key,
uint8_t *p_Mask);
/**************************************************************************//**
@Function FM_PCD_MatchTableFindNModifyNextEngine
@Description Modify the Next Engine Parameters in the relevant key entry of
the node. Note that this routine will search the node to locate
the index of the required key (& mask) to modify.
@Param[in] h_CcNode A handle to the node
@Param[in] keySize Key size of the one to modify.
@Param[in] p_Key A pointer to the requested key to modify.
@Param[in] p_Mask A pointer to the mask if relevant,
otherwise pointer to NULL
@Param[in] p_FmPcdCcNextEngineParams Parameters for defining next engine
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_MatchTableSet().
*//***************************************************************************/
t_Error FM_PCD_MatchTableFindNModifyNextEngine(t_Handle h_CcNode,
uint8_t keySize,
uint8_t *p_Key,
uint8_t *p_Mask,
t_FmPcdCcNextEngineParams *p_FmPcdCcNextEngineParams);
/**************************************************************************//**
@Function FM_PCD_MatchTableFindNModifyKeyAndNextEngine
@Description Modify the key and Next Engine Parameters of this key in the
index defined by the keyIndex. Note that this routine will search
the node to locate the index of the required key (& mask) to modify.
@Param[in] h_CcNode A handle to the node
@Param[in] keySize Key size of the one to modify.
@Param[in] p_Key A pointer to the requested key to modify.
@Param[in] p_Mask A pointer to the mask if relevant,
otherwise pointer to NULL
@Param[in] p_KeyParams A pointer to the parameters includes
modified key and modified Next Engine Parameters
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_MatchTableSet() was called for this
node and the nodes that lead to it.
*//***************************************************************************/
t_Error FM_PCD_MatchTableFindNModifyKeyAndNextEngine(t_Handle h_CcNode,
uint8_t keySize,
uint8_t *p_Key,
uint8_t *p_Mask,
t_FmPcdCcKeyParams *p_KeyParams);
/**************************************************************************//**
@Function FM_PCD_MatchTableFindNModifyKey
@Description Modify the key in the index defined by the keyIndex. Note that
this routine will search the node to locate the index of the
required key (& mask) to modify.
@Param[in] h_CcNode A handle to the node
@Param[in] keySize Key size of the one to modify.
@Param[in] p_Key A pointer to the requested key to modify.
@Param[in] p_Mask A pointer to the mask if relevant,
otherwise pointer to NULL
@Param[in] p_NewKey A pointer to the new key
@Param[in] p_NewMask A pointer to the new mask if relevant,
otherwise pointer to NULL
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_MatchTableSet() was called for this
node and the nodes that lead to it.
*//***************************************************************************/
t_Error FM_PCD_MatchTableFindNModifyKey(t_Handle h_CcNode,
uint8_t keySize,
uint8_t *p_Key,
uint8_t *p_Mask,
uint8_t *p_NewKey,
uint8_t *p_NewMask);
/**************************************************************************//**
@Function FM_PCD_MatchTableGetKeyCounter
@Description This routine may be used to get a counter of specific key in a CC
Node; This counter reflects how many frames passed that were matched
this key.
@Param[in] h_CcNode A handle to the node
@Param[in] keyIndex Key index for adding
@Return The specific key counter.
@Cautions Allowed only following FM_PCD_MatchTableSet().
*//***************************************************************************/
uint32_t FM_PCD_MatchTableGetKeyCounter(t_Handle h_CcNode, uint16_t keyIndex);
/**************************************************************************//**
@Function FM_PCD_MatchTableGetKeyStatistics
@Description This routine may be used to get statistics counters of specific key
in a CC Node.
If 'e_FM_PCD_CC_STATS_MODE_FRAME' and
'e_FM_PCD_CC_STATS_MODE_BYTE_AND_FRAME' were set for this node,
these counters reflect how many frames passed that were matched
this key; The total frames count will be returned in the counter
of the first range (as only one frame length range was defined).
If 'e_FM_PCD_CC_STATS_MODE_RMON' was set for this node, the total
frame count will be separated to frame length counters, based on
provided frame length ranges.
@Param[in] h_CcNode A handle to the node
@Param[in] keyIndex Key index for adding
@Param[out] p_KeyStatistics Key statistics counters
@Return The specific key statistics.
@Cautions Allowed only following FM_PCD_MatchTableSet().
*//***************************************************************************/
t_Error FM_PCD_MatchTableGetKeyStatistics(t_Handle h_CcNode,
uint16_t keyIndex,
t_FmPcdCcKeyStatistics *p_KeyStatistics);
/**************************************************************************//**
@Function FM_PCD_MatchTableFindNGetKeyStatistics
@Description This routine may be used to get statistics counters of specific key
in a CC Node.
If 'e_FM_PCD_CC_STATS_MODE_FRAME' and
'e_FM_PCD_CC_STATS_MODE_BYTE_AND_FRAME' were set for this node,
these counters reflect how many frames passed that were matched
this key; The total frames count will be returned in the counter
of the first range (as only one frame length range was defined).
If 'e_FM_PCD_CC_STATS_MODE_RMON' was set for this node, the total
frame count will be separated to frame length counters, based on
provided frame length ranges.
Note that this routine will search the node to locate the index
of the required key based on received key parameters.
@Param[in] h_CcNode A handle to the node
@Param[in] keySize Size of the requested key
@Param[in] p_Key A pointer to the requested key
@Param[in] p_Mask A pointer to the mask if relevant,
otherwise pointer to NULL
@Param[out] p_KeyStatistics Key statistics counters
@Return The specific key statistics.
@Cautions Allowed only following FM_PCD_MatchTableSet().
*//***************************************************************************/
t_Error FM_PCD_MatchTableFindNGetKeyStatistics(t_Handle h_CcNode,
uint8_t keySize,
uint8_t *p_Key,
uint8_t *p_Mask,
t_FmPcdCcKeyStatistics *p_KeyStatistics);
/**************************************************************************//*
@Function FM_PCD_MatchTableGetNextEngine
@Description Gets NextEngine of the relevant keyIndex.
@Param[in] h_CcNode A handle to the node.
@Param[in] keyIndex keyIndex in the relevant node.
@Param[out] p_FmPcdCcNextEngineParams here updated nextEngine parameters for
the relevant keyIndex of the CC Node
received as parameter to this function
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_Init().
*//***************************************************************************/
t_Error FM_PCD_MatchTableGetNextEngine(t_Handle h_CcNode,
uint16_t keyIndex,
t_FmPcdCcNextEngineParams *p_FmPcdCcNextEngineParams);
/**************************************************************************//*
@Function FM_PCD_MatchTableGetIndexedHashBucket
@Description This routine simulates KeyGen operation on the provided key and
calculates to which hash bucket it will be mapped.
@Param[in] h_CcNode A handle to the node.
@Param[in] kgKeySize Key size as it was configured in the KG
scheme that leads to this hash.
@Param[in] p_KgKey Pointer to the key; must be like the key
that the KG is generated, i.e. the same
extraction and with mask if exist.
@Param[in] kgHashShift Hash-shift as it was configured in the KG
scheme that leads to this hash.
@Param[out] p_CcNodeBucketHandle Pointer to the bucket of the provided key.
@Param[out] p_BucketIndex Index to the bucket of the provided key
@Param[out] p_LastIndex Pointer to last index in the bucket of the
provided key.
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_HashTableSet()
*//***************************************************************************/
t_Error FM_PCD_MatchTableGetIndexedHashBucket(t_Handle h_CcNode,
uint8_t kgKeySize,
uint8_t *p_KgKey,
uint8_t kgHashShift,
t_Handle *p_CcNodeBucketHandle,
uint8_t *p_BucketIndex,
uint16_t *p_LastIndex);
/**************************************************************************//**
@Function FM_PCD_HashTableSet
@Description This routine initializes a hash table structure.
KeyGen hash result determines the hash bucket.
Next, KeyGen key is compared against all keys of this
bucket (exact match).
Number of sets (number of buckets) of the hash equals to the
number of 1-s in 'hashResMask' in the provided parameters.
Number of hash table ways is then calculated by dividing
'maxNumOfKeys' equally between the hash sets. This is the maximal
number of keys that a hash bucket may hold.
The hash table is initialized empty and keys may be
added to it following the initialization. Keys masks are not
supported in current hash table implementation.
The initialized hash table can be integrated as a node in a
CC tree.
@Param[in] h_FmPcd FM PCD module descriptor.
@Param[in] p_Param A structure of parameters defining the hash table
@Return A handle to the initialized object on success; NULL code otherwise.
@Cautions Allowed only following FM_PCD_Init().
*//***************************************************************************/
t_Handle FM_PCD_HashTableSet(t_Handle h_FmPcd, t_FmPcdHashTableParams *p_Param);
/**************************************************************************//**
@Function FM_PCD_HashTableDelete
@Description This routine deletes the provided hash table and released all
its allocated resources.
@Param[in] h_HashTbl A handle to a hash table
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_HashTableSet().
*//***************************************************************************/
t_Error FM_PCD_HashTableDelete(t_Handle h_HashTbl);
/**************************************************************************//**
@Function FM_PCD_HashTableAddKey
@Description This routine adds the provided key (including next engine
parameters of this key) to the hash table.
The key is added as the last key of the bucket that it is
mapped to.
@Param[in] h_HashTbl A handle to a hash table
@Param[in] keySize Key size of added key
@Param[in] p_KeyParams A pointer to the parameters includes
new key with next engine parameters; The pointer
to the key mask must be NULL, as masks are not
supported in hash table implementation.
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_HashTableSet().
*//***************************************************************************/
t_Error FM_PCD_HashTableAddKey(t_Handle h_HashTbl,
uint8_t keySize,
t_FmPcdCcKeyParams *p_KeyParams);
/**************************************************************************//**
@Function FM_PCD_HashTableRemoveKey
@Description This routine removes the requested key (including next engine
parameters of this key) from the hash table.
@Param[in] h_HashTbl A handle to a hash table
@Param[in] keySize Key size of the one to remove.
@Param[in] p_Key A pointer to the requested key to remove.
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_HashTableSet().
*//***************************************************************************/
t_Error FM_PCD_HashTableRemoveKey(t_Handle h_HashTbl,
uint8_t keySize,
uint8_t *p_Key);
/**************************************************************************//**
@Function FM_PCD_HashTableModifyNextEngine
@Description This routine modifies the next engine for the provided key. The
key should be previously added to the hash table.
@Param[in] h_HashTbl A handle to a hash table
@Param[in] keySize Key size of the key to modify.
@Param[in] p_Key A pointer to the requested key to modify.
@Param[in] p_FmPcdCcNextEngineParams A structure for defining new next engine
parameters.
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_HashTableSet().
*//***************************************************************************/
t_Error FM_PCD_HashTableModifyNextEngine(t_Handle h_HashTbl,
uint8_t keySize,
uint8_t *p_Key,
t_FmPcdCcNextEngineParams *p_FmPcdCcNextEngineParams);
/**************************************************************************//**
@Function FM_PCD_HashTableModifyMissNextEngine
@Description This routine modifies the next engine on key match miss.
@Param[in] h_HashTbl A handle to a hash table
@Param[in] p_FmPcdCcNextEngineParams A structure for defining new next engine
parameters.
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_HashTableSet().
*//***************************************************************************/
t_Error FM_PCD_HashTableModifyMissNextEngine(t_Handle h_HashTbl,
t_FmPcdCcNextEngineParams *p_FmPcdCcNextEngineParams);
/**************************************************************************//*
@Function FM_PCD_HashTableGetMissNextEngine
@Description Gets NextEngine in case of key match miss.
@Param[in] h_HashTbl A handle to a hash table
@Param[out] p_FmPcdCcNextEngineParams Next engine parameters for the specified
hash table.
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_HashTableSet().
*//***************************************************************************/
t_Error FM_PCD_HashTableGetMissNextEngine(t_Handle h_HashTbl,
t_FmPcdCcNextEngineParams *p_FmPcdCcNextEngineParams);
/**************************************************************************//**
@Function FM_PCD_HashTableFindNGetKeyStatistics
@Description This routine may be used to get statistics counters of specific key
in a hash table.
If 'e_FM_PCD_CC_STATS_MODE_FRAME' and
'e_FM_PCD_CC_STATS_MODE_BYTE_AND_FRAME' were set for this node,
these counters reflect how many frames passed that were matched
this key; The total frames count will be returned in the counter
of the first range (as only one frame length range was defined).
If 'e_FM_PCD_CC_STATS_MODE_RMON' was set for this node, the total
frame count will be separated to frame length counters, based on
provided frame length ranges.
Note that this routine will identify the bucket of this key in
the hash table and will search the bucket to locate the index
of the required key based on received key parameters.
@Param[in] h_HashTbl A handle to a hash table
@Param[in] keySize Size of the requested key
@Param[in] p_Key A pointer to the requested key
@Param[out] p_KeyStatistics Key statistics counters
@Return The specific key statistics.
@Cautions Allowed only following FM_PCD_HashTableSet().
*//***************************************************************************/
t_Error FM_PCD_HashTableFindNGetKeyStatistics(t_Handle h_HashTbl,
uint8_t keySize,
uint8_t *p_Key,
t_FmPcdCcKeyStatistics *p_KeyStatistics);
/**************************************************************************//**
@Function FM_PCD_ManipNodeSet
@Description This routine should be called for defining a manipulation
node. A manipulation node must be defined before the CC node
that precedes it.
@Param[in] h_FmPcd FM PCD module descriptor.
@Param[in] p_FmPcdManipParams A structure of parameters defining the manipulation
@Return A handle to the initialized object on success; NULL code otherwise.
@Cautions Allowed only following FM_PCD_Init().
*//***************************************************************************/
t_Handle FM_PCD_ManipNodeSet(t_Handle h_FmPcd, t_FmPcdManipParams *p_FmPcdManipParams);
/**************************************************************************//**
@Function FM_PCD_ManipNodeDelete
@Description Delete an existing manipulation node.
@Param[in] h_ManipNode A handle to a manipulation node.
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_ManipNodeSet().
*//***************************************************************************/
t_Error FM_PCD_ManipNodeDelete(t_Handle h_ManipNode);
/**************************************************************************//**
@Function FM_PCD_ManipGetStatistics
@Description Retrieve the manipulation statistics.
@Param[in] h_ManipNode A handle to a manipulation node.
@Param[out] p_FmPcdManipStats A structure for retrieving the manipulation statistics
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_ManipNodeSet().
*//***************************************************************************/
t_Error FM_PCD_ManipGetStatistics(t_Handle h_ManipNode, t_FmPcdManipStats *p_FmPcdManipStats);
/**************************************************************************//**
@Function FM_PCD_ManipNodeReplace
@Description Change existing manipulation node to be according to new requirement.
@Param[in] h_ManipNode A handle to a manipulation node.
@Param[out] p_ManipParams A structure of parameters defining the change requirement
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_ManipNodeSet().
*//***************************************************************************/
t_Error FM_PCD_ManipNodeReplace(t_Handle h_ManipNode, t_FmPcdManipParams *p_ManipParams);
#if (DPAA_VERSION >= 11)
/**************************************************************************//**
@Function FM_PCD_FrmReplicSetGroup
@Description Initialize a Frame Replicator group.
@Param[in] h_FmPcd FM PCD module descriptor.
@Param[in] p_FrmReplicGroupParam A structure of parameters for the initialization of
the frame replicator group.
@Return A handle to the initialized object on success; NULL code otherwise.
@Cautions Allowed only following FM_PCD_Init().
*//***************************************************************************/
t_Handle FM_PCD_FrmReplicSetGroup(t_Handle h_FmPcd, t_FmPcdFrmReplicGroupParams *p_FrmReplicGroupParam);
/**************************************************************************//**
@Function FM_PCD_FrmReplicDeleteGroup
@Description Delete a Frame Replicator group.
@Param[in] h_FrmReplicGroup A handle to the frame replicator group.
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_FrmReplicSetGroup().
*//***************************************************************************/
t_Error FM_PCD_FrmReplicDeleteGroup(t_Handle h_FrmReplicGroup);
/**************************************************************************//**
@Function FM_PCD_FrmReplicAddMember
@Description Add the member in the index defined by the memberIndex.
@Param[in] h_FrmReplicGroup A handle to the frame replicator group.
@Param[in] memberIndex member index for adding.
@Param[in] p_MemberParams A pointer to the new member parameters.
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_FrmReplicSetGroup() of this group.
*//***************************************************************************/
t_Error FM_PCD_FrmReplicAddMember(t_Handle h_FrmReplicGroup,
uint16_t memberIndex,
t_FmPcdCcNextEngineParams *p_MemberParams);
/**************************************************************************//**
@Function FM_PCD_FrmReplicRemoveMember
@Description Remove the member defined by the index from the relevant group.
@Param[in] h_FrmReplicGroup A handle to the frame replicator group.
@Param[in] memberIndex member index for removing.
@Return E_OK on success; Error code otherwise.
@Cautions Allowed only following FM_PCD_FrmReplicSetGroup() of this group.
*//***************************************************************************/
t_Error FM_PCD_FrmReplicRemoveMember(t_Handle h_FrmReplicGroup,
uint16_t memberIndex);
#endif /* (DPAA_VERSION >= 11) */
#ifdef FM_CAPWAP_SUPPORT
/**************************************************************************//**
@Function FM_PCD_StatisticsSetNode
@Description This routine should be called for defining a statistics node.
@Param[in] h_FmPcd FM PCD module descriptor.
@Param[in] p_FmPcdstatsParams A structure of parameters defining the statistics
@Return A handle to the initialized object on success; NULL code otherwise.
@Cautions Allowed only following FM_PCD_Init().
*//***************************************************************************/
t_Handle FM_PCD_StatisticsSetNode(t_Handle h_FmPcd, t_FmPcdStatsParams *p_FmPcdstatsParams);
#endif /* FM_CAPWAP_SUPPORT */
/** @} */ /* end of FM_PCD_Runtime_build_grp group */
/** @} */ /* end of FM_PCD_Runtime_grp group */
/** @} */ /* end of FM_PCD_grp group */
/** @} */ /* end of FM_grp group */
#ifdef NCSW_BACKWARD_COMPATIBLE_API
#define FM_PCD_MAX_NUM_OF_INTERCHANGABLE_HDRS FM_PCD_MAX_NUM_OF_INTERCHANGEABLE_HDRS
#define e_FM_PCD_MANIP_ONE_WAYS_HASH e_FM_PCD_MANIP_ONE_WAY_HASH
#define e_FM_PCD_MANIP_TOW_WAYS_HASH e_FM_PCD_MANIP_TWO_WAYS_HASH
#define e_FM_PCD_MANIP_FRAGMENT_PACKECT e_FM_PCD_MANIP_FRAGMENT_PACKET /* Feb13 */
#define FM_PCD_SetNetEnvCharacteristics(_pcd, _params) \
FM_PCD_NetEnvCharacteristicsSet(_pcd, _params)
#define FM_PCD_KgSetScheme(_pcd, _params) FM_PCD_KgSchemeSet(_pcd, _params)
#define FM_PCD_CcBuildTree(_pcd, _params) FM_PCD_CcRootBuild(_pcd, _params)
#define FM_PCD_CcSetNode(_pcd, _params) FM_PCD_MatchTableSet(_pcd, _params)
#define FM_PCD_PlcrSetProfile(_pcd, _params) FM_PCD_PlcrProfileSet(_pcd, _params)
#define FM_PCD_ManipSetNode(_pcd, _params) FM_PCD_ManipNodeSet(_pcd, _params)
#define FM_PCD_DeleteNetEnvCharacteristics(_pcd, ...) \
FM_PCD_NetEnvCharacteristicsDelete(__VA_ARGS__)
#define FM_PCD_KgDeleteScheme(_pcd, ...) \
FM_PCD_KgSchemeDelete(__VA_ARGS__)
#define FM_PCD_KgGetSchemeCounter(_pcd, ...) \
FM_PCD_KgSchemeGetCounter(__VA_ARGS__)
#define FM_PCD_KgSetSchemeCounter(_pcd, ...) \
FM_PCD_KgSchemeSetCounter(__VA_ARGS__)
#define FM_PCD_PlcrDeleteProfile(_pcd, ...) \
FM_PCD_PlcrProfileDelete(__VA_ARGS__)
#define FM_PCD_PlcrGetProfileCounter(_pcd, ...) \
FM_PCD_PlcrProfileGetCounter(__VA_ARGS__)
#define FM_PCD_PlcrSetProfileCounter(_pcd, ...) \
FM_PCD_PlcrProfileSetCounter(__VA_ARGS__)
#define FM_PCD_CcDeleteTree(_pcd, ...) \
FM_PCD_CcRootDelete(__VA_ARGS__)
#define FM_PCD_CcTreeModifyNextEngine(_pcd, ...) \
FM_PCD_CcRootModifyNextEngine(__VA_ARGS__)
#define FM_PCD_CcDeleteNode(_pcd, ...) \
FM_PCD_MatchTableDelete(__VA_ARGS__)
#define FM_PCD_CcNodeModifyMissNextEngine(_pcd, ...) \
FM_PCD_MatchTableModifyMissNextEngine(__VA_ARGS__)
#define FM_PCD_CcNodeRemoveKey(_pcd, ...) \
FM_PCD_MatchTableRemoveKey(__VA_ARGS__)
#define FM_PCD_CcNodeAddKey(_pcd, ...) \
FM_PCD_MatchTableAddKey(__VA_ARGS__)
#define FM_PCD_CcNodeModifyNextEngine(_pcd, ...) \
FM_PCD_MatchTableModifyNextEngine(__VA_ARGS__)
#define FM_PCD_CcNodeModifyKeyAndNextEngine(_pcd, ...) \
FM_PCD_MatchTableModifyKeyAndNextEngine(__VA_ARGS__)
#define FM_PCD_CcNodeModifyKey(_pcd, ...) \
FM_PCD_MatchTableModifyKey(__VA_ARGS__)
#define FM_PCD_CcNodeFindNRemoveKey(_pcd, ...) \
FM_PCD_MatchTableFindNRemoveKey(__VA_ARGS__)
#define FM_PCD_CcNodeFindNModifyNextEngine(_pcd, ...) \
FM_PCD_MatchTableFindNModifyNextEngine(__VA_ARGS__)
#define FM_PCD_CcNodeFindNModifyKeyAndNextEngine(_pcd, ...) \
FM_PCD_MatchTableFindNModifyKeyAndNextEngine(__VA_ARGS__)
#define FM_PCD_CcNodeFindNModifyKey(_pcd, ...) \
FM_PCD_MatchTableFindNModifyKey(__VA_ARGS__)
#define FM_PCD_CcIndexedHashNodeGetBucket(_pcd, ...) \
FM_PCD_MatchTableGetIndexedHashBucket(__VA_ARGS__)
#define FM_PCD_CcNodeGetNextEngine(_pcd, ...) \
FM_PCD_MatchTableGetNextEngine(__VA_ARGS__)
#define FM_PCD_CcNodeGetKeyCounter(_pcd, ...) \
FM_PCD_MatchTableGetKeyCounter(__VA_ARGS__)
#define FM_PCD_ManipDeleteNode(_pcd, ...) \
FM_PCD_ManipNodeDelete(__VA_ARGS__)
#endif /* NCSW_BACKWARD_COMPATIBLE_API */
#endif /* __FM_PCD_EXT */
|