-/*\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
- * Driver for the USART subsystem on supported USB AVRs.\r
- */\r
- \r
-/** \ingroup Group_PeripheralDrivers\r
- * @defgroup Group_Serial Serial USART Driver - LUFA/Drivers/Peripheral/Serial.h\r
- *\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
- * Functions, macros, variables, enums and types related to the setup of the USART for serial communications.\r
- *\r
- * @{\r
- */\r
- \r
-#ifndef __SERIAL_H__\r
-#define __SERIAL_H__\r
-\r
- /* Includes: */\r
- #include <avr/io.h>\r
- #include <avr/pgmspace.h>\r
- #include <stdbool.h>\r
- \r
- #include "../../Common/Common.h"\r
- #include "../Misc/TerminalCodes.h"\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
- /* Macros: */ \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
- /* Psuedo-Functions: */\r
- #if defined(__DOXYGEN__)\r
- /** Indicates whether a character has been received through the USART.\r
- *\r
- * \return Boolean true if a character has been received, false otherwise\r
- */\r
- static inline bool Serial_IsCharReceived(void);\r
- #else\r
- #define Serial_IsCharReceived() ((UCSR1A & (1 << RXC1)) ? true : false)\r
- #endif\r
-\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
- * \param 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
- * \param 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
- /* 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
- #endif\r
- \r
-#endif\r
-\r
-/** @} */\r
+/*
+ LUFA Library
+ Copyright (C) Dean Camera, 2011.
+
+ dean [at] fourwalledcubicle [dot] com
+ www.lufa-lib.org
+*/
+
+/*
+ Copyright 2011 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
+ without fee, provided that the above copyright notice appear in
+ all copies and that both that the copyright notice and this
+ permission notice and warranty disclaimer appear in supporting
+ documentation, and that the name of the author not be used in
+ advertising or publicity pertaining to distribution of the
+ software without specific, written prior permission.
+
+ The author disclaim 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
+ whatsoever resulting from loss of use, data or profits, whether
+ in an action of contract, negligence or other tortious action,
+ arising out of or in connection with the use or performance of
+ this software.
+*/
+
+/** \file
+ * \brief Hardware Serial USART driver.
+ *
+ * This file is the master dispatch header file for the device-specific USART driver, for microcontrollers
+ * containing a hardware USART.
+ *
+ * User code should include this file, which will in turn include the correct ADC driver header file for the
+ * currently selected architecture and microcontroller model.
+ */
+
+/** \ingroup Group_PeripheralDrivers
+ * \defgroup Group_Serial Serial USART Driver - LUFA/Drivers/Peripheral/Serial.h
+ * \brief Hardware Serial USART driver.
+ *
+ * \section Sec_Dependencies Module Source Dependencies
+ * The following files must be built with any user project that uses this module:
+ * - LUFA/Drivers/Peripheral/<i>ARCH</i>/Serial_<i>ARCH</i>.c <i>(Makefile source module name: LUFA_SRC_SERIAL)</i>
+ *
+ * \section Sec_ModDescription Module Description
+ * Hardware serial USART driver. This module provides an easy to use driver for the setup and transfer
+ * of data over the selected architecture and microcontroller model's USART port.
+ *
+ * \note The exact API for this driver may vary depending on the target used - see
+ * individual target module documentation for the API specific to your target processor.
+ */
+
+#ifndef __SERIAL_H__
+#define __SERIAL_H__
+
+ /* Macros: */
+ #define __INCLUDE_FROM_SERIAL_H
+
+ /* Includes: */
+ #include "../../Common/Common.h"
+
+ /* Includes: */
+ #if (ARCH == ARCH_AVR8)
+ #include "AVR8/Serial_AVR8.h"
+ #else
+ #error The Serial peripheral driver is not currently available for your selected architecture.
+ #endif
+
+#endif
projects / pub / USBasp.git / blobdiff