1    /* 
     2     * Copyright (c) 2010, Texas Instruments Incorporated
     3     * All rights reserved.
     4     *
     5     * Redistribution and use in source and binary forms, with or without
     6     * modification, are permitted provided that the following conditions
     7     * are met:
     8     *
     9     * *  Redistributions of source code must retain the above copyright
    10     *    notice, this list of conditions and the following disclaimer.
    11     *
    12     * *  Redistributions in binary form must reproduce the above copyright
    13     *    notice, this list of conditions and the following disclaimer in the
    14     *    documentation and/or other materials provided with the distribution.
    15     *
    16     * *  Neither the name of Texas Instruments Incorporated nor the names of
    17     *    its contributors may be used to endorse or promote products derived
    18     *    from this software without specific prior written permission.
    19     *
    20     * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    21     * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
    22     * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
    23     * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
    24     * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
    25     * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
    26     * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
    27     * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
    28     * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
    29     * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
    30     * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    31     * 
    32     */
    33    
    34    /*!
    35     *  ======== Ipc ========
    36     *  BIOS ipc settings.
    37     */
    38    @Template("./Ipc.xdt")
    39    
    40    metaonly module Ipc inherits ti.sdo.ce.ipc.IIpc {
    41        /*!
    42         *  ======== armCommMsgSize ========
    43         *  Default size for the Arm-DSP communication messages (MSGQ messages).
    44         *
    45         *  Applies only to configurations where DSP Link is used.
    46         */
    47        config UInt32 armCommMsgSize = 4 * 1024;
    48    
    49        /*!
    50         *  ======== dspConfigureMsgqAndPool ========
    51         *  Set to true by default, instructs this module to generate code that
    52         *  configures BIOS MSGQ and POOL modules: symbols MSGQ_config and
    53         *  POOL_config. If set to false, and if BIOS is configured to use MSGQ,
    54         *  user application must define these symbols.
    55         */
    56        config bool dspConfigureMsgqAndPool = true;
    57    
    58        /*!
    59         *  ======== dspUseMsgqAndPool ========
    60         *  If set to false, instructs Codecs Engine to cut out MSGQ and POOL
    61         *  references completely from the final image.
    62         *
    63         *  Must be set to true if DSP Link is used.
    64         */
    65        config bool dspUseMsgqAndPool = true;
    66    
    67        /*!
    68         *  ======== dspCommNumMsgQueues ========
    69         *  Number of message queues (that can receive and store messages) on the
    70         *  DSP side. Each DSP node (task) needs one message queue.
    71         *
    72         *  Applies only to configurations where runtimeEnv == DSPBIOS or
    73         *  runtimeEnv == DSPLINK_BIOS
    74         */
    75        config UInt32 dspCommNumMsgQueues = 64;
    76    
    77        /*!
    78         *  ======== dspCommUseExactMatch ========
    79         *  Indicates that "exact match" must be used for comm messages allocated
    80         *  on the DSP side.
    81         *
    82         *  Applies only to configurations where DSP Link is used.
    83         */
    84        config Bool dspCommUseExactMatch = true;
    85    
    86        /*!
    87         *  ======== dspCommMsgSize ========
    88         *  Default size for the inter-DSP communication messages (MSGQ messages).
    89         *
    90         *  Applies only to configurations where DSP Link is not used, in special
    91         *  circumstances.
    92         * @_nodoc
    93         */
    94        config UInt32 dspCommMsgSize = 1024;
    95    
    96        /*!
    97         *  ======== dspCommNumMsgs ========
    98         *  Number of <commMsgSize>-sized messages used for Arm-DSP communication.
    99         *
   100         *  Applies only to configurations where DSP Link is not used, in special
   101         *  circumstances.
   102         * @_nodoc
   103         */
   104        config UInt32 dspCommNumMsgs = 64;
   105    
   106        /*!
   107         *  ======== usePowerManagement ========
   108         *  Enable power Management
   109         *
   110         *  If set to true, will attempt to include power-management code
   111         *  where applicable.
   112         *
   113         *  This feature may not be available on all devices.
   114         */
   115        config bool usePowerManagement = false;
   116    
   117        /*!
   118         *  ======== powerSaveMemoryBlockName ========
   119         *  Memory segment name for context save/restore.
   120         *
   121         *  The name of the segment to which power should be saved; if left null,
   122         *  will default to defaultMemSegId.
   123         *
   124         *  This feature may not be available on all devices.
   125         */
   126        config String powerSaveMemoryBlockName = null;
   127    
   128        /*!
   129         *  ======== debug ========
   130         *  Enable the debug profile
   131         *
   132         *  Now obsolete. Leave here for awhile until users update.
   133         *  @_nodoc
   134         */
   135        config Bool debug = false;
   136    
   137        /*!
   138         * ======== dspLinkUsed ========
   139         * Returns true if the executable should be built with DSP Link
   140         *
   141         * @_nodoc
   142         */
   143        bool dspLinkUsed();
   144    
   145    }
   146    /*
   147     *  @(#) ti.sdo.ce.ipc.bios; 2, 0, 1,176; 9-20-2010 16:41:31; /db/atree/library/trees/ce/ce-r09x/src/ xlibrary
   148    
   149     */
   150