Re: [PATCH] iio: cros_ec: Add kernel-doc for cros_ec_sensors_read_lpc

[Jonathan Cameron]

On Wed, 13 Mar 2019 12:40:50 +0100
Enric Balletbo i Serra <enric.balletbo@xxxxxxxxxxxxx> wrote:

> From: Gwendal Grignou <gwendal@xxxxxxxxxxxx>
> 
> Document cros_ec_sensors_read_lpc, adding an additional note to explain
> that this is the safe function for reading the EC data.
> 
> Signed-off-by: Gwendal Grignou <gwendal@xxxxxxxxxxxx>
> Signed-off-by: Enric Balletbo i Serra <enric.balletbo@xxxxxxxxxxxxx>
Applied,

Thanks

Jonathan

> ---
> 
>  .../iio/common/cros_ec_sensors/cros_ec_sensors_core.c | 11 +++++++++++
>  1 file changed, 11 insertions(+)
> 
> diff --git a/drivers/iio/common/cros_ec_sensors/cros_ec_sensors_core.c b/drivers/iio/common/cros_ec_sensors/cros_ec_sensors_core.c
> index c770a2a809d7..eb7b0edd5da4 100644
> --- a/drivers/iio/common/cros_ec_sensors/cros_ec_sensors_core.c
> +++ b/drivers/iio/common/cros_ec_sensors/cros_ec_sensors_core.c
> @@ -268,6 +268,17 @@ static int cros_ec_sensors_read_data_unsafe(struct iio_dev *indio_dev,
>  	return 0;
>  }
>  
> +/**
> + * cros_ec_sensors_read_lpc() - read acceleration data from EC shared memory.
> + * @indio_dev: pointer to IIO device.
> + * @scan_mask: bitmap of the sensor indices to scan.
> + * @data: location to store data.
> + *
> + * Note: this is the safe function for reading the EC data. It guarantees
> + * that the data sampled was not modified by the EC while being read.
> + *
> + * Return: 0 on success, -errno on failure.
> + */
>  int cros_ec_sensors_read_lpc(struct iio_dev *indio_dev,
>  			     unsigned long scan_mask, s16 *data)
>  {