Add script reading bootloader flags
[pub/lufa.git] / LUFA / Drivers / Peripheral / XMEGA / Serial_XMEGA.h
index ad34c85..215c7a4 100644 (file)
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2014.
+     Copyright (C) Dean Camera, 2021.
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
-  Copyright 2014  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2021  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
                         *  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.
                         *
                         *  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.
                         */
                         *  \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(FILE* Stream);
+                       void Serial_CreateStream(USART_t* USART, FILE* Stream);
 
 
-                       /** Identical to \ref Serial_CreateStream(), except that reads are blocking until the calling stream function terminates
+            /** Identical to \ref Serial_CreateStream(), except that reads are blocking until the calling stream function terminates
                         *  the transfer.
                         *
                         *  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.
                         */
                         *  \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(FILE* Stream);
+                       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.
 
                /* 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.
+                        *  \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,
                         *  \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,