diff options
author | Dean Camera <dean@fourwalledcubicle.com> | 2014-07-15 21:23:13 +1000 |
---|---|---|
committer | Dean Camera <dean@fourwalledcubicle.com> | 2014-07-15 21:23:13 +1000 |
commit | 3d818fbb86ddb648c6df4d9389dc025510a169b6 (patch) | |
tree | 1d807808fa9217039a7ae3619017441d2bbdafd8 /LUFA/Drivers | |
parent | 0c00c2aaa30421aea2e949443853971ec11a82bb (diff) | |
download | lufa-3d818fbb86ddb648c6df4d9389dc025510a169b6.tar.gz lufa-3d818fbb86ddb648c6df4d9389dc025510a169b6.tar.bz2 lufa-3d818fbb86ddb648c6df4d9389dc025510a169b6.zip |
Add Serial_IsSendReady() and Serial_IsSendComplete() serial driver API functions.
Diffstat (limited to 'LUFA/Drivers')
-rw-r--r-- | LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h | 27 | ||||
-rw-r--r-- | LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.h | 31 |
2 files changed, 56 insertions, 2 deletions
diff --git a/LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h b/LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h index f951f6b74..e8860a511 100644 --- a/LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h +++ b/LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h @@ -210,14 +210,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; } diff --git a/LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.h b/LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.h index 1161ef674..e7f9fee24 100644 --- a/LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.h +++ b/LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.h @@ -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_TCXIF_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; } |