bertos/drv/adc.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 2005 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \version $Id$
  34  *
  35  * \brief Analog to Digital Converter driver (ADC).
  36  *
  37  * \version $Id$
  38  * \author Francesco Sacchi <batt@develer.com>
  39  *
  40  * $WIZARD_MODULE = {
  41  * "name" : "adc",
  42  * "depends" : [],
  43  * "configuration" : "bertos/cfg/cfg_adc.h"
  44  * }
  45  */
  46
  47
  48 #ifndef DRV_ADC_H
  49 #define DRV_ADC_H
  50
  51 #include <cfg/compiler.h>
  52 #include <cfg/debug.h>
  53 #include <cpu/attr.h>
  54 #include CPU_HEADER(adc)
  55
  56 /** Type for ADC return value. */
  57 typedef uint16_t adcread_t;
  58
  59 /** Type for channel */
  60 typedef uint8_t adc_ch_t;
  61
  62 #define adc_bits() ADC_BITS
  63
  64 adcread_t adc_read(adc_ch_t ch);
  65 void adc_init(void);
  66
  67 /**
  68  * Macro used to convert data from adc range (0...(2 ^ADC_BITS - 1)) to
  69  * \a y1 ... \a y2 range.
  70  * \note \a y1, \a y2 can be negative, and put in ascending or descending order as well.
  71  * \note \a data and \a y2 are evaluated only once, \a y1 twice.
  72  */
  73 #define ADC_RANGECONV(data, y1, y2) (((((int32_t)(data)) * ((y2) - (y1))) / ((1 << ADC_BITS) - 1)) + (y1))
  74
  75 #endif /* DRV_ADC_H */