bitmask_t Struct Reference

Bit mask structure for bitwise operations on 8-bits registers. More...

#include <sim_types.h>

Public Member Functions
constexpr	bitmask_t (uint8_t m=0)
constexpr uint8_t	replace (uint8_t reg, uint8_t value) const
constexpr uint8_t	set_from (uint8_t reg) const
constexpr uint8_t	clear_from (uint8_t reg) const
constexpr bitmask_t	operator| (const bitmask_t &bm) const
constexpr bitmask_t	operator& (const bitmask_t &bm) const
constexpr bitmask_t	operator^ (const bitmask_t &bm) const
constexpr bitmask_t	operator~ () const
bitmask_t &	operator|= (const bitmask_t &bm)
bitmask_t &	operator&= (const bitmask_t &bm)
bitmask_t &	operator^= (const bitmask_t &bm)
constexpr uint8_t	operator& (uint8_t v) const
constexpr unsigned int	bitcount () const
	Returns the number of bits set in the mask.
constexpr bool	bit (unsigned int i) const
	Returns the state of the bit i.

Public Attributes
uint8_t	mask

Detailed Description

Bit mask structure for bitwise operations on 8-bits registers.

Constructor & Destructor Documentation

bitmask_t()

constexpr bitmask_t::bitmask_t ( uint8_t  m = 0 )

inlineconstexpr

Member Function Documentation

bit()

constexpr bool bitmask_t::bit ( unsigned int  i ) const

inlineconstexpr

Returns the state of the bit i.

bitcount()

constexpr unsigned int bitmask_t::bitcount ( ) const

inlineconstexpr

Returns the number of bits set in the mask.

clear_from()

constexpr uint8_t bitmask_t::clear_from ( uint8_t  reg ) const

inlineconstexpr

Performs a bitwise NEG-AND between the reg value and the bitmask

operator&() [1/2]

constexpr bitmask_t bitmask_t::operator& ( const bitmask_t &  bm ) const

inlineconstexpr

operator&() [2/2]

constexpr uint8_t bitmask_t::operator& ( uint8_t  v ) const

inlineconstexpr

operator&=()

bitmask_t & bitmask_t::operator&= ( const bitmask_t &  bm )

inline

operator^()

constexpr bitmask_t bitmask_t::operator^ ( const bitmask_t &  bm ) const

inlineconstexpr

operator^=()

bitmask_t & bitmask_t::operator^= ( const bitmask_t &  bm )

inline

operator|()

constexpr bitmask_t bitmask_t::operator| ( const bitmask_t &  bm ) const

inlineconstexpr

operator|=()

bitmask_t & bitmask_t::operator|= ( const bitmask_t &  bm )

inline

operator~()

constexpr bitmask_t bitmask_t::operator~ ( ) const

inlineconstexpr

replace()

constexpr uint8_t bitmask_t::replace ( uint8_t  reg, uint8_t  value  ) const

inlineconstexpr

set_from()

constexpr uint8_t bitmask_t::set_from ( uint8_t  reg ) const

inlineconstexpr

Performs a bitwise OR between the reg value and the bitmask

Member Data Documentation

mask

uint8_t bitmask_t::mask

---

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

• sim_types.h