LUFA/Drivers/Peripheral/Serial.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 USART peripheral driver.
  33  *
  34  *  This file is the master dispatch header file for the device-specific USART driver, for microcontrollers
  35  *  containing a hardware USART.
  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_Serial Serial USART Driver - LUFA/Drivers/Peripheral/Serial.h
  43  *
  44  *  \section Sec_Dependencies Module Source Dependencies
  45  *  The following files must be built with any user project that uses this module:
  46  *    - LUFA/Drivers/Peripheral/<i>ARCH</i>/Serial.c <i>(Makefile source module name: LUFA_SRC_SERIAL)</i>
  47  *
  48  *  \section Sec_ModDescription Module Description
  49  *  Hardware serial USART driver. This module provides an easy to use driver for the setup and transfer
  50  *  of data over the selected architecture and microcontroller model's USART port.
  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 __SERIAL_H__
  57 #define __SERIAL_H__
  58
  59         /* Macros: */
  60                 #if !defined(__DOXYGEN__)
  61                         #define __INCLUDE_FROM_SERIAL_H
  62                 #endif
  63
  64         /* Includes: */
  65                 #include "../../Common/Common.h"
  66
  67         /* Includes: */
  68                 #if (ARCH == ARCH_AVR8)
  69                         #include "AVR8/Serial.h"
  70                 #else
  71                         #error The Serial peripheral driver is not currently available for your selected architecture.
  72                 #endif
  73
  74 #endif