LUFA/Drivers/Peripheral/TWI.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  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 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  *  \brief Master include file for the TWI peripheral driver.
  33  *
  34  *  This file is the master dispatch header file for the device-specific ADC driver, for AVRs containing an ADC.
  35  *
  36  *  User code should include this file, which will in turn include the correct ADC driver header file for the
  37  *  currently selected AVR model.
  38  */
  39
  40 /** \ingroup Group_PeripheralDrivers
  41  *  @defgroup Group_TWI TWI Driver - LUFA/Drivers/Peripheral/TWI.h
  42  *
  43  *  \section Sec_Dependencies Module Source Dependencies
  44  *  The following files must be built with any user project that uses this module:
  45  *    - LUFA/Drivers/Peripheral/TWI.c <i>(Makefile source module name: LUFA_SRC_TWI)</i>
  46  *
  47  *
  48  *  \section Sec_ModDescription Module Description
  49  *  Master Mode Hardware TWI driver. This module provides an easy to use driver for the hardware
  50  *  TWI present on many AVR models, for the transmission and reception of data on a TWI bus.
  51  *
  52  *  \note The exact API for this driver may vary depending on the target used - see
  53  *        individual target module documentation for the API specific to your target processor.
  54  */
  55
  56 #ifndef __TWI_H__
  57 #define __TWI_H__
  58
  59         /* Macros: */
  60         #if !defined(__DOXYGEN__)
  61                 #define __INCLUDE_FROM_TWI_H
  62         #endif
  63
  64         /* Includes: */
  65                 #if (defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB646__) || \
  66                      defined(__AVR_AT90USB1287__) || defined(__AVR_AT90USB647__) || \
  67                          defined(__AVR_ATmega16U4__)  || defined(__AVR_ATmega32U4__) || \
  68                          defined(__AVR_ATmega32U6__))
  69                         #include "AVRU4U6U7/TWI.h"
  70                 #else
  71                         #error "TWI is not available for the currently selected AVR model."
  72                 #endif
  73
  74 #endif
  75