82dce48828f18e1b55c428b5c1224fdeb66afad4
[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  * Define the macros needed to set the serial input bit of SIPO device
51  * low or high.
52  */
53 #define SIPO_SI_HIGH()/* Implement me! */
54 #define SIPO_SI_LOW() /* Implement me! */
55
56 /**
57  * Drive pin to load the bit, presented in serial-in pin,
58  * into sipo shift register.
59  */
60 #define SIPO_SI_CLOCK() /* Implement me! */
61
62 /**
63  * Clock the content of shift register to output.
64  */
65 #define SIPO_LOAD()   /* Implement me! */
66
67 /**
68  * Enable the shift register output.
69  */
70 #define SIPO_ENABLE() /* Implement me! */
71
72
73 /**
74  * Do everything needed in order to init the SIPO pins.
75  */
76 #define SIPO_INIT_PIN() \
77         do { \
78                 /* Implement me! */ \
79         } while(0)
80
81 #endif /* HW_SIPO_H */