1a61127c2SThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-only */
2401ca24fSsrinivas pandruvada /*
3401ca24fSsrinivas pandruvada * HID Sensors Driver
4401ca24fSsrinivas pandruvada * Copyright (c) 2012, Intel Corporation.
5401ca24fSsrinivas pandruvada */
6401ca24fSsrinivas pandruvada #ifndef _HID_SENSORS_HUB_H
7401ca24fSsrinivas pandruvada #define _HID_SENSORS_HUB_H
8401ca24fSsrinivas pandruvada
9401ca24fSsrinivas pandruvada #include <linux/hid.h>
10401ca24fSsrinivas pandruvada #include <linux/hid-sensor-ids.h>
11ec7f68e0SSrinivas Pandruvada #include <linux/iio/iio.h>
12ec7f68e0SSrinivas Pandruvada #include <linux/iio/trigger.h>
13401ca24fSsrinivas pandruvada
14401ca24fSsrinivas pandruvada /**
15401ca24fSsrinivas pandruvada * struct hid_sensor_hub_attribute_info - Attribute info
16401ca24fSsrinivas pandruvada * @usage_id: Parent usage id of a physical device.
17401ca24fSsrinivas pandruvada * @attrib_id: Attribute id for this attribute.
18401ca24fSsrinivas pandruvada * @report_id: Report id in which this information resides.
19401ca24fSsrinivas pandruvada * @index: Field index in the report.
20401ca24fSsrinivas pandruvada * @units: Measurment unit for this attribute.
21401ca24fSsrinivas pandruvada * @unit_expo: Exponent used in the data.
22401ca24fSsrinivas pandruvada * @size: Size in bytes for data size.
23f9d904acSSrinivas Pandruvada * @logical_minimum: Logical minimum value for this attribute.
24f9d904acSSrinivas Pandruvada * @logical_maximum: Logical maximum value for this attribute.
25401ca24fSsrinivas pandruvada */
26401ca24fSsrinivas pandruvada struct hid_sensor_hub_attribute_info {
27401ca24fSsrinivas pandruvada u32 usage_id;
28401ca24fSsrinivas pandruvada u32 attrib_id;
29401ca24fSsrinivas pandruvada s32 report_id;
30401ca24fSsrinivas pandruvada s32 index;
31401ca24fSsrinivas pandruvada s32 units;
32401ca24fSsrinivas pandruvada s32 unit_expo;
33401ca24fSsrinivas pandruvada s32 size;
349f740ffaSSrinivas Pandruvada s32 logical_minimum;
359f740ffaSSrinivas Pandruvada s32 logical_maximum;
36401ca24fSsrinivas pandruvada };
37401ca24fSsrinivas pandruvada
38401ca24fSsrinivas pandruvada /**
39e651a1daSSrinivas Pandruvada * struct sensor_hub_pending - Synchronous read pending information
40e651a1daSSrinivas Pandruvada * @status: Pending status true/false.
41e651a1daSSrinivas Pandruvada * @ready: Completion synchronization data.
42e651a1daSSrinivas Pandruvada * @usage_id: Usage id for physical device, E.g. Gyro usage id.
43e651a1daSSrinivas Pandruvada * @attr_usage_id: Usage Id of a field, E.g. X-AXIS for a gyro.
44e651a1daSSrinivas Pandruvada * @raw_size: Response size for a read request.
45e651a1daSSrinivas Pandruvada * @raw_data: Place holder for received response.
46e651a1daSSrinivas Pandruvada */
47e651a1daSSrinivas Pandruvada struct sensor_hub_pending {
48e651a1daSSrinivas Pandruvada bool status;
49e651a1daSSrinivas Pandruvada struct completion ready;
50e651a1daSSrinivas Pandruvada u32 usage_id;
51e651a1daSSrinivas Pandruvada u32 attr_usage_id;
52e651a1daSSrinivas Pandruvada int raw_size;
53e651a1daSSrinivas Pandruvada u8 *raw_data;
54e651a1daSSrinivas Pandruvada };
55e651a1daSSrinivas Pandruvada
56e651a1daSSrinivas Pandruvada /**
57401ca24fSsrinivas pandruvada * struct hid_sensor_hub_device - Stores the hub instance data
58401ca24fSsrinivas pandruvada * @hdev: Stores the hid instance.
59401ca24fSsrinivas pandruvada * @vendor_id: Vendor id of hub device.
60401ca24fSsrinivas pandruvada * @product_id: Product id of hub device.
61e651a1daSSrinivas Pandruvada * @usage: Usage id for this hub device instance.
62ca2ed12fSSrinivas Pandruvada * @start_collection_index: Starting index for a phy type collection
63ca2ed12fSSrinivas Pandruvada * @end_collection_index: Last index for a phy type collection
642d94e522SSrinivas Pandruvada * @mutex_ptr: synchronizing mutex pointer.
65e651a1daSSrinivas Pandruvada * @pending: Holds information of pending sync read request.
66401ca24fSsrinivas pandruvada */
67401ca24fSsrinivas pandruvada struct hid_sensor_hub_device {
68401ca24fSsrinivas pandruvada struct hid_device *hdev;
69401ca24fSsrinivas pandruvada u32 vendor_id;
70401ca24fSsrinivas pandruvada u32 product_id;
71e651a1daSSrinivas Pandruvada u32 usage;
72ca2ed12fSSrinivas Pandruvada int start_collection_index;
73ca2ed12fSSrinivas Pandruvada int end_collection_index;
742d94e522SSrinivas Pandruvada struct mutex *mutex_ptr;
75e651a1daSSrinivas Pandruvada struct sensor_hub_pending pending;
76401ca24fSsrinivas pandruvada };
77401ca24fSsrinivas pandruvada
78401ca24fSsrinivas pandruvada /**
79401ca24fSsrinivas pandruvada * struct hid_sensor_hub_callbacks - Client callback functions
80401ca24fSsrinivas pandruvada * @pdev: Platform device instance of the client driver.
81401ca24fSsrinivas pandruvada * @suspend: Suspend callback.
82401ca24fSsrinivas pandruvada * @resume: Resume callback.
83401ca24fSsrinivas pandruvada * @capture_sample: Callback to get a sample.
84401ca24fSsrinivas pandruvada * @send_event: Send notification to indicate all samples are
85401ca24fSsrinivas pandruvada * captured, process and send event
86401ca24fSsrinivas pandruvada */
87401ca24fSsrinivas pandruvada struct hid_sensor_hub_callbacks {
88401ca24fSsrinivas pandruvada struct platform_device *pdev;
89401ca24fSsrinivas pandruvada int (*suspend)(struct hid_sensor_hub_device *hsdev, void *priv);
90401ca24fSsrinivas pandruvada int (*resume)(struct hid_sensor_hub_device *hsdev, void *priv);
91401ca24fSsrinivas pandruvada int (*capture_sample)(struct hid_sensor_hub_device *hsdev,
92401ca24fSsrinivas pandruvada u32 usage_id, size_t raw_len, char *raw_data,
93401ca24fSsrinivas pandruvada void *priv);
94401ca24fSsrinivas pandruvada int (*send_event)(struct hid_sensor_hub_device *hsdev, u32 usage_id,
95401ca24fSsrinivas pandruvada void *priv);
96401ca24fSsrinivas pandruvada };
97401ca24fSsrinivas pandruvada
981df3a401SSrinivas Pandruvada /**
991df3a401SSrinivas Pandruvada * sensor_hub_device_open() - Open hub device
1001df3a401SSrinivas Pandruvada * @hsdev: Hub device instance.
1011df3a401SSrinivas Pandruvada *
1021df3a401SSrinivas Pandruvada * Used to open hid device for sensor hub.
1031df3a401SSrinivas Pandruvada */
1041df3a401SSrinivas Pandruvada int sensor_hub_device_open(struct hid_sensor_hub_device *hsdev);
1051df3a401SSrinivas Pandruvada
1061df3a401SSrinivas Pandruvada /**
1071df3a401SSrinivas Pandruvada * sensor_hub_device_clode() - Close hub device
1081df3a401SSrinivas Pandruvada * @hsdev: Hub device instance.
1091df3a401SSrinivas Pandruvada *
1101df3a401SSrinivas Pandruvada * Used to clode hid device for sensor hub.
1111df3a401SSrinivas Pandruvada */
1121df3a401SSrinivas Pandruvada void sensor_hub_device_close(struct hid_sensor_hub_device *hsdev);
1131df3a401SSrinivas Pandruvada
114401ca24fSsrinivas pandruvada /* Registration functions */
115401ca24fSsrinivas pandruvada
116401ca24fSsrinivas pandruvada /**
117401ca24fSsrinivas pandruvada * sensor_hub_register_callback() - Register client callbacks
118401ca24fSsrinivas pandruvada * @hsdev: Hub device instance.
119401ca24fSsrinivas pandruvada * @usage_id: Usage id of the client (E.g. 0x200076 for Gyro).
120401ca24fSsrinivas pandruvada * @usage_callback: Callback function storage
121401ca24fSsrinivas pandruvada *
122401ca24fSsrinivas pandruvada * Used to register callbacks by client processing drivers. Sensor
123401ca24fSsrinivas pandruvada * hub core driver will call these callbacks to offload processing
124401ca24fSsrinivas pandruvada * of data streams and notifications.
125401ca24fSsrinivas pandruvada */
126401ca24fSsrinivas pandruvada int sensor_hub_register_callback(struct hid_sensor_hub_device *hsdev,
127401ca24fSsrinivas pandruvada u32 usage_id,
128401ca24fSsrinivas pandruvada struct hid_sensor_hub_callbacks *usage_callback);
129401ca24fSsrinivas pandruvada
130401ca24fSsrinivas pandruvada /**
131401ca24fSsrinivas pandruvada * sensor_hub_remove_callback() - Remove client callbacks
132401ca24fSsrinivas pandruvada * @hsdev: Hub device instance.
133401ca24fSsrinivas pandruvada * @usage_id: Usage id of the client (E.g. 0x200076 for Gyro).
134401ca24fSsrinivas pandruvada *
135401ca24fSsrinivas pandruvada * If there is a callback registred, this call will remove that
136401ca24fSsrinivas pandruvada * callbacks, so that it will stop data and event notifications.
137401ca24fSsrinivas pandruvada */
138401ca24fSsrinivas pandruvada int sensor_hub_remove_callback(struct hid_sensor_hub_device *hsdev,
139401ca24fSsrinivas pandruvada u32 usage_id);
140401ca24fSsrinivas pandruvada
141401ca24fSsrinivas pandruvada
142401ca24fSsrinivas pandruvada /* Hid sensor hub core interfaces */
143401ca24fSsrinivas pandruvada
144401ca24fSsrinivas pandruvada /**
145401ca24fSsrinivas pandruvada * sensor_hub_input_get_attribute_info() - Get an attribute information
146401ca24fSsrinivas pandruvada * @hsdev: Hub device instance.
147401ca24fSsrinivas pandruvada * @type: Type of this attribute, input/output/feature
148401ca24fSsrinivas pandruvada * @usage_id: Attribute usage id of parent physical device as per spec
149401ca24fSsrinivas pandruvada * @attr_usage_id: Attribute usage id as per spec
150401ca24fSsrinivas pandruvada * @info: return information about attribute after parsing report
151401ca24fSsrinivas pandruvada *
152401ca24fSsrinivas pandruvada * Parses report and returns the attribute information such as report id,
153ceecd1bfSRandy Dunlap * field index, units and exponent etc.
154401ca24fSsrinivas pandruvada */
155401ca24fSsrinivas pandruvada int sensor_hub_input_get_attribute_info(struct hid_sensor_hub_device *hsdev,
156401ca24fSsrinivas pandruvada u8 type,
157401ca24fSsrinivas pandruvada u32 usage_id, u32 attr_usage_id,
158401ca24fSsrinivas pandruvada struct hid_sensor_hub_attribute_info *info);
159401ca24fSsrinivas pandruvada
160401ca24fSsrinivas pandruvada /**
161401ca24fSsrinivas pandruvada * sensor_hub_input_attr_get_raw_value() - Synchronous read request
162f9d904acSSrinivas Pandruvada * @hsdev: Hub device instance.
163401ca24fSsrinivas pandruvada * @usage_id: Attribute usage id of parent physical device as per spec
164401ca24fSsrinivas pandruvada * @attr_usage_id: Attribute usage id as per spec
165401ca24fSsrinivas pandruvada * @report_id: Report id to look for
166b3f4737dSSrinivas Pandruvada * @flag: Synchronous or asynchronous read
1670145b505SHans de Goede * @is_signed: If true then fields < 32 bits will be sign-extended
168401ca24fSsrinivas pandruvada *
169b3f4737dSSrinivas Pandruvada * Issues a synchronous or asynchronous read request for an input attribute.
170ceecd1bfSRandy Dunlap * Return: data up to 32 bits.
171401ca24fSsrinivas pandruvada */
172401ca24fSsrinivas pandruvada
173b3f4737dSSrinivas Pandruvada enum sensor_hub_read_flags {
174b3f4737dSSrinivas Pandruvada SENSOR_HUB_SYNC,
175b3f4737dSSrinivas Pandruvada SENSOR_HUB_ASYNC,
176b3f4737dSSrinivas Pandruvada };
177b3f4737dSSrinivas Pandruvada
178401ca24fSsrinivas pandruvada int sensor_hub_input_attr_get_raw_value(struct hid_sensor_hub_device *hsdev,
179401ca24fSsrinivas pandruvada u32 usage_id,
180b3f4737dSSrinivas Pandruvada u32 attr_usage_id, u32 report_id,
1810145b505SHans de Goede enum sensor_hub_read_flags flag,
1820145b505SHans de Goede bool is_signed
183b3f4737dSSrinivas Pandruvada );
184b3f4737dSSrinivas Pandruvada
185401ca24fSsrinivas pandruvada /**
186401ca24fSsrinivas pandruvada * sensor_hub_set_feature() - Feature set request
187f9d904acSSrinivas Pandruvada * @hsdev: Hub device instance.
188401ca24fSsrinivas pandruvada * @report_id: Report id to look for
189401ca24fSsrinivas pandruvada * @field_index: Field index inside a report
1903950e033SSrinivas Pandruvada * @buffer_size: size of the buffer
1913950e033SSrinivas Pandruvada * @buffer: buffer to use in the feature set
192401ca24fSsrinivas pandruvada *
193401ca24fSsrinivas pandruvada * Used to set a field in feature report. For example this can set polling
194401ca24fSsrinivas pandruvada * interval, sensitivity, activate/deactivate state.
195401ca24fSsrinivas pandruvada */
196401ca24fSsrinivas pandruvada int sensor_hub_set_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
1973950e033SSrinivas Pandruvada u32 field_index, int buffer_size, void *buffer);
198401ca24fSsrinivas pandruvada
199401ca24fSsrinivas pandruvada /**
200401ca24fSsrinivas pandruvada * sensor_hub_get_feature() - Feature get request
201f9d904acSSrinivas Pandruvada * @hsdev: Hub device instance.
202401ca24fSsrinivas pandruvada * @report_id: Report id to look for
203401ca24fSsrinivas pandruvada * @field_index: Field index inside a report
2046adc83fcSSrinivas Pandruvada * @buffer_size: size of the buffer
2056adc83fcSSrinivas Pandruvada * @buffer: buffer to copy output
206401ca24fSsrinivas pandruvada *
207401ca24fSsrinivas pandruvada * Used to get a field in feature report. For example this can get polling
208ceecd1bfSRandy Dunlap * interval, sensitivity, activate/deactivate state.
209ceecd1bfSRandy Dunlap * Return: On success, it returns the number of bytes copied to buffer.
210ceecd1bfSRandy Dunlap * On failure, it returns value < 0.
211401ca24fSsrinivas pandruvada */
212401ca24fSsrinivas pandruvada int sensor_hub_get_feature(struct hid_sensor_hub_device *hsdev, u32 report_id,
2136adc83fcSSrinivas Pandruvada u32 field_index, int buffer_size, void *buffer);
2142974cdf2SAlexander Holler
2152974cdf2SAlexander Holler /* hid-sensor-attributes */
2162974cdf2SAlexander Holler
2172974cdf2SAlexander Holler /* Common hid sensor iio structure */
218e07c6d17SAlexander Holler struct hid_sensor_common {
2192974cdf2SAlexander Holler struct hid_sensor_hub_device *hsdev;
2202974cdf2SAlexander Holler struct platform_device *pdev;
2212974cdf2SAlexander Holler unsigned usage_id;
22256ff6be6SSrinivas Pandruvada atomic_t data_ready;
2231e25aa96SSrinivas Pandruvada atomic_t user_requested_state;
224ad7532ceSSrinivas Pandruvada atomic_t runtime_pm_enable;
2255d9854eaSSrinivas Pandruvada int poll_interval;
2265d9854eaSSrinivas Pandruvada int raw_hystersis;
227138bc796SSrinivas Pandruvada int latency_ms;
228ec7f68e0SSrinivas Pandruvada struct iio_trigger *trigger;
229a96cd0f9SSrinivas Pandruvada int timestamp_ns_scale;
2302974cdf2SAlexander Holler struct hid_sensor_hub_attribute_info poll;
2312974cdf2SAlexander Holler struct hid_sensor_hub_attribute_info report_state;
2322974cdf2SAlexander Holler struct hid_sensor_hub_attribute_info power_state;
2332974cdf2SAlexander Holler struct hid_sensor_hub_attribute_info sensitivity;
234*1c71a286SYe Xiang struct hid_sensor_hub_attribute_info sensitivity_rel;
235138bc796SSrinivas Pandruvada struct hid_sensor_hub_attribute_info report_latency;
2367f6cf741SSrinivas Pandruvada struct work_struct work;
2372974cdf2SAlexander Holler };
2382974cdf2SAlexander Holler
2392974cdf2SAlexander Holler /* Convert from hid unit expo to regular exponent */
hid_sensor_convert_exponent(int unit_expo)2402974cdf2SAlexander Holler static inline int hid_sensor_convert_exponent(int unit_expo)
2412974cdf2SAlexander Holler {
2422974cdf2SAlexander Holler if (unit_expo < 0x08)
2432974cdf2SAlexander Holler return unit_expo;
2442974cdf2SAlexander Holler else if (unit_expo <= 0x0f)
2452974cdf2SAlexander Holler return -(0x0f-unit_expo+1);
2462974cdf2SAlexander Holler else
2472974cdf2SAlexander Holler return 0;
2482974cdf2SAlexander Holler }
2492974cdf2SAlexander Holler
2502974cdf2SAlexander Holler int hid_sensor_parse_common_attributes(struct hid_sensor_hub_device *hsdev,
2512974cdf2SAlexander Holler u32 usage_id,
2520e41fd51SYe Xiang struct hid_sensor_common *st,
2530e41fd51SYe Xiang const u32 *sensitivity_addresses,
2540e41fd51SYe Xiang u32 sensitivity_addresses_len);
255e07c6d17SAlexander Holler int hid_sensor_write_raw_hyst_value(struct hid_sensor_common *st,
2562974cdf2SAlexander Holler int val1, int val2);
257*1c71a286SYe Xiang int hid_sensor_write_raw_hyst_rel_value(struct hid_sensor_common *st, int val1,
258*1c71a286SYe Xiang int val2);
259e07c6d17SAlexander Holler int hid_sensor_read_raw_hyst_value(struct hid_sensor_common *st,
2602974cdf2SAlexander Holler int *val1, int *val2);
261*1c71a286SYe Xiang int hid_sensor_read_raw_hyst_rel_value(struct hid_sensor_common *st,
262*1c71a286SYe Xiang int *val1, int *val2);
263e07c6d17SAlexander Holler int hid_sensor_write_samp_freq_value(struct hid_sensor_common *st,
2642974cdf2SAlexander Holler int val1, int val2);
265e07c6d17SAlexander Holler int hid_sensor_read_samp_freq_value(struct hid_sensor_common *st,
2662974cdf2SAlexander Holler int *val1, int *val2);
2672974cdf2SAlexander Holler
268e02cee48SSrinivas Pandruvada int hid_sensor_get_usage_index(struct hid_sensor_hub_device *hsdev,
269e02cee48SSrinivas Pandruvada u32 report_id, int field_index, u32 usage_id);
270e02cee48SSrinivas Pandruvada
2715d02edfcSSrinivas Pandruvada int hid_sensor_format_scale(u32 usage_id,
2725d02edfcSSrinivas Pandruvada struct hid_sensor_hub_attribute_info *attr_info,
2735d02edfcSSrinivas Pandruvada int *val0, int *val1);
2745d02edfcSSrinivas Pandruvada
27590309245SSrinivas Pandruvada s32 hid_sensor_read_poll_value(struct hid_sensor_common *st);
27690309245SSrinivas Pandruvada
277a96cd0f9SSrinivas Pandruvada int64_t hid_sensor_convert_timestamp(struct hid_sensor_common *st,
278a96cd0f9SSrinivas Pandruvada int64_t raw_value);
279138bc796SSrinivas Pandruvada bool hid_sensor_batch_mode_supported(struct hid_sensor_common *st);
280138bc796SSrinivas Pandruvada int hid_sensor_set_report_latency(struct hid_sensor_common *st, int latency);
281138bc796SSrinivas Pandruvada int hid_sensor_get_report_latency(struct hid_sensor_common *st);
282a96cd0f9SSrinivas Pandruvada
283401ca24fSsrinivas pandruvada #endif
284