Serial.h 4.62 KB
Newer Older
1
2
/*
             LUFA Library
Dean Camera's avatar
Dean Camera committed
3
     Copyright (C) Dean Camera, 2010.
4
5
6
7
8
9
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
Dean Camera's avatar
Dean Camera committed
10
  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
11

12
13
14
15
16
17
18
  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 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
  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
 *
33
34
35
36
 *  ADC driver for the 8-bit AVRs.
 *
 *  \note This file should not be included directly. It is automatically included as needed by the USART driver
 *        dispatch header located in LUFA/Drivers/Peripheral/Serial.h.
37
38
 */
 
39
40
/** \ingroup Group_Serial
 *  @defgroup Group_Serial_AVR8 8-Bit AVR Serial Driver
41
 *
42
 *  Serial driver for the 8-bit AVRs.
43
 *
44
45
 *  \note This file should not be included directly. It is automatically included as needed by the ADC driver
 *        dispatch header located in LUFA/Drivers/Peripheral/USART.h.
46
47
48
49
 *
 *  @{
 */
 
50
51
#ifndef __SERIAL_AVR8_H__
#define __SERIAL_AVR8_H__
52
53
54
55
56
57

	/* Includes: */
		#include <avr/io.h>
		#include <avr/pgmspace.h>
		#include <stdbool.h>
		
58
59
60
	/* Preprocessor Checks: */
		#if !defined(__INCLUDE_FROM_SERIAL_H)
			#error Do not include this file directly. Include LUFA/Drivers/Peripheral/Serial.h instead.
61
62
63
		#endif

	/* Public Interface - May be used in end-application: */
64
		/* Macros: */
65
66
67
			/** Macro for calculating the baud value from a given baud rate when the U2X (double speed) bit is
			 *  not set.
			 */
68
			#define SERIAL_UBBRVAL(baud)    ((((F_CPU / 16) + (baud / 2)) / (baud)) - 1)
69
70
71
72

			/** Macro for calculating the baud value from a given baud rate when the U2X (double speed) bit is
			 *  set.
			 */
73
			#define SERIAL_2X_UBBRVAL(baud) ((((F_CPU / 8) + (baud / 2)) / (baud)) - 1)
74

75
		/* Pseudo-Function Macros: */
76
77
78
79
80
81
82
83
84
85
			#if defined(__DOXYGEN__)
				/** 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);
			#else
				#define Serial_IsCharReceived() ((UCSR1A & (1 << RXC1)) ? true : false)
			#endif

86
		/* Inline Functions: */
87
			/** Initializes the USART, ready for serial data transmission and reception. This initializes the interface to
88
89
			 *  standard 8-bit, no parity, 1 stop bit settings suitable for most applications.
			 *
90
91
			 *  \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
92
93
94
95
96
97
98
99
100
101
102
103
104
			 */
			static inline void Serial_Init(const uint32_t BaudRate, const bool DoubleSpeed)
			{
				UCSR1A = (DoubleSpeed ? (1 << U2X1) : 0);
				UCSR1B = ((1 << TXEN1)  | (1 << RXEN1));
				UCSR1C = ((1 << UCSZ11) | (1 << UCSZ10));
				
				DDRD  |= (1 << 3);	
				PORTD |= (1 << 2);
				
				UBRR1  = (DoubleSpeed ? SERIAL_2X_UBBRVAL(BaudRate) : SERIAL_UBBRVAL(BaudRate));
			}

105
106
107
108
109
110
111
112
113
114
115
116
117
			/** Turns off the USART driver, disabling and returning used hardware to their default configuration. */
			static inline void Serial_ShutDown(void)
			{
				UCSR1A = 0;
				UCSR1B = 0;
				UCSR1C = 0;
				
				DDRD  &= ~(1 << 3);	
				PORTD &= ~(1 << 2);
				
				UBRR1  = 0;
			}
			
118
119
			/** Transmits a given byte through the USART.
			 *
120
			 *  \param[in] DataByte  Byte to transmit through the USART
121
122
123
124
125
126
127
128
129
130
131
			 */
			static inline void Serial_TxByte(const char DataByte)
			{
				while (!(UCSR1A & (1 << UDRE1)));
				UDR1 = DataByte;
			}

			/** Receives a byte from the USART.
			 *
			 *  \return Byte received from the USART
			 */
132
			static inline uint8_t Serial_RxByte(void)
133
134
135
136
137
138
139
140
141
142
143
			{
				while (!(UCSR1A & (1 << RXC1)));
				return UDR1; 
			}

	/* Disable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			}
		#endif
		
#endif
144
145

/** @} */