X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/a7aaa45ec4c3f415bf6073a5cc016635d5ecf77d..071fd8ce536522ca6365580d64cd465e4c18a031:/LUFA/Drivers/Peripheral/Serial.h diff --git a/LUFA/Drivers/Peripheral/Serial.h b/LUFA/Drivers/Peripheral/Serial.h index 838c1fd3c..d00f9c1c0 100644 --- a/LUFA/Drivers/Peripheral/Serial.h +++ b/LUFA/Drivers/Peripheral/Serial.h @@ -30,11 +30,7 @@ /** \file * - * This file is the master dispatch header file for the device-specific USART driver, for AVRs containing a - * USART. - * - * User code should include this file, which will in turn include the correct USART driver header file for - * the currently selected AVR model. + * Driver for the USART subsystem on supported USB AVRs. */ /** \ingroup Group_PeripheralDrivers @@ -54,27 +50,42 @@ #ifndef __SERIAL_H__ #define __SERIAL_H__ - /* Macros: */ - #if !defined(__DOXYGEN__) - #define __INCLUDE_FROM_SERIAL_H - #endif - /* Includes: */ - #include "../../Common/Common.h" + #include + #include + #include + + #include "../../Common/Common.h" #include "../Misc/TerminalCodes.h" - #if defined(__AVR32__) - #include "AVR32/Serial.h" - #elif defined(__AVR__) - #include "AVR8/Serial.h" - #endif - /* 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) + + /* Pseudo-Function Macros: */ + #if defined(__DOXYGEN__) + /** 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); + #else + #define Serial_IsCharReceived() ((UCSR1A & (1 << RXC1)) ? true : false) + #endif + /* Function Prototypes: */ /** Transmits a given string located in program space (FLASH) through the USART. * @@ -88,6 +99,58 @@ */ void Serial_TxString(const char *StringPtr) ATTR_NON_NULL_PTR_ARG(1); + /* Inline Functions: */ + /** Initializes the USART, ready for serial data transmission and reception. This initializes the interface to + * standard 8-bit, no parity, 1 stop bit settings suitable for most applications. + * + * \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 + */ + static inline void Serial_Init(const uint32_t BaudRate, const bool DoubleSpeed) + { + UCSR1A = (DoubleSpeed ? (1 << U2X1) : 0); + UCSR1B = ((1 << TXEN1) | (1 << RXEN1)); + UCSR1C = ((1 << UCSZ11) | (1 << UCSZ10)); + + DDRD |= (1 << 3); + PORTD |= (1 << 2); + + UBRR1 = (DoubleSpeed ? SERIAL_2X_UBBRVAL(BaudRate) : SERIAL_UBBRVAL(BaudRate)); + } + + /** Turns off the USART driver, disabling and returning used hardware to their default configuration. */ + static inline void Serial_ShutDown(void) + { + UCSR1A = 0; + UCSR1B = 0; + UCSR1C = 0; + + DDRD &= ~(1 << 3); + PORTD &= ~(1 << 2); + + UBRR1 = 0; + } + + /** Transmits a given byte through the USART. + * + * \param[in] DataByte Byte to transmit through the USART + */ + static inline void Serial_TxByte(const char DataByte) + { + while (!(UCSR1A & (1 << UDRE1))); + UDR1 = DataByte; + } + + /** Receives a byte from the USART. + * + * \return Byte received from the USART + */ + static inline char Serial_RxByte(void) + { + while (!(UCSR1A & (1 << RXC1))); + return UDR1; + } + /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus) }