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