tmc51x0::ExternalClockConfig Struct Reference

External clock configuration structure. More...

#include <tmc51x0_types.hpp>

Public Member Functions
	ExternalClockConfig ()=default
	Default constructor.

Public Attributes
uint32_t	frequency_hz {0}
	External clock frequency in Hz.

Detailed Description

External clock configuration structure.

Configuration for external clock source on CLK pin. If not configured (frequency = 0), the driver uses the internal oscillator (12 MHz, CLK pin tied to GND).

Note

The actual clock frequency used for timing calculations (f_clk) is determined internally:

• If external_clk_config.frequency_hz > 0: f_clk = external_clk_config.frequency_hz
• If external_clk_config.frequency_hz = 0: f_clk = 12 MHz (internal clock)

Constructor & Destructor Documentation

ExternalClockConfig()

tmc51x0::ExternalClockConfig::ExternalClockConfig ( )

default

Default constructor.

Initializes with safe defaults:

• frequency_hz: 0 (use internal 12 MHz oscillator)

Member Data Documentation

frequency_hz

uint32_t tmc51x0::ExternalClockConfig::frequency_hz {0}

External clock frequency in Hz.

Frequency of the external clock signal provided on CLK pin.

Range: 0 (use internal clock) or 8000000-16000000 Hz (8-16 MHz) Default: 0 (use internal 12 MHz oscillator)

Clock Mode Selection:

• 0 (default): Use internal oscillator (CLK pin tied to GND, ~12 MHz)
• **> 0**: Use external clock at specified frequency (CLK pin receives clock signal)

Typical Values:

• 0: Internal clock (default, no external clock needed)
• 12000000: External 12 MHz clock (same as internal)
• 24000000: External 24 MHz clock (higher performance, requires external oscillator)

Note

If set to 0, the driver uses internal oscillator and f_clk = 12 MHz

If set to > 0, the driver attempts to configure external clock and f_clk = frequency_hz

The actual f_clk value is calculated internally and used for all timing calculations

This value is passed to SetClkFreq() during Initialize() External clock frequency in Hz (0 = use internal clock, default: 0)

---

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

• tmc51x0_types.hpp