drivers/iio/common/st_sensors/st_sensors_core.c

   1 /*
   2  * STMicroelectronics sensors core library driver
   3  *
   4  * Copyright 2012-2013 STMicroelectronics Inc.
   5  *
   6  * Denis Ciocca <denis.ciocca@st.com>
   7  *
   8  * Licensed under the GPL-2.
   9  */
  10
  11 #include <linux/kernel.h>
  12 #include <linux/module.h>
  13 #include <linux/slab.h>
  14 #include <linux/delay.h>
  15 #include <linux/iio/iio.h>
  16 #include <linux/regulator/consumer.h>
  17 #include <linux/of.h>
  18 #include <asm/unaligned.h>
  19 #include <linux/iio/common/st_sensors.h>
  20
  21 #include "st_sensors_core.h"
  22
  23 static inline u32 st_sensors_get_unaligned_le24(const u8 *p)
  24 {
  25         return (s32)((p[0] | p[1] << 8 | p[2] << 16) << 8) >> 8;
  26 }
  27
  28 int st_sensors_write_data_with_mask(struct iio_dev *indio_dev,
  29                                     u8 reg_addr, u8 mask, u8 data)
  30 {
  31         int err;
  32         u8 new_data;
  33         struct st_sensor_data *sdata = iio_priv(indio_dev);
  34
  35         err = sdata->tf->read_byte(&sdata->tb, sdata->dev, reg_addr, &new_data);
  36         if (err < 0)
  37                 goto st_sensors_write_data_with_mask_error;
  38
  39         new_data = ((new_data & (~mask)) | ((data << __ffs(mask)) & mask));
  40         err = sdata->tf->write_byte(&sdata->tb, sdata->dev, reg_addr, new_data);
  41
  42 st_sensors_write_data_with_mask_error:
  43         return err;
  44 }
  45
  46 int st_sensors_debugfs_reg_access(struct iio_dev *indio_dev,
  47                                   unsigned reg, unsigned writeval,
  48                                   unsigned *readval)
  49 {
  50         struct st_sensor_data *sdata = iio_priv(indio_dev);
  51         u8 readdata;
  52         int err;
  53
  54         if (!readval)
  55                 return sdata->tf->write_byte(&sdata->tb, sdata->dev,
  56                                              (u8)reg, (u8)writeval);
  57
  58         err = sdata->tf->read_byte(&sdata->tb, sdata->dev, (u8)reg, &readdata);
  59         if (err < 0)
  60                 return err;
  61
  62         *readval = (unsigned)readdata;
  63
  64         return 0;
  65 }
  66 EXPORT_SYMBOL(st_sensors_debugfs_reg_access);
  67
  68 static int st_sensors_match_odr(struct st_sensor_settings *sensor_settings,
  69                         unsigned int odr, struct st_sensor_odr_avl *odr_out)
  70 {
  71         int i, ret = -EINVAL;
  72
  73         for (i = 0; i < ST_SENSORS_ODR_LIST_MAX; i++) {
  74                 if (sensor_settings->odr.odr_avl[i].hz == 0)
  75                         goto st_sensors_match_odr_error;
  76
  77                 if (sensor_settings->odr.odr_avl[i].hz == odr) {
  78                         odr_out->hz = sensor_settings->odr.odr_avl[i].hz;
  79                         odr_out->value = sensor_settings->odr.odr_avl[i].value;
  80                         ret = 0;
  81                         break;
  82                 }
  83         }
  84
  85 st_sensors_match_odr_error:
  86         return ret;
  87 }
  88
  89 int st_sensors_set_odr(struct iio_dev *indio_dev, unsigned int odr)
  90 {
  91         int err;
  92         struct st_sensor_odr_avl odr_out = {0, 0};
  93         struct st_sensor_data *sdata = iio_priv(indio_dev);
  94
  95         err = st_sensors_match_odr(sdata->sensor_settings, odr, &odr_out);
  96         if (err < 0)
  97                 goto st_sensors_match_odr_error;
  98
  99         if ((sdata->sensor_settings->odr.addr ==
 100                                         sdata->sensor_settings->pw.addr) &&
 101                                 (sdata->sensor_settings->odr.mask ==
 102                                         sdata->sensor_settings->pw.mask)) {
 103                 if (sdata->enabled == true) {
 104                         err = st_sensors_write_data_with_mask(indio_dev,
 105                                 sdata->sensor_settings->odr.addr,
 106                                 sdata->sensor_settings->odr.mask,
 107                                 odr_out.value);
 108                 } else {
 109                         err = 0;
 110                 }
 111         } else {
 112                 err = st_sensors_write_data_with_mask(indio_dev,
 113                         sdata->sensor_settings->odr.addr,
 114                         sdata->sensor_settings->odr.mask,
 115                         odr_out.value);
 116         }
 117         if (err >= 0)
 118                 sdata->odr = odr_out.hz;
 119
 120 st_sensors_match_odr_error:
 121         return err;
 122 }
 123 EXPORT_SYMBOL(st_sensors_set_odr);
 124
 125 static int st_sensors_match_fs(struct st_sensor_settings *sensor_settings,
 126                                         unsigned int fs, int *index_fs_avl)
 127 {
 128         int i, ret = -EINVAL;
 129
 130         for (i = 0; i < ST_SENSORS_FULLSCALE_AVL_MAX; i++) {
 131                 if (sensor_settings->fs.fs_avl[i].num == 0)
 132                         goto st_sensors_match_odr_error;
 133
 134                 if (sensor_settings->fs.fs_avl[i].num == fs) {
 135                         *index_fs_avl = i;
 136                         ret = 0;
 137                         break;
 138                 }
 139         }
 140
 141 st_sensors_match_odr_error:
 142         return ret;
 143 }
 144
 145 static int st_sensors_set_fullscale(struct iio_dev *indio_dev, unsigned int fs)
 146 {
 147         int err, i = 0;
 148         struct st_sensor_data *sdata = iio_priv(indio_dev);
 149
 150         if (sdata->sensor_settings->fs.addr == 0)
 151                 return 0;
 152
 153         err = st_sensors_match_fs(sdata->sensor_settings, fs, &i);
 154         if (err < 0)
 155                 goto st_accel_set_fullscale_error;
 156
 157         err = st_sensors_write_data_with_mask(indio_dev,
 158                                 sdata->sensor_settings->fs.addr,
 159                                 sdata->sensor_settings->fs.mask,
 160                                 sdata->sensor_settings->fs.fs_avl[i].value);
 161         if (err < 0)
 162                 goto st_accel_set_fullscale_error;
 163
 164         sdata->current_fullscale = (struct st_sensor_fullscale_avl *)
 165                                         &sdata->sensor_settings->fs.fs_avl[i];
 166         return err;
 167
 168 st_accel_set_fullscale_error:
 169         dev_err(&indio_dev->dev, "failed to set new fullscale.\n");
 170         return err;
 171 }
 172
 173 int st_sensors_set_enable(struct iio_dev *indio_dev, bool enable)
 174 {
 175         u8 tmp_value;
 176         int err = -EINVAL;
 177         bool found = false;
 178         struct st_sensor_odr_avl odr_out = {0, 0};
 179         struct st_sensor_data *sdata = iio_priv(indio_dev);
 180
 181         if (enable) {
 182                 tmp_value = sdata->sensor_settings->pw.value_on;
 183                 if ((sdata->sensor_settings->odr.addr ==
 184                                         sdata->sensor_settings->pw.addr) &&
 185                                 (sdata->sensor_settings->odr.mask ==
 186                                         sdata->sensor_settings->pw.mask)) {
 187                         err = st_sensors_match_odr(sdata->sensor_settings,
 188                                                         sdata->odr, &odr_out);
 189                         if (err < 0)
 190                                 goto set_enable_error;
 191                         tmp_value = odr_out.value;
 192                         found = true;
 193                 }
 194                 err = st_sensors_write_data_with_mask(indio_dev,
 195                                 sdata->sensor_settings->pw.addr,
 196                                 sdata->sensor_settings->pw.mask, tmp_value);
 197                 if (err < 0)
 198                         goto set_enable_error;
 199
 200                 sdata->enabled = true;
 201
 202                 if (found)
 203                         sdata->odr = odr_out.hz;
 204         } else {
 205                 err = st_sensors_write_data_with_mask(indio_dev,
 206                                 sdata->sensor_settings->pw.addr,
 207                                 sdata->sensor_settings->pw.mask,
 208                                 sdata->sensor_settings->pw.value_off);
 209                 if (err < 0)
 210                         goto set_enable_error;
 211
 212                 sdata->enabled = false;
 213         }
 214
 215 set_enable_error:
 216         return err;
 217 }
 218 EXPORT_SYMBOL(st_sensors_set_enable);
 219
 220 int st_sensors_set_axis_enable(struct iio_dev *indio_dev, u8 axis_enable)
 221 {
 222         struct st_sensor_data *sdata = iio_priv(indio_dev);
 223
 224         return st_sensors_write_data_with_mask(indio_dev,
 225                                 sdata->sensor_settings->enable_axis.addr,
 226                                 sdata->sensor_settings->enable_axis.mask,
 227                                 axis_enable);
 228 }
 229 EXPORT_SYMBOL(st_sensors_set_axis_enable);
 230
 231 void st_sensors_power_enable(struct iio_dev *indio_dev)
 232 {
 233         struct st_sensor_data *pdata = iio_priv(indio_dev);
 234         int err;
 235
 236         /* Regulators not mandatory, but if requested we should enable them. */
 237         pdata->vdd = devm_regulator_get_optional(indio_dev->dev.parent, "vdd");
 238         if (!IS_ERR(pdata->vdd)) {
 239                 err = regulator_enable(pdata->vdd);
 240                 if (err != 0)
 241                         dev_warn(&indio_dev->dev,
 242                                  "Failed to enable specified Vdd supply\n");
 243         }
 244
 245         pdata->vdd_io = devm_regulator_get_optional(indio_dev->dev.parent, "vddio");
 246         if (!IS_ERR(pdata->vdd_io)) {
 247                 err = regulator_enable(pdata->vdd_io);
 248                 if (err != 0)
 249                         dev_warn(&indio_dev->dev,
 250                                  "Failed to enable specified Vdd_IO supply\n");
 251         }
 252 }
 253 EXPORT_SYMBOL(st_sensors_power_enable);
 254
 255 void st_sensors_power_disable(struct iio_dev *indio_dev)
 256 {
 257         struct st_sensor_data *pdata = iio_priv(indio_dev);
 258
 259         if (!IS_ERR(pdata->vdd))
 260                 regulator_disable(pdata->vdd);
 261
 262         if (!IS_ERR(pdata->vdd_io))
 263                 regulator_disable(pdata->vdd_io);
 264 }
 265 EXPORT_SYMBOL(st_sensors_power_disable);
 266
 267 static int st_sensors_set_drdy_int_pin(struct iio_dev *indio_dev,
 268                                         struct st_sensors_platform_data *pdata)
 269 {
 270         struct st_sensor_data *sdata = iio_priv(indio_dev);
 271
 272         /* Sensor does not support interrupts */
 273         if (sdata->sensor_settings->drdy_irq.addr == 0) {
 274                 if (pdata->drdy_int_pin)
 275                         dev_info(&indio_dev->dev,
 276                                  "DRDY on pin INT%d specified, but sensor "
 277                                  "does not support interrupts\n",
 278                                  pdata->drdy_int_pin);
 279                 return 0;
 280         }
 281
 282         switch (pdata->drdy_int_pin) {
 283         case 1:
 284                 if (sdata->sensor_settings->drdy_irq.mask_int1 == 0) {
 285                         dev_err(&indio_dev->dev,
 286                                         "DRDY on INT1 not available.\n");
 287                         return -EINVAL;
 288                 }
 289                 sdata->drdy_int_pin = 1;
 290                 break;
 291         case 2:
 292                 if (sdata->sensor_settings->drdy_irq.mask_int2 == 0) {
 293                         dev_err(&indio_dev->dev,
 294                                         "DRDY on INT2 not available.\n");
 295                         return -EINVAL;
 296                 }
 297                 sdata->drdy_int_pin = 2;
 298                 break;
 299         default:
 300                 dev_err(&indio_dev->dev, "DRDY on pdata not valid.\n");
 301                 return -EINVAL;
 302         }
 303
 304         if (pdata->open_drain) {
 305                 if (!sdata->sensor_settings->drdy_irq.addr_od)
 306                         dev_err(&indio_dev->dev,
 307                                 "open drain requested but unsupported.\n");
 308                 else
 309                         sdata->int_pin_open_drain = true;
 310         }
 311
 312         return 0;
 313 }
 314
 315 #ifdef CONFIG_OF
 316 static struct st_sensors_platform_data *st_sensors_of_probe(struct device *dev,
 317                 struct st_sensors_platform_data *defdata)
 318 {
 319         struct st_sensors_platform_data *pdata;
 320         struct device_node *np = dev->of_node;
 321         u32 val;
 322
 323         if (!np)
 324                 return NULL;
 325
 326         pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
 327         if (!of_property_read_u32(np, "st,drdy-int-pin", &val) && (val <= 2))
 328                 pdata->drdy_int_pin = (u8) val;
 329         else
 330                 pdata->drdy_int_pin = defdata ? defdata->drdy_int_pin : 0;
 331
 332         pdata->open_drain = of_property_read_bool(np, "drive-open-drain");
 333
 334         return pdata;
 335 }
 336 #else
 337 static struct st_sensors_platform_data *st_sensors_of_probe(struct device *dev,
 338                 struct st_sensors_platform_data *defdata)
 339 {
 340         return NULL;
 341 }
 342 #endif
 343
 344 int st_sensors_init_sensor(struct iio_dev *indio_dev,
 345                                         struct st_sensors_platform_data *pdata)
 346 {
 347         struct st_sensor_data *sdata = iio_priv(indio_dev);
 348         struct st_sensors_platform_data *of_pdata;
 349         int err = 0;
 350
 351         /* If OF/DT pdata exists, it will take precedence of anything else */
 352         of_pdata = st_sensors_of_probe(indio_dev->dev.parent, pdata);
 353         if (of_pdata)
 354                 pdata = of_pdata;
 355
 356         if (pdata) {
 357                 err = st_sensors_set_drdy_int_pin(indio_dev, pdata);
 358                 if (err < 0)
 359                         return err;
 360         }
 361
 362         err = st_sensors_set_enable(indio_dev, false);
 363         if (err < 0)
 364                 return err;
 365
 366         if (sdata->current_fullscale) {
 367                 err = st_sensors_set_fullscale(indio_dev,
 368                                                 sdata->current_fullscale->num);
 369                 if (err < 0)
 370                         return err;
 371         } else
 372                 dev_info(&indio_dev->dev, "Full-scale not possible\n");
 373
 374         err = st_sensors_set_odr(indio_dev, sdata->odr);
 375         if (err < 0)
 376                 return err;
 377
 378         /* set BDU */
 379         if (sdata->sensor_settings->bdu.addr) {
 380                 err = st_sensors_write_data_with_mask(indio_dev,
 381                                         sdata->sensor_settings->bdu.addr,
 382                                         sdata->sensor_settings->bdu.mask, true);
 383                 if (err < 0)
 384                         return err;
 385         }
 386
 387         if (sdata->int_pin_open_drain) {
 388                 dev_info(&indio_dev->dev,
 389                          "set interrupt line to open drain mode\n");
 390                 err = st_sensors_write_data_with_mask(indio_dev,
 391                                 sdata->sensor_settings->drdy_irq.addr_od,
 392                                 sdata->sensor_settings->drdy_irq.mask_od, 1);
 393                 if (err < 0)
 394                         return err;
 395         }
 396
 397         err = st_sensors_set_axis_enable(indio_dev, ST_SENSORS_ENABLE_ALL_AXIS);
 398
 399         return err;
 400 }
 401 EXPORT_SYMBOL(st_sensors_init_sensor);
 402
 403 int st_sensors_set_dataready_irq(struct iio_dev *indio_dev, bool enable)
 404 {
 405         int err;
 406         u8 drdy_mask;
 407         struct st_sensor_data *sdata = iio_priv(indio_dev);
 408
 409         if (!sdata->sensor_settings->drdy_irq.addr)
 410                 return 0;
 411
 412         /* Enable/Disable the interrupt generator 1. */
 413         if (sdata->sensor_settings->drdy_irq.ig1.en_addr > 0) {
 414                 err = st_sensors_write_data_with_mask(indio_dev,
 415                                 sdata->sensor_settings->drdy_irq.ig1.en_addr,
 416                                 sdata->sensor_settings->drdy_irq.ig1.en_mask,
 417                                 (int)enable);
 418                 if (err < 0)
 419                         goto st_accel_set_dataready_irq_error;
 420         }
 421
 422         if (sdata->drdy_int_pin == 1)
 423                 drdy_mask = sdata->sensor_settings->drdy_irq.mask_int1;
 424         else
 425                 drdy_mask = sdata->sensor_settings->drdy_irq.mask_int2;
 426
 427         /* Enable/Disable the interrupt generator for data ready. */
 428         err = st_sensors_write_data_with_mask(indio_dev,
 429                                         sdata->sensor_settings->drdy_irq.addr,
 430                                         drdy_mask, (int)enable);
 431
 432 st_accel_set_dataready_irq_error:
 433         return err;
 434 }
 435 EXPORT_SYMBOL(st_sensors_set_dataready_irq);
 436
 437 int st_sensors_set_fullscale_by_gain(struct iio_dev *indio_dev, int scale)
 438 {
 439         int err = -EINVAL, i;
 440         struct st_sensor_data *sdata = iio_priv(indio_dev);
 441
 442         for (i = 0; i < ST_SENSORS_FULLSCALE_AVL_MAX; i++) {
 443                 if ((sdata->sensor_settings->fs.fs_avl[i].gain == scale) &&
 444                                 (sdata->sensor_settings->fs.fs_avl[i].gain != 0)) {
 445                         err = 0;
 446                         break;
 447                 }
 448         }
 449         if (err < 0)
 450                 goto st_sensors_match_scale_error;
 451
 452         err = st_sensors_set_fullscale(indio_dev,
 453                                 sdata->sensor_settings->fs.fs_avl[i].num);
 454
 455 st_sensors_match_scale_error:
 456         return err;
 457 }
 458 EXPORT_SYMBOL(st_sensors_set_fullscale_by_gain);
 459
 460 static int st_sensors_read_axis_data(struct iio_dev *indio_dev,
 461                                 struct iio_chan_spec const *ch, int *data)
 462 {
 463         int err;
 464         u8 *outdata;
 465         struct st_sensor_data *sdata = iio_priv(indio_dev);
 466         unsigned int byte_for_channel = ch->scan_type.storagebits >> 3;
 467
 468         outdata = kmalloc(byte_for_channel, GFP_KERNEL);
 469         if (!outdata)
 470                 return -ENOMEM;
 471
 472         err = sdata->tf->read_multiple_byte(&sdata->tb, sdata->dev,
 473                                 ch->address, byte_for_channel,
 474                                 outdata, sdata->multiread_bit);
 475         if (err < 0)
 476                 goto st_sensors_free_memory;
 477
 478         if (byte_for_channel == 1)
 479                 *data = (s8)*outdata;
 480         else if (byte_for_channel == 2)
 481                 *data = (s16)get_unaligned_le16(outdata);
 482         else if (byte_for_channel == 3)
 483                 *data = (s32)st_sensors_get_unaligned_le24(outdata);
 484
 485 st_sensors_free_memory:
 486         kfree(outdata);
 487
 488         return err;
 489 }
 490
 491 int st_sensors_read_info_raw(struct iio_dev *indio_dev,
 492                                 struct iio_chan_spec const *ch, int *val)
 493 {
 494         int err;
 495         struct st_sensor_data *sdata = iio_priv(indio_dev);
 496
 497         mutex_lock(&indio_dev->mlock);
 498         if (indio_dev->currentmode == INDIO_BUFFER_TRIGGERED) {
 499                 err = -EBUSY;
 500                 goto out;
 501         } else {
 502                 err = st_sensors_set_enable(indio_dev, true);
 503                 if (err < 0)
 504                         goto out;
 505
 506                 msleep((sdata->sensor_settings->bootime * 1000) / sdata->odr);
 507                 err = st_sensors_read_axis_data(indio_dev, ch, val);
 508                 if (err < 0)
 509                         goto out;
 510
 511                 *val = *val >> ch->scan_type.shift;
 512
 513                 err = st_sensors_set_enable(indio_dev, false);
 514         }
 515 out:
 516         mutex_unlock(&indio_dev->mlock);
 517
 518         return err;
 519 }
 520 EXPORT_SYMBOL(st_sensors_read_info_raw);
 521
 522 int st_sensors_check_device_support(struct iio_dev *indio_dev,
 523                         int num_sensors_list,
 524                         const struct st_sensor_settings *sensor_settings)
 525 {
 526         int i, n, err;
 527         u8 wai;
 528         struct st_sensor_data *sdata = iio_priv(indio_dev);
 529
 530         for (i = 0; i < num_sensors_list; i++) {
 531                 for (n = 0; n < ST_SENSORS_MAX_4WAI; n++) {
 532                         if (strcmp(indio_dev->name,
 533                                 sensor_settings[i].sensors_supported[n]) == 0) {
 534                                 break;
 535                         }
 536                 }
 537                 if (n < ST_SENSORS_MAX_4WAI)
 538                         break;
 539         }
 540         if (i == num_sensors_list) {
 541                 dev_err(&indio_dev->dev, "device name %s not recognized.\n",
 542                                                         indio_dev->name);
 543                 return -ENODEV;
 544         }
 545
 546         err = sdata->tf->read_byte(&sdata->tb, sdata->dev,
 547                                         sensor_settings[i].wai_addr, &wai);
 548         if (err < 0) {
 549                 dev_err(&indio_dev->dev, "failed to read Who-Am-I register.\n");
 550                 return err;
 551         }
 552
 553         if (sensor_settings[i].wai != wai) {
 554                 dev_err(&indio_dev->dev, "%s: WhoAmI mismatch (0x%x).\n",
 555                                                 indio_dev->name, wai);
 556                 return -EINVAL;
 557         }
 558
 559         sdata->sensor_settings =
 560                         (struct st_sensor_settings *)&sensor_settings[i];
 561
 562         return i;
 563 }
 564 EXPORT_SYMBOL(st_sensors_check_device_support);
 565
 566 ssize_t st_sensors_sysfs_sampling_frequency_avail(struct device *dev,
 567                                 struct device_attribute *attr, char *buf)
 568 {
 569         int i, len = 0;
 570         struct iio_dev *indio_dev = dev_get_drvdata(dev);
 571         struct st_sensor_data *sdata = iio_priv(indio_dev);
 572
 573         mutex_lock(&indio_dev->mlock);
 574         for (i = 0; i < ST_SENSORS_ODR_LIST_MAX; i++) {
 575                 if (sdata->sensor_settings->odr.odr_avl[i].hz == 0)
 576                         break;
 577
 578                 len += scnprintf(buf + len, PAGE_SIZE - len, "%d ",
 579                                 sdata->sensor_settings->odr.odr_avl[i].hz);
 580         }
 581         mutex_unlock(&indio_dev->mlock);
 582         buf[len - 1] = '\n';
 583
 584         return len;
 585 }
 586 EXPORT_SYMBOL(st_sensors_sysfs_sampling_frequency_avail);
 587
 588 ssize_t st_sensors_sysfs_scale_avail(struct device *dev,
 589                                 struct device_attribute *attr, char *buf)
 590 {
 591         int i, len = 0;
 592         struct iio_dev *indio_dev = dev_get_drvdata(dev);
 593         struct st_sensor_data *sdata = iio_priv(indio_dev);
 594
 595         mutex_lock(&indio_dev->mlock);
 596         for (i = 0; i < ST_SENSORS_FULLSCALE_AVL_MAX; i++) {
 597                 if (sdata->sensor_settings->fs.fs_avl[i].num == 0)
 598                         break;
 599
 600                 len += scnprintf(buf + len, PAGE_SIZE - len, "0.%06u ",
 601                                 sdata->sensor_settings->fs.fs_avl[i].gain);
 602         }
 603         mutex_unlock(&indio_dev->mlock);
 604         buf[len - 1] = '\n';
 605
 606         return len;
 607 }
 608 EXPORT_SYMBOL(st_sensors_sysfs_scale_avail);
 609
 610 MODULE_AUTHOR("Denis Ciocca <denis.ciocca@st.com>");
 611 MODULE_DESCRIPTION("STMicroelectronics ST-sensors core");
 612 MODULE_LICENSE("GPL v2");