[PATCH] staging: iio/meter: add name to function definition arguments

[PATCH] staging: iio/meter: add name to function definition arguments

[rodrigosiqueira]

This patch fixes the checkpatch.pl warning:

drivers/staging/iio/meter/ade7854.h:157: WARNING: function definition
argument 'struct device *' should also have an identifier name...

Signed-off-by: Rodrigo Siqueira <rodrigosiqueiramelo@gmail.com>
---
 drivers/staging/iio/meter/ade7854.h | 28 ++++++++++++++--------------
 1 file changed, 14 insertions(+), 14 deletions(-)

diff --git a/drivers/staging/iio/meter/ade7854.h b/drivers/staging/iio/meter/ade7854.h
index c27247a7891a..2362a4a51ce3 100644
--- a/drivers/staging/iio/meter/ade7854.h
+++ b/drivers/staging/iio/meter/ade7854.h
@@ -152,20 +152,20 @@
  * @rx:			receive buffer
  **/
 struct ade7854_state {
-	struct spi_device	*spi;
-	struct i2c_client	*i2c;
-	int			(*read_reg_8)(struct device *, u16, u8 *);
-	int			(*read_reg_16)(struct device *, u16, u16 *);
-	int			(*read_reg_24)(struct device *, u16, u32 *);
-	int			(*read_reg_32)(struct device *, u16, u32 *);
-	int			(*write_reg_8)(struct device *, u16, u8);
-	int			(*write_reg_16)(struct device *, u16, u16);
-	int			(*write_reg_24)(struct device *, u16, u32);
-	int			(*write_reg_32)(struct device *, u16, u32);
-	int			irq;
-	struct mutex		buf_lock;
-	u8			tx[ADE7854_MAX_TX] ____cacheline_aligned;
-	u8			rx[ADE7854_MAX_RX];
+	struct spi_device *spi;
+	struct i2c_client *i2c;
+	int (*read_reg_8)(struct device *dev, u16 reg_address, u8 *val);
+	int (*read_reg_16)(struct device *dev, u16 reg_address, u16 *val);
+	int (*read_reg_24)(struct device *dev, u16 reg_address, u32 *val);
+	int (*read_reg_32)(struct device *dev, u16 reg_address, u32 *val);
+	int (*write_reg_8)(struct device *dev, u16 reg_address, u8 value);
+	int (*write_reg_16)(struct device *dev, u16 reg_address, u16 value);
+	int (*write_reg_24)(struct device *dev, u16 reg_address, u32 value);
+	int (*write_reg_32)(struct device *dev, u16 reg_address, u32 value);
+	int irq;
+	struct mutex buf_lock;
+	u8 tx[ADE7854_MAX_TX] ____cacheline_aligned;
+	u8 rx[ADE7854_MAX_RX];
 
 };
 
-- 
2.16.1

_______________________________________________
devel mailing list
devel@linuxdriverproject.org
http://driverdev.linuxdriverproject.org/mailman/listinfo/driverdev-devel

Re: [PATCH] staging: iio/meter: add name to function definition arguments

[Daniel Baluta]

Hi Rodrigo,

I think this is a nice finding. One comment inline:

On Vi, 2018-02-16 at 10:50 -0200, rodrigosiqueira wrote:
> This patch fixes the checkpatch.pl warning:
> 
> drivers/staging/iio/meter/ade7854.h:157: WARNING: function definition
> argument 'struct device *' should also have an identifier name...
> 
> +	int (*read_reg_32)(struct device *dev, u16 reg_address, u32 *val);
> +	int (*write_reg_8)(struct device *dev, u16 reg_address, u8 value);


Any particular reason for using val vs value? I get that one is a pointer
and another a plain type, but I think the name should be the same.

thanks,
Daniel.

Re: [PATCH] staging: iio/meter: add name to function definition arguments

[Rodrigo Siqueira]

Hi Daniel

> Hi Rodrigo,
> 
> I think this is a nice finding. One comment inline:
> 
> On Vi, 2018-02-16 at 10:50 -0200, rodrigosiqueira wrote:
> > This patch fixes the checkpatch.pl warning:
> > 
> > drivers/staging/iio/meter/ade7854.h:157: WARNING: function definition
> > argument 'struct device *' should also have an identifier name...
> > 
> > +	int (*read_reg_32)(struct device *dev, u16 reg_address, u32 *val);
> > +	int (*write_reg_8)(struct device *dev, u16 reg_address, u8 value);
> 
> 
> Any particular reason for using val vs value? I get that one is a pointer
> and another a plain type, but I think the name should be the same.

Before I selected the name, I figure out that read_reg_* and write_reg_*
was assigned inside the iio/meter/ade7754-(i2c|spi).c files by function
like ade7754_*_read_reg_* and ade7754_*_write_reg_* .

I considered to use 'value' name for both functions parameters, however,
I noticed that function ade7754_*_write_reg_* adopted the name 'value'
for the last argument and ade7754_*_read_reg_* named the last argument
as 'val'. So, for consistency sake between the header file and the c
code, I decided to use the same parameter name patterns.


> thanks,
> Daniel.
>

Thanks 

Re: [PATCH] staging: iio/meter: add name to function definition arguments

[Jonathan Cameron]

On Fri, 16 Feb 2018 11:16:58 -0200
Rodrigo Siqueira <rodrigosiqueiramelo@gmail.com> wrote:

> Hi Daniel
> 
> > Hi Rodrigo,
> > 
> > I think this is a nice finding. One comment inline:
> > 
> > On Vi, 2018-02-16 at 10:50 -0200, rodrigosiqueira wrote:  
> > > This patch fixes the checkpatch.pl warning:
> > > 
> > > drivers/staging/iio/meter/ade7854.h:157: WARNING: function definition
> > > argument 'struct device *' should also have an identifier name...
> > > 
> > > +	int (*read_reg_32)(struct device *dev, u16 reg_address, u32 *val);
> > > +	int (*write_reg_8)(struct device *dev, u16 reg_address, u8 value);  
> > 
> > 
> > Any particular reason for using val vs value? I get that one is a pointer
> > and another a plain type, but I think the name should be the same.  
> 
> Before I selected the name, I figure out that read_reg_* and write_reg_*
> was assigned inside the iio/meter/ade7754-(i2c|spi).c files by function
> like ade7754_*_read_reg_* and ade7754_*_write_reg_* .
> 
> I considered to use 'value' name for both functions parameters, however,
> I noticed that function ade7754_*_write_reg_* adopted the name 'value'
> for the last argument and ade7754_*_read_reg_* named the last argument
> as 'val'. So, for consistency sake between the header file and the c
> code, I decided to use the same parameter name patterns.
> 
Hohum. It isn't even that consistent ;)

ade7754_write_reg_8 uses val and ade7754_write_reg_16 uses value.

I would suggest another patch to make them all val.

Thanks,

Jonathan
> 
> > thanks,
> > Daniel.
> >  
> 
> Thanks 

Re: [PATCH] staging: iio/meter: add name to function definition arguments

[Rodrigo Siqueira]

Hi Jonathan,

> On Fri, 16 Feb 2018 11:16:58 -0200
> Rodrigo Siqueira <rodrigosiqueiramelo@gmail.com> wrote:
> 
> > Hi Daniel
> > 
> > > Hi Rodrigo,
> > > 
> > > I think this is a nice finding. One comment inline:
> > > 
> > > On Vi, 2018-02-16 at 10:50 -0200, rodrigosiqueira wrote:  
> > > > This patch fixes the checkpatch.pl warning:
> > > > 
> > > > drivers/staging/iio/meter/ade7854.h:157: WARNING: function definition
> > > > argument 'struct device *' should also have an identifier name...
> > > > 
> > > > +	int (*read_reg_32)(struct device *dev, u16 reg_address, u32 *val);
> > > > +	int (*write_reg_8)(struct device *dev, u16 reg_address, u8 value);  
> > > 
> > > 
> > > Any particular reason for using val vs value? I get that one is a pointer
> > > and another a plain type, but I think the name should be the same.  
> > 
> > Before I selected the name, I figure out that read_reg_* and write_reg_*
> > was assigned inside the iio/meter/ade7754-(i2c|spi).c files by function
> > like ade7754_*_read_reg_* and ade7754_*_write_reg_* .
> > 
> > I considered to use 'value' name for both functions parameters, however,
> > I noticed that function ade7754_*_write_reg_* adopted the name 'value'
> > for the last argument and ade7754_*_read_reg_* named the last argument
> > as 'val'. So, for consistency sake between the header file and the c
> > code, I decided to use the same parameter name patterns.
> > 
> Hohum. It isn't even that consistent ;)
> 
> ade7754_write_reg_8 uses val and ade7754_write_reg_16 uses value.
> 
> I would suggest another patch to make them all val.

Thanks for the review. I will send another patch as you recommended.

Rodrigo Siqueira
 
> Thanks,
> 
> Jonathan
> > 
> > > thanks,
> > > Daniel.
> > >  
> > 
> > Thanks 
> 
_______________________________________________
devel mailing list
devel@linuxdriverproject.org
http://driverdev.linuxdriverproject.org/mailman/listinfo/driverdev-devel