sdma.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_sdma_interface_sdma_
#define ti_sdo_linuxutils_sdma_interface_sdma_

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


#define SDMA_VERSION    0x01010000U

#define SDMA_IOCMAGIC                   0x0000fb00
#define SDMA_IOCCMDMASK                 0x000000ff

#define SDMA_IOCREQUESTDMA              1
#define SDMA_IOCRELEASEDMA              2
#define SDMA_IOCWAITFORCOMPLETION       3
#define SDMA_IOCGETVERSION              4

struct SDMA_transferState {
    volatile int transferCompleted;    
    volatile int checkPending;         
};

union SDMA_requestDmaParams {
    struct SDMA_transferState *ptransferState;    
    int channel;                                  
};

typedef struct SDMA_ChannelDescriptor {
    int chanNum;            
    unsigned int * addr;    
    struct SDMA_transferState transferState;    
} SDMA_ChannelDescriptor;

typedef enum SDMA_Status {
    SDMA_OK = 0,        
    SDMA_EFAIL,         
    SDMA_ENOCHANNEL,    
    SDMA_ENOINIT        
} SDMA_Status;


int SDMA_init(void);

int SDMA_exit(void);

SDMA_Status SDMA_getChannels(int numChannels,
        SDMA_ChannelDescriptor chanArray[]);

SDMA_Status SDMA_freeChannels(int numChannels,
        SDMA_ChannelDescriptor chanArray[]);

SDMA_Status SDMA_wait(SDMA_ChannelDescriptor * channel);

SDMA_Status SDMA_check(SDMA_ChannelDescriptor * channel, int *pcompleted);

int SDMA_getVersion(void);

#if defined (__cplusplus)
}
#endif

#endif
/*
 *  @(#) ti.sdo.linuxutils.sdma; 1, 0, 0,99; 12-9-2011 16:57:06; /db/atree/library/trees/linuxutils/linuxutils-j06x/src/ xlibrary

 */