X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/0f45b9c8e076483cd546d0bc9c606b73455295c6..5517f96e86b9447780a3e27bb455697f9fc65eea:/LUFA/Drivers/Peripheral/Serial.h

diff --git a/LUFA/Drivers/Peripheral/Serial.h b/LUFA/Drivers/Peripheral/Serial.h
index 23bbd6a4b..37722db0a 100644
--- a/LUFA/Drivers/Peripheral/Serial.h
+++ b/LUFA/Drivers/Peripheral/Serial.h
@@ -1,7 +1,7 @@
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.
-              
+
   dean [at] fourwalledcubicle [dot] com
       www.fourwalledcubicle.com
 */
@@ -9,13 +9,13 @@
 /*
   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
-  Permission to use, copy, modify, distribute, and sell this 
+  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 
+  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 
+  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
@@ -33,7 +33,7 @@
  *
  *  Driver for the USART subsystem on supported USB AVRs.
  */
- 
+
 /** \ingroup Group_PeripheralDrivers
  *  @defgroup Group_Serial Serial USART Driver - LUFA/Drivers/Peripheral/Serial.h
  *
@@ -47,7 +47,7 @@
  *
  *  @{
  */
- 
+
 #ifndef __SERIAL_H__
 #define __SERIAL_H__
 
@@ -55,7 +55,7 @@
 		#include <avr/io.h>
 		#include <avr/pgmspace.h>
 		#include <stdbool.h>
-		
+
 		#include "../../Common/Common.h"
 		#include "../Misc/TerminalCodes.h"
 
@@ -90,7 +90,7 @@
 			void Serial_TxString(const char* StringPtr) ATTR_NON_NULL_PTR_ARG(1);
 
 		/* Inline Functions: */
-			/** Initialises the USART, ready for serial data transmission and reception. This initialises the interface to
+			/** 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.
@@ -99,27 +99,27 @@
 			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));
-				UCSR1C = ((1 << UCSZ11) | (1 << UCSZ10));
-				
-				DDRD  |= (1 << 3);	
+
+				DDRD  |= (1 << 3);
 				PORTD |= (1 << 2);
-				
-				UBRR1  = (DoubleSpeed ? SERIAL_2X_UBBRVAL(BaudRate) : SERIAL_UBBRVAL(BaudRate));
 			}
 
 			/** Turns off the USART driver, disabling and returning used hardware to their default configuration. */
 			static inline void Serial_ShutDown(void)
 			{
-				UCSR1A = 0;
 				UCSR1B = 0;
+				UCSR1A = 0;
 				UCSR1C = 0;
-				
-				DDRD  &= ~(1 << 3);	
-				PORTD &= ~(1 << 2);
-				
+
 				UBRR1  = 0;
+
+				DDRD  &= ~(1 << 3);
+				PORTD &= ~(1 << 2);
 			}
 
 			/** Indicates whether a character has been received through the USART.
@@ -131,7 +131,7 @@
 			{
 				return ((UCSR1A & (1 << RXC1)) ? true : false);
 			}
-			
+
 			/** Transmits a given byte through the USART.
 			 *
 			 *  \param[in] DataByte  Byte to transmit through the USART.
@@ -143,7 +143,9 @@
 				UDR1 = DataByte;
 			}
 
-			/** Receives a byte from the USART.
+			/** 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.
 			 */
@@ -151,14 +153,15 @@
 			static inline char Serial_RxByte(void)
 			{
 				while (!(UCSR1A & (1 << RXC1)));
-				return UDR1; 
+				return UDR1;
 			}
 
 	/* Disable C linkage for C++ Compilers: */
 		#if defined(__cplusplus)
 			}
 		#endif
-		
+
 #endif
 
 /** @} */
+