adi,tmc522x (on spi bus)

Description

Trinamic TMC522x stepper motor controller (SPI variant - TMC5221)

Properties

Properties not inherited from the base binding file.

Name

Type

Details

spi-max-frequency

int

Maximum clock frequency of device's SPI interface in Hz

This property is required.

duplex

int

Duplex mode, full or half. By default it's always full duplex thus 0
as this is, by far, the most common mode.
Use the macros not the actual enum value, here is the concordance
list (see dt-bindings/spi/spi.h)
  0    SPI_FULL_DUPLEX
  2048 SPI_HALF_DUPLEX

Default value: 0

Legal values: 0, 2048

frame-format

int

Motorola or TI frame format. By default it's always Motorola's,
thus 0 as this is, by far, the most common format.
Use the macros not the actual enum value, here is the concordance
list (see dt-bindings/spi/spi.h)
  0     SPI_FRAME_FORMAT_MOTOROLA
  32768 SPI_FRAME_FORMAT_TI

Default value: 0

Legal values: 0, 32768

spi-cpol

boolean

SPI clock polarity which indicates the clock idle state.
If it is used, the clock idle state is logic high; otherwise, low.

spi-cpha

boolean

SPI clock phase that indicates on which edge data is sampled.
If it is used, data is sampled on the second edge; otherwise, on the first edge.

spi-lsb-first

boolean

The device requires least significant bit first data mode.

spi-hold-cs

boolean

In some cases, it is necessary for the controller to manage SPI chip select
under software control, so that multiple spi transactions can be performed
without releasing it. A typical use case is variable length SPI packets
where the first spi transaction reads the length and the second spi transaction
reads length bytes.

spi-cs-high

boolean

The device requires the chip select to be active high.

spi-interframe-delay-ns

int

Delay in nanoseconds between SPI words.
Default of 0 is special value which will assume to mean half of the SCK period.

Default value: 0

spi-cs-setup-delay-ns

int

Delay in nanoseconds to be introduced by the controller after CS is asserted.
Also known as enable lead time.

spi-cs-hold-delay-ns

int

Delay in nanoseconds to be introduced by the controller before the CS is de-asserted.
 Also known as enable lag time.

supply-gpios

phandle-array

GPIO specifier that controls power to the device.

This property should be provided when the device has a dedicated
switch that controls power to the device.  The supply state is
entirely the responsibility of the device driver.

Contrast with vin-supply.

vin-supply

phandle

Reference to the regulator that controls power to the device.
The referenced devicetree node must have a regulator compatible.

This property should be provided when device power is supplied
by a shared regulator.  The supply state is dependent on the
request status of all devices fed by the regulator.

Contrast with supply-gpios.  If both properties are provided
then the regulator must be requested before the supply GPIOS is
set to an active state, and the supply GPIOS must be set to an
inactive state before releasing the regulator.

clock-frequency

int

The frequency of the clock signal provided to the TMC522x.
This is used for velocity and acceleration calculations.
Default is 16 MHz internal oscillator.

Default value: 16000000

drven-gpios

phandle-array

Driver enable pin (active high). Enables the power stage when high.
Required for motor operation unless the pin is tied high in hardware,
in which case this property may be omitted.

sleepn-gpios

phandle-array

Sleep/wake pin (active high). REQUIRED for chip operation.
Must be set high for normal operation. If not specified in devicetree,
the SLEEPN pin MUST be tied to VDD in hardware.
Per datasheet: Set SLEEPN=1 before accessing registers, wait 10ms.

diag0-gpios

phandle-array

GPIO connection for DIAG0 interrupt pin (StallGuard event).
This pin is configured as active-high push-pull output by the chip.

diag1-gpios

phandle-array

GPIO connection for DIAG1 interrupt pin (Position reached event).
This pin is configured as active-high push-pull output by the chip.

interrupt-gpios

phandle-array

GPIO connections for DIAG0 and DIAG1 interrupt pins.
- DIAG0: StallGuard event (motor stall detection)
- DIAG1: Position reached event (target position achieved)

chopper-mode

string

High-level chopper mode selection (EN_PWM_MODE in GCONF register).
- "spreadcycle": Current chopping mode (default)
- "stealthchop": Voltage PWM mode (silent operation)

Default value: spreadcycle

Legal values: spreadcycle, stealthchop

chm-mode

string

CHM bit configuration in CHOPCONF register (only applies to spreadcycle).
- "spreadcycle": SpreadCycle adaptive hysteresis mode (CHM=0, recommended)
- "classic": Classic constant off-time mode (CHM=1)

Default value: spreadcycle

Legal values: spreadcycle, classic

poscmp-enable

boolean

Enable position compare feature
0: Outputs INT and PP are tristated.
1: Position compare pulse (PP) and interrupt output (INT) are available

Attention – do not leave the outputs floating in tristate condition, provide an external
pull-up or set poscmp-enable=1

test-mode

boolean

Enable test mode
0: Normal operation
1: Enable analog test output on pin REFR2
TEST_SEL selects the function of REFR2: 0…4: T120, DAC1, VDDH1, DAC2, VDDH2

Attention: Not for user, set to 0 for normal operation!

lock-gconf

boolean

1: GCONF is locked against further write access.