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