X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/9708b45e693dcfc3119360d555be3b382d2ba9fe..385ffb6de3cc85462be82f14eeb580d6b66bc5e7:/LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h diff --git a/LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h b/LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h index d8216cd24..f7d03fc7a 100644 --- a/LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h +++ b/LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h @@ -1,13 +1,13 @@ /* LUFA Library - Copyright (C) Dean Camera, 2011. + Copyright (C) Dean Camera, 2012. dean [at] fourwalledcubicle [dot] com www.lufa-lib.org */ /* - Copyright 2011 Dean Camera (dean [at] fourwalledcubicle [dot] com) + Copyright 2012 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 @@ -70,7 +70,7 @@ /* Includes: */ #include "../../../Common/Common.h" #include "../../Misc/TerminalCodes.h" - + #include /* Enable C linkage for C++ Compilers: */ @@ -87,7 +87,7 @@ #if !defined(__DOXYGEN__) /* External Variables: */ extern FILE USARTSerialStream; - + /* Function Prototypes: */ int Serial_putchar(char DataByte, FILE *Stream); @@ -97,15 +97,23 @@ /* 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 + /** Macro for calculating the baud value from a given baud rate when the \c U2X (double speed) bit is * not set. + * + * \param[in] Baud Target serial UART baud rate. + * + * \return Closest UBRR register value for the given UART frequency. */ - #define SERIAL_UBBRVAL(baud) ((((F_CPU / 16) + (baud / 2)) / (baud)) - 1) + #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 + /** Macro for calculating the baud value from a given baud rate when the \c U2X (double speed) bit is * set. + * + * \param[in] Baud Target serial UART baud rate. + * + * \return Closest UBRR register value for the given UART frequency. */ - #define SERIAL_2X_UBBRVAL(baud) ((((F_CPU / 8) + (baud / 2)) / (baud)) - 1) + #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. @@ -119,7 +127,7 @@ * \param[in] StringPtr Pointer to a string located in SRAM space. */ void Serial_SendString(const char* StringPtr) ATTR_NON_NULL_PTR_ARG(1); - + /** Transmits a given buffer located in SRAM memory through the USART. * * \param[in] Buffer Pointer to a buffer containing the data to send. @@ -182,7 +190,7 @@ stdin = Stream; stdout = Stream; } - + *Stream = (FILE)FDEV_SETUP_STREAM(Serial_putchar, Serial_getchar, _FDEV_SETUP_RW); } @@ -236,7 +244,7 @@ { if (!(Serial_IsCharReceived())) return -1; - + return UDR1; }