doc: Add clarifications for doxygen generated documentation
[bertos.git] / boards / triface / hw / hw_input.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 2003, 2004, 2006, 2010 Develer S.r.l. (http://www.develer.com/)
30  * Copyright 2000 Bernie Innocenti <bernie@codewiz.org>
31  *
32  * -->
33  *
34  * \brief Macro for HW_INPUT_H
35  *
36  * \author Andrea Grandi <andrea@develer.com>
37  */
38
39 #ifndef HW_INPUT_H
40 #define HW_INPUT_H
41
42 #include <avr/io.h>
43
44 /* Set pins as input and enable pull-up */
45 #define INPUT_INIT_D \
46         do{     \
47         DDRD &= ~(BV(PD4) | BV(PD5) | BV(PD6) | BV(PD7)); \
48         PORTD |= (BV(PD4) | BV(PD5) | BV(PD6) | BV(PD7)); \
49         } while(0)
50
51 #define INPUT_INIT_E \
52         do{     \
53                 DDRE &= ~(BV(PE4) | BV(PE5) | BV(PE6) | BV(PE7)); \
54                 PORTE |= (BV(PE4) | BV(PE5) | BV(PE6) | BV(PE7)); \
55         } while(0)
56
57 INLINE uint8_t INPUT_GET(void)
58 {
59         uint8_t out_d, out_e;
60         out_d = PIND;
61         out_e = PINE;
62
63         /* Select our input (see scheme) */
64         out_d >>= 4;
65         out_e = out_e & 0xF0;
66
67         return (out_e | out_d);
68 }
69
70 #define INPUT_INIT() \
71         do { \
72                 INPUT_INIT_D; \
73                 INPUT_INIT_E; \
74         } while(0)
75
76 #endif /* HW_INPUT_H */