LUFA/Drivers/Peripheral/SerialStream.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  *  \brief Standard avr-libc character stream driver for the USART.
  33  *
  34  *  Serial stream driver for the USART subsystem on supported USB AVRs. This makes use of the functions in the
  35  *  regular USART driver (see \ref Group_Serial), but allows the avr-libc standard stream functions (printf,
  36  *  puts, etc.) to work with the
  37  *  USART.
  38  */
  39
  40 /** \ingroup Group_PeripheralDrivers
  41  *  @defgroup Group_SerialStream Serial Stream Driver - LUFA/Drivers/Peripheral/SerialStream.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/SerialStream.c <i>(Makefile source module name: LUFA_SRC_SERIALSTREAM)</i>
  46  *
  47  *  \section Module Description
  48  *  Serial stream driver for the USART subsystem on supported USB AVRs. This makes use of the functions in the
  49  *  regular USART driver (see \ref Group_Serial), but allows the avr-libc standard stream functions (printf,
  50  *  puts, etc.) to work with the
  51  *  USART.
  52  *
  53  *  @{
  54  */
  55
  56 #ifndef __SERIAL_STREAM_H__
  57 #define __SERIAL_STREAM_H__
  58
  59         /* Includes: */
  60                 #include <avr/io.h>
  61                 #include <stdio.h>
  62
  63                 #include "Serial.h"
  64
  65         /* Enable C linkage for C++ Compilers: */
  66                 #if defined(__cplusplus)
  67                         extern "C" {
  68                 #endif
  69
  70         /* Private Interface - For use in library only: */
  71         #if !defined(__DOXYGEN__)
  72                 /* External Variables: */
  73                         extern FILE USARTStream;
  74
  75                 /* Function Prototypes: */
  76                 #if defined(__INCLUDE_FROM_SERIALSTREAM_C)
  77                         static int SerialStream_TxByte(char DataByte,
  78                                                        FILE *Stream) ATTR_NON_NULL_PTR_ARG(2);
  79                         static int SerialStream_RxByte(FILE *Stream) ATTR_NON_NULL_PTR_ARG(1);
  80                 #endif
  81         #endif
  82
  83         /* Public Interface - May be used in end-application: */
  84                 /* Inline Functions: */
  85                         /** Initialises the serial stream (and regular USART driver) so that both the stream and regular
  86                          *  USART driver functions can be used. Must be called before any stream or regular USART functions.
  87                          *
  88                          *  \param[in] BaudRate     Baud rate to configure the USART to.
  89                          *  \param[in] DoubleSpeed  Enables double speed mode when set, halving the sample time to double the baud rate.
  90                          */
  91                         static inline void SerialStream_Init(const uint32_t BaudRate,
  92                                                              const bool DoubleSpeed)
  93                         {
  94                                 Serial_Init(BaudRate, DoubleSpeed);
  95
  96                                 stdout = &USARTStream;
  97                                 stdin  = &USARTStream;
  98                         }
  99
 100                         /** Turns off the serial stream (and regular USART driver), disabling and returning used hardware to
 101                          *  their default configuration.
 102                          */
 103                         static inline void SerialStream_ShutDown(void)
 104                         {
 105                                 Serial_ShutDown();
 106                         }
 107
 108         /* Disable C linkage for C++ Compilers: */
 109                 #if defined(__cplusplus)
 110                         }
 111                 #endif
 112
 113 #endif
 114
 115 /** @} */