[processor-sdk/performance-audio-sr.git] / psdk_cust / ipc_3_43_00_00_eng / docs / cdoc / ti / ipc / transports / TransportRpmsg.html
1 <html>
2 <head>
3 <title>module ti.ipc.transports.TransportRpmsg</title>
4 <meta name="description" content="Transport for MessageQ that uses vring structures">
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.ipc.transports.</span><span class="xdoc-id">TransportRpmsg</span></td>
10 <td class="xdocHdrArrow">
11 <a class="xdocHdrLink" href="../../../ti/ipc/transports/package.html" title="package ti.ipc.transports"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
12 <td class="xdocHdrArrow">
13 <a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsgSetup.html" title="module TransportRpmsgSetup"><img class="xdocHdrArrow" src="../../../Arrow_right.png"/></a></td>
14 </table>
15 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/transports/TransportRpmsg.html">index URL</a></div>
16 <p class="xdocHdrSummary">Transport for MessageQ that uses vring structures</p>
17 <ul class="xdocToc">
18 <li class="xdocToc"><a class="xdocToc" href="#targ-synop">C synopsis</a></li>
19 <li class="xdocToc2"><a class="xdocToc" href="#xdocElems">Individual elements</a></li>
20 <li class="xdocToc"><a class="xdocToc" href="#meta-synop">Configuration settings</a></li>
21 <li class="xdocToc2"><a class="xdocToc" href="#xdocMetaElems">Individual elements</a></li>
22 </ul>
23 <div class="xdocBrief">
24 This is a <a class="xdoc-link" href="../../../ti/sdo/ipc/MessageQ.html" title="ti.sdo.ipc.MessageQ">ti.sdo.ipc.MessageQ</a> transport that utilizes
25 a pair of vrings (see Linux virtio) to communicate with a remote processor.
26 </div>
27 <span id='targ-synop'></span>
28 <table class="xdocLabel"><tr>
29 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2">C</span></tt> synopsis</td>
30 <td class="xdocLabelCenter">target-domain</td>
31 <td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../ti/ipc/transports/TransportRpmsg-src.html"><span class="xdocLabelFile">ti/ipc/transports/TransportRpmsg.xdc</span></a></td>
32 </tr></table>
33 <div class="xdocSynT">
34 <div class="xdocSynCode">
35 <tt></tt><span class="xdoc-kw3">#include</span> <span class="xdoc-id"><ti/ipc/transports/TransportRpmsg.h></span>
36 </div>
37 <table cellspacing="0" cellpadding="0" border="0">
38 <tr><td colspan='2'><div class='xdocSynTblHdr'>Functions</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_creation"><span class="xdoc-id">TransportRpmsg_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/ipc/transports/TransportRpmsg.html#per-instance_object_types" title="ti.ipc.transports.TransportRpmsg.Struct">TransportRpmsg_Struct</a> *structP, <span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">procId</span>, <span class="xdoc-kw1">const</span> <a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_config_parameters" title="ti.ipc.transports.TransportRpmsg.Params">TransportRpmsg_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>
41 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_object_types" title="ti.ipc.transports.TransportRpmsg.Handle">TransportRpmsg_Handle</a> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_creation"><span class="xdoc-id">TransportRpmsg_create</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Allocate and initialize a new instance object and return its handle</span></span></a>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">procId</span>, <span class="xdoc-kw1">const</span> <a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_config_parameters" title="ti.ipc.transports.TransportRpmsg.Params">TransportRpmsg_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>
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_deletion"><span class="xdoc-id">TransportRpmsg_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/ipc/transports/TransportRpmsg.html#per-instance_object_types" title="ti.ipc.transports.TransportRpmsg.Handle">TransportRpmsg_Handle</a> *handleP);</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_deletion"><span class="xdoc-id">TransportRpmsg_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/ipc/transports/TransportRpmsg.html#per-instance_object_types" title="ti.ipc.transports.TransportRpmsg.Struct">TransportRpmsg_Struct</a> *structP);</div></td></tr>
44 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Void</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_config_parameters"><span class="xdoc-id">TransportRpmsg_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/ipc/transports/TransportRpmsg.html#per-instance_config_parameters" title="ti.ipc.transports.TransportRpmsg.Params">TransportRpmsg_Params</a> *params);</div></td></tr>
45 <tr><td colspan="2"><div class="xdocSynFxnCat">Functions common to all IMessageQTransport modules</div></td></tr>
47 <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="#control"><span class="xdoc-id">TransportRpmsg_control</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Send a control command to the transport instance</span></span></a>(<a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_object_types" title="ti.ipc.transports.TransportRpmsg.Handle">TransportRpmsg_Handle</a> handle, <span class="xdoc-kw2">UInt</span> <span class="xdoc-id">cmd</span>, <span class="xdoc-kw2">UArg</span> <span class="xdoc-id">cmdArg</span>);</div></td></tr>
48 <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="#get.Status"><span class="xdoc-id">TransportRpmsg_getStatus</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Status of a Transport instance</span></span></a>(<a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_object_types" title="ti.ipc.transports.TransportRpmsg.Handle">TransportRpmsg_Handle</a> handle);</div></td></tr>
49 <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="#put"><span class="xdoc-id">TransportRpmsg_put</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Put the message to the remote processor</span></span></a>(<a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_object_types" title="ti.ipc.transports.TransportRpmsg.Handle">TransportRpmsg_Handle</a> handle, <span class="xdoc-kw2">Ptr</span> <span class="xdoc-id">msg</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="#set.Err.Fxn"><span class="xdoc-id">TransportRpmsg_setErrFxn</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Sets the asynchronous error function for the transport module</span></span></a>(<a class="xdoc-link" href="../../../ti/sdo/ipc/interfaces/IMessageQTransport.html#.Err.Fxn" title="ti.sdo.ipc.interfaces.IMessageQTransport.ErrFxn">IMessageQTransport_ErrFxn</a> <span class="xdoc-id">errFxn</span>);</div></td></tr>
51 <tr><td class="xdocSynFxnCat" colspan="2"><div class="xdocSynFxnCat">Functions common to all target instances</div></td></tr>
53 <tr>
54 <td></td>
55 <td>
56 <div class="xdocSynTblPack">
57 <a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">TransportRpmsg_handle</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Convert this instance structure pointer into an instance handle</span></span></a>,
58 <a class="xdocSynGo" href="#per-instance_convertors"><span class="xdoc-id">TransportRpmsg_Handle_downCast</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// conditionally move one level down the inheritance hierarchy; NULL upon failure</span></span></a>,
59 <a class="xdocSynGo" href="#per-instance_convertors"><span class="xdoc-id">TransportRpmsg_Handle_downCast2</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// conditionally move 2 levels down the inheritance hierarchy; NULL upon failure</span></span></a>,
60 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">TransportRpmsg_Handle_label</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The label associated with this instance object</span></span></a>,
61 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">TransportRpmsg_Handle_name</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The name of this instance object</span></span></a>,
62 <a class="xdocSynGo" href="#per-instance_convertors"><span class="xdoc-id">TransportRpmsg_Handle_upCast</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// unconditionally move one level up the inheritance hierarchy</span></span></a>,
63 <a class="xdocSynGo" href="#per-instance_convertors"><span class="xdoc-id">TransportRpmsg_Handle_upCast2</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// unconditionally move 2 levels up the inheritance hierarchy</span></span></a>,
64 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">TransportRpmsg_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">TransportRpmsg_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">TransportRpmsg_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">TransportRpmsg_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">TransportRpmsg_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">TransportRpmsg_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">TransportRpmsg_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">TransportRpmsg_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">TransportRpmsg_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">TransportRpmsg_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">TransportRpmsg_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">TransportRpmsg_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> <span class="xdoc-kw2">Void</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl">(*<a class="xdocSynGo" href="#.Err.Fxn"><span class="xdoc-id">TransportRpmsg_ErrFxn</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Typedef for transport error callback function</span></span></a>)(<a class="xdoc-link" href="../../../ti/sdo/ipc/interfaces/IMessageQTransport.html#.Reason" title="ti.sdo.ipc.interfaces.IMessageQTransport.Reason">IMessageQTransport_Reason</a>,<a class="xdoc-link" href="../../../ti/sdo/ipc/interfaces/IMessageQTransport.html#per-instance_object_types" title="ti.sdo.ipc.interfaces.IMessageQTransport.Handle">IMessageQTransport_Handle</a>,<span class="xdoc-kw2">Ptr</span>,<span class="xdoc-kw2">UArg</span>);</div></td></tr>
91 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">typedef</span> <a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_object_types" title="ti.ipc.transports.TransportRpmsg.Object">TransportRpmsg_Object</a> *</div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">TransportRpmsg_Handle</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Client reference to an instance object</span></span></a>;</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_object_types"><span class="xdoc-id">TransportRpmsg_Object</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Opaque internal representation of an instance object</span></span></a> <span class="xdoc-id">TransportRpmsg_Object</span>;</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_config_parameters"><span class="xdoc-id">TransportRpmsg_Params</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Instance config-params structure</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">enum</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#.Reason"><span class="xdoc-id">TransportRpmsg_Reason</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Reason for error function being called</span></span></a> ...</div></td></tr>
95 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">enum</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#.Status"><span class="xdoc-id">TransportRpmsg_Status</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Transport return values</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">TransportRpmsg_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">TransportRpmsg_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/interfaces/IMessageQTransport.html#.Err.Fxn" title="ti.sdo.ipc.interfaces.IMessageQTransport.ErrFxn">IMessageQTransport_ErrFxn</a> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#err.Fxn"><span class="xdoc-id">TransportRpmsg_errFxn</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Asynchronous error function for the transport module</span></span></a>;</div></td></tr>
100 </table>
101 <div class="xdocSynSpacer"> </div>
102 </div>
103 <div id="xdocSep">
104 </div>
105 <div id="xdocElems">
106 <div class="xdocSynSpacer"> </div>
107 <a class="xdocAnchor" id=".Reason"></a>
108 <a class="xdocAnchor" id=".Reason_.F.A.I.L.E.D.P.U.T"></a>
109 <a class="xdocAnchor" id=".Reason_.I.N.T.E.R.N.A.L.E.R.R"></a>
110 <a class="xdocAnchor" id=".Reason_.P.H.Y.S.I.C.A.L.E.R.R"></a>
111 <a class="xdocAnchor" id=".Reason_.F.A.I.L.E.D.A.L.L.O.C"></a>
112 <table class="xdocHdr"><tr>
113 <td class="xdocHdrTitle"><span class="xdoc-kw1">enum</span> <span class="xdoc-id">TransportRpmsg_</span><span class="xdoc-id">Reason</span></td>
114 <td class="xdocHdrArrow">
115 <a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsg.html" title="module TransportRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
116 </table>
117 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/transports/TransportRpmsg.html#.Reason">index URL</a></div>
118 <p class="xdocHdrSummaryDcl">Reason for error function being called</p>
119 <span id='targ-synop'></span>
120 <table class="xdocLabel"><tr>
121 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
122 <td class="xdocLabelRight">target-domain</td>
123 </tr></table>
124 <div class="xdocSynTdcl">
125 <div class="xdocSynCode">
126 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">enum</span> <span class="xdoc-id">TransportRpmsg_Reason</span> {
127 </div>
128 <div class="xdocSynCode">
129 <tt></tt><tt> </tt><span class="xdoc-id">TransportRpmsg_Reason_FAILEDPUT</span>,
130 </div>
131 <div class="xdocSynCode">
132 <tt></tt><tt> </tt><span class="xdoc-id">TransportRpmsg_Reason_INTERNALERR</span>,
133 </div>
134 <div class="xdocSynCode">
135 <tt></tt><tt> </tt><span class="xdoc-id">TransportRpmsg_Reason_PHYSICALERR</span>,
136 </div>
137 <div class="xdocSynCode">
138 <tt></tt><tt> </tt><span class="xdoc-id">TransportRpmsg_Reason_FAILEDALLOC</span>
139 </div>
140 <div class="xdocSynCode">
141 <tt></tt><tt></tt>} <span class="xdoc-id">TransportRpmsg_Reason</span>;
142 </div>
143 </div>
144 <div class="xdocSynSpacer"> </div>
145 <span id="xdoc-sect-1"></span>
146 <div class="xdocSect">DETAILS</div>
147 <div class="xdocText">First field in the <a class="xdoc-link" href="TransportRpmsg.html#err.Fxn" title="errFxn">errFxn</a></div>
148 <div class="xdocSynSpacer"> </div>
149 <a class="xdocAnchor" id=".Status"></a>
150 <a class="xdocAnchor" id=".S_.S.U.C.C.E.S.S"></a>
151 <a class="xdocAnchor" id=".E_.F.A.I.L"></a>
152 <a class="xdocAnchor" id=".E_.E.R.R.O.R"></a>
153 <table class="xdocHdr"><tr>
154 <td class="xdocHdrTitle"><span class="xdoc-kw1">enum</span> <span class="xdoc-id">TransportRpmsg_</span><span class="xdoc-id">Status</span></td>
155 <td class="xdocHdrArrow">
156 <a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsg.html" title="module TransportRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
157 </table>
158 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/transports/TransportRpmsg.html#.Status">index URL</a></div>
159 <p class="xdocHdrSummaryDcl">Transport return values</p>
160 <span id='targ-synop'></span>
161 <table class="xdocLabel"><tr>
162 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
163 <td class="xdocLabelRight">target-domain</td>
164 </tr></table>
165 <div class="xdocSynTdcl">
166 <div class="xdocSynCode">
167 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">enum</span> <span class="xdoc-id">TransportRpmsg_Status</span> {
168 </div>
169 <div class="xdocSynCode">
170 <tt></tt><tt> </tt><span class="xdoc-id">TransportRpmsg_S_SUCCESS</span>,
171 </div>
172 <div class="xdocSynCode">
173 <tt></tt><tt> </tt><span class="xdoc-id">TransportRpmsg_E_FAIL</span>,
174 </div>
175 <div class="xdocSynCode">
176 <tt></tt><tt> </tt><span class="xdoc-id">TransportRpmsg_E_ERROR</span>
177 </div>
178 <div class="xdocSynCode">
179 <tt></tt><tt></tt>} <span class="xdoc-id">TransportRpmsg_Status</span>;
180 </div>
181 </div>
182 <div class="xdocSynSpacer"> </div>
183 <span id="xdoc-sect-1"></span>
184 <div class="xdocSect">DETAILS</div>
185 <div class="xdocText"><UL><LI><a class="xdoc-link" href="TransportRpmsg.html#.S_.S.U.C.C.E.S.S" title="S_SUCCESS">S_SUCCESS</a>: Operation was successful
186 </LI><LI><a class="xdoc-link" href="TransportRpmsg.html#.E_.F.A.I.L" title="E_FAIL">E_FAIL</a>: Operation resulted in a failure
187 </LI><LI><a class="xdoc-link" href="TransportRpmsg.html#.E_.E.R.R.O.R" title="E_ERROR">E_ERROR</a>: Operation resulted in an error.
188 </LI></UL></div>
189 <div class="xdocSynSpacer"> </div>
190 <a class="xdocAnchor" id=".Err.Fxn"></a>
191 <table class="xdocHdr"><tr>
192 <td class="xdocHdrTitle"><span class="xdoc-kw1">typedef</span> <span class="xdoc-id">TransportRpmsg_</span><span class="xdoc-id">ErrFxn</span></td>
193 <td class="xdocHdrArrow">
194 <a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsg.html" title="module TransportRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
195 </table>
196 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/transports/TransportRpmsg.html#.Err.Fxn">index URL</a></div>
197 <p class="xdocHdrSummaryDcl">Typedef for transport error callback function</p>
198 <span id='targ-synop'></span>
199 <table class="xdocLabel"><tr>
200 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
201 <td class="xdocLabelRight">target-domain</td>
202 </tr></table>
203 <div class="xdocSynTdcl">
204 <div class="xdocSynCode">
205 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw2">Void</span> (*<span class="xdoc-id">TransportRpmsg_ErrFxn</span>)(<a class="xdoc-link" href="../../../ti/sdo/ipc/interfaces/IMessageQTransport.html#.Reason" title="ti.sdo.ipc.interfaces.IMessageQTransport.Reason">IMessageQTransport_Reason</a>,<a class="xdoc-link" href="../../../ti/sdo/ipc/interfaces/IMessageQTransport.html#per-instance_object_types" title="ti.sdo.ipc.interfaces.IMessageQTransport.Handle">IMessageQTransport_Handle</a>,<span class="xdoc-kw2">Ptr</span>,<span class="xdoc-kw2">UArg</span>);
206 </div>
207 </div>
208 <div class="xdocSynSpacer"> </div>
209 <span id="xdoc-sect-1"></span>
210 <div class="xdocSect">DETAILS</div>
211 <div class="xdocText">First parameter: Why the error function is being called.</div>
212 <div class="xdocText">Second parameter: Handle of transport that had the error. NULL denotes
213 that it is a system error, not a specific transport.</div>
214 <div class="xdocText">Third parameter: Pointer to the message. This is only valid for
215 <a class="xdoc-link" href="TransportRpmsg.html#.Reason_.F.A.I.L.E.D.P.U.T" title="Reason_FAILEDPUT">Reason_FAILEDPUT</a>.</div>
216 <div class="xdocText">Fourth parameter: Transport specific information. Refer to individual
217 transports for more details.</div>
218 <div class="xdocSynSpacer"> </div>
219 <a class="xdocAnchor" id="err.Fxn"></a>
220 <table class="xdocHdr"><tr>
221 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">TransportRpmsg_</span><span class="xdoc-id">errFxn</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
222 <td class="xdocHdrArrow">
223 <a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsg.html" title="module TransportRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
224 </table>
225 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/transports/TransportRpmsg.html#err.Fxn">index URL</a></div>
226 <p class="xdocHdrSummaryDcl">Asynchronous error function for the transport module</p>
227 <span id='targ-synop'></span>
228 <table class="xdocLabel"><tr>
229 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
230 <td class="xdocLabelRight">target-domain</td>
231 </tr></table>
232 <div class="xdocSynTdcl">
233 <div class="xdocSynCode">
234 <tt></tt><tt></tt><span class="xdoc-kw1">extern const</span> <a class="xdoc-link" href="../../../ti/sdo/ipc/interfaces/IMessageQTransport.html#.Err.Fxn" title="ti.sdo.ipc.interfaces.IMessageQTransport.ErrFxn">IMessageQTransport_ErrFxn</a> <span class="xdoc-id">TransportRpmsg_errFxn</span>;
235 </div>
236 </div>
237 <div class="xdocSynSpacer"> </div>
238 <div class="xdocSynSpacer"> </div>
239 <a class="xdocAnchor" id="set.Err.Fxn"></a>
240 <table class="xdocHdr"><tr>
241 <td class="xdocHdrTitle"><span class="xdoc-id">TransportRpmsg_</span><span class="xdoc-id">setErrFxn</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
242 <td class="xdocHdrArrow">
243 <a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsg.html" title="module TransportRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
244 </table>
245 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/transports/TransportRpmsg.html#set.Err.Fxn">index URL</a></div>
246 <p class="xdocHdrSummaryDcl">Sets the asynchronous error function for the transport module</p>
247 <span id='targ-synop'></span>
248 <table class="xdocLabel"><tr>
249 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
250 <td class="xdocLabelRight">target-domain</td>
251 </tr></table>
252 <div class="xdocSynTdcl">
253 <div class="xdocSynCode">
254 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">TransportRpmsg_setErrFxn</span>(<a class="xdoc-link" href="../../../ti/sdo/ipc/interfaces/IMessageQTransport.html#.Err.Fxn" title="ti.sdo.ipc.interfaces.IMessageQTransport.ErrFxn">IMessageQTransport_ErrFxn</a> <span class="xdoc-id">errFxn</span>);
255 </div>
256 </div>
257 <div class="xdocSynSpacer"> </div>
258 <span id="xdoc-sect-1"></span>
259 <div class="xdocSect">ARGUMENTS</div>
260 <div class="xdocChild"><span class="xdocChildId">errFxn</span>
261 <span class="xdocChildSum">— Function that is called when an asynchronous
262 error occurs.</span>
263 </div>
264 <span id="xdoc-sect-2"></span>
265 <div class="xdocSect">DETAILS</div>
266 <div class="xdocText">This API allows the user to set the function that will be called in
267 case of an asynchronous error by the transport.</div>
268 <a class="xdocAnchor" id="module-wide_built-ins"></a>
269 <table class="xdocHdr"><tr>
270 <td class="xdocHdrTitle"><span class="xdocSynSum">Module-Wide Built-Ins</span></td>
271 <td class="xdocHdrArrow">
272 <a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsg.html" title="module TransportRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
273 </table>
274 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/transports/TransportRpmsg.html#module-wide_built-ins">index URL</a></div>
275 <p class="xdocHdrSummary"></p>
276 <span id='targ-synop'></span>
277 <table class="xdocLabel"><tr>
278 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
279 <td class="xdocLabelRight">target-domain</td>
280 </tr></table>
281 <div class="xdocSynTdcl">
282 <div class="xdocSynCode">
283 <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">TransportRpmsg_Module_id</span>();
284 </div>
285 <div class='xdocSynSum'><tt></tt><tt></tt>// Get this module's unique id</div>
286 <div class="xdocSynSpacer"> </div>
287 <div class="xdocSynCode">
288 <tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">TransportRpmsg_Module_startupDone</span>();
289 </div>
290 <div class='xdocSynSum'><tt></tt><tt></tt>// Test if this module has completed startup</div>
291 <div class="xdocSynSpacer"> </div>
292 <div class="xdocSynCode">
293 <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">TransportRpmsg_Module_heap</span>();
294 </div>
295 <div class='xdocSynSum'><tt></tt><tt></tt>// The heap from which this module allocates memory</div>
296 <div class="xdocSynSpacer"> </div>
297 <div class="xdocSynCode">
298 <tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">TransportRpmsg_Module_hasMask</span>();
299 </div>
300 <div class='xdocSynSum'><tt></tt><tt></tt>// Test whether this module has a diagnostics mask</div>
301 <div class="xdocSynSpacer"> </div>
302 <div class="xdocSynCode">
303 <tt></tt><tt></tt><span class="xdoc-kw2">Bits16</span> <span class="xdoc-id">TransportRpmsg_Module_getMask</span>();
304 </div>
305 <div class='xdocSynSum'><tt></tt><tt></tt>// Returns the diagnostics mask for this module</div>
306 <div class="xdocSynSpacer"> </div>
307 <div class="xdocSynCode">
308 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">TransportRpmsg_Module_setMask</span>(<span class="xdoc-kw2">Bits16</span> <span class="xdoc-id">mask</span>);
309 </div>
310 <div class='xdocSynSum'><tt></tt><tt></tt>// Set the diagnostics mask for this module</div>
311 </div>
312 <a class="xdocAnchor" id="per-instance_object_types"></a>
313 <table class="xdocHdr"><tr>
314 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Object Types</span></td>
315 <td class="xdocHdrArrow">
316 <a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsg.html" title="module TransportRpmsg"><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/ipc/transports/TransportRpmsg.html#per-instance_object_types">index URL</a></div>
319 <p class="xdocHdrSummary"></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">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">TransportRpmsg_Object</span> <span class="xdoc-id">TransportRpmsg_Object</span>;
328 </div>
329 <div class='xdocSynSum'><tt></tt><tt></tt>// Opaque internal representation of an instance object</div>
330 <div class="xdocSynSpacer"> </div>
331 <div class="xdocSynCode">
332 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_object_types" title="ti.ipc.transports.TransportRpmsg.Object">TransportRpmsg_Object</a> *<span class="xdoc-id">TransportRpmsg_Handle</span>;
333 </div>
334 <div class='xdocSynSum'><tt></tt><tt></tt>// Client reference to an instance object</div>
335 <div class="xdocSynSpacer"> </div>
336 <div class="xdocSynCode">
337 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">TransportRpmsg_Struct</span> <span class="xdoc-id">TransportRpmsg_Struct</span>;
338 </div>
339 <div class='xdocSynSum'><tt></tt><tt></tt>// Opaque client structure large enough to hold an instance object</div>
340 <div class="xdocSynSpacer"> </div>
341 <div class="xdocSynCode">
342 <tt></tt><tt></tt><a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_object_types" title="ti.ipc.transports.TransportRpmsg.Handle">TransportRpmsg_Handle</a> <span class="xdoc-id">TransportRpmsg_handle</span>(<a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_object_types" title="ti.ipc.transports.TransportRpmsg.Struct">TransportRpmsg_Struct</a> *structP);
343 </div>
344 <div class='xdocSynSum'><tt></tt><tt></tt>// Convert this instance structure pointer into an instance handle</div>
345 <div class="xdocSynSpacer"> </div>
346 <div class="xdocSynCode">
347 <tt></tt><tt></tt><a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_object_types" title="ti.ipc.transports.TransportRpmsg.Struct">TransportRpmsg_Struct</a> *<span class="xdoc-id">TransportRpmsg_struct</span>(<a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_object_types" title="ti.ipc.transports.TransportRpmsg.Handle">TransportRpmsg_Handle</a> handle);
348 </div>
349 <div class='xdocSynSum'><tt></tt><tt></tt>// Convert this instance handle into an instance structure pointer</div>
350 </div>
351 <a class="xdocAnchor" id="per-instance_config_parameters"></a>
352 <table class="xdocHdr"><tr>
353 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Config Parameters</span></td>
354 <td class="xdocHdrArrow">
355 <a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsg.html" title="module TransportRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
356 </table>
357 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/transports/TransportRpmsg.html#per-instance_config_parameters">index URL</a></div>
358 <p class="xdocHdrSummary"></p>
359 <span id='targ-synop'></span>
360 <table class="xdocLabel"><tr>
361 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
362 <td class="xdocLabelRight">target-domain</td>
363 </tr></table>
364 <div class="xdocSynTdcl">
365 <div class="xdocSynCode">
366 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">TransportRpmsg_Params</span> {
367 </div>
368 <div class='xdocSynSum'><tt></tt><tt></tt>// Instance config-params structure</div>
369 <div class="xdocSynCode">
370 <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;
371 </div>
372 <div class='xdocSynSum'><tt></tt><tt> </tt>// Common per-instance configs</div>
373 <div class="xdocSynCode">
374 <tt></tt><tt> </tt><span class="xdoc-kw2">UInt</span> <span class="xdoc-id">priority</span>;
375 </div>
376 <div class='xdocSynSum'><tt></tt><tt> </tt>// Which priority messages should this transport manage</div>
377 <div class="xdocSynCode">
378 <tt></tt><tt> </tt><span class="xdoc-kw2">Ptr</span> <span class="xdoc-id">sharedAddr</span>;
379 </div>
380 <div class='xdocSynSum'><tt></tt><tt> </tt>// Address in shared memory where this instance will be placed</div>
381 <div class="xdocSynCode">
382 <tt></tt><tt></tt>} <span class="xdoc-id">TransportRpmsg_Params</span>;
383 </div>
384 <div class="xdocSynSpacer"> </div>
385 <div class="xdocSynCode">
386 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">TransportRpmsg_Params_init</span>(<a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_config_parameters" title="ti.ipc.transports.TransportRpmsg.Params">TransportRpmsg_Params</a> *params);
387 </div>
388 <div class='xdocSynSum'><tt></tt><tt></tt>// Initialize this config-params structure with supplier-specified defaults before instance creation</div>
389 </div>
390 <div class="xdocSynSpacer"> </div>
391 <a class="xdocAnchor" id="priority"></a>
392 <table class="xdocHdr"><tr>
393 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">TransportRpmsg_Params.</span><span class="xdoc-id">priority</span> <small><span class="xdocSynSum">// instance</span></small></td>
394 <td class="xdocHdrArrow">
395 <a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsg.html" title="module TransportRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
396 </table>
397 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/transports/TransportRpmsg.html#priority">index URL</a></div>
398 <p class="xdocHdrSummaryDcl">Which priority messages should this transport manage</p>
399 <span id='targ-synop'></span>
400 <table class="xdocLabel"><tr>
401 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
402 <td class="xdocLabelRight">target-domain</td>
403 </tr></table>
404 <div class="xdocSynTdcl">
405 <div class="xdocSynCode">
406 <tt></tt><tt></tt><span class="xdoc-kw1">struct</span> <a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_config_parameters" title="ti.ipc.transports.TransportRpmsg.Params">TransportRpmsg_Params</a> {
407 </div>
408 <div class="xdocSynCode">
409 <tt></tt><tt> </tt><b> ...</b>
410 </div>
411 <div class="xdocSynCode">
412 <tt></tt><tt> </tt><span class="xdoc-kw2">UInt</span> <span class="xdoc-id">priority</span>;
413 </div>
414 </div>
415 <div class="xdocSynSpacer"> </div>
416 <div class="xdocSynSpacer"> </div>
417 <a class="xdocAnchor" id="shared.Addr"></a>
418 <table class="xdocHdr"><tr>
419 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">TransportRpmsg_Params.</span><span class="xdoc-id">sharedAddr</span> <small><span class="xdocSynSum">// instance</span></small></td>
420 <td class="xdocHdrArrow">
421 <a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsg.html" title="module TransportRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
422 </table>
423 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/transports/TransportRpmsg.html#shared.Addr">index URL</a></div>
424 <p class="xdocHdrSummaryDcl">Address in shared memory where this instance will be placed</p>
425 <span id='targ-synop'></span>
426 <table class="xdocLabel"><tr>
427 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
428 <td class="xdocLabelRight">target-domain</td>
429 </tr></table>
430 <div class="xdocSynTdcl">
431 <div class="xdocSynCode">
432 <tt></tt><tt></tt><span class="xdoc-kw1">struct</span> <a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_config_parameters" title="ti.ipc.transports.TransportRpmsg.Params">TransportRpmsg_Params</a> {
433 </div>
434 <div class="xdocSynCode">
435 <tt></tt><tt> </tt><b> ...</b>
436 </div>
437 <div class="xdocSynCode">
438 <tt></tt><tt> </tt><span class="xdoc-kw2">Ptr</span> <span class="xdoc-id">sharedAddr</span>;
439 </div>
440 </div>
441 <div class="xdocSynSpacer"> </div>
442 <a class="xdocAnchor" id="per-instance_creation"></a>
443 <table class="xdocHdr"><tr>
444 <td class="xdocHdrTitle"><span class="xdocSynSum">Runtime Instance Creation</span></td>
445 <td class="xdocHdrArrow">
446 <a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsg.html" title="module TransportRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
447 </table>
448 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/transports/TransportRpmsg.html#per-instance_creation">index URL</a></div>
449 <p class="xdocHdrSummary"></p>
450 <span id='targ-synop'></span>
451 <table class="xdocLabel"><tr>
452 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
453 <td class="xdocLabelRight">target-domain</td>
454 </tr></table>
455 <div class="xdocSynTdcl">
456 <div class="xdocSynCode">
457 <tt></tt><tt></tt><a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_object_types" title="ti.ipc.transports.TransportRpmsg.Handle">TransportRpmsg_Handle</a> <span class="xdoc-id">TransportRpmsg_create</span>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">procId</span>, <span class="xdoc-kw1">const</span> <a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_config_parameters" title="ti.ipc.transports.TransportRpmsg.Params">TransportRpmsg_Params</a> *params, <a class="xdoc-link" href="../../../xdc/runtime/Error.html#.Block" title="xdc.runtime.Error.Block">Error_Block</a> *eb);
458 </div>
459 <div class='xdocSynSum'><tt></tt><tt></tt>// Allocate and initialize a new instance object and return its handle</div>
460 <div class="xdocSynSpacer"> </div>
461 <div class="xdocSynCode">
462 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">TransportRpmsg_construct</span>(<a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_object_types" title="ti.ipc.transports.TransportRpmsg.Struct">TransportRpmsg_Struct</a> *structP, <span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">procId</span>, <span class="xdoc-kw1">const</span> <a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_config_parameters" title="ti.ipc.transports.TransportRpmsg.Params">TransportRpmsg_Params</a> *params, <a class="xdoc-link" href="../../../xdc/runtime/Error.html#.Block" title="xdc.runtime.Error.Block">Error_Block</a> *eb);
463 </div>
464 <div class='xdocSynSum'><tt></tt><tt></tt>// Initialize a new instance object inside the provided structure</div>
465 </div>
466 <span id="xdoc-sect-1"></span>
467 <div class="xdocSect">ARGUMENTS</div>
468 <div class="xdocChild"><span class="xdocChildId">procId</span>
469 <span class="xdocChildSum">— Remote processor id that this instance
470 will communicate with.</span>
471 </div>
472 <div class="xdocChild"><span class="xdocChildId">params</span>
473 <span class="xdocChildSum">— per-instance config params, or <tt>NULL</tt> to select default values (target-domain only)</span>
474 </div>
475 <div class="xdocChild"><span class="xdocChildId">eb</span>
476 <span class="xdocChildSum">— active error-handling block, or <tt>NULL</tt> to select default policy (target-domain only)</span>
477 </div>
478 <span id="xdoc-sect-2"></span>
479 <div class="xdocSect">DETAILS</div>
480 <div class="xdocText">This function creates a transport instance. The transport is
481 responsible for registering with MessageQ via the
482 <a class="xdoc-link" href="../../../ti/sdo/ipc/MessageQ.html#register.Transport" title="ti.sdo.ipc.MessageQ.registerTransport">ti.sdo.ipc.MessageQ.registerTransport</a> API.</div>
483 <a class="xdocAnchor" id="per-instance_deletion"></a>
484 <table class="xdocHdr"><tr>
485 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Deletion</span></td>
486 <td class="xdocHdrArrow">
487 <a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsg.html" title="module TransportRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
488 </table>
489 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/transports/TransportRpmsg.html#per-instance_deletion">index URL</a></div>
490 <p class="xdocHdrSummary"></p>
491 <span id='targ-synop'></span>
492 <table class="xdocLabel"><tr>
493 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
494 <td class="xdocLabelRight">target-domain</td>
495 </tr></table>
496 <div class="xdocSynTdcl">
497 <div class="xdocSynCode">
498 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">TransportRpmsg_delete</span>(<a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_object_types" title="ti.ipc.transports.TransportRpmsg.Handle">TransportRpmsg_Handle</a> *handleP);
499 </div>
500 <div class='xdocSynSum'><tt></tt><tt></tt>// Finalize and free this previously allocated instance object, setting the referenced handle to NULL</div>
501 <div class="xdocSynSpacer"> </div>
502 <div class="xdocSynCode">
503 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">TransportRpmsg_destruct</span>(<a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_object_types" title="ti.ipc.transports.TransportRpmsg.Struct">TransportRpmsg_Struct</a> *structP);
504 </div>
505 <div class='xdocSynSum'><tt></tt><tt></tt>// Finalize the instance object inside the provided structure</div>
506 </div>
507 <div class="xdocSynSpacer"> </div>
508 <a class="xdocAnchor" id="control"></a>
509 <table class="xdocHdr"><tr>
510 <td class="xdocHdrTitle"><span class="xdoc-id">TransportRpmsg_</span><span class="xdoc-id">control</span>() <small><span class="xdocSynSum">// instance</span></small></td>
511 <td class="xdocHdrArrow">
512 <a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsg.html" title="module TransportRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
513 </table>
514 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/transports/TransportRpmsg.html#control">index URL</a></div>
515 <p class="xdocHdrSummaryDcl">Send a control command to the transport instance</p>
516 <span id='targ-synop'></span>
517 <table class="xdocLabel"><tr>
518 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
519 <td class="xdocLabelRight">target-domain</td>
520 </tr></table>
521 <div class="xdocSynTdcl">
522 <div class="xdocSynCode">
523 <tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">TransportRpmsg_control</span>(<a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_object_types" title="ti.ipc.transports.TransportRpmsg.Handle">TransportRpmsg_Handle</a> handle, <span class="xdoc-kw2">UInt</span> <span class="xdoc-id">cmd</span>, <span class="xdoc-kw2">UArg</span> <span class="xdoc-id">cmdArg</span>);
524 </div>
525 </div>
526 <div class="xdocSynSpacer"> </div>
527 <span id="xdoc-sect-1"></span>
528 <div class="xdocSect">ARGUMENTS</div>
529 <div class="xdocChild"><span class="xdocChildId">handle</span>
530 <span class="xdocChildSum">— handle of a previously-created <tt>TransportRpmsg</tt> instance object</span>
531 </div>
532 <div class="xdocChild"><span class="xdocChildId">cmd</span>
533 <span class="xdocChildSum">— Requested command</span>
534 </div>
535 <div class="xdocChild"><span class="xdocChildId">cmdArgs</span>
536 <span class="xdocChildSum">— Accompanying field for the command. This is
537 command specific.</span>
538 </div>
539 <span id="xdoc-sect-2"></span>
540 <div class="xdocSect">RETURNS</div>
541 <div class="xdocText">TRUE denotes acceptance of the command. FALSE
542 denotes failure of the command.</div>
543 <span id="xdoc-sect-3"></span>
544 <div class="xdocSect">DETAILS</div>
545 <div class="xdocText">This is function allows transport to specify control commands. Refer
546 to individual transport implementions for more details.</div>
547 <div class="xdocSynSpacer"> </div>
548 <a class="xdocAnchor" id="get.Status"></a>
549 <table class="xdocHdr"><tr>
550 <td class="xdocHdrTitle"><span class="xdoc-id">TransportRpmsg_</span><span class="xdoc-id">getStatus</span>() <small><span class="xdocSynSum">// instance</span></small></td>
551 <td class="xdocHdrArrow">
552 <a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsg.html" title="module TransportRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
553 </table>
554 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/transports/TransportRpmsg.html#get.Status">index URL</a></div>
555 <p class="xdocHdrSummaryDcl">Status of a Transport instance</p>
556 <span id='targ-synop'></span>
557 <table class="xdocLabel"><tr>
558 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
559 <td class="xdocLabelRight">target-domain</td>
560 </tr></table>
561 <div class="xdocSynTdcl">
562 <div class="xdocSynCode">
563 <tt></tt><tt></tt><span class="xdoc-kw2">Int</span> <span class="xdoc-id">TransportRpmsg_getStatus</span>(<a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_object_types" title="ti.ipc.transports.TransportRpmsg.Handle">TransportRpmsg_Handle</a> handle);
564 </div>
565 </div>
566 <div class="xdocSynSpacer"> </div>
567 <span id="xdoc-sect-1"></span>
568 <div class="xdocSect">ARGUMENTS</div>
569 <div class="xdocChild"><span class="xdocChildId">handle</span>
570 <span class="xdocChildSum">— handle of a previously-created <tt>TransportRpmsg</tt> instance object</span>
571 </div>
572 <span id="xdoc-sect-2"></span>
573 <div class="xdocSect">RETURNS</div>
574 <div class="xdocText">Returns status of Transport instance</div>
575 <span id="xdoc-sect-3"></span>
576 <div class="xdocSect">DETAILS</div>
577 <div class="xdocText">This function returns the status of the transport instance.</div>
578 <div class="xdocSynSpacer"> </div>
579 <a class="xdocAnchor" id="put"></a>
580 <table class="xdocHdr"><tr>
581 <td class="xdocHdrTitle"><span class="xdoc-id">TransportRpmsg_</span><span class="xdoc-id">put</span>() <small><span class="xdocSynSum">// instance</span></small></td>
582 <td class="xdocHdrArrow">
583 <a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsg.html" title="module TransportRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
584 </table>
585 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/transports/TransportRpmsg.html#put">index URL</a></div>
586 <p class="xdocHdrSummaryDcl">Put the message to the remote processor</p>
587 <span id='targ-synop'></span>
588 <table class="xdocLabel"><tr>
589 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
590 <td class="xdocLabelRight">target-domain</td>
591 </tr></table>
592 <div class="xdocSynTdcl">
593 <div class="xdocSynCode">
594 <tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">TransportRpmsg_put</span>(<a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_object_types" title="ti.ipc.transports.TransportRpmsg.Handle">TransportRpmsg_Handle</a> handle, <span class="xdoc-kw2">Ptr</span> <span class="xdoc-id">msg</span>);
595 </div>
596 </div>
597 <div class="xdocSynSpacer"> </div>
598 <span id="xdoc-sect-1"></span>
599 <div class="xdocSect">ARGUMENTS</div>
600 <div class="xdocChild"><span class="xdocChildId">handle</span>
601 <span class="xdocChildSum">— handle of a previously-created <tt>TransportRpmsg</tt> instance object</span>
602 </div>
603 <div class="xdocChild"><span class="xdocChildId">msg</span>
604 <span class="xdocChildSum">— Pointer the message to be sent</span>
605 </div>
606 <span id="xdoc-sect-2"></span>
607 <div class="xdocSect">RETURNS</div>
608 <div class="xdocText">TRUE denotes acceptance of the message to
609 be sent. FALSE denotes the message could not be
610 sent.</div>
611 <span id="xdoc-sect-3"></span>
612 <div class="xdocSect">DETAILS</div>
613 <div class="xdocText">If the transport can accept the message, it returns TRUE. Accepting
614 a message does not mean that it is transmitted. It simply means that
615 the transport should be able to send the message. If the actual transfer
616 fails, the transport calls the {@#ErrFxn} (assuming it is set up via the
617 {@#setErrFxn} API. If the {@#ErrFxn} is not set, the message is dropped.
618 (also...should an error be raised or just System_printf?).</div>
619 <div class="xdocText">If the transport cannot send the message, it returns FALSE and a
620 filled in Error_Block. The caller still owns the message.</div>
621 <a class="xdocAnchor" id="per-instance_convertors"></a>
622 <table class="xdocHdr"><tr>
623 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Convertors</span></td>
624 <td class="xdocHdrArrow">
625 <a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsg.html" title="module TransportRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
626 </table>
627 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/transports/TransportRpmsg.html#per-instance_convertors">index URL</a></div>
628 <p class="xdocHdrSummary"></p>
629 <span id='targ-synop'></span>
630 <table class="xdocLabel"><tr>
631 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
632 <td class="xdocLabelRight">target-domain</td>
633 </tr></table>
634 <div class="xdocSynTdcl">
635 <div class="xdocSynCode">
636 <tt></tt><tt></tt><a class="xdoc-link" href="../../../ti/sdo/ipc/interfaces/IMessageQTransport.html#per-instance_object_types" title="ti.sdo.ipc.interfaces.IMessageQTransport.Handle">IMessageQTransport_Handle</a> <span class="xdoc-id">TransportRpmsg_Handle_upCast</span>(<a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_object_types" title="ti.ipc.transports.TransportRpmsg.Handle">TransportRpmsg_Handle</a> handle);
637 </div>
638 <div class='xdocSynSum'><tt></tt><tt></tt>// unconditionally move one level up the inheritance hierarchy</div>
639 <div class="xdocSynSpacer"> </div>
640 <div class="xdocSynCode">
641 <tt></tt><tt></tt><a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_object_types" title="ti.ipc.transports.TransportRpmsg.Handle">TransportRpmsg_Handle</a> <span class="xdoc-id">TransportRpmsg_Handle_downCast</span>(<a class="xdoc-link" href="../../../ti/sdo/ipc/interfaces/IMessageQTransport.html#per-instance_object_types" title="ti.sdo.ipc.interfaces.IMessageQTransport.Handle">IMessageQTransport_Handle</a> handle);
642 </div>
643 <div class='xdocSynSum'><tt></tt><tt></tt>// conditionally move one level down the inheritance hierarchy; NULL upon failure</div>
644 <div class="xdocSynSpacer"> </div>
645 <div class="xdocSynCode">
646 <tt></tt><tt></tt><a class="xdoc-link" href="../../../ti/sdo/ipc/interfaces/ITransport.html#per-instance_object_types" title="ti.sdo.ipc.interfaces.ITransport.Handle">ITransport_Handle</a> <span class="xdoc-id">TransportRpmsg_Handle_upCast2</span>(<a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_object_types" title="ti.ipc.transports.TransportRpmsg.Handle">TransportRpmsg_Handle</a> handle);
647 </div>
648 <div class='xdocSynSum'><tt></tt><tt></tt>// unconditionally move 2 levels up the inheritance hierarchy</div>
649 <div class="xdocSynSpacer"> </div>
650 <div class="xdocSynCode">
651 <tt></tt><tt></tt><a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_object_types" title="ti.ipc.transports.TransportRpmsg.Handle">TransportRpmsg_Handle</a> <span class="xdoc-id">TransportRpmsg_Handle_downCast2</span>(<a class="xdoc-link" href="../../../ti/sdo/ipc/interfaces/ITransport.html#per-instance_object_types" title="ti.sdo.ipc.interfaces.ITransport.Handle">ITransport_Handle</a> handle);
652 </div>
653 <div class='xdocSynSum'><tt></tt><tt></tt>// conditionally move 2 levels down the inheritance hierarchy; NULL upon failure</div>
654 </div>
655 <a class="xdocAnchor" id="per-instance_built-ins"></a>
656 <table class="xdocHdr"><tr>
657 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Built-Ins</span></td>
658 <td class="xdocHdrArrow">
659 <a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsg.html" title="module TransportRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
660 </table>
661 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/transports/TransportRpmsg.html#per-instance_built-ins">index URL</a></div>
662 <p class="xdocHdrSummary"></p>
663 <span id='targ-synop'></span>
664 <table class="xdocLabel"><tr>
665 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
666 <td class="xdocLabelRight">target-domain</td>
667 </tr></table>
668 <div class="xdocSynTdcl">
669 <div class="xdocSynCode">
670 <tt></tt><tt></tt><span class="xdoc-kw2">Int</span> <span class="xdoc-id">TransportRpmsg_Object_count</span>();
671 </div>
672 <div class='xdocSynSum'><tt></tt><tt></tt>// The number of statically-created instance objects</div>
673 <div class="xdocSynSpacer"> </div>
674 <div class="xdocSynCode">
675 <tt></tt><tt></tt><a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_object_types" title="ti.ipc.transports.TransportRpmsg.Handle">TransportRpmsg_Handle</a> <span class="xdoc-id">TransportRpmsg_Object_get</span>(<a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_object_types" title="ti.ipc.transports.TransportRpmsg.Object">TransportRpmsg_Object</a> *array, <span class="xdoc-kw2">Int</span> i);
676 </div>
677 <div class='xdocSynSum'><tt></tt><tt></tt>// The handle of the i-th statically-created instance object (array == NULL)</div>
678 <div class="xdocSynSpacer"> </div>
679 <div class="xdocSynCode">
680 <tt></tt><tt></tt><a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_object_types" title="ti.ipc.transports.TransportRpmsg.Handle">TransportRpmsg_Handle</a> <span class="xdoc-id">TransportRpmsg_Object_first</span>();
681 </div>
682 <div class='xdocSynSum'><tt></tt><tt></tt>// The handle of the first dynamically-created instance object, or NULL</div>
683 <div class="xdocSynSpacer"> </div>
684 <div class="xdocSynCode">
685 <tt></tt><tt></tt><a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_object_types" title="ti.ipc.transports.TransportRpmsg.Handle">TransportRpmsg_Handle</a> <span class="xdoc-id">TransportRpmsg_Object_next</span>(<a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_object_types" title="ti.ipc.transports.TransportRpmsg.Handle">TransportRpmsg_Handle</a> handle);
686 </div>
687 <div class='xdocSynSum'><tt></tt><tt></tt>// The handle of the next dynamically-created instance object, or NULL</div>
688 <div class="xdocSynSpacer"> </div>
689 <div class="xdocSynCode">
690 <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">TransportRpmsg_Object_heap</span>();
691 </div>
692 <div class='xdocSynSum'><tt></tt><tt></tt>// The heap used to allocate dynamically-created instance objects</div>
693 <div class="xdocSynSpacer"> </div>
694 <div class="xdocSynCode">
695 <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">TransportRpmsg_Handle_label</span>(<a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_object_types" title="ti.ipc.transports.TransportRpmsg.Handle">TransportRpmsg_Handle</a> handle, <a class="xdoc-link" href="../../../xdc/runtime/Types.html#.Label" title="xdc.runtime.Types.Label">Types_Label</a> *buf);
696 </div>
697 <div class='xdocSynSum'><tt></tt><tt></tt>// The label associated with this instance object</div>
698 <div class="xdocSynSpacer"> </div>
699 <div class="xdocSynCode">
700 <tt></tt><tt></tt><span class="xdoc-kw2">String</span> <span class="xdoc-id">TransportRpmsg_Handle_name</span>(<a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#per-instance_object_types" title="ti.ipc.transports.TransportRpmsg.Handle">TransportRpmsg_Handle</a> handle);
701 </div>
702 <div class='xdocSynSum'><tt></tt><tt></tt>// The name of this instance object</div>
703 </div>
704 </div>
705 <div class="xdocSynSpacer"> </div>
706 <span id='meta-synop'></span>
707 <table class="xdocLabel"><tr>
708 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2"></span></tt>Configuration settings</td>
709 <td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../ti/ipc/transports/TransportRpmsg-src.html"><span class="xdocLabelFile">ti/ipc/transports/TransportRpmsg.xdc</span></a></td>
710 </tr></table>
711 <div class="xdocSynM">
712 <div class="xdocSynCode">
713 <tt></tt><span class="xdoc-kw1">var</span> TransportRpmsg = <span class="xdoc-kw3">xdc.useModule</span>(<span class="xdoc-id">'ti.ipc.transports.TransportRpmsg'</span>);
714 </div>
715 <div class='xdocSynHdr'>module-wide constants & types</div>
717 <div class="xdocSynCode">
718 <tt> </tt><tt></tt><i>values of type <a class="xdocSynGo" href="#meta.Reason">TransportRpmsg.<span class="xdoc-id">Reason</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Reason for error function being called</span></span></a></i>
719 </div>
720 <div class="xdocSynCode">
721 <tt> </tt><tt> </tt><span class="xdoc-kw1">const</span> <a class="xdocSynGo" href="#meta.Reason" title="ti.ipc.transports.TransportRpmsg.Reason">TransportRpmsg.<span class="xdoc-id">Reason_FAILEDPUT</span></a>;
722 </div>
723 <div class="xdocSynCode">
724 <tt> </tt><tt> </tt><span class="xdoc-kw1">const</span> <a class="xdocSynGo" href="#meta.Reason" title="ti.ipc.transports.TransportRpmsg.Reason">TransportRpmsg.<span class="xdoc-id">Reason_INTERNALERR</span></a>;
725 </div>
726 <div class="xdocSynCode">
727 <tt> </tt><tt> </tt><span class="xdoc-kw1">const</span> <a class="xdocSynGo" href="#meta.Reason" title="ti.ipc.transports.TransportRpmsg.Reason">TransportRpmsg.<span class="xdoc-id">Reason_PHYSICALERR</span></a>;
728 </div>
729 <div class="xdocSynCode">
730 <tt> </tt><tt> </tt><span class="xdoc-kw1">const</span> <a class="xdocSynGo" href="#meta.Reason" title="ti.ipc.transports.TransportRpmsg.Reason">TransportRpmsg.<span class="xdoc-id">Reason_FAILEDALLOC</span></a>;
731 </div>
732 <div class="xdocSynSpacer"> </div>
733 <div class="xdocSynCode">
734 <tt> </tt><tt></tt><i>values of type <a class="xdocSynGo" href="#meta.Status">TransportRpmsg.<span class="xdoc-id">Status</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Transport return values</span></span></a></i>
735 </div>
736 <div class="xdocSynCode">
737 <tt> </tt><tt> </tt><span class="xdoc-kw1">const</span> <a class="xdocSynGo" href="#meta.Status" title="ti.ipc.transports.TransportRpmsg.Status">TransportRpmsg.<span class="xdoc-id">S_SUCCESS</span></a>;
738 </div>
739 <div class="xdocSynCode">
740 <tt> </tt><tt> </tt><span class="xdoc-kw1">const</span> <a class="xdocSynGo" href="#meta.Status" title="ti.ipc.transports.TransportRpmsg.Status">TransportRpmsg.<span class="xdoc-id">E_FAIL</span></a>;
741 </div>
742 <div class="xdocSynCode">
743 <tt> </tt><tt> </tt><span class="xdoc-kw1">const</span> <a class="xdocSynGo" href="#meta.Status" title="ti.ipc.transports.TransportRpmsg.Status">TransportRpmsg.<span class="xdoc-id">E_ERROR</span></a>;
744 </div>
745 <div class='xdocSynHdr'>module-wide config parameters</div>
747 <div class="xdocSynCode">
748 <tt> </tt><tt></tt><a class="xdocSynGo" href="#metaerr.Fxn">TransportRpmsg.<span class="xdoc-id">errFxn</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Asynchronous error function for the transport module</span></span></a> = <i><span class="xdoc-kw2">Void</span>(*)(<a class="xdoc-link" href="../../../ti/sdo/ipc/interfaces/IMessageQTransport.html#.Reason" title="ti.sdo.ipc.interfaces.IMessageQTransport.Reason">IMessageQTransport.Reason</a>,<a class="xdoc-link" href="../../../ti/sdo/ipc/interfaces/IMessageQTransport.html#per-instance_object_types" title="ti.sdo.ipc.interfaces.IMessageQTransport.Handle">IMessageQTransport.Handle</a>,<span class="xdoc-kw2">Ptr</span>,<span class="xdoc-kw2">UArg</span>)</i> <span class="xdoc-kw2">null</span>;
749 </div>
750 <div class="xdocSynSpacer"> </div>
751 <div class="xdocSynCode">
752 <tt> </tt><tt></tt><a class="xdocSynGo" href="#common$">TransportRpmsg.<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>;
753 </div>
754 <div class='xdocSynHdr'>per-instance config parameters</div>
756 <div class="xdocSynCode">
757 <tt> </tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> TransportRpmsg.<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>;
758 </div>
759 <div class="xdocSynCode">
760 <tt> </tt><tt> </tt>params.<a class="xdocSynGo" href="#metapriority"><span class="xdoc-id">priority</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Which priority messages should this transport manage</span></span></a> = <i><span class="xdoc-kw2">UInt</span></i> 0;
761 </div>
762 <div class="xdocSynCode">
763 <tt> </tt><tt> </tt>params.<a class="xdocSynGo" href="#metashared.Addr"><span class="xdoc-id">sharedAddr</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Address in shared memory where this instance will be placed</span></span></a> = <i><span class="xdoc-kw2">Ptr</span></i> <span class="xdoc-kw2">null</span>;
764 </div>
765 <div class='xdocSynHdr'>per-instance creation</div>
767 <div class="xdocSynCode">
768 <tt> </tt><tt></tt><span class="xdoc-kw1">var</span> inst = TransportRpmsg.<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><span class="xdoc-kw2">UInt16</span></i> <span class="xdoc-id">procId</span>, params);
769 </div>
770 <div class="xdocSynSpacer"> </div>
771 </div>
772 <div id="xdocSep">
773 </div>
774 <div id="xdocMetaElems">
775 <div class="xdocSynSpacer"> </div>
776 <a class="xdocAnchor" id="meta.Reason"></a>
777 <a class="xdocAnchor" id=".Reason_.F.A.I.L.E.D.P.U.T"></a>
778 <a class="xdocAnchor" id=".Reason_.I.N.T.E.R.N.A.L.E.R.R"></a>
779 <a class="xdocAnchor" id=".Reason_.P.H.Y.S.I.C.A.L.E.R.R"></a>
780 <a class="xdocAnchor" id=".Reason_.F.A.I.L.E.D.A.L.L.O.C"></a>
781 <table class="xdocHdr"><tr>
782 <td class="xdocHdrTitle"><span class="xdoc-kw1">enum</span> <span class="xdoc-id">TransportRpmsg.</span><span class="xdoc-id">Reason</span></td>
783 <td class="xdocHdrArrow">
784 <a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsg.html" title="module TransportRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
785 </table>
786 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/transports/TransportRpmsg.html#.Reason">index URL</a></div>
787 <p class="xdocHdrSummaryDcl">Reason for error function being called</p>
788 <span id='meta-synop'></span>
789 <table class="xdocLabel"><tr>
790 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
791 <td class="xdocLabelRight"></td>
792 </tr></table>
793 <div class="xdocSynMdcl">
794 <div class="xdocSynCode">
795 <tt></tt><tt></tt><i>values of type TransportRpmsg.<span class="xdoc-id">Reason</span></i>
796 </div>
797 <div class="xdocSynCode">
798 <tt></tt><tt> </tt><span class="xdoc-kw1">const</span> TransportRpmsg.<span class="xdoc-id">Reason_FAILEDPUT</span>;
799 </div>
800 <div class="xdocSynCode">
801 <tt></tt><tt> </tt><span class="xdoc-kw1">const</span> TransportRpmsg.<span class="xdoc-id">Reason_INTERNALERR</span>;
802 </div>
803 <div class="xdocSynCode">
804 <tt></tt><tt> </tt><span class="xdoc-kw1">const</span> TransportRpmsg.<span class="xdoc-id">Reason_PHYSICALERR</span>;
805 </div>
806 <div class="xdocSynCode">
807 <tt></tt><tt> </tt><span class="xdoc-kw1">const</span> TransportRpmsg.<span class="xdoc-id">Reason_FAILEDALLOC</span>;
808 </div>
809 </div>
810 <div class="xdocSynSpacer"> </div>
811 <span id="xdoc-sect-1"></span>
812 <div class="xdocSect">DETAILS</div>
813 <div class="xdocText">First field in the <a class="xdoc-link" href="TransportRpmsg.html#err.Fxn" title="errFxn">errFxn</a></div>
814 <div class="xdocSect">C SYNOPSIS</div>
815 <div class="xdocText"><a class="xdoc-link" href="#.Reason" title="TransportRpmsg_Reason">TransportRpmsg_Reason</a></div>
816 <div class="xdocSynSpacer"> </div>
817 <a class="xdocAnchor" id="meta.Status"></a>
818 <a class="xdocAnchor" id=".S_.S.U.C.C.E.S.S"></a>
819 <a class="xdocAnchor" id=".E_.F.A.I.L"></a>
820 <a class="xdocAnchor" id=".E_.E.R.R.O.R"></a>
821 <table class="xdocHdr"><tr>
822 <td class="xdocHdrTitle"><span class="xdoc-kw1">enum</span> <span class="xdoc-id">TransportRpmsg.</span><span class="xdoc-id">Status</span></td>
823 <td class="xdocHdrArrow">
824 <a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsg.html" title="module TransportRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
825 </table>
826 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/transports/TransportRpmsg.html#.Status">index URL</a></div>
827 <p class="xdocHdrSummaryDcl">Transport return values</p>
828 <span id='meta-synop'></span>
829 <table class="xdocLabel"><tr>
830 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
831 <td class="xdocLabelRight"></td>
832 </tr></table>
833 <div class="xdocSynMdcl">
834 <div class="xdocSynCode">
835 <tt></tt><tt></tt><i>values of type TransportRpmsg.<span class="xdoc-id">Status</span></i>
836 </div>
837 <div class="xdocSynCode">
838 <tt></tt><tt> </tt><span class="xdoc-kw1">const</span> TransportRpmsg.<span class="xdoc-id">S_SUCCESS</span>;
839 </div>
840 <div class="xdocSynCode">
841 <tt></tt><tt> </tt><span class="xdoc-kw1">const</span> TransportRpmsg.<span class="xdoc-id">E_FAIL</span>;
842 </div>
843 <div class="xdocSynCode">
844 <tt></tt><tt> </tt><span class="xdoc-kw1">const</span> TransportRpmsg.<span class="xdoc-id">E_ERROR</span>;
845 </div>
846 </div>
847 <div class="xdocSynSpacer"> </div>
848 <span id="xdoc-sect-1"></span>
849 <div class="xdocSect">DETAILS</div>
850 <div class="xdocText"><UL><LI><a class="xdoc-link" href="TransportRpmsg.html#.S_.S.U.C.C.E.S.S" title="S_SUCCESS">S_SUCCESS</a>: Operation was successful
851 </LI><LI><a class="xdoc-link" href="TransportRpmsg.html#.E_.F.A.I.L" title="E_FAIL">E_FAIL</a>: Operation resulted in a failure
852 </LI><LI><a class="xdoc-link" href="TransportRpmsg.html#.E_.E.R.R.O.R" title="E_ERROR">E_ERROR</a>: Operation resulted in an error.
853 </LI></UL></div>
854 <div class="xdocSect">C SYNOPSIS</div>
855 <div class="xdocText"><a class="xdoc-link" href="#.Status" title="TransportRpmsg_Status">TransportRpmsg_Status</a></div>
856 <div class="xdocSynSpacer"> </div>
857 <a class="xdocAnchor" id="metaerr.Fxn"></a>
858 <table class="xdocHdr"><tr>
859 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">TransportRpmsg.</span><span class="xdoc-id">errFxn</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
860 <td class="xdocHdrArrow">
861 <a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsg.html" title="module TransportRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
862 </table>
863 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/transports/TransportRpmsg.html#err.Fxn">index URL</a></div>
864 <p class="xdocHdrSummaryDcl">Asynchronous error function for the transport module</p>
865 <span id='meta-synop'></span>
866 <table class="xdocLabel"><tr>
867 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
868 <td class="xdocLabelRight"></td>
869 </tr></table>
870 <div class="xdocSynMdcl">
871 <div class="xdocSynCode">
872 <tt></tt><tt></tt>TransportRpmsg.<span class="xdoc-id">errFxn</span> = <i><span class="xdoc-kw2">Void</span>(*)(<a class="xdoc-link" href="../../../ti/sdo/ipc/interfaces/IMessageQTransport.html#.Reason" title="ti.sdo.ipc.interfaces.IMessageQTransport.Reason">IMessageQTransport.Reason</a>,<a class="xdoc-link" href="../../../ti/sdo/ipc/interfaces/IMessageQTransport.html#per-instance_object_types" title="ti.sdo.ipc.interfaces.IMessageQTransport.Handle">IMessageQTransport.Handle</a>,<span class="xdoc-kw2">Ptr</span>,<span class="xdoc-kw2">UArg</span>)</i> <span class="xdoc-kw2">null</span>;
873 </div>
874 </div>
875 <div class="xdocSynSpacer"> </div>
876 <div class="xdocSect">C SYNOPSIS</div>
877 <div class="xdocText"><a class="xdoc-link" href="#err.Fxn" title="TransportRpmsg_errFxn">TransportRpmsg_errFxn</a></div>
878 <div class="xdocSynSpacer"> </div>
879 <a class="xdocAnchor" id="common$"></a>
880 <table class="xdocHdr"><tr>
881 <td class="xdocHdrTitle"><span class="xdoc-kw1">metaonly </span><span class="xdoc-kw1">config</span> <span class="xdoc-id">TransportRpmsg.</span><span class="xdoc-id">common$</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
882 <td class="xdocHdrArrow">
883 <a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsg.html" title="module TransportRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
884 </table>
885 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/transports/TransportRpmsg.html#common$">index URL</a></div>
886 <p class="xdocHdrSummaryDcl">Common module configuration parameters</p>
887 <span id='meta-synop'></span>
888 <table class="xdocLabel"><tr>
889 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
890 <td class="xdocLabelRight"></td>
891 </tr></table>
892 <div class="xdocSynMdcl">
893 <div class="xdocSynCode">
894 <tt></tt><tt></tt>TransportRpmsg.<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>;
895 </div>
896 </div>
897 <div class="xdocSynSpacer"> </div>
898 <span id="xdoc-sect-1"></span>
899 <div class="xdocSect">DETAILS</div>
900 <div class="xdocText">All modules have this configuration parameter. Its name
901 contains the '$' character to ensure it does not conflict with
902 configuration parameters declared by the module. This allows
903 new configuration parameters to be added in the future without
904 any chance of breaking existing modules.</div>
905 <a class="xdocAnchor" id="metaper-instance_config_parameters"></a>
906 <table class="xdocHdr"><tr>
907 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Config Parameters</span></td>
908 <td class="xdocHdrArrow">
909 <a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsg.html" title="module TransportRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
910 </table>
911 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/transports/TransportRpmsg.html#per-instance_config_parameters">index URL</a></div>
912 <p class="xdocHdrSummary"></p>
913 <span id='meta-synop'></span>
914 <table class="xdocLabel"><tr>
915 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
916 <td class="xdocLabelRight"></td>
917 </tr></table>
918 <div class="xdocSynMdcl">
919 <div class="xdocSynCode">
920 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> TransportRpmsg.<span class="xdoc-id">Params</span>;
921 </div>
922 <div class='xdocSynSum'><tt></tt><tt></tt>// Instance config-params object</div>
923 <div class="xdocSynCode">
924 <tt></tt><tt> </tt>params.<span class="xdoc-id">priority</span> = <i><span class="xdoc-kw2">UInt</span></i> 0;
925 </div>
926 <div class='xdocSynSum'><tt></tt><tt> </tt>// Which priority messages should this transport manage</div>
927 <div class="xdocSynCode">
928 <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>;
929 </div>
930 <div class='xdocSynSum'><tt></tt><tt> </tt>// Address in shared memory where this instance will be placed</div>
931 </div>
932 <div class="xdocSynSpacer"> </div>
933 <a class="xdocAnchor" id="metapriority"></a>
934 <table class="xdocHdr"><tr>
935 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">TransportRpmsg.Params.</span><span class="xdoc-id">priority</span> <small><span class="xdocSynSum">// instance</span></small></td>
936 <td class="xdocHdrArrow">
937 <a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsg.html" title="module TransportRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
938 </table>
939 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/transports/TransportRpmsg.html#priority">index URL</a></div>
940 <p class="xdocHdrSummaryDcl">Which priority messages should this transport manage</p>
941 <span id='meta-synop'></span>
942 <table class="xdocLabel"><tr>
943 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
944 <td class="xdocLabelRight"></td>
945 </tr></table>
946 <div class="xdocSynMdcl">
947 <div class="xdocSynCode">
948 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> TransportRpmsg.<span class="xdoc-id">Params</span>;
949 </div>
950 <div class="xdocSynCode">
951 <tt></tt><tt></tt><b> ...</b>
952 </div>
953 <div class="xdocSynCode">
954 <tt></tt><tt></tt>params.<span class="xdoc-id">priority</span> = <i><span class="xdoc-kw2">UInt</span></i> 0;
955 </div>
956 </div>
957 <div class="xdocSynSpacer"> </div>
958 <div class="xdocSect">C SYNOPSIS</div>
959 <div class="xdocText"><a class="xdoc-link" href="#priority" title="TransportRpmsg_Params.priority">TransportRpmsg_Params.priority</a></div>
960 <div class="xdocSynSpacer"> </div>
961 <a class="xdocAnchor" id="metashared.Addr"></a>
962 <table class="xdocHdr"><tr>
963 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">TransportRpmsg.Params.</span><span class="xdoc-id">sharedAddr</span> <small><span class="xdocSynSum">// instance</span></small></td>
964 <td class="xdocHdrArrow">
965 <a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsg.html" title="module TransportRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
966 </table>
967 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/transports/TransportRpmsg.html#shared.Addr">index URL</a></div>
968 <p class="xdocHdrSummaryDcl">Address in shared memory where this instance will be placed</p>
969 <span id='meta-synop'></span>
970 <table class="xdocLabel"><tr>
971 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
972 <td class="xdocLabelRight"></td>
973 </tr></table>
974 <div class="xdocSynMdcl">
975 <div class="xdocSynCode">
976 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> TransportRpmsg.<span class="xdoc-id">Params</span>;
977 </div>
978 <div class="xdocSynCode">
979 <tt></tt><tt></tt><b> ...</b>
980 </div>
981 <div class="xdocSynCode">
982 <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>;
983 </div>
984 </div>
985 <div class="xdocSynSpacer"> </div>
986 <div class="xdocSect">C SYNOPSIS</div>
987 <div class="xdocText"><a class="xdoc-link" href="#shared.Addr" title="TransportRpmsg_Params.sharedAddr">TransportRpmsg_Params.sharedAddr</a></div>
988 <a class="xdocAnchor" id="metaper-instance_creation"></a>
989 <table class="xdocHdr"><tr>
990 <td class="xdocHdrTitle"><span class="xdocSynSum">Static Instance Creation</span></td>
991 <td class="xdocHdrArrow">
992 <a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsg.html" title="module TransportRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
993 </table>
994 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/transports/TransportRpmsg.html#per-instance_creation">index URL</a></div>
995 <p class="xdocHdrSummary"></p>
996 <span id='meta-synop'></span>
997 <table class="xdocLabel"><tr>
998 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
999 <td class="xdocLabelRight"></td>
1000 </tr></table>
1001 <div class="xdocSynMdcl">
1002 <div class="xdocSynCode">
1003 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> TransportRpmsg.<a class="xdoc-link" href="../../../ti/ipc/transports/TransportRpmsg.html#metaper-instance_config_parameters" title="ti.ipc.transports.TransportRpmsg.Params">Params</a>;
1004 </div>
1005 <div class='xdocSynSum'><tt></tt><tt></tt>// Allocate instance config-params</div>
1006 <div class="xdocSynCode">
1007 <tt></tt><tt></tt>params.<i>config</i> = <b> ...</b>
1008 </div>
1009 <div class='xdocSynSum'><tt></tt><tt></tt>// Assign individual configs</div>
1010 <div class="xdocSynSpacer"> </div>
1011 <div class="xdocSynCode">
1012 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> inst = TransportRpmsg.<span class="xdoc-id">create</span>(<i><span class="xdoc-kw2">UInt16</span></i> <span class="xdoc-id">procId</span>, params);
1013 </div>
1014 <div class='xdocSynSum'><tt></tt><tt></tt>// Create an instance-object</div>
1015 </div>
1016 <span id="xdoc-sect-1"></span>
1017 <div class="xdocSect">ARGUMENTS</div>
1018 <div class="xdocChild"><span class="xdocChildId">procId</span>
1019 <span class="xdocChildSum">— Remote processor id that this instance
1020 will communicate with.</span>
1021 </div>
1022 <div class="xdocChild"><span class="xdocChildId">params</span>
1023 <span class="xdocChildSum">— per-instance config params, or <tt>NULL</tt> to select default values (target-domain only)</span>
1024 </div>
1025 <div class="xdocChild"><span class="xdocChildId">eb</span>
1026 <span class="xdocChildSum">— active error-handling block, or <tt>NULL</tt> to select default policy (target-domain only)</span>
1027 </div>
1028 <span id="xdoc-sect-2"></span>
1029 <div class="xdocSect">DETAILS</div>
1030 <div class="xdocText">This function creates a transport instance. The transport is
1031 responsible for registering with MessageQ via the
1032 <a class="xdoc-link" href="../../../ti/sdo/ipc/MessageQ.html#register.Transport" title="ti.sdo.ipc.MessageQ.registerTransport">ti.sdo.ipc.MessageQ.registerTransport</a> API.</div>
1033 </div>
1034 <div id="xdocDate">generated on Mon, 23 May 2016 14:31:25 GMT</div>
1035 </div></div></body>
1036 </html>