path: root/bsp/lpc408x/Libraries/Drivers/source/lpc_timer.c

/**********************************************************************
* $Id$      lpc_timer.c         2011-06-02
*//**
* @file     lpc_timer.c
* @brief    Contains all functions support for Timer firmware library
*           on LPC
* @version  1.0
* @date     02. June. 2011
* @author   NXP MCU SW Application Team
* 
* Copyright(C) 2011, NXP Semiconductor
* All rights reserved.
*
***********************************************************************
* Software that is described herein is for illustrative purposes only
* which provides customers with programming information regarding the
* products. This software is supplied "AS IS" without any warranties.
* NXP Semiconductors assumes no responsibility or liability for the
* use of the software, conveys no license or title under any patent,
* copyright, or mask work right to the product. NXP Semiconductors
* reserves the right to make changes in the software without
* notification. NXP Semiconductors also make no representation or
* warranty that such application will be suitable for the specified
* use without further testing or modification.
* Permission to use, copy, modify, and distribute this software and its
* documentation is hereby granted, under NXP Semiconductors'
* relevant copyright 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.
**********************************************************************/

/* Peripheral group ----------------------------------------------------------- */
/** @addtogroup TIMER
 * @{
 */
#ifdef __BUILD_WITH_EXAMPLE__
#include "lpc_libcfg.h"
#else
#include "lpc_libcfg_default.h"
#endif /* __BUILD_WITH_EXAMPLE__ */
#ifdef _TIM

/* Includes ------------------------------------------------------------------- */
#include "lpc_timer.h"
#include "lpc_clkpwr.h"
#include "lpc_pinsel.h"

/* Private Functions ---------------------------------------------------------- */

static uint32_t getPClock (uint32_t timernum);
static uint32_t converUSecToVal (uint32_t timernum, uint32_t usec);
static int32_t converPtrToTimeNum (LPC_TIM_TypeDef *TIMx);


/*********************************************************************//**
 * @brief       Get peripheral clock of each timer controller
 * @param[in]   timernum Timer number
 * @return      Peripheral clock of timer
 **********************************************************************/
static uint32_t getPClock (uint32_t timernum)
{
    uint32_t clkdlycnt;
    clkdlycnt = CLKPWR_GetCLK(CLKPWR_CLKTYPE_PER);
    return clkdlycnt;
}


/*********************************************************************//**
 * @brief       Convert a time to a timer count value
 * @param[in]   timernum Timer number
 * @param[in]   usec Time in microseconds
 * @return      The number of required clock ticks to give the time delay
 **********************************************************************/
uint32_t converUSecToVal (uint32_t timernum, uint32_t usec)
{
    uint64_t clkdlycnt;

    // Get Pclock of timer
    clkdlycnt = (uint64_t) getPClock(timernum);

    clkdlycnt = (clkdlycnt * usec) / 1000000;
    return (uint32_t) clkdlycnt;
}


/*********************************************************************//**
 * @brief       Convert a timer register pointer to a timer number
 * @param[in]   TIMx Pointer to LPC_TIM_TypeDef, should be:
 *              - LPC_TIM0: TIMER0 peripheral
 *              - LPC_TIM1: TIMER1 peripheral
 *              - LPC_TIM2: TIMER2 peripheral
 *              - LPC_TIM3: TIMER3 peripheral
 * @return      The timer number (0 to 3) or -1 if register pointer is bad
 **********************************************************************/
int32_t converPtrToTimeNum (LPC_TIM_TypeDef *TIMx)
{
    int32_t tnum = -1;

    if (TIMx == LPC_TIM0)
    {
        tnum = 0;
    }
    else if (TIMx == LPC_TIM1)
    {
        tnum = 1;
    }
    else if (TIMx == LPC_TIM2)
    {
        tnum = 2;
    }
    else if (TIMx == LPC_TIM3)
    {
        tnum = 3;
    }

    return tnum;
}

/* End of Private Functions ---------------------------------------------------- */


/* Public Functions ----------------------------------------------------------- */
/** @addtogroup TIM_Public_Functions
 * @{
 */

/*********************************************************************//**
 * @brief       Get Interrupt Status
 * @param[in]   TIMx Timer selection, should be:
 *              - LPC_TIM0: TIMER0 peripheral
 *              - LPC_TIM1: TIMER1 peripheral
 *              - LPC_TIM2: TIMER2 peripheral
 *              - LPC_TIM3: TIMER3 peripheral
 * @param[in]   IntFlag Interrupt type, should be:
 *              - TIM_MR0_INT: Interrupt for Match channel 0
 *              - TIM_MR1_INT: Interrupt for Match channel 1
 *              - TIM_MR2_INT: Interrupt for Match channel 2
 *              - TIM_MR3_INT: Interrupt for Match channel 3
 *              - TIM_CR0_INT: Interrupt for Capture channel 0
 *              - TIM_CR1_INT: Interrupt for Capture channel 1
 * @return      Flag Status for required interrupt
 *              - SET : interrupt
 *              - RESET : no interrupt
 **********************************************************************/
FlagStatus TIM_GetIntStatus(LPC_TIM_TypeDef *TIMx, TIM_INT_TYPE IntFlag)
{
    uint8_t temp;
    temp = (TIMx->IR)& TIM_IR_CLR(IntFlag);
    if (temp)
        return SET;

    return RESET;

}
/*********************************************************************//**
 * @brief       Get Capture Interrupt Status
 * @param[in]   TIMx Timer selection, should be:
 *              - LPC_TIM0: TIMER0 peripheral
 *              - LPC_TIM1: TIMER1 peripheral
 *              - LPC_TIM2: TIMER2 peripheral
 *              - LPC_TIM3: TIMER3 peripheral
 * @param[in]   IntFlag: interrupt type, should be:
 *              - TIM_MR0_INT: Interrupt for Match channel 0
 *              - TIM_MR1_INT: Interrupt for Match channel 1
 *              - TIM_MR2_INT: Interrupt for Match channel 2
 *              - TIM_MR3_INT: Interrupt for Match channel 3
 *              - TIM_CR0_INT: Interrupt for Capture channel 0
 *              - TIM_CR1_INT: Interrupt for Capture channel 1
 * @return      FlagStatus
 *              - SET : interrupt
 *              - RESET : no interrupt
 **********************************************************************/
FlagStatus TIM_GetIntCaptureStatus(LPC_TIM_TypeDef *TIMx, TIM_INT_TYPE IntFlag)
{
    uint8_t temp;
    temp = (TIMx->IR) & (1<<(4+IntFlag));
    if(temp)
        return SET;
    return RESET;
}
/*********************************************************************//**
 * @brief       Clear Interrupt pending
 * @param[in]   TIMx Timer selection, should be:
 *              - LPC_TIM0: TIMER0 peripheral
 *              - LPC_TIM1: TIMER1 peripheral
 *              - LPC_TIM2: TIMER2 peripheral
 *              - LPC_TIM3: TIMER3 peripheral
 * @param[in]   IntFlag: interrupt type, should be:
 *              - TIM_MR0_INT: Interrupt for Match channel 0
 *              - TIM_MR1_INT: Interrupt for Match channel 1
 *              - TIM_MR2_INT: Interrupt for Match channel 2
 *              - TIM_MR3_INT: Interrupt for Match channel 3
 *              - TIM_CR0_INT: Interrupt for Capture channel 0
 *              - TIM_CR1_INT: Interrupt for Capture channel 1
 * @return      None
 **********************************************************************/
void TIM_ClearIntPending(LPC_TIM_TypeDef *TIMx, TIM_INT_TYPE IntFlag)
{
    TIMx->IR = TIM_IR_CLR(IntFlag);
}

/*********************************************************************//**
 * @brief       Clear Capture Interrupt pending
 * @param[in]   TIMx Timer selection, should be
 *              - LPC_TIM0: TIMER0 peripheral
 *              - LPC_TIM1: TIMER1 peripheral
 *              - LPC_TIM2: TIMER2 peripheral
 *              - LPC_TIM3: TIMER3 peripheral
 * @param[in]   IntFlag interrupt type, should be:
 *              - TIM_MR0_INT: Interrupt for Match channel 0
 *              - TIM_MR1_INT: Interrupt for Match channel 1
 *              - TIM_MR2_INT: Interrupt for Match channel 2
 *              - TIM_MR3_INT: Interrupt for Match channel 3
 *              - TIM_CR0_INT: Interrupt for Capture channel 0
 *              - TIM_CR1_INT: Interrupt for Capture channel 1
 * @return      None
 **********************************************************************/
void TIM_ClearIntCapturePending(LPC_TIM_TypeDef *TIMx, TIM_INT_TYPE IntFlag)
{
    TIMx->IR = (1<<(4+IntFlag));
}

/*********************************************************************//**
 * @brief       Configuration for Timer at initial time
 * @param[in]   TimerCounterMode timer counter mode, should be:
 *              - TIM_TIMER_MODE: Timer mode
 *              - TIM_COUNTER_RISING_MODE: Counter rising mode
 *              - TIM_COUNTER_FALLING_MODE: Counter falling mode
 *              - TIM_COUNTER_ANY_MODE:Counter on both edges
 * @param[in]   TIM_ConfigStruct pointer to TIM_TIMERCFG_Type or
 *              TIM_COUNTERCFG_Type
 * @return      None
 **********************************************************************/
void TIM_ConfigStructInit(TIM_MODE_OPT TimerCounterMode, void *TIM_ConfigStruct)
{
    if (TimerCounterMode == TIM_TIMER_MODE )
    {
        TIM_TIMERCFG_Type * pTimeCfg = (TIM_TIMERCFG_Type *)TIM_ConfigStruct;
        pTimeCfg->PrescaleOption = TIM_PRESCALE_USVAL;
        pTimeCfg->PrescaleValue = 1;
    }
    else
    {
        TIM_COUNTERCFG_Type * pCounterCfg = (TIM_COUNTERCFG_Type *)TIM_ConfigStruct;
        pCounterCfg->CountInputSelect = TIM_COUNTER_INCAP0;
    }
}

/*********************************************************************//**
 * @brief       Initial Timer/Counter device
 *                  Set Clock frequency for Timer
 *                  Set initial configuration for Timer
 * @param[in]   TIMx  Timer selection, should be:
 *              - LPC_TIM0: TIMER0 peripheral
 *              - LPC_TIM1: TIMER1 peripheral
 *              - LPC_TIM2: TIMER2 peripheral
 *              - LPC_TIM3: TIMER3 peripheral
 * @param[in]   TimerCounterMode Timer counter mode, should be:
 *              - TIM_TIMER_MODE: Timer mode
 *              - TIM_COUNTER_RISING_MODE: Counter rising mode
 *              - TIM_COUNTER_FALLING_MODE: Counter falling mode
 *              - TIM_COUNTER_ANY_MODE:Counter on both edges
 * @param[in]   TIM_ConfigStruct pointer to TIM_TIMERCFG_Type
 *              that contains the configuration information for the
 *                    specified Timer peripheral.
 * @return      None
 **********************************************************************/
void TIM_Init(LPC_TIM_TypeDef *TIMx, TIM_MODE_OPT TimerCounterMode, void *TIM_ConfigStruct)
{
    TIM_TIMERCFG_Type *pTimeCfg;
    TIM_COUNTERCFG_Type *pCounterCfg;

    //set power
    if (TIMx== LPC_TIM0)
    {
        CLKPWR_ConfigPPWR (CLKPWR_PCONP_PCTIM0, ENABLE);
    }
    else if (TIMx== LPC_TIM1)
    {
        CLKPWR_ConfigPPWR (CLKPWR_PCONP_PCTIM1, ENABLE);
    }

    else if (TIMx== LPC_TIM2)
    {
        CLKPWR_ConfigPPWR (CLKPWR_PCONP_PCTIM2, ENABLE);
    }
    else if (TIMx== LPC_TIM3)
    {
        CLKPWR_ConfigPPWR (CLKPWR_PCONP_PCTIM3, ENABLE);
    }

    TIMx->CTCR &= ~TIM_CTCR_MODE_MASK;
    TIMx->CTCR |= TIM_TIMER_MODE;

    TIMx->TC =0;
    TIMx->PC =0;
    TIMx->PR =0;
    TIMx->TCR |= (1<<1); //Reset Counter
    TIMx->TCR &= ~(1<<1); //release reset
    if (TimerCounterMode == TIM_TIMER_MODE )
    {
        pTimeCfg = (TIM_TIMERCFG_Type *)TIM_ConfigStruct;
        if (pTimeCfg->PrescaleOption  == TIM_PRESCALE_TICKVAL)
        {
            TIMx->PR   = pTimeCfg->PrescaleValue -1  ;
        }
        else
        {
            TIMx->PR   = converUSecToVal (converPtrToTimeNum(TIMx),pTimeCfg->PrescaleValue)-1;
        }
    }
    else
    {

        pCounterCfg = (TIM_COUNTERCFG_Type *)TIM_ConfigStruct;
        TIMx->CTCR  &= ~TIM_CTCR_INPUT_MASK;
        if (pCounterCfg->CountInputSelect == TIM_COUNTER_INCAP1)
            TIMx->CCR |= _BIT(2);
    }

    // Clear interrupt pending
    TIMx->IR = 0xFFFFFFFF;

}

/*********************************************************************//**
 * @brief       Close Timer/Counter device
 * @param[in]   TIMx  Pointer to timer device, should be:
 *              - LPC_TIM0: TIMER0 peripheral
 *              - LPC_TIM1: TIMER1 peripheral
 *              - LPC_TIM2: TIMER2 peripheral
 *              - LPC_TIM3: TIMER3 peripheral
 * @return      None
 **********************************************************************/
void TIM_DeInit (LPC_TIM_TypeDef *TIMx)
{
    // Disable timer/counter
    TIMx->TCR = 0x00;

    // Disable power
    if (TIMx== LPC_TIM0)
        CLKPWR_ConfigPPWR (CLKPWR_PCONP_PCTIM0, DISABLE);

    else if (TIMx== LPC_TIM1)
        CLKPWR_ConfigPPWR (CLKPWR_PCONP_PCTIM1, DISABLE);

    else if (TIMx== LPC_TIM2)
        CLKPWR_ConfigPPWR (CLKPWR_PCONP_PCTIM2, DISABLE);

    else if (TIMx== LPC_TIM3)
        CLKPWR_ConfigPPWR (CLKPWR_PCONP_PCTIM2, DISABLE);

}

/*********************************************************************//**
 * @brief       Start/Stop Timer/Counter device
 * @param[in]   TIMx Pointer to timer device, should be:
 *              - LPC_TIM0: TIMER0 peripheral
 *              - LPC_TIM1: TIMER1 peripheral
 *              - LPC_TIM2: TIMER2 peripheral
 *              - LPC_TIM3: TIMER3 peripheral
 * @param[in]   NewState
 *              -   ENABLE  : set timer enable
 *              -   DISABLE : disable timer
 * @return      None
 **********************************************************************/
void TIM_Cmd(LPC_TIM_TypeDef *TIMx, FunctionalState NewState)
{
    if (NewState == ENABLE)
    {
        TIMx->TCR   |=  TIM_ENABLE;
    }
    else
    {
        TIMx->TCR &= ~TIM_ENABLE;
    }
}

/*********************************************************************//**
 * @brief       Reset Timer/Counter device,
 *                  Make TC and PC are synchronously reset on the next
 *                  positive edge of PCLK
 * @param[in]   TIMx Pointer to timer device, should be:
 *              - LPC_TIM0: TIMER0 peripheral
 *              - LPC_TIM1: TIMER1 peripheral
 *              - LPC_TIM2: TIMER2 peripheral
 *              - LPC_TIM3: TIMER3 peripheral
 * @return      None
 **********************************************************************/
void TIM_ResetCounter(LPC_TIM_TypeDef *TIMx)
{
    TIMx->TCR |= TIM_RESET;
    TIMx->TCR &= ~TIM_RESET;
}

/*********************************************************************//**
 * @brief       Configuration for Match register
 * @param[in]   TIMx Pointer to timer device, should be:
 *              - LPC_TIM0: TIMER0 peripheral
 *              - LPC_TIM1: TIMER1 peripheral
 *              - LPC_TIM2: TIMER2 peripheral
 *              - LPC_TIM3: TIMER3 peripheral
 * @param[in]   TIM_MatchConfigStruct Pointer to TIM_MATCHCFG_Type
 *                  - MatchChannel : choose channel 0 or 1
 *                  - IntOnMatch     : if SET, interrupt will be generated when MRxx match
 *                                  the value in TC
 *                  - StopOnMatch    : if SET, TC and PC will be stopped whenM Rxx match
 *                                  the value in TC
 *                  - ResetOnMatch : if SET, Reset on MR0 when MRxx match
 *                                  the value in TC
 *                  -ExtMatchOutputType: Select output for external match
 *                       +   0: Do nothing for external output pin if match
 *                       +   1: Force external output pin to low if match
 *                       +   2: Force external output pin to high if match
 *                       +   3: Toggle external output pin if match
 *                  MatchValue: Set the value to be compared with TC value
 * @return      None
 **********************************************************************/
void TIM_ConfigMatch(LPC_TIM_TypeDef *TIMx, TIM_MATCHCFG_Type *TIM_MatchConfigStruct)
{
    switch(TIM_MatchConfigStruct->MatchChannel)
    {
    case 0:
        TIMx->MR0 = TIM_MatchConfigStruct->MatchValue;
        break;
    case 1:
        TIMx->MR1 = TIM_MatchConfigStruct->MatchValue;
        break;
    case 2:
        TIMx->MR2 = TIM_MatchConfigStruct->MatchValue;
        break;
    case 3:
        TIMx->MR3 = TIM_MatchConfigStruct->MatchValue;
        break;
    default:
        //Error match value
        //Error loop
        while(1);
    }
    //interrupt on MRn
    TIMx->MCR &= ~ TIM_MCR_CHANNEL_MASKBIT(TIM_MatchConfigStruct->MatchChannel);

    if (TIM_MatchConfigStruct->IntOnMatch)
        TIMx->MCR |= TIM_INT_ON_MATCH(TIM_MatchConfigStruct->MatchChannel);

    //reset on MRn
    if (TIM_MatchConfigStruct->ResetOnMatch)
        TIMx->MCR |= TIM_RESET_ON_MATCH(TIM_MatchConfigStruct->MatchChannel);

    //stop on MRn
    if (TIM_MatchConfigStruct->StopOnMatch)
        TIMx->MCR |= TIM_STOP_ON_MATCH(TIM_MatchConfigStruct->MatchChannel);

    // match output type

    TIMx->EMR   &= ~ TIM_EM_MASK(TIM_MatchConfigStruct->MatchChannel);
    TIMx->EMR   |= TIM_EM_SET(TIM_MatchConfigStruct->MatchChannel,TIM_MatchConfigStruct->ExtMatchOutputType);
}
/*********************************************************************//**
 * @brief       Update Match value
 * @param[in]   TIMx Pointer to timer device, should be:
 *              - LPC_TIM0: TIMER0 peripheral
 *              - LPC_TIM1: TIMER1 peripheral
 *              - LPC_TIM2: TIMER2 peripheral
 *              - LPC_TIM3: TIMER3 peripheral
 * @param[in]   MatchChannel    Match channel, should be: 0..3
 * @param[in]   MatchValue      updated match value
 * @return      None
 **********************************************************************/
void TIM_UpdateMatchValue(LPC_TIM_TypeDef *TIMx,uint8_t MatchChannel, uint32_t MatchValue)
{
    switch(MatchChannel)
    {
    case 0:
        TIMx->MR0 = MatchValue;
        break;
    case 1:
        TIMx->MR1 = MatchValue;
        break;
    case 2:
        TIMx->MR2 = MatchValue;
        break;
    case 3:
        TIMx->MR3 = MatchValue;
        break;
    default:
        //Error Loop
        while(1);
    }
}

/*********************************************************************//**
 * @brief       Configuration for Capture register
 * @param[in]   TIMx Pointer to timer device, should be:
 *              - LPC_TIM0: TIMER0 peripheral
 *              - LPC_TIM1: TIMER1 peripheral
 *              - LPC_TIM2: TIMER2 peripheral
 *              - LPC_TIM3: TIMER3 peripheral
 * @param[in]   TIM_CaptureConfigStruct Pointer to TIM_CAPTURECFG_Type
 *              - CaptureChannel: set the channel to capture data
 *              - RisingEdge    : if SET, Capture at rising edge
 *              - FallingEdge   : if SET, Capture at falling edge
 *              - IntOnCaption  : if SET, Capture generate interrupt 
 * @return      None
 **********************************************************************/
void TIM_ConfigCapture(LPC_TIM_TypeDef *TIMx, TIM_CAPTURECFG_Type *TIM_CaptureConfigStruct)
{
    TIMx->CCR &= ~TIM_CCR_CHANNEL_MASKBIT(TIM_CaptureConfigStruct->CaptureChannel);

    if (TIM_CaptureConfigStruct->RisingEdge)
        TIMx->CCR |= TIM_CAP_RISING(TIM_CaptureConfigStruct->CaptureChannel);

    if (TIM_CaptureConfigStruct->FallingEdge)
        TIMx->CCR |= TIM_CAP_FALLING(TIM_CaptureConfigStruct->CaptureChannel);

    if (TIM_CaptureConfigStruct->IntOnCaption)
        TIMx->CCR |= TIM_INT_ON_CAP(TIM_CaptureConfigStruct->CaptureChannel);
}

/*********************************************************************//**
 * @brief       Read value of capture register in timer/counter device
 * @param[in]   TIMx Pointer to timer/counter device, should be:
 *              - LPC_TIM0: TIMER0 peripheral
 *              - LPC_TIM1: TIMER1 peripheral
 *              - LPC_TIM2: TIMER2 peripheral
 *              - LPC_TIM3: TIMER3 peripheral
 * @param[in]   CaptureChannel: capture channel number, should be:
 *              - TIM_COUNTER_INCAP0: CAPn.0 input pin for TIMERn
 *              - TIM_COUNTER_INCAP1: CAPn.1 input pin for TIMERn
 * @return      Value of capture register
 **********************************************************************/
uint32_t TIM_GetCaptureValue(LPC_TIM_TypeDef *TIMx, TIM_COUNTER_INPUT_OPT CaptureChannel)
{
    if(CaptureChannel==0)
        return TIMx->CR0;
    else
        return TIMx->CR1;
}

/*---------------Advanced TIMER functions -----------------------------------------*/
/*********************************************************************//**
 * @brief       Timer wait (microseconds)
 * @param[in]   time    number of microseconds waiting
 * @return      None
 **********************************************************************/
void TIM_Waitus(uint32_t time)
{
    TIM_MATCHCFG_Type MatchConfigStruct;
    LPC_TIM0->IR = 0xFFFFFFFF;

    MatchConfigStruct.MatchChannel = 0;
    MatchConfigStruct.IntOnMatch = ENABLE;
    MatchConfigStruct.ResetOnMatch = ENABLE;
    MatchConfigStruct.StopOnMatch = ENABLE;
    MatchConfigStruct.ExtMatchOutputType = 0;
    MatchConfigStruct.MatchValue = time;

    TIM_ConfigMatch(LPC_TIM0, &MatchConfigStruct);
    TIM_Cmd(LPC_TIM0,ENABLE);
    //wait until interrupt flag occur
    while(!(LPC_TIM0->IR & 0x01));
    TIM_ResetCounter(LPC_TIM0);
}
/*********************************************************************//**
 * @brief       Timer wait (milliseconds)
 * @param[in]   time    number of millisecond waiting
 * @return      None
 **********************************************************************/
void TIM_Waitms(uint32_t time)
{
    TIM_Waitus(time * 1000);
}
/**
 * @}
 */
#endif /*_TIM*/
/**
 * @}
 */

/* --------------------------------- End Of File ------------------------------ */