diff options
| author | Gwendal Grignou <gwendal@chromium.org> | 2019-03-13 12:40:50 +0100 |
|---|---|---|
| committer | Jonathan Cameron <Jonathan.Cameron@huawei.com> | 2019-04-04 20:19:58 +0100 |
| commit | ad9cc622f10116046a88181e8c2f7d6a19af7fc0 (patch) | |
| tree | 4057591935f44b205429f3c33cc96ed9ff604619 | |
| parent | b921d928a31c78b083a34140204f2ad183bcc083 (diff) | |
| download | linux-ad9cc622f10116046a88181e8c2f7d6a19af7fc0.tar.gz linux-ad9cc622f10116046a88181e8c2f7d6a19af7fc0.tar.bz2 linux-ad9cc622f10116046a88181e8c2f7d6a19af7fc0.zip | |
iio: cros_ec: Add kernel-doc for cros_ec_sensors_read_lpc
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@chromium.org>
Signed-off-by: Enric Balletbo i Serra <enric.balletbo@collabora.com>
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
| -rw-r--r-- | drivers/iio/common/cros_ec_sensors/cros_ec_sensors_core.c | 11 |
1 files changed, 11 insertions, 0 deletions
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) { |