Serial.h 5.44 KB
 Dean Camera committed May 08, 2010 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 /* LUFA Library Copyright (C) Dean Camera, 2010. dean [at] fourwalledcubicle [dot] com www.fourwalledcubicle.com */ /* Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com) Permission to use, copy, modify, distribute, and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that the copyright notice and this permission notice and warranty disclaimer appear in supporting documentation, and that the name of the author not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission. The author disclaim all warranties with regard to this software, including all implied warranties of merchantability and fitness. In no event shall the author be liable for any special, indirect or consequential damages or any damages whatsoever resulting from loss of use, data or profits, whether in an action of contract, negligence or other tortious action, arising out of or in connection with the use or performance of this software. */ /** \file * \brief Master include file for the USART peripheral driver. * * Driver for the USART subsystem on supported USB AVRs. */ /** \ingroup Group_PeripheralDrivers * @defgroup Group_Serial Serial USART Driver - LUFA/Drivers/Peripheral/Serial.h * * \section Sec_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module:  Dean Camera committed Jul 19, 2010 42  * - LUFA/Drivers/Peripheral/Serial.c (Makefile source module name: LUFA_SRC_SERIAL)  Dean Camera committed May 08, 2010 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81  * * \section Module Description * Hardware serial USART driver. This module provides an easy to use driver for * the setup of and transfer of data over the AVR's USART port. * * @{ */ #ifndef __SERIAL_H__ #define __SERIAL_H__ /* Includes: */ #include #include #include #include "../../Common/Common.h" #include "../Misc/TerminalCodes.h" /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) extern "C" { #endif /* Public Interface - May be used in end-application: */ /* Macros: */ /** Macro for calculating the baud value from a given baud rate when the U2X (double speed) bit is * not set. */ #define SERIAL_UBBRVAL(baud) ((((F_CPU / 16) + (baud / 2)) / (baud)) - 1) /** Macro for calculating the baud value from a given baud rate when the U2X (double speed) bit is * set. */ #define SERIAL_2X_UBBRVAL(baud) ((((F_CPU / 8) + (baud / 2)) / (baud)) - 1) /* Function Prototypes: */ /** Transmits a given string located in program space (FLASH) through the USART. *  Dean Camera committed Jun 17, 2010 82  * \param[in] FlashStringPtr Pointer to a string located in program space.  Dean Camera committed May 08, 2010 83  */  Dean Camera committed Jul 21, 2010 84  void Serial_TxString_P(const char* FlashStringPtr) ATTR_NON_NULL_PTR_ARG(1);  Dean Camera committed May 08, 2010 85 86 87  /** Transmits a given string located in SRAM memory through the USART. *  Dean Camera committed Jun 17, 2010 88  * \param[in] StringPtr Pointer to a string located in SRAM space.  Dean Camera committed May 08, 2010 89  */  Dean Camera committed Jul 21, 2010 90  void Serial_TxString(const char* StringPtr) ATTR_NON_NULL_PTR_ARG(1);  Dean Camera committed May 08, 2010 91 92  /* Inline Functions: */  Dean Camera committed Jul 30, 2010 93  /** Initializes the USART, ready for serial data transmission and reception. This initializes the interface to  Dean Camera committed May 08, 2010 94 95  * standard 8-bit, no parity, 1 stop bit settings suitable for most applications. *  Dean Camera committed Jun 17, 2010 96 97  * \param[in] BaudRate Serial baud rate, in bits per second. * \param[in] DoubleSpeed Enables double speed mode when set, halving the sample time to double the baud rate.  Dean Camera committed May 08, 2010 98  */  Dean Camera committed Jul 21, 2010 99 100  static inline void Serial_Init(const uint32_t BaudRate, const bool DoubleSpeed)  Dean Camera committed May 08, 2010 101  {  Dean Camera committed Jul 31, 2010 102 103 104  UBRR1 = (DoubleSpeed ? SERIAL_2X_UBBRVAL(BaudRate) : SERIAL_UBBRVAL(BaudRate)); UCSR1C = ((1 << UCSZ11) | (1 << UCSZ10));  Dean Camera committed May 08, 2010 105 106 107  UCSR1A = (DoubleSpeed ? (1 << U2X1) : 0); UCSR1B = ((1 << TXEN1) | (1 << RXEN1));  Dean Camera committed Jul 31, 2010 108  DDRD |= (1 << 3);  Dean Camera committed May 08, 2010 109 110 111 112 113 114 115  PORTD |= (1 << 2); } /** Turns off the USART driver, disabling and returning used hardware to their default configuration. */ static inline void Serial_ShutDown(void) { UCSR1B = 0;  Dean Camera committed Jul 31, 2010 116  UCSR1A = 0;  Dean Camera committed May 08, 2010 117  UCSR1C = 0;  Dean Camera committed Jul 31, 2010 118 119  UBRR1 = 0;  Dean Camera committed May 08, 2010 120   Dean Camera committed Jul 31, 2010 121  DDRD &= ~(1 << 3);  Dean Camera committed May 08, 2010 122 123  PORTD &= ~(1 << 2); }  Dean Camera committed Jul 22, 2010 124 125 126 127 128 129 130 131 132 133  /** Indicates whether a character has been received through the USART. * * \return Boolean true if a character has been received, false otherwise. */ static inline bool Serial_IsCharReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; static inline bool Serial_IsCharReceived(void) { return ((UCSR1A & (1 << RXC1)) ? true : false); }  Dean Camera committed May 08, 2010 134 135 136  /** Transmits a given byte through the USART. *  Dean Camera committed Jun 17, 2010 137  * \param[in] DataByte Byte to transmit through the USART.  Dean Camera committed May 08, 2010 138  */  Dean Camera committed Jul 22, 2010 139  static inline void Serial_TxByte(const char DataByte) ATTR_ALWAYS_INLINE;  Dean Camera committed May 08, 2010 140 141 142 143 144 145  static inline void Serial_TxByte(const char DataByte) { while (!(UCSR1A & (1 << UDRE1))); UDR1 = DataByte; }  Dean Camera committed Jul 31, 2010 146 147 148  /** Receives a byte from the USART. This function blocks until a byte has been * received; if non-blocking behaviour is required, test for a received character * beforehand with \ref Serial_IsCharReceived().  Dean Camera committed May 08, 2010 149  *  Dean Camera committed Jun 17, 2010 150  * \return Byte received from the USART.  Dean Camera committed May 08, 2010 151  */  Dean Camera committed Jul 22, 2010 152  static inline char Serial_RxByte(void) ATTR_ALWAYS_INLINE;  Dean Camera committed May 08, 2010 153 154 155 156 157 158 159 160 161 162 163 164 165 166  static inline char Serial_RxByte(void) { while (!(UCSR1A & (1 << RXC1))); return UDR1; } /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus) } #endif #endif /** @} */