Add Progmem Variant to CDC_Device_Send
[pub/USBasp.git] / LUFA / Drivers / Peripheral / AVR8 / Serial_AVR8.h
index 724c19c..e8860a5 100644 (file)
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2013.
+     Copyright (C) Dean Camera, 2014.
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
-  Copyright 2013  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2014  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
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
                                return ((UCSR1A & (1 << RXC1)) ? true : false);
                        }
 
                                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.
                         *
                        /** 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)
                        {
                         *  \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;
                        }
 
                                UDR1 = DataByte;
                        }