serial.c File Reference

Serial port configuration implementation. More...

#include <Lazuli/common.h>
#include <Lazuli/config.h>
#include <Lazuli/serial.h>
#include <Lazuli/sys/arch/arch.h>

Go to the source code of this file.

Functions
void	Lz_Serial_GetConfiguration (Lz_SerialConfiguration *const serialConfiguration)
	Retrieve the configuration of the serial line.
void	Lz_Serial_SetConfiguration (Lz_SerialConfiguration *const serialConfiguration)
	Set the configuration of the serial line.

Detailed Description

Serial port configuration implementation.

Copyright

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

This file describes the implementation of serial interface configuration.

Definition in file serial.c.

Function Documentation

Lz_Serial_GetConfiguration()

void Lz_Serial_GetConfiguration

(

Lz_SerialConfiguration *const

serialConfiguration

)

Retrieve the configuration of the serial line.

This function will fill the object pointed by the parameter with current serial settings.

Parameters

serialConfiguration

A pointer to an allocated Lz_SerialConfiguration (e.g. allocated on the stack).

Definition at line 20 of file serial.c.

Lz_Serial_SetConfiguration()

void Lz_Serial_SetConfiguration

(

Lz_SerialConfiguration *const

serialConfiguration

)

Set the configuration of the serial line.

This function will set the different parameters of the serial line according to the configuration pointed by the serialConfiguration parameter.

Warning

On the AVR platform this function will block interrupts if configuration option LZ_CONFIG_SERIAL_USE_INTERRUPTS is activated. On the AVR platform, this function will wait all transmit and receive operations has completed.

Parameters

serialConfiguration

A pointer to an allocated Lz_SerialConfiguration (e.g. allocated on the stack).

Definition at line 32 of file serial.c.