aboutsummaryrefslogtreecommitdiff
path: root/docs/devel/clocks.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/devel/clocks.rst')
-rw-r--r--docs/devel/clocks.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/devel/clocks.rst b/docs/devel/clocks.rst
index 2d317ff32f..2548d84232 100644
--- a/docs/devel/clocks.rst
+++ b/docs/devel/clocks.rst
@@ -267,6 +267,11 @@ Here is an example:
clock_get(dev->my_clk_input));
}
+If you are only interested in the frequency for displaying it to
+humans (for instance in debugging), use ``clock_display_freq()``,
+which returns a prettified string-representation, e.g. "33.3 MHz".
+The caller must free the string with g_free() after use.
+
Calculating expiry deadlines
----------------------------