web/docs/exception_8h.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: include/hardware/exception.h File Reference</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('exception_8h.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="#define-members">Macros</a> &#124;
 107 <a href="#typedef-members">Typedefs</a> &#124;
 108 <a href="#enum-members">Enumerations</a> &#124;
 109 <a href="#func-members">Functions</a>  </div>
 110   <div class="headertitle"><div class="title">exception.h File Reference</div></div>
 111 </div><!--header-->
 112 <div class="contents">
 113 <div class="textblock"><code>#include &quot;<a class="el" href="pico_8h_source.html">pico.h</a>&quot;</code><br />
 114 <code>#include &quot;<a class="el" href="address__mapped_8h_source.html">hardware/address_mapped.h</a>&quot;</code><br />
 115 </div><div class="textblock"><div class="dynheader">
 116 Include dependency graph for exception.h:</div>
 117 <div class="dyncontent">
 118 <div class="center"><img src="exception_8h__incl.png" border="0" usemap="#ainclude_2hardware_2exception_8h" alt=""/></div>
 119 <map name="ainclude_2hardware_2exception_8h" id="ainclude_2hardware_2exception_8h">
 120 <area shape="rect" title=" " alt="" coords="643,5,857,32"/>
 121 <area shape="rect" href="pico_8h.html" title=" " alt="" coords="649,155,710,181"/>
 122 <area shape="rect" href="address__mapped_8h.html" title=" " alt="" coords="717,80,927,107"/>
 123 <area shape="rect" href="common_2pico__base__headers_2include_2pico_2types_8h_source.html" title=" " alt="" coords="158,379,259,405"/>
 124 <area shape="rect" title=" " alt="" coords="420,229,533,256"/>
 125 <area shape="rect" href="common_2pico__base__headers_2include_2pico_2config_8h_source.html" title=" " alt="" coords="558,229,662,256"/>
 126 <area shape="rect" href="platform_8h.html" title=" " alt="" coords="687,229,808,256"/>
 127 <area shape="rect" href="error_8h_source.html" title=" " alt="" coords="832,229,927,256"/>
 128 <area shape="rect" href="assert_8h_source.html" title=" " alt="" coords="5,453,111,480"/>
 129 <area shape="rect" title=" " alt="" coords="74,528,157,555"/>
 130 <area shape="rect" title=" " alt="" coords="211,453,281,480"/>
 131 <area shape="rect" title=" " alt="" coords="306,453,381,480"/>
 132 <area shape="rect" title=" " alt="" coords="173,304,337,331"/>
 133 <area shape="rect" href="compiler_8h_source.html" title=" " alt="" coords="362,304,543,331"/>
 134 <area shape="rect" href="sections_8h_source.html" title=" " alt="" coords="567,304,746,331"/>
 135 <area shape="rect" href="panic_8h_source.html" title=" " alt="" coords="770,304,930,331"/>
 136 <area shape="rect" title=" " alt="" coords="1130,304,1341,331"/>
 137 <area shape="rect" title=" " alt="" coords="955,304,1105,331"/>
 138 <area shape="rect" title=" " alt="" coords="357,379,548,405"/>
 139 </map>
 140 </div>
 141 </div>
 142 <p><a href="exception_8h_source.html">Go to the source code of this file.</a></p>
 143 <table class="memberdecls">
 144 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
 145 Macros</h2></td></tr>
 146 <tr class="memitem:ab04853092d6db6e66a566c96d77ab1e1"><td class="memItemLeft" align="right" valign="top"><a id="ab04853092d6db6e66a566c96d77ab1e1" name="ab04853092d6db6e66a566c96d77ab1e1"></a>
 147 #define&#160;</td><td class="memItemRight" valign="bottom"><b>PARAM_ASSERTIONS_ENABLED_HARDWARE_EXCEPTION</b>&#160;&#160;&#160;0</td></tr>
 148 <tr class="separator:ab04853092d6db6e66a566c96d77ab1e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 <tr class="memitem:a09567ffc0374e75b57f04d571b731cca"><td class="memItemLeft" align="right" valign="top"><a id="a09567ffc0374e75b57f04d571b731cca" name="a09567ffc0374e75b57f04d571b731cca"></a>
 150 #define&#160;</td><td class="memItemRight" valign="bottom"><b>PICO_LOWEST_EXCEPTION_PRIORITY</b>&#160;&#160;&#160;0xff</td></tr>
 151 <tr class="separator:a09567ffc0374e75b57f04d571b731cca"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 <tr class="memitem:a03fdaddf1972edcf975983c066024388"><td class="memItemLeft" align="right" valign="top"><a id="a03fdaddf1972edcf975983c066024388" name="a03fdaddf1972edcf975983c066024388"></a>
 153 #define&#160;</td><td class="memItemRight" valign="bottom"><b>PICO_HIGHEST_EXCEPTION_PRIORITY</b>&#160;&#160;&#160;0x00</td></tr>
 154 <tr class="separator:a03fdaddf1972edcf975983c066024388"><td class="memSeparator" colspan="2">&#160;</td></tr>
 155 </table><table class="memberdecls">
 156 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
 157 Typedefs</h2></td></tr>
 158 <tr class="memitem:ga4de8b8ce1d704966edfc547190f73f0b"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__exception.html#ga4de8b8ce1d704966edfc547190f73f0b">exception_handler_t</a>) (void)</td></tr>
 159 <tr class="memdesc:ga4de8b8ce1d704966edfc547190f73f0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exception handler function type.  <a href="group__hardware__exception.html#ga4de8b8ce1d704966edfc547190f73f0b">More...</a><br /></td></tr>
 160 <tr class="separator:ga4de8b8ce1d704966edfc547190f73f0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 161 </table><table class="memberdecls">
 162 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
 163 Enumerations</h2></td></tr>
 164 <tr class="memitem:ga504f1c3a5a6959d430665f5d72cf335a"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__exception.html#ga504f1c3a5a6959d430665f5d72cf335a">exception_number</a> { <br />
 165 &#160;&#160;<b>MIN_EXCEPTION_NUM</b> = 2
 166 , <a class="el" href="group__hardware__exception.html#gga504f1c3a5a6959d430665f5d72cf335aa6e8a4e796361d59517c80affc6e93cd7">NMI_EXCEPTION</a> = 2
 167 , <a class="el" href="group__hardware__exception.html#gga504f1c3a5a6959d430665f5d72cf335aadf88404244d6cf50e5103848de3892e2">HARDFAULT_EXCEPTION</a> = 3
 168 , <a class="el" href="group__hardware__exception.html#gga504f1c3a5a6959d430665f5d72cf335aa1e7d691476a041fb59915e046e85d586">SVCALL_EXCEPTION</a> = 11
 169 , <br />
 170 &#160;&#160;<a class="el" href="group__hardware__exception.html#gga504f1c3a5a6959d430665f5d72cf335aae6e5980728dbb2ff717a7867bdb25a3a">PENDSV_EXCEPTION</a> = 14
 171 , <a class="el" href="group__hardware__exception.html#gga504f1c3a5a6959d430665f5d72cf335aa05ced3409f791060c7eab53bc557c333">SYSTICK_EXCEPTION</a> = 15
 172 , <b>MAX_EXCEPTION_NUM</b> = 15
 173 <br />
 174  }</td></tr>
 175 <tr class="memdesc:ga504f1c3a5a6959d430665f5d72cf335a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exception number definitions.  <a href="group__hardware__exception.html#ga504f1c3a5a6959d430665f5d72cf335a">More...</a><br /></td></tr>
 176 <tr class="separator:ga504f1c3a5a6959d430665f5d72cf335a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 177 </table><table class="memberdecls">
 178 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 179 Functions</h2></td></tr>
 180 <tr class="memitem:ga0c49b97eb751230b3d77459e7bfe98f5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__hardware__exception.html#ga4de8b8ce1d704966edfc547190f73f0b">exception_handler_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__exception.html#ga0c49b97eb751230b3d77459e7bfe98f5">exception_set_exclusive_handler</a> (enum <a class="el" href="group__hardware__exception.html#ga504f1c3a5a6959d430665f5d72cf335a">exception_number</a> num, <a class="el" href="group__hardware__exception.html#ga4de8b8ce1d704966edfc547190f73f0b">exception_handler_t</a> handler)</td></tr>
 181 <tr class="memdesc:ga0c49b97eb751230b3d77459e7bfe98f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the exception handler for an exception on the executing core.  <a href="group__hardware__exception.html#ga0c49b97eb751230b3d77459e7bfe98f5">More...</a><br /></td></tr>
 182 <tr class="separator:ga0c49b97eb751230b3d77459e7bfe98f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 183 <tr class="memitem:gabd73e0f58d5d1149a77a521c0dceb9cb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__exception.html#gabd73e0f58d5d1149a77a521c0dceb9cb">exception_restore_handler</a> (enum <a class="el" href="group__hardware__exception.html#ga504f1c3a5a6959d430665f5d72cf335a">exception_number</a> num, <a class="el" href="group__hardware__exception.html#ga4de8b8ce1d704966edfc547190f73f0b">exception_handler_t</a> original_handler)</td></tr>
 184 <tr class="memdesc:gabd73e0f58d5d1149a77a521c0dceb9cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restore the original exception handler for an exception on this core.  <a href="group__hardware__exception.html#gabd73e0f58d5d1149a77a521c0dceb9cb">More...</a><br /></td></tr>
 185 <tr class="separator:gabd73e0f58d5d1149a77a521c0dceb9cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 186 <tr class="memitem:ga51b870aeeca94e21bd35bdfbab20e706"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__hardware__exception.html#ga4de8b8ce1d704966edfc547190f73f0b">exception_handler_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__exception.html#ga51b870aeeca94e21bd35bdfbab20e706">exception_get_vtable_handler</a> (enum <a class="el" href="group__hardware__exception.html#ga504f1c3a5a6959d430665f5d72cf335a">exception_number</a> num)</td></tr>
 187 <tr class="memdesc:ga51b870aeeca94e21bd35bdfbab20e706"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current exception handler for the specified exception from the currently installed vector table of the execution core.  <a href="group__hardware__exception.html#ga51b870aeeca94e21bd35bdfbab20e706">More...</a><br /></td></tr>
 188 <tr class="separator:ga51b870aeeca94e21bd35bdfbab20e706"><td class="memSeparator" colspan="2">&#160;</td></tr>
 189 <tr class="memitem:ga6567fefaab2f557e12796f8d57bec124"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__exception.html#ga6567fefaab2f557e12796f8d57bec124">exception_set_priority</a> (uint num, uint8_t hardware_priority)</td></tr>
 190 <tr class="memdesc:ga6567fefaab2f557e12796f8d57bec124"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set specified exception's priority.  <a href="group__hardware__exception.html#ga6567fefaab2f557e12796f8d57bec124">More...</a><br /></td></tr>
 191 <tr class="separator:ga6567fefaab2f557e12796f8d57bec124"><td class="memSeparator" colspan="2">&#160;</td></tr>
 192 <tr class="memitem:ga7189f5bb3db0bf08c76cb79c1235a71a"><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__exception.html#ga7189f5bb3db0bf08c76cb79c1235a71a">exception_get_priority</a> (uint num)</td></tr>
 193 <tr class="memdesc:ga7189f5bb3db0bf08c76cb79c1235a71a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get specified exception's priority.  <a href="group__hardware__exception.html#ga7189f5bb3db0bf08c76cb79c1235a71a">More...</a><br /></td></tr>
 194 <tr class="separator:ga7189f5bb3db0bf08c76cb79c1235a71a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 195 </table>
 196 </div><!-- contents -->
 197 </div><!-- doc-content -->
 198
 199         <script src="main.js"></script>
 200 </body>
 201 </html>