Zephyr API Documentation 4.0.0-rc2
A Scalable Open Source RTOS
|
Trinamic Stepper Controller Interface . More...
Data Structures | |
struct | tmc_ramp_generator_data |
Trinamic Stepper Ramp Generator data. More... | |
Functions | |
int | tmc5041_stepper_set_ramp (const struct device *dev, const struct tmc_ramp_generator_data *ramp_data) |
Configure Trinamic Stepper Ramp Generator. | |
Trinamic Stepper Controller Interface .
#define CHECK_RAMP_DT_DATA | ( | node | ) |
#include <zephyr/drivers/stepper/stepper_trinamic.h>
Check if Ramp DT data is within limits.
#define TMC_RAMP_A1_MAX GENMASK(15, 0) |
#include <zephyr/drivers/stepper/stepper_trinamic.h>
#define TMC_RAMP_A1_MIN 0 |
#include <zephyr/drivers/stepper/stepper_trinamic.h>
#define TMC_RAMP_AMAX_MAX GENMASK(15, 0) |
#include <zephyr/drivers/stepper/stepper_trinamic.h>
#define TMC_RAMP_AMAX_MIN 0 |
#include <zephyr/drivers/stepper/stepper_trinamic.h>
#define TMC_RAMP_D1_MAX GENMASK(15, 0) |
#include <zephyr/drivers/stepper/stepper_trinamic.h>
#define TMC_RAMP_D1_MIN 1 |
#include <zephyr/drivers/stepper/stepper_trinamic.h>
#define TMC_RAMP_DMAX_MAX GENMASK(15, 0) |
#include <zephyr/drivers/stepper/stepper_trinamic.h>
#define TMC_RAMP_DMAX_MIN 0 |
#include <zephyr/drivers/stepper/stepper_trinamic.h>
#define TMC_RAMP_DT_SPEC_GET | ( | node | ) |
#include <zephyr/drivers/stepper/stepper_trinamic.h>
Get Trinamic Stepper Ramp Generator data from DT.
node | DT node identifier |
#define TMC_RAMP_IHOLD_IRUN_MAX GENMASK(4, 0) |
#include <zephyr/drivers/stepper/stepper_trinamic.h>
#define TMC_RAMP_IHOLD_IRUN_MIN 0 |
#include <zephyr/drivers/stepper/stepper_trinamic.h>
#define TMC_RAMP_IHOLDDELAY_MAX GENMASK(3, 0) |
#include <zephyr/drivers/stepper/stepper_trinamic.h>
#define TMC_RAMP_IHOLDDELAY_MIN 0 |
#include <zephyr/drivers/stepper/stepper_trinamic.h>
#define TMC_RAMP_TZEROWAIT_MAX (GENMASK(15, 0) - 512) |
#include <zephyr/drivers/stepper/stepper_trinamic.h>
#define TMC_RAMP_TZEROWAIT_MIN 0 |
#include <zephyr/drivers/stepper/stepper_trinamic.h>
#define TMC_RAMP_V1_MAX GENMASK(19, 0) |
#include <zephyr/drivers/stepper/stepper_trinamic.h>
#define TMC_RAMP_V1_MIN 0 |
#include <zephyr/drivers/stepper/stepper_trinamic.h>
#define TMC_RAMP_VACTUAL_SHIFT 22 |
#include <zephyr/drivers/stepper/stepper_trinamic.h>
#define TMC_RAMP_VCOOLTHRS_MAX GENMASK(22, 0) |
#include <zephyr/drivers/stepper/stepper_trinamic.h>
#define TMC_RAMP_VCOOLTHRS_MIN 0 |
#include <zephyr/drivers/stepper/stepper_trinamic.h>
#define TMC_RAMP_VHIGH_MAX GENMASK(22, 0) |
#include <zephyr/drivers/stepper/stepper_trinamic.h>
#define TMC_RAMP_VHIGH_MIN 0 |
#include <zephyr/drivers/stepper/stepper_trinamic.h>
#define TMC_RAMP_VMAX_MAX (GENMASK(22, 0) - 512) |
#include <zephyr/drivers/stepper/stepper_trinamic.h>
#define TMC_RAMP_VMAX_MIN 0 |
#include <zephyr/drivers/stepper/stepper_trinamic.h>
#define TMC_RAMP_VSTART_MAX GENMASK(17, 0) |
#include <zephyr/drivers/stepper/stepper_trinamic.h>
Trinamic stepper controller ramp generator data limits.
#define TMC_RAMP_VSTART_MIN 0 |
#include <zephyr/drivers/stepper/stepper_trinamic.h>
#define TMC_RAMP_VSTOP_MAX GENMASK(17, 0) |
#include <zephyr/drivers/stepper/stepper_trinamic.h>
#define TMC_RAMP_VSTOP_MIN 1 |
#include <zephyr/drivers/stepper/stepper_trinamic.h>
int tmc5041_stepper_set_ramp | ( | const struct device * | dev, |
const struct tmc_ramp_generator_data * | ramp_data ) |
#include <zephyr/drivers/stepper/stepper_trinamic.h>
Configure Trinamic Stepper Ramp Generator.
dev | Pointer to the stepper motor controller instance |
ramp_data | Pointer to a struct containing the required ramp parameters |
-EIO | General input / output error |
-ENOSYS | If not implemented by device driver |
0 | Success |