Remove \version svn tag.
[bertos.git] / bertos / cpu / arm / io / at91_pit.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 2007 Develer S.r.l. (http://www.develer.com/)
30  *
31  * -->
32  *
33  *
34  * \author Francesco Sacchi <batt@develer.com>
35  *
36  * AT91 periodic interval timer.
37  * This file is based on NUT/OS implementation. See license below.
38  */
39
40 /*
41  * Copyright (C) 2007 by egnite Software GmbH. All rights reserved.
42  *
43  * Redistribution and use in source and binary forms, with or without
44  * modification, are permitted provided that the following conditions
45  * are met:
46  *
47  * 1. Redistributions of source code must retain the above copyright
48  *    notice, this list of conditions and the following disclaimer.
49  * 2. Redistributions in binary form must reproduce the above copyright
50  *    notice, this list of conditions and the following disclaimer in the
51  *    documentation and/or other materials provided with the distribution.
52  * 3. Neither the name of the copyright holders nor the names of
53  *    contributors may be used to endorse or promote products derived
54  *    from this software without specific prior written permission.
55  *
56  * THIS SOFTWARE IS PROVIDED BY EGNITE SOFTWARE GMBH AND CONTRIBUTORS
57  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
58  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
59  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL EGNITE
60  * SOFTWARE GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
61  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
62  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
63  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
64  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
65  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
66  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
67  * SUCH DAMAGE.
68  *
69  * For additional information see http://www.ethernut.de/
70  */
71
72 #ifndef AT91_PIT_H
73 #define AT91_PIT_H
74
75 #include <cfg/compiler.h>
76 /**
77  *Periodic Inverval Timer Mode Register
78  *\{
79  */
80 #define PIT_MR_OFF 0x00000000 ///< Mode register offset.
81 #define PIT_MR     (*((reg32_t *)(PIT_BASE + PIT_MR_OFF))) ///< Mode register address.
82
83 #define PIV_MASK   0x000FFFFF ///< Periodic interval value mask.
84 #define PIV_SHIFT  0          ///< Periodic interval value shift.
85 #define PITEN      24         ///< Periodic interval timer enable.
86 #define PITIEN     25         ///< Periodic interval timer interrupt enable.
87 /*\}*/
88
89 /**
90  * Periodic Inverval Timer Status Register
91  *\{
92  */
93 #define PIT_SR_OFF 0x00000004 ///< Status register offset.
94 #define PIT_SR     (*((reg32_t *)(PIT_BASE + PIT_SR_OFF))) ///< Status register address.
95
96 #define PITS       0          ///< Timer has reached PIV.
97 /*\}*/
98
99 /**
100  * Periodic Inverval Timer Value and Image Registers
101  *\{
102  */
103 #define PIVR_OFF    0x00000008 ///< Value register offset.
104 #define PIVR        (*((reg32_t *)(PIT_BASE + PIVR_OFF))) ///< Value register address.
105
106 #define PIIR_OFF    0x0000000C ///< Image register offset.
107 #define PIIR        (*((reg32_t *)(PIT_BASE + PIIR_OFF))) ///< Image register address.
108 #define CPIV_MASK   0x000FFFFF ///< Current periodic interval value mask.
109 #define CPIV_SHIFT  0          ///< Current periodic interval value SHIFT.
110 #define PICNT_MASK  0xFFF00000 ///< Periodic interval counter mask.
111 #define PICNT_SHIFT 20         ///< Periodic interval counter LSB.
112 /*\}*/
113
114 #endif /* AT91_PIT_H */