2020-07-16 14:03:26

by Lee Jones

Subject: [PATCH 05/30] iio: chemical: sgp30: Add description for sgp_read_cmd()'s 'duration_us'

Fixes the following W=1 kernel build warning(s):

drivers/iio/chemical/sgp30.c:236: warning: Function parameter or member 'duration_us' not described in 'sgp_read_cmd'

Cc: Andreas Brauchli <[email protected]>
Cc: Pascal Sachs <[email protected]>
Signed-off-by: Lee Jones <[email protected]>
---
drivers/iio/chemical/sgp30.c | 1 +
1 file changed, 1 insertion(+)

diff --git a/drivers/iio/chemical/sgp30.c b/drivers/iio/chemical/sgp30.c
index 403e8803471a9..82e407d48a0aa 100644
--- a/drivers/iio/chemical/sgp30.c
+++ b/drivers/iio/chemical/sgp30.c
@@ -227,6 +227,7 @@ static int sgp_verify_buffer(const struct sgp_data *data,
* @cmd: SGP Command to issue
* @buf: Raw data buffer to use
* @word_count: Num words to read, excluding CRC bytes
+ * @duration_us: Time to sleep in microseconds
*
* Return: 0 on success, negative error otherwise.
*/
--
2.25.1

2020-07-18 14:35:05

by Jonathan Cameron

Subject: Re: [PATCH 05/30] iio: chemical: sgp30: Add description for sgp_read_cmd()'s 'duration_us'

On Thu, 16 Jul 2020 14:59:03 +0100
Lee Jones <[email protected]> wrote:

> Fixes the following W=1 kernel build warning(s):
>
> drivers/iio/chemical/sgp30.c:236: warning: Function parameter or member 'duration_us' not described in 'sgp_read_cmd'
>
> Cc: Andreas Brauchli <[email protected]>
> Cc: Pascal Sachs <[email protected]>
> Signed-off-by: Lee Jones <[email protected]>

Perhaps we can do better on the wording.

> ---
> drivers/iio/chemical/sgp30.c | 1 +
> 1 file changed, 1 insertion(+)
>
> diff --git a/drivers/iio/chemical/sgp30.c b/drivers/iio/chemical/sgp30.c
> index 403e8803471a9..82e407d48a0aa 100644
> --- a/drivers/iio/chemical/sgp30.c
> +++ b/drivers/iio/chemical/sgp30.c
> @@ -227,6 +227,7 @@ static int sgp_verify_buffer(const struct sgp_data *data,
> * @cmd: SGP Command to issue
> * @buf: Raw data buffer to use
> * @word_count: Num words to read, excluding CRC bytes
> + * @duration_us: Time to sleep in microseconds

Time taken to sensor to take a reading and data to be ready.

Something like that maybe? I've not checked the datasheet but from
code that looks to be what this describes..

Jonathan

> *
> * Return: 0 on success, negative error otherwise.
> */

2020-09-17 18:37:51

by Jonathan Cameron

Subject: Re: [PATCH 05/30] iio: chemical: sgp30: Add description for sgp_read_cmd()'s 'duration_us'

On Sat, 18 Jul 2020 15:33:45 +0100
Jonathan Cameron <[email protected]> wrote:

> On Thu, 16 Jul 2020 14:59:03 +0100
> Lee Jones <[email protected]> wrote:
>
> > Fixes the following W=1 kernel build warning(s):
> >
> > drivers/iio/chemical/sgp30.c:236: warning: Function parameter or member 'duration_us' not described in 'sgp_read_cmd'
> >
> > Cc: Andreas Brauchli <[email protected]>
> > Cc: Pascal Sachs <[email protected]>
> > Signed-off-by: Lee Jones <[email protected]>
>
> Perhaps we can do better on the wording.
>
> > ---
> > drivers/iio/chemical/sgp30.c | 1 +
> > 1 file changed, 1 insertion(+)
> >
> > diff --git a/drivers/iio/chemical/sgp30.c b/drivers/iio/chemical/sgp30.c
> > index 403e8803471a9..82e407d48a0aa 100644
> > --- a/drivers/iio/chemical/sgp30.c
> > +++ b/drivers/iio/chemical/sgp30.c
> > @@ -227,6 +227,7 @@ static int sgp_verify_buffer(const struct sgp_data *data,
> > * @cmd: SGP Command to issue
> > * @buf: Raw data buffer to use
> > * @word_count: Num words to read, excluding CRC bytes
> > + * @duration_us: Time to sleep in microseconds
>
> Time taken to sensor to take a reading and data to be ready.
>
> Something like that maybe? I've not checked the datasheet but from
> code that looks to be what this describes..

Tweaked and applied

Thanks,

Jonathan

>
> Jonathan
>
> > *
> > * Return: 0 on success, negative error otherwise.
> > */
>