Rename Drivers/AT90USBXXX to Drivers/Peripheral.

[pub/lufa.git] / LUFA / Drivers / Peripheral / Serial_Stream.h

diff --git a/LUFA/Drivers/Peripheral/Serial_Stream.h b/LUFA/Drivers/Peripheral/Serial_Stream.h
new file mode 100644 (file)
index 0000000..406cbed
--- /dev/null
+++ b/LUFA/Drivers/Peripheral/Serial_Stream.h
@@ -0,0 +1,93 @@
+/*\r
+             LUFA Library\r
+     Copyright (C) Dean Camera, 2009.\r
+              \r
+  dean [at] fourwalledcubicle [dot] com\r
+      www.fourwalledcubicle.com\r
+*/\r
+\r
+/*\r
+  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+  Permission to use, copy, modify, and distribute this software\r
+  and its documentation for any purpose and without fee is hereby\r
+  granted, provided that the above copyright notice appear in all\r
+  copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting\r
+  documentation, and that the name of the author not be used in\r
+  advertising or publicity pertaining to distribution of the\r
+  software without specific, written prior permission.\r
+\r
+  The author disclaim all warranties with regard to this\r
+  software, including all implied warranties of merchantability\r
+  and fitness.  In no event shall the author be liable for any\r
+  special, indirect or consequential damages or any damages\r
+  whatsoever resulting from loss of use, data or profits, whether\r
+  in an action of contract, negligence or other tortious action,\r
+  arising out of or in connection with the use or performance of\r
+  this software.\r
+*/\r
+\r
+/** \file\r
+ *\r
+ *  Serial stream driver for the USART subsystem on supported USB AVRs. This makes use of the functions in the\r
+ *  regular USART driver, but allows the avr-libc standard stream functions (printf, puts, etc.) to work with the\r
+ *  USART.\r
+ **/\r
+\r
+/** \ingroup Group_SubsystemDrivers\r
+ *  @defgroup Group_SerialStream Serial Stream Driver - LUFA/Drivers/Peripheral/Serial_Stream.h\r
+ *\r
+ *  Functions, macros, variables, enums and types related to the setup of a serial stream, so that standard printf and other\r
+ *  C stream functions can be used on the serial port.\r
+ *\r
+ *  @{\r
+ */\r
+\r
+#ifndef __SERIAL_STREAM_H__\r
+#define __SERIAL_STREAM_H__\r
+\r
+       /* Includes: */\r
+               #include <avr/io.h>\r
+               #include <stdio.h>\r
+               \r
+               #include "Serial.h"\r
+       \r
+       /* Enable C linkage for C++ Compilers: */\r
+               #if defined(__cplusplus)\r
+                       extern "C" {\r
+               #endif\r
+\r
+       /* Private Interface - For use in library only: */      \r
+       #if !defined(__DOXYGEN__)\r
+               /* External Variables: */\r
+                       extern FILE USARTStream;\r
+\r
+               /* Function Prototypes: */\r
+                       int SerialStream_TxByte(char DataByte, FILE *Stream) ATTR_NON_NULL_PTR_ARG(2);\r
+                       int SerialStream_RxByte(FILE *Stream) ATTR_NON_NULL_PTR_ARG(1);\r
+       #endif\r
+\r
+       /* Public Interface - May be used in end-application: */\r
+               /* Inline Functions: */\r
+                       /** Initializes the serial stream (and regular USART driver) so that both the stream and regular\r
+                        *  USART driver functions can be used. Must be called before any stream or regular USART functions.\r
+                        *\r
+                        *  \param BaudRate     Baud rate to configure the USART to\r
+                        *  \param DoubleSpeed  Enables double speed mode when set, halving the sample time to double the baud rate\r
+                        */\r
+                       static inline void SerialStream_Init(const uint32_t BaudRate, const bool DoubleSpeed)\r
+                       {\r
+                               Serial_Init(BaudRate, DoubleSpeed);\r
+                               \r
+                               stdout = &USARTStream;\r
+                       }\r
+\r
+       /* Disable C linkage for C++ Compilers: */\r
+               #if defined(__cplusplus)\r
+                       }\r
+               #endif\r
+\r
+#endif\r
+\r
+/** @} */\r