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