ahoneybun/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add Serial_IsSendReady() and Serial_IsSendComplete() serial driver API functions.

Browse source
This commit is contained in:
Dean Camera 2014-07-15 21:23:13 +10:00
parent 0c00c2aaa3
commit 3d818fbb86
3 changed files with 57 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

1
LUFA/DoxygenPages/ChangeLog.txt
View file

@ -10,6 +10,7 @@
* <b>New:</b>
* - Core:
* - Updated the BUILD build system module to add a new COMPILER_PATH optional variable
* - Added Serial_IsSendReady() and Serial_IsSendComplete() functions to the Serial hardware peripheral driver
*
* <b>Fixed:</b>
* - Core:

27
LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h
View file

@ -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;
}

31
LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.h
View file

@ -216,7 +216,36 @@
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;
}