psdk_cust/ipc_3_43_00_00_eng/docs/doxygen/html/_notify_8h.html

   1 <!-- HTML header for doxygen 1.8.9.1-->
   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="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.8.9.1"/>
   8 <title>IPC API: ti/ipc/Notify.h File Reference</title>
   9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13 <script type="text/javascript" src="search/searchdata.js"></script>
  14 <script type="text/javascript" src="search/search.js"></script>
  15 <script type="text/javascript">
  16   $(document).ready(function() { init_search(); });
  17 </script>
  18 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  19 </head>
  20 <body>
  21 <table width="100%">
  22 <tr>
  23   <td bgcolor="black" width="1"><a href="http://www.ti.com"><img border="0" src="tilogo.gif" /></a></td>
  24   <td bgcolor="red"><img src="titagline.gif" /></td>
  25 </tr>
  26 </table>
  27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  28 <div id="titlearea">
  29 <table cellspacing="0" cellpadding="0">
  30  <tbody>
  31  <tr style="height: 56px;">
  32   <td style="padding-left: 0.5em;">
  33    <div id="projectname">IPC API
  34    &#160;<span id="projectnumber">3.43.00.00_eng</span>
  35    </div>
  36   </td>
  37  </tr>
  38  </tbody>
  39 </table>
  40 </div>
  41 <!-- end header part -->
  42 <!-- Generated by Doxygen 1.8.9.1 -->
  43 <script type="text/javascript">
  44 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  45 </script>
  46   <div id="navrow1" class="tabs">
  47     <ul class="tablist">
  48       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  49       <li><a href="modules.html"><span>Modules</span></a></li>
  50       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  51       <li class="current"><a href="files.html"><span>Files</span></a></li>
  52       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  53       <li>
  54         <div id="MSearchBox" class="MSearchBoxInactive">
  55         <span class="left">
  56           <img id="MSearchSelect" src="search/mag_sel.png"
  57                onmouseover="return searchBox.OnSearchSelectShow()"
  58                onmouseout="return searchBox.OnSearchSelectHide()"
  59                alt=""/>
  60           <input type="text" id="MSearchField" value="Search" accesskey="S"
  61                onfocus="searchBox.OnSearchFieldFocus(true)"
  62                onblur="searchBox.OnSearchFieldFocus(false)"
  63                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  64           </span><span class="right">
  65             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  66           </span>
  67         </div>
  68       </li>
  69     </ul>
  70   </div>
  71   <div id="navrow2" class="tabs2">
  72     <ul class="tablist">
  73       <li><a href="files.html"><span>File&#160;List</span></a></li>
  74       <li><a href="globals.html"><span>Globals</span></a></li>
  75     </ul>
  76   </div>
  77 <!-- window showing the filter options -->
  78 <div id="MSearchSelectWindow"
  79      onmouseover="return searchBox.OnSearchSelectShow()"
  80      onmouseout="return searchBox.OnSearchSelectHide()"
  81      onkeydown="return searchBox.OnSearchSelectKey(event)">
  82 </div>
  83
  84 <!-- iframe showing the search results (closed by default) -->
  85 <div id="MSearchResultsWindow">
  86 <iframe src="javascript:void(0)" frameborder="0"
  87         name="MSearchResults" id="MSearchResults">
  88 </iframe>
  89 </div>
  90
  91 <div id="nav-path" class="navpath">
  92   <ul>
  93 <li class="navelem"><a class="el" href="dir_46079174fecd82ead33d8fa28082a6fc.html">ti</a></li><li class="navelem"><a class="el" href="dir_d15d182bf14778c656928067305f92ce.html">ipc</a></li>  </ul>
  94 </div>
  95 </div><!-- top -->
  96 <div class="header">
  97   <div class="summary">
  98 <a href="#define-members">Macros</a> &#124;
  99 <a href="#typedef-members">Typedefs</a> &#124;
 100 <a href="#func-members">Functions</a>  </div>
 101   <div class="headertitle">
 102 <div class="title">Notify.h File Reference</div>  </div>
 103 </div><!--header-->
 104 <div class="contents">
 105 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 106 <div class="textblock"><p>Notification manager for IPC. </p>
 107 <dl class="section note"><dt>Note</dt><dd>Notify is currently only available for SYS/BIOS.</dd></dl>
 108 <p>The Notify module manages the multiplexing/demultiplexing of software interrupts over hardware interrupts. In order to receive notifications, a processor registers one or more callback functions to an eventId using <a class="el" href="_notify_8h.html#af0e6797faaeea3d07121ad83394dd1cb" title="Register a callback for an event (supports multiple callbacks) ">Notify_registerEvent()</a>. The <a class="el" href="_notify_8h.html#af0e6797faaeea3d07121ad83394dd1cb" title="Register a callback for an event (supports multiple callbacks) ">Notify_registerEvent()</a> call (like most other Notify APIs) uses a MultiProc id and line id to target a specific interrupt line to/from a specific processor on a device. The <a class="el" href="_notify_8h.html#a35609c7bf129016087dd520be69c14cf" title="Whether an unused event is available on an interrupt line. ">Notify_eventAvailable()</a> API may be used to query whether an event id is available for use before registration.</p>
 109 <p>Once an event has been registered, a remote processor may send an event using the <a class="el" href="_notify_8h.html#ac0f8b4cb2245dd897b5b75485f6b5c13" title="Send an event on an interrupt line. ">Notify_sendEvent()</a> call. If the event and the interrupt line are both enabled, all callback functions registered to the event will be called sequentially.</p>
 110 <p>A specific event may be disabled or enabled using the <a class="el" href="_notify_8h.html#acb0512fe9bdbc30a1bd6d055d3c662d0" title="Disable an event. ">Notify_disableEvent()</a> and <a class="el" href="_notify_8h.html#a701ab77f8cd9b811dcca05e243815b85" title="Enable an event. ">Notify_enableEvent()</a> calls. An entire interrupt line may be disabled or restored using the <a class="el" href="_notify_8h.html#a0eeb5a2e898a287ec0e31be4e6a92364" title="Disable ability to receive interrupts on an interrupt line. ">Notify_disable()</a> or <a class="el" href="_notify_8h.html#a07248810e2b457664a2a1f24a4179621" title="Restore ability to receive interrupts on an interrupt line. ">Notify_restore()</a> calls. <a class="el" href="_notify_8h.html#a0eeb5a2e898a287ec0e31be4e6a92364" title="Disable ability to receive interrupts on an interrupt line. ">Notify_disable()</a> does not alter the state of individual events. Instead, it just disables the ability of the Notify module to receive events on the interrupt line.</p>
 111 <p>Notify APIs should never be called within an Hwi context. All API calls should be made within main(), a Task or a Swi with the exception of <a class="el" href="_notify_8h.html#ac0f8b4cb2245dd897b5b75485f6b5c13" title="Send an event on an interrupt line. ">Notify_sendEvent()</a> which may also be called within a Hwi.</p>
 112 <p>"Loopback" functionality allows Notifications to be registered and sent locally. This is accomplished by supplying our own MultiProc id to Notify APIs. Line id #0 is always used for local notifications. It is important to be aware of some subtle (but important) differences between remote and local notifications:</p><ul>
 113 <li>Loopback callback functions will execute in the same thread in which <a class="el" href="_notify_8h.html#ac0f8b4cb2245dd897b5b75485f6b5c13" title="Send an event on an interrupt line. ">Notify_sendEvent()</a> is called. This is in contrast to callback functions that are called due to another processor's sent notification- these 'remote' callback functions will execute in an ISR context.</li>
 114 <li>Loopback callback functions will execute with interrupts disabled</li>
 115 <li>Disabling the local interrupt line will cause all notifications that are sent to the local processor to be lost. By contrast, a notification sent to an enabled event on a remote processor that has called <a class="el" href="_notify_8h.html#a0eeb5a2e898a287ec0e31be4e6a92364" title="Disable ability to receive interrupts on an interrupt line. ">Notify_disable()</a> results in a pending notifications until the disabled processor has called <a class="el" href="_notify_8h.html#a07248810e2b457664a2a1f24a4179621" title="Restore ability to receive interrupts on an interrupt line. ">Notify_restore()</a>.</li>
 116 <li>Local notifications do not support events of different priorities. By contrast, Notify driver implementations may correlate event ids with varying priorities.</li>
 117 </ul>
 118 <p>In order to use any Notify APIs all necessary Notify drivers, shared memory and interprocessor interrupts must be initialized. This is typically done by <a class="el" href="_ipc_8h.html#aca550c6a5498637cfec7b0f4e6d07828" title="Reserves memory, creates default GateMP and HeapMemMP. ">Ipc_start()</a>, which internally call <a class="el" href="_notify_8h.html#a2d6e7fc00357b58ddc2a860e6bd4bf80" title="Creates notify drivers and registers them with Notify. ">Notify_attach()</a>. It is possible for a user application to call <a class="el" href="_notify_8h.html#a2d6e7fc00357b58ddc2a860e6bd4bf80" title="Creates notify drivers and registers them with Notify. ">Notify_attach()</a> directly (before <a class="el" href="_ipc_8h.html#a170f84915df79377080be708302bcb08" title="Attach to remote processor. ">Ipc_attach()</a> or <a class="el" href="_ipc_8h.html#aca550c6a5498637cfec7b0f4e6d07828" title="Reserves memory, creates default GateMP and HeapMemMP. ">Ipc_start()</a>) if notifications must be set up prior to runtime SharedRegion initialization. Refer to the documentation for <a class="el" href="_notify_8h.html#a2d6e7fc00357b58ddc2a860e6bd4bf80" title="Creates notify drivers and registers them with Notify. ">Notify_attach()</a> for more information.</p>
 119 <p>The Notify header should be included in an application as follows: </p><div class="fragment"><div class="line"><span class="preprocessor">#include &lt;<a class="code" href="_notify_8h.html">ti/ipc/Notify.h</a>&gt;</span></div>
 120 </div><!-- fragment --> </div>
 121 <p><a href="_notify_8h_source.html">Go to the source code of this file.</a></p>
 122 <table class="memberdecls">
 123 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
 124 Macros</h2></td></tr>
 125 <tr class="memitem:a0d58ddfdb5d08f6ca1de749701033450"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#a0d58ddfdb5d08f6ca1de749701033450">Notify_S_BUSY</a>&#160;&#160;&#160;(2)</td></tr>
 126 <tr class="memdesc:a0d58ddfdb5d08f6ca1de749701033450"><td class="mdescLeft">&#160;</td><td class="mdescRight">The resource is still in use.  <a href="#a0d58ddfdb5d08f6ca1de749701033450">More...</a><br /></td></tr>
 127 <tr class="separator:a0d58ddfdb5d08f6ca1de749701033450"><td class="memSeparator" colspan="2">&#160;</td></tr>
 128 <tr class="memitem:a4a3b8a694b528547f8478d0b9e24289c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#a4a3b8a694b528547f8478d0b9e24289c">Notify_S_ALREADYSETUP</a>&#160;&#160;&#160;(1)</td></tr>
 129 <tr class="memdesc:a4a3b8a694b528547f8478d0b9e24289c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Module already set up.  <a href="#a4a3b8a694b528547f8478d0b9e24289c">More...</a><br /></td></tr>
 130 <tr class="separator:a4a3b8a694b528547f8478d0b9e24289c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 131 <tr class="memitem:a846ddddd026310bcbcda9837a3571ba4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#a846ddddd026310bcbcda9837a3571ba4">Notify_S_SUCCESS</a>&#160;&#160;&#160;(0)</td></tr>
 132 <tr class="memdesc:a846ddddd026310bcbcda9837a3571ba4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Operation is successful.  <a href="#a846ddddd026310bcbcda9837a3571ba4">More...</a><br /></td></tr>
 133 <tr class="separator:a846ddddd026310bcbcda9837a3571ba4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 134 <tr class="memitem:a20a2a59166c514c653d7eed49344566e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#a20a2a59166c514c653d7eed49344566e">Notify_E_FAIL</a>&#160;&#160;&#160;(-1)</td></tr>
 135 <tr class="memdesc:a20a2a59166c514c653d7eed49344566e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generic failure.  <a href="#a20a2a59166c514c653d7eed49344566e">More...</a><br /></td></tr>
 136 <tr class="separator:a20a2a59166c514c653d7eed49344566e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 137 <tr class="memitem:a31fc3f7c99af3b98e9fd9f666cc4e2f3"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#a31fc3f7c99af3b98e9fd9f666cc4e2f3">Notify_E_INVALIDARG</a>&#160;&#160;&#160;(-2)</td></tr>
 138 <tr class="memdesc:a31fc3f7c99af3b98e9fd9f666cc4e2f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Argument passed to function is invalid.  <a href="#a31fc3f7c99af3b98e9fd9f666cc4e2f3">More...</a><br /></td></tr>
 139 <tr class="separator:a31fc3f7c99af3b98e9fd9f666cc4e2f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 140 <tr class="memitem:aa74af2d630f14ab3083a587ef0337184"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#aa74af2d630f14ab3083a587ef0337184">Notify_E_MEMORY</a>&#160;&#160;&#160;(-3)</td></tr>
 141 <tr class="memdesc:aa74af2d630f14ab3083a587ef0337184"><td class="mdescLeft">&#160;</td><td class="mdescRight">Operation resulted in memory failure.  <a href="#aa74af2d630f14ab3083a587ef0337184">More...</a><br /></td></tr>
 142 <tr class="separator:aa74af2d630f14ab3083a587ef0337184"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 <tr class="memitem:aea5c89c302ce37850d8819c85e29ce97"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#aea5c89c302ce37850d8819c85e29ce97">Notify_E_ALREADYEXISTS</a>&#160;&#160;&#160;(-4)</td></tr>
 144 <tr class="memdesc:aea5c89c302ce37850d8819c85e29ce97"><td class="mdescLeft">&#160;</td><td class="mdescRight">The specified entity already exists.  <a href="#aea5c89c302ce37850d8819c85e29ce97">More...</a><br /></td></tr>
 145 <tr class="separator:aea5c89c302ce37850d8819c85e29ce97"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 <tr class="memitem:a1c9a19382cfb8c48de9bc3e52e9f7635"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#a1c9a19382cfb8c48de9bc3e52e9f7635">Notify_E_NOTFOUND</a>&#160;&#160;&#160;(-5)</td></tr>
 147 <tr class="memdesc:a1c9a19382cfb8c48de9bc3e52e9f7635"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unable to find the specified entity.  <a href="#a1c9a19382cfb8c48de9bc3e52e9f7635">More...</a><br /></td></tr>
 148 <tr class="separator:a1c9a19382cfb8c48de9bc3e52e9f7635"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 <tr class="memitem:a546b13cc1d684582073aaa256652fbc4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#a546b13cc1d684582073aaa256652fbc4">Notify_E_TIMEOUT</a>&#160;&#160;&#160;(-6)</td></tr>
 150 <tr class="memdesc:a546b13cc1d684582073aaa256652fbc4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Operation timed out.  <a href="#a546b13cc1d684582073aaa256652fbc4">More...</a><br /></td></tr>
 151 <tr class="separator:a546b13cc1d684582073aaa256652fbc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 <tr class="memitem:a14366d0247e7dda6144f851b60121125"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#a14366d0247e7dda6144f851b60121125">Notify_E_INVALIDSTATE</a>&#160;&#160;&#160;(-7)</td></tr>
 153 <tr class="memdesc:a14366d0247e7dda6144f851b60121125"><td class="mdescLeft">&#160;</td><td class="mdescRight">Module is not initialized.  <a href="#a14366d0247e7dda6144f851b60121125">More...</a><br /></td></tr>
 154 <tr class="separator:a14366d0247e7dda6144f851b60121125"><td class="memSeparator" colspan="2">&#160;</td></tr>
 155 <tr class="memitem:a62c9f5fc1a523a1d7efc2685c939a92b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#a62c9f5fc1a523a1d7efc2685c939a92b">Notify_E_OSFAILURE</a>&#160;&#160;&#160;(-8)</td></tr>
 156 <tr class="memdesc:a62c9f5fc1a523a1d7efc2685c939a92b"><td class="mdescLeft">&#160;</td><td class="mdescRight">A failure occurred in an OS-specific call.  <a href="#a62c9f5fc1a523a1d7efc2685c939a92b">More...</a><br /></td></tr>
 157 <tr class="separator:a62c9f5fc1a523a1d7efc2685c939a92b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 158 <tr class="memitem:abd83fd46add74de157a57a8458c67021"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#abd83fd46add74de157a57a8458c67021">Notify_E_ALREADYSETUP</a>&#160;&#160;&#160;(-9)</td></tr>
 159 <tr class="memdesc:abd83fd46add74de157a57a8458c67021"><td class="mdescLeft">&#160;</td><td class="mdescRight">The module has been already setup.  <a href="#abd83fd46add74de157a57a8458c67021">More...</a><br /></td></tr>
 160 <tr class="separator:abd83fd46add74de157a57a8458c67021"><td class="memSeparator" colspan="2">&#160;</td></tr>
 161 <tr class="memitem:aa4f6f673a3eb54bdcd65d1cefccb29e7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#aa4f6f673a3eb54bdcd65d1cefccb29e7">Notify_E_RESOURCE</a>&#160;&#160;&#160;(-10)</td></tr>
 162 <tr class="memdesc:aa4f6f673a3eb54bdcd65d1cefccb29e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specified resource is not available.  <a href="#aa4f6f673a3eb54bdcd65d1cefccb29e7">More...</a><br /></td></tr>
 163 <tr class="separator:aa4f6f673a3eb54bdcd65d1cefccb29e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 164 <tr class="memitem:a281da75d439e60a04a400bffdaf6c4f6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#a281da75d439e60a04a400bffdaf6c4f6">Notify_E_RESTART</a>&#160;&#160;&#160;(-11)</td></tr>
 165 <tr class="memdesc:a281da75d439e60a04a400bffdaf6c4f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Operation was interrupted. Please restart the operation.  <a href="#a281da75d439e60a04a400bffdaf6c4f6">More...</a><br /></td></tr>
 166 <tr class="separator:a281da75d439e60a04a400bffdaf6c4f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 167 <tr class="memitem:a21bc6c23823d736fb2589664d876d942"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#a21bc6c23823d736fb2589664d876d942">Notify_E_BUSY</a>&#160;&#160;&#160;(-12)</td></tr>
 168 <tr class="memdesc:a21bc6c23823d736fb2589664d876d942"><td class="mdescLeft">&#160;</td><td class="mdescRight">The resource is still in use.  <a href="#a21bc6c23823d736fb2589664d876d942">More...</a><br /></td></tr>
 169 <tr class="separator:a21bc6c23823d736fb2589664d876d942"><td class="memSeparator" colspan="2">&#160;</td></tr>
 170 <tr class="memitem:a545952549555e51f9e79011dc809c07c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#a545952549555e51f9e79011dc809c07c">Notify_E_DRIVERNOTREGISTERED</a>&#160;&#160;&#160;(-13)</td></tr>
 171 <tr class="memdesc:a545952549555e51f9e79011dc809c07c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Driver corresponding to the specified eventId is not registered.  <a href="#a545952549555e51f9e79011dc809c07c">More...</a><br /></td></tr>
 172 <tr class="separator:a545952549555e51f9e79011dc809c07c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 173 <tr class="memitem:ad9030d9269afff260cba4971288ea06d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#ad9030d9269afff260cba4971288ea06d">Notify_E_EVTNOTREGISTERED</a>&#160;&#160;&#160;(-14)</td></tr>
 174 <tr class="memdesc:ad9030d9269afff260cba4971288ea06d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event not registered.  <a href="#ad9030d9269afff260cba4971288ea06d">More...</a><br /></td></tr>
 175 <tr class="separator:ad9030d9269afff260cba4971288ea06d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 176 <tr class="memitem:a5f7397fead455e8973aff576329edeec"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#a5f7397fead455e8973aff576329edeec">Notify_E_EVTDISABLED</a>&#160;&#160;&#160;(-15)</td></tr>
 177 <tr class="memdesc:a5f7397fead455e8973aff576329edeec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event is disabled.  <a href="#a5f7397fead455e8973aff576329edeec">More...</a><br /></td></tr>
 178 <tr class="separator:a5f7397fead455e8973aff576329edeec"><td class="memSeparator" colspan="2">&#160;</td></tr>
 179 <tr class="memitem:a78efd69afedc82d2912adb9f668c2c54"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#a78efd69afedc82d2912adb9f668c2c54">Notify_E_NOTINITIALIZED</a>&#160;&#160;&#160;(-16)</td></tr>
 180 <tr class="memdesc:a78efd69afedc82d2912adb9f668c2c54"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remote notification is not initialized.  <a href="#a78efd69afedc82d2912adb9f668c2c54">More...</a><br /></td></tr>
 181 <tr class="separator:a78efd69afedc82d2912adb9f668c2c54"><td class="memSeparator" colspan="2">&#160;</td></tr>
 182 <tr class="memitem:a68460eb33839572c7416387b91e33e68"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#a68460eb33839572c7416387b91e33e68">Notify_E_EVTRESERVED</a>&#160;&#160;&#160;(-17)</td></tr>
 183 <tr class="memdesc:a68460eb33839572c7416387b91e33e68"><td class="mdescLeft">&#160;</td><td class="mdescRight">Trying to illegally use a reserved event.  <a href="#a68460eb33839572c7416387b91e33e68">More...</a><br /></td></tr>
 184 <tr class="separator:a68460eb33839572c7416387b91e33e68"><td class="memSeparator" colspan="2">&#160;</td></tr>
 185 <tr class="memitem:afb698e2a48abcb1b698e80a16b38bf43"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#afb698e2a48abcb1b698e80a16b38bf43">Notify_MAXEVENTS</a>&#160;&#160;&#160;(UInt16)32</td></tr>
 186 <tr class="memdesc:afb698e2a48abcb1b698e80a16b38bf43"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum number of events supported by the Notify module.  <a href="#afb698e2a48abcb1b698e80a16b38bf43">More...</a><br /></td></tr>
 187 <tr class="separator:afb698e2a48abcb1b698e80a16b38bf43"><td class="memSeparator" colspan="2">&#160;</td></tr>
 188 <tr class="memitem:a67e0ce1661274a428248b143dd41dbfc"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#a67e0ce1661274a428248b143dd41dbfc">Notify_MAX_INTLINES</a>&#160;&#160;&#160;4u</td></tr>
 189 <tr class="memdesc:a67e0ce1661274a428248b143dd41dbfc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum number of IPC interrupt lines for any pair of processors.  <a href="#a67e0ce1661274a428248b143dd41dbfc">More...</a><br /></td></tr>
 190 <tr class="separator:a67e0ce1661274a428248b143dd41dbfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 191 <tr class="memitem:ac33600d8704857ef0afbbee3d4ce6d80"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#ac33600d8704857ef0afbbee3d4ce6d80">Notify_SYSTEMKEY</a>&#160;&#160;&#160;((UInt16)0xC1D2)</td></tr>
 192 <tr class="memdesc:ac33600d8704857ef0afbbee3d4ce6d80"><td class="mdescLeft">&#160;</td><td class="mdescRight">This key must be provided as the upper 16 bits of the eventId when registering for an event, if any reserved event numbers are to be used.  <a href="#ac33600d8704857ef0afbbee3d4ce6d80">More...</a><br /></td></tr>
 193 <tr class="separator:ac33600d8704857ef0afbbee3d4ce6d80"><td class="memSeparator" colspan="2">&#160;</td></tr>
 194 </table><table class="memberdecls">
 195 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
 196 Typedefs</h2></td></tr>
 197 <tr class="memitem:ab362f7571ee3d7f7abaa743914edcd62"><td class="memItemLeft" align="right" valign="top">typedef Void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#ab362f7571ee3d7f7abaa743914edcd62">Notify_FnNotifyCbck</a>) (UInt16, UInt16, UInt32, UArg, UInt32)</td></tr>
 198 <tr class="memdesc:ab362f7571ee3d7f7abaa743914edcd62"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signature of any callback function that can be registered with the Notify component.  <a href="#ab362f7571ee3d7f7abaa743914edcd62">More...</a><br /></td></tr>
 199 <tr class="separator:ab362f7571ee3d7f7abaa743914edcd62"><td class="memSeparator" colspan="2">&#160;</td></tr>
 200 </table><table class="memberdecls">
 201 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 202 Functions</h2></td></tr>
 203 <tr class="memitem:a2d6e7fc00357b58ddc2a860e6bd4bf80"><td class="memItemLeft" align="right" valign="top">Int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#a2d6e7fc00357b58ddc2a860e6bd4bf80">Notify_attach</a> (UInt16 remoteProcId, Ptr sharedAddr)</td></tr>
 204 <tr class="memdesc:a2d6e7fc00357b58ddc2a860e6bd4bf80"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates notify drivers and registers them with Notify.  <a href="#a2d6e7fc00357b58ddc2a860e6bd4bf80">More...</a><br /></td></tr>
 205 <tr class="separator:a2d6e7fc00357b58ddc2a860e6bd4bf80"><td class="memSeparator" colspan="2">&#160;</td></tr>
 206 <tr class="memitem:a0eeb5a2e898a287ec0e31be4e6a92364"><td class="memItemLeft" align="right" valign="top">UInt&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#a0eeb5a2e898a287ec0e31be4e6a92364">Notify_disable</a> (UInt16 procId, UInt16 lineId)</td></tr>
 207 <tr class="memdesc:a0eeb5a2e898a287ec0e31be4e6a92364"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable ability to receive interrupts on an interrupt line.  <a href="#a0eeb5a2e898a287ec0e31be4e6a92364">More...</a><br /></td></tr>
 208 <tr class="separator:a0eeb5a2e898a287ec0e31be4e6a92364"><td class="memSeparator" colspan="2">&#160;</td></tr>
 209 <tr class="memitem:acb0512fe9bdbc30a1bd6d055d3c662d0"><td class="memItemLeft" align="right" valign="top">Void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#acb0512fe9bdbc30a1bd6d055d3c662d0">Notify_disableEvent</a> (UInt16 procId, UInt16 lineId, UInt32 eventId)</td></tr>
 210 <tr class="memdesc:acb0512fe9bdbc30a1bd6d055d3c662d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable an event.  <a href="#acb0512fe9bdbc30a1bd6d055d3c662d0">More...</a><br /></td></tr>
 211 <tr class="separator:acb0512fe9bdbc30a1bd6d055d3c662d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 212 <tr class="memitem:a701ab77f8cd9b811dcca05e243815b85"><td class="memItemLeft" align="right" valign="top">Void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#a701ab77f8cd9b811dcca05e243815b85">Notify_enableEvent</a> (UInt16 procId, UInt16 lineId, UInt32 eventId)</td></tr>
 213 <tr class="memdesc:a701ab77f8cd9b811dcca05e243815b85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable an event.  <a href="#a701ab77f8cd9b811dcca05e243815b85">More...</a><br /></td></tr>
 214 <tr class="separator:a701ab77f8cd9b811dcca05e243815b85"><td class="memSeparator" colspan="2">&#160;</td></tr>
 215 <tr class="memitem:a35609c7bf129016087dd520be69c14cf"><td class="memItemLeft" align="right" valign="top">Bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#a35609c7bf129016087dd520be69c14cf">Notify_eventAvailable</a> (UInt16 procId, UInt16 lineId, UInt32 eventId)</td></tr>
 216 <tr class="memdesc:a35609c7bf129016087dd520be69c14cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether an unused event is available on an interrupt line.  <a href="#a35609c7bf129016087dd520be69c14cf">More...</a><br /></td></tr>
 217 <tr class="separator:a35609c7bf129016087dd520be69c14cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
 218 <tr class="memitem:a696ca01e7ee01649e5685081f6f8a425"><td class="memItemLeft" align="right" valign="top">Bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#a696ca01e7ee01649e5685081f6f8a425">Notify_intLineRegistered</a> (UInt16 procId, UInt16 lineId)</td></tr>
 219 <tr class="memdesc:a696ca01e7ee01649e5685081f6f8a425"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether notification via interrupt line has been registered.  <a href="#a696ca01e7ee01649e5685081f6f8a425">More...</a><br /></td></tr>
 220 <tr class="separator:a696ca01e7ee01649e5685081f6f8a425"><td class="memSeparator" colspan="2">&#160;</td></tr>
 221 <tr class="memitem:a195f48cdad4a2db36eb00bdbc752f8f9"><td class="memItemLeft" align="right" valign="top">UInt16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#a195f48cdad4a2db36eb00bdbc752f8f9">Notify_numIntLines</a> (UInt16 procId)</td></tr>
 222 <tr class="memdesc:a195f48cdad4a2db36eb00bdbc752f8f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns number of interrupt lines to remote processor.  <a href="#a195f48cdad4a2db36eb00bdbc752f8f9">More...</a><br /></td></tr>
 223 <tr class="separator:a195f48cdad4a2db36eb00bdbc752f8f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 224 <tr class="memitem:af0e6797faaeea3d07121ad83394dd1cb"><td class="memItemLeft" align="right" valign="top">Int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#af0e6797faaeea3d07121ad83394dd1cb">Notify_registerEvent</a> (UInt16 procId, UInt16 lineId, UInt32 eventId, <a class="el" href="_notify_8h.html#ab362f7571ee3d7f7abaa743914edcd62">Notify_FnNotifyCbck</a> fnNotifyCbck, UArg cbckArg)</td></tr>
 225 <tr class="memdesc:af0e6797faaeea3d07121ad83394dd1cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register a callback for an event (supports multiple callbacks)  <a href="#af0e6797faaeea3d07121ad83394dd1cb">More...</a><br /></td></tr>
 226 <tr class="separator:af0e6797faaeea3d07121ad83394dd1cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 227 <tr class="memitem:ad3d08088f515d57a3e4999a046267f49"><td class="memItemLeft" align="right" valign="top">Int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#ad3d08088f515d57a3e4999a046267f49">Notify_registerEventSingle</a> (UInt16 procId, UInt16 lineId, UInt32 eventId, <a class="el" href="_notify_8h.html#ab362f7571ee3d7f7abaa743914edcd62">Notify_FnNotifyCbck</a> fnNotifyCbck, UArg cbckArg)</td></tr>
 228 <tr class="memdesc:ad3d08088f515d57a3e4999a046267f49"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register a single callback for an event.  <a href="#ad3d08088f515d57a3e4999a046267f49">More...</a><br /></td></tr>
 229 <tr class="separator:ad3d08088f515d57a3e4999a046267f49"><td class="memSeparator" colspan="2">&#160;</td></tr>
 230 <tr class="memitem:a07248810e2b457664a2a1f24a4179621"><td class="memItemLeft" align="right" valign="top">Void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#a07248810e2b457664a2a1f24a4179621">Notify_restore</a> (UInt16 procId, UInt16 lineId, UInt key)</td></tr>
 231 <tr class="memdesc:a07248810e2b457664a2a1f24a4179621"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restore ability to receive interrupts on an interrupt line.  <a href="#a07248810e2b457664a2a1f24a4179621">More...</a><br /></td></tr>
 232 <tr class="separator:a07248810e2b457664a2a1f24a4179621"><td class="memSeparator" colspan="2">&#160;</td></tr>
 233 <tr class="memitem:ac0f8b4cb2245dd897b5b75485f6b5c13"><td class="memItemLeft" align="right" valign="top">Int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#ac0f8b4cb2245dd897b5b75485f6b5c13">Notify_sendEvent</a> (UInt16 procId, UInt16 lineId, UInt32 eventId, UInt32 payload, Bool waitClear)</td></tr>
 234 <tr class="memdesc:ac0f8b4cb2245dd897b5b75485f6b5c13"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send an event on an interrupt line.  <a href="#ac0f8b4cb2245dd897b5b75485f6b5c13">More...</a><br /></td></tr>
 235 <tr class="separator:ac0f8b4cb2245dd897b5b75485f6b5c13"><td class="memSeparator" colspan="2">&#160;</td></tr>
 236 <tr class="memitem:a04733f534741df34fb5c0fbd7cbab8bc"><td class="memItemLeft" align="right" valign="top">Int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#a04733f534741df34fb5c0fbd7cbab8bc">Notify_unregisterEvent</a> (UInt16 procId, UInt16 lineId, UInt32 eventId, <a class="el" href="_notify_8h.html#ab362f7571ee3d7f7abaa743914edcd62">Notify_FnNotifyCbck</a> fnNotifyCbck, UArg cbckArg)</td></tr>
 237 <tr class="memdesc:a04733f534741df34fb5c0fbd7cbab8bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove an event listener from an event.  <a href="#a04733f534741df34fb5c0fbd7cbab8bc">More...</a><br /></td></tr>
 238 <tr class="separator:a04733f534741df34fb5c0fbd7cbab8bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 239 <tr class="memitem:a7d8a78106ebe364b994f828d9b90f12f"><td class="memItemLeft" align="right" valign="top">Int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_notify_8h.html#a7d8a78106ebe364b994f828d9b90f12f">Notify_unregisterEventSingle</a> (UInt16 procId, UInt16 lineId, UInt32 eventId)</td></tr>
 240 <tr class="memdesc:a7d8a78106ebe364b994f828d9b90f12f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove an event listener from an event.  <a href="#a7d8a78106ebe364b994f828d9b90f12f">More...</a><br /></td></tr>
 241 <tr class="separator:a7d8a78106ebe364b994f828d9b90f12f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 242 </table>
 243 <h2 class="groupheader">Macro Definition Documentation</h2>
 244 <a class="anchor" id="a0d58ddfdb5d08f6ca1de749701033450"></a>
 245 <div class="memitem">
 246 <div class="memproto">
 247       <table class="memname">
 248         <tr>
 249           <td class="memname">#define Notify_S_BUSY&#160;&#160;&#160;(2)</td>
 250         </tr>
 251       </table>
 252 </div><div class="memdoc">
 253
 254 <p>The resource is still in use. </p>
 255
 256 </div>
 257 </div>
 258 <a class="anchor" id="a4a3b8a694b528547f8478d0b9e24289c"></a>
 259 <div class="memitem">
 260 <div class="memproto">
 261       <table class="memname">
 262         <tr>
 263           <td class="memname">#define Notify_S_ALREADYSETUP&#160;&#160;&#160;(1)</td>
 264         </tr>
 265       </table>
 266 </div><div class="memdoc">
 267
 268 <p>Module already set up. </p>
 269
 270 </div>
 271 </div>
 272 <a class="anchor" id="a846ddddd026310bcbcda9837a3571ba4"></a>
 273 <div class="memitem">
 274 <div class="memproto">
 275       <table class="memname">
 276         <tr>
 277           <td class="memname">#define Notify_S_SUCCESS&#160;&#160;&#160;(0)</td>
 278         </tr>
 279       </table>
 280 </div><div class="memdoc">
 281
 282 <p>Operation is successful. </p>
 283
 284 </div>
 285 </div>
 286 <a class="anchor" id="a20a2a59166c514c653d7eed49344566e"></a>
 287 <div class="memitem">
 288 <div class="memproto">
 289       <table class="memname">
 290         <tr>
 291           <td class="memname">#define Notify_E_FAIL&#160;&#160;&#160;(-1)</td>
 292         </tr>
 293       </table>
 294 </div><div class="memdoc">
 295
 296 <p>Generic failure. </p>
 297
 298 </div>
 299 </div>
 300 <a class="anchor" id="a31fc3f7c99af3b98e9fd9f666cc4e2f3"></a>
 301 <div class="memitem">
 302 <div class="memproto">
 303       <table class="memname">
 304         <tr>
 305           <td class="memname">#define Notify_E_INVALIDARG&#160;&#160;&#160;(-2)</td>
 306         </tr>
 307       </table>
 308 </div><div class="memdoc">
 309
 310 <p>Argument passed to function is invalid. </p>
 311
 312 </div>
 313 </div>
 314 <a class="anchor" id="aa74af2d630f14ab3083a587ef0337184"></a>
 315 <div class="memitem">
 316 <div class="memproto">
 317       <table class="memname">
 318         <tr>
 319           <td class="memname">#define Notify_E_MEMORY&#160;&#160;&#160;(-3)</td>
 320         </tr>
 321       </table>
 322 </div><div class="memdoc">
 323
 324 <p>Operation resulted in memory failure. </p>
 325
 326 </div>
 327 </div>
 328 <a class="anchor" id="aea5c89c302ce37850d8819c85e29ce97"></a>
 329 <div class="memitem">
 330 <div class="memproto">
 331       <table class="memname">
 332         <tr>
 333           <td class="memname">#define Notify_E_ALREADYEXISTS&#160;&#160;&#160;(-4)</td>
 334         </tr>
 335       </table>
 336 </div><div class="memdoc">
 337
 338 <p>The specified entity already exists. </p>
 339
 340 </div>
 341 </div>
 342 <a class="anchor" id="a1c9a19382cfb8c48de9bc3e52e9f7635"></a>
 343 <div class="memitem">
 344 <div class="memproto">
 345       <table class="memname">
 346         <tr>
 347           <td class="memname">#define Notify_E_NOTFOUND&#160;&#160;&#160;(-5)</td>
 348         </tr>
 349       </table>
 350 </div><div class="memdoc">
 351
 352 <p>Unable to find the specified entity. </p>
 353
 354 </div>
 355 </div>
 356 <a class="anchor" id="a546b13cc1d684582073aaa256652fbc4"></a>
 357 <div class="memitem">
 358 <div class="memproto">
 359       <table class="memname">
 360         <tr>
 361           <td class="memname">#define Notify_E_TIMEOUT&#160;&#160;&#160;(-6)</td>
 362         </tr>
 363       </table>
 364 </div><div class="memdoc">
 365
 366 <p>Operation timed out. </p>
 367
 368 </div>
 369 </div>
 370 <a class="anchor" id="a14366d0247e7dda6144f851b60121125"></a>
 371 <div class="memitem">
 372 <div class="memproto">
 373       <table class="memname">
 374         <tr>
 375           <td class="memname">#define Notify_E_INVALIDSTATE&#160;&#160;&#160;(-7)</td>
 376         </tr>
 377       </table>
 378 </div><div class="memdoc">
 379
 380 <p>Module is not initialized. </p>
 381
 382 </div>
 383 </div>
 384 <a class="anchor" id="a62c9f5fc1a523a1d7efc2685c939a92b"></a>
 385 <div class="memitem">
 386 <div class="memproto">
 387       <table class="memname">
 388         <tr>
 389           <td class="memname">#define Notify_E_OSFAILURE&#160;&#160;&#160;(-8)</td>
 390         </tr>
 391       </table>
 392 </div><div class="memdoc">
 393
 394 <p>A failure occurred in an OS-specific call. </p>
 395
 396 </div>
 397 </div>
 398 <a class="anchor" id="abd83fd46add74de157a57a8458c67021"></a>
 399 <div class="memitem">
 400 <div class="memproto">
 401       <table class="memname">
 402         <tr>
 403           <td class="memname">#define Notify_E_ALREADYSETUP&#160;&#160;&#160;(-9)</td>
 404         </tr>
 405       </table>
 406 </div><div class="memdoc">
 407
 408 <p>The module has been already setup. </p>
 409
 410 </div>
 411 </div>
 412 <a class="anchor" id="aa4f6f673a3eb54bdcd65d1cefccb29e7"></a>
 413 <div class="memitem">
 414 <div class="memproto">
 415       <table class="memname">
 416         <tr>
 417           <td class="memname">#define Notify_E_RESOURCE&#160;&#160;&#160;(-10)</td>
 418         </tr>
 419       </table>
 420 </div><div class="memdoc">
 421
 422 <p>Specified resource is not available. </p>
 423
 424 </div>
 425 </div>
 426 <a class="anchor" id="a281da75d439e60a04a400bffdaf6c4f6"></a>
 427 <div class="memitem">
 428 <div class="memproto">
 429       <table class="memname">
 430         <tr>
 431           <td class="memname">#define Notify_E_RESTART&#160;&#160;&#160;(-11)</td>
 432         </tr>
 433       </table>
 434 </div><div class="memdoc">
 435
 436 <p>Operation was interrupted. Please restart the operation. </p>
 437
 438 </div>
 439 </div>
 440 <a class="anchor" id="a21bc6c23823d736fb2589664d876d942"></a>
 441 <div class="memitem">
 442 <div class="memproto">
 443       <table class="memname">
 444         <tr>
 445           <td class="memname">#define Notify_E_BUSY&#160;&#160;&#160;(-12)</td>
 446         </tr>
 447       </table>
 448 </div><div class="memdoc">
 449
 450 <p>The resource is still in use. </p>
 451
 452 </div>
 453 </div>
 454 <a class="anchor" id="a545952549555e51f9e79011dc809c07c"></a>
 455 <div class="memitem">
 456 <div class="memproto">
 457       <table class="memname">
 458         <tr>
 459           <td class="memname">#define Notify_E_DRIVERNOTREGISTERED&#160;&#160;&#160;(-13)</td>
 460         </tr>
 461       </table>
 462 </div><div class="memdoc">
 463
 464 <p>Driver corresponding to the specified eventId is not registered. </p>
 465
 466 </div>
 467 </div>
 468 <a class="anchor" id="ad9030d9269afff260cba4971288ea06d"></a>
 469 <div class="memitem">
 470 <div class="memproto">
 471       <table class="memname">
 472         <tr>
 473           <td class="memname">#define Notify_E_EVTNOTREGISTERED&#160;&#160;&#160;(-14)</td>
 474         </tr>
 475       </table>
 476 </div><div class="memdoc">
 477
 478 <p>Event not registered. </p>
 479
 480 </div>
 481 </div>
 482 <a class="anchor" id="a5f7397fead455e8973aff576329edeec"></a>
 483 <div class="memitem">
 484 <div class="memproto">
 485       <table class="memname">
 486         <tr>
 487           <td class="memname">#define Notify_E_EVTDISABLED&#160;&#160;&#160;(-15)</td>
 488         </tr>
 489       </table>
 490 </div><div class="memdoc">
 491
 492 <p>Event is disabled. </p>
 493
 494 </div>
 495 </div>
 496 <a class="anchor" id="a78efd69afedc82d2912adb9f668c2c54"></a>
 497 <div class="memitem">
 498 <div class="memproto">
 499       <table class="memname">
 500         <tr>
 501           <td class="memname">#define Notify_E_NOTINITIALIZED&#160;&#160;&#160;(-16)</td>
 502         </tr>
 503       </table>
 504 </div><div class="memdoc">
 505
 506 <p>Remote notification is not initialized. </p>
 507
 508 </div>
 509 </div>
 510 <a class="anchor" id="a68460eb33839572c7416387b91e33e68"></a>
 511 <div class="memitem">
 512 <div class="memproto">
 513       <table class="memname">
 514         <tr>
 515           <td class="memname">#define Notify_E_EVTRESERVED&#160;&#160;&#160;(-17)</td>
 516         </tr>
 517       </table>
 518 </div><div class="memdoc">
 519
 520 <p>Trying to illegally use a reserved event. </p>
 521
 522 </div>
 523 </div>
 524 <a class="anchor" id="afb698e2a48abcb1b698e80a16b38bf43"></a>
 525 <div class="memitem">
 526 <div class="memproto">
 527       <table class="memname">
 528         <tr>
 529           <td class="memname">#define Notify_MAXEVENTS&#160;&#160;&#160;(UInt16)32</td>
 530         </tr>
 531       </table>
 532 </div><div class="memdoc">
 533
 534 <p>Maximum number of events supported by the Notify module. </p>
 535
 536 </div>
 537 </div>
 538 <a class="anchor" id="a67e0ce1661274a428248b143dd41dbfc"></a>
 539 <div class="memitem">
 540 <div class="memproto">
 541       <table class="memname">
 542         <tr>
 543           <td class="memname">#define Notify_MAX_INTLINES&#160;&#160;&#160;4u</td>
 544         </tr>
 545       </table>
 546 </div><div class="memdoc">
 547
 548 <p>Maximum number of IPC interrupt lines for any pair of processors. </p>
 549
 550 </div>
 551 </div>
 552 <a class="anchor" id="ac33600d8704857ef0afbbee3d4ce6d80"></a>
 553 <div class="memitem">
 554 <div class="memproto">
 555       <table class="memname">
 556         <tr>
 557           <td class="memname">#define Notify_SYSTEMKEY&#160;&#160;&#160;((UInt16)0xC1D2)</td>
 558         </tr>
 559       </table>
 560 </div><div class="memdoc">
 561
 562 <p>This key must be provided as the upper 16 bits of the eventId when registering for an event, if any reserved event numbers are to be used. </p>
 563
 564 </div>
 565 </div>
 566 <h2 class="groupheader">Typedef Documentation</h2>
 567 <a class="anchor" id="ab362f7571ee3d7f7abaa743914edcd62"></a>
 568 <div class="memitem">
 569 <div class="memproto">
 570       <table class="memname">
 571         <tr>
 572           <td class="memname">Notify_FnNotifyCbck</td>
 573         </tr>
 574       </table>
 575 </div><div class="memdoc">
 576
 577 <p>Signature of any callback function that can be registered with the Notify component. </p>
 578 <dl class="params"><dt>Parameters</dt><dd>
 579   <table class="params">
 580     <tr><td class="paramdir">[in]</td><td class="paramname">procId</td><td>Remote processor id </td></tr>
 581     <tr><td class="paramdir">[in]</td><td class="paramname">lineId</td><td>Line id </td></tr>
 582     <tr><td class="paramdir">[in]</td><td class="paramname">eventId</td><td>Event id (minus system key if reserved event) </td></tr>
 583     <tr><td class="paramdir">[in]</td><td class="paramname">arg</td><td>Argument specified in the registerEvent </td></tr>
 584     <tr><td class="paramdir">[in]</td><td class="paramname">payload</td><td>Payload specified in the sendEvent </td></tr>
 585   </table>
 586   </dd>
 587 </dl>
 588
 589 </div>
 590 </div>
 591 <h2 class="groupheader">Function Documentation</h2>
 592 <a class="anchor" id="a2d6e7fc00357b58ddc2a860e6bd4bf80"></a>
 593 <div class="memitem">
 594 <div class="memproto">
 595       <table class="memname">
 596         <tr>
 597           <td class="memname">Int Notify_attach </td>
 598           <td>(</td>
 599           <td class="paramtype">UInt16&#160;</td>
 600           <td class="paramname"><em>remoteProcId</em>, </td>
 601         </tr>
 602         <tr>
 603           <td class="paramkey"></td>
 604           <td></td>
 605           <td class="paramtype">Ptr&#160;</td>
 606           <td class="paramname"><em>sharedAddr</em>&#160;</td>
 607         </tr>
 608         <tr>
 609           <td></td>
 610           <td>)</td>
 611           <td></td><td></td>
 612         </tr>
 613       </table>
 614 </div><div class="memdoc">
 615
 616 <p>Creates notify drivers and registers them with Notify. </p>
 617 <p>This function must be called before other Notify API calls are invoked. Performing a attach invokes a device-specific Notify initialization routine that creates required drivers and registers those drivers with the Notify module. If the drivers require shared memory, a shared address must be supplied.</p>
 618 <p><a class="el" href="_notify_8h.html#a2d6e7fc00357b58ddc2a860e6bd4bf80" title="Creates notify drivers and registers them with Notify. ">Notify_attach()</a> is typically called internally as part of the IPC initialization sequence. Any memory required for Notify drivers is reserved by SharedRegion and passed to <a class="el" href="_notify_8h.html#a2d6e7fc00357b58ddc2a860e6bd4bf80" title="Creates notify drivers and registers them with Notify. ">Notify_attach()</a>. However, if it is necessary to pass a specific base address to <a class="el" href="_notify_8h.html#a2d6e7fc00357b58ddc2a860e6bd4bf80" title="Creates notify drivers and registers them with Notify. ">Notify_attach()</a> (i.e. if the shared region is not valid yet), then <a class="el" href="_notify_8h.html#a2d6e7fc00357b58ddc2a860e6bd4bf80" title="Creates notify drivers and registers them with Notify. ">Notify_attach()</a> should be called before <a class="el" href="_ipc_8h.html#aca550c6a5498637cfec7b0f4e6d07828" title="Reserves memory, creates default GateMP and HeapMemMP. ">Ipc_start()</a> with this address. When <a class="el" href="_ipc_8h.html#aca550c6a5498637cfec7b0f4e6d07828" title="Reserves memory, creates default GateMP and HeapMemMP. ">Ipc_start()</a> is eventually called, <a class="el" href="_notify_8h.html#a2d6e7fc00357b58ddc2a860e6bd4bf80" title="Creates notify drivers and registers them with Notify. ">Notify_attach()</a> will be internally bypassed since it was directly called by the user.</p>
 619 <dl class="params"><dt>Parameters</dt><dd>
 620   <table class="params">
 621     <tr><td class="paramdir">[in]</td><td class="paramname">remoteProcId</td><td>Remote processor id </td></tr>
 622     <tr><td class="paramdir">[in]</td><td class="paramname">sharedAddr</td><td>Shared address to use if any driver requires shared memory </td></tr>
 623   </table>
 624   </dd>
 625 </dl>
 626 <dl class="section return"><dt>Returns</dt><dd>Notify status:<ul>
 627 <li><a class="el" href="_notify_8h.html#a20a2a59166c514c653d7eed49344566e" title="Generic failure. ">Notify_E_FAIL</a>: failed to attach to remote processor</li>
 628 <li><a class="el" href="_notify_8h.html#a846ddddd026310bcbcda9837a3571ba4" title="Operation is successful. ">Notify_S_SUCCESS</a>: successfully attach to remote processor </li>
 629 </ul>
 630 </dd></dl>
 631
 632 </div>
 633 </div>
 634 <a class="anchor" id="a0eeb5a2e898a287ec0e31be4e6a92364"></a>
 635 <div class="memitem">
 636 <div class="memproto">
 637       <table class="memname">
 638         <tr>
 639           <td class="memname">UInt Notify_disable </td>
 640           <td>(</td>
 641           <td class="paramtype">UInt16&#160;</td>
 642           <td class="paramname"><em>procId</em>, </td>
 643         </tr>
 644         <tr>
 645           <td class="paramkey"></td>
 646           <td></td>
 647           <td class="paramtype">UInt16&#160;</td>
 648           <td class="paramname"><em>lineId</em>&#160;</td>
 649         </tr>
 650         <tr>
 651           <td></td>
 652           <td>)</td>
 653           <td></td><td></td>
 654         </tr>
 655       </table>
 656 </div><div class="memdoc">
 657
 658 <p>Disable ability to receive interrupts on an interrupt line. </p>
 659 <p>This function disables a NotifyDriver from processing received events. The key that is returned from this call must be used in the <a class="el" href="_notify_8h.html#a07248810e2b457664a2a1f24a4179621" title="Restore ability to receive interrupts on an interrupt line. ">Notify_restore()</a> function.</p>
 660 <p>Notify supports nested disable/restore calls. The value of the returned key is the nesting depth.</p>
 661 <p>If <a class="el" href="_notify_8h.html#a0eeb5a2e898a287ec0e31be4e6a92364" title="Disable ability to receive interrupts on an interrupt line. ">Notify_disable()</a> is called upon an interrupt line that is already disabled, then the corresponding <a class="el" href="_notify_8h.html#a07248810e2b457664a2a1f24a4179621" title="Restore ability to receive interrupts on an interrupt line. ">Notify_restore()</a> will not re-enable notifications. Only the restore call that corresponds to the <a class="el" href="_notify_8h.html#a0eeb5a2e898a287ec0e31be4e6a92364" title="Disable ability to receive interrupts on an interrupt line. ">Notify_disable()</a> that actually disabled notifications will re-enable notifications on the interrupt line.</p>
 662 <dl class="params"><dt>Parameters</dt><dd>
 663   <table class="params">
 664     <tr><td class="paramdir">[in]</td><td class="paramname">procId</td><td>Remote processor id </td></tr>
 665     <tr><td class="paramdir">[in]</td><td class="paramname">lineId</td><td>Line id</td></tr>
 666   </table>
 667   </dd>
 668 </dl>
 669 <dl class="section return"><dt>Returns</dt><dd>Key that must be used in <a class="el" href="_notify_8h.html#a07248810e2b457664a2a1f24a4179621" title="Restore ability to receive interrupts on an interrupt line. ">Notify_restore()</a></dd></dl>
 670 <dl class="section see"><dt>See also</dt><dd><a class="el" href="_notify_8h.html#a07248810e2b457664a2a1f24a4179621" title="Restore ability to receive interrupts on an interrupt line. ">Notify_restore()</a> </dd></dl>
 671
 672 </div>
 673 </div>
 674 <a class="anchor" id="acb0512fe9bdbc30a1bd6d055d3c662d0"></a>
 675 <div class="memitem">
 676 <div class="memproto">
 677       <table class="memname">
 678         <tr>
 679           <td class="memname">Void Notify_disableEvent </td>
 680           <td>(</td>
 681           <td class="paramtype">UInt16&#160;</td>
 682           <td class="paramname"><em>procId</em>, </td>
 683         </tr>
 684         <tr>
 685           <td class="paramkey"></td>
 686           <td></td>
 687           <td class="paramtype">UInt16&#160;</td>
 688           <td class="paramname"><em>lineId</em>, </td>
 689         </tr>
 690         <tr>
 691           <td class="paramkey"></td>
 692           <td></td>
 693           <td class="paramtype">UInt32&#160;</td>
 694           <td class="paramname"><em>eventId</em>&#160;</td>
 695         </tr>
 696         <tr>
 697           <td></td>
 698           <td>)</td>
 699           <td></td><td></td>
 700         </tr>
 701       </table>
 702 </div><div class="memdoc">
 703
 704 <p>Disable an event. </p>
 705 <p>This function allows the disabling of a single event number from the specified source processor. Sending to a disabled event will return <a class="el" href="_notify_8h.html#a5f7397fead455e8973aff576329edeec" title="Event is disabled. ">Notify_E_EVTDISABLED</a> on the sender if waitClear is false. <a class="el" href="_notify_8h.html#acb0512fe9bdbc30a1bd6d055d3c662d0" title="Disable an event. ">Notify_disableEvent()</a> and <a class="el" href="_notify_8h.html#a701ab77f8cd9b811dcca05e243815b85" title="Enable an event. ">Notify_enableEvent()</a> may not be supported by all Notify drivers. Consult the documentation for the Notify driver to determine whether it supports this API call.</p>
 706 <p>An event is, by default, enabled upon driver initialization. Calling <a class="el" href="_notify_8h.html#acb0512fe9bdbc30a1bd6d055d3c662d0" title="Disable an event. ">Notify_disableEvent()</a> upon an event that is already disabled results in no change in state.</p>
 707 <p>Note that callbacks may be registered to an event or removed from the event even while the event has been disabled.</p>
 708 <dl class="params"><dt>Parameters</dt><dd>
 709   <table class="params">
 710     <tr><td class="paramdir">[in]</td><td class="paramname">procId</td><td>Remote processor id </td></tr>
 711     <tr><td class="paramdir">[in]</td><td class="paramname">lineId</td><td>Line id </td></tr>
 712     <tr><td class="paramdir">[in]</td><td class="paramname">eventId</td><td>Event id</td></tr>
 713   </table>
 714   </dd>
 715 </dl>
 716 <dl class="section see"><dt>See also</dt><dd><a class="el" href="_notify_8h.html#a701ab77f8cd9b811dcca05e243815b85" title="Enable an event. ">Notify_enableEvent()</a> </dd></dl>
 717
 718 </div>
 719 </div>
 720 <a class="anchor" id="a701ab77f8cd9b811dcca05e243815b85"></a>
 721 <div class="memitem">
 722 <div class="memproto">
 723       <table class="memname">
 724         <tr>
 725           <td class="memname">Void Notify_enableEvent </td>
 726           <td>(</td>
 727           <td class="paramtype">UInt16&#160;</td>
 728           <td class="paramname"><em>procId</em>, </td>
 729         </tr>
 730         <tr>
 731           <td class="paramkey"></td>
 732           <td></td>
 733           <td class="paramtype">UInt16&#160;</td>
 734           <td class="paramname"><em>lineId</em>, </td>
 735         </tr>
 736         <tr>
 737           <td class="paramkey"></td>
 738           <td></td>
 739           <td class="paramtype">UInt32&#160;</td>
 740           <td class="paramname"><em>eventId</em>&#160;</td>
 741         </tr>
 742         <tr>
 743           <td></td>
 744           <td>)</td>
 745           <td></td><td></td>
 746         </tr>
 747       </table>
 748 </div><div class="memdoc">
 749
 750 <p>Enable an event. </p>
 751 <p>This function re-enables an event that has been previously disabled using disableEvent(). Calling <a class="el" href="_notify_8h.html#a701ab77f8cd9b811dcca05e243815b85" title="Enable an event. ">Notify_enableEvent()</a> upon an event that is already enabled results in no change in state. An event is, by default, enabled upon driver initialization.</p>
 752 <p><a class="el" href="_notify_8h.html#acb0512fe9bdbc30a1bd6d055d3c662d0" title="Disable an event. ">Notify_disableEvent()</a> and <a class="el" href="_notify_8h.html#a701ab77f8cd9b811dcca05e243815b85" title="Enable an event. ">Notify_enableEvent()</a> may not be supported by all Notify drivers. Consult the documentation for the Notify driver to determine whether it supports this API call.</p>
 753 <dl class="params"><dt>Parameters</dt><dd>
 754   <table class="params">
 755     <tr><td class="paramdir">[in]</td><td class="paramname">procId</td><td>Remote processor id </td></tr>
 756     <tr><td class="paramdir">[in]</td><td class="paramname">lineId</td><td>Line id </td></tr>
 757     <tr><td class="paramdir">[in]</td><td class="paramname">eventId</td><td>Event id</td></tr>
 758   </table>
 759   </dd>
 760 </dl>
 761 <dl class="section see"><dt>See also</dt><dd><a class="el" href="_notify_8h.html#acb0512fe9bdbc30a1bd6d055d3c662d0" title="Disable an event. ">Notify_disableEvent()</a> </dd></dl>
 762
 763 </div>
 764 </div>
 765 <a class="anchor" id="a35609c7bf129016087dd520be69c14cf"></a>
 766 <div class="memitem">
 767 <div class="memproto">
 768       <table class="memname">
 769         <tr>
 770           <td class="memname">Bool Notify_eventAvailable </td>
 771           <td>(</td>
 772           <td class="paramtype">UInt16&#160;</td>
 773           <td class="paramname"><em>procId</em>, </td>
 774         </tr>
 775         <tr>
 776           <td class="paramkey"></td>
 777           <td></td>
 778           <td class="paramtype">UInt16&#160;</td>
 779           <td class="paramname"><em>lineId</em>, </td>
 780         </tr>
 781         <tr>
 782           <td class="paramkey"></td>
 783           <td></td>
 784           <td class="paramtype">UInt32&#160;</td>
 785           <td class="paramname"><em>eventId</em>&#160;</td>
 786         </tr>
 787         <tr>
 788           <td></td>
 789           <td>)</td>
 790           <td></td><td></td>
 791         </tr>
 792       </table>
 793 </div><div class="memdoc">
 794
 795 <p>Whether an unused event is available on an interrupt line. </p>
 796 <p>This function can be used to determine whether an unused eventId for a specific interrupt line is available for use in <a class="el" href="_notify_8h.html#af0e6797faaeea3d07121ad83394dd1cb" title="Register a callback for an event (supports multiple callbacks) ">Notify_registerEvent()</a> or <a class="el" href="_notify_8h.html#ad3d08088f515d57a3e4999a046267f49" title="Register a single callback for an event. ">Notify_registerEventSingle()</a>. This function will return TRUE if and only if the following conditions are simultaneously TRUE:</p><ul>
 797 <li>The corresponding interrupt line is available. Notifications over an interrupt line to a remote processor are typically made available by calling <a class="el" href="_notify_8h.html#a2d6e7fc00357b58ddc2a860e6bd4bf80" title="Creates notify drivers and registers them with Notify. ">Notify_attach()</a> or <a class="el" href="_ipc_8h.html#a170f84915df79377080be708302bcb08" title="Attach to remote processor. ">Ipc_attach()</a>.</li>
 798 <li>The event is not a reserved event</li>
 799 <li>The event is a reserved event and <a class="el" href="_notify_8h.html#ac33600d8704857ef0afbbee3d4ce6d80" title="This key must be provided as the upper 16 bits of the eventId when registering for an event...">Notify_SYSTEMKEY</a> has been passed as the upper 16 bits of the 32-bit eventId argument</li>
 800 <li>No callback functions have been registered to the event If any of the above conditions is false, this function will return FALSE. Note that an event may still be registered using <a class="el" href="_notify_8h.html#af0e6797faaeea3d07121ad83394dd1cb" title="Register a callback for an event (supports multiple callbacks) ">Notify_registerEvent()</a> while the last condition is false if the existing callback function(s) were registered using <a class="el" href="_notify_8h.html#af0e6797faaeea3d07121ad83394dd1cb" title="Register a callback for an event (supports multiple callbacks) ">Notify_registerEvent()</a> (not <a class="el" href="_notify_8h.html#ad3d08088f515d57a3e4999a046267f49" title="Register a single callback for an event. ">Notify_registerEventSingle()</a>).</li>
 801 </ul>
 802 <dl class="params"><dt>Parameters</dt><dd>
 803   <table class="params">
 804     <tr><td class="paramdir">[in]</td><td class="paramname">procId</td><td>Remote processor id </td></tr>
 805     <tr><td class="paramdir">[in]</td><td class="paramname">lineId</td><td>Line id </td></tr>
 806     <tr><td class="paramdir">[in]</td><td class="paramname">eventId</td><td>Event id</td></tr>
 807   </table>
 808   </dd>
 809 </dl>
 810 <dl class="section return"><dt>Returns</dt><dd>TRUE if an unused event is available, FALSE otherwise </dd></dl>
 811
 812 </div>
 813 </div>
 814 <a class="anchor" id="a696ca01e7ee01649e5685081f6f8a425"></a>
 815 <div class="memitem">
 816 <div class="memproto">
 817       <table class="memname">
 818         <tr>
 819           <td class="memname">Bool Notify_intLineRegistered </td>
 820           <td>(</td>
 821           <td class="paramtype">UInt16&#160;</td>
 822           <td class="paramname"><em>procId</em>, </td>
 823         </tr>
 824         <tr>
 825           <td class="paramkey"></td>
 826           <td></td>
 827           <td class="paramtype">UInt16&#160;</td>
 828           <td class="paramname"><em>lineId</em>&#160;</td>
 829         </tr>
 830         <tr>
 831           <td></td>
 832           <td>)</td>
 833           <td></td><td></td>
 834         </tr>
 835       </table>
 836 </div><div class="memdoc">
 837
 838 <p>Whether notification via interrupt line has been registered. </p>
 839 <p>This function will return TRUE if and only if a notify driver has been registered for the interrupt line identified by the supplied procId and lineId. The interrupt line corresponding to loopback functionality is always registered. A value of FALSE indicates that either <a class="el" href="_notify_8h.html#a2d6e7fc00357b58ddc2a860e6bd4bf80" title="Creates notify drivers and registers them with Notify. ">Notify_attach()</a> has not yet been called or that notification to the remote processor is unsupported.</p>
 840 <dl class="params"><dt>Parameters</dt><dd>
 841   <table class="params">
 842     <tr><td class="paramdir">[in]</td><td class="paramname">procId</td><td>Remote processor id </td></tr>
 843     <tr><td class="paramdir">[in]</td><td class="paramname">lineId</td><td>Line id</td></tr>
 844   </table>
 845   </dd>
 846 </dl>
 847 <dl class="section return"><dt>Returns</dt><dd>TRUE if registered, FALSE otherwise </dd></dl>
 848
 849 </div>
 850 </div>
 851 <a class="anchor" id="a195f48cdad4a2db36eb00bdbc752f8f9"></a>
 852 <div class="memitem">
 853 <div class="memproto">
 854       <table class="memname">
 855         <tr>
 856           <td class="memname">UInt16 Notify_numIntLines </td>
 857           <td>(</td>
 858           <td class="paramtype">UInt16&#160;</td>
 859           <td class="paramname"><em>procId</em></td><td>)</td>
 860           <td></td>
 861         </tr>
 862       </table>
 863 </div><div class="memdoc">
 864
 865 <p>Returns number of interrupt lines to remote processor. </p>
 866 <p>This function returns the number of available interrupt lines to a remote processor.</p>
 867 <dl class="params"><dt>Parameters</dt><dd>
 868   <table class="params">
 869     <tr><td class="paramdir">[in]</td><td class="paramname">procId</td><td>Remote processor id</td></tr>
 870   </table>
 871   </dd>
 872 </dl>
 873 <dl class="section return"><dt>Returns</dt><dd>Number of interrupt lines </dd></dl>
 874
 875 </div>
 876 </div>
 877 <a class="anchor" id="af0e6797faaeea3d07121ad83394dd1cb"></a>
 878 <div class="memitem">
 879 <div class="memproto">
 880       <table class="memname">
 881         <tr>
 882           <td class="memname">Int Notify_registerEvent </td>
 883           <td>(</td>
 884           <td class="paramtype">UInt16&#160;</td>
 885           <td class="paramname"><em>procId</em>, </td>
 886         </tr>
 887         <tr>
 888           <td class="paramkey"></td>
 889           <td></td>
 890           <td class="paramtype">UInt16&#160;</td>
 891           <td class="paramname"><em>lineId</em>, </td>
 892         </tr>
 893         <tr>
 894           <td class="paramkey"></td>
 895           <td></td>
 896           <td class="paramtype">UInt32&#160;</td>
 897           <td class="paramname"><em>eventId</em>, </td>
 898         </tr>
 899         <tr>
 900           <td class="paramkey"></td>
 901           <td></td>
 902           <td class="paramtype"><a class="el" href="_notify_8h.html#ab362f7571ee3d7f7abaa743914edcd62">Notify_FnNotifyCbck</a>&#160;</td>
 903           <td class="paramname"><em>fnNotifyCbck</em>, </td>
 904         </tr>
 905         <tr>
 906           <td class="paramkey"></td>
 907           <td></td>
 908           <td class="paramtype">UArg&#160;</td>
 909           <td class="paramname"><em>cbckArg</em>&#160;</td>
 910         </tr>
 911         <tr>
 912           <td></td>
 913           <td>)</td>
 914           <td></td><td></td>
 915         </tr>
 916       </table>
 917 </div><div class="memdoc">
 918
 919 <p>Register a callback for an event (supports multiple callbacks) </p>
 920 <p>This function registers a callback to a specific event number, processor id and interrupt line. When the event is received by the specified processor, the callback is called.</p>
 921 <p>The callback function prototype is of type <a class="el" href="_notify_8h.html#ab362f7571ee3d7f7abaa743914edcd62" title="Signature of any callback function that can be registered with the Notify component. ">Notify_FnNotifyCbck</a>. This function must be non-blocking.</p>
 922 <p>It is important to note that multiple callbacks may be registered with a single event. This is accomplished by simply calling <a class="el" href="_notify_8h.html#af0e6797faaeea3d07121ad83394dd1cb" title="Register a callback for an event (supports multiple callbacks) ">Notify_registerEvent()</a> for each combination of callback functions and callback arguments as needed.</p>
 923 <p>It is important to note that interrupts are disabled during the entire duration of this function's execution.</p>
 924 <dl class="params"><dt>Parameters</dt><dd>
 925   <table class="params">
 926     <tr><td class="paramdir">[in]</td><td class="paramname">procId</td><td>Remote processor id </td></tr>
 927     <tr><td class="paramdir">[in]</td><td class="paramname">lineId</td><td>Line id (0 for most systems) </td></tr>
 928     <tr><td class="paramdir">[in]</td><td class="paramname">eventId</td><td>Event id </td></tr>
 929     <tr><td class="paramdir">[in]</td><td class="paramname">fnNotifyCbck</td><td>Pointer to callback function </td></tr>
 930     <tr><td class="paramdir">[in]</td><td class="paramname">cbckArg</td><td>Callback function argument</td></tr>
 931   </table>
 932   </dd>
 933 </dl>
 934 <dl class="section return"><dt>Returns</dt><dd>Notify status:<ul>
 935 <li><a class="el" href="_notify_8h.html#a846ddddd026310bcbcda9837a3571ba4" title="Operation is successful. ">Notify_S_SUCCESS</a>: Event successfully registered</li>
 936 <li><a class="el" href="_notify_8h.html#aa74af2d630f14ab3083a587ef0337184" title="Operation resulted in memory failure. ">Notify_E_MEMORY</a>: Failed to register due to memory error</li>
 937 </ul>
 938 </dd></dl>
 939 <dl class="section see"><dt>See also</dt><dd><a class="el" href="_notify_8h.html#a04733f534741df34fb5c0fbd7cbab8bc" title="Remove an event listener from an event. ">Notify_unregisterEvent()</a> </dd></dl>
 940
 941 </div>
 942 </div>
 943 <a class="anchor" id="ad3d08088f515d57a3e4999a046267f49"></a>
 944 <div class="memitem">
 945 <div class="memproto">
 946       <table class="memname">
 947         <tr>
 948           <td class="memname">Int Notify_registerEventSingle </td>
 949           <td>(</td>
 950           <td class="paramtype">UInt16&#160;</td>
 951           <td class="paramname"><em>procId</em>, </td>
 952         </tr>
 953         <tr>
 954           <td class="paramkey"></td>
 955           <td></td>
 956           <td class="paramtype">UInt16&#160;</td>
 957           <td class="paramname"><em>lineId</em>, </td>
 958         </tr>
 959         <tr>
 960           <td class="paramkey"></td>
 961           <td></td>
 962           <td class="paramtype">UInt32&#160;</td>
 963           <td class="paramname"><em>eventId</em>, </td>
 964         </tr>
 965         <tr>
 966           <td class="paramkey"></td>
 967           <td></td>
 968           <td class="paramtype"><a class="el" href="_notify_8h.html#ab362f7571ee3d7f7abaa743914edcd62">Notify_FnNotifyCbck</a>&#160;</td>
 969           <td class="paramname"><em>fnNotifyCbck</em>, </td>
 970         </tr>
 971         <tr>
 972           <td class="paramkey"></td>
 973           <td></td>
 974           <td class="paramtype">UArg&#160;</td>
 975           <td class="paramname"><em>cbckArg</em>&#160;</td>
 976         </tr>
 977         <tr>
 978           <td></td>
 979           <td>)</td>
 980           <td></td><td></td>
 981         </tr>
 982       </table>
 983 </div><div class="memdoc">
 984
 985 <p>Register a single callback for an event. </p>
 986 <p>This function registers a callback to a specific event number, processor id and interrupt line. When the event is received by the specified processor, the callback is called.</p>
 987 <p>The callback function prototype is of type <a class="el" href="_notify_8h.html#ab362f7571ee3d7f7abaa743914edcd62" title="Signature of any callback function that can be registered with the Notify component. ">Notify_FnNotifyCbck</a>. The callback function must be non-blocking.</p>
 988 <p>Only one callback may be registered with this API.</p>
 989 <p>Use <a class="el" href="_notify_8h.html#af0e6797faaeea3d07121ad83394dd1cb" title="Register a callback for an event (supports multiple callbacks) ">Notify_registerEvent()</a> to register multiple callbacks for a single event.</p>
 990 <dl class="params"><dt>Parameters</dt><dd>
 991   <table class="params">
 992     <tr><td class="paramdir">[in]</td><td class="paramname">procId</td><td>Remote processor id </td></tr>
 993     <tr><td class="paramdir">[in]</td><td class="paramname">lineId</td><td>Line id (0 for most systems) </td></tr>
 994     <tr><td class="paramdir">[in]</td><td class="paramname">eventId</td><td>Event id </td></tr>
 995     <tr><td class="paramdir">[in]</td><td class="paramname">fnNotifyCbck</td><td>Pointer to callback function </td></tr>
 996     <tr><td class="paramdir">[in]</td><td class="paramname">cbckArg</td><td>Callback function argument</td></tr>
 997   </table>
 998   </dd>
 999 </dl>
1000 <dl class="section return"><dt>Returns</dt><dd>Notify status:<ul>
1001 <li><a class="el" href="_notify_8h.html#aea5c89c302ce37850d8819c85e29ce97" title="The specified entity already exists. ">Notify_E_ALREADYEXISTS</a>: Event already registered</li>
1002 <li><a class="el" href="_notify_8h.html#a846ddddd026310bcbcda9837a3571ba4" title="Operation is successful. ">Notify_S_SUCCESS</a>: Event successfully registered</li>
1003 </ul>
1004 </dd></dl>
1005 <dl class="section see"><dt>See also</dt><dd><a class="el" href="_notify_8h.html#a7d8a78106ebe364b994f828d9b90f12f" title="Remove an event listener from an event. ">Notify_unregisterEventSingle()</a> </dd></dl>
1006
1007 </div>
1008 </div>
1009 <a class="anchor" id="a07248810e2b457664a2a1f24a4179621"></a>
1010 <div class="memitem">
1011 <div class="memproto">
1012       <table class="memname">
1013         <tr>
1014           <td class="memname">Void Notify_restore </td>
1015           <td>(</td>
1016           <td class="paramtype">UInt16&#160;</td>
1017           <td class="paramname"><em>procId</em>, </td>
1018         </tr>
1019         <tr>
1020           <td class="paramkey"></td>
1021           <td></td>
1022           <td class="paramtype">UInt16&#160;</td>
1023           <td class="paramname"><em>lineId</em>, </td>
1024         </tr>
1025         <tr>
1026           <td class="paramkey"></td>
1027           <td></td>
1028           <td class="paramtype">UInt&#160;</td>
1029           <td class="paramname"><em>key</em>&#160;</td>
1030         </tr>
1031         <tr>
1032           <td></td>
1033           <td>)</td>
1034           <td></td><td></td>
1035         </tr>
1036       </table>
1037 </div><div class="memdoc">
1038
1039 <p>Restore ability to receive interrupts on an interrupt line. </p>
1040 <p>This function re-enables receiving notifications on a specific interrupt line.</p>
1041 <p>Notify supports nested disable/restore calls. The last restore call will re-enable Notifications.</p>
1042 <dl class="params"><dt>Parameters</dt><dd>
1043   <table class="params">
1044     <tr><td class="paramdir">[in]</td><td class="paramname">procId</td><td>Remote processor id </td></tr>
1045     <tr><td class="paramdir">[in]</td><td class="paramname">lineId</td><td>Line id </td></tr>
1046     <tr><td class="paramdir">[in]</td><td class="paramname">key</td><td>Key returned by <a class="el" href="_notify_8h.html#a0eeb5a2e898a287ec0e31be4e6a92364" title="Disable ability to receive interrupts on an interrupt line. ">Notify_disable()</a></td></tr>
1047   </table>
1048   </dd>
1049 </dl>
1050 <dl class="section see"><dt>See also</dt><dd><a class="el" href="_notify_8h.html#a0eeb5a2e898a287ec0e31be4e6a92364" title="Disable ability to receive interrupts on an interrupt line. ">Notify_disable()</a> </dd></dl>
1051
1052 </div>
1053 </div>
1054 <a class="anchor" id="ac0f8b4cb2245dd897b5b75485f6b5c13"></a>
1055 <div class="memitem">
1056 <div class="memproto">
1057       <table class="memname">
1058         <tr>
1059           <td class="memname">Int Notify_sendEvent </td>
1060           <td>(</td>
1061           <td class="paramtype">UInt16&#160;</td>
1062           <td class="paramname"><em>procId</em>, </td>
1063         </tr>
1064         <tr>
1065           <td class="paramkey"></td>
1066           <td></td>
1067           <td class="paramtype">UInt16&#160;</td>
1068           <td class="paramname"><em>lineId</em>, </td>
1069         </tr>
1070         <tr>
1071           <td class="paramkey"></td>
1072           <td></td>
1073           <td class="paramtype">UInt32&#160;</td>
1074           <td class="paramname"><em>eventId</em>, </td>
1075         </tr>
1076         <tr>
1077           <td class="paramkey"></td>
1078           <td></td>
1079           <td class="paramtype">UInt32&#160;</td>
1080           <td class="paramname"><em>payload</em>, </td>
1081         </tr>
1082         <tr>
1083           <td class="paramkey"></td>
1084           <td></td>
1085           <td class="paramtype">Bool&#160;</td>
1086           <td class="paramname"><em>waitClear</em>&#160;</td>
1087         </tr>
1088         <tr>
1089           <td></td>
1090           <td>)</td>
1091           <td></td><td></td>
1092         </tr>
1093       </table>
1094 </div><div class="memdoc">
1095
1096 <p>Send an event on an interrupt line. </p>
1097 <p>This function sends an event to a processor via an interrupt line identified by a processor id and line id. A payload may be optionally sent to the the remote processor if supported by the device.</p>
1098 <p>On the destination processor, the callback functions registered with Notify with the associated eventId and source processor id are called.</p>
1099 <p>For example, when using 'NotifyDriverShm', a <code>waitClear</code> value of 'TRUE' indicates that, if an event was previously sent to the same eventId, sendEvent should spin until the previous event has been acknowledged by the remote processor. If <code>waitClear</code> is FALSE, a pending event with the same eventId will be overwritten by the event currently being sent. When in doubt, a value of TRUE should be used because notifications may be potentially dropped when FALSE is used. When using NotifyDriverShm, a payload should never be sent with 'waitClear = FALSE.'</p>
1100 <p>On the other hand, other notify drivers that use a FIFO to transmit events will spin if <code>waitClear</code> is TRUE until the FIFO has enough room to accept the event being sent. If <code>waitClear</code> is FALSE, <a class="el" href="_notify_8h.html#ac0f8b4cb2245dd897b5b75485f6b5c13" title="Send an event on an interrupt line. ">Notify_sendEvent()</a> will return <a class="el" href="_notify_8h.html#a20a2a59166c514c653d7eed49344566e" title="Generic failure. ">Notify_E_FAIL</a> if the FIFO does not have room for the event.</p>
1101 <p>Refer to the documentation for the Notify drivers for more information about the effect of the <code>waitClear</code> flag in <a class="el" href="_notify_8h.html#ac0f8b4cb2245dd897b5b75485f6b5c13" title="Send an event on an interrupt line. ">Notify_sendEvent()</a>.</p>
1102 <p>Notify_sendEvent can be called from a Hwi context unlike other Notify APIs.</p>
1103 <dl class="params"><dt>Parameters</dt><dd>
1104   <table class="params">
1105     <tr><td class="paramdir">[in]</td><td class="paramname">procId</td><td>Remote processor id </td></tr>
1106     <tr><td class="paramdir">[in]</td><td class="paramname">lineId</td><td>Line id </td></tr>
1107     <tr><td class="paramdir">[in]</td><td class="paramname">eventId</td><td>Event id </td></tr>
1108     <tr><td class="paramdir">[in]</td><td class="paramname">payload</td><td>Payload to be sent along with the event. </td></tr>
1109     <tr><td class="paramdir">[in]</td><td class="paramname">waitClear</td><td>Indicates whether to spin waiting for the remote core to process previous events</td></tr>
1110   </table>
1111   </dd>
1112 </dl>
1113 <dl class="section return"><dt>Returns</dt><dd>Notify status:<ul>
1114 <li><a class="el" href="_notify_8h.html#ad9030d9269afff260cba4971288ea06d" title="Event not registered. ">Notify_E_EVTNOTREGISTERED</a>: event has no registered callback functions</li>
1115 <li><a class="el" href="_notify_8h.html#a78efd69afedc82d2912adb9f668c2c54" title="Remote notification is not initialized. ">Notify_E_NOTINITIALIZED</a>: remote driver has not yet been initialized</li>
1116 <li><a class="el" href="_notify_8h.html#a5f7397fead455e8973aff576329edeec" title="Event is disabled. ">Notify_E_EVTDISABLED</a>: remote event is disabled</li>
1117 <li><a class="el" href="_notify_8h.html#a546b13cc1d684582073aaa256652fbc4" title="Operation timed out. ">Notify_E_TIMEOUT</a>: timeout occurred (when waitClear is TRUE)</li>
1118 <li><a class="el" href="_notify_8h.html#a846ddddd026310bcbcda9837a3571ba4" title="Operation is successful. ">Notify_S_SUCCESS</a>: event successfully sent </li>
1119 </ul>
1120 </dd></dl>
1121
1122 </div>
1123 </div>
1124 <a class="anchor" id="a04733f534741df34fb5c0fbd7cbab8bc"></a>
1125 <div class="memitem">
1126 <div class="memproto">
1127       <table class="memname">
1128         <tr>
1129           <td class="memname">Int Notify_unregisterEvent </td>
1130           <td>(</td>
1131           <td class="paramtype">UInt16&#160;</td>
1132           <td class="paramname"><em>procId</em>, </td>
1133         </tr>
1134         <tr>
1135           <td class="paramkey"></td>
1136           <td></td>
1137           <td class="paramtype">UInt16&#160;</td>
1138           <td class="paramname"><em>lineId</em>, </td>
1139         </tr>
1140         <tr>
1141           <td class="paramkey"></td>
1142           <td></td>
1143           <td class="paramtype">UInt32&#160;</td>
1144           <td class="paramname"><em>eventId</em>, </td>
1145         </tr>
1146         <tr>
1147           <td class="paramkey"></td>
1148           <td></td>
1149           <td class="paramtype"><a class="el" href="_notify_8h.html#ab362f7571ee3d7f7abaa743914edcd62">Notify_FnNotifyCbck</a>&#160;</td>
1150           <td class="paramname"><em>fnNotifyCbck</em>, </td>
1151         </tr>
1152         <tr>
1153           <td class="paramkey"></td>
1154           <td></td>
1155           <td class="paramtype">UArg&#160;</td>
1156           <td class="paramname"><em>cbckArg</em>&#160;</td>
1157         </tr>
1158         <tr>
1159           <td></td>
1160           <td>)</td>
1161           <td></td><td></td>
1162         </tr>
1163       </table>
1164 </div><div class="memdoc">
1165
1166 <p>Remove an event listener from an event. </p>
1167 <p>This function unregisters a single callback that was registered to an event using <a class="el" href="_notify_8h.html#af0e6797faaeea3d07121ad83394dd1cb" title="Register a callback for an event (supports multiple callbacks) ">Notify_registerEvent()</a>. The <code>procId</code>, <code>lineId</code>, <code>eventId</code>, <code>fnNotifyCbck</code> and <code>cbckArg</code> must exactly match with the registered one.</p>
1168 <p>This API is used to unregister events that were registered with <a class="el" href="_notify_8h.html#af0e6797faaeea3d07121ad83394dd1cb" title="Register a callback for an event (supports multiple callbacks) ">Notify_registerEvent()</a>. If this is the last event, then <a class="el" href="_notify_8h.html#a7d8a78106ebe364b994f828d9b90f12f" title="Remove an event listener from an event. ">Notify_unregisterEventSingle()</a> is called to completely remove the event.</p>
1169 <dl class="params"><dt>Parameters</dt><dd>
1170   <table class="params">
1171     <tr><td class="paramdir">[in]</td><td class="paramname">procId</td><td>Remote processor id </td></tr>
1172     <tr><td class="paramdir">[in]</td><td class="paramname">lineId</td><td>Line id </td></tr>
1173     <tr><td class="paramdir">[in]</td><td class="paramname">eventId</td><td>Event id </td></tr>
1174     <tr><td class="paramdir">[in]</td><td class="paramname">fnNotifyCbck</td><td>Pointer to callback function </td></tr>
1175     <tr><td class="paramdir">[in]</td><td class="paramname">cbckArg</td><td>Callback function argument</td></tr>
1176   </table>
1177   </dd>
1178 </dl>
1179 <dl class="section return"><dt>Returns</dt><dd>Notify status:<ul>
1180 <li><a class="el" href="_notify_8h.html#a1c9a19382cfb8c48de9bc3e52e9f7635" title="Unable to find the specified entity. ">Notify_E_NOTFOUND</a>: event listener not found</li>
1181 <li><a class="el" href="_notify_8h.html#a846ddddd026310bcbcda9837a3571ba4" title="Operation is successful. ">Notify_S_SUCCESS</a>: event listener unregistered</li>
1182 </ul>
1183 </dd></dl>
1184 <dl class="section see"><dt>See also</dt><dd><a class="el" href="_notify_8h.html#af0e6797faaeea3d07121ad83394dd1cb" title="Register a callback for an event (supports multiple callbacks) ">Notify_registerEvent()</a> </dd></dl>
1185
1186 </div>
1187 </div>
1188 <a class="anchor" id="a7d8a78106ebe364b994f828d9b90f12f"></a>
1189 <div class="memitem">
1190 <div class="memproto">
1191       <table class="memname">
1192         <tr>
1193           <td class="memname">Int Notify_unregisterEventSingle </td>
1194           <td>(</td>
1195           <td class="paramtype">UInt16&#160;</td>
1196           <td class="paramname"><em>procId</em>, </td>
1197         </tr>
1198         <tr>
1199           <td class="paramkey"></td>
1200           <td></td>
1201           <td class="paramtype">UInt16&#160;</td>
1202           <td class="paramname"><em>lineId</em>, </td>
1203         </tr>
1204         <tr>
1205           <td class="paramkey"></td>
1206           <td></td>
1207           <td class="paramtype">UInt32&#160;</td>
1208           <td class="paramname"><em>eventId</em>&#160;</td>
1209         </tr>
1210         <tr>
1211           <td></td>
1212           <td>)</td>
1213           <td></td><td></td>
1214         </tr>
1215       </table>
1216 </div><div class="memdoc">
1217
1218 <p>Remove an event listener from an event. </p>
1219 <p>This function removes a previously registered callback registered with <a class="el" href="_notify_8h.html#ad3d08088f515d57a3e4999a046267f49" title="Register a single callback for an event. ">Notify_registerEventSingle()</a>. The <code>procId</code>, <code>lineId</code>, and <code>eventId</code> must exactly match the registered one.</p>
1220 <dl class="params"><dt>Parameters</dt><dd>
1221   <table class="params">
1222     <tr><td class="paramdir">[in]</td><td class="paramname">procId</td><td>Remote processor id </td></tr>
1223     <tr><td class="paramdir">[in]</td><td class="paramname">lineId</td><td>Line id </td></tr>
1224     <tr><td class="paramdir">[in]</td><td class="paramname">eventId</td><td>Event id that is being unregistered</td></tr>
1225   </table>
1226   </dd>
1227 </dl>
1228 <dl class="section return"><dt>Returns</dt><dd>Notify status:<ul>
1229 <li><a class="el" href="_notify_8h.html#a846ddddd026310bcbcda9837a3571ba4" title="Operation is successful. ">Notify_S_SUCCESS</a>: event unregistered</li>
1230 <li><a class="el" href="_notify_8h.html#a20a2a59166c514c653d7eed49344566e" title="Generic failure. ">Notify_E_FAIL</a>: fail to unregister event</li>
1231 </ul>
1232 </dd></dl>
1233 <dl class="section see"><dt>See also</dt><dd><a class="el" href="_notify_8h.html#ad3d08088f515d57a3e4999a046267f49" title="Register a single callback for an event. ">Notify_registerEventSingle()</a> </dd></dl>
1234
1235 </div>
1236 </div>
1237 </div><!-- contents -->
1238 <!-- HTML footer for doxygen 1.8.9.1-->
1239 <!-- start footer part -->
1240 <hr class="footer"/><small>
1241 Copyright  2016, Texas Instruments Incorporated
1242 </small>
1243 </body>
1244 </html>