21.9.19 smartpower_init_set_clocks_options

Description

This Tcl command initializes the clock frequency options of all clock domains.

Note: This command is associated with the functionality of Initialize frequencies and probabilities dialog box.

smartpower_init_set_clocks_options [-with_clock_constraints {value}] \
                                   [-with_default_values {value}] \
                                   [-freq {value}] \
                                   [-duty_cycle {value}]

Arguments


Parameter	Type	Description
with_clock_constraints	boolean	This sets the option of initializing the clock frequencies with frequency constraints from SmartTime. The acceptable values for this argument are the following: true - Sets initialize clock frequencies with clock constraints ON. false - Sets initialize clock frequencies with clock constraints OFF.
with_default_values	boolean	This sets the option of initializing the clock frequencies with a user input default value. The acceptable values for this argument are the following: true - Sets initialize clock frequencies with default values ON. false - Sets initialize clock frequencies with default values OFF.
freq	string	Specifies the user input frequency in Hz, KHz or MHz.
duty_cycle	decimal	Specifies the user input duty cycles in percentage(%).


Return Type	Description
None	None

Error Codes


Error Code	Description
None	Parameter 'duty_cycle' has illegal value.
None	Parameter 'duty_cycle' must be less than or equal to 100.000.
None	Parameter 'duty_cycle' must be a positive decimal value.
None	duty_cycle: Invalid argument value: 'value' (expecting decimal value).
None	Parameter 'freq' has illegal value.
None	freq: Parameter format incorrect (expecting a positive decimal value, optionally followed by a unit (possible values are Hz, KHz or MHz)).
None	Parameter 'with_default_values' has illegal value.
None	with_default_values: Invalid argument value: 'value' (expecting TRUE, 1, true, FALSE, 0 or false).
None	Parameter 'with_clock_constraints' has illegal value.
None	with_clock_constraints: Invalid argument value: 'value' (expecting TRUE, 1, true, FALSE, 0 or false).
None	Parameter 'param_name' is not defined. Valid command formatting is 'smartpower_init_set_clocks_options [-with_clock_constraints "TRUE \| FALSE"] [-with_default_values "TRUE \| FALSE"] [-freq "decimal value [ unit { Hz \| KHz \| MHz } ]"] [-duty_cycle "decimal value"]'.

Supported Families


PolarFire®
SmartFusion® 2
RTG4™
IGLOO® 2
PolarFire SoC

Example

The following example initializes all clocks after executing "smartpower_init_do":

smartpower_init_do with -clocks {true}
smartpower_init_set_clocks_options -with_clock_constraints {true} \ 
                                   -with_default_values {true} \
                                   -freq {10 MHz} \
                                   -duty_cycle {20}

v2024.2