Make twi capitalization match.

[pub/USBasp.git] / LUFA / Drivers / Peripheral / XMEGA / Serial_XMEGA.h

diff --git a/LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.h b/LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.h
index c2cb77f..1161ef6 100644 (file)
--- a/LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.h
+++ b/LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2012.
+     Copyright (C) Dean Camera, 2014.

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

-  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2014  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,23 +40,23 @@
 /** \ingroup Group_Serial
  *  \defgroup Group_Serial_XMEGA Serial USART Peripheral Driver (XMEGA)
  *
 /** \ingroup Group_Serial
  *  \defgroup Group_Serial_XMEGA Serial USART Peripheral Driver (XMEGA)
  *

- *  \section Sec_ModDescription Module Description
+ *  \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.
  *
  *  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_ExampleUsage Example Usage
+ *  \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);
  *  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");
  *      // 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
  *      // Receive a byte through the USART
  *      uint8_t DataByte = Serial_RxByte(&USARTD0);
  *  \endcode


@@ -139,7 +139,8 @@
                         *  \param[in]     Length  Length of the data to send, in bytes.
                         */
                        void Serial_SendData(USART_t* const USART,
                         *  \param[in]     Length  Length of the data to send, in bytes.
                         */
                        void Serial_SendData(USART_t* const USART,

-                                            const uint8_t* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
+                                            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
 
                        /** 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


@@ -156,7 +157,7 @@
                         *  \pre The USART must first be configured via a call to \ref Serial_Init() before the stream is used.
                         */
                        void Serial_CreateStream(FILE* Stream);
                         *  \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.
                         *
                        /** Identical to \ref Serial_CreateStream(), except that reads are blocking until the calling stream function terminates
                         *  the transfer.
                         *


@@ -177,13 +178,16 @@
                         */
                        static inline void Serial_Init(USART_t* const USART,
                                                       const uint32_t BaudRate,
                         */
                        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);
                                                       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));
                        }
                                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));
                        }


@@ -192,20 +196,21 @@
                         *
                         *  \param[in,out] USART  Pointer to the base of the USART peripheral within the device.
                         */
                         *
                         *  \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;
                        }
                        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.
                         */
                        /** 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_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
+                       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);
                        static inline bool Serial_IsCharReceived(USART_t* const USART)
                        {
                                return ((USART->STATUS & USART_RXCIF_bm) ? true : false);


@@ -217,7 +222,7 @@
                         *  \param[in]     DataByte  Byte to transmit through the USART.
                         */
                        static inline void Serial_SendByte(USART_t* const USART,
                         *  \param[in]     DataByte  Byte to transmit through the USART.
                         */
                        static inline void Serial_SendByte(USART_t* const USART,

-                                                          const char DataByte) ATTR_ALWAYS_INLINE;
+                                                          const char DataByte) ATTR_ALWAYS_INLINE ATTR_NON_NULL_PTR_ARG(1);

                        static inline void Serial_SendByte(USART_t* const USART,
                                                           const char DataByte)
                        {
                        static inline void Serial_SendByte(USART_t* const USART,
                                                           const char DataByte)
                        {


@@ -231,7 +236,7 @@
                         *
                         *  \return Next byte received from the USART, or a negative value if no byte has been received.
                         */
                         *
                         *  \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;
+                       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)))
                        static inline int16_t Serial_ReceiveByte(USART_t* const USART)
                        {
                                if (!(Serial_IsCharReceived(USART)))