3 * Copyright (c) 2012, Intel Corporation.
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.
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
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.
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/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"
33 #define CHANNEL_SCAN_INDEX_ILLUM 0
36 struct hid_sensor_hub_callbacks callbacks;
37 struct hid_sensor_common common_attributes;
38 struct hid_sensor_hub_attribute_info als_illum;
42 /* Channel definitions */
43 static const struct iio_chan_spec als_channels[] = {
45 .type = IIO_INTENSITY,
47 .channel2 = IIO_MOD_LIGHT_BOTH,
48 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
49 BIT(IIO_CHAN_INFO_SCALE) |
50 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
51 BIT(IIO_CHAN_INFO_HYSTERESIS),
52 .scan_index = CHANNEL_SCAN_INDEX_ILLUM,
56 /* Adjust channel real bits based on report descriptor */
57 static void als_adjust_channel_bit_mask(struct iio_chan_spec *channels,
58 int channel, int size)
60 channels[channel].scan_type.sign = 's';
61 /* Real storage bits will change based on the report desc. */
62 channels[channel].scan_type.realbits = size * 8;
63 /* Maximum size of a sample to capture is u32 */
64 channels[channel].scan_type.storagebits = sizeof(u32) * 8;
67 /* Channel read_raw handler */
68 static int als_read_raw(struct iio_dev *indio_dev,
69 struct iio_chan_spec const *chan,
73 struct als_state *als_state = iio_priv(indio_dev);
83 switch (chan->scan_index) {
84 case CHANNEL_SCAN_INDEX_ILLUM:
85 report_id = als_state->als_illum.report_id;
87 HID_USAGE_SENSOR_LIGHT_ILLUM;
94 *val = sensor_hub_input_attr_get_raw_value(
95 als_state->common_attributes.hsdev,
96 HID_USAGE_SENSOR_ALS, address,
102 ret_type = IIO_VAL_INT;
104 case IIO_CHAN_INFO_SCALE:
105 *val = als_state->als_illum.units;
106 ret_type = IIO_VAL_INT;
108 case IIO_CHAN_INFO_OFFSET:
109 *val = hid_sensor_convert_exponent(
110 als_state->als_illum.unit_expo);
111 ret_type = IIO_VAL_INT;
113 case IIO_CHAN_INFO_SAMP_FREQ:
114 ret = hid_sensor_read_samp_freq_value(
115 &als_state->common_attributes, val, val2);
116 ret_type = IIO_VAL_INT_PLUS_MICRO;
118 case IIO_CHAN_INFO_HYSTERESIS:
119 ret = hid_sensor_read_raw_hyst_value(
120 &als_state->common_attributes, val, val2);
121 ret_type = IIO_VAL_INT_PLUS_MICRO;
131 /* Channel write_raw handler */
132 static int als_write_raw(struct iio_dev *indio_dev,
133 struct iio_chan_spec const *chan,
138 struct als_state *als_state = iio_priv(indio_dev);
142 case IIO_CHAN_INFO_SAMP_FREQ:
143 ret = hid_sensor_write_samp_freq_value(
144 &als_state->common_attributes, val, val2);
146 case IIO_CHAN_INFO_HYSTERESIS:
147 ret = hid_sensor_write_raw_hyst_value(
148 &als_state->common_attributes, val, val2);
157 static const struct iio_info als_info = {
158 .driver_module = THIS_MODULE,
159 .read_raw = &als_read_raw,
160 .write_raw = &als_write_raw,
163 /* Function to push data to buffer */
164 static void hid_sensor_push_data(struct iio_dev *indio_dev, const void *data,
167 dev_dbg(&indio_dev->dev, "hid_sensor_push_data\n");
168 iio_push_to_buffers(indio_dev, data);
171 /* Callback handler to send event after all samples are received and captured */
172 static int als_proc_event(struct hid_sensor_hub_device *hsdev,
176 struct iio_dev *indio_dev = platform_get_drvdata(priv);
177 struct als_state *als_state = iio_priv(indio_dev);
179 dev_dbg(&indio_dev->dev, "als_proc_event [%d]\n",
180 als_state->common_attributes.data_ready);
181 if (als_state->common_attributes.data_ready)
182 hid_sensor_push_data(indio_dev,
184 sizeof(als_state->illum));
189 /* Capture samples in local storage */
190 static int als_capture_sample(struct hid_sensor_hub_device *hsdev,
192 size_t raw_len, char *raw_data,
195 struct iio_dev *indio_dev = platform_get_drvdata(priv);
196 struct als_state *als_state = iio_priv(indio_dev);
200 case HID_USAGE_SENSOR_LIGHT_ILLUM:
201 als_state->illum = *(u32 *)raw_data;
211 /* Parse report which is specific to an usage id*/
212 static int als_parse_report(struct platform_device *pdev,
213 struct hid_sensor_hub_device *hsdev,
214 struct iio_chan_spec *channels,
216 struct als_state *st)
220 ret = sensor_hub_input_get_attribute_info(hsdev, HID_INPUT_REPORT,
222 HID_USAGE_SENSOR_LIGHT_ILLUM,
226 als_adjust_channel_bit_mask(channels, CHANNEL_SCAN_INDEX_ILLUM,
229 dev_dbg(&pdev->dev, "als %x:%x\n", st->als_illum.index,
230 st->als_illum.report_id);
235 /* Function to initialize the processing for usage id */
236 static int hid_als_probe(struct platform_device *pdev)
239 static const char *name = "als";
240 struct iio_dev *indio_dev;
241 struct als_state *als_state;
242 struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
243 struct iio_chan_spec *channels;
245 indio_dev = devm_iio_device_alloc(&pdev->dev, sizeof(struct als_state));
248 platform_set_drvdata(pdev, indio_dev);
250 als_state = iio_priv(indio_dev);
251 als_state->common_attributes.hsdev = hsdev;
252 als_state->common_attributes.pdev = pdev;
254 ret = hid_sensor_parse_common_attributes(hsdev, HID_USAGE_SENSOR_ALS,
255 &als_state->common_attributes);
257 dev_err(&pdev->dev, "failed to setup common attributes\n");
261 channels = kmemdup(als_channels, sizeof(als_channels), GFP_KERNEL);
263 dev_err(&pdev->dev, "failed to duplicate channels\n");
267 ret = als_parse_report(pdev, hsdev, channels,
268 HID_USAGE_SENSOR_ALS, als_state);
270 dev_err(&pdev->dev, "failed to setup attributes\n");
271 goto error_free_dev_mem;
274 indio_dev->channels = channels;
275 indio_dev->num_channels =
276 ARRAY_SIZE(als_channels);
277 indio_dev->dev.parent = &pdev->dev;
278 indio_dev->info = &als_info;
279 indio_dev->name = name;
280 indio_dev->modes = INDIO_DIRECT_MODE;
282 ret = iio_triggered_buffer_setup(indio_dev, &iio_pollfunc_store_time,
285 dev_err(&pdev->dev, "failed to initialize trigger buffer\n");
286 goto error_free_dev_mem;
288 als_state->common_attributes.data_ready = false;
289 ret = hid_sensor_setup_trigger(indio_dev, name,
290 &als_state->common_attributes);
292 dev_err(&pdev->dev, "trigger setup failed\n");
293 goto error_unreg_buffer_funcs;
296 ret = iio_device_register(indio_dev);
298 dev_err(&pdev->dev, "device register failed\n");
299 goto error_remove_trigger;
302 als_state->callbacks.send_event = als_proc_event;
303 als_state->callbacks.capture_sample = als_capture_sample;
304 als_state->callbacks.pdev = pdev;
305 ret = sensor_hub_register_callback(hsdev, HID_USAGE_SENSOR_ALS,
306 &als_state->callbacks);
308 dev_err(&pdev->dev, "callback reg failed\n");
309 goto error_iio_unreg;
315 iio_device_unregister(indio_dev);
316 error_remove_trigger:
317 hid_sensor_remove_trigger(indio_dev);
318 error_unreg_buffer_funcs:
319 iio_triggered_buffer_cleanup(indio_dev);
321 kfree(indio_dev->channels);
325 /* Function to deinitialize the processing for usage id */
326 static int hid_als_remove(struct platform_device *pdev)
328 struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
329 struct iio_dev *indio_dev = platform_get_drvdata(pdev);
331 sensor_hub_remove_callback(hsdev, HID_USAGE_SENSOR_ALS);
332 iio_device_unregister(indio_dev);
333 hid_sensor_remove_trigger(indio_dev);
334 iio_triggered_buffer_cleanup(indio_dev);
335 kfree(indio_dev->channels);
340 static struct platform_device_id hid_als_ids[] = {
342 /* Format: HID-SENSOR-usage_id_in_hex_lowercase */
343 .name = "HID-SENSOR-200041",
347 MODULE_DEVICE_TABLE(platform, hid_als_ids);
349 static struct platform_driver hid_als_platform_driver = {
350 .id_table = hid_als_ids,
352 .name = KBUILD_MODNAME,
353 .owner = THIS_MODULE,
355 .probe = hid_als_probe,
356 .remove = hid_als_remove,
358 module_platform_driver(hid_als_platform_driver);
360 MODULE_DESCRIPTION("HID Sensor ALS");
361 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
362 MODULE_LICENSE("GPL");