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 slicelen);
  68 typedef void (*DmaStopFunc_t) (struct Dac *dac);
  69
  70 typedef struct DacContext
  71 {
  72         DacWriteFunc_t write;
  73         SetChannelMaskFunc_t setCh;
  74         SetSamplingRate_t setSampleRate;
  75         DmaConversionBufFunc_t conversion;
  76         DmaConversionIsFinished_t isFinished;
  77         DmaStartStreamingFunc_t start;
  78         DmaStopFunc_t stop;
  79         size_t slicelen;
  80
  81         DB(id_t _type);
  82
  83 } DacContext;
  84
  85 typedef struct Dac
  86 {
  87         DacContext ctx;
  88         struct DacHardware *hw;
  89 } Dac;
  90
  91 INLINE int dac_write(Dac *dac, unsigned channel, uint16_t sample)
  92 {
  93         ASSERT(dac->ctx.write);
  94         return dac->ctx.write(dac, channel, sample);
  95 }
  96
  97 INLINE void dac_setChannelMask(struct Dac *dac, uint32_t mask)
  98 {
  99         ASSERT(dac->ctx.setCh);
 100         dac->ctx.setCh(dac, mask);
 101 }
 102
 103 INLINE void dac_setSamplingRate(Dac *dac, uint32_t rate)
 104 {
 105         ASSERT(dac->ctx.setSampleRate);
 106         dac->ctx.setSampleRate(dac, rate);
 107 }
 108
 109 /**
 110  * Convert \param len samples stored into \param buf.
 111  */
 112 INLINE void dac_dmaConversionBuffer(Dac *dac, void *buf, size_t len)
 113 {
 114         ASSERT(dac->ctx.conversion);
 115         dac->ctx.conversion(dac, buf, len);
 116 }
 117
 118 /**
 119  * Check if a dma transfer is finished.
 120  *
 121  * Useful for kernel-less applications.
 122  */
 123 INLINE bool dac_dmaIsFinished(Dac *dac)
 124 {
 125         ASSERT(dac->ctx.isFinished);
 126         return dac->ctx.isFinished(dac);
 127 }
 128
 129 /**
 130  * \param slicelen Must be a divisor of len, ie. len % slicelen == 0.
 131  */
 132 INLINE void dac_dmaStartStreaming(Dac *dac, void *buf, size_t len, size_t slicelen)
 133 {
 134         ASSERT(dac->ctx.start);
 135         ASSERT(len % slicelen == 0);
 136         dac->ctx.slicelen = slicelen;
 137         dac->ctx.start(dac, buf, len, slicelen);
 138 }
 139
 140 INLINE void dac_dmaStop(Dac *dac)
 141 {
 142         ASSERT(dac->ctx.stop);
 143         dac->ctx.stop(dac);
 144 }
 145
 146 #define dac_bits() DAC_BITS
 147
 148 void dac_init(Dac *dac);
 149
 150 /** \} */ //defgroup dac
 151 #endif /* DRV_DAC_H */