zephyrproject-rtos/zephyr

Drop Futile BUILD_ASSERTs in tmc5xxx series

Closed

#109,856 opened on May 26, 2026

View on GitHubContributor guide
 (2 comments) (1 reaction) (1 assignee)C (9,144 forks)batch import
Good first issuearea: Stepper

Repository metrics

Stars
 (15,249 stars)
PR merge metrics
 (Avg merge 4d 21h) (1,000 merged PRs in 30d)

Description

Summary

stallguard_threshold_velocity is actually part of adi,tmc5xxx-stepper-ctrl bindings. https://github.com/zephyrproject-rtos/zephyr/blob/cdb58275997595faa129ca83ed0cfeb37542026b/dts/bindings/stepper/adi/adi%2Ctmc50xx-stepper-ctrl.yaml#L10 https://github.com/zephyrproject-rtos/zephyr/blob/cdb58275997595faa129ca83ed0cfeb37542026b/drivers/stepper/adi_tmc/tmc51xx/tmc51xx_stepper_ctrl.c#L493

However, couple of other drivers in the tmc5xxx series do BUILD_ASSERT on this property. The ASSERT never actually happens since it's guarded by a COND_CODE_1, which would never be tree, hence it's actually futile.

https://github.com/zephyrproject-rtos/zephyr/blob/cdb58275997595faa129ca83ed0cfeb37542026b/drivers/stepper/adi_tmc/tmc51xx/tmc51xx.c#L528-L530

Describe the solution you'd like

Drop the ASSERTs listed below.

  1. https://github.com/zephyrproject-rtos/zephyr/blob/cdb58275997595faa129ca83ed0cfeb37542026b/drivers/stepper/adi_tmc/tmc51xx/tmc51xx.c#L528-L530

  2. https://github.com/zephyrproject-rtos/zephyr/blob/cdb58275997595faa129ca83ed0cfeb37542026b/drivers/stepper/adi_tmc/tmc51xx/tmc51xx_stepper_driver.c#L205-L207

  3. https://github.com/zephyrproject-rtos/zephyr/blob/cdb58275997595faa129ca83ed0cfeb37542026b/drivers/stepper/adi_tmc/tmc50xx/tmc50xx_stepper_driver.c#L170-L172

Alternatives

No response

Additional Context

No response

Contributor guide

Research direction
The issue involves removing three futile BUILD ASSERT macros from files: drivers/stepper/adi tmc/tmc51xx/tmc51xx.c (lines 528-530), drivers/stepper/adi tmc/tmc51xx/tmc51xx stepper driver.c (lines 205-207), and drivers/stepper/adi tmc/tmc50xx/tmc50xx stepper driver.c (lines 170-172). The asserts are guarded by COND CODE 1 on a property that never exists, so they are dead code. The fix is to delete those lines. The issue is assigned but has no open PR, so check assignee status before starting.
Tech stack
c
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C programming
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40