PF1550 Driver
API reference
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
pf1550::BusInterface< Derived > Class Template Reference

CRTP template interface for PF1550 bus and strap pins. More...

#include <pf1550_i2c_interface.hpp>

Public Member Functions

bool Write (uint8_t addr, uint8_t reg, const uint8_t *data, size_t len) noexcept
 
bool Read (uint8_t addr, uint8_t reg, uint8_t *data, size_t len) noexcept
 
bool EnsureInitialized () noexcept
 
void GpioSet (CtrlPin pin, GpioSignal signal) noexcept
 
void GpioSetActive (CtrlPin pin) noexcept
 
void GpioSetInactive (CtrlPin pin) noexcept
 
void DelayUs (uint32_t us) noexcept
 Optional delay hook — override in derived bus for profile pacing.
 
 BusInterface (const BusInterface &)=delete
 
BusInterface & operator= (const BusInterface &)=delete
 
 BusInterface (BusInterface &&)=delete
 
BusInterface & operator= (BusInterface &&)=delete
 

Protected Member Functions

 BusInterface ()=default
 
 ~BusInterface ()=default
 

Detailed Description

template<typename Derived>
class pf1550::BusInterface< Derived >

CRTP template interface for PF1550 bus and strap pins.

Template Parameters
DerivedPlatform bus implementation type.

Constructor & Destructor Documentation

◆ BusInterface() [1/3]

template<typename Derived >
pf1550::BusInterface< Derived >::BusInterface ( const BusInterface< Derived > &  )
delete

◆ BusInterface() [2/3]

template<typename Derived >
pf1550::BusInterface< Derived >::BusInterface ( BusInterface< Derived > &&  )
delete

◆ BusInterface() [3/3]

template<typename Derived >
pf1550::BusInterface< Derived >::BusInterface ( )
protecteddefault

◆ ~BusInterface()

template<typename Derived >
pf1550::BusInterface< Derived >::~BusInterface ( )
protecteddefault

Member Function Documentation

◆ DelayUs()

template<typename Derived >
void pf1550::BusInterface< Derived >::DelayUs ( uint32_t  us)
inlinenoexcept

Optional delay hook — override in derived bus for profile pacing.

◆ EnsureInitialized()

template<typename Derived >
bool pf1550::BusInterface< Derived >::EnsureInitialized ( )
inlinenoexcept

◆ GpioSet()

template<typename Derived >
void pf1550::BusInterface< Derived >::GpioSet ( CtrlPin  pin,
GpioSignal  signal 
)
inlinenoexcept

◆ GpioSetActive()

template<typename Derived >
void pf1550::BusInterface< Derived >::GpioSetActive ( CtrlPin  pin)
inlinenoexcept

◆ GpioSetInactive()

template<typename Derived >
void pf1550::BusInterface< Derived >::GpioSetInactive ( CtrlPin  pin)
inlinenoexcept

◆ operator=() [1/2]

template<typename Derived >
BusInterface & pf1550::BusInterface< Derived >::operator= ( BusInterface< Derived > &&  )
delete

◆ operator=() [2/2]

template<typename Derived >
BusInterface & pf1550::BusInterface< Derived >::operator= ( const BusInterface< Derived > &  )
delete

◆ Read()

template<typename Derived >
bool pf1550::BusInterface< Derived >::Read ( uint8_t  addr,
uint8_t  reg,
uint8_t *  data,
size_t  len 
)
inlinenoexcept

◆ Write()

template<typename Derived >
bool pf1550::BusInterface< Derived >::Write ( uint8_t  addr,
uint8_t  reg,
const uint8_t *  data,
size_t  len 
)
inlinenoexcept

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