[linux-block.git] / include / linux / hid-sensor-hub.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * HID Sensors Driver
 * Copyright (c) 2012, Intel Corporation.
 */
#ifndef _HID_SENSORS_HUB_H
#define _HID_SENSORS_HUB_H

#include <linux/hid.h>
#include <linux/hid-sensor-ids.h>
#include <linux/iio/iio.h>
#include <linux/iio/trigger.h>

/**
 * struct hid_sensor_hub_attribute_info - Attribute info
 * @usage_id:		Parent usage id of a physical device.
 * @attrib_id:		Attribute id for this attribute.
 * @report_id:		Report id in which this information resides.
 * @index:		Field index in the report.
 * @units:		Measurment unit for this attribute.
 * @unit_expo:		Exponent used in the data.
 * @size:		Size in bytes for data size.
 * @logical_minimum:	Logical minimum value for this attribute.
 * @logical_maximum:	Logical maximum value for this attribute.
 */
struct hid_sensor_hub_attribute_info {
	u32 usage_id;
	u32 attrib_id;
	s32 report_id;
	s32 index;
	s32 units;
	s32 unit_expo;
	s32 size;
	s32 logical_minimum;
	s32 logical_maximum;
};

/**
 * struct sensor_hub_pending - Synchronous read pending information
 * @status:		Pending status true/false.
 * @ready:		Completion synchronization data.
 * @usage_id:		Usage id for physical device, E.g. Gyro usage id.
 * @attr_usage_id:	Usage Id of a field, E.g. X-AXIS for a gyro.
 * @raw_size:		Response size for a read request.
 * @raw_data:		Place holder for received response.
 */
struct sensor_hub_pending {
	bool status;
	struct completion ready;
	u32 usage_id;
	u32 attr_usage_id;
	int raw_size;
	u8  *raw_data;
};

/**
 * struct hid_sensor_hub_device - Stores the hub instance data
 * @hdev:		Stores the hid instance.
 * @vendor_id:		Vendor id of hub device.
 * @product_id:		Product id of hub device.
 * @usage:		Usage id for this hub device instance.
 * @start_collection_index: Starting index for a phy type collection
 * @end_collection_index: Last index for a phy type collection
 * @mutex_ptr:		synchronizing mutex pointer.
 * @pending:		Holds information of pending sync read request.
 */
struct hid_sensor_hub_device {
	struct hid_device *hdev;
	u32 vendor_id;
	u32 product_id;
	u32 usage;
	int start_collection_index;
	int end_collection_index;
	struct mutex *mutex_ptr;
	struct sensor_hub_pending pending;
};

/**
 * struct hid_sensor_hub_callbacks - Client callback functions
 * @pdev:		Platform device instance of the client driver.
 * @suspend:		Suspend callback.
 * @resume:		Resume callback.
 * @capture_sample:	Callback to get a sample.
 * @send_event:		Send notification to indicate all samples are
 *			captured, process and send event
 */
struct hid_sensor_hub_callbacks {
	struct platform_device *pdev;
	int (*suspend)(struct hid_sensor_hub_device *hsdev, void *priv);
	int (*resume)(struct hid_sensor_hub_device *hsdev, void *priv);
	int (*capture_sample)(struct hid_sensor_hub_device *hsdev,
			u32 usage_id, size_t raw_len, char *raw_data,
			void *priv);
	int (*send_event)(struct hid_sensor_hub_device *hsdev, u32 usage_id,
			 void *priv);
};

/**
* sensor_hub_device_open() - Open hub device
* @hsdev:	Hub device instance.
*
* Used to open hid device for sensor hub.
*/
int sensor_hub_device_open(struct hid_sensor_hub_device *hsdev);

/**
* sensor_hub_device_clode() - Close hub device
* @hsdev:	Hub device instance.
*
* Used to clode hid device for sensor hub.
*/
void sensor_hub_device_close(struct hid_sensor_hub_device *hsdev);

/* Registration functions */

/**
* sensor_hub_register_callback() - Register client callbacks
* @hsdev:	Hub device instance.
* @usage_id:	Usage id of the client (E.g. 0x200076 for Gyro).
* @usage_callback: Callback function storage
*
* Used to register callbacks by client processing drivers. Sensor
* hub core driver will call these callbacks to offload processing
* of data streams and notifications.
*/
int sensor_hub_register_callback(struct hid_sensor_hub_device *hsdev,
			u32 usage_id,
			struct hid_sensor_hub_callbacks *usage_callback);

/**
* sensor_hub_remove_callback() - Remove client callbacks
* @hsdev:	Hub device instance.
* @usage_id:	Usage id of the client (E.g. 0x200076 for Gyro).
*
* If there is a callback registred, this call will remove that
* callbacks, so that it will stop data and event notifications.
*/
int sensor_hub_remove_callback(struct hid_sensor_hub_device *hsdev,
			u32 usage_id);


/* Hid sensor hub core interfaces */

/**
* sensor_hub_input_get_attribute_info() - Get an attribute information
* @hsdev:	Hub device instance.
* @type:	Type of this attribute, input/output/feature
* @usage_id:	Attribute usage id of parent physical device as per spec
* @attr_usage_id:	Attribute usage id as per spec
* @info:	return information about attribute after parsing report
*
* Parses report and returns the attribute information such as report id,
* field index, units and exponent etc.
*/
int sensor_hub_input_get_attribute_info(struct hid_sensor_hub_device *hsdev,
			u8 type,
			u32 usage_id, u32 attr_usage_id,
			struct hid_sensor_hub_attribute_info *info);

/**
* sensor_hub_input_attr_get_raw_value() - Synchronous read request
* @hsdev:	Hub device instance.
* @usage_id:	Attribute usage id of parent physical device as per spec
* @attr_usage_id:	Attribute usage id as per spec
* @report_id:	Report id to look for
* @flag:      Synchronous or asynchronous read
* @is_signed:   If true then fields < 32 bits will be sign-extended
*
* Issues a synchronous or asynchronous read request for an input attribute.
* Return: data up to 32 bits.
*/

enum sensor_hub_read_flags {
	SENSOR_HUB_SYNC,
	SENSOR_HUB_ASYNC,
};

int sensor_hub_input_attr_get_raw_value(struct hid_sensor_hub_device *hsdev,
 					u32 usage_id,
 					u32 attr_usage_id, u32 report_id,
					enum sensor_hub_read_flags flag,
					bool is_signed
);

/**
* sensor_hub_set_feature() - Feature set request
* @hsdev:	Hub device instance.
* @report_id:	Report id to look for
* @field_index:	Field index inside a report
* @buffer_size: size of the buffer
* @buffer:	buffer to use in the feature set
*
* Used to set a field in feature report. For example this can set polling
* interval, sensitivity, activate/deactivate state.
*/
int sensor_hub_set_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
			   u32 field_index, int buffer_size, void *buffer);

/**
* sensor_hub_get_feature() - Feature get request
* @hsdev:	Hub device instance.
* @report_id:	Report id to look for
* @field_index:	Field index inside a report
* @buffer_size:	size of the buffer
* @buffer:	buffer to copy output
*
* Used to get a field in feature report. For example this can get polling
* interval, sensitivity, activate/deactivate state.
* Return: On success, it returns the number of bytes copied to buffer.
* On failure, it returns value < 0.
*/
int sensor_hub_get_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
			   u32 field_index, int buffer_size, void *buffer);

/* hid-sensor-attributes */

/* Common hid sensor iio structure */
struct hid_sensor_common {
	struct hid_sensor_hub_device *hsdev;
	struct platform_device *pdev;
	unsigned usage_id;
	atomic_t data_ready;
	atomic_t user_requested_state;
	atomic_t runtime_pm_enable;
	int poll_interval;
	int raw_hystersis;
	int latency_ms;
	struct iio_trigger *trigger;
	int timestamp_ns_scale;
	struct hid_sensor_hub_attribute_info poll;
	struct hid_sensor_hub_attribute_info report_state;
	struct hid_sensor_hub_attribute_info power_state;
	struct hid_sensor_hub_attribute_info sensitivity;
	struct hid_sensor_hub_attribute_info sensitivity_rel;
	struct hid_sensor_hub_attribute_info report_latency;
	struct work_struct work;
};

/* Convert from hid unit expo to regular exponent */
static inline int hid_sensor_convert_exponent(int unit_expo)
{
	if (unit_expo < 0x08)
		return unit_expo;
	else if (unit_expo <= 0x0f)
		return -(0x0f-unit_expo+1);
	else
		return 0;
}

int hid_sensor_parse_common_attributes(struct hid_sensor_hub_device *hsdev,
					u32 usage_id,
					struct hid_sensor_common *st,
					const u32 *sensitivity_addresses,
					u32 sensitivity_addresses_len);
int hid_sensor_write_raw_hyst_value(struct hid_sensor_common *st,
					int val1, int val2);
int hid_sensor_write_raw_hyst_rel_value(struct hid_sensor_common *st, int val1,
					int val2);
int hid_sensor_read_raw_hyst_value(struct hid_sensor_common *st,
					int *val1, int *val2);
int hid_sensor_read_raw_hyst_rel_value(struct hid_sensor_common *st,
				       int *val1, int *val2);
int hid_sensor_write_samp_freq_value(struct hid_sensor_common *st,
					int val1, int val2);
int hid_sensor_read_samp_freq_value(struct hid_sensor_common *st,
					int *val1, int *val2);

int hid_sensor_get_usage_index(struct hid_sensor_hub_device *hsdev,
				u32 report_id, int field_index, u32 usage_id);

int hid_sensor_format_scale(u32 usage_id,
			    struct hid_sensor_hub_attribute_info *attr_info,
			    int *val0, int *val1);

s32 hid_sensor_read_poll_value(struct hid_sensor_common *st);

int64_t hid_sensor_convert_timestamp(struct hid_sensor_common *st,
				     int64_t raw_value);
bool hid_sensor_batch_mode_supported(struct hid_sensor_common *st);
int hid_sensor_set_report_latency(struct hid_sensor_common *st, int latency);
int hid_sensor_get_report_latency(struct hid_sensor_common *st);

#endif
Commit	Line	Data
a61127c2	1	/* SPDX-License-Identifier: GPL-2.0-only */
401ca24f	2	/*
	3	* HID Sensors Driver
	4	* Copyright (c) 2012, Intel Corporation.
401ca24f	5	*/
	6	#ifndef _HID_SENSORS_HUB_H
	7	#define _HID_SENSORS_HUB_H
	8
	9	#include <linux/hid.h>
	10	#include <linux/hid-sensor-ids.h>
ec7f68e0 SP	11	#include <linux/iio/iio.h>
ec7f68e0 SP	12	#include <linux/iio/trigger.h>
401ca24f	13
	14	/**
	15	* struct hid_sensor_hub_attribute_info - Attribute info
	16	* @usage_id: Parent usage id of a physical device.
	17	* @attrib_id: Attribute id for this attribute.
	18	* @report_id: Report id in which this information resides.
	19	* @index: Field index in the report.
	20	* @units: Measurment unit for this attribute.
	21	* @unit_expo: Exponent used in the data.
	22	* @size: Size in bytes for data size.
f9d904ac SP	23	* @logical_minimum: Logical minimum value for this attribute.
f9d904ac SP	24	* @logical_maximum: Logical maximum value for this attribute.
401ca24f	25	*/
	26	struct hid_sensor_hub_attribute_info {
	27	u32 usage_id;
	28	u32 attrib_id;
	29	s32 report_id;
	30	s32 index;
	31	s32 units;
	32	s32 unit_expo;
	33	s32 size;
9f740ffa SP	34	s32 logical_minimum;
9f740ffa SP	35	s32 logical_maximum;
401ca24f	36	};
401ca24f	37
e651a1da SP	38	/**
	39	* struct sensor_hub_pending - Synchronous read pending information
	40	* @status: Pending status true/false.
	41	* @ready: Completion synchronization data.
	42	* @usage_id: Usage id for physical device, E.g. Gyro usage id.
	43	* @attr_usage_id: Usage Id of a field, E.g. X-AXIS for a gyro.
	44	* @raw_size: Response size for a read request.
	45	* @raw_data: Place holder for received response.
	46	*/
	47	struct sensor_hub_pending {
	48	bool status;
	49	struct completion ready;
	50	u32 usage_id;
	51	u32 attr_usage_id;
	52	int raw_size;
	53	u8 *raw_data;
	54	};
	55
401ca24f	56	/**
	57	* struct hid_sensor_hub_device - Stores the hub instance data
	58	* @hdev: Stores the hid instance.
	59	* @vendor_id: Vendor id of hub device.
	60	* @product_id: Product id of hub device.
e651a1da	61	* @usage: Usage id for this hub device instance.
ca2ed12f SP	62	* @start_collection_index: Starting index for a phy type collection
ca2ed12f SP	63	* @end_collection_index: Last index for a phy type collection
2d94e522	64	* @mutex_ptr: synchronizing mutex pointer.
e651a1da	65	* @pending: Holds information of pending sync read request.
401ca24f	66	*/
	67	struct hid_sensor_hub_device {
	68	struct hid_device *hdev;
	69	u32 vendor_id;
	70	u32 product_id;
e651a1da	71	u32 usage;
ca2ed12f SP	72	int start_collection_index;
ca2ed12f SP	73	int end_collection_index;
2d94e522	74	struct mutex *mutex_ptr;
e651a1da	75	struct sensor_hub_pending pending;
401ca24f	76	};
	77
	78	/**
	79	* struct hid_sensor_hub_callbacks - Client callback functions
	80	* @pdev: Platform device instance of the client driver.
	81	* @suspend: Suspend callback.
	82	* @resume: Resume callback.
	83	* @capture_sample: Callback to get a sample.
	84	* @send_event: Send notification to indicate all samples are
	85	* captured, process and send event
	86	*/
	87	struct hid_sensor_hub_callbacks {
	88	struct platform_device *pdev;
	89	int (suspend)(struct hid_sensor_hub_device hsdev, void *priv);
	90	int (resume)(struct hid_sensor_hub_device hsdev, void *priv);
	91	int (capture_sample)(struct hid_sensor_hub_device hsdev,
	92	u32 usage_id, size_t raw_len, char *raw_data,
	93	void *priv);
	94	int (send_event)(struct hid_sensor_hub_device hsdev, u32 usage_id,
	95	void *priv);
	96	};
	97
1df3a401 SP	98	/**
	99	* sensor_hub_device_open() - Open hub device
	100	* @hsdev: Hub device instance.
	101	*
	102	* Used to open hid device for sensor hub.
	103	*/
	104	int sensor_hub_device_open(struct hid_sensor_hub_device *hsdev);
	105
	106	/**
	107	* sensor_hub_device_clode() - Close hub device
	108	* @hsdev: Hub device instance.
	109	*
	110	* Used to clode hid device for sensor hub.
	111	*/
	112	void sensor_hub_device_close(struct hid_sensor_hub_device *hsdev);
	113
401ca24f	114	/* Registration functions */
	115
	116	/**
	117	* sensor_hub_register_callback() - Register client callbacks
	118	* @hsdev: Hub device instance.
	119	* @usage_id: Usage id of the client (E.g. 0x200076 for Gyro).
	120	* @usage_callback: Callback function storage
	121	*
	122	* Used to register callbacks by client processing drivers. Sensor
	123	* hub core driver will call these callbacks to offload processing
	124	* of data streams and notifications.
	125	*/
	126	int sensor_hub_register_callback(struct hid_sensor_hub_device *hsdev,
	127	u32 usage_id,
	128	struct hid_sensor_hub_callbacks *usage_callback);
	129
	130	/**
	131	* sensor_hub_remove_callback() - Remove client callbacks
	132	* @hsdev: Hub device instance.
	133	* @usage_id: Usage id of the client (E.g. 0x200076 for Gyro).
	134	*
	135	* If there is a callback registred, this call will remove that
	136	* callbacks, so that it will stop data and event notifications.
	137	*/
	138	int sensor_hub_remove_callback(struct hid_sensor_hub_device *hsdev,
	139	u32 usage_id);
	140
	141
	142	/* Hid sensor hub core interfaces */
	143
	144	/**
	145	* sensor_hub_input_get_attribute_info() - Get an attribute information
	146	* @hsdev: Hub device instance.
	147	* @type: Type of this attribute, input/output/feature
	148	* @usage_id: Attribute usage id of parent physical device as per spec
	149	* @attr_usage_id: Attribute usage id as per spec
	150	* @info: return information about attribute after parsing report
	151	*
	152	* Parses report and returns the attribute information such as report id,
ceecd1bf	153	* field index, units and exponent etc.
401ca24f	154	*/
	155	int sensor_hub_input_get_attribute_info(struct hid_sensor_hub_device *hsdev,
	156	u8 type,
	157	u32 usage_id, u32 attr_usage_id,
	158	struct hid_sensor_hub_attribute_info *info);
	159
	160	/**
	161	* sensor_hub_input_attr_get_raw_value() - Synchronous read request
f9d904ac	162	* @hsdev: Hub device instance.
401ca24f	163	* @usage_id: Attribute usage id of parent physical device as per spec
	164	* @attr_usage_id: Attribute usage id as per spec
	165	* @report_id: Report id to look for
b3f4737d	166	* @flag: Synchronous or asynchronous read
0145b505	167	* @is_signed: If true then fields < 32 bits will be sign-extended
401ca24f	168	*
b3f4737d	169	* Issues a synchronous or asynchronous read request for an input attribute.
ceecd1bf	170	* Return: data up to 32 bits.
401ca24f	171	*/
401ca24f	172
b3f4737d SP	173	enum sensor_hub_read_flags {
	174	SENSOR_HUB_SYNC,
	175	SENSOR_HUB_ASYNC,
	176	};
	177
401ca24f	178	int sensor_hub_input_attr_get_raw_value(struct hid_sensor_hub_device *hsdev,
b3f4737d SP	179	u32 usage_id,
b3f4737d SP	180	u32 attr_usage_id, u32 report_id,
0145b505 HG	181	enum sensor_hub_read_flags flag,
0145b505 HG	182	bool is_signed
b3f4737d SP	183	);
b3f4737d SP	184
401ca24f	185	/**
401ca24f	186	* sensor_hub_set_feature() - Feature set request
f9d904ac	187	* @hsdev: Hub device instance.
401ca24f	188	* @report_id: Report id to look for
401ca24f	189	* @field_index: Field index inside a report
3950e033 SP	190	* @buffer_size: size of the buffer
3950e033 SP	191	* @buffer: buffer to use in the feature set
401ca24f	192	*
	193	* Used to set a field in feature report. For example this can set polling
	194	* interval, sensitivity, activate/deactivate state.
	195	*/
	196	int sensor_hub_set_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
3950e033	197	u32 field_index, int buffer_size, void *buffer);
401ca24f	198
	199	/**
	200	* sensor_hub_get_feature() - Feature get request
f9d904ac	201	* @hsdev: Hub device instance.
401ca24f	202	* @report_id: Report id to look for
401ca24f	203	* @field_index: Field index inside a report
6adc83fc SP	204	* @buffer_size: size of the buffer
6adc83fc SP	205	* @buffer: buffer to copy output
401ca24f	206	*
401ca24f	207	* Used to get a field in feature report. For example this can get polling
ceecd1bf RD	208	* interval, sensitivity, activate/deactivate state.
	209	* Return: On success, it returns the number of bytes copied to buffer.
	210	* On failure, it returns value < 0.
401ca24f	211	*/
401ca24f	212	int sensor_hub_get_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
6adc83fc	213	u32 field_index, int buffer_size, void *buffer);
2974cdf2 AH	214
	215	/* hid-sensor-attributes */
	216
	217	/* Common hid sensor iio structure */
e07c6d17	218	struct hid_sensor_common {
2974cdf2 AH	219	struct hid_sensor_hub_device *hsdev;
	220	struct platform_device *pdev;
	221	unsigned usage_id;
56ff6be6	222	atomic_t data_ready;
1e25aa96	223	atomic_t user_requested_state;
ad7532ce	224	atomic_t runtime_pm_enable;
5d9854ea SP	225	int poll_interval;
5d9854ea SP	226	int raw_hystersis;
138bc796	227	int latency_ms;
ec7f68e0	228	struct iio_trigger *trigger;
a96cd0f9	229	int timestamp_ns_scale;
2974cdf2 AH	230	struct hid_sensor_hub_attribute_info poll;
	231	struct hid_sensor_hub_attribute_info report_state;
	232	struct hid_sensor_hub_attribute_info power_state;
	233	struct hid_sensor_hub_attribute_info sensitivity;
1c71a286	234	struct hid_sensor_hub_attribute_info sensitivity_rel;
138bc796	235	struct hid_sensor_hub_attribute_info report_latency;
7f6cf741	236	struct work_struct work;
2974cdf2 AH	237	};
2974cdf2 AH	238
15261f6d	239	/* Convert from hid unit expo to regular exponent */
2974cdf2 AH	240	static inline int hid_sensor_convert_exponent(int unit_expo)
	241	{
	242	if (unit_expo < 0x08)
	243	return unit_expo;
	244	else if (unit_expo <= 0x0f)
	245	return -(0x0f-unit_expo+1);
	246	else
	247	return 0;
	248	}
	249
	250	int hid_sensor_parse_common_attributes(struct hid_sensor_hub_device *hsdev,
	251	u32 usage_id,
0e41fd51 YX	252	struct hid_sensor_common *st,
	253	const u32 *sensitivity_addresses,
	254	u32 sensitivity_addresses_len);
e07c6d17	255	int hid_sensor_write_raw_hyst_value(struct hid_sensor_common *st,
2974cdf2	256	int val1, int val2);
1c71a286 YX	257	int hid_sensor_write_raw_hyst_rel_value(struct hid_sensor_common *st, int val1,
1c71a286 YX	258	int val2);
e07c6d17	259	int hid_sensor_read_raw_hyst_value(struct hid_sensor_common *st,
2974cdf2	260	int val1, int val2);
1c71a286 YX	261	int hid_sensor_read_raw_hyst_rel_value(struct hid_sensor_common *st,
1c71a286 YX	262	int val1, int val2);
e07c6d17	263	int hid_sensor_write_samp_freq_value(struct hid_sensor_common *st,
2974cdf2	264	int val1, int val2);
e07c6d17	265	int hid_sensor_read_samp_freq_value(struct hid_sensor_common *st,
2974cdf2 AH	266	int val1, int val2);
2974cdf2 AH	267
e02cee48 SP	268	int hid_sensor_get_usage_index(struct hid_sensor_hub_device *hsdev,
	269	u32 report_id, int field_index, u32 usage_id);
	270
5d02edfc SP	271	int hid_sensor_format_scale(u32 usage_id,
	272	struct hid_sensor_hub_attribute_info *attr_info,
	273	int val0, int val1);
	274
90309245 SP	275	s32 hid_sensor_read_poll_value(struct hid_sensor_common *st);
90309245 SP	276
a96cd0f9 SP	277	int64_t hid_sensor_convert_timestamp(struct hid_sensor_common *st,
a96cd0f9 SP	278	int64_t raw_value);
138bc796 SP	279	bool hid_sensor_batch_mode_supported(struct hid_sensor_common *st);
	280	int hid_sensor_set_report_latency(struct hid_sensor_common *st, int latency);
	281	int hid_sensor_get_report_latency(struct hid_sensor_common *st);
a96cd0f9	282
401ca24f	283	#endif