UDMALPF3.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022-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.
 */
#ifndef ti_drivers_UDMALPF3__include
#define ti_drivers_UDMALPF3__include

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

#include <ti/drivers/Power.h>

#include <ti/devices/DeviceFamily.h>
#include DeviceFamily_constructPath(inc/hw_types.h)
#include DeviceFamily_constructPath(driverlib/udma.h)

#ifdef __cplusplus
extern "C" {
#endif

#if !defined(UDMALPF3_CONFIG_BASE)
    #define UDMALPF3_CONFIG_BASE 0x20000400
#endif

#if (UDMALPF3_CONFIG_BASE & 0x3FF)
    #error "Base address for DMA control table 'UDMALPF3_CONFIG_BASE' must be 1024 bytes aligned."
#endif

#if defined(__IAR_SYSTEMS_ICC__)
    #define ALLOCATE_CONTROL_TABLE_ENTRY(ENTRY_NAME, CHANNEL_INDEX)                               \
        __no_init __root static volatile uDMAControlTableEntry ENTRY_NAME @UDMALPF3_CONFIG_BASE + \
            (CHANNEL_INDEX) * sizeof(uDMAControlTableEntry)
#elif defined(__TI_COMPILER_VERSION__) || defined(__clang__)
    #define ALLOCATE_CONTROL_TABLE_ENTRY(ENTRY_NAME, CHANNEL_INDEX) \
        static volatile uDMAControlTableEntry ENTRY_NAME            \
            __attribute__((retain,                                  \
                           location((UDMALPF3_CONFIG_BASE) + (CHANNEL_INDEX) * sizeof(uDMAControlTableEntry))))
#elif defined(__GNUC__)
    #define ALLOCATE_CONTROL_TABLE_ENTRY(ENTRY_NAME, CHANNEL_INDEX)                                          \
        extern int UDMALPF3_##ENTRY_NAME##_is_placed;                                                        \
        __attribute__((section("." #ENTRY_NAME), used)) static volatile uDMAControlTableEntry ENTRY_NAME = { \
            &UDMALPF3_##ENTRY_NAME##_is_placed}
#else
    #error "don't know how to define ALLOCATE_CONTROL_TABLE_ENTRY for this toolchain"
#endif

#define UDMALPF3_SET_TRANSFER_SIZE(SIZE)    (((SIZE - 1) << UDMA_XFER_SIZE_S) & UDMA_XFER_SIZE_M)

#define UDMALPF3_GET_TRANSFER_SIZE(CONTROL) (((CONTROL & UDMA_XFER_SIZE_M) >> UDMA_XFER_SIZE_S) + 1)

typedef struct
{
    uint32_t CtrlBaseAddr; 
} UDMALPF3_Config;

/* Externs from ti_drivers_config.c */
extern const UDMALPF3_Config UDMALPF3_config;

extern void UDMALPF3_init(void);

__STATIC_INLINE void UDMALPF3_channelEnable(uint32_t channelBitMask)
{
    /* Enable DMA channel */
    uDMAEnableChannel(channelBitMask);
}

__STATIC_INLINE bool UDMALPF3_channelDone(uint32_t channelBitMask)
{
    /* Check if REQDONE is set for the specified channels */
    return (uDMAIntStatus() & channelBitMask) ? true : false;
}

__STATIC_INLINE void UDMALPF3_clearInterrupt(uint32_t channelBitMask)
{
    /* Clear UDMA done interrupt */
    uDMAClearInt(channelBitMask);
}

__STATIC_INLINE void UDMALPF3_channelDisable(uint32_t channelBitMask)
{
    /* Disable provided channels(s) */
    uDMADisableChannel(channelBitMask);
}

__STATIC_INLINE void UDMALPF3_disableAttribute(uint32_t channelBitMask, uint32_t attr)
{
    /* disable provided attribute for the given channel */
    uDMADisableChannelAttribute(channelBitMask, attr);
}

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_UDMALPF3__include */