xref: /openbmc/linux/scripts/gdb/linux/clk.py (revision 1d7adbc7) 
1# SPDX-License-Identifier: GPL-2.0
2#
3# Copyright (c) NXP 2019
4
5import gdb
6import sys
7
8from linux import utils, lists, constants
9
10clk_core_type = utils.CachedType("struct clk_core")
11
12
13def clk_core_for_each_child(hlist_head):
14    return lists.hlist_for_each_entry(hlist_head,
15            clk_core_type.get_type().pointer(), "child_node")
16
17
18class LxClkSummary(gdb.Command):
19    """Print clk tree summary
20
21Output is a subset of /sys/kernel/debug/clk/clk_summary
22
23No calls are made during printing, instead a (c) if printed after values which
24are cached and potentially out of date"""
25
26    def __init__(self):
27        super(LxClkSummary, self).__init__("lx-clk-summary", gdb.COMMAND_DATA)
28
29    def show_subtree(self, clk, level):
30        gdb.write("%*s%-*s %7d %8d %8d %11lu%s\n" % (
31                level * 3 + 1, "",
32                30 - level * 3,
33                clk['name'].string(),
34                clk['enable_count'],
35                clk['prepare_count'],
36                clk['protect_count'],
37                clk['rate'],
38                '(c)' if clk['flags'] & constants.LX_CLK_GET_RATE_NOCACHE else '   '))
39
40        for child in clk_core_for_each_child(clk['children']):
41            self.show_subtree(child, level + 1)
42
43    def invoke(self, arg, from_tty):
44        if utils.gdb_eval_or_none("clk_root_list") is None:
45            raise gdb.GdbError("No clocks registered")
46        gdb.write("                                 enable  prepare  protect               \n")
47        gdb.write("   clock                          count    count    count        rate   \n")
48        gdb.write("------------------------------------------------------------------------\n")
49        for clk in clk_core_for_each_child(gdb.parse_and_eval("clk_root_list")):
50            self.show_subtree(clk, 0)
51        for clk in clk_core_for_each_child(gdb.parse_and_eval("clk_orphan_list")):
52            self.show_subtree(clk, 0)
53
54
55LxClkSummary()
56
57
58class LxClkCoreLookup(gdb.Function):
59    """Find struct clk_core by name"""
60
61    def __init__(self):
62        super(LxClkCoreLookup, self).__init__("lx_clk_core_lookup")
63
64    def lookup_hlist(self, hlist_head, name):
65        for child in clk_core_for_each_child(hlist_head):
66            if child['name'].string() == name:
67                return child
68            result = self.lookup_hlist(child['children'], name)
69            if result:
70                return result
71
72    def invoke(self, name):
73        name = name.string()
74        return (self.lookup_hlist(gdb.parse_and_eval("clk_root_list"), name) or
75                self.lookup_hlist(gdb.parse_and_eval("clk_orphan_list"), name))
76
77
78LxClkCoreLookup()
79