rti/v0/rti.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2022 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 RTI_H_
#define RTI_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include <drivers/hw_include/cslr_rti.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define    RTI_GC_STALL_MODE_ON     (CSL_RTI_RTIGCTRL_COS_STOPPED)
 
#define    RTI_GC_STALL_MODE_OFF    (CSL_RTI_RTIGCTRL_COS_RUNNING)
 
#define RTI_TMR_CNT_BLK_INDEX_0        (0U)
 
#define RTI_TMR_CNT_BLK_INDEX_1        (1U)
 
#define RTI_TMR_CNT_BLK_INDEX_MAX      (RTI_TMR_CNT_BLK_INDEX_1)
 
#define RTI_TMR_CMP_BLK_INDEX_0        (0U)
 
#define RTI_TMR_CMP_BLK_INDEX_1        (1U)
 
#define RTI_TMR_CMP_BLK_INDEX_2        (2U)
 
#define RTI_TMR_CMP_BLK_INDEX_3        (3U)
 
#define RTI_TMR_CMP_BLK_INDEX_MAX      (RTI_TMR_CMP_BLK_INDEX_3)
 
#define RTI_TMR_MIN_PRESCALER_VAL           (1U)
 
#define RTI_TMR_MAX_PRESACLER_VAL           (0xFFFFFFFFU)
 
#define RTI_TMR_INT_INT0_FLAG        (CSL_RTI_RTISETINT_SETINT0_MASK)
 
#define RTI_TMR_INT_INT1_FLAG        (CSL_RTI_RTISETINT_SETINT1_MASK)
 
#define RTI_TMR_INT_INT2_FLAG        (CSL_RTI_RTISETINT_SETINT2_MASK)
 
#define RTI_TMR_INT_INT3_FLAG        (CSL_RTI_RTISETINT_SETINT3_MASK)
 
#define RTI_TMR_INT_DMA0_FLAG        (CSL_RTI_RTISETINT_SETDMA0_MASK)
 
#define RTI_TMR_INT_DMA1_FLAG        (CSL_RTI_RTISETINT_SETDMA1_MASK)
 
#define RTI_TMR_INT_DMA2_FLAG        (CSL_RTI_RTISETINT_SETDMA2_MASK)
 
#define RTI_TMR_INT_DMA3_FLAG        (CSL_RTI_RTISETINT_SETDMA3_MASK)
 
#define RTI_TMR_INT_TB_FLAG          (CSL_RTI_RTISETINT_SETTBINT_MASK)
 
#define RTI_TMR_INT_OVL0_FLAG        (CSL_RTI_RTISETINT_SETOVL0INT_MASK)
 
#define RTI_TMR_INT_OVL1_FLAG        (CSL_RTI_RTISETINT_SETOVL1INT_MASK)
 
#define RTI_TMR_INT_STATUS_ALL       (RTI_TMR_INT_INT0_FLAG |   \
                                      RTI_TMR_INT_INT1_FLAG |   \
                                      RTI_TMR_INT_INT2_FLAG |   \
                                      RTI_TMR_INT_INT3_FLAG |   \
                                      RTI_TMR_INT_TB_FLAG   |   \
                                      RTI_TMR_INT_OVL0_FLAG |   \
                                      RTI_TMR_INT_OVL1_FLAG)
 
#define RTI_TMR_INT_REQ_ALL          (RTI_TMR_INT_INT0_FLAG |   \
                                      RTI_TMR_INT_INT1_FLAG |   \
                                      RTI_TMR_INT_INT2_FLAG |   \
                                      RTI_TMR_INT_INT3_FLAG |   \
                                      RTI_TMR_INT_DMA0_FLAG |   \
                                      RTI_TMR_INT_DMA1_FLAG |   \
                                      RTI_TMR_INT_DMA2_FLAG |   \
                                      RTI_TMR_INT_DMA3_FLAG |   \
                                      RTI_TMR_INT_TB_FLAG   |   \
                                      RTI_TMR_INT_OVL0_FLAG |   \
                                      RTI_TMR_INT_OVL1_FLAG)
 
#define RTI_TMR_INT_AUTO_CLR_ENABLE_FLAG  (0x0000000FU)
 
#define RTI_TMR_INT_AUTO_CLR_DISABLE_FLAG  (0x00000005U)
 
#define RTI_TMR_NTU_0        (0x0U)
 
#define RTI_TMR_NTU_1        (0x5U)
 
#define RTI_TMR_NTU_2        (0xAU)
 
#define RTI_TMR_NTU_3        (0xFU)
 
#define RTI_TMR_CAPTURE_EVT_0        (0U)
 
#define RTI_TMR_CAPTURE_EVT_1        (1U)
 
#define RTI_TMR_CAPTURE_EVT_MAX      (RTI_TMR_CAPTURE_EVT_1)
 
#define RTI_TMR_CLK_SRC_COUNTER     (0U)
 
#define RTI_TMR_CLK_SRC_NTU         (1U)
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
int32_t RTIG_setStallMode(uint32_t baseAddr, uint32_t stallMode);
 
int32_t RTI_counterEnable(uint32_t baseAddr, uint32_t cntIndex);
 
int32_t RTI_counterDisable(uint32_t baseAddr, uint32_t cntIndex);
 
int32_t RTI_counterClear(uint32_t baseAddr, uint32_t cntIndex);
 
int32_t RTI_compareClear(uint32_t baseAddr, uint32_t cmpIndex);
 
int32_t RTI_counterGet(uint32_t baseAddr, uint32_t cntIndex, uint32_t *counterLow, uint32_t *counterHigh);
 
int32_t RTI_captureConfig(uint32_t baseAddr, uint32_t cntIndex, uint32_t cntrCapSrc);
 
int32_t RTI_captureCounterGet(uint32_t baseAddr, uint32_t cntIndex, uint32_t *counterLow, uint32_t *counterHigh);
 
int32_t RTI_compareEventConfig(uint32_t baseAddr, uint32_t cmpIndex, uint32_t cntBlkIndex, uint32_t cmpVal, uint32_t period);
 
int32_t RTI_counterConfigure(uint32_t baseAddr, uint32_t cntBlkIndex, uint32_t clkSrc, uint32_t ntu, uint32_t prescaler);
 
uint32_t RTI_compareGet(uint32_t baseAddr, uint32_t cmpIndex);
 
int32_t RTI_compareClearConfig(uint32_t baseAddr, uint32_t cmpIndex, uint32_t cmpClearVal);
 
uint32_t RTI_intStatusGet(uint32_t baseAddr);
 
int32_t RTI_intStatusClear(uint32_t baseAddr, uint32_t intFlags);
 
int32_t RTI_intEnable(uint32_t baseAddr, uint32_t intFlags);
 
int32_t RTI_intDisable(uint32_t baseAddr, uint32_t intFlags);
 
int32_t RTI_intAutoClearEnable(uint32_t baseAddr, uint32_t cmpIndex);
 
int32_t RTI_intAutoClearDisable(uint32_t baseAddr, uint32_t cmpIndex);
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef RTI_H_ */