drivers/iio/orientation/hid-sensor-incl-3d.c

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