mcspi_dma.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2021-22 Texas Instruments Incorporated
 *
 *  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 MCSPI_DMA_H_
#define MCSPI_DMA_H_
 
#include <stdint.h>
#include <kernel/dpl/SystemP.h>
#include <drivers/mcspi.h>
 
#ifdef __cplusplus
extern "C"
{
#endif
 
typedef void* MCSPI_DmaHandle;
 
typedef int32_t (*MCSPI_dmaOpenFxn)(void *mcspiDmaArgs);
 
typedef int32_t (*MCSPI_dmaCloseFxn)(MCSPI_Handle handle, const MCSPI_ChConfig *chCfg);
 
typedef int32_t (*MCSPI_dmaChInitFxn)(MCSPI_Handle handle,
                        const MCSPI_ChConfig *chCfg,
                        const MCSPI_DmaChConfig *dmaChCfg);
 
typedef int32_t (*MCSPI_dmaTransferMasterFxn)(MCSPI_Object *obj,
                                MCSPI_ChObject *chObj,
                                const MCSPI_Attrs *attrs,
                                MCSPI_Transaction *transaction);
typedef int32_t (*MCSPI_dmaStopFxn)(MCSPI_Object *obj,
                                const MCSPI_Attrs *attrs,
                                MCSPI_ChObject *chObj,
                                uint32_t chNum);
 
typedef struct MCSPI_DmaFxns_s
{
    MCSPI_dmaOpenFxn                dmaOpenFxn;
    MCSPI_dmaCloseFxn               dmaCloseFxn;
    MCSPI_dmaChInitFxn              dmaChInitFxn;
    MCSPI_dmaTransferMasterFxn      dmaTransferMasterFxn;
    MCSPI_dmaStopFxn                dmaStopFxn;
 
} MCSPI_DmaFxns;
 
#if defined (DMA_VERSION_MCSPI_UDMA)
extern MCSPI_DmaFxns gMcspiDmaUdmaFxns;
#endif
#if defined (DMA_VERSION_MCSPI_EDMA)
extern MCSPI_DmaFxns gMcspiDmaEdmaFxns;
#endif
 
typedef struct MCSPI_DmaConfig_s
{
    MCSPI_DmaFxns *fxns;
    /* Registered callbacks for a particular DMA driver. This will be set by Sysconfig depending on the DMA driver selected*/
    void *mcspiDmaArgs;
    /* Arguments specific to a DMA driver. This will be typecasted to the specific DMA driver args struct
     * when used by the appropriate callback. This struct will be defined in the specific DMA driver header file.
     * Allocation of this struct will be done statically using Sysconfig code generation in the example code
     */
} MCSPI_DmaConfig;
 
MCSPI_DmaHandle MCSPI_dmaOpen(int32_t dmaConfigIndex);
 
int32_t MCSPI_dmaClose(MCSPI_Handle handle, const MCSPI_ChConfig *chCfg);
 
int32_t MCSPI_dmaChInit(MCSPI_Handle handle, const MCSPI_ChConfig *chCfg,
                        const MCSPI_DmaChConfig *dmaChCfg);
 
int32_t MCSPI_dmaTransfer(MCSPI_Object *obj, MCSPI_ChObject *chObj,
                   const MCSPI_Attrs *attrs, MCSPI_Transaction *transaction);
 
int32_t MCSPI_dmaStop(MCSPI_Object *obj,
                      const MCSPI_Attrs *attrs,
                      MCSPI_ChObject *chObj,
                      uint32_t chNum);
#ifdef __cplusplus
}
#endif
 
#endif /* MCSPI_DMA_H_ */