Merge pull request #21 from mondalaci/fix-ringbuffer-example

[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 7816b5d..f951f6b 100644 (file)
--- a/LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h
+++ b/LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2012.
+     Copyright (C) Dean Camera, 2014.
 
   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
@@ -40,26 +40,26 @@
 /** \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.
  *
  *  \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_AVR8_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(9600, false);
- *      
+ *
  *      // Send a string through the USART
  *      Serial_SendString("Test String\r\n");
  *
  *      // Send a raw byte through the USART
  *      Serial_SendByte(0xDC);
- *      
+ *
  *      // Receive a byte through the USART (or -1 if no data received)
  *      int16_t DataByte = Serial_ReceiveByte();
  *  \endcode
@@ -136,7 +136,7 @@
                         *  \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
@@ -153,7 +153,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);
-                       
+
                        /** Identical to \ref Serial_CreateStream(), except that reads are blocking until the calling stream function terminates
                         *  the transfer.
                         *
@@ -172,6 +172,8 @@
                         *  \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));
@@ -185,6 +187,7 @@
                        }
 
                        /** 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;