tmc51x0_registers.hpp File Reference

Register definitions and bitfield structures for TMC51x0 stepper motor. More...

#include "tmc51x0_register_defs.hpp"
#include <cstdint>

Include dependency graph for tmc51x0_registers.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
union	tmc51x0::GCONF_Register
	General configuration register (GCONF) More...
union	tmc51x0::GSTAT_Register
	Global status register (GSTAT) More...
union	tmc51x0::NODECONF_Register
	UART node address configuration register (NODECONF) More...
union	tmc51x0::IOIN_Register
	Input pin register (IOIN) - Read-only at address 0x04. More...
union	tmc51x0::OTP_PROG_Register
	OTP programming register (OTP_PROG) More...
union	tmc51x0::OTP_READ_Register
	OTP read register (OTP_READ) More...
union	tmc51x0::SHORT_CONF_Register
	Short detector configuration register (SHORT_CONF) More...
union	tmc51x0::DRV_CONF_Register
	Driver configuration register (DRV_CONF) More...
union	tmc51x0::OFFSET_READ_Register
	Offset calibration result register (OFFSET_READ) More...
union	tmc51x0::IHOLD_IRUN_Register
	Driver current control register (IHOLD_IRUN) More...
union	tmc51x0::SW_MODE_Register
	Switch mode configuration register (SW_MODE) More...
union	tmc51x0::RAMP_STAT_Register
	Ramp status and switch event status register (RAMP_STAT) More...
union	tmc51x0::ENCMODE_Register
	Encoder configuration register (ENCMODE) More...
union	tmc51x0::ENC_STATUS_Register
	Encoder status register (ENC_STATUS) More...
union	tmc51x0::MSLUTSEL_Register
	Microstep lookup table segmentation definition register (MSLUTSEL) More...
union	tmc51x0::MSCURACT_Register
	Actual microstep current register (MSCURACT) More...
union	tmc51x0::CHOPCONF_Register
	Chopper and driver configuration register (CHOPCONF) More...
union	tmc51x0::COOLCONF_Register
	coolStep smart current control and stallGuard2 configuration register (COOLCONF) More...
union	tmc51x0::DCCTRL_Register
	dcStep automatic commutation configuration register (DCCTRL) More...
union	tmc51x0::DRV_STATUS_Register
	stallGuard2 value and driver error flags register (DRV_STATUS) More...
union	tmc51x0::PWMCONF_Register
	stealthChop voltage PWM mode chopper configuration register (PWMCONF) More...
union	tmc51x0::PWM_SCALE_Register
	Results of stealthChop amplitude regulator register (PWM_SCALE) More...
union	tmc51x0::PWM_AUTO_Register
	stealthChop automatically generated values read out register (PWM_AUTO) More...

Namespaces
namespace	tmc51x0
namespace	tmc51x0::Registers
	TMC51x0 register addresses.

Macros
#define	X(addr, name, access, category, desc)   constexpr uint8_t name = addr;

Enumerations
enum class	tmc51x0::RampMode : uint8_t { tmc51x0::POSITIONING = 0x00 , tmc51x0::VELOCITY_POS = 0x01 , tmc51x0::VELOCITY_NEG = 0x02 , tmc51x0::HOLD = 0x03 }
	Ramp mode enumeration values. More...
enum class	tmc51x0::PWMFreewheel : uint8_t { tmc51x0::NORMAL = 0x00 , tmc51x0::ENABLED = 0x01 , tmc51x0::SHORT_LS = 0x02 , tmc51x0::SHORT_HS = 0x03 }
	PWM freewheel mode enumeration values. More...
enum class	tmc51x0::EncoderSensitivity : uint8_t { tmc51x0::NO_EDGE = 0x00 , tmc51x0::RISING_EDGE = 0x01 , tmc51x0::FALLING_EDGE = 0x02 , tmc51x0::BOTH_EDGES }
	Encoder N channel sensitivity enumeration values. More...

Detailed Description

Register definitions and bitfield structures for TMC51x0 stepper motor.

Copyright

Copyright (c) 2024-2025 HardFOC. All rights reserved.

Macro Definition Documentation

X

#define X	(		addr,
			name,
			access,
			category,
			desc )   constexpr uint8_t name = addr;