Update documentation and reset version information post-release.

[pub/USBasp.git] / LUFA / Drivers / Peripheral / AVR8 / Serial_AVR8.h

diff --git a/LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h b/LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h
index 7f519d3..ad8a4b6 100644 (file)
--- a/LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h
+++ b/LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2011.
+     Copyright (C) Dean Camera, 2015.

 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*

-  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2015  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


@@ -18,7 +18,7 @@
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 

-  The author disclaim all warranties with regard to this
+  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
   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


@@ -40,13 +40,13 @@
 /** \ingroup Group_Serial
  *  \defgroup Group_Serial_AVR8 Serial USART Peripheral Driver (AVR8)
  *
 /** \ingroup Group_Serial
  *  \defgroup Group_Serial_AVR8 Serial USART Peripheral Driver (AVR8)
  *

- *  \section Sec_ModDescription Module Description
+ *  \section Sec_Serial_AVR8_ModDescription Module Description

  *  On-chip serial USART driver for the 8-bit AVR microcontrollers.
  *
  *  On-chip serial USART driver for the 8-bit AVR microcontrollers.
  *

- *  \note This file should not be included directly. It is automatically included as needed by the ADC driver
+ *  \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.
  *
  *        dispatch header located in LUFA/Drivers/Peripheral/Serial.h.
  *

- *  \section Sec_ExampleUsage Example Usage
+ *  \section Sec_Serial_AVR8_ExampleUsage Example Usage

  *  The following snippet is an example of how this module may be used within a typical
  *  application.
  *
  *  The following snippet is an example of how this module may be used within a typical
  *  application.
  *


@@ -55,10 +55,13 @@
  *      Serial_Init(9600, false);
  *
  *      // Send a string through the USART
  *      Serial_Init(9600, false);
  *
  *      // Send a string through the USART

- *      Serial_TxString("Test String\r\n");
+ *      Serial_SendString("Test String\r\n");
+ *
+ *      // Send a raw byte through the USART
+ *      Serial_SendByte(0xDC);

  *
  *

- *      // Receive a byte through the USART
- *      uint8_t DataByte = Serial_RxByte();
+ *      // Receive a byte through the USART (or -1 if no data received)
+ *      int16_t DataByte = Serial_ReceiveByte();

  *  \endcode
  *
  *  @{
  *  \endcode
  *
  *  @{


@@ -70,7 +73,7 @@
        /* Includes: */
                #include "../../../Common/Common.h"
                #include "../../Misc/TerminalCodes.h"
        /* Includes: */
                #include "../../../Common/Common.h"
                #include "../../Misc/TerminalCodes.h"

-               
+

                #include <stdio.h>
 
        /* Enable C linkage for C++ Compilers: */
                #include <stdio.h>
 
        /* Enable C linkage for C++ Compilers: */


@@ -87,7 +90,7 @@
        #if !defined(__DOXYGEN__)
                /* External Variables: */
                        extern FILE USARTSerialStream;
        #if !defined(__DOXYGEN__)
                /* External Variables: */
                        extern FILE USARTSerialStream;

-       
+

                /* Function Prototypes: */
                        int Serial_putchar(char DataByte,
                                           FILE *Stream);
                /* Function Prototypes: */
                        int Serial_putchar(char DataByte,
                                           FILE *Stream);


@@ -97,44 +100,81 @@
 
        /* Public Interface - May be used in end-application: */
                /* Macros: */
 
        /* Public Interface - May be used in end-application: */
                /* Macros: */

-                       /** Macro for calculating the baud value from a given baud rate when the U2X (double speed) bit is
+                       /** Macro for calculating the baud value from a given baud rate when the \c U2X (double speed) bit is

                         *  not set.
                         *  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)
+                       #define SERIAL_UBBRVAL(Baud)    ((((F_CPU / 16) + (Baud / 2)) / (Baud)) - 1)

 
 

-                       /** Macro for calculating the baud value from a given baud rate when the U2X (double speed) bit is
+                       /** Macro for calculating the baud value from a given baud rate when the \c U2X (double speed) bit is

                         *  set.
                         *  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)
+                       #define SERIAL_2X_UBBRVAL(Baud) ((((F_CPU / 8) + (Baud / 2)) / (Baud)) - 1)

 
                /* Function Prototypes: */
 
                /* Function Prototypes: */

-                       /** Transmits a given string located in program space (FLASH) through the USART.
+                       /** Transmits a given NUL terminated string located in program space (FLASH) through the USART.

                         *
                         *  \param[in] FlashStringPtr  Pointer to a string located in program space.
                         */
                        void Serial_SendString_P(const char* FlashStringPtr) ATTR_NON_NULL_PTR_ARG(1);
 
                         *
                         *  \param[in] FlashStringPtr  Pointer to a string located in program space.
                         */
                        void Serial_SendString_P(const char* FlashStringPtr) ATTR_NON_NULL_PTR_ARG(1);
 

-                       /** Transmits a given string located in SRAM memory through the USART.
+                       /** Transmits a given NUL terminated string located in SRAM memory through the USART.

                         *
                         *  \param[in] StringPtr  Pointer to a string located in SRAM space.
                         */
                        void Serial_SendString(const char* StringPtr) ATTR_NON_NULL_PTR_ARG(1);
                         *
                         *  \param[in] StringPtr  Pointer to a string located in SRAM space.
                         */
                        void Serial_SendString(const char* StringPtr) ATTR_NON_NULL_PTR_ARG(1);

-                       
+

                        /** Transmits a given buffer located in SRAM memory through the USART.
                         *
                         *  \param[in] Buffer  Pointer to a buffer containing the data to send.
                         *  \param[in] Length  Length of the data to send, in bytes.
                         */
                        /** Transmits a given buffer located in SRAM memory through the USART.
                         *
                         *  \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(const uint8_t* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
+                       void Serial_SendData(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] 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);
+
+                       /** Identical to \ref Serial_CreateStream(), except that reads are blocking until the calling stream function terminates
+                        *  the transfer.
+                        *
+                        *  \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);

 
                /* 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.
                         *
 
                /* 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] 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(const uint32_t BaudRate,
                         *  \param[in] DoubleSpeed  Enables double speed mode when set, halving the sample time to double the baud rate.
                         */
                        static inline void Serial_Init(const uint32_t BaudRate,

+                                                      const bool DoubleSpeed);
+                       static inline void Serial_Init(const uint32_t BaudRate,

                                                       const bool DoubleSpeed)
                        {
                                UBRR1  = (DoubleSpeed ? SERIAL_2X_UBBRVAL(BaudRate) : SERIAL_UBBRVAL(BaudRate));
                                                       const bool DoubleSpeed)
                        {
                                UBRR1  = (DoubleSpeed ? SERIAL_2X_UBBRVAL(BaudRate) : SERIAL_UBBRVAL(BaudRate));


@@ -148,6 +188,7 @@
                        }
 
                        /** Turns off the USART driver, disabling and returning used hardware to their default configuration. */
                        }
 
                        /** Turns off the USART driver, disabling and returning used hardware to their default configuration. */

+                       static inline void Serial_Disable(void);

                        static inline void Serial_Disable(void)
                        {
                                UCSR1B = 0;
                        static inline void Serial_Disable(void)
                        {
                                UCSR1B = 0;


@@ -160,70 +201,49 @@
                                PORTD &= ~(1 << 2);
                        }
 
                                PORTD &= ~(1 << 2);
                        }
 

-                       /** 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] Stream  Pointer to a FILE structure where the created stream should be placed, if \c NULL stdio
-                        *                         and stdin will be configured to use the USART.
+                       /** Indicates whether a character has been received through the USART.

                         *
                         *

-                        *  \pre The USART must first be configured via a call to \ref Serial_Init() before the stream is used.
+                        *  \return Boolean \c true if a character has been received, \c false otherwise.

                         */
                         */

-                       static inline void Serial_CreateStream(FILE* Stream)
+                       static inline bool Serial_IsCharReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
+                       static inline bool Serial_IsCharReceived(void)

                        {
                        {

-                               if (!(Stream))
-                               {
-                                       Stream = &USARTSerialStream;
-                                       stdin  = Stream;
-                                       stdout = Stream;
-                               }
-                       
-                               *Stream = (FILE)FDEV_SETUP_STREAM(Serial_putchar, Serial_getchar, _FDEV_SETUP_RW);
+                               return ((UCSR1A & (1 << RXC1)) ? true : false);

                        }
 
                        }
 

-                       /** Identical to \ref Serial_CreateStream(), except that reads are blocking until the calling stream function terminates
-                        *  the transfer.
-                        *
-                        *  \param[in,out] Stream  Pointer to a FILE structure where the created stream should be placed, if \c NULL stdio
-                        *                         and stdin will be configured to use the USART.
+                       /** 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.

                         *
                         *

-                        *  \pre The USART must first be configured via a call to \ref Serial_Init() before the stream is used.
+                        *  \return Boolean \c true if a character can be queued for transmission immediately, \c false otherwise.

                         */
                         */

-                       static inline void Serial_CreateBlockingStream(FILE* Stream)
+                       static inline bool Serial_IsSendReady(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
+                       static inline bool Serial_IsSendReady(void)

                        {
                        {

-                               if (!(Stream))
-                               {
-                                       Stream = &USARTSerialStream;
-                                       stdin  = Stream;
-                                       stdout = Stream;
-                               }
-
-                               *Stream = (FILE)FDEV_SETUP_STREAM(Serial_putchar, Serial_getchar_Blocking, _FDEV_SETUP_RW);
+                               return ((UCSR1A & (1 << UDRE1)) ? true : false);

                        }
 
                        }
 

-                       /** Indicates whether a character has been received through the USART.
+                       /** Indicates whether the hardware USART transmit buffer is completely empty, indicating all
+                        *  pending transmissions have completed.

                         *
                         *

-                        *  \return Boolean \c true if a character has been received, \c false otherwise.
+                        *  \return Boolean \c true if no characters are buffered for transmission, \c false otherwise.

                         */
                         */

-                       static inline bool Serial_IsCharReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
-                       static inline bool Serial_IsCharReceived(void)
+                       static inline bool Serial_IsSendComplete(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
+                       static inline bool Serial_IsSendComplete(void)

                        {
                        {

-                               return ((UCSR1A & (1 << RXC1)) ? true : false);
+                               return ((UCSR1A & (1 << TXC1)) ? true : false);

                        }
 
                        /** Transmits a given byte through the USART.
                         *
                        }
 
                        /** 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)
                        {
                         *  \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;
                        }
 
                                UDR1 = DataByte;
                        }
 


@@ -236,7 +256,7 @@
                        {
                                if (!(Serial_IsCharReceived()))
                                  return -1;
                        {
                                if (!(Serial_IsCharReceived()))
                                  return -1;

-                               
+

                                return UDR1;
                        }
 
                                return UDR1;
                        }