systick.h

Go to the documentation of this file.

/******************************************************************************
 *  Filename:       systick.h
 *
 *  Description:    Prototypes for the SysTick driver.
 *
 *  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:
 *
 *  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 __SYSTICK_H__
#define __SYSTICK_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_types.h"
#include "../inc/hw_ints.h"
#include "../inc/hw_memmap.h"
#include "../inc/hw_systick.h"
#include "debug.h"
#include "interrupt.h"

//*****************************************************************************
//
// API Functions and Prototypes
//
//*****************************************************************************

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void SysTickEnable(void)
{
    // Enable SysTick.
    HWREG(SYSTICK_BASE + SYSTICK_O_CSR) |= (SYSTICK_CSR_CLKSOURCE | SYSTICK_CSR_ENABLE);
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void SysTickDisable(void)
{
    // Disable SysTick.
    HWREG(SYSTICK_BASE + SYSTICK_O_CSR) &= ~(SYSTICK_CSR_ENABLE);
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void SysTickRegisterInt(void (*pfnHandler)(void))
{
    // Register the interrupt handler, returning an error if an error occurs.
    IntRegister(INT_SYSTICK, pfnHandler);

    // Enable the SysTick interrupt.
    HWREG(SYSTICK_BASE + SYSTICK_O_CSR) |= SYSTICK_CSR_TICKINT;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void SysTickUnregisterInt(void)
{
    // Disable the SysTick interrupt.
    HWREG(SYSTICK_BASE + SYSTICK_O_CSR) &= ~(SYSTICK_CSR_TICKINT);

    // Unregister the interrupt handler.
    IntUnregister(INT_SYSTICK);
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void SysTickEnableInt(void)
{
    // Enable the SysTick interrupt.
    HWREG(SYSTICK_BASE + SYSTICK_O_CSR) |= SYSTICK_CSR_TICKINT;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE void SysTickDisableInt(void)
{
    // Disable the SysTick interrupt.
    HWREG(SYSTICK_BASE + SYSTICK_O_CSR) &= ~(SYSTICK_CSR_TICKINT);
}

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

//
//*****************************************************************************
__STATIC_INLINE void SysTickSetPeriod(uint32_t period)
{
    // Check the arguments.
    ASSERT((period > 0) && (period <= 16777216));

    // Set the period of the SysTick counter.
    HWREG(SYSTICK_BASE + SYSTICK_O_RVR) = period - 1;
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE uint32_t SysTickGetPeriod(void)
{
    // Return the period of the SysTick counter.
    return (HWREG(SYSTICK_BASE + SYSTICK_O_RVR) + 1);
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE uint32_t SysTickGetValue(void)
{
    // Return the current value of the SysTick counter.
    return (HWREG(SYSTICK_BASE + SYSTICK_O_CVR));
}

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

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

#endif // __SYSTICK_H__