[processor-sdk/performance-audio-sr.git] / ipc_3_43_00_00_eng / docs / cdoc / ti / sdo / ipc / notifyDrivers / NotifyDriverCirc.html
1 <html>
2 <head>
3 <title>module ti.sdo.ipc.notifyDrivers.NotifyDriverCirc</title>
4 <meta name="description" content="A shared memory driver using circular buffer for the Notify Module">
5 <link rel="stylesheet" type="text/css" href="../../../../xdoc.css" />
6 </head>
7 <body><div id="xdocWrapper"><div id="xdocContent">
8 <table class="xdocHdr"><tr>
9 <td class="xdocHdrTitle"><span class="xdoc-kw1">module</span> <span class="xdoc-id">ti.sdo.ipc.notifyDrivers.</span><span class="xdoc-id">NotifyDriverCirc</span></td>
10 <td class="xdocHdrArrow">
11 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/IInterrupt.html" title="interface IInterrupt"><img class="xdocHdrArrow" src="../../../../Arrow_left.png"/></a></td>
12 <td class="xdocHdrArrow">
13 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/package.html" title="package ti.sdo.ipc.notifyDrivers"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
14 <td class="xdocHdrArrow">
15 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverShm.html" title="module NotifyDriverShm"><img class="xdocHdrArrow" src="../../../../Arrow_right.png"/></a></td>
16 </table>
17 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html">index URL</a></div>
18 <p class="xdocHdrSummary">A shared memory driver using circular buffer for the Notify Module</p>
19 <ul class="xdocToc">
20 <li class="xdocToc"><a class="xdocToc" href="#targ-synop">C synopsis</a></li>
21 <li class="xdocToc2"><a class="xdocToc" href="#xdocElems">Individual elements</a></li>
22 <li class="xdocToc"><a class="xdocToc" href="#meta-synop">Configuration settings</a></li>
23 <li class="xdocToc2"><a class="xdocToc" href="#xdocMetaElems">Individual elements</a></li>
24 </ul>
25 <div class="xdocBrief">
26 This is a <a class="xdoc-link" href="../../../../ti/sdo/ipc/Notify.html" title="ti.sdo.ipc.Notify">ti.sdo.ipc.Notify</a> driver that utilizes shared memory
27 and inter-processor hardware interrupts for notification between cores.
28 This driver supports caching.
29 [ <a class="xdocBrief" href="#xdoc-desc">more</a> ... ]
30 </div>
31 <span id='targ-synop'></span>
32 <table class="xdocLabel"><tr>
33 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2">C</span></tt> synopsis</td>
34 <td class="xdocLabelCenter">target-domain</td>
35 <td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc-src.html"><span class="xdocLabelFile">ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.xdc</span></a></td>
36 </tr></table>
37 <div class="xdocSynT">
38 <div class="xdocSynCode">
39 <tt></tt><span class="xdoc-kw3">#include</span> <span class="xdoc-id"><ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.h></span>
40 </div>
41 <table cellspacing="0" cellpadding="0" border="0">
42 <tr><td colspan='2'><div class='xdocSynTblHdr'>Functions</div></td></tr>
44 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Void</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_config_parameters"><span class="xdoc-id">NotifyDriverCirc_Params_init</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Initialize this config-params structure with supplier-specified defaults before instance creation</span></span></a>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_config_parameters" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Params">NotifyDriverCirc_Params</a> *params);</div></td></tr>
45 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">SizeT</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#shared.Mem.Req"><span class="xdoc-id">NotifyDriverCirc_sharedMemReq</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Amount of shared memory required for creation of each instance</span></span></a>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_config_parameters" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Params">NotifyDriverCirc_Params</a> *<span class="xdoc-id">params</span>);</div></td></tr>
46 <tr><td colspan="2"><div class="xdocSynFxnCat">Functions common to all INotifyDriver modules</div></td></tr>
48 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Void</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#disable"><span class="xdoc-id">NotifyDriverCirc_disable</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Disable a NotifyDriver instance</span></span></a>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_object_types" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Handle">NotifyDriverCirc_Handle</a> handle);</div></td></tr>
49 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Void</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#disable.Event"><span class="xdoc-id">NotifyDriverCirc_disableEvent</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Disable an event</span></span></a>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_object_types" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Handle">NotifyDriverCirc_Handle</a> handle, <span class="xdoc-kw2">UInt32</span> <span class="xdoc-id">eventId</span>);</div></td></tr>
50 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Void</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#enable"><span class="xdoc-id">NotifyDriverCirc_enable</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Enable a NotifyDriver instance</span></span></a>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_object_types" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Handle">NotifyDriverCirc_Handle</a> handle);</div></td></tr>
51 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Void</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#enable.Event"><span class="xdoc-id">NotifyDriverCirc_enableEvent</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Enable an event</span></span></a>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_object_types" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Handle">NotifyDriverCirc_Handle</a> handle, <span class="xdoc-kw2">UInt32</span> <span class="xdoc-id">eventId</span>);</div></td></tr>
52 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Void</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#register.Event"><span class="xdoc-id">NotifyDriverCirc_registerEvent</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Register a callback to an event</span></span></a>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_object_types" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Handle">NotifyDriverCirc_Handle</a> handle, <span class="xdoc-kw2">UInt32</span> <span class="xdoc-id">eventId</span>);</div></td></tr>
53 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Int</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#send.Event"><span class="xdoc-id">NotifyDriverCirc_sendEvent</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Send a signal to an event</span></span></a>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_object_types" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Handle">NotifyDriverCirc_Handle</a> handle, <span class="xdoc-kw2">UInt32</span> <span class="xdoc-id">eventId</span>, <span class="xdoc-kw2">UInt32</span> <span class="xdoc-id">payload</span>, <span class="xdoc-kw2">Bool</span> <span class="xdoc-id">waitClear</span>);</div></td></tr>
54 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Void</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#unregister.Event"><span class="xdoc-id">NotifyDriverCirc_unregisterEvent</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Remove an event listener from an event</span></span></a>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_object_types" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Handle">NotifyDriverCirc_Handle</a> handle, <span class="xdoc-kw2">UInt32</span> <span class="xdoc-id">eventId</span>);</div></td></tr>
55 <tr><td class="xdocSynFxnCat" colspan="2"><div class="xdocSynFxnCat">Functions common to all target instances</div></td></tr>
57 <tr>
58 <td></td>
59 <td>
60 <div class="xdocSynTblPack">
61 <a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">NotifyDriverCirc_handle</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Convert this instance structure pointer into an instance handle</span></span></a>,
62 <a class="xdocSynGo" href="#per-instance_convertors"><span class="xdoc-id">NotifyDriverCirc_Handle_downCast</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// conditionally move one level down the inheritance hierarchy; NULL upon failure</span></span></a>,
63 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">NotifyDriverCirc_Handle_label</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The label associated with this instance object</span></span></a>,
64 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">NotifyDriverCirc_Handle_name</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The name of this instance object</span></span></a>,
65 <a class="xdocSynGo" href="#per-instance_convertors"><span class="xdoc-id">NotifyDriverCirc_Handle_upCast</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// unconditionally move one level up the inheritance hierarchy</span></span></a>,
66 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">NotifyDriverCirc_Object_count</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The number of statically-created instance objects</span></span></a>,
67 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">NotifyDriverCirc_Object_first</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The handle of the first dynamically-created instance object, or NULL</span></span></a>,
68 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">NotifyDriverCirc_Object_get</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The handle of the i-th statically-created instance object (array == NULL)</span></span></a>,
69 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">NotifyDriverCirc_Object_heap</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The heap used to allocate dynamically-created instance objects</span></span></a>,
70 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">NotifyDriverCirc_Object_next</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The handle of the next dynamically-created instance object, or NULL</span></span></a>,
71 <a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">NotifyDriverCirc_struct</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Convert this instance handle into an instance structure pointer</span></span></a>
72 </div>
73 </td>
74 </tr>
75 <tr><td class="xdocSynFxnCat" colspan="2"><div class="xdocSynFxnCat">Functions common to all target modules</div></td></tr>
77 <tr>
78 <td></td>
79 <td>
80 <div class="xdocSynTblPack">
81 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">NotifyDriverCirc_Module_getMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Returns the diagnostics mask for this module</span></span></a>,
82 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">NotifyDriverCirc_Module_hasMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Test whether this module has a diagnostics mask</span></span></a>,
83 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">NotifyDriverCirc_Module_heap</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The heap from which this module allocates memory</span></span></a>,
84 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">NotifyDriverCirc_Module_id</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Get this module's unique id</span></span></a>,
85 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">NotifyDriverCirc_Module_setMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Set the diagnostics mask for this module</span></span></a>,
86 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">NotifyDriverCirc_Module_startupDone</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Test if this module has completed startup</span></span></a>
87 </div>
88 </td>
89 </tr>
90 <tr><td colspan='2'><div class='xdocSynTblHdr'>Typedefs</div></td></tr>
92 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">typedef</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_object_types" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Object">NotifyDriverCirc_Object</a> *</div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">NotifyDriverCirc_Handle</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Client reference to an instance object</span></span></a>;</div></td></tr>
93 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">NotifyDriverCirc_Object</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Opaque internal representation of an instance object</span></span></a> <span class="xdoc-id">NotifyDriverCirc_Object</span>;</div></td></tr>
94 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_config_parameters"><span class="xdoc-id">NotifyDriverCirc_Params</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Instance config-params structure</span></span></a> ...</div></td></tr>
95 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">NotifyDriverCirc_Struct</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Opaque client structure large enough to hold an instance object</span></span></a> <span class="xdoc-id">NotifyDriverCirc_Struct</span>;</div></td></tr>
96 <tr><td colspan='2'><div class='xdocSynTblHdr'>Constants</div></td></tr>
98 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">extern const</span> <a class="xdoc-link" href="../../../../xdc/runtime/Assert.html#.Id" title="xdc.runtime.Assert.Id">Assert_Id</a> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#.A_not.Supported"><span class="xdoc-id">NotifyDriverCirc_A_notSupported</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert raised when trying to use Notify_[enable/disable]Event with
99 NotifyDriverCirc</span></span></a>;</div></td></tr>
100 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">extern const</span> <span class="xdoc-kw2">Bool</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#enable.Stats"><span class="xdoc-id">NotifyDriverCirc_enableStats</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Enable statistics for sending an event</span></span></a>;</div></td></tr>
101 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">extern const</span> <span class="xdoc-kw2">UInt</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#num.Msgs"><span class="xdoc-id">NotifyDriverCirc_numMsgs</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The number of messages or slots in the circular buffer</span></span></a>;</div></td></tr>
102 </table>
103 <div class="xdocSynSpacer"> </div>
104 </div>
105 <span id="xdoc-desc"></span>
106 <span id="xdoc-sect-1"></span>
107 <div class="xdocSect">DETAILS</div>
108 <div class="xdocText">This is a <a class="xdoc-link" href="../../../../ti/sdo/ipc/Notify.html" title="ti.sdo.ipc.Notify">ti.sdo.ipc.Notify</a> driver that utilizes shared memory
109 and inter-processor hardware interrupts for notification between cores.
110 This driver supports caching.</div>
111 <div class="xdocText">This driver is designed to work with a variety of devices, each with
112 distinct interrupt mechanisms. Therefore, this module needs to be plugged
113 with an appropriate module that implements the <a class="xdoc-link" href="IInterrupt.html" title="IInterrupt">IInterrupt</a> interface
114 for a given device.</div>
115 <div class="xdocText">The Notify_[enable/disable]Event APIs are not supported by this driver.</div>
116 <div class="xdocText">The driver utilizes shared memory in the manner indicated by the following
117 diagram.</div>
118 <div class="xdocText"><PRE class="Example">
119 NOTE: Processors '0' and '1' correspond to the processors with lower and
120 higher MultiProc ids, respectively
122 sharedAddr -> --------------------------- bytes
123 | eventEntry0 (0) | 8
124 | eventEntry1 (0) | 8
125 | ... |
126 | eventEntry15 (0) | 8
127 | [align to cache size] |
128 |-------------------------|
129 | eventEntry16 (0) | 8
130 | eventEntry17 (0) | 8
131 | ... |
132 | eventEntry31 (0) | 8
133 | [align to cache size] |
134 |-------------------------|
135 | putWriteIndex (0) | 4
136 | [align to cache size] |
137 |-------------------------|
138 | putReadIndex (0) | 4
139 | [align to cache size] |
140 |-------------------------|
141 | eventEntry0 (1) | 8
142 | eventEntry1 (1) | 8
143 | ... |
144 | eventEntry15 (1) | 8
145 | [align to cache size] |
146 |-------------------------|
147 | eventEntry16 (1) | 8
148 | eventEntry17 (1) | 8
149 | ... |
150 | eventEntry31 (1) | 8
151 | [align to cache size] |
152 |-------------------------|
153 | getWriteIndex (1) | 4
154 | [align to cache size] |
155 |-------------------------|
156 | getReadIndex (1) | 4
157 | [align to cache size] |
158 |-------------------------|
161 Legend:
162 (0), (1) : Memory that belongs to the proc with lower and higher
163 MultiProc.id, respectively
164 |----| : Cache line boundary
166 </PRE></div>
167 <div id="xdocSep">
168 </div>
169 <div id="xdocElems">
170 <div class="xdocSynSpacer"> </div>
171 <a class="xdocAnchor" id=".A_not.Supported"></a>
172 <table class="xdocHdr"><tr>
173 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifyDriverCirc_</span><span class="xdoc-id">A_notSupported</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
174 <td class="xdocHdrArrow">
175 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
176 </table>
177 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#.A_not.Supported">index URL</a></div>
178 <p class="xdocHdrSummaryDcl">Assert raised when trying to use Notify_[enable/disable]Event with
179 NotifyDriverCirc</p>
180 <span id='targ-synop'></span>
181 <table class="xdocLabel"><tr>
182 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
183 <td class="xdocLabelRight">target-domain</td>
184 </tr></table>
185 <div class="xdocSynTdcl">
186 <div class="xdocSynCode">
187 <tt></tt><tt></tt><span class="xdoc-kw1">extern const</span> <a class="xdoc-link" href="../../../../xdc/runtime/Assert.html#.Id" title="xdc.runtime.Assert.Id">Assert_Id</a> <span class="xdoc-id">NotifyDriverCirc_A_notSupported</span>;
188 </div>
189 </div>
190 <div class="xdocSynSpacer"> </div>
191 <div class="xdocSynSpacer"> </div>
192 <a class="xdocAnchor" id="enable.Stats"></a>
193 <table class="xdocHdr"><tr>
194 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifyDriverCirc_</span><span class="xdoc-id">enableStats</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
195 <td class="xdocHdrArrow">
196 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
197 </table>
198 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#enable.Stats">index URL</a></div>
199 <p class="xdocHdrSummaryDcl">Enable statistics for sending an event</p>
200 <span id='targ-synop'></span>
201 <table class="xdocLabel"><tr>
202 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
203 <td class="xdocLabelRight">target-domain</td>
204 </tr></table>
205 <div class="xdocSynTdcl">
206 <div class="xdocSynCode">
207 <tt></tt><tt></tt><span class="xdoc-kw1">extern const</span> <span class="xdoc-kw2">Bool</span> <span class="xdoc-id">NotifyDriverCirc_enableStats</span>;
208 </div>
209 </div>
210 <div class="xdocSynSpacer"> </div>
211 <span id="xdoc-sect-1"></span>
212 <div class="xdocSect">DETAILS</div>
213 <div class="xdocText">If this parameter is to 'TRUE' and 'waitClear' is also set to
214 TRUE when calling (@link #sendEvent(), then the module keeps
215 track of the number of times the processor spins waiting for
216 an empty slot and the max amount of time it waits.</div>
217 <div class="xdocSynSpacer"> </div>
218 <a class="xdocAnchor" id="num.Msgs"></a>
219 <table class="xdocHdr"><tr>
220 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifyDriverCirc_</span><span class="xdoc-id">numMsgs</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
221 <td class="xdocHdrArrow">
222 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
223 </table>
224 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#num.Msgs">index URL</a></div>
225 <p class="xdocHdrSummaryDcl">The number of messages or slots in the circular buffer</p>
226 <span id='targ-synop'></span>
227 <table class="xdocLabel"><tr>
228 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
229 <td class="xdocLabelRight">target-domain</td>
230 </tr></table>
231 <div class="xdocSynTdcl">
232 <div class="xdocSynCode">
233 <tt></tt><tt></tt><span class="xdoc-kw1">extern const</span> <span class="xdoc-kw2">UInt</span> <span class="xdoc-id">NotifyDriverCirc_numMsgs</span>;
234 </div>
235 </div>
236 <div class="xdocSynSpacer"> </div>
237 <span id="xdoc-sect-1"></span>
238 <div class="xdocSect">DETAILS</div>
239 <div class="xdocText">This is use to determine the size of the put and get buffers.
240 Each eventEntry is two 32bits wide, therefore the total size
241 of each circular buffer is [numMsgs * sizeof(eventEntry)].
242 The total size of each buffer must be a multiple of the
243 the cache line size. For example, if the cacheLineSize = 128
244 then numMsgs could be 16, 32, etc...</div>
245 <div class="xdocSynSpacer"> </div>
246 <a class="xdocAnchor" id="shared.Mem.Req"></a>
247 <table class="xdocHdr"><tr>
248 <td class="xdocHdrTitle"><span class="xdoc-id">NotifyDriverCirc_</span><span class="xdoc-id">sharedMemReq</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
249 <td class="xdocHdrArrow">
250 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
251 </table>
252 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#shared.Mem.Req">index URL</a></div>
253 <p class="xdocHdrSummaryDcl">Amount of shared memory required for creation of each instance</p>
254 <span id='targ-synop'></span>
255 <table class="xdocLabel"><tr>
256 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
257 <td class="xdocLabelRight">target-domain</td>
258 </tr></table>
259 <div class="xdocSynTdcl">
260 <div class="xdocSynCode">
261 <tt></tt><tt></tt><span class="xdoc-kw2">SizeT</span> <span class="xdoc-id">NotifyDriverCirc_sharedMemReq</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_config_parameters" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Params">NotifyDriverCirc_Params</a> *<span class="xdoc-id">params</span>);
262 </div>
263 </div>
264 <div class="xdocSynSpacer"> </div>
265 <span id="xdoc-sect-1"></span>
266 <div class="xdocSect">ARGUMENTS</div>
267 <div class="xdocChild"><span class="xdocChildId">params</span>
268 <span class="xdocChildSum">— Pointer to parameters that will be used in the
269 create</span>
270 </div>
271 <span id="xdoc-sect-2"></span>
272 <div class="xdocSect">RETURNS</div>
273 <div class="xdocText">Number of MAUs in shared memory needed to create
274 the instance.</div>
275 <a class="xdocAnchor" id="module-wide_built-ins"></a>
276 <table class="xdocHdr"><tr>
277 <td class="xdocHdrTitle"><span class="xdocSynSum">Module-Wide Built-Ins</span></td>
278 <td class="xdocHdrArrow">
279 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
280 </table>
281 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#module-wide_built-ins">index URL</a></div>
282 <p class="xdocHdrSummary"></p>
283 <span id='targ-synop'></span>
284 <table class="xdocLabel"><tr>
285 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
286 <td class="xdocLabelRight">target-domain</td>
287 </tr></table>
288 <div class="xdocSynTdcl">
289 <div class="xdocSynCode">
290 <tt></tt><tt></tt><a class="xdoc-link" href="../../../../xdc/runtime/Types.html#.Module.Id" title="xdc.runtime.Types.ModuleId">Types_ModuleId</a> <span class="xdoc-id">NotifyDriverCirc_Module_id</span>();
291 </div>
292 <div class='xdocSynSum'><tt></tt><tt></tt>// Get this module's unique id</div>
293 <div class="xdocSynSpacer"> </div>
294 <div class="xdocSynCode">
295 <tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">NotifyDriverCirc_Module_startupDone</span>();
296 </div>
297 <div class='xdocSynSum'><tt></tt><tt></tt>// Test if this module has completed startup</div>
298 <div class="xdocSynSpacer"> </div>
299 <div class="xdocSynCode">
300 <tt></tt><tt></tt><a class="xdoc-link" href="../../../../xdc/runtime/IHeap.html#per-instance_object_types" title="xdc.runtime.IHeap.Handle">IHeap_Handle</a> <span class="xdoc-id">NotifyDriverCirc_Module_heap</span>();
301 </div>
302 <div class='xdocSynSum'><tt></tt><tt></tt>// The heap from which this module allocates memory</div>
303 <div class="xdocSynSpacer"> </div>
304 <div class="xdocSynCode">
305 <tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">NotifyDriverCirc_Module_hasMask</span>();
306 </div>
307 <div class='xdocSynSum'><tt></tt><tt></tt>// Test whether this module has a diagnostics mask</div>
308 <div class="xdocSynSpacer"> </div>
309 <div class="xdocSynCode">
310 <tt></tt><tt></tt><span class="xdoc-kw2">Bits16</span> <span class="xdoc-id">NotifyDriverCirc_Module_getMask</span>();
311 </div>
312 <div class='xdocSynSum'><tt></tt><tt></tt>// Returns the diagnostics mask for this module</div>
313 <div class="xdocSynSpacer"> </div>
314 <div class="xdocSynCode">
315 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">NotifyDriverCirc_Module_setMask</span>(<span class="xdoc-kw2">Bits16</span> <span class="xdoc-id">mask</span>);
316 </div>
317 <div class='xdocSynSum'><tt></tt><tt></tt>// Set the diagnostics mask for this module</div>
318 </div>
319 <a class="xdocAnchor" id="per-instance_object_types"></a>
320 <table class="xdocHdr"><tr>
321 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Object Types</span></td>
322 <td class="xdocHdrArrow">
323 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
324 </table>
325 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_object_types">index URL</a></div>
326 <p class="xdocHdrSummary"></p>
327 <span id='targ-synop'></span>
328 <table class="xdocLabel"><tr>
329 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
330 <td class="xdocLabelRight">target-domain</td>
331 </tr></table>
332 <div class="xdocSynTdcl">
333 <div class="xdocSynCode">
334 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">NotifyDriverCirc_Object</span> <span class="xdoc-id">NotifyDriverCirc_Object</span>;
335 </div>
336 <div class='xdocSynSum'><tt></tt><tt></tt>// Opaque internal representation of an instance object</div>
337 <div class="xdocSynSpacer"> </div>
338 <div class="xdocSynCode">
339 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_object_types" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Object">NotifyDriverCirc_Object</a> *<span class="xdoc-id">NotifyDriverCirc_Handle</span>;
340 </div>
341 <div class='xdocSynSum'><tt></tt><tt></tt>// Client reference to an instance object</div>
342 <div class="xdocSynSpacer"> </div>
343 <div class="xdocSynCode">
344 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">NotifyDriverCirc_Struct</span> <span class="xdoc-id">NotifyDriverCirc_Struct</span>;
345 </div>
346 <div class='xdocSynSum'><tt></tt><tt></tt>// Opaque client structure large enough to hold an instance object</div>
347 <div class="xdocSynSpacer"> </div>
348 <div class="xdocSynCode">
349 <tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_object_types" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Handle">NotifyDriverCirc_Handle</a> <span class="xdoc-id">NotifyDriverCirc_handle</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_object_types" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Struct">NotifyDriverCirc_Struct</a> *structP);
350 </div>
351 <div class='xdocSynSum'><tt></tt><tt></tt>// Convert this instance structure pointer into an instance handle</div>
352 <div class="xdocSynSpacer"> </div>
353 <div class="xdocSynCode">
354 <tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_object_types" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Struct">NotifyDriverCirc_Struct</a> *<span class="xdoc-id">NotifyDriverCirc_struct</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_object_types" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Handle">NotifyDriverCirc_Handle</a> handle);
355 </div>
356 <div class='xdocSynSum'><tt></tt><tt></tt>// Convert this instance handle into an instance structure pointer</div>
357 </div>
358 <a class="xdocAnchor" id="per-instance_config_parameters"></a>
359 <table class="xdocHdr"><tr>
360 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Config Parameters</span></td>
361 <td class="xdocHdrArrow">
362 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
363 </table>
364 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_config_parameters">index URL</a></div>
365 <p class="xdocHdrSummary"></p>
366 <span id='targ-synop'></span>
367 <table class="xdocLabel"><tr>
368 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
369 <td class="xdocLabelRight">target-domain</td>
370 </tr></table>
371 <div class="xdocSynTdcl">
372 <div class="xdocSynCode">
373 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">NotifyDriverCirc_Params</span> {
374 </div>
375 <div class='xdocSynSum'><tt></tt><tt></tt>// Instance config-params structure</div>
376 <div class="xdocSynCode">
377 <tt></tt><tt> </tt><a class="xdoc-link" href="../../../../xdc/runtime/IInstance.html#per-instance_config_parameters" title="xdc.runtime.IInstance.Params">IInstance_Params</a> *instance;
378 </div>
379 <div class='xdocSynSum'><tt></tt><tt> </tt>// Common per-instance configs</div>
380 <div class="xdocSynCode">
381 <tt></tt><tt> </tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">cacheEnabled</span>;
382 </div>
383 <div class='xdocSynSum'><tt></tt><tt> </tt>// Whether cache operations will be performed</div>
384 <div class="xdocSynCode">
385 <tt></tt><tt> </tt><span class="xdoc-kw2">SizeT</span> <span class="xdoc-id">cacheLineSize</span>;
386 </div>
387 <div class='xdocSynSum'><tt></tt><tt> </tt>// The cache line size of the shared memory</div>
388 <div class="xdocSynCode">
389 <tt></tt><tt> </tt><span class="xdoc-kw2">UInt</span> <span class="xdoc-id">intVectorId</span>;
390 </div>
391 <div class='xdocSynSum'><tt></tt><tt> </tt>// Interrupt vector ID to be used by the driver</div>
392 <div class="xdocSynCode">
393 <tt></tt><tt> </tt><span class="xdoc-kw2">UInt</span> <span class="xdoc-id">localIntId</span>;
394 </div>
395 <div class='xdocSynSum'><tt></tt><tt> </tt>// Local interrupt ID for interrupt line</div>
396 <div class="xdocSynCode">
397 <tt></tt><tt> </tt><span class="xdoc-kw2">UInt</span> <span class="xdoc-id">remoteIntId</span>;
398 </div>
399 <div class='xdocSynSum'><tt></tt><tt> </tt>// Remote interrupt ID for interrupt line</div>
400 <div class="xdocSynCode">
401 <tt></tt><tt> </tt><span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>;
402 </div>
403 <div class='xdocSynSum'><tt></tt><tt> </tt>// The MultiProc ID corresponding to the remote processor</div>
404 <div class="xdocSynCode">
405 <tt></tt><tt> </tt><span class="xdoc-kw2">Ptr</span> <span class="xdoc-id">sharedAddr</span>;
406 </div>
407 <div class='xdocSynSum'><tt></tt><tt> </tt>// Address in shared memory where this instance will be placed</div>
408 <div class="xdocSynCode">
409 <tt></tt><tt></tt>} <span class="xdoc-id">NotifyDriverCirc_Params</span>;
410 </div>
411 <div class="xdocSynSpacer"> </div>
412 <div class="xdocSynCode">
413 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">NotifyDriverCirc_Params_init</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_config_parameters" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Params">NotifyDriverCirc_Params</a> *params);
414 </div>
415 <div class='xdocSynSum'><tt></tt><tt></tt>// Initialize this config-params structure with supplier-specified defaults before instance creation</div>
416 </div>
417 <div class="xdocSynSpacer"> </div>
418 <a class="xdocAnchor" id="cache.Enabled"></a>
419 <table class="xdocHdr"><tr>
420 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifyDriverCirc_Params.</span><span class="xdoc-id">cacheEnabled</span> <small><span class="xdocSynSum">// instance</span></small></td>
421 <td class="xdocHdrArrow">
422 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
423 </table>
424 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#cache.Enabled">index URL</a></div>
425 <p class="xdocHdrSummaryDcl">Whether cache operations will be performed</p>
426 <span id='targ-synop'></span>
427 <table class="xdocLabel"><tr>
428 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
429 <td class="xdocLabelRight">target-domain</td>
430 </tr></table>
431 <div class="xdocSynTdcl">
432 <div class="xdocSynCode">
433 <tt></tt><tt></tt><span class="xdoc-kw1">struct</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_config_parameters" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Params">NotifyDriverCirc_Params</a> {
434 </div>
435 <div class="xdocSynCode">
436 <tt></tt><tt> </tt><b> ...</b>
437 </div>
438 <div class="xdocSynCode">
439 <tt></tt><tt> </tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">cacheEnabled</span>;
440 </div>
441 </div>
442 <div class="xdocSynSpacer"> </div>
443 <span id="xdoc-sect-1"></span>
444 <div class="xdocSect">DETAILS</div>
445 <div class="xdocText">If it is known that no cache operations are needed for this instance
446 set this flag to FALSE. If <a class="xdoc-link" href="NotifyDriverCirc.html#shared.Addr" title="sharedAddr">sharedAddr</a> lies within a shared
447 region and the cache enabled setting for the region is FALSE,
448 then the value specified here will be overriden to FALSE.</div>
449 <div class="xdocSynSpacer"> </div>
450 <a class="xdocAnchor" id="cache.Line.Size"></a>
451 <table class="xdocHdr"><tr>
452 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifyDriverCirc_Params.</span><span class="xdoc-id">cacheLineSize</span> <small><span class="xdocSynSum">// instance</span></small></td>
453 <td class="xdocHdrArrow">
454 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
455 </table>
456 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#cache.Line.Size">index URL</a></div>
457 <p class="xdocHdrSummaryDcl">The cache line size of the shared memory</p>
458 <span id='targ-synop'></span>
459 <table class="xdocLabel"><tr>
460 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
461 <td class="xdocLabelRight">target-domain</td>
462 </tr></table>
463 <div class="xdocSynTdcl">
464 <div class="xdocSynCode">
465 <tt></tt><tt></tt><span class="xdoc-kw1">struct</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_config_parameters" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Params">NotifyDriverCirc_Params</a> {
466 </div>
467 <div class="xdocSynCode">
468 <tt></tt><tt> </tt><b> ...</b>
469 </div>
470 <div class="xdocSynCode">
471 <tt></tt><tt> </tt><span class="xdoc-kw2">SizeT</span> <span class="xdoc-id">cacheLineSize</span>;
472 </div>
473 </div>
474 <div class="xdocSynSpacer"> </div>
475 <span id="xdoc-sect-1"></span>
476 <div class="xdocSect">DETAILS</div>
477 <div class="xdocText">This value should be configured</div>
478 <div class="xdocSynSpacer"> </div>
479 <a class="xdocAnchor" id="int.Vector.Id"></a>
480 <table class="xdocHdr"><tr>
481 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifyDriverCirc_Params.</span><span class="xdoc-id">intVectorId</span> <small><span class="xdocSynSum">// instance</span></small></td>
482 <td class="xdocHdrArrow">
483 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
484 </table>
485 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#int.Vector.Id">index URL</a></div>
486 <p class="xdocHdrSummaryDcl">Interrupt vector ID to be used by the driver</p>
487 <span id='targ-synop'></span>
488 <table class="xdocLabel"><tr>
489 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
490 <td class="xdocLabelRight">target-domain</td>
491 </tr></table>
492 <div class="xdocSynTdcl">
493 <div class="xdocSynCode">
494 <tt></tt><tt></tt><span class="xdoc-kw1">struct</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_config_parameters" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Params">NotifyDriverCirc_Params</a> {
495 </div>
496 <div class="xdocSynCode">
497 <tt></tt><tt> </tt><b> ...</b>
498 </div>
499 <div class="xdocSynCode">
500 <tt></tt><tt> </tt><span class="xdoc-kw2">UInt</span> <span class="xdoc-id">intVectorId</span>;
501 </div>
502 </div>
503 <div class="xdocSynSpacer"> </div>
504 <span id="xdoc-sect-1"></span>
505 <div class="xdocSect">DETAILS</div>
506 <div class="xdocText">This parameter is only used by C64x+ targets</div>
507 <div class="xdocSynSpacer"> </div>
508 <a class="xdocAnchor" id="local.Int.Id"></a>
509 <table class="xdocHdr"><tr>
510 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifyDriverCirc_Params.</span><span class="xdoc-id">localIntId</span> <small><span class="xdocSynSum">// instance</span></small></td>
511 <td class="xdocHdrArrow">
512 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
513 </table>
514 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#local.Int.Id">index URL</a></div>
515 <p class="xdocHdrSummaryDcl">Local interrupt ID for interrupt line</p>
516 <span id='targ-synop'></span>
517 <table class="xdocLabel"><tr>
518 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
519 <td class="xdocLabelRight">target-domain</td>
520 </tr></table>
521 <div class="xdocSynTdcl">
522 <div class="xdocSynCode">
523 <tt></tt><tt></tt><span class="xdoc-kw1">struct</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_config_parameters" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Params">NotifyDriverCirc_Params</a> {
524 </div>
525 <div class="xdocSynCode">
526 <tt></tt><tt> </tt><b> ...</b>
527 </div>
528 <div class="xdocSynCode">
529 <tt></tt><tt> </tt><span class="xdoc-kw2">UInt</span> <span class="xdoc-id">localIntId</span>;
530 </div>
531 </div>
532 <div class="xdocSynSpacer"> </div>
533 <span id="xdoc-sect-1"></span>
534 <div class="xdocSect">DETAILS</div>
535 <div class="xdocText">For devices that support multiple inter-processor interrupt lines, this
536 configuration parameter allows selecting a specific line to use for
537 receiving an interrupt. The value specified here corresponds to the
538 incoming interrupt line on the local processor.</div>
539 <div class="xdocText">If this configuration is not set, a default interrupt id is
540 typically chosen.</div>
541 <div class="xdocSynSpacer"> </div>
542 <a class="xdocAnchor" id="remote.Int.Id"></a>
543 <table class="xdocHdr"><tr>
544 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifyDriverCirc_Params.</span><span class="xdoc-id">remoteIntId</span> <small><span class="xdocSynSum">// instance</span></small></td>
545 <td class="xdocHdrArrow">
546 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
547 </table>
548 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#remote.Int.Id">index URL</a></div>
549 <p class="xdocHdrSummaryDcl">Remote interrupt ID for interrupt line</p>
550 <span id='targ-synop'></span>
551 <table class="xdocLabel"><tr>
552 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
553 <td class="xdocLabelRight">target-domain</td>
554 </tr></table>
555 <div class="xdocSynTdcl">
556 <div class="xdocSynCode">
557 <tt></tt><tt></tt><span class="xdoc-kw1">struct</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_config_parameters" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Params">NotifyDriverCirc_Params</a> {
558 </div>
559 <div class="xdocSynCode">
560 <tt></tt><tt> </tt><b> ...</b>
561 </div>
562 <div class="xdocSynCode">
563 <tt></tt><tt> </tt><span class="xdoc-kw2">UInt</span> <span class="xdoc-id">remoteIntId</span>;
564 </div>
565 </div>
566 <div class="xdocSynSpacer"> </div>
567 <span id="xdoc-sect-1"></span>
568 <div class="xdocSect">DETAILS</div>
569 <div class="xdocText">For devices that support multiple inter-processor interrupt lines, this
570 configuration parameter allows selecting a specific line to use for
571 receiving an interrupt. The value specified here corresponds to the
572 incoming interrupt line on the remote processor.</div>
573 <div class="xdocText">If this configuration is not set, a default interrupt id is
574 typically chosen.</div>
575 <div class="xdocSynSpacer"> </div>
576 <a class="xdocAnchor" id="remote.Proc.Id"></a>
577 <table class="xdocHdr"><tr>
578 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifyDriverCirc_Params.</span><span class="xdoc-id">remoteProcId</span> <small><span class="xdocSynSum">// instance</span></small></td>
579 <td class="xdocHdrArrow">
580 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
581 </table>
582 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#remote.Proc.Id">index URL</a></div>
583 <p class="xdocHdrSummaryDcl">The MultiProc ID corresponding to the remote processor</p>
584 <span id='targ-synop'></span>
585 <table class="xdocLabel"><tr>
586 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
587 <td class="xdocLabelRight">target-domain</td>
588 </tr></table>
589 <div class="xdocSynTdcl">
590 <div class="xdocSynCode">
591 <tt></tt><tt></tt><span class="xdoc-kw1">struct</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_config_parameters" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Params">NotifyDriverCirc_Params</a> {
592 </div>
593 <div class="xdocSynCode">
594 <tt></tt><tt> </tt><b> ...</b>
595 </div>
596 <div class="xdocSynCode">
597 <tt></tt><tt> </tt><span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>;
598 </div>
599 </div>
600 <div class="xdocSynSpacer"> </div>
601 <span id="xdoc-sect-1"></span>
602 <div class="xdocSect">DETAILS</div>
603 <div class="xdocText">This parameter must be set for every device. The
604 MultiProc_getId call can be used to obtain
605 a MultiProc id given the remote processor's name.</div>
606 <div class="xdocSynSpacer"> </div>
607 <a class="xdocAnchor" id="shared.Addr"></a>
608 <table class="xdocHdr"><tr>
609 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifyDriverCirc_Params.</span><span class="xdoc-id">sharedAddr</span> <small><span class="xdocSynSum">// instance</span></small></td>
610 <td class="xdocHdrArrow">
611 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
612 </table>
613 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#shared.Addr">index URL</a></div>
614 <p class="xdocHdrSummaryDcl">Address in shared memory where this instance will be placed</p>
615 <span id='targ-synop'></span>
616 <table class="xdocLabel"><tr>
617 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
618 <td class="xdocLabelRight">target-domain</td>
619 </tr></table>
620 <div class="xdocSynTdcl">
621 <div class="xdocSynCode">
622 <tt></tt><tt></tt><span class="xdoc-kw1">struct</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_config_parameters" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Params">NotifyDriverCirc_Params</a> {
623 </div>
624 <div class="xdocSynCode">
625 <tt></tt><tt> </tt><b> ...</b>
626 </div>
627 <div class="xdocSynCode">
628 <tt></tt><tt> </tt><span class="xdoc-kw2">Ptr</span> <span class="xdoc-id">sharedAddr</span>;
629 </div>
630 </div>
631 <div class="xdocSynSpacer"> </div>
632 <span id="xdoc-sect-1"></span>
633 <div class="xdocSect">DETAILS</div>
634 <div class="xdocText">Use <a class="xdoc-link" href="NotifyDriverCirc.html#shared.Mem.Req" title="sharedMemReq">sharedMemReq</a> to determine the amount of shared memory
635 required.</div>
636 <div class="xdocSynSpacer"> </div>
637 <a class="xdocAnchor" id="disable"></a>
638 <table class="xdocHdr"><tr>
639 <td class="xdocHdrTitle"><span class="xdoc-id">NotifyDriverCirc_</span><span class="xdoc-id">disable</span>() <small><span class="xdocSynSum">// instance</span></small></td>
640 <td class="xdocHdrArrow">
641 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
642 </table>
643 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#disable">index URL</a></div>
644 <p class="xdocHdrSummaryDcl">Disable a NotifyDriver instance</p>
645 <span id='targ-synop'></span>
646 <table class="xdocLabel"><tr>
647 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
648 <td class="xdocLabelRight">target-domain</td>
649 </tr></table>
650 <div class="xdocSynTdcl">
651 <div class="xdocSynCode">
652 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">NotifyDriverCirc_disable</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_object_types" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Handle">NotifyDriverCirc_Handle</a> handle);
653 </div>
654 </div>
655 <div class="xdocSynSpacer"> </div>
656 <span id="xdoc-sect-1"></span>
657 <div class="xdocSect">ARGUMENTS</div>
658 <div class="xdocChild"><span class="xdocChildId">handle</span>
659 <span class="xdocChildSum">— handle of a previously-created <tt>NotifyDriverCirc</tt> instance object</span>
660 </div>
661 <span id="xdoc-sect-2"></span>
662 <div class="xdocSect">DETAILS</div>
663 <div class="xdocText">Disables the ability of a Notify driver to receive events for a given
664 processor. This interface function is called by the Notify_disable
665 function. Refer to its documentation for more details.</div>
666 <div class="xdocSynSpacer"> </div>
667 <a class="xdocAnchor" id="disable.Event"></a>
668 <table class="xdocHdr"><tr>
669 <td class="xdocHdrTitle"><span class="xdoc-id">NotifyDriverCirc_</span><span class="xdoc-id">disableEvent</span>() <small><span class="xdocSynSum">// instance</span></small></td>
670 <td class="xdocHdrArrow">
671 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
672 </table>
673 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#disable.Event">index URL</a></div>
674 <p class="xdocHdrSummaryDcl">Disable an event</p>
675 <span id='targ-synop'></span>
676 <table class="xdocLabel"><tr>
677 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
678 <td class="xdocLabelRight">target-domain</td>
679 </tr></table>
680 <div class="xdocSynTdcl">
681 <div class="xdocSynCode">
682 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">NotifyDriverCirc_disableEvent</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_object_types" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Handle">NotifyDriverCirc_Handle</a> handle, <span class="xdoc-kw2">UInt32</span> <span class="xdoc-id">eventId</span>);
683 </div>
684 </div>
685 <div class="xdocSynSpacer"> </div>
686 <span id="xdoc-sect-1"></span>
687 <div class="xdocSect">ARGUMENTS</div>
688 <div class="xdocChild"><span class="xdocChildId">handle</span>
689 <span class="xdocChildSum">— handle of a previously-created <tt>NotifyDriverCirc</tt> instance object</span>
690 </div>
691 <div class="xdocChild"><span class="xdocChildId">eventId</span>
692 <span class="xdocChildSum">— Number of event to disable</span>
693 </div>
694 <span id="xdoc-sect-2"></span>
695 <div class="xdocSect">DETAILS</div>
696 <div class="xdocText">This interface function is called by the Notify_disableEvent function.
697 Refer to its documentation for more details.</div>
698 <div class="xdocText">The Notify module does validation of the eventId. The Notify module
699 enters calls this function within the Notify module gate.</div>
700 <div class="xdocSynSpacer"> </div>
701 <a class="xdocAnchor" id="enable"></a>
702 <table class="xdocHdr"><tr>
703 <td class="xdocHdrTitle"><span class="xdoc-id">NotifyDriverCirc_</span><span class="xdoc-id">enable</span>() <small><span class="xdocSynSum">// instance</span></small></td>
704 <td class="xdocHdrArrow">
705 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
706 </table>
707 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#enable">index URL</a></div>
708 <p class="xdocHdrSummaryDcl">Enable a NotifyDriver instance</p>
709 <span id='targ-synop'></span>
710 <table class="xdocLabel"><tr>
711 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
712 <td class="xdocLabelRight">target-domain</td>
713 </tr></table>
714 <div class="xdocSynTdcl">
715 <div class="xdocSynCode">
716 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">NotifyDriverCirc_enable</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_object_types" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Handle">NotifyDriverCirc_Handle</a> handle);
717 </div>
718 </div>
719 <div class="xdocSynSpacer"> </div>
720 <span id="xdoc-sect-1"></span>
721 <div class="xdocSect">ARGUMENTS</div>
722 <div class="xdocChild"><span class="xdocChildId">handle</span>
723 <span class="xdocChildSum">— handle of a previously-created <tt>NotifyDriverCirc</tt> instance object</span>
724 </div>
725 <span id="xdoc-sect-2"></span>
726 <div class="xdocSect">DETAILS</div>
727 <div class="xdocText">Enables the ability of a Notify driver to receive events for a given
728 processor. This interface function is called by the Notify_restore
729 function. Refer to its documentation for more details.</div>
730 <div class="xdocSynSpacer"> </div>
731 <a class="xdocAnchor" id="enable.Event"></a>
732 <table class="xdocHdr"><tr>
733 <td class="xdocHdrTitle"><span class="xdoc-id">NotifyDriverCirc_</span><span class="xdoc-id">enableEvent</span>() <small><span class="xdocSynSum">// instance</span></small></td>
734 <td class="xdocHdrArrow">
735 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
736 </table>
737 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#enable.Event">index URL</a></div>
738 <p class="xdocHdrSummaryDcl">Enable an event</p>
739 <span id='targ-synop'></span>
740 <table class="xdocLabel"><tr>
741 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
742 <td class="xdocLabelRight">target-domain</td>
743 </tr></table>
744 <div class="xdocSynTdcl">
745 <div class="xdocSynCode">
746 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">NotifyDriverCirc_enableEvent</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_object_types" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Handle">NotifyDriverCirc_Handle</a> handle, <span class="xdoc-kw2">UInt32</span> <span class="xdoc-id">eventId</span>);
747 </div>
748 </div>
749 <div class="xdocSynSpacer"> </div>
750 <span id="xdoc-sect-1"></span>
751 <div class="xdocSect">ARGUMENTS</div>
752 <div class="xdocChild"><span class="xdocChildId">handle</span>
753 <span class="xdocChildSum">— handle of a previously-created <tt>NotifyDriverCirc</tt> instance object</span>
754 </div>
755 <div class="xdocChild"><span class="xdocChildId">eventId</span>
756 <span class="xdocChildSum">— Number of event to enable</span>
757 </div>
758 <span id="xdoc-sect-2"></span>
759 <div class="xdocSect">DETAILS</div>
760 <div class="xdocText">This interface function is called by the Notify_disableEvent function.
761 Refer to its documentation for more details.</div>
762 <div class="xdocText">The Notify module does validation of the eventId. The Notify module
763 enters calls this function within the Notify module gate.</div>
764 <div class="xdocSynSpacer"> </div>
765 <a class="xdocAnchor" id="register.Event"></a>
766 <table class="xdocHdr"><tr>
767 <td class="xdocHdrTitle"><span class="xdoc-id">NotifyDriverCirc_</span><span class="xdoc-id">registerEvent</span>() <small><span class="xdocSynSum">// instance</span></small></td>
768 <td class="xdocHdrArrow">
769 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
770 </table>
771 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#register.Event">index URL</a></div>
772 <p class="xdocHdrSummaryDcl">Register a callback to an event</p>
773 <span id='targ-synop'></span>
774 <table class="xdocLabel"><tr>
775 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
776 <td class="xdocLabelRight">target-domain</td>
777 </tr></table>
778 <div class="xdocSynTdcl">
779 <div class="xdocSynCode">
780 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">NotifyDriverCirc_registerEvent</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_object_types" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Handle">NotifyDriverCirc_Handle</a> handle, <span class="xdoc-kw2">UInt32</span> <span class="xdoc-id">eventId</span>);
781 </div>
782 </div>
783 <div class="xdocSynSpacer"> </div>
784 <span id="xdoc-sect-1"></span>
785 <div class="xdocSect">ARGUMENTS</div>
786 <div class="xdocChild"><span class="xdocChildId">handle</span>
787 <span class="xdocChildSum">— handle of a previously-created <tt>NotifyDriverCirc</tt> instance object</span>
788 </div>
789 <div class="xdocChild"><span class="xdocChildId">eventId</span>
790 <span class="xdocChildSum">— Number of event that is being registered</span>
791 </div>
792 <span id="xdoc-sect-2"></span>
793 <div class="xdocSect">DETAILS</div>
794 <div class="xdocText">This driver function is called by the Notify_registerEvent function
795 within the Notify module gate. Refer to its documentation for more
796 details.</div>
797 <div class="xdocSynSpacer"> </div>
798 <a class="xdocAnchor" id="send.Event"></a>
799 <table class="xdocHdr"><tr>
800 <td class="xdocHdrTitle"><span class="xdoc-id">NotifyDriverCirc_</span><span class="xdoc-id">sendEvent</span>() <small><span class="xdocSynSum">// instance</span></small></td>
801 <td class="xdocHdrArrow">
802 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
803 </table>
804 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#send.Event">index URL</a></div>
805 <p class="xdocHdrSummaryDcl">Send a signal to an event</p>
806 <span id='targ-synop'></span>
807 <table class="xdocLabel"><tr>
808 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
809 <td class="xdocLabelRight">target-domain</td>
810 </tr></table>
811 <div class="xdocSynTdcl">
812 <div class="xdocSynCode">
813 <tt></tt><tt></tt><span class="xdoc-kw2">Int</span> <span class="xdoc-id">NotifyDriverCirc_sendEvent</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_object_types" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Handle">NotifyDriverCirc_Handle</a> handle, <span class="xdoc-kw2">UInt32</span> <span class="xdoc-id">eventId</span>, <span class="xdoc-kw2">UInt32</span> <span class="xdoc-id">payload</span>, <span class="xdoc-kw2">Bool</span> <span class="xdoc-id">waitClear</span>);
814 </div>
815 </div>
816 <div class="xdocSynSpacer"> </div>
817 <span id="xdoc-sect-1"></span>
818 <div class="xdocSect">ARGUMENTS</div>
819 <div class="xdocChild"><span class="xdocChildId">handle</span>
820 <span class="xdocChildSum">— handle of a previously-created <tt>NotifyDriverCirc</tt> instance object</span>
821 </div>
822 <div class="xdocChild"><span class="xdocChildId">eventId</span>
823 <span class="xdocChildSum">— Number of event to signal</span>
824 </div>
825 <div class="xdocChild"><span class="xdocChildId">payload</span>
826 <span class="xdocChildSum">— Payload (optional) to pass to callback function</span>
827 </div>
828 <div class="xdocChild"><span class="xdocChildId">waitClear</span>
829 <span class="xdocChildSum">— If TRUE, have the NotifyDriver wait for
830 acknowledgement back from the destination
831 processor.</span>
832 </div>
833 <span id="xdoc-sect-2"></span>
834 <div class="xdocSect">RETURNS</div>
835 <div class="xdocText">Notify status</div>
836 <span id="xdoc-sect-3"></span>
837 <div class="xdocSect">DETAILS</div>
838 <div class="xdocText">This interface function is called by the Notify_sendEvent function.
839 Notify_sendEvent does not provide any context protection for
840 INotifyDriver_sendEvent, so appropriate measures must be taken within
841 the driver itself.</div>
842 <div class="xdocSynSpacer"> </div>
843 <a class="xdocAnchor" id="unregister.Event"></a>
844 <table class="xdocHdr"><tr>
845 <td class="xdocHdrTitle"><span class="xdoc-id">NotifyDriverCirc_</span><span class="xdoc-id">unregisterEvent</span>() <small><span class="xdocSynSum">// instance</span></small></td>
846 <td class="xdocHdrArrow">
847 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
848 </table>
849 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#unregister.Event">index URL</a></div>
850 <p class="xdocHdrSummaryDcl">Remove an event listener from an event</p>
851 <span id='targ-synop'></span>
852 <table class="xdocLabel"><tr>
853 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
854 <td class="xdocLabelRight">target-domain</td>
855 </tr></table>
856 <div class="xdocSynTdcl">
857 <div class="xdocSynCode">
858 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">NotifyDriverCirc_unregisterEvent</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_object_types" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Handle">NotifyDriverCirc_Handle</a> handle, <span class="xdoc-kw2">UInt32</span> <span class="xdoc-id">eventId</span>);
859 </div>
860 </div>
861 <div class="xdocSynSpacer"> </div>
862 <span id="xdoc-sect-1"></span>
863 <div class="xdocSect">ARGUMENTS</div>
864 <div class="xdocChild"><span class="xdocChildId">handle</span>
865 <span class="xdocChildSum">— handle of a previously-created <tt>NotifyDriverCirc</tt> instance object</span>
866 </div>
867 <div class="xdocChild"><span class="xdocChildId">eventId</span>
868 <span class="xdocChildSum">— Number of event that is being unregistered</span>
869 </div>
870 <span id="xdoc-sect-2"></span>
871 <div class="xdocSect">DETAILS</div>
872 <div class="xdocText">This driver function is called by the Notify_unregisterEvent function
873 within the Notify module gate. Refer to it for more details.</div>
874 <a class="xdocAnchor" id="per-instance_convertors"></a>
875 <table class="xdocHdr"><tr>
876 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Convertors</span></td>
877 <td class="xdocHdrArrow">
878 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
879 </table>
880 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_convertors">index URL</a></div>
881 <p class="xdocHdrSummary"></p>
882 <span id='targ-synop'></span>
883 <table class="xdocLabel"><tr>
884 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
885 <td class="xdocLabelRight">target-domain</td>
886 </tr></table>
887 <div class="xdocSynTdcl">
888 <div class="xdocSynCode">
889 <tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/interfaces/INotifyDriver.html#per-instance_object_types" title="ti.sdo.ipc.interfaces.INotifyDriver.Handle">INotifyDriver_Handle</a> <span class="xdoc-id">NotifyDriverCirc_Handle_upCast</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_object_types" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Handle">NotifyDriverCirc_Handle</a> handle);
890 </div>
891 <div class='xdocSynSum'><tt></tt><tt></tt>// unconditionally move one level up the inheritance hierarchy</div>
892 <div class="xdocSynSpacer"> </div>
893 <div class="xdocSynCode">
894 <tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_object_types" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Handle">NotifyDriverCirc_Handle</a> <span class="xdoc-id">NotifyDriverCirc_Handle_downCast</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/interfaces/INotifyDriver.html#per-instance_object_types" title="ti.sdo.ipc.interfaces.INotifyDriver.Handle">INotifyDriver_Handle</a> handle);
895 </div>
896 <div class='xdocSynSum'><tt></tt><tt></tt>// conditionally move one level down the inheritance hierarchy; NULL upon failure</div>
897 </div>
898 <a class="xdocAnchor" id="per-instance_built-ins"></a>
899 <table class="xdocHdr"><tr>
900 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Built-Ins</span></td>
901 <td class="xdocHdrArrow">
902 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
903 </table>
904 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_built-ins">index URL</a></div>
905 <p class="xdocHdrSummary"></p>
906 <span id='targ-synop'></span>
907 <table class="xdocLabel"><tr>
908 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
909 <td class="xdocLabelRight">target-domain</td>
910 </tr></table>
911 <div class="xdocSynTdcl">
912 <div class="xdocSynCode">
913 <tt></tt><tt></tt><span class="xdoc-kw2">Int</span> <span class="xdoc-id">NotifyDriverCirc_Object_count</span>();
914 </div>
915 <div class='xdocSynSum'><tt></tt><tt></tt>// The number of statically-created instance objects</div>
916 <div class="xdocSynSpacer"> </div>
917 <div class="xdocSynCode">
918 <tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_object_types" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Handle">NotifyDriverCirc_Handle</a> <span class="xdoc-id">NotifyDriverCirc_Object_get</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_object_types" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Object">NotifyDriverCirc_Object</a> *array, <span class="xdoc-kw2">Int</span> i);
919 </div>
920 <div class='xdocSynSum'><tt></tt><tt></tt>// The handle of the i-th statically-created instance object (array == NULL)</div>
921 <div class="xdocSynSpacer"> </div>
922 <div class="xdocSynCode">
923 <tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_object_types" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Handle">NotifyDriverCirc_Handle</a> <span class="xdoc-id">NotifyDriverCirc_Object_first</span>();
924 </div>
925 <div class='xdocSynSum'><tt></tt><tt></tt>// The handle of the first dynamically-created instance object, or NULL</div>
926 <div class="xdocSynSpacer"> </div>
927 <div class="xdocSynCode">
928 <tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_object_types" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Handle">NotifyDriverCirc_Handle</a> <span class="xdoc-id">NotifyDriverCirc_Object_next</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_object_types" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Handle">NotifyDriverCirc_Handle</a> handle);
929 </div>
930 <div class='xdocSynSum'><tt></tt><tt></tt>// The handle of the next dynamically-created instance object, or NULL</div>
931 <div class="xdocSynSpacer"> </div>
932 <div class="xdocSynCode">
933 <tt></tt><tt></tt><a class="xdoc-link" href="../../../../xdc/runtime/IHeap.html#per-instance_object_types" title="xdc.runtime.IHeap.Handle">IHeap_Handle</a> <span class="xdoc-id">NotifyDriverCirc_Object_heap</span>();
934 </div>
935 <div class='xdocSynSum'><tt></tt><tt></tt>// The heap used to allocate dynamically-created instance objects</div>
936 <div class="xdocSynSpacer"> </div>
937 <div class="xdocSynCode">
938 <tt></tt><tt></tt><a class="xdoc-link" href="../../../../xdc/runtime/Types.html#.Label" title="xdc.runtime.Types.Label">Types_Label</a> *<span class="xdoc-id">NotifyDriverCirc_Handle_label</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_object_types" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Handle">NotifyDriverCirc_Handle</a> handle, <a class="xdoc-link" href="../../../../xdc/runtime/Types.html#.Label" title="xdc.runtime.Types.Label">Types_Label</a> *buf);
939 </div>
940 <div class='xdocSynSum'><tt></tt><tt></tt>// The label associated with this instance object</div>
941 <div class="xdocSynSpacer"> </div>
942 <div class="xdocSynCode">
943 <tt></tt><tt></tt><span class="xdoc-kw2">String</span> <span class="xdoc-id">NotifyDriverCirc_Handle_name</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_object_types" title="ti.sdo.ipc.notifyDrivers.NotifyDriverCirc.Handle">NotifyDriverCirc_Handle</a> handle);
944 </div>
945 <div class='xdocSynSum'><tt></tt><tt></tt>// The name of this instance object</div>
946 </div>
947 </div>
948 <div class="xdocSynSpacer"> </div>
949 <span id='meta-synop'></span>
950 <table class="xdocLabel"><tr>
951 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2"></span></tt>Configuration settings</td>
952 <td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc-src.html"><span class="xdocLabelFile">ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.xdc</span></a></td>
953 </tr></table>
954 <div class="xdocSynM">
955 <div class="xdocSynCode">
956 <tt></tt><span class="xdoc-kw1">var</span> NotifyDriverCirc = <span class="xdoc-kw3">xdc.useModule</span>(<span class="xdoc-id">'ti.sdo.ipc.notifyDrivers.NotifyDriverCirc'</span>);
957 </div>
958 <div class='xdocSynHdr'>module-wide config parameters</div>
960 <div class="xdocSynCode">
961 <tt> </tt><tt></tt><a class="xdocSynGo" href="#meta.A_not.Supported">NotifyDriverCirc.<span class="xdoc-id">A_notSupported</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert raised when trying to use Notify_[enable/disable]Event with
962 NotifyDriverCirc</span></span></a> = <i><a class="xdoc-link" href="../../../../xdc/runtime/Assert.html#.Desc" title="xdc.runtime.Assert.Desc">Assert.Desc</a></i> {
963 </div>
964 <div class="xdocSynCode">
965 <tt> </tt><tt> </tt>msg: "A_notSupported: [enable/disable]Event not supported by NotifyDriverCirc"
966 </div>
967 <div class="xdocSynCode">
968 <tt> </tt><tt></tt>};
969 </div>
970 <div class="xdocSynCode">
971 <tt> </tt><tt></tt><a class="xdocSynGo" href="#metaenable.Stats">NotifyDriverCirc.<span class="xdoc-id">enableStats</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Enable statistics for sending an event</span></span></a> = <i><span class="xdoc-kw2">Bool</span></i> <span class="xdoc-kw2">false</span>;
972 </div>
973 <div class="xdocSynCode">
974 <tt> </tt><tt></tt><a class="xdocSynGo" href="#metanum.Msgs">NotifyDriverCirc.<span class="xdoc-id">numMsgs</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The number of messages or slots in the circular buffer</span></span></a> = <i><span class="xdoc-kw2">UInt</span></i> 32;
975 </div>
976 <div class="xdocSynSpacer"> </div>
977 <div class="xdocSynCode">
978 <tt> </tt><tt></tt><a class="xdocSynGo" href="#common$">NotifyDriverCirc.<span class="xdoc-id">common$</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Common module configuration parameters</span></span></a> = <i><a class="xdoc-link" href="../../../../xdc/runtime/Types.html#.Common$" title="xdc.runtime.Types.Common$">Types.Common$</a></i> <span class="xdoc-kw2">undefined</span>;
979 </div>
980 <div class="xdocSynCode">
981 <tt> </tt><tt></tt><a class="xdocSynGo" href="#rov.View.Info">NotifyDriverCirc.<span class="xdoc-id">rovViewInfo</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a> = <i><a class="xdoc-link" href="../../../../xdc/rov/ViewInfo.html#.Instance" title="xdc.rov.ViewInfo.Instance">ViewInfo.Instance</a></i> <a class="xdoc-link" href="../../../../xdc/rov/ViewInfo.html#per-instance_creation" title="xdc.rov.ViewInfo.create">ViewInfo.create</a>;
982 </div>
983 <div class='xdocSynHdr'>per-instance config parameters</div>
985 <div class="xdocSynCode">
986 <tt> </tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> NotifyDriverCirc.<a class="xdocSynGo" href="#metaper-instance_config_parameters"><span class="xdoc-id">Params</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Instance config-params object</span></span></a>;
987 </div>
988 <div class="xdocSynCode">
989 <tt> </tt><tt> </tt>params.<a class="xdocSynGo" href="#metacache.Enabled"><span class="xdoc-id">cacheEnabled</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Whether cache operations will be performed</span></span></a> = <i><span class="xdoc-kw2">Bool</span></i> <span class="xdoc-kw2">true</span>;
990 </div>
991 <div class="xdocSynCode">
992 <tt> </tt><tt> </tt>params.<a class="xdocSynGo" href="#metacache.Line.Size"><span class="xdoc-id">cacheLineSize</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The cache line size of the shared memory</span></span></a> = <i><span class="xdoc-kw2">SizeT</span></i> 128;
993 </div>
994 <div class="xdocSynCode">
995 <tt> </tt><tt> </tt>params.<a class="xdocSynGo" href="#metaint.Vector.Id"><span class="xdoc-id">intVectorId</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Interrupt vector ID to be used by the driver</span></span></a> = <i><span class="xdoc-kw2">UInt</span></i> ~1u;
996 </div>
997 <div class="xdocSynCode">
998 <tt> </tt><tt> </tt>params.<a class="xdocSynGo" href="#metalocal.Int.Id"><span class="xdoc-id">localIntId</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Local interrupt ID for interrupt line</span></span></a> = <i><span class="xdoc-kw2">UInt</span></i> -1u;
999 </div>
1000 <div class="xdocSynCode">
1001 <tt> </tt><tt> </tt>params.<a class="xdocSynGo" href="#metaremote.Int.Id"><span class="xdoc-id">remoteIntId</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Remote interrupt ID for interrupt line</span></span></a> = <i><span class="xdoc-kw2">UInt</span></i> -1u;
1002 </div>
1003 <div class="xdocSynCode">
1004 <tt> </tt><tt> </tt>params.<a class="xdocSynGo" href="#metaremote.Proc.Id"><span class="xdoc-id">remoteProcId</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The MultiProc ID corresponding to the remote processor</span></span></a> = <i><span class="xdoc-kw2">UInt16</span></i> <a class="xdoc-link" href="../../../../ti/sdo/utils/MultiProc.html#.I.N.V.A.L.I.D.I.D" title="ti.sdo.utils.MultiProc.INVALIDID">MultiProc.INVALIDID</a>;
1005 </div>
1006 <div class="xdocSynCode">
1007 <tt> </tt><tt> </tt>params.<a class="xdocSynGo" href="#metashared.Addr"><span class="xdoc-id">sharedAddr</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Address in shared memory where this instance will be placed</span></span></a> = <i><span class="xdoc-kw2">Ptr</span></i> <span class="xdoc-kw2">null</span>;
1008 </div>
1009 <div class="xdocSynSpacer"> </div>
1010 </div>
1011 <div id="xdocSep">
1012 </div>
1013 <div id="xdocMetaElems">
1014 <div class="xdocSynSpacer"> </div>
1015 <a class="xdocAnchor" id="meta.A_not.Supported"></a>
1016 <table class="xdocHdr"><tr>
1017 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifyDriverCirc.</span><span class="xdoc-id">A_notSupported</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
1018 <td class="xdocHdrArrow">
1019 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
1020 </table>
1021 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#.A_not.Supported">index URL</a></div>
1022 <p class="xdocHdrSummaryDcl">Assert raised when trying to use Notify_[enable/disable]Event with
1023 NotifyDriverCirc</p>
1024 <span id='meta-synop'></span>
1025 <table class="xdocLabel"><tr>
1026 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
1027 <td class="xdocLabelRight"></td>
1028 </tr></table>
1029 <div class="xdocSynMdcl">
1030 <div class="xdocSynCode">
1031 <tt></tt><tt></tt>NotifyDriverCirc.<span class="xdoc-id">A_notSupported</span> = <i><a class="xdoc-link" href="../../../../xdc/runtime/Assert.html#.Desc" title="xdc.runtime.Assert.Desc">Assert.Desc</a></i> {
1032 </div>
1033 <div class="xdocSynCode">
1034 <tt></tt><tt> </tt>msg: "A_notSupported: [enable/disable]Event not supported by NotifyDriverCirc"
1035 </div>
1036 <div class="xdocSynCode">
1037 <tt></tt><tt></tt>};
1038 </div>
1039 </div>
1040 <div class="xdocSynSpacer"> </div>
1041 <div class="xdocSect">C SYNOPSIS</div>
1042 <div class="xdocText"><a class="xdoc-link" href="#.A_not.Supported" title="NotifyDriverCirc_A_notSupported">NotifyDriverCirc_A_notSupported</a></div>
1043 <div class="xdocSynSpacer"> </div>
1044 <a class="xdocAnchor" id="metaenable.Stats"></a>
1045 <table class="xdocHdr"><tr>
1046 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifyDriverCirc.</span><span class="xdoc-id">enableStats</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
1047 <td class="xdocHdrArrow">
1048 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
1049 </table>
1050 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#enable.Stats">index URL</a></div>
1051 <p class="xdocHdrSummaryDcl">Enable statistics for sending an event</p>
1052 <span id='meta-synop'></span>
1053 <table class="xdocLabel"><tr>
1054 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
1055 <td class="xdocLabelRight"></td>
1056 </tr></table>
1057 <div class="xdocSynMdcl">
1058 <div class="xdocSynCode">
1059 <tt></tt><tt></tt>NotifyDriverCirc.<span class="xdoc-id">enableStats</span> = <i><span class="xdoc-kw2">Bool</span></i> <span class="xdoc-kw2">false</span>;
1060 </div>
1061 </div>
1062 <div class="xdocSynSpacer"> </div>
1063 <span id="xdoc-sect-1"></span>
1064 <div class="xdocSect">DETAILS</div>
1065 <div class="xdocText">If this parameter is to 'TRUE' and 'waitClear' is also set to
1066 TRUE when calling (@link #sendEvent(), then the module keeps
1067 track of the number of times the processor spins waiting for
1068 an empty slot and the max amount of time it waits.</div>
1069 <div class="xdocSect">C SYNOPSIS</div>
1070 <div class="xdocText"><a class="xdoc-link" href="#enable.Stats" title="NotifyDriverCirc_enableStats">NotifyDriverCirc_enableStats</a></div>
1071 <div class="xdocSynSpacer"> </div>
1072 <a class="xdocAnchor" id="metanum.Msgs"></a>
1073 <table class="xdocHdr"><tr>
1074 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifyDriverCirc.</span><span class="xdoc-id">numMsgs</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
1075 <td class="xdocHdrArrow">
1076 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
1077 </table>
1078 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#num.Msgs">index URL</a></div>
1079 <p class="xdocHdrSummaryDcl">The number of messages or slots in the circular buffer</p>
1080 <span id='meta-synop'></span>
1081 <table class="xdocLabel"><tr>
1082 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
1083 <td class="xdocLabelRight"></td>
1084 </tr></table>
1085 <div class="xdocSynMdcl">
1086 <div class="xdocSynCode">
1087 <tt></tt><tt></tt>NotifyDriverCirc.<span class="xdoc-id">numMsgs</span> = <i><span class="xdoc-kw2">UInt</span></i> 32;
1088 </div>
1089 </div>
1090 <div class="xdocSynSpacer"> </div>
1091 <span id="xdoc-sect-1"></span>
1092 <div class="xdocSect">DETAILS</div>
1093 <div class="xdocText">This is use to determine the size of the put and get buffers.
1094 Each eventEntry is two 32bits wide, therefore the total size
1095 of each circular buffer is [numMsgs * sizeof(eventEntry)].
1096 The total size of each buffer must be a multiple of the
1097 the cache line size. For example, if the cacheLineSize = 128
1098 then numMsgs could be 16, 32, etc...</div>
1099 <div class="xdocSect">C SYNOPSIS</div>
1100 <div class="xdocText"><a class="xdoc-link" href="#num.Msgs" title="NotifyDriverCirc_numMsgs">NotifyDriverCirc_numMsgs</a></div>
1101 <div class="xdocSynSpacer"> </div>
1102 <a class="xdocAnchor" id="common$"></a>
1103 <table class="xdocHdr"><tr>
1104 <td class="xdocHdrTitle"><span class="xdoc-kw1">metaonly </span><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifyDriverCirc.</span><span class="xdoc-id">common$</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
1105 <td class="xdocHdrArrow">
1106 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
1107 </table>
1108 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#common$">index URL</a></div>
1109 <p class="xdocHdrSummaryDcl">Common module configuration parameters</p>
1110 <span id='meta-synop'></span>
1111 <table class="xdocLabel"><tr>
1112 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
1113 <td class="xdocLabelRight"></td>
1114 </tr></table>
1115 <div class="xdocSynMdcl">
1116 <div class="xdocSynCode">
1117 <tt></tt><tt></tt>NotifyDriverCirc.<span class="xdoc-id">common$</span> = <i><a class="xdoc-link" href="../../../../xdc/runtime/Types.html#.Common$" title="xdc.runtime.Types.Common$">Types.Common$</a></i> <span class="xdoc-kw2">undefined</span>;
1118 </div>
1119 </div>
1120 <div class="xdocSynSpacer"> </div>
1121 <span id="xdoc-sect-1"></span>
1122 <div class="xdocSect">DETAILS</div>
1123 <div class="xdocText">All modules have this configuration parameter. Its name
1124 contains the '$' character to ensure it does not conflict with
1125 configuration parameters declared by the module. This allows
1126 new configuration parameters to be added in the future without
1127 any chance of breaking existing modules.</div>
1128 <div class="xdocSynSpacer"> </div>
1129 <a class="xdocAnchor" id="rov.View.Info"></a>
1130 <table class="xdocHdr"><tr>
1131 <td class="xdocHdrTitle"><span class="xdoc-kw1">metaonly </span><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifyDriverCirc.</span><span class="xdoc-id">rovViewInfo</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
1132 <td class="xdocHdrArrow">
1133 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
1134 </table>
1135 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#rov.View.Info">index URL</a></div>
1136 <span id='meta-synop'></span>
1137 <table class="xdocLabel"><tr>
1138 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
1139 <td class="xdocLabelRight"></td>
1140 </tr></table>
1141 <div class="xdocSynMdcl">
1142 <div class="xdocSynCode">
1143 <tt></tt><tt></tt>NotifyDriverCirc.<span class="xdoc-id">rovViewInfo</span> = <i><a class="xdoc-link" href="../../../../xdc/rov/ViewInfo.html#.Instance" title="xdc.rov.ViewInfo.Instance">ViewInfo.Instance</a></i> <a class="xdoc-link" href="../../../../xdc/rov/ViewInfo.html#per-instance_creation" title="xdc.rov.ViewInfo.create">ViewInfo.create</a>;
1144 </div>
1145 </div>
1146 <div class="xdocSynSpacer"> </div>
1147 <a class="xdocAnchor" id="metaper-instance_config_parameters"></a>
1148 <table class="xdocHdr"><tr>
1149 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Config Parameters</span></td>
1150 <td class="xdocHdrArrow">
1151 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
1152 </table>
1153 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#per-instance_config_parameters">index URL</a></div>
1154 <p class="xdocHdrSummary"></p>
1155 <span id='meta-synop'></span>
1156 <table class="xdocLabel"><tr>
1157 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
1158 <td class="xdocLabelRight"></td>
1159 </tr></table>
1160 <div class="xdocSynMdcl">
1161 <div class="xdocSynCode">
1162 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> NotifyDriverCirc.<span class="xdoc-id">Params</span>;
1163 </div>
1164 <div class='xdocSynSum'><tt></tt><tt></tt>// Instance config-params object</div>
1165 <div class="xdocSynCode">
1166 <tt></tt><tt> </tt>params.<span class="xdoc-id">cacheEnabled</span> = <i><span class="xdoc-kw2">Bool</span></i> <span class="xdoc-kw2">true</span>;
1167 </div>
1168 <div class='xdocSynSum'><tt></tt><tt> </tt>// Whether cache operations will be performed</div>
1169 <div class="xdocSynCode">
1170 <tt></tt><tt> </tt>params.<span class="xdoc-id">cacheLineSize</span> = <i><span class="xdoc-kw2">SizeT</span></i> 128;
1171 </div>
1172 <div class='xdocSynSum'><tt></tt><tt> </tt>// The cache line size of the shared memory</div>
1173 <div class="xdocSynCode">
1174 <tt></tt><tt> </tt>params.<span class="xdoc-id">intVectorId</span> = <i><span class="xdoc-kw2">UInt</span></i> ~1u;
1175 </div>
1176 <div class='xdocSynSum'><tt></tt><tt> </tt>// Interrupt vector ID to be used by the driver</div>
1177 <div class="xdocSynCode">
1178 <tt></tt><tt> </tt>params.<span class="xdoc-id">localIntId</span> = <i><span class="xdoc-kw2">UInt</span></i> -1u;
1179 </div>
1180 <div class='xdocSynSum'><tt></tt><tt> </tt>// Local interrupt ID for interrupt line</div>
1181 <div class="xdocSynCode">
1182 <tt></tt><tt> </tt>params.<span class="xdoc-id">remoteIntId</span> = <i><span class="xdoc-kw2">UInt</span></i> -1u;
1183 </div>
1184 <div class='xdocSynSum'><tt></tt><tt> </tt>// Remote interrupt ID for interrupt line</div>
1185 <div class="xdocSynCode">
1186 <tt></tt><tt> </tt>params.<span class="xdoc-id">remoteProcId</span> = <i><span class="xdoc-kw2">UInt16</span></i> <a class="xdoc-link" href="../../../../ti/sdo/utils/MultiProc.html#.I.N.V.A.L.I.D.I.D" title="ti.sdo.utils.MultiProc.INVALIDID">MultiProc.INVALIDID</a>;
1187 </div>
1188 <div class='xdocSynSum'><tt></tt><tt> </tt>// The MultiProc ID corresponding to the remote processor</div>
1189 <div class="xdocSynCode">
1190 <tt></tt><tt> </tt>params.<span class="xdoc-id">sharedAddr</span> = <i><span class="xdoc-kw2">Ptr</span></i> <span class="xdoc-kw2">null</span>;
1191 </div>
1192 <div class='xdocSynSum'><tt></tt><tt> </tt>// Address in shared memory where this instance will be placed</div>
1193 </div>
1194 <div class="xdocSynSpacer"> </div>
1195 <a class="xdocAnchor" id="metacache.Enabled"></a>
1196 <table class="xdocHdr"><tr>
1197 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifyDriverCirc.Params.</span><span class="xdoc-id">cacheEnabled</span> <small><span class="xdocSynSum">// instance</span></small></td>
1198 <td class="xdocHdrArrow">
1199 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
1200 </table>
1201 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#cache.Enabled">index URL</a></div>
1202 <p class="xdocHdrSummaryDcl">Whether cache operations will be performed</p>
1203 <span id='meta-synop'></span>
1204 <table class="xdocLabel"><tr>
1205 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
1206 <td class="xdocLabelRight"></td>
1207 </tr></table>
1208 <div class="xdocSynMdcl">
1209 <div class="xdocSynCode">
1210 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> NotifyDriverCirc.<span class="xdoc-id">Params</span>;
1211 </div>
1212 <div class="xdocSynCode">
1213 <tt></tt><tt></tt><b> ...</b>
1214 </div>
1215 <div class="xdocSynCode">
1216 <tt></tt><tt></tt>params.<span class="xdoc-id">cacheEnabled</span> = <i><span class="xdoc-kw2">Bool</span></i> <span class="xdoc-kw2">true</span>;
1217 </div>
1218 </div>
1219 <div class="xdocSynSpacer"> </div>
1220 <span id="xdoc-sect-1"></span>
1221 <div class="xdocSect">DETAILS</div>
1222 <div class="xdocText">If it is known that no cache operations are needed for this instance
1223 set this flag to FALSE. If <a class="xdoc-link" href="NotifyDriverCirc.html#shared.Addr" title="sharedAddr">sharedAddr</a> lies within a shared
1224 region and the cache enabled setting for the region is FALSE,
1225 then the value specified here will be overriden to FALSE.</div>
1226 <div class="xdocSect">C SYNOPSIS</div>
1227 <div class="xdocText"><a class="xdoc-link" href="#cache.Enabled" title="NotifyDriverCirc_Params.cacheEnabled">NotifyDriverCirc_Params.cacheEnabled</a></div>
1228 <div class="xdocSynSpacer"> </div>
1229 <a class="xdocAnchor" id="metacache.Line.Size"></a>
1230 <table class="xdocHdr"><tr>
1231 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifyDriverCirc.Params.</span><span class="xdoc-id">cacheLineSize</span> <small><span class="xdocSynSum">// instance</span></small></td>
1232 <td class="xdocHdrArrow">
1233 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
1234 </table>
1235 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#cache.Line.Size">index URL</a></div>
1236 <p class="xdocHdrSummaryDcl">The cache line size of the shared memory</p>
1237 <span id='meta-synop'></span>
1238 <table class="xdocLabel"><tr>
1239 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
1240 <td class="xdocLabelRight"></td>
1241 </tr></table>
1242 <div class="xdocSynMdcl">
1243 <div class="xdocSynCode">
1244 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> NotifyDriverCirc.<span class="xdoc-id">Params</span>;
1245 </div>
1246 <div class="xdocSynCode">
1247 <tt></tt><tt></tt><b> ...</b>
1248 </div>
1249 <div class="xdocSynCode">
1250 <tt></tt><tt></tt>params.<span class="xdoc-id">cacheLineSize</span> = <i><span class="xdoc-kw2">SizeT</span></i> 128;
1251 </div>
1252 </div>
1253 <div class="xdocSynSpacer"> </div>
1254 <span id="xdoc-sect-1"></span>
1255 <div class="xdocSect">DETAILS</div>
1256 <div class="xdocText">This value should be configured</div>
1257 <div class="xdocSect">C SYNOPSIS</div>
1258 <div class="xdocText"><a class="xdoc-link" href="#cache.Line.Size" title="NotifyDriverCirc_Params.cacheLineSize">NotifyDriverCirc_Params.cacheLineSize</a></div>
1259 <div class="xdocSynSpacer"> </div>
1260 <a class="xdocAnchor" id="metaint.Vector.Id"></a>
1261 <table class="xdocHdr"><tr>
1262 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifyDriverCirc.Params.</span><span class="xdoc-id">intVectorId</span> <small><span class="xdocSynSum">// instance</span></small></td>
1263 <td class="xdocHdrArrow">
1264 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
1265 </table>
1266 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#int.Vector.Id">index URL</a></div>
1267 <p class="xdocHdrSummaryDcl">Interrupt vector ID to be used by the driver</p>
1268 <span id='meta-synop'></span>
1269 <table class="xdocLabel"><tr>
1270 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
1271 <td class="xdocLabelRight"></td>
1272 </tr></table>
1273 <div class="xdocSynMdcl">
1274 <div class="xdocSynCode">
1275 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> NotifyDriverCirc.<span class="xdoc-id">Params</span>;
1276 </div>
1277 <div class="xdocSynCode">
1278 <tt></tt><tt></tt><b> ...</b>
1279 </div>
1280 <div class="xdocSynCode">
1281 <tt></tt><tt></tt>params.<span class="xdoc-id">intVectorId</span> = <i><span class="xdoc-kw2">UInt</span></i> ~1u;
1282 </div>
1283 </div>
1284 <div class="xdocSynSpacer"> </div>
1285 <span id="xdoc-sect-1"></span>
1286 <div class="xdocSect">DETAILS</div>
1287 <div class="xdocText">This parameter is only used by C64x+ targets</div>
1288 <div class="xdocSect">C SYNOPSIS</div>
1289 <div class="xdocText"><a class="xdoc-link" href="#int.Vector.Id" title="NotifyDriverCirc_Params.intVectorId">NotifyDriverCirc_Params.intVectorId</a></div>
1290 <div class="xdocSynSpacer"> </div>
1291 <a class="xdocAnchor" id="metalocal.Int.Id"></a>
1292 <table class="xdocHdr"><tr>
1293 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifyDriverCirc.Params.</span><span class="xdoc-id">localIntId</span> <small><span class="xdocSynSum">// instance</span></small></td>
1294 <td class="xdocHdrArrow">
1295 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
1296 </table>
1297 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#local.Int.Id">index URL</a></div>
1298 <p class="xdocHdrSummaryDcl">Local interrupt ID for interrupt line</p>
1299 <span id='meta-synop'></span>
1300 <table class="xdocLabel"><tr>
1301 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
1302 <td class="xdocLabelRight"></td>
1303 </tr></table>
1304 <div class="xdocSynMdcl">
1305 <div class="xdocSynCode">
1306 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> NotifyDriverCirc.<span class="xdoc-id">Params</span>;
1307 </div>
1308 <div class="xdocSynCode">
1309 <tt></tt><tt></tt><b> ...</b>
1310 </div>
1311 <div class="xdocSynCode">
1312 <tt></tt><tt></tt>params.<span class="xdoc-id">localIntId</span> = <i><span class="xdoc-kw2">UInt</span></i> -1u;
1313 </div>
1314 </div>
1315 <div class="xdocSynSpacer"> </div>
1316 <span id="xdoc-sect-1"></span>
1317 <div class="xdocSect">DETAILS</div>
1318 <div class="xdocText">For devices that support multiple inter-processor interrupt lines, this
1319 configuration parameter allows selecting a specific line to use for
1320 receiving an interrupt. The value specified here corresponds to the
1321 incoming interrupt line on the local processor.</div>
1322 <div class="xdocText">If this configuration is not set, a default interrupt id is
1323 typically chosen.</div>
1324 <div class="xdocSect">C SYNOPSIS</div>
1325 <div class="xdocText"><a class="xdoc-link" href="#local.Int.Id" title="NotifyDriverCirc_Params.localIntId">NotifyDriverCirc_Params.localIntId</a></div>
1326 <div class="xdocSynSpacer"> </div>
1327 <a class="xdocAnchor" id="metaremote.Int.Id"></a>
1328 <table class="xdocHdr"><tr>
1329 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifyDriverCirc.Params.</span><span class="xdoc-id">remoteIntId</span> <small><span class="xdocSynSum">// instance</span></small></td>
1330 <td class="xdocHdrArrow">
1331 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
1332 </table>
1333 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#remote.Int.Id">index URL</a></div>
1334 <p class="xdocHdrSummaryDcl">Remote interrupt ID for interrupt line</p>
1335 <span id='meta-synop'></span>
1336 <table class="xdocLabel"><tr>
1337 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
1338 <td class="xdocLabelRight"></td>
1339 </tr></table>
1340 <div class="xdocSynMdcl">
1341 <div class="xdocSynCode">
1342 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> NotifyDriverCirc.<span class="xdoc-id">Params</span>;
1343 </div>
1344 <div class="xdocSynCode">
1345 <tt></tt><tt></tt><b> ...</b>
1346 </div>
1347 <div class="xdocSynCode">
1348 <tt></tt><tt></tt>params.<span class="xdoc-id">remoteIntId</span> = <i><span class="xdoc-kw2">UInt</span></i> -1u;
1349 </div>
1350 </div>
1351 <div class="xdocSynSpacer"> </div>
1352 <span id="xdoc-sect-1"></span>
1353 <div class="xdocSect">DETAILS</div>
1354 <div class="xdocText">For devices that support multiple inter-processor interrupt lines, this
1355 configuration parameter allows selecting a specific line to use for
1356 receiving an interrupt. The value specified here corresponds to the
1357 incoming interrupt line on the remote processor.</div>
1358 <div class="xdocText">If this configuration is not set, a default interrupt id is
1359 typically chosen.</div>
1360 <div class="xdocSect">C SYNOPSIS</div>
1361 <div class="xdocText"><a class="xdoc-link" href="#remote.Int.Id" title="NotifyDriverCirc_Params.remoteIntId">NotifyDriverCirc_Params.remoteIntId</a></div>
1362 <div class="xdocSynSpacer"> </div>
1363 <a class="xdocAnchor" id="metaremote.Proc.Id"></a>
1364 <table class="xdocHdr"><tr>
1365 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifyDriverCirc.Params.</span><span class="xdoc-id">remoteProcId</span> <small><span class="xdocSynSum">// instance</span></small></td>
1366 <td class="xdocHdrArrow">
1367 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
1368 </table>
1369 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#remote.Proc.Id">index URL</a></div>
1370 <p class="xdocHdrSummaryDcl">The MultiProc ID corresponding to the remote processor</p>
1371 <span id='meta-synop'></span>
1372 <table class="xdocLabel"><tr>
1373 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
1374 <td class="xdocLabelRight"></td>
1375 </tr></table>
1376 <div class="xdocSynMdcl">
1377 <div class="xdocSynCode">
1378 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> NotifyDriverCirc.<span class="xdoc-id">Params</span>;
1379 </div>
1380 <div class="xdocSynCode">
1381 <tt></tt><tt></tt><b> ...</b>
1382 </div>
1383 <div class="xdocSynCode">
1384 <tt></tt><tt></tt>params.<span class="xdoc-id">remoteProcId</span> = <i><span class="xdoc-kw2">UInt16</span></i> <a class="xdoc-link" href="../../../../ti/sdo/utils/MultiProc.html#.I.N.V.A.L.I.D.I.D" title="ti.sdo.utils.MultiProc.INVALIDID">MultiProc.INVALIDID</a>;
1385 </div>
1386 </div>
1387 <div class="xdocSynSpacer"> </div>
1388 <span id="xdoc-sect-1"></span>
1389 <div class="xdocSect">DETAILS</div>
1390 <div class="xdocText">This parameter must be set for every device. The
1391 MultiProc_getId call can be used to obtain
1392 a MultiProc id given the remote processor's name.</div>
1393 <div class="xdocSect">C SYNOPSIS</div>
1394 <div class="xdocText"><a class="xdoc-link" href="#remote.Proc.Id" title="NotifyDriverCirc_Params.remoteProcId">NotifyDriverCirc_Params.remoteProcId</a></div>
1395 <div class="xdocSynSpacer"> </div>
1396 <a class="xdocAnchor" id="metashared.Addr"></a>
1397 <table class="xdocHdr"><tr>
1398 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifyDriverCirc.Params.</span><span class="xdoc-id">sharedAddr</span> <small><span class="xdocSynSum">// instance</span></small></td>
1399 <td class="xdocHdrArrow">
1400 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html" title="module NotifyDriverCirc"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
1401 </table>
1402 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/notifyDrivers/NotifyDriverCirc.html#shared.Addr">index URL</a></div>
1403 <p class="xdocHdrSummaryDcl">Address in shared memory where this instance will be placed</p>
1404 <span id='meta-synop'></span>
1405 <table class="xdocLabel"><tr>
1406 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
1407 <td class="xdocLabelRight"></td>
1408 </tr></table>
1409 <div class="xdocSynMdcl">
1410 <div class="xdocSynCode">
1411 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> NotifyDriverCirc.<span class="xdoc-id">Params</span>;
1412 </div>
1413 <div class="xdocSynCode">
1414 <tt></tt><tt></tt><b> ...</b>
1415 </div>
1416 <div class="xdocSynCode">
1417 <tt></tt><tt></tt>params.<span class="xdoc-id">sharedAddr</span> = <i><span class="xdoc-kw2">Ptr</span></i> <span class="xdoc-kw2">null</span>;
1418 </div>
1419 </div>
1420 <div class="xdocSynSpacer"> </div>
1421 <span id="xdoc-sect-1"></span>
1422 <div class="xdocSect">DETAILS</div>
1423 <div class="xdocText">Use <a class="xdoc-link" href="NotifyDriverCirc.html#shared.Mem.Req" title="sharedMemReq">sharedMemReq</a> to determine the amount of shared memory
1424 required.</div>
1425 <div class="xdocSect">C SYNOPSIS</div>
1426 <div class="xdocText"><a class="xdoc-link" href="#shared.Addr" title="NotifyDriverCirc_Params.sharedAddr">NotifyDriverCirc_Params.sharedAddr</a></div>
1427 </div>
1428 <div id="xdocDate">generated on Mon, 23 May 2016 14:31:21 GMT</div>
1429 </div></div></body>
1430 </html>