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