regs

Classes
struct	zth::Register< T, Addr, Fields >
	Helper class to read/write (bitfields in) hardware registers. More...

Macros
#define	ZTH_REG_DEFINE(T, name, addr, fields...)
	Define a hardware reference helper class, with bitfields. More...

Detailed Description

Macro Definition Documentation

ZTH_REG_DEFINE

#define ZTH_REG_DEFINE	(		T,
			name,
			addr,
			fields...
	)

Value:

                struct name##__type {                                       \
                        T ZTH_REG_BITFIELDS(fields);                        \
                } __attribute__((packed));                                  \
                struct name : public zth::Register<T, addr, name##__type> { \
                        typedef zth::Register<T, addr, name##__type> base;  \
                        using typename base::type;                          \
                        name() noexcept                                     \
                                : base()                                    \
                        {}                                                  \
                        constexpr explicit name(type v) noexcept            \
                                : base(v)                                   \
                        {}                                                  \
                };

Define a hardware reference helper class, with bitfields.

Example to create zth::reg_mpu_type register:

// clang-format off
ZTH_REG_DEFINE(uint32_t, reg_mpu_type, 0xE000ED90,
        // 32-bit register definition in unsigned int fields,
        // ordered from MSB to LSB.
        reserved1 : 8,
        region : 8,
        dregion : 8,
        reserved2 : 7,
        separate : 1)
// clang-format on

Afterwards, instantiate the zth::reg_mpu_type class to access the hardware register.

See also

zth::Register

Definition at line 118 of file regs.h.