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