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