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