summaryrefslogtreecommitdiff
path: root/lib/lufa/LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/lufa/LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.h')
-rw-r--r--lib/lufa/LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.h289
1 files changed, 0 insertions, 289 deletions
diff --git a/lib/lufa/LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.h b/lib/lufa/LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.h
deleted file mode 100644
index 36f507d43e..0000000000
--- a/lib/lufa/LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.h
+++ /dev/null
@@ -1,289 +0,0 @@
-/*
- LUFA Library
- Copyright (C) Dean Camera, 2017.
-
- dean [at] fourwalledcubicle [dot] com
- www.lufa-lib.org
-*/
-
-/*
- Copyright 2017 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
- without fee, provided that the above copyright notice appear in
- all copies and that both that the copyright notice and this
- permission notice and warranty disclaimer appear in supporting
- documentation, and that the name of the author not be used in
- advertising or publicity pertaining to distribution of the
- software without specific, written prior permission.
-
- The author disclaims all warranties with regard to this
- software, including all implied warranties of merchantability
- and fitness. In no event shall the author be liable for any
- special, indirect or consequential damages or any damages
- whatsoever resulting from loss of use, data or profits, whether
- in an action of contract, negligence or other tortious action,
- arising out of or in connection with the use or performance of
- this software.
-*/
-
-/** \file
- * \brief Serial USART Peripheral Driver (XMEGA)
- *
- * 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.
- */
-
-/** \ingroup Group_Serial
- * \defgroup Group_Serial_XMEGA Serial USART Peripheral Driver (XMEGA)
- *
- * \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_Serial_XMEGA_ExampleUsage Example Usage
- * The following snippet is an example of how this module may be used within a typical
- * application.
- *
- * \code
- * // Initialize the serial USART driver before first use, with 9600 baud (and no double-speed mode)
- * Serial_Init(&USARTD0, 9600, false);
- *
- * // Send a string through the USART
- * Serial_TxString(&USARTD0, "Test String\r\n");
- *
- * // Receive a byte through the USART
- * uint8_t DataByte = Serial_RxByte(&USARTD0);
- * \endcode
- *
- * @{
- */
-
-#ifndef __SERIAL_XMEGA_H__
-#define __SERIAL_XMEGA_H__
-
- /* Includes: */
- #include "../../../Common/Common.h"
- #include "../../Misc/TerminalCodes.h"
-
- #include <stdio.h>
-
- /* Enable C linkage for C++ Compilers: */
- #if defined(__cplusplus)
- extern "C" {
- #endif
-
- /* Preprocessor Checks: */
- #if !defined(__INCLUDE_FROM_SERIAL_H) && !defined(__INCLUDE_FROM_SERIAL_C)
- #error Do not include this file directly. Include LUFA/Drivers/Peripheral/Serial.h instead.
- #endif
-
- /* Private Interface - For use in library only: */
- #if !defined(__DOXYGEN__)
- /* External Variables: */
- extern FILE USARTSerialStream;
-
- /* Function Prototypes: */
- int Serial_putchar(char DataByte,
- FILE *Stream);
- int Serial_getchar(FILE *Stream);
- int Serial_getchar_Blocking(FILE *Stream);
- #endif
-
- /* Public Interface - May be used in end-application: */
- /* Macros: */
- /** Macro for calculating the baud value from a given baud rate when the \c U2X (double speed) bit is
- * not set.
- *
- * \param[in] Baud Target serial UART baud rate.
- *
- * \return Closest UBRR register value for the given UART frequency.
- */
- #define SERIAL_UBBRVAL(Baud) ((((F_CPU / 16) + (Baud / 2)) / (Baud)) - 1)
-
- /** Macro for calculating the baud value from a given baud rate when the \c U2X (double speed) bit is
- * set.
- *
- * \param[in] Baud Target serial UART baud rate.
- *
- * \return Closest UBRR register value for the given UART frequency.
- */
- #define SERIAL_2X_UBBRVAL(Baud) ((((F_CPU / 8) + (Baud / 2)) / (Baud)) - 1)
-
- /* Function Prototypes: */
- /** Transmits a given string located in program space (FLASH) through the USART.
- *
- * \param[in,out] USART Pointer to the base of the USART peripheral within the device.
- * \param[in] FlashStringPtr Pointer to a string located in program space.
- */
- void Serial_SendString_P(USART_t* const USART,
- const char* FlashStringPtr) ATTR_NON_NULL_PTR_ARG(1);
-
- /** Transmits a given string located in SRAM memory through the USART.
- *
- * \param[in,out] USART Pointer to the base of the USART peripheral within the device.
- * \param[in] StringPtr Pointer to a string located in SRAM space.
- */
- void Serial_SendString(USART_t* const USART,
- const char* StringPtr) ATTR_NON_NULL_PTR_ARG(1);
-
- /** Transmits a given buffer located in SRAM memory through the USART.
- *
- * \param[in,out] USART Pointer to the base of the USART peripheral within the device.
- * \param[in] Buffer Pointer to a buffer containing the data to send.
- * \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);
-
- /** 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
- * stream is bidirectional and can be used for both input and output functions.
- *
- * Reading data from this stream is non-blocking, i.e. in most instances, complete strings cannot be read in by a single
- * fetch, as the endpoint will not be ready at some point in the transmission, aborting the transfer. However, this may
- * be used when the read data is processed byte-per-bye (via \c getc()) or when the user application will implement its own
- * line buffering.
- *
- * \param[in,out] USART Pointer to the base of the USART peripheral within the device.
- * \param[in,out] Stream Pointer to a FILE structure where the created stream should be placed, if \c NULL, \c stdout
- * and \c stdin will be configured to use the USART.
- *
- * \pre The USART must first be configured via a call to \ref Serial_Init() before the stream is used.
- */
- void Serial_CreateStream(USART_t* USART, FILE* Stream);
-
- /** Identical to \ref Serial_CreateStream(), except that reads are blocking until the calling stream function terminates
- * the transfer.
- *
- * \param[in,out] USART Pointer to the base of the USART peripheral within the device.
- * \param[in,out] Stream Pointer to a FILE structure where the created stream should be placed, if \c NULL, \c stdout
- * and \c stdin will be configured to use the USART.
- *
- * \pre The USART must first be configured via a call to \ref Serial_Init() before the stream is used.
- */
- void Serial_CreateBlockingStream(USART_t* USART, FILE* Stream);
-
- /* Inline Functions: */
- /** Initializes the USART, ready for serial data transmission and reception. This initializes the interface to
- * standard 8-bit, no parity, 1 stop bit settings suitable for most applications.
- *
- * \param[in,out] USART Pointer to the base of the USART peripheral within the device.
- * \param[in] BaudRate Serial baud rate, in bits per second. This should be the target baud rate regardless of
- * the \c DoubleSpeed parameter's value.
- * \param[in] DoubleSpeed Enables double speed mode when set, halving the sample time to double the baud rate.
- */
- 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));
-
- USART->BAUDCTRLB = (BaudValue >> 8);
- USART->BAUDCTRLA = (BaudValue & 0xFF);
-
- USART->CTRLC = (USART_CMODE_ASYNCHRONOUS_gc | USART_PMODE_DISABLED_gc | USART_CHSIZE_8BIT_gc);
- USART->CTRLB = (USART_RXEN_bm | USART_TXEN_bm | (DoubleSpeed ? USART_CLK2X_bm : 0));
- }
-
- /** Turns off the USART driver, disabling and returning used hardware to their default configuration.
- *
- * \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;
- USART->CTRLB = 0;
- USART->CTRLC = 0;
- }
-
- /** Indicates whether a character has been received through the USART.
- *
- * \param[in,out] USART Pointer to the base of the USART peripheral within the device.
- *
- * \return Boolean \c true if a character has been received, \c false otherwise.
- */
- 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);
- }
-
- /** 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.
- */
- static inline void Serial_SendByte(USART_t* const USART,
- const char DataByte) ATTR_ALWAYS_INLINE ATTR_NON_NULL_PTR_ARG(1);
- static inline void Serial_SendByte(USART_t* const USART,
- const char DataByte)
- {
- while (!(Serial_IsSendReady(USART)));
- USART->DATA = DataByte;
- }
-
- /** Receives the next byte from the USART.
- *
- * \param[in,out] USART Pointer to the base of the USART peripheral within the device.
- *
- * \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 ATTR_NON_NULL_PTR_ARG(1);
- static inline int16_t Serial_ReceiveByte(USART_t* const USART)
- {
- if (!(Serial_IsCharReceived(USART)))
- return -1;
-
- USART->STATUS = USART_RXCIF_bm;
- return USART->DATA;
- }
-
- /* Disable C linkage for C++ Compilers: */
- #if defined(__cplusplus)
- }
- #endif
-
-#endif
-
-/** @} */
-