File size: 405,693 Bytes
71af7ca | 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 |
# **O-RAN Working Group 6 (Cloudification and Orchestration Workgroup) Acceleration Abstraction Layer Common API**
Copyright © 2024 by the O-RAN ALLIANCE e.V.
The copying or incorporation into any other work of part or all of the material available in this specification in any form without the prior written permission of O-RAN ALLIANCE e.V. is prohibited, save that you may print or download extracts of the material of this specification for your personal use, or copy the material of this specification for the purpose of sending to individual third parties for their information provided that you acknowledge O-RAN ALLIANCE as the source of the material and that you inform the third party that these conditions apply to them and that they must comply with them.
O-RAN ALLIANCE e.V., Buschkauler Weg 27, 53347 Alfter, Germany
Register of Associations, Bonn VR 11238, VAT ID DE321720189
# --- Contents
| | |
|-------------------------------------------------------------------------------|----|
| Chapter 1 Introductory Material ..... | 4 |
| 1.1 Scope 4 ..... | |
| 1.2 References ..... | 4 |
| 1.3 Definitions and Abbreviations ..... | 5 |
| 1.3.1 Definitions ..... | 5 |
| 1.3.2 Abbreviations ..... | 5 |
| Chapter 2 Overview ..... | 6 |
| 2.1 General ..... | 6 |
| 2.2 Document Structure ..... | 6 |
| Chapter 3 AAL Common requirements and Object Model ..... | 7 |
| 3.1 AALI-C Mgmt Requirements ..... | 7 |
| 3.1.1 Functional requirements for the HAM ..... | 8 |
| 3.2 AALI-C App Requirements ..... | 10 |
| 3.2.1 AALI-C-APP Transport Abstraction Requirements and Operations ..... | 10 |
| 3.3 AAL Information Model ..... | 11 |
| 3.3.1 Overview ..... | 11 |
| 3.3.2 AALI-C-Mgmt Information Model ..... | 12 |
| 3.3.2.1 Imported and associated information entities ..... | 12 |
| 3.3.2.1.2 Associated information entities and local labels ..... | 12 |
| 3.3.2.2 Class Diagram ..... | 12 |
| 3.3.2.3 Class Definitions ..... | 14 |
| 3.3.3 AALI-C-App Information Model ..... | 25 |
| 3.3.3.1 Imported and associated information entities ..... | 25 |
| 3.3.3.2 Class Diagram ..... | 25 |
| 3.3.3.3 Class Definitions ..... | 27 |
| 3.3.4 Naming convention and managed resource tags ..... | 29 |
| 3.3.4.1 API managed resources tags ..... | 29 |
| 3.3.4.2 API Naming Conventions ..... | 30 |
| 3.3.4.3 Model Conventions ..... | 30 |
| Chapter 4 AALI-C-Mgmt ..... | 30 |
| 4.1 AALI-C-Mgmt operations and events ..... | 30 |
| 4.2 AALI-C-Mgmt use case workflows ..... | 32 |
| 4.2.1 HW Accelerator installation/bootstrap use case workflow ..... | 32 |
| 4.2.1.1 Sequence Diagram ..... | 33 |
| 4.2.2 end-2-end Life Cycle Management use case workflow (Informational) ..... | 35 |
| 4.2.2.1 Sequence Diagram ..... | 37 |
| 4.2.3 HW Accelerator Manager (HAM) registration use case workflow ..... | 41 |
| 4.2.3.1 Sequence Diagram ..... | 42 |
| 4.3 AALI-C-Mgmt API details ..... | 43 |
| 4.3.1 Capabilities discovery and configuration ..... | 43 |
| 4.3.1.1 getAalHwAccelStatus ..... | 43 |
| 4.3.1.2 getAalLpuStatus ..... | 44 |
| 4.3.1.3 getAalAccelInfo ..... | 45 |
| 4.3.1.4 setAalAccelConfig ..... | 48 |
| 4.3.1.5 startAalLpu ..... | 51 |
| 4.3.1.6 stopAalLpu ..... | 52 |
| 4.3.1.7 Inventory Notifications ..... | 52 |
| 4.3.1.8 setAalAccelIdentifier ..... | 53 |
| 4.3.1.9 aalHamRegistrationNotification ..... | 54 |
| 4.3.2 Infrastructure Monitoring Service ..... | 55 |
| 4.3.2.1 Fault Service Operations ..... | 55 |
| 4.3.2.2 Fault Notifications ..... | 56 |
| Chapter 5 AALI-C-APP ..... | 60 |
| 5.1 AALI-C-App Identification & Representation ..... | 60 |
| | |
|----------------------------------------------------------------------------------------|------------|
| 5.2 AALI-C-App operations and events ..... | 61 |
| 5.3 AALI-C-App Operations and Events Sequence and State Diagram ..... | 62 |
| 5.3.1 AALI-C-App State ..... | 62 |
| 5.3.2 AALI-C-App API Init Sequence ..... | 64 |
| 5.3.3 AALI-C-Transport API Sequence ..... | 66 |
| 5.3.3.1 Allocation of AAL Buffer(s) ..... | 66 |
| 5.3.3.2 Procedure for Buffer(s) Send and Receive ..... | 70 |
| 5.4 AALI-C-App API details ..... | 90 |
| 5.4.1 Capabilities discovery and configuration ..... | 90 |
| 5.4.1.1 initAal ..... | 90 |
| 5.4.1.2 cleanupAal ..... | 90 |
| 5.4.1.3 getAalLpuInfo ..... | 91 |
| 5.4.2 AALI-C-App Configuration Services ..... | 92 |
| 5.4.2.1 createAalProfileInstance ..... | 92 |
| 5.4.2.2 setAalProfileInstanceConfig ..... | 93 |
| 5.4.2.3 deleteAalProfileInstance ..... | 93 |
| 5.4.2.4 setAalProfileQueueConfig ..... | 94 |
| 5.4.2.5 getAalProfileQueueConfig ..... | 95 |
| 5.4.2.6 getAalProfileInstanceConfig ..... | 96 |
| 5.4.3 AALI-C-App Transport Operations ..... | 97 |
| 5.4.3.1 createBufferPool ..... | 97 |
| 5.4.3.2 allocBuffer ..... | 98 |
| 5.4.3.3 getBufferAddr ..... | 100 |
| 5.4.3.4 getBufferSize ..... | 100 |
| 5.4.3.5 sendBuffer ..... | 101 |
| 5.4.3.6 receiveBuffer ..... | 103 |
| 5.4.3.7 freeBuffer ..... | 104 |
| 5.4.3.8 destroyBufferPool ..... | 105 |
| 5.4.4 AALI-C-App Administrative Operations ..... | 105 |
| 5.4.4.1 startAalProfileInstance ..... | 105 |
| 5.4.4.2 stopAalProfileInstance ..... | 106 |
| 5.4.4.3 startAalProfileQueue ..... | 107 |
| 5.4.4.4 stopAalProfileQueue ..... | 107 |
| <b>Annex A (normative): Acceleration Capability Requirements .....</b> | <b>108</b> |
| A.1 Capability requirements used in the placement of an AAL Application to an AF ..... | 108 |
# Chapter 1 Introductory Material
## 1.1 Scope
This Technical Specification has been produced by the O-RAN Alliance.
The contents of the present document are subject to continuing work within O-RAN and may change following formal O-RAN approval. Should the O-RAN Alliance modify the contents of the present document, it will be re-released by O-RAN with an identifying change of release date and an increase in version number as follows:
Release x.y.z
where:
- x the first digit is incremented for all changes of substance, i.e., technical enhancements, corrections, updates, etc. (the initial approved document will have x=01).
- y the second digit is incremented when editorial only changes have been incorporated in the document.
- z the third digit is included only in working versions of the document indicating incremental changes during the editing process.
The present document describes the functional requirements for the Hardware Accelerator Manager (HAM) and interface requirements for the AAL Common API (i.e., AALI-C-Mgmt and AALI-C-App interfaces). It also provides the specification of the AALI-C-Mgmt and AALI-C-App interfaces as well as the information elements exchanged over those interfaces.
## 1.2 References
- [1] 3GPP-TR-21.905: “Vocabulary for 3GPP Specifications”.
- [2] Void
- [3] O-RAN O-RAN.WG1.O-RAN-Architecture-Description
- [4] O-RAN O2 Interface General Aspects and Principles
- [5] O-RAN Cloudification and Orchestration Use Cases and Requirements for O-RAN Virtualized RAN
- [6] O-RAN O2ims Interface Specification
- [7] O-RAN Acceleration Abstraction Layer General Aspects and Principles
- [8] O-RAN Acceleration Abstraction Layer FEC Profiles
- [9] O-RAN Acceleration Abstraction Layer High-PHY Profiles
- [10] 3GPP TS 28.620: Telecommunication management; Fixed Mobile Convergence (FMC); Federated Network Information Model (FNIM); Umbrella Information Model (UIM))
- [11] 3GPP TS 28.622: Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)
- [12] 3GPP TS 32.156: " Model repertoire".
- [13] OAS 3.0 Specification: [OpenAPI Specification](#)
- [14] ITU-T X.731: Information Technology - Opens Systems Interconnection: State Management Function
- [15] IETF RFC 4122: “A Universally Unique IDentifier (UUID) URN Namespace”
- [16] IETF RFC 3986: IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax"
## 1.3 Definitions and Abbreviations
### 1.3.1 Definitions
For the purposes of the present document, the terms and definitions given in O-RAN Acceleration Abstraction Layer General Aspects and Principles [7] apply.
UUID Universally Unique Identifier [15]
URI Uniform Resource Identifier [16]
### 1.3.2 Abbreviations
For the purposes of the present document, the terms and definitions given in the O-RAN Acceleration Abstraction Layer General Aspects and Principles [7] apply. There are no additional abbreviations that are required aside from those in O-RAN Acceleration Abstraction Layer General Aspects and Principles [7].
# Chapter 2 Overview
## 2.1 General
The AAL General Aspects and Principles are described in [7] and the AAL architecture including the AAL interfaces are depicted in figure 4.2-1 in [7].
The set of interfaces used to expose AAL functionality is the following:
1. AALI-C: AAL-Profile independent set of interfaces addressing all the independent aspects of the underlying AAL Implementation(s) within an O-Cloud platform.
2. AALI-P: A set of AAL-Profile specific interfaces dependent upon the AAL-Profile selected e.g., FEC.
The AALI-P interfaces are specified in FEC[8] and High-PHY specifications [9].
Within the AALI-C interface set there are two interfaces:
1. AALI-C-Mgmt: Interface used for common administrative operations, actions, and events between the O-Cloud IMS and the HW Accelerator Manager (HAM) for resources exposed by this interface. The IMS provides the O2 interface towards the SMO. The HAM exposes the AALI-C-Mgmt interface towards IMS.
2. AALI-C-App: Interface used for common operations/actions/events toward an AAL Application for resources exposed by this interface. These operations are between the AAL Implementation and the AAL Application (AAL-App).
The present document specifies the list of AALI-C-Mgmt and AALI-C-App interface operations and events, description with input/outputs, information models, object models, state transition diagrams and requirements.
NOTE: The scope of the interfaces specification in this document is between the O-Cloud IMS and the HAM as well as between the AAL Implementation and the AAL Application. Interactions between the IMS and SMO is part of the O2 IMS specification. [6]
## 2.2 Document Structure
This present document is structured as follows:
Chapter 2 presents the overview and main purpose of this specification.
Chapter 3 presents a list of requirements and object model.
Chapter 4 presents the initialization and flow, operations and events associated with AALI-C-Mgmt.
Chapter 5 presents the initialization and flow, operations and events associated with AALI-C-App.
Annex A identifies the common acceleration capability requirements used for placing AFs.
# Chapter 3 AAL Common requirements and Object Model
## 3.1 AALI-C Mgmt Requirements
The following table described the AAL-C-Mgmt interface requirements. The HAM shall support producing the AAL-C-Mgmt interface. The consumer of the interface is IMS.
**Table 3.1-1: AALI-C-Mgmt Interface Requirements**
| | Description | Additional Info (TBD) |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|
| [REQ-AALI-C-MGMT1a] | The AALI-C-Mgmt interface shall support unique identifiers for the HW Accelerators within an O-Cloud. | |
| [REQ-AALI-C-MGMT1b] | The AALI-C-Mgmt interface shall support unique identifiers for the AAL-LPUs within an O-Cloud. | |
| [REQ-AALI-C-MGMT2] | The AALI-C-Mgmt interface shall support querying inventory and capabilities information of the HW Accelerator. Inventory and capabilities information are related to the HW Accelerators and AAL-LPUs. | |
| [REQ-AALI-C-MGMT3] | VOID | |
| [REQ-AALI-C-MGMT4] | The AALI-C-Mgmt interface shall provide fault information for the HW Accelerator and AAL-LPUs. AALI-C-Mgmt interface shall support the autonomous sending of notification when a fault has been raised. AAL-C-Mgmt interface shall also be able to reply to on demand queries of faults (e.g., active faults). | |
| [REQ-AALI-C-MGMT5] | The AALI-C-Mgmt interface shall provide logs for the HW Accelerator and AAL-LPUs. Logs can be related to faults, debugging info etc. The AAL-C-Mgmt interface shall support operations like starting and stopping the logs collection and support the logs retrieval. | |
| [REQ-AALI-C-MGMT6] | AALI-C-Mgmt interface shall support providing performance information for the HW Accelerator and AAL-LPUs. The AAL-C-Mgmt interface shall support the autonomous sending of notification with PM info (e.g., periodically or due to an event). AAL-C-Mgmt interface shall also be able to reply to on demand queries for PM data. | |
| [REQ-AALI-C-MGMT7] | The AALI-C-Mgmt interface shall provide state management services for HW Accelerator and AAL-LPUs. Examples of state management operations are support querying the status and state information, autonomous notification of state changes, restart/reset HW Accelerator, Power Cycle HW Accelerator, Start AAL-LPU and Stop AAL-LPU. | |
| [REQ-AALI-C-MGMT8] | The AALI-C-Mgmt interface shall provide configuration management services. Examples of operations related to configuration management are the following: <ul style="list-style-type: none"> <li>• Configure the number of AAL-LPUs to be supported.</li> <li>• Configure the Profiles to be support on the AAL-LPUs.</li> <li>• Retrieve AAL-LPU capabilities.</li> <li>• Configure performance collection interval.</li> </ul> | |
| [REQ-AALI-C-MGMT9] | The AALI-C-Mgmt interface shall support the installation and upgrade of the HW Accelerator Drivers/FW. | |
| | | |
|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|
| [REQ-AALI-C-MGMT10] | Void | |
| [REQ-AALI-C-MGMT11] | Void | |
| [REQ-AALI-C-MGMT12] | Void | |
| [REQ-AALI-C-MGMT13] | Void | |
| [REQ-AALI-C-MGMT14] | Void | |
| [REQ-AALI-C-MGMT15] | The AALI-C-Mgmt interface shall provide the ability to report the default values for attributes associated with AAL-Profiles that are supported by the HW Accelerator. | |
| [REQ-AALI-C-MGMT16] | The AALI-C-Mgmt interface shall report the capabilities associated with AAL-Profiles that are supported by the HW Accelerator. | |
### 3.1.1 Functional requirements for the HAM
The following tables describe functional requirements for the HAM.
**Table 3.1.1-1: Functional requirements for HWA and LPUs lifecycle management**
| | Description |
|-------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [REQ-HAM-LCM 1] | The HAM shall support the capability to expose inventory information and capabilities of the physical and logical partitioning of the hardware and software acceleration resources. |
| [REQ-HAM-LCM 2] | The HAM shall support the capability to discover the capabilities of the HW Accelerator(s). |
| [REQ-HAM-LCM 3] | The HAM shall support the capability to configure the HW Accelerator. See NOTE. |
| [REQ-HAM-LCM 4] | The HAM shall provide the capability to preserve HWA and AAL-LPU identifiers that are provided either by the IMS or the HAM and used in the AALI-C-Mgmt APIs: <ul style="list-style-type: none"> <li>HAM, O-Cloud node, HWA, AAL-LPU planned and unplanned restarts or reboots,</li> <li>HAM, O-Cloud node, HWA, AAL-LPU SW updates or configuration changes.</li> </ul> |
| NOTE: The configuration of the HW Accelerator Manager may include HW Accelerator resource assignment to AAL-LPUs. | |
**Table 3.1.1-2: Functional requirements for faults and logs management**
| | Description |
|----------------|-------------------------------------------------------------------------------------------------------------|
| [REQ-HAM-FM 1] | The HAM shall support the capability to expose fault information related to the HWA(s) it manages to IMS. |
| [REQ-HAM-FM 2] | The HAM shall support the capability to expose fault information related to the LPU(s) it manages to IMS. |
| [REQ-HAM-FM 3] | The HAM shall support the capability to expose logging information related to the HWA(s) it manages to IMS. |
| [REQ-HAM-FM 4] | The HAM shall support the capability to expose logging information related to the LPU(s) it manages to IMS. |
**Table 3.1.1-3: Functional requirements for performance management**
| | Description |
|-----------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|
| [REQ-HAM-PM 1] | The HAM shall support the capability of performance management of HWAs. |
| [REQ-HAM-PM 2] | The HAM shall support the capability to expose performance information related to the HWA it manages (see NOTE). |
| [REQ-HAM-PM 3] | In response to a query, the HAM shall support the capability to provide the information about active PM jobs which match filtering criteria. |
| NOTE: Performance information can be also related to collected performance information of the LPUs that are operating on the HWA. | |
**Table 3.1.1-4: Functional requirements for security considerations**
| | Description |
|-----------------|--------------------------------------------------------------|
| [REQ-HAM-SEC 1] | The HAM shall support being certified by the O-Cloud vendor. |
**Table 3.1.1-5: Functional requirements for software management**
| | Description |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|
| [REQ-HAM-SW 1] | The HAM shall support the capability to update and/or upgrade the software for an HWA on the O-Cloud node. See NOTE. |
| NOTE: An example of this may include the programming or re-programming of a downloadable firmware or driver upgrades. Updates/Upgrades can be done locally or remotely. | |
**Table 3.1.1-6: Functional requirements for HAM registration to IMS exposure of the AAL-C-Mgmt interface**
| | Description |
|-----------------|-----------------------------------------------------------------------------------------------------------------------------|
| [REQ-HAM-REG 1] | The HAM shall be able to be configured with an IMS service endpoint. |
| [REQ-HAM-REG 2] | The HAM shall be able to be configured with a local HAM service endpoint that the IMS will use to communicate with the HAM. |
| [REQ-HAM-REG 3] | The HAM shall be able to register the HAM service endpoint with the IMS via the AAL-C-Mgmt interface. |
**Table 3.1.1-7: Functional requirements for HAM related to AAL-Profiles**
| | Description |
|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [REQ-HAM-PROF 1] | The HAM shall provide the ability to retrieve the default values for attributes associated with AAL-Profiles that are supported by the HW Accelerator. See NOTE. |
| [REQ-HAM-PROF 2] | The HAM shall provide the ability to report the default values for attributes associated with AAL-Profiles that are supported by the HW Accelerator. |
| [REQ-HAM-PROF 3] | The HAM shall provide the ability to report the capabilities associated with AAL-Profiles that are supported by the HW Accelerator. |
NOTE: The mechanisms for the specification and retrieval of the default values for the AAL-Profile are vendor specific behaviour.
## 3.2 AALI-C App Requirements
**Table 3.2-1: AALI-C-App Requirements**
| Requirement Number | Description | Additional Info |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|
| [REQ-AALI-C-APP-1] | During deployment, the DMS shall provide the AAL Application with a list of LPU identifiers that the DMS has assigned to the AAL Application. | DMS-AAL Interface |
| [REQ-AALI-C-APP-2] | During deployment, the DMS may provide the AAL Application with additional attributes needed by the AAL Implementation for the AAL Implementation to initialize the AAL Implementation for the AAL Application. | DMS-AAL Interface |
| [REQ-AALI-C-APP-3] | During deployment, the AAL Application shall pass the information provided by the DMS that is needed to initialize the AAL Implementation for the AAL Application. | DMS-AAL Interface |
| NOTE: The above AAL requirements (REQ-AALI-C-APP-1 to 3) for DMS to AAL interface are out of scope for the current version of the AAL Common API specification. | | |
### 3.2.1 AALI-C-APP Transport Abstraction Requirements and Operations
The transport between an AAL Application and an AAL Implementation can be of different types (e.g., based on shared memory, PCIe interconnect, over Ethernet). AALI-C-App shall support abstraction of these various transport mechanisms between an AAL Application and an AAL Implementation through a set of common transport APIs, constituting a transport abstraction framework.
**Table 3.2.1-1: AALI-C-App Transport Abstraction Framework Requirements**
| Requirement Number | Description | Operation |
|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------|
| [REQ-AALI-C-APP-TRANSPORT1] | The Transport Abstraction Framework shall provide a method for the AAL Application to request an AAL Implementation to create buffer pool(s) constituting of buffers(s) of one size or more than <i>one size</i> . | createBufferPool (Sec. 5.4.3.1) |
| [REQ-AALI-C-APP-TRANSPORT2] | The Transport Abstraction Framework shall provide a method for the AAL Application to request an AAL Implementation to allocate buffers. | allocBuffer (Sec. 5.4.3.2) |
| [REQ-AALI-APP-TRANSPORT3] | The Transport Abstraction Framework shall support Synchronous (blocking), and Asynchronous (non-blocking) interactions for operations related to sending and receiving buffer(s) by the AAL Application. | sendBuffer (Sec. 5.4.3.5)<br>receiveBuffer (Sec. 5.4.3.6) |
| [REQ-AALI-C-APP-TRANSPORT4] | <p>The Transport Abstraction Framework shall support a method of enabling buffer ownership transfer from the AAL Application to the AAL Implementation.</p> <ul style="list-style-type: none"> <li>When the AAL Application retains ownership of buffer(s), the AAL Implementation shall not free the</li> </ul> | |
| | | |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|
| | buffer(s) on completion of an operation until buffer ownership is transferred by the AAL Application. <ul style="list-style-type: none"> <li>If the AAL Application does not retain ownership of the buffer(s), the AAL Implementation shall assume ownership and free the buffer(s) on completion of an operation</li> </ul> | |
| [REQ-AALI-C-APP-TRANSPORT5] | The Transport Abstraction Framework shall support a method for the AAL Application to receive data in the buffer(s) allocated by the AAL Application or the AAL Implementation. | receiveBuffer (Sec. 5.4.3.6) |
| [REQ-AALI-C-APP-TRANSPORT6] | The Transport Abstraction Framework shall support a method for freeing pre-allocated buffer(s). | receiveBuffer (Sec. 5.4.3.6) |
| [REQ-AALI-C-APP-TRANSPORT7] | The Transport Abstraction Framework shall support a method for destroying pre-created buffer pool(s). | freeBuffer (Sec. 5.4.3.7) |
| NOTE: Synchronous (Blocking) API - blocks until the operation is complete and returns the status of the operation execution (success/failure). Asynchronous (Non-Blocking) API - returns immediately before the operation is complete. The AAL Application invoking API calls in this mode can pre-register for a callback. | | |
## 3.3 AAL Information Model
### 3.3.1 Overview
The AALI-C-Mgmt interface is the management interface that is used by the IMS for administrative operations/actions/events. The HAM terminates the AALI-C-Mgmt interface.
Operations and actions/events via AALI-C-Mgmt are applicable on the following entities:
- HW Accelerator
- AAL Logical Processing Unit (AAL-LPU)
- AAL Profile
The AALI-C-App interface is exposed by the AAL Implementation and is used by the AAL Application to discover, configure, and manage the AAL-Profile-Instance(s) and AAL-Profile-Queue(s) in the AAL-LPU assigned to the AAL Application.
NOTE: An AAL Application may choose to use one or more AAL Profiles as part of its implementation.
Operations and actions/events via AALI-C-App are applicable on the following entities:
- AAL Logical Processing Unit (AAL-LPU)
- AAL Profile Instance
- AAL Profile Queue
```
graph TD
subgraph Logical_Managed_Resource [Logical Managed Resource]
AAL_Profile_Instance_A[AAL Profile Instance A]
AAL_Profile_Instance_B[AAL Profile Instance B]
AAL_Profile_Instance_C[AAL Profile Instance C]
AAL_Profile_Instance_A2[AAL Profile Instance A]
AAL_Profile_Instance_E[AAL Profile Instance E]
AAL_LPU[AAL-LPU]
AA_LPU[AA-LPU]
AAL_LPU2[AAL-LPU]
end
subgraph Physical_Managed_Resource [Physical Managed Resource]
HW_Accelerator[HW Accelerator]
end
AAL_LPU --- HW_Accelerator
AA_LPU --- HW_Accelerator
AAL_LPU2 --- HW_Accelerator
```
Diagram showing the AAL Information Model architecture. It illustrates the relationship between Logical Managed Resources (AAL-LPU, AA-LPU, AAL-LPU) and Physical Managed Resources (HW Accelerator). AAL Profile Instances (A, B, C, A, E) are shown as components of the AAL-LPU.
**Figure 3.3-1: Physical and Logical resources**
NOTE: The definition of these entities are defined in GAnP specification [7] section 1.3: The cardinality and relationship between these entities are derived from the GAnP specification [7] section 2.3. The various scenarios supported are also available in the GAnP [7] section 5.
The Information model defined in [6] will be used to define these managed resources.
NOTE 1: Usage of 'M', 'O', and 'CM' imply Mandatory, Optional and Conditional Mandatory in the spec
### 3.3.2 AALI-C-Mgmt Information Model
#### 3.3.2.1 Imported and associated information entities
##### 3.3.2.1.1 Imported information entities and local labels
Information entities imported into the model are used for inheritance purposes.
**Table 3.3.2.1.1-1 AALI-C-Mgmt Imported Information Entities and Local Labels**
| Label reference | Local label |
|--------------------------------------------------------------|-------------|
| TS 28.622 [10] Information Object Class, TS 28.620 [11] Top_ | Top_ |
##### 3.3.2.1.2 Associated information entities and local labels
Information entities referenced in the model through an association that is not based on inheritance are listed in the associated entities table.
**Table 3.3.2.1.2-1 AALI-C-Mgmt Associated Information Entities and Local Labels**
| Label reference | Local label |
|-----------------|-------------|
| | |
#### 3.3.2.2 Class Diagram
##### 3.3.2.2.1 Relationships
```
@startuml
skin rose
skinparam ClassStereotypeFontStyle normal
skinparam style strictuml
hide members
Namespace ORAN.AALI.Mgmt {
Class "HwAccel (HW Accelerator)" as hwa <<Information Object Class>> {
}
Class "AalLpu (AAL-LPU)" as lpu <<Information Object Class>> {
}
Class "AalProfile (AAL Profile)" as profile <<data Type>> {
}
```
```
}
Class "Fault" as fault <<dataType>> {
}
Class "AalLpuConfiguration" as lpuConfig <<dataType>> {
}
Class "HW Accelerator Manager" as ham <<Information Object Class>> {
}
Class "AalProfileTemplate" as aalProfileTemplate <<dataType>> {
}
hwa "1" *-down- "<U+002B>aalProfileTemplates\n1..*" aalProfileTemplate
hwa "1" *-down- "<U+002B>aalLpus\n0..*" lpu
hwa "1" -down-> "0..*" fault: faults
lpu "1" -right-> "0..*" fault: fault
lpu "1..*" -down-> "<U+002B>aalLpuConfig\n1" lpuConfig
lpu "1" -down-> "<U+002B>supportedAalProfiles\n\t\t\t0..*" profile
}
@enduml
```
```
classDiagram
class HWAcceleratorManager["«Information Object Class» HW Accelerator Manager"]
class HwAccel["«Information Object Class» HwAccel (HW Accelerator)"]
class AalLpu["«Information Object Class» AalLpu (AAL-LPU)"]
class Fault["«dataType» Fault"]
class AalProfileTemplate["«dataType» AalProfileTemplate"]
class AalProfile["«dataType» AalProfile (AAL Profile)"]
class AalLpuConfiguration["«dataType» AalLpuConfiguration"]
HWAcceleratorManager --> AalLpu : +aalLpus 0..*
HwAccel --> AalLpu : 1
HwAccel --> Fault : 1 faults 0..*
HwAccel --> AalProfileTemplate : 1 +aalProfileTemplates 1..*
AalLpu --> Fault : 1 fault 0..*
AalLpu --> AalProfile : 1 +supportedAalProfiles 0..*
AalLpu --> AalLpuConfiguration : 1 +aalLpuConfig 1
```
UML Class Diagram for OCloud.AALI.Mgmt showing relationships between HW Accelerator Manager, AalLpu (AAL-LPU), Fault, AalProfileTemplate, AalProfile (AAL Profile), and AalLpuConfiguration.
Figure 3.3.2.2.1-1: AALI-C-Mgmt Class Relationships
Editor's Note: Open Action: Requires coordinated adjustment in WG6/WG10 specification.
Editor's Note: The identification of the HAM and the HAM relationship with the IMS and O-Cloud Infrastructure is FFS.
##### 3.3.2.2.2 Inheritance
```
@startuml
skin rose
skinparam ClassStereotypeFontStyle normal
```
```
skinparam style strictuml
hide members
Namespace ORAN.AALI.App {
Class "AalLpu (AAL-LPU)" as lpu <<Information Object Class>> {
}
Class "AalProfileInstance (AAL Profile Instance)" as profilei <<Information Object Class>> {
}
Class "AalProfileQueue (AAL Profile Queue)" as queue <<Information Object Class>> {
}
lpu "1" *-- "<U+002B>aalProfileInstances\n\t\t\t0..*" profilei
profilei "1" *-down- "<U+002B>aalProfileQueues\n\t\t\t0..*" queue
}
@enduml
```
```
classDiagram
class AalLpu["«Information Object Class»\nAalLpu (AAL-LPU)"]
class AalProfileInstance["«Information Object Class»\nAalProfileInstance (AAL Profile Instance)"]
class AalProfileQueue["«Information Object Class»\nAalProfileQueue (AAL Profile Queue)"]
AalLpu "1" -- "0..*" AalProfileInstance : +aalProfileInstances
AalProfileInstance "1" -- "0..*" AalProfileQueue : +aalProfileQueues
```
UML Class Diagram showing AALI-C-Mgmt Class Inheritance. The diagram is titled 'OCloud.AALI.App'. It contains three classes: 'AalLpu (AAL-LPU)', 'AalProfileInstance (AAL Profile Instance)', and 'AalProfileQueue (AAL Profile Queue)'. All three classes are marked as '«Information Object Class»'. 'AalLpu' has an association with 'AalProfileInstance' labeled '+aalProfileInstances' with multiplicity '1' at 'AalLpu' and '0..\*' at 'AalProfileInstance'. 'AalProfileInstance' has an association with 'AalProfileQueue' labeled '+aalProfileQueues' with multiplicity '1' at 'AalProfileInstance' and '0..\*' at 'AalProfileQueue'.
Figure 3.3.2.2.2-1: AALI-C-Mgmt Class Inheritance
#### 3.3.2.3 Class Definitions
##### 3.3.2.3.1 HwAccel <<InformationObjectClass>>
###### 3.3.2.3.1.1 Definition
The ORAN.AALI.Mgmt.HwAccel class represents the HW Accelerator.
###### 3.3.2.3.1.2 Attributes
Table 3.3.2.3.1.2-1 Attributes Properties for HwAccel
| Attribute name | Data Type/Description | Properties |
|----------------|--------------------------|------------------------|
| hwAccelId | <b>Data Type:</b> string | x-support-qualifier: M |
| Attribute name | Data Type/Description | Properties |
|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| | <b>Description:</b> UUID identifier for an instance of the HW Accelerator.<br><br>This identifier is unique within the O-Cloud.<br><br>Data Type pattern and examples are given in [15] | readOnly: False<br>x-isInvariant: False<br>x-inventoryNotification: True<br>nullable: False<br>format: uuid |
| operationalState | <b>Data Type:</b> string<br><br><b>Description:</b> Reflects the HW Accelerator's operational state as defined in clause 7.1.1 of ITU X.731. | x-support-qualifier: M<br>readOnly: True<br>x-isInvariant: False<br>x-inventoryNotification: False<br>nullable: False<br>enum:<br>- DISABLED<br>- ENABLED<br>default: DISABLED |
| operationalConditions | <b>Data Type:</b> array<br><br><b>Description:</b> List of conditions that support the operational state of the entity. | x-support-qualifier: M<br>readOnly: True<br>x-isInvariant: False<br>x-inventoryNotification: False<br>nullable: False<br>enum:<br>- UNKNOWN<br>- STARTED<br>default: UNKNOWN |
| serialNum | <b>Data Type:</b> string<br><br><b>Description:</b> Serial number of this entity. | x-support-qualifier: M<br>readOnly: True<br>x-isInvariant: True<br>x-inventoryNotification: True<br>nullable: False |
| vendorName | <b>Data Type:</b> string<br><br><b>Description:</b> Name of the Vendor/Provider of the entity. | x-support-qualifier: M<br>readOnly: True<br>x-isInvariant: True<br>x-inventoryNotification: True<br>nullable: False |
| model | <b>Data Type:</b> string<br><br><b>Description:</b> Information about the model of the entity. | x-support-qualifier: M<br>readOnly: True<br>x-isInvariant: True<br>x-inventoryNotification: True<br>nullable: False |
| hwVersion | <b>Data Type:</b> string<br><br><b>Description:</b> Version or generation of the entity. | x-support-qualifier: M<br>readOnly: True<br>x-isInvariant: True<br>x-inventoryNotification: True<br>nullable: False<br>example: '1.9.0' |
| maxNumAalLpus | <b>Data Type:</b> integer<br><br><b>Description:</b> This attribute may be included if a HW Accelerator has an upper limit on AAL-LPUs it can support. Actual number of AAL-LPUs available at runtime may be lower based on resource usage, AAL-LPU SW used, and | x-support-qualifier: O<br>readOnly: True<br>x-isInvariant: False<br>x-inventoryNotification: True<br>nullable: True<br>format: integer8<br>minimum: 0 |
| Attribute name | Data Type/Description | Properties |
|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| | AAL-Profile SW and types instantiated on the AAL-LPU(s). | |
| aalProfileTemplates | <b>Data Type:</b> array<br><br><b>Description:</b> The list of AAL-Profile templates supported by the Accelerator. The AAL-Profile templates can be used to configure LPUs within the Accelerator. | x-support-qualifier: M<br>x-isInvariant: False<br>x-inventoryNotification: True<br>nullable: False<br>x-isOrdered: False<br>title: AAL-Profile Templates<br>minItems: 1<br>uniqueItems: True<br>items: AalProfileTemplate |
| faults | <b>Data Type:</b> array<br><br><b>Description:</b> The list of current fault conditions. | x-support-qualifier: M<br>readOnly: True<br>x-isInvariant: False<br>x-inventoryNotification: False<br>nullable: False<br>x-isOrdered: False<br>title: faults<br>maxItems: *<br>minItems: 0<br>uniqueItems: True<br>items: Fault |
| lpuType | <b>Data Type:</b> string<br><br><b>Description:</b> The method to apply the configuration settings for the aalLpus associated with a HW Accelerator. | x-support-qualifier: M<br>x-isInvariant: False<br>x-inventoryNotification: True<br>nullable: False<br>enum:<br>- Single<br>- Mixed<br>default: Mixed |
| numAalLpusConfigured | <b>Data Type:</b> integer8<br><br><b>Description:</b> The number of aalLpus currently configured. | x-support-qualifier: M<br>x-isInvariant: False<br>x-inventoryNotification: True<br>nullable: False<br>format: integer8<br>minimum: 0 |
| aalLpus | <b>Data Type:</b> array<br><br><b>Description:</b> The list of AAL-LPUs configured for this HW Accelerator.<br><br>The number of aalLpu instances is determined by the value of the numAalLpusConfigured attribute. | x-support-qualifier: M<br>x-isInvariant: False<br>x-inventoryNotification: True<br>nullable: False<br>x-isOrdered: False<br>title: AAL LPUs<br>minItems: 0<br>uniqueItems: True<br>items: AalLpu |
| imageVersion | <b>Data Type:</b> string<br><br><b>Description:</b> The version for the image applied to the HW Accelerator. | x-support-qualifier: M<br>x-isInvariant: False<br>x-inventoryNotification: True<br>nullable: False<br>example: '1.9.0' |
| imageLocation | <b>Data Type:</b> string<br><br><b>Description:</b> URI[16] Path to the software/firmware image. | x-support-qualifier: M<br>x-isInvariant: False<br>x-inventoryNotification: True<br>nullable: False<br>format: uri |
| extensions | <b>Data Type:</b> array<br><br><b>Description:</b> The list of | x-support-qualifier: M<br>x-isInvariant: False |
| | | |
|--|--------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|
| | unspecified (not standardized) properties for the entity which are tailored by the vendor. | x-inventoryNotification True<br>nullable: False<br>x-isOrdered: False<br>title: extensions<br>minItems: 0<br>uniqueItems: True<br>items: AttributeValuePair |
|--|--------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|
###### 3.3.2.3.1.3 Attribute constraints
None
###### 3.3.2.3.1.4 State diagram
###### 3.3.2.3.1.4.1 Introduction
The HWAccel maintains an operational state of the entity as defined in clause 7.1.1 of ITU X.731 [14]. How the HW Accel determines its operational state is implementation specific.
##### 3.3.2.3.2 AalLpu <<InformationObjectClass>>
###### 3.3.2.3.2.1 Definition
The ORAN.AALI.Mgmt.AalLpu class represents the AAL-LPU.
###### 3.3.2.3.2.2 Attributes
**Table 3.3.2.3.2.2-1 Attributes Properties for AalLpu**
| Attribute name | Data Type/Description | Properties |
|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| aalLpuId | <b>Data Type:</b> string<br><br><b>Description:</b> UUID identifier for an instance of the AAL-LPU.<br><br>This identifier is unique within the O-Cloud.<br><br>Data Type pattern and examples are given in [15] | x-support-qualifier: M<br>readOnly: False<br>x-isInvariant: False<br>x-inventoryNotification True<br>nullable: False<br>format: uuid |
| operationalState | <b>Data Type:</b> string<br><br><b>Description:</b> Reflects the AAL-LPU's operational state as defined in clause 7.1.1 of ITU X.731. | x-support-qualifier: M<br>readOnly: True<br>x-isInvariant: False<br>x-inventoryNotification False<br>nullable: False<br>enum:<br>- DISABLED<br>- ENABLED<br>default: DISABLED |
| operationalConditions | <b>Data Type:</b> array<br><br><b>Description:</b> List of conditions that support the operational state of the entity. | x-support-qualifier: M<br>readOnly: True<br>x-isInvariant: False<br>x-inventoryNotification False<br>nullable: False<br>enum:<br>- UNKNOWN<br>- STARTED<br>- STARTINGUP<br>- SHUTTINGDOWN |
| Attribute name | Data Type/Description | Properties |
|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| | | - STOPPED<br>default: UNKNOWN |
| faults | <b>Data Type:</b> array<br><br><b>Description:</b> The list of current fault conditions. | x-support-qualifier: M<br>readOnly: True<br>x-isInvariant: False<br><br>x-inventoryNotification: False<br>nullable: False<br>x-isOrdered: False<br>title: faults<br>maxItems: *<br>minItems: 0<br>uniqueItems: True<br>items: Fault |
| supportedAalProfiles | <b>Data Type:</b> array<br><br><b>Description:</b> The list of supported AAL Profiles. | x-support-qualifier: M<br>x-isInvariant: False<br>x-inventoryNotification: True<br>nullable: False<br>x-isOrdered: False<br>title: AAL Profiles<br><br>minItems: 0<br>uniqueItems: True<br>items: AalProfile |
| imageVersion | <b>Data Type:</b> string<br><br><b>Description:</b> The version or generation for the image applied to the entity.<br><br>If an AAL-LPU image is the same as the Accelerator HW's image, then the HW Accelerator's imageVersion attribute and this attribute would contain the same value. | x-support-qualifier: M<br>x-isInvariant: False<br>x-inventoryNotification: True<br>nullable: False<br>example: '1.9.0' |
| imageLocation | <b>Data Type:</b> string<br><br><b>Description:</b> URI [16] Path to the software/firmware image.<br><br>If an AAL-LPU image is the same as the Accelerator HW's image, then the HW Accelerator's imageLocation attribute and this attribute would contain the same value. | x-support-qualifier: M<br>x-isInvariant: False<br>x-inventoryNotification: True<br>nullable: False<br>format: uri |
| aalLpuConfig | <b>Data Type:</b> AalLpuConfig<br><br><b>Description:</b> The common configuration attributes that are common to one or more AAL-LPUs including this AAL-LPU. | x-support-qualifier: M<br>x-isInvariant: False<br>x-inventoryNotification: True<br>nullable: False |
###### 3.3.2.3.2.3 Attribute constraints
None
###### 3.3.2.3.2.4 State diagram
###### 3.3.2.3.2.4.1 Introduction
The AAL-LPU maintains an operational state of the entity as defined in clause 7.1.1 of ITU X.731 [14]. How the AAL-LPU determines its operational state is implementation specific.
##### 3.3.2.3.3 AalProfile <<dataType>>
###### 3.3.2.3.3.1 Definition
The ORAN.AALI.Mgmt.AalProfile class represents the AAL-Profile.
###### 3.3.2.3.3.2 Attributes
**Table 3.3.2.3.3.2-1 Attributes Properties for AalProfile**
| Attribute name | Data Type/Description | Properties |
|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| name | <b>Data Type:</b> string<br><br><b>Description:</b> Name identifier of the AAL Profile. | x-support-qualifier: M<br>readOnly: True<br>x-isInvariant: True<br>x-inventoryNotification: True<br>nullable: False<br>format: string |
| version | <b>Data Type:</b> string<br><br><b>Description:</b> The version of AAL Profile. | x-support-qualifier: M<br>x-isInvariant: False<br>x-inventoryNotification: True<br>nullable: False<br>example: '1.9.0' |
| imageVersion | <b>Data Type:</b> string<br><br><b>Description:</b> The version or generation for the image of the entity.<br><br>If an AAL-Profile image is the same as the AAL-LPU's image then the AAL-LPU's imageVersion attribute and this attribute would contain the same value. | x-support-qualifier: M<br>x-isInvariant: False<br>x-inventoryNotification: True<br>nullable: False<br>example: '1.9.0' |
| imageLocation | <b>Data Type:</b> string<br><br><b>Description:</b> Path to the software/firmware image.<br><br>If an AAL-Profile image is the same as the AAL-LPU's image then the AAL-LPU's imageLocation attribute and this attribute would contain the same value. | x-support-qualifier: M<br>x-isInvariant: False<br>x-inventoryNotification: True<br>nullable: False<br>format: uri |
| attributes | <b>Data Type:</b> array<br><br><b>Description:</b> The list of AAL-Profile attributes represented as key/value pairs.<br><br>The values for entries in this list that are duplicates of entries in the AALProfileTemplate's attributes | x-support-qualifier: M<br>x-isInvariant: True<br>x-inventoryNotification: True<br>nullable: False<br>x-isOrdered: False<br>title: Attributes<br>minItems: 0<br>uniqueItems: True<br>items: AttributeVa |
| Attribute name | Data Type/Description | Properties |
|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| | attribute override the value provided by the AALProfileTemplate attributes attribute's entry. | AttributeVa<br>luePair |
| extensions | <b>Data Type:</b> array<br><br><b>Description:</b> The list of AAL-Profile unspecified (not standardized) attributes represented as key/value pairs. The structure and format of the value attribute is specified as part of the definition of the key.<br><br>The values for entries in this list that are duplicates of entries in the AALProfileTemplate's extensions attribute override the value provided by the AALProfileTemplate extensions attribute's entry. | x-support-qualifier: M<br>x-isInvariant: False<br>x-inventoryNotification True<br>nullable: False<br>x-isOrdered: False<br>title: Extension<br>Attributes<br>minItems: 0<br>uniqueItems: True<br>items: AttributeVa<br>luePair |
###### 3.3.2.3.3.3 Attribute constraints
None
###### 3.3.2.3.3.4 State diagram
None
##### 3.3.2.3.4 Fault <<dataType>>
###### 3.3.2.3.4.1 Definition
The ORAN.AALI.Mgmt.Fault class represents a current Fault condition associated with an entity.
###### 3.3.2.3.4.2 Attributes
**Table 3.3.2.3.4.2-1 Attributes Properties for Fault**
| Attribute name | Data Type/Description | Properties |
|----------------|--------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|
| faultId | <b>Data Type:</b> string<br><br><b>Description:</b> The identifier for the fault condition. | x-support-qualifier: M<br>readOnly: True<br>x-isInvariant: True<br>x-inventoryNotification False<br>nullable: False |
| detectedTime | <b>Data Type:</b> string<br><br><b>Description:</b> The date and time the fault condition was last detected. | x-support-qualifier: M<br>readOnly: True<br>x-isInvariant: False<br>x-inventoryNotification False<br>nullable: False<br>format: date-time |
###### 3.3.2.3.4.3 Attribute constraints
None
###### 3.3.2.3.4.4 State diagram
None
##### 3.3.2.3.5 AalLpuConfig <<dataType>>
###### 3.3.2.3.3.1 Definition
The ORAN.AALI.Mgmt.AalLpuConfig class represents the AAL-LPU configuration settings to be applied to an instance of an AAL-LPU.
The AAL-LPU's HW Accelerator determines how the AAL-LPU configuration settings are applied using the HW Accelerators lpuType and numAalLpusConfigured attributes. If the lpuType attribute's value is "mixed", then each AAL-LPU for the HW Accelerator has a different instance of the AalLpuConfig entity. If the lpuType attribute's value is "single" then all AAL-LPUs for the HW Accelerator share the same instance of the AalLpuConfig entity.
###### 3.3.2.3.5.2 Attributes
**Table 3.3.2.3.5.2-1 Attributes Properties for AalLpuConfig**
| Attribute name | Data Type/Description | Properties |
|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| memory | <b>Data Type:</b> integer<br><br><b>Description:</b> Memory allocated to this entity. | x-support-qualifier: 0<br>x-isInvariant: False<br>x-inventoryNotification: True<br>nullable: True<br>format: integer64<br>x-units: bytes |
| multiprocessorNum | <b>Data Type:</b> integer<br><br><b>Description:</b> Number of multiprocessors allocated to this entity. | x-support-qualifier: 0<br>x-isInvariant: False<br>x-inventoryNotification: True<br>nullable: True<br>format: integer8<br>minimum: 1 |
| computeSlicesNum | <b>Data Type:</b> integer<br><br><b>Description:</b> Number of compute-slices allocated to this entity. | x-support-qualifier: 0<br>x-isInvariant: False<br>x-inventoryNotification: True<br>nullable: True<br>format: integer8<br>minimum: 1 |
| extensions | <b>Data Type:</b> array<br><br><b>Description:</b> The list of unspecified (not standardized) properties defined by vendors that used for the configuration of the AAL-LPU.of the AAL-LPU. | x-support-qualifier: M<br>x-isInvariant: False<br>x-inventoryNotification: True<br>nullable: False<br>x-isOrdered: False<br>title: Extensions<br>minItems: 0<br>uniqueItems: True<br>items: AttributeValuePair |
###### 3.3.2.3.5.3 Attribute constraints
None
###### 3.3.2.3.5.4 State diagram
None
##### 3.3.2.3.6 AalProfileTemplate <<data Type>>
###### 3.3.2.3.6.1 Definition
The ORAN.AALI.Mgmt.AalProfileTemplate class represents the version of the AAL-Profile template for capabilities and default configurations reported by the HW Accelerator.
###### 3.3.2.3.6.2 Attributes
**Table 3.3.2.3.6.2-1 Attributes Properties for AalProfileTemplate**
| Attribute name | Data Type/Description | Properties |
|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| name | <b>Data Type:</b> string<br><br><b>Description:</b> Name identifier of the AAL Profile template. | x-support-qualifier: M<br>readOnly: True<br>x-isInvariant: True<br>x-inventoryNotification: True<br>nullable: False<br>format: string |
| version | <b>Data Type:</b> string<br><br><b>Description:</b> The version or AAL Profile Template | x-support-qualifier: M<br>x-isInvariant: True<br>x-inventoryNotification: True<br>nullable: False<br>example: '1.9.0' |
| imageVersion | <b>Data Type:</b> string<br><br><b>Description:</b> The version or generation for the image of the entity.<br><br>If an AAL-Profile image is the same as the AAL-LPU's image then the AAL-LPU's imageVersion attribute and this attribute would contain the same value. | x-support-qualifier: M<br>x-isInvariant: True<br>x-inventoryNotification: True<br>nullable: False<br><br>example: '1.9.0' |
| attributes | <b>Data Type:</b> array<br><br><b>Description:</b> The list of AAL-Profile attributes represented as key/value pairs.<br><br>Values for entries in this attribute would be considered the initial or default configuration setting for entries with the associated key. | x-support-qualifier: M<br>x-isInvariant: True<br>x-inventoryNotification: True<br>nullable: False<br>x-isOrdered: False<br>title: Attributes<br>minItems: 0<br>uniqueItems: True<br>items: AttributeValuePair |
| extensions | <b>Data Type:</b> array<br><br><b>Description:</b> The list of AAL-Profile unspecified (not standardized) capabilities and attributes represented as key/value pairs. The structure and format of the value attribute is specified as part of the definition of the key.<br><br>Values for attribute entries in this attribute would be considered the initial or default | x-support-qualifier: M<br>x-isInvariant: True<br>x-inventoryNotification: True<br>nullable: False<br>x-isOrdered: False<br>title: Extension Capabilities and Attributes<br>minItems: 0<br>uniqueItems: True<br>items: AttributeValuePair |
| Attribute name | Data Type/Description | Properties |
|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| | configuration setting for entries with the associated key. | |
| capabilities | <b>Data Type:</b> array<br><br><b>Description:</b> The list of AAL-Profile specified capabilities represented as key/value pairs. The structure and format of the value attribute is specified as part of the definition of the key in the corresponding AAL Profile specification. | x-support-qualifier: M<br>x-isInvariant: True<br>x-inventoryNotification: True<br>nullable: False<br>x-isOrdered: False<br>title: Capabilities<br>minItems: 0<br>uniqueItems: True<br>items: AttributeValuePair |
###### 3.3.2.3.6.3 Attribute constraints
None
###### 3.3.2.3.6.4 State diagram
None
##### 3.3.2.3.7 AalHam <<InformationObjectClass>>
###### 3.3.2.3.7.1 Definition
The ORAN.AALI.Mgmt.AalHam class represents the HAM acceleration management function.
###### 3.3.2.3.7.2 Attributes
**Table 3.3.2.3.7.2-1 Attributes Properties for AalHam**
| Attribute name | Data Type/Description | Properties |
|----------------------|-----------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| | | |
| operationalState | <b>Data Type:</b> string<br><br><b>Description:</b> Reflects the HAM's operational state as defined in clause 7.1.1 of ITU X.731. | x-support-qualifier: M<br>readOnly: True<br>x-isInvariant: False<br>x-inventoryNotification: False<br>x-stateChangeNotification: True<br>nullable: False<br>enum:<br>- DISABLED<br>- ENABLED<br>default: DISABLED |
| imsRegistrationState | <b>Data Type:</b> string<br><br><b>Description:</b> Reflects the registration state of HAM toward the IMS. | x-support-qualifier: M<br>readOnly: True<br>x-isInvariant: False<br>x-inventoryNotification: False<br>x-stateChangeNotification: True<br>nullable: False<br>enum:<br>- NOTREGISTERED<br>- REGISTERED<br>default: |
| Attribute name | Data Type/Description | Properties |
|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|
| | | NOTREGISTERED |
| localServiceEndpoint | <b>Data Type:</b> string<br><b>Description:</b> The service endpoint that the HAM exposes to the IMS that permits the IMS to send requests to the HAM and receive notifications from the HAM. | x-support-qualifier: M<br>x-isInvariant: True<br>x-inventoryNotification True<br>nullable: False<br>format: uri |
| registrationServiceEndpoint | <b>Data Type:</b> string<br><b>Description:</b> The service endpoint that the HAM uses register with the IMS in order for the IMS to connect to and manage the HAM. | x-support-qualifier: M<br>x-isInvariant: True<br>x-inventoryNotification True<br>nullable: False<br>format: uri |
3.3.2.3.7.3
###### Attributes Constraints
**Table 3.3.2.3.7.3 -1 Attributes Constraints for AalHam**
| Name | Definition |
|----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
| imsRegistrationState | Condition:<br>Modification of the localServiceEndpoint or registrationServiceEndpoint will cause the HAM to invoke the de-registration transition. |
###### 3.3.2.3.7.4 State diagram
###### 3.3.2.3.7.4.1 Introduction
The HAM maintains an operational state of the HAM as defined in clause 7.1.1 of ITU X.731 [14]. How the HAM determines its operational state is implementation specific.
The HAM maintains an IMS Registration state that reflects the HAMs current registration with an IMS.
###### 3.3.2.3.7.4.2 imsRegistrationState diagram
```
@startuml
skin rose
skinparam ClassStereotypeFontStyle normal
skinparam style strictuml
hide members
NotRegistered: imsRegistrationState = NOTREGISTERED
NotRegistered--> NotRegistered: Registration failure
NotRegistered--> Registered: Registration successful
Registered : imsRegistrationState = REGISTERED
Registered --> NotRegistered: De-Registration successful
enduml
```
```
stateDiagram-v2
state NotRegistered {
imsRegistrationState = NOTREGISTERED
}
state Registered {
imsRegistrationState = REGISTERED
}
NotRegistered --> NotRegistered : Registration failure
NotRegistered --> Registered : Registration successful
Registered --> NotRegistered : De-Registration successful
```
State Diagram for AalHam Registration with IMS. The diagram shows two states: 'NotRegistered' and 'Registered'. 'NotRegistered' has a self-loop labeled 'Registration failure'. Transitions between the states are labeled 'Registration successful' and 'De-Registration successful'.
**Figure 3.3.3.2.1-1:State Diagram for AalHam Registration with IMS**
### 3.3.3 AALI-C-App Information Model
#### 3.3.3.1 Imported and associated information entities
##### 3.3.3.1.1 Imported information entities and local labels
Information entities imported into the model are used for inheritance purposes.
**Table 3.3.3.1.1-1 AALI-C-App Imported Information Entities and Local Labels**
| Label reference | Local label |
|--------------------------------------------------------------|-------------|
| TS 28.622 [10] Information Object Class, TS 28.620 [11] Top_ | Top_ |
##### 3.3.3.1.2 Associated information entities and local labels
None
#### 3.3.3.2 Class Diagram
##### 3.3.3.2.1 Relationships
```
@startuml
skin rose
skinparam ClassStereotypeFontStyle normal
skinparam style strictuml
hide members
Namespace ORAN.AALI.App {
Class "AalLpu (AAL-LPU)" as lpu <<Information Object Class>> {
}
Class "AalProfileInstance (AAL Profile Instance)" as profilei <<Information Object Class>> {
}
Class "AalProfileQueue (AAL Profile Queue)" as queue <<Information Object Class>> {
}
}
```
```
lpu "1" *-- "0..n" profilei: aalProfileInstances
profilei "1" *-down- "0..n" queue: aalProfileQueues
}
@enduml
```
```
classDiagram
class AalLpu["«Information Object Class»\nAalLpu (AAL-LPU)"]
class AalProfileInstance["«Information Object Class»\nAalProfileInstance (AAL Profile Instance)"]
class AalProfileQueue["«Information Object Class»\nAalProfileQueue (AAL Profile Queue)"]
AalLpu "1" --> "0..n" AalProfileInstance : aalProfileInstances
AalProfileInstance "1" --> "0..n" AalProfileQueue : aalProfileQueues
```
UML Class Diagram showing AAL-C-App Class Relationships. The diagram is titled 'OCloud.AALI.App'. It contains three classes: 'AalLpu (AAL-LPU)', 'AalProfileInstance (AAL Profile Instance)', and 'AalProfileQueue (AAL Profile Queue)'. All three classes are marked as '«Information Object Class»'. 'AalLpu' has a directed association to 'AalProfileInstance' with the role 'aalProfileInstances', multiplicity '1' at 'AalLpu' and '0..n' at 'AalProfileInstance'. 'AalProfileInstance' has a directed association to 'AalProfileQueue' with the role 'aalProfileQueues', multiplicity '1' at 'AalProfileInstance' and '0..n' at 'AalProfileQueue'.
Figure 3.3.3.2.1-1: AALI-C-App Class Relationships
##### 3.3.3.2.2 Inheritance
```
@startuml
skin rose
skinparam ClassStereotypeFontStyle normal
skinparam style strictuml
hide members
abstract class "Top_" as top <<Information Object Class>>
class "AalLpu (AAL-LPU)" as lpu <<Information Object Class>>
class "AalProfileInstance (AAL Profile Instance)" as profilei <<Information Object Class>>
class "AalProfileQueue (AAL Profile Queue)" as queue <<Information Object Class>>
note right of top
defined in
3GPP TS 28.620
clause 4.3.8
end note
top <|-- lpu
top <|-- profilei
top <|-- queue
@enduml
```
```
classDiagram
class Top_["«Information Object Class» Top_"]
class AalLpu["«Information Object Class» AalLpu (AAL-LPU)"]
class AalProfileInstance["«Information Object Class» AalProfileInstance (AAL Profile Instance)"]
class AalProfileQueue["«Information Object Class» AalProfileQueue (AAL Profile Queue)"]
Top_ <|-- AalLpu
Top_ <|-- AalProfileInstance
Top_ <|-- AalProfileQueue
Top_ -.- Note["defined in 3GPP TS 28.620 clause 4.3.8"]
```
UML Class Inheritance Diagram for AALI-C-App. The diagram shows three subclasses at the bottom: '«Information Object Class» AalLpu (AAL-LPU)', '«Information Object Class» AalProfileInstance (AAL Profile Instance)', and '«Information Object Class» AalProfileQueue (AAL Profile Queue)'. All three have solid arrows pointing to a superclass at the top: '«Information Object Class» Top\_'. A dashed line connects 'Top\_' to a yellow note box on the right that says 'defined in 3GPP TS 28.620 clause 4.3.8'.
**Figure 3.3.3.2.2-1: AALI-C-App Class Inheritance**
#### 3.3.3.3 Class Definitions
##### 3.3.3.3.1 AalLpu <<InformationObjectClass>>
###### 3.3.3.3.1.1 Definition
The ORAN.AALI.App.AalLpu class represents the runtime instance of an AAL-LPU entity.
###### 3.3.3.3.1.2 Attributes
**Table 3.3.3.3.1.2-1 Attributes Properties for AalLpu**
| Attribute name | Data Type/Description | Properties |
|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| aalLpuHandle | <b>Data Type:</b> string<br><br><b>Description:</b> Identifier that represents the handle (e.g., pointer) that the AAL Application uses to access the AAL-LPU exposed by the AAL Implementation<br><br>This identifier is unique between the AAL Implementation and the AAL Application.<br><br>The identifier is assigned by the AAL Implementation. | x-support-qualifier: M<br>readOnly: True<br>x-isInvariant: True<br>x-inventoryNotification: False<br>nullable: False<br>format: binary |
| aalProfileInstances | <b>Data Type:</b> array<br><br><b>Description:</b> The list of AAL-Profile instances created by the AAL Application for this AAL-LPU. | x-support-qualifier: M<br>x-isInvariant: False<br>x-inventoryNotification: False<br>nullable: False<br>x-isOrdered: False<br>minItems: 0<br>uniqueItems: True<br>items: AalProfileI<br>nstance |
###### 3.3.3.3.2.3 Attribute constraints
None
###### 3.3.3.3.1.4 State diagram
Section 5.3.1 of this present document describes the state diagram for this entity.
##### 3.3.3.3.2 AalProfileInstance <<InformationObjectClass>>
###### 3.3.3.3.2.1 Definition
The ORAN.AALI.App. AalProfileInstance class represents the runtime instance of an AAL-Profile entity.
###### 3.3.3.3.2.2 Attributes
**Table 3.3.3.3.2-1 Attributes Properties for AalProfileInstance**
| Attribute name | Data Type/Description | Properties |
|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| aalProfileInstanceHandle | <b>Data Type:</b> string<br><br><b>Description:</b> Identifier that represents the handle (e.g., pointer) that the AAL Application uses to access the AAL-Profile instance exposed by the AAL Implementation<br><br>This identifier is unique between the AAL Implementation and the AAL Application.<br><br>The identifier is assigned by the AAL Implementation. | x-support-qualifier: M<br>readOnly: True<br>x-isInvariant: True<br>x-inventoryNotification: False<br>nullable: False<br>format: binary |
| aalProfileName | <b>Data Type:</b> string<br><br><b>Description:</b> Name identifier of the AAL Profile. | x-support-qualifier: M<br>x-isInvariant: False<br>x-inventoryNotification: False<br>nullable: False<br>format: string |
| aalProfileVersion | <b>Data Type:</b> string<br><br><b>Description:</b> The version of the AAL Profile. | x-support-qualifier: M<br>x-isInvariant: False<br>x-inventoryNotification: False<br>nullable: False<br>example: '1.9.0' |
| aalProfileQueues | <b>Data Type:</b> array<br><br><b>Description:</b> The list of AAL-Profile Queues created by the AAL Application for this AAL-Profile instance. | x-support-qualifier: M<br>x-isInvariant: False<br>x-inventoryNotification: False<br>nullable: False<br>x-isOrdered: False<br>minItems: 0<br>uniqueItems: True<br>items:<br><br>AalProfileQueue |
###### 3.3.3.3.2.3 Attribute constraints
None
###### 3.3.3.3.2.4 State diagram
Section 5.3.1 of this present document describes the state diagram for this entity.
##### 3.3.3.3.3 AalProfileQueue <<InformationObjectClass>>
###### 3.3.3.3.3.1 Definition
The ORAN.AALI.App.AalProfileQueue class represents the runtime instance of an AAL-Profile-Queue entity.
###### 3.3.3.3.3.2 Attributes
**Table 3.3.3.3.2-1 Attributes Properties for AalProfileQueue**
| Attribute name | Data Type/Description | Properties |
|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| aalProfileQueueHandle | <p><b>Data Type:</b> string</p> <p><b>Description:</b> Identifier that represents the handle (e.g., pointer) that the AAL Application uses to access the AAL-Profile-Queue instance exposed by the AAL Implementation</p> <p>This identifier is unique between the AAL Implementation and the AAL Application.</p> <p>The identifier is assigned by the AAL Implementation.</p> | <p>x-support-qualifier: M</p> <p>readOnly: True</p> <p>x-isInvariant: True</p> <p>x-inventoryNotification: False</p> <p>nullable: False</p> <p>format: binary</p> |
###### 3.3.3.3.3.3 Attribute constraints
None
###### 3.3.3.3.3.4 State diagram
Section 5.3.1 of this present document describes the state diagram for this entity.
### 3.3.4 Naming convention and managed resource tags
#### 3.3.4.1 API managed resources tags
For the following managed resources, the associated API managed resource tags will be used:
**For the managed resources:**
- HW Accelerator - **HW-Accel**
- AAL LPU - **AAL-LPU**
- AAL Profile Instance - **AAL-Profile-Instance**
- AAL Profile Queue - **AAL-Profile-Queue**
**Profile Naming convention:**
- FEC Profile – **AAL-FEC**
- L1 DL High Phy Profile – **AAL-DOWNLINK-High-PHY**
- L1 UL High Phy Profile – **AAL-UPLINK-High-PHY**
#### 3.3.4.2 API Naming Conventions
##### Operations and parameters naming convention:
- lowerCamelCase for operation names
- lower\_snake\_case for parameters
##### Group of attributes are notified with a > sign.
Example:
A grouped list of variables a, b and c under one parameter i.e. parameter\_name is shown as follows:
| parameter_name | struct |
|----------------|--------|
| >a | |
| >b | |
| >c | |
#### 3.3.4.3 Model Conventions
The conventions for the development of the Information Model are derived from the following sources:
3GPP TS 32.156 [1] provides the basis of the Class definitions for modelling elements that also includes the Stereotypes to be used when defining Classes. 3GPP TS 32.156 also includes the descriptions in clause 5.2.1.1 of the 3GPP standard Class attribute properties.
OAS 3.0 Specification [13] provides the basis for the Information Model data types. The Swagger documentation provides additional descriptions for the Class Attribute properties.
# Chapter 4 AALI-C-Mgmt
## 4.1 AALI-C-Mgmt operations and events
The below table lists the operations and events as part of the AALI-C-Mgmt interface.
Note: The present document version does not contain details of all the operations listed in the table below. The operations marked TBD need further evaluation.
**Table 4.1-1: AALI-C-Mgmt operations and events**
| Category | Operations/Events | Objects |
|----------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|
| <b>Capabilities discovery and Configuration Services</b> | | |
| <b>Get Configuration Services</b> | Get configuration <ul style="list-style-type: none"> <li>• getAalHwAccelStatus</li> <li>• getAalLpuStatus</li> <li>• getAalAccelInfo (inventory and capabilities)</li> <li>• getPmCounters</li> </ul> | HW-Accel<br><br>AAL-LPU |
| <b>Set Configuration Services</b> | Set configuration (add/modify/delete) configuration (initial and inline updates): | HW-Accel<br><br>AAL-LPU |
| | | |
|-------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|
| | <ul style="list-style-type: none"> <li>setAalAccelConfig</li> <li>setPmCollectionInterval (granularity/reporting etc.) (TBD)</li> </ul> | |
| | Set identification of the managed resource. <ul style="list-style-type: none"> <li>setAalAccelIdentifier</li> </ul> | HW-Accel |
| <b>Inventory Notification</b> | Inventory notification event <ul style="list-style-type: none"> <li>aalInventoryNotification</li> </ul> | HW-Accel<br>AAL-LPU |
| <b>Infrastructure Monitoring Services</b> | | |
| <b>Fault Service Operations</b> | <ul style="list-style-type: none"> <li>getAalHwAccelFaults</li> <li>getAalLpuFaults</li> </ul> | HW-Accel<br>AAL-LPU |
| | <ul style="list-style-type: none"> <li>manageLogs (Start/Stop/Get logs (Fault, debug))</li> </ul> | HW-Accel<br>AAL-LPU |
| <b>Fault Subscription</b> | <ul style="list-style-type: none"> <li>createAalFaultSubscription</li> <li>deleteAalFaultSubscription</li> <li>getAalFaultSubscription</li> </ul> | HW-Accel<br>AAL-LPU |
| <b>Fault Notification</b> | <ul style="list-style-type: none"> <li>aalFaultNotification</li> </ul> | HW-Accel<br>AAL-LPU |
| <b>State Change Notification</b> | <ul style="list-style-type: none"> <li>State Change notification (Autonomous)</li> </ul> | HW-Accel<br>AAL-LPU |
| <b>PM Service Operations</b> | <ul style="list-style-type: none"> <li>PM Subscription</li> </ul> | HW-Accel<br>AAL-LPU |
| | <ul style="list-style-type: none"> <li>Reporting of PM (file, streaming etc)</li> </ul> | HW-Accel<br>AAL-LPU |
| <b>Operational Commands</b> | | |
| <b>Operational commands</b> | <ul style="list-style-type: none"> <li>restartHwAccel (TBD)</li> <li>resetHwAccel (TBD)</li> </ul> | HW-Accel |
| | <ul style="list-style-type: none"> <li>powerCycleHwAccel (TBD)</li> </ul> | HW-Accel |
| | <ul style="list-style-type: none"> <li>startAalLpu</li> </ul> | AAL-LPU |
| | <ul style="list-style-type: none"> <li>stopAalLpu</li> </ul> | AAL-LPU |
| | <ul style="list-style-type: none"> <li>initiateTest (TBD)</li> </ul> | HW-Accel<br>AAL-LPU |
| <b>HAM Operations</b> | | |
| <b>IMS Registration</b> | <ul style="list-style-type: none"> <li>aalHamRegistrationNotification</li> </ul> | HAM |
## 4.2 AALI-C-Mgmt use case workflows
### 4.2.1 HW Accelerator installation/bootstrap use case workflow
This use case describes the procedure with a focus on the interaction of IMS with the HAM when installing and optionally configuring the HW Accelerator resource and configuring the AAL-LPUs resources. This procedure would be applicable during the initial deployment of an O-Cloud and afterward to reconfigure or add new resources.
This AAL UC flow can be executed during the O-Cloud Registration and Initialization Use Case, O-Cloud Inventory Update Use Case and the Hardware Infrastructure Scaling of O-Cloud Post Deployment Use Case [ Ref[5]: 3.1.3 “O-Cloud Registration and Initialization Use Case”, Configure AAL-LPU “3.1.4 : O-Cloud Inventory Update Use Case (DMS Example)” and “3.1.5: Hardware Infrastructure Scaling of O-Cloud Post Deployment”].
**Table 4.2.1-1: HW Accelerator installation/bootstrap workflow steps**
| | <b>Evolution / Specification</b> | <b><<Uses>><br/>Related use</b> |
|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------|
| Goal | Install the HW Accelerator and update the IMS that the HW Accelerator is available. | |
| Actors and Roles | Cloud Installer, SMO, FOCOM, IMS, HAM<br><br>SW Repo: Software repository | |
| Assumptions | This UC can be applicable during the O-Cloud Registration and Initialization or during Hardware Infrastructure Scaling of O-Cloud Post Deployment. | |
| Pre-conditions | SMO/FOCOM is active and running normally<br><br>O-Cloud is available<br><br>IMS is operational<br><br>HAM is operational and registered with the IMS<br><br>SMO and IMS connectivity is established<br><br>Accelerator SW Repository is accessible to HAM and populated with needed files. | |
| Begins when | SMO sends request to install the HW Accelerator | |
| Step 1 (M) | The IMS updates its inventory with the O-Cloud Resource information for the HW Accelerator discovered by the HAM.<br><br>The IMS obtains, via the AALI-C-Mgmt interface, the managed resource information for the HW Accelerator through reception of an inventory notification event for additions of HW Accelerator(s). | |
| Step 2-3 (O) | If the IMS needs to assign the identifier of the HW Accelerator, the IMS sets the HW Accelerator’s identifier by sending the setAalAccelIdentifier request to the HAM. | |
| Steps 4-7(O) | If the HW Accelerator status information is exchanged, additionally optionally the IMS can get the AAL-LPU status(es). | |
| | | |
|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|
| Steps 8-9 (O) | Optionally the IMS can get the HW Accelerator configuration | |
| Step 10-11 (O) | Optionally the IMS can configure the HW Accelerator (via the HAM): If the IMS (or SMO) determines that different image(s) should be used it may send a setAalAccelConfig request to the HAM, if the HAM determines new binaries, SW or configuration artifacts are needed from a SW repo, they are fetched, verified, and installed.<br><br>SMO is informed about the status if the operation | |
| Ends when | HW Accelerator inventory has been received by the IMS and IMS has optionally configured the HW Accelerator. | |
| Exceptions | None identified | |
| Post Conditions | The HW Accelerator has been deployed on the O-Cloud. | |
| Traceability | To be added later | |
#### 4.2.1.1 Sequence Diagram
```
@startuml
skinparam sequenceArrowThickness 1
skinparam ParticipantPadding 2
skinparam BoxPadding 5
Autonumber
Box "Personnel" #lightblue
Actor Installer as "Cloud Installer"
End box
Box "Service Management & Orchestration Framework" #gold
Participant "FOCOM" as FCC
End box
Box "O-Cloud" "#lightseagreen"
Participant "IMS" as IMS
Participant AccelMgr as "HAM"
End box
Box "SW Repo" #grey
Participant "SW Repo" as Repo
End Box
Note over Installer, IMS
PRECONDITIONS:
SMO/FOCOM is active and running normally
O-Cloud is available
IMS is operational
HAM is operational and registered with the IMS
SMO and IMS connectivity is established
IMS and HAM connectivity is established
HW Accel(s) installed
HAM connection to HW Accel(s) is established
End Note
AccelMgr --> IMS : <<AALI-C-Mgmt>> aalInventoryNotification (inc SW/FW/Config - same params as getAalAccelInfo)
Note over FCC, IMS
IMS informs SMO of the HW Accelerator Inventory
SMO Updates inventory with the HW Accelerator inventory information
```
```
End Note
Opt
Note over IMS, AccelMgr
If IMS needs to set the identifier of the HW Accel using the HW Accelerator
vendor_name, model and serial_number input parameters.
End Note
IMS -> AccelMgr : <<AALI-C-Mgmt>> setAalAccelIdentifier request
AccelMgr -> IMS : <<AALI-C-Mgmt>> setAalAccelIdentifier response (success)
End Opt
Opt
IMS -> AccelMgr : <<AALI-C-Mgmt>> getAalHwAccelStatus request
AccelMgr -> IMS : <<AALI-C-Mgmt>> getAalHwAccelStatus response (success)
opt
IMS -> AccelMgr : <<AALI-C-Mgmt>> getAalLpuStatus request
AccelMgr -> IMS : <<AALI-C-Mgmt>> getAalLpuStatus response (success)
End opt
End opt
Opt
IMS -> AccelMgr : <<AALI-C-Mgmt>> getAalAccelInfo request
AccelMgr -> IMS : <<AALI-C-Mgmt>> getAalAccelInfo response (success)
End opt
Note over FCC, IMS
SMO optionally instructs IMS to configure HW Accelerator
boot image or other config/SW/config artifact
End Note
Opt
Note over IMS, AccelMgr
If boot image or other config/SW/config artifact is needed or new driver is needed
(in order to match an intended configuration) then it is set using setAalAccelConfig
API
End Note
IMS -> AccelMgr : <<AALI-C-Mgmt>> setAalAccelConfig request
Note over AccelMgr, Repo
Download & apply needed
binaries, images, FW, etc.
End note
AccelMgr -> IMS : <<AALI-C-Mgmt>> setAalAccelConfig response (success)
End Opt
Note over FCC, IMS
HW Accelerator is installed and SMO has the inventory
information about the HW Accelerator.
SMO inventory is updated
resouce information
End Note
@enduml
```
```
sequenceDiagram
participant Personnel as Personnel
Cloud Installer
participant SMO as Service Management & Orchestration Framework
FOCOM
participant OCloud as O-Cloud
IMS
participant HAM
participant SWRepo as SW Repo
Note over SMO: PRECONDITIONS:
SMO/FOCOM is active and running normally
O-Cloud is available
IMS is operational
HAM is operational and registered with the IMS
SMO and IMS connectivity is established
IMS and HAM connectivity is established
HW Accel(s) installed
HAM connection to HW Accel(s) is established
Note over SMO: IMS informs SMO of the HW Accelerator Inventory
SMO Updates inventory with the HW Accelerator inventory information
Note over SMO: 1 <<AALI-C-Mgmt>> aalInventoryNotification (inc SW/FW/Config - same params as getAalAccelInfo)
Note over SMO: opt
If IMS needs to set the identifier of the HW Accel using the HW Accelerator vendor_name, model and serial_number input parameters.
Note over SMO: 2 <<AALI-C-Mgmt>> setAalAccelIdentifier request
Note over OCloud: 3 <<AALI-C-Mgmt>> setAalAccelIdentifier response (success)
Note over SMO: opt
Note over OCloud: 4 <<AALI-C-Mgmt>> getAalHwAccelStatus request
Note over OCloud: 5 <<AALI-C-Mgmt>> getAalHwAccelStatus response (success)
Note over SMO: opt
Note over OCloud: 6 <<AALI-C-Mgmt>> getAalLpuStatus request
Note over OCloud: 7 <<AALI-C-Mgmt>> getAalLpuStatus response (success)
Note over SMO: opt
Note over OCloud: 8 <<AALI-C-Mgmt>> getAalAccelInfo request
Note over OCloud: 9 <<AALI-C-Mgmt>> getAalAccelInfo response (success)
Note over SMO: SMO optionally instructs IMS to configure HW Accelerator
boot image or other config/SW/config artifact
Note over SMO: opt
Note over OCloud: If boot image or other config/SW/config artifact is needed or new driver is needed
(in order to match an intended configuration) then it is set using setAalAccelConfig API
Note over SMO: 10 <<AALI-C-Mgmt>> setAalAccelConfig request
Note over SWRepo: Download & apply needed binaries, images, FW, etc.
Note over OCloud: 11 <<AALI-C-Mgmt>> setAalAccelConfig response (success)
Note over SMO: HW Accelerator is installed and SMO has the inventory
information about the HW Accelerator.
SMO inventory is updated
resource information
```
Sequence diagram for end-2-end Life Cycle Management use case workflow. The diagram shows interactions between Personnel (Cloud Installer), Service Management & Orchestration Framework (FOCOM, IMS), O-Cloud (HAM), and SW Repo. The flow starts with preconditions, followed by a notification from IMS to FOCOM. Then, FOCOM sends a request to IMS to set the HW Accelerator identifier. This is followed by optional steps for getting status and configuration information. Finally, FOCOM sends a request to IMS to set the HW Accelerator configuration, which triggers a download and application of binaries from the SW Repo.
### 4.2.2 end-2-end Life Cycle Management use case workflow (Informational)
NOTE: The e2e flow depicted in this section are known to be incomplete and are being provided as informational guidance to implementors on how the APIs documented in the remainder of the specification are to be used. These exchanges will be made normative in future versions of the specification.
This use case describes the end-to-end procedure with a focus on the interaction between the IMS and the HAM via the AALI-C-Mgmt interface for discovering the capabilities of the HW Accelerator, configuring the AAL-LPUs, instantiating an AAL Application and optionally updating/reconfiguring the managed resources based on the needs of the AAL Application. The flow also shows the interaction with the AAL Application via the AALI-C-App to create an AAL-Profile-Instance.
This AAL UC flow can be executed during the O-Cloud Registration and Initialization Use Case, O-Cloud Inventory Update Use Case and the Hardware Infrastructure Scaling of O-Cloud Post Deployment Use Case [ Ref[5]: 3.1.3 “O-Cloud Registration and Initialization Use Case”, Configure AAL-LPU “3.1.4 : O-Cloud Inventory Update Use Case
(DMS Example)” and “3.1.5: Hardware Infrastructure Scaling of O-Cloud Post Deployment”]. This use case is also related to the “3.2.1 Instantiate Network Function on O-Cloud”.
**Table 4.2.2-1: end-2-end Life Cycle Management workflow steps**
| | <b>Evolution / Specification</b> | <b><<Uses>><br/>Related use</b> |
|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------|
| Goal | Discover the capabilities of the HW Accelerator, update HW Accelerator and configure AAL-LPU(s) based on the AAL Application needs. | |
| Actors and Roles | SMO, FOCOM, NFO, IMS, DMS, HAM | |
| Assumptions | This UC can be applicable for initial or subsequent deployment of the O-Cloud, (re)instantiation of AAL Application and adding/deleting managed resources or AAL-Profile-Instances. | |
| Pre-conditions | <p>SMO/FOCOM/NFO is active and running normally</p> <p>O-Cloud is available</p> <p>IMS/DMS is operational</p> <p>HAM is operational and registered with the IMS</p> <p>HW Accelerator is bootstrapped/installed (4.2.1 HW Accelerator installation/bootstrap use case workflow).</p> <p>SMO and IMS/DMS communication is established</p> <p>IMS and HAM communication is established</p> <p>SMO Catalogue, AAL Application Manifest is available</p> <p>SW Repo available</p> <p>SMO inventory DB available</p> | |
| Begins when | SMO sends request to query the resource(s) | |
| Step 1-5 (M) | <p>SMO sends a query to retrieve the available O-Cloud resources Info.</p> <p>The IMS queries the HAM for the HW Accelerator managed resource(s) using the getAalAccelInfo via AALI-C-Mgmt interface. This includes hardware information and the HW accelerator capabilities (example: Vendor, Version, BIOS, AAL-LPU, and other capabilities supported by the HW Accelerator).</p> <p>SMO inventory is updated based on the response.</p> | |
| Step 6-10 (M) | <p>Based on the planned AAL Application manifest, the SMO/IMS configures the HW Accelerator (e.g.: AAL-LPU capabilities, Profile images etc) using the setAalAccelConfig via the AALI-C-Mgmt interface.</p> <p>The IMS receives inventory notifications for managed resources that have been added, modified or removed.</p> <p>DMS inventory is updated.</p> <p>SMO inventory is updated based on the response.</p> | |
| Step 11-20 (M) | SMO gets the deployment artifacts for AAL Application (e.g., Manifest/ Helm Charts) that includes requested O-Cloud Resource and profiles. SMO | |
| | | |
|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|
| | <p>then sends request to DMS for AAL Application instantiation with a manifest file.</p> <p>Using the setAalAccelConfig via the AALI-C-Mgmt interface the HW Accelerator and AAL-LPU configuration may have to be updated as needed for each of the items in the manifest.</p> <p>The IMS receives receive inventory notifications for managed resources that have been added, modified or removed.</p> <p>The AAL Application is instantiated, and the DMS/SMO inventory updated. [5].</p> | |
| Step 21-22 (M) | The SMO configures the cell details, AAL Profile versions etc to the AAL Application via O1 interface | |
| Step 23 (M) | Initialize AALI-C-App interface between the AAL Application and the AAL | |
| Step 24-25 (M) | <p>The AAL Application queries through the AALI-C-App interface the AAL implementation to get the capabilities of the AAL-LPU assigned using the getAalLpuInfo via the AALI-C-App interface.</p> <p>In response, the AAL Application gets the aal-lpu-handle and the AAL Profile(s) supported.</p> | |
| Step 26-33 (M) | The AAL Application creates one or many AAL-Profile-Instance(s) via the AALI-C-App using setAalProfileInstance and starts the AAL-Profile-Instance. The AAL Application also sets the AAL-Profile-Queue configuration and starts the queue. | |
| Step 34-39 (M) | If the AAL-Profile-Instance needs to be updated or is not needed anymore, the AAL Application via the AALI-C-App stops the AAL-Profile-Queue and AAL-Profile-Instance and deletes the AAL-Profile-Instance. | |
| Ends when | The HW Accelerator and AAL-LPUs have been configured, the AAL Application is instantiated and the AAL Profile instances are managed. | |
| Exceptions | None identified | |
| Post Conditions | AAL Application is instantiated, and the AAL-Profile-Instances are managed. | |
| Traceability | To be added later | |
#### 4.2.2.1 Sequence Diagram
```
@startuml
skinparam sequenceArrowThickness 1
skinparam ParticipantPadding 2
skinparam BoxPadding 5
Autonumber
Box "Service Management & Orchestration Framework" #gold
Participant "FOCOM/NFO" as FCC
End box
Box "O-Cloud" #lightseagreen
Participant "IMS" as IMS
Participant DMS as "DMS"
Participant HAM as "HAM"
Participant "AAL \n Implementation" as aal
End box
```
```
Box "Network Functions"#LightBlue
Participant "<<AAL-App>> AAL Application" as App
End box
Box "Network Functions"#DarkBlue
Participant "SMO" as O1
End box
Box "SW Repo" "#Blue
Participant "Repo" as Repo
End box
Note over FCC, DMS
PRECONDITIONS:
SMO/FOCOM/NFO is active and running normally
O-Cloud is available
IMS/DMS is operational
HAM is operational and registered with the IMS
HW Accelerator is bootstrapped/installed
SMO and IMS/DMS connectivity is established
IMS and HAM connectivity is established
End Note
== Use case: AAL Flow ==
Note over FCC
PRECONDITIONS:
SMO Catalog, HW Accelerator Manifest, AAL Application Manifest available
FW/SW image Repo available, SMO inventory DB available
End Note
FCC -> IMS: <<O2>> QueryOcloudInfoRequest
IMS -> HAM : <<AALI-C-Mgmt>> getAalAccelInfo
HAM --> IMS : getAalAccelInfo response Success( Vendor, Version, Bios etc )
IMS --> FCC : <<O2>> QueryOcloudInfoResponse
FCC -> FCC : SMO inventory updated
Note over FCC, IMS
Single Set command to configure the device with manifest,
including AAL LPU and Profile Images.
The SMO knows the pre-defined set of configurations that support different
use cases that it wants to deploy.
The configuration can be changed dynamically in the future.
The HAM will be able to apply delta changes accordingly.
end Note
group Set configuration of the HW Accelerator
Note over FCC, IMS
SMO triggers configuration of the HW Accelerator
End Note
IMS -> HAM: <<AALI-C-Mgmt>> setAalAccelConfig \n(e.g. AAL-LPU's, Supported AAL-Profile
etc..)
Note over HAM, Repo
Optionally, the SW/FW image is retrieved from the Software Repository
End Note
group DMS inventory update
HAM <--> DMS : DMS Info exchange
Note over DMS
Examples of information exchanged \n AAL-LPUs, AAL-Profile info etc
End Note
End
HAM --> IMS: setAalAccelConfig response success
HAM --> IMS : <<AALI-C-Mgmt>> aalInventoryNotification w/ managed resource informaton
Note over FCC, IMS
```
```
Response to SMO with success/failure of setting AAL Accel Config
end Note
FCC -> FCC : SMO inventory update
end
group Instantiate AAL Applications and optionally update HW Accelerator information
Note over FCC,IMS
SMO Instantiate AAL Applications
SMO gets the deployment artifacts for
containerized workload (e.g., Manifest/ Helm Charts).
This includes managed resource and AAL-Profiles requested
end Note
REF over FCC : Use case 3.2.1 Orchestration Use Case Spec
FCC -> DMS : <<O2>> Instantiate AAL Application
Note over DMS
The DMS manifest includes the LPU (Profile) required and I/O ports etc..
end NOTE
opt Update HW Accelerator information if needed
Note over DMS
Optionally, the IMS sets the AAL Accel Config
based on the information received from SMO
to add/modify managed resources as defined in the AAL Application instantiate request.
End Note
DMS --> FCC : <<DMS-SMO interface>>Update HW Accelerator information(to be define by
O2dms)
FCC -> IMS: <<O2>> setAalAccelConfig \n(including AAL-LPU's, Supported AAL-Profile)
IMS -> HAM: <<AALI-C-Mgmt>> setAalAccelConfig \n(e.g. AAL-LPU's, Supported AAL-Profile)
HAM --> IMS: <<AALI-C-Mgmt>> setAalAccelConfig response success
HAM --> IMS : <<AALI-C-Mgmt>> aalInventoryNotification w/ O-Cloud AAL-LPU information
IMS --> FCC : <<O2>> Set AAL Accel Config response success
FCC --> DMS: Success
End opt
DMS -> App : <<AAL-App>> AAL Application instantiated
activate App
DMS --> FCC : <<AAL-App>> AAL Application instantiated response success
End
group AAL Application application and AAL configured
O1 -> App : <<O1>> DU Configuration \n Cells, BW, Profile Version etc..
App --> O1 : response Success
Note over aal, App
Initilize the AAL interface betwwen AAL and the AAL Application
end NOTE
App <-> aal : Init AALI-C-App
Note over aal, App
Get AAL LPU information and
create AAL Profile Instance
end NOTE
App -> aal : <<AALI-C-App>> getAalLpuInfo
aal -> App : <<AALI-C-App>> Response LPU/Profile handle
App -> aal : <<AALI-C-App>> createAalProfileInstance
aal -> App : <<AALI-C-App>> Response Success
App -> aal : <<AALI-C-App>>
setAalProfileInstance/startAalProfileInstance/startAalProfileInstance
aal -> App : <<AALI-C-App>> Response Success
App -> aal : <<AALI-C-App>> setAalProfileQueueConfig
aal -> App : <<AALI-C-App>> Response Success
App -> aal : <<AALI-C-App>> startAalProfileQueue
aal -> App : <<AALI-C-App>> Response Success
```
```
Note over aal, App
Delete AAL Profile Instance
end NOTE
App -> aal : <<AALI-C-App>> stopAalProfileQueue
aal -> App : <<AALI-C-App>> Response Success
App -> aal : <<AALI-C-App>> stopAalProfileInstance
aal -> App : <<AALI-C-App>> Response Success
App -> aal : <<AALI-C-App>> deleteAalProfileInstance
aal -> App : <<AALI-C-App>> Response Success
end
== End Use Case ==
@enduml
```
**Service Management & Orchestration Framework**
**O-Cloud**
**Network Functions**
**SMO**
**Repo**
**Use case: AAL Flow**
**Set configuration of the HW Accelerator**
**Instantiate AAL applications and optionally update HW Accelerator information**
**AAL application application and AAL configured**
**End Use Case**
**Preconditions:**
- SMO/FQDN is active and running normally
- O-Cloud is available
- IMS/DMS is operational
- HAM is operational and registered with the IMS
- HW Accelerator is bootstrapped/installed
- SMO and IMS/DMS connectivity is established
- IMS and HAM connectivity is established
**Use case: AAL Flow**
**Preconditions:**
- SMO Catalog, HW Accelerator Manifest, AAL application Manifest available
- FW/FW image Repo available, SMO inventory DB available
**Set configuration of the HW Accelerator**
SMO triggers configuration of the HW Accelerator
1 <<O2>> QueryO2ConfigRequest
2 <<AAL-C-Mgmt>> getAalAccelInfo
3 getAalAccelInfo response Success (Vendor, Version, Bios etc.)
4 <<O2>> QueryO2ConfigResponse
5 SMO inventory update
Single Set command to configure the device with manifest, including AAL LPU and Profile Images. The SMO knows the predefined set of configurations that support different use cases that it wants to deploy. The configuration can be changed dynamically in the future. The HAM will be able to apply delta changes accordingly.
6 <<AAL-C-Mgmt>> setAalAccelConfig (e.g. AAL-LPU's, Supported AAL-Profile etc.)
7 DMS Info exchange
Examples of information exchanged to AAL-LPU's, AAL-Profile info etc.
8 setAalAccelConfig response success
9 <<AAL-C-Mgmt>> aalInventoryNotification w/ O-Cloud resource information
Response to SMO with success/failure of setting AAL Accel Config
10 SMO inventory update
Optionally, the SW/FW image is retrieved from the Software Repository
**Instantiate AAL applications and optionally update HW Accelerator information**
SMO Instantiate AAL applications. SMO gets the deployment artifacts for containerized workload (e.g., Manifest/ Helm Charts). This includes resource and profiles requested.
Use case 3.2.1 Orchestration Use Case Spec
11 <<O2>> Instantiate AAL application
The DMS manifest includes the LPU (Profile) required and I/O ports etc.
[Update HW Accelerator information if needed]
12 <<DMS-SMO interface>> Update HW Accelerator information to be define by O2dms
13 <<O2>> setAalAccelConfig (including AAL-LPU's, Supported AAL-Profile)
14 <<AAL-C-Mgmt>> setAalAccelConfig (e.g. AAL-LPU's, Supported AAL-Profile)
15 <<AAL-C-Mgmt>> setAalAccelConfig response success
16 <<AAL-C-Mgmt>> aalInventoryNotification w/ O-Cloud AAL-LPU information
17 <<O2>> Set AAL Accel Config response success
18 Success
19 <<AAL-App>> AAL application instantiated
20 <<AAL-App>> AAL application instantiated response success
**AAL application application and AAL configured**
Initialize the AAL interface between AAL and the AAL Application
21 <<O1>> DU Configuration Cells, BW, Profile Version etc.
22 response Success
23 Init AAL-C-App
Get AAL LPU information and create AAL Profile Instance
24 <<AAL-C-App>> getAalLpuInfo
25 <<AAL-C-App>> Response LPU/Profile handle
26 <<AAL-C-App>> createAalProfileInstance
27 <<AAL-C-App>> Response Success
28 <<AAL-C-App>> setAalProfileInstance/startAalProfileInstance/startAalProfileInstance
29 <<AAL-C-App>> Response Success
30 <<AAL-C-App>> setAalProfileQueueConfig
31 <<AAL-C-App>> Response Success
32 <<AAL-C-App>> startAalProfileQueue
33 <<AAL-C-App>> Response Success
Delete AAL Profile Instance
34 <<AAL-C-App>> stopAalProfileQueue
35 <<AAL-C-App>> Response Success
36 <<AAL-C-App>> stopAalProfileInstance
37 <<AAL-C-App>> Response Success
38 <<AAL-C-App>> deleteAalProfileInstance
39 <<AAL-C-App>> Response Success
Sequence diagram for HW Accelerator Manager (HAM) registration use case workflow. The diagram shows interactions between Service Management & Orchestration Framework (FQDN: FQDN), O-Cloud (IMS, DMS, HAM, AAL Implementation), Network Functions (AAL-App), SMO, and Repo. The workflow includes preconditions, use case AAL Flow, setting configuration of the HW Accelerator, instantiating AAL applications, and AAL application application and AAL configured steps.
### 4.2.3 HW Accelerator Manager (HAM) registration use case workflow
The HAM registration procedure makes the HAM known to the IMS.
This use case describes how the HAM registers itself with the IMS using the AALI-C-Mgmt API. This registration at the minimum includes the HAM end point for the IMS to communicate with the HAM.
Following successful registration with the IMS, the HAM can participate in other resource management and AALI-C-Mgmt procedures.
Until successfully registered with an IMS, the HAM cannot accept management requests or provide notifications not associated with the IMS registration procedure.
NOTE: Installation and configuration of the HAM are not in the scope of this use case. How the HAM is configured with the IMS service endpoint and the local HAM service endpoint are implementation specific.
**Table 4.2.3-1: HW Accelerator Manager registration workflow steps**
| | Evolution / Specification | <<Uses>><br>Related use |
|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|
| Goal | Register the HW Accelerator Manager (HAM) with the IMS | |
| Actors and Roles | SMO, FOCOM, IMS, HAM | |
| Assumptions | This UC is applicable when the HAM is first configured with the IMS and HAM service endpoints or when the IMS or HAM service endpoint is modified. | |
| Pre-conditions | SMO/FOCOM is active and running normally<br><br>O-Cloud is available<br><br>IMS is operational and reachable.<br><br>HAM is configured and not registered with the IMS<br><br>SMO and IMS connectivity is established | |
| Begins when | When the HAM is ready to register with the IMS | |
| Step 1 (M) | HAM initialized | |
| Step 2 (M) | HAM registers itself with the IMS | |
| Step 3 (M) | IMS sends a success response to the HAM | |
| Ends when | The IMS updates its inventory for the availability of the HAM | |
| Exceptions | None identified | |
| Post Conditions | IMS can communicate with the HAM via its end point | |
| Traceability | To be added later | |
#### 4.2.3.1 Sequence Diagram
```
@startuml
```
```
skinparam sequenceArrowThickness 1
skinparam ParticipantPadding 2
skinparam BoxPadding 5
Autonumber
```
```
Box "Service Management & Orchestration Framework" #gold
Participant "FOCOM" as FCC
End box
Box "O-Cloud" "#lightseagreen"
Participant "IMS" as IMS
Participant AccelMgr as "HAM"
End box
Note over FCC,AccelMgr
HAM was is installed and configured with the IMS service endpoint
End Note
AccelMgr --> AccelMgr : HAM is configured and not registered with the IMS
AccelMgr --> IMS : <<AALI-C-Mgmt>> aalHamRegistrationNotification (Registration
Notification.callback URI)
IMS --> AccelMgr : <<AALI-C-Mgmt>> response (sucess)
Note over IMS
IMS update its inventory
End Note
Note over FCC, IMS
TBD * IMS informs SMO of the HW Accelerator Manager (HAM) Inventory
SMO Updates inventory with the HAM inventory information *
End Note
@endum1
```
```
sequenceDiagram
participant FOCOM
participant IMS
participant HAM
FOCOM->>IMS: HAM was is installed and configured with the IMS service endpoint
IMS->>HAM: 1 HAM is configured and not registered with the IMS
HAM->>IMS: 2 <<AALI-C-Mgmt>> aalHamRegistrationNotification (Registration Notification.callback URI)
IMS->>HAM: 3 <<AALI-C-Mgmt>> response (sucess)
IMS->>FOCOM: IMS update its inventory
FOCOM->>IMS: TBD * IMS informs SMO of the HW Accelerator Manager (HAM) Inventory SMO Updates inventory with the HAM inventory information *
```
Sequence diagram showing interactions between FOCOM, IMS, and HAM. FOCOM sends a message to IMS: 'HAM was is installed and configured with the IMS service endpoint'. IMS sends a message to HAM: '1 HAM is configured and not registered with the IMS'. HAM sends a message to IMS: '2 <> aalHamRegistrationNotification (Registration Notification.callback URI)'. IMS sends a message to HAM: '3 <> response (sucess)'. IMS sends a message to FOCOM: 'IMS update its inventory'. FOCOM sends a message to IMS: 'TBD \* IMS informs SMO of the HW Accelerator Manager (HAM) Inventory SMO Updates inventory with the HAM inventory information \*'.
## 4.3 AALI-C-Mgmt API details
NOTE: The AALI-C-Mgmt interface defines the administrative operations/actions/events between the O-Cloud IMS and the HAM.
### 4.3.1 Capabilities discovery and configuration
#### 4.3.1.1 getAalHwAccelStatus
Description: This API is used to query the HAM about the status of the HW Accelerator.
Pre-conditions: HAM is registered with an IMS.
Triggers: On demand request via AALI-C-Mgmt interface
Frequency: N/A
**Table 4.3.1.1-1: getAalHwAccelStatus Operation**
| Operation | Direction |
|---------------------|-------------------------------------|
| getAalHwAccelStatus | IMS => HW Accelerator Manager (HAM) |
**Table 4.3.1.1-2: getAalHwAccelStatus Input Parameter**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------|-------------|------------|-----------|------------------------------------|
| hw_accel_id | | Identifier | M | This ID is unique within a O-Cloud |
**Table 4.3.1.1-3: getAalHwAccelStatus Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------------------|-------------|-----------------------------------------|-----------|--------------------------------------------------------------------------------------------|
| hw_accel_operational_state | | <i>String</i> | M | Returns the operational state of the HW Accelerator |
| hw_accel_operational_conditions | 0..N | <i>Array</i> | M | Returns the operation conditions that support the operational state of the HW Accelerator. |
| status_of_operation | 1 | <i>Reference<br/>WG6 info<br/>model</i> | M | Returns the status of the operation |
#### 4.3.1.2 getAalLpuStatus
Description:
This API is used to query the HAM about the status of the HW Accelerator and the AAL-LPUs (per AAL-LPU).).
Pre-conditions: HAM is registered with an IMS.
Triggers: On demand request via AALI-C-Mgmt interface
Frequency: N/A
**Table 4.3.1.2-1: getAalLpuStatus Operation**
| Operation | Direction |
|-----------------|-------------------------------------|
| getAalLpuStatus | IMS => HW Accelerator Manager (HAM) |
**Table 4.3.1.2-2: getAalLpuStatus Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------|-------------|------------|-----------|-------------------------------------|
| hw_accel_id | 1.. N | Identifier | M | This ID is unique within an O-Cloud |
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------|-------------|------------|-----------|-------------------------------------------|
| aal_lpu_handle | 0..1 | Identifier | M | This ID is unique within a HW Accelerator |
**Table 4.3.1.2-3: getAalLpuStatus Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------------------|-------------|--------------------------------|-----------|------------------------------------------------------------------------------------|
| hw_accel_id | 1.. N | Identifier | M | This ID is unique within an O-Cloud |
| >aal_lpu_handle | 1 | Identifier | M | This ID is unique within a HW Accelerator |
| >aal_lpu_operational_state | 1 | String | M | Returns the operational state of the AAL-LPU. |
| >aal_lpu_operational_conditions | 0..N | Array | M | Returns the operation conditions that support the operational state of the AAL-LPU |
| status_of_operation | 1 | Reference<br>WG6 info<br>model | M | Returns the status of the operation |
#### 4.3.1.3 getAalAccelInfo
Description: This API is used to query the HAM about a HW Accelerator and capabilities of its AAL-LPU(s).
Pre-conditions: HAM is registered with an IMS.
.
Triggers: On demand request via AALI-C-Mgmt interface
Frequency: N/A
**Table 4.3.1.3-1: getAalAccelInfo Operation**
| Operation | Direction |
|-----------------|-------------------------------------|
| getAalAccelInfo | IMS => HW Accelerator Manager (HAM) |
**Table 4.3.1.3-2: getAalAccelInfo Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------|-------------|------------|-----------|-----------------------------------------------------------|
| hw_accel_id | 1.. N | Identifier | M | Unique Identification of the AAL-HW-Accel in the O-Cloud. |
| Output Parameter | Cardinality | Data Type<br>(Align with<br>O2 Data<br>model) | Qualifier | Description |
|---------------------|-------------|-----------------------------------------------|-----------|--------------------------------------------------------|
| status_of_operation | 1 | Reference<br>WG6 info<br>model | M | Returns the status of the get-AAL-Accel-info procedure |
| Output Parameter | Cardinality | Data Type<br>(Align with O2 Data model) | Qualifier | Description |
|----------------------------------|-------------|-----------------------------------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| hw_accel_list | 0.. N | List of struct - inlined | M | List of Hardware Accelerator's and their characteristics: |
| >hw_accel_id | 1 | Identifier | M | Unique Identification of the HW Accelerator in the O-Cloud. |
| >hw_accel_operational_state | 1 | String | M | The operational state of the HW Accelerator |
| >hw_accel_operational_conditions | 1 | Array | M | The operational conditions that support the operational state of the HW Accelerator |
| >vendor_name | 1 | String | M | Name of the Vendor/Provider of the resource. |
| >date_of_manufacture | 1 | String | M | Date of the manufacture of the resource. |
| >model | 1 | String | M | Information about the model of the resource. |
| >serial_number | 1 | String | M | Serial number of the specific resource. |
| >hw_version | 1 | String | M | Version or generation of the resource. |
| >hw_accel_image_version | 1 | String | M | The version for the image applied to the HW Accelerator. The parameter is associated with the HW Accelerator's resource type. |
| >hw_accel_image_location | 1 | String | M | Path / URI to the software/firmware image. |
| >hw_accel_vendor_specific | 0.. N | List Key Value Pair<br>String/String | M | Vendor specific attributes associated with the HW Accelerator. |
| >max_num_aal_lpus | 0..1 | Integer | O | This parameter may be included if a HW Accelerator has an upper limit on AAL-LPUs it can support. Actual number of AAL-LPUs available at runtime may be lower based on resource usage, AAL-LPU SW used, and AAL-Profile SW and types instantiated on the AAL-LPU(s) |
| >aal_profile_templates | 0..N | List AALProfileTemplate | M | This parameter provides a list of templates for the AAL-Profiles that is supported for this HW Accelerator. |
| >num_aal_lpus_configured | 1 | Integer | M | Number of LPU(s) configured |
| Output Parameter | Cardinality | Data Type<br>(Align with O2 Data model) | Qualifier | Description |
|----------------------------------|-------------|-----------------------------------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| >lpu_type | 1 | String | M | single/mixed<br><br>single: all LPUs are identical.<br><br>mixed: non-identical LPUs |
| >aal_lpu_list | 0.. N | List of struct - inlined | M | List of AAL-LPUs and their characteristics: |
| >> aal_lpu_handle | 1 | Identifier | M | Uniquely identifies the AAL-LPU within the accelerator |
| >>aal_lpu_administrative_state | 1 | String | M | The administrative state of the AAL-LPU |
| >>aal_lpu_operational_state | 1 | String | M | The operational state of the AAL-LPU |
| >>aal_lpu_operational_conditions | 1 | Array | M | The operational conditions that support the operational state of the AAL-LPU. |
| >>aal_lpu_image_version | 1 | String | M | The version or generation for the image applied to the AAL-LPU.<br><br>If an AAL-LPU image is the same as the Accelerator HW image then the hw_accel_image_version and aal_lpu_image_version parameters would contain the same value. |
| >>aal_lpu_image_location | 1 | String | M | Path / URI to the software/firmware image.<br><br>If an AAL-LPU image is the same as the Accelerator HW image then the hw_accel_image_location and aal_lpu_image_location parameters would contain the same value. |
| >>aal_lpu_profile_list | 0..1 | List of Struct - inlined | M | List of AAL-Profile(s) supported (Profile Name ID, Image) |
| >>>aal_lpu_profile_name | 1 | String | M | AAL Profile name as defined in section 3.3.3.1. |
| >>>aal_lpu_profile_version | 1 | String | M | AAL Profile version for the associated AAL Profile name. The AAL Profile version is the version of the AAL Profile's approved specification. |
| >>>aal_lpu_profile_image_version | 1 | String | M | Version of the AAL Profile image (e.g. binaries, libraries, etc).<br><br>If an AAL Profile image is the same as the AAL-LPU image then the aal_lpu_image_version and aal_lpu_profile_image_version parameters would contain the same value. |
| Output Parameter | Cardinality | Data Type<br>(Align with O2 Data model) | Qualifier | Description |
|------------------------------------|-------------|------------------------------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| >>>aal_lpu_profile_image_location | 1 | String | M | Path / URI to the AAL Profile image (e.g. binaries, libraries, etc).<br><br>If an AAL Profile image is the same as the AAL-LPU image then the aal_lpu_image_location and aal_lpu_profile_image_location parameters would contain the same value. |
| >>>aal_lpu_profile_attributes | 0..N | List Key Value Pair | M | This parameter provides a list of configuration attributes for the AAL-Profiles that used for this AAL-LPU. The structure and format of the Value attribute is specified as part of the definition of the Key. |
| >>>aal_lpu_profile_vendor_specific | 0..N | List Key Value Pair | M | This parameter provides a list of vendor specific attributes for the AAL-Profiles that used for this AAL-LPU. The structure and format of the Value attribute is specified as part of the definition of the Key. |
| >>aal_lpu_config | 0..1 | Struct - Inlined | M | Can be one or more parameters that define the AAL-LPU persona – Some of the parameters are listed below |
| >>>aal_lpu_memory | 0..1 | Integer | O | AAL-LPU memory |
| >>>aal_lpu_multi_processors_num | 0..1 | Integer | O | Number of Multi-Processors per AAL-LPU |
| >>>aal_lpu_compute_slices_num | 0..1 | Integer | O | Number of compute slices per AAL-LPU |
| >>aal_lpu_vendor_specific | 0.. N | List Key Value Pair<br><br>String/String | M | Vendor specific AAL-LPU attribute.<br><br>Some examples: Number of DMA engines, number of encoders, number of decoders, number of JPEG engines, Number of OfA (Optical flow accelerator) engines |
NOTE: While this list provides the details of parameters between IMS and HAM, further analysis is needed to understand what is needed by the SMO.
#### 4.3.1.4 setAalAccelConfig
Description: This is used to configure the HW Accelerator and AAL-LPU. The operation's input parameters are the full configuration set of parameters for the HW Accelerator and contained AAL-LPUs. These input parameters replace the existing configuration of the HW Accelerator and AAL-LPUs. The HAM shall determine the changes to be applied to the HW Accelerator based on the input parameters contained in the operation and the current configuration parameters associated with the HW Accelerator. For example, if the operation contains an AAL-LPU instance that is part of the current configuration, the HAM adds the AAL-LPU instance to the current configuration. Likewise, if the current configuration has a configured AAL-LPU that is not contained within the input parameters of this operation, the HAM
deletes the AAL-LPU from the current configuration of the HW Accelerator. The HAM shall validate the state of the HW Accelerator and AAL-LPUs prior to applying the changes.
Pre-conditions:
- HW Accelerator Device is initialized, and HAM is operational.
- HW Accelerator Device and AAL-LPUs are in the correct state prior to performing configuration changes.
Triggers: On demand request via AALI-C-Mgmt interface
Frequency: N/A
**Table 4.3.1.4-1: setAalAccelConfig Operation**
| Operation | Direction |
|-------------------|-------------------------------------|
| setAalAccelConfig | IMS => HW Accelerator Manager (HAM) |
**Table 4.3.1.4-2: setAalAccelConfig Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|----------------------------------|-------------|--------------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| hw_accel_list | 1.. N | List of struct - inlined | M | List of Hardware Accelerator's and their characteristics: |
| >hw_accel_id | 1.. N | Identifier | M | Unique Identification of the AAL-HW-Accel in the O-Cloud.. |
| >hw_accel_image_version_location | 1 | String | M | Path / URI to the HW Accelerator image (e.g., BIOS/FW/Host OS, libraries, drivers) to be used. |
| >num_aal_lpus_configured | 1 | Integer | M | Number of LPU(s) configured |
| >lpu_type | 1 | String | M | single/mixed<br>single: all LPUs are identical.<br>mixed: non-identical LPUs |
| >aal_lpu_list | 0.. N | List of struct - inlined | M | List of AAL-LPUs and their characteristics: |
| >> aal_lpu_handle | 1 | Identifier | M | Uniquely identifies the AAL-LPU within the accelerator |
| >>aal_lpu_image_version_location | 1 | String | M | Path / URI to the Image (e.g. FW/guest OS, libraries, drivers) to be used.<br><br>If an AAL-LPU image is the same as the Accelerator HW image then the hw_accel_image_version_location and |
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|------------------------------------|-------------|--------------------------------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| | | | | aal_lpu_image_version_location parameters would contain the same value |
| >hw_accel_vendor_specific | 0..N | List Key Value Pair<br>String/String | M | Vendor specific attributes associated with the HW Accelerator. |
| >>aal_lpu_profile_list | 0..N | List of Struct - inlined | M | List of AAL-Profile(s) supported (Profile Name ID, Image) |
| >>>aal_lpu_profile_name | 1 | String | M | AAL Profile name as defined in section 3.3.3.1. |
| >>>aal_lpu_profile_version | 1 | String | M | AAL Profile version for the associated AAL Profile name. The AAL Profile version is the version of the AAL Profile's approved specification |
| >>>aal_lpu_profile_image_version | 1 | String | M | Version of the AAL Profile image (e.g. binaries, libraries, etc).<br><br>If an AAL Profile image version is the same as the aal_lpu_image_version then the aal_lpu_image_version and aal_lpu_profile_image_version parameters would contain the same value. |
| >>>aal_lpu_profile_image_location | 1 | String | M | Path / URI to the AAL Profile image (e.g. binaries, libraries, etc) to be used.<br><br>If an AAL Profile image is the same as the AAL-LPU image then the aal_lpu_image_version_location and aal_lpu_profile_image_location parameters would contain the same value. |
| >>>aal_lpu_profile_attributes | 0..N | List Key Value Pair | M | This parameter provides a list of configuration attributes for the AAL-Profiles that used for this AAL-LPU. The structure and format of the Value attribute is specified as part of the definition of the Key. |
| >>>aal_lpu_profile_vendor_specific | 0..N | List Key Value Pair | M | This parameter provides a list of vendor specific attributes for the AAL-Profiles that used for this AAL-LPU. The structure and format of the Value attribute is specified as part of the definition of the Key. |
| >>aal_lpu_config | 0..1 | Struct - Inlined | M | Can be one or more parameters that define the AAL-LPU persona – Some of the parameters are listed below |
| >>aal_lpu_memory | 0..1 | Integer | O | AAL-LPU memory |
| >>aal_lpu_multiprocessors_num | 0..1 | Integer | O | Number of Multi-Processors per AAL-LPU |
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|------------------------------|-------------|--------------------------------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| >>aal_lpu_compute_slices_num | 0..1 | Integer | O | Number of compute slices per AAL-LPU |
| >>aal_lpu_vendor_specific | 0.. N | List Key Value Pair<br>String/String | M | Vendor specific AAL-LPU attribute. Some examples: Number of DMA engines, number of encoders, number of decoders, number of JPEG engines, Number of OfA (Optical flow accelerator) engines |
**Table 4.3.1.4-3: setAalAccelConfig Output Parameter**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|-----------------------------------------|-----------|-------------------------------------|
| status_of_operation | | <i>Reference<br/>WG6 info<br/>model</i> | M | Returns the status of the procedure |
- The vendor specific attributes in the getAalAccelInfo and setAalAccelConfig needs to consider vendor specific attributes for the LPU and Accelerator.
#### 4.3.1.5 startAalLpu
Description: This operation will start an AAL-LPU that is in the stopped state. The AAL-LPU is instantiated using the SW/FW image(s) and configuration that were provided in the setAalAccelConfig procedure.
The AAL-LPU state machine is moved to a started state. When the AAL-LPU is in the started state it is ready to be used by the AAL Application.
After successfully starting AAL-LPU using this procedure, the AAL-LPU can be stopped.
Pre-conditions: HW Accelerator Device is initialized, and HAM is operational. The AAL-LPU has been successfully configured and is in the stopped state.
Triggers: On demand request via AALI-C-Mgmt interface
Frequency: N/A
**Table 4.3.1.5-1: startAalLpu Operation**
| Operation | Direction |
|-------------|-------------------------------------|
| startAalLpu | IMS => HW Accelerator Manager (HAM) |
**Table 4.3.1.5-2: startAalLpu Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------|-------------|------------|-----------|--------------------------------------------------|
| hw_accel_id | 1 | Identifier | M | HW Accel ID is unique within an O-Cloud |
| aal_lpu_handle | 1 | Identifier | M | AAL-LPU handle is unique within a HW Accelerator |
**Table 4.3.1.5-3: startAalLpu Output Parameter**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|-----------------------------------------|-----------|-------------------------------------|
| status_of_operation | 1 | <i>Reference<br/>WG6 info<br/>model</i> | M | Returns the status of the procedure |
#### 4.3.1.6 stopAalLpu
Description: Moves AAL-LPU state machine to a stopped state.
AAL-LPU service is stopped. Configuration changes on the AAL-LPU can be performed. Re-configuration of the AAL-LPU compute / memory resource partitioning can be performed. Drivers can be updated / re-installed and configured. Maintenance / debugging operations can be performed.
After successfully stopping the AAL-LPU, the AAL-LPU can be (re-)configured, started or deleted.
Pre-conditions: HW Accelerator Device is initialized, and HAM is operational. The number of AAL-LPUs has been set on the HW Accelerator. The AAL-LPU has been successfully configured and is started. AAL Applications have previously been migrated off the AAL-LPU.
Triggers: On demand request via AALI-C-Mgmt interface
Frequency: N/A
**Table 4.3.1.6-1: stopAalLpu Operation**
| Operation | Direction |
|------------|-------------------------------------|
| stopAalLpu | IMS => HW Accelerator Manager (HAM) |
**Table 4.3.1.6-2: stopAalLpu Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------|-------------|------------|-----------|-------------------------------------------|
| hw_accel_id | 1 | Identifier | M | This ID is unique within an O-Cloud |
| aal_lpu_handle | 1 | Identifier | M | This ID is unique within a HW Accelerator |
**Table 4.3.1.6-3: stopAalLpu Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|--------------------------------------------|-----------|-------------------------------------|
| status_of_operation | 1 | <i>Reference<br/>WG10<br/>object model</i> | M | Returns the status of the procedure |
#### 4.3.1.7 Inventory Notifications
Description: Inventory notifications are sent by the HAM to the IMS when the HAM discovers that managed resources have been added, modified, or removed from the HAM's inventory of managed resources. Inventory notifications are not used to report administrative or operational state changes in the resources (e.g., restarts, configuration changes that do not include added or deleted managed resources). The Inventory Notification services in this section, provide the ability for the IMS to receive inventory notification events when managed resources have been added, modified or removed from the HAM.
The modification of a managed resource differs from addition and removal of an O-Cloud Resource. Examples of modifications of a managed resource that causes an Inventory Notification event to be emitted by the HAM would be the modification of the path to the image for an AAL-LPU or the modification of the compute resources assigned to the AAL-LPU..
##### 4.3.1.7.1 aalInventoryNotification
Description: The HW Accelerator Manager emits notifications to the IMS. The 4.2.1 HW Accelerator installation/bootstrap use case workflow, 4.2.2 end-2end Life Cycle Management use case workflow (Informational) provide examples of when the inventory notification is sent by the HAM to the IMS that has previously subscribed to receive the notification event.
Pre-conditions: The HAM is operational. The IMS and the HAM have established connectivity.
Triggers: On demand request via AALI-C-Mgmt interface.
Frequency: Infrequent
**Table 4.3.1.7-1: aalInventoryNotification Operation**
| Operation | Direction |
|--------------------------|-------------------------------------|
| aalInventoryNotification | HW Accelerator Manager (HAM) => IMS |
**Table 4.3.1.7-2: aalInventoryNotification Parameters**
| Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------|-------------|-------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| resources | 0.. N | Structure | M | The current managed resource list. |
| > resource | 1 | Structure | M | The resource (HW Accelerator, AAL-LPU) and its associated attributes known by the HAM.<br><br>Section 3.3.1 contains the list of attributes for managed resource that are retrieval and are part of the Inventory Notification event.<br><br>When the HW Accelerator is newly discovered, the hw_accel_id attribute of the resource does not have a value reported since the value of this attribute is assigned by the IMS. |
| > detected_time | 1 | DateTime | M | The time the inventory event was last detected. |
| > event | 1 | Enumeration | M | The event that caused the notification.<br><br>Values: Add, Modify, Remove |
#### 4.3.1.8 setAalAccelIdentifier
Description: This is used to provide the HW Accelerator with its resource identifier (hw\_accel\_id) assigned by the IMS. The HAM uses the vendor, model, and serial\_number input parameters to identify the HW Accelerator and then assigns the resource identifier to the HW Accelerator.
Pre-conditions: HW Accelerator has been discovered but needs its identifier assigned by the IMS, and HAM is operational.
Triggers: On demand request via AALI-C-Mgmt interface
Frequency: N/A
**Table 4.3.1.8-1: setAalAccelIdentifier Operation**
| Operation | Direction |
|-----------------------|-------------------------------------|
| setAalAccelIdentifier | IMS => HW Accelerator Manager (HAM) |
**Table 4.3.1.8-2: setAalAccelIdentifier Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------|-------------|------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| vendor_name | 1 | String | M | Input parameter that is used by the HAM to match the vendor of the HW Accelerator. |
| model | 1 | String | M | Input parameter that is used by the HAM to match the model of the HW Accelerator. |
| serial_number | 1 | String | M | Input parameter that is used by the HAM to match the serial number of the HW Accelerator. |
| hw_accel_id | 1 | Identifier | M | Unique Identification of the AAL-HW-Accel in the O-Cloud.<br><br>If the HAM has an existing hw_accel_id value mapped to the device identified by vendor_name, model and serial_number, the HAM's value will be replaced with the value provided in this parameter. |
**Table 4.3.1.8-3: setAalAccelIdentifier Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|---------------------------------|-----------|-------------------------------------|
| status_of_operation | | <i>Reference WG6 info model</i> | M | Returns the status of the procedure |
#### 4.3.1.9 aalHamRegistrationNotification
Description: The HAM Registration Notification API is used by the HAM to register itself with the SMO. This occurs:
- After the HAM is ready to support interactions with the IMS.
- After HAM is configured with the IMS and HAM's service endpoints.
- When the HAM or IMS service endpoint has been modified.
**Table 4.3.1.9-1: aalHamRegistrationNotification Operation**
| Operation | Direction |
|--------------------------------|-------------------------------------|
| aalHamRegistrationNotification | HW Accelerator Manager (HAM) => IMS |
**Table 4.3.1.9-2: aalHamRegistrationNotification Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------|-------------|-----------|-----------|----------------------------------------------------------------|
| aalHam_ep | 1 | String | M | The service end point for the IMS to communicate with the HAM. |
### 4.3.2 Infrastructure Monitoring Service
#### 4.3.2.1 Fault Service Operations
The AALI-C-Mgmt API provides operations to query the current Fault conditions for managed resources and raise event notifications to subscribed entities when Fault conditions occur. These Fault conditions are operational conditions of the managed resource and can be retrieved from the “faults” attribute of the associated managed resource.
The HAM provides the capability to query the current Fault conditions for the HW Accelerator and AAL-LPU(s).
##### 4.3.2.1.1 getAalHwAccelFaults
Description: This API is used between the IMS and HAM to query the currently active faults of the HW Accelerator.
Pre-conditions: HW Accelerator Device is initialized, and HAM is operational.
Triggers: On demand request via AALI-C-Mgmt interface
Frequency: Infrequent
**Table 4.3.2.1.1-1: getAalHwAccelFaults Operation**
| Operation | Direction |
|---------------------|-------------------------------------|
| getAalHwAccelFaults | IMS => HW Accelerator Manager (HAM) |
**Table 4.3.2.1.1-2: getAalHwAccelFaults Input Parameter**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------|-------------|------------|-----------|------------------------------------|
| hw_accel_id | | Identifier | M | This ID is unique within a O-Cloud |
**Table 4.3.2.1.1-3: getAalHwAccelFaults Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|---------------------------------|-----------|------------------------------------------------|
| status_of_operation | | <i>Reference WG6 info model</i> | | Returns the status of the operation |
| faults | 0.. N | Structure | M | The currently active Fault list |
| > hw_accel_id | 1 | Identifier | M | This ID is unique within an O-Cloud |
| > detected_time | 1 | DateTime | M | The time the Fault condition was last detected |
| > fault_id | 1 | Identifier | M | The Fault identifier. |
##### 4.3.2.1.2 getAalLpuFaults
Description: This API is used between the IMS and HAM to query the currently active faults of the AAL-LPUs (per AAL-LPU).
Pre-conditions: HW Accelerator Device is initialized, and HAM is operational.
Triggers: On demand request via AALI-C-Mgmt interface
Frequency: Infrequent
**Table 4.3.2.1.2-1: getAalHwAccelFaults Operation**
| Operation | Direction |
|-----------------|-------------------------------------|
| getAalLpuFaults | IMS => HW Accelerator Manager (HAM) |
**Table 4.3.2.1.2-2: getAalHwAccelFaults Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------|-------------|------------|-----------|-------------------------------------------|
| hw_accel_id | 1.. N | Identifier | M | This ID is unique within an O-Cloud |
| aal_lpu_handle | | Identifier | M | This ID is unique within a HW Accelerator |
**Table 4.3.2.1.2-3: getAalHwAccelFaults Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|--------------------------------------------|-----------|----------------------------------------------------------------------------|
| status_of_operation | | <i>Reference<br/>WG10 object<br/>model</i> | M | Returns the status of the operation |
| faults | 0.. N | Structure | M | The currently active Fault conditions list |
| > hw_accel_id | 1 | Identifier | M | This ID is unique within an O-Cloud |
| > aal_lpu_handle | 1 | Identifier | M | This ID is unique within a HW Accelerator needed for LPU Fault conditions. |
| > detected_time | 1 | DateTime | M | The time the Fault condition was last detected |
| > fault_id | 1 | Identifier | M | The Fault identifier. |
#### 4.3.2.2 Fault Notifications
The HW Accelerator Manager (HAM) provides the capability to subscribe to receive Fault conditions for the HW Accelerator and AAL-LPU(s) that it is managing. This capability is managed within the O-Cloud through the subscription\_id identifier.
##### 4.3.2.2.1 Subscription\_id
The subscription\_id is an identifier used to describe the fault notification relationship between the IMS and a given HAM; it applies indirectly to the notification of faults from all the HW Accelerators that the HAM is managing.
The subscription\_id includes a list of all the faults that the IMS needs to be notified in the event of their occurrence in any one of the HW Accelerators that is being managed by the HAM.
The validity and duration of the subscription\_id shall be defined by the following:
- The existence and validity of the IMS to HAM relationship. For example, if the HAM needs to be updated or modified then a new subscription\_id needs to be issued by the IMS.
- The existence and validity of any of the HW Accelerators for which the HAM is responsible for and is managing for the IMS. If any one of these HW Accelerators requires an update, upgrade, or any other modification is performed then the subscription\_id between the IMS and the given HAM needs to be renewed.
Any notification that the HAM issues to the IMS pertaining to a modification in the state or operation of the HW Accelerator by the HAM shall result in an update/renewal of the subscription\_id with the IMS.
- In the case of restart or power-cycles in the HW Accelerator managed by the HAM the subscription\_id doesn't have to be renewed since restart or power-cycle does not alter the faults supported by the HW Accelerator or the fault formats.
If the IMS receives a fault notification from a HAM that includes a subscription\_id that does not match a subscription\_id maintained by the IMS for that given HAM, the IMS shall then delete that subscription by calling the deleteAalFaultSubscription API with the subscription\_id followed by calling the createAalFaultSubscription API with new subscription\_id(s) to (re-)create a new fault subscription.
##### 4.3.2.2.2 createAalFaultSubscription
Description: This API is used between the IMS and HAM to create fault subscriptions for AAL-LPUs and the HW Accelerator managed resources.
Pre-conditions: HW Accelerator Device is initialized, and HAM is operational.
Triggers: On demand request via AALI-C-Mgmt interface.
Frequency: Infrequent
**Table 4.3.2.2.2-1: createAalFaultSubscription Operation**
| Operation | Direction |
|----------------------------|-------------------------------------|
| createAalFaultSubscription | IMS => HW Accelerator Manager (HAM) |
**Table 4.3.2.2.2-2: createAalFaultSubscription Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-------------------|-------------|------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| subscriptions | 1.. N | Structure | M | The subscriptions to be created. |
| > subscription_id | 1 | Identifier | M | Unique identification of the subscription in the O-Cloud. |
| > filter_criteria | 1 | String | M | <p>Policy to subscribe that is evaluated by the HAM to determine what faults for which AAL managed resource types and instances should be notified to the IMS.</p> <p>Each criteria includes the Fault condition(s) for a managed resource type. The criteria accepts Fault condition/ managed resource types that are associated with a set of instances of that type of resource.</p> <p>Multiple criteria can be part of the subscription with criteria evaluation operators (i.e., and, or) that can be used to evaluate the individual criterion.</p> <p>For example:</p> <p>To subscribe to temperature faults for all HW Accelerator resources and the memory exhausted fault for an AAL-LPU with an identifier of 45; the subscription looks like:</p> <p>((TemperatureFault HW-Accel *) and (MemoryExhausted AAL-LPU 45))</p> |
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------|-------------|-----------|-----------|---------------------------------------------------------------------------------------------------------------------------|
| | | | | NOTE: The filter_criteria element is further described as part of the protocol specific implementation of this operation. |
**Table 4.3.2.2.2-3: createAalFaultSubscription Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------------|-------------|-----------------------------------------|-----------|---------------------------------------------|
| subscriptions | 1.. N | Structure | M | Status of the subscriptions. |
| > subscription_id | 1 | Identifier | M | Returns the identifier of the subscription. |
| > status_of_operation | 1 | <i>Reference<br/>WG6 info<br/>model</i> | M | Returns the status of the operation. |
##### 4.3.2.2.3 getAalFaultSubscription
Description: This API is used between the IMS and HAM to query Fault Subscriptions for the HW Accelerator.
Pre-conditions: HW Accelerator Device is initialized, and HAM is operational.
Triggers: On demand request via AALI-C-Mgmt interface
Frequency: Infrequent
**Table 4.3.2.2.3-1: getAalFaultSubscription Operation**
| Operation | Direction |
|-------------------------|-------------------------------------|
| getAalFaultSubscription | IMS => HW Accelerator Manager (HAM) |
**Table 4.3.2.2.3-2: getAalFaultSubscription Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------|-------------|------------|-----------|----------------------------------------------------------------------------------------------------------------------|
| subscription_id | 1.. N | Identifier | O | List of identifiers to retrieve.<br><br>If this attribute is not present, all subscriptions in the HAM are returned. |
**Table 4.3.2.2.3-3: getAalFaultSubscription Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|-------------------|-------------|------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------|
| subscriptions | 0.. N | Structure | M | Returns the subscriptions |
| > subscription_id | 1 | Identifier | M | Returns the identifiers of the requested subscriptions. |
| > filter_criteria | 1 | String | M | Criteria evaluated by the HAM to determine what faults for which AAL managed resource types and instances should be notified to the IMS. |
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------------|-------------|--------------------------------|-----------|-----------------------------------------------------------------------|
| > status_of_operation | 1 | Reference<br>WG6 info<br>model | | Returns the status of the operation for each subscription identifier. |
##### 4.3.2.2.4 deleteAalFaultSubscription
Description: The HAM provides the ability for the IMS to delete a subscription for notification of faults.
Pre-conditions: HW Accelerator Device is initialized, and HAM is operational.
Triggers: On demand request via AALI-C-Mgmt interface.
Frequency: Infrequent
**Table 4.3.2.2.4-1: deleteAalFaultSubscription Operation**
| Operation | Direction |
|----------------------------|-------------------------------------|
| deleteAalFaultSubscription | IMS => HW Accelerator Manager (HAM) |
**Table 4.3.2.2.4-2: deleteAalFaultSubscription Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------|-------------|------------|-----------|-------------------------------|
| subscription_id | 1.. N | Identifier | M | List of identifiers to delete |
**Table 4.3.2.2.4-3: deleteAalFaultSubscription Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------------|-------------|--------------------------------|-----------|-----------------------------------------------------------------------|
| subscriptions | 1.. N | Structure | M | Returns the subscriptions that were deleted. |
| > subscription_id | 1 | Identifier | M | Returns the identifiers of the subscriptions that were deleted. |
| > status_of_operation | 1 | Reference<br>WG6 info<br>model | | Returns the status of the operation for each subscription identifier. |
##### 4.3.2.2.5 aalFaultNotification
Description: The HW Accelerator Manager emits notifications to the IMS based on a subscription.
Pre-conditions: HW Accelerator Device is initialized, and HAM is operational.
Triggers: On demand request via AALI-C-Mgmt interface.
Frequency: Infrequent
**Table 4.3.2.2.5-1: aalFaultNotification Operation**
| Operation | Direction |
|----------------------|-------------------------------------|
| aalFaultNotification | HW Accelerator Manager (HAM) => IMS |
| Parameter | Cardinality | Data Type | Qualifier | Description |
|------------------|-------------|-------------|-----------|------------------------------------------------------------------|
| subscription_id | 1 | Identifier | M | Identifier of the subscription. |
| faults | 0.. N | Structure | M | The current fault list. |
| > hw_accel_id | 1 | Identifier | M | This ID is unique within an O-Cloud. |
| > aal_lpu_handle | 1 | Identifier | O | This ID is unique within a HW Accelerator needed for LPU faults. |
| > detected_time | 1 | DateTime | M | The time the fault condition was last detected. |
| > event | 1 | Enumeration | M | The event that caused the notification.<br>Values: Raise, Clear |
| > fault_id | 1 | Identifier | M | The identifier of the fault condition. |
# Chapter 5 AALI-C-APP
## 5.1 AALI-C-App Identification & Representation
Within the AAL Application's process address space each, AAL-LPU can be represented by a generalized object handle (i.e., aal\_lpu\_handle) provided by the AAL implementation in order for the AAL Application to use the capabilities of the AAL-LPU.
Before the AALI-C-App interface can be used, the AAL implementation must be initialized by the AAL Application. The initialization of the AAL implementation allows for initialization, setup and discovery routines that are specific to an implementation. Where needed, the initialization of the AAL implementation also allows the AAL Application to inform the AAL implementation what O-Cloud Resources and associated attributes that the DMS has assigned to and can be used by the AAL Application. As an example, the DMS may inform the AAL Application about the AAL Application's assigned O-Cloud Resource using environment variables that identify the O-Cloud Resource and associated attributes within the POD/container/VM. The identification of these O-Cloud Resources are to be shared with the AAL implementation by the AAL Application through the AALI-C-App initialization operation.
Depending on the HW design and implementation choice, an AAL-LPU implementation may want to accelerate multiple AAL Profiles, offer support for sharing HW Accelerator resources between multiple threads and/or partition AAL-LPU resources between multiple cells. For this reason, the AAL-Profile-Instance and AAL Profile Queue logical managed resources can optionally be used by the AAL Application to
- distinguish between multiple supported AAL profiles per AAL-LPU
- prioritize access to AAL-LPU resources.
- group operation requests
- partition AAL-LPU resources
- allow parallel access through the AAL Application interface for multiple threads / cores.
As a logical managed resources, an AAL Profile Queue does not reflect a HW design specification or requirement but an AAL interface specification.
The AALI-C-App configuration is done on a per AAL-LPU basis. That is, for each AAL-LPU that is assigned to the AAL Application, the AAL Implementation exposes the AALI-C-App to the AAL Application to initialize and configure each AAL-Profile-Instance and AAL-Profile-Queue.
## 5.2 AALI-C-App operations and events
The below table lists the operations and events as part of the AALI-C-App interface.
**Table 5.2-1: AALI-C-App operations and events**
| Category | Operations/<br>Events | Objects |
|--------------------------------|-----------------------------|----------------------|
| <b>Initialization Services</b> | initAal | N/A |
| | cleanupAal | N/A |
| <b>Inventory Services</b> | getAalLpuInfo | AAL-LPU |
| <b>Configuration Services</b> | createAalProfileInstance | AAL-LPU |
| | getAalProfileInstanceConfig | AAL-Profile-Instance |
| | setAalProfileInstanceConfig | AAL-Profile-Instance |
| | deleteAalProfileInstance | AAL-Profile-Instance |
| | setAalProfileQueueConfig | AAL-Profile-Queue |
| | getAalProfileQueueConfig | AAL-Profile-Queue |
| <b>Operations</b> | startAalProfileInstance | AAL-Profile-Instance |
| | stopAalProfileInstance | AAL-Profile-Instance |
| | startAalProfileQueue | AAL-Profile-Queue |
| | stopAalProfileQueue | AAL-Profile-Queue |
| <b>Transport Operations</b> | createBufferPool | N/A |
| | allocBuffer | N/A |
| | getBufferAddr | N/A |
| | getBufferSize | N/A |
| | sendBuffer | N/A |
| | receiveBuffer | N/A |
| | freeBuffer | N/A |
| | destroyBufferPool | N/A |
*Editor's note: Use of AAL-Profile-Queue operations for user plane data transfer and buffer API operations needs to be clarified.*
## 5.3 AALI-C-App Operations and Events Sequence and State Diagram
### 5.3.1 AALI-C-App State
The below state diagram shows the high-level state and state transitions for all AALI-C-App Operations and Events
```
@startuml
skinparam StateBackgroundColor #FEFECF
skinparam StateBorderColor #A80036
skinparam ArrowColor #A80036
skinparam ArrowHeadColor #A80036
skinparam ParticipantPadding 5
skinparam BoxPadding 10
hide members
hide empty description
[*] --> AAL : initAal
state AAL {
[*] --> AalInitialized
AalInitialized --> AalInitialized : getAalLpuInfo
AalInitialized -left-> [*] : cleanupAal
AalInitialized --> AalProfileInstance
state AalProfileInstance {
[*] --> Stopped : createAalProfileInstance (s)
Stopped --> Started : startAalProfileInstance
Started --> Stopped : stopAalProfileInstance
Stopped --> Stopped : setAalProfileInstanceConfig\ngetAalProfileInstanceConfig
Started --> Started : getAalProfileInstanceConfig
Stopped --> [*] : deleteAalProfileInstance
Started --> AalProfileQueue
state AalProfileQueue {
[*] --> QueueStopped
QueueStopped --> QueueStarted : startAalProfileQueue
QueueStarted --> QueueStopped : stopAalProfileQueue
QueueStopped --> QueueStopped : setAalProfileQueueConfig\ngetAalProfileQueueConfig
QueueStarted --> QueueStarted : getAalProfileQueueConfig\nPerform Operations
}
}
}
@enduml
```
```
stateDiagram-v2
[*] --> AAL : initAal
state AAL {
[*] --> AalInitialized
AalInitialized --> [*] : cleanupAal
AalInitialized --> AalInitialized : getAalLpinfo
AAL --> AalProfileInstance
state AalProfileInstance {
[*] --> Stopped
Stopped --> [*] : createAalProfileInstance (s)
Stopped --> Stopped : setAalProfileInstanceConfig
Stopped --> Stopped : getAalProfileInstanceConfig
Stopped --> Started : startAalProfileInstance
Stopped --> [*] : deleteAalProfileInstance
Started --> Stopped : stopAalProfileInstance
Started --> Started : getAalProfileInstanceConfig
AalProfileInstance --> AalProfileQueue
state AalProfileQueue {
[*] --> QueueStopped
QueueStopped --> [*] : setAalProfileQueueConfig
QueueStopped --> QueueStopped : getAalProfileQueueConfig
QueueStopped --> QueueStarted : startAalProfileQueue
QueueStarted --> QueueStopped : stopAalProfileQueue
QueueStarted --> QueueStarted : getAalProfileQueueConfig
QueueStarted --> QueueStarted : Perform Operations
}
}
}
```
The diagram illustrates the state transitions for the AAL (Access Abstraction Layer) component, which is composed of three sub-components: AAL, AalProfileInstance, and AalProfileQueue.
- AAL Component:**
- Starts at an initial state and transitions to the **AalInitialized** state upon receiving the **initAal** message.
- The **AalInitialized** state has a self-loop for **getAalLpinfo** and a transition to a final state upon receiving **cleanupAal**.
- The AAL component transitions to the **AalProfileInstance** component.
- AalProfileInstance Component:**
- Starts at an initial state and transitions to the **Stopped** state upon receiving the **createAalProfileInstance (s)** message.
- The **Stopped** state has self-loops for **setAalProfileInstanceConfig** and **getAalProfileInstanceConfig**.
- Transitions from **Stopped** include **startAalProfileInstance** to the **Started** state and **deleteAalProfileInstance** to a final state.
- The **Started** state has a self-loop for **getAalProfileInstanceConfig** and a transition back to **Stopped** upon receiving **stopAalProfileInstance**.
- The AalProfileInstance component transitions to the **AalProfileQueue** component.
- AalProfileQueue Component:**
- Starts at an initial state and transitions to the **QueueStopped** state.
- The **QueueStopped** state has self-loops for **setAalProfileQueueConfig** and **getAalProfileQueueConfig**.
- Transitions from **QueueStopped** include **startAalProfileQueue** to the **QueueStarted** state and **stopAalProfileQueue** back to **QueueStopped**.
- The **QueueStarted** state has a self-loop for **getAalProfileQueueConfig** and a self-loop for **Perform Operations**.
UML State Machine Diagram for AAL (Access Abstraction Layer) showing the flow between AAL, AalProfileInstance, and AalProfileQueue components.
### 5.3.2 AALI-C-App API Init Sequence
The below sequence diagram shows the high-level initialization and configuration procedure for the AALI-C-App.
```
@startuml
Autonumber
Skinparam sequenceArrowThickness 2
skinparam ParticipantPadding 5
skinparam BoxPadding 10
Box "O-RAN" #NavajoWhite
Participant "O-DU" as ODU << OAAL-App>>
end box
Box "Cloud Platform" #lightseagreen
participant "AAL Implementation" as AAL
End box
note over ODU, AAL
Assumed the O-DU is already instantiated on the O-Cloud
With desired HW Accelerator resources assigned from O2 and
Configuration through O1 interface is complete
endnote
==Initialization Services==
ODU -> AAL : initAal
AAL --> ODU : return
==Inventory Services==
ODU -> AAL : getAalLpuInfo
AAL --> ODU : Response getAalLpuInfo
==Configuration & Operation Services==
loop for each AAL-LPU
loop for each AAL-Profile-Instance
ODU -> AAL : createAalProfileInstance
AAL --> ODU : AAL-Profile-Instance handle / identifier
ODU -> AAL : setAalProfileInstanceConfig
AAL --> ODU : return
ODU -> AAL : startAalProfileInstance
AAL --> ODU : return
loop for each AAL-Profile-Queue
ODU -> AAL : setAalProfileQueueConfig
AAL --> ODU : return
ODU -> AAL : startAalProfileQueue
AAL --> ODU : return
end loop
end loop
end loop
ODU -> AAL : cleanupAal
AAL --> ODU : return
@enduml
```
![Sequence diagram showing the interaction between O-RAN and Cloud Platform for AAL services. The diagram is divided into three sections: Initialization Services, Inventory Services, and Configuration & Operation Services. The O-RAN side contains the « OAAL-App » O-DU, and the Cloud Platform side contains the AAL Implementation. A note at the top states: 'Assumed the O-DU is already instantiated on the O-Cloud With desired HW Accelerator resources assigned from O2 and Configuration through O1 interface is complete'. The Initialization Services section shows a call to '1 initAal' and a return. The Inventory Services section shows a call to '3 getAalLpuInfo' and a return '4 Response getAalLpuInfo'. The Configuration & Operation Services section contains three nested loops: an outer loop 'loop [for each AAL-LPU]', an inner loop 'loop [for each AAL-Profile-Instance]', and a third loop 'loop [for each AAL-Profile-Queue]'. The inner loop contains calls '5 createAalProfileInstance', '7 setAalProfileInstanceConfig', and '9 startAalProfileInstance', with returns '6 AAL-Profile-Instance handle / identifier' and '8 return'. The third loop contains calls '11 setAalProfileQueueConfig' and '13 startAalProfileQueue', with returns '12 return' and '14 return'. After the loops, there is a call '15 cleanupAal' and a return '16 return'.](8fc34bc59ac1849b848a737b2cd379e5_img.jpg)
**O-RAN**
« OAAL-App »
O-DU
**Cloud Platform**
AAL Implementation
Assumed the O-DU is already instantiated on the O-Cloud
With desired HW Accelerator resources assigned from O2 and
Configuration through O1 interface is complete
**Initialization Services**
1 initAal
2 return
**Inventory Services**
3 getAalLpuInfo
4 Response getAalLpuInfo
**Configuration & Operation Services**
**loop** [for each AAL-LPU]
**loop** [for each AAL-Profile-Instance]
5 createAalProfileInstance
6 AAL-Profile-Instance handle / identifier
7 setAalProfileInstanceConfig
8 return
9 startAalProfileInstance
10 return
**loop** [for each AAL-Profile-Queue]
11 setAalProfileQueueConfig
12 return
13 startAalProfileQueue
14 return
15 cleanupAal
16 return
« OAAL-App »
O-DU
AAL Implementation
Sequence diagram showing the interaction between O-RAN and Cloud Platform for AAL services. The diagram is divided into three sections: Initialization Services, Inventory Services, and Configuration & Operation Services. The O-RAN side contains the « OAAL-App » O-DU, and the Cloud Platform side contains the AAL Implementation. A note at the top states: 'Assumed the O-DU is already instantiated on the O-Cloud With desired HW Accelerator resources assigned from O2 and Configuration through O1 interface is complete'. The Initialization Services section shows a call to '1 initAal' and a return. The Inventory Services section shows a call to '3 getAalLpuInfo' and a return '4 Response getAalLpuInfo'. The Configuration & Operation Services section contains three nested loops: an outer loop 'loop [for each AAL-LPU]', an inner loop 'loop [for each AAL-Profile-Instance]', and a third loop 'loop [for each AAL-Profile-Queue]'. The inner loop contains calls '5 createAalProfileInstance', '7 setAalProfileInstanceConfig', and '9 startAalProfileInstance', with returns '6 AAL-Profile-Instance handle / identifier' and '8 return'. The third loop contains calls '11 setAalProfileQueueConfig' and '13 startAalProfileQueue', with returns '12 return' and '14 return'. After the loops, there is a call '15 cleanupAal' and a return '16 return'.
### 5.3.3 AALI-C-Transport API Sequence
The AALI-C-App Transport API sequence is divided into two sets of call flows in the following subsections:
- Sec. 5.3.3.1 focusses on call flows related to allocation of buffers(s) to be used with other AALI-C-App Transport APIs.
- Sec. 5.3.3.2 and its subsections focus on call flows detailing the various procedures for sending and receiving buffer(s) using AALI-C-App Transport API.
#### 5.3.3.1 Allocation of AAL Buffer(s)
The AALI-C-App Transport API supports allocation of buffers from either pre-created buffer pool(s) or from memory not mapped to pre-created buffer pool(s). Send buffer(s) are allocated by the AAL Application, while Receive buffer(s) are allocated either by the AAL Application or by the AAL Implementation.
NOTE 2: The terms "AAL" and "AAL Implementation" are used interchangeably in the tables below.
**Table 5.3.3.1-1 : Allocation of AAL Buffer(s) workflow steps**
| | Evolution / Specification | <<Uses>><br>Related use |
|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|
| Goal | The AAL Application (e.g., O-DU) creates and allocates memory to be used when offloading operations to the AAL Implementation. | |
| Actors and Roles | AAL Application: calls buffer operations with desired input parameters.<br>AAL: executes buffer operations. | |
| Assumptions | This sequence is representative of how the AAL Application uses the buffer operations. | |
| Pre-conditions | AAL Implementation is initialized. | |
| Begins when | The AAL Application is ready to create buffers. | |
| Steps 1-2 (O) | The AAL Application can optionally create a buffer pool by calling the createBufferPool operation. On success, the AAL returns a buffer_pool_handle to the created buffer pool. | |
| Steps 3-4 (M) | The AAL Application allocates a buffer to use in future AAL operations. The buffer can be allocated from a pre-created buffer pool from steps 1 and 2, or can be dynamically allocated. On success, the AAL returns a buffer_handle. | |
| Steps 5 – 8 (O) | The AAL Application can retrieve the pointer to the buffer to add/modify/delete the content of the buffers. The AAL Application can also check the size of the buffer. | |
| Steps 9 – 10 (M) | Once the AAL Application is finished with the buffer it can free the buffer by calling the bufferFree operation. | |
| Steps 11 – 12 (O) | If previously created in steps 1 and 2 and the AAL Application is finished with the buffer pool, the AAL Application will destroy the buffer pool. | |
| | | |
|-----------------|-------------------------------------------------------------------------------------------------------------------------------|--|
| Ends when | All memory is freed and returned to the AAL Implementation. | |
| Exceptions | Exceptions can occur in steps 1, 3, 5, 7, 9 and 10 if the AAL fails to allocate or free memory. The AAL will report an error. | |
| Post Conditions | Memory is freed, AAL Application is free to continue processing. | |
| Traceability | To be added later. | |
##### 5.3.3.1.1 Sequence Diagram
```
@startuml
Autonumber
Skinparam sequenceArrowThickness 2
skinparam ParticipantPadding 5
skinparam BoxPadding 10
Box "O-RAN" #NavajoWhite
Participant "O-DU" as ODU << AAL-App>>
end box
Box "Cloud Platform" #lightseagreen
participant "AAL Implementation" as AAL
End box
activate ODU
ref over ODU, AAL
AALI-C-App Sequence assumptions (Sec. 5.3.2)
End ref
==Inventory Services==
ref over ODU, AAL
AALI-C-App API Sequence call flow related to Inventory Service (Sec. 5.3.2)
End ref
==Creating Buffer Pools and Allocating Buffers ==
opt if buffer pool creation
ODU -> AAL : createBufferPool
activate AAL
AAL --> ODU : return buffer pool handle(s)
Deactivate AAL
End opt
Note over ODU, AAL
Allocate a buffer using pre-created buffer pool with buffer_pool_handle
or allocate dynamically with NULL buffer_pool_handle parameter
Endnote
ODU -> AAL : allocBuffer
activate AAL
AAL --> ODU : return buffer handle
deactivate AAL
autoactivate on
opt Get buffer address and buffer size using buffer handle if needed
ODU -> AAL : getBufferAddr
AAL --> ODU: return buffer address
ODU -> AAL: getBufferSize
AAL --> ODU: return buffer size
End opt
ref over ODU, AAL
AALI-C-App API Sequence call flow related to AAL-LPU, AAL-Profile-Instance
```
```
and AAL-Profile-Queue initialization & configuration (Sec. 5.3.2)
end ref
==Run Time Operations ==
ref over ODU, AAL
AALI-C-App API Sequence call flow related to Sending/Receiving Buffer(s) (Sec. 5.3.3.2)
End ref
==Free Buffer, Destroy Buffer Pool Operations ==
ODU -> AAL : freeBuffer
AAL --> ODU : success/failure
opt if buffer pool was created by the AAL Application
ODU -> AAL : destroyBufferPool
AAL --> ODU : success/failure
End opt
deactivate ODU
@enduml
```
**O-RAN**
«AAL-App»
O-DU
**Cloud Platform**
AAL Implementation
ref
AALI-C-App Sequence assumptions (Sec. 5.3.2)
**Inventory Services**
ref
AALI-C-App API Sequence call flow related to Inventory Service (Sec. 5.3.2)
**Creating Buffer Pools and Allocating Buffers**
opt **[if buffer pool creation]**
1 createBufferPool
2 return buffer pool handle(s)
Allocate a buffer using pre-created buffer pool with buffer\_pool\_handle or allocate dynamically with NULL buffer\_pool\_handle parameter
3 allocBuffer
4 return buffer handle
opt **[Get buffer address and buffer size using buffer handle if needed]**
5 getBufferAddr
6 return buffer address
7 getBufferSize
8 return buffer size
ref
AALI-C-App API Sequence call flow related to AAL-LPU, AAL-Profile-Instance and AAL-Profile-Queue initialization & configuration (Sec. 5.3.2)
**Run Time Operations**
ref
AALI-C-App API Sequence call flow related to Sending/Receiving Buffer(s) (Sec. 5.3.3.2)
**Free Buffer, Destroy Buffer Pool Operations**
9 freeBuffer
10 success/failure
opt **[if buffer pool was created by the AAL Application]**
11 destroyBufferPool
12 success/failure
«AAL-App»
O-DU
AAL Implementation
Sequence diagram showing the interaction between O-RAN and Cloud Platform for AAL-App O-DU and AAL Implementation. The diagram includes sections for Inventory Services, Creating Buffer Pools and Allocating Buffers, Run Time Operations, and Free Buffer, Destroy Buffer Pool Operations.
#### 5.3.3.2 Procedure for Buffer(s) Send and Receive
The AALI-C-App Transport API supports the following high level use cases
- Send Buffer Synchronous Mode with buffer free
- Send Buffer Synchronous Mode without buffer free
- Send Buffer Asynchronous Mode with buffer free
- Send Buffer Asynchronous Mode without buffer free
- Receive Buffer Synchronous Mode with non-NULL buffer\_handles(s) input
- Receive Buffer Synchronous Mode with NULL buffer\_handles(s) input
- Receive Buffer Asynchronous Mode with non-NULL buffer\_handle(s) input
- Receive Buffer Asynchronous Mode with NULL buffer\_handle(s) input
In the use cases above, 'with buffer free' and 'without buffer free' imply that the input parameter 'buffer\_free' = 'TRUE' (or 1) and 'FALSE' (or 0) respectively in sendBuffer operation (Sec. 5.4.3.5).
These use cases are detailed in the sections below.
##### 5.3.3.2.1 Send Buffer Synchronous Mode with buffer free
**Table 5.3.3.2.1-1 : Send Buffer Synchronous Mode with buffer free workflow steps**
| | Evolution / Specification | <<Uses>><br>Related use |
|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|
| Goal | The AAL Application (e.g., O-DU) sends buffer(s) to the AAL for processing in synchronous mode with buffer free. | |
| Actors and Roles | AAL Application: formats buffer and its content, and calls AAL to send the buffer.<br><br>AAL Implementation executes sendBuffer operation. | |
| Assumptions | This sequence is representative of how the AAL Application uses the sendBuffer operation in a synchronous manner with buffer free enabled. | |
| Pre-conditions | At least one AAL-Profile-Instance is configured and started. At least one AAL-Profile-Queue is configured and started. Buffer(s) to be sent are allocated. | |
| Begins when | The AAL Application is ready to send buffer. | |
| Step 1 (M) | The AAL Application calls the sendBuffer API to transfer the buffer to the AAL which will execute the sendBuffer operation. The AAL Application thread invoking the API is blocked waiting for the sendBuffer operation to complete. | |
| Steps 2 - 3 (M) | The AAL internally frees the buffer back to the buffer pool upon completion of the sendBuffer operation.<br><br>Once done, the AAL returns the status of the operation back to the AAL Application and unblock the AAL Application call thread process. | |
| Ends when | sendBuffer operation has completed. | |
| Exceptions | Exceptions can occur if the sendBuffer operation fails. Status indicating failure will be returned in Step 3. | |
| | | |
|-----------------|----------------------------------------------|--|
| Post Conditions | The AAL Application can continue processing. | |
| Traceability | To Be added later. | |
```
@startuml
Autonumber
Skinparam sequenceArrowThickness 2
skinparam ParticipantPadding 5
skinparam BoxPadding 10
autoactivate on
Box "O-RAN" #NavajoWhite
Participant "O-DU" as ODU << AAL-App>>
end box
Box "Cloud Platform" #lightseagreen
participant "AAL Implementation" as AAL
End box
activate ODU
ref over ODU, AAL
Section 5.3.3.1 Creating Buffer Pools and Allocating Buffers
end ref
==Synchronous Send Buffer (with buffer free) ==
ODU -> AAL : sendBuffer
Deactivate ODU
note over AAL
Perform operations and send all buffers.
Return when all buffers are sent.
endnote
AAL -> AAL : free buffer
AAL --> ODU : return status
Activate ODU
deactivate ODU
@enduml
```
```
sequenceDiagram
participant O-RAN as O-RAN
participant CP as Cloud Platform
participant AALApp as «AAL-App» O-DU
participant AALImpl as AAL Implementation
O-RAN-->>CP: ref Section 5.3.3.1 Creating Buffer Pools and Allocating Buffers
Note over CP: Synchronous Send Buffer (with buffer free)
AALApp->>AALImpl: 1 sendBuffer
activate AALImpl
Note right of AALImpl: Perform operations and send all buffers. Return when all buffers are sent.
AALImpl-->>AALApp: 2 free buffer
deactivate AALImpl
AALApp-->>AALApp: 3 return status
```
Sequence diagram showing the interaction between O-RAN and Cloud Platform for Synchronous Send Buffer (with buffer free) mode. The O-RAN side has a «AAL-App» O-DU. The Cloud Platform side has an AAL Implementation. The sequence starts with a reference to Section 5.3.3.1. Step 1: «AAL-App» O-DU calls sendBuffer on AAL Implementation. Step 2: AAL Implementation performs operations and sends all buffers, then returns. Step 3: «AAL-App» O-DU receives the return status.
##### 5.3.3.2.2 Send Buffer Synchronous Mode without buffer free
**Table 5.3.3.2.2-1 : Send Buffer Synchronous Mode without buffer free workflow steps**
| | Evolution / Specification | <<Uses>><br>Related use |
|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|
| Goal | The AAL Application sends buffer(s) to the AAL for processing in synchronous mode without buffer free. | |
| Actors and Roles | AAL Application: formats buffer and its content, and calls AAL to send the buffer.<br><br>AAL Implementation: executes sendBuffer operation. | |
| Assumptions | This sequence is representative of how the AAL Application uses the sendBuffer operation in a synchronous manner without buffer free enabled. | |
| Pre-conditions | At least one AAL-Profile-Instance is configured and started. At least one AAL-Profile-Queue is configured and started. Buffer(s) to be sent are allocated. | |
| Begins when | The AAL Application is ready to send buffer. | |
| Steps 1 – 2 (M) | The AAL Application calls the sendBuffer API to transfer the buffer to the AAL which will execute the sendBuffer operation. The AAL Application thread invoking the API is blocked waiting for the sendBuffer operation to complete. | |
| | | |
|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|
| | The AAL processes the operation and sends the buffers. Once done, the AAL returns the status of the operation back to the AAL Application and unblock the AAL Application call thread process. | |
| Step 3 (M) | The AAL Application, when finished with the buffer, calls freeBuffer operation and the AAL will free the buffer back to the buffer pool. | |
| Ends when | sendBuffer operation has completed. | |
| Exceptions | Exceptions can occur if the sendBuffer operation fails. Status indicating failure will be returned in Step 2. | |
| Post Conditions | The AAL Application can continue processing. | |
| Traceability | To Be added later. | |
```
@startuml
Autonumber
Skinparam sequenceArrowThickness 2
skinparam ParticipantPadding 5
skinparam BoxPadding 10
autoactivate on
Box "O-RAN" #NavajoWhite
Participant "O-DU" as ODU << AAL-App>>
end box
Box "Cloud Platform" #lightseagreen
participant "AAL Implementation" as AAL
End box
activate ODU
ref over ODU, AAL
Section 5.3.3.1 Creating Buffer Pools and Allocating Buffers
end ref
==Synchronous Send Buffer (without buffer free) ==
ODU -> AAL : sendBuffer
deactivate ODU
note over AAL
Perform operations and send all buffers.
Return when all buffers are sent.
Endnote
AAL --> ODU : return status
activate ODU
ODU -> AAL: freeBuffer
AAL --> ODU : success/failure
deactivate ODU
@enduml
```
```
sequenceDiagram
participant O-RAN as O-RAN
participant Cloud Platform as Cloud Platform
participant AAL_App_O-DU as « AAL-App » O-DU
participant AAL_Implementation as AAL Implementation
O-RAN->>Cloud Platform: 1 sendBuffer
activate AAL_Implementation
Note over AAL_Implementation: Perform operations and send all buffers.
Return when all buffers are sent.
AAL_Implementation-->>O-RAN: 2 return status
deactivate AAL_Implementation
O-RAN->>Cloud Platform: 3 freeBuffer
activate AAL_Implementation
AAL_Implementation-->>O-RAN: 4 success/failure
deactivate AAL_Implementation
```
The diagram illustrates the workflow for sending a buffer synchronously without a buffer free operation. It shows two main components: O-RAN (orange) and Cloud Platform (teal). Within O-RAN, there is a component « AAL-App » O-DU. Within the Cloud Platform, there is a component AAL Implementation. The process starts with the O-RAN component sending a message '1 sendBuffer' to the AAL Implementation. The AAL Implementation then performs operations and sends all buffers, returning when all buffers are sent. This is followed by the AAL Implementation returning a status '2 return status' to the O-RAN component. The O-RAN component then sends a message '3 freeBuffer' to the AAL Implementation, which returns a success/failure status '4 success/failure' to the O-RAN component. A reference 'ref' points to 'Section 5.3.3.1 Creating Buffer Pools and Allocating Buffers'.
Sequence diagram for Synchronous Send Buffer (without buffer free) showing interactions between O-RAN and Cloud Platform.
##### 5.3.3.2.3 Send Buffer Asynchronous Mode with buffer free
**Table 5.3.3.2.3-1 : Send Buffer Synchronous Mode without buffer free workflow steps**
| | Evolution / Specification | <<Uses>><br>Related use |
|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|
| Goal | The AAL Application sends buffer(s) to the AAL for processing in asynchronous mode with buffer free. | |
| Actors and Roles | AAL Application: formats buffer and its content, and calls AAL to send the buffer.<br><br>AAL Implementation: executes sendBuffer operation. | |
| Assumptions | This sequence is representative of how the AAL Application uses the sendBuffer operation in an asynchronous manner with buffer free enabled. | |
| Pre-conditions | At least one AAL-Profile-Instance is configured and started. At least one AAL-Profile-Queue is configured and started. Buffer(s) to be sent are allocated. | |
| Begins when | The AAL Application is ready to send buffer. | |
| Steps 1 – 3 (M) | The AAL Application calls the sendBuffer API to transfer the buffer to the AAL which will execute the sendBuffer operation.<br><br>The AAL Application thread invoking the API is returned immediately with the status of the API call, without being blocked until the completion of sendBuffer operation. | |
| | | |
|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|
| | The AAL continues to process the operation and sends the buffers. Upon completion of sendBuffer operation, the AAL internally frees the buffer back to the buffer pool. | |
| Step 4 (O) | Once done, the AAL optionally returns the status of the operation back to the AAL Application, if the AAL Application preregisters for a callback. | |
| Ends when | sendBuffer operation has completed. | |
| Exceptions | Exceptions can occur if the sendBuffer API call fails. Status indicating failure will be returned in Step 2. | |
| Post Conditions | The AAL Application can continue processing. | |
| Traceability | To Be added later. | |
```
@startuml
Autonumber
Skinparam sequenceArrowThickness 2
skinparam ParticipantPadding 5
skinparam BoxPadding 10
Box "O-RAN" #NavajoWhite
Participant "O-DU" as ODU << AAL-App>>
end box
Box "Cloud Platform" #lightseagreen
participant "AAL Implementation" as AAL
End box
activate ODU
ref over ODU, AAL
Section 5.3.3.1 Creating Buffer Pools and Allocating Buffers
end ref
==Asynchronous Send Buffer (with buffer free) ==
ODU -> AAL : sendBuffer
Activate AAL
note over AAL
Return immediately.
endnote
AAL --> ODU : return status of API
Note over AAL
Continue to process operations asynchronously
until all buffers sent.
endnote
AAL -> AAL: free Buffer
opt if a callback is preregistered
AAL -> ODU: execute preregistered callback function
End opt
deactivate AAL
deactivate ODU
@enduml
```
```
sequenceDiagram
participant O-RAN as O-RAN
participant CP as Cloud Platform
participant AAL_O_DU as «AAL-App» O-DU
participant AAL_Impl as AAL Implementation
O-RAN->>CP: ref Section 5.3.3.1 Creating Buffer Pools and Allocating Buffers
O-RAN->>CP: 1 sendBuffer
CP-->>O-RAN: 2 return status of API
CP->>CP: Return immediately.
CP->>CP: Continue to process operations asynchronously until all buffers sent.
CP->>CP: 3 free Buffer
O-RAN->>CP: opt [if a callback is preregistered] 4 execute preregistered callback function
```
The diagram illustrates the workflow for sending a buffer asynchronously without buffer free. It shows the interaction between the O-RAN (O-DU) and the Cloud Platform (AAL Implementation). The O-RAN sends a buffer to the AAL Implementation, which returns the status of the API. The AAL Implementation then returns immediately and continues to process operations asynchronously until all buffers are sent. Finally, the AAL Implementation sends a free buffer message back to the O-RAN. An optional step shows the AAL Implementation executing a preregistered callback function if one is present.
Sequence diagram for Asynchronous Send Buffer (with buffer free) showing interactions between O-RAN and Cloud Platform.
##### 5.3.3.2.4 Send Buffer Asynchronous Mode without buffer free
**Table 5.3.3.2.4-1 : Send Buffer Asynchronous Mode without buffer free workflow steps**
| | Evolution / Specification | <<Uses>><br>Related use |
|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|
| Goal | The AAL Application sends buffer(s) to the AAL for processing in asynchronous mode without buffer free. | |
| Actors and Roles | AAL Application: formats buffer and its content, and calls AAL to send the buffer.<br>AAL Implementation: executes sendBuffer operation. | |
| Assumptions | This sequence is representative of how the AAL Application uses the sendBuffer operation in an asynchronous manner without buffer free enabled. | |
| Pre-conditions | At least one AAL-Profile-Instance is configured and started. At least one AAL-Profile-Queue is configured and started. Buffer(s) to be sent are allocated. | |
| Begins when | The AAL Application is ready to send buffer. | |
| Steps 1-2 (M) | The AAL Application calls the sendBuffer API to transfer the buffer to the AAL which will execute the sendBuffer operation. | |
| | | |
|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|
| | <p>The AAL Application thread invoking the API is returned immediately with the status of the API call, without being blocked until the completion of sendBuffer operation.</p> <p>The AAL continues to process the operation and sends the buffers.</p> | |
| Steps 3-4 (CM) | In case of without preregistered callback, the AAL Application, when finished with the buffer <sup>[1]</sup> , calls freeBuffer operation. The AAL returns the status of the API call immediately and internally frees the buffer upon completion of sendBuffer operation. | |
| Steps 5-7 (CM) | <p>In case of with preregistered callback, the AAL returns the status of the sendBuffer operation back to the AAL Application, once done.</p> <p>The AAL Application, when finished with the buffer <sup>[2]</sup>, calls freeBuffer operation and the AAL will free the buffer back to the buffer pool.</p> | |
| Ends when | sendBuffer operation has completed. | |
| Exceptions | Exceptions can occur if the sendBuffer API call fails. Status indicating failure will be returned in Step 2. | |
| Post Conditions | The AAL Application can continue processing. | |
| Traceability | To Be added later. | |
Note <sup>[1]</sup>: The AAL Application should not modify the content of the buffer(s) after step 2.
Note <sup>[2]</sup>: The AAL Application can modify the content of the buffer(s) after step 5.
```
@startuml
Autonumber
Skinparam sequenceArrowThickness 2
skinparam ParticipantPadding 5
skinparam BoxPadding 10
Box "O-RAN" #NavajoWhite
Participant "O-DU" as ODU << AAL-App>>
end box
Box "Cloud Platform" #lightseagreen
participant "AAL Implementation" as AAL
End box
activate ODU
ref over ODU, AAL
Section 5.3.3.1 Creating Buffer Pools and Allocating Buffers
end ref
==Asynchronous Send Buffer (without buffer free) ==
ODU -> AAL : sendBuffer
activate AAL
note over AAL
return immediately.
endnote
AAL --> ODU : return status of API
Note over AAL
Continue to process operations asynchronously
```
```
until all buffers sent.
endnote
alt without callback
ODU -> AAL: freeBuffer
AAL --> ODU : success/failure
Note over AAL
Internally buffer is freed when sendBuffer completes.
endnote
else with preregistered callback
AAL --> ODU: execute preregistered callback function
deactivate AAL
ODU -> AAL: freeBuffer
activate AAL
AAL --> ODU : success/failure
deactivate AAL
end
deactivate ODU
@enduml
```
The diagram illustrates the sequence of operations for an asynchronous send buffer without a buffer free callback. It involves two main entities: O-RAN (represented by «AAL-App» O-DU) and Cloud Platform (represented by AAL Implementation).
**Sequence of Operations:**
- ref:** Section 5.3.3.1 Creating Buffer Pools and Allocating Buffers
- Asynchronous Send Buffer (without buffer free)** (Double horizontal line separator)
- 1 sendBuffer:** O-RAN sends a message to Cloud Platform.
- return immediately:** Cloud Platform returns immediately.
- 2 return status of API:** Cloud Platform returns status to O-RAN.
- Continue to process operations asynchronously until all buffers sent.** (Note block)
- alt:**
- [without callback]**
- 3 freeBuffer:** O-RAN sends freeBuffer to Cloud Platform.
- 4 success/failure:** Cloud Platform returns success/failure to O-RAN.
- Internally buffer is freed when sendBuffer completes.** (Note block)
- [with preregistered callback]**
- 5 execute preregistered callback function:** Cloud Platform executes callback function on O-RAN.
- 6 freeBuffer:** O-RAN sends freeBuffer to Cloud Platform.
- 7 success/failure:** Cloud Platform returns success/failure to O-RAN.
Sequence diagram showing the interaction between O-RAN and Cloud Platform for asynchronous send buffer operations.
##### 5.3.3.2.5 Receive Buffer Synchronous Mode with non-NULL buffer\_handle(s) input
**Table 5.3.3.2.5-1 : Receive Buffer Synchronous Mode with non-NULL buffer\_handle(s) input workflow steps**
| | Evolution / Specification | <<Uses>><br>Related use |
|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|
| Goal | The AAL Application (e.g., O-DU) receives buffer(s) from the AAL in synchronous mode with non-NULL buffer_handle(s) input. | |
| Actors and Roles | AAL Application: calls AAL to receive the buffer.<br>AAL Implementation: executes receiveBuffer operation. | |
| Assumptions | This sequence is representative of how the AAL Application uses the receiveBuffer operation in a synchronous manner with non-NULL buffer handle(s) input. | |
| Pre-conditions | At least one AAL-Profile-Instance is configured and started. At least one AAL-Profile-Queue is configured and started. Receive buffer(s) are allocated. | |
| Begins when | The AAL Application is ready to receive buffer. | |
| Steps 1 – 2 (M) | The AAL Application calls the receiveBuffer API to receive buffer content from the AAL which will execute the receiveBuffer operation. The AAL Application thread invoking the API is blocked waiting for the receiveBuffer operation to complete.<br><br>Once done, the AAL returns the status of the operation back to the AAL Application and unblock the AAL Application call thread process. | |
| Steps 3 - 4 (M) | The AAL Application, when finished with the buffer, calls freeBuffer operation and the AAL will free the buffer back to the buffer pool. | |
| Ends when | receiveBuffer operation has completed. | |
| Exceptions | Exceptions can occur if the receiveBuffer operation fails. Status indicating failure will be returned in Step 2. | |
| Post Conditions | The AAL Application can continue processing. | |
| Traceability | To Be added later. | |
```
@startuml
Autonumber
Skinparam sequenceArrowThickness 2
skinparam ParticipantPadding 5
skinparam BoxPadding 10
autoactivate on
Box "O-RAN" #NavajoWhite
Participant "O-DU" as ODU << AAL-App>>
end box
Box "Cloud Platform" #lightseagreen
participant "AAL Implementation" as AAL
End box
activate ODU
ref over ODU, AAL
```
##### Section 5.3.3.1 Creating Buffer Pools and Allocating Buffers
```
==Synchronous Receive Buffer==
```
```
ODU -> AAL : receiveBuffer
deactivate ODU
```
```
note over AAL
Perform operations and receive all buffers.
Return when all buffers are sent.
Endnote
```
```
AAL --> ODU : return status
activate ODU
ODU -> AAL: freeBuffer
AAL --> ODU : success/failure
```
```
deactivate ODU
@enduml
```
```
sequenceDiagram
participant O_RAN as O-RAN
participant Cloud_Platform as Cloud Platform
participant AAL_App as «AAL-App» O-DU
participant AAL_Implementation as AAL Implementation
O_RAN->>Cloud_Platform: ref
O_RAN->>Cloud_Platform: Section 5.3.3.1 Creating Buffer Pools and Allocating Buffers
O_RAN->>Cloud_Platform: 1 receiveBuffer
activate AAL_Implementation
Note over AAL_Implementation: Perform operations and receive all buffers.
Return when all buffers are sent.
Cloud_Platform-->>O_RAN: 2 return status
deactivate AAL_Implementation
O_RAN->>Cloud_Platform: 3 freeBuffer
activate AAL_Implementation
Cloud_Platform-->>O_RAN: 4 success/failure
deactivate AAL_Implementation
```
The diagram illustrates the sequence of operations for a Synchronous Receive Buffer. It shows the interaction between the O-RAN (represented by the «AAL-App» O-DU) and the Cloud Platform (represented by the AAL Implementation). The process begins with a reference to Section 5.3.3.1, followed by the O-RAN sending a 'receiveBuffer' message to the Cloud Platform. The Cloud Platform then performs operations and returns a 'return status' to the O-RAN. Finally, the O-RAN sends a 'freeBuffer' message to the Cloud Platform, which returns a 'success/failure' status.
Sequence diagram showing the interaction between O-RAN and Cloud Platform for a Synchronous Receive Buffer.
```
sequenceDiagram
participant O-RAN as O-RAN
participant Cloud Platform as Cloud Platform
O-RAN->>Cloud Platform: 1 receiveBuffer
activate Cloud Platform
Note over Cloud Platform: Perform operations and receive all buffers. Return when all buffers are sent.
Cloud Platform-->>O-RAN: 2 return status
deactivate Cloud Platform
O-RAN->>Cloud Platform: 3 freeBuffer
activate Cloud Platform
Cloud Platform-->>O-RAN: 4 success/failure
deactivate Cloud Platform
```
Sequence diagram showing the workflow for Receive Buffer Synchronous Mode with NULL buffer\_handle(s) input. The diagram involves two main components: O-RAN (containing «AAL-App» O-DU) and Cloud Platform (containing AAL Implementation). A reference is made to Section 5.3.3.1. The sequence of messages is: 1. receiveBuffer (O-RAN to Cloud Platform), 2. return status (Cloud Platform to O-RAN), 3. freeBuffer (O-RAN to Cloud Platform), and 4. success/failure (Cloud Platform to O-RAN). A note indicates that the AAL Implementation performs operations and receives all buffers, returning when all buffers are sent.
##### 5.3.3.2.6 Receive Buffer Synchronous Mode with NULL buffer\_handle(s) input
**Table 5.3.3.2.6-1: Receive Buffer Synchronous Mode with NULL buffer\_handle(s) input workflow steps**
| | Evolution / Specification | <<Uses>><br>Related use |
|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|
| Goal | The AAL Application (e.g., O-DU) receives buffer(s) from the AAL in synchronous mode with NULL buffer_handle(s) input. | |
| Actors and Roles | AAL Application: calls AAL to receive the buffer.<br>AAL Implementation: executes receiveBuffer operation. | |
| Assumptions | This sequence is representative of how the AAL Application uses the receiveBuffer operation in a synchronous manner with NULL buffer_handle(s) input. | |
| Pre-conditions | At least one AAL-Profile-Instance is configured and started. At least one AAL-Profile-Queue is configured and started. | |
| Begins when | The AAL Application is ready to receive buffer. | |
| Steps 1 – 2 (M) | The AAL Application calls the receiveBuffer API to receive buffer content from the AAL which will execute the receiveBuffer operation including the allocation of the buffers. The AAL Application thread invoking the API is blocked waiting for the receiveBuffer operation to complete.<br><br>Once done, the AAL returns the status of the operation back to the AAL Application and unblock the AAL Application call thread process. | |
| Steps 3 - 4 (M) | The AAL Application, when finished with the buffer, calls freeBuffer operation and the AAL will free the buffer back to the buffer pool. | |
| Ends when | receiveBuffer operation has completed. | |
| Exceptions | Exceptions can occur if the receiveBuffer operation fails. Status indicating failure will be returned in Step 2. | |
| | | |
|-----------------|----------------------------------------------|--|
| Post Conditions | The AAL Application can continue processing. | |
| Traceability | To Be added later. | |
```
@startuml
Autonumber
Skinparam sequenceArrowThickness 2
skinparam ParticipantPadding 5
skinparam BoxPadding 10
autoactivate on
Box "O-RAN" #NavajoWhite
Participant "O-DU" as ODU << AAL-App >>
end box
Box "Cloud Platform" #lightseagreen
participant "AAL Implementation" as AAL
End box
activate ODU
ref over ODU, AAL
Section 5.3.3.1 Creating Buffer Pools and Allocating Buffers
end ref
==Synchronous Receive Buffer==
ODU -> AAL : receiveBuffer
deactivate ODU
AAL -> AAL : allocate buffer
note over AAL
Perform operations and receive all buffers.
Return when all buffers are sent.
endnote
AAL --> ODU : return status
deactivate AAL
activate ODU
ODU -> AAL: freeBuffer
AAL --> ODU : success/failure
deactivate ODU
@enduml
```
```
sequenceDiagram
participant O-RAN as O-RAN
participant CP as Cloud Platform
participant AAL_Implementation as AAL Implementation
O-RAN->>CP: 1 receiveBuffer
activate CP
CP->>AAL_Implementation: 2 allocate buffer
activate AAL_Implementation
AAL_Implementation-->>CP:
deactivate AAL_Implementation
CP-->>O-RAN: 3 return status
deactivate CP
O-RAN->>CP: 4 freeBuffer
activate CP
CP-->>O-RAN: 5 success/failure
deactivate CP
```
Sequence diagram for Synchronous Receive Buffer workflow. The diagram shows interactions between O-RAN (containing «AAL-App» O-DU) and Cloud Platform (containing AAL Implementation). A reference to Section 5.3.3.1 is provided. The workflow steps are: 1. receiveBuffer (O-RAN to Cloud Platform), 2. allocate buffer (Cloud Platform self-call), 3. return status (Cloud Platform to O-RAN), 4. freeBuffer (O-RAN to Cloud Platform), and 5. success/failure (Cloud Platform to O-RAN). A note indicates: 'Perform operations and receive all buffers. Return when all buffers are sent.'
##### 5.3.3.2.7 Receive Buffer Asynchronous Mode with non-NULL buffer\_handle(s) input
**Table 5.3.3.2.7-1: Receive Buffer Asynchronous Mode with non-NULL buffer\_handle(s) input workflow steps**
| | Evolution / Specification | <<Uses>><br>Related use |
|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|
| Goal | The AAL Application (e.g., O-DU) receives buffer(s) from the AAL in asynchronous mode with non-NULL buffer_handle(s) input. | |
| Actors and Roles | AAL Application: calls AAL to receive the buffer.<br>AAL Implementation: executes receiveBuffer operation. | |
| Assumptions | This sequence is representative of how the AAL Application uses the receiveBuffer operation in an asynchronous manner with non-NULL buffer_handle(s) input. | |
| Pre-conditions | At least one AAL-Profile-Instance is configured and started. At least one AAL-Profile-Queue is configured and started. Receive buffer(s) are allocated. | |
| Begins when | The AAL Application is ready to receive buffer. | |
| Step 1-4 (CM) | In case of without callback, the AAL Application calls the receiveBuffer API to receive buffer content from the AAL which will execute the receiveBuffer | |
| | | |
|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|
| | operation. In the case no buffers are ready to be received the AAL Implementation returns immediately indicating no buffers were received. | |
| | The AAL Application calls the receiveBuffer API to receive buffer content from the AAL which will execute the receiveBuffer operation. The AAL returns the status of the operation and the number of buffers received. | |
| Steps 5-8 (CM) | In case of with preregistered callback, the AAL Application calls the receiveBuffer API to receive buffer content from the AAL which will execute the receiveBuffer operation. In the case no buffers are ready to be received the AAL Implementation returns immediately indicating the status of the operation. The AAL Implementation waits asynchronously for buffers to be received. Upon receiving buffers, the pre-registered callback function is executed to asynchronously inform the AAL Application that new buffers have been received. | |
| Steps 9-10 (M) | The AAL Application, when finished with the buffer, calls freeBuffer operation and the AAL will free the buffer back to the buffer pool. | |
| Ends when | receiveBuffer operation has completed. | |
| Exceptions | Exceptions can occur if the receiveBuffer operation fails. Status indicating failure will be returned in Step 1 or 5 or 8. | |
| Post Conditions | The AAL Application can continue processing. | |
| Traceability | To Be added later. | |
```
@startuml
Autonumber
Skinparam sequenceArrowThickness 2
skinparam ParticipantPadding 5
skinparam BoxPadding 10
autoactivate on
Box "O-RAN" #NavajoWhite
Participant "O-DU" as ODU << AAL-App >>
end box
Box "Cloud Platform" #lightseagreen
participant "AAL Implementation" as AAL
End box
activate ODU
ref over ODU, AAL
Section 5.3.3.1 Creating Buffer Pools and Allocating Buffers
end ref
==Asynchronous Receive Buffer==
alt without callback
ODU -> AAL : receiveBuffer
deactivate ODU
note over AAL
If no buffers received return immediately.
In Asynchronous mode with no callback receive
API behaves in a poll manner.
endnote
```
```
AAL --> ODU : (number of buffers = 0)
activate ODU
ODU -> AAL : receiveBuffer
deactivate ODU
AAL --> ODU : success (number of buffers)
activate ODU
else with preregistered callback
ODU -> AAL : receiveBuffer
Activate AAL
AAL --> ODU : return status
AAL -> AAL : wait for receive buffers
note over AAL
AAL executes receive operation.
endnote
AAL --> ODU: execute preregistered callback function
deactivate AAL
end
activate ODU
ODU -> AAL: freeBuffer
AAL --> ODU : success/failure
deactivate ODU
@enduml
```
```
sequenceDiagram
participant O-RAN as «AAL-App» O-DU
participant Cloud Platform as AAL Implementation
ref Section 5.3.3.1 Creating Buffer Pools and Allocating Buffers
alt Asynchronous Receive Buffer
alt [without callback]
O-RAN->>Cloud Platform: 1 receiveBuffer
Cloud Platform-->>O-RAN: 2 (number of buffers = 0)
O-RAN->>Cloud Platform: 3 receiveBuffer
Cloud Platform-->>O-RAN: 4 success (number of buffers)
and [with preregistered callback]
O-RAN->>Cloud Platform: 5 receiveBuffer
Cloud Platform-->>O-RAN: 6 return status
Cloud Platform->>Cloud Platform: 7 wait for receive buffers
Cloud Platform-->>O-RAN: 8 execute preregistered callback function
O-RAN->>Cloud Platform: 9 freeBuffer
Cloud Platform-->>O-RAN: 10 success/failure
end
end
```
If no buffers received return immediately. In Asynchronous mode with no callback receive API behaves in a poll manner.
AAL executes receive operation.
Sequence diagram for Asynchronous Receive Buffer API workflow. The diagram shows interactions between O-RAN (AAL-App O-DU) and Cloud Platform (AAL Implementation). It includes a reference to Section 5.3.3.1, an asynchronous receive buffer section, and two alternative flows: one without a callback and one with a preregistered callback. The 'without callback' flow shows steps 1 (receiveBuffer), 2 (number of buffers = 0), 3 (receiveBuffer), and 4 (success). The 'with preregistered callback' flow shows steps 5 (receiveBuffer), 6 (return status), 7 (wait for receive buffers), 8 (execute preregistered callback function), 9 (freeBuffer), and 10 (success/failure). A note indicates that if no buffers are received, the return is immediate in asynchronous mode without a callback. Another note states that the AAL Implementation executes the receive operation.
##### 5.3.3.2.8 Receive Buffer Asynchronous Mode with NULL buffer\_handle input
**Table 5.3.3.2.8-1 : Receive Buffer Asynchronous Mode with NULL buffer\_handle input workflow steps**
| | Evolution / Specification | <<Uses>><br>Related use |
|--|---------------------------|-------------------------|
|--|---------------------------|-------------------------|
| | | |
|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|
| Goal | The AAL Application (e.g., O-DU) receives buffer(s) from the AAL in asynchronous mode with NULL buffer_handle input. | |
| Actors and Roles | AAL Application: calls AAL to receive the buffer.<br><br>AAL Implementation: executes receiveBuffer operation. | |
| Assumptions | This sequence is representative of how the AAL Application uses the receiveBuffer operation in an asynchronous manner with NULL buffer_handle input. | |
| Pre-conditions | At least one AAL-Profile-Instance is configured and started. At least one AAL-Profile-Queue is configured and started. | |
| Begins when | The AAL Application is ready to receive buffer. | |
| Steps 1-5 (CM) | In case of with callback, the AAL Application calls the receiveBuffer API to receive buffer content from the AAL which will execute the receive. In the case no buffers are ready to be received the AAL Implementation returns immediately indicating no buffers were received.<br><br>The AAL Application calls the receiveBuffer API to receive buffer content from the AAL which will execute the receiveBuffer operation including the allocation of the buffers. The AAL returns the status of the operation, newly allocated buffer_handle(s) and the number of buffers received. | |
| Steps 6-10 (CM) | In case of with preregistered callback, the AAL Application calls the receiveBuffer API to receive buffer content from the AAL which will execute the receiveBuffer operation. In the case no buffers are ready to be received the AAL Implementation returns immediately indicating the status of the operation.<br><br>The AAL Implementation waits asynchronously for buffers to be received. The AAL allocates the buffers. Upon receiving buffers, the pre-registered callback function is executed to asynchronously inform the AAL Application that new buffers have been received. | |
| Steps 11-12 (M) | The AAL Application, when finished with the buffer, calls freeBuffer operation and the AAL will free the buffer back to the buffer pool. | |
| Ends when | receiveBuffer operation has completed. | |
| Exceptions | Exceptions can occur if the receiveBuffer operation fails. Status indicating failure will be returned in Step 1 or 5 or 8. | |
| Post Conditions | The AAL Application can continue processing. | |
| Traceability | To Be added later. | |
```
@startuml
Autonumber
Skinparam sequenceArrowThickness 2
skinparam ParticipantPadding 5
skinparam BoxPadding 10
autoactivate on
Box "O-RAN" #NavajoWhite
Participant "O-DU" as ODU << AAL-App>>
end box
Box "Cloud Platform" #lightseagreen
```
```
participant "AAL Implementation" as AAL
End box
activate ODU
ref over ODU, AAL
Section 5.3.3.1 Creating Buffer Pools and Allocating Buffers
end ref
==Asynchronous Receive Buffer==
alt without callback
ODU -> AAL : receiveBuffer
deactivate ODU
note over AAL
If no buffers received return immediately.
In Asynchronous mode with no callback receive
API behaves in a poll mode manner.
endnote
AAL --> ODU : (number of buffers = 0)
activate ODU
ODU -> AAL : receiveBuffer
deactivate ODU
AAL -> AAL : Allocate buffer(s)
AAL --> ODU : success (number of buffers)
activate ODU
else with preregistered callback
ODU -> AAL : receiveBuffer
AAL --> ODU : return status
AAL -> AAL : wait for receive buffers
AAL -> AAL : Allocate buffer(s)
note over AAL
AAL executes receive operation.
endnote
AAL --> ODU : execute preregistered callback function
deactivate AAL
deactivate AAL
end
activate ODU
ODU -> AAL : freeBuffer
AAL --> ODU : success/failure
deactivate ODU
@enduml
```
The diagram illustrates the sequence of operations for the Asynchronous Receive Buffer API between the O-RAN and the Cloud Platform.
**Participants:**
- O-RAN:** Contains the «AAL-App» O-DU.
- Cloud Platform:** Contains the AAL Implementation.
**Sequence of Operations:**
- ref:** Section 5.3.3.1 Creating Buffer Pools and Allocating Buffers.
- alt [without callback]:**
- 1 receiveBuffer:** O-RAN sends to Cloud Platform.
- 2 (number of buffers = 0):** Cloud Platform returns to O-RAN.
- 3 receiveBuffer:** O-RAN sends to Cloud Platform.
- 4 Allocate buffer(s):** Cloud Platform performs internal action.
- 5 success (number of buffers):** Cloud Platform returns to O-RAN.
- [with preregistered callback]:**
- 6 receiveBuffer:** O-RAN sends to Cloud Platform.
- 7 return status:** Cloud Platform returns to O-RAN.
- 8 wait for receive buffers:** Cloud Platform performs internal action.
- 9 Allocate buffer(s):** Cloud Platform performs internal action.
- AAL executes receive operation:** Cloud Platform performs internal action.
- 10 execute preregistered callback function:** Cloud Platform returns to O-RAN.
- 11 freeBuffer:** O-RAN sends to Cloud Platform.
- 12 success/failure:** Cloud Platform returns to O-RAN.
**Notes:**
- If no buffers received return immediately. In Asynchronous mode with no callback receive API behaves in a poll mode manner.
- AAL executes receive operation.
Sequence diagram for Asynchronous Receive Buffer API between O-RAN and Cloud Platform.
## 5.4 AALI-C-App API details
### 5.4.1 Capabilities discovery and configuration
#### 5.4.1.1 initAal
Description: An AAL Application initializes the AAL Implementation.
Pre-conditions: AAL Application is started.
Triggers: Executed once by the AAL Application
Frequency: AAL Application Initialization time.
**Table 5.4.1.1-1: initAal operation**
| Operation | Direction |
|-----------|------------------------|
| initAal | AAL Application => AAL |
**Table 5.4.1.1-2: initAal Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------|-------------|----------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| lpu_identifiers | 1..N | List Values | M | Optional list provided by DMS to the AAL Application that identifies the O-Cloud Resources and associated attributes that the DMS has assigned to and can be used by the AAL Application |
| vendor_specific | 0..N | List Key/Value pairs | | List of vendor specific attributes provided by the AAL Application. The AAL Application can obtain these parameters via the DMS or through another mechanism. |
**Table 5.4.1.1-3: initAal Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|-----------------------------|-----------|-------------------------------------|
| status_of_operation | | Reference WG10 object model | M | Returns the status of the procedure |
#### 5.4.1.2 cleanupAal
Description: This function must be called to allow the AAL implementation release any internal resources that the AAL implementation has allocated during initAal. After this call no other AALI-C-App API calls may be made.
Pre-conditions: initAal has been executed.
Triggers: Executed once by the AAL Application
Frequency: AAL Application termination time.
**Table 5.4.1.2-1: cleanupAal Operation**
| Operation | Direction |
|-----------|-----------|
|-----------|-----------|
| | |
|------------|------------------------|
| cleanupAal | AAL Application => AAL |
|------------|------------------------|
**Table 5.4.1.2-2: cleanupAal Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------|-------------|-----------|-----------|-------------|
| NULL | 0 | | | |
**Table 5.4.1.2-3: cleanupAal Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|-----------------------------|-----------|-------------------------------------|
| status_of_operation | | Reference WG10 object model | M | Returns the status of the procedure |
#### 5.4.1.3 getAalLpuInfo
Description: An AAL Application queries the handle and capabilities of the AAL-LPU(s) assigned to the AAL Application. AAL-LPUs may provide different capabilities such as different AAL Profiles can be supported by the AAL-LPUs that includes different types of AAL-Profile-Instances and AAL-Profile-Queue(s). The aal-lpu-handle is unique between the AAL Application and the AAL-LPUs assigned to the AAL Application. The aal-lpu-handle is generated by the AAL Implementation.
Pre-conditions: AAL Application has at least one AAL-LPU assigned and available for use.
Triggers: On demand request from the AAL Application
Frequency: AAL Application Initialization time.
**Table 5.4.1.1-1: getAalLpuInfo operation**
| Operation | Direction |
|---------------|---------------------------|
| getAalLpuInfo | AAL => AAL Implementation |
**Table 5.4.1.1-2: getAalLpuInfo Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------|-------------|-----------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| aal_lpu_handle | 0 to 1 | | O | If supplied, the capabilities of only the AAL-LPU associated with the Handle is requested. If omitted, the capabilities of all the AAL-LPUs assigned to the AAL Application is requested. |
**Table 5.4.1.1-3: getAalLpuInfo Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|-----------------------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| aal-lpu-cap-struct | 0 to many | struct | O | Struct containing the aal-lpu-handle and the capabilities supported by this AAL-LPU including AAL Profile type(s) that are available to the calling AAL Application. |
| status_of_operation | | Reference WG10 object model | M | Returns the status of the procedure |
NOTE List of AAL Profile types to be defined, e.g. High-PHY. Types should also be versioned, e.g. High-PHY.V1
### 5.4.2 AALI-C-App Configuration Services
Before using AAL-Profile-Instance services the AAL Application must first create the AAL-Profile-Instance, then configure the AAL-Profile-Instance and the AAL-Profile-Queue(s).
#### 5.4.2.1 createAalProfileInstance
Description: The AAL Application creates an AAL-Profile-Instance on the AAL-LPU. The AAL-Profile-Instance is created based on the AAL Profile type that is requested by the AAL Application. The list of available AAL Profile type(s) is provided by the AALI in the getAalLpuInfo response. After successful creation, the AAL-Profile-Instance is in a 'in use, stopped' state. The AAL Application may now configure the AAL-Profile-Instance, AAL-Profile-Queue(s) and start the AAL-Profile-Instance.
This procedure may be repeated by the AAL Application in order to create multiple AAL-Profile-Instances, of the same or different AAL Profile types.
Pre-conditions: AAL Application has at least 1 AAL-LPU assigned and available for use. The AAL Profile type that is requested to be created is provided by the AAL-LPU (listed in the AAL-LPU-Capability struct of the getAalLpuInfo response operation).
Triggers: On demand request from the AAL Application
Frequency: Infrequent.
**Table 5.4.2.1-1: createAalProfileInstance Operator**
| Operation | Direction |
|--------------------------|---------------------------------------|
| createAalProfileInstance | AAL Application => AAL Implementation |
**Table 5.4.2.1-2: createAalProfileInstance Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------------|-------------|-----------|-----------|-----------------------------------------------------------------------------------------------------------------------|
| aal_lpu_handle | 1 | N/A | M | The Handle of the AAL-LPU to create the AAL-Profile instance on. |
| aal_profile_instance_type | 1 | tbd | M | The type (and version) of an AAL-Profile-Instance (returned in the getAalLpuInfo operation) to create on this AAL-LPU |
**Table 5.4.2.1-3: createAalProfileInstance Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------------------|-------------|-----------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Status | 1 | | M | Result of the createProfileInstance operation |
| aal_profile_instance_handle | 1 | | C | Handle of the AAL-Profile instance created in this create AAL-Profile-Instance Request.<br><br>This field is only present if the createProfileInstance operation is successful |
| aal_profile_instance_config | 1 | Struct | C | Structure containing the default settings of the AAL-Profile-Instance. This field is only present if the createProfileInstance operation is successful. |
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|--------------------------------------|-----------|-----------------------------------------------|
| Status | 1 | | M | Result of the createProfileInstance operation |
| status_of_operation | | Reference<br>WG10<br>object<br>model | M | Returns the status of the procedure |
#### 5.4.2.2 setAalProfileInstanceConfig
Description: The AAL Application configures the AAL-Profile-Instance on the AAL-LPU for a specific AAL Profile configuration for use by the AAL Application.
Pre-conditions: AAL Application has successfully created the AAL-LPU-Profile instance on the AAL-LPU. The AAL-Profile-Instance is not started.
Triggers: On demand request from the AAL Application
Frequency: Infrequent.
**Table 5.4.2.2-1: setAalProfileInstanceConfig Operation**
| Operation | Direction |
|--------------------------|---------------------------------------|
| setProfileInstanceConfig | AAL Application => AAL Implementation |
**Table 5.4.2.2-2: setAalProfileInstanceConfig Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------------------|-------------|-----------|-----------|-----------------------------------------------------------------------|
| aal_profile_instance_handle | 1 | N/A | M | The Handle of the AAL-Profile-Instance to be configured. |
| aal_profile_instance_config | 1 | struct | M | Structure containing the AAL-Profile-Instance configuration to apply. |
**Table 5.4.2.2-3: setAalProfileInstanceConfig Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|------------------------------------------------|-----------|-------------------------------------|
| status_of_operation | | <i>Reference<br/>WG10<br/>object<br/>model</i> | M | Returns the status of the procedure |
#### 5.4.2.3 deleteAalProfileInstance
Description: The AAL Application may delete the AAL-Profile-Instance when it no longer requires it. For example, if a cell is deleted from the O-DU by upper layers or the OAM system, the AAL-Profile-Instance resources used to offload that cell can be deleted. After deleting the AAL-Profile-Instance, that AAL-Profile-Instance is no longer usable by the AAL Application.
Pre-conditions: The AAL Application has successfully stopped the AAL-Profile-Instance.
Triggers: On demand request from the AAL Application
Frequency: Infrequent.
**Table 5.4.2.3-1: deleteAalProfileInstance Operation**
| Operation | Direction |
|--------------------------|---------------------------------------|
| deleteAalProfileInstance | AAL Application => AAL Implementation |
**Table 5.4.2.3-2: deleteAalProfileInstance Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------------------|-------------|-----------|-----------|---------------------------------------------------|
| aal_profile_instance_handle | 1 | N/A | M | The Handle of the AAL-Profile-Instance to delete. |
**Table 5.4.2.3-3: deleteAalProfileInstance Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|------------------------------------|-----------|-------------------------------------|
| status_of_operation | | <i>Reference WG10 object model</i> | M | Returns the status of the procedure |
#### 5.4.2.4 setAalProfileQueueConfig
NOTE: Use of AAL-Profile-Queue operations for user plane data transfer and buffer API operations needs to be clarified.
Description: The AAL Application configures the AAL-Profile-Queue on the AAL-Profile-Instance.
If no AAL-Profile-Queue Handle is included, this operation will create and configure a new AAL-Profile-Queue. The response will include the AAL-Profile-Queue Handle for the AAL-Profile-Queue. To add an AAL-Profile-Queue to an AAL-Profile-Instance, the AAL-Profile-Instance must be stopped by the AAL Application.
If an AAL-Profile-Queue Handle is supplied, the configuration of the AAL-Profile-Queue identified by the AAL-Profile-Queue Handle is modified with the supplied configuration. Any items already on the queue are deleted when this operation is called. The AAL-Profile-Queue must be in the stopped state.
Pre-conditions: AAL-Profile-Instance has already successfully been created in the AAL-LPU. The AAL Application has successfully configured the AAL-Profile-Instance. The AAL-Profile-Queue (if already existing) is in the stopped state. To add an AAL-Profile-Queue to an AAL-Profile-Instance, the AAL-Profile-Instance must be stopped by the AAL Application. To re-configure an existing AAL-Profile-Queue on an AAL-Profile-Instance, the AAL-Profile-Instance does not need to be stopped by the AAL Application.
Triggers: On demand request from the AAL Application
Frequency: Infrequent.
**Table 5.4.2.4-1: setAalProfileQueueConfig Operation**
| Operation | Direction |
|--------------------------|---------------------------------------|
| setAalProfileQueueConfig | AAL Application => AAL Implementation |
**Table 5.4.2.4-2: setAalProfileQueueConfig Input Parameter**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------------------|-------------|-----------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| aal-profile-instance-handle | 1 | | M | The Handle of the AAL-Profile-Instance |
| aal_profile_queue-handle | 1 | N/A | O | If this field is included, the operation is for an existing AAL-Profile-Queue.<br><br>If this field is omitted, a new AAL-Profile-Queue is being configured. |
| aal_profile_queue-config | 1 | struct | M | Structure containing the AAL-Profile-Queue configuration to apply. E.g.<br><br>Direction (Input or Output);<br><br>Max number of entries permitted.<br><br>Queue priority (relative to the other queues of the same direction associated with this AAL-Profile-Instance) |
**Table 5.4.2.4-2: setAalProfileQueueConfig Output Parameter**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|--------------------------|-------------|------------------------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------|
| status_of_operation | | <i>Reference WG10 object model</i> | M | Returns the status of the procedure |
| aal_profile_queue-handle | 0 to 1 | | C | If no AAL-Profile-Queue Handle was included in the request, a new AAL-Profile-Queue Handle is returned if the operation was successful. |
#### 5.4.2.5 getAalProfileQueueConfig
Description: The AAL Application may query the current AAL-Profile-Instance queue configuration.
Pre-conditions: AAL-Profile-Instance has already successfully been created in the AAL-LPU. The AAL Application has successfully created the AAL-Profile-Instance and the AAL-Profile-Queue.
Triggers: On demand request from the AAL Application
Frequency: N/A
**Table 5.4.2.5-1: getAalProfileQueueConfig Operation**
| Operation | Direction |
|--------------------------|---------------------------------------|
| getAalProfileQueueConfig | AAL Application => AAL Implementation |
**Table 5.4.2.5-2: getAalProfileQueueConfig Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|--------------------------|-------------|-----------|-----------|----------------------------------------------------|
| aal_profile_queue-handle | 1 | N/A | | The handle of the AAL-Profile-Queue to be queried. |
**Table 5.4.2.5-3: getAalProfileQueueConfig Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|--------------------------|-------------|------------------------------------|-----------|--------------------------------------------------------------------------|
| status_of_operation | | <i>Reference WG10 object model</i> | M | Returns the status of the procedure |
| aal_profile_queue_config | 1 | structure | C | On success the struct that contains the AAL-Profile-Queue configuration. |
#### 5.4.2.6 getAalProfileInstanceConfig
Description: The AAL Application may query the current configuration of the AAL-Profile-Instance.
Pre-conditions: AAL Application has successfully created the AAL-LPU-Profile instance on the AAL-LPU.
Triggers: On demand request from the AAL Application.
Frequency: Infrequent.
**Table 5.4.2.2-1: getAalProfileInstanceConfig Operation**
| Operation | Direction |
|-----------------------------|---------------------------------------|
| getAalProfileInstanceConfig | AAL Application => AAL Implementation |
**Table 5.4.2.2-2: getAalProfileInstanceConfig Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------------------|-------------|-----------|-----------|----------------------------------------------------------|
| aal_profile_instance_handle | 1 | N/A | M | The handle of the AAL-Profile-Instance to be configured. |
**Table 5.4.2.2-3: getAalProfileInstanceConfig Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------------------|-------------|------------------------------------|-----------|-----------------------------------------------------------------------|
| aal_profile_instance_config | 1 | struct | M | Structure containing the AAL-Profile-Instance configuration to apply. |
| status_of_operation | | <i>Reference WG10 object model</i> | M | Returns the status of the procedure |
### 5.4.3 AALI-C-App Transport Operations
#### 5.4.3.1 createBufferPool
Description: The createBufferPool operation shall support creation of N buffer pools ( $N \geq 1$ ) of a specific buffer type, with buffer read/write access to the AAL Application.
- The AAL Application shall have the flexibility to invoke the createBufferPool operation either one time, or multiple times, to request creation of buffer pool(s) with multiple buffer sizes.
- The AAL Application shall invoke the createBufferPool operation multiple times for creation of buffer pools of different buffer types.
- The AAL Application shall not assume buffers in created buffer pools to be in a specific memory state (e.g., zero 'ed buffer).
- Buffer pool(s) and buffers are sharable by AAL-LPU(s).
- FFS: support for inter-accelerator buffer pool sharing.
Pre-conditions: AAL Implementation is initialized.
Triggers: On demand request from the AAL Application
Frequency: No restriction
**Table 5.4.3.1-1: createBufferPool Operation**
| Operation | Direction |
|------------------|---------------------------------------|
| createBufferPool | AAL Application => AAL Implementation |
**Table 5.4.3.1-2: createBufferPool Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|------------------------|-------------|-----------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| number_of_buffer_pools | 1 | integer | M | Indicates the number of buffer pool(s) creation requested by the AAL Application |
| buffer_type | N | integer | M | Indicates the type(s) of content that can be placed in buffers allocated from the buffer pool(s).<br><br>AAL-Profile instances can share buffer pools of the same buffer type(s)<br><br>The buffer type values are identified within the AAL-Profile specification.<br><br>An empty list indicates that the buffer(s) within the buffer pool(s) do not have an intended type of content that can be placed in the buffer pool(s). |
| buffer_size | N | integer | M | Indicates the buffer size for each requested buffer pool<br><br>NOTE: |
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-------------------|-------------|-----------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| | | | | <ul style="list-style-type: none"> <li>AAL Application shall indicate N buffer sizes, when requesting for creation of N buffer pool(s) (<math>N \geq 1</math>) in a single createBufferPool Operation</li> </ul> |
| number_of_buffers | N | integer | M | Indicates the size of each buffer pool, i.e., number of buffers available in each pool upon creation<br><br>NOTE: <ul style="list-style-type: none"> <li>AAL Application shall indicate N buffer pool sizes, when requesting for creation of N buffer pool(s), (<math>N \geq 1</math>) in a single createBufferPool Operation</li> </ul> |
**Table 5.4.3.1-3: createBufferPool Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|--------------------------------------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| status_of_operation | 1 | <i>Reference<br/>WG10<br/>object model</i> | M | Returns the status of the procedure. Indicates the status of createBufferPool Operation execution (TRUE for success, FALSE for failure)<br><br>If FALSE: Returns failure code if the AAL Implementation does not support pre-created buffer pools. |
| buffer_pool_handle | N | opaque handle | M | For each buffer pool, a handle to the pool<br><br>NOTE: Each buffer_pool_handle is associated with a specific buffer_size<br><br>A NULL shall be returned if the status_of_operation is FALSE (failure) |
#### 5.4.3.2 allocBuffer
Description: The allocBuffer operation shall support allocation of a buffer either from pre-created buffer pool(s), or from memory that is not associated with a pre-created buffer pool.
Pre-conditions: If a non-NULL buffer\_pool\_handle is passed, the buffers are allocated from the buffer pool(s) created using the createBufferPool operation.
Triggers: On demand request from the AAL Application
Frequency: No restriction
**Table 5.4.3.2-1: allocBuffer Operation**
| Operation | Direction |
|-------------|---------------------------------------|
| allocBuffer | AAL Application => AAL Implementation |
**Table 5.4.3.2-2: allocBuffer Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|--------------------|-------------|---------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| buffer_pool_handle | 1 | opaque handle | M | A handle to a pre-created buffer pool generated using createBufferPool operation or a NULL handle. When a NULL handle is passed, the AAL Implementation shall not use memory that is part of a pre-created buffer pool. |
| message_size | 1 | integer | M | <p>Indicates message size (in bytes) for which the AAL Application is requesting buffer allocation</p> <p>NOTE:</p> <ul style="list-style-type: none"> <li>The AAL Application shall not use the allocated buffer for a message greater than the indicated message_size.</li> <li>Whether/how an AAL Implementation takes into consideration message_size in allocating the buffer is transparent to the AAL Application.</li> </ul> <p>When the value of the buffer_pool_handle is not NULL:</p> <ul style="list-style-type: none"> <li>The AAL Application shall request buffer allocation from a pre-created buffer pool with buffer_size <math>\geq</math> message_size > 0 <ul style="list-style-type: none"> <li>The AAL Application can indicate the message_size equal to the buffer_size associated with the buffer_pool_handle.</li> </ul> </li> <li>For optimal memory usage, AAL Application should indicate a buffer_pool_handle with associated buffer_size closest to the indicated memory size.</li> </ul> |
**Table 5.4.3.2-3: allocBuffer Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|------------------------------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| status_of_operation | 1 | <i>Reference WG10 object model</i> | M | <p>Returns the status of the procedure. Indicates the status of allocBuffer Operation execution (TRUE for success, FALSE for failure)</p> <p>NOTE: If the status of the operation is FALSE:</p> <ul style="list-style-type: none"> <li>Returns a failure code if the AAL Implementation requires buffers to be allocated from a pre-created buffer pool and the operation was invoked with buffer_pool_handle = NULL.</li> <li>Returns a failure code if the AAL Implementation does not support pre-created buffer pools and the operation was invoked with a buffer_pool_handle that is not NULL.</li> </ul> |
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|------------------|-------------|---------------|-----------|--------------------------------|
| | | | | |
| buffer_handle | 1 | opaque handle | M | Handle to the allocated buffer |
#### 5.4.3.3 getBufferAddr
Description: The getBufferAddr operation shall return address from buffer\_handle
Pre-conditions: The buffer\_handle is created using allocBuffer operation
Triggers: On demand request from the AAL Application
Frequency: No restriction
**Table 5.4.3.3-1: getBufferAddr Operation**
| Operation | Direction |
|---------------|---------------------------------------|
| getBufferAddr | AAL Application => AAL Implementation |
**Table 5.4.3.3-2: getBufferAddr Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------|-------------|---------------|-----------|--------------------------------------------------------|
| buffer_handle | 1 | opaque handle | M | buffer object handle returned by allocBuffer operation |
**Table 5.4.3.3-3: getBufferAddr Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|------------------------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------|
| status_of_operation | 1 | <i>Reference WG10 object model</i> | M | Returns the status of the procedure. |
| buffer_address | 1 | void * | M | Pointer that points to the starting virtual address of the buffer for the AAL Application to use. On error, buffer address will be NULL value. |
#### 5.4.3.4 getBufferSize
Description: The getBufferSize operation shall return the size of the buffer from buffer\_handle
Pre-conditions: buffer\_handle is created using allocBuffer operation
Triggers: On demand request from the AAL Application
Frequency: No restriction
**Table 5.4.3.4-1: getBufferSize Operation**
| Operation | Direction |
|-----------|-----------|
|-----------|-----------|
| | |
|---------------|---------------------------------------|
| getBufferSize | AAL Application => AAL Implementation |
|---------------|---------------------------------------|
**Table 5.4.3.4-2: getBufferSize Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------|-------------|---------------|-----------|--------------------------------------------------------|
| buffer_handle | 1 | opaque handle | M | buffer object handle returned by allocBuffer operation |
**Table 5.4.3.4-3: getBufferSize Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|------------------------------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------|
| status_of_operation | 1 | <i>Reference WG10 object model</i> | M | Returns the status of the procedure.<br><br>Indicates the status of <i>getBufferSize</i> operation execution (TRUE for success, FALSE for failure) |
| buffer_size | 1 | Integer | M | Size of the buffer |
#### 5.4.3.5 sendBuffer
Description: The sendBuffer operation shall support enqueueing of N buffer(s) ( $N \geq 1$ ) by the AAL Application. The AAL Application shall either retain buffer ownership in sendBuffer operation or indicate buffer ownership transfer. AAL Application shall indicate the synchronization mode ('synchronous' or 'asynchronous') in sendBuffer operation.
AAL Implementation shall support both modes of operation.
- For synchronous mode, the AAL Implementation, upon execution completion of sendBuffer operation, shall return the status of the sendBuffer operation
- For asynchronous mode, AAL Implementation shall return the status of sendBuffer operation execution, only if AAL Application preregisters for a callback; otherwise AAL Implementation is not expected to return the execution status of the sendBuffer operation
FFS: Mechanism of sending details of AAL-Profile specific parameters
Pre-conditions: Buffers are allocated through allocBuffer operation. At least one AAL-Profile-Instance is configured and started. At least one AAL-Profile-Queue is configured and started
Triggers: On demand request from the AAL Application
Frequency: No restriction
**Table 5.4.3.5-1: sendBuffer Operation**
| Operation | Direction |
|------------|---------------------------------------|
| sendBuffer | AAL Application => AAL Implementation |
**Table 5.4.3.5-2: sendBuffer Input Parameter**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------------------|-------------|---------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| number_of_buffers | 1 | integer | M | Indicates number of enqueued buffer(s) ( $N \ge 1$ ) |
| per_buffer_config | N | structure | M | Structure containing attributes corresponding to enqueued buffer(s). |
| > buffer_handle | 1 | opaque handle | M | Indicates the buffer(s) containing metadata and payload to be sent. |
| > buffer_free | 1 | integer | M | When "TRUE" or 1, the AAL Application transfers ownership of the buffer to the AAL Implementation, which is expected to free the buffer upon completion of the sendBuffer operation, for each enqueued buffer.<br><br>When "FALSE" or 0, the AAL Application retains the ownership of the buffer and the AAL Implementation shall not automatically free the buffer upon completion of the sendBuffer operation. |
| aal_profile_instance_handle | 1 | opaque handle | M | Indicates the AAL-Profile-Instance corresponding to the buffer payload(s) |
| aal_queue_handle | 1 | opaque handle | M | Indicates the AAL-Profile-Queue associated with the enqueued buffer(s) |
| synchronization_mode | 1 | integer | M | Indicates synchronous/asynchronous mode of operation |
**Table 5.4.3.5-3: sendBuffer Output Parameter**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|-------------------------------|-------------|------------------------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| status_of_operation | 1 | <i>Reference WG10 object model</i> | M | Returns the status of the procedure.<br><br>Indicates the status of sendBuffer operation execution (success or failure) in synchronous mode and in asynchronous mode with preregistered callback<br><br>FFS: Details of callback preregistration mechanism |
| number_of_buffers_transmitted | 1 | integer | M | Indicates the total number of successfully transmitted buffers |
| status_of_each_buffer | N | bool | O | Optionally, returns status of each buffer (success or failure) |
#### 5.4.3.6 receiveBuffer
Description: The receiveBuffer operation shall support dequeuing up to N buffer(s) ( $N \geq 1$ ) by the AAL Application. The AAL Application shall indicate the synchronization mode ('synchronous' or 'asynchronous') in the receiveBuffer operation.
AAL Implementation shall support both modes of the operation.
- For synchronous mode, the AAL Implementation, upon execution completion of receiveBuffer operation, shall return the status of the receiveBuffer operation
- For asynchronous mode, the AAL Implementation shall return the status of receiveBuffer operation execution, only if AAL Application preregisters for a callback; otherwise AAL Implementation is not expected to return the execution status of the receiveBuffer operation
Either the AAL Application, or the AAL Implementation shall allocate the receiving buffer(s) either from buffer pool(s) pre-created through createBufferPool operation or from memory not mapped to a pre-created buffer pool.
Pre-conditions: At least one AAL-Profile-Instance is configured and started. At least one AAL-Profile-Queue is configured and started
Triggers: On demand request from the AAL Application
Frequency: No restriction
**Table 5.4.3.6-1: receiveBuffer Operation**
| Operation | Direction |
|---------------|---------------------------------------|
| receiveBuffer | AAL Application => AAL Implementation |
**Table 5.4.3.6-2: receiveBuffer Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------------------|-------------|---------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| number_of_buffers | 1 | integer | M | Indicates maximum number of buffers ( $N \geq 1$ ) that can be dequeued by the AAL Application |
| buffer_handle | 0..N | opaque handle | M | Indicates dequeue buffer(s) allocated by the AAL Application.<br><br>If NULL, the AAL Implementation allocates the dequeue buffer(s) <ul style="list-style-type: none"> <li>The AAL Application shall not use the dequeue buffer(s) allocated by the AAL Implementation for any other subsequent send or receive operation</li> </ul> |
| aal_profile_instance_handle | 1 | opaque handle | M | Indicates the AAL-Profile-Instance corresponding to the dequeued buffer payloads |
| aal_queue_handle | 1 | opaque handle | M | Indicates the AAL-Profile-Queue associated with the dequeued buffers |
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|----------------------|-------------|-----------|-----------|------------------------------------------------------|
| synchronization_mode | 1 | integer | M | Indicates synchronous/asynchronous mode of operation |
**Table 5.4.3.6-3: receiveBuffer Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|----------------------------|-------------|--------------------------------------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| status_of_operation | 1 | <i>Reference<br/>WG10<br/>object model</i> | M | Returns the status of the procedure.<br><br>Indicates the status of receiveBuffer operation execution (success or failure) in synchronous mode and in asynchronous mode with preregistered callback<br><br>FFS: details of callback preregistration mechanism |
| number_of_received_buffers | 1 | integer | M | Indicates number of buffers (L) to be received by the AAL Application, which is < = maximum number of buffers (N) |
| buffer_handle | L | opaque handle | M | Indicates dequeue buffer(s) where from AAL Application retrieves the received data. |
| buffer_content_size | L | integer | O | Optionally, indicates the size (in bytes) of the contents of each received buffer |
#### 5.4.3.7 freeBuffer
Description: The freeBuffer operation shall free the buffer back to the buffer pool to which the buffer was allocated from.
- If the buffer is not freed in the sendBuffer operation (i.e., buffer\_free parameter is set to 0 or 'FALSE'), the freeBuffer operation shall free the buffer upon completion of the sendBuffer operation execution by the AAL Implementation.
Pre-conditions: The buffer\_handle is created using allocBuffer operation
Post-condition: Upon successful completion of the freeBuffer operation, the buffer\_handle is no longer usable by the AAL Application
Triggers: On demand request from the AAL Application
Frequency: No restriction
**Table 5.4.3.7-1: freeBuffer Operation**
| Operation | Direction |
|------------|---------------------------------------|
| freeBuffer | AAL Application => AAL Implementation |
**Table 5.4.3.7-2: freeBuffer Input Operation**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------|-------------|---------------|-----------|--------------------------------------------------------|
| buffer_handle | 1 | opaque handle | M | buffer object handle returned by allocBuffer operation |
**Table 5.4.3.7-3: freeBuffer Output Operation**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|------------------------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------|
| status_of_operation | 1 | <i>Reference WG10 object model</i> | M | Returns the status of the procedure.<br><br>Indicates the status of freeBuffer Operation execution (TRUE for success, FALSE for failure) |
#### 5.4.3.8 destroyBufferPool
Description: The destroyBufferPool operation shall support termination of buffer pool, which will make buffer\_handle(s) associated with the buffer pool unusable by the AAL Application.
Pre-condition: The buffer\_pool\_handle is created using createBufferPool operation
Trigger: On demand request from the AAL Application
Frequency: Infrequent
**Table 5.4.3.8-1: destroyBufferPool Operation**
| Operation | Direction |
|-------------------|---------------------------------------|
| destroyBufferPool | AAL Application => AAL Implementation |
**Table 5.4.3.8-2: destroyBufferPool Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|--------------------|-------------|---------------|-----------|---------------------------------------------|
| buffer_pool_handle | 1 | opaque handle | M | Indicates handle to pre-created buffer pool |
**Table 5.4.3.8-3: destroyBufferPool Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|------------------------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------|
| status_of_operation | 1 | <i>Reference WG10 object model</i> | M | Returns the status of the procedure.<br><br>Indicates the status of destroyBufferPool Operation execution (success or failure) |
### 5.4.4 AALI-C-App Administrative Operations
#### 5.4.4.1 startAalProfileInstance
Description: The AAL Application starts the AAL-Profile-Instance once it is ready to start operations.
Pre-conditions: AAL-LPU is started, AAL Application is successfully configured, AAL-Profile-Instance is configured. The AAL-Profile-Instance is in the stopped state.
On success, the AAL-Profile-Instance will be in the started state.
Triggers: On demand request from the AAL Application.
Frequency: Run time, infrequent.
**Table 5.4.4.1-1: startAalProfileInstance Operation**
| Operation | Direction |
|-------------------------|---------------------------------------|
| startAalProfileInstance | AAL Application => AAL Implementation |
**Table 5.4.4.1-2: startAalProfileInstance Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------------------|-------------|-----------|-----------|------------------------------------------------------|
| aal_profile_instance_handle | 1 | UUID | M | The identifier of the AAL-Profile-Instance to start. |
**Table 5.4.4.1-3: startAalProfileInstance Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|-----------------------------|-----------|-------------------------------------|
| status_of_operation | | Reference WG10 object model | M | Returns the status of the procedure |
#### 5.4.4.2 stopAalProfileInstance
Description: The AAL Application stops the AAL-Profile-Instance.
Pre-conditions: AAL-LPU is started, AAL Application is configured and started, the AAL-Profile-Instance is configured and started.
On success, the AAL-Profile-Instance will be in the stopped state.
Triggers: On demand request from the AAL Application.
Frequency: Run time, infrequent.
**Table 5.4.4.2-1: stopAalProfileInstance Operation**
| Operation | Direction |
|------------------------|---------------------------------------|
| stopAalProfileInstance | AAL Application => AAL Implementation |
**Table 5.4.4.2-2: stopAalProfileInstance Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------------------|-------------|-----------|-----------|-----------------------------------------------------|
| aal_profile_instance_handle | 1 | UUID | M | The identifier of the AAL-Profile-Instance to stop. |
**Table 5.4.4.2-3: stopAalProfileInstance Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|--------------------------------------|-----------|-------------------------------------|
| status_of_operation | | Reference<br>WG10<br>object<br>model | M | Returns the status of the procedure |
#### 5.4.4.3 startAalProfileQueue
Description: The AAL Application starts the AAL-Profile-Queue once it is ready to start operations.
Pre-conditions: AAL-LPU is started, AAL Application is successfully configured and started, AAL-Profile-Instance is configured and started, the AAL-Queue is configured and in stopped state.
Triggers: On demand request from the AAL Application.
Frequency: Run time.
**Table 5.4.4.3-1 startAalprofileQueue Operation**
| Operation | Direction |
|----------------------|---------------------------------------|
| startAalProfileQueue | AAL Application => AAL Implementation |
**Table 5.4.4.3-2: startAalprofileQueue Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|--------------------------|-------------|-----------|-----------|-----------------------------------------------------------------|
| aal-profile-queue-handle | 1 | N/A | | The handle or identification of the AAL-Profile_Queue to start. |
**Table 5.4.4.3-2: startAalprofileQueue Input Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|--------------------------------------|-----------|-------------------------------------|
| status_of_operation | | Reference<br>WG10<br>object<br>model | M | Returns the status of the procedure |
#### 5.4.4.4 stopAalProfileQueue
Description: The AAL Application stops the AAL-Profile\_Queue.
Pre-conditions: AAL-LPU is started, AAL Application has successfully configured the AAL-Profile-Instance, AAL-Profile-Instance is configured and started, the AAL-Queue is configured and in started state.
Triggers: On demand request from the AAL Application
Frequency: Run time
**Table 5.4.4.4-1 stopAalProfileQueue Operation**
| Operation | Direction |
|---------------------|---------------------------------------|
| stopAalProfileQueue | AAL Application => AAL Implementation |
**Table 5.4.4.4-2: stopAalProfileQueue Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|--------------------------|-------------|-----------|-----------|----------------------------------------------------------------|
| aal-profile-queue-handle | 1 | N/A | | The handle or identification of the AAL-Profile_Queue to stop. |
**Table 5.4.4.4-2: stopAalprofileQueue Input Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|-----------------------------|-----------|-------------------------------------|
| status_of_operation | | Reference WG10 object model | M | Returns the status of the procedure |
# Annex A (normative): Acceleration Capability Requirements
## A.1 Capability requirements used in the placement of an AAL Application to an AF
Table A.1-1 contains a list of acceleration capability requirements that are common across AAL implementations. These capability requirements are used by the AAL Application to identify their requirements for use of AFs and by the SMO and/or DMS when assigning the AAL Application with a selected AF.
**Table A.1-1: Acceleration Capability Requirements**
| Capability requirement name | Data Type/Description |
|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| aalProfileRequirement | <b>Data Type:</b> AalProfileRequirement<br><b>Description:</b> The capability requirement for expressing what AAL-Profile is applicable when assigning an AAL-Profile to an AAL-LPU. |
| hwAcceleratorRequirement | <b>Data Type:</b> HwAccelRequirement<br><b>Description:</b> The capability requirement for expressing what HW Accelerator is applicable when assigning an AAL-Profile to an AAL-LPU. |
| aalLpuRequirement | <b>Data Type:</b> AalLpuRequirement<br><b>Description:</b> The capability requirements applicable when assigning an AAL-Profile to an AAL-LPU. |
**Table A.1-2: Attributes for AalProfileRequirement**
| Attribute name | Data Type/Description |
|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| name | <b>Data Type:</b> string<br><b>Description:</b> The name of the AAL-Profile as defined in the corresponding AAL-Profile specification. |
| supportedVersions | <b>Data Type:</b> Array of string<br><b>Description:</b> The versions of the AAL-Profile that the AAL Application can use. The version syntax is consistent with the version of the corresponding AAL-Profile specification. |
| preferredVersion | <b>Data Type:</b> string |
| Attribute name | Data Type/Description |
|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| | <b>Description:</b> The preferred version of the AAL-Profile that the AAL Application can use. The version syntax is consistent with the version of the corresponding AAL-Profile specification. |
**Table A.1-3: Attributes for HwAccelRequirement**
| Attribute name | Data Type/Description |
|----------------|---------------------------------------------------------------------------------------------------------------------------------------|
| vendorName | <b>Data Type:</b> string<br><b>Description:</b> The HW Accelerator's vendor that is needed to support the AAL Application. |
| model | <b>Data Type:</b> string<br><b>Description:</b> The model of the HW Accelerator that is needed to support the AAL Application. |
| hwVersion | <b>Data Type:</b> string<br><b>Description:</b> hardware version of the HW Accelerator that is needed to support the AAL Application. |
**Table A.1-4: Attributes for AalLpuRequirement**
| Attribute name | Data Type/Description |
|----------------|------------------------------------------------------------------------------------------------------------------------------------------|
| aalIDriver | <b>Data Type:</b> string<br><b>Description:</b> The name of the AAL Implementation driver that is needed to support the AAL Application. |
# Annex (informative): Change History
| Date | Revision | Author | Description |
|-----------|----------|-----------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 2022.2.28 | 00.00.01 | VMware, Ericsson, Wind River, Nvidia, Marvell, AT&T, Orange, Qualcomm | Initial skeleton |
| 2022.3.18 | 00.00.02 | VMware | Incorporated 2 CRs:<br><br>Management Objects Model CR (VMWare)<br><br>Common API Requirements CR (VMWare) |
| 2022.3.25 | 00.00.03 | NVIDIA, Intel, VMware | Incorporated 4 CRs:<br><br>Transport abstraction (NVIDIA)<br><br>AALI-C-App APIs (Intel)<br><br>AALI-C-Mgmt Workflow CR (VMWare)<br><br>AALI-C-Mgmt APIs CR (VMWare) |
| 2022.3.28 | 01.00 | Padma Sudarsan<br>VMware | Spec for final approval |
| 2022.5.12 | 01.00.01 | VMware | Incorporate CR:<br><br>Align AAL Definitions and Acronyms (Ericsson) |
| 2022.6.10 | 01.00.02 | Padma Sudarsan<br>VMware | Incorporate 7 CRs<br><br>AAL Transport Buffer Operations (Marvell)<br><br>AAL Transport API Operations (Nvidia)<br><br>AAL Transport Abstraction Requirements (Nvidia)<br><br>AAL-LPU start/Stop (Ericsson)<br><br>AAL Common API Spec Alignment (VMware)<br><br>AAL Get Accel Info part 1 (VMware)<br><br>AAL Common API e2e lcm flow (VMware et al.) |
| 2022.7.15 | 01.00.03 | Padma Sudarsan<br>VMware | Editor changes: |
| | | | |
|------------|----------|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| | | | <p>Modified cover page, footer, copyright, and Annex Z per new template</p> <p>Incorporate CRs:</p> <p>AAL Common API AAL Application Operations (Ericsson)</p> <p>Editor Changes:</p> <p>Modify Naming Conventions for Operations/parameters</p> <p>Identify sections that are still in progress</p> |
| 2022.7.20 | 01.00.04 | Padma Sudarsan<br>VMware | <p>Incorporate CRs:</p> <p>AAL Get Accel Info part 2 (VMware et al)</p> <p>AAL Common API e2e lcm flow enhancement (Intel, VMware.)</p> <p>AAL App Init Sequence alignment (VMware)</p> <p>Buffer Pool Create Operation (Nvidia et al)</p> <p>Buffer Send Operation (Nvidia et al)</p> <p>Buffer Receive buffer pool destroy operation (Nvidia et al)</p> <p>Editor Changes:</p> <p>Modify Naming Conventions for Operations/parameters etc.</p> |
| 2022.7.21 | 01.00.05 | Padma Sudarsan<br>VMware | <p>Incorporate CRs:</p> <p>AAL-C-Transport Call flow (Nvidia et al)</p> |
| 2022.7.25 | 01.00.06 | Padma Sudarsan<br>VMware | <p>Incorporate CRs:</p> <p>AAL-C-Transport Call flow (Nvidia et al) update</p> <p>Editorial Cleanup</p> |
| 2022.11.07 | 02.00.01 | Padma Sudarsan<br>VMware | <p>Incorporate CRs:</p> <p>AAL Transport API-freeBuffer clarification (Nvidia)</p> <p>Transport Req. alignment with receiveBuffer and freeBuffer (Nvidia)</p> <p>Transport receives buffer Operation clarification (Nvidia)</p> <p>e2e lcm flow updates (VMware)</p> <p>Correct UML in AALI-C-App API Init Sequence (Ericsson)</p> <p>Add Detailed API Diagrams (Intel, Nvidia)</p> <p>Update allocBuffer (Qualcomm)</p> <p>Update createBufferPool (Qualcomm)</p> |
| | | | |
|------------|----------|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 2022.11.07 | 02.00.02 | Padma Sudarsan<br>VMware | Editorial corrections based on comments from the member companies. |
| 2022.12.05 | 03.00.01 | Padma Sudarsan<br>VMware | Incorporate Editorial corrections.<br><br>Editorial alignment of terminology (Qualcomm)<br><br>Fault management service with AALI-C-Mgmt (Qualcomm, VMware, Ericsson) |
| 2023.1.11 | 03.00.02 | Padma Sudarsan<br>VMware | Incorporate Editorial corrections |
| 2023.2.1 | 03.00.03 | Padma Sudarsan<br>VMware | Incorporate CRs:<br><br>Common API Mgmt Requirement Clarification (Ericsson)<br><br>AAL-AALI-C-MGMT uploadBootImage Removal (Ericsson)<br><br>AAL-Common-API-03.00-Add-Inv-Sub-Not (Qualcomm) |
| 2023.3.11 | 03.00.04 | Padma Sudarsan<br>VMware | Incorporate CRs:<br><br>CR 0027 AAL Common API Updates from F2F (Qualcomm)<br><br>Incorporate Editorial corrections |
| 2023.3.17 | 03.00.05 | Padma Sudarsan<br>VMware | Incorporate Editorial corrections |
| 2023.4.18 | 04.00.01 | Padma Sudarsan<br>VMware | Incorporate Editorial corrections |
| 2023.6.20 | 04.00.02 | Padma Sudarsan<br>VMware | Incorporated the following CRs:<br><br>QCM: Update description in setAalAccelConfig and vendor specific attribute in set and get<br><br>INT: Fix missing AALI-C-App Init API<br><br>INT: AAL Common: Fix and update AALI-C-App State diagram<br><br>QCM: AAL Common: AAL IM Diagrams<br><br>QCM: AAL Common: AAL IM Management Definitions<br><br>QCM: AAL Common: AAL IM App Definitions<br><br>VMW: AAL Common: Changing Arch reference |
| 2023.6.28 | 04.00.03 | Padma Sudarsan<br>VMware | Incorporated the following CRs:<br><br>QCM: AAL Common Fix AAL IM Namespace |
| 2023.7.21 | 04.00.04 | Padma Sudarsan<br>VMware | Incorporated editorial comment |
| 2023.9.14 | 05.00.01 | Padma Sudarsan<br>VMware | Incorporated the following CRs: |
| | | | |
|-----------|----------|-------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| | | | <p>NOK: Clarification on AALI-C-Mgmt Inventory Notification Parameters</p> <p>WNDR: AALI-C-Mgmt HAM registration</p> <p>Incorporate Editorial comments</p> |
| 2023.11.7 | 05.00.02 | <p>Padma Sudarsan</p> <p>VMware</p> | <p>Incorporate the following CRs.</p> <p>QCM: Remove reference to Alarm Dictionary</p> <p>QCM: Add HAM IM State</p> <p>QCM: AAL Common Add Capabilities</p> <p>QCM: Add HAM IM</p> <p>QCM: Fix DMS AAL Scenarios Requirement</p> <p>Incorporate Editorial comments.</p> |
| 2024-1-22 | 06.00.01 | <p>Padma Sudarsan</p> <p>VMware by Broadcom</p> | <p>Incorporate the following CRs:</p> <p>DCM-2023.10.24-WG6-commonAPI__CR001_scope_overview_v03</p> <p>QCM-2023.12.01-WG6-CR-0052-Common-API-Add-aalLpuConfig attribute to LPU</p> <p>QCM-2023.12.11-WG6-CR-0055-Common-API-Add-LPU-HW-Accel-Conditions</p> <p>QCM-2023.12.11-WG6-CR-0058-Common-API-Remove-PM-Dictionary</p> <p>QCM-2023.12.21-WG6-CR-0049-Common-API-Add-Capability-Advertisement</p> <p>QCM-2023.12.21-WG6-CR-0056-Common-API-Identify-Common-Requirements</p> <p>QCM-2023.11.30-WG6-CR-0051-Common-API-Remove_OCloud_Resource_Ref</p> |
| 2024-1-22 | 06.00.02 | <p>Padma Sudarsan</p> <p>VMware by Broadcom</p> | <p>Incorporate the following CRs:</p> <p>NOK-2023.10.11-WG6-CR0083-AAL-Common-HAM_IM v00.06</p> <p>DCM-2023.01.19-WG6-commonAPI__CR002_HAM_func_requirements_v06</p> <p>DCM-2023.10.24-WG6-commonAPI__CR003_c-mgmt requirements_v04</p> <p>NOK-2023.12.11-WG6-CR-AAL Common API Mgmt_requirement_v03</p> <p>DCM-2024.01.22-WG6-commonAPI__CR007_transport_abstraction framework_v1</p> <p>ERI-2024.1.18-WG6-CR-0044-AAL Common API UUID definition and reference_v3</p> |
| | | | |
|-----------|----------|--------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| | | | ERI-2024.1.23-WG6-CR-0045-AAL Common API URI reference and acronym_v4 |
| 2024-3-17 | 06.00.03 | Padma Sudarsan<br>VMware by Broadcom | DCM-2023.10.24-WG6-commonAPI__CR003_c-mgmt requirements_v05<br><br>ERI - 20240110-WG6-CR-0041-AAL Common-API - Removal of AALI-C-App requirements for interaction with DMS v04<br><br>ERI-2024.1.18-WG6-CR-0043-AAL Common API AAL resource identifier requirements_v7 |
| 2024-3-19 | 06.00.04 | Padma Sudarsan<br>VMware by Broadcom | Editorial updates |
| 2024-4-18 | 07.00.01 | Padma Sudarsan<br>VMware by Broadcom | Incorporate CR<br><br>ERI-2024.04.05-WG6-CR-0047-AAL Common API Re-add AALI-C-App Operations section accidentally removed in version 01.03 v2<br><br>Editorial changes |
| 2024-7-5 | 07.00.02 | Padma Sudarsan<br>VMware by Broadcom | Incorporate CR<br><br>NOK-2024.04.08-WG6-CR0112-AAL_CommonAPI-EditorialRemovalOfDuplicateText<br><br>QCM-2024.04.10-WG6-AAL-Common-CR-0063-Update-IM-Namespace<br><br>ERI-2024.04.05-WG6-CR-0048-AAL Common API Update ALI-C-App State Diagram v4 |
# History
| Date | Revision | Description |
|------------|----------|---------------------------------|
| 2022.03.28 | 01.00 | Published from version 00.00.03 |
| 2022.08.01 | 02.00 | Published from version 01.00.06 |
| 2022.11.21 | 03.00 | Published from version 02.00.02 |
| 2023.03.27 | 04.00 | Published from version 03.00.05 |
| 2023.07.31 | 05.00 | Published from version 04.00.04 |
| 2023.11.27 | 06.00 | Published from version 05.00.02 |
| 2024.4.10 | 07.00 | Published from version 06.00.04 |
| 2024.7.31 | 08.00 | Published from version 07.00.02 | |