1 // SPDX-License-Identifier: GPL-2.0-only 2 /* 3 * HID Sensors Driver 4 * Copyright (c) 2013, Intel Corporation. 5 */ 6 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 incl_3d_channel { 17 CHANNEL_SCAN_INDEX_X, 18 CHANNEL_SCAN_INDEX_Y, 19 CHANNEL_SCAN_INDEX_Z, 20 INCLI_3D_CHANNEL_MAX, 21 }; 22 23 #define CHANNEL_SCAN_INDEX_TIMESTAMP INCLI_3D_CHANNEL_MAX 24 25 struct incl_3d_state { 26 struct hid_sensor_hub_callbacks callbacks; 27 struct hid_sensor_common common_attributes; 28 struct hid_sensor_hub_attribute_info incl[INCLI_3D_CHANNEL_MAX]; 29 struct { 30 u32 incl_val[INCLI_3D_CHANNEL_MAX]; 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 s64 timestamp; 38 }; 39 40 static const u32 incl_3d_addresses[INCLI_3D_CHANNEL_MAX] = { 41 HID_USAGE_SENSOR_ORIENT_TILT_X, 42 HID_USAGE_SENSOR_ORIENT_TILT_Y, 43 HID_USAGE_SENSOR_ORIENT_TILT_Z 44 }; 45 46 static const u32 incl_3d_sensitivity_addresses[] = { 47 HID_USAGE_SENSOR_DATA_ORIENTATION, 48 HID_USAGE_SENSOR_ORIENT_TILT, 49 }; 50 51 /* Channel definitions */ 52 static const struct iio_chan_spec incl_3d_channels[] = { 53 { 54 .type = IIO_INCLI, 55 .modified = 1, 56 .channel2 = IIO_MOD_X, 57 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), 58 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) | 59 BIT(IIO_CHAN_INFO_SCALE) | 60 BIT(IIO_CHAN_INFO_SAMP_FREQ) | 61 BIT(IIO_CHAN_INFO_HYSTERESIS), 62 .scan_index = CHANNEL_SCAN_INDEX_X, 63 }, { 64 .type = IIO_INCLI, 65 .modified = 1, 66 .channel2 = IIO_MOD_Y, 67 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), 68 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) | 69 BIT(IIO_CHAN_INFO_SCALE) | 70 BIT(IIO_CHAN_INFO_SAMP_FREQ) | 71 BIT(IIO_CHAN_INFO_HYSTERESIS), 72 .scan_index = CHANNEL_SCAN_INDEX_Y, 73 }, { 74 .type = IIO_INCLI, 75 .modified = 1, 76 .channel2 = IIO_MOD_Z, 77 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), 78 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) | 79 BIT(IIO_CHAN_INFO_SCALE) | 80 BIT(IIO_CHAN_INFO_SAMP_FREQ) | 81 BIT(IIO_CHAN_INFO_HYSTERESIS), 82 .scan_index = CHANNEL_SCAN_INDEX_Z, 83 }, 84 IIO_CHAN_SOFT_TIMESTAMP(CHANNEL_SCAN_INDEX_TIMESTAMP), 85 }; 86 87 /* Adjust channel real bits based on report descriptor */ 88 static void incl_3d_adjust_channel_bit_mask(struct iio_chan_spec *chan, int size) 89 { 90 chan->scan_type.sign = 's'; 91 /* Real storage bits will change based on the report desc. */ 92 chan->scan_type.realbits = size * 8; 93 /* Maximum size of a sample to capture is u32 */ 94 chan->scan_type.storagebits = sizeof(u32) * 8; 95 } 96 97 /* Channel read_raw handler */ 98 static int incl_3d_read_raw(struct iio_dev *indio_dev, 99 struct iio_chan_spec const *chan, 100 int *val, int *val2, long mask) 101 { 102 struct incl_3d_state *incl_state = iio_priv(indio_dev); 103 int report_id = -1; 104 u32 address; 105 int ret_type; 106 s32 min; 107 108 *val = 0; 109 *val2 = 0; 110 switch (mask) { 111 case IIO_CHAN_INFO_RAW: 112 hid_sensor_power_state(&incl_state->common_attributes, true); 113 report_id = incl_state->incl[chan->scan_index].report_id; 114 min = incl_state->incl[chan->scan_index].logical_minimum; 115 address = incl_3d_addresses[chan->scan_index]; 116 if (report_id >= 0) 117 *val = sensor_hub_input_attr_get_raw_value( 118 incl_state->common_attributes.hsdev, 119 HID_USAGE_SENSOR_INCLINOMETER_3D, address, 120 report_id, 121 SENSOR_HUB_SYNC, 122 min < 0); 123 else { 124 hid_sensor_power_state(&incl_state->common_attributes, 125 false); 126 return -EINVAL; 127 } 128 hid_sensor_power_state(&incl_state->common_attributes, false); 129 ret_type = IIO_VAL_INT; 130 break; 131 case IIO_CHAN_INFO_SCALE: 132 *val = incl_state->scale_pre_decml; 133 *val2 = incl_state->scale_post_decml; 134 ret_type = incl_state->scale_precision; 135 break; 136 case IIO_CHAN_INFO_OFFSET: 137 *val = incl_state->value_offset; 138 ret_type = IIO_VAL_INT; 139 break; 140 case IIO_CHAN_INFO_SAMP_FREQ: 141 ret_type = hid_sensor_read_samp_freq_value( 142 &incl_state->common_attributes, val, val2); 143 break; 144 case IIO_CHAN_INFO_HYSTERESIS: 145 ret_type = hid_sensor_read_raw_hyst_value( 146 &incl_state->common_attributes, val, val2); 147 break; 148 default: 149 ret_type = -EINVAL; 150 break; 151 } 152 153 return ret_type; 154 } 155 156 /* Channel write_raw handler */ 157 static int incl_3d_write_raw(struct iio_dev *indio_dev, 158 struct iio_chan_spec const *chan, 159 int val, int val2, long mask) 160 { 161 struct incl_3d_state *incl_state = iio_priv(indio_dev); 162 int ret; 163 164 switch (mask) { 165 case IIO_CHAN_INFO_SAMP_FREQ: 166 ret = hid_sensor_write_samp_freq_value( 167 &incl_state->common_attributes, val, val2); 168 break; 169 case IIO_CHAN_INFO_HYSTERESIS: 170 ret = hid_sensor_write_raw_hyst_value( 171 &incl_state->common_attributes, val, val2); 172 break; 173 default: 174 ret = -EINVAL; 175 } 176 177 return ret; 178 } 179 180 static const struct iio_info incl_3d_info = { 181 .read_raw = &incl_3d_read_raw, 182 .write_raw = &incl_3d_write_raw, 183 }; 184 185 /* Callback handler to send event after all samples are received and captured */ 186 static int incl_3d_proc_event(struct hid_sensor_hub_device *hsdev, 187 u32 usage_id, void *priv) 188 { 189 struct iio_dev *indio_dev = platform_get_drvdata(priv); 190 struct incl_3d_state *incl_state = iio_priv(indio_dev); 191 192 dev_dbg(&indio_dev->dev, "incl_3d_proc_event\n"); 193 if (atomic_read(&incl_state->common_attributes.data_ready)) { 194 if (!incl_state->timestamp) 195 incl_state->timestamp = iio_get_time_ns(indio_dev); 196 197 iio_push_to_buffers_with_timestamp(indio_dev, 198 &incl_state->scan, 199 incl_state->timestamp); 200 201 incl_state->timestamp = 0; 202 } 203 204 return 0; 205 } 206 207 /* Capture samples in local storage */ 208 static int incl_3d_capture_sample(struct hid_sensor_hub_device *hsdev, 209 u32 usage_id, 210 size_t raw_len, char *raw_data, 211 void *priv) 212 { 213 struct iio_dev *indio_dev = platform_get_drvdata(priv); 214 struct incl_3d_state *incl_state = iio_priv(indio_dev); 215 int ret = 0; 216 217 switch (usage_id) { 218 case HID_USAGE_SENSOR_ORIENT_TILT_X: 219 incl_state->scan.incl_val[CHANNEL_SCAN_INDEX_X] = *(u32 *)raw_data; 220 break; 221 case HID_USAGE_SENSOR_ORIENT_TILT_Y: 222 incl_state->scan.incl_val[CHANNEL_SCAN_INDEX_Y] = *(u32 *)raw_data; 223 break; 224 case HID_USAGE_SENSOR_ORIENT_TILT_Z: 225 incl_state->scan.incl_val[CHANNEL_SCAN_INDEX_Z] = *(u32 *)raw_data; 226 break; 227 case HID_USAGE_SENSOR_TIME_TIMESTAMP: 228 incl_state->timestamp = 229 hid_sensor_convert_timestamp(&incl_state->common_attributes, 230 *(s64 *)raw_data); 231 break; 232 default: 233 ret = -EINVAL; 234 break; 235 } 236 237 return ret; 238 } 239 240 /* Parse report which is specific to an usage id*/ 241 static int incl_3d_parse_report(struct platform_device *pdev, 242 struct hid_sensor_hub_device *hsdev, 243 struct iio_chan_spec *channels, 244 u32 usage_id, 245 struct incl_3d_state *st) 246 { 247 int ret; 248 249 ret = sensor_hub_input_get_attribute_info(hsdev, 250 HID_INPUT_REPORT, 251 usage_id, 252 HID_USAGE_SENSOR_ORIENT_TILT_X, 253 &st->incl[CHANNEL_SCAN_INDEX_X]); 254 if (ret) 255 return ret; 256 incl_3d_adjust_channel_bit_mask(&channels[CHANNEL_SCAN_INDEX_X], 257 st->incl[CHANNEL_SCAN_INDEX_X].size); 258 259 ret = sensor_hub_input_get_attribute_info(hsdev, 260 HID_INPUT_REPORT, 261 usage_id, 262 HID_USAGE_SENSOR_ORIENT_TILT_Y, 263 &st->incl[CHANNEL_SCAN_INDEX_Y]); 264 if (ret) 265 return ret; 266 incl_3d_adjust_channel_bit_mask(&channels[CHANNEL_SCAN_INDEX_Y], 267 st->incl[CHANNEL_SCAN_INDEX_Y].size); 268 269 ret = sensor_hub_input_get_attribute_info(hsdev, 270 HID_INPUT_REPORT, 271 usage_id, 272 HID_USAGE_SENSOR_ORIENT_TILT_Z, 273 &st->incl[CHANNEL_SCAN_INDEX_Z]); 274 if (ret) 275 return ret; 276 incl_3d_adjust_channel_bit_mask(&channels[CHANNEL_SCAN_INDEX_Z], 277 st->incl[CHANNEL_SCAN_INDEX_Z].size); 278 279 dev_dbg(&pdev->dev, "incl_3d %x:%x, %x:%x, %x:%x\n", 280 st->incl[0].index, 281 st->incl[0].report_id, 282 st->incl[1].index, st->incl[1].report_id, 283 st->incl[2].index, st->incl[2].report_id); 284 285 st->scale_precision = hid_sensor_format_scale( 286 HID_USAGE_SENSOR_INCLINOMETER_3D, 287 &st->incl[CHANNEL_SCAN_INDEX_X], 288 &st->scale_pre_decml, &st->scale_post_decml); 289 290 return ret; 291 } 292 293 /* Function to initialize the processing for usage id */ 294 static int hid_incl_3d_probe(struct platform_device *pdev) 295 { 296 struct hid_sensor_hub_device *hsdev = dev_get_platdata(&pdev->dev); 297 int ret; 298 static char *name = "incli_3d"; 299 struct iio_dev *indio_dev; 300 struct incl_3d_state *incl_state; 301 302 indio_dev = devm_iio_device_alloc(&pdev->dev, 303 sizeof(struct incl_3d_state)); 304 if (!indio_dev) 305 return -ENOMEM; 306 307 platform_set_drvdata(pdev, indio_dev); 308 309 incl_state = iio_priv(indio_dev); 310 incl_state->common_attributes.hsdev = hsdev; 311 incl_state->common_attributes.pdev = pdev; 312 313 ret = hid_sensor_parse_common_attributes(hsdev, 314 HID_USAGE_SENSOR_INCLINOMETER_3D, 315 &incl_state->common_attributes, 316 incl_3d_sensitivity_addresses, 317 ARRAY_SIZE(incl_3d_sensitivity_addresses)); 318 if (ret) { 319 dev_err(&pdev->dev, "failed to setup common attributes\n"); 320 return ret; 321 } 322 323 indio_dev->channels = devm_kmemdup(&pdev->dev, incl_3d_channels, 324 sizeof(incl_3d_channels), GFP_KERNEL); 325 if (!indio_dev->channels) { 326 dev_err(&pdev->dev, "failed to duplicate channels\n"); 327 return -ENOMEM; 328 } 329 330 ret = incl_3d_parse_report(pdev, hsdev, 331 (struct iio_chan_spec *)indio_dev->channels, 332 HID_USAGE_SENSOR_INCLINOMETER_3D, 333 incl_state); 334 if (ret) { 335 dev_err(&pdev->dev, "failed to setup attributes\n"); 336 return ret; 337 } 338 339 indio_dev->num_channels = ARRAY_SIZE(incl_3d_channels); 340 indio_dev->info = &incl_3d_info; 341 indio_dev->name = name; 342 indio_dev->modes = INDIO_DIRECT_MODE; 343 344 atomic_set(&incl_state->common_attributes.data_ready, 0); 345 346 ret = hid_sensor_setup_trigger(indio_dev, name, 347 &incl_state->common_attributes); 348 if (ret) { 349 dev_err(&pdev->dev, "trigger setup failed\n"); 350 return ret; 351 } 352 353 incl_state->callbacks.send_event = incl_3d_proc_event; 354 incl_state->callbacks.capture_sample = incl_3d_capture_sample; 355 incl_state->callbacks.pdev = pdev; 356 ret = sensor_hub_register_callback(hsdev, 357 HID_USAGE_SENSOR_INCLINOMETER_3D, 358 &incl_state->callbacks); 359 if (ret) { 360 dev_err(&pdev->dev, "callback reg failed\n"); 361 goto error_remove_trigger; 362 } 363 364 ret = iio_device_register(indio_dev); 365 if (ret) { 366 dev_err(&pdev->dev, "device register failed\n"); 367 goto error_remove_callback; 368 } 369 370 return 0; 371 372 error_remove_callback: 373 sensor_hub_remove_callback(hsdev, HID_USAGE_SENSOR_INCLINOMETER_3D); 374 error_remove_trigger: 375 hid_sensor_remove_trigger(indio_dev, &incl_state->common_attributes); 376 return ret; 377 } 378 379 /* Function to deinitialize the processing for usage id */ 380 static void hid_incl_3d_remove(struct platform_device *pdev) 381 { 382 struct hid_sensor_hub_device *hsdev = dev_get_platdata(&pdev->dev); 383 struct iio_dev *indio_dev = platform_get_drvdata(pdev); 384 struct incl_3d_state *incl_state = iio_priv(indio_dev); 385 386 iio_device_unregister(indio_dev); 387 sensor_hub_remove_callback(hsdev, HID_USAGE_SENSOR_INCLINOMETER_3D); 388 hid_sensor_remove_trigger(indio_dev, &incl_state->common_attributes); 389 } 390 391 static const struct platform_device_id hid_incl_3d_ids[] = { 392 { 393 /* Format: HID-SENSOR-usage_id_in_hex_lowercase */ 394 .name = "HID-SENSOR-200086", 395 }, 396 { } 397 }; 398 MODULE_DEVICE_TABLE(platform, hid_incl_3d_ids); 399 400 static struct platform_driver hid_incl_3d_platform_driver = { 401 .id_table = hid_incl_3d_ids, 402 .driver = { 403 .name = KBUILD_MODNAME, 404 .pm = &hid_sensor_pm_ops, 405 }, 406 .probe = hid_incl_3d_probe, 407 .remove = hid_incl_3d_remove, 408 }; 409 module_platform_driver(hid_incl_3d_platform_driver); 410 411 MODULE_DESCRIPTION("HID Sensor Inclinometer 3D"); 412 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>"); 413 MODULE_LICENSE("GPL"); 414 MODULE_IMPORT_NS("IIO_HID"); 415