dskt2.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 DSKT2_
#define DSKT2_

#ifdef __cplusplus
extern "C" {
#endif


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

#include <ti/xdais/ialg.h>
#include <ti/xdais/ires.h>
#include <stddef.h>

#define DSKT2_NUM_SCRATCH_GROUPS 20     
#define DSKT2_MAX_MEM_ALLOCATION_SIZE  0xFFFF   
/* NOTE: DO NOT Change NUM_SHAREDHEAPS*/
#define DSKT2_NUM_SHAREDHEAPS 2

#define DSKT2_MODNAME  "ti.sdo.fc.dskt2"

typedef Void (*DSKT2_CacheWBInvFxn)(Ptr blockPtr, size_t byteCnt, Bool wait);


extern __FAR__ DSKT2_CacheWBInvFxn DSKT2_cacheWBInvFxn;

/* TODO: Should these be declared here ? User should know they can initialize
         these entries */
extern __FAR__ xdc_runtime_IHeap_Handle DSKT2_daram0Heap;
extern __FAR__  xdc_runtime_IHeap_Handle DSKT2_daram1Heap;
extern __FAR__  xdc_runtime_IHeap_Handle DSKT2_daram2Heap;
extern __FAR__  xdc_runtime_IHeap_Handle DSKT2_saram0Heap;
extern __FAR__  xdc_runtime_IHeap_Handle DSKT2_saram1Heap;
extern __FAR__  xdc_runtime_IHeap_Handle DSKT2_saram2Heap;
extern __FAR__  xdc_runtime_IHeap_Handle DSKT2_iprogHeap;
extern __FAR__  xdc_runtime_IHeap_Handle DSKT2_eprogHeap;
extern __FAR__  xdc_runtime_IHeap_Handle DSKT2_esdataHeap;
extern __FAR__  xdc_runtime_IHeap_Handle _DSKT2_heap;

extern __FAR__ UInt _DSKT2_ALLOW_EXTERNAL_SCRATCH;

extern __FAR__ UInt _DSKT2_DARAM_SCRATCH_SIZES[];
extern __FAR__ UInt _DSKT2_SARAM_SCRATCH_SIZES[];

/* ENDTODO */

extern __FAR__ Bool ti_sdo_fc_dskt2_DSKT2_disableLazyDeactivate;

extern Void DSKT2_activateAlg(Int scratchMutexId, IALG_Handle alg);


extern Int DSKT2_controlAlg(IALG_Handle alg, IALG_Cmd cmd,
    IALG_Status *status);


extern IALG_Handle DSKT2_createAlg(Int scratchMutexId, IALG_Fxns * fxns,
    IALG_Handle parent, IALG_Params * params);


extern IALG_Handle DSKT2_createAlg2(Int scratchMutexId, IALG_Fxns * fxns,
        IALG_Handle parent, IALG_Params * params,
        xdc_runtime_IHeap_Handle extHeapId);


IALG_Handle DSKT2_createAlgExt(Int scratchId, IALG_Fxns * fxns,
        IALG_Handle parent, IALG_Params * params);

extern Void DSKT2_deactivateAlg(Int scratchMutexId, IALG_Handle alg);

extern Int DSKT2_deactivateAll();

extern Bool DSKT2_freeAlg(Int scratchMutexId, IALG_Handle alg);

extern Bool DSKT2_allocScratch(IALG_Handle alg,Int mutexId, IALG_MemRec *memTab,
        Int numRecs);

extern Int DSKT2_getScratchId(IALG_Handle alg);

extern Void DSKT2_freeScratch(Int mutexId, Void *addr, UInt size);

extern Bool DSKT2_allocPersistent(IALG_MemRec *memTab, Int numRecs);

extern Void DSKT2_freePersistent(IALG_MemRec *memTab, Int numRecs);

/*
 * Functions below are friend functions that are used by RMAN and some IRES
 * implementations to cooperatively yield to higher priority algorithms.
 */
Void DSKT2_yield(IRES_YieldResourceType resource,
        IRES_YieldContextHandle algYieldContext, IRES_YieldArgs yieldArgs);

IRES_YieldArgs DSKT2_getYieldArgs(Int scratchId);

IRES_YieldArgs DSKT2_setYieldArgs(Int scratchId, Bool yieldFlag);


Void DSKT2_contextRelease(IRES_YieldResourceType resource,
        IRES_YieldContextHandle algYieldContext, IRES_YieldArgs yieldArgs);

Void DSKT2_contextAcquire(IRES_YieldResourceType resource,
        IRES_YieldContextHandle algYieldContext, IRES_YieldArgs yieldArgs);

Int DSKT2_getNumAlgs();

Int DSKT2_getAlgList(IALG_Handle * algList, Int * scratchIds);


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

#endif  /* DSKT2_ */