Hello,
this is another try to convince the relevant people that devm_clk_get_enabled() is a nice idea. Compared to v7 (back in May 2021) this series is rebased to v5.17-rc8 and converts quite some drivers that open code devm_clk_get_enabled() up to now (patches #3 - #11).
A concern about devm_clk_get_enabled() in v7 was that it helps people to be lazy and I agree that in some situations when devm_clk_get_enabled() is used it would be more efficient and sensible to care to only enable the clk when really needed.
On the other hand, the function is right for some users, e.g. the watchdog drivers. For the others it's not so simple to judge. Given that there are a lot of drivers that are lazy even if doing so is some effort (i.e. calling clk_prepare_enable() and devm_add_action()) convinces me, that introducing the function family is sensible. (And if you want to work on these drivers, grepping for devm_clk_get_enabled gives you a few candidates once the series is in :-)
Otherwise looking at the diffstat of this series:
48 files changed, 257 insertions(+), 851 deletions(-)
is quite convincing. Just the first two patches (which introduce the new functions) account for
2 files changed, 169 insertions(+), 17 deletions(-)
. A rough third of the added lines is documentation. The rest is driver updates which then has:
46 files changed, 88 insertions(+), 834 deletions(-)
which makes a really nice cleanup.
The series is build-tested on arm64, m68k, powerpc, riscv, s390, sparc64 and x86_64 using an allmodconfig.
Best regards Uwe
Uwe Kleine-König (16): clk: generalize devm_clk_get() a bit clk: Provide new devm_clk helpers for prepared and enabled clocks hwmon: Make use of devm_clk_get_enabled() iio: Make use of devm_clk_get_enabled() hwrng: meson - Don't open-code devm_clk_get_optional_enabled() bus: bt1: Don't open code devm_clk_get_enabled() gpio: vf610: Simplify error handling in probe drm/meson: dw-hdmi: Don't open code devm_clk_get_enabled() rtc: ingenic: Simplify using devm_clk_get_enabled() clk: meson: axg-audio: Don't duplicate devm_clk_get_enabled() watchdog: Make use of devm_clk_get_enabled() pwm: atmel: Simplify using devm_clk_get_prepared() rtc: at91sam9: Simplify using devm_clk_get_enabled() i2c: imx: Simplify using devm_clk_get_enabled() spi: davinci: Simplify using devm_clk_get_enabled() dmaengine: lgm: Fix error handling
drivers/bus/bt1-apb.c | 23 +------ drivers/bus/bt1-axi.c | 23 +------ drivers/char/hw_random/meson-rng.c | 20 +----- drivers/clk/clk-devres.c | 96 ++++++++++++++++++++++----- drivers/clk/meson/axg-audio.c | 36 ++-------- drivers/dma/lgm/lgm-dma.c | 8 +-- drivers/gpio/gpio-vf610.c | 45 +++---------- drivers/gpu/drm/meson/meson_dw_hdmi.c | 48 +++++--------- drivers/hwmon/axi-fan-control.c | 15 +---- drivers/hwmon/ltc2947-core.c | 17 +---- drivers/hwmon/mr75203.c | 26 +------- drivers/hwmon/sparx5-temp.c | 19 +----- drivers/i2c/busses/i2c-imx.c | 12 +--- drivers/iio/adc/ad7124.c | 15 +---- drivers/iio/adc/ad7768-1.c | 17 +---- drivers/iio/adc/ad9467.c | 17 +---- drivers/iio/adc/ingenic-adc.c | 15 +---- drivers/iio/adc/lpc18xx_adc.c | 18 +---- drivers/iio/adc/rockchip_saradc.c | 44 +----------- drivers/iio/adc/ti-ads131e08.c | 19 +----- drivers/iio/adc/xilinx-ams.c | 15 +---- drivers/iio/adc/xilinx-xadc-core.c | 18 +---- drivers/iio/frequency/adf4371.c | 17 +---- drivers/iio/frequency/admv1013.c | 15 +---- drivers/iio/frequency/adrf6780.c | 16 +---- drivers/iio/imu/adis16475.c | 15 +---- drivers/pwm/pwm-atmel.c | 16 +---- drivers/rtc/rtc-at91sam9.c | 22 ++---- drivers/rtc/rtc-jz4740.c | 21 +----- drivers/spi/spi-davinci.c | 11 +-- drivers/watchdog/cadence_wdt.c | 17 +---- drivers/watchdog/davinci_wdt.c | 18 +---- drivers/watchdog/imgpdc_wdt.c | 31 +-------- drivers/watchdog/imx2_wdt.c | 15 +---- drivers/watchdog/imx7ulp_wdt.c | 15 +---- drivers/watchdog/loongson1_wdt.c | 17 +---- drivers/watchdog/lpc18xx_wdt.c | 30 +-------- drivers/watchdog/meson_gxbb_wdt.c | 16 +---- drivers/watchdog/of_xilinx_wdt.c | 16 +---- drivers/watchdog/pic32-dmt.c | 15 +---- drivers/watchdog/pic32-wdt.c | 17 +---- drivers/watchdog/pnx4008_wdt.c | 15 +---- drivers/watchdog/qcom-wdt.c | 16 +---- drivers/watchdog/rtd119x_wdt.c | 16 +---- drivers/watchdog/st_lpc_wdt.c | 16 +---- drivers/watchdog/stm32_iwdg.c | 31 +-------- drivers/watchdog/visconti_wdt.c | 18 +---- include/linux/clk.h | 90 ++++++++++++++++++++++++- 48 files changed, 257 insertions(+), 851 deletions(-)
base-commit: 09688c0166e76ce2fb85e86b9d99be8b0084cdf9
Allow to add an exit hook to devm managed clocks. Also use clk_get_optional() in devm_clk_get_optional instead of open coding it. The generalisation will be used in the next commit to add some more devm_clk helpers.
Reviewed-by: Jonathan Cameron Jonathan.Cameron@huawei.com Reviewed-by: Alexandru Ardelean aardelean@deviqon.com Signed-off-by: Uwe Kleine-König u.kleine-koenig@pengutronix.de --- drivers/clk/clk-devres.c | 67 ++++++++++++++++++++++++++++++---------- 1 file changed, 50 insertions(+), 17 deletions(-)
diff --git a/drivers/clk/clk-devres.c b/drivers/clk/clk-devres.c index f9d5b7334341..fb7761888b30 100644 --- a/drivers/clk/clk-devres.c +++ b/drivers/clk/clk-devres.c @@ -4,39 +4,72 @@ #include <linux/export.h> #include <linux/gfp.h>
+struct devm_clk_state { + struct clk *clk; + void (*exit)(struct clk *clk); +}; + static void devm_clk_release(struct device *dev, void *res) { - clk_put(*(struct clk **)res); + struct devm_clk_state *state = *(struct devm_clk_state **)res; + + if (state->exit) + state->exit(state->clk); + + clk_put(state->clk); }
-struct clk *devm_clk_get(struct device *dev, const char *id) +static struct clk *__devm_clk_get(struct device *dev, const char *id, + struct clk *(*get)(struct device *dev, const char *id), + int (*init)(struct clk *clk), + void (*exit)(struct clk *clk)) { - struct clk **ptr, *clk; + struct devm_clk_state *state; + struct clk *clk; + int ret;
- ptr = devres_alloc(devm_clk_release, sizeof(*ptr), GFP_KERNEL); - if (!ptr) + state = devres_alloc(devm_clk_release, sizeof(*state), GFP_KERNEL); + if (!state) return ERR_PTR(-ENOMEM);
- clk = clk_get(dev, id); - if (!IS_ERR(clk)) { - *ptr = clk; - devres_add(dev, ptr); - } else { - devres_free(ptr); + clk = get(dev, id); + if (IS_ERR(clk)) { + ret = PTR_ERR(clk); + goto err_clk_get; }
+ if (init) { + ret = init(clk); + if (ret) + goto err_clk_init; + } + + state->clk = clk; + state->exit = exit; + + devres_add(dev, state); + return clk; + +err_clk_init: + + clk_put(clk); +err_clk_get: + + devres_free(state); + return ERR_PTR(ret); } -EXPORT_SYMBOL(devm_clk_get);
-struct clk *devm_clk_get_optional(struct device *dev, const char *id) +struct clk *devm_clk_get(struct device *dev, const char *id) { - struct clk *clk = devm_clk_get(dev, id); + return __devm_clk_get(dev, id, clk_get, NULL, NULL);
- if (clk == ERR_PTR(-ENOENT)) - return NULL; +} +EXPORT_SYMBOL(devm_clk_get);
- return clk; +struct clk *devm_clk_get_optional(struct device *dev, const char *id) +{ + return __devm_clk_get(dev, id, clk_get_optional, NULL, NULL); } EXPORT_SYMBOL(devm_clk_get_optional);
Hi Uwe,
On 14/03/2022 14:16, Uwe Kleine-König wrote:
Allow to add an exit hook to devm managed clocks. Also use clk_get_optional() in devm_clk_get_optional instead of open coding it. The generalisation will be used in the next commit to add some more devm_clk helpers.
Reviewed-by: Jonathan Cameron Jonathan.Cameron@huawei.com Reviewed-by: Alexandru Ardelean aardelean@deviqon.com Signed-off-by: Uwe Kleine-König u.kleine-koenig@pengutronix.de
drivers/clk/clk-devres.c | 67 ++++++++++++++++++++++++++++++---------- 1 file changed, 50 insertions(+), 17 deletions(-)
diff --git a/drivers/clk/clk-devres.c b/drivers/clk/clk-devres.c index f9d5b7334341..fb7761888b30 100644 --- a/drivers/clk/clk-devres.c +++ b/drivers/clk/clk-devres.c @@ -4,39 +4,72 @@ #include <linux/export.h> #include <linux/gfp.h>
+struct devm_clk_state {
- struct clk *clk;
- void (*exit)(struct clk *clk);
+};
- static void devm_clk_release(struct device *dev, void *res) {
- clk_put(*(struct clk **)res);
- struct devm_clk_state *state = *(struct devm_clk_state **)res;
- if (state->exit)
state->exit(state->clk);
- clk_put(state->clk); }
-struct clk *devm_clk_get(struct device *dev, const char *id) +static struct clk *__devm_clk_get(struct device *dev, const char *id,
struct clk *(*get)(struct device *dev, const char *id),
int (*init)(struct clk *clk),
{void (*exit)(struct clk *clk))
- struct clk **ptr, *clk;
- struct devm_clk_state *state;
- struct clk *clk;
- int ret;
- ptr = devres_alloc(devm_clk_release, sizeof(*ptr), GFP_KERNEL);
- if (!ptr)
- state = devres_alloc(devm_clk_release, sizeof(*state), GFP_KERNEL);
- if (!state) return ERR_PTR(-ENOMEM);
- clk = clk_get(dev, id);
- if (!IS_ERR(clk)) {
*ptr = clk;
devres_add(dev, ptr);
- } else {
devres_free(ptr);
clk = get(dev, id);
if (IS_ERR(clk)) {
ret = PTR_ERR(clk);
goto err_clk_get;
}
if (init) {
ret = init(clk);
if (ret)
goto err_clk_init;
}
state->clk = clk;
state->exit = exit;
devres_add(dev, state);
return clk;
+err_clk_init:
- clk_put(clk);
+err_clk_get:
- devres_free(state);
- return ERR_PTR(ret); }
-EXPORT_SYMBOL(devm_clk_get);
-struct clk *devm_clk_get_optional(struct device *dev, const char *id) +struct clk *devm_clk_get(struct device *dev, const char *id) {
- struct clk *clk = devm_clk_get(dev, id);
- return __devm_clk_get(dev, id, clk_get, NULL, NULL);
- if (clk == ERR_PTR(-ENOENT))
return NULL;
+} +EXPORT_SYMBOL(devm_clk_get);
- return clk;
+struct clk *devm_clk_get_optional(struct device *dev, const char *id) +{
- return __devm_clk_get(dev, id, clk_get_optional, NULL, NULL); } EXPORT_SYMBOL(devm_clk_get_optional);
Some of our Tegra boards are not booting with the current -next and bisect is pointing to this commit. Looking at the boot log I am seeing the following panic ...
[ 2.097048] 8<--- cut here --- [ 2.097053] Unable to handle kernel paging request at virtual address c216c810 [ 2.097060] [c216c810] *pgd=0201141e(bad) [ 2.097079] Internal error: Oops: 8000000d [#1] SMP ARM [ 2.097088] Modules linked in: [ 2.097097] CPU: 1 PID: 1 Comm: swapper/0 Not tainted 5.19.0-rc3-next-20220621-g34d1d36073ea #1 [ 2.097107] Hardware name: NVIDIA Tegra SoC (Flattened Device Tree) [ 2.097113] PC is at 0xc216c810 [ 2.097123] LR is at devm_clk_release+0x18/0x24 [ 2.097150] pc : [<c216c810>] lr : [<c088cb04>] psr: a0000013 [ 2.097155] sp : f080dde8 ip : 000006cf fp : c18d4854 [ 2.097161] r10: c1501850 r9 : c1a04d10 r8 : c1c4efa0 [ 2.097166] r7 : c216c810 r6 : f080de1c r5 : c2737680 r4 : c26a9680 [ 2.097172] r3 : c216c810 r2 : 00000000 r1 : c2737840 r0 : c2082840 [ 2.097179] Flags: NzCv IRQs on FIQs on Mode SVC_32 ISA ARM Segment none [ 2.097187] Control: 10c5387d Table: 0020404a DAC: 00000051 [ 2.097191] Register r0 information: slab kmalloc-192 start c2082840 pointer offset 0 size 192 [ 2.097216] Register r1 information: slab kmalloc-128 start c2737800 pointer offset 64 size 128 [ 2.097236] Register r2 information: NULL pointer [ 2.097244] Register r3 information: slab kmalloc-1k start c216c800 pointer offset 16 size 1024 [ 2.097263] Register r4 information: slab kmalloc-64 start c26a9680 pointer offset 0 size 64 [ 2.097282] Register r5 information: slab kmalloc-128 start c2737680 pointer offset 0 size 128 [ 2.097301] Register r6 information: 2-page vmalloc region starting at 0xf080c000 allocated at kernel_clone+0xb4/0x3e8 [ 2.097321] Register r7 information: slab kmalloc-1k start c216c800 pointer offset 16 size 1024 [ 2.097341] Register r8 information: non-slab/vmalloc memory [ 2.097348] Register r9 information: non-slab/vmalloc memory [ 2.097355] Register r10 information: non-slab/vmalloc memory [ 2.097362] Register r11 information: non-slab/vmalloc memory [ 2.097369] Register r12 information: non-paged memory [ 2.097375] Process swapper/0 (pid: 1, stack limit = 0x(ptrval)) [ 2.097384] Stack: (0xf080dde8 to 0xf080e000) [ 2.097394] dde0: c2737800 c0a72d38 c18d4854 c0530490 c216c810 f080de1c [ 2.097404] de00: c2120000 00000005 c216c9c0 80000013 0000017e c0a73d68 00000008 c2629e00 [ 2.097413] de20: c2737880 5640e141 c216c810 c216c810 00000205 c1c09dd4 00000000 c27375b8 [ 2.097422] de40: c2091700 c0a6e9a0 c216c810 c0a6f288 c216c810 c1c09dd4 c216c810 00000000 [ 2.097430] de60: c27375b8 c0a6f3c0 c1caa8e0 c216c810 c216c810 c0a6f450 00000000 c216c810 [ 2.097439] de80: c1c09dd4 c2120000 c27375b8 c0a6f850 00000000 c1c09dd4 c0a6f7c4 c0a6d4c0 [ 2.097447] dea0: 00000000 c2091458 c2286434 5640e141 c1be7f08 c1c09dd4 c2737580 c1be7f08 [ 2.097455] dec0: 00000000 c0a6e484 c1615714 c1be7c50 c1c09dd4 c2120000 c189a99c 00000000 [ 2.097464] dee0: c2120000 c0a701a0 c1c494e0 c2120000 c189a99c c0302144 0000017d c0364438 [ 2.097472] df00: c16da8bc c1626700 00000000 00000006 00000006 c16554c8 00000000 c2120000 [ 2.097480] df20: c15105bc c14f9778 c2091700 c20917d9 00000000 5640e141 c1a88930 c16da8bc [ 2.097488] df40: c1c59000 5640e141 c16da8bc c1c59000 c1953b4c c18d4834 00000007 c1801340 [ 2.097497] df60: 00000006 00000006 00000000 c18004dc c2120000 c18004dc f080df74 c1a04cc0 [ 2.097505] df80: c106bbf0 00000000 00000000 00000000 00000000 00000000 00000000 c106bc08 [ 2.097513] dfa0: 00000000 c106bbf0 00000000 c03001a8 00000000 00000000 00000000 00000000 [ 2.097520] dfc0: 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 [ 2.097528] dfe0: 00000000 00000000 00000000 00000000 00000013 00000000 00000000 00000000 [ 2.097542] devm_clk_release from release_nodes+0x58/0xc0 [ 2.097575] release_nodes from devres_release_all+0x7c/0xc0 [ 2.097596] devres_release_all from device_unbind_cleanup+0xc/0x60 [ 2.097626] device_unbind_cleanup from really_probe+0x1f4/0x2a8 [ 2.097650] really_probe from __driver_probe_device+0x84/0xe4 [ 2.097673] __driver_probe_device from driver_probe_device+0x30/0xd0 [ 2.097696] driver_probe_device from __driver_attach+0x8c/0xf0 [ 2.097713] __driver_attach from bus_for_each_dev+0x70/0xb0 [ 2.097729] bus_for_each_dev from bus_add_driver+0x168/0x1f4 [ 2.097749] bus_add_driver from driver_register+0x7c/0x118 [ 2.097766] driver_register from do_one_initcall+0x44/0x1ec [ 2.097784] do_one_initcall from kernel_init_freeable+0x1d4/0x224 [ 2.097803] kernel_init_freeable from kernel_init+0x18/0x12c [ 2.097820] kernel_init from ret_from_fork+0x14/0x2c [ 2.097831] Exception stack(0xf080dfb0 to 0xf080dff8) [ 2.097839] dfa0: 00000000 00000000 00000000 00000000 [ 2.097847] dfc0: 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 [ 2.097854] dfe0: 00000000 00000000 00000000 00000000 00000013 00000000 [ 2.097862] Code: c2288680 ffffffff 00000000 00000000 (c2288680) [ 2.097872] ---[ end trace 0000000000000000 ]---
Let me know if you have any thoughts.
Cheers Jon
On Tue, Jun 21, 2022 at 08:57:00PM +0100, Jon Hunter wrote:
Some of our Tegra boards are not booting with the current -next and bisect is pointing to this commit. Looking at the boot log I am seeing the following panic ...
[ 2.097048] 8<--- cut here --- [ 2.097053] Unable to handle kernel paging request at virtual address c216c810 [ 2.097060] [c216c810] *pgd=0201141e(bad) [ 2.097079] Internal error: Oops: 8000000d [#1] SMP ARM [ 2.097088] Modules linked in: [ 2.097097] CPU: 1 PID: 1 Comm: swapper/0 Not tainted 5.19.0-rc3-next-20220621-g34d1d36073ea #1 [ 2.097107] Hardware name: NVIDIA Tegra SoC (Flattened Device Tree) [ 2.097113] PC is at 0xc216c810 [ 2.097123] LR is at devm_clk_release+0x18/0x24 [ 2.097150] pc : [<c216c810>] lr : [<c088cb04>] psr: a0000013 [ 2.097155] sp : f080dde8 ip : 000006cf fp : c18d4854 [ 2.097161] r10: c1501850 r9 : c1a04d10 r8 : c1c4efa0 [ 2.097166] r7 : c216c810 r6 : f080de1c r5 : c2737680 r4 : c26a9680 [ 2.097172] r3 : c216c810 r2 : 00000000 r1 : c2737840 r0 : c2082840 [ 2.097179] Flags: NzCv IRQs on FIQs on Mode SVC_32 ISA ARM Segment none [ 2.097187] Control: 10c5387d Table: 0020404a DAC: 00000051 [ 2.097191] Register r0 information: slab kmalloc-192 start c2082840 pointer offset 0 size 192 [ 2.097216] Register r1 information: slab kmalloc-128 start c2737800 pointer offset 64 size 128 [ 2.097236] Register r2 information: NULL pointer [ 2.097244] Register r3 information: slab kmalloc-1k start c216c800 pointer offset 16 size 1024 [ 2.097263] Register r4 information: slab kmalloc-64 start c26a9680 pointer offset 0 size 64 [ 2.097282] Register r5 information: slab kmalloc-128 start c2737680 pointer offset 0 size 128 [ 2.097301] Register r6 information: 2-page vmalloc region starting at 0xf080c000 allocated at kernel_clone+0xb4/0x3e8 [ 2.097321] Register r7 information: slab kmalloc-1k start c216c800 pointer offset 16 size 1024 [ 2.097341] Register r8 information: non-slab/vmalloc memory [ 2.097348] Register r9 information: non-slab/vmalloc memory [ 2.097355] Register r10 information: non-slab/vmalloc memory [ 2.097362] Register r11 information: non-slab/vmalloc memory [ 2.097369] Register r12 information: non-paged memory [ 2.097375] Process swapper/0 (pid: 1, stack limit = 0x(ptrval)) [ 2.097384] Stack: (0xf080dde8 to 0xf080e000) [ 2.097394] dde0: c2737800 c0a72d38 c18d4854 c0530490 c216c810 f080de1c [ 2.097404] de00: c2120000 00000005 c216c9c0 80000013 0000017e c0a73d68 00000008 c2629e00 [ 2.097413] de20: c2737880 5640e141 c216c810 c216c810 00000205 c1c09dd4 00000000 c27375b8 [ 2.097422] de40: c2091700 c0a6e9a0 c216c810 c0a6f288 c216c810 c1c09dd4 c216c810 00000000 [ 2.097430] de60: c27375b8 c0a6f3c0 c1caa8e0 c216c810 c216c810 c0a6f450 00000000 c216c810 [ 2.097439] de80: c1c09dd4 c2120000 c27375b8 c0a6f850 00000000 c1c09dd4 c0a6f7c4 c0a6d4c0 [ 2.097447] dea0: 00000000 c2091458 c2286434 5640e141 c1be7f08 c1c09dd4 c2737580 c1be7f08 [ 2.097455] dec0: 00000000 c0a6e484 c1615714 c1be7c50 c1c09dd4 c2120000 c189a99c 00000000 [ 2.097464] dee0: c2120000 c0a701a0 c1c494e0 c2120000 c189a99c c0302144 0000017d c0364438 [ 2.097472] df00: c16da8bc c1626700 00000000 00000006 00000006 c16554c8 00000000 c2120000 [ 2.097480] df20: c15105bc c14f9778 c2091700 c20917d9 00000000 5640e141 c1a88930 c16da8bc [ 2.097488] df40: c1c59000 5640e141 c16da8bc c1c59000 c1953b4c c18d4834 00000007 c1801340 [ 2.097497] df60: 00000006 00000006 00000000 c18004dc c2120000 c18004dc f080df74 c1a04cc0 [ 2.097505] df80: c106bbf0 00000000 00000000 00000000 00000000 00000000 00000000 c106bc08 [ 2.097513] dfa0: 00000000 c106bbf0 00000000 c03001a8 00000000 00000000 00000000 00000000 [ 2.097520] dfc0: 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 [ 2.097528] dfe0: 00000000 00000000 00000000 00000000 00000013 00000000 00000000 00000000 [ 2.097542] devm_clk_release from release_nodes+0x58/0xc0 [ 2.097575] release_nodes from devres_release_all+0x7c/0xc0 [ 2.097596] devres_release_all from device_unbind_cleanup+0xc/0x60 [ 2.097626] device_unbind_cleanup from really_probe+0x1f4/0x2a8 [ 2.097650] really_probe from __driver_probe_device+0x84/0xe4 [ 2.097673] __driver_probe_device from driver_probe_device+0x30/0xd0 [ 2.097696] driver_probe_device from __driver_attach+0x8c/0xf0 [ 2.097713] __driver_attach from bus_for_each_dev+0x70/0xb0 [ 2.097729] bus_for_each_dev from bus_add_driver+0x168/0x1f4 [ 2.097749] bus_add_driver from driver_register+0x7c/0x118 [ 2.097766] driver_register from do_one_initcall+0x44/0x1ec [ 2.097784] do_one_initcall from kernel_init_freeable+0x1d4/0x224 [ 2.097803] kernel_init_freeable from kernel_init+0x18/0x12c [ 2.097820] kernel_init from ret_from_fork+0x14/0x2c [ 2.097831] Exception stack(0xf080dfb0 to 0xf080dff8) [ 2.097839] dfa0: 00000000 00000000 00000000 00000000 [ 2.097847] dfc0: 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 [ 2.097854] dfe0: 00000000 00000000 00000000 00000000 00000013 00000000 [ 2.097862] Code: c2288680 ffffffff 00000000 00000000 (c2288680) [ 2.097872] ---[ end trace 0000000000000000 ]---
Let me know if you have any thoughts.
Yeah, sorry, there is already a fix at https://lore.kernel.org/linux-clk/20220620171815.114212-1-u.kleine-koenig@pe...
(Pro tipp: The commit in next has a Link: footer. If you follow the link, you find the thread that was actually applied (i.e. v9) and where the fix is also contained.)
@Stephen: It would be a great favour to our testers if you could apply the fix ...
Best regards Uwe
On Tue, Jun 21, 2022 at 11:01 PM Uwe Kleine-König u.kleine-koenig@pengutronix.de wrote:
On Tue, Jun 21, 2022 at 08:57:00PM +0100, Jon Hunter wrote:
...
(Pro tipp: The commit in next has a Link: footer. If you follow the link, you find the thread that was actually applied (i.e. v9) and where the fix is also contained.)
Even easier, you may take a message-id from the Link and supply to `b4`:
b4 mbox ${message-id} mutt -f ${message-id}.mbx # or whatever MUA that handles mboxes
Dunno if `b4` has capability to parse Link instead of message-id.
On 22/06/2022 12:36, Andy Shevchenko wrote:
On Tue, Jun 21, 2022 at 11:01 PM Uwe Kleine-König u.kleine-koenig@pengutronix.de wrote:
On Tue, Jun 21, 2022 at 08:57:00PM +0100, Jon Hunter wrote:
...
(Pro tipp: The commit in next has a Link: footer. If you follow the link, you find the thread that was actually applied (i.e. v9) and where the fix is also contained.)
Even easier, you may take a message-id from the Link and supply to `b4`:
b4 mbox ${message-id} mutt -f ${message-id}.mbx # or whatever MUA that handles mboxes
Dunno if `b4` has capability to parse Link instead of message-id.
It does:
$ b4 mbox https://lore.kernel.org/r/20220616144915.3988071-1-windhl@126.com Looking up https://lore.kernel.org/r/20220616144915.3988071-1-windhl%40126.com Grabbing thread from lore.kernel.org/all/20220616144915.3988071-1-windhl%40126.com/t.mbox.gz 5 messages in the thread Saved ./20220616144915.3988071-1-windhl@126.com.mbx
Neil
On 21/06/2022 21:49, Uwe Kleine-König wrote:
On Tue, Jun 21, 2022 at 08:57:00PM +0100, Jon Hunter wrote:
Some of our Tegra boards are not booting with the current -next and bisect is pointing to this commit. Looking at the boot log I am seeing the following panic ...
[ 2.097048] 8<--- cut here --- [ 2.097053] Unable to handle kernel paging request at virtual address c216c810 [ 2.097060] [c216c810] *pgd=0201141e(bad) [ 2.097079] Internal error: Oops: 8000000d [#1] SMP ARM [ 2.097088] Modules linked in: [ 2.097097] CPU: 1 PID: 1 Comm: swapper/0 Not tainted 5.19.0-rc3-next-20220621-g34d1d36073ea #1 [ 2.097107] Hardware name: NVIDIA Tegra SoC (Flattened Device Tree) [ 2.097113] PC is at 0xc216c810 [ 2.097123] LR is at devm_clk_release+0x18/0x24 [ 2.097150] pc : [<c216c810>] lr : [<c088cb04>] psr: a0000013 [ 2.097155] sp : f080dde8 ip : 000006cf fp : c18d4854 [ 2.097161] r10: c1501850 r9 : c1a04d10 r8 : c1c4efa0 [ 2.097166] r7 : c216c810 r6 : f080de1c r5 : c2737680 r4 : c26a9680 [ 2.097172] r3 : c216c810 r2 : 00000000 r1 : c2737840 r0 : c2082840 [ 2.097179] Flags: NzCv IRQs on FIQs on Mode SVC_32 ISA ARM Segment none [ 2.097187] Control: 10c5387d Table: 0020404a DAC: 00000051 [ 2.097191] Register r0 information: slab kmalloc-192 start c2082840 pointer offset 0 size 192 [ 2.097216] Register r1 information: slab kmalloc-128 start c2737800 pointer offset 64 size 128 [ 2.097236] Register r2 information: NULL pointer [ 2.097244] Register r3 information: slab kmalloc-1k start c216c800 pointer offset 16 size 1024 [ 2.097263] Register r4 information: slab kmalloc-64 start c26a9680 pointer offset 0 size 64 [ 2.097282] Register r5 information: slab kmalloc-128 start c2737680 pointer offset 0 size 128 [ 2.097301] Register r6 information: 2-page vmalloc region starting at 0xf080c000 allocated at kernel_clone+0xb4/0x3e8 [ 2.097321] Register r7 information: slab kmalloc-1k start c216c800 pointer offset 16 size 1024 [ 2.097341] Register r8 information: non-slab/vmalloc memory [ 2.097348] Register r9 information: non-slab/vmalloc memory [ 2.097355] Register r10 information: non-slab/vmalloc memory [ 2.097362] Register r11 information: non-slab/vmalloc memory [ 2.097369] Register r12 information: non-paged memory [ 2.097375] Process swapper/0 (pid: 1, stack limit = 0x(ptrval)) [ 2.097384] Stack: (0xf080dde8 to 0xf080e000) [ 2.097394] dde0: c2737800 c0a72d38 c18d4854 c0530490 c216c810 f080de1c [ 2.097404] de00: c2120000 00000005 c216c9c0 80000013 0000017e c0a73d68 00000008 c2629e00 [ 2.097413] de20: c2737880 5640e141 c216c810 c216c810 00000205 c1c09dd4 00000000 c27375b8 [ 2.097422] de40: c2091700 c0a6e9a0 c216c810 c0a6f288 c216c810 c1c09dd4 c216c810 00000000 [ 2.097430] de60: c27375b8 c0a6f3c0 c1caa8e0 c216c810 c216c810 c0a6f450 00000000 c216c810 [ 2.097439] de80: c1c09dd4 c2120000 c27375b8 c0a6f850 00000000 c1c09dd4 c0a6f7c4 c0a6d4c0 [ 2.097447] dea0: 00000000 c2091458 c2286434 5640e141 c1be7f08 c1c09dd4 c2737580 c1be7f08 [ 2.097455] dec0: 00000000 c0a6e484 c1615714 c1be7c50 c1c09dd4 c2120000 c189a99c 00000000 [ 2.097464] dee0: c2120000 c0a701a0 c1c494e0 c2120000 c189a99c c0302144 0000017d c0364438 [ 2.097472] df00: c16da8bc c1626700 00000000 00000006 00000006 c16554c8 00000000 c2120000 [ 2.097480] df20: c15105bc c14f9778 c2091700 c20917d9 00000000 5640e141 c1a88930 c16da8bc [ 2.097488] df40: c1c59000 5640e141 c16da8bc c1c59000 c1953b4c c18d4834 00000007 c1801340 [ 2.097497] df60: 00000006 00000006 00000000 c18004dc c2120000 c18004dc f080df74 c1a04cc0 [ 2.097505] df80: c106bbf0 00000000 00000000 00000000 00000000 00000000 00000000 c106bc08 [ 2.097513] dfa0: 00000000 c106bbf0 00000000 c03001a8 00000000 00000000 00000000 00000000 [ 2.097520] dfc0: 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 [ 2.097528] dfe0: 00000000 00000000 00000000 00000000 00000013 00000000 00000000 00000000 [ 2.097542] devm_clk_release from release_nodes+0x58/0xc0 [ 2.097575] release_nodes from devres_release_all+0x7c/0xc0 [ 2.097596] devres_release_all from device_unbind_cleanup+0xc/0x60 [ 2.097626] device_unbind_cleanup from really_probe+0x1f4/0x2a8 [ 2.097650] really_probe from __driver_probe_device+0x84/0xe4 [ 2.097673] __driver_probe_device from driver_probe_device+0x30/0xd0 [ 2.097696] driver_probe_device from __driver_attach+0x8c/0xf0 [ 2.097713] __driver_attach from bus_for_each_dev+0x70/0xb0 [ 2.097729] bus_for_each_dev from bus_add_driver+0x168/0x1f4 [ 2.097749] bus_add_driver from driver_register+0x7c/0x118 [ 2.097766] driver_register from do_one_initcall+0x44/0x1ec [ 2.097784] do_one_initcall from kernel_init_freeable+0x1d4/0x224 [ 2.097803] kernel_init_freeable from kernel_init+0x18/0x12c [ 2.097820] kernel_init from ret_from_fork+0x14/0x2c [ 2.097831] Exception stack(0xf080dfb0 to 0xf080dff8) [ 2.097839] dfa0: 00000000 00000000 00000000 00000000 [ 2.097847] dfc0: 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 [ 2.097854] dfe0: 00000000 00000000 00000000 00000000 00000013 00000000 [ 2.097862] Code: c2288680 ffffffff 00000000 00000000 (c2288680) [ 2.097872] ---[ end trace 0000000000000000 ]---
Let me know if you have any thoughts.
Yeah, sorry, there is already a fix at https://lore.kernel.org/linux-clk/20220620171815.114212-1-u.kleine-koenig@pe...
Thanks! Works for me.
Tested-by: Jon Hunter jonathanh@nvidia.com
(Pro tipp: The commit in next has a Link: footer. If you follow the link, you find the thread that was actually applied (i.e. v9) and where the fix is also contained.
Thanks for the tip!
Jon
When a driver keeps a clock prepared (or enabled) during the whole lifetime of the driver, these helpers allow to simplify the drivers.
Reviewed-by: Jonathan Cameron Jonathan.Cameron@huawei.com Reviewed-by: Alexandru Ardelean aardelean@deviqon.com Signed-off-by: Uwe Kleine-König u.kleine-koenig@pengutronix.de --- drivers/clk/clk-devres.c | 31 ++++++++++++++ include/linux/clk.h | 90 +++++++++++++++++++++++++++++++++++++++- 2 files changed, 120 insertions(+), 1 deletion(-)
diff --git a/drivers/clk/clk-devres.c b/drivers/clk/clk-devres.c index fb7761888b30..4707fe718f0b 100644 --- a/drivers/clk/clk-devres.c +++ b/drivers/clk/clk-devres.c @@ -67,12 +67,43 @@ struct clk *devm_clk_get(struct device *dev, const char *id) } EXPORT_SYMBOL(devm_clk_get);
+struct clk *devm_clk_get_prepared(struct device *dev, const char *id) +{ + return __devm_clk_get(dev, id, clk_get, clk_prepare, clk_unprepare); + +} +EXPORT_SYMBOL(devm_clk_get_prepared); + +struct clk *devm_clk_get_enabled(struct device *dev, const char *id) +{ + return __devm_clk_get(dev, id, clk_get, + clk_prepare_enable, clk_disable_unprepare); + +} +EXPORT_SYMBOL(devm_clk_get_enabled); + struct clk *devm_clk_get_optional(struct device *dev, const char *id) { return __devm_clk_get(dev, id, clk_get_optional, NULL, NULL); } EXPORT_SYMBOL(devm_clk_get_optional);
+struct clk *devm_clk_get_optional_prepared(struct device *dev, const char *id) +{ + return __devm_clk_get(dev, id, clk_get_optional, + clk_prepare, clk_unprepare); + +} +EXPORT_SYMBOL(devm_clk_get_optional_prepared); + +struct clk *devm_clk_get_optional_enabled(struct device *dev, const char *id) +{ + return __devm_clk_get(dev, id, clk_get_optional, + clk_prepare_enable, clk_disable_unprepare); + +} +EXPORT_SYMBOL(devm_clk_get_optional_enabled); + struct clk_bulk_devres { struct clk_bulk_data *clks; int num_clks; diff --git a/include/linux/clk.h b/include/linux/clk.h index 266e8de3cb51..b011dbba7109 100644 --- a/include/linux/clk.h +++ b/include/linux/clk.h @@ -449,7 +449,7 @@ int __must_check devm_clk_bulk_get_all(struct device *dev, * the clock producer. (IOW, @id may be identical strings, but * clk_get may return different clock producers depending on @dev.) * - * Drivers must assume that the clock source is not enabled. + * Drivers must assume that the clock source is neither prepared nor enabled. * * devm_clk_get should not be called from within interrupt context. * @@ -458,6 +458,47 @@ int __must_check devm_clk_bulk_get_all(struct device *dev, */ struct clk *devm_clk_get(struct device *dev, const char *id);
+/** + * devm_clk_get_prepared - devm_clk_get() + clk_prepare() + * @dev: device for clock "consumer" + * @id: clock consumer ID + * + * Returns a struct clk corresponding to the clock producer, or + * valid IS_ERR() condition containing errno. The implementation + * uses @dev and @id to determine the clock consumer, and thereby + * the clock producer. (IOW, @id may be identical strings, but + * clk_get may return different clock producers depending on @dev.) + * + * The returned clk (if valid) is prepared. Drivers must however assume that the + * clock is not enabled. + * + * devm_clk_get_prepared should not be called from within interrupt context. + * + * The clock will automatically be unprepared and freed when the + * device is unbound from the bus. + */ +struct clk *devm_clk_get_prepared(struct device *dev, const char *id); + +/** + * devm_clk_get_enabled - devm_clk_get() + clk_prepare_enable() + * @dev: device for clock "consumer" + * @id: clock consumer ID + * + * Returns a struct clk corresponding to the clock producer, or valid IS_ERR() + * condition containing errno. The implementation uses @dev and @id to + * determine the clock consumer, and thereby the clock producer. (IOW, @id may + * be identical strings, but clk_get may return different clock producers + * depending on @dev.) + * + * The returned clk (if valid) is prepared and enabled. + * + * devm_clk_get_prepared should not be called from within interrupt context. + * + * The clock will automatically be disabled, unprepared and freed when the + * device is unbound from the bus. + */ +struct clk *devm_clk_get_enabled(struct device *dev, const char *id); + /** * devm_clk_get_optional - lookup and obtain a managed reference to an optional * clock producer. @@ -469,6 +510,29 @@ struct clk *devm_clk_get(struct device *dev, const char *id); */ struct clk *devm_clk_get_optional(struct device *dev, const char *id);
+/** + * devm_clk_get_optional_prepared - devm_clk_get_optional() + clk_prepare() + * @dev: device for clock "consumer" + * @id: clock consumer ID + * + * Behaves the same as devm_clk_get_prepared() except where there is no clock + * producer. In this case, instead of returning -ENOENT, the function returns + * NULL. + */ +struct clk *devm_clk_get_optional_prepared(struct device *dev, const char *id); + +/** + * devm_clk_get_optional_enabled - devm_clk_get_optional() + + * clk_prepare_enable() + * @dev: device for clock "consumer" + * @id: clock consumer ID + * + * Behaves the same as devm_clk_get_enabled() except where there is no clock + * producer. In this case, instead of returning -ENOENT, the function returns + * NULL. + */ +struct clk *devm_clk_get_optional_enabled(struct device *dev, const char *id); + /** * devm_get_clk_from_child - lookup and obtain a managed reference to a * clock producer from child node. @@ -813,12 +877,36 @@ static inline struct clk *devm_clk_get(struct device *dev, const char *id) return NULL; }
+static inline struct clk *devm_clk_get_prepared(struct device *dev, + const char *id) +{ + return NULL; +} + +static inline struct clk *devm_clk_get_enabled(struct device *dev, + const char *id) +{ + return NULL; +} + static inline struct clk *devm_clk_get_optional(struct device *dev, const char *id) { return NULL; }
+static inline struct clk *devm_clk_get_optional_prepared(struct device *dev, + const char *id) +{ + return NULL; +} + +static inline struct clk *devm_clk_get_optional_enabled(struct device *dev, + const char *id) +{ + return NULL; +} + static inline int __must_check devm_clk_bulk_get(struct device *dev, int num_clks, struct clk_bulk_data *clks) {
On Mon, 14 Mar 2022 15:16:29 +0100 Uwe Kleine-König u.kleine-koenig@pengutronix.de wrote:
When a driver keeps a clock prepared (or enabled) during the whole lifetime of the driver, these helpers allow to simplify the drivers.
Reviewed-by: Jonathan Cameron Jonathan.Cameron@huawei.com Reviewed-by: Alexandru Ardelean aardelean@deviqon.com Signed-off-by: Uwe Kleine-König u.kleine-koenig@pengutronix.de
One trivial thing below.
drivers/clk/clk-devres.c | 31 ++++++++++++++ include/linux/clk.h | 90 +++++++++++++++++++++++++++++++++++++++- 2 files changed, 120 insertions(+), 1 deletion(-)
diff --git a/drivers/clk/clk-devres.c b/drivers/clk/clk-devres.c index fb7761888b30..4707fe718f0b 100644 --- a/drivers/clk/clk-devres.c +++ b/drivers/clk/clk-devres.c @@ -67,12 +67,43 @@ struct clk *devm_clk_get(struct device *dev, const char *id) } EXPORT_SYMBOL(devm_clk_get);
+struct clk *devm_clk_get_prepared(struct device *dev, const char *id) +{
- return __devm_clk_get(dev, id, clk_get, clk_prepare, clk_unprepare);
Nitpick but this spacing before } in functions is rather unusual and not in keeping with the existing code in this file.
+} +EXPORT_SYMBOL(devm_clk_get_prepared);
+struct clk *devm_clk_get_enabled(struct device *dev, const char *id) +{
- return __devm_clk_get(dev, id, clk_get,
clk_prepare_enable, clk_disable_unprepare);
+} +EXPORT_SYMBOL(devm_clk_get_enabled);
struct clk *devm_clk_get_optional(struct device *dev, const char *id) { return __devm_clk_get(dev, id, clk_get_optional, NULL, NULL); } EXPORT_SYMBOL(devm_clk_get_optional);
+struct clk *devm_clk_get_optional_prepared(struct device *dev, const char *id) +{
- return __devm_clk_get(dev, id, clk_get_optional,
clk_prepare, clk_unprepare);
+} +EXPORT_SYMBOL(devm_clk_get_optional_prepared);
+struct clk *devm_clk_get_optional_enabled(struct device *dev, const char *id) +{
- return __devm_clk_get(dev, id, clk_get_optional,
clk_prepare_enable, clk_disable_unprepare);
+} +EXPORT_SYMBOL(devm_clk_get_optional_enabled);
struct clk_bulk_devres { struct clk_bulk_data *clks; int num_clks; diff --git a/include/linux/clk.h b/include/linux/clk.h index 266e8de3cb51..b011dbba7109 100644 --- a/include/linux/clk.h +++ b/include/linux/clk.h @@ -449,7 +449,7 @@ int __must_check devm_clk_bulk_get_all(struct device *dev,
- the clock producer. (IOW, @id may be identical strings, but
- clk_get may return different clock producers depending on @dev.)
- Drivers must assume that the clock source is not enabled.
- Drivers must assume that the clock source is neither prepared nor enabled.
- devm_clk_get should not be called from within interrupt context.
@@ -458,6 +458,47 @@ int __must_check devm_clk_bulk_get_all(struct device *dev, */ struct clk *devm_clk_get(struct device *dev, const char *id);
+/**
- devm_clk_get_prepared - devm_clk_get() + clk_prepare()
- @dev: device for clock "consumer"
- @id: clock consumer ID
- Returns a struct clk corresponding to the clock producer, or
- valid IS_ERR() condition containing errno. The implementation
- uses @dev and @id to determine the clock consumer, and thereby
- the clock producer. (IOW, @id may be identical strings, but
- clk_get may return different clock producers depending on @dev.)
- The returned clk (if valid) is prepared. Drivers must however assume that the
- clock is not enabled.
- devm_clk_get_prepared should not be called from within interrupt context.
- The clock will automatically be unprepared and freed when the
- device is unbound from the bus.
- */
+struct clk *devm_clk_get_prepared(struct device *dev, const char *id);
+/**
- devm_clk_get_enabled - devm_clk_get() + clk_prepare_enable()
- @dev: device for clock "consumer"
- @id: clock consumer ID
- Returns a struct clk corresponding to the clock producer, or valid IS_ERR()
- condition containing errno. The implementation uses @dev and @id to
- determine the clock consumer, and thereby the clock producer. (IOW, @id may
- be identical strings, but clk_get may return different clock producers
- depending on @dev.)
- The returned clk (if valid) is prepared and enabled.
- devm_clk_get_prepared should not be called from within interrupt context.
- The clock will automatically be disabled, unprepared and freed when the
- device is unbound from the bus.
- */
+struct clk *devm_clk_get_enabled(struct device *dev, const char *id);
/**
- devm_clk_get_optional - lookup and obtain a managed reference to an optional
clock producer.
@@ -469,6 +510,29 @@ struct clk *devm_clk_get(struct device *dev, const char *id); */ struct clk *devm_clk_get_optional(struct device *dev, const char *id);
+/**
- devm_clk_get_optional_prepared - devm_clk_get_optional() + clk_prepare()
- @dev: device for clock "consumer"
- @id: clock consumer ID
- Behaves the same as devm_clk_get_prepared() except where there is no clock
- producer. In this case, instead of returning -ENOENT, the function returns
- NULL.
- */
+struct clk *devm_clk_get_optional_prepared(struct device *dev, const char *id);
+/**
- devm_clk_get_optional_enabled - devm_clk_get_optional() +
clk_prepare_enable()
- @dev: device for clock "consumer"
- @id: clock consumer ID
- Behaves the same as devm_clk_get_enabled() except where there is no clock
- producer. In this case, instead of returning -ENOENT, the function returns
- NULL.
- */
+struct clk *devm_clk_get_optional_enabled(struct device *dev, const char *id);
/**
- devm_get_clk_from_child - lookup and obtain a managed reference to a
clock producer from child node.
@@ -813,12 +877,36 @@ static inline struct clk *devm_clk_get(struct device *dev, const char *id) return NULL; }
+static inline struct clk *devm_clk_get_prepared(struct device *dev,
const char *id)
+{
- return NULL;
+}
+static inline struct clk *devm_clk_get_enabled(struct device *dev,
const char *id)
+{
- return NULL;
+}
static inline struct clk *devm_clk_get_optional(struct device *dev, const char *id) { return NULL; }
+static inline struct clk *devm_clk_get_optional_prepared(struct device *dev,
const char *id)
+{
- return NULL;
+}
+static inline struct clk *devm_clk_get_optional_enabled(struct device *dev,
const char *id)
+{
- return NULL;
+}
static inline int __must_check devm_clk_bulk_get(struct device *dev, int num_clks, struct clk_bulk_data *clks) {
On Sat, Mar 19, 2022 at 06:29:36PM +0000, Jonathan Cameron wrote:
On Mon, 14 Mar 2022 15:16:29 +0100 Uwe Kleine-König u.kleine-koenig@pengutronix.de wrote:
When a driver keeps a clock prepared (or enabled) during the whole lifetime of the driver, these helpers allow to simplify the drivers.
Reviewed-by: Jonathan Cameron Jonathan.Cameron@huawei.com Reviewed-by: Alexandru Ardelean aardelean@deviqon.com Signed-off-by: Uwe Kleine-König u.kleine-koenig@pengutronix.de
One trivial thing below.
drivers/clk/clk-devres.c | 31 ++++++++++++++ include/linux/clk.h | 90 +++++++++++++++++++++++++++++++++++++++- 2 files changed, 120 insertions(+), 1 deletion(-)
diff --git a/drivers/clk/clk-devres.c b/drivers/clk/clk-devres.c index fb7761888b30..4707fe718f0b 100644 --- a/drivers/clk/clk-devres.c +++ b/drivers/clk/clk-devres.c @@ -67,12 +67,43 @@ struct clk *devm_clk_get(struct device *dev, const char *id) } EXPORT_SYMBOL(devm_clk_get);
+struct clk *devm_clk_get_prepared(struct device *dev, const char *id) +{
- return __devm_clk_get(dev, id, clk_get, clk_prepare, clk_unprepare);
Nitpick but this spacing before } in functions is rather unusual and not in keeping with the existing code in this file.
+}
ack, I fixed that in my tree, so this will be part of an v9. I won't send it just for this change, though. I fixed three further functions that had a similar empty line, too.
Thanks for looking Uwe
The Cc list is huge. Here it goes!
Quoting Uwe Kleine-König (2022-03-14 07:16:29)
When a driver keeps a clock prepared (or enabled) during the whole lifetime of the driver, these helpers allow to simplify the drivers.
Reviewed-by: Jonathan Cameron Jonathan.Cameron@huawei.com Reviewed-by: Alexandru Ardelean aardelean@deviqon.com Signed-off-by: Uwe Kleine-König u.kleine-koenig@pengutronix.de
I'm ready to merge it! I'm largely waiting for Russell to ack the clk.h change, but if that doesn't happen then I think we'll have to merge it anyway. Can you resend with collected acks, maybe just the ones you want me to merge through clk tree? Then I'll go ahead and stage it. Some nitpicks below.
drivers/clk/clk-devres.c | 31 ++++++++++++++ include/linux/clk.h | 90 +++++++++++++++++++++++++++++++++++++++- 2 files changed, 120 insertions(+), 1 deletion(-)
diff --git a/drivers/clk/clk-devres.c b/drivers/clk/clk-devres.c index fb7761888b30..4707fe718f0b 100644 --- a/drivers/clk/clk-devres.c +++ b/drivers/clk/clk-devres.c @@ -67,12 +67,43 @@ struct clk *devm_clk_get(struct device *dev, const char *id) } EXPORT_SYMBOL(devm_clk_get);
+struct clk *devm_clk_get_prepared(struct device *dev, const char *id) +{
return __devm_clk_get(dev, id, clk_get, clk_prepare, clk_unprepare);
Nitpick: Remove newline
+} +EXPORT_SYMBOL(devm_clk_get_prepared);
+struct clk *devm_clk_get_enabled(struct device *dev, const char *id) +{
return __devm_clk_get(dev, id, clk_get,
clk_prepare_enable, clk_disable_unprepare);
Nitpick: Remove newline
+} +EXPORT_SYMBOL(devm_clk_get_enabled);
struct clk *devm_clk_get_optional(struct device *dev, const char *id) { return __devm_clk_get(dev, id, clk_get_optional, NULL, NULL); } EXPORT_SYMBOL(devm_clk_get_optional);
+struct clk *devm_clk_get_optional_prepared(struct device *dev, const char *id) +{
return __devm_clk_get(dev, id, clk_get_optional,
clk_prepare, clk_unprepare);
Nitpick: Remove newline
+} +EXPORT_SYMBOL(devm_clk_get_optional_prepared);
+struct clk *devm_clk_get_optional_enabled(struct device *dev, const char *id) +{
return __devm_clk_get(dev, id, clk_get_optional,
clk_prepare_enable, clk_disable_unprepare);
Nitpick: Remove newline
+} +EXPORT_SYMBOL(devm_clk_get_optional_enabled);
EXPORT_SYMBOL_GPL for all of these? Or make them macros and cut down on the number of symbols.
struct clk_bulk_devres { struct clk_bulk_data *clks; int num_clks; diff --git a/include/linux/clk.h b/include/linux/clk.h index 266e8de3cb51..b011dbba7109 100644 --- a/include/linux/clk.h +++ b/include/linux/clk.h @@ -449,7 +449,7 @@ int __must_check devm_clk_bulk_get_all(struct device *dev,
- the clock producer. (IOW, @id may be identical strings, but
- clk_get may return different clock producers depending on @dev.)
- Drivers must assume that the clock source is not enabled.
- Drivers must assume that the clock source is neither prepared nor enabled.
- devm_clk_get should not be called from within interrupt context.
Can you split this off to another patch? It's updating the doc to clarify the assumed state of a clk returned from this API.
@@ -458,6 +458,47 @@ int __must_check devm_clk_bulk_get_all(struct device *dev, */ struct clk *devm_clk_get(struct device *dev, const char *id);
+/**
- devm_clk_get_prepared - devm_clk_get() + clk_prepare()
- @dev: device for clock "consumer"
- @id: clock consumer ID
- Returns a struct clk corresponding to the clock producer, or
- valid IS_ERR() condition containing errno. The implementation
- uses @dev and @id to determine the clock consumer, and thereby
- the clock producer. (IOW, @id may be identical strings, but
- clk_get may return different clock producers depending on @dev.)
- The returned clk (if valid) is prepared. Drivers must however assume that the
- clock is not enabled.
- devm_clk_get_prepared should not be called from within interrupt context.
There's 'Context:' for this. Please use it.
- The clock will automatically be unprepared and freed when the
- device is unbound from the bus.
- */
+struct clk *devm_clk_get_prepared(struct device *dev, const char *id);
+/**
- devm_clk_get_enabled - devm_clk_get() + clk_prepare_enable()
- @dev: device for clock "consumer"
- @id: clock consumer ID
- Returns a struct clk corresponding to the clock producer, or valid IS_ERR()
There's 'Return:' for this. Please use it.
- condition containing errno. The implementation uses @dev and @id to
- determine the clock consumer, and thereby the clock producer. (IOW, @id may
- be identical strings, but clk_get may return different clock producers
- depending on @dev.)
- The returned clk (if valid) is prepared and enabled.
- devm_clk_get_prepared should not be called from within interrupt context.
- The clock will automatically be disabled, unprepared and freed when the
- device is unbound from the bus.
- */
+struct clk *devm_clk_get_enabled(struct device *dev, const char *id);
/**
- devm_clk_get_optional - lookup and obtain a managed reference to an optional
clock producer.
@@ -469,6 +510,29 @@ struct clk *devm_clk_get(struct device *dev, const char *id); */ struct clk *devm_clk_get_optional(struct device *dev, const char *id);
+/**
- devm_clk_get_optional_prepared - devm_clk_get_optional() + clk_prepare()
- @dev: device for clock "consumer"
- @id: clock consumer ID
- Behaves the same as devm_clk_get_prepared() except where there is no clock
- producer. In this case, instead of returning -ENOENT, the function returns
- NULL.
When it comes to kernel-doc I think the DRY principle should not apply. I don't want to have to jump to one doc block to jump to another doc block while holding the previous verbage in my head to understand what the difference is. Please be repetitive with documentation for APIs :)
- */
+struct clk *devm_clk_get_optional_prepared(struct device *dev, const char *id);
+/**
- devm_clk_get_optional_enabled - devm_clk_get_optional() +
clk_prepare_enable()
- @dev: device for clock "consumer"
- @id: clock consumer ID
- Behaves the same as devm_clk_get_enabled() except where there is no clock
- producer. In this case, instead of returning -ENOENT, the function returns
- NULL.
- */
+struct clk *devm_clk_get_optional_enabled(struct device *dev, const char *id);
/**
- devm_get_clk_from_child - lookup and obtain a managed reference to a
clock producer from child node.
devm_clk_get_enabled() returns a clock prepared and enabled and already registers a devm exit handler to disable (and unprepare) the clock.
There is slight change in behavior as a failure to enable the clock now results in an error message, too. Also the actual error code is added to the message.
Signed-off-by: Uwe Kleine-König u.kleine-koenig@pengutronix.de --- drivers/gpu/drm/meson/meson_dw_hdmi.c | 48 +++++++++------------------ 1 file changed, 16 insertions(+), 32 deletions(-)
diff --git a/drivers/gpu/drm/meson/meson_dw_hdmi.c b/drivers/gpu/drm/meson/meson_dw_hdmi.c index 5cd2b2ebbbd3..6034e80c5b2e 100644 --- a/drivers/gpu/drm/meson/meson_dw_hdmi.c +++ b/drivers/gpu/drm/meson/meson_dw_hdmi.c @@ -670,29 +670,6 @@ static void meson_disable_regulator(void *data) regulator_disable(data); }
-static void meson_disable_clk(void *data) -{ - clk_disable_unprepare(data); -} - -static int meson_enable_clk(struct device *dev, char *name) -{ - struct clk *clk; - int ret; - - clk = devm_clk_get(dev, name); - if (IS_ERR(clk)) { - dev_err(dev, "Unable to get %s pclk\n", name); - return PTR_ERR(clk); - } - - ret = clk_prepare_enable(clk); - if (!ret) - ret = devm_add_action_or_reset(dev, meson_disable_clk, clk); - - return ret; -} - static int meson_dw_hdmi_bind(struct device *dev, struct device *master, void *data) { @@ -702,6 +679,7 @@ static int meson_dw_hdmi_bind(struct device *dev, struct device *master, struct drm_device *drm = data; struct meson_drm *priv = drm->dev_private; struct dw_hdmi_plat_data *dw_plat_data; + struct clk *clk; int irq; int ret;
@@ -763,17 +741,23 @@ static int meson_dw_hdmi_bind(struct device *dev, struct device *master, if (IS_ERR(meson_dw_hdmi->hdmitx)) return PTR_ERR(meson_dw_hdmi->hdmitx);
- ret = meson_enable_clk(dev, "isfr"); - if (ret) - return ret; + clk = devm_clk_get_enabled(dev, "isfr"); + if (IS_ERR(clk)) { + dev_err(dev, "Failed to get enabled isfr pclk (%pe)\n", clk); + return PTR_ERR(clk); + }
- ret = meson_enable_clk(dev, "iahb"); - if (ret) - return ret; + clk = devm_clk_get_enabled(dev, "iahb"); + if (IS_ERR(clk)) { + dev_err(dev, "Failed to get enabled iahb pclk (%pe)\n", clk); + return PTR_ERR(clk); + }
- ret = meson_enable_clk(dev, "venci"); - if (ret) - return ret; + clk = devm_clk_get_enabled(dev, "venci"); + if (IS_ERR(clk)) { + dev_err(dev, "Failed to get enabled venci pclk (%pe)\n", clk); + return PTR_ERR(clk); + }
dw_plat_data->regm = devm_regmap_init(dev, NULL, meson_dw_hdmi, &meson_dw_hdmi_regmap_config);
On 14/03/2022 15:16, Uwe Kleine-König wrote:
devm_clk_get_enabled() returns a clock prepared and enabled and already registers a devm exit handler to disable (and unprepare) the clock.
There is slight change in behavior as a failure to enable the clock now results in an error message, too. Also the actual error code is added to the message.
Signed-off-by: Uwe Kleine-König u.kleine-koenig@pengutronix.de
drivers/gpu/drm/meson/meson_dw_hdmi.c | 48 +++++++++------------------ 1 file changed, 16 insertions(+), 32 deletions(-)
diff --git a/drivers/gpu/drm/meson/meson_dw_hdmi.c b/drivers/gpu/drm/meson/meson_dw_hdmi.c index 5cd2b2ebbbd3..6034e80c5b2e 100644 --- a/drivers/gpu/drm/meson/meson_dw_hdmi.c +++ b/drivers/gpu/drm/meson/meson_dw_hdmi.c @@ -670,29 +670,6 @@ static void meson_disable_regulator(void *data) regulator_disable(data); }
-static void meson_disable_clk(void *data) -{
- clk_disable_unprepare(data);
-}
-static int meson_enable_clk(struct device *dev, char *name) -{
- struct clk *clk;
- int ret;
- clk = devm_clk_get(dev, name);
- if (IS_ERR(clk)) {
dev_err(dev, "Unable to get %s pclk\n", name);
return PTR_ERR(clk);
- }
- ret = clk_prepare_enable(clk);
- if (!ret)
ret = devm_add_action_or_reset(dev, meson_disable_clk, clk);
- return ret;
-}
- static int meson_dw_hdmi_bind(struct device *dev, struct device *master, void *data) {
@@ -702,6 +679,7 @@ static int meson_dw_hdmi_bind(struct device *dev, struct device *master, struct drm_device *drm = data; struct meson_drm *priv = drm->dev_private; struct dw_hdmi_plat_data *dw_plat_data;
- struct clk *clk; int irq; int ret;
@@ -763,17 +741,23 @@ static int meson_dw_hdmi_bind(struct device *dev, struct device *master, if (IS_ERR(meson_dw_hdmi->hdmitx)) return PTR_ERR(meson_dw_hdmi->hdmitx);
- ret = meson_enable_clk(dev, "isfr");
- if (ret)
return ret;
- clk = devm_clk_get_enabled(dev, "isfr");
- if (IS_ERR(clk)) {
dev_err(dev, "Failed to get enabled isfr pclk (%pe)\n", clk);
return PTR_ERR(clk);
- }
- ret = meson_enable_clk(dev, "iahb");
- if (ret)
return ret;
- clk = devm_clk_get_enabled(dev, "iahb");
- if (IS_ERR(clk)) {
dev_err(dev, "Failed to get enabled iahb pclk (%pe)\n", clk);
return PTR_ERR(clk);
- }
- ret = meson_enable_clk(dev, "venci");
- if (ret)
return ret;
clk = devm_clk_get_enabled(dev, "venci");
if (IS_ERR(clk)) {
dev_err(dev, "Failed to get enabled venci pclk (%pe)\n", clk);
return PTR_ERR(clk);
}
dw_plat_data->regm = devm_regmap_init(dev, NULL, meson_dw_hdmi, &meson_dw_hdmi_regmap_config);
Acked-by: Neil Armstrong narmstrong@baylibre.com
On Mon, Mar 14, 2022 at 5:14 PM Uwe Kleine-König u.kleine-koenig@pengutronix.de wrote:
Hello,
this is another try to convince the relevant people that devm_clk_get_enabled() is a nice idea. Compared to v7 (back in May 2021) this series is rebased to v5.17-rc8 and converts quite some drivers that open code devm_clk_get_enabled() up to now (patches #3 - #11).
A concern about devm_clk_get_enabled() in v7 was that it helps people to be lazy and I agree that in some situations when devm_clk_get_enabled() is used it would be more efficient and sensible to care to only enable the clk when really needed.
On the other hand, the function is right for some users, e.g. the watchdog drivers. For the others it's not so simple to judge. Given that there are a lot of drivers that are lazy even if doing so is some effort (i.e. calling clk_prepare_enable() and devm_add_action()) convinces me, that introducing the function family is sensible. (And if you want to work on these drivers, grepping for devm_clk_get_enabled gives you a few candidates once the series is in :-)
FWIW, Reviewed-by: Andy Shevchenko andy.shevchenko@gmail.com for drivers/iio
Thanks for doing this!
Otherwise looking at the diffstat of this series:
48 files changed, 257 insertions(+), 851 deletions(-)
is quite convincing. Just the first two patches (which introduce the new functions) account for
2 files changed, 169 insertions(+), 17 deletions(-)
. A rough third of the added lines is documentation. The rest is driver updates which then has:
46 files changed, 88 insertions(+), 834 deletions(-)
which makes a really nice cleanup.
The series is build-tested on arm64, m68k, powerpc, riscv, s390, sparc64 and x86_64 using an allmodconfig.
Best regards Uwe
Uwe Kleine-König (16): clk: generalize devm_clk_get() a bit clk: Provide new devm_clk helpers for prepared and enabled clocks hwmon: Make use of devm_clk_get_enabled() iio: Make use of devm_clk_get_enabled() hwrng: meson - Don't open-code devm_clk_get_optional_enabled() bus: bt1: Don't open code devm_clk_get_enabled() gpio: vf610: Simplify error handling in probe drm/meson: dw-hdmi: Don't open code devm_clk_get_enabled() rtc: ingenic: Simplify using devm_clk_get_enabled() clk: meson: axg-audio: Don't duplicate devm_clk_get_enabled() watchdog: Make use of devm_clk_get_enabled() pwm: atmel: Simplify using devm_clk_get_prepared() rtc: at91sam9: Simplify using devm_clk_get_enabled() i2c: imx: Simplify using devm_clk_get_enabled() spi: davinci: Simplify using devm_clk_get_enabled() dmaengine: lgm: Fix error handling
drivers/bus/bt1-apb.c | 23 +------ drivers/bus/bt1-axi.c | 23 +------ drivers/char/hw_random/meson-rng.c | 20 +----- drivers/clk/clk-devres.c | 96 ++++++++++++++++++++++----- drivers/clk/meson/axg-audio.c | 36 ++-------- drivers/dma/lgm/lgm-dma.c | 8 +-- drivers/gpio/gpio-vf610.c | 45 +++---------- drivers/gpu/drm/meson/meson_dw_hdmi.c | 48 +++++--------- drivers/hwmon/axi-fan-control.c | 15 +---- drivers/hwmon/ltc2947-core.c | 17 +---- drivers/hwmon/mr75203.c | 26 +------- drivers/hwmon/sparx5-temp.c | 19 +----- drivers/i2c/busses/i2c-imx.c | 12 +--- drivers/iio/adc/ad7124.c | 15 +---- drivers/iio/adc/ad7768-1.c | 17 +---- drivers/iio/adc/ad9467.c | 17 +---- drivers/iio/adc/ingenic-adc.c | 15 +---- drivers/iio/adc/lpc18xx_adc.c | 18 +---- drivers/iio/adc/rockchip_saradc.c | 44 +----------- drivers/iio/adc/ti-ads131e08.c | 19 +----- drivers/iio/adc/xilinx-ams.c | 15 +---- drivers/iio/adc/xilinx-xadc-core.c | 18 +---- drivers/iio/frequency/adf4371.c | 17 +---- drivers/iio/frequency/admv1013.c | 15 +---- drivers/iio/frequency/adrf6780.c | 16 +---- drivers/iio/imu/adis16475.c | 15 +---- drivers/pwm/pwm-atmel.c | 16 +---- drivers/rtc/rtc-at91sam9.c | 22 ++---- drivers/rtc/rtc-jz4740.c | 21 +----- drivers/spi/spi-davinci.c | 11 +-- drivers/watchdog/cadence_wdt.c | 17 +---- drivers/watchdog/davinci_wdt.c | 18 +---- drivers/watchdog/imgpdc_wdt.c | 31 +-------- drivers/watchdog/imx2_wdt.c | 15 +---- drivers/watchdog/imx7ulp_wdt.c | 15 +---- drivers/watchdog/loongson1_wdt.c | 17 +---- drivers/watchdog/lpc18xx_wdt.c | 30 +-------- drivers/watchdog/meson_gxbb_wdt.c | 16 +---- drivers/watchdog/of_xilinx_wdt.c | 16 +---- drivers/watchdog/pic32-dmt.c | 15 +---- drivers/watchdog/pic32-wdt.c | 17 +---- drivers/watchdog/pnx4008_wdt.c | 15 +---- drivers/watchdog/qcom-wdt.c | 16 +---- drivers/watchdog/rtd119x_wdt.c | 16 +---- drivers/watchdog/st_lpc_wdt.c | 16 +---- drivers/watchdog/stm32_iwdg.c | 31 +-------- drivers/watchdog/visconti_wdt.c | 18 +---- include/linux/clk.h | 90 ++++++++++++++++++++++++- 48 files changed, 257 insertions(+), 851 deletions(-)
base-commit: 09688c0166e76ce2fb85e86b9d99be8b0084cdf9
2.35.1
dri-devel@lists.freedesktop.org