#include <nrf51_i2c_master.hpp>

Inheritance diagram for nRF51i2cMaster_Blocking< TTWIIndex, TSclPin, TSdaPin >:

Public Types
using	cb_t = stdext::inplace_function< void(i2c::op_t, i2c::status)>
	Represents the type of the callback operation. More...

using	sweep_list_t = etl::vector< uint8_t, 128 >

using	sweep_cb_t = stdext::inplace_function< void(void)>

Public Member Functions
	nRFi2cMaster_Blocking () noexcept

	nRFi2cMaster_Blocking (const char *name) noexcept

	~nRFi2cMaster_Blocking ()=default

virtual void	configure (i2c::baud baud, i2c::pullups pull=i2c::pullups::external) noexcept
	Configure the I2C bus. More...

i2c::state	state () const noexcept
	Check the I2C bus status. More...

i2c::pullups	pullups (i2c::pullups pullups) noexcept
	Configure pull-ups. More...

i2c::pullups	pullups () const noexcept
	Check the pull-up configuration. More...

void	sweep (sweep_list_t &found_list, const sweep_cb_t &cb) noexcept
	Perform an I2C bus sweep to identify active devices. More...

void	start () noexcept
	Start the driver. More...

void	stop () noexcept
	Stop the driver. More...

void	restart () noexcept
	Restart the driver. More...

type_safe::boolean	started () const noexcept
	Check if the driver has been started. More...

constexpr embvm::DriverType_t	DriverType () const noexcept
	Returns the registered type ID of the driver. More...

constexpr const std::string_view &	name () const noexcept
	Provides a string_view reference of the driver name. More...

constexpr const char *	name_cstr () const noexcept
	Provides a c-string version of the driver name. More...

virtual DriverBase &	operator++ () noexcept
	Increment operator is a no-op, but is used for iterator compatibility. More...

Static Public Member Functions
static constexpr embvm::DriverType	type () noexcept
	I2C Driver Type ID. More...

Protected Attributes
i2c::pullups	pullups_ = i2c::pullups::external
	Tracks the active pull-up configuration. More...

i2c::state	state_ = i2c::state::idle
	Tracks the status of the I2C bus. More...

type_safe::boolean	started_ = false
	Tracks the driver state. More...

const std::string_view	name_
	Name of the driver instance. More...

const embvm::DriverType_t	type_
	Type ID of the driver instance. More...

Private Member Functions
void	start_ () noexcept final
	Derived classes override the start_ method to control driver-specific startup behavior. More...

void	stop_ () noexcept final
	Derived classes override the start_ method to control driver-specific startup behavior. More...

void	configure_ (embvm::i2c::pullups pullup) noexcept final
	Configure the I2C bus for operation. More...

embvm::i2c::status	transfer_ (const embvm::i2c::op_t &op, const embvm::i2c::master::cb_t &cb) noexcept final

embvm::i2c::baud	baudrate_ (embvm::i2c::baud baud) noexcept final

embvm::i2c::pullups	setPullups_ (embvm::i2c::pullups pullups) noexcept final
	Configure pull-ups. More...

Detailed Description

template<unsigned TTWIIndex, typename TSclPin, typename TSdaPin>
class nRF51i2cMaster_Blocking< TTWIIndex, TSclPin, TSdaPin >

Template Parameters

TTWIIndex	The instance of the TWI to use. Can be 0 or 1.
TSclPin	A class representing the SCL pin. This is designed for use with nRFPinID<>: nRFi2cMaster_Blocking<0, nRFPinID<0,27>, nRFPinID<0,26>> i2c0;
TSdaPin	A class representing the SDA pin. This is designed for use with nRFPinID<>: nRFi2cMaster_Blocking<0, nRFPinID<0,27>, nRFPinID<0,26>> i2c0;

Member Typedef Documentation

◆ cb_t

using embvm::i2c::master::cb_t = stdext::inplace_function<void(i2c::op_t, i2c::status)>

inherited

Represents the type of the callback operation.

◆ sweep_cb_t

using embvm::i2c::master::sweep_cb_t = stdext::inplace_function<void(void)>

inherited

◆ sweep_list_t

using embvm::i2c::master::sweep_list_t = etl::vector<uint8_t, 128>

inherited

Constructor & Destructor Documentation

◆ ~nRFi2cMaster_Blocking()

template<unsigned TTWIIndex, typename TSclPin , typename TSdaPin >

nRF51i2cMaster_Blocking< TTWIIndex, TSclPin, TSdaPin >::~nRFi2cMaster_Blocking ( )

default

Member Function Documentation

◆ baudrate_()

template<unsigned TTWIIndex, typename TSclPin , typename TSdaPin >

embvm::i2c::baud nRF51i2cMaster_Blocking< TTWIIndex, TSclPin, TSdaPin >::baudrate_ ( embvm::i2c::baud baud )

inlinefinalprivatevirtualnoexcept

Implements embvm::i2c::master.

References nRFTWITranslator::setFrequency().

◆ configure()

virtual void embvm::i2c::master::configure	(	i2c::baud	baud,
		i2c::pullups	pull = `i2c::pullups::external`
	)

inlinevirtualnoexceptinherited

Configure the I2C bus.

Configures the I2C bus for operation and sets the target baud rate and pull-ups.

Derived classes must implement the configure_() function to set up the target hardware.

Parameters

baud	The target baudrate (as an i2c::baud enumeration rather than integral Hz). TODO: Tolerance - allowed relative tolerance for the resulting baudrate
pull	The pullup setting, which defaults to external pull-ups (in hardware).

References embvm::i2c::master::configure_(), and embvm::i2c::master::pullups().

Referenced by embvm::i2c::activeMaster< 128 >::configure_(), and FWDemoSimulatorHWPlatform::init_().

◆ configure_()

template<unsigned TTWIIndex, typename TSclPin , typename TSdaPin >

void nRF51i2cMaster_Blocking< TTWIIndex, TSclPin, TSdaPin >::configure_ ( embvm::i2c::pullups pullups )

inlinefinalprivatevirtualnoexcept

Configure the I2C bus for operation.

This function is implemented by the derived class. It is responsible for configuring the target hardware for operation.

Parameters

pullups The target pull-up configuration.

Implements embvm::i2c::master.

◆ DriverType()

constexpr embvm::DriverType_t embvm::DriverBase::DriverType ( ) const

inlinenoexceptinherited

Returns the registered type ID of the driver.

When using DriverBase interfaces, clients can retrieve the registered driver type in order to up-cast to the correct interface.

The type is returned as a embvm::DriverType_t rather than a embvm::DriverType enum to work with custom user-defined types. Enforcing a embvm::DriverType return value would prevent clients from defining and using their own custom types.

Returns: the registered driver type as a embvm::DriverType_t value

References embvm::DriverBase::type_.

◆ name()

constexpr const std::string_view& embvm::DriverBase::name ( ) const

inlinenoexceptinherited

Provides a string_view reference of the driver name.

Returns: std::string_view ref containing the driver name.

References embvm::DriverBase::name_.

◆ name_cstr()

constexpr const char* embvm::DriverBase::name_cstr ( ) const

inlinenoexceptinherited

Provides a c-string version of the driver name.

Returns: c-string containing the driver name

References embvm::DriverBase::name_.

◆ nRFi2cMaster_Blocking() [1/2]

template<unsigned TTWIIndex, typename TSclPin , typename TSdaPin >

nRF51i2cMaster_Blocking< TTWIIndex, TSclPin, TSdaPin >::nRFi2cMaster_Blocking ( )

inlinenoexcept

◆ nRFi2cMaster_Blocking() [2/2]

template<unsigned TTWIIndex, typename TSclPin , typename TSdaPin >

nRF51i2cMaster_Blocking< TTWIIndex, TSclPin, TSdaPin >::nRFi2cMaster_Blocking ( const char * name )

inlinenoexcept

◆ operator++()

virtual DriverBase& embvm::DriverBase::operator++ ( )

inlinevirtualnoexceptinherited

Increment operator is a no-op, but is used for iterator compatibility.

◆ pullups() [1/2]

i2c::pullups embvm::i2c::master::pullups ( i2c::pullups pullups )

inlinenoexceptinherited

Configure pull-ups.

Parameters

pullups The target pull-up setting.

Returns: The configured pull-up setting.

References embvm::i2c::master::pullups_, and embvm::i2c::master::setPullups_().

Referenced by embvm::i2c::activeMaster< 128 >::setPullups_().

◆ pullups() [2/2]

i2c::pullups embvm::i2c::master::pullups ( ) const

inlinenoexceptinherited

Check the pull-up configuration.

Returns: The configured pull-up setting.

References embvm::i2c::master::pullups_.

Referenced by embvm::i2c::master::configure(), nRF51i2cMaster_Blocking< TTWIIndex, TSclPin, TSdaPin >::setPullups_(), and nRFi2cMaster< NordicTWIM0, nRFPinID< 0, 27 >, nRFPinID< 0, 26 > >::setPullups_().

◆ restart()

void embvm::DriverBase::restart ( )

inlinenoexceptinherited

Restart the driver.

Calls stop() and then start() on the driver. If the driver is not started, then it will be started after the start() function is invoked.

References embvm::DriverBase::start(), and embvm::DriverBase::stop().

◆ setPullups_()

template<unsigned TTWIIndex, typename TSclPin , typename TSdaPin >

embvm::i2c::pullups nRF51i2cMaster_Blocking< TTWIIndex, TSclPin, TSdaPin >::setPullups_ ( embvm::i2c::pullups pullups )

inlinefinalprivatevirtualnoexcept

Configure pull-ups.

This function is implemented by the derived class. It is responsible for configuring the target hardware to use the requested pullup setting.

Parameters

pullups The target pull-up setting.

Returns: The configured pull-up setting.

Implements embvm::i2c::master.

References embvm::i2c::master::pullups().

◆ start()

void embvm::DriverBase::start ( )

inlinenoexceptinherited

Start the driver.

If the driver is not started, call the start_() function defined by the derived class. (Template Method Pattern)

References embvm::DriverBase::start_(), and embvm::DriverBase::started_.

Referenced by NRF52DongleHWPlatform::init_(), NRF52DKHWPlatform::init_(), BlinkySimulatorHWPlatform::init_(), FWDemoSimulatorHWPlatform::init_(), FrameworkDemoSimPlatform::initHWPlatform_(), embvm::DriverBase::restart(), embvm::timer::Timer::restart(), embvm::spi::activeMaster< TQueueSize, TLock, TCond >::start_(), embvm::i2c::activeMaster< 128 >::start_(), embdrv::aardvarkSPIMaster::start_(), embdrv::aardvarkI2CMaster::start_(), embdrv::aardvarkGPIOInput< 4 >::start_(), embdrv::vl53l1x::start_(), embdrv::aardvarkGPIOOutput< 5 >::start_(), BlinkySimulatorHWPlatform::startBlink(), and FWDemoSimulatorHWPlatform::startLEDTimer().

◆ start_()

template<unsigned TTWIIndex, typename TSclPin , typename TSdaPin >

void nRF51i2cMaster_Blocking< TTWIIndex, TSclPin, TSdaPin >::start_ ( )

inlinefinalprivatevirtualnoexcept

Derived classes override the start_ method to control driver-specific startup behavior.

(Template Method Pattern)

Implements embvm::i2c::master.

References nRFGPIOTranslator::configure_i2c(), nRFTWITranslator::enable(), nRFTWITranslator::setSCLPin(), and nRFTWITranslator::setSDAPin().

◆ started()

type_safe::boolean embvm::DriverBase::started ( ) const

inlinenoexceptinherited

Check if the driver has been started.

Returns: true if the driver is running (started), false if not running (stopped).

References embvm::DriverBase::started_.

Referenced by embdrv::aardvarkSPIMaster::configure_(), embdrv::aardvarkGPIOInput< 4 >::get(), embdrv::aardvarkGPIOOutput< 5 >::set(), embdrv::vl53l1x::start_(), embdrv::aardvarkAdapter::start_(), and embdrv::aardvarkAdapter::stop_().

◆ state()

i2c::state embvm::i2c::master::state ( ) const

inlinenoexceptinherited

Check the I2C bus status.

Returns: the status of the I2C bus as an i2c::state enumeration.

References embvm::i2c::master::state_.

◆ stop()

void embvm::DriverBase::stop ( )

inlinenoexceptinherited

Stop the driver.

If the driver has been started, call the stop_() function defined by the derived class. (Template Method Pattern)

References embvm::DriverBase::started_, and embvm::DriverBase::stop_().

Referenced by embvm::DriverBase::restart(), embvm::timer::Timer::restart(), embvm::spi::activeMaster< TQueueSize, TLock, TCond >::stop_(), embvm::i2c::activeMaster< 128 >::stop_(), embdrv::aardvarkSPIMaster::stop_(), embdrv::aardvarkI2CMaster::stop_(), embdrv::aardvarkGPIOInput< 4 >::stop_(), embdrv::aardvarkGPIOOutput< 5 >::stop_(), FWDemoSimulatorHWPlatform::~FWDemoSimulatorHWPlatform(), and embdrv::SimulatorTimer::~SimulatorTimer().

◆ stop_()

template<unsigned TTWIIndex, typename TSclPin , typename TSdaPin >

void nRF51i2cMaster_Blocking< TTWIIndex, TSclPin, TSdaPin >::stop_ ( )

inlinefinalprivatevirtualnoexcept

Derived classes override the start_ method to control driver-specific startup behavior.

(Template Method Pattern)

Implements embvm::i2c::master.

References nRFGPIOTranslator::configure_default(), and nRFTWITranslator::disable().

◆ sweep()

void embvm::i2c::master::sweep	(	sweep_list_t &	found_list,
		const sweep_cb_t &	cb
	)

noexceptinherited

Perform an I2C bus sweep to identify active devices.

The sweep function pings all I2C addresses. Devices which ACK are stored in a list and returned via callback.

Parameters

[in,out]	found_list	Caller's memory which will contain the successfully found ping addresses
[in]	cb	The callback which will be called to indicate that the sweep is complete. After the cb is called, found_list is valid and can be used by the caller.

References embvm::i2c::op_t::address, embvm::i2c::busy, I2C_ADDR_MAX, and embvm::i2c::op_t::op.

◆ transfer_()

template<unsigned TTWIIndex, typename TSclPin , typename TSdaPin >

embvm::i2c::status nRF51i2cMaster_Blocking< TTWIIndex, TSclPin, TSdaPin >::transfer_	(	const embvm::i2c::op_t &	op,
		const embvm::i2c::master::cb_t &	cb
	)

inlinefinalprivatevirtualnoexcept

Implements embvm::i2c::master.

References embvm::i2c::continueWriteNoStop, embvm::i2c::continueWriteStop, nRFTWITranslator::NO_STOP, embvm::i2c::ok, embvm::i2c::ping, embvm::i2c::read, embvm::i2c::restart, nRFTWITranslator::set_transfer_address(), nRFTWITranslator::STOP, embvm::i2c::stop, nRFTWITranslator::stop_condition(), embvm::i2c::write, embvm::i2c::writeNoStop, and embvm::i2c::writeRead.

◆ type()

static constexpr embvm::DriverType embvm::i2c::master::type ( )

inlinestaticnoexceptinherited

I2C Driver Type ID.

Returns: I2C type ID.

References embvm::I2C.

Member Data Documentation

◆ name_

const std::string_view embvm::DriverBase::name_

protectedinherited

Name of the driver instance.

Referenced by embvm::DriverBase::name(), and embvm::DriverBase::name_cstr().

◆ pullups_

i2c::pullups embvm::i2c::master::pullups_ = i2c::pullups::external

protectedinherited

Tracks the active pull-up configuration.

Referenced by embvm::i2c::master::pullups().

◆ started_

type_safe::boolean embvm::DriverBase::started_ = false

protectedinherited

Tracks the driver state.

True if the driver has been started, false if it has been stopped or not yet started.

Referenced by embvm::DriverBase::start(), embvm::DriverBase::started(), and embvm::DriverBase::stop().

◆ state_

i2c::state embvm::i2c::master::state_ = i2c::state::idle

protectedinherited

Tracks the status of the I2C bus.

Referenced by embvm::i2c::master::state().

◆ type_

const embvm::DriverType_t embvm::DriverBase::type_

protectedinherited

Type ID of the driver instance.

Referenced by embvm::DriverBase::DriverType().

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

src/processors/arm/nordic/drivers/nrf51_i2c_master.hpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

template<unsigned TTWIIndex, typename TSclPin, typename TSdaPin> class nRF51i2cMaster_Blocking< TTWIIndex, TSclPin, TSdaPin >

Member Typedef Documentation

◆ cb_t

◆ sweep_cb_t

◆ sweep_list_t

Constructor & Destructor Documentation

◆ ~nRFi2cMaster_Blocking()

Member Function Documentation

◆ baudrate_()

◆ configure()

◆ configure_()

◆ DriverType()

◆ name()

◆ name_cstr()

◆ nRFi2cMaster_Blocking() [1/2]

◆ nRFi2cMaster_Blocking() [2/2]

◆ operator++()

◆ pullups() [1/2]

◆ pullups() [2/2]

◆ restart()

◆ setPullups_()

◆ start()

◆ start_()

◆ started()

◆ state()

◆ stop()

◆ stop_()

◆ sweep()

◆ transfer_()

◆ type()

Member Data Documentation

◆ name_

◆ pullups_

◆ started_

◆ state_

◆ type_

template<unsigned TTWIIndex, typename TSclPin, typename TSdaPin>
class nRF51i2cMaster_Blocking< TTWIIndex, TSclPin, TSdaPin >