drivers/iio/accel/hid-sensor-accel-3d.c

   1 /*
   2  * HID Sensors Driver
   3  * Copyright (c) 2012, 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  * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
  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 accel_3d_channel {
  35         CHANNEL_SCAN_INDEX_X,
  36         CHANNEL_SCAN_INDEX_Y,
  37         CHANNEL_SCAN_INDEX_Z,
  38         ACCEL_3D_CHANNEL_MAX,
  39 };
  40
  41 struct accel_3d_state {
  42         struct hid_sensor_hub_callbacks callbacks;
  43         struct hid_sensor_common common_attributes;
  44         struct hid_sensor_hub_attribute_info accel[ACCEL_3D_CHANNEL_MAX];
  45         /* Reserve for 3 channels + padding + timestamp */
  46         u32 accel_val[ACCEL_3D_CHANNEL_MAX + 3];
  47         int scale_pre_decml;
  48         int scale_post_decml;
  49         int scale_precision;
  50         int value_offset;
  51         int64_t timestamp;
  52 };
  53
  54 static const u32 accel_3d_addresses[ACCEL_3D_CHANNEL_MAX] = {
  55         HID_USAGE_SENSOR_ACCEL_X_AXIS,
  56         HID_USAGE_SENSOR_ACCEL_Y_AXIS,
  57         HID_USAGE_SENSOR_ACCEL_Z_AXIS
  58 };
  59
  60 /* Channel definitions */
  61 static const struct iio_chan_spec accel_3d_channels[] = {
  62         {
  63                 .type = IIO_ACCEL,
  64                 .modified = 1,
  65                 .channel2 = IIO_MOD_X,
  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_X,
  72         }, {
  73                 .type = IIO_ACCEL,
  74                 .modified = 1,
  75                 .channel2 = IIO_MOD_Y,
  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_Y,
  82         }, {
  83                 .type = IIO_ACCEL,
  84                 .modified = 1,
  85                 .channel2 = IIO_MOD_Z,
  86                 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
  87                 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
  88                 BIT(IIO_CHAN_INFO_SCALE) |
  89                 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
  90                 BIT(IIO_CHAN_INFO_HYSTERESIS),
  91                 .scan_index = CHANNEL_SCAN_INDEX_Z,
  92         },
  93         IIO_CHAN_SOFT_TIMESTAMP(3)
  94 };
  95
  96 /* Channel definitions */
  97 static const struct iio_chan_spec gravity_channels[] = {
  98         {
  99                 .type = IIO_GRAVITY,
 100                 .modified = 1,
 101                 .channel2 = IIO_MOD_X,
 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_X,
 108         }, {
 109                 .type = IIO_GRAVITY,
 110                 .modified = 1,
 111                 .channel2 = IIO_MOD_Y,
 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_Y,
 118         }, {
 119                 .type = IIO_GRAVITY,
 120                 .modified = 1,
 121                 .channel2 = IIO_MOD_Z,
 122                 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
 123                 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
 124                 BIT(IIO_CHAN_INFO_SCALE) |
 125                 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
 126                 BIT(IIO_CHAN_INFO_HYSTERESIS),
 127                 .scan_index = CHANNEL_SCAN_INDEX_Z,
 128         }
 129 };
 130
 131 /* Adjust channel real bits based on report descriptor */
 132 static void accel_3d_adjust_channel_bit_mask(struct iio_chan_spec *channels,
 133                                                 int channel, int size)
 134 {
 135         channels[channel].scan_type.sign = 's';
 136         /* Real storage bits will change based on the report desc. */
 137         channels[channel].scan_type.realbits = size * 8;
 138         /* Maximum size of a sample to capture is u32 */
 139         channels[channel].scan_type.storagebits = sizeof(u32) * 8;
 140 }
 141
 142 /* Channel read_raw handler */
 143 static int accel_3d_read_raw(struct iio_dev *indio_dev,
 144                               struct iio_chan_spec const *chan,
 145                               int *val, int *val2,
 146                               long mask)
 147 {
 148         struct accel_3d_state *accel_state = iio_priv(indio_dev);
 149         int report_id = -1;
 150         u32 address;
 151         int ret_type;
 152         s32 min;
 153         struct hid_sensor_hub_device *hsdev =
 154                                         accel_state->common_attributes.hsdev;
 155
 156         *val = 0;
 157         *val2 = 0;
 158         switch (mask) {
 159         case 0:
 160                 hid_sensor_power_state(&accel_state->common_attributes, true);
 161                 report_id = accel_state->accel[chan->scan_index].report_id;
 162                 min = accel_state->accel[chan->scan_index].logical_minimum;
 163                 address = accel_3d_addresses[chan->scan_index];
 164                 if (report_id >= 0)
 165                         *val = sensor_hub_input_attr_get_raw_value(
 166                                         accel_state->common_attributes.hsdev,
 167                                         hsdev->usage, address, report_id,
 168                                         SENSOR_HUB_SYNC,
 169                                         min < 0);
 170                 else {
 171                         *val = 0;
 172                         hid_sensor_power_state(&accel_state->common_attributes,
 173                                                  false);
 174                         return -EINVAL;
 175                 }
 176                 hid_sensor_power_state(&accel_state->common_attributes, false);
 177                 ret_type = IIO_VAL_INT;
 178                 break;
 179         case IIO_CHAN_INFO_SCALE:
 180                 *val = accel_state->scale_pre_decml;
 181                 *val2 = accel_state->scale_post_decml;
 182                 ret_type = accel_state->scale_precision;
 183                 break;
 184         case IIO_CHAN_INFO_OFFSET:
 185                 *val = accel_state->value_offset;
 186                 ret_type = IIO_VAL_INT;
 187                 break;
 188         case IIO_CHAN_INFO_SAMP_FREQ:
 189                 ret_type = hid_sensor_read_samp_freq_value(
 190                         &accel_state->common_attributes, val, val2);
 191                 break;
 192         case IIO_CHAN_INFO_HYSTERESIS:
 193                 ret_type = hid_sensor_read_raw_hyst_value(
 194                         &accel_state->common_attributes, val, val2);
 195                 break;
 196         default:
 197                 ret_type = -EINVAL;
 198                 break;
 199         }
 200
 201         return ret_type;
 202 }
 203
 204 /* Channel write_raw handler */
 205 static int accel_3d_write_raw(struct iio_dev *indio_dev,
 206                                struct iio_chan_spec const *chan,
 207                                int val,
 208                                int val2,
 209                                long mask)
 210 {
 211         struct accel_3d_state *accel_state = iio_priv(indio_dev);
 212         int ret = 0;
 213
 214         switch (mask) {
 215         case IIO_CHAN_INFO_SAMP_FREQ:
 216                 ret = hid_sensor_write_samp_freq_value(
 217                                 &accel_state->common_attributes, val, val2);
 218                 break;
 219         case IIO_CHAN_INFO_HYSTERESIS:
 220                 ret = hid_sensor_write_raw_hyst_value(
 221                                 &accel_state->common_attributes, val, val2);
 222                 break;
 223         default:
 224                 ret = -EINVAL;
 225         }
 226
 227         return ret;
 228 }
 229
 230 static const struct iio_info accel_3d_info = {
 231         .driver_module = THIS_MODULE,
 232         .read_raw = &accel_3d_read_raw,
 233         .write_raw = &accel_3d_write_raw,
 234 };
 235
 236 /* Function to push data to buffer */
 237 static void hid_sensor_push_data(struct iio_dev *indio_dev, void *data,
 238                                  int len, int64_t timestamp)
 239 {
 240         dev_dbg(&indio_dev->dev, "hid_sensor_push_data\n");
 241         iio_push_to_buffers_with_timestamp(indio_dev, data, timestamp);
 242 }
 243
 244 /* Callback handler to send event after all samples are received and captured */
 245 static int accel_3d_proc_event(struct hid_sensor_hub_device *hsdev,
 246                                 unsigned usage_id,
 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
 252         dev_dbg(&indio_dev->dev, "accel_3d_proc_event\n");
 253         if (atomic_read(&accel_state->common_attributes.data_ready)) {
 254                 if (!accel_state->timestamp)
 255                         accel_state->timestamp = iio_get_time_ns(indio_dev);
 256
 257                 hid_sensor_push_data(indio_dev,
 258                                      accel_state->accel_val,
 259                                      sizeof(accel_state->accel_val),
 260                                      accel_state->timestamp);
 261
 262                 accel_state->timestamp = 0;
 263         }
 264
 265         return 0;
 266 }
 267
 268 /* Capture samples in local storage */
 269 static int accel_3d_capture_sample(struct hid_sensor_hub_device *hsdev,
 270                                 unsigned usage_id,
 271                                 size_t raw_len, char *raw_data,
 272                                 void *priv)
 273 {
 274         struct iio_dev *indio_dev = platform_get_drvdata(priv);
 275         struct accel_3d_state *accel_state = iio_priv(indio_dev);
 276         int offset;
 277         int ret = -EINVAL;
 278
 279         switch (usage_id) {
 280         case HID_USAGE_SENSOR_ACCEL_X_AXIS:
 281         case HID_USAGE_SENSOR_ACCEL_Y_AXIS:
 282         case HID_USAGE_SENSOR_ACCEL_Z_AXIS:
 283                 offset = usage_id - HID_USAGE_SENSOR_ACCEL_X_AXIS;
 284                 accel_state->accel_val[CHANNEL_SCAN_INDEX_X + offset] =
 285                                                 *(u32 *)raw_data;
 286                 ret = 0;
 287         break;
 288         case HID_USAGE_SENSOR_TIME_TIMESTAMP:
 289                 accel_state->timestamp =
 290                         hid_sensor_convert_timestamp(
 291                                         &accel_state->common_attributes,
 292                                         *(int64_t *)raw_data);
 293         break;
 294         default:
 295                 break;
 296         }
 297
 298         return ret;
 299 }
 300
 301 /* Parse report which is specific to an usage id*/
 302 static int accel_3d_parse_report(struct platform_device *pdev,
 303                                 struct hid_sensor_hub_device *hsdev,
 304                                 struct iio_chan_spec *channels,
 305                                 unsigned usage_id,
 306                                 struct accel_3d_state *st)
 307 {
 308         int ret;
 309         int i;
 310
 311         for (i = 0; i <= CHANNEL_SCAN_INDEX_Z; ++i) {
 312                 ret = sensor_hub_input_get_attribute_info(hsdev,
 313                                 HID_INPUT_REPORT,
 314                                 usage_id,
 315                                 HID_USAGE_SENSOR_ACCEL_X_AXIS + i,
 316                                 &st->accel[CHANNEL_SCAN_INDEX_X + i]);
 317                 if (ret < 0)
 318                         break;
 319                 accel_3d_adjust_channel_bit_mask(channels,
 320                                 CHANNEL_SCAN_INDEX_X + i,
 321                                 st->accel[CHANNEL_SCAN_INDEX_X + i].size);
 322         }
 323         dev_dbg(&pdev->dev, "accel_3d %x:%x, %x:%x, %x:%x\n",
 324                         st->accel[0].index,
 325                         st->accel[0].report_id,
 326                         st->accel[1].index, st->accel[1].report_id,
 327                         st->accel[2].index, st->accel[2].report_id);
 328
 329         st->scale_precision = hid_sensor_format_scale(
 330                                 hsdev->usage,
 331                                 &st->accel[CHANNEL_SCAN_INDEX_X],
 332                                 &st->scale_pre_decml, &st->scale_post_decml);
 333
 334         /* Set Sensitivity field ids, when there is no individual modifier */
 335         if (st->common_attributes.sensitivity.index < 0) {
 336                 sensor_hub_input_get_attribute_info(hsdev,
 337                         HID_FEATURE_REPORT, usage_id,
 338                         HID_USAGE_SENSOR_DATA_MOD_CHANGE_SENSITIVITY_ABS |
 339                         HID_USAGE_SENSOR_DATA_ACCELERATION,
 340                         &st->common_attributes.sensitivity);
 341                 dev_dbg(&pdev->dev, "Sensitivity index:report %d:%d\n",
 342                         st->common_attributes.sensitivity.index,
 343                         st->common_attributes.sensitivity.report_id);
 344         }
 345
 346         return ret;
 347 }
 348
 349 /* Function to initialize the processing for usage id */
 350 static int hid_accel_3d_probe(struct platform_device *pdev)
 351 {
 352         int ret = 0;
 353         const char *name;
 354         struct iio_dev *indio_dev;
 355         struct accel_3d_state *accel_state;
 356         const struct iio_chan_spec *channel_spec;
 357         int channel_size;
 358
 359         struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
 360
 361         indio_dev = devm_iio_device_alloc(&pdev->dev,
 362                                           sizeof(struct accel_3d_state));
 363         if (indio_dev == NULL)
 364                 return -ENOMEM;
 365
 366         platform_set_drvdata(pdev, indio_dev);
 367
 368         accel_state = iio_priv(indio_dev);
 369         accel_state->common_attributes.hsdev = hsdev;
 370         accel_state->common_attributes.pdev = pdev;
 371
 372         if (hsdev->usage == HID_USAGE_SENSOR_ACCEL_3D) {
 373                 name = "accel_3d";
 374                 channel_spec = accel_3d_channels;
 375                 channel_size = sizeof(accel_3d_channels);
 376                 indio_dev->num_channels = ARRAY_SIZE(accel_3d_channels);
 377         } else {
 378                 name = "gravity";
 379                 channel_spec = gravity_channels;
 380                 channel_size = sizeof(gravity_channels);
 381                 indio_dev->num_channels = ARRAY_SIZE(gravity_channels);
 382         }
 383         ret = hid_sensor_parse_common_attributes(hsdev, hsdev->usage,
 384                                         &accel_state->common_attributes);
 385         if (ret) {
 386                 dev_err(&pdev->dev, "failed to setup common attributes\n");
 387                 return ret;
 388         }
 389         indio_dev->channels = kmemdup(channel_spec, channel_size, GFP_KERNEL);
 390
 391         if (!indio_dev->channels) {
 392                 dev_err(&pdev->dev, "failed to duplicate channels\n");
 393                 return -ENOMEM;
 394         }
 395         ret = accel_3d_parse_report(pdev, hsdev,
 396                                 (struct iio_chan_spec *)indio_dev->channels,
 397                                 hsdev->usage, accel_state);
 398         if (ret) {
 399                 dev_err(&pdev->dev, "failed to setup attributes\n");
 400                 goto error_free_dev_mem;
 401         }
 402
 403         indio_dev->dev.parent = &pdev->dev;
 404         indio_dev->info = &accel_3d_info;
 405         indio_dev->name = name;
 406         indio_dev->modes = INDIO_DIRECT_MODE;
 407
 408         ret = iio_triggered_buffer_setup(indio_dev, &iio_pollfunc_store_time,
 409                 NULL, NULL);
 410         if (ret) {
 411                 dev_err(&pdev->dev, "failed to initialize trigger buffer\n");
 412                 goto error_free_dev_mem;
 413         }
 414         atomic_set(&accel_state->common_attributes.data_ready, 0);
 415         ret = hid_sensor_setup_trigger(indio_dev, name,
 416                                         &accel_state->common_attributes);
 417         if (ret < 0) {
 418                 dev_err(&pdev->dev, "trigger setup failed\n");
 419                 goto error_unreg_buffer_funcs;
 420         }
 421
 422         ret = iio_device_register(indio_dev);
 423         if (ret) {
 424                 dev_err(&pdev->dev, "device register failed\n");
 425                 goto error_remove_trigger;
 426         }
 427
 428         accel_state->callbacks.send_event = accel_3d_proc_event;
 429         accel_state->callbacks.capture_sample = accel_3d_capture_sample;
 430         accel_state->callbacks.pdev = pdev;
 431         ret = sensor_hub_register_callback(hsdev, hsdev->usage,
 432                                         &accel_state->callbacks);
 433         if (ret < 0) {
 434                 dev_err(&pdev->dev, "callback reg failed\n");
 435                 goto error_iio_unreg;
 436         }
 437
 438         return ret;
 439
 440 error_iio_unreg:
 441         iio_device_unregister(indio_dev);
 442 error_remove_trigger:
 443         hid_sensor_remove_trigger(&accel_state->common_attributes);
 444 error_unreg_buffer_funcs:
 445         iio_triggered_buffer_cleanup(indio_dev);
 446 error_free_dev_mem:
 447         kfree(indio_dev->channels);
 448         return ret;
 449 }
 450
 451 /* Function to deinitialize the processing for usage id */
 452 static int hid_accel_3d_remove(struct platform_device *pdev)
 453 {
 454         struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
 455         struct iio_dev *indio_dev = platform_get_drvdata(pdev);
 456         struct accel_3d_state *accel_state = iio_priv(indio_dev);
 457
 458         sensor_hub_remove_callback(hsdev, hsdev->usage);
 459         iio_device_unregister(indio_dev);
 460         hid_sensor_remove_trigger(&accel_state->common_attributes);
 461         iio_triggered_buffer_cleanup(indio_dev);
 462         kfree(indio_dev->channels);
 463
 464         return 0;
 465 }
 466
 467 static const struct platform_device_id hid_accel_3d_ids[] = {
 468         {
 469                 /* Format: HID-SENSOR-usage_id_in_hex_lowercase */
 470                 .name = "HID-SENSOR-200073",
 471         },
 472         {       /* gravity sensor */
 473                 .name = "HID-SENSOR-20007b",
 474         },
 475         { /* sentinel */ }
 476 };
 477 MODULE_DEVICE_TABLE(platform, hid_accel_3d_ids);
 478
 479 static struct platform_driver hid_accel_3d_platform_driver = {
 480         .id_table = hid_accel_3d_ids,
 481         .driver = {
 482                 .name   = KBUILD_MODNAME,
 483                 .pm     = &hid_sensor_pm_ops,
 484         },
 485         .probe          = hid_accel_3d_probe,
 486         .remove         = hid_accel_3d_remove,
 487 };
 488 module_platform_driver(hid_accel_3d_platform_driver);
 489
 490 MODULE_DESCRIPTION("HID Sensor Accel 3D");
 491 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
 492 MODULE_LICENSE("GPL");