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

/*
 * HID Sensors Driver
 * Copyright (c) 2012, Intel Corporation.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
 *
 */
#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 exponet 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
*
* Issues a synchronous or asynchronous read request for an input attribute.
* Returns data upto 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
);

/**
* 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. On success it returns
* 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;
	struct iio_trigger *trigger;
	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;
};

/* 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);
int hid_sensor_write_raw_hyst_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_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);

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