]> Git Repo - pico-vscode.git/blob - web/docs/group__hardware__irq.html
Merge branch 'main' into main
[pico-vscode.git] / web / docs / group__hardware__irq.html
1 <!-- HTML header for doxygen 1.8.20-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5         <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6         <meta http-equiv="X-UA-Compatible" content="IE=9"/>
7         <meta name="generator" content="Doxygen 1.9.4"/>
8         <meta name="viewport" content="width=device-width, initial-scale=1"/>
9         <title>Raspberry Pi Pico SDK: hardware_irq</title>
10         <!-- <link href="tabs.css" rel="stylesheet" type="text/css"/> -->
11         <script type="text/javascript" src="jquery.js"></script>
12         <script type="text/javascript" src="dynsections.js"></script>
13         <link href="navtree.css" rel="stylesheet" type="text/css"/>
14 <script type="text/javascript" src="resize.js"></script>
15 <script type="text/javascript" src="navtreedata.js"></script>
16 <script type="text/javascript" src="navtree.js"></script>
17         <link href="search/search.css" rel="stylesheet" type="text/css"/>
18 <script type="text/javascript" src="search/searchdata.js"></script>
19 <script type="text/javascript" src="search/search.js"></script>
20     <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500&display=swap" rel="stylesheet">
21         <link href="doxygen.css" rel="stylesheet" type="text/css" />
22         <link href="normalise.css" rel="stylesheet" type="text/css"/>
23 <link href="main.css" rel="stylesheet" type="text/css"/>
24 <link href="styles.css" rel="stylesheet" type="text/css"/>
25 </head>
26 <body>
27         <div class="navigation-mobile">
28                 <div class="logo--mobile">
29                         <a href="/"><img src="logo-mobile.svg" alt="Raspberry Pi"></a>
30                 </div>
31                 <div class="navigation-toggle">
32                         <span class="line-1"></span>
33                         <span class="line-2">
34                                 <p>Menu Toggle</p>
35                         </span>
36                         <span class="line-3"></span>
37                 </div>
38         </div>
39         <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
40                 <div class="logo">
41                         <a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
42                         <span style="display: inline-block; margin-top: 10px;">
43                                 v2.0.0
44                         </span>
45                 </div>
46                 <div class="navigation-footer">
47                         <img src="logo-mobile.svg" alt="Raspberry Pi">
48                         <a href="https://www.raspberrypi.com/" target="_blank">By Raspberry Pi Ltd</a>
49                 </div>
50 <!--            <div class="search">
51                         <form>
52                                 <input type="search" name="search" id="search" placeholder="Search">
53                                 <input type="submit" value="Search">
54                         </form>
55                 </div> -->
56 <!-- Generated by Doxygen 1.9.4 -->
57 <script type="text/javascript">
58 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
59 var searchBox = new SearchBox("searchBox", "search",'Search','.html');
60 /* @license-end */
61 </script>
62 <script type="text/javascript" src="menudata.js"></script>
63 <script type="text/javascript" src="menu.js"></script>
64 <script type="text/javascript">
65 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
66 $(function() {
67   initMenu('',true,false,'search.php','Search');
68   $(document).ready(function() { init_search(); });
69 });
70 /* @license-end */
71 </script>
72 <div id="main-nav"></div>
73 </div><!-- top -->
74 <div id="side-nav" class="ui-resizable side-nav-resizable">
75   <div id="nav-tree">
76     <div id="nav-tree-contents">
77       <div id="nav-sync" class="sync"></div>
78     </div>
79   </div>
80   <div id="splitbar" style="-moz-user-select:none;" 
81        class="ui-resizable-handle">
82   </div>
83 </div>
84 <script type="text/javascript">
85 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
86 $(document).ready(function(){initNavTree('group__hardware__irq.html',''); initResizable(); });
87 /* @license-end */
88 </script>
89 <div id="doc-content">
90 <!-- window showing the filter options -->
91 <div id="MSearchSelectWindow"
92      onmouseover="return searchBox.OnSearchSelectShow()"
93      onmouseout="return searchBox.OnSearchSelectHide()"
94      onkeydown="return searchBox.OnSearchSelectKey(event)">
95 </div>
96
97 <!-- iframe showing the search results (closed by default) -->
98 <div id="MSearchResultsWindow">
99 <iframe src="javascript:void(0)" frameborder="0" 
100         name="MSearchResults" id="MSearchResults">
101 </iframe>
102 </div>
103
104 <div class="header">
105   <div class="summary">
106 <a href="#typedef-members">Typedefs</a> &#124;
107 <a href="#enum-members">Enumerations</a> &#124;
108 <a href="#func-members">Functions</a>  </div>
109   <div class="headertitle"><div class="title">hardware_irq<div class="ingroups"><a class="el" href="group__hardware.html">Hardware APIs</a></div></div></div>
110 </div><!--header-->
111 <div class="contents">
112
113 <p>Hardware interrupt handling API.  
114 <a href="#details">More...</a></p>
115 <table class="memberdecls">
116 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
117 Typedefs</h2></td></tr>
118 <tr class="memitem:ga8787b32e001d4eac0ec747c53d6a4288"><td class="memItemLeft" align="right" valign="top"><a id="ga8787b32e001d4eac0ec747c53d6a4288" name="ga8787b32e001d4eac0ec747c53d6a4288"></a>
119 typedef enum <a class="el" href="group__hardware__irq.html#ga876b9495995a81dff786f07a1975c3b8">irq_num_rp2350</a>&#160;</td><td class="memItemRight" valign="bottom"><b>irq_num_t</b></td></tr>
120 <tr class="memdesc:ga8787b32e001d4eac0ec747c53d6a4288"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interrupt numbers on RP2350 (used as typedef <a class="el" href="group__hardware__irq.html#gaf30862f51b5994ffd5863176a185d137">irq_num_t</a>) <br /></td></tr>
121 <tr class="separator:ga8787b32e001d4eac0ec747c53d6a4288"><td class="memSeparator" colspan="2">&#160;</td></tr>
122 <tr class="memitem:gaf30862f51b5994ffd5863176a185d137"><td class="memItemLeft" align="right" valign="top"><a id="gaf30862f51b5994ffd5863176a185d137" name="gaf30862f51b5994ffd5863176a185d137"></a>
123 typedef enum <a class="el" href="group__hardware__irq.html#gaf4bf6b287c1a8445fce49ccaa711b3c3">irq_num_rp2040</a>&#160;</td><td class="memItemRight" valign="bottom"><b>irq_num_t</b></td></tr>
124 <tr class="memdesc:gaf30862f51b5994ffd5863176a185d137"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interrupt numbers on RP2040 (used as typedef <a class="el" href="group__hardware__irq.html#gaf30862f51b5994ffd5863176a185d137">irq_num_t</a>) <br /></td></tr>
125 <tr class="separator:gaf30862f51b5994ffd5863176a185d137"><td class="memSeparator" colspan="2">&#160;</td></tr>
126 <tr class="memitem:ga8478ee26cc144e947ccd75b0169059a6"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__irq.html#ga8478ee26cc144e947ccd75b0169059a6">irq_handler_t</a>) (void)</td></tr>
127 <tr class="memdesc:ga8478ee26cc144e947ccd75b0169059a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interrupt handler function type.  <a href="group__hardware__irq.html#ga8478ee26cc144e947ccd75b0169059a6">More...</a><br /></td></tr>
128 <tr class="separator:ga8478ee26cc144e947ccd75b0169059a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
129 </table><table class="memberdecls">
130 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
131 Enumerations</h2></td></tr>
132 <tr class="memitem:ga876b9495995a81dff786f07a1975c3b8"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__irq.html#ga876b9495995a81dff786f07a1975c3b8">irq_num_rp2350</a> { <br />
133 &#160;&#160;<a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a8aefc9b5ce0307f2983c7cfe9cfcee0e">TIMER0_IRQ_0</a> = 0
134 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a5b912fdba3cd93427d74b8ef527d980f">TIMER0_IRQ_1</a> = 1
135 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a959d2d69aa10978b36fb4fbecc77a465">TIMER0_IRQ_2</a> = 2
136 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a021f4aa1758af47eb23298196e1f22c5">TIMER0_IRQ_3</a> = 3
137 , <br />
138 &#160;&#160;<a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a4ba1f242076b28a4217181e0f65896ec">TIMER1_IRQ_0</a> = 4
139 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a757d218b48843638d3f8f45fa6fd48f9">TIMER1_IRQ_1</a> = 5
140 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a156a0e9cbc66e4ce56dfb52d09d86858">TIMER1_IRQ_2</a> = 6
141 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8af2fb391af7b873b5268e3824068d08c0">TIMER1_IRQ_3</a> = 7
142 , <br />
143 &#160;&#160;<a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8ab95e3cb2a0db0f078b2f51d43d6f0221">PWM_IRQ_WRAP_0</a> = 8
144 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a9b21deae090eb8ab1c69eaa4dd71572f">PWM_IRQ_WRAP_1</a> = 9
145 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a27c81947202be1166b90cd5fb6f482a0">DMA_IRQ_0</a> = 10
146 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a7b25577c8e3d3b1c4bab08eaed19b5ef">DMA_IRQ_1</a> = 11
147 , <br />
148 &#160;&#160;<a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8aa05c818a7b9a97853fced4be9a9b0955">DMA_IRQ_2</a> = 12
149 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a2852a4ce8747ec1b0ece265c3d681ad4">DMA_IRQ_3</a> = 13
150 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a2cd42859a0101338a23d1687c6ff473c">USBCTRL_IRQ</a> = 14
151 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a6a1531131ebf36cef68deb1b098c169e">PIO0_IRQ_0</a> = 15
152 , <br />
153 &#160;&#160;<a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a8342ee77067f98e1796e79d437093367">PIO0_IRQ_1</a> = 16
154 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a25729562658fcf2aa86e87e54617e7af">PIO1_IRQ_0</a> = 17
155 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a02a272c2eed06831563b441793eb4964">PIO1_IRQ_1</a> = 18
156 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a6a797ac81319a12d8f727b0df3bf4b45">PIO2_IRQ_0</a> = 19
157 , <br />
158 &#160;&#160;<a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8aeaaf6372e890b298cab2d23ccf6b7e25">PIO2_IRQ_1</a> = 20
159 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8ae9d0650a36de3bfbad6edc82a613d3c1">IO_IRQ_BANK0</a> = 21
160 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a8cfea98eab080d57d60d751d78b9397d">IO_IRQ_BANK0_NS</a> = 22
161 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8af5aa261b359dd160a1d8c3bc558ceb2b">IO_IRQ_QSPI</a> = 23
162 , <br />
163 &#160;&#160;<a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8ac2d22291df1fa6859d5c86ba7eae9018">IO_IRQ_QSPI_NS</a> = 24
164 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8afe8f5a1a66b8b6c489a8fb3bb618815f">SIO_IRQ_FIFO</a> = 25
165 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8abee4ee8eee7b960d0cf734578ffef811">SIO_IRQ_BELL</a> = 26
166 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a2bcf85572bb5a5f53ec4444798261541">SIO_IRQ_FIFO_NS</a> = 27
167 , <br />
168 &#160;&#160;<a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a72f9b9916df889c0a55731b3a51b8e05">SIO_IRQ_BELL_NS</a> = 28
169 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a750e73e82e614dff437a37149bd59eb1">SIO_IRQ_MTIMECMP</a> = 29
170 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a737a1db2a02502ed578e908b3b6796c2">CLOCKS_IRQ</a> = 30
171 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a10b2c78ee63a060db5d9f30b8f1daf8a">SPI0_IRQ</a> = 31
172 , <br />
173 &#160;&#160;<a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a60f73b071388a649cac65d2026607540">SPI1_IRQ</a> = 32
174 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a504e54f28a2e2928bd6a1604ee0a24fb">UART0_IRQ</a> = 33
175 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a1062848ec5bc51fcdd58a95d40fc266b">UART1_IRQ</a> = 34
176 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a80d34861619c6034c897e829aea93ed4">ADC_IRQ_FIFO</a> = 35
177 , <br />
178 &#160;&#160;<a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8ae54e6d9ba3c33888744c4ba77a7a4255">I2C0_IRQ</a> = 36
179 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a3d4c9de91954651ee3dee7c066fc3db9">I2C1_IRQ</a> = 37
180 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a2ef9df4ccdeb630d832d6d2b076586b6">OTP_IRQ</a> = 38
181 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8aeef89f7a46f31d1ce96fd0f6328b78c8">TRNG_IRQ</a> = 39
182 , <br />
183 &#160;&#160;<a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a0ed6df37fc7086fc72331ac64d5abcf0">PROC0_IRQ_CTI</a> = 40
184 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8af8101a6cce54937f4af39f3c27a2fe6d">PROC1_IRQ_CTI</a> = 41
185 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a946ceb547b06cf725bcdc28171249d5a">PLL_SYS_IRQ</a> = 42
186 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a875f153be03e06f3da74de8ed802ae12">PLL_USB_IRQ</a> = 43
187 , <br />
188 &#160;&#160;<a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8ac30f13a1f91cc090fdb619028183ad0e">POWMAN_IRQ_POW</a> = 44
189 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a803d6485cd5cc1737bbaa006eb30e0f8">POWMAN_IRQ_TIMER</a> = 45
190 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8aad3052d1d06b983df4551cd9ddd739ae">SPARE_IRQ_0</a> = 46
191 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a1db065c3095a5f7f4c08becc89cc146e">SPARE_IRQ_1</a> = 47
192 , <br />
193 &#160;&#160;<a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a8632f943b2645a064df4b4f32be6cfb4">SPARE_IRQ_2</a> = 48
194 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8a37d25d9bef6f9987f6f0acd1199fdd06">SPARE_IRQ_3</a> = 49
195 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8ae1e37d639062c9f84055a9137fc29870">SPARE_IRQ_4</a> = 50
196 , <a class="el" href="group__hardware__irq.html#gga876b9495995a81dff786f07a1975c3b8af00c937dd1333d2fa5e52d906dd7529b">SPARE_IRQ_5</a> = 51
197 , <br />
198 &#160;&#160;<b>IRQ_COUNT</b>
199 <br />
200  }</td></tr>
201 <tr class="memdesc:ga876b9495995a81dff786f07a1975c3b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interrupt numbers on RP2350 (used as typedef <a class="el" href="group__hardware__irq.html#gaf30862f51b5994ffd5863176a185d137">irq_num_t</a>)  <a href="group__hardware__irq.html#ga876b9495995a81dff786f07a1975c3b8">More...</a><br /></td></tr>
202 <tr class="separator:ga876b9495995a81dff786f07a1975c3b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
203 <tr class="memitem:gaf4bf6b287c1a8445fce49ccaa711b3c3"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__irq.html#gaf4bf6b287c1a8445fce49ccaa711b3c3">irq_num_rp2040</a> { <br />
204 &#160;&#160;<a class="el" href="group__hardware__irq.html#ggaf4bf6b287c1a8445fce49ccaa711b3c3a9adcee3ff00b51d885e399d87fd6c957">TIMER_IRQ_0</a> = 0
205 , <a class="el" href="group__hardware__irq.html#ggaf4bf6b287c1a8445fce49ccaa711b3c3a4c240b6b48b410130cd2890ab04d560e">TIMER_IRQ_1</a> = 1
206 , <a class="el" href="group__hardware__irq.html#ggaf4bf6b287c1a8445fce49ccaa711b3c3aff3b80e5739147626d9386b2a3b2953c">TIMER_IRQ_2</a> = 2
207 , <a class="el" href="group__hardware__irq.html#ggaf4bf6b287c1a8445fce49ccaa711b3c3aa85dca1accc78d56c18c8a2c2e842b42">TIMER_IRQ_3</a> = 3
208 , <br />
209 &#160;&#160;<a class="el" href="group__hardware__irq.html#ggaf4bf6b287c1a8445fce49ccaa711b3c3a0142d31049f55e027a88331ad70fa5aa">PWM_IRQ_WRAP</a> = 4
210 , <a class="el" href="group__hardware__irq.html#ggaf4bf6b287c1a8445fce49ccaa711b3c3a2cd42859a0101338a23d1687c6ff473c">USBCTRL_IRQ</a> = 5
211 , <a class="el" href="group__hardware__irq.html#ggaf4bf6b287c1a8445fce49ccaa711b3c3a76f444f019edf6356c9e64a1c2714b30">XIP_IRQ</a> = 6
212 , <a class="el" href="group__hardware__irq.html#ggaf4bf6b287c1a8445fce49ccaa711b3c3a6a1531131ebf36cef68deb1b098c169e">PIO0_IRQ_0</a> = 7
213 , <br />
214 &#160;&#160;<a class="el" href="group__hardware__irq.html#ggaf4bf6b287c1a8445fce49ccaa711b3c3a8342ee77067f98e1796e79d437093367">PIO0_IRQ_1</a> = 8
215 , <a class="el" href="group__hardware__irq.html#ggaf4bf6b287c1a8445fce49ccaa711b3c3a25729562658fcf2aa86e87e54617e7af">PIO1_IRQ_0</a> = 9
216 , <a class="el" href="group__hardware__irq.html#ggaf4bf6b287c1a8445fce49ccaa711b3c3a02a272c2eed06831563b441793eb4964">PIO1_IRQ_1</a> = 10
217 , <a class="el" href="group__hardware__irq.html#ggaf4bf6b287c1a8445fce49ccaa711b3c3a27c81947202be1166b90cd5fb6f482a0">DMA_IRQ_0</a> = 11
218 , <br />
219 &#160;&#160;<a class="el" href="group__hardware__irq.html#ggaf4bf6b287c1a8445fce49ccaa711b3c3a7b25577c8e3d3b1c4bab08eaed19b5ef">DMA_IRQ_1</a> = 12
220 , <a class="el" href="group__hardware__irq.html#ggaf4bf6b287c1a8445fce49ccaa711b3c3ae9d0650a36de3bfbad6edc82a613d3c1">IO_IRQ_BANK0</a> = 13
221 , <a class="el" href="group__hardware__irq.html#ggaf4bf6b287c1a8445fce49ccaa711b3c3af5aa261b359dd160a1d8c3bc558ceb2b">IO_IRQ_QSPI</a> = 14
222 , <a class="el" href="group__hardware__irq.html#ggaf4bf6b287c1a8445fce49ccaa711b3c3a841acbddc6961252827d7645277452ec">SIO_IRQ_PROC0</a> = 15
223 , <br />
224 &#160;&#160;<a class="el" href="group__hardware__irq.html#ggaf4bf6b287c1a8445fce49ccaa711b3c3ae00819201c60acdf59448df5a08c11b5">SIO_IRQ_PROC1</a> = 16
225 , <a class="el" href="group__hardware__irq.html#ggaf4bf6b287c1a8445fce49ccaa711b3c3a737a1db2a02502ed578e908b3b6796c2">CLOCKS_IRQ</a> = 17
226 , <a class="el" href="group__hardware__irq.html#ggaf4bf6b287c1a8445fce49ccaa711b3c3a10b2c78ee63a060db5d9f30b8f1daf8a">SPI0_IRQ</a> = 18
227 , <a class="el" href="group__hardware__irq.html#ggaf4bf6b287c1a8445fce49ccaa711b3c3a60f73b071388a649cac65d2026607540">SPI1_IRQ</a> = 19
228 , <br />
229 &#160;&#160;<a class="el" href="group__hardware__irq.html#ggaf4bf6b287c1a8445fce49ccaa711b3c3a504e54f28a2e2928bd6a1604ee0a24fb">UART0_IRQ</a> = 20
230 , <a class="el" href="group__hardware__irq.html#ggaf4bf6b287c1a8445fce49ccaa711b3c3a1062848ec5bc51fcdd58a95d40fc266b">UART1_IRQ</a> = 21
231 , <a class="el" href="group__hardware__irq.html#ggaf4bf6b287c1a8445fce49ccaa711b3c3a80d34861619c6034c897e829aea93ed4">ADC_IRQ_FIFO</a> = 22
232 , <a class="el" href="group__hardware__irq.html#ggaf4bf6b287c1a8445fce49ccaa711b3c3ae54e6d9ba3c33888744c4ba77a7a4255">I2C0_IRQ</a> = 23
233 , <br />
234 &#160;&#160;<a class="el" href="group__hardware__irq.html#ggaf4bf6b287c1a8445fce49ccaa711b3c3a3d4c9de91954651ee3dee7c066fc3db9">I2C1_IRQ</a> = 24
235 , <a class="el" href="group__hardware__irq.html#ggaf4bf6b287c1a8445fce49ccaa711b3c3a758d0e5253474a1224daa5eff0bdb5fc">RTC_IRQ</a> = 25
236 , <b>IRQ_COUNT</b>
237 <br />
238  }</td></tr>
239 <tr class="memdesc:gaf4bf6b287c1a8445fce49ccaa711b3c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interrupt numbers on RP2040 (used as typedef <a class="el" href="group__hardware__irq.html#gaf30862f51b5994ffd5863176a185d137">irq_num_t</a>)  <a href="group__hardware__irq.html#gaf4bf6b287c1a8445fce49ccaa711b3c3">More...</a><br /></td></tr>
240 <tr class="separator:gaf4bf6b287c1a8445fce49ccaa711b3c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
241 </table><table class="memberdecls">
242 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
243 Functions</h2></td></tr>
244 <tr class="memitem:gad11ea172f11d9763647ac34b366ab3c2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__irq.html#gad11ea172f11d9763647ac34b366ab3c2">irq_set_priority</a> (uint num, uint8_t hardware_priority)</td></tr>
245 <tr class="memdesc:gad11ea172f11d9763647ac34b366ab3c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set specified interrupt's priority.  <a href="group__hardware__irq.html#gad11ea172f11d9763647ac34b366ab3c2">More...</a><br /></td></tr>
246 <tr class="separator:gad11ea172f11d9763647ac34b366ab3c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
247 <tr class="memitem:ga6bcde7d99ca71abe8dccfd13b4d80b29"><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__irq.html#ga6bcde7d99ca71abe8dccfd13b4d80b29">irq_get_priority</a> (uint num)</td></tr>
248 <tr class="memdesc:ga6bcde7d99ca71abe8dccfd13b4d80b29"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get specified interrupt's priority.  <a href="group__hardware__irq.html#ga6bcde7d99ca71abe8dccfd13b4d80b29">More...</a><br /></td></tr>
249 <tr class="separator:ga6bcde7d99ca71abe8dccfd13b4d80b29"><td class="memSeparator" colspan="2">&#160;</td></tr>
250 <tr class="memitem:ga7c7167f643c6898b758340ce59d333d9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__irq.html#ga7c7167f643c6898b758340ce59d333d9">irq_set_enabled</a> (uint num, bool enabled)</td></tr>
251 <tr class="memdesc:ga7c7167f643c6898b758340ce59d333d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable or disable a specific interrupt on the executing core.  <a href="group__hardware__irq.html#ga7c7167f643c6898b758340ce59d333d9">More...</a><br /></td></tr>
252 <tr class="separator:ga7c7167f643c6898b758340ce59d333d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
253 <tr class="memitem:ga0c54ae4c0593c2a8596b99cd167584e0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__irq.html#ga0c54ae4c0593c2a8596b99cd167584e0">irq_is_enabled</a> (uint num)</td></tr>
254 <tr class="memdesc:ga0c54ae4c0593c2a8596b99cd167584e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determine if a specific interrupt is enabled on the executing core.  <a href="group__hardware__irq.html#ga0c54ae4c0593c2a8596b99cd167584e0">More...</a><br /></td></tr>
255 <tr class="separator:ga0c54ae4c0593c2a8596b99cd167584e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
256 <tr class="memitem:gae91340b84a6d70049933af657df93201"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__irq.html#gae91340b84a6d70049933af657df93201">irq_set_mask_enabled</a> (uint32_t mask, bool enabled)</td></tr>
257 <tr class="memdesc:gae91340b84a6d70049933af657df93201"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable/disable multiple interrupts on the executing core.  <a href="group__hardware__irq.html#gae91340b84a6d70049933af657df93201">More...</a><br /></td></tr>
258 <tr class="separator:gae91340b84a6d70049933af657df93201"><td class="memSeparator" colspan="2">&#160;</td></tr>
259 <tr class="memitem:gae1a927e62e780b2f7dacc3a008ffaf20"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__irq.html#gae1a927e62e780b2f7dacc3a008ffaf20">irq_set_mask_n_enabled</a> (uint n, uint32_t mask, bool enabled)</td></tr>
260 <tr class="memdesc:gae1a927e62e780b2f7dacc3a008ffaf20"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable/disable multiple interrupts on the executing core.  <a href="group__hardware__irq.html#gae1a927e62e780b2f7dacc3a008ffaf20">More...</a><br /></td></tr>
261 <tr class="separator:gae1a927e62e780b2f7dacc3a008ffaf20"><td class="memSeparator" colspan="2">&#160;</td></tr>
262 <tr class="memitem:gafffd448ba2d2eef5b355b88180aefe7f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__irq.html#gafffd448ba2d2eef5b355b88180aefe7f">irq_set_exclusive_handler</a> (uint num, <a class="el" href="group__hardware__irq.html#ga8478ee26cc144e947ccd75b0169059a6">irq_handler_t</a> handler)</td></tr>
263 <tr class="memdesc:gafffd448ba2d2eef5b355b88180aefe7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set an exclusive interrupt handler for an interrupt on the executing core.  <a href="group__hardware__irq.html#gafffd448ba2d2eef5b355b88180aefe7f">More...</a><br /></td></tr>
264 <tr class="separator:gafffd448ba2d2eef5b355b88180aefe7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
265 <tr class="memitem:ga42e9cdce7b82ef63c7b2416d32a42361"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__hardware__irq.html#ga8478ee26cc144e947ccd75b0169059a6">irq_handler_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__irq.html#ga42e9cdce7b82ef63c7b2416d32a42361">irq_get_exclusive_handler</a> (uint num)</td></tr>
266 <tr class="memdesc:ga42e9cdce7b82ef63c7b2416d32a42361"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the exclusive interrupt handler for an interrupt on the executing core.  <a href="group__hardware__irq.html#ga42e9cdce7b82ef63c7b2416d32a42361">More...</a><br /></td></tr>
267 <tr class="separator:ga42e9cdce7b82ef63c7b2416d32a42361"><td class="memSeparator" colspan="2">&#160;</td></tr>
268 <tr class="memitem:gaf02f8599896c66f4579c845a96b2126e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__irq.html#gaf02f8599896c66f4579c845a96b2126e">irq_add_shared_handler</a> (uint num, <a class="el" href="group__hardware__irq.html#ga8478ee26cc144e947ccd75b0169059a6">irq_handler_t</a> handler, uint8_t order_priority)</td></tr>
269 <tr class="memdesc:gaf02f8599896c66f4579c845a96b2126e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a shared interrupt handler for an interrupt on the executing core.  <a href="group__hardware__irq.html#gaf02f8599896c66f4579c845a96b2126e">More...</a><br /></td></tr>
270 <tr class="separator:gaf02f8599896c66f4579c845a96b2126e"><td class="memSeparator" colspan="2">&#160;</td></tr>
271 <tr class="memitem:gadfd3308952d41ee91671ae098b867a90"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__irq.html#gadfd3308952d41ee91671ae098b867a90">irq_remove_handler</a> (uint num, <a class="el" href="group__hardware__irq.html#ga8478ee26cc144e947ccd75b0169059a6">irq_handler_t</a> handler)</td></tr>
272 <tr class="memdesc:gadfd3308952d41ee91671ae098b867a90"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove a specific interrupt handler for the given irq number on the executing core.  <a href="group__hardware__irq.html#gadfd3308952d41ee91671ae098b867a90">More...</a><br /></td></tr>
273 <tr class="separator:gadfd3308952d41ee91671ae098b867a90"><td class="memSeparator" colspan="2">&#160;</td></tr>
274 <tr class="memitem:gae552cab9da1b37a785791f678090f418"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__irq.html#gae552cab9da1b37a785791f678090f418">irq_has_shared_handler</a> (uint num)</td></tr>
275 <tr class="memdesc:gae552cab9da1b37a785791f678090f418"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determine if the current handler for the given number is shared.  <a href="group__hardware__irq.html#gae552cab9da1b37a785791f678090f418">More...</a><br /></td></tr>
276 <tr class="separator:gae552cab9da1b37a785791f678090f418"><td class="memSeparator" colspan="2">&#160;</td></tr>
277 <tr class="memitem:ga4f9772d9d1781c3a28371623886a0310"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__hardware__irq.html#ga8478ee26cc144e947ccd75b0169059a6">irq_handler_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__irq.html#ga4f9772d9d1781c3a28371623886a0310">irq_get_vtable_handler</a> (uint num)</td></tr>
278 <tr class="memdesc:ga4f9772d9d1781c3a28371623886a0310"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current IRQ handler for the specified IRQ from the currently installed hardware vector table (VTOR) of the execution core.  <a href="group__hardware__irq.html#ga4f9772d9d1781c3a28371623886a0310">More...</a><br /></td></tr>
279 <tr class="separator:ga4f9772d9d1781c3a28371623886a0310"><td class="memSeparator" colspan="2">&#160;</td></tr>
280 <tr class="memitem:ga14fa98b8bec09df3e7409a75cf2f5359"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__irq.html#ga14fa98b8bec09df3e7409a75cf2f5359">irq_clear</a> (uint int_num)</td></tr>
281 <tr class="memdesc:ga14fa98b8bec09df3e7409a75cf2f5359"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear a specific interrupt on the executing core.  <a href="group__hardware__irq.html#ga14fa98b8bec09df3e7409a75cf2f5359">More...</a><br /></td></tr>
282 <tr class="separator:ga14fa98b8bec09df3e7409a75cf2f5359"><td class="memSeparator" colspan="2">&#160;</td></tr>
283 <tr class="memitem:ga36e4b97d3414ce58c3091e63badcf9ce"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__irq.html#ga36e4b97d3414ce58c3091e63badcf9ce">irq_set_pending</a> (uint num)</td></tr>
284 <tr class="memdesc:ga36e4b97d3414ce58c3091e63badcf9ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Force an interrupt to be pending on the executing core.  <a href="group__hardware__irq.html#ga36e4b97d3414ce58c3091e63badcf9ce">More...</a><br /></td></tr>
285 <tr class="separator:ga36e4b97d3414ce58c3091e63badcf9ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
286 <tr class="memitem:gaa52ec9e5f572b3a0ef50707ab37233ef"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__irq.html#gaa52ec9e5f572b3a0ef50707ab37233ef">user_irq_claim</a> (uint irq_num)</td></tr>
287 <tr class="memdesc:gaa52ec9e5f572b3a0ef50707ab37233ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Claim ownership of a user IRQ on the calling core.  <a href="group__hardware__irq.html#gaa52ec9e5f572b3a0ef50707ab37233ef">More...</a><br /></td></tr>
288 <tr class="separator:gaa52ec9e5f572b3a0ef50707ab37233ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
289 <tr class="memitem:ga14c041e05fbd5ee3c0b6b6341073a20a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__irq.html#ga14c041e05fbd5ee3c0b6b6341073a20a">user_irq_unclaim</a> (uint irq_num)</td></tr>
290 <tr class="memdesc:ga14c041e05fbd5ee3c0b6b6341073a20a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mark a user IRQ as no longer used on the calling core.  <a href="group__hardware__irq.html#ga14c041e05fbd5ee3c0b6b6341073a20a">More...</a><br /></td></tr>
291 <tr class="separator:ga14c041e05fbd5ee3c0b6b6341073a20a"><td class="memSeparator" colspan="2">&#160;</td></tr>
292 <tr class="memitem:gace889ebb0bde6fc678dee915d4e3537e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__irq.html#gace889ebb0bde6fc678dee915d4e3537e">user_irq_claim_unused</a> (bool required)</td></tr>
293 <tr class="memdesc:gace889ebb0bde6fc678dee915d4e3537e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Claim ownership of a free user IRQ on the calling core.  <a href="group__hardware__irq.html#gace889ebb0bde6fc678dee915d4e3537e">More...</a><br /></td></tr>
294 <tr class="separator:gace889ebb0bde6fc678dee915d4e3537e"><td class="memSeparator" colspan="2">&#160;</td></tr>
295 </table>
296 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
297 <p >Hardware interrupt handling API. </p>
298 <p >The RP2040 uses the standard ARM nested vectored interrupt controller (NVIC).</p>
299 <p >Interrupts are identified by a number from 0 to 31.</p>
300 <p >On the RP2040, only the lower 26 IRQ signals are connected on the NVIC; IRQs 26 to 31 are tied to zero (never firing).</p>
301 <p >There is one NVIC per core, and each core's NVIC has the same hardware interrupt lines routed to it, with the exception of the IO interrupts where there is one IO interrupt per bank, per core. These are completely independent, so, for example, processor 0 can be interrupted by GPIO 0 in bank 0, and processor 1 by GPIO 1 in the same bank.</p>
302 <dl class="section note"><dt>Note</dt><dd>That all IRQ APIs affect the executing core only (i.e. the core calling the function).</dd>
303 <dd>
304 You should not enable the same (shared) IRQ number on both cores, as this will lead to race conditions or starvation of one of the cores. Additionally, don't forget that disabling interrupts on one core does not disable interrupts on the other core.</dd></dl>
305 <p>There are three different ways to set handlers for an IRQ:</p><ul>
306 <li>Calling <a class="el" href="group__hardware__irq.html#gaf02f8599896c66f4579c845a96b2126e" title="Add a shared interrupt handler for an interrupt on the executing core.">irq_add_shared_handler()</a> at runtime to add a handler for a multiplexed interrupt (e.g. GPIO bank) on the current core. Each handler, should check and clear the relevant hardware interrupt source</li>
307 <li>Calling <a class="el" href="group__hardware__irq.html#gafffd448ba2d2eef5b355b88180aefe7f" title="Set an exclusive interrupt handler for an interrupt on the executing core.">irq_set_exclusive_handler()</a> at runtime to install a single handler for the interrupt on the current core</li>
308 <li>Defining the interrupt handler explicitly in your application (e.g. by defining void <code>isr_dma_0</code> will make that function the handler for the DMA_IRQ_0 on core 0, and you will not be able to change it using the above APIs at runtime). Using this method can cause link conflicts at runtime, and offers no runtime performance benefit (i.e, it should not generally be used).</li>
309 </ul>
310 <dl class="section note"><dt>Note</dt><dd>If an IRQ is enabled and fires with no handler installed, a breakpoint will be hit and the IRQ number will be in register r0.</dd></dl>
311 <h1><a class="anchor" id="interrupt_nums"></a>
312 Interrupt Numbers</h1>
313 <p >A set of defines is available (<a class="el" href="intctrl_8h_source.html">intctrl.h</a>) with these names to avoid using the numbers directly.</p>
314 <p >On RP2040 the interrupt numbers are as follows:</p>
315 <table class="markdownTable">
316 <tr class="markdownTableHead">
317 <th class="markdownTableHeadNone">IRQ   </th><th class="markdownTableHeadNone">Interrupt Source    </th></tr>
318 <tr class="markdownTableRowOdd">
319 <td class="markdownTableBodyNone">0   </td><td class="markdownTableBodyNone">TIMER_IRQ_0    </td></tr>
320 <tr class="markdownTableRowEven">
321 <td class="markdownTableBodyNone">1   </td><td class="markdownTableBodyNone">TIMER_IRQ_1    </td></tr>
322 <tr class="markdownTableRowOdd">
323 <td class="markdownTableBodyNone">2   </td><td class="markdownTableBodyNone">TIMER_IRQ_2    </td></tr>
324 <tr class="markdownTableRowEven">
325 <td class="markdownTableBodyNone">3   </td><td class="markdownTableBodyNone">TIMER_IRQ_3    </td></tr>
326 <tr class="markdownTableRowOdd">
327 <td class="markdownTableBodyNone">4   </td><td class="markdownTableBodyNone">PWM_IRQ_WRAP    </td></tr>
328 <tr class="markdownTableRowEven">
329 <td class="markdownTableBodyNone">5   </td><td class="markdownTableBodyNone">USBCTRL_IRQ    </td></tr>
330 <tr class="markdownTableRowOdd">
331 <td class="markdownTableBodyNone">6   </td><td class="markdownTableBodyNone">XIP_IRQ    </td></tr>
332 <tr class="markdownTableRowEven">
333 <td class="markdownTableBodyNone">7   </td><td class="markdownTableBodyNone">PIO0_IRQ_0    </td></tr>
334 <tr class="markdownTableRowOdd">
335 <td class="markdownTableBodyNone">8   </td><td class="markdownTableBodyNone">PIO0_IRQ_1    </td></tr>
336 <tr class="markdownTableRowEven">
337 <td class="markdownTableBodyNone">9   </td><td class="markdownTableBodyNone">PIO1_IRQ_0    </td></tr>
338 <tr class="markdownTableRowOdd">
339 <td class="markdownTableBodyNone">10   </td><td class="markdownTableBodyNone">PIO1_IRQ_1    </td></tr>
340 <tr class="markdownTableRowEven">
341 <td class="markdownTableBodyNone">11   </td><td class="markdownTableBodyNone">DMA_IRQ_0    </td></tr>
342 <tr class="markdownTableRowOdd">
343 <td class="markdownTableBodyNone">12   </td><td class="markdownTableBodyNone">DMA_IRQ_1    </td></tr>
344 <tr class="markdownTableRowEven">
345 <td class="markdownTableBodyNone">13   </td><td class="markdownTableBodyNone">IO_IRQ_BANK0    </td></tr>
346 <tr class="markdownTableRowOdd">
347 <td class="markdownTableBodyNone">14   </td><td class="markdownTableBodyNone">IO_IRQ_QSPI    </td></tr>
348 <tr class="markdownTableRowEven">
349 <td class="markdownTableBodyNone">15   </td><td class="markdownTableBodyNone">SIO_IRQ_PROC0    </td></tr>
350 <tr class="markdownTableRowOdd">
351 <td class="markdownTableBodyNone">16   </td><td class="markdownTableBodyNone">SIO_IRQ_PROC1    </td></tr>
352 <tr class="markdownTableRowEven">
353 <td class="markdownTableBodyNone">17   </td><td class="markdownTableBodyNone">CLOCKS_IRQ    </td></tr>
354 <tr class="markdownTableRowOdd">
355 <td class="markdownTableBodyNone">18   </td><td class="markdownTableBodyNone">SPI0_IRQ    </td></tr>
356 <tr class="markdownTableRowEven">
357 <td class="markdownTableBodyNone">19   </td><td class="markdownTableBodyNone">SPI1_IRQ    </td></tr>
358 <tr class="markdownTableRowOdd">
359 <td class="markdownTableBodyNone">20   </td><td class="markdownTableBodyNone">UART0_IRQ    </td></tr>
360 <tr class="markdownTableRowEven">
361 <td class="markdownTableBodyNone">21   </td><td class="markdownTableBodyNone">UART1_IRQ    </td></tr>
362 <tr class="markdownTableRowOdd">
363 <td class="markdownTableBodyNone">22   </td><td class="markdownTableBodyNone">ADC0_IRQ_FIFO    </td></tr>
364 <tr class="markdownTableRowEven">
365 <td class="markdownTableBodyNone">23   </td><td class="markdownTableBodyNone">I2C0_IRQ    </td></tr>
366 <tr class="markdownTableRowOdd">
367 <td class="markdownTableBodyNone">24   </td><td class="markdownTableBodyNone">I2C1_IRQ    </td></tr>
368 <tr class="markdownTableRowEven">
369 <td class="markdownTableBodyNone">25   </td><td class="markdownTableBodyNone">RTC_IRQ   </td></tr>
370 </table>
371 <p >On RP2350 the interrupt numbers are as follows:</p>
372 <table class="markdownTable">
373 <tr class="markdownTableHead">
374 <th class="markdownTableHeadNone">IRQ   </th><th class="markdownTableHeadNone">Interrupt Source    </th></tr>
375 <tr class="markdownTableRowOdd">
376 <td class="markdownTableBodyNone">0   </td><td class="markdownTableBodyNone">TIMER0_IRQ_0    </td></tr>
377 <tr class="markdownTableRowEven">
378 <td class="markdownTableBodyNone">1   </td><td class="markdownTableBodyNone">TIMER0_IRQ_1    </td></tr>
379 <tr class="markdownTableRowOdd">
380 <td class="markdownTableBodyNone">2   </td><td class="markdownTableBodyNone">TIMER0_IRQ_2    </td></tr>
381 <tr class="markdownTableRowEven">
382 <td class="markdownTableBodyNone">3   </td><td class="markdownTableBodyNone">TIMER0_IRQ_3    </td></tr>
383 <tr class="markdownTableRowOdd">
384 <td class="markdownTableBodyNone">4   </td><td class="markdownTableBodyNone">TIMER1_IRQ_0    </td></tr>
385 <tr class="markdownTableRowEven">
386 <td class="markdownTableBodyNone">5   </td><td class="markdownTableBodyNone">TIMER1_IRQ_1    </td></tr>
387 <tr class="markdownTableRowOdd">
388 <td class="markdownTableBodyNone">6   </td><td class="markdownTableBodyNone">TIMER1_IRQ_2    </td></tr>
389 <tr class="markdownTableRowEven">
390 <td class="markdownTableBodyNone">7   </td><td class="markdownTableBodyNone">TIMER1_IRQ_3    </td></tr>
391 <tr class="markdownTableRowOdd">
392 <td class="markdownTableBodyNone">8   </td><td class="markdownTableBodyNone">PWM_IRQ_WRAP_0    </td></tr>
393 <tr class="markdownTableRowEven">
394 <td class="markdownTableBodyNone">9   </td><td class="markdownTableBodyNone">PWM_IRQ_WRAP_1    </td></tr>
395 <tr class="markdownTableRowOdd">
396 <td class="markdownTableBodyNone">10   </td><td class="markdownTableBodyNone">DMA_IRQ_0    </td></tr>
397 <tr class="markdownTableRowEven">
398 <td class="markdownTableBodyNone">11   </td><td class="markdownTableBodyNone">DMA_IRQ_1    </td></tr>
399 <tr class="markdownTableRowOdd">
400 <td class="markdownTableBodyNone">12   </td><td class="markdownTableBodyNone">DMA_IRQ_2    </td></tr>
401 <tr class="markdownTableRowEven">
402 <td class="markdownTableBodyNone">13   </td><td class="markdownTableBodyNone">DMA_IRQ_3    </td></tr>
403 <tr class="markdownTableRowOdd">
404 <td class="markdownTableBodyNone">14   </td><td class="markdownTableBodyNone">USBCTRL_IRQ    </td></tr>
405 <tr class="markdownTableRowEven">
406 <td class="markdownTableBodyNone">15   </td><td class="markdownTableBodyNone">PIO0_IRQ_0    </td></tr>
407 <tr class="markdownTableRowOdd">
408 <td class="markdownTableBodyNone">16   </td><td class="markdownTableBodyNone">PIO0_IRQ_1    </td></tr>
409 <tr class="markdownTableRowEven">
410 <td class="markdownTableBodyNone">17   </td><td class="markdownTableBodyNone">PIO1_IRQ_0    </td></tr>
411 <tr class="markdownTableRowOdd">
412 <td class="markdownTableBodyNone">18   </td><td class="markdownTableBodyNone">PIO1_IRQ_1    </td></tr>
413 <tr class="markdownTableRowEven">
414 <td class="markdownTableBodyNone">19   </td><td class="markdownTableBodyNone">PIO2_IRQ_0    </td></tr>
415 <tr class="markdownTableRowOdd">
416 <td class="markdownTableBodyNone">20   </td><td class="markdownTableBodyNone">PIO2_IRQ_1    </td></tr>
417 <tr class="markdownTableRowEven">
418 <td class="markdownTableBodyNone">21   </td><td class="markdownTableBodyNone">IO_IRQ_BANK0    </td></tr>
419 <tr class="markdownTableRowOdd">
420 <td class="markdownTableBodyNone">22   </td><td class="markdownTableBodyNone">IO_IRQ_BANK0_NS    </td></tr>
421 <tr class="markdownTableRowEven">
422 <td class="markdownTableBodyNone">23   </td><td class="markdownTableBodyNone">IO_IRQ_QSPI    </td></tr>
423 <tr class="markdownTableRowOdd">
424 <td class="markdownTableBodyNone">24   </td><td class="markdownTableBodyNone">IO_IRQ_QSPI_NS    </td></tr>
425 <tr class="markdownTableRowEven">
426 <td class="markdownTableBodyNone">25   </td><td class="markdownTableBodyNone">SIO_IRQ_FIFO    </td></tr>
427 <tr class="markdownTableRowOdd">
428 <td class="markdownTableBodyNone">26   </td><td class="markdownTableBodyNone">SIO_IRQ_BELL    </td></tr>
429 <tr class="markdownTableRowEven">
430 <td class="markdownTableBodyNone">27   </td><td class="markdownTableBodyNone">SIO_IRQ_FIFO_NS    </td></tr>
431 <tr class="markdownTableRowOdd">
432 <td class="markdownTableBodyNone">28   </td><td class="markdownTableBodyNone">SIO_IRQ_BELL_NS    </td></tr>
433 <tr class="markdownTableRowEven">
434 <td class="markdownTableBodyNone">29   </td><td class="markdownTableBodyNone">SIO_IRQ_MTIMECMP    </td></tr>
435 <tr class="markdownTableRowOdd">
436 <td class="markdownTableBodyNone">30   </td><td class="markdownTableBodyNone">CLOCKS_IRQ    </td></tr>
437 <tr class="markdownTableRowEven">
438 <td class="markdownTableBodyNone">31   </td><td class="markdownTableBodyNone">SPI0_IRQ    </td></tr>
439 <tr class="markdownTableRowOdd">
440 <td class="markdownTableBodyNone">32   </td><td class="markdownTableBodyNone">SPI1_IRQ    </td></tr>
441 <tr class="markdownTableRowEven">
442 <td class="markdownTableBodyNone">33   </td><td class="markdownTableBodyNone">UART0_IRQ    </td></tr>
443 <tr class="markdownTableRowOdd">
444 <td class="markdownTableBodyNone">34   </td><td class="markdownTableBodyNone">UART1_IRQ    </td></tr>
445 <tr class="markdownTableRowEven">
446 <td class="markdownTableBodyNone">35   </td><td class="markdownTableBodyNone">ADC_IRQ_FIFO    </td></tr>
447 <tr class="markdownTableRowOdd">
448 <td class="markdownTableBodyNone">36   </td><td class="markdownTableBodyNone">I2C0_IRQ    </td></tr>
449 <tr class="markdownTableRowEven">
450 <td class="markdownTableBodyNone">37   </td><td class="markdownTableBodyNone">I2C1_IRQ    </td></tr>
451 <tr class="markdownTableRowOdd">
452 <td class="markdownTableBodyNone">38   </td><td class="markdownTableBodyNone">OTP_IRQ    </td></tr>
453 <tr class="markdownTableRowEven">
454 <td class="markdownTableBodyNone">39   </td><td class="markdownTableBodyNone">TRNG_IRQ    </td></tr>
455 <tr class="markdownTableRowOdd">
456 <td class="markdownTableBodyNone">40   </td><td class="markdownTableBodyNone">PROC0_IRQ_CTI    </td></tr>
457 <tr class="markdownTableRowEven">
458 <td class="markdownTableBodyNone">41   </td><td class="markdownTableBodyNone">PROC1_IRQ_CTI    </td></tr>
459 <tr class="markdownTableRowOdd">
460 <td class="markdownTableBodyNone">42   </td><td class="markdownTableBodyNone">PLL_SYS_IRQ    </td></tr>
461 <tr class="markdownTableRowEven">
462 <td class="markdownTableBodyNone">43   </td><td class="markdownTableBodyNone">PLL_USB_IRQ    </td></tr>
463 <tr class="markdownTableRowOdd">
464 <td class="markdownTableBodyNone">44   </td><td class="markdownTableBodyNone">POWMAN_IRQ_POW    </td></tr>
465 <tr class="markdownTableRowEven">
466 <td class="markdownTableBodyNone">45   </td><td class="markdownTableBodyNone">POWMAN_IRQ_TIMER    </td></tr>
467 <tr class="markdownTableRowOdd">
468 <td class="markdownTableBodyNone">46   </td><td class="markdownTableBodyNone">SPAREIRQ_IRQ_0    </td></tr>
469 <tr class="markdownTableRowEven">
470 <td class="markdownTableBodyNone">47   </td><td class="markdownTableBodyNone">SPAREIRQ_IRQ_1    </td></tr>
471 <tr class="markdownTableRowOdd">
472 <td class="markdownTableBodyNone">48   </td><td class="markdownTableBodyNone">SPAREIRQ_IRQ_2    </td></tr>
473 <tr class="markdownTableRowEven">
474 <td class="markdownTableBodyNone">49   </td><td class="markdownTableBodyNone">SPAREIRQ_IRQ_3    </td></tr>
475 <tr class="markdownTableRowOdd">
476 <td class="markdownTableBodyNone">50   </td><td class="markdownTableBodyNone">SPAREIRQ_IRQ_4    </td></tr>
477 <tr class="markdownTableRowEven">
478 <td class="markdownTableBodyNone">51   </td><td class="markdownTableBodyNone">SPAREIRQ_IRQ_5   </td></tr>
479 </table>
480 <h2 class="groupheader">Typedef Documentation</h2>
481 <a id="ga8478ee26cc144e947ccd75b0169059a6" name="ga8478ee26cc144e947ccd75b0169059a6"></a>
482 <h2 class="memtitle"><span class="permalink"><a href="#ga8478ee26cc144e947ccd75b0169059a6">&#9670;&nbsp;</a></span>irq_handler_t</h2>
483
484 <div class="memitem">
485 <div class="memproto">
486       <table class="memname">
487         <tr>
488           <td class="memname">typedef void(* irq_handler_t) (void)</td>
489         </tr>
490       </table>
491 </div><div class="memdoc">
492
493 <p>Interrupt handler function type. </p>
494 <p >All interrupts handlers should be of this type, and follow normal ARM EABI register saving conventions </p>
495
496 </div>
497 </div>
498 <h2 class="groupheader">Enumeration Type Documentation</h2>
499 <a id="gaf4bf6b287c1a8445fce49ccaa711b3c3" name="gaf4bf6b287c1a8445fce49ccaa711b3c3"></a>
500 <h2 class="memtitle"><span class="permalink"><a href="#gaf4bf6b287c1a8445fce49ccaa711b3c3">&#9670;&nbsp;</a></span>irq_num_rp2040</h2>
501
502 <div class="memitem">
503 <div class="memproto">
504       <table class="memname">
505         <tr>
506           <td class="memname">enum <a class="el" href="group__hardware__irq.html#gaf4bf6b287c1a8445fce49ccaa711b3c3">irq_num_rp2040</a></td>
507         </tr>
508       </table>
509 </div><div class="memdoc">
510
511 <p>Interrupt numbers on RP2040 (used as typedef <a class="el" href="group__hardware__irq.html#gaf30862f51b5994ffd5863176a185d137">irq_num_t</a>) </p>
512 <table class="fieldtable">
513 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggaf4bf6b287c1a8445fce49ccaa711b3c3a9adcee3ff00b51d885e399d87fd6c957" name="ggaf4bf6b287c1a8445fce49ccaa711b3c3a9adcee3ff00b51d885e399d87fd6c957"></a>TIMER_IRQ_0&#160;</td><td class="fielddoc"><p >Select TIMER's IRQ 0 output. </p>
514 </td></tr>
515 <tr><td class="fieldname"><a id="ggaf4bf6b287c1a8445fce49ccaa711b3c3a4c240b6b48b410130cd2890ab04d560e" name="ggaf4bf6b287c1a8445fce49ccaa711b3c3a4c240b6b48b410130cd2890ab04d560e"></a>TIMER_IRQ_1&#160;</td><td class="fielddoc"><p >Select TIMER's IRQ 1 output. </p>
516 </td></tr>
517 <tr><td class="fieldname"><a id="ggaf4bf6b287c1a8445fce49ccaa711b3c3aff3b80e5739147626d9386b2a3b2953c" name="ggaf4bf6b287c1a8445fce49ccaa711b3c3aff3b80e5739147626d9386b2a3b2953c"></a>TIMER_IRQ_2&#160;</td><td class="fielddoc"><p >Select TIMER's IRQ 2 output. </p>
518 </td></tr>
519 <tr><td class="fieldname"><a id="ggaf4bf6b287c1a8445fce49ccaa711b3c3aa85dca1accc78d56c18c8a2c2e842b42" name="ggaf4bf6b287c1a8445fce49ccaa711b3c3aa85dca1accc78d56c18c8a2c2e842b42"></a>TIMER_IRQ_3&#160;</td><td class="fielddoc"><p >Select TIMER's IRQ 3 output. </p>
520 </td></tr>
521 <tr><td class="fieldname"><a id="ggaf4bf6b287c1a8445fce49ccaa711b3c3a0142d31049f55e027a88331ad70fa5aa" name="ggaf4bf6b287c1a8445fce49ccaa711b3c3a0142d31049f55e027a88331ad70fa5aa"></a>PWM_IRQ_WRAP&#160;</td><td class="fielddoc"><p >Select PWM's IRQ_WRAP output. </p>
522 </td></tr>
523 <tr><td class="fieldname"><a id="ggaf4bf6b287c1a8445fce49ccaa711b3c3a2cd42859a0101338a23d1687c6ff473c" name="ggaf4bf6b287c1a8445fce49ccaa711b3c3a2cd42859a0101338a23d1687c6ff473c"></a>USBCTRL_IRQ&#160;</td><td class="fielddoc"><p >Select USBCTRL's IRQ output. </p>
524 </td></tr>
525 <tr><td class="fieldname"><a id="ggaf4bf6b287c1a8445fce49ccaa711b3c3a76f444f019edf6356c9e64a1c2714b30" name="ggaf4bf6b287c1a8445fce49ccaa711b3c3a76f444f019edf6356c9e64a1c2714b30"></a>XIP_IRQ&#160;</td><td class="fielddoc"><p >Select XIP's IRQ output. </p>
526 </td></tr>
527 <tr><td class="fieldname"><a id="ggaf4bf6b287c1a8445fce49ccaa711b3c3a6a1531131ebf36cef68deb1b098c169e" name="ggaf4bf6b287c1a8445fce49ccaa711b3c3a6a1531131ebf36cef68deb1b098c169e"></a>PIO0_IRQ_0&#160;</td><td class="fielddoc"><p >Select PIO0's IRQ 0 output. </p>
528 </td></tr>
529 <tr><td class="fieldname"><a id="ggaf4bf6b287c1a8445fce49ccaa711b3c3a8342ee77067f98e1796e79d437093367" name="ggaf4bf6b287c1a8445fce49ccaa711b3c3a8342ee77067f98e1796e79d437093367"></a>PIO0_IRQ_1&#160;</td><td class="fielddoc"><p >Select PIO0's IRQ 1 output. </p>
530 </td></tr>
531 <tr><td class="fieldname"><a id="ggaf4bf6b287c1a8445fce49ccaa711b3c3a25729562658fcf2aa86e87e54617e7af" name="ggaf4bf6b287c1a8445fce49ccaa711b3c3a25729562658fcf2aa86e87e54617e7af"></a>PIO1_IRQ_0&#160;</td><td class="fielddoc"><p >Select PIO1's IRQ 0 output. </p>
532 </td></tr>
533 <tr><td class="fieldname"><a id="ggaf4bf6b287c1a8445fce49ccaa711b3c3a02a272c2eed06831563b441793eb4964" name="ggaf4bf6b287c1a8445fce49ccaa711b3c3a02a272c2eed06831563b441793eb4964"></a>PIO1_IRQ_1&#160;</td><td class="fielddoc"><p >Select PIO1's IRQ 1 output. </p>
534 </td></tr>
535 <tr><td class="fieldname"><a id="ggaf4bf6b287c1a8445fce49ccaa711b3c3a27c81947202be1166b90cd5fb6f482a0" name="ggaf4bf6b287c1a8445fce49ccaa711b3c3a27c81947202be1166b90cd5fb6f482a0"></a>DMA_IRQ_0&#160;</td><td class="fielddoc"><p >Select DMA's IRQ 0 output. </p>
536 </td></tr>
537 <tr><td class="fieldname"><a id="ggaf4bf6b287c1a8445fce49ccaa711b3c3a7b25577c8e3d3b1c4bab08eaed19b5ef" name="ggaf4bf6b287c1a8445fce49ccaa711b3c3a7b25577c8e3d3b1c4bab08eaed19b5ef"></a>DMA_IRQ_1&#160;</td><td class="fielddoc"><p >Select DMA's IRQ 1 output. </p>
538 </td></tr>
539 <tr><td class="fieldname"><a id="ggaf4bf6b287c1a8445fce49ccaa711b3c3ae9d0650a36de3bfbad6edc82a613d3c1" name="ggaf4bf6b287c1a8445fce49ccaa711b3c3ae9d0650a36de3bfbad6edc82a613d3c1"></a>IO_IRQ_BANK0&#160;</td><td class="fielddoc"><p >Select IO_BANK0's IRQ output. </p>
540 </td></tr>
541 <tr><td class="fieldname"><a id="ggaf4bf6b287c1a8445fce49ccaa711b3c3af5aa261b359dd160a1d8c3bc558ceb2b" name="ggaf4bf6b287c1a8445fce49ccaa711b3c3af5aa261b359dd160a1d8c3bc558ceb2b"></a>IO_IRQ_QSPI&#160;</td><td class="fielddoc"><p >Select IO_QSPI's IRQ output. </p>
542 </td></tr>
543 <tr><td class="fieldname"><a id="ggaf4bf6b287c1a8445fce49ccaa711b3c3a841acbddc6961252827d7645277452ec" name="ggaf4bf6b287c1a8445fce49ccaa711b3c3a841acbddc6961252827d7645277452ec"></a>SIO_IRQ_PROC0&#160;</td><td class="fielddoc"><p >Select SIO_PROC0's IRQ output. </p>
544 </td></tr>
545 <tr><td class="fieldname"><a id="ggaf4bf6b287c1a8445fce49ccaa711b3c3ae00819201c60acdf59448df5a08c11b5" name="ggaf4bf6b287c1a8445fce49ccaa711b3c3ae00819201c60acdf59448df5a08c11b5"></a>SIO_IRQ_PROC1&#160;</td><td class="fielddoc"><p >Select SIO_PROC1's IRQ output. </p>
546 </td></tr>
547 <tr><td class="fieldname"><a id="ggaf4bf6b287c1a8445fce49ccaa711b3c3a737a1db2a02502ed578e908b3b6796c2" name="ggaf4bf6b287c1a8445fce49ccaa711b3c3a737a1db2a02502ed578e908b3b6796c2"></a>CLOCKS_IRQ&#160;</td><td class="fielddoc"><p >Select CLOCKS's IRQ output. </p>
548 </td></tr>
549 <tr><td class="fieldname"><a id="ggaf4bf6b287c1a8445fce49ccaa711b3c3a10b2c78ee63a060db5d9f30b8f1daf8a" name="ggaf4bf6b287c1a8445fce49ccaa711b3c3a10b2c78ee63a060db5d9f30b8f1daf8a"></a>SPI0_IRQ&#160;</td><td class="fielddoc"><p >Select SPI0's IRQ output. </p>
550 </td></tr>
551 <tr><td class="fieldname"><a id="ggaf4bf6b287c1a8445fce49ccaa711b3c3a60f73b071388a649cac65d2026607540" name="ggaf4bf6b287c1a8445fce49ccaa711b3c3a60f73b071388a649cac65d2026607540"></a>SPI1_IRQ&#160;</td><td class="fielddoc"><p >Select SPI1's IRQ output. </p>
552 </td></tr>
553 <tr><td class="fieldname"><a id="ggaf4bf6b287c1a8445fce49ccaa711b3c3a504e54f28a2e2928bd6a1604ee0a24fb" name="ggaf4bf6b287c1a8445fce49ccaa711b3c3a504e54f28a2e2928bd6a1604ee0a24fb"></a>UART0_IRQ&#160;</td><td class="fielddoc"><p >Select UART0's IRQ output. </p>
554 </td></tr>
555 <tr><td class="fieldname"><a id="ggaf4bf6b287c1a8445fce49ccaa711b3c3a1062848ec5bc51fcdd58a95d40fc266b" name="ggaf4bf6b287c1a8445fce49ccaa711b3c3a1062848ec5bc51fcdd58a95d40fc266b"></a>UART1_IRQ&#160;</td><td class="fielddoc"><p >Select UART1's IRQ output. </p>
556 </td></tr>
557 <tr><td class="fieldname"><a id="ggaf4bf6b287c1a8445fce49ccaa711b3c3a80d34861619c6034c897e829aea93ed4" name="ggaf4bf6b287c1a8445fce49ccaa711b3c3a80d34861619c6034c897e829aea93ed4"></a>ADC_IRQ_FIFO&#160;</td><td class="fielddoc"><p >Select ADC's IRQ_FIFO output. </p>
558 </td></tr>
559 <tr><td class="fieldname"><a id="ggaf4bf6b287c1a8445fce49ccaa711b3c3ae54e6d9ba3c33888744c4ba77a7a4255" name="ggaf4bf6b287c1a8445fce49ccaa711b3c3ae54e6d9ba3c33888744c4ba77a7a4255"></a>I2C0_IRQ&#160;</td><td class="fielddoc"><p >Select I2C0's IRQ output. </p>
560 </td></tr>
561 <tr><td class="fieldname"><a id="ggaf4bf6b287c1a8445fce49ccaa711b3c3a3d4c9de91954651ee3dee7c066fc3db9" name="ggaf4bf6b287c1a8445fce49ccaa711b3c3a3d4c9de91954651ee3dee7c066fc3db9"></a>I2C1_IRQ&#160;</td><td class="fielddoc"><p >Select I2C1's IRQ output. </p>
562 </td></tr>
563 <tr><td class="fieldname"><a id="ggaf4bf6b287c1a8445fce49ccaa711b3c3a758d0e5253474a1224daa5eff0bdb5fc" name="ggaf4bf6b287c1a8445fce49ccaa711b3c3a758d0e5253474a1224daa5eff0bdb5fc"></a>RTC_IRQ&#160;</td><td class="fielddoc"><p >Select RTC's IRQ output. </p>
564 </td></tr>
565 </table>
566
567 </div>
568 </div>
569 <a id="ga876b9495995a81dff786f07a1975c3b8" name="ga876b9495995a81dff786f07a1975c3b8"></a>
570 <h2 class="memtitle"><span class="permalink"><a href="#ga876b9495995a81dff786f07a1975c3b8">&#9670;&nbsp;</a></span>irq_num_rp2350</h2>
571
572 <div class="memitem">
573 <div class="memproto">
574       <table class="memname">
575         <tr>
576           <td class="memname">enum <a class="el" href="group__hardware__irq.html#ga876b9495995a81dff786f07a1975c3b8">irq_num_rp2350</a></td>
577         </tr>
578       </table>
579 </div><div class="memdoc">
580
581 <p>Interrupt numbers on RP2350 (used as typedef <a class="el" href="group__hardware__irq.html#gaf30862f51b5994ffd5863176a185d137">irq_num_t</a>) </p>
582 <table class="fieldtable">
583 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a8aefc9b5ce0307f2983c7cfe9cfcee0e" name="gga876b9495995a81dff786f07a1975c3b8a8aefc9b5ce0307f2983c7cfe9cfcee0e"></a>TIMER0_IRQ_0&#160;</td><td class="fielddoc"><p >Select TIMER0's IRQ 0 output. </p>
584 </td></tr>
585 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a5b912fdba3cd93427d74b8ef527d980f" name="gga876b9495995a81dff786f07a1975c3b8a5b912fdba3cd93427d74b8ef527d980f"></a>TIMER0_IRQ_1&#160;</td><td class="fielddoc"><p >Select TIMER0's IRQ 1 output. </p>
586 </td></tr>
587 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a959d2d69aa10978b36fb4fbecc77a465" name="gga876b9495995a81dff786f07a1975c3b8a959d2d69aa10978b36fb4fbecc77a465"></a>TIMER0_IRQ_2&#160;</td><td class="fielddoc"><p >Select TIMER0's IRQ 2 output. </p>
588 </td></tr>
589 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a021f4aa1758af47eb23298196e1f22c5" name="gga876b9495995a81dff786f07a1975c3b8a021f4aa1758af47eb23298196e1f22c5"></a>TIMER0_IRQ_3&#160;</td><td class="fielddoc"><p >Select TIMER0's IRQ 3 output. </p>
590 </td></tr>
591 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a4ba1f242076b28a4217181e0f65896ec" name="gga876b9495995a81dff786f07a1975c3b8a4ba1f242076b28a4217181e0f65896ec"></a>TIMER1_IRQ_0&#160;</td><td class="fielddoc"><p >Select TIMER1's IRQ 0 output. </p>
592 </td></tr>
593 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a757d218b48843638d3f8f45fa6fd48f9" name="gga876b9495995a81dff786f07a1975c3b8a757d218b48843638d3f8f45fa6fd48f9"></a>TIMER1_IRQ_1&#160;</td><td class="fielddoc"><p >Select TIMER1's IRQ 1 output. </p>
594 </td></tr>
595 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a156a0e9cbc66e4ce56dfb52d09d86858" name="gga876b9495995a81dff786f07a1975c3b8a156a0e9cbc66e4ce56dfb52d09d86858"></a>TIMER1_IRQ_2&#160;</td><td class="fielddoc"><p >Select TIMER1's IRQ 2 output. </p>
596 </td></tr>
597 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8af2fb391af7b873b5268e3824068d08c0" name="gga876b9495995a81dff786f07a1975c3b8af2fb391af7b873b5268e3824068d08c0"></a>TIMER1_IRQ_3&#160;</td><td class="fielddoc"><p >Select TIMER1's IRQ 3 output. </p>
598 </td></tr>
599 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8ab95e3cb2a0db0f078b2f51d43d6f0221" name="gga876b9495995a81dff786f07a1975c3b8ab95e3cb2a0db0f078b2f51d43d6f0221"></a>PWM_IRQ_WRAP_0&#160;</td><td class="fielddoc"><p >Select PWM's IRQ_WRAP 0 output. </p>
600 </td></tr>
601 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a9b21deae090eb8ab1c69eaa4dd71572f" name="gga876b9495995a81dff786f07a1975c3b8a9b21deae090eb8ab1c69eaa4dd71572f"></a>PWM_IRQ_WRAP_1&#160;</td><td class="fielddoc"><p >Select PWM's IRQ_WRAP 1 output. </p>
602 </td></tr>
603 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a27c81947202be1166b90cd5fb6f482a0" name="gga876b9495995a81dff786f07a1975c3b8a27c81947202be1166b90cd5fb6f482a0"></a>DMA_IRQ_0&#160;</td><td class="fielddoc"><p >Select DMA's IRQ 0 output. </p>
604 </td></tr>
605 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a7b25577c8e3d3b1c4bab08eaed19b5ef" name="gga876b9495995a81dff786f07a1975c3b8a7b25577c8e3d3b1c4bab08eaed19b5ef"></a>DMA_IRQ_1&#160;</td><td class="fielddoc"><p >Select DMA's IRQ 1 output. </p>
606 </td></tr>
607 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8aa05c818a7b9a97853fced4be9a9b0955" name="gga876b9495995a81dff786f07a1975c3b8aa05c818a7b9a97853fced4be9a9b0955"></a>DMA_IRQ_2&#160;</td><td class="fielddoc"><p >Select DMA's IRQ 2 output. </p>
608 </td></tr>
609 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a2852a4ce8747ec1b0ece265c3d681ad4" name="gga876b9495995a81dff786f07a1975c3b8a2852a4ce8747ec1b0ece265c3d681ad4"></a>DMA_IRQ_3&#160;</td><td class="fielddoc"><p >Select DMA's IRQ 3 output. </p>
610 </td></tr>
611 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a2cd42859a0101338a23d1687c6ff473c" name="gga876b9495995a81dff786f07a1975c3b8a2cd42859a0101338a23d1687c6ff473c"></a>USBCTRL_IRQ&#160;</td><td class="fielddoc"><p >Select USBCTRL's IRQ output. </p>
612 </td></tr>
613 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a6a1531131ebf36cef68deb1b098c169e" name="gga876b9495995a81dff786f07a1975c3b8a6a1531131ebf36cef68deb1b098c169e"></a>PIO0_IRQ_0&#160;</td><td class="fielddoc"><p >Select PIO0's IRQ 0 output. </p>
614 </td></tr>
615 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a8342ee77067f98e1796e79d437093367" name="gga876b9495995a81dff786f07a1975c3b8a8342ee77067f98e1796e79d437093367"></a>PIO0_IRQ_1&#160;</td><td class="fielddoc"><p >Select PIO0's IRQ 1 output. </p>
616 </td></tr>
617 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a25729562658fcf2aa86e87e54617e7af" name="gga876b9495995a81dff786f07a1975c3b8a25729562658fcf2aa86e87e54617e7af"></a>PIO1_IRQ_0&#160;</td><td class="fielddoc"><p >Select PIO1's IRQ 0 output. </p>
618 </td></tr>
619 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a02a272c2eed06831563b441793eb4964" name="gga876b9495995a81dff786f07a1975c3b8a02a272c2eed06831563b441793eb4964"></a>PIO1_IRQ_1&#160;</td><td class="fielddoc"><p >Select PIO1's IRQ 1 output. </p>
620 </td></tr>
621 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a6a797ac81319a12d8f727b0df3bf4b45" name="gga876b9495995a81dff786f07a1975c3b8a6a797ac81319a12d8f727b0df3bf4b45"></a>PIO2_IRQ_0&#160;</td><td class="fielddoc"><p >Select PIO2's IRQ 0 output. </p>
622 </td></tr>
623 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8aeaaf6372e890b298cab2d23ccf6b7e25" name="gga876b9495995a81dff786f07a1975c3b8aeaaf6372e890b298cab2d23ccf6b7e25"></a>PIO2_IRQ_1&#160;</td><td class="fielddoc"><p >Select PIO2's IRQ 1 output. </p>
624 </td></tr>
625 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8ae9d0650a36de3bfbad6edc82a613d3c1" name="gga876b9495995a81dff786f07a1975c3b8ae9d0650a36de3bfbad6edc82a613d3c1"></a>IO_IRQ_BANK0&#160;</td><td class="fielddoc"><p >Select IO_BANK0's IRQ output. </p>
626 </td></tr>
627 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a8cfea98eab080d57d60d751d78b9397d" name="gga876b9495995a81dff786f07a1975c3b8a8cfea98eab080d57d60d751d78b9397d"></a>IO_IRQ_BANK0_NS&#160;</td><td class="fielddoc"><p >Select IO_BANK0_NS's IRQ output. </p>
628 </td></tr>
629 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8af5aa261b359dd160a1d8c3bc558ceb2b" name="gga876b9495995a81dff786f07a1975c3b8af5aa261b359dd160a1d8c3bc558ceb2b"></a>IO_IRQ_QSPI&#160;</td><td class="fielddoc"><p >Select IO_QSPI's IRQ output. </p>
630 </td></tr>
631 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8ac2d22291df1fa6859d5c86ba7eae9018" name="gga876b9495995a81dff786f07a1975c3b8ac2d22291df1fa6859d5c86ba7eae9018"></a>IO_IRQ_QSPI_NS&#160;</td><td class="fielddoc"><p >Select IO_QSPI_NS's IRQ output. </p>
632 </td></tr>
633 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8afe8f5a1a66b8b6c489a8fb3bb618815f" name="gga876b9495995a81dff786f07a1975c3b8afe8f5a1a66b8b6c489a8fb3bb618815f"></a>SIO_IRQ_FIFO&#160;</td><td class="fielddoc"><p >Select SIO's IRQ_FIFO output. </p>
634 </td></tr>
635 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8abee4ee8eee7b960d0cf734578ffef811" name="gga876b9495995a81dff786f07a1975c3b8abee4ee8eee7b960d0cf734578ffef811"></a>SIO_IRQ_BELL&#160;</td><td class="fielddoc"><p >Select SIO's IRQ_BELL output. </p>
636 </td></tr>
637 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a2bcf85572bb5a5f53ec4444798261541" name="gga876b9495995a81dff786f07a1975c3b8a2bcf85572bb5a5f53ec4444798261541"></a>SIO_IRQ_FIFO_NS&#160;</td><td class="fielddoc"><p >Select SIO_NS's IRQ_FIFO output. </p>
638 </td></tr>
639 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a72f9b9916df889c0a55731b3a51b8e05" name="gga876b9495995a81dff786f07a1975c3b8a72f9b9916df889c0a55731b3a51b8e05"></a>SIO_IRQ_BELL_NS&#160;</td><td class="fielddoc"><p >Select SIO_NS's IRQ_BELL output. </p>
640 </td></tr>
641 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a750e73e82e614dff437a37149bd59eb1" name="gga876b9495995a81dff786f07a1975c3b8a750e73e82e614dff437a37149bd59eb1"></a>SIO_IRQ_MTIMECMP&#160;</td><td class="fielddoc"><p >Select SIO_IRQ_MTIMECMP's IRQ output. </p>
642 </td></tr>
643 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a737a1db2a02502ed578e908b3b6796c2" name="gga876b9495995a81dff786f07a1975c3b8a737a1db2a02502ed578e908b3b6796c2"></a>CLOCKS_IRQ&#160;</td><td class="fielddoc"><p >Select CLOCKS's IRQ output. </p>
644 </td></tr>
645 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a10b2c78ee63a060db5d9f30b8f1daf8a" name="gga876b9495995a81dff786f07a1975c3b8a10b2c78ee63a060db5d9f30b8f1daf8a"></a>SPI0_IRQ&#160;</td><td class="fielddoc"><p >Select SPI0's IRQ output. </p>
646 </td></tr>
647 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a60f73b071388a649cac65d2026607540" name="gga876b9495995a81dff786f07a1975c3b8a60f73b071388a649cac65d2026607540"></a>SPI1_IRQ&#160;</td><td class="fielddoc"><p >Select SPI1's IRQ output. </p>
648 </td></tr>
649 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a504e54f28a2e2928bd6a1604ee0a24fb" name="gga876b9495995a81dff786f07a1975c3b8a504e54f28a2e2928bd6a1604ee0a24fb"></a>UART0_IRQ&#160;</td><td class="fielddoc"><p >Select UART0's IRQ output. </p>
650 </td></tr>
651 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a1062848ec5bc51fcdd58a95d40fc266b" name="gga876b9495995a81dff786f07a1975c3b8a1062848ec5bc51fcdd58a95d40fc266b"></a>UART1_IRQ&#160;</td><td class="fielddoc"><p >Select UART1's IRQ output. </p>
652 </td></tr>
653 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a80d34861619c6034c897e829aea93ed4" name="gga876b9495995a81dff786f07a1975c3b8a80d34861619c6034c897e829aea93ed4"></a>ADC_IRQ_FIFO&#160;</td><td class="fielddoc"><p >Select ADC's IRQ_FIFO output. </p>
654 </td></tr>
655 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8ae54e6d9ba3c33888744c4ba77a7a4255" name="gga876b9495995a81dff786f07a1975c3b8ae54e6d9ba3c33888744c4ba77a7a4255"></a>I2C0_IRQ&#160;</td><td class="fielddoc"><p >Select I2C0's IRQ output. </p>
656 </td></tr>
657 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a3d4c9de91954651ee3dee7c066fc3db9" name="gga876b9495995a81dff786f07a1975c3b8a3d4c9de91954651ee3dee7c066fc3db9"></a>I2C1_IRQ&#160;</td><td class="fielddoc"><p >Select I2C1's IRQ output. </p>
658 </td></tr>
659 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a2ef9df4ccdeb630d832d6d2b076586b6" name="gga876b9495995a81dff786f07a1975c3b8a2ef9df4ccdeb630d832d6d2b076586b6"></a>OTP_IRQ&#160;</td><td class="fielddoc"><p >Select OTP's IRQ output. </p>
660 </td></tr>
661 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8aeef89f7a46f31d1ce96fd0f6328b78c8" name="gga876b9495995a81dff786f07a1975c3b8aeef89f7a46f31d1ce96fd0f6328b78c8"></a>TRNG_IRQ&#160;</td><td class="fielddoc"><p >Select TRNG's IRQ output. </p>
662 </td></tr>
663 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a0ed6df37fc7086fc72331ac64d5abcf0" name="gga876b9495995a81dff786f07a1975c3b8a0ed6df37fc7086fc72331ac64d5abcf0"></a>PROC0_IRQ_CTI&#160;</td><td class="fielddoc"><p >Select PROC0's IRQ_CTI output. </p>
664 </td></tr>
665 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8af8101a6cce54937f4af39f3c27a2fe6d" name="gga876b9495995a81dff786f07a1975c3b8af8101a6cce54937f4af39f3c27a2fe6d"></a>PROC1_IRQ_CTI&#160;</td><td class="fielddoc"><p >Select PROC1's IRQ_CTI output. </p>
666 </td></tr>
667 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a946ceb547b06cf725bcdc28171249d5a" name="gga876b9495995a81dff786f07a1975c3b8a946ceb547b06cf725bcdc28171249d5a"></a>PLL_SYS_IRQ&#160;</td><td class="fielddoc"><p >Select PLL_SYS's IRQ output. </p>
668 </td></tr>
669 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a875f153be03e06f3da74de8ed802ae12" name="gga876b9495995a81dff786f07a1975c3b8a875f153be03e06f3da74de8ed802ae12"></a>PLL_USB_IRQ&#160;</td><td class="fielddoc"><p >Select PLL_USB's IRQ output. </p>
670 </td></tr>
671 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8ac30f13a1f91cc090fdb619028183ad0e" name="gga876b9495995a81dff786f07a1975c3b8ac30f13a1f91cc090fdb619028183ad0e"></a>POWMAN_IRQ_POW&#160;</td><td class="fielddoc"><p >Select POWMAN's IRQ_POW output. </p>
672 </td></tr>
673 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a803d6485cd5cc1737bbaa006eb30e0f8" name="gga876b9495995a81dff786f07a1975c3b8a803d6485cd5cc1737bbaa006eb30e0f8"></a>POWMAN_IRQ_TIMER&#160;</td><td class="fielddoc"><p >Select POWMAN's IRQ_TIMER output. </p>
674 </td></tr>
675 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8aad3052d1d06b983df4551cd9ddd739ae" name="gga876b9495995a81dff786f07a1975c3b8aad3052d1d06b983df4551cd9ddd739ae"></a>SPARE_IRQ_0&#160;</td><td class="fielddoc"><p >Select SPARE IRQ 0. </p>
676 </td></tr>
677 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a1db065c3095a5f7f4c08becc89cc146e" name="gga876b9495995a81dff786f07a1975c3b8a1db065c3095a5f7f4c08becc89cc146e"></a>SPARE_IRQ_1&#160;</td><td class="fielddoc"><p >Select SPARE IRQ 1. </p>
678 </td></tr>
679 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a8632f943b2645a064df4b4f32be6cfb4" name="gga876b9495995a81dff786f07a1975c3b8a8632f943b2645a064df4b4f32be6cfb4"></a>SPARE_IRQ_2&#160;</td><td class="fielddoc"><p >Select SPARE IRQ 2. </p>
680 </td></tr>
681 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8a37d25d9bef6f9987f6f0acd1199fdd06" name="gga876b9495995a81dff786f07a1975c3b8a37d25d9bef6f9987f6f0acd1199fdd06"></a>SPARE_IRQ_3&#160;</td><td class="fielddoc"><p >Select SPARE IRQ 3. </p>
682 </td></tr>
683 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8ae1e37d639062c9f84055a9137fc29870" name="gga876b9495995a81dff786f07a1975c3b8ae1e37d639062c9f84055a9137fc29870"></a>SPARE_IRQ_4&#160;</td><td class="fielddoc"><p >Select SPARE IRQ 4. </p>
684 </td></tr>
685 <tr><td class="fieldname"><a id="gga876b9495995a81dff786f07a1975c3b8af00c937dd1333d2fa5e52d906dd7529b" name="gga876b9495995a81dff786f07a1975c3b8af00c937dd1333d2fa5e52d906dd7529b"></a>SPARE_IRQ_5&#160;</td><td class="fielddoc"><p >Select SPARE IRQ 5. </p>
686 </td></tr>
687 </table>
688
689 </div>
690 </div>
691 <h2 class="groupheader">Function Documentation</h2>
692 <a id="gaf02f8599896c66f4579c845a96b2126e" name="gaf02f8599896c66f4579c845a96b2126e"></a>
693 <h2 class="memtitle"><span class="permalink"><a href="#gaf02f8599896c66f4579c845a96b2126e">&#9670;&nbsp;</a></span>irq_add_shared_handler()</h2>
694
695 <div class="memitem">
696 <div class="memproto">
697       <table class="memname">
698         <tr>
699           <td class="memname">void irq_add_shared_handler </td>
700           <td>(</td>
701           <td class="paramtype">uint&#160;</td>
702           <td class="paramname"><em>num</em>, </td>
703         </tr>
704         <tr>
705           <td class="paramkey"></td>
706           <td></td>
707           <td class="paramtype"><a class="el" href="group__hardware__irq.html#ga8478ee26cc144e947ccd75b0169059a6">irq_handler_t</a>&#160;</td>
708           <td class="paramname"><em>handler</em>, </td>
709         </tr>
710         <tr>
711           <td class="paramkey"></td>
712           <td></td>
713           <td class="paramtype">uint8_t&#160;</td>
714           <td class="paramname"><em>order_priority</em>&#160;</td>
715         </tr>
716         <tr>
717           <td></td>
718           <td>)</td>
719           <td></td><td></td>
720         </tr>
721       </table>
722 </div><div class="memdoc">
723
724 <p>Add a shared interrupt handler for an interrupt on the executing core. </p>
725 <p >Use this method to add a handler on an irq number shared between multiple distinct hardware sources (e.g. GPIO, DMA or PIO IRQs). Handlers added by this method will all be called in sequence from highest order_priority to lowest. The <a class="el" href="group__hardware__irq.html#gafffd448ba2d2eef5b355b88180aefe7f" title="Set an exclusive interrupt handler for an interrupt on the executing core.">irq_set_exclusive_handler()</a> method should be used instead if you know there will or should only ever be one handler for the interrupt.</p>
726 <p >This method will assert if there is an exclusive interrupt handler set for this irq number on this core, or if the (total across all IRQs on both cores) maximum (configurable via PICO_MAX_SHARED_IRQ_HANDLERS) number of shared handlers would be exceeded.</p>
727 <dl class="params"><dt>Parameters</dt><dd>
728   <table class="params">
729     <tr><td class="paramname">num</td><td>Interrupt number <a class="el" href="group__hardware__irq.html#interrupt_nums">Interrupt Numbers</a> </td></tr>
730     <tr><td class="paramname">handler</td><td>The handler to set. See <a class="el" href="group__hardware__irq.html#ga8478ee26cc144e947ccd75b0169059a6">irq_handler_t</a> </td></tr>
731     <tr><td class="paramname">order_priority</td><td>The order priority controls the order that handlers for the same IRQ number on the core are called. The shared irq handlers for an interrupt are all called when an IRQ fires, however the order of the calls is based on the order_priority (higher priorities are called first, identical priorities are called in undefined order). A good rule of thumb is to use PICO_SHARED_IRQ_HANDLER_DEFAULT_ORDER_PRIORITY if you don't much care, as it is in the middle of the priority range by default.</td></tr>
732   </table>
733   </dd>
734 </dl>
735 <dl class="section note"><dt>Note</dt><dd>The order_priority uses <em>higher</em> values for higher priorities which is the <em>opposite</em> of the CPU interrupt priorities passed to <a class="el" href="group__hardware__irq.html#gad11ea172f11d9763647ac34b366ab3c2" title="Set specified interrupt&#39;s priority.">irq_set_priority()</a> which use lower values for higher priorities.</dd></dl>
736 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__hardware__irq.html#gafffd448ba2d2eef5b355b88180aefe7f" title="Set an exclusive interrupt handler for an interrupt on the executing core.">irq_set_exclusive_handler()</a> </dd></dl>
737
738 </div>
739 </div>
740 <a id="ga14fa98b8bec09df3e7409a75cf2f5359" name="ga14fa98b8bec09df3e7409a75cf2f5359"></a>
741 <h2 class="memtitle"><span class="permalink"><a href="#ga14fa98b8bec09df3e7409a75cf2f5359">&#9670;&nbsp;</a></span>irq_clear()</h2>
742
743 <div class="memitem">
744 <div class="memproto">
745 <table class="mlabels">
746   <tr>
747   <td class="mlabels-left">
748       <table class="memname">
749         <tr>
750           <td class="memname">static void irq_clear </td>
751           <td>(</td>
752           <td class="paramtype">uint&#160;</td>
753           <td class="paramname"><em>int_num</em></td><td>)</td>
754           <td></td>
755         </tr>
756       </table>
757   </td>
758   <td class="mlabels-right">
759 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
760   </tr>
761 </table>
762 </div><div class="memdoc">
763
764 <p>Clear a specific interrupt on the executing core. </p>
765 <p >This method is only useful for "software" IRQs that are not connected to hardware (e.g. IRQs 26-31 on RP2040) as the the NVIC always reflects the current state of the IRQ state of the hardware for hardware IRQs, and clearing of the IRQ state of the hardware is performed via the hardware's registers instead.</p>
766 <dl class="params"><dt>Parameters</dt><dd>
767   <table class="params">
768     <tr><td class="paramname">int_num</td><td>Interrupt number <a class="el" href="group__hardware__irq.html#interrupt_nums">Interrupt Numbers</a> </td></tr>
769   </table>
770   </dd>
771 </dl>
772
773 </div>
774 </div>
775 <a id="ga42e9cdce7b82ef63c7b2416d32a42361" name="ga42e9cdce7b82ef63c7b2416d32a42361"></a>
776 <h2 class="memtitle"><span class="permalink"><a href="#ga42e9cdce7b82ef63c7b2416d32a42361">&#9670;&nbsp;</a></span>irq_get_exclusive_handler()</h2>
777
778 <div class="memitem">
779 <div class="memproto">
780       <table class="memname">
781         <tr>
782           <td class="memname"><a class="el" href="group__hardware__irq.html#ga8478ee26cc144e947ccd75b0169059a6">irq_handler_t</a> irq_get_exclusive_handler </td>
783           <td>(</td>
784           <td class="paramtype">uint&#160;</td>
785           <td class="paramname"><em>num</em></td><td>)</td>
786           <td></td>
787         </tr>
788       </table>
789 </div><div class="memdoc">
790
791 <p>Get the exclusive interrupt handler for an interrupt on the executing core. </p>
792 <p >This method will return an exclusive IRQ handler set on this core by irq_set_exclusive_handler if there is one.</p>
793 <dl class="params"><dt>Parameters</dt><dd>
794   <table class="params">
795     <tr><td class="paramname">num</td><td>Interrupt number <a class="el" href="group__hardware__irq.html#interrupt_nums">Interrupt Numbers</a> </td></tr>
796   </table>
797   </dd>
798 </dl>
799 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__hardware__irq.html#gafffd448ba2d2eef5b355b88180aefe7f" title="Set an exclusive interrupt handler for an interrupt on the executing core.">irq_set_exclusive_handler()</a> </dd></dl>
800 <dl class="section return"><dt>Returns</dt><dd>handler The handler if an exclusive handler is set for the IRQ, NULL if no handler is set or shared/shareable handlers are installed </dd></dl>
801
802 </div>
803 </div>
804 <a id="ga6bcde7d99ca71abe8dccfd13b4d80b29" name="ga6bcde7d99ca71abe8dccfd13b4d80b29"></a>
805 <h2 class="memtitle"><span class="permalink"><a href="#ga6bcde7d99ca71abe8dccfd13b4d80b29">&#9670;&nbsp;</a></span>irq_get_priority()</h2>
806
807 <div class="memitem">
808 <div class="memproto">
809       <table class="memname">
810         <tr>
811           <td class="memname">uint irq_get_priority </td>
812           <td>(</td>
813           <td class="paramtype">uint&#160;</td>
814           <td class="paramname"><em>num</em></td><td>)</td>
815           <td></td>
816         </tr>
817       </table>
818 </div><div class="memdoc">
819
820 <p>Get specified interrupt's priority. </p>
821 <p >Numerically-lower values indicate a higher priority. Hardware priorities range from 0 (highest priority) to 255 (lowest priority). To make it easier to specify higher or lower priorities than the default, all IRQ priorities are initialized to PICO_DEFAULT_IRQ_PRIORITY by the SDK runtime at startup. PICO_DEFAULT_IRQ_PRIORITY defaults to 0x80</p>
822 <p >Only the top 2 bits are significant on ARM Cortex-M0+ on RP2040. </p>
823 <p >Only the top 4 bits are significant on ARM Cortex-M33 or Hazard3 (RISC-V) on RP2350. Note that this API uses the same (inverted) ordering as ARM on RISC-V </p>
824 <dl class="params"><dt>Parameters</dt><dd>
825   <table class="params">
826     <tr><td class="paramname">num</td><td>Interrupt number <a class="el" href="group__hardware__irq.html#interrupt_nums">Interrupt Numbers</a> </td></tr>
827   </table>
828   </dd>
829 </dl>
830 <dl class="section return"><dt>Returns</dt><dd>the IRQ priority </dd></dl>
831
832 </div>
833 </div>
834 <a id="ga4f9772d9d1781c3a28371623886a0310" name="ga4f9772d9d1781c3a28371623886a0310"></a>
835 <h2 class="memtitle"><span class="permalink"><a href="#ga4f9772d9d1781c3a28371623886a0310">&#9670;&nbsp;</a></span>irq_get_vtable_handler()</h2>
836
837 <div class="memitem">
838 <div class="memproto">
839       <table class="memname">
840         <tr>
841           <td class="memname"><a class="el" href="group__hardware__irq.html#ga8478ee26cc144e947ccd75b0169059a6">irq_handler_t</a> irq_get_vtable_handler </td>
842           <td>(</td>
843           <td class="paramtype">uint&#160;</td>
844           <td class="paramname"><em>num</em></td><td>)</td>
845           <td></td>
846         </tr>
847       </table>
848 </div><div class="memdoc">
849
850 <p>Get the current IRQ handler for the specified IRQ from the currently installed hardware vector table (VTOR) of the execution core. </p>
851 <dl class="params"><dt>Parameters</dt><dd>
852   <table class="params">
853     <tr><td class="paramname">num</td><td>Interrupt number <a class="el" href="group__hardware__irq.html#interrupt_nums">Interrupt Numbers</a> </td></tr>
854   </table>
855   </dd>
856 </dl>
857 <dl class="section return"><dt>Returns</dt><dd>the address stored in the VTABLE for the given irq number </dd></dl>
858
859 </div>
860 </div>
861 <a id="gae552cab9da1b37a785791f678090f418" name="gae552cab9da1b37a785791f678090f418"></a>
862 <h2 class="memtitle"><span class="permalink"><a href="#gae552cab9da1b37a785791f678090f418">&#9670;&nbsp;</a></span>irq_has_shared_handler()</h2>
863
864 <div class="memitem">
865 <div class="memproto">
866       <table class="memname">
867         <tr>
868           <td class="memname">bool irq_has_shared_handler </td>
869           <td>(</td>
870           <td class="paramtype">uint&#160;</td>
871           <td class="paramname"><em>num</em></td><td>)</td>
872           <td></td>
873         </tr>
874       </table>
875 </div><div class="memdoc">
876
877 <p>Determine if the current handler for the given number is shared. </p>
878 <dl class="params"><dt>Parameters</dt><dd>
879   <table class="params">
880     <tr><td class="paramname">num</td><td>Interrupt number <a class="el" href="group__hardware__irq.html#interrupt_nums">Interrupt Numbers</a> </td></tr>
881   </table>
882   </dd>
883 </dl>
884 <dl class="section return"><dt>Returns</dt><dd>true if the specified IRQ has a shared handler </dd></dl>
885
886 </div>
887 </div>
888 <a id="ga0c54ae4c0593c2a8596b99cd167584e0" name="ga0c54ae4c0593c2a8596b99cd167584e0"></a>
889 <h2 class="memtitle"><span class="permalink"><a href="#ga0c54ae4c0593c2a8596b99cd167584e0">&#9670;&nbsp;</a></span>irq_is_enabled()</h2>
890
891 <div class="memitem">
892 <div class="memproto">
893       <table class="memname">
894         <tr>
895           <td class="memname">bool irq_is_enabled </td>
896           <td>(</td>
897           <td class="paramtype">uint&#160;</td>
898           <td class="paramname"><em>num</em></td><td>)</td>
899           <td></td>
900         </tr>
901       </table>
902 </div><div class="memdoc">
903
904 <p>Determine if a specific interrupt is enabled on the executing core. </p>
905 <dl class="params"><dt>Parameters</dt><dd>
906   <table class="params">
907     <tr><td class="paramname">num</td><td>Interrupt number <a class="el" href="group__hardware__irq.html#interrupt_nums">Interrupt Numbers</a> </td></tr>
908   </table>
909   </dd>
910 </dl>
911 <dl class="section return"><dt>Returns</dt><dd>true if the interrupt is enabled </dd></dl>
912
913 </div>
914 </div>
915 <a id="gadfd3308952d41ee91671ae098b867a90" name="gadfd3308952d41ee91671ae098b867a90"></a>
916 <h2 class="memtitle"><span class="permalink"><a href="#gadfd3308952d41ee91671ae098b867a90">&#9670;&nbsp;</a></span>irq_remove_handler()</h2>
917
918 <div class="memitem">
919 <div class="memproto">
920       <table class="memname">
921         <tr>
922           <td class="memname">void irq_remove_handler </td>
923           <td>(</td>
924           <td class="paramtype">uint&#160;</td>
925           <td class="paramname"><em>num</em>, </td>
926         </tr>
927         <tr>
928           <td class="paramkey"></td>
929           <td></td>
930           <td class="paramtype"><a class="el" href="group__hardware__irq.html#ga8478ee26cc144e947ccd75b0169059a6">irq_handler_t</a>&#160;</td>
931           <td class="paramname"><em>handler</em>&#160;</td>
932         </tr>
933         <tr>
934           <td></td>
935           <td>)</td>
936           <td></td><td></td>
937         </tr>
938       </table>
939 </div><div class="memdoc">
940
941 <p>Remove a specific interrupt handler for the given irq number on the executing core. </p>
942 <p >This method may be used to remove an irq set via either <a class="el" href="group__hardware__irq.html#gafffd448ba2d2eef5b355b88180aefe7f" title="Set an exclusive interrupt handler for an interrupt on the executing core.">irq_set_exclusive_handler()</a> or <a class="el" href="group__hardware__irq.html#gaf02f8599896c66f4579c845a96b2126e" title="Add a shared interrupt handler for an interrupt on the executing core.">irq_add_shared_handler()</a>, and will assert if the handler is not currently installed for the given IRQ number</p>
943 <dl class="section note"><dt>Note</dt><dd>This method may <em>only</em> be called from user (non IRQ code) or from within the handler itself (i.e. an IRQ handler may remove itself as part of handling the IRQ). Attempts to call from another IRQ will cause an assertion.</dd></dl>
944 <dl class="params"><dt>Parameters</dt><dd>
945   <table class="params">
946     <tr><td class="paramname">num</td><td>Interrupt number <a class="el" href="group__hardware__irq.html#interrupt_nums">Interrupt Numbers</a> </td></tr>
947     <tr><td class="paramname">handler</td><td>The handler to removed. </td></tr>
948   </table>
949   </dd>
950 </dl>
951 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__hardware__irq.html#gafffd448ba2d2eef5b355b88180aefe7f" title="Set an exclusive interrupt handler for an interrupt on the executing core.">irq_set_exclusive_handler()</a> </dd>
952 <dd>
953 <a class="el" href="group__hardware__irq.html#gaf02f8599896c66f4579c845a96b2126e" title="Add a shared interrupt handler for an interrupt on the executing core.">irq_add_shared_handler()</a> </dd></dl>
954
955 </div>
956 </div>
957 <a id="ga7c7167f643c6898b758340ce59d333d9" name="ga7c7167f643c6898b758340ce59d333d9"></a>
958 <h2 class="memtitle"><span class="permalink"><a href="#ga7c7167f643c6898b758340ce59d333d9">&#9670;&nbsp;</a></span>irq_set_enabled()</h2>
959
960 <div class="memitem">
961 <div class="memproto">
962       <table class="memname">
963         <tr>
964           <td class="memname">void irq_set_enabled </td>
965           <td>(</td>
966           <td class="paramtype">uint&#160;</td>
967           <td class="paramname"><em>num</em>, </td>
968         </tr>
969         <tr>
970           <td class="paramkey"></td>
971           <td></td>
972           <td class="paramtype">bool&#160;</td>
973           <td class="paramname"><em>enabled</em>&#160;</td>
974         </tr>
975         <tr>
976           <td></td>
977           <td>)</td>
978           <td></td><td></td>
979         </tr>
980       </table>
981 </div><div class="memdoc">
982
983 <p>Enable or disable a specific interrupt on the executing core. </p>
984 <dl class="params"><dt>Parameters</dt><dd>
985   <table class="params">
986     <tr><td class="paramname">num</td><td>Interrupt number <a class="el" href="group__hardware__irq.html#interrupt_nums">Interrupt Numbers</a> </td></tr>
987     <tr><td class="paramname">enabled</td><td>true to enable the interrupt, false to disable </td></tr>
988   </table>
989   </dd>
990 </dl>
991
992 </div>
993 </div>
994 <a id="gafffd448ba2d2eef5b355b88180aefe7f" name="gafffd448ba2d2eef5b355b88180aefe7f"></a>
995 <h2 class="memtitle"><span class="permalink"><a href="#gafffd448ba2d2eef5b355b88180aefe7f">&#9670;&nbsp;</a></span>irq_set_exclusive_handler()</h2>
996
997 <div class="memitem">
998 <div class="memproto">
999       <table class="memname">
1000         <tr>
1001           <td class="memname">void irq_set_exclusive_handler </td>
1002           <td>(</td>
1003           <td class="paramtype">uint&#160;</td>
1004           <td class="paramname"><em>num</em>, </td>
1005         </tr>
1006         <tr>
1007           <td class="paramkey"></td>
1008           <td></td>
1009           <td class="paramtype"><a class="el" href="group__hardware__irq.html#ga8478ee26cc144e947ccd75b0169059a6">irq_handler_t</a>&#160;</td>
1010           <td class="paramname"><em>handler</em>&#160;</td>
1011         </tr>
1012         <tr>
1013           <td></td>
1014           <td>)</td>
1015           <td></td><td></td>
1016         </tr>
1017       </table>
1018 </div><div class="memdoc">
1019
1020 <p>Set an exclusive interrupt handler for an interrupt on the executing core. </p>
1021 <p >Use this method to set a handler for single IRQ source interrupts, or when your code, use case or performance requirements dictate that there should no other handlers for the interrupt.</p>
1022 <p >This method will assert if there is already any sort of interrupt handler installed for the specified irq number.</p>
1023 <dl class="params"><dt>Parameters</dt><dd>
1024   <table class="params">
1025     <tr><td class="paramname">num</td><td>Interrupt number <a class="el" href="group__hardware__irq.html#interrupt_nums">Interrupt Numbers</a> </td></tr>
1026     <tr><td class="paramname">handler</td><td>The handler to set. See <a class="el" href="group__hardware__irq.html#ga8478ee26cc144e947ccd75b0169059a6">irq_handler_t</a> </td></tr>
1027   </table>
1028   </dd>
1029 </dl>
1030 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__hardware__irq.html#gaf02f8599896c66f4579c845a96b2126e" title="Add a shared interrupt handler for an interrupt on the executing core.">irq_add_shared_handler()</a> </dd></dl>
1031
1032 </div>
1033 </div>
1034 <a id="gae91340b84a6d70049933af657df93201" name="gae91340b84a6d70049933af657df93201"></a>
1035 <h2 class="memtitle"><span class="permalink"><a href="#gae91340b84a6d70049933af657df93201">&#9670;&nbsp;</a></span>irq_set_mask_enabled()</h2>
1036
1037 <div class="memitem">
1038 <div class="memproto">
1039       <table class="memname">
1040         <tr>
1041           <td class="memname">void irq_set_mask_enabled </td>
1042           <td>(</td>
1043           <td class="paramtype">uint32_t&#160;</td>
1044           <td class="paramname"><em>mask</em>, </td>
1045         </tr>
1046         <tr>
1047           <td class="paramkey"></td>
1048           <td></td>
1049           <td class="paramtype">bool&#160;</td>
1050           <td class="paramname"><em>enabled</em>&#160;</td>
1051         </tr>
1052         <tr>
1053           <td></td>
1054           <td>)</td>
1055           <td></td><td></td>
1056         </tr>
1057       </table>
1058 </div><div class="memdoc">
1059
1060 <p>Enable/disable multiple interrupts on the executing core. </p>
1061 <dl class="params"><dt>Parameters</dt><dd>
1062   <table class="params">
1063     <tr><td class="paramname">mask</td><td>32-bit mask with one bits set for the interrupts to enable/disable <a class="el" href="group__hardware__irq.html#interrupt_nums">Interrupt Numbers</a> </td></tr>
1064     <tr><td class="paramname">enabled</td><td>true to enable the interrupts, false to disable them. </td></tr>
1065   </table>
1066   </dd>
1067 </dl>
1068
1069 </div>
1070 </div>
1071 <a id="gae1a927e62e780b2f7dacc3a008ffaf20" name="gae1a927e62e780b2f7dacc3a008ffaf20"></a>
1072 <h2 class="memtitle"><span class="permalink"><a href="#gae1a927e62e780b2f7dacc3a008ffaf20">&#9670;&nbsp;</a></span>irq_set_mask_n_enabled()</h2>
1073
1074 <div class="memitem">
1075 <div class="memproto">
1076       <table class="memname">
1077         <tr>
1078           <td class="memname">void irq_set_mask_n_enabled </td>
1079           <td>(</td>
1080           <td class="paramtype">uint&#160;</td>
1081           <td class="paramname"><em>n</em>, </td>
1082         </tr>
1083         <tr>
1084           <td class="paramkey"></td>
1085           <td></td>
1086           <td class="paramtype">uint32_t&#160;</td>
1087           <td class="paramname"><em>mask</em>, </td>
1088         </tr>
1089         <tr>
1090           <td class="paramkey"></td>
1091           <td></td>
1092           <td class="paramtype">bool&#160;</td>
1093           <td class="paramname"><em>enabled</em>&#160;</td>
1094         </tr>
1095         <tr>
1096           <td></td>
1097           <td>)</td>
1098           <td></td><td></td>
1099         </tr>
1100       </table>
1101 </div><div class="memdoc">
1102
1103 <p>Enable/disable multiple interrupts on the executing core. </p>
1104 <dl class="params"><dt>Parameters</dt><dd>
1105   <table class="params">
1106     <tr><td class="paramname">n</td><td>the index of the mask to update. n == 0 means 0-&gt;31, n == 1 mean 32-&gt;63 etc. </td></tr>
1107     <tr><td class="paramname">mask</td><td>32-bit mask with one bits set for the interrupts to enable/disable <a class="el" href="group__hardware__irq.html#interrupt_nums">Interrupt Numbers</a> </td></tr>
1108     <tr><td class="paramname">enabled</td><td>true to enable the interrupts, false to disable them. </td></tr>
1109   </table>
1110   </dd>
1111 </dl>
1112
1113 </div>
1114 </div>
1115 <a id="ga36e4b97d3414ce58c3091e63badcf9ce" name="ga36e4b97d3414ce58c3091e63badcf9ce"></a>
1116 <h2 class="memtitle"><span class="permalink"><a href="#ga36e4b97d3414ce58c3091e63badcf9ce">&#9670;&nbsp;</a></span>irq_set_pending()</h2>
1117
1118 <div class="memitem">
1119 <div class="memproto">
1120       <table class="memname">
1121         <tr>
1122           <td class="memname">void irq_set_pending </td>
1123           <td>(</td>
1124           <td class="paramtype">uint&#160;</td>
1125           <td class="paramname"><em>num</em></td><td>)</td>
1126           <td></td>
1127         </tr>
1128       </table>
1129 </div><div class="memdoc">
1130
1131 <p>Force an interrupt to be pending on the executing core. </p>
1132 <p >This should generally not be used for IRQs connected to hardware.</p>
1133 <dl class="params"><dt>Parameters</dt><dd>
1134   <table class="params">
1135     <tr><td class="paramname">num</td><td>Interrupt number <a class="el" href="group__hardware__irq.html#interrupt_nums">Interrupt Numbers</a> </td></tr>
1136   </table>
1137   </dd>
1138 </dl>
1139
1140 </div>
1141 </div>
1142 <a id="gad11ea172f11d9763647ac34b366ab3c2" name="gad11ea172f11d9763647ac34b366ab3c2"></a>
1143 <h2 class="memtitle"><span class="permalink"><a href="#gad11ea172f11d9763647ac34b366ab3c2">&#9670;&nbsp;</a></span>irq_set_priority()</h2>
1144
1145 <div class="memitem">
1146 <div class="memproto">
1147       <table class="memname">
1148         <tr>
1149           <td class="memname">void irq_set_priority </td>
1150           <td>(</td>
1151           <td class="paramtype">uint&#160;</td>
1152           <td class="paramname"><em>num</em>, </td>
1153         </tr>
1154         <tr>
1155           <td class="paramkey"></td>
1156           <td></td>
1157           <td class="paramtype">uint8_t&#160;</td>
1158           <td class="paramname"><em>hardware_priority</em>&#160;</td>
1159         </tr>
1160         <tr>
1161           <td></td>
1162           <td>)</td>
1163           <td></td><td></td>
1164         </tr>
1165       </table>
1166 </div><div class="memdoc">
1167
1168 <p>Set specified interrupt's priority. </p>
1169 <dl class="params"><dt>Parameters</dt><dd>
1170   <table class="params">
1171     <tr><td class="paramname">num</td><td>Interrupt number <a class="el" href="group__hardware__irq.html#interrupt_nums">Interrupt Numbers</a> </td></tr>
1172     <tr><td class="paramname">hardware_priority</td><td>Priority to set. Numerically-lower values indicate a higher priority. Hardware priorities range from 0 (highest priority) to 255 (lowest priority). To make it easier to specify higher or lower priorities than the default, all IRQ priorities are initialized to PICO_DEFAULT_IRQ_PRIORITY by the SDK runtime at startup. PICO_DEFAULT_IRQ_PRIORITY defaults to 0x80</td></tr>
1173   </table>
1174   </dd>
1175 </dl>
1176 <p>Only the top 2 bits are significant on ARM Cortex-M0+ on RP2040. </p>
1177 <p >Only the top 4 bits are significant on ARM Cortex-M33 or Hazard3 (RISC-V) on RP2350. Note that this API uses the same (inverted) ordering as ARM on RISC-V  </p>
1178
1179 </div>
1180 </div>
1181 <a id="gaa52ec9e5f572b3a0ef50707ab37233ef" name="gaa52ec9e5f572b3a0ef50707ab37233ef"></a>
1182 <h2 class="memtitle"><span class="permalink"><a href="#gaa52ec9e5f572b3a0ef50707ab37233ef">&#9670;&nbsp;</a></span>user_irq_claim()</h2>
1183
1184 <div class="memitem">
1185 <div class="memproto">
1186       <table class="memname">
1187         <tr>
1188           <td class="memname">void user_irq_claim </td>
1189           <td>(</td>
1190           <td class="paramtype">uint&#160;</td>
1191           <td class="paramname"><em>irq_num</em></td><td>)</td>
1192           <td></td>
1193         </tr>
1194       </table>
1195 </div><div class="memdoc">
1196
1197 <p>Claim ownership of a user IRQ on the calling core. </p>
1198 <p >User IRQs starting from FIRST_USER_IRQ are not connected to any hardware, but can be triggered by <a class="el" href="group__hardware__irq.html#ga36e4b97d3414ce58c3091e63badcf9ce">irq_set_pending</a>.</p>
1199 <dl class="section note"><dt>Note</dt><dd>User IRQs are a core local feature; they cannot be used to communicate between cores. Therefore all functions dealing with Uer IRQs affect only the calling core</dd></dl>
1200 <p>This method explicitly claims ownership of a user IRQ, so other code can know it is being used.</p>
1201 <dl class="params"><dt>Parameters</dt><dd>
1202   <table class="params">
1203     <tr><td class="paramname">irq_num</td><td>the user IRQ to claim </td></tr>
1204   </table>
1205   </dd>
1206 </dl>
1207
1208 </div>
1209 </div>
1210 <a id="gace889ebb0bde6fc678dee915d4e3537e" name="gace889ebb0bde6fc678dee915d4e3537e"></a>
1211 <h2 class="memtitle"><span class="permalink"><a href="#gace889ebb0bde6fc678dee915d4e3537e">&#9670;&nbsp;</a></span>user_irq_claim_unused()</h2>
1212
1213 <div class="memitem">
1214 <div class="memproto">
1215       <table class="memname">
1216         <tr>
1217           <td class="memname">int user_irq_claim_unused </td>
1218           <td>(</td>
1219           <td class="paramtype">bool&#160;</td>
1220           <td class="paramname"><em>required</em></td><td>)</td>
1221           <td></td>
1222         </tr>
1223       </table>
1224 </div><div class="memdoc">
1225
1226 <p>Claim ownership of a free user IRQ on the calling core. </p>
1227 <p >User IRQs starting from FIRST_USER_IRQ are not connected to any hardware, but can be triggered by <a class="el" href="group__hardware__irq.html#ga36e4b97d3414ce58c3091e63badcf9ce">irq_set_pending</a>.</p>
1228 <dl class="section note"><dt>Note</dt><dd>User IRQs are a core local feature; they cannot be used to communicate between cores. Therefore all functions dealing with Uer IRQs affect only the calling core</dd></dl>
1229 <p>This method explicitly claims ownership of an unused user IRQ if there is one, so other code can know it is being used.</p>
1230 <dl class="params"><dt>Parameters</dt><dd>
1231   <table class="params">
1232     <tr><td class="paramname">required</td><td>if true the function will panic if none are available </td></tr>
1233   </table>
1234   </dd>
1235 </dl>
1236 <dl class="section return"><dt>Returns</dt><dd>the user IRQ number or -1 if required was false, and none were free </dd></dl>
1237
1238 </div>
1239 </div>
1240 <a id="ga14c041e05fbd5ee3c0b6b6341073a20a" name="ga14c041e05fbd5ee3c0b6b6341073a20a"></a>
1241 <h2 class="memtitle"><span class="permalink"><a href="#ga14c041e05fbd5ee3c0b6b6341073a20a">&#9670;&nbsp;</a></span>user_irq_unclaim()</h2>
1242
1243 <div class="memitem">
1244 <div class="memproto">
1245       <table class="memname">
1246         <tr>
1247           <td class="memname">void user_irq_unclaim </td>
1248           <td>(</td>
1249           <td class="paramtype">uint&#160;</td>
1250           <td class="paramname"><em>irq_num</em></td><td>)</td>
1251           <td></td>
1252         </tr>
1253       </table>
1254 </div><div class="memdoc">
1255
1256 <p>Mark a user IRQ as no longer used on the calling core. </p>
1257 <p >User IRQs starting from FIRST_USER_IRQ are not connected to any hardware, but can be triggered by <a class="el" href="group__hardware__irq.html#ga36e4b97d3414ce58c3091e63badcf9ce">irq_set_pending</a>.</p>
1258 <dl class="section note"><dt>Note</dt><dd>User IRQs are a core local feature; they cannot be used to communicate between cores. Therefore all functions dealing with Uer IRQs affect only the calling core</dd></dl>
1259 <p>This method explicitly releases ownership of a user IRQ, so other code can know it is free to use.</p>
1260 <dl class="section note"><dt>Note</dt><dd>it is customary to have disabled the irq and removed the handler prior to calling this method.</dd></dl>
1261 <dl class="params"><dt>Parameters</dt><dd>
1262   <table class="params">
1263     <tr><td class="paramname">irq_num</td><td>the irq irq_num to unclaim </td></tr>
1264   </table>
1265   </dd>
1266 </dl>
1267
1268 </div>
1269 </div>
1270 </div><!-- contents -->
1271 </div><!-- doc-content -->
1272
1273         <script src="main.js"></script>
1274 </body>
1275 </html>
This page took 0.110146 seconds and 4 git commands to generate.