scpy.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_scpy_SCPY_
#define ti_sdo_fc_scpy_SCPY_


/* TODO: Uncommenting the below define creates ordering dependencies between
         ires_sdma.h and scpy.h (ires_sdma.h needs to be before scpy.h)
         Need to figure this out, till then commenting it out.
         Warnings appear during build of this library */
/*  #define ti_sdo_fc_ires_NOPROTOCOLREV*/


#ifdef __cplusplus
extern "C" {
#endif

#include <ti/sdo/fc/ires/sdma/ires_sdma.h>

#define OMAP_DMA_DATA_TYPE_S8       0x00  
#define OMAP_DMA_DATA_TYPE_S16      0x01 
#define OMAP_DMA_DATA_TYPE_S32      0x02

#define OMAP_DMA_PORT_EMIFF         0x00

#define OMAP_DMA_AMODE_POST_CONST           0x00
#define OMAP_DMA_AMODE_POST_INC             0x01
#define OMAP_DMA_AMODE_POST_SINGLE_INDEX    0x02
#define OMAP_DMA_AMODE_POST_DOUBLE_INDEX    0x03

#define OMAP_DMA_SYNC_MODE_ELEMENT  0x00
#define OMAP_DMA_SYNC_MODE_FRAME    0x01
#define OMAP_DMA_SYNC_MODE_BLOCK    0x02

#define OMAP_DMA_SYNC_TYPE_DEST     0x00
#define OMAP_DMA_SYNC_TYPE_SRC      0x01


typedef struct SCPY_AddrParams {
    int addr_mode;
    unsigned int addr;
    int elem_index;
    int frame_index;
} SCPY_AddrParams;

typedef struct SCPY_TransferParams {
    int dataType;
    int elemCount;
    int frameCount;
} SCPY_TransferParams;

/*
 *  @brief      Paramters of transfer
 */
typedef struct SCPY_Params {
    SCPY_AddrParams * src;
    SCPY_AddrParams * dst;
    SCPY_TransferParams * transfer;
} SCPY_Params;

void SCPY_init();

void SCPY_exit();

void SCPY_configure(IRES_SDMA_Handle logicalChannel, SCPY_Params * params);

void SCPY_start(IRES_SDMA_Handle logicalChannel);

void SCPY_wait(IRES_SDMA_Handle logicalChannel);

Bool SCPY_complete(IRES_SDMA_Handle logicalChannel);


#ifdef __cplusplus
}
#endif /* extern "C" */
 
#endif /* ti_sdo_fc_scpy_SCPY_*/
/*
 *  @(#) ti.sdo.fc.scpy; 1, 0, 0,3; 4-16-2012 00:02:37; /db/atree/library/trees/fc/fc-q08/src/ xlibrary

 */