projects / pub / USBasp.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Update UC3 platform driver support to use the bitmasks defined in the header files...
[pub/USBasp.git] / LUFA / Drivers / Peripheral / Serial.h
diff --git a/LUFA/Drivers/Peripheral/Serial.h b/LUFA/Drivers/Peripheral/Serial.h
index 549448d..856c54b 100644 (file)
--- a/LUFA/Drivers/Peripheral/Serial.h
+++ b/LUFA/Drivers/Peripheral/Serial.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
+     Copyright (C) Dean Camera, 2011.
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  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
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
@@ -29,154 +29,45 @@
 */
 
 /** \file
 */
 
 /** \file
- *  \brief Master include file for the USART peripheral driver.
+ *  \brief Hardware Serial USART driver.
  *
  *
- *  Driver for the USART subsystem on supported USB AVRs.
+ *  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
  */
 
 /** \ingroup Group_PeripheralDrivers
- *  @defgroup Group_Serial Serial USART Driver - LUFA/Drivers/Peripheral/Serial.h
+ *  \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:
  *
  *  \section Sec_Dependencies Module Source Dependencies
  *  The following files must be built with any user project that uses this module:
- *    - LUFA/Drivers/Peripheral/Serial.c <i>(Makefile source module name: LUFA_SRC_SERIAL)</i>
+ *    - 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
  *
  *  \section Sec_ModDescription Module Description
- *  Hardware serial USART driver. This module provides an easy to use driver for
- *  the setup of and transfer of data over the AVR's USART port.
- *
- *  \section Sec_ExampleUsage Example Usage
- *  The following snippet is an example of how this module may be used within a typical
- *  application.
- *
- *  \code
- *      // Initialise the serial USART driver before first use, with 9600 baud (and no double-speed mode)
- *      Serial_Init(9600, false);
- *
- *      // Send a string through the USART
- *      Serial_TxString("Test String\r\n");
+ *  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.
  *
  *
- *      // Receive a byte through the USART
- *      uint8_t DataByte = Serial_RxByte();
- *  \endcode
- *
- *  @{
+ *  \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__
 
  */
 
 #ifndef __SERIAL_H__
 #define __SERIAL_H__
 
-       /* Includes: */
-               #include <avr/io.h>
-               #include <avr/pgmspace.h>
-               #include <stdbool.h>
+       /* Macros: */
+               #define __INCLUDE_FROM_SERIAL_H
 
 
+       /* Includes: */
                #include "../../Common/Common.h"
                #include "../../Common/Common.h"
-               #include "../Misc/TerminalCodes.h"
-
-       /* Enable C linkage for C++ Compilers: */
-               #if defined(__cplusplus)
-                       extern "C" {
-               #endif
-
-       /* Public Interface - May be used in end-application: */
-               /* Macros: */
-                       /** Macro for calculating the baud value from a given baud rate when the U2X (double speed) bit is
-                        *  not set.
-                        */
-                       #define SERIAL_UBBRVAL(baud)    ((((F_CPU / 16) + (baud / 2)) / (baud)) - 1)
-
-                       /** Macro for calculating the baud value from a given baud rate when the U2X (double speed) bit is
-                        *  set.
-                        */
-                       #define SERIAL_2X_UBBRVAL(baud) ((((F_CPU / 8) + (baud / 2)) / (baud)) - 1)
-
-               /* Function Prototypes: */
-                       /** Transmits a given string located in program space (FLASH) through the USART.
-                        *
-                        *  \param[in] FlashStringPtr  Pointer to a string located in program space.
-                        */
-                       void Serial_TxString_P(const char* FlashStringPtr) ATTR_NON_NULL_PTR_ARG(1);
-
-                       /** Transmits a given string located in SRAM memory through the USART.
-                        *
-                        *  \param[in] StringPtr  Pointer to a string located in SRAM space.
-                        */
-                       void Serial_TxString(const char* StringPtr) ATTR_NON_NULL_PTR_ARG(1);
 
 
-               /* Inline Functions: */
-                       /** Initializes the USART, ready for serial data transmission and reception. This initializes the interface to
-                        *  standard 8-bit, no parity, 1 stop bit settings suitable for most applications.
-                        *
-                        *  \param[in] BaudRate     Serial baud rate, in bits per second.
-                        *  \param[in] DoubleSpeed  Enables double speed mode when set, halving the sample time to double the baud rate.
-                        */
-                       static inline void Serial_Init(const uint32_t BaudRate,
-                                                      const bool DoubleSpeed)
-                       {
-                               UBRR1  = (DoubleSpeed ? SERIAL_2X_UBBRVAL(BaudRate) : SERIAL_UBBRVAL(BaudRate));
-
-                               UCSR1C = ((1 << UCSZ11) | (1 << UCSZ10));
-                               UCSR1A = (DoubleSpeed ? (1 << U2X1) : 0);
-                               UCSR1B = ((1 << TXEN1)  | (1 << RXEN1));
-
-                               DDRD  |= (1 << 3);
-                               PORTD |= (1 << 2);
-                       }
-
-                       /** Turns off the USART driver, disabling and returning used hardware to their default configuration. */
-                       static inline void Serial_ShutDown(void)
-                       {
-                               UCSR1B = 0;
-                               UCSR1A = 0;
-                               UCSR1C = 0;
-
-                               UBRR1  = 0;
-
-                               DDRD  &= ~(1 << 3);
-                               PORTD &= ~(1 << 2);
-                       }
-
-                       /** Indicates whether a character has been received through the USART.
-                        *
-                        *  \return Boolean true if a character has been received, false otherwise.
-                        */
-                       static inline bool Serial_IsCharReceived(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
-                       static inline bool Serial_IsCharReceived(void)
-                       {
-                               return ((UCSR1A & (1 << RXC1)) ? true : false);
-                       }
-
-                       /** Transmits a given byte through the USART.
-                        *
-                        *  \param[in] DataByte  Byte to transmit through the USART.
-                        */
-                       static inline void Serial_TxByte(const char DataByte) ATTR_ALWAYS_INLINE;
-                       static inline void Serial_TxByte(const char DataByte)
-                       {
-                               while (!(UCSR1A & (1 << UDRE1)));
-                               UDR1 = DataByte;
-                       }
-
-                       /** Receives a byte from the USART. This function blocks until a byte has been
-                        *  received; if non-blocking behaviour is required, test for a received character
-                        *  beforehand with \ref Serial_IsCharReceived().
-                        *
-                        *  \return Byte received from the USART.
-                        */
-                       static inline char Serial_RxByte(void) ATTR_ALWAYS_INLINE;
-                       static inline char Serial_RxByte(void)
-                       {
-                               while (!(UCSR1A & (1 << RXC1)));
-                               return UDR1;
-                       }
-
-       /* Disable C linkage for C++ Compilers: */
-               #if defined(__cplusplus)
-                       }
+       /* 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
                #endif
 
 #endif
-
-/** @} */
-
USB isp AVR programmer