From a35f715b63c0b740a45b39d0b6a7dcea016682ae Mon Sep 17 00:00:00 2001 From: Marc Bonnici Date: Fri, 1 Jun 2018 15:01:35 +0100 Subject: [PATCH] doc/cpufreq: Add docs for max/min frequency methods. Adds documentation for the previously added methods in commit a1e58cd8b1b293d5a18f204effbe1f37efcbecd4 and clarify existing method documentation. --- doc/modules.rst | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/doc/modules.rst b/doc/modules.rst index b89b488..9d6fe28 100644 --- a/doc/modules.rst +++ b/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_max_frequency(cpu, frequency[, exact=True]) - Get and set min and max frequencies on the specified CPU. "set" functions are - available with all governors other than ``userspace``. + Get the currently set, or set new min and max frequencies for the specified + 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. ``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. .. method:: target.cpufreq.get_frequency(cpu)