LUFA/Drivers/Peripheral/ADC.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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 disclaim 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  *
  33  *  This file is the master dispatch header file for the device-specific ADC driver, for AVRs containing an ADC.
  34  *
  35  *  User code should include this file, which will in turn include the correct ADC driver header file for the
  36  *  currently selected AVR model.
  37  */
  38
  39 /** \ingroup Group_PeripheralDrivers
  40  *  @defgroup Group_ADC ADC Driver - LUFA/Drivers/Peripheral/ADC.h
  41  *
  42  *  \section Sec_Dependencies Module Source Dependencies
  43  *  The following files must be built with any user project that uses this module:
  44  *    - None
  45  *
  46  *  \section Module Description
  47  *  Hardware ADC driver. This module provides an easy to use driver for the hardware
  48  *  ADC present on many AVR models, for the conversion of analogue signals into the
  49  *  digital domain.
  50  */
  51
  52 #ifndef __ADC_H__
  53 #define __ADC_H__
  54
  55         /* Macros: */
  56         #if !defined(__DOXYGEN__)
  57                 #define INCLUDE_FROM_ADC_H
  58                 #define INCLUDE_FROM_CHIP_DRIVER
  59         #endif
  60
  61         /* Includes: */
  62                 #if (defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB646__) || \
  63                      defined(__AVR_AT90USB1287__) || defined(__AVR_AT90USB647__) || \
  64                          defined(__AVR_ATmega16U4__)  || defined(__AVR_ATmega32U4__) || \
  65                          defined(__AVR_ATmega32U6__))
  66                         #include "AVRU4U6U7/ADC.h"
  67                 #else
  68                         #error "ADC is not available for the currently selected AVR model."
  69                 #endif
  70
  71 #endif