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