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_cpu.h"        /* CLOCK_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
  53 /**
  54  * \name Values for CONFIG_TIMER.
  55  *
  56  * Select which hardware timer interrupt to use for system clock and softtimers.
  57  * \note The timer 1 overflow mode set the timer as a 24 kHz PWM.
  58  * $WIZ$ timer_select = "TIMER_ON_OUTPUT_COMPARE0", "TIMER_ON_OVERFLOW1", "TIMER_ON_OUTPUT_COMPARE2", "TIMER_ON_OVERFLOW3", "TIMER_DEFAULT"
  59  */
  60 #define TIMER_ON_OUTPUT_COMPARE0  1
  61 #define TIMER_ON_OVERFLOW1        2
  62 #define TIMER_ON_OUTPUT_COMPARE2  3
  63 #define TIMER_ON_OVERFLOW3        4
  64
  65 #define TIMER_DEFAULT TIMER_ON_OUTPUT_COMPARE0 ///< Default system timer
  66
  67 /*
  68  * Hardware dependent timer initialization.
  69  */
  70 #if (CONFIG_TIMER == TIMER_ON_OUTPUT_COMPARE0)
  71
  72         #define TIMER_PRESCALER      64
  73         #define TIMER_HW_BITS        8
  74         #if CPU_AVR_ATMEGA1281 || CPU_AVR_ATMEGA168
  75                 #define DEFINE_TIMER_ISR     SIGNAL(SIG_OUTPUT_COMPARE0A)
  76         #else
  77                 #define DEFINE_TIMER_ISR     SIGNAL(SIG_OUTPUT_COMPARE0)
  78         #endif
  79         #define TIMER_TICKS_PER_SEC  1000
  80         #define TIMER_HW_CNT         OCR_DIVISOR
  81
  82         /// Type of time expressed in ticks of the hardware high-precision timer
  83         typedef uint8_t hptime_t;
  84
  85 #elif (CONFIG_TIMER == TIMER_ON_OVERFLOW1)
  86
  87         #define TIMER_PRESCALER      1
  88         #define TIMER_HW_BITS        8
  89         /** This value is the maximum in overflow based timers. */
  90         #define TIMER_HW_CNT         (1 << TIMER_HW_BITS)
  91         #define DEFINE_TIMER_ISR     SIGNAL(SIG_OVERFLOW1)
  92         #define TIMER_TICKS_PER_SEC  DIV_ROUND(TIMER_HW_HPTICKS_PER_SEC, TIMER_HW_CNT)
  93
  94         /// Type of time expressed in ticks of the hardware high precision timer
  95         typedef uint16_t hptime_t;
  96
  97 #elif (CONFIG_TIMER == TIMER_ON_OUTPUT_COMPARE2)
  98
  99         #define TIMER_PRESCALER      64
 100         #define TIMER_HW_BITS        8
 101         #if CPU_AVR_ATMEGA1281 || CPU_AVR_ATMEGA168
 102                 #define DEFINE_TIMER_ISR     SIGNAL(SIG_OUTPUT_COMPARE2A)
 103         #else
 104                 #define DEFINE_TIMER_ISR     SIGNAL(SIG_OUTPUT_COMPARE2)
 105         #endif
 106         #define TIMER_TICKS_PER_SEC  1000
 107         /** Value for OCR register in output-compare based timers. */
 108         #define TIMER_HW_CNT         OCR_DIVISOR
 109
 110
 111         /// Type of time expressed in ticks of the hardware high precision timer
 112         typedef uint8_t hptime_t;
 113
 114 #elif (CONFIG_TIMER == TIMER_ON_OVERFLOW3)
 115
 116         #define TIMER_PRESCALER      1
 117         #define TIMER_HW_BITS        8
 118         /** This value is the maximum in overflow based timers. */
 119         #define TIMER_HW_CNT         (1 << TIMER_HW_BITS)
 120         #define DEFINE_TIMER_ISR     SIGNAL(SIG_OVERFLOW3)
 121         #define TIMER_TICKS_PER_SEC  DIV_ROUND(TIMER_HW_HPTICKS_PER_SEC, TIMER_HW_CNT)
 122
 123         /// Type of time expressed in ticks of the hardware high precision timer
 124         typedef uint16_t hptime_t;
 125 #else
 126
 127         #error Unimplemented value for CONFIG_TIMER
 128 #endif /* CONFIG_TIMER */
 129
 130
 131 /** Frequency of the hardware high precision timer. */
 132 #define TIMER_HW_HPTICKS_PER_SEC  DIV_ROUND(CLOCK_FREQ, TIMER_PRESCALER)
 133
 134 /**
 135  * System timer: additional division after the prescaler
 136  * 12288000 / 64 / 192 (0..191) = 1 ms
 137  */
 138 #define OCR_DIVISOR  (DIV_ROUND(DIV_ROUND(CLOCK_FREQ, TIMER_PRESCALER), TIMER_TICKS_PER_SEC) - 1)
 139
 140 /** Not needed, IRQ timer flag cleared automatically */
 141 #define timer_hw_irq() do {} while (0)
 142
 143 /** Not needed, timer IRQ handler called only for timer source */
 144 #define timer_hw_triggered() (true)
 145
 146
 147 #endif /* DRV_TIMER_AVR_H */