ecpy.h

Go to the documentation of this file.

/* 
 * Copyright (c) 2013, 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_ecpy_ECPY_
#define ti_sdo_fc_ecpy_ECPY_


#ifdef __cplusplus
extern "C" {
#endif


#define ti_sdo_fc_ires_NOPROTOCOLREV
#include <ti/sdo/fc/ires/edma3chan/ires_edma3Chan.h>

#define ECPY_GTNAME "ti.sdo.fc.ecpy"

#define ECPY_MODNAME "ti.sdo.fc.ecpy"


typedef enum ECPY_ParamField16b {

    ECPY_PARAMFIELD_ELEMENTSIZE =  8,
    ECPY_PARAMFIELD_NUMELEMENTS = 10 ,
    ECPY_PARAMFIELD_ELEMENTINDEX_SRC = 16,
    ECPY_PARAMFIELD_ELEMENTINDEX_DST = 18,
    ECPY_PARAMFIELD_FRAMEINDEX_SRC =  24,
    ECPY_PARAMFIELD_FRAMEINDEX_DST =  26,
    ECPY_PARAMFIELD_NUMFRAMES = 28

} ECPY_ParamField16b;

typedef enum ECPY_ParamField32b {

    ECPY_PARAMFIELD_SRCADDR = 4,
    ECPY_PARAMFIELD_DSTADDR = 12,
    ECPY_PARAMFIELD_ELEMENTINDEXES = 16,
    ECPY_PARAMFIELD_FRAMEINDEXES = 24

} ECPY_ParamField32b;

typedef enum ECPY_TransferType {

    ECPY_1D1D,

    ECPY_1D2D,

    ECPY_2D1D,

    ECPY_2D2D
} ECPY_TransferType;

typedef struct ECPY_Obj *ECPY_Handle;


typedef struct ECPY_Params {

    ECPY_TransferType transferType;

    Void *         srcAddr;

    Void *         dstAddr;

    unsigned short elementSize;

    unsigned short numElements;

    unsigned short numFrames ;

    short srcElementIndex;

    short dstElementIndex;

    short srcFrameIndex;

    short dstFrameIndex;

} ECPY_Params;


#if defined(ECPY_CONFIGURE_INLINE) || defined(ECPY_INLINE_ALL)
#include <ti/sdo/fc/ecpy/ecpy_configure.h>
#else
Void ECPY_configure(ECPY_Handle handle, ECPY_Params * restrict params,
    short transferNo);
#endif

#if defined(ECPY_DIRECTCONFIGURE_INLINE) || defined(ECPY_INLINE_ALL)
#include <ti/sdo/fc/ecpy/ecpy_directconfigure.h>
#else
Void ECPY_directConfigure(ECPY_Handle handle, ECPY_Params * restrict params,
    short transferNo);
#endif


#if defined(ECPY_CONFIGURE16_INLINE) || defined(ECPY_INLINE_ALL)
#include <ti/sdo/fc/ecpy/ecpy_configure16.h>
#else
Void ECPY_configure16(ECPY_Handle handle, ECPY_ParamField16b fieldId,
        unsigned short value, short transferNo);
#endif

#if defined(ECPY_DIRECTCONFIGURE16_INLINE) || defined(ECPY_INLINE_ALL)
#include <ti/sdo/fc/ecpy/ecpy_directconfigure16.h>
#else
Void ECPY_directConfigure16(ECPY_Handle handle, ECPY_ParamField16b fieldId,
        unsigned short value, short transferNo);
#endif

#if defined(ECPY_CONFIGURE32_INLINE) || defined(ECPY_INLINE_ALL)
#include <ti/sdo/fc/ecpy/ecpy_configure32.h>
#else
Void ECPY_configure32(ECPY_Handle handle, ECPY_ParamField32b fieldId,
        unsigned int value, short transferNo);
#endif

#if defined(ECPY_DIRECTCONFIGURE32_INLINE) || defined(ECPY_INLINE_ALL)
#include <ti/sdo/fc/ecpy/ecpy_directconfigure32.h>
#else
Void ECPY_directConfigure32(ECPY_Handle handle, ECPY_ParamField32b fieldId,
        unsigned int value, short transferNo);
#endif

#if defined(ECPY_SETFINAL_INLINE) || defined(ECPY_INLINE_ALL)
#include <ti/sdo/fc/ecpy/ecpy_setfinal.h>
#else
Void ECPY_setFinal(ECPY_Handle handle, short transferNo);
#endif

#if defined(ECPY_DIRECTSETFINAL_INLINE) || defined(ECPY_INLINE_ALL)
#include <ti/sdo/fc/ecpy/ecpy_directsetfinal.h>
#else
Void ECPY_directSetFinal(ECPY_Handle handle, short transferNo);
#endif

Void ECPY_setDestinationMemoryMode(ECPY_Handle handle, short mode);

#if defined(ECPY_START_INLINE) || defined(ECPY_INLINE_ALL)
#include <ti/sdo/fc/ecpy/ecpy_start.h>
#else
Void ECPY_start(ECPY_Handle handle);
#endif


#if defined(ECPY_DIRECTSTARTEDMA_INLINE) || defined(ECPY_INLINE_ALL)
#include <ti/sdo/fc/ecpy/ecpy_directstartedma.h>
#else
Void ECPY_directStartEdma(ECPY_Handle handle);
#endif

Void ECPY_directStartQdma(ECPY_Handle handle);


#if defined(ECPY_WAIT_INLINE) || defined(ECPY_INLINE_ALL)
#include <ti/sdo/fc/ecpy/ecpy_wait.h>
#else
Void ECPY_wait(ECPY_Handle handle);
#endif

#if defined(ECPY_DIRECTWAIT_INLINE) || defined(ECPY_INLINE_ALL)
#include <ti/sdo/fc/ecpy/ecpy_directwait.h>
#else
Void ECPY_directWait(ECPY_Handle handle);
#endif

Void ECPY_activate(ECPY_Handle handle);

ECPY_Handle ECPY_createHandle(IRES_EDMA3CHAN2_Handle handle, IALG_Handle alg);

Void ECPY_deleteHandle(ECPY_Handle handle);

Void ECPY_deactivate(ECPY_Handle handle);

Void ECPY_setEarlyCompletionMode(ECPY_Handle handle, short enabled);

Void ECPY_init(Void);

Void ECPY_exit(Void);

typedef Bool (ECPY_PersistentAllocFxn)(IALG_MemRec *memTab, Int numRecs);

typedef Void (ECPY_PersistentFreeFxn)(IALG_MemRec *memTab, Int numRecs);

typedef Bool (ECPY_ScratchAllocFxn)(IALG_Handle alg, Int scratchId,
                                    IALG_MemRec *memTab, Int numRecs);
typedef Void (ECPY_ScratchFreeFxn)(Int mutexId, Void *addr, UInt size);

typedef Int  (ECPY_getScratchIdFxn)(IALG_Handle alg);


typedef struct ECPY_CfgParams {

    ECPY_PersistentAllocFxn * allocFxn;

    ECPY_PersistentFreeFxn * freeFxn;

    ECPY_ScratchAllocFxn * scratchAllocFxn;

    ECPY_ScratchFreeFxn * scratchFreeFxn;

    ECPY_getScratchIdFxn *getScratchIdFxn;
} ECPY_CfgParams;

extern __FAR__ ECPY_CfgParams ECPY_CFG_PARAMS;

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


#endif /* ti_sdo_fc_ecpy_ECPY_ */

/*
 *  @(#) ti.sdo.fc.ecpy; 1, 0, 1,4; 2-7-2013 17:31:15; /db/atree/library/trees/fc/fc-r17/src/ xlibrary

 */