Release 2.7.0
[bertos.git] / boards / arduino-mega / hw / hw_sipo.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, 2008, 2009 Develer S.r.l. (http://www.develer.com/)
30  * Copyright 2000 Bernie Innocenti <bernie@codewiz.org>
31  * All Rights Reserved.
32  * -->
33  *
34  * \brief Macro for HW_SIPO_H
35  *
36  *
37  * \version $Id$
38  *
39  * \author Andrea Grandi <andrea@develer.com>
40  * \author Daniele Basile <asterix@develer.com>
41  */
42
43 #ifndef HW_SIPO_H
44 #define HW_SIPO_H
45
46 /**
47  * Map sipo connection on board.
48  */
49 typedef enum SipoMap
50 {
51         SIPO_CNT
52 } SipoMap;
53
54 /**
55  * Define generic macro to set pins logic level
56  */
57 #define SIPO_SET_LEVEL_LOW(dev)    do { /* Implement me! */   } while (0)
58 #define SIPO_SET_LEVEL_HIGH(dev)   do { /* Implement me! */   } while (0)
59
60
61 /**
62  * Generate one low pulse on select line.
63  */
64 #define PULSE_LOW(dev)    do { /* Implement me! */   } while (0)
65
66 /**
67  * Generate one hight pulse on select line.
68  */
69 #define PULSE_HIGH(dev)     do { /* Implement me! */   } while (0)
70
71
72 /**
73  * Define the procedure to drive serial input in sipo device (SI).
74  */
75 #define SIPO_SI_HIGH()   do { /* Implement me! */   } while (0)
76 #define SIPO_SI_LOW()    do { /* Implement me! */   } while (0)
77
78 /**
79  * Drive clock to shift SI data into latch.
80  */
81 #define SIPO_SI_CLOCK(clk_pol) \
82         do { \
83                 (void)clk_pol; \
84                 /* Implement me! */ \
85         } while (0)
86
87 /**
88  * Do everything needed in order to load dato into sipo.
89  */
90 #define SIPO_LOAD(device, load_pol)   do { /* Implement me! */   } while (0)
91
92 /**
93  * Enable the shift register output.
94  */
95 #define SIPO_ENABLE()             do { /* Implement me! */   } while (0)
96
97 /**
98  * Set polarity for Load, Clk, SI signals.
99  */
100 #define SIPO_SET_LD_LEVEL(device, load_pol)  do { /* Implement me! */   } while (0)
101 #define SIPO_SET_CLK_LEVEL(clock_pol)        do { /* Implement me! */   } while (0)
102 #define SIPO_SET_SI_LEVEL()       do { /* Implement me! */   } while (0)
103
104 /**
105  * Do anything that needed to init sipo pins.
106  */
107 #define SIPO_INIT_PIN()           do { /* Implement me! */   } while (0)
108
109 #endif /* HW_SIPO_H */