iio: frequency: adf4377: replace mutex_lock/unlock with guard and scoped_guard
Subsystems (3)
PATCH 1/1 iio: frequency: adf4377: replace mutex_lock/unlock with guard and scoped_guard
From: Eduardo Guedes <[email protected]>
Replace manual mutex_lock()/mutex_unlock() calls with guard(mutex) and scoped_guard(mutex) from cleanup.h.
Using guard(mutex) and scoped_guard(mutex) from cleanup.h allows the compiler to enforce lock release on every exit path, eliminating the error-prone manual lock/unlock pattern and the goto-based exit labels that existed in adf4377_get_freq() and adf4377_set_freq(). This reduces the chance of lock imbalance bugs.
--- drivers/iio/frequency/adf4377.c | 80 +++++++++++++++------------------ 1 file changed, 35 insertions(+), 45 deletions(-)
drivers/iio/frequency/adf4377.c +35 -45
@@ -7,6 +7,7 @@#include <linux/bitfield.h> #include <linux/bits.h> +#include <linux/cleanup.h> #include <linux/clk.h> #include <linux/clk-provider.h> #include <linux/clkdev.h>
@@ -518,14 +519,15 @@ static int adf4377_get_freq(struct adf4377_state *st, u64 *freq)u64 clkin_freq;int ret; -mutex_lock (&st->lock); +guard (mutex)(&st->lock); + ret =regmap_read (st->regmap,0x12 , &ref_div_factor);if (ret) - goto exit; +return ret; ret =regmap_bulk_read (st->regmap,0x10 , st->buf,sizeof (st->buf));if (ret) - goto exit; +return ret; clkin_freq =clk_get_rate (st->clkin); ref_div_factor =FIELD_GET (ADF4377_0012_R_DIV_MSK , ref_div_factor);
@@ -533,10 +535,8 @@ static int adf4377_get_freq(struct adf4377_state *st, u64 *freq) get_unaligned_le16(&st->buf)); *freq =div_u64 (clkin_freq, ref_div_factor) * n_int; -exit: -mutex_unlock (&st->lock); -return ret; +return 0 ; }static int adf4377_set_freq (struct adf4377_state *st,u64 freq)
@@ -545,26 +545,24 @@ static int adf4377_set_freq(struct adf4377_state *st, u64 freq)u64 f_vco;int ret; -mutex_lock (&st->lock); +guard (mutex)(&st->lock); -if (freq >ADF4377_MAX_CLKPN_FREQ || freq <ADF4377_MIN_CLKPN_FREQ ) { - ret = -EINVAL ; - goto exit; - } +if (freq >ADF4377_MAX_CLKPN_FREQ || freq <ADF4377_MIN_CLKPN_FREQ ) +return -EINVAL ; ret =regmap_update_bits (st->regmap,0x1C ,ADF4377_001C_EN_DNCLK_MSK |ADF4377_001C_EN_DRCLK_MSK ,FIELD_PREP (ADF4377_001C_EN_DNCLK_MSK ,1 ) |FIELD_PREP (ADF4377_001C_EN_DRCLK_MSK ,1 ));if (ret) - goto exit; +return ret; ret =regmap_update_bits (st->regmap,0x11 ,ADF4377_0011_EN_AUTOCAL_MSK |ADF4377_0011_DCLK_DIV2_MSK ,FIELD_PREP (ADF4377_0011_EN_AUTOCAL_MSK ,1 ) |FIELD_PREP (ADF4377_0011_DCLK_DIV2_MSK , st->dclk_div2));if (ret) - goto exit; +return ret; ret = regmap_update_bits(st->regmap, 0x2E, ADF4377_002E_EN_ADC_CNV_MSK | ADF4377_002E_EN_ADC_MSK |
@@ -574,56 +572,56 @@ static int adf4377_set_freq(struct adf4377_state *st, u64 freq)FIELD_PREP (ADF4377_002E_ADC_A_CONV_MSK , ADF4377_002E_ADC_A_CONV_VCO_CALIB));if (ret) - goto exit; +return ret; ret =regmap_update_bits (st->regmap,0x20 ,ADF4377_0020_EN_ADC_CLK_MSK ,FIELD_PREP (ADF4377_0020_EN_ADC_CLK_MSK ,1 ));if (ret) - goto exit; +return ret; ret =regmap_update_bits (st->regmap,0x2F ,ADF4377_002F_DCLK_DIV1_MSK ,FIELD_PREP (ADF4377_002F_DCLK_DIV1_MSK , st->dclk_div1));if (ret) - goto exit; +return ret; ret =regmap_update_bits (st->regmap,0x24 ,ADF4377_0024_DCLK_MODE_MSK ,FIELD_PREP (ADF4377_0024_DCLK_MODE_MSK , st->dclk_mode));if (ret) - goto exit; +return ret; ret =regmap_write (st->regmap,0x27 ,FIELD_PREP (ADF4377_0027_SYNTH_LOCK_TO_LSB_MSK , st->synth_lock_timeout));if (ret) - goto exit; +return ret; ret =regmap_update_bits (st->regmap,0x28 ,ADF4377_0028_SYNTH_LOCK_TO_MSB_MSK ,FIELD_PREP (ADF4377_0028_SYNTH_LOCK_TO_MSB_MSK , st->synth_lock_timeout >>8 ));if (ret) - goto exit; +return ret; ret =regmap_write (st->regmap,0x29 ,FIELD_PREP (ADF4377_0029_VCO_ALC_TO_LSB_MSK , st->vco_alc_timeout));if (ret) - goto exit; +return ret; ret =regmap_update_bits (st->regmap,0x2A ,ADF4377_002A_VCO_ALC_TO_MSB_MSK ,FIELD_PREP (ADF4377_002A_VCO_ALC_TO_MSB_MSK , st->vco_alc_timeout >>8 ));if (ret) - goto exit; +return ret; ret =regmap_write (st->regmap,0x26 ,FIELD_PREP (ADF4377_0026_VCO_BAND_DIV_MSK , st->vco_band_div));if (ret) - goto exit; +return ret; ret =regmap_write (st->regmap,0x2D ,FIELD_PREP (ADF4377_002D_ADC_CLK_DIV_MSK , st->adc_clk_div));if (ret) - goto exit; +return ret; st->clkout_div_sel =0 ;
@@ -641,24 +639,24 @@ static int adf4377_set_freq(struct adf4377_state *st, u64 freq)FIELD_PREP (ADF4377_0011_EN_RDBLR_MSK ,0 ) | FIELD_PREP(ADF4377_0011_N_INT_MSB_MSK, st->n_int >> 8));if (ret) - goto exit; +return ret; ret =regmap_update_bits (st->regmap,0x12 ,ADF4377_0012_R_DIV_MSK |ADF4377_0012_CLKOUT_DIV_MSK ,FIELD_PREP (ADF4377_0012_CLKOUT_DIV_MSK , st->clkout_div_sel) |FIELD_PREP (ADF4377_0012_R_DIV_MSK , st->ref_div_factor));if (ret) - goto exit; +return ret; ret =regmap_write (st->regmap,0x10 ,FIELD_PREP (ADF4377_0010_N_INT_LSB_MSK , st->n_int));if (ret) - goto exit; +return ret; ret =regmap_read_poll_timeout (st->regmap,0x49 , read_val, !(read_val & (ADF4377_0049_FSM_BUSY_MSK )),200 ,200 *100 );if (ret) - goto exit; +return ret;/* Disable EN_DNCLK, EN_DRCLK */ ret = regmap_update_bits(st->regmap, 0x1C, ADF4377_001C_EN_DNCLK_MSK |
@@ -666,26 +664,21 @@ static int adf4377_set_freq(struct adf4377_state *st, u64 freq)FIELD_PREP (ADF4377_001C_EN_DNCLK_MSK ,0 ) | FIELD_PREP(ADF4377_001C_EN_DRCLK_MSK, 0));if (ret) - goto exit; +return ret;/* Disable EN_ADC_CLK */ ret =regmap_update_bits (st->regmap,0x20 ,ADF4377_0020_EN_ADC_CLK_MSK ,FIELD_PREP (ADF4377_0020_EN_ADC_CLK_MSK ,0 ));if (ret) - goto exit; +return ret;/* Set output Amplitude */ - ret =regmap_update_bits (st->regmap,0x19 ,ADF4377_0019_CLKOUT2_OP_MSK | -ADF4377_0019_CLKOUT1_OP_MSK , -FIELD_PREP (ADF4377_0019_CLKOUT1_OP_MSK , -ADF4377_0019_CLKOUT_420MV ) | -FIELD_PREP (ADF4377_0019_CLKOUT2_OP_MSK , -ADF4377_0019_CLKOUT_420MV )); - -exit: -mutex_unlock (&st->lock); - -return ret; +return regmap_update_bits (st->regmap,0x19 ,ADF4377_0019_CLKOUT2_OP_MSK | +ADF4377_0019_CLKOUT1_OP_MSK , +FIELD_PREP (ADF4377_0019_CLKOUT1_OP_MSK , +ADF4377_0019_CLKOUT_420MV ) | +FIELD_PREP (ADF4377_0019_CLKOUT2_OP_MSK , +ADF4377_0019_CLKOUT_420MV )); }static void adf4377_gpio_init (struct adf4377_state *st)
@@ -919,13 +912,10 @@ static int adf4377_properties_parse(struct adf4377_state *st)static int adf4377_freq_change (struct notifier_block *nb,unsigned long action,void *data) { struct adf4377_state *st = container_of(nb, struct adf4377_state, nb); -int ret;if (action ==POST_RATE_CHANGE ) { -mutex_lock (&st->lock); - ret =notifier_from_errno (adf4377_init (st)); -mutex_unlock (&st->lock); -return ret; +guard (mutex)(&st->lock); +return notifier_from_errno (adf4377_init (st)); }return NOTIFY_OK ;
Signature · 1 line
2.39.5
Quoted 12 lines · On Wed, 6 May 2026 at 16:46, Educg550 <[email protected]> wrote:
From: Eduardo Guedes <[email protected]>
Replace manual mutex_lock()/mutex_unlock() calls with guard(mutex) and
scoped_guard(mutex)fromcleanup.h.Using guard(mutex) and
scoped_guard(mutex)fromcleanup.hallows the compiler to enforce lock release on every exit path, eliminating the error-prone manual lock/unlock pattern and the goto-based exit labels that existed inadf4377_get_freq()andadf4377_set_freq(). This reduces the chance of lock imbalance bugs.
Quoted 3 lines
Signed-off-by Eduardo Guedes <[email protected]>Co-developed-by Lucca Ciriac <[email protected]>Signed-off-by Lucca Ciriac <[email protected]>
Codewise LGTM, but you mention scoped_guard()() in the commit message, yet I don't see any uses of it in the patch (perhaps Jonathan can tweak that).
Signature · 3 lines
Kind regards CJD
Jonathan Cameron
maintainerQuoted 1 line · On Wed, 6 May 2026 11:43:59 -0300 Educg550 <[email protected]> wrote:
From: Eduardo Guedes <[email protected]>
Read submitting patches, particularly about how to send a v2. Should be [PATCH V2]
Quoted 5 lines
Replace manual mutex_lock()/mutex_unlock() calls with guard(mutex) and
scoped_guard(mutex)fromcleanup.h.Using guard(mutex) and
scoped_guard(mutex)fromcleanup.hallows the
Andy pointed out in another review earlier that it would be clearer to refer to guard(mutex)()
For scoped_guard() if it were used I'd use scoped_guard(mutex, ...) to refer to it.
Quoted 9 lines
compiler to enforce lock release on every exit path, eliminating the error-prone manual lock/unlock pattern and the goto-based exit labels that existed in
adf4377_get_freq()andadf4377_set_freq(). This reduces the chance of lock imbalance bugs.Signed-off-by Eduardo Guedes <[email protected]>Co-developed-by Lucca Ciriac <[email protected]>Signed-off-by Lucca Ciriac <[email protected]>---
There should be a change log here. Otherwise just one trivial request inline for v3.
Quoted 11 lines
drivers/iio/frequency/adf4377.c | 80 +++++++++++++++------------------ 1 file changed, 35 insertions(+), 45 deletions(-)drivers/iio/frequency/adf4377.c +0
-0static void adf4377_gpio_init (struct adf4377_state *st)@@ -919,13 +912,10 @@ static int adf4377_properties_parse(struct adf4377_state *st)static int adf4377_freq_change (struct notifier_block *nb,unsigned long action,void *data)
drivers/iio/frequency/adf4377.c static int adf4377_properties_parse(struct adf4377_state *st) · line 917
Quoted 10 lines
drivers/iio/frequency/adf4377.c +1
-5{ struct adf4377_state *st = container_of(nb, struct adf4377_state, nb); -int ret;if (action ==POST_RATE_CHANGE ) { -mutex_lock (&st->lock); - ret =notifier_from_errno (adf4377_init (st)); -mutex_unlock (&st->lock); -return ret; +guard (mutex)(&st->lock);
Slight preference for a blank line here as the we don't have the same need for closely associating lock and action as we did with the original code.
Quoted 4 lines
drivers/iio/frequency/adf4377.c +1
-0+return notifier_from_errno (adf4377_init (st)); }return NOTIFY_OK ;