Reorder includes.
[bertos.git] / bertos / cpu / arm / drv / sysirq_at91.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  * \brief System irq handler for Atmel AT91 ARM7 processors (interface).
38  */
39
40 #ifndef DRV_AT91_SYSIRQ_H
41 #define DRV_AT91_SYSIRQ_H
42
43 #include <cfg/compiler.h>
44
45 typedef void (* sysirq_handler_t)(void);   ///< Type for system irq handler.
46 typedef void (* sysirq_setEnable_t)(bool); ///< Type for system irq enable/disable function.
47
48 /**
49  * Structure used to define a system interrupt source.
50  */
51 typedef struct SysIrq
52 {
53         bool enabled;                 ///< Getter for irq enable/disable state.
54         sysirq_setEnable_t setEnable; ///< Setter for irq enable/disable state.
55         sysirq_handler_t handler;     ///< IRQ handler.
56 } SysIrq;
57
58 /**
59  * System IRQ ID list.
60  */
61 typedef enum sysirq_t
62 {
63         SYSIRQ_PIT, ///< Periodic Interval Timer
64         /* TODO: add all system irqs */
65         SYSIRQ_CNT
66 } sysirq_t;
67
68 void sysirq_init(void);
69 void sysirq_setHandler(sysirq_t irq, sysirq_handler_t handler);
70 void sysirq_setEnable(sysirq_t irq, bool enable);
71 bool sysirq_enabled(sysirq_t irq);
72
73 #endif /* ARCH_ARM_SYSIRQ_H */