acpy3.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 _ACPY3_
#define _ACPY3_


#ifdef __cplusplus
extern "C" {
#endif


#include <ti/xdais/idma3.h>

#define ACPY3_GTNAME "ti.sdo.fc.acpy3"

#define ACPY3_MODNAME "ti.sdo.fc.acpy3"


typedef enum ACPY3_ParamField16b {

    ACPY3_PARAMFIELD_ELEMENTSIZE =  8,
    ACPY3_PARAMFIELD_NUMELEMENTS = 10 ,
    ACPY3_PARAMFIELD_ELEMENTINDEX_SRC = 16,
    ACPY3_PARAMFIELD_ELEMENTINDEX_DST = 18,
    ACPY3_PARAMFIELD_FRAMEINDEX_SRC =  24,
    ACPY3_PARAMFIELD_FRAMEINDEX_DST =  26,
    ACPY3_PARAMFIELD_NUMFRAMES = 28

} ACPY3_ParamField16b;

typedef enum ACPY3_ParamField32b {

    ACPY3_PARAMFIELD_SRCADDR = 4,
    ACPY3_PARAMFIELD_DSTADDR = 12,
    ACPY3_PARAMFIELD_ELEMENTINDEXES = 16,
    ACPY3_PARAMFIELD_FRAMEINDEXES = 24

} ACPY3_ParamField32b;

typedef enum ACPY3_TransferType {

    ACPY3_1D1D,

    ACPY3_1D2D,

    ACPY3_2D1D,

    ACPY3_2D2D
} ACPY3_TransferType;


typedef struct ACPY3_Params {

    ACPY3_TransferType transferType;

    Void *         srcAddr;

    Void *         dstAddr;

    unsigned short elementSize;

    unsigned short numElements;

    unsigned short numFrames ;

    short srcElementIndex;

    short dstElementIndex;

    short srcFrameIndex;

    short dstFrameIndex;

    short waitId;

} ACPY3_Params;


extern IDMA3_ProtocolObj ACPY3_PROTOCOL;

Void ACPY3_configure(IDMA3_Handle handle, ACPY3_Params *params,
    short transferNo);


#if defined(ACPY3_FASTCONFIGURE16B_INLINE) || defined(ACPY3_INLINE_ALL)
#include <ti/sdo/fc/acpy3/acpy3_fastconfigure16b.h>
#else
Void ACPY3_fastConfigure16b(IDMA3_Handle handle, ACPY3_ParamField16b fieldId,
    unsigned short value, short transferNo);
#endif

#if defined(ACPY3_FASTCONFIGURE32B_INLINE) || defined(ACPY3_INLINE_ALL)
#include <ti/sdo/fc/acpy3/acpy3_fastconfigure32b.h>
#else
Void ACPY3_fastConfigure32b(IDMA3_Handle handle, ACPY3_ParamField32b fieldId,
    Uns value, short transferNo);
#endif

#if defined(ACPY3_SETFINAL_INLINE) || defined(ACPY3_INLINE_ALL)
#include <ti/sdo/fc/acpy3/acpy3_setfinal.h>
#else
Void ACPY3_setFinal(IDMA3_Handle handle, short transferNo);
#endif

#if defined(ACPY3_FASTSETFINAL_INLINE) || defined(ACPY3_INLINE_ALL)
#include <ti/sdo/fc/acpy3/acpy3_fastsetfinal.h>
#else
Void ACPY3_fastSetFinal(IDMA3_Handle handle, short transferNo);
#endif

#if defined(ACPY3_START_INLINE) || defined(ACPY3_INLINE_ALL)
#include <ti/sdo/fc/acpy3/acpy3_start.h>
#else
Void ACPY3_start(IDMA3_Handle handle);
#endif


#if defined(ACPY3_WAIT_INLINE) || defined(ACPY3_INLINE_ALL)
#include <ti/sdo/fc/acpy3/acpy3_wait.h>
#else
Void ACPY3_wait(IDMA3_Handle handle);
#endif


Void ACPY3_waitLinked(IDMA3_Handle handle, unsigned short waitId);


#if defined(ACPY3_COMPLETE_INLINE) || defined(ACPY3_INLINE_ALL)
#include <ti/sdo/fc/acpy3/acpy3_complete.h>
#else
Bool ACPY3_complete(IDMA3_Handle handle);
#endif


Bool ACPY3_completeLinked(IDMA3_Handle handle, unsigned short waitId);


Void ACPY3_activate(IDMA3_Handle handle);


Void ACPY3_deactivate(IDMA3_Handle handle);


Void ACPY3_init(Void);

Void ACPY3_exit(Void);


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


#endif /* _ACPY3_ */

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

 */