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         u32 accel_val[ACCEL_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 accel_3d_addresses[ACCEL_3D_CHANNEL_MAX] = {
  53         HID_USAGE_SENSOR_ACCEL_X_AXIS,
  54         HID_USAGE_SENSOR_ACCEL_Y_AXIS,
  55         HID_USAGE_SENSOR_ACCEL_Z_AXIS
  56 };
  57
  58 /* Channel definitions */
  59 static const struct iio_chan_spec accel_3d_channels[] = {
  60         {
  61                 .type = IIO_ACCEL,
  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_ACCEL,
  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_ACCEL,
  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 accel_3d_adjust_channel_bit_mask(struct iio_chan_spec *channels,
  95                                                 int channel, int size)
  96 {
  97         channels[channel].scan_type.sign = 's';
  98         /* Real storage bits will change based on the report desc. */
  99         channels[channel].scan_type.realbits = size * 8;
 100         /* Maximum size of a sample to capture is u32 */
 101         channels[channel].scan_type.storagebits = sizeof(u32) * 8;
 102 }
 103
 104 /* Channel read_raw handler */
 105 static int accel_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 accel_3d_state *accel_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 0:
 120                 poll_value = hid_sensor_read_poll_value(
 121                                         &accel_state->common_attributes);
 122                 if (poll_value < 0)
 123                         return -EINVAL;
 124
 125                 hid_sensor_power_state(&accel_state->common_attributes, true);
 126                 msleep_interruptible(poll_value * 2);
 127                 report_id = accel_state->accel[chan->scan_index].report_id;
 128                 address = accel_3d_addresses[chan->scan_index];
 129                 if (report_id >= 0)
 130                         *val = sensor_hub_input_attr_get_raw_value(
 131                                         accel_state->common_attributes.hsdev,
 132                                         HID_USAGE_SENSOR_ACCEL_3D, address,
 133                                         report_id,
 134                                         SENSOR_HUB_SYNC);
 135                 else {
 136                         *val = 0;
 137                         hid_sensor_power_state(&accel_state->common_attributes,
 138                                                  false);
 139                         return -EINVAL;
 140                 }
 141                 hid_sensor_power_state(&accel_state->common_attributes, false);
 142                 ret_type = IIO_VAL_INT;
 143                 break;
 144         case IIO_CHAN_INFO_SCALE:
 145                 *val = accel_state->scale_pre_decml;
 146                 *val2 = accel_state->scale_post_decml;
 147                 ret_type = accel_state->scale_precision;
 148                 break;
 149         case IIO_CHAN_INFO_OFFSET:
 150                 *val = accel_state->value_offset;
 151                 ret_type = IIO_VAL_INT;
 152                 break;
 153         case IIO_CHAN_INFO_SAMP_FREQ:
 154                 ret_type = hid_sensor_read_samp_freq_value(
 155                         &accel_state->common_attributes, val, val2);
 156                 break;
 157         case IIO_CHAN_INFO_HYSTERESIS:
 158                 ret_type = hid_sensor_read_raw_hyst_value(
 159                         &accel_state->common_attributes, val, val2);
 160                 break;
 161         default:
 162                 ret_type = -EINVAL;
 163                 break;
 164         }
 165
 166         return ret_type;
 167 }
 168
 169 /* Channel write_raw handler */
 170 static int accel_3d_write_raw(struct iio_dev *indio_dev,
 171                                struct iio_chan_spec const *chan,
 172                                int val,
 173                                int val2,
 174                                long mask)
 175 {
 176         struct accel_3d_state *accel_state = iio_priv(indio_dev);
 177         int ret = 0;
 178
 179         switch (mask) {
 180         case IIO_CHAN_INFO_SAMP_FREQ:
 181                 ret = hid_sensor_write_samp_freq_value(
 182                                 &accel_state->common_attributes, val, val2);
 183                 break;
 184         case IIO_CHAN_INFO_HYSTERESIS:
 185                 ret = hid_sensor_write_raw_hyst_value(
 186                                 &accel_state->common_attributes, val, val2);
 187                 break;
 188         default:
 189                 ret = -EINVAL;
 190         }
 191
 192         return ret;
 193 }
 194
 195 static const struct iio_info accel_3d_info = {
 196         .driver_module = THIS_MODULE,
 197         .read_raw = &accel_3d_read_raw,
 198         .write_raw = &accel_3d_write_raw,
 199 };
 200
 201 /* Function to push data to buffer */
 202 static void hid_sensor_push_data(struct iio_dev *indio_dev, const void *data,
 203         int len)
 204 {
 205         dev_dbg(&indio_dev->dev, "hid_sensor_push_data\n");
 206         iio_push_to_buffers(indio_dev, data);
 207 }
 208
 209 /* Callback handler to send event after all samples are received and captured */
 210 static int accel_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 accel_3d_state *accel_state = iio_priv(indio_dev);
 216
 217         dev_dbg(&indio_dev->dev, "accel_3d_proc_event\n");
 218         if (atomic_read(&accel_state->common_attributes.data_ready))
 219                 hid_sensor_push_data(indio_dev,
 220                                 accel_state->accel_val,
 221                                 sizeof(accel_state->accel_val));
 222
 223         return 0;
 224 }
 225
 226 /* Capture samples in local storage */
 227 static int accel_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 accel_3d_state *accel_state = iio_priv(indio_dev);
 234         int offset;
 235         int ret = -EINVAL;
 236
 237         switch (usage_id) {
 238         case HID_USAGE_SENSOR_ACCEL_X_AXIS:
 239         case HID_USAGE_SENSOR_ACCEL_Y_AXIS:
 240         case HID_USAGE_SENSOR_ACCEL_Z_AXIS:
 241                 offset = usage_id - HID_USAGE_SENSOR_ACCEL_X_AXIS;
 242                 accel_state->accel_val[CHANNEL_SCAN_INDEX_X + offset] =
 243                                                 *(u32 *)raw_data;
 244                 ret = 0;
 245         break;
 246         default:
 247                 break;
 248         }
 249
 250         return ret;
 251 }
 252
 253 /* Parse report which is specific to an usage id*/
 254 static int accel_3d_parse_report(struct platform_device *pdev,
 255                                 struct hid_sensor_hub_device *hsdev,
 256                                 struct iio_chan_spec *channels,
 257                                 unsigned usage_id,
 258                                 struct accel_3d_state *st)
 259 {
 260         int ret;
 261         int i;
 262
 263         for (i = 0; i <= CHANNEL_SCAN_INDEX_Z; ++i) {
 264                 ret = sensor_hub_input_get_attribute_info(hsdev,
 265                                 HID_INPUT_REPORT,
 266                                 usage_id,
 267                                 HID_USAGE_SENSOR_ACCEL_X_AXIS + i,
 268                                 &st->accel[CHANNEL_SCAN_INDEX_X + i]);
 269                 if (ret < 0)
 270                         break;
 271                 accel_3d_adjust_channel_bit_mask(channels,
 272                                 CHANNEL_SCAN_INDEX_X + i,
 273                                 st->accel[CHANNEL_SCAN_INDEX_X + i].size);
 274         }
 275         dev_dbg(&pdev->dev, "accel_3d %x:%x, %x:%x, %x:%x\n",
 276                         st->accel[0].index,
 277                         st->accel[0].report_id,
 278                         st->accel[1].index, st->accel[1].report_id,
 279                         st->accel[2].index, st->accel[2].report_id);
 280
 281         st->scale_precision = hid_sensor_format_scale(
 282                                 HID_USAGE_SENSOR_ACCEL_3D,
 283                                 &st->accel[CHANNEL_SCAN_INDEX_X],
 284                                 &st->scale_pre_decml, &st->scale_post_decml);
 285
 286         /* Set Sensitivity field ids, when there is no individual modifier */
 287         if (st->common_attributes.sensitivity.index < 0) {
 288                 sensor_hub_input_get_attribute_info(hsdev,
 289                         HID_FEATURE_REPORT, usage_id,
 290                         HID_USAGE_SENSOR_DATA_MOD_CHANGE_SENSITIVITY_ABS |
 291                         HID_USAGE_SENSOR_DATA_ACCELERATION,
 292                         &st->common_attributes.sensitivity);
 293                 dev_dbg(&pdev->dev, "Sensitivity index:report %d:%d\n",
 294                         st->common_attributes.sensitivity.index,
 295                         st->common_attributes.sensitivity.report_id);
 296         }
 297
 298         return ret;
 299 }
 300
 301 /* Function to initialize the processing for usage id */
 302 static int hid_accel_3d_probe(struct platform_device *pdev)
 303 {
 304         int ret = 0;
 305         static const char *name = "accel_3d";
 306         struct iio_dev *indio_dev;
 307         struct accel_3d_state *accel_state;
 308         struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
 309         struct iio_chan_spec *channels;
 310
 311         indio_dev = devm_iio_device_alloc(&pdev->dev,
 312                                           sizeof(struct accel_3d_state));
 313         if (indio_dev == NULL)
 314                 return -ENOMEM;
 315
 316         platform_set_drvdata(pdev, indio_dev);
 317
 318         accel_state = iio_priv(indio_dev);
 319         accel_state->common_attributes.hsdev = hsdev;
 320         accel_state->common_attributes.pdev = pdev;
 321
 322         ret = hid_sensor_parse_common_attributes(hsdev,
 323                                         HID_USAGE_SENSOR_ACCEL_3D,
 324                                         &accel_state->common_attributes);
 325         if (ret) {
 326                 dev_err(&pdev->dev, "failed to setup common attributes\n");
 327                 return ret;
 328         }
 329
 330         channels = kmemdup(accel_3d_channels, sizeof(accel_3d_channels),
 331                            GFP_KERNEL);
 332         if (!channels) {
 333                 dev_err(&pdev->dev, "failed to duplicate channels\n");
 334                 return -ENOMEM;
 335         }
 336
 337         ret = accel_3d_parse_report(pdev, hsdev, channels,
 338                                         HID_USAGE_SENSOR_ACCEL_3D, accel_state);
 339         if (ret) {
 340                 dev_err(&pdev->dev, "failed to setup attributes\n");
 341                 goto error_free_dev_mem;
 342         }
 343
 344         indio_dev->channels = channels;
 345         indio_dev->num_channels = ARRAY_SIZE(accel_3d_channels);
 346         indio_dev->dev.parent = &pdev->dev;
 347         indio_dev->info = &accel_3d_info;
 348         indio_dev->name = name;
 349         indio_dev->modes = INDIO_DIRECT_MODE;
 350
 351         ret = iio_triggered_buffer_setup(indio_dev, &iio_pollfunc_store_time,
 352                 NULL, NULL);
 353         if (ret) {
 354                 dev_err(&pdev->dev, "failed to initialize trigger buffer\n");
 355                 goto error_free_dev_mem;
 356         }
 357         atomic_set(&accel_state->common_attributes.data_ready, 0);
 358         ret = hid_sensor_setup_trigger(indio_dev, name,
 359                                         &accel_state->common_attributes);
 360         if (ret < 0) {
 361                 dev_err(&pdev->dev, "trigger setup failed\n");
 362                 goto error_unreg_buffer_funcs;
 363         }
 364
 365         ret = iio_device_register(indio_dev);
 366         if (ret) {
 367                 dev_err(&pdev->dev, "device register failed\n");
 368                 goto error_remove_trigger;
 369         }
 370
 371         accel_state->callbacks.send_event = accel_3d_proc_event;
 372         accel_state->callbacks.capture_sample = accel_3d_capture_sample;
 373         accel_state->callbacks.pdev = pdev;
 374         ret = sensor_hub_register_callback(hsdev, HID_USAGE_SENSOR_ACCEL_3D,
 375                                         &accel_state->callbacks);
 376         if (ret < 0) {
 377                 dev_err(&pdev->dev, "callback reg failed\n");
 378                 goto error_iio_unreg;
 379         }
 380
 381         return ret;
 382
 383 error_iio_unreg:
 384         iio_device_unregister(indio_dev);
 385 error_remove_trigger:
 386         hid_sensor_remove_trigger(&accel_state->common_attributes);
 387 error_unreg_buffer_funcs:
 388         iio_triggered_buffer_cleanup(indio_dev);
 389 error_free_dev_mem:
 390         kfree(indio_dev->channels);
 391         return ret;
 392 }
 393
 394 /* Function to deinitialize the processing for usage id */
 395 static int hid_accel_3d_remove(struct platform_device *pdev)
 396 {
 397         struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
 398         struct iio_dev *indio_dev = platform_get_drvdata(pdev);
 399         struct accel_3d_state *accel_state = iio_priv(indio_dev);
 400
 401         sensor_hub_remove_callback(hsdev, HID_USAGE_SENSOR_ACCEL_3D);
 402         iio_device_unregister(indio_dev);
 403         hid_sensor_remove_trigger(&accel_state->common_attributes);
 404         iio_triggered_buffer_cleanup(indio_dev);
 405         kfree(indio_dev->channels);
 406
 407         return 0;
 408 }
 409
 410 static struct platform_device_id hid_accel_3d_ids[] = {
 411         {
 412                 /* Format: HID-SENSOR-usage_id_in_hex_lowercase */
 413                 .name = "HID-SENSOR-200073",
 414         },
 415         { /* sentinel */ }
 416 };
 417 MODULE_DEVICE_TABLE(platform, hid_accel_3d_ids);
 418
 419 static struct platform_driver hid_accel_3d_platform_driver = {
 420         .id_table = hid_accel_3d_ids,
 421         .driver = {
 422                 .name   = KBUILD_MODNAME,
 423         },
 424         .probe          = hid_accel_3d_probe,
 425         .remove         = hid_accel_3d_remove,
 426 };
 427 module_platform_driver(hid_accel_3d_platform_driver);
 428
 429 MODULE_DESCRIPTION("HID Sensor Accel 3D");
 430 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
 431 MODULE_LICENSE("GPL");