Added new CONCAT() and CONCAT_EXPANDED() convenience macros.
[pub/USBasp.git] / LUFA / Drivers / Peripheral / XMEGA / Serial_XMEGA.h
index 8dd7844..04941b1 100644 (file)
@@ -1,13 +1,13 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2012.
+     Copyright (C) Dean Camera, 2013.
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
-  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2013  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
@@ -18,7 +18,7 @@
   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
  *
  *  \code
  *      // Initialize the serial USART driver before first use, with 9600 baud (and no double-speed mode)
- *      Serial_Init(&USARTD, 9600, false);
+ *      Serial_Init(&USARTD0, 9600, false);
  *
  *      // Send a string through the USART
- *      Serial_TxString(&USARTD, "Test String\r\n");
+ *      Serial_TxString(&USARTD0, "Test String\r\n");
  *
  *      // Receive a byte through the USART
- *      uint8_t DataByte = Serial_RxByte(&USARTD);
+ *      uint8_t DataByte = Serial_RxByte(&USARTD0);
  *  \endcode
  *
  *  @{
                         *  \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
+                        *  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
 
                                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 = 0;
                        }
 
-                       /** 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.
-                        */
-                       static inline void Serial_CreateStream(USART_t* const USART,
-                                                              FILE* Stream)
-                       {
-                               if (!(Stream))
-                               {
-                                       Stream = &USARTSerialStream;
-                                       stdin  = Stream;
-                                       stdout = Stream;
-                               }
-
-                               *Stream = (FILE)FDEV_SETUP_STREAM(Serial_putchar, Serial_getchar, _FDEV_SETUP_RW);
-                               fdev_set_udata(Stream, USART);
-                       }
-
-                       /** 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.
-                        */
-                       static inline void Serial_CreateBlockingStream(USART_t* const USART,
-                                                                      FILE* Stream)
-                       {
-                               if (!(Stream))
-                               {
-                                       Stream = &USARTSerialStream;
-                                       stdin  = Stream;
-                                       stdout = Stream;
-                               }
-
-                               *Stream = (FILE)FDEV_SETUP_STREAM(Serial_putchar, Serial_getchar_Blocking, _FDEV_SETUP_RW);
-                               fdev_set_udata(Stream, USART);
-                       }
-
                        /** 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.