DMAMSPM0.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023, 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.
 */
/*!****************************************************************************
 *  @file       DMAMSPM0.h
 *
 *  @brief      DMA driver implementation for MSPM0.
 *
 *  @defgroup   DMA Direct Memory Access (DMA)
 *
 *  The DMA header file should be included in an application as follows:
 *  @code
 *  #include <ti/drivers/dma/DMAMSPM0.h>
 *  @endcode
 *
 *  @anchor ti_drivers_DMA_Overview
 *  # Overview
 *
 *  This driver is intended for use only by drivers that use the DMA
 *  peripheral (e.g., SPI).  This driver is mainly used for management of
 *  the control table base address of the DMA peripheral.
 *
 *  The application should set up the DMAMSPM0_HWAttrs and DMAMSPM0_Config structures.
 *
 *  The DMAMSPM0 header file should be included in an application as follows:
 *  @code
 *  #include <ti/drivers/dma/DMAMSPM0.h>
 *  @endcode
 *
 ******************************************************************************
 */
/* clang-format off */
#ifndef ti_drivers_dma_DMAMSPM0__include
#define ti_drivers_dma_DMAMSPM0__include

#include <stdbool.h>
#include <stdint.h>

#include <ti/driverlib/dl_dma.h>
#include <ti/drivers/dpl/HwiP.h>

#ifdef __cplusplus
extern "C" {
#endif

#define NUM_DMA_CHANNELS (DMA_SYS_N_DMA_CHANNEL)

typedef void (*DMAMSPM0_IsrFxn)(uintptr_t arg);

typedef struct
{
    DMAMSPM0_IsrFxn dmaIsrFxn; 
    uint8_t intPriority;       
    bool roundRobinPriority;   
} DMAMSPM0_HWAttrs;



typedef struct
{
    uint8_t txTrigger;                  
    uint8_t rxTrigger;                  
    DL_DMA_TRIGGER_TYPE txTriggerType;  
    DL_DMA_TRIGGER_TYPE rxTriggerType;  
    DL_DMA_TRANSFER_MODE transferMode;  
    DL_DMA_EXTENDED_MODE extendedMode;  
    DL_DMA_WIDTH srcWidth;              
    DL_DMA_WIDTH destWidth;             
    DL_DMA_INCREMENT srcIncrement;      
    DL_DMA_INCREMENT destIncrement;     
    uint8_t dmaChannel;                 
    void *dmaTransferSource;            
    void *dmaTransferDestination;       
    uint32_t noOfData;                  
    DMAMSPM0_IsrFxn dmaChIsrFxn;        
    bool enableDMAISR;                  
} DMAMSPM0_Transfer;

typedef struct
{
    DMAMSPM0_Transfer dmaTransfer;
} DMAMSPM0_Object;
typedef struct
{
    void const *hwAttrs;        
    void *object;        
} DMAMSPM0_Cfg;

extern const DMAMSPM0_Cfg DMAMSPM0_Config[];

extern const uint_least8_t DMA_Count;

typedef DMAMSPM0_Cfg* DMAMSPM0_Handle;

extern void DMAMSPM0_close(DMA_Regs *handle, uint8_t channelNum);
extern bool DMAMSPM0_init(void);

extern DMAMSPM0_Handle DMAMSPM0_open(uint_least8_t index, uint8_t channelNum);

bool DMAMSPM0_setupTransfer(DMAMSPM0_Transfer *transfer, DL_DMA_Config* DMACfg);
DMAMSPM0_Handle DMA_Init(DMAMSPM0_Transfer* dmaParams, DL_DMA_Config* DMACfg, uint8_t noOfChs);

void DMAMSPM0_disableChannel(DMAMSPM0_Handle handle, uint8_t dmaChannel);

uint16_t DMAMSPM0_getCurrTransferSize(uint8_t dmaChannel);

void DMA_Params_init(DMAMSPM0_Transfer *params);

void DMAMSPM0_copyDMAParams(DMAMSPM0_Transfer* dmaParams, DL_DMA_Config* dmaConfig);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_dma_DMAMSPM0__include */
/* clang-format on */