Version:  2.0.40 2.2.26 2.4.37 3.4 3.5 3.6 3.7 3.8 3.9 3.10 3.11 3.12 3.13 3.14 3.15 3.16 3.17 3.18 3.19 4.0

Linux/drivers/iio/magnetometer/hid-sensor-magn-3d.c

  1 /*
  2  * HID Sensors Driver
  3  * Copyright (c) 2012, 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; if not, write to the Free Software Foundation, Inc.,
 16  * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
 17  *
 18  */
 19 #include <linux/device.h>
 20 #include <linux/platform_device.h>
 21 #include <linux/module.h>
 22 #include <linux/interrupt.h>
 23 #include <linux/irq.h>
 24 #include <linux/slab.h>
 25 #include <linux/delay.h>
 26 #include <linux/hid-sensor-hub.h>
 27 #include <linux/iio/iio.h>
 28 #include <linux/iio/sysfs.h>
 29 #include <linux/iio/buffer.h>
 30 #include <linux/iio/trigger_consumer.h>
 31 #include <linux/iio/triggered_buffer.h>
 32 #include "../common/hid-sensors/hid-sensor-trigger.h"
 33 
 34 enum magn_3d_channel {
 35         CHANNEL_SCAN_INDEX_X,
 36         CHANNEL_SCAN_INDEX_Y,
 37         CHANNEL_SCAN_INDEX_Z,
 38         CHANNEL_SCAN_INDEX_NORTH_MAGN_TILT_COMP,
 39         CHANNEL_SCAN_INDEX_NORTH_TRUE_TILT_COMP,
 40         CHANNEL_SCAN_INDEX_NORTH_MAGN,
 41         CHANNEL_SCAN_INDEX_NORTH_TRUE,
 42         MAGN_3D_CHANNEL_MAX,
 43 };
 44 
 45 struct magn_3d_state {
 46         struct hid_sensor_hub_callbacks callbacks;
 47         struct hid_sensor_common common_attributes;
 48         struct hid_sensor_hub_attribute_info magn[MAGN_3D_CHANNEL_MAX];
 49 
 50         /* dynamically sized array to hold sensor values */
 51         u32 *iio_vals;
 52         /* array of pointers to sensor value */
 53         u32 *magn_val_addr[MAGN_3D_CHANNEL_MAX];
 54 
 55         int scale_pre_decml;
 56         int scale_post_decml;
 57         int scale_precision;
 58         int value_offset;
 59 };
 60 
 61 static const u32 magn_3d_addresses[MAGN_3D_CHANNEL_MAX] = {
 62         HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS,
 63         HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Y_AXIS,
 64         HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Z_AXIS,
 65         HID_USAGE_SENSOR_ORIENT_COMP_MAGN_NORTH,
 66         HID_USAGE_SENSOR_ORIENT_COMP_TRUE_NORTH,
 67         HID_USAGE_SENSOR_ORIENT_MAGN_NORTH,
 68         HID_USAGE_SENSOR_ORIENT_TRUE_NORTH,
 69 };
 70 
 71 /* Channel definitions */
 72 static const struct iio_chan_spec magn_3d_channels[] = {
 73         {
 74                 .type = IIO_MAGN,
 75                 .modified = 1,
 76                 .channel2 = IIO_MOD_X,
 77                 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
 78                 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
 79                 BIT(IIO_CHAN_INFO_SCALE) |
 80                 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
 81                 BIT(IIO_CHAN_INFO_HYSTERESIS),
 82         }, {
 83                 .type = IIO_MAGN,
 84                 .modified = 1,
 85                 .channel2 = IIO_MOD_Y,
 86                 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
 87                 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
 88                 BIT(IIO_CHAN_INFO_SCALE) |
 89                 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
 90                 BIT(IIO_CHAN_INFO_HYSTERESIS),
 91         }, {
 92                 .type = IIO_MAGN,
 93                 .modified = 1,
 94                 .channel2 = IIO_MOD_Z,
 95                 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
 96                 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
 97                 BIT(IIO_CHAN_INFO_SCALE) |
 98                 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
 99                 BIT(IIO_CHAN_INFO_HYSTERESIS),
100         }, {
101                 .type = IIO_ROT,
102                 .modified = 1,
103                 .channel2 = IIO_MOD_NORTH_MAGN_TILT_COMP,
104                 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
105                 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
106                 BIT(IIO_CHAN_INFO_SCALE) |
107                 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
108                 BIT(IIO_CHAN_INFO_HYSTERESIS),
109         }, {
110                 .type = IIO_ROT,
111                 .modified = 1,
112                 .channel2 = IIO_MOD_NORTH_TRUE_TILT_COMP,
113                 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
114                 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
115                 BIT(IIO_CHAN_INFO_SCALE) |
116                 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
117                 BIT(IIO_CHAN_INFO_HYSTERESIS),
118         }, {
119                 .type = IIO_ROT,
120                 .modified = 1,
121                 .channel2 = IIO_MOD_NORTH_MAGN,
122                 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
123                 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
124                 BIT(IIO_CHAN_INFO_SCALE) |
125                 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
126                 BIT(IIO_CHAN_INFO_HYSTERESIS),
127         }, {
128                 .type = IIO_ROT,
129                 .modified = 1,
130                 .channel2 = IIO_MOD_NORTH_TRUE,
131                 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
132                 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET) |
133                 BIT(IIO_CHAN_INFO_SCALE) |
134                 BIT(IIO_CHAN_INFO_SAMP_FREQ) |
135                 BIT(IIO_CHAN_INFO_HYSTERESIS),
136         }
137 };
138 
139 /* Adjust channel real bits based on report descriptor */
140 static void magn_3d_adjust_channel_bit_mask(struct iio_chan_spec *channels,
141                                                 int channel, int size)
142 {
143         channels[channel].scan_type.sign = 's';
144         /* Real storage bits will change based on the report desc. */
145         channels[channel].scan_type.realbits = size * 8;
146         /* Maximum size of a sample to capture is u32 */
147         channels[channel].scan_type.storagebits = sizeof(u32) * 8;
148 }
149 
150 /* Channel read_raw handler */
151 static int magn_3d_read_raw(struct iio_dev *indio_dev,
152                               struct iio_chan_spec const *chan,
153                               int *val, int *val2,
154                               long mask)
155 {
156         struct magn_3d_state *magn_state = iio_priv(indio_dev);
157         int report_id = -1;
158         u32 address;
159         int ret_type;
160 
161         *val = 0;
162         *val2 = 0;
163         switch (mask) {
164         case 0:
165                 hid_sensor_power_state(&magn_state->common_attributes, true);
166                 report_id =
167                         magn_state->magn[chan->address].report_id;
168                 address = magn_3d_addresses[chan->address];
169                 if (report_id >= 0)
170                         *val = sensor_hub_input_attr_get_raw_value(
171                                 magn_state->common_attributes.hsdev,
172                                 HID_USAGE_SENSOR_COMPASS_3D, address,
173                                 report_id);
174                 else {
175                         *val = 0;
176                         hid_sensor_power_state(&magn_state->common_attributes,
177                                                 false);
178                         return -EINVAL;
179                 }
180                 hid_sensor_power_state(&magn_state->common_attributes, false);
181                 ret_type = IIO_VAL_INT;
182                 break;
183         case IIO_CHAN_INFO_SCALE:
184                 *val = magn_state->scale_pre_decml;
185                 *val2 = magn_state->scale_post_decml;
186                 ret_type = magn_state->scale_precision;
187                 break;
188         case IIO_CHAN_INFO_OFFSET:
189                 *val = magn_state->value_offset;
190                 ret_type = IIO_VAL_INT;
191                 break;
192         case IIO_CHAN_INFO_SAMP_FREQ:
193                 ret_type = hid_sensor_read_samp_freq_value(
194                         &magn_state->common_attributes, val, val2);
195                 break;
196         case IIO_CHAN_INFO_HYSTERESIS:
197                 ret_type = hid_sensor_read_raw_hyst_value(
198                         &magn_state->common_attributes, val, val2);
199                 break;
200         default:
201                 ret_type = -EINVAL;
202                 break;
203         }
204 
205         return ret_type;
206 }
207 
208 /* Channel write_raw handler */
209 static int magn_3d_write_raw(struct iio_dev *indio_dev,
210                                struct iio_chan_spec const *chan,
211                                int val,
212                                int val2,
213                                long mask)
214 {
215         struct magn_3d_state *magn_state = iio_priv(indio_dev);
216         int ret = 0;
217 
218         switch (mask) {
219         case IIO_CHAN_INFO_SAMP_FREQ:
220                 ret = hid_sensor_write_samp_freq_value(
221                                 &magn_state->common_attributes, val, val2);
222                 break;
223         case IIO_CHAN_INFO_HYSTERESIS:
224                 ret = hid_sensor_write_raw_hyst_value(
225                                 &magn_state->common_attributes, val, val2);
226                 break;
227         default:
228                 ret = -EINVAL;
229         }
230 
231         return ret;
232 }
233 
234 static const struct iio_info magn_3d_info = {
235         .driver_module = THIS_MODULE,
236         .read_raw = &magn_3d_read_raw,
237         .write_raw = &magn_3d_write_raw,
238 };
239 
240 /* Function to push data to buffer */
241 static void hid_sensor_push_data(struct iio_dev *indio_dev, const void *data)
242 {
243         dev_dbg(&indio_dev->dev, "hid_sensor_push_data\n");
244         iio_push_to_buffers(indio_dev, data);
245 }
246 
247 /* Callback handler to send event after all samples are received and captured */
248 static int magn_3d_proc_event(struct hid_sensor_hub_device *hsdev,
249                                 unsigned usage_id,
250                                 void *priv)
251 {
252         struct iio_dev *indio_dev = platform_get_drvdata(priv);
253         struct magn_3d_state *magn_state = iio_priv(indio_dev);
254 
255         dev_dbg(&indio_dev->dev, "magn_3d_proc_event\n");
256         if (atomic_read(&magn_state->common_attributes.data_ready))
257                 hid_sensor_push_data(indio_dev, magn_state->iio_vals);
258 
259         return 0;
260 }
261 
262 /* Capture samples in local storage */
263 static int magn_3d_capture_sample(struct hid_sensor_hub_device *hsdev,
264                                 unsigned usage_id,
265                                 size_t raw_len, char *raw_data,
266                                 void *priv)
267 {
268         struct iio_dev *indio_dev = platform_get_drvdata(priv);
269         struct magn_3d_state *magn_state = iio_priv(indio_dev);
270         int offset;
271         int ret = 0;
272         u32 *iio_val = NULL;
273 
274         switch (usage_id) {
275         case HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS:
276         case HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Y_AXIS:
277         case HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_Z_AXIS:
278                 offset = (usage_id - HID_USAGE_SENSOR_ORIENT_MAGN_FLUX_X_AXIS)
279                                 + CHANNEL_SCAN_INDEX_X;
280         break;
281         case HID_USAGE_SENSOR_ORIENT_COMP_MAGN_NORTH:
282         case HID_USAGE_SENSOR_ORIENT_COMP_TRUE_NORTH:
283         case HID_USAGE_SENSOR_ORIENT_MAGN_NORTH:
284         case HID_USAGE_SENSOR_ORIENT_TRUE_NORTH:
285                 offset = (usage_id - HID_USAGE_SENSOR_ORIENT_COMP_MAGN_NORTH)
286                                 + CHANNEL_SCAN_INDEX_NORTH_MAGN_TILT_COMP;
287         break;
288         default:
289                 return -EINVAL;
290         }
291 
292         iio_val = magn_state->magn_val_addr[offset];
293 
294         if (iio_val != NULL)
295                 *iio_val = *((u32 *)raw_data);
296         else
297                 ret = -EINVAL;
298 
299         return ret;
300 }
301 
302 /* Parse report which is specific to an usage id*/
303 static int magn_3d_parse_report(struct platform_device *pdev,
304                                 struct hid_sensor_hub_device *hsdev,
305                                 struct iio_chan_spec **channels,
306                                 int *chan_count,
307                                 unsigned usage_id,
308                                 struct magn_3d_state *st)
309 {
310         int i;
311         int attr_count = 0;
312         struct iio_chan_spec *_channels;
313 
314         /* Scan for each usage attribute supported */
315         for (i = 0; i < MAGN_3D_CHANNEL_MAX; i++) {
316                 int status;
317                 u32 address = magn_3d_addresses[i];
318 
319                 /* Check if usage attribute exists in the sensor hub device */
320                 status = sensor_hub_input_get_attribute_info(hsdev,
321                         HID_INPUT_REPORT,
322                         usage_id,
323                         address,
324                         &(st->magn[i]));
325                 if (!status)
326                         attr_count++;
327         }
328 
329         if (attr_count <= 0) {
330                 dev_err(&pdev->dev,
331                         "failed to find any supported usage attributes in report\n");
332                 return  -EINVAL;
333         }
334 
335         dev_dbg(&pdev->dev, "magn_3d Found %d usage attributes\n",
336                         attr_count);
337         dev_dbg(&pdev->dev, "magn_3d X: %x:%x Y: %x:%x Z: %x:%x\n",
338                         st->magn[0].index,
339                         st->magn[0].report_id,
340                         st->magn[1].index, st->magn[1].report_id,
341                         st->magn[2].index, st->magn[2].report_id);
342 
343         /* Setup IIO channel array */
344         _channels = devm_kcalloc(&pdev->dev, attr_count,
345                                 sizeof(struct iio_chan_spec),
346                                 GFP_KERNEL);
347         if (!_channels) {
348                 dev_err(&pdev->dev,
349                         "failed to allocate space for iio channels\n");
350                 return -ENOMEM;
351         }
352 
353         st->iio_vals = devm_kcalloc(&pdev->dev, attr_count,
354                                 sizeof(u32),
355                                 GFP_KERNEL);
356         if (!st->iio_vals) {
357                 dev_err(&pdev->dev,
358                         "failed to allocate space for iio values array\n");
359                 return -ENOMEM;
360         }
361 
362         for (i = 0, *chan_count = 0;
363         i < MAGN_3D_CHANNEL_MAX && *chan_count < attr_count;
364         i++){
365                 if (st->magn[i].index >= 0) {
366                         /* Setup IIO channel struct */
367                         (_channels[*chan_count]) = magn_3d_channels[i];
368                         (_channels[*chan_count]).scan_index = *chan_count;
369                         (_channels[*chan_count]).address = i;
370 
371                         /* Set magn_val_addr to iio value address */
372                         st->magn_val_addr[i] = &(st->iio_vals[*chan_count]);
373                         magn_3d_adjust_channel_bit_mask(_channels,
374                                                         *chan_count,
375                                                         st->magn[i].size);
376                         (*chan_count)++;
377                 }
378         }
379 
380         if (*chan_count <= 0) {
381                 dev_err(&pdev->dev,
382                         "failed to find any magnetic channels setup\n");
383                 return -EINVAL;
384         }
385 
386         *channels = _channels;
387 
388         dev_dbg(&pdev->dev, "magn_3d Setup %d IIO channels\n",
389                         *chan_count);
390 
391         st->scale_precision = hid_sensor_format_scale(
392                                 HID_USAGE_SENSOR_COMPASS_3D,
393                                 &st->magn[CHANNEL_SCAN_INDEX_X],
394                                 &st->scale_pre_decml, &st->scale_post_decml);
395 
396         /* Set Sensitivity field ids, when there is no individual modifier */
397         if (st->common_attributes.sensitivity.index < 0) {
398                 sensor_hub_input_get_attribute_info(hsdev,
399                         HID_FEATURE_REPORT, usage_id,
400                         HID_USAGE_SENSOR_DATA_MOD_CHANGE_SENSITIVITY_ABS |
401                         HID_USAGE_SENSOR_DATA_ORIENTATION,
402                         &st->common_attributes.sensitivity);
403                 dev_dbg(&pdev->dev, "Sensitivity index:report %d:%d\n",
404                         st->common_attributes.sensitivity.index,
405                         st->common_attributes.sensitivity.report_id);
406         }
407 
408         return 0;
409 }
410 
411 /* Function to initialize the processing for usage id */
412 static int hid_magn_3d_probe(struct platform_device *pdev)
413 {
414         int ret = 0;
415         static char *name = "magn_3d";
416         struct iio_dev *indio_dev;
417         struct magn_3d_state *magn_state;
418         struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
419         struct iio_chan_spec *channels;
420         int chan_count = 0;
421 
422         indio_dev = devm_iio_device_alloc(&pdev->dev,
423                                           sizeof(struct magn_3d_state));
424         if (indio_dev == NULL)
425                 return -ENOMEM;
426 
427         platform_set_drvdata(pdev, indio_dev);
428 
429         magn_state = iio_priv(indio_dev);
430         magn_state->common_attributes.hsdev = hsdev;
431         magn_state->common_attributes.pdev = pdev;
432 
433         ret = hid_sensor_parse_common_attributes(hsdev,
434                                 HID_USAGE_SENSOR_COMPASS_3D,
435                                 &magn_state->common_attributes);
436         if (ret) {
437                 dev_err(&pdev->dev, "failed to setup common attributes\n");
438                 return ret;
439         }
440 
441         ret = magn_3d_parse_report(pdev, hsdev,
442                                 &channels, &chan_count,
443                                 HID_USAGE_SENSOR_COMPASS_3D, magn_state);
444         if (ret) {
445                 dev_err(&pdev->dev, "failed to parse report\n");
446                 return ret;
447         }
448 
449         indio_dev->channels = channels;
450         indio_dev->num_channels = chan_count;
451         indio_dev->dev.parent = &pdev->dev;
452         indio_dev->info = &magn_3d_info;
453         indio_dev->name = name;
454         indio_dev->modes = INDIO_DIRECT_MODE;
455 
456         ret = iio_triggered_buffer_setup(indio_dev, &iio_pollfunc_store_time,
457                 NULL, NULL);
458         if (ret) {
459                 dev_err(&pdev->dev, "failed to initialize trigger buffer\n");
460                 return ret;
461         }
462         atomic_set(&magn_state->common_attributes.data_ready, 0);
463         ret = hid_sensor_setup_trigger(indio_dev, name,
464                                         &magn_state->common_attributes);
465         if (ret < 0) {
466                 dev_err(&pdev->dev, "trigger setup failed\n");
467                 goto error_unreg_buffer_funcs;
468         }
469 
470         ret = iio_device_register(indio_dev);
471         if (ret) {
472                 dev_err(&pdev->dev, "device register failed\n");
473                 goto error_remove_trigger;
474         }
475 
476         magn_state->callbacks.send_event = magn_3d_proc_event;
477         magn_state->callbacks.capture_sample = magn_3d_capture_sample;
478         magn_state->callbacks.pdev = pdev;
479         ret = sensor_hub_register_callback(hsdev, HID_USAGE_SENSOR_COMPASS_3D,
480                                         &magn_state->callbacks);
481         if (ret < 0) {
482                 dev_err(&pdev->dev, "callback reg failed\n");
483                 goto error_iio_unreg;
484         }
485 
486         return ret;
487 
488 error_iio_unreg:
489         iio_device_unregister(indio_dev);
490 error_remove_trigger:
491         hid_sensor_remove_trigger(&magn_state->common_attributes);
492 error_unreg_buffer_funcs:
493         iio_triggered_buffer_cleanup(indio_dev);
494         return ret;
495 }
496 
497 /* Function to deinitialize the processing for usage id */
498 static int hid_magn_3d_remove(struct platform_device *pdev)
499 {
500         struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
501         struct iio_dev *indio_dev = platform_get_drvdata(pdev);
502         struct magn_3d_state *magn_state = iio_priv(indio_dev);
503 
504         sensor_hub_remove_callback(hsdev, HID_USAGE_SENSOR_COMPASS_3D);
505         iio_device_unregister(indio_dev);
506         hid_sensor_remove_trigger(&magn_state->common_attributes);
507         iio_triggered_buffer_cleanup(indio_dev);
508 
509         return 0;
510 }
511 
512 static struct platform_device_id hid_magn_3d_ids[] = {
513         {
514                 /* Format: HID-SENSOR-usage_id_in_hex_lowercase */
515                 .name = "HID-SENSOR-200083",
516         },
517         { /* sentinel */ }
518 };
519 MODULE_DEVICE_TABLE(platform, hid_magn_3d_ids);
520 
521 static struct platform_driver hid_magn_3d_platform_driver = {
522         .id_table = hid_magn_3d_ids,
523         .driver = {
524                 .name   = KBUILD_MODNAME,
525                 .pm     = &hid_sensor_pm_ops,
526         },
527         .probe          = hid_magn_3d_probe,
528         .remove         = hid_magn_3d_remove,
529 };
530 module_platform_driver(hid_magn_3d_platform_driver);
531 
532 MODULE_DESCRIPTION("HID Sensor Magnetometer 3D");
533 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@intel.com>");
534 MODULE_LICENSE("GPL");
535 

This page was automatically generated by LXR 0.3.1 (source).  •  Linux is a registered trademark of Linus Torvalds  •  Contact us