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