Quelle  hid-sensor-als.c   Sprache: C

// SPDX-License-Identifier: GPL-2.0-only
/*
 * HID Sensors Driver
 * Copyright (c) 2012, Intel Corporation.
 */
#include <linux/device.h>
#include <linux/platform_device.h>
#include <linux/module.h>
#include <linux/mod_devicetable.h>
#include <linux/slab.h>
#include <linux/hid-sensor-hub.h>
#include <linux/iio/iio.h>
#include <linux/iio/buffer.h>
#include "../common/hid-sensors/hid-sensor-trigger.h"

enum {
 CHANNEL_SCAN_INDEX_INTENSITY,
 CHANNEL_SCAN_INDEX_ILLUM,
 CHANNEL_SCAN_INDEX_COLOR_TEMP,
 CHANNEL_SCAN_INDEX_CHROMATICITY_X,
 CHANNEL_SCAN_INDEX_CHROMATICITY_Y,
 CHANNEL_SCAN_INDEX_MAX
};

#define CHANNEL_SCAN_INDEX_TIMESTAMP CHANNEL_SCAN_INDEX_MAX

struct als_state {
 struct hid_sensor_hub_callbacks callbacks;
 struct hid_sensor_common common_attributes;
 struct hid_sensor_hub_attribute_info als[CHANNEL_SCAN_INDEX_MAX];
 struct iio_chan_spec channels[CHANNEL_SCAN_INDEX_MAX + 1];
 struct {
  u32 illum[CHANNEL_SCAN_INDEX_MAX];
  aligned_s64 timestamp;
 } scan;
 int scale_pre_decml;
 int scale_post_decml;
 int scale_precision;
 int value_offset;
 int num_channels;
 s64 timestamp;
 unsigned long als_scan_mask[2];
};

/* The order of usage ids must match scan index starting from CHANNEL_SCAN_INDEX_INTENSITY */
static const u32 als_usage_ids[] = {
 HID_USAGE_SENSOR_LIGHT_ILLUM,
 HID_USAGE_SENSOR_LIGHT_ILLUM,
 HID_USAGE_SENSOR_LIGHT_COLOR_TEMPERATURE,
 HID_USAGE_SENSOR_LIGHT_CHROMATICITY_X,
 HID_USAGE_SENSOR_LIGHT_CHROMATICITY_Y,
};

static const u32 als_sensitivity_addresses[] = {
 HID_USAGE_SENSOR_DATA_LIGHT,
 HID_USAGE_SENSOR_LIGHT_ILLUM,
};

/* Channel definitions */
static const struct iio_chan_spec als_channels[] = {
 {
  .type = IIO_INTENSITY,
  .modified = 1,
  .channel2 = IIO_MOD_LIGHT_BOTH,
  .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
  .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
  BIT(IIO_CHAN_INFO_SCALE) |
  BIT(IIO_CHAN_INFO_SAMP_FREQ) |
  BIT(IIO_CHAN_INFO_HYSTERESIS) |
  BIT(IIO_CHAN_INFO_HYSTERESIS_RELATIVE),
  .scan_index = CHANNEL_SCAN_INDEX_INTENSITY,
 },
 {
  .type = IIO_LIGHT,
  .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
  .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
  BIT(IIO_CHAN_INFO_SCALE) |
  BIT(IIO_CHAN_INFO_SAMP_FREQ) |
  BIT(IIO_CHAN_INFO_HYSTERESIS) |
  BIT(IIO_CHAN_INFO_HYSTERESIS_RELATIVE),
  .scan_index = CHANNEL_SCAN_INDEX_ILLUM,
 },
 {
  .type = IIO_COLORTEMP,
  .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
  .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
  BIT(IIO_CHAN_INFO_SCALE) |
  BIT(IIO_CHAN_INFO_SAMP_FREQ) |
  BIT(IIO_CHAN_INFO_HYSTERESIS) |
  BIT(IIO_CHAN_INFO_HYSTERESIS_RELATIVE),
  .scan_index = CHANNEL_SCAN_INDEX_COLOR_TEMP,
 },
 {
  .type = IIO_CHROMATICITY,
  .modified = 1,
  .channel2 = IIO_MOD_X,
  .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
  .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
  BIT(IIO_CHAN_INFO_SCALE) |
  BIT(IIO_CHAN_INFO_SAMP_FREQ) |
  BIT(IIO_CHAN_INFO_HYSTERESIS) |
  BIT(IIO_CHAN_INFO_HYSTERESIS_RELATIVE),
  .scan_index = CHANNEL_SCAN_INDEX_CHROMATICITY_X,
 },
 {
  .type = IIO_CHROMATICITY,
  .modified = 1,
  .channel2 = IIO_MOD_Y,
  .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
  .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
  BIT(IIO_CHAN_INFO_SCALE) |
  BIT(IIO_CHAN_INFO_SAMP_FREQ) |
  BIT(IIO_CHAN_INFO_HYSTERESIS) |
  BIT(IIO_CHAN_INFO_HYSTERESIS_RELATIVE),
  .scan_index = CHANNEL_SCAN_INDEX_CHROMATICITY_Y,
 },
 IIO_CHAN_SOFT_TIMESTAMP(CHANNEL_SCAN_INDEX_TIMESTAMP)
};

/* Adjust channel real bits based on report descriptor */
static void als_adjust_channel_bit_mask(struct iio_chan_spec *channels,
     int channel, int size)
{
 channels[channel].scan_type.sign = 's';
 /* Real storage bits will change based on the report desc. */
 channels[channel].scan_type.realbits = size * 8;
 /* Maximum size of a sample to capture is u32 */
 channels[channel].scan_type.storagebits = sizeof(u32) * 8;
}

/* Channel read_raw handler */
static int als_read_raw(struct iio_dev *indio_dev,
         struct iio_chan_spec const *chan,
         int *val, int *val2,
         long mask)
{
 struct als_state *als_state = iio_priv(indio_dev);
 struct hid_sensor_hub_device *hsdev = als_state->common_attributes.hsdev;
 int report_id = -1;
 u32 address;
 int ret_type;
 s32 min;

 *val = 0;
 *val2 = 0;
 switch (mask) {
 case IIO_CHAN_INFO_RAW:
  switch (chan->scan_index) {
  case  CHANNEL_SCAN_INDEX_INTENSITY:
  case  CHANNEL_SCAN_INDEX_ILLUM:
   report_id = als_state->als[chan->scan_index].report_id;
   min = als_state->als[chan->scan_index].logical_minimum;
   address = HID_USAGE_SENSOR_LIGHT_ILLUM;
   break;
  case  CHANNEL_SCAN_INDEX_COLOR_TEMP:
   report_id = als_state->als[chan->scan_index].report_id;
   min = als_state->als[chan->scan_index].logical_minimum;
   address = HID_USAGE_SENSOR_LIGHT_COLOR_TEMPERATURE;
   break;
  case  CHANNEL_SCAN_INDEX_CHROMATICITY_X:
   report_id = als_state->als[chan->scan_index].report_id;
   min = als_state->als[chan->scan_index].logical_minimum;
   address = HID_USAGE_SENSOR_LIGHT_CHROMATICITY_X;
   break;
  case  CHANNEL_SCAN_INDEX_CHROMATICITY_Y:
   report_id = als_state->als[chan->scan_index].report_id;
   min = als_state->als[chan->scan_index].logical_minimum;
   address = HID_USAGE_SENSOR_LIGHT_CHROMATICITY_Y;
   break;
  default:
   report_id = -1;
   break;
  }
  if (report_id >= 0) {
   hid_sensor_power_state(&als_state->common_attributes,
      true);
   *val = sensor_hub_input_attr_get_raw_value(
     hsdev, hsdev->usage, address, report_id,
     SENSOR_HUB_SYNC, min < 0);
   hid_sensor_power_state(&als_state->common_attributes,
      false);
  } else {
   *val = 0;
   return -EINVAL;
  }
  ret_type = IIO_VAL_INT;
  break;
 case IIO_CHAN_INFO_SCALE:
  *val = als_state->scale_pre_decml;
  *val2 = als_state->scale_post_decml;
  ret_type = als_state->scale_precision;
  break;
 case IIO_CHAN_INFO_OFFSET:
  *val = als_state->value_offset;
  ret_type = IIO_VAL_INT;
  break;
 case IIO_CHAN_INFO_SAMP_FREQ:
  ret_type = hid_sensor_read_samp_freq_value(
    &als_state->common_attributes, val, val2);
  break;
 case IIO_CHAN_INFO_HYSTERESIS:
  ret_type = hid_sensor_read_raw_hyst_value(
    &als_state->common_attributes, val, val2);
  break;
 case IIO_CHAN_INFO_HYSTERESIS_RELATIVE:
  ret_type = hid_sensor_read_raw_hyst_rel_value(
    &als_state->common_attributes, val, val2);
  break;
 default:
  ret_type = -EINVAL;
  break;
 }

 return ret_type;
}

/* Channel write_raw handler */
static int als_write_raw(struct iio_dev *indio_dev,
          struct iio_chan_spec const *chan,
          int val,
          int val2,
          long mask)
{
 struct als_state *als_state = iio_priv(indio_dev);
 int ret = 0;

 switch (mask) {
 case IIO_CHAN_INFO_SAMP_FREQ:
  ret = hid_sensor_write_samp_freq_value(
    &als_state->common_attributes, val, val2);
  break;
 case IIO_CHAN_INFO_HYSTERESIS:
  ret = hid_sensor_write_raw_hyst_value(
    &als_state->common_attributes, val, val2);
  break;
 case IIO_CHAN_INFO_HYSTERESIS_RELATIVE:
  ret = hid_sensor_write_raw_hyst_rel_value(
    &als_state->common_attributes, val, val2);
  break;
 default:
  ret = -EINVAL;
 }

 return ret;
}

static const struct iio_info als_info = {
 .read_raw = &als_read_raw,
 .write_raw = &als_write_raw,
};

/* Callback handler to send event after all samples are received and captured */
static int als_proc_event(struct hid_sensor_hub_device *hsdev,
    unsigned usage_id,
    void *priv)
{
 struct iio_dev *indio_dev = platform_get_drvdata(priv);
 struct als_state *als_state = iio_priv(indio_dev);

 dev_dbg(&indio_dev->dev, "als_proc_event\n");
 if (atomic_read(&als_state->common_attributes.data_ready)) {
  if (!als_state->timestamp)
   als_state->timestamp = iio_get_time_ns(indio_dev);

  iio_push_to_buffers_with_timestamp(indio_dev, &als_state->scan,
         als_state->timestamp);
  als_state->timestamp = 0;
 }

 return 0;
}

/* Capture samples in local storage */
static int als_capture_sample(struct hid_sensor_hub_device *hsdev,
    unsigned usage_id,
    size_t raw_len, char *raw_data,
    void *priv)
{
 struct iio_dev *indio_dev = platform_get_drvdata(priv);
 struct als_state *als_state = iio_priv(indio_dev);
 int ret = -EINVAL;
 u32 sample_data = *(u32 *)raw_data;

 switch (usage_id) {
 case HID_USAGE_SENSOR_LIGHT_ILLUM:
  als_state->scan.illum[CHANNEL_SCAN_INDEX_INTENSITY] = sample_data;
  als_state->scan.illum[CHANNEL_SCAN_INDEX_ILLUM] = sample_data;
  ret = 0;
  break;
 case HID_USAGE_SENSOR_LIGHT_COLOR_TEMPERATURE:
  als_state->scan.illum[CHANNEL_SCAN_INDEX_COLOR_TEMP] = sample_data;
  ret = 0;
  break;
 case HID_USAGE_SENSOR_LIGHT_CHROMATICITY_X:
  als_state->scan.illum[CHANNEL_SCAN_INDEX_CHROMATICITY_X] = sample_data;
  ret = 0;
  break;
 case HID_USAGE_SENSOR_LIGHT_CHROMATICITY_Y:
  als_state->scan.illum[CHANNEL_SCAN_INDEX_CHROMATICITY_Y] = sample_data;
  ret = 0;
  break;
 case HID_USAGE_SENSOR_TIME_TIMESTAMP:
  als_state->timestamp = hid_sensor_convert_timestamp(&als_state->common_attributes,
            *(s64 *)raw_data);
  ret = 0;
  break;
 default:
  break;
 }

 return ret;
}

/* Parse report which is specific to an usage id*/
static int als_parse_report(struct platform_device *pdev,
    struct hid_sensor_hub_device *hsdev,
    unsigned usage_id,
    struct als_state *st)
{
 struct iio_chan_spec *channels;
 int ret, index = 0;
 int i;

 channels = st->channels;

 for (i = 0; i < CHANNEL_SCAN_INDEX_MAX; ++i) {
  ret = sensor_hub_input_get_attribute_info(hsdev,
      HID_INPUT_REPORT,
      usage_id,
      als_usage_ids[i],
      &st->als[i]);
  if (ret < 0)
   continue;

  channels[index] = als_channels[i];
  st->als_scan_mask[0] |= BIT(i);
  als_adjust_channel_bit_mask(channels, index, st->als[i].size);
  ++index;

  dev_dbg(&pdev->dev, "als %x:%x\n", st->als[i].index,
   st->als[i].report_id);
 }

 st->num_channels = index;
 /* Return success even if one usage id is present */
 if (index)
  ret = 0;

 st->scale_precision = hid_sensor_format_scale(usage_id,
    &st->als[CHANNEL_SCAN_INDEX_INTENSITY],
    &st->scale_pre_decml, &st->scale_post_decml);

 return ret;
}

/* Function to initialize the processing for usage id */
static int hid_als_probe(struct platform_device *pdev)
{
 struct hid_sensor_hub_device *hsdev = dev_get_platdata(&pdev->dev);
 int ret = 0;
 static const char *name = "als";
 struct iio_dev *indio_dev;
 struct als_state *als_state;

 indio_dev = devm_iio_device_alloc(&pdev->dev, sizeof(struct als_state));
 if (!indio_dev)
  return -ENOMEM;
 platform_set_drvdata(pdev, indio_dev);

 als_state = iio_priv(indio_dev);
 als_state->common_attributes.hsdev = hsdev;
 als_state->common_attributes.pdev = pdev;

 ret = hid_sensor_parse_common_attributes(hsdev,
     hsdev->usage,
     &als_state->common_attributes,
     als_sensitivity_addresses,
     ARRAY_SIZE(als_sensitivity_addresses));
 if (ret) {
  dev_err(&pdev->dev, "failed to setup common attributes\n");
  return ret;
 }

 ret = als_parse_report(pdev, hsdev,
          hsdev->usage,
          als_state);
 if (ret) {
  dev_err(&pdev->dev, "failed to setup attributes\n");
  return ret;
 }

 /* Add timestamp channel */
 als_state->channels[als_state->num_channels] = als_channels[CHANNEL_SCAN_INDEX_TIMESTAMP];

 /* +1 for adding timestamp channel */
 indio_dev->num_channels = als_state->num_channels + 1;

 indio_dev->channels = als_state->channels;
 indio_dev->available_scan_masks = als_state->als_scan_mask;

 indio_dev->info = &als_info;
 indio_dev->name = name;
 indio_dev->modes = INDIO_DIRECT_MODE;

 atomic_set(&als_state->common_attributes.data_ready, 0);

 ret = hid_sensor_setup_trigger(indio_dev, name,
    &als_state->common_attributes);
 if (ret < 0) {
  dev_err(&pdev->dev, "trigger setup failed\n");
  return ret;
 }

 ret = iio_device_register(indio_dev);
 if (ret) {
  dev_err(&pdev->dev, "device register failed\n");
  goto error_remove_trigger;
 }

 als_state->callbacks.send_event = als_proc_event;
 als_state->callbacks.capture_sample = als_capture_sample;
 als_state->callbacks.pdev = pdev;
 ret = sensor_hub_register_callback(hsdev, hsdev->usage, &als_state->callbacks);
 if (ret < 0) {
  dev_err(&pdev->dev, "callback reg failed\n");
  goto error_iio_unreg;
 }

 return ret;

error_iio_unreg:
 iio_device_unregister(indio_dev);
error_remove_trigger:
 hid_sensor_remove_trigger(indio_dev, &als_state->common_attributes);
 return ret;
}

/* Function to deinitialize the processing for usage id */
static void hid_als_remove(struct platform_device *pdev)
{
 struct hid_sensor_hub_device *hsdev = dev_get_platdata(&pdev->dev);
 struct iio_dev *indio_dev = platform_get_drvdata(pdev);
 struct als_state *als_state = iio_priv(indio_dev);

 sensor_hub_remove_callback(hsdev, hsdev->usage);
 iio_device_unregister(indio_dev);
 hid_sensor_remove_trigger(indio_dev, &als_state->common_attributes);
}

static const struct platform_device_id hid_als_ids[] = {
 {
  /* Format: HID-SENSOR-usage_id_in_hex_lowercase */
  .name = "HID-SENSOR-200041",
 },
 {
  /* Format: HID-SENSOR-custom_sensor_tag-usage_id_in_hex_lowercase */
  .name = "HID-SENSOR-LISS-0041",
 },
 { }
};
MODULE_DEVICE_TABLE(platform, hid_als_ids);

static struct platform_driver hid_als_platform_driver = {
 .id_table = hid_als_ids,
 .driver = {
  .name = KBUILD_MODNAME,
  .pm = &hid_sensor_pm_ops,
 },
 .probe  = hid_als_probe,
 .remove  = hid_als_remove,
};
module_platform_driver(hid_als_platform_driver);

MODULE_DESCRIPTION("HID Sensor ALS");
MODULE_AUTHOR("Srinivas Pandruvada ");
MODULE_LICENSE("GPL");
MODULE_IMPORT_NS("IIO_HID");