regbit_t Class Reference

Represents a field in a I/O register with address. More...

#include <sim_types.h>

Public Member Functions
constexpr	regbit_t ()
constexpr	regbit_t (reg_addr_t a)
constexpr	regbit_t (reg_addr_t a, uint8_t bit)
constexpr	regbit_t (reg_addr_t a, uint8_t msb_, uint8_t lsb_)
constexpr	regbit_t (reg_addr_t a, const bitspec_t &f)
constexpr regbit_t	bit (uint8_t n) const
constexpr	operator regmask_t () const
constexpr bool	operator== (reg_addr_t a) const
constexpr bool	operator!= (reg_addr_t a) const
constexpr bool	valid () const
	Returns true if at least one bit set.
constexpr uint8_t	shift_and_mask (uint8_t value) const
	Transform the field value to its true representation and position in the 8-bits of the register.
constexpr uint8_t	extract (uint8_t reg) const
	Extract the field value and shift right by the LSB.
constexpr uint8_t	set_from (uint8_t reg) const
constexpr uint8_t	clear_from (uint8_t reg) const
constexpr uint8_t	replace (uint8_t reg, uint8_t value) const
constexpr unsigned int	bitcount () const
constexpr uint8_t	lsb () const
constexpr uint8_t	msb () const
constexpr	operator bitmask_t () const
constexpr uint8_t	operator& (uint8_t v) const

Public Attributes
reg_addr_t	addr

Detailed Description

Represents a field in a I/O register with address.

Constructor & Destructor Documentation

regbit_t() [1/5]

constexpr regbit_t::regbit_t ( )

inlineconstexpr

regbit_t() [2/5]

constexpr regbit_t::regbit_t ( reg_addr_t  a )

inlineexplicitconstexpr

regbit_t() [3/5]

constexpr regbit_t::regbit_t ( reg_addr_t  a, uint8_t  bit  )

inlineconstexpr

regbit_t() [4/5]

constexpr regbit_t::regbit_t ( reg_addr_t  a, uint8_t  msb_, uint8_t  lsb_  )

inlineconstexpr

regbit_t() [5/5]

constexpr regbit_t::regbit_t ( reg_addr_t  a, const bitspec_t &  f  )

inlineconstexpr

Member Function Documentation

bit()

constexpr regbit_t regbit_t::bit ( uint8_t  n ) const

inlineconstexpr

bitcount()

constexpr unsigned int regbit_t::bitcount ( ) const

constexpr

clear_from()

constexpr uint8_t regbit_t::clear_from ( uint8_t  reg ) const

constexpr

extract()

constexpr uint8_t regbit_t::extract ( uint8_t  reg ) const

constexpr

Extract the field value and shift right by the LSB.

lsb()

constexpr uint8_t regbit_t::lsb ( ) const

constexpr

msb()

constexpr uint8_t regbit_t::msb ( ) const

constexpr

operator bitmask_t()

constexpr regbit_t::operator bitmask_t ( ) const

constexpr

operator regmask_t()

constexpr regbit_t::operator regmask_t ( ) const

inlineconstexpr

operator!=()

constexpr bool regbit_t::operator!= ( reg_addr_t  a ) const

inlineconstexpr

operator&()

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

constexpr

operator==()

constexpr bool regbit_t::operator== ( reg_addr_t  a ) const

inlineconstexpr

replace()

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

constexpr

set_from()

constexpr uint8_t regbit_t::set_from ( uint8_t  reg ) const

constexpr

shift_and_mask()

constexpr uint8_t regbit_t::shift_and_mask ( uint8_t  value ) const

constexpr

Transform the field value to its true representation and position in the 8-bits of the register.

valid()

constexpr bool regbit_t::valid ( ) const

constexpr

Returns true if at least one bit set.

Member Data Documentation

addr

reg_addr_t regbit_t::addr

---

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

• sim_types.h