drivers/iio/light/hid-sensor-prox.c

   1 /*
   2  * HID Sensors Driver
   3  * Copyright (c) 2014, 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.
  16  *
  17  */
  18 #include <linux/device.h>
  19 #include <linux/platform_device.h>
  20 #include <linux/module.h>
  21 #include <linux/interrupt.h>
  22 #include <linux/irq.h>
  23 #include <linux/slab.h>
  24 #include <linux/delay.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 #define CHANNEL_SCAN_INDEX_PRESENCE 0
  34
  35 struct prox_state {
  36         struct hid_sensor_hub_callbacks callbacks;
  37         struct hid_sensor_common common_attributes;
  38         struct hid_sensor_hub_attribute_info prox_attr;
  39         u32 human_presence;
  40 };
  41
  42 /* Channel definitions */
  43 static const struct iio_chan_spec prox_channels[] = {
  44         {
  45                 .type = IIO_PROXIMITY,
  46                 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
  47                 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
  48                 BIT(IIO_CHAN_INFO_SCALE) |
  49                 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
  50                 BIT(IIO_CHAN_INFO_HYSTERESIS),
  51                 .scan_index = CHANNEL_SCAN_INDEX_PRESENCE,
  52         }
  53 };
  54
  55 /* Adjust channel real bits based on report descriptor */
  56 static void prox_adjust_channel_bit_mask(struct iio_chan_spec *channels,
  57                                         int channel, int size)
  58 {
  59         channels[channel].scan_type.sign = 's';
  60         /* Real storage bits will change based on the report desc. */
  61         channels[channel].scan_type.realbits = size * 8;
  62         /* Maximum size of a sample to capture is u32 */
  63         channels[channel].scan_type.storagebits = sizeof(u32) * 8;
  64 }
  65
  66 /* Channel read_raw handler */
  67 static int prox_read_raw(struct iio_dev *indio_dev,
  68                               struct iio_chan_spec const *chan,
  69                               int *val, int *val2,
  70                               long mask)
  71 {
  72         struct prox_state *prox_state = iio_priv(indio_dev);
  73         int report_id = -1;
  74         u32 address;
  75         int ret_type;
  76         s32 min;
  77
  78         *val = 0;
  79         *val2 = 0;
  80         switch (mask) {
  81         case IIO_CHAN_INFO_RAW:
  82                 switch (chan->scan_index) {
  83                 case  CHANNEL_SCAN_INDEX_PRESENCE:
  84                         report_id = prox_state->prox_attr.report_id;
  85                         min = prox_state->prox_attr.logical_minimum;
  86                         address = HID_USAGE_SENSOR_HUMAN_PRESENCE;
  87                         break;
  88                 default:
  89                         report_id = -1;
  90                         break;
  91                 }
  92                 if (report_id >= 0) {
  93                         hid_sensor_power_state(&prox_state->common_attributes,
  94                                                 true);
  95                         *val = sensor_hub_input_attr_get_raw_value(
  96                                 prox_state->common_attributes.hsdev,
  97                                 HID_USAGE_SENSOR_PROX, address,
  98                                 report_id,
  99                                 SENSOR_HUB_SYNC,
 100                                 min < 0);
 101                         hid_sensor_power_state(&prox_state->common_attributes,
 102                                                 false);
 103                 } else {
 104                         *val = 0;
 105                         return -EINVAL;
 106                 }
 107                 ret_type = IIO_VAL_INT;
 108                 break;
 109         case IIO_CHAN_INFO_SCALE:
 110                 *val = prox_state->prox_attr.units;
 111                 ret_type = IIO_VAL_INT;
 112                 break;
 113         case IIO_CHAN_INFO_OFFSET:
 114                 *val = hid_sensor_convert_exponent(
 115                                 prox_state->prox_attr.unit_expo);
 116                 ret_type = IIO_VAL_INT;
 117                 break;
 118         case IIO_CHAN_INFO_SAMP_FREQ:
 119                 ret_type = hid_sensor_read_samp_freq_value(
 120                                 &prox_state->common_attributes, val, val2);
 121                 break;
 122         case IIO_CHAN_INFO_HYSTERESIS:
 123                 ret_type = hid_sensor_read_raw_hyst_value(
 124                                 &prox_state->common_attributes, val, val2);
 125                 break;
 126         default:
 127                 ret_type = -EINVAL;
 128                 break;
 129         }
 130
 131         return ret_type;
 132 }
 133
 134 /* Channel write_raw handler */
 135 static int prox_write_raw(struct iio_dev *indio_dev,
 136                                struct iio_chan_spec const *chan,
 137                                int val,
 138                                int val2,
 139                                long mask)
 140 {
 141         struct prox_state *prox_state = iio_priv(indio_dev);
 142         int ret = 0;
 143
 144         switch (mask) {
 145         case IIO_CHAN_INFO_SAMP_FREQ:
 146                 ret = hid_sensor_write_samp_freq_value(
 147                                 &prox_state->common_attributes, val, val2);
 148                 break;
 149         case IIO_CHAN_INFO_HYSTERESIS:
 150                 ret = hid_sensor_write_raw_hyst_value(
 151                                 &prox_state->common_attributes, val, val2);
 152                 break;
 153         default:
 154                 ret = -EINVAL;
 155         }
 156
 157         return ret;
 158 }
 159
 160 static const struct iio_info prox_info = {
 161         .read_raw = &prox_read_raw,
 162         .write_raw = &prox_write_raw,
 163 };
 164
 165 /* Function to push data to buffer */
 166 static void hid_sensor_push_data(struct iio_dev *indio_dev, const void *data,
 167                                         int len)
 168 {
 169         dev_dbg(&indio_dev->dev, "hid_sensor_push_data\n");
 170         iio_push_to_buffers(indio_dev, data);
 171 }
 172
 173 /* Callback handler to send event after all samples are received and captured */
 174 static int prox_proc_event(struct hid_sensor_hub_device *hsdev,
 175                                 unsigned usage_id,
 176                                 void *priv)
 177 {
 178         struct iio_dev *indio_dev = platform_get_drvdata(priv);
 179         struct prox_state *prox_state = iio_priv(indio_dev);
 180
 181         dev_dbg(&indio_dev->dev, "prox_proc_event\n");
 182         if (atomic_read(&prox_state->common_attributes.data_ready))
 183                 hid_sensor_push_data(indio_dev,
 184                                 &prox_state->human_presence,
 185                                 sizeof(prox_state->human_presence));
 186
 187         return 0;
 188 }
 189
 190 /* Capture samples in local storage */
 191 static int prox_capture_sample(struct hid_sensor_hub_device *hsdev,
 192                                 unsigned usage_id,
 193                                 size_t raw_len, char *raw_data,
 194                                 void *priv)
 195 {
 196         struct iio_dev *indio_dev = platform_get_drvdata(priv);
 197         struct prox_state *prox_state = iio_priv(indio_dev);
 198         int ret = -EINVAL;
 199
 200         switch (usage_id) {
 201         case HID_USAGE_SENSOR_HUMAN_PRESENCE:
 202                 prox_state->human_presence = *(u32 *)raw_data;
 203                 ret = 0;
 204                 break;
 205         default:
 206                 break;
 207         }
 208
 209         return ret;
 210 }
 211
 212 /* Parse report which is specific to an usage id*/
 213 static int prox_parse_report(struct platform_device *pdev,
 214                                 struct hid_sensor_hub_device *hsdev,
 215                                 struct iio_chan_spec *channels,
 216                                 unsigned usage_id,
 217                                 struct prox_state *st)
 218 {
 219         int ret;
 220
 221         ret = sensor_hub_input_get_attribute_info(hsdev, HID_INPUT_REPORT,
 222                         usage_id,
 223                         HID_USAGE_SENSOR_HUMAN_PRESENCE,
 224                         &st->prox_attr);
 225         if (ret < 0)
 226                 return ret;
 227         prox_adjust_channel_bit_mask(channels, CHANNEL_SCAN_INDEX_PRESENCE,
 228                                         st->prox_attr.size);
 229
 230         dev_dbg(&pdev->dev, "prox %x:%x\n", st->prox_attr.index,
 231                         st->prox_attr.report_id);
 232
 233         /* Set Sensitivity field ids, when there is no individual modifier */
 234         if (st->common_attributes.sensitivity.index < 0) {
 235                 sensor_hub_input_get_attribute_info(hsdev,
 236                         HID_FEATURE_REPORT, usage_id,
 237                         HID_USAGE_SENSOR_DATA_MOD_CHANGE_SENSITIVITY_ABS |
 238                         HID_USAGE_SENSOR_DATA_PRESENCE,
 239                         &st->common_attributes.sensitivity);
 240                 dev_dbg(&pdev->dev, "Sensitivity index:report %d:%d\n",
 241                         st->common_attributes.sensitivity.index,
 242                         st->common_attributes.sensitivity.report_id);
 243         }
 244         if (st->common_attributes.sensitivity.index < 0)
 245                 sensor_hub_input_get_attribute_info(hsdev,
 246                         HID_FEATURE_REPORT, usage_id,
 247                         HID_USAGE_SENSOR_DATA_MOD_CHANGE_SENSITIVITY_ABS |
 248                         HID_USAGE_SENSOR_HUMAN_PRESENCE,
 249                         &st->common_attributes.sensitivity);
 250
 251         return ret;
 252 }
 253
 254 /* Function to initialize the processing for usage id */
 255 static int hid_prox_probe(struct platform_device *pdev)
 256 {
 257         int ret = 0;
 258         static const char *name = "prox";
 259         struct iio_dev *indio_dev;
 260         struct prox_state *prox_state;
 261         struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
 262
 263         indio_dev = devm_iio_device_alloc(&pdev->dev,
 264                                 sizeof(struct prox_state));
 265         if (!indio_dev)
 266                 return -ENOMEM;
 267         platform_set_drvdata(pdev, indio_dev);
 268
 269         prox_state = iio_priv(indio_dev);
 270         prox_state->common_attributes.hsdev = hsdev;
 271         prox_state->common_attributes.pdev = pdev;
 272
 273         ret = hid_sensor_parse_common_attributes(hsdev, HID_USAGE_SENSOR_PROX,
 274                                         &prox_state->common_attributes);
 275         if (ret) {
 276                 dev_err(&pdev->dev, "failed to setup common attributes\n");
 277                 return ret;
 278         }
 279
 280         indio_dev->channels = kmemdup(prox_channels, sizeof(prox_channels),
 281                                       GFP_KERNEL);
 282         if (!indio_dev->channels) {
 283                 dev_err(&pdev->dev, "failed to duplicate channels\n");
 284                 return -ENOMEM;
 285         }
 286
 287         ret = prox_parse_report(pdev, hsdev,
 288                                 (struct iio_chan_spec *)indio_dev->channels,
 289                                 HID_USAGE_SENSOR_PROX, prox_state);
 290         if (ret) {
 291                 dev_err(&pdev->dev, "failed to setup attributes\n");
 292                 goto error_free_dev_mem;
 293         }
 294
 295         indio_dev->num_channels = ARRAY_SIZE(prox_channels);
 296         indio_dev->dev.parent = &pdev->dev;
 297         indio_dev->info = &prox_info;
 298         indio_dev->name = name;
 299         indio_dev->modes = INDIO_DIRECT_MODE;
 300
 301         ret = iio_triggered_buffer_setup(indio_dev, &iio_pollfunc_store_time,
 302                 NULL, NULL);
 303         if (ret) {
 304                 dev_err(&pdev->dev, "failed to initialize trigger buffer\n");
 305                 goto error_free_dev_mem;
 306         }
 307         atomic_set(&prox_state->common_attributes.data_ready, 0);
 308         ret = hid_sensor_setup_trigger(indio_dev, name,
 309                                 &prox_state->common_attributes);
 310         if (ret) {
 311                 dev_err(&pdev->dev, "trigger setup failed\n");
 312                 goto error_unreg_buffer_funcs;
 313         }
 314
 315         ret = iio_device_register(indio_dev);
 316         if (ret) {
 317                 dev_err(&pdev->dev, "device register failed\n");
 318                 goto error_remove_trigger;
 319         }
 320
 321         prox_state->callbacks.send_event = prox_proc_event;
 322         prox_state->callbacks.capture_sample = prox_capture_sample;
 323         prox_state->callbacks.pdev = pdev;
 324         ret = sensor_hub_register_callback(hsdev, HID_USAGE_SENSOR_PROX,
 325                                         &prox_state->callbacks);
 326         if (ret < 0) {
 327                 dev_err(&pdev->dev, "callback reg failed\n");
 328                 goto error_iio_unreg;
 329         }
 330
 331         return ret;
 332
 333 error_iio_unreg:
 334         iio_device_unregister(indio_dev);
 335 error_remove_trigger:
 336         hid_sensor_remove_trigger(&prox_state->common_attributes);
 337 error_unreg_buffer_funcs:
 338         iio_triggered_buffer_cleanup(indio_dev);
 339 error_free_dev_mem:
 340         kfree(indio_dev->channels);
 341         return ret;
 342 }
 343
 344 /* Function to deinitialize the processing for usage id */
 345 static int hid_prox_remove(struct platform_device *pdev)
 346 {
 347         struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
 348         struct iio_dev *indio_dev = platform_get_drvdata(pdev);
 349         struct prox_state *prox_state = iio_priv(indio_dev);
 350
 351         sensor_hub_remove_callback(hsdev, HID_USAGE_SENSOR_PROX);
 352         iio_device_unregister(indio_dev);
 353         hid_sensor_remove_trigger(&prox_state->common_attributes);
 354         iio_triggered_buffer_cleanup(indio_dev);
 355         kfree(indio_dev->channels);
 356
 357         return 0;
 358 }
 359
 360 static const struct platform_device_id hid_prox_ids[] = {
 361         {
 362                 /* Format: HID-SENSOR-usage_id_in_hex_lowercase */
 363                 .name = "HID-SENSOR-200011",
 364         },
 365         { /* sentinel */ }
 366 };
 367 MODULE_DEVICE_TABLE(platform, hid_prox_ids);
 368
 369 static struct platform_driver hid_prox_platform_driver = {
 370         .id_table = hid_prox_ids,
 371         .driver = {
 372                 .name   = KBUILD_MODNAME,
 373                 .pm     = &hid_sensor_pm_ops,
 374         },
 375         .probe          = hid_prox_probe,
 376         .remove         = hid_prox_remove,
 377 };
 378 module_platform_driver(hid_prox_platform_driver);
 379
 380 MODULE_DESCRIPTION("HID Sensor Proximity");
 381 MODULE_AUTHOR("Archana Patni <archana.patni@intel.com>");
 382 MODULE_LICENSE("GPL");