tmk_core/protocol/lufa/LUFA-git/LUFA/Drivers/Peripheral/ADC.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2014.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2014  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaims all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *  \brief Hardware Analogue-to-Digital converter driver.
  33  *
  34  *  This file is the master dispatch header file for the device-specific ADC driver, for microcontrollers
  35  *  containing an ADC.
  36  *
  37  *  User code should include this file, which will in turn include the correct ADC driver header file for the
  38  *  currently selected architecture and microcontroller model.
  39  */
  40
  41 /** \ingroup Group_PeripheralDrivers
  42  *  \defgroup Group_ADC ADC Driver - LUFA/Drivers/Peripheral/ADC.h
  43  *  \brief Hardware Analogue-to-Digital converter driver.
  44  *
  45  *  \section Sec_ADC_Dependencies Module Source Dependencies
  46  *  The following files must be built with any user project that uses this module:
  47  *    - None
  48  *
  49  *  \section Sec_ADC_ModDescription Module Description
  50  *  Hardware ADC driver. This module provides an easy to use driver for the hardware ADC
  51  *  present on many microcontrollers, for the conversion of analogue signals into the
  52  *  digital domain.
  53  *
  54  *  \note The exact API for this driver may vary depending on the target used - see
  55  *        individual target module documentation for the API specific to your target processor.
  56  */
  57
  58 #ifndef __ADC_H__
  59 #define __ADC_H__
  60
  61         /* Macros: */
  62                 #define __INCLUDE_FROM_ADC_H
  63
  64         /* Includes: */
  65                 #include "../../Common/Common.h"
  66
  67         /* Includes: */
  68                 #if (ARCH == ARCH_AVR8)
  69                         #include "AVR8/ADC_AVR8.h"
  70                 #else
  71                         #error The ADC peripheral driver is not currently available for your selected architecture.
  72                 #endif
  73
  74 #endif
  75