web/docs/group__hardware__exception.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_exception</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__exception.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_exception<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>Methods for setting processor exception handlers.
 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: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>
 119 <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>
 120 <tr class="separator:ga4de8b8ce1d704966edfc547190f73f0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 121 </table><table class="memberdecls">
 122 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
 123 Enumerations</h2></td></tr>
 124 <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 />
 125 &#160;&#160;<b>MIN_EXCEPTION_NUM</b> = 2
 126 , <a class="el" href="group__hardware__exception.html#gga504f1c3a5a6959d430665f5d72cf335aa6e8a4e796361d59517c80affc6e93cd7">NMI_EXCEPTION</a> = 2
 127 , <a class="el" href="group__hardware__exception.html#gga504f1c3a5a6959d430665f5d72cf335aadf88404244d6cf50e5103848de3892e2">HARDFAULT_EXCEPTION</a> = 3
 128 , <a class="el" href="group__hardware__exception.html#gga504f1c3a5a6959d430665f5d72cf335aa1e7d691476a041fb59915e046e85d586">SVCALL_EXCEPTION</a> = 11
 129 , <br />
 130 &#160;&#160;<a class="el" href="group__hardware__exception.html#gga504f1c3a5a6959d430665f5d72cf335aae6e5980728dbb2ff717a7867bdb25a3a">PENDSV_EXCEPTION</a> = 14
 131 , <a class="el" href="group__hardware__exception.html#gga504f1c3a5a6959d430665f5d72cf335aa05ced3409f791060c7eab53bc557c333">SYSTICK_EXCEPTION</a> = 15
 132 , <b>MAX_EXCEPTION_NUM</b> = 15
 133 <br />
 134  }</td></tr>
 135 <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>
 136 <tr class="separator:ga504f1c3a5a6959d430665f5d72cf335a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 137 </table><table class="memberdecls">
 138 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 139 Functions</h2></td></tr>
 140 <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>
 141 <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>
 142 <tr class="separator:ga0c49b97eb751230b3d77459e7bfe98f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 <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>
 144 <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>
 145 <tr class="separator:gabd73e0f58d5d1149a77a521c0dceb9cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 <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>
 147 <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>
 148 <tr class="separator:ga51b870aeeca94e21bd35bdfbab20e706"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 <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>
 150 <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>
 151 <tr class="separator:ga6567fefaab2f557e12796f8d57bec124"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 <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>
 153 <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>
 154 <tr class="separator:ga7189f5bb3db0bf08c76cb79c1235a71a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 155 </table>
 156 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 157 <p >Methods for setting processor exception handlers. </p>
 158 <p >Exceptions are identified by a <a class="el" href="group__hardware__exception.html#ga504f1c3a5a6959d430665f5d72cf335a">exception_number</a> which is a number from -15 to -1; these are the numbers relative to the index of the first IRQ vector in the vector table. (i.e. vector table index is exception_num plus 16)</p>
 159 <p >There is one set of exception handlers per core, so the exception handlers for each core as set by these methods are independent.</p>
 160 <dl class="section note"><dt>Note</dt><dd>That all exception APIs affect the executing core only (i.e. the core calling the function). </dd></dl>
 161 <h2 class="groupheader">Typedef Documentation</h2>
 162 <a id="ga4de8b8ce1d704966edfc547190f73f0b" name="ga4de8b8ce1d704966edfc547190f73f0b"></a>
 163 <h2 class="memtitle"><span class="permalink"><a href="#ga4de8b8ce1d704966edfc547190f73f0b">&#9670;&nbsp;</a></span>exception_handler_t</h2>
 164
 165 <div class="memitem">
 166 <div class="memproto">
 167       <table class="memname">
 168         <tr>
 169           <td class="memname">typedef void(* exception_handler_t) (void)</td>
 170         </tr>
 171       </table>
 172 </div><div class="memdoc">
 173
 174 <p>Exception handler function type. </p>
 175 <p >All exception handlers should be of this type, and follow normal ARM EABI register saving conventions </p>
 176
 177 </div>
 178 </div>
 179 <h2 class="groupheader">Enumeration Type Documentation</h2>
 180 <a id="ga504f1c3a5a6959d430665f5d72cf335a" name="ga504f1c3a5a6959d430665f5d72cf335a"></a>
 181 <h2 class="memtitle"><span class="permalink"><a href="#ga504f1c3a5a6959d430665f5d72cf335a">&#9670;&nbsp;</a></span>exception_number</h2>
 182
 183 <div class="memitem">
 184 <div class="memproto">
 185       <table class="memname">
 186         <tr>
 187           <td class="memname">enum <a class="el" href="group__hardware__exception.html#ga504f1c3a5a6959d430665f5d72cf335a">exception_number</a></td>
 188         </tr>
 189       </table>
 190 </div><div class="memdoc">
 191
 192 <p>Exception number definitions. </p>
 193 <p >On Arm these are vector table indices:</p>
 194 <table class="markdownTable">
 195 <tr class="markdownTableHead">
 196 <th class="markdownTableHeadNone">Name   </th><th class="markdownTableHeadNone">Value   </th><th class="markdownTableHeadNone">Exception    </th></tr>
 197 <tr class="markdownTableRowOdd">
 198 <td class="markdownTableBodyNone">NMI_EXCEPTION   </td><td class="markdownTableBodyNone">2   </td><td class="markdownTableBodyNone">Non Maskable Interrupt    </td></tr>
 199 <tr class="markdownTableRowEven">
 200 <td class="markdownTableBodyNone">HARDFAULT_EXCEPTION   </td><td class="markdownTableBodyNone">3   </td><td class="markdownTableBodyNone">HardFault    </td></tr>
 201 <tr class="markdownTableRowOdd">
 202 <td class="markdownTableBodyNone">SVCALL_EXCEPTION   </td><td class="markdownTableBodyNone">11   </td><td class="markdownTableBodyNone">SV Call    </td></tr>
 203 <tr class="markdownTableRowEven">
 204 <td class="markdownTableBodyNone">PENDSV_EXCEPTION   </td><td class="markdownTableBodyNone">14   </td><td class="markdownTableBodyNone">Pend SV    </td></tr>
 205 <tr class="markdownTableRowOdd">
 206 <td class="markdownTableBodyNone">SYSTICK_EXCEPTION   </td><td class="markdownTableBodyNone">15   </td><td class="markdownTableBodyNone">System Tick   </td></tr>
 207 </table>
 208 <p >On RISC-V these are exception cause numbers:</p>
 209 <table class="markdownTable">
 210 <tr class="markdownTableHead">
 211 <th class="markdownTableHeadNone">Name   </th><th class="markdownTableHeadNone">Value   </th><th class="markdownTableHeadNone">Exception    </th></tr>
 212 <tr class="markdownTableRowOdd">
 213 <td class="markdownTableBodyNone">INSTR_ALIGN_EXCEPTION   </td><td class="markdownTableBodyNone">0   </td><td class="markdownTableBodyNone">Instruction fetch misaligned    </td></tr>
 214 <tr class="markdownTableRowEven">
 215 <td class="markdownTableBodyNone">INSTR_FAULT_EXCEPTION   </td><td class="markdownTableBodyNone">1   </td><td class="markdownTableBodyNone">Instruction fetch bus fault    </td></tr>
 216 <tr class="markdownTableRowOdd">
 217 <td class="markdownTableBodyNone">INSTR_ILLEGAL_EXCEPTION   </td><td class="markdownTableBodyNone">2   </td><td class="markdownTableBodyNone">Invalid or illegal instruction    </td></tr>
 218 <tr class="markdownTableRowEven">
 219 <td class="markdownTableBodyNone">EBREAK_EXCEPTION   </td><td class="markdownTableBodyNone">3   </td><td class="markdownTableBodyNone">ebreak was not caught by an ex    </td></tr>
 220 <tr class="markdownTableRowOdd">
 221 <td class="markdownTableBodyNone">LOAD_ALIGN_EXCEPTION   </td><td class="markdownTableBodyNone">4   </td><td class="markdownTableBodyNone">Load address not naturally ali    </td></tr>
 222 <tr class="markdownTableRowEven">
 223 <td class="markdownTableBodyNone">LOAD_FAULT_EXCEPTION   </td><td class="markdownTableBodyNone">5   </td><td class="markdownTableBodyNone">Load bus fault    </td></tr>
 224 <tr class="markdownTableRowOdd">
 225 <td class="markdownTableBodyNone">STORE_ALIGN_EXCEPTION   </td><td class="markdownTableBodyNone">6   </td><td class="markdownTableBodyNone">Store or AMO address not natur    </td></tr>
 226 <tr class="markdownTableRowEven">
 227 <td class="markdownTableBodyNone">STORE_FAULT_EXCEPTION   </td><td class="markdownTableBodyNone">7   </td><td class="markdownTableBodyNone">Store or AMO bus fault    </td></tr>
 228 <tr class="markdownTableRowOdd">
 229 <td class="markdownTableBodyNone">ECALL_UMODE_EXCEPTION   </td><td class="markdownTableBodyNone">8   </td><td class="markdownTableBodyNone">ecall was executed in U-mode    </td></tr>
 230 <tr class="markdownTableRowEven">
 231 <td class="markdownTableBodyNone">ECALL_SMODE_EXCEPTION   </td><td class="markdownTableBodyNone">9   </td><td class="markdownTableBodyNone">ecall was executed in S-mode    </td></tr>
 232 <tr class="markdownTableRowOdd">
 233 <td class="markdownTableBodyNone">ECALL_MMODE_EXCEPTION   </td><td class="markdownTableBodyNone">11   </td><td class="markdownTableBodyNone">ecall was executed in M-mode   </td></tr>
 234 </table>
 235 <table class="fieldtable">
 236 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga504f1c3a5a6959d430665f5d72cf335aa6e8a4e796361d59517c80affc6e93cd7" name="gga504f1c3a5a6959d430665f5d72cf335aa6e8a4e796361d59517c80affc6e93cd7"></a>NMI_EXCEPTION&#160;</td><td class="fielddoc"><p >Non Maskable Interrupt. </p>
 237 </td></tr>
 238 <tr><td class="fieldname"><a id="gga504f1c3a5a6959d430665f5d72cf335aadf88404244d6cf50e5103848de3892e2" name="gga504f1c3a5a6959d430665f5d72cf335aadf88404244d6cf50e5103848de3892e2"></a>HARDFAULT_EXCEPTION&#160;</td><td class="fielddoc"><p >HardFault Interrupt. </p>
 239 </td></tr>
 240 <tr><td class="fieldname"><a id="gga504f1c3a5a6959d430665f5d72cf335aa1e7d691476a041fb59915e046e85d586" name="gga504f1c3a5a6959d430665f5d72cf335aa1e7d691476a041fb59915e046e85d586"></a>SVCALL_EXCEPTION&#160;</td><td class="fielddoc"><p >SV Call Interrupt. </p>
 241 </td></tr>
 242 <tr><td class="fieldname"><a id="gga504f1c3a5a6959d430665f5d72cf335aae6e5980728dbb2ff717a7867bdb25a3a" name="gga504f1c3a5a6959d430665f5d72cf335aae6e5980728dbb2ff717a7867bdb25a3a"></a>PENDSV_EXCEPTION&#160;</td><td class="fielddoc"><p >Pend SV Interrupt. </p>
 243 </td></tr>
 244 <tr><td class="fieldname"><a id="gga504f1c3a5a6959d430665f5d72cf335aa05ced3409f791060c7eab53bc557c333" name="gga504f1c3a5a6959d430665f5d72cf335aa05ced3409f791060c7eab53bc557c333"></a>SYSTICK_EXCEPTION&#160;</td><td class="fielddoc"><p >System Tick Interrupt. </p>
 245 </td></tr>
 246 </table>
 247
 248 </div>
 249 </div>
 250 <h2 class="groupheader">Function Documentation</h2>
 251 <a id="ga7189f5bb3db0bf08c76cb79c1235a71a" name="ga7189f5bb3db0bf08c76cb79c1235a71a"></a>
 252 <h2 class="memtitle"><span class="permalink"><a href="#ga7189f5bb3db0bf08c76cb79c1235a71a">&#9670;&nbsp;</a></span>exception_get_priority()</h2>
 253
 254 <div class="memitem">
 255 <div class="memproto">
 256       <table class="memname">
 257         <tr>
 258           <td class="memname">uint exception_get_priority </td>
 259           <td>(</td>
 260           <td class="paramtype">uint&#160;</td>
 261           <td class="paramname"><em>num</em></td><td>)</td>
 262           <td></td>
 263         </tr>
 264       </table>
 265 </div><div class="memdoc">
 266
 267 <p>Get specified exception's priority. </p>
 268 <p >Numerically-lower values indicate a higher priority. Hardware priorities range from 0 (highest priority) to 255 (lowest priority).</p>
 269 <p >Only the top 2 bits are significant on ARM Cortex-M0+ on RP2040. </p>
 270 <p >Only the top 4 bits are significant on ARM Cortex-M33 on RP2350, and exception priorities are not supported on RISC-V </p>
 271 <dl class="params"><dt>Parameters</dt><dd>
 272   <table class="params">
 273     <tr><td class="paramname">num</td><td>Exception number <a class="el" href="group__hardware__exception.html#ga504f1c3a5a6959d430665f5d72cf335a">exception_number</a> </td></tr>
 274   </table>
 275   </dd>
 276 </dl>
 277 <dl class="section return"><dt>Returns</dt><dd>the exception priority </dd></dl>
 278
 279 </div>
 280 </div>
 281 <a id="ga51b870aeeca94e21bd35bdfbab20e706" name="ga51b870aeeca94e21bd35bdfbab20e706"></a>
 282 <h2 class="memtitle"><span class="permalink"><a href="#ga51b870aeeca94e21bd35bdfbab20e706">&#9670;&nbsp;</a></span>exception_get_vtable_handler()</h2>
 283
 284 <div class="memitem">
 285 <div class="memproto">
 286       <table class="memname">
 287         <tr>
 288           <td class="memname"><a class="el" href="group__hardware__exception.html#ga4de8b8ce1d704966edfc547190f73f0b">exception_handler_t</a> exception_get_vtable_handler </td>
 289           <td>(</td>
 290           <td class="paramtype">enum <a class="el" href="group__hardware__exception.html#ga504f1c3a5a6959d430665f5d72cf335a">exception_number</a>&#160;</td>
 291           <td class="paramname"><em>num</em></td><td>)</td>
 292           <td></td>
 293         </tr>
 294       </table>
 295 </div><div class="memdoc">
 296
 297 <p>Get the current exception handler for the specified exception from the currently installed vector table of the execution core. </p>
 298 <dl class="params"><dt>Parameters</dt><dd>
 299   <table class="params">
 300     <tr><td class="paramname">num</td><td>Exception number </td></tr>
 301   </table>
 302   </dd>
 303 </dl>
 304 <dl class="section return"><dt>Returns</dt><dd>the address stored in the VTABLE for the given exception number </dd></dl>
 305
 306 </div>
 307 </div>
 308 <a id="gabd73e0f58d5d1149a77a521c0dceb9cb" name="gabd73e0f58d5d1149a77a521c0dceb9cb"></a>
 309 <h2 class="memtitle"><span class="permalink"><a href="#gabd73e0f58d5d1149a77a521c0dceb9cb">&#9670;&nbsp;</a></span>exception_restore_handler()</h2>
 310
 311 <div class="memitem">
 312 <div class="memproto">
 313       <table class="memname">
 314         <tr>
 315           <td class="memname">void exception_restore_handler </td>
 316           <td>(</td>
 317           <td class="paramtype">enum <a class="el" href="group__hardware__exception.html#ga504f1c3a5a6959d430665f5d72cf335a">exception_number</a>&#160;</td>
 318           <td class="paramname"><em>num</em>, </td>
 319         </tr>
 320         <tr>
 321           <td class="paramkey"></td>
 322           <td></td>
 323           <td class="paramtype"><a class="el" href="group__hardware__exception.html#ga4de8b8ce1d704966edfc547190f73f0b">exception_handler_t</a>&#160;</td>
 324           <td class="paramname"><em>original_handler</em>&#160;</td>
 325         </tr>
 326         <tr>
 327           <td></td>
 328           <td>)</td>
 329           <td></td><td></td>
 330         </tr>
 331       </table>
 332 </div><div class="memdoc">
 333
 334 <p>Restore the original exception handler for an exception on this core. </p>
 335 <p >This method may be used to restore the exception handler for an exception on this core to the state prior to the call to <a class="el" href="group__hardware__exception.html#ga0c49b97eb751230b3d77459e7bfe98f5" title="Set the exception handler for an exception on the executing core.">exception_set_exclusive_handler()</a>, so that <a class="el" href="group__hardware__exception.html#ga0c49b97eb751230b3d77459e7bfe98f5" title="Set the exception handler for an exception on the executing core.">exception_set_exclusive_handler()</a> may be called again in the future.</p>
 336 <dl class="params"><dt>Parameters</dt><dd>
 337   <table class="params">
 338     <tr><td class="paramname">num</td><td>Exception number <a class="el" href="group__hardware__exception.html#ga504f1c3a5a6959d430665f5d72cf335a">exception_number</a> </td></tr>
 339     <tr><td class="paramname">original_handler</td><td>The original handler returned from <a class="el" href="group__hardware__exception.html#ga0c49b97eb751230b3d77459e7bfe98f5">exception_set_exclusive_handler</a> </td></tr>
 340   </table>
 341   </dd>
 342 </dl>
 343 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__hardware__exception.html#ga0c49b97eb751230b3d77459e7bfe98f5" title="Set the exception handler for an exception on the executing core.">exception_set_exclusive_handler()</a> </dd></dl>
 344
 345 </div>
 346 </div>
 347 <a id="ga0c49b97eb751230b3d77459e7bfe98f5" name="ga0c49b97eb751230b3d77459e7bfe98f5"></a>
 348 <h2 class="memtitle"><span class="permalink"><a href="#ga0c49b97eb751230b3d77459e7bfe98f5">&#9670;&nbsp;</a></span>exception_set_exclusive_handler()</h2>
 349
 350 <div class="memitem">
 351 <div class="memproto">
 352       <table class="memname">
 353         <tr>
 354           <td class="memname"><a class="el" href="group__hardware__exception.html#ga4de8b8ce1d704966edfc547190f73f0b">exception_handler_t</a> exception_set_exclusive_handler </td>
 355           <td>(</td>
 356           <td class="paramtype">enum <a class="el" href="group__hardware__exception.html#ga504f1c3a5a6959d430665f5d72cf335a">exception_number</a>&#160;</td>
 357           <td class="paramname"><em>num</em>, </td>
 358         </tr>
 359         <tr>
 360           <td class="paramkey"></td>
 361           <td></td>
 362           <td class="paramtype"><a class="el" href="group__hardware__exception.html#ga4de8b8ce1d704966edfc547190f73f0b">exception_handler_t</a>&#160;</td>
 363           <td class="paramname"><em>handler</em>&#160;</td>
 364         </tr>
 365         <tr>
 366           <td></td>
 367           <td>)</td>
 368           <td></td><td></td>
 369         </tr>
 370       </table>
 371 </div><div class="memdoc">
 372
 373 <p>Set the exception handler for an exception on the executing core. </p>
 374 <p >This method will assert if an exception handler has been set for this exception number on this core via this method, without an intervening restore via exception_restore_handler.</p>
 375 <dl class="section note"><dt>Note</dt><dd>this method may not be used to override an exception handler that was specified at link time by providing a strong replacement for the weakly defined stub exception handlers. It will assert in this case too.</dd></dl>
 376 <dl class="params"><dt>Parameters</dt><dd>
 377   <table class="params">
 378     <tr><td class="paramname">num</td><td>Exception number </td></tr>
 379     <tr><td class="paramname">handler</td><td>The handler to set </td></tr>
 380   </table>
 381   </dd>
 382 </dl>
 383 <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__hardware__exception.html#ga504f1c3a5a6959d430665f5d72cf335a" title="Exception number definitions.">exception_number</a> </dd></dl>
 384
 385 </div>
 386 </div>
 387 <a id="ga6567fefaab2f557e12796f8d57bec124" name="ga6567fefaab2f557e12796f8d57bec124"></a>
 388 <h2 class="memtitle"><span class="permalink"><a href="#ga6567fefaab2f557e12796f8d57bec124">&#9670;&nbsp;</a></span>exception_set_priority()</h2>
 389
 390 <div class="memitem">
 391 <div class="memproto">
 392       <table class="memname">
 393         <tr>
 394           <td class="memname">bool exception_set_priority </td>
 395           <td>(</td>
 396           <td class="paramtype">uint&#160;</td>
 397           <td class="paramname"><em>num</em>, </td>
 398         </tr>
 399         <tr>
 400           <td class="paramkey"></td>
 401           <td></td>
 402           <td class="paramtype">uint8_t&#160;</td>
 403           <td class="paramname"><em>hardware_priority</em>&#160;</td>
 404         </tr>
 405         <tr>
 406           <td></td>
 407           <td>)</td>
 408           <td></td><td></td>
 409         </tr>
 410       </table>
 411 </div><div class="memdoc">
 412
 413 <p>Set specified exception's priority. </p>
 414 <dl class="params"><dt>Parameters</dt><dd>
 415   <table class="params">
 416     <tr><td class="paramname">num</td><td>Exception number <a class="el" href="group__hardware__exception.html#ga504f1c3a5a6959d430665f5d72cf335a">exception_number</a> </td></tr>
 417     <tr><td class="paramname">hardware_priority</td><td>Priority to set.</td></tr>
 418   </table>
 419   </dd>
 420 </dl>
 421 <p>Numerically-lower values indicate a higher priority. Hardware priorities range from 0 (highest priority) to 255 (lowest priority).</p>
 422 <p >Only the top 2 bits are significant on ARM Cortex-M0+ on RP2040. </p>
 423 <p >Only the top 4 bits are significant on ARM Cortex-M33 on RP2350, and exception priorities are not supported on RISC-V  </p>
 424
 425 </div>
 426 </div>
 427 </div><!-- contents -->
 428 </div><!-- doc-content -->
 429
 430         <script src="main.js"></script>
 431 </body>
 432 </html>