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