Fix hw SIPO macro declaration.
[bertos.git] / bertos / 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 #warning TODO:This is an example implementation, you must implement it!
47
48
49 /**
50  * Mapping sipo connection on board.
51  * See scheme to more info.
52  */
53 typedef enum SipoMap {
54
55         /* Add device here */
56
57         SIPO_CNT
58 } SipoMap;
59
60
61 /**
62  * Define the macros needed to set the serial input bit of SIPO device
63  * low or high.
64  */
65 #define SIPO_SI_HIGH() do { /* Implement me! */ } while (0)
66 #define SIPO_SI_LOW()  do { /* Implement me! */ } while (0)
67
68 /**
69  * Drive pin to load the bit, presented in serial-in pin,
70  * into sipo shift register.
71  */
72 #define SIPO_SI_CLOCK(clk_pol) \
73         do { \
74                 /* Implement me! */ \
75                 (void)clk_pol; \
76         } while (0)
77
78 /**
79  * Clock the content of shift register to output.
80  */
81 #define SIPO_LOAD(device, load_pol)  \
82         do { \
83                 /* Implement me! */ \
84                 (void)device; \
85                 (void)load_pol; \
86         } while (0)
87
88 /**
89  * Enable the shift register output.
90  */
91 #define SIPO_ENABLE() /* Implement me! */
92
93 /**
94  * Set logic level for load signal
95  */
96 #define SIPO_SET_LD_LEVEL(device, load_pol) \
97         do { \
98                 /* Implement me! */ \
99                 (void)device; \
100                 (void)load_pol; \
101         } while (0)
102
103
104 /**
105  * Sel logic level for clock signal
106  */
107 #define SIPO_SET_CLK_LEVEL(clock_pol)  \
108         do { \
109                 /* Implement me! */ \
110                 (void)clock_pol; \
111         } while (0)
112
113
114 /**
115  * Do everything needed in order to init the SIPO pins.
116  */
117 #define SIPO_INIT_PIN() \
118         do { \
119                 /* Implement me! */ \
120         } while(0)
121
122 #endif /* HW_SIPO_H */