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