Commit d9452adc authored by Gwendal Grignou's avatar Gwendal Grignou Committed by Enric Balletbo i Serra
Browse files

iio: cros_ec: Move function description to .c file 



To prevent comment rot, move function description to
cros_ec_sensors_core.c.

Signed-off-by: default avatarGwendal Grignou <gwendal@chromium.org>
Acked-by: default avatarJonathan Cameron <Jonathan.Cameron@huawei.com>
Signed-off-by: default avatarEnric Balletbo i Serra <enric.balletbo@collabora.com>
parent 93fe48a5

drivers/iio/common/cros_ec_sensors/cros_ec_sensors_core.c

+69 −0
Original line number Diff line number Diff line
@@ -82,6 +82,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)
@@ -159,6 +167,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

 * @state:		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)

{
@@ -421,6 +439,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)

{
@@ -445,6 +471,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;
@@ -480,6 +518,16 @@ done: 
}

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)
@@ -520,6 +568,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,
@@ -541,6 +600,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)

include/linux/iio/common/cros_ec_sensors_core.h

+0 −80
Original line number Diff line number Diff line
@@ -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);

CRA Git | Maintained and supported by SUSTech CRA and CCSE