Comply to new sipo drv.
[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 /**
51  *  * Mapping sipo connection on board.
52  *   * See scheme to more info.
53  *    */
54 typedef enum SipoMap
55 {
56         TRIFACE_DOUT = 0,
57
58         SIPO_CNT
59 } SipoMap;
60
61
62
63 //Set output pin for sipo
64 #define SCK_OUT            (DDRB |= BV(PB1))  // Shift register clock input pin
65 #define SOUT_OUT           (DDRB |= BV(PB2))  // Serial data input pin
66 #define SLOAD_OUT          (DDRB |= BV(PB3))  // Storage register clock input pin
67 #define OE_OUT             (DDRG |= BV(PG3))  // Output enable pin
68
69 //Define output level
70 #define SCK_HIGH           (PORTB |= BV(PB1))
71 #define SCK_LOW            (PORTB &= ~BV(PB1))
72 #define SOUT_OUT_HIGH      (PORTB |= BV(PB2))
73 #define SOUT_OUT_LOW       (PORTB &= ~BV(PB2))
74 #define SLOAD_OUT_HIGH     (PORTB |= BV(PB3))
75 #define SLOAD_OUT_LOW      (PORTB &= ~BV(PB3))
76 #define OE_LOW             (PORTG &= BV(PG3))
77
78 /**
79  * Define the macros needed to set the serial input bit of SIPO device
80  * low or high.
81  */
82 #define SIPO_SI_HIGH()    SOUT_OUT_HIGH
83 #define SIPO_SI_LOW()     SOUT_OUT_LOW
84
85 /**
86  * Drive pin to load the bit, presented in serial-in pin,
87  * into sipo shift register.
88  */
89 #define SIPO_SI_CLOCK(clk_pol) \
90         do{ \
91                 (void)clk_pol; \
92                 SCK_HIGH; \
93                 SCK_LOW; \
94         }while(0)
95
96 /**
97  * Clock the content of shift register to output.
98  */
99 #define SIPO_LOAD(device, load_pol) \
100         do { \
101                 (void)device; \
102                 (void)load_pol; \
103                 SLOAD_OUT_HIGH; \
104                 SLOAD_OUT_LOW; \
105         }while(0)
106
107 /**
108  * Enable the shift register output.
109  */
110 #define SIPO_ENABLE() OE_LOW;
111
112 /**
113  * Set logic level for load signal
114  */
115 #define SIPO_SET_LD_LEVEL(device, load_pol) \
116         do { \
117                 (void)device; \
118                 if(load_pol) \
119                         SLOAD_OUT_HIGH; \
120                 else \
121                         SLOAD_OUT_LOW; \
122         } while (0)
123
124
125 /**
126  * Sel logic level for clock signal
127  */
128 #define SIPO_SET_CLK_LEVEL(clock_pol) \
129         do { \
130                 if(clock_pol) \
131                         SCK_HIGH; \
132                 else \
133                         SCK_LOW; \
134         } while (0)
135
136 #define SIPO_SET_SI_LEVEL()     SIPO_SI_LOW()
137
138 /**
139  * Do everything needed in order to init the SIPO pins.
140  */
141 #define SIPO_INIT_PIN() \
142         do { \
143                 OE_OUT; \
144                 SOUT_OUT; \
145                 SCK_OUT; \
146                 SLOAD_OUT; \
147                 SIPO_ENABLE(); \
148         } while(0)
149
150
151 #endif /* HW_SIPO_H */