AM64x MCU+ SDK  12.01.00

Detailed Description

Set the spread spectrum clocking for a clock.

Set the SSC for a clock with desired modulation frequency, spread type and modulation depth, all within their allowable range. SSC can only be enabled on clocks that have SSC support in the hardware. This message will fail if SSC is not supported by the hardware.

Parameters
hdrTISCI header
deviceThe device ID that the clock is connected to.
clkEach device has its own set of clock inputs. This indexes which clock input to modify.
modfreq_hzThe desired modulation frequency in Hz. The modulation period is the time required to cycle the clock nominal frequency from an initial value through all the different values along the modulation profile and back to the initial value. The modulation frequency is the inverse of the period. The minimum allowable frequency is 32 kHz and maximum is fREFCLK / 200. For example, if the fREFCLK is 25 MHz, the maximum allowable modulation frequency would be 125 kHz.
mod_depthThe target modulation depth in "permyriad". The modulation depth refers to the maximum variation in frequency as a percentage of the clock center frequency. The minimum modulation depth is 0.1% and the maximum is 3.1%. Modulation depth can be adjusted in 0.1% increments.
spread_typeThe target spread type. Both center and down spread are supported.
enableEnable or disable SSC.

Data Fields

struct tisci_header hdr
 
uint32_t device
 
uint32_t clk
 
uint32_t modfreq_hz
 
uint32_t mod_depth
 
uint8_t spread_type
 
uint8_t enable
 

Field Documentation

◆ hdr

struct tisci_header tisci_msg_set_clock_ssc_req::hdr

◆ device

uint32_t tisci_msg_set_clock_ssc_req::device

◆ clk

uint32_t tisci_msg_set_clock_ssc_req::clk

◆ modfreq_hz

uint32_t tisci_msg_set_clock_ssc_req::modfreq_hz

◆ mod_depth

uint32_t tisci_msg_set_clock_ssc_req::mod_depth

◆ spread_type

uint8_t tisci_msg_set_clock_ssc_req::spread_type

◆ enable

uint8_t tisci_msg_set_clock_ssc_req::enable