dman3.h

Go to the documentation of this file.

/* 
 * Copyright (c) 2012, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * 
 */
#ifndef ti_sdo_fc_dman3_DMAN3_
#define ti_sdo_fc_dman3_DMAN3_



#ifdef __cplusplus
extern "C" {
#endif

#include <xdc/std.h>
#include <xdc/runtime/IHeap.h>

#include <ti/xdais/ialg.h>
#include <ti/xdais/idma3.h>


#define DMAN3_MODNAME  "ti.sdo.fc.dman3"

#define DMAN3_GTNAME "ti.sdo.fc.dman3"  
#define DMAN3_MAXGROUPS      20  
#define DMAN3_SOK             0  
#define DMAN3_EOUTOFMEMORY   -1  
#define DMAN3_EFAIL          -2  
#define DMAN3_EFREE          -3  
#define DMAN3_EOUTOFTCCS     -4  
#define DMAN3_EOUTOFPARAMS   -5  
#define DMAN3_ETCCCONFIG     -6  
#define DMAN3_EPARAMCONFIG   -7  


typedef Bool (*DMAN3_ScratchAllocFxn)(IALG_Handle alg, Int mutexId,
        IALG_MemRec *memTab, Int numRecs);

typedef Void (*DMAN3_ScratchFreeFxn)(Int mutexId, Void *addr, Uns size);


typedef struct DMAN3_Params {
    Uns    *qdmaPaRamBase;

    Uns     maxPaRamEntries;

    Uns     paRamBaseIndex;

    Uns     numPaRamEntries;

    Uns     maxQdmaChannels;

    Uns     numQdmaChannels;

    Uns    *qdmaChannels;

    Uns     tccAllocationMaskH;

    Uns     tccAllocationMaskL;

    xdc_runtime_IHeap_Handle heapInternal;

    xdc_runtime_IHeap_Handle heapExternal;

    unsigned char numTccGroup[DMAN3_MAXGROUPS];    
    unsigned short numPaRamGroup[DMAN3_MAXGROUPS];  
    Bool          idma3Internal;

    DMAN3_ScratchAllocFxn scratchAllocFxn;

    DMAN3_ScratchFreeFxn scratchFreeFxn;

    Uns nullPaRamIndex;

    Uns     maxTCs;  

    Uns   *qdmaQueueMap; 

    Uns   *queueTCMap;

    Uns   *queuePri;

    Bool allowUnshared;
} DMAN3_Params;


extern DMAN3_Params DMAN3_PARAMS;

extern Uns ti_sdo_fc_dman3_DMAN3_numQdmaGroup[DMAN3_MAXGROUPS + 1];

extern Bool ti_sdo_fc_dman3_DMAN3_useCustomDma;

extern Int DMAN3_grantDmaChannels(Int groupId, IALG_Handle algHandle[],
        IDMA3_Fxns *dmaFxns[], Int numAlgs);

extern Void DMAN3_exit(Void);

extern Int DMAN3_createChannels(Int groupId, IDMA3_ChannelRec dmaTab[],
        Int numChans);


extern Void DMAN3_init(Void);


extern Int  DMAN3_releaseDmaChannels(IALG_Handle algHandle[],
    IDMA3_Fxns *dmaFxns[], Int numAlgs);


extern Int DMAN3_freeChannels(IDMA3_Handle channelTab[], Int numChans);


#ifdef __cplusplus
}
#endif /* extern "C" */


#endif
/*
 *  @(#) ti.sdo.fc.dman3; 1, 0, 4,3; 4-16-2012 00:00:07; /db/atree/library/trees/fc/fc-q08/src/ xlibrary

 */