-/*\r
- LUFA Library\r
- Copyright (C) Dean Camera, 2010.\r
- \r
- dean [at] fourwalledcubicle [dot] com\r
- www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
- Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
- Permission to use, copy, modify, distribute, and sell this \r
- software and its documentation for any purpose is hereby granted\r
- without fee, provided that the above copyright notice appear in \r
- all copies and that both that the copyright notice and this\r
- permission notice and warranty disclaimer appear in supporting \r
- documentation, and that the name of the author not be used in \r
- advertising or publicity pertaining to distribution of the \r
- software without specific, written prior permission.\r
-\r
- The author disclaim all warranties with regard to this\r
- software, including all implied warranties of merchantability\r
- and fitness. In no event shall the author be liable for any\r
- special, indirect or consequential damages or any damages\r
- whatsoever resulting from loss of use, data or profits, whether\r
- in an action of contract, negligence or other tortious action,\r
- arising out of or in connection with the use or performance of\r
- this software.\r
-*/\r
-\r
-/** \file\r
- * \brief Master include file for the USART peripheral driver.\r
- *\r
- * Driver for the USART subsystem on supported USB AVRs.\r
- */\r
- \r
-/** \ingroup Group_PeripheralDrivers\r
- * @defgroup Group_Serial Serial USART Driver - LUFA/Drivers/Peripheral/Serial.h\r
- *\r
- * \section Sec_Dependencies Module Source Dependencies\r
- * The following files must be built with any user project that uses this module:\r
- * - LUFA/Drivers/Peripheral/Serial.c\r
- *\r
- * \section Module Description\r
- * Hardware serial USART driver. This module provides an easy to use driver for\r
- * the setup of and transfer of data over the AVR's USART port.\r
- *\r
- * @{\r
- */\r
- \r
-#ifndef __SERIAL_H__\r
-#define __SERIAL_H__\r
-\r
- /* Includes: */\r
- #include <avr/io.h>\r
- #include <avr/pgmspace.h>\r
- #include <stdbool.h>\r
- \r
- #include "../../Common/Common.h"\r
- #include "../Misc/TerminalCodes.h"\r
-\r
- /* Enable C linkage for C++ Compilers: */\r
- #if defined(__cplusplus)\r
- extern "C" {\r
- #endif\r
-\r
- /* Public Interface - May be used in end-application: */\r
- /* Macros: */\r
- /** Macro for calculating the baud value from a given baud rate when the U2X (double speed) bit is\r
- * not set.\r
- */\r
- #define SERIAL_UBBRVAL(baud) ((((F_CPU / 16) + (baud / 2)) / (baud)) - 1)\r
-\r
- /** Macro for calculating the baud value from a given baud rate when the U2X (double speed) bit is\r
- * set.\r
- */\r
- #define SERIAL_2X_UBBRVAL(baud) ((((F_CPU / 8) + (baud / 2)) / (baud)) - 1)\r
-\r
- /* Pseudo-Function Macros: */\r
- #if defined(__DOXYGEN__)\r
- /** Indicates whether a character has been received through the USART.\r
- *\r
- * \return Boolean true if a character has been received, false otherwise\r
- */\r
- static inline bool Serial_IsCharReceived(void);\r
- #else\r
- #define Serial_IsCharReceived() ((UCSR1A & (1 << RXC1)) ? true : false)\r
- #endif\r
-\r
- /* Function Prototypes: */\r
- /** Transmits a given string located in program space (FLASH) through the USART.\r
- *\r
- * \param[in] FlashStringPtr Pointer to a string located in program space\r
- */\r
- void Serial_TxString_P(const char *FlashStringPtr) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** Transmits a given string located in SRAM memory through the USART.\r
- *\r
- * \param[in] StringPtr Pointer to a string located in SRAM space\r
- */\r
- void Serial_TxString(const char *StringPtr) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /* Inline Functions: */\r
- /** Initializes the USART, ready for serial data transmission and reception. This initializes the interface to\r
- * standard 8-bit, no parity, 1 stop bit settings suitable for most applications.\r
- *\r
- * \param[in] BaudRate Serial baud rate, in bits per second\r
- * \param[in] DoubleSpeed Enables double speed mode when set, halving the sample time to double the baud rate\r
- */\r
- static inline void Serial_Init(const uint32_t BaudRate, const bool DoubleSpeed)\r
- {\r
- UCSR1A = (DoubleSpeed ? (1 << U2X1) : 0);\r
- UCSR1B = ((1 << TXEN1) | (1 << RXEN1));\r
- UCSR1C = ((1 << UCSZ11) | (1 << UCSZ10));\r
- \r
- DDRD |= (1 << 3); \r
- PORTD |= (1 << 2);\r
- \r
- UBRR1 = (DoubleSpeed ? SERIAL_2X_UBBRVAL(BaudRate) : SERIAL_UBBRVAL(BaudRate));\r
- }\r
-\r
- /** Turns off the USART driver, disabling and returning used hardware to their default configuration. */\r
- static inline void Serial_ShutDown(void)\r
- {\r
- UCSR1A = 0;\r
- UCSR1B = 0;\r
- UCSR1C = 0;\r
- \r
- DDRD &= ~(1 << 3); \r
- PORTD &= ~(1 << 2);\r
- \r
- UBRR1 = 0;\r
- }\r
- \r
- /** Transmits a given byte through the USART.\r
- *\r
- * \param[in] DataByte Byte to transmit through the USART\r
- */\r
- static inline void Serial_TxByte(const char DataByte)\r
- {\r
- while (!(UCSR1A & (1 << UDRE1)));\r
- UDR1 = DataByte;\r
- }\r
-\r
- /** Receives a byte from the USART.\r
- *\r
- * \return Byte received from the USART\r
- */\r
- static inline char Serial_RxByte(void)\r
- {\r
- while (!(UCSR1A & (1 << RXC1)));\r
- return UDR1; \r
- }\r
-\r
- /* Disable C linkage for C++ Compilers: */\r
- #if defined(__cplusplus)\r
- }\r
- #endif\r
- \r
-#endif\r
-\r
-/** @} */\r
+/*
+ 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:
+ * - 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.
+ *
+ * @{
+ */
+
+#ifndef __SERIAL_H__
+#define __SERIAL_H__
+
+ /* Includes: */
+ #include <avr/io.h>
+ #include <avr/pgmspace.h>
+ #include <stdbool.h>
+
+ #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)
+
+ /* 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.
+ *
+ * \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[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[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)
+ }
+ #endif
+
+#endif
+
+/** @} */
projects / pub / USBasp.git / blobdiff