[processor-sdk/performance-audio-sr.git] / ipc_3_43_00_00_eng / docs / cdoc / ti / sdo / ipc / gates / GateMPSupportNull.html
1 <html>
2 <head>
3 <title>module ti.sdo.ipc.gates.GateMPSupportNull</title>
4 <meta name="description" content="Module to plug GateMP proxies">
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.gates.</span><span class="xdoc-id">GateMPSupportNull</span></td>
10 <td class="xdocHdrArrow">
11 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/gates/GateHWSpinlock.html" title="module GateHWSpinlock"><img class="xdocHdrArrow" src="../../../../Arrow_left.png"/></a></td>
12 <td class="xdocHdrArrow">
13 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/gates/package.html" title="package ti.sdo.ipc.gates"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
14 <td class="xdocHdrArrow">
15 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/gates/GatePeterson.html" title="module GatePeterson"><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/gates/GateMPSupportNull.html">index URL</a></div>
18 <p class="xdocHdrSummary">Module to plug GateMP proxies</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 <span id='targ-synop'></span>
26 <table class="xdocLabel"><tr>
27 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2">C</span></tt> synopsis</td>
28 <td class="xdocLabelCenter">target-domain</td>
29 <td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull-src.html"><span class="xdocLabelFile">ti/sdo/ipc/gates/GateMPSupportNull.xdc</span></a></td>
30 </tr></table>
31 <div class="xdocSynT">
32 <div class="xdocSynCode">
33 <tt></tt><span class="xdoc-kw3">#include</span> <span class="xdoc-id"><ti/sdo/ipc/gates/GateMPSupportNull.h></span>
34 </div>
35 <table cellspacing="0" cellpadding="0" border="0">
36 <tr><td colspan='2'><div class='xdocSynTblHdr'>Functions</div></td></tr>
38 <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_creation"><span class="xdoc-id">GateMPSupportNull_construct</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Initialize a new instance object inside the provided structure</span></span></a>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_object_types" title="ti.sdo.ipc.gates.GateMPSupportNull.Struct">GateMPSupportNull_Struct</a> *structP, <a class="xdoc-link" href="../../../../xdc/runtime/IGateProvider.html#per-instance_object_types" title="xdc.runtime.IGateProvider.Handle">IGateProvider_Handle</a> <span class="xdoc-id">localGate</span>, <span class="xdoc-kw1">const</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_config_parameters" title="ti.sdo.ipc.gates.GateMPSupportNull.Params">GateMPSupportNull_Params</a> *params);</div></td></tr>
39 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_object_types" title="ti.sdo.ipc.gates.GateMPSupportNull.Handle">GateMPSupportNull_Handle</a> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_creation"><span class="xdoc-id">GateMPSupportNull_create</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Allocate and initialize a new instance object and return its handle</span></span></a>(<a class="xdoc-link" href="../../../../xdc/runtime/IGateProvider.html#per-instance_object_types" title="xdc.runtime.IGateProvider.Handle">IGateProvider_Handle</a> <span class="xdoc-id">localGate</span>, <span class="xdoc-kw1">const</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_config_parameters" title="ti.sdo.ipc.gates.GateMPSupportNull.Params">GateMPSupportNull_Params</a> *params, <a class="xdoc-link" href="../../../../xdc/runtime/Error.html#.Block" title="xdc.runtime.Error.Block">Error_Block</a> *eb);</div></td></tr>
40 <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_deletion"><span class="xdoc-id">GateMPSupportNull_delete</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Finalize and free this previously allocated instance object, setting the referenced handle to NULL</span></span></a>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_object_types" title="ti.sdo.ipc.gates.GateMPSupportNull.Handle">GateMPSupportNull_Handle</a> *handleP);</div></td></tr>
41 <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_deletion"><span class="xdoc-id">GateMPSupportNull_destruct</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Finalize the instance object inside the provided structure</span></span></a>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_object_types" title="ti.sdo.ipc.gates.GateMPSupportNull.Struct">GateMPSupportNull_Struct</a> *structP);</div></td></tr>
42 <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">GateMPSupportNull_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/gates/GateMPSupportNull.html#per-instance_config_parameters" title="ti.sdo.ipc.gates.GateMPSupportNull.Params">GateMPSupportNull_Params</a> *params);</div></td></tr>
43 <tr><td colspan="2"><div class="xdocSynFxnCat">Functions common to all IGateProvider modules</div></td></tr>
45 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Bool</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#query"><span class="xdoc-id">GateMPSupportNull_query</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Runtime test for a particular gate quality</span></span></a>(<span class="xdoc-kw2">Int</span> <span class="xdoc-id">qual</span>);</div></td></tr>
46 <tr><td colspan="2"><div class="xdocSynFxnCat">Functions common to all IGateMPSupport modules</div></td></tr>
48 <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">GateMPSupportNull_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/interfaces/IGateMPSupport.html#per-instance_config_parameters" title="ti.sdo.ipc.interfaces.IGateMPSupport.Params">IGateMPSupport_Params</a> *<span class="xdoc-id">params</span>);</div></td></tr>
49 <tr><td class="xdocSynFxnCat" colspan="2"><div class="xdocSynFxnCat">Functions common to all target instances</div></td></tr>
51 <tr>
52 <td></td>
53 <td>
54 <div class="xdocSynTblPack">
55 <a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">GateMPSupportNull_handle</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Convert this instance structure pointer into an instance handle</span></span></a>,
56 <a class="xdocSynGo" href="#per-instance_convertors"><span class="xdoc-id">GateMPSupportNull_Handle_downCast</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// conditionally move one level down the inheritance hierarchy; NULL upon failure</span></span></a>,
57 <a class="xdocSynGo" href="#per-instance_convertors"><span class="xdoc-id">GateMPSupportNull_Handle_downCast2</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// conditionally move 2 levels down the inheritance hierarchy; NULL upon failure</span></span></a>,
58 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">GateMPSupportNull_Handle_label</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The label associated with this instance object</span></span></a>,
59 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">GateMPSupportNull_Handle_name</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The name of this instance object</span></span></a>,
60 <a class="xdocSynGo" href="#per-instance_convertors"><span class="xdoc-id">GateMPSupportNull_Handle_upCast</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// unconditionally move one level up the inheritance hierarchy</span></span></a>,
61 <a class="xdocSynGo" href="#per-instance_convertors"><span class="xdoc-id">GateMPSupportNull_Handle_upCast2</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// unconditionally move 2 levels up the inheritance hierarchy</span></span></a>,
62 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">GateMPSupportNull_Object_count</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The number of statically-created instance objects</span></span></a>,
63 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">GateMPSupportNull_Object_first</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The handle of the first dynamically-created instance object, or NULL</span></span></a>,
64 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">GateMPSupportNull_Object_get</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The handle of the i-th statically-created instance object (array == NULL)</span></span></a>,
65 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">GateMPSupportNull_Object_heap</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The heap used to allocate dynamically-created instance objects</span></span></a>,
66 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">GateMPSupportNull_Object_next</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The handle of the next dynamically-created instance object, or NULL</span></span></a>,
67 <a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">GateMPSupportNull_struct</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Convert this instance handle into an instance structure pointer</span></span></a>
68 </div>
69 </td>
70 </tr>
71 <tr><td class="xdocSynFxnCat" colspan="2"><div class="xdocSynFxnCat">Functions common to all target modules</div></td></tr>
73 <tr>
74 <td></td>
75 <td>
76 <div class="xdocSynTblPack">
77 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">GateMPSupportNull_Module_getMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Returns the diagnostics mask for this module</span></span></a>,
78 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">GateMPSupportNull_Module_hasMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Test whether this module has a diagnostics mask</span></span></a>,
79 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">GateMPSupportNull_Module_heap</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The heap from which this module allocates memory</span></span></a>,
80 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">GateMPSupportNull_Module_id</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Get this module's unique id</span></span></a>,
81 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">GateMPSupportNull_Module_setMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Set the diagnostics mask for this module</span></span></a>,
82 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">GateMPSupportNull_Module_startupDone</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Test if this module has completed startup</span></span></a>
83 </div>
84 </td>
85 </tr>
86 <tr><td colspan='2'><div class='xdocSynTblHdr'>Defines</div></td></tr>
88 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw3">#define</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#.Q_.B.L.O.C.K.I.N.G"><span class="xdoc-id">GateMPSupportNull_Q_BLOCKING</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Blocking quality</span></span></a> (<i><span class="xdoc-kw2">Int</span></i>)1</div></td></tr>
89 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw3">#define</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#.Q_.P.R.E.E.M.P.T.I.N.G"><span class="xdoc-id">GateMPSupportNull_Q_PREEMPTING</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Preempting quality</span></span></a> (<i><span class="xdoc-kw2">Int</span></i>)2</div></td></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> <span class="xdoc-kw1">enum</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#.Action"><span class="xdoc-id">GateMPSupportNull_Action</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Error codes returned by certain calls in GateMP</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> <a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_object_types" title="ti.sdo.ipc.gates.GateMPSupportNull.Object">GateMPSupportNull_Object</a> *</div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">GateMPSupportNull_Handle</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Client reference to an instance object</span></span></a>;</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_object_types"><span class="xdoc-id">GateMPSupportNull_Object</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Opaque internal representation of an instance object</span></span></a> <span class="xdoc-id">GateMPSupportNull_Object</span>;</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_config_parameters"><span class="xdoc-id">GateMPSupportNull_Params</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Instance config-params structure</span></span></a> ...</div></td></tr>
96 <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">GateMPSupportNull_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">GateMPSupportNull_Struct</span>;</div></td></tr>
97 <tr><td colspan='2'><div class='xdocSynTblHdr'>Constants</div></td></tr>
99 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">extern const</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#.Action" title="ti.sdo.ipc.gates.GateMPSupportNull.Action">GateMPSupportNull_Action</a> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#action"><span class="xdoc-id">GateMPSupportNull_action</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert if the enter and/or leave is called</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> <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_invalid.Action"><span class="xdoc-id">GateMPSupportNull_A_invalidAction</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert raised when trying to use GateMPSupportNull's enter or leave</span></span></a>;</div></td></tr>
101 </table>
102 <div class="xdocSynSpacer"> </div>
103 </div>
104 <div id="xdocSep">
105 </div>
106 <div id="xdocElems">
107 <div class="xdocSynSpacer"> </div>
108 <a class="xdocAnchor" id=".Q_.B.L.O.C.K.I.N.G"></a>
109 <table class="xdocHdr"><tr>
110 <td class="xdocHdrTitle"><span class="xdoc-kw1">const</span> <span class="xdoc-id">GateMPSupportNull_</span><span class="xdoc-id">Q_BLOCKING</span></td>
111 <td class="xdocHdrArrow">
112 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html" title="module GateMPSupportNull"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
113 </table>
114 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/gates/GateMPSupportNull.html#.Q_.B.L.O.C.K.I.N.G">index URL</a></div>
115 <p class="xdocHdrSummaryDcl">Blocking quality</p>
116 <span id='targ-synop'></span>
117 <table class="xdocLabel"><tr>
118 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
119 <td class="xdocLabelRight">target-domain</td>
120 </tr></table>
121 <div class="xdocSynTdcl">
122 <div class="xdocSynCode">
123 <tt></tt><tt></tt><span class="xdoc-kw3">#define</span> <span class="xdoc-id">GateMPSupportNull_Q_BLOCKING</span> (<i><span class="xdoc-kw2">Int</span></i>)1
124 </div>
125 </div>
126 <div class="xdocSynSpacer"> </div>
127 <span id="xdoc-sect-1"></span>
128 <div class="xdocSect">DETAILS</div>
129 <div class="xdocText">Gates with this "quality" may cause the calling thread to block;
130 i.e., suspend execution until another thread leaves the gate.</div>
131 <div class="xdocSynSpacer"> </div>
132 <a class="xdocAnchor" id=".Q_.P.R.E.E.M.P.T.I.N.G"></a>
133 <table class="xdocHdr"><tr>
134 <td class="xdocHdrTitle"><span class="xdoc-kw1">const</span> <span class="xdoc-id">GateMPSupportNull_</span><span class="xdoc-id">Q_PREEMPTING</span></td>
135 <td class="xdocHdrArrow">
136 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html" title="module GateMPSupportNull"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
137 </table>
138 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/gates/GateMPSupportNull.html#.Q_.P.R.E.E.M.P.T.I.N.G">index URL</a></div>
139 <p class="xdocHdrSummaryDcl">Preempting quality</p>
140 <span id='targ-synop'></span>
141 <table class="xdocLabel"><tr>
142 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
143 <td class="xdocLabelRight">target-domain</td>
144 </tr></table>
145 <div class="xdocSynTdcl">
146 <div class="xdocSynCode">
147 <tt></tt><tt></tt><span class="xdoc-kw3">#define</span> <span class="xdoc-id">GateMPSupportNull_Q_PREEMPTING</span> (<i><span class="xdoc-kw2">Int</span></i>)2
148 </div>
149 </div>
150 <div class="xdocSynSpacer"> </div>
151 <span id="xdoc-sect-1"></span>
152 <div class="xdocSect">DETAILS</div>
153 <div class="xdocText">Gates with this "quality" allow other threads to preempt the thread
154 that has already entered the gate.</div>
155 <div class="xdocSynSpacer"> </div>
156 <a class="xdocAnchor" id=".Action"></a>
157 <a class="xdocAnchor" id=".Action_.N.O.N.E"></a>
158 <a class="xdocAnchor" id=".Action_.A.S.S.E.R.T"></a>
159 <table class="xdocHdr"><tr>
160 <td class="xdocHdrTitle"><span class="xdoc-kw1">enum</span> <span class="xdoc-id">GateMPSupportNull_</span><span class="xdoc-id">Action</span></td>
161 <td class="xdocHdrArrow">
162 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html" title="module GateMPSupportNull"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
163 </table>
164 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/gates/GateMPSupportNull.html#.Action">index URL</a></div>
165 <p class="xdocHdrSummaryDcl">Error codes returned by certain calls in GateMP</p>
166 <span id='targ-synop'></span>
167 <table class="xdocLabel"><tr>
168 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
169 <td class="xdocLabelRight">target-domain</td>
170 </tr></table>
171 <div class="xdocSynTdcl">
172 <div class="xdocSynCode">
173 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">enum</span> <span class="xdoc-id">GateMPSupportNull_Action</span> {
174 </div>
175 <div class="xdocSynCode">
176 <tt></tt><tt> </tt><span class="xdoc-id">GateMPSupportNull_Action_NONE</span>,
177 </div>
178 <div class="xdocSynCode">
179 <tt></tt><tt> </tt><span class="xdoc-id">GateMPSupportNull_Action_ASSERT</span>
180 </div>
181 <div class="xdocSynCode">
182 <tt></tt><tt></tt>} <span class="xdoc-id">GateMPSupportNull_Action</span>;
183 </div>
184 </div>
185 <div class="xdocSynSpacer"> </div>
186 <div class="xdocSynSpacer"> </div>
187 <a class="xdocAnchor" id=".A_invalid.Action"></a>
188 <table class="xdocHdr"><tr>
189 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">GateMPSupportNull_</span><span class="xdoc-id">A_invalidAction</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
190 <td class="xdocHdrArrow">
191 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html" title="module GateMPSupportNull"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
192 </table>
193 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/gates/GateMPSupportNull.html#.A_invalid.Action">index URL</a></div>
194 <p class="xdocHdrSummaryDcl">Assert raised when trying to use GateMPSupportNull's enter or leave</p>
195 <span id='targ-synop'></span>
196 <table class="xdocLabel"><tr>
197 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
198 <td class="xdocLabelRight">target-domain</td>
199 </tr></table>
200 <div class="xdocSynTdcl">
201 <div class="xdocSynCode">
202 <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">GateMPSupportNull_A_invalidAction</span>;
203 </div>
204 </div>
205 <div class="xdocSynSpacer"> </div>
206 <div class="xdocSynSpacer"> </div>
207 <a class="xdocAnchor" id="action"></a>
208 <table class="xdocHdr"><tr>
209 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">GateMPSupportNull_</span><span class="xdoc-id">action</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
210 <td class="xdocHdrArrow">
211 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html" title="module GateMPSupportNull"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
212 </table>
213 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/gates/GateMPSupportNull.html#action">index URL</a></div>
214 <p class="xdocHdrSummaryDcl">Assert if the enter and/or leave is called</p>
215 <span id='targ-synop'></span>
216 <table class="xdocLabel"><tr>
217 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
218 <td class="xdocLabelRight">target-domain</td>
219 </tr></table>
220 <div class="xdocSynTdcl">
221 <div class="xdocSynCode">
222 <tt></tt><tt></tt><span class="xdoc-kw1">extern const</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#.Action" title="ti.sdo.ipc.gates.GateMPSupportNull.Action">GateMPSupportNull_Action</a> <span class="xdoc-id">GateMPSupportNull_action</span>;
223 </div>
224 </div>
225 <div class="xdocSynSpacer"> </div>
226 <div class="xdocSynSpacer"> </div>
227 <a class="xdocAnchor" id="query"></a>
228 <table class="xdocHdr"><tr>
229 <td class="xdocHdrTitle"><span class="xdoc-id">GateMPSupportNull_</span><span class="xdoc-id">query</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
230 <td class="xdocHdrArrow">
231 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html" title="module GateMPSupportNull"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
232 </table>
233 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/gates/GateMPSupportNull.html#query">index URL</a></div>
234 <p class="xdocHdrSummaryDcl">Runtime test for a particular gate quality</p>
235 <span id='targ-synop'></span>
236 <table class="xdocLabel"><tr>
237 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
238 <td class="xdocLabelRight">target-domain</td>
239 </tr></table>
240 <div class="xdocSynTdcl">
241 <div class="xdocSynCode">
242 <tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">GateMPSupportNull_query</span>(<span class="xdoc-kw2">Int</span> <span class="xdoc-id">qual</span>);
243 </div>
244 </div>
245 <div class="xdocSynSpacer"> </div>
246 <span id="xdoc-sect-1"></span>
247 <div class="xdocSect">ARGUMENTS</div>
248 <div class="xdocChild"><span class="xdocChildId">qual</span>
249 <span class="xdocChildSum">— constant describing a quality</span>
250 </div>
251 <span id="xdoc-sect-2"></span>
252 <div class="xdocSect">RETURNS</div>
253 <div class="xdocText">Returns <tt>TRUE</tt> if the gate has the given quality,
254 and <tt>FALSE</tt> otherwise, which includes the case when the gate does not
255 recognize the constant describing the quality.</div>
256 <div class="xdocSynSpacer"> </div>
257 <a class="xdocAnchor" id="shared.Mem.Req"></a>
258 <table class="xdocHdr"><tr>
259 <td class="xdocHdrTitle"><span class="xdoc-id">GateMPSupportNull_</span><span class="xdoc-id">sharedMemReq</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
260 <td class="xdocHdrArrow">
261 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html" title="module GateMPSupportNull"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
262 </table>
263 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/gates/GateMPSupportNull.html#shared.Mem.Req">index URL</a></div>
264 <p class="xdocHdrSummaryDcl">Amount of shared memory required for creation of each instance</p>
265 <span id='targ-synop'></span>
266 <table class="xdocLabel"><tr>
267 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
268 <td class="xdocLabelRight">target-domain</td>
269 </tr></table>
270 <div class="xdocSynTdcl">
271 <div class="xdocSynCode">
272 <tt></tt><tt></tt><span class="xdoc-kw2">SizeT</span> <span class="xdoc-id">GateMPSupportNull_sharedMemReq</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/interfaces/IGateMPSupport.html#per-instance_config_parameters" title="ti.sdo.ipc.interfaces.IGateMPSupport.Params">IGateMPSupport_Params</a> *<span class="xdoc-id">params</span>);
273 </div>
274 </div>
275 <div class="xdocSynSpacer"> </div>
276 <span id="xdoc-sect-1"></span>
277 <div class="xdocSect">ARGUMENTS</div>
278 <div class="xdocChild"><span class="xdocChildId">params</span>
279 <span class="xdocChildSum">— Pointer to the parameters that will be used in
280 the create.</span>
281 </div>
282 <span id="xdoc-sect-2"></span>
283 <div class="xdocSect">DETAILS</div>
284 <div class="xdocText">The value returned by this function may depend on the cache alignment
285 requirements for the shared region from which memory will be used.</div>
286 <span id="xdoc-sect-3"></span>
287 <div class="xdocSect">RETURNS</div>
288 <div class="xdocText">Number of MAUs needed to create the instance.</div>
289 <a class="xdocAnchor" id="module-wide_built-ins"></a>
290 <table class="xdocHdr"><tr>
291 <td class="xdocHdrTitle"><span class="xdocSynSum">Module-Wide Built-Ins</span></td>
292 <td class="xdocHdrArrow">
293 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html" title="module GateMPSupportNull"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
294 </table>
295 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/gates/GateMPSupportNull.html#module-wide_built-ins">index URL</a></div>
296 <p class="xdocHdrSummary"></p>
297 <span id='targ-synop'></span>
298 <table class="xdocLabel"><tr>
299 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
300 <td class="xdocLabelRight">target-domain</td>
301 </tr></table>
302 <div class="xdocSynTdcl">
303 <div class="xdocSynCode">
304 <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">GateMPSupportNull_Module_id</span>();
305 </div>
306 <div class='xdocSynSum'><tt></tt><tt></tt>// Get this module's unique id</div>
307 <div class="xdocSynSpacer"> </div>
308 <div class="xdocSynCode">
309 <tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">GateMPSupportNull_Module_startupDone</span>();
310 </div>
311 <div class='xdocSynSum'><tt></tt><tt></tt>// Test if this module has completed startup</div>
312 <div class="xdocSynSpacer"> </div>
313 <div class="xdocSynCode">
314 <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">GateMPSupportNull_Module_heap</span>();
315 </div>
316 <div class='xdocSynSum'><tt></tt><tt></tt>// The heap from which this module allocates memory</div>
317 <div class="xdocSynSpacer"> </div>
318 <div class="xdocSynCode">
319 <tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">GateMPSupportNull_Module_hasMask</span>();
320 </div>
321 <div class='xdocSynSum'><tt></tt><tt></tt>// Test whether this module has a diagnostics mask</div>
322 <div class="xdocSynSpacer"> </div>
323 <div class="xdocSynCode">
324 <tt></tt><tt></tt><span class="xdoc-kw2">Bits16</span> <span class="xdoc-id">GateMPSupportNull_Module_getMask</span>();
325 </div>
326 <div class='xdocSynSum'><tt></tt><tt></tt>// Returns the diagnostics mask for this module</div>
327 <div class="xdocSynSpacer"> </div>
328 <div class="xdocSynCode">
329 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">GateMPSupportNull_Module_setMask</span>(<span class="xdoc-kw2">Bits16</span> <span class="xdoc-id">mask</span>);
330 </div>
331 <div class='xdocSynSum'><tt></tt><tt></tt>// Set the diagnostics mask for this module</div>
332 </div>
333 <a class="xdocAnchor" id="per-instance_object_types"></a>
334 <table class="xdocHdr"><tr>
335 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Object Types</span></td>
336 <td class="xdocHdrArrow">
337 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html" title="module GateMPSupportNull"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
338 </table>
339 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_object_types">index URL</a></div>
340 <p class="xdocHdrSummary"></p>
341 <span id='targ-synop'></span>
342 <table class="xdocLabel"><tr>
343 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
344 <td class="xdocLabelRight">target-domain</td>
345 </tr></table>
346 <div class="xdocSynTdcl">
347 <div class="xdocSynCode">
348 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">GateMPSupportNull_Object</span> <span class="xdoc-id">GateMPSupportNull_Object</span>;
349 </div>
350 <div class='xdocSynSum'><tt></tt><tt></tt>// Opaque internal representation of an instance object</div>
351 <div class="xdocSynSpacer"> </div>
352 <div class="xdocSynCode">
353 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_object_types" title="ti.sdo.ipc.gates.GateMPSupportNull.Object">GateMPSupportNull_Object</a> *<span class="xdoc-id">GateMPSupportNull_Handle</span>;
354 </div>
355 <div class='xdocSynSum'><tt></tt><tt></tt>// Client reference to an instance object</div>
356 <div class="xdocSynSpacer"> </div>
357 <div class="xdocSynCode">
358 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">GateMPSupportNull_Struct</span> <span class="xdoc-id">GateMPSupportNull_Struct</span>;
359 </div>
360 <div class='xdocSynSum'><tt></tt><tt></tt>// Opaque client structure large enough to hold an instance object</div>
361 <div class="xdocSynSpacer"> </div>
362 <div class="xdocSynCode">
363 <tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_object_types" title="ti.sdo.ipc.gates.GateMPSupportNull.Handle">GateMPSupportNull_Handle</a> <span class="xdoc-id">GateMPSupportNull_handle</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_object_types" title="ti.sdo.ipc.gates.GateMPSupportNull.Struct">GateMPSupportNull_Struct</a> *structP);
364 </div>
365 <div class='xdocSynSum'><tt></tt><tt></tt>// Convert this instance structure pointer into an instance handle</div>
366 <div class="xdocSynSpacer"> </div>
367 <div class="xdocSynCode">
368 <tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_object_types" title="ti.sdo.ipc.gates.GateMPSupportNull.Struct">GateMPSupportNull_Struct</a> *<span class="xdoc-id">GateMPSupportNull_struct</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_object_types" title="ti.sdo.ipc.gates.GateMPSupportNull.Handle">GateMPSupportNull_Handle</a> handle);
369 </div>
370 <div class='xdocSynSum'><tt></tt><tt></tt>// Convert this instance handle into an instance structure pointer</div>
371 </div>
372 <a class="xdocAnchor" id="per-instance_config_parameters"></a>
373 <table class="xdocHdr"><tr>
374 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Config Parameters</span></td>
375 <td class="xdocHdrArrow">
376 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html" title="module GateMPSupportNull"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
377 </table>
378 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_config_parameters">index URL</a></div>
379 <p class="xdocHdrSummary"></p>
380 <span id='targ-synop'></span>
381 <table class="xdocLabel"><tr>
382 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
383 <td class="xdocLabelRight">target-domain</td>
384 </tr></table>
385 <div class="xdocSynTdcl">
386 <div class="xdocSynCode">
387 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">GateMPSupportNull_Params</span> {
388 </div>
389 <div class='xdocSynSum'><tt></tt><tt></tt>// Instance config-params structure</div>
390 <div class="xdocSynCode">
391 <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;
392 </div>
393 <div class='xdocSynSum'><tt></tt><tt> </tt>// Common per-instance configs</div>
394 <div class="xdocSynCode">
395 <tt></tt><tt> </tt><span class="xdoc-kw2">UInt</span> <span class="xdoc-id">resourceId</span>;
396 </div>
397 <div class='xdocSynSum'><tt></tt><tt> </tt>// Logical resource id</div>
398 <div class="xdocSynCode">
399 <tt></tt><tt> </tt><span class="xdoc-kw2">Ptr</span> <span class="xdoc-id">sharedAddr</span>;
400 </div>
401 <div class='xdocSynSum'><tt></tt><tt> </tt>// Physical address of the shared memory</div>
402 <div class="xdocSynCode">
403 <tt></tt><tt></tt>} <span class="xdoc-id">GateMPSupportNull_Params</span>;
404 </div>
405 <div class="xdocSynSpacer"> </div>
406 <div class="xdocSynCode">
407 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">GateMPSupportNull_Params_init</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_config_parameters" title="ti.sdo.ipc.gates.GateMPSupportNull.Params">GateMPSupportNull_Params</a> *params);
408 </div>
409 <div class='xdocSynSum'><tt></tt><tt></tt>// Initialize this config-params structure with supplier-specified defaults before instance creation</div>
410 </div>
411 <div class="xdocSynSpacer"> </div>
412 <a class="xdocAnchor" id="resource.Id"></a>
413 <table class="xdocHdr"><tr>
414 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">GateMPSupportNull_Params.</span><span class="xdoc-id">resourceId</span> <small><span class="xdocSynSum">// instance</span></small></td>
415 <td class="xdocHdrArrow">
416 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html" title="module GateMPSupportNull"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
417 </table>
418 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/gates/GateMPSupportNull.html#resource.Id">index URL</a></div>
419 <p class="xdocHdrSummaryDcl">Logical resource id</p>
420 <span id='targ-synop'></span>
421 <table class="xdocLabel"><tr>
422 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
423 <td class="xdocLabelRight">target-domain</td>
424 </tr></table>
425 <div class="xdocSynTdcl">
426 <div class="xdocSynCode">
427 <tt></tt><tt></tt><span class="xdoc-kw1">struct</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_config_parameters" title="ti.sdo.ipc.gates.GateMPSupportNull.Params">GateMPSupportNull_Params</a> {
428 </div>
429 <div class="xdocSynCode">
430 <tt></tt><tt> </tt><b> ...</b>
431 </div>
432 <div class="xdocSynCode">
433 <tt></tt><tt> </tt><span class="xdoc-kw2">UInt</span> <span class="xdoc-id">resourceId</span>;
434 </div>
435 </div>
436 <div class="xdocSynSpacer"> </div>
437 <div class="xdocSynSpacer"> </div>
438 <a class="xdocAnchor" id="shared.Addr"></a>
439 <table class="xdocHdr"><tr>
440 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">GateMPSupportNull_Params.</span><span class="xdoc-id">sharedAddr</span> <small><span class="xdocSynSum">// instance</span></small></td>
441 <td class="xdocHdrArrow">
442 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html" title="module GateMPSupportNull"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
443 </table>
444 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/gates/GateMPSupportNull.html#shared.Addr">index URL</a></div>
445 <p class="xdocHdrSummaryDcl">Physical address of the shared memory</p>
446 <span id='targ-synop'></span>
447 <table class="xdocLabel"><tr>
448 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
449 <td class="xdocLabelRight">target-domain</td>
450 </tr></table>
451 <div class="xdocSynTdcl">
452 <div class="xdocSynCode">
453 <tt></tt><tt></tt><span class="xdoc-kw1">struct</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_config_parameters" title="ti.sdo.ipc.gates.GateMPSupportNull.Params">GateMPSupportNull_Params</a> {
454 </div>
455 <div class="xdocSynCode">
456 <tt></tt><tt> </tt><b> ...</b>
457 </div>
458 <div class="xdocSynCode">
459 <tt></tt><tt> </tt><span class="xdoc-kw2">Ptr</span> <span class="xdoc-id">sharedAddr</span>;
460 </div>
461 </div>
462 <div class="xdocSynSpacer"> </div>
463 <span id="xdoc-sect-1"></span>
464 <div class="xdocSect">DETAILS</div>
465 <div class="xdocText">This parameter is only used by GateMP delegates that use shared memory</div>
466 <a class="xdocAnchor" id="per-instance_creation"></a>
467 <table class="xdocHdr"><tr>
468 <td class="xdocHdrTitle"><span class="xdocSynSum">Runtime Instance Creation</span></td>
469 <td class="xdocHdrArrow">
470 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html" title="module GateMPSupportNull"><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/gates/GateMPSupportNull.html#per-instance_creation">index URL</a></div>
473 <p class="xdocHdrSummary"></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><a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_object_types" title="ti.sdo.ipc.gates.GateMPSupportNull.Handle">GateMPSupportNull_Handle</a> <span class="xdoc-id">GateMPSupportNull_create</span>(<a class="xdoc-link" href="../../../../xdc/runtime/IGateProvider.html#per-instance_object_types" title="xdc.runtime.IGateProvider.Handle">IGateProvider_Handle</a> <span class="xdoc-id">localGate</span>, <span class="xdoc-kw1">const</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_config_parameters" title="ti.sdo.ipc.gates.GateMPSupportNull.Params">GateMPSupportNull_Params</a> *params, <a class="xdoc-link" href="../../../../xdc/runtime/Error.html#.Block" title="xdc.runtime.Error.Block">Error_Block</a> *eb);
482 </div>
483 <div class='xdocSynSum'><tt></tt><tt></tt>// Allocate and initialize a new instance object and return its handle</div>
484 <div class="xdocSynSpacer"> </div>
485 <div class="xdocSynCode">
486 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">GateMPSupportNull_construct</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_object_types" title="ti.sdo.ipc.gates.GateMPSupportNull.Struct">GateMPSupportNull_Struct</a> *structP, <a class="xdoc-link" href="../../../../xdc/runtime/IGateProvider.html#per-instance_object_types" title="xdc.runtime.IGateProvider.Handle">IGateProvider_Handle</a> <span class="xdoc-id">localGate</span>, <span class="xdoc-kw1">const</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_config_parameters" title="ti.sdo.ipc.gates.GateMPSupportNull.Params">GateMPSupportNull_Params</a> *params);
487 </div>
488 <div class='xdocSynSum'><tt></tt><tt></tt>// Initialize a new instance object inside the provided structure</div>
489 </div>
490 <span id="xdoc-sect-1"></span>
491 <div class="xdocSect">ARGUMENTS</div>
492 <div class="xdocChild"><span class="xdocChildId">localGate</span>
493 <span class="xdocChildSum">— Gate to use for local protection.</span>
494 </div>
495 <div class="xdocChild"><span class="xdocChildId">params</span>
496 <span class="xdocChildSum">— per-instance config params, or <tt>NULL</tt> to select default values (target-domain only)</span>
497 </div>
498 <div class="xdocChild"><span class="xdocChildId">eb</span>
499 <span class="xdocChildSum">— active error-handling block, or <tt>NULL</tt> to select default policy (target-domain only)</span>
500 </div>
501 <span id="xdoc-sect-2"></span>
502 <div class="xdocSect">DETAILS</div>
503 <div class="xdocText">A Non-NULL gate for local protection must be passed to the create
504 call. If no local protection is desired, a
505 <a class="xdoc-link" href="../../../../xdc/runtime/GateNull.html" title="xdc.runtime.GateNull">xdc.runtime.GateNull</a> handle must be passed in.</div>
506 <a class="xdocAnchor" id="per-instance_deletion"></a>
507 <table class="xdocHdr"><tr>
508 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Deletion</span></td>
509 <td class="xdocHdrArrow">
510 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html" title="module GateMPSupportNull"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
511 </table>
512 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_deletion">index URL</a></div>
513 <p class="xdocHdrSummary"></p>
514 <span id='targ-synop'></span>
515 <table class="xdocLabel"><tr>
516 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
517 <td class="xdocLabelRight">target-domain</td>
518 </tr></table>
519 <div class="xdocSynTdcl">
520 <div class="xdocSynCode">
521 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">GateMPSupportNull_delete</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_object_types" title="ti.sdo.ipc.gates.GateMPSupportNull.Handle">GateMPSupportNull_Handle</a> *handleP);
522 </div>
523 <div class='xdocSynSum'><tt></tt><tt></tt>// Finalize and free this previously allocated instance object, setting the referenced handle to NULL</div>
524 <div class="xdocSynSpacer"> </div>
525 <div class="xdocSynCode">
526 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">GateMPSupportNull_destruct</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_object_types" title="ti.sdo.ipc.gates.GateMPSupportNull.Struct">GateMPSupportNull_Struct</a> *structP);
527 </div>
528 <div class='xdocSynSum'><tt></tt><tt></tt>// Finalize the instance object inside the provided structure</div>
529 </div>
530 <a class="xdocAnchor" id="per-instance_convertors"></a>
531 <table class="xdocHdr"><tr>
532 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Convertors</span></td>
533 <td class="xdocHdrArrow">
534 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html" title="module GateMPSupportNull"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
535 </table>
536 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_convertors">index URL</a></div>
537 <p class="xdocHdrSummary"></p>
538 <span id='targ-synop'></span>
539 <table class="xdocLabel"><tr>
540 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
541 <td class="xdocLabelRight">target-domain</td>
542 </tr></table>
543 <div class="xdocSynTdcl">
544 <div class="xdocSynCode">
545 <tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/interfaces/IGateMPSupport.html#per-instance_object_types" title="ti.sdo.ipc.interfaces.IGateMPSupport.Handle">IGateMPSupport_Handle</a> <span class="xdoc-id">GateMPSupportNull_Handle_upCast</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_object_types" title="ti.sdo.ipc.gates.GateMPSupportNull.Handle">GateMPSupportNull_Handle</a> handle);
546 </div>
547 <div class='xdocSynSum'><tt></tt><tt></tt>// unconditionally move one level up the inheritance hierarchy</div>
548 <div class="xdocSynSpacer"> </div>
549 <div class="xdocSynCode">
550 <tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_object_types" title="ti.sdo.ipc.gates.GateMPSupportNull.Handle">GateMPSupportNull_Handle</a> <span class="xdoc-id">GateMPSupportNull_Handle_downCast</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/interfaces/IGateMPSupport.html#per-instance_object_types" title="ti.sdo.ipc.interfaces.IGateMPSupport.Handle">IGateMPSupport_Handle</a> handle);
551 </div>
552 <div class='xdocSynSum'><tt></tt><tt></tt>// conditionally move one level down the inheritance hierarchy; NULL upon failure</div>
553 <div class="xdocSynSpacer"> </div>
554 <div class="xdocSynCode">
555 <tt></tt><tt></tt><a class="xdoc-link" href="../../../../xdc/runtime/IGateProvider.html#per-instance_object_types" title="xdc.runtime.IGateProvider.Handle">IGateProvider_Handle</a> <span class="xdoc-id">GateMPSupportNull_Handle_upCast2</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_object_types" title="ti.sdo.ipc.gates.GateMPSupportNull.Handle">GateMPSupportNull_Handle</a> handle);
556 </div>
557 <div class='xdocSynSum'><tt></tt><tt></tt>// unconditionally move 2 levels up the inheritance hierarchy</div>
558 <div class="xdocSynSpacer"> </div>
559 <div class="xdocSynCode">
560 <tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_object_types" title="ti.sdo.ipc.gates.GateMPSupportNull.Handle">GateMPSupportNull_Handle</a> <span class="xdoc-id">GateMPSupportNull_Handle_downCast2</span>(<a class="xdoc-link" href="../../../../xdc/runtime/IGateProvider.html#per-instance_object_types" title="xdc.runtime.IGateProvider.Handle">IGateProvider_Handle</a> handle);
561 </div>
562 <div class='xdocSynSum'><tt></tt><tt></tt>// conditionally move 2 levels down the inheritance hierarchy; NULL upon failure</div>
563 </div>
564 <a class="xdocAnchor" id="per-instance_built-ins"></a>
565 <table class="xdocHdr"><tr>
566 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Built-Ins</span></td>
567 <td class="xdocHdrArrow">
568 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html" title="module GateMPSupportNull"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
569 </table>
570 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_built-ins">index URL</a></div>
571 <p class="xdocHdrSummary"></p>
572 <span id='targ-synop'></span>
573 <table class="xdocLabel"><tr>
574 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
575 <td class="xdocLabelRight">target-domain</td>
576 </tr></table>
577 <div class="xdocSynTdcl">
578 <div class="xdocSynCode">
579 <tt></tt><tt></tt><span class="xdoc-kw2">Int</span> <span class="xdoc-id">GateMPSupportNull_Object_count</span>();
580 </div>
581 <div class='xdocSynSum'><tt></tt><tt></tt>// The number of statically-created instance objects</div>
582 <div class="xdocSynSpacer"> </div>
583 <div class="xdocSynCode">
584 <tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_object_types" title="ti.sdo.ipc.gates.GateMPSupportNull.Handle">GateMPSupportNull_Handle</a> <span class="xdoc-id">GateMPSupportNull_Object_get</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_object_types" title="ti.sdo.ipc.gates.GateMPSupportNull.Object">GateMPSupportNull_Object</a> *array, <span class="xdoc-kw2">Int</span> i);
585 </div>
586 <div class='xdocSynSum'><tt></tt><tt></tt>// The handle of the i-th statically-created instance object (array == NULL)</div>
587 <div class="xdocSynSpacer"> </div>
588 <div class="xdocSynCode">
589 <tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_object_types" title="ti.sdo.ipc.gates.GateMPSupportNull.Handle">GateMPSupportNull_Handle</a> <span class="xdoc-id">GateMPSupportNull_Object_first</span>();
590 </div>
591 <div class='xdocSynSum'><tt></tt><tt></tt>// The handle of the first dynamically-created instance object, or NULL</div>
592 <div class="xdocSynSpacer"> </div>
593 <div class="xdocSynCode">
594 <tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_object_types" title="ti.sdo.ipc.gates.GateMPSupportNull.Handle">GateMPSupportNull_Handle</a> <span class="xdoc-id">GateMPSupportNull_Object_next</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_object_types" title="ti.sdo.ipc.gates.GateMPSupportNull.Handle">GateMPSupportNull_Handle</a> handle);
595 </div>
596 <div class='xdocSynSum'><tt></tt><tt></tt>// The handle of the next dynamically-created instance object, or NULL</div>
597 <div class="xdocSynSpacer"> </div>
598 <div class="xdocSynCode">
599 <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">GateMPSupportNull_Object_heap</span>();
600 </div>
601 <div class='xdocSynSum'><tt></tt><tt></tt>// The heap used to allocate dynamically-created instance objects</div>
602 <div class="xdocSynSpacer"> </div>
603 <div class="xdocSynCode">
604 <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">GateMPSupportNull_Handle_label</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_object_types" title="ti.sdo.ipc.gates.GateMPSupportNull.Handle">GateMPSupportNull_Handle</a> handle, <a class="xdoc-link" href="../../../../xdc/runtime/Types.html#.Label" title="xdc.runtime.Types.Label">Types_Label</a> *buf);
605 </div>
606 <div class='xdocSynSum'><tt></tt><tt></tt>// The label associated with this instance object</div>
607 <div class="xdocSynSpacer"> </div>
608 <div class="xdocSynCode">
609 <tt></tt><tt></tt><span class="xdoc-kw2">String</span> <span class="xdoc-id">GateMPSupportNull_Handle_name</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_object_types" title="ti.sdo.ipc.gates.GateMPSupportNull.Handle">GateMPSupportNull_Handle</a> handle);
610 </div>
611 <div class='xdocSynSum'><tt></tt><tt></tt>// The name of this instance object</div>
612 </div>
613 </div>
614 <div class="xdocSynSpacer"> </div>
615 <span id='meta-synop'></span>
616 <table class="xdocLabel"><tr>
617 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2"></span></tt>Configuration settings</td>
618 <td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull-src.html"><span class="xdocLabelFile">ti/sdo/ipc/gates/GateMPSupportNull.xdc</span></a></td>
619 </tr></table>
620 <div class="xdocSynM">
621 <div class="xdocSynCode">
622 <tt></tt><span class="xdoc-kw1">var</span> GateMPSupportNull = <span class="xdoc-kw3">xdc.useModule</span>(<span class="xdoc-id">'ti.sdo.ipc.gates.GateMPSupportNull'</span>);
623 </div>
624 <div class='xdocSynHdr'>module-wide constants & types</div>
626 <div class="xdocSynCode">
627 <tt> </tt><tt></tt><span class="xdoc-kw1">const</span> <a class="xdocSynGo" href="#meta.Q_.B.L.O.C.K.I.N.G">GateMPSupportNull.<span class="xdoc-id">Q_BLOCKING</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Blocking quality</span></span></a> = 1;
628 </div>
629 <div class="xdocSynCode">
630 <tt> </tt><tt></tt><span class="xdoc-kw1">const</span> <a class="xdocSynGo" href="#meta.Q_.P.R.E.E.M.P.T.I.N.G">GateMPSupportNull.<span class="xdoc-id">Q_PREEMPTING</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Preempting quality</span></span></a> = 2;
631 </div>
632 <div class="xdocSynSpacer"> </div>
633 <div class="xdocSynCode">
634 <tt> </tt><tt></tt><i>values of type <a class="xdocSynGo" href="#meta.Action">GateMPSupportNull.<span class="xdoc-id">Action</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Error codes returned by certain calls in GateMP</span></span></a></i>
635 </div>
636 <div class="xdocSynCode">
637 <tt> </tt><tt> </tt><span class="xdoc-kw1">const</span> <a class="xdocSynGo" href="#meta.Action" title="ti.sdo.ipc.gates.GateMPSupportNull.Action">GateMPSupportNull.<span class="xdoc-id">Action_NONE</span></a>;
638 </div>
639 <div class="xdocSynCode">
640 <tt> </tt><tt> </tt><span class="xdoc-kw1">const</span> <a class="xdocSynGo" href="#meta.Action" title="ti.sdo.ipc.gates.GateMPSupportNull.Action">GateMPSupportNull.<span class="xdoc-id">Action_ASSERT</span></a>;
641 </div>
642 <div class='xdocSynHdr'>module-wide config parameters</div>
644 <div class="xdocSynCode">
645 <tt> </tt><tt></tt><a class="xdocSynGo" href="#meta.A_invalid.Action">GateMPSupportNull.<span class="xdoc-id">A_invalidAction</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert raised when trying to use GateMPSupportNull's enter or leave</span></span></a> = <i><a class="xdoc-link" href="../../../../xdc/runtime/Assert.html#.Desc" title="xdc.runtime.Assert.Desc">Assert.Desc</a></i> {
646 </div>
647 <div class="xdocSynCode">
648 <tt> </tt><tt> </tt>msg: "A_invalidAction: Cannot use ti.sdo.ipc.gates.GateMPSupportNull"
649 </div>
650 <div class="xdocSynCode">
651 <tt> </tt><tt></tt>};
652 </div>
653 <div class="xdocSynCode">
654 <tt> </tt><tt></tt><a class="xdocSynGo" href="#metaaction">GateMPSupportNull.<span class="xdoc-id">action</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert if the enter and/or leave is called</span></span></a> = <i><a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#.Action" title="ti.sdo.ipc.gates.GateMPSupportNull.Action">GateMPSupportNull.Action</a></i> <a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#.Action_.A.S.S.E.R.T" title="ti.sdo.ipc.gates.GateMPSupportNull.Action_ASSERT">GateMPSupportNull.Action_ASSERT</a>;
655 </div>
656 <div class="xdocSynSpacer"> </div>
657 <div class="xdocSynCode">
658 <tt> </tt><tt></tt><a class="xdocSynGo" href="#common$">GateMPSupportNull.<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>;
659 </div>
660 <div class='xdocSynHdr'>module-wide functions</div>
662 <div class="xdocSynCode">
663 <tt> </tt><tt></tt><a class="xdocSynGo" href="#get.Num.Resources">GateMPSupportNull.<span class="xdoc-id">getNumResources</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Returns the number of resources offered by the GateMP delegate</span></span></a>() <i>returns</i> <i><span class="xdoc-kw2">UInt</span></i>
664 </div>
665 <div class="xdocSynCode">
666 <tt> </tt><tt></tt><a class="xdocSynGo" href="#query.Meta">GateMPSupportNull.<span class="xdoc-id">queryMeta</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Configuration time test for a particular gate quality</span></span></a>(<i><span class="xdoc-kw2">Int</span></i> <span class="xdoc-id">qual</span>) <i>returns</i> <i><span class="xdoc-kw2">Bool</span></i>
667 </div>
668 <div class='xdocSynHdr'>per-instance config parameters</div>
670 <div class="xdocSynCode">
671 <tt> </tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> GateMPSupportNull.<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>;
672 </div>
673 <div class="xdocSynCode">
674 <tt> </tt><tt> </tt>params.<a class="xdocSynGo" href="#metaresource.Id"><span class="xdoc-id">resourceId</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Logical resource id</span></span></a> = <i><span class="xdoc-kw2">UInt</span></i> 0;
675 </div>
676 <div class="xdocSynCode">
677 <tt> </tt><tt> </tt>params.<a class="xdocSynGo" href="#metashared.Addr"><span class="xdoc-id">sharedAddr</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Physical address of the shared memory</span></span></a> = <i><span class="xdoc-kw2">Ptr</span></i> <span class="xdoc-kw2">null</span>;
678 </div>
679 <div class='xdocSynHdr'>per-instance creation</div>
681 <div class="xdocSynCode">
682 <tt> </tt><tt></tt><span class="xdoc-kw1">var</span> inst = GateMPSupportNull.<a class="xdocSynGo" href="#metaper-instance_creation"><span class="xdoc-id">create</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Create an instance-object</span></span></a>(<i><a class="xdoc-link" href="../../../../xdc/runtime/IGateProvider.html#per-instance_object_types" title="xdc.runtime.IGateProvider.Handle">IGateProvider.Handle</a></i> <span class="xdoc-id">localGate</span>, params);
683 </div>
684 <div class="xdocSynSpacer"> </div>
685 </div>
686 <div id="xdocSep">
687 </div>
688 <div id="xdocMetaElems">
689 <div class="xdocSynSpacer"> </div>
690 <a class="xdocAnchor" id="meta.Q_.B.L.O.C.K.I.N.G"></a>
691 <table class="xdocHdr"><tr>
692 <td class="xdocHdrTitle"><span class="xdoc-kw1">const</span> <span class="xdoc-id">GateMPSupportNull.</span><span class="xdoc-id">Q_BLOCKING</span></td>
693 <td class="xdocHdrArrow">
694 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html" title="module GateMPSupportNull"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
695 </table>
696 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/gates/GateMPSupportNull.html#.Q_.B.L.O.C.K.I.N.G">index URL</a></div>
697 <p class="xdocHdrSummaryDcl">Blocking quality</p>
698 <span id='meta-synop'></span>
699 <table class="xdocLabel"><tr>
700 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
701 <td class="xdocLabelRight"></td>
702 </tr></table>
703 <div class="xdocSynMdcl">
704 <div class="xdocSynCode">
705 <tt></tt><tt></tt><span class="xdoc-kw1">const</span> GateMPSupportNull.<span class="xdoc-id">Q_BLOCKING</span> = 1;
706 </div>
707 </div>
708 <div class="xdocSynSpacer"> </div>
709 <span id="xdoc-sect-1"></span>
710 <div class="xdocSect">DETAILS</div>
711 <div class="xdocText">Gates with this "quality" may cause the calling thread to block;
712 i.e., suspend execution until another thread leaves the gate.</div>
713 <div class="xdocSect">C SYNOPSIS</div>
714 <div class="xdocText"><a class="xdoc-link" href="#.Q_.B.L.O.C.K.I.N.G" title="GateMPSupportNull_Q_BLOCKING">GateMPSupportNull_Q_BLOCKING</a></div>
715 <div class="xdocSynSpacer"> </div>
716 <a class="xdocAnchor" id="meta.Q_.P.R.E.E.M.P.T.I.N.G"></a>
717 <table class="xdocHdr"><tr>
718 <td class="xdocHdrTitle"><span class="xdoc-kw1">const</span> <span class="xdoc-id">GateMPSupportNull.</span><span class="xdoc-id">Q_PREEMPTING</span></td>
719 <td class="xdocHdrArrow">
720 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html" title="module GateMPSupportNull"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
721 </table>
722 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/gates/GateMPSupportNull.html#.Q_.P.R.E.E.M.P.T.I.N.G">index URL</a></div>
723 <p class="xdocHdrSummaryDcl">Preempting quality</p>
724 <span id='meta-synop'></span>
725 <table class="xdocLabel"><tr>
726 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
727 <td class="xdocLabelRight"></td>
728 </tr></table>
729 <div class="xdocSynMdcl">
730 <div class="xdocSynCode">
731 <tt></tt><tt></tt><span class="xdoc-kw1">const</span> GateMPSupportNull.<span class="xdoc-id">Q_PREEMPTING</span> = 2;
732 </div>
733 </div>
734 <div class="xdocSynSpacer"> </div>
735 <span id="xdoc-sect-1"></span>
736 <div class="xdocSect">DETAILS</div>
737 <div class="xdocText">Gates with this "quality" allow other threads to preempt the thread
738 that has already entered the gate.</div>
739 <div class="xdocSect">C SYNOPSIS</div>
740 <div class="xdocText"><a class="xdoc-link" href="#.Q_.P.R.E.E.M.P.T.I.N.G" title="GateMPSupportNull_Q_PREEMPTING">GateMPSupportNull_Q_PREEMPTING</a></div>
741 <div class="xdocSynSpacer"> </div>
742 <a class="xdocAnchor" id="meta.Action"></a>
743 <a class="xdocAnchor" id=".Action_.N.O.N.E"></a>
744 <a class="xdocAnchor" id=".Action_.A.S.S.E.R.T"></a>
745 <table class="xdocHdr"><tr>
746 <td class="xdocHdrTitle"><span class="xdoc-kw1">enum</span> <span class="xdoc-id">GateMPSupportNull.</span><span class="xdoc-id">Action</span></td>
747 <td class="xdocHdrArrow">
748 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html" title="module GateMPSupportNull"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
749 </table>
750 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/gates/GateMPSupportNull.html#.Action">index URL</a></div>
751 <p class="xdocHdrSummaryDcl">Error codes returned by certain calls in GateMP</p>
752 <span id='meta-synop'></span>
753 <table class="xdocLabel"><tr>
754 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
755 <td class="xdocLabelRight"></td>
756 </tr></table>
757 <div class="xdocSynMdcl">
758 <div class="xdocSynCode">
759 <tt></tt><tt></tt><i>values of type GateMPSupportNull.<span class="xdoc-id">Action</span></i>
760 </div>
761 <div class="xdocSynCode">
762 <tt></tt><tt> </tt><span class="xdoc-kw1">const</span> GateMPSupportNull.<span class="xdoc-id">Action_NONE</span>;
763 </div>
764 <div class="xdocSynCode">
765 <tt></tt><tt> </tt><span class="xdoc-kw1">const</span> GateMPSupportNull.<span class="xdoc-id">Action_ASSERT</span>;
766 </div>
767 </div>
768 <div class="xdocSynSpacer"> </div>
769 <div class="xdocSect">C SYNOPSIS</div>
770 <div class="xdocText"><a class="xdoc-link" href="#.Action" title="GateMPSupportNull_Action">GateMPSupportNull_Action</a></div>
771 <div class="xdocSynSpacer"> </div>
772 <a class="xdocAnchor" id="meta.A_invalid.Action"></a>
773 <table class="xdocHdr"><tr>
774 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">GateMPSupportNull.</span><span class="xdoc-id">A_invalidAction</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
775 <td class="xdocHdrArrow">
776 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html" title="module GateMPSupportNull"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
777 </table>
778 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/gates/GateMPSupportNull.html#.A_invalid.Action">index URL</a></div>
779 <p class="xdocHdrSummaryDcl">Assert raised when trying to use GateMPSupportNull's enter or leave</p>
780 <span id='meta-synop'></span>
781 <table class="xdocLabel"><tr>
782 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
783 <td class="xdocLabelRight"></td>
784 </tr></table>
785 <div class="xdocSynMdcl">
786 <div class="xdocSynCode">
787 <tt></tt><tt></tt>GateMPSupportNull.<span class="xdoc-id">A_invalidAction</span> = <i><a class="xdoc-link" href="../../../../xdc/runtime/Assert.html#.Desc" title="xdc.runtime.Assert.Desc">Assert.Desc</a></i> {
788 </div>
789 <div class="xdocSynCode">
790 <tt></tt><tt> </tt>msg: "A_invalidAction: Cannot use ti.sdo.ipc.gates.GateMPSupportNull"
791 </div>
792 <div class="xdocSynCode">
793 <tt></tt><tt></tt>};
794 </div>
795 </div>
796 <div class="xdocSynSpacer"> </div>
797 <div class="xdocSect">C SYNOPSIS</div>
798 <div class="xdocText"><a class="xdoc-link" href="#.A_invalid.Action" title="GateMPSupportNull_A_invalidAction">GateMPSupportNull_A_invalidAction</a></div>
799 <div class="xdocSynSpacer"> </div>
800 <a class="xdocAnchor" id="metaaction"></a>
801 <table class="xdocHdr"><tr>
802 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">GateMPSupportNull.</span><span class="xdoc-id">action</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
803 <td class="xdocHdrArrow">
804 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html" title="module GateMPSupportNull"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
805 </table>
806 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/gates/GateMPSupportNull.html#action">index URL</a></div>
807 <p class="xdocHdrSummaryDcl">Assert if the enter and/or leave is called</p>
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>GateMPSupportNull.<span class="xdoc-id">action</span> = <i><a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#.Action" title="ti.sdo.ipc.gates.GateMPSupportNull.Action">GateMPSupportNull.Action</a></i> <a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#.Action_.A.S.S.E.R.T" title="ti.sdo.ipc.gates.GateMPSupportNull.Action_ASSERT">GateMPSupportNull.Action_ASSERT</a>;
816 </div>
817 </div>
818 <div class="xdocSynSpacer"> </div>
819 <div class="xdocSect">C SYNOPSIS</div>
820 <div class="xdocText"><a class="xdoc-link" href="#action" title="GateMPSupportNull_action">GateMPSupportNull_action</a></div>
821 <div class="xdocSynSpacer"> </div>
822 <a class="xdocAnchor" id="common$"></a>
823 <table class="xdocHdr"><tr>
824 <td class="xdocHdrTitle"><span class="xdoc-kw1">metaonly </span><span class="xdoc-kw1">config</span> <span class="xdoc-id">GateMPSupportNull.</span><span class="xdoc-id">common$</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
825 <td class="xdocHdrArrow">
826 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html" title="module GateMPSupportNull"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
827 </table>
828 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/gates/GateMPSupportNull.html#common$">index URL</a></div>
829 <p class="xdocHdrSummaryDcl">Common module configuration parameters</p>
830 <span id='meta-synop'></span>
831 <table class="xdocLabel"><tr>
832 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
833 <td class="xdocLabelRight"></td>
834 </tr></table>
835 <div class="xdocSynMdcl">
836 <div class="xdocSynCode">
837 <tt></tt><tt></tt>GateMPSupportNull.<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>;
838 </div>
839 </div>
840 <div class="xdocSynSpacer"> </div>
841 <span id="xdoc-sect-1"></span>
842 <div class="xdocSect">DETAILS</div>
843 <div class="xdocText">All modules have this configuration parameter. Its name
844 contains the '$' character to ensure it does not conflict with
845 configuration parameters declared by the module. This allows
846 new configuration parameters to be added in the future without
847 any chance of breaking existing modules.</div>
848 <div class="xdocSynSpacer"> </div>
849 <a class="xdocAnchor" id="get.Num.Resources"></a>
850 <table class="xdocHdr"><tr>
851 <td class="xdocHdrTitle"><span class="xdoc-kw1">metaonly </span><span class="xdoc-id">GateMPSupportNull.</span><span class="xdoc-id">getNumResources</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
852 <td class="xdocHdrArrow">
853 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html" title="module GateMPSupportNull"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
854 </table>
855 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/gates/GateMPSupportNull.html#get.Num.Resources">index URL</a></div>
856 <p class="xdocHdrSummaryDcl">Returns the number of resources offered by the GateMP delegate</p>
857 <span id='meta-synop'></span>
858 <table class="xdocLabel"><tr>
859 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
860 <td class="xdocLabelRight"></td>
861 </tr></table>
862 <div class="xdocSynMdcl">
863 <div class="xdocSynCode">
864 <tt></tt><tt></tt>GateMPSupportNull.<span class="xdoc-id">getNumResources</span>() <i>returns</i> <i><span class="xdoc-kw2">UInt</span></i>
865 </div>
866 </div>
867 <div class="xdocSynSpacer"> </div>
868 <div class="xdocSynSpacer"> </div>
869 <a class="xdocAnchor" id="query.Meta"></a>
870 <table class="xdocHdr"><tr>
871 <td class="xdocHdrTitle"><span class="xdoc-kw1">metaonly </span><span class="xdoc-id">GateMPSupportNull.</span><span class="xdoc-id">queryMeta</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
872 <td class="xdocHdrArrow">
873 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html" title="module GateMPSupportNull"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
874 </table>
875 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/gates/GateMPSupportNull.html#query.Meta">index URL</a></div>
876 <p class="xdocHdrSummaryDcl">Configuration time test for a particular gate quality</p>
877 <span id='meta-synop'></span>
878 <table class="xdocLabel"><tr>
879 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
880 <td class="xdocLabelRight"></td>
881 </tr></table>
882 <div class="xdocSynMdcl">
883 <div class="xdocSynCode">
884 <tt></tt><tt></tt>GateMPSupportNull.<span class="xdoc-id">queryMeta</span>(<i><span class="xdoc-kw2">Int</span></i> <span class="xdoc-id">qual</span>) <i>returns</i> <i><span class="xdoc-kw2">Bool</span></i>
885 </div>
886 </div>
887 <div class="xdocSynSpacer"> </div>
888 <span id="xdoc-sect-1"></span>
889 <div class="xdocSect">ARGUMENTS</div>
890 <div class="xdocChild"><span class="xdocChildId">qual</span>
891 <span class="xdocChildSum">— constant describing a quality</span>
892 </div>
893 <span id="xdoc-sect-2"></span>
894 <div class="xdocSect">RETURNS</div>
895 <div class="xdocText">Returns <tt>TRUE</tt> if the gate has the given quality,
896 and <tt>FALSE</tt> otherwise, which includes the case when the gate does not
897 recognize the constant describing the quality.</div>
898 <a class="xdocAnchor" id="metaper-instance_config_parameters"></a>
899 <table class="xdocHdr"><tr>
900 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Config Parameters</span></td>
901 <td class="xdocHdrArrow">
902 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html" title="module GateMPSupportNull"><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/gates/GateMPSupportNull.html#per-instance_config_parameters">index URL</a></div>
905 <p class="xdocHdrSummary"></p>
906 <span id='meta-synop'></span>
907 <table class="xdocLabel"><tr>
908 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
909 <td class="xdocLabelRight"></td>
910 </tr></table>
911 <div class="xdocSynMdcl">
912 <div class="xdocSynCode">
913 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> GateMPSupportNull.<span class="xdoc-id">Params</span>;
914 </div>
915 <div class='xdocSynSum'><tt></tt><tt></tt>// Instance config-params object</div>
916 <div class="xdocSynCode">
917 <tt></tt><tt> </tt>params.<span class="xdoc-id">resourceId</span> = <i><span class="xdoc-kw2">UInt</span></i> 0;
918 </div>
919 <div class='xdocSynSum'><tt></tt><tt> </tt>// Logical resource id</div>
920 <div class="xdocSynCode">
921 <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>;
922 </div>
923 <div class='xdocSynSum'><tt></tt><tt> </tt>// Physical address of the shared memory</div>
924 </div>
925 <div class="xdocSynSpacer"> </div>
926 <a class="xdocAnchor" id="metaresource.Id"></a>
927 <table class="xdocHdr"><tr>
928 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">GateMPSupportNull.Params.</span><span class="xdoc-id">resourceId</span> <small><span class="xdocSynSum">// instance</span></small></td>
929 <td class="xdocHdrArrow">
930 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html" title="module GateMPSupportNull"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
931 </table>
932 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/gates/GateMPSupportNull.html#resource.Id">index URL</a></div>
933 <p class="xdocHdrSummaryDcl">Logical resource id</p>
934 <span id='meta-synop'></span>
935 <table class="xdocLabel"><tr>
936 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
937 <td class="xdocLabelRight"></td>
938 </tr></table>
939 <div class="xdocSynMdcl">
940 <div class="xdocSynCode">
941 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> GateMPSupportNull.<span class="xdoc-id">Params</span>;
942 </div>
943 <div class="xdocSynCode">
944 <tt></tt><tt></tt><b> ...</b>
945 </div>
946 <div class="xdocSynCode">
947 <tt></tt><tt></tt>params.<span class="xdoc-id">resourceId</span> = <i><span class="xdoc-kw2">UInt</span></i> 0;
948 </div>
949 </div>
950 <div class="xdocSynSpacer"> </div>
951 <div class="xdocSect">C SYNOPSIS</div>
952 <div class="xdocText"><a class="xdoc-link" href="#resource.Id" title="GateMPSupportNull_Params.resourceId">GateMPSupportNull_Params.resourceId</a></div>
953 <div class="xdocSynSpacer"> </div>
954 <a class="xdocAnchor" id="metashared.Addr"></a>
955 <table class="xdocHdr"><tr>
956 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">GateMPSupportNull.Params.</span><span class="xdoc-id">sharedAddr</span> <small><span class="xdocSynSum">// instance</span></small></td>
957 <td class="xdocHdrArrow">
958 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html" title="module GateMPSupportNull"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
959 </table>
960 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/gates/GateMPSupportNull.html#shared.Addr">index URL</a></div>
961 <p class="xdocHdrSummaryDcl">Physical address of the shared memory</p>
962 <span id='meta-synop'></span>
963 <table class="xdocLabel"><tr>
964 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
965 <td class="xdocLabelRight"></td>
966 </tr></table>
967 <div class="xdocSynMdcl">
968 <div class="xdocSynCode">
969 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> GateMPSupportNull.<span class="xdoc-id">Params</span>;
970 </div>
971 <div class="xdocSynCode">
972 <tt></tt><tt></tt><b> ...</b>
973 </div>
974 <div class="xdocSynCode">
975 <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>;
976 </div>
977 </div>
978 <div class="xdocSynSpacer"> </div>
979 <span id="xdoc-sect-1"></span>
980 <div class="xdocSect">DETAILS</div>
981 <div class="xdocText">This parameter is only used by GateMP delegates that use shared memory</div>
982 <div class="xdocSect">C SYNOPSIS</div>
983 <div class="xdocText"><a class="xdoc-link" href="#shared.Addr" title="GateMPSupportNull_Params.sharedAddr">GateMPSupportNull_Params.sharedAddr</a></div>
984 <a class="xdocAnchor" id="metaper-instance_creation"></a>
985 <table class="xdocHdr"><tr>
986 <td class="xdocHdrTitle"><span class="xdocSynSum">Static Instance Creation</span></td>
987 <td class="xdocHdrArrow">
988 <a class="xdocHdrLink" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html" title="module GateMPSupportNull"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
989 </table>
990 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/gates/GateMPSupportNull.html#per-instance_creation">index URL</a></div>
991 <p class="xdocHdrSummary"></p>
992 <span id='meta-synop'></span>
993 <table class="xdocLabel"><tr>
994 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
995 <td class="xdocLabelRight"></td>
996 </tr></table>
997 <div class="xdocSynMdcl">
998 <div class="xdocSynCode">
999 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> GateMPSupportNull.<a class="xdoc-link" href="../../../../ti/sdo/ipc/gates/GateMPSupportNull.html#metaper-instance_config_parameters" title="ti.sdo.ipc.gates.GateMPSupportNull.Params">Params</a>;
1000 </div>
1001 <div class='xdocSynSum'><tt></tt><tt></tt>// Allocate instance config-params</div>
1002 <div class="xdocSynCode">
1003 <tt></tt><tt></tt>params.<i>config</i> = <b> ...</b>
1004 </div>
1005 <div class='xdocSynSum'><tt></tt><tt></tt>// Assign individual configs</div>
1006 <div class="xdocSynSpacer"> </div>
1007 <div class="xdocSynCode">
1008 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> inst = GateMPSupportNull.<span class="xdoc-id">create</span>(<i><a class="xdoc-link" href="../../../../xdc/runtime/IGateProvider.html#per-instance_object_types" title="xdc.runtime.IGateProvider.Handle">IGateProvider.Handle</a></i> <span class="xdoc-id">localGate</span>, params);
1009 </div>
1010 <div class='xdocSynSum'><tt></tt><tt></tt>// Create an instance-object</div>
1011 </div>
1012 <span id="xdoc-sect-1"></span>
1013 <div class="xdocSect">ARGUMENTS</div>
1014 <div class="xdocChild"><span class="xdocChildId">localGate</span>
1015 <span class="xdocChildSum">— Gate to use for local protection.</span>
1016 </div>
1017 <div class="xdocChild"><span class="xdocChildId">params</span>
1018 <span class="xdocChildSum">— per-instance config params, or <tt>NULL</tt> to select default values (target-domain only)</span>
1019 </div>
1020 <div class="xdocChild"><span class="xdocChildId">eb</span>
1021 <span class="xdocChildSum">— active error-handling block, or <tt>NULL</tt> to select default policy (target-domain only)</span>
1022 </div>
1023 <span id="xdoc-sect-2"></span>
1024 <div class="xdocSect">DETAILS</div>
1025 <div class="xdocText">A Non-NULL gate for local protection must be passed to the create
1026 call. If no local protection is desired, a
1027 <a class="xdoc-link" href="../../../../xdc/runtime/GateNull.html" title="xdc.runtime.GateNull">xdc.runtime.GateNull</a> handle must be passed in.</div>
1028 </div>
1029 <div id="xdocDate">generated on Mon, 23 May 2016 14:31:20 GMT</div>
1030 </div></div></body>
1031 </html>