include/pic24_timer.h

Go to the documentation of this file.

/* Standard copyright does not go in this file because
* of the use of Microchip provided macros, see comments below.
*/
// Documentation for this file. If the \file tag isn't present,
// this file won't be documented.
#ifndef  _PIC24_TIMER_H_
#define _PIC24_TIMER_H_

#define getTimerPrescale(TxCONbits) getTimerPrescaleBits(TxCONbits.TCKPS)

#define MS_TO_TICKS(ms, pre) ((FCY/1000L/(pre))*ms)
uint16 msToU16Ticks(uint16 u16_ms, uint16 u16_pre);
uint16 usToU16Ticks(uint16 u16_us, uint16 u16_pre);
uint32 usToU32Ticks(uint32 u32_us, uint16 u16_pre);
uint16 getTimerPrescaleBits(uint8 u8_TCKPS);
uint32 ticksToMs (uint32 u32_ticks, uint16 u16_tmrPre);
uint32 ticksToUs (uint32 u32_ticks, uint16 u16_tmrPre);
uint32 ticksToNs (uint32 u32_ticks, uint16 u16_tmrPre);
uint32 computeDeltaTicksLong(uint16 u16_start, uint16 u16_end, uint16 u16_tmrPR, uint16 u16_oflows);
uint16 computeDeltaTicks(uint16 u16_start, uint16 u16_end, uint16 u16_tmrPR);
int32 roundFloatToUint32(float f_x);
int16 roundFloatToUint16(float f_x);

/*
The following macros are a subset of the AND/OR macros found in the
the MPLAB C30/src/peripheral_24F/timer.h file and placed
in this header for use solely and exclusively on Microchip
PICmicro Microcontroller products as
specified in the MPLAB C30/src/peripheral_24F/timer.h header.

Edits have been made in the comments to correct some
minor typos.
*/

/* T1CON: TIMER1 CONTROL REGISTER */
#define T1_ON               0x8000 /* Timer1 ON */
#define T1_OFF              0x0000 /* Timer1 OFF */
#define T1_OFF_ON_MASK      (~T1_ON)

#define T1_IDLE_STOP        0x2000 /* stop operation during sleep */
#define T1_IDLE_CON         0x0000 /* operate during sleep */
#define T1_IDLE_MASK        (~T1_IDLE_STOP)

#define T1_GATE_ON          0x0040 /* Timer Gate time accumulation enabled */
#define T1_GATE_OFF         0x0000 /* Timer Gate time accumulation disabled */
#define T1_GATE_MASK        (~T1_GATE_ON)

#define T1_PS_1_1           0x0000 /* Prescaler 1:1 */
#define T1_PS_1_8           0x0010 /*           1:8 */
#define T1_PS_1_64          0x0020 /*          1:64 */
#define T1_PS_1_256         0x0030 /*         1:256 */
#define T1_PS_MASK          (~T1_PS_1_256)

#define T1_SYNC_EXT_ON      0x0004 /* Synch external clk input */
#define T1_SYNC_EXT_OFF     0x0000 /* Do not synch external clk input */
#define T1_SYNC_EXT_MASK    (~T1_SYNC_EXT_ON)

#define T1_SOURCE_EXT       0x0002 /* External clock source */
#define T1_SOURCE_INT       0x0000 /* Internal clock source */
#define T1_SOURCE_MASK      (~T1_SOURCE_EXT)

#ifdef _T2IF
/* T2CON: TIMER2 CONTROL REGISTER */
#define T2_ON               0x8000      /* Timer2 ON */
#define T2_OFF              0x0000      /* Timer2 OFF */
#define T2_OFF_ON_MASK      (~T2_ON)

#define T2_IDLE_STOP        0x2000 /* stop operation during sleep */
#define T2_IDLE_CON         0x0000 /* operate during sleep */
#define T2_IDLE_MASK        (~T2_IDLE_STOP)

#define T2_GATE_ON          0x0040 /* Timer Gate time accumulation enabled */
#define T2_GATE_OFF         0x0000 /* Timer Gate time accumulation disabled */
#define T2_GATE_MASK        (~T2_GATE_ON)

#define T2_PS_1_1           0x0000      /* Prescaler 1:1 */
#define T2_PS_1_8           0x0010      /*           1:8 */
#define T2_PS_1_64          0x0020      /*          1:64 */
#define T2_PS_1_256         0x0030      /*         1:256 */
#define T2_PS_MASK          (~T2_PS_1_256)

#define T2_32BIT_MODE_ON    0x0008      /* Timer 2 and Timer 3 form a 32 bit Timer */
#define T2_32BIT_MODE_OFF   0x0000
#define T2_32BIT_MODE_MASK   (~T2_32BIT_MODE_ON)

#define T2_SOURCE_EXT       0x0002 /* External clock source */
#define T2_SOURCE_INT       0x0000 /* Internal clock source */
#define T2_SOURCE_MASK      (~T2_SOURCE_EXT)
#endif

#ifdef _T3IF
/* T3CON: TIMER3 CONTROL REGISTER */
#define T3_ON               0x8000      /* Timer3 ON */
#define T3_OFF              0x0000      /* Timer3 OFF */
#define T3_OFF_ON_MASK      (~T3_ON)

#define T3_IDLE_STOP        0x2000 /* operate during sleep */
#define T3_IDLE_CON         0x0000 /* stop operation during sleep */
#define T3_IDLE_MASK        (~T3_IDLE_STOP)

#define T3_GATE_ON          0x0040 /* Timer Gate time accumulation enabled */
#define T3_GATE_OFF         0x0000 /* Timer Gate time accumulation disabled */
#define T3_GATE_MASK        (~T3_GATE_ON)

#define T3_PS_1_1           0x0000      /* Prescaler 1:1 */
#define T3_PS_1_8           0x0010      /*           1:8 */
#define T3_PS_1_64          0x0020      /*          1:64 */
#define T3_PS_1_256         0x0030      /*         1:256 */
#define T3_PS_MASK          (~T3_PS_1_256)

#define T3_SOURCE_EXT       0x0002 /* External clock source */
#define T3_SOURCE_INT       0x0000 /* Internal clock source */
#define T3_SOURCE_MASK      (~T3_SOURCE_EXT)
#endif

#ifdef _T4IF
/* T4CON: TIMER4 CONTROL REGISTER */
#define T4_ON               0x8000      /* Timer4 ON */
#define T4_OFF              0x0000      /* Timer4 OFF */
#define T4_OFF_ON_MASK      (~T4_ON)

#define T4_IDLE_STOP        0x2000 /* operate during sleep */
#define T4_IDLE_CON         0x0000 /* stop operation during sleep */
#define T4_IDLE_MASK        (~T4_IDLE_STOP)

#define T4_GATE_ON          0x0040 /* Timer Gate time accumulation enabled */
#define T4_GATE_OFF         0x0000 /* Timer Gate time accumulation disabled */
#define T4_GATE_MASK        (~T4_GATE_ON)

#define T4_PS_1_1           0x0000      /* Prescaler 1:1 */
#define T4_PS_1_8           0x0010      /*           1:8 */
#define T4_PS_1_64          0x0020      /*          1:64 */
#define T4_PS_1_256         0x0030      /*         1:256 */
#define T4_PS_MASK          (~T4_PS_1_256)

#define T4_32BIT_MODE_ON    0x0008      /* Timer 4 and Timer 5 form a 32 bit Timer */
#define T4_32BIT_MODE_OFF   0x0000
#define T4_32BIT_MODE_MASK   (~T4_32BIT_MODE_ON)

#define T4_SOURCE_EXT       0x0002 /* External clock source */
#define T4_SOURCE_INT       0x0000 /* Internal clock source */
#define T4_SOURCE_MASK      (~T4_SOURCE_EXT)
#endif

#ifdef _T5IF
/* T5CON: TIMER5 CONTROL REGISTER */
#define T5_ON               0x8000      /* Timer5 ON */
#define T5_OFF              0x0000      /* Timer5 OFF */
#define T5_OFF_ON_MASK      (~T5_ON)

#define T5_IDLE_STOP        0x2000 /* operate during sleep */
#define T5_IDLE_CON         0x0000 /* stop operation during sleep */
#define T5_IDLE_MASK        (~T5_IDLE_STOP)

#define T5_GATE_ON          0x0040 /* Timer Gate time accumulation enabled */
#define T5_GATE_OFF         0x0000 /* Timer Gate time accumulation disabled */
#define T5_GATE_MASK        (~T5_GATE_ON)

#define T5_PS_1_1           0x0000      /* Prescaler 1:1 */
#define T5_PS_1_8           0x0010      /*           1:8 */
#define T5_PS_1_64          0x0020      /*          1:64 */
#define T5_PS_1_256         0x0030      /*         1:256 */
#define T5_PS_MASK          (~T5_PS_1_256)

#define T5_SOURCE_EXT       0x0002 /* External clock source */
#define T5_SOURCE_INT       0x0000 /* Internal clock source */
#define T5_SOURCE_MASK      (~T5_SOURCE_EXT)
#endif

#ifdef _T6IF
/* T6CON: TIMER6 CONTROL REGISTER */
#define T6_ON               0x8000      /* Timer6 ON */
#define T6_OFF              0x0000      /* Timer6 OFF */
#define T6_OFF_ON_MASK      (~T6_ON)

#define T6_IDLE_STOP        0x2000 /* operate during sleep */
#define T6_IDLE_CON         0x0000 /* stop operation during sleep */
#define T6_IDLE_MASK        (~T6_IDLE_STOP)

#define T6_GATE_ON          0x0040 /* Timer Gate time accumulation enabled */
#define T6_GATE_OFF         0x0000 /* Timer Gate time accumulation disabled */
#define T6_GATE_MASK        (~T6_GATE_ON)

#define T6_PS_1_1           0x0000      /* Prescaler 1:1 */
#define T6_PS_1_8           0x0010      /*           1:8 */
#define T6_PS_1_64          0x0020      /*          1:64 */
#define T6_PS_1_256         0x0030      /*         1:256 */
#define T6_PS_MASK          (~T6_PS_1_256)

#define T6_32BIT_MODE_ON    0x0008      /* Timer 6 and Timer 7 form a 32 bit Timer */
#define T6_32BIT_MODE_OFF   0x0000
#define T6_32BIT_MODE_MASK   (~T6_32BIT_MODE_ON)

#define T6_SOURCE_EXT       0x0002 /* External clock source */
#define T6_SOURCE_INT       0x0000 /* Internal clock source */
#define T6_SOURCE_MASK      (~T6_SOURCE_EXT)
#endif

#ifdef _T7IF
/* T7CON: TIMER7 CONTROL REGISTER */
#define T7_ON               0x8000      /* Timer7 ON */
#define T7_OFF              0x0000      /* Timer7 OFF */
#define T7_OFF_ON_MASK      (~T7_ON)

#define T7_IDLE_STOP        0x2000 /* operate during sleep */
#define T7_IDLE_CON         0x0000 /* stop operation during sleep */
#define T7_IDLE_MASK        (~T7_IDLE_STOP)

#define T7_GATE_ON          0x0040 /* Timer Gate time accumulation enabled */
#define T7_GATE_OFF         0x0000 /* Timer Gate time accumulation disabled */
#define T7_GATE_MASK        (~T7_GATE_ON)

#define T7_PS_1_1           0x0000      /* Prescaler 1:1 */
#define T7_PS_1_8           0x0010      /*           1:8 */
#define T7_PS_1_64          0x0020      /*          1:64 */
#define T7_PS_1_256         0x0030      /*         1:256 */
#define T7_PS_MASK          (~T7_PS_1_256)

#define T7_SOURCE_EXT       0x0002 /* External clock source */
#define T7_SOURCE_INT       0x0000 /* Internal clock source */
#define T7_SOURCE_MASK      (~T7_SOURCE_EXT)
#endif

#ifdef _T8IF
/* T8CON: TIMER8 CONTROL REGISTER */
#define T8_ON               0x8000      /* Timer8 ON */
#define T8_OFF              0x0000      /* Timer8 OFF */
#define T8_OFF_ON_MASK      (~T8_ON)

#define T8_IDLE_STOP        0x2000 /* operate during sleep */
#define T8_IDLE_CON         0x0000 /* stop operation during sleep */
#define T8_IDLE_MASK        (~T8_IDLE_STOP)

#define T8_GATE_ON          0x0040 /* Timer Gate time accumulation enabled */
#define T8_GATE_OFF         0x0000 /* Timer Gate time accumulation disabled */
#define T8_GATE_MASK        (~T8_GATE_ON)

#define T8_PS_1_1           0x0000      /* Prescaler 1:1 */
#define T8_PS_1_8           0x0010      /*           1:8 */
#define T8_PS_1_64          0x0020      /*          1:64 */
#define T8_PS_1_256         0x0030      /*         1:256 */
#define T8_PS_MASK          (~T8_PS_1_256)

#define T8_32BIT_MODE_ON    0x0008      /* Timer 8 and Timer 9 form a 32 bit Timer */
#define T8_32BIT_MODE_OFF   0x0000
#define T8_32BIT_MODE_MASK   (~T8_32BIT_MODE_ON)

#define T8_SOURCE_EXT       0x0002 /* External clock source */
#define T8_SOURCE_INT       0x0000 /* Internal clock source */
#define T8_SOURCE_MASK      (~T8_SOURCE_EXT)
#endif

#ifdef _T9IF
/* T9CON: TIMER9 CONTROL REGISTER */
#define T9_ON               0x8000      /* Timer9 ON */
#define T9_OFF              0x0000      /* Timer9 OFF */
#define T9_OFF_ON_MASK      (~T9_ON)

#define T9_IDLE_STOP        0x2000 /* operate during sleep */
#define T9_IDLE_CON         0x0000 /* stop operation during sleep */
#define T9_IDLE_MASK        (~T9_IDLE_STOP)

#define T9_GATE_ON          0x0040 /* Timer Gate time accumulation enabled */
#define T9_GATE_OFF         0x0000 /* Timer Gate time accumulation disabled */
#define T9_GATE_MASK        (~T9_GATE_ON)

#define T9_PS_1_1           0x0000      /* Prescaler 1:1 */
#define T9_PS_1_8           0x0010      /*           1:8 */
#define T9_PS_1_64          0x0020      /*          1:64 */
#define T9_PS_1_256         0x0030      /*         1:256 */
#define T9_PS_MASK          (~T9_PS_1_256)

#define T9_SOURCE_EXT       0x0002 /* External clock source */
#define T9_SOURCE_INT       0x0000 /* Internal clock source */
#define T9_SOURCE_MASK      (~T9_SOURCE_EXT)
#endif

//Input Capture macros

/*
The following macros are a subset of the AND/OR macros found in the
the MPLAB C30/src/peripheral_24F/incap.h file and placed
in this header for use solely and exclusively on Microchip
PICmicro Microcontroller products as
specified in the MPLAB C30/src/peripheral_24F/incap.h header.
*/

#define IC_IDLE_STOP            0x2000 /* IC stop in sleep mode */
#define IC_IDLE_CON             0x0000 /* IC operate in sleep mode */
#define IC_IDLE_MASK            (~IC_IDLE_STOP)

#define IC_TIMER2_SRC           0x0080 /* Timer2 is the clock source for Capture */
#define IC_TIMER3_SRC           0x0000 /* Timer3 is the clock source for Capture */
#define IC_TIMER_SRC_MASK       (~IC_TIMER2_SRC)

#define IC_INT_4CAPTURE         0x0060  /* Interrupt on fourth Capture*/
#define IC_INT_3CAPTURE         0x0040 /* Interrupt on third Capture */
#define IC_INT_2CAPTURE         0x0020 /* Interrupt on second Capture*/
#define IC_INT_1CAPTURE         0x0000 /* Interrupt on first Capture */
#define IC_INT_CAPTURE_MASK     (~IC_INT_4CAPTURE)

#define IC_INTERRUPT            0x0007 /* Interrupt pin only in CPU sleep and idle mode */
#define IC_EVERY_16_RISE_EDGE   0x0005 /* Every 16th rising edge */
#define IC_EVERY_4_RISE_EDGE    0x0004 /* Every 4th rising edge  */
#define IC_EVERY_RISE_EDGE      0x0003 /* Every rising edge      */
#define IC_EVERY_FALL_EDGE      0x0002 /* Every falling edge      */
#define IC_EVERY_EDGE           0x0001 /* Every rising/falling edge */
#define IC_INPUTCAP_OFF         0x0000 /* Input Capture Off      */
#define IC_CAPTURE_MODE_MASK    (~IC_INTERRUPT)

//Output Compare macros

/*
The following macros are a subset of the AND/OR macros found in the
the MPLAB C30/src/peripheral_24F/outcompare.h file and placed
in this header for use solely and exclusively on Microchip
PICmicro Microcontroller products as
specified in the MPLAB C30/src/peripheral_24F/outcompare.h header.
*/

/* Section : Output Compare Stop in Idle mode Bit defines */
#define OC_IDLE_CON                0x0000 /*  continue operation in idle mode */
#define OC_IDLE_STOP               0x2000 /* stop in idle mode */
#define OC_IDLE_MASK               (~OC_IDLE_STOP)

/*Section :  Output Compare timer select Bit Defines */
#define OC_TIMER2_SRC               0x0000 /* Timer2 is the clock source for OutputCompare */
#define OC_TIMER3_SRC               0x0008 /* Timer3 is the clock source for OutputCompare */
#define OC_TIMER_SRC_MASK           (~OC_TIMER3_SRC)

#define OC_PWM_FAULT_PIN_ENABLE     0x0007 /* PWM Mode on OCx, fault pin enabled, (TxIF bit is set for PWM, OCxIF is set for fault)*/
#define OC_PWM_FAULT_PIN_DISABLE    0x0006 /* PWM Mode on OCx, fault pin disabled */
#define OC_CONTINUE_PULSE           0x0005 /* Generates Continuous Output pulse on OCx Pin */
#define OC_SINGLE_PULSE             0x0004 /* Generates Single Output pulse on OCx Pin */
#define OC_TOGGLE_PULSE             0x0003 /* Compare1 toggles  OCx pin*/
#define OC_HIGH_LOW                 0x0002 /* Compare1 forces   OCx pin Low*/
#define OC_LOW_HIGH                 0x0001 /* Compare1 forces  OCx pin High*/
#define OC_OFF                      0x0000 /* OutputCompare x Off*/
#define OC_PWM_MODE_MASK            (~OC_PWM_FAULT_PIN_ENABLE)


#endif

---