Add pwm pins set registers.
[bertos.git] / bertos / drv / dac.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 2011 Develer S.r.l. (http://www.develer.com/)
30  *
31  * -->
32  *
33  * \defgroup dac Generic DAC driver
34  * \ingroup drivers
35  * \{
36  * \brief Digital to Analog Converter driver (DAC).
37  *
38  * <b>Configuration file</b>: cfg_dac.h
39  *
40  * \author Daniele Basile <asterix@develer.com>
41  *
42  * $WIZ$ module_name = "dac"
43  * $WIZ$ module_configuration = "bertos/cfg/cfg_dac.h"
44  * $WIZ$ module_supports = "sam3x"
45  */
46
47
48 #ifndef DRV_DAC_H
49 #define DRV_DAC_H
50
51 #include <cfg/compiler.h>
52 #include <cfg/debug.h>
53 #include <cfg/macros.h>
54
55 #include <cpu/attr.h>
56
57 #include CPU_HEADER(dac)
58
59 struct DacContext;
60 struct Dac;
61
62 typedef int (*DacWriteFunc_t) (struct Dac *dac, unsigned channel, uint16_t sample);
63 typedef void (*SetChannelMaskFunc_t) (struct Dac *dac, uint32_t mask);
64 typedef void (*SetSamplingRate_t) (struct Dac *dac, uint32_t rate);
65 typedef void (*DmaConversionBufFunc_t) (struct Dac *dac, void *buf, size_t len);
66 typedef bool (*DmaConversionIsFinished_t) (struct Dac *dac);
67 typedef void (*DmaStartStreamingFunc_t) (struct Dac *dac, void *buf, size_t len, size_t slice_len);
68 typedef void (*DmaStopFunc_t) (struct Dac *dac);
69 typedef void (*DmaCallbackFunc_t) (struct Dac *dac, void *_buf, size_t len);
70
71 typedef struct DacContext
72 {
73         DacWriteFunc_t write;
74         SetChannelMaskFunc_t setCh;
75         SetSamplingRate_t setSampleRate;
76         DmaConversionBufFunc_t conversion;
77         DmaConversionIsFinished_t isFinished;
78         DmaStartStreamingFunc_t start;
79         DmaStopFunc_t stop;
80         DmaCallbackFunc_t callback;
81         size_t slice_len;
82
83         DB(id_t _type);
84
85 } DacContext;
86
87 typedef struct Dac
88 {
89         DacContext ctx;
90         struct DacHardware *hw;
91 } Dac;
92
93 INLINE int dac_write(Dac *dac, unsigned channel, uint16_t sample)
94 {
95         ASSERT(dac->ctx.write);
96         return dac->ctx.write(dac, channel, sample);
97 }
98
99 INLINE void dac_setChannelMask(struct Dac *dac, uint32_t mask)
100 {
101         ASSERT(dac->ctx.setCh);
102         dac->ctx.setCh(dac, mask);
103 }
104
105 INLINE void dac_setSamplingRate(Dac *dac, uint32_t rate)
106 {
107         ASSERT(dac->ctx.setSampleRate);
108         dac->ctx.setSampleRate(dac, rate);
109 }
110
111 /*
112  * Convert \param len samples stored into \param buf.
113  */
114 INLINE void dac_dmaConversionBuffer(Dac *dac, void *buf, size_t len)
115 {
116         ASSERT(dac->ctx.conversion);
117         dac->ctx.conversion(dac, buf, len);
118 }
119
120 /*
121  * Check if a dma transfer is finished.
122  *
123  * Useful for kernel-less applications.
124  */
125 INLINE bool dac_dmaIsFinished(Dac *dac)
126 {
127         ASSERT(dac->ctx.isFinished);
128         return dac->ctx.isFinished(dac);
129 }
130
131 /*
132  * \param slicelen Must be a divisor of len, ie. len % slicelen == 0.
133  */
134 INLINE void dac_dmaStartStreaming(Dac *dac, void *buf, size_t len, size_t slice_len, DmaCallbackFunc_t callback)
135 {
136         ASSERT(dac->ctx.start);
137         ASSERT(len % slice_len == 0);
138         ASSERT(callback);
139
140         dac->ctx.callback = callback;
141         dac->ctx.slice_len = slice_len;
142         dac->ctx.start(dac, buf, len, slice_len);
143 }
144
145 INLINE void dac_dmaStop(Dac *dac)
146 {
147         ASSERT(dac->ctx.stop);
148         dac->ctx.stop(dac);
149 }
150
151 #define dac_bits() DAC_BITS
152
153 void dac_init(Dac *dac);
154
155 /** \} */ //defgroup dac
156 #endif /* DRV_DAC_H */