04b25e8e9b455f81880c6eb078ed7bbeaaeb8862
[simavr] / simavr / sim / avr_timer.h
1 /*
2         avr_timer.h
3
4         Copyright 2008, 2009 Michel Pollet <buserror@gmail.com>
5
6         This file is part of simavr.
7
8         simavr is free software: you can redistribute it and/or modify
9         it under the terms of the GNU General Public License as published by
10         the Free Software Foundation, either version 3 of the License, or
11         (at your option) any later version.
12
13         simavr is distributed in the hope that it will be useful,
14         but WITHOUT ANY WARRANTY; without even the implied warranty of
15         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16         GNU General Public License for more details.
17
18         You should have received a copy of the GNU General Public License
19         along with simavr.  If not, see <http://www.gnu.org/licenses/>.
20  */
21
22 #ifndef AVR_TIMER_H_
23 #define AVR_TIMER_H_
24
25 #include "sim_avr.h"
26
27 enum {
28         AVR_TIMER_COMPA = 0,
29         AVR_TIMER_COMPB,
30         AVR_TIMER_COMPC,
31
32         AVR_TIMER_COMP_COUNT
33 };
34
35 enum {
36         TIMER_IRQ_OUT_PWM0 = 0,
37         TIMER_IRQ_OUT_PWM1,
38         TIMER_IRQ_OUT_COMP,     // comparator pins output IRQ
39
40         TIMER_IRQ_COUNT = TIMER_IRQ_OUT_COMP + AVR_TIMER_COMP_COUNT
41 };
42
43 // Get the internal IRQ corresponding to the INT
44 #define AVR_IOCTL_TIMER_GETIRQ(_name) AVR_IOCTL_DEF('t','m','r',(_name))
45
46 // Waweform generation modes
47 enum {
48         avr_timer_wgm_none = 0, // invalid mode
49         avr_timer_wgm_normal,
50         avr_timer_wgm_ctc,
51         avr_timer_wgm_pwm,
52         avr_timer_wgm_fast_pwm,
53         avr_timer_wgm_fc_pwm,
54 };
55
56 // Compare output modes
57 enum {
58         avr_timer_com_normal = 0,// Normal mode, OCnx disconnected
59         avr_timer_com_toggle,   // Toggle OCnx on compare match
60         avr_timer_com_clear,    // clear OCnx on compare match
61         avr_timer_com_set,      // set OCnx on compare match
62         
63 };
64
65 enum {
66         avr_timer_wgm_reg_constant = 0,
67         avr_timer_wgm_reg_ocra,
68         avr_timer_wgm_reg_icr,
69 };
70 typedef struct avr_timer_wgm_t {
71         uint32_t top: 8, bottom: 8, size : 8, kind : 8;
72 } avr_timer_wgm_t;
73
74 #define AVR_TIMER_WGM_NORMAL8() { .kind = avr_timer_wgm_normal, .size=8 }
75 #define AVR_TIMER_WGM_NORMAL16() { .kind = avr_timer_wgm_normal, .size=16 }
76 #define AVR_TIMER_WGM_CTC() { .kind = avr_timer_wgm_ctc, .top = avr_timer_wgm_reg_ocra }
77 #define AVR_TIMER_WGM_ICCTC() { .kind = avr_timer_wgm_ctc, .top = avr_timer_wgm_reg_icr }
78 #define AVR_TIMER_WGM_FASTPWM8() { .kind = avr_timer_wgm_fast_pwm, .size=8 }
79 #define AVR_TIMER_WGM_FASTPWM9() { .kind = avr_timer_wgm_fast_pwm, .size=9 }
80 #define AVR_TIMER_WGM_FASTPWM10() { .kind = avr_timer_wgm_fast_pwm, .size=10 }
81 #define AVR_TIMER_WGM_FCPWM8() { .kind = avr_timer_wgm_fc_pwm, .size=8 }
82 #define AVR_TIMER_WGM_FCPWM9() { .kind = avr_timer_wgm_fc_pwm, .size=9 }
83 #define AVR_TIMER_WGM_FCPWM10() { .kind = avr_timer_wgm_fc_pwm, .size=10 }
84 #define AVR_TIMER_WGM_OCPWM() { .kind = avr_timer_wgm_pwm, .top = avr_timer_wgm_reg_ocra }
85 #define AVR_TIMER_WGM_ICPWM() { .kind = avr_timer_wgm_pwm, .top = avr_timer_wgm_reg_icr }
86
87
88 typedef struct avr_timer_t {
89         avr_io_t        io;
90         char name;
91         uint16_t                trace_flags;
92
93         avr_regbit_t    disabled;       // bit in the PRR
94
95         avr_io_addr_t   r_tcnt, r_icr;
96         avr_io_addr_t   r_tcnth, r_icrh;
97
98         avr_regbit_t    wgm[4];
99         avr_timer_wgm_t wgm_op[16];
100
101         avr_regbit_t    cs[4];
102         uint8_t                 cs_div[16];
103         avr_regbit_t    as2;            // asynchronous clock 32khz
104         avr_regbit_t    icp;            // input capture pin, to link IRQs
105         avr_regbit_t    ices;           // input capture edge select
106
107         struct {
108                 avr_int_vector_t        interrupt;              // interrupt vector
109                 avr_io_addr_t           r_ocr;                  // comparator register low byte
110                 avr_io_addr_t           r_ocrh;                 // comparator register hi byte
111                 avr_regbit_t            com;                    // comparator output mode registers
112                 avr_regbit_t            com_pin;                // where comparator output is connected
113                 uint64_t                        comp_cycles;
114         } comp[AVR_TIMER_COMP_COUNT];
115
116         avr_int_vector_t overflow;      // overflow
117         avr_int_vector_t icr;   // input capture
118
119         avr_timer_wgm_t mode;
120         uint64_t                tov_cycles;
121         uint64_t                tov_base;       // when we last were called
122         uint16_t                tov_top;        // current top value to calculate tnct
123 } avr_timer_t;
124
125 void avr_timer_init(avr_t * avr, avr_timer_t * port);
126
127 #endif /* AVR_TIMER_H_ */