Add missing declaration.
[bertos.git] / bertos / drv / 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 2009 Develer S.r.l. (http://www.develer.com/)
30  *
31  * -->
32  *
33  * \brief Generic Serial-in, Parallel-out implementation (SIPO).
34  *
35  *
36  * \version $Id$
37  *
38  * \author Andrea Grandi <andrea@develer.com>
39  * \author Daniele Basile <asterix@develer.com>
40  *
41  * $WIZ$ module_name = "sipo"
42  * $WIZ$ module_depends = "kfile"
43  * $WIZ$ module_hw = "bertos/hw/hw_sipo.h"
44  */
45
46
47
48
49
50 #ifndef DRV_SIPO_H
51 #define DRV_SIPO_H
52
53 #include "hw/hw_sipo.h"
54
55 #include <kern/kfile.h>
56
57 #define SIPO_DATAORDER_START_LSB        1
58 #define SIPO_DATAORDER_START_MSB     0x80
59
60 /**
61  * Define enum to set sipo data order.
62  */
63 typedef enum SipoBitOrder
64 {
65         SIPO_DATAORDER_MSB = 0,
66         SIPO_DATAORDER_LSB = 1
67 } SipoBitOrder;
68
69 /**
70  * Define enum to set the start level of clock.
71  */
72 typedef enum SipoClockPol
73 {
74         SIPO_START_LOW = 0,
75         SIPO_START_HIGH = 1
76
77 } SipoClkPol;
78
79 /**
80  * Define enum to set load signal level.
81  */
82 typedef enum SipoLoadPol
83 {
84         SIPO_LOW_TO_HIGH = 0,
85         SIPO_HIGH_TO_LOW = 1
86
87 } SipoLoadPol;
88
89 /**
90  * Map sipo connection on board.
91  */
92 typedef enum SipoMap
93 {
94         SIPO_CNT
95 } SipoMap;
96
97 /**
98  * Sipo KFile context structure.
99  */
100 typedef struct Sipo
101 {
102         KFile fd;                 ///< File descriptor.
103         SipoMap load_device;      ///< Descriptor of the device that we want drive.
104         SipoLoadPol load_pol;     ///< Set polarity of load signal.
105         SipoClkPol clock_pol;     ///< Set polarity of data clock.
106         SipoBitOrder bit_order;   ///< Set the order of pushed bits in sipo.
107
108 } Sipo;
109
110 /**
111  * ID for sipo.
112  */
113 #define KFT_SIPO MAKE_ID('S', 'I', 'P', 'O')
114
115 /**
116  * Convert + ASSERT from generic KFile to Sipo.
117  */
118 INLINE Sipo * SIPO_CAST(KFile *fd)
119 {
120         ASSERT(fd->_type == KFT_SIPO);
121         return (Sipo *)fd;
122 }
123
124 void sipo_init(Sipo *fd);
125
126 #endif // DRV_SIPO_H
127