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