psdk_cust/ipc_3_43_00_00_eng/docs/cdoc/ti/sdo/ipc/family/c647x/MultiProcSetup-src.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html><head><title>module ti.sdo.ipc.family.c647x.MultiProcSetup</title>
   3 <meta name="googlebot" content="noindex,nofollow">
   4 <link rel="stylesheet" type="text/css" href="../../../../../src.css"/>
   5 </head>
   6 <body>
   7 <pre class=src>
   8      1    <span class="comment">/*
   9 </span>     2    <span class="comment"> * Copyright (c) 2012-2013, Texas Instruments Incorporated
  10 </span>     3    <span class="comment"> * All rights reserved.
  11 </span>     4    <span class="comment"> *
  12 </span>     5    <span class="comment"> * Redistribution and use in source and binary forms, with or without
  13 </span>     6    <span class="comment"> * modification, are permitted provided that the following conditions
  14 </span>     7    <span class="comment"> * are met:
  15 </span>     8    <span class="comment"> *
  16 </span>     9    <span class="comment"> * *  Redistributions of source code must retain the above copyright
  17 </span>    10    <span class="comment"> *    notice, this list of conditions and the following disclaimer.
  18 </span>    11    <span class="comment"> *
  19 </span>    12    <span class="comment"> * *  Redistributions in binary form must reproduce the above copyright
  20 </span>    13    <span class="comment"> *    notice, this list of conditions and the following disclaimer in the
  21 </span>    14    <span class="comment"> *    documentation and/or other materials provided with the distribution.
  22 </span>    15    <span class="comment"> *
  23 </span>    16    <span class="comment"> * *  Neither the name of Texas Instruments Incorporated nor the names of
  24 </span>    17    <span class="comment"> *    its contributors may be used to endorse or promote products derived
  25 </span>    18    <span class="comment"> *    from this software without specific prior written permission.
  26 </span>    19    <span class="comment"> *
  27 </span>    20    <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  28 </span>    21    <span class="comment"> * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  29 </span>    22    <span class="comment"> * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  30 </span>    23    <span class="comment"> * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  31 </span>    24    <span class="comment"> * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  32 </span>    25    <span class="comment"> * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  33 </span>    26    <span class="comment"> * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  34 </span>    27    <span class="comment"> * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  35 </span>    28    <span class="comment"> * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  36 </span>    29    <span class="comment"> * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  37 </span>    30    <span class="comment"> * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38 </span>    31    <span class="comment"> */</span>
  39     32    <span class="comment">/*
  40 </span>    33    <span class="comment"> *  ======== MultiProcSetup.xdc ========
  41 </span>    34    <span class="comment"> */</span>
  42     35
  43     36    import xdc.runtime.Assert;
  44     37
  45     38    <span class="xdoc">/*!
  46 </span>    39    <span class="xdoc"> *  ======== MultiProcSetup ========
  47 </span>    40    <span class="xdoc"> */</span>
  48     41
  49     42    <span class=key>module</span> MultiProcSetup
  50     43    {
  51     44        <span class="xdoc">/*!
  52 </span>    45    <span class="xdoc">     * By default the MultiProcSetup module will set the ID at startup.
  53 </span>    46    <span class="xdoc">     *
  54 </span>    47    <span class="xdoc">     * By setting this flag to false, the initialization step is suppressed.
  55 </span>    48    <span class="xdoc">     */</span>
  56     49        <span class=key>config</span> Bool configureProcId = <span class=key>true</span>;
  57     50
  58     51        <span class="xdoc">/*!
  59 </span>    52    <span class="xdoc">     *  Assert raised when the target core is not in the MultiProc name list
  60 </span>    53    <span class="xdoc">     */</span>
  61     54        <span class=key>config</span> Assert.Id A_invalidProcessor  = {
  62     55            msg: <span class="string">"A_invalidProcessor: This core is not present in the MultiProc name list"</span>
  63     56        };
  64     57
  65     58        <span class="xdoc">/*! ProcId -&gt; CoreId mapping (indexed by procId) */</span>
  66     59        <span class=key>config</span> UInt16 procMap[];
  67     60
  68     61    <span class=key>internal</span>:
  69     62
  70     63        <span class="xdoc">/*!
  71 </span>    64    <span class="xdoc">     *  ======== getProcId ========
  72 </span>    65    <span class="xdoc">     *  Returns the MultiProc ID corresponding to a specific core
  73 </span>    66    <span class="xdoc">     */</span>
  74     67        UInt16 getProcId(UInt coreId);
  75     68
  76     69        Void init();
  77     70    }
  78 </pre>
  79 </body></html>