From: Jonathan Cameron <jic23@kernel.org>
To: Gwendal Grignou <gwendal@chromium.org>
Cc: briannorris@chromium.org, knaack.h@gmx.de, lars@metafoo.de,
pmeerw@pmeerw.net, lee.jones@linaro.org, bleung@chromium.org,
enric.balletbo@collabora.com, dianders@chromium.org,
groeck@chromium.org, fabien.lahoudere@collabora.com,
linux-kernel@vger.kernel.org, linux-iio@vger.kernel.org
Subject: Re: [PATCH v2 13/18] iio: cros_ec: Move function description to .c file
Date: Mon, 21 Oct 2019 17:33:01 +0100 [thread overview]
Message-ID: <20191021173301.3f7b3268@archlinux> (raw)
In-Reply-To: <20191021055403.67849-14-gwendal@chromium.org>
On Sun, 20 Oct 2019 22:53:58 -0700
Gwendal Grignou <gwendal@chromium.org> wrote:
> To prevent comment rot, move function description to
> cros_ec_sensors_core.c.
>
> Signed-off-by: Gwendal Grignou <gwendal@chromium.org>
Great thanks.
Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> ---
> New in v2.
>
> .../cros_ec_sensors/cros_ec_sensors_core.c | 69 ++++++++++++++++
> .../linux/iio/common/cros_ec_sensors_core.h | 80 -------------------
> 2 files changed, 69 insertions(+), 80 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 81a7f692de2f3..4acb8b7310d43 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
> @@ -83,6 +83,14 @@ static void get_default_min_max_freq(enum motionsensor_type type,
> }
> }
>
> +/**
> + * cros_ec_sensors_core_init() - basic initialization of the core structure
> + * @pdev: platform device created for the sensors
> + * @indio_dev: iio device structure of the device
> + * @physical_device: true if the device refers to a physical device
> + *
> + * Return: 0 on success, -errno on failure.
> + */
> int cros_ec_sensors_core_init(struct platform_device *pdev,
> struct iio_dev *indio_dev,
> bool physical_device)
> @@ -160,6 +168,16 @@ int cros_ec_sensors_core_init(struct platform_device *pdev,
> }
> EXPORT_SYMBOL_GPL(cros_ec_sensors_core_init);
>
> +/**
> + * cros_ec_motion_send_host_cmd() - send motion sense host command
> + * @st: pointer to state information for device
> + * @opt_length: optional length to reduce the response size, useful on the data
> + * path. Otherwise, the maximal allowed response size is used
> + *
> + * When called, the sub-command is assumed to be set in param->cmd.
> + *
> + * Return: 0 on success, -errno on failure.
> + */
> int cros_ec_motion_send_host_cmd(struct cros_ec_sensors_core_state *state,
> u16 opt_length)
> {
> @@ -422,6 +440,14 @@ int cros_ec_sensors_read_lpc(struct iio_dev *indio_dev,
> }
> EXPORT_SYMBOL_GPL(cros_ec_sensors_read_lpc);
>
> +/**
> + * cros_ec_sensors_read_cmd() - retrieve data using the EC command protocol
> + * @indio_dev: pointer to IIO device
> + * @scan_mask: bitmap of the sensor indices to scan
> + * @data: location to store data
> + *
> + * Return: 0 on success, -errno on failure.
> + */
> int cros_ec_sensors_read_cmd(struct iio_dev *indio_dev,
> unsigned long scan_mask, s16 *data)
> {
> @@ -446,6 +472,18 @@ int cros_ec_sensors_read_cmd(struct iio_dev *indio_dev,
> }
> EXPORT_SYMBOL_GPL(cros_ec_sensors_read_cmd);
>
> +/**
> + * cros_ec_sensors_capture() - the trigger handler function
> + * @irq: the interrupt number.
> + * @p: a pointer to the poll function.
> + *
> + * On a trigger event occurring, if the pollfunc is attached then this
> + * handler is called as a threaded interrupt (and hence may sleep). It
> + * is responsible for grabbing data from the device and pushing it into
> + * the associated buffer.
> + *
> + * Return: IRQ_HANDLED
> + */
> irqreturn_t cros_ec_sensors_capture(int irq, void *p)
> {
> struct iio_poll_func *pf = p;
> @@ -481,6 +519,16 @@ irqreturn_t cros_ec_sensors_capture(int irq, void *p)
> }
> EXPORT_SYMBOL_GPL(cros_ec_sensors_capture);
>
> +/**
> + * cros_ec_sensors_core_read() - function to request a value from the sensor
> + * @st: pointer to state information for device
> + * @chan: channel specification structure table
> + * @val: will contain one element making up the returned value
> + * @val2: will contain another element making up the returned value
> + * @mask: specifies which values to be requested
> + *
> + * Return: the type of value returned by the device
> + */
> int cros_ec_sensors_core_read(struct cros_ec_sensors_core_state *st,
> struct iio_chan_spec const *chan,
> int *val, int *val2, long mask)
> @@ -521,6 +569,17 @@ int cros_ec_sensors_core_read(struct cros_ec_sensors_core_state *st,
> }
> EXPORT_SYMBOL_GPL(cros_ec_sensors_core_read);
>
> +/**
> + * cros_ec_sensors_core_read_avail() - get available values
> + * @indio_dev: pointer to state information for device
> + * @chan: channel specification structure table
> + * @vals: list of available values
> + * @type: type of data returned
> + * @length: number of data returned in the array
> + * @mask: specifies which values to be requested
> + *
> + * Return: an error code, IIO_AVAIL_RANGE or IIO_AVAIL_LIST
> + */
> int cros_ec_sensors_core_read_avail(struct iio_dev *indio_dev,
> struct iio_chan_spec const *chan,
> const int **vals,
> @@ -542,6 +601,16 @@ int cros_ec_sensors_core_read_avail(struct iio_dev *indio_dev,
> }
> EXPORT_SYMBOL_GPL(cros_ec_sensors_core_read_avail);
>
> +/**
> + * cros_ec_sensors_core_write() - function to write a value to the sensor
> + * @st: pointer to state information for device
> + * @chan: channel specification structure table
> + * @val: first part of value to write
> + * @val2: second part of value to write
> + * @mask: specifies which values to write
> + *
> + * Return: the type of value returned by the device
> + */
> int cros_ec_sensors_core_write(struct cros_ec_sensors_core_state *st,
> struct iio_chan_spec const *chan,
> int val, int val2, long mask)
> diff --git a/include/linux/iio/common/cros_ec_sensors_core.h b/include/linux/iio/common/cros_ec_sensors_core.h
> index bb331e6356a9c..0af918978f975 100644
> --- a/include/linux/iio/common/cros_ec_sensors_core.h
> +++ b/include/linux/iio/common/cros_ec_sensors_core.h
> @@ -79,95 +79,25 @@ struct cros_ec_sensors_core_state {
> int frequencies[3];
> };
>
> -/**
> - * cros_ec_sensors_read_lpc() - retrieve 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
> - *
> - * 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);
>
> -/**
> - * cros_ec_sensors_read_cmd() - retrieve data using the EC command protocol
> - * @indio_dev: pointer to IIO device
> - * @scan_mask: bitmap of the sensor indices to scan
> - * @data: location to store data
> - *
> - * Return: 0 on success, -errno on failure.
> - */
> int cros_ec_sensors_read_cmd(struct iio_dev *indio_dev, unsigned long scan_mask,
> s16 *data);
>
> struct platform_device;
> -/**
> - * cros_ec_sensors_core_init() - basic initialization of the core structure
> - * @pdev: platform device created for the sensors
> - * @indio_dev: iio device structure of the device
> - * @physical_device: true if the device refers to a physical device
> - *
> - * Return: 0 on success, -errno on failure.
> - */
> int cros_ec_sensors_core_init(struct platform_device *pdev,
> struct iio_dev *indio_dev, bool physical_device);
>
> -/**
> - * cros_ec_sensors_capture() - the trigger handler function
> - * @irq: the interrupt number.
> - * @p: a pointer to the poll function.
> - *
> - * On a trigger event occurring, if the pollfunc is attached then this
> - * handler is called as a threaded interrupt (and hence may sleep). It
> - * is responsible for grabbing data from the device and pushing it into
> - * the associated buffer.
> - *
> - * Return: IRQ_HANDLED
> - */
> irqreturn_t cros_ec_sensors_capture(int irq, void *p);
>
> -/**
> - * cros_ec_motion_send_host_cmd() - send motion sense host command
> - * @st: pointer to state information for device
> - * @opt_length: optional length to reduce the response size, useful on the data
> - * path. Otherwise, the maximal allowed response size is used
> - *
> - * When called, the sub-command is assumed to be set in param->cmd.
> - *
> - * Return: 0 on success, -errno on failure.
> - */
> int cros_ec_motion_send_host_cmd(struct cros_ec_sensors_core_state *st,
> u16 opt_length);
>
> -/**
> - * cros_ec_sensors_core_read() - function to request a value from the sensor
> - * @st: pointer to state information for device
> - * @chan: channel specification structure table
> - * @val: will contain one element making up the returned value
> - * @val2: will contain another element making up the returned value
> - * @mask: specifies which values to be requested
> - *
> - * Return: the type of value returned by the device
> - */
> int cros_ec_sensors_core_read(struct cros_ec_sensors_core_state *st,
> struct iio_chan_spec const *chan,
> int *val, int *val2, long mask);
>
> -/**
> - * cros_ec_sensors_core_read_avail() - get available values
> - * @indio_dev: pointer to state information for device
> - * @chan: channel specification structure table
> - * @vals: list of available values
> - * @type: type of data returned
> - * @length: number of data returned in the array
> - * @mask: specifies which values to be requested
> - *
> - * Return: an error code, IIO_AVAIL_RANGE or IIO_AVAIL_LIST
> - */
> int cros_ec_sensors_core_read_avail(struct iio_dev *indio_dev,
> struct iio_chan_spec const *chan,
> const int **vals,
> @@ -175,16 +105,6 @@ int cros_ec_sensors_core_read_avail(struct iio_dev *indio_dev,
> int *length,
> long mask);
>
> -/**
> - * cros_ec_sensors_core_write() - function to write a value to the sensor
> - * @st: pointer to state information for device
> - * @chan: channel specification structure table
> - * @val: first part of value to write
> - * @val2: second part of value to write
> - * @mask: specifies which values to write
> - *
> - * Return: the type of value returned by the device
> - */
> int cros_ec_sensors_core_write(struct cros_ec_sensors_core_state *st,
> struct iio_chan_spec const *chan,
> int val, int val2, long mask);
next prev parent reply other threads:[~2019-10-21 16:33 UTC|newest]
Thread overview: 42+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-10-21 5:53 [PATCH v2 00/18] cros_ec: Add sensorhub driver and FIFO processing*** SUBJECT HERE Gwendal Grignou
2019-10-21 5:53 ` [PATCH v2 01/18] platform: chrome: Put docs with the code Gwendal Grignou
2019-10-21 15:31 ` Jonathan Cameron
2019-10-24 17:03 ` Enric Balletbo i Serra
2019-10-21 5:53 ` [PATCH v2 02/18] mfd: cros_ec: Add sensor_count and make check_features public Gwendal Grignou
2019-10-21 15:12 ` Enric Balletbo i Serra
2019-10-21 15:49 ` Jonathan Cameron
2019-11-01 9:00 ` Lee Jones
2019-10-21 5:53 ` [PATCH v2 03/18] platform: cros_ec: Add cros_ec_sensor_hub driver Gwendal Grignou
2019-10-21 15:59 ` Jonathan Cameron
2019-10-22 8:32 ` Enric Balletbo i Serra
2019-10-21 5:53 ` [PATCH v2 04/18] platform/mfd:iio: cros_ec: Register sensor through sensorhub Gwendal Grignou
2019-10-21 16:00 ` Jonathan Cameron
2019-10-22 9:39 ` Enric Balletbo i Serra
2019-10-21 5:53 ` [PATCH v2 05/18] platform: chrome: cros-ec: record event timestamp in the hard irq Gwendal Grignou
2019-10-22 10:03 ` Enric Balletbo i Serra
2019-10-21 5:53 ` [PATCH v2 06/18] platform: chrome: cros_ec: Do not attempt to register a non-positive IRQ number Gwendal Grignou
2019-10-22 10:05 ` Enric Balletbo i Serra
2019-10-21 5:53 ` [PATCH v2 07/18] platform: chrome: cros_ec: handle MKBP more events flag Gwendal Grignou
2019-10-21 16:07 ` Jonathan Cameron
2019-10-21 5:53 ` [PATCH v2 08/18] Revert "Input: cros_ec_keyb - add back missing mask for event_type" Gwendal Grignou
2019-10-21 5:53 ` [PATCH v2 09/18] Revert "Input: cros_ec_keyb: mask out extra flags in event_type" Gwendal Grignou
2019-10-21 5:53 ` [PATCH v2 10/18] platform: chrome: sensorhub: Add FIFO support Gwendal Grignou
2019-10-21 16:27 ` Jonathan Cameron
2019-10-21 22:09 ` Gwendal Grignou
2019-10-22 10:42 ` Jonathan Cameron
2019-10-21 5:53 ` [PATCH v2 11/18] platform: chrome: sensorhub: Add code to spread timestmap Gwendal Grignou
2019-10-21 5:53 ` [PATCH v2 12/18] platform: chrome: sensorhub: Add median filter Gwendal Grignou
2019-10-21 5:53 ` [PATCH v2 13/18] iio: cros_ec: Move function description to .c file Gwendal Grignou
2019-10-21 16:33 ` Jonathan Cameron [this message]
2019-10-21 5:53 ` [PATCH v2 14/18] iio: cros_ec: Register to cros_ec_sensorhub when EC supports FIFO Gwendal Grignou
2019-10-21 16:38 ` Jonathan Cameron
2019-10-21 5:54 ` [PATCH v2 15/18] iio: cros_ec: Remove pm function Gwendal Grignou
2019-10-21 16:39 ` Jonathan Cameron
2019-10-21 5:54 ` [PATCH v2 16/18] iio: cros_ec: Expose hwfifo_timeout Gwendal Grignou
2019-10-21 16:42 ` Jonathan Cameron
2019-10-21 5:54 ` [PATCH v2 17/18] iio: cros_ec: Report hwfifo_watermark_max Gwendal Grignou
2019-10-21 16:42 ` Jonathan Cameron
2019-10-21 5:54 ` [PATCH v2 18/18] iio: cros_ec: Use Hertz as unit for sampling frequency Gwendal Grignou
2019-10-21 16:45 ` Jonathan Cameron
2019-10-22 19:11 ` Gwendal Grignou
2019-10-21 15:29 ` [PATCH v2 00/18] cros_ec: Add sensorhub driver and FIFO processing*** SUBJECT HERE Jonathan Cameron
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20191021173301.3f7b3268@archlinux \
--to=jic23@kernel.org \
--cc=bleung@chromium.org \
--cc=briannorris@chromium.org \
--cc=dianders@chromium.org \
--cc=enric.balletbo@collabora.com \
--cc=fabien.lahoudere@collabora.com \
--cc=groeck@chromium.org \
--cc=gwendal@chromium.org \
--cc=knaack.h@gmx.de \
--cc=lars@metafoo.de \
--cc=lee.jones@linaro.org \
--cc=linux-iio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=pmeerw@pmeerw.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).