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     *  ======== Algorithm ========
    35     *
    36     */
    37    
    38    @Template("./Algorithm.xdt")
    39    
    40    
    41    metaonly module Algorithm {
    42    
    43        /*!
    44         *  ======== useIdma3 ========
    45         *  True if IDMA3 needs to be supported.
    46         *
    47         *  @_nodoc
    48         *  Deprecated 
    49         */
    50        metaonly config bool useIdma3;
    51    
    52        /*!
    53         *  ======== useIres ========
    54         *  True if IRES needs to be supported.
    55         *
    56         *  @_nodoc
    57         */
    58        metaonly config bool useIres;
    59    
    60        /*!
    61         *  ======== useHeap ========
    62         *  Indicates that algorithm memory should be allocated from a heap.
    63         *
    64         *  Flag indicating whether algorithm memory should be allocated from
    65         *  a heap or from a pool.
    66         *
    67         *  This flag is currently only used when CMEM is used to allocate memory
    68         *  (e.g. ARM-side 'local' codecs).
    69         */
    70        config bool useHeap = false;
    71    
    72        /*!
    73         *  ======== useCache ========
    74         *  Indicates that algorithm memory should be cacheable.
    75         *
    76         *  This flag indicates whether algorithm memory should be allocated from
    77         *  cache-enabled buffers.
    78         *
    79         *  This flag is currently only used when CMEM is used to allocate memory
    80         *  (e.g. ARM-side 'local' codecs).
    81         *
    82         *  Note that when cache-enabled buffers are used, it is the application's
    83         *  responsibility to manage this cache.  See the various `Memory_` APIs
    84         *  for cache services.
    85         */
    86        config bool useCache = false;
    87    
    88        /*!
    89         *  ======== ipcKeyBase ========
    90         *  Default base value for ALG's semaphore keys.
    91         *
    92         *  The SemMP objects created by ALG will use keys starting at this
    93         *  value, and incrementing with each new object. There are currently
    94         *  _ALG_NUMGROUPS (20) keys needed for ALG semaphores.
    95         *  The default value of ipcKeyBase is ascii code for "OGLA".
    96         *
    97         *  WARNING: This value should only be changed if it conflicts with
    98         *  another IPC key in the system that cannot be changed. If this value
    99         *  is changed, all programs using Codec Engine that will be run
   100         *  simultaneously must have the ipcKeyBase configured to the new value.
   101         *
   102         *  @_nodoc
   103         */
   104        metaonly config UInt32 ipcKeyBase = 0x4F474C41;
   105    
   106        /*!
   107         *  ======== MAXGROUPID ========
   108         *  Maximum group id.
   109         *
   110         *  @_nodoc
   111         */
   112        const Int MAXGROUPID = 20;
   113    
   114        /*!
   115         *  ======== groupUsed ========
   116         *  Internal array indicating groups with algorithms
   117         *
   118         *  If there is an algorithm with groupId i, then groupUsed[i]
   119         *  will be set to true.
   120         *
   121         *  @_nodoc
   122         */
   123        metaonly config bool groupUsed[MAXGROUPID] = [
   124                false, false, false, false, false,
   125                false, false, false, false, false,
   126                false, false, false, false, false,
   127                false, false, false, false, false
   128        ];
   129    }
   130    /*
   131     *  @(#) ti.sdo.ce.alg; 1, 0, 1,1; 8-14-2012 12:59:37; /db/atree/library/trees/ce/ce-u07/src/ xlibrary
   132    
   133     */
   134