imt::base::bsp::driver::UsartDriver Class Reference

Driver for a single serial peripheral in the system. More...

#include <Imt.Base.BSP/Driver/UsartDriver.h>

Inheritance diagram for imt::base::bsp::driver::UsartDriver:

Public Member Functions
	UsartDriver (const size_t indexModule, const size_t indexPort)
	Constructor. More...
virtual	~UsartDriver (void)
	Destructor. More...
imt::base::bsp::type::ErrorCode::Id	read (uint8_t *pData, const size_t size, uint8_t *const pBytesRead)
	Reads up to the given number of bytes from the serial interface. More...
imt::base::bsp::type::ErrorCode::Id	write (const uint8_t pData[], const uint32_t size, uint8_t *const pBytesWritten)
	Writes the given number of bytes to the UART. More...
Public Member Functions inherited from imt::base::bsp::driver::ConfigurableDriverAbs< imt::base::bsp::type::DriverType::USART, UsartDriverConfiguration >
	ConfigurableDriverAbs (const size_t indexModule, const size_t indexPin)
	Constructor. More...
virtual	~ConfigurableDriverAbs (void)
	Destructor. More...
imt::base::bsp::type::ErrorCode::Id	configure (const UsartDriverConfiguration &configuration)
	Configures the driver. More...
const UsartDriverConfiguration &	getConfiguration (void) const
	Gets the last accepted configuration. More...
Public Member Functions inherited from imt::base::bsp::module::DriverAbs< TypeId >
	DriverAbs (const size_t indexModule, const size_t indexDriver)
	Constructor. More...
virtual	~DriverAbs (void)
	Destructor. More...
void	initialize (void)
	Initialize the driver. More...
void	enable (void)
	Enable the driver. More...
imt::base::bsp::type::ErrorCode::Id	start (void)
	Starts the driver. More...
imt::base::bsp::type::ErrorCode::Id	stop (void)
	Stops the driver. More...
size_t	getIndexDriver (void) const
	Gets the index of the driver inisde the module. More...
size_t	getIndexModule (void) const
	Gets the index of the module the driver is part of. More...
imt::base::bsp::type::DriverType::Id	getType (void) const
	Gets the type of the driver. More...
bool	isInitialized (void) const
	Gets if the driver has been initialzied. More...
bool	isEnabled (void) const
	Gets if the driver has been enabled. More...
bool	isStarted (void) const
	Gets if the driver has been started. More...

Protected Member Functions
virtual void	onInitialize (void)
virtual void	onEnable (void)
virtual imt::base::bsp::type::ErrorCode::Id	onStart (void)
virtual imt::base::bsp::type::ErrorCode::Id	onStop (void)
virtual imt::base::bsp::type::ErrorCode::Id	onReconfigure (const Configuration &configuration)

Additional Inherited Members
Public Types inherited from imt::base::bsp::driver::ConfigurableDriverAbs< imt::base::bsp::type::DriverType::USART, UsartDriverConfiguration >
typedef UsartDriverConfiguration	Configuration
	The type of the driver configuration. More...
Static Public Attributes inherited from imt::base::bsp::module::DriverAbs< TypeId >
static const imt::base::bsp::type::DriverType::Id	Type = TypeId
	Constant holding the driver type. More...

Detailed Description

Driver for a single serial peripheral in the system.

Constructor & Destructor Documentation

UsartDriver()

imt::base::bsp::driver::UsartDriver::UsartDriver ( const size_t  indexModule, const size_t  indexPort  )

explicit

Constructor.

Parameters

indexModule	Index of the module (starting at 0).
indexPort	Index of the port (starting at 0).

~UsartDriver()

virtual imt::base::bsp::driver::UsartDriver::~UsartDriver ( void  )

virtual

Destructor.

Member Function Documentation

onEnable()

virtual void imt::base::bsp::driver::UsartDriver::onEnable ( void  )

protectedvirtual

See also

DriverAbs

Implements imt::base::bsp::module::DriverAbs< TypeId >.

onInitialize()

virtual void imt::base::bsp::driver::UsartDriver::onInitialize ( void  )

protectedvirtual

See also

DriverAbs

Implements imt::base::bsp::module::DriverAbs< TypeId >.

onReconfigure()

virtual imt::base::bsp::type::ErrorCode::Id imt::base::bsp::driver::UsartDriver::onReconfigure ( const Configuration &  configuration )

protectedvirtual

See also

ConfigurableDriverAbs

Implements imt::base::bsp::driver::ConfigurableDriverAbs< imt::base::bsp::type::DriverType::USART, UsartDriverConfiguration >.

onStart()

virtual imt::base::bsp::type::ErrorCode::Id imt::base::bsp::driver::UsartDriver::onStart ( void  )

protectedvirtual

See also

DriverAbs

Implements imt::base::bsp::module::DriverAbs< TypeId >.

onStop()

virtual imt::base::bsp::type::ErrorCode::Id imt::base::bsp::driver::UsartDriver::onStop ( void  )

protectedvirtual

See also

DriverAbs

Implements imt::base::bsp::module::DriverAbs< TypeId >.

read()

imt::base::bsp::type::ErrorCode::Id imt::base::bsp::driver::UsartDriver::read	(	uint8_t *	pData,
		const size_t	size,
		uint8_t *const	pBytesRead
	)

Reads up to the given number of bytes from the serial interface.

Parameters

pData	The array the bytes will be written to.
size	The maximal number of bytes to read (array size).
pBytesRead	The actual number of bytes read.

Returns

OK Read was sucessfull. INVALID_ARGUMENT Null pointer passed. UNINITIALIZED Driver is not a valid USART. NO_DATA No data to read. INVALID_STATE Driver is not started. READ_ERROR Any other read error.

write()

imt::base::bsp::type::ErrorCode::Id imt::base::bsp::driver::UsartDriver::write	(	const uint8_t	pData[],
		const uint32_t	size,
		uint8_t *const	pBytesWritten
	)

Writes the given number of bytes to the UART.

Parameters

pData	The array of bytes to write.
size	The number of bytes to write.
pBytesWritten	The actual number of bytes written.

Returns

OK Write was sucessfull. INVALID_ARGUMENT Null pointer passed. UNINITIALIZED Driver is not a valid USART. OUT_OF_MEMORY Data does not fit into send buffer. INVALID_STATE Driver is not started. WRITE_ERROR Any other write error.

---

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

• D:/_Work/10/s/Imt.Base/Imt.Base.BSP/Driver/UsartDriver.h