1 // SPDX-License-Identifier: GPL-2.0-only 2 /* 3 * HID Sensors Driver 4 * Copyright (c) 2012, Intel Corporation. 5 */ 6 #include <linux/bitops.h> 7 #include <linux/device.h> 8 #include <linux/platform_device.h> 9 #include <linux/module.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, 18 CHANNEL_SCAN_INDEX_ILLUM, 19 CHANNEL_SCAN_INDEX_COLOR_TEMP, 20 CHANNEL_SCAN_INDEX_CHROMATICITY_X, 21 CHANNEL_SCAN_INDEX_CHROMATICITY_Y, 22 CHANNEL_SCAN_INDEX_MAX 23 }; 24 25 #define CHANNEL_SCAN_INDEX_TIMESTAMP CHANNEL_SCAN_INDEX_MAX 26 27 struct als_state { 28 struct hid_sensor_hub_callbacks callbacks; 29 struct hid_sensor_common common_attributes; 30 struct hid_sensor_hub_attribute_info als[CHANNEL_SCAN_INDEX_MAX]; 31 struct iio_chan_spec channels[CHANNEL_SCAN_INDEX_MAX + 1]; 32 struct { 33 u32 illum[CHANNEL_SCAN_INDEX_MAX]; 34 aligned_s64 timestamp; 35 } scan; 36 int scale_pre_decml; 37 int scale_post_decml; 38 int scale_precision; 39 int value_offset; 40 int num_channels; 41 s64 timestamp; 42 unsigned long als_scan_mask[2]; 43 }; 44 45 /* The order of usage ids must match scan index starting from CHANNEL_SCAN_INDEX_INTENSITY */ 46 static const u32 als_usage_ids[] = { 47 HID_USAGE_SENSOR_LIGHT_ILLUM, 48 HID_USAGE_SENSOR_LIGHT_ILLUM, 49 HID_USAGE_SENSOR_LIGHT_COLOR_TEMPERATURE, 50 HID_USAGE_SENSOR_LIGHT_CHROMATICITY_X, 51 HID_USAGE_SENSOR_LIGHT_CHROMATICITY_Y, 52 }; 53 54 static const u32 als_sensitivity_addresses[] = { 55 HID_USAGE_SENSOR_DATA_LIGHT, 56 HID_USAGE_SENSOR_LIGHT_ILLUM, 57 }; 58 59 /* Channel definitions */ 60 static const struct iio_chan_spec als_channels[] = { 61 { 62 .type = IIO_INTENSITY, 63 .modified = 1, 64 .channel2 = IIO_MOD_LIGHT_BOTH, 65 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), 66 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) | 67 BIT(IIO_CHAN_INFO_SCALE) | 68 BIT(IIO_CHAN_INFO_SAMP_FREQ) | 69 BIT(IIO_CHAN_INFO_HYSTERESIS) | 70 BIT(IIO_CHAN_INFO_HYSTERESIS_RELATIVE), 71 .scan_index = CHANNEL_SCAN_INDEX_INTENSITY, 72 }, 73 { 74 .type = IIO_LIGHT, 75 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), 76 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) | 77 BIT(IIO_CHAN_INFO_SCALE) | 78 BIT(IIO_CHAN_INFO_SAMP_FREQ) | 79 BIT(IIO_CHAN_INFO_HYSTERESIS) | 80 BIT(IIO_CHAN_INFO_HYSTERESIS_RELATIVE), 81 .scan_index = CHANNEL_SCAN_INDEX_ILLUM, 82 }, 83 { 84 .type = IIO_COLORTEMP, 85 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), 86 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) | 87 BIT(IIO_CHAN_INFO_SCALE) | 88 BIT(IIO_CHAN_INFO_SAMP_FREQ) | 89 BIT(IIO_CHAN_INFO_HYSTERESIS) | 90 BIT(IIO_CHAN_INFO_HYSTERESIS_RELATIVE), 91 .scan_index = CHANNEL_SCAN_INDEX_COLOR_TEMP, 92 }, 93 { 94 .type = IIO_CHROMATICITY, 95 .modified = 1, 96 .channel2 = IIO_MOD_X, 97 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), 98 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) | 99 BIT(IIO_CHAN_INFO_SCALE) | 100 BIT(IIO_CHAN_INFO_SAMP_FREQ) | 101 BIT(IIO_CHAN_INFO_HYSTERESIS) | 102 BIT(IIO_CHAN_INFO_HYSTERESIS_RELATIVE), 103 .scan_index = CHANNEL_SCAN_INDEX_CHROMATICITY_X, 104 }, 105 { 106 .type = IIO_CHROMATICITY, 107 .modified = 1, 108 .channel2 = IIO_MOD_Y, 109 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), 110 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) | 111 BIT(IIO_CHAN_INFO_SCALE) | 112 BIT(IIO_CHAN_INFO_SAMP_FREQ) | 113 BIT(IIO_CHAN_INFO_HYSTERESIS) | 114 BIT(IIO_CHAN_INFO_HYSTERESIS_RELATIVE), 115 .scan_index = CHANNEL_SCAN_INDEX_CHROMATICITY_Y, 116 }, 117 IIO_CHAN_SOFT_TIMESTAMP(CHANNEL_SCAN_INDEX_TIMESTAMP) 118 }; 119 120 /* Channel read_raw handler */ 121 static int als_read_raw(struct iio_dev *indio_dev, 122 struct iio_chan_spec const *chan, 123 int *val, int *val2, 124 long mask) 125 { 126 struct als_state *als_state = iio_priv(indio_dev); 127 struct hid_sensor_hub_device *hsdev = als_state->common_attributes.hsdev; 128 int report_id = -1; 129 u32 address; 130 int ret_type; 131 s32 min; 132 133 *val = 0; 134 *val2 = 0; 135 switch (mask) { 136 case IIO_CHAN_INFO_RAW: 137 switch (chan->scan_index) { 138 case CHANNEL_SCAN_INDEX_INTENSITY: 139 case CHANNEL_SCAN_INDEX_ILLUM: 140 report_id = als_state->als[chan->scan_index].report_id; 141 min = als_state->als[chan->scan_index].logical_minimum; 142 address = HID_USAGE_SENSOR_LIGHT_ILLUM; 143 break; 144 case CHANNEL_SCAN_INDEX_COLOR_TEMP: 145 report_id = als_state->als[chan->scan_index].report_id; 146 min = als_state->als[chan->scan_index].logical_minimum; 147 address = HID_USAGE_SENSOR_LIGHT_COLOR_TEMPERATURE; 148 break; 149 case CHANNEL_SCAN_INDEX_CHROMATICITY_X: 150 report_id = als_state->als[chan->scan_index].report_id; 151 min = als_state->als[chan->scan_index].logical_minimum; 152 address = HID_USAGE_SENSOR_LIGHT_CHROMATICITY_X; 153 break; 154 case CHANNEL_SCAN_INDEX_CHROMATICITY_Y: 155 report_id = als_state->als[chan->scan_index].report_id; 156 min = als_state->als[chan->scan_index].logical_minimum; 157 address = HID_USAGE_SENSOR_LIGHT_CHROMATICITY_Y; 158 break; 159 default: 160 report_id = -1; 161 break; 162 } 163 if (report_id >= 0) { 164 hid_sensor_power_state(&als_state->common_attributes, 165 true); 166 *val = sensor_hub_input_attr_get_raw_value( 167 hsdev, hsdev->usage, address, report_id, 168 SENSOR_HUB_SYNC, min < 0); 169 hid_sensor_power_state(&als_state->common_attributes, 170 false); 171 } else { 172 *val = 0; 173 return -EINVAL; 174 } 175 ret_type = IIO_VAL_INT; 176 break; 177 case IIO_CHAN_INFO_SCALE: 178 *val = als_state->scale_pre_decml; 179 *val2 = als_state->scale_post_decml; 180 ret_type = als_state->scale_precision; 181 break; 182 case IIO_CHAN_INFO_OFFSET: 183 *val = als_state->value_offset; 184 ret_type = IIO_VAL_INT; 185 break; 186 case IIO_CHAN_INFO_SAMP_FREQ: 187 ret_type = hid_sensor_read_samp_freq_value( 188 &als_state->common_attributes, val, val2); 189 break; 190 case IIO_CHAN_INFO_HYSTERESIS: 191 ret_type = hid_sensor_read_raw_hyst_value( 192 &als_state->common_attributes, val, val2); 193 break; 194 case IIO_CHAN_INFO_HYSTERESIS_RELATIVE: 195 ret_type = hid_sensor_read_raw_hyst_rel_value( 196 &als_state->common_attributes, val, val2); 197 break; 198 default: 199 ret_type = -EINVAL; 200 break; 201 } 202 203 return ret_type; 204 } 205 206 /* Channel write_raw handler */ 207 static int als_write_raw(struct iio_dev *indio_dev, 208 struct iio_chan_spec const *chan, 209 int val, 210 int val2, 211 long mask) 212 { 213 struct als_state *als_state = iio_priv(indio_dev); 214 int ret = 0; 215 216 switch (mask) { 217 case IIO_CHAN_INFO_SAMP_FREQ: 218 ret = hid_sensor_write_samp_freq_value( 219 &als_state->common_attributes, val, val2); 220 break; 221 case IIO_CHAN_INFO_HYSTERESIS: 222 ret = hid_sensor_write_raw_hyst_value( 223 &als_state->common_attributes, val, val2); 224 break; 225 case IIO_CHAN_INFO_HYSTERESIS_RELATIVE: 226 ret = hid_sensor_write_raw_hyst_rel_value( 227 &als_state->common_attributes, val, val2); 228 break; 229 default: 230 ret = -EINVAL; 231 } 232 233 return ret; 234 } 235 236 static const struct iio_info als_info = { 237 .read_raw = &als_read_raw, 238 .write_raw = &als_write_raw, 239 }; 240 241 /* Callback handler to send event after all samples are received and captured */ 242 static int als_proc_event(struct hid_sensor_hub_device *hsdev, 243 unsigned usage_id, 244 void *priv) 245 { 246 struct iio_dev *indio_dev = platform_get_drvdata(priv); 247 struct als_state *als_state = iio_priv(indio_dev); 248 249 dev_dbg(&indio_dev->dev, "als_proc_event\n"); 250 if (atomic_read(&als_state->common_attributes.data_ready)) { 251 if (!als_state->timestamp) 252 als_state->timestamp = iio_get_time_ns(indio_dev); 253 254 iio_push_to_buffers_with_ts(indio_dev, &als_state->scan, 255 sizeof(als_state->scan), 256 als_state->timestamp); 257 als_state->timestamp = 0; 258 } 259 260 return 0; 261 } 262 263 /* Capture samples in local storage */ 264 static int als_capture_sample(struct hid_sensor_hub_device *hsdev, 265 unsigned usage_id, 266 size_t raw_len, char *raw_data, 267 void *priv) 268 { 269 struct iio_dev *indio_dev = platform_get_drvdata(priv); 270 struct als_state *als_state = iio_priv(indio_dev); 271 int ret = -EINVAL; 272 u32 sample_data = *(u32 *)raw_data; 273 274 switch (usage_id) { 275 case HID_USAGE_SENSOR_LIGHT_ILLUM: 276 als_state->scan.illum[CHANNEL_SCAN_INDEX_INTENSITY] = sample_data; 277 als_state->scan.illum[CHANNEL_SCAN_INDEX_ILLUM] = sample_data; 278 ret = 0; 279 break; 280 case HID_USAGE_SENSOR_LIGHT_COLOR_TEMPERATURE: 281 als_state->scan.illum[CHANNEL_SCAN_INDEX_COLOR_TEMP] = sample_data; 282 ret = 0; 283 break; 284 case HID_USAGE_SENSOR_LIGHT_CHROMATICITY_X: 285 als_state->scan.illum[CHANNEL_SCAN_INDEX_CHROMATICITY_X] = sample_data; 286 ret = 0; 287 break; 288 case HID_USAGE_SENSOR_LIGHT_CHROMATICITY_Y: 289 als_state->scan.illum[CHANNEL_SCAN_INDEX_CHROMATICITY_Y] = sample_data; 290 ret = 0; 291 break; 292 case HID_USAGE_SENSOR_TIME_TIMESTAMP: 293 als_state->timestamp = hid_sensor_convert_timestamp(&als_state->common_attributes, 294 *(s64 *)raw_data); 295 ret = 0; 296 break; 297 default: 298 break; 299 } 300 301 return ret; 302 } 303 304 /* Parse report which is specific to an usage id*/ 305 static int als_parse_report(struct platform_device *pdev, 306 struct hid_sensor_hub_device *hsdev, 307 unsigned usage_id, 308 struct als_state *st) 309 { 310 struct iio_chan_spec *channels; 311 int ret, index = 0; 312 int i; 313 314 channels = st->channels; 315 316 for (i = 0; i < CHANNEL_SCAN_INDEX_MAX; ++i) { 317 ret = sensor_hub_input_get_attribute_info(hsdev, 318 HID_INPUT_REPORT, 319 usage_id, 320 als_usage_ids[i], 321 &st->als[i]); 322 if (ret < 0) 323 continue; 324 325 channels[index] = als_channels[i]; 326 st->als_scan_mask[0] |= BIT(i); 327 channels[index].scan_type = (struct iio_scan_type) { 328 .format = 's', 329 .realbits = BYTES_TO_BITS(st->als[i].size), 330 .storagebits = BITS_PER_TYPE(u32), 331 }; 332 ++index; 333 334 dev_dbg(&pdev->dev, "als %x:%x\n", st->als[i].index, 335 st->als[i].report_id); 336 } 337 338 st->num_channels = index; 339 /* Return success even if one usage id is present */ 340 if (index) 341 ret = 0; 342 343 st->scale_precision = hid_sensor_format_scale(usage_id, 344 &st->als[CHANNEL_SCAN_INDEX_INTENSITY], 345 &st->scale_pre_decml, &st->scale_post_decml); 346 347 return ret; 348 } 349 350 /* Function to initialize the processing for usage id */ 351 static int hid_als_probe(struct platform_device *pdev) 352 { 353 struct hid_sensor_hub_device *hsdev = dev_get_platdata(&pdev->dev); 354 int ret = 0; 355 static const char *name = "als"; 356 struct iio_dev *indio_dev; 357 struct als_state *als_state; 358 359 indio_dev = devm_iio_device_alloc(&pdev->dev, sizeof(struct als_state)); 360 if (!indio_dev) 361 return -ENOMEM; 362 platform_set_drvdata(pdev, indio_dev); 363 364 als_state = iio_priv(indio_dev); 365 als_state->common_attributes.hsdev = hsdev; 366 als_state->common_attributes.pdev = pdev; 367 368 ret = hid_sensor_parse_common_attributes(hsdev, 369 hsdev->usage, 370 &als_state->common_attributes, 371 als_sensitivity_addresses, 372 ARRAY_SIZE(als_sensitivity_addresses)); 373 if (ret) { 374 dev_err(&pdev->dev, "failed to setup common attributes\n"); 375 return ret; 376 } 377 378 ret = als_parse_report(pdev, hsdev, 379 hsdev->usage, 380 als_state); 381 if (ret) { 382 dev_err(&pdev->dev, "failed to setup attributes\n"); 383 return ret; 384 } 385 386 /* Add timestamp channel */ 387 als_state->channels[als_state->num_channels] = als_channels[CHANNEL_SCAN_INDEX_TIMESTAMP]; 388 389 /* +1 for adding timestamp channel */ 390 indio_dev->num_channels = als_state->num_channels + 1; 391 392 indio_dev->channels = als_state->channels; 393 indio_dev->available_scan_masks = als_state->als_scan_mask; 394 395 indio_dev->info = &als_info; 396 indio_dev->name = name; 397 indio_dev->modes = INDIO_DIRECT_MODE; 398 399 atomic_set(&als_state->common_attributes.data_ready, 0); 400 401 ret = hid_sensor_setup_trigger(indio_dev, name, 402 &als_state->common_attributes); 403 if (ret < 0) { 404 dev_err(&pdev->dev, "trigger setup failed\n"); 405 return ret; 406 } 407 408 ret = iio_device_register(indio_dev); 409 if (ret) { 410 dev_err(&pdev->dev, "device register failed\n"); 411 goto error_remove_trigger; 412 } 413 414 als_state->callbacks.send_event = als_proc_event; 415 als_state->callbacks.capture_sample = als_capture_sample; 416 als_state->callbacks.pdev = pdev; 417 ret = sensor_hub_register_callback(hsdev, hsdev->usage, &als_state->callbacks); 418 if (ret < 0) { 419 dev_err(&pdev->dev, "callback reg failed\n"); 420 goto error_iio_unreg; 421 } 422 423 return ret; 424 425 error_iio_unreg: 426 iio_device_unregister(indio_dev); 427 error_remove_trigger: 428 hid_sensor_remove_trigger(indio_dev, &als_state->common_attributes); 429 return ret; 430 } 431 432 /* Function to deinitialize the processing for usage id */ 433 static void hid_als_remove(struct platform_device *pdev) 434 { 435 struct hid_sensor_hub_device *hsdev = dev_get_platdata(&pdev->dev); 436 struct iio_dev *indio_dev = platform_get_drvdata(pdev); 437 struct als_state *als_state = iio_priv(indio_dev); 438 439 sensor_hub_remove_callback(hsdev, hsdev->usage); 440 iio_device_unregister(indio_dev); 441 hid_sensor_remove_trigger(indio_dev, &als_state->common_attributes); 442 } 443 444 static const struct platform_device_id hid_als_ids[] = { 445 { 446 /* Format: HID-SENSOR-usage_id_in_hex_lowercase */ 447 .name = "HID-SENSOR-200041", 448 }, 449 { 450 /* Format: HID-SENSOR-custom_sensor_tag-usage_id_in_hex_lowercase */ 451 .name = "HID-SENSOR-LISS-0041", 452 }, 453 { } 454 }; 455 MODULE_DEVICE_TABLE(platform, hid_als_ids); 456 457 static struct platform_driver hid_als_platform_driver = { 458 .id_table = hid_als_ids, 459 .driver = { 460 .name = KBUILD_MODNAME, 461 .pm = &hid_sensor_pm_ops, 462 }, 463 .probe = hid_als_probe, 464 .remove = hid_als_remove, 465 }; 466 module_platform_driver(hid_als_platform_driver); 467 468 MODULE_DESCRIPTION("HID Sensor ALS"); 469 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>"); 470 MODULE_LICENSE("GPL"); 471 MODULE_IMPORT_NS("IIO_HID"); 472