1 /* 2 * HID Sensors Driver 3 * Copyright (c) 2014, Intel Corporation. 4 * 5 * This program is free software; you can redistribute it and/or modify it 6 * under the terms and conditions of the GNU General Public License, 7 * version 2, as published by the Free Software Foundation. 8 * 9 * This program is distributed in the hope it will be useful, but WITHOUT 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for 12 * more details. 13 * 14 * You should have received a copy of the GNU General Public License along with 15 * this program. 16 * 17 */ 18 #include <linux/device.h> 19 #include <linux/platform_device.h> 20 #include <linux/module.h> 21 #include <linux/interrupt.h> 22 #include <linux/irq.h> 23 #include <linux/slab.h> 24 #include <linux/hid-sensor-hub.h> 25 #include <linux/iio/iio.h> 26 #include <linux/iio/sysfs.h> 27 #include <linux/iio/buffer.h> 28 #include <linux/iio/trigger_consumer.h> 29 #include <linux/iio/triggered_buffer.h> 30 #include "../common/hid-sensors/hid-sensor-trigger.h" 31 32 #define CHANNEL_SCAN_INDEX_PRESSURE 0 33 34 struct press_state { 35 struct hid_sensor_hub_callbacks callbacks; 36 struct hid_sensor_common common_attributes; 37 struct hid_sensor_hub_attribute_info press_attr; 38 u32 press_data; 39 int scale_pre_decml; 40 int scale_post_decml; 41 int scale_precision; 42 int value_offset; 43 }; 44 45 /* Channel definitions */ 46 static const struct iio_chan_spec press_channels[] = { 47 { 48 .type = IIO_PRESSURE, 49 .modified = 1, 50 .channel2 = IIO_NO_MOD, 51 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), 52 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) | 53 BIT(IIO_CHAN_INFO_SCALE) | 54 BIT(IIO_CHAN_INFO_SAMP_FREQ) | 55 BIT(IIO_CHAN_INFO_HYSTERESIS), 56 .scan_index = CHANNEL_SCAN_INDEX_PRESSURE, 57 } 58 }; 59 60 /* Adjust channel real bits based on report descriptor */ 61 static void press_adjust_channel_bit_mask(struct iio_chan_spec *channels, 62 int channel, int size) 63 { 64 channels[channel].scan_type.sign = 's'; 65 /* Real storage bits will change based on the report desc. */ 66 channels[channel].scan_type.realbits = size * 8; 67 /* Maximum size of a sample to capture is u32 */ 68 channels[channel].scan_type.storagebits = sizeof(u32) * 8; 69 } 70 71 /* Channel read_raw handler */ 72 static int press_read_raw(struct iio_dev *indio_dev, 73 struct iio_chan_spec const *chan, 74 int *val, int *val2, 75 long mask) 76 { 77 struct press_state *press_state = iio_priv(indio_dev); 78 int report_id = -1; 79 u32 address; 80 int ret; 81 int ret_type; 82 83 *val = 0; 84 *val2 = 0; 85 switch (mask) { 86 case IIO_CHAN_INFO_RAW: 87 switch (chan->scan_index) { 88 case CHANNEL_SCAN_INDEX_PRESSURE: 89 report_id = press_state->press_attr.report_id; 90 address = 91 HID_USAGE_SENSOR_ATMOSPHERIC_PRESSURE; 92 break; 93 default: 94 report_id = -1; 95 break; 96 } 97 if (report_id >= 0) 98 *val = sensor_hub_input_attr_get_raw_value( 99 press_state->common_attributes.hsdev, 100 HID_USAGE_SENSOR_PRESSURE, address, 101 report_id); 102 else { 103 *val = 0; 104 return -EINVAL; 105 } 106 ret_type = IIO_VAL_INT; 107 break; 108 case IIO_CHAN_INFO_SCALE: 109 *val = press_state->scale_pre_decml; 110 *val2 = press_state->scale_post_decml; 111 ret_type = press_state->scale_precision; 112 break; 113 case IIO_CHAN_INFO_OFFSET: 114 *val = press_state->value_offset; 115 ret_type = IIO_VAL_INT; 116 break; 117 case IIO_CHAN_INFO_SAMP_FREQ: 118 ret = hid_sensor_read_samp_freq_value( 119 &press_state->common_attributes, val, val2); 120 ret_type = IIO_VAL_INT_PLUS_MICRO; 121 break; 122 case IIO_CHAN_INFO_HYSTERESIS: 123 ret = hid_sensor_read_raw_hyst_value( 124 &press_state->common_attributes, val, val2); 125 ret_type = IIO_VAL_INT_PLUS_MICRO; 126 break; 127 default: 128 ret_type = -EINVAL; 129 break; 130 } 131 132 return ret_type; 133 } 134 135 /* Channel write_raw handler */ 136 static int press_write_raw(struct iio_dev *indio_dev, 137 struct iio_chan_spec const *chan, 138 int val, 139 int val2, 140 long mask) 141 { 142 struct press_state *press_state = iio_priv(indio_dev); 143 int ret = 0; 144 145 switch (mask) { 146 case IIO_CHAN_INFO_SAMP_FREQ: 147 ret = hid_sensor_write_samp_freq_value( 148 &press_state->common_attributes, val, val2); 149 break; 150 case IIO_CHAN_INFO_HYSTERESIS: 151 ret = hid_sensor_write_raw_hyst_value( 152 &press_state->common_attributes, val, val2); 153 break; 154 default: 155 ret = -EINVAL; 156 } 157 158 return ret; 159 } 160 161 static const struct iio_info press_info = { 162 .driver_module = THIS_MODULE, 163 .read_raw = &press_read_raw, 164 .write_raw = &press_write_raw, 165 }; 166 167 /* Function to push data to buffer */ 168 static void hid_sensor_push_data(struct iio_dev *indio_dev, const void *data, 169 int len) 170 { 171 dev_dbg(&indio_dev->dev, "hid_sensor_push_data\n"); 172 iio_push_to_buffers(indio_dev, data); 173 } 174 175 /* Callback handler to send event after all samples are received and captured */ 176 static int press_proc_event(struct hid_sensor_hub_device *hsdev, 177 unsigned usage_id, 178 void *priv) 179 { 180 struct iio_dev *indio_dev = platform_get_drvdata(priv); 181 struct press_state *press_state = iio_priv(indio_dev); 182 183 dev_dbg(&indio_dev->dev, "press_proc_event [%d]\n", 184 press_state->common_attributes.data_ready); 185 if (press_state->common_attributes.data_ready) 186 hid_sensor_push_data(indio_dev, 187 &press_state->press_data, 188 sizeof(press_state->press_data)); 189 190 return 0; 191 } 192 193 /* Capture samples in local storage */ 194 static int press_capture_sample(struct hid_sensor_hub_device *hsdev, 195 unsigned usage_id, 196 size_t raw_len, char *raw_data, 197 void *priv) 198 { 199 struct iio_dev *indio_dev = platform_get_drvdata(priv); 200 struct press_state *press_state = iio_priv(indio_dev); 201 int ret = -EINVAL; 202 203 switch (usage_id) { 204 case HID_USAGE_SENSOR_ATMOSPHERIC_PRESSURE: 205 press_state->press_data = *(u32 *)raw_data; 206 ret = 0; 207 break; 208 default: 209 break; 210 } 211 212 return ret; 213 } 214 215 /* Parse report which is specific to an usage id*/ 216 static int press_parse_report(struct platform_device *pdev, 217 struct hid_sensor_hub_device *hsdev, 218 struct iio_chan_spec *channels, 219 unsigned usage_id, 220 struct press_state *st) 221 { 222 int ret; 223 224 ret = sensor_hub_input_get_attribute_info(hsdev, HID_INPUT_REPORT, 225 usage_id, 226 HID_USAGE_SENSOR_ATMOSPHERIC_PRESSURE, 227 &st->press_attr); 228 if (ret < 0) 229 return ret; 230 press_adjust_channel_bit_mask(channels, CHANNEL_SCAN_INDEX_PRESSURE, 231 st->press_attr.size); 232 233 dev_dbg(&pdev->dev, "press %x:%x\n", st->press_attr.index, 234 st->press_attr.report_id); 235 236 st->scale_precision = hid_sensor_format_scale( 237 HID_USAGE_SENSOR_PRESSURE, 238 &st->press_attr, 239 &st->scale_pre_decml, &st->scale_post_decml); 240 241 /* Set Sensitivity field ids, when there is no individual modifier */ 242 if (st->common_attributes.sensitivity.index < 0) { 243 sensor_hub_input_get_attribute_info(hsdev, 244 HID_FEATURE_REPORT, usage_id, 245 HID_USAGE_SENSOR_DATA_MOD_CHANGE_SENSITIVITY_ABS | 246 HID_USAGE_SENSOR_DATA_ATMOSPHERIC_PRESSURE, 247 &st->common_attributes.sensitivity); 248 dev_dbg(&pdev->dev, "Sensitivity index:report %d:%d\n", 249 st->common_attributes.sensitivity.index, 250 st->common_attributes.sensitivity.report_id); 251 } 252 return ret; 253 } 254 255 /* Function to initialize the processing for usage id */ 256 static int hid_press_probe(struct platform_device *pdev) 257 { 258 int ret = 0; 259 static const char *name = "press"; 260 struct iio_dev *indio_dev; 261 struct press_state *press_state; 262 struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data; 263 struct iio_chan_spec *channels; 264 265 indio_dev = devm_iio_device_alloc(&pdev->dev, 266 sizeof(struct press_state)); 267 if (!indio_dev) 268 return -ENOMEM; 269 platform_set_drvdata(pdev, indio_dev); 270 271 press_state = iio_priv(indio_dev); 272 press_state->common_attributes.hsdev = hsdev; 273 press_state->common_attributes.pdev = pdev; 274 275 ret = hid_sensor_parse_common_attributes(hsdev, 276 HID_USAGE_SENSOR_PRESSURE, 277 &press_state->common_attributes); 278 if (ret) { 279 dev_err(&pdev->dev, "failed to setup common attributes\n"); 280 return ret; 281 } 282 283 channels = kmemdup(press_channels, sizeof(press_channels), GFP_KERNEL); 284 if (!channels) { 285 dev_err(&pdev->dev, "failed to duplicate channels\n"); 286 return -ENOMEM; 287 } 288 289 ret = press_parse_report(pdev, hsdev, channels, 290 HID_USAGE_SENSOR_PRESSURE, press_state); 291 if (ret) { 292 dev_err(&pdev->dev, "failed to setup attributes\n"); 293 goto error_free_dev_mem; 294 } 295 296 indio_dev->channels = channels; 297 indio_dev->num_channels = 298 ARRAY_SIZE(press_channels); 299 indio_dev->dev.parent = &pdev->dev; 300 indio_dev->info = &press_info; 301 indio_dev->name = name; 302 indio_dev->modes = INDIO_DIRECT_MODE; 303 304 ret = iio_triggered_buffer_setup(indio_dev, &iio_pollfunc_store_time, 305 NULL, NULL); 306 if (ret) { 307 dev_err(&pdev->dev, "failed to initialize trigger buffer\n"); 308 goto error_free_dev_mem; 309 } 310 press_state->common_attributes.data_ready = false; 311 ret = hid_sensor_setup_trigger(indio_dev, name, 312 &press_state->common_attributes); 313 if (ret) { 314 dev_err(&pdev->dev, "trigger setup failed\n"); 315 goto error_unreg_buffer_funcs; 316 } 317 318 ret = iio_device_register(indio_dev); 319 if (ret) { 320 dev_err(&pdev->dev, "device register failed\n"); 321 goto error_remove_trigger; 322 } 323 324 press_state->callbacks.send_event = press_proc_event; 325 press_state->callbacks.capture_sample = press_capture_sample; 326 press_state->callbacks.pdev = pdev; 327 ret = sensor_hub_register_callback(hsdev, HID_USAGE_SENSOR_PRESSURE, 328 &press_state->callbacks); 329 if (ret < 0) { 330 dev_err(&pdev->dev, "callback reg failed\n"); 331 goto error_iio_unreg; 332 } 333 334 return ret; 335 336 error_iio_unreg: 337 iio_device_unregister(indio_dev); 338 error_remove_trigger: 339 hid_sensor_remove_trigger(&press_state->common_attributes); 340 error_unreg_buffer_funcs: 341 iio_triggered_buffer_cleanup(indio_dev); 342 error_free_dev_mem: 343 kfree(indio_dev->channels); 344 return ret; 345 } 346 347 /* Function to deinitialize the processing for usage id */ 348 static int hid_press_remove(struct platform_device *pdev) 349 { 350 struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data; 351 struct iio_dev *indio_dev = platform_get_drvdata(pdev); 352 struct press_state *press_state = iio_priv(indio_dev); 353 354 sensor_hub_remove_callback(hsdev, HID_USAGE_SENSOR_PRESSURE); 355 iio_device_unregister(indio_dev); 356 hid_sensor_remove_trigger(&press_state->common_attributes); 357 iio_triggered_buffer_cleanup(indio_dev); 358 kfree(indio_dev->channels); 359 360 return 0; 361 } 362 363 static struct platform_device_id hid_press_ids[] = { 364 { 365 /* Format: HID-SENSOR-usage_id_in_hex_lowercase */ 366 .name = "HID-SENSOR-200031", 367 }, 368 { /* sentinel */ } 369 }; 370 MODULE_DEVICE_TABLE(platform, hid_press_ids); 371 372 static struct platform_driver hid_press_platform_driver = { 373 .id_table = hid_press_ids, 374 .driver = { 375 .name = KBUILD_MODNAME, 376 .owner = THIS_MODULE, 377 }, 378 .probe = hid_press_probe, 379 .remove = hid_press_remove, 380 }; 381 module_platform_driver(hid_press_platform_driver); 382 383 MODULE_DESCRIPTION("HID Sensor Pressure"); 384 MODULE_AUTHOR("Archana Patni <archana.patni@intel.com>"); 385 MODULE_LICENSE("GPL"); 386