sascha/devlib
1
0
Fork 0
mirror of https://github.com/ARM-software/devlib.git synced 2025-07-19 20:22:40 +01:00
Code Issues Releases Wiki Activity

doc/cpufreq: Add docs for max/min frequency methods.

Browse Source 
Adds documentation for the previously added methods in commit
a1e58cd8b1 and clarify existing method
documentation.
This commit is contained in:
Marc Bonnici
2018-06-01 15:01:35 +01:00
committed by setrofim
parent 55762edf19
commit a35f715b63
1 changed files with 11 additions and 2 deletions

13
doc/modules.rst

@ -106,11 +106,20 @@ policies (governors). The ``devlib`` module exposes the following interface
target.cpufreq.set_min_frequency(cpu, frequency[, exact=True]) target.cpufreq.set_min_frequency(cpu, frequency[, exact=True])
target.cpufreq.set_max_frequency(cpu, frequency[, exact=True]) target.cpufreq.set_max_frequency(cpu, frequency[, exact=True])
Get and set min and max frequencies on the specified CPU. "set" functions are Get the currently set, or set new min and max frequencies for the specified
available with all governors other than ``userspace``. CPU. "set" functions are available with all governors other than
``userspace``.
:param cpu: The cpu; could be a numeric or the corresponding string (e.g. :param cpu: The cpu; could be a numeric or the corresponding string (e.g.
``1`` or ``"cpu1"``). ``1`` or ``"cpu1"``).
.. method:: target.cpufreq.get_min_available_frequency(cpu)
target.cpufreq.get_max_available_frequency(cpu)
Retrieve the min or max DVFS frequency that is supported (as opposed to
currently enforced) for a given CPU. Returns an int or None if could not be
determined.
:param frequency: Frequency to set. :param frequency: Frequency to set.
.. method:: target.cpufreq.get_frequency(cpu) .. method:: target.cpufreq.get_frequency(cpu)