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