interrupt.h

Go to the documentation of this file.

/******************************************************************************
 *  Filename:       interrupt.h
 *
 *  Description:    Defines and prototypes for the NVIC Interrupt Controller
 *
 *  Copyright (c) 2022-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 __INTERRUPT_H__
#define __INTERRUPT_H__

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

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

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

#include "../inc/hw_ints.h"
#include "../inc/hw_types.h"

#include "../cmsis/cc35xx.h"
#include "../cmsis/core/core_cm33.h"

#include "cpu.h"

//*****************************************************************************
//
// Macro to generate an interrupt priority mask based on the number of bits
// of priority supported by the hardware. For CC35XX the number of priority
// bit is 3 as defined in <tt>hw_ints.h</tt>. The priority mask is
// defined as
//
// INT_PRIORITY_MASK = ((0xFF << (8 - NUM_PRIORITY_BITS)) & 0xFF)
//
//*****************************************************************************
#define INT_PRIORITY_MASK 0x000000F0
#define INT_PRI_LEVEL0    0x00000000
#define INT_PRI_LEVEL1    0x00000010
#define INT_PRI_LEVEL2    0x00000020
#define INT_PRI_LEVEL3    0x00000030
#define INT_PRI_LEVEL4    0x00000040
#define INT_PRI_LEVEL5    0x00000050
#define INT_PRI_LEVEL6    0x00000060
#define INT_PRI_LEVEL7    0x00000070
#define INT_PRI_LEVEL8    0x00000080
#define INT_PRI_LEVEL9    0x00000090
#define INT_PRI_LEVEL10   0x000000A0
#define INT_PRI_LEVEL11   0x000000B0
#define INT_PRI_LEVEL12   0x000000C0
#define INT_PRI_LEVEL13   0x000000D0
#define INT_PRI_LEVEL14   0x000000E0
#define INT_PRI_LEVEL15   0x000000F0

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

//*****************************************************************************
//
//
//*****************************************************************************
extern void IntRegister(uint32_t intNum, void (*handler)(void));

//*****************************************************************************
//
//
//*****************************************************************************
extern void IntUnregister(uint32_t intNum);

//*****************************************************************************
//
//
//*****************************************************************************
extern void IntSetPriority(uint32_t intNum, uint8_t priority);

//*****************************************************************************
//
//
//*****************************************************************************
extern int32_t IntGetPriority(uint32_t intNum);

//*****************************************************************************
//
//
//*****************************************************************************
extern void IntEnable(uint32_t intNum);

//*****************************************************************************
//
//
//*****************************************************************************
extern void IntDisable(uint32_t intNum);

//*****************************************************************************
//
//
//*****************************************************************************
extern void IntSetPend(uint32_t intNum);

//*****************************************************************************
//
//
//*****************************************************************************
extern bool IntGetPend(uint32_t intNum);

//*****************************************************************************
//
//
//*****************************************************************************
extern void IntClearPend(uint32_t intNum);

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE bool IntEnableMaster(void)
{
    uint32_t interruptsDisabled = __get_PRIMASK();
    // Enable CPU interrupts.
    __enable_irq();
    return (interruptsDisabled);
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE bool IntDisableMaster(void)
{
    uint32_t interruptsDisabled = __get_PRIMASK();
    // Disable CPU interrupts.
    __disable_irq();
    return (interruptsDisabled);
}

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

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

#endif // __INTERRUPT_H__