Functions

Serial Stream Driver - LUFA/Drivers/Peripheral/SerialStream.h
[On-chip Peripheral Drivers]

Functions

static void SerialStream_Init (const uint32_t BaudRate, const bool DoubleSpeed)
static void SerialStream_ShutDown (void)

Detailed Description

Module Source Dependencies

The following files must be built with any user project that uses this module:

Description

Serial stream driver for the USART subsystem on supported USB AVRs. This makes use of the functions in the regular USART driver (see Serial USART Driver - LUFA/Drivers/Peripheral/Serial.h), but allows the avr-libc standard stream functions (printf, puts, etc.) to work with the USART.


Function Documentation

static void SerialStream_Init ( const uint32_t  BaudRate,
const bool  DoubleSpeed 
) [inline, static]

Initialises the serial stream (and regular USART driver) so that both the stream and regular USART driver functions can be used. Must be called before any stream or regular USART functions.

Parameters:
[in]BaudRateBaud rate to configure the USART to.
[in]DoubleSpeedEnables double speed mode when set, halving the sample time to double the baud rate.
static void SerialStream_ShutDown ( void   ) [inline, static]

Turns off the serial stream (and regular USART driver), disabling and returning used hardware to their default configuration.