Add first draft of the TPI NVM commands for reading, writing and erasing a target...
[pub/USBasp.git] / LUFA / Drivers / Peripheral / SerialStream.h
index 2753135..61c151a 100644 (file)
@@ -9,13 +9,13 @@
 /*\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
+  Permission to use, copy, modify, distribute, and sell this \r
+  software and its documentation for any purpose is hereby granted\r
+  without fee, provided that the above copyright notice appear in \r
+  all 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
                        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
+               #if defined(INCLUDE_FROM_SERIALSTREAM_C)\r
+                       static int SerialStream_TxByte(char DataByte, FILE *Stream) ATTR_NON_NULL_PTR_ARG(2);\r
+                       static int SerialStream_RxByte(FILE *Stream) ATTR_NON_NULL_PTR_ARG(1);\r
+               #endif\r
        #endif\r
 \r
        /* Public Interface - May be used in end-application: */\r
@@ -79,8 +81,8 @@
                        /** 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
+                        *  \param[in] BaudRate     Baud rate to configure the USART to\r
+                        *  \param[in] 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
                                \r
                                stdout = &USARTStream;\r
                        }\r
+                       \r
+                       /** Turns off the serial stream (and regular USART driver), disabling and returning used hardware to\r
+                        *  their default configuration.\r
+                        */\r
+                       static inline void SerialStream_ShutDown(void)\r
+                       {\r
+                               Serial_ShutDown();\r
+                       }                       \r
 \r
        /* Disable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r