Reformat.
[bertos.git] / bertos / drv / sipo.c
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 2009 Develer S.r.l. (http://www.develer.com/)
30  *
31  * -->
32  *
33  * \version $Id$
34  *
35  * \brief SIPO Module
36  *
37  * The SIPO module transforms a serial input in a parallel output. Please check hw_sipo.h
38  * file to customize hardware related parameters.
39  *
40  * \author Andrea Grandi <andrea@develer.com>
41  * \author Daniele Basile <asterix@develer.com>
42  */
43
44 #include "sipo.h"
45
46 #include "hw/hw_sipo.h"
47
48 #include <cfg/compiler.h>
49 #include <cfg/log.h>
50
51 #include <kern/kfile.h>
52
53 #include <string.h>
54
55
56 #define SIPO_DATAORDER_START(order)          (order ? SIPO_DATAORDER_START_LSB : SIPO_DATAORDER_START_MSB)
57 #define SIPO_DATAORDER_SHIFT(shift, order)   (order ?  ((shift) <<= 1) : ((shift) >>= 1))
58
59 /**
60  * Write a char in sipo shift register
61  */
62 INLINE void sipo_putchar(uint8_t c, uint8_t bit_order, uint8_t clock_pol)
63 {
64         uint8_t shift = SIPO_DATAORDER_START(bit_order);
65
66         for(int i = 0; i < 8; i++)
67         {
68                 if((c & shift) == 0)
69                         SIPO_SI_LOW();
70                 else
71                         SIPO_SI_HIGH();
72
73                 SIPO_SI_CLOCK(clock_pol);
74
75                 SIPO_DATAORDER_SHIFT(shift, bit_order);
76         }
77 }
78
79 /**
80  * Write a buffer into the sipo register and, when finished, give a load pulse.
81  */
82 static size_t sipo_write(struct KFile *_fd, const void *_buf, size_t size)
83 {
84         const uint8_t *buf = (const uint8_t *)_buf;
85         Sipo *fd = SIPO_CAST(_fd);
86         size_t write_len = size;
87
88         ASSERT(buf);
89
90         SIPO_SET_SI_LEVEL();
91         SIPO_SET_CLK_LEVEL(fd->clock_pol);
92         SIPO_SET_LD_LEVEL(fd->load_device, fd->load_pol);
93
94         // Load into the shift register all the buffer bytes
95         while(size--)
96                 sipo_putchar(*buf++, fd->bit_order, fd->clock_pol);
97
98         // We finsh to load bytes, so load it.
99         SIPO_LOAD(fd->load_device, fd->load_pol);
100
101         return write_len;
102 }
103
104 /**
105  * Initialize the SIPO
106  */
107 void sipo_init(Sipo *fd)
108 {
109         ASSERT(fd);
110
111         memset(fd, 0, sizeof(Sipo));
112
113         //Set kfile struct type as a generic kfile structure.
114         DB(fd->fd._type = KFT_SIPO);
115
116         // Set up SIPO writing functions.
117         fd->fd.write = sipo_write;
118
119         SIPO_INIT_PIN();
120
121         /* Enable sipo output */
122         SIPO_ENABLE();
123 }