drv/timer_avr.h

   1 /**
   2  * \file
   3  * <!--
   4  * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
   5  * Copyright 2000 Bernardo Innocenti <bernie@develer.com>
   6  * This file is part of DevLib - See README.devlib for information.
   7  * -->
   8  *
   9  * \version $Id$
  10  *
  11  * \author Bernardo Innocenti <bernie@develer.com>
  12  * \author Francesco Sacchi <batt@develer.com>
  13  *
  14  * \brief Low-level timer module for AVR (interface).
  15  */
  16
  17 /*#*
  18  *#* $Log$
  19  *#* Revision 1.32  2007/10/08 12:14:32  batt
  20  *#* Fix some review issues.
  21  *#*
  22  *#* Revision 1.31  2007/10/07 12:30:55  batt
  23  *#* Add default timer for AVR.
  24  *#*
  25  *#* Revision 1.30  2007/06/07 14:35:12  batt
  26  *#* Merge from project_ks.
  27  *#*
  28  *#* Revision 1.29  2007/03/21 11:01:36  batt
  29  *#* Add missing support for ATMega1281.
  30  *#*
  31  *#* Revision 1.28  2006/07/19 12:56:26  bernie
  32  *#* Convert to new Doxygen style.
  33  *#*
  34  *#* Revision 1.27  2006/05/18 00:38:24  bernie
  35  *#* Use hw_cpu.h instead of ubiquitous hw.h.
  36  *#*
  37  *#* Revision 1.26  2006/02/21 21:28:02  bernie
  38  *#* New time handling based on TIMER_TICKS_PER_SEC to support slow timers with ticks longer than 1ms.
  39  *#*
  40  *#* Revision 1.25  2005/07/19 07:26:37  bernie
  41  *#* Refactor to decouple timer ticks from milliseconds.
  42  *#*
  43  *#* Revision 1.24  2005/04/11 19:10:28  bernie
  44  *#* Include top-level headers from cfg/ subdir.
  45  *#*
  46  *#* Revision 1.23  2005/03/01 23:24:51  bernie
  47  *#* Tweaks for avr-libc 1.2.x.
  48  *#*
  49  *#* Revision 1.21  2004/12/13 12:07:06  bernie
  50  *#* DISABLE_IRQSAVE/ENABLE_IRQRESTORE: Convert to IRQ_SAVE_DISABLE/IRQ_RESTORE.
  51  *#*
  52  *#* Revision 1.20  2004/11/16 20:59:46  bernie
  53  *#* Include <avr/io.h> explicitly.
  54  *#*
  55  *#* Revision 1.19  2004/10/19 08:56:41  bernie
  56  *#* TIMER_STROBE_ON, TIMER_STROBE_OFF, TIMER_STROBE_INIT: Move from timer_avr.h to timer.h, where they really belong.
  57  *#*
  58  *#* Revision 1.18  2004/09/20 03:31:03  bernie
  59  *#* Fix racy racy code.
  60  *#*/
  61 #ifndef DRV_TIMER_AVR_H
  62 #define DRV_TIMER_AVR_H
  63
  64 #include <appconfig.h>     /* CONFIG_TIMER */
  65 #include <cfg/compiler.h>  /* uint8_t */
  66 #include <hw_cpu.h>        /* CLOCK_FREQ */
  67
  68 /**
  69  * \name Values for CONFIG_TIMER.
  70  *
  71  * Select which hardware timer interrupt to use for system clock and softtimers.
  72  * \note The timer 1 overflow mode set the timer as a 24 kHz PWM.
  73  *
  74  * \{
  75  */
  76 #define TIMER_ON_OUTPUT_COMPARE0  1
  77 #define TIMER_ON_OVERFLOW1        2
  78 #define TIMER_ON_OUTPUT_COMPARE2  3
  79 #define TIMER_ON_OVERFLOW3        4
  80
  81 #define TIMER_DEFAULT TIMER_ON_OUTPUT_COMPARE0 ///< Default system timer
  82 /* \} */
  83
  84 /*
  85  * Hardware dependent timer initialization.
  86  */
  87 #if (CONFIG_TIMER == TIMER_ON_OUTPUT_COMPARE0)
  88
  89         #define TIMER_PRESCALER      64
  90         #define TIMER_HW_BITS        8
  91         #define DEFINE_TIMER_ISR     SIGNAL(SIG_OUTPUT_COMPARE0)
  92         #define TIMER_TICKS_PER_SEC  1000
  93         #define TIMER_HW_CNT         OCR_DIVISOR
  94
  95         /// Type of time expressed in ticks of the hardware high-precision timer
  96         typedef uint8_t hptime_t;
  97
  98 #elif (CONFIG_TIMER == TIMER_ON_OVERFLOW1)
  99
 100         #define TIMER_PRESCALER      1
 101         #define TIMER_HW_BITS        8
 102         /** This value is the maximum in overflow based timers. */
 103         #define TIMER_HW_CNT         (1 << TIMER_HW_BITS)
 104         #define DEFINE_TIMER_ISR     SIGNAL(SIG_OVERFLOW1)
 105         #define TIMER_TICKS_PER_SEC  ((TIMER_HW_HPTICKS_PER_SEC + TIMER_HW_CNT / 2) / TIMER_HW_CNT)
 106
 107         /// Type of time expressed in ticks of the hardware high precision timer
 108         typedef uint16_t hptime_t;
 109
 110 #elif (CONFIG_TIMER == TIMER_ON_OUTPUT_COMPARE2)
 111
 112         #define TIMER_PRESCALER      64
 113         #define TIMER_HW_BITS        8
 114         #if CPU_AVR_ATMEGA1281 || CPU_AVR_ATMEGA168
 115                 #define DEFINE_TIMER_ISR     SIGNAL(SIG_OUTPUT_COMPARE2A)
 116         #else
 117                 #define DEFINE_TIMER_ISR     SIGNAL(SIG_OUTPUT_COMPARE2)
 118         #endif
 119         #define TIMER_TICKS_PER_SEC  1000
 120         /** Value for OCR register in output-compare based timers. */
 121         #define TIMER_HW_CNT         OCR_DIVISOR
 122
 123
 124         /// Type of time expressed in ticks of the hardware high precision timer
 125         typedef uint8_t hptime_t;
 126
 127 #elif (CONFIG_TIMER == TIMER_ON_OVERFLOW3)
 128
 129         #define TIMER_PRESCALER      1
 130         #define TIMER_HW_BITS        8
 131         /** This value is the maximum in overflow based timers. */
 132         #define TIMER_HW_CNT         (1 << TIMER_HW_BITS)
 133         #define DEFINE_TIMER_ISR     SIGNAL(SIG_OVERFLOW3)
 134         #define TIMER_TICKS_PER_SEC  ((TIMER_HW_HPTICKS_PER_SEC + TIMER_HW_CNT / 2) / TIMER_HW_CNT)
 135
 136         /// Type of time expressed in ticks of the hardware high precision timer
 137         typedef uint16_t hptime_t;
 138 #else
 139
 140         #error Unimplemented value for CONFIG_TIMER
 141 #endif /* CONFIG_TIMER */
 142
 143
 144 /** Frequency of the hardware high precision timer. */
 145 #define TIMER_HW_HPTICKS_PER_SEC  ((CLOCK_FREQ + TIMER_PRESCALER / 2) / TIMER_PRESCALER)
 146
 147 /**
 148  * System timer: additional division after the prescaler
 149  * 12288000 / 64 / 192 (0..191) = 1 ms
 150  */
 151 #define OCR_DIVISOR  (((CLOCK_FREQ + TIMER_PRESCALER / 2) / TIMER_PRESCALER + TIMER_TICKS_PER_SEC / 2) / TIMER_TICKS_PER_SEC - 1)
 152
 153 /** Not needed, IRQ timer flag cleared automatically */
 154 #define timer_hw_irq() do {} while (0)
 155
 156 /** Not needed, timer IRQ handler called only for timer source */
 157 #define timer_hw_triggered() (true)
 158
 159
 160 #endif /* DRV_TIMER_AVR_H */