[processor-sdk/performance-audio-sr.git] / ipc_3_43_00_00_eng / docs / cdoc / ti / ipc / family / omapl138 / VirtQueue.html
1 <html>
2 <head>
3 <title>module ti.ipc.family.omapl138.VirtQueue</title>
4 <link rel="stylesheet" type="text/css" href="../../../../xdoc.css" />
5 </head>
6 <body><div id="xdocWrapper"><div id="xdocContent">
7 <table class="xdocHdr"><tr>
8 <td class="xdocHdrTitle"><span class="xdoc-kw1">module</span> <span class="xdoc-id">ti.ipc.family.omapl138.</span><span class="xdoc-id">VirtQueue</span></td>
9 <td class="xdocHdrArrow">
10 <a class="xdocHdrLink" href="../../../../ti/ipc/family/omapl138/package.html" title="package ti.ipc.family.omapl138"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
11 </table>
12 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/omapl138/VirtQueue.html">index URL</a></div>
13 <ul class="xdocToc">
14 <li class="xdocToc"><a class="xdocToc" href="#targ-synop">C synopsis</a></li>
15 <li class="xdocToc2"><a class="xdocToc" href="#xdocElems">Individual elements</a></li>
16 <li class="xdocToc"><a class="xdocToc" href="#meta-synop">Configuration settings</a></li>
17 <li class="xdocToc2"><a class="xdocToc" href="#xdocMetaElems">Individual elements</a></li>
18 </ul>
19 <span id='targ-synop'></span>
20 <table class="xdocLabel"><tr>
21 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2">C</span></tt> synopsis</td>
22 <td class="xdocLabelCenter">target-domain</td>
23 <td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../../ti/ipc/family/omapl138/VirtQueue-src.html"><span class="xdocLabelFile">ti/ipc/family/omapl138/VirtQueue.xdc</span></a></td>
24 </tr></table>
25 <div class="xdocSynT">
26 <div class="xdocSynCode">
27 <tt></tt><span class="xdoc-kw3">#include</span> <span class="xdoc-id"><ti/ipc/family/omapl138/VirtQueue.h></span>
28 </div>
29 <table cellspacing="0" cellpadding="0" border="0">
30 <tr><td colspan='2'><div class='xdocSynTblHdr'>Functions</div></td></tr>
32 <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="#add.Avail.Buf"><span class="xdoc-id">VirtQueue_addAvailBuf</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a>(<a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Handle">VirtQueue_Handle</a> handle, <span class="xdoc-kw2">Void</span> *<span class="xdoc-id">buf</span>);</div></td></tr>
33 <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="#add.Used.Buf"><span class="xdoc-id">VirtQueue_addUsedBuf</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a>(<a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Handle">VirtQueue_Handle</a> handle, <span class="xdoc-kw2">Int16</span> <span class="xdoc-id">token</span>, <span class="xdoc-kw2">Int</span> <span class="xdoc-id">len</span>);</div></td></tr>
34 <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">VirtQueue_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/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Struct">VirtQueue_Struct</a> *structP, <span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>, <span class="xdoc-kw1">const</span> <a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_config_parameters" title="ti.ipc.family.omapl138.VirtQueue.Params">VirtQueue_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>
35 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Handle">VirtQueue_Handle</a> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_creation"><span class="xdoc-id">VirtQueue_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">remoteProcId</span>, <span class="xdoc-kw1">const</span> <a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_config_parameters" title="ti.ipc.family.omapl138.VirtQueue.Params">VirtQueue_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>
36 <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">VirtQueue_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/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Handle">VirtQueue_Handle</a> *handleP);</div></td></tr>
37 <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">VirtQueue_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/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Struct">VirtQueue_Struct</a> *structP);</div></td></tr>
38 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Int16</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#get.Avail.Buf"><span class="xdoc-id">VirtQueue_getAvailBuf</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a>(<a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Handle">VirtQueue_Handle</a> handle, <span class="xdoc-kw2">Void</span> **<span class="xdoc-id">buf</span>, <span class="xdoc-kw2">Int</span> *<span class="xdoc-id">len</span>);</div></td></tr>
39 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">UInt16</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#get.Id"><span class="xdoc-id">VirtQueue_getId</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a>(<a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Handle">VirtQueue_Handle</a> handle);</div></td></tr>
40 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><a class="xdoc-link" href="../../../../ti/sysbios/knl/Swi.html#per-instance_object_types" title="ti.sysbios.knl.Swi.Handle">Swi_Handle</a> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#get.Swi.Handle"><span class="xdoc-id">VirtQueue_getSwiHandle</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a>(<a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Handle">VirtQueue_Handle</a> handle);</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="#get.Used.Buf"><span class="xdoc-id">VirtQueue_getUsedBuf</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a>(<a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Handle">VirtQueue_Handle</a> handle);</div></td></tr>
42 <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="#is.Host"><span class="xdoc-id">VirtQueue_isHost</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a>(<a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Handle">VirtQueue_Handle</a> handle);</div></td></tr>
43 <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="#is.Slave"><span class="xdoc-id">VirtQueue_isSlave</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a>(<a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Handle">VirtQueue_Handle</a> handle);</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="#kick"><span class="xdoc-id">VirtQueue_kick</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a>(<a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Handle">VirtQueue_Handle</a> handle);</div></td></tr>
45 <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">VirtQueue_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/family/omapl138/VirtQueue.html#per-instance_config_parameters" title="ti.ipc.family.omapl138.VirtQueue.Params">VirtQueue_Params</a> *params);</div></td></tr>
46 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Void</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#startup"><span class="xdoc-id">VirtQueue_startup</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Plug interrupts, and if host, initialize vring memory and send
47 startup sequence events to slave</span></span></a>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>, <span class="xdoc-kw2">Bool</span> <span class="xdoc-id">isHost</span>);</div></td></tr>
48 <tr><td class="xdocSynFxnCat" colspan="2"><div class="xdocSynFxnCat">Functions common to all target instances</div></td></tr>
50 <tr>
51 <td></td>
52 <td>
53 <div class="xdocSynTblPack">
54 <a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">VirtQueue_handle</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Convert this instance structure pointer into an instance handle</span></span></a>,
55 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">VirtQueue_Handle_label</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The label associated with this instance object</span></span></a>,
56 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">VirtQueue_Handle_name</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The name of this instance object</span></span></a>,
57 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">VirtQueue_Object_count</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The number of statically-created instance objects</span></span></a>,
58 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">VirtQueue_Object_first</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The handle of the first dynamically-created instance object, or NULL</span></span></a>,
59 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">VirtQueue_Object_get</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The handle of the i-th statically-created instance object (array == NULL)</span></span></a>,
60 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">VirtQueue_Object_heap</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The heap used to allocate dynamically-created instance objects</span></span></a>,
61 <a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">VirtQueue_Object_next</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The handle of the next dynamically-created instance object, or NULL</span></span></a>,
62 <a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">VirtQueue_struct</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Convert this instance handle into an instance structure pointer</span></span></a>
63 </div>
64 </td>
65 </tr>
66 <tr><td class="xdocSynFxnCat" colspan="2"><div class="xdocSynFxnCat">Functions common to all target modules</div></td></tr>
68 <tr>
69 <td></td>
70 <td>
71 <div class="xdocSynTblPack">
72 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">VirtQueue_Module_getMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Returns the diagnostics mask for this module</span></span></a>,
73 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">VirtQueue_Module_hasMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Test whether this module has a diagnostics mask</span></span></a>,
74 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">VirtQueue_Module_heap</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The heap from which this module allocates memory</span></span></a>,
75 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">VirtQueue_Module_id</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Get this module's unique id</span></span></a>,
76 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">VirtQueue_Module_setMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Set the diagnostics mask for this module</span></span></a>,
77 <a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">VirtQueue_Module_startupDone</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Test if this module has completed startup</span></span></a>
78 </div>
79 </td>
80 </tr>
81 <tr><td colspan='2'><div class='xdocSynTblHdr'>Typedefs</div></td></tr>
83 <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/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Object">VirtQueue_Object</a> *</div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">VirtQueue_Handle</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Client reference to an instance object</span></span></a>;</div></td></tr>
84 <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">VirtQueue_Object</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Opaque internal representation of an instance object</span></span></a> <span class="xdoc-id">VirtQueue_Object</span>;</div></td></tr>
85 <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">VirtQueue_Params</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Instance config-params structure</span></span></a> ...</div></td></tr>
86 <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">VirtQueue_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">VirtQueue_Struct</span>;</div></td></tr>
87 <tr><td colspan='2'><div class='xdocSynTblHdr'>Constants</div></td></tr>
89 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">extern const</span> <span class="xdoc-kw2">UInt</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#.P.A.G.E_.S.I.Z.E"><span class="xdoc-id">VirtQueue_PAGE_SIZE</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a>;</div></td></tr>
90 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">extern const</span> <span class="xdoc-kw2">UInt</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#.R.P_.M.S.G_.N.U.M_.B.U.F.S"><span class="xdoc-id">VirtQueue_RP_MSG_NUM_BUFS</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a>;</div></td></tr>
91 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">extern const</span> <span class="xdoc-kw2">UInt</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#.R.P_.M.S.G_.V.R.I.N.G_.A.L.I.G.N"><span class="xdoc-id">VirtQueue_RP_MSG_VRING_ALIGN</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a>;</div></td></tr>
92 <tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">extern const</span> <span class="xdoc-kw2">UInt</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#.V.Q1_.S.I.Z.E"><span class="xdoc-id">VirtQueue_VQ1_SIZE</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a>;</div></td></tr>
93 </table>
94 <div class="xdocSynSpacer"> </div>
95 </div>
96 <div id="xdocSep">
97 </div>
98 <div id="xdocElems">
99 <div class="xdocSynSpacer"> </div>
100 <a class="xdocAnchor" id=".P.A.G.E_.S.I.Z.E"></a>
101 <table class="xdocHdr"><tr>
102 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">VirtQueue_</span><span class="xdoc-id">PAGE_SIZE</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
103 <td class="xdocHdrArrow">
104 <a class="xdocHdrLink" href="../../../../ti/ipc/family/omapl138/VirtQueue.html" title="module VirtQueue"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
105 </table>
106 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/omapl138/VirtQueue.html#.P.A.G.E_.S.I.Z.E">index URL</a></div>
107 <span id='targ-synop'></span>
108 <table class="xdocLabel"><tr>
109 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
110 <td class="xdocLabelRight">target-domain</td>
111 </tr></table>
112 <div class="xdocSynTdcl">
113 <div class="xdocSynCode">
114 <tt></tt><tt></tt><span class="xdoc-kw1">extern const</span> <span class="xdoc-kw2">UInt</span> <span class="xdoc-id">VirtQueue_PAGE_SIZE</span>;
115 </div>
116 </div>
117 <div class="xdocSynSpacer"> </div>
118 <div class="xdocSynSpacer"> </div>
119 <a class="xdocAnchor" id=".R.P_.M.S.G_.N.U.M_.B.U.F.S"></a>
120 <table class="xdocHdr"><tr>
121 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">VirtQueue_</span><span class="xdoc-id">RP_MSG_NUM_BUFS</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
122 <td class="xdocHdrArrow">
123 <a class="xdocHdrLink" href="../../../../ti/ipc/family/omapl138/VirtQueue.html" title="module VirtQueue"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
124 </table>
125 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/omapl138/VirtQueue.html#.R.P_.M.S.G_.N.U.M_.B.U.F.S">index URL</a></div>
126 <span id='targ-synop'></span>
127 <table class="xdocLabel"><tr>
128 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
129 <td class="xdocLabelRight">target-domain</td>
130 </tr></table>
131 <div class="xdocSynTdcl">
132 <div class="xdocSynCode">
133 <tt></tt><tt></tt><span class="xdoc-kw1">extern const</span> <span class="xdoc-kw2">UInt</span> <span class="xdoc-id">VirtQueue_RP_MSG_NUM_BUFS</span>;
134 </div>
135 </div>
136 <div class="xdocSynSpacer"> </div>
137 <div class="xdocSynSpacer"> </div>
138 <a class="xdocAnchor" id=".R.P_.M.S.G_.V.R.I.N.G_.A.L.I.G.N"></a>
139 <table class="xdocHdr"><tr>
140 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">VirtQueue_</span><span class="xdoc-id">RP_MSG_VRING_ALIGN</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
141 <td class="xdocHdrArrow">
142 <a class="xdocHdrLink" href="../../../../ti/ipc/family/omapl138/VirtQueue.html" title="module VirtQueue"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
143 </table>
144 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/omapl138/VirtQueue.html#.R.P_.M.S.G_.V.R.I.N.G_.A.L.I.G.N">index URL</a></div>
145 <span id='targ-synop'></span>
146 <table class="xdocLabel"><tr>
147 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
148 <td class="xdocLabelRight">target-domain</td>
149 </tr></table>
150 <div class="xdocSynTdcl">
151 <div class="xdocSynCode">
152 <tt></tt><tt></tt><span class="xdoc-kw1">extern const</span> <span class="xdoc-kw2">UInt</span> <span class="xdoc-id">VirtQueue_RP_MSG_VRING_ALIGN</span>;
153 </div>
154 </div>
155 <div class="xdocSynSpacer"> </div>
156 <div class="xdocSynSpacer"> </div>
157 <a class="xdocAnchor" id=".V.Q1_.S.I.Z.E"></a>
158 <table class="xdocHdr"><tr>
159 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">VirtQueue_</span><span class="xdoc-id">VQ1_SIZE</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
160 <td class="xdocHdrArrow">
161 <a class="xdocHdrLink" href="../../../../ti/ipc/family/omapl138/VirtQueue.html" title="module VirtQueue"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
162 </table>
163 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/omapl138/VirtQueue.html#.V.Q1_.S.I.Z.E">index URL</a></div>
164 <span id='targ-synop'></span>
165 <table class="xdocLabel"><tr>
166 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
167 <td class="xdocLabelRight">target-domain</td>
168 </tr></table>
169 <div class="xdocSynTdcl">
170 <div class="xdocSynCode">
171 <tt></tt><tt></tt><span class="xdoc-kw1">extern const</span> <span class="xdoc-kw2">UInt</span> <span class="xdoc-id">VirtQueue_VQ1_SIZE</span>;
172 </div>
173 </div>
174 <div class="xdocSynSpacer"> </div>
175 <div class="xdocSynSpacer"> </div>
176 <a class="xdocAnchor" id="startup"></a>
177 <table class="xdocHdr"><tr>
178 <td class="xdocHdrTitle"><span class="xdoc-id">VirtQueue_</span><span class="xdoc-id">startup</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
179 <td class="xdocHdrArrow">
180 <a class="xdocHdrLink" href="../../../../ti/ipc/family/omapl138/VirtQueue.html" title="module VirtQueue"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
181 </table>
182 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/omapl138/VirtQueue.html#startup">index URL</a></div>
183 <p class="xdocHdrSummaryDcl">Plug interrupts, and if host, initialize vring memory and send
184 startup sequence events to slave</p>
185 <span id='targ-synop'></span>
186 <table class="xdocLabel"><tr>
187 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
188 <td class="xdocLabelRight">target-domain</td>
189 </tr></table>
190 <div class="xdocSynTdcl">
191 <div class="xdocSynCode">
192 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">VirtQueue_startup</span>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>, <span class="xdoc-kw2">Bool</span> <span class="xdoc-id">isHost</span>);
193 </div>
194 </div>
195 <div class="xdocSynSpacer"> </div>
196 <a class="xdocAnchor" id="module-wide_built-ins"></a>
197 <table class="xdocHdr"><tr>
198 <td class="xdocHdrTitle"><span class="xdocSynSum">Module-Wide Built-Ins</span></td>
199 <td class="xdocHdrArrow">
200 <a class="xdocHdrLink" href="../../../../ti/ipc/family/omapl138/VirtQueue.html" title="module VirtQueue"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
201 </table>
202 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/omapl138/VirtQueue.html#module-wide_built-ins">index URL</a></div>
203 <p class="xdocHdrSummary"></p>
204 <span id='targ-synop'></span>
205 <table class="xdocLabel"><tr>
206 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
207 <td class="xdocLabelRight">target-domain</td>
208 </tr></table>
209 <div class="xdocSynTdcl">
210 <div class="xdocSynCode">
211 <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">VirtQueue_Module_id</span>();
212 </div>
213 <div class='xdocSynSum'><tt></tt><tt></tt>// Get this module's unique id</div>
214 <div class="xdocSynSpacer"> </div>
215 <div class="xdocSynCode">
216 <tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">VirtQueue_Module_startupDone</span>();
217 </div>
218 <div class='xdocSynSum'><tt></tt><tt></tt>// Test if this module has completed startup</div>
219 <div class="xdocSynSpacer"> </div>
220 <div class="xdocSynCode">
221 <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">VirtQueue_Module_heap</span>();
222 </div>
223 <div class='xdocSynSum'><tt></tt><tt></tt>// The heap from which this module allocates memory</div>
224 <div class="xdocSynSpacer"> </div>
225 <div class="xdocSynCode">
226 <tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">VirtQueue_Module_hasMask</span>();
227 </div>
228 <div class='xdocSynSum'><tt></tt><tt></tt>// Test whether this module has a diagnostics mask</div>
229 <div class="xdocSynSpacer"> </div>
230 <div class="xdocSynCode">
231 <tt></tt><tt></tt><span class="xdoc-kw2">Bits16</span> <span class="xdoc-id">VirtQueue_Module_getMask</span>();
232 </div>
233 <div class='xdocSynSum'><tt></tt><tt></tt>// Returns the diagnostics mask for this module</div>
234 <div class="xdocSynSpacer"> </div>
235 <div class="xdocSynCode">
236 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">VirtQueue_Module_setMask</span>(<span class="xdoc-kw2">Bits16</span> <span class="xdoc-id">mask</span>);
237 </div>
238 <div class='xdocSynSum'><tt></tt><tt></tt>// Set the diagnostics mask for this module</div>
239 </div>
240 <a class="xdocAnchor" id="per-instance_object_types"></a>
241 <table class="xdocHdr"><tr>
242 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Object Types</span></td>
243 <td class="xdocHdrArrow">
244 <a class="xdocHdrLink" href="../../../../ti/ipc/family/omapl138/VirtQueue.html" title="module VirtQueue"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
245 </table>
246 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types">index URL</a></div>
247 <p class="xdocHdrSummary"></p>
248 <span id='targ-synop'></span>
249 <table class="xdocLabel"><tr>
250 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
251 <td class="xdocLabelRight">target-domain</td>
252 </tr></table>
253 <div class="xdocSynTdcl">
254 <div class="xdocSynCode">
255 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">VirtQueue_Object</span> <span class="xdoc-id">VirtQueue_Object</span>;
256 </div>
257 <div class='xdocSynSum'><tt></tt><tt></tt>// Opaque internal representation of an instance object</div>
258 <div class="xdocSynSpacer"> </div>
259 <div class="xdocSynCode">
260 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Object">VirtQueue_Object</a> *<span class="xdoc-id">VirtQueue_Handle</span>;
261 </div>
262 <div class='xdocSynSum'><tt></tt><tt></tt>// Client reference to an instance object</div>
263 <div class="xdocSynSpacer"> </div>
264 <div class="xdocSynCode">
265 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">VirtQueue_Struct</span> <span class="xdoc-id">VirtQueue_Struct</span>;
266 </div>
267 <div class='xdocSynSum'><tt></tt><tt></tt>// Opaque client structure large enough to hold an instance object</div>
268 <div class="xdocSynSpacer"> </div>
269 <div class="xdocSynCode">
270 <tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Handle">VirtQueue_Handle</a> <span class="xdoc-id">VirtQueue_handle</span>(<a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Struct">VirtQueue_Struct</a> *structP);
271 </div>
272 <div class='xdocSynSum'><tt></tt><tt></tt>// Convert this instance structure pointer into an instance handle</div>
273 <div class="xdocSynSpacer"> </div>
274 <div class="xdocSynCode">
275 <tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Struct">VirtQueue_Struct</a> *<span class="xdoc-id">VirtQueue_struct</span>(<a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Handle">VirtQueue_Handle</a> handle);
276 </div>
277 <div class='xdocSynSum'><tt></tt><tt></tt>// Convert this instance handle into an instance structure pointer</div>
278 </div>
279 <a class="xdocAnchor" id="per-instance_config_parameters"></a>
280 <table class="xdocHdr"><tr>
281 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Config Parameters</span></td>
282 <td class="xdocHdrArrow">
283 <a class="xdocHdrLink" href="../../../../ti/ipc/family/omapl138/VirtQueue.html" title="module VirtQueue"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
284 </table>
285 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/omapl138/VirtQueue.html#per-instance_config_parameters">index URL</a></div>
286 <p class="xdocHdrSummary"></p>
287 <span id='targ-synop'></span>
288 <table class="xdocLabel"><tr>
289 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
290 <td class="xdocLabelRight">target-domain</td>
291 </tr></table>
292 <div class="xdocSynTdcl">
293 <div class="xdocSynCode">
294 <tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">VirtQueue_Params</span> {
295 </div>
296 <div class='xdocSynSum'><tt></tt><tt></tt>// Instance config-params structure</div>
297 <div class="xdocSynCode">
298 <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;
299 </div>
300 <div class='xdocSynSum'><tt></tt><tt> </tt>// Common per-instance configs</div>
301 <div class="xdocSynCode">
302 <tt></tt><tt> </tt><span class="xdoc-kw2">Fxn</span> <span class="xdoc-id">callback</span>;
303 </div>
304 <div class='xdocSynSum'><tt></tt><tt> </tt>// </div>
305 <div class="xdocSynCode">
306 <tt></tt><tt> </tt><span class="xdoc-kw2">Int</span> <span class="xdoc-id">vqId</span>;
307 </div>
308 <div class='xdocSynSum'><tt></tt><tt> </tt>// </div>
309 <div class="xdocSynCode">
310 <tt></tt><tt></tt>} <span class="xdoc-id">VirtQueue_Params</span>;
311 </div>
312 <div class="xdocSynSpacer"> </div>
313 <div class="xdocSynCode">
314 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">VirtQueue_Params_init</span>(<a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_config_parameters" title="ti.ipc.family.omapl138.VirtQueue.Params">VirtQueue_Params</a> *params);
315 </div>
316 <div class='xdocSynSum'><tt></tt><tt></tt>// Initialize this config-params structure with supplier-specified defaults before instance creation</div>
317 </div>
318 <div class="xdocSynSpacer"> </div>
319 <a class="xdocAnchor" id="callback"></a>
320 <table class="xdocHdr"><tr>
321 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">VirtQueue_Params.</span><span class="xdoc-id">callback</span> <small><span class="xdocSynSum">// instance</span></small></td>
322 <td class="xdocHdrArrow">
323 <a class="xdocHdrLink" href="../../../../ti/ipc/family/omapl138/VirtQueue.html" title="module VirtQueue"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
324 </table>
325 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/omapl138/VirtQueue.html#callback">index URL</a></div>
326 <span id='targ-synop'></span>
327 <table class="xdocLabel"><tr>
328 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
329 <td class="xdocLabelRight">target-domain</td>
330 </tr></table>
331 <div class="xdocSynTdcl">
332 <div class="xdocSynCode">
333 <tt></tt><tt></tt><span class="xdoc-kw1">struct</span> <a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_config_parameters" title="ti.ipc.family.omapl138.VirtQueue.Params">VirtQueue_Params</a> {
334 </div>
335 <div class="xdocSynCode">
336 <tt></tt><tt> </tt><b> ...</b>
337 </div>
338 <div class="xdocSynCode">
339 <tt></tt><tt> </tt><span class="xdoc-kw2">Fxn</span> <span class="xdoc-id">callback</span>;
340 </div>
341 </div>
342 <div class="xdocSynSpacer"> </div>
343 <div class="xdocSynSpacer"> </div>
344 <a class="xdocAnchor" id="vq.Id"></a>
345 <table class="xdocHdr"><tr>
346 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">VirtQueue_Params.</span><span class="xdoc-id">vqId</span> <small><span class="xdocSynSum">// instance</span></small></td>
347 <td class="xdocHdrArrow">
348 <a class="xdocHdrLink" href="../../../../ti/ipc/family/omapl138/VirtQueue.html" title="module VirtQueue"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
349 </table>
350 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/omapl138/VirtQueue.html#vq.Id">index URL</a></div>
351 <span id='targ-synop'></span>
352 <table class="xdocLabel"><tr>
353 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
354 <td class="xdocLabelRight">target-domain</td>
355 </tr></table>
356 <div class="xdocSynTdcl">
357 <div class="xdocSynCode">
358 <tt></tt><tt></tt><span class="xdoc-kw1">struct</span> <a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_config_parameters" title="ti.ipc.family.omapl138.VirtQueue.Params">VirtQueue_Params</a> {
359 </div>
360 <div class="xdocSynCode">
361 <tt></tt><tt> </tt><b> ...</b>
362 </div>
363 <div class="xdocSynCode">
364 <tt></tt><tt> </tt><span class="xdoc-kw2">Int</span> <span class="xdoc-id">vqId</span>;
365 </div>
366 </div>
367 <div class="xdocSynSpacer"> </div>
368 <a class="xdocAnchor" id="per-instance_creation"></a>
369 <table class="xdocHdr"><tr>
370 <td class="xdocHdrTitle"><span class="xdocSynSum">Runtime Instance Creation</span></td>
371 <td class="xdocHdrArrow">
372 <a class="xdocHdrLink" href="../../../../ti/ipc/family/omapl138/VirtQueue.html" title="module VirtQueue"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
373 </table>
374 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/omapl138/VirtQueue.html#per-instance_creation">index URL</a></div>
375 <p class="xdocHdrSummary"></p>
376 <span id='targ-synop'></span>
377 <table class="xdocLabel"><tr>
378 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
379 <td class="xdocLabelRight">target-domain</td>
380 </tr></table>
381 <div class="xdocSynTdcl">
382 <div class="xdocSynCode">
383 <tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Handle">VirtQueue_Handle</a> <span class="xdoc-id">VirtQueue_create</span>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>, <span class="xdoc-kw1">const</span> <a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_config_parameters" title="ti.ipc.family.omapl138.VirtQueue.Params">VirtQueue_Params</a> *params, <a class="xdoc-link" href="../../../../xdc/runtime/Error.html#.Block" title="xdc.runtime.Error.Block">Error_Block</a> *eb);
384 </div>
385 <div class='xdocSynSum'><tt></tt><tt></tt>// Allocate and initialize a new instance object and return its handle</div>
386 <div class="xdocSynSpacer"> </div>
387 <div class="xdocSynCode">
388 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">VirtQueue_construct</span>(<a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Struct">VirtQueue_Struct</a> *structP, <span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>, <span class="xdoc-kw1">const</span> <a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_config_parameters" title="ti.ipc.family.omapl138.VirtQueue.Params">VirtQueue_Params</a> *params, <a class="xdoc-link" href="../../../../xdc/runtime/Error.html#.Block" title="xdc.runtime.Error.Block">Error_Block</a> *eb);
389 </div>
390 <div class='xdocSynSum'><tt></tt><tt></tt>// Initialize a new instance object inside the provided structure</div>
391 </div>
392 <span id="xdoc-sect-1"></span>
393 <div class="xdocSect">ARGUMENTS</div>
394 <div class="xdocChild"><span class="xdocChildId"></span>
395 <span class="xdocChildSum">— [in] remoteProcId Remote processor ID associated with this VirtQueue.</span>
396 </div>
397 <div class="xdocChild"><span class="xdocChildId">params</span>
398 <span class="xdocChildSum">— per-instance config params, or <tt>NULL</tt> to select default values (target-domain only)</span>
399 </div>
400 <div class="xdocChild"><span class="xdocChildId">eb</span>
401 <span class="xdocChildSum">— active error-handling block, or <tt>NULL</tt> to select default policy (target-domain only)</span>
402 </div>
403 <span id="xdoc-sect-2"></span>
404 <div class="xdocSect">DETAILS</div>
405 <div class="xdocText">Maps to Instance_init function</div>
406 <span id="xdoc-sect-3"></span>
407 <div class="xdocSect">BRIEF</div>
408 <div class="xdocText">Initialize at runtime the VirtQueue</div>
409 <span id="xdoc-sect-4"></span>
410 <div class="xdocSect">RETURNS</div>
411 <div class="xdocText">Returns a handle to a new initialized VirtQueue.</div>
412 <a class="xdocAnchor" id="per-instance_deletion"></a>
413 <table class="xdocHdr"><tr>
414 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Deletion</span></td>
415 <td class="xdocHdrArrow">
416 <a class="xdocHdrLink" href="../../../../ti/ipc/family/omapl138/VirtQueue.html" title="module VirtQueue"><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/ipc/family/omapl138/VirtQueue.html#per-instance_deletion">index URL</a></div>
419 <p class="xdocHdrSummary"></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-kw2">Void</span> <span class="xdoc-id">VirtQueue_delete</span>(<a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Handle">VirtQueue_Handle</a> *handleP);
428 </div>
429 <div class='xdocSynSum'><tt></tt><tt></tt>// Finalize and free this previously allocated instance object, setting the referenced handle to NULL</div>
430 <div class="xdocSynSpacer"> </div>
431 <div class="xdocSynCode">
432 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">VirtQueue_destruct</span>(<a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Struct">VirtQueue_Struct</a> *structP);
433 </div>
434 <div class='xdocSynSum'><tt></tt><tt></tt>// Finalize the instance object inside the provided structure</div>
435 </div>
436 <div class="xdocSynSpacer"> </div>
437 <a class="xdocAnchor" id="add.Avail.Buf"></a>
438 <table class="xdocHdr"><tr>
439 <td class="xdocHdrTitle"><span class="xdoc-id">VirtQueue_</span><span class="xdoc-id">addAvailBuf</span>() <small><span class="xdocSynSum">// instance</span></small></td>
440 <td class="xdocHdrArrow">
441 <a class="xdocHdrLink" href="../../../../ti/ipc/family/omapl138/VirtQueue.html" title="module VirtQueue"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
442 </table>
443 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/omapl138/VirtQueue.html#add.Avail.Buf">index URL</a></div>
444 <span id='targ-synop'></span>
445 <table class="xdocLabel"><tr>
446 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
447 <td class="xdocLabelRight">target-domain</td>
448 </tr></table>
449 <div class="xdocSynTdcl">
450 <div class="xdocSynCode">
451 <tt></tt><tt></tt><span class="xdoc-kw2">Int</span> <span class="xdoc-id">VirtQueue_addAvailBuf</span>(<a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Handle">VirtQueue_Handle</a> handle, <span class="xdoc-kw2">Void</span> *<span class="xdoc-id">buf</span>);
452 </div>
453 </div>
454 <div class="xdocSynSpacer"> </div>
455 <span id="xdoc-sect-1"></span>
456 <div class="xdocSect">ARGUMENTS</div>
457 <div class="xdocChild"><span class="xdocChildId">handle</span>
458 <span class="xdocChildSum">— handle of a previously-created <tt>VirtQueue</tt> instance object</span>
459 </div>
460 <div class="xdocChild"><span class="xdocChildId"></span>
461 <span class="xdocChildSum">— [in] vq the VirtQueue.
462 [in] buf the buffer to be processed by the slave.</span>
463 </div>
464 <span id="xdoc-sect-2"></span>
465 <div class="xdocSect">BRIEF</div>
466 <div class="xdocText">Add available buffer to virtqueue's available buffer list.
467 Only used by Host.</div>
468 <span id="xdoc-sect-3"></span>
469 <div class="xdocSect">RETURN</div>
470 <div class="xdocText">Remaining capacity of queue or a negative error.</div>
471 <span id="xdoc-sect-4"></span>
472 <div class="xdocSect">SA</div>
473 <div class="xdocText">VirtQueue_getUsedBuf</div>
474 <div class="xdocSynSpacer"> </div>
475 <a class="xdocAnchor" id="add.Used.Buf"></a>
476 <table class="xdocHdr"><tr>
477 <td class="xdocHdrTitle"><span class="xdoc-id">VirtQueue_</span><span class="xdoc-id">addUsedBuf</span>() <small><span class="xdocSynSum">// instance</span></small></td>
478 <td class="xdocHdrArrow">
479 <a class="xdocHdrLink" href="../../../../ti/ipc/family/omapl138/VirtQueue.html" title="module VirtQueue"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
480 </table>
481 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/omapl138/VirtQueue.html#add.Used.Buf">index URL</a></div>
482 <span id='targ-synop'></span>
483 <table class="xdocLabel"><tr>
484 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
485 <td class="xdocLabelRight">target-domain</td>
486 </tr></table>
487 <div class="xdocSynTdcl">
488 <div class="xdocSynCode">
489 <tt></tt><tt></tt><span class="xdoc-kw2">Int</span> <span class="xdoc-id">VirtQueue_addUsedBuf</span>(<a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Handle">VirtQueue_Handle</a> handle, <span class="xdoc-kw2">Int16</span> <span class="xdoc-id">token</span>, <span class="xdoc-kw2">Int</span> <span class="xdoc-id">len</span>);
490 </div>
491 </div>
492 <div class="xdocSynSpacer"> </div>
493 <span id="xdoc-sect-1"></span>
494 <div class="xdocSect">ARGUMENTS</div>
495 <div class="xdocChild"><span class="xdocChildId">handle</span>
496 <span class="xdocChildSum">— handle of a previously-created <tt>VirtQueue</tt> instance object</span>
497 </div>
498 <div class="xdocChild"><span class="xdocChildId"></span>
499 <span class="xdocChildSum">— [in] vq the VirtQueue.
500 [in] token token of the buffer added to vring used list.
501 [in] len length of the message being added.</span>
502 </div>
503 <span id="xdoc-sect-2"></span>
504 <div class="xdocSect">BRIEF</div>
505 <div class="xdocText">Add used buffer to virtqueue's used buffer list.
506 Only used by Slave.</div>
507 <span id="xdoc-sect-3"></span>
508 <div class="xdocSect">RETURN</div>
509 <div class="xdocText">Remaining capacity of queue or a negative error.</div>
510 <span id="xdoc-sect-4"></span>
511 <div class="xdocSect">SA</div>
512 <div class="xdocText">VirtQueue_getAvailBuf</div>
513 <div class="xdocSynSpacer"> </div>
514 <a class="xdocAnchor" id="get.Avail.Buf"></a>
515 <table class="xdocHdr"><tr>
516 <td class="xdocHdrTitle"><span class="xdoc-id">VirtQueue_</span><span class="xdoc-id">getAvailBuf</span>() <small><span class="xdocSynSum">// instance</span></small></td>
517 <td class="xdocHdrArrow">
518 <a class="xdocHdrLink" href="../../../../ti/ipc/family/omapl138/VirtQueue.html" title="module VirtQueue"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
519 </table>
520 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/omapl138/VirtQueue.html#get.Avail.Buf">index URL</a></div>
521 <span id='targ-synop'></span>
522 <table class="xdocLabel"><tr>
523 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
524 <td class="xdocLabelRight">target-domain</td>
525 </tr></table>
526 <div class="xdocSynTdcl">
527 <div class="xdocSynCode">
528 <tt></tt><tt></tt><span class="xdoc-kw2">Int16</span> <span class="xdoc-id">VirtQueue_getAvailBuf</span>(<a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Handle">VirtQueue_Handle</a> handle, <span class="xdoc-kw2">Void</span> **<span class="xdoc-id">buf</span>, <span class="xdoc-kw2">Int</span> *<span class="xdoc-id">len</span>);
529 </div>
530 </div>
531 <div class="xdocSynSpacer"> </div>
532 <span id="xdoc-sect-1"></span>
533 <div class="xdocSect">ARGUMENTS</div>
534 <div class="xdocChild"><span class="xdocChildId">handle</span>
535 <span class="xdocChildSum">— handle of a previously-created <tt>VirtQueue</tt> instance object</span>
536 </div>
537 <div class="xdocChild"><span class="xdocChildId"></span>
538 <span class="xdocChildSum">— [in] vq the VirtQueue.
539 [out] buf Pointer to location of available buffer;
540 [out] len Length of the available buffer message.</span>
541 </div>
542 <span id="xdoc-sect-2"></span>
543 <div class="xdocSect">BRIEF</div>
544 <div class="xdocText">Get the next available buffer.
545 Only used by Slave.</div>
546 <span id="xdoc-sect-3"></span>
547 <div class="xdocSect">RETURN</div>
548 <div class="xdocText">Returns a token used to identify the available buffer, to be
549 passed back into VirtQueue_addUsedBuf();
550 token is negative if failure to find an available buffer.</div>
551 <span id="xdoc-sect-4"></span>
552 <div class="xdocSect">SA</div>
553 <div class="xdocText">VirtQueue_addUsedBuf</div>
554 <div class="xdocSynSpacer"> </div>
555 <a class="xdocAnchor" id="get.Id"></a>
556 <table class="xdocHdr"><tr>
557 <td class="xdocHdrTitle"><span class="xdoc-id">VirtQueue_</span><span class="xdoc-id">getId</span>() <small><span class="xdocSynSum">// instance</span></small></td>
558 <td class="xdocHdrArrow">
559 <a class="xdocHdrLink" href="../../../../ti/ipc/family/omapl138/VirtQueue.html" title="module VirtQueue"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
560 </table>
561 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/omapl138/VirtQueue.html#get.Id">index URL</a></div>
562 <span id='targ-synop'></span>
563 <table class="xdocLabel"><tr>
564 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
565 <td class="xdocLabelRight">target-domain</td>
566 </tr></table>
567 <div class="xdocSynTdcl">
568 <div class="xdocSynCode">
569 <tt></tt><tt></tt><span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">VirtQueue_getId</span>(<a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Handle">VirtQueue_Handle</a> handle);
570 </div>
571 </div>
572 <div class="xdocSynSpacer"> </div>
573 <span id="xdoc-sect-1"></span>
574 <div class="xdocSect">ARGUMENTS</div>
575 <div class="xdocChild"><span class="xdocChildId">handle</span>
576 <span class="xdocChildSum">— handle of a previously-created <tt>VirtQueue</tt> instance object</span>
577 </div>
578 <div class="xdocChild"><span class="xdocChildId"></span>
579 <span class="xdocChildSum">— [in] vq the VirtQueue.</span>
580 </div>
581 <span id="xdoc-sect-2"></span>
582 <div class="xdocSect">DETAILS</div>
583 <div class="xdocText">Returns VirtQueue instance's queue ID.</div>
584 <span id="xdoc-sect-3"></span>
585 <div class="xdocSect">BRIEF</div>
586 <div class="xdocText">VirtQueue instance returns queue ID</div>
587 <div class="xdocSynSpacer"> </div>
588 <a class="xdocAnchor" id="get.Swi.Handle"></a>
589 <table class="xdocHdr"><tr>
590 <td class="xdocHdrTitle"><span class="xdoc-id">VirtQueue_</span><span class="xdoc-id">getSwiHandle</span>() <small><span class="xdocSynSum">// instance</span></small></td>
591 <td class="xdocHdrArrow">
592 <a class="xdocHdrLink" href="../../../../ti/ipc/family/omapl138/VirtQueue.html" title="module VirtQueue"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
593 </table>
594 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/omapl138/VirtQueue.html#get.Swi.Handle">index URL</a></div>
595 <span id='targ-synop'></span>
596 <table class="xdocLabel"><tr>
597 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
598 <td class="xdocLabelRight">target-domain</td>
599 </tr></table>
600 <div class="xdocSynTdcl">
601 <div class="xdocSynCode">
602 <tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/sysbios/knl/Swi.html#per-instance_object_types" title="ti.sysbios.knl.Swi.Handle">Swi_Handle</a> <span class="xdoc-id">VirtQueue_getSwiHandle</span>(<a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Handle">VirtQueue_Handle</a> handle);
603 </div>
604 </div>
605 <div class="xdocSynSpacer"> </div>
606 <span id="xdoc-sect-1"></span>
607 <div class="xdocSect">ARGUMENTS</div>
608 <div class="xdocChild"><span class="xdocChildId">handle</span>
609 <span class="xdocChildSum">— handle of a previously-created <tt>VirtQueue</tt> instance object</span>
610 </div>
611 <div class="xdocChild"><span class="xdocChildId"></span>
612 <span class="xdocChildSum">— [in] vq the VirtQueue.</span>
613 </div>
614 <span id="xdoc-sect-2"></span>
615 <div class="xdocSect">DETAILS</div>
616 <div class="xdocText">Returns VirtQueue instance Swi handle</div>
617 <span id="xdoc-sect-3"></span>
618 <div class="xdocSect">BRIEF</div>
619 <div class="xdocText">VirtQueue instance returns Swi handle</div>
620 <div class="xdocSynSpacer"> </div>
621 <a class="xdocAnchor" id="get.Used.Buf"></a>
622 <table class="xdocHdr"><tr>
623 <td class="xdocHdrTitle"><span class="xdoc-id">VirtQueue_</span><span class="xdoc-id">getUsedBuf</span>() <small><span class="xdocSynSum">// instance</span></small></td>
624 <td class="xdocHdrArrow">
625 <a class="xdocHdrLink" href="../../../../ti/ipc/family/omapl138/VirtQueue.html" title="module VirtQueue"><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/family/omapl138/VirtQueue.html#get.Used.Buf">index URL</a></div>
628 <span id='targ-synop'></span>
629 <table class="xdocLabel"><tr>
630 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
631 <td class="xdocLabelRight">target-domain</td>
632 </tr></table>
633 <div class="xdocSynTdcl">
634 <div class="xdocSynCode">
635 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> *<span class="xdoc-id">VirtQueue_getUsedBuf</span>(<a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Handle">VirtQueue_Handle</a> handle);
636 </div>
637 </div>
638 <div class="xdocSynSpacer"> </div>
639 <span id="xdoc-sect-1"></span>
640 <div class="xdocSect">ARGUMENTS</div>
641 <div class="xdocChild"><span class="xdocChildId">handle</span>
642 <span class="xdocChildSum">— handle of a previously-created <tt>VirtQueue</tt> instance object</span>
643 </div>
644 <div class="xdocChild"><span class="xdocChildId"></span>
645 <span class="xdocChildSum">— [in] vq the VirtQueue.</span>
646 </div>
647 <span id="xdoc-sect-2"></span>
648 <div class="xdocSect">BRIEF</div>
649 <div class="xdocText">Get the next used buffer.
650 Only used by Host.</div>
651 <span id="xdoc-sect-3"></span>
652 <div class="xdocSect">RETURN</div>
653 <div class="xdocText">Returns NULL or the processed buffer.</div>
654 <span id="xdoc-sect-4"></span>
655 <div class="xdocSect">SA</div>
656 <div class="xdocText">VirtQueue_addAvailBuf</div>
657 <div class="xdocSynSpacer"> </div>
658 <a class="xdocAnchor" id="is.Host"></a>
659 <table class="xdocHdr"><tr>
660 <td class="xdocHdrTitle"><span class="xdoc-id">VirtQueue_</span><span class="xdoc-id">isHost</span>() <small><span class="xdocSynSum">// instance</span></small></td>
661 <td class="xdocHdrArrow">
662 <a class="xdocHdrLink" href="../../../../ti/ipc/family/omapl138/VirtQueue.html" title="module VirtQueue"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
663 </table>
664 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/omapl138/VirtQueue.html#is.Host">index URL</a></div>
665 <span id='targ-synop'></span>
666 <table class="xdocLabel"><tr>
667 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
668 <td class="xdocLabelRight">target-domain</td>
669 </tr></table>
670 <div class="xdocSynTdcl">
671 <div class="xdocSynCode">
672 <tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">VirtQueue_isHost</span>(<a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Handle">VirtQueue_Handle</a> handle);
673 </div>
674 </div>
675 <div class="xdocSynSpacer"> </div>
676 <span id="xdoc-sect-1"></span>
677 <div class="xdocSect">ARGUMENTS</div>
678 <div class="xdocChild"><span class="xdocChildId">handle</span>
679 <span class="xdocChildSum">— handle of a previously-created <tt>VirtQueue</tt> instance object</span>
680 </div>
681 <div class="xdocChild"><span class="xdocChildId"></span>
682 <span class="xdocChildSum">— [in] vq the VirtQueue.</span>
683 </div>
684 <span id="xdoc-sect-2"></span>
685 <div class="xdocSect">DETAILS</div>
686 <div class="xdocText">Returns if this VirtQueue instance belongs to a host</div>
687 <span id="xdoc-sect-3"></span>
688 <div class="xdocSect">BRIEF</div>
689 <div class="xdocText">VirtQueue instance returns host status</div>
690 <div class="xdocSynSpacer"> </div>
691 <a class="xdocAnchor" id="is.Slave"></a>
692 <table class="xdocHdr"><tr>
693 <td class="xdocHdrTitle"><span class="xdoc-id">VirtQueue_</span><span class="xdoc-id">isSlave</span>() <small><span class="xdocSynSum">// instance</span></small></td>
694 <td class="xdocHdrArrow">
695 <a class="xdocHdrLink" href="../../../../ti/ipc/family/omapl138/VirtQueue.html" title="module VirtQueue"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
696 </table>
697 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/omapl138/VirtQueue.html#is.Slave">index URL</a></div>
698 <span id='targ-synop'></span>
699 <table class="xdocLabel"><tr>
700 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
701 <td class="xdocLabelRight">target-domain</td>
702 </tr></table>
703 <div class="xdocSynTdcl">
704 <div class="xdocSynCode">
705 <tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">VirtQueue_isSlave</span>(<a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Handle">VirtQueue_Handle</a> handle);
706 </div>
707 </div>
708 <div class="xdocSynSpacer"> </div>
709 <span id="xdoc-sect-1"></span>
710 <div class="xdocSect">ARGUMENTS</div>
711 <div class="xdocChild"><span class="xdocChildId">handle</span>
712 <span class="xdocChildSum">— handle of a previously-created <tt>VirtQueue</tt> instance object</span>
713 </div>
714 <div class="xdocChild"><span class="xdocChildId"></span>
715 <span class="xdocChildSum">— [in] vq the VirtQueue.</span>
716 </div>
717 <span id="xdoc-sect-2"></span>
718 <div class="xdocSect">DETAILS</div>
719 <div class="xdocText">Returns if this VirtQueue instance belongs to a slave</div>
720 <span id="xdoc-sect-3"></span>
721 <div class="xdocSect">BRIEF</div>
722 <div class="xdocText">VirtQueue instance returns slave status</div>
723 <div class="xdocSynSpacer"> </div>
724 <a class="xdocAnchor" id="kick"></a>
725 <table class="xdocHdr"><tr>
726 <td class="xdocHdrTitle"><span class="xdoc-id">VirtQueue_</span><span class="xdoc-id">kick</span>() <small><span class="xdocSynSum">// instance</span></small></td>
727 <td class="xdocHdrArrow">
728 <a class="xdocHdrLink" href="../../../../ti/ipc/family/omapl138/VirtQueue.html" title="module VirtQueue"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
729 </table>
730 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/omapl138/VirtQueue.html#kick">index URL</a></div>
731 <span id='targ-synop'></span>
732 <table class="xdocLabel"><tr>
733 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
734 <td class="xdocLabelRight">target-domain</td>
735 </tr></table>
736 <div class="xdocSynTdcl">
737 <div class="xdocSynCode">
738 <tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">VirtQueue_kick</span>(<a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Handle">VirtQueue_Handle</a> handle);
739 </div>
740 </div>
741 <div class="xdocSynSpacer"> </div>
742 <span id="xdoc-sect-1"></span>
743 <div class="xdocSect">ARGUMENTS</div>
744 <div class="xdocChild"><span class="xdocChildId">handle</span>
745 <span class="xdocChildSum">— handle of a previously-created <tt>VirtQueue</tt> instance object</span>
746 </div>
747 <div class="xdocChild"><span class="xdocChildId"></span>
748 <span class="xdocChildSum">— [in] vq the VirtQueue.</span>
749 </div>
750 <span id="xdoc-sect-2"></span>
751 <div class="xdocSect">DETAILS</div>
752 <div class="xdocText">After one or more add_buf calls, invoke this to kick the other side.</div>
753 <span id="xdoc-sect-3"></span>
754 <div class="xdocSect">BRIEF</div>
755 <div class="xdocText">Notify other processor of new buffers in the queue.</div>
756 <span id="xdoc-sect-4"></span>
757 <div class="xdocSect">SA</div>
758 <div class="xdocText">VirtQueue_addBuf</div>
759 <a class="xdocAnchor" id="per-instance_built-ins"></a>
760 <table class="xdocHdr"><tr>
761 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Built-Ins</span></td>
762 <td class="xdocHdrArrow">
763 <a class="xdocHdrLink" href="../../../../ti/ipc/family/omapl138/VirtQueue.html" title="module VirtQueue"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
764 </table>
765 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/omapl138/VirtQueue.html#per-instance_built-ins">index URL</a></div>
766 <p class="xdocHdrSummary"></p>
767 <span id='targ-synop'></span>
768 <table class="xdocLabel"><tr>
769 <td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
770 <td class="xdocLabelRight">target-domain</td>
771 </tr></table>
772 <div class="xdocSynTdcl">
773 <div class="xdocSynCode">
774 <tt></tt><tt></tt><span class="xdoc-kw2">Int</span> <span class="xdoc-id">VirtQueue_Object_count</span>();
775 </div>
776 <div class='xdocSynSum'><tt></tt><tt></tt>// The number of statically-created instance objects</div>
777 <div class="xdocSynSpacer"> </div>
778 <div class="xdocSynCode">
779 <tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Handle">VirtQueue_Handle</a> <span class="xdoc-id">VirtQueue_Object_get</span>(<a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Object">VirtQueue_Object</a> *array, <span class="xdoc-kw2">Int</span> i);
780 </div>
781 <div class='xdocSynSum'><tt></tt><tt></tt>// The handle of the i-th statically-created instance object (array == NULL)</div>
782 <div class="xdocSynSpacer"> </div>
783 <div class="xdocSynCode">
784 <tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Handle">VirtQueue_Handle</a> <span class="xdoc-id">VirtQueue_Object_first</span>();
785 </div>
786 <div class='xdocSynSum'><tt></tt><tt></tt>// The handle of the first dynamically-created instance object, or NULL</div>
787 <div class="xdocSynSpacer"> </div>
788 <div class="xdocSynCode">
789 <tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Handle">VirtQueue_Handle</a> <span class="xdoc-id">VirtQueue_Object_next</span>(<a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Handle">VirtQueue_Handle</a> handle);
790 </div>
791 <div class='xdocSynSum'><tt></tt><tt></tt>// The handle of the next dynamically-created instance object, or NULL</div>
792 <div class="xdocSynSpacer"> </div>
793 <div class="xdocSynCode">
794 <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">VirtQueue_Object_heap</span>();
795 </div>
796 <div class='xdocSynSum'><tt></tt><tt></tt>// The heap used to allocate dynamically-created instance objects</div>
797 <div class="xdocSynSpacer"> </div>
798 <div class="xdocSynCode">
799 <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">VirtQueue_Handle_label</span>(<a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Handle">VirtQueue_Handle</a> handle, <a class="xdoc-link" href="../../../../xdc/runtime/Types.html#.Label" title="xdc.runtime.Types.Label">Types_Label</a> *buf);
800 </div>
801 <div class='xdocSynSum'><tt></tt><tt></tt>// The label associated with this instance object</div>
802 <div class="xdocSynSpacer"> </div>
803 <div class="xdocSynCode">
804 <tt></tt><tt></tt><span class="xdoc-kw2">String</span> <span class="xdoc-id">VirtQueue_Handle_name</span>(<a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#per-instance_object_types" title="ti.ipc.family.omapl138.VirtQueue.Handle">VirtQueue_Handle</a> handle);
805 </div>
806 <div class='xdocSynSum'><tt></tt><tt></tt>// The name of this instance object</div>
807 </div>
808 </div>
809 <div class="xdocSynSpacer"> </div>
810 <span id='meta-synop'></span>
811 <table class="xdocLabel"><tr>
812 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2"></span></tt>Configuration settings</td>
813 <td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../../ti/ipc/family/omapl138/VirtQueue-src.html"><span class="xdocLabelFile">ti/ipc/family/omapl138/VirtQueue.xdc</span></a></td>
814 </tr></table>
815 <div class="xdocSynM">
816 <div class="xdocSynCode">
817 <tt></tt><span class="xdoc-kw1">var</span> VirtQueue = <span class="xdoc-kw3">xdc.useModule</span>(<span class="xdoc-id">'ti.ipc.family.omapl138.VirtQueue'</span>);
818 </div>
819 <div class='xdocSynHdr'>module-wide config parameters</div>
821 <div class="xdocSynCode">
822 <tt> </tt><tt></tt><a class="xdocSynGo" href="#meta.P.A.G.E_.S.I.Z.E">VirtQueue.<span class="xdoc-id">PAGE_SIZE</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a> = <i><span class="xdoc-kw2">UInt</span></i> 4096;
823 </div>
824 <div class="xdocSynCode">
825 <tt> </tt><tt></tt><a class="xdocSynGo" href="#meta.R.P_.M.S.G_.N.U.M_.B.U.F.S">VirtQueue.<span class="xdoc-id">RP_MSG_NUM_BUFS</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a> = <i><span class="xdoc-kw2">UInt</span></i> <a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#.V.Q0_.S.I.Z.E" title="ti.ipc.family.omapl138.VirtQueue.VQ0_SIZE">VirtQueue.VQ0_SIZE</a>;
826 </div>
827 <div class="xdocSynCode">
828 <tt> </tt><tt></tt><a class="xdocSynGo" href="#meta.R.P_.M.S.G_.V.R.I.N.G_.A.L.I.G.N">VirtQueue.<span class="xdoc-id">RP_MSG_VRING_ALIGN</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a> = <i><span class="xdoc-kw2">UInt</span></i> 4096;
829 </div>
830 <div class="xdocSynCode">
831 <tt> </tt><tt></tt><a class="xdocSynGo" href="#meta.V.Q1_.S.I.Z.E">VirtQueue.<span class="xdoc-id">VQ1_SIZE</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a> = <i><span class="xdoc-kw2">UInt</span></i> 256;
832 </div>
833 <div class="xdocSynSpacer"> </div>
834 <div class="xdocSynCode">
835 <tt> </tt><tt></tt><a class="xdocSynGo" href="#common$">VirtQueue.<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>;
836 </div>
837 <div class='xdocSynHdr'>per-instance config parameters</div>
839 <div class="xdocSynCode">
840 <tt> </tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> VirtQueue.<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>;
841 </div>
842 <div class="xdocSynCode">
843 <tt> </tt><tt> </tt>params.<a class="xdocSynGo" href="#metacallback"><span class="xdoc-id">callback</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a> = <i><span class="xdoc-kw2">Fxn</span></i> <span class="xdoc-kw2">null</span>;
844 </div>
845 <div class="xdocSynCode">
846 <tt> </tt><tt> </tt>params.<a class="xdocSynGo" href="#metavq.Id"><span class="xdoc-id">vqId</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// </span></span></a> = <i><span class="xdoc-kw2">Int</span></i> 0;
847 </div>
848 <div class='xdocSynHdr'>per-instance creation</div>
850 <div class="xdocSynCode">
851 <tt> </tt><tt></tt><span class="xdoc-kw1">var</span> inst = VirtQueue.<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">remoteProcId</span>, params);
852 </div>
853 <div class="xdocSynSpacer"> </div>
854 </div>
855 <div id="xdocSep">
856 </div>
857 <div id="xdocMetaElems">
858 <div class="xdocSynSpacer"> </div>
859 <a class="xdocAnchor" id="meta.P.A.G.E_.S.I.Z.E"></a>
860 <table class="xdocHdr"><tr>
861 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">VirtQueue.</span><span class="xdoc-id">PAGE_SIZE</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
862 <td class="xdocHdrArrow">
863 <a class="xdocHdrLink" href="../../../../ti/ipc/family/omapl138/VirtQueue.html" title="module VirtQueue"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
864 </table>
865 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/omapl138/VirtQueue.html#.P.A.G.E_.S.I.Z.E">index URL</a></div>
866 <span id='meta-synop'></span>
867 <table class="xdocLabel"><tr>
868 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
869 <td class="xdocLabelRight"></td>
870 </tr></table>
871 <div class="xdocSynMdcl">
872 <div class="xdocSynCode">
873 <tt></tt><tt></tt>VirtQueue.<span class="xdoc-id">PAGE_SIZE</span> = <i><span class="xdoc-kw2">UInt</span></i> 4096;
874 </div>
875 </div>
876 <div class="xdocSynSpacer"> </div>
877 <div class="xdocSect">C SYNOPSIS</div>
878 <div class="xdocText"><a class="xdoc-link" href="#.P.A.G.E_.S.I.Z.E" title="VirtQueue_PAGE_SIZE">VirtQueue_PAGE_SIZE</a></div>
879 <div class="xdocSynSpacer"> </div>
880 <a class="xdocAnchor" id="meta.R.P_.M.S.G_.N.U.M_.B.U.F.S"></a>
881 <table class="xdocHdr"><tr>
882 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">VirtQueue.</span><span class="xdoc-id">RP_MSG_NUM_BUFS</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
883 <td class="xdocHdrArrow">
884 <a class="xdocHdrLink" href="../../../../ti/ipc/family/omapl138/VirtQueue.html" title="module VirtQueue"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
885 </table>
886 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/omapl138/VirtQueue.html#.R.P_.M.S.G_.N.U.M_.B.U.F.S">index URL</a></div>
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>VirtQueue.<span class="xdoc-id">RP_MSG_NUM_BUFS</span> = <i><span class="xdoc-kw2">UInt</span></i> <a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#.V.Q0_.S.I.Z.E" title="ti.ipc.family.omapl138.VirtQueue.VQ0_SIZE">VirtQueue.VQ0_SIZE</a>;
895 </div>
896 </div>
897 <div class="xdocSynSpacer"> </div>
898 <div class="xdocSect">C SYNOPSIS</div>
899 <div class="xdocText"><a class="xdoc-link" href="#.R.P_.M.S.G_.N.U.M_.B.U.F.S" title="VirtQueue_RP_MSG_NUM_BUFS">VirtQueue_RP_MSG_NUM_BUFS</a></div>
900 <div class="xdocSynSpacer"> </div>
901 <a class="xdocAnchor" id="meta.R.P_.M.S.G_.V.R.I.N.G_.A.L.I.G.N"></a>
902 <table class="xdocHdr"><tr>
903 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">VirtQueue.</span><span class="xdoc-id">RP_MSG_VRING_ALIGN</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
904 <td class="xdocHdrArrow">
905 <a class="xdocHdrLink" href="../../../../ti/ipc/family/omapl138/VirtQueue.html" title="module VirtQueue"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
906 </table>
907 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/omapl138/VirtQueue.html#.R.P_.M.S.G_.V.R.I.N.G_.A.L.I.G.N">index URL</a></div>
908 <span id='meta-synop'></span>
909 <table class="xdocLabel"><tr>
910 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
911 <td class="xdocLabelRight"></td>
912 </tr></table>
913 <div class="xdocSynMdcl">
914 <div class="xdocSynCode">
915 <tt></tt><tt></tt>VirtQueue.<span class="xdoc-id">RP_MSG_VRING_ALIGN</span> = <i><span class="xdoc-kw2">UInt</span></i> 4096;
916 </div>
917 </div>
918 <div class="xdocSynSpacer"> </div>
919 <div class="xdocSect">C SYNOPSIS</div>
920 <div class="xdocText"><a class="xdoc-link" href="#.R.P_.M.S.G_.V.R.I.N.G_.A.L.I.G.N" title="VirtQueue_RP_MSG_VRING_ALIGN">VirtQueue_RP_MSG_VRING_ALIGN</a></div>
921 <div class="xdocSynSpacer"> </div>
922 <a class="xdocAnchor" id="meta.V.Q1_.S.I.Z.E"></a>
923 <table class="xdocHdr"><tr>
924 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">VirtQueue.</span><span class="xdoc-id">VQ1_SIZE</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
925 <td class="xdocHdrArrow">
926 <a class="xdocHdrLink" href="../../../../ti/ipc/family/omapl138/VirtQueue.html" title="module VirtQueue"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
927 </table>
928 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/omapl138/VirtQueue.html#.V.Q1_.S.I.Z.E">index URL</a></div>
929 <span id='meta-synop'></span>
930 <table class="xdocLabel"><tr>
931 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
932 <td class="xdocLabelRight"></td>
933 </tr></table>
934 <div class="xdocSynMdcl">
935 <div class="xdocSynCode">
936 <tt></tt><tt></tt>VirtQueue.<span class="xdoc-id">VQ1_SIZE</span> = <i><span class="xdoc-kw2">UInt</span></i> 256;
937 </div>
938 </div>
939 <div class="xdocSynSpacer"> </div>
940 <div class="xdocSect">C SYNOPSIS</div>
941 <div class="xdocText"><a class="xdoc-link" href="#.V.Q1_.S.I.Z.E" title="VirtQueue_VQ1_SIZE">VirtQueue_VQ1_SIZE</a></div>
942 <div class="xdocSynSpacer"> </div>
943 <a class="xdocAnchor" id="common$"></a>
944 <table class="xdocHdr"><tr>
945 <td class="xdocHdrTitle"><span class="xdoc-kw1">metaonly </span><span class="xdoc-kw1">config</span> <span class="xdoc-id">VirtQueue.</span><span class="xdoc-id">common$</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
946 <td class="xdocHdrArrow">
947 <a class="xdocHdrLink" href="../../../../ti/ipc/family/omapl138/VirtQueue.html" title="module VirtQueue"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
948 </table>
949 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/omapl138/VirtQueue.html#common$">index URL</a></div>
950 <p class="xdocHdrSummaryDcl">Common module configuration parameters</p>
951 <span id='meta-synop'></span>
952 <table class="xdocLabel"><tr>
953 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
954 <td class="xdocLabelRight"></td>
955 </tr></table>
956 <div class="xdocSynMdcl">
957 <div class="xdocSynCode">
958 <tt></tt><tt></tt>VirtQueue.<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>;
959 </div>
960 </div>
961 <div class="xdocSynSpacer"> </div>
962 <span id="xdoc-sect-1"></span>
963 <div class="xdocSect">DETAILS</div>
964 <div class="xdocText">All modules have this configuration parameter. Its name
965 contains the '$' character to ensure it does not conflict with
966 configuration parameters declared by the module. This allows
967 new configuration parameters to be added in the future without
968 any chance of breaking existing modules.</div>
969 <a class="xdocAnchor" id="metaper-instance_config_parameters"></a>
970 <table class="xdocHdr"><tr>
971 <td class="xdocHdrTitle"><span class="xdocSynSum">Instance Config Parameters</span></td>
972 <td class="xdocHdrArrow">
973 <a class="xdocHdrLink" href="../../../../ti/ipc/family/omapl138/VirtQueue.html" title="module VirtQueue"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
974 </table>
975 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/omapl138/VirtQueue.html#per-instance_config_parameters">index URL</a></div>
976 <p class="xdocHdrSummary"></p>
977 <span id='meta-synop'></span>
978 <table class="xdocLabel"><tr>
979 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
980 <td class="xdocLabelRight"></td>
981 </tr></table>
982 <div class="xdocSynMdcl">
983 <div class="xdocSynCode">
984 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> VirtQueue.<span class="xdoc-id">Params</span>;
985 </div>
986 <div class='xdocSynSum'><tt></tt><tt></tt>// Instance config-params object</div>
987 <div class="xdocSynCode">
988 <tt></tt><tt> </tt>params.<span class="xdoc-id">callback</span> = <i><span class="xdoc-kw2">Fxn</span></i> <span class="xdoc-kw2">null</span>;
989 </div>
990 <div class='xdocSynSum'><tt></tt><tt> </tt>// </div>
991 <div class="xdocSynCode">
992 <tt></tt><tt> </tt>params.<span class="xdoc-id">vqId</span> = <i><span class="xdoc-kw2">Int</span></i> 0;
993 </div>
994 <div class='xdocSynSum'><tt></tt><tt> </tt>// </div>
995 </div>
996 <div class="xdocSynSpacer"> </div>
997 <a class="xdocAnchor" id="metacallback"></a>
998 <table class="xdocHdr"><tr>
999 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">VirtQueue.Params.</span><span class="xdoc-id">callback</span> <small><span class="xdocSynSum">// instance</span></small></td>
1000 <td class="xdocHdrArrow">
1001 <a class="xdocHdrLink" href="../../../../ti/ipc/family/omapl138/VirtQueue.html" title="module VirtQueue"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
1002 </table>
1003 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/omapl138/VirtQueue.html#callback">index URL</a></div>
1004 <span id='meta-synop'></span>
1005 <table class="xdocLabel"><tr>
1006 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
1007 <td class="xdocLabelRight"></td>
1008 </tr></table>
1009 <div class="xdocSynMdcl">
1010 <div class="xdocSynCode">
1011 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> VirtQueue.<span class="xdoc-id">Params</span>;
1012 </div>
1013 <div class="xdocSynCode">
1014 <tt></tt><tt></tt><b> ...</b>
1015 </div>
1016 <div class="xdocSynCode">
1017 <tt></tt><tt></tt>params.<span class="xdoc-id">callback</span> = <i><span class="xdoc-kw2">Fxn</span></i> <span class="xdoc-kw2">null</span>;
1018 </div>
1019 </div>
1020 <div class="xdocSynSpacer"> </div>
1021 <div class="xdocSect">C SYNOPSIS</div>
1022 <div class="xdocText"><a class="xdoc-link" href="#callback" title="VirtQueue_Params.callback">VirtQueue_Params.callback</a></div>
1023 <div class="xdocSynSpacer"> </div>
1024 <a class="xdocAnchor" id="metavq.Id"></a>
1025 <table class="xdocHdr"><tr>
1026 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">VirtQueue.Params.</span><span class="xdoc-id">vqId</span> <small><span class="xdocSynSum">// instance</span></small></td>
1027 <td class="xdocHdrArrow">
1028 <a class="xdocHdrLink" href="../../../../ti/ipc/family/omapl138/VirtQueue.html" title="module VirtQueue"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
1029 </table>
1030 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/omapl138/VirtQueue.html#vq.Id">index URL</a></div>
1031 <span id='meta-synop'></span>
1032 <table class="xdocLabel"><tr>
1033 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
1034 <td class="xdocLabelRight"></td>
1035 </tr></table>
1036 <div class="xdocSynMdcl">
1037 <div class="xdocSynCode">
1038 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> VirtQueue.<span class="xdoc-id">Params</span>;
1039 </div>
1040 <div class="xdocSynCode">
1041 <tt></tt><tt></tt><b> ...</b>
1042 </div>
1043 <div class="xdocSynCode">
1044 <tt></tt><tt></tt>params.<span class="xdoc-id">vqId</span> = <i><span class="xdoc-kw2">Int</span></i> 0;
1045 </div>
1046 </div>
1047 <div class="xdocSynSpacer"> </div>
1048 <div class="xdocSect">C SYNOPSIS</div>
1049 <div class="xdocText"><a class="xdoc-link" href="#vq.Id" title="VirtQueue_Params.vqId">VirtQueue_Params.vqId</a></div>
1050 <a class="xdocAnchor" id="metaper-instance_creation"></a>
1051 <table class="xdocHdr"><tr>
1052 <td class="xdocHdrTitle"><span class="xdocSynSum">Static Instance Creation</span></td>
1053 <td class="xdocHdrArrow">
1054 <a class="xdocHdrLink" href="../../../../ti/ipc/family/omapl138/VirtQueue.html" title="module VirtQueue"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
1055 </table>
1056 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/ipc/family/omapl138/VirtQueue.html#per-instance_creation">index URL</a></div>
1057 <p class="xdocHdrSummary"></p>
1058 <span id='meta-synop'></span>
1059 <table class="xdocLabel"><tr>
1060 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
1061 <td class="xdocLabelRight"></td>
1062 </tr></table>
1063 <div class="xdocSynMdcl">
1064 <div class="xdocSynCode">
1065 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> VirtQueue.<a class="xdoc-link" href="../../../../ti/ipc/family/omapl138/VirtQueue.html#metaper-instance_config_parameters" title="ti.ipc.family.omapl138.VirtQueue.Params">Params</a>;
1066 </div>
1067 <div class='xdocSynSum'><tt></tt><tt></tt>// Allocate instance config-params</div>
1068 <div class="xdocSynCode">
1069 <tt></tt><tt></tt>params.<i>config</i> = <b> ...</b>
1070 </div>
1071 <div class='xdocSynSum'><tt></tt><tt></tt>// Assign individual configs</div>
1072 <div class="xdocSynSpacer"> </div>
1073 <div class="xdocSynCode">
1074 <tt></tt><tt></tt><span class="xdoc-kw1">var</span> inst = VirtQueue.<span class="xdoc-id">create</span>(<i><span class="xdoc-kw2">UInt16</span></i> <span class="xdoc-id">remoteProcId</span>, params);
1075 </div>
1076 <div class='xdocSynSum'><tt></tt><tt></tt>// Create an instance-object</div>
1077 </div>
1078 <span id="xdoc-sect-1"></span>
1079 <div class="xdocSect">ARGUMENTS</div>
1080 <div class="xdocChild"><span class="xdocChildId"></span>
1081 <span class="xdocChildSum">— [in] remoteProcId Remote processor ID associated with this VirtQueue.</span>
1082 </div>
1083 <div class="xdocChild"><span class="xdocChildId">params</span>
1084 <span class="xdocChildSum">— per-instance config params, or <tt>NULL</tt> to select default values (target-domain only)</span>
1085 </div>
1086 <div class="xdocChild"><span class="xdocChildId">eb</span>
1087 <span class="xdocChildSum">— active error-handling block, or <tt>NULL</tt> to select default policy (target-domain only)</span>
1088 </div>
1089 <span id="xdoc-sect-2"></span>
1090 <div class="xdocSect">DETAILS</div>
1091 <div class="xdocText">Maps to Instance_init function</div>
1092 <span id="xdoc-sect-3"></span>
1093 <div class="xdocSect">BRIEF</div>
1094 <div class="xdocText">Initialize at runtime the VirtQueue</div>
1095 <span id="xdoc-sect-4"></span>
1096 <div class="xdocSect">RETURNS</div>
1097 <div class="xdocText">Returns a handle to a new initialized VirtQueue.</div>
1098 </div>
1099 <div id="xdocDate">generated on Mon, 23 May 2016 14:31:25 GMT</div>
1100 </div></div></body>
1101 </html>