1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * HID Sensors Driver
4  * Copyright (c) 2012, Intel Corporation.
5  */
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"
15 
16 enum {
17 	CHANNEL_SCAN_INDEX_INTENSITY = 0,
18 	CHANNEL_SCAN_INDEX_ILLUM = 1,
19 	CHANNEL_SCAN_INDEX_MAX
20 };
21 
22 #define CHANNEL_SCAN_INDEX_TIMESTAMP CHANNEL_SCAN_INDEX_MAX
23 
24 struct als_state {
25 	struct hid_sensor_hub_callbacks callbacks;
26 	struct hid_sensor_common common_attributes;
27 	struct hid_sensor_hub_attribute_info als_illum;
28 	struct {
29 		u32 illum[CHANNEL_SCAN_INDEX_MAX];
30 		u64 timestamp __aligned(8);
31 	} scan;
32 	int scale_pre_decml;
33 	int scale_post_decml;
34 	int scale_precision;
35 	int value_offset;
36 	s64 timestamp;
37 };
38 
39 static const u32 als_sensitivity_addresses[] = {
40 	HID_USAGE_SENSOR_DATA_LIGHT,
41 	HID_USAGE_SENSOR_LIGHT_ILLUM,
42 };
43 
44 /* Channel definitions */
45 static const struct iio_chan_spec als_channels[] = {
46 	{
47 		.type = IIO_INTENSITY,
48 		.modified = 1,
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,
57 	},
58 	{
59 		.type = IIO_LIGHT,
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,
67 	},
68 	IIO_CHAN_SOFT_TIMESTAMP(CHANNEL_SCAN_INDEX_TIMESTAMP)
69 };
70 
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)
74 {
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;
80 }
81 
82 /* Channel read_raw handler */
83 static int als_read_raw(struct iio_dev *indio_dev,
84 			      struct iio_chan_spec const *chan,
85 			      int *val, int *val2,
86 			      long mask)
87 {
88 	struct als_state *als_state = iio_priv(indio_dev);
89 	struct hid_sensor_hub_device *hsdev = als_state->common_attributes.hsdev;
90 	int report_id = -1;
91 	u32 address;
92 	int ret_type;
93 	s32 min;
94 
95 	*val = 0;
96 	*val2 = 0;
97 	switch (mask) {
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_illum.report_id;
103 			min = als_state->als_illum.logical_minimum;
104 			address = HID_USAGE_SENSOR_LIGHT_ILLUM;
105 			break;
106 		default:
107 			report_id = -1;
108 			break;
109 		}
110 		if (report_id >= 0) {
111 			hid_sensor_power_state(&als_state->common_attributes,
112 						true);
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,
117 						false);
118 		} else {
119 			*val = 0;
120 			return -EINVAL;
121 		}
122 		ret_type = IIO_VAL_INT;
123 		break;
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;
128 		break;
129 	case IIO_CHAN_INFO_OFFSET:
130 		*val = als_state->value_offset;
131 		ret_type = IIO_VAL_INT;
132 		break;
133 	case IIO_CHAN_INFO_SAMP_FREQ:
134 		ret_type = hid_sensor_read_samp_freq_value(
135 				&als_state->common_attributes, val, val2);
136 		break;
137 	case IIO_CHAN_INFO_HYSTERESIS:
138 		ret_type = hid_sensor_read_raw_hyst_value(
139 				&als_state->common_attributes, val, val2);
140 		break;
141 	case IIO_CHAN_INFO_HYSTERESIS_RELATIVE:
142 		ret_type = hid_sensor_read_raw_hyst_rel_value(
143 				&als_state->common_attributes, val, val2);
144 		break;
145 	default:
146 		ret_type = -EINVAL;
147 		break;
148 	}
149 
150 	return ret_type;
151 }
152 
153 /* Channel write_raw handler */
154 static int als_write_raw(struct iio_dev *indio_dev,
155 			       struct iio_chan_spec const *chan,
156 			       int val,
157 			       int val2,
158 			       long mask)
159 {
160 	struct als_state *als_state = iio_priv(indio_dev);
161 	int ret = 0;
162 
163 	switch (mask) {
164 	case IIO_CHAN_INFO_SAMP_FREQ:
165 		ret = hid_sensor_write_samp_freq_value(
166 				&als_state->common_attributes, val, val2);
167 		break;
168 	case IIO_CHAN_INFO_HYSTERESIS:
169 		ret = hid_sensor_write_raw_hyst_value(
170 				&als_state->common_attributes, val, val2);
171 		break;
172 	case IIO_CHAN_INFO_HYSTERESIS_RELATIVE:
173 		ret = hid_sensor_write_raw_hyst_rel_value(
174 				&als_state->common_attributes, val, val2);
175 		break;
176 	default:
177 		ret = -EINVAL;
178 	}
179 
180 	return ret;
181 }
182 
183 static const struct iio_info als_info = {
184 	.read_raw = &als_read_raw,
185 	.write_raw = &als_write_raw,
186 };
187 
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,
190 				unsigned usage_id,
191 				void *priv)
192 {
193 	struct iio_dev *indio_dev = platform_get_drvdata(priv);
194 	struct als_state *als_state = iio_priv(indio_dev);
195 
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);
200 
201 		iio_push_to_buffers_with_timestamp(indio_dev, &als_state->scan,
202 						   als_state->timestamp);
203 		als_state->timestamp = 0;
204 	}
205 
206 	return 0;
207 }
208 
209 /* Capture samples in local storage */
210 static int als_capture_sample(struct hid_sensor_hub_device *hsdev,
211 				unsigned usage_id,
212 				size_t raw_len, char *raw_data,
213 				void *priv)
214 {
215 	struct iio_dev *indio_dev = platform_get_drvdata(priv);
216 	struct als_state *als_state = iio_priv(indio_dev);
217 	int ret = -EINVAL;
218 	u32 sample_data = *(u32 *)raw_data;
219 
220 	switch (usage_id) {
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;
224 		ret = 0;
225 		break;
226 	case HID_USAGE_SENSOR_TIME_TIMESTAMP:
227 		als_state->timestamp = hid_sensor_convert_timestamp(&als_state->common_attributes,
228 								    *(s64 *)raw_data);
229 		break;
230 	default:
231 		break;
232 	}
233 
234 	return ret;
235 }
236 
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,
241 				unsigned usage_id,
242 				struct als_state *st)
243 {
244 	int ret;
245 
246 	ret = sensor_hub_input_get_attribute_info(hsdev, HID_INPUT_REPORT,
247 			usage_id,
248 			HID_USAGE_SENSOR_LIGHT_ILLUM,
249 			&st->als_illum);
250 	if (ret < 0)
251 		return ret;
252 	als_adjust_channel_bit_mask(channels, CHANNEL_SCAN_INDEX_INTENSITY,
253 				    st->als_illum.size);
254 	als_adjust_channel_bit_mask(channels, CHANNEL_SCAN_INDEX_ILLUM,
255 					st->als_illum.size);
256 
257 	dev_dbg(&pdev->dev, "als %x:%x\n", st->als_illum.index,
258 			st->als_illum.report_id);
259 
260 	st->scale_precision = hid_sensor_format_scale(usage_id, &st->als_illum,
261 				&st->scale_pre_decml, &st->scale_post_decml);
262 
263 	return ret;
264 }
265 
266 /* Function to initialize the processing for usage id */
267 static int hid_als_probe(struct platform_device *pdev)
268 {
269 	int ret = 0;
270 	static const char *name = "als";
271 	struct iio_dev *indio_dev;
272 	struct als_state *als_state;
273 	struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
274 
275 	indio_dev = devm_iio_device_alloc(&pdev->dev, sizeof(struct als_state));
276 	if (!indio_dev)
277 		return -ENOMEM;
278 	platform_set_drvdata(pdev, indio_dev);
279 
280 	als_state = iio_priv(indio_dev);
281 	als_state->common_attributes.hsdev = hsdev;
282 	als_state->common_attributes.pdev = pdev;
283 
284 	ret = hid_sensor_parse_common_attributes(hsdev,
285 					hsdev->usage,
286 					&als_state->common_attributes,
287 					als_sensitivity_addresses,
288 					ARRAY_SIZE(als_sensitivity_addresses));
289 	if (ret) {
290 		dev_err(&pdev->dev, "failed to setup common attributes\n");
291 		return ret;
292 	}
293 
294 	indio_dev->channels = devm_kmemdup(&pdev->dev, als_channels,
295 					   sizeof(als_channels), GFP_KERNEL);
296 	if (!indio_dev->channels) {
297 		dev_err(&pdev->dev, "failed to duplicate channels\n");
298 		return -ENOMEM;
299 	}
300 
301 	ret = als_parse_report(pdev, hsdev,
302 			       (struct iio_chan_spec *)indio_dev->channels,
303 			       hsdev->usage,
304 			       als_state);
305 	if (ret) {
306 		dev_err(&pdev->dev, "failed to setup attributes\n");
307 		return ret;
308 	}
309 
310 	indio_dev->num_channels =
311 				ARRAY_SIZE(als_channels);
312 	indio_dev->info = &als_info;
313 	indio_dev->name = name;
314 	indio_dev->modes = INDIO_DIRECT_MODE;
315 
316 	atomic_set(&als_state->common_attributes.data_ready, 0);
317 
318 	ret = hid_sensor_setup_trigger(indio_dev, name,
319 				&als_state->common_attributes);
320 	if (ret < 0) {
321 		dev_err(&pdev->dev, "trigger setup failed\n");
322 		return ret;
323 	}
324 
325 	ret = iio_device_register(indio_dev);
326 	if (ret) {
327 		dev_err(&pdev->dev, "device register failed\n");
328 		goto error_remove_trigger;
329 	}
330 
331 	als_state->callbacks.send_event = als_proc_event;
332 	als_state->callbacks.capture_sample = als_capture_sample;
333 	als_state->callbacks.pdev = pdev;
334 	ret = sensor_hub_register_callback(hsdev, hsdev->usage, &als_state->callbacks);
335 	if (ret < 0) {
336 		dev_err(&pdev->dev, "callback reg failed\n");
337 		goto error_iio_unreg;
338 	}
339 
340 	return ret;
341 
342 error_iio_unreg:
343 	iio_device_unregister(indio_dev);
344 error_remove_trigger:
345 	hid_sensor_remove_trigger(indio_dev, &als_state->common_attributes);
346 	return ret;
347 }
348 
349 /* Function to deinitialize the processing for usage id */
350 static int hid_als_remove(struct platform_device *pdev)
351 {
352 	struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
353 	struct iio_dev *indio_dev = platform_get_drvdata(pdev);
354 	struct als_state *als_state = iio_priv(indio_dev);
355 
356 	sensor_hub_remove_callback(hsdev, hsdev->usage);
357 	iio_device_unregister(indio_dev);
358 	hid_sensor_remove_trigger(indio_dev, &als_state->common_attributes);
359 
360 	return 0;
361 }
362 
363 static const struct platform_device_id hid_als_ids[] = {
364 	{
365 		/* Format: HID-SENSOR-usage_id_in_hex_lowercase */
366 		.name = "HID-SENSOR-200041",
367 	},
368 	{
369 		/* Format: HID-SENSOR-custom_sensor_tag-usage_id_in_hex_lowercase */
370 		.name = "HID-SENSOR-LISS-0041",
371 	},
372 	{ /* sentinel */ }
373 };
374 MODULE_DEVICE_TABLE(platform, hid_als_ids);
375 
376 static struct platform_driver hid_als_platform_driver = {
377 	.id_table = hid_als_ids,
378 	.driver = {
379 		.name	= KBUILD_MODNAME,
380 		.pm	= &hid_sensor_pm_ops,
381 	},
382 	.probe		= hid_als_probe,
383 	.remove		= hid_als_remove,
384 };
385 module_platform_driver(hid_als_platform_driver);
386 
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);
391