f31497f27543a68448cf41f95e0d72f44689a5ae
[bertos.git] / examples / triface / 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, 2009 Develer S.r.l. (http://www.develer.com/)
30  * Copyright 2000 Bernie Innocenti <bernie@codewiz.org>
31  *
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 #include <cfg/macros.h>
47
48 #include <avr/io.h>
49
50 //Set output pin for sipo
51 #define SCK_OUT            (DDRB |= BV(PB1))  // Shift register clock input pin
52 #define SOUT_OUT           (DDRB |= BV(PB2))  // Serial data input pin
53 #define SLOAD_OUT          (DDRB |= BV(PB3))  // Storage register clock input pin
54 #define OE_OUT             (DDRG |= BV(PG3))  // Output enable pin
55
56 //Define output level
57 #define SCK_HIGH           (PORTB |= BV(PB1))
58 #define SCK_LOW            (PORTB &= ~BV(PB1))
59 #define SOUT_OUT_HIGH      (PORTB |= BV(PB2))
60 #define SOUT_OUT_LOW       (PORTB &= ~BV(PB2))
61 #define SLOAD_OUT_HIGH     (PORTB |= BV(PB3))
62 #define SLOAD_OUT_LOW      (PORTB &= ~BV(PB3))
63 #define OE_LOW             (PORTG &= BV(PG3))
64
65 /**
66  * Define the macros needed to set the serial input bit of SIPO device
67  * low or high.
68  */
69 #define SIPO_SI_HIGH()    SOUT_OUT_HIGH
70 #define SIPO_SI_LOW()     SOUT_OUT_LOW
71
72 /**
73  * Drive pin to load the bit, presented in serial-in pin,
74  * into sipo shift register.
75  */
76 #define SIPO_SI_CLOCK() \
77         do{ \
78                 SCK_HIGH; \
79                 SCK_LOW; \
80         }while(0)
81
82 /**
83  * Clock the content of shift register to output.
84  */
85 #define SIPO_LOAD() \
86         do { \
87                 SLOAD_OUT_HIGH; \
88                 SLOAD_OUT_LOW; \
89         }while(0)
90
91 /**
92  * Enable the shift register output.
93  */
94 #define SIPO_ENABLE() OE_LOW;
95
96
97 /**
98  * Do everything needed in order to init the SIPO pins.
99  */
100 #define SIPO_INIT_PIN() \
101         do { \
102                 OE_OUT; \
103                 SOUT_OUT; \
104                 SCK_OUT; \
105                 SLOAD_OUT; \
106                 SIPO_ENABLE(); \
107         } while(0)
108
109
110 #endif /* HW_SIPO_H */