bsp::mid::drv::UART< BaseAddress > Struct Template Reference

UART implementation for Midgard. More...

#include <uart.hpp>

Static Public Member Functions
static bool	init ()
	Init function. More...
static bool	deinit ()
	Deinit function. More...
static void	receive (std::string &buffer)
	UART receive string. More...
template<size_t N>
static void	receive (std::array< u8, N > &buffer)
	UART receive. More...
static void	transmit (std::string_view buffer)
	UART transmit string. More...
template<size_t N>
static void	transmit (const std::array< u8, N > &buffer)
	UART transmit. More...

Detailed Description

template<addr_t BaseAddress>
struct bsp::mid::drv::UART< BaseAddress >

UART implementation for Midgard.

Warning

Do not use this on its own!

Template Parameters

BaseAddress

UART Block base address

Member Function Documentation

deinit()

template<addr_t BaseAddress>

static bool bsp::mid::drv::UART< BaseAddress >::deinit ( )

inlinestatic

Deinit function.

Returns

Success

init()

template<addr_t BaseAddress>

static bool bsp::mid::drv::UART< BaseAddress >::init ( )

inlinestatic

Init function.

Returns

Success

receive() [1/2]

template<addr_t BaseAddress>

template<size_t N>

static void bsp::mid::drv::UART< BaseAddress >::receive ( std::array< u8, N > &  buffer )

inlinestatic

UART receive.

Template Parameters

N

Data size

Parameters

buffer

Array for the read data

receive() [2/2]

template<addr_t BaseAddress>

static void bsp::mid::drv::UART< BaseAddress >::receive ( std::string &  buffer )

inlinestatic

UART receive string.

Note

The function receives until a '\n' or a '\r'

Parameters

buffer

Buffer for the read string

transmit() [1/2]

template<addr_t BaseAddress>

template<size_t N>

static void bsp::mid::drv::UART< BaseAddress >::transmit ( const std::array< u8, N > &  buffer )

inlinestatic

UART transmit.

Template Parameters

N

Data size

Parameters

buffer

Array for the data to write

transmit() [2/2]

template<addr_t BaseAddress>

static void bsp::mid::drv::UART< BaseAddress >::transmit ( std::string_view  buffer )

inlinestatic

UART transmit string.

Parameters

buffer

Buffer for the string to write

---

The documentation for this struct was generated from the following file:

• Inc/cpp/midgard/driver/uart.hpp