Serial USART Driver - LUFA/Drivers/Peripheral/Serial.h
[On-chip Peripheral Drivers]
Detailed Description
The following files must be built with any user project that uses this module:
- LUFA/Drivers/Peripheral/Serial.c
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.
Define Documentation
#define SERIAL_2X_UBBRVAL |
( |
baud |
|
) |
(((F_CPU / 8) / baud) - 1) |
Macro for calculating the baud value from a given baud rate when the U2X (double speed) bit is set.
#define SERIAL_UBBRVAL |
( |
baud |
|
) |
(((F_CPU / 16) / baud) - 1) |
Macro for calculating the baud value from a given baud rate when the U2X (double speed) bit is not set.
Function Documentation
static void Serial_Init |
( |
const uint32_t |
BaudRate, |
|
|
const bool |
DoubleSpeed | |
|
) |
| | [inline, static] |
Initializes the USART, ready for serial data transmission and reception. This initialises the interface to standard 8-bit, no parity, 1 stop bit settings suitable for most applications.
- Parameters:
-
[in] | BaudRate | Serial baud rate, in bits per second |
[in] | DoubleSpeed | Enables double speed mode when set, halving the sample time to double the baud rate |
static bool Serial_IsCharReceived |
( |
void |
|
) |
[inline, static] |
Indicates whether a character has been received through the USART.
- Returns:
- Boolean true if a character has been received, false otherwise
static char Serial_RxByte |
( |
void |
|
) |
[inline, static] |
Receives a byte from the USART.
- Returns:
- Byte received from the USART
static void Serial_ShutDown |
( |
void |
|
) |
[inline, static] |
Turns off the USART driver, disabling and returning used hardware to their default configuration.
static void Serial_TxByte |
( |
const char |
DataByte |
) |
[inline, static] |
Transmits a given byte through the USART.
- Parameters:
-
[in] | DataByte | Byte to transmit through the USART |
void Serial_TxString |
( |
const char * |
StringPtr |
) |
|
Transmits a given string located in SRAM memory through the USART.
- Parameters:
-
[in] | StringPtr | Pointer to a string located in SRAM space |
void Serial_TxString_P |
( |
const char * |
FlashStringPtr |
) |
|
Transmits a given string located in program space (FLASH) through the USART.
- Parameters:
-
[in] | FlashStringPtr | Pointer to a string located in program space |