diff options
| author | Petri Savolainen <petri.savolainen@nokia.com> | 2023-05-22 16:10:04 +0300 |
|---|---|---|
| committer | Petri Savolainen <petri.savolainen@nokia.com> | 2023-06-08 11:05:46 +0300 |
| commit | d65c1b678114bc7b971d8c73dbc119a7d61d1092 (patch) | |
| tree | 4e5a8c44efa2d8ae05c8f59d3089c425a643b9c7 /include/odp/api/spec/timer.h | |
| parent | a94dd9160c9f8d30d2eec45fe11a65e5d8adf2e8 (diff) | |
api: timer: clarify periodic timer capability output
Clarify that the periodic timer capability call does not
overwrite the base frequency value (with equal fractional
number) when 1 is returned. Validation test already assumes
this.
Signed-off-by: Petri Savolainen <petri.savolainen@nokia.com>
Reviewed-by: Matias Elo <matias.elo@nokia.com>
Reviewed-by: Shijith Thotton <sthotton@marvell.com>
Diffstat (limited to 'include/odp/api/spec/timer.h')
| -rw-r--r-- | include/odp/api/spec/timer.h | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/include/odp/api/spec/timer.h b/include/odp/api/spec/timer.h index 7982e391b..998fe8632 100644 --- a/include/odp/api/spec/timer.h +++ b/include/odp/api/spec/timer.h @@ -75,11 +75,14 @@ int odp_timer_res_capability(odp_timer_clk_src_t clk_src, * frequency multiplier and the minimum timeout resolution. If there is no requirement for timeout * resolution, it is set to zero. * - * A successful call overwrites all 'capa' fields with the resulting values. Return value - * is 1 when timer capability meets or exceeds all requested values. The call returns 0, when - * the requested base frequency is not supported exactly, but capability meets or exceeds all other - * requested values. In this case, the call overwrites 'base_freq_hz' with the closest supported - * frequency. + * When the call returns success, 'capa' fields are overwritten in following ways. On return value + * of 1, timer supports the requested base frequency exactly, and meets or exceeds other requested + * values. The base frequency value is not modified, but other 'capa' fields are updated with + * resulting maximum capabilities. + * + * When the call returns 0, the requested base frequency is not supported exactly, but timer + * capabilities meet or exceed all other requested values. In this case, the call overwrites + * 'base_freq_hz' with the closest supported frequency and updates other 'capa' fields accordingly. * * Failure is returned when the requirements are not supported or the call fails otherwise. * |