Start porting the USB core to the AVR32 UC3B.

[pub/USBasp.git] / LUFA / Drivers / Peripheral / Serial.h

diff --git a/LUFA/Drivers/Peripheral/Serial.h b/LUFA/Drivers/Peripheral/Serial.h
index d83761f..838c1fd 100644 (file)
--- a/LUFA/Drivers/Peripheral/Serial.h
+++ b/LUFA/Drivers/Peripheral/Serial.h
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r

-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r

               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\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
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\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
   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r


@@ -30,13 +30,23 @@
 \r
 /** \file\r
  *\r
 \r
 /** \file\r
  *\r

- *  Driver for the USART subsystem on supported USB AVRs.\r
+ *  This file is the master dispatch header file for the device-specific USART driver, for AVRs containing a\r
+ *  USART.\r
+ *\r
+ *  User code should include this file, which will in turn include the correct USART driver header file for\r
+ *  the currently selected AVR model.\r

  */\r
  \r
  */\r
  \r

-/** \ingroup Group_SubsystemDrivers\r
+/** \ingroup Group_PeripheralDrivers\r

  *  @defgroup Group_Serial Serial USART Driver - LUFA/Drivers/Peripheral/Serial.h\r
  *\r
  *  @defgroup Group_Serial Serial USART Driver - LUFA/Drivers/Peripheral/Serial.h\r
  *\r

- *  Functions, macros, variables, enums and types related to the setup of the USART for serial communications.\r
+ *  \section Sec_Dependencies Module Source Dependencies\r
+ *  The following files must be built with any user project that uses this module:\r
+ *    - LUFA/Drivers/Peripheral/Serial.c\r
+ *\r
+ *  \section Module Description\r
+ *  Hardware serial USART driver. This module provides an easy to use driver for\r
+ *  the setup of and transfer of data over the AVR's USART port.\r

  *\r
  *  @{\r
  */\r
  *\r
  *  @{\r
  */\r


@@ -44,77 +54,40 @@
 #ifndef __SERIAL_H__\r
 #define __SERIAL_H__\r
 \r
 #ifndef __SERIAL_H__\r
 #define __SERIAL_H__\r
 \r

+       /* Macros: */\r
+       #if !defined(__DOXYGEN__)\r
+               #define __INCLUDE_FROM_SERIAL_H\r
+       #endif\r
+\r

        /* Includes: */\r
        /* Includes: */\r

-               #include <avr/io.h>\r
-               #include <avr/pgmspace.h>\r
-               #include <stdbool.h>\r
-               \r
-               #include "../../Common/Common.h"\r
+               #include "../../Common/Common.h"                \r

                #include "../Misc/TerminalCodes.h"\r
 \r
                #include "../Misc/TerminalCodes.h"\r
 \r

+               #if defined(__AVR32__)\r
+                       #include "AVR32/Serial.h"\r
+               #elif defined(__AVR__)\r
+                       #include "AVR8/Serial.h"                \r
+               #endif\r
+               \r

        /* Enable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
                        extern "C" {\r
                #endif\r
 \r
        /* Public Interface - May be used in end-application: */\r
        /* Enable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
                        extern "C" {\r
                #endif\r
 \r
        /* Public Interface - May be used in end-application: */\r

-               /* Macros: */   \r
-                       /** Indicates whether a character has been received through the USART - boolean false if no character\r
-                        *  has been received, or non-zero if a character is waiting to be read from the reception buffer.\r
-                        */\r
-                       #define Serial_IsCharReceived() ((UCSR1A & (1 << RXC1)) ? true : false)\r
-\r
-                       /** Macro for calculating the baud value from a given baud rate when the U2X (double speed) bit is\r
-                        *  not set.\r
-                        */\r
-                       #define SERIAL_UBBRVAL(baud)    (((F_CPU / 16) / baud) - 1)\r
-\r
-                       /** Macro for calculating the baud value from a given baud rate when the U2X (double speed) bit is\r
-                        *  set.\r
-                        */\r
-                       #define SERIAL_2X_UBBRVAL(baud) (((F_CPU / 8) / baud) - 1)\r
-\r

                /* Function Prototypes: */\r
                /* Function Prototypes: */\r

-                       /** Initializes the USART, ready for serial data transmission and reception.\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
-                       void Serial_Init(const uint32_t BaudRate, const bool DoubleSpeed);\r
-\r

                        /** Transmits a given string located in program space (FLASH) through the USART.\r
                         *\r
                        /** Transmits a given string located in program space (FLASH) through the USART.\r
                         *\r

-                        *  \param FlashStringPtr  Pointer to a string located in program space\r
+                        *  \param[in] FlashStringPtr  Pointer to a string located in program space\r

                         */\r
                        void Serial_TxString_P(const char *FlashStringPtr) ATTR_NON_NULL_PTR_ARG(1);\r
 \r
                        /** Transmits a given string located in SRAM memory through the USART.\r
                         *\r
                         */\r
                        void Serial_TxString_P(const char *FlashStringPtr) ATTR_NON_NULL_PTR_ARG(1);\r
 \r
                        /** Transmits a given string located in SRAM memory through the USART.\r
                         *\r

-                        *  \param StringPtr  Pointer to a string located in SRAM space\r
+                        *  \param[in] StringPtr  Pointer to a string located in SRAM space\r

                         */\r
                        void Serial_TxString(const char *StringPtr) ATTR_NON_NULL_PTR_ARG(1);\r
 \r
                         */\r
                        void Serial_TxString(const char *StringPtr) ATTR_NON_NULL_PTR_ARG(1);\r
 \r

-               /* Inline Functions: */\r
-                       /** Transmits a given byte through the USART.\r
-                        *\r
-                        *  \param DataByte  Byte to transmit through the USART\r
-                        */\r
-                       static inline void Serial_TxByte(const char DataByte)\r
-                       {\r
-                               while (!(UCSR1A & (1 << UDRE1)));\r
-                               UDR1 = DataByte;\r
-                       }\r
-\r
-                       /** Receives a byte from the USART.\r
-                        *\r
-                        *  \return Byte received from the USART\r
-                        */\r
-                       static inline char Serial_RxByte(void)\r
-                       {\r
-                               while (!(UCSR1A & (1 << RXC1)));\r
-                               return UDR1; \r
-                       }\r
-\r

        /* Disable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
                        }\r
        /* Disable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
                        }\r