1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3 * HID Sensors Driver
4 * Copyright (c) 2014, Intel Corporation.
5 */
6 #include <linux/device.h>
7 #include <linux/platform_device.h>
8 #include <linux/module.h>
9 #include <linux/mod_devicetable.h>
10 #include <linux/slab.h>
11 #include <linux/hid-sensor-hub.h>
12 #include <linux/iio/iio.h>
13 #include <linux/iio/buffer.h>
14 #include "../common/hid-sensors/hid-sensor-trigger.h"
15
16 #define CHANNEL_SCAN_INDEX_PRESENCE 0
17
18 struct prox_state {
19 struct hid_sensor_hub_callbacks callbacks;
20 struct hid_sensor_common common_attributes;
21 struct hid_sensor_hub_attribute_info prox_attr;
22 u32 human_presence;
23 int scale_pre_decml;
24 int scale_post_decml;
25 int scale_precision;
26 };
27
28 static const u32 prox_sensitivity_addresses[] = {
29 HID_USAGE_SENSOR_HUMAN_PRESENCE,
30 HID_USAGE_SENSOR_DATA_PRESENCE,
31 };
32
33 /* Channel definitions */
34 static const struct iio_chan_spec prox_channels[] = {
35 {
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,
43 }
44 };
45
46 /* Adjust channel real bits based on report descriptor */
prox_adjust_channel_bit_mask(struct iio_chan_spec * channels,int channel,int size)47 static void prox_adjust_channel_bit_mask(struct iio_chan_spec *channels,
48 int channel, int size)
49 {
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;
55 }
56
57 /* Channel read_raw handler */
prox_read_raw(struct iio_dev * indio_dev,struct iio_chan_spec const * chan,int * val,int * val2,long mask)58 static int prox_read_raw(struct iio_dev *indio_dev,
59 struct iio_chan_spec const *chan,
60 int *val, int *val2,
61 long mask)
62 {
63 struct prox_state *prox_state = iio_priv(indio_dev);
64 struct hid_sensor_hub_device *hsdev;
65 int report_id = -1;
66 u32 address;
67 int ret_type;
68 s32 min;
69
70 *val = 0;
71 *val2 = 0;
72 switch (mask) {
73 case IIO_CHAN_INFO_RAW:
74 switch (chan->scan_index) {
75 case CHANNEL_SCAN_INDEX_PRESENCE:
76 report_id = prox_state->prox_attr.report_id;
77 min = prox_state->prox_attr.logical_minimum;
78 address = HID_USAGE_SENSOR_HUMAN_PRESENCE;
79 hsdev = prox_state->common_attributes.hsdev;
80 break;
81 default:
82 report_id = -1;
83 break;
84 }
85 if (report_id >= 0) {
86 hid_sensor_power_state(&prox_state->common_attributes,
87 true);
88 *val = sensor_hub_input_attr_get_raw_value(
89 hsdev, hsdev->usage, address, report_id,
90 SENSOR_HUB_SYNC, min < 0);
91 hid_sensor_power_state(&prox_state->common_attributes,
92 false);
93 } else {
94 *val = 0;
95 return -EINVAL;
96 }
97 ret_type = IIO_VAL_INT;
98 break;
99 case IIO_CHAN_INFO_SCALE:
100 *val = prox_state->scale_pre_decml;
101 *val2 = prox_state->scale_post_decml;
102 ret_type = prox_state->scale_precision;
103 break;
104 case IIO_CHAN_INFO_OFFSET:
105 *val = 0;
106 ret_type = IIO_VAL_INT;
107 break;
108 case IIO_CHAN_INFO_SAMP_FREQ:
109 ret_type = hid_sensor_read_samp_freq_value(
110 &prox_state->common_attributes, val, val2);
111 break;
112 case IIO_CHAN_INFO_HYSTERESIS:
113 ret_type = hid_sensor_read_raw_hyst_value(
114 &prox_state->common_attributes, val, val2);
115 break;
116 default:
117 ret_type = -EINVAL;
118 break;
119 }
120
121 return ret_type;
122 }
123
124 /* Channel write_raw handler */
prox_write_raw(struct iio_dev * indio_dev,struct iio_chan_spec const * chan,int val,int val2,long mask)125 static int prox_write_raw(struct iio_dev *indio_dev,
126 struct iio_chan_spec const *chan,
127 int val,
128 int val2,
129 long mask)
130 {
131 struct prox_state *prox_state = iio_priv(indio_dev);
132 int ret = 0;
133
134 switch (mask) {
135 case IIO_CHAN_INFO_SAMP_FREQ:
136 ret = hid_sensor_write_samp_freq_value(
137 &prox_state->common_attributes, val, val2);
138 break;
139 case IIO_CHAN_INFO_HYSTERESIS:
140 ret = hid_sensor_write_raw_hyst_value(
141 &prox_state->common_attributes, val, val2);
142 break;
143 default:
144 ret = -EINVAL;
145 }
146
147 return ret;
148 }
149
150 static const struct iio_info prox_info = {
151 .read_raw = &prox_read_raw,
152 .write_raw = &prox_write_raw,
153 };
154
155 /* Function to push data to buffer */
hid_sensor_push_data(struct iio_dev * indio_dev,const void * data,int len)156 static void hid_sensor_push_data(struct iio_dev *indio_dev, const void *data,
157 int len)
158 {
159 dev_dbg(&indio_dev->dev, "hid_sensor_push_data\n");
160 iio_push_to_buffers(indio_dev, data);
161 }
162
163 /* Callback handler to send event after all samples are received and captured */
prox_proc_event(struct hid_sensor_hub_device * hsdev,unsigned usage_id,void * priv)164 static int prox_proc_event(struct hid_sensor_hub_device *hsdev,
165 unsigned usage_id,
166 void *priv)
167 {
168 struct iio_dev *indio_dev = platform_get_drvdata(priv);
169 struct prox_state *prox_state = iio_priv(indio_dev);
170
171 dev_dbg(&indio_dev->dev, "prox_proc_event\n");
172 if (atomic_read(&prox_state->common_attributes.data_ready))
173 hid_sensor_push_data(indio_dev,
174 &prox_state->human_presence,
175 sizeof(prox_state->human_presence));
176
177 return 0;
178 }
179
180 /* Capture samples in local storage */
prox_capture_sample(struct hid_sensor_hub_device * hsdev,unsigned usage_id,size_t raw_len,char * raw_data,void * priv)181 static int prox_capture_sample(struct hid_sensor_hub_device *hsdev,
182 unsigned usage_id,
183 size_t raw_len, char *raw_data,
184 void *priv)
185 {
186 struct iio_dev *indio_dev = platform_get_drvdata(priv);
187 struct prox_state *prox_state = iio_priv(indio_dev);
188 int ret = -EINVAL;
189
190 switch (usage_id) {
191 case HID_USAGE_SENSOR_HUMAN_PRESENCE:
192 switch (raw_len) {
193 case 1:
194 prox_state->human_presence = *(u8 *)raw_data;
195 return 0;
196 case 4:
197 prox_state->human_presence = *(u32 *)raw_data;
198 return 0;
199 default:
200 break;
201 }
202 break;
203 }
204
205 return ret;
206 }
207
208 /* Parse report which is specific to an usage id*/
prox_parse_report(struct platform_device * pdev,struct hid_sensor_hub_device * hsdev,struct iio_chan_spec * channels,unsigned usage_id,struct prox_state * st)209 static int prox_parse_report(struct platform_device *pdev,
210 struct hid_sensor_hub_device *hsdev,
211 struct iio_chan_spec *channels,
212 unsigned usage_id,
213 struct prox_state *st)
214 {
215 int ret;
216
217 ret = sensor_hub_input_get_attribute_info(hsdev, HID_INPUT_REPORT,
218 usage_id,
219 HID_USAGE_SENSOR_HUMAN_PRESENCE,
220 &st->prox_attr);
221 if (ret < 0)
222 return ret;
223 prox_adjust_channel_bit_mask(channels, CHANNEL_SCAN_INDEX_PRESENCE,
224 st->prox_attr.size);
225
226 dev_dbg(&pdev->dev, "prox %x:%x\n", st->prox_attr.index,
227 st->prox_attr.report_id);
228
229 st->scale_precision = hid_sensor_format_scale(hsdev->usage,
230 &st->prox_attr,
231 &st->scale_pre_decml,
232 &st->scale_post_decml);
233
234 return ret;
235 }
236
237 /* Function to initialize the processing for usage id */
hid_prox_probe(struct platform_device * pdev)238 static int hid_prox_probe(struct platform_device *pdev)
239 {
240 int ret = 0;
241 static const char *name = "prox";
242 struct iio_dev *indio_dev;
243 struct prox_state *prox_state;
244 struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
245
246 indio_dev = devm_iio_device_alloc(&pdev->dev,
247 sizeof(struct prox_state));
248 if (!indio_dev)
249 return -ENOMEM;
250 platform_set_drvdata(pdev, indio_dev);
251
252 prox_state = iio_priv(indio_dev);
253 prox_state->common_attributes.hsdev = hsdev;
254 prox_state->common_attributes.pdev = pdev;
255
256 ret = hid_sensor_parse_common_attributes(hsdev, hsdev->usage,
257 &prox_state->common_attributes,
258 prox_sensitivity_addresses,
259 ARRAY_SIZE(prox_sensitivity_addresses));
260 if (ret) {
261 dev_err(&pdev->dev, "failed to setup common attributes\n");
262 return ret;
263 }
264
265 indio_dev->channels = devm_kmemdup(&pdev->dev, prox_channels,
266 sizeof(prox_channels), GFP_KERNEL);
267 if (!indio_dev->channels) {
268 dev_err(&pdev->dev, "failed to duplicate channels\n");
269 return -ENOMEM;
270 }
271
272 ret = prox_parse_report(pdev, hsdev,
273 (struct iio_chan_spec *)indio_dev->channels,
274 hsdev->usage, prox_state);
275 if (ret) {
276 dev_err(&pdev->dev, "failed to setup attributes\n");
277 return ret;
278 }
279
280 indio_dev->num_channels = ARRAY_SIZE(prox_channels);
281 indio_dev->info = &prox_info;
282 indio_dev->name = name;
283 indio_dev->modes = INDIO_DIRECT_MODE;
284
285 atomic_set(&prox_state->common_attributes.data_ready, 0);
286
287 ret = hid_sensor_setup_trigger(indio_dev, name,
288 &prox_state->common_attributes);
289 if (ret) {
290 dev_err(&pdev->dev, "trigger setup failed\n");
291 return ret;
292 }
293
294 ret = iio_device_register(indio_dev);
295 if (ret) {
296 dev_err(&pdev->dev, "device register failed\n");
297 goto error_remove_trigger;
298 }
299
300 prox_state->callbacks.send_event = prox_proc_event;
301 prox_state->callbacks.capture_sample = prox_capture_sample;
302 prox_state->callbacks.pdev = pdev;
303 ret = sensor_hub_register_callback(hsdev, hsdev->usage,
304 &prox_state->callbacks);
305 if (ret < 0) {
306 dev_err(&pdev->dev, "callback reg failed\n");
307 goto error_iio_unreg;
308 }
309
310 return ret;
311
312 error_iio_unreg:
313 iio_device_unregister(indio_dev);
314 error_remove_trigger:
315 hid_sensor_remove_trigger(indio_dev, &prox_state->common_attributes);
316 return ret;
317 }
318
319 /* Function to deinitialize the processing for usage id */
hid_prox_remove(struct platform_device * pdev)320 static void hid_prox_remove(struct platform_device *pdev)
321 {
322 struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
323 struct iio_dev *indio_dev = platform_get_drvdata(pdev);
324 struct prox_state *prox_state = iio_priv(indio_dev);
325
326 sensor_hub_remove_callback(hsdev, hsdev->usage);
327 iio_device_unregister(indio_dev);
328 hid_sensor_remove_trigger(indio_dev, &prox_state->common_attributes);
329 }
330
331 static const struct platform_device_id hid_prox_ids[] = {
332 {
333 /* Format: HID-SENSOR-usage_id_in_hex_lowercase */
334 .name = "HID-SENSOR-200011",
335 },
336 {
337 /* Format: HID-SENSOR-tag-usage_id_in_hex_lowercase */
338 .name = "HID-SENSOR-LISS-0226",
339 },
340 { /* sentinel */ }
341 };
342 MODULE_DEVICE_TABLE(platform, hid_prox_ids);
343
344 static struct platform_driver hid_prox_platform_driver = {
345 .id_table = hid_prox_ids,
346 .driver = {
347 .name = KBUILD_MODNAME,
348 .pm = &hid_sensor_pm_ops,
349 },
350 .probe = hid_prox_probe,
351 .remove_new = hid_prox_remove,
352 };
353 module_platform_driver(hid_prox_platform_driver);
354
355 MODULE_DESCRIPTION("HID Sensor Proximity");
356 MODULE_AUTHOR("Archana Patni <archana.patni@intel.com>");
357 MODULE_LICENSE("GPL");
358 MODULE_IMPORT_NS(IIO_HID);
359