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