[processor-sdk/performance-audio-sr.git] / processor_audio_sdk_1_00_00_00 / psdk_cust / ipc_3_43_00_00_eng / docs / cdoc / ti / sdo / ipc / family / c6a8149 / NotifyDriverMbx.html
1 <html>
2 <head>
3 <title>module ti.sdo.ipc.family.c6a8149.NotifyDriverMbx</title>
4 <meta name="description" content="A TI81xx hardware mailbox based driver 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.family.c6a8149.</span><span class="xdoc-id">NotifyDriverMbx</span></td>
10 <td class="xdocHdrArrow">
11 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyCircSetup.html" title="module NotifyCircSetup"><img class="xdocHdrArrow" src="../../../../../Arrow_left.png"/></a></td>
12 <td class="xdocHdrArrow">
13 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c6a8149/package.html" title="package ti.sdo.ipc.family.c6a8149"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
14 <td class="xdocHdrArrow">
15 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyMbxSetup.html" title="module NotifyMbxSetup"><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/family/c6a8149/NotifyDriverMbx.html">index URL</a></div>
18 <p class="xdocHdrSummary">A TI81xx hardware mailbox based driver 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 uses hardware mailboxes to
27 transmit notifications to remote processors.
28 [ <a class="xdocBrief" href="#xdoc-desc">more</a> ... ]
29 </div>
30 <span id='targ-synop'></span>
31 <table class="xdocLabel"><tr>
32 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2">C</span></tt> synopsis</td>
33 <td class="xdocLabelCenter">target-domain</td>
34 <td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx-src.html"><span class="xdocLabelFile">ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.xdc</span></a></td>
35 </tr></table>
36 <div class="xdocSynT">
37 <div class="xdocSynCode">
38 <tt></tt><span class="xdoc-kw3">#include</span> <span class="xdoc-id"><ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.h></span>
39 </div>
40 <table cellspacing="0" cellpadding="0" border="0">
41 <tr><td colspan='2'><div class='xdocSynTblHdr'>Functions</div></td></tr>
43 <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">NotifyDriverMbx_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/family/c6a8149/NotifyDriverMbx.html#per-instance_config_parameters" title="ti.sdo.ipc.family.c6a8149.NotifyDriverMbx.Params">NotifyDriverMbx_Params</a> *params);</div></td></tr>
44 <tr><td colspan="2"><div class="xdocSynFxnCat">Functions common to all INotifyDriver modules</div></td></tr>
46 <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">NotifyDriverMbx_disable</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Disable a NotifyDriver instance</span></span></a>(<a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#per-instance_object_types" title="ti.sdo.ipc.family.c6a8149.NotifyDriverMbx.Handle">NotifyDriverMbx_Handle</a> handle);</div></td></tr>
47 <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">NotifyDriverMbx_disableEvent</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Disable an event</span></span></a>(<a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#per-instance_object_types" title="ti.sdo.ipc.family.c6a8149.NotifyDriverMbx.Handle">NotifyDriverMbx_Handle</a> handle, <span class="xdoc-kw2">UInt32</span> <span class="xdoc-id">eventId</span>);</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="#enable"><span class="xdoc-id">NotifyDriverMbx_enable</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Enable a NotifyDriver instance</span></span></a>(<a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#per-instance_object_types" title="ti.sdo.ipc.family.c6a8149.NotifyDriverMbx.Handle">NotifyDriverMbx_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="#enable.Event"><span class="xdoc-id">NotifyDriverMbx_enableEvent</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Enable an event</span></span></a>(<a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#per-instance_object_types" title="ti.sdo.ipc.family.c6a8149.NotifyDriverMbx.Handle">NotifyDriverMbx_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="#register.Event"><span class="xdoc-id">NotifyDriverMbx_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/family/c6a8149/NotifyDriverMbx.html#per-instance_object_types" title="ti.sdo.ipc.family.c6a8149.NotifyDriverMbx.Handle">NotifyDriverMbx_Handle</a> handle, <span class="xdoc-kw2">UInt32</span> <span class="xdoc-id">eventId</span>);</div></td></tr>
51 <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">NotifyDriverMbx_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/family/c6a8149/NotifyDriverMbx.html#per-instance_object_types" title="ti.sdo.ipc.family.c6a8149.NotifyDriverMbx.Handle">NotifyDriverMbx_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>
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="#unregister.Event"><span class="xdoc-id">NotifyDriverMbx_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/family/c6a8149/NotifyDriverMbx.html#per-instance_object_types" title="ti.sdo.ipc.family.c6a8149.NotifyDriverMbx.Handle">NotifyDriverMbx_Handle</a> handle, <span class="xdoc-kw2">UInt32</span> <span class="xdoc-id">eventId</span>);</div></td></tr>
53 <tr><td class="xdocSynFxnCat" colspan="2"><div class="xdocSynFxnCat">Functions common to all target instances</div></td></tr>
55 <tr>
56 <td></td>
57 <td>
58 <div class="xdocSynTblPack">
59 <a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">NotifyDriverMbx_handle</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Convert this instance structure pointer into an instance handle</span></span></a>,
60 <a class="xdocSynGo" href="#per-instance_convertors"><span class="xdoc-id">NotifyDriverMbx_Handle_downCast</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// conditionally move one level down the inheritance hierarchy; NULL upon failure</span></span></a>,
61 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">NotifyDriverMbx_Handle_label</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The label associated with this instance object</span></span></a>,
62 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">NotifyDriverMbx_Handle_name</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The name of this instance object</span></span></a>,
63 <a class="xdocSynGo" href="#per-instance_convertors"><span class="xdoc-id">NotifyDriverMbx_Handle_upCast</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// unconditionally move one level up the inheritance hierarchy</span></span></a>,
64 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">NotifyDriverMbx_Object_count</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The number of statically-created instance objects</span></span></a>,
65 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">NotifyDriverMbx_Object_first</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The handle of the first dynamically-created instance object, or NULL</span></span></a>,
66 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">NotifyDriverMbx_Object_get</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The handle of the i-th statically-created instance object (array == NULL)</span></span></a>,
67 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">NotifyDriverMbx_Object_heap</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The heap used to allocate dynamically-created instance objects</span></span></a>,
68 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">NotifyDriverMbx_Object_next</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The handle of the next dynamically-created instance object, or NULL</span></span></a>,
69 <a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">NotifyDriverMbx_struct</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Convert this instance handle into an instance structure pointer</span></span></a>
70 </div>
71 </td>
72 </tr>
73 <tr><td class="xdocSynFxnCat" colspan="2"><div class="xdocSynFxnCat">Functions common to all target modules</div></td></tr>
75 <tr>
76 <td></td>
77 <td>
78 <div class="xdocSynTblPack">
79 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">NotifyDriverMbx_Module_getMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Returns the diagnostics mask for this module</span></span></a>,
80 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">NotifyDriverMbx_Module_hasMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Test whether this module has a diagnostics mask</span></span></a>,
81 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">NotifyDriverMbx_Module_heap</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The heap from which this module allocates memory</span></span></a>,
82 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">NotifyDriverMbx_Module_id</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Get this module's unique id</span></span></a>,
83 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">NotifyDriverMbx_Module_setMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Set the diagnostics mask for this module</span></span></a>,
84 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">NotifyDriverMbx_Module_startupDone</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Test if this module has completed startup</span></span></a>
85 </div>
86 </td>
87 </tr>
88 <tr><td colspan='2'><div class='xdocSynTblHdr'>Typedefs</div></td></tr>
90 <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/family/c6a8149/NotifyDriverMbx.html#per-instance_object_types" title="ti.sdo.ipc.family.c6a8149.NotifyDriverMbx.Object">NotifyDriverMbx_Object</a> *</div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">NotifyDriverMbx_Handle</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Client reference to an instance object</span></span></a>;</div></td></tr>
91 <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">NotifyDriverMbx_Object</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Opaque internal representation of an instance object</span></span></a> <span class="xdoc-id">NotifyDriverMbx_Object</span>;</div></td></tr>
92 <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">NotifyDriverMbx_Params</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Instance config-params structure</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">NotifyDriverMbx_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">NotifyDriverMbx_Struct</span>;</div></td></tr>
94 <tr><td colspan='2'><div class='xdocSynTblHdr'>Constants</div></td></tr>
96 <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">NotifyDriverMbx_A_notSupported</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert raised when trying to use Notify_[enable/disable]Event with
97 NotifyDriverMbx</span></span></a>;</div></td></tr>
98 <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="#int.Vector.Id"><span class="xdoc-id">NotifyDriverMbx_intVectorId</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Interrupt vector ID to be used by the driver</span></span></a>;</div></td></tr>
99 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">extern const</span> <span class="xdoc-kw2">UInt32</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#mailbox.Base.Addr"><span class="xdoc-id">NotifyDriverMbx_mailboxBaseAddr</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Base address for the Mailbox subsystem</span></span></a>;</div></td></tr>
100 </table>
101 <div class="xdocSynSpacer"> </div>
102 </div>
103 <span id="xdoc-desc"></span>
104 <span id="xdoc-sect-1"></span>
105 <div class="xdocSect">DETAILS</div>
106 <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 uses hardware mailboxes to
107 transmit notifications to remote processors.</div>
108 <div class="xdocText">Unlike the Notify drivers available in the <a class="xdoc-link" href="../../../../../ti/sdo/ipc/notifyDrivers/package.html" title="ti.sdo.ipc.notifyDrivers">ti.sdo.ipc.notifyDrivers</a>
109 package, this driver is not generic and will only work with the TI81xx
110 family of devices.</div>
111 <div class="xdocText">The driver uses no shared memory since the event IDs and payloads that
112 comprise notifications are transmitted via the hardware mailbox FIFO. The
113 FIFO can hold up to 4 mailbox messages. The number of notification that can
114 be stored in the FIFO depends on the sizes of the payloads being sent via
115 Notify_sendEvent. If the payload is less than 0x7FFFFFF, then a single
116 message will be sent per notification. Otherwise, if the payload is greater
117 than or equal to 0x7FFFFFF, two mailbox messages are needed to send the
118 notification.</div>
119 <div class="xdocText">The behavior of Notify_sendEvent when the FIFO is full depends on the value
120 of the 'waitClear' argument to the function. If 'waitClear' is TRUE, then
121 Notify_sendEvent will spin waiting for enough room in the FIFO for the
122 notification before actually sending it. If 'waitClear' is FALSE, then
123 Notify_sendEvent will return Notify_E_FAIL if there isn't enough room in the
124 FIFO to store the notification.</div>
125 <div class="xdocText">The Notify_[enable/disable]Event APIs are not supported by this driver.</div>
126 <div id="xdocSep">
127 </div>
128 <div id="xdocElems">
129 <div class="xdocSynSpacer"> </div>
130 <a class="xdocAnchor" id=".A_not.Supported"></a>
131 <table class="xdocHdr"><tr>
132 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifyDriverMbx_</span><span class="xdoc-id">A_notSupported</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
133 <td class="xdocHdrArrow">
134 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html" title="module NotifyDriverMbx"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
135 </table>
136 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#.A_not.Supported">index URL</a></div>
137 <p class="xdocHdrSummaryDcl">Assert raised when trying to use Notify_[enable/disable]Event with
138 NotifyDriverMbx</p>
139 <span id='targ-synop'></span>
140 <table class="xdocLabel"><tr>
141 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
142 <td class="xdocLabelRight">target-domain</td>
143 </tr></table>
144 <div class="xdocSynTdcl">
145 <div class="xdocSynCode">
146 <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">NotifyDriverMbx_A_notSupported</span>;
147 </div>
148 </div>
149 <div class="xdocSynSpacer"> </div>
150 <div class="xdocSynSpacer"> </div>
151 <a class="xdocAnchor" id="int.Vector.Id"></a>
152 <table class="xdocHdr"><tr>
153 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifyDriverMbx_</span><span class="xdoc-id">intVectorId</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
154 <td class="xdocHdrArrow">
155 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html" title="module NotifyDriverMbx"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
156 </table>
157 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#int.Vector.Id">index URL</a></div>
158 <p class="xdocHdrSummaryDcl">Interrupt vector ID to be used by the driver</p>
159 <span id='targ-synop'></span>
160 <table class="xdocLabel"><tr>
161 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
162 <td class="xdocLabelRight">target-domain</td>
163 </tr></table>
164 <div class="xdocSynTdcl">
165 <div class="xdocSynCode">
166 <tt></tt><tt></tt><span class="xdoc-kw1">extern const</span> <span class="xdoc-kw2">UInt</span> <span class="xdoc-id">NotifyDriverMbx_intVectorId</span>;
167 </div>
168 </div>
169 <div class="xdocSynSpacer"> </div>
170 <span id="xdoc-sect-1"></span>
171 <div class="xdocSect">DETAILS</div>
172 <div class="xdocText">This parameter is only used by the DSP core</div>
173 <div class="xdocSynSpacer"> </div>
174 <a class="xdocAnchor" id="mailbox.Base.Addr"></a>
175 <table class="xdocHdr"><tr>
176 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifyDriverMbx_</span><span class="xdoc-id">mailboxBaseAddr</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
177 <td class="xdocHdrArrow">
178 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html" title="module NotifyDriverMbx"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
179 </table>
180 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#mailbox.Base.Addr">index URL</a></div>
181 <p class="xdocHdrSummaryDcl">Base address for the Mailbox subsystem</p>
182 <span id='targ-synop'></span>
183 <table class="xdocLabel"><tr>
184 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
185 <td class="xdocLabelRight">target-domain</td>
186 </tr></table>
187 <div class="xdocSynTdcl">
188 <div class="xdocSynCode">
189 <tt></tt><tt></tt><span class="xdoc-kw1">extern const</span> <span class="xdoc-kw2">UInt32</span> <span class="xdoc-id">NotifyDriverMbx_mailboxBaseAddr</span>;
190 </div>
191 </div>
192 <div class="xdocSynSpacer"> </div>
193 <a class="xdocAnchor" id="module-wide_built-ins"></a>
194 <table class="xdocHdr"><tr>
195 <td class="xdocHdrTitle"><span class="xdocSynSum">Module-Wide Built-Ins</span></td>
196 <td class="xdocHdrArrow">
197 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html" title="module NotifyDriverMbx"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
198 </table>
199 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#module-wide_built-ins">index URL</a></div>
200 <p class="xdocHdrSummary"></p>
201 <span id='targ-synop'></span>
202 <table class="xdocLabel"><tr>
203 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
204 <td class="xdocLabelRight">target-domain</td>
205 </tr></table>
206 <div class="xdocSynTdcl">
207 <div class="xdocSynCode">
208 <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">NotifyDriverMbx_Module_id</span>();
209 </div>
210 <div class='xdocSynSum'><tt></tt><tt></tt>// Get this module's unique id</div>
211 <div class="xdocSynSpacer"> </div>
212 <div class="xdocSynCode">
213 <tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">NotifyDriverMbx_Module_startupDone</span>();
214 </div>
215 <div class='xdocSynSum'><tt></tt><tt></tt>// Test if this module has completed startup</div>
216 <div class="xdocSynSpacer"> </div>
217 <div class="xdocSynCode">
218 <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">NotifyDriverMbx_Module_heap</span>();
219 </div>
220 <div class='xdocSynSum'><tt></tt><tt></tt>// The heap from which this module allocates memory</div>
221 <div class="xdocSynSpacer"> </div>
222 <div class="xdocSynCode">
223 <tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">NotifyDriverMbx_Module_hasMask</span>();
224 </div>
225 <div class='xdocSynSum'><tt></tt><tt></tt>// Test whether this module has a diagnostics mask</div>
226 <div class="xdocSynSpacer"> </div>
227 <div class="xdocSynCode">
228 <tt></tt><tt></tt><span class="xdoc-kw2">Bits16</span> <span class="xdoc-id">NotifyDriverMbx_Module_getMask</span>();
229 </div>
230 <div class='xdocSynSum'><tt></tt><tt></tt>// Returns the diagnostics mask for this module</div>
231 <div class="xdocSynSpacer"> </div>
232 <div class="xdocSynCode">
233 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">NotifyDriverMbx_Module_setMask</span>(<span class="xdoc-kw2">Bits16</span> <span class="xdoc-id">mask</span>);
234 </div>
235 <div class='xdocSynSum'><tt></tt><tt></tt>// Set the diagnostics mask for this module</div>
236 </div>
237 <a class="xdocAnchor" id="per-instance_object_types"></a>
238 <table class="xdocHdr"><tr>
239 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Object Types</span></td>
240 <td class="xdocHdrArrow">
241 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html" title="module NotifyDriverMbx"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
242 </table>
243 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#per-instance_object_types">index URL</a></div>
244 <p class="xdocHdrSummary"></p>
245 <span id='targ-synop'></span>
246 <table class="xdocLabel"><tr>
247 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
248 <td class="xdocLabelRight">target-domain</td>
249 </tr></table>
250 <div class="xdocSynTdcl">
251 <div class="xdocSynCode">
252 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">NotifyDriverMbx_Object</span> <span class="xdoc-id">NotifyDriverMbx_Object</span>;
253 </div>
254 <div class='xdocSynSum'><tt></tt><tt></tt>// Opaque internal representation of an instance object</div>
255 <div class="xdocSynSpacer"> </div>
256 <div class="xdocSynCode">
257 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#per-instance_object_types" title="ti.sdo.ipc.family.c6a8149.NotifyDriverMbx.Object">NotifyDriverMbx_Object</a> *<span class="xdoc-id">NotifyDriverMbx_Handle</span>;
258 </div>
259 <div class='xdocSynSum'><tt></tt><tt></tt>// Client reference to an instance object</div>
260 <div class="xdocSynSpacer"> </div>
261 <div class="xdocSynCode">
262 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">NotifyDriverMbx_Struct</span> <span class="xdoc-id">NotifyDriverMbx_Struct</span>;
263 </div>
264 <div class='xdocSynSum'><tt></tt><tt></tt>// Opaque client structure large enough to hold an instance object</div>
265 <div class="xdocSynSpacer"> </div>
266 <div class="xdocSynCode">
267 <tt></tt><tt></tt><a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#per-instance_object_types" title="ti.sdo.ipc.family.c6a8149.NotifyDriverMbx.Handle">NotifyDriverMbx_Handle</a> <span class="xdoc-id">NotifyDriverMbx_handle</span>(<a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#per-instance_object_types" title="ti.sdo.ipc.family.c6a8149.NotifyDriverMbx.Struct">NotifyDriverMbx_Struct</a> *structP);
268 </div>
269 <div class='xdocSynSum'><tt></tt><tt></tt>// Convert this instance structure pointer into an instance handle</div>
270 <div class="xdocSynSpacer"> </div>
271 <div class="xdocSynCode">
272 <tt></tt><tt></tt><a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#per-instance_object_types" title="ti.sdo.ipc.family.c6a8149.NotifyDriverMbx.Struct">NotifyDriverMbx_Struct</a> *<span class="xdoc-id">NotifyDriverMbx_struct</span>(<a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#per-instance_object_types" title="ti.sdo.ipc.family.c6a8149.NotifyDriverMbx.Handle">NotifyDriverMbx_Handle</a> handle);
273 </div>
274 <div class='xdocSynSum'><tt></tt><tt></tt>// Convert this instance handle into an instance structure pointer</div>
275 </div>
276 <a class="xdocAnchor" id="per-instance_config_parameters"></a>
277 <table class="xdocHdr"><tr>
278 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Config Parameters</span></td>
279 <td class="xdocHdrArrow">
280 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html" title="module NotifyDriverMbx"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
281 </table>
282 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#per-instance_config_parameters">index URL</a></div>
283 <p class="xdocHdrSummary"></p>
284 <span id='targ-synop'></span>
285 <table class="xdocLabel"><tr>
286 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
287 <td class="xdocLabelRight">target-domain</td>
288 </tr></table>
289 <div class="xdocSynTdcl">
290 <div class="xdocSynCode">
291 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">NotifyDriverMbx_Params</span> {
292 </div>
293 <div class='xdocSynSum'><tt></tt><tt></tt>// Instance config-params structure</div>
294 <div class="xdocSynCode">
295 <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;
296 </div>
297 <div class='xdocSynSum'><tt></tt><tt> </tt>// Common per-instance configs</div>
298 <div class="xdocSynCode">
299 <tt></tt><tt> </tt><span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>;
300 </div>
301 <div class='xdocSynSum'><tt></tt><tt> </tt>// The MultiProc ID corresponding to the remote processor</div>
302 <div class="xdocSynCode">
303 <tt></tt><tt></tt>} <span class="xdoc-id">NotifyDriverMbx_Params</span>;
304 </div>
305 <div class="xdocSynSpacer"> </div>
306 <div class="xdocSynCode">
307 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">NotifyDriverMbx_Params_init</span>(<a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#per-instance_config_parameters" title="ti.sdo.ipc.family.c6a8149.NotifyDriverMbx.Params">NotifyDriverMbx_Params</a> *params);
308 </div>
309 <div class='xdocSynSum'><tt></tt><tt></tt>// Initialize this config-params structure with supplier-specified defaults before instance creation</div>
310 </div>
311 <div class="xdocSynSpacer"> </div>
312 <a class="xdocAnchor" id="remote.Proc.Id"></a>
313 <table class="xdocHdr"><tr>
314 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifyDriverMbx_Params.</span><span class="xdoc-id">remoteProcId</span> <small><span class="xdocSynSum">// instance</span></small></td>
315 <td class="xdocHdrArrow">
316 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html" title="module NotifyDriverMbx"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
317 </table>
318 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#remote.Proc.Id">index URL</a></div>
319 <p class="xdocHdrSummaryDcl">The MultiProc ID corresponding to the remote processor</p>
320 <span id='targ-synop'></span>
321 <table class="xdocLabel"><tr>
322 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
323 <td class="xdocLabelRight">target-domain</td>
324 </tr></table>
325 <div class="xdocSynTdcl">
326 <div class="xdocSynCode">
327 <tt></tt><tt></tt><span class="xdoc-kw1">struct</span> <a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#per-instance_config_parameters" title="ti.sdo.ipc.family.c6a8149.NotifyDriverMbx.Params">NotifyDriverMbx_Params</a> {
328 </div>
329 <div class="xdocSynCode">
330 <tt></tt><tt> </tt><b> ...</b>
331 </div>
332 <div class="xdocSynCode">
333 <tt></tt><tt> </tt><span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>;
334 </div>
335 </div>
336 <div class="xdocSynSpacer"> </div>
337 <div class="xdocSynSpacer"> </div>
338 <a class="xdocAnchor" id="disable"></a>
339 <table class="xdocHdr"><tr>
340 <td class="xdocHdrTitle"><span class="xdoc-id">NotifyDriverMbx_</span><span class="xdoc-id">disable</span>() <small><span class="xdocSynSum">// instance</span></small></td>
341 <td class="xdocHdrArrow">
342 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html" title="module NotifyDriverMbx"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
343 </table>
344 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#disable">index URL</a></div>
345 <p class="xdocHdrSummaryDcl">Disable a NotifyDriver instance</p>
346 <span id='targ-synop'></span>
347 <table class="xdocLabel"><tr>
348 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
349 <td class="xdocLabelRight">target-domain</td>
350 </tr></table>
351 <div class="xdocSynTdcl">
352 <div class="xdocSynCode">
353 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">NotifyDriverMbx_disable</span>(<a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#per-instance_object_types" title="ti.sdo.ipc.family.c6a8149.NotifyDriverMbx.Handle">NotifyDriverMbx_Handle</a> handle);
354 </div>
355 </div>
356 <div class="xdocSynSpacer"> </div>
357 <span id="xdoc-sect-1"></span>
358 <div class="xdocSect">ARGUMENTS</div>
359 <div class="xdocChild"><span class="xdocChildId">handle</span>
360 <span class="xdocChildSum">— handle of a previously-created <tt>NotifyDriverMbx</tt> instance object</span>
361 </div>
362 <span id="xdoc-sect-2"></span>
363 <div class="xdocSect">DETAILS</div>
364 <div class="xdocText">Disables the ability of a Notify driver to receive events for a given
365 processor. This interface function is called by the Notify_disable
366 function. Refer to its documentation for more details.</div>
367 <div class="xdocSynSpacer"> </div>
368 <a class="xdocAnchor" id="disable.Event"></a>
369 <table class="xdocHdr"><tr>
370 <td class="xdocHdrTitle"><span class="xdoc-id">NotifyDriverMbx_</span><span class="xdoc-id">disableEvent</span>() <small><span class="xdocSynSum">// instance</span></small></td>
371 <td class="xdocHdrArrow">
372 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html" title="module NotifyDriverMbx"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
373 </table>
374 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#disable.Event">index URL</a></div>
375 <p class="xdocHdrSummaryDcl">Disable an event</p>
376 <span id='targ-synop'></span>
377 <table class="xdocLabel"><tr>
378 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
379 <td class="xdocLabelRight">target-domain</td>
380 </tr></table>
381 <div class="xdocSynTdcl">
382 <div class="xdocSynCode">
383 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">NotifyDriverMbx_disableEvent</span>(<a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#per-instance_object_types" title="ti.sdo.ipc.family.c6a8149.NotifyDriverMbx.Handle">NotifyDriverMbx_Handle</a> handle, <span class="xdoc-kw2">UInt32</span> <span class="xdoc-id">eventId</span>);
384 </div>
385 </div>
386 <div class="xdocSynSpacer"> </div>
387 <span id="xdoc-sect-1"></span>
388 <div class="xdocSect">ARGUMENTS</div>
389 <div class="xdocChild"><span class="xdocChildId">handle</span>
390 <span class="xdocChildSum">— handle of a previously-created <tt>NotifyDriverMbx</tt> instance object</span>
391 </div>
392 <div class="xdocChild"><span class="xdocChildId">eventId</span>
393 <span class="xdocChildSum">— Number of event to disable</span>
394 </div>
395 <span id="xdoc-sect-2"></span>
396 <div class="xdocSect">DETAILS</div>
397 <div class="xdocText">This interface function is called by the Notify_disableEvent function.
398 Refer to its documentation for more details.</div>
399 <div class="xdocText">The Notify module does validation of the eventId. The Notify module
400 enters calls this function within the Notify module gate.</div>
401 <div class="xdocSynSpacer"> </div>
402 <a class="xdocAnchor" id="enable"></a>
403 <table class="xdocHdr"><tr>
404 <td class="xdocHdrTitle"><span class="xdoc-id">NotifyDriverMbx_</span><span class="xdoc-id">enable</span>() <small><span class="xdocSynSum">// instance</span></small></td>
405 <td class="xdocHdrArrow">
406 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html" title="module NotifyDriverMbx"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
407 </table>
408 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#enable">index URL</a></div>
409 <p class="xdocHdrSummaryDcl">Enable a NotifyDriver instance</p>
410 <span id='targ-synop'></span>
411 <table class="xdocLabel"><tr>
412 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
413 <td class="xdocLabelRight">target-domain</td>
414 </tr></table>
415 <div class="xdocSynTdcl">
416 <div class="xdocSynCode">
417 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">NotifyDriverMbx_enable</span>(<a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#per-instance_object_types" title="ti.sdo.ipc.family.c6a8149.NotifyDriverMbx.Handle">NotifyDriverMbx_Handle</a> handle);
418 </div>
419 </div>
420 <div class="xdocSynSpacer"> </div>
421 <span id="xdoc-sect-1"></span>
422 <div class="xdocSect">ARGUMENTS</div>
423 <div class="xdocChild"><span class="xdocChildId">handle</span>
424 <span class="xdocChildSum">— handle of a previously-created <tt>NotifyDriverMbx</tt> instance object</span>
425 </div>
426 <span id="xdoc-sect-2"></span>
427 <div class="xdocSect">DETAILS</div>
428 <div class="xdocText">Enables the ability of a Notify driver to receive events for a given
429 processor. This interface function is called by the Notify_restore
430 function. Refer to its documentation for more details.</div>
431 <div class="xdocSynSpacer"> </div>
432 <a class="xdocAnchor" id="enable.Event"></a>
433 <table class="xdocHdr"><tr>
434 <td class="xdocHdrTitle"><span class="xdoc-id">NotifyDriverMbx_</span><span class="xdoc-id">enableEvent</span>() <small><span class="xdocSynSum">// instance</span></small></td>
435 <td class="xdocHdrArrow">
436 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html" title="module NotifyDriverMbx"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
437 </table>
438 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#enable.Event">index URL</a></div>
439 <p class="xdocHdrSummaryDcl">Enable an event</p>
440 <span id='targ-synop'></span>
441 <table class="xdocLabel"><tr>
442 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
443 <td class="xdocLabelRight">target-domain</td>
444 </tr></table>
445 <div class="xdocSynTdcl">
446 <div class="xdocSynCode">
447 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">NotifyDriverMbx_enableEvent</span>(<a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#per-instance_object_types" title="ti.sdo.ipc.family.c6a8149.NotifyDriverMbx.Handle">NotifyDriverMbx_Handle</a> handle, <span class="xdoc-kw2">UInt32</span> <span class="xdoc-id">eventId</span>);
448 </div>
449 </div>
450 <div class="xdocSynSpacer"> </div>
451 <span id="xdoc-sect-1"></span>
452 <div class="xdocSect">ARGUMENTS</div>
453 <div class="xdocChild"><span class="xdocChildId">handle</span>
454 <span class="xdocChildSum">— handle of a previously-created <tt>NotifyDriverMbx</tt> instance object</span>
455 </div>
456 <div class="xdocChild"><span class="xdocChildId">eventId</span>
457 <span class="xdocChildSum">— Number of event to enable</span>
458 </div>
459 <span id="xdoc-sect-2"></span>
460 <div class="xdocSect">DETAILS</div>
461 <div class="xdocText">This interface function is called by the Notify_disableEvent function.
462 Refer to its documentation for more details.</div>
463 <div class="xdocText">The Notify module does validation of the eventId. The Notify module
464 enters calls this function within the Notify module gate.</div>
465 <div class="xdocSynSpacer"> </div>
466 <a class="xdocAnchor" id="register.Event"></a>
467 <table class="xdocHdr"><tr>
468 <td class="xdocHdrTitle"><span class="xdoc-id">NotifyDriverMbx_</span><span class="xdoc-id">registerEvent</span>() <small><span class="xdocSynSum">// instance</span></small></td>
469 <td class="xdocHdrArrow">
470 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html" title="module NotifyDriverMbx"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
471 </table>
472 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#register.Event">index URL</a></div>
473 <p class="xdocHdrSummaryDcl">Register a callback to an event</p>
474 <span id='targ-synop'></span>
475 <table class="xdocLabel"><tr>
476 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
477 <td class="xdocLabelRight">target-domain</td>
478 </tr></table>
479 <div class="xdocSynTdcl">
480 <div class="xdocSynCode">
481 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">NotifyDriverMbx_registerEvent</span>(<a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#per-instance_object_types" title="ti.sdo.ipc.family.c6a8149.NotifyDriverMbx.Handle">NotifyDriverMbx_Handle</a> handle, <span class="xdoc-kw2">UInt32</span> <span class="xdoc-id">eventId</span>);
482 </div>
483 </div>
484 <div class="xdocSynSpacer"> </div>
485 <span id="xdoc-sect-1"></span>
486 <div class="xdocSect">ARGUMENTS</div>
487 <div class="xdocChild"><span class="xdocChildId">handle</span>
488 <span class="xdocChildSum">— handle of a previously-created <tt>NotifyDriverMbx</tt> instance object</span>
489 </div>
490 <div class="xdocChild"><span class="xdocChildId">eventId</span>
491 <span class="xdocChildSum">— Number of event that is being registered</span>
492 </div>
493 <span id="xdoc-sect-2"></span>
494 <div class="xdocSect">DETAILS</div>
495 <div class="xdocText">This driver function is called by the Notify_registerEvent function
496 within the Notify module gate. Refer to its documentation for more
497 details.</div>
498 <div class="xdocSynSpacer"> </div>
499 <a class="xdocAnchor" id="send.Event"></a>
500 <table class="xdocHdr"><tr>
501 <td class="xdocHdrTitle"><span class="xdoc-id">NotifyDriverMbx_</span><span class="xdoc-id">sendEvent</span>() <small><span class="xdocSynSum">// instance</span></small></td>
502 <td class="xdocHdrArrow">
503 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html" title="module NotifyDriverMbx"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
504 </table>
505 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#send.Event">index URL</a></div>
506 <p class="xdocHdrSummaryDcl">Send a signal to an event</p>
507 <span id='targ-synop'></span>
508 <table class="xdocLabel"><tr>
509 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
510 <td class="xdocLabelRight">target-domain</td>
511 </tr></table>
512 <div class="xdocSynTdcl">
513 <div class="xdocSynCode">
514 <tt></tt><tt></tt><span class="xdoc-kw2">Int</span> <span class="xdoc-id">NotifyDriverMbx_sendEvent</span>(<a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#per-instance_object_types" title="ti.sdo.ipc.family.c6a8149.NotifyDriverMbx.Handle">NotifyDriverMbx_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>);
515 </div>
516 </div>
517 <div class="xdocSynSpacer"> </div>
518 <span id="xdoc-sect-1"></span>
519 <div class="xdocSect">ARGUMENTS</div>
520 <div class="xdocChild"><span class="xdocChildId">handle</span>
521 <span class="xdocChildSum">— handle of a previously-created <tt>NotifyDriverMbx</tt> instance object</span>
522 </div>
523 <div class="xdocChild"><span class="xdocChildId">eventId</span>
524 <span class="xdocChildSum">— Number of event to signal</span>
525 </div>
526 <div class="xdocChild"><span class="xdocChildId">payload</span>
527 <span class="xdocChildSum">— Payload (optional) to pass to callback function</span>
528 </div>
529 <div class="xdocChild"><span class="xdocChildId">waitClear</span>
530 <span class="xdocChildSum">— If TRUE, have the NotifyDriver wait for
531 acknowledgement back from the destination
532 processor.</span>
533 </div>
534 <span id="xdoc-sect-2"></span>
535 <div class="xdocSect">RETURNS</div>
536 <div class="xdocText">Notify status</div>
537 <span id="xdoc-sect-3"></span>
538 <div class="xdocSect">DETAILS</div>
539 <div class="xdocText">This interface function is called by the Notify_sendEvent function.
540 Notify_sendEvent does not provide any context protection for
541 INotifyDriver_sendEvent, so appropriate measures must be taken within
542 the driver itself.</div>
543 <div class="xdocSynSpacer"> </div>
544 <a class="xdocAnchor" id="unregister.Event"></a>
545 <table class="xdocHdr"><tr>
546 <td class="xdocHdrTitle"><span class="xdoc-id">NotifyDriverMbx_</span><span class="xdoc-id">unregisterEvent</span>() <small><span class="xdocSynSum">// instance</span></small></td>
547 <td class="xdocHdrArrow">
548 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html" title="module NotifyDriverMbx"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
549 </table>
550 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#unregister.Event">index URL</a></div>
551 <p class="xdocHdrSummaryDcl">Remove an event listener from an event</p>
552 <span id='targ-synop'></span>
553 <table class="xdocLabel"><tr>
554 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
555 <td class="xdocLabelRight">target-domain</td>
556 </tr></table>
557 <div class="xdocSynTdcl">
558 <div class="xdocSynCode">
559 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">NotifyDriverMbx_unregisterEvent</span>(<a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#per-instance_object_types" title="ti.sdo.ipc.family.c6a8149.NotifyDriverMbx.Handle">NotifyDriverMbx_Handle</a> handle, <span class="xdoc-kw2">UInt32</span> <span class="xdoc-id">eventId</span>);
560 </div>
561 </div>
562 <div class="xdocSynSpacer"> </div>
563 <span id="xdoc-sect-1"></span>
564 <div class="xdocSect">ARGUMENTS</div>
565 <div class="xdocChild"><span class="xdocChildId">handle</span>
566 <span class="xdocChildSum">— handle of a previously-created <tt>NotifyDriverMbx</tt> instance object</span>
567 </div>
568 <div class="xdocChild"><span class="xdocChildId">eventId</span>
569 <span class="xdocChildSum">— Number of event that is being unregistered</span>
570 </div>
571 <span id="xdoc-sect-2"></span>
572 <div class="xdocSect">DETAILS</div>
573 <div class="xdocText">This driver function is called by the Notify_unregisterEvent function
574 within the Notify module gate. Refer to it for more details.</div>
575 <a class="xdocAnchor" id="per-instance_convertors"></a>
576 <table class="xdocHdr"><tr>
577 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Convertors</span></td>
578 <td class="xdocHdrArrow">
579 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html" title="module NotifyDriverMbx"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
580 </table>
581 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#per-instance_convertors">index URL</a></div>
582 <p class="xdocHdrSummary"></p>
583 <span id='targ-synop'></span>
584 <table class="xdocLabel"><tr>
585 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
586 <td class="xdocLabelRight">target-domain</td>
587 </tr></table>
588 <div class="xdocSynTdcl">
589 <div class="xdocSynCode">
590 <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">NotifyDriverMbx_Handle_upCast</span>(<a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#per-instance_object_types" title="ti.sdo.ipc.family.c6a8149.NotifyDriverMbx.Handle">NotifyDriverMbx_Handle</a> handle);
591 </div>
592 <div class='xdocSynSum'><tt></tt><tt></tt>// unconditionally move one level up the inheritance hierarchy</div>
593 <div class="xdocSynSpacer"> </div>
594 <div class="xdocSynCode">
595 <tt></tt><tt></tt><a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#per-instance_object_types" title="ti.sdo.ipc.family.c6a8149.NotifyDriverMbx.Handle">NotifyDriverMbx_Handle</a> <span class="xdoc-id">NotifyDriverMbx_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);
596 </div>
597 <div class='xdocSynSum'><tt></tt><tt></tt>// conditionally move one level down the inheritance hierarchy; NULL upon failure</div>
598 </div>
599 <a class="xdocAnchor" id="per-instance_built-ins"></a>
600 <table class="xdocHdr"><tr>
601 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Built-Ins</span></td>
602 <td class="xdocHdrArrow">
603 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html" title="module NotifyDriverMbx"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
604 </table>
605 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#per-instance_built-ins">index URL</a></div>
606 <p class="xdocHdrSummary"></p>
607 <span id='targ-synop'></span>
608 <table class="xdocLabel"><tr>
609 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
610 <td class="xdocLabelRight">target-domain</td>
611 </tr></table>
612 <div class="xdocSynTdcl">
613 <div class="xdocSynCode">
614 <tt></tt><tt></tt><span class="xdoc-kw2">Int</span> <span class="xdoc-id">NotifyDriverMbx_Object_count</span>();
615 </div>
616 <div class='xdocSynSum'><tt></tt><tt></tt>// The number of statically-created instance objects</div>
617 <div class="xdocSynSpacer"> </div>
618 <div class="xdocSynCode">
619 <tt></tt><tt></tt><a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#per-instance_object_types" title="ti.sdo.ipc.family.c6a8149.NotifyDriverMbx.Handle">NotifyDriverMbx_Handle</a> <span class="xdoc-id">NotifyDriverMbx_Object_get</span>(<a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#per-instance_object_types" title="ti.sdo.ipc.family.c6a8149.NotifyDriverMbx.Object">NotifyDriverMbx_Object</a> *array, <span class="xdoc-kw2">Int</span> i);
620 </div>
621 <div class='xdocSynSum'><tt></tt><tt></tt>// The handle of the i-th statically-created instance object (array == NULL)</div>
622 <div class="xdocSynSpacer"> </div>
623 <div class="xdocSynCode">
624 <tt></tt><tt></tt><a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#per-instance_object_types" title="ti.sdo.ipc.family.c6a8149.NotifyDriverMbx.Handle">NotifyDriverMbx_Handle</a> <span class="xdoc-id">NotifyDriverMbx_Object_first</span>();
625 </div>
626 <div class='xdocSynSum'><tt></tt><tt></tt>// The handle of the first dynamically-created instance object, or NULL</div>
627 <div class="xdocSynSpacer"> </div>
628 <div class="xdocSynCode">
629 <tt></tt><tt></tt><a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#per-instance_object_types" title="ti.sdo.ipc.family.c6a8149.NotifyDriverMbx.Handle">NotifyDriverMbx_Handle</a> <span class="xdoc-id">NotifyDriverMbx_Object_next</span>(<a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#per-instance_object_types" title="ti.sdo.ipc.family.c6a8149.NotifyDriverMbx.Handle">NotifyDriverMbx_Handle</a> handle);
630 </div>
631 <div class='xdocSynSum'><tt></tt><tt></tt>// The handle of the next dynamically-created instance object, or NULL</div>
632 <div class="xdocSynSpacer"> </div>
633 <div class="xdocSynCode">
634 <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">NotifyDriverMbx_Object_heap</span>();
635 </div>
636 <div class='xdocSynSum'><tt></tt><tt></tt>// The heap used to allocate dynamically-created instance objects</div>
637 <div class="xdocSynSpacer"> </div>
638 <div class="xdocSynCode">
639 <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">NotifyDriverMbx_Handle_label</span>(<a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#per-instance_object_types" title="ti.sdo.ipc.family.c6a8149.NotifyDriverMbx.Handle">NotifyDriverMbx_Handle</a> handle, <a class="xdoc-link" href="../../../../../xdc/runtime/Types.html#.Label" title="xdc.runtime.Types.Label">Types_Label</a> *buf);
640 </div>
641 <div class='xdocSynSum'><tt></tt><tt></tt>// The label associated with this instance object</div>
642 <div class="xdocSynSpacer"> </div>
643 <div class="xdocSynCode">
644 <tt></tt><tt></tt><span class="xdoc-kw2">String</span> <span class="xdoc-id">NotifyDriverMbx_Handle_name</span>(<a class="xdoc-link" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#per-instance_object_types" title="ti.sdo.ipc.family.c6a8149.NotifyDriverMbx.Handle">NotifyDriverMbx_Handle</a> handle);
645 </div>
646 <div class='xdocSynSum'><tt></tt><tt></tt>// The name of this instance object</div>
647 </div>
648 </div>
649 <div class="xdocSynSpacer"> </div>
650 <span id='meta-synop'></span>
651 <table class="xdocLabel"><tr>
652 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2"></span></tt>Configuration settings</td>
653 <td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx-src.html"><span class="xdocLabelFile">ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.xdc</span></a></td>
654 </tr></table>
655 <div class="xdocSynM">
656 <div class="xdocSynCode">
657 <tt></tt><span class="xdoc-kw1">var</span> NotifyDriverMbx = <span class="xdoc-kw3">xdc.useModule</span>(<span class="xdoc-id">'ti.sdo.ipc.family.c6a8149.NotifyDriverMbx'</span>);
658 </div>
659 <div class='xdocSynHdr'>module-wide config parameters</div>
661 <div class="xdocSynCode">
662 <tt> </tt><tt></tt><a class="xdocSynGo" href="#meta.A_not.Supported">NotifyDriverMbx.<span class="xdoc-id">A_notSupported</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert raised when trying to use Notify_[enable/disable]Event with
663 NotifyDriverMbx</span></span></a> = <i><a class="xdoc-link" href="../../../../../xdc/runtime/Assert.html#.Desc" title="xdc.runtime.Assert.Desc">Assert.Desc</a></i> {
664 </div>
665 <div class="xdocSynCode">
666 <tt> </tt><tt> </tt>msg: "A_notSupported: [enable/disable]Event not supported by NotifyDriverMbx"
667 </div>
668 <div class="xdocSynCode">
669 <tt> </tt><tt></tt>};
670 </div>
671 <div class="xdocSynCode">
672 <tt> </tt><tt></tt><a class="xdocSynGo" href="#metaint.Vector.Id">NotifyDriverMbx.<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;
673 </div>
674 <div class="xdocSynCode">
675 <tt> </tt><tt></tt><a class="xdocSynGo" href="#metamailbox.Base.Addr">NotifyDriverMbx.<span class="xdoc-id">mailboxBaseAddr</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Base address for the Mailbox subsystem</span></span></a> = <i><span class="xdoc-kw2">UInt32</span></i> 0x480C8000;
676 </div>
677 <div class="xdocSynSpacer"> </div>
678 <div class="xdocSynCode">
679 <tt> </tt><tt></tt><a class="xdocSynGo" href="#common$">NotifyDriverMbx.<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>;
680 </div>
681 <div class="xdocSynCode">
682 <tt> </tt><tt></tt><a class="xdocSynGo" href="#rov.View.Info">NotifyDriverMbx.<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>;
683 </div>
684 <div class='xdocSynHdr'>per-instance config parameters</div>
686 <div class="xdocSynCode">
687 <tt> </tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> NotifyDriverMbx.<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>;
688 </div>
689 <div class="xdocSynCode">
690 <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>;
691 </div>
692 <div class="xdocSynSpacer"> </div>
693 </div>
694 <div id="xdocSep">
695 </div>
696 <div id="xdocMetaElems">
697 <div class="xdocSynSpacer"> </div>
698 <a class="xdocAnchor" id="meta.A_not.Supported"></a>
699 <table class="xdocHdr"><tr>
700 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifyDriverMbx.</span><span class="xdoc-id">A_notSupported</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
701 <td class="xdocHdrArrow">
702 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html" title="module NotifyDriverMbx"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
703 </table>
704 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#.A_not.Supported">index URL</a></div>
705 <p class="xdocHdrSummaryDcl">Assert raised when trying to use Notify_[enable/disable]Event with
706 NotifyDriverMbx</p>
707 <span id='meta-synop'></span>
708 <table class="xdocLabel"><tr>
709 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
710 <td class="xdocLabelRight"></td>
711 </tr></table>
712 <div class="xdocSynMdcl">
713 <div class="xdocSynCode">
714 <tt></tt><tt></tt>NotifyDriverMbx.<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> {
715 </div>
716 <div class="xdocSynCode">
717 <tt></tt><tt> </tt>msg: "A_notSupported: [enable/disable]Event not supported by NotifyDriverMbx"
718 </div>
719 <div class="xdocSynCode">
720 <tt></tt><tt></tt>};
721 </div>
722 </div>
723 <div class="xdocSynSpacer"> </div>
724 <div class="xdocSect">C SYNOPSIS</div>
725 <div class="xdocText"><a class="xdoc-link" href="#.A_not.Supported" title="NotifyDriverMbx_A_notSupported">NotifyDriverMbx_A_notSupported</a></div>
726 <div class="xdocSynSpacer"> </div>
727 <a class="xdocAnchor" id="metaint.Vector.Id"></a>
728 <table class="xdocHdr"><tr>
729 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifyDriverMbx.</span><span class="xdoc-id">intVectorId</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
730 <td class="xdocHdrArrow">
731 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html" title="module NotifyDriverMbx"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
732 </table>
733 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#int.Vector.Id">index URL</a></div>
734 <p class="xdocHdrSummaryDcl">Interrupt vector ID to be used by the driver</p>
735 <span id='meta-synop'></span>
736 <table class="xdocLabel"><tr>
737 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
738 <td class="xdocLabelRight"></td>
739 </tr></table>
740 <div class="xdocSynMdcl">
741 <div class="xdocSynCode">
742 <tt></tt><tt></tt>NotifyDriverMbx.<span class="xdoc-id">intVectorId</span> = <i><span class="xdoc-kw2">UInt</span></i> ~1u;
743 </div>
744 </div>
745 <div class="xdocSynSpacer"> </div>
746 <span id="xdoc-sect-1"></span>
747 <div class="xdocSect">DETAILS</div>
748 <div class="xdocText">This parameter is only used by the DSP core</div>
749 <div class="xdocSect">C SYNOPSIS</div>
750 <div class="xdocText"><a class="xdoc-link" href="#int.Vector.Id" title="NotifyDriverMbx_intVectorId">NotifyDriverMbx_intVectorId</a></div>
751 <div class="xdocSynSpacer"> </div>
752 <a class="xdocAnchor" id="metamailbox.Base.Addr"></a>
753 <table class="xdocHdr"><tr>
754 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifyDriverMbx.</span><span class="xdoc-id">mailboxBaseAddr</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
755 <td class="xdocHdrArrow">
756 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html" title="module NotifyDriverMbx"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
757 </table>
758 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#mailbox.Base.Addr">index URL</a></div>
759 <p class="xdocHdrSummaryDcl">Base address for the Mailbox subsystem</p>
760 <span id='meta-synop'></span>
761 <table class="xdocLabel"><tr>
762 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
763 <td class="xdocLabelRight"></td>
764 </tr></table>
765 <div class="xdocSynMdcl">
766 <div class="xdocSynCode">
767 <tt></tt><tt></tt>NotifyDriverMbx.<span class="xdoc-id">mailboxBaseAddr</span> = <i><span class="xdoc-kw2">UInt32</span></i> 0x480C8000;
768 </div>
769 </div>
770 <div class="xdocSynSpacer"> </div>
771 <div class="xdocSect">C SYNOPSIS</div>
772 <div class="xdocText"><a class="xdoc-link" href="#mailbox.Base.Addr" title="NotifyDriverMbx_mailboxBaseAddr">NotifyDriverMbx_mailboxBaseAddr</a></div>
773 <div class="xdocSynSpacer"> </div>
774 <a class="xdocAnchor" id="common$"></a>
775 <table class="xdocHdr"><tr>
776 <td class="xdocHdrTitle"><span class="xdoc-kw1">metaonly </span><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifyDriverMbx.</span><span class="xdoc-id">common$</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
777 <td class="xdocHdrArrow">
778 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html" title="module NotifyDriverMbx"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
779 </table>
780 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#common$">index URL</a></div>
781 <p class="xdocHdrSummaryDcl">Common module configuration parameters</p>
782 <span id='meta-synop'></span>
783 <table class="xdocLabel"><tr>
784 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
785 <td class="xdocLabelRight"></td>
786 </tr></table>
787 <div class="xdocSynMdcl">
788 <div class="xdocSynCode">
789 <tt></tt><tt></tt>NotifyDriverMbx.<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>;
790 </div>
791 </div>
792 <div class="xdocSynSpacer"> </div>
793 <span id="xdoc-sect-1"></span>
794 <div class="xdocSect">DETAILS</div>
795 <div class="xdocText">All modules have this configuration parameter. Its name
796 contains the '$' character to ensure it does not conflict with
797 configuration parameters declared by the module. This allows
798 new configuration parameters to be added in the future without
799 any chance of breaking existing modules.</div>
800 <div class="xdocSynSpacer"> </div>
801 <a class="xdocAnchor" id="rov.View.Info"></a>
802 <table class="xdocHdr"><tr>
803 <td class="xdocHdrTitle"><span class="xdoc-kw1">metaonly </span><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifyDriverMbx.</span><span class="xdoc-id">rovViewInfo</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
804 <td class="xdocHdrArrow">
805 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html" title="module NotifyDriverMbx"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
806 </table>
807 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#rov.View.Info">index URL</a></div>
808 <span id='meta-synop'></span>
809 <table class="xdocLabel"><tr>
810 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
811 <td class="xdocLabelRight"></td>
812 </tr></table>
813 <div class="xdocSynMdcl">
814 <div class="xdocSynCode">
815 <tt></tt><tt></tt>NotifyDriverMbx.<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>;
816 </div>
817 </div>
818 <div class="xdocSynSpacer"> </div>
819 <a class="xdocAnchor" id="metaper-instance_config_parameters"></a>
820 <table class="xdocHdr"><tr>
821 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Config Parameters</span></td>
822 <td class="xdocHdrArrow">
823 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html" title="module NotifyDriverMbx"><img class="xdocHdrArrow" src="../../../../../Arrow_up.png"/></a></td>
824 </table>
825 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../../index.html#ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html#per-instance_config_parameters">index URL</a></div>
826 <p class="xdocHdrSummary"></p>
827 <span id='meta-synop'></span>
828 <table class="xdocLabel"><tr>
829 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
830 <td class="xdocLabelRight"></td>
831 </tr></table>
832 <div class="xdocSynMdcl">
833 <div class="xdocSynCode">
834 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> NotifyDriverMbx.<span class="xdoc-id">Params</span>;
835 </div>
836 <div class='xdocSynSum'><tt></tt><tt></tt>// Instance config-params object</div>
837 <div class="xdocSynCode">
838 <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>;
839 </div>
840 <div class='xdocSynSum'><tt></tt><tt> </tt>// The MultiProc ID corresponding to the remote processor</div>
841 </div>
842 <div class="xdocSynSpacer"> </div>
843 <a class="xdocAnchor" id="metaremote.Proc.Id"></a>
844 <table class="xdocHdr"><tr>
845 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">NotifyDriverMbx.Params.</span><span class="xdoc-id">remoteProcId</span> <small><span class="xdocSynSum">// instance</span></small></td>
846 <td class="xdocHdrArrow">
847 <a class="xdocHdrLink" href="../../../../../ti/sdo/ipc/family/c6a8149/NotifyDriverMbx.html" title="module NotifyDriverMbx"><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/family/c6a8149/NotifyDriverMbx.html#remote.Proc.Id">index URL</a></div>
850 <p class="xdocHdrSummaryDcl">The MultiProc ID corresponding to the remote processor</p>
851 <span id='meta-synop'></span>
852 <table class="xdocLabel"><tr>
853 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
854 <td class="xdocLabelRight"></td>
855 </tr></table>
856 <div class="xdocSynMdcl">
857 <div class="xdocSynCode">
858 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> NotifyDriverMbx.<span class="xdoc-id">Params</span>;
859 </div>
860 <div class="xdocSynCode">
861 <tt></tt><tt></tt><b> ...</b>
862 </div>
863 <div class="xdocSynCode">
864 <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>;
865 </div>
866 </div>
867 <div class="xdocSynSpacer"> </div>
868 <div class="xdocSect">C SYNOPSIS</div>
869 <div class="xdocText"><a class="xdoc-link" href="#remote.Proc.Id" title="NotifyDriverMbx_Params.remoteProcId">NotifyDriverMbx_Params.remoteProcId</a></div>
870 </div>
871 <div id="xdocDate">generated on Mon, 23 May 2016 14:31:16 GMT</div>
872 </div></div></body>
873 </html>