ATmega328p USART driver. More...

#include <stdint.h>
#include <stdio.h>
#include <Lazuli/common.h>
#include <Lazuli/config.h>
#include <Lazuli/serial.h>
#include <Lazuli/sys/arch/AVR/usart.h>
#include <Lazuli/sys/arch/arch.h>
#include <Lazuli/sys/compiler.h>
#include <Lazuli/sys/kernel.h>

Functions
int	putchar (int c)
	Transmit a single character on the serial line.

int	puts (const char *s)
	Transmit the NUL-terminated string `s` followed by a trailing newline on the serial line, without any formatting.

static enum Lz_SerialEnableFlags	GetEnablingStatus (void)
	Retrieve the enabling status of the serial line.

static enum Lz_SerialStopBits	GetStopBits (void)
	Retrieve the number of stop bits currently used by the serial line.

static enum Lz_SerialParityBit	GetParityBit (void)
	Retrieve the kind of parity currently used by the serial line.

static enum Lz_SerialSize	GetSize (void)
	Retrieve the character size currently used by the serial line.

static void	SetEnablingStatus (const enum Lz_SerialEnableFlags flags)
	Set the enabling/disabling of Tx/Rx of the serial line.

static void	SetStopBits1 (void)
	Set USART to use 1 stop bit.

static void	SetStopBits2 (void)
	Set USART to use 2 stop bits.

static void	SetStopBits (const enum Lz_SerialStopBits stopBits)
	Set the number of stop bits of the serial line.

static void	SetParityBitNone (void)
	Set no parity bit.

static void	SetParityBitEven (void)
	Set even parity bit.

static void	SetParityBitOdd (void)
	Set odd parity bit.

static void	SetParityBit (const enum Lz_SerialParityBit parityBit)
	Set the kind of parity bit of the serial line.

static void	SetSize5 (void)
	Set character size to 5 bits.

static void	SetSize6 (void)
	Set character size to 6 bits.

static void	SetSize7 (void)
	Set character size to 7 bits.

static void	SetSize8 (void)
	Set character size to 8 bits.

static void	SetSize (const enum Lz_SerialSize size)
	Set the character size of the serial line.

static void	SetSpeed (const enum Lz_SerialSpeed speed)
	Set the baud rate of the serial line.

void	Arch_GetSerialConfiguration (Lz_SerialConfiguration *const configuration)
	Retrieve the current configuration of the serial line.

void	Arch_SetSerialConfiguration (const Lz_SerialConfiguration *const configuration)
	Configure the serial line according to the parameter.

void	Arch_InitSerial (void)
	Initialize serial line with default configuration at system startup.

Variables
static Usart *const	usart = (Usart*)&UCSR0A
	A constant pointer to the memory mapped Usart structure.

static enum Lz_SerialSpeed	currentSerialSpeed
	The current serial baud rate.

static void(*const	setStopBits [])(void)
	Jump table to functions setting the number of stop bits of the serial line.

static void(*const	setParityBit [])(void)
	Jump table to functions setting the kind of parity of the serial line.

static void(*const	setSize [])(void)
	Jump table to functions setting character sizes of the serial line.

static const uint16_t	serialSpeedRegisterValue []
	Jump table containing the setting values of UBRR0L and UBRR0H registers for baud rates defined in Lz_SerialSpeed.

Detailed Description

ATmega328p USART driver.

Copyright: 2019-2020, Remi Andruccioli remi..nosp@m.andr.nosp@m.uccio.nosp@m.li@g.nosp@m.mail..nosp@m.com

Describes the driver implementation for the USART of the ATMega328p.

Definition in file usart.c.

Function Documentation

◆ putchar()

int putchar ( int c )

Transmit a single character on the serial line.

Parameters

c	The character to transmit, that will be cast to an unsigned char.

Returns: The actual value of the transmitted character, resulting from the cast, as an int.

Warning: This operation is not thread safe. No locking mechanism is provided.

Definition at line 40 of file usart.c.

◆ puts()

int puts ( const char * s )

Transmit the NUL-terminated string s followed by a trailing newline on the serial line, without any formatting.

Parameters

s	The string to transmit.

Returns: A non-negative number on success, otherwise EOF on error.

Warning: This operation is not thread safe. No locking mechanism is provided.

Definition at line 52 of file usart.c.

◆ GetEnablingStatus()

static enum Lz_SerialEnableFlags GetEnablingStatus ( void )

static

Retrieve the enabling status of the serial line.

Returns: An Lz_SerialEnableFlags containing the enabling status.

Definition at line 79 of file usart.c.

◆ GetStopBits()

static enum Lz_SerialStopBits GetStopBits ( void )

static

Retrieve the number of stop bits currently used by the serial line.

Returns: An Lz_SerialStopBits containing the number of stop bits.

Definition at line 100 of file usart.c.

◆ GetParityBit()

static enum Lz_SerialParityBit GetParityBit ( void )

static

Retrieve the kind of parity currently used by the serial line.

Returns: An Lz_SerialParityBit containing the kind of parity.

Definition at line 115 of file usart.c.

◆ GetSize()

static enum Lz_SerialSize GetSize ( void )

static

Retrieve the character size currently used by the serial line.

Returns: An Lz_SerialSize containing the character size.

Definition at line 138 of file usart.c.

◆ SetEnablingStatus()

static void SetEnablingStatus ( const enum Lz_SerialEnableFlags flags )

static

Set the enabling/disabling of Tx/Rx of the serial line.

Parameters

flags An Lz_SerialEnableFlags containing enable flags.

Definition at line 165 of file usart.c.

◆ SetStopBits1()

static void SetStopBits1 ( void )

static

Set USART to use 1 stop bit.

Definition at line 184 of file usart.c.

◆ SetStopBits2()

static void SetStopBits2 ( void )

static

Set USART to use 2 stop bits.

Definition at line 193 of file usart.c.

◆ SetStopBits()

static void SetStopBits ( const enum Lz_SerialStopBits stopBits )

static

Set the number of stop bits of the serial line.

Parameters

stopBits An Lz_SerialStopBits defining the number of stop bits.

Definition at line 224 of file usart.c.

◆ SetParityBitNone()

static void SetParityBitNone ( void )

static

Set no parity bit.

Definition at line 243 of file usart.c.

◆ SetParityBitEven()

static void SetParityBitEven ( void )

static

Set even parity bit.

Definition at line 252 of file usart.c.

◆ SetParityBitOdd()

static void SetParityBitOdd ( void )

static

Set odd parity bit.

Definition at line 262 of file usart.c.

◆ SetParityBit()

static void SetParityBit ( const enum Lz_SerialParityBit parityBit )

static

Set the kind of parity bit of the serial line.

Parameters

parityBit An Lz_SerialParityBit defining the kind of parity.

Definition at line 294 of file usart.c.

◆ SetSize5()

static void SetSize5 ( void )

static

Set character size to 5 bits.

Definition at line 313 of file usart.c.

◆ SetSize6()

static void SetSize6 ( void )

static

Set character size to 6 bits.

Definition at line 323 of file usart.c.

◆ SetSize7()

static void SetSize7 ( void )

static

Set character size to 7 bits.

Definition at line 334 of file usart.c.

◆ SetSize8()

static void SetSize8 ( void )

static

Set character size to 8 bits.

Definition at line 345 of file usart.c.

◆ SetSize()

static void SetSize ( const enum Lz_SerialSize size )

static

Set the character size of the serial line.

Parameters

size	An Lz_SerialSize defining the character size.

Definition at line 378 of file usart.c.

◆ SetSpeed()

static void SetSpeed ( const enum Lz_SerialSpeed speed )

static

Set the baud rate of the serial line.

Parameters

speed An Lz_SerialSpeed value defining the baud rate.

Definition at line 421 of file usart.c.

◆ Arch_GetSerialConfiguration()

void Arch_GetSerialConfiguration ( Lz_SerialConfiguration *const configuration )

Retrieve the current configuration of the serial line.

Parameters

configuration A pointer to an allocated Lz_SerialConfiguration used to store the configuration.

Definition at line 441 of file usart.c.

◆ Arch_SetSerialConfiguration()

void Arch_SetSerialConfiguration ( const Lz_SerialConfiguration *const configuration )

Configure the serial line according to the parameter.

Parameters

configuration A pointer to an existing Lz_SerialConfiguration containing the full configuration to set up the serial line.

Definition at line 451 of file usart.c.

◆ Arch_InitSerial()

void Arch_InitSerial ( void )

Initialize serial line with default configuration at system startup.

< member: enableFlags

< member: stopBits

< member: parityBits

< member: size

< member: speed

Definition at line 480 of file usart.c.

Variable Documentation

◆ usart

Usart* const usart = (Usart*)&UCSR0A

static

A constant pointer to the memory mapped Usart structure.

Definition at line 28 of file usart.c.

◆ currentSerialSpeed

enum Lz_SerialSpeed currentSerialSpeed

static

The current serial baud rate.

This is used to save the current setting of the serial baud rate. On AVR, the setting of the speed isn't always accurate once calculated, so we use this variable to store it and be able to retrieve it easily.

Definition at line 37 of file usart.c.

◆ setStopBits

void(*const setStopBits[])(void) ( void )

static

Initial value:

= {
  SetStopBits1, 
  SetStopBits2  
}

Jump table to functions setting the number of stop bits of the serial line.

Warning: This table must be ordered by entry values of enum Lz_SerialStopBits.

Definition at line 205 of file usart.c.

◆ setParityBit

void(*const setParityBit[])(void) ( void )

static

Initial value:

= {
  SetParityBitNone, 
  SetParityBitEven, 
  SetParityBitOdd   
}

Jump table to functions setting the kind of parity of the serial line.

Warning: This table must be ordered by entry values of enum Lz_SerialParityBit.

Definition at line 274 of file usart.c.

◆ setSize

void(*const setSize[])(void) ( void )

static

Initial value:

= {
  SetSize5, 
  SetSize6, 
  SetSize7, 
  SetSize8  
}

Jump table to functions setting character sizes of the serial line.

Warning: This table must be ordered by entry values of enum Lz_SerialSize.

Definition at line 357 of file usart.c.

◆ serialSpeedRegisterValue

const uint16_t serialSpeedRegisterValue[]

static

Initial value:

= {
  (uint16_t)416, 
  (uint16_t)207, 
  (uint16_t)103, 
  (uint16_t)51   
}

Jump table containing the setting values of UBRR0L and UBRR0H registers for baud rates defined in Lz_SerialSpeed.

Warning: This table must be ordered by entry values of enum Lz_SerialSpeed.

Definition at line 400 of file usart.c.

Functions

Variables

Detailed Description

Function Documentation

◆ putchar()

◆ puts()

◆ GetEnablingStatus()

◆ GetStopBits()

◆ GetParityBit()

◆ GetSize()

◆ SetEnablingStatus()

◆ SetStopBits1()

◆ SetStopBits2()

◆ SetStopBits()

◆ SetParityBitNone()

◆ SetParityBitEven()

◆ SetParityBitOdd()

◆ SetParityBit()

◆ SetSize5()

◆ SetSize6()

◆ SetSize7()

◆ SetSize8()

◆ SetSize()

◆ SetSpeed()

◆ Arch_GetSerialConfiguration()

◆ Arch_SetSerialConfiguration()

◆ Arch_InitSerial()

Variable Documentation

◆ usart

◆ currentSerialSpeed

◆ setStopBits

◆ setParityBit

◆ setSize

◆ serialSpeedRegisterValue