Ramp status and switch event status register (RAMP_STAT) More...

#include <tmc51x0_registers.hpp>

Public Attributes
uint32_t	value

struct {

uint32_t status_stop_l: 1
	Reference switch left status (1=active) More...

uint32_t status_stop_r: 1
	Reference switch right status (1=active) More...

uint32_t status_latch_l: 1
	Latch left ready. More...

uint32_t status_latch_r: 1
	Latch right ready. More...

uint32_t event_stop_l: 1

uint32_t event_stop_r: 1

uint32_t event_stop_sg: 1
	Signals an active StallGuard2 stop event. More...

uint32_t event_pos_reached: 1

uint32_t velocity_reached: 1
	Signals that the target velocity is reached. More...

uint32_t position_reached: 1
	Signals that the target position is reached. More...

uint32_t vzero: 1
	Signals that the actual velocity is 0. More...

uint32_t t_zerowait_active: 1

uint32_t second_move: 1

uint32_t status_sg: 1
	Signals an active stallGuard2 input. More...

uint32_t reserved: 18
	Reserved bits. More...

}	bits

Detailed Description

Ramp status and switch event status register (RAMP_STAT)

Status information about ramp generator and switch events.

Bit assignments per datasheet:

Bit 0: status_stop_l - Reference switch left status (1=active)
Bit 1: status_stop_r - Reference switch right status (1=active)
Bit 2: status_latch_l - Latch left ready (Write '1' to clear)
Bit 3: status_latch_r - Latch right ready (Write '1' to clear)
Bit 4: event_stop_l - Signals an active stop left condition due to stop switch (ORed to interrupt output)
Bit 5: event_stop_r - Signals an active stop right condition due to stop switch (ORed to interrupt output)
Bit 6: event_stop_sg - Signals an active StallGuard2 stop event (Write '1' to clear, ORed to interrupt output)
Bit 7: event_pos_reached - Signals that the target position has been reached (Write '1' to clear, ORed to interrupt output)
Bit 8: velocity_reached - Signals that the target velocity is reached
Bit 9: position_reached - Signals that the target position is reached
Bit 10: vzero - Signals that the actual velocity is 0
Bit 11: t_zerowait_active - Signals that TZEROWAIT is active after a motor stop
Bit 12: second_move - Signals that the automatic ramp required moving back in the opposite direction (Write '1' to clear)
Bit 13: status_sg - Signals an active StallGuard2 input from CoolStep driver or DcStep unit

Member Data Documentation

◆ [struct]

struct { ... } tmc51x0::RAMP_STAT_Register::bits

◆ event_pos_reached

uint32_t tmc51x0::RAMP_STAT_Register::event_pos_reached

Signals that the target position has been reached

◆ event_stop_l

uint32_t tmc51x0::RAMP_STAT_Register::event_stop_l

Signals an active stop left condition due to stop switch

◆ event_stop_r

uint32_t tmc51x0::RAMP_STAT_Register::event_stop_r

Signals an active stop right condition due to stop switch

◆ event_stop_sg

uint32_t tmc51x0::RAMP_STAT_Register::event_stop_sg

Signals an active StallGuard2 stop event.

◆ position_reached

uint32_t tmc51x0::RAMP_STAT_Register::position_reached

Signals that the target position is reached.

◆ reserved

uint32_t tmc51x0::RAMP_STAT_Register::reserved

Reserved bits.

◆ second_move

uint32_t tmc51x0::RAMP_STAT_Register::second_move

Signals that the automatic ramp required moving back in the opposite direction

◆ status_latch_l

uint32_t tmc51x0::RAMP_STAT_Register::status_latch_l

Latch left ready.

◆ status_latch_r

uint32_t tmc51x0::RAMP_STAT_Register::status_latch_r

Latch right ready.

◆ status_sg

uint32_t tmc51x0::RAMP_STAT_Register::status_sg

Signals an active stallGuard2 input.

◆ status_stop_l

uint32_t tmc51x0::RAMP_STAT_Register::status_stop_l

Reference switch left status (1=active)

◆ status_stop_r

uint32_t tmc51x0::RAMP_STAT_Register::status_stop_r

Reference switch right status (1=active)

◆ t_zerowait_active

uint32_t tmc51x0::RAMP_STAT_Register::t_zerowait_active

Signals that TZEROWAIT is active after a motor stop

◆ value

uint32_t tmc51x0::RAMP_STAT_Register::value

◆ velocity_reached

uint32_t tmc51x0::RAMP_STAT_Register::velocity_reached

Signals that the target velocity is reached.

◆ vzero

uint32_t tmc51x0::RAMP_STAT_Register::vzero

Signals that the actual velocity is 0.

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

tmc51x0_registers.hpp

Public Attributes