1 // SPDX-License-Identifier: GPL-2.0-only
4 * Copyright (c) 2014, Intel Corporation.
6 #include <linux/device.h>
7 #include <linux/platform_device.h>
8 #include <linux/module.h>
9 #include <linux/interrupt.h>
10 #include <linux/irq.h>
11 #include <linux/slab.h>
12 #include <linux/delay.h>
13 #include <linux/hid-sensor-hub.h>
14 #include <linux/iio/iio.h>
15 #include <linux/iio/sysfs.h>
16 #include <linux/iio/buffer.h>
17 #include "../common/hid-sensors/hid-sensor-trigger.h"
19 #define CHANNEL_SCAN_INDEX_PRESENCE 0
22 struct hid_sensor_hub_callbacks callbacks;
23 struct hid_sensor_common common_attributes;
24 struct hid_sensor_hub_attribute_info prox_attr;
28 static const u32 prox_sensitivity_addresses[] = {
29 HID_USAGE_SENSOR_HUMAN_PRESENCE,
30 HID_USAGE_SENSOR_DATA_PRESENCE,
33 /* Channel definitions */
34 static const struct iio_chan_spec prox_channels[] = {
36 .type = IIO_PROXIMITY,
37 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
38 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
39 BIT(IIO_CHAN_INFO_SCALE) |
40 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
41 BIT(IIO_CHAN_INFO_HYSTERESIS),
42 .scan_index = CHANNEL_SCAN_INDEX_PRESENCE,
46 /* Adjust channel real bits based on report descriptor */
47 static void prox_adjust_channel_bit_mask(struct iio_chan_spec *channels,
48 int channel, int size)
50 channels[channel].scan_type.sign = 's';
51 /* Real storage bits will change based on the report desc. */
52 channels[channel].scan_type.realbits = size * 8;
53 /* Maximum size of a sample to capture is u32 */
54 channels[channel].scan_type.storagebits = sizeof(u32) * 8;
57 /* Channel read_raw handler */
58 static int prox_read_raw(struct iio_dev *indio_dev,
59 struct iio_chan_spec const *chan,
63 struct prox_state *prox_state = iio_priv(indio_dev);
72 case IIO_CHAN_INFO_RAW:
73 switch (chan->scan_index) {
74 case CHANNEL_SCAN_INDEX_PRESENCE:
75 report_id = prox_state->prox_attr.report_id;
76 min = prox_state->prox_attr.logical_minimum;
77 address = HID_USAGE_SENSOR_HUMAN_PRESENCE;
84 hid_sensor_power_state(&prox_state->common_attributes,
86 *val = sensor_hub_input_attr_get_raw_value(
87 prox_state->common_attributes.hsdev,
88 HID_USAGE_SENSOR_PROX, address,
92 hid_sensor_power_state(&prox_state->common_attributes,
98 ret_type = IIO_VAL_INT;
100 case IIO_CHAN_INFO_SCALE:
101 *val = prox_state->prox_attr.units;
102 ret_type = IIO_VAL_INT;
104 case IIO_CHAN_INFO_OFFSET:
105 *val = hid_sensor_convert_exponent(
106 prox_state->prox_attr.unit_expo);
107 ret_type = IIO_VAL_INT;
109 case IIO_CHAN_INFO_SAMP_FREQ:
110 ret_type = hid_sensor_read_samp_freq_value(
111 &prox_state->common_attributes, val, val2);
113 case IIO_CHAN_INFO_HYSTERESIS:
114 ret_type = hid_sensor_read_raw_hyst_value(
115 &prox_state->common_attributes, val, val2);
125 /* Channel write_raw handler */
126 static int prox_write_raw(struct iio_dev *indio_dev,
127 struct iio_chan_spec const *chan,
132 struct prox_state *prox_state = iio_priv(indio_dev);
136 case IIO_CHAN_INFO_SAMP_FREQ:
137 ret = hid_sensor_write_samp_freq_value(
138 &prox_state->common_attributes, val, val2);
140 case IIO_CHAN_INFO_HYSTERESIS:
141 ret = hid_sensor_write_raw_hyst_value(
142 &prox_state->common_attributes, val, val2);
151 static const struct iio_info prox_info = {
152 .read_raw = &prox_read_raw,
153 .write_raw = &prox_write_raw,
156 /* Function to push data to buffer */
157 static void hid_sensor_push_data(struct iio_dev *indio_dev, const void *data,
160 dev_dbg(&indio_dev->dev, "hid_sensor_push_data\n");
161 iio_push_to_buffers(indio_dev, data);
164 /* Callback handler to send event after all samples are received and captured */
165 static int prox_proc_event(struct hid_sensor_hub_device *hsdev,
169 struct iio_dev *indio_dev = platform_get_drvdata(priv);
170 struct prox_state *prox_state = iio_priv(indio_dev);
172 dev_dbg(&indio_dev->dev, "prox_proc_event\n");
173 if (atomic_read(&prox_state->common_attributes.data_ready))
174 hid_sensor_push_data(indio_dev,
175 &prox_state->human_presence,
176 sizeof(prox_state->human_presence));
181 /* Capture samples in local storage */
182 static int prox_capture_sample(struct hid_sensor_hub_device *hsdev,
184 size_t raw_len, char *raw_data,
187 struct iio_dev *indio_dev = platform_get_drvdata(priv);
188 struct prox_state *prox_state = iio_priv(indio_dev);
192 case HID_USAGE_SENSOR_HUMAN_PRESENCE:
193 prox_state->human_presence = *(u32 *)raw_data;
203 /* Parse report which is specific to an usage id*/
204 static int prox_parse_report(struct platform_device *pdev,
205 struct hid_sensor_hub_device *hsdev,
206 struct iio_chan_spec *channels,
208 struct prox_state *st)
212 ret = sensor_hub_input_get_attribute_info(hsdev, HID_INPUT_REPORT,
214 HID_USAGE_SENSOR_HUMAN_PRESENCE,
218 prox_adjust_channel_bit_mask(channels, CHANNEL_SCAN_INDEX_PRESENCE,
221 dev_dbg(&pdev->dev, "prox %x:%x\n", st->prox_attr.index,
222 st->prox_attr.report_id);
227 /* Function to initialize the processing for usage id */
228 static int hid_prox_probe(struct platform_device *pdev)
231 static const char *name = "prox";
232 struct iio_dev *indio_dev;
233 struct prox_state *prox_state;
234 struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
236 indio_dev = devm_iio_device_alloc(&pdev->dev,
237 sizeof(struct prox_state));
240 platform_set_drvdata(pdev, indio_dev);
242 prox_state = iio_priv(indio_dev);
243 prox_state->common_attributes.hsdev = hsdev;
244 prox_state->common_attributes.pdev = pdev;
246 ret = hid_sensor_parse_common_attributes(hsdev, HID_USAGE_SENSOR_PROX,
247 &prox_state->common_attributes,
248 prox_sensitivity_addresses,
249 ARRAY_SIZE(prox_sensitivity_addresses));
251 dev_err(&pdev->dev, "failed to setup common attributes\n");
255 indio_dev->channels = kmemdup(prox_channels, sizeof(prox_channels),
257 if (!indio_dev->channels) {
258 dev_err(&pdev->dev, "failed to duplicate channels\n");
262 ret = prox_parse_report(pdev, hsdev,
263 (struct iio_chan_spec *)indio_dev->channels,
264 HID_USAGE_SENSOR_PROX, prox_state);
266 dev_err(&pdev->dev, "failed to setup attributes\n");
267 goto error_free_dev_mem;
270 indio_dev->num_channels = ARRAY_SIZE(prox_channels);
271 indio_dev->info = &prox_info;
272 indio_dev->name = name;
273 indio_dev->modes = INDIO_DIRECT_MODE;
275 atomic_set(&prox_state->common_attributes.data_ready, 0);
277 ret = hid_sensor_setup_trigger(indio_dev, name,
278 &prox_state->common_attributes);
280 dev_err(&pdev->dev, "trigger setup failed\n");
281 goto error_free_dev_mem;
284 ret = iio_device_register(indio_dev);
286 dev_err(&pdev->dev, "device register failed\n");
287 goto error_remove_trigger;
290 prox_state->callbacks.send_event = prox_proc_event;
291 prox_state->callbacks.capture_sample = prox_capture_sample;
292 prox_state->callbacks.pdev = pdev;
293 ret = sensor_hub_register_callback(hsdev, HID_USAGE_SENSOR_PROX,
294 &prox_state->callbacks);
296 dev_err(&pdev->dev, "callback reg failed\n");
297 goto error_iio_unreg;
303 iio_device_unregister(indio_dev);
304 error_remove_trigger:
305 hid_sensor_remove_trigger(indio_dev, &prox_state->common_attributes);
307 kfree(indio_dev->channels);
311 /* Function to deinitialize the processing for usage id */
312 static int hid_prox_remove(struct platform_device *pdev)
314 struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
315 struct iio_dev *indio_dev = platform_get_drvdata(pdev);
316 struct prox_state *prox_state = iio_priv(indio_dev);
318 sensor_hub_remove_callback(hsdev, HID_USAGE_SENSOR_PROX);
319 iio_device_unregister(indio_dev);
320 hid_sensor_remove_trigger(indio_dev, &prox_state->common_attributes);
321 kfree(indio_dev->channels);
326 static const struct platform_device_id hid_prox_ids[] = {
328 /* Format: HID-SENSOR-usage_id_in_hex_lowercase */
329 .name = "HID-SENSOR-200011",
333 MODULE_DEVICE_TABLE(platform, hid_prox_ids);
335 static struct platform_driver hid_prox_platform_driver = {
336 .id_table = hid_prox_ids,
338 .name = KBUILD_MODNAME,
339 .pm = &hid_sensor_pm_ops,
341 .probe = hid_prox_probe,
342 .remove = hid_prox_remove,
344 module_platform_driver(hid_prox_platform_driver);
346 MODULE_DESCRIPTION("HID Sensor Proximity");
347 MODULE_AUTHOR("Archana Patni <archana.patni@intel.com>");
348 MODULE_LICENSE("GPL");