tmk_core/protocol/lufa/LUFA-git/LUFA/Drivers/Peripheral/TWI.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 Two Wire Interface (I2C) driver.
  33  *
  34  *  This file is the master dispatch header file for the device-specific SPI driver, for microcontrollers
  35  *  containing a hardware TWI.
  36  *
  37  *  User code should include this file, which will in turn include the correct TWI driver header file for the
  38  *  currently selected architecture and microcontroller model.
  39  */
  40
  41 /** \ingroup Group_PeripheralDrivers
  42  *  \defgroup Group_TWI TWI Driver - LUFA/Drivers/Peripheral/TWI.h
  43  *  \brief Hardware Two Wire Interface (I2C) driver.
  44  *
  45  *  \section Sec_TWI_Dependencies Module Source Dependencies
  46  *  The following files must be built with any user project that uses this module:
  47  *    - LUFA/Drivers/Peripheral/<i>ARCH</i>/TWI_<i>ARCH</i>.c <i>(Makefile source module name: LUFA_SRC_TWI)</i>
  48  *
  49  *  \section Sec_TWI_ModDescription Module Description
  50  *  Hardware TWI driver. This module provides an easy to use driver for the setup and transfer of data over
  51  *  the selected architecture and microcontroller model's TWI bus port.
  52  *
  53  *  \note The exact API for this driver may vary depending on the target used - see
  54  *        individual target module documentation for the API specific to your target processor.
  55  */
  56
  57 #ifndef __TWI_H__
  58 #define __TWI_H__
  59
  60         /* Macros: */
  61                 #define __INCLUDE_FROM_TWI_H
  62
  63         /* Includes: */
  64                 #include "../../Common/Common.h"
  65
  66         /* Includes: */
  67                 #if (ARCH == ARCH_AVR8)
  68                         #include "AVR8/TWI_AVR8.h"
  69                 #elif (ARCH == ARCH_XMEGA)
  70                         #include "XMEGA/TWI_XMEGA.h"
  71                 #else
  72                         #error The TWI peripheral driver is not currently available for your selected architecture.
  73                 #endif
  74
  75 #endif
  76