250 lines
6.8 KiB
C
250 lines
6.8 KiB
C
/*
|
|
* @brief LPC5410x RITimer driver
|
|
*
|
|
* @note
|
|
* Copyright(C) NXP Semiconductors, 2014
|
|
* All rights reserved.
|
|
*
|
|
* @par
|
|
* Software that is described herein is for illustrative purposes only
|
|
* which provides customers with programming information regarding the
|
|
* LPC products. This software is supplied "AS IS" without any warranties of
|
|
* any kind, and NXP Semiconductors and its licensor disclaim any and
|
|
* all warranties, express or implied, including all implied warranties of
|
|
* merchantability, fitness for a particular purpose and non-infringement of
|
|
* intellectual property rights. NXP Semiconductors assumes no responsibility
|
|
* or liability for the use of the software, conveys no license or rights under any
|
|
* patent, copyright, mask work right, or any other intellectual property rights in
|
|
* or to any products. NXP Semiconductors reserves the right to make changes
|
|
* in the software without notification. NXP Semiconductors also makes no
|
|
* representation or warranty that such application will be suitable for the
|
|
* specified use without further testing or modification.
|
|
*
|
|
* @par
|
|
* Permission to use, copy, modify, and distribute this software and its
|
|
* documentation is hereby granted, under NXP Semiconductors' and its
|
|
* licensor's relevant copyrights in the software, without fee, provided that it
|
|
* is used in conjunction with NXP Semiconductors microcontrollers. This
|
|
* copyright, permission, and disclaimer notice must appear in all copies of
|
|
* this code.
|
|
*/
|
|
|
|
#ifndef __RITIMER_5410X_H_
|
|
#define __RITIMER_5410X_H_
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/** @defgroup RITIMER_5410X CHIP: LPC5410x Repetitive Interrupt Timer driver
|
|
* @ingroup CHIP_5410X_DRIVERS
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @brief Repetitive Interrupt Timer register block structure
|
|
*/
|
|
typedef struct { /*!< RITIMER Structure */
|
|
__IO uint32_t COMPVAL; /*!< Compare register */
|
|
__IO uint32_t MASK; /*!< Mask register */
|
|
__IO uint32_t CTRL; /*!< Control register */
|
|
__IO uint32_t COUNTER; /*!< 32-bit counter */
|
|
__IO uint32_t COMPVAL_H; /*!< Compare register, upper 16-bits */
|
|
__IO uint32_t MASK_H; /*!< Compare register, upper 16-bits */
|
|
__I uint32_t reserved;
|
|
__IO uint32_t COUNTER_H; /*!< Counter register, upper 16-bits */
|
|
} LPC_RITIMER_T;
|
|
|
|
/*
|
|
* @brief RITIMER register support bitfields and mask
|
|
*/
|
|
|
|
/*
|
|
* RIT control register
|
|
*/
|
|
/** Set by H/W when the counter value equals the masked compare value */
|
|
#define RIT_CTRL_INT ((uint32_t) (1))
|
|
/** Set timer enable clear to 0 when the counter value equals the masked compare value */
|
|
#define RIT_CTRL_ENCLR ((uint32_t) _BIT(1))
|
|
/** Set timer enable on debug */
|
|
#define RIT_CTRL_ENBR ((uint32_t) _BIT(2))
|
|
/** Set timer enable */
|
|
#define RIT_CTRL_TEN ((uint32_t) _BIT(3))
|
|
|
|
/**
|
|
* @brief Initialize the RIT
|
|
* @param pRITimer : RITimer peripheral selected
|
|
* @return None
|
|
*/
|
|
void Chip_RIT_Init(LPC_RITIMER_T *pRITimer);
|
|
|
|
/**
|
|
* @brief Shutdown the RIT
|
|
* @param pRITimer : RITimer peripheral selected
|
|
* @return None
|
|
*/
|
|
void Chip_RIT_DeInit(LPC_RITIMER_T *pRITimer);
|
|
|
|
/**
|
|
* @brief Enable Timer
|
|
* @param pRITimer : RITimer peripheral selected
|
|
* @return None
|
|
*/
|
|
STATIC INLINE void Chip_RIT_Enable(LPC_RITIMER_T *pRITimer)
|
|
{
|
|
pRITimer->CTRL |= RIT_CTRL_TEN;
|
|
}
|
|
|
|
/**
|
|
* @brief Disable Timer
|
|
* @param pRITimer : RITimer peripheral selected
|
|
* @return None
|
|
*/
|
|
STATIC INLINE void Chip_RIT_Disable(LPC_RITIMER_T *pRITimer)
|
|
{
|
|
pRITimer->CTRL &= ~RIT_CTRL_TEN;
|
|
}
|
|
|
|
/**
|
|
* @brief Enable timer debug
|
|
* @param pRITimer : RITimer peripheral selected
|
|
* @return None
|
|
*/
|
|
STATIC INLINE void Chip_RIT_DebugEnable(LPC_RITIMER_T *pRITimer)
|
|
{
|
|
pRITimer->CTRL |= RIT_CTRL_ENBR;
|
|
}
|
|
|
|
/**
|
|
* @brief Disable timer debug
|
|
* @param pRITimer : RITimer peripheral selected
|
|
* @return None
|
|
*/
|
|
STATIC INLINE void Chip_RIT_DebugDisable(LPC_RITIMER_T *pRITimer)
|
|
{
|
|
pRITimer->CTRL &= ~RIT_CTRL_ENBR;
|
|
}
|
|
|
|
/**
|
|
* @brief Enable clear on compare match
|
|
* @param pRITimer : RITimer peripheral selected
|
|
* @return None
|
|
*/
|
|
STATIC INLINE void Chip_RIT_CompClearEnable(LPC_RITIMER_T *pRITimer)
|
|
{
|
|
pRITimer->CTRL |= RIT_CTRL_ENCLR;
|
|
}
|
|
|
|
/**
|
|
* @brief Disable clear on compare match
|
|
* @param pRITimer : RITimer peripheral selected
|
|
* @return None
|
|
*/
|
|
STATIC INLINE void Chip_RIT_CompClearDisable(LPC_RITIMER_T *pRITimer)
|
|
{
|
|
pRITimer->CTRL &= ~RIT_CTRL_ENCLR;
|
|
}
|
|
|
|
/**
|
|
* @brief Check whether interrupt flag is set or not
|
|
* @param pRITimer : RITimer peripheral selected
|
|
* @return Current interrupt status, either ET or UNSET
|
|
*/
|
|
IntStatus Chip_RIT_GetIntStatus(LPC_RITIMER_T *pRITimer);
|
|
|
|
/**
|
|
* @brief Set a tick value for the interrupt to time out
|
|
* @param pRITimer : RITimer peripheral selected
|
|
* @param val : value (in ticks) of the interrupt to be set
|
|
* @return None
|
|
*/
|
|
STATIC INLINE void Chip_RIT_SetCOMPVAL(LPC_RITIMER_T *pRITimer, uint32_t val)
|
|
{
|
|
pRITimer->COMPVAL = val;
|
|
pRITimer->COMPVAL_H = 0;
|
|
}
|
|
|
|
/**
|
|
* @brief Set a tick value for the interrupt to time out (48-bits)
|
|
* @param pRITimer : RITimer peripheral selected
|
|
* @param val : value (in ticks) of the interrupt to be set, 48-bits max
|
|
* @return None
|
|
*/
|
|
STATIC INLINE void Chip_RIT_SetCOMPVAL64(LPC_RITIMER_T *pRITimer, uint64_t val)
|
|
{
|
|
pRITimer->COMPVAL = (uint32_t) (val & 0xFFFFFFFF);
|
|
pRITimer->COMPVAL_H = (uint32_t) ((val >> 32) & 0xFFFF);
|
|
}
|
|
|
|
/**
|
|
* @brief Enables or clears the RIT or interrupt
|
|
* @param pRITimer : RITimer peripheral selected
|
|
* @param val : RIT to be set, one or more RIT_CTRL_* values
|
|
* @return None
|
|
*/
|
|
STATIC INLINE void Chip_RIT_EnableCTRL(LPC_RITIMER_T *pRITimer, uint32_t val)
|
|
{
|
|
pRITimer->CTRL |= val;
|
|
}
|
|
|
|
/**
|
|
* @brief Clears the RIT interrupt
|
|
* @param pRITimer : RITimer peripheral selected
|
|
* @return None
|
|
*/
|
|
STATIC INLINE void Chip_RIT_ClearInt(LPC_RITIMER_T *pRITimer)
|
|
{
|
|
pRITimer->CTRL |= RIT_CTRL_INT;
|
|
}
|
|
|
|
/**
|
|
* @brief Returns the current RIT Counter value
|
|
* @param pRITimer : RITimer peripheral selected
|
|
* @return the current timer counter value
|
|
*/
|
|
STATIC INLINE uint32_t Chip_RIT_GetCounter(LPC_RITIMER_T *pRITimer)
|
|
{
|
|
return pRITimer->COUNTER;
|
|
}
|
|
|
|
/**
|
|
* @brief Returns the current RIT Counter value (48-bit)
|
|
* @param pRITimer : RITimer peripheral selected
|
|
* @return the current timer counter value
|
|
*/
|
|
STATIC INLINE uint64_t Chip_RIT_GetCounter64(LPC_RITIMER_T *pRITimer)
|
|
{
|
|
uint64_t retVal;
|
|
|
|
retVal = (uint64_t) pRITimer->COUNTER;
|
|
retVal = retVal | (((uint64_t) pRITimer->COUNTER_H) << 32);
|
|
|
|
return retVal;
|
|
}
|
|
|
|
/**
|
|
* @brief Set timer interval value
|
|
* @param pRITimer : RITimer peripheral selected
|
|
* @param time_interval : timer interval value (ms)
|
|
* @return None
|
|
*/
|
|
void Chip_RIT_SetTimerInterval(LPC_RITIMER_T *pRITimer, uint32_t time_interval);
|
|
|
|
/**
|
|
* @brief Set timer interval value (48-bit)
|
|
* @param pRITimer : RITimer peripheral selected
|
|
* @param time_interval : timer interval value (ms)
|
|
* @return None
|
|
*/
|
|
void Chip_RIT_SetTimerInterval64(LPC_RITIMER_T *pRITimer, uint64_t time_interval);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __RITIMER_5410X_H_ */
|