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