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