1 // SPDX-License-Identifier: GPL-2.0-only
4 * Copyright (c) 2012, Intel Corporation.
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"
17 CHANNEL_SCAN_INDEX_INTENSITY = 0,
18 CHANNEL_SCAN_INDEX_ILLUM = 1,
19 CHANNEL_SCAN_INDEX_MAX
22 #define CHANNEL_SCAN_INDEX_TIMESTAMP CHANNEL_SCAN_INDEX_MAX
25 struct hid_sensor_hub_callbacks callbacks;
26 struct hid_sensor_common common_attributes;
27 struct hid_sensor_hub_attribute_info als[CHANNEL_SCAN_INDEX_MAX];
29 u32 illum[CHANNEL_SCAN_INDEX_MAX];
30 u64 timestamp __aligned(8);
39 static const u32 als_sensitivity_addresses[] = {
40 HID_USAGE_SENSOR_DATA_LIGHT,
41 HID_USAGE_SENSOR_LIGHT_ILLUM,
44 /* Channel definitions */
45 static const struct iio_chan_spec als_channels[] = {
47 .type = IIO_INTENSITY,
49 .channel2 = IIO_MOD_LIGHT_BOTH,
50 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
51 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
52 BIT(IIO_CHAN_INFO_SCALE) |
53 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
54 BIT(IIO_CHAN_INFO_HYSTERESIS) |
55 BIT(IIO_CHAN_INFO_HYSTERESIS_RELATIVE),
56 .scan_index = CHANNEL_SCAN_INDEX_INTENSITY,
60 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
61 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
62 BIT(IIO_CHAN_INFO_SCALE) |
63 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
64 BIT(IIO_CHAN_INFO_HYSTERESIS) |
65 BIT(IIO_CHAN_INFO_HYSTERESIS_RELATIVE),
66 .scan_index = CHANNEL_SCAN_INDEX_ILLUM,
68 IIO_CHAN_SOFT_TIMESTAMP(CHANNEL_SCAN_INDEX_TIMESTAMP)
71 /* Adjust channel real bits based on report descriptor */
72 static void als_adjust_channel_bit_mask(struct iio_chan_spec *channels,
73 int channel, int size)
75 channels[channel].scan_type.sign = 's';
76 /* Real storage bits will change based on the report desc. */
77 channels[channel].scan_type.realbits = size * 8;
78 /* Maximum size of a sample to capture is u32 */
79 channels[channel].scan_type.storagebits = sizeof(u32) * 8;
82 /* Channel read_raw handler */
83 static int als_read_raw(struct iio_dev *indio_dev,
84 struct iio_chan_spec const *chan,
88 struct als_state *als_state = iio_priv(indio_dev);
89 struct hid_sensor_hub_device *hsdev = als_state->common_attributes.hsdev;
98 case IIO_CHAN_INFO_RAW:
99 switch (chan->scan_index) {
100 case CHANNEL_SCAN_INDEX_INTENSITY:
101 case CHANNEL_SCAN_INDEX_ILLUM:
102 report_id = als_state->als[chan->scan_index].report_id;
103 min = als_state->als[chan->scan_index].logical_minimum;
104 address = HID_USAGE_SENSOR_LIGHT_ILLUM;
110 if (report_id >= 0) {
111 hid_sensor_power_state(&als_state->common_attributes,
113 *val = sensor_hub_input_attr_get_raw_value(
114 hsdev, hsdev->usage, address, report_id,
115 SENSOR_HUB_SYNC, min < 0);
116 hid_sensor_power_state(&als_state->common_attributes,
122 ret_type = IIO_VAL_INT;
124 case IIO_CHAN_INFO_SCALE:
125 *val = als_state->scale_pre_decml;
126 *val2 = als_state->scale_post_decml;
127 ret_type = als_state->scale_precision;
129 case IIO_CHAN_INFO_OFFSET:
130 *val = als_state->value_offset;
131 ret_type = IIO_VAL_INT;
133 case IIO_CHAN_INFO_SAMP_FREQ:
134 ret_type = hid_sensor_read_samp_freq_value(
135 &als_state->common_attributes, val, val2);
137 case IIO_CHAN_INFO_HYSTERESIS:
138 ret_type = hid_sensor_read_raw_hyst_value(
139 &als_state->common_attributes, val, val2);
141 case IIO_CHAN_INFO_HYSTERESIS_RELATIVE:
142 ret_type = hid_sensor_read_raw_hyst_rel_value(
143 &als_state->common_attributes, val, val2);
153 /* Channel write_raw handler */
154 static int als_write_raw(struct iio_dev *indio_dev,
155 struct iio_chan_spec const *chan,
160 struct als_state *als_state = iio_priv(indio_dev);
164 case IIO_CHAN_INFO_SAMP_FREQ:
165 ret = hid_sensor_write_samp_freq_value(
166 &als_state->common_attributes, val, val2);
168 case IIO_CHAN_INFO_HYSTERESIS:
169 ret = hid_sensor_write_raw_hyst_value(
170 &als_state->common_attributes, val, val2);
172 case IIO_CHAN_INFO_HYSTERESIS_RELATIVE:
173 ret = hid_sensor_write_raw_hyst_rel_value(
174 &als_state->common_attributes, val, val2);
183 static const struct iio_info als_info = {
184 .read_raw = &als_read_raw,
185 .write_raw = &als_write_raw,
188 /* Callback handler to send event after all samples are received and captured */
189 static int als_proc_event(struct hid_sensor_hub_device *hsdev,
193 struct iio_dev *indio_dev = platform_get_drvdata(priv);
194 struct als_state *als_state = iio_priv(indio_dev);
196 dev_dbg(&indio_dev->dev, "als_proc_event\n");
197 if (atomic_read(&als_state->common_attributes.data_ready)) {
198 if (!als_state->timestamp)
199 als_state->timestamp = iio_get_time_ns(indio_dev);
201 iio_push_to_buffers_with_timestamp(indio_dev, &als_state->scan,
202 als_state->timestamp);
203 als_state->timestamp = 0;
209 /* Capture samples in local storage */
210 static int als_capture_sample(struct hid_sensor_hub_device *hsdev,
212 size_t raw_len, char *raw_data,
215 struct iio_dev *indio_dev = platform_get_drvdata(priv);
216 struct als_state *als_state = iio_priv(indio_dev);
218 u32 sample_data = *(u32 *)raw_data;
221 case HID_USAGE_SENSOR_LIGHT_ILLUM:
222 als_state->scan.illum[CHANNEL_SCAN_INDEX_INTENSITY] = sample_data;
223 als_state->scan.illum[CHANNEL_SCAN_INDEX_ILLUM] = sample_data;
226 case HID_USAGE_SENSOR_TIME_TIMESTAMP:
227 als_state->timestamp = hid_sensor_convert_timestamp(&als_state->common_attributes,
237 /* Parse report which is specific to an usage id*/
238 static int als_parse_report(struct platform_device *pdev,
239 struct hid_sensor_hub_device *hsdev,
240 struct iio_chan_spec *channels,
242 struct als_state *st)
247 for (i = 0; i <= CHANNEL_SCAN_INDEX_ILLUM; ++i) {
248 ret = sensor_hub_input_get_attribute_info(hsdev,
251 HID_USAGE_SENSOR_LIGHT_ILLUM,
255 als_adjust_channel_bit_mask(channels, i, st->als[i].size);
257 dev_dbg(&pdev->dev, "als %x:%x\n", st->als[i].index,
258 st->als[i].report_id);
261 st->scale_precision = hid_sensor_format_scale(usage_id,
262 &st->als[CHANNEL_SCAN_INDEX_INTENSITY],
263 &st->scale_pre_decml, &st->scale_post_decml);
268 /* Function to initialize the processing for usage id */
269 static int hid_als_probe(struct platform_device *pdev)
272 static const char *name = "als";
273 struct iio_dev *indio_dev;
274 struct als_state *als_state;
275 struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
277 indio_dev = devm_iio_device_alloc(&pdev->dev, sizeof(struct als_state));
280 platform_set_drvdata(pdev, indio_dev);
282 als_state = iio_priv(indio_dev);
283 als_state->common_attributes.hsdev = hsdev;
284 als_state->common_attributes.pdev = pdev;
286 ret = hid_sensor_parse_common_attributes(hsdev,
288 &als_state->common_attributes,
289 als_sensitivity_addresses,
290 ARRAY_SIZE(als_sensitivity_addresses));
292 dev_err(&pdev->dev, "failed to setup common attributes\n");
296 indio_dev->channels = devm_kmemdup(&pdev->dev, als_channels,
297 sizeof(als_channels), GFP_KERNEL);
298 if (!indio_dev->channels) {
299 dev_err(&pdev->dev, "failed to duplicate channels\n");
303 ret = als_parse_report(pdev, hsdev,
304 (struct iio_chan_spec *)indio_dev->channels,
308 dev_err(&pdev->dev, "failed to setup attributes\n");
312 indio_dev->num_channels =
313 ARRAY_SIZE(als_channels);
314 indio_dev->info = &als_info;
315 indio_dev->name = name;
316 indio_dev->modes = INDIO_DIRECT_MODE;
318 atomic_set(&als_state->common_attributes.data_ready, 0);
320 ret = hid_sensor_setup_trigger(indio_dev, name,
321 &als_state->common_attributes);
323 dev_err(&pdev->dev, "trigger setup failed\n");
327 ret = iio_device_register(indio_dev);
329 dev_err(&pdev->dev, "device register failed\n");
330 goto error_remove_trigger;
333 als_state->callbacks.send_event = als_proc_event;
334 als_state->callbacks.capture_sample = als_capture_sample;
335 als_state->callbacks.pdev = pdev;
336 ret = sensor_hub_register_callback(hsdev, hsdev->usage, &als_state->callbacks);
338 dev_err(&pdev->dev, "callback reg failed\n");
339 goto error_iio_unreg;
345 iio_device_unregister(indio_dev);
346 error_remove_trigger:
347 hid_sensor_remove_trigger(indio_dev, &als_state->common_attributes);
351 /* Function to deinitialize the processing for usage id */
352 static void hid_als_remove(struct platform_device *pdev)
354 struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
355 struct iio_dev *indio_dev = platform_get_drvdata(pdev);
356 struct als_state *als_state = iio_priv(indio_dev);
358 sensor_hub_remove_callback(hsdev, hsdev->usage);
359 iio_device_unregister(indio_dev);
360 hid_sensor_remove_trigger(indio_dev, &als_state->common_attributes);
363 static const struct platform_device_id hid_als_ids[] = {
365 /* Format: HID-SENSOR-usage_id_in_hex_lowercase */
366 .name = "HID-SENSOR-200041",
369 /* Format: HID-SENSOR-custom_sensor_tag-usage_id_in_hex_lowercase */
370 .name = "HID-SENSOR-LISS-0041",
374 MODULE_DEVICE_TABLE(platform, hid_als_ids);
376 static struct platform_driver hid_als_platform_driver = {
377 .id_table = hid_als_ids,
379 .name = KBUILD_MODNAME,
380 .pm = &hid_sensor_pm_ops,
382 .probe = hid_als_probe,
383 .remove_new = hid_als_remove,
385 module_platform_driver(hid_als_platform_driver);
387 MODULE_DESCRIPTION("HID Sensor ALS");
388 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
389 MODULE_LICENSE("GPL");
390 MODULE_IMPORT_NS(IIO_HID);