summaryrefslogtreecommitdiffstats
path: root/c-user/interrupt/directives.rst
blob: 2d7dccf08ab7a273a2521b7b81d67ddb03ba4b1c (plain) (blame)
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
.. SPDX-License-Identifier: CC-BY-SA-4.0

.. Copyright (C) 2008, 2021 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)

.. This file is part of the RTEMS quality process and was automatically
.. generated.  If you find something that needs to be fixed or
.. worded better please post a report or patch to an RTEMS mailing list
.. or raise a bug report:
..
.. https://www.rtems.org/bugs.html
..
.. For information on updating and regenerating please refer to the How-To
.. section in the Software Requirements Engineering chapter of the
.. RTEMS Software Engineering manual.  The manual is provided as a part of
.. a release.  For development sources please refer to the online
.. documentation at:
..
.. https://docs.rtems.org

.. _InterruptManagerDirectives:

Directives
==========

This section details the directives of the Interrupt Manager. A subsection is
dedicated to each of this manager's directives and lists the calling sequence,
parameters, description, return values, and notes of the directive.

.. Generated from spec:/rtems/intr/if/catch

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_catch()
.. index:: establish an ISR
.. index:: install an ISR

.. _InterfaceRtemsInterruptCatch:

rtems_interrupt_catch()
-----------------------

Establishes an interrupt service routine.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_interrupt_catch(
      rtems_isr_entry     new_isr_handler,
      rtems_vector_number vector,
      rtems_isr_entry    *old_isr_handler
    );

.. rubric:: PARAMETERS:

``new_isr_handler``
    This parameter is the new interrupt service routine.

``vector``
    This parameter is the interrupt vector number.

``old_isr_handler``
    This parameter is the pointer to an :c:type:`rtems_isr_entry` object.  When
    the directive call is successful, the previous interrupt service routine
    established for this interrupt vector will be stored in this object.

.. rubric:: DESCRIPTION:

This directive establishes an interrupt service routine (ISR) for the interrupt
specified by the ``vector`` number.  The ``new_isr_handler`` parameter
specifies the entry point of the ISR.  The entry point of the previous ISR for
the specified vector is returned in ``old_isr_handler``.

To release an interrupt vector, pass the old handler's address obtained when
the vector was first capture.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_NUMBER`
    The interrupt vector number was illegal.

:c:macro:`RTEMS_INVALID_ADDRESS`
    The ``new_isr_handler`` parameter was `NULL
    <https://en.cppreference.com/w/c/types/NULL>`_.

:c:macro:`RTEMS_INVALID_ADDRESS`
    The ``old_isr_handler`` parameter was `NULL
    <https://en.cppreference.com/w/c/types/NULL>`_.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within interrupt context.

* The directive may be called from within device driver initialization context.

* The directive may be called from within task context.

* The directive will not cause the calling task to be preempted.

* The directive is only available where the :term:`target architecture` support
  enabled simple vectored interrupts.

.. Generated from spec:/rtems/intr/if/disable

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_disable()
.. index:: disable interrupts

.. _InterfaceRtemsInterruptDisable:

rtems_interrupt_disable()
-------------------------

Disables the maskable interrupts on the current processor.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    #define rtems_interrupt_disable( isr_cookie )

.. rubric:: PARAMETERS:

``isr_cookie``
    This parameter is a variable of type :c:type:`rtems_interrupt_level` which
    will be used to save the previous interrupt level.

.. rubric:: DESCRIPTION:

This directive disables all maskable interrupts on the current processor and
returns the previous interrupt level in ``isr_cookie``.

.. rubric:: NOTES:

A later invocation of the :ref:`InterfaceRtemsInterruptEnable` directive should
be used to restore the previous interrupt level.

This directive is implemented as a macro which sets the ``isr_cookie``
parameter.

.. code-block:: c
    :linenos:

    #include <rtems.h>

    void local_critical_section( void )
    {
      rtems_interrupt_level level;

      // Please note that the rtems_interrupt_disable() is a macro.  The
      // previous interrupt level (before the maskable interrupts are
      // disabled) is returned here in the level macro parameter.  This
      // would be wrong:
      //
      // rtems_interrupt_disable( &level );
      rtems_interrupt_disable( level );

      // Here is the critical section: maskable interrupts are disabled

      {
        rtems_interrupt_level nested_level;

        rtems_interrupt_disable( nested_level );

        // Here is a nested critical section

        rtems_interrupt_enable( nested_level );
      }

      // Maskable interrupts are still disabled

      rtems_interrupt_enable( level );
    }

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within any runtime context.

* The directive will not cause the calling task to be preempted.

* Where the system was built with SMP support enabled, the directive is not
  available.  Its use will result in compiler warnings and linker errors.  The
  :ref:`InterfaceRtemsInterruptLocalDisable` and
  :ref:`InterfaceRtemsInterruptLocalEnable` directives are available in all
  build configurations.

.. Generated from spec:/rtems/intr/if/enable

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_enable()
.. index:: enable interrupts
.. index:: restore interrupt level

.. _InterfaceRtemsInterruptEnable:

rtems_interrupt_enable()
------------------------

Restores the previous interrupt level on the current processor.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    #define rtems_interrupt_enable( isr_cookie )

.. rubric:: PARAMETERS:

``isr_cookie``
    This parameter is the previous interrupt level to restore.  The value must
    be obtained by a previous call to :ref:`InterfaceRtemsInterruptDisable` or
    :ref:`InterfaceRtemsInterruptFlash`.

.. rubric:: DESCRIPTION:

This directive restores the interrupt level specified by ``isr_cookie`` on the
current processor.

.. rubric:: NOTES:

The ``isr_cookie`` parameter value must be obtained by a previous call to
:ref:`InterfaceRtemsInterruptDisable` or :ref:`InterfaceRtemsInterruptFlash`.
Using an otherwise obtained value is undefined behaviour.

This directive is unsuitable to enable particular interrupt sources, for
example in an interrupt controller.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within any runtime context.

* The directive will not cause the calling task to be preempted.

* While at least one maskable interrupt is pending, when the directive enables
  maskable interrupts, the pending interrupts are immediately serviced.  The
  interrupt service routines may unblock higher priority tasks which may
  preempt the calling task.

* Where the system was built with SMP support enabled, the directive is not
  available.  Its use will result in compiler warnings and linker errors.  The
  :ref:`InterfaceRtemsInterruptLocalDisable` and
  :ref:`InterfaceRtemsInterruptLocalEnable` directives are available in all
  build configurations.

.. Generated from spec:/rtems/intr/if/flash

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_flash()
.. index:: flash interrupts

.. _InterfaceRtemsInterruptFlash:

rtems_interrupt_flash()
-----------------------

Flashes interrupts on the current processor.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    #define rtems_interrupt_flash( isr_cookie )

.. rubric:: PARAMETERS:

``isr_cookie``
    This parameter is the previous interrupt level.

.. rubric:: DESCRIPTION:

This directive is functionally equivalent to a calling
:ref:`InterfaceRtemsInterruptEnable` immediately followed by a
:ref:`InterfaceRtemsInterruptDisable`.  On some architectures it is possible to
provide an optimized implementation for this sequence.

.. rubric:: NOTES:

The ``isr_cookie`` parameter value must be obtained by a previous call to
:ref:`InterfaceRtemsInterruptDisable` or :ref:`InterfaceRtemsInterruptFlash`.
Using an otherwise obtained value is undefined behaviour.

Historically, the interrupt flash directive was heavily used in the operating
system implementation.  However, this is no longer the case.  The interrupt
flash directive is provided for backward compatibility reasons.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within any runtime context.

* The directive will not cause the calling task to be preempted.

* Where the system was built with SMP support enabled, the directive is not
  available.  Its use will result in compiler warnings and linker errors.  The
  :ref:`InterfaceRtemsInterruptLocalDisable` and
  :ref:`InterfaceRtemsInterruptLocalEnable` directives are available in all
  build configurations.

.. Generated from spec:/rtems/intr/if/local-disable

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_local_disable()
.. index:: disable interrupts

.. _InterfaceRtemsInterruptLocalDisable:

rtems_interrupt_local_disable()
-------------------------------

Disables the maskable interrupts on the current processor.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    #define rtems_interrupt_local_disable( isr_cookie )

.. rubric:: PARAMETERS:

``isr_cookie``
    This parameter is a variable of type :c:type:`rtems_interrupt_level` which
    will be used to save the previous interrupt level.

.. rubric:: DESCRIPTION:

This directive disables all maskable interrupts on the current processor and
returns the previous interrupt level in ``isr_cookie``.

.. rubric:: NOTES:

A later invocation of the :ref:`InterfaceRtemsInterruptLocalEnable` directive
should be used to restore the previous interrupt level.

This directive is implemented as a macro which sets the ``isr_cookie``
parameter.

Where the system was built with SMP support enabled, this will not ensure
system wide mutual exclusion.  Use interrupt locks instead, see
:ref:`InterfaceRtemsInterruptLockAcquire`.  Interrupt disabled critical
sections may be used to access processor-specific data structures or disable
thread dispatching.

.. code-block:: c
    :linenos:

    #include <rtems.h>

    void local_critical_section( void )
    {
      rtems_interrupt_level level;

      // Please note that the rtems_interrupt_local_disable() is a macro.
      // The previous interrupt level (before the maskable interrupts are
      // disabled) is returned here in the level macro parameter.  This would
      // be wrong:
      //
      // rtems_interrupt_local_disable( &level );
      rtems_interrupt_local_disable( level );

      // Here is the critical section: maskable interrupts are disabled

      {
        rtems_interrupt_level nested_level;

        rtems_interrupt_local_disable( nested_level );

        // Here is a nested critical section

        rtems_interrupt_local_enable( nested_level );
      }

      // Maskable interrupts are still disabled

      rtems_interrupt_local_enable( level );
    }

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within any runtime context.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/intr/if/local-enable

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_local_enable()
.. index:: enable interrupts
.. index:: restore interrupt level

.. _InterfaceRtemsInterruptLocalEnable:

rtems_interrupt_local_enable()
------------------------------

Restores the previous interrupt level on the current processor.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    #define rtems_interrupt_local_enable( isr_cookie )

.. rubric:: PARAMETERS:

``isr_cookie``
    This parameter is the previous interrupt level to restore.  The value must
    be obtained by a previous call to
    :ref:`InterfaceRtemsInterruptLocalDisable`.

.. rubric:: DESCRIPTION:

This directive restores the interrupt level specified by ``isr_cookie`` on the
current processor.

.. rubric:: NOTES:

The ``isr_cookie`` parameter value must be obtained by a previous call to
:ref:`InterfaceRtemsInterruptLocalDisable`.  Using an otherwise obtained value
is undefined behaviour.

This directive is unsuitable to enable particular interrupt sources, for
example in an interrupt controller.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within any runtime context.

* The directive will not cause the calling task to be preempted.

* While at least one maskable interrupt is pending, when the directive enables
  maskable interrupts, the pending interrupts are immediately serviced.  The
  interrupt service routines may unblock higher priority tasks which may
  preempt the calling task.

.. Generated from spec:/rtems/intr/if/is-in-progress

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_is_in_progress()
.. index:: is interrupt in progress

.. _InterfaceRtemsInterruptIsInProgress:

rtems_interrupt_is_in_progress()
--------------------------------

Checks if an ISR is in progress on the current processor.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    #define rtems_interrupt_is_in_progress()

.. rubric:: DESCRIPTION:

This directive returns ``true``, if the current processor is currently
servicing an interrupt, and ``false`` otherwise.  A return value of ``true``
indicates that the caller is an interrupt service routine, **not** a task. The
directives available to an interrupt service routine are restricted.

.. rubric:: RETURN VALUES:

Returns true, if the current processor is currently servicing an interrupt,
otherwise false.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within any runtime context.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/intr/if/lock-initialize

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_lock_initialize()

.. _InterfaceRtemsInterruptLockInitialize:

rtems_interrupt_lock_initialize()
---------------------------------

Initializes the ISR lock.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    #define rtems_interrupt_lock_initialize( lock, name )

.. rubric:: PARAMETERS:

``lock``
    This parameter is the ISR lock to initialize.

``name``
    This parameter is the ISR lock name.  It shall be a string.  The name is
    only used where the system was built with profiling support enabled.

.. rubric:: NOTES:

ISR locks may also be statically defined by
:ref:`InterfaceRTEMSINTERRUPTLOCKDEFINE` or statically initialized by
:ref:`InterfaceRTEMSINTERRUPTLOCKINITIALIZER`.

.. Generated from spec:/rtems/intr/if/lock-destroy

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_lock_destroy()

.. _InterfaceRtemsInterruptLockDestroy:

rtems_interrupt_lock_destroy()
------------------------------

Destroys the ISR lock.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    #define rtems_interrupt_lock_destroy( lock )

.. rubric:: PARAMETERS:

``lock``
    This parameter is the ISR lock to destroy.

.. rubric:: NOTES:

The lock must have been dynamically initialized by
:ref:`InterfaceRtemsInterruptLockInitialize`, statically defined by
:ref:`InterfaceRTEMSINTERRUPTLOCKDEFINE`, or statically initialized by
:ref:`InterfaceRTEMSINTERRUPTLOCKINITIALIZER`.

Concurrent lock use during the destruction or concurrent destruction leads to
unpredictable results.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within any runtime context.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/intr/if/lock-acquire

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_lock_acquire()

.. _InterfaceRtemsInterruptLockAcquire:

rtems_interrupt_lock_acquire()
------------------------------

Acquires the ISR lock.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    #define rtems_interrupt_lock_acquire( lock, lock_context )

.. rubric:: PARAMETERS:

``lock``
    This parameter is the ISR lock to acquire.

``lock_context``
    This parameter is the ISR lock context.  This lock context shall be used to
    release the lock by calling :ref:`InterfaceRtemsInterruptLockRelease`.

.. rubric:: DESCRIPTION:

This directive acquires the ISR lock specified by ``lock`` using the lock
context provided by ``lock_context``.  Maskable interrupts will be disabled on
the current processor.

.. rubric:: NOTES:

A caller-specific lock context shall be provided for each acquire/release pair,
for example an automatic variable.

Where the system was built with SMP support enabled, this directive acquires an
SMP lock.  An attempt to recursively acquire the lock may result in an infinite
loop with maskable interrupts disabled.

This directive establishes a non-preemptive critical section with system wide
mutual exclusion on the local node in all RTEMS build configurations.

.. code-block:: c
    :linenos:

    #include <rtems.h>

    void critical_section( rtems_interrupt_lock *lock )
    {
      rtems_interrupt_lock_context lock_context;

      rtems_interrupt_lock_acquire( lock, &lock_context );

      // Here is the critical section.  Maskable interrupts are disabled.
      // Where the system was built with SMP support enabled, this section
      // is protected by an SMP lock.

      rtems_interrupt_lock_release( lock, &lock_context );
    }

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within any runtime context.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/intr/if/lock-release

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_lock_release()

.. _InterfaceRtemsInterruptLockRelease:

rtems_interrupt_lock_release()
------------------------------

Releases the ISR lock.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    #define rtems_interrupt_lock_release( lock, lock_context )

.. rubric:: PARAMETERS:

``lock``
    This parameter is the ISR lock to release.

``lock_context``
    This parameter is the ISR lock context.  This lock context shall have been
    used to acquire the lock by calling
    :ref:`InterfaceRtemsInterruptLockAcquire`.

.. rubric:: DESCRIPTION:

This directive releases the ISR lock specified by ``lock`` using the lock
context provided by ``lock_context``.  The previous interrupt level will be
restored on the current processor.

.. rubric:: NOTES:

The lock context shall be the one used to acquire the lock, otherwise the
result is unpredictable.

Where the system was built with SMP support enabled, this directive releases an
SMP lock.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within any runtime context.

* The directive will not cause the calling task to be preempted.

* While at least one maskable interrupt is pending, when the directive enables
  maskable interrupts, the pending interrupts are immediately serviced.  The
  interrupt service routines may unblock higher priority tasks which may
  preempt the calling task.

.. Generated from spec:/rtems/intr/if/lock-acquire-isr

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_lock_acquire_isr()

.. _InterfaceRtemsInterruptLockAcquireIsr:

rtems_interrupt_lock_acquire_isr()
----------------------------------

Acquires the ISR lock from within an ISR.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    #define rtems_interrupt_lock_acquire_isr( lock, lock_context )

.. rubric:: PARAMETERS:

``lock``
    This parameter is the ISR lock to acquire within an ISR.

``lock_context``
    This parameter is the ISR lock context.  This lock context shall be used to
    release the lock by calling :ref:`InterfaceRtemsInterruptLockReleaseIsr`.

.. rubric:: DESCRIPTION:

This directive acquires the ISR lock specified by ``lock`` using the lock
context provided by ``lock_context``.  The interrupt level will remain
unchanged.

.. rubric:: NOTES:

A caller-specific lock context shall be provided for each acquire/release pair,
for example an automatic variable.

Where the system was built with SMP support enabled, this directive acquires an
SMP lock.  An attempt to recursively acquire the lock may result in an infinite
loop.

This directive is intended for device drivers and should be called from the
corresponding interrupt service routine.

In case the corresponding interrupt service routine can be interrupted by
higher priority interrupts and these interrupts enter the critical section
protected by this lock, then the result is unpredictable.  This directive may
be used under specific circumstances as an optimization.  In doubt, use
:ref:`InterfaceRtemsInterruptLockAcquire` and
:ref:`InterfaceRtemsInterruptLockRelease`.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within any runtime context.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/intr/if/lock-release-isr

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_lock_release_isr()

.. _InterfaceRtemsInterruptLockReleaseIsr:

rtems_interrupt_lock_release_isr()
----------------------------------

Releases the ISR lock from within an ISR.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    #define rtems_interrupt_lock_release_isr( lock, lock_context )

.. rubric:: PARAMETERS:

``lock``
    This parameter is the ISR lock to release within an ISR.

``lock_context``
    This parameter is the ISR lock context.  This lock context shall have been
    used to acquire the lock by calling
    :ref:`InterfaceRtemsInterruptLockAcquireIsr`.

.. rubric:: DESCRIPTION:

This directive releases the ISR lock specified by ``lock`` using the lock
context provided by ``lock_context``.  The interrupt level will remain
unchanged.

.. rubric:: NOTES:

The lock context shall be the one used to acquire the lock, otherwise the
result is unpredictable.

Where the system was built with SMP support enabled, this directive releases an
SMP lock.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within any runtime context.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/intr/if/lock-isr-disable

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_lock_interrupt_disable()

.. _InterfaceRtemsInterruptLockInterruptDisable:

rtems_interrupt_lock_interrupt_disable()
----------------------------------------

Disables maskable interrupts on the current processor.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    #define rtems_interrupt_lock_interrupt_disable( lock_context )

.. rubric:: PARAMETERS:

``lock_context``
    This parameter is the ISR lock context for an acquire and release pair.

.. rubric:: DESCRIPTION:

This directive disables maskable interrupts on the current processor and stores
the previous interrupt level in ``lock_context``.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within any runtime context.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/intr/if/lock-declare

.. raw:: latex

    \clearpage

.. index:: RTEMS_INTERRUPT_LOCK_DECLARE()

.. _InterfaceRTEMSINTERRUPTLOCKDECLARE:

RTEMS_INTERRUPT_LOCK_DECLARE()
------------------------------

Declares an ISR lock object.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    #define RTEMS_INTERRUPT_LOCK_DECLARE( specifier, designator )

.. rubric:: PARAMETERS:

``specifier``
    This parameter is the storage-class specifier for the ISR lock to declare,
    for example ``extern`` or ``static``.

``designator``
    This parameter is the ISR lock object designator.

.. rubric:: NOTES:

Do not add a ";" after this macro.

.. Generated from spec:/rtems/intr/if/lock-define

.. raw:: latex

    \clearpage

.. index:: RTEMS_INTERRUPT_LOCK_DEFINE()

.. _InterfaceRTEMSINTERRUPTLOCKDEFINE:

RTEMS_INTERRUPT_LOCK_DEFINE()
-----------------------------

Defines an ISR lock object.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    #define RTEMS_INTERRUPT_LOCK_DEFINE( specifier, designator, name )

.. rubric:: PARAMETERS:

``specifier``
    This parameter is the storage-class specifier for the ISR lock to declare,
    for example ``extern`` or ``static``.

``designator``
    This parameter is the ISR lock object designator.

``name``
    This parameter is the ISR lock name.  It shall be a string.  The name is
    only used where the system was built with profiling support enabled.

.. rubric:: NOTES:

Do not add a ";" after this macro.

ISR locks may also be dynamically initialized by
:ref:`InterfaceRtemsInterruptLockInitialize` or statically by
:ref:`InterfaceRTEMSINTERRUPTLOCKINITIALIZER`.

.. Generated from spec:/rtems/intr/if/lock-initializer

.. raw:: latex

    \clearpage

.. index:: RTEMS_INTERRUPT_LOCK_INITIALIZER()

.. _InterfaceRTEMSINTERRUPTLOCKINITIALIZER:

RTEMS_INTERRUPT_LOCK_INITIALIZER()
----------------------------------

Statically initializes an ISR lock object.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    #define RTEMS_INTERRUPT_LOCK_INITIALIZER( name )

.. rubric:: PARAMETERS:

``name``
    This parameter is the ISR lock name.  It shall be a string.  The name is
    only used where the system was built with profiling support enabled.

.. rubric:: NOTES:

ISR locks may also be dynamically initialized by
:ref:`InterfaceRtemsInterruptLockInitialize` or statically defined by
:ref:`InterfaceRTEMSINTERRUPTLOCKDEFINE`.

.. Generated from spec:/rtems/intr/if/lock-member

.. raw:: latex

    \clearpage

.. index:: RTEMS_INTERRUPT_LOCK_MEMBER()

.. _InterfaceRTEMSINTERRUPTLOCKMEMBER:

RTEMS_INTERRUPT_LOCK_MEMBER()
-----------------------------

Defines an ISR lock member.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    #define RTEMS_INTERRUPT_LOCK_MEMBER( designator )

.. rubric:: PARAMETERS:

``designator``
    This parameter is the ISR lock member designator.

.. rubric:: NOTES:

Do not add a ";" after this macro.

.. Generated from spec:/rtems/intr/if/lock-reference

.. raw:: latex

    \clearpage

.. index:: RTEMS_INTERRUPT_LOCK_REFERENCE()

.. _InterfaceRTEMSINTERRUPTLOCKREFERENCE:

RTEMS_INTERRUPT_LOCK_REFERENCE()
--------------------------------

Defines an ISR lock object reference.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    #define RTEMS_INTERRUPT_LOCK_REFERENCE( designator, target )

.. rubric:: PARAMETERS:

``designator``
    This parameter is the ISR lock reference designator.

``target``
    This parameter is the target object to reference.

.. rubric:: NOTES:

Do not add a ";" after this macro.

.. Generated from spec:/rtems/intr/if/entry-initializer

.. raw:: latex

    \clearpage

.. index:: RTEMS_INTERRUPT_ENTRY_INITIALIZER()

.. _InterfaceRTEMSINTERRUPTENTRYINITIALIZER:

RTEMS_INTERRUPT_ENTRY_INITIALIZER()
-----------------------------------

Statically initializes an interrupt entry object.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    #define RTEMS_INTERRUPT_ENTRY_INITIALIZER( routine, arg, info )

.. rubric:: PARAMETERS:

``routine``
    This parameter is the interrupt handler routine for the entry.

``arg``
    This parameter is the interrupt handler argument for the entry.

``info``
    This parameter is the descriptive information for the entry.

.. rubric:: NOTES:

Alternatively, :ref:`InterfaceRtemsInterruptEntryInitialize` may be used to
dynamically initialize an interrupt entry.

.. Generated from spec:/rtems/intr/if/entry-initialize

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_entry_initialize()

.. _InterfaceRtemsInterruptEntryInitialize:

rtems_interrupt_entry_initialize()
----------------------------------

Initializes the interrupt entry.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    void rtems_interrupt_entry_initialize(
      rtems_interrupt_entry  *entry,
      rtems_interrupt_handler routine,
      void                   *arg,
      const char             *info
    );

.. rubric:: PARAMETERS:

``entry``
    This parameter is the interrupt entry to initialize.

``routine``
    This parameter is the interrupt handler routine for the entry.

``arg``
    This parameter is the interrupt handler argument for the entry.

``info``
    This parameter is the descriptive information for the entry.

.. rubric:: NOTES:

Alternatively, :ref:`InterfaceRTEMSINTERRUPTENTRYINITIALIZER` may be used to
statically initialize an interrupt entry.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within any runtime context.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/intr/if/entry-install

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_entry_install()

.. _InterfaceRtemsInterruptEntryInstall:

rtems_interrupt_entry_install()
-------------------------------

Installs the interrupt entry at the interrupt vector.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_interrupt_entry_install(
      rtems_vector_number    vector,
      rtems_option           options,
      rtems_interrupt_entry *entry
    );

.. rubric:: PARAMETERS:

``vector``
    This parameter is the interrupt vector number.

``options``
    This parameter is the interrupt entry install option set.

``entry``
    This parameter is the interrupt entry to install.

.. rubric:: DESCRIPTION:

One of the following mutually exclusive options

* :c:macro:`RTEMS_INTERRUPT_UNIQUE`, and

* :c:macro:`RTEMS_INTERRUPT_SHARED`

shall be set in the ``options`` parameter.

The handler routine of the entry specified by ``entry`` will be called with the
handler argument of the entry when dispatched.  The order in which shared
interrupt handlers are dispatched for one vector is defined by the installation
order.  The first installed handler is dispatched first.

If the option :c:macro:`RTEMS_INTERRUPT_UNIQUE` is set, then it will be ensured
that the handler will be the only one for the interrupt vector.

If the option :c:macro:`RTEMS_INTERRUPT_SHARED` is set, then multiple handlers
may be installed for the interrupt vector.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_ADDRESS`
    The ``entry`` parameter was `NULL
    <https://en.cppreference.com/w/c/types/NULL>`_.

:c:macro:`RTEMS_INCORRECT_STATE`
    The service was not initialized.

:c:macro:`RTEMS_INVALID_ADDRESS`
    The handler routine of the entry was `NULL
    <https://en.cppreference.com/w/c/types/NULL>`_.

:c:macro:`RTEMS_INVALID_ID`
    There was no interrupt vector associated with the number specified by
    ``vector``.

:c:macro:`RTEMS_CALLED_FROM_ISR`
    The directive was called from within interrupt context.

:c:macro:`RTEMS_INVALID_NUMBER`
    An option specified by ``options`` was not applicable.

:c:macro:`RTEMS_RESOURCE_IN_USE`
    The :c:macro:`RTEMS_INTERRUPT_UNIQUE` option was set in ``entry`` and the
    interrupt vector was already occupied by a handler.

:c:macro:`RTEMS_RESOURCE_IN_USE`
    The :c:macro:`RTEMS_INTERRUPT_SHARED` option was set in ``entry`` and the
    interrupt vector was already occupied by a unique handler.

:c:macro:`RTEMS_TOO_MANY`
    The handler routine of the entry specified by ``entry`` was already
    installed for the interrupt vector specified by ``vector`` with an argument
    equal to the handler argument of the entry.

.. rubric:: NOTES:

When the directive call was successful, the ownership of the interrupt entry
has been transferred from the caller to the interrupt service.  An installed
interrupt entry may be removed from the interrupt service by calling
:ref:`InterfaceRtemsInterruptEntryRemove`.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within device driver initialization context.

* The directive may be called from within task context.

* The directive may obtain and release the object allocator mutex.  This may
  cause the calling task to be preempted.

* The interrupt entry shall have been initialized by
  :ref:`InterfaceRtemsInterruptEntryInitialize` or
  :ref:`InterfaceRTEMSINTERRUPTENTRYINITIALIZER`.

.. Generated from spec:/rtems/intr/if/entry-remove

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_entry_remove()

.. _InterfaceRtemsInterruptEntryRemove:

rtems_interrupt_entry_remove()
------------------------------

Removes the interrupt entry from the interrupt vector.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_interrupt_entry_remove(
      rtems_vector_number    vector,
      rtems_interrupt_entry *entry
    );

.. rubric:: PARAMETERS:

``vector``
    This parameter is the interrupt vector number.

``entry``
    This parameter is the interrupt entry to remove.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INCORRECT_STATE`
    The service was not initialized.

:c:macro:`RTEMS_INVALID_ADDRESS`
    The ``entry`` parameter was `NULL
    <https://en.cppreference.com/w/c/types/NULL>`_.

:c:macro:`RTEMS_INVALID_ID`
    There was no interrupt vector associated with the number specified by
    ``vector``.

:c:macro:`RTEMS_CALLED_FROM_ISR`
    The directive was called from within interrupt context.

:c:macro:`RTEMS_UNSATISFIED`
    The entry specified by ``entry`` was not installed at the interrupt vector
    specified by ``vector``.

.. rubric:: NOTES:

When the directive call was successful, the ownership of the interrupt entry
has been transferred from the interrupt service to the caller.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within device driver initialization context.

* The directive may be called from within task context.

* The directive may obtain and release the object allocator mutex.  This may
  cause the calling task to be preempted.

* The interrupt entry shall have been installed by
  :ref:`InterfaceRtemsInterruptEntryInstall`.

.. Generated from spec:/rtems/intr/if/handler-install

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_handler_install()

.. _InterfaceRtemsInterruptHandlerInstall:

rtems_interrupt_handler_install()
---------------------------------

Installs the interrupt handler routine and argument at the interrupt vector.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_interrupt_handler_install(
      rtems_vector_number     vector,
      const char             *info,
      rtems_option            options,
      rtems_interrupt_handler routine,
      void                   *arg
    );

.. rubric:: PARAMETERS:

``vector``
    This parameter is the interrupt vector number.

``info``
    This parameter is the descriptive information of the interrupt handler to
    install.

``options``
    This parameter is the interrupt handler install option set.

``routine``
    This parameter is the interrupt handler routine to install.

``arg``
    This parameter is the interrupt handler argument to install.

.. rubric:: DESCRIPTION:

One of the following mutually exclusive options

* :c:macro:`RTEMS_INTERRUPT_UNIQUE`,

* :c:macro:`RTEMS_INTERRUPT_SHARED`, and

* :c:macro:`RTEMS_INTERRUPT_REPLACE`

shall be set in the ``options`` parameter.

The handler routine will be called with the argument specified by ``arg`` when
dispatched.  The order in which shared interrupt handlers are dispatched for
one vector is defined by the installation order.  The first installed handler
is dispatched first.

If the option :c:macro:`RTEMS_INTERRUPT_UNIQUE` is set, then it will be ensured
that the handler will be the only one for the interrupt vector.

If the option :c:macro:`RTEMS_INTERRUPT_SHARED` is set, then multiple handler
may be installed for the interrupt vector.

If the option :c:macro:`RTEMS_INTERRUPT_REPLACE` is set, then the handler
specified by ``routine`` will replace the first handler with the same argument
for the interrupt vector if it exists, otherwise an error status will be
returned.  A second handler with the same argument for the interrupt vector
will remain unchanged.  The new handler will inherit the unique or shared
options from the replaced handler.

An informative description may be provided in ``info``.  It may be used for
system debugging and diagnostic tools.  The referenced string has to be
persistent as long as the handler is installed.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INCORRECT_STATE`
    The service was not initialized.

:c:macro:`RTEMS_INVALID_ADDRESS`
    The ``routine`` parameter was `NULL
    <https://en.cppreference.com/w/c/types/NULL>`_.

:c:macro:`RTEMS_INVALID_ID`
    There was no interrupt vector associated with the number specified by
    ``vector``.

:c:macro:`RTEMS_CALLED_FROM_ISR`
    The directive was called from within interrupt context.

:c:macro:`RTEMS_NO_MEMORY`
    There was not enough memory available to allocate data structures to
    install the handler.

:c:macro:`RTEMS_RESOURCE_IN_USE`
    The :c:macro:`RTEMS_INTERRUPT_UNIQUE` option was set in ``options`` and the
    interrupt vector was already occupied by a handler.

:c:macro:`RTEMS_RESOURCE_IN_USE`
    The :c:macro:`RTEMS_INTERRUPT_SHARED` option was set in ``options`` and the
    interrupt vector was already occupied by a unique handler.

:c:macro:`RTEMS_TOO_MANY`
    The handler specified by ``routine`` was already installed for the
    interrupt vector specified by ``vector`` with an argument equal to the
    argument specified by ``arg``.

:c:macro:`RTEMS_UNSATISFIED`
    The :c:macro:`RTEMS_INTERRUPT_REPLACE` option was set in ``options`` and no
    handler to replace was installed.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within device driver initialization context.

* The directive may be called from within task context.

* The directive may obtain and release the object allocator mutex.  This may
  cause the calling task to be preempted.

.. Generated from spec:/rtems/intr/if/handler-remove

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_handler_remove()

.. _InterfaceRtemsInterruptHandlerRemove:

rtems_interrupt_handler_remove()
--------------------------------

Removes the interrupt handler routine and argument from the interrupt vector.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_interrupt_handler_remove(
      rtems_vector_number     vector,
      rtems_interrupt_handler routine,
      void                   *arg
    );

.. rubric:: PARAMETERS:

``vector``
    This parameter is the interrupt vector number.

``routine``
    This parameter is the interrupt handler routine to remove.

``arg``
    This parameter is the interrupt handler argument to remove.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INCORRECT_STATE`
    The service was not initialized.

:c:macro:`RTEMS_INVALID_ADDRESS`
    The ``routine`` parameter was `NULL
    <https://en.cppreference.com/w/c/types/NULL>`_.

:c:macro:`RTEMS_INVALID_ID`
    There was no interrupt vector associated with the number specified by
    ``vector``.

:c:macro:`RTEMS_CALLED_FROM_ISR`
    The directive was called from within interrupt context.

:c:macro:`RTEMS_UNSATISFIED`
    There was no handler routine and argument pair installed specified by
    ``routine`` and ``arg``.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within device driver initialization context.

* The directive may be called from within task context.

* The directive may obtain and release the object allocator mutex.  This may
  cause the calling task to be preempted.

.. Generated from spec:/rtems/intr/if/vector-is-enabled

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_vector_is_enabled()

.. _InterfaceRtemsInterruptVectorIsEnabled:

rtems_interrupt_vector_is_enabled()
-----------------------------------

Checks if the interrupt vector is enabled.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_interrupt_vector_is_enabled(
      rtems_vector_number vector,
      bool               *enabled
    );

.. rubric:: PARAMETERS:

``vector``
    This parameter is the interrupt vector number.

``enabled``
    This parameter is the pointer to a ``bool`` object.  When the directive
    call is successful, the enabled status of the interrupt associated with the
    interrupt vector specified by ``vector`` will be stored in this object.
    When the interrupt was enabled for the processor executing the directive
    call at some time point during the call, the object value will be set to
    :c:macro:`true`, otherwise to :c:macro:`false`.

.. rubric:: DESCRIPTION:

The directive checks if the interrupt associated with the interrupt vector
specified by ``vector`` was enabled for the processor executing the directive
call at some time point during the call.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_ADDRESS`
    The ``enabled`` parameter was `NULL
    <https://en.cppreference.com/w/c/types/NULL>`_.

:c:macro:`RTEMS_INVALID_ID`
    There was no interrupt vector associated with the number specified by
    ``vector``.

.. rubric:: NOTES:

Interrupt vectors may be enabled by :ref:`InterfaceRtemsInterruptVectorEnable`
and disabled by :ref:`InterfaceRtemsInterruptVectorDisable`.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within interrupt context.

* The directive may be called from within device driver initialization context.

* The directive may be called from within task context.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/intr/if/vector-enable

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_vector_enable()

.. _InterfaceRtemsInterruptVectorEnable:

rtems_interrupt_vector_enable()
-------------------------------

Enables the interrupt vector.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_interrupt_vector_enable( rtems_vector_number vector );

.. rubric:: PARAMETERS:

``vector``
    This parameter is the number of the interrupt vector to enable.

.. rubric:: DESCRIPTION:

The directive enables the interrupt vector specified by ``vector``. This allows
that interrupt service requests are issued to the target processors of the
interrupt vector.  Interrupt service requests for an interrupt vector may be
raised by :ref:`InterfaceRtemsInterruptRaise`,
:ref:`InterfaceRtemsInterruptRaiseOn`, external signals, or messages.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_ID`
    There was no interrupt vector associated with the number specified by
    ``vector``.

:c:macro:`RTEMS_UNSATISFIED`
    The request to enable the interrupt vector has not been satisfied.

.. rubric:: NOTES:

The :ref:`InterfaceRtemsInterruptGetAttributes` directive may be used to check
if an interrupt vector can be enabled.  Interrupt vectors may be disabled by
:ref:`InterfaceRtemsInterruptVectorDisable`.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within interrupt context.

* The directive may be called from within device driver initialization context.

* The directive may be called from within task context.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/intr/if/vector-disable

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_vector_disable()

.. _InterfaceRtemsInterruptVectorDisable:

rtems_interrupt_vector_disable()
--------------------------------

Disables the interrupt vector.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_interrupt_vector_disable( rtems_vector_number vector );

.. rubric:: PARAMETERS:

``vector``
    This parameter is the number of the interrupt vector to disable.

.. rubric:: DESCRIPTION:

The directive disables the interrupt vector specified by ``vector``.  This
prevents that an interrupt service request is issued to the target processors
of the interrupt vector.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_ID`
    There was no interrupt vector associated with the number specified by
    ``vector``.

:c:macro:`RTEMS_UNSATISFIED`
    The request to disable the interrupt vector has not been satisfied.

.. rubric:: NOTES:

The :ref:`InterfaceRtemsInterruptGetAttributes` directive may be used to check
if an interrupt vector can be disabled.  Interrupt vectors may be enabled by
:ref:`InterfaceRtemsInterruptVectorEnable`.  There may be targets on which some
interrupt vectors cannot be disabled, for example a hardware watchdog interrupt
or software generated interrupts.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within interrupt context.

* The directive may be called from within device driver initialization context.

* The directive may be called from within task context.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/intr/if/is-pending

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_is_pending()

.. _InterfaceRtemsInterruptIsPending:

rtems_interrupt_is_pending()
----------------------------

Checks if the interrupt is pending.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_interrupt_is_pending(
      rtems_vector_number vector,
      bool               *pending
    );

.. rubric:: PARAMETERS:

``vector``
    This parameter is the interrupt vector number.

``pending``
    This parameter is the pointer to a ``bool`` object.  When the directive
    call is successful, the pending status of the interrupt associated with the
    interrupt vector specified by ``vector`` will be stored in this object.
    When the interrupt was pending for the processor executing the directive
    call at some time point during the call, the object value will be set to
    :c:macro:`true`, otherwise to :c:macro:`false`.

.. rubric:: DESCRIPTION:

The directive checks if the interrupt associated with the interrupt vector
specified by ``vector`` was pending for the processor executing the directive
call at some time point during the call.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_ADDRESS`
    The ``pending`` parameter was `NULL
    <https://en.cppreference.com/w/c/types/NULL>`_.

:c:macro:`RTEMS_INVALID_ID`
    There was no interrupt vector associated with the number specified by
    ``vector``.

:c:macro:`RTEMS_UNSATISFIED`
    The request to get the pending status has not been satisfied.

.. rubric:: NOTES:

Interrupts may be made pending by calling the
:ref:`InterfaceRtemsInterruptRaise` or :ref:`InterfaceRtemsInterruptRaiseOn`
directives or due to external signals or messages.  The pending state may be
cleared by :ref:`InterfaceRtemsInterruptClear`.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within interrupt context.

* The directive may be called from within device driver initialization context.

* The directive may be called from within task context.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/intr/if/raise

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_raise()

.. _InterfaceRtemsInterruptRaise:

rtems_interrupt_raise()
-----------------------

Raises the interrupt vector.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_interrupt_raise( rtems_vector_number vector );

.. rubric:: PARAMETERS:

``vector``
    This parameter is the number of the interrupt vector to raise.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_ID`
    There was no interrupt vector associated with the number specified by
    ``vector``.

:c:macro:`RTEMS_UNSATISFIED`
    The request to raise the interrupt vector has not been satisfied.

.. rubric:: NOTES:

The :ref:`InterfaceRtemsInterruptGetAttributes` directive may be used to check
if an interrupt vector can be raised.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within interrupt context.

* The directive may be called from within device driver initialization context.

* The directive may be called from within task context.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/intr/if/raise-on

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_raise_on()

.. _InterfaceRtemsInterruptRaiseOn:

rtems_interrupt_raise_on()
--------------------------

Raises the interrupt vector on the processor.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_interrupt_raise_on(
      rtems_vector_number vector,
      uint32_t            cpu_index
    );

.. rubric:: PARAMETERS:

``vector``
    This parameter is the number of the interrupt vector to raise.

``cpu_index``
    This parameter is the index of the target processor of the interrupt vector
    to raise.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_ID`
    There was no interrupt vector associated with the number specified by
    ``vector``.

:c:macro:`RTEMS_NOT_CONFIGURED`
    The processor specified by ``cpu_index`` was not configured to be used by
    the application.

:c:macro:`RTEMS_INCORRECT_STATE`
    The processor specified by ``cpu_index`` was configured to be used by the
    application, however, it was not online.

:c:macro:`RTEMS_UNSATISFIED`
    The request to raise the interrupt vector has not been satisfied.

.. rubric:: NOTES:

The :ref:`InterfaceRtemsInterruptGetAttributes` directive may be used to check
if an interrupt vector can be raised on a processor.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within interrupt context.

* The directive may be called from within device driver initialization context.

* The directive may be called from within task context.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/intr/if/clear

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_clear()

.. _InterfaceRtemsInterruptClear:

rtems_interrupt_clear()
-----------------------

Clears the interrupt vector.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_interrupt_clear( rtems_vector_number vector );

.. rubric:: PARAMETERS:

``vector``
    This parameter is the number of the interrupt vector to clear.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_ID`
    There was no interrupt vector associated with the number specified by
    ``vector``.

:c:macro:`RTEMS_UNSATISFIED`
    The request to raise the interrupt vector has not been satisfied.

.. rubric:: NOTES:

The :ref:`InterfaceRtemsInterruptGetAttributes` directive may be used to check
if an interrupt vector can be cleared.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within interrupt context.

* The directive may be called from within device driver initialization context.

* The directive may be called from within task context.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/intr/if/get-affinity

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_get_affinity()

.. _InterfaceRtemsInterruptGetAffinity:

rtems_interrupt_get_affinity()
------------------------------

Gets the processor affinity set of the interrupt vector.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_interrupt_get_affinity(
      rtems_vector_number vector,
      size_t              affinity_size,
      cpu_set_t          *affinity
    );

.. rubric:: PARAMETERS:

``vector``
    This parameter is the interrupt vector number.

``affinity_size``
    This parameter is the size of the processor set referenced by ``affinity``
    in bytes.

``affinity``
    This parameter is the pointer to a :c:type:`cpu_set_t` object.  When the
    directive call is successful, the processor affinity set of the interrupt
    vector will be stored in this object.  A set bit in the processor set means
    that the corresponding processor is in the processor affinity set of the
    interrupt vector, otherwise the bit is cleared.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_ADDRESS`
    The ``affinity`` parameter was `NULL
    <https://en.cppreference.com/w/c/types/NULL>`_.

:c:macro:`RTEMS_INVALID_ID`
    There was no interrupt vector associated with the number specified by
    ``vector``.

:c:macro:`RTEMS_INVALID_SIZE`
    The size specified by ``affinity_size`` of the processor set was too small
    for the processor affinity set of the interrupt vector.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within interrupt context.

* The directive may be called from within device driver initialization context.

* The directive may be called from within task context.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/intr/if/set-affinity

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_set_affinity()

.. _InterfaceRtemsInterruptSetAffinity:

rtems_interrupt_set_affinity()
------------------------------

Sets the processor affinity set of the interrupt vector.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_interrupt_set_affinity(
      rtems_vector_number vector,
      size_t              affinity_size,
      const cpu_set_t    *affinity
    );

.. rubric:: PARAMETERS:

``vector``
    This parameter is the interrupt vector number.

``affinity_size``
    This parameter is the size of the processor set referenced by ``affinity``
    in bytes.

``affinity``
    This parameter is the pointer to a :c:type:`cpu_set_t` object.  The
    processor set defines the new processor affinity set of the interrupt
    vector.  A set bit in the processor set means that the corresponding
    processor shall be in the processor affinity set of the interrupt vector,
    otherwise the bit shall be cleared.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_ADDRESS`
    The ``affinity`` parameter was `NULL
    <https://en.cppreference.com/w/c/types/NULL>`_.

:c:macro:`RTEMS_INVALID_ID`
    There was no interrupt vector associated with the number specified by
    ``vector``.

:c:macro:`RTEMS_INVALID_NUMBER`
    The referenced processor set was not a valid new processor affinity set for
    the interrupt vector.

:c:macro:`RTEMS_UNSATISFIED`
    The request to set the processor affinity of the interrupt vector has not
    been satisfied.

.. rubric:: NOTES:

The :ref:`InterfaceRtemsInterruptGetAttributes` directive may be used to check
if the processor affinity of an interrupt vector can be set.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within interrupt context.

* The directive may be called from within device driver initialization context.

* The directive may be called from within task context.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/intr/if/get-attributes

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_get_attributes()

.. _InterfaceRtemsInterruptGetAttributes:

rtems_interrupt_get_attributes()
--------------------------------

Gets the attributes of the interrupt vector.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_interrupt_get_attributes(
      rtems_vector_number         vector,
      rtems_interrupt_attributes *attributes
    );

.. rubric:: PARAMETERS:

``vector``
    This parameter is the interrupt vector number.

``attributes``
    This parameter is the pointer to an :c:type:`rtems_interrupt_attributes`
    object.  When the directive call is successful, the attributes of the
    interrupt vector will be stored in this object.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_ADDRESS`
    The ``attributes`` parameter was `NULL
    <https://en.cppreference.com/w/c/types/NULL>`_.

:c:macro:`RTEMS_INVALID_ID`
    There was no interrupt vector associated with the number specified by
    ``vector``.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within interrupt context.

* The directive may be called from within device driver initialization context.

* The directive may be called from within task context.

* The directive will not cause the calling task to be preempted.

.. Generated from spec:/rtems/intr/if/handler-iterate

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_handler_iterate()

.. _InterfaceRtemsInterruptHandlerIterate:

rtems_interrupt_handler_iterate()
---------------------------------

Iterates over all interrupt handler installed at the interrupt vector.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_interrupt_handler_iterate(
      rtems_vector_number                 vector,
      rtems_interrupt_per_handler_routine routine,
      void                               *arg
    );

.. rubric:: PARAMETERS:

``vector``
    This parameter is the interrupt vector number.

``routine``
    This parameter is the visitor routine.

``arg``
    This parameter is the visitor argument.

.. rubric:: DESCRIPTION:

For each installed handler at the interrupt vector the visitor function
specified by ``routine`` will be called with the argument specified by ``arg``
and the handler information, options, routine and argument.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INCORRECT_STATE`
    The service was not initialized.

:c:macro:`RTEMS_INVALID_ADDRESS`
    The ``routine`` parameter was `NULL
    <https://en.cppreference.com/w/c/types/NULL>`_.

:c:macro:`RTEMS_INVALID_ID`
    There was no interrupt vector associated with the number specified by
    ``vector``.

:c:macro:`RTEMS_CALLED_FROM_ISR`
    The directive was called from within interrupt context.

.. rubric:: NOTES:

The directive is intended for system information and diagnostics.

Never install or remove an interrupt handler within the visitor function. This
may result in a deadlock.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within device driver initialization context.

* The directive may be called from within task context.

* The directive may obtain and release the object allocator mutex.  This may
  cause the calling task to be preempted.

.. Generated from spec:/rtems/intr/if/server-initialize

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_server_initialize()

.. _InterfaceRtemsInterruptServerInitialize:

rtems_interrupt_server_initialize()
-----------------------------------

Initializes the interrupt server tasks.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_interrupt_server_initialize(
      rtems_task_priority priority,
      size_t              stack_size,
      rtems_mode          modes,
      rtems_attribute     attributes,
      uint32_t           *server_count
    );

.. rubric:: PARAMETERS:

``priority``
    This parameter is the initial :term:`task priority` of the created
    interrupt servers.

``stack_size``
    This parameter is the task stack size of the created interrupt servers.

``modes``
    This parameter is the initial mode set of the created interrupt servers.

``attributes``
    This parameter is the attribute set of the created interrupt servers.

``server_count``
    This parameter is the pointer to an `uint32_t
    <https://en.cppreference.com/w/c/types/integer>`_ object or `NULL
    <https://en.cppreference.com/w/c/types/NULL>`_. When the pointer is not
    equal to `NULL <https://en.cppreference.com/w/c/types/NULL>`_, the count of
    successfully created interrupt servers is stored in this object regardless
    of the return status.

.. rubric:: DESCRIPTION:

The directive tries to create an interrupt server task for each online
processor in the system.  The tasks will have the initial priority specified by
``priority``, the stack size specified by ``stack_size``, the initial mode set
specified by ``modes``, and the attribute set specified by ``attributes``.  The
count of successfully created server tasks will be returned in ``server_count``
if the pointer is not equal to `NULL
<https://en.cppreference.com/w/c/types/NULL>`_.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INCORRECT_STATE`
    The interrupt servers were already initialized.

The directive uses :ref:`InterfaceRtemsTaskCreate`.  If this directive fails,
then its error status will be returned.

.. rubric:: NOTES:

Interrupt handlers may be installed on an interrupt server with
:ref:`InterfaceRtemsInterruptServerHandlerInstall` and removed with
:ref:`InterfaceRtemsInterruptServerHandlerRemove` using a server index.  In
case of an interrupt, the request will be forwarded to the interrupt server.
The handlers are executed within the interrupt server context.  If one handler
blocks on something this may delay the processing of other handlers.

Interrupt servers may be deleted by :ref:`InterfaceRtemsInterruptServerDelete`.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within device driver initialization context.

* The directive may be called from within task context.

* The directive may obtain and release the object allocator mutex.  This may
  cause the calling task to be preempted.

.. Generated from spec:/rtems/intr/if/server-create

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_server_create()

.. _InterfaceRtemsInterruptServerCreate:

rtems_interrupt_server_create()
-------------------------------

Creates an interrupt server.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_interrupt_server_create(
      rtems_interrupt_server_control      *control,
      const rtems_interrupt_server_config *config,
      uint32_t                            *server_index
    );

.. rubric:: PARAMETERS:

``control``
    This parameter is the pointer to an
    :c:type:`rtems_interrupt_server_control` object.  When the directive call
    was successful, the ownership of the object was transferred from the caller
    of the directive to the interrupt server management.

``config``
    This parameter is the interrupt server configuration.

``server_index``
    This parameter is the pointer to an `uint32_t
    <https://en.cppreference.com/w/c/types/integer>`_ object.  When the
    directive call was successful, the index of the created interrupt server
    will be stored in this object.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

The directive uses :ref:`InterfaceRtemsTaskCreate`.  If this directive fails,
then its error status will be returned.

.. rubric:: NOTES:

See also :ref:`InterfaceRtemsInterruptServerInitialize` and
:ref:`InterfaceRtemsInterruptServerDelete`.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within device driver initialization context.

* The directive may be called from within task context.

* The directive may obtain and release the object allocator mutex.  This may
  cause the calling task to be preempted.

.. Generated from spec:/rtems/intr/if/server-handler-install

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_server_handler_install()

.. _InterfaceRtemsInterruptServerHandlerInstall:

rtems_interrupt_server_handler_install()
----------------------------------------

Installs the interrupt handler routine and argument at the interrupt vector on
the interrupt server.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_interrupt_server_handler_install(
      uint32_t                server_index,
      rtems_vector_number     vector,
      const char             *info,
      rtems_option            options,
      rtems_interrupt_handler routine,
      void                   *arg
    );

.. rubric:: PARAMETERS:

``server_index``
    This parameter is the interrupt server index.  The constant
    :c:macro:`RTEMS_INTERRUPT_SERVER_DEFAULT` may be used to specify the
    default interrupt server.

``vector``
    This parameter is the interrupt vector number.

``info``
    This parameter is the descriptive information of the interrupt handler to
    install.

``options``
    This parameter is the interrupt handler install option set.

``routine``
    This parameter is the interrupt handler routine to install.

``arg``
    This parameter is the interrupt handler argument to install.

.. rubric:: DESCRIPTION:

The handler routine specified by ``routine`` will be executed within the
context of the interrupt server task specified by ``server_index``.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_ID`
    There was no interrupt server associated with the index specified by
    ``server_index``.

:c:macro:`RTEMS_CALLED_FROM_ISR`
    The directive was called from within interrupt context.

:c:macro:`RTEMS_INVALID_ADDRESS`
    The ``routine`` parameter was `NULL
    <https://en.cppreference.com/w/c/types/NULL>`_.

:c:macro:`RTEMS_INVALID_ID`
    There was no interrupt vector associated with the number specified by
    ``vector``.

:c:macro:`RTEMS_INVALID_NUMBER`
    An option specified by ``info`` was not applicable.

:c:macro:`RTEMS_RESOURCE_IN_USE`
    The :c:macro:`RTEMS_INTERRUPT_UNIQUE` option was set in ``info`` and the
    interrupt vector was already occupied by a handler.

:c:macro:`RTEMS_RESOURCE_IN_USE`
    The :c:macro:`RTEMS_INTERRUPT_SHARED` option was set in ``info`` and the
    interrupt vector was already occupied by a unique handler.

:c:macro:`RTEMS_TOO_MANY`
    The handler specified by ``routine`` was already installed for the
    interrupt vector specified by ``vector`` with an argument equal to the
    argument specified by ``arg``.

:c:macro:`RTEMS_UNSATISFIED`
    The :c:macro:`RTEMS_INTERRUPT_REPLACE` option was set in ``info`` and no
    handler to replace was installed.

.. rubric:: NOTES:

See also :ref:`InterfaceRtemsInterruptHandlerInstall`.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within device driver initialization context.

* The directive may be called from within task context.

* The directive may obtain and release the object allocator mutex.  This may
  cause the calling task to be preempted.

.. Generated from spec:/rtems/intr/if/server-handler-remove

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_server_handler_remove()

.. _InterfaceRtemsInterruptServerHandlerRemove:

rtems_interrupt_server_handler_remove()
---------------------------------------

Removes the interrupt handler routine and argument from the interrupt vector
and the interrupt server.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_interrupt_server_handler_remove(
      uint32_t                server_index,
      rtems_vector_number     vector,
      rtems_interrupt_handler routine,
      void                   *arg
    );

.. rubric:: PARAMETERS:

``server_index``
    This parameter is the interrupt server index.  The constant
    :c:macro:`RTEMS_INTERRUPT_SERVER_DEFAULT` may be used to specify the
    default interrupt server.

``vector``
    This parameter is the interrupt vector number.

``routine``
    This parameter is the interrupt handler routine to remove.

``arg``
    This parameter is the interrupt handler argument to remove.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_ID`
    There was no interrupt server associated with the index specified by
    ``server_index``.

:c:macro:`RTEMS_INVALID_ID`
    There was no interrupt vector associated with the number specified by
    ``vector``.

:c:macro:`RTEMS_UNSATISFIED`
    There was no handler routine and argument pair installed specified by
    ``routine`` and ``arg``.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within task context.

* The directive may obtain and release the object allocator mutex.  This may
  cause the calling task to be preempted.

* The directive sends a request to another task and waits for a response.  This
  may cause the calling task to be blocked and unblocked.

* The directive shall not be called from within the context of an interrupt
  server.  Calling the directive from within the context of an interrupt server
  is undefined behaviour.

.. Generated from spec:/rtems/intr/if/server-set-affinity

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_server_set_affinity()

.. _InterfaceRtemsInterruptServerSetAffinity:

rtems_interrupt_server_set_affinity()
-------------------------------------

Sets the processor affinity of the interrupt server.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_interrupt_server_set_affinity(
      uint32_t            server_index,
      size_t              affinity_size,
      const cpu_set_t    *affinity,
      rtems_task_priority priority
    );

.. rubric:: PARAMETERS:

``server_index``
    This parameter is the interrupt server index.  The constant
    :c:macro:`RTEMS_INTERRUPT_SERVER_DEFAULT` may be used to specify the
    default interrupt server.

``affinity_size``
    This parameter is the size of the processor set referenced by ``affinity``
    in bytes.

``affinity``
    This parameter is the pointer to a :c:type:`cpu_set_t` object.  The
    processor set defines the new processor affinity set of the interrupt
    server.  A set bit in the processor set means that the corresponding
    processor shall be in the processor affinity set of the task, otherwise the
    bit shall be cleared.

``priority``
    This parameter is the new :term:`real priority` for the interrupt server.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_ID`
    There was no interrupt server associated with the index specified by
    ``server_index``.

The directive uses :ref:`InterfaceRtemsSchedulerIdentByProcessorSet`,
:ref:`InterfaceRtemsTaskSetScheduler`, and
:ref:`InterfaceRtemsTaskSetAffinity`.  If one of these directive fails, then
its error status will be returned.

.. rubric:: NOTES:

The scheduler is set determined by the highest numbered processor in the
affinity set specified by ``affinity``.

This operation is only reliable in case the interrupt server was suspended via
:ref:`InterfaceRtemsInterruptServerSuspend`.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within interrupt context.

* The directive may be called from within device driver initialization context.

* The directive may be called from within task context.

* The directive may change the processor affinity of a task.  This may cause
  the calling task to be preempted.

* The directive may change the priority of a task.  This may cause the calling
  task to be preempted.

.. Generated from spec:/rtems/intr/if/server-delete

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_server_delete()

.. _InterfaceRtemsInterruptServerDelete:

rtems_interrupt_server_delete()
-------------------------------

Deletes the interrupt server.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_interrupt_server_delete( uint32_t server_index );

.. rubric:: PARAMETERS:

``server_index``
    This parameter is the index of the interrupt server to delete.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_ID`
    There was no interrupt server associated with the server index specified by
    ``server_index``.

.. rubric:: NOTES:

The interrupt server deletes itself, so after the return of the directive the
interrupt server may be still in the termination process depending on the task
priorities of the system.

See also :ref:`InterfaceRtemsInterruptServerCreate`.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within task context.

* The directive shall not be called from within the context of an interrupt
  server.  Calling the directive from within the context of an interrupt server
  is undefined behaviour.

* The directive sends a request to another task and waits for a response.  This
  may cause the calling task to be blocked and unblocked.

.. Generated from spec:/rtems/intr/if/server-suspend

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_server_suspend()

.. _InterfaceRtemsInterruptServerSuspend:

rtems_interrupt_server_suspend()
--------------------------------

Suspends the interrupt server.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_interrupt_server_suspend( uint32_t server_index );

.. rubric:: PARAMETERS:

``server_index``
    This parameter is the index of the interrupt server to suspend.  The
    constant :c:macro:`RTEMS_INTERRUPT_SERVER_DEFAULT` may be used to specify
    the default interrupt server.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_ID`
    There was no interrupt server associated with the index specified by
    ``server_index``.

.. rubric:: NOTES:

Interrupt server may be resumed by :ref:`InterfaceRtemsInterruptServerResume`.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within task context.

* The directive shall not be called from within the context of an interrupt
  server.  Calling the directive from within the context of an interrupt server
  is undefined behaviour.

* The directive sends a request to another task and waits for a response.  This
  may cause the calling task to be blocked and unblocked.

.. Generated from spec:/rtems/intr/if/server-resume

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_server_resume()

.. _InterfaceRtemsInterruptServerResume:

rtems_interrupt_server_resume()
-------------------------------

Resumes the interrupt server.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_interrupt_server_resume( uint32_t server_index );

.. rubric:: PARAMETERS:

``server_index``
    This parameter is the index of the interrupt server to resume.  The
    constant :c:macro:`RTEMS_INTERRUPT_SERVER_DEFAULT` may be used to specify
    the default interrupt server.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_ID`
    There was no interrupt server associated with the index specified by
    ``server_index``.

.. rubric:: NOTES:

Interrupt server may be suspended by
:ref:`InterfaceRtemsInterruptServerSuspend`.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within task context.

* The directive shall not be called from within the context of an interrupt
  server.  Calling the directive from within the context of an interrupt server
  is undefined behaviour.

* The directive sends a request to another task and waits for a response.  This
  may cause the calling task to be blocked and unblocked.

.. Generated from spec:/rtems/intr/if/server-move

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_server_move()

.. _InterfaceRtemsInterruptServerMove:

rtems_interrupt_server_move()
-----------------------------

Moves the interrupt handlers installed at the interrupt vector and the source
interrupt server to the destination interrupt server.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_interrupt_server_move(
      uint32_t            source_server_index,
      rtems_vector_number vector,
      uint32_t            destination_server_index
    );

.. rubric:: PARAMETERS:

``source_server_index``
    This parameter is the index of the source interrupt server.  The constant
    :c:macro:`RTEMS_INTERRUPT_SERVER_DEFAULT` may be used to specify the
    default interrupt server.

``vector``
    This parameter is the interrupt vector number.

``destination_server_index``
    This parameter is the index of the destination interrupt server.  The
    constant :c:macro:`RTEMS_INTERRUPT_SERVER_DEFAULT` may be used to specify
    the default interrupt server.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_ID`
    There was no interrupt server associated with the index specified by
    ``source_server_index``.

:c:macro:`RTEMS_INVALID_ID`
    There was no interrupt server associated with the index specified by
    ``destination_server_index``.

:c:macro:`RTEMS_INVALID_ID`
    There was no interrupt vector associated with the number specified by
    ``vector``.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within task context.

* The directive shall not be called from within the context of an interrupt
  server.  Calling the directive from within the context of an interrupt server
  is undefined behaviour.

* The directive sends a request to another task and waits for a response.  This
  may cause the calling task to be blocked and unblocked.

.. Generated from spec:/rtems/intr/if/server-handler-iterate

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_server_handler_iterate()

.. _InterfaceRtemsInterruptServerHandlerIterate:

rtems_interrupt_server_handler_iterate()
----------------------------------------

Iterates over all interrupt handler installed at the interrupt vector and
interrupt server.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_interrupt_server_handler_iterate(
      uint32_t                            server_index,
      rtems_vector_number                 vector,
      rtems_interrupt_per_handler_routine routine,
      void                               *arg
    );

.. rubric:: PARAMETERS:

``server_index``
    This parameter is the index of the interrupt server.

``vector``
    This parameter is the interrupt vector number.

``routine``
    This parameter is the visitor routine.

``arg``
    This parameter is the visitor argument.

.. rubric:: DESCRIPTION:

For each installed handler at the interrupt vector and interrupt server the
visitor function specified by ``vector`` will be called with the argument
specified by ``routine`` and the handler information, options, routine and
argument.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_ID`
    There was no interrupt server associated with the index specified by
    ``server_index``.

:c:macro:`RTEMS_INVALID_ID`
    There was no interrupt vector associated with the number specified by
    ``vector``.

.. rubric:: NOTES:

The directive is intended for system information and diagnostics.

Never install or remove an interrupt handler within the visitor function. This
may result in a deadlock.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within device driver initialization context.

* The directive may be called from within task context.

* The directive may obtain and release the object allocator mutex.  This may
  cause the calling task to be preempted.

.. Generated from spec:/rtems/intr/if/server-entry-initialize

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_server_entry_initialize()

.. _InterfaceRtemsInterruptServerEntryInitialize:

rtems_interrupt_server_entry_initialize()
-----------------------------------------

Initializes the interrupt server entry.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_interrupt_server_entry_initialize(
      uint32_t                      server_index,
      rtems_interrupt_server_entry *entry
    );

.. rubric:: PARAMETERS:

``server_index``
    This parameter is the interrupt server index.  The constant
    :c:macro:`RTEMS_INTERRUPT_SERVER_DEFAULT` may be used to specify the
    default interrupt server.

``entry``
    This parameter is the interrupt server entry to initialize.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_ID`
    There was no interrupt server associated with the index specified by
    ``server_index``.

.. rubric:: NOTES:

After initialization, the list of actions of the interrupt server entry is
empty.  Actions may be prepended by
:ref:`InterfaceRtemsInterruptServerActionPrepend`. Interrupt server entries may
be moved to another interrupt vector with
:ref:`InterfaceRtemsInterruptServerEntryMove`.  Server entries may be submitted
to get serviced by the interrupt server with
:ref:`InterfaceRtemsInterruptServerEntrySubmit`.  Server entries may be
destroyed by :ref:`InterfaceRtemsInterruptServerEntryDestroy`.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within device driver initialization context.

* The directive may be called from within task context.

* The directive may obtain and release the object allocator mutex.  This may
  cause the calling task to be preempted.

.. Generated from spec:/rtems/intr/if/server-action-prepend

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_server_action_prepend()

.. _InterfaceRtemsInterruptServerActionPrepend:

rtems_interrupt_server_action_prepend()
---------------------------------------

Prepends the interrupt server action to the list of actions of the interrupt
server entry.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    void rtems_interrupt_server_action_prepend(
      rtems_interrupt_server_entry  *entry,
      rtems_interrupt_server_action *action,
      rtems_interrupt_handler        routine,
      void                          *arg
    );

.. rubric:: PARAMETERS:

``entry``
    This parameter is the interrupt server entry to prepend the interrupt
    server action.  It shall have been initialized via
    :ref:`InterfaceRtemsInterruptServerEntryInitialize`.

``action``
    This parameter is the interrupt server action to initialize and prepend to
    the list of actions of the entry.

``routine``
    This parameter is the interrupt handler routine to set in the action.

``arg``
    This parameter is the interrupt handler argument to set in the action.

.. rubric:: NOTES:

No error checking is performed by the directive.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within interrupt context.

* The directive may be called from within device driver initialization context.

* The directive may be called from within task context.

* The directive will not cause the calling task to be preempted.

* The interrupt server entry shall have been initialized by
  :ref:`InterfaceRtemsInterruptServerEntryInitialize` and further optional
  calls to :ref:`InterfaceRtemsInterruptServerActionPrepend`.

* The directive shall not be called concurrently with
  :ref:`InterfaceRtemsInterruptServerActionPrepend` with the same interrupt
  server entry. Calling the directive under this condition is undefined
  behaviour.

* The directive shall not be called concurrently with
  :ref:`InterfaceRtemsInterruptServerEntryMove` with the same interrupt server
  entry. Calling the directive under this condition is undefined behaviour.

* The directive shall not be called concurrently with
  :ref:`InterfaceRtemsInterruptServerEntrySubmit` with the same interrupt
  server entry. Calling the directive under this condition is undefined
  behaviour.

* The directive shall not be called while the interrupt server entry is pending
  on or serviced by its current interrupt server.  Calling the directive under
  these conditions is undefined behaviour.

.. Generated from spec:/rtems/intr/if/server-entry-destroy

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_server_entry_destroy()

.. _InterfaceRtemsInterruptServerEntryDestroy:

rtems_interrupt_server_entry_destroy()
--------------------------------------

Destroys the interrupt server entry.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    void rtems_interrupt_server_entry_destroy(
      rtems_interrupt_server_entry *entry
    );

.. rubric:: PARAMETERS:

``entry``
    This parameter is the interrupt server entry to destroy.

.. rubric:: NOTES:

No error checking is performed by the directive.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within task context.

* The directive shall not be called from within the context of an interrupt
  server.  Calling the directive from within the context of an interrupt server
  is undefined behaviour.

* The directive sends a request to another task and waits for a response.  This
  may cause the calling task to be blocked and unblocked.

* The interrupt server entry shall have been initialized by
  :ref:`InterfaceRtemsInterruptServerEntryInitialize` and further optional
  calls to :ref:`InterfaceRtemsInterruptServerActionPrepend`.

.. Generated from spec:/rtems/intr/if/server-entry-submit

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_server_entry_submit()

.. _InterfaceRtemsInterruptServerEntrySubmit:

rtems_interrupt_server_entry_submit()
-------------------------------------

Submits the interrupt server entry to be serviced by the interrupt server.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    void rtems_interrupt_server_entry_submit(
      rtems_interrupt_server_entry *entry
    );

.. rubric:: PARAMETERS:

``entry``
    This parameter is the interrupt server entry to submit.

.. rubric:: DESCRIPTION:

The directive appends the entry to the pending entries of the interrupt server.
The interrupt server is notified that a new entry is pending.  Once the
interrupt server is scheduled it services the actions of all pending entries.

.. rubric:: NOTES:

This directive may be used to do a two-step interrupt processing.  The first
step is done from within interrupt context by a call to this directive.  The
second step is then done from within the context of the interrupt server.

No error checking is performed by the directive.

A submitted entry may be destroyed by
:ref:`InterfaceRtemsInterruptServerEntryDestroy`.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within interrupt context.

* The directive may be called from within device driver initialization context.

* The directive may be called from within task context.

* The directive may unblock a task.  This may cause the calling task to be
  preempted.

* The interrupt server entry shall have been initialized by
  :ref:`InterfaceRtemsInterruptServerEntryInitialize` and further optional
  calls to :ref:`InterfaceRtemsInterruptServerActionPrepend`.

* The directive shall not be called concurrently with
  :ref:`InterfaceRtemsInterruptServerActionPrepend` with the same interrupt
  server entry. Calling the directive under this condition is undefined
  behaviour.

* The directive shall not be called concurrently with
  :ref:`InterfaceRtemsInterruptServerEntryMove` with the same interrupt server
  entry. Calling the directive under this condition is undefined behaviour.

.. Generated from spec:/rtems/intr/if/server-entry-move

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_server_entry_move()

.. _InterfaceRtemsInterruptServerEntryMove:

rtems_interrupt_server_entry_move()
-----------------------------------

Moves the interrupt server entry to the interrupt server.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_interrupt_server_entry_move(
      rtems_interrupt_server_entry *entry,
      uint32_t                      server_index
    );

.. rubric:: PARAMETERS:

``entry``
    This parameter is the interrupt server entry to move.

``server_index``
    This parameter is the index of the destination interrupt server.  The
    constant :c:macro:`RTEMS_INTERRUPT_SERVER_DEFAULT` may be used to specify
    the default interrupt server.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_ID`
    There was no interrupt server associated with the index specified by
    ``server_index``.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within device driver initialization context.

* The directive may be called from within task context.

* The directive may obtain and release the object allocator mutex.  This may
  cause the calling task to be preempted.

* The interrupt server entry shall have been initialized by
  :ref:`InterfaceRtemsInterruptServerEntryInitialize` and further optional
  calls to :ref:`InterfaceRtemsInterruptServerActionPrepend`.

* The directive shall not be called concurrently with
  :ref:`InterfaceRtemsInterruptServerActionPrepend` with the same interrupt
  server entry. Calling the directive under this condition is undefined
  behaviour.

* The directive shall not be called concurrently with
  :ref:`InterfaceRtemsInterruptServerEntryMove` with the same interrupt server
  entry. Calling the directive under this condition is undefined behaviour.

* The directive shall not be called concurrently with
  :ref:`InterfaceRtemsInterruptServerEntrySubmit` with the same interrupt
  server entry. Calling the directive under this condition is undefined
  behaviour.

* The directive shall not be called while the interrupt server entry is pending
  on or serviced by its current interrupt server.  Calling the directive under
  these conditions is undefined behaviour.

.. Generated from spec:/rtems/intr/if/server-request-initialize

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_server_request_initialize()

.. _InterfaceRtemsInterruptServerRequestInitialize:

rtems_interrupt_server_request_initialize()
-------------------------------------------

Initializes the interrupt server request.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    rtems_status_code rtems_interrupt_server_request_initialize(
      uint32_t                        server_index,
      rtems_interrupt_server_request *request,
      rtems_interrupt_handler         routine,
      void                           *arg
    );

.. rubric:: PARAMETERS:

``server_index``
    This parameter is the interrupt server index.  The constant
    :c:macro:`RTEMS_INTERRUPT_SERVER_DEFAULT` may be used to specify the
    default interrupt server.

``request``
    This parameter is the interrupt server request to initialize.

``routine``
    This parameter is the interrupt handler routine for the request action.

``arg``
    This parameter is the interrupt handler argument for the request action.

.. rubric:: RETURN VALUES:

:c:macro:`RTEMS_SUCCESSFUL`
    The requested operation was successful.

:c:macro:`RTEMS_INVALID_ID`
    There was no interrupt server associated with the index specified by
    ``server_index``.

.. rubric:: NOTES:

An interrupt server requests consists of an interrupt server entry and exactly
one interrupt server action.  The interrupt vector of the request may be
changed with :ref:`InterfaceRtemsInterruptServerRequestSetVector`.  Interrupt
server requests may be submitted to get serviced by the interrupt server with
:ref:`InterfaceRtemsInterruptServerRequestSubmit`.  Requests may be destroyed
by :ref:`InterfaceRtemsInterruptServerRequestDestroy`.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within device driver initialization context.

* The directive may be called from within task context.

* The directive may obtain and release the object allocator mutex.  This may
  cause the calling task to be preempted.

.. Generated from spec:/rtems/intr/if/server-request-set-vector

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_server_request_set_vector()

.. _InterfaceRtemsInterruptServerRequestSetVector:

rtems_interrupt_server_request_set_vector()
-------------------------------------------

Sets the interrupt vector in the interrupt server request.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    void rtems_interrupt_server_request_set_vector(
      rtems_interrupt_server_request *request,
      rtems_vector_number             vector
    );

.. rubric:: PARAMETERS:

``request``
    This parameter is the interrupt server request to change.

``vector``
    This parameter is the interrupt vector number to be used by the request.

.. rubric:: NOTES:

By default, the interrupt vector of an interrupt server request is set to a
special value which is outside the range of vectors supported by the interrupt
controller hardware.

Calls to :ref:`InterfaceRtemsInterruptServerRequestSubmit` will disable the
interrupt vector of the request.  After processing of the request by the
interrupt server the interrupt vector will be enabled again.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within interrupt context.

* The directive may be called from within device driver initialization context.

* The directive may be called from within task context.

* The directive will not cause the calling task to be preempted.

* The interrupt server request shall have been initialized by
  :ref:`InterfaceRtemsInterruptServerRequestInitialize`.

* The directive shall not be called concurrently with
  :ref:`InterfaceRtemsInterruptServerRequestSetVector` with the same interrupt
  server request.  Calling the directive under this condition is undefined
  behaviour.

* The directive shall not be called concurrently with
  :ref:`InterfaceRtemsInterruptServerRequestSubmit` with the same interrupt
  server request. Calling the directive under this condition is undefined
  behaviour.

* The directive shall not be called while the interrupt server entry is pending
  on or serviced by its current interrupt server.  Calling the directive under
  these conditions is undefined behaviour.

.. Generated from spec:/rtems/intr/if/server-request-destroy

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_server_request_destroy()

.. _InterfaceRtemsInterruptServerRequestDestroy:

rtems_interrupt_server_request_destroy()
----------------------------------------

Destroys the interrupt server request.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    void rtems_interrupt_server_request_destroy(
      rtems_interrupt_server_request *request
    );

.. rubric:: PARAMETERS:

``request``
    This parameter is the interrupt server request to destroy.

.. rubric:: NOTES:

No error checking is performed by the directive.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within task context.

* The directive shall not be called from within the context of an interrupt
  server.  Calling the directive from within the context of an interrupt server
  is undefined behaviour.

* The directive sends a request to another task and waits for a response.  This
  may cause the calling task to be blocked and unblocked.

* The interrupt server request shall have been initialized by
  :ref:`InterfaceRtemsInterruptServerRequestInitialize`.

.. Generated from spec:/rtems/intr/if/server-request-submit

.. raw:: latex

    \clearpage

.. index:: rtems_interrupt_server_request_submit()

.. _InterfaceRtemsInterruptServerRequestSubmit:

rtems_interrupt_server_request_submit()
---------------------------------------

Submits the interrupt server request to be serviced by the interrupt server.

.. rubric:: CALLING SEQUENCE:

.. code-block:: c

    void rtems_interrupt_server_request_submit(
      rtems_interrupt_server_request *request
    );

.. rubric:: PARAMETERS:

``request``
    This parameter is the interrupt server request to submit.

.. rubric:: DESCRIPTION:

The directive appends the interrupt server entry of the request to the pending
entries of the interrupt server.  The interrupt server is notified that a new
entry is pending.  Once the interrupt server is scheduled it services the
actions of all pending entries.

.. rubric:: NOTES:

This directive may be used to do a two-step interrupt processing.  The first
step is done from within interrupt context by a call to this directive.  The
second step is then done from within the context of the interrupt server.

No error checking is performed by the directive.

A submitted request may be destroyed by
:ref:`InterfaceRtemsInterruptServerRequestDestroy`.

.. rubric:: CONSTRAINTS:

The following constraints apply to this directive:

* The directive may be called from within interrupt context.

* The directive may be called from within device driver initialization context.

* The directive may be called from within task context.

* The directive may unblock a task.  This may cause the calling task to be
  preempted.

* The interrupt server request shall have been initialized by
  :ref:`InterfaceRtemsInterruptServerRequestInitialize`.

* The directive shall not be called concurrently with
  :ref:`InterfaceRtemsInterruptServerRequestSetVector` with the same interrupt
  server request.  Calling the directive under this condition is undefined
  behaviour.