Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

clk: Replace explicit clk assignment with __clk_hw_set_clk

The change in the clk API to return a per-user clock instance, moved
the clock state to struct clk_core so now the struct clk_hw .core field
is used instead of .clk for most operations.

So for hardware clocks that needs to share the same clock state, both
the .core and .clk pointers have to be assigned but currently only the
.clk is set. This leads to NULL pointer dereference when the operations
try to access the hw clock .core. For example, the composite clock rate
and mux components didn't have a .core set which leads to this error:

Unable to handle kernel NULL pointer dereference at virtual address 00000034
pgd = c0004000
[00000034] *pgd=00000000
Internal error: Oops: 5 [#1] PREEMPT SMP ARM
Modules linked in:
CPU: 0 PID: 1 Comm: swapper/0 Not tainted 3.19.0-next-20150211-00002-g1fb7f0e1150d #423
Hardware name: SAMSUNG EXYNOS (Flattened Device Tree)
task: ee480000 ti: ee488000 task.ti: ee488000
PC is at clk_mux_determine_rate_flags+0x14/0x19c
LR is at __clk_mux_determine_rate+0x24/0x2c
pc : [<c03a355c>] lr : [<c03a3734>] psr: a0000113
sp : ee489ce8 ip : ee489d84 fp : ee489d84
r10: 0000005c r9 : 00000001 r8 : 016e3600
r7 : 00000000 r6 : 00000000 r5 : ee442200 r4 : ee440c98
r3 : ffffffff r2 : 00000000 r1 : 016e3600 r0 : ee440c98
Flags: NzCv IRQs on FIQs on Mode SVC_32 ISA ARM Segment kernel
Control: 10c5387d Table: 4000406a DAC: 00000015
Process swapper/0 (pid: 1, stack limit = 0xee488210)
Stack: (0xee489ce8 to 0xee48a000)
9ce0: 00000000 ffffffff 60000113 ee440c98 ee442200 00000000
9d00: 016e3600 ffffffff 00000001 0000005c ee489d84 c03a3734 ee489d80 ee489d84
9d20: 00000000 c048b130 00000400 c03a5798 ee489d80 ee489d84 c0607f60 ffffffea
9d40: 00000001 00000001 ee489d5c c003f844 c06e3340 ee402680 ee440d0c ed935000
9d60: 016e3600 00000003 00000001 0000005c eded3700 c03a11a0 ee489d80 ee489d84
9d80: 016e3600 ee402680 c05b413a eddc9900 016e3600 c03a1228 00000000 ffffffff
9da0: ffffffff eddc9900 016e3600 c03a1c1c ffffffff 016e3600 ed8c6710 c03d6ce4
9dc0: eded3400 00000000 00000000 c03c797c 00000001 0000005c eded3700 eded3700
9de0: 000005e0 00000001 0000005c c03db8ac c06e7e54 c03c8f08 00000000 c06e7e64
9e00: c06b6e74 c06e7f64 000005e0 c06e7df8 c06e5100 00000000 c06e7e6c c06e7f54
9e20: 00000000 00000000 eebd9550 00000000 c06e7da0 c06e7e54 ee7b5010 c06e7da0
9e40: eddc9690 c06e7db4 c06b6e74 00000097 00000000 c03d4398 00000000 ee7b5010
9e60: eebd9550 c06e7da0 00000000 c03db824 ee7b5010 fffffffe c06e7db4 c0299c7c
9e80: ee7b5010 c072a05c 00000000 c0298858 ee7b5010 c06e7db4 ee7b5044 00000000
9ea0: eddc9580 c0298a04 c06e7db4 00000000 c0298978 c02971d4 ee405c78 ee732b40
9ec0: c06e7db4 eded3800 c06d6738 c0298044 c0608300 c06e7db4 00000000 c06e7db4
9ee0: 00000000 c06beb58 c06beb58 c0299024 00000000 c068dd00 00000000 c0008944
9f00: 00000038 c049013c ee462200 c0711920 ee480000 60000113 c06c2cb0 00000000
9f20: 00000000 c06c2cb0 60000113 00000000 ef7fcafc 00000000 c0640194 c00389ec
9f40: c05ec3a8 c063f824 00000006 00000006 c06c2c50 c0696444 00000006 c0696424
9f60: c06ee1c0 c066b588 c06b6e74 00000097 00000000 c066bd44 00000006 00000006
9f80: c066b588 c003d684 00000000 c0481938 00000000 00000000 00000000 00000000
9fa0: 00000000 c0481940 00000000 c000e680 00000000 00000000 00000000 00000000
9fc0: 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000
9fe0: 00000000 00000000 00000000 00000000 00000013 00000000 00000000 00000000
[<c03a355c>] (clk_mux_determine_rate_flags) from [<c03a3734>] (__clk_mux_determine_rate+0x24/0x2c)
[<c03a3734>] (__clk_mux_determine_rate) from [<c03a5798>] (clk_composite_determine_rate+0xbc/0x238)
[<c03a5798>] (clk_composite_determine_rate) from [<c03a11a0>] (clk_core_round_rate_nolock+0x5c/0x9c)
[<c03a11a0>] (clk_core_round_rate_nolock) from [<c03a1228>] (__clk_round_rate+0x38/0x40)
[<c03a1228>] (__clk_round_rate) from [<c03a1c1c>] (clk_round_rate+0x20/0x38)
[<c03a1c1c>] (clk_round_rate) from [<c03d6ce4>] (max98090_dai_set_sysclk+0x34/0x118)
[<c03d6ce4>] (max98090_dai_set_sysclk) from [<c03c797c>] (snd_soc_dai_set_sysclk+0x38/0x80)
[<c03c797c>] (snd_soc_dai_set_sysclk) from [<c03db8ac>] (snow_late_probe+0x24/0x48)
[<c03db8ac>] (snow_late_probe) from [<c03c8f08>] (snd_soc_register_card+0xf04/0x1070)
[<c03c8f08>] (snd_soc_register_card) from [<c03d4398>] (devm_snd_soc_register_card+0x30/0x64)
[<c03d4398>] (devm_snd_soc_register_card) from [<c03db824>] (snow_probe+0x68/0xcc)
[<c03db824>] (snow_probe) from [<c0299c7c>] (platform_drv_probe+0x48/0x98)
[<c0299c7c>] (platform_drv_probe) from [<c0298858>] (driver_probe_device+0x114/0x234)
[<c0298858>] (driver_probe_device) from [<c0298a04>] (__driver_attach+0x8c/0x90)
[<c0298a04>] (__driver_attach) from [<c02971d4>] (bus_for_each_dev+0x54/0x88)
[<c02971d4>] (bus_for_each_dev) from [<c0298044>] (bus_add_driver+0xd8/0x1cc)
[<c0298044>] (bus_add_driver) from [<c0299024>] (driver_register+0x78/0xf4)
[<c0299024>] (driver_register) from [<c0008944>] (do_one_initcall+0x80/0x1d0)
[<c0008944>] (do_one_initcall) from [<c066bd44>] (kernel_init_freeable+0x10c/0x1d8)
[<c066bd44>] (kernel_init_freeable) from [<c0481940>] (kernel_init+0x8/0xe4)
[<c0481940>] (kernel_init) from [<c000e680>] (ret_from_fork+0x14/0x34)
Code: e24dd00c e5907000 e1a08001 e88d000c (e5970034)

The changes were made using the following cocinelle semantic patch:

@i@
@@

@depends on i@
identifier dst;
@@

- dst->clk = hw->clk;
+ __clk_hw_set_clk(dst, hw);

@depends on i@
identifier dst;
@@

- dst->hw.clk = hw->clk;
+ __clk_hw_set_clk(&dst->hw, hw);

Fixes: 035a61c314eb3 ("clk: Make clk API return per-user struct clk instances")
Signed-off-by: Javier Martinez Canillas <javier.martinez@collabora.co.uk>
Reviewed-by: Stephen Boyd <sboyd@codeaurora.org>
Signed-off-by: Michael Turquette <mturquette@linaro.org>

authored by

Javier Martinez Canillas and committed by
Michael Turquette
4e907ef6 2e65d8bf

+35 -35
+10 -10
drivers/clk/clk-composite.c
··· 27 27 const struct clk_ops *mux_ops = composite->mux_ops; 28 28 struct clk_hw *mux_hw = composite->mux_hw; 29 29 30 - mux_hw->clk = hw->clk; 30 + __clk_hw_set_clk(mux_hw, hw); 31 31 32 32 return mux_ops->get_parent(mux_hw); 33 33 } ··· 38 38 const struct clk_ops *mux_ops = composite->mux_ops; 39 39 struct clk_hw *mux_hw = composite->mux_hw; 40 40 41 - mux_hw->clk = hw->clk; 41 + __clk_hw_set_clk(mux_hw, hw); 42 42 43 43 return mux_ops->set_parent(mux_hw, index); 44 44 } ··· 50 50 const struct clk_ops *rate_ops = composite->rate_ops; 51 51 struct clk_hw *rate_hw = composite->rate_hw; 52 52 53 - rate_hw->clk = hw->clk; 53 + __clk_hw_set_clk(rate_hw, hw); 54 54 55 55 return rate_ops->recalc_rate(rate_hw, parent_rate); 56 56 } ··· 74 74 int i; 75 75 76 76 if (rate_hw && rate_ops && rate_ops->determine_rate) { 77 - rate_hw->clk = hw->clk; 77 + __clk_hw_set_clk(rate_hw, hw); 78 78 return rate_ops->determine_rate(rate_hw, rate, min_rate, 79 79 max_rate, 80 80 best_parent_rate, ··· 120 120 121 121 return best_rate; 122 122 } else if (mux_hw && mux_ops && mux_ops->determine_rate) { 123 - mux_hw->clk = hw->clk; 123 + __clk_hw_set_clk(mux_hw, hw); 124 124 return mux_ops->determine_rate(mux_hw, rate, min_rate, 125 125 max_rate, best_parent_rate, 126 126 best_parent_p); ··· 137 137 const struct clk_ops *rate_ops = composite->rate_ops; 138 138 struct clk_hw *rate_hw = composite->rate_hw; 139 139 140 - rate_hw->clk = hw->clk; 140 + __clk_hw_set_clk(rate_hw, hw); 141 141 142 142 return rate_ops->round_rate(rate_hw, rate, prate); 143 143 } ··· 149 149 const struct clk_ops *rate_ops = composite->rate_ops; 150 150 struct clk_hw *rate_hw = composite->rate_hw; 151 151 152 - rate_hw->clk = hw->clk; 152 + __clk_hw_set_clk(rate_hw, hw); 153 153 154 154 return rate_ops->set_rate(rate_hw, rate, parent_rate); 155 155 } ··· 160 160 const struct clk_ops *gate_ops = composite->gate_ops; 161 161 struct clk_hw *gate_hw = composite->gate_hw; 162 162 163 - gate_hw->clk = hw->clk; 163 + __clk_hw_set_clk(gate_hw, hw); 164 164 165 165 return gate_ops->is_enabled(gate_hw); 166 166 } ··· 171 171 const struct clk_ops *gate_ops = composite->gate_ops; 172 172 struct clk_hw *gate_hw = composite->gate_hw; 173 173 174 - gate_hw->clk = hw->clk; 174 + __clk_hw_set_clk(gate_hw, hw); 175 175 176 176 return gate_ops->enable(gate_hw); 177 177 } ··· 182 182 const struct clk_ops *gate_ops = composite->gate_ops; 183 183 struct clk_hw *gate_hw = composite->gate_hw; 184 184 185 - gate_hw->clk = hw->clk; 185 + __clk_hw_set_clk(gate_hw, hw); 186 186 187 187 gate_ops->disable(gate_hw); 188 188 }
+1 -1
drivers/clk/pxa/clk-pxa.c
··· 46 46 fix = &pclk->lp; 47 47 else 48 48 fix = &pclk->hp; 49 - fix->hw.clk = hw->clk; 49 + __clk_hw_set_clk(&fix->hw, hw); 50 50 return clk_fixed_factor_ops.recalc_rate(&fix->hw, parent_rate); 51 51 } 52 52
+10 -10
drivers/clk/st/clk-flexgen.c
··· 37 37 struct clk_hw *pgate_hw = &flexgen->pgate.hw; 38 38 struct clk_hw *fgate_hw = &flexgen->fgate.hw; 39 39 40 - pgate_hw->clk = hw->clk; 41 - fgate_hw->clk = hw->clk; 40 + __clk_hw_set_clk(pgate_hw, hw); 41 + __clk_hw_set_clk(fgate_hw, hw); 42 42 43 43 clk_gate_ops.enable(pgate_hw); 44 44 ··· 54 54 struct clk_hw *fgate_hw = &flexgen->fgate.hw; 55 55 56 56 /* disable only the final gate */ 57 - fgate_hw->clk = hw->clk; 57 + __clk_hw_set_clk(fgate_hw, hw); 58 58 59 59 clk_gate_ops.disable(fgate_hw); 60 60 ··· 66 66 struct flexgen *flexgen = to_flexgen(hw); 67 67 struct clk_hw *fgate_hw = &flexgen->fgate.hw; 68 68 69 - fgate_hw->clk = hw->clk; 69 + __clk_hw_set_clk(fgate_hw, hw); 70 70 71 71 if (!clk_gate_ops.is_enabled(fgate_hw)) 72 72 return 0; ··· 79 79 struct flexgen *flexgen = to_flexgen(hw); 80 80 struct clk_hw *mux_hw = &flexgen->mux.hw; 81 81 82 - mux_hw->clk = hw->clk; 82 + __clk_hw_set_clk(mux_hw, hw); 83 83 84 84 return clk_mux_ops.get_parent(mux_hw); 85 85 } ··· 89 89 struct flexgen *flexgen = to_flexgen(hw); 90 90 struct clk_hw *mux_hw = &flexgen->mux.hw; 91 91 92 - mux_hw->clk = hw->clk; 92 + __clk_hw_set_clk(mux_hw, hw); 93 93 94 94 return clk_mux_ops.set_parent(mux_hw, index); 95 95 } ··· 124 124 struct clk_hw *fdiv_hw = &flexgen->fdiv.hw; 125 125 unsigned long mid_rate; 126 126 127 - pdiv_hw->clk = hw->clk; 128 - fdiv_hw->clk = hw->clk; 127 + __clk_hw_set_clk(pdiv_hw, hw); 128 + __clk_hw_set_clk(fdiv_hw, hw); 129 129 130 130 mid_rate = clk_divider_ops.recalc_rate(pdiv_hw, parent_rate); 131 131 ··· 141 141 unsigned long div = 0; 142 142 int ret = 0; 143 143 144 - pdiv_hw->clk = hw->clk; 145 - fdiv_hw->clk = hw->clk; 144 + __clk_hw_set_clk(pdiv_hw, hw); 145 + __clk_hw_set_clk(fdiv_hw, hw); 146 146 147 147 div = clk_best_div(parent_rate, rate); 148 148
+7 -7
drivers/clk/st/clkgen-mux.c
··· 94 94 unsigned long timeout; 95 95 int ret = 0; 96 96 97 - mux_hw->clk = hw->clk; 97 + __clk_hw_set_clk(mux_hw, hw); 98 98 99 99 ret = clk_mux_ops.set_parent(mux_hw, genamux->muxsel); 100 100 if (ret) ··· 116 116 struct clkgena_divmux *genamux = to_clkgena_divmux(hw); 117 117 struct clk_hw *mux_hw = &genamux->mux.hw; 118 118 119 - mux_hw->clk = hw->clk; 119 + __clk_hw_set_clk(mux_hw, hw); 120 120 121 121 clk_mux_ops.set_parent(mux_hw, CKGAX_CLKOPSRC_SWITCH_OFF); 122 122 } ··· 126 126 struct clkgena_divmux *genamux = to_clkgena_divmux(hw); 127 127 struct clk_hw *mux_hw = &genamux->mux.hw; 128 128 129 - mux_hw->clk = hw->clk; 129 + __clk_hw_set_clk(mux_hw, hw); 130 130 131 131 return (s8)clk_mux_ops.get_parent(mux_hw) > 0; 132 132 } ··· 136 136 struct clkgena_divmux *genamux = to_clkgena_divmux(hw); 137 137 struct clk_hw *mux_hw = &genamux->mux.hw; 138 138 139 - mux_hw->clk = hw->clk; 139 + __clk_hw_set_clk(mux_hw, hw); 140 140 141 141 genamux->muxsel = clk_mux_ops.get_parent(mux_hw); 142 142 if ((s8)genamux->muxsel < 0) { ··· 174 174 struct clkgena_divmux *genamux = to_clkgena_divmux(hw); 175 175 struct clk_hw *div_hw = &genamux->div[genamux->muxsel].hw; 176 176 177 - div_hw->clk = hw->clk; 177 + __clk_hw_set_clk(div_hw, hw); 178 178 179 179 return clk_divider_ops.recalc_rate(div_hw, parent_rate); 180 180 } ··· 185 185 struct clkgena_divmux *genamux = to_clkgena_divmux(hw); 186 186 struct clk_hw *div_hw = &genamux->div[genamux->muxsel].hw; 187 187 188 - div_hw->clk = hw->clk; 188 + __clk_hw_set_clk(div_hw, hw); 189 189 190 190 return clk_divider_ops.set_rate(div_hw, rate, parent_rate); 191 191 } ··· 196 196 struct clkgena_divmux *genamux = to_clkgena_divmux(hw); 197 197 struct clk_hw *div_hw = &genamux->div[genamux->muxsel].hw; 198 198 199 - div_hw->clk = hw->clk; 199 + __clk_hw_set_clk(div_hw, hw); 200 200 201 201 return clk_divider_ops.round_rate(div_hw, rate, prate); 202 202 }
+7 -7
drivers/clk/tegra/clk-periph.c
··· 28 28 const struct clk_ops *mux_ops = periph->mux_ops; 29 29 struct clk_hw *mux_hw = &periph->mux.hw; 30 30 31 - mux_hw->clk = hw->clk; 31 + __clk_hw_set_clk(mux_hw, hw); 32 32 33 33 return mux_ops->get_parent(mux_hw); 34 34 } ··· 39 39 const struct clk_ops *mux_ops = periph->mux_ops; 40 40 struct clk_hw *mux_hw = &periph->mux.hw; 41 41 42 - mux_hw->clk = hw->clk; 42 + __clk_hw_set_clk(mux_hw, hw); 43 43 44 44 return mux_ops->set_parent(mux_hw, index); 45 45 } ··· 51 51 const struct clk_ops *div_ops = periph->div_ops; 52 52 struct clk_hw *div_hw = &periph->divider.hw; 53 53 54 - div_hw->clk = hw->clk; 54 + __clk_hw_set_clk(div_hw, hw); 55 55 56 56 return div_ops->recalc_rate(div_hw, parent_rate); 57 57 } ··· 63 63 const struct clk_ops *div_ops = periph->div_ops; 64 64 struct clk_hw *div_hw = &periph->divider.hw; 65 65 66 - div_hw->clk = hw->clk; 66 + __clk_hw_set_clk(div_hw, hw); 67 67 68 68 return div_ops->round_rate(div_hw, rate, prate); 69 69 } ··· 75 75 const struct clk_ops *div_ops = periph->div_ops; 76 76 struct clk_hw *div_hw = &periph->divider.hw; 77 77 78 - div_hw->clk = hw->clk; 78 + __clk_hw_set_clk(div_hw, hw); 79 79 80 80 return div_ops->set_rate(div_hw, rate, parent_rate); 81 81 } ··· 86 86 const struct clk_ops *gate_ops = periph->gate_ops; 87 87 struct clk_hw *gate_hw = &periph->gate.hw; 88 88 89 - gate_hw->clk = hw->clk; 89 + __clk_hw_set_clk(gate_hw, hw); 90 90 91 91 return gate_ops->is_enabled(gate_hw); 92 92 } ··· 97 97 const struct clk_ops *gate_ops = periph->gate_ops; 98 98 struct clk_hw *gate_hw = &periph->gate.hw; 99 99 100 - gate_hw->clk = hw->clk; 100 + __clk_hw_set_clk(gate_hw, hw); 101 101 102 102 return gate_ops->enable(gate_hw); 103 103 }