Comply to log module.

[bertos.git] / bertos / hw / hw_sipo.h

diff --git a/bertos/hw/hw_sipo.h b/bertos/hw/hw_sipo.h
index 0fad43b86865c49e9f8906c0cd8609d9e202d3db..3371c2c0336eb6b8158a103aa3b11c3570d9a539 100644 (file)
--- a/bertos/hw/hw_sipo.h
+++ b/bertos/hw/hw_sipo.h
@@ -26,8 +26,8 @@
  * invalidate any other reasons why the executable file might be covered by
  * the GNU General Public License.
  *
- * Copyright 2003, 2004, 2006, 2008 Develer S.r.l. (http://www.develer.com/)
- * Copyright 2000 Bernardo Innocenti <bernie@codewiz.org>
+ * Copyright 2003, 2004, 2006, 2008, 2009 Develer S.r.l. (http://www.develer.com/)
+ * Copyright 2000 Bernie Innocenti <bernie@codewiz.org>
  * All Rights Reserved.
  * -->
  *
@@ -37,26 +37,73 @@
  * \version $Id$
  *
  * \author Andrea Grandi <andrea@develer.com>
+ * \author Daniele Basile <asterix@develer.com>
  */
 
 #ifndef HW_SIPO_H
 #define HW_SIPO_H
 
-#warning TODO:This is an example implementation, you must implement it!
+/**
+ * Map sipo connection on board.
+ */
+typedef enum SipoMap
+{
+       SIPO_CNT
+} SipoMap;
+
+/**
+ * Define generic macro to set pins logic level
+ */
+#define SIPO_SET_LEVEL_LOW(dev)    do { /* Implement me! */   } while (0)
+#define SIPO_SET_LEVEL_HIGH(dev)   do { /* Implement me! */   } while (0)
+
+
+/**
+ * Generate one low pulse on select line.
+ */
+#define PULSE_LOW(dev)    do { /* Implement me! */   } while (0)
+
+/**
+ * Generate one hight pulse on select line.
+ */
+#define PULSE_HIGH(dev)     do { /* Implement me! */   } while (0)
+
+
+/**
+ * Define the procedure to drive serial input in sipo device (SI).
+ */
+#define SIPO_SI_HIGH()   do { /* Implement me! */   } while (0)
+#define SIPO_SI_LOW()    do { /* Implement me! */   } while (0)
+
+/**
+ * Drive clock to shift SI data into latch.
+ */
+#define SIPO_SI_CLOCK(clk_pol) \
+       do { \
+               (void)clk_pol; \
+               /* Implement me! */ \
+       } while (0)
+
+/**
+ * Do everything needed in order to load dato into sipo.
+ */
+#define SIPO_LOAD(device, load_pol)   do { /* Implement me! */   } while (0)
 
-#define LOAD_HIGH       /* Implement me! */   
-#define LOAD_LOW        /* Implement me! */     
-#define LOAD_INIT       /* Implement me! */   
-#define SET_SCK_OUT     /* Implement me! */   
-#define SET_SOUT_OUT    /* Implement me! */   
-#define CLOCK_HIGH      /* Implement me! */   
-#define CLOCK_LOW       /* Implement me! */   
-#define SET_SOUT_HIGH   /* Implement me! */   
-#define SET_SOUT_LOW    /* Implement me! */   
-#define CLOCK_PULSE     /* Implement me! */   
+/**
+ * Enable the shift register output.
+ */
+#define SIPO_ENABLE()             do { /* Implement me! */   } while (0)
 
-#define OE_OUT        
-#define OE_LOW        
+/**
+ * Set polarity for Load, Clk, SI signals.
+ */
+#define SIPO_SET_LD_LEVEL(device, load_pol)  do { /* Implement me! */   } while (0)
+#define SIPO_SET_CLK_LEVEL(clock_pol)        do { /* Implement me! */   } while (0)
+#define SIPO_SET_SI_LEVEL()       do { /* Implement me! */   } while (0)
 
+/**
+ * Do anything that needed to init sipo pins.
+ */
+#define SIPO_INIT_PIN()           do { /* Implement me! */   } while (0)
 
 #endif /* HW_SIPO_H */