Only deque from the USBtoSerial's USB->USART buffer when the USART is idle.

[pub/USBasp.git] / LUFA / Drivers / Peripheral / XMEGA / Serial_XMEGA.h

diff --git a/LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.h b/LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.h
index 04941b1..e7f9fee 100644 (file)
--- a/LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.h
+++ b/LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.h
@@ -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


@@ -40,13 +40,13 @@
 /** \ingroup Group_Serial
  *  \defgroup Group_Serial_XMEGA Serial USART Peripheral Driver (XMEGA)
  *
 /** \ingroup Group_Serial
  *  \defgroup Group_Serial_XMEGA Serial USART Peripheral Driver (XMEGA)
  *

- *  \section Sec_ModDescription Module Description
+ *  \section Sec_Serial_XMEGA_ModDescription Module Description

  *  On-chip serial USART driver for the XMEGA 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.
  *
  *  On-chip serial USART driver for the XMEGA 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_XMEGA_ExampleUsage Example Usage

  *  The following snippet is an example of how this module may be used within a typical
  *  application.
  *
  *  The following snippet is an example of how this module may be used within a typical
  *  application.
  *


@@ -139,7 +139,8 @@
                         *  \param[in]     Length  Length of the data to send, in bytes.
                         */
                        void Serial_SendData(USART_t* const USART,
                         *  \param[in]     Length  Length of the data to send, in bytes.
                         */
                        void Serial_SendData(USART_t* const USART,

-                                            const void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
+                                            const void* Buffer,
+                                            uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);

 
                        /** Creates a standard character stream from the USART so that it can be used with all the regular functions
                         *  in the avr-libc \c <stdio.h> library that accept a \c FILE stream as a destination (e.g. \c fprintf). The created
 
                        /** Creates a standard character stream from the USART so that it can be used with all the regular functions
                         *  in the avr-libc \c <stdio.h> library that accept a \c FILE stream as a destination (e.g. \c fprintf). The created


@@ -177,6 +178,9 @@
                         */
                        static inline void Serial_Init(USART_t* const USART,
                                                       const uint32_t BaudRate,
                         */
                        static inline void Serial_Init(USART_t* const USART,
                                                       const uint32_t BaudRate,

+                                                      const bool DoubleSpeed) ATTR_NON_NULL_PTR_ARG(1);
+                       static inline void Serial_Init(USART_t* const USART,
+                                                      const uint32_t BaudRate,

                                                       const bool DoubleSpeed)
                        {
                                uint16_t BaudValue = (DoubleSpeed ? SERIAL_2X_UBBRVAL(BaudRate) : SERIAL_UBBRVAL(BaudRate));
                                                       const bool DoubleSpeed)
                        {
                                uint16_t BaudValue = (DoubleSpeed ? SERIAL_2X_UBBRVAL(BaudRate) : SERIAL_UBBRVAL(BaudRate));


@@ -192,6 +196,7 @@
                         *
                         *  \param[in,out] USART  Pointer to the base of the USART peripheral within the device.
                         */
                         *
                         *  \param[in,out] USART  Pointer to the base of the USART peripheral within the device.
                         */

+                       static inline void Serial_Disable(USART_t* const USART) ATTR_ALWAYS_INLINE ATTR_NON_NULL_PTR_ARG(1);

                        static inline void Serial_Disable(USART_t* const USART)
                        {
                                USART->CTRLA = 0;
                        static inline void Serial_Disable(USART_t* const USART)
                        {
                                USART->CTRLA = 0;


@@ -205,23 +210,52 @@
                         *
                         *  \return Boolean \c true if a character has been received, \c false otherwise.
                         */
                         *
                         *  \return Boolean \c true if a character has been received, \c false otherwise.
                         */

-                       static inline bool Serial_IsCharReceived(USART_t* const USART) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
+                       static inline bool Serial_IsCharReceived(USART_t* const USART) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);

                        static inline bool Serial_IsCharReceived(USART_t* const USART)
                        {
                                return ((USART->STATUS & USART_RXCIF_bm) ? true : false);
                        }
 
                        static inline bool Serial_IsCharReceived(USART_t* const USART)
                        {
                                return ((USART->STATUS & USART_RXCIF_bm) ? 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.
+                        *
+                        *  \param[in,out] USART  Pointer to the base of the USART peripheral within the device.
+                        *
+                        *  \return Boolean \c true if a character can be queued for transmission immediately, \c false otherwise.
+                        */
+                       static inline bool Serial_IsSendReady(USART_t* const USART) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
+                       static inline bool Serial_IsSendReady(USART_t* const USART)
+                       {
+                               return (USART->STATUS & USART_DREIF_bm) ? true : false);
+                       }
+
+                       /** Indicates whether the hardware USART transmit buffer is completely empty, indicating all
+                        *  pending transmissions have completed.
+                        *
+                        *  \param[in,out] USART  Pointer to the base of the USART peripheral within the device.
+                        *
+                        *  \return Boolean \c true if no characters are buffered for transmission, \c false otherwise.
+                        */
+                       static inline bool Serial_IsSendComplete(USART_t* const USART) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
+                       static inline bool Serial_IsSendComplete(USART_t* const USART)
+                       {
+                               return (USART->STATUS & USART_TCXIF_bm) ? 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,out] USART     Pointer to the base of the USART peripheral within the device.
                         *  \param[in]     DataByte  Byte to transmit through the USART.
                         */
                        static inline void Serial_SendByte(USART_t* const USART,
                         *  \param[in,out] USART     Pointer to the base of the USART peripheral within the device.
                         *  \param[in]     DataByte  Byte to transmit through the USART.
                         */
                        static inline void Serial_SendByte(USART_t* const USART,

-                                                          const char DataByte) ATTR_ALWAYS_INLINE;
+                                                          const char DataByte) ATTR_ALWAYS_INLINE ATTR_NON_NULL_PTR_ARG(1);

                        static inline void Serial_SendByte(USART_t* const USART,
                                                           const char DataByte)
                        {
                        static inline void Serial_SendByte(USART_t* const USART,
                                                           const char DataByte)
                        {

-                               while (!(USART->STATUS & USART_DREIF_bm));
+                               while (!(Serial_IsSendReady(USART));

                                USART->DATA = DataByte;
                        }
 
                                USART->DATA = DataByte;
                        }
 


@@ -231,7 +265,7 @@
                         *
                         *  \return Next byte received from the USART, or a negative value if no byte has been received.
                         */
                         *
                         *  \return Next byte received from the USART, or a negative value if no byte has been received.
                         */

-                       static inline int16_t Serial_ReceiveByte(USART_t* const USART) ATTR_ALWAYS_INLINE;
+                       static inline int16_t Serial_ReceiveByte(USART_t* const USART) ATTR_ALWAYS_INLINE ATTR_NON_NULL_PTR_ARG(1);

                        static inline int16_t Serial_ReceiveByte(USART_t* const USART)
                        {
                                if (!(Serial_IsCharReceived(USART)))
                        static inline int16_t Serial_ReceiveByte(USART_t* const USART)
                        {
                                if (!(Serial_IsCharReceived(USART)))