1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
|
/** @file
AML Code Generation.
Copyright (c) 2020 - 2022, Arm Limited. All rights reserved.<BR>
Copyright (C) 2023 - 2024, Advanced Micro Devices, Inc. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include <AmlNodeDefines.h>
#include <AcpiTableGenerator.h>
#include <AmlCoreInterface.h>
#include <AmlCpcInfo.h>
#include <AmlEncoding/Aml.h>
#include <Api/AmlApiHelper.h>
#include <CodeGen/AmlResourceDataCodeGen.h>
#include <Tree/AmlNode.h>
#include <Tree/AmlTree.h>
#include <String/AmlString.h>
#include <Utils/AmlUtility.h>
/** Utility function to link a node when returning from a CodeGen function.
@param [in] Node Newly created node.
@param [in] ParentNode If provided, set ParentNode as the parent
of the node created.
@param [out] NewObjectNode If not NULL:
- and Success, contains the created Node.
- and Error, reset to NULL.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
STATIC
EFI_STATUS
EFIAPI
LinkNode (
IN AML_OBJECT_NODE *Node,
IN AML_NODE_HEADER *ParentNode,
OUT AML_OBJECT_NODE **NewObjectNode
)
{
EFI_STATUS Status;
if (NewObjectNode != NULL) {
*NewObjectNode = NULL;
}
// Add RdNode as the last element.
if (ParentNode != NULL) {
Status = AmlVarListAddTail (ParentNode, (AML_NODE_HEADER *)Node);
if (EFI_ERROR (Status)) {
ASSERT (0);
return Status;
}
}
if (NewObjectNode != NULL) {
*NewObjectNode = Node;
}
return EFI_SUCCESS;
}
/** AML code generation for DefinitionBlock.
Create a Root Node handle.
It is the caller's responsibility to free the allocated memory
with the AmlDeleteTree function.
AmlCodeGenDefinitionBlock (TableSignature, OemID, TableID, OEMRevision) is
equivalent to the following ASL code:
DefinitionBlock (AMLFileName, TableSignature, ComplianceRevision,
OemID, TableID, OEMRevision) {}
with the ComplianceRevision set to 2 and the AMLFileName is ignored.
@param[in] TableSignature 4-character ACPI signature.
Must be 'DSDT' or 'SSDT'.
@param[in] OemId 6-character string OEM identifier.
@param[in] OemTableId 8-character string OEM table identifier.
@param[in] OemRevision OEM revision number.
@param[out] NewRootNode Pointer to the root node representing a
Definition Block.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
EFI_STATUS
EFIAPI
AmlCodeGenDefinitionBlock (
IN CONST CHAR8 *TableSignature,
IN CONST CHAR8 *OemId,
IN CONST CHAR8 *OemTableId,
IN UINT32 OemRevision,
OUT AML_ROOT_NODE **NewRootNode
)
{
EFI_STATUS Status;
EFI_ACPI_DESCRIPTION_HEADER AcpiHeader;
if ((TableSignature == NULL) ||
(OemId == NULL) ||
(OemTableId == NULL) ||
(NewRootNode == NULL))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
CopyMem (&AcpiHeader.Signature, TableSignature, 4);
AcpiHeader.Length = sizeof (EFI_ACPI_DESCRIPTION_HEADER);
AcpiHeader.Revision = 2;
CopyMem (&AcpiHeader.OemId, OemId, 6);
CopyMem (&AcpiHeader.OemTableId, OemTableId, 8);
AcpiHeader.OemRevision = OemRevision;
AcpiHeader.CreatorId = TABLE_GENERATOR_CREATOR_ID_ARM;
AcpiHeader.CreatorRevision = CREATE_REVISION (1, 0);
Status = AmlCreateRootNode (&AcpiHeader, NewRootNode);
ASSERT_EFI_ERROR (Status);
return Status;
}
/** AML code generation for a String object node.
@param [in] String Pointer to a NULL terminated string.
@param [out] NewObjectNode If success, contains the created
String object node.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
STATIC
EFI_STATUS
EFIAPI
AmlCodeGenString (
IN CHAR8 *String,
OUT AML_OBJECT_NODE **NewObjectNode
)
{
EFI_STATUS Status;
AML_OBJECT_NODE *ObjectNode;
AML_DATA_NODE *DataNode;
if ((String == NULL) ||
(NewObjectNode == NULL))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
DataNode = NULL;
Status = AmlCreateObjectNode (
AmlGetByteEncodingByOpCode (AML_STRING_PREFIX, 0),
0,
&ObjectNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
return Status;
}
Status = AmlCreateDataNode (
EAmlNodeDataTypeString,
(UINT8 *)String,
(UINT32)AsciiStrLen (String) + 1,
&DataNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
Status = AmlSetFixedArgument (
ObjectNode,
EAmlParseIndexTerm0,
(AML_NODE_HEADER *)DataNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
AmlDeleteTree ((AML_NODE_HEADER *)DataNode);
goto error_handler;
}
*NewObjectNode = ObjectNode;
return Status;
error_handler:
AmlDeleteTree ((AML_NODE_HEADER *)ObjectNode);
return Status;
}
/** AML code generation for an Integer object node.
@param [in] Integer Integer of the Integer object node.
@param [out] NewObjectNode If success, contains the created
Integer object node.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
STATIC
EFI_STATUS
EFIAPI
AmlCodeGenInteger (
IN UINT64 Integer,
OUT AML_OBJECT_NODE **NewObjectNode
)
{
EFI_STATUS Status;
INT8 ValueWidthDiff;
if (NewObjectNode == NULL) {
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
// Create an object node containing Zero.
Status = AmlCreateObjectNode (
AmlGetByteEncodingByOpCode (AML_ZERO_OP, 0),
0,
NewObjectNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
return Status;
}
// Update the object node with integer value.
Status = AmlNodeSetIntegerValue (*NewObjectNode, Integer, &ValueWidthDiff);
if (EFI_ERROR (Status)) {
ASSERT (0);
AmlDeleteTree ((AML_NODE_HEADER *)*NewObjectNode);
}
return Status;
}
/** AML code generation for a Package object node.
The package generated is empty. New elements can be added via its
list of variable arguments.
@param [out] NewObjectNode If success, contains the created
Package object node.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
STATIC
EFI_STATUS
EFIAPI
AmlCodeGenPackage (
OUT AML_OBJECT_NODE **NewObjectNode
)
{
EFI_STATUS Status;
AML_DATA_NODE *DataNode;
UINT8 NodeCount;
if (NewObjectNode == NULL) {
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
NodeCount = 0;
// Create an object node.
// PkgLen is 2:
// - one byte to store the PkgLength
// - one byte for the NumElements.
// Cf ACPI6.3, s20.2.5 "Term Objects Encoding"
// DefPackage := PackageOp PkgLength NumElements PackageElementList
// NumElements := ByteData
Status = AmlCreateObjectNode (
AmlGetByteEncodingByOpCode (AML_PACKAGE_OP, 0),
2,
NewObjectNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
return Status;
}
// NumElements is a ByteData.
Status = AmlCreateDataNode (
EAmlNodeDataTypeUInt,
&NodeCount,
sizeof (NodeCount),
&DataNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
Status = AmlSetFixedArgument (
*NewObjectNode,
EAmlParseIndexTerm0,
(AML_NODE_HEADER *)DataNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
return Status;
error_handler:
AmlDeleteTree ((AML_NODE_HEADER *)*NewObjectNode);
if (DataNode != NULL) {
AmlDeleteTree ((AML_NODE_HEADER *)DataNode);
}
return Status;
}
/** AML code generation for a Buffer object node.
To create a Buffer object node with an empty buffer,
call the function with (Buffer=NULL, BufferSize=0).
@param [in] Buffer Buffer to set for the created Buffer
object node. The Buffer's content is copied.
NULL if there is no buffer to set for
the Buffer node.
@param [in] BufferSize Size of the Buffer.
0 if there is no buffer to set for
the Buffer node.
@param [out] NewObjectNode If success, contains the created
Buffer object node.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
STATIC
EFI_STATUS
EFIAPI
AmlCodeGenBuffer (
IN CONST UINT8 *Buffer OPTIONAL,
IN UINT32 BufferSize OPTIONAL,
OUT AML_OBJECT_NODE **NewObjectNode
)
{
EFI_STATUS Status;
AML_OBJECT_NODE *BufferNode;
AML_OBJECT_NODE *BufferSizeNode;
UINT32 BufferSizeNodeSize;
AML_DATA_NODE *DataNode;
UINT32 PkgLen;
// Buffer and BufferSize must be either both set, or both clear.
if ((NewObjectNode == NULL) ||
((Buffer == NULL) != (BufferSize == 0)))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
BufferNode = NULL;
DataNode = NULL;
// Cf ACPI 6.3 specification, s20.2.5.4 "Type 2 Opcodes Encoding"
// DefBuffer := BufferOp PkgLength BufferSize ByteList
// BufferOp := 0x11
// BufferSize := TermArg => Integer
Status = AmlCodeGenInteger (BufferSize, &BufferSizeNode);
if (EFI_ERROR (Status)) {
ASSERT (0);
return Status;
}
// Get the number of bytes required to encode the BufferSizeNode.
Status = AmlComputeSize (
(AML_NODE_HEADER *)BufferSizeNode,
&BufferSizeNodeSize
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
// Compute the size to write in the PkgLen.
Status = AmlComputePkgLength (BufferSizeNodeSize + BufferSize, &PkgLen);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
// Create an object node for the buffer.
Status = AmlCreateObjectNode (
AmlGetByteEncodingByOpCode (AML_BUFFER_OP, 0),
PkgLen,
&BufferNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
// Set the BufferSizeNode as a fixed argument of the BufferNode.
Status = AmlSetFixedArgument (
BufferNode,
EAmlParseIndexTerm0,
(AML_NODE_HEADER *)BufferSizeNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
// BufferSizeNode is now attached.
BufferSizeNode = NULL;
// If there is a buffer, create a DataNode and attach it to the BufferNode.
if (Buffer != NULL) {
Status = AmlCreateDataNode (
EAmlNodeDataTypeRaw,
Buffer,
BufferSize,
&DataNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
Status = AmlVarListAddTail (
(AML_NODE_HEADER *)BufferNode,
(AML_NODE_HEADER *)DataNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
}
*NewObjectNode = BufferNode;
return Status;
error_handler:
if (BufferSizeNode != NULL) {
AmlDeleteTree ((AML_NODE_HEADER *)BufferSizeNode);
}
if (BufferNode != NULL) {
AmlDeleteTree ((AML_NODE_HEADER *)BufferNode);
}
if (DataNode != NULL) {
AmlDeleteTree ((AML_NODE_HEADER *)DataNode);
}
return Status;
}
/** AML code generation for a ResourceTemplate.
"ResourceTemplate" is a macro defined in ACPI 6.3, s19.3.3
"ASL Resource Templates". It allows to store resource data elements.
In AML, a ResourceTemplate is implemented as a Buffer storing resource
data elements. An EndTag resource data descriptor must be at the end
of the list of resource data elements.
This function generates a Buffer node with an EndTag resource data
descriptor. It can be seen as an empty list of resource data elements.
@param [out] NewObjectNode If success, contains the created
ResourceTemplate object node.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
STATIC
EFI_STATUS
EFIAPI
AmlCodeGenResourceTemplate (
OUT AML_OBJECT_NODE **NewObjectNode
)
{
EFI_STATUS Status;
AML_OBJECT_NODE *BufferNode;
if (NewObjectNode == NULL) {
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
// Create a BufferNode with an empty buffer.
Status = AmlCodeGenBuffer (NULL, 0, &BufferNode);
if (EFI_ERROR (Status)) {
ASSERT (0);
return Status;
}
// Create an EndTag resource data element and attach it to the Buffer.
Status = AmlCodeGenEndTag (0, BufferNode, NULL);
if (EFI_ERROR (Status)) {
ASSERT (0);
AmlDeleteTree ((AML_NODE_HEADER *)BufferNode);
return Status;
}
*NewObjectNode = BufferNode;
return Status;
}
/** AML code generation for a Name object node.
@param [in] NameString The new variable name.
Must be a NULL-terminated ASL NameString
e.g.: "DEV0", "DV15.DEV0", etc.
This input string is copied.
@param [in] Object Object associated to the NameString.
@param [in] ParentNode If provided, set ParentNode as the parent
of the node created.
@param [out] NewObjectNode If success, contains the created node.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
STATIC
EFI_STATUS
EFIAPI
AmlCodeGenName (
IN CONST CHAR8 *NameString,
IN AML_OBJECT_NODE *Object,
IN AML_NODE_HEADER *ParentNode OPTIONAL,
OUT AML_OBJECT_NODE **NewObjectNode OPTIONAL
)
{
EFI_STATUS Status;
AML_OBJECT_NODE *ObjectNode;
AML_DATA_NODE *DataNode;
CHAR8 *AmlNameString;
UINT32 AmlNameStringSize;
if ((NameString == NULL) ||
(Object == NULL) ||
((ParentNode == NULL) && (NewObjectNode == NULL)))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
ObjectNode = NULL;
DataNode = NULL;
AmlNameString = NULL;
Status = ConvertAslNameToAmlName (NameString, &AmlNameString);
if (EFI_ERROR (Status)) {
ASSERT (0);
return Status;
}
Status = AmlGetNameStringSize (AmlNameString, &AmlNameStringSize);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler1;
}
Status = AmlCreateObjectNode (
AmlGetByteEncodingByOpCode (AML_NAME_OP, 0),
0,
&ObjectNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler1;
}
Status = AmlCreateDataNode (
EAmlNodeDataTypeNameString,
(UINT8 *)AmlNameString,
AmlNameStringSize,
&DataNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler2;
}
Status = AmlSetFixedArgument (
ObjectNode,
EAmlParseIndexTerm0,
(AML_NODE_HEADER *)DataNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
AmlDeleteTree ((AML_NODE_HEADER *)DataNode);
goto error_handler2;
}
Status = AmlSetFixedArgument (
ObjectNode,
EAmlParseIndexTerm1,
(AML_NODE_HEADER *)Object
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler2;
}
Status = LinkNode (
ObjectNode,
ParentNode,
NewObjectNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler2;
}
// Free AmlNameString before returning as it is copied
// in the call to AmlCreateDataNode().
goto error_handler1;
error_handler2:
if (ObjectNode != NULL) {
AmlDeleteTree ((AML_NODE_HEADER *)ObjectNode);
}
error_handler1:
if (AmlNameString != NULL) {
FreePool (AmlNameString);
}
return Status;
}
/** AML code generation for a Name object node, containing a String.
AmlCodeGenNameString ("_HID", "HID0000", ParentNode, NewObjectNode) is
equivalent of the following ASL code:
Name(_HID, "HID0000")
@param [in] NameString The new variable name.
Must be a NULL-terminated ASL NameString
e.g.: "DEV0", "DV15.DEV0", etc.
The input string is copied.
@param [in] String NULL terminated String to associate to the
NameString.
@param [in] ParentNode If provided, set ParentNode as the parent
of the node created.
@param [out] NewObjectNode If success, contains the created node.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
EFI_STATUS
EFIAPI
AmlCodeGenNameString (
IN CONST CHAR8 *NameString,
IN CHAR8 *String,
IN AML_NODE_HEADER *ParentNode OPTIONAL,
OUT AML_OBJECT_NODE **NewObjectNode OPTIONAL
)
{
EFI_STATUS Status;
AML_OBJECT_NODE *ObjectNode;
if ((NameString == NULL) ||
(String == NULL) ||
((ParentNode == NULL) && (NewObjectNode == NULL)))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
Status = AmlCodeGenString (String, &ObjectNode);
if (EFI_ERROR (Status)) {
ASSERT (0);
return Status;
}
Status = AmlCodeGenName (
NameString,
ObjectNode,
ParentNode,
NewObjectNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
AmlDeleteTree ((AML_NODE_HEADER *)ObjectNode);
}
return Status;
}
/** AML code generation for a Name object node, containing an Integer.
AmlCodeGenNameInteger ("_UID", 1, ParentNode, NewObjectNode) is
equivalent of the following ASL code:
Name(_UID, One)
@param [in] NameString The new variable name.
Must be a NULL-terminated ASL NameString
e.g.: "DEV0", "DV15.DEV0", etc.
The input string is copied.
@param [in] Integer Integer to associate to the NameString.
@param [in] ParentNode If provided, set ParentNode as the parent
of the node created.
@param [out] NewObjectNode If success, contains the created node.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
EFI_STATUS
EFIAPI
AmlCodeGenNameInteger (
IN CONST CHAR8 *NameString,
IN UINT64 Integer,
IN AML_NODE_HEADER *ParentNode OPTIONAL,
OUT AML_OBJECT_NODE **NewObjectNode OPTIONAL
)
{
EFI_STATUS Status;
AML_OBJECT_NODE *ObjectNode;
if ((NameString == NULL) ||
((ParentNode == NULL) && (NewObjectNode == NULL)))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
Status = AmlCodeGenInteger (Integer, &ObjectNode);
if (EFI_ERROR (Status)) {
ASSERT (0);
return Status;
}
Status = AmlCodeGenName (
NameString,
ObjectNode,
ParentNode,
NewObjectNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
AmlDeleteTree ((AML_NODE_HEADER *)ObjectNode);
}
return Status;
}
/** AML code generation for a Name object node, containing a Package.
AmlCodeGenNamePackage ("PKG0", ParentNode, NewObjectNode) is
equivalent of the following ASL code:
Name(PKG0, Package () {})
@param [in] NameString The new variable name.
Must be a NULL-terminated ASL NameString
e.g.: "DEV0", "DV15.DEV0", etc.
The input string is copied.
@param [in] ParentNode If provided, set ParentNode as the parent
of the node created.
@param [out] NewObjectNode If success, contains the created node.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
EFI_STATUS
EFIAPI
AmlCodeGenNamePackage (
IN CONST CHAR8 *NameString,
IN AML_NODE_HEADER *ParentNode, OPTIONAL
OUT AML_OBJECT_NODE **NewObjectNode OPTIONAL
)
{
EFI_STATUS Status;
AML_OBJECT_NODE *PackageNode;
if ((NameString == NULL) ||
((ParentNode == NULL) && (NewObjectNode == NULL)))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
Status = AmlCodeGenPackage (&PackageNode);
if (EFI_ERROR (Status)) {
ASSERT (0);
return Status;
}
Status = AmlCodeGenName (
NameString,
PackageNode,
ParentNode,
NewObjectNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
AmlDeleteTree ((AML_NODE_HEADER *)PackageNode);
}
return Status;
}
/** AML code generation for a Name object node, containing a ResourceTemplate.
AmlCodeGenNameResourceTemplate ("PRS0", ParentNode, NewObjectNode) is
equivalent of the following ASL code:
Name(PRS0, ResourceTemplate () {})
@param [in] NameString The new variable name.
Must be a NULL-terminated ASL NameString
e.g.: "DEV0", "DV15.DEV0", etc.
The input string is copied.
@param [in] ParentNode If provided, set ParentNode as the parent
of the node created.
@param [out] NewObjectNode If success, contains the created node.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
EFI_STATUS
EFIAPI
AmlCodeGenNameResourceTemplate (
IN CONST CHAR8 *NameString,
IN AML_NODE_HEADER *ParentNode, OPTIONAL
OUT AML_OBJECT_NODE **NewObjectNode OPTIONAL
)
{
EFI_STATUS Status;
AML_OBJECT_NODE *ResourceTemplateNode;
if ((NameString == NULL) ||
((ParentNode == NULL) && (NewObjectNode == NULL)))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
Status = AmlCodeGenResourceTemplate (&ResourceTemplateNode);
if (EFI_ERROR (Status)) {
ASSERT (0);
return Status;
}
Status = AmlCodeGenName (
NameString,
ResourceTemplateNode,
ParentNode,
NewObjectNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
AmlDeleteTree ((AML_NODE_HEADER *)ResourceTemplateNode);
}
return Status;
}
/** AML code generation for a Name object node, containing a String.
AmlCodeGenNameUnicodeString ("_STR", L"String", ParentNode, NewObjectNode) is
equivalent of the following ASL code:
Name(_STR, Unicode ("String"))
@ingroup CodeGenApis
@param [in] NameString The new variable name.
Must be a NULL-terminated ASL NameString
e.g.: "DEV0", "DV15.DEV0", etc.
The input string is copied.
@param [in] String NULL terminated Unicode String to associate to the
NameString.
@param [in] ParentNode If provided, set ParentNode as the parent
of the node created.
@param [out] NewObjectNode If success, contains the created node.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
EFI_STATUS
EFIAPI
AmlCodeGenNameUnicodeString (
IN CONST CHAR8 *NameString,
IN CHAR16 *String,
IN AML_NODE_HANDLE ParentNode OPTIONAL,
OUT AML_OBJECT_NODE_HANDLE *NewObjectNode OPTIONAL
)
{
EFI_STATUS Status;
AML_OBJECT_NODE *ObjectNode;
AML_DATA_NODE *DataNode;
if ((NameString == NULL) ||
(String == NULL) ||
((ParentNode == NULL) && (NewObjectNode == NULL)))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
Status = AmlCodeGenBuffer (NULL, 0, &ObjectNode);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
return Status;
}
Status = AmlCreateDataNode (
EAmlNodeDataTypeRaw,
(CONST UINT8 *)String,
(UINT32)StrSize (String),
&DataNode
);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
AmlDeleteTree ((AML_NODE_HEADER *)ObjectNode);
return Status;
}
Status = AmlVarListAddTail (
(AML_NODE_HEADER *)ObjectNode,
(AML_NODE_HEADER *)DataNode
);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
AmlDeleteTree ((AML_NODE_HEADER *)ObjectNode);
AmlDeleteTree ((AML_NODE_HANDLE)DataNode);
return Status;
}
Status = AmlCodeGenName (
NameString,
ObjectNode,
ParentNode,
NewObjectNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
AmlDeleteTree ((AML_NODE_HEADER *)ObjectNode);
}
return Status;
}
/** Add a _PRT entry.
AmlCodeGenPrtEntry (0x0FFFF, 0, "LNKA", 0, PrtNameNode) is
equivalent of the following ASL code:
Package (4) {
0x0FFFF, // Address: Device address (([Device Id] << 16) | 0xFFFF).
0, // Pin: PCI pin number of the device (0-INTA, ...).
LNKA // Source: Name of the device that allocates the interrupt
// to which the above pin is connected.
0 // Source Index: Source is assumed to only describe one
// interrupt, so let it to index 0.
}
The 2 models described in ACPI 6.4, s6.2.13 "_PRT (PCI Routing Table)" can
be generated by this function. The example above matches the first model.
The package is added at the tail of the list of the input _PRT node
name:
Name (_PRT, Package () {
[Pre-existing _PRT entries],
[Newly created _PRT entry]
})
Cf. ACPI 6.4 specification:
- s6.2.13 "_PRT (PCI Routing Table)"
- s6.1.1 "_ADR (Address)"
@param [in] Address Address. Cf ACPI 6.4 specification, Table 6.2:
"ADR Object Address Encodings":
High word-Device #, Low word-Function #. (for
example, device 3, function 2 is 0x00030002).
To refer to all the functions on a device #,
use a function number of FFFF).
@param [in] Pin PCI pin number of the device (0-INTA ... 3-INTD).
Must be between 0-3.
@param [in] LinkName Link Name, i.e. device in the AML NameSpace
describing the interrupt used. The input string
is copied.
If NULL, generate 0 in the 'Source' field (cf.
second model, using GSIV).
@param [in] SourceIndex Source index or GSIV.
@param [in] PrtNameNode Prt Named node to add the object to ....
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
EFI_STATUS
EFIAPI
AmlAddPrtEntry (
IN UINT32 Address,
IN UINT8 Pin,
IN CONST CHAR8 *LinkName,
IN UINT32 SourceIndex,
IN AML_OBJECT_NODE_HANDLE PrtNameNode
)
{
EFI_STATUS Status;
AML_OBJECT_NODE *PrtEntryList;
AML_OBJECT_NODE *PackageNode;
AML_OBJECT_NODE *NewElementNode;
CHAR8 *AmlNameString;
UINT32 AmlNameStringSize;
AML_DATA_NODE *DataNode;
if ((Pin > 3) ||
(PrtNameNode == NULL) ||
(AmlGetNodeType ((AML_NODE_HANDLE)PrtNameNode) != EAmlNodeObject) ||
(!AmlNodeHasOpCode (PrtNameNode, AML_NAME_OP, 0)) ||
!AmlNameOpCompareName (PrtNameNode, "_PRT"))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
NewElementNode = NULL;
AmlNameString = NULL;
DataNode = NULL;
// Get the Package object node of the _PRT node,
// which is the 2nd fixed argument (i.e. index 1).
PrtEntryList = (AML_OBJECT_NODE_HANDLE)AmlGetFixedArgument (
PrtNameNode,
EAmlParseIndexTerm1
);
if ((PrtEntryList == NULL) ||
(AmlGetNodeType ((AML_NODE_HANDLE)PrtEntryList) != EAmlNodeObject) ||
(!AmlNodeHasOpCode (PrtEntryList, AML_PACKAGE_OP, 0)))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
// The new _PRT entry.
Status = AmlCodeGenPackage (&PackageNode);
if (EFI_ERROR (Status)) {
ASSERT (0);
return Status;
}
Status = AmlCodeGenInteger (Address, &NewElementNode);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
Status = AmlVarListAddTail (
(AML_NODE_HANDLE)PackageNode,
(AML_NODE_HANDLE)NewElementNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
NewElementNode = NULL;
Status = AmlCodeGenInteger (Pin, &NewElementNode);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
Status = AmlVarListAddTail (
(AML_NODE_HANDLE)PackageNode,
(AML_NODE_HANDLE)NewElementNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
NewElementNode = NULL;
if (LinkName != NULL) {
Status = ConvertAslNameToAmlName (LinkName, &AmlNameString);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
Status = AmlGetNameStringSize (AmlNameString, &AmlNameStringSize);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
Status = AmlCreateDataNode (
EAmlNodeDataTypeNameString,
(UINT8 *)AmlNameString,
AmlNameStringSize,
&DataNode
);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
// AmlNameString will be freed be fore returning.
Status = AmlVarListAddTail (
(AML_NODE_HANDLE)PackageNode,
(AML_NODE_HANDLE)DataNode
);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
DataNode = NULL;
} else {
Status = AmlCodeGenInteger (0, &NewElementNode);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
Status = AmlVarListAddTail (
(AML_NODE_HANDLE)PackageNode,
(AML_NODE_HANDLE)NewElementNode
);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
}
Status = AmlCodeGenInteger (SourceIndex, &NewElementNode);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
Status = AmlVarListAddTail (
(AML_NODE_HANDLE)PackageNode,
(AML_NODE_HANDLE)NewElementNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
// Append to the list of _PRT entries.
Status = AmlVarListAddTail (
(AML_NODE_HANDLE)PrtEntryList,
(AML_NODE_HANDLE)PackageNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
// Free AmlNameString before returning as it is copied
// in the call to AmlCreateDataNode().
goto exit_handler;
error_handler:
AmlDeleteTree ((AML_NODE_HANDLE)PackageNode);
if (NewElementNode != NULL) {
AmlDeleteTree ((AML_NODE_HANDLE)NewElementNode);
}
if (DataNode != NULL) {
AmlDeleteTree ((AML_NODE_HANDLE)DataNode);
}
exit_handler:
if (AmlNameString != NULL) {
FreePool (AmlNameString);
}
return Status;
}
/** AML code generation for a Device object node.
AmlCodeGenDevice ("COM0", ParentNode, NewObjectNode) is
equivalent of the following ASL code:
Device(COM0) {}
@param [in] NameString The new Device's name.
Must be a NULL-terminated ASL NameString
e.g.: "DEV0", "DV15.DEV0", etc.
The input string is copied.
@param [in] ParentNode If provided, set ParentNode as the parent
of the node created.
@param [out] NewObjectNode If success, contains the created node.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
EFI_STATUS
EFIAPI
AmlCodeGenDevice (
IN CONST CHAR8 *NameString,
IN AML_NODE_HEADER *ParentNode OPTIONAL,
OUT AML_OBJECT_NODE **NewObjectNode OPTIONAL
)
{
EFI_STATUS Status;
AML_OBJECT_NODE *ObjectNode;
AML_DATA_NODE *DataNode;
CHAR8 *AmlNameString;
UINT32 AmlNameStringSize;
if ((NameString == NULL) ||
((ParentNode == NULL) && (NewObjectNode == NULL)))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
ObjectNode = NULL;
DataNode = NULL;
AmlNameString = NULL;
Status = ConvertAslNameToAmlName (NameString, &AmlNameString);
if (EFI_ERROR (Status)) {
ASSERT (0);
return Status;
}
Status = AmlGetNameStringSize (AmlNameString, &AmlNameStringSize);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler1;
}
Status = AmlCreateObjectNode (
AmlGetByteEncodingByOpCode (AML_EXT_OP, AML_EXT_DEVICE_OP),
AmlNameStringSize + AmlComputePkgLengthWidth (AmlNameStringSize),
&ObjectNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler1;
}
Status = AmlCreateDataNode (
EAmlNodeDataTypeNameString,
(UINT8 *)AmlNameString,
AmlNameStringSize,
&DataNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler2;
}
Status = AmlSetFixedArgument (
ObjectNode,
EAmlParseIndexTerm0,
(AML_NODE_HEADER *)DataNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
AmlDeleteTree ((AML_NODE_HEADER *)DataNode);
goto error_handler2;
}
Status = LinkNode (
ObjectNode,
ParentNode,
NewObjectNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler2;
}
// Free AmlNameString before returning as it is copied
// in the call to AmlCreateDataNode().
goto error_handler1;
error_handler2:
if (ObjectNode != NULL) {
AmlDeleteTree ((AML_NODE_HEADER *)ObjectNode);
}
error_handler1:
if (AmlNameString != NULL) {
FreePool (AmlNameString);
}
return Status;
}
/** AML code generation for a ThermalZone object node.
AmlCodeGenThermalZone ("TZ00", ParentNode, NewObjectNode) is
equivalent of the following ASL code:
ThermalZone(TZ00) {}
@ingroup CodeGenApis
@param [in] NameString The new ThermalZone's name.
Must be a NULL-terminated ASL NameString
e.g.: "DEV0", "DV15.DEV0", etc.
The input string is copied.
@param [in] ParentNode If provided, set ParentNode as the parent
of the node created.
@param [out] NewObjectNode If success, contains the created node.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
EFI_STATUS
EFIAPI
AmlCodeGenThermalZone (
IN CONST CHAR8 *NameString,
IN AML_NODE_HANDLE ParentNode OPTIONAL,
OUT AML_OBJECT_NODE_HANDLE *NewObjectNode OPTIONAL
)
{
EFI_STATUS Status;
AML_OBJECT_NODE *ObjectNode;
AML_DATA_NODE *DataNode;
CHAR8 *AmlNameString;
UINT32 AmlNameStringSize;
if ((NameString == NULL) ||
((ParentNode == NULL) && (NewObjectNode == NULL)))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
ObjectNode = NULL;
DataNode = NULL;
AmlNameString = NULL;
Status = ConvertAslNameToAmlName (NameString, &AmlNameString);
if (EFI_ERROR (Status)) {
ASSERT (0);
return Status;
}
Status = AmlGetNameStringSize (AmlNameString, &AmlNameStringSize);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler1;
}
Status = AmlCreateObjectNode (
AmlGetByteEncodingByOpCode (AML_EXT_OP, AML_EXT_THERMAL_ZONE_OP),
AmlNameStringSize + AmlComputePkgLengthWidth (AmlNameStringSize),
&ObjectNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler1;
}
Status = AmlCreateDataNode (
EAmlNodeDataTypeNameString,
(UINT8 *)AmlNameString,
AmlNameStringSize,
&DataNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler2;
}
Status = AmlSetFixedArgument (
ObjectNode,
EAmlParseIndexTerm0,
(AML_NODE_HEADER *)DataNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
AmlDeleteTree ((AML_NODE_HEADER *)DataNode);
goto error_handler2;
}
Status = LinkNode (
ObjectNode,
ParentNode,
NewObjectNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler2;
}
// Free AmlNameString before returning as it is copied
// in the call to AmlCreateDataNode().
goto error_handler1;
error_handler2:
if (ObjectNode != NULL) {
AmlDeleteTree ((AML_NODE_HEADER *)ObjectNode);
}
error_handler1:
if (AmlNameString != NULL) {
FreePool (AmlNameString);
}
return Status;
}
/** AML code generation for a Scope object node.
AmlCodeGenScope ("_SB", ParentNode, NewObjectNode) is
equivalent of the following ASL code:
Scope(_SB) {}
@param [in] NameString The new Scope's name.
Must be a NULL-terminated ASL NameString
e.g.: "DEV0", "DV15.DEV0", etc.
The input string is copied.
@param [in] ParentNode If provided, set ParentNode as the parent
of the node created.
@param [out] NewObjectNode If success, contains the created node.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
EFI_STATUS
EFIAPI
AmlCodeGenScope (
IN CONST CHAR8 *NameString,
IN AML_NODE_HEADER *ParentNode OPTIONAL,
OUT AML_OBJECT_NODE **NewObjectNode OPTIONAL
)
{
EFI_STATUS Status;
AML_OBJECT_NODE *ObjectNode;
AML_DATA_NODE *DataNode;
CHAR8 *AmlNameString;
UINT32 AmlNameStringSize;
if ((NameString == NULL) ||
((ParentNode == NULL) && (NewObjectNode == NULL)))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
ObjectNode = NULL;
DataNode = NULL;
AmlNameString = NULL;
Status = ConvertAslNameToAmlName (NameString, &AmlNameString);
if (EFI_ERROR (Status)) {
ASSERT (0);
return Status;
}
Status = AmlGetNameStringSize (AmlNameString, &AmlNameStringSize);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler1;
}
Status = AmlCreateObjectNode (
AmlGetByteEncodingByOpCode (AML_SCOPE_OP, 0),
AmlNameStringSize + AmlComputePkgLengthWidth (AmlNameStringSize),
&ObjectNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler1;
}
Status = AmlCreateDataNode (
EAmlNodeDataTypeNameString,
(UINT8 *)AmlNameString,
AmlNameStringSize,
&DataNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler2;
}
Status = AmlSetFixedArgument (
ObjectNode,
EAmlParseIndexTerm0,
(AML_NODE_HEADER *)DataNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
AmlDeleteTree ((AML_NODE_HEADER *)DataNode);
goto error_handler2;
}
Status = LinkNode (
ObjectNode,
ParentNode,
NewObjectNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler2;
}
// Free AmlNameString before returning as it is copied
// in the call to AmlCreateDataNode().
goto error_handler1;
error_handler2:
if (ObjectNode != NULL) {
AmlDeleteTree ((AML_NODE_HEADER *)ObjectNode);
}
error_handler1:
if (AmlNameString != NULL) {
FreePool (AmlNameString);
}
return Status;
}
/** AML code generation for a Method object node.
AmlCodeGenMethod ("MET0", 1, TRUE, 3, ParentNode, NewObjectNode) is
equivalent of the following ASL code:
Method(MET0, 1, Serialized, 3) {}
ACPI 6.4, s20.2.5.2 "Named Objects Encoding":
DefMethod := MethodOp PkgLength NameString MethodFlags TermList
MethodOp := 0x14
The ASL parameters "ReturnType" and "ParameterTypes" are not asked
in this function. They are optional parameters in ASL.
@param [in] NameString The new Method's name.
Must be a NULL-terminated ASL NameString
e.g.: "MET0", "_SB.MET0", etc.
The input string is copied.
@param [in] NumArgs Number of arguments.
Must be 0 <= NumArgs <= 6.
@param [in] IsSerialized TRUE is equivalent to Serialized.
FALSE is equivalent to NotSerialized.
Default is NotSerialized in ASL spec.
@param [in] SyncLevel Synchronization level for the method.
Must be 0 <= SyncLevel <= 15.
Default is 0 in ASL.
@param [in] ParentNode If provided, set ParentNode as the parent
of the node created.
@param [out] NewObjectNode If success, contains the created node.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
STATIC
EFI_STATUS
EFIAPI
AmlCodeGenMethod (
IN CONST CHAR8 *NameString,
IN UINT8 NumArgs,
IN BOOLEAN IsSerialized,
IN UINT8 SyncLevel,
IN AML_NODE_HEADER *ParentNode OPTIONAL,
OUT AML_OBJECT_NODE **NewObjectNode OPTIONAL
)
{
EFI_STATUS Status;
UINT32 PkgLen;
UINT8 Flags;
AML_OBJECT_NODE *ObjectNode;
AML_DATA_NODE *DataNode;
CHAR8 *AmlNameString;
UINT32 AmlNameStringSize;
if ((NameString == NULL) ||
(NumArgs > 6) ||
(SyncLevel > 15) ||
((ParentNode == NULL) && (NewObjectNode == NULL)))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
ObjectNode = NULL;
DataNode = NULL;
// ACPI 6.4, s20.2.5.2 "Named Objects Encoding":
// DefMethod := MethodOp PkgLength NameString MethodFlags TermList
// MethodOp := 0x14
// So:
// 1- Create the NameString
// 2- Compute the size to write in the PkgLen
// 3- Create nodes for the NameString and Method object node
// 4- Set the NameString DataNode as a fixed argument
// 5- Create and link the MethodFlags node
// 1- Create the NameString
Status = ConvertAslNameToAmlName (NameString, &AmlNameString);
if (EFI_ERROR (Status)) {
ASSERT (0);
return Status;
}
Status = AmlGetNameStringSize (AmlNameString, &AmlNameStringSize);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler1;
}
// 2- Compute the size to write in the PkgLen
// Add 1 byte (ByteData) for MethodFlags.
Status = AmlComputePkgLength (AmlNameStringSize + 1, &PkgLen);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler1;
}
// 3- Create nodes for the NameString and Method object node
Status = AmlCreateObjectNode (
AmlGetByteEncodingByOpCode (AML_METHOD_OP, 0),
PkgLen,
&ObjectNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler1;
}
Status = AmlCreateDataNode (
EAmlNodeDataTypeNameString,
(UINT8 *)AmlNameString,
AmlNameStringSize,
&DataNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler2;
}
// 4- Set the NameString DataNode as a fixed argument
Status = AmlSetFixedArgument (
ObjectNode,
EAmlParseIndexTerm0,
(AML_NODE_HEADER *)DataNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler2;
}
DataNode = NULL;
// 5- Create and link the MethodFlags node
Flags = NumArgs |
(IsSerialized ? BIT3 : 0) |
(SyncLevel << 4);
Status = AmlCreateDataNode (EAmlNodeDataTypeUInt, &Flags, 1, &DataNode);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler2;
}
Status = AmlSetFixedArgument (
ObjectNode,
EAmlParseIndexTerm1,
(AML_NODE_HEADER *)DataNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler2;
}
// Data node is attached so set the pointer to
// NULL to ensure correct error handling.
DataNode = NULL;
Status = LinkNode (
ObjectNode,
ParentNode,
NewObjectNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler2;
}
// Free AmlNameString before returning as it is copied
// in the call to AmlCreateDataNode().
goto error_handler1;
error_handler2:
if (ObjectNode != NULL) {
AmlDeleteTree ((AML_NODE_HEADER *)ObjectNode);
}
if (DataNode != NULL) {
AmlDeleteTree ((AML_NODE_HEADER *)DataNode);
}
error_handler1:
if (AmlNameString != NULL) {
FreePool (AmlNameString);
}
return Status;
}
/** AML code generation for a Return object node.
AmlCodeGenReturn (ReturnNode, ParentNode, NewObjectNode) is
equivalent of the following ASL code:
Return([Content of the ReturnNode])
The ACPI 6.3 specification, s20.2.5.3 "Type 1 Opcodes Encoding" states:
DefReturn := ReturnOp ArgObject
ReturnOp := 0xA4
ArgObject := TermArg => DataRefObject
Thus, the ReturnNode must be evaluated as a DataRefObject. It can
be a NameString referencing an object. As this CodeGen Api doesn't
do semantic checking, it is strongly advised to check the AML bytecode
generated by this function against an ASL compiler.
The ReturnNode must be generated inside a Method body scope.
@param [in] ReturnNode The object returned by the Return ASL statement.
This node is deleted if an error occurs.
@param [in] ParentNode If provided, set ParentNode as the parent
of the node created.
Must be a MethodOp node.
@param [out] NewObjectNode If success, contains the created node.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
STATIC
EFI_STATUS
EFIAPI
AmlCodeGenReturn (
IN AML_NODE_HEADER *ReturnNode,
IN AML_NODE_HEADER *ParentNode OPTIONAL,
OUT AML_OBJECT_NODE **NewObjectNode OPTIONAL
)
{
EFI_STATUS Status;
AML_OBJECT_NODE *ObjectNode;
if ((ReturnNode == NULL) ||
((ParentNode == NULL) && (NewObjectNode == NULL)) ||
((ParentNode != NULL) &&
!AmlNodeCompareOpCode (
(AML_OBJECT_NODE *)ParentNode,
AML_METHOD_OP,
0
)))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
Status = AmlCreateObjectNode (
AmlGetByteEncodingByOpCode (AML_RETURN_OP, 0),
0,
&ObjectNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
Status = AmlSetFixedArgument (
ObjectNode,
EAmlParseIndexTerm0,
ReturnNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
ReturnNode = NULL;
Status = LinkNode (
ObjectNode,
ParentNode,
NewObjectNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
return Status;
error_handler:
if (ReturnNode != NULL) {
AmlDeleteTree (ReturnNode);
}
if (ObjectNode != NULL) {
AmlDeleteTree ((AML_NODE_HEADER *)ObjectNode);
}
return Status;
}
/** AML code generation for a Return object node,
returning the object as an input NameString.
AmlCodeGenReturn ("NAM1", ParentNode, NewObjectNode) is
equivalent of the following ASL code:
Return(NAM1)
The ACPI 6.3 specification, s20.2.5.3 "Type 1 Opcodes Encoding" states:
DefReturn := ReturnOp ArgObject
ReturnOp := 0xA4
ArgObject := TermArg => DataRefObject
Thus, the ReturnNode must be evaluated as a DataRefObject. It can
be a NameString referencing an object. As this CodeGen Api doesn't
do semantic checking, it is strongly advised to check the AML bytecode
generated by this function against an ASL compiler.
The ReturnNode must be generated inside a Method body scope.
@param [in] NameString The object referenced by this NameString
is returned by the Return ASL statement.
Must be a NULL-terminated ASL NameString
e.g.: "NAM1", "_SB.NAM1", etc.
The input string is copied.
@param [in] ParentNode If provided, set ParentNode as the parent
of the node created.
Must be a MethodOp node.
@param [out] NewObjectNode If success, contains the created node.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
STATIC
EFI_STATUS
EFIAPI
AmlCodeGenReturnNameString (
IN CONST CHAR8 *NameString,
IN AML_NODE_HEADER *ParentNode OPTIONAL,
OUT AML_OBJECT_NODE **NewObjectNode OPTIONAL
)
{
EFI_STATUS Status;
AML_DATA_NODE *DataNode;
CHAR8 *AmlNameString;
UINT32 AmlNameStringSize;
DataNode = NULL;
Status = ConvertAslNameToAmlName (NameString, &AmlNameString);
if (EFI_ERROR (Status)) {
ASSERT (0);
return Status;
}
Status = AmlGetNameStringSize (AmlNameString, &AmlNameStringSize);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto exit_handler;
}
Status = AmlCreateDataNode (
EAmlNodeDataTypeNameString,
(UINT8 *)AmlNameString,
AmlNameStringSize,
&DataNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto exit_handler;
}
// AmlCodeGenReturn() deletes DataNode if error.
Status = AmlCodeGenReturn (
(AML_NODE_HEADER *)DataNode,
ParentNode,
NewObjectNode
);
ASSERT_EFI_ERROR (Status);
exit_handler:
if (AmlNameString != NULL) {
FreePool (AmlNameString);
}
return Status;
}
/** AML code generation for a Return object node,
returning an Integer.
AmlCodeGenReturn (0), ParentNode, NewObjectNode) is
equivalent of the following ASL code:
Return (0)
The ACPI 6.3 specification, 20.2.8 "Statement Opcodes Encoding" states:
DefReturn := ReturnOp ArgObject
ReturnOp := 0xA4
ArgObject := TermArg => DataRefObject
Thus, the ReturnNode must be evaluated as a DataRefObject.
The ReturnNode must be generated inside a Method body scope.
@param [in] Integer The integer is returned by the Return
ASL statement.
@param [in] ParentNode If provided, set ParentNode as the parent
of the node created.
Must be a MethodOp node.
@param [out] NewObjectNode If success, contains the created node.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
STATIC
EFI_STATUS
EFIAPI
AmlCodeGenReturnInteger (
IN UINT64 Integer,
IN AML_NODE_HEADER *ParentNode OPTIONAL,
OUT AML_OBJECT_NODE **NewObjectNode OPTIONAL
)
{
EFI_STATUS Status;
AML_OBJECT_NODE *IntNode;
IntNode = NULL;
Status = AmlCodeGenInteger (Integer, &IntNode);
if (EFI_ERROR (Status)) {
ASSERT (0);
return Status;
}
// AmlCodeGenReturn() deletes DataNode if error.
Status = AmlCodeGenReturn (
(AML_NODE_HEADER *)IntNode,
ParentNode,
NewObjectNode
);
ASSERT_EFI_ERROR (Status);
return Status;
}
/** AML code generation for a Return object node,
returning the object as an input NameString with a integer argument.
AmlCodeGenReturn ("NAM1", 6, ParentNode, NewObjectNode) is
equivalent of the following ASL code:
Return(NAM1 (6))
The ACPI 6.3 specification, s20.2.5.3 "Type 1 Opcodes Encoding" states:
DefReturn := ReturnOp ArgObject
ReturnOp := 0xA4
ArgObject := TermArg => DataRefObject
Thus, the ReturnNode must be evaluated as a DataRefObject. It can
be a NameString referencing an object. As this CodeGen Api doesn't
do semantic checking, it is strongly advised to check the AML bytecode
generated by this function against an ASL compiler.
The ReturnNode must be generated inside a Method body scope.
@param [in] NameString The object referenced by this NameString
is returned by the Return ASL statement.
Must be a NULL-terminated ASL NameString
e.g.: "NAM1", "_SB.NAM1", etc.
The input string is copied.
@param [in] Integer Argument to pass to the NameString
@param [in] ParentNode If provided, set ParentNode as the parent
of the node created.
Must be a MethodOp node.
@param [out] NewObjectNode If success, contains the created node.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
STATIC
EFI_STATUS
EFIAPI
AmlCodeGenReturnNameStringIntegerArgument (
IN CONST CHAR8 *NameString,
IN UINT64 Integer,
IN AML_NODE_HEADER *ParentNode OPTIONAL,
OUT AML_OBJECT_NODE **NewObjectNode OPTIONAL
)
{
EFI_STATUS Status;
AML_DATA_NODE *DataNode;
AML_OBJECT_NODE *IntNode;
CHAR8 *AmlNameString;
UINT32 AmlNameStringSize;
AML_OBJECT_NODE *ObjectNode;
DataNode = NULL;
IntNode = NULL;
ObjectNode = NULL;
Status = ConvertAslNameToAmlName (NameString, &AmlNameString);
if (EFI_ERROR (Status)) {
ASSERT (0);
return Status;
}
Status = AmlGetNameStringSize (AmlNameString, &AmlNameStringSize);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto exit_handler;
}
Status = AmlCodeGenInteger (Integer, &IntNode);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto exit_handler;
}
Status = AmlCreateDataNode (
EAmlNodeDataTypeNameString,
(UINT8 *)AmlNameString,
AmlNameStringSize,
&DataNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto exit_handler1;
}
// AmlCodeGenReturn() deletes DataNode if error.
Status = AmlCodeGenReturn (
(AML_NODE_HEADER *)DataNode,
ParentNode,
&ObjectNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto exit_handler1;
}
Status = AmlVarListAddTail (
(AML_NODE_HANDLE)ObjectNode,
(AML_NODE_HANDLE)IntNode
);
if (EFI_ERROR (Status)) {
// ObjectNode is already attached to ParentNode in AmlCodeGenReturn(),
// so no need to free it here, it will be deleted when deleting the
// ParentNode tree
ASSERT (0);
goto exit_handler1;
}
if (NewObjectNode != 0) {
*NewObjectNode = ObjectNode;
}
goto exit_handler;
exit_handler1:
if (IntNode != NULL) {
AmlDeleteTree ((AML_NODE_HANDLE)IntNode);
}
exit_handler:
if (AmlNameString != NULL) {
FreePool (AmlNameString);
}
return Status;
}
/** AML code generation for a method returning a NameString.
AmlCodeGenMethodRetNameString (
"MET0", "_CRS", 1, TRUE, 3, ParentNode, NewObjectNode
);
is equivalent of the following ASL code:
Method(MET0, 1, Serialized, 3) {
Return (_CRS)
}
The ASL parameters "ReturnType" and "ParameterTypes" are not asked
in this function. They are optional parameters in ASL.
@param [in] MethodNameString The new Method's name.
Must be a NULL-terminated ASL NameString
e.g.: "MET0", "_SB.MET0", etc.
The input string is copied.
@param [in] ReturnedNameString The name of the object returned by the
method. Optional parameter, can be:
- NULL (ignored).
- A NULL-terminated ASL NameString.
e.g.: "MET0", "_SB.MET0", etc.
The input string is copied.
@param [in] NumArgs Number of arguments.
Must be 0 <= NumArgs <= 6.
@param [in] IsSerialized TRUE is equivalent to Serialized.
FALSE is equivalent to NotSerialized.
Default is NotSerialized in ASL spec.
@param [in] SyncLevel Synchronization level for the method.
Must be 0 <= SyncLevel <= 15.
Default is 0 in ASL.
@param [in] ParentNode If provided, set ParentNode as the parent
of the node created.
@param [out] NewObjectNode If success, contains the created node.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
EFI_STATUS
EFIAPI
AmlCodeGenMethodRetNameString (
IN CONST CHAR8 *MethodNameString,
IN CONST CHAR8 *ReturnedNameString OPTIONAL,
IN UINT8 NumArgs,
IN BOOLEAN IsSerialized,
IN UINT8 SyncLevel,
IN AML_NODE_HANDLE ParentNode OPTIONAL,
OUT AML_OBJECT_NODE_HANDLE *NewObjectNode OPTIONAL
)
{
EFI_STATUS Status;
AML_OBJECT_NODE_HANDLE MethodNode;
if ((MethodNameString == NULL) ||
((ParentNode == NULL) && (NewObjectNode == NULL)))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
// Create a Method named MethodNameString.
Status = AmlCodeGenMethod (
MethodNameString,
NumArgs,
IsSerialized,
SyncLevel,
NULL,
&MethodNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
return Status;
}
// Return ReturnedNameString if provided.
if (ReturnedNameString != NULL) {
Status = AmlCodeGenReturnNameString (
ReturnedNameString,
(AML_NODE_HANDLE)MethodNode,
NULL
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
}
Status = LinkNode (
MethodNode,
ParentNode,
NewObjectNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
return Status;
error_handler:
if (MethodNode != NULL) {
AmlDeleteTree ((AML_NODE_HANDLE)MethodNode);
}
return Status;
}
/** AML code generation for a method returning a NameString that takes an
integer argument.
AmlCodeGenMethodRetNameStringIntegerArgument (
"MET0", "MET1", 1, TRUE, 3, 5, ParentNode, NewObjectNode
);
is equivalent of the following ASL code:
Method(MET0, 1, Serialized, 3) {
Return (MET1 (5))
}
The ASL parameters "ReturnType" and "ParameterTypes" are not asked
in this function. They are optional parameters in ASL.
@param [in] MethodNameString The new Method's name.
Must be a NULL-terminated ASL NameString
e.g.: "MET0", "_SB.MET0", etc.
The input string is copied.
@param [in] ReturnedNameString The name of the object returned by the
method. Optional parameter, can be:
- NULL (ignored).
- A NULL-terminated ASL NameString.
e.g.: "MET0", "_SB.MET0", etc.
The input string is copied.
@param [in] NumArgs Number of arguments.
Must be 0 <= NumArgs <= 6.
@param [in] IsSerialized TRUE is equivalent to Serialized.
FALSE is equivalent to NotSerialized.
Default is NotSerialized in ASL spec.
@param [in] SyncLevel Synchronization level for the method.
Must be 0 <= SyncLevel <= 15.
Default is 0 in ASL.
@param [in] IntegerArgument Argument to pass to the NameString.
@param [in] ParentNode If provided, set ParentNode as the parent
of the node created.
@param [out] NewObjectNode If success, contains the created node.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
EFI_STATUS
EFIAPI
AmlCodeGenMethodRetNameStringIntegerArgument (
IN CONST CHAR8 *MethodNameString,
IN CONST CHAR8 *ReturnedNameString OPTIONAL,
IN UINT8 NumArgs,
IN BOOLEAN IsSerialized,
IN UINT8 SyncLevel,
IN UINT64 IntegerArgument,
IN AML_NODE_HANDLE ParentNode OPTIONAL,
OUT AML_OBJECT_NODE_HANDLE *NewObjectNode OPTIONAL
)
{
EFI_STATUS Status;
AML_OBJECT_NODE_HANDLE MethodNode;
if ((MethodNameString == NULL) ||
((ParentNode == NULL) && (NewObjectNode == NULL)))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
// Create a Method named MethodNameString.
Status = AmlCodeGenMethod (
MethodNameString,
NumArgs,
IsSerialized,
SyncLevel,
NULL,
&MethodNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
return Status;
}
// Return ReturnedNameString if provided.
if (ReturnedNameString != NULL) {
Status = AmlCodeGenReturnNameStringIntegerArgument (
ReturnedNameString,
IntegerArgument,
(AML_NODE_HANDLE)MethodNode,
NULL
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
}
Status = LinkNode (
MethodNode,
ParentNode,
NewObjectNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
return Status;
error_handler:
if (MethodNode != NULL) {
AmlDeleteTree ((AML_NODE_HANDLE)MethodNode);
}
return Status;
}
/** AML code generation for a method returning an Integer.
AmlCodeGenMethodRetInteger (
"_CBA", 0, 1, TRUE, 3, ParentNode, NewObjectNode
);
is equivalent of the following ASL code:
Method(_CBA, 1, Serialized, 3) {
Return (0)
}
The ASL parameters "ReturnType" and "ParameterTypes" are not asked
in this function. They are optional parameters in ASL.
@param [in] MethodNameString The new Method's name.
Must be a NULL-terminated ASL NameString
e.g.: "MET0", "_SB.MET0", etc.
The input string is copied.
@param [in] ReturnedInteger The value of the integer returned by the
method.
@param [in] NumArgs Number of arguments.
Must be 0 <= NumArgs <= 6.
@param [in] IsSerialized TRUE is equivalent to Serialized.
FALSE is equivalent to NotSerialized.
Default is NotSerialized in ASL spec.
@param [in] SyncLevel Synchronization level for the method.
Must be 0 <= SyncLevel <= 15.
Default is 0 in ASL.
@param [in] ParentNode If provided, set ParentNode as the parent
of the node created.
@param [out] NewObjectNode If success, contains the created node.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
EFI_STATUS
EFIAPI
AmlCodeGenMethodRetInteger (
IN CONST CHAR8 *MethodNameString,
IN UINT64 ReturnedInteger,
IN UINT8 NumArgs,
IN BOOLEAN IsSerialized,
IN UINT8 SyncLevel,
IN AML_NODE_HANDLE ParentNode OPTIONAL,
OUT AML_OBJECT_NODE_HANDLE *NewObjectNode OPTIONAL
)
{
EFI_STATUS Status;
AML_OBJECT_NODE_HANDLE MethodNode;
if ((MethodNameString == NULL) ||
((ParentNode == NULL) && (NewObjectNode == NULL)))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
// Create a Method named MethodNameString.
Status = AmlCodeGenMethod (
MethodNameString,
NumArgs,
IsSerialized,
SyncLevel,
NULL,
&MethodNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
return Status;
}
Status = AmlCodeGenReturnInteger (
ReturnedInteger,
(AML_NODE_HANDLE)MethodNode,
NULL
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
Status = LinkNode (
MethodNode,
ParentNode,
NewObjectNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
return Status;
error_handler:
if (MethodNode != NULL) {
AmlDeleteTree ((AML_NODE_HANDLE)MethodNode);
}
return Status;
}
/** Create a _LPI name.
AmlCreateLpiNode ("_LPI", 0, 1, ParentNode, &LpiNode) is
equivalent of the following ASL code:
Name (_LPI, Package (
0, // Revision
1, // LevelId
0 // Count
))
This function doesn't define any LPI state. As shown above, the count
of _LPI state is set to 0.
The AmlAddLpiState () function allows to add LPI states.
Cf ACPI 6.3 specification, s8.4.4 "Lower Power Idle States".
@param [in] LpiNameString The new LPI 's object name.
Must be a NULL-terminated ASL NameString
e.g.: "_LPI", "DEV0.PLPI", etc.
The input string is copied.
@param [in] Revision Revision number of the _LPI states.
@param [in] LevelId A platform defined number that identifies the
level of hierarchy of the processor node to
which the LPI states apply.
@param [in] ParentNode If provided, set ParentNode as the parent
of the node created.
@param [out] NewLpiNode If success, contains the created node.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
EFI_STATUS
EFIAPI
AmlCreateLpiNode (
IN CONST CHAR8 *LpiNameString,
IN UINT16 Revision,
IN UINT64 LevelId,
IN AML_NODE_HANDLE ParentNode OPTIONAL,
OUT AML_OBJECT_NODE_HANDLE *NewLpiNode OPTIONAL
)
{
EFI_STATUS Status;
AML_OBJECT_NODE_HANDLE PackageNode;
AML_OBJECT_NODE_HANDLE IntegerNode;
if ((LpiNameString == NULL) ||
((ParentNode == NULL) && (NewLpiNode == NULL)))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
IntegerNode = NULL;
Status = AmlCodeGenPackage (&PackageNode);
if (EFI_ERROR (Status)) {
ASSERT (0);
return Status;
}
// Create and attach Revision
Status = AmlCodeGenInteger (Revision, &IntegerNode);
if (EFI_ERROR (Status)) {
ASSERT (0);
IntegerNode = NULL;
goto error_handler;
}
Status = AmlVarListAddTail (
(AML_NODE_HANDLE)PackageNode,
(AML_NODE_HANDLE)IntegerNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
IntegerNode = NULL;
// Create and attach LevelId
Status = AmlCodeGenInteger (LevelId, &IntegerNode);
if (EFI_ERROR (Status)) {
ASSERT (0);
IntegerNode = NULL;
goto error_handler;
}
Status = AmlVarListAddTail (
(AML_NODE_HANDLE)PackageNode,
(AML_NODE_HANDLE)IntegerNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
IntegerNode = NULL;
// Create and attach Count. No LPI state is added, so 0.
Status = AmlCodeGenInteger (0, &IntegerNode);
if (EFI_ERROR (Status)) {
ASSERT (0);
IntegerNode = NULL;
goto error_handler;
}
Status = AmlVarListAddTail (
(AML_NODE_HANDLE)PackageNode,
(AML_NODE_HANDLE)IntegerNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
IntegerNode = NULL;
Status = AmlCodeGenName (LpiNameString, PackageNode, ParentNode, NewLpiNode);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
return Status;
error_handler:
AmlDeleteTree ((AML_NODE_HANDLE)PackageNode);
if (IntegerNode != NULL) {
AmlDeleteTree ((AML_NODE_HANDLE)IntegerNode);
}
return Status;
}
/** Add an _LPI state to a LPI node created using AmlCreateLpiNode.
AmlAddLpiState increments the Count of LPI states in the LPI node by one,
and adds the following package:
Package() {
MinResidency,
WorstCaseWakeLatency,
Flags,
ArchFlags,
ResCntFreq,
EnableParentState,
(GenericRegisterDescriptor != NULL) ? // Entry method. If a
ResourceTemplate(GenericRegisterDescriptor) : // Register is given,
Integer, // use it. Use the
// Integer otherwise.
ResourceTemplate() { // NULL Residency Counter
Register (SystemMemory, 0, 0, 0, 0)
},
ResourceTemplate() { // NULL Usage Counter
Register (SystemMemory, 0, 0, 0, 0)
},
"" // NULL State Name
},
Cf ACPI 6.3 specification, s8.4.4 "Lower Power Idle States".
@param [in] MinResidency Minimum Residency.
@param [in] WorstCaseWakeLatency Worst case wake-up latency.
@param [in] Flags Flags.
@param [in] ArchFlags Architectural flags.
@param [in] ResCntFreq Residency Counter Frequency.
@param [in] EnableParentState Enabled Parent State.
@param [in] GenericRegisterDescriptor Entry Method.
If not NULL, use this Register to
describe the entry method address.
@param [in] Integer Entry Method.
If GenericRegisterDescriptor is NULL,
take this value.
@param [in] ResidencyCounterRegister If not NULL, use it to populate the
residency counter register.
@param [in] UsageCounterRegister If not NULL, use it to populate the
usage counter register.
@param [in] StateName If not NULL, use it to populate the
state name.
@param [in] LpiNode Lpi node created with the function
AmlCreateLpiNode to which the new LPI
state is appended.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
EFI_STATUS
EFIAPI
AmlAddLpiState (
IN UINT32 MinResidency,
IN UINT32 WorstCaseWakeLatency,
IN UINT32 Flags,
IN UINT32 ArchFlags,
IN UINT32 ResCntFreq,
IN UINT32 EnableParentState,
IN EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE *GenericRegisterDescriptor OPTIONAL,
IN UINT64 Integer OPTIONAL,
IN EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE *ResidencyCounterRegister OPTIONAL,
IN EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE *UsageCounterRegister OPTIONAL,
IN CHAR8 *StateName OPTIONAL,
IN AML_OBJECT_NODE_HANDLE LpiNode
)
{
EFI_STATUS Status;
AML_DATA_NODE_HANDLE RdNode;
AML_OBJECT_NODE_HANDLE PackageNode;
AML_OBJECT_NODE_HANDLE IntegerNode;
AML_OBJECT_NODE_HANDLE StringNode;
AML_OBJECT_NODE_HANDLE NewLpiPackageNode;
AML_OBJECT_NODE_HANDLE ResourceTemplateNode;
UINT32 Index;
AML_OBJECT_NODE_HANDLE CountNode;
UINT64 Count;
if ((LpiNode == NULL) ||
(AmlGetNodeType ((AML_NODE_HANDLE)LpiNode) != EAmlNodeObject) ||
(!AmlNodeHasOpCode (LpiNode, AML_NAME_OP, 0)))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
RdNode = 0;
StringNode = NULL;
IntegerNode = NULL;
ResourceTemplateNode = NULL;
// AmlCreateLpiNode () created a LPI container such as:
// Name (_LPI, Package (
// 0, // Revision
// 1, // LevelId
// 0 // Count
// ))
// Get the LPI container, a PackageOp object node stored as the 2nd fixed
// argument (i.e. index 1) of LpiNode.
PackageNode = (AML_OBJECT_NODE_HANDLE)AmlGetFixedArgument (
LpiNode,
EAmlParseIndexTerm1
);
if ((PackageNode == NULL) ||
(AmlGetNodeType ((AML_NODE_HANDLE)PackageNode) != EAmlNodeObject) ||
(!AmlNodeHasOpCode (PackageNode, AML_PACKAGE_OP, 0)))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
CountNode = NULL;
// The third variable argument is the LPI Count node.
for (Index = 0; Index < 3; Index++) {
CountNode = (AML_OBJECT_NODE_HANDLE)AmlGetNextVariableArgument (
(AML_NODE_HANDLE)PackageNode,
(AML_NODE_HANDLE)CountNode
);
if (CountNode == NULL) {
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
}
Status = AmlNodeGetIntegerValue (CountNode, &Count);
if (EFI_ERROR (Status)) {
ASSERT (0);
return Status;
}
Status = AmlUpdateInteger (CountNode, Count + 1);
if (EFI_ERROR (Status)) {
ASSERT (0);
return Status;
}
Status = AmlCodeGenPackage (&NewLpiPackageNode);
if (EFI_ERROR (Status)) {
ASSERT (0);
return Status;
}
// MinResidency
Status = AmlCodeGenInteger (MinResidency, &IntegerNode);
if (EFI_ERROR (Status)) {
ASSERT (0);
IntegerNode = NULL;
goto error_handler;
}
Status = AmlVarListAddTail (
(AML_NODE_HANDLE)NewLpiPackageNode,
(AML_NODE_HANDLE)IntegerNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
IntegerNode = NULL;
// WorstCaseWakeLatency
Status = AmlCodeGenInteger (WorstCaseWakeLatency, &IntegerNode);
if (EFI_ERROR (Status)) {
ASSERT (0);
IntegerNode = NULL;
goto error_handler;
}
Status = AmlVarListAddTail (
(AML_NODE_HANDLE)NewLpiPackageNode,
(AML_NODE_HANDLE)IntegerNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
IntegerNode = NULL;
// Flags
Status = AmlCodeGenInteger (Flags, &IntegerNode);
if (EFI_ERROR (Status)) {
ASSERT (0);
IntegerNode = NULL;
goto error_handler;
}
Status = AmlVarListAddTail (
(AML_NODE_HANDLE)NewLpiPackageNode,
(AML_NODE_HANDLE)IntegerNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
IntegerNode = NULL;
// ArchFlags
Status = AmlCodeGenInteger (ArchFlags, &IntegerNode);
if (EFI_ERROR (Status)) {
ASSERT (0);
IntegerNode = NULL;
goto error_handler;
}
Status = AmlVarListAddTail (
(AML_NODE_HANDLE)NewLpiPackageNode,
(AML_NODE_HANDLE)IntegerNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
IntegerNode = NULL;
// ResCntFreq
Status = AmlCodeGenInteger (ResCntFreq, &IntegerNode);
if (EFI_ERROR (Status)) {
ASSERT (0);
IntegerNode = NULL;
goto error_handler;
}
Status = AmlVarListAddTail (
(AML_NODE_HANDLE)NewLpiPackageNode,
(AML_NODE_HANDLE)IntegerNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
IntegerNode = NULL;
// EnableParentState
Status = AmlCodeGenInteger (EnableParentState, &IntegerNode);
if (EFI_ERROR (Status)) {
ASSERT (0);
IntegerNode = NULL;
goto error_handler;
}
Status = AmlVarListAddTail (
(AML_NODE_HANDLE)NewLpiPackageNode,
(AML_NODE_HANDLE)IntegerNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
IntegerNode = NULL;
// Entry Method
if (GenericRegisterDescriptor != NULL) {
// Entry Method: As a Register resource data
Status = AmlCodeGenResourceTemplate (&ResourceTemplateNode);
if (EFI_ERROR (Status)) {
ASSERT (0);
ResourceTemplateNode = NULL;
goto error_handler;
}
Status = AmlCodeGenRdRegister (
GenericRegisterDescriptor->AddressSpaceId,
GenericRegisterDescriptor->RegisterBitWidth,
GenericRegisterDescriptor->RegisterBitOffset,
GenericRegisterDescriptor->Address,
GenericRegisterDescriptor->AccessSize,
NULL,
&RdNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
RdNode = NULL;
goto error_handler;
}
Status = AmlAppendRdNode (ResourceTemplateNode, RdNode);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
RdNode = NULL;
Status = AmlVarListAddTail (
(AML_NODE_HANDLE)NewLpiPackageNode,
(AML_NODE_HANDLE)ResourceTemplateNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
ResourceTemplateNode = NULL;
} else {
// Entry Method: As an integer
Status = AmlCodeGenInteger (Integer, &IntegerNode);
if (EFI_ERROR (Status)) {
ASSERT (0);
IntegerNode = NULL;
goto error_handler;
}
Status = AmlVarListAddTail (
(AML_NODE_HANDLE)NewLpiPackageNode,
(AML_NODE_HANDLE)IntegerNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
IntegerNode = NULL;
}
// Residency Counter Register.
Status = AmlCodeGenResourceTemplate (&ResourceTemplateNode);
if (EFI_ERROR (Status)) {
ASSERT (0);
ResourceTemplateNode = NULL;
goto error_handler;
}
if (ResidencyCounterRegister != NULL) {
Status = AmlCodeGenRdRegister (
ResidencyCounterRegister->AddressSpaceId,
ResidencyCounterRegister->RegisterBitWidth,
ResidencyCounterRegister->RegisterBitOffset,
ResidencyCounterRegister->Address,
ResidencyCounterRegister->AccessSize,
NULL,
&RdNode
);
} else {
Status = AmlCodeGenRdRegister (
EFI_ACPI_6_4_SYSTEM_MEMORY,
0,
0,
0,
0,
NULL,
&RdNode
);
}
if (EFI_ERROR (Status)) {
ASSERT (0);
RdNode = NULL;
goto error_handler;
}
Status = AmlAppendRdNode (ResourceTemplateNode, RdNode);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
RdNode = NULL;
Status = AmlVarListAddTail (
(AML_NODE_HANDLE)NewLpiPackageNode,
(AML_NODE_HANDLE)ResourceTemplateNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
ResourceTemplateNode = NULL;
// Usage Counter Register.
Status = AmlCodeGenResourceTemplate (&ResourceTemplateNode);
if (EFI_ERROR (Status)) {
ASSERT (0);
ResourceTemplateNode = NULL;
goto error_handler;
}
if (UsageCounterRegister != NULL) {
Status = AmlCodeGenRdRegister (
UsageCounterRegister->AddressSpaceId,
UsageCounterRegister->RegisterBitWidth,
UsageCounterRegister->RegisterBitOffset,
UsageCounterRegister->Address,
UsageCounterRegister->AccessSize,
NULL,
&RdNode
);
} else {
Status = AmlCodeGenRdRegister (
EFI_ACPI_6_4_SYSTEM_MEMORY,
0,
0,
0,
0,
NULL,
&RdNode
);
}
if (EFI_ERROR (Status)) {
ASSERT (0);
RdNode = NULL;
goto error_handler;
}
Status = AmlAppendRdNode (ResourceTemplateNode, RdNode);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
RdNode = NULL;
Status = AmlVarListAddTail (
(AML_NODE_HANDLE)NewLpiPackageNode,
(AML_NODE_HANDLE)ResourceTemplateNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
ResourceTemplateNode = NULL;
// State name.
if (UsageCounterRegister != NULL) {
Status = AmlCodeGenString (StateName, &StringNode);
} else {
Status = AmlCodeGenString ("", &StringNode);
}
if (EFI_ERROR (Status)) {
ASSERT (0);
StringNode = NULL;
goto error_handler;
}
Status = AmlVarListAddTail (
(AML_NODE_HANDLE)NewLpiPackageNode,
(AML_NODE_HANDLE)StringNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
StringNode = NULL;
// Add the new LPI state to the LpiNode.
Status = AmlVarListAddTail (
(AML_NODE_HANDLE)PackageNode,
(AML_NODE_HANDLE)NewLpiPackageNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto error_handler;
}
return Status;
error_handler:
if (RdNode != NULL) {
AmlDeleteTree ((AML_NODE_HANDLE)RdNode);
}
if (NewLpiPackageNode != NULL) {
AmlDeleteTree ((AML_NODE_HANDLE)NewLpiPackageNode);
}
if (StringNode != NULL) {
AmlDeleteTree ((AML_NODE_HANDLE)StringNode);
}
if (IntegerNode != NULL) {
AmlDeleteTree ((AML_NODE_HANDLE)IntegerNode);
}
if (ResourceTemplateNode != NULL) {
AmlDeleteTree ((AML_NODE_HANDLE)ResourceTemplateNode);
}
return Status;
}
/** AML code generation for a _DSD device data object.
AmlAddDeviceDataDescriptorPackage (Uuid, DsdNode, PackageNode) is
equivalent of the following ASL code:
ToUUID(Uuid),
Package () {}
Cf ACPI 6.4 specification, s6.2.5 "_DSD (Device Specific Data)".
_DSD (Device Specific Data) Implementation Guide
https://github.com/UEFI/DSD-Guide
Per s3. "'Well-Known _DSD UUIDs and Data Structure Formats'"
If creating a Device Properties data then UUID daffd814-6eba-4d8c-8a91-bc9bbf4aa301 should be used.
@param [in] Uuid The Uuid of the descriptor to be created
@param [in] DsdNode Node of the DSD Package.
@param [out] PackageNode If success, contains the created package node.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
EFI_STATUS
EFIAPI
AmlAddDeviceDataDescriptorPackage (
IN CONST EFI_GUID *Uuid,
IN AML_OBJECT_NODE_HANDLE DsdNode,
OUT AML_OBJECT_NODE_HANDLE *PackageNode
)
{
EFI_STATUS Status;
AML_OBJECT_NODE *UuidNode;
AML_DATA_NODE *UuidDataNode;
AML_OBJECT_NODE_HANDLE DsdEntryList;
if ((Uuid == NULL) ||
(PackageNode == NULL) ||
(AmlGetNodeType ((AML_NODE_HANDLE)DsdNode) != EAmlNodeObject) ||
(!AmlNodeHasOpCode (DsdNode, AML_NAME_OP, 0)) ||
!AmlNameOpCompareName (DsdNode, "_DSD"))
{
ASSERT_EFI_ERROR (EFI_INVALID_PARAMETER);
return EFI_INVALID_PARAMETER;
}
// Get the Package object node of the _DSD node,
// which is the 2nd fixed argument (i.e. index 1).
DsdEntryList = (AML_OBJECT_NODE_HANDLE)AmlGetFixedArgument (
DsdNode,
EAmlParseIndexTerm1
);
if ((DsdEntryList == NULL) ||
(AmlGetNodeType ((AML_NODE_HANDLE)DsdEntryList) != EAmlNodeObject) ||
(!AmlNodeHasOpCode (DsdEntryList, AML_PACKAGE_OP, 0)))
{
ASSERT_EFI_ERROR (EFI_INVALID_PARAMETER);
return EFI_INVALID_PARAMETER;
}
*PackageNode = NULL;
UuidDataNode = NULL;
Status = AmlCodeGenBuffer (NULL, 0, &UuidNode);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
return Status;
}
Status = AmlCreateDataNode (
EAmlNodeDataTypeRaw,
(CONST UINT8 *)Uuid,
sizeof (EFI_GUID),
&UuidDataNode
);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
Status = AmlVarListAddTail (
(AML_NODE_HEADER *)UuidNode,
(AML_NODE_HEADER *)UuidDataNode
);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
UuidDataNode = NULL;
// Append to the list of _DSD entries.
Status = AmlVarListAddTail (
(AML_NODE_HANDLE)DsdEntryList,
(AML_NODE_HANDLE)UuidNode
);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
Status = AmlCodeGenPackage (PackageNode);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler_detach;
}
// Append to the list of _DSD entries.
Status = AmlVarListAddTail (
(AML_NODE_HANDLE)DsdEntryList,
(AML_NODE_HANDLE)*PackageNode
);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler_detach;
}
return Status;
error_handler_detach:
if (UuidNode != NULL) {
AmlDetachNode ((AML_NODE_HANDLE)UuidNode);
}
error_handler:
if (UuidNode != NULL) {
AmlDeleteTree ((AML_NODE_HANDLE)UuidNode);
}
if (*PackageNode != NULL) {
AmlDeleteTree ((AML_NODE_HANDLE)*PackageNode);
*PackageNode = NULL;
}
if (UuidDataNode != NULL) {
AmlDeleteTree ((AML_NODE_HANDLE)UuidDataNode);
}
return Status;
}
/** AML code generation to add a package with a name and value,
to a parent package.
This is useful to build the _DSD package but can be used in other cases.
AmlAddNameIntegerPackage ("Name", Value, PackageNode) is
equivalent of the following ASL code:
Package (2) {"Name", Value}
Cf ACPI 6.4 specification, s6.2.5 "_DSD (Device Specific Data)".
@param [in] Name String to place in first entry of package
@param [in] Value Integer to place in second entry of package
@param [in] PackageNode Package to add new sub package to.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
EFI_STATUS
EFIAPI
AmlAddNameIntegerPackage (
IN CHAR8 *Name,
IN UINT64 Value,
IN AML_OBJECT_NODE_HANDLE PackageNode
)
{
EFI_STATUS Status;
AML_OBJECT_NODE *NameNode;
AML_OBJECT_NODE *ValueNode;
AML_OBJECT_NODE *NewPackageNode;
if ((Name == NULL) ||
(AmlGetNodeType ((AML_NODE_HANDLE)PackageNode) != EAmlNodeObject) ||
(!AmlNodeHasOpCode (PackageNode, AML_PACKAGE_OP, 0)))
{
ASSERT_EFI_ERROR (EFI_INVALID_PARAMETER);
return EFI_INVALID_PARAMETER;
}
NameNode = NULL;
ValueNode = NULL;
// The new package entry.
Status = AmlCodeGenPackage (&NewPackageNode);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
return Status;
}
Status = AmlCodeGenString (Name, &NameNode);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
Status = AmlVarListAddTail (
(AML_NODE_HANDLE)NewPackageNode,
(AML_NODE_HANDLE)NameNode
);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
NameNode = NULL;
Status = AmlCodeGenInteger (Value, &ValueNode);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
Status = AmlVarListAddTail (
(AML_NODE_HANDLE)NewPackageNode,
(AML_NODE_HANDLE)ValueNode
);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
ValueNode = NULL;
Status = AmlVarListAddTail (
(AML_NODE_HANDLE)PackageNode,
(AML_NODE_HANDLE)NewPackageNode
);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
return Status;
error_handler:
if (NewPackageNode != NULL) {
AmlDeleteTree ((AML_NODE_HANDLE)NewPackageNode);
}
if (NameNode != NULL) {
AmlDeleteTree ((AML_NODE_HANDLE)NameNode);
}
if (ValueNode != NULL) {
AmlDeleteTree ((AML_NODE_HANDLE)ValueNode);
}
return Status;
}
/** Adds a register to the package
@ingroup CodeGenApis
@param [in] Register If provided, register that will be added to package.
otherwise NULL register will be added
@param [in] PackageNode Package to add value to
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
STATIC
EFI_STATUS
EFIAPI
AmlAddRegisterToPackage (
IN EFI_ACPI_6_4_GENERIC_ADDRESS_STRUCTURE *Register OPTIONAL,
IN AML_OBJECT_NODE_HANDLE PackageNode
)
{
EFI_STATUS Status;
AML_DATA_NODE_HANDLE RdNode;
AML_OBJECT_NODE_HANDLE ResourceTemplateNode;
RdNode = NULL;
Status = AmlCodeGenResourceTemplate (&ResourceTemplateNode);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
return Status;
}
if (Register != NULL) {
Status = AmlCodeGenRdRegister (
Register->AddressSpaceId,
Register->RegisterBitWidth,
Register->RegisterBitOffset,
Register->Address,
Register->AccessSize,
NULL,
&RdNode
);
} else {
Status = AmlCodeGenRdRegister (
EFI_ACPI_6_4_SYSTEM_MEMORY,
0,
0,
0,
0,
NULL,
&RdNode
);
}
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
Status = AmlAppendRdNode (ResourceTemplateNode, RdNode);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
RdNode = NULL;
Status = AmlVarListAddTail (
(AML_NODE_HANDLE)PackageNode,
(AML_NODE_HANDLE)ResourceTemplateNode
);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
return Status;
error_handler:
if (RdNode != NULL) {
AmlDeleteTree ((AML_NODE_HANDLE)RdNode);
}
if (ResourceTemplateNode != NULL) {
AmlDeleteTree ((AML_NODE_HANDLE)ResourceTemplateNode);
}
return Status;
}
/** Utility function to check if generic address points to NULL
@param [in] Address Pointer to the Generic address
@retval TRUE Address is system memory with an Address of 0.
@retval FALSE Address does not point to NULL.
**/
STATIC
BOOLEAN
EFIAPI
IsNullGenericAddress (
IN EFI_ACPI_6_4_GENERIC_ADDRESS_STRUCTURE *Address
)
{
if ((Address == NULL) ||
((Address->AddressSpaceId == EFI_ACPI_6_4_SYSTEM_MEMORY) &&
(Address->Address == 0x0)))
{
return TRUE;
}
return FALSE;
}
/** Adds an integer or register to the package
@ingroup CodeGenApis
@param [in] Register If provided, register that will be added to package
@param [in] Integer If Register is NULL, integer that will be added to the package
@param [in] PackageNode Package to add value to
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
STATIC
EFI_STATUS
EFIAPI
AmlAddRegisterOrIntegerToPackage (
IN EFI_ACPI_6_4_GENERIC_ADDRESS_STRUCTURE *Register OPTIONAL,
IN UINT32 Integer,
IN AML_OBJECT_NODE_HANDLE PackageNode
)
{
EFI_STATUS Status;
AML_OBJECT_NODE_HANDLE IntegerNode;
IntegerNode = NULL;
if (!IsNullGenericAddress (Register)) {
Status = AmlAddRegisterToPackage (Register, PackageNode);
} else {
Status = AmlCodeGenInteger (Integer, &IntegerNode);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
return Status;
}
Status = AmlVarListAddTail (
(AML_NODE_HANDLE)PackageNode,
(AML_NODE_HANDLE)IntegerNode
);
}
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
if (IntegerNode != NULL) {
AmlDeleteTree ((AML_NODE_HANDLE)IntegerNode);
}
}
return Status;
}
/** Create a _CPC node.
Creates and optionally adds the following node
Name(_CPC, Package()
{
NumEntries, // Integer
Revision, // Integer
HighestPerformance, // Integer or Buffer (Resource Descriptor)
NominalPerformance, // Integer or Buffer (Resource Descriptor)
LowestNonlinearPerformance, // Integer or Buffer (Resource Descriptor)
LowestPerformance, // Integer or Buffer (Resource Descriptor)
GuaranteedPerformanceRegister, // Buffer (Resource Descriptor)
DesiredPerformanceRegister , // Buffer (Resource Descriptor)
MinimumPerformanceRegister , // Buffer (Resource Descriptor)
MaximumPerformanceRegister , // Buffer (Resource Descriptor)
PerformanceReductionToleranceRegister, // Buffer (Resource Descriptor)
TimeWindowRegister, // Buffer (Resource Descriptor)
CounterWraparoundTime, // Integer or Buffer (Resource Descriptor)
ReferencePerformanceCounterRegister, // Buffer (Resource Descriptor)
DeliveredPerformanceCounterRegister, // Buffer (Resource Descriptor)
PerformanceLimitedRegister, // Buffer (Resource Descriptor)
CPPCEnableRegister // Buffer (Resource Descriptor)
AutonomousSelectionEnable, // Integer or Buffer (Resource Descriptor)
AutonomousActivityWindowRegister, // Buffer (Resource Descriptor)
EnergyPerformancePreferenceRegister, // Buffer (Resource Descriptor)
ReferencePerformance // Integer or Buffer (Resource Descriptor)
LowestFrequency, // Integer or Buffer (Resource Descriptor)
NominalFrequency // Integer or Buffer (Resource Descriptor)
})
If resource buffer is NULL then integer will be used.
Cf. ACPI 6.4, s8.4.7.1 _CPC (Continuous Performance Control)
@ingroup CodeGenApis
@param [in] CpcInfo CpcInfo object
@param [in] ParentNode If provided, set ParentNode as the parent
of the node created.
@param [out] NewCpcNode If success and provided, contains the created node.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
EFI_STATUS
EFIAPI
AmlCreateCpcNode (
IN AML_CPC_INFO *CpcInfo,
IN AML_NODE_HANDLE ParentNode OPTIONAL,
OUT AML_OBJECT_NODE_HANDLE *NewCpcNode OPTIONAL
)
{
EFI_STATUS Status;
AML_OBJECT_NODE_HANDLE CpcNode;
AML_OBJECT_NODE_HANDLE CpcPackage;
UINT32 NumberOfEntries;
if ((CpcInfo == NULL) ||
((ParentNode == NULL) && (NewCpcNode == NULL)))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
// Revision 3 per ACPI 6.4 specification
if (CpcInfo->Revision == EFI_ACPI_6_5_AML_CPC_REVISION) {
// NumEntries 23 per ACPI 6.4 specification
NumberOfEntries = 23;
} else {
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
if ((IsNullGenericAddress (&CpcInfo->HighestPerformanceBuffer) &&
(CpcInfo->HighestPerformanceInteger == 0)) ||
(IsNullGenericAddress (&CpcInfo->NominalPerformanceBuffer) &&
(CpcInfo->NominalPerformanceInteger == 0)) ||
(IsNullGenericAddress (&CpcInfo->LowestNonlinearPerformanceBuffer) &&
(CpcInfo->LowestNonlinearPerformanceInteger == 0)) ||
(IsNullGenericAddress (&CpcInfo->LowestPerformanceBuffer) &&
(CpcInfo->LowestPerformanceInteger == 0)) ||
IsNullGenericAddress (&CpcInfo->DesiredPerformanceRegister) ||
IsNullGenericAddress (&CpcInfo->ReferencePerformanceCounterRegister) ||
IsNullGenericAddress (&CpcInfo->DeliveredPerformanceCounterRegister) ||
IsNullGenericAddress (&CpcInfo->PerformanceLimitedRegister))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
CpcPackage = NULL;
Status = AmlCodeGenNamePackage ("_CPC", NULL, &CpcNode);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
return Status;
}
// Get the Package object node of the _CPC node,
// which is the 2nd fixed argument (i.e. index 1).
CpcPackage = (AML_OBJECT_NODE_HANDLE)AmlGetFixedArgument (
CpcNode,
EAmlParseIndexTerm1
);
if ((CpcPackage == NULL) ||
(AmlGetNodeType ((AML_NODE_HANDLE)CpcPackage) != EAmlNodeObject) ||
(!AmlNodeHasOpCode (CpcPackage, AML_PACKAGE_OP, 0)))
{
ASSERT (0);
Status = EFI_INVALID_PARAMETER;
goto error_handler;
}
Status = AmlAddRegisterOrIntegerToPackage (
NULL,
NumberOfEntries,
CpcPackage
);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
Status = AmlAddRegisterOrIntegerToPackage (
NULL,
CpcInfo->Revision,
CpcPackage
);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
Status = AmlAddRegisterOrIntegerToPackage (
&CpcInfo->HighestPerformanceBuffer,
CpcInfo->HighestPerformanceInteger,
CpcPackage
);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
Status = AmlAddRegisterOrIntegerToPackage (
&CpcInfo->NominalPerformanceBuffer,
CpcInfo->NominalPerformanceInteger,
CpcPackage
);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
Status = AmlAddRegisterOrIntegerToPackage (
&CpcInfo->LowestNonlinearPerformanceBuffer,
CpcInfo->LowestNonlinearPerformanceInteger,
CpcPackage
);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
Status = AmlAddRegisterOrIntegerToPackage (
&CpcInfo->LowestPerformanceBuffer,
CpcInfo->LowestPerformanceInteger,
CpcPackage
);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
Status = AmlAddRegisterToPackage (&CpcInfo->GuaranteedPerformanceRegister, CpcPackage);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
Status = AmlAddRegisterToPackage (&CpcInfo->DesiredPerformanceRegister, CpcPackage);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
Status = AmlAddRegisterToPackage (&CpcInfo->MinimumPerformanceRegister, CpcPackage);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
Status = AmlAddRegisterToPackage (&CpcInfo->MaximumPerformanceRegister, CpcPackage);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
Status = AmlAddRegisterToPackage (&CpcInfo->PerformanceReductionToleranceRegister, CpcPackage);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
Status = AmlAddRegisterToPackage (&CpcInfo->TimeWindowRegister, CpcPackage);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
Status = AmlAddRegisterOrIntegerToPackage (
&CpcInfo->CounterWraparoundTimeBuffer,
CpcInfo->CounterWraparoundTimeInteger,
CpcPackage
);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
Status = AmlAddRegisterToPackage (&CpcInfo->ReferencePerformanceCounterRegister, CpcPackage);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
Status = AmlAddRegisterToPackage (&CpcInfo->DeliveredPerformanceCounterRegister, CpcPackage);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
Status = AmlAddRegisterToPackage (&CpcInfo->PerformanceLimitedRegister, CpcPackage);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
Status = AmlAddRegisterToPackage (&CpcInfo->CPPCEnableRegister, CpcPackage);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
Status = AmlAddRegisterOrIntegerToPackage (
&CpcInfo->AutonomousSelectionEnableBuffer,
CpcInfo->AutonomousSelectionEnableInteger,
CpcPackage
);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
Status = AmlAddRegisterToPackage (&CpcInfo->AutonomousActivityWindowRegister, CpcPackage);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
Status = AmlAddRegisterToPackage (&CpcInfo->EnergyPerformancePreferenceRegister, CpcPackage);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
Status = AmlAddRegisterOrIntegerToPackage (
&CpcInfo->ReferencePerformanceBuffer,
CpcInfo->ReferencePerformanceInteger,
CpcPackage
);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
Status = AmlAddRegisterOrIntegerToPackage (
&CpcInfo->LowestFrequencyBuffer,
CpcInfo->LowestFrequencyInteger,
CpcPackage
);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
Status = AmlAddRegisterOrIntegerToPackage (
&CpcInfo->NominalFrequencyBuffer,
CpcInfo->NominalFrequencyInteger,
CpcPackage
);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
Status = LinkNode (CpcNode, ParentNode, NewCpcNode);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto error_handler;
}
return Status;
error_handler:
AmlDeleteTree ((AML_NODE_HANDLE)CpcNode);
return Status;
}
/** AML code generation to add a NameString to the package in a named node.
@param [in] NameString NameString to add
@param [in] NamedNode Node to add the string to the included package.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
EFI_STATUS
EFIAPI
AmlAddNameStringToNamedPackage (
IN CHAR8 *NameString,
IN AML_OBJECT_NODE_HANDLE NamedNode
)
{
EFI_STATUS Status;
AML_DATA_NODE *DataNode;
CHAR8 *AmlNameString;
UINT32 AmlNameStringSize;
AML_OBJECT_NODE_HANDLE PackageNode;
DataNode = NULL;
if ((NamedNode == NULL) ||
(AmlGetNodeType ((AML_NODE_HANDLE)NamedNode) != EAmlNodeObject) ||
(!AmlNodeHasOpCode (NamedNode, AML_NAME_OP, 0)))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
PackageNode = (AML_OBJECT_NODE_HANDLE)AmlGetFixedArgument (
NamedNode,
EAmlParseIndexTerm1
);
if ((PackageNode == NULL) ||
(AmlGetNodeType ((AML_NODE_HANDLE)PackageNode) != EAmlNodeObject) ||
(!AmlNodeHasOpCode (PackageNode, AML_PACKAGE_OP, 0)))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
Status = ConvertAslNameToAmlName (NameString, &AmlNameString);
if (EFI_ERROR (Status)) {
ASSERT (0);
return Status;
}
Status = AmlGetNameStringSize (AmlNameString, &AmlNameStringSize);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto exit_handler;
}
Status = AmlCreateDataNode (
EAmlNodeDataTypeNameString,
(UINT8 *)AmlNameString,
AmlNameStringSize,
&DataNode
);
if (EFI_ERROR (Status)) {
ASSERT (0);
goto exit_handler;
}
Status = AmlVarListAddTail (
(AML_NODE_HANDLE)PackageNode,
(AML_NODE_HANDLE)DataNode
);
if (EFI_ERROR (Status)) {
AmlDeleteTree ((AML_NODE_HANDLE)DataNode);
}
exit_handler:
if (AmlNameString != NULL) {
FreePool (AmlNameString);
}
return Status;
}
/** AML code generation to invoke/call another method.
This method is a subset implementation of MethodInvocation
defined in the ACPI specification 6.5,
section 20.2.5 "Term Objects Encoding".
Added integer, string, ArgObj and LocalObj support.
Example 1:
AmlCodeGenInvokeMethod ("MET0", 0, NULL, ParentNode);
is equivalent to the following ASL code:
MET0 ();
Example 2:
AML_METHOD_PARAM Param[4];
Param[0].Data.Integer = 0x100;
Param[0].Type = AmlMethodParamTypeInteger;
Param[1].Data.Buffer = "TEST";
Param[1].Type = AmlMethodParamTypeString;
Param[2].Data.Arg = 0;
Param[2].Type = AmlMethodParamTypeArg;
Param[3].Data.Local = 2;
Param[3].Type = AmlMethodParamTypeLocal;
AmlCodeGenInvokeMethod ("MET0", 4, Param, ParentNode);
is equivalent to the following ASL code:
MET0 (0x100, "TEST", Arg0, Local2);
Example 3:
AML_METHOD_PARAM Param[2];
Param[0].Data.Arg = 0;
Param[0].Type = AmlMethodParamTypeArg;
Param[1].Data.Integer = 0x100;
Param[1].Type = AmlMethodParamTypeInteger;
AmlCodeGenMethodRetNameString ("MET2", NULL, 2, TRUE, 0,
ParentNode, &MethodNode);
AmlCodeGenInvokeMethod ("MET3", 2, Param, MethodNode);
is equivalent to the following ASL code:
Method (MET2, 2, Serialized)
{
MET3 (Arg0, 0x0100)
}
@param [in] MethodNameString The method name to be called or invoked.
@param [in] NumArgs Number of arguments to be passed,
0 to 7 are permissible values.
@param [in] Parameters Contains the parameter data.
@param [in] ParentNode The parent node to which the method invocation
nodes are attached.
@retval EFI_SUCCESS Success.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
EFI_STATUS
EFIAPI
AmlCodeGenInvokeMethod (
IN CONST CHAR8 *MethodNameString,
IN UINT8 NumArgs,
IN AML_METHOD_PARAM *Parameters OPTIONAL,
IN AML_NODE_HANDLE ParentNode
)
{
EFI_STATUS Status;
UINT8 Index;
CHAR8 *AmlNameString;
UINT32 AmlNameStringSize;
AML_DATA_NODE *DataNode;
AML_OBJECT_NODE *ObjectNode;
AML_NODE_HANDLE *NodeStream;
if ((MethodNameString == NULL) || (ParentNode == NULL)) {
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
if ((NumArgs > 7) ||
((Parameters == NULL) && (NumArgs > 0)))
{
ASSERT (0);
return EFI_INVALID_PARAMETER;
}
/// Allocate space to store methodname, object, data node pointers
NodeStream = AllocateZeroPool (sizeof (AML_NODE_HANDLE) * (NumArgs + 1));
if (NodeStream == NULL) {
ASSERT (0);
return EFI_OUT_OF_RESOURCES;
}
/// Create a called or invoked method name string.
Status = ConvertAslNameToAmlName (MethodNameString, &AmlNameString);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto exit_handler;
}
Status = AmlGetNameStringSize (AmlNameString, &AmlNameStringSize);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
FreePool (AmlNameString);
goto exit_handler;
}
DataNode = NULL;
Status = AmlCreateDataNode (
EAmlNodeDataTypeNameString,
(UINT8 *)AmlNameString,
AmlNameStringSize,
&DataNode
);
FreePool (AmlNameString);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto exit_handler;
}
NodeStream[0] = (AML_NODE_HANDLE)DataNode;
if (Parameters != NULL) {
/// Validate and convert the Parameters to the stream of nodes.
for (Index = 0; Index < NumArgs; Index++) {
ObjectNode = NULL;
switch (Parameters[Index].Type) {
case AmlMethodParamTypeInteger:
Status = AmlCodeGenInteger (
Parameters[Index].Data.Integer,
&ObjectNode
);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto exit_handler;
}
break;
case AmlMethodParamTypeString:
if (Parameters[Index].Data.Buffer == NULL) {
ASSERT_EFI_ERROR (EFI_INVALID_PARAMETER);
Status = EFI_INVALID_PARAMETER;
goto exit_handler;
}
Status = AmlCodeGenString (
Parameters[Index].Data.Buffer,
&ObjectNode
);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto exit_handler;
}
break;
case AmlMethodParamTypeArg:
if (Parameters[Index].Data.Arg > (UINT8)(AML_ARG6 - AML_ARG0)) {
ASSERT_EFI_ERROR (EFI_INVALID_PARAMETER);
Status = EFI_INVALID_PARAMETER;
goto exit_handler;
}
Status = AmlCreateObjectNode (
AmlGetByteEncodingByOpCode (
AML_ARG0 + Parameters[Index].Data.Arg,
0
),
0,
&ObjectNode
);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto exit_handler;
}
break;
case AmlMethodParamTypeLocal:
if (Parameters[Index].Data.Local > (UINT8)(AML_LOCAL7 - AML_LOCAL0)) {
ASSERT_EFI_ERROR (EFI_INVALID_PARAMETER);
Status = EFI_INVALID_PARAMETER;
goto exit_handler;
}
Status = AmlCreateObjectNode (
AmlGetByteEncodingByOpCode (
AML_LOCAL0 + Parameters[Index].Data.Local,
0
),
0,
&ObjectNode
);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto exit_handler;
}
break;
default:
ASSERT_EFI_ERROR (EFI_INVALID_PARAMETER);
Status = EFI_INVALID_PARAMETER;
goto exit_handler;
} // switch
// Link the Object Node in the Node Stream.
NodeStream[Index + 1] = (AML_NODE_HANDLE)ObjectNode;
} // for
}
/// Index <= NumArgs, because an additional method name was added.
for (Index = 0; Index <= NumArgs; Index++) {
Status = AmlVarListAddTail (
(AML_NODE_HANDLE)ParentNode,
(AML_NODE_HANDLE)NodeStream[Index]
);
if (EFI_ERROR (Status)) {
ASSERT_EFI_ERROR (Status);
goto exit_handler_detach;
}
}
FreePool (NodeStream);
return Status;
exit_handler_detach:
/// The index contains the last successful node attached.
for ( ; Index > 0; Index--) {
/// Index contains the node number that is failed for AmlVarListAddTail().
/// Hence, start detaching from the last successful
AmlDetachNode (NodeStream[Index-1]);
}
exit_handler:
/// Index <= NumArgs, because an additional method name was added.
for (Index = 0; Index <= NumArgs; Index++) {
if (NodeStream[Index] != 0) {
AmlDeleteTree (NodeStream[Index]);
}
}
FreePool (NodeStream);
return Status;
}
|