idma3.h

Go to the documentation of this file.

/*
 * Copyright (c) 2006-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 IDMA3_
#define IDMA3_



#ifdef __cplusplus
extern "C" {
#endif

#include "ialg.h"

typedef enum IDMA3_MemType {
    IDMA3_INTERNAL,             
    IDMA3_EXTERNAL              
} IDMA3_MemType;


typedef struct IDMA3_MemRec {

    Void *base;

    Uns size;

    Uns align;

    IDMA3_MemType memType;

} IDMA3_MemRec;


typedef struct IDMA3_Obj *IDMA3_Handle;


typedef struct IDMA3_ProtocolObj *IDMA3_ProtocolHandle;


#define IDMA3_PROTOCOL_NULL ((IDMA3_ProtocolHandle)NULL)


typedef enum IDMA3_Priority {

    IDMA3_PRIORITY_URGENT,
    IDMA3_PRIORITY_HIGH,
    IDMA3_PRIORITY_MEDIUM,
    IDMA3_PRIORITY_LOW

} IDMA3_Priority;


typedef struct IDMA3_ChannelRec {

    IDMA3_Handle handle;

    Int numTransfers;

    Int numWaits;

    IDMA3_Priority priority;

    IDMA3_ProtocolHandle protocol;

    Bool persistent;

} IDMA3_ChannelRec;


typedef struct IDMA3_Fxns {

    Void *implementationId;

    Void (*dmaChangeChannels)(IALG_Handle handle, IDMA3_ChannelRec *chnlRec);

    Uns (*dmaGetChannelCnt)(Void);

    Uns (*dmaGetChannels)(IALG_Handle handle, IDMA3_ChannelRec *chnlRec);

    Int (*dmaInit)(IALG_Handle handle, IDMA3_ChannelRec *chnlRec);

} IDMA3_Fxns;


typedef struct IDMA3_ProtocolObj {

    String name;

    Void (*getEnvMemRec)(IDMA3_ChannelRec *chnlRec, IDMA3_MemRec *memRec);

    Bool (*initHandle)(IDMA3_Handle handle);

    Bool (*deInitHandle)(IDMA3_Handle handle);

} IDMA3_ProtocolObj;


typedef struct IDMA3_Obj {

    unsigned short numTccs;

    unsigned short numPaRams;

    unsigned char *tccTable;

    Uns *paRamAddr;

    unsigned short qdmaChan;

    Bool transferPending;

    Void *env;

    IDMA3_ProtocolHandle protocol;

    Bool persistent;

} IDMA3_Obj;


#ifdef __cplusplus
}
#endif

#endif