1    /* 
     2     * Copyright (c) 2012, 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        /* TODO:H - review this name and usage */
    50        config UInt32 hostCommNumMsgs = 64;
    51    
    52        /*
    53         *  ======== dspCommNumMsgQueues ========
    54         *  Number of message queues (that can receive and store messages) on the
    55         *  DSP side. Each DSP node (task) needs one message queue.
    56         *
    57         *  Applies only to configurations where runtimeEnv == DSPBIOS or
    58         *  runtimeEnv == DSPLINK_BIOS
    59         *
    60         *  @_nodoc
    61         */
    62    //    config UInt32 dspCommNumMsgQueues = 64;
    63    
    64        /*!
    65         *  ======== dspCommMsgSize ========
    66         *  Default size for the inter-DSP communication messages (MSGQ messages).
    67         *
    68         *  Applies only to configurations where DSP Link is not used, in special
    69         *  circumstances.
    70         *
    71         * @_nodoc
    72         */
    73        config UInt32 dspCommMsgSize = 1024;
    74    
    75        /*!
    76         *  ======== dspCommNumMsgs ========
    77         *  Number of <commMsgSize>-sized messages used for Arm-DSP communication.
    78         *
    79         *  Applies only to configurations where DSP Link is not used, in special
    80         *  circumstances.
    81         *
    82         * @_nodoc
    83         */
    84        config UInt32 dspCommNumMsgs = 64;
    85    
    86        /*!
    87         *  ======== usePowerManagement ========
    88         *  Enable power Management
    89         *
    90         *  If set to true, will attempt to include power-management code
    91         *  where applicable.
    92         *
    93         *  This feature may not be available on all devices.
    94         *
    95         *  @_nodoc
    96         */
    97        config bool usePowerManagement = false;
    98    
    99        /*!
   100         *  ======== powerSaveMemoryBlockName ========
   101         *  Memory segment name for context save/restore.
   102         *
   103         *  The name of the segment to which power should be saved; if left null,
   104         *  will default to defaultMemSegId.
   105         *
   106         *  This feature may not be available on all devices.
   107         *
   108         *  @_nodoc
   109         */
   110        config String powerSaveMemoryBlockName = null;
   111    
   112        /*!
   113         *  ======== manageIpc ========
   114         *  Ipc calls will be built into the app.
   115         *
   116         *  If set to true, calls to Ipc_attach(), Ipc_detach(), etc, will be
   117         *  auto-generated.  If false, the app must manage these calls.
   118         *
   119         *  @_nodoc
   120         */
   121        config bool manageIpc = true;
   122    
   123        /*!
   124         * ======== dspLinkUsed ========
   125         * Returns true if the executable should be built with DSP Link
   126         *
   127         * @_nodoc
   128         */
   129        bool dspLinkUsed();
   130    
   131        /*!
   132         * ======== messageqUsed ========
   133         * Returns true if ti.sdo.ipc.MessageQ is used
   134         *
   135         * @_nodoc
   136         */
   137        bool messageqUsed();
   138    }
   139    /*
   140     *  @(#) ti.sdo.ce.ipc.bios; 2, 0, 1,1; 8-14-2012 13:01:36; /db/atree/library/trees/ce/ce-u07/src/ xlibrary
   141    
   142     */
   143