\r
/** \file\r
*\r
- * This file is the master dispatch header file for the device-specific USART driver, for AVRs containing a\r
- * USART.\r
- *\r
- * User code should include this file, which will in turn include the correct USART driver header file for\r
- * the currently selected AVR model.\r
+ * Driver for the USART subsystem on supported USB AVRs.\r
*/\r
\r
/** \ingroup Group_PeripheralDrivers\r
#ifndef __SERIAL_H__\r
#define __SERIAL_H__\r
\r
- /* Macros: */\r
- #if !defined(__DOXYGEN__)\r
- #define __INCLUDE_FROM_SERIAL_H\r
- #endif\r
-\r
/* Includes: */\r
- #include "../../Common/Common.h" \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
- #if defined(__AVR32__)\r
- #include "AVR32/Serial.h"\r
- #elif defined(__AVR__)\r
- #include "AVR8/Serial.h" \r
- #endif\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
*/\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