Subversion Repositories idreammicro-avr

/**************************************************************************//**
 * \brief ADC library.
 * \author Copyright (C) 2012  Julien Le Sech - www.idreammicro.com
 * \version 1.0
 * \date 20121029
 *
 * This file is part of the iDreamMicro library.
 *
 * This library is free software: you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation, either version 3 of the License, or (at your option) any
 * later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see http://www.gnu.org/licenses/
 ******************************************************************************/

/**************************************************************************//**
 * \headerfile adc.h
 ******************************************************************************/

#ifndef H__IDREAMMICRO__ADC__H
#define H__IDREAMMICRO__ADC__H

#ifdef _cplusplus
extern "C"{
#endif

/******************************************************************************
 * Header file inclusions.
 ******************************************************************************/

#include <stdint.h>

/******************************************************************************
 * Public type definitions.
 ******************************************************************************/

/**************************************************************************//**
 * \enum    adc__channels
 * \brief   ADC channels.
 *
 * \typedef adc__channel_t
 * \brief   ADC channel.
 ******************************************************************************/
typedef enum adc__channels
{
    ADC__CHANNEL_0, /*!<  Channel 0. */
    ADC__CHANNEL_1, /*!<  Channel 1. */
    ADC__CHANNEL_2, /*!<  Channel 2. */
    ADC__CHANNEL_3, /*!<  Channel 3. */
    ADC__CHANNEL_4, /*!<  Channel 4. */
    ADC__CHANNEL_5, /*!<  Channel 5. */
    ADC__CHANNEL_6, /*!<  Channel 6. */
    ADC__CHANNEL_7, /*!<  Channel 7. */
    ADC__CHANNEL_8  /*!<  Channel 8. */
} adc__channel_t;

/******************************************************************************
 * Public function prototypes.
 ******************************************************************************/

/**************************************************************************//**
 * \fn void adc__single_channel_initialize(adc__channel_t channel)
 *
 * \brief Initialize ADC.
 *
 * \param channel   ADC channel.
 ******************************************************************************/
void
adc__single_channel_initialize
(
    adc__channel_t channel
);

/**************************************************************************//**
 * \fn uint16_t adc__single_channel_read(void)
 *
 * \brief Read ADC.
 *
 * \return Read value.
 ******************************************************************************/
uint16_t
adc__single_channel_read
(
    void
);

#ifdef _cplusplus
}
#endif

#endif /* H__IDREAMMICRO__ADC__H */