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