Skip to content

Commit

Permalink
docs: clk: add documentation to log which clocks have been disabled
Browse files Browse the repository at this point in the history
The existing clk documentation has a section that talks about the
clk_ignore_unused kernel parameter. Add additional documentation that
describes how to log which clocks the kernel disables on bootup. This
will log messages like the following to the console on bootup:

    [    1.268115] clk: Disabling unused clocks
    [    1.272167] clk_disable: gcc_usb_clkref_en
    [    1.276389] clk_disable: gcc_usb30_sec_sleep_clk
    [    1.281131] clk_disable: gcc_usb30_prim_sleep_clk
    ...

Signed-off-by: Brian Masney <bmasney@redhat.com>
Link: https://lore.kernel.org/r/20230411192153.289688-1-bmasney@redhat.com
[jc: turned parameters into a literal block]
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
  • Loading branch information
Brian Masney authored and Jonathan Corbet committed Apr 20, 2023
1 parent c9b951c commit 54d85d6
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions Documentation/driver-api/clk.rst
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,11 @@ clocks properly but rely on them being on from the bootloader, bypassing
the disabling means that the driver will remain functional while the issues
are sorted out.

You can see which clocks have been disabled by booting your kernel with these
parameters::

tp_printk trace_event=clk:clk_disable

To bypass this disabling, include "clk_ignore_unused" in the bootargs to the
kernel.

Expand Down

0 comments on commit 54d85d6

Please sign in to comment.