LUFA/Drivers/Peripheral/Serial.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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  *  Driver for the USART subsystem on supported USB AVRs.
  34  */
  35
  36 /** \ingroup Group_PeripheralDrivers
  37  *  @defgroup Group_Serial Serial USART Driver - LUFA/Drivers/Peripheral/Serial.h
  38  *
  39  *  \section Sec_Dependencies Module Source Dependencies
  40  *  The following files must be built with any user project that uses this module:
  41  *    - LUFA/Drivers/Peripheral/Serial.c
  42  *
  43  *  \section Module Description
  44  *  Functions, macros, variables, enums and types related to the setup of the USART for serial communications.
  45  *
  46  *  @{
  47  */
  48
  49 #ifndef __SERIAL_H__
  50 #define __SERIAL_H__
  51
  52         /* Includes: */
  53                 #include <avr/io.h>
  54                 #include <avr/pgmspace.h>
  55                 #include <stdbool.h>
  56
  57                 #include "../../Common/Common.h"
  58                 #include "../Misc/TerminalCodes.h"
  59
  60         /* Enable C linkage for C++ Compilers: */
  61                 #if defined(__cplusplus)
  62                         extern "C" {
  63                 #endif
  64
  65         /* Public Interface - May be used in end-application: */
  66                 /* Macros: */
  67                         /** Macro for calculating the baud value from a given baud rate when the U2X (double speed) bit is
  68                          *  not set.
  69                          */
  70                         #define SERIAL_UBBRVAL(baud)    (((F_CPU / 16) / baud) - 1)
  71
  72                         /** Macro for calculating the baud value from a given baud rate when the U2X (double speed) bit is
  73                          *  set.
  74                          */
  75                         #define SERIAL_2X_UBBRVAL(baud) (((F_CPU / 8) / baud) - 1)
  76
  77                 /* Pseudo-Function Macros: */
  78                         #if defined(__DOXYGEN__)
  79                                 /** Indicates whether a character has been received through the USART.
  80                                  *
  81                                  *  \return Boolean true if a character has been received, false otherwise
  82                                  */
  83                                 static inline bool Serial_IsCharReceived(void);
  84                         #else
  85                                 #define Serial_IsCharReceived() ((UCSR1A & (1 << RXC1)) ? true : false)
  86                         #endif
  87
  88                 /* Function Prototypes: */
  89                         /** Initializes the USART, ready for serial data transmission and reception.
  90                          *
  91                          *  \param BaudRate     Baud rate to configure the USART to
  92                          *  \param DoubleSpeed  Enables double speed mode when set, halving the sample time to double the baud rate
  93                          */
  94                         void Serial_Init(const uint32_t BaudRate, const bool DoubleSpeed);
  95
  96                         /** Transmits a given string located in program space (FLASH) through the USART.
  97                          *
  98                          *  \param FlashStringPtr  Pointer to a string located in program space
  99                          */
 100                         void Serial_TxString_P(const char *FlashStringPtr) ATTR_NON_NULL_PTR_ARG(1);
 101
 102                         /** Transmits a given string located in SRAM memory through the USART.
 103                          *
 104                          *  \param StringPtr  Pointer to a string located in SRAM space
 105                          */
 106                         void Serial_TxString(const char *StringPtr) ATTR_NON_NULL_PTR_ARG(1);
 107
 108                 /* Inline Functions: */
 109                         /** Transmits a given byte through the USART.
 110                          *
 111                          *  \param DataByte  Byte to transmit through the USART
 112                          */
 113                         static inline void Serial_TxByte(const char DataByte)
 114                         {
 115                                 while (!(UCSR1A & (1 << UDRE1)));
 116                                 UDR1 = DataByte;
 117                         }
 118
 119                         /** Receives a byte from the USART.
 120                          *
 121                          *  \return Byte received from the USART
 122                          */
 123                         static inline char Serial_RxByte(void)
 124                         {
 125                                 while (!(UCSR1A & (1 << RXC1)));
 126                                 return UDR1;
 127                         }
 128
 129         /* Disable C linkage for C++ Compilers: */
 130                 #if defined(__cplusplus)
 131                         }
 132                 #endif
 133
 134 #endif
 135
 136 /** @} */