[processor-sdk/performance-audio-sr.git] / psdk_cust / ipc_3_43_00_00_eng / docs / cdoc / ti / ipc / ipcmgr / package / package.doc.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <package kind='package' name='ti.ipc.ipcmgr' nodoc='0' root='../../../' summary='Home+for+ipc+startup+%28and+later+config%2Fother+fxns%29+for+rpmsg+based+IPC'>
3 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Epackage%3C%2Fspan%3E+%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3Eti.ipc.ipcmgr%3C%2Fspan%3E%3C%2Fgo%3E+%5B1%2C+0%2C+0%5D+%7B'/>
4 <line tab='0' content='%7D'/>
5 <unit name='IpcMgr' kind='module' nodoc='0' metaonly='1' summary='IPC+Manager'>
6 <synopSpec>
7 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Epackage%3C%2Fspan%3E+%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2Fti%2Fipc%2Fipcmgr%2Fpackage.html%22+title%3D%22ti.ipc.ipcmgr%22%3Eti.ipc.ipcmgr%3C%2Fa%3E%3B'/>
8 <line blank='1' always='0'/>
9 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Emetaonly+%3C%2Fspan%3E%3Cspan+class%3D%22xdoc-kw1%22%3Emodule%3C%2Fspan%3E+%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EIpcMgr%3C%2Fspan%3E%3C%2Fgo%3E+%7B'/>
10 <line tab='0' content='%7D'/>
11 </synopSpec>
12 <specInfo>
13 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Emetaonly+%3C%2Fspan%3E%3Cspan+class%3D%22xdoc-kw1%22%3Emodule%3C%2Fspan%3E+%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EIpcMgr%3C%2Fspan%3E%3C%2Fgo%3E+%7B%3Cb%3E%26nbsp%3B%26nbsp%3B...%3C%2Fb%3E'/>
14 </specInfo>
15 <synopMeta>
16 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Evar%3C%2Fspan%3E+IpcMgr+%3D+%3Cspan+class%3D%22xdoc-kw3%22%3Exdc.useModule%3C%2Fspan%3E%28%3Cspan+class%3D%22xdoc-id%22%3E%27ti.ipc.ipcmgr.IpcMgr%27%3C%2Fspan%3E%29%3B'/>
17 </synopMeta>
18 <group name='module-wide constants & types'>
19 <decl spacer='1'/>
20 <decl kind='enum' name='TransCombo' anchor='.Trans.Combo' altext='ti.ipc.ipcmgr.IpcMgr.TransCombo' nodoc='0' external='1' overrides='0' readonly='0' instance='0' summary='Transport+combinations'>
21 <decl kind='enumval' name='TransCombo_RPMSG' anchor='.Trans.Combo_.R.P.M.S.G'/>
22 <decl kind='enumval' name='TransCombo_RPMSG_MESSAGEQ' anchor='.Trans.Combo_.R.P.M.S.G_.M.E.S.S.A.G.E.Q'/>
23 <decl kind='enumval' name='TransCombo_RPMSG_IPC' anchor='.Trans.Combo_.R.P.M.S.G_.I.P.C'/>
24 <synopSpec>
25 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Eenum%3C%2Fspan%3E+%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3ETransCombo%3C%2Fspan%3E%3C%2Fgo%3E+%7B'/>
26 <line tab='1' comment='RPMessage+only' content='%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3ETransCombo_RPMSG%3C%2Fspan%3E%3C%2Fgo%3E%2C+'/>
27 <line tab='1' comment='RPMessage+over+MessageQ' content='%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3ETransCombo_RPMSG_MESSAGEQ%3C%2Fspan%3E%3C%2Fgo%3E%2C+'/>
28 <line tab='1' comment='RpMessage+plus+IPC+between+slaves' content='%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3ETransCombo_RPMSG_IPC%3C%2Fspan%3E%3C%2Fgo%3E'/>
29 <line tab='0' content='%7D%3B'/>
30 </synopSpec>
31 <synopMeta>
32 <line tab='0' content='%3Ci%3Evalues+of+type+%3Cgo%3EIpcMgr.%3Cspan+class%3D%22xdoc-id%22%3ETransCombo%3C%2Fspan%3E%3C%2Fgo%3E%3C%2Fi%3E'/>
33 <line tab='1' comment='RPMessage+only' content='%3Cspan+class%3D%22xdoc-kw1%22%3Econst%3C%2Fspan%3E+%3Cgo%3EIpcMgr.%3Cspan+class%3D%22xdoc-id%22%3ETransCombo_RPMSG%3C%2Fspan%3E%3C%2Fgo%3E%3B'/>
34 <line tab='1' comment='RPMessage+over+MessageQ' content='%3Cspan+class%3D%22xdoc-kw1%22%3Econst%3C%2Fspan%3E+%3Cgo%3EIpcMgr.%3Cspan+class%3D%22xdoc-id%22%3ETransCombo_RPMSG_MESSAGEQ%3C%2Fspan%3E%3C%2Fgo%3E%3B'/>
35 <line tab='1' comment='RpMessage+plus+IPC+between+slaves' content='%3Cspan+class%3D%22xdoc-kw1%22%3Econst%3C%2Fspan%3E+%3Cgo%3EIpcMgr.%3Cspan+class%3D%22xdoc-id%22%3ETransCombo_RPMSG_IPC%3C%2Fspan%3E%3C%2Fgo%3E%3B'/>
36 </synopMeta>
37 <docSect name='details'>
38 <docPara content='IpcMgr+supports+the+following+transport+combinations.'/>
39 </docSect>
40 </decl>
41 <decl spacer='1'/>
42 </group>
43 <group name='module-wide config parameters'>
44 <decl spacer='1'/>
45 <decl spacer='1'/>
46 <decl spacer='1'/>
47 <decl kind='config' name='transportCombo' anchor='transport.Combo' altext='ti.ipc.ipcmgr.IpcMgr.transportCombo' nodoc='0' external='1' overrides='0' readonly='0' instance='0' summary='Specifies+which+transport+combination+will+be+used'>
48 <synopSpec>
49 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Econfig%3C%2Fspan%3E+%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2Fti%2Fipc%2Fipcmgr%2FIpcMgr.html%23.Trans.Combo%22+title%3D%22ti.ipc.ipcmgr.IpcMgr.TransCombo%22%3EIpcMgr.TransCombo%3C%2Fa%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EtransportCombo%3C%2Fspan%3E%3C%2Fgo%3E%3B'/>
50 </synopSpec>
51 <synopMeta>
52 <line tab='0' content='%3Cgo%3EIpcMgr.%3Cspan+class%3D%22xdoc-id%22%3EtransportCombo%3C%2Fspan%3E%3C%2Fgo%3E+%3D+%3Ci%3E%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2Fti%2Fipc%2Fipcmgr%2FIpcMgr.html%23.Trans.Combo%22+title%3D%22ti.ipc.ipcmgr.IpcMgr.TransCombo%22%3EIpcMgr.TransCombo%3C%2Fa%3E%3C%2Fi%3E+%3Cspan+class%3D%22xdoc-kw2%22%3Eundefined%3C%2Fspan%3E%3B'/>
53 </synopMeta>
54 <docSect name='details'>
55 <docPara content='This+config+param+must+be+set+in+the+application+config+script.%0A++It+has+no+default+value.'/>
56 </docSect>
57 </decl>
58 </group>
59 <group name='module-wide data'>
60 </group>
61 <group name='module-wide functions'>
62 <decl spacer='1'/>
63 <decl kind='fxn' name='getDefs' anchor='get.Defs' altext='ti.ipc.ipcmgr.IpcMgr.getDefs' nodoc='0' external='1' overrides='0' readonly='0' instance='0' summary='Get+the+compiler+-D+options+necessary+to+build'>
64 <synopSpec>
65 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw2%22%3EString%3C%2Fspan%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EgetDefs%3C%2Fspan%3E%3C%2Fgo%3E%28++%29%3B'/>
66 </synopSpec>
67 <synopMeta>
68 <line tab='0' content='%3Cgo%3EIpcMgr.%3Cspan+class%3D%22xdoc-id%22%3EgetDefs%3C%2Fspan%3E%3C%2Fgo%3E%28++%29+%3Ci%3Ereturns%3C%2Fi%3E+%3Ci%3E%3Cspan+class%3D%22xdoc-kw2%22%3EString%3C%2Fspan%3E%3C%2Fi%3E'/>
69 </synopMeta>
70 </decl>
71 </group>
72 </unit>
73 </package>