Skip to contentSkip to conversation

docs: clk: add documentation to log which clocks have been disabled

PATCH In review Brian Masney 2 participants 2 messages Apr 11, 2023 – Apr 20, 2023

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs: clk: add documentation to log which clocks have been disabled

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
    ...
---
 Documentation/driver-api/clk.rst | 5 +++++
 1 file changed, 5 insertions(+)
Documentation/driver-api/clk.rst +5 -0
index 3cad45d14187..2199c0042e75 100644
@@ -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.
 
Signature · 1 line
2.39.2
maintainer
#1 lore raw
Quoted 11 lines · Brian Masney

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
    ...
Quoted 4 lines
---
 Documentation/driver-api/clk.rst | 5 +++++
 1 file changed, 5 insertions(+)

I've applied this, but...

Documentation/driver-api/clk.rst clocks properly but rely on them being on from the bootloader, bypassing · line 262

Quoted 10 lines
Documentation/driver-api/clk.rst +2 -0
index 3cad45d14187..2199c0042e75 100644
@@ -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:

...I took the liberty of making that "parameters::" so that the options would be formatted as a literal block.

Documentation/driver-api/clk.rst clocks properly but rely on them being on from the bootloader, bypassing · line 267

Quoted 4 lines
Documentation/driver-api/clk.rst +2 -0
+ tp_printk trace_event=clk:clk_disable
+
 To bypass this disabling, include "clk_ignore_unused" in the bootargs to the
 kernel.

Thanks,

jon