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 /*Format: HID-SENSOR-usage_id_in_hex*/
34 /*Usage ID from spec for Ambiant-Light: 0x200041*/
35 #define DRIVER_NAME "HID-SENSOR-200041"
37 #define CHANNEL_SCAN_INDEX_ILLUM 0
40 struct hid_sensor_hub_callbacks callbacks;
41 struct hid_sensor_common common_attributes;
42 struct hid_sensor_hub_attribute_info als_illum;
46 /* Channel definitions */
47 static const struct iio_chan_spec als_channels[] = {
49 .type = IIO_INTENSITY,
51 .channel2 = IIO_MOD_LIGHT_BOTH,
52 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
53 BIT(IIO_CHAN_INFO_SCALE) |
54 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
55 BIT(IIO_CHAN_INFO_HYSTERESIS),
56 .scan_index = CHANNEL_SCAN_INDEX_ILLUM,
60 /* Adjust channel real bits based on report descriptor */
61 static void als_adjust_channel_bit_mask(struct iio_chan_spec *channels,
62 int channel, int size)
64 channels[channel].scan_type.sign = 's';
65 /* Real storage bits will change based on the report desc. */
66 channels[channel].scan_type.realbits = size * 8;
67 /* Maximum size of a sample to capture is u32 */
68 channels[channel].scan_type.storagebits = sizeof(u32) * 8;
71 /* Channel read_raw handler */
72 static int als_read_raw(struct iio_dev *indio_dev,
73 struct iio_chan_spec const *chan,
77 struct als_state *als_state = iio_priv(indio_dev);
87 switch (chan->scan_index) {
88 case CHANNEL_SCAN_INDEX_ILLUM:
89 report_id = als_state->als_illum.report_id;
91 HID_USAGE_SENSOR_LIGHT_ILLUM;
98 *val = sensor_hub_input_attr_get_raw_value(
99 als_state->common_attributes.hsdev,
100 HID_USAGE_SENSOR_ALS, address,
106 ret_type = IIO_VAL_INT;
108 case IIO_CHAN_INFO_SCALE:
109 *val = als_state->als_illum.units;
110 ret_type = IIO_VAL_INT;
112 case IIO_CHAN_INFO_OFFSET:
113 *val = hid_sensor_convert_exponent(
114 als_state->als_illum.unit_expo);
115 ret_type = IIO_VAL_INT;
117 case IIO_CHAN_INFO_SAMP_FREQ:
118 ret = hid_sensor_read_samp_freq_value(
119 &als_state->common_attributes, val, val2);
120 ret_type = IIO_VAL_INT_PLUS_MICRO;
122 case IIO_CHAN_INFO_HYSTERESIS:
123 ret = hid_sensor_read_raw_hyst_value(
124 &als_state->common_attributes, val, val2);
125 ret_type = IIO_VAL_INT_PLUS_MICRO;
135 /* Channel write_raw handler */
136 static int als_write_raw(struct iio_dev *indio_dev,
137 struct iio_chan_spec const *chan,
142 struct als_state *als_state = iio_priv(indio_dev);
146 case IIO_CHAN_INFO_SAMP_FREQ:
147 ret = hid_sensor_write_samp_freq_value(
148 &als_state->common_attributes, val, val2);
150 case IIO_CHAN_INFO_HYSTERESIS:
151 ret = hid_sensor_write_raw_hyst_value(
152 &als_state->common_attributes, val, val2);
161 static int als_write_raw_get_fmt(struct iio_dev *indio_dev,
162 struct iio_chan_spec const *chan,
165 return IIO_VAL_INT_PLUS_MICRO;
168 static const struct iio_info als_info = {
169 .driver_module = THIS_MODULE,
170 .read_raw = &als_read_raw,
171 .write_raw = &als_write_raw,
172 .write_raw_get_fmt = &als_write_raw_get_fmt,
175 /* Function to push data to buffer */
176 static void hid_sensor_push_data(struct iio_dev *indio_dev, u8 *data, int len)
178 dev_dbg(&indio_dev->dev, "hid_sensor_push_data\n");
179 iio_push_to_buffers(indio_dev, (u8 *)data);
182 /* Callback handler to send event after all samples are received and captured */
183 static int als_proc_event(struct hid_sensor_hub_device *hsdev,
187 struct iio_dev *indio_dev = platform_get_drvdata(priv);
188 struct als_state *als_state = iio_priv(indio_dev);
190 dev_dbg(&indio_dev->dev, "als_proc_event [%d]\n",
191 als_state->common_attributes.data_ready);
192 if (als_state->common_attributes.data_ready)
193 hid_sensor_push_data(indio_dev,
194 (u8 *)&als_state->illum,
195 sizeof(als_state->illum));
200 /* Capture samples in local storage */
201 static int als_capture_sample(struct hid_sensor_hub_device *hsdev,
203 size_t raw_len, char *raw_data,
206 struct iio_dev *indio_dev = platform_get_drvdata(priv);
207 struct als_state *als_state = iio_priv(indio_dev);
211 case HID_USAGE_SENSOR_LIGHT_ILLUM:
212 als_state->illum = *(u32 *)raw_data;
222 /* Parse report which is specific to an usage id*/
223 static int als_parse_report(struct platform_device *pdev,
224 struct hid_sensor_hub_device *hsdev,
225 struct iio_chan_spec *channels,
227 struct als_state *st)
231 ret = sensor_hub_input_get_attribute_info(hsdev, HID_INPUT_REPORT,
233 HID_USAGE_SENSOR_LIGHT_ILLUM,
237 als_adjust_channel_bit_mask(channels, CHANNEL_SCAN_INDEX_ILLUM,
240 dev_dbg(&pdev->dev, "als %x:%x\n", st->als_illum.index,
241 st->als_illum.report_id);
246 /* Function to initialize the processing for usage id */
247 static int hid_als_probe(struct platform_device *pdev)
250 static const char *name = "als";
251 struct iio_dev *indio_dev;
252 struct als_state *als_state;
253 struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
254 struct iio_chan_spec *channels;
256 indio_dev = iio_device_alloc(sizeof(struct als_state));
257 if (indio_dev == NULL) {
261 platform_set_drvdata(pdev, indio_dev);
263 als_state = iio_priv(indio_dev);
264 als_state->common_attributes.hsdev = hsdev;
265 als_state->common_attributes.pdev = pdev;
267 ret = hid_sensor_parse_common_attributes(hsdev, HID_USAGE_SENSOR_ALS,
268 &als_state->common_attributes);
270 dev_err(&pdev->dev, "failed to setup common attributes\n");
274 channels = kmemdup(als_channels, sizeof(als_channels), GFP_KERNEL);
277 dev_err(&pdev->dev, "failed to duplicate channels\n");
281 ret = als_parse_report(pdev, hsdev, channels,
282 HID_USAGE_SENSOR_ALS, als_state);
284 dev_err(&pdev->dev, "failed to setup attributes\n");
285 goto error_free_dev_mem;
288 indio_dev->channels = channels;
289 indio_dev->num_channels =
290 ARRAY_SIZE(als_channels);
291 indio_dev->dev.parent = &pdev->dev;
292 indio_dev->info = &als_info;
293 indio_dev->name = name;
294 indio_dev->modes = INDIO_DIRECT_MODE;
296 ret = iio_triggered_buffer_setup(indio_dev, &iio_pollfunc_store_time,
299 dev_err(&pdev->dev, "failed to initialize trigger buffer\n");
300 goto error_free_dev_mem;
302 als_state->common_attributes.data_ready = false;
303 ret = hid_sensor_setup_trigger(indio_dev, name,
304 &als_state->common_attributes);
306 dev_err(&pdev->dev, "trigger setup failed\n");
307 goto error_unreg_buffer_funcs;
310 ret = iio_device_register(indio_dev);
312 dev_err(&pdev->dev, "device register failed\n");
313 goto error_remove_trigger;
316 als_state->callbacks.send_event = als_proc_event;
317 als_state->callbacks.capture_sample = als_capture_sample;
318 als_state->callbacks.pdev = pdev;
319 ret = sensor_hub_register_callback(hsdev, HID_USAGE_SENSOR_ALS,
320 &als_state->callbacks);
322 dev_err(&pdev->dev, "callback reg failed\n");
323 goto error_iio_unreg;
329 iio_device_unregister(indio_dev);
330 error_remove_trigger:
331 hid_sensor_remove_trigger(indio_dev);
332 error_unreg_buffer_funcs:
333 iio_triggered_buffer_cleanup(indio_dev);
335 kfree(indio_dev->channels);
337 iio_device_free(indio_dev);
342 /* Function to deinitialize the processing for usage id */
343 static int hid_als_remove(struct platform_device *pdev)
345 struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
346 struct iio_dev *indio_dev = platform_get_drvdata(pdev);
348 sensor_hub_remove_callback(hsdev, HID_USAGE_SENSOR_ALS);
349 iio_device_unregister(indio_dev);
350 hid_sensor_remove_trigger(indio_dev);
351 iio_triggered_buffer_cleanup(indio_dev);
352 kfree(indio_dev->channels);
353 iio_device_free(indio_dev);
358 static struct platform_driver hid_als_platform_driver = {
361 .owner = THIS_MODULE,
363 .probe = hid_als_probe,
364 .remove = hid_als_remove,
366 module_platform_driver(hid_als_platform_driver);
368 MODULE_DESCRIPTION("HID Sensor ALS");
369 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
370 MODULE_LICENSE("GPL");