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 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596
|
/*
*
* Copyright (C) 2019-2025 Intel Corporation
*
* SPDX-License-Identifier: MIT
*
* @file zes_api.h
* @version v1.14-r1.14.33
*
*/
#ifndef _ZES_API_H
#define _ZES_API_H
#if defined(__cplusplus)
#pragma once
#endif
// 'core' API headers
#include "ze_api.h"
#if defined(__cplusplus)
extern "C" {
#endif
// Intel 'oneAPI' Level-Zero Sysman API common types
#if !defined(__GNUC__)
#pragma region common
#endif
///////////////////////////////////////////////////////////////////////////////
/// @brief Handle to a driver instance
typedef ze_driver_handle_t zes_driver_handle_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Handle of device object
typedef ze_device_handle_t zes_device_handle_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Handle for a Sysman device scheduler queue
typedef struct _zes_sched_handle_t *zes_sched_handle_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Handle for a Sysman device performance factors
typedef struct _zes_perf_handle_t *zes_perf_handle_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Handle for a Sysman device power domain
typedef struct _zes_pwr_handle_t *zes_pwr_handle_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Handle for a Sysman device frequency domain
typedef struct _zes_freq_handle_t *zes_freq_handle_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Handle for a Sysman device engine group
typedef struct _zes_engine_handle_t *zes_engine_handle_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Handle for a Sysman device standby control
typedef struct _zes_standby_handle_t *zes_standby_handle_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Handle for a Sysman device firmware
typedef struct _zes_firmware_handle_t *zes_firmware_handle_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Handle for a Sysman device memory module
typedef struct _zes_mem_handle_t *zes_mem_handle_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Handle for a Sysman fabric port
typedef struct _zes_fabric_port_handle_t *zes_fabric_port_handle_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Handle for a Sysman device temperature sensor
typedef struct _zes_temp_handle_t *zes_temp_handle_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Handle for a Sysman device power supply
typedef struct _zes_psu_handle_t *zes_psu_handle_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Handle for a Sysman device fan
typedef struct _zes_fan_handle_t *zes_fan_handle_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Handle for a Sysman device LED
typedef struct _zes_led_handle_t *zes_led_handle_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Handle for a Sysman device RAS error set
typedef struct _zes_ras_handle_t *zes_ras_handle_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Handle for a Sysman device diagnostics test suite
typedef struct _zes_diag_handle_t *zes_diag_handle_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Handle for a Sysman device overclock domain
typedef struct _zes_overclock_handle_t *zes_overclock_handle_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Handle for a Sysman virtual function management domain
typedef struct _zes_vf_handle_t *zes_vf_handle_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Defines structure types
typedef enum _zes_structure_type_t
{
ZES_STRUCTURE_TYPE_DEVICE_PROPERTIES = 0x1, ///< ::zes_device_properties_t
ZES_STRUCTURE_TYPE_PCI_PROPERTIES = 0x2, ///< ::zes_pci_properties_t
ZES_STRUCTURE_TYPE_PCI_BAR_PROPERTIES = 0x3, ///< ::zes_pci_bar_properties_t
ZES_STRUCTURE_TYPE_DIAG_PROPERTIES = 0x4, ///< ::zes_diag_properties_t
ZES_STRUCTURE_TYPE_ENGINE_PROPERTIES = 0x5, ///< ::zes_engine_properties_t
ZES_STRUCTURE_TYPE_FABRIC_PORT_PROPERTIES = 0x6, ///< ::zes_fabric_port_properties_t
ZES_STRUCTURE_TYPE_FAN_PROPERTIES = 0x7, ///< ::zes_fan_properties_t
ZES_STRUCTURE_TYPE_FIRMWARE_PROPERTIES = 0x8, ///< ::zes_firmware_properties_t
ZES_STRUCTURE_TYPE_FREQ_PROPERTIES = 0x9, ///< ::zes_freq_properties_t
ZES_STRUCTURE_TYPE_LED_PROPERTIES = 0xa, ///< ::zes_led_properties_t
ZES_STRUCTURE_TYPE_MEM_PROPERTIES = 0xb, ///< ::zes_mem_properties_t
ZES_STRUCTURE_TYPE_PERF_PROPERTIES = 0xc, ///< ::zes_perf_properties_t
ZES_STRUCTURE_TYPE_POWER_PROPERTIES = 0xd, ///< ::zes_power_properties_t
ZES_STRUCTURE_TYPE_PSU_PROPERTIES = 0xe, ///< ::zes_psu_properties_t
ZES_STRUCTURE_TYPE_RAS_PROPERTIES = 0xf, ///< ::zes_ras_properties_t
ZES_STRUCTURE_TYPE_SCHED_PROPERTIES = 0x10, ///< ::zes_sched_properties_t
ZES_STRUCTURE_TYPE_SCHED_TIMEOUT_PROPERTIES = 0x11, ///< ::zes_sched_timeout_properties_t
ZES_STRUCTURE_TYPE_SCHED_TIMESLICE_PROPERTIES = 0x12, ///< ::zes_sched_timeslice_properties_t
ZES_STRUCTURE_TYPE_STANDBY_PROPERTIES = 0x13, ///< ::zes_standby_properties_t
ZES_STRUCTURE_TYPE_TEMP_PROPERTIES = 0x14, ///< ::zes_temp_properties_t
ZES_STRUCTURE_TYPE_DEVICE_STATE = 0x15, ///< ::zes_device_state_t
ZES_STRUCTURE_TYPE_PROCESS_STATE = 0x16, ///< ::zes_process_state_t
ZES_STRUCTURE_TYPE_PCI_STATE = 0x17, ///< ::zes_pci_state_t
ZES_STRUCTURE_TYPE_FABRIC_PORT_CONFIG = 0x18, ///< ::zes_fabric_port_config_t
ZES_STRUCTURE_TYPE_FABRIC_PORT_STATE = 0x19, ///< ::zes_fabric_port_state_t
ZES_STRUCTURE_TYPE_FAN_CONFIG = 0x1a, ///< ::zes_fan_config_t
ZES_STRUCTURE_TYPE_FREQ_STATE = 0x1b, ///< ::zes_freq_state_t
ZES_STRUCTURE_TYPE_OC_CAPABILITIES = 0x1c, ///< ::zes_oc_capabilities_t
ZES_STRUCTURE_TYPE_LED_STATE = 0x1d, ///< ::zes_led_state_t
ZES_STRUCTURE_TYPE_MEM_STATE = 0x1e, ///< ::zes_mem_state_t
ZES_STRUCTURE_TYPE_PSU_STATE = 0x1f, ///< ::zes_psu_state_t
ZES_STRUCTURE_TYPE_BASE_STATE = 0x20, ///< ::zes_base_state_t
ZES_STRUCTURE_TYPE_RAS_CONFIG = 0x21, ///< ::zes_ras_config_t
ZES_STRUCTURE_TYPE_RAS_STATE = 0x22, ///< ::zes_ras_state_t
ZES_STRUCTURE_TYPE_TEMP_CONFIG = 0x23, ///< ::zes_temp_config_t
ZES_STRUCTURE_TYPE_PCI_BAR_PROPERTIES_1_2 = 0x24, ///< ::zes_pci_bar_properties_1_2_t
ZES_STRUCTURE_TYPE_DEVICE_ECC_DESC = 0x25, ///< ::zes_device_ecc_desc_t
ZES_STRUCTURE_TYPE_DEVICE_ECC_PROPERTIES = 0x26, ///< ::zes_device_ecc_properties_t
ZES_STRUCTURE_TYPE_POWER_LIMIT_EXT_DESC = 0x27, ///< ::zes_power_limit_ext_desc_t
ZES_STRUCTURE_TYPE_POWER_EXT_PROPERTIES = 0x28, ///< ::zes_power_ext_properties_t
ZES_STRUCTURE_TYPE_OVERCLOCK_PROPERTIES = 0x29, ///< ::zes_overclock_properties_t
ZES_STRUCTURE_TYPE_FABRIC_PORT_ERROR_COUNTERS = 0x2a, ///< ::zes_fabric_port_error_counters_t
ZES_STRUCTURE_TYPE_ENGINE_EXT_PROPERTIES = 0x2b, ///< ::zes_engine_ext_properties_t
ZES_STRUCTURE_TYPE_RESET_PROPERTIES = 0x2c, ///< ::zes_reset_properties_t
ZES_STRUCTURE_TYPE_DEVICE_EXT_PROPERTIES = 0x2d, ///< ::zes_device_ext_properties_t
ZES_STRUCTURE_TYPE_DEVICE_UUID = 0x2e, ///< ::zes_uuid_t
ZES_STRUCTURE_TYPE_POWER_DOMAIN_EXP_PROPERTIES = 0x00020001, ///< ::zes_power_domain_exp_properties_t
ZES_STRUCTURE_TYPE_MEM_BANDWIDTH_COUNTER_BITS_EXP_PROPERTIES = 0x00020002, ///< ::zes_mem_bandwidth_counter_bits_exp_properties_t
ZES_STRUCTURE_TYPE_MEMORY_PAGE_OFFLINE_STATE_EXP = 0x00020003, ///< ::zes_mem_page_offline_state_exp_t
ZES_STRUCTURE_TYPE_SUBDEVICE_EXP_PROPERTIES = 0x00020004, ///< ::zes_subdevice_exp_properties_t
ZES_STRUCTURE_TYPE_VF_EXP_PROPERTIES = 0x00020005, ///< ::zes_vf_exp_properties_t
ZES_STRUCTURE_TYPE_VF_UTIL_MEM_EXP = 0x00020006, ///< ::zes_vf_util_mem_exp_t
ZES_STRUCTURE_TYPE_VF_UTIL_ENGINE_EXP = 0x00020007, ///< ::zes_vf_util_engine_exp_t
ZES_STRUCTURE_TYPE_VF_EXP_CAPABILITIES = 0x00020008, ///< ::zes_vf_exp_capabilities_t
ZES_STRUCTURE_TYPE_VF_UTIL_MEM_EXP2 = 0x00020009, ///< ::zes_vf_util_mem_exp2_t
ZES_STRUCTURE_TYPE_VF_UTIL_ENGINE_EXP2 = 0x00020010, ///< ::zes_vf_util_engine_exp2_t
ZES_STRUCTURE_TYPE_VF_EXP2_CAPABILITIES = 0x00020011, ///< ::zes_vf_exp2_capabilities_t
ZES_STRUCTURE_TYPE_DEVICE_ECC_DEFAULT_PROPERTIES_EXT = 0x00020012, ///< ::zes_device_ecc_default_properties_ext_t
ZES_STRUCTURE_TYPE_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_STRUCTURE_TYPE_* ENUMs
} zes_structure_type_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Base for all properties types
typedef struct _zes_base_properties_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
} zes_base_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Base for all descriptor types
typedef struct _zes_base_desc_t
{
zes_structure_type_t stype; ///< [in] type of this structure
const void* pNext; ///< [in][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
} zes_base_desc_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Base for all state types
typedef struct _zes_base_state_t
{
zes_structure_type_t stype; ///< [in] type of this structure
const void* pNext; ///< [in][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
} zes_base_state_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Base for all config types
typedef struct _zes_base_config_t
{
zes_structure_type_t stype; ///< [in] type of this structure
const void* pNext; ///< [in][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
} zes_base_config_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Base for all capability types
typedef struct _zes_base_capability_t
{
zes_structure_type_t stype; ///< [in] type of this structure
const void* pNext; ///< [in][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
} zes_base_capability_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_base_properties_t
typedef struct _zes_base_properties_t zes_base_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_base_desc_t
typedef struct _zes_base_desc_t zes_base_desc_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_base_state_t
typedef struct _zes_base_state_t zes_base_state_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_base_config_t
typedef struct _zes_base_config_t zes_base_config_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_base_capability_t
typedef struct _zes_base_capability_t zes_base_capability_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_driver_extension_properties_t
typedef struct _zes_driver_extension_properties_t zes_driver_extension_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_device_state_t
typedef struct _zes_device_state_t zes_device_state_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_reset_properties_t
typedef struct _zes_reset_properties_t zes_reset_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_uuid_t
typedef struct _zes_uuid_t zes_uuid_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_device_properties_t
typedef struct _zes_device_properties_t zes_device_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_device_ext_properties_t
typedef struct _zes_device_ext_properties_t zes_device_ext_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_process_state_t
typedef struct _zes_process_state_t zes_process_state_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_pci_address_t
typedef struct _zes_pci_address_t zes_pci_address_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_pci_speed_t
typedef struct _zes_pci_speed_t zes_pci_speed_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_pci_properties_t
typedef struct _zes_pci_properties_t zes_pci_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_pci_state_t
typedef struct _zes_pci_state_t zes_pci_state_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_pci_bar_properties_t
typedef struct _zes_pci_bar_properties_t zes_pci_bar_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_pci_bar_properties_1_2_t
typedef struct _zes_pci_bar_properties_1_2_t zes_pci_bar_properties_1_2_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_pci_stats_t
typedef struct _zes_pci_stats_t zes_pci_stats_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_overclock_properties_t
typedef struct _zes_overclock_properties_t zes_overclock_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_control_property_t
typedef struct _zes_control_property_t zes_control_property_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_vf_property_t
typedef struct _zes_vf_property_t zes_vf_property_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_diag_test_t
typedef struct _zes_diag_test_t zes_diag_test_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_diag_properties_t
typedef struct _zes_diag_properties_t zes_diag_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_device_ecc_desc_t
typedef struct _zes_device_ecc_desc_t zes_device_ecc_desc_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_device_ecc_properties_t
typedef struct _zes_device_ecc_properties_t zes_device_ecc_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_engine_properties_t
typedef struct _zes_engine_properties_t zes_engine_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_engine_stats_t
typedef struct _zes_engine_stats_t zes_engine_stats_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_fabric_port_id_t
typedef struct _zes_fabric_port_id_t zes_fabric_port_id_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_fabric_port_speed_t
typedef struct _zes_fabric_port_speed_t zes_fabric_port_speed_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_fabric_port_properties_t
typedef struct _zes_fabric_port_properties_t zes_fabric_port_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_fabric_link_type_t
typedef struct _zes_fabric_link_type_t zes_fabric_link_type_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_fabric_port_config_t
typedef struct _zes_fabric_port_config_t zes_fabric_port_config_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_fabric_port_state_t
typedef struct _zes_fabric_port_state_t zes_fabric_port_state_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_fabric_port_throughput_t
typedef struct _zes_fabric_port_throughput_t zes_fabric_port_throughput_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_fabric_port_error_counters_t
typedef struct _zes_fabric_port_error_counters_t zes_fabric_port_error_counters_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_fan_speed_t
typedef struct _zes_fan_speed_t zes_fan_speed_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_fan_temp_speed_t
typedef struct _zes_fan_temp_speed_t zes_fan_temp_speed_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_fan_speed_table_t
typedef struct _zes_fan_speed_table_t zes_fan_speed_table_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_fan_properties_t
typedef struct _zes_fan_properties_t zes_fan_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_fan_config_t
typedef struct _zes_fan_config_t zes_fan_config_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_firmware_properties_t
typedef struct _zes_firmware_properties_t zes_firmware_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_freq_properties_t
typedef struct _zes_freq_properties_t zes_freq_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_freq_range_t
typedef struct _zes_freq_range_t zes_freq_range_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_freq_state_t
typedef struct _zes_freq_state_t zes_freq_state_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_freq_throttle_time_t
typedef struct _zes_freq_throttle_time_t zes_freq_throttle_time_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_oc_capabilities_t
typedef struct _zes_oc_capabilities_t zes_oc_capabilities_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_led_properties_t
typedef struct _zes_led_properties_t zes_led_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_led_color_t
typedef struct _zes_led_color_t zes_led_color_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_led_state_t
typedef struct _zes_led_state_t zes_led_state_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_mem_properties_t
typedef struct _zes_mem_properties_t zes_mem_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_mem_state_t
typedef struct _zes_mem_state_t zes_mem_state_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_mem_bandwidth_t
typedef struct _zes_mem_bandwidth_t zes_mem_bandwidth_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_mem_ext_bandwidth_t
typedef struct _zes_mem_ext_bandwidth_t zes_mem_ext_bandwidth_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_perf_properties_t
typedef struct _zes_perf_properties_t zes_perf_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_power_properties_t
typedef struct _zes_power_properties_t zes_power_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_power_energy_counter_t
typedef struct _zes_power_energy_counter_t zes_power_energy_counter_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_power_sustained_limit_t
typedef struct _zes_power_sustained_limit_t zes_power_sustained_limit_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_power_burst_limit_t
typedef struct _zes_power_burst_limit_t zes_power_burst_limit_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_power_peak_limit_t
typedef struct _zes_power_peak_limit_t zes_power_peak_limit_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_energy_threshold_t
typedef struct _zes_energy_threshold_t zes_energy_threshold_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_psu_properties_t
typedef struct _zes_psu_properties_t zes_psu_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_psu_state_t
typedef struct _zes_psu_state_t zes_psu_state_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_ras_properties_t
typedef struct _zes_ras_properties_t zes_ras_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_ras_state_t
typedef struct _zes_ras_state_t zes_ras_state_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_ras_config_t
typedef struct _zes_ras_config_t zes_ras_config_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_sched_properties_t
typedef struct _zes_sched_properties_t zes_sched_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_sched_timeout_properties_t
typedef struct _zes_sched_timeout_properties_t zes_sched_timeout_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_sched_timeslice_properties_t
typedef struct _zes_sched_timeslice_properties_t zes_sched_timeslice_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_standby_properties_t
typedef struct _zes_standby_properties_t zes_standby_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_temp_properties_t
typedef struct _zes_temp_properties_t zes_temp_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_temp_threshold_t
typedef struct _zes_temp_threshold_t zes_temp_threshold_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_temp_config_t
typedef struct _zes_temp_config_t zes_temp_config_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_device_ecc_default_properties_ext_t
typedef struct _zes_device_ecc_default_properties_ext_t zes_device_ecc_default_properties_ext_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_power_limit_ext_desc_t
typedef struct _zes_power_limit_ext_desc_t zes_power_limit_ext_desc_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_power_ext_properties_t
typedef struct _zes_power_ext_properties_t zes_power_ext_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_engine_ext_properties_t
typedef struct _zes_engine_ext_properties_t zes_engine_ext_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_ras_state_exp_t
typedef struct _zes_ras_state_exp_t zes_ras_state_exp_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_mem_page_offline_state_exp_t
typedef struct _zes_mem_page_offline_state_exp_t zes_mem_page_offline_state_exp_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_mem_bandwidth_counter_bits_exp_properties_t
typedef struct _zes_mem_bandwidth_counter_bits_exp_properties_t zes_mem_bandwidth_counter_bits_exp_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_power_domain_exp_properties_t
typedef struct _zes_power_domain_exp_properties_t zes_power_domain_exp_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_subdevice_exp_properties_t
typedef struct _zes_subdevice_exp_properties_t zes_subdevice_exp_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_vf_exp_properties_t
typedef struct _zes_vf_exp_properties_t zes_vf_exp_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_vf_util_mem_exp_t
typedef struct _zes_vf_util_mem_exp_t zes_vf_util_mem_exp_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_vf_util_engine_exp_t
typedef struct _zes_vf_util_engine_exp_t zes_vf_util_engine_exp_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_vf_exp_capabilities_t
typedef struct _zes_vf_exp_capabilities_t zes_vf_exp_capabilities_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_vf_exp2_capabilities_t
typedef struct _zes_vf_exp2_capabilities_t zes_vf_exp2_capabilities_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_vf_util_mem_exp2_t
typedef struct _zes_vf_util_mem_exp2_t zes_vf_util_mem_exp2_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Forward-declare zes_vf_util_engine_exp2_t
typedef struct _zes_vf_util_engine_exp2_t zes_vf_util_engine_exp2_t;
#if !defined(__GNUC__)
#pragma endregion
#endif
// Intel 'oneAPI' Level-Zero Tool APIs for System Resource Management (Sysman)
#if !defined(__GNUC__)
#pragma region driver
#endif
///////////////////////////////////////////////////////////////////////////////
/// @brief Supported sysman initialization flags
typedef uint32_t zes_init_flags_t;
typedef enum _zes_init_flag_t
{
ZES_INIT_FLAG_PLACEHOLDER = ZE_BIT(0), ///< placeholder for future use
ZES_INIT_FLAG_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_INIT_FLAG_* ENUMs
} zes_init_flag_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Initialize 'oneAPI' System Resource Management (sysman)
///
/// @details
/// - The application must call this function or ::zeInit with the
/// ::ZES_ENABLE_SYSMAN environment variable set before calling any other
/// sysman function.
/// - If this function is not called then all other sysman functions will
/// return ::ZE_RESULT_ERROR_UNINITIALIZED.
/// - This function will only initialize sysman. To initialize other
/// functions, call ::zeInit.
/// - There is no requirement to call this function before or after
/// ::zeInit.
/// - Only one instance of sysman will be initialized per process.
/// - The application must call this function after forking new processes.
/// Each forked process must call this function.
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function must be thread-safe for scenarios
/// where multiple libraries may initialize sysman simultaneously.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_ENUMERATION
/// + `0x1 < flags`
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
ZE_APIEXPORT ze_result_t ZE_APICALL
zesInit(
zes_init_flags_t flags ///< [in] initialization flags.
///< currently unused, must be 0 (default).
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Retrieves sysman driver instances
///
/// @details
/// - A sysman driver represents a collection of physical devices.
/// - Multiple calls to this function will return identical sysman driver
/// handles, in the same order.
/// - The application may pass nullptr for pDrivers when only querying the
/// number of sysman drivers.
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDriverGet(
uint32_t* pCount, ///< [in,out] pointer to the number of sysman driver instances.
///< if count is zero, then the loader shall update the value with the
///< total number of sysman drivers available.
///< if count is greater than the number of sysman drivers available, then
///< the loader shall update the value with the correct number of sysman
///< drivers available.
zes_driver_handle_t* phDrivers ///< [in,out][optional][range(0, *pCount)] array of sysman driver instance handles.
///< if count is less than the number of sysman drivers available, then the
///< loader shall only retrieve that number of sysman drivers.
);
///////////////////////////////////////////////////////////////////////////////
#ifndef ZES_MAX_EXTENSION_NAME
/// @brief Maximum extension name string size
#define ZES_MAX_EXTENSION_NAME 256
#endif // ZES_MAX_EXTENSION_NAME
///////////////////////////////////////////////////////////////////////////////
/// @brief Extension properties queried using ::zesDriverGetExtensionProperties
typedef struct _zes_driver_extension_properties_t
{
char name[ZES_MAX_EXTENSION_NAME]; ///< [out] extension name
uint32_t version; ///< [out] extension version using ::ZE_MAKE_VERSION
} zes_driver_extension_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Retrieves extension properties
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDriver`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDriverGetExtensionProperties(
zes_driver_handle_t hDriver, ///< [in] handle of the driver instance
uint32_t* pCount, ///< [in,out] pointer to the number of extension properties.
///< if count is zero, then the driver shall update the value with the
///< total number of extension properties available.
///< if count is greater than the number of extension properties available,
///< then the driver shall update the value with the correct number of
///< extension properties available.
zes_driver_extension_properties_t* pExtensionProperties ///< [in,out][optional][range(0, *pCount)] array of query results for
///< extension properties.
///< if count is less than the number of extension properties available,
///< then driver shall only retrieve that number of extension properties.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Retrieves function pointer for vendor-specific or experimental
/// extensions
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDriver`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == name`
/// + `nullptr == ppFunctionAddress`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDriverGetExtensionFunctionAddress(
zes_driver_handle_t hDriver, ///< [in] handle of the driver instance
const char* name, ///< [in] extension function name
void** ppFunctionAddress ///< [out] pointer to function pointer
);
#if !defined(__GNUC__)
#pragma endregion
#endif
// Intel 'oneAPI' Level-Zero Tool APIs for System Resource Management (Sysman) - Device management
#if !defined(__GNUC__)
#pragma region device
#endif
///////////////////////////////////////////////////////////////////////////////
/// @brief Retrieves sysman devices within a sysman driver
///
/// @details
/// - Multiple calls to this function will return identical sysman device
/// handles, in the same order.
/// - The number and order of handles returned from this function is NOT
/// affected by the ::ZE_AFFINITY_MASK, ::ZE_ENABLE_PCI_ID_DEVICE_ORDER,
/// or ::ZE_FLAT_DEVICE_HIERARCHY environment variables.
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDriver`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceGet(
zes_driver_handle_t hDriver, ///< [in] handle of the sysman driver instance
uint32_t* pCount, ///< [in,out] pointer to the number of sysman devices.
///< if count is zero, then the driver shall update the value with the
///< total number of sysman devices available.
///< if count is greater than the number of sysman devices available, then
///< the driver shall update the value with the correct number of sysman
///< devices available.
zes_device_handle_t* phDevices ///< [in,out][optional][range(0, *pCount)] array of handle of sysman devices.
///< if count is less than the number of sysman devices available, then
///< driver shall only retrieve that number of sysman devices.
);
///////////////////////////////////////////////////////////////////////////////
#ifndef ZES_STRING_PROPERTY_SIZE
/// @brief Maximum number of characters in string properties.
#define ZES_STRING_PROPERTY_SIZE 64
#endif // ZES_STRING_PROPERTY_SIZE
///////////////////////////////////////////////////////////////////////////////
#ifndef ZES_MAX_UUID_SIZE
/// @brief Maximum device universal unique id (UUID) size in bytes.
#define ZES_MAX_UUID_SIZE 16
#endif // ZES_MAX_UUID_SIZE
///////////////////////////////////////////////////////////////////////////////
/// @brief Types of accelerator engines
typedef uint32_t zes_engine_type_flags_t;
typedef enum _zes_engine_type_flag_t
{
ZES_ENGINE_TYPE_FLAG_OTHER = ZE_BIT(0), ///< Undefined types of accelerators.
ZES_ENGINE_TYPE_FLAG_COMPUTE = ZE_BIT(1), ///< Engines that process compute kernels only (no 3D content).
ZES_ENGINE_TYPE_FLAG_3D = ZE_BIT(2), ///< Engines that process 3D content only (no compute kernels).
ZES_ENGINE_TYPE_FLAG_MEDIA = ZE_BIT(3), ///< Engines that process media workloads.
ZES_ENGINE_TYPE_FLAG_DMA = ZE_BIT(4), ///< Engines that copy blocks of data.
ZES_ENGINE_TYPE_FLAG_RENDER = ZE_BIT(5), ///< Engines that can process both 3D content and compute kernels.
ZES_ENGINE_TYPE_FLAG_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_ENGINE_TYPE_FLAG_* ENUMs
} zes_engine_type_flag_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Device repair status
typedef enum _zes_repair_status_t
{
ZES_REPAIR_STATUS_UNSUPPORTED = 0, ///< The device does not support in-field repairs.
ZES_REPAIR_STATUS_NOT_PERFORMED = 1, ///< The device has never been repaired.
ZES_REPAIR_STATUS_PERFORMED = 2, ///< The device has been repaired.
ZES_REPAIR_STATUS_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_REPAIR_STATUS_* ENUMs
} zes_repair_status_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Device reset reasons
typedef uint32_t zes_reset_reason_flags_t;
typedef enum _zes_reset_reason_flag_t
{
ZES_RESET_REASON_FLAG_WEDGED = ZE_BIT(0), ///< The device needs to be reset because one or more parts of the hardware
///< is wedged
ZES_RESET_REASON_FLAG_REPAIR = ZE_BIT(1), ///< The device needs to be reset in order to complete in-field repairs
ZES_RESET_REASON_FLAG_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_RESET_REASON_FLAG_* ENUMs
} zes_reset_reason_flag_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Device reset type
typedef enum _zes_reset_type_t
{
ZES_RESET_TYPE_WARM = 0, ///< Apply warm reset
ZES_RESET_TYPE_COLD = 1, ///< Apply cold reset
ZES_RESET_TYPE_FLR = 2, ///< Apply FLR reset
ZES_RESET_TYPE_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_RESET_TYPE_* ENUMs
} zes_reset_type_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Device state
typedef struct _zes_device_state_t
{
zes_structure_type_t stype; ///< [in] type of this structure
const void* pNext; ///< [in][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
zes_reset_reason_flags_t reset; ///< [out] Indicates if the device needs to be reset and for what reasons.
///< returns 0 (none) or combination of ::zes_reset_reason_flag_t
zes_repair_status_t repaired; ///< [out] Indicates if the device has been repaired
} zes_device_state_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Device reset properties
typedef struct _zes_reset_properties_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
ze_bool_t force; ///< [in] If set to true, all applications that are currently using the
///< device will be forcibly killed.
zes_reset_type_t resetType; ///< [in] Type of reset needs to be performed
} zes_reset_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Device universal unique id (UUID)
typedef struct _zes_uuid_t
{
uint8_t id[ZES_MAX_UUID_SIZE]; ///< [out] opaque data representing a device UUID
} zes_uuid_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Supported device types
typedef enum _zes_device_type_t
{
ZES_DEVICE_TYPE_GPU = 1, ///< Graphics Processing Unit
ZES_DEVICE_TYPE_CPU = 2, ///< Central Processing Unit
ZES_DEVICE_TYPE_FPGA = 3, ///< Field Programmable Gate Array
ZES_DEVICE_TYPE_MCA = 4, ///< Memory Copy Accelerator
ZES_DEVICE_TYPE_VPU = 5, ///< Vision Processing Unit
ZES_DEVICE_TYPE_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_DEVICE_TYPE_* ENUMs
} zes_device_type_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Supported device property flags
typedef uint32_t zes_device_property_flags_t;
typedef enum _zes_device_property_flag_t
{
ZES_DEVICE_PROPERTY_FLAG_INTEGRATED = ZE_BIT(0), ///< Device is integrated with the Host.
ZES_DEVICE_PROPERTY_FLAG_SUBDEVICE = ZE_BIT(1), ///< Device handle used for query represents a sub-device.
ZES_DEVICE_PROPERTY_FLAG_ECC = ZE_BIT(2), ///< Device supports error correction memory access.
ZES_DEVICE_PROPERTY_FLAG_ONDEMANDPAGING = ZE_BIT(3), ///< Device supports on-demand page-faulting.
ZES_DEVICE_PROPERTY_FLAG_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_DEVICE_PROPERTY_FLAG_* ENUMs
} zes_device_property_flag_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Device properties
typedef struct _zes_device_properties_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
ze_device_properties_t core; ///< [out] (Deprecated, use ::zes_uuid_t in the extended structure) Core
///< device properties
uint32_t numSubdevices; ///< [out] Number of sub-devices. A value of 0 indicates that this device
///< doesn't have sub-devices.
char serialNumber[ZES_STRING_PROPERTY_SIZE]; ///< [out] Manufacturing serial number (NULL terminated string value). This
///< value is intended to reflect the Part ID/SoC ID assigned by
///< manufacturer that is unique for a SoC. Will be set to the string
///< "unknown" if this cannot be determined for the device.
char boardNumber[ZES_STRING_PROPERTY_SIZE]; ///< [out] Manufacturing board number (NULL terminated string value).
///< Alternatively "boardSerialNumber", this value is intended to reflect
///< the string printed on board label by manufacturer. Will be set to the
///< string "unknown" if this cannot be determined for the device.
char brandName[ZES_STRING_PROPERTY_SIZE]; ///< [out] Brand name of the device (NULL terminated string value). Will be
///< set to the string "unknown" if this cannot be determined for the
///< device.
char modelName[ZES_STRING_PROPERTY_SIZE]; ///< [out] Model name of the device (NULL terminated string value). Will be
///< set to the string "unknown" if this cannot be determined for the
///< device.
char vendorName[ZES_STRING_PROPERTY_SIZE]; ///< [out] Vendor name of the device (NULL terminated string value). Will
///< be set to the string "unknown" if this cannot be determined for the
///< device.
char driverVersion[ZES_STRING_PROPERTY_SIZE]; ///< [out] Installed driver version (NULL terminated string value). Will be
///< set to the string "unknown" if this cannot be determined for the
///< device.
} zes_device_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Device properties
typedef struct _zes_device_ext_properties_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
zes_uuid_t uuid; ///< [out] universal unique identifier. Note: uuid obtained from Sysman API
///< is the same as from core API. Subdevices will have their own uuid.
zes_device_type_t type; ///< [out] generic device type
zes_device_property_flags_t flags; ///< [out] 0 (none) or a valid combination of ::zes_device_property_flag_t
} zes_device_ext_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Get properties about the device
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pProperties`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceGetProperties(
zes_device_handle_t hDevice, ///< [in] Sysman handle of the device.
zes_device_properties_t* pProperties ///< [in,out] Structure that will contain information about the device.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get information about the state of the device - if a reset is
/// required, reasons for the reset and if the device has been repaired
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pState`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceGetState(
zes_device_handle_t hDevice, ///< [in] Sysman handle of the device.
zes_device_state_t* pState ///< [in,out] Structure that will contain information about the device.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Reset device
///
/// @details
/// - Performs a PCI bus reset of the device. This will result in all
/// current device state being lost.
/// - All applications using the device should be stopped before calling
/// this function.
/// - If the force argument is specified, all applications using the device
/// will be forcibly killed.
/// - The function will block until the device has restarted or an
/// implementation defined timeout occurred waiting for the reset to
/// complete.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to perform this operation.
/// - ::ZE_RESULT_ERROR_HANDLE_OBJECT_IN_USE
/// + Reset cannot be performed because applications are using this device.
/// - ::ZE_RESULT_ERROR_UNKNOWN
/// + There were problems unloading the device driver, performing a bus reset or reloading the device driver.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceReset(
zes_device_handle_t hDevice, ///< [in] Sysman handle for the device
ze_bool_t force ///< [in] If set to true, all applications that are currently using the
///< device will be forcibly killed.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Reset device extension
///
/// @details
/// - Performs a PCI bus reset of the device. This will result in all
/// current device state being lost.
/// - Prior to calling this function, user is responsible for closing
/// applications using the device unless force argument is specified.
/// - If the force argument is specified, all applications using the device
/// will be forcibly killed.
/// - The function will block until the device has restarted or a
/// implementation specific timeout occurred waiting for the reset to
/// complete.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pProperties`
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to perform this operation.
/// - ::ZE_RESULT_ERROR_HANDLE_OBJECT_IN_USE
/// + Reset cannot be performed because applications are using this device.
/// - ::ZE_RESULT_ERROR_UNKNOWN
/// + There were problems unloading the device driver, performing a bus reset or reloading the device driver.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceResetExt(
zes_device_handle_t hDevice, ///< [in] Sysman handle for the device
zes_reset_properties_t* pProperties ///< [in] Device reset properties to apply
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Contains information about a process that has an open connection with
/// this device
///
/// @details
/// - The application can use the process ID to query the OS for the owner
/// and the path to the executable.
typedef struct _zes_process_state_t
{
zes_structure_type_t stype; ///< [in] type of this structure
const void* pNext; ///< [in][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
uint32_t processId; ///< [out] Host OS process ID.
uint64_t memSize; ///< [out] Device memory size in bytes allocated by this process (may not
///< necessarily be resident on the device at the time of reading).
uint64_t sharedSize; ///< [out] The size of shared device memory mapped into this process (may
///< not necessarily be resident on the device at the time of reading).
zes_engine_type_flags_t engines; ///< [out] Bitfield of accelerator engine types being used by this process.
} zes_process_state_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Get information about host processes using the device
///
/// @details
/// - The number of processes connected to the device is dynamic. This means
/// that between a call to determine the value of pCount and the
/// subsequent call, the number of processes may have increased or
/// decreased. It is recommended that a large array be passed in so as to
/// avoid receiving the error ::ZE_RESULT_ERROR_INVALID_SIZE. Also, always
/// check the returned value in pCount since it may be less than the
/// earlier call to get the required array size.
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
/// - ::ZE_RESULT_ERROR_INVALID_SIZE
/// + The provided value of pCount is not big enough to store information about all the processes currently attached to the device.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceProcessesGetState(
zes_device_handle_t hDevice, ///< [in] Sysman handle for the device
uint32_t* pCount, ///< [in,out] pointer to the number of processes.
///< if count is zero, then the driver shall update the value with the
///< total number of processes currently attached to the device.
///< if count is greater than the number of processes currently attached to
///< the device, then the driver shall update the value with the correct
///< number of processes.
zes_process_state_t* pProcesses ///< [in,out][optional][range(0, *pCount)] array of process information.
///< if count is less than the number of processes currently attached to
///< the device, then the driver shall only retrieve information about that
///< number of processes. In this case, the return code will ::ZE_RESULT_ERROR_INVALID_SIZE.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief PCI address
typedef struct _zes_pci_address_t
{
uint32_t domain; ///< [out] BDF domain
uint32_t bus; ///< [out] BDF bus
uint32_t device; ///< [out] BDF device
uint32_t function; ///< [out] BDF function
} zes_pci_address_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief PCI speed
typedef struct _zes_pci_speed_t
{
int32_t gen; ///< [out] The link generation. A value of -1 means that this property is
///< unknown.
int32_t width; ///< [out] The number of lanes. A value of -1 means that this property is
///< unknown.
int64_t maxBandwidth; ///< [out] The maximum bandwidth in bytes/sec (sum of all lanes). A value
///< of -1 means that this property is unknown.
} zes_pci_speed_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Static PCI properties
typedef struct _zes_pci_properties_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
zes_pci_address_t address; ///< [out] The BDF address
zes_pci_speed_t maxSpeed; ///< [out] Fastest port configuration supported by the device (sum of all
///< lanes)
ze_bool_t haveBandwidthCounters; ///< [out] Indicates whether the `rxCounter` and `txCounter` members of
///< ::zes_pci_stats_t will have valid values
ze_bool_t havePacketCounters; ///< [out] Indicates whether the `packetCounter` member of
///< ::zes_pci_stats_t will have a valid value
ze_bool_t haveReplayCounters; ///< [out] Indicates whether the `replayCounter` member of
///< ::zes_pci_stats_t will have a valid value
} zes_pci_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief PCI link status
typedef enum _zes_pci_link_status_t
{
ZES_PCI_LINK_STATUS_UNKNOWN = 0, ///< The link status could not be determined
ZES_PCI_LINK_STATUS_GOOD = 1, ///< The link is up and operating as expected
ZES_PCI_LINK_STATUS_QUALITY_ISSUES = 2, ///< The link is up but has quality and/or bandwidth degradation
ZES_PCI_LINK_STATUS_STABILITY_ISSUES = 3, ///< The link has stability issues and preventing workloads making forward
///< progress
ZES_PCI_LINK_STATUS_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_PCI_LINK_STATUS_* ENUMs
} zes_pci_link_status_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief PCI link quality degradation reasons
typedef uint32_t zes_pci_link_qual_issue_flags_t;
typedef enum _zes_pci_link_qual_issue_flag_t
{
ZES_PCI_LINK_QUAL_ISSUE_FLAG_REPLAYS = ZE_BIT(0), ///< A significant number of replays are occurring
ZES_PCI_LINK_QUAL_ISSUE_FLAG_SPEED = ZE_BIT(1), ///< There is a degradation in the maximum bandwidth of the link
ZES_PCI_LINK_QUAL_ISSUE_FLAG_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_PCI_LINK_QUAL_ISSUE_FLAG_* ENUMs
} zes_pci_link_qual_issue_flag_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief PCI link stability issues
typedef uint32_t zes_pci_link_stab_issue_flags_t;
typedef enum _zes_pci_link_stab_issue_flag_t
{
ZES_PCI_LINK_STAB_ISSUE_FLAG_RETRAINING = ZE_BIT(0), ///< Link retraining has occurred to deal with quality issues
ZES_PCI_LINK_STAB_ISSUE_FLAG_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_PCI_LINK_STAB_ISSUE_FLAG_* ENUMs
} zes_pci_link_stab_issue_flag_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Dynamic PCI state
typedef struct _zes_pci_state_t
{
zes_structure_type_t stype; ///< [in] type of this structure
const void* pNext; ///< [in][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
zes_pci_link_status_t status; ///< [out] The current status of the port
zes_pci_link_qual_issue_flags_t qualityIssues; ///< [out] If status is ::ZES_PCI_LINK_STATUS_QUALITY_ISSUES,
///< then this gives a combination of ::zes_pci_link_qual_issue_flag_t for
///< quality issues that have been detected;
///< otherwise, 0 indicates there are no quality issues with the link at
///< this time."
zes_pci_link_stab_issue_flags_t stabilityIssues; ///< [out] If status is ::ZES_PCI_LINK_STATUS_STABILITY_ISSUES,
///< then this gives a combination of ::zes_pci_link_stab_issue_flag_t for
///< reasons for the connection instability;
///< otherwise, 0 indicates there are no connection stability issues at
///< this time."
zes_pci_speed_t speed; ///< [out] The current port configure speed
} zes_pci_state_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief PCI bar types
typedef enum _zes_pci_bar_type_t
{
ZES_PCI_BAR_TYPE_MMIO = 0, ///< MMIO registers
ZES_PCI_BAR_TYPE_ROM = 1, ///< ROM aperture
ZES_PCI_BAR_TYPE_MEM = 2, ///< Device memory
ZES_PCI_BAR_TYPE_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_PCI_BAR_TYPE_* ENUMs
} zes_pci_bar_type_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Properties of a pci bar
typedef struct _zes_pci_bar_properties_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
zes_pci_bar_type_t type; ///< [out] The type of bar
uint32_t index; ///< [out] The index of the bar
uint64_t base; ///< [out] Base address of the bar.
uint64_t size; ///< [out] Size of the bar.
} zes_pci_bar_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Properties of a pci bar, including the resizable bar.
typedef struct _zes_pci_bar_properties_1_2_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
zes_pci_bar_type_t type; ///< [out] The type of bar
uint32_t index; ///< [out] The index of the bar
uint64_t base; ///< [out] Base address of the bar.
uint64_t size; ///< [out] Size of the bar.
ze_bool_t resizableBarSupported; ///< [out] Support for Resizable Bar on this device.
ze_bool_t resizableBarEnabled; ///< [out] Resizable Bar enabled on this device
} zes_pci_bar_properties_1_2_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief PCI stats counters
///
/// @details
/// - Percent replays is calculated by taking two snapshots (s1, s2) and
/// using the equation: %replay = 10^6 * (s2.replayCounter -
/// s1.replayCounter) / (s2.maxBandwidth * (s2.timestamp - s1.timestamp))
/// - Percent throughput is calculated by taking two snapshots (s1, s2) and
/// using the equation: %bw = 10^6 * ((s2.rxCounter - s1.rxCounter) +
/// (s2.txCounter - s1.txCounter)) / (s2.maxBandwidth * (s2.timestamp -
/// s1.timestamp))
typedef struct _zes_pci_stats_t
{
uint64_t timestamp; ///< [out] Monotonic timestamp counter in microseconds when the measurement
///< was made.
///< This timestamp should only be used to calculate delta time between
///< snapshots of this structure.
///< Never take the delta of this timestamp with the timestamp from a
///< different structure since they are not guaranteed to have the same base.
///< The absolute value of the timestamp is only valid during within the
///< application and may be different on the next execution.
uint64_t replayCounter; ///< [out] Monotonic counter for the number of replay packets (sum of all
///< lanes). Will always be 0 when the `haveReplayCounters` member of
///< ::zes_pci_properties_t is FALSE.
uint64_t packetCounter; ///< [out] Monotonic counter for the number of packets (sum of all lanes).
///< Will always be 0 when the `havePacketCounters` member of
///< ::zes_pci_properties_t is FALSE.
uint64_t rxCounter; ///< [out] Monotonic counter for the number of bytes received (sum of all
///< lanes). Will always be 0 when the `haveBandwidthCounters` member of
///< ::zes_pci_properties_t is FALSE.
uint64_t txCounter; ///< [out] Monotonic counter for the number of bytes transmitted (including
///< replays) (sum of all lanes). Will always be 0 when the
///< `haveBandwidthCounters` member of ::zes_pci_properties_t is FALSE.
zes_pci_speed_t speed; ///< [out] The current speed of the link (sum of all lanes)
} zes_pci_stats_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Get PCI properties - address, max speed
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pProperties`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDevicePciGetProperties(
zes_device_handle_t hDevice, ///< [in] Sysman handle of the device.
zes_pci_properties_t* pProperties ///< [in,out] Will contain the PCI properties.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get current PCI state - current speed
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pState`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDevicePciGetState(
zes_device_handle_t hDevice, ///< [in] Sysman handle of the device.
zes_pci_state_t* pState ///< [in,out] Will contain the PCI properties.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get information about each configured bar
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDevicePciGetBars(
zes_device_handle_t hDevice, ///< [in] Sysman handle of the device.
uint32_t* pCount, ///< [in,out] pointer to the number of PCI bars.
///< if count is zero, then the driver shall update the value with the
///< total number of PCI bars that are setup.
///< if count is greater than the number of PCI bars that are setup, then
///< the driver shall update the value with the correct number of PCI bars.
zes_pci_bar_properties_t* pProperties ///< [in,out][optional][range(0, *pCount)] array of information about setup
///< PCI bars.
///< if count is less than the number of PCI bars that are setup, then the
///< driver shall only retrieve information about that number of PCI bars.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get PCI stats - bandwidth, number of packets, number of replays
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pStats`
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to query this telemetry.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDevicePciGetStats(
zes_device_handle_t hDevice, ///< [in] Sysman handle of the device.
zes_pci_stats_t* pStats ///< [in,out] Will contain a snapshot of the latest stats.
);
#if !defined(__GNUC__)
#pragma endregion
#endif
// Intel 'oneAPI' Level-Zero Tool APIs for System Resource Management (Sysman) - Overclock controls, VF curve manipulation
#if !defined(__GNUC__)
#pragma region Overclock
#endif
///////////////////////////////////////////////////////////////////////////////
/// @brief Overclock domains.
typedef enum _zes_overclock_domain_t
{
ZES_OVERCLOCK_DOMAIN_CARD = 1, ///< Overclocking card level properties such as temperature limits.
ZES_OVERCLOCK_DOMAIN_PACKAGE = 2, ///< Overclocking package level properties such as power limits.
ZES_OVERCLOCK_DOMAIN_GPU_ALL = 4, ///< Overclocking a GPU that has all accelerator assets on the same PLL/VR.
ZES_OVERCLOCK_DOMAIN_GPU_RENDER_COMPUTE = 8, ///< Overclocking a GPU with render and compute assets on the same PLL/VR.
ZES_OVERCLOCK_DOMAIN_GPU_RENDER = 16, ///< Overclocking a GPU with render assets on its own PLL/VR.
ZES_OVERCLOCK_DOMAIN_GPU_COMPUTE = 32, ///< Overclocking a GPU with compute assets on its own PLL/VR.
ZES_OVERCLOCK_DOMAIN_GPU_MEDIA = 64, ///< Overclocking a GPU with media assets on its own PLL/VR.
ZES_OVERCLOCK_DOMAIN_VRAM = 128, ///< Overclocking device local memory.
ZES_OVERCLOCK_DOMAIN_ADM = 256, ///< Overclocking LLC/L4 cache.
ZES_OVERCLOCK_DOMAIN_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_OVERCLOCK_DOMAIN_* ENUMs
} zes_overclock_domain_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Overclock controls.
typedef enum _zes_overclock_control_t
{
ZES_OVERCLOCK_CONTROL_VF = 1, ///< This control permits setting a custom V-F curve.
ZES_OVERCLOCK_CONTROL_FREQ_OFFSET = 2, ///< The V-F curve of the overclock domain can be shifted up or down using
///< this control.
ZES_OVERCLOCK_CONTROL_VMAX_OFFSET = 4, ///< This control is used to increase the permitted voltage above the
///< shipped voltage maximum.
ZES_OVERCLOCK_CONTROL_FREQ = 8, ///< This control permits direct changes to the operating frequency.
ZES_OVERCLOCK_CONTROL_VOLT_LIMIT = 16, ///< This control prevents frequencies that would push the voltage above
///< this value, typically used by V-F scanners.
ZES_OVERCLOCK_CONTROL_POWER_SUSTAINED_LIMIT = 32, ///< This control changes the sustained power limit (PL1).
ZES_OVERCLOCK_CONTROL_POWER_BURST_LIMIT = 64, ///< This control changes the burst power limit (PL2).
ZES_OVERCLOCK_CONTROL_POWER_PEAK_LIMIT = 128, ///< his control changes the peak power limit (PL4).
ZES_OVERCLOCK_CONTROL_ICCMAX_LIMIT = 256, ///< This control changes the value of IccMax..
ZES_OVERCLOCK_CONTROL_TEMP_LIMIT = 512, ///< This control changes the value of TjMax.
ZES_OVERCLOCK_CONTROL_ITD_DISABLE = 1024, ///< This control permits disabling the adaptive voltage feature ITD
ZES_OVERCLOCK_CONTROL_ACM_DISABLE = 2048, ///< This control permits disabling the adaptive voltage feature ACM.
ZES_OVERCLOCK_CONTROL_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_OVERCLOCK_CONTROL_* ENUMs
} zes_overclock_control_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Overclock modes.
typedef enum _zes_overclock_mode_t
{
ZES_OVERCLOCK_MODE_MODE_OFF = 0, ///< Overclock mode is off
ZES_OVERCLOCK_MODE_MODE_STOCK = 2, ///< Stock (manufacturing settings) are being used.
ZES_OVERCLOCK_MODE_MODE_ON = 3, ///< Overclock mode is on.
ZES_OVERCLOCK_MODE_MODE_UNAVAILABLE = 4, ///< Overclocking is unavailable at this time since the system is running
///< on battery.
ZES_OVERCLOCK_MODE_MODE_DISABLED = 5, ///< Overclock mode is disabled.
ZES_OVERCLOCK_MODE_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_OVERCLOCK_MODE_* ENUMs
} zes_overclock_mode_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Overclock control states.
typedef enum _zes_control_state_t
{
ZES_CONTROL_STATE_STATE_UNSET = 0, ///< No overclock control has not been changed by the driver since the last
///< boot/reset.
ZES_CONTROL_STATE_STATE_ACTIVE = 2, ///< The overclock control has been set and it is active.
ZES_CONTROL_STATE_STATE_DISABLED = 3, ///< The overclock control value has been disabled due to the current power
///< configuration (typically when running on DC).
ZES_CONTROL_STATE_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_CONTROL_STATE_* ENUMs
} zes_control_state_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Overclock pending actions.
typedef enum _zes_pending_action_t
{
ZES_PENDING_ACTION_PENDING_NONE = 0, ///< There no pending actions. .
ZES_PENDING_ACTION_PENDING_IMMINENT = 1, ///< The requested change is in progress and should complete soon.
ZES_PENDING_ACTION_PENDING_COLD_RESET = 2, ///< The requested change requires a device cold reset (hotplug, system
///< boot).
ZES_PENDING_ACTION_PENDING_WARM_RESET = 3, ///< The requested change requires a device warm reset (PCIe FLR).
ZES_PENDING_ACTION_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_PENDING_ACTION_* ENUMs
} zes_pending_action_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Overclock V-F curve programing.
typedef enum _zes_vf_program_type_t
{
ZES_VF_PROGRAM_TYPE_VF_ARBITRARY = 0, ///< Can program an arbitrary number of V-F points up to the maximum number
///< and each point can have arbitrary voltage and frequency values within
///< the min/max/step limits
ZES_VF_PROGRAM_TYPE_VF_FREQ_FIXED = 1, ///< Can only program the voltage for the V-F points that it reads back -
///< the frequency of those points cannot be changed
ZES_VF_PROGRAM_TYPE_VF_VOLT_FIXED = 2, ///< Can only program the frequency for the V-F points that is reads back -
///< the voltage of each point cannot be changed.
ZES_VF_PROGRAM_TYPE_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_VF_PROGRAM_TYPE_* ENUMs
} zes_vf_program_type_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief VF type
typedef enum _zes_vf_type_t
{
ZES_VF_TYPE_VOLT = 0, ///< VF Voltage point
ZES_VF_TYPE_FREQ = 1, ///< VF Frequency point
ZES_VF_TYPE_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_VF_TYPE_* ENUMs
} zes_vf_type_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief VF type
typedef enum _zes_vf_array_type_t
{
ZES_VF_ARRAY_TYPE_USER_VF_ARRAY = 0, ///< User V-F array
ZES_VF_ARRAY_TYPE_DEFAULT_VF_ARRAY = 1, ///< Default V-F array
ZES_VF_ARRAY_TYPE_LIVE_VF_ARRAY = 2, ///< Live V-F array
ZES_VF_ARRAY_TYPE_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_VF_ARRAY_TYPE_* ENUMs
} zes_vf_array_type_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Overclock properties
///
/// @details
/// - Information on the overclock domain type and all the contols that are
/// part of the domain.
typedef struct _zes_overclock_properties_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
zes_overclock_domain_t domainType; ///< [out] The hardware block that this overclock domain controls (GPU,
///< VRAM, ...)
uint32_t AvailableControls; ///< [out] Returns the overclock controls that are supported (a bit for
///< each of enum ::zes_overclock_control_t). If no bits are set, the
///< domain doesn't support overclocking.
zes_vf_program_type_t VFProgramType; ///< [out] Type of V-F curve programming that is permitted:.
uint32_t NumberOfVFPoints; ///< [out] Number of VF points that can be programmed - max_num_points
} zes_overclock_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Overclock Control properties
///
/// @details
/// - Provides all the control capabilities supported by the device for the
/// overclock domain.
typedef struct _zes_control_property_t
{
double MinValue; ///< [out] This provides information about the limits of the control value
///< so that the driver can calculate the set of valid values.
double MaxValue; ///< [out] This provides information about the limits of the control value
///< so that the driver can calculate the set of valid values.
double StepValue; ///< [out] This provides information about the limits of the control value
///< so that the driver can calculate the set of valid values.
double RefValue; ///< [out] The reference value provides the anchor point, UIs can combine
///< this with the user offset request to show the anticipated improvement.
double DefaultValue; ///< [out] The shipped out-of-box position of this control. Driver can
///< request this value at any time to return to the out-of-box behavior.
} zes_control_property_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Overclock VF properties
///
/// @details
/// - Provides all the VF capabilities supported by the device for the
/// overclock domain.
typedef struct _zes_vf_property_t
{
double MinFreq; ///< [out] Read the minimum frequency that can be be programmed in the
///< custom V-F point..
double MaxFreq; ///< [out] Read the maximum frequency that can be be programmed in the
///< custom V-F point..
double StepFreq; ///< [out] Read the frequency step that can be be programmed in the custom
///< V-F point..
double MinVolt; ///< [out] Read the minimum voltage that can be be programmed in the custom
///< V-F point..
double MaxVolt; ///< [out] Read the maximum voltage that can be be programmed in the custom
///< V-F point..
double StepVolt; ///< [out] Read the voltage step that can be be programmed in the custom
///< V-F point.
} zes_vf_property_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Set the overclock waiver.The overclock waiver setting is persistent
/// until the next pcode boot
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + This product does not support overclocking
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceSetOverclockWaiver(
zes_device_handle_t hDevice ///< [in] Sysman handle of the device.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get the list of supported overclock domains for this device
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pOverclockDomains`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + Overclocking is not supported on this control domain
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceGetOverclockDomains(
zes_device_handle_t hDevice, ///< [in] Sysman handle of the device.
uint32_t* pOverclockDomains ///< [in,out] Returns the overclock domains that are supported (a bit for
///< each of enum ::zes_overclock_domain_t). If no bits are set, the device
///< doesn't support overclocking.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get the list of supported overclock controls available for one of the
/// supported overclock domains on the device
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_ENUMERATION
/// + `::ZES_OVERCLOCK_DOMAIN_ADM < domainType`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pAvailableControls`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + Overclocking is not supported on this control domain
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceGetOverclockControls(
zes_device_handle_t hDevice, ///< [in] Sysman handle of the device.
zes_overclock_domain_t domainType, ///< [in] Domain type.
uint32_t* pAvailableControls ///< [in,out] Returns the overclock controls that are supported for the
///< specified overclock domain (a bit for each of enum
///< ::zes_overclock_control_t).
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Reset all overclock settings to default values (shipped = 1 or
/// manufacturing =0)
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + Overclocking is not supported on this control domain
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceResetOverclockSettings(
zes_device_handle_t hDevice, ///< [in] Sysman handle of the device.
ze_bool_t onShippedState ///< [in] True will reset to shipped state; false will reset to
///< manufacturing state
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Determine the state of overclocking
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pOverclockMode`
/// + `nullptr == pWaiverSetting`
/// + `nullptr == pOverclockState`
/// + `nullptr == pPendingAction`
/// + `nullptr == pPendingReset`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + Overclocking is not supported on this control domain
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceReadOverclockState(
zes_device_handle_t hDevice, ///< [in] Sysman handle of the device.
zes_overclock_mode_t* pOverclockMode, ///< [out] One of overclock mode.
ze_bool_t* pWaiverSetting, ///< [out] Waiver setting: 0 = Waiver not set, 1 = waiver has been set.
ze_bool_t* pOverclockState, ///< [out] Current settings 0 =manufacturing state, 1= shipped state)..
zes_pending_action_t* pPendingAction, ///< [out] This enum is returned when the driver attempts to set an
///< overclock control or reset overclock settings.
ze_bool_t* pPendingReset ///< [out] Pending reset 0 =manufacturing state, 1= shipped state)..
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get handle of overclock domains
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceEnumOverclockDomains(
zes_device_handle_t hDevice, ///< [in] Sysman handle of the device.
uint32_t* pCount, ///< [in,out] pointer to the number of components of this type.
///< if count is zero, then the driver shall update the value with the
///< total number of components of this type that are available.
///< if count is greater than the number of components of this type that
///< are available, then the driver shall update the value with the correct
///< number of components.
zes_overclock_handle_t* phDomainHandle ///< [in,out][optional][range(0, *pCount)] array of handle of components of
///< this type.
///< if count is less than the number of components of this type that are
///< available, then the driver shall only retrieve that number of
///< component handles.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get overclock domain control properties
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDomainHandle`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pDomainProperties`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + Overclocking is not supported on this control domain
ZE_APIEXPORT ze_result_t ZE_APICALL
zesOverclockGetDomainProperties(
zes_overclock_handle_t hDomainHandle, ///< [in] Handle for the component domain.
zes_overclock_properties_t* pDomainProperties ///< [in,out] The overclock properties for the specified domain.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Read overclock VF min,max and step values
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDomainHandle`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pVFProperties`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + Overclocking is not supported on this control domain
ZE_APIEXPORT ze_result_t ZE_APICALL
zesOverclockGetDomainVFProperties(
zes_overclock_handle_t hDomainHandle, ///< [in] Handle for the component domain.
zes_vf_property_t* pVFProperties ///< [in,out] The VF min,max,step for a specified domain.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Read overclock control values - min/max/step/default/ref
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDomainHandle`
/// - ::ZE_RESULT_ERROR_INVALID_ENUMERATION
/// + `::ZES_OVERCLOCK_CONTROL_ACM_DISABLE < DomainControl`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pControlProperties`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + Overclocking is not supported on this control domain
ZE_APIEXPORT ze_result_t ZE_APICALL
zesOverclockGetDomainControlProperties(
zes_overclock_handle_t hDomainHandle, ///< [in] Handle for the component domain.
zes_overclock_control_t DomainControl, ///< [in] Handle for the component.
zes_control_property_t* pControlProperties ///< [in,out] overclock control values.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Read the current value for a given overclock control
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDomainHandle`
/// - ::ZE_RESULT_ERROR_INVALID_ENUMERATION
/// + `::ZES_OVERCLOCK_CONTROL_ACM_DISABLE < DomainControl`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pValue`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + Overclocking is not supported on this control domain
ZE_APIEXPORT ze_result_t ZE_APICALL
zesOverclockGetControlCurrentValue(
zes_overclock_handle_t hDomainHandle, ///< [in] Handle for the component.
zes_overclock_control_t DomainControl, ///< [in] Overclock Control.
double* pValue ///< [in,out] Getting overclock control value for the specified control.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Read the the reset pending value for a given overclock control
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDomainHandle`
/// - ::ZE_RESULT_ERROR_INVALID_ENUMERATION
/// + `::ZES_OVERCLOCK_CONTROL_ACM_DISABLE < DomainControl`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pValue`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + Overclocking is not supported on this control domain
ZE_APIEXPORT ze_result_t ZE_APICALL
zesOverclockGetControlPendingValue(
zes_overclock_handle_t hDomainHandle, ///< [in] Handle for the component domain.
zes_overclock_control_t DomainControl, ///< [in] Overclock Control.
double* pValue ///< [out] Returns the pending value for a given control. The units and
///< format of the value depend on the control type.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Set the value for a given overclock control
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDomainHandle`
/// - ::ZE_RESULT_ERROR_INVALID_ENUMERATION
/// + `::ZES_OVERCLOCK_CONTROL_ACM_DISABLE < DomainControl`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pPendingAction`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + Overclocking is not supported on this control domain
ZE_APIEXPORT ze_result_t ZE_APICALL
zesOverclockSetControlUserValue(
zes_overclock_handle_t hDomainHandle, ///< [in] Handle for the component domain.
zes_overclock_control_t DomainControl, ///< [in] Domain Control.
double pValue, ///< [in] The new value of the control. The units and format of the value
///< depend on the control type.
zes_pending_action_t* pPendingAction ///< [out] Pending overclock setting.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Determine the state of an overclock control
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDomainHandle`
/// - ::ZE_RESULT_ERROR_INVALID_ENUMERATION
/// + `::ZES_OVERCLOCK_CONTROL_ACM_DISABLE < DomainControl`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pControlState`
/// + `nullptr == pPendingAction`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + Overclocking is not supported on this control domain
ZE_APIEXPORT ze_result_t ZE_APICALL
zesOverclockGetControlState(
zes_overclock_handle_t hDomainHandle, ///< [in] Handle for the component domain.
zes_overclock_control_t DomainControl, ///< [in] Domain Control.
zes_control_state_t* pControlState, ///< [out] Current overclock control state.
zes_pending_action_t* pPendingAction ///< [out] Pending overclock setting.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Read the frequency or voltage of a V-F point from the default or
/// custom V-F curve.
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDomainHandle`
/// - ::ZE_RESULT_ERROR_INVALID_ENUMERATION
/// + `::ZES_VF_TYPE_FREQ < VFType`
/// + `::ZES_VF_ARRAY_TYPE_LIVE_VF_ARRAY < VFArrayType`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == PointValue`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + Overclocking is not supported on this control domain
ZE_APIEXPORT ze_result_t ZE_APICALL
zesOverclockGetVFPointValues(
zes_overclock_handle_t hDomainHandle, ///< [in] Handle for the component domain.
zes_vf_type_t VFType, ///< [in] Voltage or Freqency point to read.
zes_vf_array_type_t VFArrayType, ///< [in] User,Default or Live VF array to read from
uint32_t PointIndex, ///< [in] Point index - number between (0, max_num_points - 1).
uint32_t* PointValue ///< [out] Returns the frequency in 1kHz units or voltage in millivolt
///< units from the custom V-F curve at the specified zero-based index
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Write the frequency or voltage of a V-F point to custom V-F curve.
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDomainHandle`
/// - ::ZE_RESULT_ERROR_INVALID_ENUMERATION
/// + `::ZES_VF_TYPE_FREQ < VFType`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + Overclocking is not supported on this control domain
ZE_APIEXPORT ze_result_t ZE_APICALL
zesOverclockSetVFPointValues(
zes_overclock_handle_t hDomainHandle, ///< [in] Handle for the component domain.
zes_vf_type_t VFType, ///< [in] Voltage or Freqency point to read.
uint32_t PointIndex, ///< [in] Point index - number between (0, max_num_points - 1).
uint32_t PointValue ///< [in] Writes frequency in 1kHz units or voltage in millivolt units to
///< custom V-F curve at the specified zero-based index
);
#if !defined(__GNUC__)
#pragma endregion
#endif
// Intel 'oneAPI' Level-Zero Tool APIs for System Resource Management (Sysman) - Firmware management
#if !defined(__GNUC__)
#pragma region diagnostics
#endif
///////////////////////////////////////////////////////////////////////////////
/// @brief Diagnostic results
typedef enum _zes_diag_result_t
{
ZES_DIAG_RESULT_NO_ERRORS = 0, ///< Diagnostic completed without finding errors to repair
ZES_DIAG_RESULT_ABORT = 1, ///< Diagnostic had problems running tests
ZES_DIAG_RESULT_FAIL_CANT_REPAIR = 2, ///< Diagnostic had problems setting up repairs
ZES_DIAG_RESULT_REBOOT_FOR_REPAIR = 3, ///< Diagnostics found errors, setup for repair and reboot is required to
///< complete the process
ZES_DIAG_RESULT_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_DIAG_RESULT_* ENUMs
} zes_diag_result_t;
///////////////////////////////////////////////////////////////////////////////
#ifndef ZES_DIAG_FIRST_TEST_INDEX
/// @brief Diagnostic test index to use for the very first test.
#define ZES_DIAG_FIRST_TEST_INDEX 0x0
#endif // ZES_DIAG_FIRST_TEST_INDEX
///////////////////////////////////////////////////////////////////////////////
#ifndef ZES_DIAG_LAST_TEST_INDEX
/// @brief Diagnostic test index to use for the very last test.
#define ZES_DIAG_LAST_TEST_INDEX 0xFFFFFFFF
#endif // ZES_DIAG_LAST_TEST_INDEX
///////////////////////////////////////////////////////////////////////////////
/// @brief Diagnostic test
typedef struct _zes_diag_test_t
{
uint32_t index; ///< [out] Index of the test
char name[ZES_STRING_PROPERTY_SIZE]; ///< [out] Name of the test
} zes_diag_test_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Diagnostics test suite properties
typedef struct _zes_diag_properties_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
ze_bool_t onSubdevice; ///< [out] True if the resource is located on a sub-device; false means
///< that the resource is on the device of the calling Sysman handle
uint32_t subdeviceId; ///< [out] If onSubdevice is true, this gives the ID of the sub-device
char name[ZES_STRING_PROPERTY_SIZE]; ///< [out] Name of the diagnostics test suite
ze_bool_t haveTests; ///< [out] Indicates if this test suite has individual tests which can be
///< run separately (use the function ::zesDiagnosticsGetTests() to get the
///< list of these tests)
} zes_diag_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Get handle of diagnostics test suites
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceEnumDiagnosticTestSuites(
zes_device_handle_t hDevice, ///< [in] Sysman handle of the device.
uint32_t* pCount, ///< [in,out] pointer to the number of components of this type.
///< if count is zero, then the driver shall update the value with the
///< total number of components of this type that are available.
///< if count is greater than the number of components of this type that
///< are available, then the driver shall update the value with the correct
///< number of components.
zes_diag_handle_t* phDiagnostics ///< [in,out][optional][range(0, *pCount)] array of handle of components of
///< this type.
///< if count is less than the number of components of this type that are
///< available, then the driver shall only retrieve that number of
///< component handles.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get properties of a diagnostics test suite
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDiagnostics`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pProperties`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDiagnosticsGetProperties(
zes_diag_handle_t hDiagnostics, ///< [in] Handle for the component.
zes_diag_properties_t* pProperties ///< [in,out] Structure describing the properties of a diagnostics test
///< suite
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get individual tests that can be run separately. Not all test suites
/// permit running individual tests, check the `haveTests` member of
/// ::zes_diag_properties_t.
///
/// @details
/// - The list of available tests is returned in order of increasing test
/// index (see the `index` member of ::zes_diag_test_t).
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDiagnostics`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDiagnosticsGetTests(
zes_diag_handle_t hDiagnostics, ///< [in] Handle for the component.
uint32_t* pCount, ///< [in,out] pointer to the number of tests.
///< if count is zero, then the driver shall update the value with the
///< total number of tests that are available.
///< if count is greater than the number of tests that are available, then
///< the driver shall update the value with the correct number of tests.
zes_diag_test_t* pTests ///< [in,out][optional][range(0, *pCount)] array of information about
///< individual tests sorted by increasing value of the `index` member of ::zes_diag_test_t.
///< if count is less than the number of tests that are available, then the
///< driver shall only retrieve that number of tests.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Run a diagnostics test suite, either all tests or a subset of tests.
///
/// @details
/// - WARNING: Running diagnostics may destroy current device state
/// information. Gracefully close any running workloads before initiating.
/// - To run all tests in a test suite, set start =
/// ::ZES_DIAG_FIRST_TEST_INDEX and end = ::ZES_DIAG_LAST_TEST_INDEX.
/// - If the test suite permits running individual tests, the `haveTests`
/// member of ::zes_diag_properties_t will be true. In this case, the
/// function ::zesDiagnosticsGetTests() can be called to get the list of
/// tests and corresponding indices that can be supplied to the arguments
/// start and end in this function.
/// - This function will block until the diagnostics have completed and
/// force reset based on result
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDiagnostics`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pResult`
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to perform diagnostics.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDiagnosticsRunTests(
zes_diag_handle_t hDiagnostics, ///< [in] Handle for the component.
uint32_t startIndex, ///< [in] The index of the first test to run. Set to
///< ::ZES_DIAG_FIRST_TEST_INDEX to start from the beginning.
uint32_t endIndex, ///< [in] The index of the last test to run. Set to
///< ::ZES_DIAG_LAST_TEST_INDEX to complete all tests after the start test.
zes_diag_result_t* pResult ///< [in,out] The result of the diagnostics
);
#if !defined(__GNUC__)
#pragma endregion
#endif
// Intel 'oneAPI' Level-Zero Tool APIs for System Resource Management (Sysman) - ECC management
#if !defined(__GNUC__)
#pragma region ecc
#endif
///////////////////////////////////////////////////////////////////////////////
/// @brief ECC State
typedef enum _zes_device_ecc_state_t
{
ZES_DEVICE_ECC_STATE_UNAVAILABLE = 0, ///< None
ZES_DEVICE_ECC_STATE_ENABLED = 1, ///< ECC enabled.
ZES_DEVICE_ECC_STATE_DISABLED = 2, ///< ECC disabled.
ZES_DEVICE_ECC_STATE_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_DEVICE_ECC_STATE_* ENUMs
} zes_device_ecc_state_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief State Change Requirements
typedef enum _zes_device_action_t
{
ZES_DEVICE_ACTION_NONE = 0, ///< No action.
ZES_DEVICE_ACTION_WARM_CARD_RESET = 1, ///< Warm reset of the card.
ZES_DEVICE_ACTION_COLD_CARD_RESET = 2, ///< Cold reset of the card.
ZES_DEVICE_ACTION_COLD_SYSTEM_REBOOT = 3, ///< Cold reboot of the system.
ZES_DEVICE_ACTION_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_DEVICE_ACTION_* ENUMs
} zes_device_action_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief ECC State Descriptor
typedef struct _zes_device_ecc_desc_t
{
zes_structure_type_t stype; ///< [in] type of this structure
const void* pNext; ///< [in][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
zes_device_ecc_state_t state; ///< [out] ECC state
} zes_device_ecc_desc_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief ECC State
typedef struct _zes_device_ecc_properties_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
zes_device_ecc_state_t currentState; ///< [out] Current ECC state
zes_device_ecc_state_t pendingState; ///< [out] Pending ECC state
zes_device_action_t pendingAction; ///< [out] Pending action
} zes_device_ecc_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Is ECC functionality available - true or false?
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pAvailable`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceEccAvailable(
zes_device_handle_t hDevice, ///< [in] Handle for the component.
ze_bool_t* pAvailable ///< [out] ECC functionality is available (true)/unavailable (false).
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Is ECC support configurable - true or false?
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pConfigurable`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceEccConfigurable(
zes_device_handle_t hDevice, ///< [in] Handle for the component.
ze_bool_t* pConfigurable ///< [out] ECC can be enabled/disabled (true)/enabled/disabled (false).
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get current ECC state, pending state, and pending action
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pState`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceGetEccState(
zes_device_handle_t hDevice, ///< [in] Handle for the component.
zes_device_ecc_properties_t* pState ///< [out] ECC state, pending state, and pending action for state change.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Set new ECC state
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
/// - ::zesDeviceGetState should be called to determine pending action
/// required to implement state change.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == newState`
/// + `nullptr == pState`
/// - ::ZE_RESULT_ERROR_INVALID_ENUMERATION
/// + `::ZES_DEVICE_ECC_STATE_DISABLED < newState->state`
/// - ::ZE_RESULT_WARNING_ACTION_REQUIRED
/// + User must look at the pendingAction attribute of pState & perform the action required to complete the ECC state change.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceSetEccState(
zes_device_handle_t hDevice, ///< [in] Handle for the component.
const zes_device_ecc_desc_t* newState, ///< [in] Pointer to desired ECC state.
zes_device_ecc_properties_t* pState ///< [out] ECC state, pending state, and pending action for state change.
);
#if !defined(__GNUC__)
#pragma endregion
#endif
// Intel 'oneAPI' Level-Zero Tool APIs for System Resource Management (Sysman) - Engine groups
#if !defined(__GNUC__)
#pragma region engine
#endif
///////////////////////////////////////////////////////////////////////////////
/// @brief Accelerator engine groups
typedef enum _zes_engine_group_t
{
ZES_ENGINE_GROUP_ALL = 0, ///< Access information about all engines combined.
ZES_ENGINE_GROUP_COMPUTE_ALL = 1, ///< Access information about all compute engines combined. Compute engines
///< can only process compute kernels (no 3D content).
ZES_ENGINE_GROUP_MEDIA_ALL = 2, ///< Access information about all media engines combined.
ZES_ENGINE_GROUP_COPY_ALL = 3, ///< Access information about all copy (blitter) engines combined.
ZES_ENGINE_GROUP_COMPUTE_SINGLE = 4, ///< Access information about a single compute engine - this is an engine
///< that can process compute kernels. Note that single engines may share
///< the same underlying accelerator resources as other engines so activity
///< of such an engine may not be indicative of the underlying resource
///< utilization - use ::ZES_ENGINE_GROUP_3D_RENDER_COMPUTE_ALL for that.
ZES_ENGINE_GROUP_RENDER_SINGLE = 5, ///< Access information about a single render engine - this is an engine
///< that can process both 3D content and compute kernels. Note that single
///< engines may share the same underlying accelerator resources as other
///< engines so activity of such an engine may not be indicative of the
///< underlying resource utilization - use
///< ::ZES_ENGINE_GROUP_3D_RENDER_COMPUTE_ALL for that.
ZES_ENGINE_GROUP_MEDIA_DECODE_SINGLE = 6, ///< [DEPRECATED] No longer supported.
ZES_ENGINE_GROUP_MEDIA_ENCODE_SINGLE = 7, ///< [DEPRECATED] No longer supported.
ZES_ENGINE_GROUP_COPY_SINGLE = 8, ///< Access information about a single media encode engine. Note that
///< single engines may share the same underlying accelerator resources as
///< other engines so activity of such an engine may not be indicative of
///< the underlying resource utilization - use ::ZES_ENGINE_GROUP_COPY_ALL
///< for that.
ZES_ENGINE_GROUP_MEDIA_ENHANCEMENT_SINGLE = 9, ///< Access information about a single media enhancement engine. Note that
///< single engines may share the same underlying accelerator resources as
///< other engines so activity of such an engine may not be indicative of
///< the underlying resource utilization - use ::ZES_ENGINE_GROUP_MEDIA_ALL
///< for that.
ZES_ENGINE_GROUP_3D_SINGLE = 10, ///< [DEPRECATED] No longer supported.
ZES_ENGINE_GROUP_3D_RENDER_COMPUTE_ALL = 11, ///< [DEPRECATED] No longer supported.
ZES_ENGINE_GROUP_RENDER_ALL = 12, ///< Access information about all render engines combined. Render engines
///< are those than process both 3D content and compute kernels.
ZES_ENGINE_GROUP_3D_ALL = 13, ///< [DEPRECATED] No longer supported.
ZES_ENGINE_GROUP_MEDIA_CODEC_SINGLE = 14, ///< Access information about a single media engine. Note that single
///< engines may share the same underlying accelerator resources as other
///< engines so activity of such an engine may not be indicative of the
///< underlying resource utilization - use ::ZES_ENGINE_GROUP_MEDIA_ALL for
///< that.
ZES_ENGINE_GROUP_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_ENGINE_GROUP_* ENUMs
} zes_engine_group_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Engine group properties
typedef struct _zes_engine_properties_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
zes_engine_group_t type; ///< [out] The engine group
ze_bool_t onSubdevice; ///< [out] True if this resource is located on a sub-device; false means
///< that the resource is on the device of the calling Sysman handle
uint32_t subdeviceId; ///< [out] If onSubdevice is true, this gives the ID of the sub-device
} zes_engine_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Engine activity counters
///
/// @details
/// - Percent utilization is calculated by taking two snapshots (s1, s2) and
/// using the equation: %util = (s2.activeTime - s1.activeTime) /
/// (s2.timestamp - s1.timestamp)
/// - The `activeTime` time units are implementation-specific since the
/// value is only intended to be used for calculating utilization
/// percentage.
/// - The `timestamp` should only be used to calculate delta between
/// snapshots of this structure.
/// - The application should never take the delta of `timestamp` with the
/// timestamp from a different structure since they are not guaranteed to
/// have the same base.
/// - When taking the delta, the difference between `timestamp` samples
/// could be `0`, if the frequency of sampling the snapshots is higher
/// than the frequency of the timestamp update.
/// - The absolute value of `timestamp` is only valid during within the
/// application and may be different on the next execution.
typedef struct _zes_engine_stats_t
{
uint64_t activeTime; ///< [out] Monotonic counter where the resource is actively running
///< workloads.
uint64_t timestamp; ///< [out] Monotonic counter when activeTime counter was sampled.
} zes_engine_stats_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Get handle of engine groups
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceEnumEngineGroups(
zes_device_handle_t hDevice, ///< [in] Sysman handle of the device.
uint32_t* pCount, ///< [in,out] pointer to the number of components of this type.
///< if count is zero, then the driver shall update the value with the
///< total number of components of this type that are available.
///< if count is greater than the number of components of this type that
///< are available, then the driver shall update the value with the correct
///< number of components.
zes_engine_handle_t* phEngine ///< [in,out][optional][range(0, *pCount)] array of handle of components of
///< this type.
///< if count is less than the number of components of this type that are
///< available, then the driver shall only retrieve that number of
///< component handles.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get engine group properties
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hEngine`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pProperties`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesEngineGetProperties(
zes_engine_handle_t hEngine, ///< [in] Handle for the component.
zes_engine_properties_t* pProperties ///< [in,out] The properties for the specified engine group.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get the activity stats for an engine group.
///
/// @details
/// - This function also returns the engine activity inside a Virtual
/// Machine (VM), in the presence of hardware virtualization (SRIOV)
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hEngine`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pStats`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesEngineGetActivity(
zes_engine_handle_t hEngine, ///< [in] Handle for the component.
zes_engine_stats_t* pStats ///< [in,out] Will contain a snapshot of the engine group activity
///< counters.
);
#if !defined(__GNUC__)
#pragma endregion
#endif
// Intel 'oneAPI' Level-Zero Tool APIs for System Resource Management (Sysman) - Event management
#if !defined(__GNUC__)
#pragma region events
#endif
///////////////////////////////////////////////////////////////////////////////
/// @brief Event types
typedef uint32_t zes_event_type_flags_t;
typedef enum _zes_event_type_flag_t
{
ZES_EVENT_TYPE_FLAG_DEVICE_DETACH = ZE_BIT(0), ///< Event is triggered when the device is no longer available (due to a
///< reset or being disabled).
ZES_EVENT_TYPE_FLAG_DEVICE_ATTACH = ZE_BIT(1), ///< Event is triggered after the device is available again.
ZES_EVENT_TYPE_FLAG_DEVICE_SLEEP_STATE_ENTER = ZE_BIT(2), ///< Event is triggered when the driver is about to put the device into a
///< deep sleep state
ZES_EVENT_TYPE_FLAG_DEVICE_SLEEP_STATE_EXIT = ZE_BIT(3), ///< Event is triggered when the driver is waking the device up from a deep
///< sleep state
ZES_EVENT_TYPE_FLAG_FREQ_THROTTLED = ZE_BIT(4), ///< Event is triggered when the frequency starts being throttled
ZES_EVENT_TYPE_FLAG_ENERGY_THRESHOLD_CROSSED = ZE_BIT(5), ///< Event is triggered when the energy consumption threshold is reached
///< (use ::zesPowerSetEnergyThreshold() to configure).
ZES_EVENT_TYPE_FLAG_TEMP_CRITICAL = ZE_BIT(6), ///< Event is triggered when the critical temperature is reached (use
///< ::zesTemperatureSetConfig() to configure - disabled by default).
ZES_EVENT_TYPE_FLAG_TEMP_THRESHOLD1 = ZE_BIT(7), ///< Event is triggered when the temperature crosses threshold 1 (use
///< ::zesTemperatureSetConfig() to configure - disabled by default).
ZES_EVENT_TYPE_FLAG_TEMP_THRESHOLD2 = ZE_BIT(8), ///< Event is triggered when the temperature crosses threshold 2 (use
///< ::zesTemperatureSetConfig() to configure - disabled by default).
ZES_EVENT_TYPE_FLAG_MEM_HEALTH = ZE_BIT(9), ///< Event is triggered when the health of device memory changes.
ZES_EVENT_TYPE_FLAG_FABRIC_PORT_HEALTH = ZE_BIT(10), ///< Event is triggered when the health of fabric ports change.
ZES_EVENT_TYPE_FLAG_PCI_LINK_HEALTH = ZE_BIT(11), ///< Event is triggered when the health of the PCI link changes.
ZES_EVENT_TYPE_FLAG_RAS_CORRECTABLE_ERRORS = ZE_BIT(12), ///< Event is triggered when accelerator RAS correctable errors cross
///< thresholds (use ::zesRasSetConfig() to configure - disabled by
///< default).
ZES_EVENT_TYPE_FLAG_RAS_UNCORRECTABLE_ERRORS = ZE_BIT(13), ///< Event is triggered when accelerator RAS uncorrectable errors cross
///< thresholds (use ::zesRasSetConfig() to configure - disabled by
///< default).
ZES_EVENT_TYPE_FLAG_DEVICE_RESET_REQUIRED = ZE_BIT(14), ///< Event is triggered when the device needs to be reset (use
///< ::zesDeviceGetState() to determine the reasons for the reset).
ZES_EVENT_TYPE_FLAG_SURVIVABILITY_MODE_DETECTED = ZE_BIT(15), ///< Event is triggered when graphics driver encounter an error condition.
ZES_EVENT_TYPE_FLAG_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_EVENT_TYPE_FLAG_* ENUMs
} zes_event_type_flag_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Specify the list of events to listen to for a given device
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_ENUMERATION
/// + `0xffff < events`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceEventRegister(
zes_device_handle_t hDevice, ///< [in] The device handle.
zes_event_type_flags_t events ///< [in] List of events to listen to.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Wait for events to be received from a one or more devices.
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDriver`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == phDevices`
/// + `nullptr == pNumDeviceEvents`
/// + `nullptr == pEvents`
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to listen to events.
/// - ::ZE_RESULT_ERROR_INVALID_ARGUMENT
/// + One or more of the supplied device handles belongs to a different driver.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDriverEventListen(
ze_driver_handle_t hDriver, ///< [in] handle of the driver instance
uint32_t timeout, ///< [in] if non-zero, then indicates the maximum time (in milliseconds) to
///< yield before returning ::ZE_RESULT_SUCCESS or ::ZE_RESULT_NOT_READY;
///< if zero, then will check status and return immediately;
///< if `UINT32_MAX`, then function will not return until events arrive.
uint32_t count, ///< [in] Number of device handles in phDevices.
zes_device_handle_t* phDevices, ///< [in][range(0, count)] Device handles to listen to for events. Only
///< devices from the provided driver handle can be specified in this list.
uint32_t* pNumDeviceEvents, ///< [in,out] Will contain the actual number of devices in phDevices that
///< generated events. If non-zero, check pEvents to determine the devices
///< and events that were received.
zes_event_type_flags_t* pEvents ///< [in,out] An array that will continue the list of events for each
///< device listened in phDevices.
///< This array must be at least as big as count.
///< For every device handle in phDevices, this will provide the events
///< that occurred for that device at the same position in this array. If
///< no event was received for a given device, the corresponding array
///< entry will be zero.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Wait for events to be received from a one or more devices.
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDriver`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == phDevices`
/// + `nullptr == pNumDeviceEvents`
/// + `nullptr == pEvents`
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to listen to events.
/// - ::ZE_RESULT_ERROR_INVALID_ARGUMENT
/// + One or more of the supplied device handles belongs to a different driver.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDriverEventListenEx(
ze_driver_handle_t hDriver, ///< [in] handle of the driver instance
uint64_t timeout, ///< [in] if non-zero, then indicates the maximum time (in milliseconds) to
///< yield before returning ::ZE_RESULT_SUCCESS or ::ZE_RESULT_NOT_READY;
///< if zero, then will check status and return immediately;
///< if `UINT64_MAX`, then function will not return until events arrive.
uint32_t count, ///< [in] Number of device handles in phDevices.
zes_device_handle_t* phDevices, ///< [in][range(0, count)] Device handles to listen to for events. Only
///< devices from the provided driver handle can be specified in this list.
uint32_t* pNumDeviceEvents, ///< [in,out] Will contain the actual number of devices in phDevices that
///< generated events. If non-zero, check pEvents to determine the devices
///< and events that were received.
zes_event_type_flags_t* pEvents ///< [in,out] An array that will continue the list of events for each
///< device listened in phDevices.
///< This array must be at least as big as count.
///< For every device handle in phDevices, this will provide the events
///< that occurred for that device at the same position in this array. If
///< no event was received for a given device, the corresponding array
///< entry will be zero.
);
#if !defined(__GNUC__)
#pragma endregion
#endif
// Intel 'oneAPI' Level-Zero Tool APIs for System Resource Management (Sysman) - Firmware management
#if !defined(__GNUC__)
#pragma region fabric
#endif
///////////////////////////////////////////////////////////////////////////////
#ifndef ZES_MAX_FABRIC_PORT_MODEL_SIZE
/// @brief Maximum Fabric port model string size
#define ZES_MAX_FABRIC_PORT_MODEL_SIZE 256
#endif // ZES_MAX_FABRIC_PORT_MODEL_SIZE
///////////////////////////////////////////////////////////////////////////////
#ifndef ZES_MAX_FABRIC_LINK_TYPE_SIZE
/// @brief Maximum size of the buffer that will return information about link
/// types
#define ZES_MAX_FABRIC_LINK_TYPE_SIZE 256
#endif // ZES_MAX_FABRIC_LINK_TYPE_SIZE
///////////////////////////////////////////////////////////////////////////////
/// @brief Fabric port status
typedef enum _zes_fabric_port_status_t
{
ZES_FABRIC_PORT_STATUS_UNKNOWN = 0, ///< The port status cannot be determined
ZES_FABRIC_PORT_STATUS_HEALTHY = 1, ///< The port is up and operating as expected
ZES_FABRIC_PORT_STATUS_DEGRADED = 2, ///< The port is up but has quality and/or speed degradation
ZES_FABRIC_PORT_STATUS_FAILED = 3, ///< Port connection instabilities are preventing workloads making forward
///< progress
ZES_FABRIC_PORT_STATUS_DISABLED = 4, ///< The port is configured down
ZES_FABRIC_PORT_STATUS_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_FABRIC_PORT_STATUS_* ENUMs
} zes_fabric_port_status_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Fabric port quality degradation reasons
typedef uint32_t zes_fabric_port_qual_issue_flags_t;
typedef enum _zes_fabric_port_qual_issue_flag_t
{
ZES_FABRIC_PORT_QUAL_ISSUE_FLAG_LINK_ERRORS = ZE_BIT(0), ///< Excessive link errors are occurring
ZES_FABRIC_PORT_QUAL_ISSUE_FLAG_SPEED = ZE_BIT(1), ///< There is a degradation in the bitrate and/or width of the link
ZES_FABRIC_PORT_QUAL_ISSUE_FLAG_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_FABRIC_PORT_QUAL_ISSUE_FLAG_* ENUMs
} zes_fabric_port_qual_issue_flag_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Fabric port failure reasons
typedef uint32_t zes_fabric_port_failure_flags_t;
typedef enum _zes_fabric_port_failure_flag_t
{
ZES_FABRIC_PORT_FAILURE_FLAG_FAILED = ZE_BIT(0), ///< A previously operating link has failed. Hardware will automatically
///< retrain this port. This state will persist until either the physical
///< connection is removed or the link trains successfully.
ZES_FABRIC_PORT_FAILURE_FLAG_TRAINING_TIMEOUT = ZE_BIT(1), ///< A connection has not been established within an expected time.
///< Hardware will continue to attempt port training. This status will
///< persist until either the physical connection is removed or the link
///< successfully trains.
ZES_FABRIC_PORT_FAILURE_FLAG_FLAPPING = ZE_BIT(2), ///< Port has excessively trained and then transitioned down for some
///< period of time. Driver will allow port to continue to train, but will
///< not enable the port for use until the port has been disabled and
///< subsequently re-enabled using ::zesFabricPortSetConfig().
ZES_FABRIC_PORT_FAILURE_FLAG_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_FABRIC_PORT_FAILURE_FLAG_* ENUMs
} zes_fabric_port_failure_flag_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Unique identifier for a fabric port
///
/// @details
/// - This not a universal identifier. The identified is garanteed to be
/// unique for the current hardware configuration of the system. Changes
/// in the hardware may result in a different identifier for a given port.
/// - The main purpose of this identifier to build up an instantaneous
/// topology map of system connectivity. An application should enumerate
/// all fabric ports and match the `remotePortId` member of
/// ::zes_fabric_port_state_t to the `portId` member of
/// ::zes_fabric_port_properties_t.
typedef struct _zes_fabric_port_id_t
{
uint32_t fabricId; ///< [out] Unique identifier for the fabric end-point
uint32_t attachId; ///< [out] Unique identifier for the device attachment point
uint8_t portNumber; ///< [out] The logical port number (this is typically marked somewhere on
///< the physical device)
} zes_fabric_port_id_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Fabric port speed in one direction
typedef struct _zes_fabric_port_speed_t
{
int64_t bitRate; ///< [out] Bits/sec that the link is operating at. A value of -1 means that
///< this property is unknown.
int32_t width; ///< [out] The number of lanes. A value of -1 means that this property is
///< unknown.
} zes_fabric_port_speed_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Fabric port properties
typedef struct _zes_fabric_port_properties_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
char model[ZES_MAX_FABRIC_PORT_MODEL_SIZE]; ///< [out] Description of port technology. Will be set to the string
///< "unkown" if this cannot be determined for this port.
ze_bool_t onSubdevice; ///< [out] True if the port is located on a sub-device; false means that
///< the port is on the device of the calling Sysman handle
uint32_t subdeviceId; ///< [out] If onSubdevice is true, this gives the ID of the sub-device
zes_fabric_port_id_t portId; ///< [out] The unique port identifier
zes_fabric_port_speed_t maxRxSpeed; ///< [out] Maximum speed supported by the receive side of the port (sum of
///< all lanes)
zes_fabric_port_speed_t maxTxSpeed; ///< [out] Maximum speed supported by the transmit side of the port (sum of
///< all lanes)
} zes_fabric_port_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Provides information about the fabric link attached to a port
typedef struct _zes_fabric_link_type_t
{
char desc[ZES_MAX_FABRIC_LINK_TYPE_SIZE]; ///< [out] Description of link technology. Will be set to the string
///< "unkown" if this cannot be determined for this link.
} zes_fabric_link_type_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Fabric port configuration
typedef struct _zes_fabric_port_config_t
{
zes_structure_type_t stype; ///< [in] type of this structure
const void* pNext; ///< [in][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
ze_bool_t enabled; ///< [in,out] Port is configured up/down
ze_bool_t beaconing; ///< [in,out] Beaconing is configured on/off
} zes_fabric_port_config_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Fabric port state
typedef struct _zes_fabric_port_state_t
{
zes_structure_type_t stype; ///< [in] type of this structure
const void* pNext; ///< [in][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
zes_fabric_port_status_t status; ///< [out] The current status of the port
zes_fabric_port_qual_issue_flags_t qualityIssues; ///< [out] If status is ::ZES_FABRIC_PORT_STATUS_DEGRADED,
///< then this gives a combination of ::zes_fabric_port_qual_issue_flag_t
///< for quality issues that have been detected;
///< otherwise, 0 indicates there are no quality issues with the link at
///< this time.
zes_fabric_port_failure_flags_t failureReasons; ///< [out] If status is ::ZES_FABRIC_PORT_STATUS_FAILED,
///< then this gives a combination of ::zes_fabric_port_failure_flag_t for
///< reasons for the connection instability;
///< otherwise, 0 indicates there are no connection stability issues at
///< this time.
zes_fabric_port_id_t remotePortId; ///< [out] The unique port identifier for the remote connection point if
///< status is ::ZES_FABRIC_PORT_STATUS_HEALTHY,
///< ::ZES_FABRIC_PORT_STATUS_DEGRADED or ::ZES_FABRIC_PORT_STATUS_FAILED
zes_fabric_port_speed_t rxSpeed; ///< [out] Current maximum receive speed (sum of all lanes)
zes_fabric_port_speed_t txSpeed; ///< [out] Current maximum transmit speed (sum of all lanes)
} zes_fabric_port_state_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Fabric port throughput.
typedef struct _zes_fabric_port_throughput_t
{
uint64_t timestamp; ///< [out] Monotonic timestamp counter in microseconds when the measurement
///< was made.
///< This timestamp should only be used to calculate delta time between
///< snapshots of this structure.
///< Never take the delta of this timestamp with the timestamp from a
///< different structure since they are not guaranteed to have the same base.
///< The absolute value of the timestamp is only valid during within the
///< application and may be different on the next execution.
uint64_t rxCounter; ///< [out] Monotonic counter for the number of bytes received (sum of all
///< lanes). This includes all protocol overhead, not only the GPU traffic.
uint64_t txCounter; ///< [out] Monotonic counter for the number of bytes transmitted (sum of
///< all lanes). This includes all protocol overhead, not only the GPU
///< traffic.
} zes_fabric_port_throughput_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Fabric Port Error Counters
typedef struct _zes_fabric_port_error_counters_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
uint64_t linkFailureCount; ///< [out] Link Failure Error Count reported per port
uint64_t fwCommErrorCount; ///< [out] Firmware Communication Error Count reported per device
uint64_t fwErrorCount; ///< [out] Firmware reported Error Count reported per device
uint64_t linkDegradeCount; ///< [out] Link Degrade Error Count reported per port
} zes_fabric_port_error_counters_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Get handle of Fabric ports in a device
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceEnumFabricPorts(
zes_device_handle_t hDevice, ///< [in] Sysman handle of the device.
uint32_t* pCount, ///< [in,out] pointer to the number of components of this type.
///< if count is zero, then the driver shall update the value with the
///< total number of components of this type that are available.
///< if count is greater than the number of components of this type that
///< are available, then the driver shall update the value with the correct
///< number of components.
zes_fabric_port_handle_t* phPort ///< [in,out][optional][range(0, *pCount)] array of handle of components of
///< this type.
///< if count is less than the number of components of this type that are
///< available, then the driver shall only retrieve that number of
///< component handles.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get Fabric port properties
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hPort`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pProperties`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFabricPortGetProperties(
zes_fabric_port_handle_t hPort, ///< [in] Handle for the component.
zes_fabric_port_properties_t* pProperties ///< [in,out] Will contain properties of the Fabric Port.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get Fabric port link type
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hPort`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pLinkType`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFabricPortGetLinkType(
zes_fabric_port_handle_t hPort, ///< [in] Handle for the component.
zes_fabric_link_type_t* pLinkType ///< [in,out] Will contain details about the link attached to the Fabric
///< port.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get Fabric port configuration
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hPort`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pConfig`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFabricPortGetConfig(
zes_fabric_port_handle_t hPort, ///< [in] Handle for the component.
zes_fabric_port_config_t* pConfig ///< [in,out] Will contain configuration of the Fabric Port.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Set Fabric port configuration
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hPort`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pConfig`
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to make these modifications.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFabricPortSetConfig(
zes_fabric_port_handle_t hPort, ///< [in] Handle for the component.
const zes_fabric_port_config_t* pConfig ///< [in] Contains new configuration of the Fabric Port.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get Fabric port state - status (health/degraded/failed/disabled),
/// reasons for link degradation or instability, current rx/tx speed
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hPort`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pState`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFabricPortGetState(
zes_fabric_port_handle_t hPort, ///< [in] Handle for the component.
zes_fabric_port_state_t* pState ///< [in,out] Will contain the current state of the Fabric Port
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get Fabric port throughput
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hPort`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pThroughput`
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to query this telemetry.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFabricPortGetThroughput(
zes_fabric_port_handle_t hPort, ///< [in] Handle for the component.
zes_fabric_port_throughput_t* pThroughput ///< [in,out] Will contain the Fabric port throughput counters.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get Fabric Port Error Counters
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
/// - The memory backing the arrays for phPorts and ppThroughputs must be
/// allocated in system memory by the user who is also responsible for
/// releasing them when they are no longer needed.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hPort`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pErrors`
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to query this telemetry.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFabricPortGetFabricErrorCounters(
zes_fabric_port_handle_t hPort, ///< [in] Handle for the component.
zes_fabric_port_error_counters_t* pErrors ///< [in,out] Will contain the Fabric port Error counters.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get Fabric port throughput from multiple ports in a single call
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == phPort`
/// + `nullptr == pThroughput`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFabricPortGetMultiPortThroughput(
zes_device_handle_t hDevice, ///< [in] Sysman handle of the device.
uint32_t numPorts, ///< [in] Number of ports enumerated in function ::zesDeviceEnumFabricPorts
zes_fabric_port_handle_t* phPort, ///< [in][range(0, numPorts)] array of fabric port handles provided by user
///< to gather throughput values.
zes_fabric_port_throughput_t** pThroughput ///< [out][range(0, numPorts)] array of fabric port throughput counters
///< from multiple ports of type ::zes_fabric_port_throughput_t.
);
#if !defined(__GNUC__)
#pragma endregion
#endif
// Intel 'oneAPI' Level-Zero Tool APIs for System Resource Management (Sysman) - Firmware management
#if !defined(__GNUC__)
#pragma region fan
#endif
///////////////////////////////////////////////////////////////////////////////
/// @brief Fan resource speed mode
typedef enum _zes_fan_speed_mode_t
{
ZES_FAN_SPEED_MODE_DEFAULT = 0, ///< The fan speed is operating using the hardware default settings
ZES_FAN_SPEED_MODE_FIXED = 1, ///< The fan speed is currently set to a fixed value
ZES_FAN_SPEED_MODE_TABLE = 2, ///< The fan speed is currently controlled dynamically by hardware based on
///< a temp/speed table
ZES_FAN_SPEED_MODE_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_FAN_SPEED_MODE_* ENUMs
} zes_fan_speed_mode_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Fan speed units
typedef enum _zes_fan_speed_units_t
{
ZES_FAN_SPEED_UNITS_RPM = 0, ///< The fan speed is in units of revolutions per minute (rpm)
ZES_FAN_SPEED_UNITS_PERCENT = 1, ///< The fan speed is a percentage of the maximum speed of the fan
ZES_FAN_SPEED_UNITS_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_FAN_SPEED_UNITS_* ENUMs
} zes_fan_speed_units_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Fan speed
typedef struct _zes_fan_speed_t
{
int32_t speed; ///< [in,out] The speed of the fan. On output, a value of -1 indicates that
///< there is no fixed fan speed setting.
zes_fan_speed_units_t units; ///< [in,out] The units that the fan speed is expressed in. On output, if
///< fan speed is -1 then units should be ignored.
} zes_fan_speed_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Fan temperature/speed pair
typedef struct _zes_fan_temp_speed_t
{
uint32_t temperature; ///< [in,out] Temperature in degrees Celsius.
zes_fan_speed_t speed; ///< [in,out] The speed of the fan
} zes_fan_temp_speed_t;
///////////////////////////////////////////////////////////////////////////////
#ifndef ZES_FAN_TEMP_SPEED_PAIR_COUNT
/// @brief Maximum number of fan temperature/speed pairs in the fan speed table.
#define ZES_FAN_TEMP_SPEED_PAIR_COUNT 32
#endif // ZES_FAN_TEMP_SPEED_PAIR_COUNT
///////////////////////////////////////////////////////////////////////////////
/// @brief Fan speed table
typedef struct _zes_fan_speed_table_t
{
int32_t numPoints; ///< [in,out] The number of valid points in the fan speed table. 0 means
///< that there is no fan speed table configured. -1 means that a fan speed
///< table is not supported by the hardware.
zes_fan_temp_speed_t table[ZES_FAN_TEMP_SPEED_PAIR_COUNT]; ///< [in,out] Array of temperature/fan speed pairs. The table is ordered
///< based on temperature from lowest to highest.
} zes_fan_speed_table_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Fan properties
typedef struct _zes_fan_properties_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
ze_bool_t onSubdevice; ///< [out] True if the resource is located on a sub-device; false means
///< that the resource is on the device of the calling Sysman handle
uint32_t subdeviceId; ///< [out] If onSubdevice is true, this gives the ID of the sub-device
ze_bool_t canControl; ///< [out] Indicates if software can control the fan speed assuming the
///< user has permissions
uint32_t supportedModes; ///< [out] Bitfield of supported fan configuration modes
///< (1<<::zes_fan_speed_mode_t)
uint32_t supportedUnits; ///< [out] Bitfield of supported fan speed units
///< (1<<::zes_fan_speed_units_t)
int32_t maxRPM; ///< [out] The maximum RPM of the fan. A value of -1 means that this
///< property is unknown.
int32_t maxPoints; ///< [out] The maximum number of points in the fan temp/speed table. A
///< value of -1 means that this fan doesn't support providing a temp/speed
///< table.
} zes_fan_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Fan configuration
typedef struct _zes_fan_config_t
{
zes_structure_type_t stype; ///< [in] type of this structure
const void* pNext; ///< [in][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
zes_fan_speed_mode_t mode; ///< [in,out] The fan speed mode (fixed, temp-speed table)
zes_fan_speed_t speedFixed; ///< [in,out] The current fixed fan speed setting
zes_fan_speed_table_t speedTable; ///< [out] A table containing temperature/speed pairs
} zes_fan_config_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Get handle of fans
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceEnumFans(
zes_device_handle_t hDevice, ///< [in] Sysman handle of the device.
uint32_t* pCount, ///< [in,out] pointer to the number of components of this type.
///< if count is zero, then the driver shall update the value with the
///< total number of components of this type that are available.
///< if count is greater than the number of components of this type that
///< are available, then the driver shall update the value with the correct
///< number of components.
zes_fan_handle_t* phFan ///< [in,out][optional][range(0, *pCount)] array of handle of components of
///< this type.
///< if count is less than the number of components of this type that are
///< available, then the driver shall only retrieve that number of
///< component handles.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get fan properties
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hFan`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pProperties`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFanGetProperties(
zes_fan_handle_t hFan, ///< [in] Handle for the component.
zes_fan_properties_t* pProperties ///< [in,out] Will contain the properties of the fan.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get fan configurations and the current fan speed mode (default, fixed,
/// temp-speed table)
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hFan`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pConfig`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFanGetConfig(
zes_fan_handle_t hFan, ///< [in] Handle for the component.
zes_fan_config_t* pConfig ///< [in,out] Will contain the current configuration of the fan.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Configure the fan to run with hardware factory settings (set mode to
/// ::ZES_FAN_SPEED_MODE_DEFAULT)
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hFan`
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to make these modifications.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFanSetDefaultMode(
zes_fan_handle_t hFan ///< [in] Handle for the component.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Configure the fan to rotate at a fixed speed (set mode to
/// ::ZES_FAN_SPEED_MODE_FIXED)
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hFan`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == speed`
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to make these modifications.
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + Fixing the fan speed not supported by the hardware or the fan speed units are not supported. See the `supportedModes` and `supportedUnits` members of ::zes_fan_properties_t.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFanSetFixedSpeedMode(
zes_fan_handle_t hFan, ///< [in] Handle for the component.
const zes_fan_speed_t* speed ///< [in] The fixed fan speed setting
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Configure the fan to adjust speed based on a temperature/speed table
/// (set mode to ::ZES_FAN_SPEED_MODE_TABLE)
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hFan`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == speedTable`
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to make these modifications.
/// - ::ZE_RESULT_ERROR_INVALID_ARGUMENT
/// + The temperature/speed pairs in the array are not sorted on temperature from lowest to highest.
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + Fan speed table not supported by the hardware or the fan speed units are not supported. See the `supportedModes` and `supportedUnits` members of ::zes_fan_properties_t.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFanSetSpeedTableMode(
zes_fan_handle_t hFan, ///< [in] Handle for the component.
const zes_fan_speed_table_t* speedTable ///< [in] A table containing temperature/speed pairs.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get current state of a fan - current mode and speed
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hFan`
/// - ::ZE_RESULT_ERROR_INVALID_ENUMERATION
/// + `::ZES_FAN_SPEED_UNITS_PERCENT < units`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pSpeed`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + The requested fan speed units are not supported. See the `supportedUnits` member of ::zes_fan_properties_t.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFanGetState(
zes_fan_handle_t hFan, ///< [in] Handle for the component.
zes_fan_speed_units_t units, ///< [in] The units in which the fan speed should be returned.
int32_t* pSpeed ///< [in,out] Will contain the current speed of the fan in the units
///< requested. A value of -1 indicates that the fan speed cannot be
///< measured.
);
#if !defined(__GNUC__)
#pragma endregion
#endif
// Intel 'oneAPI' Level-Zero Tool APIs for System Resource Management (Sysman) - Firmware management
#if !defined(__GNUC__)
#pragma region firmware
#endif
///////////////////////////////////////////////////////////////////////////////
/// @brief Firmware properties
typedef struct _zes_firmware_properties_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
ze_bool_t onSubdevice; ///< [out] True if the resource is located on a sub-device; false means
///< that the resource is on the device of the calling Sysman handle
uint32_t subdeviceId; ///< [out] If onSubdevice is true, this gives the ID of the sub-device
ze_bool_t canControl; ///< [out] Indicates if software can flash the firmware assuming the user
///< has permissions
char name[ZES_STRING_PROPERTY_SIZE]; ///< [out] NULL terminated string value. The string "unknown" will be
///< returned if this property cannot be determined.
char version[ZES_STRING_PROPERTY_SIZE]; ///< [out] NULL terminated string value. The string "unknown" will be
///< returned if this property cannot be determined.
} zes_firmware_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Get handle of firmwares
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceEnumFirmwares(
zes_device_handle_t hDevice, ///< [in] Sysman handle of the device.
uint32_t* pCount, ///< [in,out] pointer to the number of components of this type.
///< if count is zero, then the driver shall update the value with the
///< total number of components of this type that are available.
///< if count is greater than the number of components of this type that
///< are available, then the driver shall update the value with the correct
///< number of components.
zes_firmware_handle_t* phFirmware ///< [in,out][optional][range(0, *pCount)] array of handle of components of
///< this type.
///< if count is less than the number of components of this type that are
///< available, then the driver shall only retrieve that number of
///< component handles.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get firmware properties
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hFirmware`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pProperties`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFirmwareGetProperties(
zes_firmware_handle_t hFirmware, ///< [in] Handle for the component.
zes_firmware_properties_t* pProperties ///< [in,out] Pointer to an array that will hold the properties of the
///< firmware
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Flash a new firmware image
///
/// @details
/// - Any running workload must be gracefully closed before invoking this
/// function.
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
/// - This is a non-blocking call. Application may call
/// ::zesFirmwareGetFlashProgress to get completion status.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hFirmware`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pImage`
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to perform this operation.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFirmwareFlash(
zes_firmware_handle_t hFirmware, ///< [in] Handle for the component.
void* pImage, ///< [in] Image of the new firmware to flash.
uint32_t size ///< [in] Size of the flash image.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get Firmware Flash Progress
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hFirmware`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCompletionPercent`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFirmwareGetFlashProgress(
zes_firmware_handle_t hFirmware, ///< [in] Handle for the component.
uint32_t* pCompletionPercent ///< [in,out] Pointer to the Completion Percentage of Firmware Update
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get Firmware Console Logs
///
/// @details
/// - The caller may pass nullptr for pFirmwareLog and set pSize to zero
/// when querying only for size.
/// - The caller must provide memory for Firmware log.
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hFirmware`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pSize`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFirmwareGetConsoleLogs(
zes_firmware_handle_t hFirmware, ///< [in] Handle for the component.
size_t* pSize, ///< [in,out] size of firmware log
char* pFirmwareLog ///< [in,out][optional] pointer to null-terminated string of the log.
);
#if !defined(__GNUC__)
#pragma endregion
#endif
// Intel 'oneAPI' Level-Zero Tool APIs for System Resource Management (Sysman) - Frequency domains
#if !defined(__GNUC__)
#pragma region frequency
#endif
///////////////////////////////////////////////////////////////////////////////
/// @brief Frequency domains.
typedef enum _zes_freq_domain_t
{
ZES_FREQ_DOMAIN_GPU = 0, ///< GPU Core Domain.
ZES_FREQ_DOMAIN_MEMORY = 1, ///< Local Memory Domain.
ZES_FREQ_DOMAIN_MEDIA = 2, ///< GPU Media Domain.
ZES_FREQ_DOMAIN_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_FREQ_DOMAIN_* ENUMs
} zes_freq_domain_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Frequency properties
///
/// @details
/// - Indicates if this frequency domain can be overclocked (if true,
/// functions such as ::zesFrequencyOcSetFrequencyTarget() are supported).
/// - The min/max hardware frequencies are specified for non-overclock
/// configurations. For overclock configurations, use
/// ::zesFrequencyOcGetFrequencyTarget() to determine the maximum
/// frequency that can be requested.
typedef struct _zes_freq_properties_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
zes_freq_domain_t type; ///< [out] The hardware block that this frequency domain controls (GPU,
///< memory, ...)
ze_bool_t onSubdevice; ///< [out] True if this resource is located on a sub-device; false means
///< that the resource is on the device of the calling Sysman handle
uint32_t subdeviceId; ///< [out] If onSubdevice is true, this gives the ID of the sub-device
ze_bool_t canControl; ///< [out] Indicates if software can control the frequency of this domain
///< assuming the user has permissions
ze_bool_t isThrottleEventSupported; ///< [out] Indicates if software can register to receive event
///< ::ZES_EVENT_TYPE_FLAG_FREQ_THROTTLED
double min; ///< [out] The minimum hardware clock frequency in units of MHz.
double max; ///< [out] The maximum non-overclock hardware clock frequency in units of
///< MHz.
} zes_freq_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Frequency range between which the hardware can operate.
///
/// @details
/// - When setting limits, they will be clamped to the hardware limits.
/// - When setting limits, ensure that the max frequency is greater than or
/// equal to the min frequency specified.
/// - When setting limits to return to factory settings, specify -1 for both
/// the min and max limit.
typedef struct _zes_freq_range_t
{
double min; ///< [in,out] The min frequency in MHz below which hardware frequency
///< management will not request frequencies. On input, setting to 0 will
///< permit the frequency to go down to the hardware minimum while setting
///< to -1 will return the min frequency limit to the factory value (can be
///< larger than the hardware min). On output, a negative value indicates
///< that no external minimum frequency limit is in effect.
double max; ///< [in,out] The max frequency in MHz above which hardware frequency
///< management will not request frequencies. On input, setting to 0 or a
///< very big number will permit the frequency to go all the way up to the
///< hardware maximum while setting to -1 will return the max frequency to
///< the factory value (which can be less than the hardware max). On
///< output, a negative number indicates that no external maximum frequency
///< limit is in effect.
} zes_freq_range_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Frequency throttle reasons
typedef uint32_t zes_freq_throttle_reason_flags_t;
typedef enum _zes_freq_throttle_reason_flag_t
{
ZES_FREQ_THROTTLE_REASON_FLAG_AVE_PWR_CAP = ZE_BIT(0), ///< frequency throttled due to average power excursion (PL1)
ZES_FREQ_THROTTLE_REASON_FLAG_BURST_PWR_CAP = ZE_BIT(1), ///< frequency throttled due to burst power excursion (PL2)
ZES_FREQ_THROTTLE_REASON_FLAG_CURRENT_LIMIT = ZE_BIT(2), ///< frequency throttled due to current excursion (PL4)
ZES_FREQ_THROTTLE_REASON_FLAG_THERMAL_LIMIT = ZE_BIT(3), ///< frequency throttled due to thermal excursion (T > TjMax)
ZES_FREQ_THROTTLE_REASON_FLAG_PSU_ALERT = ZE_BIT(4), ///< frequency throttled due to power supply assertion
ZES_FREQ_THROTTLE_REASON_FLAG_SW_RANGE = ZE_BIT(5), ///< frequency throttled due to software supplied frequency range
ZES_FREQ_THROTTLE_REASON_FLAG_HW_RANGE = ZE_BIT(6), ///< frequency throttled due to a sub block that has a lower frequency
///< range when it receives clocks
ZES_FREQ_THROTTLE_REASON_FLAG_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_FREQ_THROTTLE_REASON_FLAG_* ENUMs
} zes_freq_throttle_reason_flag_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Frequency state
typedef struct _zes_freq_state_t
{
zes_structure_type_t stype; ///< [in] type of this structure
const void* pNext; ///< [in][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
double currentVoltage; ///< [out] Current voltage in Volts. A negative value indicates that this
///< property is not known.
double request; ///< [out] The current frequency request in MHz. A negative value indicates
///< that this property is not known.
double tdp; ///< [out] The maximum frequency in MHz supported under the current TDP
///< conditions. This fluctuates dynamically based on the power and thermal
///< limits of the part. A negative value indicates that this property is
///< not known.
double efficient; ///< [out] The efficient minimum frequency in MHz. A negative value
///< indicates that this property is not known.
double actual; ///< [out] The resolved frequency in MHz. A negative value indicates that
///< this property is not known.
zes_freq_throttle_reason_flags_t throttleReasons; ///< [out] The reasons that the frequency is being limited by the hardware.
///< Returns 0 (frequency not throttled) or a combination of ::zes_freq_throttle_reason_flag_t.
} zes_freq_state_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Frequency throttle time snapshot
///
/// @details
/// - Percent time throttled is calculated by taking two snapshots (s1, s2)
/// and using the equation: %throttled = (s2.throttleTime -
/// s1.throttleTime) / (s2.timestamp - s1.timestamp)
typedef struct _zes_freq_throttle_time_t
{
uint64_t throttleTime; ///< [out] The monotonic counter of time in microseconds that the frequency
///< has been limited by the hardware.
uint64_t timestamp; ///< [out] Microsecond timestamp when throttleTime was captured.
///< This timestamp should only be used to calculate delta time between
///< snapshots of this structure.
///< Never take the delta of this timestamp with the timestamp from a
///< different structure since they are not guaranteed to have the same base.
///< The absolute value of the timestamp is only valid during within the
///< application and may be different on the next execution.
} zes_freq_throttle_time_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Overclocking modes
///
/// @details
/// - [DEPRECATED] No longer supported.
typedef enum _zes_oc_mode_t
{
ZES_OC_MODE_OFF = 0, ///< Overclocking if off - hardware is running using factory default
///< voltages/frequencies.
ZES_OC_MODE_OVERRIDE = 1, ///< Overclock override mode - In this mode, a fixed user-supplied voltage
///< is applied independent of the frequency request. The maximum permitted
///< frequency can also be increased. This mode disables INTERPOLATIVE and
///< FIXED modes.
ZES_OC_MODE_INTERPOLATIVE = 2, ///< Overclock interpolative mode - In this mode, the voltage/frequency
///< curve can be extended with a new voltage/frequency point that will be
///< interpolated. The existing voltage/frequency points can also be offset
///< (up or down) by a fixed voltage. This mode disables FIXED and OVERRIDE
///< modes.
ZES_OC_MODE_FIXED = 3, ///< Overclocking fixed Mode - In this mode, hardware will disable most
///< frequency throttling and lock the frequency and voltage at the
///< specified overclock values. This mode disables OVERRIDE and
///< INTERPOLATIVE modes. This mode can damage the part, most of the
///< protections are disabled on this mode.
ZES_OC_MODE_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_OC_MODE_* ENUMs
} zes_oc_mode_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Overclocking properties
///
/// @details
/// - Provides all the overclocking capabilities and properties supported by
/// the device for the frequency domain.
/// - [DEPRECATED] No longer supported.
typedef struct _zes_oc_capabilities_t
{
zes_structure_type_t stype; ///< [in] type of this structure
const void* pNext; ///< [in][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
ze_bool_t isOcSupported; ///< [out] Indicates if any overclocking features are supported on this
///< frequency domain.
double maxFactoryDefaultFrequency; ///< [out] Factory default non-overclock maximum frequency in Mhz.
double maxFactoryDefaultVoltage; ///< [out] Factory default voltage used for the non-overclock maximum
///< frequency in MHz.
double maxOcFrequency; ///< [out] Maximum hardware overclocking frequency limit in Mhz.
double minOcVoltageOffset; ///< [out] The minimum voltage offset that can be applied to the
///< voltage/frequency curve. Note that this number can be negative.
double maxOcVoltageOffset; ///< [out] The maximum voltage offset that can be applied to the
///< voltage/frequency curve.
double maxOcVoltage; ///< [out] The maximum overclock voltage that hardware supports.
ze_bool_t isTjMaxSupported; ///< [out] Indicates if the maximum temperature limit (TjMax) can be
///< changed for this frequency domain.
ze_bool_t isIccMaxSupported; ///< [out] Indicates if the maximum current (IccMax) can be changed for
///< this frequency domain.
ze_bool_t isHighVoltModeCapable; ///< [out] Indicates if this frequency domains supports a feature to set
///< very high voltages.
ze_bool_t isHighVoltModeEnabled; ///< [out] Indicates if very high voltages are permitted on this frequency
///< domain.
ze_bool_t isExtendedModeSupported; ///< [out] Indicates if the extended overclocking features are supported.
///< If this is supported, increments are on 1 Mhz basis.
ze_bool_t isFixedModeSupported; ///< [out] Indicates if the fixed mode is supported. In this mode, hardware
///< will disable most frequency throttling and lock the frequency and
///< voltage at the specified overclock values.
} zes_oc_capabilities_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Get handle of frequency domains
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceEnumFrequencyDomains(
zes_device_handle_t hDevice, ///< [in] Sysman handle of the device.
uint32_t* pCount, ///< [in,out] pointer to the number of components of this type.
///< if count is zero, then the driver shall update the value with the
///< total number of components of this type that are available.
///< if count is greater than the number of components of this type that
///< are available, then the driver shall update the value with the correct
///< number of components.
zes_freq_handle_t* phFrequency ///< [in,out][optional][range(0, *pCount)] array of handle of components of
///< this type.
///< if count is less than the number of components of this type that are
///< available, then the driver shall only retrieve that number of
///< component handles.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get frequency properties - available frequencies
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hFrequency`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pProperties`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFrequencyGetProperties(
zes_freq_handle_t hFrequency, ///< [in] Handle for the component.
zes_freq_properties_t* pProperties ///< [in,out] The frequency properties for the specified domain.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get available non-overclocked hardware clock frequencies for the
/// frequency domain
///
/// @details
/// - The list of available frequencies is returned in order of slowest to
/// fastest.
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hFrequency`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFrequencyGetAvailableClocks(
zes_freq_handle_t hFrequency, ///< [in] Sysman handle of the device.
uint32_t* pCount, ///< [in,out] pointer to the number of frequencies.
///< if count is zero, then the driver shall update the value with the
///< total number of frequencies that are available.
///< if count is greater than the number of frequencies that are available,
///< then the driver shall update the value with the correct number of frequencies.
double* phFrequency ///< [in,out][optional][range(0, *pCount)] array of frequencies in units of
///< MHz and sorted from slowest to fastest.
///< if count is less than the number of frequencies that are available,
///< then the driver shall only retrieve that number of frequencies.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get current frequency limits
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hFrequency`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pLimits`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFrequencyGetRange(
zes_freq_handle_t hFrequency, ///< [in] Handle for the component.
zes_freq_range_t* pLimits ///< [in,out] The range between which the hardware can operate for the
///< specified domain.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Set frequency range between which the hardware can operate.
///
/// @details
/// - The application may call this function with the frequency range min
/// and max values set to `-1` to request the frequency be (re)set to the
/// default values.
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hFrequency`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pLimits`
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to make these modifications.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFrequencySetRange(
zes_freq_handle_t hFrequency, ///< [in] Handle for the component.
const zes_freq_range_t* pLimits ///< [in] The limits between which the hardware can operate for the
///< specified domain.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get current frequency state - frequency request, actual frequency, TDP
/// limits
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hFrequency`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pState`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFrequencyGetState(
zes_freq_handle_t hFrequency, ///< [in] Handle for the component.
zes_freq_state_t* pState ///< [in,out] Frequency state for the specified domain.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get frequency throttle time
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hFrequency`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pThrottleTime`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFrequencyGetThrottleTime(
zes_freq_handle_t hFrequency, ///< [in] Handle for the component.
zes_freq_throttle_time_t* pThrottleTime ///< [in,out] Will contain a snapshot of the throttle time counters for the
///< specified domain.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get the overclocking capabilities.
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
/// - [DEPRECATED] No longer supported.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hFrequency`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pOcCapabilities`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFrequencyOcGetCapabilities(
zes_freq_handle_t hFrequency, ///< [in] Handle for the component.
zes_oc_capabilities_t* pOcCapabilities ///< [in,out] Pointer to the capabilities structure.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get the current overclocking frequency target, if extended moded is
/// supported, will returned in 1 Mhz granularity.
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
/// - [DEPRECATED] No longer supported.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hFrequency`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCurrentOcFrequency`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + Overclocking is not supported on this frequency domain (see the `isOcSupported` member of ::zes_oc_capabilities_t).
/// + The specified voltage and/or frequency overclock settings exceed the hardware values (see the `maxOcFrequency`, `maxOcVoltage`, `minOcVoltageOffset` and `maxOcVoltageOffset` members of ::zes_oc_capabilities_t).
/// + Requested voltage overclock is very high but the `isHighVoltModeEnabled` member of ::zes_oc_capabilities_t is not enabled for the device.
/// - ::ZE_RESULT_ERROR_NOT_AVAILABLE
/// + Overclocking feature is locked on this frequency domain.
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to make these modifications.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFrequencyOcGetFrequencyTarget(
zes_freq_handle_t hFrequency, ///< [in] Handle for the component.
double* pCurrentOcFrequency ///< [out] Overclocking Frequency in MHz, if extended moded is supported,
///< will returned in 1 Mhz granularity, else, in multiples of 50 Mhz. This
///< cannot be greater than the `maxOcFrequency` member of
///< ::zes_oc_capabilities_t.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Set the current overclocking frequency target, if extended moded is
/// supported, can be set in 1 Mhz granularity.
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
/// - [DEPRECATED] No longer supported.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hFrequency`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + Overclocking is not supported on this frequency domain (see the `isOcSupported` member of ::zes_oc_capabilities_t).
/// + The specified voltage and/or frequency overclock settings exceed the hardware values (see the `maxOcFrequency`, `maxOcVoltage`, `minOcVoltageOffset` and `maxOcVoltageOffset` members of ::zes_oc_capabilities_t).
/// + Requested voltage overclock is very high but the `isHighVoltModeEnabled` member of ::zes_oc_capabilities_t is not enabled for the device.
/// - ::ZE_RESULT_ERROR_NOT_AVAILABLE
/// + Overclocking feature is locked on this frequency domain.
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to make these modifications.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFrequencyOcSetFrequencyTarget(
zes_freq_handle_t hFrequency, ///< [in] Handle for the component.
double CurrentOcFrequency ///< [in] Overclocking Frequency in MHz, if extended moded is supported, it
///< could be set in 1 Mhz granularity, else, in multiples of 50 Mhz. This
///< cannot be greater than the `maxOcFrequency` member of
///< ::zes_oc_capabilities_t.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get the current overclocking voltage settings.
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
/// - [DEPRECATED] No longer supported.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hFrequency`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCurrentVoltageTarget`
/// + `nullptr == pCurrentVoltageOffset`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + Overclocking is not supported on this frequency domain (see the `isOcSupported` member of ::zes_oc_capabilities_t).
/// + The specified voltage and/or frequency overclock settings exceed the hardware values (see the `maxOcFrequency`, `maxOcVoltage`, `minOcVoltageOffset` and `maxOcVoltageOffset` members of ::zes_oc_capabilities_t).
/// + Requested voltage overclock is very high but the `isHighVoltModeEnabled` member of ::zes_oc_capabilities_t is not enabled for the device.
/// - ::ZE_RESULT_ERROR_NOT_AVAILABLE
/// + Overclocking feature is locked on this frequency domain.
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to make these modifications.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFrequencyOcGetVoltageTarget(
zes_freq_handle_t hFrequency, ///< [in] Handle for the component.
double* pCurrentVoltageTarget, ///< [out] Overclock voltage in Volts. This cannot be greater than the
///< `maxOcVoltage` member of ::zes_oc_capabilities_t.
double* pCurrentVoltageOffset ///< [out] This voltage offset is applied to all points on the
///< voltage/frequency curve, including the new overclock voltageTarget.
///< Valid range is between the `minOcVoltageOffset` and
///< `maxOcVoltageOffset` members of ::zes_oc_capabilities_t.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Set the current overclocking voltage settings.
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
/// - [DEPRECATED] No longer supported.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hFrequency`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + Overclocking is not supported on this frequency domain (see the `isOcSupported` member of ::zes_oc_capabilities_t).
/// + The specified voltage and/or frequency overclock settings exceed the hardware values (see the `maxOcFrequency`, `maxOcVoltage`, `minOcVoltageOffset` and `maxOcVoltageOffset` members of ::zes_oc_capabilities_t).
/// + Requested voltage overclock is very high but the `isHighVoltModeEnabled` member of ::zes_oc_capabilities_t is not enabled for the device.
/// - ::ZE_RESULT_ERROR_NOT_AVAILABLE
/// + Overclocking feature is locked on this frequency domain.
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to make these modifications.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFrequencyOcSetVoltageTarget(
zes_freq_handle_t hFrequency, ///< [in] Handle for the component.
double CurrentVoltageTarget, ///< [in] Overclock voltage in Volts. This cannot be greater than the
///< `maxOcVoltage` member of ::zes_oc_capabilities_t.
double CurrentVoltageOffset ///< [in] This voltage offset is applied to all points on the
///< voltage/frequency curve, include the new overclock voltageTarget.
///< Valid range is between the `minOcVoltageOffset` and
///< `maxOcVoltageOffset` members of ::zes_oc_capabilities_t.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Set the current overclocking mode.
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
/// - [DEPRECATED] No longer supported.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hFrequency`
/// - ::ZE_RESULT_ERROR_INVALID_ENUMERATION
/// + `::ZES_OC_MODE_FIXED < CurrentOcMode`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + Overclocking is not supported on this frequency domain (see the `isOcSupported` member of ::zes_oc_capabilities_t).
/// + The specified voltage and/or frequency overclock settings exceed the hardware values (see the `maxOcFrequency`, `maxOcVoltage`, `minOcVoltageOffset` and `maxOcVoltageOffset` members of ::zes_oc_capabilities_t).
/// + Requested voltage overclock is very high but the `isHighVoltModeEnabled` member of ::zes_oc_capabilities_t is not enabled for the device.
/// - ::ZE_RESULT_ERROR_NOT_AVAILABLE
/// + Overclocking feature is locked on this frequency domain.
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to make these modifications.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFrequencyOcSetMode(
zes_freq_handle_t hFrequency, ///< [in] Handle for the component.
zes_oc_mode_t CurrentOcMode ///< [in] Current Overclocking Mode ::zes_oc_mode_t.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get the current overclocking mode.
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
/// - [DEPRECATED] No longer supported.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hFrequency`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCurrentOcMode`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + Overclocking is not supported on this frequency domain (see the `isOcSupported` member of ::zes_oc_capabilities_t).
/// + The specified voltage and/or frequency overclock settings exceed the hardware values (see the `maxOcFrequency`, `maxOcVoltage`, `minOcVoltageOffset` and `maxOcVoltageOffset` members of ::zes_oc_capabilities_t).
/// + Requested voltage overclock is very high but the `isHighVoltModeEnabled` member of ::zes_oc_capabilities_t is not enabled for the device.
/// - ::ZE_RESULT_ERROR_NOT_AVAILABLE
/// + Overclocking feature is locked on this frequency domain.
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to make these modifications.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFrequencyOcGetMode(
zes_freq_handle_t hFrequency, ///< [in] Handle for the component.
zes_oc_mode_t* pCurrentOcMode ///< [out] Current Overclocking Mode ::zes_oc_mode_t.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get the maximum current limit setting.
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
/// - [DEPRECATED] No longer supported.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hFrequency`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pOcIccMax`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + Overclocking is not supported on this frequency domain (see the `isOcSupported` member of ::zes_oc_capabilities_t).
/// + Capability the `isIccMaxSupported` member of ::zes_oc_capabilities_t is false for this frequency domain.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFrequencyOcGetIccMax(
zes_freq_handle_t hFrequency, ///< [in] Handle for the component.
double* pOcIccMax ///< [in,out] Will contain the maximum current limit in Amperes on
///< successful return.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Change the maximum current limit setting.
///
/// @details
/// - Setting ocIccMax to 0.0 will return the value to the factory default.
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
/// - [DEPRECATED] No longer supported.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hFrequency`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + Overclocking is not supported on this frequency domain (see the `isOcSupported` member of ::zes_oc_capabilities_t).
/// + The `isIccMaxSupported` member of ::zes_oc_capabilities_t is false for this frequency domain.
/// - ::ZE_RESULT_ERROR_NOT_AVAILABLE
/// + Overclocking feature is locked on this frequency domain.
/// - ::ZE_RESULT_ERROR_INVALID_ARGUMENT
/// + The specified current limit is too low or too high.
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to make these modifications.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFrequencyOcSetIccMax(
zes_freq_handle_t hFrequency, ///< [in] Handle for the component.
double ocIccMax ///< [in] The new maximum current limit in Amperes.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get the maximum temperature limit setting.
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
/// - [DEPRECATED] No longer supported.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hFrequency`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pOcTjMax`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + Overclocking is not supported on this frequency domain (see the `isOcSupported` member of ::zes_oc_capabilities_t).
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFrequencyOcGetTjMax(
zes_freq_handle_t hFrequency, ///< [in] Handle for the component.
double* pOcTjMax ///< [in,out] Will contain the maximum temperature limit in degrees Celsius
///< on successful return.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Change the maximum temperature limit setting.
///
/// @details
/// - Setting ocTjMax to 0.0 will return the value to the factory default.
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
/// - [DEPRECATED] No longer supported.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hFrequency`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + Overclocking is not supported on this frequency domain (see the `isOcSupported` member of ::zes_oc_capabilities_t).
/// + The `isTjMaxSupported` member of ::zes_oc_capabilities_t is false for this frequency domain.
/// - ::ZE_RESULT_ERROR_NOT_AVAILABLE
/// + Overclocking feature is locked on this frequency domain.
/// - ::ZE_RESULT_ERROR_INVALID_ARGUMENT
/// + The specified temperature limit is too high.
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to make these modifications.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFrequencyOcSetTjMax(
zes_freq_handle_t hFrequency, ///< [in] Handle for the component.
double ocTjMax ///< [in] The new maximum temperature limit in degrees Celsius.
);
#if !defined(__GNUC__)
#pragma endregion
#endif
// Intel 'oneAPI' Level-Zero Tool APIs for System Resource Management (Sysman) - Firmware management
#if !defined(__GNUC__)
#pragma region led
#endif
///////////////////////////////////////////////////////////////////////////////
/// @brief LED properties
typedef struct _zes_led_properties_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
ze_bool_t onSubdevice; ///< [out] True if the resource is located on a sub-device; false means
///< that the resource is on the device of the calling Sysman handle
uint32_t subdeviceId; ///< [out] If onSubdevice is true, this gives the ID of the sub-device
ze_bool_t canControl; ///< [out] Indicates if software can control the LED assuming the user has
///< permissions
ze_bool_t haveRGB; ///< [out] Indicates if the LED is RGB capable
} zes_led_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief LED color
typedef struct _zes_led_color_t
{
double red; ///< [in,out][range(0.0, 1.0)] The LED red value. On output, a value less
///< than 0.0 indicates that the color is not known.
double green; ///< [in,out][range(0.0, 1.0)] The LED green value. On output, a value less
///< than 0.0 indicates that the color is not known.
double blue; ///< [in,out][range(0.0, 1.0)] The LED blue value. On output, a value less
///< than 0.0 indicates that the color is not known.
} zes_led_color_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief LED state
typedef struct _zes_led_state_t
{
zes_structure_type_t stype; ///< [in] type of this structure
const void* pNext; ///< [in][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
ze_bool_t isOn; ///< [out] Indicates if the LED is on or off
zes_led_color_t color; ///< [out] Color of the LED
} zes_led_state_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Get handle of LEDs
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceEnumLeds(
zes_device_handle_t hDevice, ///< [in] Sysman handle of the device.
uint32_t* pCount, ///< [in,out] pointer to the number of components of this type.
///< if count is zero, then the driver shall update the value with the
///< total number of components of this type that are available.
///< if count is greater than the number of components of this type that
///< are available, then the driver shall update the value with the correct
///< number of components.
zes_led_handle_t* phLed ///< [in,out][optional][range(0, *pCount)] array of handle of components of
///< this type.
///< if count is less than the number of components of this type that are
///< available, then the driver shall only retrieve that number of
///< component handles.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get LED properties
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hLed`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pProperties`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesLedGetProperties(
zes_led_handle_t hLed, ///< [in] Handle for the component.
zes_led_properties_t* pProperties ///< [in,out] Will contain the properties of the LED.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get current state of a LED - on/off, color
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hLed`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pState`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesLedGetState(
zes_led_handle_t hLed, ///< [in] Handle for the component.
zes_led_state_t* pState ///< [in,out] Will contain the current state of the LED.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Turn the LED on/off
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hLed`
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to make these modifications.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesLedSetState(
zes_led_handle_t hLed, ///< [in] Handle for the component.
ze_bool_t enable ///< [in] Set to TRUE to turn the LED on, FALSE to turn off.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Set the color of the LED
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hLed`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pColor`
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to make these modifications.
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + This LED doesn't not support color changes. See the `haveRGB` member of ::zes_led_properties_t.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesLedSetColor(
zes_led_handle_t hLed, ///< [in] Handle for the component.
const zes_led_color_t* pColor ///< [in] New color of the LED.
);
#if !defined(__GNUC__)
#pragma endregion
#endif
// Intel 'oneAPI' Level-Zero Tool APIs for System Resource Management (Sysman) - Memory management
#if !defined(__GNUC__)
#pragma region memory
#endif
///////////////////////////////////////////////////////////////////////////////
/// @brief Memory module types
typedef enum _zes_mem_type_t
{
ZES_MEM_TYPE_HBM = 0, ///< HBM memory
ZES_MEM_TYPE_DDR = 1, ///< DDR memory
ZES_MEM_TYPE_DDR3 = 2, ///< DDR3 memory
ZES_MEM_TYPE_DDR4 = 3, ///< DDR4 memory
ZES_MEM_TYPE_DDR5 = 4, ///< DDR5 memory
ZES_MEM_TYPE_LPDDR = 5, ///< LPDDR memory
ZES_MEM_TYPE_LPDDR3 = 6, ///< LPDDR3 memory
ZES_MEM_TYPE_LPDDR4 = 7, ///< LPDDR4 memory
ZES_MEM_TYPE_LPDDR5 = 8, ///< LPDDR5 memory
ZES_MEM_TYPE_SRAM = 9, ///< SRAM memory
ZES_MEM_TYPE_L1 = 10, ///< L1 cache
ZES_MEM_TYPE_L3 = 11, ///< L3 cache
ZES_MEM_TYPE_GRF = 12, ///< Execution unit register file
ZES_MEM_TYPE_SLM = 13, ///< Execution unit shared local memory
ZES_MEM_TYPE_GDDR4 = 14, ///< GDDR4 memory
ZES_MEM_TYPE_GDDR5 = 15, ///< GDDR5 memory
ZES_MEM_TYPE_GDDR5X = 16, ///< GDDR5X memory
ZES_MEM_TYPE_GDDR6 = 17, ///< GDDR6 memory
ZES_MEM_TYPE_GDDR6X = 18, ///< GDDR6X memory
ZES_MEM_TYPE_GDDR7 = 19, ///< GDDR7 memory
ZES_MEM_TYPE_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_MEM_TYPE_* ENUMs
} zes_mem_type_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Memory module location
typedef enum _zes_mem_loc_t
{
ZES_MEM_LOC_SYSTEM = 0, ///< System memory
ZES_MEM_LOC_DEVICE = 1, ///< On board local device memory
ZES_MEM_LOC_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_MEM_LOC_* ENUMs
} zes_mem_loc_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Memory health
typedef enum _zes_mem_health_t
{
ZES_MEM_HEALTH_UNKNOWN = 0, ///< The memory health cannot be determined.
ZES_MEM_HEALTH_OK = 1, ///< All memory channels are healthy.
ZES_MEM_HEALTH_DEGRADED = 2, ///< Excessive correctable errors have been detected on one or more
///< channels. Device should be reset.
ZES_MEM_HEALTH_CRITICAL = 3, ///< Operating with reduced memory to cover banks with too many
///< uncorrectable errors.
ZES_MEM_HEALTH_REPLACE = 4, ///< Device should be replaced due to excessive uncorrectable errors.
ZES_MEM_HEALTH_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_MEM_HEALTH_* ENUMs
} zes_mem_health_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Memory properties
typedef struct _zes_mem_properties_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
zes_mem_type_t type; ///< [out] The memory type
ze_bool_t onSubdevice; ///< [out] True if this resource is located on a sub-device; false means
///< that the resource is on the device of the calling Sysman handle
uint32_t subdeviceId; ///< [out] If onSubdevice is true, this gives the ID of the sub-device
zes_mem_loc_t location; ///< [out] Location of this memory (system, device)
uint64_t physicalSize; ///< [out] Physical memory size in bytes. A value of 0 indicates that this
///< property is not known. However, a call to ::zesMemoryGetState() will
///< correctly return the total size of usable memory.
int32_t busWidth; ///< [out] Width of the memory bus. A value of -1 means that this property
///< is unknown.
int32_t numChannels; ///< [out] The number of memory channels. A value of -1 means that this
///< property is unknown.
} zes_mem_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Memory state - health, allocated
///
/// @details
/// - Percent allocation is given by 100 * (size - free / size.
/// - Percent free is given by 100 * free / size.
typedef struct _zes_mem_state_t
{
zes_structure_type_t stype; ///< [in] type of this structure
const void* pNext; ///< [in][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
zes_mem_health_t health; ///< [out] Indicates the health of the memory
uint64_t free; ///< [out] The free memory in bytes
uint64_t size; ///< [out] The total allocatable memory in bytes (can be less than the
///< `physicalSize` member of ::zes_mem_properties_t)
} zes_mem_state_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Memory bandwidth
///
/// @details
/// - Percent bandwidth is calculated by taking two snapshots (s1, s2) and
/// using the equation: %bw = 10^6 * ((s2.readCounter - s1.readCounter) +
/// (s2.writeCounter - s1.writeCounter)) / (s2.maxBandwidth *
/// (s2.timestamp - s1.timestamp))
/// - Counter can roll over and rollover needs to be handled by comparing
/// the current read against the previous read
/// - Counter is a 32 byte transaction count, which means the calculated
/// delta (delta = current_value - previous_value or delta = 2^32 -
/// previous_value + current_value in case of rollover) needs to be
/// multiplied by 32 to get delta between samples in actual byte count
typedef struct _zes_mem_bandwidth_t
{
uint64_t readCounter; ///< [out] Total bytes read from memory
uint64_t writeCounter; ///< [out] Total bytes written to memory
uint64_t maxBandwidth; ///< [out] Current maximum bandwidth in units of bytes/sec
uint64_t timestamp; ///< [out] The timestamp in microseconds when these measurements were sampled.
///< This timestamp should only be used to calculate delta time between
///< snapshots of this structure.
///< Never take the delta of this timestamp with the timestamp from a
///< different structure since they are not guaranteed to have the same base.
///< The absolute value of the timestamp is only valid during within the
///< application and may be different on the next execution.
} zes_mem_bandwidth_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Extension properties for Memory bandwidth
///
/// @details
/// - Number of counter bits
/// - [DEPRECATED] No longer supported.
typedef struct _zes_mem_ext_bandwidth_t
{
uint32_t memoryTimestampValidBits; ///< [out] Returns the number of valid bits in the timestamp values
} zes_mem_ext_bandwidth_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Get handle of memory modules
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceEnumMemoryModules(
zes_device_handle_t hDevice, ///< [in] Sysman handle of the device.
uint32_t* pCount, ///< [in,out] pointer to the number of components of this type.
///< if count is zero, then the driver shall update the value with the
///< total number of components of this type that are available.
///< if count is greater than the number of components of this type that
///< are available, then the driver shall update the value with the correct
///< number of components.
zes_mem_handle_t* phMemory ///< [in,out][optional][range(0, *pCount)] array of handle of components of
///< this type.
///< if count is less than the number of components of this type that are
///< available, then the driver shall only retrieve that number of
///< component handles.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get memory properties
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hMemory`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pProperties`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesMemoryGetProperties(
zes_mem_handle_t hMemory, ///< [in] Handle for the component.
zes_mem_properties_t* pProperties ///< [in,out] Will contain memory properties.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get memory state - health, allocated
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hMemory`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pState`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesMemoryGetState(
zes_mem_handle_t hMemory, ///< [in] Handle for the component.
zes_mem_state_t* pState ///< [in,out] Will contain the current health and allocated memory.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get memory bandwidth
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hMemory`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pBandwidth`
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to query this telemetry.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesMemoryGetBandwidth(
zes_mem_handle_t hMemory, ///< [in] Handle for the component.
zes_mem_bandwidth_t* pBandwidth ///< [in,out] Will contain the total number of bytes read from and written
///< to memory, as well as the current maximum bandwidth.
);
#if !defined(__GNUC__)
#pragma endregion
#endif
// Intel 'oneAPI' Level-Zero Tool APIs for System Resource Management (Sysman) - Performance factor
#if !defined(__GNUC__)
#pragma region performance
#endif
///////////////////////////////////////////////////////////////////////////////
/// @brief Static information about a Performance Factor domain
typedef struct _zes_perf_properties_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
ze_bool_t onSubdevice; ///< [out] True if this Performance Factor affects accelerators located on
///< a sub-device
uint32_t subdeviceId; ///< [out] If onSubdevice is true, this gives the ID of the sub-device
zes_engine_type_flags_t engines; ///< [out] Bitfield of accelerator engine types that are affected by this
///< Performance Factor.
} zes_perf_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Get handles to accelerator domains whose performance can be optimized
/// via a Performance Factor
///
/// @details
/// - A Performance Factor should be tuned for each workload.
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceEnumPerformanceFactorDomains(
zes_device_handle_t hDevice, ///< [in] Sysman handle of the device.
uint32_t* pCount, ///< [in,out] pointer to the number of components of this type.
///< if count is zero, then the driver shall update the value with the
///< total number of components of this type that are available.
///< if count is greater than the number of components of this type that
///< are available, then the driver shall update the value with the correct
///< number of components.
zes_perf_handle_t* phPerf ///< [in,out][optional][range(0, *pCount)] array of handle of components of
///< this type.
///< if count is less than the number of components of this type that are
///< available, then the driver shall only retrieve that number of
///< component handles.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get properties about a Performance Factor domain
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hPerf`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pProperties`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesPerformanceFactorGetProperties(
zes_perf_handle_t hPerf, ///< [in] Handle for the Performance Factor domain.
zes_perf_properties_t* pProperties ///< [in,out] Will contain information about the specified Performance
///< Factor domain.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get current Performance Factor for a given domain
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hPerf`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pFactor`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesPerformanceFactorGetConfig(
zes_perf_handle_t hPerf, ///< [in] Handle for the Performance Factor domain.
double* pFactor ///< [in,out] Will contain the actual Performance Factor being used by the
///< hardware (may not be the same as the requested Performance Factor).
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Change the performance factor for a domain
///
/// @details
/// - The Performance Factor is a number between 0 and 100.
/// - A Performance Factor is a hint to the hardware. Depending on the
/// hardware, the request may not be granted. Follow up this function with
/// a call to ::zesPerformanceFactorGetConfig() to determine the actual
/// factor being used by the hardware.
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hPerf`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesPerformanceFactorSetConfig(
zes_perf_handle_t hPerf, ///< [in] Handle for the Performance Factor domain.
double factor ///< [in] The new Performance Factor.
);
#if !defined(__GNUC__)
#pragma endregion
#endif
// Intel 'oneAPI' Level-Zero Tool APIs for System Resource Management (Sysman) - Scheduler management
#if !defined(__GNUC__)
#pragma region power
#endif
///////////////////////////////////////////////////////////////////////////////
/// @brief Power Domain
typedef enum _zes_power_domain_t
{
ZES_POWER_DOMAIN_UNKNOWN = 0, ///< The PUnit power domain level cannot be determined.
ZES_POWER_DOMAIN_CARD = 1, ///< The PUnit power domain is a card-level power domain.
ZES_POWER_DOMAIN_PACKAGE = 2, ///< The PUnit power domain is a package-level power domain.
ZES_POWER_DOMAIN_STACK = 3, ///< The PUnit power domain is a stack-level power domain.
ZES_POWER_DOMAIN_MEMORY = 4, ///< The PUnit power domain is a memory-level power domain.
ZES_POWER_DOMAIN_GPU = 5, ///< The PUnit power domain is a GPU-level power domain.
ZES_POWER_DOMAIN_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_POWER_DOMAIN_* ENUMs
} zes_power_domain_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Power Level Type
typedef enum _zes_power_level_t
{
ZES_POWER_LEVEL_UNKNOWN = 0, ///< The PUnit power monitoring duration cannot be determined.
ZES_POWER_LEVEL_SUSTAINED = 1, ///< The PUnit determines effective power draw by computing a moving
///< average of the actual power draw over a time interval (longer than
///< BURST).
ZES_POWER_LEVEL_BURST = 2, ///< The PUnit determines effective power draw by computing a moving
///< average of the actual power draw over a time interval (longer than
///< PEAK).
ZES_POWER_LEVEL_PEAK = 3, ///< The PUnit determines effective power draw by computing a moving
///< average of the actual power draw over a very short time interval.
ZES_POWER_LEVEL_INSTANTANEOUS = 4, ///< The PUnit predicts effective power draw using the current device
///< configuration (frequency, voltage, etc...) & throttles proactively to
///< stay within the specified limit.
ZES_POWER_LEVEL_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_POWER_LEVEL_* ENUMs
} zes_power_level_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Power Source Type
typedef enum _zes_power_source_t
{
ZES_POWER_SOURCE_ANY = 0, ///< Limit active no matter whether the power source is mains powered or
///< battery powered.
ZES_POWER_SOURCE_MAINS = 1, ///< Limit active only when the device is mains powered.
ZES_POWER_SOURCE_BATTERY = 2, ///< Limit active only when the device is battery powered.
ZES_POWER_SOURCE_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_POWER_SOURCE_* ENUMs
} zes_power_source_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Limit Unit
typedef enum _zes_limit_unit_t
{
ZES_LIMIT_UNIT_UNKNOWN = 0, ///< The PUnit power monitoring unit cannot be determined.
ZES_LIMIT_UNIT_CURRENT = 1, ///< The limit is specified in milliamperes of current drawn.
ZES_LIMIT_UNIT_POWER = 2, ///< The limit is specified in milliwatts of power generated.
ZES_LIMIT_UNIT_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_LIMIT_UNIT_* ENUMs
} zes_limit_unit_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Properties related to device power settings
typedef struct _zes_power_properties_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
ze_bool_t onSubdevice; ///< [out] True if this resource is located on a sub-device; false means
///< that the resource is on the device of the calling Sysman handle
uint32_t subdeviceId; ///< [out] If onSubdevice is true, this gives the ID of the sub-device
ze_bool_t canControl; ///< [out] Software can change the power limits of this domain assuming the
///< user has permissions.
ze_bool_t isEnergyThresholdSupported; ///< [out] Indicates if this power domain supports the energy threshold
///< event (::ZES_EVENT_TYPE_FLAG_ENERGY_THRESHOLD_CROSSED).
int32_t defaultLimit; ///< [out] (Deprecated) The factory default TDP power limit of the part in
///< milliwatts. A value of -1 means that this is not known.
int32_t minLimit; ///< [out] (Deprecated) The minimum power limit in milliwatts that can be
///< requested. A value of -1 means that this is not known.
int32_t maxLimit; ///< [out] (Deprecated) The maximum power limit in milliwatts that can be
///< requested. A value of -1 means that this is not known.
} zes_power_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Energy counter snapshot
///
/// @details
/// - Average power is calculated by taking two snapshots (s1, s2) and using
/// the equation: PowerWatts = (s2.energy - s1.energy) / (s2.timestamp -
/// s1.timestamp)
typedef struct _zes_power_energy_counter_t
{
uint64_t energy; ///< [out] The monotonic energy counter in microjoules.
uint64_t timestamp; ///< [out] Microsecond timestamp when energy was captured.
///< This timestamp should only be used to calculate delta time between
///< snapshots of this structure.
///< Never take the delta of this timestamp with the timestamp from a
///< different structure since they are not guaranteed to have the same base.
///< The absolute value of the timestamp is only valid during within the
///< application and may be different on the next execution.
} zes_power_energy_counter_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Sustained power limits
///
/// @details
/// - The power controller (Punit) will throttle the operating frequency if
/// the power averaged over a window (typically seconds) exceeds this
/// limit.
/// - [DEPRECATED] No longer supported.
typedef struct _zes_power_sustained_limit_t
{
ze_bool_t enabled; ///< [in,out] indicates if the limit is enabled (true) or ignored (false)
int32_t power; ///< [in,out] power limit in milliwatts
int32_t interval; ///< [in,out] power averaging window (Tau) in milliseconds
} zes_power_sustained_limit_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Burst power limit
///
/// @details
/// - The power controller (Punit) will throttle the operating frequency of
/// the device if the power averaged over a few milliseconds exceeds a
/// limit known as PL2. Typically PL2 > PL1 so that it permits the
/// frequency to burst higher for short periods than would be otherwise
/// permitted by PL1.
/// - [DEPRECATED] No longer supported.
typedef struct _zes_power_burst_limit_t
{
ze_bool_t enabled; ///< [in,out] indicates if the limit is enabled (true) or ignored (false)
int32_t power; ///< [in,out] power limit in milliwatts
} zes_power_burst_limit_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Peak power limit
///
/// @details
/// - The power controller (Punit) will reactively/proactively throttle the
/// operating frequency of the device when the instantaneous/100usec power
/// exceeds this limit. The limit is known as PL4 or Psys. It expresses
/// the maximum power that can be drawn from the power supply.
/// - If this power limit is removed or set too high, the power supply will
/// generate an interrupt when it detects an overcurrent condition and the
/// power controller will throttle the device frequencies down to min. It
/// is thus better to tune the PL4 value in order to avoid such
/// excursions.
/// - [DEPRECATED] No longer supported.
typedef struct _zes_power_peak_limit_t
{
int32_t powerAC; ///< [in,out] power limit in milliwatts for the AC power source.
int32_t powerDC; ///< [in,out] power limit in milliwatts for the DC power source. On input,
///< this is ignored if the product does not have a battery. On output,
///< this will be -1 if the product does not have a battery.
} zes_power_peak_limit_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Energy threshold
///
/// @details
/// - .
typedef struct _zes_energy_threshold_t
{
ze_bool_t enable; ///< [in,out] Indicates if the energy threshold is enabled.
double threshold; ///< [in,out] The energy threshold in Joules. Will be 0.0 if no threshold
///< has been set.
uint32_t processId; ///< [in,out] The host process ID that set the energy threshold. Will be
///< 0xFFFFFFFF if no threshold has been set.
} zes_energy_threshold_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Get handle of power domains
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceEnumPowerDomains(
zes_device_handle_t hDevice, ///< [in] Sysman handle of the device.
uint32_t* pCount, ///< [in,out] pointer to the number of components of this type.
///< if count is zero, then the driver shall update the value with the
///< total number of components of this type that are available.
///< if count is greater than the number of components of this type that
///< are available, then the driver shall update the value with the correct
///< number of components.
zes_pwr_handle_t* phPower ///< [in,out][optional][range(0, *pCount)] array of handle of components of
///< this type.
///< if count is less than the number of components of this type that are
///< available, then the driver shall only retrieve that number of
///< component handles.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get handle of the PCIe card-level power
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
/// - [DEPRECATED] No longer supported.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == phPower`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + The device does not provide access to card level power controls or telemetry. An invalid power domain handle will be returned in phPower.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceGetCardPowerDomain(
zes_device_handle_t hDevice, ///< [in] Sysman handle of the device.
zes_pwr_handle_t* phPower ///< [in,out] power domain handle for the entire PCIe card.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get properties related to a power domain
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hPower`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pProperties`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesPowerGetProperties(
zes_pwr_handle_t hPower, ///< [in] Handle for the component.
zes_power_properties_t* pProperties ///< [in,out] Structure that will contain property data.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get energy counter
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hPower`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pEnergy`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesPowerGetEnergyCounter(
zes_pwr_handle_t hPower, ///< [in] Handle for the component.
zes_power_energy_counter_t* pEnergy ///< [in,out] Will contain the latest snapshot of the energy counter and
///< timestamp when the last counter value was measured.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get power limits
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
/// - [DEPRECATED] Use ::zesPowerGetLimitsExt.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hPower`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesPowerGetLimits(
zes_pwr_handle_t hPower, ///< [in] Handle for the component.
zes_power_sustained_limit_t* pSustained, ///< [in,out][optional] The sustained power limit. If this is null, the
///< current sustained power limits will not be returned.
zes_power_burst_limit_t* pBurst, ///< [in,out][optional] The burst power limit. If this is null, the current
///< peak power limits will not be returned.
zes_power_peak_limit_t* pPeak ///< [in,out][optional] The peak power limit. If this is null, the peak
///< power limits will not be returned.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Set power limits
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
/// - [DEPRECATED] Use ::zesPowerSetLimitsExt.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hPower`
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to make these modifications.
/// - ::ZE_RESULT_ERROR_NOT_AVAILABLE
/// + The device is in use, meaning that the GPU is under Over clocking, applying power limits under overclocking is not supported.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesPowerSetLimits(
zes_pwr_handle_t hPower, ///< [in] Handle for the component.
const zes_power_sustained_limit_t* pSustained, ///< [in][optional] The sustained power limit. If this is null, no changes
///< will be made to the sustained power limits.
const zes_power_burst_limit_t* pBurst, ///< [in][optional] The burst power limit. If this is null, no changes will
///< be made to the burst power limits.
const zes_power_peak_limit_t* pPeak ///< [in][optional] The peak power limit. If this is null, no changes will
///< be made to the peak power limits.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get energy threshold
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hPower`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pThreshold`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + Energy threshold not supported on this power domain (check the `isEnergyThresholdSupported` member of ::zes_power_properties_t).
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to request this feature.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesPowerGetEnergyThreshold(
zes_pwr_handle_t hPower, ///< [in] Handle for the component.
zes_energy_threshold_t* pThreshold ///< [in,out] Returns information about the energy threshold setting -
///< enabled/energy threshold/process ID.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Set energy threshold
///
/// @details
/// - An event ::ZES_EVENT_TYPE_FLAG_ENERGY_THRESHOLD_CROSSED will be
/// generated when the delta energy consumed starting from this call
/// exceeds the specified threshold. Use the function
/// ::zesDeviceEventRegister() to start receiving the event.
/// - Only one running process can control the energy threshold at a given
/// time. If another process attempts to change the energy threshold, the
/// error ::ZE_RESULT_ERROR_NOT_AVAILABLE will be returned. The function
/// ::zesPowerGetEnergyThreshold() to determine the process ID currently
/// controlling this setting.
/// - Calling this function will remove any pending energy thresholds and
/// start counting from the time of this call.
/// - Once the energy threshold has been reached and the event generated,
/// the threshold is automatically removed. It is up to the application to
/// request a new threshold.
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hPower`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + Energy threshold not supported on this power domain (check the `isEnergyThresholdSupported` member of ::zes_power_properties_t).
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to request this feature.
/// - ::ZE_RESULT_ERROR_NOT_AVAILABLE
/// + Another running process has set the energy threshold.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesPowerSetEnergyThreshold(
zes_pwr_handle_t hPower, ///< [in] Handle for the component.
double threshold ///< [in] The energy threshold to be set in joules.
);
#if !defined(__GNUC__)
#pragma endregion
#endif
// Intel 'oneAPI' Level-Zero Tool APIs for System Resource Management (Sysman) - Firmware management
#if !defined(__GNUC__)
#pragma region psu
#endif
///////////////////////////////////////////////////////////////////////////////
/// @brief PSU voltage status
typedef enum _zes_psu_voltage_status_t
{
ZES_PSU_VOLTAGE_STATUS_UNKNOWN = 0, ///< The status of the power supply voltage controllers cannot be
///< determined
ZES_PSU_VOLTAGE_STATUS_NORMAL = 1, ///< No unusual voltages have been detected
ZES_PSU_VOLTAGE_STATUS_OVER = 2, ///< Over-voltage has occurred
ZES_PSU_VOLTAGE_STATUS_UNDER = 3, ///< Under-voltage has occurred
ZES_PSU_VOLTAGE_STATUS_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_PSU_VOLTAGE_STATUS_* ENUMs
} zes_psu_voltage_status_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Static properties of the power supply
typedef struct _zes_psu_properties_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
ze_bool_t onSubdevice; ///< [out] True if the resource is located on a sub-device; false means
///< that the resource is on the device of the calling Sysman handle
uint32_t subdeviceId; ///< [out] If onSubdevice is true, this gives the ID of the sub-device
ze_bool_t haveFan; ///< [out] True if the power supply has a fan
int32_t ampLimit; ///< [out] The maximum electrical current in milliamperes that can be
///< drawn. A value of -1 indicates that this property cannot be
///< determined.
} zes_psu_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Dynamic state of the power supply
typedef struct _zes_psu_state_t
{
zes_structure_type_t stype; ///< [in] type of this structure
const void* pNext; ///< [in][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
zes_psu_voltage_status_t voltStatus; ///< [out] The current PSU voltage status
ze_bool_t fanFailed; ///< [out] Indicates if the fan has failed
int32_t temperature; ///< [out] Read the current heatsink temperature in degrees Celsius. A
///< value of -1 indicates that this property cannot be determined.
int32_t current; ///< [out] The amps being drawn in milliamperes. A value of -1 indicates
///< that this property cannot be determined.
} zes_psu_state_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Get handle of power supplies
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceEnumPsus(
zes_device_handle_t hDevice, ///< [in] Sysman handle of the device.
uint32_t* pCount, ///< [in,out] pointer to the number of components of this type.
///< if count is zero, then the driver shall update the value with the
///< total number of components of this type that are available.
///< if count is greater than the number of components of this type that
///< are available, then the driver shall update the value with the correct
///< number of components.
zes_psu_handle_t* phPsu ///< [in,out][optional][range(0, *pCount)] array of handle of components of
///< this type.
///< if count is less than the number of components of this type that are
///< available, then the driver shall only retrieve that number of
///< component handles.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get power supply properties
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hPsu`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pProperties`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesPsuGetProperties(
zes_psu_handle_t hPsu, ///< [in] Handle for the component.
zes_psu_properties_t* pProperties ///< [in,out] Will contain the properties of the power supply.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get current power supply state
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hPsu`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pState`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesPsuGetState(
zes_psu_handle_t hPsu, ///< [in] Handle for the component.
zes_psu_state_t* pState ///< [in,out] Will contain the current state of the power supply.
);
#if !defined(__GNUC__)
#pragma endregion
#endif
// Intel 'oneAPI' Level-Zero Tool APIs for System Resource Management (Sysman) - Firmware management
#if !defined(__GNUC__)
#pragma region ras
#endif
///////////////////////////////////////////////////////////////////////////////
/// @brief RAS error type
typedef enum _zes_ras_error_type_t
{
ZES_RAS_ERROR_TYPE_CORRECTABLE = 0, ///< Errors were corrected by hardware
ZES_RAS_ERROR_TYPE_UNCORRECTABLE = 1, ///< Error were not corrected
ZES_RAS_ERROR_TYPE_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_RAS_ERROR_TYPE_* ENUMs
} zes_ras_error_type_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief RAS error categories
typedef enum _zes_ras_error_cat_t
{
ZES_RAS_ERROR_CAT_RESET = 0, ///< The number of accelerator engine resets attempted by the driver
ZES_RAS_ERROR_CAT_PROGRAMMING_ERRORS = 1, ///< The number of hardware exceptions generated by the way workloads have
///< programmed the hardware
ZES_RAS_ERROR_CAT_DRIVER_ERRORS = 2, ///< The number of low level driver communication errors have occurred
ZES_RAS_ERROR_CAT_COMPUTE_ERRORS = 3, ///< The number of errors that have occurred in the compute accelerator
///< hardware
ZES_RAS_ERROR_CAT_NON_COMPUTE_ERRORS = 4, ///< The number of errors that have occurred in the fixed-function
///< accelerator hardware
ZES_RAS_ERROR_CAT_CACHE_ERRORS = 5, ///< The number of errors that have occurred in caches (L1/L3/register
///< file/shared local memory/sampler)
ZES_RAS_ERROR_CAT_DISPLAY_ERRORS = 6, ///< The number of errors that have occurred in the display
ZES_RAS_ERROR_CAT_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_RAS_ERROR_CAT_* ENUMs
} zes_ras_error_cat_t;
///////////////////////////////////////////////////////////////////////////////
#ifndef ZES_MAX_RAS_ERROR_CATEGORY_COUNT
/// @brief The maximum number of categories
#define ZES_MAX_RAS_ERROR_CATEGORY_COUNT 7
#endif // ZES_MAX_RAS_ERROR_CATEGORY_COUNT
///////////////////////////////////////////////////////////////////////////////
/// @brief RAS properties
typedef struct _zes_ras_properties_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
zes_ras_error_type_t type; ///< [out] The type of RAS error
ze_bool_t onSubdevice; ///< [out] True if the resource is located on a sub-device; false means
///< that the resource is on the device of the calling Sysman handle
uint32_t subdeviceId; ///< [out] If onSubdevice is true, this gives the ID of the sub-device
} zes_ras_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief RAS error details
typedef struct _zes_ras_state_t
{
zes_structure_type_t stype; ///< [in] type of this structure
const void* pNext; ///< [in][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
uint64_t category[ZES_MAX_RAS_ERROR_CATEGORY_COUNT]; ///< [in][out] Breakdown of error by category
} zes_ras_state_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief RAS error configuration - thresholds used for triggering RAS events
/// (::ZES_EVENT_TYPE_FLAG_RAS_CORRECTABLE_ERRORS,
/// ::ZES_EVENT_TYPE_FLAG_RAS_UNCORRECTABLE_ERRORS)
///
/// @details
/// - The driver maintains a total counter which is updated every time a
/// hardware block covered by the corresponding RAS error set notifies
/// that an error has occurred. When this total count goes above the
/// totalThreshold specified below, a RAS event is triggered.
/// - The driver also maintains a counter for each category of RAS error
/// (see ::zes_ras_state_t for a breakdown). Each time a hardware block of
/// that category notifies that an error has occurred, that corresponding
/// category counter is updated. When it goes above the threshold
/// specified in detailedThresholds, a RAS event is triggered.
typedef struct _zes_ras_config_t
{
zes_structure_type_t stype; ///< [in] type of this structure
const void* pNext; ///< [in][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
uint64_t totalThreshold; ///< [in,out] If the total RAS errors exceeds this threshold, the event
///< will be triggered. A value of 0ULL disables triggering the event based
///< on the total counter.
zes_ras_state_t detailedThresholds; ///< [in,out] If the RAS errors for each category exceed the threshold for
///< that category, the event will be triggered. A value of 0ULL will
///< disable an event being triggered for that category.
} zes_ras_config_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Get handle of all RAS error sets on a device
///
/// @details
/// - A RAS error set is a collection of RAS error counters of a given type
/// (correctable/uncorrectable) from hardware blocks contained within a
/// sub-device or within the device.
/// - A device without sub-devices will typically return two handles, one
/// for correctable errors sets and one for uncorrectable error sets.
/// - A device with sub-devices will return RAS error sets for each
/// sub-device and possibly RAS error sets for hardware blocks outside the
/// sub-devices.
/// - If the function completes successfully but pCount is set to 0, RAS
/// features are not available/enabled on this device.
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceEnumRasErrorSets(
zes_device_handle_t hDevice, ///< [in] Sysman handle of the device.
uint32_t* pCount, ///< [in,out] pointer to the number of components of this type.
///< if count is zero, then the driver shall update the value with the
///< total number of components of this type that are available.
///< if count is greater than the number of components of this type that
///< are available, then the driver shall update the value with the correct
///< number of components.
zes_ras_handle_t* phRas ///< [in,out][optional][range(0, *pCount)] array of handle of components of
///< this type.
///< if count is less than the number of components of this type that are
///< available, then the driver shall only retrieve that number of
///< component handles.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get RAS properties of a given RAS error set - this enables discovery
/// of the type of RAS error set (correctable/uncorrectable) and if
/// located on a sub-device
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hRas`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pProperties`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesRasGetProperties(
zes_ras_handle_t hRas, ///< [in] Handle for the component.
zes_ras_properties_t* pProperties ///< [in,out] Structure describing RAS properties
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get RAS error thresholds that control when RAS events are generated
///
/// @details
/// - The driver maintains counters for all RAS error sets and error
/// categories. Events are generated when errors occur. The configuration
/// enables setting thresholds to limit when events are sent.
/// - When a particular RAS correctable error counter exceeds the configured
/// threshold, the event ::ZES_EVENT_TYPE_FLAG_RAS_CORRECTABLE_ERRORS will
/// be triggered.
/// - When a particular RAS uncorrectable error counter exceeds the
/// configured threshold, the event
/// ::ZES_EVENT_TYPE_FLAG_RAS_UNCORRECTABLE_ERRORS will be triggered.
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hRas`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pConfig`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesRasGetConfig(
zes_ras_handle_t hRas, ///< [in] Handle for the component.
zes_ras_config_t* pConfig ///< [in,out] Will be populed with the current RAS configuration -
///< thresholds used to trigger events
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Set RAS error thresholds that control when RAS events are generated
///
/// @details
/// - The driver maintains counters for all RAS error sets and error
/// categories. Events are generated when errors occur. The configuration
/// enables setting thresholds to limit when events are sent.
/// - When a particular RAS correctable error counter exceeds the specified
/// threshold, the event ::ZES_EVENT_TYPE_FLAG_RAS_CORRECTABLE_ERRORS will
/// be generated.
/// - When a particular RAS uncorrectable error counter exceeds the
/// specified threshold, the event
/// ::ZES_EVENT_TYPE_FLAG_RAS_UNCORRECTABLE_ERRORS will be generated.
/// - Call ::zesRasGetState() and set the clear flag to true to restart
/// event generation once counters have exceeded thresholds.
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hRas`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pConfig`
/// - ::ZE_RESULT_ERROR_NOT_AVAILABLE
/// + Another running process is controlling these settings.
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + Don't have permissions to set thresholds.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesRasSetConfig(
zes_ras_handle_t hRas, ///< [in] Handle for the component.
const zes_ras_config_t* pConfig ///< [in] Change the RAS configuration - thresholds used to trigger events
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get the current value of RAS error counters for a particular error set
///
/// @details
/// - Clearing errors will affect other threads/applications - the counter
/// values will start from zero.
/// - Clearing errors requires write permissions.
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hRas`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pState`
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + Don't have permissions to clear error counters.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesRasGetState(
zes_ras_handle_t hRas, ///< [in] Handle for the component.
ze_bool_t clear, ///< [in] Set to 1 to clear the counters of this type
zes_ras_state_t* pState ///< [in,out] Breakdown of where errors have occurred
);
#if !defined(__GNUC__)
#pragma endregion
#endif
// Intel 'oneAPI' Level-Zero Tool APIs for System Resource Management (Sysman) - Scheduler management
#if !defined(__GNUC__)
#pragma region scheduler
#endif
///////////////////////////////////////////////////////////////////////////////
/// @brief Scheduler mode
typedef enum _zes_sched_mode_t
{
ZES_SCHED_MODE_TIMEOUT = 0, ///< Multiple applications or contexts are submitting work to the hardware.
///< When higher priority work arrives, the scheduler attempts to pause the
///< current executing work within some timeout interval, then submits the
///< other work.
ZES_SCHED_MODE_TIMESLICE = 1, ///< The scheduler attempts to fairly timeslice hardware execution time
///< between multiple contexts submitting work to the hardware
///< concurrently.
ZES_SCHED_MODE_EXCLUSIVE = 2, ///< Any application or context can run indefinitely on the hardware
///< without being preempted or terminated. All pending work for other
///< contexts must wait until the running context completes with no further
///< submitted work.
ZES_SCHED_MODE_COMPUTE_UNIT_DEBUG = 3, ///< [DEPRECATED] No longer supported.
ZES_SCHED_MODE_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_SCHED_MODE_* ENUMs
} zes_sched_mode_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Properties related to scheduler component
typedef struct _zes_sched_properties_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
ze_bool_t onSubdevice; ///< [out] True if this resource is located on a sub-device; false means
///< that the resource is on the device of the calling Sysman handle
uint32_t subdeviceId; ///< [out] If onSubdevice is true, this gives the ID of the sub-device
ze_bool_t canControl; ///< [out] Software can change the scheduler component configuration
///< assuming the user has permissions.
zes_engine_type_flags_t engines; ///< [out] Bitfield of accelerator engine types that are managed by this
///< scheduler component. Note that there can be more than one scheduler
///< component for the same type of accelerator engine.
uint32_t supportedModes; ///< [out] Bitfield of scheduler modes that can be configured for this
///< scheduler component (bitfield of 1<<::zes_sched_mode_t).
} zes_sched_properties_t;
///////////////////////////////////////////////////////////////////////////////
#ifndef ZES_SCHED_WATCHDOG_DISABLE
/// @brief Disable forward progress guard timeout.
#define ZES_SCHED_WATCHDOG_DISABLE (~(0ULL))
#endif // ZES_SCHED_WATCHDOG_DISABLE
///////////////////////////////////////////////////////////////////////////////
/// @brief Configuration for timeout scheduler mode (::ZES_SCHED_MODE_TIMEOUT)
typedef struct _zes_sched_timeout_properties_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
uint64_t watchdogTimeout; ///< [in,out] The maximum time in microseconds that the scheduler will wait
///< for a batch of work submitted to a hardware engine to complete or to
///< be preempted so as to run another context.
///< If this time is exceeded, the hardware engine is reset and the context terminated.
///< If set to ::ZES_SCHED_WATCHDOG_DISABLE, a running workload can run as
///< long as it wants without being terminated, but preemption attempts to
///< run other contexts are permitted but not enforced.
} zes_sched_timeout_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Configuration for timeslice scheduler mode
/// (::ZES_SCHED_MODE_TIMESLICE)
typedef struct _zes_sched_timeslice_properties_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
uint64_t interval; ///< [in,out] The average interval in microseconds that a submission for a
///< context will run on a hardware engine before being preempted out to
///< run a pending submission for another context.
uint64_t yieldTimeout; ///< [in,out] The maximum time in microseconds that the scheduler will wait
///< to preempt a workload running on an engine before deciding to reset
///< the hardware engine and terminating the associated context.
} zes_sched_timeslice_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Returns handles to scheduler components.
///
/// @details
/// - Each scheduler component manages the distribution of work across one
/// or more accelerator engines.
/// - If an application wishes to change the scheduler behavior for all
/// accelerator engines of a specific type (e.g. compute), it should
/// select all the handles where the `engines` member
/// ::zes_sched_properties_t contains that type.
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceEnumSchedulers(
zes_device_handle_t hDevice, ///< [in] Sysman handle of the device.
uint32_t* pCount, ///< [in,out] pointer to the number of components of this type.
///< if count is zero, then the driver shall update the value with the
///< total number of components of this type that are available.
///< if count is greater than the number of components of this type that
///< are available, then the driver shall update the value with the correct
///< number of components.
zes_sched_handle_t* phScheduler ///< [in,out][optional][range(0, *pCount)] array of handle of components of
///< this type.
///< if count is less than the number of components of this type that are
///< available, then the driver shall only retrieve that number of
///< component handles.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get properties related to a scheduler component
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hScheduler`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pProperties`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesSchedulerGetProperties(
zes_sched_handle_t hScheduler, ///< [in] Handle for the component.
zes_sched_properties_t* pProperties ///< [in,out] Structure that will contain property data.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get current scheduling mode in effect on a scheduler component.
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hScheduler`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pMode`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + This scheduler component does not support scheduler modes.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesSchedulerGetCurrentMode(
zes_sched_handle_t hScheduler, ///< [in] Sysman handle for the component.
zes_sched_mode_t* pMode ///< [in,out] Will contain the current scheduler mode.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get scheduler config for mode ::ZES_SCHED_MODE_TIMEOUT
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hScheduler`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pConfig`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + This scheduler component does not support scheduler modes.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesSchedulerGetTimeoutModeProperties(
zes_sched_handle_t hScheduler, ///< [in] Sysman handle for the component.
ze_bool_t getDefaults, ///< [in] If TRUE, the driver will return the system default properties for
///< this mode, otherwise it will return the current properties.
zes_sched_timeout_properties_t* pConfig ///< [in,out] Will contain the current parameters for this mode.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get scheduler config for mode ::ZES_SCHED_MODE_TIMESLICE
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hScheduler`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pConfig`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + This scheduler component does not support scheduler modes.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesSchedulerGetTimesliceModeProperties(
zes_sched_handle_t hScheduler, ///< [in] Sysman handle for the component.
ze_bool_t getDefaults, ///< [in] If TRUE, the driver will return the system default properties for
///< this mode, otherwise it will return the current properties.
zes_sched_timeslice_properties_t* pConfig ///< [in,out] Will contain the current parameters for this mode.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Change scheduler mode to ::ZES_SCHED_MODE_TIMEOUT or update scheduler
/// mode parameters if already running in this mode.
///
/// @details
/// - This mode is optimized for multiple applications or contexts
/// submitting work to the hardware. When higher priority work arrives,
/// the scheduler attempts to pause the current executing work within some
/// timeout interval, then submits the other work.
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hScheduler`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pProperties`
/// + `nullptr == pNeedReload`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + This scheduler component does not support scheduler modes.
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to make this modification.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesSchedulerSetTimeoutMode(
zes_sched_handle_t hScheduler, ///< [in] Sysman handle for the component.
zes_sched_timeout_properties_t* pProperties, ///< [in] The properties to use when configurating this mode.
ze_bool_t* pNeedReload ///< [in,out] Will be set to TRUE if a device driver reload is needed to
///< apply the new scheduler mode.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Change scheduler mode to ::ZES_SCHED_MODE_TIMESLICE or update
/// scheduler mode parameters if already running in this mode.
///
/// @details
/// - This mode is optimized to provide fair sharing of hardware execution
/// time between multiple contexts submitting work to the hardware
/// concurrently.
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hScheduler`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pProperties`
/// + `nullptr == pNeedReload`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + This scheduler component does not support scheduler modes.
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to make this modification.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesSchedulerSetTimesliceMode(
zes_sched_handle_t hScheduler, ///< [in] Sysman handle for the component.
zes_sched_timeslice_properties_t* pProperties, ///< [in] The properties to use when configurating this mode.
ze_bool_t* pNeedReload ///< [in,out] Will be set to TRUE if a device driver reload is needed to
///< apply the new scheduler mode.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Change scheduler mode to ::ZES_SCHED_MODE_EXCLUSIVE
///
/// @details
/// - This mode is optimized for single application/context use-cases. It
/// permits a context to run indefinitely on the hardware without being
/// preempted or terminated. All pending work for other contexts must wait
/// until the running context completes with no further submitted work.
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hScheduler`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pNeedReload`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + This scheduler component does not support scheduler modes.
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to make this modification.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesSchedulerSetExclusiveMode(
zes_sched_handle_t hScheduler, ///< [in] Sysman handle for the component.
ze_bool_t* pNeedReload ///< [in,out] Will be set to TRUE if a device driver reload is needed to
///< apply the new scheduler mode.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Change scheduler mode to ::ZES_SCHED_MODE_COMPUTE_UNIT_DEBUG
///
/// @details
/// - This is a special mode that must ben enabled when debugging an
/// application that uses this device e.g. using the Level0 Debug API.
/// - It ensures that only one command queue can execute work on the
/// hardware at a given time. Work is permitted to run as long as needed
/// without enforcing any scheduler fairness policies.
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
/// - [DEPRECATED] No longer supported.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hScheduler`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pNeedReload`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + This scheduler component does not support scheduler modes.
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to make this modification.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesSchedulerSetComputeUnitDebugMode(
zes_sched_handle_t hScheduler, ///< [in] Sysman handle for the component.
ze_bool_t* pNeedReload ///< [in,out] Will be set to TRUE if a device driver reload is needed to
///< apply the new scheduler mode.
);
#if !defined(__GNUC__)
#pragma endregion
#endif
// Intel 'oneAPI' Level-Zero Tool APIs for System Resource Management (Sysman) - Standby domains
#if !defined(__GNUC__)
#pragma region standby
#endif
///////////////////////////////////////////////////////////////////////////////
/// @brief Standby hardware components
typedef enum _zes_standby_type_t
{
ZES_STANDBY_TYPE_GLOBAL = 0, ///< Control the overall standby policy of the device/sub-device
ZES_STANDBY_TYPE_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_STANDBY_TYPE_* ENUMs
} zes_standby_type_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Standby hardware component properties
typedef struct _zes_standby_properties_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
zes_standby_type_t type; ///< [out] Which standby hardware component this controls
ze_bool_t onSubdevice; ///< [out] True if the resource is located on a sub-device; false means
///< that the resource is on the device of the calling Sysman handle
uint32_t subdeviceId; ///< [out] If onSubdevice is true, this gives the ID of the sub-device
} zes_standby_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Standby promotion modes
typedef enum _zes_standby_promo_mode_t
{
ZES_STANDBY_PROMO_MODE_DEFAULT = 0, ///< Best compromise between performance and energy savings.
ZES_STANDBY_PROMO_MODE_NEVER = 1, ///< The device/component will never shutdown. This can improve performance
///< but uses more energy.
ZES_STANDBY_PROMO_MODE_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_STANDBY_PROMO_MODE_* ENUMs
} zes_standby_promo_mode_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Get handle of standby controls
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceEnumStandbyDomains(
zes_device_handle_t hDevice, ///< [in] Sysman handle of the device.
uint32_t* pCount, ///< [in,out] pointer to the number of components of this type.
///< if count is zero, then the driver shall update the value with the
///< total number of components of this type that are available.
///< if count is greater than the number of components of this type that
///< are available, then the driver shall update the value with the correct
///< number of components.
zes_standby_handle_t* phStandby ///< [in,out][optional][range(0, *pCount)] array of handle of components of
///< this type.
///< if count is less than the number of components of this type that are
///< available, then the driver shall only retrieve that number of
///< component handles.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get standby hardware component properties
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hStandby`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pProperties`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesStandbyGetProperties(
zes_standby_handle_t hStandby, ///< [in] Handle for the component.
zes_standby_properties_t* pProperties ///< [in,out] Will contain the standby hardware properties.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get the current standby promotion mode
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hStandby`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pMode`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesStandbyGetMode(
zes_standby_handle_t hStandby, ///< [in] Handle for the component.
zes_standby_promo_mode_t* pMode ///< [in,out] Will contain the current standby mode.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Set standby promotion mode
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hStandby`
/// - ::ZE_RESULT_ERROR_INVALID_ENUMERATION
/// + `::ZES_STANDBY_PROMO_MODE_NEVER < mode`
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to make these modifications.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesStandbySetMode(
zes_standby_handle_t hStandby, ///< [in] Handle for the component.
zes_standby_promo_mode_t mode ///< [in] New standby mode.
);
#if !defined(__GNUC__)
#pragma endregion
#endif
// Intel 'oneAPI' Level-Zero Tool APIs for System Resource Management (Sysman) - Firmware management
#if !defined(__GNUC__)
#pragma region temperature
#endif
///////////////////////////////////////////////////////////////////////////////
/// @brief Temperature sensors
typedef enum _zes_temp_sensors_t
{
ZES_TEMP_SENSORS_GLOBAL = 0, ///< The maximum temperature across all device sensors
ZES_TEMP_SENSORS_GPU = 1, ///< The maximum temperature across all sensors in the GPU
ZES_TEMP_SENSORS_MEMORY = 2, ///< The maximum temperature across all sensors in the local memory
ZES_TEMP_SENSORS_GLOBAL_MIN = 3, ///< The minimum temperature across all device sensors
ZES_TEMP_SENSORS_GPU_MIN = 4, ///< The minimum temperature across all sensors in the GPU
ZES_TEMP_SENSORS_MEMORY_MIN = 5, ///< The minimum temperature across all sensors in the local device memory
ZES_TEMP_SENSORS_GPU_BOARD = 6, ///< The maximum temperature across all sensors in the GPU Board
ZES_TEMP_SENSORS_GPU_BOARD_MIN = 7, ///< The minimum temperature across all sensors in the GPU Board
ZES_TEMP_SENSORS_VOLTAGE_REGULATOR = 8, ///< The maximum temperature across all sensors in the Voltage Regulator
ZES_TEMP_SENSORS_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_TEMP_SENSORS_* ENUMs
} zes_temp_sensors_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Temperature sensor properties
typedef struct _zes_temp_properties_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
zes_temp_sensors_t type; ///< [out] Which part of the device the temperature sensor measures
ze_bool_t onSubdevice; ///< [out] True if the resource is located on a sub-device; false means
///< that the resource is on the device of the calling Sysman handle
uint32_t subdeviceId; ///< [out] If onSubdevice is true, this gives the ID of the sub-device
double maxTemperature; ///< [out] Will contain the maximum temperature for the specific device in
///< degrees Celsius.
ze_bool_t isCriticalTempSupported; ///< [out] Indicates if the critical temperature event
///< ::ZES_EVENT_TYPE_FLAG_TEMP_CRITICAL is supported
ze_bool_t isThreshold1Supported; ///< [out] Indicates if the temperature threshold 1 event
///< ::ZES_EVENT_TYPE_FLAG_TEMP_THRESHOLD1 is supported
ze_bool_t isThreshold2Supported; ///< [out] Indicates if the temperature threshold 2 event
///< ::ZES_EVENT_TYPE_FLAG_TEMP_THRESHOLD2 is supported
} zes_temp_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Temperature sensor threshold
typedef struct _zes_temp_threshold_t
{
ze_bool_t enableLowToHigh; ///< [in,out] Trigger an event when the temperature crosses from below the
///< threshold to above.
ze_bool_t enableHighToLow; ///< [in,out] Trigger an event when the temperature crosses from above the
///< threshold to below.
double threshold; ///< [in,out] The threshold in degrees Celsius.
} zes_temp_threshold_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Temperature configuration - which events should be triggered and the
/// trigger conditions.
typedef struct _zes_temp_config_t
{
zes_structure_type_t stype; ///< [in] type of this structure
const void* pNext; ///< [in][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
ze_bool_t enableCritical; ///< [in,out] Indicates if event ::ZES_EVENT_TYPE_FLAG_TEMP_CRITICAL should
///< be triggered by the driver.
zes_temp_threshold_t threshold1; ///< [in,out] Configuration controlling if and when event
///< ::ZES_EVENT_TYPE_FLAG_TEMP_THRESHOLD1 should be triggered by the
///< driver.
zes_temp_threshold_t threshold2; ///< [in,out] Configuration controlling if and when event
///< ::ZES_EVENT_TYPE_FLAG_TEMP_THRESHOLD2 should be triggered by the
///< driver.
} zes_temp_config_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Get handle of temperature sensors
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceEnumTemperatureSensors(
zes_device_handle_t hDevice, ///< [in] Sysman handle of the device.
uint32_t* pCount, ///< [in,out] pointer to the number of components of this type.
///< if count is zero, then the driver shall update the value with the
///< total number of components of this type that are available.
///< if count is greater than the number of components of this type that
///< are available, then the driver shall update the value with the correct
///< number of components.
zes_temp_handle_t* phTemperature ///< [in,out][optional][range(0, *pCount)] array of handle of components of
///< this type.
///< if count is less than the number of components of this type that are
///< available, then the driver shall only retrieve that number of
///< component handles.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get temperature sensor properties
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hTemperature`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pProperties`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesTemperatureGetProperties(
zes_temp_handle_t hTemperature, ///< [in] Handle for the component.
zes_temp_properties_t* pProperties ///< [in,out] Will contain the temperature sensor properties.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get temperature configuration for this sensor - which events are
/// triggered and the trigger conditions
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hTemperature`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pConfig`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + Temperature thresholds are not supported on this temperature sensor. Generally this is only supported for temperature sensor ::ZES_TEMP_SENSORS_GLOBAL.
/// + One or both of the thresholds is not supported. Check the `isThreshold1Supported` and `isThreshold2Supported` members of ::zes_temp_properties_t.
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to request this feature.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesTemperatureGetConfig(
zes_temp_handle_t hTemperature, ///< [in] Handle for the component.
zes_temp_config_t* pConfig ///< [in,out] Returns current configuration.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Set temperature configuration for this sensor - indicates which events
/// are triggered and the trigger conditions
///
/// @details
/// - Events ::ZES_EVENT_TYPE_FLAG_TEMP_CRITICAL will be triggered when
/// temperature reaches the critical range. Use the function
/// ::zesDeviceEventRegister() to start receiving this event.
/// - Events ::ZES_EVENT_TYPE_FLAG_TEMP_THRESHOLD1 and
/// ::ZES_EVENT_TYPE_FLAG_TEMP_THRESHOLD2 will be generated when
/// temperature cross the thresholds set using this function. Use the
/// function ::zesDeviceEventRegister() to start receiving these events.
/// - Only one running process can set the temperature configuration at a
/// time. If another process attempts to change the configuration, the
/// error ::ZE_RESULT_ERROR_NOT_AVAILABLE will be returned. The function
/// ::zesTemperatureGetConfig() will return the process ID currently
/// controlling these settings.
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hTemperature`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pConfig`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE
/// + Temperature thresholds are not supported on this temperature sensor. Generally they are only supported for temperature sensor ::ZES_TEMP_SENSORS_GLOBAL.
/// + Enabling the critical temperature event is not supported. Check the `isCriticalTempSupported` member of ::zes_temp_properties_t.
/// + One or both of the thresholds is not supported. Check the `isThreshold1Supported` and `isThreshold2Supported` members of ::zes_temp_properties_t.
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to request this feature.
/// - ::ZE_RESULT_ERROR_NOT_AVAILABLE
/// + Another running process is controlling these settings.
/// - ::ZE_RESULT_ERROR_INVALID_ARGUMENT
/// + One or both the thresholds is above TjMax (see ::zesFrequencyOcGetTjMax()). Temperature thresholds must be below this value.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesTemperatureSetConfig(
zes_temp_handle_t hTemperature, ///< [in] Handle for the component.
const zes_temp_config_t* pConfig ///< [in] New configuration.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get the temperature from a specified sensor
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hTemperature`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pTemperature`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesTemperatureGetState(
zes_temp_handle_t hTemperature, ///< [in] Handle for the component.
double* pTemperature ///< [in,out] Will contain the temperature read from the specified sensor
///< in degrees Celsius.
);
#if !defined(__GNUC__)
#pragma endregion
#endif
// Intel 'oneAPI' Level-Zero Sysman Extension APIs Device-ECC default properties
#if !defined(__GNUC__)
#pragma region eccState
#endif
///////////////////////////////////////////////////////////////////////////////
#ifndef ZES_DEVICE_ECC_DEFAULT_PROPERTIES_EXT_NAME
/// @brief Device ECC default properties Extension Name
#define ZES_DEVICE_ECC_DEFAULT_PROPERTIES_EXT_NAME "ZES_extension_device_ecc_default_properties"
#endif // ZES_DEVICE_ECC_DEFAULT_PROPERTIES_EXT_NAME
///////////////////////////////////////////////////////////////////////////////
/// @brief Device ECC default properties Extension Version(s)
typedef enum _zes_device_ecc_default_properties_ext_version_t
{
ZES_DEVICE_ECC_DEFAULT_PROPERTIES_EXT_VERSION_1_0 = ZE_MAKE_VERSION( 1, 0 ),///< version 1.0
ZES_DEVICE_ECC_DEFAULT_PROPERTIES_EXT_VERSION_CURRENT = ZE_MAKE_VERSION( 1, 0 ),///< latest known version
ZES_DEVICE_ECC_DEFAULT_PROPERTIES_EXT_VERSION_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_DEVICE_ECC_DEFAULT_PROPERTIES_EXT_VERSION_* ENUMs
} zes_device_ecc_default_properties_ext_version_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief This structure may be passed to ::zesDeviceGetEccState as pNext member
/// of ::zes_device_ecc_properties_t.
typedef struct _zes_device_ecc_default_properties_ext_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
zes_device_ecc_state_t defaultState; ///< [out] Default ECC state
} zes_device_ecc_default_properties_ext_t;
#if !defined(__GNUC__)
#pragma endregion
#endif
// Intel 'oneAPI' Level-Zero Sysman Extension APIs for Power Limits
#if !defined(__GNUC__)
#pragma region powerLimits
#endif
///////////////////////////////////////////////////////////////////////////////
#ifndef ZES_POWER_LIMITS_EXT_NAME
/// @brief Power Limits Extension Name
#define ZES_POWER_LIMITS_EXT_NAME "ZES_extension_power_limits"
#endif // ZES_POWER_LIMITS_EXT_NAME
///////////////////////////////////////////////////////////////////////////////
/// @brief Power Limits Extension Version(s)
typedef enum _zes_power_limits_ext_version_t
{
ZES_POWER_LIMITS_EXT_VERSION_1_0 = ZE_MAKE_VERSION( 1, 0 ), ///< version 1.0
ZES_POWER_LIMITS_EXT_VERSION_CURRENT = ZE_MAKE_VERSION( 1, 0 ), ///< latest known version
ZES_POWER_LIMITS_EXT_VERSION_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_POWER_LIMITS_EXT_VERSION_* ENUMs
} zes_power_limits_ext_version_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Device power/current limit descriptor.
typedef struct _zes_power_limit_ext_desc_t
{
zes_structure_type_t stype; ///< [in] type of this structure
const void* pNext; ///< [in][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
zes_power_level_t level; ///< [in,out] duration type over which the power draw is measured, i.e.
///< sustained, burst, peak, or critical.
zes_power_source_t source; ///< [out] source of power used by the system, i.e. AC or DC.
zes_limit_unit_t limitUnit; ///< [out] unit used for specifying limit, i.e. current units (milliamps)
///< or power units (milliwatts).
ze_bool_t enabledStateLocked; ///< [out] indicates if the power limit state (enabled/ignored) can be set
///< (false) or is locked (true).
ze_bool_t enabled; ///< [in,out] indicates if the limit is enabled (true) or ignored (false).
///< If enabledStateIsLocked is True, this value is ignored.
ze_bool_t intervalValueLocked; ///< [out] indicates if the interval can be modified (false) or is fixed
///< (true).
int32_t interval; ///< [in,out] power averaging window in milliseconds. If
///< intervalValueLocked is true, this value is ignored.
ze_bool_t limitValueLocked; ///< [out] indicates if the limit can be set (false) or if the limit is
///< fixed (true).
int32_t limit; ///< [in,out] limit value. If limitValueLocked is true, this value is
///< ignored. The value should be provided in the unit specified by
///< limitUnit.
} zes_power_limit_ext_desc_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Extension properties related to device power settings
///
/// @details
/// - This structure may be returned from ::zesPowerGetProperties via the
/// `pNext` member of ::zes_power_properties_t.
/// - This structure may also be returned from ::zesPowerGetProperties via
/// the `pNext` member of ::zes_power_ext_properties_t
/// - Used for determining the power domain level, i.e. card-level v/s
/// package-level v/s stack-level & the factory default power limits.
typedef struct _zes_power_ext_properties_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
zes_power_domain_t domain; ///< [out] domain that the power limit belongs to.
zes_power_limit_ext_desc_t* defaultLimit; ///< [out] the factory default limit of the part.
} zes_power_ext_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Get power limits
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
/// - This function returns all the power limits associated with the
/// supplied power domain.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hPower`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesPowerGetLimitsExt(
zes_pwr_handle_t hPower, ///< [in] Power domain handle instance.
uint32_t* pCount, ///< [in,out] Pointer to the number of power limit descriptors. If count is
///< zero, then the driver shall update the value with the total number of
///< components of this type that are available. If count is greater than
///< the number of components of this type that are available, then the
///< driver shall update the value with the correct number of components.
zes_power_limit_ext_desc_t* pSustained ///< [in,out][optional][range(0, *pCount)] Array of query results for power
///< limit descriptors. If count is less than the number of components of
///< this type that are available, then the driver shall only retrieve that
///< number of components.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Set power limits
///
/// @details
/// - The application can only modify unlocked members of the limit
/// descriptors returned by ::zesPowerGetLimitsExt.
/// - Not all the limits returned by ::zesPowerGetLimitsExt need to be
/// supplied to this function.
/// - Limits do not have to be supplied in the same order as returned by
/// ::zesPowerGetLimitsExt.
/// - The same limit can be supplied multiple times. Limits are applied in
/// the order in which they are supplied.
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hPower`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + User does not have permissions to make these modifications.
/// - ::ZE_RESULT_ERROR_NOT_AVAILABLE
/// + The device is in use, meaning that the GPU is under Over clocking, applying power limits under overclocking is not supported.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesPowerSetLimitsExt(
zes_pwr_handle_t hPower, ///< [in] Handle for the component.
uint32_t* pCount, ///< [in] Pointer to the number of power limit descriptors.
zes_power_limit_ext_desc_t* pSustained ///< [in][optional][range(0, *pCount)] Array of power limit descriptors.
);
#if !defined(__GNUC__)
#pragma endregion
#endif
// Intel 'oneAPI' Level-Zero Sysman Extension APIs for Engine Activity
#if !defined(__GNUC__)
#pragma region engineActivity
#endif
///////////////////////////////////////////////////////////////////////////////
#ifndef ZES_ENGINE_ACTIVITY_EXT_NAME
/// @brief Engine Activity Extension Name
#define ZES_ENGINE_ACTIVITY_EXT_NAME "ZES_extension_engine_activity"
#endif // ZES_ENGINE_ACTIVITY_EXT_NAME
///////////////////////////////////////////////////////////////////////////////
/// @brief Engine Activity Extension Version(s)
typedef enum _zes_engine_activity_ext_version_t
{
ZES_ENGINE_ACTIVITY_EXT_VERSION_1_0 = ZE_MAKE_VERSION( 1, 0 ), ///< version 1.0
ZES_ENGINE_ACTIVITY_EXT_VERSION_CURRENT = ZE_MAKE_VERSION( 1, 0 ), ///< latest known version
ZES_ENGINE_ACTIVITY_EXT_VERSION_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_ENGINE_ACTIVITY_EXT_VERSION_* ENUMs
} zes_engine_activity_ext_version_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Extension properties related to Engine Groups
///
/// @details
/// - This structure may be passed to ::zesEngineGetProperties by having the
/// pNext member of ::zes_engine_properties_t point at this struct.
/// - Used for SRIOV per Virtual Function device utilization by
/// ::zes_engine_group_t
typedef struct _zes_engine_ext_properties_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
uint32_t countOfVirtualFunctionInstance; ///< [out] Number of Virtual Function(VF) instances associated with engine
///< to monitor the utilization of hardware across all Virtual Function
///< from a Physical Function (PF) instance.
///< These VF-by-VF views should provide engine group and individual engine
///< level granularity.
///< This count represents the number of VF instances that are actively
///< using the resource represented by the engine handle.
} zes_engine_ext_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Get activity stats for Physical Function (PF) and each Virtual
/// Function (VF) associated with engine group.
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hEngine`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
/// - ::ZE_RESULT_ERROR_UNSUPPORTED_FEATURE - "Engine activity extension is not supported in the environment."
ZE_APIEXPORT ze_result_t ZE_APICALL
zesEngineGetActivityExt(
zes_engine_handle_t hEngine, ///< [in] Handle for the component.
uint32_t* pCount, ///< [in,out] Pointer to the number of VF engine stats descriptors.
///< - if count is zero, the driver shall update the value with the total
///< number of engine stats available.
///< - if count is greater than the total number of engine stats
///< available, the driver shall update the value with the correct number
///< of engine stats available.
///< - The count returned is the sum of number of VF instances currently
///< available and the PF instance.
zes_engine_stats_t* pStats ///< [in,out][optional][range(0, *pCount)] array of engine group activity counters.
///< - if count is less than the total number of engine stats available,
///< then driver shall only retrieve that number of stats.
///< - the implementation shall populate the vector with engine stat for
///< PF at index 0 of the vector followed by user provided pCount-1 number
///< of VF engine stats.
);
#if !defined(__GNUC__)
#pragma endregion
#endif
// Intel 'oneAPI' Level-Zero Sysman Extension APIs for RAS Get State and Clear State
#if !defined(__GNUC__)
#pragma region rasState
#endif
///////////////////////////////////////////////////////////////////////////////
#ifndef ZES_RAS_GET_STATE_EXP_NAME
/// @brief RAS Get State Extension Name
#define ZES_RAS_GET_STATE_EXP_NAME "ZES_extension_ras_state"
#endif // ZES_RAS_GET_STATE_EXP_NAME
///////////////////////////////////////////////////////////////////////////////
/// @brief RAS Get State Extension Version(s)
typedef enum _zes_ras_state_exp_version_t
{
ZES_RAS_STATE_EXP_VERSION_1_0 = ZE_MAKE_VERSION( 1, 0 ), ///< version 1.0
ZES_RAS_STATE_EXP_VERSION_CURRENT = ZE_MAKE_VERSION( 1, 0 ), ///< latest known version
ZES_RAS_STATE_EXP_VERSION_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_RAS_STATE_EXP_VERSION_* ENUMs
} zes_ras_state_exp_version_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief RAS error categories
typedef enum _zes_ras_error_category_exp_t
{
ZES_RAS_ERROR_CATEGORY_EXP_RESET = 0, ///< The number of accelerator engine resets attempted by the driver
ZES_RAS_ERROR_CATEGORY_EXP_PROGRAMMING_ERRORS = 1, ///< The number of hardware exceptions generated by the way workloads have
///< programmed the hardware
ZES_RAS_ERROR_CATEGORY_EXP_DRIVER_ERRORS = 2, ///< The number of low level driver communication errors have occurred
ZES_RAS_ERROR_CATEGORY_EXP_COMPUTE_ERRORS = 3, ///< The number of errors that have occurred in the compute accelerator
///< hardware
ZES_RAS_ERROR_CATEGORY_EXP_NON_COMPUTE_ERRORS = 4, ///< The number of errors that have occurred in the fixed-function
///< accelerator hardware
ZES_RAS_ERROR_CATEGORY_EXP_CACHE_ERRORS = 5, ///< The number of errors that have occurred in caches (L1/L3/register
///< file/shared local memory/sampler)
ZES_RAS_ERROR_CATEGORY_EXP_DISPLAY_ERRORS = 6, ///< The number of errors that have occurred in the display
ZES_RAS_ERROR_CATEGORY_EXP_MEMORY_ERRORS = 7, ///< The number of errors that have occurred in Memory
ZES_RAS_ERROR_CATEGORY_EXP_SCALE_ERRORS = 8, ///< The number of errors that have occurred in Scale Fabric
ZES_RAS_ERROR_CATEGORY_EXP_L3FABRIC_ERRORS = 9, ///< The number of errors that have occurred in L3 Fabric
ZES_RAS_ERROR_CATEGORY_EXP_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_RAS_ERROR_CATEGORY_EXP_* ENUMs
} zes_ras_error_category_exp_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Extension structure for providing RAS error counters for different
/// error sets
typedef struct _zes_ras_state_exp_t
{
zes_ras_error_category_exp_t category; ///< [out] category for which error counter is provided.
uint64_t errorCounter; ///< [out] Current value of RAS counter for specific error category.
} zes_ras_state_exp_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Ras Get State
///
/// @details
/// - This function retrieves error counters for different RAS error
/// categories.
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hRas`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesRasGetStateExp(
zes_ras_handle_t hRas, ///< [in] Handle for the component.
uint32_t* pCount, ///< [in,out] pointer to the number of RAS state structures that can be retrieved.
///< if count is zero, then the driver shall update the value with the
///< total number of error categories for which state can be retrieved.
///< if count is greater than the number of RAS states available, then the
///< driver shall update the value with the correct number of RAS states available.
zes_ras_state_exp_t* pState ///< [in,out][optional][range(0, *pCount)] array of query results for RAS
///< error states for different categories.
///< if count is less than the number of RAS states available, then driver
///< shall only retrieve that number of RAS states.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Ras Clear State
///
/// @details
/// - This function clears error counters for a RAS error category.
/// - Clearing errors will affect other threads/applications - the counter
/// values will start from zero.
/// - Clearing errors requires write permissions.
/// - The application should not call this function from simultaneous
/// threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hRas`
/// - ::ZE_RESULT_ERROR_INVALID_ENUMERATION
/// + `::ZES_RAS_ERROR_CATEGORY_EXP_L3FABRIC_ERRORS < category`
/// - ::ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
/// + Don't have permissions to clear error counters.
ZE_APIEXPORT ze_result_t ZE_APICALL
zesRasClearStateExp(
zes_ras_handle_t hRas, ///< [in] Handle for the component.
zes_ras_error_category_exp_t category ///< [in] category for which error counter is to be cleared.
);
#if !defined(__GNUC__)
#pragma endregion
#endif
// Intel 'oneAPI' Level-Zero Sysman Extension APIs for Memory State
#if !defined(__GNUC__)
#pragma region memPageOfflineState
#endif
///////////////////////////////////////////////////////////////////////////////
#ifndef ZES_MEM_PAGE_OFFLINE_STATE_EXP_NAME
/// @brief Memory State Extension Name
#define ZES_MEM_PAGE_OFFLINE_STATE_EXP_NAME "ZES_extension_mem_state"
#endif // ZES_MEM_PAGE_OFFLINE_STATE_EXP_NAME
///////////////////////////////////////////////////////////////////////////////
/// @brief Memory State Extension Version(s)
typedef enum _zes_mem_page_offline_state_exp_version_t
{
ZES_MEM_PAGE_OFFLINE_STATE_EXP_VERSION_1_0 = ZE_MAKE_VERSION( 1, 0 ), ///< version 1.0
ZES_MEM_PAGE_OFFLINE_STATE_EXP_VERSION_CURRENT = ZE_MAKE_VERSION( 1, 0 ), ///< latest known version
ZES_MEM_PAGE_OFFLINE_STATE_EXP_VERSION_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_MEM_PAGE_OFFLINE_STATE_EXP_VERSION_* ENUMs
} zes_mem_page_offline_state_exp_version_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Extension properties for Memory State
///
/// @details
/// - This structure may be returned from ::zesMemoryGetState via the
/// `pNext` member of ::zes_mem_state_t
/// - These additional parameters get Memory Page Offline Metrics
typedef struct _zes_mem_page_offline_state_exp_t
{
zes_structure_type_t stype; ///< [in] type of this structure
const void* pNext; ///< [in][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
uint32_t memoryPageOffline; ///< [out] Returns the number of Memory Pages Offline
uint32_t maxMemoryPageOffline; ///< [out] Returns the Allowed Memory Pages Offline
} zes_mem_page_offline_state_exp_t;
#if !defined(__GNUC__)
#pragma endregion
#endif
// Intel 'oneAPI' Level-Zero Sysman Extension APIs for Memory Bandwidth Counter Valid Bits
#if !defined(__GNUC__)
#pragma region memoryBwCounterValidBits
#endif
///////////////////////////////////////////////////////////////////////////////
#ifndef ZES_MEMORY_BANDWIDTH_COUNTER_BITS_EXP_PROPERTIES_NAME
/// @brief Memory Bandwidth Counter Valid Bits Extension Name
#define ZES_MEMORY_BANDWIDTH_COUNTER_BITS_EXP_PROPERTIES_NAME "ZES_extension_mem_bandwidth_counter_bits_properties"
#endif // ZES_MEMORY_BANDWIDTH_COUNTER_BITS_EXP_PROPERTIES_NAME
///////////////////////////////////////////////////////////////////////////////
/// @brief Memory Bandwidth Counter Valid Bits Extension Version(s)
typedef enum _zes_mem_bandwidth_counter_bits_exp_version_t
{
ZES_MEM_BANDWIDTH_COUNTER_BITS_EXP_VERSION_1_0 = ZE_MAKE_VERSION( 1, 0 ), ///< version 1.0
ZES_MEM_BANDWIDTH_COUNTER_BITS_EXP_VERSION_CURRENT = ZE_MAKE_VERSION( 1, 0 ), ///< latest known version
ZES_MEM_BANDWIDTH_COUNTER_BITS_EXP_VERSION_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_MEM_BANDWIDTH_COUNTER_BITS_EXP_VERSION_* ENUMs
} zes_mem_bandwidth_counter_bits_exp_version_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Extension properties for reporting valid bit count for memory
/// bandwidth counter value
///
/// @details
/// - Number of valid read and write counter bits of memory bandwidth
/// - This structure may be returned from ::zesMemoryGetProperties via the
/// `pNext` member of ::zes_mem_properties_t.
/// - Used for denoting number of valid bits in the counter value returned
/// in ::zes_mem_bandwidth_t.
typedef struct _zes_mem_bandwidth_counter_bits_exp_properties_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
uint32_t validBitsCount; ///< [out] Returns the number of valid bits in the counter values
} zes_mem_bandwidth_counter_bits_exp_properties_t;
#if !defined(__GNUC__)
#pragma endregion
#endif
// Intel 'oneAPI' Level-Zero Sysman Extension APIs for Power Domain Properties
#if !defined(__GNUC__)
#pragma region powerDomainProperties
#endif
///////////////////////////////////////////////////////////////////////////////
#ifndef ZES_POWER_DOMAIN_PROPERTIES_EXP_NAME
/// @brief Power Domain Properties Name
#define ZES_POWER_DOMAIN_PROPERTIES_EXP_NAME "ZES_extension_power_domain_properties"
#endif // ZES_POWER_DOMAIN_PROPERTIES_EXP_NAME
///////////////////////////////////////////////////////////////////////////////
/// @brief Power Domain Properties Extension Version(s)
typedef enum _zes_power_domain_properties_exp_version_t
{
ZES_POWER_DOMAIN_PROPERTIES_EXP_VERSION_1_0 = ZE_MAKE_VERSION( 1, 0 ), ///< version 1.0
ZES_POWER_DOMAIN_PROPERTIES_EXP_VERSION_CURRENT = ZE_MAKE_VERSION( 1, 0 ), ///< latest known version
ZES_POWER_DOMAIN_PROPERTIES_EXP_VERSION_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_POWER_DOMAIN_PROPERTIES_EXP_VERSION_* ENUMs
} zes_power_domain_properties_exp_version_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Extension structure for providing power domain information associated
/// with a power handle
///
/// @details
/// - This structure may be returned from ::zesPowerGetProperties via the
/// `pNext` member of ::zes_power_properties_t.
/// - Used for associating a power handle with a power domain.
typedef struct _zes_power_domain_exp_properties_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
zes_power_domain_t powerDomain; ///< [out] Power domain associated with the power handle.
} zes_power_domain_exp_properties_t;
#if !defined(__GNUC__)
#pragma endregion
#endif
// Intel 'oneAPI' Level-Zero Sysman Extension APIs for firmware security version
#if !defined(__GNUC__)
#pragma region firmwareSecurityVersion
#endif
///////////////////////////////////////////////////////////////////////////////
#ifndef ZES_FIRMWARE_SECURITY_VERSION_EXP_NAME
/// @brief Firmware security version
#define ZES_FIRMWARE_SECURITY_VERSION_EXP_NAME "ZES_experimental_firmware_security_version"
#endif // ZES_FIRMWARE_SECURITY_VERSION_EXP_NAME
///////////////////////////////////////////////////////////////////////////////
/// @brief Firmware security version Extension Version(s)
typedef enum _zes_firmware_security_exp_version_t
{
ZES_FIRMWARE_SECURITY_EXP_VERSION_1_0 = ZE_MAKE_VERSION( 1, 0 ), ///< version 1.0
ZES_FIRMWARE_SECURITY_EXP_VERSION_CURRENT = ZE_MAKE_VERSION( 1, 0 ), ///< latest known version
ZES_FIRMWARE_SECURITY_EXP_VERSION_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_FIRMWARE_SECURITY_EXP_VERSION_* ENUMs
} zes_firmware_security_exp_version_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Get the firmware security version number of the currently running
/// firmware
///
/// @details
/// - The application should create a character array of size
/// ::ZES_STRING_PROPERTY_SIZE and reference it for the `pVersion`
/// parameter.
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hFirmware`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pVersion`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFirmwareGetSecurityVersionExp(
zes_firmware_handle_t hFirmware, ///< [in] Handle for the component.
char* pVersion ///< [in,out] NULL terminated string value. The string "unknown" will be
///< returned if this property cannot be determined.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Set the firmware security version number
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hFirmware`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesFirmwareSetSecurityVersionExp(
zes_firmware_handle_t hFirmware ///< [in] Handle for the component.
);
#if !defined(__GNUC__)
#pragma endregion
#endif
// Intel 'oneAPI' Level-Zero Sysman Extension APIs for Sysman Device Mapping
#if !defined(__GNUC__)
#pragma region sysmanDeviceMapping
#endif
///////////////////////////////////////////////////////////////////////////////
#ifndef ZES_SYSMAN_DEVICE_MAPPING_EXP_NAME
/// @brief Sysman Device Mapping Extension Name
#define ZES_SYSMAN_DEVICE_MAPPING_EXP_NAME "ZES_experimental_sysman_device_mapping"
#endif // ZES_SYSMAN_DEVICE_MAPPING_EXP_NAME
///////////////////////////////////////////////////////////////////////////////
/// @brief Sysman Device Mapping Extension Version(s)
typedef enum _zes_sysman_device_mapping_exp_version_t
{
ZES_SYSMAN_DEVICE_MAPPING_EXP_VERSION_1_0 = ZE_MAKE_VERSION( 1, 0 ), ///< version 1.0
ZES_SYSMAN_DEVICE_MAPPING_EXP_VERSION_CURRENT = ZE_MAKE_VERSION( 1, 0 ),///< latest known version
ZES_SYSMAN_DEVICE_MAPPING_EXP_VERSION_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_SYSMAN_DEVICE_MAPPING_EXP_VERSION_* ENUMs
} zes_sysman_device_mapping_exp_version_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Sub Device Properties
typedef struct _zes_subdevice_exp_properties_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
uint32_t subdeviceId; ///< [out] this gives the ID of the sub device
zes_uuid_t uuid; ///< [out] universal unique identifier of the sub device.
} zes_subdevice_exp_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Retrieves sub device properties for the given sysman device handle
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceGetSubDevicePropertiesExp(
zes_device_handle_t hDevice, ///< [in] Sysman handle of the device.
uint32_t* pCount, ///< [in,out] pointer to the number of sub devices.
///< if count is zero, then the driver shall update the value with the
///< total number of sub devices currently attached to the device.
///< if count is greater than the number of sub devices currently attached
///< to the device, then the driver shall update the value with the correct
///< number of sub devices.
zes_subdevice_exp_properties_t* pSubdeviceProps ///< [in,out][optional][range(0, *pCount)] array of sub device property structures.
///< if count is less than the number of sysman sub devices available, then
///< the driver shall only retrieve that number of sub device property structures.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Retrieves sysman device and subdevice index for the given UUID and
/// sysman driver
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDriver`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == phDevice`
/// + `nullptr == onSubdevice`
/// + `nullptr == subdeviceId`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDriverGetDeviceByUuidExp(
zes_driver_handle_t hDriver, ///< [in] handle of the sysman driver instance
zes_uuid_t uuid, ///< [in] universal unique identifier.
zes_device_handle_t* phDevice, ///< [out] Sysman handle of the device.
ze_bool_t* onSubdevice, ///< [out] True if the UUID belongs to the sub-device; false means that
///< UUID belongs to the root device.
uint32_t* subdeviceId ///< [out] If onSubdevice is true, this gives the ID of the sub-device
);
#if !defined(__GNUC__)
#pragma endregion
#endif
// Intel 'oneAPI' Level-Zero Sysman Extension APIs for Virtual Function Management Properties
#if !defined(__GNUC__)
#pragma region virtualFunctionManagement
#endif
///////////////////////////////////////////////////////////////////////////////
#ifndef ZES_VIRTUAL_FUNCTION_MANAGEMENT_EXP_NAME
/// @brief Virtual Function Management Extension Name
#define ZES_VIRTUAL_FUNCTION_MANAGEMENT_EXP_NAME "ZES_experimental_virtual_function_management"
#endif // ZES_VIRTUAL_FUNCTION_MANAGEMENT_EXP_NAME
///////////////////////////////////////////////////////////////////////////////
/// @brief Virtual Function Management Extension Version(s)
typedef enum _zes_vf_management_exp_version_t
{
ZES_VF_MANAGEMENT_EXP_VERSION_1_0 = ZE_MAKE_VERSION( 1, 0 ), ///< version 1.0 (deprecated)
ZES_VF_MANAGEMENT_EXP_VERSION_1_1 = ZE_MAKE_VERSION( 1, 1 ), ///< version 1.1 (deprecated)
ZES_VF_MANAGEMENT_EXP_VERSION_1_2 = ZE_MAKE_VERSION( 1, 2 ), ///< version 1.2
ZES_VF_MANAGEMENT_EXP_VERSION_CURRENT = ZE_MAKE_VERSION( 1, 2 ), ///< latest known version
ZES_VF_MANAGEMENT_EXP_VERSION_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_VF_MANAGEMENT_EXP_VERSION_* ENUMs
} zes_vf_management_exp_version_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Virtual function memory types (deprecated)
typedef uint32_t zes_vf_info_mem_type_exp_flags_t;
typedef enum _zes_vf_info_mem_type_exp_flag_t
{
ZES_VF_INFO_MEM_TYPE_EXP_FLAG_MEM_TYPE_SYSTEM = ZE_BIT(0), ///< System memory
ZES_VF_INFO_MEM_TYPE_EXP_FLAG_MEM_TYPE_DEVICE = ZE_BIT(1), ///< Device local memory
ZES_VF_INFO_MEM_TYPE_EXP_FLAG_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_VF_INFO_MEM_TYPE_EXP_FLAG_* ENUMs
} zes_vf_info_mem_type_exp_flag_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Virtual function utilization flag bit fields (deprecated)
typedef uint32_t zes_vf_info_util_exp_flags_t;
typedef enum _zes_vf_info_util_exp_flag_t
{
ZES_VF_INFO_UTIL_EXP_FLAG_INFO_NONE = ZE_BIT(0), ///< No info associated with virtual function
ZES_VF_INFO_UTIL_EXP_FLAG_INFO_MEM_CPU = ZE_BIT(1), ///< System memory utilization associated with virtual function
ZES_VF_INFO_UTIL_EXP_FLAG_INFO_MEM_GPU = ZE_BIT(2), ///< Device memory utilization associated with virtual function
ZES_VF_INFO_UTIL_EXP_FLAG_INFO_ENGINE = ZE_BIT(3), ///< Engine utilization associated with virtual function
ZES_VF_INFO_UTIL_EXP_FLAG_FORCE_UINT32 = 0x7fffffff ///< Value marking end of ZES_VF_INFO_UTIL_EXP_FLAG_* ENUMs
} zes_vf_info_util_exp_flag_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Virtual function management properties (deprecated)
typedef struct _zes_vf_exp_properties_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
zes_pci_address_t address; ///< [out] Virtual function BDF address
zes_uuid_t uuid; ///< [out] universal unique identifier of the device
zes_vf_info_util_exp_flags_t flags; ///< [out] utilization flags available. May be 0 or a valid combination of
///< ::zes_vf_info_util_exp_flag_t.
} zes_vf_exp_properties_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Provides memory utilization values for a virtual function (deprecated)
typedef struct _zes_vf_util_mem_exp_t
{
zes_structure_type_t stype; ///< [in] type of this structure
const void* pNext; ///< [in][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
zes_vf_info_mem_type_exp_flags_t memTypeFlags; ///< [out] Memory type flags.
uint64_t free; ///< [out] Free memory size in bytes.
uint64_t size; ///< [out] Total allocatable memory in bytes.
uint64_t timestamp; ///< [out] Wall clock time from VF when value was sampled.
} zes_vf_util_mem_exp_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Provides engine utilization values for a virtual function (deprecated)
typedef struct _zes_vf_util_engine_exp_t
{
zes_structure_type_t stype; ///< [in] type of this structure
const void* pNext; ///< [in][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
zes_engine_group_t type; ///< [out] The engine group.
uint64_t activeCounterValue; ///< [out] Represents active counter.
uint64_t samplingCounterValue; ///< [out] Represents counter value when activeCounterValue was sampled.
uint64_t timestamp; ///< [out] Wall clock time when the activeCounterValue was sampled.
} zes_vf_util_engine_exp_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Virtual function management capabilities (deprecated)
typedef struct _zes_vf_exp_capabilities_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
zes_pci_address_t address; ///< [out] Virtual function BDF address
uint32_t vfDeviceMemSize; ///< [out] Virtual function memory size in kilo bytes
uint32_t vfID; ///< [out] Virtual Function ID
} zes_vf_exp_capabilities_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Virtual function management capabilities
typedef struct _zes_vf_exp2_capabilities_t
{
zes_structure_type_t stype; ///< [in] type of this structure
void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
zes_pci_address_t address; ///< [out] Virtual function BDF address
uint64_t vfDeviceMemSize; ///< [out] Virtual function memory size in bytes
uint32_t vfID; ///< [out] Virtual Function ID
} zes_vf_exp2_capabilities_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Provides memory utilization values for a virtual function
typedef struct _zes_vf_util_mem_exp2_t
{
zes_structure_type_t stype; ///< [in] type of this structure
const void* pNext; ///< [in][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
zes_mem_loc_t vfMemLocation; ///< [out] Location of this memory (system, device)
uint64_t vfMemUtilized; ///< [out] Utilized memory size in bytes.
} zes_vf_util_mem_exp2_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Provides engine utilization values for a virtual function
///
/// @details
/// - Percent utilization is calculated by taking two snapshots (s1, s2) and
/// using the equation: %util = (s2.activeCounterValue -
/// s1.activeCounterValue) / (s2.samplingCounterValue -
/// s1.samplingCounterValue)
typedef struct _zes_vf_util_engine_exp2_t
{
zes_structure_type_t stype; ///< [in] type of this structure
const void* pNext; ///< [in][optional] must be null or a pointer to an extension-specific
///< structure (i.e. contains stype and pNext).
zes_engine_group_t vfEngineType; ///< [out] The engine group.
uint64_t activeCounterValue; ///< [out] Represents active counter.
uint64_t samplingCounterValue; ///< [out] Represents counter value when activeCounterValue was sampled.
///< Refer to the formulae above for calculating the utilization percent
} zes_vf_util_engine_exp2_t;
///////////////////////////////////////////////////////////////////////////////
/// @brief Get handle of virtual function modules
///
/// @details
/// - [DEPRECATED] No longer supported. Use ::zesDeviceEnumEnabledVFExp.
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceEnumActiveVFExp(
zes_device_handle_t hDevice, ///< [in] Sysman handle of the device.
uint32_t* pCount, ///< [in,out] pointer to the number of components of this type.
///< if count is zero, then the driver shall update the value with the
///< total number of components of this type that are available.
///< if count is greater than the number of components of this type that
///< are available, then the driver shall update the value with the correct
///< number of components.
zes_vf_handle_t* phVFhandle ///< [in,out][optional][range(0, *pCount)] array of handle of components of
///< this type.
///< if count is less than the number of components of this type that are
///< available, then the driver shall only retrieve that number of
///< component handles.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get virtual function management properties
///
/// @details
/// - [DEPRECATED] No longer supported. Use
/// ::zesVFManagementGetVFCapabilitiesExp.
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hVFhandle`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pProperties`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesVFManagementGetVFPropertiesExp(
zes_vf_handle_t hVFhandle, ///< [in] Sysman handle for the VF component.
zes_vf_exp_properties_t* pProperties ///< [in,out] Will contain VF properties.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get memory activity stats for each available memory types associated
/// with Virtual Function (VF)
///
/// @details
/// - [DEPRECATED] No longer supported. Use
/// ::zesVFManagementGetVFMemoryUtilizationExp2.
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hVFhandle`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesVFManagementGetVFMemoryUtilizationExp(
zes_vf_handle_t hVFhandle, ///< [in] Sysman handle for the component.
uint32_t* pCount, ///< [in,out] Pointer to the number of VF memory stats descriptors.
///< - if count is zero, the driver shall update the value with the total
///< number of memory stats available.
///< - if count is greater than the total number of memory stats
///< available, the driver shall update the value with the correct number
///< of memory stats available.
///< - The count returned is the sum of number of VF instances currently
///< available and the PF instance.
zes_vf_util_mem_exp_t* pMemUtil ///< [in,out][optional][range(0, *pCount)] array of memory group activity counters.
///< - if count is less than the total number of memory stats available,
///< then driver shall only retrieve that number of stats.
///< - the implementation shall populate the vector pCount-1 number of VF
///< memory stats.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get engine activity stats for each available engine group associated
/// with Virtual Function (VF)
///
/// @details
/// - [DEPRECATED] No longer supported. Use
/// ::zesVFManagementGetVFEngineUtilizationExp2.
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hVFhandle`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesVFManagementGetVFEngineUtilizationExp(
zes_vf_handle_t hVFhandle, ///< [in] Sysman handle for the component.
uint32_t* pCount, ///< [in,out] Pointer to the number of VF engine stats descriptors.
///< - if count is zero, the driver shall update the value with the total
///< number of engine stats available.
///< - if count is greater than the total number of engine stats
///< available, the driver shall update the value with the correct number
///< of engine stats available.
///< - The count returned is the sum of number of VF instances currently
///< available and the PF instance.
zes_vf_util_engine_exp_t* pEngineUtil ///< [in,out][optional][range(0, *pCount)] array of engine group activity counters.
///< - if count is less than the total number of engine stats available,
///< then driver shall only retrieve that number of stats.
///< - the implementation shall populate the vector pCount-1 number of VF
///< engine stats.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Configure utilization telemetry enabled or disabled associated with
/// Virtual Function (VF)
///
/// @details
/// - [DEPRECATED] No longer supported.
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hVFhandle`
/// - ::ZE_RESULT_ERROR_INVALID_ENUMERATION
/// + `0xf < flags`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesVFManagementSetVFTelemetryModeExp(
zes_vf_handle_t hVFhandle, ///< [in] Sysman handle for the component.
zes_vf_info_util_exp_flags_t flags, ///< [in] utilization flags to enable or disable. May be 0 or a valid
///< combination of ::zes_vf_info_util_exp_flag_t.
ze_bool_t enable ///< [in] Enable utilization telemetry.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Set sampling interval to monitor for a particular utilization
/// telemetry associated with Virtual Function (VF)
///
/// @details
/// - [DEPRECATED] No longer supported.
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hVFhandle`
/// - ::ZE_RESULT_ERROR_INVALID_ENUMERATION
/// + `0xf < flag`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesVFManagementSetVFTelemetrySamplingIntervalExp(
zes_vf_handle_t hVFhandle, ///< [in] Sysman handle for the component.
zes_vf_info_util_exp_flags_t flag, ///< [in] utilization flags to set sampling interval. May be 0 or a valid
///< combination of ::zes_vf_info_util_exp_flag_t.
uint64_t samplingInterval ///< [in] Sampling interval value.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get handle of virtual function modules
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hDevice`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesDeviceEnumEnabledVFExp(
zes_device_handle_t hDevice, ///< [in] Sysman handle of the device.
uint32_t* pCount, ///< [in,out] pointer to the number of components of this type.
///< if count is zero, then the driver shall update the value with the
///< total number of components of this type that are available.
///< if count is greater than the number of components of this type that
///< are available, then the driver shall update the value with the correct
///< number of components.
zes_vf_handle_t* phVFhandle ///< [in,out][optional][range(0, *pCount)] array of handle of components of
///< this type.
///< if count is less than the number of components of this type that are
///< available, then the driver shall only retrieve that number of
///< component handles.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get virtual function management capabilities
///
/// @details
/// - [DEPRECATED] No longer supported. Use
/// ::zesVFManagementGetVFCapabilitiesExp2.
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hVFhandle`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCapability`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesVFManagementGetVFCapabilitiesExp(
zes_vf_handle_t hVFhandle, ///< [in] Sysman handle for the VF component.
zes_vf_exp_capabilities_t* pCapability ///< [in,out] Will contain VF capability.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get memory activity stats for each available memory types associated
/// with Virtual Function (VF)
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
/// - If VF is disable/pause/not active, utilization will give zero value.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hVFhandle`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesVFManagementGetVFMemoryUtilizationExp2(
zes_vf_handle_t hVFhandle, ///< [in] Sysman handle for the component.
uint32_t* pCount, ///< [in,out] Pointer to the number of VF memory stats descriptors.
///< - if count is zero, the driver shall update the value with the total
///< number of memory stats available.
///< - if count is greater than the total number of memory stats
///< available, the driver shall update the value with the correct number
///< of memory stats available.
zes_vf_util_mem_exp2_t* pMemUtil ///< [in,out][optional][range(0, *pCount)] array of memory group activity counters.
///< - if count is less than the total number of memory stats available,
///< then driver shall only retrieve that number of stats.
///< - the implementation shall populate the vector pCount-1 number of VF
///< memory stats.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get engine activity stats for each available engine group associated
/// with Virtual Function (VF)
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
/// - If VF is disable/pause/not active, utilization will give zero value.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hVFhandle`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCount`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesVFManagementGetVFEngineUtilizationExp2(
zes_vf_handle_t hVFhandle, ///< [in] Sysman handle for the component.
uint32_t* pCount, ///< [in,out] Pointer to the number of VF engine stats descriptors.
///< - if count is zero, the driver shall update the value with the total
///< number of engine stats available.
///< - if count is greater than the total number of engine stats
///< available, the driver shall update the value with the correct number
///< of engine stats available.
zes_vf_util_engine_exp2_t* pEngineUtil ///< [in,out][optional][range(0, *pCount)] array of engine group activity counters.
///< - if count is less than the total number of engine stats available,
///< then driver shall only retrieve that number of stats.
///< - the implementation shall populate the vector pCount-1 number of VF
///< engine stats.
);
///////////////////////////////////////////////////////////////////////////////
/// @brief Get virtual function management capabilities
///
/// @details
/// - The application may call this function from simultaneous threads.
/// - The implementation of this function should be lock-free.
///
/// @returns
/// - ::ZE_RESULT_SUCCESS
/// - ::ZE_RESULT_ERROR_UNINITIALIZED
/// - ::ZE_RESULT_ERROR_DEVICE_LOST
/// - ::ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY
/// - ::ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY
/// - ::ZE_RESULT_ERROR_INVALID_NULL_HANDLE
/// + `nullptr == hVFhandle`
/// - ::ZE_RESULT_ERROR_INVALID_NULL_POINTER
/// + `nullptr == pCapability`
ZE_APIEXPORT ze_result_t ZE_APICALL
zesVFManagementGetVFCapabilitiesExp2(
zes_vf_handle_t hVFhandle, ///< [in] Sysman handle for the VF component.
zes_vf_exp2_capabilities_t* pCapability ///< [in,out] Will contain VF capability.
);
#if !defined(__GNUC__)
#pragma endregion
#endif
#if defined(__cplusplus)
} // extern "C"
#endif
#endif // _ZES_API_H
|