timer.h

Go to the documentation of this file.

/* --COPYRIGHT--,BSD
 * Copyright (c) 2015, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  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.
 *
 * *  Neither the name of Texas Instruments Incorporated 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 OWNER 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.
 * --/COPYRIGHT--*/
#ifndef _TIMER_H_
#define _TIMER_H_


// **************************************************************************
// the includes

#include "sw/modules/types/src/types.h"




#ifdef __cplusplus
extern "C" {
#endif


// **************************************************************************
// the defines


#define  TIMER0_BASE_ADDR                (0x00000C00)

#define  TIMER1_BASE_ADDR                (0x00000C08)

#define  TIMER2_BASE_ADDR                (0x00000C10)


#define  TIMER_TCR_TSS_BITS               (1 << 4)

#define  TIMER_TCR_TRB_BITS               (1 << 5)

#define  TIMER_TCR_FREESOFT_BITS          (3 << 10)

#define  TIMER_TCR_TIE_BITS               (1 << 14)

#define  TIMER_TCR_TIF_BITS               (1 << 15)


// **************************************************************************
// the typedefs


typedef enum
{
  TIMER_EmulationMode_StopAfterNextDecrement=(0 << 10),  
  TIMER_EmulationMode_StopAtZero=(1 << 10),              
  TIMER_EmulationMode_RunFree=(2 << 10)                  
} TIMER_EmulationMode_e;


typedef enum
{
  TIMER_Status_CntIsNotZero=(0 << 15),  
  TIMER_Status_CntIsZero=(1 << 15)      
} TIMER_Status_e;


typedef struct _TIMER_Obj_
{
    volatile uint32_t  TIM;    
    volatile uint32_t  PRD;    
    volatile uint16_t  TCR;    
    volatile uint16_t  resvd_1;
    volatile uint32_t  TPR;    
} TIMER_Obj;


typedef struct _TIMER_Obj_ *TIMER_Handle;


// **************************************************************************
// the globals


// **************************************************************************
// the function prototypes


extern void TIMER_clearFlag(TIMER_Handle timerHandle);


extern void TIMER_disableInt(TIMER_Handle timerHandle);


extern void TIMER_enableInt(TIMER_Handle timerHandle);


static inline uint32_t TIMER_getCount(TIMER_Handle timerHandle)
{
  TIMER_Obj *volatile timer = (TIMER_Obj *)timerHandle;


  // get the count
  uint32_t cnt = timer->TIM;

  return(cnt);
} // end of TIMER_getCount() function


extern TIMER_Status_e TIMER_getStatus(TIMER_Handle timerHandle);


extern TIMER_Handle TIMER_init(void *pMemory,const size_t numBytes);


static inline void TIMER_reload(TIMER_Handle timerHandle)
{
    TIMER_Obj *timer = (TIMER_Obj *)timerHandle;


    // clear the bits
    timer->TCR |= (uint16_t)TIMER_TCR_TRB_BITS;

    return;
} // end of TIMER_reload() function


extern void TIMER_setDecimationFactor(TIMER_Handle timerHandle,
                               const uint16_t decFactor);


extern void TIMER_setEmulationMode(TIMER_Handle timerHandle,
                            const TIMER_EmulationMode_e mode);


static inline uint32_t TIMER_getPeriod(TIMER_Handle timerHandle)
{
    TIMER_Obj *timer = (TIMER_Obj *)timerHandle;


    // get the period
    uint32_t period = timer->PRD;

    return(period);
} // end of TIMER_getPeriod() function


static inline void TIMER_setPeriod(TIMER_Handle timerHandle,
                                   const uint32_t period)
{
    TIMER_Obj *timer = (TIMER_Obj *)timerHandle;


    // set the bits
    timer->PRD = period;

    return;
} // end of TIMER_setPeriod() function


extern void TIMER_setPreScaler(TIMER_Handle timerHandle,
                        const uint16_t preScaler);


static inline void TIMER_start(TIMER_Handle timerHandle)
{
    TIMER_Obj *timer = (TIMER_Obj *)timerHandle;


    // clear the bits
    timer->TCR &= (~(uint16_t)TIMER_TCR_TSS_BITS);

    return;
} // end of TIMER_start() function


static inline void TIMER_stop(TIMER_Handle timerHandle)
{
    TIMER_Obj *timer = (TIMER_Obj *)timerHandle;


    // set the bits
    timer->TCR |= (uint16_t)TIMER_TCR_TSS_BITS;

    return;
} // end of TIMER_stop() function


#ifdef __cplusplus
}
#endif // extern "C"

#endif  // end of _TIMER_H_ definition