Zephyr API Documentation 4.0.0
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
stepper_trinamic.h File Reference

Public API for Trinamic Stepper Controller Specific Functions. More...

#include <stdint.h>
#include <zephyr/drivers/stepper.h>

Go to the source code of this file.

Data Structures

struct  tmc_ramp_generator_data
 Trinamic Stepper Ramp Generator data. More...
 

Macros

#define TMC_RAMP_VSTART_MAX   GENMASK(17, 0)
 Trinamic stepper controller ramp generator data limits.
 
#define TMC_RAMP_VSTART_MIN   0
 
#define TMC_RAMP_V1_MAX   GENMASK(19, 0)
 
#define TMC_RAMP_V1_MIN   0
 
#define TMC_RAMP_VMAX_MAX   (GENMASK(22, 0) - 512)
 
#define TMC_RAMP_VMAX_MIN   0
 
#define TMC_RAMP_A1_MAX   GENMASK(15, 0)
 
#define TMC_RAMP_A1_MIN   0
 
#define TMC_RAMP_AMAX_MAX   GENMASK(15, 0)
 
#define TMC_RAMP_AMAX_MIN   0
 
#define TMC_RAMP_D1_MAX   GENMASK(15, 0)
 
#define TMC_RAMP_D1_MIN   1
 
#define TMC_RAMP_DMAX_MAX   GENMASK(15, 0)
 
#define TMC_RAMP_DMAX_MIN   0
 
#define TMC_RAMP_VSTOP_MAX   GENMASK(17, 0)
 
#define TMC_RAMP_VSTOP_MIN   1
 
#define TMC_RAMP_TZEROWAIT_MAX   (GENMASK(15, 0) - 512)
 
#define TMC_RAMP_TZEROWAIT_MIN   0
 
#define TMC_RAMP_VCOOLTHRS_MAX   GENMASK(22, 0)
 
#define TMC_RAMP_VCOOLTHRS_MIN   0
 
#define TMC_RAMP_VHIGH_MAX   GENMASK(22, 0)
 
#define TMC_RAMP_VHIGH_MIN   0
 
#define TMC_RAMP_IHOLD_IRUN_MAX   GENMASK(4, 0)
 
#define TMC_RAMP_IHOLD_IRUN_MIN   0
 
#define TMC_RAMP_IHOLDDELAY_MAX   GENMASK(3, 0)
 
#define TMC_RAMP_IHOLDDELAY_MIN   0
 
#define TMC_RAMP_VACTUAL_SHIFT   22
 
#define CHECK_RAMP_DT_DATA(node)
 Check if Ramp DT data is within limits.
 
#define TMC_RAMP_DT_SPEC_GET(node)
 Get Trinamic Stepper Ramp Generator data from DT.
 

Functions

int tmc5041_stepper_set_ramp (const struct device *dev, const struct tmc_ramp_generator_data *ramp_data)
 Configure Trinamic Stepper Ramp Generator.
 

Detailed Description

Public API for Trinamic Stepper Controller Specific Functions.