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 IP setting valid values.
Parameters
| Name | Description |
|---|---|
| <setting_path> | IP setting path - a list of hierarchical
dictionary keys. For example, ['port1', 'data_rate'] for MRMAC Port1 Data Rate. |
| [<settings_dict>] | IP settings sub-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 an IP setting with no dependencies
proj = open_project('my_design.pdm')
handler = proj.get_ip_handler('LPDDRMC')
valid = handler.get_setting_valid_values(['standard'])
# valid == ['LPDDR4', 'LPDDR4X', 'LPDDR5', 'LPDDR5X']
# Get valid range for a numeric setting
valid = handler.get_setting_valid_values(['data_rate'])
# valid == {'min': 0.0, 'max': 3733.0}
# Get valid values for a dependent setting by providing dependencies
handler = proj.get_ip_handler('GTM2')
stg = handler.get_sample_settings()
valid = handler.get_setting_valid_values(['data_rate'], stg)
# For nested settings, use a list of keys as the setting path
handler = proj.get_ip_handler('MRMAC')
valid = handler.get_setting_valid_values(['port1', 'data_rate'], stg)