SoftChipSelectGuard< AssertFn, DeassertFn > Class Template Reference

RAII soft-CS: runs assert_fn on construction and deassert_fn on destruction (including early return / error paths). More...

#include <SoftChipSelectGuard.h>

Public Member Functions
	SoftChipSelectGuard (AssertFn assert_fn, DeassertFn deassert_fn) noexcept
	~SoftChipSelectGuard () noexcept
	SoftChipSelectGuard (const SoftChipSelectGuard &)=delete
SoftChipSelectGuard &	operator= (const SoftChipSelectGuard &)=delete
	SoftChipSelectGuard (SoftChipSelectGuard &&other) noexcept
SoftChipSelectGuard &	operator= (SoftChipSelectGuard &&other) noexcept
void	Release () noexcept
	Early deassert (idempotent). Destructor becomes a no-op.
bool	OwnsCs () const noexcept

Private Attributes
DeassertFn	deassert_
bool	armed_

Detailed Description

template<typename AssertFn, typename DeassertFn>
class SoftChipSelectGuard< AssertFn, DeassertFn >

RAII soft-CS: runs assert_fn on construction and deassert_fn on destruction (including early return / error paths).

Template Parameters

AssertFn	Callable void()
DeassertFn	Callable void()

Typical STM32 soft-CS device usage (inside a bus lock):

SoftChipSelectGuard cs{[&]{ AssertCS(); }, [&]{ DeassertCS(); }};
// HAL_SPI_TransmitReceive...

Constructor & Destructor Documentation

SoftChipSelectGuard() [1/3]

template<typename AssertFn , typename DeassertFn >

SoftChipSelectGuard< AssertFn, DeassertFn >::SoftChipSelectGuard ( AssertFn  assert_fn, DeassertFn  deassert_fn  )

inlinenoexcept

~SoftChipSelectGuard()

template<typename AssertFn , typename DeassertFn >

SoftChipSelectGuard< AssertFn, DeassertFn >::~SoftChipSelectGuard ( )

inlinenoexcept

SoftChipSelectGuard() [2/3]

template<typename AssertFn , typename DeassertFn >

SoftChipSelectGuard< AssertFn, DeassertFn >::SoftChipSelectGuard ( const SoftChipSelectGuard< AssertFn, DeassertFn > &  )

delete

SoftChipSelectGuard() [3/3]

template<typename AssertFn , typename DeassertFn >

SoftChipSelectGuard< AssertFn, DeassertFn >::SoftChipSelectGuard ( SoftChipSelectGuard< AssertFn, DeassertFn > &&  other )

inlinenoexcept

Member Function Documentation

operator=() [1/2]

template<typename AssertFn , typename DeassertFn >

SoftChipSelectGuard & SoftChipSelectGuard< AssertFn, DeassertFn >::operator= ( const SoftChipSelectGuard< AssertFn, DeassertFn > &  )

delete

operator=() [2/2]

template<typename AssertFn , typename DeassertFn >

SoftChipSelectGuard & SoftChipSelectGuard< AssertFn, DeassertFn >::operator= ( SoftChipSelectGuard< AssertFn, DeassertFn > &&  other )

inlinenoexcept

OwnsCs()

template<typename AssertFn , typename DeassertFn >

bool SoftChipSelectGuard< AssertFn, DeassertFn >::OwnsCs ( ) const

inlinenoexcept

Release()

template<typename AssertFn , typename DeassertFn >

void SoftChipSelectGuard< AssertFn, DeassertFn >::Release ( )

inlinenoexcept

Early deassert (idempotent). Destructor becomes a no-op.

Member Data Documentation

armed_

template<typename AssertFn , typename DeassertFn >

bool SoftChipSelectGuard< AssertFn, DeassertFn >::armed_

private

deassert_

template<typename AssertFn , typename DeassertFn >

DeassertFn SoftChipSelectGuard< AssertFn, DeassertFn >::deassert_

private

---

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

• inc/utils/SoftChipSelectGuard.h