Update documentation and reset version information post-release.

[pub/USBasp.git] / 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 eb56bc7..ad8a4b6 100644 (file)
--- 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, 2013.
+     Copyright (C) Dean Camera, 2015.
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
-  Copyright 2013  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2015  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
@@ -40,13 +40,13 @@
 /** \ingroup Group_Serial
  *  \defgroup Group_Serial_AVR8 Serial USART Peripheral Driver (AVR8)
  *
- *  \section Sec_ModDescription Module Description
+ *  \section Sec_Serial_AVR8_ModDescription Module Description
  *  On-chip serial USART driver for the 8-bit AVR microcontrollers.
  *
  *  \note This file should not be included directly. It is automatically included as needed by the USART driver
  *        dispatch header located in LUFA/Drivers/Peripheral/Serial.h.
  *
- *  \section Sec_ExampleUsage Example Usage
+ *  \section Sec_Serial_AVR8_ExampleUsage Example Usage
  *  The following snippet is an example of how this module may be used within a typical
  *  application.
  *
@@ -168,10 +168,13 @@
                        /** 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] BaudRate     Serial baud rate, in bits per second. This should be the target baud rate regardless of the
+                        *                          \c DoubleSpeed parameter's value.
                         *  \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);
+                       static inline void Serial_Init(const uint32_t BaudRate,
                                                       const bool DoubleSpeed)
                        {
                                UBRR1  = (DoubleSpeed ? SERIAL_2X_UBBRVAL(BaudRate) : SERIAL_UBBRVAL(BaudRate));
@@ -185,6 +188,7 @@
                        }
 
                        /** Turns off the USART driver, disabling and returning used hardware to their default configuration. */
+                       static inline void Serial_Disable(void);
                        static inline void Serial_Disable(void)
                        {
                                UCSR1B = 0;
@@ -207,14 +211,39 @@
                                return ((UCSR1A & (1 << RXC1)) ? true : false);
                        }
 
+                       /** Indicates whether there is hardware buffer space for a new transmit on the USART. This
+                        *  function can be used to determine if a call to \ref Serial_SendByte() will block in advance.
+                        *
+                        *  \return Boolean \c true if a character can be queued for transmission immediately, \c false otherwise.
+                        */
+                       static inline bool Serial_IsSendReady(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
+                       static inline bool Serial_IsSendReady(void)
+                       {
+                               return ((UCSR1A & (1 << UDRE1)) ? true : false);
+                       }
+
+                       /** Indicates whether the hardware USART transmit buffer is completely empty, indicating all
+                        *  pending transmissions have completed.
+                        *
+                        *  \return Boolean \c true if no characters are buffered for transmission, \c false otherwise.
+                        */
+                       static inline bool Serial_IsSendComplete(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
+                       static inline bool Serial_IsSendComplete(void)
+                       {
+                               return ((UCSR1A & (1 << TXC1)) ? true : false);
+                       }
+
                        /** Transmits a given byte through the USART.
                         *
+                        *  \note If no buffer space is available in the hardware USART, this function will block. To check if
+                        *        space is available before calling this function, see \ref Serial_IsSendReady().
+                        *
                         *  \param[in] DataByte  Byte to transmit through the USART.
                         */
                        static inline void Serial_SendByte(const char DataByte) ATTR_ALWAYS_INLINE;
                        static inline void Serial_SendByte(const char DataByte)
                        {
-                               while (!(UCSR1A & (1 << UDRE1)));
+                               while (!(Serial_IsSendReady()));
                                UDR1 = DataByte;
                        }