X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/5712b8dff669dc1947cd7d6f34f13eb9fe6a8d0a..d11ed10c5314c44dc01c06954d1d73d4894cbff8:/LUFA/Drivers/Peripheral/Serial.h diff --git a/LUFA/Drivers/Peripheral/Serial.h b/LUFA/Drivers/Peripheral/Serial.h index d83761f3f..ba466f314 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 @@ -33,10 +33,16 @@ * Driver for the USART subsystem on supported USB AVRs. */ -/** \ingroup Group_SubsystemDrivers +/** \ingroup Group_PeripheralDrivers * @defgroup Group_Serial Serial USART Driver - LUFA/Drivers/Peripheral/Serial.h * - * Functions, macros, variables, enums and types related to the setup of the USART for serial communications. + * \section Sec_Dependencies Module Source Dependencies + * The following files must be built with any user project that uses this module: + * - LUFA/Drivers/Peripheral/Serial.c + * + * \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. * * @{ */ @@ -58,46 +64,76 @@ #endif /* Public Interface - May be used in end-application: */ - /* Macros: */ - /** Indicates whether a character has been received through the USART - boolean false if no character - * has been received, or non-zero if a character is waiting to be read from the reception buffer. - */ - #define Serial_IsCharReceived() ((UCSR1A & (1 << RXC1)) ? true : false) - + /* 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) + #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) + #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: */ - /** Initializes the USART, ready for serial data transmission and reception. - * - * \param BaudRate Baud rate to configure the USART to - * \param DoubleSpeed Enables double speed mode when set, halving the sample time to double the baud rate - */ - void Serial_Init(const uint32_t BaudRate, const bool DoubleSpeed); - /** Transmits a given string located in program space (FLASH) through the USART. * - * \param FlashStringPtr Pointer to a string located in program space + * \param[in] FlashStringPtr Pointer to a string located in program space */ void Serial_TxString_P(const char *FlashStringPtr) ATTR_NON_NULL_PTR_ARG(1); /** Transmits a given string located in SRAM memory through the USART. * - * \param StringPtr Pointer to a string located in SRAM space + * \param[in] StringPtr Pointer to a string located in SRAM space */ 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 DataByte Byte to transmit through the USART + * \param[in] DataByte Byte to transmit through the USART */ static inline void Serial_TxByte(const char DataByte) {