edma.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011, 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_linuxutils_edma_interface_edma_
#define ti_sdo_linuxutils_edma_interface_edma_

#if defined (__cplusplus)
extern "C" {
#endif


#define EDMA_VERSION    0x02000000U

/*
 * To make implementation easier, we're matching the values below to
 * similar values in the kernel header file include/asm/arch/edma.h.
 * However, we're not tied to the LSP #defines since we translate from
 * our #defines below to the LSP #defines in the kernel module edmak.ko.
 * What this means is that we are free to change the ones below, but must
 * be sure to not clash with EDMA channel numbers directly
 * (0 -> (EDMA_NUM_DMACH - 1)).
 */
#define EDMA_TCCANY             1001
#define EDMA_TCCSYMM            1005
#define EDMA_PARAMANY           1006
#define EDMA_PARAMFIXEDEXACT    1007
#define EDMA_PARAMFIXEDNOTEXACT 1008
#define EDMA_EDMAANY            1003
#define EDMA_QDMAANY            1004
#define EDMA_QDMA0              512     /* should be > all arch's # PaRAM */

#define EDMA_QDMA1    EDMA_QDMA(1)
#define EDMA_QDMA2    EDMA_QDMA(2)
#define EDMA_QDMA3    EDMA_QDMA(3)
#define EDMA_QDMA4    EDMA_QDMA(4)
#define EDMA_QDMA5    EDMA_QDMA(5)
#define EDMA_QDMA6    EDMA_QDMA(6)
#define EDMA_QDMA7    EDMA_QDMA(7)

#define EDMA_QDMA(n)  (EDMA_QDMA0 + (n))

#define EDMA_QDMA2NUM(qdma)  (qdma - EDMA_QDMA0)

typedef enum {
    EDMA_IOCREQUESTDMA = 1,
    EDMA_IOCRELEASEDMA,
    EDMA_IOCGETVERSION,
    EDMA_IOCGETBASEPHYSADDR,
    EDMA_IOCREGUSER
} EDMA_commmands;

#define EDMA_IOCMAGIC                   0x0000fd00
#define EDMA_IOCCMDMASK                 0x000000ff

struct EDMA_requestDmaParams {
    int dev_id;                                   
    int eventq_no;                                
    int tcc;                                      
    int param;                                    
    int nParam;
    int channel;                                  
};

struct EDMA_releaseDmaParams {
    int channel;
    int nParam;
};

typedef enum EDMA_Status {
    EDMA_OK = 0,        
    EDMA_EFAIL,         
    EDMA_ENOCHANNEL,    
    EDMA_ENOINIT        
} EDMA_Status;


int EDMA_init(void);

int EDMA_exit(void);

EDMA_Status EDMA_mapBaseAddress(void **pvirtAddr);

EDMA_Status EDMA_getResource(int devId, int *tcc, int *channel, int *param,
                             int nParams);

EDMA_Status EDMA_freeResource(int lch, int nParams);

int EDMA_getVersion(void);

EDMA_Status EDMA_registerResource(int lch);

EDMA_Status EDMA_unregister(int lch, int nParams);

#if defined (__cplusplus)
}
#endif

#endif
/*
 *  @(#) ti.sdo.linuxutils.edma; 1, 0, 0,96; 12-9-2011 16:56:41; /db/atree/library/trees/linuxutils/linuxutils-j06x/src/ xlibrary

 */