LUFA/Drivers/Peripheral/Serial.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  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  *
  33  *  This file is the master dispatch header file for the device-specific USART driver, for AVRs containing a
  34  *  USART.
  35  *
  36  *  User code should include this file, which will in turn include the correct USART driver header file for
  37  *  the currently selected AVR model.
  38  */
  39
  40 /** \ingroup Group_PeripheralDrivers
  41  *  @defgroup Group_Serial Serial USART Driver - LUFA/Drivers/Peripheral/Serial.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/Serial.c
  46  *
  47  *  \section Module Description
  48  *  Hardware serial USART driver. This module provides an easy to use driver for
  49  *  the setup of and transfer of data over the AVR's USART port.
  50  *
  51  *  @{
  52  */
  53
  54 #ifndef __SERIAL_H__
  55 #define __SERIAL_H__
  56
  57         /* Macros: */
  58         #if !defined(__DOXYGEN__)
  59                 #define __INCLUDE_FROM_SERIAL_H
  60         #endif
  61
  62         /* Includes: */
  63                 #include "../../Common/Common.h"
  64                 #include "../Misc/TerminalCodes.h"
  65
  66                 #if defined(__AVR32__)
  67                         #include "AVR32/Serial.h"
  68                 #elif defined(__AVR__)
  69                         #include "AVR8/Serial.h"
  70                 #endif
  71
  72         /* Enable C linkage for C++ Compilers: */
  73                 #if defined(__cplusplus)
  74                         extern "C" {
  75                 #endif
  76
  77         /* Public Interface - May be used in end-application: */
  78                 /* Function Prototypes: */
  79                         /** Transmits a given string located in program space (FLASH) through the USART.
  80                          *
  81                          *  \param[in] FlashStringPtr  Pointer to a string located in program space
  82                          */
  83                         void Serial_TxString_P(const char *FlashStringPtr) ATTR_NON_NULL_PTR_ARG(1);
  84
  85                         /** Transmits a given string located in SRAM memory through the USART.
  86                          *
  87                          *  \param[in] StringPtr  Pointer to a string located in SRAM space
  88                          */
  89                         void Serial_TxString(const char *StringPtr) ATTR_NON_NULL_PTR_ARG(1);
  90
  91         /* Disable C linkage for C++ Compilers: */
  92                 #if defined(__cplusplus)
  93                         }
  94                 #endif
  95
  96 #endif
  97
  98 /** @} */