Sygaldry
•All Classes Functions Variables Typedefs Enumerations Modules Pages Concepts
Public Types | Static Public Member Functions | List of all members
sygaldry::sygsp::ICM20948Registers< Serif >::BitSwitch< name, Register, mask, invert > Struct Template Reference
Inheritance diagram for sygaldry::sygsp::ICM20948Registers< Serif >::BitSwitch< name, Register, mask, invert >:
sygaldry::sygsp::ICM20948Registers< Serif >::BitField< name, Register, mask > sygaldry::sygsp::ICM20948Registers< Serif >::Register< name, addr_, bank_, reset_ >

Public Types

using This = BitSwitch< name, Register, mask, invert >
 

Static Public Member Functions

static void enable ()
 
static void disable ()
 
- Static Public Member Functions inherited from sygaldry::sygsp::ICM20948Registers< Serif >::BitField< name, Register, mask >
static constexpr const char * field_name ()
 
static uint8_t read_field ()
 
- Static Public Member Functions inherited from sygaldry::sygsp::ICM20948Registers< Serif >::Register< name, addr_, bank_, reset_ >
static constexpr const char * register_name ()
 
static void select_bank ()
 
static uint8_t read ()
 
static void write (uint8_t value)
 

Additional Inherited Members

- Static Public Attributes inherited from sygaldry::sygsp::ICM20948Registers< Serif >::BitField< name, Register, mask >
static constexpr uint8_t mask
 
- Static Public Attributes inherited from sygaldry::sygsp::ICM20948Registers< Serif >::Register< name, addr_, bank_, reset_ >
static constexpr uint8_t address = addr_
 
static constexpr uint8_t bank = bank_
 
static constexpr uint8_t after_reset = reset_
 

Detailed Description

template<typename Serif>
template<string_literal name, typename Register, uint8_t mask, bool invert = false>
struct sygaldry::sygsp::ICM20948Registers< Serif >::BitSwitch< name, Register, mask, invert >

Base class for single-bit fields where a set bit indicates an enabled (or disabled) state and an unset bit indicates a disabled (or enabled) state.

The default assumption is that a set bit indicates an enabled state.

Template Parameters
RegisterThe struct defining the register (address, bank, etc.) for this bit field.
maskThe mask for the single bit, which is also used to set the bit.
invertFlip the default assumption, so that a set bit indicates a disabled state.
The documentation for this struct was generated from the following file: