psdk_cust/ipc_3_43_00_00_eng/docs/cdoc/ti/sdo/ipc/family/package/package.doc.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <package kind='package' name='ti.sdo.ipc.family' nodoc='0' root='../../../../' summary=''>
   3     <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Epackage%3C%2Fspan%3E+%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3Eti.sdo.ipc.family%3C%2Fspan%3E%3C%2Fgo%3E+%5B1%2C+0%2C+0%2C+0%5D+%7B'/>
   4     <line tab='0' content='%7D'/>
   5     <unit name='Settings' kind='module' nodoc='1' metaonly='1' summary=''>
   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..%2F..%2Fti%2Fsdo%2Fipc%2Ffamily%2Fpackage.html%22+title%3D%22ti.sdo.ipc.family%22%3Eti.sdo.ipc.family%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%3ESettings%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%3ESettings%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+Settings+%3D+%3Cspan+class%3D%22xdoc-kw3%22%3Exdc.useModule%3C%2Fspan%3E%28%3Cspan+class%3D%22xdoc-id%22%3E%27ti.sdo.ipc.family.Settings%27%3C%2Fspan%3E%29%3B'/>
  17         </synopMeta>
  18         <group name='module-wide constants &amp; types'>
  19             <decl spacer='1'/>
  20         </group>
  21         <group name='module-wide config parameters'>
  22             <decl spacer='1'/>
  23             <decl spacer='1'/>
  24             <decl spacer='1'/>
  25         </group>
  26         <group name='module-wide data'>
  27         </group>
  28         <group name='module-wide functions'>
  29             <decl spacer='1'/>
  30             <decl kind='fxn' name='generateSlaveDataForHost' anchor='generate.Slave.Data.For.Host' altext='ti.sdo.ipc.family.Settings.generateSlaveDataForHost' nodoc='0' external='1' overrides='0' readonly='0' instance='0' summary='returns+whether+to+generate+slave+data+for+the+host'>
  31                 <synopSpec>
  32                     <line tab='0' content='%3Cspan+class%3D%22xdoc-kw2%22%3EBool%3C%2Fspan%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EgenerateSlaveDataForHost%3C%2Fspan%3E%3C%2Fgo%3E%28++%29%3B'/>
  33                 </synopSpec>
  34                 <synopMeta>
  35                     <line tab='0' content='%3Cgo%3ESettings.%3Cspan+class%3D%22xdoc-id%22%3EgenerateSlaveDataForHost%3C%2Fspan%3E%3C%2Fgo%3E%28++%29+%3Ci%3Ereturns%3C%2Fi%3E+%3Ci%3E%3Cspan+class%3D%22xdoc-kw2%22%3EBool%3C%2Fspan%3E%3C%2Fi%3E'/>
  36                 </synopMeta>
  37             </decl>
  38             <decl kind='fxn' name='getDefaultInterruptDelegate' anchor='get.Default.Interrupt.Delegate' altext='ti.sdo.ipc.family.Settings.getDefaultInterruptDelegate' nodoc='0' external='1' overrides='0' readonly='0' instance='0' summary='returns+the+family+specific+Interrupt+module+delegate'>
  39                 <synopSpec>
  40                     <line tab='0' content='%3Cspan+class%3D%22xdoc-kw2%22%3EString%3C%2Fspan%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EgetDefaultInterruptDelegate%3C%2Fspan%3E%3C%2Fgo%3E%28++%29%3B'/>
  41                 </synopSpec>
  42                 <synopMeta>
  43                     <line tab='0' content='%3Cgo%3ESettings.%3Cspan+class%3D%22xdoc-id%22%3EgetDefaultInterruptDelegate%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'/>
  44                 </synopMeta>
  45             </decl>
  46             <decl kind='fxn' name='getDeviceProcNames' anchor='get.Device.Proc.Names' altext='ti.sdo.ipc.family.Settings.getDeviceProcNames' nodoc='0' external='1' overrides='0' readonly='0' instance='0' summary='returns+array+of+names+of+processors+on+the+build+device'>
  47                 <synopSpec>
  48                     <line tab='0' content='%3Cspan+class%3D%22xdoc-kw2%22%3EAny%3C%2Fspan%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EgetDeviceProcNames%3C%2Fspan%3E%3C%2Fgo%3E%28++%29%3B'/>
  49                 </synopSpec>
  50                 <synopMeta>
  51                     <line tab='0' content='%3Cgo%3ESettings.%3Cspan+class%3D%22xdoc-id%22%3EgetDeviceProcNames%3C%2Fspan%3E%3C%2Fgo%3E%28++%29+%3Ci%3Ereturns%3C%2Fi%3E+%3Ci%3E%3Cspan+class%3D%22xdoc-kw2%22%3EAny%3C%2Fspan%3E%3C%2Fi%3E'/>
  52                 </synopMeta>
  53             </decl>
  54             <decl kind='fxn' name='getGateHWSemSettings' anchor='get.Gate.H.W.Sem.Settings' altext='ti.sdo.ipc.family.Settings.getGateHWSemSettings' nodoc='0' external='1' overrides='0' readonly='0' instance='0' summary='returns+the+device+specific+GateHWSem+settings'>
  55                 <synopSpec>
  56                     <line tab='0' content='%3Cspan+class%3D%22xdoc-kw2%22%3EAny%3C%2Fspan%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EgetGateHWSemSettings%3C%2Fspan%3E%3C%2Fgo%3E%28++%29%3B'/>
  57                 </synopSpec>
  58                 <synopMeta>
  59                     <line tab='0' content='%3Cgo%3ESettings.%3Cspan+class%3D%22xdoc-id%22%3EgetGateHWSemSettings%3C%2Fspan%3E%3C%2Fgo%3E%28++%29+%3Ci%3Ereturns%3C%2Fi%3E+%3Ci%3E%3Cspan+class%3D%22xdoc-kw2%22%3EAny%3C%2Fspan%3E%3C%2Fi%3E'/>
  60                 </synopMeta>
  61             </decl>
  62             <decl kind='fxn' name='getGateHWSpinlockSettings' anchor='get.Gate.H.W.Spinlock.Settings' altext='ti.sdo.ipc.family.Settings.getGateHWSpinlockSettings' nodoc='0' external='1' overrides='0' readonly='0' instance='0' summary='returns+the+device+specific+GateSpinLock+settings'>
  63                 <synopSpec>
  64                     <line tab='0' content='%3Cspan+class%3D%22xdoc-kw2%22%3EAny%3C%2Fspan%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EgetGateHWSpinlockSettings%3C%2Fspan%3E%3C%2Fgo%3E%28++%29%3B'/>
  65                 </synopSpec>
  66                 <synopMeta>
  67                     <line tab='0' content='%3Cgo%3ESettings.%3Cspan+class%3D%22xdoc-id%22%3EgetGateHWSpinlockSettings%3C%2Fspan%3E%3C%2Fgo%3E%28++%29+%3Ci%3Ereturns%3C%2Fi%3E+%3Ci%3E%3Cspan+class%3D%22xdoc-kw2%22%3EAny%3C%2Fspan%3E%3C%2Fi%3E'/>
  68                 </synopMeta>
  69             </decl>
  70             <decl kind='fxn' name='getHWGate' anchor='get.H.W.Gate' altext='ti.sdo.ipc.family.Settings.getHWGate' nodoc='0' external='1' overrides='0' readonly='0' instance='0' summary='returns+the+module+name+of+the+HW+Gate+that+the+device+supports'>
  71                 <synopSpec>
  72                     <line tab='0' content='%3Cspan+class%3D%22xdoc-kw2%22%3EString%3C%2Fspan%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EgetHWGate%3C%2Fspan%3E%3C%2Fgo%3E%28++%29%3B'/>
  73                 </synopSpec>
  74                 <synopMeta>
  75                     <line tab='0' content='%3Cgo%3ESettings.%3Cspan+class%3D%22xdoc-id%22%3EgetHWGate%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'/>
  76                 </synopMeta>
  77             </decl>
  78             <decl kind='fxn' name='getHostProcId' anchor='get.Host.Proc.Id' altext='ti.sdo.ipc.family.Settings.getHostProcId' nodoc='0' external='1' overrides='0' readonly='0' instance='0' summary='returns+the+MultiProc.id+of+the+HOST+if+configured+in+MultiProc'>
  79                 <synopSpec>
  80                     <line tab='0' content='%3Cspan+class%3D%22xdoc-kw2%22%3EUInt16%3C%2Fspan%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EgetHostProcId%3C%2Fspan%3E%3C%2Fgo%3E%28++%29%3B'/>
  81                 </synopSpec>
  82                 <synopMeta>
  83                     <line tab='0' content='%3Cgo%3ESettings.%3Cspan+class%3D%22xdoc-id%22%3EgetHostProcId%3C%2Fspan%3E%3C%2Fgo%3E%28++%29+%3Ci%3Ereturns%3C%2Fi%3E+%3Ci%3E%3Cspan+class%3D%22xdoc-kw2%22%3EUInt16%3C%2Fspan%3E%3C%2Fi%3E'/>
  84                 </synopMeta>
  85             </decl>
  86             <decl kind='fxn' name='getIpcSR0Setup' anchor='get.Ipc.S.R0.Setup' altext='ti.sdo.ipc.family.Settings.getIpcSR0Setup' nodoc='0' external='1' overrides='0' readonly='0' instance='0' summary='returns+true+when+the+host+needs+to+program+the+mmu+for+the+slave'>
  87                 <synopSpec>
  88                     <line tab='0' content='%3Cspan+class%3D%22xdoc-kw2%22%3EBool%3C%2Fspan%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EgetIpcSR0Setup%3C%2Fspan%3E%3C%2Fgo%3E%28++%29%3B'/>
  89                 </synopSpec>
  90                 <synopMeta>
  91                     <line tab='0' content='%3Cgo%3ESettings.%3Cspan+class%3D%22xdoc-id%22%3EgetIpcSR0Setup%3C%2Fspan%3E%3C%2Fgo%3E%28++%29+%3Ci%3Ereturns%3C%2Fi%3E+%3Ci%3E%3Cspan+class%3D%22xdoc-kw2%22%3EBool%3C%2Fspan%3E%3C%2Fi%3E'/>
  92                 </synopMeta>
  93             </decl>
  94             <decl kind='fxn' name='getMessageQSetupDelegate' anchor='get.Message.Q.Setup.Delegate' altext='ti.sdo.ipc.family.Settings.getMessageQSetupDelegate' nodoc='0' external='1' overrides='0' readonly='0' instance='0' summary='returns+the+MessageQ+transport+setup+delegate'>
  95                 <synopSpec>
  96                     <line tab='0' content='%3Cspan+class%3D%22xdoc-kw2%22%3EString%3C%2Fspan%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EgetMessageQSetupDelegate%3C%2Fspan%3E%3C%2Fgo%3E%28++%29%3B'/>
  97                 </synopSpec>
  98                 <synopMeta>
  99                     <line tab='0' content='%3Cgo%3ESettings.%3Cspan+class%3D%22xdoc-id%22%3EgetMessageQSetupDelegate%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'/>
 100                 </synopMeta>
 101             </decl>
 102             <decl kind='fxn' name='getNameServerRemoteDelegate' anchor='get.Name.Server.Remote.Delegate' altext='ti.sdo.ipc.family.Settings.getNameServerRemoteDelegate' nodoc='0' external='1' overrides='0' readonly='0' instance='0' summary='returns+the+device+specific+NameServer+Remote+delegate'>
 103                 <synopSpec>
 104                     <line tab='0' content='%3Cspan+class%3D%22xdoc-kw2%22%3EString%3C%2Fspan%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EgetNameServerRemoteDelegate%3C%2Fspan%3E%3C%2Fgo%3E%28++%29%3B'/>
 105                 </synopSpec>
 106                 <synopMeta>
 107                     <line tab='0' content='%3Cgo%3ESettings.%3Cspan+class%3D%22xdoc-id%22%3EgetNameServerRemoteDelegate%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'/>
 108                 </synopMeta>
 109             </decl>
 110             <decl kind='fxn' name='getNotifySetupDelegate' anchor='get.Notify.Setup.Delegate' altext='ti.sdo.ipc.family.Settings.getNotifySetupDelegate' nodoc='0' external='1' overrides='0' readonly='0' instance='0' summary='returns+the+device+specific+NotifySetup+delegate'>
 111                 <synopSpec>
 112                     <line tab='0' content='%3Cspan+class%3D%22xdoc-kw2%22%3EString%3C%2Fspan%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EgetNotifySetupDelegate%3C%2Fspan%3E%3C%2Fgo%3E%28++%29%3B'/>
 113                 </synopSpec>
 114                 <synopMeta>
 115                     <line tab='0' content='%3Cgo%3ESettings.%3Cspan+class%3D%22xdoc-id%22%3EgetNotifySetupDelegate%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'/>
 116                 </synopMeta>
 117             </decl>
 118             <decl kind='fxn' name='procInDevice' anchor='proc.In.Device' altext='ti.sdo.ipc.family.Settings.procInDevice' nodoc='0' external='1' overrides='0' readonly='0' instance='0' summary='returns+whether+the+processor+is+in+the+build+device'>
 119                 <synopSpec>
 120                     <line tab='0' content='%3Cspan+class%3D%22xdoc-kw2%22%3EBool%3C%2Fspan%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EprocInDevice%3C%2Fspan%3E%3C%2Fgo%3E%28+%3Cspan+class%3D%22xdoc-kw2%22%3EString%3C%2Fspan%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EprocName%3C%2Fspan%3E%3C%2Fgo%3E+%29%3B'/>
 121                 </synopSpec>
 122                 <synopMeta>
 123                     <line tab='0' content='%3Cgo%3ESettings.%3Cspan+class%3D%22xdoc-id%22%3EprocInDevice%3C%2Fspan%3E%3C%2Fgo%3E%28+%3Ci%3E%3Cspan+class%3D%22xdoc-kw2%22%3EString%3C%2Fspan%3E%3C%2Fi%3E+%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EprocName%3C%2Fspan%3E%3C%2Fgo%3E+%29+%3Ci%3Ereturns%3C%2Fi%3E+%3Ci%3E%3Cspan+class%3D%22xdoc-kw2%22%3EBool%3C%2Fspan%3E%3C%2Fi%3E'/>
 124                 </synopMeta>
 125             </decl>
 126         </group>
 127     </unit>
 128 </package>