bertos/cpu/avr/drv/timer_avr.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
  30  * Copyright 2000 Bernie Innocenti <bernie@codewiz.org>
  31  *
  32  * -->
  33  *
  34  * \brief Low-level timer module for AVR (interface).
  35  *
  36  * \version $Id$
  37  *
  38  * \author Bernie Innocenti <bernie@codewiz.org>
  39  * \author Francesco Sacchi <batt@develer.com>
  40  *
  41  */
  42
  43 #ifndef DRV_TIMER_AVR_H
  44 #define DRV_TIMER_AVR_H
  45
  46 #include <hw/hw_cpufreq.h>   /* CPU_FREQ */
  47
  48 #include "cfg/cfg_timer.h"   /* CONFIG_TIMER */
  49 #include <cfg/compiler.h>    /* uint8_t */
  50 #include <cfg/macros.h>      /* DIV_ROUND */
  51
  52 #include <avr/io.h>
  53 #include <avr/interrupt.h>
  54
  55 /**
  56  * \name Values for CONFIG_TIMER.
  57  *
  58  * Select which hardware timer interrupt to use for system clock and softtimers.
  59  * \note The timer 1 overflow mode set the timer as a 24 kHz PWM.
  60  * $WIZ$ timer_select = "TIMER_ON_OUTPUT_COMPARE0", "TIMER_ON_OVERFLOW1", "TIMER_ON_OUTPUT_COMPARE2", "TIMER_ON_OVERFLOW3", "TIMER_DEFAULT"
  61  */
  62 #define TIMER_ON_OUTPUT_COMPARE0  1
  63 #define TIMER_ON_OVERFLOW1        2
  64 #define TIMER_ON_OUTPUT_COMPARE2  3
  65 #define TIMER_ON_OVERFLOW3        4
  66
  67 #define TIMER_DEFAULT TIMER_ON_OUTPUT_COMPARE0 ///< Default system timer
  68
  69 /*
  70  * Hardware dependent timer initialization.
  71  */
  72 #if (CONFIG_TIMER == TIMER_ON_OUTPUT_COMPARE0)
  73
  74         #define TIMER_PRESCALER      64
  75         #define TIMER_HW_BITS        8
  76         #if CPU_AVR_ATMEGA1281 || CPU_AVR_ATMEGA168
  77                 #define DEFINE_TIMER_ISR     SIGNAL(SIG_OUTPUT_COMPARE0A)
  78         #else
  79                 #define DEFINE_TIMER_ISR     SIGNAL(SIG_OUTPUT_COMPARE0)
  80         #endif
  81         #define TIMER_TICKS_PER_SEC  1000
  82         #define TIMER_HW_CNT         OCR_DIVISOR
  83
  84         /// Type of time expressed in ticks of the hardware high-precision timer
  85         typedef uint8_t hptime_t;
  86
  87         INLINE hptime_t timer_hw_hpread(void)
  88         {
  89                 return TCNT0;
  90         }
  91
  92 #elif (CONFIG_TIMER == TIMER_ON_OVERFLOW1)
  93
  94         #define TIMER_PRESCALER      1
  95         #define TIMER_HW_BITS        8
  96         /** This value is the maximum in overflow based timers. */
  97         #define TIMER_HW_CNT         (1 << TIMER_HW_BITS)
  98         #define DEFINE_TIMER_ISR     SIGNAL(SIG_OVERFLOW1)
  99         #define TIMER_TICKS_PER_SEC  DIV_ROUND(TIMER_HW_HPTICKS_PER_SEC, TIMER_HW_CNT)
 100
 101         /// Type of time expressed in ticks of the hardware high precision timer
 102         typedef uint16_t hptime_t;
 103
 104         INLINE hptime_t timer_hw_hpread(void)
 105         {
 106                 return TCNT1;
 107         }
 108
 109 #elif (CONFIG_TIMER == TIMER_ON_OUTPUT_COMPARE2)
 110
 111         #define TIMER_PRESCALER      64
 112         #define TIMER_HW_BITS        8
 113         #if CPU_AVR_ATMEGA1281 || CPU_AVR_ATMEGA168
 114                 #define DEFINE_TIMER_ISR     SIGNAL(SIG_OUTPUT_COMPARE2A)
 115         #else
 116                 #define DEFINE_TIMER_ISR     SIGNAL(SIG_OUTPUT_COMPARE2)
 117         #endif
 118         #define TIMER_TICKS_PER_SEC  1000
 119         /** Value for OCR register in output-compare based timers. */
 120         #define TIMER_HW_CNT         OCR_DIVISOR
 121
 122         /// Type of time expressed in ticks of the hardware high precision timer
 123         typedef uint8_t hptime_t;
 124
 125         INLINE hptime_t timer_hw_hpread(void)
 126         {
 127                 return TCNT2;
 128         }
 129
 130 #elif (CONFIG_TIMER == TIMER_ON_OVERFLOW3)
 131
 132         #define TIMER_PRESCALER      1
 133         #define TIMER_HW_BITS        8
 134         /** This value is the maximum in overflow based timers. */
 135         #define TIMER_HW_CNT         (1 << TIMER_HW_BITS)
 136         #define DEFINE_TIMER_ISR     SIGNAL(SIG_OVERFLOW3)
 137         #define TIMER_TICKS_PER_SEC  DIV_ROUND(TIMER_HW_HPTICKS_PER_SEC, TIMER_HW_CNT)
 138
 139         /// Type of time expressed in ticks of the hardware high precision timer
 140         typedef uint16_t hptime_t;
 141
 142         INLINE hptime_t timer_hw_hpread(void)
 143         {
 144                 return TCNT3;
 145         }
 146
 147 #else
 148
 149         #error Unimplemented value for CONFIG_TIMER
 150 #endif /* CONFIG_TIMER */
 151
 152
 153 /** Frequency of the hardware high precision timer. */
 154 #define TIMER_HW_HPTICKS_PER_SEC  DIV_ROUND(CPU_FREQ, TIMER_PRESCALER)
 155
 156 /**
 157  * System timer: additional division after the prescaler
 158  * 12288000 / 64 / 192 (0..191) = 1 ms
 159  */
 160 #define OCR_DIVISOR  (DIV_ROUND(DIV_ROUND(CPU_FREQ, TIMER_PRESCALER), TIMER_TICKS_PER_SEC) - 1)
 161
 162 /** Not needed, IRQ timer flag cleared automatically */
 163 #define timer_hw_irq() do {} while (0)
 164
 165 /** Not needed, timer IRQ handler called only for timer source */
 166 #define timer_hw_triggered() (true)
 167
 168 void timer_hw_init(void);
 169
 170 #endif /* DRV_TIMER_AVR_H */