evtsvt.h

Go to the documentation of this file.

/******************************************************************************
 *  Filename:       evtsvt.h
 *
 *  Description:    Prototypes and defines for the EVTSVT API.
 *
 *  Copyright (c) 2025 Texas Instruments Incorporated
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *
 *  1) Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *
 *  2) 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.
 *
 *  3) Neither the name of the copyright holder 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 HOLDER 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 __EVTSVT_H__
#define __EVTSVT_H__

//*****************************************************************************
//
//
//*****************************************************************************

#include <stdint.h>
#include "../inc/hw_types.h"
#include "../inc/hw_memmap.h"
#include "../inc/hw_evtsvt.h"

//*****************************************************************************
//
// If building with a C++ compiler, make all of the definitions in this header
// have a C binding.
//
//*****************************************************************************
#ifdef __cplusplus
extern "C" {
#endif

//*****************************************************************************
//
// Event subscribers
//
//*****************************************************************************

#define EVTSVT_SUB_CPUIRQ0  EVTSVT_O_CPUIRQ0SEL  
#define EVTSVT_SUB_CPUIRQ1  EVTSVT_O_CPUIRQ1SEL  
#define EVTSVT_SUB_CPUIRQ2  EVTSVT_O_CPUIRQ2SEL  
#define EVTSVT_SUB_CPUIRQ3  EVTSVT_O_CPUIRQ3SEL  
#define EVTSVT_SUB_CPUIRQ4  EVTSVT_O_CPUIRQ4SEL  
#define EVTSVT_SUB_CPUIRQ16 EVTSVT_O_CPUIRQ16SEL 
#define EVTSVT_SUB_CPUIRQ17 EVTSVT_O_CPUIRQ17SEL 
#define EVTSVT_SUB_SYSTIMC1 EVTSVT_O_SYSTIMC1SEL 
#define EVTSVT_SUB_SYSTIMC5 EVTSVT_O_SYSTIMC5SEL 
#define EVTSVT_SUB_ADCTRG   EVTSVT_O_ADCTRGSEL   
#define EVTSVT_SUB_LGPTSYNC EVTSVT_O_LGPTSYNCSEL 
#define EVTSVT_SUB_LGPT0IN0 EVTSVT_O_LGPT0IN0SEL 
#define EVTSVT_SUB_LGPT0IN1 EVTSVT_O_LGPT0IN1SEL 
#define EVTSVT_SUB_LGPT0IN2 EVTSVT_O_LGPT0IN2SEL 
#define EVTSVT_SUB_LGPT0TEN EVTSVT_O_LGPT0TENSEL 
#define EVTSVT_SUB_LGPT1IN0 EVTSVT_O_LGPT1IN0SEL 
#define EVTSVT_SUB_LGPT1IN1 EVTSVT_O_LGPT1IN1SEL 
#define EVTSVT_SUB_LGPT1IN2 EVTSVT_O_LGPT1IN2SEL 
#define EVTSVT_SUB_LGPT1TEN EVTSVT_O_LGPT1TENSEL 
#define EVTSVT_SUB_LGPT2IN0 EVTSVT_O_LGPT2IN0SEL 
#define EVTSVT_SUB_LGPT2IN1 EVTSVT_O_LGPT2IN1SEL 
#define EVTSVT_SUB_LGPT2IN2 EVTSVT_O_LGPT2IN2SEL 
#define EVTSVT_SUB_LGPT2TEN EVTSVT_O_LGPT2TENSEL 
#define EVTSVT_SUB_LGPT3IN0 EVTSVT_O_LGPT3IN0SEL 
#define EVTSVT_SUB_LGPT3IN1 EVTSVT_O_LGPT3IN1SEL 
#define EVTSVT_SUB_LGPT3IN2 EVTSVT_O_LGPT3IN2SEL 
#define EVTSVT_SUB_LGPT3TEN EVTSVT_O_LGPT3TENSEL 
#define EVTSVT_SUB_I2SSTMP  EVTSVT_O_I2SSTMPSEL  

//*****************************************************************************
//
// DMA channels
//
//*****************************************************************************

#define EVTSVT_DMA_CH0  EVTSVT_O_DMACH0SEL  
#define EVTSVT_DMA_CH1  EVTSVT_O_DMACH1SEL  
#define EVTSVT_DMA_CH2  EVTSVT_O_DMACH2SEL  
#define EVTSVT_DMA_CH3  EVTSVT_O_DMACH3SEL  
#define EVTSVT_DMA_CH4  EVTSVT_O_DMACH4SEL  
#define EVTSVT_DMA_CH5  EVTSVT_O_DMACH5SEL  
#define EVTSVT_DMA_CH6  EVTSVT_O_DMACH6SEL  
#define EVTSVT_DMA_CH7  EVTSVT_O_DMACH7SEL  
#define EVTSVT_DMA_CH8  EVTSVT_O_DMACH8SEL  
#define EVTSVT_DMA_CH9  EVTSVT_O_DMACH9SEL  
#define EVTSVT_DMA_CH10 EVTSVT_O_DMACH10SEL 
#define EVTSVT_DMA_CH11 EVTSVT_O_DMACH11SEL 

//*****************************************************************************
//
// DMA triggers for use use with dedicated DMA channels (DCH) in
// EVTSVTConfigureDma(). Channels 0-7 are dedicated DMA channels.
//
//*****************************************************************************

#define EVTSVT_DMA_TRIG_UART0TXTRG EVTSVT_DMACH2SEL_IPID_UART0TXTRG 
#define EVTSVT_DMA_TRIG_UART0RXTRG EVTSVT_DMACH3SEL_IPID_UART0RXTRG 
#define EVTSVT_DMA_TRIG_UART1TXTRG EVTSVT_DMACH1SEL_IPID_UART1TXTRG 
#define EVTSVT_DMA_TRIG_UART1RXTRG EVTSVT_DMACH0SEL_IPID_UART1RXTRG 
#define EVTSVT_DMA_TRIG_SPI0TXTRG  EVTSVT_DMACH0SEL_IPID_SPI0TXTRG  
#define EVTSVT_DMA_TRIG_SPI0RXTRG  EVTSVT_DMACH1SEL_IPID_SPI0RXTRG  
#define EVTSVT_DMA_TRIG_SPI1TXTRG  EVTSVT_DMACH6SEL_IPID_SPI1TXTRG  
#define EVTSVT_DMA_TRIG_SPI1RXTRG  EVTSVT_DMACH7SEL_IPID_SPI1RXTRG  
#define EVTSVT_DMA_TRIG_LRFDTRG    EVTSVT_DMACH2SEL_IPID_LRFDTRG    
#define EVTSVT_DMA_TRIG_ADC0TRG    EVTSVT_DMACH3SEL_IPID_ADC0TRG    
#define EVTSVT_DMA_TRIG_LAESTRGA   EVTSVT_DMACH4SEL_IPID_LAESTRGA   
#define EVTSVT_DMA_TRIG_LAESTRGB   EVTSVT_DMACH5SEL_IPID_LAESTRGB   
#define EVTSVT_DMA_TRIG_CANTRGA    EVTSVT_DMACH6SEL_IPID_CANTRGA    
#define EVTSVT_DMA_TRIG_CANTRGB    EVTSVT_DMACH7SEL_IPID_CANTRGB    

//*****************************************************************************
//
// Event publishers for use with EVTSVTConfigureEvent() and
// EVTSVTConfigureDma(). Channels 8-11 are event publisher DMA channels (ECH).
//
//*****************************************************************************

#define EVTSVT_PUB_SYSTIM5       EVTSVT_CPUIRQ0SEL_PUBID_SYSTIM5       
#define EVTSVT_PUB_GPIO_EVT1     EVTSVT_CPUIRQ0SEL_PUBID_GPIO_EVT1     
#define EVTSVT_PUB_APU_IRQ       EVTSVT_CPUIRQ0SEL_PUBID_APU_IRQ       
#define EVTSVT_PUB_SPI1_COMB     EVTSVT_CPUIRQ0SEL_PUBID_SPI1_COMB     
#define EVTSVT_PUB_CAN_EVT       EVTSVT_CPUIRQ0SEL_PUBID_CAN_EVT       
#define EVTSVT_PUB_CAN_IRQ       EVTSVT_CPUIRQ0SEL_PUBID_CAN_IRQ       
#define EVTSVT_PUB_I2S_IRQ       EVTSVT_CPUIRQ0SEL_PUBID_I2S_IRQ       
#define EVTSVT_PUB_LGPT3_ADC     EVTSVT_CPUIRQ0SEL_PUBID_LGPT3_ADC     
#define EVTSVT_PUB_LGPT3_DMA     EVTSVT_CPUIRQ0SEL_PUBID_LGPT3_DMA     
#define EVTSVT_PUB_LGPT3_COMB    EVTSVT_CPUIRQ0SEL_PUBID_LGPT3_COMB    
#define EVTSVT_PUB_LGPT3C2       EVTSVT_CPUIRQ0SEL_PUBID_LGPT3C2       
#define EVTSVT_PUB_LGPT3C1       EVTSVT_CPUIRQ0SEL_PUBID_LGPT3C1       
#define EVTSVT_PUB_LGPT3C0       EVTSVT_CPUIRQ0SEL_PUBID_LGPT3C0       
#define EVTSVT_PUB_LGPT2_ADC     EVTSVT_CPUIRQ0SEL_PUBID_LGPT2_ADC     
#define EVTSVT_PUB_LGPT2_DMA     EVTSVT_CPUIRQ0SEL_PUBID_LGPT2_DMA     
#define EVTSVT_PUB_LGPT2_COMB    EVTSVT_CPUIRQ0SEL_PUBID_LGPT2_COMB    
#define EVTSVT_PUB_LGPT2C2       EVTSVT_CPUIRQ0SEL_PUBID_LGPT2C2       
#define EVTSVT_PUB_LGPT2C1       EVTSVT_CPUIRQ0SEL_PUBID_LGPT2C1       
#define EVTSVT_PUB_LGPT2C0       EVTSVT_CPUIRQ0SEL_PUBID_LGPT2C0       
#define EVTSVT_PUB_UART1_COMB    EVTSVT_CPUIRQ0SEL_PUBID_UART1_COMB    
#define EVTSVT_PUB_LRFD_EVT2     EVTSVT_CPUIRQ0SEL_PUBID_LRFD_EVT2     
#define EVTSVT_PUB_LRFD_EVT1     EVTSVT_CPUIRQ0SEL_PUBID_LRFD_EVT1     
#define EVTSVT_PUB_LRFD_EVT0     EVTSVT_CPUIRQ0SEL_PUBID_LRFD_EVT0     
#define EVTSVT_PUB_LGPT1_ADC     EVTSVT_CPUIRQ0SEL_PUBID_LGPT1_ADC     
#define EVTSVT_PUB_LGPT1_DMA     EVTSVT_CPUIRQ0SEL_PUBID_LGPT1_DMA     
#define EVTSVT_PUB_LGPT1C2       EVTSVT_CPUIRQ0SEL_PUBID_LGPT1C2       
#define EVTSVT_PUB_LGPT1C1       EVTSVT_CPUIRQ0SEL_PUBID_LGPT1C1       
#define EVTSVT_PUB_LGPT1C0       EVTSVT_CPUIRQ0SEL_PUBID_LGPT1C0       
#define EVTSVT_PUB_LGPT0_ADC     EVTSVT_CPUIRQ0SEL_PUBID_LGPT0_ADC     
#define EVTSVT_PUB_LGPT0_DMA     EVTSVT_CPUIRQ0SEL_PUBID_LGPT0_DMA     
#define EVTSVT_PUB_LGPT0C2       EVTSVT_CPUIRQ0SEL_PUBID_LGPT0C2       
#define EVTSVT_PUB_LGPT0C1       EVTSVT_CPUIRQ0SEL_PUBID_LGPT0C1       
#define EVTSVT_PUB_LGPT0C0       EVTSVT_CPUIRQ0SEL_PUBID_LGPT0C0       
#define EVTSVT_PUB_SYSTIM4       EVTSVT_CPUIRQ0SEL_PUBID_SYSTIM4       
#define EVTSVT_PUB_SYSTIM3       EVTSVT_CPUIRQ0SEL_PUBID_SYSTIM3       
#define EVTSVT_PUB_SYSTIM2       EVTSVT_CPUIRQ0SEL_PUBID_SYSTIM2       
#define EVTSVT_PUB_SYSTIM1       EVTSVT_CPUIRQ0SEL_PUBID_SYSTIM1       
#define EVTSVT_PUB_SYSTIM0       EVTSVT_CPUIRQ0SEL_PUBID_SYSTIM0       
#define EVTSVT_PUB_SYSTIM_LT     EVTSVT_CPUIRQ0SEL_PUBID_SYSTIM_LT     
#define EVTSVT_PUB_SYSTIM_HB     EVTSVT_CPUIRQ0SEL_PUBID_SYSTIM_HB     
#define EVTSVT_PUB_I2C0_IRQ      EVTSVT_CPUIRQ0SEL_PUBID_I2C0_IRQ      
#define EVTSVT_PUB_UART0_COMB    EVTSVT_CPUIRQ0SEL_PUBID_UART0_COMB    
#define EVTSVT_PUB_AES_COMB      EVTSVT_CPUIRQ0SEL_PUBID_AES_COMB      
#define EVTSVT_PUB_DMA_ERR       EVTSVT_CPUIRQ0SEL_PUBID_DMA_ERR       
#define EVTSVT_PUB_DMA_DONE_COMB EVTSVT_CPUIRQ0SEL_PUBID_DMA_DONE_COMB 
#define EVTSVT_PUB_LGPT1_COMB    EVTSVT_CPUIRQ0SEL_PUBID_LGPT1_COMB    
#define EVTSVT_PUB_LGPT0_COMB    EVTSVT_CPUIRQ0SEL_PUBID_LGPT0_COMB    
#define EVTSVT_PUB_ADC_EVT       EVTSVT_CPUIRQ0SEL_PUBID_ADC_EVT       
#define EVTSVT_PUB_ADC_COMB      EVTSVT_CPUIRQ0SEL_PUBID_ADC_COMB      
#define EVTSVT_PUB_SPI0_COMB     EVTSVT_CPUIRQ0SEL_PUBID_SPI0_COMB     
#define EVTSVT_PUB_LRFD_IRQ2     EVTSVT_CPUIRQ0SEL_PUBID_LRFD_IRQ2     
#define EVTSVT_PUB_LRFD_IRQ1     EVTSVT_CPUIRQ0SEL_PUBID_LRFD_IRQ1     
#define EVTSVT_PUB_LRFD_IRQ0     EVTSVT_CPUIRQ0SEL_PUBID_LRFD_IRQ0     
#define EVTSVT_PUB_FLASH_IRQ     EVTSVT_CPUIRQ0SEL_PUBID_FLASH_IRQ     
#define EVTSVT_PUB_GPIO_EVT      EVTSVT_CPUIRQ0SEL_PUBID_GPIO_EVT      
#define EVTSVT_PUB_GPIO_COMB     EVTSVT_CPUIRQ0SEL_PUBID_GPIO_COMB     
#define EVTSVT_PUB_SYSTIM_COMB   EVTSVT_CPUIRQ0SEL_PUBID_SYSTIM_COMB   
#define EVTSVT_PUB_AON_IOC_COMB  EVTSVT_CPUIRQ0SEL_PUBID_AON_IOC_COMB  
#define EVTSVT_PUB_AON_LPMCMP_IRQ \
    EVTSVT_CPUIRQ0SEL_PUBID_AON_LPMCMP_IRQ                           
#define EVTSVT_PUB_AON_DBG_COMB EVTSVT_CPUIRQ0SEL_PUBID_AON_DBG_COMB 
#define EVTSVT_PUB_AON_RTC_COMB EVTSVT_CPUIRQ0SEL_PUBID_AON_RTC_COMB 
#define EVTSVT_PUB_AON_CKM_COMB \
    EVTSVT_CPUIRQ0SEL_PUBID_AON_CKM_COMB 
#define EVTSVT_PUB_AON_PMU_COMB \
    EVTSVT_CPUIRQ0SEL_PUBID_AON_PMU_COMB             
#define EVTSVT_PUB_NONE EVTSVT_CPUIRQ0SEL_PUBID_NONE 

//*****************************************************************************
//
// Helper defines used for range checking
//
//*****************************************************************************
#define EVTSVT_IPID_MAX_VAL EVTSVT_DMA_TRIG_UART1RXTRG

#define EVTSVT_PUBID_MAX_VAL EVTSVT_PUB_SYSTIM5

#define EVTSVT_DMA_CH_MAX_VAL EVTSVT_DMA_CH9
#define EVTSVT_DMA_CH_MIN_VAL EVTSVT_DMA_CH0

#define EVTSVT_SUB_MAX_VAL EVTSVT_SUB_I2SSTMP
#define EVTSVT_SUB_MIN_VAL EVTSVT_SUB_CPUIRQ0

//*****************************************************************************
//
// API Functions and prototypes
//
//*****************************************************************************

#ifndef DRIVERLIB_NS
//*****************************************************************************
//
// Below functions will only be compiled into the driverlib.a library and not
// the driverlib_ns.a library.
// Non-secure applications might be able to access some/all of these functions
// through veneers declared further below in the #else case.
//
//*****************************************************************************

//*****************************************************************************
//
//
//*****************************************************************************
extern void EVTSVTConfigureDma(uint32_t channel, uint32_t id);

//*****************************************************************************
//
//
//*****************************************************************************
extern void EVTSVTConfigureEvent(uint32_t subscriber, uint32_t pubId);

#else
//*****************************************************************************
//
// Secure-only API functions available from non-secure context through
// veneers.
//
// These functions must be linked in from from the secure veneer library.
//
//*****************************************************************************

extern void EVTSVTConfigureDma_veneer(uint32_t channel, uint32_t id);
    #define EVTSVTConfigureDma   EVTSVTConfigureDma_veneer

extern void EVTSVTConfigureEvent_veneer(uint32_t subscriber, uint32_t pubId);
    #define EVTSVTConfigureEvent EVTSVTConfigureEvent_veneer
#endif

//*****************************************************************************
//
// Mark the end of the C bindings section for C++ compilers.
//
//*****************************************************************************
#ifdef __cplusplus
}
#endif

//*****************************************************************************
//
//
//*****************************************************************************

#endif //  __EVTSVT_H__