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