hid-sensor-temperature.c 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295
  1. // SPDX-License-Identifier: GPL-2.0-only
  2. /*
  3. * HID Sensors Driver
  4. * Copyright (c) 2017, Intel Corporation.
  5. */
  6. #include <linux/device.h>
  7. #include <linux/hid-sensor-hub.h>
  8. #include <linux/iio/buffer.h>
  9. #include <linux/iio/iio.h>
  10. #include <linux/module.h>
  11. #include <linux/mod_devicetable.h>
  12. #include <linux/platform_device.h>
  13. #include "../common/hid-sensors/hid-sensor-trigger.h"
  14. struct temperature_state {
  15. struct hid_sensor_common common_attributes;
  16. struct hid_sensor_hub_attribute_info temperature_attr;
  17. struct {
  18. s32 temperature_data;
  19. u64 timestamp __aligned(8);
  20. } scan;
  21. int scale_pre_decml;
  22. int scale_post_decml;
  23. int scale_precision;
  24. int value_offset;
  25. };
  26. static const u32 temperature_sensitivity_addresses[] = {
  27. HID_USAGE_SENSOR_DATA_ENVIRONMENTAL_TEMPERATURE,
  28. };
  29. /* Channel definitions */
  30. static const struct iio_chan_spec temperature_channels[] = {
  31. {
  32. .type = IIO_TEMP,
  33. .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
  34. .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
  35. BIT(IIO_CHAN_INFO_SCALE) |
  36. BIT(IIO_CHAN_INFO_SAMP_FREQ) |
  37. BIT(IIO_CHAN_INFO_HYSTERESIS),
  38. },
  39. IIO_CHAN_SOFT_TIMESTAMP(1),
  40. };
  41. /* Adjust channel real bits based on report descriptor */
  42. static void temperature_adjust_channel_bit_mask(struct iio_chan_spec *channels,
  43. int channel, int size)
  44. {
  45. channels[channel].scan_type.sign = 's';
  46. /* Real storage bits will change based on the report desc. */
  47. channels[channel].scan_type.realbits = size * 8;
  48. /* Maximum size of a sample to capture is s32 */
  49. channels[channel].scan_type.storagebits = sizeof(s32) * 8;
  50. }
  51. static int temperature_read_raw(struct iio_dev *indio_dev,
  52. struct iio_chan_spec const *chan,
  53. int *val, int *val2, long mask)
  54. {
  55. struct temperature_state *temp_st = iio_priv(indio_dev);
  56. switch (mask) {
  57. case IIO_CHAN_INFO_RAW:
  58. if (chan->type != IIO_TEMP)
  59. return -EINVAL;
  60. hid_sensor_power_state(
  61. &temp_st->common_attributes, true);
  62. *val = sensor_hub_input_attr_get_raw_value(
  63. temp_st->common_attributes.hsdev,
  64. HID_USAGE_SENSOR_TEMPERATURE,
  65. HID_USAGE_SENSOR_DATA_ENVIRONMENTAL_TEMPERATURE,
  66. temp_st->temperature_attr.report_id,
  67. SENSOR_HUB_SYNC,
  68. temp_st->temperature_attr.logical_minimum < 0);
  69. hid_sensor_power_state(
  70. &temp_st->common_attributes,
  71. false);
  72. return IIO_VAL_INT;
  73. case IIO_CHAN_INFO_SCALE:
  74. *val = temp_st->scale_pre_decml;
  75. *val2 = temp_st->scale_post_decml;
  76. return temp_st->scale_precision;
  77. case IIO_CHAN_INFO_OFFSET:
  78. *val = temp_st->value_offset;
  79. return IIO_VAL_INT;
  80. case IIO_CHAN_INFO_SAMP_FREQ:
  81. return hid_sensor_read_samp_freq_value(
  82. &temp_st->common_attributes, val, val2);
  83. case IIO_CHAN_INFO_HYSTERESIS:
  84. return hid_sensor_read_raw_hyst_value(
  85. &temp_st->common_attributes, val, val2);
  86. default:
  87. return -EINVAL;
  88. }
  89. }
  90. static int temperature_write_raw(struct iio_dev *indio_dev,
  91. struct iio_chan_spec const *chan,
  92. int val, int val2, long mask)
  93. {
  94. struct temperature_state *temp_st = iio_priv(indio_dev);
  95. switch (mask) {
  96. case IIO_CHAN_INFO_SAMP_FREQ:
  97. return hid_sensor_write_samp_freq_value(
  98. &temp_st->common_attributes, val, val2);
  99. case IIO_CHAN_INFO_HYSTERESIS:
  100. return hid_sensor_write_raw_hyst_value(
  101. &temp_st->common_attributes, val, val2);
  102. default:
  103. return -EINVAL;
  104. }
  105. }
  106. static const struct iio_info temperature_info = {
  107. .read_raw = &temperature_read_raw,
  108. .write_raw = &temperature_write_raw,
  109. };
  110. /* Callback handler to send event after all samples are received and captured */
  111. static int temperature_proc_event(struct hid_sensor_hub_device *hsdev,
  112. unsigned int usage_id, void *pdev)
  113. {
  114. struct iio_dev *indio_dev = platform_get_drvdata(pdev);
  115. struct temperature_state *temp_st = iio_priv(indio_dev);
  116. if (atomic_read(&temp_st->common_attributes.data_ready))
  117. iio_push_to_buffers_with_timestamp(indio_dev, &temp_st->scan,
  118. iio_get_time_ns(indio_dev));
  119. return 0;
  120. }
  121. /* Capture samples in local storage */
  122. static int temperature_capture_sample(struct hid_sensor_hub_device *hsdev,
  123. unsigned int usage_id, size_t raw_len,
  124. char *raw_data, void *pdev)
  125. {
  126. struct iio_dev *indio_dev = platform_get_drvdata(pdev);
  127. struct temperature_state *temp_st = iio_priv(indio_dev);
  128. switch (usage_id) {
  129. case HID_USAGE_SENSOR_DATA_ENVIRONMENTAL_TEMPERATURE:
  130. temp_st->scan.temperature_data = *(s32 *)raw_data;
  131. return 0;
  132. default:
  133. return -EINVAL;
  134. }
  135. }
  136. /* Parse report which is specific to an usage id*/
  137. static int temperature_parse_report(struct platform_device *pdev,
  138. struct hid_sensor_hub_device *hsdev,
  139. struct iio_chan_spec *channels,
  140. unsigned int usage_id,
  141. struct temperature_state *st)
  142. {
  143. int ret;
  144. ret = sensor_hub_input_get_attribute_info(hsdev, HID_INPUT_REPORT,
  145. usage_id,
  146. HID_USAGE_SENSOR_DATA_ENVIRONMENTAL_TEMPERATURE,
  147. &st->temperature_attr);
  148. if (ret < 0)
  149. return ret;
  150. temperature_adjust_channel_bit_mask(channels, 0,
  151. st->temperature_attr.size);
  152. st->scale_precision = hid_sensor_format_scale(
  153. HID_USAGE_SENSOR_TEMPERATURE,
  154. &st->temperature_attr,
  155. &st->scale_pre_decml, &st->scale_post_decml);
  156. return ret;
  157. }
  158. static struct hid_sensor_hub_callbacks temperature_callbacks = {
  159. .send_event = &temperature_proc_event,
  160. .capture_sample = &temperature_capture_sample,
  161. };
  162. /* Function to initialize the processing for usage id */
  163. static int hid_temperature_probe(struct platform_device *pdev)
  164. {
  165. static const char *name = "temperature";
  166. struct iio_dev *indio_dev;
  167. struct temperature_state *temp_st;
  168. struct iio_chan_spec *temp_chans;
  169. struct hid_sensor_hub_device *hsdev = dev_get_platdata(&pdev->dev);
  170. int ret;
  171. indio_dev = devm_iio_device_alloc(&pdev->dev, sizeof(*temp_st));
  172. if (!indio_dev)
  173. return -ENOMEM;
  174. temp_st = iio_priv(indio_dev);
  175. temp_st->common_attributes.hsdev = hsdev;
  176. temp_st->common_attributes.pdev = pdev;
  177. ret = hid_sensor_parse_common_attributes(hsdev,
  178. HID_USAGE_SENSOR_TEMPERATURE,
  179. &temp_st->common_attributes,
  180. temperature_sensitivity_addresses,
  181. ARRAY_SIZE(temperature_sensitivity_addresses));
  182. if (ret)
  183. return ret;
  184. temp_chans = devm_kmemdup(&indio_dev->dev, temperature_channels,
  185. sizeof(temperature_channels), GFP_KERNEL);
  186. if (!temp_chans)
  187. return -ENOMEM;
  188. ret = temperature_parse_report(pdev, hsdev, temp_chans,
  189. HID_USAGE_SENSOR_TEMPERATURE, temp_st);
  190. if (ret)
  191. return ret;
  192. indio_dev->channels = temp_chans;
  193. indio_dev->num_channels = ARRAY_SIZE(temperature_channels);
  194. indio_dev->info = &temperature_info;
  195. indio_dev->name = name;
  196. indio_dev->modes = INDIO_DIRECT_MODE;
  197. atomic_set(&temp_st->common_attributes.data_ready, 0);
  198. ret = hid_sensor_setup_trigger(indio_dev, name,
  199. &temp_st->common_attributes);
  200. if (ret)
  201. return ret;
  202. platform_set_drvdata(pdev, indio_dev);
  203. temperature_callbacks.pdev = pdev;
  204. ret = sensor_hub_register_callback(hsdev, HID_USAGE_SENSOR_TEMPERATURE,
  205. &temperature_callbacks);
  206. if (ret)
  207. goto error_remove_trigger;
  208. ret = devm_iio_device_register(indio_dev->dev.parent, indio_dev);
  209. if (ret)
  210. goto error_remove_callback;
  211. return ret;
  212. error_remove_callback:
  213. sensor_hub_remove_callback(hsdev, HID_USAGE_SENSOR_TEMPERATURE);
  214. error_remove_trigger:
  215. hid_sensor_remove_trigger(indio_dev, &temp_st->common_attributes);
  216. return ret;
  217. }
  218. /* Function to deinitialize the processing for usage id */
  219. static int hid_temperature_remove(struct platform_device *pdev)
  220. {
  221. struct hid_sensor_hub_device *hsdev = dev_get_platdata(&pdev->dev);
  222. struct iio_dev *indio_dev = platform_get_drvdata(pdev);
  223. struct temperature_state *temp_st = iio_priv(indio_dev);
  224. sensor_hub_remove_callback(hsdev, HID_USAGE_SENSOR_TEMPERATURE);
  225. hid_sensor_remove_trigger(indio_dev, &temp_st->common_attributes);
  226. return 0;
  227. }
  228. static const struct platform_device_id hid_temperature_ids[] = {
  229. {
  230. /* Format: HID-SENSOR-usage_id_in_hex_lowercase */
  231. .name = "HID-SENSOR-200033",
  232. },
  233. { /* sentinel */ }
  234. };
  235. MODULE_DEVICE_TABLE(platform, hid_temperature_ids);
  236. static struct platform_driver hid_temperature_platform_driver = {
  237. .id_table = hid_temperature_ids,
  238. .driver = {
  239. .name = "temperature-sensor",
  240. .pm = &hid_sensor_pm_ops,
  241. },
  242. .probe = hid_temperature_probe,
  243. .remove = hid_temperature_remove,
  244. };
  245. module_platform_driver(hid_temperature_platform_driver);
  246. MODULE_DESCRIPTION("HID Environmental temperature sensor");
  247. MODULE_AUTHOR("Song Hongyan <[email protected]>");
  248. MODULE_LICENSE("GPL v2");
  249. MODULE_IMPORT_NS(IIO_HID);