Description
Get valid values of a single setting, identified by its path - a list of hierarchical dictionary keys.
Syntax
get_setting_valid_values(<setting_path>, [<settings_dict>])
Returns
List or range of a clock manager setting valid values.
Parameters
| Name | Description |
|---|---|
| <setting_path> | Clock manager setting path - a list of hierarchical dictionary keys. For example, ['vco_range']. |
| [<settings_dict>] | Clock manager settings dictionary containing all settings and values that the specified setting depends on. This is not needed or is ignored if the setting has no dependencies. Default: None |
Examples
# Get valid values for a clock manager setting
proj = open_project('my_design.pdm')
clock_mgr = proj.get_clock_mgr_handler()
# Get valid types
valid = clock_mgr.get_setting_valid_values('type')
# valid == ['MMCM', 'DPLL', 'XPLL']
# Get valid VCO range values
valid = clock_mgr.get_setting_valid_values('vco_range')
# valid == ['Low', 'Medium', 'High']
# Get valid values for a dependent setting by providing its dependencies
valid = clock_mgr.get_setting_valid_values('vco_range', {'type': 'DPLL'})