X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/16e8fe9878944f7bcd69cb6e6636ba8b9c574ab9..df366e055d7c3831bd40d96efe3a91cdeb31e2dd:/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 b5af9c6e2..ad34c8535 100644 --- a/LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.h +++ b/LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.h @@ -1,13 +1,13 @@ /* LUFA Library - Copyright (C) Dean Camera, 2013. + Copyright (C) Dean Camera, 2014. 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 @@ -40,13 +40,13 @@ /** \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. * - * \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. * @@ -216,8 +216,37 @@ 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_TXCIF_bm) ? 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,out] USART Pointer to the base of the USART peripheral within the device. * \param[in] DataByte Byte to transmit through the USART. */ @@ -226,7 +255,7 @@ 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; }