gbdk-2020 | GameBoy Development Kit |
| download: https://git.y1.nz/archives/gbdk.tar.gz | |
| README | Files | Log | Refs | LICENSE |
docs/api/isr_8h.html
1 <!-- HTML header for doxygen 1.8.14-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <meta http-equiv="cache-control" content="max-age=86400"/>
6 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
7 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
8 <meta name="generator" content="Doxygen 1.9.2"/>
9 <meta name="viewport" content="width=device-width, initial-scale=1"/>
10 <title>GBDK 2020 Docs: gbdk-lib/include/gb/isr.h File Reference</title>
11 <link href="tabs.css" rel="stylesheet" type="text/css"/>
12 <script type="text/javascript" src="jquery.js"></script>
13 <script type="text/javascript" src="dynsections.js"></script>
14 <link href="navtree.css" rel="stylesheet" type="text/css"/>
15 <script type="text/javascript" src="resize.js"></script>
16 <script type="text/javascript" src="navtreedata.js"></script>
17 <script type="text/javascript" src="navtree.js"></script>
18 <link href="search/search.css" rel="stylesheet" type="text/css"/>
19 <script type="text/javascript" src="search/searchdata.js"></script>
20 <script type="text/javascript" src="search/search.js"></script>
21 <link href="doxygen.css" rel="stylesheet" type="text/css" />
22 <link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
23 <link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
24 <link href="doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
25 <!-- BEGIN: doxygen-awesome-css -->
26 <script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
27 <script type="text/javascript">
28 DoxygenAwesomeDarkModeToggle.init()
29 </script>
30 <script type="text/javascript" src="doxygen-awesome-paragraph-link.js"></script>
31 <script type="text/javascript">
32 DoxygenAwesomeParagraphLink.init()
33 </script>
34 <!-- END: doxygen-awesome-css -->
35 </head>
36 <body>
37 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
38 <div id="titlearea">
39 <table cellspacing="0" cellpadding="0">
40 <tbody>
41 <tr style="height: 56px;">
42 <td id="projectalign" style="padding-left: 0.5em;">
43 <div id="projectname">GBDK 2020 Docs
44  <span id="projectnumber">4.5.0</span>
45 </div>
46 <div id="projectbrief">API Documentation for GBDK 2020</div>
47 </td>
48 </tr>
49 </tbody>
50 </table>
51 </div>
52 <!-- end header part -->
53 <!-- Generated by Doxygen 1.9.2 -->
54 <script type="text/javascript">
55 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
56 var searchBox = new SearchBox("searchBox", "search",'Search','.html');
57 /* @license-end */
58 </script>
59 <script type="text/javascript" src="menudata.js"></script>
60 <script type="text/javascript" src="menu.js"></script>
61 <script type="text/javascript">
62 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
63 $(function() {
64 initMenu('',true,false,'search.php','Search');
65 $(document).ready(function() { init_search(); });
66 });
67 /* @license-end */
68 </script>
69 <div id="main-nav"></div>
70 </div><!-- top -->
71 <div id="side-nav" class="ui-resizable side-nav-resizable">
72 <div id="nav-tree">
73 <div id="nav-tree-contents">
74 <div id="nav-sync" class="sync"></div>
75 </div>
76 </div>
77 <div id="splitbar" style="-moz-user-select:none;"
78 class="ui-resizable-handle">
79 </div>
80 </div>
81 <script type="text/javascript">
82 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
83 $(document).ready(function(){initNavTree('isr_8h.html',''); initResizable(); });
84 /* @license-end */
85 </script>
86 <div id="doc-content">
87 <!-- window showing the filter options -->
88 <div id="MSearchSelectWindow"
89 onmouseover="return searchBox.OnSearchSelectShow()"
90 onmouseout="return searchBox.OnSearchSelectHide()"
91 onkeydown="return searchBox.OnSearchSelectKey(event)">
92 </div>
93
94 <!-- iframe showing the search results (closed by default) -->
95 <div id="MSearchResultsWindow">
96 <iframe src="javascript:void(0)" frameborder="0"
97 name="MSearchResults" id="MSearchResults">
98 </iframe>
99 </div>
100
101 <div class="header">
102 <div class="summary">
103 <a href="#nested-classes">Data Structures</a> |
104 <a href="#define-members">Macros</a> |
105 <a href="#typedef-members">Typedefs</a> </div>
106 <div class="headertitle"><div class="title">isr.h File Reference</div></div>
107 </div><!--header-->
108 <div class="contents">
109 <div class="textblock"><code>#include <<a class="el" href="stdint_8h_source.html">stdint.h</a>></code><br />
110 <code>#include <types.h></code><br />
111 </div>
112 <p><a href="isr_8h_source.html">Go to the source code of this file.</a></p>
113 <table class="memberdecls">
114 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
115 Data Structures</h2></td></tr>
116 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structisr__vector__t.html">isr_vector_t</a></td></tr>
117 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
118 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structisr__nested__vector__t.html">isr_nested_vector_t</a></td></tr>
119 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
120 </table><table class="memberdecls">
121 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
122 Macros</h2></td></tr>
123 <tr class="memitem:VECTOR_STAT"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="isr_8h.html#VECTOR_STAT">VECTOR_STAT</a>   0x48</td></tr>
124 <tr class="separator:VECTOR_STAT"><td class="memSeparator" colspan="2"> </td></tr>
125 <tr class="memitem:VECTOR_TIMER"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="isr_8h.html#VECTOR_TIMER">VECTOR_TIMER</a>   0x50</td></tr>
126 <tr class="separator:VECTOR_TIMER"><td class="memSeparator" colspan="2"> </td></tr>
127 <tr class="memitem:VECTOR_SERIAL"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="isr_8h.html#VECTOR_SERIAL">VECTOR_SERIAL</a>   0x58</td></tr>
128 <tr class="separator:VECTOR_SERIAL"><td class="memSeparator" colspan="2"> </td></tr>
129 <tr class="memitem:VECTOR_JOYPAD"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="isr_8h.html#VECTOR_JOYPAD">VECTOR_JOYPAD</a>   0x60</td></tr>
130 <tr class="separator:VECTOR_JOYPAD"><td class="memSeparator" colspan="2"> </td></tr>
131 <tr class="memitem:ISR_VECTOR"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="isr_8h.html#ISR_VECTOR">ISR_VECTOR</a>(ADDR, FUNC)   static const <a class="el" href="structisr__vector__t.html">isr_vector_t</a> <a class="el" href="asm_2types_8h.html#AT">AT</a>((ADDR)) __ISR_ ## ADDR = {0xc3, (void *)&(FUNC)};</td></tr>
132 <tr class="separator:ISR_VECTOR"><td class="memSeparator" colspan="2"> </td></tr>
133 <tr class="memitem:ISR_NESTED_VECTOR"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="isr_8h.html#ISR_NESTED_VECTOR">ISR_NESTED_VECTOR</a>(ADDR, FUNC)   static const <a class="el" href="structisr__nested__vector__t.html">isr_nested_vector_t</a> <a class="el" href="asm_2types_8h.html#AT">AT</a>((ADDR)) __ISR_ ## ADDR = {{0xfb, 0xc3}, (void *)&(FUNC)};</td></tr>
134 <tr class="separator:ISR_NESTED_VECTOR"><td class="memSeparator" colspan="2"> </td></tr>
135 </table><table class="memberdecls">
136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
137 Typedefs</h2></td></tr>
138 <tr class="memitem:isr_vector_t"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structisr__vector__t.html">isr_vector_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="isr_8h.html#isr_vector_t">isr_vector_t</a></td></tr>
139 <tr class="separator:isr_vector_t"><td class="memSeparator" colspan="2"> </td></tr>
140 <tr class="memitem:isr_nested_vector_t"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structisr__nested__vector__t.html">isr_nested_vector_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="isr_8h.html#isr_nested_vector_t">isr_nested_vector_t</a></td></tr>
141 <tr class="separator:isr_nested_vector_t"><td class="memSeparator" colspan="2"> </td></tr>
142 </table>
143 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
144 <div class="textblock"><p >Macros for creating raw interrupt service routines (ISRs) which do not use the default GBDK ISR dispatcher.</p>
145 <p >Handlers installed this way will have less overhead than ones which use the GBDK ISR dispatcher. </p>
146 </div><h2 class="groupheader">Macro Definition Documentation</h2>
147 <a id="VECTOR_STAT" name="VECTOR_STAT"></a>
148 <h2 class="memtitle"><span class="permalink"><a href="#VECTOR_STAT">◆ </a></span>VECTOR_STAT</h2>
149
150 <div class="memitem">
151 <div class="memproto">
152 <table class="memname">
153 <tr>
154 <td class="memname">#define VECTOR_STAT   0x48</td>
155 </tr>
156 </table>
157 </div><div class="memdoc">
158 <p >Address for the STAT interrupt vector </p>
159
160 </div>
161 </div>
162 <a id="VECTOR_TIMER" name="VECTOR_TIMER"></a>
163 <h2 class="memtitle"><span class="permalink"><a href="#VECTOR_TIMER">◆ </a></span>VECTOR_TIMER</h2>
164
165 <div class="memitem">
166 <div class="memproto">
167 <table class="memname">
168 <tr>
169 <td class="memname">#define VECTOR_TIMER   0x50</td>
170 </tr>
171 </table>
172 </div><div class="memdoc">
173 <p >Address for the TIMER interrupt vector </p>
174
175 </div>
176 </div>
177 <a id="VECTOR_SERIAL" name="VECTOR_SERIAL"></a>
178 <h2 class="memtitle"><span class="permalink"><a href="#VECTOR_SERIAL">◆ </a></span>VECTOR_SERIAL</h2>
179
180 <div class="memitem">
181 <div class="memproto">
182 <table class="memname">
183 <tr>
184 <td class="memname">#define VECTOR_SERIAL   0x58</td>
185 </tr>
186 </table>
187 </div><div class="memdoc">
188 <p >Address for the SERIAL interrupt vector </p>
189
190 </div>
191 </div>
192 <a id="VECTOR_JOYPAD" name="VECTOR_JOYPAD"></a>
193 <h2 class="memtitle"><span class="permalink"><a href="#VECTOR_JOYPAD">◆ </a></span>VECTOR_JOYPAD</h2>
194
195 <div class="memitem">
196 <div class="memproto">
197 <table class="memname">
198 <tr>
199 <td class="memname">#define VECTOR_JOYPAD   0x60</td>
200 </tr>
201 </table>
202 </div><div class="memdoc">
203 <p >Address for the JOYPAD interrupt vector </p>
204
205 </div>
206 </div>
207 <a id="ISR_VECTOR" name="ISR_VECTOR"></a>
208 <h2 class="memtitle"><span class="permalink"><a href="#ISR_VECTOR">◆ </a></span>ISR_VECTOR</h2>
209
210 <div class="memitem">
211 <div class="memproto">
212 <table class="memname">
213 <tr>
214 <td class="memname">#define ISR_VECTOR</td>
215 <td>(</td>
216 <td class="paramtype"> </td>
217 <td class="paramname">ADDR, </td>
218 </tr>
219 <tr>
220 <td class="paramkey"></td>
221 <td></td>
222 <td class="paramtype"> </td>
223 <td class="paramname">FUNC </td>
224 </tr>
225 <tr>
226 <td></td>
227 <td>)</td>
228 <td></td><td>   static const <a class="el" href="structisr__vector__t.html">isr_vector_t</a> <a class="el" href="asm_2types_8h.html#AT">AT</a>((ADDR)) __ISR_ ## ADDR = {0xc3, (void *)&(FUNC)};</td>
229 </tr>
230 </table>
231 </div><div class="memdoc">
232 <p >Creates an interrupt vector at the given address for a raw interrupt service routine (which does not use the GBDK ISR dispatcher)</p>
233 <dl class="params"><dt>Parameters</dt><dd>
234 <table class="params">
235 <tr><td class="paramname">ADDR</td><td>Address of the interrupt vector, any of: <a class="el" href="isr_8h.html#VECTOR_STAT">VECTOR_STAT</a>, <a class="el" href="isr_8h.html#VECTOR_TIMER">VECTOR_TIMER</a>, <a class="el" href="isr_8h.html#VECTOR_SERIAL">VECTOR_SERIAL</a>, <a class="el" href="isr_8h.html#VECTOR_JOYPAD">VECTOR_JOYPAD</a> </td></tr>
236 <tr><td class="paramname">FUNC</td><td>ISR function supplied by the user</td></tr>
237 </table>
238 </dd>
239 </dl>
240 <p>This cannot be used with the VBLANK interrupt.</p>
241 <p >Do not use this in combination with interrupt installers that rely on the default GBDK ISR dispatcher such as <a class="el" href="gb_8h.html#add_TIM">add_TIM()</a>, <a class="el" href="gb_8h.html#remove_TIM">remove_TIM()</a> (and the same for all other interrupts).</p>
242 <p >Example: </p><div class="fragment"><div class="line"><span class="preprocessor">#include <<a class="code" href="isr_8h.html">gb/isr.h</a>></span></div>
243 <div class="line"> </div>
244 <div class="line"><span class="keywordtype">void</span> TimerISR() __critical __interrupt {</div>
245 <div class="line"><span class="comment">// some ISR code here</span></div>
246 <div class="line">}</div>
247 <div class="line"> </div>
248 <div class="line"><a class="code hl_define" href="isr_8h.html#ISR_VECTOR">ISR_VECTOR</a>(<a class="code hl_define" href="isr_8h.html#VECTOR_TIMER">VECTOR_TIMER</a>, TimerISR)</div>
249 <div class="ttc" id="aisr_8h_html"><div class="ttname"><a href="isr_8h.html">isr.h</a></div></div>
250 <div class="ttc" id="aisr_8h_html_ISR_VECTOR"><div class="ttname"><a href="isr_8h.html#ISR_VECTOR">ISR_VECTOR</a></div><div class="ttdeci">#define ISR_VECTOR(ADDR, FUNC)</div><div class="ttdef"><b>Definition:</b> isr.h:52</div></div>
251 <div class="ttc" id="aisr_8h_html_VECTOR_TIMER"><div class="ttname"><a href="isr_8h.html#VECTOR_TIMER">VECTOR_TIMER</a></div><div class="ttdeci">#define VECTOR_TIMER</div><div class="ttdef"><b>Definition:</b> isr.h:17</div></div>
252 </div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><a class="el" href="isr_8h.html#ISR_NESTED_VECTOR">ISR_NESTED_VECTOR</a>, <a class="el" href="sms_8h.html#set_interrupts">set_interrupts</a> </dd></dl>
253
254 </div>
255 </div>
256 <a id="ISR_NESTED_VECTOR" name="ISR_NESTED_VECTOR"></a>
257 <h2 class="memtitle"><span class="permalink"><a href="#ISR_NESTED_VECTOR">◆ </a></span>ISR_NESTED_VECTOR</h2>
258
259 <div class="memitem">
260 <div class="memproto">
261 <table class="memname">
262 <tr>
263 <td class="memname">#define ISR_NESTED_VECTOR</td>
264 <td>(</td>
265 <td class="paramtype"> </td>
266 <td class="paramname">ADDR, </td>
267 </tr>
268 <tr>
269 <td class="paramkey"></td>
270 <td></td>
271 <td class="paramtype"> </td>
272 <td class="paramname">FUNC </td>
273 </tr>
274 <tr>
275 <td></td>
276 <td>)</td>
277 <td></td><td>   static const <a class="el" href="structisr__nested__vector__t.html">isr_nested_vector_t</a> <a class="el" href="asm_2types_8h.html#AT">AT</a>((ADDR)) __ISR_ ## ADDR = {{0xfb, 0xc3}, (void *)&(FUNC)};</td>
278 </tr>
279 </table>
280 </div><div class="memdoc">
281 <p >Creates an interrupt vector at the given address for a raw interrupt service routine allowing nested interrupts</p>
282 <dl class="params"><dt>Parameters</dt><dd>
283 <table class="params">
284 <tr><td class="paramname">ADDR</td><td>Address of the interrupt vector, any of: <a class="el" href="isr_8h.html#VECTOR_STAT">VECTOR_STAT</a>, <a class="el" href="isr_8h.html#VECTOR_TIMER">VECTOR_TIMER</a>, <a class="el" href="isr_8h.html#VECTOR_SERIAL">VECTOR_SERIAL</a>, <a class="el" href="isr_8h.html#VECTOR_JOYPAD">VECTOR_JOYPAD</a> </td></tr>
285 <tr><td class="paramname">FUNC</td><td>ISR function</td></tr>
286 </table>
287 </dd>
288 </dl>
289 <p>This cannot be used with the VBLANK interrupt</p>
290 <p >The LCD STAT vector (<a class="el" href="isr_8h.html#VECTOR_STAT">VECTOR_STAT</a>) cannot be used in the same program as <code>stdio.h</code> since they install an ISR vector to the same location.</p>
291 <dl class="section see"><dt>See also</dt><dd><a class="el" href="isr_8h.html#ISR_VECTOR">ISR_VECTOR</a> </dd></dl>
292
293 </div>
294 </div>
295 <h2 class="groupheader">Typedef Documentation</h2>
296 <a id="isr_vector_t" name="isr_vector_t"></a>
297 <h2 class="memtitle"><span class="permalink"><a href="#isr_vector_t">◆ </a></span>isr_vector_t</h2>
298
299 <div class="memitem">
300 <div class="memproto">
301 <table class="memname">
302 <tr>
303 <td class="memname">typedef struct <a class="el" href="structisr__vector__t.html">isr_vector_t</a> <a class="el" href="structisr__vector__t.html">isr_vector_t</a></td>
304 </tr>
305 </table>
306 </div><div class="memdoc">
307
308 </div>
309 </div>
310 <a id="isr_nested_vector_t" name="isr_nested_vector_t"></a>
311 <h2 class="memtitle"><span class="permalink"><a href="#isr_nested_vector_t">◆ </a></span>isr_nested_vector_t</h2>
312
313 <div class="memitem">
314 <div class="memproto">
315 <table class="memname">
316 <tr>
317 <td class="memname">typedef struct <a class="el" href="structisr__nested__vector__t.html">isr_nested_vector_t</a> <a class="el" href="structisr__nested__vector__t.html">isr_nested_vector_t</a></td>
318 </tr>
319 </table>
320 </div><div class="memdoc">
321
322 </div>
323 </div>
324 </div><!-- contents -->
325 </div><!-- doc-content -->
326 <!-- start footer part -->
327 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
328 <ul>
329 <li class="navelem"><a class="el" href="dir_8bd3092e915ccc8a773a74e0a10d4d15.html">gbdk-lib</a></li><li class="navelem"><a class="el" href="dir_a9f896cff747ba031115e41245385c17.html">include</a></li><li class="navelem"><a class="el" href="dir_bdfe001eb73b667f67d57fb851301eb1.html">gb</a></li><li class="navelem"><a class="el" href="isr_8h.html">isr.h</a></li>
330 <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.2 </li>
331 </ul>
332 </div>
333 </body>
334 </html>
This webpage is intended to be an accessible preview of this repository. To get a fuller picture, clone it and use the git CLI.