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