1    /*
     2     * Copyright (c) 2010-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    import xdc.runtime.IHeap;
    35    
    36    /*!
    37     *  ======== ECPY ========
    38     *  EDMA functional layer library.
    39     */
    40    
    41    @Template("./ECPY.xdt")
    42    metaonly module ECPY {
    43    
    44        config Bool cachedIresMode = true;
    45    
    46        /*!
    47         *  ======== persistentAllocFxn ========
    48         *  Function for allocating persistent memory for ECPY's
    49         *  implementation's internal objects and for allocating memory for
    50         *  ECPY handle objects.
    51         *
    52         *  The signature of the persistent alloc function is:
    53         *      extern Bool persistentAllocFxn(IALG_MemRec * memTab, Int numRecs);
    54         */
    55        config String persistentAllocFxn = null;
    56    
    57        /*!
    58         *  ======== persistentFreeFxn ========
    59         *  Function for freeing persistent memory allocated by ECPY.
    60         *
    61         *  The signature of hte persistentFreeFxn is:
    62         *
    63         *      extern Void persistentFreeFxn(IALG_MemRec *memTab, Int numRecs);
    64         */
    65        config String persistentFreeFxn = null;
    66    
    67        /*!
    68         *  ======== scratchAllocFxn ========
    69         *  Function for allocating scratch memory for ECPY Handle.
    70         *  The scratch memory can be overlayed with other algorithm instance's
    71         *  handle's that are created in the same scratch group to reduce footprint
    72         *  in high-density multi-channel environments.
    73         *
    74         *  The signature of the shared allocation function is:
    75         *
    76         *      extern Bool scratchAllocFxn(IALG_Handle alg, Int scratchId,
    77         *                                  IALG_MemRec * memTab, Int numRecs);
    78         */
    79        config String scratchAllocFxn = null;
    80    
    81        /*!
    82         *  ======== scratchFreeFxn ========
    83         *  Function for freeing scratch memory allocated by ECPY.
    84         *
    85         *  The signature of the scratchFreeFxn is:
    86         *
    87         *      extern Void scratchFreeFxn(Int mutexId, Void *addr, UInt size);
    88         */
    89        config String scratchFreeFxn = null;
    90    
    91        /*!
    92         *  ======== getScratchIdFxn ========
    93         *  Function for obtaining scratchId associated with IALG_Handle
    94         *  used for creating the algorithm instance.
    95         *  When set to null, ECPY assumes scratchId => -1
    96         *
    97         *  The signature of the getScratchIdFxn is:
    98         *
    99         *      extern Int DSKT2_getScratchId(IALG_Handle alg);
   100         */
   101        config String getScratchIdFxn = null;
   102    }
   103    /*
   104     *  @(#) ti.sdo.fc.ecpy; 1, 0, 0,10; 8-26-2010 17:48:49; /db/atree/mk/fc-n13x/src/
   105     */