X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/f1076ac4d6e56bff7fb6d2126746af1108211370..0e6d5cf5b4fea133cbd3c16b958617deb42332cf:/LUFA/Drivers/Peripheral/Serial.h diff --git a/LUFA/Drivers/Peripheral/Serial.h b/LUFA/Drivers/Peripheral/Serial.h index 82cbcfc2c..838c1fd3c 100644 --- a/LUFA/Drivers/Peripheral/Serial.h +++ b/LUFA/Drivers/Peripheral/Serial.h @@ -1,21 +1,21 @@ /* LUFA Library - Copyright (C) Dean Camera, 2009. + Copyright (C) Dean Camera, 2010. dean [at] fourwalledcubicle [dot] com www.fourwalledcubicle.com */ /* - Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com) - - Permission to use, copy, modify, and distribute this software - and its documentation for any purpose and without fee is hereby - granted, 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 + 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 @@ -30,7 +30,11 @@ /** \file * - * Driver for the USART subsystem on supported USB AVRs. + * 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. */ /** \ingroup Group_PeripheralDrivers @@ -41,7 +45,8 @@ * - LUFA/Drivers/Peripheral/Serial.c * * \section Module Description - * Functions, macros, variables, enums and types related to the setup of the USART for serial communications. + * 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. * * @{ */ @@ -49,42 +54,27 @@ #ifndef __SERIAL_H__ #define __SERIAL_H__ + /* Macros: */ + #if !defined(__DOXYGEN__) + #define __INCLUDE_FROM_SERIAL_H + #endif + /* Includes: */ - #include - #include - #include - - #include "../../Common/Common.h" + #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) - 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) - 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. * @@ -98,45 +88,6 @@ */ 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 initialises 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)); - } - - /** 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) }