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